Stream.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef MBED_STREAM_H
00018 #define MBED_STREAM_H
00019 
00020 #include "platform/platform.h"
00021 #include "platform/FileLike.h"
00022 #include "platform/FileHandle.h"
00023 #include "platform/NonCopyable.h"
00024 #include "mbed_toolchain.h"
00025 #include <cstdio>
00026 #include <cstdarg>
00027 
00028 namespace mbed {
00029 /** \addtogroup platform */
00030 /** @{*/
00031 /**
00032  * \defgroup platform_Stream Stream class
00033  * @{
00034  */
00035 
00036 extern void mbed_set_unbuffered_stream(std::FILE *_file);
00037 
00038 /** File stream
00039  *
00040  * @note Synchronization level: Set by subclass
00041  */
00042 class Stream : public FileLike, private NonCopyable<Stream> {
00043 
00044 public:
00045     Stream(const char *name = NULL);
00046     virtual ~Stream();
00047 
00048     int putc(int c);
00049     int puts(const char *s);
00050     int getc();
00051     char *gets(char *s, int size);
00052     int printf(const char *format, ...) MBED_PRINTF_METHOD(1, 2);
00053     int scanf(const char *format, ...) MBED_SCANF_METHOD(1, 2);
00054     int vprintf(const char *format, std::va_list args) MBED_PRINTF_METHOD(1, 0);
00055     int vscanf(const char *format, std::va_list args) MBED_SCANF_METHOD(1, 0);
00056 
00057     operator std::FILE *()
00058     {
00059         return _file;
00060     }
00061 
00062 protected:
00063     virtual int close();
00064     virtual ssize_t write(const void *buffer, size_t length);
00065     virtual ssize_t read(void *buffer, size_t length);
00066     virtual off_t seek(off_t offset, int whence);
00067     virtual off_t tell();
00068     virtual void rewind();
00069     virtual int isatty();
00070     virtual int sync();
00071     virtual off_t size();
00072 
00073     virtual int _putc(int c) = 0;
00074     virtual int _getc() = 0;
00075 
00076     std::FILE *_file;
00077 
00078     /** Acquire exclusive access to this object.
00079      */
00080     virtual void lock()
00081     {
00082         // Stub
00083     }
00084 
00085     /** Release exclusive access to this object.
00086      */
00087     virtual void unlock()
00088     {
00089         // Stub
00090     }
00091 };
00092 /**@}*/
00093 
00094 /**@}*/
00095 } // namespace mbed
00096 
00097 #endif
00098