mbed library sources, mbed-dev only for TYBLE16
Fork of mbed-dev by
Please refer flowing link.
/users/kenjiArai/notebook/tyble16-module-will-become-a-mbed-family--mbedliza/
platform/FileSystemHandle.h@182:976b131d2800, 2018-02-25 (annotated)
- Committer:
- kenjiArai
- Date:
- Sun Feb 25 02:00:51 2018 +0000
- Revision:
- 182:976b131d2800
- Parent:
- 178:79309dc6340a
Only for TYBLE16
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 167:e84263d55307 | 1 | /* mbed Microcontroller Library |
AnnaBridge | 167:e84263d55307 | 2 | * Copyright (c) 2006-2013 ARM Limited |
AnnaBridge | 167:e84263d55307 | 3 | * |
AnnaBridge | 167:e84263d55307 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 167:e84263d55307 | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 167:e84263d55307 | 6 | * You may obtain a copy of the License at |
AnnaBridge | 167:e84263d55307 | 7 | * |
AnnaBridge | 167:e84263d55307 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 167:e84263d55307 | 9 | * |
AnnaBridge | 167:e84263d55307 | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 167:e84263d55307 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 167:e84263d55307 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 167:e84263d55307 | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 167:e84263d55307 | 14 | * limitations under the License. |
AnnaBridge | 167:e84263d55307 | 15 | */ |
AnnaBridge | 167:e84263d55307 | 16 | #ifndef MBED_FILESYSTEMHANDLE_H |
AnnaBridge | 167:e84263d55307 | 17 | #define MBED_FILESYSTEMHANDLE_H |
AnnaBridge | 167:e84263d55307 | 18 | |
AnnaBridge | 167:e84263d55307 | 19 | #include "platform/platform.h" |
AnnaBridge | 167:e84263d55307 | 20 | |
AnnaBridge | 167:e84263d55307 | 21 | #include "platform/FileBase.h" |
AnnaBridge | 167:e84263d55307 | 22 | #include "platform/FileHandle.h" |
AnnaBridge | 167:e84263d55307 | 23 | #include "platform/DirHandle.h" |
AnnaBridge | 168:9672193075cf | 24 | #include "platform/NonCopyable.h" |
AnnaBridge | 167:e84263d55307 | 25 | |
AnnaBridge | 167:e84263d55307 | 26 | namespace mbed { |
AnnaBridge | 177:d650f5d4c87a | 27 | /** \addtogroup platform */ |
AnnaBridge | 167:e84263d55307 | 28 | /** @{*/ |
AnnaBridge | 178:79309dc6340a | 29 | /** |
AnnaBridge | 178:79309dc6340a | 30 | * \defgroup platform_FileSystemHandle FileSystemHandle functions |
AnnaBridge | 178:79309dc6340a | 31 | * @{ |
AnnaBridge | 178:79309dc6340a | 32 | */ |
AnnaBridge | 167:e84263d55307 | 33 | |
AnnaBridge | 167:e84263d55307 | 34 | |
AnnaBridge | 167:e84263d55307 | 35 | /** A filesystem-like object is one that can be used to open file-like |
AnnaBridge | 167:e84263d55307 | 36 | * objects though it by fopen("/name/filename", mode) |
AnnaBridge | 167:e84263d55307 | 37 | * |
AnnaBridge | 167:e84263d55307 | 38 | * Implementations must define at least open (the default definitions |
AnnaBridge | 167:e84263d55307 | 39 | * of the rest of the functions just return error values). |
AnnaBridge | 167:e84263d55307 | 40 | * |
AnnaBridge | 167:e84263d55307 | 41 | * @note Synchronization level: Set by subclass |
AnnaBridge | 167:e84263d55307 | 42 | */ |
AnnaBridge | 168:9672193075cf | 43 | class FileSystemHandle : private NonCopyable<FileSystemHandle> { |
AnnaBridge | 167:e84263d55307 | 44 | public: |
AnnaBridge | 167:e84263d55307 | 45 | /** FileSystemHandle lifetime |
AnnaBridge | 167:e84263d55307 | 46 | */ |
AnnaBridge | 167:e84263d55307 | 47 | virtual ~FileSystemHandle() {} |
AnnaBridge | 167:e84263d55307 | 48 | |
AnnaBridge | 167:e84263d55307 | 49 | /** Open a file on the filesystem |
AnnaBridge | 167:e84263d55307 | 50 | * |
AnnaBridge | 167:e84263d55307 | 51 | * @param file Destination for the handle to a newly created file |
AnnaBridge | 167:e84263d55307 | 52 | * @param filename The name of the file to open |
AnnaBridge | 167:e84263d55307 | 53 | * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR, |
AnnaBridge | 167:e84263d55307 | 54 | * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND |
AnnaBridge | 167:e84263d55307 | 55 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 56 | */ |
AnnaBridge | 167:e84263d55307 | 57 | virtual int open(FileHandle **file, const char *filename, int flags) = 0; |
AnnaBridge | 167:e84263d55307 | 58 | |
AnnaBridge | 167:e84263d55307 | 59 | /** Open a directory on the filesystem |
AnnaBridge | 167:e84263d55307 | 60 | * |
AnnaBridge | 167:e84263d55307 | 61 | * @param dir Destination for the handle to the directory |
AnnaBridge | 167:e84263d55307 | 62 | * @param path Name of the directory to open |
AnnaBridge | 167:e84263d55307 | 63 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 64 | */ |
AnnaBridge | 167:e84263d55307 | 65 | virtual int open(DirHandle **dir, const char *path); |
AnnaBridge | 167:e84263d55307 | 66 | |
AnnaBridge | 167:e84263d55307 | 67 | /** Remove a file from the filesystem. |
AnnaBridge | 167:e84263d55307 | 68 | * |
AnnaBridge | 167:e84263d55307 | 69 | * @param path The name of the file to remove. |
AnnaBridge | 167:e84263d55307 | 70 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 71 | */ |
AnnaBridge | 167:e84263d55307 | 72 | virtual int remove(const char *path); |
AnnaBridge | 167:e84263d55307 | 73 | |
AnnaBridge | 167:e84263d55307 | 74 | /** Rename a file in the filesystem. |
AnnaBridge | 167:e84263d55307 | 75 | * |
AnnaBridge | 167:e84263d55307 | 76 | * @param path The name of the file to rename. |
AnnaBridge | 167:e84263d55307 | 77 | * @param newpath The name to rename it to |
AnnaBridge | 167:e84263d55307 | 78 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 79 | */ |
AnnaBridge | 167:e84263d55307 | 80 | virtual int rename(const char *path, const char *newpath); |
AnnaBridge | 167:e84263d55307 | 81 | |
AnnaBridge | 167:e84263d55307 | 82 | /** Store information about the file in a stat structure |
AnnaBridge | 167:e84263d55307 | 83 | * |
AnnaBridge | 167:e84263d55307 | 84 | * @param path The name of the file to find information about |
AnnaBridge | 167:e84263d55307 | 85 | * @param st The stat buffer to write to |
AnnaBridge | 167:e84263d55307 | 86 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 87 | */ |
AnnaBridge | 167:e84263d55307 | 88 | virtual int stat(const char *path, struct stat *st); |
AnnaBridge | 167:e84263d55307 | 89 | |
AnnaBridge | 167:e84263d55307 | 90 | /** Create a directory in the filesystem. |
AnnaBridge | 167:e84263d55307 | 91 | * |
AnnaBridge | 167:e84263d55307 | 92 | * @param path The name of the directory to create. |
AnnaBridge | 167:e84263d55307 | 93 | * @param mode The permissions with which to create the directory |
AnnaBridge | 167:e84263d55307 | 94 | * @return 0 on success, negative error code on failure |
AnnaBridge | 167:e84263d55307 | 95 | */ |
AnnaBridge | 167:e84263d55307 | 96 | virtual int mkdir(const char *path, mode_t mode); |
AnnaBridge | 167:e84263d55307 | 97 | }; |
AnnaBridge | 178:79309dc6340a | 98 | /**@}*/ |
AnnaBridge | 167:e84263d55307 | 99 | |
AnnaBridge | 178:79309dc6340a | 100 | /**@}*/ |
AnnaBridge | 167:e84263d55307 | 101 | |
AnnaBridge | 167:e84263d55307 | 102 | } // namespace mbed |
AnnaBridge | 167:e84263d55307 | 103 | |
AnnaBridge | 167:e84263d55307 | 104 | #endif |
AnnaBridge | 167:e84263d55307 | 105 | |
AnnaBridge | 167:e84263d55307 | 106 | /** @}*/ |