Morpheus / mbed-hal

Dependencies:   target-freescale

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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