ScummVM API documentation
metaengine.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef ENGINES_METAENGINE_H
23#define ENGINES_METAENGINE_H
24
25#include "common/scummsys.h"
26#include "common/error.h"
27#include "common/array.h"
28#include "common/debug-channels.h"
29
30#include "engines/achievements.h"
31#include "engines/game.h"
32#include "engines/savestate.h"
33
34#include "base/plugins.h"
35
36class Engine;
37class OSystem;
38
39namespace Common {
40struct Action;
41class Keymap;
42class FSList;
43class OutSaveFile;
44class String;
45
46typedef SeekableReadStream InSaveFile;
47}
48
49namespace Graphics {
50struct Surface;
51}
52
53namespace GUI {
54class GuiObject;
55class OptionsContainerWidget;
56}
57
72 const char *label;
73 const char *tooltip;
74 const char *configOption;
76 byte groupId;
78};
79
84
88enum { kSavegameFilePattern = -99 };
89
90#define EXTENDED_SAVE_VERSION 4
91
96 char id[6];
97 uint8 version;
100 uint32 date;
101 uint16 time;
102 uint32 playtime;
107 memset(id, 0, 6);
108 version = 0;
109 date = 0;
110 time = 0;
111 playtime = 0;
112 thumbnail = nullptr;
113 isAutosave = false;
114 }
115};
116
128protected:
132 static Common::String escapeString(const char *string);
133
134public:
139 static const char GAME_NOT_IMPLEMENTED[];
140
141 virtual ~MetaEngineDetection() {}
142
144 virtual const char *getName() const override = 0;
145
147 virtual const char *getEngineName() const = 0;
148
150 virtual const char *getOriginalCopyright() const = 0;
151
153 virtual PlainGameList getSupportedGames() const = 0;
154
156 virtual PlainGameDescriptor findGame(const char *gameId) const = 0;
157
159 virtual Common::Error identifyGame(DetectedGame &game, const void **descriptor) = 0;
160
166 virtual DetectedGames detectGames(const Common::FSList &fslist, uint32 skipADFlags = 0, bool skipIncomplete = false) = 0;
167
169 virtual uint getMD5Bytes() const = 0;
170
172 virtual int getGameVariantCount() const {
173 return -1;
174 }
175
177 virtual void dumpDetectionEntries() const = 0;
178
186 virtual const DebugChannelDef *getDebugChannels() const {
187 return NULL;
188 }
189};
190
203class MetaEngine : public PluginObject {
204protected:
211
218 int findEmptySaveSlot(const char *target);
219
234 virtual const ExtraGuiOptions getExtraGuiOptions(const Common::String &target) const {
235 return ExtraGuiOptions();
236 }
237
238public:
239 virtual ~MetaEngine() {}
240
251 virtual const char *getName() const override = 0;
252
269 virtual Common::Error createInstance(OSystem *syst, Engine **engine, const DetectedGame &gameDescriptor, const void *meDescriptor) = 0;
270
283 virtual void deleteInstance(Engine *engine, const DetectedGame &gameDescriptor, const void *meDescriptor);
284
304 virtual SaveStateList listSaves(const char *target) const;
305
316 SaveStateList listSaves(const char *target, bool saveMode) const;
317
324 virtual int getAutosaveSlot() const {
325 return 0;
326 }
327
338 virtual int getMaximumSaveSlot() const {
339 // For games using the new save format, assume 99 slots by default
340 return hasFeature(kSavesUseExtendedFormat) ? 99 : 0;
341 }
342
355 virtual bool removeSaveState(const char *target, int slot) const;
356
366 virtual SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
367
376 virtual Common::String getSavegameFile(int saveGameIdx, const char *target = nullptr) const;
377
383 Common::String getSavegameFilePattern(const char *target = nullptr) const {
384 return getSavegameFile(kSavegameFilePattern, target);
385 }
386
390 virtual Common::Array<Common::Keymap *> initKeymaps(const char *target) const;
391
394 static bool hotspotsEnabled(const char *target);
395
402 virtual void registerDefaultSettings(const Common::String &target) const;
403
417
433
438
445
461
470
479
488
506
518 };
519
528
537
546 return nullptr;
547 }
548
554 virtual bool hasFeature(MetaEngineFeature f) const;
555
559 void appendExtendedSave(Common::OutSaveFile *saveFile, uint32 playtime, Common::String desc, bool isAutosave);
560
564 void appendExtendedSaveToStream(Common::WriteStream *saveFile, uint32 playtime, Common::String desc, bool isAutosave, uint32 offset = 0);
565
573 bool copySaveFileToFreeSlot(const char *target, int slot);
574
585
589 static void decodeSavegameDate(const ExtendedSavegameHeader *header, uint16 &outYear, uint8 &outMonth, uint8 &outDay);
590
594 static void decodeSavegameTime(const ExtendedSavegameHeader *header, uint8 &outHour, uint8 &outMinute);
595
599 WARN_UNUSED_RESULT static bool readSavegameHeader(Common::InSaveFile *in, ExtendedSavegameHeader *header, bool skipThumbnail = true);
600};
601
605class EngineManager : public Common::Singleton<EngineManager> {
606public:
613 DetectionResults detectGames(const Common::FSList &fslist, uint32 skipADFlags = 0, bool skipIncomplete = false);
614
616 const Plugin *findDetectionPlugin(const Common::String &engineId) const;
617
621 const PluginList &getPlugins(const PluginType fetchPluginType) const;
622
625
634
641
643 void upgradeTargetIfNecessary(const Common::String &target) const;
644
647
648private:
650 QualifiedGameList findGameInLoadedPlugins(const Common::String &gameId) const;
651
653 void upgradeTargetForEngineId(const Common::String &target) const;
654};
655
657#define EngineMan EngineManager::instance()
659#endif
Definition: error.h:81
Definition: fs.h:57
Definition: savefile.h:54
Definition: stream.h:745
Definition: singleton.h:42
Definition: str.h:59
Definition: stream.h:77
Definition: game.h:249
Definition: engine.h:155
Definition: metaengine.h:605
QualifiedGameDescriptor findTarget(const Common::String &target) const
Common::String generateUniqueDomain(const Common::String &gameId)
void upgradeTargetIfNecessary(const Common::String &target) const
const PluginList & getPlugins(const PluginType fetchPluginType) const
DetectionResults detectGames(const Common::FSList &fslist, uint32 skipADFlags=0, bool skipIncomplete=false)
const Plugin * findDetectionPlugin(const Common::String &engineId) const
Common::String createTargetForGame(const DetectedGame &game)
QualifiedGameList findGamesMatching(const Common::String &engineId, const Common::String &gameId) const
Definition: object.h:60
Definition: widget.h:590
Definition: metaengine.h:127
virtual const DebugChannelDef * getDebugChannels() const
Definition: metaengine.h:186
virtual uint getMD5Bytes() const =0
virtual Common::Error identifyGame(DetectedGame &game, const void **descriptor)=0
virtual void dumpDetectionEntries() const =0
virtual DetectedGames detectGames(const Common::FSList &fslist, uint32 skipADFlags=0, bool skipIncomplete=false)=0
virtual PlainGameDescriptor findGame(const char *gameId) const =0
virtual PlainGameList getSupportedGames() const =0
virtual int getGameVariantCount() const
Definition: metaengine.h:172
static Common::String escapeString(const char *string)
virtual const char * getOriginalCopyright() const =0
virtual const char * getEngineName() const =0
static const char GAME_NOT_IMPLEMENTED[]
Definition: metaengine.h:139
virtual const char * getName() const override=0
Definition: metaengine.h:203
int findEmptySaveSlot(const char *target)
virtual Common::String getSavegameFile(int saveGameIdx, const char *target=nullptr) const
virtual bool hasFeature(MetaEngineFeature f) const
virtual void registerDefaultSettings(const Common::String &target) const
static void parseSavegameHeader(ExtendedSavegameHeader *header, SaveStateDescriptor *desc)
Common::String getSavegameFilePattern(const char *target=nullptr) const
Definition: metaengine.h:383
static WARN_UNUSED_RESULT bool readSavegameHeader(Common::InSaveFile *in, ExtendedSavegameHeader *header, bool skipThumbnail=true)
virtual Common::Error createInstance(OSystem *syst, Engine **engine, const DetectedGame &gameDescriptor, const void *meDescriptor)=0
virtual int getMaximumSaveSlot() const
Definition: metaengine.h:338
static Common::Action * createHotspotAction()
virtual void deleteInstance(Engine *engine, const DetectedGame &gameDescriptor, const void *meDescriptor)
MetaEngineFeature
Definition: metaengine.h:424
@ kSavesUseExtendedFormat
Definition: metaengine.h:517
@ kSavesSupportThumbnail
Definition: metaengine.h:469
@ kSavesSupportCreationDate
Definition: metaengine.h:478
@ kSavesSupportMetaInfo
Definition: metaengine.h:460
@ kSavesSupportPlayTime
Definition: metaengine.h:487
@ kSimpleSavesNames
Definition: metaengine.h:505
@ kSupportsListSaves
Definition: metaengine.h:432
@ kSupportsLoadingDuringStartup
Definition: metaengine.h:437
@ kSupportsDeleteSave
Definition: metaengine.h:444
SaveStateList listSaves(const char *target, bool saveMode) const
virtual void getSavegameThumbnail(Graphics::Surface &thumb)
virtual Common::Array< Common::Keymap * > initKeymaps(const char *target) const
static void fillDummyHeader(ExtendedSavegameHeader *header)
virtual SaveStateList listSaves(const char *target) const
virtual bool removeSaveState(const char *target, int slot) const
static void decodeSavegameTime(const ExtendedSavegameHeader *header, uint8 &outHour, uint8 &outMinute)
virtual const char * getName() const override=0
virtual GUI::OptionsContainerWidget * buildEngineOptionsWidget(GUI::GuiObject *boss, const Common::String &name, const Common::String &target) const
static void decodeSavegameDate(const ExtendedSavegameHeader *header, uint16 &outYear, uint8 &outMonth, uint8 &outDay)
void appendExtendedSaveToStream(Common::WriteStream *saveFile, uint32 playtime, Common::String desc, bool isAutosave, uint32 offset=0)
bool copySaveFileToFreeSlot(const char *target, int slot)
virtual const ExtraGuiOptions getExtraGuiOptions(const Common::String &target) const
Definition: metaengine.h:234
virtual const Common::AchievementDescriptionList * getAchievementDescriptionList() const
Definition: metaengine.h:545
virtual SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const
virtual Common::AchievementsPlatform getAchievementsPlatform(const Common::String &target) const
void appendExtendedSave(Common::OutSaveFile *saveFile, uint32 playtime, Common::String desc, bool isAutosave)
virtual int getAutosaveSlot() const
Definition: metaengine.h:324
virtual const Common::AchievementsInfo getAchievementsInfo(const Common::String &target) const
Definition: system.h:166
Definition: game.h:64
Definition: plugins.h:157
Definition: plugins.h:143
Definition: savestate.h:56
AchievementsPlatform
Definition: achievements.h:46
SeekableReadStream InSaveFile
Definition: savefile.h:47
Common::Array< ExtraGuiOption > ExtraGuiOptions
Definition: metaengine.h:83
bool skipThumbnail(Common::SeekableReadStream &in)
Definition: algorithm.h:29
Definition: formatinfo.h:28
Definition: achievements.h:87
Definition: achievements.h:74
Definition: action.h:41
Definition: debug-channels.h:36
Definition: game.h:146
Definition: metaengine.h:95
bool isAutosave
Definition: metaengine.h:104
uint32 playtime
Definition: metaengine.h:102
Graphics::Surface * thumbnail
Definition: metaengine.h:103
uint16 time
Definition: metaengine.h:101
Common::String description
Definition: metaengine.h:99
uint8 version
Definition: metaengine.h:97
Common::String saveName
Definition: metaengine.h:98
uint32 date
Definition: metaengine.h:100
Definition: metaengine.h:71
const char * label
Definition: metaengine.h:72
byte groupLeaderId
Definition: metaengine.h:77
const char * configOption
Definition: metaengine.h:74
bool defaultState
Definition: metaengine.h:75
byte groupId
Definition: metaengine.h:76
const char * tooltip
Definition: metaengine.h:73
Definition: surface.h:67
Definition: game.h:49
Definition: game.h:79