]>
git.gir.st - tmk_keyboard.git/blob - tmk_core/tool/mbed/mbed-sdk/libraries/mbed/api/FileSystemLike.h
1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2013 ARM Limited
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef MBED_FILESYSTEMLIKE_H
17 #define MBED_FILESYSTEMLIKE_H
22 #include "FileHandle.h"
23 #include "DirHandle.h"
27 /** A filesystem-like object is one that can be used to open files
28 * though it by fopen("/name/filename", mode)
30 * Implementations must define at least open (the default definitions
31 * of the rest of the functions just return error values).
33 class FileSystemLike
: public FileBase
{
36 /** FileSystemLike constructor
38 * @param name The name to use for the filesystem.
40 FileSystemLike(const char *name
);
42 virtual ~FileSystemLike();
44 static DirHandle
*opendir();
45 friend class BaseDirHandle
;
47 /** Opens a file from the filesystem
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.
54 * A pointer to a FileHandle object representing the
55 * file on success, or NULL on failure.
57 virtual FileHandle
*open(const char *filename
, int flags
) = 0;
59 /** Remove a file from the filesystem.
61 * @param filename the name of the file to remove.
62 * @param returns 0 on success, -1 on failure.
64 virtual int remove(const char *filename
) { return -1; };
66 /** Rename a file in the filesystem.
68 * @param oldname the name of the file to rename.
69 * @param newname the name to rename it to.
75 virtual int rename(const char *oldname
, const char *newname
) { return -1; };
77 /** Opens a directory in the filesystem and returns a DirHandle
78 * representing the directory stream.
80 * @param name The name of the directory to open.
83 * A DirHandle representing the directory stream, or
86 virtual DirHandle
*opendir(const char *name
) { return NULL
; };
88 /** Creates a directory in the filesystem.
90 * @param name The name of the directory to create.
91 * @param mode The permissions to create the directory with.
97 virtual int mkdir(const char *name
, mode_t mode
) { return -1; }
99 // TODO other filesystem functions (mkdir, rm, rn, ls etc)