Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

FileSystemLike.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
9:cf0d45ce28a6
Child:
27:7110ebee3484
A shiny new version

Who changed what in which revision?

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