ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

FileSystemLike.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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