Jonne Valola / PokittoLib Featured

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

Dependents:   YATTT sd_map_test cPong SnowDemo ... more

PokittoLib

Library for programming Pokitto hardware

How to Use

  1. Import this library to online compiler (see button "import" on the right hand side
  2. DO NOT import mbed-src anymore, a better version is now included inside PokittoLib
  3. Change My_settings.h according to your project
  4. Start coding!

mbed-pokitto/api/FileHandle.h@71:531419862202, 2019-12-25 (annotated)

Committer:
Pokitto
Date:
Wed Dec 25 23:59:52 2019 +0000
Revision:
71:531419862202
Parent:
5:ea7377f3d1af 
Changed Mode2 C++ refresh code (graphical errors)

Who changed what in which revision?

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