Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/FileSystemLike.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_FILESYSTEMLIKE_H
NYX 0:85b3fd62ea1a 17 #define MBED_FILESYSTEMLIKE_H
NYX 0:85b3fd62ea1a 18
NYX 0:85b3fd62ea1a 19 #include "platform/platform.h"
NYX 0:85b3fd62ea1a 20
NYX 0:85b3fd62ea1a 21 #include "platform/FileSystemHandle.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 platform */
NYX 0:85b3fd62ea1a 28
NYX 0:85b3fd62ea1a 29
NYX 0:85b3fd62ea1a 30 /** A filesystem-like object is one that can be used to open file-like
NYX 0:85b3fd62ea1a 31 * objects though it by fopen("/name/filename", mode)
NYX 0:85b3fd62ea1a 32 *
NYX 0:85b3fd62ea1a 33 * Implementations must define at least open (the default definitions
NYX 0:85b3fd62ea1a 34 * of the rest of the functions just return error values).
NYX 0:85b3fd62ea1a 35 *
NYX 0:85b3fd62ea1a 36 * @note Synchronization level: Set by subclass
NYX 0:85b3fd62ea1a 37 * @ingroup platform
NYX 0:85b3fd62ea1a 38 */
NYX 0:85b3fd62ea1a 39 class FileSystemLike : public FileSystemHandle, public FileBase, private NonCopyable<FileSystemLike> {
NYX 0:85b3fd62ea1a 40 public:
NYX 0:85b3fd62ea1a 41 /** FileSystemLike lifetime
NYX 0:85b3fd62ea1a 42 */
NYX 0:85b3fd62ea1a 43 FileSystemLike(const char *name = NULL) : FileBase(name, FileSystemPathType) {}
NYX 0:85b3fd62ea1a 44 virtual ~FileSystemLike() {}
NYX 0:85b3fd62ea1a 45
NYX 0:85b3fd62ea1a 46 // Inherited functions with name conflicts
NYX 0:85b3fd62ea1a 47 using FileSystemHandle::open;
NYX 0:85b3fd62ea1a 48
NYX 0:85b3fd62ea1a 49 /** Open a file on the filesystem
NYX 0:85b3fd62ea1a 50 *
NYX 0:85b3fd62ea1a 51 * @param path The name of the file to open
NYX 0:85b3fd62ea1a 52 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
NYX 0:85b3fd62ea1a 53 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
NYX 0:85b3fd62ea1a 54 * @return A file handle on success, NULL on failure
NYX 0:85b3fd62ea1a 55 * @deprecated Replaced by `int open(FileHandle **, ...)` for propagating error codes
NYX 0:85b3fd62ea1a 56 */
NYX 0:85b3fd62ea1a 57 MBED_DEPRECATED_SINCE("mbed-os-5.5",
NYX 0:85b3fd62ea1a 58 "Replaced by `int open(FileHandle **, ...)` for propagating error codes")
NYX 0:85b3fd62ea1a 59 FileHandle *open(const char *path, int flags)
NYX 0:85b3fd62ea1a 60 {
NYX 0:85b3fd62ea1a 61 FileHandle *file;
NYX 0:85b3fd62ea1a 62 int err = open(&file, path, flags);
NYX 0:85b3fd62ea1a 63 return err ? NULL : file;
NYX 0:85b3fd62ea1a 64 }
NYX 0:85b3fd62ea1a 65
NYX 0:85b3fd62ea1a 66 /** Open a directory on the filesystem
NYX 0:85b3fd62ea1a 67 *
NYX 0:85b3fd62ea1a 68 * @param path Name of the directory to open
NYX 0:85b3fd62ea1a 69 * @return A directory handle on success, NULL on failure
NYX 0:85b3fd62ea1a 70 * @deprecated Replaced by `int open(DirHandle **, ...)` for propagating error codes
NYX 0:85b3fd62ea1a 71 */
NYX 0:85b3fd62ea1a 72 MBED_DEPRECATED_SINCE("mbed-os-5.5",
NYX 0:85b3fd62ea1a 73 "Replaced by `int open(DirHandle **, ...)` for propagating error codes")
NYX 0:85b3fd62ea1a 74 DirHandle *opendir(const char *path)
NYX 0:85b3fd62ea1a 75 {
NYX 0:85b3fd62ea1a 76 DirHandle *dir;
NYX 0:85b3fd62ea1a 77 int err = open(&dir, path);
NYX 0:85b3fd62ea1a 78 return err ? NULL : dir;
NYX 0:85b3fd62ea1a 79 }
NYX 0:85b3fd62ea1a 80 };
NYX 0:85b3fd62ea1a 81
NYX 0:85b3fd62ea1a 82
NYX 0:85b3fd62ea1a 83 } // namespace mbed
NYX 0:85b3fd62ea1a 84
NYX 0:85b3fd62ea1a 85 #endif