Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/FileHandle.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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