mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

api/FileSystemLike.h@635:a11c0372f0ba, 2015-09-30 (annotated)

Committer:
mbed_official
Date:
Wed Sep 30 17:00:09 2015 +0100
Revision:
635:a11c0372f0ba
Parent:
13:0645d8841f51 
Synchronized with git revision d29c98dae61be0946ddf3a3c641c7726056f9452



Full URL: https://github.com/mbedmicro/mbed/commit/d29c98dae61be0946ddf3a3c641c7726056f9452/



Added support for SAMW25

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 13:0645d8841f51 1 /* mbed Microcontroller Library
bogdanm 13:0645d8841f51 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 13:0645d8841f51 3 *
bogdanm 13:0645d8841f51 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 13:0645d8841f51 5 * you may not use this file except in compliance with the License.
bogdanm 13:0645d8841f51 6 * You may obtain a copy of the License at
bogdanm 13:0645d8841f51 7 *
bogdanm 13:0645d8841f51 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 13:0645d8841f51 9 *
bogdanm 13:0645d8841f51 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 13:0645d8841f51 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 13:0645d8841f51 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 13:0645d8841f51 13 * See the License for the specific language governing permissions and
bogdanm 13:0645d8841f51 14 * limitations under the License.
bogdanm 13:0645d8841f51 15 */
bogdanm 13:0645d8841f51 16 #ifndef MBED_FILESYSTEMLIKE_H
bogdanm 13:0645d8841f51 17 #define MBED_FILESYSTEMLIKE_H
bogdanm 13:0645d8841f51 18
bogdanm 13:0645d8841f51 19 #include "platform.h"
bogdanm 13:0645d8841f51 20
bogdanm 13:0645d8841f51 21 #include "FileBase.h"
bogdanm 13:0645d8841f51 22 #include "FileHandle.h"
bogdanm 13:0645d8841f51 23 #include "DirHandle.h"
bogdanm 13:0645d8841f51 24
bogdanm 13:0645d8841f51 25 namespace mbed {
bogdanm 13:0645d8841f51 26
bogdanm 13:0645d8841f51 27 /** A filesystem-like object is one that can be used to open files
bogdanm 13:0645d8841f51 28 * though it by fopen("/name/filename", mode)
bogdanm 13:0645d8841f51 29 *
bogdanm 13:0645d8841f51 30 * Implementations must define at least open (the default definitions
bogdanm 13:0645d8841f51 31 * of the rest of the functions just return error values).
bogdanm 13:0645d8841f51 32 */
bogdanm 13:0645d8841f51 33 class FileSystemLike : public FileBase {
bogdanm 13:0645d8841f51 34
bogdanm 13:0645d8841f51 35 public:
bogdanm 13:0645d8841f51 36 /** FileSystemLike constructor
bogdanm 13:0645d8841f51 37 *
bogdanm 13:0645d8841f51 38 * @param name The name to use for the filesystem.
bogdanm 13:0645d8841f51 39 */
bogdanm 13:0645d8841f51 40 FileSystemLike(const char *name);
bogdanm 13:0645d8841f51 41
bogdanm 13:0645d8841f51 42 virtual ~FileSystemLike();
bogdanm 13:0645d8841f51 43
bogdanm 13:0645d8841f51 44 static DirHandle *opendir();
bogdanm 13:0645d8841f51 45 friend class BaseDirHandle;
bogdanm 13:0645d8841f51 46
bogdanm 13:0645d8841f51 47 /** Opens a file from the filesystem
bogdanm 13:0645d8841f51 48 *
bogdanm 13:0645d8841f51 49 * @param filename The name of the file to open.
bogdanm 13:0645d8841f51 50 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
bogdanm 13:0645d8841f51 51 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
bogdanm 13:0645d8841f51 52 *
bogdanm 13:0645d8841f51 53 * @returns
bogdanm 13:0645d8841f51 54 * A pointer to a FileHandle object representing the
bogdanm 13:0645d8841f51 55 * file on success, or NULL on failure.
bogdanm 13:0645d8841f51 56 */
bogdanm 13:0645d8841f51 57 virtual FileHandle *open(const char *filename, int flags) = 0;
bogdanm 13:0645d8841f51 58
bogdanm 13:0645d8841f51 59 /** Remove a file from the filesystem.
bogdanm 13:0645d8841f51 60 *
bogdanm 13:0645d8841f51 61 * @param filename the name of the file to remove.
bogdanm 13:0645d8841f51 62 * @param returns 0 on success, -1 on failure.
bogdanm 13:0645d8841f51 63 */
bogdanm 13:0645d8841f51 64 virtual int remove(const char *filename) { return -1; };
bogdanm 13:0645d8841f51 65
bogdanm 13:0645d8841f51 66 /** Rename a file in the filesystem.
bogdanm 13:0645d8841f51 67 *
bogdanm 13:0645d8841f51 68 * @param oldname the name of the file to rename.
bogdanm 13:0645d8841f51 69 * @param newname the name to rename it to.
bogdanm 13:0645d8841f51 70 *
bogdanm 13:0645d8841f51 71 * @returns
bogdanm 13:0645d8841f51 72 * 0 on success,
bogdanm 13:0645d8841f51 73 * -1 on failure.
bogdanm 13:0645d8841f51 74 */
bogdanm 13:0645d8841f51 75 virtual int rename(const char *oldname, const char *newname) { return -1; };
bogdanm 13:0645d8841f51 76
bogdanm 13:0645d8841f51 77 /** Opens a directory in the filesystem and returns a DirHandle
bogdanm 13:0645d8841f51 78 * representing the directory stream.
bogdanm 13:0645d8841f51 79 *
bogdanm 13:0645d8841f51 80 * @param name The name of the directory to open.
bogdanm 13:0645d8841f51 81 *
bogdanm 13:0645d8841f51 82 * @returns
bogdanm 13:0645d8841f51 83 * A DirHandle representing the directory stream, or
bogdanm 13:0645d8841f51 84 * NULL on failure.
bogdanm 13:0645d8841f51 85 */
bogdanm 13:0645d8841f51 86 virtual DirHandle *opendir(const char *name) { return NULL; };
bogdanm 13:0645d8841f51 87
bogdanm 13:0645d8841f51 88 /** Creates a directory in the filesystem.
bogdanm 13:0645d8841f51 89 *
bogdanm 13:0645d8841f51 90 * @param name The name of the directory to create.
bogdanm 13:0645d8841f51 91 * @param mode The permissions to create the directory with.
bogdanm 13:0645d8841f51 92 *
bogdanm 13:0645d8841f51 93 * @returns
bogdanm 13:0645d8841f51 94 * 0 on success,
bogdanm 13:0645d8841f51 95 * -1 on failure.
bogdanm 13:0645d8841f51 96 */
bogdanm 13:0645d8841f51 97 virtual int mkdir(const char *name, mode_t mode) { return -1; }
bogdanm 13:0645d8841f51 98
bogdanm 13:0645d8841f51 99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
bogdanm 13:0645d8841f51 100 };
bogdanm 13:0645d8841f51 101
bogdanm 13:0645d8841f51 102 } // namespace mbed
bogdanm 13:0645d8841f51 103
bogdanm 13:0645d8841f51 104 #endif