Stream.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_STREAM_H
00023 #define MBED_STREAM_H
00024 
00025 #include "platform.h"
00026 #include "FileLike.h"
00027 
00028 namespace mbed {
00029 
00030 class Stream : public FileLike {
00031 
00032 public:
00033     Stream(const char *name=NULL);
00034     virtual ~Stream();
00035 
00036     int putc(int c);
00037     int puts(const char *s);
00038     int getc();
00039     char *gets(char *s, int size);
00040     int printf(const char* format, ...);
00041     int scanf(const char* format, ...);
00042 
00043     operator std::FILE*() {return _file;}
00044 
00045 protected:
00046     virtual int close();
00047     virtual ssize_t write(const void* buffer, size_t length);
00048     virtual ssize_t read(void* buffer, size_t length);
00049     virtual off_t lseek(off_t offset, int whence);
00050     virtual int isatty();
00051     virtual int fsync();
00052     virtual off_t flen();
00053 
00054     virtual int _putc(int c) = 0;
00055     virtual int _getc() = 0;
00056 
00057     std::FILE *_file;
00058 };
00059 
00060 } // namespace mbed
00061 
00062 #endif
00063