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@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

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