jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

FileSystemLike.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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