aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/kernel/kernel.cpp
blob: 78181bc4d328985f64e49e6c33f6946bc358fb86 (plain)
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/* 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$
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#include "common/system.h"
#include "sword25/gfx/graphicengine.h"
#ifdef USE_THEORADEC
#include "sword25/fmv/movieplayer.h"
#endif
#include "sword25/input/inputengine.h"
#include "sword25/kernel/kernel.h"
#include "sword25/kernel/persistenceservice.h"
#include "sword25/kernel/service_ids.h"
#include "sword25/package/packagemanager.h"
#include "sword25/script/script.h"
#include "sword25/sfx/soundengine.h"

namespace Sword25 {

#define BS_LOG_PREFIX "KERNEL"

Kernel *Kernel::_Instance = 0;

Kernel::Kernel() :
	_pWindow(NULL),
	_Running(false),
	_pResourceManager(NULL),
	_InitSuccess(false) {

	// Log that the kernel is beign created
	BS_LOGLN("created.");

	// Read the BS_SERVICE_TABLE and prepare kernel structures
	for (uint i = 0; i < BS_SERVICE_COUNT; i++) {
		// Is the superclass already registered?
		Superclass *pCurSuperclass = NULL;
		Common::Array<Superclass *>::iterator Iter;
		for (Iter = _SuperclassList.begin(); Iter != _SuperclassList.end(); ++Iter)
			if ((*Iter)->GetIdentifier() == BS_SERVICE_TABLE[i].SuperclassIdentifier) {
				pCurSuperclass = *Iter;
				break;
			}

		// If the superclass isn't already registered, then add it in
		if (!pCurSuperclass)
			_SuperclassList.push_back(new Superclass(this, BS_SERVICE_TABLE[i].SuperclassIdentifier));
	}

	// Create window object
	_pWindow = Window::CreateBSWindow(0, 0, 0, 0, false);
	if (!_pWindow) {
		BS_LOG_ERRORLN("Failed to create the window.");
	} else
		BS_LOGLN("Window created.");

	// Create the resource manager
	_pResourceManager = new ResourceManager(this);

	// Initialise the script engine
	ScriptEngine *pScript = static_cast<ScriptEngine *>(NewService("script", "lua"));
	if (!pScript || !pScript->init()) {
		_InitSuccess = false;
		return;
	}

	// Register kernel script bindings
	if (!_RegisterScriptBindings()) {
		BS_LOG_ERRORLN("Script bindings could not be registered.");
		_InitSuccess = false;
		return;
	}
	BS_LOGLN("Script bindings registered.");

	_InitSuccess = true;
}

Kernel::~Kernel() {
	// Services are de-registered in reverse order of creation
	while (!_ServiceCreationOrder.empty()) {
		Superclass *superclass = GetSuperclassByIdentifier(_ServiceCreationOrder.top());
		if (superclass) superclass->DisconnectService();
		_ServiceCreationOrder.pop();
	}

	// Empty the Superclass list
	while (_SuperclassList.size()) {
		delete _SuperclassList.back();
		_SuperclassList.pop_back();
	}

	// Release the window object
	delete _pWindow;
	BS_LOGLN("Window destroyed.");

	// Resource-Manager freigeben
	delete _pResourceManager;

	BS_LOGLN("destroyed.");
}

// Service Methoden
// ----------------

Kernel::Superclass::Superclass(Kernel *pKernel, const Common::String &Identifier) :
	_pKernel(pKernel),
	_Identifier(Identifier),
	_ServiceCount(0),
	_ActiveService(NULL) {
	for (uint i = 0; i < BS_SERVICE_COUNT; i++)
		if (BS_SERVICE_TABLE[i].SuperclassIdentifier == _Identifier)
			_ServiceCount++;
}

Kernel::Superclass::~Superclass() {
	DisconnectService();
}

/**
 * Gets the identifier of a service with a given superclass.
 * The number of services in a superclass can be learned with GetServiceCount().
 * @param SuperclassIdentifier      The name of the superclass
 *         z.B: "sfx", "gfx", "package" ...
 * @param Number die Nummer des Services, dessen Bezeichner man erfahren will.<br>
 *         Hierbei ist zu beachten, dass der erste Service die Nummer 0 erh�lt. Number muss also eine Zahl zwischen
 *         0 und GetServiceCount() - 1 sein.
 */
Common::String Kernel::Superclass::GetServiceIdentifier(uint Number) {
	if (Number > _ServiceCount) return NULL;

	uint CurServiceOrd = 0;
	for (uint i = 0; i < BS_SERVICE_COUNT; i++) {
		if (BS_SERVICE_TABLE[i].SuperclassIdentifier == _Identifier) {
			if (Number == CurServiceOrd)
				return BS_SERVICE_TABLE[i].ServiceIdentifier;
			else
				CurServiceOrd++;
		}
	}

	return Common::String("");
}

/**
 * Creates a new service with the given identifier. Returns a pointer to the service, or null if the
 * service could not be created
 * Note: All services must be registered in service_ids.h, otherwise they cannot be created here
 * @param SuperclassIdentifier      The name of the superclass of the service
 *         z.B: "sfx", "gfx", "package" ...
 * @param ServiceIdentifier         The name of the service
 *         For the superclass "sfx" an example could be "Fmod" or "directsound"
 */
Service *Kernel::Superclass::NewService(const Common::String &ServiceIdentifier) {
	for (uint i = 0; i < BS_SERVICE_COUNT; i++)
		if (BS_SERVICE_TABLE[i].SuperclassIdentifier == _Identifier &&
		        BS_SERVICE_TABLE[i].ServiceIdentifier == ServiceIdentifier) {
			Service *NewService_ = BS_SERVICE_TABLE[i].CreateMethod(_pKernel);

			if (NewService_) {
				DisconnectService();
				BS_LOGLN("Service '%s' created from superclass '%s'.", ServiceIdentifier.c_str(), _Identifier.c_str());
				_ActiveService = NewService_;
				_ActiveServiceName = BS_SERVICE_TABLE[i].ServiceIdentifier;
				return _ActiveService;
			} else {
				BS_LOG_ERRORLN("Failed to create service '%s' from superclass '%s'.", ServiceIdentifier.c_str(), _Identifier.c_str());
				return NULL;
			}
		}

	BS_LOG_ERRORLN("Service '%s' is not avaliable from superclass '%s'.", ServiceIdentifier.c_str(), _Identifier.c_str());
	return NULL;
}

/**
 * Ends the current service of a superclass. Returns true on success, and false if the superclass
 * does not exist or if not service was active
 * @param SuperclassIdentfier       The name of the superclass which is to be disconnected
 *         z.B: "sfx", "gfx", "package" ...
 */
bool Kernel::Superclass::DisconnectService() {
	if (_ActiveService) {
		delete _ActiveService;
		_ActiveService = 0;
		BS_LOGLN("Active service '%s' disconnected from superclass '%s'.", _ActiveServiceName.c_str(), _Identifier.c_str());
		return true;
	}

	return false;
}

Kernel::Superclass *Kernel::GetSuperclassByIdentifier(const Common::String &Identifier) {
	Common::Array<Superclass *>::iterator Iter;
	for (Iter = _SuperclassList.begin(); Iter != _SuperclassList.end(); ++Iter) {
		if ((*Iter)->GetIdentifier() == Identifier)
			return *Iter;
	}

	// BS_LOG_ERRORLN("Superclass '%s' does not exist.", Identifier.c_str());
	return NULL;
}

/**
 * Returns the number of register superclasses
 */
uint Kernel::GetSuperclassCount() {
	return _SuperclassList.size();
}

/**
 * Returns the name of a superclass with the specified index.
 * Note: The number of superclasses can be retrieved using GetSuperclassCount
 * @param Number        The number of the superclass to return the identifier for.
 * It should be noted that the number should be between 0 und GetSuperclassCount() - 1.
 */
Common::String Kernel::GetSuperclassIdentifier(uint Number) {
	if (Number > _SuperclassList.size()) return NULL;

	uint CurSuperclassOrd = 0;
	Common::Array<Superclass *>::iterator Iter;
	for (Iter = _SuperclassList.begin(); Iter != _SuperclassList.end(); ++Iter) {
		if (CurSuperclassOrd == Number)
			return ((*Iter)->GetIdentifier());

		CurSuperclassOrd++;
	}

	return Common::String("");
}

/**
 * Returns the number of services registered with a given superclass
 * @param SuperclassIdentifier      The name of the superclass
 *         z.B: "sfx", "gfx", "package" ...
 */
uint Kernel::GetServiceCount(const Common::String &SuperclassIdentifier) {
	Superclass *pSuperclass;
	if (!(pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier)))
		return 0;

	return pSuperclass->GetServiceCount();

}

/**
 * Gets the identifier of a service with a given superclass.
 * The number of services in a superclass can be learned with GetServiceCount().
 * @param SuperclassIdentifier      The name of the superclass
 *         z.B: "sfx", "gfx", "package" ...
 * @param Number die Nummer des Services, dessen Bezeichner man erfahren will.<br>
 *         Hierbei ist zu beachten, dass der erste Service die Nummer 0 erh�lt. Number muss also eine Zahl zwischen
 *         0 und GetServiceCount() - 1 sein.
 */
Common::String Kernel::GetServiceIdentifier(const Common::String &SuperclassIdentifier, uint Number) {
	Superclass *pSuperclass;
	if (!(pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier))) return NULL;

	return (pSuperclass->GetServiceIdentifier(Number));
}

/**
 * Creates a new service with the given identifier. Returns a pointer to the service, or null if the
 * service could not be created
 * Note: All services must be registered in service_ids.h, otherwise they cannot be created here
 * @param SuperclassIdentifier      The name of the superclass of the service
 *         z.B: "sfx", "gfx", "package" ...
 * @param ServiceIdentifier         The name of the service
 *         For the superclass "sfx" an example could be "Fmod" or "directsound"
 */
Service *Kernel::NewService(const Common::String &SuperclassIdentifier, const Common::String &ServiceIdentifier) {
	Superclass *pSuperclass;
	if (!(pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier))) return NULL;

	// Die Reihenfolge merken, in der Services erstellt werden, damit sie sp�ter in umgekehrter Reihenfolge entladen werden k�nnen.
	_ServiceCreationOrder.push(SuperclassIdentifier);

	return pSuperclass->NewService(ServiceIdentifier);
}

/**
 * Ends the current service of a superclass. Returns true on success, and false if the superclass
 * does not exist or if not service was active
 * @param SuperclassIdentfier       The name of the superclass which is to be disconnected
 *         z.B: "sfx", "gfx", "package" ...
 */
bool Kernel::DisconnectService(const Common::String &SuperclassIdentifier) {
	Superclass *pSuperclass;
	if (!(pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier))) return false;

	return pSuperclass->DisconnectService();
}

/**
 * Returns a pointer to the currently active service object of a superclass
 * @param SuperclassIdentfier       The name of the superclass
 *         z.B: "sfx", "gfx", "package" ...
 */
Service *Kernel::GetService(const Common::String &SuperclassIdentifier) {
	Superclass *pSuperclass;
	if (!(pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier))) return NULL;

	return (pSuperclass->GetActiveService());
}

/**
 * Returns the name of the currentl active service object of a superclass.
 * If an error occurs, then an empty string is returned
 * @param SuperclassIdentfier       The name of the superclass
 *         z.B: "sfx", "gfx", "package" ...
 */
Common::String Kernel::GetActiveServiceIdentifier(const Common::String &SuperclassIdentifier) {
	Superclass *pSuperclass = GetSuperclassByIdentifier(SuperclassIdentifier);
	if (!pSuperclass) return Common::String("");

	return (pSuperclass->GetActiveServiceName());
}

// -----------------------------------------------------------------------------

/**
 * Returns a random number
 * @param Min       The minimum allowed value
 * @param Max       The maximum allowed value
 */
int Kernel::GetRandomNumber(int Min, int Max) {
	BS_ASSERT(Min <= Max);

	return Min + _rnd.getRandomNumber(Max - Min + 1);
}

/**
 * Returns the elapsed time since startup in milliseconds
 */
uint Kernel::GetMilliTicks() {
	return g_system->getMillis();
}

// Other methods
// -----------------

/**
 * Returns how much memory is being used
 */
size_t Kernel::GetUsedMemory() {
	return 0;

#ifdef SCUMMVM_DISABLED_CODE
	PROCESS_MEMORY_COUNTERS pmc;
	pmc.cb = sizeof(pmc);
	if (GetProcessMemoryInfo(GetCurrentProcess(), &pmc, sizeof(pmc))) {
		return pmc.WorkingSetSize;
	} else {
		BS_LOG_ERRORLN("Call to GetProcessMemoryInfo() failed. Error code: %d", GetLastError());
		return 0;
	}
#endif
}

// -----------------------------------------------------------------------------

/**
 * Returns a pointer to the active Gfx Service, or NULL if no Gfx service is active
 */
GraphicEngine *Kernel::GetGfx() {
	return static_cast<GraphicEngine *>(GetService("gfx"));
}

// -----------------------------------------------------------------------------

/**
 * Returns a pointer to the active Sfx Service, or NULL if no Sfx service is active
 */
SoundEngine *Kernel::GetSfx() {
	return static_cast<SoundEngine *>(GetService("sfx"));
}

// -----------------------------------------------------------------------------

/**
 * Returns a pointer to the active input service, or NULL if no input service is active
 */
InputEngine *Kernel::GetInput() {
	return static_cast<InputEngine *>(GetService("input"));
}

// -----------------------------------------------------------------------------

/**
 * Returns a pointer to the active package manager, or NULL if no manager is active
 */
PackageManager *Kernel::GetPackage() {
	return static_cast<PackageManager *>(GetService("package"));
}

// -----------------------------------------------------------------------------

/**
 * Returns a pointer to the script engine, or NULL if it is not active
 */
ScriptEngine *Kernel::GetScript() {
	return static_cast<ScriptEngine *>(GetService("script"));
}

// -----------------------------------------------------------------------------

#ifdef USE_THEORADEC
/**
 * Returns a pointer to the movie player, or NULL if it is not active
 */
MoviePlayer *Kernel::GetFMV() {
	return static_cast<MoviePlayer *>(GetService("fmv"));
}
#endif

// -----------------------------------------------------------------------------

void Kernel::Sleep(uint Msecs) const {
	g_system->delayMillis(Msecs);
}

} // End of namespace Sword25