Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/FileSystemLike.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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