Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

FileSystemLike.h@8:00a04e5cd407, 2009-02-03 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Tue Feb 03 18:02:02 2009 +0000
Revision:
8:00a04e5cd407
Parent:
5:62573be585e9
Child:
9:cf0d45ce28a6
* Update to improve filesystem support

 * Add a generic FATFileSystem

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 4:5d1359a283bc 1 /* Copyright 2008 ARM Limited. All rights reserved. */
simon.ford@mbed.co.uk 4:5d1359a283bc 2
simon.ford@mbed.co.uk 4:5d1359a283bc 3 #ifndef MBED_FILESYSTEMLIKE_H
simon.ford@mbed.co.uk 4:5d1359a283bc 4 #define MBED_FILESYSTEMLIKE_H
simon.ford@mbed.co.uk 4:5d1359a283bc 5
simon.ford@mbed.co.uk 4:5d1359a283bc 6 #ifdef __ARMCC_VERSION
simon.ford@mbed.co.uk 4:5d1359a283bc 7 # define O_RDONLY 0
simon.ford@mbed.co.uk 4:5d1359a283bc 8 # define O_WRONLY 1
simon.ford@mbed.co.uk 4:5d1359a283bc 9 # define O_RDWR 2
simon.ford@mbed.co.uk 4:5d1359a283bc 10 # define O_CREAT 0x0200
simon.ford@mbed.co.uk 5:62573be585e9 11 # define O_TRUNC 0x0400
simon.ford@mbed.co.uk 4:5d1359a283bc 12 # define O_APPEND 0x0008
simon.ford@mbed.co.uk 8:00a04e5cd407 13 typedef int mode_t;
simon.ford@mbed.co.uk 4:5d1359a283bc 14 #else
simon.ford@mbed.co.uk 4:5d1359a283bc 15 # include <sys/fcntl.h>
simon.ford@mbed.co.uk 4:5d1359a283bc 16 #endif
simon.ford@mbed.co.uk 8:00a04e5cd407 17 #include "Base.h"
simon.ford@mbed.co.uk 8:00a04e5cd407 18 #include "FileHandle.h"
simon.ford@mbed.co.uk 8:00a04e5cd407 19 #include "DirHandle.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 20
simon.ford@mbed.co.uk 4:5d1359a283bc 21 namespace mbed {
simon.ford@mbed.co.uk 4:5d1359a283bc 22
simon.ford@mbed.co.uk 4:5d1359a283bc 23 /* Class FileSystemLike
simon.ford@mbed.co.uk 4:5d1359a283bc 24 * A filesystem-like object is one that can be used to open files
simon.ford@mbed.co.uk 4:5d1359a283bc 25 * though it by fopen("/name/filename", mode)
simon.ford@mbed.co.uk 4:5d1359a283bc 26 *
simon.ford@mbed.co.uk 4:5d1359a283bc 27 * Implementations must define at least open (the default definitions
simon.ford@mbed.co.uk 4:5d1359a283bc 28 * of the rest of the functions just return error values).
simon.ford@mbed.co.uk 4:5d1359a283bc 29 */
simon.ford@mbed.co.uk 4:5d1359a283bc 30 class FileSystemLike : public Base {
simon.ford@mbed.co.uk 4:5d1359a283bc 31
simon.ford@mbed.co.uk 4:5d1359a283bc 32 public:
simon.ford@mbed.co.uk 4:5d1359a283bc 33
simon.ford@mbed.co.uk 4:5d1359a283bc 34 /* Constructor FileSystemLike
simon.ford@mbed.co.uk 4:5d1359a283bc 35 *
simon.ford@mbed.co.uk 4:5d1359a283bc 36 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 37 * name - The name to use for the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 38 */
simon.ford@mbed.co.uk 4:5d1359a283bc 39 FileSystemLike(const char *name) : Base(name) {}
simon.ford@mbed.co.uk 4:5d1359a283bc 40
simon.ford@mbed.co.uk 4:5d1359a283bc 41 /* Function open
simon.ford@mbed.co.uk 4:5d1359a283bc 42 *
simon.ford@mbed.co.uk 4:5d1359a283bc 43 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 44 * filename - The name of the file to open.
simon.ford@mbed.co.uk 5:62573be585e9 45 * flags - One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
simon.ford@mbed.co.uk 5:62573be585e9 46 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
simon.ford@mbed.co.uk 4:5d1359a283bc 47 * returns - A pointer to a FileHandle object representing the
simon.ford@mbed.co.uk 4:5d1359a283bc 48 * file on success, or NULL on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 49 */
simon.ford@mbed.co.uk 4:5d1359a283bc 50 virtual FileHandle *open(const char *filename, int flags) = 0;
simon.ford@mbed.co.uk 4:5d1359a283bc 51
simon.ford@mbed.co.uk 4:5d1359a283bc 52 /* Function remove
simon.ford@mbed.co.uk 4:5d1359a283bc 53 * Remove a file from the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 54 *
simon.ford@mbed.co.uk 4:5d1359a283bc 55 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 56 * filename - the name of the file to remove.
simon.ford@mbed.co.uk 4:5d1359a283bc 57 * returns - 0 on success, -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 58 */
simon.ford@mbed.co.uk 4:5d1359a283bc 59 virtual int remove(const char *filename) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 60
simon.ford@mbed.co.uk 4:5d1359a283bc 61 /* Function rename
simon.ford@mbed.co.uk 4:5d1359a283bc 62 * Rename a file in the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 63 *
simon.ford@mbed.co.uk 4:5d1359a283bc 64 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 65 * oldname - the name of the file to rename.
simon.ford@mbed.co.uk 4:5d1359a283bc 66 * newname - the name to rename it to.
simon.ford@mbed.co.uk 4:5d1359a283bc 67 * returns - 0 on success, -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 68 */
simon.ford@mbed.co.uk 4:5d1359a283bc 69 virtual int rename(const char *oldname, const char *newname) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 70
simon.ford@mbed.co.uk 8:00a04e5cd407 71 /* Function opendir
simon.ford@mbed.co.uk 8:00a04e5cd407 72 * Opens a directory in the filesystem and returns a DirHandle
simon.ford@mbed.co.uk 8:00a04e5cd407 73 * representing the directory stream.
simon.ford@mbed.co.uk 8:00a04e5cd407 74 *
simon.ford@mbed.co.uk 8:00a04e5cd407 75 * Variables
simon.ford@mbed.co.uk 8:00a04e5cd407 76 * name - The name of the directory to open.
simon.ford@mbed.co.uk 8:00a04e5cd407 77 * returns - A DirHandle representing the directory stream, or
simon.ford@mbed.co.uk 8:00a04e5cd407 78 * NULL on failure.
simon.ford@mbed.co.uk 8:00a04e5cd407 79 */
simon.ford@mbed.co.uk 8:00a04e5cd407 80 virtual DirHandle *opendir(const char *name) { return NULL; };
simon.ford@mbed.co.uk 8:00a04e5cd407 81
simon.ford@mbed.co.uk 8:00a04e5cd407 82 /* Function mkdir
simon.ford@mbed.co.uk 8:00a04e5cd407 83 * Creates a directory in the filesystem.
simon.ford@mbed.co.uk 8:00a04e5cd407 84 *
simon.ford@mbed.co.uk 8:00a04e5cd407 85 * Variables
simon.ford@mbed.co.uk 8:00a04e5cd407 86 * name - The name of the directory to create.
simon.ford@mbed.co.uk 8:00a04e5cd407 87 * returns - 0 on success, -1 on failure.
simon.ford@mbed.co.uk 8:00a04e5cd407 88 */
simon.ford@mbed.co.uk 8:00a04e5cd407 89 virtual int mkdir(const char *name, mode_t mode) { return -1; }
simon.ford@mbed.co.uk 8:00a04e5cd407 90
simon.ford@mbed.co.uk 4:5d1359a283bc 91 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
simon.ford@mbed.co.uk 4:5d1359a283bc 92
simon.ford@mbed.co.uk 4:5d1359a283bc 93 };
simon.ford@mbed.co.uk 4:5d1359a283bc 94
simon.ford@mbed.co.uk 4:5d1359a283bc 95 } // namespace mbed
simon.ford@mbed.co.uk 4:5d1359a283bc 96
simon.ford@mbed.co.uk 4:5d1359a283bc 97 #endif