Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/FileSystemLike.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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