2023-11-25 12:43:48 +01:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <hex.hpp>
|
2023-12-19 12:22:28 +01:00
|
|
|
#include <hex/api/localization_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_interaction.hpp>
|
2023-12-19 12:22:28 +01:00
|
|
|
|
2023-11-25 12:43:48 +01:00
|
|
|
#include <hex/providers/undo_redo/operations/operation.hpp>
|
|
|
|
|
|
|
|
#include <map>
|
|
|
|
#include <memory>
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
namespace hex::prv {
|
|
|
|
class Provider;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace hex::prv::undo {
|
|
|
|
|
|
|
|
using Patches = std::map<u64, u8>;
|
|
|
|
|
|
|
|
class Stack {
|
|
|
|
public:
|
|
|
|
explicit Stack(Provider *provider);
|
|
|
|
|
|
|
|
void undo(u32 count = 1);
|
|
|
|
void redo(u32 count = 1);
|
|
|
|
|
2023-12-19 12:22:28 +01:00
|
|
|
void groupOperations(u32 count, const UnlocalizedString &unlocalizedName);
|
2023-11-25 12:43:48 +01:00
|
|
|
void apply(const Stack &otherStack);
|
2024-03-10 14:31:39 +01:00
|
|
|
void reapply();
|
2023-11-25 12:43:48 +01:00
|
|
|
|
|
|
|
[[nodiscard]] bool canUndo() const;
|
|
|
|
[[nodiscard]] bool canRedo() const;
|
|
|
|
|
|
|
|
template<std::derived_from<Operation> T>
|
|
|
|
bool add(auto && ... args) {
|
2024-02-15 13:01:34 +01:00
|
|
|
auto result = this->add(std::make_unique<T>(std::forward<decltype(args)>(args)...));
|
2024-01-25 22:49:56 +01:00
|
|
|
EventDataChanged::post(m_provider);
|
2024-02-15 13:01:34 +01:00
|
|
|
|
|
|
|
return result;
|
2023-11-25 12:43:48 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
bool add(std::unique_ptr<Operation> &&operation);
|
|
|
|
|
|
|
|
const std::vector<std::unique_ptr<Operation>> &getAppliedOperations() const {
|
2023-12-19 13:10:25 +01:00
|
|
|
return m_undoStack;
|
2023-11-25 12:43:48 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
const std::vector<std::unique_ptr<Operation>> &getUndoneOperations() const {
|
2023-12-19 13:10:25 +01:00
|
|
|
return m_redoStack;
|
2023-11-25 12:43:48 +01:00
|
|
|
}
|
2023-11-27 15:48:46 +01:00
|
|
|
|
|
|
|
void reset() {
|
2023-12-19 13:10:25 +01:00
|
|
|
m_undoStack.clear();
|
|
|
|
m_redoStack.clear();
|
2023-11-27 15:48:46 +01:00
|
|
|
}
|
|
|
|
|
2023-11-25 12:43:48 +01:00
|
|
|
private:
|
|
|
|
[[nodiscard]] Operation* getLastOperation() const {
|
2023-12-19 13:10:25 +01:00
|
|
|
return m_undoStack.back().get();
|
2023-11-25 12:43:48 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::vector<std::unique_ptr<Operation>> m_undoStack, m_redoStack;
|
|
|
|
Provider *m_provider;
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|