ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Base Namespace Reference

Functions

static void NORETURN_PRE usage (const char *s,...) GCC_PRINTF(1
static void ensureFirstCommand (const Common::String &existingCommand, const char *newCommand)
static Common::String buildQualifiedGameName (const Common::String &engineId, const Common::String &gameId)
void registerDefaults ()
 Register various defaults with the ConfigManager.
static bool parseGameName (const Common::String &gameName, Common::String &engineId, Common::String &gameId)
static QualifiedGameDescriptor findGameMatchingName (const Common::String &name)
static Common::String createTemporaryTarget (const Common::String &engineId, const Common::String &gameId)
Common::String parseCommandLine (Common::StringMap &settings, int argc, const char *const *argv)
 Parse the command line for options and a command; the options are stored in the map 'settings, the command (if any) is returned.
static void listGames ()
 List all supported game IDs, i.e.
static void listEngines ()
 List all supported engines, i.e.
static void listTargets ()
 List all targets which are configured in the config file.
static Common::Error listSaves (const Common::String &singleTarget)
 List all saves states for the given target.
static void listThemes ()
 Lists all usable themes.
static void listAudioDevices ()
 Lists all output devices.
static DetectedGames getGameList (const Common::FSNode &dir)
 Display all games in the given directory, or current directory if empty.
static DetectedGames recListGames (const Common::FSNode &dir, const Common::String &engineId, const Common::String &gameId, bool recursive)
static Common::String detectGames (const Common::String &path, const Common::String &engineId, const Common::String &gameId, bool recursive)
 Display all games in the given directory, return ID of first detected game.
static int recAddGames (const Common::FSNode &dir, const Common::String &engineId, const Common::String &gameId, bool recursive)
static bool addGames (const Common::String &path, const Common::String &engineId, const Common::String &gameId, bool recursive)
static void runDetectorTest ()
void upgradeTargets ()
bool processSettings (Common::String &command, Common::StringMap &settings, Common::Error &err)
 Process the command line options and arguments.

Variables

static const char USAGE_STRING [] = "Try '%s --help' for more options.\n"
static const char HELP_STRING [] = "\"no-\", e.g. \"--no-aspect-ratio\".\n"
static const char * s_appName = "residualvm"
static void NORETURN_PRE NORETURN_POST

Function Documentation

static bool Base::addGames ( const Common::String path,
const Common::String engineId,
const Common::String gameId,
bool  recursive 
) [static]

Definition at line 1155 of file commandLine.cpp.

static Common::String Base::buildQualifiedGameName ( const Common::String engineId,
const Common::String gameId 
) [static]

Definition at line 239 of file commandLine.cpp.

static Common::String Base::createTemporaryTarget ( const Common::String engineId,
const Common::String gameId 
) [static]

Definition at line 417 of file commandLine.cpp.

static Common::String Base::detectGames ( const Common::String path,
const Common::String engineId,
const Common::String gameId,
bool  recursive 
) [static]

Display all games in the given directory, return ID of first detected game.

Definition at line 1086 of file commandLine.cpp.

static void Base::ensureFirstCommand ( const Common::String existingCommand,
const char *  newCommand 
) [static]

Definition at line 234 of file commandLine.cpp.

static QualifiedGameDescriptor Base::findGameMatchingName ( const Common::String name  )  [static]

Definition at line 396 of file commandLine.cpp.

static DetectedGames Base::getGameList ( const Common::FSNode dir  )  [static]

Display all games in the given directory, or current directory if empty.

Definition at line 1046 of file commandLine.cpp.

static void Base::listAudioDevices (  )  [static]

Lists all output devices.

Definition at line 1030 of file commandLine.cpp.

static void Base::listEngines (  )  [static]

List all supported engines, i.e.

all loaded plugins.

Definition at line 873 of file commandLine.cpp.

static void Base::listGames (  )  [static]

List all supported game IDs, i.e.

all games which any loaded plugin supports.

Definition at line 857 of file commandLine.cpp.

static Common::Error Base::listSaves ( const Common::String singleTarget  )  [static]

List all saves states for the given target.

Definition at line 919 of file commandLine.cpp.

static void Base::listTargets (  )  [static]

List all targets which are configured in the config file.

Definition at line 885 of file commandLine.cpp.

static void Base::listThemes (  )  [static]

Lists all usable themes.

Definition at line 1017 of file commandLine.cpp.

Common::String Base::parseCommandLine ( Common::StringMap settings,
int  argc,
const char *const *  argv 
)

Parse the command line for options and a command; the options are stored in the map 'settings, the command (if any) is returned.

static bool Base::parseGameName ( const Common::String gameName,
Common::String engineId,
Common::String gameId 
) [static]

Definition at line 367 of file commandLine.cpp.

bool Base::processSettings ( Common::String command,
Common::StringMap settings,
Common::Error err 
)

Process the command line options and arguments.

Returns true if everything was handled and ScummVM should quit (e.g. because "--help" was specified, and handled).

Parameters:
[in] command the command as returned by parseCommandLine
[in] settings the settings as returned by parseCommandLine
[out] err indicates whether any error occurred, and which
Returns:
true if the command was completely processed and ScummVM should quit, false otherwise
static int Base::recAddGames ( const Common::FSNode dir,
const Common::String engineId,
const Common::String gameId,
bool  recursive 
) [static]

Definition at line 1115 of file commandLine.cpp.

static DetectedGames Base::recListGames ( const Common::FSNode dir,
const Common::String engineId,
const Common::String gameId,
bool  recursive 
) [static]

Definition at line 1066 of file commandLine.cpp.

void Base::registerDefaults (  ) 

Register various defaults with the ConfigManager.

static void Base::runDetectorTest (  )  [static]

Definition at line 1168 of file commandLine.cpp.

void Base::upgradeTargets (  ) 

Definition at line 1240 of file commandLine.cpp.

static void Base::usage ( const char *  s,
  ... 
) [static]

Definition at line 220 of file commandLine.cpp.


Variable Documentation

const char Base::HELP_STRING[] = "\"no-\", e.g. \"--no-aspect-ratio\".\n" [static]

Definition at line 66 of file commandLine.cpp.

void NORETURN_PRE Base::NORETURN_POST

Definition at line 218 of file commandLine.cpp.

const char* Base::s_appName = "residualvm" [static]

Definition at line 216 of file commandLine.cpp.

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

Definition at line 55 of file commandLine.cpp.



Generated on Sat Aug 1 2020 05:03:31 for ResidualVM by doxygen 1.7.1
curved edge   curved edge