Yihui Xiong / BLE_NODE_TEST

Test code for Grove Node BLE

Dependencies:   BLE_API nRF51822

Fork of BLE_LoopbackUART by Bluetooth Low Energy

mbed-src/api/DirHandle.h@10:22480ac31879, 2014-11-27 (annotated)

Committer:
yihui
Date:
Thu Nov 27 09:30:36 2014 +0000
Revision:
10:22480ac31879
Parent:
9:05f0b5a3a70a 
change to new revision hardware

Who changed what in which revision?

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