cc y / mbed

ads1115 only

Fork of mbed by mbed official

FileSystemLike.h@48:49c296715c73, 2012-11-28 (annotated)

Committer:
emilmont
Date:
Wed Nov 28 16:48:25 2012 +0000
Revision:
48:49c296715c73
Parent:
44:24d45a770a51
Child:
54:71b101360fb9
Fix "opendir"

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_FILESYSTEMLIKE_H
emilmont 44:24d45a770a51 23 #define MBED_FILESYSTEMLIKE_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #ifdef __ARMCC_VERSION
emilmont 44:24d45a770a51 26 # define O_RDONLY 0
emilmont 44:24d45a770a51 27 # define O_WRONLY 1
emilmont 44:24d45a770a51 28 # define O_RDWR 2
emilmont 44:24d45a770a51 29 # define O_CREAT 0x0200
emilmont 44:24d45a770a51 30 # define O_TRUNC 0x0400
emilmont 44:24d45a770a51 31 # define O_APPEND 0x0008
emilmont 44:24d45a770a51 32 typedef int mode_t;
emilmont 44:24d45a770a51 33
emilmont 44:24d45a770a51 34 #else
emilmont 44:24d45a770a51 35 # include <sys/fcntl.h>
emilmont 44:24d45a770a51 36 #endif
emilmont 44:24d45a770a51 37
emilmont 44:24d45a770a51 38 #include "platform.h"
emilmont 44:24d45a770a51 39
emilmont 44:24d45a770a51 40 #include "FileHandle.h"
emilmont 44:24d45a770a51 41 #include "DirHandle.h"
emilmont 44:24d45a770a51 42
emilmont 44:24d45a770a51 43 namespace mbed {
emilmont 44:24d45a770a51 44
emilmont 44:24d45a770a51 45 /** A filesystem-like object is one that can be used to open files
emilmont 44:24d45a770a51 46 * though it by fopen("/name/filename", mode)
emilmont 44:24d45a770a51 47 *
emilmont 44:24d45a770a51 48 * Implementations must define at least open (the default definitions
emilmont 44:24d45a770a51 49 * of the rest of the functions just return error values).
emilmont 44:24d45a770a51 50 */
emilmont 44:24d45a770a51 51 class FileSystemLike {
emilmont 44:24d45a770a51 52
emilmont 44:24d45a770a51 53 public:
emilmont 44:24d45a770a51 54 /** FileSystemLike constructor
emilmont 44:24d45a770a51 55 *
emilmont 44:24d45a770a51 56 * @param name The name to use for the filesystem.
emilmont 44:24d45a770a51 57 */
emilmont 44:24d45a770a51 58 FileSystemLike(const char *name);
emilmont 44:24d45a770a51 59
emilmont 44:24d45a770a51 60 virtual ~FileSystemLike();
emilmont 44:24d45a770a51 61
emilmont 44:24d45a770a51 62 /* Function lookup
emilmont 44:24d45a770a51 63 * Lookup and return the object that has the given name.
emilmont 44:24d45a770a51 64 *
emilmont 44:24d45a770a51 65 * Variables
emilmont 44:24d45a770a51 66 * name - the name to lookup.
emilmont 44:24d45a770a51 67 * len - the length of name.
emilmont 44:24d45a770a51 68 */
emilmont 44:24d45a770a51 69 static FileSystemLike *lookup(const char *name, unsigned int len);
emilmont 44:24d45a770a51 70
emilmont 44:24d45a770a51 71 static DirHandle *opendir();
emilmont 44:24d45a770a51 72 friend class BaseDirHandle;
emilmont 44:24d45a770a51 73
emilmont 44:24d45a770a51 74 /** Opens a file from the filesystem
emilmont 44:24d45a770a51 75 *
emilmont 44:24d45a770a51 76 * @param filename The name of the file to open.
emilmont 44:24d45a770a51 77 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
emilmont 44:24d45a770a51 78 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
emilmont 44:24d45a770a51 79 *
emilmont 44:24d45a770a51 80 * @returns
emilmont 44:24d45a770a51 81 * A pointer to a FileHandle object representing the
emilmont 44:24d45a770a51 82 * file on success, or NULL on failure.
emilmont 44:24d45a770a51 83 */
emilmont 44:24d45a770a51 84 virtual FileHandle *open(const char *filename, int flags) = 0;
emilmont 44:24d45a770a51 85
emilmont 44:24d45a770a51 86 /** Remove a file from the filesystem.
emilmont 44:24d45a770a51 87 *
emilmont 44:24d45a770a51 88 * @param filename the name of the file to remove.
emilmont 44:24d45a770a51 89 * @param returns 0 on success, -1 on failure.
emilmont 44:24d45a770a51 90 */
emilmont 44:24d45a770a51 91 virtual int remove(const char *filename) { return -1; };
emilmont 44:24d45a770a51 92
emilmont 44:24d45a770a51 93 /** Rename a file in the filesystem.
emilmont 44:24d45a770a51 94 *
emilmont 44:24d45a770a51 95 * @param oldname the name of the file to rename.
emilmont 44:24d45a770a51 96 * @param newname the name to rename it to.
emilmont 44:24d45a770a51 97 *
emilmont 44:24d45a770a51 98 * @returns
emilmont 44:24d45a770a51 99 * 0 on success,
emilmont 44:24d45a770a51 100 * -1 on failure.
emilmont 44:24d45a770a51 101 */
emilmont 44:24d45a770a51 102 virtual int rename(const char *oldname, const char *newname) { return -1; };
emilmont 44:24d45a770a51 103
emilmont 44:24d45a770a51 104 /** Opens a directory in the filesystem and returns a DirHandle
emilmont 44:24d45a770a51 105 * representing the directory stream.
emilmont 44:24d45a770a51 106 *
emilmont 44:24d45a770a51 107 * @param name The name of the directory to open.
emilmont 44:24d45a770a51 108 *
emilmont 44:24d45a770a51 109 * @returns
emilmont 44:24d45a770a51 110 * A DirHandle representing the directory stream, or
emilmont 44:24d45a770a51 111 * NULL on failure.
emilmont 44:24d45a770a51 112 */
emilmont 44:24d45a770a51 113 virtual DirHandle *opendir(const char *name) { return NULL; };
emilmont 44:24d45a770a51 114
emilmont 44:24d45a770a51 115 /** Creates a directory in the filesystem.
emilmont 44:24d45a770a51 116 *
emilmont 44:24d45a770a51 117 * @param name The name of the directory to create.
emilmont 44:24d45a770a51 118 * @param mode The permissions to create the directory with.
emilmont 44:24d45a770a51 119 *
emilmont 44:24d45a770a51 120 * @returns
emilmont 44:24d45a770a51 121 * 0 on success,
emilmont 44:24d45a770a51 122 * -1 on failure.
emilmont 44:24d45a770a51 123 */
emilmont 44:24d45a770a51 124 virtual int mkdir(const char *name, mode_t mode) { return -1; }
emilmont 44:24d45a770a51 125
emilmont 44:24d45a770a51 126 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
emilmont 44:24d45a770a51 127
emilmont 44:24d45a770a51 128 protected:
emilmont 44:24d45a770a51 129 static FileSystemLike *_head;
emilmont 44:24d45a770a51 130 FileSystemLike *_next;
emilmont 44:24d45a770a51 131 const char *_name;
emilmont 44:24d45a770a51 132 };
emilmont 44:24d45a770a51 133
emilmont 44:24d45a770a51 134 class FilePath {
emilmont 44:24d45a770a51 135 public:
emilmont 44:24d45a770a51 136 FilePath(const char* file_path);
emilmont 44:24d45a770a51 137
emilmont 44:24d45a770a51 138 const char* fileName(void);
emilmont 44:24d45a770a51 139 FileSystemLike* fileSystem(void);
emilmont 44:24d45a770a51 140
emilmont 44:24d45a770a51 141 private:
emilmont 44:24d45a770a51 142 const char* file_name;
emilmont 44:24d45a770a51 143 FileSystemLike* fs;
emilmont 44:24d45a770a51 144 };
emilmont 44:24d45a770a51 145
emilmont 44:24d45a770a51 146 } // namespace mbed
emilmont 44:24d45a770a51 147
emilmont 44:24d45a770a51 148 #endif