Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

DirHandle.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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