bcode_tui 0.0.1-alpha.0

Terminal user interface for bcode
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
//! Transcript layout projection preparation.

use bmux_tui::geometry::Rect;

use super::app::BmuxApp;
use super::pending_submission::PendingSubmission;
use super::render;
use super::transcript::TranscriptItem;
#[cfg(test)]
use super::transcript_document::TranscriptDocument;
use super::transcript_document::TranscriptItems;
use super::transcript_layout::{
    TranscriptLayoutFingerprint, TranscriptLayoutRows, TranscriptLayoutSignature,
    TranscriptLayoutSpec,
};
use bcode_config::TuiDiffViewerConfig;
use std::time::Instant;

const MAX_DIRTY_VISUALS_PER_LAYOUT_SYNC: usize = 64;

/// Prepare transcript layout and viewport projections for a frame body.
pub fn prepare_for_body(app: &mut BmuxApp, body: Rect) {
    app.begin_transcript_presentation();
    let initial_transcript_area = render::transcript_area_for_body(app, body);
    app.begin_transcript_geometry_update();
    sync_layout(app, initial_transcript_area.width);
    // Chrome is decided against the full body. A bar cannot create its own reason
    // to exist by reducing the viewport, and measurement never consumes navigation.
    let latest_bar_height =
        u16::from(app.needs_latest_bar_at_height(initial_transcript_area.height));
    let body = Rect::new(
        body.x,
        body.y,
        body.width,
        body.height.saturating_sub(latest_bar_height),
    );
    let transcript_area = render::transcript_area_for_body(app, body);
    sync_viewport(app, transcript_area);
}

#[cfg(test)]
pub fn sync_layout_for_test(app: &mut BmuxApp, width: u16) {
    sync_layout(app, width);
}

fn sync_viewport(app: &mut BmuxApp, transcript_area: Rect) {
    app.sync_transcript_scroll_max(
        max_scroll_offset(app, transcript_area),
        max_bottom_overscroll(transcript_area),
        app.transcript_layout().total_rows(),
        transcript_area.height,
    );
    app.sync_transcript_anchor_requests();
}

fn max_scroll_offset(app: &BmuxApp, area: Rect) -> usize {
    if area.is_empty() || app.transcript().is_empty() && app.pending_submissions().is_empty() {
        return 0;
    }
    app.transcript_layout()
        .total_rows()
        .saturating_sub(usize::from(area.height))
}

fn max_bottom_overscroll(area: Rect) -> usize {
    usize::from(area.height).saturating_sub(1)
}

fn transcript_item_rows(
    app: &BmuxApp,
    item: &TranscriptItem,
    input: &TranscriptLayoutInput<'_>,
) -> TranscriptLayoutRows {
    if let Some(interaction) = item.interaction()
        && !interaction.resolved
        && let Some(height) = input
            .active_interaction_layout
            .filter(|(id, _)| *id == interaction.interaction_id)
            .map(|(_, height)| height)
    {
        return TranscriptLayoutRows::BlankSpan(usize::from(height.max(1)));
    }
    let markdown = render::transcript_markdown_projection_for_layout(app, item, input.width);
    let (rows, anchors, selection) = render::transcript_item_layout_with_keymap(
        item,
        input.width,
        input.plugin_host,
        input.diff_viewer_config,
        markdown.as_deref(),
        app.effective_keymap(),
    );
    if let Some(projection) = markdown
        && matches!(
            item.kind(),
            super::transcript::TranscriptItemKind::AssistantMessage
                | super::transcript::TranscriptItemKind::UserMessage
                | super::transcript::TranscriptItemKind::System
        )
    {
        let container =
            render::TranscriptItemLayout::resolve(&app.presented_theme(), item, input.width);
        let body_start = rows.len().saturating_sub(
            projection
                .lines
                .len()
                .saturating_add(1)
                .saturating_add(container.bottom_rows()),
        );
        TranscriptLayoutRows::Markdown {
            rows,
            anchors,
            projection,
            body_start,
        }
    } else {
        TranscriptLayoutRows::Selected {
            rows,
            anchors,
            selection: selection.into_iter().collect(),
        }
    }
}

fn sync_layout(app: &mut BmuxApp, width: u16) {
    // Include asynchronous adapter/Markdown acceptance and width changes, not
    // just semantic event application, in the anchor reconciliation boundary.
    app.capture_stable_transcript_anchor();
    render::set_markdown_details_open(app.markdown_details_open());
    render::set_plugin_visual_theme(&app.presented_theme());
    let started = Instant::now();
    let elapsed_dirty_visuals =
        app.drain_elapsed_dirty_visuals_bounded(MAX_DIRTY_VISUALS_PER_LAYOUT_SYNC);
    let transcript_dirty_items = app.drain_transcript_dirty_items();
    let mut transcript_layout = std::mem::take(app.transcript_layout_mut());
    let elapsed_only;
    {
        let input = TranscriptLayoutInput::from_app(app, width);
        let fingerprint = input.fingerprint();
        let structural_fingerprint = input.structural_fingerprint();
        if transcript_layout.is_current(&fingerprint) {
            transcript_layout
                .record_cache_hit(u64::try_from(started.elapsed().as_micros()).unwrap_or(u64::MAX));
            *app.transcript_layout_mut() = transcript_layout;
            return;
        }
        let mut dirty_visuals =
            input
                .plugin_host
                .map_or_else(std::collections::BTreeSet::new, |host| {
                    host.drain_dirty_visuals_bounded(
                        MAX_DIRTY_VISUALS_PER_LAYOUT_SYNC
                            .saturating_sub(elapsed_dirty_visuals.len()),
                    )
                });
        elapsed_only = elapsed_dirty_visuals
            .difference(&dirty_visuals)
            .filter(|invocation| {
                !transcript_dirty_items.iter().any(|&index| {
                    input.transcript[index].visual_invocation_id() == Some(invocation.as_str())
                })
            })
            .cloned()
            .collect();
        dirty_visuals.extend(elapsed_dirty_visuals);
        if (!dirty_visuals.is_empty() || !transcript_dirty_items.is_empty())
            && transcript_layout.structure_is_current(&structural_fingerprint)
        {
            if !transcript_dirty_items.is_empty() {
                transcript_layout.sync_transcript_entries(
                    fingerprint.clone(),
                    &transcript_dirty_items,
                    |index| transcript_item_signature(&input.transcript[index], &input),
                    |index| transcript_item_rows(app, &input.transcript[index], &input),
                );
            }
            if !dirty_visuals.is_empty() {
                transcript_layout.sync_visuals(
                    fingerprint,
                    &dirty_visuals,
                    |index| transcript_item_signature(&input.transcript[index], &input),
                    |index| transcript_item_rows(app, &input.transcript[index], &input),
                );
            }
            transcript_layout.suppress_visual_content_changes(&elapsed_only);
            *app.transcript_layout_mut() = transcript_layout;
            return;
        }
        transcript_layout.sync(TranscriptLayoutSpec {
            width,
            fingerprint,
            structural_fingerprint,
            transcript_len: input.transcript.len(),
            pending_len: input.pending.len(),
            transcript_signature: |index| {
                transcript_item_signature(&input.transcript[index], &input)
            },
            transcript_rows: |index| transcript_item_rows(app, &input.transcript[index], &input),
            transcript_invocation_id: |index: usize| {
                input.transcript[index]
                    .visual_invocation_id()
                    .map(ToOwned::to_owned)
            },
            pending_signature: |index| {
                render::pending_submission_signature(&input.pending[index], width)
            },
            pending_rows: |index| {
                render::pending_submission_rows(&input.pending[index], width).into()
            },
            history_banner_signature: || {
                render::history_banner_text(input.has_older_history, input.loading_older_history)
                    .map(|text| TranscriptLayoutSignature::new(format!("history:{width}:{text}")))
            },
            history_banner_rows: || {
                render::history_banner_rows(input.has_older_history, input.loading_older_history)
                    .into()
            },
            reset: || false,
        });
    }
    transcript_layout.suppress_visual_content_changes(&elapsed_only);
    *app.transcript_layout_mut() = transcript_layout;
}

struct TranscriptLayoutInput<'a> {
    width: u16,
    transcript: TranscriptItems<'a>,
    plugin_host: Option<&'a crate::plugin_tui::PluginTuiPresentation>,
    diff_viewer_config: TuiDiffViewerConfig,
    pending: &'a [PendingSubmission],
    elapsed_layout_revision: u64,
    transcript_projection_revision: u64,
    active_interaction_layout: Option<(&'a str, u16)>,
    markdown_presentation_revision: u64,
    pending_submissions_projection_revision: u64,
    theme_fingerprint: u64,
    has_older_history: bool,
    loading_older_history: bool,
}

impl<'a> TranscriptLayoutInput<'a> {
    fn from_app(app: &'a BmuxApp, width: u16) -> Self {
        Self {
            width,
            transcript: app.transcript(),
            plugin_host: app.plugin_presentation(),
            diff_viewer_config: app.effective_diff_viewer_config(),
            pending: app.pending_submissions(),
            elapsed_layout_revision: app.elapsed_layout_revision(),
            transcript_projection_revision: app.transcript_projection_revision(),
            active_interaction_layout: app.active_interaction_layout(),
            markdown_presentation_revision: app.markdown_presentation_revision(),
            pending_submissions_projection_revision: app.pending_submissions_projection_revision(),
            theme_fingerprint: app.presented_theme().fingerprint,
            has_older_history: app.has_older_history(),
            loading_older_history: app.loading_older_history(),
        }
    }

    fn fingerprint(&self) -> TranscriptLayoutFingerprint {
        let presentation = self.plugin_host.map_or_else(
            || "none".to_owned(),
            |host| {
                format!(
                    "{}:{}:{}",
                    std::ptr::from_ref(host).addr(),
                    host.revision(),
                    host.visual_generation()
                )
            },
        );
        TranscriptLayoutFingerprint::new(format!(
            "{};transcript-rev:{};elapsed-rev:{};visual-generation:{presentation}",
            self.structural_fingerprint().as_str(),
            self.transcript_projection_revision,
            self.elapsed_layout_revision
        ))
    }

    fn structural_fingerprint(&self) -> TranscriptLayoutFingerprint {
        let presentation = self.plugin_host.map_or_else(
            || "none".to_owned(),
            |host| format!("{}:{}", std::ptr::from_ref(host).addr(), host.revision()),
        );
        TranscriptLayoutFingerprint::new(format!(
            "width:{};diff:{:?};theme:{};history:{}:{};presentation:{presentation};markdown-presentation-rev:{};transcript-len:{};pending-rev:{};pending-len:{}",
            self.width,
            self.diff_viewer_config,
            self.theme_fingerprint,
            self.has_older_history,
            self.loading_older_history,
            self.markdown_presentation_revision,
            self.transcript.len(),
            self.pending_submissions_projection_revision,
            self.pending.len()
        ))
    }
}

#[cfg(test)]
#[must_use]
pub fn test_layout_signature(
    item: &TranscriptItem,
    width: u16,
    plugin_host: Option<&crate::plugin_tui::PluginTuiPresentation>,
) -> TranscriptLayoutSignature {
    let mut transcript = TranscriptDocument::default();
    transcript.push_ephemeral("test".to_owned(), item.clone());
    let pending = [];
    let input = TranscriptLayoutInput {
        width,
        transcript: transcript.items(),
        plugin_host,
        diff_viewer_config: TuiDiffViewerConfig::default(),
        pending: &pending,
        elapsed_layout_revision: 0,
        transcript_projection_revision: 0,
        active_interaction_layout: None,
        markdown_presentation_revision: 0,
        pending_submissions_projection_revision: 0,
        theme_fingerprint: 0,
        has_older_history: false,
        loading_older_history: false,
    };
    transcript_item_signature(item, &input)
}

#[cfg(test)]
#[must_use]
pub fn test_layout_signature_with_interaction_height(
    item: &TranscriptItem,
    width: u16,
    interaction_id: &str,
    height: u16,
) -> TranscriptLayoutSignature {
    let mut transcript = TranscriptDocument::default();
    transcript.push_ephemeral("test".to_owned(), item.clone());
    let pending = [];
    let input = TranscriptLayoutInput {
        width,
        transcript: transcript.items(),
        plugin_host: None,
        diff_viewer_config: TuiDiffViewerConfig::default(),
        pending: &pending,
        elapsed_layout_revision: 0,
        transcript_projection_revision: 0,
        active_interaction_layout: Some((interaction_id, height)),
        markdown_presentation_revision: 0,
        pending_submissions_projection_revision: 0,
        theme_fingerprint: 0,
        has_older_history: false,
        loading_older_history: false,
    };
    transcript_item_signature(item, &input)
}

#[cfg(test)]
#[must_use]
pub fn test_layout_signature_with_theme(
    item: &TranscriptItem,
    width: u16,
    theme_fingerprint: u64,
) -> TranscriptLayoutSignature {
    let mut transcript = TranscriptDocument::default();
    transcript.push_ephemeral("test".to_owned(), item.clone());
    let pending = [];
    let input = TranscriptLayoutInput {
        width,
        transcript: transcript.items(),
        plugin_host: None,
        diff_viewer_config: TuiDiffViewerConfig::default(),
        pending: &pending,
        elapsed_layout_revision: 0,
        transcript_projection_revision: 0,
        active_interaction_layout: None,
        markdown_presentation_revision: 0,
        pending_submissions_projection_revision: 0,
        theme_fingerprint,
        has_older_history: false,
        loading_older_history: false,
    };
    transcript_item_signature(item, &input)
}

#[cfg(test)]
#[test]
fn theme_fingerprint_changes_versioned_transcript_layout_signature_exactly() {
    let item = TranscriptItem::with_format(
        "Bcode",
        "# themed markdown".to_owned(),
        bcode_session_view_models::TextFormat::Markdown,
    );
    let first = test_layout_signature_with_theme(&item, 80, 11);
    let repeated = test_layout_signature_with_theme(&item, 80, 11);
    let changed = test_layout_signature_with_theme(&item, 80, 12);

    assert_eq!(first, repeated);
    assert_ne!(first, changed);
    assert!(first.as_str().contains("theme:11"));
    assert!(changed.as_str().contains("theme:12"));
}

fn transcript_item_signature(
    item: &TranscriptItem,
    input: &TranscriptLayoutInput<'_>,
) -> TranscriptLayoutSignature {
    let base = render::transcript_item_signature(item, input.width, ());
    let presentation_generation = input.plugin_host.map_or_else(
        || "none".to_owned(),
        |host| format!("{}:{}", std::ptr::from_ref(host).addr(), host.revision()),
    );
    let visual_revision = item.visual_invocation_id().map_or(0, |invocation_id| {
        input
            .plugin_host
            .map_or(0, |host| host.visual_revision(invocation_id))
    });
    let interaction_layout = item.interaction().and_then(|interaction| {
        input
            .active_interaction_layout
            .filter(|(id, _)| *id == interaction.interaction_id)
            .map(|(id, height)| format!("{id}:{height}"))
    });
    TranscriptLayoutSignature::new(format!(
        "{};theme:{};presentation-generation:{presentation_generation};visual-rev:{visual_revision};interaction-layout:{}",
        base.as_str(),
        input.theme_fingerprint,
        interaction_layout.as_deref().unwrap_or("none")
    ))
}