tmk_core/tool/mbed/mbed-sdk/libraries/mbed/api/FileSystemLike.h

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