Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/platform/LocalFileSystem.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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