Jhon Plantikow / Dataloger

Dataloger

DirHandle.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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