Lancaster University / mbed-lite-test

test

DirHandle.h@1:a7c51b5e0534, 2016-04-07 (annotated)

Committer:
jamesadevine
Date:
Thu Apr 07 17:50:29 2016 +0000
Revision:
1:a7c51b5e0534
Parent:
0:e1a608bb55e8 
Added correct nrf51.h ; Added scatter file.

Who changed what in which revision?

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