AGOS: Split detection code & adapt to new plugins.

- Move AGOSGameDescription -> detection.h
- Move obsoleteGameIDsTable -> obsolete.h
- Both the above points are because the detection needs them, as well as the engine.
- By moving to headers in this pattern, we avoid many unnecessary inclusions and keep everything clean.
This commit is contained in:
aryanrawlani28 2020-08-05 00:20:50 +05:30 committed by Eugene Sandulenko
parent 5850987077
commit 2f6453100b
6 changed files with 295 additions and 204 deletions

2
configure vendored
View File

@ -6162,7 +6162,7 @@ done
declare -a static_detect_engines=("PLUMBERS" "AGI" "SCUMM" "SKY" "DREAMWEB" "DRASCULA" "LURE"
"SWORD1" "SWORD2" "SWORD25" "ADL" "QUEEN" "CGE" "CGE2" "ACCESS"
"ZVISION")
"ZVISION" "AGOS")
detectId="_DETECTION"
echo "Creating engines/plugins_table.h"

View File

@ -24,46 +24,21 @@
#include "engines/advancedDetector.h"
#include "engines/obsolete.h"
#include "common/config-manager.h"
#include "common/savefile.h"
#include "common/system.h"
#include "common/textconsole.h"
#include "common/installshield_cab.h"
#include "agos/intern.h"
#include "agos/agos.h"
namespace AGOS {
struct AGOSGameDescription {
ADGameDescription desc;
int gameType;
int gameId;
uint32 features;
};
}
#include "agos/detection.h"
#include "agos/detection_enums.h"
#include "agos/intern_detection.h"
#include "agos/obsolete.h" // Obsolete ID table.
/**
* Conversion table mapping old obsolete target names to the
* corresponding new target and platform combination.
*
*/
static const Engines::ObsoleteGameID obsoleteGameIDsTable[] = {
{"simon1acorn", "simon1", Common::kPlatformAcorn},
{"simon1amiga", "simon1", Common::kPlatformAmiga},
{"simon1cd32", "simon1", Common::kPlatformAmiga},
{"simon1demo", "simon1", Common::kPlatformDOS},
{"simon1dos", "simon1", Common::kPlatformDOS},
{"simon1talkie", "simon1", Common::kPlatformDOS},
{"simon1win", "simon1", Common::kPlatformWindows},
{"simon2dos", "simon2", Common::kPlatformDOS},
{"simon2talkie", "simon2", Common::kPlatformDOS},
{"simon2mac", "simon2", Common::kPlatformMacintosh},
{"simon2win", "simon2", Common::kPlatformWindows},
{0, 0, Common::kPlatformUnknown}
};
static const PlainGameDescriptor agosGames[] = {
{"pn", "Personal Nightmare"},
@ -114,177 +89,6 @@ public:
const char *getOriginalCopyright() const override {
return "AGOS (C) Adventure Soft";
}
bool hasFeature(MetaEngineFeature f) const override;
Common::Error createInstance(OSystem *syst, Engine **engine) const override {
Engines::upgradeTargetIfNecessary(obsoleteGameIDsTable);
return AdvancedMetaEngine::createInstance(syst, engine);
}
bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const override;
SaveStateList listSaves(const char *target) const override;
int getMaximumSaveSlot() const override;
};
bool AgosMetaEngine::hasFeature(MetaEngineFeature f) const {
return
(f == kSupportsListSaves) ||
(f == kSimpleSavesNames);
}
bool AGOS::AGOSEngine::hasFeature(EngineFeature f) const {
return
(f == kSupportsReturnToLauncher);
}
bool AgosMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
const AGOS::AGOSGameDescription *gd = (const AGOS::AGOSGameDescription *)desc;
bool res = true;
switch (gd->gameType) {
case AGOS::GType_PN:
*engine = new AGOS::AGOSEngine_PN(syst, gd);
break;
case AGOS::GType_ELVIRA1:
*engine = new AGOS::AGOSEngine_Elvira1(syst, gd);
break;
case AGOS::GType_ELVIRA2:
*engine = new AGOS::AGOSEngine_Elvira2(syst, gd);
break;
case AGOS::GType_WW:
*engine = new AGOS::AGOSEngine_Waxworks(syst, gd);
break;
case AGOS::GType_SIMON1:
*engine = new AGOS::AGOSEngine_Simon1(syst, gd);
break;
case AGOS::GType_SIMON2:
*engine = new AGOS::AGOSEngine_Simon2(syst, gd);
break;
#ifdef ENABLE_AGOS2
case AGOS::GType_FF:
if (gd->features & GF_DEMO)
*engine = new AGOS::AGOSEngine_FeebleDemo(syst, gd);
else
*engine = new AGOS::AGOSEngine_Feeble(syst, gd);
break;
case AGOS::GType_PP:
if (gd->gameId == GID_DIMP)
*engine = new AGOS::AGOSEngine_DIMP(syst, gd);
else
*engine = new AGOS::AGOSEngine_PuzzlePack(syst, gd);
break;
#endif
default:
res = false;
error("AGOS engine: unknown gameType");
}
return res;
}
SaveStateList AgosMetaEngine::listSaves(const char *target) const {
Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
Common::StringArray filenames;
Common::String saveDesc;
Common::String pattern = target;
pattern += ".###";
filenames = saveFileMan->listSavefiles(pattern);
SaveStateList saveList;
for (Common::StringArray::const_iterator file = filenames.begin(); file != filenames.end(); ++file) {
// Obtain the last 3 digits of the filename, since they correspond to the save slot
int slotNum = atoi(file->c_str() + file->size() - 3);
if (slotNum >= 0 && slotNum <= 999) {
Common::InSaveFile *in = saveFileMan->openForLoading(*file);
if (in) {
saveDesc = file->c_str();
saveList.push_back(SaveStateDescriptor(slotNum, saveDesc));
delete in;
}
}
}
// Sort saves based on slot number.
Common::sort(saveList.begin(), saveList.end(), SaveStateDescriptorSlotComparator());
return saveList;
}
int AgosMetaEngine::getMaximumSaveSlot() const { return 999; }
#if PLUGIN_ENABLED_DYNAMIC(AGOS)
REGISTER_PLUGIN_DYNAMIC(AGOS, PLUGIN_TYPE_ENGINE, AgosMetaEngine);
#else
REGISTER_PLUGIN_STATIC(AGOS, PLUGIN_TYPE_ENGINE, AgosMetaEngine);
#endif
namespace AGOS {
int AGOSEngine::getGameId() const {
return _gameDescription->gameId;
}
int AGOSEngine::getGameType() const {
return _gameDescription->gameType;
}
uint32 AGOSEngine::getFeatures() const {
return _gameDescription->features;
}
const char *AGOSEngine::getExtra() const {
return _gameDescription->desc.extra;
}
Common::Language AGOSEngine::getLanguage() const {
return _gameDescription->desc.language;
}
Common::Platform AGOSEngine::getPlatform() const {
return _gameDescription->desc.platform;
}
const char *AGOSEngine::getFileName(int type) const {
// Required if the InstallShield cab is been used
if (getGameType() == GType_PP) {
if (type == GAME_BASEFILE)
return gss->base_filename;
}
// Required if the InstallShield cab is been used
if (getGameType() == GType_FF && getPlatform() == Common::kPlatformWindows) {
if (type == GAME_BASEFILE)
return gss->base_filename;
if (type == GAME_RESTFILE)
return gss->restore_filename;
if (type == GAME_TBLFILE)
return gss->tbl_filename;
}
for (int i = 0; _gameDescription->desc.filesDescriptions[i].fileType; i++) {
if (_gameDescription->desc.filesDescriptions[i].fileType == type)
return _gameDescription->desc.filesDescriptions[i].fileName;
}
return NULL;
}
#ifdef ENABLE_AGOS2
void AGOSEngine::loadArchives() {
const ADGameFileDescription *ag;
if (getFeatures() & GF_PACKED) {
for (ag = _gameDescription->desc.filesDescriptions; ag->fileName; ag++) {
if (!SearchMan.hasArchive(ag->fileName)) {
Common::SeekableReadStream *stream = SearchMan.createReadStreamForMember(ag->fileName);
if (stream)
SearchMan.add(ag->fileName, Common::makeInstallShieldArchive(stream, DisposeAfterUse::YES), ag->fileType);
}
}
}
}
#endif
} // End of namespace AGOS
REGISTER_PLUGIN_STATIC(AGOS_DETECTION, PLUGIN_TYPE_METAENGINE, AgosMetaEngine);

33
engines/agos/detection.h Normal file
View File

@ -0,0 +1,33 @@
/* 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.
*
*/
namespace AGOS {
struct AGOSGameDescription {
ADGameDescription desc;
int gameType;
int gameId;
uint32 features;
};
} // End of namespace AGOS

214
engines/agos/metaengine.cpp Normal file
View File

@ -0,0 +1,214 @@
/* 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.
*
*/
#include "common/config-manager.h"
#include "common/savefile.h"
#include "common/system.h"
#include "common/installshield_cab.h"
#include "engines/advancedDetector.h"
#include "engines/obsolete.h"
#include "agos/intern.h"
#include "agos/agos.h"
#include "agos/detection.h"
#include "agos/obsolete.h"
class AgosMetaEngineConnect : public AdvancedMetaEngineConnect {
public:
const char *getName() const override {
return "agos";
}
bool hasFeature(MetaEngineFeature f) const override;
Common::Error createInstance(OSystem *syst, Engine **engine) const override {
Engines::upgradeTargetIfNecessary(obsoleteGameIDsTable);
return AdvancedMetaEngineConnect::createInstance(syst, engine);
}
bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const override;
SaveStateList listSaves(const char *target) const override;
int getMaximumSaveSlot() const override;
};
bool AgosMetaEngineConnect::hasFeature(MetaEngineFeature f) const {
return
(f == kSupportsListSaves) ||
(f == kSimpleSavesNames);
}
bool AGOS::AGOSEngine::hasFeature(EngineFeature f) const {
return
(f == kSupportsReturnToLauncher);
}
bool AgosMetaEngineConnect::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
const AGOS::AGOSGameDescription *gd = (const AGOS::AGOSGameDescription *)desc;
bool res = true;
switch (gd->gameType) {
case AGOS::GType_PN:
*engine = new AGOS::AGOSEngine_PN(syst, gd);
break;
case AGOS::GType_ELVIRA1:
*engine = new AGOS::AGOSEngine_Elvira1(syst, gd);
break;
case AGOS::GType_ELVIRA2:
*engine = new AGOS::AGOSEngine_Elvira2(syst, gd);
break;
case AGOS::GType_WW:
*engine = new AGOS::AGOSEngine_Waxworks(syst, gd);
break;
case AGOS::GType_SIMON1:
*engine = new AGOS::AGOSEngine_Simon1(syst, gd);
break;
case AGOS::GType_SIMON2:
*engine = new AGOS::AGOSEngine_Simon2(syst, gd);
break;
#ifdef ENABLE_AGOS2
case AGOS::GType_FF:
if (gd->features & AGOS::GF_DEMO)
*engine = new AGOS::AGOSEngine_FeebleDemo(syst, gd);
else
*engine = new AGOS::AGOSEngine_Feeble(syst, gd);
break;
case AGOS::GType_PP:
if (gd->gameId == AGOS::GID_DIMP)
*engine = new AGOS::AGOSEngine_DIMP(syst, gd);
else
*engine = new AGOS::AGOSEngine_PuzzlePack(syst, gd);
break;
#endif
default:
res = false;
error("AGOS engine: unknown gameType");
}
return res;
}
SaveStateList AgosMetaEngineConnect::listSaves(const char *target) const {
Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
Common::StringArray filenames;
Common::String saveDesc;
Common::String pattern = target;
pattern += ".###";
filenames = saveFileMan->listSavefiles(pattern);
SaveStateList saveList;
for (Common::StringArray::const_iterator file = filenames.begin(); file != filenames.end(); ++file) {
// Obtain the last 3 digits of the filename, since they correspond to the save slot
int slotNum = atoi(file->c_str() + file->size() - 3);
if (slotNum >= 0 && slotNum <= 999) {
Common::InSaveFile *in = saveFileMan->openForLoading(*file);
if (in) {
saveDesc = file->c_str();
saveList.push_back(SaveStateDescriptor(slotNum, saveDesc));
delete in;
}
}
}
// Sort saves based on slot number.
Common::sort(saveList.begin(), saveList.end(), SaveStateDescriptorSlotComparator());
return saveList;
}
int AgosMetaEngineConnect::getMaximumSaveSlot() const { return 999; }
#if PLUGIN_ENABLED_DYNAMIC(AGOS)
REGISTER_PLUGIN_DYNAMIC(AGOS, PLUGIN_TYPE_ENGINE, AgosMetaEngineConnect);
#else
REGISTER_PLUGIN_STATIC(AGOS, PLUGIN_TYPE_ENGINE, AgosMetaEngineConnect);
#endif
namespace AGOS {
int AGOSEngine::getGameId() const {
return _gameDescription->gameId;
}
int AGOSEngine::getGameType() const {
return _gameDescription->gameType;
}
uint32 AGOSEngine::getFeatures() const {
return _gameDescription->features;
}
const char *AGOSEngine::getExtra() const {
return _gameDescription->desc.extra;
}
Common::Language AGOSEngine::getLanguage() const {
return _gameDescription->desc.language;
}
Common::Platform AGOSEngine::getPlatform() const {
return _gameDescription->desc.platform;
}
const char *AGOSEngine::getFileName(int type) const {
// Required if the InstallShield cab is been used
if (getGameType() == GType_PP) {
if (type == GAME_BASEFILE)
return gss->base_filename;
}
// Required if the InstallShield cab is been used
if (getGameType() == GType_FF && getPlatform() == Common::kPlatformWindows) {
if (type == GAME_BASEFILE)
return gss->base_filename;
if (type == GAME_RESTFILE)
return gss->restore_filename;
if (type == GAME_TBLFILE)
return gss->tbl_filename;
}
for (int i = 0; _gameDescription->desc.filesDescriptions[i].fileType; i++) {
if (_gameDescription->desc.filesDescriptions[i].fileType == type)
return _gameDescription->desc.filesDescriptions[i].fileName;
}
return NULL;
}
#ifdef ENABLE_AGOS2
void AGOSEngine::loadArchives() {
const ADGameFileDescription *ag;
if (getFeatures() & GF_PACKED) {
for (ag = _gameDescription->desc.filesDescriptions; ag->fileName; ag++) {
if (!SearchMan.hasArchive(ag->fileName)) {
Common::SeekableReadStream *stream = SearchMan.createReadStreamForMember(ag->fileName);
if (stream)
SearchMan.add(ag->fileName, Common::makeInstallShieldArchive(stream, DisposeAfterUse::YES), ag->fileType);
}
}
}
}
#endif
} // End of namespace AGOS

View File

@ -12,7 +12,6 @@ MODULE_OBJS := \
cursor.o \
debug.o \
debugger.o \
detection.o \
draw.o \
event.o \
gfx.o \
@ -21,6 +20,7 @@ MODULE_OBJS := \
input_pn.o \
items.o \
menus.o \
metaengine.o \
midi.o \
midiparser_s1d.o \
pn.o \
@ -69,3 +69,6 @@ endif
# Include common rules
include $(srcdir)/rules.mk
# Detection objects
DETECT_OBJS += $(MODULE)/detection.o

37
engines/agos/obsolete.h Normal file
View File

@ -0,0 +1,37 @@
/* 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.
*
*/
static const Engines::ObsoleteGameID obsoleteGameIDsTable[] = {
{"simon1acorn", "simon1", Common::kPlatformAcorn},
{"simon1amiga", "simon1", Common::kPlatformAmiga},
{"simon1cd32", "simon1", Common::kPlatformAmiga},
{"simon1demo", "simon1", Common::kPlatformDOS},
{"simon1dos", "simon1", Common::kPlatformDOS},
{"simon1talkie", "simon1", Common::kPlatformDOS},
{"simon1win", "simon1", Common::kPlatformWindows},
{"simon2dos", "simon2", Common::kPlatformDOS},
{"simon2talkie", "simon2", Common::kPlatformDOS},
{"simon2mac", "simon2", Common::kPlatformMacintosh},
{"simon2win", "simon2", Common::kPlatformWindows},
{0, 0, Common::kPlatformUnknown}
};