BA / SerialCom

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 OmniWheels by Gustav Atmel

mbed-os/platform/Stream.h@2:798925c9e4a8, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:55:34 2018 +0000
Revision:
2:798925c9e4a8
Parent:
1:9c5af431a1f1 
bluetooth

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gustavatmel 1:9c5af431a1f1 1 /* mbed Microcontroller Library
gustavatmel 1:9c5af431a1f1 2 * Copyright (c) 2006-2013 ARM Limited
gustavatmel 1:9c5af431a1f1 3 *
gustavatmel 1:9c5af431a1f1 4 * Licensed under the Apache License, Version 2.0 (the "License");
gustavatmel 1:9c5af431a1f1 5 * you may not use this file except in compliance with the License.
gustavatmel 1:9c5af431a1f1 6 * You may obtain a copy of the License at
gustavatmel 1:9c5af431a1f1 7 *
gustavatmel 1:9c5af431a1f1 8 * http://www.apache.org/licenses/LICENSE-2.0
gustavatmel 1:9c5af431a1f1 9 *
gustavatmel 1:9c5af431a1f1 10 * Unless required by applicable law or agreed to in writing, software
gustavatmel 1:9c5af431a1f1 11 * distributed under the License is distributed on an "AS IS" BASIS,
gustavatmel 1:9c5af431a1f1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gustavatmel 1:9c5af431a1f1 13 * See the License for the specific language governing permissions and
gustavatmel 1:9c5af431a1f1 14 * limitations under the License.
gustavatmel 1:9c5af431a1f1 15 */
gustavatmel 1:9c5af431a1f1 16 #ifndef MBED_STREAM_H
gustavatmel 1:9c5af431a1f1 17 #define MBED_STREAM_H
gustavatmel 1:9c5af431a1f1 18
gustavatmel 1:9c5af431a1f1 19 #include "platform/platform.h"
gustavatmel 1:9c5af431a1f1 20 #include "platform/FileLike.h"
gustavatmel 1:9c5af431a1f1 21 #include "platform/FileHandle.h"
gustavatmel 1:9c5af431a1f1 22 #include "platform/NonCopyable.h"
gustavatmel 1:9c5af431a1f1 23 #include <cstdio>
gustavatmel 1:9c5af431a1f1 24 #include <cstdarg>
gustavatmel 1:9c5af431a1f1 25
gustavatmel 1:9c5af431a1f1 26 namespace mbed {
gustavatmel 1:9c5af431a1f1 27 /** \addtogroup platform */
gustavatmel 1:9c5af431a1f1 28 /** @{*/
gustavatmel 1:9c5af431a1f1 29 /**
gustavatmel 1:9c5af431a1f1 30 * \defgroup platform_Stream Stream class
gustavatmel 1:9c5af431a1f1 31 * @{
gustavatmel 1:9c5af431a1f1 32 */
gustavatmel 1:9c5af431a1f1 33
gustavatmel 1:9c5af431a1f1 34 extern void mbed_set_unbuffered_stream(std::FILE *_file);
gustavatmel 1:9c5af431a1f1 35 extern int mbed_getc(std::FILE *_file);
gustavatmel 1:9c5af431a1f1 36 extern char* mbed_gets(char *s, int size, std::FILE *_file);
gustavatmel 1:9c5af431a1f1 37
gustavatmel 1:9c5af431a1f1 38 /** File stream
gustavatmel 1:9c5af431a1f1 39 *
gustavatmel 1:9c5af431a1f1 40 * @note Synchronization level: Set by subclass
gustavatmel 1:9c5af431a1f1 41 */
gustavatmel 1:9c5af431a1f1 42 class Stream : public FileLike, private NonCopyable<Stream> {
gustavatmel 1:9c5af431a1f1 43
gustavatmel 1:9c5af431a1f1 44 public:
gustavatmel 1:9c5af431a1f1 45 Stream(const char *name=NULL);
gustavatmel 1:9c5af431a1f1 46 virtual ~Stream();
gustavatmel 1:9c5af431a1f1 47
gustavatmel 1:9c5af431a1f1 48 int putc(int c);
gustavatmel 1:9c5af431a1f1 49 int puts(const char *s);
gustavatmel 1:9c5af431a1f1 50 int getc();
gustavatmel 1:9c5af431a1f1 51 char *gets(char *s, int size);
gustavatmel 1:9c5af431a1f1 52 int printf(const char* format, ...);
gustavatmel 1:9c5af431a1f1 53 int scanf(const char* format, ...);
gustavatmel 1:9c5af431a1f1 54 int vprintf(const char* format, std::va_list args);
gustavatmel 1:9c5af431a1f1 55 int vscanf(const char* format, std::va_list args);
gustavatmel 1:9c5af431a1f1 56
gustavatmel 1:9c5af431a1f1 57 operator std::FILE*() {return _file;}
gustavatmel 1:9c5af431a1f1 58
gustavatmel 1:9c5af431a1f1 59 protected:
gustavatmel 1:9c5af431a1f1 60 virtual int close();
gustavatmel 1:9c5af431a1f1 61 virtual ssize_t write(const void* buffer, size_t length);
gustavatmel 1:9c5af431a1f1 62 virtual ssize_t read(void* buffer, size_t length);
gustavatmel 1:9c5af431a1f1 63 virtual off_t seek(off_t offset, int whence);
gustavatmel 1:9c5af431a1f1 64 virtual off_t tell();
gustavatmel 1:9c5af431a1f1 65 virtual void rewind();
gustavatmel 1:9c5af431a1f1 66 virtual int isatty();
gustavatmel 1:9c5af431a1f1 67 virtual int sync();
gustavatmel 1:9c5af431a1f1 68 virtual off_t size();
gustavatmel 1:9c5af431a1f1 69
gustavatmel 1:9c5af431a1f1 70 virtual int _putc(int c) = 0;
gustavatmel 1:9c5af431a1f1 71 virtual int _getc() = 0;
gustavatmel 1:9c5af431a1f1 72
gustavatmel 1:9c5af431a1f1 73 std::FILE *_file;
gustavatmel 1:9c5af431a1f1 74
gustavatmel 1:9c5af431a1f1 75 /** Acquire exclusive access to this object.
gustavatmel 1:9c5af431a1f1 76 */
gustavatmel 1:9c5af431a1f1 77 virtual void lock() {
gustavatmel 1:9c5af431a1f1 78 // Stub
gustavatmel 1:9c5af431a1f1 79 }
gustavatmel 1:9c5af431a1f1 80
gustavatmel 1:9c5af431a1f1 81 /** Release exclusive access to this object.
gustavatmel 1:9c5af431a1f1 82 */
gustavatmel 1:9c5af431a1f1 83 virtual void unlock() {
gustavatmel 1:9c5af431a1f1 84 // Stub
gustavatmel 1:9c5af431a1f1 85 }
gustavatmel 1:9c5af431a1f1 86 };
gustavatmel 1:9c5af431a1f1 87 /**@}*/
gustavatmel 1:9c5af431a1f1 88
gustavatmel 1:9c5af431a1f1 89 /**@}*/
gustavatmel 1:9c5af431a1f1 90 } // namespace mbed
gustavatmel 1:9c5af431a1f1 91
gustavatmel 1:9c5af431a1f1 92 #endif
gustavatmel 1:9c5af431a1f1 93