aboutsummaryrefslogtreecommitdiff
path: root/engines/parallaction/parser.cpp
blob: 2ad65abf20a186c381d8db76d8e6a994edd0f3c3 (plain)
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
/* 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$
 *
 */

#include "parallaction/parallaction.h"


namespace Parallaction {

#define MAX_TOKENS	50

int				_numTokens;
char			_tokens[MAX_TOKENS][MAX_TOKEN_LEN];

Script::Script(Common::ReadStream *input, bool disposeSource) : _input(input), _disposeSource(disposeSource), _line(0) {}

Script::~Script() {
	if (_disposeSource)
		delete _input;
}

/*
 * readLineIntern read a text line and prepares it for
 * parsing, by stripping the leading whitespace and
 * changing tabs to spaces. It will stop on a CR or LF,
 * and return an empty string (length = 0) when a line
 * has no printable text in it.
 */
char *Script::readLineIntern(char *buf, size_t bufSize) {
	uint i = 0;
	for ( ; i < bufSize; ) {
		char c = _input->readSByte();
		if (_input->eos())
			break;
		if (c == '\n' || c == '\r')
			break;
		if (c == '\t')
			c = ' ';

		if ((c != ' ') || (i > 0)) {
			buf[i] = c;
			i++;
		}
	}
	_line++;
	if (i == bufSize) {
		warning("overflow in readLineIntern (line %i)", _line);
	}
	if (i == 0 && _input->eos()) {
		return 0;
	}
	buf[i] = '\0';
	return buf;
}

bool isCommentLine(char *text) {
	return text[0] == '#';
}

bool isStartOfCommentBlock(char *text) {
	return (text[0] == '[');
}

bool isEndOfCommentBlock(char *text) {
	return (text[0] == ']');
}

char *Script::readLine(char *buf, size_t bufSize) {
	bool inBlockComment = false;
	bool ignoreLine = true;

	char *line = 0;
	do {
		line = readLineIntern(buf, bufSize);
		if (line == 0) {
			return 0;
		}

		if (line[0] == '\0')
			continue;

		ignoreLine = false;

		line = Common::ltrim(line);
		if (isCommentLine(line)) {
			// ignore this line
			ignoreLine = true;
		} else
		if (isStartOfCommentBlock(line)) {
			// mark this and the following lines as comment
			inBlockComment = true;
		} else
		if (isEndOfCommentBlock(line)) {
			// comment is finished, so stop ignoring
			inBlockComment = false;
			// the current line must be skipped, though,
			// as it contains the end-of-comment marker
			ignoreLine = true;
		}

	} while (inBlockComment || ignoreLine);

	return line;
}



void Script::clearTokens() {
	memset(_tokens, 0, sizeof(_tokens));
	_numTokens = 0;
}

void Script::skip(const char* endToken) {

	while (scumm_stricmp(_tokens[0], endToken)) {
		readLineToken(true);
	}

}

//
//	Scans 's' until one of the stop-chars in 'brk' is found, building a token.
//	If the routine encounters quotes, it will extract the contained text and
//  make a proper token. When scanning inside quotes, 'brk' is ignored and
//  only newlines are considered stop-chars.
//
//	The routine returns the unparsed portion of the input string 's'.
//
char *Script::parseNextToken(char *s, char *tok, uint16 count, const char *brk) {

	enum STATES { NORMAL, QUOTED };

	STATES state = NORMAL;

	while (count > 0) {

		switch (state) {
		case NORMAL:
			if (*s == '\0') {
				*tok = '\0';
				return s;
			} else
			if (strchr(brk, *s)) {
				*tok = '\0';
				return ++s;
			} else
			if (*s == '"') {
				state = QUOTED;
				s++;
			} else {
				*tok++ = *s++;
				count--;
			}
			break;

		case QUOTED:
			if (*s == '\0') {
				*tok = '\0';
				return s;
			} else
			if (*s == '"') {
				*tok = '\0';
				return ++s;
			} else {
				*tok++ = *s++;
				count--;
			}
			break;
		}

	}

	*tok = '\0';
	// TODO: if execution flows here, make *REALLY* sure everything has been parsed
	// out of the input string. This is what is supposed to happen, but never ever
	// allocated time to properly check.

	return tok;

}

uint16 Script::readLineToken(bool errorOnEOF) {
	char buf[200];
	char *line = readLine(buf, 200);
	if (!line) {
		if (errorOnEOF)
			error("unexpected end of file while parsing");
		else
			return 0;
	}

	clearTokens();
	while (*line && _numTokens < MAX_TOKENS) {
		line = parseNextToken(line, _tokens[_numTokens], MAX_TOKEN_LEN, " ");
		line = Common::ltrim(line);
		_numTokens++;
	}
	return _numTokens;
}


void Parser::reset() {
	_currentOpcodes = 0;
	_currentStatements = 0;

	_statements.clear();
	_opcodes.clear();
}

void Parser::pushTables(OpcodeSet *opcodes, Table *statements) {
	_opcodes.push(_currentOpcodes);
	_statements.push(_currentStatements);

	_currentOpcodes = opcodes;
	_currentStatements = statements;
}

void Parser::popTables() {
	assert(_opcodes.size() > 0);

	_currentOpcodes = _opcodes.pop();
	_currentStatements = _statements.pop();
}

void Parser::parseStatement() {
	assert(_currentOpcodes != 0);

	_lookup = _currentStatements->lookup(_tokens[0]);

	debugC(9, kDebugParser, "parseStatement: %s (lookup = %i)", _tokens[0], _lookup);

	(*(*_currentOpcodes)[_lookup])();
}


#define BLOCK_BASE	100

class StatementDef {
protected:
	Common::String makeLineFromTokens() {
		Common::String space(" ");
		Common::String newLine("\n");
		Common::String text;
		for (int i = 0; i < _numTokens; i++)
			text += (Common::String(_tokens[i]) + space);
		text.deleteLastChar();
		text += newLine;
		return text;
	}

public:
	uint _score;
	const char*	_name;


	StatementDef(uint score, const char *name) : _score(score), _name(name) { }
	virtual ~StatementDef() { }

	virtual Common::String makeLine(Script &script) = 0;

};


class SimpleStatementDef : public StatementDef {

public:
	SimpleStatementDef(uint score, const char *name) : StatementDef(score, name) { }

	Common::String makeLine(Script &script) {
		return makeLineFromTokens();
	}

};



class BlockStatementDef : public StatementDef {

	const char*	_ending1;
	const char*	_ending2;

public:
	BlockStatementDef(uint score, const char *name, const char *ending1, const char *ending2 = 0) : StatementDef(score, name), _ending1(ending1),
		_ending2(ending2) { }

	Common::String makeLine(Script &script) {
		Common::String text = makeLineFromTokens();
		bool end;
		do {
			script.readLineToken(true);
			text += makeLineFromTokens();
			end = !scumm_stricmp(_ending1, _tokens[0]) || (_ending2 && !scumm_stricmp(_ending2, _tokens[0]));
		} while (!end);
		return text;
	}

};

class CommentStatementDef : public StatementDef {

	Common::String parseComment(Script &script) {
		Common::String result;
		char buf[401];
		do {
			char *line = script.readLine(buf, 400);
			if (!scumm_stricmp(line, "endtext"))
				break;
			result += Common::String(line) + "\n";
		} while (true);
		result += "endtext\n";
		return result;
	}

public:
	CommentStatementDef(uint score, const char *name) : StatementDef(score, name) { }

	Common::String makeLine(Script &script) {
		Common::String text = makeLineFromTokens();
		text += parseComment(script);
		return text;
	}

};




PreProcessor::PreProcessor() {
	_defs.push_back(new SimpleStatementDef(1, "disk" ));
	_defs.push_back(new SimpleStatementDef(2, "location" ));
	_defs.push_back(new SimpleStatementDef(3, "localflags" ));
	_defs.push_back(new SimpleStatementDef(4, "flags" ));
	_defs.push_back(new SimpleStatementDef(5, "zeta" ));
	_defs.push_back(new SimpleStatementDef(6, "music" ));
	_defs.push_back(new SimpleStatementDef(7, "sound" ));
	_defs.push_back(new SimpleStatementDef(8, "mask" ));
	_defs.push_back(new SimpleStatementDef(9, "path" ));
	_defs.push_back(new SimpleStatementDef(10, "character" ));
	_defs.push_back(new CommentStatementDef(11, "comment" ));
	_defs.push_back(new CommentStatementDef(12, "endcomment" ));
	_defs.push_back(new BlockStatementDef(13,  "ifchar", "endif" ));
	_defs.push_back(new BlockStatementDef(BLOCK_BASE, "zone", "endanimation", "endzone" ));
	_defs.push_back(new BlockStatementDef(BLOCK_BASE, "animation", "endanimation", "endzone" ));
	_defs.push_back(new BlockStatementDef(1000, "commands", "endcommands" ));
	_defs.push_back(new BlockStatementDef(1001, "acommands", "endcommands" ));
	_defs.push_back(new BlockStatementDef(1002, "escape", "endcommands" ));
	_defs.push_back(new SimpleStatementDef(2000, "endlocation"));
}

PreProcessor::~PreProcessor() {
	DefList::iterator it = _defs.begin();
	for (; it != _defs.end(); it++) {
		delete *it;
	}
}

StatementDef* PreProcessor::findDef(const char* name) {
	DefList::iterator it = _defs.begin();
	for (; it != _defs.end(); it++) {
		if (!scumm_stricmp((*it)->_name, name)) {
			return *it;
		}
	}
	return 0;
}



uint PreProcessor::getDefScore(StatementDef* def) {
	if (def->_score == BLOCK_BASE) {
		_numZones++;
		return (_numZones + BLOCK_BASE);
	}
	return def->_score;
}


void PreProcessor::preprocessScript(Script &script, StatementList &list) {
	_numZones = 0;
	Common::String text;
	do {
		if (script.readLineToken(false) == 0)
			break;

		StatementDef *def = findDef(_tokens[0]);
		if (!def) {
			error("PreProcessor::preprocessScript: unknown statement '%s' found\n", _tokens[0]);
		}

		text = def->makeLine(script);
		int score = getDefScore(def);
		list.push_back(StatementListNode(score, def->_name, text));
	} while (true);
	Common::sort(list.begin(), list.end());
}




void testPreprocessing(Parallaction *vm, const char *filename) {
	Script *script = vm->_disk->loadLocation(filename);
	StatementList list;
	PreProcessor pp;
	pp.preprocessScript(*script, list);
	delete script;
	Common::DumpFile dump;
	dump.open(filename);
	StatementList::iterator it = list.begin();
	for ( ; it != list.end(); it++) {
		dump.write((*it)._text.c_str(), (*it)._text.size());
	}
	dump.close();
}


} // namespace Parallaction