1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
|
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef ENGINES_ADVANCED_DETECTOR_H
#define ENGINES_ADVANCED_DETECTOR_H
#include "engines/metaengine.h"
#include "engines/engine.h"
#include "common/hash-str.h"
#include "common/gui_options.h" // Keep it here, so detection tables can refer to them
namespace Common {
class Error;
class FSList;
}
/**
* @defgroup engines_advdetector Advanced Detector
* @ingroup engines
*
* @brief The Advanced Detector (AD) provides a standard framework for filename and MD5-based game detection.
*
* @{
*/
/* Some helpers functions to avoid code duplication */
namespace ADDynamicDescription {
static inline uint32 strSizeBuffer(const char * const &field) {
return field ? strlen(field) + 1 : 0;
}
static inline void *strToBuffer(void *buffer, const char *&field) {
if (field) {
int len = strlen(field) + 1;
memcpy((char *)buffer, field, len);
field = (const char *)buffer;
buffer = (char *)buffer + len;
}
return buffer;
}
static inline uint32 alignSizeBuffer() {
// We consider alignments up to pointer size
return sizeof(void *) - 1;
}
static inline void *alignToBuffer(void *buffer) {
// Round up
uintptr tmp = (uintptr)buffer + sizeof(void *) - 1;
return (void *)(tmp & -(int)sizeof(void *));
}
} // End of namespace ADDynamicDescription
/**
* A record describing a file to be matched for detecting a specific game
* variant. A list of such records is used inside every ADGameDescription to
* enable detection.
*/
struct ADGameFileDescription {
const char *fileName; ///< Name of the described file.
uint16 fileType; ///< Optional. Not used during detection, only by engines.
const char *md5; ///< MD5 of (the beginning of) the described file. Optional. Set to NULL to ignore.
uint32 fileSize; ///< Size of the described file. Set to AD_NO_SIZE to ignore.
uint32 sizeBuffer() const {
uint32 ret = 0;
ret += ADDynamicDescription::strSizeBuffer(fileName);
ret += ADDynamicDescription::strSizeBuffer(md5);
return ret;
}
void *toBuffer(void *buffer) {
buffer = ADDynamicDescription::strToBuffer(buffer, fileName);
buffer = ADDynamicDescription::strToBuffer(buffer, md5);
return buffer;
}
};
#define AD_NO_SIZE ((uint32)-1)
/**
* A shortcut to produce an empty ADGameFileDescription record. Used to mark
* the end of a list of these.
*/
#define AD_LISTEND {NULL, 0, NULL, 0}
/**
* A shortcut to produce a list of ADGameFileDescription records with only one
* record that contains just a filename with an MD5, and no file size.
*/
#define AD_ENTRY1(f, x) {{ f, 0, x, AD_NO_SIZE}, AD_LISTEND}
/**
* A shortcut to produce a list of ADGameFileDescription records with only one
* record that contains just a filename with an MD5, plus a file size.
*/
#define AD_ENTRY1s(f, x, s) {{ f, 0, x, s}, AD_LISTEND}
/**
* A shortcut to produce a list of ADGameFileDescription records with only two
* records that contain just a filename with an MD5, plus a file size.
*/
#define AD_ENTRY2s(f1, x1, s1, f2, x2, s2) {{f1, 0, x1, s1}, {f2, 0, x2, s2}, AD_LISTEND}
/**
* A shortcut to produce a list of ADGameFileDescription records with only three
* records that contain just a filename with an MD5, plus a file size.
*/
#define AD_ENTRY3s(f1, x1, s1, f2, x2, s2, f3, x3, s3) {{f1, 0, x1, s1}, {f2, 0, x2, s2}, {f3, 0, x3, s3}, AD_LISTEND}
#define AD_ENTRY4s(f1, x1, s1, f2, x2, s2, f3, x3, s3, f4, x4, s4) {{f1, 0, x1, s1}, {f2, 0, x2, s2}, {f3, 0, x3, s3}, {f4, 0, x4, s4}, AD_LISTEND}
#define AD_ENTRY5s(f1, x1, s1, f2, x2, s2, f3, x3, s3, f4, x4, s4, f5, x5, s5) {{f1, 0, x1, s1}, {f2, 0, x2, s2}, {f3, 0, x3, s3}, {f4, 0, x4, s4}, {f5, 0, x5, s5}, AD_LISTEND}
#define AD_ENTRY6s(f1, x1, s1, f2, x2, s2, f3, x3, s3, f4, x4, s4, f5, x5, s5, f6, x6, s6) {{f1, 0, x1, s1}, {f2, 0, x2, s2}, {f3, 0, x3, s3}, {f4, 0, x4, s4}, {f5, 0, x5, s5}, {f6, 0, x6, s6}, AD_LISTEND}
/**
* Flags used in the game description.
*
* Note that the lowest 16 bits are currently reserved for use by the client code.
*/
enum ADGameFlags : uint {
ADGF_NO_FLAGS = 0u, ///< No flags.
ADGF_TAILMD5 = (1u << 16), ///< Calculate the MD5 for this entry from the end of the file.
ADGF_AUTOGENTARGET = (1u << 17), ///< Automatically generate gameid from @ref ADGameDescription::extra.
ADGF_UNSTABLE = (1u << 18), ///< Flag to designate not yet officially supported games that are not fit for public testing.
ADGF_TESTING = (1u << 19), ///< Flag to designate not yet officially supported games that are fit for public testing.
ADGF_PIRATED = (1u << 20), ///< Flag to designate well-known pirated versions with cracks.
ADGF_UNSUPPORTED = (1u << 21), /*!< Flag to mark certain versions (like badly protected full games as demos) not to be run for various reasons.
A custom message can be provided in the @ref ADGameDescription::extra field. */
ADGF_WARNING = (1u << 22), /*!< Flag to mark certain versions to show confirmation warning before proceeding.
A custom message should be provided in the @ref ADGameDescription::extra field. */
ADGF_ADDENGLISH = (1u << 23), ///< Always add English as a language option.
ADGF_MACRESFORK = (1u << 24), ///< Calculate the MD5 for this entry from the resource fork.
ADGF_USEEXTRAASTITLE = (1u << 25), ///< Use @ref ADGameDescription::extra as the main game title, not gameid.
ADGF_DROPLANGUAGE = (1u << 26), ///< Do not add language to gameid.
ADGF_DROPPLATFORM = (1u << 27), ///< Do not add platform to gameid.
ADGF_CD = (1u << 28), ///< Add "-cd" to gameid.
ADGF_DVD = (1u << 29), ///< Add "-dvd" to gameid.
ADGF_DEMO = (1u << 30), ///< Add "-demo" to gameid.
ADGF_REMASTERED = (1u << 31) ///< Add "-remastered' to gameid.
};
/**
* Data table describing a game variant.
*/
struct ADGameDescription {
/**
* The gameid that identifies the game.
*
* Mainly used for taking the game description from the @ref PlainGameDescriptor table.
*/
const char *gameId;
/**
* Field that is used to distinguish between different variants of a game.
*
* The content of this field is inserted in the generated description for the config file game entry.
* If the @ref kADFlagUseExtraAsHint ADFlag is set, the contents of this field are stored
* in the config file, and are used to additionally distinguish between game variants.
* Also, if the ADGF_USEEXTRAASTITLE game flag is set, the contents of this field
* will be used as a description instead the one extracted from the @ref PlainGameDescriptor table.
*/
const char *extra;
/**
* A list of individual file entries used for detection.
*
* 13 files (last is zero-terminated) is the maximum number of files currently used in ScummVM.
* A hardcoded number is used here due to a C++ limitation for defining const arrays.
*/
ADGameFileDescription filesDescriptions[14];
/**
* Language of the game variant.
*/
Common::Language language;
/**
* Platform of the game variant.
*/
Common::Platform platform;
/**
* A bitmask of extra flags.
*
* The top 16 bits are reserved for generic flags defined in @ref ADGameFlags.
* This leaves 16 bits to be used by the client code.
*/
uint32 flags;
/**
* Game features that are user-controllable.
*
* This list reflects which features of the GUI should be turned on or off in order to minimize user confusion.
* For instance, there is no point in changing game language in single-language games
* or have MIDI controls in a game that only supports digital music.
*/
const char *guiOptions;
/**
* Calculates the size needed to store all pointed data
*/
uint32 sizeBuffer() const {
uint32 ret = 0;
ret += ADDynamicDescription::strSizeBuffer(gameId);
ret += ADDynamicDescription::strSizeBuffer(extra);
for(int i = 0; i < ARRAYSIZE(filesDescriptions); i++) {
ret += filesDescriptions[i].sizeBuffer();
}
ret += ADDynamicDescription::strSizeBuffer(guiOptions);
return ret;
}
/**
* Fixup all pointers to lie inside buffer and stores the needed data in it
*
* @param buffer Where the original data is copied in and pointed at
*
* @return The new pointer on buffer after the stored data.
*/
void *toBuffer(void *buffer) {
buffer = ADDynamicDescription::strToBuffer(buffer, gameId);
buffer = ADDynamicDescription::strToBuffer(buffer, extra);
for(int i = 0; i < ARRAYSIZE(filesDescriptions); i++) {
buffer = filesDescriptions[i].toBuffer(buffer);
}
buffer = ADDynamicDescription::strToBuffer(buffer, guiOptions);
return buffer;
}
};
/**
* This macro can be used in simple ADGameDescription containers
* to let them be used by ADDynamicGameDescription
*
* Simple containers are the one not making use of pointers.
*/
#define AD_GAME_DESCRIPTION_HELPERS(field) \
uint32 sizeBuffer() const { \
return field.sizeBuffer(); \
} \
void *toBuffer(void *buffer) { \
return field.toBuffer(buffer); \
}
/**
* This class is a small helper to manage copies in heap
* of static ADGameDescription.
* To work, all ADGameDescription and derived classes that manipulate
* pointers must define the sizeBuffer and toBuffer functions like ADGameDescription.
*/
template<class T>
class ADDynamicGameDescription : public T {
public:
ADDynamicGameDescription(const T *other) : _buffer(nullptr) {
// First copy all fields
memcpy(static_cast<T*>(this), other, sizeof(T));
// Then calculate the size of the dynamic buffer
// we will need to store evrything pointed at by
// the structures
uint32 sz = other->sizeBuffer();
_buffer = new byte[sz];
// Finally copy every pointer in the buffer
// and make the structure point into it
void *end = this->toBuffer(_buffer);
assert(end <= _buffer + sz);
}
~ADDynamicGameDescription() {
delete[] _buffer;
}
private:
byte *_buffer;
};
/**
* struct which saved extra information for detected games
*/
struct ADDetectedGameExtraInfo {
Common::String gameName; /*!< Extra info which saved game name */
Common::String targetID; /*!< targetID which will be used on preferred target id */
};
/**
* A game installation matching an AD game description.
*/
struct ADDetectedGame {
bool hasUnknownFiles; /*!< Whether the game has unknown files. */
FilePropertiesMap matchedFiles; /*!< List of the files that were used to match the game. */
const ADGameDescription *desc; /*!< Matching game description from detection table. */
ADDetectedGame() : desc(nullptr), hasUnknownFiles(false) {}
/**
* Construct an ADDetectedGame object.
*/
explicit ADDetectedGame(const ADGameDescription *d) : desc(d), hasUnknownFiles(false) {}
};
/** A list of games detected by the AD. */
typedef Common::Array<ADDetectedGame> ADDetectedGames;
/**
* End marker for a table of @ref ADGameDescription structures. Use this to
* terminate a list to be passed to the Advanced Detector API.
*/
#define AD_TABLE_END_MARKER \
{ NULL, NULL, { { NULL, 0, NULL, 0 } }, Common::UNK_LANG, Common::kPlatformUnknown, ADGF_NO_FLAGS, GUIO0() }
struct ADFileBasedFallback {
/**
* Pointer to an @ref ADGameDescription or its subclass that will be
* returned if there is a detection match.
*/
const ADGameDescription *desc;
/**
* A zero-terminated list of filenames used for matching. All files in
* the list must be present to get a detection match.
*/
const char *filenames[10];
};
enum ADFlags {
/**
* Store the value of the @ref ADGameDescription::extra field
* in the config file, and use it as a hint on subsequent runs.
*
* This can be used when there is no way to autodetect the game
* (when more than one game are located in same directory), and the user picks
* up a variant manually.
* In addition, this is useful if two variants of a game sharing the same
* gameid are contained in a single directory.
*/
kADFlagUseExtraAsHint = (1 << 0),
/**
* If set, filenames will be matched against the entire path, relative to
* the root detection directory.
*
* For example: "foo/bar.000" for a file at "<root>/foo/bar.000").
* Otherwise, filenames only match the base name (e.g. "bar.000" for the same file).
*
* @note @c _maxScanDepth must still be configured to allow
* the detector to find files inside subdirectories. @c _directoryGlobs are
* extracted from the entries.
*/
kADFlagMatchFullPaths = (1 << 1),
/**
* If set, the engine's fallback detection results are used instead of the
* partial matches found in the detection table.
*
* An engine sets this if its fallback detection produces good results that
* should always be used. If fallback detection fails, then partial matches
* are still used.
*/
kADFlagPreferFallbackDetection = (1 << 2),
/**
* Indicates engine's ability to play a variant of a game with unknown files.
* This will leave the detection entries with partial matches in the list
* of detected games.
*/
kADFlagCanPlayUnknownVariants = (1 << 3),
/**
* Indicates engine's ability to play a variant of a Traditional Chinese game while transcoding it on-the-fly to Simplified.
*/
kADFlagCanTranscodeTraditionalChineseToSimplified = (1 << 4),
};
/**
* Map entry for mapping GUIO_GAMEOPTIONS* to their @ref ExtraGuiOption
* description.
*/
struct ADExtraGuiOptionsMap {
const char *guioFlag; /*!< GUIO_GAMEOPTION* string. */
ExtraGuiOption option; /*!< The associated option. */
};
#define AD_EXTRA_GUI_OPTIONS_TERMINATOR { 0, { 0, 0, 0, 0, 0, 0 } }
/**
* A @ref MetaEngineDetection implementation based on the Advanced Detector code.
*/
class AdvancedMetaEngineDetectionBase : public MetaEngineDetection {
protected:
/**
* Pointer to an array of objects which are either ADGameDescription
* or superset structures (i.e. start with an ADGameDescription member).
*
* The list is terminated by an entry with a gameid equal to 0
* (see @ref AD_TABLE_END_MARKER).
*/
const byte *_gameDescriptors;
/**
* The size of a single entry of the above descriptions array.
*
* Always must be >= sizeof(ADGameDescription).
*/
const uint _descItemSize;
/**
* A list of all gameids (and their corresponding descriptions) supported
* by this engine.
*/
const PlainGameDescriptor *_gameIds;
/**
* The number of bytes to compute the MD5 checksum for.
*
* The Advanced Detector is primarily based on computing and matching
* MD5 checksums of files. Since doing that for large files can be slow,
* it can be restricted to a subset of all files.
* Typically this will be set to something between 5 and 50 kilobytes,
* but arbitrary non-zero values are possible. The default is 5000.
*/
uint _md5Bytes;
/**
* A bitmask of flags which can be used to configure the behavior
* of the Advanced Detector.
*
* See @ref ADFlags for a list of flags that can be ORed together and passed here.
*/
uint32 _flags;
/**
* A list of game GUI options which will be added to each
* entry in addition to per-game options.
*
* Refer to @ref GameGUIOption enum for the list.
*/
Common::String _guiOptions;
/**
* Maximum depth of directories to look up.
*
* If set to 0, the depth is 1 level.
*/
uint32 _maxScanDepth;
/**
* Case-insensitive list of directory globs that can be used for
* going deeper into the directory structure.
*
* See @ref String::matchString() method for format description.
*
* @note The last item must be 0.
*/
const char * const *_directoryGlobs;
/**
* If ADGF_AUTOGENTARGET is used, then this specifies the max length
* of the autogenerated name.
* The default is 15.
*/
int _maxAutogenLength;
/**
* If kADFlagMatchFullPaths is set, then use this value for specifying
* depth for addSubDirectoryMatching() call
* The default is 5;
*/
int _fullPathGlobsDepth;
/**
* Initialize game detection using AdvancedMetaEngineDetection.
*/
AdvancedMetaEngineDetectionBase(const void *descs, uint descItemSize, const PlainGameDescriptor *gameIds);
public:
/**
* Return a list of targets supported by the engine.
*
* Distinguishes engines with a single ID.
*/
PlainGameList getSupportedGames() const override;
/** Query the engine for a @ref PlainGameDescriptor for the specified gameid, if any. */
PlainGameDescriptor findGame(const char *gameId) const override;
/** Identify the active game and check its data files. */
Common::Error identifyGame(DetectedGame &game, const void **descriptor) override;
/**
* Run the engine's game detector on the given list of files, and return a
* (possibly empty) list of games supported by the engine that were
* found among the given files.
*/
DetectedGames detectGames(const Common::FSList &fslist, uint32 skipADFlags, bool skipIncomplete) override;
uint getMD5Bytes() const override final { return _md5Bytes; }
int getGameVariantCount() const override final {
uint count = 0;
for (const byte *descPtr = _gameDescriptors; ((const ADGameDescription *)descPtr)->gameId != nullptr; descPtr += _descItemSize)
++count;
return count;
}
void dumpDetectionEntries() const override final;
protected:
/**
* A hashmap of file paths and their file system nodes.
*/
typedef Common::HashMap<Common::Path, Common::FSNode, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> FileMap;
/**
* An (optional) generic fallback detection function that is invoked
* if the regular MD5-based detection failed to detect anything.
*/
virtual ADDetectedGame fallbackDetect(const FileMap &allFiles, const Common::FSList &fslist, ADDetectedGameExtraInfo **extra = nullptr) const {
return ADDetectedGame();
}
private:
void preprocessDescriptions();
static Common::StringArray getPathsFromEntry(const ADGameDescription *g);
bool isEntryGrayListed(const ADGameDescription *g) const;
void detectClashes() const;
private:
Common::HashMap<Common::String, bool, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> _grayListMap;
Common::HashMap<Common::String, bool, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> _globsMap;
bool _hashMapsInited;
protected:
/**
* Detect games in the specified directory.
*
* Parameters @p language and @p platform are used to pass the values
* specified by the user. This is used to restrict search scope.
*
* @param parent Parent node of this file node.
* @param allFiles List of all present files, as computed by the @ref composeFileHashMap.
* @param language Restrict results to the specified language.
* @param platform Restrict results to the specified platform.
* @param extra Restrict results to the specified @c extra string (only if @ref kADFlagUseExtraAsHint is set).
* @param skipADFlags Specify bitmask of ADGF flags to be ignored (for mass add).
* @param skipIncomplete Ignore results with incomplete file/md5/size matches (for mass add).
*
* @return A list of @ref ADGameDescription pointers corresponding to the matched games.
*/
virtual ADDetectedGames detectGame(const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra, uint32 skipADFlags = 0, bool skipIncomplete = false);
/**
* Iterate over all @ref ADFileBasedFallback records inside @p fileBasedFallback
* and return the record (or rather, the ADGameDescription
* contained in it) for which all files described by it are present, and
* among those the one with the maximal number of matching files.
*
* In case of a tie, the entry coming first in the list is chosen.
*
* @param allFiles Map describing all present files
* @param fileBasedFallback List of ADFileBasedFallback records, zero-terminated.
*/
ADDetectedGame detectGameFilebased(const FileMap &allFiles, const ADFileBasedFallback *fileBasedFallback) const;
/**
* Compose a hashmap of all files in @p fslist.
*
* Removes trailing dots and ignores case in the process.
*/
void composeFileHashMap(FileMap &allFiles, const Common::FSList &fslist, int depth, const Common::Path &parentName = Common::Path()) const;
/** Get the properties (size and MD5) of this file. */
bool getFileProperties(const FileMap &allFiles, MD5Properties md5prop, const Common::Path &fname, FileProperties &fileProps) const;
/** Convert an AD game description into the shared game description format. */
virtual DetectedGame toDetectedGame(const ADDetectedGame &adGame, ADDetectedGameExtraInfo *extraInfo = nullptr) const;
/** Check for pirated games in the given detected games */
bool cleanupPirated(ADDetectedGames &matched) const;
friend class FileMapArchive;
};
template<class Descriptor>
class AdvancedMetaEngineDetection : public AdvancedMetaEngineDetectionBase {
protected:
AdvancedMetaEngineDetection(const Descriptor *descs, const PlainGameDescriptor *gameIds) : AdvancedMetaEngineDetectionBase(descs, sizeof(Descriptor), gameIds) {}
Common::Error identifyGame(DetectedGame &game, const void **descriptor) override {
assert(descriptor);
Common::Error err = AdvancedMetaEngineDetectionBase::identifyGame(game, descriptor);
if (err.getCode() != Common::kNoError) {
return err;
}
if (*descriptor) {
*descriptor = new ADDynamicGameDescription<Descriptor>(static_cast<const Descriptor *>(*descriptor));
}
return err;
}
};
/**
* A MetaEngine implementation of AdvancedMetaEngine.
*/
class AdvancedMetaEngineBase : public MetaEngine {
public:
/**
* Base createInstance for AdvancedMetaEngine.
*
* The AdvancedMetaEngine provides a default createInstance that is called first,
* so this should be invoked first.
* By the time this is called, it is assumed that there is only one
* plugin engine loaded in memory.
*/
Common::Error createInstance(OSystem *syst, Engine **engine, const DetectedGame &gameDescriptor, const void *metaEngineDescriptor) override;
/**
* A createInstance implementation for subclasses. To be called after the base
* createInstance function above is called.
*/
virtual Common::Error createInstance(OSystem *syst, Engine **engine, const void *desc) const = 0;
/**
* Return the name of the engine plugin based on the engineID.
*
* The engineID must match the one from MetaEngine.
*
* @see MetaEngine::getName().
*/
const char *getName() const override = 0;
public:
/**
* A hashmap of file paths and their file system nodes.
*/
typedef Common::HashMap<Common::Path, Common::FSNode, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> FileMap;
/**
* An (optional) generic fallback detection function that is invoked
* if the regular MD5-based detection failed to detect anything.
* @note This is only meant to be used if fallback detection heavily depends on engine resources.
*
* To use this, implement the intended fallbackDetectExtern inside the relevant MetaEngine class.
* Then, override the method "fallbackDetect" inside your MetaEngine class.
* Finally, provide a "hook" to fetch the relevant MetaEngine class and then use the original detection
* method.
*
* An example of how this is implemented can be found in the Wintermute Engine.
*/
virtual ADDetectedGame fallbackDetectExtern(uint md5Bytes, const FileMap &allFiles, const Common::FSList &fslist, ADDetectedGameExtraInfo **extra = nullptr) const {
return ADDetectedGame();
}
/**
* Get the properties (size and MD5) of this file.
*
* Based on @ref MetaEngine::getFileProperties.
*/
bool getFilePropertiesExtern(uint md5Bytes, const FileMap &allFiles, MD5Properties md5prop, const Common::Path &fname, FileProperties &fileProps) const;
protected:
/**
* Return a list of extra GUI options for the specified target.
*
* If no target is specified, all of the available custom GUI options are
* returned for the plugin (used to set default values).
*
* Currently, this only supports options with checkboxes.
*
* The default implementation returns an empty list.
*
* @param target Name of a config manager target.
*
* @return A list of extra GUI options for an engine plugin and target.
*/
const ExtraGuiOptions getExtraGuiOptions(const Common::String &target) const override final;
/**
* Returns a map containing all the extra game GUI options the engine supports.
*/
virtual const ADExtraGuiOptionsMap *getAdvancedExtraGuiOptions() const { return nullptr; }
/**
* Returns the set of features that need to be enabled for the
* extended save format to work
*/
bool checkExtendedSaves(MetaEngineFeature f) const;
private:
void initSubSystems(const ADGameDescription *gameDesc) const;
};
template<class Descriptor>
class AdvancedMetaEngine : public AdvancedMetaEngineBase {
protected:
virtual Common::Error createInstance(OSystem *syst, Engine **engine, const Descriptor *desc) const = 0;
Common::Error createInstance(OSystem *syst, Engine **engine, const void *desc) const override final {
return createInstance(syst, engine, static_cast<const Descriptor *>(desc));
}
void deleteInstance(Engine *engine, const DetectedGame &gameDescriptor, const void *meDescriptor) override {
delete engine;
delete static_cast<ADDynamicGameDescription<Descriptor> *>(
const_cast<void *>(meDescriptor));
}
private:
// Silence overloaded-virtual warning from clang
using AdvancedMetaEngineBase::createInstance;
};
/**
* Singleton Cache Storage for Computed MD5s and Open Archives
*/
class AdvancedDetectorCacheManager : public Common::Singleton<AdvancedDetectorCacheManager> {
public:
void setMD5(const Common::String &fname, const Common::String &md5) {
md5HashMap.setVal(fname, md5);
}
const Common::String &getMD5(const Common::String &fname) const {
return md5HashMap.getVal(fname);
}
void setSize(const Common::String &fname, int64 size) {
sizeHashMap.setVal(fname, size);
}
int64 getSize(const Common::String &fname) const {
return sizeHashMap.getVal(fname);
}
bool containsMD5(const Common::String &fname) const {
return (md5HashMap.contains(fname) && sizeHashMap.contains(fname));
}
void addArchive(const Common::FSNode &node, Common::Archive *archivePtr) {
if (!archivePtr)
return;
Common::Path filename = node.getPath();
if (archiveHashMap.contains(filename)) {
delete archiveHashMap[filename];
}
archiveHashMap.setVal(filename, archivePtr);
}
Common::Archive *getArchive(const Common::FSNode &node) const {
return archiveHashMap.getValOrDefault(node.getPath(), nullptr);
}
AdvancedDetectorCacheManager() {
clear();
}
void clearArchives() {
for (auto &entry : archiveHashMap) {
delete entry._value;
}
archiveHashMap.clear(true);
}
void clear() {
md5HashMap.clear(true);
sizeHashMap.clear(true);
clearArchives();
}
private:
friend class Common::Singleton<AdvancedDetectorCacheManager>;
typedef Common::HashMap<Common::String, Common::String, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> FileHashMap;
typedef Common::HashMap<Common::String, int64, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> SizeHashMap;
typedef Common::HashMap<Common::Path, Common::Archive *, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> ArchiveHashMap;
FileHashMap md5HashMap;
SizeHashMap sizeHashMap;
ArchiveHashMap archiveHashMap;
};
/** Convenience shortcut for accessing the MD5CacheManager. */
#define ADCacheMan AdvancedDetectorCacheManager::instance()
/** @} */
#endif
|