1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef TITANIC_SIMPLE_FILE_H
#define TITANIC_SIMPLE_FILE_H
#include "common/file.h"
#include "titanic/support/rect.h"
#include "common/savefile.h"
#include "common/stream.h"
#include "common/zlib.h"
#include "titanic/support/string.h"
namespace Titanic {
class Decompressor;
class DecompressorData;
/**
* Simple ScummVM File descendent that throws a wobbly if
* the file it tries to open isn't present
*/
class File : public Common::File {
public:
virtual bool open(const Common::String &name);
};
/**
* This class implements basic reading and writing to files
*/
class SimpleFile {
protected:
Common::SeekableReadStream *_inStream;
Common::OutSaveFile *_outStream;
int _lineCount;
public:
SimpleFile();
virtual ~SimpleFile();
/**
* Set up a stream for read access
*/
virtual void open(Common::SeekableReadStream *stream);
/**
* Set up a stream for write access
*/
virtual void open(Common::OutSaveFile *stream);
/**
* Close the file
*/
virtual void close();
/**
* Read from the file with validation
*/
virtual void safeRead(void *dst, size_t count);
/**
* Read from the file
*/
virtual size_t unsafeRead(void *dst, size_t count);
/**
* Write out data
*/
virtual size_t write(const void *src, size_t count);
/**
* Read a string from the file
*/
CString readString();
/**
* Read a number from the file
*/
int readNumber();
/**
* Read a floating point number from the file
*/
double readFloat();
/**
* Read in a point
*/
Point readPoint();
/**
* Read in a rect
*/
Rect readRect();
/**
* Read a string and copy it into an optionally passed buffer
*/
void readBuffer(char *buffer = nullptr, size_t count = 0);
/**
* Write a string line
*/
void writeLine(const CString &str);
/**
* Write a string
*/
void writeString(const CString &str);
/**
* Write a quoted string
*/
void writeQuotedString(const CString &str);
/**
* Write a quoted string line
*/
void writeQuotedLine(const CString &str, int indent);
/**
* Write a number to file
*/
void writeNumber(int val);
/**
* Write a number line to file
*/
void writeNumberLine(int val, int indent);
/**
* Write a floating point number
*/
void writeFloat(double val);
/**
* Write a floating point number as a line
*/
void writeFloatLine(double val, int indent);
/**
* Write out a point line
*/
void writePoint(const Point &pt, int indent);
/**
* Write out a rect line
*/
void writeRect(const Rect &r, int indent);
/**
* Write out a number of tabs to form an indent in the output
*/
void writeIndent(uint indent);
/**
* Validates that the following non-space character is either
* an opening or closing squiggly bracket denoting a class
* definition start or end. Returns true if it's a class start
*/
bool IsClassStart();
/**
* Write the starting header for a class definition
*/
void writeClassStart(const CString &classStr, int indent);
/**
* Write out the ending footer for a class definition
*/
void writeClassEnd(int indent);
};
/**
* Derived file that handles compressed files
*/
class CompressedFile : public SimpleFile {
public:
CompressedFile() : SimpleFile() {}
virtual ~CompressedFile() {}
/**
* Set up a stream for read access
*/
virtual void open(Common::SeekableReadStream *stream) {
SimpleFile::open(Common::wrapCompressedReadStream(stream));
}
/**
* Set up a stream for write access
*/
virtual void open(Common::OutSaveFile *stream) {
SimpleFile::open(Common::wrapCompressedWriteStream(stream));
}
};
/**
* Derived file that handles WAD archives containing multiple files
*/
class StdCWadFile : public SimpleFile {
public:
StdCWadFile() : SimpleFile() {}
virtual ~StdCWadFile() {}
/**
* Open up the specified file
*/
void open(const CString &name);
/**
* Return a reference to the read stream
*/
Common::SeekableReadStream *readStream() const { return _inStream; }
};
} // End of namespace Titanic
#endif /* TITANIC_SIMPLE_FILE_H */
|
