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
|
/* 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 GLK_QUETZAL
#define GLK_QUETZAL
#include "common/array.h"
#include "common/endian.h"
#include "common/memstream.h"
#include "common/stream.h"
#include "engines/savestate.h"
#include "glk/blorb.h"
#include "glk/glk_types.h"
namespace Glk {
enum QueztalTag {
ID_IFSF = MKTAG('I', 'F', 'S', 'F'),
ID_IFZS = MKTAG('I', 'F', 'Z', 'S'),
ID_IFhd = MKTAG('I', 'F', 'h', 'd'),
ID_UMem = MKTAG('U', 'M', 'e', 'm'),
ID_CMem = MKTAG('C', 'M', 'e', 'm'),
ID_Stks = MKTAG('S', 't', 'k', 's'),
ID_SCVM = MKTAG('S', 'C', 'V', 'M')
};
class QuetzalBase {
public:
static uint32 getInterpreterTag(InterpreterType interpType);
};
/**
* Quetzal save file reader
*/
class QuetzalReader : public QuetzalBase {
struct Chunk {
uint32 _id;
size_t _offset, _size;
};
public:
/**
* Iterator for the chunks list
*/
struct Iterator {
private:
Common::SeekableReadStream *_stream;
Common::Array<Chunk> &_chunks;
int _index;
public:
/**
* Constructor
*/
Iterator(Common::SeekableReadStream *stream, Common::Array<Chunk> &chunks, int index) :
_stream(stream), _chunks(chunks), _index(index) {}
/**
* Deference
*/
Chunk &operator*() const { return _chunks[_index]; }
/**
* Incrementer
*/
Iterator &operator++() {
++_index;
return *this;
}
/**
* Decrementer
*/
Iterator &operator--() {
--_index;
return *this;
}
/**
* Equality test
*/
bool operator==(const Iterator &rhs) { return _index == rhs._index; }
/**
* Inequality test
*/
bool operator!=(const Iterator &rhs) { return _index != rhs._index; }
/**
* Get a read stream for the contents of a chunk
*/
Common::SeekableReadStream *getStream() {
_stream->seek(_chunks[_index]._offset);
return _stream->readStream(_chunks[_index]._size);
}
};
private:
Common::SeekableReadStream *_stream;
Common::Array<Chunk> _chunks;
public:
/**
* Constructor
*/
QuetzalReader() : _stream(nullptr) {}
/**
* Clear
*/
void clear();
/**
* Opens a Quetzal file for access
*/
bool open(Common::SeekableReadStream *stream, uint32 formType = 0);
/**
* Return an iterator for the beginning of the chunks list
*/
Iterator begin() { return Iterator(_stream, _chunks, 0); }
/**
* Return an iterator for the beginning of the chunks list
*/
Iterator end() { return Iterator(_stream, _chunks, _chunks.size()); }
/**
* Loads a Quetzal save and extracts it's description from an ANNO chunk
*/
static bool getSavegameDescription(Common::SeekableReadStream *rs, Common::String &saveName);
/**
* Loads a Quetzal save and extract's it's description and meta info
*/
static bool getSavegameMetaInfo(Common::SeekableReadStream *rs, SaveStateDescriptor &ssd);
/**
* Support method for reading a string from a stream
*/
static Common::String readString(Common::ReadStream *src);
};
/**
* Quetzal save file writer
*/
class QuetzalWriter : public QuetzalBase {
/**
* Chunk entry
*/
struct Chunk {
uint32 _id;
Common::MemoryWriteStreamDynamic _stream;
/**
* Constructor
*/
Chunk() : _id(0), _stream(DisposeAfterUse::YES) {}
/**
* Constructor
*/
Chunk(uint32 id) : _id(id), _stream(DisposeAfterUse::YES) {}
};
private:
Common::Array<Chunk> _chunks;
/**
* Add chunks common to all Glk savegames
*/
void addCommonChunks(const Common::String &saveName);
public:
/**
* Clear
*/
void clear() { _chunks.clear(); }
/**
* Add a chunk
*/
Common::WriteStream &add(uint32 chunkId);
/**
* Save the added chunks to file
*/
void save(Common::WriteStream *out, const Common::String &saveName, uint32 formType = ID_IFSF);
};
} // End of namespace Glk
#endif
|
