clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/FileHandle.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - FileHandler
slowness 0:c03cffe402df 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_FILEHANDLE_H
slowness 0:c03cffe402df 6 #define MBED_FILEHANDLE_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 typedef int FILEHANDLE;
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #include <stdio.h>
slowness 0:c03cffe402df 11 #ifdef __ARMCC_VERSION
slowness 0:c03cffe402df 12 typedef int ssize_t;
slowness 0:c03cffe402df 13 typedef long off_t;
slowness 0:c03cffe402df 14 #else
slowness 0:c03cffe402df 15 #include <sys/types.h>
slowness 0:c03cffe402df 16 #endif
slowness 0:c03cffe402df 17
slowness 0:c03cffe402df 18 namespace mbed {
slowness 0:c03cffe402df 19
slowness 0:c03cffe402df 20 /* Class FileHandle
slowness 0:c03cffe402df 21 * An OO equivalent of the internal FILEHANDLE variable
slowness 0:c03cffe402df 22 * and associated _sys_* functions
slowness 0:c03cffe402df 23 *
slowness 0:c03cffe402df 24 * FileHandle is an abstract class, needing at least sys_write and
slowness 0:c03cffe402df 25 * sys_read to be implmented for a simple interactive device
slowness 0:c03cffe402df 26 *
slowness 0:c03cffe402df 27 * No one ever directly tals to/instanciates a FileHandle - it gets
slowness 0:c03cffe402df 28 * created by FileSystem, and wrapped up by stdio
slowness 0:c03cffe402df 29 */
slowness 0:c03cffe402df 30 class FileHandle {
slowness 0:c03cffe402df 31
slowness 0:c03cffe402df 32 public:
slowness 0:c03cffe402df 33
slowness 0:c03cffe402df 34 /* Function write
slowness 0:c03cffe402df 35 * Write the contents of a buffer to the file
slowness 0:c03cffe402df 36 *
slowness 0:c03cffe402df 37 * Parameters
slowness 0:c03cffe402df 38 * buffer - the buffer to write from
slowness 0:c03cffe402df 39 * length - the number of characters to write
slowness 0:c03cffe402df 40 *
slowness 0:c03cffe402df 41 * Returns
slowness 0:c03cffe402df 42 * The number of characters written (possibly 0) on success, -1 on error.
slowness 0:c03cffe402df 43 */
slowness 0:c03cffe402df 44 virtual ssize_t write(const void* buffer, size_t length) = 0;
slowness 0:c03cffe402df 45
slowness 0:c03cffe402df 46 /* Function close
slowness 0:c03cffe402df 47 * Close the file
slowness 0:c03cffe402df 48 *
slowness 0:c03cffe402df 49 * Returns
slowness 0:c03cffe402df 50 * Zero on success, -1 on error.
slowness 0:c03cffe402df 51 */
slowness 0:c03cffe402df 52 virtual int close() = 0;
slowness 0:c03cffe402df 53
slowness 0:c03cffe402df 54 /* Function read
slowness 0:c03cffe402df 55 * Reads the contents of the file into a buffer
slowness 0:c03cffe402df 56 *
slowness 0:c03cffe402df 57 * Parameters
slowness 0:c03cffe402df 58 * buffer - the buffer to read in to
slowness 0:c03cffe402df 59 * length - the number of characters to read
slowness 0:c03cffe402df 60 *
slowness 0:c03cffe402df 61 * Returns
slowness 0:c03cffe402df 62 * The number of characters read (zero at end of file) on success, -1 on error.
slowness 0:c03cffe402df 63 */
slowness 0:c03cffe402df 64 virtual ssize_t read(void* buffer, size_t length) = 0;
slowness 0:c03cffe402df 65
slowness 0:c03cffe402df 66 /* Function isatty
slowness 0:c03cffe402df 67 * Check if the handle is for a interactive terminal device
slowness 0:c03cffe402df 68 *
slowness 0:c03cffe402df 69 * If so, line buffered behaviour is used by default
slowness 0:c03cffe402df 70 *
slowness 0:c03cffe402df 71 * Returns
slowness 0:c03cffe402df 72 * 1 if it is a terminal, 0 otherwise
slowness 0:c03cffe402df 73 */
slowness 0:c03cffe402df 74 virtual int isatty() = 0 ;
slowness 0:c03cffe402df 75
slowness 0:c03cffe402df 76 /* Function lseek
slowness 0:c03cffe402df 77 * Move the file position to a given offset from a given location.
slowness 0:c03cffe402df 78 *
slowness 0:c03cffe402df 79 * Parameters
slowness 0:c03cffe402df 80 * offset - The offset from whence to move to
slowness 0:c03cffe402df 81 * whence - SEEK_SET for the start of the file, SEEK_CUR for the
slowness 0:c03cffe402df 82 * current file position, or SEEK_END for the end of the file.
slowness 0:c03cffe402df 83 *
slowness 0:c03cffe402df 84 * Returns
slowness 0:c03cffe402df 85 * New file position on success, -1 on failure or unsupported
slowness 0:c03cffe402df 86 */
slowness 0:c03cffe402df 87 virtual off_t lseek(off_t offset, int whence) = 0;
slowness 0:c03cffe402df 88
slowness 0:c03cffe402df 89 /* Function fsync
slowness 0:c03cffe402df 90 * Flush any buffers associated with the FileHandle, ensuring it
slowness 0:c03cffe402df 91 * is up to date on disk
slowness 0:c03cffe402df 92 *
slowness 0:c03cffe402df 93 * Returns
slowness 0:c03cffe402df 94 * 0 on success or un-needed, -1 on error
slowness 0:c03cffe402df 95 */
slowness 0:c03cffe402df 96 virtual int fsync() = 0;
slowness 0:c03cffe402df 97
slowness 0:c03cffe402df 98 virtual off_t flen() {
slowness 0:c03cffe402df 99 /* remember our current position */
slowness 0:c03cffe402df 100 off_t pos = lseek(0, SEEK_CUR);
slowness 0:c03cffe402df 101 if(pos == -1) return -1;
slowness 0:c03cffe402df 102 /* seek to the end to get the file length */
slowness 0:c03cffe402df 103 off_t res = lseek(0, SEEK_END);
slowness 0:c03cffe402df 104 /* return to our old position */
slowness 0:c03cffe402df 105 lseek(pos, SEEK_SET);
slowness 0:c03cffe402df 106 return res;
slowness 0:c03cffe402df 107 }
slowness 0:c03cffe402df 108
slowness 0:c03cffe402df 109 };
slowness 0:c03cffe402df 110
slowness 0:c03cffe402df 111 } // namespace mbed
slowness 0:c03cffe402df 112
slowness 0:c03cffe402df 113 #endif
slowness 0:c03cffe402df 114