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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2002-2006 The ScummVM project
*
* 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 BASE_ENGINE_H
#define BASE_ENGINE_H
#include "common/stdafx.h"
#include "common/scummsys.h"
#include "common/str.h"
class OSystem;
namespace Audio {
class Mixer;
}
namespace Common {
class EventManager;
class SaveFileManager;
class TimerManager;
}
namespace GUI {
class Debugger;
}
class Engine {
public:
OSystem *_system;
Audio::Mixer *_mixer;
Common::TimerManager * _timer;
protected:
Common::EventManager *_eventMan;
Common::SaveFileManager *_saveFileMan;
const Common::String _targetName; // target name for saves
const Common::String _gameDataPath;
private:
int _autosavePeriod;
public:
Engine(OSystem *syst);
virtual ~Engine();
/**
* Init the engine.
* @return 0 for success, else an error code.
*/
virtual int init() = 0;
/**
* Start the main engine loop.
* The return value is not yet used, but could indicate whether the user
* wants to return to the launch or to fully quit ScummVM.
* @return a result code
*/
virtual int go() = 0;
/** Specific for each engine: prepare error string. */
virtual void errorString(const char *buf_input, char *buf_output);
void initCommonGFX(bool defaultTo1XScaler);
/** On some systems, check if the game appears to be run from CD. */
void checkCD();
/* Indicate if an autosave should be performed. */
bool shouldPerformAutoSave(int lastSaveTime);
/** Initialized graphics and shows error message. */
void GUIErrorMessage(const Common::String msg);
/**
* Return the engine's debugger instance, if any. Used by error() to
* invoke the debugger when a severe error is reported.
*/
virtual GUI::Debugger *getDebugger() { return 0; }
};
extern Engine *g_engine;
#endif
|
