jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

FileSystemLike.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
48:49c296715c73
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

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 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_FILESYSTEMLIKE_H
emilmont 44:24d45a770a51 23 #define MBED_FILESYSTEMLIKE_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 54:71b101360fb9 27 #include "FileBase.h"
emilmont 44:24d45a770a51 28 #include "FileHandle.h"
emilmont 44:24d45a770a51 29 #include "DirHandle.h"
emilmont 44:24d45a770a51 30
emilmont 44:24d45a770a51 31 namespace mbed {
emilmont 44:24d45a770a51 32
emilmont 44:24d45a770a51 33 /** A filesystem-like object is one that can be used to open files
emilmont 44:24d45a770a51 34 * though it by fopen("/name/filename", mode)
emilmont 44:24d45a770a51 35 *
emilmont 44:24d45a770a51 36 * Implementations must define at least open (the default definitions
emilmont 44:24d45a770a51 37 * of the rest of the functions just return error values).
emilmont 44:24d45a770a51 38 */
emilmont 54:71b101360fb9 39 class FileSystemLike : public FileBase {
emilmont 44:24d45a770a51 40
emilmont 44:24d45a770a51 41 public:
emilmont 44:24d45a770a51 42 /** FileSystemLike constructor
emilmont 44:24d45a770a51 43 *
emilmont 44:24d45a770a51 44 * @param name The name to use for the filesystem.
emilmont 44:24d45a770a51 45 */
emilmont 44:24d45a770a51 46 FileSystemLike(const char *name);
emilmont 44:24d45a770a51 47
emilmont 44:24d45a770a51 48 virtual ~FileSystemLike();
emilmont 44:24d45a770a51 49
emilmont 44:24d45a770a51 50 static DirHandle *opendir();
emilmont 44:24d45a770a51 51 friend class BaseDirHandle;
emilmont 44:24d45a770a51 52
emilmont 44:24d45a770a51 53 /** Opens a file from the filesystem
emilmont 44:24d45a770a51 54 *
emilmont 44:24d45a770a51 55 * @param filename The name of the file to open.
emilmont 44:24d45a770a51 56 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
emilmont 44:24d45a770a51 57 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
emilmont 44:24d45a770a51 58 *
emilmont 44:24d45a770a51 59 * @returns
emilmont 44:24d45a770a51 60 * A pointer to a FileHandle object representing the
emilmont 44:24d45a770a51 61 * file on success, or NULL on failure.
emilmont 44:24d45a770a51 62 */
emilmont 44:24d45a770a51 63 virtual FileHandle *open(const char *filename, int flags) = 0;
emilmont 44:24d45a770a51 64
emilmont 44:24d45a770a51 65 /** Remove a file from the filesystem.
emilmont 44:24d45a770a51 66 *
emilmont 44:24d45a770a51 67 * @param filename the name of the file to remove.
emilmont 44:24d45a770a51 68 * @param returns 0 on success, -1 on failure.
emilmont 44:24d45a770a51 69 */
emilmont 44:24d45a770a51 70 virtual int remove(const char *filename) { return -1; };
emilmont 44:24d45a770a51 71
emilmont 44:24d45a770a51 72 /** Rename a file in the filesystem.
emilmont 44:24d45a770a51 73 *
emilmont 44:24d45a770a51 74 * @param oldname the name of the file to rename.
emilmont 44:24d45a770a51 75 * @param newname the name to rename it to.
emilmont 44:24d45a770a51 76 *
emilmont 44:24d45a770a51 77 * @returns
emilmont 44:24d45a770a51 78 * 0 on success,
emilmont 44:24d45a770a51 79 * -1 on failure.
emilmont 44:24d45a770a51 80 */
emilmont 44:24d45a770a51 81 virtual int rename(const char *oldname, const char *newname) { return -1; };
emilmont 44:24d45a770a51 82
emilmont 44:24d45a770a51 83 /** Opens a directory in the filesystem and returns a DirHandle
emilmont 44:24d45a770a51 84 * representing the directory stream.
emilmont 44:24d45a770a51 85 *
emilmont 44:24d45a770a51 86 * @param name The name of the directory to open.
emilmont 44:24d45a770a51 87 *
emilmont 44:24d45a770a51 88 * @returns
emilmont 44:24d45a770a51 89 * A DirHandle representing the directory stream, or
emilmont 44:24d45a770a51 90 * NULL on failure.
emilmont 44:24d45a770a51 91 */
emilmont 44:24d45a770a51 92 virtual DirHandle *opendir(const char *name) { return NULL; };
emilmont 44:24d45a770a51 93
emilmont 44:24d45a770a51 94 /** Creates a directory in the filesystem.
emilmont 44:24d45a770a51 95 *
emilmont 44:24d45a770a51 96 * @param name The name of the directory to create.
emilmont 44:24d45a770a51 97 * @param mode The permissions to create the directory with.
emilmont 44:24d45a770a51 98 *
emilmont 44:24d45a770a51 99 * @returns
emilmont 44:24d45a770a51 100 * 0 on success,
emilmont 44:24d45a770a51 101 * -1 on failure.
emilmont 44:24d45a770a51 102 */
emilmont 44:24d45a770a51 103 virtual int mkdir(const char *name, mode_t mode) { return -1; }
emilmont 54:71b101360fb9 104
emilmont 44:24d45a770a51 105 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
emilmont 44:24d45a770a51 106 };
emilmont 44:24d45a770a51 107
emilmont 44:24d45a770a51 108 } // namespace mbed
emilmont 44:24d45a770a51 109
emilmont 44:24d45a770a51 110 #endif