flipperzero-firmware/lib/app-scened-template/view-controller.hpp
SG 0b14db4fb3
C++ apps: templated scene controller (#517)
* C++ apps: templated scene controller
* templated app: fix type names
* templated app: text store component
* Applications: add "Templated Scene" application
* templated app: refractoring
* Gui module byte input: fix docs
* templated app: new byte input scene
* templated app: dialog ex view module
* templated app: popup view module
* templated app: dialog-ex view module, fix docs
* templated app: text input view module
* Gui module text input: fix docs
* Furi: duplicated include
* templated app: record holder (controller) class
* templated app: view modules can now be accessed via cast
* templated app: remove unused includes
* templated app: fix return code
2021-06-15 14:01:56 +03:00

163 lines
4.4 KiB
C++

#pragma once
#include "view-modules/generic-view-module.h"
#include <map>
#include <furi/check.h>
#include <gui/view_dispatcher.h>
#include <callback-connector.h>
#include "typeindex_no_rtti.hpp"
/**
* @brief Controller for switching application views and handling inputs and events
*
* @tparam TApp application class
* @tparam TViewModules variadic list of ViewModules
*/
template <typename TApp, typename... TViewModules> class ViewController {
public:
ViewController() {
event_queue = osMessageQueueNew(10, sizeof(typename TApp::Event), NULL);
view_dispatcher = view_dispatcher_alloc();
previous_view_callback_pointer = cbc::obtain_connector(
this, &ViewController<TApp, TViewModules...>::previous_view_callback);
[](...) {
}((this->add_view(ext::make_type_index<TViewModules>().hash_code(), new TViewModules()),
0)...);
gui = static_cast<Gui*>(furi_record_open("gui"));
view_dispatcher_attach_to_gui(view_dispatcher, gui, ViewDispatcherTypeFullscreen);
};
~ViewController() {
for(auto& it : holder) {
view_dispatcher_remove_view(view_dispatcher, static_cast<uint32_t>(it.first));
delete it.second;
}
view_dispatcher_free(view_dispatcher);
osMessageQueueDelete(event_queue);
}
/**
* @brief Get ViewModule pointer
*
* @tparam T Concrete ViewModule class
* @return T* ViewModule pointer
*/
template <typename T> T* get() {
uint32_t view_index = ext::make_type_index<T>().hash_code();
furi_check(holder.count(view_index) != 0);
return static_cast<T*>(holder[view_index]);
}
/**
* @brief Get ViewModule pointer by cast
*
* @tparam T Concrete ViewModule class
* @return T* ViewModule pointer
*/
template <typename T> operator T*() {
uint32_t view_index = ext::make_type_index<T>().hash_code();
furi_check(holder.count(view_index) != 0);
return static_cast<T*>(holder[view_index]);
}
/**
* @brief Switch view to ViewModule
*
* @tparam T Concrete ViewModule class
* @return T* ViewModule pointer
*/
template <typename T> void switch_to() {
uint32_t view_index = ext::make_type_index<T>().hash_code();
furi_check(holder.count(view_index) != 0);
view_dispatcher_switch_to_view(view_dispatcher, view_index);
}
/**
* @brief Receive event from app event queue
*
* @param event event pointer
*/
void receive_event(typename TApp::Event* event) {
if(osMessageQueueGet(event_queue, event, NULL, 100) != osOK) {
event->type = TApp::EventType::Tick;
}
}
/**
* @brief Send event to app event queue
*
* @param event event pointer
*/
void send_event(typename TApp::Event* event) {
osStatus_t result = osMessageQueuePut(event_queue, event, 0, osWaitForever);
furi_check(result == osOK);
}
private:
/**
* @brief ViewModulesHolder
*
*/
std::map<size_t, GenericViewModule*> holder;
/**
* @brief App event queue
*
*/
osMessageQueueId_t event_queue;
/**
* @brief Main ViewDispatcher pointer
*
*/
ViewDispatcher* view_dispatcher;
/**
* @brief Gui record pointer
*
*/
Gui* gui;
/**
* @brief Previous view callback fn pointer
*
*/
ViewNavigationCallback previous_view_callback_pointer;
/**
* @brief Previous view callback fn
*
* @param context not used
* @return uint32_t VIEW_IGNORE
*/
uint32_t previous_view_callback(void* context) {
(void)context;
typename TApp::Event event;
event.type = TApp::EventType::Back;
if(event_queue != NULL) {
send_event(&event);
}
return VIEW_IGNORE;
}
/**
* @brief Add ViewModule to holder
*
* @param view_index view index in holder
* @param view_module view module pointer
*/
void add_view(size_t view_index, GenericViewModule* view_module) {
furi_check(holder.count(view_index) == 0);
holder[view_index] = view_module;
View* view = view_module->get_view();
view_dispatcher_add_view(view_dispatcher, static_cast<uint32_t>(view_index), view);
view_set_previous_callback(view, previous_view_callback_pointer);
}
};