mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-04 16:26:53 +00:00
114 lines
4.1 KiB
C++
114 lines
4.1 KiB
C++
/* 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$
|
|
*
|
|
*/
|
|
|
|
#ifndef ENGINES_GAME_H
|
|
#define ENGINES_GAME_H
|
|
|
|
#include "common/array.h"
|
|
#include "common/hash-str.h"
|
|
#include "engines/savestate.h" // TODO: Push this #include out to .cpp files needing it
|
|
|
|
/**
|
|
* A simple structure used to map gameids (like "monkey", "sword1", ...) to
|
|
* nice human readable and descriptive game titles (like "The Secret of Monkey Island").
|
|
* This is a plain struct to make it possible to declare NULL-terminated C arrays
|
|
* consisting of PlainGameDescriptors.
|
|
*/
|
|
struct PlainGameDescriptor {
|
|
const char *gameid;
|
|
const char *description;
|
|
};
|
|
|
|
/**
|
|
* Same as PlainGameDsscriptor except it adds Game GUI options parameter
|
|
* This is a plain struct to make it possible to declare NULL-terminated C arrays
|
|
* consisting of PlainGameDescriptors.
|
|
*/
|
|
struct PlainGameDescriptorGUIOpts {
|
|
const char *gameid;
|
|
const char *description;
|
|
uint32 guioptions;
|
|
};
|
|
|
|
/**
|
|
* Given a list of PlainGameDescriptors, returns the first PlainGameDescriptor
|
|
* matching the given gameid. If not match is found return 0.
|
|
* The end of the list must marked by a PlainGameDescriptor with gameid equal to 0.
|
|
*/
|
|
const PlainGameDescriptor *findPlainGameDescriptor(const char *gameid, const PlainGameDescriptor *list);
|
|
|
|
/**
|
|
* A hashmap describing details about a given game. In a sense this is a refined
|
|
* version of PlainGameDescriptor, as it also contains a gameid and a description string.
|
|
* But in addition, platform and language settings, as well as arbitrary other settings,
|
|
* can be contained in a GameDescriptor.
|
|
* This is an essential part of the glue between the game engines and the launcher code.
|
|
*/
|
|
class GameDescriptor : public Common::StringMap {
|
|
public:
|
|
GameDescriptor();
|
|
GameDescriptor(const PlainGameDescriptor &pgd);
|
|
GameDescriptor(const PlainGameDescriptorGUIOpts &pgd);
|
|
GameDescriptor(const Common::String &gameid,
|
|
const Common::String &description,
|
|
Common::Language language = Common::UNK_LANG,
|
|
Common::Platform platform = Common::kPlatformUnknown,
|
|
uint32 guioptions = 0);
|
|
|
|
/**
|
|
* Update the description string by appending (LANG/PLATFORM/EXTRA) to it.
|
|
*/
|
|
void updateDesc(const char *extra = 0);
|
|
|
|
void setGUIOptions(uint32 options);
|
|
void appendGUIOptions(const Common::String &str);
|
|
|
|
Common::String &gameid() { return getVal("gameid"); }
|
|
Common::String &description() { return getVal("description"); }
|
|
const Common::String &gameid() const { return getVal("gameid"); }
|
|
const Common::String &description() const { return getVal("description"); }
|
|
Common::Language language() const { return contains("language") ? Common::parseLanguage(getVal("language")) : Common::UNK_LANG; }
|
|
Common::Platform platform() const { return contains("platform") ? Common::parsePlatform(getVal("platform")) : Common::kPlatformUnknown; }
|
|
|
|
const Common::String &preferredtarget() const {
|
|
return contains("preferredtarget") ? getVal("preferredtarget") : getVal("gameid");
|
|
}
|
|
};
|
|
|
|
/** List of games. */
|
|
class GameList : public Common::Array<GameDescriptor> {
|
|
public:
|
|
GameList() {}
|
|
GameList(const GameList &list) : Common::Array<GameDescriptor>(list) {}
|
|
GameList(const PlainGameDescriptor *g) {
|
|
while (g->gameid) {
|
|
push_back(GameDescriptor(g->gameid, g->description));
|
|
g++;
|
|
}
|
|
}
|
|
};
|
|
|
|
#endif
|