Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/FileSystemLike.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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