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/FileSystemLike.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_FILESYSTEMLIKE_H
yihui 9:05f0b5a3a70a 17 #define MBED_FILESYSTEMLIKE_H
yihui 9:05f0b5a3a70a 18
yihui 9:05f0b5a3a70a 19 #include "platform.h"
yihui 9:05f0b5a3a70a 20
yihui 9:05f0b5a3a70a 21 #include "FileBase.h"
yihui 9:05f0b5a3a70a 22 #include "FileHandle.h"
yihui 9:05f0b5a3a70a 23 #include "DirHandle.h"
yihui 9:05f0b5a3a70a 24
yihui 9:05f0b5a3a70a 25 namespace mbed {
yihui 9:05f0b5a3a70a 26
yihui 9:05f0b5a3a70a 27 /** A filesystem-like object is one that can be used to open files
yihui 9:05f0b5a3a70a 28 * though it by fopen("/name/filename", mode)
yihui 9:05f0b5a3a70a 29 *
yihui 9:05f0b5a3a70a 30 * Implementations must define at least open (the default definitions
yihui 9:05f0b5a3a70a 31 * of the rest of the functions just return error values).
yihui 9:05f0b5a3a70a 32 */
yihui 9:05f0b5a3a70a 33 class FileSystemLike : public FileBase {
yihui 9:05f0b5a3a70a 34
yihui 9:05f0b5a3a70a 35 public:
yihui 9:05f0b5a3a70a 36 /** FileSystemLike constructor
yihui 9:05f0b5a3a70a 37 *
yihui 9:05f0b5a3a70a 38 * @param name The name to use for the filesystem.
yihui 9:05f0b5a3a70a 39 */
yihui 9:05f0b5a3a70a 40 FileSystemLike(const char *name);
yihui 9:05f0b5a3a70a 41
yihui 9:05f0b5a3a70a 42 virtual ~FileSystemLike();
yihui 9:05f0b5a3a70a 43
yihui 9:05f0b5a3a70a 44 static DirHandle *opendir();
yihui 9:05f0b5a3a70a 45 friend class BaseDirHandle;
yihui 9:05f0b5a3a70a 46
yihui 9:05f0b5a3a70a 47 /** Opens a file from the filesystem
yihui 9:05f0b5a3a70a 48 *
yihui 9:05f0b5a3a70a 49 * @param filename The name of the file to open.
yihui 9:05f0b5a3a70a 50 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
yihui 9:05f0b5a3a70a 51 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
yihui 9:05f0b5a3a70a 52 *
yihui 9:05f0b5a3a70a 53 * @returns
yihui 9:05f0b5a3a70a 54 * A pointer to a FileHandle object representing the
yihui 9:05f0b5a3a70a 55 * file on success, or NULL on failure.
yihui 9:05f0b5a3a70a 56 */
yihui 9:05f0b5a3a70a 57 virtual FileHandle *open(const char *filename, int flags) = 0;
yihui 9:05f0b5a3a70a 58
yihui 9:05f0b5a3a70a 59 /** Remove a file from the filesystem.
yihui 9:05f0b5a3a70a 60 *
yihui 9:05f0b5a3a70a 61 * @param filename the name of the file to remove.
yihui 9:05f0b5a3a70a 62 * @param returns 0 on success, -1 on failure.
yihui 9:05f0b5a3a70a 63 */
yihui 9:05f0b5a3a70a 64 virtual int remove(const char *filename) { return -1; };
yihui 9:05f0b5a3a70a 65
yihui 9:05f0b5a3a70a 66 /** Rename a file in the filesystem.
yihui 9:05f0b5a3a70a 67 *
yihui 9:05f0b5a3a70a 68 * @param oldname the name of the file to rename.
yihui 9:05f0b5a3a70a 69 * @param newname the name to rename it to.
yihui 9:05f0b5a3a70a 70 *
yihui 9:05f0b5a3a70a 71 * @returns
yihui 9:05f0b5a3a70a 72 * 0 on success,
yihui 9:05f0b5a3a70a 73 * -1 on failure.
yihui 9:05f0b5a3a70a 74 */
yihui 9:05f0b5a3a70a 75 virtual int rename(const char *oldname, const char *newname) { return -1; };
yihui 9:05f0b5a3a70a 76
yihui 9:05f0b5a3a70a 77 /** Opens a directory in the filesystem and returns a DirHandle
yihui 9:05f0b5a3a70a 78 * representing the directory stream.
yihui 9:05f0b5a3a70a 79 *
yihui 9:05f0b5a3a70a 80 * @param name The name of the directory to open.
yihui 9:05f0b5a3a70a 81 *
yihui 9:05f0b5a3a70a 82 * @returns
yihui 9:05f0b5a3a70a 83 * A DirHandle representing the directory stream, or
yihui 9:05f0b5a3a70a 84 * NULL on failure.
yihui 9:05f0b5a3a70a 85 */
yihui 9:05f0b5a3a70a 86 virtual DirHandle *opendir(const char *name) { return NULL; };
yihui 9:05f0b5a3a70a 87
yihui 9:05f0b5a3a70a 88 /** Creates a directory in the filesystem.
yihui 9:05f0b5a3a70a 89 *
yihui 9:05f0b5a3a70a 90 * @param name The name of the directory to create.
yihui 9:05f0b5a3a70a 91 * @param mode The permissions to create the directory with.
yihui 9:05f0b5a3a70a 92 *
yihui 9:05f0b5a3a70a 93 * @returns
yihui 9:05f0b5a3a70a 94 * 0 on success,
yihui 9:05f0b5a3a70a 95 * -1 on failure.
yihui 9:05f0b5a3a70a 96 */
yihui 9:05f0b5a3a70a 97 virtual int mkdir(const char *name, mode_t mode) { return -1; }
yihui 9:05f0b5a3a70a 98
yihui 9:05f0b5a3a70a 99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
yihui 9:05f0b5a3a70a 100 };
yihui 9:05f0b5a3a70a 101
yihui 9:05f0b5a3a70a 102 } // namespace mbed
yihui 9:05f0b5a3a70a 103
yihui 9:05f0b5a3a70a 104 #endif