jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

DirHandle.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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