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
|
/* 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_H
#define SCI_H
#include "engines/engine.h"
#include "engines/advancedDetector.h"
namespace Sci {
class Console;
struct EngineState;
class Kernel;
class Vocabulary;
class ResourceManager;
// our engine debug levels
enum kDebugLevels {
kDebugLevelError = 1 << 0,
kDebugLevelNodes = 1 << 1,
kDebugLevelGraphics = 1 << 2,
kDebugLevelStrings = 1 << 3,
kDebugLevelMemory = 1 << 4,
kDebugLevelFuncCheck = 1 << 5,
kDebugLevelBresen = 1 << 6,
kDebugLevelSound = 1 << 7,
kDebugLevelGfxDriver = 1 << 8,
kDebugLevelBaseSetter = 1 << 9,
kDebugLevelParser = 1 << 10,
kDebugLevelMenu = 1 << 11,
kDebugLevelSaid = 1 << 12,
kDebugLevelFile = 1 << 13,
kDebugLevelTime = 1 << 14,
kDebugLevelRoom = 1 << 15,
kDebugLevelAvoidPath = 1 << 16,
kDebugLevelDclInflate = 1 << 17,
kDebugLevelVM = 1 << 18,
kDebugLevelScripts = 1 << 19,
kDebugLevelGC = 1 << 20
};
struct SciGameDescription {
ADGameDescription desc;
uint32 flags;
};
extern const char *versionNames[];
enum SciGameFlags {
// SCI0 flags
/* Applies to all versions before 0.000.629
* Older SCI versions had simpler code for GetTime()
*/
GF_SCI0_OLDGETTIME = (1 << 0)
};
/** SCI versions */
enum SciVersion {
SCI_VERSION_AUTODETECT,
SCI_VERSION_0_EARLY, // Early KQ4, 1988 xmas card
SCI_VERSION_0_LATE, // KQ4, LSL2, LSL3, SQ3 etc
SCI_VERSION_01, // KQ1 and multilingual games (S.old.*)
SCI_VERSION_1_EGA, // EGA with parser, QFG2
SCI_VERSION_1_EARLY, // KQ5. (EGA/VGA)
SCI_VERSION_1_MIDDLE, // LSL1, JONESCD. (EGA?/VGA)
SCI_VERSION_1_LATE, // ECO1, LSL5. (EGA/VGA)
SCI_VERSION_1_1, // KQ6, ECO2
SCI_VERSION_2, // GK1, PQ4 (Floppy), QFG4 (Floppy)
SCI_VERSION_2_1, // GK2, KQ7, SQ6, Torin
SCI_VERSION_3 // LSL7, RAMA, Lighthouse
};
class SciEngine : public Engine {
friend class Console;
public:
SciEngine(OSystem *syst, const SciGameDescription *desc);
~SciEngine();
// Engine APIs
virtual Common::Error run();
void pauseEngineIntern(bool pause);
virtual GUI::Debugger *getDebugger();
Console *getSciDebugger();
const char* getGameID() const;
int getResourceVersion() const;
SciVersion getVersion() const;
Common::Language getLanguage() const;
Common::Platform getPlatform() const;
uint32 getFlags() const;
ResourceManager *getresourceManager() const { return _resourceManager; }
Kernel *getKernel() const { return _kernel; }
Vocabulary *getVocabulary() const { return _vocabulary; }
Common::String getSavegameName(int nr) const;
Common::String getSavegamePattern() const;
/** Prepend 'TARGET-' to the given filename. */
Common::String wrapFilename(const Common::String &name) const;
/** Remove the 'TARGET-' prefix of the given filename, if present. */
Common::String unwrapFilename(const Common::String &name) const;
Common::String getSciVersionDesc(SciVersion version) const;
private:
const SciGameDescription *_gameDescription;
ResourceManager *_resourceManager;
EngineState *_gamestate;
Kernel *_kernel;
Vocabulary *_vocabulary;
Console *_console;
};
} // End of namespace Sci
#endif // SCI_H
|
