mirror of
https://github.com/scummvm/scummvm.git
synced 2026-06-20 05:45:29 +00:00
Bartosz Gentkowski
ec24687ce4
Adding @defgroup and @ingroup doxygen tags into all headers in the common folder that contain doxygen blocks. This improves the structure, readability, and findability of information in the resulting output. This commit targets purely structure and does not deal with the content of the currently existing doxygen documentation.
100 lines
2.4 KiB
C++
100 lines
2.4 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.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_PLATFORM_H
|
|
#define COMMON_PLATFORM_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_platform Game platforms
|
|
* @ingroup common
|
|
*
|
|
* @brief API for managing game platforms.
|
|
* @{
|
|
*/
|
|
|
|
class String;
|
|
|
|
/**
|
|
* List of game platforms. Specifying a platform for a target can be used to
|
|
* give the game engines a hint for which platform the game data file are.
|
|
* This may be optional or required, depending on the game engine and the
|
|
* game in question.
|
|
*/
|
|
enum Platform {
|
|
kPlatformDOS,
|
|
kPlatformAmiga,
|
|
kPlatformAtari8Bit,
|
|
kPlatformAtariST,
|
|
kPlatformMacintosh,
|
|
kPlatformFMTowns,
|
|
kPlatformWindows,
|
|
kPlatformNES,
|
|
kPlatformC64,
|
|
kPlatformCoCo3,
|
|
kPlatformLinux,
|
|
kPlatformAcorn,
|
|
kPlatformSegaCD,
|
|
kPlatform3DO,
|
|
kPlatformPCEngine,
|
|
kPlatformApple2,
|
|
kPlatformApple2GS,
|
|
kPlatformPC98,
|
|
kPlatformWii,
|
|
kPlatformPSX,
|
|
kPlatformPS2,
|
|
kPlatformXbox,
|
|
kPlatformCDi,
|
|
kPlatformIOS,
|
|
kPlatformOS2,
|
|
kPlatformBeOS,
|
|
kPlatformPocketPC,
|
|
kPlatformMegaDrive,
|
|
|
|
kPlatformUnknown = -1
|
|
};
|
|
|
|
struct PlatformDescription {
|
|
const char *code;
|
|
const char *code2;
|
|
const char *abbrev;
|
|
const char *description;
|
|
Platform id;
|
|
};
|
|
|
|
extern const PlatformDescription g_platforms[];
|
|
|
|
/** Convert a string containing a platform name into a Platform enum value. */
|
|
extern Platform parsePlatform(const String &str);
|
|
extern const char *getPlatformCode(Platform id);
|
|
extern const char *getPlatformAbbrev(Platform id);
|
|
extern const char *getPlatformDescription(Platform id);
|
|
|
|
/** @} */
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|