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>
72 lines
2.3 KiB
C++
72 lines
2.3 KiB
C++
#pragma once
|
|
|
|
#include <hex/api/event_manager.hpp>
|
|
|
|
/* Lifecycle events definitions */
|
|
namespace hex {
|
|
|
|
/**
|
|
* @brief Called when Imhex finished startup, and will enter the main window rendering loop
|
|
*/
|
|
EVENT_DEF(EventImHexStartupFinished);
|
|
|
|
/**
|
|
* @brief Called when ImHex is closing, to trigger the last shutdown hooks
|
|
*
|
|
* This is the last event to fire before complete graceful shutdown.
|
|
*/
|
|
EVENT_DEF(EventImHexClosing);
|
|
|
|
/**
|
|
* @brief Signals that it's ImHex first launch ever
|
|
*
|
|
* This event allows for the launch of the ImHex tutorial (also called Out of Box experience).
|
|
*/
|
|
EVENT_DEF(EventFirstLaunch);
|
|
|
|
/**
|
|
* FIXME: this event is unused and should be scrapped.
|
|
*/
|
|
EVENT_DEF(EventAnySettingChanged);
|
|
|
|
/**
|
|
* @brief Ensures correct plugin cleanup on crash
|
|
*
|
|
* This event is fired when catching an unexpected error that cannot be recovered and
|
|
* which forces Imhex to close immediately.
|
|
*
|
|
* Subscribing to this event ensures that the plugin can correctly clean up any mission-critical tasks
|
|
* before forceful shutdown.
|
|
*
|
|
* @param signal the POSIX signal code
|
|
*/
|
|
EVENT_DEF(EventAbnormalTermination, int);
|
|
|
|
/**
|
|
* @brief Informs of the ImHex versions (and difference, if any)
|
|
*
|
|
* Called on every startup to inform subscribers of the two versions picked up:
|
|
* - the version of the previous launch, gathered from the settings file
|
|
* - the current version, gathered directly from C++ code
|
|
*
|
|
* In most cases, and unless ImHex was updated, the two parameters will be the same.
|
|
*
|
|
* FIXME: Maybe rename the event to signal a startup information, instead of the misleading
|
|
* title that the event could be fired when ImHex detects that it was updated since last launch?
|
|
*
|
|
* @param previousLaunchVersion ImHex's version during the previous launch
|
|
* @param currentVersion ImHex's current version for this startup
|
|
*/
|
|
EVENT_DEF(EventImHexUpdated, SemanticVersion, SemanticVersion);
|
|
|
|
/**
|
|
* @brief Called when ImHex managed to catch an error in a general try/catch to prevent/recover from a crash
|
|
*/
|
|
EVENT_DEF(EventCrashRecovered, const std::exception &);
|
|
|
|
/**
|
|
* @brief Called when a project has been loaded
|
|
*/
|
|
EVENT_DEF(EventProjectOpened);
|
|
|
|
} |