Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

DirHandle.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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