dev01 Brautlecht / mbed-STM32F030F4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   STM32F031_Blink_Aug17

Fork of mbed-STM32F030F4 by Nothing Special

api/FileSystemLike.h@0:38ccae254a29, 2014-10-18 (annotated)

Committer:
mega64
Date:
Sat Oct 18 02:40:17 2014 +0000
Revision:
0:38ccae254a29
only for STM32F030F4

Who changed what in which revision?

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