takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/FileSystemLike.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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