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
|
/* 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"
#include "common/str-array.h"
namespace Common {
class SeekableReadStream;
class WriteStream;
}
#include "sci/sci.h"
#include "sci/engine/seg_manager.h"
#include "sci/parser/vocabulary.h"
#ifdef USE_OLD_MUSIC_FUNCTIONS
#include "sci/sound/iterator/core.h"
#endif
#include "sci/sound/soundcmd.h"
namespace Sci {
class SciEvent;
class MessageState;
class SoundCommandParser;
class DirSeeker {
protected:
reg_t _outbuffer;
Common::StringArray _savefiles;
Common::StringArray::const_iterator _iter;
public:
DirSeeker() {
_outbuffer = NULL_REG;
_iter = _savefiles.begin();
}
reg_t firstFile(const Common::String &mask, reg_t buffer, SegManager *segMan);
reg_t nextFile(SegManager *segMan);
};
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
};
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(Vocabulary *voc, SegManager *segMan);
virtual ~EngineState();
virtual void saveLoadWithSerializer(Common::Serializer &ser);
public:
SegManager *_segMan; /**< The segment manager */
Vocabulary *_voc;
Common::String _gameId; /**< Designation of the primary object (which inherits from Game) */
/* Non-VM information */
SciEvent *_event; // Event handling
#ifdef USE_OLD_MUSIC_FUNCTIONS
SfxState _sound; /**< sound subsystem */
int sfx_init_flags; /**< flags the sfx subsystem was initialised with */
#endif
SoundCommandParser *_soundCmd;
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() */
void wait(int16 ticks);
uint32 _throttleCounter; /**< total times kAnimate was invoked */
uint32 _throttleLastTime; /**< last time kAnimate was invoked */
bool _throttleTrigger;
/* Kernel File IO stuff */
Common::Array<FileHandle> _fileHandles; /**< Array of file handles. Dynamically increased if required. */
DirSeeker _dirseeker;
public:
/* 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 */
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);
/* Debugger data: */
Common::List<Breakpoint> _breakpoints; /**< List of breakpoints */
int _activeBreakpointTypes; /**< Bit mask specifying which types of breakpoints are active */
/* System strings */
SegmentId sys_strings_segment;
SystemStrings *sys_strings;
reg_t _gameObj; /**< Pointer to the game object */
int gc_countdown; /**< Number of kernel calls until next gc */
public:
MessageState *_msgState;
// MemorySegment provides access to a 256-byte block of memory that remains
// intact across restarts and restores
enum {
kMemorySegmentMax = 256
};
uint _memorySegmentSize;
byte _memorySegment[kMemorySegmentMax];
EngineState *successor; /**< Successor of this state: Used for restoring */
};
} // End of namespace Sci
#endif // SCI_INCLUDE_ENGINE_H
|
