jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

DirHandle.h@55:d722ed6a4237, 2013-01-16 (annotated)

Committer:
emilmont
Date:
Wed Jan 16 12:56:34 2013 +0000
Revision:
55:d722ed6a4237
Parent:
54:71b101360fb9
Child:
59:0883845fe643
Include "sleep_api.h" in "mbed.h"

Add initial IAR toolchain support

LPC I2C: better handling of status

Add sleep mode support for the LPC1768

Correct GCC "__semihost" definition

Correct GCC "_isatty" retargeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 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
emilmont 55:d722ed6a4237 25 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
emilmont 55:d722ed6a4237 26 # define NAME_MAX 255
simon.ford@mbed.co.uk 8:00a04e5cd407 27 typedef int mode_t;
emilmont 55:d722ed6a4237 28
simon.ford@mbed.co.uk 8:00a04e5cd407 29 #else
emilmont 55:d722ed6a4237 30 # include <sys/syslimits.h>
simon.ford@mbed.co.uk 8:00a04e5cd407 31 #endif
emilmont 55:d722ed6a4237 32
simon.ford@mbed.co.uk 8:00a04e5cd407 33 #include "FileHandle.h"
simon.ford@mbed.co.uk 8:00a04e5cd407 34
simon.ford@mbed.co.uk 8:00a04e5cd407 35 struct dirent {
simon.ford@mbed.co.uk 8:00a04e5cd407 36 char d_name[NAME_MAX+1];
simon.ford@mbed.co.uk 8:00a04e5cd407 37 };
simon.ford@mbed.co.uk 8:00a04e5cd407 38
simon.ford@mbed.co.uk 8:00a04e5cd407 39 namespace mbed {
simon.ford@mbed.co.uk 8:00a04e5cd407 40
emilmont 43:e2ed12d17f06 41 /** Represents a directory stream. Objects of this type are returned
simon.ford@mbed.co.uk 8:00a04e5cd407 42 * by a FileSystemLike's opendir method. Implementations must define
simon.ford@mbed.co.uk 8:00a04e5cd407 43 * at least closedir, readdir and rewinddir.
simon.ford@mbed.co.uk 8:00a04e5cd407 44 *
simon.ford@mbed.co.uk 8:00a04e5cd407 45 * If a FileSystemLike class defines the opendir method, then the
emilmont 55:d722ed6a4237 46 * directories of an object of that type can be accessed by
emilmont 44:24d45a770a51 47 * DIR *d = opendir("/example/directory") (or opendir("/example")
simon.ford@mbed.co.uk 8:00a04e5cd407 48 * to open the root of the filesystem), and then using readdir(d) etc.
simon.ford@mbed.co.uk 8:00a04e5cd407 49 *
simon.ford@mbed.co.uk 8:00a04e5cd407 50 * The root directory is considered to contain all FileLike and
simon.ford@mbed.co.uk 8:00a04e5cd407 51 * FileSystemLike objects, so the DIR* returned by opendir("/") will
simon.ford@mbed.co.uk 8:00a04e5cd407 52 * reflect this.
simon.ford@mbed.co.uk 8:00a04e5cd407 53 */
simon.ford@mbed.co.uk 8:00a04e5cd407 54 class DirHandle {
simon.ford@mbed.co.uk 8:00a04e5cd407 55
emilmont 44:24d45a770a51 56 public:
emilmont 43:e2ed12d17f06 57 /** Closes the directory.
simon.ford@mbed.co.uk 8:00a04e5cd407 58 *
emilmont 43:e2ed12d17f06 59 * @returns
emilmont 43:e2ed12d17f06 60 * 0 on success,
emilmont 43:e2ed12d17f06 61 * -1 on error.
simon.ford@mbed.co.uk 8:00a04e5cd407 62 */
simon.ford@mbed.co.uk 8:00a04e5cd407 63 virtual int closedir()=0;
emilmont 55:d722ed6a4237 64
emilmont 43:e2ed12d17f06 65 /** Return the directory entry at the current position, and
simon.ford@mbed.co.uk 8:00a04e5cd407 66 * advances the position to the next entry.
simon.ford@mbed.co.uk 8:00a04e5cd407 67 *
emilmont 43:e2ed12d17f06 68 * @returns
emilmont 44:24d45a770a51 69 * A pointer to a dirent structure representing the
emilmont 44:24d45a770a51 70 * directory entry at the current position, or NULL on reaching
emilmont 44:24d45a770a51 71 * end of directory or error.
simon.ford@mbed.co.uk 8:00a04e5cd407 72 */
simon.ford@mbed.co.uk 8:00a04e5cd407 73 virtual struct dirent *readdir()=0;
simon.ford@mbed.co.uk 8:00a04e5cd407 74
emilmont 43:e2ed12d17f06 75 /** Resets the position to the beginning of the directory.
simon.ford@mbed.co.uk 8:00a04e5cd407 76 */
simon.ford@mbed.co.uk 8:00a04e5cd407 77 virtual void rewinddir()=0;
simon.ford@mbed.co.uk 8:00a04e5cd407 78
emilmont 43:e2ed12d17f06 79 /** Returns the current position of the DirHandle.
simon.ford@mbed.co.uk 8:00a04e5cd407 80 *
emilmont 43:e2ed12d17f06 81 * @returns
emilmont 43:e2ed12d17f06 82 * the current position,
emilmont 43:e2ed12d17f06 83 * -1 on error.
simon.ford@mbed.co.uk 8:00a04e5cd407 84 */
simon.ford@mbed.co.uk 8:00a04e5cd407 85 virtual off_t telldir() { return -1; }
simon.ford@mbed.co.uk 8:00a04e5cd407 86
emilmont 43:e2ed12d17f06 87 /** Sets the position of the DirHandle.
simon.ford@mbed.co.uk 8:00a04e5cd407 88 *
emilmont 43:e2ed12d17f06 89 * @param location The location to seek to. Must be a value returned by telldir.
simon.ford@mbed.co.uk 8:00a04e5cd407 90 */
simon.ford@mbed.co.uk 8:00a04e5cd407 91 virtual void seekdir(off_t location) { }
emilmont 55:d722ed6a4237 92
emilmont 44:24d45a770a51 93 virtual ~DirHandle() {}
simon.ford@mbed.co.uk 8:00a04e5cd407 94 };
simon.ford@mbed.co.uk 8:00a04e5cd407 95
rolf.meyer@arm.com 11:1c1ebd0324fa 96 } // namespace mbed
simon.ford@mbed.co.uk 8:00a04e5cd407 97
simon.ford@mbed.co.uk 8:00a04e5cd407 98 typedef mbed::DirHandle DIR;
simon.ford@mbed.co.uk 8:00a04e5cd407 99
simon.ford@mbed.co.uk 8:00a04e5cd407 100 extern "C" {
simon.ford@mbed.co.uk 8:00a04e5cd407 101 DIR *opendir(const char*);
simon.ford@mbed.co.uk 8:00a04e5cd407 102 struct dirent *readdir(DIR *);
simon.ford@mbed.co.uk 8:00a04e5cd407 103 int closedir(DIR*);
simon.ford@mbed.co.uk 8:00a04e5cd407 104 void rewinddir(DIR*);
simon.ford@mbed.co.uk 8:00a04e5cd407 105 long telldir(DIR*);
simon.ford@mbed.co.uk 8:00a04e5cd407 106 void seekdir(DIR*, long);
simon.ford@mbed.co.uk 8:00a04e5cd407 107 int mkdir(const char *name, mode_t n);
simon.ford@mbed.co.uk 8:00a04e5cd407 108 };
simon.ford@mbed.co.uk 8:00a04e5cd407 109
simon.ford@mbed.co.uk 8:00a04e5cd407 110 #endif /* MBED_DIRHANDLE_H */