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
|
/* 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.
*
* $URL$
* $Id$
*
*/
/**
* @brief GPL2 bytecode disassembler
* @param gplcode A pointer to the bytecode
* len Length of the bytecode
*
* GPL2 is short for Game Programming Language 2 which is the script language
* used by Draci Historie. This is a simple disassembler for the language.
*
* A compiled GPL2 program consists of a stream of bytes representing commands
* and their parameters. The syntax is as follows:
*
* Syntax of a command:
* <name of the command> <number> <sub-number> <list of parameters...>
*
* Syntax of a parameter:
* - 1: integer number literally passed to the program
* - 2-1: string stored in the reservouir of game strings (i.e. something to be
* displayed) and stored as an index in this list
* - 2-2: string resolved by the compiler (i.e., a path to another file) and
* replaced by an integer index of this entity in the appropriate namespace
* (e.g., the index of the palette, location, ...)
* - 3-0: relative jump to a label defined in this code. Each label must be
* first declared in the beginning of the program.
* - 3-1 .. 3-9: index of an entity in several namespaces, defined in file ident
* - 4: mathematical expression compiled into a postfix format
*
* In the compiled program, parameters of type 1..3 are represented by a single
* 16-bit integer. The called command knows by its definition what namespace the
* value comes from.
*/
#include "common/debug.h"
#include "common/stream.h"
#include "draci/gpldisasm.h"
#include "draci/barchive.h"
#include "draci/draci.h"
#define skipParams(x) for(unsigned int i = 0; i < (x); ++i) reader.readUint16LELE()
#define CMDPAIR(x, y) (((x) << 8) | y)
namespace Draci {
// FIXME: Handle math expressions properly instead of just skipping them
void handleMathExpression(Common::MemoryReadStream &reader) {
uint16 temp;
while (1) {
temp = reader.readUint16LE();
if (temp == 0) {
break;
}
temp = reader.readUint16LE();
}
return;
}
int gpldisasm(byte *gplcode, uint16 len) {
Common::MemoryReadStream reader(gplcode, len);
while (!reader.eos()) {
// read in command pair
uint16 cmdpair = reader.readUint16BE();
uint16 param1, param2, param3;
switch (cmdpair) {
case CMDPAIR(5,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_Load %hu %hu", param1, param2);
break;
case CMDPAIR(4,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_Start %hu %hu", param1, param2);
break;
case CMDPAIR(5,2):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_StartPlay %hu %hu",
param1, param2);
break;
case CMDPAIR(5,3):
debugC(2, kDraciBytecodeDebugLevel, "C_JustTalk");
break;
case CMDPAIR(5,4):
debugC(2, kDraciBytecodeDebugLevel, "C_JustStay");
break;
case CMDPAIR(10,2):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_StayOn %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(10,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_WalkOn %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(10,3):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_WalkOnPlay %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(7,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ObjStat %hu %hu",
param1, param2);
break;
case CMDPAIR(7,2):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ObjStat_On %hu %hu",
param1, param2);
break;
case CMDPAIR(8,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_IcoStat %hu %hu",
param1, param2);
break;
case CMDPAIR(14,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_NewRoom %hu %hu",
param1, param2);
break;
case CMDPAIR(6,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_Talk %hu %hu",
param1, param2);
break;
case CMDPAIR(2,1):
param1 = reader.readUint16LE();
handleMathExpression(reader);
debugC(2, kDraciBytecodeDebugLevel, "C_Let <MATHEXPR> %hu", param1);
break;
case CMDPAIR(15,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ExecInit %hu", param1);
break;
case CMDPAIR(15,2):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ExecLook %hu", param1);
break;
case CMDPAIR(15,3):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ExecUse %hu", param1);
break;
case CMDPAIR(16,1):
debugC(2, kDraciBytecodeDebugLevel, "C_RepaintInventory");
break;
case CMDPAIR(16,2):
debugC(2, kDraciBytecodeDebugLevel, "C_ExitInventory");
break;
case CMDPAIR(1,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_goto %hu", param1);
break;
case CMDPAIR(3,1):
handleMathExpression(reader);
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_if <MATHEXPR> %hu", param1);
break;
case CMDPAIR(9,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_Dialogue %hu", param1);
break;
case CMDPAIR(9,2):
debugC(2, kDraciBytecodeDebugLevel, "C_ExitDialogue");
break;
case CMDPAIR(9,3):
debugC(2, kDraciBytecodeDebugLevel, "C_ResetDialogue");
break;
case CMDPAIR(9,4):
debugC(2, kDraciBytecodeDebugLevel, "C_ResetDialogueFrom");
break;
case CMDPAIR(9,5):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ResetBlock %hu", param1);
break;
case CMDPAIR(11,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_LoadPalette %hu", param1);
break;
case CMDPAIR(12,1):
debugC(2, kDraciBytecodeDebugLevel, "C_SetPalette");
break;
case CMDPAIR(12,2):
debugC(2, kDraciBytecodeDebugLevel, "C_BlackPalette");
break;
case CMDPAIR(13,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_FadePalette %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(13,2):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_FadePalettePlay %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(17,1):
debugC(2, kDraciBytecodeDebugLevel, "C_ExitMap");
break;
case CMDPAIR(18,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_LoadMusic %hu", param1);
break;
case CMDPAIR(18,2):
debugC(2, kDraciBytecodeDebugLevel, "C_StartMusic");
break;
case CMDPAIR(18,3):
debugC(2, kDraciBytecodeDebugLevel, "C_StopMusic");
break;
case CMDPAIR(18,4):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_FadeOutMusic %hu", param1);
break;
case CMDPAIR(18,5):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_FadeInMusic %hu", param1);
break;
case CMDPAIR(19,1):
debugC(2, kDraciBytecodeDebugLevel, "C_Mark");
break;
case CMDPAIR(19,2):
debugC(2, kDraciBytecodeDebugLevel, "C_Release");
break;
case CMDPAIR(20,1):
debugC(2, kDraciBytecodeDebugLevel, "C_Play");
break;
case CMDPAIR(21,1):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_LoadMap %hu", param1);
break;
case CMDPAIR(21,2):
debugC(2, kDraciBytecodeDebugLevel, "C_RoomMap");
break;
case CMDPAIR(22,1):
debugC(2, kDraciBytecodeDebugLevel, "C_DisableQuickHero");
break;
case CMDPAIR(22,2):
debugC(2, kDraciBytecodeDebugLevel, "C_EnableQuickHero");
break;
case CMDPAIR(23,1):
debugC(2, kDraciBytecodeDebugLevel, "C_DisableSpeedText");
break;
case CMDPAIR(23,2):
debugC(2, kDraciBytecodeDebugLevel, "C_EnableSpeedText");
break;
case CMDPAIR(24,1):
debugC(2, kDraciBytecodeDebugLevel, "C_QuitGame");
break;
case CMDPAIR(25,1):
debugC(2, kDraciBytecodeDebugLevel, "C_PushNewRoom");
break;
case CMDPAIR(25,2):
debugC(2, kDraciBytecodeDebugLevel, "C_PopNewRoom");
break;
case CMDPAIR(26,1):
debugC(2, kDraciBytecodeDebugLevel, "C_ShowCheat");
break;
case CMDPAIR(26,2):
debugC(2, kDraciBytecodeDebugLevel, "C_HideCheat");
break;
case CMDPAIR(26,3):
param1 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_ClearCheat %hu", param1);
break;
case CMDPAIR(27,1):
param1 = reader.readUint16LE();
param2 = reader.readUint16LE();
param3 = reader.readUint16LE();
debugC(2, kDraciBytecodeDebugLevel, "C_FeedPassword %hu %hu %hu",
param1, param2, param3);
break;
case CMDPAIR(0, 0):
debugC(2, kDraciBytecodeDebugLevel, "gplend");
break;
case CMDPAIR(0, 1):
debugC(2, kDraciBytecodeDebugLevel, "exit");
break;
default:
debugC(2, kDraciBytecodeDebugLevel, "Unknown opcode %hu, %hu",
(cmdpair >> 8) & 0xFF, cmdpair & 0xFF);
}
}
return 0;
}
}
|
