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
|
/* 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.
*
*/
#ifndef GARGOYLE_GARGOLE_H
#define GARGOYLE_GARGOLE_H
#include "common/scummsys.h"
#include "common/random.h"
#include "common/system.h"
#include "common/serializer.h"
#include "engines/advancedDetector.h"
#include "engines/engine.h"
#include "gargoyle/glk_types.h"
namespace Gargoyle {
class Clipboard;
class Conf;
class Events;
class PicList;
class Screen;
class Selection;
class Streams;
class Windows;
enum InterpreterType {
INTERPRETER_ADVSYS = 0,
INTERPRETER_AGILITY = 1,
INTERPRETER_ALAN2 = 2,
INTERPRETER_ALAN3 = 3,
INTERPRETER_BOCFEL = 4,
INTERPRETER_FROTZ = 5,
INTERPRETER_GEAS = 6,
INTERPRETER_HUGO = 7,
INTERPRETER_JACL = 8,
INTERPRETER_LEVEL9 = 9,
INTERPRETER_MAGNETIC = 10,
INTERPRETER_NITFOL = 11,
INTERPRETER_SCARE = 12,
INTERPRETER_SCOTT = 13,
INTERPRETER_TADS = 14
};
enum GargoyleDebugChannels {
kDebugCore = 1 << 0,
kDebugScripts = 1 << 1,
kDebugGraphics = 1 << 2,
kDebugSound = 1 << 3
};
#define GARGOYLE_SAVEGAME_VERSION 1
struct GargoyleGameDescription;
/**
* Base class for the different interpreters
*/
class GargoyleEngine : public Engine {
private:
/**
* Handles basic initialization
*/
void initialize();
/**
* Setup the video mode
*/
void initGraphicsMode();
protected:
const GargoyleGameDescription *_gameDescription;
Common::RandomSource _random;
int _loadSaveSlot;
// Engine APIs
virtual Common::Error run();
/**
* Returns true whether a given feature is supported by the engine
*/
virtual bool hasFeature(EngineFeature f) const;
/**
* Main game loop for the individual interpreters
*/
virtual void runGame(Common::SeekableReadStream *gameFile) = 0;
public:
Clipboard *_clipboard;
Conf *_conf;
Events *_events;
PicList *_picList;
Screen *_screen;
Selection *_selection;
Streams *_streams;
Windows *_windows;
bool _copySelect;
bool _terminated;
void (*gli_unregister_obj)(void *obj, glui32 objclass, gidispatch_rock_t objrock);
gidispatch_rock_t (*gli_register_arr)(void *array, glui32 len, const char *typecode);
void (*gli_unregister_arr)(void *array, glui32 len, const char *typecode, gidispatch_rock_t objrock);
public:
GargoyleEngine(OSystem *syst, const GargoyleGameDescription *gameDesc);
virtual ~GargoyleEngine();
/**
* Returns true if a savegame can be loaded
*/
virtual bool canLoadGameStateCurrently() override {
return true;
}
/**
* Returns true if the game can be saved
*/
virtual bool canSaveGameStateCurrently() override {
return true;
}
/**
* Returns the bitset of game features
*/
uint32 getFeatures() const;
/**
* Returns whether the game is a demo
*/
bool isDemo() const;
/**
* Returns the language
*/
Common::Language getLanguage() const;
/**
* Returns the running interpreter type
*/
InterpreterType getInterpreterType() const;
/**
* Returns the game's md5
*/
const Common::String &getGameMD5() const;
/**
* Returns the primary filename for the game
*/
const Common::String &GargoyleEngine::getFilename() const;
/**
* Return the game engine's target name
*/
const Common::String &getTargetName() const {
return _targetName;
}
/**
* Display a message in a GUI dialog
*/
void GUIError(const char *msg, ...);
};
extern GargoyleEngine *g_vm;
} // End of namespace Gargoyle
#endif
|
