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>
117 lines
3.5 KiB
C++
117 lines
3.5 KiB
C++
#pragma once
|
|
|
|
#include <hex.hpp>
|
|
#include <hex/api/event_manager.hpp>
|
|
|
|
/* Forward declarations */
|
|
namespace pl::ptrn { class Pattern; }
|
|
|
|
/* Interaction requests definitions */
|
|
namespace hex {
|
|
|
|
/**
|
|
* @brief Requests a selection change in the Hex editor
|
|
*
|
|
* This request is handled by the Hex editor, which proceeds to check if the selection is valid.
|
|
* If it is invalid, the Hex editor fires the `EventRegionSelected` event with nullptr region info.
|
|
*
|
|
* @param region the region that should be selected
|
|
*/
|
|
EVENT_DEF(RequestHexEditorSelectionChange, Region);
|
|
|
|
/**
|
|
* @brief Requests the Pattern editor to move selection
|
|
*
|
|
* Requests the Pattern editor to move the cursor's position to reflect the user's click or movement.
|
|
*
|
|
* @param line the target line
|
|
* @param column the target column
|
|
*/
|
|
EVENT_DEF(RequestPatternEditorSelectionChange, u32, u32);
|
|
|
|
/**
|
|
* @brief Requests a jump to a given pattern
|
|
*
|
|
* This request is fired by the Hex editor when the user asks to jump to the pattern.
|
|
* It is then caught and reflected by the Pattern data component.
|
|
*
|
|
* @param pattern the pattern to jump to
|
|
*/
|
|
EVENT_DEF(RequestJumpToPattern, const pl::ptrn::Pattern*);
|
|
|
|
/**
|
|
* @brief Requests to add a bookmark
|
|
*
|
|
* @param region the region to be bookmarked
|
|
* @param name the bookmark's name
|
|
* @param comment a comment
|
|
* @param color the color
|
|
* @param id the bookmark's unique ID
|
|
*/
|
|
EVENT_DEF(RequestAddBookmark, Region, std::string, std::string, color_t, u64*);
|
|
|
|
/**
|
|
* @brief Requests a bookmark removal
|
|
*
|
|
* @param id the bookmark's unique ID
|
|
*/
|
|
EVENT_DEF(RequestRemoveBookmark, u64);
|
|
|
|
/**
|
|
* @brief Request the Pattern editor to set its code
|
|
*
|
|
* This request allows the rest of ImHex to interface with the Pattern editor component, by setting its code.
|
|
* This allows for `.hexpat` file loading, and more.
|
|
*
|
|
* @param code the code's string
|
|
*/
|
|
EVENT_DEF(RequestSetPatternLanguageCode, std::string);
|
|
|
|
/**
|
|
* @brief Requests the Pattern editor to run the current code
|
|
*
|
|
* This is only ever used in the introduction tutorial.
|
|
*
|
|
* FIXME: the name is misleading, as for now this activates the pattern's auto-evaluation rather than a
|
|
* one-off execution
|
|
*/
|
|
EVENT_DEF(RequestRunPatternCode);
|
|
|
|
/**
|
|
* @brief Request to load a pattern language file
|
|
*
|
|
* FIXME: this request is unused, as now another component is responsible for pattern file loading.
|
|
* This request should be scrapped.
|
|
*
|
|
* @param path the pattern file's path
|
|
*/
|
|
EVENT_DEF(RequestLoadPatternLanguageFile, std::fs::path);
|
|
|
|
/**
|
|
* @brief Request to save a pattern language file
|
|
*
|
|
* FIXME: this request is unused, as now another component is responsible for pattern file saving.
|
|
* This request should be scrapped.
|
|
*
|
|
* @param path the pattern file's path
|
|
*/
|
|
EVENT_DEF(RequestSavePatternLanguageFile, std::fs::path);
|
|
|
|
/**
|
|
* @brief Requests ImHex to open and process a file
|
|
*
|
|
* @param path the file's path
|
|
*/
|
|
EVENT_DEF(RequestOpenFile, std::fs::path);
|
|
|
|
/**
|
|
* @brief Adds a virtual file in the Pattern editor
|
|
*
|
|
* @param path the file's path
|
|
* @param data the file's data
|
|
* @param region the impacted region
|
|
*/
|
|
EVENT_DEF(RequestAddVirtualFile, std::fs::path, std::vector<u8>, Region);
|
|
|
|
}
|