Jhon Plantikow / DHT11

DHT11

DirHandle.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:c52df770855b 1 /* mbed Microcontroller Library
jhon309 0:c52df770855b 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:c52df770855b 3 *
jhon309 0:c52df770855b 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:c52df770855b 5 * you may not use this file except in compliance with the License.
jhon309 0:c52df770855b 6 * You may obtain a copy of the License at
jhon309 0:c52df770855b 7 *
jhon309 0:c52df770855b 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:c52df770855b 9 *
jhon309 0:c52df770855b 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:c52df770855b 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:c52df770855b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:c52df770855b 13 * See the License for the specific language governing permissions and
jhon309 0:c52df770855b 14 * limitations under the License.
jhon309 0:c52df770855b 15 */
jhon309 0:c52df770855b 16 #ifndef MBED_DIRHANDLE_H
jhon309 0:c52df770855b 17 #define MBED_DIRHANDLE_H
jhon309 0:c52df770855b 18
jhon309 0:c52df770855b 19 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
jhon309 0:c52df770855b 20 # define NAME_MAX 255
jhon309 0:c52df770855b 21 typedef int mode_t;
jhon309 0:c52df770855b 22
jhon309 0:c52df770855b 23 #else
jhon309 0:c52df770855b 24 # include <sys/syslimits.h>
jhon309 0:c52df770855b 25 #endif
jhon309 0:c52df770855b 26
jhon309 0:c52df770855b 27 #include "FileHandle.h"
jhon309 0:c52df770855b 28
jhon309 0:c52df770855b 29 struct dirent {
jhon309 0:c52df770855b 30 char d_name[NAME_MAX+1];
jhon309 0:c52df770855b 31 };
jhon309 0:c52df770855b 32
jhon309 0:c52df770855b 33 namespace mbed {
jhon309 0:c52df770855b 34
jhon309 0:c52df770855b 35 /** Represents a directory stream. Objects of this type are returned
jhon309 0:c52df770855b 36 * by a FileSystemLike's opendir method. Implementations must define
jhon309 0:c52df770855b 37 * at least closedir, readdir and rewinddir.
jhon309 0:c52df770855b 38 *
jhon309 0:c52df770855b 39 * If a FileSystemLike class defines the opendir method, then the
jhon309 0:c52df770855b 40 * directories of an object of that type can be accessed by
jhon309 0:c52df770855b 41 * DIR *d = opendir("/example/directory") (or opendir("/example")
jhon309 0:c52df770855b 42 * to open the root of the filesystem), and then using readdir(d) etc.
jhon309 0:c52df770855b 43 *
jhon309 0:c52df770855b 44 * The root directory is considered to contain all FileLike and
jhon309 0:c52df770855b 45 * FileSystemLike objects, so the DIR* returned by opendir("/") will
jhon309 0:c52df770855b 46 * reflect this.
jhon309 0:c52df770855b 47 */
jhon309 0:c52df770855b 48 class DirHandle {
jhon309 0:c52df770855b 49
jhon309 0:c52df770855b 50 public:
jhon309 0:c52df770855b 51 /** Closes the directory.
jhon309 0:c52df770855b 52 *
jhon309 0:c52df770855b 53 * @returns
jhon309 0:c52df770855b 54 * 0 on success,
jhon309 0:c52df770855b 55 * -1 on error.
jhon309 0:c52df770855b 56 */
jhon309 0:c52df770855b 57 virtual int closedir()=0;
jhon309 0:c52df770855b 58
jhon309 0:c52df770855b 59 /** Return the directory entry at the current position, and
jhon309 0:c52df770855b 60 * advances the position to the next entry.
jhon309 0:c52df770855b 61 *
jhon309 0:c52df770855b 62 * @returns
jhon309 0:c52df770855b 63 * A pointer to a dirent structure representing the
jhon309 0:c52df770855b 64 * directory entry at the current position, or NULL on reaching
jhon309 0:c52df770855b 65 * end of directory or error.
jhon309 0:c52df770855b 66 */
jhon309 0:c52df770855b 67 virtual struct dirent *readdir()=0;
jhon309 0:c52df770855b 68
jhon309 0:c52df770855b 69 /** Resets the position to the beginning of the directory.
jhon309 0:c52df770855b 70 */
jhon309 0:c52df770855b 71 virtual void rewinddir()=0;
jhon309 0:c52df770855b 72
jhon309 0:c52df770855b 73 /** Returns the current position of the DirHandle.
jhon309 0:c52df770855b 74 *
jhon309 0:c52df770855b 75 * @returns
jhon309 0:c52df770855b 76 * the current position,
jhon309 0:c52df770855b 77 * -1 on error.
jhon309 0:c52df770855b 78 */
jhon309 0:c52df770855b 79 virtual off_t telldir() { return -1; }
jhon309 0:c52df770855b 80
jhon309 0:c52df770855b 81 /** Sets the position of the DirHandle.
jhon309 0:c52df770855b 82 *
jhon309 0:c52df770855b 83 * @param location The location to seek to. Must be a value returned by telldir.
jhon309 0:c52df770855b 84 */
jhon309 0:c52df770855b 85 virtual void seekdir(off_t location) { }
jhon309 0:c52df770855b 86
jhon309 0:c52df770855b 87 virtual ~DirHandle() {}
jhon309 0:c52df770855b 88 };
jhon309 0:c52df770855b 89
jhon309 0:c52df770855b 90 } // namespace mbed
jhon309 0:c52df770855b 91
jhon309 0:c52df770855b 92 typedef mbed::DirHandle DIR;
jhon309 0:c52df770855b 93
jhon309 0:c52df770855b 94 extern "C" {
jhon309 0:c52df770855b 95 DIR *opendir(const char*);
jhon309 0:c52df770855b 96 struct dirent *readdir(DIR *);
jhon309 0:c52df770855b 97 int closedir(DIR*);
jhon309 0:c52df770855b 98 void rewinddir(DIR*);
jhon309 0:c52df770855b 99 long telldir(DIR*);
jhon309 0:c52df770855b 100 void seekdir(DIR*, long);
jhon309 0:c52df770855b 101 int mkdir(const char *name, mode_t n);
jhon309 0:c52df770855b 102 };
jhon309 0:c52df770855b 103
jhon309 0:c52df770855b 104 #endif /* MBED_DIRHANDLE_H */