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
|
/* 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$
*
*/
#ifndef GOB_SCRIPT_H
#define GOB_SCRIPT_H
#include "common/str.h"
#include "common/stack.h"
#include "gob/totfile.h"
namespace Gob {
class GobEngine;
class Expression;
class Script {
public:
Script(GobEngine *vm);
~Script();
/** Read data and move the pointer accordingly. */
uint32 read(byte *data, int32 size);
/** Read data (from an optional offset) without moving the pointer. */
uint32 peek(byte *data, int32 size, int32 offset = 0) const;
// Stream properties
int32 pos() const;
int32 getSize() const;
// Stream seeking
bool seek(int32 offset, int whence = SEEK_SET);
bool skip(int32 offset);
bool skipBlock();
// Reading data
byte readByte ();
char readChar ();
uint8 readUint8 ();
uint16 readUint16();
uint32 readUint32();
int8 readInt8 ();
int16 readInt16 ();
int32 readInt32 ();
char *readString(int32 length = -1);
// Peeking data
byte peekByte (int32 offset = 0);
char peekChar (int32 offset = 0);
uint8 peekUint8 (int32 offset = 0);
uint16 peekUint16(int32 offset = 0);
uint32 peekUint32(int32 offset = 0);
int8 peekInt8 (int32 offset = 0);
int16 peekInt16 (int32 offset = 0);
int32 peekInt32 (int32 offset = 0);
char *peekString(int32 offset = 0);
// Expression parsing functions
int16 readVarIndex(uint16 *size = 0, uint16 *type = 0);
int16 readValExpr(byte stopToken = 99);
int16 readExpr(byte stopToken, byte *type);
void skipExpr(char stopToken);
// Higher-level expression parsing functions
char evalExpr(int16 *pRes);
bool evalBool();
int32 evalInt();
const char *evalString();
// Accessing the result of expressions
int32 getResultInt() const;
char *getResultStr() const;
/** Returns the offset the specified pointer is within the script data. */
int32 getOffset(byte *ptr) const;
/** Returns the data pointer to the offset. */
byte *getData(int32 offset) const;
/** Returns the raw data pointer. */
byte *getData();
/** Load a script file. */
bool load(const Common::String &fileName);
/** Unload the script. */
void unload();
/** Was a script loaded? */
bool isLoaded() const;
/** Setting the 'finished' property. */
void setFinished(bool finished);
/** Querying the 'finished' property. */
bool isFinished() const;
// Call stack operations
/** Push the current script position onto the call stack. */
void push();
/** Pop a script position from the call stack (and return there). */
void pop(bool ret = true);
/** Push the current script position and branch to the specified offset. */
void call(uint32 offset);
// Fixed properties
uint8 getVersionMajor () const;
uint8 getVersionMinor () const;
uint32 getVariablesCount () const;
uint32 getTextsOffset () const;
uint32 getResourcesOffset() const;
uint16 getAnimDataSize () const;
uint8 getImFileNumber () const;
uint8 getExFileNumber () const;
uint8 getCommunHandling () const;
uint16 getFunctionOffset (uint8 function) const;
static uint32 getVariablesCount(const char *fileName, GobEngine *vm);
private:
struct CallEntry {
byte *totPtr;
bool finished;
};
GobEngine *_vm;
Expression *_expression;
bool _finished;
Common::String _totFile;
byte *_totData;
byte *_totPtr;
uint32 _totSize;
Common::SeekableReadStream *_lom;
TOTFile::Properties _totProperties;
Common::Stack<CallEntry> _callStack;
/** Loading a TOT file. */
bool loadTOT(const Common::String &fileName);
/** Loading a LOM file. */
bool loadLOM(const Common::String &fileName);
/** Unloading a TOT file. */
void unloadTOT();
};
} // End of namespace Gob
#endif // GOB_SCRIPT_H
|
