[FL-1448], [FL-1529] Introducing Scene Manager, NFC App refactoring and bug fixes (#575)
* gui: refactore ViewNavigator -> SceneManager * view_dispatcher: remove scene controller, add custom and navigation cb * scene_manager: rework scene controller, move AppScene from lib * nfc: rework nfc scenes with new scene controller API * view_dispatcher: crash on free if not all views were freed * nfc: introduce scene declaration * scene_manager: allocate and configure application scenes * nfc: rework nfc with new Scene Manager API * scene_manager: remove dublicated scene handlers allocation * nfc: rework nfc app with new scene manager API * view_dispatcher: add tick event * scene_manager: add tick event type and handler * nfc: rework notifications with tick event * scene_manager: remove scene id from scene structure * scene_manager: rename array -> stack, add documentation * api-hal-nfc: remove listen activation processing * nfc_scene_start: shorter submenu call * nfc: fix nfc file name * nfc: fix Retry in mifare ul success read * nfc_cli: fix read timeout in nfc_detect CLI command Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
116
applications/gui/scene_manager.h
Executable file
116
applications/gui/scene_manager.h
Executable file
@@ -0,0 +1,116 @@
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
/** Scene Manager events type
|
||||
*/
|
||||
typedef enum {
|
||||
SceneManagerEventTypeCustom,
|
||||
SceneManagerEventTypeNavigation,
|
||||
SceneManagerEventTypeTick,
|
||||
} SceneManagerEventType;
|
||||
|
||||
/** Scene Manager event
|
||||
*/
|
||||
typedef struct {
|
||||
SceneManagerEventType type;
|
||||
uint32_t event;
|
||||
} SceneManagerEvent;
|
||||
|
||||
/** Prototype for Scene on_enter handler */
|
||||
typedef void (*AppSceneOnEnterCallback)(void* context);
|
||||
|
||||
/** Prototype for Scene on_event handler */
|
||||
typedef bool (*AppSceneOnEventCallback)(void* context, SceneManagerEvent event);
|
||||
|
||||
/** Prototype for Scene on_exit handler */
|
||||
typedef void (*AppSceneOnExitCallback)(void* context);
|
||||
|
||||
/** Scene Manager configuration structure
|
||||
* Contains array of Scene handlers
|
||||
*/
|
||||
typedef struct {
|
||||
const AppSceneOnEnterCallback* on_enter_handlers;
|
||||
const AppSceneOnEventCallback* on_event_handlers;
|
||||
const AppSceneOnExitCallback* on_exit_handlers;
|
||||
const uint32_t scene_num;
|
||||
} SceneManagerHandlers;
|
||||
|
||||
typedef struct SceneManager SceneManager;
|
||||
|
||||
/** Set Scene state
|
||||
* @param scene_manager SceneManager instance
|
||||
* @param scene_id Scene ID
|
||||
* @param state Scene new state
|
||||
*/
|
||||
void scene_manager_set_scene_state(SceneManager* scene_manager, uint32_t scene_id, uint32_t state);
|
||||
|
||||
/** Get Scene state
|
||||
* @param scene_manager SceneManager instance
|
||||
* @param scene_id Scene ID
|
||||
* @return Scene state
|
||||
*/
|
||||
uint32_t scene_manager_get_scene_state(SceneManager* scene_manager, uint32_t scene_id);
|
||||
|
||||
/** Scene Manager allocation and configuration
|
||||
* Scene Manager allocates all scenes internally
|
||||
* @param app_scene_handlers SceneManagerHandlers instance
|
||||
* @param context context to be set on Scene handlers calls
|
||||
* @return SceneManager instance
|
||||
*/
|
||||
SceneManager* scene_manager_alloc(const SceneManagerHandlers* app_scene_handlers, void* context);
|
||||
|
||||
/** Free Scene Manager with allocated Scenes
|
||||
* @param scene_manager SceneManager instance
|
||||
*/
|
||||
void scene_manager_free(SceneManager* scene_manager);
|
||||
|
||||
/** Custom event handler
|
||||
* Calls Scene event handler with Custom event parameter
|
||||
* @param scene_manager SceneManager instance
|
||||
* @param custom_event Custom event code
|
||||
* @return true if event was consumed, false otherwise
|
||||
*/
|
||||
bool scene_manager_handle_custom_event(SceneManager* scene_manager, uint32_t custom_event);
|
||||
|
||||
/** Navigation event handler
|
||||
* Calls Scene event handler with Navigation event parameter
|
||||
* @param scene_manager SceneManager instance
|
||||
* @return true if event was consumed, false otherwise
|
||||
*/
|
||||
bool scene_manager_handle_navigation_event(SceneManager* scene_manager);
|
||||
|
||||
/** Tick event handler
|
||||
* Calls Scene event handler with Tick event parameter
|
||||
* @param scene_manager SceneManager instance
|
||||
* @return true if event was consumed, false otherwise
|
||||
*/
|
||||
void scene_manager_handle_tick_event(SceneManager* scene_manager);
|
||||
|
||||
/** Add and run next Scene
|
||||
* @param scene_manager SceneManager instance
|
||||
* @param next_scene_id next Scene ID
|
||||
*/
|
||||
void scene_manager_next_scene(SceneManager* scene_manager, uint32_t next_scene_id);
|
||||
|
||||
/** Run previous Scene
|
||||
* @param scene_manager SceneManager instance
|
||||
* @return true if previous scene was found, false otherwise
|
||||
*/
|
||||
bool scene_manager_previous_scene(SceneManager* scene_manager);
|
||||
|
||||
/** Search previous Scene by ID
|
||||
* @param scene_manager SceneManager instance
|
||||
* @param scene_id Scene ID
|
||||
* @return true if previous scene was found, false otherwise
|
||||
*/
|
||||
bool scene_manager_search_previous_scene(SceneManager* scene_manager, uint32_t scene_id);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
Reference in New Issue
Block a user