Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

FileSystemLike.h@4:5d1359a283bc, 2008-11-27 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Nov 27 16:23:24 2008 +0000
Revision:
4:5d1359a283bc
Child:
5:62573be585e9
New version of framework: vectors, environment, platform, base and file system

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 #include "Base.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 7 #include "FileHandle.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 8 #ifdef __ARMCC_VERSION
simon.ford@mbed.co.uk 4:5d1359a283bc 9 # define O_RDONLY 0
simon.ford@mbed.co.uk 4:5d1359a283bc 10 # define O_WRONLY 1
simon.ford@mbed.co.uk 4:5d1359a283bc 11 # define O_RDWR 2
simon.ford@mbed.co.uk 4:5d1359a283bc 12 # define O_CREAT 0x0200
simon.ford@mbed.co.uk 4:5d1359a283bc 13 # define O_APPEND 0x0008
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 4:5d1359a283bc 17
simon.ford@mbed.co.uk 4:5d1359a283bc 18 namespace mbed {
simon.ford@mbed.co.uk 4:5d1359a283bc 19
simon.ford@mbed.co.uk 4:5d1359a283bc 20 /* Class FileSystemLike
simon.ford@mbed.co.uk 4:5d1359a283bc 21 * A filesystem-like object is one that can be used to open files
simon.ford@mbed.co.uk 4:5d1359a283bc 22 * though it by fopen("/name/filename", mode)
simon.ford@mbed.co.uk 4:5d1359a283bc 23 *
simon.ford@mbed.co.uk 4:5d1359a283bc 24 * Implementations must define at least open (the default definitions
simon.ford@mbed.co.uk 4:5d1359a283bc 25 * of the rest of the functions just return error values).
simon.ford@mbed.co.uk 4:5d1359a283bc 26 */
simon.ford@mbed.co.uk 4:5d1359a283bc 27 class FileSystemLike : public Base {
simon.ford@mbed.co.uk 4:5d1359a283bc 28
simon.ford@mbed.co.uk 4:5d1359a283bc 29 public:
simon.ford@mbed.co.uk 4:5d1359a283bc 30
simon.ford@mbed.co.uk 4:5d1359a283bc 31 /* Constructor FileSystemLike
simon.ford@mbed.co.uk 4:5d1359a283bc 32 *
simon.ford@mbed.co.uk 4:5d1359a283bc 33 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 34 * name - The name to use for the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 35 */
simon.ford@mbed.co.uk 4:5d1359a283bc 36 FileSystemLike(const char *name) : Base(name) {}
simon.ford@mbed.co.uk 4:5d1359a283bc 37
simon.ford@mbed.co.uk 4:5d1359a283bc 38 /* Function open
simon.ford@mbed.co.uk 4:5d1359a283bc 39 *
simon.ford@mbed.co.uk 4:5d1359a283bc 40 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 41 * filename - The name of the file to open.
simon.ford@mbed.co.uk 4:5d1359a283bc 42 * flags - One of O_RDONLY, O_WRONLY, or O_RDWR, possibly OR'd
simon.ford@mbed.co.uk 4:5d1359a283bc 43 * with O_CREAT or O_APPEND.
simon.ford@mbed.co.uk 4:5d1359a283bc 44 * returns - A pointer to a FileHandle object representing the
simon.ford@mbed.co.uk 4:5d1359a283bc 45 * file on success, or NULL on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 46 */
simon.ford@mbed.co.uk 4:5d1359a283bc 47 virtual FileHandle *open(const char *filename, int flags) = 0;
simon.ford@mbed.co.uk 4:5d1359a283bc 48
simon.ford@mbed.co.uk 4:5d1359a283bc 49 /* Function remove
simon.ford@mbed.co.uk 4:5d1359a283bc 50 * Remove a file from the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 51 *
simon.ford@mbed.co.uk 4:5d1359a283bc 52 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 53 * filename - the name of the file to remove.
simon.ford@mbed.co.uk 4:5d1359a283bc 54 * returns - 0 on success, -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 55 */
simon.ford@mbed.co.uk 4:5d1359a283bc 56 virtual int remove(const char *filename) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 57
simon.ford@mbed.co.uk 4:5d1359a283bc 58 /* Function rename
simon.ford@mbed.co.uk 4:5d1359a283bc 59 * Rename a file in the filesystem.
simon.ford@mbed.co.uk 4:5d1359a283bc 60 *
simon.ford@mbed.co.uk 4:5d1359a283bc 61 * Variables
simon.ford@mbed.co.uk 4:5d1359a283bc 62 * oldname - the name of the file to rename.
simon.ford@mbed.co.uk 4:5d1359a283bc 63 * newname - the name to rename it to.
simon.ford@mbed.co.uk 4:5d1359a283bc 64 * returns - 0 on success, -1 on failure.
simon.ford@mbed.co.uk 4:5d1359a283bc 65 */
simon.ford@mbed.co.uk 4:5d1359a283bc 66 virtual int rename(const char *oldname, const char *newname) { return -1; };
simon.ford@mbed.co.uk 4:5d1359a283bc 67
simon.ford@mbed.co.uk 4:5d1359a283bc 68 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
simon.ford@mbed.co.uk 4:5d1359a283bc 69
simon.ford@mbed.co.uk 4:5d1359a283bc 70 };
simon.ford@mbed.co.uk 4:5d1359a283bc 71
simon.ford@mbed.co.uk 4:5d1359a283bc 72 } // namespace mbed
simon.ford@mbed.co.uk 4:5d1359a283bc 73
simon.ford@mbed.co.uk 4:5d1359a283bc 74 #endif