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>
55 lines
1.9 KiB
C++
55 lines
1.9 KiB
C++
#pragma once
|
|
|
|
#include <hex/providers/provider.hpp>
|
|
#include <hex/api/events/events_provider.hpp>
|
|
|
|
namespace hex::plugin::builtin {
|
|
|
|
class NullProvider : public hex::prv::Provider {
|
|
public:
|
|
NullProvider() {
|
|
EventProviderOpened::subscribe([this](auto *newProvider) {
|
|
if (newProvider == this)
|
|
return;
|
|
|
|
ImHexApi::Provider::remove(this, true);
|
|
});
|
|
}
|
|
|
|
~NullProvider() override {
|
|
EventProviderOpened::unsubscribe(this);
|
|
}
|
|
|
|
[[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; }
|
|
|
|
[[nodiscard]] bool open() override { return true; }
|
|
void close() override { }
|
|
|
|
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;
|
|
}
|
|
[[nodiscard]] u64 getActualSize() const override { return 0x00; }
|
|
|
|
[[nodiscard]] std::string getName() const override { return "ImHex"; }
|
|
[[nodiscard]] std::vector<Description> getDataDescription() const override { return { }; }
|
|
|
|
void loadSettings(const nlohmann::json &settings) override { std::ignore = settings; }
|
|
[[nodiscard]] nlohmann::json storeSettings(nlohmann::json settings) const override { return settings; }
|
|
|
|
[[nodiscard]] UnlocalizedString getTypeName() const override {
|
|
return "hex.builtin.provider.null";
|
|
}
|
|
};
|
|
|
|
} |