project64/Source/Project64-core/Plugins/PluginBase.h

#pragma once

#include <Common/DynamicLibrary.h>
#include <Project64-core/Plugins/Plugin.h>
#include <Project64-core/Settings/DebugSettings.h>
#include <Project64-core/TraceModulesProject64.h>
#include <Project64-plugin-spec/Base.h>

class CPlugin :
    protected CDebugSettings
{
public:
    CPlugin();
    virtual ~CPlugin();
    inline const char * PluginName() const
    {
        return m_PluginInfo.Name;
    }
    inline bool Initialized()
    {
        return m_Initialized;
    }

    virtual int32_t GetDefaultSettingStartRange() const = 0;
    virtual int32_t GetSettingStartRange() const = 0;

    bool Load(const char * FileName);

    void RomOpened(RenderWindow * Render);
    void RomClose(RenderWindow * Render);
    void GameReset(RenderWindow * Render);
    void Close(RenderWindow * Render);

    void(CALL * DllAbout)(void * hWnd);
    void(CALL * DllConfig)(void * hParent);

    static bool ValidPluginVersion(PLUGIN_INFO & PluginInfo);

protected:
    void UnloadPlugin();
    const char * PluginType() const;
    TraceModuleProject64 PluginTraceType() const;
    virtual void UnloadPluginDetails() = 0;
    virtual PLUGIN_TYPE type() = 0;
    virtual bool LoadFunctions(void) = 0;

    void(CALL * CloseDLL)(void);
    void(CALL * RomOpen)(void);
    void(CALL * RomClosed)(void);
    void(CALL * PluginOpened)(void);
    void(CALL * SetSettingInfo)(PLUGIN_SETTINGS *);
    void(CALL * SetSettingInfo2)(PLUGIN_SETTINGS2 *);
    void(CALL * SetSettingInfo3)(PLUGIN_SETTINGS3 *);
    void(CALL * SetSettingNotificationInfo)(PLUGIN_SETTINGS_NOTIFICATION *);
    void(CALL * SetPluginNotification)(PLUGIN_NOTIFICATION *);

    DynLibHandle m_LibHandle;
    bool m_Initialized, m_RomOpen;
    PLUGIN_INFO m_PluginInfo;

    // Loads a function pointer from the currently loaded DLL
    void _LoadFunctionVoid(const char * szFunctionName, void ** functionPointer)
    {
        *functionPointer = DynamicLibraryGetProc(m_LibHandle, szFunctionName);
    }

    // Simple wrapper around _LoadFunction() to avoid having to specify the same two arguments
    // i.e. _LoadFunction("CloseDLL", CloseDLL);
#define LoadFunction(functionName) _LoadFunctionVoid(#functionName, (void **)&functionName)
#define _LoadFunction(functionName, function) _LoadFunctionVoid(functionName, (void **)&function)

private:
    static void DisplayError(const char * Message);
    static void FatalError(const char * Message);
    static void DisplayMessage(int DisplayTime, const char * Message);
    static void DisplayMessage2(const char * Message);
    static void BreakPoint(const char * FileName, int32_t LineNumber);
};