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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
|
/* 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 GARGOYLE_STREAMS_H
#define GARGOYLE_STREAMS_H
#include "common/scummsys.h"
#include "common/file.h"
#include "common/savefile.h"
#include "common/str.h"
#include "gargoyle/glk_types.h"
namespace Gargoyle {
#define SAVEGAME_VERSION 1
class Window;
class Streams;
enum FileUsage {
fileusage_Data = 0x00,
fileusage_SavedGame = 0x01,
fileusage_Transcript = 0x02,
fileusage_InputRecord = 0x03,
fileusage_TypeMask = 0x0f,
fileusage_TextMode = 0x100,
fileusage_BinaryMode = 0x000,
};
enum FileMode {
filemode_Write = 0x01,
filemode_Read = 0x02,
filemode_ReadWrite = 0x03,
filemode_WriteAppend = 0x05,
};
enum SeekMode {
seekmode_Start = 0,
seekmode_Current = 1,
seekmode_End = 2,
};
struct StreamResult {
uint32 _readCount;
uint32 _writeCount;
};
typedef StreamResult stream_result_t;
struct SavegameHeader {
uint8 _version;
byte _interpType;
byte _language;
Common::String _md5;
Common::String _saveName;
int _year, _month, _day;
int _hour, _minute;
int _totalFrames;
/**
* Constructor
*/
SavegameHeader() : _version(0), _interpType(0), _language(0), _year(0), _month(0), _day(0),
_hour(0), _minute(0), _totalFrames(0) {}
};
/**
* File details
*/
struct FileReference {
glui32 _rock;
int _slotNumber;
Common::String _description;
Common::String _filename;
FileUsage _fileType;
bool _textMode;
gidispatch_rock_t _dispRock;
/**
* Constructor
*/
FileReference() : _rock(0), _slotNumber(-1), _fileType(fileusage_Data), _textMode(false) {}
/**
* Get savegame filename
*/
const Common::String getSaveName() const;
/**
* Returns true if the given file exists
*/
bool exists() const;
/**
* Delete the given file
*/
void deleteFile();
};
typedef FileReference *frefid_t;
typedef Common::Array< Common::SharedPtr<FileReference> > FileRefArray;
/**
* Base class for streams
*/
class Stream {
public:
Streams *_streams;
Stream *_prev;
Stream *_next;
uint32 _rock;
bool _unicode;
uint32 _readCount;
uint32 _writeCount;
bool _readable, _writable;
public:
/**
* Constructor
*/
Stream(Streams *streams, bool readable, bool writable, uint32 rock, bool unicode);
/**
* Destructor
*/
virtual ~Stream();
/**
* Get the next stream
*/
Stream *getNext(uint32 *rock) const;
/**
* Get the rock value for the stream
*/
uint32 getRock() const { return _rock; }
/**
* Fill out the total amount read and/or written
*/
void fillResult(StreamResult *result);
/**
* Close and delete the stream
*/
void close(StreamResult *result = nullptr);
/**
* Write a character
*/
virtual void putChar(unsigned char ch) = 0;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) = 0;
/**
* Write a buffer
*/
virtual void putBuffer(const char *buf, size_t len) = 0;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) = 0;
/**
* Send a line to the stream with a trailing newline
*/
void echoLine(char *buf, glui32 len) {
putBuffer(buf, len);
putChar('\n');
};
/**
* Send a line to the stream with a trailing newline
*/
void echoLineUni(glui32 *buf, glui32 len) {
putBufferUni(buf, len);
putCharUni('\n');
}
virtual glui32 getPosition() const { return 0; }
virtual void setPosition(glui32 pos, glui32 seekMode) {}
virtual void setStyle(glui32 val) {}
/**
* Get a character from the stream
*/
virtual glsi32 getChar() { return -1; }
/**
* Get a unicode character from the stream
*/
virtual glsi32 getCharUni() { return -1; }
/**
* Get a unicode buffer
*/
virtual glui32 getBufferUni(glui32 *buf, glui32 len) { return 0; }
/**
* Get a unicode line
*/
virtual glui32 getLineUni(glui32 *ubuf, glui32 len) { return 0; }
/**
* Set a hyperlink
*/
virtual void setHyperlink(glui32 linkVal) {}
};
typedef Stream *strid_t;
/**
* Implements the stream for writing text to a window
*/
class WindowStream : public Stream {
private:
Window *_window;
public:
/**
* Constructor
*/
WindowStream(Streams *streams, Window *window, uint32 rock = 0, bool unicode = true) :
Stream(streams, false, true, rock, unicode), _window(window) {}
/**
* Close the stream
*/
virtual void close(StreamResult *result = nullptr);
/**
* Write a character
*/
virtual void putChar(unsigned char ch) override;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) override;
/**
* Write a buffer
*/
virtual void putBuffer(const char *buf, size_t len) override;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) override;
virtual void setStyle(glui32 val) override;
/**
* Set a hyperlink
*/
virtual void setHyperlink(glui32 linkVal) override;
};
/**
* Implements an in-memory stream
*/
class MemoryStream : public Stream {
private:
void *_buf; ///< unsigned char* for latin1, glui32* for unicode
void *_bufPtr;
void *_bufEnd;
void *_bufEof;
size_t _bufLen; ///< # of bytes for latin1, # of 4-byte words for unicode
public:
/**
* Constructor
*/
MemoryStream(Streams *streams, void *buf, size_t buflen, FileMode mode, uint32 rock = 0, bool unicode = true);
/**
* Write a character
*/
virtual void putChar(unsigned char ch) override;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) override;
/**
* Write a buffer
*/
virtual void putBuffer(const char *buf, size_t len) override;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) override;
virtual glui32 getPosition() const override;
virtual void setPosition(glui32 pos, glui32 seekMode) override;
/**
* Get a character from the stream
*/
virtual glsi32 getChar() override;
/**
* Get a unicode character from the stream
*/
virtual glsi32 getCharUni() override;
/**
* Get a unicode buffer
*/
virtual glui32 getBufferUni(glui32 *buf, glui32 len) override;
/**
* Get a unicode line
*/
virtual glui32 getLineUni(glui32 *ubuf, glui32 len) override;
};
/**
* Implements a file stream
*/
class FileStream : public Stream {
private:
Common::File _file;
Common::OutSaveFile *_outFile;
Common::InSaveFile *_inFile;
Common::SeekableReadStream *_inStream;
uint32 _lastOp; ///< 0, filemode_Write, or filemode_Read
bool _textFile;
private:
/**
* Ensure the stream is ready for the given operation
*/
void ensureOp(FileMode mode);
/**
* Put a UTF8 character
*/
void putCharUtf8(glui32 val);
/**
* Get a UTF8 character
*/
glsi32 getCharUtf8();
public:
/**
* Read a savegame header from a stream
*/
static bool readSavegameHeader(Common::SeekableReadStream *stream, SavegameHeader &header);
/**
* Write out a savegame header
*/
static void writeSavegameHeader(Common::WriteStream *stream, const Common::String &saveName);
public:
/**
* Constructor
*/
FileStream(Streams *streams, frefid_t fref, glui32 fmode, glui32 rock, bool unicode);
/**
* Destructor
*/
virtual ~FileStream();
/**
* Write a character
*/
virtual void putChar(unsigned char ch) override;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) override;
/**
* Write a buffer
*/
virtual void putBuffer(const char *buf, size_t len) override;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) override;
virtual glui32 getPosition() const override;
virtual void setPosition(glui32 pos, glui32 seekMode) override;
/**
* Get a character from the stream
*/
virtual glsi32 getChar() override;
/**
* Get a unicode character from the stream
*/
virtual glsi32 getCharUni() override;
/**
* Get a unicode buffer
*/
virtual glui32 getBufferUni(glui32 *buf, glui32 len) override;
/**
* Get a unicode line
*/
virtual glui32 getLineUni(glui32 *ubuf, glui32 len) override;
};
/**
* Streams manager
*/
class Streams {
friend class Stream;
private:
Stream *_streamList;
Stream *_currentStream;
FileRefArray _fileReferences;
private:
/**
* Adds a created stream to the list
*/
void addStream(Stream *stream);
/**
* Remove a stream
*/
void removeStream(Stream *stream);
public:
/**
* Constructor
*/
Streams();
/**
* Destructor
*/
~Streams();
/**
* Open a file stream
*/
FileStream *openFileStream(frefid_t fref, glui32 fmode, glui32 rock, bool unicode);
/**
* Open a window stream
*/
WindowStream *openWindowStream(Window *window);
/**
* Open a memory stream
*/
MemoryStream *openMemoryStream(void *buf, size_t buflen, FileMode mode, uint32 rock = 0, bool unicode = true);
/**
* Delete a stream
*/
void deleteStream(Stream *stream) {
delete stream;
}
/**
* Start an Iteration through streams
*/
Stream *getFirst(uint32 *rock);
/**
* Set the current output stream
*/
void setCurrent(Stream *stream) {
assert(stream->_writable);
_currentStream = stream;
}
/**
* Gets the current output stream
*/
Stream *getCurrent() const { return _currentStream; }
/**
* Prompt for a savegame to load or save, and populate a file reference from the result
*/
frefid_t createByPrompt(glui32 usage, FileMode fmode, glui32 rock);
/**
* Create a new file reference
*/
frefid_t createRef(int slot, const Common::String &desc, glui32 usage, glui32 rock);
/**
* Create a new file reference
*/
frefid_t createRef(const Common::String &filename, glui32 usage, glui32 rock);
/**
* Create a new temporary file reference
*/
frefid_t createTemp(glui32 usage, glui32 rock);
/**
* Create a new file reference from an old one
*/
frefid_t createFromRef(frefid_t fref, glui32 usage, glui32 rock);
/**
* Delete a file reference
*/
void deleteRef(frefid_t fref);
/**
* Iterates to the next file reference following the specified one,
* or the first if null is passed
*/
frefid_t iterate(frefid_t fref, glui32 *rock);
};
} // End of namespace Gargoyle
#endif
|