ScummVM API documentation
text_stream_reader.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 reading plain text from the stream
25
//
26
//=============================================================================
27
28
#ifndef AGS_SHARED_UTIL_TEXT_STREAM_READER_H
29
#define AGS_SHARED_UTIL_TEXT_STREAM_READER_H
30
31
#include "ags/shared/util/text_reader.h"
32
33
namespace
AGS3
{
34
namespace
AGS
{
35
namespace
Shared {
36
37
class
Stream;
38
39
class
TextStreamReader
:
public
TextReader
{
40
public
:
41
// TODO: use shared ptr
42
TextStreamReader
(
Stream
*stream);
43
~
TextStreamReader
()
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
// Read single character
53
char
ReadChar()
override
;
54
// Read defined number of characters
55
String
ReadString(
size_t
length)
override
;
56
// Read till line break
57
String
ReadLine()
override
;
58
// Read till end of available data
59
String
ReadAll()
override
;
60
61
private
:
62
Stream
*_stream;
63
};
64
65
}
// namespace Shared
66
}
// namespace AGS
67
}
// namespace AGS3
68
69
#endif
AGS
Definition:
achievements_tables.h:27
AGS3::AGS::Shared::TextStreamReader
Definition:
text_stream_reader.h:39
AGS3::AGS::Shared::String
Definition:
string.h:62
AGS3::AGS::Shared::Stream
Definition:
stream.h:52
AGS3::AGS::Shared::TextReader
Definition:
text_reader.h:37
AGS3
Definition:
ags.h:40
engines
ags
shared
util
text_stream_reader.h
Generated on Sat Aug 31 2024 09:08:49 for ScummVM API documentation by
1.8.13