Morpheus / mbed-hal

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.

Dependencies:   target-freescale

api/FileSystemLike.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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