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