Logo Search packages:      
Sourcecode: scummvm version File versions  Download package

commandLine.cpp

/* 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$
 *
 */

#include "engines/metaengine.h"
#include "base/commandLine.h"
#include "base/plugins.h"
#include "base/version.h"

#include "common/config-manager.h"
#include "common/system.h"
#include "common/textconsole.h"
#include "common/fs.h"

#include "gui/ThemeEngine.h"

#define DETECTOR_TESTING_HACK
#define UPGRADE_ALL_TARGETS_HACK

namespace Base {

#ifndef DISABLE_COMMAND_LINE

static const char USAGE_STRING[] =
      "%s: %s\n"
      "Usage: %s [OPTIONS]... [GAME]\n"
      "\n"
      "Try '%s --help' for more options.\n"
;

// DONT FIXME: DO NOT ORDER ALPHABETICALLY, THIS IS ORDERED BY IMPORTANCE/CATEGORY! :)
#if defined(__SYMBIAN32__) || defined(__GP32__) || defined(ANDROID) || defined(__DS__)
static const char HELP_STRING[] = "NoUsageString"; // save more data segment space
#else
static const char HELP_STRING[] =
      "ScummVM - Graphical Adventure Game Interpreter\n"
      "Usage: %s [OPTIONS]... [GAME]\n"
      "  -v, --version            Display ScummVM version information and exit\n"
      "  -h, --help               Display a brief help text and exit\n"
      "  -z, --list-games         Display list of supported games and exit\n"
      "  -t, --list-targets       Display list of configured targets and exit\n"
      "  --list-saves=TARGET      Display a list of savegames for the game (TARGET) specified\n"
      "\n"
      "  -c, --config=CONFIG      Use alternate configuration file\n"
      "  -p, --path=PATH          Path to where the game is installed\n"
      "  -x, --save-slot[=NUM]    Save game slot to load (default: autosave)\n"
      "  -f, --fullscreen         Force full-screen mode\n"
      "  -F, --no-fullscreen      Force windowed mode\n"
      "  -g, --gfx-mode=MODE      Select graphics scaler (1x,2x,3x,2xsai,super2xsai,\n"
      "                           supereagle,advmame2x,advmame3x,hq2x,hq3x,tv2x,\n"
      "                           dotmatrix)\n"
      "  --gui-theme=THEME        Select GUI theme\n"
      "  --themepath=PATH         Path to where GUI themes are stored\n"
      "  --list-themes            Display list of all usable GUI themes\n"
      "  -e, --music-driver=MODE  Select music driver (see README for details)\n"
      "  -q, --language=LANG      Select language (en,de,fr,it,pt,es,jp,zh,kr,se,gb,\n"
      "                           hb,ru,cz)\n"
      "  -m, --music-volume=NUM   Set the music volume, 0-255 (default: 192)\n"
      "  -s, --sfx-volume=NUM     Set the sfx volume, 0-255 (default: 192)\n"
      "  -r, --speech-volume=NUM  Set the speech volume, 0-255 (default: 192)\n"
      "  --midi-gain=NUM          Set the gain for MIDI playback, 0-1000 (default:\n"
      "                           100) (only supported by some MIDI drivers)\n"
      "  -n, --subtitles          Enable subtitles (use with games that have voice)\n"
      "  -b, --boot-param=NUM     Pass number to the boot script (boot param)\n"
      "  -d, --debuglevel=NUM     Set debug verbosity level\n"
      "  --debugflags=FLAGS       Enable engine specific debug flags\n"
      "                           (separated by commas)\n"
      "  -u, --dump-scripts       Enable script dumping if a directory called 'dumps'\n"
      "                           exists in the current directory\n"
      "\n"
      "  --cdrom=NUM              CD drive to play CD audio from (default: 0 = first\n"
      "                           drive)\n"
      "  --joystick[=NUM]         Enable joystick input (default: 0 = first joystick)\n"
      "  --platform=WORD          Specify platform of game (allowed values: 2gs, 3do,\n"
      "                           acorn, amiga, atari, c64, fmtowns, nes, mac, pc, pc98,\n"
      "                           pce, segacd, wii, windows)\n"
      "  --savepath=PATH          Path to where savegames are stored\n"
      "  --extrapath=PATH         Extra path to additional game data\n"
      "  --soundfont=FILE         Select the SoundFont for MIDI playback (only\n"
      "                           supported by some MIDI drivers)\n"
      "  --multi-midi             Enable combination AdLib and native MIDI\n"
      "  --native-mt32            True Roland MT-32 (disable GM emulation)\n"
      "  --enable-gs              Enable Roland GS mode for MIDI playback\n"
      "  --output-rate=RATE       Select output sample rate in Hz (e.g. 22050)\n"
      "  --opl-driver=DRIVER      Select AdLib (OPL) emulator (db, mame)\n"
      "  --aspect-ratio           Enable aspect ratio correction\n"
      "  --render-mode=MODE       Enable additional render modes (cga, ega, hercGreen,\n"
      "                           hercAmber, amiga)\n"
      "\n"
#if defined(ENABLE_SKY) || defined(ENABLE_QUEEN)
      "  --alt-intro              Use alternative intro for CD versions of Beneath a\n"
      "                           Steel Sky and Flight of the Amazon Queen\n"
#endif
      "  --copy-protection        Enable copy protection in SCUMM games, when\n"
      "                           ScummVM disables it by default.\n"
      "  --talkspeed=NUM          Set talk speed for games (default: 60)\n"
#if defined(ENABLE_SCUMM) || defined(ENABLE_GROOVIE)
      "  --demo-mode              Start demo mode of Maniac Mansion or The 7th Guest\n"
#endif
#ifdef ENABLE_SCUMM
      "  --tempo=NUM              Set music tempo (in percent, 50-200) for SCUMM games\n"
      "                           (default: 100)\n"
#ifdef ENABLE_SCUMM_7_8
      "  --dimuse-tempo=NUM       Set internal Digital iMuse tempo (10 - 100) per second\n"
      "                           (default: 10)\n"
#endif
#endif
      "\n"
      "The meaning of boolean long options can be inverted by prefixing them with\n"
      "\"no-\", e.g. \"--no-aspect-ratio\".\n"
;
#endif

static const char *s_appName = "scummvm";

static void usage(const char *s, ...) GCC_PRINTF(1, 2);

static void usage(const char *s, ...) {
      char buf[STRINGBUFLEN];
      va_list va;

      va_start(va, s);
      vsnprintf(buf, STRINGBUFLEN, s, va);
      va_end(va);

#if !(defined(__GP32__) || defined (__SYMBIAN32__) || defined(__DS__))
      printf(USAGE_STRING, s_appName, buf, s_appName, s_appName);
#endif
      exit(1);
}

#endif // DISABLE_COMMAND_LINE


void registerDefaults() {

      // Graphics
      ConfMan.registerDefault("fullscreen", false);
      ConfMan.registerDefault("aspect_ratio", false);
      ConfMan.registerDefault("disable_dithering", false);
      ConfMan.registerDefault("gfx_mode", "normal");
      ConfMan.registerDefault("render_mode", "default");
      ConfMan.registerDefault("desired_screen_aspect_ratio", "auto");

      // Sound & Music
      ConfMan.registerDefault("music_volume", 192);
      ConfMan.registerDefault("sfx_volume", 192);
      ConfMan.registerDefault("speech_volume", 192);

      ConfMan.registerDefault("music_mute", false);
      ConfMan.registerDefault("sfx_mute", false);
      ConfMan.registerDefault("speech_mute", false);
      ConfMan.registerDefault("mute", false);

      ConfMan.registerDefault("multi_midi", false);
      ConfMan.registerDefault("native_mt32", false);
      ConfMan.registerDefault("enable_gs", false);
      ConfMan.registerDefault("midi_gain", 100);
//    ConfMan.registerDefault("music_driver", ???);

      ConfMan.registerDefault("mt32_device", "null");
      ConfMan.registerDefault("gm_device", "null");

      ConfMan.registerDefault("cdrom", 0);

      // Game specific
      ConfMan.registerDefault("path", "");
      ConfMan.registerDefault("platform", Common::kPlatformPC);
      ConfMan.registerDefault("language", "en");
      ConfMan.registerDefault("subtitles", false);
      ConfMan.registerDefault("boot_param", 0);
      ConfMan.registerDefault("dump_scripts", false);
      ConfMan.registerDefault("save_slot", -1);
      ConfMan.registerDefault("autosave_period", 5 * 60);   // By default, trigger autosave every 5 minutes

#if defined(ENABLE_SCUMM) || defined(ENABLE_SWORD2)
      ConfMan.registerDefault("object_labels", true);
#endif

      ConfMan.registerDefault("copy_protection", false);
      ConfMan.registerDefault("talkspeed", 60);

#if defined(ENABLE_SCUMM) || defined(ENABLE_GROOVIE)
      ConfMan.registerDefault("demo_mode", false);
#endif
#ifdef ENABLE_SCUMM
      ConfMan.registerDefault("tempo", 0);
#ifdef ENABLE_SCUMM_7_8
      ConfMan.registerDefault("dimuse_tempo", 10);
#endif
#endif

#if defined(ENABLE_SKY) || defined(ENABLE_QUEEN)
      ConfMan.registerDefault("alt_intro", false);
#endif

      // Miscellaneous
      ConfMan.registerDefault("joystick_num", -1);
      ConfMan.registerDefault("confirm_exit", false);
      ConfMan.registerDefault("disable_sdl_parachute", false);

      ConfMan.registerDefault("record_mode", "none");
      ConfMan.registerDefault("record_file_name", "record.bin");
      ConfMan.registerDefault("record_temp_file_name", "record.tmp");
      ConfMan.registerDefault("record_time_file_name", "record.time");

#if 0
      // NEW CODE TO HIDE CONSOLE FOR WIN32
#ifdef WIN32
      // console hiding for win32
      ConfMan.registerDefault("show_console", false);
#endif
#endif
}

//
// Various macros used by the command line parser.
//

#ifndef DISABLE_COMMAND_LINE

// Use this for options which have an *optional* value
#define DO_OPTION_OPT(shortCmd, longCmd, defaultVal) \
      if (isLongCmd ? (!strcmp(s+2, longCmd) || !memcmp(s+2, longCmd"=", sizeof(longCmd"=") - 1)) : (tolower(s[1]) == shortCmd)) { \
            s += 2; \
            if (isLongCmd) { \
                  s += sizeof(longCmd) - 1; \
                  if (*s == '=') \
                        s++; \
            } \
            const char *option = s; \
            if (*s == '\0' && !isLongCmd) { option = s2; i++; } \
            if (!option || *option == '\0') option = defaultVal; \
            if (option) settings[longCmd] = option;

// Use this for options which have a required (string) value
#define DO_OPTION(shortCmd, longCmd) \
      DO_OPTION_OPT(shortCmd, longCmd, 0) \
      if (!option) usage("Option '%s' requires an argument", argv[isLongCmd ? i : i-1]);

// Use this for options which have a required integer value
#define DO_OPTION_INT(shortCmd, longCmd) \
      DO_OPTION(shortCmd, longCmd) \
      char *endptr = 0; \
      strtol(option, &endptr, 0); \
      if (endptr == NULL || *endptr != 0) usage("--%s: Invalid number '%s'", longCmd, option);

// Use this for boolean options; this distinguishes between "-x" and "-X",
// resp. between "--some-option" and "--no-some-option".
#define DO_OPTION_BOOL(shortCmd, longCmd) \
      if (isLongCmd ? (!strcmp(s+2, longCmd) || !strcmp(s+2, "no-"longCmd)) : (tolower(s[1]) == shortCmd)) { \
            bool boolValue = (islower(s[1]) != 0); \
            s += 2; \
            if (isLongCmd) { \
                  boolValue = !strcmp(s, longCmd); \
                  s += boolValue ? (sizeof(longCmd) - 1) : (sizeof("no-"longCmd) - 1); \
            } \
            if (*s != '\0') goto unknownOption; \
            const char *option = boolValue ? "true" : "false"; \
            settings[longCmd] = option;

// Use this for options which never have a value, i.e. for 'commands', like "--help".
#define DO_COMMAND(shortCmd, longCmd) \
      if (isLongCmd ? (!strcmp(s+2, longCmd)) : (tolower(s[1]) == shortCmd)) { \
            s += 2; \
            if (isLongCmd) \
                  s += sizeof(longCmd) - 1; \
            if (*s != '\0') goto unknownOption; \
            return longCmd;


#define DO_LONG_OPTION_OPT(longCmd, d)  DO_OPTION_OPT(0, longCmd, d)
#define DO_LONG_OPTION(longCmd)         DO_OPTION(0, longCmd)
#define DO_LONG_OPTION_INT(longCmd)     DO_OPTION_INT(0, longCmd)
#define DO_LONG_OPTION_BOOL(longCmd)    DO_OPTION_BOOL(0, longCmd)
#define DO_LONG_COMMAND(longCmd)        DO_COMMAND(0, longCmd)

// End an option handler
#define END_OPTION \
            continue; \
      }


Common::String parseCommandLine(Common::StringMap &settings, int argc, const char * const *argv) {
      const char *s, *s2;

      // argv[0] contains the name of the executable.
      if (argv && argv[0]) {
            s = strrchr(argv[0], '/');
            s_appName = s ? (s+1) : argv[0];
      }

      // We store all command line settings into a string map.

      // Iterate over all command line arguments and parse them into our string map.
      for (int i = 1; i < argc; ++i) {
            s = argv[i];
            s2 = (i < argc-1) ? argv[i+1] : 0;

            if (s[0] != '-') {
                  // The argument doesn't start with a dash, so it's not an option.
                  // Hence it must be the target name. We currently enforce that
                  // this always comes last.
                  if (i != argc - 1)
                        usage("Stray argument '%s'", s);

                  // We defer checking whether this is a valid target to a later point.
                  return s;
            } else {

                  bool isLongCmd = (s[0] == '-' && s[1] == '-');

                  DO_COMMAND('h', "help")
                  END_OPTION

                  DO_COMMAND('v', "version")
                  END_OPTION

                  DO_COMMAND('t', "list-targets")
                  END_OPTION

                  DO_COMMAND('z', "list-games")
                  END_OPTION

#ifdef DETECTOR_TESTING_HACK
                  // HACK FIXME TODO: This command is intentionally *not* documented!
                  DO_LONG_COMMAND("test-detector")
                  END_OPTION
#endif

#ifdef UPGRADE_ALL_TARGETS_HACK
                  // HACK FIXME TODO: This command is intentionally *not* documented!
                  DO_LONG_COMMAND("upgrade-targets")
                  END_OPTION
#endif

                  DO_LONG_OPTION("list-saves")
                        // FIXME: Need to document this.
                        // TODO: Make the argument optional. If no argument is given, list all savegames
                        // for all configured targets.
                        return "list-saves";
                  END_OPTION

                  DO_OPTION('c', "config")
                  END_OPTION

                  DO_OPTION_INT('b', "boot-param")
                  END_OPTION

                  DO_OPTION_OPT('d', "debuglevel", "0")
                  END_OPTION

                  DO_LONG_OPTION("debugflags")
                  END_OPTION

                  DO_OPTION('e', "music-driver")
                  END_OPTION

                  DO_LONG_OPTION_INT("output-rate")
                  END_OPTION

                  DO_OPTION_BOOL('f', "fullscreen")
                  END_OPTION

                  DO_LONG_OPTION("opl-driver")
                  END_OPTION

                  DO_OPTION('g', "gfx-mode")
                  END_OPTION

                  DO_OPTION_INT('m', "music-volume")
                  END_OPTION

                  DO_OPTION_BOOL('n', "subtitles")
                  END_OPTION

                  DO_OPTION('p', "path")
                        Common::FSNode path(option);
                        if (!path.exists()) {
                              usage("Non-existent game path '%s'", option);
                        } else if (!path.isReadable()) {
                              usage("Non-readable game path '%s'", option);
                        }
                  END_OPTION

                  DO_OPTION('q', "language")
                        if (Common::parseLanguage(option) == Common::UNK_LANG)
                              usage("Unrecognized language '%s'", option);
                  END_OPTION

                  DO_OPTION_INT('s', "sfx-volume")
                  END_OPTION

                  DO_OPTION_INT('r', "speech-volume")
                  END_OPTION

                  DO_LONG_OPTION_INT("midi-gain")
                  END_OPTION

                  DO_OPTION_BOOL('u', "dump-scripts")
                  END_OPTION

                  DO_OPTION_OPT('x', "save-slot", "0")
                  END_OPTION

                  DO_LONG_OPTION_INT("cdrom")
                  END_OPTION

                  DO_LONG_OPTION_OPT("joystick", "0")
                        settings["joystick_num"] = option;
                        settings.erase("joystick");
                  END_OPTION

                  DO_LONG_OPTION("platform")
                        int platform = Common::parsePlatform(option);
                        if (platform == Common::kPlatformUnknown)
                              usage("Unrecognized platform '%s'", option);
                  END_OPTION

                  DO_LONG_OPTION("soundfont")
                        Common::FSNode path(option);
                        if (!path.exists()) {
                              usage("Non-existent soundfont path '%s'", option);
                        } else if (!path.isReadable()) {
                              usage("Non-readable soundfont path '%s'", option);
                        }
                  END_OPTION

                  DO_LONG_OPTION_BOOL("disable-sdl-parachute")
                  END_OPTION

                  DO_LONG_OPTION_BOOL("multi-midi")
                  END_OPTION

                  DO_LONG_OPTION_BOOL("native-mt32")
                  END_OPTION

                  DO_LONG_OPTION_BOOL("enable-gs")
                  END_OPTION

                  DO_LONG_OPTION_BOOL("aspect-ratio")
                  END_OPTION

                  DO_LONG_OPTION("render-mode")
                        int renderMode = Common::parseRenderMode(option);
                        if (renderMode == Common::kRenderDefault)
                              usage("Unrecognized render mode '%s'", option);
                  END_OPTION

                  DO_LONG_OPTION("savepath")
                        Common::FSNode path(option);
                        if (!path.exists()) {
                              usage("Non-existent savegames path '%s'", option);
                        } else if (!path.isWritable()) {
                              usage("Non-writable savegames path '%s'", option);
                        }
                  END_OPTION

                  DO_LONG_OPTION("extrapath")
                        Common::FSNode path(option);
                        if (!path.exists()) {
                              usage("Non-existent extra path '%s'", option);
                        } else if (!path.isReadable()) {
                              usage("Non-readable extra path '%s'", option);
                        }
                  END_OPTION

                  DO_LONG_OPTION_INT("talkspeed")
                  END_OPTION

                  DO_LONG_OPTION_BOOL("copy-protection")
                  END_OPTION

                  DO_LONG_OPTION("gui-theme")
                  END_OPTION

                  DO_LONG_OPTION("themepath")
                        Common::FSNode path(option);
                        if (!path.exists()) {
                              usage("Non-existent theme path '%s'", option);
                        } else if (!path.isReadable()) {
                              usage("Non-readable theme path '%s'", option);
                        }
                  END_OPTION

                  DO_LONG_COMMAND("list-themes")
                  END_OPTION

                  DO_LONG_OPTION("target-md5")
                  END_OPTION

#ifdef ENABLE_SCUMM
                  DO_LONG_OPTION_INT("tempo")
                  END_OPTION
#ifdef ENABLE_SCUMM_7_8
                  DO_LONG_OPTION_INT("dimuse-tempo")
                  END_OPTION
#endif
#endif
#if defined(ENABLE_SCUMM) || defined(ENABLE_GROOVIE)
                  DO_LONG_OPTION_BOOL("demo-mode")
                  END_OPTION
#endif

#if defined(ENABLE_SKY) || defined(ENABLE_QUEEN)
                  DO_LONG_OPTION_BOOL("alt-intro")
                  END_OPTION
#endif

                  DO_LONG_OPTION("record-mode")
                  END_OPTION

                  DO_LONG_OPTION("record-file-name")
                  END_OPTION

                  DO_LONG_OPTION("record-temp-file-name")
                  END_OPTION

                  DO_LONG_OPTION("record-time-file-name")
                  END_OPTION

#ifdef IPHONE
                  // This is automatically set when launched from the Springboard.
                  DO_LONG_OPTION_OPT("launchedFromSB", 0)
                  END_OPTION
#endif

#if 0
      // NEW CODE TO HIDE CONSOLE FOR WIN32
#ifdef WIN32
                  // console hiding for win32
                  DO_LONG_OPTION_BOOL("show-console")
                  END_OPTION
#endif
#endif

unknownOption:
                  // If we get till here, the option is unhandled and hence unknown.
                  usage("Unrecognized option '%s'", argv[i]);
            }
      }

      return Common::String();
}

/** List all supported game IDs, i.e. all games which any loaded plugin supports. */
static void listGames() {
      printf("Game ID              Full Title                                            \n"
             "-------------------- ------------------------------------------------------\n");

      const EnginePlugin::List &plugins = EngineMan.getPlugins();
      EnginePlugin::List::const_iterator iter = plugins.begin();
      for (iter = plugins.begin(); iter != plugins.end(); ++iter) {
            GameList list = (**iter)->getSupportedGames();
            for (GameList::iterator v = list.begin(); v != list.end(); ++v) {
                  printf("%-20s %s\n", v->gameid().c_str(), v->description().c_str());
            }
      }
}

/** List all targets which are configured in the config file. */
static void listTargets() {
      printf("Target               Description                                           \n"
             "-------------------- ------------------------------------------------------\n");

      using namespace Common;
      const ConfigManager::DomainMap &domains = ConfMan.getGameDomains();
      ConfigManager::DomainMap::const_iterator iter;

      Common::Array<Common::String> targets;
      targets.reserve(domains.size());

      for (iter = domains.begin(); iter != domains.end(); ++iter) {
            Common::String name(iter->_key);
            Common::String description(iter->_value.getVal("description"));

            if (description.empty()) {
                  // FIXME: At this point, we should check for a "gameid" override
                  // to find the proper desc. In fact, the platform probably should
                  // be taken into account, too.
                  Common::String gameid(name);
                  GameDescriptor g = EngineMan.findGame(gameid);
                  if (g.description().size() > 0)
                        description = g.description();
            }

            targets.push_back(Common::String::format("%-20s %s", name.c_str(), description.c_str()));
      }

      Common::sort(targets.begin(), targets.end());

      for (Common::Array<Common::String>::const_iterator i = targets.begin(), end = targets.end(); i != end; ++i)
            printf("%s\n", i->c_str());
}

/** List all saves states for the given target. */
static Common::Error listSaves(const char *target) {
      Common::Error result = Common::kNoError;

      // FIXME HACK
      g_system->initBackend();

      // Grab the "target" domain, if any
      const Common::ConfigManager::Domain *domain = ConfMan.getDomain(target);

      // Set up the game domain as newly active domain, so
      // target specific savepath will be checked
      Common::String oldDomain = ConfMan.getActiveDomainName();
      ConfMan.setActiveDomain(target);

      // Grab the gameid from the domain resp. use the target as gameid
      Common::String gameid;
      if (domain)
            gameid = domain->getVal("gameid");
      if (gameid.empty())
            gameid = target;
      gameid.toLowercase();   // Normalize it to lower case

      // Find the plugin that will handle the specified gameid
      const EnginePlugin *plugin = 0;
      GameDescriptor game = EngineMan.findGame(gameid, &plugin);

      if (!plugin) {
            return Common::Error(Common::kEnginePluginNotFound,
                                    Common::String::format("target '%s', gameid '%s", target, gameid.c_str()));
      }

      if (!(*plugin)->hasFeature(MetaEngine::kSupportsListSaves)) {
            // TODO: Include more info about the target (desc, engine name, ...) ???
            return Common::Error(Common::kEnginePluginNotSupportSaves,
                                    Common::String::format("target '%s', gameid '%s", target, gameid.c_str()));
      } else {
            // Query the plugin for a list of savegames
            SaveStateList saveList = (*plugin)->listSaves(target);

            if (saveList.size() > 0) {
                  // TODO: Include more info about the target (desc, engine name, ...) ???
                  printf("Save states for target '%s' (gameid '%s'):\n", target, gameid.c_str());
                  printf("  Slot Description                                           \n"
                           "  ---- ------------------------------------------------------\n");

                  for (SaveStateList::const_iterator x = saveList.begin(); x != saveList.end(); ++x) {
                        printf("  %-4s %s\n", x->save_slot().c_str(), x->description().c_str());
                        // TODO: Could also iterate over the full hashmap, printing all key-value pairs
                  }
            } else {
                  printf("There are no save states for target '%s' (gameid '%s'):\n", target, gameid.c_str());
            }
      }

      // Revert to the old active domain
      ConfMan.setActiveDomain(oldDomain);

      return result;
}

/** Lists all usable themes */
static void listThemes() {
      typedef Common::List<GUI::ThemeEngine::ThemeDescriptor> ThList;
      ThList thList;
      GUI::ThemeEngine::listUsableThemes(thList);

      printf("Theme          Description\n");
      printf("-------------- ------------------------------------------------\n");

      for (ThList::const_iterator i = thList.begin(); i != thList.end(); ++i)
            printf("%-14s %s\n", i->id.c_str(), i->name.c_str());
}


#ifdef DETECTOR_TESTING_HACK
static void runDetectorTest() {
      // HACK: The following code can be used to test the detection code of our
      // engines. Basically, it loops over all targets, and calls the detector
      // for the given path. It then prints out the result and also checks
      // whether the result agrees with the settings of the target.

      const Common::ConfigManager::DomainMap &domains = ConfMan.getGameDomains();
      Common::ConfigManager::DomainMap::const_iterator iter = domains.begin();
      int success = 0, failure = 0;
      for (iter = domains.begin(); iter != domains.end(); ++iter) {
            Common::String name(iter->_key);
            Common::String gameid(iter->_value.getVal("gameid"));
            Common::String path(iter->_value.getVal("path"));
            printf("Looking at target '%s', gameid '%s', path '%s' ...\n",
                        name.c_str(), gameid.c_str(), path.c_str());
            if (path.empty()) {
                  printf(" ... no path specified, skipping\n");
                  continue;
            }
            if (gameid.empty()) {
                  gameid = name;
            }

            Common::FSNode dir(path);
            Common::FSList files;
            if (!dir.getChildren(files, Common::FSNode::kListAll)) {
                  printf(" ... invalid path, skipping\n");
                  continue;
            }

            GameList candidates(EngineMan.detectGames(files));
            bool gameidDiffers = false;
            GameList::iterator x;
            for (x = candidates.begin(); x != candidates.end(); ++x) {
                  gameidDiffers |= (scumm_stricmp(gameid.c_str(), x->gameid().c_str()) != 0);
            }

            if (candidates.empty()) {
                  printf(" FAILURE: No games detected\n");
                  failure++;
            } else if (candidates.size() > 1) {
                  if (gameidDiffers) {
                        printf(" WARNING: Multiple games detected, some/all with wrong gameid\n");
                  } else {
                        printf(" WARNING: Multiple games detected, but all have matching gameid\n");
                  }
                  failure++;
            } else if (gameidDiffers) {
                  printf(" FAILURE: Wrong gameid detected\n");
                  failure++;
            } else {
                  printf(" SUCCESS: Game was detected correctly\n");
                  success++;
            }

            for (x = candidates.begin(); x != candidates.end(); ++x) {
                  printf("    gameid '%s', desc '%s', language '%s', platform '%s'\n",
                           x->gameid().c_str(),
                           x->description().c_str(),
                           Common::getLanguageCode(x->language()),
                           Common::getPlatformCode(x->platform()));
            }
      }
      int total = domains.size();
      printf("Detector test run: %d fail, %d success, %d skipped, out of %d\n",
                  failure, success, total - failure - success, total);
}
#endif

#ifdef UPGRADE_ALL_TARGETS_HACK
void upgradeTargets() {
      // HACK: The following upgrades all your targets to the latest and
      // greatest. Right now that means updating the guioptions and (optionally)
      // also the game descriptions.
      // Basically, it loops over all targets, and calls the detector for the
      // given path. It then compares the result with the settings of the target.
      // If the basics seem to match, it updates the guioptions.

      printf("Upgrading all your existing targets\n");

      Common::ConfigManager::DomainMap &domains = ConfMan.getGameDomains();
      Common::ConfigManager::DomainMap::iterator iter = domains.begin();
      for (iter = domains.begin(); iter != domains.end(); ++iter) {
            Common::ConfigManager::Domain &dom = iter->_value;
            Common::String name(iter->_key);
            Common::String gameid(dom.getVal("gameid"));
            Common::String path(dom.getVal("path"));
            printf("Looking at target '%s', gameid '%s' ...\n",
                        name.c_str(), gameid.c_str());
            if (path.empty()) {
                  printf(" ... no path specified, skipping\n");
                  continue;
            }
            if (gameid.empty()) {
                  gameid = name;
            }
            gameid.toLowercase();   // TODO: Is this paranoia? Maybe we should just assume all lowercase, always?

            Common::FSNode dir(path);
            Common::FSList files;
            if (!dir.getChildren(files, Common::FSNode::kListAll)) {
                  printf(" ... invalid path, skipping\n");
                  continue;
            }

            Common::Language lang = Common::parseLanguage(dom.getVal("language"));
            Common::Platform plat = Common::parsePlatform(dom.getVal("platform"));
            Common::String desc(dom.getVal("description"));

            GameList candidates(EngineMan.detectGames(files));
            GameDescriptor *g = 0;

            // We proceed as follows:
            // * If detection failed to produce candidates, skip.
            // * If there is a unique detector match, trust it.
            // * If there are multiple match, run over them comparing gameid, language and platform.
            //   If we end up with a unique match, use it. Otherwise, skip.
            if (candidates.size() == 0) {
                  printf(" ... failed to detect game, skipping\n");
                  continue;
            }
            if (candidates.size() > 1) {
                  // Scan over all candidates, check if there is a unique match for gameid, language and platform
                  GameList::iterator x;
                  int matchesFound = 0;
                  for (x = candidates.begin(); x != candidates.end(); ++x) {
                        if (x->gameid() == gameid && x->language() == lang && x->platform() == plat) {
                              matchesFound++;
                              g = &(*x);
                        }
                  }
                  if (matchesFound != 1) {
                        printf(" ... detected multiple games, could not establish unique match, skipping\n");
                        continue;
                  }
            } else {
                  // Unique match -> use it
                  g = &candidates[0];
            }

            // At this point, g points to a GameDescriptor which we can use to update
            // the target referred to by dom. We update several things

            // Always set the gameid explicitly (in case of legacy targets)
            dom["gameid"] = g->gameid();

            // Always set the GUI options. The user should not modify them, and engines might
            // gain more features over time, so we want to keep this list up-to-date.
            if (g->contains("guioptions")) {
                  printf("  -> update guioptions to '%s'\n", (*g)["guioptions"].c_str());
                  dom["guioptions"] = (*g)["guioptions"];
            } else if (dom.contains("guioptions")) {
                  dom.erase("guioptions");
            }

            // Update the language setting but only if none has been set yet.
            if (lang == Common::UNK_LANG && g->language() != Common::UNK_LANG) {
                  printf("  -> set language to '%s'\n", Common::getLanguageCode(g->language()));
                  dom["language"] = (*g)["language"];
            }

            // Update the platform setting but only if none has been set yet.
            if (plat == Common::kPlatformUnknown && g->platform() != Common::kPlatformUnknown) {
                  printf("  -> set platform to '%s'\n", Common::getPlatformCode(g->platform()));
                  dom["platform"] = (*g)["platform"];
            }

            // TODO: We could also update the description. But not everybody will want that.
            // Esp. because for some games (e.g. the combined Zak/Loom FM-TOWNS demo etc.)
            // ScummVM still generates an incorrect description string. So, the description
            // should only be updated if the user explicitly requests this.
#if 0
            if (desc != g->description()) {
                  printf("  -> update desc from '%s' to\n                      '%s' ?\n", desc.c_str(), g->description().c_str());
                  dom["description"] = (*g)["description"];
            }
#endif
      }

      // Finally, save our changes to disk
      ConfMan.flushToDisk();
}
#endif

#else // DISABLE_COMMAND_LINE


Common::String parseCommandLine(Common::StringMap &settings, int argc, const char * const *argv) {
      return Common::String();
}


#endif // DISABLE_COMMAND_LINE


Common::Error processSettings(Common::String &command, Common::StringMap &settings) {

#ifndef DISABLE_COMMAND_LINE

      // Handle commands passed via the command line (like --list-targets and
      // --list-games). This must be done after the config file and the plugins
      // have been loaded.
      if (command == "list-targets") {
            listTargets();
            return Common::kNoError;
      } else if (command == "list-games") {
            listGames();
            return Common::kNoError;
      } else if (command == "list-saves") {
            return listSaves(settings["list-saves"].c_str());
      } else if (command == "list-themes") {
            listThemes();
            return Common::kNoError;
      } else if (command == "version") {
            printf("%s\n", gScummVMFullVersion);
            printf("Features compiled in: %s\n", gScummVMFeatures);
            return Common::kNoError;
      } else if (command == "help") {
            printf(HELP_STRING, s_appName);
            return Common::kNoError;
      }
#ifdef DETECTOR_TESTING_HACK
      else if (command == "test-detector") {
            runDetectorTest();
            return Common::kNoError;
      }
#endif
#ifdef UPGRADE_ALL_TARGETS_HACK
      else if (command == "upgrade-targets") {
            upgradeTargets();
            return Common::kNoError;
      }
#endif

#endif // DISABLE_COMMAND_LINE


      // If a target was specified, check whether there is either a game
      // domain (i.e. a target) matching this argument, or alternatively
      // whether there is a gameid matching that name.
      if (!command.empty()) {
            GameDescriptor gd = EngineMan.findGame(command);
            if (ConfMan.hasGameDomain(command) || !gd.gameid().empty()) {
                  bool idCameFromCommandLine = false;

                  // WORKAROUND: Fix for bug #1719463: "DETECTOR: Launching
                  // undefined target adds launcher entry"
                  //
                  // We designate gameids which come strictly from command line
                  // so AdvancedDetector will not save config file with invalid
                  // gameid in case target autoupgrade was performed
                  if (!ConfMan.hasGameDomain(command)) {
                        idCameFromCommandLine = true;
                  }

                  ConfMan.setActiveDomain(command);

                  if (idCameFromCommandLine)
                        ConfMan.set("id_came_from_command_line", "1");

            } else {
#ifndef DISABLE_COMMAND_LINE
                  usage("Unrecognized game target '%s'", command.c_str());
#endif // DISABLE_COMMAND_LINE
            }
      }


      // The user can override the savepath with the SCUMMVM_SAVEPATH
      // environment variable. This is weaker than a --savepath on the
      // command line, but overrides the default savepath, hence it is
      // handled here, just before the command line gets parsed.
#if !defined(_WIN32_WCE) && !defined(__GP32__) && !defined(ANDROID) && !defined(__DS__)
      if (!settings.contains("savepath")) {
            const char *dir = getenv("SCUMMVM_SAVEPATH");
            if (dir && *dir && strlen(dir) < MAXPATHLEN) {
                  Common::FSNode saveDir(dir);
                  if (!saveDir.exists()) {
                        warning("Non-existent SCUMMVM_SAVEPATH save path. It will be ignored");
                  } else if (!saveDir.isWritable()) {
                        warning("Non-writable SCUMMVM_SAVEPATH save path. It will be ignored");
                  } else {
                        settings["savepath"] = dir;
                  }
            }
      }
#endif

      // Finally, store the command line settings into the config manager.
      for (Common::StringMap::const_iterator x = settings.begin(); x != settings.end(); ++x) {
            Common::String key(x->_key);
            Common::String value(x->_value);

            // Replace any "-" in the key by "_" (e.g. change "save-slot" to "save_slot").
            for (Common::String::iterator c = key.begin(); c != key.end(); ++c)
                  if (*c == '-')
                        *c = '_';

            // Store it into ConfMan.
            ConfMan.set(key, value, Common::ConfigManager::kTransientDomain);
      }

      return Common::kArgumentNotProcessed;
}

} // End of namespace Base

Generated by  Doxygen 1.6.0   Back to index