2021-12-12 00:41:44 +01:00
|
|
|
#include "content/views/view_provider_settings.hpp"
|
|
|
|
|
2023-11-14 15:55:34 +01:00
|
|
|
#include <hex/api/content_registry.hpp>
|
2023-12-26 00:22:47 +01:00
|
|
|
#include <hex/api/task_manager.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_provider.hpp>
|
2023-12-26 00:22:47 +01:00
|
|
|
|
|
|
|
#include <toasts/toast_notification.hpp>
|
2023-04-08 00:58:53 +02:00
|
|
|
|
2021-12-12 00:41:44 +01:00
|
|
|
namespace hex::plugin::builtin {
|
|
|
|
|
2023-11-21 13:47:50 +01:00
|
|
|
ViewProviderSettings::ViewProviderSettings() : View::Modal("hex.builtin.view.provider_settings.name") {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventProviderCreated::subscribe(this, [this](const hex::prv::Provider *provider) {
|
2023-03-07 16:03:34 +01:00
|
|
|
if (provider->hasLoadInterface() && !provider->shouldSkipLoadInterface())
|
2023-11-27 15:34:05 +01:00
|
|
|
this->getWindowOpenState() = true;
|
2021-12-12 00:41:44 +01:00
|
|
|
});
|
2023-11-14 15:55:34 +01:00
|
|
|
|
|
|
|
ContentRegistry::Interface::addSidebarItem(ICON_VS_SERVER_PROCESS, [] {
|
|
|
|
auto provider = hex::ImHexApi::Provider::get();
|
|
|
|
|
|
|
|
if (provider != nullptr)
|
|
|
|
provider->drawInterface();
|
|
|
|
},
|
|
|
|
[] {
|
|
|
|
auto provider = hex::ImHexApi::Provider::get();
|
|
|
|
|
|
|
|
return provider != nullptr && provider->hasInterface() && provider->isAvailable();
|
|
|
|
});
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
ViewProviderSettings::~ViewProviderSettings() {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventProviderCreated::unsubscribe(this);
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void ViewProviderSettings::drawContent() {
|
2023-11-21 13:47:50 +01:00
|
|
|
auto provider = hex::ImHexApi::Provider::get();
|
|
|
|
if (provider != nullptr) {
|
|
|
|
bool settingsValid = provider->drawLoadInterface();
|
2021-12-12 00:41:44 +01:00
|
|
|
|
2023-11-21 13:47:50 +01:00
|
|
|
ImGui::NewLine();
|
|
|
|
ImGui::Separator();
|
2021-12-12 00:41:44 +01:00
|
|
|
|
2023-11-21 13:47:50 +01:00
|
|
|
ImGui::BeginDisabled(!settingsValid);
|
2023-12-23 21:09:41 +01:00
|
|
|
if (ImGui::Button("hex.ui.common.open"_lang)) {
|
2023-11-21 13:47:50 +01:00
|
|
|
if (provider->open()) {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventProviderOpened::post(provider);
|
2023-11-27 15:34:05 +01:00
|
|
|
|
|
|
|
this->getWindowOpenState() = false;
|
2023-11-21 13:47:50 +01:00
|
|
|
ImGui::CloseCurrentPopup();
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
2023-11-21 13:47:50 +01:00
|
|
|
else {
|
2023-11-27 15:34:05 +01:00
|
|
|
this->getWindowOpenState() = false;
|
2021-12-12 00:41:44 +01:00
|
|
|
ImGui::CloseCurrentPopup();
|
2023-11-21 13:47:50 +01:00
|
|
|
auto errorMessage = provider->getErrorMessage();
|
|
|
|
if (errorMessage.empty()) {
|
2023-12-26 00:22:47 +01:00
|
|
|
ui::ToastError::open("hex.builtin.view.provider_settings.load_error"_lang);
|
2023-11-21 13:47:50 +01:00
|
|
|
} else {
|
2023-12-26 00:22:47 +01:00
|
|
|
ui::ToastError::open(hex::format("hex.builtin.view.provider_settings.load_error_details"_lang, errorMessage));
|
2023-11-21 13:47:50 +01:00
|
|
|
}
|
2023-01-03 16:34:22 +01:00
|
|
|
TaskManager::doLater([=] { ImHexApi::Provider::remove(provider); });
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
|
|
|
}
|
2023-11-21 13:47:50 +01:00
|
|
|
ImGui::EndDisabled();
|
|
|
|
|
|
|
|
ImGui::SameLine();
|
2021-12-12 00:41:44 +01:00
|
|
|
|
2023-12-23 21:09:41 +01:00
|
|
|
if (ImGui::Button("hex.ui.common.cancel"_lang)) {
|
2023-11-21 13:47:50 +01:00
|
|
|
ImGui::CloseCurrentPopup();
|
2023-11-27 15:34:05 +01:00
|
|
|
this->getWindowOpenState() = false;
|
2023-11-21 13:47:50 +01:00
|
|
|
TaskManager::doLater([=] { ImHexApi::Provider::remove(provider); });
|
|
|
|
}
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-01-10 21:05:37 +01:00
|
|
|
bool ViewProviderSettings::hasViewMenuItemEntry() const {
|
2023-11-14 15:55:34 +01:00
|
|
|
return false;
|
2021-12-12 00:41:44 +01:00
|
|
|
}
|
|
|
|
|
2023-11-14 15:55:34 +01:00
|
|
|
}
|