Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/FileSystemLike.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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