1 files changed, 112 insertions, 91 deletions

diff --git a/engines/advancedDetector.h b/engines/advancedDetector.h
index 408c46556d..cbdfdf39d8 100644
--- a/engines/advancedDetector.h
+++ b/engines/advancedDetector.h
@@ -19,38 +19,59 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  */
+
 #ifndef ENGINES_ADVANCED_DETECTOR_H
 #define ENGINES_ADVANCED_DETECTOR_H
 
 #include "engines/metaengine.h"
+#include "engines/engine.h"
 
 namespace Common {
 class Error;
 class FSList;
 }
 
-
+/**
+ * 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;
-	uint16 fileType; // Optional. Not used during detection, only by engines.
-	const char *md5; // Optional. May be NULL.
-	int32 fileSize;  // Optional. Set to -1 to ignore.
+	const char *fileName;	///< Name of 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.
+	int32 fileSize;  ///< Size of the described file. Set to -1 to ignore.
 };
 
+/**
+ * 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, -1}, 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}
 
 enum ADGameFlags {
 	ADGF_NO_FLAGS = 0,
-	ADGF_PIRATED = (1 << 23), // flag to designate well known pirated versions with cracks
-	ADGF_ADDENGLISH = (1 << 24), // always add English as language option
-	ADGF_MACRESFORK = (1 << 25), // the md5 for this entry will be calculated from the resource fork
-	ADGF_USEEXTRAASTITLE = (1 << 26), // Extra field value will be used as main game title, not gameid
-	ADGF_DROPLANGUAGE = (1 << 28), // don't add language to gameid
-	ADGF_CD = (1 << 29),    	// add "-cd" to gameid
-	ADGF_DEMO = (1 << 30)   	// add "-demo" to gameid
+	ADGF_UNSTABLE = (1 << 21),    	// flag to designate not yet officially-supported games that are not fit for public testing
+	ADGF_TESTING = (1 << 22),    	// flag to designate not yet officially-supported games that are fit for public testing
+	ADGF_PIRATED = (1 << 23), ///< flag to designate well known pirated versions with cracks
+	ADGF_ADDENGLISH = (1 << 24), ///< always add English as language option
+	ADGF_MACRESFORK = (1 << 25), ///< the md5 for this entry will be calculated from the resource fork
+	ADGF_USEEXTRAASTITLE = (1 << 26), ///< Extra field value will be used as main game title, not gameid
+	ADGF_DROPLANGUAGE = (1 << 28), ///< don't add language to gameid
+	ADGF_CD = (1 << 29),    	///< add "-cd" to gameid
+	ADGF_DEMO = (1 << 30)   	///< add "-demo" to gameid
 };
 
 struct ADGameDescription {
@@ -71,25 +92,23 @@ struct ADGameDescription {
 };
 
 /**
+ * A list of pointers to ADGameDescription structs (or subclasses thereof).
+ */
+typedef Common::Array<const ADGameDescription *> ADGameDescList;
+
+/**
  * End marker for a table of ADGameDescription structs. Use this to
  * terminate a list to be passed to the AdvancedDetector API.
  */
 #define AD_TABLE_END_MARKER	\
 	{ NULL, NULL, { { NULL, 0, NULL, 0 } }, Common::UNK_LANG, Common::kPlatformUnknown, ADGF_NO_FLAGS, Common::GUIO_NONE }
 
-
-struct ADObsoleteGameID {
-	const char *from;
-	const char *to;
-	Common::Platform platform;
-};
-
 struct ADFileBasedFallback {
 	/**
 	 * Pointer to an ADGameDescription or subclass thereof which will get
 	 * returned if there's a detection match.
 	 */
-	const void *desc;
+	const ADGameDescription *desc;
 
 	/**
 	 * A zero-terminated list of filenames used for matching. All files in
@@ -101,149 +120,151 @@ struct ADFileBasedFallback {
 
 enum ADFlags {
 	/**
-	 * Warn user about new variant if his version was detected with fallback
-	 */
-	kADFlagPrintWarningOnFileBasedFallback = (1 << 1),
-	/**
 	 * Store value of extra field in config file, and use it as a hint
 	 * on subsequent runs. Could be used when there is no way to autodetect
 	 * game (when more than one game sits in same directory), and 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 << 2)
+	kADFlagUseExtraAsHint = (1 << 0)
 };
 
+
 /**
- * A structure containing all parameters for the AdvancedDetector.
- * Typically, an engine will have a single instance of this which is
- * used by its AdvancedMetaEngine subclass as a parameter to the
- * primary AdvancedMetaEngine constructor.
+ * A MetaEngine implementation based around the advanced detector code.
  */
-struct ADParams {
+class AdvancedMetaEngine : public MetaEngine {
+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 AD_TABLE_END_MARKER).
 	 */
-	const byte *descs;
+	const byte *_gameDescriptors;
 
 	/**
 	 * The size of a single entry of the above descs array. Always
 	 * must be >= sizeof(ADGameDescription).
 	 */
-	uint descItemSize;
-
-	/**
-	 * The number of bytes to compute MD5 sum for. The AdvancedDetector
-	 * 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 kilobyte,
-	 * but arbitrary non-zero values are possible.
-	 */
-	uint md5Bytes;
+	const uint _descItemSize;
 
 	/**
 	 * A list of all gameids (and their corresponding descriptions) supported
 	 * by this engine.
 	 */
-	const PlainGameDescriptor *list;
+	const PlainGameDescriptor *_gameids;
 
 	/**
-	 * Structure for autoupgrading obsolete targets (optional).
-	 *
-	 * @todo Properly explain this.
+	 * The number of bytes to compute MD5 sum for. The AdvancedDetector
+	 * 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 kilobyte,
+	 * but arbitrary non-zero values are possible. The default is 5000.
 	 */
-	const ADObsoleteGameID *obsoleteList;
+	uint _md5Bytes;
 
 	/**
 	 * Name of single gameid (optional).
 	 *
 	 * @todo Properly explain this -- what does it do?
 	 */
-	const char *singleid;
-
-	/**
-	 * List of files for file-based fallback detection (optional).
-	 * This is used if the regular MD5 based detection failed to
-	 * detect anything.
-	 * As usual this list is terminated by an all-zero entry.
-	 *
-	 * @todo Properly explain this
-	 */
-	const ADFileBasedFallback *fileBasedFallback;
+	const char *_singleid;
 
 	/**
 	 * A bitmask of flags which can be used to configure the behavior
 	 * of the AdvancedDetector. Refer to ADFlags for a list of flags
 	 * that can be ORed together and passed here.
 	 */
-	uint32 flags;
+	uint32 _flags;
 
 	/**
 	 * A bitmask of game GUI options which will be added to each
 	 * entry in addition to per-game options. Refer to GameGUIOption
 	 * enum for the list.
 	 */
-	uint32 guioptions;
+	uint32 _guioptions;
 
 	/**
-	 * Maximum depth of directories to look up
+	 * Maximum depth of directories to look up.
 	 * If set to 0, the depth is 1 level
 	 */
-	uint32 depth;
+	uint32 _maxScanDepth;
 
 	/**
 	 * Case-insensitive list of directory globs which could be used for
-	 * going deeper int directory structure.
+	 * going deeper into the directory structure.
 	 * @see String::matchString() method for format description.
 	 *
 	 * @note Last item must be 0
 	 */
-	const char * const *directoryGlobs;
-};
-
+	const char * const *_directoryGlobs;
 
-namespace AdvancedDetector {
-
-/**
- * Scan through the game descriptors specified in params and search for
- * 'gameid' in there. If a match is found, returns a GameDescriptor
- * with gameid and description set.
- */
-GameDescriptor findGameID(
-	const char *gameid,
-	const PlainGameDescriptor *list,
-	const ADObsoleteGameID *obsoleteList = 0
-	);
-
-} // End of namespace AdvancedDetector
-
-/**
- * A MetaEngine implementation based around the advanced detector code.
- */
-class AdvancedMetaEngine : public MetaEngine {
-	const ADParams &params;
 public:
-	AdvancedMetaEngine(const ADParams &dp) : params(dp) {}
+	AdvancedMetaEngine(const void *descs, uint descItemSize, const PlainGameDescriptor *gameids);
 
+	/**
+	 * Returns list of targets supported by the engine.
+	 * Distinguishes engines with single ID
+	 */
 	virtual GameList getSupportedGames() const;
+
 	virtual GameDescriptor findGame(const char *gameid) const;
+
 	virtual GameList detectGames(const Common::FSList &fslist) const;
+
 	virtual Common::Error createInstance(OSystem *syst, Engine **engine) const;
 
-	// To be provided by subclasses
+protected:
+	// To be implemented by subclasses
 	virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const = 0;
 
+	typedef Common::HashMap<Common::String, Common::FSNode, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> FileMap;
+
 	/**
 	 * An (optional) generic fallback detect function which is invoked
-	 * if both the regular MD5 based detection as well as the file
-	 * based fallback failed to detect anything.
+	 * if the regular MD5 based detection failed to detect anything.
 	 */
-	virtual const ADGameDescription *fallbackDetect(const Common::FSList &fslist) const {
+	virtual const ADGameDescription *fallbackDetect(const FileMap &allFiles, const Common::FSList &fslist) const {
 		return 0;
 	}
+
+protected:
+	/**
+	 * Detect games in specified directory.
+	 * Parameters language and platform are used to pass on values
+	 * specified by the user. This is used to restrict search scope.
+	 *
+	 * @param allFiles	list of all present files, as computed by composeFileHashMap
+	 * @param language	restrict results to specified language
+	 * @param platform	restrict results to specified platform
+	 * @param extra		restrict results to specified extra string (only if kADFlagUseExtraAsHint is set)
+	 * @return	list of ADGameDescription pointers corresponding to matched games
+	 */
+	ADGameDescList detectGame(const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra) const;
+
+	/**
+	 * Iterates over all ADFileBasedFallback records inside fileBasedFallback.
+	 * This then returns 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	a map describing all present files
+	 * @param fileBasedFallback	a list of ADFileBasedFallback records, zero-terminated
+	 */
+	const ADGameDescription *detectGameFilebased(const FileMap &allFiles, const ADFileBasedFallback *fileBasedFallback) const;
+
+	// TODO
+	void updateGameDescriptor(GameDescriptor &desc, const ADGameDescription *realDesc) const;
+
+	/**
+	 * Compose a hashmap of all files in fslist.
+	 * Includes nifty stuff like removing trailing dots and ignoring case.
+	 */
+	void composeFileHashMap(FileMap &allFiles, const Common::FSList &fslist, int depth) const;
 };
 
 #endif