2024-01-28 22:14:59 +01:00
|
|
|
#include <hex/plugin.hpp>
|
|
|
|
|
|
|
|
#include <hex/api/content_registry.hpp>
|
impr: Refactor and restructure Event Manager (#2082)
### Problem description
This PR addresses issue #2013 that described a cluttered Event Manager.
This is a DX issue and should not impact the users whatsoever.
### Implementation description
The changes revolve around three main points:
1. the Event Manager (`event_manager.hpp`) was split into four
categories: GUI, Interaction, Lifecycle, and Provider, and two types:
Events, and Requests. This results in the following files:
- `events_gui.hpp`
- `events_interaction.hpp`
- `events_lifecycle.hpp`
- `events_provider.hpp`
- `requests_gui.hpp`
- `requests_interaction.hpp`
- `requests_lifecycle.hpp`
- `requests_provider.hpp`
2. Every event and request now has its own piece of documentation, with
a `@brief`, accompanied by a longer comment if needed, and gets its
`@param`s described.
3. The old `event_manager.hpp` import was removed and replaced by the
correct imports wherever needed, as to reduce spread of those files only
to where they are truly useful.
### Additional things
The commits have been split into (chrono-)logical steps:
- `feat`: split the Event Manager, and replace the imports
- `refactor`, `chore`: make various small changes to match the required
structure
- `docs`: add documentation for events and requests
Hopefully, this will help to review the PR.
*Note: Beware of very long rebuild times in between the commits, use
them sparingly! The Actions will ensure this PR builds anyways*
Closes #2013
---------
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Co-authored-by: Nik <werwolv98@gmail.com>
2025-01-25 16:32:07 +01:00
|
|
|
#include <hex/api/events/events_gui.hpp>
|
2024-01-28 22:14:59 +01:00
|
|
|
#include <hex/helpers/logger.hpp>
|
|
|
|
|
|
|
|
#include <romfs/romfs.hpp>
|
2025-01-18 23:34:43 +01:00
|
|
|
#include <font_atlas.hpp>
|
|
|
|
#include <font_settings.hpp>
|
|
|
|
#include <imgui_impl_opengl3.h>
|
|
|
|
#include <fonts/fonts.hpp>
|
2024-01-28 22:14:59 +01:00
|
|
|
|
|
|
|
namespace hex::fonts {
|
2025-01-18 23:34:43 +01:00
|
|
|
|
2024-06-16 22:41:16 +02:00
|
|
|
void registerFonts();
|
|
|
|
|
2025-01-18 23:34:43 +01:00
|
|
|
bool buildFontAtlas(FontAtlas *fontAtlas, std::fs::path fontPath, bool pixelPerfectFont, float fontSize, bool loadUnicodeCharacters, bool bold, bool italic, bool antialias);
|
|
|
|
|
2025-01-19 23:07:53 +01:00
|
|
|
static AutoReset<std::map<ImFont*, std::unique_ptr<FontAtlas>>> s_fontAtlases;
|
2025-01-18 23:34:43 +01:00
|
|
|
|
2025-01-19 23:07:53 +01:00
|
|
|
void loadFont(const ContentRegistry::Settings::Widgets::Widget &widget, const UnlocalizedString &name, ImFont **font, float scale) {
|
2025-01-18 23:34:43 +01:00
|
|
|
const auto &settings = static_cast<const FontSelector&>(widget);
|
|
|
|
|
2025-01-19 23:07:53 +01:00
|
|
|
auto atlas = std::make_unique<FontAtlas>();
|
2025-01-18 23:34:43 +01:00
|
|
|
|
|
|
|
const bool atlasBuilt = buildFontAtlas(
|
2025-01-19 23:07:53 +01:00
|
|
|
atlas.get(),
|
2025-01-18 23:34:43 +01:00
|
|
|
settings.getFontPath(),
|
|
|
|
settings.isPixelPerfectFont(),
|
2025-01-19 23:07:53 +01:00
|
|
|
settings.getFontSize() * scale,
|
2025-01-18 23:34:43 +01:00
|
|
|
true,
|
|
|
|
settings.isBold(),
|
|
|
|
settings.isItalic(),
|
|
|
|
settings.isAntiAliased()
|
|
|
|
);
|
|
|
|
|
|
|
|
if (!atlasBuilt) {
|
|
|
|
buildFontAtlas(
|
2025-01-19 23:07:53 +01:00
|
|
|
atlas.get(),
|
2025-01-18 23:34:43 +01:00
|
|
|
"",
|
|
|
|
false,
|
2025-01-19 23:07:53 +01:00
|
|
|
settings.getFontSize() * scale,
|
2025-01-18 23:34:43 +01:00
|
|
|
false,
|
|
|
|
settings.isBold(),
|
|
|
|
settings.isItalic(),
|
|
|
|
settings.isAntiAliased()
|
|
|
|
);
|
|
|
|
|
|
|
|
log::error("Failed to load font {}! Reverting back to default font!", name.get());
|
|
|
|
}
|
|
|
|
|
2025-01-19 23:07:53 +01:00
|
|
|
*font = atlas->getAtlas()->Fonts[0];
|
2025-01-18 23:34:43 +01:00
|
|
|
|
|
|
|
(*s_fontAtlases)[*font] = std::move(atlas);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool setupFonts() {
|
|
|
|
ContentRegistry::Settings::add<ContentRegistry::Settings::Widgets::Checkbox>("hex.fonts.setting.font", "hex.fonts.setting.font.glyphs", "hex.fonts.setting.font.load_all_unicode_chars", false).requiresRestart();
|
|
|
|
|
|
|
|
for (auto &[name, font] : ImHexApi::Fonts::impl::getFontDefinitions()) {
|
|
|
|
auto &widget = addFontSettingsWidget(name)
|
|
|
|
.setChangedCallback([name, &font, firstLoad = true](auto &widget) mutable {
|
|
|
|
if (firstLoad) {
|
|
|
|
firstLoad = false;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2025-01-25 22:27:59 +01:00
|
|
|
loadFont(widget, name, &font, ImHexApi::System::getGlobalScale() * ImHexApi::System::getBackingScaleFactor());
|
2025-01-18 23:34:43 +01:00
|
|
|
});
|
|
|
|
|
2025-01-25 22:27:59 +01:00
|
|
|
loadFont(widget.getWidget(), name, &font, ImHexApi::System::getGlobalScale() * ImHexApi::System::getBackingScaleFactor());
|
2025-01-19 23:07:53 +01:00
|
|
|
EventDPIChanged::subscribe(font, [&widget, name, &font](float, float newScaling) {
|
2025-01-25 22:27:59 +01:00
|
|
|
loadFont(widget.getWidget(), name, &font, ImHexApi::System::getGlobalScale() * newScaling);
|
2025-01-19 23:07:53 +01:00
|
|
|
});
|
2025-01-18 23:34:43 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2024-01-28 22:14:59 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
IMHEX_LIBRARY_SETUP("Fonts") {
|
|
|
|
hex::log::debug("Using romfs: '{}'", romfs::name());
|
2025-01-18 23:34:43 +01:00
|
|
|
for (auto &path : romfs::list("lang"))
|
|
|
|
hex::ContentRegistry::Language::addLocalization(nlohmann::json::parse(romfs::get(path).string()));
|
|
|
|
|
|
|
|
hex::ImHexApi::Fonts::registerFont("hex.fonts.font.default");
|
|
|
|
hex::ImHexApi::Fonts::registerFont("hex.fonts.font.hex_editor");
|
|
|
|
hex::ImHexApi::Fonts::registerFont("hex.fonts.font.code_editor");
|
2024-01-28 22:14:59 +01:00
|
|
|
|
2025-01-18 23:34:43 +01:00
|
|
|
hex::ImHexApi::System::addStartupTask("Loading fonts", true, hex::fonts::setupFonts);
|
2024-06-16 22:41:16 +02:00
|
|
|
hex::fonts::registerFonts();
|
2024-01-28 22:14:59 +01:00
|
|
|
}
|