Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/DirHandle.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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