mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/Stream.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

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