mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/FileSystemLike.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

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