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
250            .as_ref()
251            .and_then(ActiveOverlay::as_modal)
252    }
253
254    pub(crate) fn modal_state_mut(&mut self) -> Option<&mut ModalState> {
255        self.active_overlay
256            .as_mut()
257            .and_then(ActiveOverlay::as_modal_mut)
258    }
259
260    pub(crate) fn wizard_overlay(&self) -> Option<&WizardModalState> {
261        self.active_overlay
262            .as_ref()
263            .and_then(ActiveOverlay::as_wizard)
264    }
265
266    pub(crate) fn wizard_overlay_mut(&mut self) -> Option<&mut WizardModalState> {
267        self.active_overlay
268            .as_mut()
269            .and_then(ActiveOverlay::as_wizard_mut)
270    }
271
272    pub(crate) fn diff_preview_state(&self) -> Option<&DiffPreviewState> {
273        self.active_overlay
274            .as_ref()
275            .and_then(ActiveOverlay::as_diff)
276    }
277
278    pub(crate) fn diff_preview_state_mut(&mut self) -> Option<&mut DiffPreviewState> {
279        self.active_overlay
280            .as_mut()
281            .and_then(ActiveOverlay::as_diff_mut)
282    }
283
284    pub(crate) fn modal_overlay_active(&self) -> bool {
285        self.active_overlay
286            .as_ref()
287            .is_some_and(ActiveOverlay::is_modal_like)
288    }
289
290    pub(crate) fn take_modal_state(&mut self) -> Option<ModalState> {
291        if !self
292            .active_overlay
293            .as_ref()
294            .is_some_and(|overlay| matches!(overlay, ActiveOverlay::Modal(_)))
295        {
296            return None;
297        }
298
299        match self.active_overlay.take() {
300            Some(ActiveOverlay::Modal(state)) => Some(*state),
301            Some(ActiveOverlay::Wizard(_) | ActiveOverlay::Diff(_)) | None => None,
302        }
303    }
304
305    fn activate_overlay(&mut self, request: OverlayRequest) {
306        match request {
307            OverlayRequest::Modal(request) => self.activate_modal_overlay(request),
308            OverlayRequest::List(request) => self.activate_list_overlay(request),
309            OverlayRequest::Wizard(request) => self.activate_wizard_overlay(request),
310            OverlayRequest::Diff(request) => self.activate_diff_overlay(request),
311        }
312    }
313
314    pub(super) fn close_overlay(&mut self) {
315        let Some(state) = self.active_overlay.take() else {
316            return;
317        };
318
319        self.input_enabled = state.restore_input();
320        self.cursor_visible = state.restore_cursor();
321
322        if let Some(next_request) = self.overlay_queue.pop_front() {
323            self.activate_overlay(next_request);
324            return;
325        }
326
327        self.mark_dirty();
328    }
329
330    fn activate_modal_overlay(&mut self, request: ModalOverlayRequest) {
331        let state = ModalState {
332            title: request.title,
333            lines: request.lines,
334            footer_hint: None,
335            hotkeys: Vec::new(),
336            list: None,
337            search: None,
338            secure_prompt: request.secure_prompt,
339            restore_input: true,
340            restore_cursor: true,
341        };
342        if state.secure_prompt.is_none() {
343            self.input_enabled = false;
344        }
345        self.cursor_visible = false;
346        self.active_overlay = Some(ActiveOverlay::Modal(Box::new(state)));
347        self.mark_dirty();
348    }
349
350    fn activate_list_overlay(&mut self, request: ListOverlayRequest) {
351        self.ensure_inline_lists_visible_for_trigger();
352        let mut list_state = ModalListState::new(request.items, request.selected.clone());
353        let search_state = request.search.map(ModalSearchState::from);
354        if let Some(search) = &search_state {
355            list_state.apply_search_with_preference(&search.query, request.selected);
356        }
357        let state = ModalState {
358            title: request.title,
359            lines: request.lines,
360            footer_hint: request.footer_hint,
361            hotkeys: request.hotkeys,
362            list: Some(list_state),
363            search: search_state,
364            secure_prompt: None,
365            restore_input: true,
366            restore_cursor: true,
367        };
368        self.input_enabled = false;
369        self.cursor_visible = false;
370        self.active_overlay = Some(ActiveOverlay::Modal(Box::new(state)));
371        self.mark_dirty();
372    }
373
374    fn activate_wizard_overlay(&mut self, request: WizardOverlayRequest) {
375        self.ensure_inline_lists_visible_for_trigger();
376        let wizard = WizardModalState::new(
377            request.title,
378            request.steps,
379            request.current_step,
380            request.search,
381            request.mode,
382        );
383        self.active_overlay = Some(ActiveOverlay::Wizard(Box::new(wizard)));
384        self.input_enabled = false;
385        self.cursor_visible = false;
386        self.mark_dirty();
387    }
388
389    fn activate_diff_overlay(&mut self, request: DiffOverlayRequest) {
390        let mut state = DiffPreviewState::new(
391            request.file_path,
392            request.before,
393            request.after,
394            request.hunks,
395        );
396        state.current_hunk = request.current_hunk;
397        self.active_overlay = Some(ActiveOverlay::Diff(Box::new(state)));
398        self.input_enabled = false;
399        self.cursor_visible = false;
400        self.mark_dirty();
401    }
402
403    /// Scroll operations
404    ///
405    /// Note: The scroll offset model is inverted for chat-style display:
406    /// offset=0 shows the bottom (newest content), offset=max shows the top.
407    /// Therefore "scroll up" (show older content) increases the offset, and
408    /// "scroll down" (show newer content) decreases it.
409    pub fn scroll_line_up(&mut self) {
410        self.mark_scrolling();
411        let previous_offset = self.scroll_manager.offset();
412        self.scroll_manager.scroll_down(1);
413        if self.scroll_manager.offset() != previous_offset {
414            self.user_scrolled = self.scroll_manager.offset() != 0;
415            self.visible_lines_cache = None;
416        }
417    }
418
419    pub fn scroll_line_down(&mut self) {
420        self.mark_scrolling();
421        let previous_offset = self.scroll_manager.offset();
422        self.scroll_manager.scroll_up(1);
423        if self.scroll_manager.offset() != previous_offset {
424            self.user_scrolled = self.scroll_manager.offset() != 0;
425            self.visible_lines_cache = None;
426        }
427    }
428
429    pub(super) fn scroll_page_up(&mut self) {
430        self.mark_scrolling();
431        let previous_offset = self.scroll_manager.offset();
432        self.scroll_manager
433            .scroll_down(self.viewport_height().max(1));
434        if self.scroll_manager.offset() != previous_offset {
435            self.user_scrolled = self.scroll_manager.offset() != 0;
436            self.visible_lines_cache = None;
437        }
438    }
439
440    pub(super) fn scroll_page_down(&mut self) {
441        self.mark_scrolling();
442        let page = self.viewport_height().max(1);
443        let previous_offset = self.scroll_manager.offset();
444        self.scroll_manager.scroll_up(page);
445        if self.scroll_manager.offset() != previous_offset {
446            self.user_scrolled = self.scroll_manager.offset() != 0;
447            self.visible_lines_cache = None;
448        }
449    }
450
451    pub(crate) fn viewport_height(&self) -> usize {
452        self.transcript_rows.max(1) as usize
453    }
454
455    /// Apply coalesced scroll from accumulated scroll events
456    /// This is more efficient than calling scroll_line_up/down multiple times
457    pub(crate) fn apply_coalesced_scroll(&mut self, line_delta: i32, page_delta: i32) {
458        self.mark_scrolling();
459        let previous_offset = self.scroll_manager.offset();
460
461        // Apply page scroll first (larger movements)
462        // Inverted offset model: positive delta = scroll down visually = decrease offset
463        if page_delta != 0 {
464            let page_size = self.viewport_height().max(1);
465            if page_delta > 0 {
466                self.scroll_manager
467                    .scroll_up(page_size * page_delta.unsigned_abs() as usize);
468            } else {
469                self.scroll_manager
470                    .scroll_down(page_size * page_delta.unsigned_abs() as usize);
471            }
472        }
473
474        // Then apply line scroll
475        if line_delta != 0 {
476            if line_delta > 0 {
477                self.scroll_manager
478                    .scroll_up(line_delta.unsigned_abs() as usize);
479            } else {
480                self.scroll_manager
481                    .scroll_down(line_delta.unsigned_abs() as usize);
482            }
483        }
484
485        // Invalidate visible lines cache if offset actually changed
486        if self.scroll_manager.offset() != previous_offset {
487            self.visible_lines_cache = None;
488        }
489    }
490
491    /// Invalidate scroll metrics to force recalculation
492    pub(super) fn invalidate_scroll_metrics(&mut self) {
493        self.scroll_manager.invalidate_metrics();
494        self.invalidate_transcript_cache();
495    }
496
497    /// Invalidate the transcript cache
498    pub(super) fn invalidate_transcript_cache(&mut self) {
499        if let Some(cache) = self.transcript_cache.as_mut() {
500            cache.invalidate_content();
501        }
502        self.visible_lines_cache = None;
503        self.transcript_content_changed = true;
504
505        // If no specific line was marked dirty, assume everything needs reflow
506        if self.first_dirty_line.is_none() {
507            self.first_dirty_line = Some(0);
508        }
509    }
510
511    /// Get the current maximum scroll offset
512    pub(super) fn current_max_scroll_offset(&mut self) -> usize {
513        self.ensure_scroll_metrics();
514        self.scroll_manager.max_offset()
515    }
516
517    /// Enforce scroll bounds after viewport changes
518    pub(super) fn enforce_scroll_bounds(&mut self) {
519        let max_offset = self.current_max_scroll_offset();
520        if self.scroll_manager.offset() > max_offset {
521            self.scroll_manager.set_offset(max_offset);
522        }
523    }
524
525    /// Ensure scroll metrics are up to date
526    pub(super) fn ensure_scroll_metrics(&mut self) {
527        if self.scroll_manager.metrics_valid() {
528            return;
529        }
530
531        let viewport_rows = self.viewport_height();
532        if self.transcript_width == 0 || viewport_rows == 0 {
533            self.scroll_manager.set_total_rows(0);
534            return;
535        }
536
537        let padding = usize::from(ui::INLINE_TRANSCRIPT_BOTTOM_PADDING);
538        let effective_padding = padding.min(viewport_rows.saturating_sub(1));
539        let total_rows = self.total_transcript_rows(self.transcript_width) + effective_padding;
540        self.scroll_manager.set_total_rows(total_rows);
541    }
542
543    /// Prepare transcript scroll parameters
544    pub(crate) fn prepare_transcript_scroll(
545        &mut self,
546        total_rows: usize,
547        viewport_rows: usize,
548    ) -> (usize, usize) {
549        let viewport = viewport_rows.max(1);
550        let clamped_total = total_rows.max(1);
551        self.scroll_manager.set_total_rows(clamped_total);
552        self.scroll_manager.set_viewport_rows(viewport as u16);
553        let max_offset = self.scroll_manager.max_offset();
554
555        if self.scroll_manager.offset() > max_offset {
556            self.scroll_manager.set_offset(max_offset);
557        }
558
559        let top_offset = max_offset.saturating_sub(self.scroll_manager.offset());
560        (top_offset, clamped_total)
561    }
562
563    /// Adjust scroll position after content changes
564    pub(super) fn adjust_scroll_after_change(&mut self, previous_max_offset: usize) {
565        use std::cmp::min;
566
567        let new_max_offset = self.current_max_scroll_offset();
568        let current_offset = self.scroll_manager.offset();
569
570        if current_offset >= previous_max_offset && new_max_offset > previous_max_offset {
571            self.scroll_manager.set_offset(new_max_offset);
572        } else if current_offset > 0 && new_max_offset > previous_max_offset {
573            let delta = new_max_offset - previous_max_offset;
574            self.scroll_manager
575                .set_offset(min(current_offset + delta, new_max_offset));
576        }
577        self.enforce_scroll_bounds();
578    }
579
580    /// Emit an inline event through the channel and callback
581    #[inline]
582    pub(super) fn emit_inline_event(
583        &self,
584        event: &InlineEvent,
585        events: &UnboundedSender<InlineEvent>,
586        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
587    ) {
588        if let Some(cb) = callback {
589            cb(event);
590        }
591        let _ = events.send(event.clone());
592    }
593
594    /// Handle scroll down event
595    #[inline]
596    #[allow(dead_code)]
597    pub(super) fn handle_scroll_down(
598        &mut self,
599        events: &UnboundedSender<InlineEvent>,
600        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
601    ) {
602        self.scroll_line_down();
603        self.mark_dirty();
604        self.emit_inline_event(&InlineEvent::ScrollLineDown, events, callback);
605    }
606
607    /// Handle scroll up event
608    #[inline]
609    #[allow(dead_code)]
610    pub(super) fn handle_scroll_up(
611        &mut self,
612        events: &UnboundedSender<InlineEvent>,
613        callback: Option<&(dyn Fn(&InlineEvent) + Send + Sync + 'static)>,
614    ) {
615        self.scroll_line_up();
616        self.mark_dirty();
617        self.emit_inline_event(&InlineEvent::ScrollLineUp, events, callback);
618    }
619}