Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

platform/FileSystemLike.h@3:993b4d6ff61e, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:33:24 2021 +0000
Revision:
3:993b4d6ff61e
Parent:
0:083111ae2a11 
added CAN3

Who changed what in which revision?

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