b646ece14b
### 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>
36 lines
1.2 KiB
C++
36 lines
1.2 KiB
C++
#include <optional>
|
|
|
|
#include <hex/api/imhex_api.hpp>
|
|
#include <hex/api/events/events_lifecycle.hpp>
|
|
#include <hex/api/events/requests_lifecycle.hpp>
|
|
#include <hex/helpers/logger.hpp>
|
|
|
|
#include "messaging.hpp"
|
|
|
|
namespace hex::messaging {
|
|
|
|
void messageReceived(const std::string &eventName, const std::vector<u8> &args) {
|
|
log::debug("Received event '{}' with size {}", eventName, args.size());
|
|
ImHexApi::Messaging::impl::runHandler(eventName, args);
|
|
}
|
|
|
|
void setupEvents() {
|
|
SendMessageToMainInstance::subscribe([](const std::string &eventName, const std::vector<u8> &eventData) {
|
|
if (ImHexApi::System::isMainInstance()) {
|
|
log::debug("Executing message '{}' in current instance", eventName);
|
|
EventImHexStartupFinished::subscribe([eventName, eventData]{
|
|
ImHexApi::Messaging::impl::runHandler(eventName, eventData);
|
|
});
|
|
} else {
|
|
log::debug("Forwarding message '{}' to existing instance", eventName);
|
|
sendToOtherInstance(eventName, eventData);
|
|
}
|
|
});
|
|
}
|
|
|
|
void setupMessaging() {
|
|
ImHexApi::System::impl::setMainInstanceStatus(setupNative());
|
|
setupEvents();
|
|
}
|
|
}
|