Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

LocalFileSystem.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 - LocalFileSystem
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 9:cf0d45ce28a6 6 #ifndef MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7 #define MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8
simon.ford@mbed.co.uk 9:cf0d45ce28a6 9 #include "FileSystemLike.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 12
simon.ford@mbed.co.uk 9:cf0d45ce28a6 13 /* Class: LocalFileSystem
rolf.meyer@arm.com 11:1c1ebd0324fa 14 * A filesystem for accessing the local mbed Microcontroller USB disk drive
simon.ford@mbed.co.uk 9:cf0d45ce28a6 15 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 16 * This allows programs to read and write files on the same disk drive that is used to program the
simon.ford@mbed.co.uk 9:cf0d45ce28a6 17 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
simon.ford@mbed.co.uk 9:cf0d45ce28a6 18 * read and write files.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 19 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 20 * Example:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 21 * > #include "mbed.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 22 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 23 * > LocalFileSystem local("local"); // Create the local filesystem under the name "local"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 24 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 25 * > int main() {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 26 * > FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
simon.ford@mbed.co.uk 9:cf0d45ce28a6 27 * > fprintf(fp, "Hello World!");
simon.ford@mbed.co.uk 9:cf0d45ce28a6 28 * > fclose(fp);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 29 * > remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 30 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 31 * > DIR *d = opendir("/local"); // Opens the root directory of the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 32 * > struct dirent *p;
simon.ford@mbed.co.uk 9:cf0d45ce28a6 33 * > while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 34 * > printf("%s\n", p->d_name); // to stdout.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 35 * > }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 36 * > closedir(d);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 37 * > }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 38 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 39 * Implementation Notes:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 41 * on the Host computer. This means it is no longer accessible from the Host Computer.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 42 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
simon.ford@mbed.co.uk 9:cf0d45ce28a6 44 * not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
simon.ford@mbed.co.uk 9:cf0d45ce28a6 45 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 46 class LocalFileSystem : public FileSystemLike {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 47
simon.ford@mbed.co.uk 9:cf0d45ce28a6 48 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 49
simon.ford@mbed.co.uk 9:cf0d45ce28a6 50 LocalFileSystem(const char* n) : FileSystemLike(n) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51
simon.ford@mbed.co.uk 9:cf0d45ce28a6 52 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 53
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 virtual FileHandle *open(const char* name, int flags);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 virtual int remove(const char *filename);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 virtual DirHandle *opendir(const char *name);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 #endif