SDK Development / mbed-src

mbed SDK library sources

Fork of mbed-src by mbed official

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

api/DirHandle.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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