Lancaster University / mbed-dev-bin

Binary version of Lancaster University's mbed branch, soon to be merged. The source lives here:https://developer.mbed.org/teams/Lancaster-University/code/mbed-src/

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal ... more

Fork of mbed-lite-test by Lancaster University

FileSystemLike.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

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