ScummVM API documentation
text_stream_writer.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 //=============================================================================
23 //
24 // Class for writing plain text to the stream
25 //
26 //=============================================================================
27 
28 #ifndef AGS_SHARED_UTIL_TEXT_STREAM_WRITER_H
29 #define AGS_SHARED_UTIL_TEXT_STREAM_WRITER_H
30 
31 #include "ags/shared/util/text_writer.h"
32 
33 namespace AGS3 {
34 namespace AGS {
35 namespace Shared {
36 
37 class Stream;
38 
39 class TextStreamWriter : public TextWriter {
40 public:
41  // TODO: use shared ptr
42  TextStreamWriter(Stream *stream);
43  ~TextStreamWriter() override;
44 
45  bool IsValid() const override;
46  const Stream *GetStream() const;
47  // TODO: use shared ptr instead
48  void ReleaseStream();
49 
50  bool EOS() const;
51 
52  // Write single character
53  void WriteChar(char c) override;
54  // Write string as a plain text (without null-terminator)
55  void WriteString(const String &str) override;
56  // Write string and add line break at the end
57  void WriteLine(const String &str) override;
58  // Write formatted string (see *printf)
59  void WriteFormat(const char *fmt, ...) override;
60  void WriteLineBreak() override;
61 
62 private:
63  Stream *_stream;
64  String _buf; // formatting string buffer
65 };
66 
67 } // namespace Shared
68 } // namespace AGS
69 } // namespace AGS3
70 
71 #endif
Definition: achievements_tables.h:27
Definition: text_stream_writer.h:39
Definition: string.h:62
Definition: text_writer.h:37
Definition: stream.h:52
Definition: ags.h:40