Kev Mann / mbed-dev-OS5_10_4

features/storage/filesystem/File.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /* mbed Microcontroller Library
kevman 0:38ceb79fef03 2 * Copyright (c) 2015 ARM Limited
kevman 0:38ceb79fef03 3 *
kevman 0:38ceb79fef03 4 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 5 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 6 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 7 *
kevman 0:38ceb79fef03 8 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 9 *
kevman 0:38ceb79fef03 10 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 11 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 13 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 14 * limitations under the License.
kevman 0:38ceb79fef03 15 */
kevman 0:38ceb79fef03 16
kevman 0:38ceb79fef03 17 #ifndef FILE_H
kevman 0:38ceb79fef03 18 #define FILE_H
kevman 0:38ceb79fef03 19
kevman 0:38ceb79fef03 20 #include "filesystem/FileSystem.h"
kevman 0:38ceb79fef03 21 #include "platform/FileHandle.h"
kevman 0:38ceb79fef03 22
kevman 0:38ceb79fef03 23 namespace mbed {
kevman 0:38ceb79fef03 24 /** \addtogroup filesystem */
kevman 0:38ceb79fef03 25 /** @{*/
kevman 0:38ceb79fef03 26
kevman 0:38ceb79fef03 27
kevman 0:38ceb79fef03 28 /** File class
kevman 0:38ceb79fef03 29 */
kevman 0:38ceb79fef03 30 class File : public FileHandle {
kevman 0:38ceb79fef03 31 public:
kevman 0:38ceb79fef03 32 /** Create an uninitialized file
kevman 0:38ceb79fef03 33 *
kevman 0:38ceb79fef03 34 * Must call open to initialize the file on a file system
kevman 0:38ceb79fef03 35 */
kevman 0:38ceb79fef03 36 File();
kevman 0:38ceb79fef03 37
kevman 0:38ceb79fef03 38 /** Create a file on a filesystem
kevman 0:38ceb79fef03 39 *
kevman 0:38ceb79fef03 40 * Creates and opens a file on a filesystem
kevman 0:38ceb79fef03 41 *
kevman 0:38ceb79fef03 42 * @param fs Filesystem as target for the file
kevman 0:38ceb79fef03 43 * @param path The name of the file to open
kevman 0:38ceb79fef03 44 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
kevman 0:38ceb79fef03 45 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
kevman 0:38ceb79fef03 46 */
kevman 0:38ceb79fef03 47 File(FileSystem *fs, const char *path, int flags = O_RDONLY);
kevman 0:38ceb79fef03 48
kevman 0:38ceb79fef03 49 /** Destroy a file
kevman 0:38ceb79fef03 50 *
kevman 0:38ceb79fef03 51 * Closes file if the file is still open
kevman 0:38ceb79fef03 52 */
kevman 0:38ceb79fef03 53 virtual ~File();
kevman 0:38ceb79fef03 54
kevman 0:38ceb79fef03 55 /** Open a file on the filesystem
kevman 0:38ceb79fef03 56 *
kevman 0:38ceb79fef03 57 * @param fs Filesystem as target for the file
kevman 0:38ceb79fef03 58 * @param path The name of the file to open
kevman 0:38ceb79fef03 59 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
kevman 0:38ceb79fef03 60 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
kevman 0:38ceb79fef03 61 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 62 */
kevman 0:38ceb79fef03 63 virtual int open(FileSystem *fs, const char *path, int flags=O_RDONLY);
kevman 0:38ceb79fef03 64
kevman 0:38ceb79fef03 65 /** Close a file
kevman 0:38ceb79fef03 66 *
kevman 0:38ceb79fef03 67 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 68 */
kevman 0:38ceb79fef03 69 virtual int close();
kevman 0:38ceb79fef03 70
kevman 0:38ceb79fef03 71 /** Read the contents of a file into a buffer
kevman 0:38ceb79fef03 72 *
kevman 0:38ceb79fef03 73 * @param buffer The buffer to read in to
kevman 0:38ceb79fef03 74 * @param size The number of bytes to read
kevman 0:38ceb79fef03 75 * @return The number of bytes read, 0 at end of file, negative error on failure
kevman 0:38ceb79fef03 76 */
kevman 0:38ceb79fef03 77
kevman 0:38ceb79fef03 78 virtual ssize_t read(void *buffer, size_t size);
kevman 0:38ceb79fef03 79
kevman 0:38ceb79fef03 80 /** Write the contents of a buffer to a file
kevman 0:38ceb79fef03 81 *
kevman 0:38ceb79fef03 82 * @param buffer The buffer to write from
kevman 0:38ceb79fef03 83 * @param size The number of bytes to write
kevman 0:38ceb79fef03 84 * @return The number of bytes written, negative error on failure
kevman 0:38ceb79fef03 85 */
kevman 0:38ceb79fef03 86 virtual ssize_t write(const void *buffer, size_t size);
kevman 0:38ceb79fef03 87
kevman 0:38ceb79fef03 88 /** Flush any buffers associated with the file
kevman 0:38ceb79fef03 89 *
kevman 0:38ceb79fef03 90 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 91 */
kevman 0:38ceb79fef03 92 virtual int sync();
kevman 0:38ceb79fef03 93
kevman 0:38ceb79fef03 94 /** Check if the file in an interactive terminal device
kevman 0:38ceb79fef03 95 *
kevman 0:38ceb79fef03 96 * @return True if the file is a terminal
kevman 0:38ceb79fef03 97 */
kevman 0:38ceb79fef03 98 virtual int isatty();
kevman 0:38ceb79fef03 99
kevman 0:38ceb79fef03 100 /** Move the file position to a given offset from from a given location
kevman 0:38ceb79fef03 101 *
kevman 0:38ceb79fef03 102 * @param offset The offset from whence to move to
kevman 0:38ceb79fef03 103 * @param whence The start of where to seek
kevman 0:38ceb79fef03 104 * SEEK_SET to start from beginning of file,
kevman 0:38ceb79fef03 105 * SEEK_CUR to start from current position in file,
kevman 0:38ceb79fef03 106 * SEEK_END to start from end of file
kevman 0:38ceb79fef03 107 * @return The new offset of the file
kevman 0:38ceb79fef03 108 */
kevman 0:38ceb79fef03 109 virtual off_t seek(off_t offset, int whence = SEEK_SET);
kevman 0:38ceb79fef03 110
kevman 0:38ceb79fef03 111 /** Get the file position of the file
kevman 0:38ceb79fef03 112 *
kevman 0:38ceb79fef03 113 * @return The current offset in the file
kevman 0:38ceb79fef03 114 */
kevman 0:38ceb79fef03 115 virtual off_t tell();
kevman 0:38ceb79fef03 116
kevman 0:38ceb79fef03 117 /** Rewind the file position to the beginning of the file
kevman 0:38ceb79fef03 118 *
kevman 0:38ceb79fef03 119 * @note This is equivalent to file_seek(file, 0, FS_SEEK_SET)
kevman 0:38ceb79fef03 120 */
kevman 0:38ceb79fef03 121 virtual void rewind();
kevman 0:38ceb79fef03 122
kevman 0:38ceb79fef03 123 /** Get the size of the file
kevman 0:38ceb79fef03 124 *
kevman 0:38ceb79fef03 125 * @return Size of the file in bytes
kevman 0:38ceb79fef03 126 */
kevman 0:38ceb79fef03 127 virtual off_t size();
kevman 0:38ceb79fef03 128
kevman 0:38ceb79fef03 129 private:
kevman 0:38ceb79fef03 130 FileSystem *_fs;
kevman 0:38ceb79fef03 131 fs_file_t _file;
kevman 0:38ceb79fef03 132 };
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134
kevman 0:38ceb79fef03 135 /** @}*/
kevman 0:38ceb79fef03 136 } // namespace mbed
kevman 0:38ceb79fef03 137
kevman 0:38ceb79fef03 138 #endif