2023-07-13 14:08:23 +02:00
|
|
|
#include <optional>
|
|
|
|
|
|
|
|
#include <hex/api/imhex_api.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_lifecycle.hpp>
|
|
|
|
#include <hex/api/events/requests_lifecycle.hpp>
|
2023-07-13 14:08:23 +02:00
|
|
|
#include <hex/helpers/logger.hpp>
|
|
|
|
|
|
|
|
#include "messaging.hpp"
|
|
|
|
|
|
|
|
namespace hex::messaging {
|
|
|
|
|
2023-11-10 20:47:08 +01:00
|
|
|
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);
|
2023-07-13 14:08:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void setupEvents() {
|
2023-12-08 10:29:44 +01:00
|
|
|
SendMessageToMainInstance::subscribe([](const std::string &eventName, const std::vector<u8> &eventData) {
|
2023-07-13 14:08:23 +02:00
|
|
|
if (ImHexApi::System::isMainInstance()) {
|
2024-06-20 11:09:57 +02:00
|
|
|
log::debug("Executing message '{}' in current instance", eventName);
|
2023-12-08 10:29:44 +01:00
|
|
|
EventImHexStartupFinished::subscribe([eventName, eventData]{
|
2023-07-13 14:08:23 +02:00
|
|
|
ImHexApi::Messaging::impl::runHandler(eventName, eventData);
|
|
|
|
});
|
|
|
|
} else {
|
2024-06-20 11:09:57 +02:00
|
|
|
log::debug("Forwarding message '{}' to existing instance", eventName);
|
2023-07-13 14:08:23 +02:00
|
|
|
sendToOtherInstance(eventName, eventData);
|
|
|
|
}
|
|
|
|
});
|
2025-01-26 18:50:19 +01:00
|
|
|
|
2025-01-27 19:07:22 +01:00
|
|
|
EventNativeMessageReceived::subscribe([](const std::vector<u8> &rawData) {
|
|
|
|
ssize_t nullIndex = -1;
|
|
|
|
|
|
|
|
auto messageData = reinterpret_cast<const char*>(rawData.data());
|
|
|
|
size_t messageSize = rawData.size();
|
|
|
|
|
|
|
|
for (size_t i = 0; i < messageSize; i++) {
|
|
|
|
if (messageData[i] == '\0') {
|
|
|
|
nullIndex = i;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (nullIndex == -1) {
|
|
|
|
log::warn("Received invalid forwarded event");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string eventName(messageData, nullIndex);
|
|
|
|
std::vector<u8> eventData(messageData + nullIndex + 1, messageData + messageSize);
|
|
|
|
|
2025-01-26 18:50:19 +01:00
|
|
|
messageReceived(eventName, eventData);
|
|
|
|
});
|
2023-07-13 14:08:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void setupMessaging() {
|
|
|
|
ImHexApi::System::impl::setMainInstanceStatus(setupNative());
|
|
|
|
setupEvents();
|
|
|
|
}
|
|
|
|
}
|