Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

FileSystemLike.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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