Василий Басалаев / mbed-I2CIO

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-STM32F030F4 by Nothing Special

api/FileHandle.h@0:38ccae254a29, 2014-10-18 (annotated)

Committer:
mega64
Date:
Sat Oct 18 02:40:17 2014 +0000
Revision:
0:38ccae254a29
only for STM32F030F4

Who changed what in which revision?

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