Vladimir Vana / mbed

pro vyuku PSS v Jecne

FileSystemLike.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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