Skip to main content

mermaid_cli/render/
mod.rs

1//! Pure view: `fn render(&State, &mut RenderCache, &mut Frame)`.
2//!
3//! Three contracts:
4//!   1. Never mutates `State`. The view is fully derived.
5//!   2. Never performs I/O. All state — model lists, MCP status,
6//!      file contents — is whatever the reducer put in `State`.
7//!   3. Never holds a `&mut App` / `&mut anything` other than the
8//!      `Frame` ratatui owns and the render-layer `RenderCache`
9//!      (which is memoization + scroll-position bookkeeping, not
10//!      reducer state).
11//!
12//! Signature: `fn render(&State, &mut RenderCache, &mut Frame)`.
13//! The `&mut RenderCache` is memoization only (markdown parse
14//! cache, scroll position, theme choice) — it never affects
15//! reducer outcomes or persisted state.
16
17pub mod diff;
18pub mod layout;
19pub mod markdown;
20pub mod theme;
21pub mod widgets;
22
23use ratatui::{Frame, layout::Margin};
24use rustc_hash::FxHashMap;
25use unicode_width::UnicodeWidthChar;
26
27use crate::domain::{State, TurnState};
28use crate::models::{ReasoningCapability, ReasoningLevel, nearest_effort};
29
30use widgets::{
31    AttachmentWidget, ChatState, ChatWidget, GenerationStatus, InputState, InputWidget,
32    SlashPaletteWidget, StatusLineWidget, StatusWidget,
33};
34
35/// Transient render-layer state that lives across frames but isn't
36/// reducer state. Owned by `app::run_interactive`; passed as `&mut`
37/// to `render()` per frame.
38///
39/// Contents are pure memoization + UI affordances (scroll position,
40/// markdown cache, theme choice). Nothing here affects what the
41/// reducer sees or what ends up on disk — the cache can be dropped
42/// and rebuilt from `&State` at any time.
43pub struct RenderCache {
44    pub chat: ChatState,
45    pub markdown_cache: FxHashMap<u64, Vec<ratatui::text::Line<'static>>>,
46    pub theme: theme::Theme,
47    /// F13: last `state.ui.mouse_scroll_accum` value we applied to
48    /// `chat.scroll_up/down`. Diffing lets the reducer stay pure —
49    /// it just publishes a counter; render owns the chat-state side.
50    last_mouse_scroll_accum: i32,
51}
52
53impl Default for RenderCache {
54    fn default() -> Self {
55        Self {
56            chat: ChatState::new(),
57            markdown_cache: FxHashMap::default(),
58            theme: theme::Theme::dark(),
59            last_mouse_scroll_accum: 0,
60        }
61    }
62}
63
64impl RenderCache {
65    pub fn new() -> Self {
66        Self::default()
67    }
68}
69
70/// The entrypoint. Call once per render pass from the main loop.
71pub fn render(state: &State, rstate: &mut RenderCache, frame: &mut Frame) {
72    // F13: consume any pending mouse-scroll accumulator. The reducer
73    // publishes a monotonic counter on `ui.mouse_scroll_accum`; we
74    // apply the delta to `ChatState` since the reducer isn't allowed
75    // to touch render-layer state directly.
76    let pending = state.ui.mouse_scroll_accum - rstate.last_mouse_scroll_accum;
77    if pending > 0 {
78        rstate.chat.scroll_up(pending as u16);
79    } else if pending < 0 {
80        rstate.chat.scroll_down((-pending) as u16);
81    }
82    rstate.last_mouse_scroll_accum = state.ui.mouse_scroll_accum;
83
84    // Input height: content-aware, respecting CJK/emoji widths.
85    let terminal_width = frame.area().width.saturating_sub(4) as usize;
86    let input_lines = if state.ui.input_buffer.is_empty() {
87        1
88    } else {
89        let mut lines = 1usize;
90        let mut col = 0usize;
91        for ch in state.ui.input_buffer.chars() {
92            let w = ch.width().unwrap_or(0);
93            if ch == '\n' || col >= terminal_width {
94                lines += 1;
95                col = if ch == '\n' { 0 } else { w };
96            } else {
97                col += w;
98            }
99        }
100        lines.min(5)
101    };
102    let input_height = (input_lines + 2) as u16;
103
104    let queued_count = state.ui.queued_messages.len();
105    let status_line_height = if state.is_busy() {
106        (1 + queued_count).min(6) as u16
107    } else {
108        0
109    };
110
111    let attachment_height = if state.ui.attachments.is_empty() {
112        0
113    } else {
114        1
115    };
116
117    // F9: one-row banner for `state.status`. Previously the reducer
118    // set state.status for slash commands, MCP errors, and model-pull
119    // progress but no widget painted it. Height is 1 when a status is
120    // present, 0 otherwise.
121    let status_banner_height: u16 = if state.status.is_some() { 1 } else { 0 };
122
123    // Bottom region: one of three widgets based on UI mode.
124    //   - ConversationList picker: 12-line pane.
125    //   - Slash palette (input starts with `/`): 3–10 lines based on
126    //     filter match count.
127    //   - Otherwise: 2-line status bar.
128    let conv_list_open = matches!(
129        state.ui.mode,
130        crate::domain::UiMode::ConversationList { .. }
131    );
132    let palette_open = !conv_list_open && state.ui.input_buffer.starts_with('/');
133    let bottom_height = if conv_list_open {
134        12
135    } else if palette_open {
136        let typed = state
137            .ui
138            .input_buffer
139            .trim_start_matches('/')
140            .split_whitespace()
141            .next()
142            .unwrap_or("");
143        let row_count = crate::domain::slash_commands::filter_by_prefix(typed)
144            .len()
145            .clamp(1, 8);
146        (row_count as u16) + 2
147    } else {
148        2
149    };
150
151    // 6-zone vertical layout: chat / status line / attachments /
152    // status banner / input / bottom. The banner sits directly above
153    // input so the eye finds "what just happened" right next to
154    // "what's next to type".
155    use ratatui::layout::{Constraint, Direction, Layout};
156    let chunks = Layout::default()
157        .direction(Direction::Vertical)
158        .constraints([
159            Constraint::Min(10),
160            Constraint::Length(status_line_height),
161            Constraint::Length(attachment_height),
162            Constraint::Length(status_banner_height),
163            Constraint::Length(input_height),
164            Constraint::Length(bottom_height),
165        ])
166        .split(frame.area());
167
168    // Chat area with 1-cell horizontal padding.
169    let chat_area = chunks[0].inner(Margin {
170        horizontal: 1,
171        vertical: 0,
172    });
173    let committed = state.session.messages().to_vec();
174    let live_messages = build_live_messages(&committed, &state.turn);
175    let chat_widget = ChatWidget {
176        messages: &live_messages,
177        theme: &rstate.theme,
178        markdown_cache: &mut rstate.markdown_cache,
179        show_reasoning: state.ui.show_reasoning,
180    };
181    frame.render_stateful_widget(chat_widget, chat_area, &mut rstate.chat);
182
183    // Status line for every active turn. Tool execution previously
184    // reserved the row but did not paint it, which made queued input
185    // look like it had disappeared.
186    if state.is_busy() {
187        let elapsed_secs = match &state.turn {
188            TurnState::Generating { started, .. } | TurnState::Compacting { started, .. } => {
189                started.elapsed().map(|d| d.as_secs()).unwrap_or(0)
190            },
191            TurnState::Cancelling { since, .. } => {
192                since.elapsed().map(|d| d.as_secs()).unwrap_or(0)
193            },
194            TurnState::ExecutingTools { .. } | TurnState::Idle => 0,
195        };
196        let (tokens_display, tokens_estimated) = match &state.turn {
197            TurnState::Generating {
198                tokens,
199                partial_text,
200                ..
201            } if *tokens == 0 && !partial_text.is_empty() => (partial_text.len() / 4, true),
202            TurnState::Generating { tokens, .. } => (*tokens, false),
203            _ => (0, false),
204        };
205        let status_line_widget = StatusLineWidget {
206            status: GenerationStatus::from_turn(&state.turn),
207            elapsed_secs,
208            tokens_received: tokens_display,
209            tokens_estimated,
210            theme: &rstate.theme,
211            queued_messages: &state.ui.queued_messages,
212        };
213        frame.render_widget(status_line_widget, chunks[1]);
214    }
215
216    // Attachment bar.
217    if !state.ui.attachments.is_empty() {
218        let attachment_widget = AttachmentWidget {
219            attachments: &state.ui.attachments,
220            theme: &rstate.theme,
221            focused: state.ui.attachment_focused,
222            selected: state.ui.attachment_selected,
223        };
224        frame.render_widget(attachment_widget, chunks[2]);
225    }
226
227    // F9 banner for state.status — above input, below attachments.
228    if let Some(ref status) = state.status {
229        let banner = widgets::StatusBannerWidget {
230            theme: &rstate.theme,
231            status,
232        };
233        frame.render_widget(banner, chunks[3]);
234    }
235
236    // Input box.
237    let input_widget = InputWidget {
238        input: state.ui.input_buffer.as_str(),
239        showing_command_hints: state.ui.input_buffer.starts_with('/'),
240        theme: &rstate.theme,
241        reasoning_active: state.session.reasoning != ReasoningLevel::None,
242    };
243    let mut input_widget_state = InputState {
244        cursor_position: state.ui.input_cursor.min(state.ui.input_buffer.len()),
245    };
246    frame.render_stateful_widget(input_widget, chunks[4], &mut input_widget_state);
247
248    // Cursor visible unless focus is on attachments.
249    if !state.ui.attachment_focused {
250        let input_area = chunks[4];
251        let content_width = input_area.width.saturating_sub(2) as usize;
252        let (cursor_row, cursor_col) = InputState::calculate_cursor_position(
253            &state.ui.input_buffer,
254            state.ui.input_cursor.min(state.ui.input_buffer.len()),
255            content_width,
256        );
257        frame.set_cursor_position((input_area.x + cursor_col + 2, input_area.y + 1 + cursor_row));
258    }
259
260    // Effective reasoning level. Per-model supported_reasoning cap
261    // isn't threaded through `State` yet; defaults to no snap
262    // indicator until `ProviderFactory::capabilities` reaches here.
263    let requested = state.session.reasoning;
264    let effective = match supported_reasoning_for(state) {
265        Some(ReasoningCapability::Levels(supp)) => {
266            nearest_effort(requested, &supp).unwrap_or(requested)
267        },
268        _ => requested,
269    };
270    let requested_level = if effective == requested {
271        None
272    } else {
273        Some(requested)
274    };
275
276    // Bottom: conversation-list picker, slash-palette overlay, or
277    // persistent status bar — whichever the UI mode dictates.
278    if let crate::domain::UiMode::ConversationList { candidates, cursor } = &state.ui.mode {
279        use widgets::ConversationListWidget;
280        let widget = ConversationListWidget {
281            theme: &rstate.theme,
282            candidates,
283            cursor: *cursor,
284        };
285        frame.render_widget(widget, chunks[5]);
286    } else if palette_open {
287        let typed = state
288            .ui
289            .input_buffer
290            .trim_start_matches('/')
291            .split_whitespace()
292            .next()
293            .unwrap_or("");
294        let commands = crate::domain::slash_commands::filter_by_prefix(typed);
295        let palette_widget = SlashPaletteWidget {
296            theme: &rstate.theme,
297            commands,
298            selected_index: state.ui.palette_cursor.unwrap_or(0),
299        };
300        frame.render_widget(palette_widget, chunks[5]);
301    } else {
302        let cwd = state.cwd.display().to_string();
303        let status_widget = StatusWidget {
304            theme: &rstate.theme,
305            working_dir: &cwd,
306            context_usage: state.session.context_usage.as_ref(),
307            last_usage: state.session.last_token_usage,
308            session_usage: state.session.cumulative_token_usage,
309            model_name: &state.session.model_id,
310            reasoning_level: effective,
311            requested_level,
312        };
313        frame.render_widget(status_widget, chunks[5]);
314    }
315}
316
317/// Merge the committed message log with any in-flight partial
318/// content from `TurnState::Generating`. The chat widget renders
319/// this as a single stream.
320fn build_live_messages(
321    committed: &[crate::models::ChatMessage],
322    turn: &TurnState,
323) -> Vec<crate::models::ChatMessage> {
324    let mut out = committed.to_vec();
325    if let TurnState::Generating {
326        partial_text,
327        partial_reasoning,
328        ..
329    } = turn
330        && (!partial_text.is_empty() || !partial_reasoning.is_empty())
331    {
332        let thinking = if partial_reasoning.is_empty() {
333            None
334        } else {
335            Some(partial_reasoning.clone())
336        };
337        let msg = crate::models::ChatMessage {
338            role: crate::models::MessageRole::Assistant,
339            content: partial_text.clone(),
340            timestamp: chrono::Local::now(),
341            kind: crate::models::ChatMessageKind::Normal,
342            metadata: None,
343            actions: Vec::new(),
344            thinking,
345            images: None,
346            tool_calls: None,
347            tool_call_id: None,
348            tool_name: None,
349            thinking_signature: None,
350        };
351        out.push(msg);
352    }
353    out
354}
355
356/// Future hook: consult `ProviderFactory` for per-model capabilities.
357/// Today returns `None` — reasoning snap indicator is suppressed
358/// until the factory is threaded through `State` (or an equivalent
359/// capability table).
360fn supported_reasoning_for(_state: &State) -> Option<ReasoningCapability> {
361    None
362}
363
364#[cfg(test)]
365mod tests {
366    use super::*;
367    use crate::app::Config;
368    use crate::domain::{State, StatusKind, StatusLine, TurnState};
369    use ratatui::Terminal;
370    use ratatui::backend::TestBackend;
371    use std::path::PathBuf;
372
373    fn mock_state() -> State {
374        State::new(
375            Config::default(),
376            PathBuf::from("/tmp/p"),
377            "ollama/test".to_string(),
378        )
379    }
380
381    fn render_to_string(state: &State) -> String {
382        let backend = TestBackend::new(80, 24);
383        let mut terminal = Terminal::new(backend).expect("terminal");
384        let mut rstate = RenderCache::new();
385        terminal
386            .draw(|f| render(state, &mut rstate, f))
387            .expect("draw");
388        let buf = terminal.backend().buffer();
389        let mut out = String::new();
390        for y in 0..buf.area.height {
391            for x in 0..buf.area.width {
392                out.push_str(buf[(x, y)].symbol());
393            }
394            out.push('\n');
395        }
396        out
397    }
398
399    #[test]
400    fn idle_state_renders_cwd_and_model_footer() {
401        let s = mock_state();
402        let frame = render_to_string(&s);
403        // Bottom status bar shows cwd + model id somewhere.
404        assert!(frame.contains("/tmp/p") || frame.contains("tmp"));
405        assert!(frame.contains("ollama/test"));
406    }
407
408    #[test]
409    fn status_line_appears_during_generating() {
410        let mut s = mock_state();
411        s.turn = crate::domain::transition::start_generating(crate::domain::TurnId(1));
412        let frame = render_to_string(&s);
413        assert!(
414            frame.contains("Sending") || frame.contains("Thinking") || frame.contains("Streaming"),
415            "expected generation status in frame"
416        );
417    }
418
419    #[test]
420    fn status_line_appears_during_tool_execution_and_shows_queue() {
421        let mut s = mock_state();
422        s.turn = TurnState::ExecutingTools {
423            id: crate::domain::TurnId(1),
424            calls: Vec::new(),
425            outcomes: Vec::new(),
426        };
427        s.ui.queued_messages
428            .push_back("please steer this".to_string());
429        let frame = render_to_string(&s);
430        assert!(frame.contains("Running tools"), "expected tool status");
431        assert!(
432            frame.contains("please steer this"),
433            "queued busy input must be visible"
434        );
435    }
436
437    #[test]
438    fn reasoning_blocks_are_collapsed_by_default() {
439        let mut s = mock_state();
440        let mut first_msg = crate::models::ChatMessage::assistant("first visible answer");
441        first_msg.thinking = Some("first private chain of thought".to_string());
442        s.session.append(first_msg);
443        let mut second_msg = crate::models::ChatMessage::assistant("second visible answer");
444        second_msg.thinking = Some("second private chain of thought".to_string());
445        s.session.append(second_msg);
446        let frame = render_to_string(&s);
447        assert_eq!(frame.matches("Reasoning hidden").count(), 1);
448        assert!(frame.contains("first visible answer"));
449        assert!(frame.contains("second visible answer"));
450        assert!(!frame.contains("first private chain of thought"));
451        assert!(!frame.contains("second private chain of thought"));
452    }
453
454    #[test]
455    fn committed_message_appears_in_chat_pane() {
456        let mut s = mock_state();
457        s.session
458            .append(crate::models::ChatMessage::user("unique-user-token-xyz"));
459        let frame = render_to_string(&s);
460        assert!(frame.contains("unique-user-token-xyz"));
461    }
462
463    #[test]
464    fn palette_renders_when_input_starts_with_slash() {
465        let mut s = mock_state();
466        s.ui.input_buffer = "/help".to_string();
467        s.ui.input_cursor = 5;
468        let frame = render_to_string(&s);
469        // At least one registered command should surface in the overlay.
470        assert!(frame.contains("help"));
471    }
472
473    #[test]
474    fn status_line_helper_maps_idle_to_idle() {
475        assert_eq!(
476            GenerationStatus::from_turn(&TurnState::Idle),
477            GenerationStatus::Idle
478        );
479    }
480
481    /// F9: `state.status` is painted as a banner above input. Before
482    /// this, the reducer would set `state.status` for slash-command
483    /// feedback and MCP errors but no widget displayed it.
484    #[test]
485    fn state_status_renders_as_banner() {
486        let mut s = mock_state();
487        s.status = Some(StatusLine {
488            text: "Reasoning: high".to_string(),
489            kind: StatusKind::Info,
490            shown_at: std::time::SystemTime::now(),
491        });
492        let frame = render_to_string(&s);
493        assert!(
494            frame.contains("Reasoning: high"),
495            "state.status must reach the screen"
496        );
497    }
498
499    #[test]
500    fn unused_status_line_struct_silences_warning() {
501        // Guard against dead_code on the imported StatusLine + StatusKind.
502        let _ = StatusLine {
503            text: "x".to_string(),
504            kind: StatusKind::Info,
505            shown_at: std::time::SystemTime::now(),
506        };
507    }
508}