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
|
/* 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_FROTZ_MEM
#define GLK_FROTZ_MEM
#include "glk/frotz/frotz_types.h"
namespace Glk {
namespace Frotz {
#define SET_WORD(addr,v) zmp[addr] = hi(v); zmp[addr+1] = lo(v)
#define LOW_WORD(addr,v) v = READ_BE_UINT16(&zmp[addr])
#define HIGH_WORD(addr,v) v = READ_BE_UINT16(&zmp[addr])
#define HIGH_LONG(addr,v) v = READ_BE_UINT32(&zmp[addr])
#define SET_BYTE(addr,v) zmp[addr] = v
#define LOW_BYTE(addr,v) v = zmp[addr]
enum HeaderByte {
H_VERSION = 0,
H_CONFIG = 1,
H_RELEASE = 2,
H_RESIDENT_SIZE = 4,
H_START_PC = 6,
H_DICTIONARY = 8,
H_OBJECTS = 10,
H_GLOBALS = 12,
H_DYNAMIC_SIZE = 14,
H_FLAGS = 16,
H_SERIAL = 18,
H_ABBREVIATIONS = 24,
H_FILE_SIZE = 26,
H_CHECKSUM = 28,
H_INTERPRETER_NUMBER = 30,
H_INTERPRETER_VERSION = 31,
H_SCREEN_ROWS = 32,
H_SCREEN_COLS = 33,
H_SCREEN_WIDTH = 34,
H_SCREEN_HEIGHT = 36,
H_FONT_HEIGHT = 38, ///< this is the font width in V5
H_FONT_WIDTH = 39, ///< this is the font height in V5
H_FUNCTIONS_OFFSET = 40,
H_STRINGS_OFFSET = 42,
H_DEFAULT_BACKGROUND = 44,
H_DEFAULT_FOREGROUND = 45,
H_TERMINATING_KEYS = 46,
H_LINE_WIDTH = 48,
H_STANDARD_HIGH = 50,
H_STANDARD_LOW = 51,
H_ALPHABET = 52,
H_EXTENSION_TABLE = 54,
H_USER_NAME = 56
};
enum {
HX_TABLE_SIZE = 0,
HX_MOUSE_X = 1,
HX_MOUSE_Y = 2,
HX_UNICODE_TABLE = 3,
HX_FLAGS = 4,
HX_FORE_COLOUR = 5,
HX_BACK_COLOUR = 6
};
/**
* Stores undo information
*/
struct undo_struct {
undo_struct *next;
undo_struct *prev;
long pc;
long diff_size;
zword frame_count;
zword stack_size;
zword frame_offset;
// undo diff and stack data follow
};
typedef undo_struct undo_t;
/**
* Story file header data
*/
struct Header {
private:
struct StoryEntry {
Story _storyId;
zword _release;
char _serial[7];
};
static const StoryEntry RECORDS[25];
public:
zbyte h_version;
zbyte h_config;
zword h_release;
zword h_resident_size;
zword h_start_pc;
zword h_dictionary;
zword h_objects;
zword h_globals;
zword h_dynamic_size;
zword h_flags;
zbyte h_serial[6];
zword h_abbreviations;
zword h_file_size;
zword h_checksum;
zbyte h_interpreter_number;
zbyte h_interpreter_version;
zbyte h_screen_rows;
zbyte h_screen_cols;
zword h_screen_width;
zword h_screen_height;
zbyte h_font_height = 1;
zbyte h_font_width = 1;
zword h_functions_offset;
zword h_strings_offset;
zbyte h_default_background;
zbyte h_default_foreground;
zword h_terminating_keys;
zword h_line_width;
zbyte h_standard_high;
zbyte h_standard_low;
zword h_alphabet;
zword h_extension_table;
zbyte h_user_name[8];
zword hx_table_size;
zword hx_mouse_x;
zword hx_mouse_y;
zword hx_unicode_table;
zword hx_flags;
zword hx_fore_colour;
zword hx_back_colour;
Story _storyId;
/**
* Constructor
*/
Header() : h_version(0), h_config(0), h_release(0), h_resident_size(0), h_start_pc(0),
h_dictionary(0), h_objects(0), h_globals(0), h_dynamic_size(0), h_flags(0),
h_abbreviations(0), h_file_size(0), h_checksum(0), h_interpreter_number(0),
h_interpreter_version(0), h_screen_rows(0), h_screen_cols(0), h_screen_width(0),
h_screen_height(0), h_font_height(1), h_font_width(1), h_functions_offset(0),
h_strings_offset(0), h_default_background(0), h_default_foreground(0),
h_terminating_keys(0), h_line_width(0), h_standard_high(1), h_standard_low(1),
h_alphabet(0), h_extension_table(0),
hx_table_size(0), hx_mouse_x(0), hx_mouse_y(0), hx_unicode_table(0),
hx_flags(0), hx_fore_colour(0), hx_back_colour(0), _storyId(UNKNOWN) {
Common::fill(&h_serial[0], &h_serial[6], '\0');
Common::fill(&h_user_name[0], &h_user_name[8], '\0');
}
/**
* Load the header
*/
void loadHeader(Common::SeekableReadStream &f);
};
class Mem : public Header, public virtual UserOptions {
protected:
Common::SeekableReadStream *story_fp;
uint blorb_ofs, blorb_len;
uint story_size;
byte *pcp;
byte *zmp;
undo_t *first_undo, *last_undo, *curr_undo;
zbyte *undo_mem, *prev_zmp, *undo_diff;
int undo_count;
int reserve_mem;
private:
/**
* Handles setting the story file, parsing it if it's a Blorb file
*/
void initializeStoryFile();
/**
* Setup undo data
*/
void initializeUndo();
/**
* Handles loading the game header
*/
void loadGameHeader();
protected:
/**
* Read a value from the header extension (former mouse table).
*/
zword get_header_extension(int entry);
/**
* Set an entry in the header extension (former mouse table).
*/
void set_header_extension(int entry, zword val);
/**
* Set all header fields which hold information about the interpreter.
*/
void restart_header();
/**
* Write a byte value to the dynamic Z-machine memory.
*/
void storeb(zword addr, zbyte value);
/**
* Write a word value to the dynamic Z-machine memory.
*/
void storew(zword addr, zword value);
/**
* Free count undo blocks from the beginning of the undo list
*/
void free_undo(int count);
/**
* Generates a runtime error
*/
virtual void runtimeError(ErrorCode errNum) = 0;
/**
* Called when the flags are changed
*/
virtual void flagsChanged(zbyte value) = 0;
/**
* Close the story file and deallocate memory.
*/
void reset_memory();
/**
* Set diff to a Quetzal-like difference between a and b,
* copying a to b as we go. It is assumed that diff points to a
* buffer which is large enough to hold the diff.
* mem_size is the number of bytes to compare.
* Returns the number of bytes copied to diff.
*
*/
long mem_diff(zbyte *a, zbyte *b, zword mem_size, zbyte *diff);
/**
* Applies a quetzal-like diff to dest
*/
void mem_undiff(zbyte *diff, long diff_length, zbyte *dest);
public:
/**
* Constructor
*/
Mem();
/**
* Initialize
*/
void initialize();
};
} // End of namespace Frotz
} // End of namespace Glk
#endif
|
