mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/FileSystemLike.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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