Gan likun / mbed-dev11

platform/FileSystemLike.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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