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.h"
00020 #include "FileLike.h"
00021 #include <cstdarg>
00022 
00023 namespace mbed {
00024 
00025 extern void mbed_set_unbuffered_stream(FILE *_file);
00026 extern int mbed_getc(FILE *_file);
00027 extern char* mbed_gets(char *s, int size, FILE *_file);
00028 
00029 /** File stream
00030  *
00031  * @Note Synchronization level: Set by subclass
00032  */
00033 class Stream : public FileLike {
00034 
00035 public:
00036     Stream(const char *name=NULL);
00037     virtual ~Stream();
00038 
00039     int putc(int c);
00040     int puts(const char *s);
00041     int getc();
00042     char *gets(char *s, int size);
00043     int printf(const char* format, ...);
00044     int scanf(const char* format, ...);
00045     int vprintf(const char* format, std::va_list args);
00046     int vscanf(const char* format, std::va_list args);
00047 
00048     operator std::FILE*() {return _file;}
00049 
00050 protected:
00051     virtual int close();
00052     virtual ssize_t write(const void* buffer, size_t length);
00053     virtual ssize_t read(void* buffer, size_t length);
00054     virtual off_t lseek(off_t offset, int whence);
00055     virtual int isatty();
00056     virtual int fsync();
00057     virtual off_t flen();
00058 
00059     virtual int _putc(int c) = 0;
00060     virtual int _getc() = 0;
00061 
00062     std::FILE *_file;
00063 
00064     /* disallow copy constructor and assignment operators */
00065 private:
00066     Stream(const Stream&);
00067     Stream & operator = (const Stream&);
00068 };
00069 
00070 } // namespace mbed
00071 
00072 #endif