Gan likun / The prosthetic control

The prosthetic control（MIT）

platform/FileSystemLike.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:20e0c61e0684 1 /* mbed Microcontroller Library
ganlikun 0:20e0c61e0684 2 * Copyright (c) 2006-2013 ARM Limited
ganlikun 0:20e0c61e0684 3 *
ganlikun 0:20e0c61e0684 4 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:20e0c61e0684 5 * you may not use this file except in compliance with the License.
ganlikun 0:20e0c61e0684 6 * You may obtain a copy of the License at
ganlikun 0:20e0c61e0684 7 *
ganlikun 0:20e0c61e0684 8 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:20e0c61e0684 9 *
ganlikun 0:20e0c61e0684 10 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:20e0c61e0684 11 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:20e0c61e0684 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:20e0c61e0684 13 * See the License for the specific language governing permissions and
ganlikun 0:20e0c61e0684 14 * limitations under the License.
ganlikun 0:20e0c61e0684 15 */
ganlikun 0:20e0c61e0684 16 #ifndef MBED_FILESYSTEMLIKE_H
ganlikun 0:20e0c61e0684 17 #define MBED_FILESYSTEMLIKE_H
ganlikun 0:20e0c61e0684 18
ganlikun 0:20e0c61e0684 19 #include "platform/platform.h"
ganlikun 0:20e0c61e0684 20
ganlikun 0:20e0c61e0684 21 #include "platform/FileSystemHandle.h"
ganlikun 0:20e0c61e0684 22 #include "platform/FileHandle.h"
ganlikun 0:20e0c61e0684 23 #include "platform/DirHandle.h"
ganlikun 0:20e0c61e0684 24 #include "platform/NonCopyable.h"
ganlikun 0:20e0c61e0684 25
ganlikun 0:20e0c61e0684 26 namespace mbed {
ganlikun 0:20e0c61e0684 27 /** \addtogroup platform */
ganlikun 0:20e0c61e0684 28
ganlikun 0:20e0c61e0684 29
ganlikun 0:20e0c61e0684 30 /** A filesystem-like object is one that can be used to open file-like
ganlikun 0:20e0c61e0684 31 * objects though it by fopen("/name/filename", mode)
ganlikun 0:20e0c61e0684 32 *
ganlikun 0:20e0c61e0684 33 * Implementations must define at least open (the default definitions
ganlikun 0:20e0c61e0684 34 * of the rest of the functions just return error values).
ganlikun 0:20e0c61e0684 35 *
ganlikun 0:20e0c61e0684 36 * @note Synchronization level: Set by subclass
ganlikun 0:20e0c61e0684 37 * @ingroup platform
ganlikun 0:20e0c61e0684 38 */
ganlikun 0:20e0c61e0684 39 class FileSystemLike : public FileSystemHandle, public FileBase, private NonCopyable<FileSystemLike> {
ganlikun 0:20e0c61e0684 40 public:
ganlikun 0:20e0c61e0684 41 /** FileSystemLike lifetime
ganlikun 0:20e0c61e0684 42 */
ganlikun 0:20e0c61e0684 43 FileSystemLike(const char *name = NULL) : FileBase(name, FileSystemPathType) {}
ganlikun 0:20e0c61e0684 44 virtual ~FileSystemLike() {}
ganlikun 0:20e0c61e0684 45
ganlikun 0:20e0c61e0684 46 // Inherited functions with name conflicts
ganlikun 0:20e0c61e0684 47 using FileSystemHandle::open;
ganlikun 0:20e0c61e0684 48
ganlikun 0:20e0c61e0684 49 /** Open a file on the filesystem
ganlikun 0:20e0c61e0684 50 *
ganlikun 0:20e0c61e0684 51 * @param path The name of the file to open
ganlikun 0:20e0c61e0684 52 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
ganlikun 0:20e0c61e0684 53 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
ganlikun 0:20e0c61e0684 54 * @return A file handle on success, NULL on failure
ganlikun 0:20e0c61e0684 55 * @deprecated Replaced by `int open(FileHandle **, ...)` for propagating error codes
ganlikun 0:20e0c61e0684 56 */
ganlikun 0:20e0c61e0684 57 MBED_DEPRECATED_SINCE("mbed-os-5.5",
ganlikun 0:20e0c61e0684 58 "Replaced by `int open(FileHandle **, ...)` for propagating error codes")
ganlikun 0:20e0c61e0684 59 FileHandle *open(const char *path, int flags)
ganlikun 0:20e0c61e0684 60 {
ganlikun 0:20e0c61e0684 61 FileHandle *file;
ganlikun 0:20e0c61e0684 62 int err = open(&file, path, flags);
ganlikun 0:20e0c61e0684 63 return err ? NULL : file;
ganlikun 0:20e0c61e0684 64 }
ganlikun 0:20e0c61e0684 65
ganlikun 0:20e0c61e0684 66 /** Open a directory on the filesystem
ganlikun 0:20e0c61e0684 67 *
ganlikun 0:20e0c61e0684 68 * @param path Name of the directory to open
ganlikun 0:20e0c61e0684 69 * @return A directory handle on success, NULL on failure
ganlikun 0:20e0c61e0684 70 * @deprecated Replaced by `int open(DirHandle **, ...)` for propagating error codes
ganlikun 0:20e0c61e0684 71 */
ganlikun 0:20e0c61e0684 72 MBED_DEPRECATED_SINCE("mbed-os-5.5",
ganlikun 0:20e0c61e0684 73 "Replaced by `int open(DirHandle **, ...)` for propagating error codes")
ganlikun 0:20e0c61e0684 74 DirHandle *opendir(const char *path)
ganlikun 0:20e0c61e0684 75 {
ganlikun 0:20e0c61e0684 76 DirHandle *dir;
ganlikun 0:20e0c61e0684 77 int err = open(&dir, path);
ganlikun 0:20e0c61e0684 78 return err ? NULL : dir;
ganlikun 0:20e0c61e0684 79 }
ganlikun 0:20e0c61e0684 80 };
ganlikun 0:20e0c61e0684 81
ganlikun 0:20e0c61e0684 82
ganlikun 0:20e0c61e0684 83 } // namespace mbed
ganlikun 0:20e0c61e0684 84
ganlikun 0:20e0c61e0684 85 #endif