#include #include #include #include #include #include #include #include #if defined(OS_WEB) #include #endif #include #include #include namespace hex { namespace ContentRegistry::Settings { [[maybe_unused]] constexpr auto SettingsFile = "settings.json"; namespace impl { nlohmann::json& getSetting(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const nlohmann::json &defaultValue) { auto &settings = getSettingsData(); if (!settings.contains(unlocalizedCategory)) settings[unlocalizedCategory] = {}; if (!settings[unlocalizedCategory].contains(unlocalizedName)) settings[unlocalizedCategory][unlocalizedName] = defaultValue; return settings[unlocalizedCategory][unlocalizedName]; } nlohmann::json &getSettingsData() { static nlohmann::json settings; return settings; } #if defined(OS_WEB) void load() { char *data = (char *) MAIN_THREAD_EM_ASM_INT({ let data = localStorage.getItem("config"); return data ? stringToNewUTF8(data) : null; }); if (data == nullptr) { store(); } else { getSettingsData() = nlohmann::json::parse(data); } } void store() { auto data = getSettingsData().dump(); MAIN_THREAD_EM_ASM({ localStorage.setItem("config", UTF8ToString($0)); }, data.c_str()); } void clear() { MAIN_THREAD_EM_ASM({ localStorage.removeItem("config"); }); } #else void load() { bool loaded = false; for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) { wolv::io::File file(dir / SettingsFile, wolv::io::File::Mode::Read); if (file.isValid()) { getSettingsData() = nlohmann::json::parse(file.readString()); loaded = true; break; } } if (!loaded) store(); } void store() { // During a crash settings can be empty, causing them to be overwritten. if(getSettingsData().empty()) { return; } for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) { wolv::io::File file(dir / SettingsFile, wolv::io::File::Mode::Create); if (file.isValid()) { file.writeString(getSettingsData().dump(4)); break; } } } void clear() { for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) { wolv::io::fs::remove(dir / SettingsFile); } } #endif template static T* insertOrGetEntry(std::vector &vector, const std::string &unlocalizedName) { T *foundEntry = nullptr; for (auto &entry : vector) { if (entry.unlocalizedName == unlocalizedName) { foundEntry = &entry; break; } } if (foundEntry == nullptr) { if (unlocalizedName.empty()) foundEntry = &*vector.emplace(vector.begin(), unlocalizedName); else foundEntry = &vector.emplace_back(unlocalizedName); } return foundEntry; } std::vector &getSettings() { static std::vector categories; return categories; } Widgets::Widget* add(const std::string &unlocalizedCategory, const std::string &unlocalizedSubCategory, const std::string &unlocalizedName, std::unique_ptr &&widget) { const auto category = insertOrGetEntry(getSettings(), unlocalizedCategory); const auto subCategory = insertOrGetEntry(category->subCategories, unlocalizedSubCategory); const auto entry = insertOrGetEntry(subCategory->entries, unlocalizedName); entry->widget = std::move(widget); entry->widget->load(getSetting(unlocalizedCategory, unlocalizedName, entry->widget->store())); entry->widget->onChanged(); return entry->widget.get(); } } void setCategoryDescription(const std::string &unlocalizedCategory, const std::string &unlocalizedDescription) { const auto category = insertOrGetEntry(impl::getSettings(), unlocalizedCategory); category->unlocalizedDescription = unlocalizedDescription; } nlohmann::json read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const nlohmann::json &defaultValue) { auto setting = impl::getSetting(unlocalizedCategory, unlocalizedName, defaultValue); if (setting.is_number() && defaultValue.is_boolean()) setting = setting.get() != 0; return setting; } void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const nlohmann::json &value) { impl::getSetting(unlocalizedCategory, unlocalizedName, value) = value; } namespace Widgets { bool Checkbox::draw(const std::string &name) { return ImGui::Checkbox(name.c_str(), &this->m_value); } void Checkbox::load(const nlohmann::json &data) { if (data.is_number()) { this->m_value = data.get() != 0; } else if (data.is_boolean()) { this->m_value = data.get(); } else { log::warn("Invalid data type loaded from settings for checkbox!"); } } nlohmann::json Checkbox::store() { return this->m_value; } bool SliderInteger::draw(const std::string &name) { return ImGui::SliderInt(name.c_str(), &this->m_value, this->m_min, this->m_max); } void SliderInteger::load(const nlohmann::json &data) { if (data.is_number_integer()) { this->m_value = data.get(); } else { log::warn("Invalid data type loaded from settings for slider!"); } } nlohmann::json SliderInteger::store() { return this->m_value; } bool SliderFloat::draw(const std::string &name) { return ImGui::SliderFloat(name.c_str(), &this->m_value, this->m_min, this->m_max); } void SliderFloat::load(const nlohmann::json &data) { if (data.is_number()) { this->m_value = data.get(); } else { log::warn("Invalid data type loaded from settings for slider!"); } } nlohmann::json SliderFloat::store() { return this->m_value; } ColorPicker::ColorPicker(ImColor defaultColor) { this->m_value = { defaultColor.Value.x, defaultColor.Value.y, defaultColor.Value.z, defaultColor.Value.w }; } bool ColorPicker::draw(const std::string &name) { return ImGui::ColorEdit4(name.c_str(), this->m_value.data(), ImGuiColorEditFlags_NoInputs); } void ColorPicker::load(const nlohmann::json &data) { if (data.is_number()) { ImColor color(data.get()); this->m_value = { color.Value.x, color.Value.y, color.Value.z, color.Value.w }; } else { log::warn("Invalid data type loaded from settings for color picker!"); } } nlohmann::json ColorPicker::store() { const ImColor color(this->m_value[0], this->m_value[1], this->m_value[2], this->m_value[3]); return static_cast(color); } ImColor ColorPicker::getColor() const { return { this->m_value[0], this->m_value[1], this->m_value[2], this->m_value[3] }; } bool DropDown::draw(const std::string &name) { const char *preview = ""; if (static_cast(this->m_value) < this->m_items.size()) preview = this->m_items[this->m_value].c_str(); bool changed = false; if (ImGui::BeginCombo(name.c_str(), LangEntry(preview))) { int index = 0; for (const auto &item : this->m_items) { const bool selected = index == this->m_value; if (ImGui::Selectable(LangEntry(item), selected)) { this->m_value = index; changed = true; } if (selected) ImGui::SetItemDefaultFocus(); index += 1; } ImGui::EndCombo(); } return changed; } void DropDown::load(const nlohmann::json &data) { this->m_value = 0; int defaultItemIndex = 0; int index = 0; for (const auto &item : this->m_settingsValues) { if (item == this->m_defaultItem) defaultItemIndex = index; if (item == data) { this->m_value = index; return; } index += 1; } this->m_value = defaultItemIndex; } nlohmann::json DropDown::store() { if (this->m_value == -1) return this->m_defaultItem; if (static_cast(this->m_value) >= this->m_items.size()) return this->m_defaultItem; return this->m_settingsValues[this->m_value]; } const nlohmann::json& DropDown::getValue() const { return this->m_settingsValues[this->m_value]; } bool TextBox::draw(const std::string &name) { return ImGui::InputText(name.c_str(), this->m_value); } void TextBox::load(const nlohmann::json &data) { if (data.is_string()) { this->m_value = data.get(); } else { log::warn("Invalid data type loaded from settings for text box!"); } } nlohmann::json TextBox::store() { return this->m_value; } bool FilePicker::draw(const std::string &name) { bool changed = false; if (ImGui::InputText("##font_path", this->m_value)) { changed = true; } ImGui::SameLine(); if (ImGui::IconButton(ICON_VS_FOLDER_OPENED, ImGui::GetStyleColorVec4(ImGuiCol_Text))) { return fs::openFileBrowser(fs::DialogMode::Open, { { "TTF Font", "ttf" }, { "OTF Font", "otf" } }, [&](const std::fs::path &path) { this->m_value = wolv::util::toUTF8String(path); }); } ImGui::SameLine(); ImGui::TextFormatted("{}", name); return changed; } void FilePicker::load(const nlohmann::json &data) { if (data.is_string()) { this->m_value = data.get(); } else { log::warn("Invalid data type loaded from settings for file picker!"); } } nlohmann::json FilePicker::store() { return this->m_value; } } } namespace ContentRegistry::CommandPaletteCommands { void add(Type type, const std::string &command, const std::string &unlocalizedDescription, const impl::DisplayCallback &displayCallback, const impl::ExecuteCallback &executeCallback) { log::debug("Registered new command palette command: {}", command); impl::getEntries().push_back(impl::Entry { type, command, unlocalizedDescription, displayCallback, executeCallback }); } void addHandler(Type type, const std::string &command, const impl::QueryCallback &queryCallback, const impl::DisplayCallback &displayCallback) { log::debug("Registered new command palette command handler: {}", command); impl::getHandlers().push_back(impl::Handler { type, command, queryCallback, displayCallback }); } namespace impl { std::vector &getEntries() { static std::vector commands; return commands; } std::vector &getHandlers() { static std::vector commands; return commands; } } } namespace ContentRegistry::PatternLanguage { static std::string getFunctionName(const pl::api::Namespace &ns, const std::string &name) { std::string functionName; for (auto &scope : ns) functionName += scope + "::"; functionName += name; return functionName; } pl::PatternLanguage& getRuntime() { static PerProvider runtime; return *runtime; } std::mutex& getRuntimeLock() { static std::mutex runtimeLock; return runtimeLock; } void configureRuntime(pl::PatternLanguage &runtime, prv::Provider *provider) { runtime.reset(); if (provider != nullptr) { runtime.setDataSource(provider->getBaseAddress(), provider->getActualSize(), [provider](u64 offset, u8 *buffer, size_t size) { provider->read(offset, buffer, size); }, [provider](u64 offset, const u8 *buffer, size_t size) { if (provider->isWritable()) provider->write(offset, buffer, size); } ); } runtime.setIncludePaths(fs::getDefaultPaths(fs::ImHexPath::PatternsInclude) | fs::getDefaultPaths(fs::ImHexPath::Patterns)); for (const auto &[ns, name, paramCount, callback, dangerous] : impl::getFunctions()) { if (dangerous) runtime.addDangerousFunction(ns, name, paramCount, callback); else runtime.addFunction(ns, name, paramCount, callback); } for (const auto &[name, callback] : impl::getPragmas()) { runtime.addPragma(name, callback); } runtime.addDefine("__IMHEX__"); runtime.addDefine("__IMHEX_VERSION__", ImHexApi::System::getImHexVersion()); } void addPragma(const std::string &name, const pl::api::PragmaHandler &handler) { log::debug("Registered new pattern language pragma: {}", name); impl::getPragmas()[name] = handler; } void addFunction(const pl::api::Namespace &ns, const std::string &name, pl::api::FunctionParameterCount parameterCount, const pl::api::FunctionCallback &func) { log::debug("Registered new pattern language function: {}", getFunctionName(ns, name)); impl::getFunctions().push_back({ ns, name, parameterCount, func, false }); } void addDangerousFunction(const pl::api::Namespace &ns, const std::string &name, pl::api::FunctionParameterCount parameterCount, const pl::api::FunctionCallback &func) { log::debug("Registered new dangerous pattern language function: {}", getFunctionName(ns, name)); impl::getFunctions().push_back({ ns, name, parameterCount, func, true }); } void addVisualizer(const std::string &name, const impl::VisualizerFunctionCallback &function, pl::api::FunctionParameterCount parameterCount) { log::debug("Registered new pattern visualizer function: {}", name); impl::getVisualizers()[name] = impl::Visualizer { parameterCount, function }; } void addInlineVisualizer(const std::string &name, const impl::VisualizerFunctionCallback &function, pl::api::FunctionParameterCount parameterCount) { log::debug("Registered new inline pattern visualizer function: {}", name); impl::getInlineVisualizers()[name] = impl::Visualizer { parameterCount, function }; } namespace impl { std::map &getVisualizers() { static std::map visualizers; return visualizers; } std::map &getInlineVisualizers() { static std::map visualizers; return visualizers; } std::map &getPragmas() { static std::map pragmas; return pragmas; } std::vector &getFunctions() { static std::vector functions; return functions; } } } namespace ContentRegistry::Views { namespace impl { std::map> &getEntries() { static std::map> views; return views; } } void impl::add(std::unique_ptr &&view) { log::debug("Registered new view: {}", view->getUnlocalizedName()); getEntries().insert({ view->getUnlocalizedName(), std::move(view) }); } View* getViewByName(const std::string &unlocalizedName) { auto &views = impl::getEntries(); if (views.contains(unlocalizedName)) return views[unlocalizedName].get(); else return nullptr; } } namespace ContentRegistry::Tools { void add(const std::string &unlocalizedName, const impl::Callback &function) { log::debug("Registered new tool: {}", unlocalizedName); impl::getEntries().emplace_back(impl::Entry { unlocalizedName, function, false }); } namespace impl { std::vector &getEntries() { static std::vector tools; return tools; } } } namespace ContentRegistry::DataInspector { void add(const std::string &unlocalizedName, size_t requiredSize, impl::GeneratorFunction displayGeneratorFunction, std::optional editingFunction) { log::debug("Registered new data inspector format: {}", unlocalizedName); impl::getEntries().push_back({ unlocalizedName, requiredSize, requiredSize, std::move(displayGeneratorFunction), std::move(editingFunction) }); } void add(const std::string &unlocalizedName, size_t requiredSize, size_t maxSize, impl::GeneratorFunction displayGeneratorFunction, std::optional editingFunction) { log::debug("Registered new data inspector format: {}", unlocalizedName); impl::getEntries().push_back({ unlocalizedName, requiredSize, maxSize, std::move(displayGeneratorFunction), std::move(editingFunction) }); } namespace impl { std::vector &getEntries() { static std::vector entries; return entries; } } } namespace ContentRegistry::DataProcessorNode { void impl::add(const Entry &entry) { log::debug("Registered new data processor node type: [{}]: {}", entry.category, entry.name); getEntries().push_back(entry); } void addSeparator() { impl::getEntries().push_back({ "", "", [] { return nullptr; } }); } namespace impl { std::vector &getEntries() { static std::vector nodes; return nodes; } } } namespace ContentRegistry::Language { void addLocalization(const nlohmann::json &data) { if (!data.is_object()) return; if (!data.contains("code") || !data.contains("country") || !data.contains("language") || !data.contains("translations")) { log::error("Localization data is missing required fields!"); return; } const auto &code = data["code"]; const auto &country = data["country"]; const auto &language = data["language"]; const auto &translations = data["translations"]; if (!code.is_string() || !country.is_string() || !language.is_string() || !translations.is_object()) { log::error("Localization data has invalid fields!"); return; } if (data.contains("fallback")) { const auto &fallback = data["fallback"]; if (fallback.is_boolean() && fallback.get()) LangEntry::setFallbackLanguage(code.get()); } impl::getLanguages().insert({ code.get(), hex::format("{} ({})", language.get(), country.get()) }); std::map translationDefinitions; for (auto &[key, value] : translations.items()) { if (!value.is_string()) { log::error("Localization data has invalid fields!"); continue; } translationDefinitions[key] = value.get(); } impl::getLanguageDefinitions()[code.get()].emplace_back(std::move(translationDefinitions)); } namespace impl { std::map &getLanguages() { static std::map languages; return languages; } std::map> &getLanguageDefinitions() { static std::map> definitions; return definitions; } } } namespace ContentRegistry::Interface { void registerMainMenuItem(const std::string &unlocalizedName, u32 priority) { log::debug("Registered new main menu item: {}", unlocalizedName); impl::getMainMenuItems().insert({ priority, { unlocalizedName } }); } void addMenuItem(const std::vector &unlocalizedMainMenuNames, u32 priority, const Shortcut &shortcut, const impl::MenuCallback &function, const impl::EnabledCallback& enabledCallback, View *view) { log::debug("Added new menu item to menu {} with priority {}", wolv::util::combineStrings(unlocalizedMainMenuNames, " -> "), priority); impl::getMenuItems().insert({ priority, { unlocalizedMainMenuNames, shortcut, function, enabledCallback } }); if (shortcut.isLocal() && view != nullptr) ShortcutManager::addShortcut(view, shortcut, function); else ShortcutManager::addGlobalShortcut(shortcut, function); } void addMenuItemSubMenu(std::vector unlocalizedMainMenuNames, u32 priority, const impl::MenuCallback &function, const impl::EnabledCallback& enabledCallback) { log::debug("Added new menu item sub menu to menu {} with priority {}", wolv::util::combineStrings(unlocalizedMainMenuNames, " -> "), priority); unlocalizedMainMenuNames.emplace_back(impl::SubMenuValue); impl::getMenuItems().insert({ priority, { unlocalizedMainMenuNames, {}, function, enabledCallback } }); } void addMenuItemSeparator(std::vector unlocalizedMainMenuNames, u32 priority) { unlocalizedMainMenuNames.emplace_back(impl::SeparatorValue); impl::getMenuItems().insert({ priority, { unlocalizedMainMenuNames, {}, []{}, []{ return true; } } }); } void addWelcomeScreenEntry(const impl::DrawCallback &function) { impl::getWelcomeScreenEntries().push_back(function); } void addFooterItem(const impl::DrawCallback &function) { impl::getFooterItems().push_back(function); } void addToolbarItem(const impl::DrawCallback &function) { impl::getToolbarItems().push_back(function); } void addSidebarItem(const std::string &icon, const impl::DrawCallback &function) { impl::getSidebarItems().push_back({ icon, function }); } void addTitleBarButton(const std::string &icon, const std::string &unlocalizedTooltip, const impl::ClickCallback &function) { impl::getTitleBarButtons().push_back({ icon, unlocalizedTooltip, function }); } namespace impl { std::multimap &getMainMenuItems() { static std::multimap items; return items; } std::multimap &getMenuItems() { static std::multimap items; return items; } std::vector &getWelcomeScreenEntries() { static std::vector entries; return entries; } std::vector &getFooterItems() { static std::vector items; return items; } std::vector &getToolbarItems() { static std::vector items; return items; } std::vector &getSidebarItems() { static std::vector items; return items; } std::vector &getTitleBarButtons() { static std::vector buttons; return buttons; } } } namespace ContentRegistry::Provider { void impl::addProviderName(const std::string &unlocalizedName) { log::debug("Registered new provider: {}", unlocalizedName); getEntries().push_back(unlocalizedName); } namespace impl { std::vector &getEntries() { static std::vector providerNames; return providerNames; } } } namespace ContentRegistry::DataFormatter { void add(const std::string &unlocalizedName, const impl::Callback &callback) { log::debug("Registered new data formatter: {}", unlocalizedName); impl::getEntries().push_back({ unlocalizedName, callback }); } namespace impl { std::vector &getEntries() { static std::vector entries; return entries; } } } namespace ContentRegistry::FileHandler { void add(const std::vector &extensions, const impl::Callback &callback) { for (const auto &extension : extensions) log::debug("Registered new data handler for extensions: {}", extension); impl::getEntries().push_back({ extensions, callback }); } namespace impl { std::vector &getEntries() { static std::vector entries; return entries; } } } namespace ContentRegistry::HexEditor { const int DataVisualizer::TextInputFlags = ImGuiInputTextFlags_AutoSelectAll | ImGuiInputTextFlags_NoHorizontalScroll; bool DataVisualizer::drawDefaultScalarEditingTextBox(u64 address, const char *format, ImGuiDataType dataType, u8 *data, ImGuiInputTextFlags flags) const { struct UserData { u8 *data; i32 maxChars; bool editingDone; }; UserData userData = { .data = data, .maxChars = this->getMaxCharsPerCell(), .editingDone = false }; ImGui::PushID(reinterpret_cast(address)); ImGui::InputScalarCallback("##editing_input", dataType, data, format, flags | TextInputFlags | ImGuiInputTextFlags_CallbackEdit, [](ImGuiInputTextCallbackData *data) -> int { auto &userData = *static_cast(data->UserData); if (data->BufTextLen >= userData.maxChars) userData.editingDone = true; return 0; }, &userData); ImGui::PopID(); return userData.editingDone || ImGui::IsKeyPressed(ImGuiKey_Enter) || ImGui::IsKeyPressed(ImGuiKey_Escape); } bool DataVisualizer::drawDefaultTextEditingTextBox(u64 address, std::string &data, ImGuiInputTextFlags flags) const { struct UserData { std::string *data; i32 maxChars; bool editingDone; }; UserData userData = { .data = &data, .maxChars = this->getMaxCharsPerCell(), .editingDone = false }; ImGui::PushID(reinterpret_cast(address)); ImGui::InputText("##editing_input", data.data(), data.size() + 1, flags | TextInputFlags | ImGuiInputTextFlags_CallbackEdit, [](ImGuiInputTextCallbackData *data) -> int { auto &userData = *static_cast(data->UserData); userData.data->resize(data->BufSize); if (data->BufTextLen >= userData.maxChars) userData.editingDone = true; return 0; }, &userData); ImGui::PopID(); return userData.editingDone || ImGui::IsKeyPressed(ImGuiKey_Enter) || ImGui::IsKeyPressed(ImGuiKey_Escape); } namespace impl { void addDataVisualizer(std::shared_ptr &&visualizer) { getVisualizers().emplace_back(std::move(visualizer)); } std::vector> &getVisualizers() { static std::vector> visualizers; return visualizers; } } std::shared_ptr getVisualizerByName(const std::string &unlocalizedName) { for (const auto &visualizer : impl::getVisualizers()) { if (visualizer->getUnlocalizedName() == unlocalizedName) return visualizer; } return nullptr; } } namespace ContentRegistry::Hashes { namespace impl { std::vector> &getHashes() { static std::vector> hashes; return hashes; } void add(std::unique_ptr &&hash) { getHashes().emplace_back(std::move(hash)); } } } namespace ContentRegistry::BackgroundServices { namespace impl { std::vector &getServices() { static std::vector services; return services; } void stopServices() { for (auto &service : getServices()) { service.thread.request_stop(); } for (auto &service : getServices()) { if (service.thread.joinable()) service.thread.join(); } } } void registerService(const std::string &unlocalizedName, const impl::Callback &callback) { log::debug("Registered new background service: {}", unlocalizedName); impl::getServices().push_back(impl::Service { unlocalizedName, std::jthread([callback = auto(callback)](const std::stop_token &stopToken){ while (!stopToken.stop_requested()) { callback(); std::this_thread::sleep_for(std::chrono::milliseconds(50)); } }) }); } } namespace ContentRegistry::CommunicationInterface { namespace impl { std::map &getNetworkEndpoints() { static std::map endpoints; return endpoints; } } void registerNetworkEndpoint(const std::string &endpoint, const impl::NetworkCallback &callback) { log::debug("Registered new network endpoint: {}", endpoint); impl::getNetworkEndpoints().insert({ endpoint, callback }); } } namespace ContentRegistry::Experiments { namespace impl { std::map &getExperiments() { static std::map experiments; return experiments; } } void addExperiment(const std::string &experimentName, const std::string &unlocalizedName, const std::string &unlocalizedDescription) { auto &experiments = impl::getExperiments(); if (experiments.contains(experimentName)) { log::error("Experiment with name '{}' already exists!", experimentName); return; } experiments[experimentName] = impl::Experiment { .unlocalizedName = unlocalizedName, .unlocalizedDescription = unlocalizedDescription, .enabled = false }; } void enableExperiement(const std::string &experimentName, bool enabled) { auto &experiments = impl::getExperiments(); if (!experiments.contains(experimentName)) { log::error("Experiment with name '{}' does not exist!", experimentName); return; } experiments[experimentName].enabled = enabled; } [[nodiscard]] bool isExperimentEnabled(const std::string &experimentName) { auto &experiments = impl::getExperiments(); if (!experiments.contains(experimentName)) { log::error("Experiment with name '{}' does not exist!", experimentName); return false; } return experiments[experimentName].enabled; } } }