Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/DirHandle.h@57:dd901dec6bd0, 2016-01-30 (annotated)

Committer:
Splith
Date:
Sat Jan 30 16:48:54 2016 +0000
Revision:
57:dd901dec6bd0
Parent:
0:9b334a45a8ff 
Add USART3 pin mapping to Seeed arch max

Who changed what in which revision?

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