Vladimir Vana / mbed

pro vyuku PSS v Jecne

LocalFileSystem.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vladvana 0:23d1f73bf130 1 /* mbed Microcontroller Library
vladvana 0:23d1f73bf130 2 * Copyright (c) 2006-2013 ARM Limited
vladvana 0:23d1f73bf130 3 *
vladvana 0:23d1f73bf130 4 * Licensed under the Apache License, Version 2.0 (the "License");
vladvana 0:23d1f73bf130 5 * you may not use this file except in compliance with the License.
vladvana 0:23d1f73bf130 6 * You may obtain a copy of the License at
vladvana 0:23d1f73bf130 7 *
vladvana 0:23d1f73bf130 8 * http://www.apache.org/licenses/LICENSE-2.0
vladvana 0:23d1f73bf130 9 *
vladvana 0:23d1f73bf130 10 * Unless required by applicable law or agreed to in writing, software
vladvana 0:23d1f73bf130 11 * distributed under the License is distributed on an "AS IS" BASIS,
vladvana 0:23d1f73bf130 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vladvana 0:23d1f73bf130 13 * See the License for the specific language governing permissions and
vladvana 0:23d1f73bf130 14 * limitations under the License.
vladvana 0:23d1f73bf130 15 */
vladvana 0:23d1f73bf130 16 #ifndef MBED_LOCALFILESYSTEM_H
vladvana 0:23d1f73bf130 17 #define MBED_LOCALFILESYSTEM_H
vladvana 0:23d1f73bf130 18
vladvana 0:23d1f73bf130 19 #include "platform.h"
vladvana 0:23d1f73bf130 20
vladvana 0:23d1f73bf130 21 #if DEVICE_LOCALFILESYSTEM
vladvana 0:23d1f73bf130 22
vladvana 0:23d1f73bf130 23 #include "FileSystemLike.h"
vladvana 0:23d1f73bf130 24
vladvana 0:23d1f73bf130 25 namespace mbed {
vladvana 0:23d1f73bf130 26
vladvana 0:23d1f73bf130 27 FILEHANDLE local_file_open(const char* name, int flags);
vladvana 0:23d1f73bf130 28
vladvana 0:23d1f73bf130 29 class LocalFileHandle : public FileHandle {
vladvana 0:23d1f73bf130 30
vladvana 0:23d1f73bf130 31 public:
vladvana 0:23d1f73bf130 32 LocalFileHandle(FILEHANDLE fh);
vladvana 0:23d1f73bf130 33
vladvana 0:23d1f73bf130 34 virtual int close();
vladvana 0:23d1f73bf130 35
vladvana 0:23d1f73bf130 36 virtual ssize_t write(const void *buffer, size_t length);
vladvana 0:23d1f73bf130 37
vladvana 0:23d1f73bf130 38 virtual ssize_t read(void *buffer, size_t length);
vladvana 0:23d1f73bf130 39
vladvana 0:23d1f73bf130 40 virtual int isatty();
vladvana 0:23d1f73bf130 41
vladvana 0:23d1f73bf130 42 virtual off_t lseek(off_t position, int whence);
vladvana 0:23d1f73bf130 43
vladvana 0:23d1f73bf130 44 virtual int fsync();
vladvana 0:23d1f73bf130 45
vladvana 0:23d1f73bf130 46 virtual off_t flen();
vladvana 0:23d1f73bf130 47
vladvana 0:23d1f73bf130 48 protected:
vladvana 0:23d1f73bf130 49 FILEHANDLE _fh;
vladvana 0:23d1f73bf130 50 int pos;
vladvana 0:23d1f73bf130 51 };
vladvana 0:23d1f73bf130 52
vladvana 0:23d1f73bf130 53 /** A filesystem for accessing the local mbed Microcontroller USB disk drive
vladvana 0:23d1f73bf130 54 *
vladvana 0:23d1f73bf130 55 * This allows programs to read and write files on the same disk drive that is used to program the
vladvana 0:23d1f73bf130 56 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
vladvana 0:23d1f73bf130 57 * read and write files.
vladvana 0:23d1f73bf130 58 *
vladvana 0:23d1f73bf130 59 * Example:
vladvana 0:23d1f73bf130 60 * @code
vladvana 0:23d1f73bf130 61 * #include "mbed.h"
vladvana 0:23d1f73bf130 62 *
vladvana 0:23d1f73bf130 63 * LocalFileSystem local("local"); // Create the local filesystem under the name "local"
vladvana 0:23d1f73bf130 64 *
vladvana 0:23d1f73bf130 65 * int main() {
vladvana 0:23d1f73bf130 66 * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
vladvana 0:23d1f73bf130 67 * fprintf(fp, "Hello World!");
vladvana 0:23d1f73bf130 68 * fclose(fp);
vladvana 0:23d1f73bf130 69 * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
vladvana 0:23d1f73bf130 70 *
vladvana 0:23d1f73bf130 71 * DIR *d = opendir("/local"); // Opens the root directory of the local file system
vladvana 0:23d1f73bf130 72 * struct dirent *p;
vladvana 0:23d1f73bf130 73 * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
vladvana 0:23d1f73bf130 74 * printf("%s\n", p->d_name); // to stdout.
vladvana 0:23d1f73bf130 75 * }
vladvana 0:23d1f73bf130 76 * closedir(d);
vladvana 0:23d1f73bf130 77 * }
vladvana 0:23d1f73bf130 78 * @endcode
vladvana 0:23d1f73bf130 79 *
vladvana 0:23d1f73bf130 80 * @note
vladvana 0:23d1f73bf130 81 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
vladvana 0:23d1f73bf130 82 * on the Host computer. This means it is no longer accessible from the Host Computer.
vladvana 0:23d1f73bf130 83 *
vladvana 0:23d1f73bf130 84 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
vladvana 0:23d1f73bf130 85 * not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
vladvana 0:23d1f73bf130 86 */
vladvana 0:23d1f73bf130 87 class LocalFileSystem : public FileSystemLike {
vladvana 0:23d1f73bf130 88
vladvana 0:23d1f73bf130 89 public:
vladvana 0:23d1f73bf130 90 LocalFileSystem(const char* n) : FileSystemLike(n) {
vladvana 0:23d1f73bf130 91
vladvana 0:23d1f73bf130 92 }
vladvana 0:23d1f73bf130 93
vladvana 0:23d1f73bf130 94 virtual FileHandle *open(const char* name, int flags);
vladvana 0:23d1f73bf130 95 virtual int remove(const char *filename);
vladvana 0:23d1f73bf130 96 virtual DirHandle *opendir(const char *name);
vladvana 0:23d1f73bf130 97 };
vladvana 0:23d1f73bf130 98
vladvana 0:23d1f73bf130 99 } // namespace mbed
vladvana 0:23d1f73bf130 100
vladvana 0:23d1f73bf130 101 #endif
vladvana 0:23d1f73bf130 102
vladvana 0:23d1f73bf130 103 #endif