#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std::literals::string_literals; namespace hex::plugin::builtin { static bool g_demoWindowOpen = false; namespace { bool noRunningTasks() { return TaskManager::getRunningTaskCount() == 0; } bool noRunningTaskAndValidProvider() { return noRunningTasks() && ImHexApi::Provider::isValid(); } bool noRunningTaskAndWritableProvider() { return noRunningTasks() && ImHexApi::Provider::isValid() && ImHexApi::Provider::get()->isWritable(); } } namespace { void handleIPSError(IPSError error) { TaskManager::doLater([error]{ switch (error) { case IPSError::InvalidPatchHeader: PopupError::open("hex.builtin.menu.file.export.ips.popup.invalid_patch_header_error"_lang); break; case IPSError::AddressOutOfRange: PopupError::open("hex.builtin.menu.file.export.ips.popup.address_out_of_range_error"_lang); break; case IPSError::PatchTooLarge: PopupError::open("hex.builtin.menu.file.export.ips.popup.patch_too_large_error"_lang); break; case IPSError::InvalidPatchFormat: PopupError::open("hex.builtin.menu.file.export.ips.popup.invalid_patch_format_error"_lang); break; case IPSError::MissingEOF: PopupError::open("hex.builtin.menu.file.export.ips.popup.missing_eof_error"_lang); break; } }); } } // Import namespace { void importBase64() { fs::openFileBrowser(fs::DialogMode::Open, {}, [](const auto &path) { wolv::io::File inputFile(path, wolv::io::File::Mode::Read); if (!inputFile.isValid()) { PopupError::open("hex.builtin.menu.file.import.base64.popup.open_error"_lang); return; } auto base64 = inputFile.readVector(); if (!base64.empty()) { auto data = crypt::decode64(base64); if (data.empty()) PopupError::open("hex.builtin.menu.file.import.base64.popup.import_error"_lang); else { fs::openFileBrowser(fs::DialogMode::Save, {}, [&data](const std::fs::path &path) { wolv::io::File outputFile(path, wolv::io::File::Mode::Create); if (!outputFile.isValid()) PopupError::open("hex.builtin.menu.file.import.base64.popup.import_error"_lang); outputFile.writeVector(data); }); } } else { PopupError::open("hex.builtin.popup.file_open_error"_lang); } }); } void importIPSPatch() { fs::openFileBrowser(fs::DialogMode::Open, {}, [](const auto &path) { TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [path](auto &task) { auto patchData = wolv::io::File(path, wolv::io::File::Mode::Read).readVector(); auto patch = Patches::fromIPSPatch(patchData); if (!patch.has_value()) { handleIPSError(patch.error()); return; } task.setMaxValue(patch->get().size()); auto provider = ImHexApi::Provider::get(); u64 count = 0; for (auto &[address, value] : patch->get()) { provider->write(address, &value, sizeof(value)); count += 1; task.update(count); } provider->getUndoStack().groupOperations(count, "hex.builtin.undo_operation.patches"); }); }); } void importIPS32Patch() { fs::openFileBrowser(fs::DialogMode::Open, {}, [](const auto &path) { TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [path](auto &task) { auto patchData = wolv::io::File(path, wolv::io::File::Mode::Read).readVector(); auto patch = Patches::fromIPS32Patch(patchData); if (!patch.has_value()) { handleIPSError(patch.error()); return; } task.setMaxValue(patch->get().size()); auto provider = ImHexApi::Provider::get(); u64 count = 0; for (auto &[address, value] : patch->get()) { provider->write(address, &value, sizeof(value)); count += 1; task.update(count); } provider->getUndoStack().groupOperations(count, "hex.builtin.undo_operation.patches"); }); }); } void importModifiedFile() { fs::openFileBrowser(fs::DialogMode::Open, {}, [](const auto &path) { TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [path](auto &task) { auto provider = ImHexApi::Provider::get(); auto patchData = wolv::io::File(path, wolv::io::File::Mode::Read).readVector(); if (patchData.size() != provider->getActualSize()) { PopupError::open("hex.builtin.menu.file.import.modified_file.popup.invalid_size"_lang); return; } const auto baseAddress = provider->getBaseAddress(); std::map patches; for (u64 i = 0; i < patchData.size(); i++) { u8 value = 0; provider->read(baseAddress + i, &value, 1); if (value != patchData[i]) patches[baseAddress + i] = patchData[i]; } task.setMaxValue(patches.size()); u64 count = 0; for (auto &[address, value] : patches) { provider->write(address, &value, sizeof(value)); count += 1; task.update(count); } provider->getUndoStack().groupOperations(count, "hex.builtin.undo_operation.patches"); }); }); } } // Export namespace { void exportBase64() { fs::openFileBrowser(fs::DialogMode::Save, {}, [](const auto &path) { TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [path](auto &) { wolv::io::File outputFile(path, wolv::io::File::Mode::Create); if (!outputFile.isValid()) { TaskManager::doLater([] { PopupError::open("hex.builtin.menu.file.export.base64.popup.export_error"_lang); }); return; } auto provider = ImHexApi::Provider::get(); std::vector bytes(3000); for (u64 address = 0; address < provider->getActualSize(); address += 3000) { bytes.resize(std::min(3000, provider->getActualSize() - address)); provider->read(provider->getBaseAddress() + address, bytes.data(), bytes.size()); outputFile.writeVector(crypt::encode64(bytes)); } }); }); } void drawExportLanguageMenu() { for (const auto &formatter : ContentRegistry::DataFormatter::impl::getEntries()) { if (ImGui::MenuItem(Lang(formatter.unlocalizedName), nullptr, false, ImHexApi::Provider::get()->getActualSize() > 0)) { fs::openFileBrowser(fs::DialogMode::Save, {}, [&formatter](const auto &path) { TaskManager::createTask("Exporting data", TaskManager::NoProgress, [&formatter, path](auto&){ auto provider = ImHexApi::Provider::get(); auto selection = ImHexApi::HexEditor::getSelection() .value_or( ImHexApi::HexEditor::ProviderRegion { { provider->getBaseAddress(), provider->getSize() }, provider }); auto result = formatter.callback(provider, selection.getStartAddress(), selection.getSize()); wolv::io::File file(path, wolv::io::File::Mode::Create); if (!file.isValid()) { TaskManager::doLater([] { PopupError::open("hex.builtin.menu.file.export.as_language.popup.export_error"_lang); }); return; } file.writeString(result); }); }); } } } void exportReport() { TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [](auto &) { std::string data; for (const auto &provider : ImHexApi::Provider::getProviders()) { data += hex::format("# {}", provider->getName()); data += "\n\n"; for (const auto &generator : ContentRegistry::Reports::impl::getGenerators()) { data += generator.callback(provider); data += "\n\n"; } data += "\n\n"; } TaskManager::doLater([data] { fs::openFileBrowser(fs::DialogMode::Save, { { "Markdown File", "md" }}, [&data](const auto &path) { auto file = wolv::io::File(path, wolv::io::File::Mode::Create); if (!file.isValid()) { PopupError::open("hex.builtin.menu.file.export.report.popup.export_error"_lang); return; } file.writeString(data); }); }); }); } void exportIPSPatch() { auto provider = ImHexApi::Provider::get(); auto patches = Patches::fromProvider(provider); if (!patches.has_value()) { handleIPSError(patches.error()); return; } // Make sure there's no patch at address 0x00454F46 because that would cause the patch to contain the sequence "EOF" which signals the end of the patch if (!patches->get().contains(0x00454F45) && patches->get().contains(0x00454F46)) { u8 value = 0; provider->read(0x00454F45, &value, sizeof(u8)); patches->get().at(0x00454F45) = value; } TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [patches](auto &) { auto data = patches->toIPSPatch(); TaskManager::doLater([data] { fs::openFileBrowser(fs::DialogMode::Save, {}, [&data](const auto &path) { auto file = wolv::io::File(path, wolv::io::File::Mode::Create); if (!file.isValid()) { PopupError::open("hex.builtin.menu.file.export.ips.popup.export_error"_lang); return; } if (data.has_value()) file.writeVector(data.value()); else { handleIPSError(data.error()); } AchievementManager::unlockAchievement("hex.builtin.achievement.hex_editor", "hex.builtin.achievement.hex_editor.create_patch.name"); }); }); }); } void exportIPS32Patch() { auto provider = ImHexApi::Provider::get(); auto patches = Patches::fromProvider(provider); if (!patches.has_value()) { handleIPSError(patches.error()); return; } // Make sure there's no patch at address 0x45454F46 because that would cause the patch to contain the sequence "*EOF" which signals the end of the patch if (!patches->get().contains(0x45454F45) && patches->get().contains(0x45454F46)) { u8 value = 0; provider->read(0x45454F45, &value, sizeof(u8)); patches->get().at(0x45454F45) = value; } TaskManager::createTask("hex.builtin.common.processing", TaskManager::NoProgress, [patches](auto &) { auto data = patches->toIPS32Patch(); TaskManager::doLater([data] { fs::openFileBrowser(fs::DialogMode::Save, {}, [&data](const auto &path) { auto file = wolv::io::File(path, wolv::io::File::Mode::Create); if (!file.isValid()) { PopupError::open("hex.builtin.menu.file.export.ips.popup.export_error"_lang); return; } if (data.has_value()) file.writeVector(data.value()); else { handleIPSError(data.error()); } AchievementManager::unlockAchievement("hex.builtin.achievement.hex_editor", "hex.builtin.achievement.hex_editor.create_patch.name"); }); }); }); } } /** * @brief returns true if there is a currently selected provider, and it is possibl to dump data from it */ bool isProviderDumpable() { auto provider = ImHexApi::Provider::get(); return ImHexApi::Provider::isValid() && provider->isDumpable(); } static void createFileMenu() { ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.file", 1000); /* Create File */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.create_file" }, 1050, CTRLCMD + Keys::N, [] { auto newProvider = hex::ImHexApi::Provider::createProvider("hex.builtin.provider.mem_file", true); if (newProvider != nullptr && !newProvider->open()) hex::ImHexApi::Provider::remove(newProvider); else EventProviderOpened::post(newProvider); }, noRunningTasks); /* Open File */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.open_file" }, 1100, CTRLCMD + Keys::O, [] { RequestOpenWindow::post("Open File"); }, noRunningTasks); /* Open Other */ ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.file", "hex.builtin.menu.file.open_other"}, 1150, [] { for (const auto &unlocalizedProviderName : ContentRegistry::Provider::impl::getEntries()) { if (ImGui::MenuItem(Lang(unlocalizedProviderName))) ImHexApi::Provider::createProvider(unlocalizedProviderName); } }, noRunningTasks); /* Reload Provider */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.reload_provider"}, 1250, CTRLCMD + Keys::R, [] { auto provider = ImHexApi::Provider::get(); provider->close(); if (!provider->open()) ImHexApi::Provider::remove(provider, true); }, noRunningTaskAndValidProvider); /* Project open / save */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.project", "hex.builtin.menu.file.project.open" }, 1400, ALT + Keys::O, openProject, noRunningTasks); ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.project", "hex.builtin.menu.file.project.save" }, 1450, ALT + Keys::S, saveProject, [&] { return noRunningTaskAndValidProvider() && ProjectFile::hasPath(); }); ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.project", "hex.builtin.menu.file.project.save_as" }, 1500, ALT + SHIFT + Keys::S, saveProjectAs, noRunningTaskAndValidProvider); ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.file" }, 2000); /* Import */ { /* Base 64 */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.import", "hex.builtin.menu.file.import.base64" }, 2050, Shortcut::None, importBase64, noRunningTaskAndWritableProvider); ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.file", "hex.builtin.menu.file.import" }, 2100); /* IPS */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.import", "hex.builtin.menu.file.import.ips"}, 2150, Shortcut::None, importIPSPatch, noRunningTaskAndWritableProvider); /* IPS32 */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.import", "hex.builtin.menu.file.import.ips32"}, 2200, Shortcut::None, importIPS32Patch, noRunningTaskAndWritableProvider); /* Modified File */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.import", "hex.builtin.menu.file.import.modified_file" }, 2300, Shortcut::None, importModifiedFile, noRunningTaskAndWritableProvider); } /* Export */ /* Only make them accessible if the current provider is dumpable */ { /* Base 64 */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.export", "hex.builtin.menu.file.export.base64" }, 6000, Shortcut::None, exportBase64, isProviderDumpable); /* Language */ ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.file", "hex.builtin.menu.file.export", "hex.builtin.menu.file.export.as_language" }, 6010, drawExportLanguageMenu, isProviderDumpable); /* Report */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.export", "hex.builtin.menu.file.export.report" }, 6020, Shortcut::None, exportReport, ImHexApi::Provider::isValid); ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.file", "hex.builtin.menu.file.export" }, 6050); /* IPS */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.export", "hex.builtin.menu.file.export.ips" }, 6100, Shortcut::None, exportIPSPatch, isProviderDumpable); /* IPS32 */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.export", "hex.builtin.menu.file.export.ips32" }, 6150, Shortcut::None, exportIPS32Patch, isProviderDumpable); } ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.file" }, 10000); /* Close Provider */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.close"}, 10050, CTRLCMD + Keys::W, [] { ImHexApi::Provider::remove(ImHexApi::Provider::get()); }, noRunningTaskAndValidProvider); /* Quit ImHex */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.file", "hex.builtin.menu.file.quit"}, 10100, ALT + Keys::F4, [] { ImHexApi::System::closeImHex(); }); } static void createEditMenu() { ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.edit", 2000); /* Undo */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.edit", "hex.builtin.menu.edit.undo" }, 1000, CTRLCMD + Keys::Z, [] { auto provider = ImHexApi::Provider::get(); provider->undo(); }, [&] { return ImHexApi::Provider::isValid() && ImHexApi::Provider::get()->canUndo(); }); /* Redo */ ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.edit", "hex.builtin.menu.edit.redo" }, 1050, CTRLCMD + Keys::Y, [] { auto provider = ImHexApi::Provider::get(); provider->redo(); }, [&] { return ImHexApi::Provider::isValid() && ImHexApi::Provider::get()->canRedo(); }); } static void createViewMenu() { ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.view", 3000); ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.view" }, 1000, [] { for (auto &[name, view] : ContentRegistry::Views::impl::getEntries()) { if (view->hasViewMenuItemEntry()) { auto &state = view->getWindowOpenState(); ImGui::MenuItem(Lang(view->getUnlocalizedName()), "", &state, ImHexApi::Provider::isValid() && !LayoutManager::isLayoutLocked()); } } ImGui::Separator(); #if defined(DEBUG) ImGui::MenuItem("hex.builtin.menu.view.demo"_lang, "", &g_demoWindowOpen); ImGui::MenuItem("hex.builtin.menu.view.debug"_lang, "", &hex::dbg::impl::getDebugWindowState()); #endif }); } static void createLayoutMenu() { LayoutManager::reload(); ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.workspace", 4000); ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.workspace", "hex.builtin.menu.workspace.layout", "hex.builtin.menu.workspace.layout.save" }, 1100, Shortcut::None, [] { PopupTextInput::open("hex.builtin.popup.save_layout.title"_lang, "hex.builtin.popup.save_layout.desc"_lang, [](const std::string &name) { LayoutManager::save(name); }); }, ImHexApi::Provider::isValid); ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.workspace", "hex.builtin.menu.workspace.layout" }, 1150, [] { bool locked = LayoutManager::isLayoutLocked(); if (ImGui::MenuItem("hex.builtin.menu.workspace.layout.lock"_lang, nullptr, &locked, ImHexApi::Provider::isValid())) { LayoutManager::lockLayout(locked); ContentRegistry::Settings::write("hex.builtin.setting.interface", "hex.builtin.setting.interface.layout_locked", locked); } }); ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.workspace", "hex.builtin.menu.workspace.layout" }, 1200); ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.workspace", "hex.builtin.menu.workspace.layout" }, 2000, [] { for (const auto &path : romfs::list("layouts")) { if (ImGui::MenuItem(wolv::util::capitalizeString(path.stem().string()).c_str(), "", false, ImHexApi::Provider::isValid())) { LayoutManager::loadFromString(std::string(romfs::get(path).string())); } } bool shift = ImGui::GetIO().KeyShift; for (auto &[name, path] : LayoutManager::getLayouts()) { if (ImGui::MenuItem(hex::format("{}{}", name, shift ? " " ICON_VS_X : "").c_str(), "", false, ImHexApi::Provider::isValid())) { if (shift) { wolv::io::fs::remove(path); LayoutManager::reload(); } else LayoutManager::load(path); } } }); } static void createWorkspaceMenu() { createLayoutMenu(); ContentRegistry::Interface::addMenuItemSeparator({ "hex.builtin.menu.workspace" }, 3000); ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.workspace", "hex.builtin.menu.workspace.create" }, 3100, Shortcut::None, [] { PopupTextInput::open("hex.builtin.popup.create_workspace.title"_lang, "hex.builtin.popup.create_workspace.desc"_lang, [](const std::string &name) { WorkspaceManager::createWorkspace(name); }); }, ImHexApi::Provider::isValid); ContentRegistry::Interface::addMenuItemSubMenu({ "hex.builtin.menu.workspace" }, 3200, [] { const auto &workspaces = WorkspaceManager::getWorkspaces(); for (auto it = workspaces.begin(); it != workspaces.end(); ++it) { const auto &[name, workspace] = *it; if (ImGui::MenuItem(name.c_str(), "", it == WorkspaceManager::getCurrentWorkspace(), ImHexApi::Provider::isValid())) { WorkspaceManager::switchWorkspace(name); } } }); } static void createExtrasMenu() { ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.extras", 5000); } static void createHelpMenu() { ContentRegistry::Interface::registerMainMenuItem("hex.builtin.menu.help", 6000); } void registerMainMenuEntries() { createFileMenu(); createEditMenu(); createViewMenu(); createWorkspaceMenu(); createExtrasMenu(); createHelpMenu(); (void)EventFrameEnd::subscribe([] { if (g_demoWindowOpen) { ImGui::ShowDemoWindow(&g_demoWindowOpen); ImPlot::ShowDemoWindow(&g_demoWindowOpen); } }); } }