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
|
/* 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 SCI_INCLUDE_ENGINE_H
#define SCI_INCLUDE_ENGINE_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/serializer.h"
namespace Common {
class SeekableReadStream;
class WriteStream;
}
#include "sci/sci.h"
#include "sci/vocabulary.h"
#include "sci/resource.h"
#include "sci/engine/kernel.h" // for kfunct_sig_pair_t
#include "sci/engine/script.h"
#include "sci/engine/seg_manager.h"
#include "sci/sound/audio.h"
#ifdef USE_OLD_MUSIC_FUNCTIONS
#include "sci/sound/iterator/core.h"
#endif
#include "sci/sound/soundcmd.h"
namespace Sci {
class SciEvent;
class Menubar;
class SciGui;
class Cursor;
class MessageState;
class SoundCommandParser;
struct GfxState;
struct GfxPort;
struct GfxVisual;
struct GfxContainer;
struct GfxList;
class DirSeeker {
protected:
EngineState *_state;
reg_t _outbuffer;
Common::StringList _savefiles;
Common::StringList::const_iterator _iter;
public:
DirSeeker(EngineState *s) : _state(s) {
_outbuffer = NULL_REG;
_iter = _savefiles.begin();
}
reg_t firstFile(const Common::String &mask, reg_t buffer);
reg_t nextFile();
};
enum {
MAX_SAVE_DIR_SIZE = MAXPATHLEN
};
/** values for EngineState.restarting_flag */
enum {
SCI_GAME_IS_NOT_RESTARTING = 0,
SCI_GAME_WAS_RESTARTED = 1,
SCI_GAME_IS_RESTARTING_NOW = 2,
SCI_GAME_WAS_RESTARTED_AT_LEAST_ONCE = 4
};
/** Supported languages */
enum kLanguage {
K_LANG_NONE = 0,
K_LANG_ENGLISH = 1,
K_LANG_FRENCH = 33,
K_LANG_SPANISH = 34,
K_LANG_ITALIAN = 39,
K_LANG_GERMAN = 49,
K_LANG_JAPANESE = 81,
K_LANG_PORTUGUESE = 351
};
enum FeatureDetection {
kDetectGfxFunctions = 0,
kDetectMoveCountType = 1,
kDetectSoundType = 2,
kDetectSetCursorType = 3,
kDetectLofsType = 4
};
class FileHandle {
public:
Common::String _name;
Common::SeekableReadStream *_in;
Common::WriteStream *_out;
public:
FileHandle();
~FileHandle();
void close();
bool isOpen() const;
};
struct EngineState : public Common::Serializable {
public:
EngineState(ResourceManager *res, Kernel *kernel, Vocabulary *voc, SegManager *segMan, SciGui *gui, AudioPlayer *audio);
virtual ~EngineState();
virtual void saveLoadWithSerializer(Common::Serializer &ser);
kLanguage getLanguage();
public:
ResourceManager *resMan; /**< The resource manager */
Kernel *_kernel;
Vocabulary *_voc;
Common::String _gameId; /**< Designation of the primary object (which inherits from Game) */
/* Non-VM information */
SciGui *_gui; /* Currently active Gui */
SciEvent *_event; // Event handling
AudioPlayer *_audio;
#ifdef USE_OLD_MUSIC_FUNCTIONS
SfxState _sound; /**< sound subsystem */
#endif
SoundCommandParser *_soundCmd;
int sfx_init_flags; /**< flags the sfx subsystem was initialised with */
byte restarting_flags; /**< Flags used for restarting */
uint32 game_start_time; /**< The time at which the interpreter was started */
uint32 last_wait_time; /**< The last time the game invoked Wait() */
uint32 _lastAnimateCounter; /**< total times kAnimate was invoked */
uint32 _lastAnimateTime; /**< last time kAnimate was invoked */
/* Kernel File IO stuff */
Common::Array<FileHandle> _fileHandles; /**< Array of file handles. Dynamically increased if required. */
DirSeeker _dirseeker;
/* Parser data: */
reg_t parser_base; /**< Base address for the parser error reporting mechanism */
reg_t parser_event; /**< The event passed to Parse() and later used by Said() */
bool parserIsValid; /**< If something has been correctly parsed */
/* VM Information */
Common::List<ExecStack> _executionStack; /**< The execution stack */
/**
* When called from kernel functions, the vm is re-started recursively on
* the same stack. This variable contains the stack base for the current vm.
*/
int execution_stack_base;
bool _executionStackPosChanged; /**< Set to true if the execution stack position should be re-evaluated by the vm */
reg_t r_acc; /**< Accumulator */
int16 restAdjust; /**< &rest register (only used for save games) */
reg_t r_prev; /**< previous comparison result */
SegmentId stack_segment; /**< Heap area for the stack to use */
StackPtr stack_base; /**< Pointer to the least stack element */
StackPtr stack_top; /**< First invalid stack element */
Script *script_000; /**< script 000, e.g. for globals */
uint16 currentRoomNumber() const;
void setRoomNumber(uint16 roomNumber);
/**
* Processes a multilanguage string based on the current language settings and
* returns a string that is ready to be displayed.
* @param str the multilanguage string
* @param sep optional seperator between main language and subtitle language,
* if NULL is passed no subtitle will be added to the returned string
* @return processed string
*/
Common::String strSplit(const char *str, const char *sep = "\r----------\r");
/**
* Autodetects the DoSound type
* @return DoSound type, SCI_VERSION_0_EARLY / SCI_VERSION_0_LATE /
* SCI_VERSION_1_EARLY / SCI_VERSION_1_LATE
*/
SciVersion detectDoSoundType();
/**
* Autodetects the SetCursor type
* @return SetCursor type, SCI_VERSION_0_EARLY / SCI_VERSION_1_1
*/
SciVersion detectSetCursorType();
/**
* Autodetects the Lofs type
* @return Lofs type, SCI_VERSION_0_EARLY / SCI_VERSION_1_MIDDLE / SCI_VERSION_1_1
*/
SciVersion detectLofsType();
/**
* Autodetects the graphics functions used
* @return Graphics functions type, SCI_VERSION_0_EARLY / SCI_VERSION_0_LATE
*/
SciVersion detectGfxFunctionsType();
/**
* Applies to all versions before 0.000.502
* Old SCI versions used to interpret the third DrawPic() parameter inversely,
* with the opposite default value (obviously).
* Also, they used 15 priority zones from 42 to 200 instead of 14 priority
* zones from 42 to 190.
*/
bool usesOldGfxFunctions() { return detectGfxFunctionsType() == SCI_VERSION_0_EARLY; }
/**
* Autodetects the Bresenham routine used in the actor movement functions
* @return Move count type, kIncrementMoveCnt / kIgnoreMoveCnt
*/
MoveCountType detectMoveCountType();
bool handleMoveCount() { return detectMoveCountType() == kIncrementMoveCount; }
bool usesCdTrack() { return _usesCdTrack; }
/* Debugger data: */
Breakpoint *bp_list; /**< List of breakpoints */
int have_bp; /**< Bit mask specifying which types of breakpoints are used in bp_list */
/* System strings */
SegmentId sys_strings_segment;
SystemStrings *sys_strings;
reg_t _gameObj; /**< Pointer to the game object */
SegManager *_segMan;
int gc_countdown; /**< Number of kernel calls until next gc */
MessageState *_msgState;
EngineState *successor; /**< Successor of this state: Used for restoring */
Common::String getLanguageString(const char *str, kLanguage lang) const;
private:
bool autoDetectFeature(FeatureDetection featureDetection, int methodNum = -1);
SciVersion _doSoundType, _setCursorType, _lofsType, _gfxFunctionsType;
MoveCountType _moveCountType;
kLanguage charToLanguage(const char c) const;
bool _usesCdTrack;
};
} // End of namespace Sci
#endif // SCI_INCLUDE_ENGINE_H
|