Gan likun / mbed-dev

00

platform/Stream.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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