Moved base/engine.cpp and .h to engines/ (main motivation: helps untangle the linker dependency graph). Porters will have to update project files

svn-id: r23974

6 files changed, 3 insertions, 385 deletions

diff --git a/base/commandLine.cpp b/base/commandLine.cpp
index bfa3424822..3e3d2d83ff 100644
--- a/base/commandLine.cpp
+++ b/base/commandLine.cpp
@@ -23,7 +23,7 @@
 
 #include "common/stdafx.h"
 
-#include "base/engine.h"
+#include "engines/engine.h"
 #include "base/commandLine.h"
 #include "base/plugins.h"
 #include "base/version.h"
diff --git a/base/engine.cpp b/base/engine.cpp
deleted file mode 100644
index 6c915b2954..0000000000
--- a/base/engine.cpp
+++ /dev/null
@@ -1,285 +0,0 @@
-/* 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$
- */
-
-#include "common/stdafx.h"
-#if defined(WIN32) && !defined (__SYMBIAN32__)
-#include <malloc.h>
-#endif
-#include "base/engine.h"
-#include "common/config-manager.h"
-#include "common/file.h"
-#include "common/timer.h"
-#include "common/savefile.h"
-#include "common/system.h"
-#include "sound/mixer.h"
-#include "gui/debugger.h"
-#include "gui/message.h"
-
-#ifdef _WIN32_WCE
-extern bool isSmartphone(void);
-#endif
-
-/* FIXME - BIG HACK for MidiEmu */
-Engine *g_engine = 0;
-
-Engine::Engine(OSystem *syst)
-	: _system(syst),
-		_gameDataPath(ConfMan.get("path")),
-		_targetName(ConfMan.getActiveDomainName()){
-	g_engine = this;
-	_mixer = new Audio::Mixer();
-
-	_timer = Common::g_timer;
-
-	_saveFileMan = _system->getSavefileManager();
-
-	_autosavePeriod = ConfMan.getInt("autosave_period");
-}
-
-Engine::~Engine() {
-	delete _mixer;
-	delete _saveFileMan;
-
-	g_engine = NULL;
-}
-
-void Engine::initCommonGFX(bool defaultTo1XScaler) {
-	const Common::ConfigManager::Domain *transientDomain = ConfMan.getDomain(Common::ConfigManager::kTransientDomain);
-	const Common::ConfigManager::Domain *gameDomain = ConfMan.getActiveDomain();
-
-	assert(transientDomain);
-
-	const bool useDefaultGraphicsMode =
-		!transientDomain->contains("gfx_mode") &&
-		(
-		!gameDomain ||
-		!gameDomain->contains("gfx_mode") ||
-		!scumm_stricmp(gameDomain->get("gfx_mode").c_str(), "normal") ||
-		!scumm_stricmp(gameDomain->get("gfx_mode").c_str(), "default")
-		);
-
-	// See if the game should default to 1x scaler
-	if (useDefaultGraphicsMode && defaultTo1XScaler) {
-		// FIXME: As a hack, we use "1x" here. Would be nicer to use
-		// getDefaultGraphicsMode() instead, but right now, we do not specify
-		// whether that is a 1x scaler or not...
-		_system->setGraphicsMode("1x");
-	} else {
-		// Override global scaler with any game-specific define
-		if (ConfMan.hasKey("gfx_mode")) {
-			_system->setGraphicsMode(ConfMan.get("gfx_mode").c_str());
-		}
-	}
-
-	// Note: The following code deals with the fullscreen / ASR settings. This
-	// is a bit tricky, because there are three ways the user can affect these
-	// settings: Via the config file, via the command line, and via in-game
-	// hotkeys.
-	// Any global or command line settings already have been applied at the time
-	// we get here. Hence we only do something 
-
-	// (De)activate aspect-ratio correction as determined by the config settings
-	if (gameDomain && gameDomain->contains("aspect_ratio"))
-		_system->setFeatureState(OSystem::kFeatureAspectRatioCorrection, ConfMan.getBool("aspect_ratio"));
-
-	// (De)activate fullscreen mode as determined by the config settings
-	if (gameDomain && gameDomain->contains("fullscreen"))
-		_system->setFeatureState(OSystem::kFeatureFullscreenMode, ConfMan.getBool("fullscreen"));
-}
-
-void Engine::checkCD() {
-#if defined (WIN32) && !defined(_WIN32_WCE) && !defined(__SYMBIAN32__)
-	// It is a known bug under Windows that games that play CD audio cause
-	// ScummVM to crash if the data files are read from the same CD. Check
-	// if this appears to be the case and issue a warning.
-
-	// If we can find a compressed audio track, then it should be ok even
-	// if it's running from CD.
-
-#ifdef USE_VORBIS
-	if (Common::File::exists("track1.ogg"))
-		return;
-#endif
-#ifdef USE_FLAC
-	if (Common::File::exists("track1.fla") || Common::File::exists("track1.flac"))
-		return;
-#endif
-#ifdef USE_MAD
-	if (Common::File::exists("track1.mp3"))
-		return;
-#endif
-
-	char buffer[MAXPATHLEN];
-	int i;
-
-	if (strlen(_gameDataPath.c_str()) == 0) {
-		// That's it! I give up!
-		if (getcwd(buffer, MAXPATHLEN) == NULL)
-			return;
-	} else
-		strncpy(buffer, _gameDataPath.c_str(), MAXPATHLEN);
-
-	for (i = 0; i < MAXPATHLEN - 1; i++) {
-		if (buffer[i] == '\\')
-			break;
-	}
-
-	buffer[i + 1] = 0;
-
-	if (GetDriveType(buffer) == DRIVE_CDROM) {
-		GUI::MessageDialog dialog(
-			"You appear to be playing this game directly\n"
-			"from the CD. This is known to cause problems,\n"
-			"and it's therefore recommended that you copy\n"
-			"the data files to your hard disk instead.\n"
-			"See the README file for details.", "OK");
-		dialog.runModal();
-	}
-#endif
-}
-
-bool Engine::shouldPerformAutoSave(int lastSaveTime) {
-	const int diff = _system->getMillis() - lastSaveTime;
-	return _autosavePeriod != 0 && diff > _autosavePeriod * 1000;
-}
-
-void Engine::errorString(const char *buf1, char *buf2) {
-	strcpy(buf2, buf1);
-}
-
-void NORETURN CDECL error(const char *s, ...) {
-	char buf_input[STRINGBUFLEN];
-	char buf_output[STRINGBUFLEN];
-	va_list va;
-
-	// Generate the full error message
-	va_start(va, s);
-	vsnprintf(buf_input, STRINGBUFLEN, s, va);
-	va_end(va);
-
-
-	// Next, give the active engine (if any) a chance to augment the
-	// error message
-	if (g_engine) {
-		g_engine->errorString(buf_input, buf_output);
-	} else {
-		strcpy(buf_output, buf_input);
-	}
-
-
-	// Print the error message to stderr
-#ifdef __GP32__
-	printf("ERROR: %s\n", buf_output);
-#elif !defined(_WIN32_WCE)
-	fprintf(stderr, "%s!\n", buf_output);
-#endif
-
-
-#ifndef __GP32__
-	// Unless this error -originated- within the debugger itself, we
-	// now invoke the debugger, if available / supported.
-	if (g_engine) {
-		GUI::Debugger *debugger = g_engine->getDebugger();
-#ifdef _WIN32_WCE
-		if (isSmartphone())
-			debugger = 0;
-#endif
-		if (debugger && !debugger->isAttached()) {
-			debugger->attach(buf_output);
-			debugger->onFrame();
-		}
-	}
-#endif
-
-
-#if defined( USE_WINDBG )
-#if defined( _WIN32_WCE )
-	TCHAR buf_output_unicode[1024];
-	MultiByteToWideChar(CP_ACP, 0, buf_output, strlen(buf_output) + 1, buf_output_unicode, sizeof(buf_output_unicode));
-	OutputDebugString(buf_output_unicode);
-#else
-	OutputDebugString(buf_output);
-#endif
-#endif
-
-#if defined ( _WIN32_WCE )
-	drawError(buf_output);
-#endif
-
-#ifdef PALMOS_MODE
-	PalmFatalError(buf_output);
-#endif
-
-#ifdef __SYMBIAN32__
-	Symbian::FatalError(buf_output);
-#endif
-	// Finally exit. quit() will terminate the program if g_system is present
-	if (g_system)
-		g_system->quit();
-
-	exit(1);
-}
-
-void CDECL warning(const char *s, ...) {
-	char buf[STRINGBUFLEN];
-	va_list va;
-
-	va_start(va, s);
-	vsnprintf(buf, STRINGBUFLEN, s, va);
-	va_end(va);
-
-#ifdef __GP32__ //ph0x FIXME: implement fprint?
-	printf("WARNING: %s\n", buf);
-#else
-#if !defined (_WIN32_WCE) && !defined (__SYMBIAN32__)
-	fprintf(stderr, "WARNING: %s!\n", buf);
-#endif
-#endif
-#if defined( USE_WINDBG )
-	strcat(buf, "\n");
-#if defined( _WIN32_WCE )
-	TCHAR buf_unicode[1024];
-	MultiByteToWideChar(CP_ACP, 0, buf, strlen(buf) + 1, buf_unicode, sizeof(buf_unicode));
-	OutputDebugString(buf_unicode);
-#else
-	OutputDebugString(buf);
-#endif
-#endif
-}
-
-void checkHeap() {
-#if defined(WIN32) && !defined(__SYMBIAN32__)
-	if (_heapchk() != _HEAPOK) {
-		error("Heap is invalid!");
-	}
-#endif
-}
-
-void Engine::GUIErrorMessage(const Common::String msg) {
-	_system->setWindowCaption("Error");
-	_system->beginGFXTransaction();
-		initCommonGFX(false);
-		_system->initSize(320, 200);
-	_system->endGFXTransaction();
-
-	GUI::MessageDialog dialog(msg);
-	dialog.runModal();
-}
diff --git a/base/engine.h b/base/engine.h
deleted file mode 100644
index 85798c219b..0000000000
--- a/base/engine.h
+++ /dev/null
@@ -1,96 +0,0 @@
-/* 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 SaveFileManager;
-	class TimerManager;
-}
-namespace GUI {
-	class Debugger;
-}
-
-class Engine {
-public:
-	OSystem *_system;
-	Audio::Mixer *_mixer;
-	Common::TimerManager * _timer;
-
-protected:
-	const Common::String _targetName; // target name for saves
-	const Common::String _gameDataPath;
-	Common::SaveFileManager *_saveFileMan;
-
-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
diff --git a/base/main.cpp b/base/main.cpp
index 6b626ef389..ced240973f 100644
--- a/base/main.cpp
+++ b/base/main.cpp
@@ -30,7 +30,7 @@
  */
 
 #include "common/stdafx.h"
-#include "base/engine.h"
+#include "engines/engine.h"
 #include "base/commandLine.h"
 #include "base/plugins.h"
 #include "base/version.h"
diff --git a/base/module.mk b/base/module.mk
index 9f8f31c0a3..860342eedf 100644
--- a/base/module.mk
+++ b/base/module.mk
@@ -1,7 +1,6 @@
 MODULE := base
 
 MODULE_OBJS := \
-	engine.o \
 	main.o \
 	commandLine.o \
 	plugins.o \
diff --git a/base/plugins.cpp b/base/plugins.cpp
index b222fcfcc2..6cd7448f68 100644
--- a/base/plugins.cpp
+++ b/base/plugins.cpp
@@ -23,7 +23,7 @@
 
 #include "common/stdafx.h"
 #include "base/plugins.h"
-#include "base/engine.h"
+#include "engines/engine.h"
 #include "common/util.h"
 #include "common/fs.h"