clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/DirHandle.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - DirHandler
slowness 0:c03cffe402df 2 * Copyright (c) 2008-2009 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_DIRHANDLE_H
slowness 0:c03cffe402df 6 #define MBED_DIRHANDLE_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #ifdef __ARMCC_VERSION
slowness 0:c03cffe402df 9 # define NAME_MAX 255
slowness 0:c03cffe402df 10 typedef int mode_t;
slowness 0:c03cffe402df 11 #else
slowness 0:c03cffe402df 12 # include <sys/syslimits.h>
slowness 0:c03cffe402df 13 #endif
slowness 0:c03cffe402df 14 #include "FileHandle.h"
slowness 0:c03cffe402df 15
slowness 0:c03cffe402df 16 struct dirent {
slowness 0:c03cffe402df 17 char d_name[NAME_MAX+1];
slowness 0:c03cffe402df 18 };
slowness 0:c03cffe402df 19
slowness 0:c03cffe402df 20 namespace mbed {
slowness 0:c03cffe402df 21
slowness 0:c03cffe402df 22 /* Class DirHandle
slowness 0:c03cffe402df 23 * Represents a directory stream. Objects of this type are returned
slowness 0:c03cffe402df 24 * by a FileSystemLike's opendir method. Implementations must define
slowness 0:c03cffe402df 25 * at least closedir, readdir and rewinddir.
slowness 0:c03cffe402df 26 *
slowness 0:c03cffe402df 27 * If a FileSystemLike class defines the opendir method, then the
slowness 0:c03cffe402df 28 * directories of an object of that type can be accessed by
slowness 0:c03cffe402df 29 * DIR *d = opendir("/example/directory") (or opendir("/example")
slowness 0:c03cffe402df 30 * to open the root of the filesystem), and then using readdir(d) etc.
slowness 0:c03cffe402df 31 *
slowness 0:c03cffe402df 32 * The root directory is considered to contain all FileLike and
slowness 0:c03cffe402df 33 * FileSystemLike objects, so the DIR* returned by opendir("/") will
slowness 0:c03cffe402df 34 * reflect this.
slowness 0:c03cffe402df 35 */
slowness 0:c03cffe402df 36 class DirHandle {
slowness 0:c03cffe402df 37
slowness 0:c03cffe402df 38 public:
slowness 0:c03cffe402df 39 /* Function closedir
slowness 0:c03cffe402df 40 * Closes the directory.
slowness 0:c03cffe402df 41 *
slowness 0:c03cffe402df 42 * Variables
slowness 0:c03cffe402df 43 * returns - 0 on success, or -1 on error.
slowness 0:c03cffe402df 44 */
slowness 0:c03cffe402df 45 virtual int closedir()=0;
slowness 0:c03cffe402df 46
slowness 0:c03cffe402df 47 /* Function readdir
slowness 0:c03cffe402df 48 * Return the directory entry at the current position, and
slowness 0:c03cffe402df 49 * advances the position to the next entry.
slowness 0:c03cffe402df 50 *
slowness 0:c03cffe402df 51 * Returns
slowness 0:c03cffe402df 52 * A pointer to a dirent structure representing the
slowness 0:c03cffe402df 53 * directory entry at the current position, or NULL on reaching
slowness 0:c03cffe402df 54 * end of directory or error.
slowness 0:c03cffe402df 55 */
slowness 0:c03cffe402df 56 virtual struct dirent *readdir()=0;
slowness 0:c03cffe402df 57
slowness 0:c03cffe402df 58 /* Function rewinddir
slowness 0:c03cffe402df 59 * Resets the position to the beginning of the directory.
slowness 0:c03cffe402df 60 */
slowness 0:c03cffe402df 61 virtual void rewinddir()=0;
slowness 0:c03cffe402df 62
slowness 0:c03cffe402df 63 /* Function telldir
slowness 0:c03cffe402df 64 * Returns the current position of the DirHandle.
slowness 0:c03cffe402df 65 *
slowness 0:c03cffe402df 66 * Returns
slowness 0:c03cffe402df 67 * The current position, or -1 on error.
slowness 0:c03cffe402df 68 */
slowness 0:c03cffe402df 69 virtual off_t telldir() { return -1; }
slowness 0:c03cffe402df 70
slowness 0:c03cffe402df 71 /* Function seekdir
slowness 0:c03cffe402df 72 * Sets the position of the DirHandle.
slowness 0:c03cffe402df 73 *
slowness 0:c03cffe402df 74 * Variables
slowness 0:c03cffe402df 75 * location - The location to seek to. Must be a value returned
slowness 0:c03cffe402df 76 * by telldir.
slowness 0:c03cffe402df 77 */
slowness 0:c03cffe402df 78 virtual void seekdir(off_t location) { }
slowness 0:c03cffe402df 79
slowness 0:c03cffe402df 80 };
slowness 0:c03cffe402df 81
slowness 0:c03cffe402df 82 } // namespace mbed
slowness 0:c03cffe402df 83
slowness 0:c03cffe402df 84 typedef mbed::DirHandle DIR;
slowness 0:c03cffe402df 85
slowness 0:c03cffe402df 86 extern "C" {
slowness 0:c03cffe402df 87 DIR *opendir(const char*);
slowness 0:c03cffe402df 88 struct dirent *readdir(DIR *);
slowness 0:c03cffe402df 89 int closedir(DIR*);
slowness 0:c03cffe402df 90 void rewinddir(DIR*);
slowness 0:c03cffe402df 91 long telldir(DIR*);
slowness 0:c03cffe402df 92 void seekdir(DIR*, long);
slowness 0:c03cffe402df 93 int mkdir(const char *name, mode_t n);
slowness 0:c03cffe402df 94 };
slowness 0:c03cffe402df 95
slowness 0:c03cffe402df 96 #endif /* MBED_DIRHANDLE_H */