printer

Dependents:   Good_Serial_HelloWorld_Mbed

Fork of mbed by gokmen ascioglu

LocalFileSystem.h

Committer:
redplam
Date:
2014-04-14
Revision:
1:0b0a5a73f998
Parent:
0:a8fa94490a0a

File content as of revision 1:0b0a5a73f998:

/* mbed Microcontroller Library - LocalFileSystem
 * Copyright (c) 2008-2009 ARM Limited. All rights reserved.
 */ 
 
#ifndef MBED_LOCALFILESYSTEM_H
#define MBED_LOCALFILESYSTEM_H

#include "FileSystemLike.h"

namespace mbed {

FILEHANDLE local_file_open(const char* name, int flags);

class LocalFileHandle : public FileHandle {

public:
    LocalFileHandle(FILEHANDLE fh);
    
    virtual int close();
    
    virtual ssize_t write(const void *buffer, size_t length);
    
    virtual ssize_t read(void *buffer, size_t length);
    
    virtual int isatty();
    
    virtual off_t lseek(off_t position, int whence);
    
    virtual int fsync();
    
    virtual off_t flen();

protected:
    FILEHANDLE _fh;
    int pos;
};

/* Class: LocalFileSystem
 *  A filesystem for accessing the local mbed Microcontroller USB disk drive 
 *
 *  This allows programs to read and write files on the same disk drive that is used to program the 
 *  mbed Microcontroller. Once created, the standard C file access functions are used to open, 
 *  read and write files.
 *
 * Example:
 * > #include "mbed.h"
 * >
 * > LocalFileSystem local("local");             // Create the local filesystem under the name "local"
 * >
 * > int main() {
 * >     FILE *fp = fopen("/local/out.txt", "w");  // Open "out.txt" on the local file system for writing
 * >     fprintf(fp, "Hello World!");              
 * >     fclose(fp);                               
 * >     remove("/local/out.txt");                 // Removes the file "out.txt" from the local file system
 * >
 * >     DIR *d = opendir("/local");               // Opens the root directory of the local file system
 * >     struct dirent *p;
 * >     while((p = readdir(d)) != NULL) {         // Print the names of the files in the local file system
 * >       printf("%s\n", p->d_name);              // to stdout.
 * >     }
 * >     closedir(d);
 * > }
 *
 * Implementation Notes:
 *  If the microcontroller program makes an access to the local drive, it will be marked as "removed"
 *  on the Host computer. This means it is no longer accessible from the Host Computer.
 *
 *  The drive will only re-appear when the microcontroller program exists. Note that if the program does
 *  not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
 */
class LocalFileSystem : public FileSystemLike {

public:

    LocalFileSystem(const char* n) : FileSystemLike(n) {

    }
	
    virtual FileHandle *open(const char* name, int flags);
    virtual int remove(const char *filename);
    virtual DirHandle *opendir(const char *name);
};

} // namespace mbed

#endif