614 lines
21 KiB
C++
614 lines
21 KiB
C++
#include <hex/api/content_registry.hpp>
|
|
|
|
#include <hex/helpers/fs.hpp>
|
|
#include <hex/helpers/logger.hpp>
|
|
|
|
#include <hex/ui/view.hpp>
|
|
|
|
#include <filesystem>
|
|
#include <fstream>
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
namespace hex {
|
|
|
|
namespace ContentRegistry::Settings {
|
|
|
|
constexpr auto SettingsFile = "settings.json";
|
|
|
|
void load() {
|
|
bool loaded = false;
|
|
for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) {
|
|
std::ifstream settingsFile(dir / SettingsFile);
|
|
|
|
if (settingsFile.good()) {
|
|
settingsFile >> getSettingsData();
|
|
loaded = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!loaded)
|
|
store();
|
|
}
|
|
|
|
void store() {
|
|
for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) {
|
|
std::ofstream settingsFile(dir / SettingsFile, std::ios::trunc);
|
|
|
|
if (settingsFile.good()) {
|
|
settingsFile << getSettingsData();
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
void clear() {
|
|
for (const auto &dir : fs::getDefaultPaths(fs::ImHexPath::Config)) {
|
|
hex::fs::remove(dir / SettingsFile);
|
|
}
|
|
}
|
|
|
|
static auto getCategoryEntry(const std::string &unlocalizedCategory) {
|
|
auto &entries = getEntries();
|
|
const size_t curSlot = entries.size();
|
|
auto found = entries.find(Category { unlocalizedCategory });
|
|
|
|
if (found == entries.end()) {
|
|
auto [iter, _] = entries.emplace(Category { unlocalizedCategory, curSlot }, std::vector<Entry> {});
|
|
return iter;
|
|
}
|
|
|
|
return found;
|
|
}
|
|
|
|
void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, i64 defaultValue, const Callback &callback, bool requiresRestart) {
|
|
log::debug("Registered new integer setting: [{}]: {}", unlocalizedCategory, unlocalizedName);
|
|
|
|
getCategoryEntry(unlocalizedCategory)->second.emplace_back(Entry { unlocalizedName, requiresRestart, callback });
|
|
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName) || !json[unlocalizedCategory][unlocalizedName].is_number())
|
|
json[unlocalizedCategory][unlocalizedName] = int(defaultValue);
|
|
}
|
|
|
|
void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &defaultValue, const Callback &callback, bool requiresRestart) {
|
|
log::debug("Registered new string setting: [{}]: {}", unlocalizedCategory, unlocalizedName);
|
|
|
|
getCategoryEntry(unlocalizedCategory)->second.emplace_back(Entry { unlocalizedName, requiresRestart, callback });
|
|
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName) || !json[unlocalizedCategory][unlocalizedName].is_string())
|
|
json[unlocalizedCategory][unlocalizedName] = std::string(defaultValue);
|
|
}
|
|
|
|
void add(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::vector<std::string> &defaultValue, const Callback &callback, bool requiresRestart) {
|
|
log::debug("Registered new string array setting: [{}]: {}", unlocalizedCategory, unlocalizedName);
|
|
|
|
getCategoryEntry(unlocalizedCategory)->second.emplace_back(Entry { unlocalizedName, requiresRestart, callback });
|
|
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName) || !json[unlocalizedCategory][unlocalizedName].is_array())
|
|
json[unlocalizedCategory][unlocalizedName] = defaultValue;
|
|
}
|
|
|
|
void addCategoryDescription(const std::string &unlocalizedCategory, const std::string &unlocalizedCategoryDescription) {
|
|
getCategoryDescriptions()[unlocalizedCategory] = unlocalizedCategoryDescription;
|
|
}
|
|
|
|
void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, i64 value) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
|
|
json[unlocalizedCategory][unlocalizedName] = value;
|
|
}
|
|
|
|
void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &value) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
|
|
json[unlocalizedCategory][unlocalizedName] = value;
|
|
}
|
|
|
|
void write(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::vector<std::string> &value) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
json[unlocalizedCategory] = nlohmann::json::object();
|
|
|
|
json[unlocalizedCategory][unlocalizedName] = value;
|
|
}
|
|
|
|
|
|
i64 read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, i64 defaultValue) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
return defaultValue;
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName))
|
|
return defaultValue;
|
|
|
|
if (!json[unlocalizedCategory][unlocalizedName].is_number())
|
|
json[unlocalizedCategory][unlocalizedName] = defaultValue;
|
|
|
|
return json[unlocalizedCategory][unlocalizedName].get<i64>();
|
|
}
|
|
|
|
std::string read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::string &defaultValue) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
return defaultValue;
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName))
|
|
return defaultValue;
|
|
|
|
if (!json[unlocalizedCategory][unlocalizedName].is_string())
|
|
json[unlocalizedCategory][unlocalizedName] = defaultValue;
|
|
|
|
return json[unlocalizedCategory][unlocalizedName].get<std::string>();
|
|
}
|
|
|
|
std::vector<std::string> read(const std::string &unlocalizedCategory, const std::string &unlocalizedName, const std::vector<std::string> &defaultValue) {
|
|
auto &json = getSettingsData();
|
|
|
|
if (!json.contains(unlocalizedCategory))
|
|
return defaultValue;
|
|
if (!json[unlocalizedCategory].contains(unlocalizedName))
|
|
return defaultValue;
|
|
|
|
if (!json[unlocalizedCategory][unlocalizedName].is_array())
|
|
json[unlocalizedCategory][unlocalizedName] = defaultValue;
|
|
|
|
if (!json[unlocalizedCategory][unlocalizedName].array().empty() && !json[unlocalizedCategory][unlocalizedName][0].is_string())
|
|
json[unlocalizedCategory][unlocalizedName] = defaultValue;
|
|
|
|
return json[unlocalizedCategory][unlocalizedName].get<std::vector<std::string>>();
|
|
}
|
|
|
|
|
|
std::map<Category, std::vector<Entry>> &getEntries() {
|
|
static std::map<Category, std::vector<Entry>> entries;
|
|
|
|
return entries;
|
|
}
|
|
|
|
std::map<std::string, std::string> &getCategoryDescriptions() {
|
|
static std::map<std::string, std::string> descriptions;
|
|
|
|
return descriptions;
|
|
}
|
|
|
|
nlohmann::json getSetting(const std::string &unlocalizedCategory, const std::string &unlocalizedName) {
|
|
auto &settings = getSettingsData();
|
|
|
|
if (!settings.contains(unlocalizedCategory)) return {};
|
|
if (!settings[unlocalizedCategory].contains(unlocalizedName)) return {};
|
|
|
|
return settings[unlocalizedCategory][unlocalizedName];
|
|
}
|
|
|
|
nlohmann::json &getSettingsData() {
|
|
static nlohmann::json settings;
|
|
|
|
return settings;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
namespace ContentRegistry::CommandPaletteCommands {
|
|
|
|
void add(Type type, const std::string &command, const std::string &unlocalizedDescription, const DisplayCallback &displayCallback, const ExecuteCallback &executeCallback) {
|
|
log::debug("Registered new command palette command: {}", command);
|
|
|
|
getEntries().push_back(ContentRegistry::CommandPaletteCommands::Entry { type, command, unlocalizedDescription, displayCallback, executeCallback });
|
|
}
|
|
|
|
std::vector<Entry> &getEntries() {
|
|
static std::vector<Entry> 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;
|
|
}
|
|
|
|
std::unique_ptr<pl::PatternLanguage> createDefaultRuntime(prv::Provider *provider) {
|
|
auto runtime = std::make_unique<pl::PatternLanguage>();
|
|
|
|
runtime->setDataSource([provider](u64 offset, u8 *buffer, size_t size) {
|
|
provider->read(offset, buffer, size);
|
|
}, 0, 0);
|
|
|
|
runtime->setIncludePaths(fs::getDefaultPaths(fs::ImHexPath::PatternsInclude));
|
|
|
|
for (const auto &func : getFunctions()) {
|
|
if (func.dangerous)
|
|
runtime->addDangerousFunction(func.ns, func.name, func.parameterCount, func.callback);
|
|
else
|
|
runtime->addFunction(func.ns, func.name, func.parameterCount, func.callback);
|
|
}
|
|
|
|
for (const auto &[name, callback] : getPragmas()) {
|
|
runtime->addPragma(name, callback);
|
|
}
|
|
|
|
return runtime;
|
|
}
|
|
|
|
void addPragma(const std::string &name, const pl::api::PragmaHandler &handler) {
|
|
log::debug("Registered new pattern language pragma: {}", name);
|
|
|
|
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));
|
|
|
|
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));
|
|
|
|
getFunctions().push_back({
|
|
ns, name,
|
|
parameterCount, func,
|
|
true
|
|
});
|
|
}
|
|
|
|
std::map<std::string, pl::api::PragmaHandler> &getPragmas() {
|
|
static std::map<std::string, pl::api::PragmaHandler> pragmas;
|
|
|
|
return pragmas;
|
|
}
|
|
|
|
std::vector<impl::FunctionDefinition> &getFunctions() {
|
|
static std::vector<impl::FunctionDefinition> functions;
|
|
|
|
return functions;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
namespace ContentRegistry::Views {
|
|
|
|
void impl::add(View *view) {
|
|
log::debug("Registered new view: {}", view->getUnlocalizedName());
|
|
|
|
getEntries().insert({ view->getUnlocalizedName(), view });
|
|
}
|
|
|
|
std::map<std::string, View *> &getEntries() {
|
|
static std::map<std::string, View *> views;
|
|
|
|
return views;
|
|
}
|
|
|
|
View *getViewByName(const std::string &unlocalizedName) {
|
|
auto &views = getEntries();
|
|
|
|
if (views.contains(unlocalizedName))
|
|
return views[unlocalizedName];
|
|
else
|
|
return nullptr;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::Tools {
|
|
|
|
void add(const std::string &unlocalizedName, const impl::Callback &function) {
|
|
log::debug("Registered new tool: {}", unlocalizedName);
|
|
|
|
getEntries().emplace_back(impl::Entry { unlocalizedName, function });
|
|
}
|
|
|
|
std::vector<impl::Entry> &getEntries() {
|
|
static std::vector<impl::Entry> entries;
|
|
|
|
return entries;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::DataInspector {
|
|
|
|
void add(const std::string &unlocalizedName, size_t requiredSize, impl::GeneratorFunction displayGeneratorFunction, std::optional<impl::EditingFunction> editingFunction) {
|
|
log::debug("Registered new data inspector format: {}", unlocalizedName);
|
|
|
|
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<impl::EditingFunction> editingFunction) {
|
|
log::debug("Registered new data inspector format: {}", unlocalizedName);
|
|
|
|
getEntries().push_back({ unlocalizedName, requiredSize, maxSize, std::move(displayGeneratorFunction), std::move(editingFunction) });
|
|
}
|
|
|
|
std::vector<impl::Entry> &getEntries() {
|
|
static std::vector<impl::Entry> entries;
|
|
|
|
return entries;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::DataProcessorNode {
|
|
|
|
void impl::add(const impl::Entry &entry) {
|
|
log::debug("Registered new data processor node type: [{}]: {}", entry.category, entry.name);
|
|
|
|
getEntries().push_back(entry);
|
|
}
|
|
|
|
void addSeparator() {
|
|
getEntries().push_back({ "", "", [] { return nullptr; } });
|
|
}
|
|
|
|
std::vector<impl::Entry> &getEntries() {
|
|
static std::vector<impl::Entry> nodes;
|
|
|
|
return nodes;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::Language {
|
|
|
|
void registerLanguage(const std::string &name, const std::string &languageCode) {
|
|
log::debug("Registered new language: {} ({})", name, languageCode);
|
|
|
|
getLanguages().insert({ languageCode, name });
|
|
}
|
|
|
|
void addLocalizations(const std::string &languageCode, const LanguageDefinition &definition) {
|
|
log::debug("Registered new localization for language {} with {} entries", languageCode, definition.getEntries().size());
|
|
|
|
getLanguageDefinitions()[languageCode].push_back(definition);
|
|
}
|
|
|
|
std::map<std::string, std::string> &getLanguages() {
|
|
static std::map<std::string, std::string> languages;
|
|
|
|
return languages;
|
|
}
|
|
|
|
std::map<std::string, std::vector<LanguageDefinition>> &getLanguageDefinitions() {
|
|
static std::map<std::string, std::vector<LanguageDefinition>> definitions;
|
|
|
|
return definitions;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::Interface {
|
|
|
|
void registerMainMenuItem(const std::string &unlocalizedName, u32 priority) {
|
|
log::debug("Registered new main menu item: {}", unlocalizedName);
|
|
|
|
getMainMenuItems().insert({ priority, { unlocalizedName } });
|
|
}
|
|
|
|
void addMenuItem(const std::string &unlocalizedMainMenuName, u32 priority, const impl::DrawCallback &function) {
|
|
log::debug("Added new menu item to menu {} with priority {}", unlocalizedMainMenuName, priority);
|
|
|
|
getMenuItems().insert({
|
|
priority, {unlocalizedMainMenuName, function}
|
|
});
|
|
}
|
|
|
|
void addWelcomeScreenEntry(const impl::DrawCallback &function) {
|
|
getWelcomeScreenEntries().push_back(function);
|
|
}
|
|
|
|
void addFooterItem(const impl::DrawCallback &function) {
|
|
getFooterItems().push_back(function);
|
|
}
|
|
|
|
void addToolbarItem(const impl::DrawCallback &function) {
|
|
getToolbarItems().push_back(function);
|
|
}
|
|
|
|
void addSidebarItem(const std::string &icon, const impl::DrawCallback &function) {
|
|
getSidebarItems().push_back({ icon, function });
|
|
}
|
|
|
|
void addTitleBarButton(const std::string &icon, const std::string &unlocalizedTooltip, const impl::ClickCallback &function) {
|
|
getTitleBarButtons().push_back({ icon, unlocalizedTooltip, function });
|
|
}
|
|
|
|
void addLayout(const std::string &unlocalizedName, const impl::LayoutFunction &function) {
|
|
log::debug("Added new layout: {}", unlocalizedName);
|
|
|
|
getLayouts().push_back({ unlocalizedName, function });
|
|
}
|
|
|
|
|
|
std::multimap<u32, impl::MainMenuItem> &getMainMenuItems() {
|
|
static std::multimap<u32, impl::MainMenuItem> items;
|
|
|
|
return items;
|
|
}
|
|
std::multimap<u32, impl::MenuItem> &getMenuItems() {
|
|
static std::multimap<u32, impl::MenuItem> items;
|
|
|
|
return items;
|
|
}
|
|
|
|
std::vector<impl::DrawCallback> &getWelcomeScreenEntries() {
|
|
static std::vector<impl::DrawCallback> entries;
|
|
|
|
return entries;
|
|
}
|
|
std::vector<impl::DrawCallback> &getFooterItems() {
|
|
static std::vector<impl::DrawCallback> items;
|
|
|
|
return items;
|
|
}
|
|
std::vector<impl::DrawCallback> &getToolbarItems() {
|
|
static std::vector<impl::DrawCallback> items;
|
|
|
|
return items;
|
|
}
|
|
std::vector<impl::SidebarItem> &getSidebarItems() {
|
|
static std::vector<impl::SidebarItem> items;
|
|
|
|
return items;
|
|
}
|
|
std::vector<impl::TitleBarButton> &getTitleBarButtons() {
|
|
static std::vector<impl::TitleBarButton> buttons;
|
|
|
|
return buttons;
|
|
}
|
|
|
|
std::vector<impl::Layout> &getLayouts() {
|
|
static std::vector<impl::Layout> layouts;
|
|
|
|
return layouts;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::Provider {
|
|
|
|
void impl::addProviderName(const std::string &unlocalizedName) {
|
|
log::debug("Registered new provider: {}", unlocalizedName);
|
|
|
|
getEntries().push_back(unlocalizedName);
|
|
}
|
|
|
|
std::vector<std::string> &getEntries() {
|
|
static std::vector<std::string> providerNames;
|
|
|
|
return providerNames;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::DataFormatter {
|
|
|
|
void add(const std::string &unlocalizedName, const impl::Callback &callback) {
|
|
log::debug("Registered new data formatter: {}", unlocalizedName);
|
|
|
|
getEntries().push_back({ unlocalizedName, callback });
|
|
}
|
|
|
|
std::vector<impl::Entry> &getEntries() {
|
|
static std::vector<impl::Entry> entries;
|
|
|
|
return entries;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::FileHandler {
|
|
|
|
void add(const std::vector<std::string> &extensions, const impl::Callback &callback) {
|
|
for (const auto &extension : extensions)
|
|
log::debug("Registered new data handler for extensions: {}", extension);
|
|
|
|
getEntries().push_back({ extensions, callback });
|
|
}
|
|
|
|
std::vector<impl::Entry> &getEntries() {
|
|
static std::vector<impl::Entry> entries;
|
|
|
|
return entries;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::HexEditor {
|
|
|
|
const int DataVisualizer::TextInputFlags = ImGuiInputTextFlags_AutoSelectAll | ImGuiInputTextFlags_NoHorizontalScroll;
|
|
|
|
bool DataVisualizer::drawDefaultEditingTextBox(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<void*>(address));
|
|
ImGui::InputScalarCallback("##editing_input", dataType, data, format, flags | TextInputFlags | ImGuiInputTextFlags_CallbackEdit, [](ImGuiInputTextCallbackData *data) -> int {
|
|
auto &userData = *reinterpret_cast<UserData*>(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_Enter);
|
|
}
|
|
|
|
void impl::addDataVisualizer(const std::string &unlocalizedName, DataVisualizer *visualizer) {
|
|
getVisualizers().insert({ unlocalizedName, visualizer });
|
|
|
|
}
|
|
|
|
std::map<std::string, DataVisualizer*> &impl::getVisualizers() {
|
|
static std::map<std::string, DataVisualizer*> visualizers;
|
|
|
|
return visualizers;
|
|
}
|
|
|
|
}
|
|
|
|
namespace ContentRegistry::Hashes {
|
|
|
|
std::vector<Hash *> &impl::getHashes() {
|
|
static std::vector<Hash *> hashes;
|
|
|
|
return hashes;
|
|
}
|
|
|
|
void impl::add(Hash *hash) {
|
|
getHashes().push_back(hash);
|
|
}
|
|
|
|
}
|
|
|
|
}
|