#pragma once #include #include #include #include #include #include #include #include #include namespace { struct PluginFunctionHelperInstantiation {}; } template struct PluginFeatureFunctionHelper { static void* getFeatures(); }; template struct PluginSubCommandsFunctionHelper { static void* getSubCommands(); }; template void* PluginFeatureFunctionHelper::getFeatures() { return nullptr; } template void* PluginSubCommandsFunctionHelper::getSubCommands() { return nullptr; } #if defined (IMHEX_STATIC_LINK_PLUGINS) #define IMHEX_PLUGIN_VISIBILITY_PREFIX static #else #define IMHEX_PLUGIN_VISIBILITY_PREFIX extern "C" [[gnu::visibility("default")]] #endif /** * This macro is used to define all the required entry points for a plugin. * Name, Author and Description will be displayed in the in the plugin list on the Welcome screen. */ #define IMHEX_PLUGIN_SETUP(name, author, description) IMHEX_PLUGIN_SETUP_IMPL(name, author, description) #define IMHEX_LIBRARY_SETUP(name) IMHEX_LIBRARY_SETUP_IMPL(name) #define IMHEX_LIBRARY_SETUP_IMPL(name) \ namespace { static struct EXIT_HANDLER { ~EXIT_HANDLER() { hex::log::info("Unloaded library '{}'", name); } } HANDLER; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void initializeLibrary(); \ IMHEX_PLUGIN_VISIBILITY_PREFIX const char *getLibraryName() { return name; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void setImGuiContext(ImGuiContext *ctx) { \ ImGui::SetCurrentContext(ctx); \ GImGui = ctx; \ } \ extern "C" [[gnu::visibility("default")]] void WOLV_TOKEN_CONCAT(forceLinkPlugin_, IMHEX_PLUGIN_NAME)() { \ hex::PluginManager::addPlugin(name, hex::PluginFunctions { \ nullptr, \ initializeLibrary, \ nullptr, \ getLibraryName, \ nullptr, \ nullptr, \ nullptr, \ setImGuiContext, \ nullptr, \ nullptr \ }); \ } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void initializeLibrary() #define IMHEX_PLUGIN_SETUP_IMPL(name, author, description) \ namespace { static struct EXIT_HANDLER { ~EXIT_HANDLER() { hex::log::info("Unloaded plugin '{}'", name); } } HANDLER; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX const char *getPluginName() { return name; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX const char *getPluginAuthor() { return author; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX const char *getPluginDescription() { return description; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX const char *getCompatibleVersion() { return IMHEX_VERSION; } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void setImGuiContext(ImGuiContext *ctx) { \ ImGui::SetCurrentContext(ctx); \ GImGui = ctx; \ } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void* getFeatures() { \ return PluginFeatureFunctionHelper::getFeatures(); \ } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void* getSubCommands() { \ return PluginSubCommandsFunctionHelper::getSubCommands(); \ } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void initializePlugin(); \ extern "C" [[gnu::visibility("default")]] void WOLV_TOKEN_CONCAT(forceLinkPlugin_, IMHEX_PLUGIN_NAME)() { \ hex::PluginManager::addPlugin(name, hex::PluginFunctions { \ initializePlugin, \ nullptr, \ getPluginName, \ nullptr, \ getPluginAuthor, \ getPluginDescription, \ getCompatibleVersion, \ setImGuiContext, \ getSubCommands, \ getFeatures \ }); \ } \ IMHEX_PLUGIN_VISIBILITY_PREFIX void initializePlugin() /** * This macro is used to define subcommands defined by the plugin * A subcommand consists of a key, a description, and a callback * The key is what the first argument to ImHex should be, prefixed by `--` * For example, if the key if `help`, ImHex should be started with `--help` as its first argument to trigger the subcommand * when the subcommand is triggerred, it's callback will be executed. The callback is executed BEFORE most of ImHex initialization * so to do anything meaningful, you should subscribe to an event (like EventImHexStartupFinished) and run your code there. */ #define IMHEX_PLUGIN_SUBCOMMANDS() IMHEX_PLUGIN_SUBCOMMANDS_IMPL() #define IMHEX_PLUGIN_SUBCOMMANDS_IMPL() \ extern std::vector g_subCommands; \ template<> \ struct PluginSubCommandsFunctionHelper { \ static void* getSubCommands(); \ }; \ void* PluginSubCommandsFunctionHelper::getSubCommands() { \ return &g_subCommands; \ } \ std::vector g_subCommands #define IMHEX_FEATURE_ENABLED(feature) WOLV_TOKEN_CONCAT(WOLV_TOKEN_CONCAT(WOLV_TOKEN_CONCAT(IMHEX_PLUGIN_, IMHEX_PLUGIN_NAME), _FEATURE_), feature) #define IMHEX_PLUGIN_FEATURES() IMHEX_PLUGIN_FEATURES_IMPL() #define IMHEX_PLUGIN_FEATURES_IMPL() \ extern std::vector g_features; \ template<> \ struct PluginFeatureFunctionHelper { \ static void* getFeatures(); \ }; \ void* PluginFeatureFunctionHelper::getFeatures() { \ return &g_features; \ } \ std::vector g_features