tuiserial-ui 0.1.5

Terminal user interface components for tuiserial
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

//! Terminal user interface components for tuiserial
//!
//! This crate provides the UI rendering logic using ratatui for displaying
//! serial port configuration, logs, and user interactions with full mouse support.
//!
//! ## Architecture
//!
//! The UI is organized into modular components:
//! - `areas`: UI area definitions and mouse interaction handling
//! - `menu`: Menu bar and dropdown rendering
//! - `config`: Configuration panel with dropdowns for serial settings
//! - `status`: Status panel and statistics display
//! - `log`: Log area showing serial communication data
//! - `tx`: Transmission input area
//! - `notification`: Notification bar for user messages
//! - `utils`: Utility functions for UI rendering

use ratatui::{
    layout::{Constraint, Direction, Layout, Rect},
    Frame,
};
use tuiserial_core::{AppState, MenuState};

// Module declarations
mod areas;
mod config;
mod help;
mod log;
mod menu;
mod mouse;
mod notification;
mod shortcuts;
mod status;
mod tx;
mod utils;

// Re-exports for external use
pub use areas::{
    get_clicked_field, get_clicked_menu, get_clicked_tab, get_ui_areas, is_inside,
    is_shortcuts_hint_clicked, update_cursor_state, UiAreas,
};
pub use crossterm;
pub use mouse::{
    calculate_dropdown_area, get_cursor_type, get_hover_style, handle_mouse_click,
    handle_mouse_hover, handle_mouse_scroll, is_clickable_area, CursorType, MouseAction,
    ScrollAction, ScrollDirection,
};
pub use ratatui;
pub use shortcuts::{draw_context_shortcuts, draw_shortcuts_help, draw_shortcuts_hint};

// Re-export menu functions
pub use menu::find_clicked_menu;

/// Main draw function - renders the entire application UI
///
/// This is the entry point for rendering the UI. It orchestrates the layout
/// and delegates rendering to specialized modules.
pub fn draw(f: &mut Frame, app: &AppState) {
    // Main layout: menu bar, content area, notification bar, shortcuts hint
    let chunks = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Length(1), // Menu bar
            Constraint::Min(15),   // Main content
            Constraint::Length(3), // Notification area
            Constraint::Length(1), // Shortcuts hint bar
        ])
        .split(f.area());

    // Render main content first
    draw_main_content(f, app, chunks[1]);

    // Render notification bar
    notification::draw_notification_bar(f, app, chunks[2]);

    // Render shortcuts hint bar
    shortcuts::draw_shortcuts_hint(f, chunks[3], app.language);

    // Render menu bar (without dropdown)
    menu::draw_menu_bar(f, app, chunks[0]);

    // Render dropdown last to ensure it's on top
    if let MenuState::Dropdown(menu_idx, item_idx) = app.menu_state {
        menu::draw_menu_dropdown(f, app, chunks[0], menu_idx, item_idx);
    }

    // Render shortcuts help overlay if active (on top of everything)
    if app.show_shortcuts_help {
        shortcuts::draw_shortcuts_help(f, app.language);
    }

    // Store menu bar, notification area, and shortcuts hint for mouse interaction
    areas::update_area(areas::UiAreaField::MenuBar, chunks[0]);
    areas::update_area(areas::UiAreaField::NotificationArea, chunks[2]);
    areas::update_area(areas::UiAreaField::ShortcutsHint, chunks[3]);
}

/// Draw the main content area (config panel + log/tx areas)
fn draw_main_content(f: &mut Frame, app: &AppState, area: Rect) {
    let chunks = Layout::default()
        .direction(Direction::Horizontal)
        .constraints([Constraint::Length(42), Constraint::Min(50)])
        .split(area);

    draw_config_panel(f, app, chunks[0]);
    draw_main_area(f, app, chunks[1]);
}

/// Draw the configuration panel on the left
fn draw_config_panel(f: &mut Frame, app: &AppState, area: Rect) {
    let chunks = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Length(5), // Port
            Constraint::Length(5), // Baud rate
            Constraint::Length(3), // Data bits
            Constraint::Length(3), // Parity
            Constraint::Length(3), // Stop bits
            Constraint::Length(3), // Flow control
            Constraint::Min(10),   // Status panel
        ])
        .split(area);

    config::draw_port_dropdown(f, app, chunks[0]);
    config::draw_baud_rate_dropdown(f, app, chunks[1]);
    config::draw_data_bits_dropdown(f, app, chunks[2]);
    config::draw_parity_dropdown(f, app, chunks[3]);
    config::draw_stop_bits_dropdown(f, app, chunks[4]);
    config::draw_flow_control_dropdown(f, app, chunks[5]);
    status::draw_status_panel(f, app, chunks[6]);
}

/// Draw the main area on the right (log + tx + control)
fn draw_main_area(f: &mut Frame, app: &AppState, area: Rect) {
    let chunks = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Min(10),   // Log area
            Constraint::Length(7), // TX area
            Constraint::Length(3), // Control/stats area
        ])
        .split(area);

    log::draw_log_area(f, app, chunks[0]);
    tx::draw_tx_area(f, app, chunks[1]);
    status::draw_control_area(f, app, chunks[2]);
}