25 KiB
Bottom panel Stage 2 — the GPU panel band (framing)
Revision 2 — pre-implementation. Ground truth: canonical main @
d152120, protocol v20, 2026-07-25.
Stage 1 (#155, merge e745068) gave pmacs window placement, window
parameters, TUI side windows, the divider, and the adopter display
opt-in. It deliberately set FrontendView::panel_capable = false for
every semantic session, so a GPU frontend silently falls back to the
non-side target. Stage 2 flips that bit, under an exact negotiated
rule, and earns the right to.
This document is the re-framing docs/bottom-panel-framing.md (rev 4)
§2 requires before Stage 2 is implemented. It does not restate the
parent's decisions or replace its acceptance criteria. It records the
re-scout against current main, closes the four scout obligations
review round 1 required, and fixes what round 1 found wrong.
Inherited reading, all of which remains authoritative: parent
Q#BP8 (the band), Q#BP9 (protocol), Q#BP14 (the primary-document
projection contract and its census classification), Q#BP14a (panel
input gating is per-window), Q#BP14b (focus chrome and per-window
overlay routing), Q#BP15 (PanelFrame lifecycle), Q#BP15a (three
geometries), Q#BP16 (pointer transport), Q#BP17 (fold projection), and
parent acceptance criteria 37–55.
0. Revision history
0.1 Round 1 (rev 1 → rev 2) — 2 blocking, 3 high, 3 revision points, all closed
- R1-1 (blocker). Rev 1 said all 23 census reads route through
primary_document_window. That contradicts Q#BP14, which routes only the Projection class (#1–#12, #21–#22) that way and leaves focus, input, chrome, and bell consumers on their own authorities. Rev 1's rule would have broken remote-op validation,DispatchIdle, presence, focused search/menu/completion routing, and bell ownership. §3.2 now restores all four classes; §7's criterion pins them separately. The inherited-reading list above gains Q#BP14 and Q#BP14a. - R1-2 (blocker). Rev 1 treated the three
src/statusline.rsactive reads as one disposition. Only:644selects the wrong window;:629and:675must keep tracking actual focus. §3.3 is rewritten and the criterion states the required behavior instead of routing focus away. - R1-3 (high). The
panel_capableflip needed an exact attach rule, not "for semantic sessions". §3.5 states it: v21-or-later negotiated authenticated semantic session only. - R1-4 (high). Option 1 accepted, but the epoch needed a state machine, split APIs, and a fail-closed allocator. §3.1 now carries the transition table and the API split. Rev 1's phrasing "rejects a lower-or-equal epoch carrying different data" was itself wrong — a lower epoch carrying identical data is still stale.
- R1-5 (high). Rev 1's eleven draft criteria silently omitted
parent 37–55. §7 now declares the parent list authoritative, maps it
to 2A/2B, and adds only refinements. The painter-extraction criterion
pins cursor,
view_top, and passive-window state, not just cells. - R1-6. All four scout obligations are closed in §5.
- R1-7. The coherence statement understated journey impact and overclaimed on background work. §6 names journey steps 7–10 and narrows the §9 claim.
- R1-8. Factual corrections in §1 and §3.2.
1. Anchor re-scout
| Parent anchor | Now at | Verdict |
|---|---|---|
paint_frame returns cursor separately (editor.rs:2833) |
src/editor.rs:3171 |
Holds |
Cursor-visible prep (editor.rs:2883-2935) |
src/editor.rs:3249+ |
Holds; Stage 1 inserted work above it (§2) |
Per-window paint body (editor.rs:2937-3040) |
after src/editor.rs:3260 |
Holds |
fold_map_for_window gates on the active frontend (editor_core.rs:566) |
src/editor_core.rs:734, gate at :738 |
Holds |
Stale "semantic session never enters paint_frame" (window.rs:339) |
src/window.rs:562 |
Holds, still stale; now embedded in a longer fold_projection doc block, so the edit is a paragraph rewrite |
Mouse is contractually the grid path (daemon.rs:3122-3130) |
src/daemon.rs:3123 |
Holds |
Permanent 24×80 placeholder (attach.rs:420-429, :573-577) |
pmacs-gpu/src/attach.rs:577, single site |
Holds |
Byte pin InstanceMessage::InitialTargetResult |
pmacs-protocol/src/message.rs:1145 |
Holds — still the enum's final variant |
Byte pin FrontendEvent::TerminalPointer |
final variant of its enum | Holds |
Protocol is still v20 (pmacs-protocol/src/message.rs:1568); no
intervening PR bumped it. Q#BP9's conditional resolves: Stage 2 is
v21, no reservation was taken and none was needed.
Fifteen PRs merged between the parent's last re-scout (47581f4) and
this one: #149, #150, #152–#155, #158–#166. Nothing in the parent's
mechanical model was falsified by any of them.
2. What Stage 1 already built for Stage 2
DeclaredFrameGeometry { geometry_epoch: u64, total: CellSize }(src/window.rs:522-528), held asFrontendView::frame_geometry: Option<_>(:589) whereNonemeans unknown — Q#BP15a's "unknown is first-class", already landed.EditorState::sync_frame_geometry(src/editor.rs:877-882) →declare_frame_geometry+reconcile_panel_layout, driven from two daemon sites gated onpanel_capable_for(src/daemon.rs:1882-1883attach,:1972-1973resize).paint_framedeclares geometry itself (src/editor.rs:3187), before the statusline fan-out and before the long mutable core borrow.StatuslineEvaluationTarget(src/statusline.rs:212-226) is already a two-variant enum, so Q#BP8's fan-out generalization is an added variant, not a refactor.primary_document_window(src/editor_core.rs:2830) andprimary_document_buffer(:2845).
3. Findings and decisions
3.1 Q#BP2S1 — epoch ownership, resolved: frontend-owned, with an exact state machine
Decision: option 1. The epoch is owned by the frontend for
negotiated semantic-panel sessions. The deciding argument is one rev 1
missed: a font or scale transaction can require invalidating an old
PanelFrame even when the derived CellSize is identical. Daemon
value dedup cannot detect that case, because the cell totals it
compares are unchanged while the pixels behind them are not.
The landed allocator conflicts in three ways
(src/editor_core.rs:3155-3172): it allocates the id itself, it
early-returns when total is unchanged (value dedup), and it uses
saturating_add, which is neither wrapping nor fail-closed — it pins
at u64::MAX, after which two different geometries share one id.
Acceptance rules for a semantic declaration:
| Incoming declaration | Result |
|---|---|
| epoch greater than stored | Accept, store verbatim, even if total is unchanged |
same epoch, same total |
Idempotent no-op |
same epoch, different total |
Reject |
lower epoch, any total |
Reject |
The last row is deliberate and corrects rev 1: a lower epoch carrying identical data is still stale and must not be accepted.
API split. Two methods, not one method with an optional epoch:
declare_frame_geometry(fid, total)— the grid/LOCAL allocator. Keeps value dedup (correct there: cells are the unit, and an unchanged grid means an old frame is still valid under unchanged metrics). Changes fromsaturating_addto checked allocation with an explicit fail-closed exhaustion arm.accept_frame_geometry(fid, geometry_epoch, total) -> bool— the semantic path. No value dedup; applies the table above verbatim; returns whether the declaration was accepted so the caller can drop a stale event before any reconciliation.
An ambiguous single method with an Option<u64> epoch is rejected
explicitly: it would let a future caller silently take the wrong regime.
Initial epoch and exhaustion. The frontend's first declaration
after attach acceptance carries epoch 1; 0 is reserved as "never
declared" and is rejected on the wire. Frontend-side allocation is
checked; on exhaustion the frontend stops declaring and hides its
panel rather than reusing or wrapping an id — it sends no further
geometry, so the daemon's last accepted declaration stands and no new
Present can claim a fresh identity. Daemon-side exhaustion on the
grid path fails closed the same way: no new declaration, panel stays
at its last valid geometry or hides under Q#BP2b.
3.2 The census is classified, and it is mostly unrouted
Correction to rev 1. Q#BP14 routes only the Projection class
through primary_document_window. Rev 1's "all 23 reads" was wrong and
would have broken five subsystems. The four classes, restored:
| Class | Census items | Authority |
|---|---|---|
| Projection | #1–#7, #9, #10, #12, #21, #22 | primary_document_window / primary_document_buffer |
| Projection + focus | #8 (document Pointer), #11 (full-window TerminalPointer) |
Align the primary document window and then activate it — the one place the two legitimately move together |
| Focus / input | #13 (remote-op validation), #14 (dispatch_idle_for), #15 (presence), #23 (remote-op application) |
The frontend's actually focused window. Q#BP14a: gating is per-window, never per-buffer |
| Focus chrome / surface-routed | #16–#19 (search, menu, minibuffer, completion) | Q#BP14b's routing table — the currently owned surface, with authoritative clears for the other |
| Focus / session | #20 (terminal bell drain) | Per-session counter; the focused window chooses which session may drain |
Rerouting any of the last three classes to the document is a defect,
not a simplification: it would break remote-op validation and
application, DispatchIdle, presence, focused search/menu/completion
routing, and bell ownership.
How much is already routed. primary_document_window has four
references in src/ and two production paths: directly at
src/daemon.rs:1639 (#148's initial-target bootstrap, Q#BP11b), and
through primary_document_buffer at src/daemon.rs:2998, which is
census #22 and carries a comment naming it. So one census item is
routed and the Projection class is otherwise open. For scale, src/*.rs
still holds ~80 non-test direct .active reads on top of the
active_window* / active_buffer* helper family
(src/editor_core.rs:663-967).
This is not a Stage 1 defect — with panel_capable = false no semantic
frontend can hold a side window, so the unrouted Projection reads are
unreachable from the GPU. It does mean classified census routing is
the bulk of Stage 2, which is why it is Stage 2A.
3.3 The three statusline reads have two dispositions, not one
All three sites are real, but only one is wrong:
src/statusline.rs:644—.get(&view.active)selects the wrong window when a panel is focused. This is the Projection read (#12).src/statusline.rs:629and:675—active: window_id == view.activemust continue tracking actual focus. Three reasons: grid contexts need a truthfulactive; post-callback revalidation must notice a focus change; and parent acceptance 42 explicitly requires that a document provider may observeactive = falsewhile the panel is focused.
The new semantic-layout target therefore captures the primary
document window plus the visible side window, marks each context
active iff its window_id == view.active, invokes each provider
exactly once, and invalidates the entire evaluation if a
callback mutates layout or focus. Unprojected document splits run no
callbacks (Q#BP8). Route the primary-document result to semantic
StatuslineSegments and the side result to the panel mode line.
3.4 Fold projection
Unchanged from Q#BP17, with the anchor corrected: the extracted painter
takes the map as a parameter; the panel path passes None when the
owning frontend's fold_projection is false and must never call
fold_map_for_window, which gates on the active frontend
(src/editor_core.rs:734, gate at :738) — right for command-time
reckoning, wrong for painting another frontend's panel. The stale
comment is at src/window.rs:562.
3.5 The panel_capable flip needs a negotiated rule
Not "true for semantic sessions". Exactly:
panel_capable = trueonly for an authenticated semantic session that negotiated v21 or later.
A v6–v20 semantic frontend stays non-panel-capable and takes the existing Stage 1 fallback: the non-side target with every side-specific parameter discarded, leaving the document window undedicated (Q#BP2c). "It receives no new events" is insufficient — if the daemon nevertheless places that frontend's window in a side panel it cannot render, the window becomes invisible. The gate is on placement, not only on transport. Parent acceptance 51 pins the mixed session.
4. Revisions to the parent framing
Only these; everything else stands.
- Q#BP9 resolves to v21.
- Q#BP15a's epoch ownership is specified by §3.1's table and API split, replacing the parent's one-line "frontend-owned" statement.
- Q#BP8's statusline criterion splits per §3.3: one read reroutes, two keep tracking focus.
- Q#BP17's stale comment is at
src/window.rs:562, and parent acceptance 52's reference to:339should be read against that.
5. The four scout obligations, closed
5.1 The shared cell-grid validator boundary
TerminalFrame::validate (pmacs-protocol/src/terminal.rs:226)
currently interleaves both concerns. The exact split:
- Factored into the shared parameterized wire-cell-grid validator:
checked area (the
checked_mul+usize::try_fromguard), theMAX_TERMINAL_VISIBLE_CELLS = 262,144aggregate cap, cell-count equality against declared area, cursor-in-bounds, andvalidate_cells's glyph width / continuation topology and aggregate glyph-byte checks. - Stays terminal-only: the
MAX_TERMINAL_ROWS/COLS = 512per-axis caps inchecked_area,validate_metadatafor title/signal/crash text,validate_selection, and theat_bottom == (scroll_offset == 0)coupling.
PanelFrame takes the shared half plus its own presence/epoch rules
and does not inherit the 512 per-axis cap (Bet B5'), so a 4K
small-font panel wider than 512 columns is legal while the shared area
budget still binds. Parent acceptance 39 pins exactly this.
5.2 The GPU outbox needs four more tags
coalesce_kind (pmacs-gpu/src/attach.rs:331) today returns four
tail-only tags: Viewport → 0, Pointer{Drag} → 1,
TerminalPointer{Move} → 2, TerminalPointer{Drag} → 3. Everything
else is None = lossless, counting against OUTBOX_MAX = 8192.
Stage 2 adds four distinct tags: FrontendCellGeometry → 4,
PanelResizeRows → 5, PanelPointer{Move} → 6, PanelPointer{Drag}
→ 7. Geometry is latest-wins (epochs need only increase, not be
consecutive); resize drag is latest-wins over the complete event
including its epochs. PanelPointer Down/Up/wheel/context stay
lossless and ordered — repeated left Downs are what the daemon click
state reads as a multi-click, and Down(Right) is the context-menu
gesture. Tail-only replacement preserves ordering across an
intervening event of any other class.
5.3 The pixel formula's inputs — and one trap
The formula in Q#BP15a is contract-level, not an implementation detail, because its inputs are not all safe to adopt:
| Input | Source | Note |
|---|---|---|
status_band_height_px |
FontMetrics::status_band_height (pmacs-gpu/src/main.rs:137) = BASE_STATUS_BAND_HEIGHT * scale |
Safe |
TEXT_TOP_px |
const TEXT_TOP: f32 = 16.0 (main.rs:352) |
Safe; unscaled today |
code_line_height_px |
FontMetrics::code_line_height (main.rs:131) = BASE_CODE_LINE_HEIGHT * scale |
Safe |
resolved_monospace_advance_px |
State::mono_advance (main.rs:4899) |
Unsafe to adopt blindly |
divider_height_px |
BASE_DIVIDER_HEIGHT |
Does not exist yet |
The mono_advance trap. State::mono_advance returns
measured_mono_advance when a FontFacts probe has been applied, but
otherwise falls back to the first shaped glyph of the document
buffer (main.rs:4903+). Panel column count would therefore become
document-dependent: two GPU frontends showing different files could
derive different total.cols from identical metrics, and the same
frontend's panel width could change when the document's first glyph
changes.
Decision. The panel geometry declaration uses a stable normal-face
probe, never the document sample. probe_mono_advance(font_system, family, metrics) (main.rs:323) already exists and is exactly this: it
shapes ADVANCE_PROBE in a scratch buffer, independent of document
contents, dividing total run width by logical cells so ligature
substitution survives. The declaration resolves its advance from that
probe for the current family/metrics. If the probe returns None (the
family shapes no width), the frontend declares zero usable geometry
under a new epoch — the panel hides — rather than falling back to a
document sample.
BASE_DIVIDER_HEIGHT must be decided before implementation, because
the document-bottom seam it defines is depended on by caret placement,
hit testing, the minimap, terminal geometry, clipping, and edge
scrolling. Two sub-decisions:
- Value and scaling. It joins the
BASE_*family and scales asBASE_DIVIDER_HEIGHT * scale, matchingstatus_band_height— a divider that does not scale with the font would misalign at non-1.0 scale. The concrete base value is an open item for review round 2. - One seam, not several. Today the document bottom is computed
from
status_band_heightat several sites (main.rs:3175,:3185,:6601,:6607,:8491, and the status-band rect at:5910). Stage 2 must introduce one document-bottom accessor that subtracts status band plus the installed band and divider, and route every one of those sites through it. A second, unrouted seam is the exact shape of Stage 1'sLayout::computetwo-caller defect, wheresrc/overlay_paint.rsderived its own rect and painted peer cursors at unfixed rows.
Note the asymmetry Q#BP15a already requires: divider_height_px is
subtracted for sizing purposes even while the panel is absent, to
break the first-open cycle, while the document renderer does not
actually lose those pixels until a Present panel is painted.
5.4 Ordering against folding Stage 3
Settled by review round 1: bottom-panel Stage 2 first, through the
landed GPU band. Folding Stage 3 then re-scouts the extracted
painter, the panel projection, clipping, and fold_projection behavior
exactly once.
6. Coherence impact (per COHERENCE.md §20)
- Journey steps touched: four, on the GPU frontend — steps 7–10 (find symbol / find file, terminal, build and test, error inspection). Rev 1 said "none directly", which contradicted its own next sentence. Today a GPU user who triggers references, project search, a terminal, compile, or error inspection gets the Stage 1 non-side fallback: the output surface steals a document window instead of opening a panel. Every one of those steps therefore behaves differently on GPU than on TUI, and Stage 2 is what closes the divergence.
- Interaction islands added: none, and this is a reduction. §6
grades islands "weak, and growing by one island per modal feature".
Stage 2 extends one already-adopted policy (
display = "panel", used by listview, compile, and terminal) to a second frontend rather than minting a GPU-only surface. Q#BP14b deliberately reuses the existingSearchPrompt/MenuPrompt/CompletionPopupmessages instead of panel-specific twins. - Config registry adoption: inherited, not extended. Stage 1's
window.panel-heightandwindow.min-heightalready live in the registry. Stage 2 adds no new user-facing option; if the band needs one, it enters the registry. - Background-work attribution: unchanged, and this stage does not advance it. Rev 1 implied Stage 2 helps §9's activity-view gap. It does not. A panel gives output a coherent placement; it does not make terminal PTYs, LSP servers, or workers appear in the activity/ownership view §9 describes, and it adds no join key across the four disjoint activity planes. The §9 gap is untouched.
- Section this serves:
COHERENCE.md§14, which records the panel primitive as landed for Stage 1 and names "Stage 2 (GPU band) pending its own framing" as the open item.
7. Acceptance
Parent criteria 37–55 remain authoritative and are not replaced. This section maps them to the two slices and adds only refinements.
7.1 Stage 2A — classified census routing + painter extraction
No protocol change. Parent criteria that apply in full: 42, 43, 44,
51 (the LOCAL-panel inheritance half), 52.
Refinements 2A adds:
- A2A-1 (replaces rev 1's criterion 1). Every Projection census
item (#1–#7, #9, #10, #12, #21, #22) resolves through
primary_document_window/primary_document_buffer; #8 and #11 align and then activate; #13, #14, #15, #23 continue to resolve the actually focused window; #16–#19 follow Q#BP14b's routing table; #20 keeps its per-session counter with focus choosing the eligible terminal. Each class is asserted separately, at the outermost user-reachable seam, and falsified by revert. A test that only proves "the document is used" would pass with the focus classes wrongly rerouted, so the focus-class assertions are the load-bearing half. - A2A-2 (replaces rev 1's criterion 2).
src/statusline.rs:644resolves the primary document window, while:629and:675continue to report actual focus — pinned by a document provider truthfully observingactive = falsewhile the panel is focused (parent 42). The semantic-layout target captures primary document + visible side window, invokes each provider exactly once, and invalidates the whole evaluation when a callback mutates layout or focus. - A2A-3 (replaces rev 1's criterion 3). The painter extraction
preserves, for grid frontends: the painted cells, the returned
cursor, the focused window's
view_topmutation from the auto-scroll clamp, and passive windows' untouchedview_topand scroll state. Byte-identical cells alone would not catch a clamp that silently moved to the wrong window.
7.2 Stage 2B — v21 protocol + daemon projection + GPU band
Parent criteria that apply in full: 37, 38, 39, 40, 41, 45, 46, 47, 48, 49, 50, 51, 53, 54, 55, plus re-assertion of 42/43/44 through the actual negotiated capability flip rather than through a test-only panel-capable semantic view.
Refinements 2B adds:
- A2B-1. The epoch state machine of §3.1 is pinned row by row,
including the lower-epoch-identical-data rejection and the
same-epoch-different-total rejection. Grid allocation is checked with
a fail-closed exhaustion arm; the semantic path performs no value
dedup. Epoch
0is rejected on the wire. - A2B-2. A font or scale change that leaves
CellSizeidentical still produces a newgeometry_epoch, and the olderPanelFrameneither paints nor hit-tests until a matchingPresentarrives. This is the case daemon value dedup cannot see and is why option 1 was chosen. - A2B-3. Panel columns are derived from the stable normal-face
probe, not
State::mono_advance's document-glyph fallback: two GPU frontends with identical metrics and different documents derive identicaltotal.cols, and a probe returningNonedeclares zero usable geometry rather than falling back to a document sample. - A2B-4. Every document-bottom consumer — caret, hit test, minimap,
terminal geometry, clipping, edge scrolling — routes through the one
document-bottom accessor. Falsified by introducing a band and
asserting each consumer moves; a second unrouted seam is the Stage 1
Layout::computedefect class. - A2B-5.
panel_capableis true only for a v21+ negotiated authenticated semantic session; a v20 semantic session is never placed in a side window, not merely denied the events.
8. Open items for review round 2
- The concrete
BASE_DIVIDER_HEIGHTvalue (§5.3). Scaling and the single-seam rule are decided; the number is not. - Whether
TEXT_TOPshould scale. It is an unscaled constant today and the formula consumes it as-is; that is pre-existing behavior Stage 2 inherits rather than fixes, but it is worth a decision before the conversion is pinned by acceptance.
9. Slices, branches, and gates
Per review round 1: two serial implementation PRs, each a named slice under this framing so one-feature/one-branch/one-PR holds. 2A lands before 2B branches — not stacked.
- Stage 2A — classified census routing + per-window painter
extraction. Branch
bottom-panel-stage2a. No protocol change. - Stage 2B — v21 protocol, daemon panel projection, GPU band, and
the negotiated
panel_capableflip. Branchbottom-panel-stage2b, cut frommainafter 2A merges. Repeats 2A's relevant census assertions through the real capability flip.
Gates for both: the standing suite, plus
bottom_panel_stage1_acceptance, the new
bottom_panel_stage2a_acceptance / bottom_panel_stage2b_acceptance,
the three vterm suites (the panel hosts terminals), folding Stage 2's
48 (shared projection), and PMACS_REQUIRE_GPU=1 cargo test -p pmacs-gpu. Protocol round-trip and byte-pin tests ride 2B. Parent
criterion 54's --headless-probe run — one real daemon, real PTY, real
wgpu, through a panel-hosted terminal — is a 2B gate.