DongEun Koak / mbed-src

mbed library sources

Dependents:   Freedman_v2 Nucleo_i2c_OLED_BME280_copy

Fork of mbed-src by mbed official

cpp/DirHandle.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_DIRHANDLE_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_DIRHANDLE_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #ifdef __ARMCC_VERSION
mbed_official 0:fd0d7bdfcdc2 26 # define NAME_MAX 255
mbed_official 0:fd0d7bdfcdc2 27 typedef int mode_t;
mbed_official 0:fd0d7bdfcdc2 28 #else
mbed_official 0:fd0d7bdfcdc2 29 # include <sys/syslimits.h>
mbed_official 0:fd0d7bdfcdc2 30 #endif
mbed_official 0:fd0d7bdfcdc2 31 #include "FileHandle.h"
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 struct dirent {
mbed_official 0:fd0d7bdfcdc2 34 char d_name[NAME_MAX+1];
mbed_official 0:fd0d7bdfcdc2 35 };
mbed_official 0:fd0d7bdfcdc2 36
mbed_official 0:fd0d7bdfcdc2 37 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 38
mbed_official 0:fd0d7bdfcdc2 39 /** Represents a directory stream. Objects of this type are returned
mbed_official 0:fd0d7bdfcdc2 40 * by a FileSystemLike's opendir method. Implementations must define
mbed_official 0:fd0d7bdfcdc2 41 * at least closedir, readdir and rewinddir.
mbed_official 0:fd0d7bdfcdc2 42 *
mbed_official 0:fd0d7bdfcdc2 43 * If a FileSystemLike class defines the opendir method, then the
mbed_official 0:fd0d7bdfcdc2 44 * directories of an object of that type can be accessed by
mbed_official 0:fd0d7bdfcdc2 45 * DIR *d = opendir("/example/directory") (or opendir("/example")
mbed_official 0:fd0d7bdfcdc2 46 * to open the root of the filesystem), and then using readdir(d) etc.
mbed_official 0:fd0d7bdfcdc2 47 *
mbed_official 0:fd0d7bdfcdc2 48 * The root directory is considered to contain all FileLike and
mbed_official 0:fd0d7bdfcdc2 49 * FileSystemLike objects, so the DIR* returned by opendir("/") will
mbed_official 0:fd0d7bdfcdc2 50 * reflect this.
mbed_official 0:fd0d7bdfcdc2 51 */
mbed_official 0:fd0d7bdfcdc2 52 class DirHandle {
mbed_official 0:fd0d7bdfcdc2 53
mbed_official 0:fd0d7bdfcdc2 54 public:
mbed_official 0:fd0d7bdfcdc2 55 /** Closes the directory.
mbed_official 0:fd0d7bdfcdc2 56 *
mbed_official 0:fd0d7bdfcdc2 57 * @returns
mbed_official 0:fd0d7bdfcdc2 58 * 0 on success,
mbed_official 0:fd0d7bdfcdc2 59 * -1 on error.
mbed_official 0:fd0d7bdfcdc2 60 */
mbed_official 0:fd0d7bdfcdc2 61 virtual int closedir()=0;
mbed_official 0:fd0d7bdfcdc2 62
mbed_official 0:fd0d7bdfcdc2 63 /** Return the directory entry at the current position, and
mbed_official 0:fd0d7bdfcdc2 64 * advances the position to the next entry.
mbed_official 0:fd0d7bdfcdc2 65 *
mbed_official 0:fd0d7bdfcdc2 66 * @returns
mbed_official 0:fd0d7bdfcdc2 67 * A pointer to a dirent structure representing the
mbed_official 0:fd0d7bdfcdc2 68 * directory entry at the current position, or NULL on reaching
mbed_official 0:fd0d7bdfcdc2 69 * end of directory or error.
mbed_official 0:fd0d7bdfcdc2 70 */
mbed_official 0:fd0d7bdfcdc2 71 virtual struct dirent *readdir()=0;
mbed_official 0:fd0d7bdfcdc2 72
mbed_official 0:fd0d7bdfcdc2 73 /** Resets the position to the beginning of the directory.
mbed_official 0:fd0d7bdfcdc2 74 */
mbed_official 0:fd0d7bdfcdc2 75 virtual void rewinddir()=0;
mbed_official 0:fd0d7bdfcdc2 76
mbed_official 0:fd0d7bdfcdc2 77 /** Returns the current position of the DirHandle.
mbed_official 0:fd0d7bdfcdc2 78 *
mbed_official 0:fd0d7bdfcdc2 79 * @returns
mbed_official 0:fd0d7bdfcdc2 80 * the current position,
mbed_official 0:fd0d7bdfcdc2 81 * -1 on error.
mbed_official 0:fd0d7bdfcdc2 82 */
mbed_official 0:fd0d7bdfcdc2 83 virtual off_t telldir() { return -1; }
mbed_official 0:fd0d7bdfcdc2 84
mbed_official 0:fd0d7bdfcdc2 85 /** Sets the position of the DirHandle.
mbed_official 0:fd0d7bdfcdc2 86 *
mbed_official 0:fd0d7bdfcdc2 87 * @param location The location to seek to. Must be a value returned by telldir.
mbed_official 0:fd0d7bdfcdc2 88 */
mbed_official 0:fd0d7bdfcdc2 89 virtual void seekdir(off_t location) { }
mbed_official 0:fd0d7bdfcdc2 90
mbed_official 0:fd0d7bdfcdc2 91 virtual ~DirHandle() {}
mbed_official 0:fd0d7bdfcdc2 92 };
mbed_official 0:fd0d7bdfcdc2 93
mbed_official 0:fd0d7bdfcdc2 94 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 95
mbed_official 0:fd0d7bdfcdc2 96 typedef mbed::DirHandle DIR;
mbed_official 0:fd0d7bdfcdc2 97
mbed_official 0:fd0d7bdfcdc2 98 extern "C" {
mbed_official 0:fd0d7bdfcdc2 99 DIR *opendir(const char*);
mbed_official 0:fd0d7bdfcdc2 100 struct dirent *readdir(DIR *);
mbed_official 0:fd0d7bdfcdc2 101 int closedir(DIR*);
mbed_official 0:fd0d7bdfcdc2 102 void rewinddir(DIR*);
mbed_official 0:fd0d7bdfcdc2 103 long telldir(DIR*);
mbed_official 0:fd0d7bdfcdc2 104 void seekdir(DIR*, long);
mbed_official 0:fd0d7bdfcdc2 105 int mkdir(const char *name, mode_t n);
mbed_official 0:fd0d7bdfcdc2 106 };
mbed_official 0:fd0d7bdfcdc2 107
mbed_official 0:fd0d7bdfcdc2 108 #endif /* MBED_DIRHANDLE_H */