2022-08-10 09:26:48 +02:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <hex/providers/provider.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>
|
2022-08-10 09:26:48 +02:00
|
|
|
|
2022-11-07 00:04:47 +01:00
|
|
|
namespace hex::plugin::builtin {
|
2022-08-10 09:26:48 +02:00
|
|
|
|
|
|
|
class NullProvider : public hex::prv::Provider {
|
|
|
|
public:
|
2023-12-07 11:20:37 +01:00
|
|
|
NullProvider() {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventProviderOpened::subscribe([this](auto *newProvider) {
|
2023-12-07 11:20:37 +01:00
|
|
|
if (newProvider == this)
|
|
|
|
return;
|
2023-12-07 11:53:16 +01:00
|
|
|
|
2023-12-07 11:20:37 +01:00
|
|
|
ImHexApi::Provider::remove(this, true);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
~NullProvider() override {
|
2023-12-08 10:29:44 +01:00
|
|
|
EventProviderOpened::unsubscribe(this);
|
2023-12-07 11:20:37 +01:00
|
|
|
}
|
2022-08-10 09:26:48 +02:00
|
|
|
|
|
|
|
[[nodiscard]] bool isAvailable() const override { return true; }
|
|
|
|
[[nodiscard]] bool isReadable() const override { return true; }
|
|
|
|
[[nodiscard]] bool isWritable() const override { return false; }
|
|
|
|
[[nodiscard]] bool isResizable() const override { return false; }
|
|
|
|
[[nodiscard]] bool isSavable() const override { return false; }
|
|
|
|
|
2022-09-04 11:16:20 +02:00
|
|
|
[[nodiscard]] bool open() override { return true; }
|
|
|
|
void close() override { }
|
|
|
|
|
2024-12-14 21:35:54 +01:00
|
|
|
void readRaw(u64 offset, void *buffer, size_t size) override {
|
|
|
|
std::ignore = offset;
|
|
|
|
std::ignore = buffer;
|
|
|
|
std::ignore = size;
|
|
|
|
}
|
|
|
|
void writeRaw(u64 offset, const void *buffer, size_t size) override {
|
|
|
|
std::ignore = offset;
|
|
|
|
std::ignore = buffer;
|
|
|
|
std::ignore = size;
|
|
|
|
}
|
2023-12-07 12:06:26 +01:00
|
|
|
[[nodiscard]] u64 getActualSize() const override { return 0x00; }
|
2022-08-10 09:26:48 +02:00
|
|
|
|
2024-12-27 23:56:14 +01:00
|
|
|
[[nodiscard]] std::string getName() const override { return "ImHex"; }
|
2023-06-04 10:42:11 +02:00
|
|
|
[[nodiscard]] std::vector<Description> getDataDescription() const override { return { }; }
|
2022-08-10 09:26:48 +02:00
|
|
|
|
2024-12-14 21:35:54 +01:00
|
|
|
void loadSettings(const nlohmann::json &settings) override { std::ignore = settings; }
|
2022-08-10 09:26:48 +02:00
|
|
|
[[nodiscard]] nlohmann::json storeSettings(nlohmann::json settings) const override { return settings; }
|
|
|
|
|
2025-01-04 13:28:35 +01:00
|
|
|
[[nodiscard]] UnlocalizedString getTypeName() const override {
|
2022-08-10 09:26:48 +02:00
|
|
|
return "hex.builtin.provider.null";
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|