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/requests_interaction.hpp>
|
2024-02-10 23:31:05 +01:00
|
|
|
#include <hex/api/task_manager.hpp>
|
|
|
|
#include <hex/helpers/utils.hpp>
|
|
|
|
|
|
|
|
#include <init/splash_window.hpp>
|
|
|
|
#include <init/tasks.hpp>
|
|
|
|
|
|
|
|
namespace hex::init {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Handles a file open request by opening the file specified by OS-specific means
|
|
|
|
*/
|
|
|
|
void handleFileOpenRequest() {
|
|
|
|
if (auto path = hex::getInitialFilePath(); path.has_value()) {
|
|
|
|
RequestOpenFile::post(path.value());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Displays ImHex's splash screen and runs all initialization tasks. The splash screen will be displayed until all tasks have finished.
|
|
|
|
*/
|
|
|
|
[[maybe_unused]]
|
|
|
|
std::unique_ptr<init::WindowSplash> initializeImHex() {
|
|
|
|
auto splashWindow = std::make_unique<init::WindowSplash>();
|
|
|
|
|
|
|
|
log::info("Using '{}' GPU", ImHexApi::System::getGPUVendor());
|
|
|
|
|
|
|
|
// Add initialization tasks to run
|
|
|
|
TaskManager::init();
|
2025-01-04 16:11:05 +01:00
|
|
|
for (const auto &[name, task, async, running] : init::getInitTasks())
|
2024-02-10 23:31:05 +01:00
|
|
|
splashWindow->addStartupTask(name, task, async);
|
|
|
|
|
|
|
|
splashWindow->startStartupTasks();
|
|
|
|
|
|
|
|
return splashWindow;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Deinitializes ImHex by running all exit tasks
|
|
|
|
*/
|
|
|
|
void deinitializeImHex() {
|
|
|
|
// Run exit tasks
|
|
|
|
init::runExitTasks();
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|