Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/FileHandle.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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