ddidderr
271f5e7bb5
Ports ZIG/src/terminal/{Screen,ScreenSet,Tabstops,Selection}.zig on top
of the page/PageList layer. The cursor holds a TrackedPin; Zig's cached
page_row/page_cell pointers become accessor methods. Selection methods
take the PageList explicitly because tracked bounds are handles.
Screen tests use minimal plain-text dump/selection-string helpers that
follow the formatter's semantics; they will delegate to the real
formatter once formatter.zig is ported.
Gaps found in the PageList layer are recorded for the parity pass in
docs/rewrite/notes/ghostty-terminal-pagelist-requests.md; three resize
tests are #[ignore]d pending those fixes (PageList::resize keeps
trailing blank rows Zig drops). Kitty image storage and StringMap are
placeholders.
Test Plan:
- cargo test -p ghostty-terminal (443 passed, 3 ignored; Screen 183/184,
Selection 18/18, Tabstops 4/5 - skipped tests use allocator failure
injection)
35 lines
3.1 KiB
Markdown
35 lines
3.1 KiB
Markdown
# ghostty-terminal: Screen, ScreenSet, Tabstops, Selection
|
|
|
|
## Ported
|
|
| Zig | Rust | tests |
|
|
|---|---|---|
|
|
| Screen.zig | `screen.rs` (+ `cursor.rs` for cursor.zig `Style`, `pin_iter.rs` helper) | 183 of 184 (`screen/tests/p1..p5.rs`) |
|
|
| ScreenSet.zig | `screen_set.rs` | 1/1 |
|
|
| Tabstops.zig | `tabstops.rs` | 4/5 |
|
|
| Selection.zig | `selection.rs` | 18/18 |
|
|
|
|
Skipped: `Tabstops: resize alloc failure preserves state` and `selectionString map allocation failure cleanup` (Zig tripwire failure injection).
|
|
Ignored (pagelist limitations, see `ghostty-terminal-pagelist-requests.md`): 3 resize tests.
|
|
Deps added: ghostty-unicode (width in `test_write_string`), ghostty-datastruct (unused so far), log.
|
|
|
|
## Deviations
|
|
- Cursor `page_pin` is a `TrackedPin`; `page_row`/`page_cell` are accessors: `cursor_pin()`, `cursor_row()/_mut()`, `cursor_cell()/_mut()`, `cursor_page()/_mut()`, `cursor_row_cells()`, `cursor_cell_left/right[_mut](n)`.
|
|
- Errors are `page::Error` (re-exported `screen::Error`). `Screen::reset()` returns `Result`.
|
|
- `Screen::new(Options)`; `Options::new(cols, rows, max_scrollback)` (0 = no scrollback).
|
|
- `clone` is `clone_screen(top, bot)`. `cursor_copy(&Cursor, hyperlink: bool)` copies the hyperlink from the other cursor's heap copy.
|
|
- `append_grapheme(x, cp)` takes a column of the cursor row. `clear_cells(node, y, x0, x1)` takes a half-open column range.
|
|
- Selection methods take `&PageList` (`&screen.pages`) since tracked bounds are handles: `sel.start(&pages)`, `top_left`, `order`, `contains`, `contained_row`, `ordered`, `eql(&pages, &other)`, `adjust(&mut pages, adj)`, `track(&mut pages)`, `deinit(&mut pages)`. `Selection` is `Copy`.
|
|
- `kitty_images` is a placeholder `KittyImages { dirty }` (TODO(integration) until kitty graphics storage lands). `StringMap` is a local struct (TODO(integration)).
|
|
- Minimal plain-text formatter (`plain_format` in screen.rs) backs `selection_string[_map]`, `dump_string`, `dump_string_alloc[_unwrapped]`; TODO(integration): delegate to formatter.rs.
|
|
- Tabstops::unset XORs like Zig (unsetting an unset stop sets it).
|
|
- `cursor_set_hyperlink` does not probe the string allocator (private); it re-adds the link after growth.
|
|
- `Screen::erase_rows` carries a `Viewport::Top` workaround (request 5).
|
|
|
|
## API overview for Terminal
|
|
`Screen` fields: `pages, no_scrollback, cursor, saved_cursor, selection, charset, protected_mode, kitty_keyboard, kitty_images, semantic_prompt, dirty`.
|
|
Cursor motion: `cursor_up/down/left/right(n)`, `cursor_absolute(x,y)`, `cursor_horizontal_absolute(x)`, `cursor_down_scroll()`, `cursor_scroll_above()`, `cursor_reset_wrap()`, `cursor_mark_dirty()`, `cursor_reload()`.
|
|
Editing: `clear_cells`, `clear_unprotected_cells`, `clear_rows`, `erase_rows`, `split_cell_boundary(x)`, `blank_cell()`, `resize(Resize)`, `scroll(Scroll)`, `scroll_clear()`.
|
|
Style/links: `set_attribute(sgr::Attribute)`, `manual_style_update()`, `start_hyperlink(uri, id)`, `end_hyperlink()`, `cursor_set_hyperlink()`, `cursor_set_semantic_content(..)`.
|
|
Selection: `select(Option<Selection>)`, `clear_selection()`, `select_line/all/word/word_between/output`, `line_iterator`, `prompt_click_move`, `selection_string`.
|
|
Test helper: `test_write_string`.
|