Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/DirHandle.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

Who changed what in which revision?

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