Nothing Special / mbed-STM32F103C8

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-STM32F103C8_org by Nothing Special

drivers/FileHandle.h@146:03e976389d16, 2017-03-16 (annotated)

Committer:
mega64
Date:
Thu Mar 16 06:15:53 2017 +0000
Revision:
146:03e976389d16
fully rebuild, now based on mbed-dev v160

Who changed what in which revision?

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