PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/FileSystemLike.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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