Refactor and restructure Event Manager #2082
Open
+830
−173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move all `EventProvider*` events to a new `events_provider.hpp` file. Include this new file wherever possible, without removing the event manager import for now. Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Move `Request`s to their own category. Include the correct new file for the usages. Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Remove imports referring to the old `event_manager.hpp` that was used to manage events. This is a cleanup of previous commits that included the new event definition files. Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Fix other targets than Linux, that weren't included in the build and had thus been forgotten about until now. This should completely fix the wrong imports. Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
…ocumentation Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.hppevents_interaction.hppevents_lifecycle.hppevents_provider.hpprequests_gui.hpprequests_interaction.hpprequests_lifecycle.hpprequests_provider.hppEvery event and request now has its own piece of documentation, with a
@brief, accompanied by a longer comment if needed, and gets its@params described.The old
event_manager.hppimport 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 importsrefactor,chore: make various small changes to match the required structuredocs: add documentation for events and requestsHopefully, 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