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@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
32:3b05dd009342 
Conversion of the classes documentation to Doxygen format

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 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 9:cf0d45ce28a6 5 #ifndef MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 6 #define MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8 #include "FileSystemLike.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 9
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11
emilmont 32:3b05dd009342 12 FILEHANDLE local_file_open(const char* name, int flags);
emilmont 32:3b05dd009342 13
emilmont 32:3b05dd009342 14 class LocalFileHandle : public FileHandle {
emilmont 32:3b05dd009342 15
emilmont 32:3b05dd009342 16 public:
emilmont 32:3b05dd009342 17 LocalFileHandle(FILEHANDLE fh);
emilmont 32:3b05dd009342 18
emilmont 32:3b05dd009342 19 virtual int close();
emilmont 32:3b05dd009342 20
emilmont 32:3b05dd009342 21 virtual ssize_t write(const void *buffer, size_t length);
emilmont 32:3b05dd009342 22
emilmont 32:3b05dd009342 23 virtual ssize_t read(void *buffer, size_t length);
emilmont 32:3b05dd009342 24
emilmont 32:3b05dd009342 25 virtual int isatty();
emilmont 32:3b05dd009342 26
emilmont 32:3b05dd009342 27 virtual off_t lseek(off_t position, int whence);
emilmont 32:3b05dd009342 28
emilmont 32:3b05dd009342 29 virtual int fsync();
emilmont 32:3b05dd009342 30
emilmont 32:3b05dd009342 31 virtual off_t flen();
emilmont 32:3b05dd009342 32
emilmont 32:3b05dd009342 33 protected:
emilmont 32:3b05dd009342 34 FILEHANDLE _fh;
emilmont 32:3b05dd009342 35 int pos;
emilmont 32:3b05dd009342 36 };
emilmont 32:3b05dd009342 37
screamer 43:aff670d0d510 38 /** A filesystem for accessing the local mbed Microcontroller USB disk drive
simon.ford@mbed.co.uk 9:cf0d45ce28a6 39 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40 * 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 41 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
simon.ford@mbed.co.uk 9:cf0d45ce28a6 42 * read and write files.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 44 * Example:
screamer 43:aff670d0d510 45 * @code
screamer 43:aff670d0d510 46 * #include "mbed.h"
screamer 43:aff670d0d510 47 *
screamer 43:aff670d0d510 48 * LocalFileSystem local("local"); // Create the local filesystem under the name "local"
screamer 43:aff670d0d510 49 *
screamer 43:aff670d0d510 50 * int main() {
screamer 43:aff670d0d510 51 * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
screamer 43:aff670d0d510 52 * fprintf(fp, "Hello World!");
screamer 43:aff670d0d510 53 * fclose(fp);
screamer 43:aff670d0d510 54 * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 *
screamer 43:aff670d0d510 56 * DIR *d = opendir("/local"); // Opens the root directory of the local file system
screamer 43:aff670d0d510 57 * struct dirent *p;
screamer 43:aff670d0d510 58 * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
screamer 43:aff670d0d510 59 * printf("%s\n", p->d_name); // to stdout.
screamer 43:aff670d0d510 60 * }
screamer 43:aff670d0d510 61 * closedir(d);
screamer 43:aff670d0d510 62 * }
screamer 43:aff670d0d510 63 * @endcode
screamer 43:aff670d0d510 64 *
screamer 43:aff670d0d510 65 * @note
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 * on the Host computer. This means it is no longer accessible from the Host Computer.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
simon.ford@mbed.co.uk 9:cf0d45ce28a6 70 * 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 71 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72 class LocalFileSystem : public FileSystemLike {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 LocalFileSystem(const char* n) : FileSystemLike(n) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78 }
screamer 43:aff670d0d510 79
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 virtual FileHandle *open(const char* name, int flags);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 virtual int remove(const char *filename);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 virtual DirHandle *opendir(const char *name);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 #endif