Skip to main content

vtcode_tui/core_tui/session/
state.rs

1/// State management and lifecycle operations for Session
2///
3/// This module handles session state including:
4/// - Session initialization and configuration
5/// - Exit management
6/// - Redraw and dirty state tracking
7/// - Screen clearing
8/// - Modal management
9/// - Timeline pane toggling
10/// - Scroll management operations
11use std::sync::atomic::Ordering;
12use std::time::{Duration, Instant};
13
14use ratatui::layout::Rect;
15use tokio::sync::mpsc::UnboundedSender;
16
17use super::super::types::{
18    DiffOverlayRequest, DiffPreviewState, InlineEvent, ListOverlayRequest, ModalOverlayRequest,
19    OverlayRequest, WizardOverlayRequest,
20};
21use super::status_requires_shimmer;
22use super::{
23    ActiveOverlay, Session,
24    modal::{ModalListState, ModalSearchState, ModalState, WizardModalState},
25};
26use crate::config::constants::ui;
27
28impl Session {
29    pub(crate) fn inline_lists_visible(&self) -> bool {
30        self.inline_lists_visible
31    }
32
33    pub(crate) fn ensure_inline_lists_visible_for_trigger(&mut self) {
34        if self.inline_lists_visible {
35            return;
36        }
37        self.inline_lists_visible = true;
38        self.mark_dirty();
39    }
40
41    pub(crate) fn toggle_inline_lists_visibility(&mut self) {
42        self.inline_lists_visible = !self.inline_lists_visible;
43        if !self.inline_lists_visible {
44            if self.file_palette_active {
45                self.close_file_palette();
46            }
47            if self.history_picker_state.active {
48                self.history_picker_state.cancel(&mut self.input_manager);
49            }
50        }
51        self.mark_dirty();
52    }
53
54    /// Get the next revision counter for message tracking
55    pub(crate) fn next_revision(&mut self) -> u64 {
56        self.line_revision_counter = self.line_revision_counter.wrapping_add(1);
57        self.line_revision_counter
58    }
59
60    /// Check if the session should exit
61    pub fn should_exit(&self) -> bool {
62        self.should_exit
63    }
64
65    /// Request session exit
66    pub fn request_exit(&mut self) {
67        self.should_exit = true;
68    }
69
70    /// Take the redraw flag and reset it
71    ///
72    /// Returns true if a redraw was needed
73    pub fn take_redraw(&mut self) -> bool {
74        if self.needs_redraw {
75            self.needs_redraw = false;
76            true
77        } else {
78            false
79        }
80    }
81
82    /// Mark the session as needing a redraw
83    pub fn mark_dirty(&mut self) {
84        self.needs_redraw = true;
85        self.header_lines_cache = None;
86        self.queued_inputs_preview_cache = None;
87    }
88
89    /// Invalidate only the header cache (e.g. when provider/model changes)
90    pub fn invalidate_header_cache(&mut self) {
91        self.header_lines_cache = None;
92        self.header_height_cache.clear();
93        self.mark_dirty();
94    }
95
96    /// Invalidate only the sidebar cache (e.g. when queue changes)
97    pub fn invalidate_sidebar_cache(&mut self) {
98        self.queued_inputs_preview_cache = None;
99        self.mark_dirty();
100    }
101
102    pub(crate) fn set_transcript_area(&mut self, area: Option<Rect>) {
103        self.transcript_area = area;
104    }
105
106    pub(crate) fn set_input_area(&mut self, area: Option<Rect>) {
107        self.input_area = area;
108    }
109
110    /// Advance animation state on tick and request redraw when a frame changes.
111    pub fn handle_tick(&mut self) {
112        let motion_reduced = self.appearance.motion_reduced();
113        let mut animation_updated = false;
114        if !motion_reduced && self.thinking_spinner.is_active && self.thinking_spinner.update() {
115            animation_updated = true;
116        }
117        let shimmer_active = if self.appearance.should_animate_progress_status() {
118            self.is_shimmer_active()
119        } else {
120            false
121        };
122        if shimmer_active && self.shimmer_state.update() {
123            animation_updated = true;
124        }
125        if let Some(until) = self.scroll_cursor_steady_until
126            && Instant::now() >= until
127        {
128            self.scroll_cursor_steady_until = None;
129            self.needs_redraw = true;
130        }
131        if self.last_shimmer_active && !shimmer_active {
132            self.needs_redraw = true;
133        }
134        self.last_shimmer_active = shimmer_active;
135        if animation_updated {
136            self.needs_redraw = true;
137        }
138    }
139
140    pub(crate) fn is_running_activity(&self) -> bool {
141        let left = self.input_status_left.as_deref().unwrap_or("");
142        let running_status = self.appearance.should_animate_progress_status()
143            && (left.contains("Running command:")
144                || left.contains("Running tool:")
145                || left.contains("Running:")
146                || status_requires_shimmer(left));
147        let active_pty = self
148            .active_pty_sessions
149            .as_ref()
150            .map(|counter| counter.load(Ordering::Relaxed) > 0)
151            .unwrap_or(false);
152        running_status || active_pty
153    }
154
155    pub(crate) fn has_status_spinner(&self) -> bool {
156        if !self.appearance.should_animate_progress_status() {
157            return false;
158        }
159        let Some(left) = self.input_status_left.as_deref() else {
160            return false;
161        };
162        status_requires_shimmer(left)
163    }
164
165    pub(super) fn is_shimmer_active(&self) -> bool {
166        self.has_status_spinner()
167    }
168
169    pub(crate) fn use_steady_cursor(&self) -> bool {
170        if !self.appearance.should_animate_progress_status() {
171            self.scroll_cursor_steady_until.is_some()
172        } else {
173            self.is_shimmer_active() || self.scroll_cursor_steady_until.is_some()
174        }
175    }
176
177    pub(super) fn mark_scrolling(&mut self) {
178        let steady_duration = Duration::from_millis(ui::TUI_SCROLL_CURSOR_STEADY_MS);
179        if steady_duration.is_zero() {
180            self.scroll_cursor_steady_until = None;
181        } else {
182            self.scroll_cursor_steady_until = Some(Instant::now() + steady_duration);
183        }
184    }
185
186    /// Mark a specific line as dirty to optimize reflow scans
187    pub(crate) fn mark_line_dirty(&mut self, index: usize) {
188        self.first_dirty_line = match self.first_dirty_line {
189            Some(current) => Some(current.min(index)),
190            None => Some(index),
191        };
192        self.mark_dirty();
193    }
194
195    /// Ensure the prompt style has a color set
196    pub(super) fn ensure_prompt_style_color(&mut self) {
197        if self.prompt_style.color.is_none() {
198            self.prompt_style.color = self.theme.primary.or(self.theme.foreground);
199        }
200    }
201
202    /// Clear the screen and reset scroll
203    pub(super) fn clear_screen(&mut self) {
204        self.lines.clear();
205        self.collapsed_pastes.clear();
206        self.user_scrolled = false;
207        self.scroll_manager.set_offset(0);
208        self.invalidate_transcript_cache();
209        self.invalidate_scroll_metrics();
210        self.needs_full_clear = true;
211        self.mark_dirty();
212    }
213
214    /// Toggle logs panel visibility
215    pub(super) fn toggle_logs(&mut self) {
216        self.show_logs = !self.show_logs;
217        self.invalidate_scroll_metrics();
218        self.mark_dirty();
219    }
220
221    /// Show a simple modal dialog
222    pub(super) fn show_modal(
223        &mut self,
224        title: String,
225        lines: Vec<String>,
226        secure_prompt: Option<super::super::types::SecurePromptConfig>,
227    ) {
228        self.show_overlay(OverlayRequest::Modal(ModalOverlayRequest {
229            title,
230            lines,
231            secure_prompt,
232        }));
233    }
234
235    pub(super) fn show_overlay(&mut self, request: OverlayRequest) {
236        if self.has_active_overlay() {
237            self.overlay_queue.push_back(request);
238            self.mark_dirty();
239            return;
240        }
241        self.activate_overlay(request);
242    }
243
244    pub(crate) fn has_active_overlay(&self) -> bool {
245        self.active_overlay.is_some()
246    }
247
248    pub(crate) fn modal_state(&self) -> Option<&ModalState> {
249        self.active_overlay.as_ref().and_then(ActiveOverlay::as_modal)
250    }
251
252    pub(crate) fn modal_state_mut(&mut self) -> Option<&mut ModalState> {
253        self.active_overlay
254            .as_mut()
255            .and_then(ActiveOverlay::as_modal_mut)
256    }
257
258    pub(crate) fn wizard_overlay(&self) -> Option<&WizardModalState> {
259        self.active_overlay.as_ref().and_then(ActiveOverlay::as_wizard)
260    }
261
262    pub(crate) fn wizard_overlay_mut(&mut self) -> Option<&mut WizardModalState> {
263        self.active_overlay
264            .as_mut()
265            .and_then(ActiveOverlay::as_wizard_mut)
266    }
267
268    pub(crate) fn diff_preview_state(&self) -> Option<&DiffPreviewState> {
269        self.active_overlay.as_ref().and_then(ActiveOverlay::as_diff)
270    }
271
272    pub(crate) fn diff_preview_state_mut(&mut self) -> Option<&mut DiffPreviewState> {
273        self.active_overlay
274            .as_mut()
275            .and_then(ActiveOverlay::as_diff_mut)
276    }
277
278    pub(crate) fn modal_overlay_active(&self) -> bool {
279        self.active_overlay
280            .as_ref()
281            .is_some_and(ActiveOverlay::is_modal_like)
282    }
283
284    pub(crate) fn take_modal_state(&mut self) -> Option<ModalState> {
285        if !self
286            .active_overlay
287            .as_ref()
288            .is_some_and(|overlay| matches!(overlay, ActiveOverlay::Modal(_)))
289        {
290            return None;
291        }
292
293        match self.active_overlay.take() {
294            Some(ActiveOverlay::Modal(state)) => Some(*state),
295            Some(ActiveOverlay::Wizard(_) | ActiveOverlay::Diff(_)) | None => None,
296        }
297    }
298
299    fn activate_overlay(&mut self, request: OverlayRequest) {
300        match request {
301            OverlayRequest::Modal(request) => self.activate_modal_overlay(request),
302            OverlayRequest::List(request) => self.activate_list_overlay(request),
303            OverlayRequest::Wizard(request) => self.activate_wizard_overlay(request),
304            OverlayRequest::Diff(request) => self.activate_diff_overlay(request),
305        }
306    }
307
308    pub(super) fn close_overlay(&mut self) {
309        let Some(state) = self.active_overlay.take() else {
310            return;
311        };
312
313        self.input_enabled = state.restore_input();
314        self.cursor_visible = state.restore_cursor();
315
316        if let Some(next_request) = self.overlay_queue.pop_front() {
317            self.activate_overlay(next_request);
318            return;
319        }
320
321        self.mark_dirty();
322    }
323
324    fn activate_modal_overlay(&mut self, request: ModalOverlayRequest) {
325        let state = ModalState {
326            title: request.title,
327            lines: request.lines,
328            footer_hint: None,
329            hotkeys: Vec::new(),
330            list: None,
331            search: None,
332            secure_prompt: request.secure_prompt,
333            restore_input: true,
334            restore_cursor: true,
335        };
336        if state.secure_prompt.is_none() {
337            self.input_enabled = false;
338        }
339        self.cursor_visible = false;
340        self.active_overlay = Some(ActiveOverlay::Modal(Box::new(state)));
341        self.mark_dirty();
342    }
343
344    fn activate_list_overlay(&mut self, request: ListOverlayRequest) {
345        self.ensure_inline_lists_visible_for_trigger();
346        let mut list_state = ModalListState::new(request.items, request.selected.clone());
347        let search_state = request.search.map(ModalSearchState::from);
348        if let Some(search) = &search_state {
349            list_state.apply_search_with_preference(&search.query, request.selected);
350        }
351        let state = ModalState {
352            title: request.title,
353            lines: request.lines,
354            footer_hint: request.footer_hint,
355            hotkeys: request.hotkeys,
356            list: Some(list_state),
357            search: search_state,
358            secure_prompt: None,
359            restore_input: true,
360            restore_cursor: true,
361        };
362        self.input_enabled = false;
363        self.cursor_visible = false;
364        self.active_overlay = Some(ActiveOverlay::Modal(Box::new(state)));
365        self.mark_dirty();
366    }
367
368    fn activate_wizard_overlay(&mut self, request: WizardOverlayRequest) {
369        self.ensure_inline_lists_visible_for_trigger();
370        let wizard = WizardModalState::new(
371            request.title,
372            request.steps,
373            request.current_step,
374            request.search,
375            request.mode,
376        );
377        self.active_overlay = Some(ActiveOverlay::Wizard(Box::new(wizard)));
378        self.input_enabled = false;
379        self.cursor_visible = false;
380        self.mark_dirty();
381    }
382
383    fn activate_diff_overlay(&mut self, request: DiffOverlayRequest) {
384        let mut state = DiffPreviewState::new(
385            request.file_path,
386            request.before,
387            request.after,
388            request.hunks,
389        );
390        state.current_hunk = request.current_hunk;
391        self.active_overlay = Some(ActiveOverlay::Diff(Box::new(state)));
392        self.input_enabled = false;
393        self.cursor_visible = false;
394        self.mark_dirty();
395    }
396
397    /// Scroll operations
398    ///
399    /// Note: The scroll offset model is inverted for chat-style display:
400    /// offset=0 shows the bottom (newest content), offset=max shows the top.
401    /// Therefore "scroll up" (show older content) increases the offset, and
402    /// "scroll down" (show newer content) decreases it.
403    pub fn scroll_line_up(&mut self) {
404        self.mark_scrolling();
405        let previous_offset = self.scroll_manager.offset();
406        self.scroll_manager.scroll_down(1);
407        if self.scroll_manager.offset() != previous_offset {
408            self.user_scrolled = self.scroll_manager.offset() != 0;
409            self.visible_lines_cache = None;
410        }
411    }
412
413    pub fn scroll_line_down(&mut self) {
414        self.mark_scrolling();
415        let previous_offset = self.scroll_manager.offset();
416        self.scroll_manager.scroll_up(1);
417        if self.scroll_manager.offset() != previous_offset {
418            self.user_scrolled = self.scroll_manager.offset() != 0;
419            self.visible_lines_cache = None;
420        }
421    }
422
423    pub(super) fn scroll_page_up(&mut self) {
424        self.mark_scrolling();
425        let previous_offset = self.scroll_manager.offset();
426        self.scroll_manager
427            .scroll_down(self.viewport_height().max(1));
428        if self.scroll_manager.offset() != previous_offset {
429            self.user_scrolled = self.scroll_manager.offset() != 0;
430            self.visible_lines_cache = None;
431        }
432    }
433
434    pub(super) fn scroll_page_down(&mut self) {
435        self.mark_scrolling();
436        let page = self.viewport_height().max(1);
437        let previous_offset = self.scroll_manager.offset();
438        self.scroll_manager.scroll_up(page);
439        if self.scroll_manager.offset() != previous_offset {
440            self.user_scrolled = self.scroll_manager.offset() != 0;
441            self.visible_lines_cache = None;
442        }
443    }
444
445    pub(crate) fn viewport_height(&self) -> usize {
446        self.transcript_rows.max(1) as usize
447    }
448
449    /// Apply coalesced scroll from accumulated scroll events
450    /// This is more efficient than calling scroll_line_up/down multiple times
451    pub(crate) fn apply_coalesced_scroll(&mut self, line_delta: i32, page_delta: i32) {
452        self.mark_scrolling();
453        let previous_offset = self.scroll_manager.offset();
454
455        // Apply page scroll first (larger movements)
456        // Inverted offset model: positive delta = scroll down visually = decrease offset
457        if page_delta != 0 {
458            let page_size = self.viewport_height().max(1);
459            if page_delta > 0 {
460                self.scroll_manager
461                    .scroll_up(page_size * page_delta.unsigned_abs() as usize);
462            } else {
463                self.scroll_manager
464                    .scroll_down(page_size * page_delta.unsigned_abs() as usize);
465            }
466        }
467
468        // Then apply line scroll
469        if line_delta != 0 {
470            if line_delta > 0 {
471                self.scroll_manager
472                    .scroll_up(line_delta.unsigned_abs() as usize);
473            } else {
474                self.scroll_manager
475                    .scroll_down(line_delta.unsigned_abs() as usize);
476            }
477        }
478
479        // Invalidate visible lines cache if offset actually changed
480        if self.scroll_manager.offset() != previous_offset {
481            self.visible_lines_cache = None;
482        }
483    }
484
485    /// Invalidate scroll metrics to force recalculation
486    pub(super) fn invalidate_scroll_metrics(&mut self) {
487        self.scroll_manager.invalidate_metrics();
488        self.invalidate_transcript_cache();
489    }
490
491    /// Invalidate the transcript cache
492    pub(super) fn invalidate_transcript_cache(&mut self) {
493        if let Some(cache) = self.transcript_cache.as_mut() {
494            cache.invalidate_content();
495        }
496        self.visible_lines_cache = None;
497        self.transcript_content_changed = true;
498
499        // If no specific line was marked dirty, assume everything needs reflow
500        if self.first_dirty_line.is_none() {
501            self.first_dirty_line = Some(0);
502        }
503    }
504
505    /// Get the current maximum scroll offset
506    pub(super) fn current_max_scroll_offset(&mut self) -> usize {
507        self.ensure_scroll_metrics();
508        self.scroll_manager.max_offset()
509    }
510
511    /// Enforce scroll bounds after viewport changes
512    pub(super) fn enforce_scroll_bounds(&mut self) {
513        let max_offset = self.current_max_scroll_offset();
514        if self.scroll_manager.offset() > max_offset {
515            self.scroll_manager.set_offset(max_offset);
516        }
517    }
518
519    /// Ensure scroll metrics are up to date
520    pub(super) fn ensure_scroll_metrics(&mut self) {
521        if self.scroll_manager.metrics_valid() {
522            return;
523        }
524
525        let viewport_rows = self.viewport_height();
526        if self.transcript_width == 0 || viewport_rows == 0 {
527            self.scroll_manager.set_total_rows(0);
528            return;
529        }
530
531        let padding = usize::from(ui::INLINE_TRANSCRIPT_BOTTOM_PADDING);
532        let effective_padding = padding.min(viewport_rows.saturating_sub(1));
533        let total_rows = self.total_transcript_rows(self.transcript_width) + effective_padding;
534        self.scroll_manager.set_total_rows(total_rows);
535    }
536
537    /// Prepare transcript scroll parameters
538    pub(crate) fn prepare_transcript_scroll(
539        &mut self,
540        total_rows: usize,
541        viewport_rows: usize,
542    ) -> (usize, usize) {
543        let viewport = viewport_rows.max(1);
544        let clamped_total = total_rows.max(1);
545        self.scroll_manager.set_total_rows(clamped_total);
546        self.scroll_manager.set_viewport_rows(viewport as u16);
547        let max_offset = self.scroll_manager.max_offset();
548
549        if self.scroll_manager.offset() > max_offset {
550            self.scroll_manager.set_offset(max_offset);
551        }
552
553        let top_offset = max_offset.saturating_sub(self.scroll_manager.offset());
554        (top_offset, clamped_total)
555    }
556
557    /// Adjust scroll position after content changes
558    pub(super) fn adjust_scroll_after_change(&mut self, previous_max_offset: usize) {
559        use std::cmp::min;
560
561        let new_max_offset = self.current_max_scroll_offset();
562        let current_offset = self.scroll_manager.offset();
563
564        if current_offset >= previous_max_offset && new_max_offset > previous_max_offset {
565            self.scroll_manager.set_offset(new_max_offset);
566        } else if current_offset > 0 && new_max_offset > previous_max_offset {
567            let delta = new_max_offset - previous_max_offset;
568            self.scroll_manager
569                .set_offset(min(current_offset + delta, new_max_offset));
570        }
571        self.enforce_scroll_bounds();
572    }
573
574    /// Emit an inline event through the channel and callback
575    #[inline]
576    pub(super) fn emit_inline_event(
577        &self,
578        event: &InlineEvent,
579        events: &UnboundedSender<InlineEvent>,
580        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
581    ) {
582        if let Some(cb) = callback {
583            cb(event);
584        }
585        let _ = events.send(event.clone());
586    }
587
588    /// Handle scroll down event
589    #[inline]
590    #[allow(dead_code)]
591    pub(super) fn handle_scroll_down(
592        &mut self,
593        events: &UnboundedSender<InlineEvent>,
594        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
595    ) {
596        self.scroll_line_down();
597        self.mark_dirty();
598        self.emit_inline_event(&InlineEvent::ScrollLineDown, events, callback);
599    }
600
601    /// Handle scroll up event
602    #[inline]
603    #[allow(dead_code)]
604    pub(super) fn handle_scroll_up(
605        &mut self,
606        events: &UnboundedSender<InlineEvent>,
607        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
608    ) {
609        self.scroll_line_up();
610        self.mark_dirty();
611        self.emit_inline_event(&InlineEvent::ScrollLineUp, events, callback);
612    }
613}