Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/FileSystemHandle.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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