#pragma once #include #include #include #include #include #include #include #include #include namespace hex { class View; class LanguageDefinition; namespace pl { class Evaluator; } namespace dp { class Node; } /* The Content Registry is the heart of all features in ImHex that are in some way extendable by Plugins. It allows you to add/register new content that will be picked up and used by the ImHex core or by other plugins when needed. */ struct ContentRegistry { ContentRegistry() = delete; /* Settings Registry. Allows adding of new entries into the ImHex preferences window. */ struct Settings { Settings() = delete; using Callback = std::function; struct Entry { std::string name; Callback callback; }; static void load(); static void store(); static void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, s64 defaultValue, const Callback &callback); static void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &defaultValue, const Callback &callback); static void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, s64 value); static void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &value); static void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::vector& value); static s64 read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, s64 defaultValue); static std::string read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &defaultValue); static std::vector read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::vector& defaultValue = { }); static std::map>& getEntries(); static nlohmann::json getSetting(const std::string &unlocalizedCategory, const std::string &unlocalizedName); static nlohmann::json& getSettingsData(); }; /* Command Palette Command Registry. Allows adding of new commands to the command palette */ struct CommandPaletteCommands { CommandPaletteCommands() = delete; enum class Type : u32 { SymbolCommand, KeywordCommand }; using DisplayCallback = std::function; using ExecuteCallback = std::function; struct Entry { Type type; std::string command; std::string unlocalizedDescription; DisplayCallback displayCallback; ExecuteCallback executeCallback; }; static void add(Type type, const std::string &command, const std::string &unlocalizedDescription, const DisplayCallback &displayCallback, const ExecuteCallback &executeCallback = [](auto){}); static std::vector& getEntries(); }; /* Pattern Language Function Registry. Allows adding of new functions that may be used inside the pattern language */ struct PatternLanguageFunctions { PatternLanguageFunctions() = delete; constexpr static u32 UnlimitedParameters = 0xFFFF'FFFF; constexpr static u32 MoreParametersThan = 0x8000'0000; constexpr static u32 LessParametersThan = 0x4000'0000; constexpr static u32 NoParameters = 0x0000'0000; using Namespace = std::vector; using Callback = std::function(hex::pl::Evaluator*, const std::vector&)>; struct Function { u32 parameterCount; Callback func; }; static void add(const Namespace &ns, const std::string &name, u32 parameterCount, const Callback &func); static std::map& getEntries(); }; /* View Registry. Allows adding of new windows */ struct Views { Views() = delete; template T, typename ... Args> static void add(Args&& ... args) { return add(new T(std::forward(args)...)); } static std::vector& getEntries(); private: static void add(View *view); }; /* Tools Registry. Allows adding new entries to the tools window */ struct Tools { Tools() = delete; using Callback = std::function; struct Entry { std::string name; Callback function; }; static void add(const std::string &unlocalizedName, const Callback &function); static std::vector& getEntries(); }; /* Data Inspector Registry. Allows adding of new types to the data inspector */ struct DataInspector { DataInspector() = delete; enum class NumberDisplayStyle { Decimal, Hexadecimal, Octal }; using DisplayFunction = std::function; using GeneratorFunction = std::function&, std::endian, NumberDisplayStyle)>; struct Entry { std::string unlocalizedName; size_t requiredSize; GeneratorFunction generatorFunction; }; static void add(const std::string &unlocalizedName, size_t requiredSize, GeneratorFunction function); static std::vector& getEntries(); }; /* Data Processor Node Registry. Allows adding new processor nodes to be used in the data processor */ struct DataProcessorNode { using CreatorFunction = std::function; struct Entry { std::string category; std::string name; CreatorFunction creatorFunction; }; template T, typename ... Args> static void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, Args&& ... args) { add(Entry{ unlocalizedCategory.c_str(), unlocalizedName.c_str(), [=]{ auto node = new T(std::forward(args)...); node->setUnlocalizedName(unlocalizedName); return node; } }); } static void addSeparator(); static std::vector& getEntries(); private: static void add(const Entry &entry); }; /* Language Registry. Allows together with the LangEntry class and the _lang user defined literal to add new languages */ struct Language { static void registerLanguage(const std::string &name, const std::string &languageCode); static void addLocalizations(const std::string &languageCode, const LanguageDefinition &definition); static std::map& getLanguages(); static std::map>& getLanguageDefinitions(); }; /* Interface Registry. Allows adding new items to various interfaces */ struct Interface { using DrawCallback = std::function; static void addWelcomeScreenEntry(const DrawCallback &function); static void addFooterItem(const DrawCallback &function); static void addToolbarItem(const DrawCallback &function); static std::vector& getWelcomeScreenEntries(); static std::vector& getFooterItems(); static std::vector& getToolbarItems(); }; }; }