ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/DirHandle.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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