Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/FileSystemLike.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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