ScummVM API documentation
text_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
// Specialized interface for reading plain text from the underlying source
25
//
26
//=============================================================================
27
28
#ifndef AGS_SHARED_UTIL_TEXT_READER_H
29
#define AGS_SHARED_UTIL_TEXT_READER_H
30
31
#include "ags/shared/util/string.h"
32
33
namespace
AGS3
{
34
namespace
AGS
{
35
namespace
Shared {
36
37
class
TextReader
{
38
public
:
39
virtual
~
TextReader
() {}
40
41
virtual
bool
IsValid()
const
= 0;
42
43
// Read single character
44
virtual
char
ReadChar() = 0;
45
// Read defined number of characters
46
virtual
String
ReadString(
size_t
length) = 0;
47
// Read till line break
48
virtual
String
ReadLine() = 0;
49
// Read till end of available data
50
virtual
String
ReadAll() = 0;
51
};
52
53
}
// namespace Shared
54
}
// namespace AGS
55
}
// namespace AGS3
56
57
#endif
AGS
Definition:
achievements_tables.h:27
AGS3::AGS::Shared::String
Definition:
string.h:62
AGS3::AGS::Shared::TextReader
Definition:
text_reader.h:37
AGS3
Definition:
ags.h:40
engines
ags
shared
util
text_reader.h
Generated on Sat Aug 31 2024 09:08:49 for ScummVM API documentation by
1.8.13