advancedDetector.h

/* 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 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" // FIXME: Temporary hack?

namespace Common {
class Error;
class FSList;
}
struct ADGameFileDescription {
    const char *fileName; 
    uint16 fileType;      
    const char *md5;      
    int32 fileSize;       
};

#define AD_LISTEND {NULL, 0, NULL, 0}

#define AD_ENTRY1(f, x) {{ f, 0, x, -1}, AD_LISTEND}

#define AD_ENTRY1s(f, x, s) {{ f, 0, x, s}, AD_LISTEND}

enum ADGameFlags {
    ADGF_NO_FLAGS        =  0,        
    ADGF_REMASTERED      = (1 << 18), 
    ADGF_AUTOGENTARGET   = (1 << 19), 
    ADGF_UNSTABLE        = (1 << 20), 
    ADGF_TESTING         = (1 << 21), 
    ADGF_PIRATED         = (1 << 22), 
    ADGF_UNSUPPORTED     = (1 << 23), 
    ADGF_ADDENGLISH      = (1 << 24), 
    ADGF_MACRESFORK      = (1 << 25), 
    ADGF_USEEXTRAASTITLE = (1 << 26), 
    ADGF_DROPLANGUAGE    = (1 << 27), 
    ADGF_DROPPLATFORM    = (1 << 28), 
    ADGF_CD              = (1 << 29), 
    ADGF_DEMO            = (1 << 30)  
};

struct ADGameDescription {
    const char *gameId;

    const char *extra;

    ADGameFileDescription filesDescriptions[14];

    Common::Language language;

    Common::Platform platform;

    uint32 flags;

    const char *guiOptions;
};

struct ADDetectedGame {
    bool hasUnknownFiles;           
    FilePropertiesMap matchedFiles; 
    const ADGameDescription *desc;  
    ADDetectedGame() : desc(nullptr), hasUnknownFiles(false) {}
    explicit ADDetectedGame(const ADGameDescription *d) : desc(d), hasUnknownFiles(false) {}
};

typedef Common::Array<ADDetectedGame> ADDetectedGames;

#define AD_TABLE_END_MARKER \
    { NULL, NULL, { { NULL, 0, NULL, 0 } }, Common::UNK_LANG, Common::kPlatformUnknown, ADGF_NO_FLAGS, GUIO0() }

struct ADFileBasedFallback {
    const ADGameDescription *desc;

    const char *filenames[10];
};


enum ADFlags {
    kADFlagUseExtraAsHint = (1 << 0)
};


struct ADExtraGuiOptionsMap {
    const char *guioFlag;  
    ExtraGuiOption option; 
};

#define AD_EXTRA_GUI_OPTIONS_TERMINATOR { 0, { 0, 0, 0, 0 } }

class AdvancedMetaEngineDetection : public MetaEngineDetection {
protected:
    const byte *_gameDescriptors;

    const uint _descItemSize;

    const PlainGameDescriptor *_gameIds;

    const ADExtraGuiOptionsMap * const _extraGuiOptions;

    uint _md5Bytes;

    uint32 _flags;

    Common::String _guiOptions;

    uint32 _maxScanDepth;

    const char * const *_directoryGlobs;

    bool _matchFullPaths;

    int _maxAutogenLength;

public:
    AdvancedMetaEngineDetection(const void *descs, uint descItemSize, const PlainGameDescriptor *gameIds, const ADExtraGuiOptionsMap *extraGuiOptions = 0);

    PlainGameList getSupportedGames() const override;

    PlainGameDescriptor findGame(const char *gameId) const override;

    DetectedGames detectGames(const Common::FSList &fslist) const override;

    Common::Error createInstance(OSystem *syst, Engine **engine) const;

    virtual const ExtraGuiOptions getExtraGuiOptions(const Common::String &target) const override;

protected:
    typedef Common::HashMap<Common::String, Common::FSNode, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> FileMap;

    virtual ADDetectedGame fallbackDetect(const FileMap &allFiles, const Common::FSList &fslist) const {
        return ADDetectedGame();
    }

private:
    void initSubSystems(const ADGameDescription *gameDesc) const;

protected:
    virtual ADDetectedGames detectGame(const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra) const;

    ADDetectedGame detectGameFilebased(const FileMap &allFiles, const ADFileBasedFallback *fileBasedFallback) const;

    void composeFileHashMap(FileMap &allFiles, const Common::FSList &fslist, int depth, const Common::String &parentName = Common::String()) const;

    bool getFileProperties(const FileMap &allFiles, const ADGameDescription &game, const Common::String fname, FileProperties &fileProps) const;

    virtual DetectedGame toDetectedGame(const ADDetectedGame &adGame) const;

    friend class FileMapArchive;
};

class AdvancedMetaEngine : public MetaEngine {
public:
    virtual Common::Error createInstance(OSystem *syst, Engine **engine) const override;

    virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const = 0;

    virtual const char *getName() const override = 0;

public:
    typedef Common::HashMap<Common::String, Common::FSNode, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> FileMap;

    virtual ADDetectedGame fallbackDetectExtern(uint md5Bytes, const FileMap &allFiles, const Common::FSList &fslist) const {
        return ADDetectedGame();
    }

    bool getFilePropertiesExtern(uint md5Bytes, const FileMap &allFiles, const ADGameDescription &game, const Common::String fname, FileProperties &fileProps) const;
};
#endif