Tomo Yamanaka / mbed-dev

mbed library sources. Supersedes mbed-src. GR-PEACH runs on RAM.

Fork of mbed-dev by mbed official

api/FileSystemLike.h@103:493a29d2d4d7, 2016-03-30 (annotated)

Committer:
1050186
Date:
Wed Mar 30 11:41:25 2016 +0000
Revision:
103:493a29d2d4d7
Parent:
0:9b334a45a8ff 
GR-PEACH runs on RAM.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_FILESYSTEMLIKE_H
bogdanm 0:9b334a45a8ff 17 #define MBED_FILESYSTEMLIKE_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 #include "platform.h"
bogdanm 0:9b334a45a8ff 20
bogdanm 0:9b334a45a8ff 21 #include "FileBase.h"
bogdanm 0:9b334a45a8ff 22 #include "FileHandle.h"
bogdanm 0:9b334a45a8ff 23 #include "DirHandle.h"
bogdanm 0:9b334a45a8ff 24
bogdanm 0:9b334a45a8ff 25 namespace mbed {
bogdanm 0:9b334a45a8ff 26
bogdanm 0:9b334a45a8ff 27 /** A filesystem-like object is one that can be used to open files
bogdanm 0:9b334a45a8ff 28 * though it by fopen("/name/filename", mode)
bogdanm 0:9b334a45a8ff 29 *
bogdanm 0:9b334a45a8ff 30 * Implementations must define at least open (the default definitions
bogdanm 0:9b334a45a8ff 31 * of the rest of the functions just return error values).
bogdanm 0:9b334a45a8ff 32 */
bogdanm 0:9b334a45a8ff 33 class FileSystemLike : public FileBase {
bogdanm 0:9b334a45a8ff 34
bogdanm 0:9b334a45a8ff 35 public:
bogdanm 0:9b334a45a8ff 36 /** FileSystemLike constructor
bogdanm 0:9b334a45a8ff 37 *
bogdanm 0:9b334a45a8ff 38 * @param name The name to use for the filesystem.
bogdanm 0:9b334a45a8ff 39 */
bogdanm 0:9b334a45a8ff 40 FileSystemLike(const char *name);
bogdanm 0:9b334a45a8ff 41
bogdanm 0:9b334a45a8ff 42 virtual ~FileSystemLike();
bogdanm 0:9b334a45a8ff 43
bogdanm 0:9b334a45a8ff 44 static DirHandle *opendir();
bogdanm 0:9b334a45a8ff 45 friend class BaseDirHandle;
bogdanm 0:9b334a45a8ff 46
bogdanm 0:9b334a45a8ff 47 /** Opens a file from the filesystem
bogdanm 0:9b334a45a8ff 48 *
bogdanm 0:9b334a45a8ff 49 * @param filename The name of the file to open.
bogdanm 0:9b334a45a8ff 50 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
bogdanm 0:9b334a45a8ff 51 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
bogdanm 0:9b334a45a8ff 52 *
bogdanm 0:9b334a45a8ff 53 * @returns
bogdanm 0:9b334a45a8ff 54 * A pointer to a FileHandle object representing the
bogdanm 0:9b334a45a8ff 55 * file on success, or NULL on failure.
bogdanm 0:9b334a45a8ff 56 */
bogdanm 0:9b334a45a8ff 57 virtual FileHandle *open(const char *filename, int flags) = 0;
bogdanm 0:9b334a45a8ff 58
bogdanm 0:9b334a45a8ff 59 /** Remove a file from the filesystem.
bogdanm 0:9b334a45a8ff 60 *
bogdanm 0:9b334a45a8ff 61 * @param filename the name of the file to remove.
bogdanm 0:9b334a45a8ff 62 * @param returns 0 on success, -1 on failure.
bogdanm 0:9b334a45a8ff 63 */
bogdanm 0:9b334a45a8ff 64 virtual int remove(const char *filename) { return -1; };
bogdanm 0:9b334a45a8ff 65
bogdanm 0:9b334a45a8ff 66 /** Rename a file in the filesystem.
bogdanm 0:9b334a45a8ff 67 *
bogdanm 0:9b334a45a8ff 68 * @param oldname the name of the file to rename.
bogdanm 0:9b334a45a8ff 69 * @param newname the name to rename it to.
bogdanm 0:9b334a45a8ff 70 *
bogdanm 0:9b334a45a8ff 71 * @returns
bogdanm 0:9b334a45a8ff 72 * 0 on success,
bogdanm 0:9b334a45a8ff 73 * -1 on failure.
bogdanm 0:9b334a45a8ff 74 */
bogdanm 0:9b334a45a8ff 75 virtual int rename(const char *oldname, const char *newname) { return -1; };
bogdanm 0:9b334a45a8ff 76
bogdanm 0:9b334a45a8ff 77 /** Opens a directory in the filesystem and returns a DirHandle
bogdanm 0:9b334a45a8ff 78 * representing the directory stream.
bogdanm 0:9b334a45a8ff 79 *
bogdanm 0:9b334a45a8ff 80 * @param name The name of the directory to open.
bogdanm 0:9b334a45a8ff 81 *
bogdanm 0:9b334a45a8ff 82 * @returns
bogdanm 0:9b334a45a8ff 83 * A DirHandle representing the directory stream, or
bogdanm 0:9b334a45a8ff 84 * NULL on failure.
bogdanm 0:9b334a45a8ff 85 */
bogdanm 0:9b334a45a8ff 86 virtual DirHandle *opendir(const char *name) { return NULL; };
bogdanm 0:9b334a45a8ff 87
bogdanm 0:9b334a45a8ff 88 /** Creates a directory in the filesystem.
bogdanm 0:9b334a45a8ff 89 *
bogdanm 0:9b334a45a8ff 90 * @param name The name of the directory to create.
bogdanm 0:9b334a45a8ff 91 * @param mode The permissions to create the directory with.
bogdanm 0:9b334a45a8ff 92 *
bogdanm 0:9b334a45a8ff 93 * @returns
bogdanm 0:9b334a45a8ff 94 * 0 on success,
bogdanm 0:9b334a45a8ff 95 * -1 on failure.
bogdanm 0:9b334a45a8ff 96 */
bogdanm 0:9b334a45a8ff 97 virtual int mkdir(const char *name, mode_t mode) { return -1; }
bogdanm 0:9b334a45a8ff 98
bogdanm 0:9b334a45a8ff 99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
bogdanm 0:9b334a45a8ff 100 };
bogdanm 0:9b334a45a8ff 101
bogdanm 0:9b334a45a8ff 102 } // namespace mbed
bogdanm 0:9b334a45a8ff 103
bogdanm 0:9b334a45a8ff 104 #endif