Julien Kern / mbed

mbed library

Dependents:   Printf

Fork of mbed by mbed official

DirHandle.h@53:63cdd78b2dc1, 2012-12-06 (annotated)

Committer:
emilmont
Date:
Thu Dec 06 17:03:27 2012 +0000
Revision:
53:63cdd78b2dc1
Parent:
44:24d45a770a51
Child:
54:71b101360fb9
I2C LPC: fix status after start bit

Who changed what in which revision?

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