2007-05-30 21:56:52 +00:00
|
|
|
/* 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.
|
2002-04-21 17:46:42 +00:00
|
|
|
*
|
|
|
|
* 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.
|
2014-02-18 02:34:18 +01:00
|
|
|
*
|
2002-04-21 17:46:42 +00:00
|
|
|
* 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.
|
2014-02-18 02:34:18 +01:00
|
|
|
*
|
2002-04-21 17:46:42 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
2005-10-18 01:30:26 +00:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2002-04-21 17:46:42 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2003-05-29 23:13:15 +00:00
|
|
|
/*! \mainpage %ScummVM Source Reference
|
|
|
|
*
|
|
|
|
* These pages contains a cross referenced documentation for the %ScummVM source code,
|
|
|
|
* generated with Doxygen (http://www.doxygen.org) directly from the source.
|
|
|
|
* Currently not much is actually properly documented, but at least you can get an overview
|
|
|
|
* of almost all the classes, methods and variables, and how they interact.
|
|
|
|
*/
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2011-05-02 14:42:08 +02:00
|
|
|
// FIXME: Avoid using printf
|
|
|
|
#define FORBIDDEN_SYMBOL_EXCEPTION_printf
|
|
|
|
|
2006-09-23 00:42:35 +00:00
|
|
|
#include "engines/engine.h"
|
2008-05-13 09:30:23 +00:00
|
|
|
#include "engines/metaengine.h"
|
2006-05-09 14:16:43 +00:00
|
|
|
#include "base/commandLine.h"
|
2003-09-17 22:41:01 +00:00
|
|
|
#include "base/plugins.h"
|
2004-02-09 01:27:27 +00:00
|
|
|
#include "base/version.h"
|
2006-06-24 09:53:45 +00:00
|
|
|
|
2008-11-08 01:30:32 +00:00
|
|
|
#include "common/archive.h"
|
2003-10-08 21:59:23 +00:00
|
|
|
#include "common/config-manager.h"
|
2009-01-30 05:25:17 +00:00
|
|
|
#include "common/debug.h"
|
2011-02-12 10:00:52 +00:00
|
|
|
#include "common/debug-channels.h" /* for debug manager */
|
2008-07-07 22:34:45 +00:00
|
|
|
#include "common/events.h"
|
2013-05-17 00:18:09 +03:00
|
|
|
#include "gui/EventRecorder.h"
|
2006-06-24 08:07:48 +00:00
|
|
|
#include "common/fs.h"
|
2013-05-17 00:18:09 +03:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
|
|
|
#include "common/recorderfile.h"
|
|
|
|
#endif
|
2005-01-10 22:06:49 +00:00
|
|
|
#include "common/system.h"
|
2011-04-24 11:34:27 +03:00
|
|
|
#include "common/textconsole.h"
|
2010-03-20 12:56:56 +00:00
|
|
|
#include "common/tokenizer.h"
|
2010-06-15 10:44:51 +00:00
|
|
|
#include "common/translation.h"
|
2019-07-17 23:51:58 +02:00
|
|
|
#include "common/text-to-speech.h"
|
2016-10-26 23:20:30 +01:00
|
|
|
#include "common/osd_message_queue.h"
|
2009-08-18 15:32:26 +00:00
|
|
|
|
2010-11-16 10:19:01 +00:00
|
|
|
#include "gui/gui-manager.h"
|
2010-04-11 19:04:02 +00:00
|
|
|
#include "gui/error.h"
|
2002-04-12 21:26:59 +00:00
|
|
|
|
2011-02-09 01:09:01 +00:00
|
|
|
#include "audio/mididrv.h"
|
|
|
|
#include "audio/musicplugin.h" /* for music manager */
|
2009-08-18 15:32:26 +00:00
|
|
|
|
2012-03-28 19:16:29 +02:00
|
|
|
#include "graphics/cursorman.h"
|
|
|
|
#include "graphics/fontman.h"
|
2012-09-17 12:54:08 -04:00
|
|
|
#include "graphics/yuv_to_rgb.h"
|
2012-03-28 19:17:53 +02:00
|
|
|
#ifdef USE_FREETYPE2
|
|
|
|
#include "graphics/fonts/ttf.h"
|
|
|
|
#endif
|
2012-03-28 19:16:29 +02:00
|
|
|
|
2017-08-11 13:57:28 +02:00
|
|
|
#include "backends/keymapper/action.h"
|
2017-08-13 17:04:45 +02:00
|
|
|
#include "backends/keymapper/keymap.h"
|
|
|
|
#include "backends/keymapper/keymapper.h"
|
2017-08-11 13:57:28 +02:00
|
|
|
|
2016-10-17 18:45:12 +02:00
|
|
|
#ifdef USE_CLOUD
|
2016-06-01 14:07:50 +06:00
|
|
|
#ifdef USE_LIBCURL
|
2016-07-05 15:05:30 +06:00
|
|
|
#include "backends/cloud/cloudmanager.h"
|
2016-06-01 14:07:50 +06:00
|
|
|
#include "backends/networking/curl/connectionmanager.h"
|
|
|
|
#endif
|
2016-06-15 16:38:37 +06:00
|
|
|
#ifdef USE_SDL_NET
|
|
|
|
#include "backends/networking/sdl_net/localwebserver.h"
|
|
|
|
#endif
|
2016-10-17 18:45:12 +02:00
|
|
|
#endif
|
2009-05-10 22:05:04 +00:00
|
|
|
|
2019-11-10 16:34:25 +00:00
|
|
|
#if defined(__DC__)
|
2006-06-30 21:58:40 +00:00
|
|
|
#include "backends/platform/dc/DCLauncherDialog.h"
|
2006-04-02 09:56:11 +00:00
|
|
|
#else
|
|
|
|
#include "gui/launcher.h"
|
2004-08-26 21:51:26 +00:00
|
|
|
#endif
|
|
|
|
|
2016-03-30 10:58:57 +02:00
|
|
|
#ifdef USE_UPDATES
|
|
|
|
#include "gui/updates-dialog.h"
|
|
|
|
#endif
|
2006-05-04 23:24:09 +00:00
|
|
|
|
2009-01-24 18:27:09 +00:00
|
|
|
static bool launcherDialog() {
|
2005-01-08 18:37:28 +00:00
|
|
|
|
2009-01-11 12:22:29 +00:00
|
|
|
// Discard any command line options. Those that affect the graphics
|
|
|
|
// mode and the others (like bootparam etc.) should not
|
|
|
|
// blindly be passed to the first game launched from the launcher.
|
|
|
|
ConfMan.getDomain(Common::ConfigManager::kTransientDomain)->clear();
|
|
|
|
|
2019-11-10 16:34:25 +00:00
|
|
|
#if defined(__DC__)
|
2006-05-04 22:52:18 +00:00
|
|
|
DCLauncherDialog dlg;
|
2004-08-26 21:51:26 +00:00
|
|
|
#else
|
2006-05-04 22:52:18 +00:00
|
|
|
GUI::LauncherDialog dlg;
|
2004-01-26 07:32:25 +00:00
|
|
|
#endif
|
2004-12-25 22:13:44 +00:00
|
|
|
return (dlg.runModal() != -1);
|
2002-09-30 00:55:47 +00:00
|
|
|
}
|
|
|
|
|
2017-11-10 23:06:42 -06:00
|
|
|
static const Plugin *detectPlugin() {
|
2016-09-15 18:39:45 +02:00
|
|
|
// Figure out the engine ID and game ID
|
|
|
|
Common::String engineId = ConfMan.get("engineid");
|
|
|
|
Common::String gameId = ConfMan.get("gameid");
|
2006-05-04 23:24:09 +00:00
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
// Print text saying what's going on
|
|
|
|
printf("User picked target '%s' (engine ID '%s', game ID '%s')...\n", ConfMan.getActiveDomainName().c_str(), engineId.c_str(), gameId.c_str());
|
2010-01-25 01:39:44 +00:00
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
// At this point the engine ID and game ID must be known
|
|
|
|
if (engineId.empty()) {
|
|
|
|
warning("The engine ID is not set for target '%s'", ConfMan.getActiveDomainName().c_str());
|
|
|
|
return 0;
|
2009-06-06 17:37:31 +00:00
|
|
|
}
|
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
if (gameId.empty()) {
|
|
|
|
warning("The game ID is not set for target '%s'", ConfMan.getActiveDomainName().c_str());
|
|
|
|
return 0;
|
|
|
|
}
|
2010-08-05 00:26:46 +00:00
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
const Plugin *plugin = EngineMan.findPlugin(engineId);
|
|
|
|
if (!plugin) {
|
|
|
|
warning("'%s' is an invalid engine ID. Use the --list-engines command to list supported engine IDs", engineId.c_str());
|
|
|
|
return 0;
|
|
|
|
}
|
2006-05-04 23:24:09 +00:00
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
// Query the plugin for the game descriptor
|
|
|
|
printf(" Looking for a plugin supporting this target... %s\n", plugin->getName());
|
2021-05-13 16:04:55 +08:00
|
|
|
const MetaEngineDetection &metaEngine = plugin->get<MetaEngineDetection>();
|
|
|
|
DebugMan.debugFlagsClear();
|
|
|
|
DebugMan.debugFlagsRegister(metaEngine.getDebugChannels());
|
|
|
|
PlainGameDescriptor game = metaEngine.findGame(gameId.c_str());
|
2016-09-15 18:39:45 +02:00
|
|
|
if (!game.gameId) {
|
|
|
|
warning("'%s' is an invalid game ID for the engine '%s'. Use the --list-games option to list supported game IDs", gameId.c_str(), engineId.c_str());
|
|
|
|
return 0;
|
2011-04-18 18:19:53 +02:00
|
|
|
}
|
2007-09-19 08:40:12 +00:00
|
|
|
|
2006-05-12 21:41:54 +00:00
|
|
|
return plugin;
|
|
|
|
}
|
|
|
|
|
2016-09-15 18:39:45 +02:00
|
|
|
void saveLastLaunchedTarget(const Common::String &target) {
|
|
|
|
if (ConfMan.hasGameDomain(target)) {
|
|
|
|
// Set the last selected game, so the game will be highlighted next time the user
|
|
|
|
// returns to the launcher.
|
|
|
|
ConfMan.set("lastselectedgame", target, Common::ConfigManager::kApplicationDomain);
|
|
|
|
ConfMan.flushToDisk();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2007-06-15 17:29:49 +00:00
|
|
|
// TODO: specify the possible return values here
|
2021-02-05 23:30:58 +00:00
|
|
|
static Common::Error runGame(const Plugin *plugin, const Plugin *enginePlugin, OSystem &system, const Common::String &edebuglevels) {
|
2020-08-12 18:16:55 +05:30
|
|
|
assert(plugin);
|
2021-04-06 15:04:52 +01:00
|
|
|
assert(enginePlugin);
|
2020-08-12 18:16:55 +05:30
|
|
|
|
2008-11-06 17:05:54 +00:00
|
|
|
// Determine the game data path, for validation and error messages
|
|
|
|
Common::FSNode dir(ConfMan.get("path"));
|
2020-01-23 10:50:52 +01:00
|
|
|
Common::String target = ConfMan.getActiveDomainName();
|
2008-11-06 17:05:54 +00:00
|
|
|
Common::Error err = Common::kNoError;
|
|
|
|
Engine *engine = 0;
|
2006-03-25 04:17:17 +00:00
|
|
|
|
2013-10-07 00:58:19 +02:00
|
|
|
#if defined(SDL_BACKEND) && defined(USE_OPENGL) && defined(USE_RGB_COLOR)
|
|
|
|
// HACK: We set up the requested graphics mode setting here to allow the
|
|
|
|
// backend to switch from Surface SDL to OpenGL if necessary. This is
|
|
|
|
// needed because otherwise the g_system->getSupportedFormats might return
|
|
|
|
// bad values.
|
|
|
|
g_system->beginGFXTransaction();
|
|
|
|
g_system->setGraphicsMode(ConfMan.get("gfx_mode").c_str());
|
|
|
|
if (g_system->endGFXTransaction() != OSystem::kTransactionSuccess) {
|
|
|
|
warning("Switching graphics mode to '%s' failed", ConfMan.get("gfx_mode").c_str());
|
|
|
|
return Common::kUnknownError;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2008-11-06 17:05:54 +00:00
|
|
|
// Verify that the game path refers to an actual directory
|
2019-09-14 22:22:51 +02:00
|
|
|
if (!dir.exists()) {
|
2016-03-15 23:09:42 +01:00
|
|
|
err = Common::kPathDoesNotExist;
|
2019-09-14 22:22:51 +02:00
|
|
|
} else if (!dir.isDirectory()) {
|
2011-04-18 17:50:54 +02:00
|
|
|
err = Common::kPathNotDirectory;
|
2019-09-14 22:22:51 +02:00
|
|
|
}
|
2008-12-22 11:22:15 +00:00
|
|
|
|
2021-02-14 14:21:37 +00:00
|
|
|
// Create the game's MetaEngineDetection.
|
|
|
|
const MetaEngineDetection &metaEngineDetection = plugin->get<MetaEngineDetection>();
|
2016-01-17 02:15:03 +01:00
|
|
|
if (err.getCode() == Common::kNoError) {
|
|
|
|
// Set default values for all of the custom engine options
|
2018-06-13 20:49:36 +02:00
|
|
|
// Apparently some engines query them in their constructor, thus we
|
2016-01-17 02:15:03 +01:00
|
|
|
// need to set this up before instance creation.
|
2021-02-14 14:21:37 +00:00
|
|
|
metaEngineDetection.registerDefaultSettings(target);
|
2020-08-04 00:42:23 +05:30
|
|
|
}
|
2016-01-17 02:15:03 +01:00
|
|
|
|
2021-05-12 14:58:23 +08:00
|
|
|
// clear the flag and add the global ones
|
2021-05-12 20:23:47 +08:00
|
|
|
DebugMan.debugFlagsClear();
|
2021-05-12 11:59:54 +08:00
|
|
|
// before we instantiate the engine, we register debug channels for it
|
2021-05-12 21:56:15 +08:00
|
|
|
DebugMan.debugFlagsRegister(metaEngineDetection.getDebugChannels());
|
2021-05-12 11:59:54 +08:00
|
|
|
|
2021-02-14 14:21:37 +00:00
|
|
|
// Create the game's MetaEngine.
|
2021-02-05 23:30:58 +00:00
|
|
|
MetaEngine &metaEngine = enginePlugin->get<MetaEngine>();
|
2021-02-14 14:21:37 +00:00
|
|
|
err = metaEngine.createInstance(&system, &engine);
|
2020-08-04 00:42:23 +05:30
|
|
|
|
2008-11-06 17:05:54 +00:00
|
|
|
// Check for errors
|
2011-04-18 17:39:31 +02:00
|
|
|
if (!engine || err.getCode() != Common::kNoError) {
|
2006-11-12 03:21:44 +00:00
|
|
|
|
2011-04-18 17:39:31 +02:00
|
|
|
// Print a warning; note that scummvm_main will also
|
|
|
|
// display an error dialog, so we don't have to do this here.
|
2010-06-26 18:07:41 +00:00
|
|
|
warning("%s failed to instantiate engine: %s (target '%s', path '%s')",
|
2006-11-12 03:21:44 +00:00
|
|
|
plugin->getName(),
|
2011-04-18 17:39:31 +02:00
|
|
|
err.getDesc().c_str(),
|
2020-01-23 10:50:52 +01:00
|
|
|
target.c_str(),
|
2008-11-06 17:05:54 +00:00
|
|
|
dir.getPath().c_str()
|
2006-11-12 03:21:44 +00:00
|
|
|
);
|
2009-05-20 21:00:52 +00:00
|
|
|
|
2018-06-03 13:44:40 +02:00
|
|
|
// If a temporary target failed to launch, remove it from the configuration manager
|
|
|
|
// so it not visible in the launcher.
|
|
|
|
// Temporary targets are created when starting games from the command line using the game id.
|
|
|
|
if (ConfMan.hasKey("id_came_from_command_line")) {
|
2020-01-23 10:50:52 +01:00
|
|
|
ConfMan.removeGameDomain(target.c_str());
|
2009-05-20 21:00:52 +00:00
|
|
|
}
|
|
|
|
|
2008-11-06 17:05:54 +00:00
|
|
|
return err;
|
2005-05-05 12:03:40 +00:00
|
|
|
}
|
|
|
|
|
2021-02-05 23:30:58 +00:00
|
|
|
// Set up the metaengine
|
|
|
|
engine->setMetaEngine(&metaEngine);
|
|
|
|
|
2004-01-15 14:01:57 +00:00
|
|
|
// Set the window caption to the game name
|
2006-04-15 20:36:41 +00:00
|
|
|
Common::String caption(ConfMan.get("description"));
|
2004-01-15 14:01:57 +00:00
|
|
|
|
2009-07-30 21:56:18 +00:00
|
|
|
if (caption.empty()) {
|
2021-05-13 16:04:55 +08:00
|
|
|
// here, we don't need to set the debug channels because it has been set earlier
|
2021-02-14 14:21:37 +00:00
|
|
|
PlainGameDescriptor game = metaEngineDetection.findGame(ConfMan.get("gameid").c_str());
|
2020-01-23 10:50:52 +01:00
|
|
|
if (game.description) {
|
2018-05-06 12:57:08 +02:00
|
|
|
caption = game.description;
|
|
|
|
}
|
2009-07-30 21:56:18 +00:00
|
|
|
}
|
2006-03-28 09:42:54 +00:00
|
|
|
if (caption.empty())
|
2020-01-23 10:50:52 +01:00
|
|
|
caption = target;
|
2006-03-28 09:42:54 +00:00
|
|
|
if (!caption.empty()) {
|
2020-11-01 21:15:34 +00:00
|
|
|
system.setWindowCaption(caption.decode());
|
2004-01-15 14:01:57 +00:00
|
|
|
}
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2008-10-22 17:08:17 +00:00
|
|
|
//
|
2008-11-06 17:05:54 +00:00
|
|
|
// Setup various paths in the SearchManager
|
2008-10-22 17:08:17 +00:00
|
|
|
//
|
|
|
|
|
|
|
|
// Add the game path to the directory search list
|
2014-01-22 18:07:06 +01:00
|
|
|
engine->initializePath(dir);
|
2006-03-25 04:17:17 +00:00
|
|
|
|
2004-11-23 00:03:25 +00:00
|
|
|
// Add extrapath (if any) to the directory search list
|
2008-10-22 17:08:17 +00:00
|
|
|
if (ConfMan.hasKey("extrapath")) {
|
|
|
|
dir = Common::FSNode(ConfMan.get("extrapath"));
|
|
|
|
SearchMan.addDirectory(dir.getPath(), dir);
|
|
|
|
}
|
2004-11-23 00:03:25 +00:00
|
|
|
|
2008-07-29 00:54:28 +00:00
|
|
|
// If a second extrapath is specified on the app domain level, add that as well.
|
2011-08-14 11:01:10 +02:00
|
|
|
// However, since the default hasKey() and get() check the app domain level,
|
|
|
|
// verify that it's not already there before adding it. The search manager will
|
|
|
|
// check for that too, so this check is mostly to avoid a warning message.
|
2008-10-22 17:08:17 +00:00
|
|
|
if (ConfMan.hasKey("extrapath", Common::ConfigManager::kApplicationDomain)) {
|
2011-08-14 11:01:10 +02:00
|
|
|
Common::String extraPath = ConfMan.get("extrapath", Common::ConfigManager::kApplicationDomain);
|
|
|
|
if (!SearchMan.hasArchive(extraPath)) {
|
|
|
|
dir = Common::FSNode(extraPath);
|
|
|
|
SearchMan.addDirectory(dir.getPath(), dir);
|
|
|
|
}
|
2008-10-22 17:08:17 +00:00
|
|
|
}
|
2007-06-12 21:21:40 +00:00
|
|
|
|
2009-01-30 04:52:53 +00:00
|
|
|
// On creation the engine should have set up all debug levels so we can use
|
2012-02-27 22:50:01 +02:00
|
|
|
// the command line arguments here
|
2009-01-30 04:52:53 +00:00
|
|
|
Common::StringTokenizer tokenizer(edebuglevels, " ,");
|
|
|
|
while (!tokenizer.empty()) {
|
|
|
|
Common::String token = tokenizer.nextToken();
|
2014-06-05 16:35:07 +02:00
|
|
|
if (token.equalsIgnoreCase("all"))
|
|
|
|
DebugMan.enableAllDebugChannels();
|
|
|
|
else if (!DebugMan.enableDebugChannel(token))
|
2020-07-04 03:13:05 +05:30
|
|
|
warning("Engine does not support debug level '%s'", token.c_str());
|
2009-01-30 04:52:53 +00:00
|
|
|
}
|
2006-11-13 12:03:08 +00:00
|
|
|
|
2018-09-27 07:12:11 +02:00
|
|
|
#ifdef USE_TRANSLATION
|
|
|
|
Common::String previousLanguage = TransMan.getCurrentLanguage();
|
|
|
|
if (ConfMan.hasKey("gui_use_game_language")
|
|
|
|
&& ConfMan.getBool("gui_use_game_language")
|
|
|
|
&& ConfMan.hasKey("language")) {
|
|
|
|
TransMan.setLanguage(ConfMan.get("language"));
|
2019-07-17 23:51:58 +02:00
|
|
|
Common::TextToSpeechManager *ttsMan;
|
|
|
|
if ((ttsMan = g_system->getTextToSpeechManager()) != nullptr) {
|
2019-10-14 01:23:57 +02:00
|
|
|
ttsMan->setLanguage(ConfMan.get("language"));
|
2019-07-17 23:51:58 +02:00
|
|
|
}
|
2018-09-27 07:12:11 +02:00
|
|
|
}
|
2019-07-17 23:51:58 +02:00
|
|
|
#endif // USE_TRANSLATION
|
2018-09-27 07:12:11 +02:00
|
|
|
|
2011-12-30 11:50:15 -06:00
|
|
|
// Initialize any game-specific keymaps
|
2021-02-14 14:21:37 +00:00
|
|
|
Common::KeymapArray gameKeymaps = metaEngine.initKeymaps(target.c_str());
|
2020-01-23 10:50:52 +01:00
|
|
|
Common::Keymapper *keymapper = system.getEventManager()->getKeymapper();
|
2020-01-28 18:44:08 +01:00
|
|
|
for (uint i = 0; i < gameKeymaps.size(); i++) {
|
|
|
|
keymapper->addGameKeymap(gameKeymaps[i]);
|
2020-01-23 10:50:52 +01:00
|
|
|
}
|
2011-12-30 11:50:15 -06:00
|
|
|
|
2020-05-11 12:05:56 +01:00
|
|
|
system.applyBackendSettings();
|
|
|
|
|
2007-07-01 20:29:28 +00:00
|
|
|
// Inform backend that the engine is about to be run
|
|
|
|
system.engineInit();
|
|
|
|
|
2009-03-01 04:30:55 +00:00
|
|
|
// Run the engine
|
|
|
|
Common::Error result = engine->run();
|
2004-01-15 14:01:57 +00:00
|
|
|
|
2021-01-20 23:19:49 +00:00
|
|
|
// Make sure we do not return to the launcher if this is not possible.
|
|
|
|
if (!engine->hasFeature(Engine::kSupportsReturnToLauncher))
|
|
|
|
ConfMan.setBool("gui_return_to_launcher_at_exit", false, Common::ConfigManager::kTransientDomain);
|
|
|
|
|
2007-07-01 20:29:28 +00:00
|
|
|
// Inform backend that the engine finished
|
|
|
|
system.engineDone();
|
|
|
|
|
2011-12-30 11:50:15 -06:00
|
|
|
// Clean up any game-specific keymaps
|
2020-01-23 10:50:52 +01:00
|
|
|
keymapper->cleanupGameKeymaps();
|
2011-12-30 11:50:15 -06:00
|
|
|
|
2004-01-15 14:01:57 +00:00
|
|
|
// Free up memory
|
|
|
|
delete engine;
|
2004-06-20 19:23:04 +00:00
|
|
|
|
2010-12-04 02:50:27 +00:00
|
|
|
// We clear all debug levels again even though the engine should do it
|
|
|
|
DebugMan.clearAllDebugChannels();
|
|
|
|
|
2006-04-01 21:52:33 +00:00
|
|
|
// Reset the file/directory mappings
|
2008-10-22 17:08:17 +00:00
|
|
|
SearchMan.clear();
|
2006-04-01 21:52:33 +00:00
|
|
|
|
2018-09-27 07:12:11 +02:00
|
|
|
#ifdef USE_TRANSLATION
|
|
|
|
TransMan.setLanguage(previousLanguage);
|
2021-04-25 07:05:02 +02:00
|
|
|
Common::TextToSpeechManager *ttsMan;
|
|
|
|
if ((ttsMan = g_system->getTextToSpeechManager()) != nullptr) {
|
|
|
|
ttsMan->setLanguage(ConfMan.get("language"));
|
|
|
|
}
|
2019-07-17 23:51:58 +02:00
|
|
|
#endif // USE_TRANSLATION
|
2018-09-27 07:12:11 +02:00
|
|
|
|
2008-09-03 16:56:40 +00:00
|
|
|
// Return result (== 0 means no error)
|
|
|
|
return result;
|
2004-03-16 23:51:41 +00:00
|
|
|
}
|
2004-01-15 14:01:57 +00:00
|
|
|
|
2009-01-11 12:22:29 +00:00
|
|
|
static void setupGraphics(OSystem &system) {
|
2009-05-24 15:17:42 +00:00
|
|
|
|
2008-08-18 10:07:11 +00:00
|
|
|
system.beginGFXTransaction();
|
|
|
|
// Set the user specified graphics mode (if any).
|
|
|
|
system.setGraphicsMode(ConfMan.get("gfx_mode").c_str());
|
2021-01-06 00:13:52 +05:30
|
|
|
system.setStretchMode(ConfMan.get("stretch_mode").c_str());
|
|
|
|
system.setShader(ConfMan.get("shader").c_str());
|
2008-08-18 10:07:11 +00:00
|
|
|
|
|
|
|
system.initSize(320, 200);
|
Merged revisions 33452-33453,33455-33459,33463-33464,33466-33471,33473-33474,33478,33490,33492,33495-33496,33509-33512,33518-33519,33522-33527,33529-33530,33537,33541,33544,33546,33550,33552-33554,33556,33558,33561-33562,33565,33568,33570,33574,33576,33578-33581,33584-33587,33590,33596,33604-33611,33614-33615,33617-33618,33620-33621,33623,33626-33627,33632-33633,33635,33637,33639-33640,33642-33645,33648,33654-33655,33664,33667-33670,33673-33674,33678,33682,33686-33691,33693,33696,33698,33700,33703,33708,33710,33712-33714,33716,33719,33721-33723,33725-33727,33729-33730,33733,33736,33742,33754,33756,33758,33761,33763,33766,33777,33781-33788,33790,33792-33793,33795,33797,33805,33807-33812,33815-33817,33819,33822,33826,33829,33837,33839,33844,33847,33858-33861,33864,33871-33873,33875,33877-33879,33886,33889-33892,33894,33896,33900,33902-33903,33919,33928,33930,33932-33936,33938-33940,33942-33943,33948,33950,33953,33967,33973,33976,33978,33980,33985,33991,33993,33999-34000,34006,34009,34011,34013,34015,34019,34021-34023,34025,34027-34028,34030,34032-34034,34036,34038-34039,34041,34046-34048,34050-34055,34057,34059-34065,34067,34072,34074,34076,34078-34081,34084,34086-34087,34089-34090,34093,34096-34102,34104,34107,34113,34116,34119,34122,34124,34126,34128,34131-34132,34135,34138,34141,34144,34146,34149,34152-34154,34156-34157,34160,34163-34164,34169,34173,34179-34194,34196-34198,34200-34201,34205-34206,34208-34217,34219-34225,34227-34228,34234-34237,34239-34249,34251-34279,34281-34284,34286-34288,34290-34320,34323-34324,34326,34328-34329,34332,34334,34336,34338-34340,34343-34353,34356-34357,34359-34371,34373,34375,34378,34381-34382,34384-34385,34389-34391,34393-34394,34396-34397,34399-34405,34407-34409,34411,34413,34415,34417-34420,34423-34426,34428-34438,34440-34454,34456-34458,34460,34462-34469,34472,34474,34479-34481,34483-34498,34501-34505,34508,34511-34518,34520-34524,34526-34563,34566-34569,34571-34590,34592,34595-34599,34602-34603,34605,34613-34615,34617,34619-34624,34627-34628,34630-34639,34642-34649 via svnmerge from
https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk
svn-id: r34654
2008-09-26 21:53:08 +00:00
|
|
|
|
|
|
|
if (ConfMan.hasKey("aspect_ratio"))
|
|
|
|
system.setFeatureState(OSystem::kFeatureAspectRatioCorrection, ConfMan.getBool("aspect_ratio"));
|
|
|
|
if (ConfMan.hasKey("fullscreen"))
|
|
|
|
system.setFeatureState(OSystem::kFeatureFullscreenMode, ConfMan.getBool("fullscreen"));
|
2016-10-12 22:32:36 +01:00
|
|
|
if (ConfMan.hasKey("filtering"))
|
|
|
|
system.setFeatureState(OSystem::kFeatureFilteringMode, ConfMan.getBool("filtering"));
|
2008-08-18 10:07:11 +00:00
|
|
|
system.endGFXTransaction();
|
|
|
|
|
2020-05-11 12:05:56 +01:00
|
|
|
system.applyBackendSettings();
|
|
|
|
|
Merged revisions 33452-33453,33455-33459,33463-33464,33466-33471,33473-33474,33478,33490,33492,33495-33496,33509-33512,33518-33519,33522-33527,33529-33530,33537,33541,33544,33546,33550,33552-33554,33556,33558,33561-33562,33565,33568,33570,33574,33576,33578-33581,33584-33587,33590,33596,33604-33611,33614-33615,33617-33618,33620-33621,33623,33626-33627,33632-33633,33635,33637,33639-33640,33642-33645,33648,33654-33655,33664,33667-33670,33673-33674,33678,33682,33686-33691,33693,33696,33698,33700,33703,33708,33710,33712-33714,33716,33719,33721-33723,33725-33727,33729-33730,33733,33736,33742,33754,33756,33758,33761,33763,33766,33777,33781-33788,33790,33792-33793,33795,33797,33805,33807-33812,33815-33817,33819,33822,33826,33829,33837,33839,33844,33847,33858-33861,33864,33871-33873,33875,33877-33879,33886,33889-33892,33894,33896,33900,33902-33903,33919,33928,33930,33932-33936,33938-33940,33942-33943,33948,33950,33953,33967,33973,33976,33978,33980,33985,33991,33993,33999-34000,34006,34009,34011,34013,34015,34019,34021-34023,34025,34027-34028,34030,34032-34034,34036,34038-34039,34041,34046-34048,34050-34055,34057,34059-34065,34067,34072,34074,34076,34078-34081,34084,34086-34087,34089-34090,34093,34096-34102,34104,34107,34113,34116,34119,34122,34124,34126,34128,34131-34132,34135,34138,34141,34144,34146,34149,34152-34154,34156-34157,34160,34163-34164,34169,34173,34179-34194,34196-34198,34200-34201,34205-34206,34208-34217,34219-34225,34227-34228,34234-34237,34239-34249,34251-34279,34281-34284,34286-34288,34290-34320,34323-34324,34326,34328-34329,34332,34334,34336,34338-34340,34343-34353,34356-34357,34359-34371,34373,34375,34378,34381-34382,34384-34385,34389-34391,34393-34394,34396-34397,34399-34405,34407-34409,34411,34413,34415,34417-34420,34423-34426,34428-34438,34440-34454,34456-34458,34460,34462-34469,34472,34474,34479-34481,34483-34498,34501-34505,34508,34511-34518,34520-34524,34526-34563,34566-34569,34571-34590,34592,34595-34599,34602-34603,34605,34613-34615,34617,34619-34624,34627-34628,34630-34639,34642-34649 via svnmerge from
https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk
svn-id: r34654
2008-09-26 21:53:08 +00:00
|
|
|
// When starting up launcher for the first time, the user might have specified
|
|
|
|
// a --gui-theme option, to allow that option to be working, we need to initialize
|
|
|
|
// GUI here.
|
|
|
|
// FIXME: Find a nicer way to allow --gui-theme to be working
|
2009-01-11 00:20:27 +00:00
|
|
|
GUI::GuiManager::instance();
|
Merged revisions 33452-33453,33455-33459,33463-33464,33466-33471,33473-33474,33478,33490,33492,33495-33496,33509-33512,33518-33519,33522-33527,33529-33530,33537,33541,33544,33546,33550,33552-33554,33556,33558,33561-33562,33565,33568,33570,33574,33576,33578-33581,33584-33587,33590,33596,33604-33611,33614-33615,33617-33618,33620-33621,33623,33626-33627,33632-33633,33635,33637,33639-33640,33642-33645,33648,33654-33655,33664,33667-33670,33673-33674,33678,33682,33686-33691,33693,33696,33698,33700,33703,33708,33710,33712-33714,33716,33719,33721-33723,33725-33727,33729-33730,33733,33736,33742,33754,33756,33758,33761,33763,33766,33777,33781-33788,33790,33792-33793,33795,33797,33805,33807-33812,33815-33817,33819,33822,33826,33829,33837,33839,33844,33847,33858-33861,33864,33871-33873,33875,33877-33879,33886,33889-33892,33894,33896,33900,33902-33903,33919,33928,33930,33932-33936,33938-33940,33942-33943,33948,33950,33953,33967,33973,33976,33978,33980,33985,33991,33993,33999-34000,34006,34009,34011,34013,34015,34019,34021-34023,34025,34027-34028,34030,34032-34034,34036,34038-34039,34041,34046-34048,34050-34055,34057,34059-34065,34067,34072,34074,34076,34078-34081,34084,34086-34087,34089-34090,34093,34096-34102,34104,34107,34113,34116,34119,34122,34124,34126,34128,34131-34132,34135,34138,34141,34144,34146,34149,34152-34154,34156-34157,34160,34163-34164,34169,34173,34179-34194,34196-34198,34200-34201,34205-34206,34208-34217,34219-34225,34227-34228,34234-34237,34239-34249,34251-34279,34281-34284,34286-34288,34290-34320,34323-34324,34326,34328-34329,34332,34334,34336,34338-34340,34343-34353,34356-34357,34359-34371,34373,34375,34378,34381-34382,34384-34385,34389-34391,34393-34394,34396-34397,34399-34405,34407-34409,34411,34413,34415,34417-34420,34423-34426,34428-34438,34440-34454,34456-34458,34460,34462-34469,34472,34474,34479-34481,34483-34498,34501-34505,34508,34511-34518,34520-34524,34526-34563,34566-34569,34571-34590,34592,34595-34599,34602-34603,34605,34613-34615,34617,34619-34624,34627-34628,34630-34639,34642-34649 via svnmerge from
https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk
svn-id: r34654
2008-09-26 21:53:08 +00:00
|
|
|
|
2008-08-18 10:07:11 +00:00
|
|
|
// Set initial window caption
|
2020-11-01 21:15:34 +00:00
|
|
|
system.setWindowCaption(Common::U32String(gScummVMFullVersion));
|
2008-08-18 10:07:11 +00:00
|
|
|
|
|
|
|
// Clear the main screen
|
2009-02-15 21:20:21 +00:00
|
|
|
system.fillScreen(0);
|
2008-08-18 10:07:11 +00:00
|
|
|
}
|
|
|
|
|
2009-05-10 22:05:04 +00:00
|
|
|
static void setupKeymapper(OSystem &system) {
|
|
|
|
using namespace Common;
|
|
|
|
|
|
|
|
Keymapper *mapper = system.getEventManager()->getKeymapper();
|
2020-02-09 07:18:13 +01:00
|
|
|
mapper->clear();
|
2012-02-09 01:26:29 -06:00
|
|
|
|
2020-01-22 11:18:55 +01:00
|
|
|
// Query the backend for hardware keys and default bindings and register them
|
2012-02-24 13:23:55 -06:00
|
|
|
HardwareInputSet *inputSet = system.getHardwareInputSet();
|
2020-01-28 18:44:09 +01:00
|
|
|
KeymapperDefaultBindings *backendDefaultBindings = system.getKeymapperDefaultBindings();
|
2009-05-10 22:05:04 +00:00
|
|
|
|
2020-03-11 20:42:59 +01:00
|
|
|
mapper->registerHardwareInputSet(inputSet, backendDefaultBindings);
|
2009-05-10 22:05:04 +00:00
|
|
|
|
2020-01-23 10:50:52 +01:00
|
|
|
Keymap *primaryGlobalKeymap = system.getEventManager()->getGlobalKeymap();
|
|
|
|
if (primaryGlobalKeymap) {
|
|
|
|
mapper->addGlobalKeymap(primaryGlobalKeymap);
|
|
|
|
}
|
2012-02-09 01:26:29 -06:00
|
|
|
|
|
|
|
// Get the platform-specific global keymap (if it exists)
|
2020-01-24 10:58:17 +01:00
|
|
|
KeymapArray platformKeymaps = system.getGlobalKeymaps();
|
|
|
|
for (uint i = 0; i < platformKeymaps.size(); i++) {
|
|
|
|
mapper->addGlobalKeymap(platformKeymaps[i]);
|
2012-02-09 01:26:29 -06:00
|
|
|
}
|
2009-05-10 22:05:04 +00:00
|
|
|
}
|
2006-10-21 12:03:43 +00:00
|
|
|
|
2009-03-21 16:07:46 +00:00
|
|
|
extern "C" int scummvm_main(int argc, const char * const argv[]) {
|
2006-04-02 20:27:56 +00:00
|
|
|
Common::String specialDebug;
|
2006-04-02 21:06:49 +00:00
|
|
|
Common::String command;
|
2002-05-14 11:32:16 +00:00
|
|
|
|
2006-04-02 20:27:56 +00:00
|
|
|
// Verify that the backend has been initialized (i.e. g_system has been set).
|
2006-04-02 14:16:31 +00:00
|
|
|
assert(g_system);
|
|
|
|
OSystem &system = *g_system;
|
2007-09-19 08:40:12 +00:00
|
|
|
|
2006-05-04 22:55:15 +00:00
|
|
|
// Register config manager defaults
|
2006-05-04 23:37:50 +00:00
|
|
|
Base::registerDefaults();
|
2020-05-11 12:05:56 +01:00
|
|
|
system.registerDefaultSettings(Common::ConfigManager::kApplicationDomain);
|
2006-04-02 14:16:31 +00:00
|
|
|
|
2006-04-02 20:27:56 +00:00
|
|
|
// Parse the command line
|
|
|
|
Common::StringMap settings;
|
2006-05-04 23:37:50 +00:00
|
|
|
command = Base::parseCommandLine(settings, argc, argv);
|
2006-04-02 14:16:31 +00:00
|
|
|
|
2010-10-24 13:04:33 +00:00
|
|
|
// Load the config file (possibly overridden via command line):
|
2006-04-02 20:27:56 +00:00
|
|
|
if (settings.contains("config")) {
|
|
|
|
ConfMan.loadConfigFile(settings["config"]);
|
|
|
|
settings.erase("config");
|
|
|
|
} else {
|
2004-12-25 19:03:13 +00:00
|
|
|
ConfMan.loadDefaultConfigFile();
|
2006-04-02 20:27:56 +00:00
|
|
|
}
|
2004-02-07 04:53:59 +00:00
|
|
|
|
2006-04-02 21:38:36 +00:00
|
|
|
// Update the config file
|
|
|
|
ConfMan.set("versioninfo", gScummVMVersion, Common::ConfigManager::kApplicationDomain);
|
|
|
|
|
2006-05-05 00:03:21 +00:00
|
|
|
// Load and setup the debuglevel and the debug flags. We do this at the
|
2007-09-19 08:40:12 +00:00
|
|
|
// soonest possible moment to ensure debug output starts early on, if
|
2006-05-05 00:03:21 +00:00
|
|
|
// requested.
|
2006-04-02 21:32:23 +00:00
|
|
|
if (settings.contains("debuglevel")) {
|
|
|
|
gDebugLevel = (int)strtol(settings["debuglevel"].c_str(), 0, 10);
|
|
|
|
printf("Debuglevel (from command line): %d\n", gDebugLevel);
|
2018-04-15 14:00:56 +02:00
|
|
|
settings.erase("debuglevel"); // This option should not be passed to ConfMan.
|
2006-04-02 21:32:23 +00:00
|
|
|
} else if (ConfMan.hasKey("debuglevel"))
|
2005-04-23 13:52:27 +00:00
|
|
|
gDebugLevel = ConfMan.getInt("debuglevel");
|
2004-12-27 21:54:20 +00:00
|
|
|
|
2006-04-02 20:27:56 +00:00
|
|
|
if (settings.contains("debugflags")) {
|
|
|
|
specialDebug = settings["debugflags"];
|
|
|
|
settings.erase("debugflags");
|
2016-06-05 11:43:07 +02:00
|
|
|
} else if (ConfMan.hasKey("debugflags"))
|
|
|
|
specialDebug = ConfMan.get("debugflags");
|
2006-02-14 23:31:25 +00:00
|
|
|
|
2016-08-13 21:04:42 +02:00
|
|
|
if (settings.contains("debug-channels-only"))
|
|
|
|
gDebugChannelsOnly = true;
|
|
|
|
|
|
|
|
|
2020-10-02 17:32:38 +05:30
|
|
|
ConfMan.registerDefault("always_run_fallback_detection_extern", true);
|
2010-12-23 13:38:37 +00:00
|
|
|
PluginManager::instance().init();
|
|
|
|
PluginManager::instance().loadAllPlugins(); // load plugins for cached plugin manager
|
2020-08-12 18:16:55 +05:30
|
|
|
PluginManager::instance().loadDetectionPlugin(); // load detection plugin for uncached plugin manager
|
2011-06-20 00:59:48 +02:00
|
|
|
|
2010-06-22 18:27:00 +00:00
|
|
|
// If we received an invalid music parameter via command line we check this here.
|
|
|
|
// We can't check this before loading the music plugins.
|
|
|
|
// On the other hand we cannot load the plugins before we know the file paths (in case of external plugins).
|
2010-06-28 23:59:43 +00:00
|
|
|
if (settings.contains("music-driver")) {
|
2010-06-29 00:29:35 +00:00
|
|
|
if (MidiDriver::getMusicType(MidiDriver::getDeviceHandle(settings["music-driver"])) == MT_INVALID) {
|
2010-07-26 06:10:47 +00:00
|
|
|
warning("Unrecognized music driver '%s'. Switching to default device", settings["music-driver"].c_str());
|
2010-06-29 00:29:35 +00:00
|
|
|
settings["music-driver"] = "auto";
|
2010-06-22 18:27:00 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2006-05-04 23:57:49 +00:00
|
|
|
// Process the remaining command line settings. Must be done after the
|
|
|
|
// config file and the plugins have been loaded.
|
2010-05-21 18:25:01 +00:00
|
|
|
Common::Error res;
|
|
|
|
|
2010-11-05 13:24:57 +00:00
|
|
|
// TODO: deal with settings that require plugins to be loaded
|
2011-05-23 19:36:45 +02:00
|
|
|
if (Base::processSettings(command, settings, res)) {
|
2011-05-05 17:43:33 +02:00
|
|
|
if (res.getCode() != Common::kNoError)
|
|
|
|
warning("%s", res.getDesc().c_str());
|
2021-05-14 23:25:04 +02:00
|
|
|
|
|
|
|
PluginManager::instance().unloadDetectionPlugin();
|
|
|
|
PluginManager::instance().unloadAllPlugins();
|
|
|
|
PluginManager::destroy();
|
|
|
|
|
2011-04-18 17:39:31 +02:00
|
|
|
return res.getCode();
|
2011-04-18 18:19:53 +02:00
|
|
|
}
|
2005-07-05 20:22:56 +00:00
|
|
|
|
2020-02-19 19:51:53 +02:00
|
|
|
if (settings.contains("dump-midi")) {
|
|
|
|
// Store this command line setting in ConfMan, since all transient settings are destroyed
|
|
|
|
ConfMan.registerDefault("dump_midi", true);
|
|
|
|
}
|
|
|
|
|
2021-04-21 00:57:10 +02:00
|
|
|
#ifdef USE_OPENGL
|
|
|
|
if (settings.contains("last_window_width")) {
|
|
|
|
ConfMan.setInt("last_window_width", atoi(settings["last_window_width"].c_str()));
|
|
|
|
ConfMan.setInt("last_window_height", atoi(settings["last_window_height"].c_str()));
|
|
|
|
}
|
|
|
|
#endif
|
2020-02-19 19:51:53 +02:00
|
|
|
|
2005-04-19 20:22:50 +00:00
|
|
|
// Init the backend. Must take place after all config data (including
|
|
|
|
// the command line params) was read.
|
|
|
|
system.initBackend();
|
2003-11-08 22:05:58 +00:00
|
|
|
|
2010-11-28 17:26:27 +00:00
|
|
|
// If we received an invalid graphics mode parameter via command line
|
|
|
|
// we check this here. We can't do it until after the backend is inited,
|
|
|
|
// or there won't be a graphics manager to ask for the supported modes.
|
|
|
|
|
|
|
|
if (settings.contains("gfx-mode")) {
|
|
|
|
const OSystem::GraphicsMode *gm = g_system->getSupportedGraphicsModes();
|
|
|
|
Common::String option = settings["gfx-mode"];
|
|
|
|
bool isValid = false;
|
|
|
|
|
|
|
|
while (gm->name && !isValid) {
|
|
|
|
isValid = !scumm_stricmp(gm->name, option.c_str());
|
|
|
|
gm++;
|
|
|
|
}
|
|
|
|
if (!isValid) {
|
|
|
|
warning("Unrecognized graphics mode '%s'. Switching to default mode", option.c_str());
|
|
|
|
settings["gfx-mode"] = "default";
|
|
|
|
}
|
|
|
|
}
|
2013-05-17 00:18:09 +03:00
|
|
|
if (settings.contains("disable-display")) {
|
|
|
|
ConfMan.setInt("disable-display", 1, Common::ConfigManager::kTransientDomain);
|
|
|
|
}
|
2008-08-18 10:07:11 +00:00
|
|
|
setupGraphics(system);
|
|
|
|
|
2010-11-18 11:31:46 +00:00
|
|
|
// Init the different managers that are used by the engines.
|
|
|
|
// Do it here to prevent fragmentation later
|
2010-11-18 07:17:28 +00:00
|
|
|
system.getAudioCDManager();
|
2010-11-18 11:31:46 +00:00
|
|
|
MusicManager::instance();
|
|
|
|
Common::DebugManager::instance();
|
2021-05-12 14:58:23 +08:00
|
|
|
// set the global debug flags as soon as we instantiate the debug mannager
|
2021-05-12 20:23:47 +08:00
|
|
|
DebugMan.debugFlagsClear();
|
2011-06-20 00:59:48 +02:00
|
|
|
|
2009-05-24 15:17:42 +00:00
|
|
|
// Init the event manager. As the virtual keyboard is loaded here, it must
|
2008-08-18 10:07:11 +00:00
|
|
|
// take place after the backend is initiated and the screen has been setup
|
|
|
|
system.getEventManager()->init();
|
|
|
|
|
2013-07-06 23:54:45 -04:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
2009-07-25 12:59:46 +00:00
|
|
|
// Directly after initializing the event manager, we will initialize our
|
|
|
|
// event recorder.
|
|
|
|
//
|
|
|
|
// TODO: This is just to match the current behavior, when we further extend
|
|
|
|
// our event recorder, we might do this at another place. Or even change
|
|
|
|
// the whole API for that ;-).
|
2013-05-17 00:18:09 +03:00
|
|
|
g_eventRec.RegisterEventSource();
|
2013-07-06 23:54:45 -04:00
|
|
|
#endif
|
2009-07-25 12:59:46 +00:00
|
|
|
|
2016-10-26 23:20:30 +01:00
|
|
|
Common::OSDMessageQueue::instance().registerEventSource();
|
|
|
|
|
2009-05-10 22:05:04 +00:00
|
|
|
// Now as the event manager is created, setup the keymapper
|
|
|
|
setupKeymapper(system);
|
|
|
|
|
2016-03-30 10:58:57 +02:00
|
|
|
#ifdef USE_UPDATES
|
2017-09-08 21:16:00 +01:00
|
|
|
if (!ConfMan.hasKey("updates_check") && g_system->getUpdateManager()) {
|
2016-03-30 10:58:57 +02:00
|
|
|
GUI::UpdatesDialog dlg;
|
|
|
|
dlg.runModal();
|
|
|
|
}
|
|
|
|
#endif
|
2016-10-09 15:02:02 +02:00
|
|
|
|
2016-10-17 18:45:12 +02:00
|
|
|
#if defined(USE_CLOUD) && defined(USE_LIBCURL)
|
2016-06-01 16:22:42 +06:00
|
|
|
CloudMan.init();
|
|
|
|
CloudMan.syncSaves();
|
2016-05-11 22:52:14 +06:00
|
|
|
#endif
|
2016-03-30 10:58:57 +02:00
|
|
|
|
2002-09-30 00:55:47 +00:00
|
|
|
// Unless a game was specified, show the launcher dialog
|
2009-01-11 12:22:29 +00:00
|
|
|
if (0 == ConfMan.getActiveDomain())
|
2009-01-24 18:27:09 +00:00
|
|
|
launcherDialog();
|
2002-09-30 00:55:47 +00:00
|
|
|
|
2004-10-10 16:31:15 +00:00
|
|
|
// FIXME: We're now looping the launcher. This, of course, doesn't
|
|
|
|
// work as well as it should. In theory everything should be destroyed
|
|
|
|
// cleanly, so this is now enabled to encourage people to fix bits :)
|
2006-05-05 00:26:03 +00:00
|
|
|
while (0 != ConfMan.getActiveDomain()) {
|
2016-09-15 18:39:45 +02:00
|
|
|
saveLastLaunchedTarget(ConfMan.getActiveDomainName());
|
|
|
|
|
2016-09-15 18:43:42 +02:00
|
|
|
EngineMan.upgradeTargetIfNecessary(ConfMan.getActiveDomainName());
|
|
|
|
|
2020-08-03 05:51:26 +05:30
|
|
|
// Try to find a MetaEnginePlugin which feels responsible for the specified game.
|
2017-11-10 23:06:42 -06:00
|
|
|
const Plugin *plugin = detectPlugin();
|
2020-08-03 05:51:26 +05:30
|
|
|
|
2021-04-06 15:04:52 +01:00
|
|
|
// Then, get the relevant Engine plugin from MetaEngine.
|
|
|
|
const Plugin *enginePlugin = nullptr;
|
|
|
|
if (plugin)
|
|
|
|
enginePlugin = PluginMan.getEngineFromMetaEngine(plugin);
|
|
|
|
|
|
|
|
if (enginePlugin) {
|
|
|
|
// Unload all plugins not needed for this game, to save memory
|
2020-08-03 05:51:26 +05:30
|
|
|
// Right now, we have a MetaEngine plugin, and we want to unload all except Engine.
|
|
|
|
|
2021-04-06 15:04:52 +01:00
|
|
|
// Pass in the pointer to enginePlugin, with the matching type, so our function behaves as-is.
|
2020-08-03 05:51:26 +05:30
|
|
|
PluginManager::instance().unloadPluginsExcept(PLUGIN_TYPE_ENGINE, enginePlugin);
|
2004-08-29 19:08:08 +00:00
|
|
|
|
2021-04-05 19:55:16 +01:00
|
|
|
#if defined(UNCACHED_PLUGINS) && defined(DYNAMIC_MODULES) && !defined(DETECTION_STATIC)
|
2020-08-12 18:16:55 +05:30
|
|
|
// Unload all MetaEngines not needed for the current engine, if we're using uncached plugins
|
|
|
|
// to save extra memory.
|
2020-10-11 23:12:32 +02:00
|
|
|
PluginManager::instance().unloadPluginsExcept(PLUGIN_TYPE_ENGINE_DETECTION, plugin);
|
2020-08-12 18:16:55 +05:30
|
|
|
#endif
|
|
|
|
|
2013-05-17 00:18:09 +03:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
|
|
|
Common::String recordMode = ConfMan.get("record_mode");
|
|
|
|
Common::String recordFileName = ConfMan.get("record_file_name");
|
|
|
|
|
|
|
|
if (recordMode == "record") {
|
|
|
|
g_eventRec.init(g_eventRec.generateRecordFileName(ConfMan.getActiveDomainName()), GUI::EventRecorder::kRecorderRecord);
|
|
|
|
} else if (recordMode == "playback") {
|
|
|
|
g_eventRec.init(recordFileName, GUI::EventRecorder::kRecorderPlayback);
|
|
|
|
} else if ((recordMode == "info") && (!recordFileName.empty())) {
|
|
|
|
Common::PlaybackFile record;
|
|
|
|
record.openRead(recordFileName);
|
|
|
|
debug("info:author=%s name=%s description=%s", record.getHeader().author.c_str(), record.getHeader().name.c_str(), record.getHeader().description.c_str());
|
|
|
|
break;
|
|
|
|
}
|
2019-07-22 19:42:30 +02:00
|
|
|
#endif
|
|
|
|
Common::TextToSpeechManager *ttsMan = g_system->getTextToSpeechManager();
|
2020-05-25 18:29:41 +01:00
|
|
|
if (ttsMan != nullptr) {
|
|
|
|
ttsMan->pushState();
|
|
|
|
}
|
2007-06-15 17:29:49 +00:00
|
|
|
// Try to run the game
|
2021-02-05 23:30:58 +00:00
|
|
|
Common::Error result = runGame(plugin, enginePlugin, system, specialDebug);
|
2020-05-25 18:29:41 +01:00
|
|
|
if (ttsMan != nullptr) {
|
|
|
|
ttsMan->popState();
|
|
|
|
}
|
2019-07-22 19:42:30 +02:00
|
|
|
|
2013-07-06 23:54:45 -04:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
2011-08-08 15:38:27 +01:00
|
|
|
// Flush Event recorder file. The recorder does not get reinitialized for next game
|
|
|
|
// which is intentional. Only single game per session is allowed.
|
|
|
|
g_eventRec.deinit();
|
2013-07-06 23:54:45 -04:00
|
|
|
#endif
|
2011-08-08 15:38:27 +01:00
|
|
|
|
2018-04-15 14:00:56 +02:00
|
|
|
#if defined(UNCACHED_PLUGINS) && defined(DYNAMIC_MODULES)
|
2010-11-15 13:36:34 +00:00
|
|
|
// do our best to prevent fragmentation by unloading as soon as we can
|
|
|
|
PluginManager::instance().unloadPluginsExcept(PLUGIN_TYPE_ENGINE, NULL, false);
|
2020-08-12 18:16:55 +05:30
|
|
|
PluginManager::instance().unloadDetectionPlugin();
|
2010-11-15 13:37:06 +00:00
|
|
|
// reallocate the config manager to get rid of any fragmentation
|
|
|
|
ConfMan.defragment();
|
2020-02-09 07:18:13 +01:00
|
|
|
// The keymapper keeps pointers to the configuration domains. It needs to be reinitialized.
|
|
|
|
setupKeymapper(system);
|
2018-04-15 14:00:56 +02:00
|
|
|
#endif
|
2011-06-20 00:59:48 +02:00
|
|
|
|
2008-09-03 16:56:40 +00:00
|
|
|
// Did an error occur ?
|
2011-04-25 15:26:38 -05:00
|
|
|
if (result.getCode() != Common::kNoError && result.getCode() != Common::kUserCanceled) {
|
2010-04-11 19:04:02 +00:00
|
|
|
// Shows an informative error dialog if starting the selected game failed.
|
2010-06-15 10:44:51 +00:00
|
|
|
GUI::displayErrorDialog(result, _("Error running game:"));
|
2008-09-03 16:56:40 +00:00
|
|
|
}
|
2008-09-08 14:38:07 +00:00
|
|
|
|
2008-09-03 16:56:40 +00:00
|
|
|
// Quit unless an error occurred, or Return to launcher was requested
|
2020-12-09 21:44:11 +00:00
|
|
|
if (result.getCode() == Common::kNoError && !g_system->getEventManager()->shouldReturnToLauncher() &&
|
|
|
|
!g_system->hasFeature(OSystem::kFeatureNoQuit) && !ConfMan.getBool("gui_return_to_launcher_at_exit"))
|
2004-12-05 17:35:24 +00:00
|
|
|
break;
|
2020-12-09 22:11:08 +00:00
|
|
|
|
2020-12-09 21:44:11 +00:00
|
|
|
// Reset the return to launcher and quit flags in case we want to load another engine
|
2020-05-11 08:47:44 -04:00
|
|
|
g_system->getEventManager()->resetReturnToLauncher();
|
2009-07-12 05:35:56 +00:00
|
|
|
g_system->getEventManager()->resetQuit();
|
2020-12-09 21:44:11 +00:00
|
|
|
|
2018-04-15 14:00:56 +02:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
2013-05-17 00:18:09 +03:00
|
|
|
if (g_eventRec.checkForContinueGame()) {
|
|
|
|
continue;
|
|
|
|
}
|
2018-04-15 14:00:56 +02:00
|
|
|
#endif
|
2008-09-03 16:56:40 +00:00
|
|
|
|
2014-12-30 03:45:14 +01:00
|
|
|
// At this point, we usually return to the launcher. However, the
|
|
|
|
// game may have requested that one or more other games be "chained"
|
|
|
|
// to the current one, with optional save slots to start the games
|
|
|
|
// at. At the time of writing, this is used for the Maniac Mansion
|
|
|
|
// easter egg in Day of the Tentacle.
|
|
|
|
|
2014-12-30 10:47:51 +01:00
|
|
|
Common::String chainedGame;
|
|
|
|
int saveSlot = -1;
|
2014-12-30 03:45:14 +01:00
|
|
|
|
2014-12-30 10:47:51 +01:00
|
|
|
ChainedGamesMan.pop(chainedGame, saveSlot);
|
2014-12-30 03:45:14 +01:00
|
|
|
|
2006-04-15 13:12:03 +00:00
|
|
|
// Discard any command line options. It's unlikely that the user
|
|
|
|
// wanted to apply them to *all* games ever launched.
|
|
|
|
ConfMan.getDomain(Common::ConfigManager::kTransientDomain)->clear();
|
2007-09-19 08:40:12 +00:00
|
|
|
|
2014-12-30 10:47:51 +01:00
|
|
|
if (!chainedGame.empty()) {
|
|
|
|
if (saveSlot != -1) {
|
|
|
|
ConfMan.setInt("save_slot", saveSlot, Common::ConfigManager::kTransientDomain);
|
2014-12-30 03:45:14 +01:00
|
|
|
}
|
2014-12-30 10:47:51 +01:00
|
|
|
// Start the chained game
|
|
|
|
ConfMan.setActiveDomain(chainedGame);
|
2014-12-30 03:45:14 +01:00
|
|
|
} else {
|
|
|
|
// Clear the active config domain
|
|
|
|
ConfMan.setActiveDomain("");
|
|
|
|
}
|
2004-10-13 08:49:33 +00:00
|
|
|
|
2012-06-12 15:03:51 -04:00
|
|
|
PluginManager::instance().loadAllPluginsOfType(PLUGIN_TYPE_ENGINE); // only for cached manager
|
2020-08-12 18:16:55 +05:30
|
|
|
PluginManager::instance().loadDetectionPlugin(); // only for uncached manager
|
2007-06-15 17:29:49 +00:00
|
|
|
} else {
|
2010-06-15 10:44:51 +00:00
|
|
|
GUI::displayErrorDialog(_("Could not find any engine capable of running the selected game"));
|
2015-02-22 16:49:00 -05:00
|
|
|
|
|
|
|
// Clear the active domain
|
|
|
|
ConfMan.setActiveDomain("");
|
2003-10-05 14:37:16 +00:00
|
|
|
}
|
2009-05-24 15:17:42 +00:00
|
|
|
|
2008-08-18 10:07:11 +00:00
|
|
|
// reset the graphics to default
|
2009-01-11 12:22:29 +00:00
|
|
|
setupGraphics(system);
|
2014-12-30 03:45:14 +01:00
|
|
|
if (0 == ConfMan.getActiveDomain()) {
|
|
|
|
launcherDialog();
|
|
|
|
}
|
2004-10-10 16:31:15 +00:00
|
|
|
}
|
2016-10-17 18:45:12 +02:00
|
|
|
#ifdef USE_CLOUD
|
2016-06-15 16:38:37 +06:00
|
|
|
#ifdef USE_SDL_NET
|
|
|
|
Networking::LocalWebserver::destroy();
|
|
|
|
#endif
|
2016-06-01 14:07:50 +06:00
|
|
|
#ifdef USE_LIBCURL
|
|
|
|
Networking::ConnectionManager::destroy();
|
2016-06-01 16:22:42 +06:00
|
|
|
//I think it's important to destroy it after ConnectionManager
|
|
|
|
Cloud::CloudManager::destroy();
|
2016-10-17 18:45:12 +02:00
|
|
|
#endif
|
2016-06-01 14:07:50 +06:00
|
|
|
#endif
|
2020-08-12 18:16:55 +05:30
|
|
|
PluginManager::instance().unloadDetectionPlugin();
|
2010-12-23 13:38:37 +00:00
|
|
|
PluginManager::instance().unloadAllPlugins();
|
2008-04-26 10:21:53 +00:00
|
|
|
PluginManager::destroy();
|
2010-11-01 20:41:53 +00:00
|
|
|
GUI::GuiManager::destroy();
|
2008-04-26 10:21:53 +00:00
|
|
|
Common::ConfigManager::destroy();
|
2012-03-28 19:16:29 +02:00
|
|
|
Common::DebugManager::destroy();
|
2016-10-26 23:20:30 +01:00
|
|
|
Common::OSDMessageQueue::destroy();
|
2013-07-06 23:54:45 -04:00
|
|
|
#ifdef ENABLE_EVENTRECORDER
|
2013-05-17 00:18:09 +03:00
|
|
|
GUI::EventRecorder::destroy();
|
2013-07-06 23:54:45 -04:00
|
|
|
#endif
|
2008-11-07 13:48:51 +00:00
|
|
|
Common::SearchManager::destroy();
|
2010-11-30 18:50:19 +00:00
|
|
|
#ifdef USE_TRANSLATION
|
2020-12-10 00:06:33 +01:00
|
|
|
Common::MainTranslationManager::destroy();
|
2010-11-30 18:50:19 +00:00
|
|
|
#endif
|
2012-03-28 19:16:29 +02:00
|
|
|
MusicManager::destroy();
|
|
|
|
Graphics::CursorManager::destroy();
|
|
|
|
Graphics::FontManager::destroy();
|
2012-03-28 19:17:53 +02:00
|
|
|
#ifdef USE_FREETYPE2
|
|
|
|
Graphics::shutdownTTF();
|
|
|
|
#endif
|
2012-09-18 00:01:36 +01:00
|
|
|
EngineManager::destroy();
|
2012-09-17 12:54:08 -04:00
|
|
|
Graphics::YUVToRGBManager::destroy();
|
2003-08-19 15:03:27 +00:00
|
|
|
|
2002-04-12 21:26:59 +00:00
|
|
|
return 0;
|
|
|
|
}
|