# Tui

`class Tui`

Defined in [tui.hpp:18](../../../../src/tui/tui.hpp#L18)

## Private type

### `enum Completion`

📍 [tui.hpp:19](../../../../src/tui/tui.hpp#L19)

## Private Attributes

### `std::vector< std::string > history`

📍 [tui.hpp:41](../../../../src/tui/tui.hpp#L41)

### `std::vector< std::string > recorded`

📍 [tui.hpp:42](../../../../src/tui/tui.hpp#L42)

### `std::vector< std::string > output`

📍 [tui.hpp:43](../../../../src/tui/tui.hpp#L43)

### `std::string input`

📍 [tui.hpp:44](../../../../src/tui/tui.hpp#L44)

### `int cursor_pos`

📍 [tui.hpp:45](../../../../src/tui/tui.hpp#L45)

### `int history_idx`

📍 [tui.hpp:46](../../../../src/tui/tui.hpp#L46)

### `int scroll_offset`

📍 [tui.hpp:47](../../../../src/tui/tui.hpp#L47)

Lines scrolled up from the tail; 0 = follow newest output.

### `bool quit`

📍 [tui.hpp:48](../../../../src/tui/tui.hpp#L48)

### `bool in_source`

📍 [tui.hpp:49](../../../../src/tui/tui.hpp#L49)

### `std::unique_ptr< System > sys`

📍 [tui.hpp:51](../../../../src/tui/tui.hpp#L51)

### `std::deque< Prompt > pending`

📍 [tui.hpp:52](../../../../src/tui/tui.hpp#L52)

### `std::map< std::string, CommandSpec > commands`

📍 [tui.hpp:53](../../../../src/tui/tui.hpp#L53)

### `std::map< std::string, std::string > vars`

📍 [tui.hpp:54](../../../../src/tui/tui.hpp#L54)

$var-style substitution table.

### `int screen_idx`

📍 [tui.hpp:57](../../../../src/tui/tui.hpp#L57)

### `std::vector< std::string > search_modules`

📍 [tui.hpp:60](../../../../src/tui/tui.hpp#L60)

### `std::vector< std::string > search_types`

📍 [tui.hpp:61](../../../../src/tui/tui.hpp#L61)

### `int search_module_idx`

📍 [tui.hpp:62](../../../../src/tui/tui.hpp#L62)

### `int search_type_idx`

📍 [tui.hpp:63](../../../../src/tui/tui.hpp#L63)

### `int search_focus_idx`

📍 [tui.hpp:64](../../../../src/tui/tui.hpp#L64)

### `std::string search_query`

📍 [tui.hpp:65](../../../../src/tui/tui.hpp#L65)

### `std::vector< std::string > connect_modules`

📍 [tui.hpp:68](../../../../src/tui/tui.hpp#L68)

### `int connect_m1_idx`

📍 [tui.hpp:69](../../../../src/tui/tui.hpp#L69)

### `int connect_m2_idx`

📍 [tui.hpp:70](../../../../src/tui/tui.hpp#L70)

### `std::string connect_p1_filter`

📍 [tui.hpp:71](../../../../src/tui/tui.hpp#L71)

### `std::string connect_p2_filter`

📍 [tui.hpp:72](../../../../src/tui/tui.hpp#L72)

### `std::vector< std::string > connect_p1_list`

📍 [tui.hpp:73](../../../../src/tui/tui.hpp#L73)

### `std::vector< std::string > connect_p2_list`

📍 [tui.hpp:74](../../../../src/tui/tui.hpp#L74)

### `int connect_p1_idx`

📍 [tui.hpp:75](../../../../src/tui/tui.hpp#L75)

### `int connect_p2_idx`

📍 [tui.hpp:76](../../../../src/tui/tui.hpp#L76)

### `int connect_focus_idx`

📍 [tui.hpp:77](../../../../src/tui/tui.hpp#L77)

### `std::vector< std::string > explore_modules`

📍 [tui.hpp:80](../../../../src/tui/tui.hpp#L80)

### `int explore_module_idx`

📍 [tui.hpp:81](../../../../src/tui/tui.hpp#L81)

### `std::vector< std::string > explore_types`

📍 [tui.hpp:82](../../../../src/tui/tui.hpp#L82)

### `int explore_type_idx`

📍 [tui.hpp:83](../../../../src/tui/tui.hpp#L83)

### `std::vector< std::string > explore_children`

📍 [tui.hpp:84](../../../../src/tui/tui.hpp#L84)

### `int explore_child_idx`

📍 [tui.hpp:85](../../../../src/tui/tui.hpp#L85)

### `std::string explore_child_filter`

📍 [tui.hpp:86](../../../../src/tui/tui.hpp#L86)

### `std::string explore_detail_filter`

📍 [tui.hpp:87](../../../../src/tui/tui.hpp#L87)

### `std::vector< std::string > explore_detail`

📍 [tui.hpp:88](../../../../src/tui/tui.hpp#L88)

### `int explore_detail_idx`

📍 [tui.hpp:89](../../../../src/tui/tui.hpp#L89)

### `std::string explore_header`

📍 [tui.hpp:90](../../../../src/tui/tui.hpp#L90)

### `int explore_focus_idx`

📍 [tui.hpp:91](../../../../src/tui/tui.hpp#L91)

### `std::atomic< bool > loading`

📍 [tui.hpp:94](../../../../src/tui/tui.hpp#L94)

true while a script is being processed; read by tick thread.

### `std::atomic< bool > tick_in_flight`

📍 [tui.hpp:95](../../../../src/tui/tui.hpp#L95)

main thread acks each tick by clearing this; ticker waits.

### `std::string loading_filename`

📍 [tui.hpp:96](../../../../src/tui/tui.hpp#L96)

### `std::vector< std::string > loading_lines`

📍 [tui.hpp:97](../../../../src/tui/tui.hpp#L97)

### `size_t loading_idx`

📍 [tui.hpp:98](../../../../src/tui/tui.hpp#L98)

### `int loading_executed`

📍 [tui.hpp:99](../../../../src/tui/tui.hpp#L99)

### `int loading_lineno`

📍 [tui.hpp:100](../../../../src/tui/tui.hpp#L100)

### `bool loading_prev_in_source`

📍 [tui.hpp:101](../../../../src/tui/tui.hpp#L101)

### `ftxui::ScreenInteractive * screen_ptr`

📍 [tui.hpp:102](../../../../src/tui/tui.hpp#L102)

set in `Run()` so Source() can post events. so Source() can post events.

### `std::vector< std::string > net_modules`

📍 [tui.hpp:105](../../../../src/tui/tui.hpp#L105)

### `int net_module_idx`

📍 [tui.hpp:106](../../../../src/tui/tui.hpp#L106)

### `std::string net_sig_filter`

📍 [tui.hpp:107](../../../../src/tui/tui.hpp#L107)

### `std::vector< std::string > net_sigs`

📍 [tui.hpp:108](../../../../src/tui/tui.hpp#L108)

rebuilt every frame from filter

### `int net_sig_idx`

📍 [tui.hpp:109](../../../../src/tui/tui.hpp#L109)

### `int net_focus_idx`

📍 [tui.hpp:110](../../../../src/tui/tui.hpp#L110)

### `std::vector< std::string > settype_modules`

📍 [tui.hpp:113](../../../../src/tui/tui.hpp#L113)

### `int settype_m_idx`

📍 [tui.hpp:114](../../../../src/tui/tui.hpp#L114)

### `std::string settype_p_filter`

📍 [tui.hpp:115](../../../../src/tui/tui.hpp#L115)

### `std::vector< std::string > settype_p_list`

📍 [tui.hpp:116](../../../../src/tui/tui.hpp#L116)

### `int settype_p_idx`

📍 [tui.hpp:117](../../../../src/tui/tui.hpp#L117)

### `std::string settype_type`

📍 [tui.hpp:118](../../../../src/tui/tui.hpp#L118)

### `std::string settype_status`

📍 [tui.hpp:119](../../../../src/tui/tui.hpp#L119)

### `int settype_focus_idx`

📍 [tui.hpp:120](../../../../src/tui/tui.hpp#L120)

## Public Functions

### `Tui()`

📍 [tui.hpp:123](../../../../src/tui/tui.hpp#L123)

### `~Tui()`

📍 [tui.hpp:124](../../../../src/tui/tui.hpp#L124)

### `void Run()`

📍 [tui.hpp:125](../../../../src/tui/tui.hpp#L125)

### `void DumpCommandsMd(std::ostream &out) const`

📍 [tui.hpp:126](../../../../src/tui/tui.hpp#L126)

## Private Functions

### `void RegisterCommands()`

📍 [tui.hpp:130](../../../../src/tui/tui.hpp#L130)

### `void Print(const std::string &line)`

📍 [tui.hpp:133](../../../../src/tui/tui.hpp#L133)

### `void Submit()`

📍 [tui.hpp:134](../../../../src/tui/tui.hpp#L134)

### `void Dispatch(const std::string &raw)`

📍 [tui.hpp:135](../../../../src/tui/tui.hpp#L135)

### `void Finalize(const std::string &name, const CommandSpec &spec, const std::vector< std::string > &args)`

📍 [tui.hpp:136](../../../../src/tui/tui.hpp#L136)

### `void HistoryUp()`

📍 [tui.hpp:139](../../../../src/tui/tui.hpp#L139)

### `void HistoryDown()`

📍 [tui.hpp:140](../../../../src/tui/tui.hpp#L140)

### `void CancelPending()`

📍 [tui.hpp:141](../../../../src/tui/tui.hpp#L141)

### `void LoadHistory()`

📍 [tui.hpp:142](../../../../src/tui/tui.hpp#L142)

### `void AppendHistory(const std::string &cmd)`

📍 [tui.hpp:143](../../../../src/tui/tui.hpp#L143)

### `void Source(const std::string &filename)`

📍 [tui.hpp:144](../../../../src/tui/tui.hpp#L144)

### `void ProcessNextSourceLine()`

📍 [tui.hpp:145](../../../../src/tui/tui.hpp#L145)

### `std::string ExpandVars(const std::string &s) const`

📍 [tui.hpp:146](../../../../src/tui/tui.hpp#L146)

### `void CompleteCommand(size_t start=0)`

📍 [tui.hpp:149](../../../../src/tui/tui.hpp#L149)

### `void CompletePath(size_t start=0)`

📍 [tui.hpp:150](../../../../src/tui/tui.hpp#L150)

### `void CompleteInline()`

📍 [tui.hpp:151](../../../../src/tui/tui.hpp#L151)

### `void RefreshFilteredPartList(const std::vector< std::string > &modules, int m_idx, const std::string &filter, std::vector< std::string > &out, int &sel_idx)`

📍 [tui.hpp:154](../../../../src/tui/tui.hpp#L154)

### `ftxui::Component BuildMainScreen(ftxui::ScreenInteractive &screen)`

📍 [tui.hpp:161](../../../../src/tui/tui.hpp#L161)

### `ftxui::Component BuildSearchScreen()`

📍 [tui.hpp:162](../../../../src/tui/tui.hpp#L162)

### `ftxui::Component BuildConnectScreen()`

📍 [tui.hpp:163](../../../../src/tui/tui.hpp#L163)

### `ftxui::Component BuildSettypeScreen()`

📍 [tui.hpp:164](../../../../src/tui/tui.hpp#L164)

### `ftxui::Component BuildExploreScreen()`

📍 [tui.hpp:165](../../../../src/tui/tui.hpp#L165)

### `ftxui::Component BuildNetScreen()`

📍 [tui.hpp:166](../../../../src/tui/tui.hpp#L166)

---

← [Back to classes](index.md) · [Top](../index.md)