Gan likun / mbed1-dev

001

platform/FileSystemHandle.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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