#include <ViewStack.h>

Public Types
using	InactivityCallback = void(*)()

Public Member Functions
void	push (IView view, void context=nullptr)
void	pop ()
void	replace (IView view, void context=nullptr)
void	popToRoot ()
void	popToAnchor (IView *anchor)
	Pops views until the specified anchor view is the current view.
void	popToDepth (uint8_t targetDepth)
	Pops views until the stack depth is at most targetDepth.
IView *	current () const
IView *	at (uint8_t depth) const
uint8_t	depth () const
bool	isEmpty () const
void	dispatchKey (char key)
InputResult	dispatchLongPress (char key)
void	dispatchTick (uint32_t nowMs)
void	render (bool synchronous=false)
	Render current view (and modal if present) and flush to display.
bool	needsRender () const
void	showModal (IView *modal)
void	hideModal ()
void	removeModal (IView *modal)
	Remove a specific modal from any position in the modal stack.
bool	hasModal () const
IView *	getModal () const
void	forceFullRefresh ()
void	forceRefresh (hal::RefreshMode mode)
	Escalates the refresh mode of the next render.
bool	acquireExclusive (const void *owner)
	Acquires exclusive ownership of the view stack.
bool	releaseExclusive (const void *owner)
	Releases exclusive ownership.
const void *	exclusiveOwner () const
	Returns current exclusive owner, or nullptr if none.
void	setInactivityTimeout (InactivityCallback callback, uint32_t timeoutMs)
void	resetInactivityTimer ()
void	checkInactivity (uint32_t nowMs)

Static Public Member Functions
static ViewStack &	instance ()
	Returns singleton view-stack instance.

Static Public Attributes
static constexpr uint8_t	MAX_DEPTH = 20

Detailed Description

ViewStack - Navigation stack for views

Manages a stack of views for hierarchical navigation. Supports push/pop/replace operations and modal overlays.

Reference: ~/GIT/cdc-badge-os-legacy/main/app_input.cpp (state machine)

Definition at line 18 of file ViewStack.h.

Member Typedef Documentation

◆ InactivityCallback

using cdc::ui::ViewStack::InactivityCallback = void(*)()

Callback type for inactivity timeout

Definition at line 209 of file ViewStack.h.

Member Function Documentation

◆ acquireExclusive()

bool cdc::ui::ViewStack::acquireExclusive ( const void * owner )

Acquires exclusive ownership of the view stack.

Parameters

owner Caller-supplied identity token (use the view pointer or a static address).

Returns: true if lock acquired, false if already held by someone else.

While exclusive ownership is held, push/pop/replace/showModal from anyone other than the owner are rejected with a warning log.

Definition at line 525 of file ViewStack.cpp.

References LOG_D, LOG_W, and cdc::ui::TAG.

Referenced by cdc::plugin_manager::PluginUiState::acquireExclusive().

◆ at()

IView * cdc::ui::ViewStack::at ( uint8_t depth ) const

Get view at specific depth (0 = root)

Definition at line 276 of file ViewStack.cpp.

◆ checkInactivity()

void cdc::ui::ViewStack::checkInactivity ( uint32_t nowMs )

Check and handle inactivity (call in tick/loop)

Parameters

nowMs Current time in milliseconds

Definition at line 496 of file ViewStack.cpp.

References LOG_I, and cdc::ui::TAG.

Referenced by cdc::ui::ui_process().

◆ current()

IView * cdc::ui::ViewStack::current ( ) const

Get current (top) view

Definition at line 270 of file ViewStack.cpp.

Referenced by cdc::serial::cmdPaste(), cdc::ui::isBadgeLocked(), cdc::plugin_manager::PluginUiState::setViewFooter(), and cdc::plugin_manager::PluginUiState::setViewLifecycle().

◆ depth()

uint8_t cdc::ui::ViewStack::depth ( ) const

inline

Get current stack depth

Definition at line 83 of file ViewStack.h.

Referenced by cdc::ui::isBadgeLocked(), and cdc::plugin_manager::PluginManager::startPlugin().

◆ dispatchKey()

void cdc::ui::ViewStack::dispatchKey ( char key )

Dispatch key press to current view

Parameters

key	Key character

Definition at line 282 of file ViewStack.cpp.

References cdc::core::EventBus::instance(), cdc::core::KEY_PRESSED, cdc::ui::IView::onKey(), cdc::core::EventBus::publish(), cdc::ui::REQUEST_POP, and resetInactivityTimer().

Referenced by cdc::ui::ui_process().

◆ dispatchLongPress()

InputResult cdc::ui::ViewStack::dispatchLongPress ( char key )

Dispatch long press to current view

Parameters

key	Key character

Returns: Result reported by the receiving view (IGNORED if no view handled the press), so callers can wire global fallbacks.

Definition at line 307 of file ViewStack.cpp.

References cdc::ui::CONSUMED, cdc::ui::IGNORED, cdc::core::EventBus::instance(), cdc::core::KEY_LONG_PRESS, cdc::ui::IView::onLongPress(), cdc::core::EventBus::publish(), and cdc::ui::REQUEST_POP.

Referenced by cdc::ui::ui_init().

◆ dispatchTick()

void cdc::ui::ViewStack::dispatchTick ( uint32_t nowMs )

Dispatch tick to current view and modal

Parameters

nowMs Current time

Definition at line 338 of file ViewStack.cpp.

References cdc::ui::IView::onTick().

Referenced by cdc::ui::ui_process().

◆ exclusiveOwner()

const void * cdc::ui::ViewStack::exclusiveOwner ( ) const

inline

Returns current exclusive owner, or nullptr if none.

Definition at line 202 of file ViewStack.h.

◆ forceFullRefresh()

void cdc::ui::ViewStack::forceFullRefresh ( )

inline

Force the next render to use FULL refresh (manual anti-ghosting).

Definition at line 166 of file ViewStack.h.

References forceRefresh(), and cdc::hal::FULL.

Referenced by cdc::ui::ui_init().

◆ forceRefresh()

void cdc::ui::ViewStack::forceRefresh ( hal::RefreshMode mode )

Escalates the refresh mode of the next render.

Parameters

mode	Minimum refresh mode to use; a stronger already-pending mode wins. FULL/FAST reset the HAL ghost-escalation counters as defined in EpaperDisplay. Any view may call this at any time (e.g. games or other high-churn content that wants a clean panel).

Also marks the current view dirty so the request takes effect on the next render pass without requiring a separate markDirty().

Definition at line 471 of file ViewStack.cpp.

Referenced by forceFullRefresh(), and cdc::ui::CanvasView::onTick().

◆ getModal()

IView * cdc::ui::ViewStack::getModal ( ) const

inline

Get the top (input-receiving) modal view, or nullptr if none.

Definition at line 161 of file ViewStack.h.

◆ hasModal()

bool cdc::ui::ViewStack::hasModal ( ) const

inline

Check if any modal is active

Definition at line 156 of file ViewStack.h.

◆ hideModal()

void cdc::ui::ViewStack::hideModal ( )

Hide the top modal, revealing the next modal beneath it (or the base view).

Definition at line 461 of file ViewStack.cpp.

Referenced by cdc::ui::WifiHandlers::connect(), cdc::ui::hideContextMenu(), cdc::ui::hideMessage(), cdc::ui::msgTransferUiProcess(), cdc::ui::BlePairingPromptView::onKey(), cdc::ui::ConfirmView::onKey(), cdc::ui::ToastView::onKey(), cdc::ui::ToastView::onTick(), cdc::ui::runTropicCacheCleanup(), cdc::ui::runTropicCacheRebuild(), cdc::ui::startBluetoothScan(), cdc::ui::wifiConnect(), cdc::ui::wifiNtpSync(), and cdc::ui::wifiStartScan().

◆ instance()

ViewStack & cdc::ui::ViewStack::instance ( )

static

Returns singleton view-stack instance.

Get singleton instance

Definition at line 53 of file ViewStack.cpp.

References instance().

◆ isEmpty()

bool cdc::ui::ViewStack::isEmpty ( ) const

inline

Check if stack is empty

Definition at line 88 of file ViewStack.h.

◆ needsRender()

bool cdc::ui::ViewStack::needsRender ( ) const

Check if any view needs rendering

Definition at line 410 of file ViewStack.cpp.

References cdc::ui::IView::needsRender(), and needsRender().

Referenced by needsRender(), and render().

◆ pop()

void cdc::ui::ViewStack::pop ( )

Pop the top view from stack Does nothing if only one view remains

Definition at line 212 of file ViewStack.cpp.

Referenced by cdc::mod_nvsedit::onDeleteKey(), cdc::mod_gpg::onGpgPinComplete(), cdc::ui::onInactivityTimeout(), cdc::ui::ColorPickerView::onKey(), cdc::ui::DateInputView::onKey(), cdc::ui::SliderView::onKey(), cdc::ui::T9InputView::onKey(), cdc::ui::TimeInputView::onKey(), cdc::ui::onLanguageSelect(), cdc::ui::T9InputView::onLongPress(), cdc::mod_gpg::onMyCertDeleteConfirm(), cdc::ui::settings::onPinChangeComplete(), cdc::mod_gpg::onReceivedDeleteConfirm(), cdc::plugin_manager::PluginManager::stopActivePlugin(), cdc::plugin_manager::PluginManager::unloadAllFromRam(), cdc::plugin_manager::PluginManager::unloadFromRam(), and cdc::ui::wifiFinishSetup().

◆ popToAnchor()

void cdc::ui::ViewStack::popToAnchor ( IView * anchor )

Pops views until the specified anchor view is the current view.

Parameters

anchor Anchor view to return to.

Stops popping if the anchor is reached or only the root view remains. Useful for returning to a list view after wizard completion.

Definition at line 254 of file ViewStack.cpp.

Referenced by cdc::mod_password::onMenuDeleteConfirm(), cdc::mod_vcard::onReceivedDeleteConfirm(), cdc::mod_gpg::onWizardCurve(), cdc::mod_2fa::wizardFinish(), cdc::mod_password::wizardFinish(), and cdc::mod_vcard::wizardFinish().

◆ popToDepth()

void cdc::ui::ViewStack::popToDepth ( uint8_t targetDepth )

Pops views until the stack depth is at most targetDepth.

Parameters

targetDepth Depth to collapse down to; never pops below the root.

Used by host_ui_pop_to_plugin to return to a plugin's first view in one step, since plugin root views have no stable pointer for popToAnchor.

Definition at line 263 of file ViewStack.cpp.

Referenced by host_ui_pop_to_plugin().

◆ popToRoot()

void cdc::ui::ViewStack::popToRoot ( )

Pop all views except root

Definition at line 247 of file ViewStack.cpp.

◆ push()

void cdc::ui::ViewStack::push	(	IView *	view,
		void *	context = nullptr )

Push a view onto the stack

Parameters

view	View to push
context	Optional context to pass to onEnter

Definition at line 207 of file ViewStack.cpp.

Referenced by host_ui_push_info(), cdc::ui::onBluetoothMenuSelect(), cdc::ui::onExpertMenuSelect(), cdc::mod_2fa::onListSelect(), cdc::ui::onMainMenuSelect(), cdc::mod_gpg::onMyCertListSelect(), cdc::mod_gpg::onReceivedActionSelect(), cdc::mod_gpg::onSettingsSelect(), cdc::ui::onSettingsSelect(), cdc::ui::onToolsSelect(), cdc::ui::onUnlockRequested(), cdc::ui::onWifiMainSelect(), cdc::mod_2fa::onWizardAlgo(), cdc::mod_gpg::onWizardEmail(), cdc::mod_2fa::onWizardIssuer(), cdc::mod_gpg::onWizardName(), cdc::mod_password::onWizardUsername(), cdc::mod_vcard::openReceivedList(), cdc::mod_2fa::pushAlgoStep(), cdc::plugin_manager::PluginUiState::pushCanvas(), cdc::plugin_manager::PluginUiState::pushColorPicker(), cdc::mod_vcard::pushCurrentStep(), cdc::plugin_manager::PluginUiState::pushDate(), cdc::plugin_manager::PluginUiState::pushPin(), cdc::plugin_manager::PluginUiState::pushSlider(), cdc::plugin_manager::PluginUiState::pushT9(), cdc::mod_2fa::pushT9WizardStep(), cdc::mod_password::pushT9WizardStep(), cdc::plugin_manager::PluginUiState::pushTime(), cdc::mod_2fa::pushTouchStep(), cdc::mod_2fa::pushUsbCrStep(), cdc::ui::showBackupMenu(), cdc::ui::showBeaconMenu(), cdc::ui::showBluetoothMenu(), cdc::mod_fido2::showDetail(), cdc::mod_password::showDetails(), cdc::ui::showDuressPinSetup(), cdc::ui::showExpertMenu(), cdc::mod_gpg::showExport(), cdc::ui::showFirmwareCheck(), cdc::ui::showImage(), cdc::ui::showInfo(), cdc::mod_nvsedit::showKeyListView(), cdc::ui::showListView(), cdc::ui::showMarkdown(), cdc::ui::showModulesView(), cdc::mod_gpg::showMyCertifications(), cdc::mod_nvsedit::showNamespaceListView(), cdc::ui::showPairedDevices(), cdc::ui::showPinEntry(), cdc::ui::showPlainText(), cdc::ui::showQRCode(), cdc::mod_gpg::showReceivedDetail(), cdc::mod_gpg::showReceivedKeys(), cdc::mod_gpg::showSettings(), cdc::ui::showSlider(), cdc::mod_gpg::showStatus(), cdc::ui::showT9Input(), cdc::mod_nvsedit::showValueView(), cdc::mod_vcard::showVcardDetails(), cdc::ui::showWifiMainMenu(), cdc::ui::startBluetoothScan(), cdc::ui::ui_init(), cdc::ui::wifiShowAuthMenu(), cdc::ui::wifiShowIpModeMenu(), cdc::ui::wifiStartScan(), cdc::mod_2fa::wizardStart(), and cdc::mod_gpg::wizardStart().

◆ releaseExclusive()

bool cdc::ui::ViewStack::releaseExclusive ( const void * owner )

Releases exclusive ownership.

Parameters

owner Must match the token used in acquireExclusive.

Returns: true if released, false if owner mismatch or not held.

Definition at line 540 of file ViewStack.cpp.

References LOG_D, LOG_W, and cdc::ui::TAG.

Referenced by cdc::plugin_manager::PluginUiState::releaseExclusive().

◆ removeModal()

void cdc::ui::ViewStack::removeModal ( IView * modal )

Remove a specific modal from any position in the modal stack.

Unlike hideModal() this does not require the modal to be on top; modals stacked above it stay in place. Used to retract an overlay whose backing view object is about to be destroyed (e.g. plugin teardown), so the stack keeps no dangling pointer. No-op if the modal is not currently shown.

Parameters

modal The modal view to remove.

Definition at line 466 of file ViewStack.cpp.

◆ render()

void cdc::ui::ViewStack::render ( bool synchronous = false )

Render current view (and modal if present) and flush to display.

Parameters

synchronous When true, flush via the blocking display path (flushSync) so the panel update has fully completed on return. When false (default), flush asynchronously via the render task.

Definition at line 349 of file ViewStack.cpp.

References cdc::ui::IView::clearDirty(), cdc::ui::display, cdc::hal::getDisplayInstance(), cdc::ui::IView::needsRender(), needsRender(), cdc::hal::PARTIAL, cdc::hal::PARTIAL_LIGHT, cdc::ui::IView::prefersLightRefresh(), cdc::ui::IView::render(), cdc::ui::resetTextState(), and cdc::ui::strongerRefresh().

Referenced by cdc::ui::WifiHandlers::connect(), host_ui_push_toast(), cdc::ui::showConfirm(), cdc::ui::showToastInternal(), cdc::plugin_manager::PluginManager::startPlugin(), and cdc::ui::ui_process().

◆ replace()

void cdc::ui::ViewStack::replace	(	IView *	view,
		void *	context = nullptr )

Replace top view with another

Parameters

view	New view
context	Optional context

Definition at line 217 of file ViewStack.cpp.

References cdc::ui::IView::getName(), LOG_D, LOG_W, cdc::ui::IView::onEnter(), cdc::ui::IView::onExit(), cdc::ui::IView::preferredEnterRefresh(), and cdc::ui::TAG.

Referenced by cdc::ui::onPinSuccess().

◆ resetInactivityTimer()

void cdc::ui::ViewStack::resetInactivityTimer ( )

Reset inactivity timer (called automatically on key press)

Definition at line 491 of file ViewStack.cpp.

Referenced by dispatchKey(), cdc::ui::onInactivityTimeout(), and cdc::ui::BlePairingView::onTick().

◆ setInactivityTimeout()

void cdc::ui::ViewStack::setInactivityTimeout	(	InactivityCallback	callback,
		uint32_t	timeoutMs )

Set inactivity timeout callback

Parameters

callback	Function to call when timeout expires
timeoutMs	Timeout in milliseconds (0 to disable)

Definition at line 483 of file ViewStack.cpp.

References LOG_D, and cdc::ui::TAG.

Referenced by cdc::plugin_manager::PluginUiState::setInactivity(), and cdc::ui::ui_init().

◆ showModal()

void cdc::ui::ViewStack::showModal ( IView * modal )

Show a modal overlay (e.g., toast, context menu). Modals stack: the new one is pushed on top of any already-shown modal and receives input exclusively. If the same modal is already stacked it is lifted to the top.

Parameters

modal Modal view

Definition at line 419 of file ViewStack.cpp.

References cdc::ui::IView::getName(), LOG_D, LOG_W, cdc::ui::IView::onEnter(), cdc::ui::IView::onPause(), and cdc::ui::TAG.

Referenced by host_ui_push_toast(), cdc::ui::onBlePairingRequestEvent(), cdc::plugin_manager::PluginUiState::pushConfirm(), cdc::plugin_manager::PluginUiState::pushContextMenu(), cdc::ui::showConfirm(), cdc::ui::showContextMenu(), cdc::ui::showMessage(), cdc::ui::showToastInternal(), and cdc::plugin_manager::PluginManager::startPlugin().

Member Data Documentation

◆ MAX_DEPTH

uint8_t cdc::ui::ViewStack::MAX_DEPTH = 20

staticconstexpr

Definition at line 20 of file ViewStack.h.

The documentation for this class was generated from the following files:

components/cdc_ui/include/cdc_ui/ViewStack.h
components/cdc_ui/src/ViewStack.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ InactivityCallback

Member Function Documentation

◆ acquireExclusive()

◆ at()

◆ checkInactivity()

◆ current()

◆ depth()

◆ dispatchKey()

◆ dispatchLongPress()

◆ dispatchTick()

◆ exclusiveOwner()

◆ forceFullRefresh()

◆ forceRefresh()

◆ getModal()

◆ hasModal()

◆ hideModal()

◆ instance()

◆ isEmpty()

◆ needsRender()

◆ pop()

◆ popToAnchor()

◆ popToDepth()

◆ popToRoot()

◆ push()

◆ releaseExclusive()

◆ removeModal()

◆ render()

◆ replace()

◆ resetInactivityTimer()

◆ setInactivityTimeout()

◆ showModal()

Member Data Documentation

◆ MAX_DEPTH