Stream.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_STREAM_H
00017 #define MBED_STREAM_H
00018 
00019 #include "platform/platform.h"
00020 #include "drivers/FileLike.h"
00021 #include <cstdarg>
00022 
00023 namespace mbed {
00024 /** \addtogroup drivers */
00025 /** @{*/
00026 
00027 extern void mbed_set_unbuffered_stream(FILE *_file);
00028 extern int mbed_getc(FILE *_file);
00029 extern char* mbed_gets(char *s, int size, FILE *_file);
00030 
00031 /** File stream
00032  *
00033  * @Note Synchronization level: Set by subclass
00034  */
00035 class Stream : public FileLike {
00036 
00037 public:
00038     Stream(const char *name=NULL);
00039     virtual ~Stream();
00040 
00041     int putc(int c);
00042     int puts(const char *s);
00043     int getc();
00044     char *gets(char *s, int size);
00045     int printf(const char* format, ...);
00046     int scanf(const char* format, ...);
00047     int vprintf(const char* format, std::va_list args);
00048     int vscanf(const char* format, std::va_list args);
00049 
00050     operator std::FILE*() {return _file;}
00051 
00052 protected:
00053     virtual int close();
00054     virtual ssize_t write(const void* buffer, size_t length);
00055     virtual ssize_t read(void* buffer, size_t length);
00056     virtual off_t lseek(off_t offset, int whence);
00057     virtual int isatty();
00058     virtual int fsync();
00059     virtual off_t flen();
00060 
00061     virtual int _putc(int c) = 0;
00062     virtual int _getc() = 0;
00063 
00064     std::FILE *_file;
00065 
00066     /* disallow copy constructor and assignment operators */
00067 private:
00068     Stream(const Stream&);
00069     Stream & operator = (const Stream&);
00070 };
00071 
00072 } // namespace mbed
00073 
00074 #endif
00075 
00076 /** @}*/