jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

FileHandle.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 65:5798e58a58b1 1 /* mbed Microcontroller Library
bogdanm 65:5798e58a58b1 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 65:5798e58a58b1 3 *
bogdanm 65:5798e58a58b1 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 65:5798e58a58b1 5 * you may not use this file except in compliance with the License.
bogdanm 65:5798e58a58b1 6 * You may obtain a copy of the License at
bogdanm 65:5798e58a58b1 7 *
bogdanm 65:5798e58a58b1 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 65:5798e58a58b1 9 *
bogdanm 65:5798e58a58b1 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 65:5798e58a58b1 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 65:5798e58a58b1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 65:5798e58a58b1 13 * See the License for the specific language governing permissions and
bogdanm 65:5798e58a58b1 14 * limitations under the License.
bogdanm 65:5798e58a58b1 15 */
bogdanm 65:5798e58a58b1 16 #ifndef MBED_FILEHANDLE_H
bogdanm 65:5798e58a58b1 17 #define MBED_FILEHANDLE_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 typedef int FILEHANDLE;
bogdanm 65:5798e58a58b1 20
bogdanm 65:5798e58a58b1 21 #include <stdio.h>
bogdanm 65:5798e58a58b1 22
bogdanm 65:5798e58a58b1 23 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
bogdanm 65:5798e58a58b1 24 typedef int ssize_t;
bogdanm 65:5798e58a58b1 25 typedef long off_t;
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 #else
bogdanm 65:5798e58a58b1 28 # include <sys/types.h>
bogdanm 65:5798e58a58b1 29 #endif
bogdanm 65:5798e58a58b1 30
bogdanm 65:5798e58a58b1 31 namespace mbed {
bogdanm 65:5798e58a58b1 32
bogdanm 65:5798e58a58b1 33 /** An OO equivalent of the internal FILEHANDLE variable
bogdanm 65:5798e58a58b1 34 * and associated _sys_* functions.
bogdanm 65:5798e58a58b1 35 *
bogdanm 65:5798e58a58b1 36 * FileHandle is an abstract class, needing at least sys_write and
bogdanm 65:5798e58a58b1 37 * sys_read to be implmented for a simple interactive device.
bogdanm 65:5798e58a58b1 38 *
bogdanm 65:5798e58a58b1 39 * No one ever directly tals to/instanciates a FileHandle - it gets
bogdanm 65:5798e58a58b1 40 * created by FileSystem, and wrapped up by stdio.
bogdanm 65:5798e58a58b1 41 */
bogdanm 65:5798e58a58b1 42 class FileHandle {
bogdanm 65:5798e58a58b1 43
bogdanm 65:5798e58a58b1 44 public:
bogdanm 65:5798e58a58b1 45 /** Write the contents of a buffer to the file
bogdanm 65:5798e58a58b1 46 *
bogdanm 65:5798e58a58b1 47 * @param buffer the buffer to write from
bogdanm 65:5798e58a58b1 48 * @param length the number of characters to write
bogdanm 65:5798e58a58b1 49 *
bogdanm 65:5798e58a58b1 50 * @returns
bogdanm 65:5798e58a58b1 51 * The number of characters written (possibly 0) on success, -1 on error.
bogdanm 65:5798e58a58b1 52 */
bogdanm 65:5798e58a58b1 53 virtual ssize_t write(const void* buffer, size_t length) = 0;
bogdanm 65:5798e58a58b1 54
bogdanm 65:5798e58a58b1 55 /** Close the file
bogdanm 65:5798e58a58b1 56 *
bogdanm 65:5798e58a58b1 57 * @returns
bogdanm 65:5798e58a58b1 58 * Zero on success, -1 on error.
bogdanm 65:5798e58a58b1 59 */
bogdanm 65:5798e58a58b1 60 virtual int close() = 0;
bogdanm 65:5798e58a58b1 61
bogdanm 65:5798e58a58b1 62 /** Function read
bogdanm 65:5798e58a58b1 63 * Reads the contents of the file into a buffer
bogdanm 65:5798e58a58b1 64 *
bogdanm 65:5798e58a58b1 65 * @param buffer the buffer to read in to
bogdanm 65:5798e58a58b1 66 * @param length the number of characters to read
bogdanm 65:5798e58a58b1 67 *
bogdanm 65:5798e58a58b1 68 * @returns
bogdanm 65:5798e58a58b1 69 * The number of characters read (zero at end of file) on success, -1 on error.
bogdanm 65:5798e58a58b1 70 */
bogdanm 65:5798e58a58b1 71 virtual ssize_t read(void* buffer, size_t length) = 0;
bogdanm 65:5798e58a58b1 72
bogdanm 65:5798e58a58b1 73 /** Check if the handle is for a interactive terminal device.
bogdanm 65:5798e58a58b1 74 * If so, line buffered behaviour is used by default
bogdanm 65:5798e58a58b1 75 *
bogdanm 65:5798e58a58b1 76 * @returns
bogdanm 65:5798e58a58b1 77 * 1 if it is a terminal,
bogdanm 65:5798e58a58b1 78 * 0 otherwise
bogdanm 65:5798e58a58b1 79 */
bogdanm 65:5798e58a58b1 80 virtual int isatty() = 0;
bogdanm 65:5798e58a58b1 81
bogdanm 65:5798e58a58b1 82 /** Move the file position to a given offset from a given location.
bogdanm 65:5798e58a58b1 83 *
bogdanm 65:5798e58a58b1 84 * @param offset The offset from whence to move to
bogdanm 65:5798e58a58b1 85 * @param whence SEEK_SET for the start of the file, SEEK_CUR for the
bogdanm 65:5798e58a58b1 86 * current file position, or SEEK_END for the end of the file.
bogdanm 65:5798e58a58b1 87 *
bogdanm 65:5798e58a58b1 88 * @returns
bogdanm 65:5798e58a58b1 89 * new file position on success,
bogdanm 65:5798e58a58b1 90 * -1 on failure or unsupported
bogdanm 65:5798e58a58b1 91 */
bogdanm 65:5798e58a58b1 92 virtual off_t lseek(off_t offset, int whence) = 0;
bogdanm 65:5798e58a58b1 93
bogdanm 65:5798e58a58b1 94 /** Flush any buffers associated with the FileHandle, ensuring it
bogdanm 65:5798e58a58b1 95 * is up to date on disk
bogdanm 65:5798e58a58b1 96 *
bogdanm 65:5798e58a58b1 97 * @returns
bogdanm 65:5798e58a58b1 98 * 0 on success or un-needed,
bogdanm 65:5798e58a58b1 99 * -1 on error
bogdanm 65:5798e58a58b1 100 */
bogdanm 65:5798e58a58b1 101 virtual int fsync() = 0;
bogdanm 65:5798e58a58b1 102
bogdanm 65:5798e58a58b1 103 virtual off_t flen() {
bogdanm 65:5798e58a58b1 104 /* remember our current position */
bogdanm 65:5798e58a58b1 105 off_t pos = lseek(0, SEEK_CUR);
bogdanm 65:5798e58a58b1 106 if(pos == -1) return -1;
bogdanm 65:5798e58a58b1 107 /* seek to the end to get the file length */
bogdanm 65:5798e58a58b1 108 off_t res = lseek(0, SEEK_END);
bogdanm 65:5798e58a58b1 109 /* return to our old position */
bogdanm 65:5798e58a58b1 110 lseek(pos, SEEK_SET);
bogdanm 65:5798e58a58b1 111 return res;
bogdanm 65:5798e58a58b1 112 }
bogdanm 65:5798e58a58b1 113
bogdanm 65:5798e58a58b1 114 virtual ~FileHandle();
bogdanm 65:5798e58a58b1 115 };
bogdanm 65:5798e58a58b1 116
bogdanm 65:5798e58a58b1 117 } // namespace mbed
bogdanm 65:5798e58a58b1 118
bogdanm 65:5798e58a58b1 119 #endif