EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

platform/Stream.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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