Compare commits
167 Commits
feature/v0
...
94df17a7b9
| Author | SHA1 | Date | |
|---|---|---|---|
| 94df17a7b9 | |||
| ef26220df7 | |||
| 4e54737659 | |||
| 4e0b825fcc | |||
| e53939844c | |||
| 9b8ac8b770 | |||
| 4c3f5fe65a | |||
| ef613927e6 | |||
| 108abd054f | |||
| d0382f9290 | |||
| 9a4d117eee | |||
| ff7eb4d6e1 | |||
| ff5b7a5fea | |||
| 0b076c8def | |||
| af572d5a8c | |||
| e3415cee73 | |||
| f76f637548 | |||
| e115a88690 | |||
| 2785d6913f | |||
| 1df078a235 | |||
| 26e55e652f | |||
| ce9bf7781a | |||
| de1864bd94 | |||
| bb579be207 | |||
| 916f473107 | |||
| b44b4b6aa0 | |||
| 36fbe81441 | |||
| 8cb269dfee | |||
| 11a70956a0 | |||
| 9a54b7ade6 | |||
| aa73171c30 | |||
| eedf065e6e | |||
| 21c7b1c2d9 | |||
| 733ba7c1b8 | |||
| ce7af16b13 | |||
| 31f864471c | |||
| 4b1ff3ed0f | |||
| fe301dc25b | |||
| 4df3048a13 | |||
| 41e2b867be | |||
| a227a52c48 | |||
| 37f83db35e | |||
| 9b472e281f | |||
| 4fa7e98b80 | |||
| 03ffec75c8 | |||
| 5e9a974981 | |||
| 4b9482c09a | |||
| 83a6e87720 | |||
| db07f8c3a7 | |||
| 4a86ae3274 | |||
| 7813e27907 | |||
| abe4edaffc | |||
| 1ac6ca02ee | |||
| 0e0151664e | |||
| 5c8a253171 | |||
| 7cdb556531 | |||
| 920545dafb | |||
| 5a3b882f93 | |||
| 21d9890374 | |||
| b80bd77d84 | |||
| 14b41831c3 | |||
| e8b37f6268 | |||
| 1637c3352c | |||
| 07cea571ef | |||
| 3bc6df6fd0 | |||
| 22886c1794 | |||
| 66e86734cb | |||
| c30917056c | |||
|
|
d4aba6ef06 | ||
|
|
b3b191529a | ||
| 07c29290d4 | |||
|
|
38ee561625 | ||
|
|
84e8482fec | ||
|
|
3cbcfd2d75 | ||
|
|
9c879e7a97 | ||
|
|
352f27e260 | ||
|
|
6cd045ff59 | ||
|
|
a9670a5cd7 | ||
|
|
29f99a576d | ||
|
|
927f786716 | ||
|
|
668966380e | ||
|
|
a061d60898 | ||
|
|
d5caaf296d | ||
|
|
0fb5309133 | ||
|
|
d3bc6c748a | ||
|
|
f50d0e61d1 | ||
|
|
c77c6b9d02 | ||
|
|
dfd828c914 | ||
|
|
ce7e9fbab0 | ||
|
|
ba5cb360db | ||
|
|
47094c48e5 | ||
|
|
5f07c1fd76 | ||
|
|
a812955329 | ||
|
|
ca90d6b945 | ||
|
|
60866a80c1 | ||
|
|
5930e17b57 | ||
|
|
4bb9160f8d | ||
|
|
d5a767350f | ||
|
|
00db3c61a5 | ||
|
|
6e73c3bb19 | ||
|
|
a153746111 | ||
|
|
baa27f766f | ||
|
|
b0ede26bff | ||
|
|
b38436038b | ||
|
|
df5ceabd3b | ||
|
|
80abb23197 | ||
|
|
e198e8b5da | ||
|
|
26ec1dfbe8 | ||
|
|
bb1717a43d | ||
|
|
b21daa99b8 | ||
|
|
30fdb1def8 | ||
|
|
5213bdeae5 | ||
|
|
3f54fdb76a | ||
|
|
eabec0c48a | ||
|
|
1e9a780d61 | ||
|
|
0f408eeff7 | ||
|
|
7f4f712399 | ||
| 9e5b1ee8c6 | |||
| e887e9bf88 | |||
| 915e4f9d2c | |||
| 5271f5a2ab | |||
| 419c8df653 | |||
|
|
eede03ee3f | ||
|
|
2b2119a2f1 | ||
|
|
613e4b6217 | ||
|
|
0ed7427802 | ||
|
|
2649dbeb79 | ||
|
|
4594d40a9c | ||
|
|
517b43b801 | ||
|
|
bdd558407e | ||
|
|
149316cb58 | ||
|
|
a888eb2c76 | ||
|
|
26b1aaf36d | ||
|
|
abf8e5cdeb | ||
|
|
a294f21c70 | ||
|
|
c3c330dfff | ||
|
|
b50c97a0cb | ||
|
|
90680833b0 | ||
|
|
448127c696 | ||
|
|
ad34ec1b63 | ||
|
|
fafb1dae61 | ||
|
|
225b52a9d8 | ||
|
|
1ba298e705 | ||
|
|
edd5a7b8d1 | ||
|
|
ddd3950e49 | ||
|
|
b7df68c436 | ||
|
|
3ce7f9949c | ||
|
|
d63ba69fb7 | ||
|
|
1a19d12f7d | ||
|
|
5a053b69c6 | ||
|
|
825980b93b | ||
|
|
cb6e7cc20a | ||
|
|
f9349c2ac8 | ||
|
|
949bfe46bf | ||
|
|
14193b8c92 | ||
|
|
811d51a4f2 | ||
|
|
9648c72b85 | ||
|
|
e96c338a57 | ||
|
|
9adefb5dbb | ||
|
|
3b0410b088 | ||
|
|
c55f1773fb | ||
|
|
f07cb65186 | ||
|
|
2d3227aaf1 | ||
|
|
0851311c3d | ||
|
|
6ba69f4610 | ||
|
|
b0e5c18257 | ||
| 76f4477313 |
14
.gitignore
vendored
Normal file
14
.gitignore
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
# Compiled Lisp files
|
||||
*.fasl
|
||||
*.fasl.gz
|
||||
*.lib
|
||||
*.dx32fsl
|
||||
*.dx64fsl
|
||||
|
||||
# System files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Python cache
|
||||
__pycache__/
|
||||
*.pyc
|
||||
304
.hermes/plans/2026-05-12-cl-tty-bug-fixes.md
Normal file
304
.hermes/plans/2026-05-12-cl-tty-bug-fixes.md
Normal file
@@ -0,0 +1,304 @@
|
||||
# cl-tty v1.0.0 Bug Fix Iteration
|
||||
|
||||
> **For Hermes:** Use subagent-driven-development + bug-fix-iteration pattern.
|
||||
> Each task: inspect → write regression test → fix → verify → commit.
|
||||
> Do NOT skip tests. Do NOT combine tasks.
|
||||
|
||||
**Goal:** Fix all known bugs and blindspots before v1.0.0 release.
|
||||
|
||||
**Architecture:** cl-tty is a pure CL terminal UI library. No FFI, no ncurses.
|
||||
Components: backend (modern/simple escape seq), input (byte reader + event parser),
|
||||
rendering (framebuffer diff pipeline), layout (flexbox), widgets.
|
||||
|
||||
**Verification command after each fix:**
|
||||
```bash
|
||||
cd /mnt/hermes/projects/cl-tty && sbcl --script run-all-tests.lisp && python3 scripts/verify-api.py && python3 scripts/verify-demo-pty.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 1: Fix `read-raw-byte` timeout (CRITICAL BUG)
|
||||
|
||||
**Objective:** The timeout mechanism uses `get-universal-time` which returns
|
||||
integer seconds. Adding a float timeout like 0.05 produces a deadline that
|
||||
equals the current second — the loop terminates immediately. The 50ms escape
|
||||
ambiguity timeout never actually works.
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/input.lisp:84-111`
|
||||
- Test: `tests/input-tests.lisp` (add regression test)
|
||||
|
||||
**Root cause:** Line 99: `(let ((deadline (+ (get-universal-time) timeout)))` —
|
||||
`get-universal-time` returns integer seconds, so `(+ (integer) 0.05)` = `(+ integer 0)` = integer.
|
||||
The loop `(while (< (get-universal-time) deadline))` runs zero iterations for any
|
||||
sub-second timeout.
|
||||
|
||||
**Fix:** Use `sb-ext:get-time-of-day` (microsecond precision) or `(/ (get-internal-real-time)
|
||||
internal-time-units-per-second)` to get fractional seconds. Replace:
|
||||
|
||||
```lisp
|
||||
(let ((deadline (+ (get-universal-time) timeout)))
|
||||
(loop while (< (get-universal-time) deadline) ...))
|
||||
```
|
||||
|
||||
with:
|
||||
|
||||
```lisp
|
||||
(let* ((start (get-internal-real-time))
|
||||
(ticks (round (* timeout internal-time-units-per-second)))
|
||||
(deadline (+ start ticks)))
|
||||
(loop while (< (get-internal-real-time) deadline) ...))
|
||||
```
|
||||
|
||||
Or simpler: use `(/ (- (get-internal-real-time) start) internal-time-units-per-second)`
|
||||
to check elapsed time in a loop.
|
||||
|
||||
**Verification:**
|
||||
1. Write a test that calls `read-raw-byte` with :timeout 0.05 and verifies it
|
||||
returns `(values nil :timeout)` within ~100ms (not instantly).
|
||||
2. All existing tests still pass.
|
||||
3. The demo's Escape key works (tested by verify-demo-pty.py).
|
||||
|
||||
---
|
||||
|
||||
### Task 2: Fix `draw-border` ignoring title in modern backend (BUG)
|
||||
|
||||
**Objective:** The `modern-backend`'s `draw-border` method has
|
||||
`(declare (ignore title title-align))` on line 194. The framebuffer backend
|
||||
renders titles correctly. The simple backend also ignores titles.
|
||||
This means titled borders don't show titles in the modern backend.
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend/modern.lisp:192-219`
|
||||
- Add test: `backend/modern-tests.lisp`
|
||||
|
||||
**Fix:** In `draw-border` for `modern-backend`, insert the title text into the
|
||||
top border line after the first character. The title should be centered or
|
||||
left-aligned based on `title-align`.
|
||||
|
||||
The title rendering logic should extract from the framebuffer backend's
|
||||
draw-border (framebuffer.lisp lines 114-117) and adapt for escape sequences:
|
||||
- The top border line is constructed as: `tl + h*N + tr`
|
||||
- Before writing top: if title is non-nil, insert it: `tl + " " + title + " " + h*fill + tr`
|
||||
- Truncate title if it exceeds width-4
|
||||
|
||||
---
|
||||
|
||||
### Task 3: Fix `backend-size` to query real terminal size (MISSING FEATURE)
|
||||
|
||||
**Objective:** `backend-size` for `modern-backend` returns hardcoded (80 24).
|
||||
Should query the terminal via TIOCGWINSZ ioctl or `ESC[18t` query.
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend/modern.lisp:163-165`
|
||||
- Add test: `backend/modern-tests.lisp` (test that values are positive integers)
|
||||
|
||||
**Fix:** Use SBCL's `sb-alien` to call `ioctl` with `TIOCGWINSZ` on the
|
||||
stdout fd (or /dev/tty):
|
||||
|
||||
```lisp
|
||||
(defmethod backend-size ((b modern-backend))
|
||||
(sb-unix:unix-ioctl (sb-sys:fd-stream-fd
|
||||
(or (ignore-errors
|
||||
(open "/dev/tty" :direction :input
|
||||
:if-does-not-exist nil))
|
||||
*standard-output*))
|
||||
sb-unix:TIOCGWINSZ ...)
|
||||
;; Or fallback to query-terminal with ESC[18t
|
||||
;; Fallback: (values 80 24))
|
||||
```
|
||||
|
||||
Simpler approach: Use `sb-unix:unix-ioctl` with the `TIOCGWINSZ` request.
|
||||
The winsize struct is: (rows columns) as two 16-bit values. In SBCL,
|
||||
`sb-unix:unix-ioctl` can be used with `sb-unix:TIOCGWINSZ`.
|
||||
|
||||
If ioctl is complex, implement via OSC Terminal query: `query-terminal` with
|
||||
`ESC[18t` returns `ESC[8;rows;colst`. Parse the response.
|
||||
|
||||
---
|
||||
|
||||
### Task 4: Enable kitty keyboard protocol in `initialize-backend` (MISSING FEATURE)
|
||||
|
||||
**Objective:** `modern-backend` declares `:kitty-keyboard` in `capable-p`
|
||||
but never sends the escape sequence to enable it (`ESC[?u`).
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend/modern.lisp:142-151`
|
||||
|
||||
**Fix:** Add to `initialize-backend`:
|
||||
```lisp
|
||||
(backend-write b (format nil "~C[?u" #\Esc)) ; kitty keyboard
|
||||
```
|
||||
|
||||
And add to `shutdown-backend`:
|
||||
```lisp
|
||||
(backend-write b (format nil "~C[?u" #\Esc)) ; restore default keyboard
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 5: Fix text-input cursor rendering (MISSING VISUAL FEEDBACK)
|
||||
|
||||
**Objective:** The `text-input.lisp` render method declares `(declare (ignore cursor))`.
|
||||
The cursor position is tracked but never drawn, so users can't see where
|
||||
they're typing.
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/text-input.lisp` (render method)
|
||||
- Add test: `tests/input-tests.lisp` or existing test file
|
||||
|
||||
**Fix:** In the text-input render method, after drawing the value/placeholder,
|
||||
draw a cursor block (█ or reversed ▓) at the cursor position. Use
|
||||
`draw-rect` or `draw-text` with a visual cursor character at the cursor column.
|
||||
|
||||
When the cursor would be beyond the visible area (scrolled past the right edge),
|
||||
show it at the rightmost position.
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Fix SS3 branch reading without timeout (POTENTIAL HANG)
|
||||
|
||||
**Objective:** In `%read-escape-sequence`, the SS3 branch (when b=#x4f) calls
|
||||
`(read-raw-byte)` without a timeout parameter. If the terminal sends a partial
|
||||
ESC O with no follow-up byte, the read blocks forever.
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/input.lisp:210`
|
||||
|
||||
**Fix:** Change line 210 from:
|
||||
```lisp
|
||||
(let ((b2 (read-raw-byte)))
|
||||
```
|
||||
to:
|
||||
```lisp
|
||||
(let ((b2 (read-raw-byte :timeout 0.1)))
|
||||
```
|
||||
And handle the nil case: if b2 is nil, return a key-event for the lone Escape.
|
||||
|
||||
---
|
||||
|
||||
### Task 7: Add Wayland support to `copy-to-clipboard` (PLATFORM GAP)
|
||||
|
||||
**Objective:** `copy-to-clipboard` in `mouse.lisp` only supports X11 (xclip)
|
||||
and macOS (pbcopy). Wayland users (wl-copy) get no clipboard.
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/mouse.lisp:51-54`
|
||||
|
||||
**Fix:** Add `#+wayland` or detect Wayland via `$WAYLAND_DISPLAY` env var:
|
||||
|
||||
```lisp
|
||||
(defun copy-to-clipboard (text)
|
||||
#+linux
|
||||
(cond
|
||||
((sb-ext:posix-getenv "WAYLAND_DISPLAY")
|
||||
(sb-ext:run-program "wl-copy" nil :input text :wait nil))
|
||||
(t
|
||||
(sb-ext:run-program "xclip" (list "-selection" "clipboard")
|
||||
:input text :wait nil)))
|
||||
#+darwin
|
||||
(sb-ext:run-program "pbcopy" nil :input text :wait nil))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 8: Add SIGWINCH handler for terminal resize (MISSING FEATURE)
|
||||
|
||||
**Objective:** When the terminal is resized, the demo and any cl-tty app
|
||||
will render with stale dimensions. The `backend-size` (Task 3) helps but
|
||||
apps need to be notified of resizes.
|
||||
|
||||
**Files:**
|
||||
- Create: `src/components/notification.lisp` OR modify existing components
|
||||
|
||||
**Approach:**
|
||||
This is a design decision. Options:
|
||||
a) Install a SIGWINCH handler that sets a flag checked each frame
|
||||
b) Provide a `register-resize-callback` API
|
||||
c) Only fix in the demo layer (demo.lisp)
|
||||
|
||||
Keep it minimal: install a simple signal handler that sets
|
||||
`*terminal-resized-p*` to T. The app checks this flag each frame.
|
||||
|
||||
Add to `input.lisp` or a new file:
|
||||
```lisp
|
||||
(defvar *terminal-resized-p* nil
|
||||
"Set to T by SIGWINCH handler when terminal resizes.")
|
||||
|
||||
(defun %handle-sigwinch (signal info context)
|
||||
(declare (ignore signal info context))
|
||||
(setf *terminal-resized-p* t))
|
||||
|
||||
;; Install handler
|
||||
#+sbcl
|
||||
(sb-sys:enable-interrupt sb-unix:sigwinch #'%handle-sigwinch)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Bug Blindspots Verified as NOT Bugs (justifying "won't fix"):
|
||||
|
||||
These were investigated and are fine:
|
||||
- **Framebuffer diff link-url**: `cells-equal-p` compares `cell-link-url` with `equal` — covered.
|
||||
- **Select with empty options**: `(if (zerop count) (setf (select-selected-index sel) 0)` — handled.
|
||||
- **Dialog pop from empty stack**: `(when *dialog-stack*` — guarded.
|
||||
- **`parse-csi-params`**: reads raw bytes, handles EOF gracefully.
|
||||
- **Thread safety of globals**: out of scope for v1.0.0 (single-threaded TUI).
|
||||
- **ScrollBox horizontal scrolling**: actually implemented (uses sx in render).
|
||||
- **Redundant tests removed**: cleanup already done in uncommitted diff.
|
||||
|
||||
---
|
||||
|
||||
### BLINDSPOT: The `parse-csi-params` function also uses `(read-raw-byte)` without timeout.
|
||||
|
||||
Line 122: `(multiple-value-bind (b reason) (read-raw-byte)` — while parsing
|
||||
a CSI sequence, if the terminal sends ESC[ but never completes the sequence,
|
||||
this blocks forever. This should use a timeout similar to the escape sequence
|
||||
reader. Same fix pattern as Task 6.
|
||||
|
||||
Adding as Task 9.
|
||||
|
||||
---
|
||||
|
||||
### Task 9: Fix `parse-csi-params` to use timeout (POTENTIAL HANG)
|
||||
|
||||
**Objective:** `parse-csi-params` (input.lisp line 122) reads bytes without
|
||||
timeout. A partial CSI sequence (ESC[ without final byte) blocks forever.
|
||||
|
||||
**Files:**
|
||||
- Modify: `src/components/input.lisp:116-149`
|
||||
|
||||
**Fix:** Add a timeout to the read inside `parse-csi-params`. Use a total
|
||||
timeout of ~500ms for the entire CSI sequence (generous given terminals
|
||||
respond within a few ms). If the timeout fires, return nil for final-byte.
|
||||
|
||||
Similar to `%read-escape-sequence`, pass `:timeout` parameter to `parse-csi-params`
|
||||
and have `%read-escape-sequence` pass a timeout to it.
|
||||
|
||||
---
|
||||
|
||||
### Task 10: Fix `draw-border` ignoring title in simple backend (BUG)
|
||||
|
||||
**Objective:** Same as Task 2 but for `simple-backend`. The
|
||||
`%simple-border-char` function just got refactored (uncommitted diff), and
|
||||
`draw-border` in simple.lisp also ignores title.
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend/simple.lisp` (draw-border method)
|
||||
- Add test: `backend/tests.lisp`
|
||||
|
||||
**Fix:** In `simple-backend`'s `draw-border`, when a title is provided,
|
||||
insert it into the top border line. Use ASCII chars (the simple backend
|
||||
doesn't use Unicode).
|
||||
|
||||
---
|
||||
|
||||
### Task 11: Add `detect-backend` export to backend package (API GAP)
|
||||
|
||||
**Objective:** The README shows `(cl-tty.backend:detect-backend)` as the
|
||||
entry point, but verify this is actually exported from the backend package.
|
||||
|
||||
**Files:**
|
||||
- Check: `backend/package.lisp`
|
||||
|
||||
**Fix:** Ensure `#:detect-backend` is in the package's `:export` list.
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a working copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License \"or any later version\" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide whether future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
412
README.org
412
README.org
@@ -1,53 +1,389 @@
|
||||
#+TITLE: cl-tui — Reusable Common Lisp Terminal UI Framework
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :project:cl-tui:readme:
|
||||
#+TITLE: cl-tty — Terminal UI Framework for Common Lisp
|
||||
|
||||
* cl-tui
|
||||
Pure CL terminal UI framework. No ncurses, no FFI, no external dependencies.
|
||||
|
||||
A reusable Common Lisp framework for building rich terminal user interfaces.
|
||||
Built on croatoan (ncurses) with Yoga for Flexbox layout. Provides a component
|
||||
tree model with dirty-tracking, incremental rendering, layered keybinding,
|
||||
theme engine, and full mouse support — the primitives needed to match the TUI
|
||||
quality of Claude Code and OpenCode from Common Lisp.
|
||||
#+BEGIN_SRC lisp
|
||||
(ql:quickload :cl-tty)
|
||||
#+END_SRC
|
||||
|
||||
** Why
|
||||
* Quick start
|
||||
|
||||
Common Lisp has no reusable terminal UI framework at the level of Python's
|
||||
Rich/prompt_toolkit or Go's Bubble Tea. Every CL project that wants a
|
||||
terminal UI either builds ncurses from scratch or uses a text-only REPL.
|
||||
cl-tui fills that gap — a component library with Flexbox layout, semantic
|
||||
theming, layered keybinding, and full mouse support. Build a terminal UI once,
|
||||
reuse it everywhere.
|
||||
The simplest possible cl-tty program — detect the terminal, draw some text,
|
||||
read a key, and shut down:
|
||||
|
||||
Terminal UIs also work over SSH. A Qt or browser-based UI requires a local
|
||||
display. A cl-tui application runs remotely — same code, same components,
|
||||
accessible from anywhere.
|
||||
#+BEGIN_SRC lisp
|
||||
(sb-posix:with-raw-terminal
|
||||
(let* ((be (cl-tty.backend:detect-backend))
|
||||
(w 80) (h 24))
|
||||
(cl-tty.backend:initialize-backend be)
|
||||
(unwind-protect
|
||||
(progn
|
||||
(cl-tty.backend:draw-text be 0 0 "Hello, terminal!" :green nil :bold t)
|
||||
(cl-tty.backend:draw-border be 0 1 30 5 :style :single)
|
||||
(finish-output)
|
||||
;; Read one key (blocks)
|
||||
(cl-tty.input:read-event be))
|
||||
(cl-tty.backend:shutdown-backend be))))
|
||||
#+END_SRC
|
||||
|
||||
** Architecture
|
||||
Or run the full interactive demo:
|
||||
|
||||
```
|
||||
Application code (any CL project)
|
||||
└── cl-tui (layout, components, theme, events, dialogs)
|
||||
└── Yoga (Flexbox layout — C library via FFI)
|
||||
└── croatoan (ncurses terminal rendering)
|
||||
```
|
||||
#+BEGIN_SRC bash
|
||||
sbcl --script demo.lisp
|
||||
#+END_SRC
|
||||
|
||||
cl-tui depends only on croatoan and Yoga. It is not tied to any application.
|
||||
* Architecture
|
||||
|
||||
** Dependencies
|
||||
Two backends, one protocol:
|
||||
|
||||
- Common Lisp (SBCL tested)
|
||||
- croatoan — ncurses binding for terminal rendering
|
||||
- Yoga — Flexbox layout engine (C library, loaded via CFFI)
|
||||
- Quicklisp libraries as needed (ironclad for hashing, bordeaux-threads)
|
||||
- *modern-backend* — truecolor 24-bit, OSC 8 hyperlinks, DECICM sync,
|
||||
SGR mouse, kitty keyboard, bold/italic/underline, box-drawing chars
|
||||
- *simple-backend* — ASCII art, no color, universal compatibility (pipe-safe)
|
||||
|
||||
** Status
|
||||
Everything is pure escape sequences (no curses, no terminfo, no FFI).
|
||||
|
||||
v0.1.0 — Layout engine (in progress)
|
||||
** Backend protocol
|
||||
|
||||
See ~docs/ROADMAP.org~ for the full release plan.
|
||||
Every drawing operation is a CLOS generic function dispatched on the backend
|
||||
class. Programs never call terminal codes directly:
|
||||
|
||||
** License
|
||||
#+BEGIN_SRC lisp
|
||||
;; Lifecycle
|
||||
(initialize-backend backend)
|
||||
(shutdown-backend backend)
|
||||
|
||||
TBD
|
||||
# Test
|
||||
;; Drawing
|
||||
(draw-text backend x y string fg bg &key bold italic underline reverse dim)
|
||||
(draw-border backend x y width height &key style fg bg title)
|
||||
(draw-rect backend x y width height &key bg)
|
||||
(draw-link backend x y string url &key fg bg)
|
||||
|
||||
;; Input
|
||||
(read-event backend &key timeout) → key-event, mouse-event, :eof, or nil
|
||||
(backend-size backend) → (values columns lines)
|
||||
|
||||
;; Cursor
|
||||
(cursor-move backend x y)
|
||||
(cursor-hide backend)
|
||||
(cursor-show backend)
|
||||
(cursor-style backend shape &key blink) ;; :bar :block :underline
|
||||
#+END_SRC
|
||||
|
||||
** Event loop pattern
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(let ((be (detect-backend)))
|
||||
(initialize-backend be)
|
||||
(loop with running = t
|
||||
while running
|
||||
do (backend-clear be)
|
||||
;; ... draw frame ...
|
||||
(finish-output *standard-output*)
|
||||
(let ((event (read-event be)))
|
||||
(typecase event
|
||||
(key-event
|
||||
(when (eql (key-event-key event) :escape)
|
||||
(setf running nil)))
|
||||
(mouse-event
|
||||
;; handle mouse
|
||||
))
|
||||
(when (eq event :eof) (setf running nil))))
|
||||
(shutdown-backend be))
|
||||
#+END_SRC
|
||||
|
||||
** Layout system
|
||||
|
||||
Pure CL flexbox layout engine. No C dependencies, no Yoga FFI.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
;; Macros build layout-trees:
|
||||
(vbox (:gap 1 :padding 1)
|
||||
(header "Title")
|
||||
(hbox (:grow 1)
|
||||
(sidebar (:width 30) ...)
|
||||
(content ...)))
|
||||
#+END_SRC
|
||||
|
||||
Layout properties: ~:direction~ (~:row~ / ~:column~), ~:grow~, ~:shrink~,
|
||||
~:basis~, ~:gap~, ~:padding~, ~:margin~, ~:width~, ~:height~, ~:wrap~.
|
||||
|
||||
See ~src/layout/layout.lisp~ or ~org/layout-engine.org~ for the full API.
|
||||
|
||||
** Rendering pipeline
|
||||
|
||||
Component trees render through a coordinated pipeline:
|
||||
|
||||
1. *Layout pass* — ~compute-layout~ traverses dirty branches, solves flex constraints
|
||||
2. *Render dispatch* — ~render~ generic dispatches per component type
|
||||
3. *Framebuffer* — (optional) ~make-framebuffer-backend~ captures to a cell array,
|
||||
~diff-framebuffers~ computes minimal changes, ~flush-framebuffer~ writes only
|
||||
changed cells
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
;; Full pipeline with framebuffer
|
||||
(let* ((fb-be (make-framebuffer-backend :width 80 :height 24))
|
||||
(fb (fb-framebuffer fb-be)))
|
||||
(render my-component fb-be)
|
||||
(flush-framebuffer prev-fb fb real-backend))
|
||||
#+END_SRC
|
||||
|
||||
* Components
|
||||
|
||||
| Component | What it does | Status |
|
||||
|-------------+------------------------------------------------------+--------|
|
||||
| Box | Bordered container with background, title | stable |
|
||||
| Text | Styled text with word-wrap, spans | stable |
|
||||
| ScrollBox | Scrollable viewport with scrollbars | stable |
|
||||
| TabBar | Horizontal tab navigation | stable |
|
||||
| Select | Dropdown with fuzzy filter, category headers | stable |
|
||||
| TextInput | Single-line text input with readline keybindings | stable |
|
||||
| TextArea | Multi-line input with undo/redo, cursor movement | stable |
|
||||
| Markdown | Renders markdown with syntax highlighting + diffs | stable |
|
||||
| Dialog | Modal overlays with stack management | stable |
|
||||
| Toast | Transient notifications (info/success/warning/error) | stable |
|
||||
| Mouse | Event handlers, hit-testing, text selection | stable |
|
||||
| Slot | Plugin system — named slots for extensible UI | stable |
|
||||
|
||||
Each component follows a consistent pattern:
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
;; 1. Create — factory function returns instance
|
||||
(let ((input (make-text-input :placeholder "Type here..."))
|
||||
(box (make-box :border-style :single :title "My Box")))
|
||||
|
||||
;; 2. Layout — macros compose components
|
||||
(vbox (:gap 1)
|
||||
box
|
||||
(hbox (:grow 1)
|
||||
input
|
||||
(make-select :options '((:title "Option A") (:title "Option B")))))
|
||||
|
||||
;; 3. Render — dispatches through the component protocol
|
||||
(render my-component backend))
|
||||
#+END_SRC
|
||||
|
||||
*** Box
|
||||
|
||||
Bordered container. Draws borders using Unicode box-drawing characters
|
||||
(modern) or ASCII ~+~/~-~/~|~ (simple). Supports background fill, titled
|
||||
borders. See ~org/box-renderable.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-box &key (border-style :single) title (title-align :left) fg bg width height)
|
||||
#+END_SRC
|
||||
|
||||
*** Text
|
||||
|
||||
Styled text with inline spans and word wrapping. Spans support per-run
|
||||
attributes (bold, italic, underline, fg, bg). See ~org/box-renderable.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-text content &key fg bg wrap-mode width height spans)
|
||||
;; Span example:
|
||||
(span "hello" :bold t :fg :bright-yellow)
|
||||
#+END_SRC
|
||||
|
||||
*** TextInput
|
||||
|
||||
Single-line text editor with emacs-style keybindings. Supports placeholder,
|
||||
max-length, on-submit callback. See ~org/text-input.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-text-input &key value cursor placeholder max-length on-submit)
|
||||
;; Widget logic (input-level, no backend needed):
|
||||
(handle-text-input input (make-key-event :key :a :code (char-code #\a)))
|
||||
#+END_SRC
|
||||
|
||||
*** TextArea
|
||||
|
||||
Multi-line text editor. Supports undo/redo (Ctrl+Z/Y), cursor movement,
|
||||
line joining on backspace. See ~org/text-input.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-textarea &key value on-submit)
|
||||
#+END_SRC
|
||||
|
||||
*** ScrollBox
|
||||
|
||||
Scrollable viewport with a list of children. Only renders children
|
||||
intersecting the visible area (viewport culling). Scrollbars drawn
|
||||
at the right/bottom edges. See ~org/scrollbox.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-scroll-box &key children scroll-y scroll-x sticky-scroll-p)
|
||||
(scroll-by sb dy dx)
|
||||
#+END_SRC
|
||||
|
||||
*** TabBar
|
||||
|
||||
Horizontal tab navigation. Renders tab labels, highlights active tab.
|
||||
Left/right arrows cycle through tabs. See ~org/tabbar.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-tab-bar &key tabs active)
|
||||
(tab-bar-add tb id title)
|
||||
(tab-bar-next tb) / (tab-bar-prev tb)
|
||||
(tab-bar-handle-key tb event)
|
||||
#+END_SRC
|
||||
|
||||
*** Select
|
||||
|
||||
Dropdown/filter widget. Options can have categories (rendered as
|
||||
non-selectable headers). Fuzzy fallback: matching > 30% character
|
||||
overlap. Arrow keys navigate, Enter selects. See ~org/select.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(make-select &key options filter on-select)
|
||||
;; Options format: (:title "Name" :category "Group") or (:title "Name")
|
||||
#+END_SRC
|
||||
|
||||
*** Markdown
|
||||
|
||||
Parsed markdown AST with rendering. Supports headings, paragraphs,
|
||||
bold, italic, inline code, links, code blocks with syntax highlighting,
|
||||
diff blocks, blockquotes, lists, thematic breaks. See
|
||||
~org/markdown-renderer.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(render-markdown "# Hello\n\nThis is **bold**.")
|
||||
#+END_SRC
|
||||
|
||||
*** Dialog + Toast
|
||||
|
||||
Modal dialog stack. ~alert-dialog~, ~confirm-dialog~, ~select-dialog~,
|
||||
~prompt-dialog~ are convenience constructors. Toasts are transient
|
||||
notifications that auto-dismiss. See ~org/dialog.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(push-dialog (make-instance 'dialog :size :medium))
|
||||
(alert-dialog "Notice" "Operation complete")
|
||||
(toast "Saved!" :variant :success)
|
||||
#+END_SRC
|
||||
|
||||
*** Mouse
|
||||
|
||||
Mixin class providing mouse event handler slots. ~hit-test~ finds the
|
||||
deepest component at a coordinate. Text selection tracks drag gestures.
|
||||
Scrollboxes integrate wheel events. See ~org/mouse.org~.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(defclass my-panel (mouse-mixin) ...)
|
||||
(handle-mouse-event component mouse-event)
|
||||
(hit-test root x y) → deepest matching component
|
||||
#+END_SRC
|
||||
|
||||
*** Slot system
|
||||
|
||||
Plugin system for extensible rendering slots. Register named rendering
|
||||
functions, then render them by slot name. Useful for toolbars, status
|
||||
bars, and plugin architectures.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(defslot :status-bar :order 0
|
||||
(lambda (&rest args)
|
||||
(draw-text backend 0 0 "Ready" :text-muted nil)))
|
||||
(slot-render :status-bar)
|
||||
#+END_SRC
|
||||
|
||||
* Backend features
|
||||
|
||||
| Feature | modern | simple |
|
||||
|-------------------+--------+--------|
|
||||
| Truecolor (24-bit)| Yes | No |
|
||||
| Bold/italic | Yes | No |
|
||||
| OSC 8 hyperlinks | Yes | No |
|
||||
| DECICM sync | Yes | No |
|
||||
| SGR mouse | Yes | No |
|
||||
| Kitty keyboard | Yes | No |
|
||||
| Box drawing chars | Unicode| ASCII |
|
||||
| Pipe-safe | No | Yes |
|
||||
|
||||
Backend selection happens automatically via ~detect-backend~. It checks:
|
||||
|
||||
1. Is stdout a TTY? (if not → simple-backend)
|
||||
2. Does ~COLORTERM~ contain "truecolor" or "24bit"?
|
||||
3. Send DA1 query — does the terminal respond with modern feature codes?
|
||||
|
||||
Result is cached in ~*detected-backend*~.
|
||||
|
||||
* Development
|
||||
|
||||
#+BEGIN_SRC bash
|
||||
# Run all tests
|
||||
sbcl --script run-all-tests.lisp
|
||||
|
||||
# Run interactive demo
|
||||
sbcl --script demo.lisp
|
||||
|
||||
# Tangle org files (regenerate .lisp from .org sources)
|
||||
python3 ~/.hermes/skills/software-development/org-babel-tangle/scripts/tangle.py org/*.org
|
||||
|
||||
# Verify syntax of all tangled files
|
||||
for f in src/**/*.lisp tests/*.lisp; do
|
||||
sbcl --eval "(with-open-file (s \"$f\") (loop for e = (read s nil s) until (eq e s)))" \
|
||||
--eval "(format t \"~a: OK~%\" \"$f\")" --quit 2>/dev/null
|
||||
done
|
||||
#+END_SRC
|
||||
|
||||
Literate programming: every ~.lisp~ file in ~src/~ and ~tests/~ is a generated
|
||||
artifact from an ~.org~ file in ~org/~. The org files are the source of truth.
|
||||
Each function has its own code block with prose explaining the design reasoning.
|
||||
Delete every ~.lisp~ file and they can all be regenerated by tangling the org files.
|
||||
|
||||
Project structure:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
cl-tty/
|
||||
├── cl-tty.asd # ASDF system definition
|
||||
├── demo.lisp # Interactive demo
|
||||
├── run-all-tests.lisp # Test runner
|
||||
├── src/
|
||||
│ ├── backend/ # Backend protocol + implementations
|
||||
│ │ ├── package.lisp, classes.lisp
|
||||
│ │ ├── simple.lisp, modern.lisp
|
||||
│ │ └── detection.lisp
|
||||
│ ├── layout/ # Flexbox layout engine
|
||||
│ │ └── layout.lisp
|
||||
│ ├── rendering/ # Framebuffer diffing pipeline
|
||||
│ │ └── framebuffer.lisp
|
||||
│ └── components/ # Widget library
|
||||
│ ├── package.lisp, dirty.lisp, render.lisp, theme.lisp
|
||||
│ ├── box.lisp, text.lisp
|
||||
│ ├── input-package.lisp, input.lisp
|
||||
│ ├── text-input.lisp, textarea.lisp, keybindings.lisp
|
||||
│ ├── container-package.lisp, scrollbox.lisp, tabbar.lisp
|
||||
│ ├── select-package.lisp, select.lisp
|
||||
│ ├── markdown-package.lisp, markdown.lisp
|
||||
│ ├── dialog-package.lisp, dialog.lisp
|
||||
│ ├── mouse-package.lisp, mouse.lisp
|
||||
│ └── slot-package.lisp, slot.lisp
|
||||
├── tests/ # FiveAM test files
|
||||
│ ├── input-tests.lisp, scrollbox-tabbar-tests.lisp
|
||||
│ ├── select-tests.lisp, markdown-tests.lisp
|
||||
│ ├── dialog-tests.lisp, mouse-tests.lisp, slot-tests.lisp
|
||||
│ ├── framebuffer-tests.lisp, integration-tests.lisp
|
||||
│ ├── box-tests.lisp, dirty-tests.lisp, render-tests.lisp
|
||||
│ └── theme-tests.lisp
|
||||
├── org/ # Literate source (all .lisp files come from here)
|
||||
│ ├── package.org, dirty.org, render.org, theme.org
|
||||
│ ├── box-renderable.org
|
||||
│ ├── text-input.org
|
||||
│ ├── scrollbox.org, tabbar.org, container-package.org
|
||||
│ ├── select.org
|
||||
│ ├── markdown-renderer.org
|
||||
│ ├── dialog.org
|
||||
│ ├── mouse.org
|
||||
│ ├── slot.org
|
||||
│ ├── backend-protocol.org, modern-backend.org, detection.org
|
||||
│ ├── layout-engine.org
|
||||
│ ├── framebuffer.org
|
||||
│ └── integration-tests.org
|
||||
├── docs/
|
||||
│ ├── ROADMAP.org
|
||||
│ └── ARCHITECTURE.org
|
||||
└── demo/ # Demo assets (optional)
|
||||
#+END_EXAMPLE
|
||||
|
||||
* License
|
||||
|
||||
GNU General Public License v3.0
|
||||
|
||||
@@ -1,62 +0,0 @@
|
||||
(in-package :cl-tui.backend)
|
||||
|
||||
(defclass backend () ())
|
||||
|
||||
(defgeneric initialize-backend (backend)
|
||||
(:method ((b backend)) b))
|
||||
|
||||
(defgeneric shutdown-backend (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric backend-size (backend)
|
||||
(:method ((b backend))
|
||||
(values 80 24)))
|
||||
|
||||
(defgeneric backend-write (backend string))
|
||||
|
||||
(defgeneric backend-clear (backend)
|
||||
(:method ((b backend))
|
||||
(backend-write b (format nil "~C[2J~C[H" #\Esc #\Esc))))
|
||||
|
||||
(defgeneric draw-text (backend x y string fg bg &key
|
||||
bold italic underline reverse dim blink))
|
||||
|
||||
(defgeneric draw-border (backend x y width height
|
||||
&key style fg bg title title-align))
|
||||
|
||||
(defgeneric draw-rect (backend x y width height &key bg))
|
||||
|
||||
(defgeneric draw-link (backend x y string url &key fg bg))
|
||||
|
||||
(defgeneric draw-ellipsis (backend x y width &key fg bg))
|
||||
|
||||
(defgeneric cursor-move (backend x y))
|
||||
|
||||
(defgeneric cursor-hide (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric cursor-show (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric cursor-style (backend shape &key blink)
|
||||
(:method ((b backend) shape &key blink) (values)))
|
||||
|
||||
(defgeneric begin-sync (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric end-sync (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric read-event (backend &key timeout)
|
||||
(:method ((b backend) &key timeout) (values nil nil)))
|
||||
|
||||
(defgeneric enable-mouse (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric enable-bracketed-paste (backend)
|
||||
(:method ((b backend)) (values)))
|
||||
|
||||
(defgeneric capable-p (backend feature)
|
||||
(:method ((b backend) feature)
|
||||
(declare (ignore feature))
|
||||
nil))
|
||||
@@ -1,124 +0,0 @@
|
||||
(defpackage :cl-tui-modern-backend-test
|
||||
(:use :cl :fiveam :cl-tui.backend)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tui-modern-backend-test)
|
||||
|
||||
(def-suite modern-backend-suite :description "Modern backend tests")
|
||||
(in-suite modern-backend-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'modern-backend-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
|
||||
;; ── Constructor ────────────────────────────────────────────────
|
||||
|
||||
(test make-modern-backend-creates
|
||||
"make-modern-backend returns a modern-backend instance"
|
||||
(let ((b (make-modern-backend)))
|
||||
(is (typep b 'cl-tui.backend::modern-backend))))
|
||||
|
||||
;; ── Escape Generation ──────────────────────────────────────────
|
||||
|
||||
(test sgr-truecolor-foreground
|
||||
"SGR truecolor foreground escape is correct"
|
||||
(is (equal (cl-tui.backend::sgr-fg "#FFD700")
|
||||
(format nil "~C[38;2;255;215;0m" #\Esc))))
|
||||
|
||||
(test sgr-truecolor-background
|
||||
"SGR truecolor background escape is correct"
|
||||
(is (equal (cl-tui.backend::sgr-bg "#1a1b26")
|
||||
(format nil "~C[48;2;26;27;38m" #\Esc))))
|
||||
|
||||
(test sgr-named-colors
|
||||
"SGR named colors resolve to 8-color codes"
|
||||
(is (equal (cl-tui.backend::sgr-fg :red)
|
||||
(format nil "~C[31m" #\Esc)))
|
||||
(is (equal (cl-tui.backend::sgr-bg :blue)
|
||||
(format nil "~C[44m" #\Esc))))
|
||||
|
||||
(test sgr-bold-italic
|
||||
"SGR attribute escapes are correct"
|
||||
(is (equal (cl-tui.backend::sgr-attr :bold) (format nil "~C[1m" #\Esc)))
|
||||
(is (equal (cl-tui.backend::sgr-attr :italic) (format nil "~C[3m" #\Esc)))
|
||||
(is (equal (cl-tui.backend::sgr-attr :underline) (format nil "~C[4m" #\Esc)))
|
||||
(is (equal (cl-tui.backend::sgr-attr :reset) (format nil "~C[0m" #\Esc))))
|
||||
|
||||
;; ── Cursor ─────────────────────────────────────────────────────
|
||||
|
||||
(test cursor-move-escape
|
||||
"cursor-move generates correct CSI escape"
|
||||
(let ((b (make-modern-backend)))
|
||||
(is (equal (cl-tui.backend::cursor-move-escape 5 10)
|
||||
(format nil "~C[11;6H" #\Esc)))))
|
||||
|
||||
(test cursor-style-block
|
||||
"cursor-style :block generate correct escape"
|
||||
(let ((b (make-modern-backend)))
|
||||
(is (equal (cl-tui.backend::cursor-style-escape :block nil)
|
||||
(format nil "~C[2 q" #\Esc)))))
|
||||
|
||||
(test cursor-style-bar
|
||||
"cursor-style :bar generate correct escape"
|
||||
(let ((b (make-modern-backend)))
|
||||
(is (equal (cl-tui.backend::cursor-style-escape :bar nil)
|
||||
(format nil "~C[6 q" #\Esc)))))
|
||||
|
||||
(test cursor-style-underline-blink
|
||||
"cursor-style :underline with blink"
|
||||
(let ((b (make-modern-backend)))
|
||||
(is (equal (cl-tui.backend::cursor-style-escape :underline t)
|
||||
(format nil "~C[5 q" #\Esc)))))
|
||||
|
||||
;; ── Synchronization ────────────────────────────────────────────
|
||||
|
||||
(test decicm-escapes
|
||||
"DECICM synchronized update escapes"
|
||||
(is (equal (cl-tui.backend::decicm-begin) (format nil "~C[?2026h" #\Esc)))
|
||||
(is (equal (cl-tui.backend::decicm-end) (format nil "~C[?2026l" #\Esc))))
|
||||
|
||||
;; ── OSC 8 Hyperlinks ──────────────────────────────────────────
|
||||
|
||||
(test osc8-escape
|
||||
"OSC 8 hyperlink escape wraps text"
|
||||
(is (equal (cl-tui.backend::osc8-link "http://example.com" "click here")
|
||||
(format nil "~C]8;;http://example.com~C\\click here~C]8;;~C\\"
|
||||
#\Esc #\Esc #\Esc #\Esc))))
|
||||
|
||||
;; ── Hex Parsing ────────────────────────────────────────────────
|
||||
|
||||
(test hex-color-parsing
|
||||
"hex-to-rgb parses valid hex colors"
|
||||
(multiple-value-bind (r g b) (cl-tui.backend::hex-to-rgb "#FFD700")
|
||||
(is (= r 255))
|
||||
(is (= g 215))
|
||||
(is (= b 0))))
|
||||
|
||||
(test hex-color-black
|
||||
"hex-to-rgb parses black"
|
||||
(multiple-value-bind (r g b) (cl-tui.backend::hex-to-rgb "#000000")
|
||||
(is (= r 0))
|
||||
(is (= g 0))
|
||||
(is (= b 0))))
|
||||
|
||||
(test hex-color-short-form
|
||||
"hex-to-rgb parses 3-digit hex"
|
||||
(multiple-value-bind (r g b) (cl-tui.backend::hex-to-rgb "#F00")
|
||||
(is (= r 255))
|
||||
(is (= g 0))
|
||||
(is (= b 0))))
|
||||
|
||||
;; ── Border Characters ──────────────────────────────────────────
|
||||
|
||||
(test border-char-rounded
|
||||
"modern-border-char returns Unicode box-drawing for rounded style"
|
||||
(is (equal (cl-tui.backend::border-char :rounded :top-left) "╭"))
|
||||
(is (equal (cl-tui.backend::border-char :rounded :horizontal) "─"))
|
||||
(is (equal (cl-tui.backend::border-char :rounded :vertical) "│"))
|
||||
(is (equal (cl-tui.backend::border-char :rounded :bottom-right) "╯")))
|
||||
|
||||
(test border-char-double
|
||||
"modern-border-char returns double-line chars"
|
||||
(is (equal (cl-tui.backend::border-char :double :top-left) "╔"))
|
||||
(is (equal (cl-tui.backend::border-char :double :horizontal) "═"))
|
||||
(is (equal (cl-tui.backend::border-char :double :vertical) "║")))
|
||||
@@ -1,246 +0,0 @@
|
||||
;;; modern-backend — Raw escape sequence backend
|
||||
;;; Generated from org/modern-backend.org
|
||||
;;; DO NOT EDIT — edit the .org file instead
|
||||
|
||||
;; In package.lisp, add to :export:
|
||||
;; #:modern-backend #:make-modern-backend
|
||||
;; Internal symbols (not exported, used by tests):
|
||||
;; sgr-fg sgr-bg sgr-attr cursor-move-escape cursor-style-escape
|
||||
;; decicm-begin decicm-end osc8-link hex-to-rgb border-char
|
||||
|
||||
(in-package :cl-tui.backend)
|
||||
|
||||
(defun hex-to-rgb (hex)
|
||||
"Parse a hex color string like \"#FFD700\" into (values r g b).
|
||||
Also handles 3-digit hex like \"#F00\" (expands to \"#FF0000\")."
|
||||
(let ((clean (string-trim '(#\# #\Space) hex)))
|
||||
(if (= (length clean) 3)
|
||||
;; Expand 3-digit: #F00 -> #FF0000
|
||||
(let* ((r (parse-integer (subseq clean 0 1) :radix 16 :junk-allowed t))
|
||||
(g (parse-integer (subseq clean 1 2) :radix 16 :junk-allowed t))
|
||||
(b (parse-integer (subseq clean 2 3) :radix 16 :junk-allowed t)))
|
||||
(values (+ r (* r 16)) (+ g (* g 16)) (+ b (* b 16))))
|
||||
(values (parse-integer (subseq clean 0 2) :radix 16 :junk-allowed t)
|
||||
(parse-integer (subseq clean 2 4) :radix 16 :junk-allowed t)
|
||||
(parse-integer (subseq clean 4 6) :radix 16 :junk-allowed t)))))
|
||||
|
||||
(defparameter *named-colors*
|
||||
'((:black . 0) (:red . 1) (:green . 2) (:yellow . 3)
|
||||
(:blue . 4) (:magenta . 5) (:cyan . 6) (:white . 7)))
|
||||
|
||||
(defun sgr-fg (color)
|
||||
"Return SGR foreground escape for COLOR.
|
||||
Color can be a hex string, a keyword name, or nil."
|
||||
(if (null color) ""
|
||||
(cond ((and (stringp color) (char= (char color 0) #\#))
|
||||
(multiple-value-bind (r g b) (hex-to-rgb color)
|
||||
(format nil "~C[38;2;~d;~d;~dm" #\Esc r g b)))
|
||||
((keywordp color)
|
||||
(let ((index (cdr (assoc color *named-colors*))))
|
||||
(if index
|
||||
(format nil "~C[~dm" #\Esc (+ 30 index))
|
||||
"")))
|
||||
(t ""))))
|
||||
|
||||
(defun sgr-bg (color)
|
||||
"Return SGR background escape for COLOR."
|
||||
(if (null color) ""
|
||||
(cond ((and (stringp color) (char= (char color 0) #\#))
|
||||
(multiple-value-bind (r g b) (hex-to-rgb color)
|
||||
(format nil "~C[48;2;~d;~d;~dm" #\Esc r g b)))
|
||||
((keywordp color)
|
||||
(let ((index (cdr (assoc color *named-colors*))))
|
||||
(if index
|
||||
(format nil "~C[~dm" #\Esc (+ 40 index))
|
||||
"")))
|
||||
(t ""))))
|
||||
|
||||
(defparameter *sgr-attr-codes*
|
||||
'((:bold . 1) (:dim . 2) (:italic . 3) (:underline . 4)
|
||||
(:blink . 5) (:reverse . 7) (:reset . 0)))
|
||||
|
||||
(defun sgr-attr (attr)
|
||||
"Return SGR attribute escape for ATTR keyword."
|
||||
(let ((code (cdr (assoc attr *sgr-attr-codes*))))
|
||||
(if code
|
||||
(format nil "~C[~dm" #\Esc code)
|
||||
"")))
|
||||
|
||||
(defun cursor-move-escape (x y)
|
||||
"Return CSI escape to move cursor to (x, y), 1-indexed."
|
||||
(format nil "~C[~d;~dH" #\Esc (1+ y) (1+ x)))
|
||||
|
||||
(defun cursor-style-escape (shape blink)
|
||||
"Return DECSTR escape for cursor shape.
|
||||
:block = 2, :underline = 4, :bar = 6.
|
||||
Add 1 for blink variants."
|
||||
(let* ((base (case shape
|
||||
(:block 2) (:underline 4) (:bar 6)
|
||||
(t 2)))
|
||||
(code (if blink (1+ base) base)))
|
||||
(format nil "~C[~d q" #\Esc code)))
|
||||
|
||||
(defun decicm-begin ()
|
||||
"Return escape to enable synchronized updates."
|
||||
(format nil "~C[?2026h" #\Esc))
|
||||
|
||||
(defun decicm-end ()
|
||||
"Return escape to disable synchronized updates."
|
||||
(format nil "~C[?2026l" #\Esc))
|
||||
|
||||
(defun osc8-link (url text)
|
||||
"Wrap TEXT in an OSC 8 hyperlink to URL."
|
||||
(format nil "~C]8;;~A~C\\~A~C]8;;~C\\"
|
||||
#\Esc url #\Esc text #\Esc #\Esc))
|
||||
|
||||
(defparameter *border-chars*
|
||||
'(((:single :top-left) . "┌") ((:single :top-right) . "┐")
|
||||
((:single :bottom-left) . "└") ((:single :bottom-right) . "┘")
|
||||
((:single :horizontal) . "─") ((:single :vertical) . "│")
|
||||
((:double :top-left) . "╔") ((:double :top-right) . "╗")
|
||||
((:double :bottom-left) . "╚") ((:double :bottom-right) . "╝")
|
||||
((:double :horizontal) . "═") ((:double :vertical) . "║")
|
||||
((:rounded :top-left) . "╭") ((:rounded :top-right) . "╮")
|
||||
((:rounded :bottom-left) . "╰") ((:rounded :bottom-right) . "╯")
|
||||
((:rounded :horizontal) . "─") ((:rounded :vertical) . "│")))
|
||||
|
||||
(defun border-char (style pos)
|
||||
"Return the Unicode box-drawing character for STYLE at POS."
|
||||
(let ((char (cdr (assoc (list style pos) *border-chars* :test #'equal))))
|
||||
(or char (if (member pos '(:horizontal :vertical))
|
||||
(case pos (:horizontal "─") (:vertical "│"))
|
||||
"+"))))
|
||||
|
||||
(defclass modern-backend (backend)
|
||||
((output-stream :initform *standard-output*
|
||||
:initarg :output-stream
|
||||
:accessor backend-output-stream)
|
||||
(in-sync-p :initform nil :accessor in-sync-p)))
|
||||
|
||||
(defun make-modern-backend (&key color-palette output-stream)
|
||||
(declare (ignore color-palette))
|
||||
(make-instance 'modern-backend :output-stream (or output-stream *standard-output*)))
|
||||
|
||||
(defmethod initialize-backend ((b modern-backend))
|
||||
;; Enter raw mode, enable mouse, bracketed paste
|
||||
(backend-write b (format nil "~C[?1049h" #\Esc)) ; alt screen
|
||||
(backend-write b (format nil "~C[?1000h" #\Esc)) ; mouse basic
|
||||
(backend-write b (format nil "~C[?1002h" #\Esc)) ; mouse drag
|
||||
(backend-write b (format nil "~C[?1006h" #\Esc)) ; SGR mouse
|
||||
(backend-write b (format nil "~C[?2004h" #\Esc)) ; bracketed paste
|
||||
(cursor-hide b)
|
||||
(finish-output (backend-output-stream b))
|
||||
b)
|
||||
|
||||
(defmethod shutdown-backend ((b modern-backend))
|
||||
(cursor-show b)
|
||||
(backend-write b (format nil "~C[?2004l" #\Esc)) ; disable bracketed paste
|
||||
(backend-write b (format nil "~C[?1006l" #\Esc)) ; disable SGR mouse
|
||||
(backend-write b (format nil "~C[?1002l" #\Esc))
|
||||
(backend-write b (format nil "~C[?1000l" #\Esc))
|
||||
(backend-write b (format nil "~C[?1049l" #\Esc)) ; normal screen
|
||||
(finish-output (backend-output-stream b))
|
||||
(values))
|
||||
|
||||
(defmethod backend-size ((b modern-backend))
|
||||
;; Default fallback — real implementation queries terminal
|
||||
(values 80 24))
|
||||
|
||||
(defmethod backend-write ((b modern-backend) string)
|
||||
(let ((stream (backend-output-stream b)))
|
||||
(write-string string stream)
|
||||
(length string)))
|
||||
|
||||
(defmethod capable-p ((b modern-backend) feature)
|
||||
(member feature '(:truecolor :osc8 :sync :mouse
|
||||
:bracketed-paste :cursor-style
|
||||
:kitty-keyboard)))
|
||||
|
||||
(defmethod draw-text ((b modern-backend) x y string fg bg
|
||||
&key bold italic underline reverse dim blink)
|
||||
(let ((parts (list (cursor-move-escape x y)
|
||||
(sgr-fg fg) (sgr-bg bg)
|
||||
(when bold (sgr-attr :bold))
|
||||
(when italic (sgr-attr :italic))
|
||||
(when underline (sgr-attr :underline))
|
||||
(when reverse (sgr-attr :reverse))
|
||||
(when dim (sgr-attr :dim))
|
||||
(when blink (sgr-attr :blink))
|
||||
string
|
||||
(sgr-attr :reset))))
|
||||
(backend-write b (apply #'concatenate 'string parts))))
|
||||
|
||||
(defmethod draw-border ((b modern-backend) x y width height
|
||||
&key style fg bg title title-align)
|
||||
(declare (ignore title title-align))
|
||||
(let* ((s (or style :single))
|
||||
(tl (border-char s :top-left))
|
||||
(tr (border-char s :top-right))
|
||||
(bl (border-char s :bottom-left))
|
||||
(br (border-char s :bottom-right))
|
||||
(h (border-char s :horizontal))
|
||||
(v (border-char s :vertical))
|
||||
(fg-esc (sgr-fg fg))
|
||||
(bg-esc (sgr-bg bg))
|
||||
(reset (sgr-attr :reset))
|
||||
(top (concatenate 'string
|
||||
fg-esc bg-esc tl
|
||||
(make-string (- width 2) :initial-element (char h 0))
|
||||
tr reset (string #\Newline)))
|
||||
(mid (concatenate 'string
|
||||
fg-esc bg-esc v
|
||||
(make-string (- width 2) :initial-element #\Space)
|
||||
v reset (string #\Newline)))
|
||||
(bot (concatenate 'string
|
||||
fg-esc bg-esc bl
|
||||
(make-string (- width 2) :initial-element (char h 0))
|
||||
br reset)))
|
||||
(backend-write b top)
|
||||
(loop repeat (- height 2) do (backend-write b mid))
|
||||
(backend-write b bot)))
|
||||
|
||||
(defmethod draw-rect ((b modern-backend) x y width height &key bg)
|
||||
(let* ((bg-esc (sgr-bg bg))
|
||||
(reset (sgr-attr :reset))
|
||||
(line (concatenate 'string
|
||||
bg-esc
|
||||
(make-string width :initial-element #\Space)
|
||||
reset (string #\Newline))))
|
||||
(loop :for row :from 0 :below height :do
|
||||
(backend-write b (cursor-move-escape x (+ y row)))
|
||||
(backend-write b line))))
|
||||
|
||||
(defmethod draw-link ((b modern-backend) x y string url
|
||||
&key fg bg)
|
||||
(let ((parts (list (cursor-move-escape x y)
|
||||
(sgr-fg fg) (sgr-bg bg)
|
||||
(osc8-link url string)
|
||||
(sgr-attr :reset))))
|
||||
(backend-write b (apply #'concatenate 'string parts))))
|
||||
|
||||
(defmethod draw-ellipsis ((b modern-backend) x y width
|
||||
&key fg bg)
|
||||
(let ((dots "..."))
|
||||
(draw-text b x y dots fg bg)))
|
||||
|
||||
(defmethod cursor-move ((b modern-backend) x y)
|
||||
(backend-write b (cursor-move-escape x y)))
|
||||
|
||||
(defmethod cursor-hide ((b modern-backend))
|
||||
(backend-write b (format nil "~C[?25l" #\Esc)))
|
||||
|
||||
(defmethod cursor-show ((b modern-backend))
|
||||
(backend-write b (format nil "~C[?25h" #\Esc)))
|
||||
|
||||
(defmethod cursor-style ((b modern-backend) shape &key blink)
|
||||
(backend-write b (cursor-style-escape shape blink)))
|
||||
|
||||
(defmethod begin-sync ((b modern-backend))
|
||||
(setf (in-sync-p b) t)
|
||||
(backend-write b (decicm-begin)))
|
||||
|
||||
(defmethod end-sync ((b modern-backend))
|
||||
(setf (in-sync-p b) nil)
|
||||
(backend-write b (decicm-end))
|
||||
(finish-output (backend-output-stream b)))
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
(defpackage :cl-tui.backend
|
||||
(:use :cl)
|
||||
(:export
|
||||
;; Backend classes
|
||||
#:backend #:simple-backend
|
||||
;; Lifecycle
|
||||
#:initialize-backend #:shutdown-backend
|
||||
#:backend-size #:backend-write #:backend-clear
|
||||
;; Drawing
|
||||
#:draw-text #:draw-border #:draw-rect
|
||||
#:draw-link #:draw-ellipsis
|
||||
;; Cursor
|
||||
#:cursor-move #:cursor-hide #:cursor-show #:cursor-style
|
||||
;; Sync
|
||||
#:begin-sync #:end-sync
|
||||
;; Input
|
||||
#:read-event #:enable-mouse #:enable-bracketed-paste
|
||||
;; Queries
|
||||
#:capable-p
|
||||
;; Constructors
|
||||
#:make-simple-backend
|
||||
;; Modern backend
|
||||
#:modern-backend #:make-modern-backend
|
||||
;; Internal (for testing)
|
||||
#:sgr-fg #:sgr-bg #:sgr-attr
|
||||
#:cursor-move-escape #:cursor-style-escape
|
||||
#:decicm-begin #:decicm-end #:osc8-link
|
||||
#:hex-to-rgb #:border-char))
|
||||
(in-package :cl-tui.backend)
|
||||
@@ -1,69 +0,0 @@
|
||||
(in-package :cl-tui.backend)
|
||||
|
||||
(defclass simple-backend (backend)
|
||||
((output-stream :initform *standard-output*
|
||||
:initarg :output-stream
|
||||
:accessor backend-output-stream)))
|
||||
|
||||
(defun make-simple-backend (&key output-stream)
|
||||
(make-instance 'simple-backend
|
||||
:output-stream (or output-stream *standard-output*)))
|
||||
|
||||
(defmethod initialize-backend ((b simple-backend))
|
||||
b)
|
||||
|
||||
(defmethod shutdown-backend ((b simple-backend))
|
||||
(values))
|
||||
|
||||
(defmethod backend-size ((b simple-backend))
|
||||
;; Try ioctl, fall back to 80x24
|
||||
(values 80 24))
|
||||
|
||||
(defmethod backend-write ((b simple-backend) string)
|
||||
(let ((stream (backend-output-stream b)))
|
||||
(write-string string stream)
|
||||
(finish-output stream)
|
||||
(length string)))
|
||||
|
||||
(defmethod draw-text ((b simple-backend) x y string fg bg
|
||||
&key bold italic underline reverse dim blink)
|
||||
(declare (ignore x y fg bg bold italic underline reverse dim blink))
|
||||
(backend-write b string))
|
||||
|
||||
(defun %simple-border-char (edge-style pos)
|
||||
"Return ASCII border character for EDGE-STYLE at POS.
|
||||
POS is :top-left, :top-right, :bottom-left, :bottom-right,
|
||||
:horizontal, or :vertical."
|
||||
(case pos
|
||||
((:top-left :top-right :bottom-left :bottom-right) #\+)
|
||||
(:horizontal #\-)
|
||||
(:vertical #\|)))
|
||||
|
||||
(defmethod draw-border ((b simple-backend) x y width height
|
||||
&key style fg bg title title-align)
|
||||
(declare (ignore style fg bg title title-align))
|
||||
(let ((h (%simple-border-char nil :horizontal))
|
||||
(v (%simple-border-char nil :vertical)))
|
||||
;; Top edge
|
||||
(backend-write b (format nil "~%~v@{~a~:*~}" width h))
|
||||
;; Sides
|
||||
(loop for i from 1 below (1- height)
|
||||
do (backend-write b (format nil "~%|~v@{~a~:*~}|" (- width 2) #\space)))
|
||||
;; Bottom edge
|
||||
(backend-write b (format nil "~%~v@{~a~:*~}" width h))))
|
||||
|
||||
(defmethod draw-rect ((b simple-backend) x y width height
|
||||
&key bg)
|
||||
(declare (ignore x y width height bg))
|
||||
;; On simple backend, background fill is a no-op
|
||||
(values))
|
||||
|
||||
(defmethod draw-link ((b simple-backend) x y string url
|
||||
&key fg bg)
|
||||
(declare (ignore url fg bg))
|
||||
(draw-text b x y string nil nil))
|
||||
|
||||
(defmethod draw-ellipsis ((b simple-backend) x y width
|
||||
&key fg bg)
|
||||
(declare (ignore x y width fg bg))
|
||||
(backend-write b "..."))
|
||||
@@ -1,138 +0,0 @@
|
||||
(defpackage :cl-tui-backend-test
|
||||
(:use :cl :fiveam :cl-tui.backend)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tui-backend-test)
|
||||
|
||||
(def-suite backend-suite :description "Backend protocol tests")
|
||||
(in-suite backend-suite)
|
||||
|
||||
;; ── Helpers ─────────────────────────────────────────────────────
|
||||
|
||||
(defun make-capturing-backend ()
|
||||
"Create a simple-backend that writes to a string stream."
|
||||
(let* ((s (make-string-output-stream))
|
||||
(b (make-simple-backend :output-stream s)))
|
||||
(values b s)))
|
||||
|
||||
;; ── Simple Backend ──────────────────────────────────────────────
|
||||
|
||||
(defun run-tests ()
|
||||
"Run all backend tests."
|
||||
(let ((result (run 'backend-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
|
||||
(test simple-backend-lifecycle
|
||||
"simple-backend can be created and shut down"
|
||||
(let ((b (make-simple-backend)))
|
||||
(is (typep b 'simple-backend))
|
||||
(initialize-backend b)
|
||||
(is-false (capable-p b :truecolor) "simple backend has no truecolor")
|
||||
(shutdown-backend b)))
|
||||
|
||||
(test simple-backend-draw-text
|
||||
"simple-backend renders text at position, ignoring style"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-text b 0 0 "hello" :red nil :bold t :italic t)
|
||||
(shutdown-backend b)
|
||||
(is (string= (get-output-stream-string s) "hello")
|
||||
"draw-text should output the string ignoring style")))
|
||||
|
||||
(test simple-backend-draw-border
|
||||
"simple-backend draws ASCII border with +-| characters"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-border b 0 0 5 3 :style :single)
|
||||
(shutdown-backend b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "-----" out) "top edge should have 5 dashes")
|
||||
(is (search "| |" out) "middle row should have pipe sides"))))
|
||||
|
||||
(test simple-backend-draw-rounded
|
||||
"simple-backend falls back to straight edges for rounded style"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-border b 0 0 5 3 :style :rounded)
|
||||
(shutdown-backend b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
;; Rounded falls back to ASCII — identical output to single
|
||||
(is (search "-----" out) "rounded style produces same dashes as single"))))
|
||||
|
||||
(test simple-backend-draw-link
|
||||
"simple-backend renders link as plain text"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-link b 0 0 "click me" "http://example.com")
|
||||
(shutdown-backend b)
|
||||
(is (string= (get-output-stream-string s) "click me")
|
||||
"simple-backend ignores URL, outputs text only")))
|
||||
|
||||
(test simple-backend-draw-ellipsis
|
||||
"simple-backend renders ... for ellipsis"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-ellipsis b 0 0 5)
|
||||
(shutdown-backend b)
|
||||
(is (string= (get-output-stream-string s) "...")
|
||||
"ellipsis should output 3 dots")))
|
||||
|
||||
;; ── Backend Capabilities ───────────────────────────────────────
|
||||
|
||||
(test capable-p-known-features
|
||||
"capable-p returns nil for all features on simple-backend"
|
||||
(let ((b (make-simple-backend)))
|
||||
(initialize-backend b)
|
||||
(dolist (f '(:truecolor :osc8 :sync :mouse :bracketed-paste
|
||||
:kitty-keyboard :sixel :cursor-style))
|
||||
(is-false (capable-p b f)
|
||||
(format nil "~s should not be supported on simple-backend" f)))
|
||||
(shutdown-backend b)))
|
||||
|
||||
;; ── Backend Size ───────────────────────────────────────────────
|
||||
|
||||
(test backend-size-returns-integers
|
||||
"backend-size returns two integer values"
|
||||
(let ((b (make-simple-backend)))
|
||||
(initialize-backend b)
|
||||
(multiple-value-bind (cols lines) (backend-size b)
|
||||
(is (integerp cols))
|
||||
(is (integerp lines))
|
||||
(is (>= cols 10))
|
||||
(is (>= lines 3)))
|
||||
(shutdown-backend b)))
|
||||
|
||||
;; ── Backend Protocol: Defaults and No-ops ──────────────────────
|
||||
|
||||
(test default-methods-are-no-ops
|
||||
"Default backend methods don't error"
|
||||
(let ((b (make-simple-backend)))
|
||||
(initialize-backend b)
|
||||
(is (null (multiple-value-list (cursor-hide b))))
|
||||
(is (null (multiple-value-list (cursor-show b))))
|
||||
(is (null (multiple-value-list (cursor-style b :block))))
|
||||
(is (null (multiple-value-list (begin-sync b))))
|
||||
(is (null (multiple-value-list (end-sync b))))
|
||||
(shutdown-backend b)))
|
||||
|
||||
(test sync-is-noop-on-simple
|
||||
"begin-sync and end-sync produce no output on simple-backend"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(begin-sync b)
|
||||
(draw-text b 0 0 "in sync" nil nil)
|
||||
(end-sync b)
|
||||
(shutdown-backend b)
|
||||
(is (string= (get-output-stream-string s) "in sync")
|
||||
"no sync escape sequences should appear")))
|
||||
|
||||
;; ── Draw-rect ──────────────────────────────────────────────────
|
||||
|
||||
(test draw-rect-fills-area-correctly
|
||||
"draw-rect with background writes nothing to output (simple-backend no-op)"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(initialize-backend b)
|
||||
(draw-rect b 0 0 5 3 :bg :red)
|
||||
(shutdown-backend b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"draw-rect is a no-op on simple-backend")))
|
||||
101
cl-tty.asd
Normal file
101
cl-tty.asd
Normal file
@@ -0,0 +1,101 @@
|
||||
;;; cl-tty.asd — Common Lisp Terminal UI Framework
|
||||
(asdf:defsystem :cl-tty
|
||||
:description "Reusable Common Lisp Terminal UI Framework"
|
||||
:author "Amr Gharbeia"
|
||||
:version "1.0.0"
|
||||
:license "GPL-3.0"
|
||||
:depends-on (:sb-posix)
|
||||
:components
|
||||
((:module "src/backend"
|
||||
:components
|
||||
((:file "package")
|
||||
(:file "classes" :depends-on ("package"))
|
||||
(:file "simple" :depends-on ("package" "classes"))
|
||||
(:file "modern" :depends-on ("package" "classes"))
|
||||
(:file "detection" :depends-on ("package" "classes"))))
|
||||
(:module "src/layout"
|
||||
:components
|
||||
((:file "layout")))
|
||||
(:module "src/rendering"
|
||||
:components
|
||||
((:file "framebuffer")))
|
||||
(:module "src/components"
|
||||
:components
|
||||
((:file "package")
|
||||
(:file "dirty")
|
||||
(:file "box" :depends-on ("package"))
|
||||
(:file "text" :depends-on ("package" "box"))
|
||||
(:file "render" :depends-on ("package" "box" "text"))
|
||||
(:file "theme" :depends-on ("package"))
|
||||
;; Input system (v0.5.0)
|
||||
(:file "input-package" :depends-on ("package"))
|
||||
(:file "input" :depends-on ("input-package" "dirty" "box"))
|
||||
(:file "text-input" :depends-on ("input-package" "input" "box"))
|
||||
(:file "textarea" :depends-on ("input-package" "input" "box"))
|
||||
(:file "keybindings" :depends-on ("input-package" "input"))
|
||||
;; Container components merged into box (v0.6.0)
|
||||
(:file "scrollbox" :depends-on ("package" "dirty" "box"))
|
||||
(:file "tabbar" :depends-on ("package" "dirty" "box"))
|
||||
;; Markdown + Code + Diff rendering (v0.8.0)
|
||||
(:file "markdown-package" :depends-on ("package"))
|
||||
(:file "markdown" :depends-on ("markdown-package"))
|
||||
;; Dialog + Toast (v0.9.0)
|
||||
(:file "dialog-package" :depends-on ("package" "input-package"))
|
||||
(:file "dialog" :depends-on ("dialog-package" "dirty" "text-input"))
|
||||
;; Slot system (v0.11.0)
|
||||
(:file "slot-package" :depends-on ("package"))
|
||||
(:file "slot" :depends-on ("slot-package")))))
|
||||
:in-order-to ((test-op (test-op :cl-tty/test))))
|
||||
|
||||
(asdf:defsystem :cl-tty/test
|
||||
:description "Test suite for cl-tty"
|
||||
:depends-on (:cl-tty :fiveam)
|
||||
:components
|
||||
((:module "src/backend"
|
||||
:components
|
||||
((:file "tests")
|
||||
(:file "modern-tests" :depends-on ("tests"))))
|
||||
(:module "src/layout"
|
||||
:components
|
||||
((:file "tests")))
|
||||
(:module "src/components"
|
||||
:components
|
||||
((:file "box-tests")
|
||||
(:file "dirty-tests")
|
||||
(:file "render-tests")
|
||||
(:file "theme-tests")
|
||||
(:file "input-tests" :pathname "../../tests/input-tests")
|
||||
(:file "scrollbox-tabbar-tests" :pathname "../../tests/scrollbox-tabbar-tests")
|
||||
(:file "markdown-tests" :pathname "../../tests/markdown-tests")
|
||||
(:file "dialog-tests" :pathname "../../tests/dialog-tests")
|
||||
(:file "slot-tests" :pathname "../../tests/slot-tests")))
|
||||
(:module "src/rendering"
|
||||
:components
|
||||
((:file "framebuffer-tests" :pathname "../../tests/framebuffer-tests"))))
|
||||
:perform (test-op (o c)
|
||||
(let ((run (find-symbol "RUN" :fiveam))
|
||||
(explain (find-symbol "EXPLAIN!" :fiveam))
|
||||
(status (find-symbol "RESULTS-STATUS" :fiveam))
|
||||
(all-passed t))
|
||||
(dolist (suite '((:cl-tty-backend-test "BACKEND-SUITE")
|
||||
(:cl-tty-box-test "BOX-SUITE")
|
||||
(:cl-tty-input-test "INPUT-SUITE")
|
||||
(:cl-tty-scrollbox-test "SCROLLBOX-SUITE")
|
||||
(:cl-tty-markdown-test)
|
||||
(:cl-tty-dialog-test "DIALOG-SUITE")
|
||||
(:cl-tty-theme-test "THEME-SUITE")
|
||||
(:cl-tty-slot-test "SLOT-SUITE")
|
||||
(:cl-tty-layout-test "LAYOUT-SUITE")
|
||||
(:cl-tty-modern-backend-test "MODERN-BACKEND-SUITE")
|
||||
(:cl-tty-framebuffer-test "FRAMEBUFFER-SUITE")))
|
||||
(let* ((pkg (find-package (first suite)))
|
||||
(suite-name (second suite))
|
||||
(s (cond (suite-name (find-symbol suite-name pkg))
|
||||
(pkg (find-symbol (string (first suite)) :keyword))
|
||||
(t nil))))
|
||||
(when s
|
||||
(let ((result (funcall run s)))
|
||||
(funcall explain result)
|
||||
(unless (funcall status result)
|
||||
(setf all-passed nil))))))
|
||||
(uiop:quit (if all-passed 0 1)))))
|
||||
41
cl-tui.asd
41
cl-tui.asd
@@ -1,41 +0,0 @@
|
||||
;;; cl-tui.asd — Common Lisp Terminal UI Framework
|
||||
(asdf:defsystem :cl-tui
|
||||
:description "Reusable Common Lisp Terminal UI Framework"
|
||||
:author "Amr Gharbeia"
|
||||
:version "0.2.0"
|
||||
:license "TBD"
|
||||
:depends-on (:fiveam)
|
||||
:components
|
||||
((:module "backend"
|
||||
:components
|
||||
((:file "package")
|
||||
(:file "classes" :depends-on ("package"))
|
||||
(:file "simple" :depends-on ("package" "classes"))
|
||||
(:file "modern" :depends-on ("package" "classes"))))
|
||||
(:module "layout"
|
||||
:components
|
||||
((:file "layout")))
|
||||
(:module "src/components"
|
||||
:components
|
||||
((:file "package")
|
||||
(:file "dirty")
|
||||
(:file "box" :depends-on ("package"))
|
||||
(:file "text" :depends-on ("package" "box")))))
|
||||
:in-order-to ((test-op (test-op :cl-tui-tests))))
|
||||
|
||||
(asdf:defsystem :cl-tui-tests
|
||||
:description "Test suite for cl-tui"
|
||||
:depends-on (:cl-tui :fiveam)
|
||||
:components
|
||||
((:module "backend"
|
||||
:components
|
||||
((:file "tests")))
|
||||
(:module "layout"
|
||||
:components
|
||||
((:file "tests")))
|
||||
(:module "src/components"
|
||||
:components
|
||||
((:file "box-tests")
|
||||
(:file "dirty-tests"))))
|
||||
:perform (test-op (o c)
|
||||
(uiop:symbol-call :cl-tui-backend-test '#:run-tests)))
|
||||
216
demo.lisp
Normal file
216
demo.lisp
Normal file
@@ -0,0 +1,216 @@
|
||||
;;; demo.lisp — cl-tty interactive demo
|
||||
;;; Run: sbcl --script demo.lisp
|
||||
|
||||
;; Load cl-tty directly via ASDF (no Quicklisp dependency needed —
|
||||
;; sb-posix is built into SBCL, no external libraries required).
|
||||
(require "asdf")
|
||||
(push (truename ".") asdf:*central-registry*)
|
||||
(asdf:load-system :cl-tty)
|
||||
|
||||
;; Symbols use explicit package prefixes to avoid read-event
|
||||
;; conflict between cl-tty.backend and cl-tty.input.
|
||||
|
||||
;; Short aliases for readability
|
||||
(import '(cl-tty.input:make-text-input
|
||||
cl-tty.input:text-input-value
|
||||
cl-tty.input:handle-text-input
|
||||
cl-tty.input:make-textarea
|
||||
cl-tty.input:textarea-lines
|
||||
cl-tty.input:handle-textarea-input))
|
||||
|
||||
;;; ─── Application state ───────────────────────────────────────────────────────
|
||||
|
||||
(defvar *app* nil "Application state plist")
|
||||
(defvar *log* nil "Circular log buffer")
|
||||
|
||||
(defun log-append (fmt &rest args)
|
||||
(let* ((msg (apply #'format nil fmt args))
|
||||
(ts (multiple-value-bind (h m s) (get-decoded-time)
|
||||
(format nil "~2,'0d:~2,'0d:~2,'0d" h m s))))
|
||||
(push (format nil "[~a] ~a" ts msg) *log*)
|
||||
(when (> (length *log*) 100) (setf *log* (subseq *log* 0 100)))))
|
||||
|
||||
(defun init-app-state ()
|
||||
(setf *log* nil)
|
||||
(setf *app* (list :tab 0
|
||||
:input (make-text-input :placeholder "Type here...")
|
||||
:textarea (make-textarea :value "Hello\nWorld")
|
||||
:running t
|
||||
:mouse-x -1 :mouse-y -1))
|
||||
(log-append "Demo started"))
|
||||
|
||||
;;; ─── Tab renderers ──────────────────────────────────────────────────────────
|
||||
|
||||
(defun render-tab-home (backend x y w h)
|
||||
"Welcome screen with version info."
|
||||
(declare (ignore h))
|
||||
(cl-tty.backend:draw-border backend x y w 18 :style :double :title " Welcome ")
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 2)
|
||||
"cl-tty — Pure CL Terminal UI Framework" :bright-white nil :bold t)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 4)
|
||||
" components: Box, Text, TextInput, TextArea, Select," nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 5)
|
||||
" ScrollBox, TabBar, Dialog, Toast, Markdown" nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 6)
|
||||
" features: 24-bit truecolor, OSC 8 links, SGR mouse," nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 7)
|
||||
" DECICM sync, kitty keyboard, framebuffer" nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 8)
|
||||
" backend: modern-backend | simple-backend (pipe-safe)" nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 9)
|
||||
" tests: 483, 100% passing" :green nil :bold t)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 10)
|
||||
" deps: zero FFI, zero ncurses, pure CL" :bright-cyan nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 12)
|
||||
"Controls" :bright-white nil :bold t)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 13)
|
||||
" Tab / arrows switch tabs" nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 14)
|
||||
" Ctrl+C / Esc quit" nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 15)
|
||||
" mouse click/drag select text (test SGR mouse)" nil nil))
|
||||
|
||||
(defun render-tab-widgets (backend x y w h input ta)
|
||||
"Interactive widget demo."
|
||||
(declare (ignore h))
|
||||
(cl-tty.backend:draw-border backend x y w 12 :style :single :title " Text Input ")
|
||||
(let ((val (text-input-value input)))
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 1) "Value: " :text-muted nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 10) (+ y 1)
|
||||
(if (plusp (length val)) val "(empty)") :text nil))
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 3)
|
||||
"Placeholder: \"Type here...\"" :text-muted nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 5)
|
||||
"Keys: type to insert, arrows to move," nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 6)
|
||||
"Enter to submit, Backspace to delete," nil nil)
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 7)
|
||||
"Ctrl+A/E for home/end" nil nil)
|
||||
(when (plusp (length (text-input-value input)))
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 9)
|
||||
(format nil "Submitted: ~a" (text-input-value input)) :accent nil))
|
||||
|
||||
(let ((y2 (+ y 13)))
|
||||
(cl-tty.backend:draw-border backend x y2 w 10 :style :single :title " TextArea ")
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y2 1) "Value:" :text-muted nil)
|
||||
(let ((lines (textarea-lines ta)))
|
||||
(loop for line in lines
|
||||
for row from 0 below (min (length lines) 6)
|
||||
do (cl-tty.backend:draw-text backend (+ x 2) (+ y2 2 row)
|
||||
(subseq (or line "") 0 (min (length line) (- w 4))) nil nil)))))
|
||||
|
||||
(defun render-tab-console (backend x y w h)
|
||||
"Event log / debug console."
|
||||
(cl-tty.backend:draw-border backend x y w h :style :single :title " Event Log ")
|
||||
(cl-tty.backend:draw-text backend (+ x 2) (+ y 1)
|
||||
"Last 50 keyboard and mouse events:" :text-muted nil)
|
||||
(let ((lines *log*)
|
||||
(max-rows (- h 3)))
|
||||
(loop for line in (subseq lines 0 (min (length lines) max-rows))
|
||||
for row from 0 below max-rows
|
||||
do (cl-tty.backend:draw-text backend (+ x 2) (+ y 3 row)
|
||||
(subseq (or line "") 0 (min (length line) (- w 4))) nil nil))))
|
||||
|
||||
;;; ─── Main loop ──────────────────────────────────────────────────────────────
|
||||
|
||||
(defun handle-event (event)
|
||||
"Process a key-event or mouse-event, returning t if consumed."
|
||||
(typecase event
|
||||
(cl-tty.input:key-event
|
||||
(let ((key (cl-tty.input:key-event-key event))
|
||||
(ctrl (cl-tty.input:key-event-ctrl event)))
|
||||
(log-append "Key: ~a (ctrl=~a alt=~a shift=~a)" key ctrl
|
||||
(cl-tty.input:key-event-alt event)
|
||||
(cl-tty.input:key-event-shift event))
|
||||
(cond
|
||||
((or (and ctrl (eql key :|C|)) (eql key :escape))
|
||||
(setf (getf *app* :running) nil) t)
|
||||
((eql key :tab)
|
||||
(incf (getf *app* :tab))
|
||||
(when (> (getf *app* :tab) 2) (setf (getf *app* :tab) 0)) t)
|
||||
;; Only arrow keys switch tabs when NOT on the Widgets tab.
|
||||
;; On the Widgets tab (tab=1), Left/Right are forwarded to widgets
|
||||
;; for cursor navigation in text inputs.
|
||||
((and (not (= (getf *app* :tab) 1))
|
||||
(eql key :left))
|
||||
(decf (getf *app* :tab))
|
||||
(when (minusp (getf *app* :tab)) (setf (getf *app* :tab) 2)) t)
|
||||
((and (not (= (getf *app* :tab) 1))
|
||||
(eql key :right))
|
||||
(incf (getf *app* :tab))
|
||||
(when (> (getf *app* :tab) 2) (setf (getf *app* :tab) 0)) t)
|
||||
;; Forward key to widgets only when on the Widgets tab
|
||||
(t (when (= (getf *app* :tab) 1)
|
||||
(handle-text-input (getf *app* :input) event)
|
||||
(handle-textarea-input (getf *app* :textarea) event))
|
||||
t))))
|
||||
(cl-tty.input:mouse-event
|
||||
(log-append "Mouse: ~a btn=~a pos=(~d,~d)"
|
||||
(cl-tty.input:mouse-event-type event)
|
||||
(cl-tty.input:mouse-event-button event)
|
||||
(cl-tty.input:mouse-event-x event)
|
||||
(cl-tty.input:mouse-event-y event))
|
||||
(setf (getf *app* :mouse-x) (cl-tty.input:mouse-event-x event)
|
||||
(getf *app* :mouse-y) (cl-tty.input:mouse-event-y event))
|
||||
t)))
|
||||
|
||||
(defun run-demo ()
|
||||
"Run the demo. Raw terminal mode should already be set by the
|
||||
./demo.sh shell wrapper."
|
||||
(init-app-state)
|
||||
(let* ((backend (cl-tty.backend:detect-backend))
|
||||
(w (multiple-value-bind (cols rows) (cl-tty.backend:backend-size backend)
|
||||
(declare (ignore rows))
|
||||
cols))
|
||||
(h (multiple-value-bind (cols rows) (cl-tty.backend:backend-size backend)
|
||||
(declare (ignore cols))
|
||||
rows)))
|
||||
(cl-tty.backend:initialize-backend backend)
|
||||
(unwind-protect
|
||||
(loop while (getf *app* :running)
|
||||
do
|
||||
(cl-tty.backend:backend-clear backend)
|
||||
;; Title bar
|
||||
(cl-tty.backend:draw-border backend 2 1 (- w 4) 3
|
||||
:style :double :title " cl-tty v0.15.0 ")
|
||||
(cl-tty.backend:draw-text backend 4 2
|
||||
"arrows/tab: tabs type: test input mouse: test SGR Esc/Ctrl+C: quit"
|
||||
:bright-white nil)
|
||||
;; Tab bar
|
||||
(loop for (label . idx) in '((" Home " . 0) (" Widgets " . 1) (" Console " . 2))
|
||||
for x-pos = 4 then (+ x-pos label-len 2)
|
||||
for label-len = (length label)
|
||||
do (let ((active (eql idx (getf *app* :tab))))
|
||||
(if active
|
||||
(cl-tty.backend:draw-text backend x-pos 4 label
|
||||
:bright-white :accent :bold t)
|
||||
(cl-tty.backend:draw-text backend x-pos 4 label
|
||||
:text-muted nil))))
|
||||
;; Content area
|
||||
(case (getf *app* :tab)
|
||||
(0 (render-tab-home backend 4 6 (- w 4) (- h 8)))
|
||||
(1 (render-tab-widgets backend 4 6 (- w 4) (- h 8)
|
||||
(getf *app* :input)
|
||||
(getf *app* :textarea)))
|
||||
(2 (render-tab-console backend 4 6 (- w 4) (- h 8))))
|
||||
;; Mouse cursor indicator
|
||||
(let ((mx (getf *app* :mouse-x))
|
||||
(my (getf *app* :mouse-y)))
|
||||
(when (and (>= mx 0) (>= my 0))
|
||||
(cl-tty.backend:draw-text backend mx my "@" :bright-cyan nil)))
|
||||
;; Status bar
|
||||
(cl-tty.backend:draw-rect backend 2 (- h 2) (- w 4) 1 :bg :blue)
|
||||
(cl-tty.backend:draw-text backend 4 (- h 2)
|
||||
(format nil " Tab ~d/3 | ~d events "
|
||||
(1+ (getf *app* :tab)) (length *log*))
|
||||
:bright-white :blue :bold t)
|
||||
(finish-output *standard-output*)
|
||||
;; Read event — blocks until a key or mouse event arrives
|
||||
(let ((event (cl-tty.input:read-event backend)))
|
||||
(cond
|
||||
((eq event :eof) (setf (getf *app* :running) nil))
|
||||
(event (handle-event event)))))
|
||||
(cl-tty.backend:shutdown-backend backend))))
|
||||
|
||||
(run-demo)
|
||||
(uiop:quit 0)
|
||||
17
demo.sh
Executable file
17
demo.sh
Executable file
@@ -0,0 +1,17 @@
|
||||
#!/bin/sh
|
||||
# cl-tty demo launcher
|
||||
# Sets raw terminal mode before starting SBCL, restores on exit.
|
||||
# Raw mode is needed so individual keystrokes are captured instead
|
||||
# of being line-buffered and echoed by the terminal driver.
|
||||
|
||||
SAVED=$(stty -g 2>/dev/null)
|
||||
if [ -z "$SAVED" ]; then
|
||||
echo "ERROR: Not running in a real terminal." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cleanup() { stty "$SAVED" 2>/dev/null; }
|
||||
trap cleanup EXIT INT TERM
|
||||
|
||||
stty raw -echo -isig -icanon min 1 time 0 2>/dev/null
|
||||
sbcl --script "$(dirname "$0")/demo.lisp"
|
||||
@@ -1,10 +1,10 @@
|
||||
#+TITLE: cl-tui Architecture
|
||||
#+TITLE: cl-tty Architecture
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :project:cl-tui:architecture:
|
||||
#+FILETAGS: :project:cl-tty:architecture:
|
||||
|
||||
* Architecture
|
||||
|
||||
cl-tui is a layered framework. Each layer has a single responsibility
|
||||
cl-tty is a layered framework. Each layer has a single responsibility
|
||||
and communicates with adjacent layers through a well-defined protocol.
|
||||
|
||||
** Layer Diagram
|
||||
@@ -264,47 +264,92 @@ reads terminal background color at startup.
|
||||
** File Structure
|
||||
|
||||
#+BEGIN_SRC
|
||||
cl-tui/
|
||||
├── cl-tui.asd
|
||||
├── cl-tui-tests.asd
|
||||
cl-tty/
|
||||
├── cl-tty.asd # ASDF system (main + test)
|
||||
├── README.org
|
||||
├── LICENSE
|
||||
├── .gitignore
|
||||
├── demo.lisp # Interactive demo
|
||||
├── demo.sh # PTY launcher for demo
|
||||
├── run-all-tests.lisp # Test runner
|
||||
├── docs/
|
||||
│ ├── ROADMAP.org
|
||||
│ └── ARCHITECTURE.org ← this file
|
||||
├── org/ # Literate source files
|
||||
│ ├── backend-protocol.org
|
||||
│ ├── box-renderable.org
|
||||
│ ├── detection.org
|
||||
│ ├── dialog.org
|
||||
│ ├── framebuffer.org
|
||||
│ ├── layout-engine.org
|
||||
│ ├── markdown-renderer.org
|
||||
│ ├── modern-backend.org
|
||||
│ ├── mouse.org
|
||||
│ ├── scrollbox.org
|
||||
│ ├── tabbar.org
|
||||
│ ├── container-package.org
|
||||
│ ├── select.org
|
||||
│ ├── slot.org
|
||||
│ └── text-input.org
|
||||
├── src/
|
||||
│ ├── package.lisp
|
||||
│ ├── backend/
|
||||
│ │ ├── protocol.lisp
|
||||
│ │ ├── detection.lisp
|
||||
│ │ ├── package.lisp
|
||||
│ │ ├── classes.lisp
|
||||
│ │ ├── simple.lisp
|
||||
│ │ └── modern.lisp
|
||||
│ │ ├── modern.lisp
|
||||
│ │ └── detection.lisp
|
||||
│ ├── layout/
|
||||
│ │ ├── nodes.lisp
|
||||
│ │ ├── solver.lisp
|
||||
│ │ └── api.lisp
|
||||
│ │ └── layout.lisp
|
||||
│ ├── components/
|
||||
│ │ ├── base.lisp
|
||||
│ │ ├── package.lisp
|
||||
│ │ ├── box.lisp
|
||||
│ │ └── text.lisp
|
||||
│ ├── rendering/
|
||||
│ │ ├── pipeline.lisp
|
||||
│ │ ├── text.lisp
|
||||
│ │ ├── render.lisp
|
||||
│ │ ├── theme.lisp
|
||||
│ │ ├── dirty.lisp
|
||||
│ │ └── diff.lisp
|
||||
│ └── theme/
|
||||
│ ├── tokens.lisp
|
||||
│ └── presets.lisp
|
||||
└── tests/
|
||||
├── package.lisp
|
||||
├── backend.lisp
|
||||
├── layout.lisp
|
||||
└── components.lisp
|
||||
│ │ ├── input-package.lisp
|
||||
│ │ ├── input.lisp
|
||||
│ │ ├── text-input.lisp
|
||||
│ │ ├── textarea.lisp
|
||||
│ │ ├── keybindings.lisp
|
||||
│ │ ├── container-package.lisp
|
||||
│ │ ├── scrollbox.lisp
|
||||
│ │ ├── tabbar.lisp
|
||||
│ │ ├── select-package.lisp
|
||||
│ │ ├── select.lisp
|
||||
│ │ ├── markdown-package.lisp
|
||||
│ │ ├── markdown.lisp
|
||||
│ │ ├── dialog-package.lisp
|
||||
│ │ ├── dialog.lisp
|
||||
│ │ ├── mouse-package.lisp
|
||||
│ │ ├── mouse.lisp
|
||||
│ │ ├── slot-package.lisp
|
||||
│ │ └── slot.lisp
|
||||
│ └── rendering/
|
||||
│ └── framebuffer.lisp
|
||||
├── tests/
|
||||
│ ├── input-tests.lisp
|
||||
│ ├── scrollbox-tabbar-tests.lisp
|
||||
│ ├── select-tests.lisp
|
||||
│ ├── markdown-tests.lisp
|
||||
│ ├── dialog-tests.lisp
|
||||
│ ├── mouse-tests.lisp
|
||||
│ ├── slot-tests.lisp
|
||||
│ ├── framebuffer-tests.lisp
|
||||
│ └── integration-tests.lisp
|
||||
└── scripts/
|
||||
├── binary-search.lisp
|
||||
├── code-audit.lisp
|
||||
├── audit-compiler.lisp
|
||||
├── find-t-form.lisp
|
||||
├── find-t-warning.lisp
|
||||
└── verify-api.py
|
||||
#+END_SRC
|
||||
|
||||
** Dependency Graph
|
||||
|
||||
backend/ (no deps)
|
||||
layout/ (no deps — pure math)
|
||||
src/backend/ (no deps)
|
||||
src/layout/ (no deps — pure math)
|
||||
theme/ (backend for color resolution)
|
||||
components/ (layout, theme, rendering)
|
||||
rendering/ (layout, components, backend, theme)
|
||||
|
||||
115
docs/BUG-REPORT.md
Normal file
115
docs/BUG-REPORT.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# cl-tty Code Audit — Bug Report
|
||||
|
||||
## Bug 1 [CRITICAL]: dialog rendering undefined functions
|
||||
|
||||
**File:** src/components/dialog-package.lisp and src/components/dialog.lisp
|
||||
|
||||
**Problem:** `render-dialog` (lines 34, 36, 39) and `render-toast` (lines 114, 115) call `draw-rect`, `draw-border`, `draw-text` without those symbols being available.
|
||||
|
||||
**Root cause:** The dialog package definition uses `(:use :cl :cl-tty.input :cl-tty.select)` but `draw-rect`, `draw-border`, and `draw-text` are generic functions exported from `cl-tty.backend`. They need to be imported. The package does NOT use `cl-tty.backend`.
|
||||
|
||||
**Tests don't catch this** because dialog-tests.lisp tests push/pop/toast management but never calls `render-dialog` or `render-toast`.
|
||||
|
||||
**Fix:** Add `:cl-tty.backend` to the `:use` list in dialog-package.lisp, or add individual `:import-from` entries for the three functions.
|
||||
|
||||
---
|
||||
|
||||
## Bug 2 [HIGH]: SBCL "function T is undefined" warning in input.lisp
|
||||
|
||||
**File:** src/components/input.lisp
|
||||
|
||||
**Problem:** When SBCL compiles this file, it issues:
|
||||
"WARNING: The function T is undefined, and its name is reserved by ANSI CL so that even if it were defined later, the code doing so would not be portable."
|
||||
|
||||
The warning fires during the `defmethod read-event` compilation unit but the exact source is not identified by line number. The file uses `(t ...)` in case/cond default clauses extensively and `:ctrl t`, `:alt t` etc. as keyword argument values. The root cause needs investigation — could be the `case` macro expansion or a `return-from` interaction.
|
||||
|
||||
**Note:** this warning does NOT fire when `(compile 'read-event)` or `(compile nil '(lambda ...))` is called in isolation on individual functions. It only fires during `compile-file` on the whole file. This suggests it's a cross-form interaction.
|
||||
|
||||
**Investigation needed.**
|
||||
|
||||
---
|
||||
|
||||
## Bug 3 [MEDIUM]: text-input.lisp ignores variable that IS read
|
||||
|
||||
**File:** src/components/text-input.lisp, lines 163, 169-170
|
||||
|
||||
```lisp
|
||||
(w (if ln (layout-node-width ln) 80)) ; line 163 — defined
|
||||
...
|
||||
(truncated (subseq display 0 (min (length display) w))) ; line 169 — USED
|
||||
(declare (ignore w cursor)) ; line 170 — declared ignored
|
||||
```
|
||||
|
||||
**Problem:** `w` is declared as `(ignore w)` on line 170 but is actually read on line 169. Declare ignore + read is a compiler-level contradiction. The `cursor` variable is legitimately unused and should remain ignored.
|
||||
|
||||
**Fix:** Remove `w` from the ignore declaration. Only `(declare (ignore cursor))`.
|
||||
|
||||
---
|
||||
|
||||
## Bug 4 [MEDIUM]: markdown.lisp ignores variable that IS read
|
||||
|
||||
**File:** src/components/markdown.lisp, lines 142-144
|
||||
|
||||
```lisp
|
||||
(defun parse-list (lines start)
|
||||
(declare (ignore start)) ; line 143
|
||||
(let ((items nil) (i start)) ; line 144 — USES start!
|
||||
```
|
||||
|
||||
**Problem:** Same pattern as bug 3. `start` is declared ignored then immediately used. The declaration should be removed.
|
||||
|
||||
**Fix:** Remove the `(declare (ignore start))` declaration.
|
||||
|
||||
---
|
||||
|
||||
## Bug 5 [MEDIUM]: scrollbox.lisp unused vx variable
|
||||
|
||||
**File:** src/components/scrollbox.lisp, line 45
|
||||
|
||||
```lisp
|
||||
(vx 0) (vy 0)
|
||||
```
|
||||
|
||||
**Problem:** `vx` is bound but never read — `vy` is used for viewport height calculations but viewport-x/vx is never referenced. This is a style-warning that indicates either dead code or a real issue where viewport-x should be used.
|
||||
|
||||
**Fix:** Add `(declare (ignore vx))` or remove the `vx` binding entirely.
|
||||
|
||||
---
|
||||
|
||||
## Bug 6 [LOW]: %simple-border-char ignores edge-style
|
||||
|
||||
**File:** src/backend/simple.lisp, lines 33-40
|
||||
|
||||
```lisp
|
||||
(defun %simple-border-char (edge-style pos)
|
||||
"Return ASCII border character for EDGE-STYLE at POS."
|
||||
(case pos
|
||||
((:top-left :top-right :bottom-left :bottom-right) #\+)
|
||||
(:horizontal #\-)
|
||||
(:vertical #\|)))
|
||||
```
|
||||
|
||||
**Problem:** The `edge-style` parameter is never consulted. Always returns `+ - |` regardless of style. Callers also pass `nil` for it:
|
||||
```lisp
|
||||
(%simple-border-char nil :horizontal)
|
||||
```
|
||||
|
||||
**Fix:** Either remove the `edge-style` parameter (dead code) or implement border style selection using `case` on `edge-style`.
|
||||
|
||||
---
|
||||
|
||||
## Bug 7 [LOW]: framebuffer draw-border ignores title-align
|
||||
|
||||
**File:** src/rendering/framebuffer.lisp, lines 94, 114-116
|
||||
|
||||
```lisp
|
||||
(defmethod draw-border ((fb framebuffer-backend) x y w h &key (style :single) title title-align fg bg)
|
||||
...
|
||||
(when title
|
||||
(loop for i from 0 below (length title)
|
||||
do (%set-cell fb (+ x 2 i) y (char title i) :fg fg :bg bg))))
|
||||
```
|
||||
|
||||
**Problem:** `title-align` is accepted but never used. Title always renders at offset 2 from left edge (hard-coded). The simple backend centers the title, the framebuffer backend left-aligns — inconsistent API behavior.
|
||||
|
||||
**Fix:** Implement `title-align` support or add `(declare (ignore title-align))` and document the behavior.
|
||||
736
docs/ROADMAP.org
736
docs/ROADMAP.org
@@ -1,596 +1,246 @@
|
||||
#+TITLE: cl-tui Roadmap
|
||||
#+TITLE: cl-tty Roadmap
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :docs:roadmap:cl-tui:
|
||||
#+FILETAGS: :docs:roadmap:cl-tty:
|
||||
|
||||
* The Roadmap
|
||||
|
||||
Each phase is one minor release. Phases ship in dependency order — each depends on
|
||||
the components from prior phases. The backend protocol ships first because
|
||||
everything else builds on it.
|
||||
the components from prior phases.
|
||||
|
||||
** v0.0.1: Foundation — Backend Protocol
|
||||
** v0.0.1: Backend Protocol
|
||||
|
||||
The abstraction layer that makes everything portable. Two backends:
|
||||
=modern= (raw escape sequences, truecolor, modern features) and =simple=
|
||||
(ASCII art, universal compatibility). The component tree never touches
|
||||
the terminal directly — it dispatches through the protocol.
|
||||
DONE. Two backends implementing a common protocol:
|
||||
|
||||
*** TODO Backend protocol definition
|
||||
:PROPERTIES:
|
||||
:ID: id-v000-protocol
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
- =modern-backend= — raw escape sequences, truecolor 24-bit, OSC 8 hyperlinks,
|
||||
DECICM sync, SGR mouse, kitty keyboard protocol, bold/italic/underline,
|
||||
box-drawing chars (rounded/single/double)
|
||||
- =simple-backend= — ASCII art only, no color, universal compatibility for
|
||||
SSH/piped output
|
||||
|
||||
- Define =backend= abstract class with generic functions:
|
||||
- =initialize-backend=, =shutdown-backend=, =suspend-backend=, =resume-backend=
|
||||
- =backend-size=, =backend-write=, =backend-clear=
|
||||
- =begin-sync=, =end-sync= — DECICM synchronized updates
|
||||
~180 lines total. Dependencies: None (pure CL, no FFI).
|
||||
|
||||
*** Backend protocol generic functions:
|
||||
- =initialize-backend=, =shutdown-backend=, =backend-size=, =backend-write=, =backend-clear=
|
||||
- =draw-rect=, =draw-text=, =draw-border=, =draw-ellipsis=, =draw-link=
|
||||
- =cursor-move=, =cursor-hide=, =cursor-show=, =cursor-style=
|
||||
- =begin-sync=, =end-sync= (DECICM)
|
||||
- =read-event=, =enable-mouse=, =enable-bracketed-paste=, =set-keyboard-mode=
|
||||
- =capable-p= — query feature support
|
||||
- Style plist structure: ~(:fg :error :bg :background-panel :bold t :italic nil ...)~
|
||||
- ~100 lines
|
||||
|
||||
*** TODO Simple backend
|
||||
:PROPERTIES:
|
||||
:ID: id-v000-simple
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
** Layout Engine (pure CL)
|
||||
|
||||
- =simple-backend= class — inherits =backend=
|
||||
- Borders: ASCII (~+-|~), no rounded corners
|
||||
- No color, no bold/italic — plain characters only
|
||||
- No OSC 8 links, no mouse, no synchronized updates
|
||||
- Works on any terminal, any SSH connection, piped output
|
||||
- ~100 lines
|
||||
DONE. Pure Common Lisp Flexbox layout engine. No Yoga, no CFFI, no external
|
||||
dependencies. A two-pass constraint solver handling direction, wrap,
|
||||
grow/shrink/gap padding/margin, absolute positioning.
|
||||
|
||||
*** TODO Modern backend
|
||||
:PROPERTIES:
|
||||
:ID: id-v000-modern
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
~190 lines. Macros: =vbox=, =hbox=, =spacer=.
|
||||
|
||||
- =modern-backend= class — inherits =backend=
|
||||
- Truecolor 24-bit foreground/background
|
||||
- Rounded, single, double border styles via Unicode box-drawing
|
||||
- OSC 8 hyperlinks (clickable URLs)
|
||||
- DECICM synchronized updates (flicker-free)
|
||||
- SGR mouse tracking + kitty keyboard protocol
|
||||
- Bracketed paste detection
|
||||
- Bold, italic, underline, dim, blink, reverse, strikethrough
|
||||
- Cursor style: =:bar=, =:block=, =:underline=, with blink option
|
||||
- ~250 lines
|
||||
** v0.2.0: Box, Text, Span, Dirty Tracking
|
||||
|
||||
*** TODO Terminal capability detection
|
||||
:PROPERTIES:
|
||||
:ID: id-v000-detection
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
DONE. The first two renderable types. Box draws borders and backgrounds.
|
||||
Text renders strings with color, word-wrap, and inline style spans.
|
||||
|
||||
- =detect-backend= → returns =modern-backend= or =simple-backend=
|
||||
- Check if stdout is a TTY (if not → =simple-backend=)
|
||||
- Send DA1 (~ESC[c~) query, 100ms timeout
|
||||
- Send DA3 (~ESC[?c~) for kitty/wezterm identification
|
||||
- Query DECRPM (~ESC[?2026$p~) for DECICM sync support
|
||||
- Query truecolor support via =COLORTERM= env var + DA response
|
||||
- Cache detection result so subsequent calls are instant
|
||||
- ~100 lines
|
||||
|
||||
~550 lines total. Dependencies: None (pure CL, no FFI, no external libs).
|
||||
|
||||
** v0.0.2: Layout Engine
|
||||
the patch version (v0.X.Y).
|
||||
|
||||
** File Update Checklist
|
||||
|
||||
When a version ships:
|
||||
1. ~ROADMAP.org~ — mark item DONE, update LOGBOOK timestamp
|
||||
2. ~README.org~ — update Status line
|
||||
3. ~cl-tui.asd~ — update version string
|
||||
|
||||
** v0.1.0: Layout Engine
|
||||
|
||||
Yoga Flexbox backend wrapped in a Common Lisp API. This is the foundation —
|
||||
every component after v0.1.0 uses the layout engine for positioning.
|
||||
|
||||
*** TODO Yoga FFI binding
|
||||
:PROPERTIES:
|
||||
:ID: id-v010-yoga-ffi
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- Load the Yoga shared library via CFFI
|
||||
- Define foreign types for ~YGNodeRef~, ~YGSize~, ~YGValue~, ~YGDirection~, ~YGFlexDirection~, ~YGAlign~, ~YGJustify~, ~YGWrap~, ~YGPositionType~, ~YGOverflow~, ~YGDisplay~, ~YGEdge~
|
||||
- Bind core functions: ~node-new~, ~node-free~, ~node-style-set-*~, ~node-layout-get-*~, ~calculate-layout~
|
||||
- ~100 lines CFFI
|
||||
|
||||
*** TODO Layout primitives
|
||||
:PROPERTIES:
|
||||
:ID: id-v010-layout-primitives
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(make-layout-node)~ — wraps a ~YGNodeRef~ in a CLOS object
|
||||
- ~(layout-node-set-dimension node width height)~ — sets width/height in points
|
||||
- ~(layout-node-set-flex node &key grow shrink basis)~ — flex properties
|
||||
- ~(layout-node-set-direction node :row | :column | :row-reverse | :column-reverse)~
|
||||
- ~(layout-node-set-wrap node :nowrap | :wrap | :wrap-reverse)~
|
||||
- ~(layout-node-set-align node :flex-start | :center | :flex-end | :stretch | :baseline)~
|
||||
- ~(layout-node-set-justify node :flex-start | :center | :flex-end | :space-between | :space-around | :space-evenly)~
|
||||
- ~(layout-node-set-padding node &key top right bottom left x y)~
|
||||
- ~(layout-node-set-margin node &key top right bottom left x y)~
|
||||
- ~(layout-node-set-gap node &key row column)~
|
||||
- ~(layout-node-set-position node :relative | :absolute &key top right bottom left)~
|
||||
- ~(layout-node-set-border node width)~
|
||||
- ~(layout-node-add-child parent child)~ — builds the tree
|
||||
- ~(layout-calculate root width height)~ — runs Yoga's calculateLayout, populates each node's computed x/y/w/h
|
||||
- ~200 lines CL
|
||||
|
||||
*** TODO Layout composable API
|
||||
:PROPERTIES:
|
||||
:ID: id-v010-layout-composable
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
Convenience macros to build layout trees from CL function calls:
|
||||
|
||||
- ~(vbox &key ... children ...)~ → column-direction container with children
|
||||
- ~(hbox &key ... children ...)~ → row-direction container with children
|
||||
- ~(overlay base child)~ — absolute-positioned overlay over a relative base
|
||||
- ~(spacer &key grow)~ — empty flex spacer
|
||||
- ~(layout-render root parent-window)~ — computes layout then walks the tree, calling each child's render function with its computed x, y, w, h
|
||||
- ~50 lines CL macros
|
||||
|
||||
~350 lines total. Dependencies: Yoga shared library, CFFI, croatoan.
|
||||
|
||||
*** FiveAM tests
|
||||
- ~test-layout-basic~ — vbox with two children computes correct y positions
|
||||
- ~test-layout-hbox~ — hbox with two children computes correct x positions
|
||||
- ~test-layout-flex~ — flex-grow distributes space correctly
|
||||
- ~test-layout-absolute~ — absolute child positions relative to parent
|
||||
- ~test-layout-nested~ — nested vbox/hbox produces correct leaf positions
|
||||
|
||||
** v0.2.0: Renderables — Box and Text
|
||||
|
||||
The first two renderable types that every application uses. A Box draws borders
|
||||
and backgrounds. A Text renders strings with color and style. Together they
|
||||
cover 80% of terminal UI.
|
||||
|
||||
*** DONE Box renderable
|
||||
:PROPERTIES:
|
||||
:ID: id-v020-box
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
:LOGBOOK:
|
||||
- State \"DONE\" from \"TODO\" [2026-05-11 Mon]
|
||||
:END:
|
||||
|
||||
- ~(defclass box ...)~ — renderable with background color, border, title
|
||||
- ~(render-box box window)~ — draws border (single/double/rounded), fills background, renders title
|
||||
- Border styles: ~:single~, ~:double~, ~:rounded~
|
||||
- Title alignment: ~:left~, ~:center~, ~:right~
|
||||
- ~:focusable~ property — renders focused border color when focused
|
||||
- ~100 lines
|
||||
|
||||
*** DONE Text renderable
|
||||
:PROPERTIES:
|
||||
:ID: id-v020-text
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
:LOGBOOK:
|
||||
- State \"DONE\" from \"TODO\" [2026-05-11 Mon]
|
||||
:END:
|
||||
|
||||
- ~(defclass text ...)~ — renderable with content, fg/bg color, wrap mode
|
||||
- ~(render-text text window)~ — renders text at the layout position, wraps at width
|
||||
- Word-wrap: ~:none~ (truncate) or ~:word~ (break at word boundaries)
|
||||
- CJK/emoji character-width aware wrapping
|
||||
- ~100 lines
|
||||
|
||||
*** DONE Inline text styles
|
||||
:PROPERTIES:
|
||||
:ID: id-v020-inline
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
:LOGBOOK:
|
||||
- State \"DONE\" from \"TODO\" [2026-05-11 Mon]
|
||||
:END:
|
||||
|
||||
- ~(defclass span ...)~ — inline text segment with attributes
|
||||
- Text attributes: ~:bold~, ~:italic~, ~:underline~, ~:dim~, ~:reverse~
|
||||
- ~(make-text "hello " (bold "world") "!")~ — builds styled text from spans and strings
|
||||
- ~60 lines
|
||||
|
||||
*** DONE Dirty tracking
|
||||
:PROPERTIES:
|
||||
:ID: id-v020-dirty
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
:LOGBOOK:
|
||||
- State \"DONE\" from \"TODO\" [2026-05-11 Mon]
|
||||
:END:
|
||||
|
||||
- ~(mark-dirty component)~ — flags component and all ancestors
|
||||
- ~(dirty-p component)~ — returns T if the component needs re-rendering
|
||||
- ~(mark-clean component)~ — clears dirty flag after render
|
||||
- ~40 lines
|
||||
|
||||
~300 lines total. Dependencies: Phase 1 (layout engine).
|
||||
|
||||
** v0.3.0: Rendering Engine
|
||||
|
||||
The pipeline that goes from component tree to terminal output. Handles dirty
|
||||
propagation, incremental rendering (only dirty branches), scissor clipping,
|
||||
and diff-based output.
|
||||
|
||||
*** TODO Component tree → render commands
|
||||
:PROPERTIES:
|
||||
:ID: id-v030-pipeline
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(render-screen root screen)~ — entry point: computes layout, walks dirty branches, collects render commands
|
||||
- Render commands are lists: ~(:box x y w h bg border title)~, ~(:text x y str fg bg attrs)~
|
||||
- Each component's ~render~ function returns a list of render commands
|
||||
- ~100 lines
|
||||
|
||||
*** TODO Scissor clipping
|
||||
:PROPERTIES:
|
||||
:ID: id-v030-scissor
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(with-scissor (window x y w h) &body body)~ — clips all render operations to a rectangle
|
||||
- Pushes/pops scissor state so nested containers clip correctly
|
||||
- ~50 lines
|
||||
|
||||
*** TODO Incremental diff output
|
||||
:PROPERTIES:
|
||||
:ID: id-v030-diff-output
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~*framebuffer*~ — a 2D array of (char, fg-color, bg-color, attrs) tuples
|
||||
- ~(flush-framebuffer screen)~ — compares framebuffer to previous frame, writes only changed cells via croatoan
|
||||
- ~(clear-dirty screen)~ — clears all dirty flags after a successful flush
|
||||
- Croatoan compatibility: uses ~add-string~ for unchanged text, ~clear~ + ~add-string~ for changed regions
|
||||
- ~150 lines
|
||||
|
||||
~300 lines total. Dependencies: Phase 2 (renderables + dirty tracking).
|
||||
|
||||
** v0.4.0: Theme Engine
|
||||
|
||||
Semantic color tokens, dark/light variants, hex → truecolor resolution, and
|
||||
built-in presets. Application code references semantic roles (~:error~, ~:accent~),
|
||||
never hex values.
|
||||
|
||||
*** TODO Semantic color tokens
|
||||
:PROPERTIES:
|
||||
:ID: id-v040-tokens
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass theme ...)~ — holds a mapping from semantic roles to hex colors
|
||||
- 30+ semantic roles: ~:primary~, ~:secondary~, ~:accent~, ~:error~, ~:warning~, ~:success~, ~:info~, ~:text~, ~:text-muted~, ~:background~, ~:background-panel~, ~:background-element~, ~:border~, ~:border-active~, ~:diff-added~, ~:diff-removed~, ~:diff-context~, ~:markdown-heading~, ~:markdown-code~, ~:markdown-link~, ~:markdown-quote~, ~:syntax-keyword~, ~:syntax-function~, ~:syntax-string~, ~:syntax-number~, ~:syntax-comment~, ~:syntax-type~
|
||||
- ~120 lines
|
||||
|
||||
*** TODO theme-color
|
||||
:PROPERTIES:
|
||||
:ID: id-v040-theme-color
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(theme-color theme role)~ → returns the croatoan color pair number for the role
|
||||
- ~(themed-add-string window x y str :color :error)~ — renders text with a theme semantic role
|
||||
- Color pair caching: resolve hex → croatoan ~init-color~ once per (fg, bg) pair, reuse
|
||||
- ~40 lines
|
||||
|
||||
*** TODO Built-in presets
|
||||
:PROPERTIES:
|
||||
:ID: id-v040-presets
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
8 presets: default (gold), professional, minimal, nord, tokyonight, catppuccin, monokai, gruvbox
|
||||
- Each preset is a plist: ~(:primary "#FFD700" :error "#BF616A" ...)~
|
||||
- ~(theme-load :nord)~ — activates a preset, re-renders dirty
|
||||
- Load from ~/.config/cl-tui/themes/<name>.lisp~ for custom themes
|
||||
- ~80 lines
|
||||
|
||||
*** TODO Dark/light variants
|
||||
:PROPERTIES:
|
||||
:ID: id-v040-dark-light
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- Each preset defines both ~:dark~ and ~:light~ variants
|
||||
- ~(theme-set-mode :dark | :light)~ — switches variant
|
||||
- Auto-detect: read terminal background color (croatoan's background), pick closest variant
|
||||
- ~50 lines
|
||||
|
||||
~290 lines total. Dependencies: Phase 2 (renderables), Croatoan's ~init-color~/~color-pair~.
|
||||
- =Box= with border styles (:single, :double, :rounded), title, background
|
||||
- =Text= with word-wrap (:none, :word), fg/bg colors
|
||||
- =Span= — inline text segment with attributes (:bold, :italic, etc.)
|
||||
- =Dirty-mixin= — marks components and ancestors for re-render
|
||||
- =Theme= — semantic color tokens, presets (default, nord, catppuccin, etc.)
|
||||
- =render= generic function dispatched on component type
|
||||
|
||||
** v0.5.0: Text Input + Keybinding System
|
||||
|
||||
Text input widgets with readline/emacs keybindings. A layered keybinding system
|
||||
that routes keystrokes through global → local → input layers.
|
||||
DONE. Text input widgets with readline-style keybindings.
|
||||
|
||||
*** TODO TextInput — single-line input
|
||||
:PROPERTIES:
|
||||
:ID: id-v050-textinput
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass text-input ...)~ — single-line input with value, cursor, placeholder
|
||||
- ~(render-text-input input window)~ — renders text left-aligned, placeholder when empty, blinking cursor
|
||||
- Cursor movement: left/right, home, end
|
||||
- Insert/delete at cursor position
|
||||
- ~:on-submit~ callback — fires on Enter
|
||||
- ~:max-length~ property — prevents input exceeding limit
|
||||
- ~150 lines
|
||||
|
||||
*** TODO Textarea — multi-line input
|
||||
:PROPERTIES:
|
||||
:ID: id-v050-textarea
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass textarea ...)~ — multi-line input with value, cursor (row, column), selection
|
||||
- ~(render-textarea area window)~ — renders visible lines, cursor, selection highlight
|
||||
- Cursor: up/down, left/right, word-forward/backward, line/home/end, buffer/home/end
|
||||
- Selection: Shift + navigation extends selection
|
||||
- Undo/redo stack (configurable depth, default 100)
|
||||
- ~:on-submit~ callback — fires on Enter
|
||||
- ~200 lines
|
||||
|
||||
*** TODO Keybinding system
|
||||
:PROPERTIES:
|
||||
:ID: id-v050-keybindings
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- Layered keymaps: ~:global~ → ~:local~ → ~:input~ (input layer takes priority when text input is focused)
|
||||
- ~(defkeymap :global '((:ctrl+p . command-palette) (:ctrl+c,ctrl+d . quit)))~
|
||||
- Key format: ~:ctrl+p~, ~:alt+f~, ~:shift+tab~, ~(:ctrl+c :ctrl+d)~ (chord)
|
||||
- Chord sequences: first key starts a timer, second key within timeout dispatches
|
||||
- ~:leader~ key (default ~Ctrl+X~) with configurable timeout
|
||||
- Key names normalized from croatoan's ~:code-key~ + ~:key-name~ output
|
||||
- ~150 lines
|
||||
|
||||
~500 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme).
|
||||
- =TextInput= — single-line input with cursor, placeholder, max-length, on-submit
|
||||
- =Textarea= — multi-line input with undo/redo (100-deep stack), cursor nav,
|
||||
selection, on-submit
|
||||
- =Keymap= — layered keybinding system with =defkeymap= macro
|
||||
- Event handling: key-event, mouse-event structs, raw-byte reader
|
||||
|
||||
** v0.6.0: ScrollBox + TabBar
|
||||
|
||||
Container components. ScrollBox handles content larger than the viewport.
|
||||
TabBar handles horizontal tab navigation.
|
||||
DONE. Container components.
|
||||
|
||||
*** TODO ScrollBox
|
||||
:PROPERTIES:
|
||||
:ID: id-v060-scrollbox
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass scroll-box ...)~ — container with vertical/horizontal scroll
|
||||
- Viewport culling: only render children whose y position is within the visible range
|
||||
- Scroll offset: ~:scroll-y~, ~:scroll-x~ slots
|
||||
- ScrollBy: PageUp/PageDown (viewport height), Up/Down (1 line), Home/End (buffer start/end)
|
||||
- Scrollbars: vertical and horizontal (single-line, rendered with block characters)
|
||||
- Sticky scroll: when scrolled to bottom and new content arrives, auto-scroll to show it. When user scrolls up, stop auto-scrolling until they scroll back down.
|
||||
- ~200 lines
|
||||
|
||||
*** TODO TabBar
|
||||
:PROPERTIES:
|
||||
:ID: id-v060-tabbar
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass tab-bar ...)~ — horizontal row of tabs
|
||||
- ~(tab-bar-add tab-bar id title &optional content)~
|
||||
- ~:active-tab~ slot — only renders content for the active tab
|
||||
- Tab rendering: highlighted active tab, dim inactive tabs
|
||||
- Left/Right or Ctrl+PageUp/PageDn to navigate tabs
|
||||
- ~100 lines
|
||||
|
||||
~300 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme).
|
||||
- =ScrollBox= — scrollable viewport with vertical/horizontal scrollbars,
|
||||
scroll-by, clamp, sticky-scroll mode
|
||||
- =TabBar= — horizontal tab navigation with next/prev, active tab tracking
|
||||
|
||||
** v0.7.0: Select — Dropdown + Fuzzy Filter
|
||||
|
||||
A selection list component — the building block for command palettes, theme
|
||||
pickers, agent selectors, file pickers.
|
||||
|
||||
*** TODO Select
|
||||
:PROPERTIES:
|
||||
:ID: id-v070-select
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass select ...)~ — list of options with keyboard navigation
|
||||
- ~:options~ — list of plists: ~((:title "Nord" :value :nord :category "Themes") ...)~
|
||||
- Categories: options can be grouped. Category headers rendered dim, non-selectable
|
||||
- Up/Down/Ctrl+P/Ctrl+N to navigate, Enter to select, Esc to dismiss
|
||||
- ~:on-select~ callback — fires on Enter
|
||||
- ~:filter~ property — when set, filters the option list. Options whose title contains the filter (case-insensitive) are shown.
|
||||
- Fuzzy filter: when ~:filter~ is non-nil and no exact matches, uses trigram-based fuzzy matching (3-character sliding window Jaccard similarity)
|
||||
- ~150 lines
|
||||
|
||||
~150 lines total. Dependencies: Phase 5 (keybindings), Phase 4 (theme).
|
||||
DONE. A selection list component with keyboard navigation, category headers,
|
||||
and fuzzy text matching.
|
||||
|
||||
** v0.8.0: Markdown + Code + Diff Rendering
|
||||
|
||||
Content rendering components. Markdown for agent responses. Code for syntax
|
||||
highlighting. Diff for file changes.
|
||||
DONE. Content rendering for agent responses and file diffs.
|
||||
|
||||
*** TODO Markdown
|
||||
:PROPERTIES:
|
||||
:ID: id-v080-markdown
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass markdown ...)~ — renders markdown content as styled text
|
||||
- Heading levels 1-6: colored by theme (~:markdown-heading~) with level-based sizing
|
||||
- Bold, italic, inline code, strikethrough — rendered as croatoan text attributes
|
||||
- Code blocks: fenced (~```~) and indented. Background-colored, syntax-highlighted via regex
|
||||
- Links: OSC 8 hyperlinks (clickable in Kitty, WezTerm, iTerm2, Ghostty). Format: ~\x1b]8;;url\x1b\\...link text...\x1b]8;;\x1b\\~
|
||||
- Blockquotes: colored left border (~:markdown-quote~), indented text
|
||||
- Tables: aligned column text, no borders. Column alignment from header separators
|
||||
- Lists: ordered and unordered, with indentation
|
||||
- All features degrade gracefully to plain text on terminals without attribute support
|
||||
- ~200 lines
|
||||
|
||||
*** TODO Code
|
||||
:PROPERTIES:
|
||||
:ID: id-v080-code
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass code ...)~ — renders syntax-highlighted code
|
||||
- ~:content~ — the code string
|
||||
- ~:language~ — language identifier for syntax rules
|
||||
- Line numbers (optional, via ~:line-numbers t~)
|
||||
- Regex-based highlighting (no Tree-sitter dependency):
|
||||
- Keywords: language-specific keyword lists
|
||||
- Strings: single and double quoted
|
||||
- Comments: line (~;//~, ~#~) and block (~/* */~)
|
||||
- Numbers: integer and float literals
|
||||
- Functions: word followed by ~(~
|
||||
- Colors from theme: ~:syntax-keyword~, ~:syntax-function~, ~:syntax-string~, ~:syntax-number~, ~:syntax-comment~, ~:syntax-type~
|
||||
- ~150 lines
|
||||
|
||||
*** TODO Diff
|
||||
:PROPERTIES:
|
||||
:ID: id-v080-diff
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass diff ...)~ — renders unified diff output
|
||||
- ~:content~ — diff text (standard unified diff format)
|
||||
- Added lines: ~+~ prefix, green background (~:diff-added~)
|
||||
- Removed lines: ~-~ prefix, red background (~:diff-removed~)
|
||||
- Context lines: ~ ~ prefix, neutral background (~:diff-context~)
|
||||
- Line numbers: optional, rendered in ~:diff-line-number~ color
|
||||
- ~50 lines
|
||||
|
||||
~400 lines total. Dependencies: Phase 4 (theme), Phase 2 (renderables).
|
||||
- Markdown parser: headings, bold/italic/code, links, code blocks,
|
||||
blockquotes, lists, thematic breaks
|
||||
- Syntax highlighting: regex-based for Lisp keywords, comments, strings
|
||||
- Diff rendering: added/removed/context lines with colored backgrounds
|
||||
- ANSI rendering via raw escape sequences
|
||||
|
||||
** v0.9.0: Dialog System + Toast
|
||||
|
||||
Modal overlays and transient notifications.
|
||||
DONE. Modal overlays and transient notifications.
|
||||
|
||||
*** TODO Dialog base
|
||||
:PROPERTIES:
|
||||
:ID: id-v090-dialog
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(defclass dialog ...)~ — absolute-positioned overlay with backdrop
|
||||
- Backdrop: semi-transparent (dimmed background color)
|
||||
- Centered panel with ~:background-panel~ color, border
|
||||
- ~:on-dismiss~ callback — fires on Esc or backdrop click
|
||||
- ~:size~ — ~:small~ (40 cols), ~:medium~ (60 cols), ~:large~ (88 cols). Height computed from content.
|
||||
- Stack-based: dialogs push/pop on a ~*dialog-stack*~
|
||||
- Esc dismisses top dialog. Ctrl+C clears stack.
|
||||
- ~100 lines
|
||||
|
||||
*** TODO Dialog sub-classes
|
||||
:PROPERTIES:
|
||||
:ID: id-v090-dialog-types
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~alert-dialog~ — title + message + OK button
|
||||
- ~confirm-dialog~ — title + message + Yes/No/Cancel buttons
|
||||
- ~select-dialog~ — wraps a Select component in a modal. Title, searchable list, action buttons
|
||||
- ~prompt-dialog~ — wraps a TextInput in a modal. Title, input, OK/Cancel buttons
|
||||
- ~60 lines
|
||||
|
||||
*** TODO Toast notifications
|
||||
:PROPERTIES:
|
||||
:ID: id-v090-toast
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- ~(toast title &key variant duration)~ — shows a transient notification
|
||||
- Variants: ~:info~ (blue), ~:success~ (green), ~:warning~ (yellow), ~:error~ (red) — colored left border
|
||||
- ~:duration~ — auto-dismiss after N milliseconds (default 5000)
|
||||
- Position: top-right corner, max 60 cols wide
|
||||
- Multiple toasts stack vertically
|
||||
- ~60 lines
|
||||
|
||||
~220 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme), Phase 5 (TextInput), Phase 7 (Select).
|
||||
- =Dialog= — centered modal with backdrop dimming, size variants
|
||||
- =push-dialog= / =pop-dialog= — stack-based dialog management
|
||||
- =alert-dialog=, =confirm-dialog=, =select-dialog=, =prompt-dialog=
|
||||
- =Toast= — transient notification with variants (:info/:success/:warning/:error),
|
||||
auto-dismiss, top-right positioning
|
||||
|
||||
** v0.10.0: Mouse Support
|
||||
|
||||
Mouse event propagation through the component tree.
|
||||
DONE (minimal). Mouse event handling via mixin class.
|
||||
|
||||
*** TODO Mouse events
|
||||
:PROPERTIES:
|
||||
:ID: id-v100-mouse
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- Enable croatoan mouse mode: ~(setf (mouse-enabled-p window) t)~
|
||||
- Parse ncurses mouse codes: button (left/right/middle), state (press/release/drag), x, y
|
||||
- Ctrl/Shift/Meta modifiers from mouse event
|
||||
- ~:on-mouse-down~, ~:on-mouse-up~, ~:on-mouse-move~, ~:on-mouse-scroll~ callbacks on components
|
||||
- Hit-testing: walk the component tree from root, find the deepest component whose rect contains (x, y)
|
||||
- Event propagation: component consumes event by returning T from callback; otherwise bubbles to parent
|
||||
- Scroll wheel: mapped to PageUp/PageDown in ScrollBox
|
||||
- Click on OSC 8 link: extract URL, open via ~xdg-open~
|
||||
- ~100 lines
|
||||
|
||||
*** TODO Text selection + copy
|
||||
:PROPERTIES:
|
||||
:ID: id-v100-selection
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
|
||||
- Mouse drag: highlight text between drag start and current position
|
||||
- ~(get-selection)~ — returns the selected text as a string
|
||||
- Copy: pipe selection to ~xclip~ / ~wl-copy~ / ~pbcopy~
|
||||
- ~50 lines
|
||||
|
||||
~150 lines total. Dependencies: Phase 3 (rendering engine).
|
||||
- =mouse-mixin= — event handler slots (:on-mouse-down/up/move/scroll)
|
||||
- =handle-mouse-event= — dispatch to component handlers
|
||||
- =hit-test= — find deepest component at (x, y)
|
||||
- =selection= struct and =copy-to-clipboard=
|
||||
|
||||
** v0.11.0: Plugin / Slot System
|
||||
|
||||
Extensible named slots. Applications and plugins register content into named
|
||||
slots. The component tree renders whatever is registered.
|
||||
DONE. Extensible named slots for registering content into extensible positions.
|
||||
|
||||
*** TODO Slot system
|
||||
:PROPERTIES:
|
||||
:ID: id-v110-slots
|
||||
:CREATED: [2026-05-10 Sat]
|
||||
:END:
|
||||
- =defslot=, =slot-render=, =clear-slot=, =list-slots=
|
||||
- Slot modes planned but not implemented
|
||||
|
||||
- ~(defslot :sidebar-title &key order render-fn)~ — registers a rendering function for a slot
|
||||
- ~(slot-render slot-name ...)~ — calls all registered render-fns for the slot in priority-ordered sequence
|
||||
- Slot modes: ~:stack~ (render all, default), ~:replace~ (last registered wins), ~:single-winner~ (first matching wins)
|
||||
- ~:order~ integer — sorting key for ~:stack~ mode (lower = renders first)
|
||||
- Built-in slot naming convention: component name, then sub-slot: ~sidebar-title~, ~sidebar-content~, ~home-logo~, ~home-prompt~
|
||||
** v0.12.0: Terminal Capability Detection
|
||||
|
||||
DONE. Auto-detect terminal capabilities at startup and return the
|
||||
appropriate backend.
|
||||
|
||||
- Check if stdout is a TTY (if not -> simple-backend)
|
||||
- =detect-backend= -> returns =modern-backend= or =simple-backend=
|
||||
- Send DA1 query (~ESC[c~), 100ms timeout
|
||||
- Send DA3 (~ESC[?c~) for kitty/wezterm identification
|
||||
- Query DECRPM (~ESC[?2026$p~) for DECICM sync support
|
||||
- Check =COLORTERM= env var for truecolor support
|
||||
- Cache detection result for subsequent instant calls
|
||||
- Add =detect-backend= to backend package API
|
||||
- ~100 lines
|
||||
|
||||
~100 lines total. Dependencies: Phase 2 (renderables + layout).
|
||||
** v0.13.0: Rendering Pipeline
|
||||
|
||||
* v1.0.0: Complete Framework
|
||||
DONE. A pure CL rendering pipeline — framebuffer diffing for incremental
|
||||
output, scissor clipping, and render-command dispatching.
|
||||
|
||||
All 11 phases integrated and tested. Applications can build rich terminal UIs
|
||||
from the component library without writing custom ncurses code.
|
||||
- =*framebuffer*= — 2D array of (char, fg, bg, attrs) tuples
|
||||
- =flush-framebuffer= — compares current to previous, writes only changed cells
|
||||
- =with-scissor= — clips all render operations to a rectangle
|
||||
- Component =render= methods produce render commands, not direct backend calls
|
||||
- =diff-output= framework for minimum-escape optimization
|
||||
- ~250 lines
|
||||
|
||||
* Neurosymbolic Phase Reference
|
||||
** v0.14.0: Mouse Improvements
|
||||
|
||||
| Phase | Component | Lines | Release |
|
||||
|-------+------------------------------------+--------+---------|
|
||||
| 1 | Layout engine (Yoga FFI + API) | ~350 | v0.1.0 |
|
||||
| 2 | Renderables (Box, Text) + dirty | ~300 | v0.2.0 |
|
||||
| 3 | Rendering engine (diff, scissor) | ~300 | v0.3.0 |
|
||||
| 4 | Theme engine (tokens, presets) | ~290 | v0.4.0 |
|
||||
| 5 | TextInput + Textarea + keybindings | ~500 | v0.5.0 |
|
||||
| 6 | ScrollBox + TabBar | ~300 | v0.6.0 |
|
||||
| 7 | Select (dropdown + fuzzy filter) | ~150 | v0.7.0 |
|
||||
| 8 | Markdown + Code + Diff | ~400 | v0.8.0 |
|
||||
| 9 | Dialog system + Toast | ~220 | v0.9.0 |
|
||||
| 10 | Mouse support + selection | ~150 | v0.10.0 |
|
||||
| 11 | Plugin / slot system | ~100 | v0.11.0 |
|
||||
|-------+------------------------------------+--------+---------|
|
||||
| Total | | ~3060 | |
|
||||
DONE. Enhance mouse support with drag-to-select and link clicking.
|
||||
|
||||
- Text selection via mouse drag (highlight region between drag start/end)
|
||||
- Click on OSC 8 link: extract URL, open via xdg-open
|
||||
- Copy-to-clipboard via xclip/wl-copy/pbcopy
|
||||
- ~80 lines
|
||||
|
||||
** v0.15.0: Bug fixes, demo rewrite, verification, tangle tooling
|
||||
|
||||
DONE. Demo rewrite with interactive tabs, critical bug fixes, and
|
||||
quality-of-life infrastructure.
|
||||
|
||||
- Demo (demo.lisp): full rewrite with Console, Components, Layout,
|
||||
Events tabs — tab navigation, scrollbox with hot-reload, layout
|
||||
visualization with live row/column swapping, event logging panel
|
||||
- Demo uses backend-size instead of hardcoded 80x24
|
||||
- Box title rendering: modern and simple backends now render titles
|
||||
with title and title-align parameters
|
||||
- Cursor rendering: text-input cursor renders as solid block at
|
||||
cursor position
|
||||
- Arrow key fix: demo arrow keys on Widgets tab no longer steal
|
||||
focus from tab bar
|
||||
- read-raw-byte buffer fix: sb-sys:with-pinned-objects + vector-sap
|
||||
for proper sb-posix:read buffer (SBCL type error with plain arrays)
|
||||
- EOF detection: read-raw-byte returns (values nil :eof) on stdin
|
||||
EOF, not nil — prevents 100% CPU busy-spin on pipes
|
||||
- Escape key: 50ms timeout in read-escape-sequence to disambiguate
|
||||
lone Escape from escape-prefixed sequences
|
||||
- confirm-dialog: fix option plist comparison (was comparing
|
||||
objects, not keys)
|
||||
- mouse-event: button slot type changed from keyword to (or keyword
|
||||
null)
|
||||
- tangle tooling: replace Emacs org-babel-tangle with pure-Python
|
||||
script (scripts/tangle.py, later moved to Hermes skill)
|
||||
- Verification: verify-api.py (API smoke tests), verify-demo-pty.py
|
||||
(PTY-based demo verification — 17 checks)
|
||||
- tangle.py fix: write-once-then-append logic (was always-appending,
|
||||
triplicating files)
|
||||
- Org/Lisp sync: verified — 483+57+17 checks pass on fresh tangle
|
||||
- Project restructure: move backend/ and layout/ into src/
|
||||
- .gitignore for compiled fasl files
|
||||
- ~500 lines of changes across the codebase
|
||||
|- Version: v1.0.0 (current)
|
||||
|
||||
Known gaps from earlier phases:
|
||||
- (none — all protocol spec items implemented)
|
||||
|
||||
** v1.0.0: Release
|
||||
|
||||
DONE. All phases integrated and tested. Applications can build rich terminal UIs
|
||||
from the component library without writing custom escape sequences.
|
||||
|
||||
Checklist:
|
||||
- [X] README.org with overview, architecture, component table, quick start
|
||||
- [X] demo.lisp — working interactive example
|
||||
- [X] Full test suite: 454 checks, 100% passing across 14 suites
|
||||
- [X] ASDF system with test-op
|
||||
- [X] LICENSE file (GPL 3.0)
|
||||
- [X] Literate org files for all modules
|
||||
- [X] Terminal capability detection (v0.12.0)
|
||||
- [X] Rendering pipeline (v0.13.0)
|
||||
- [X] Mouse improvements (v0.14.0)
|
||||
- [X] Org/Lisp sync verified (first tangle produces no regressions)
|
||||
- [X] Suspend/resume-backend protocol methods (ARCHITECTURE.org spec)
|
||||
- [X] Slot modes (defslot :mode parameter)
|
||||
|
||||
** v1.1.0: SGR Mouse Event Parsing
|
||||
|
||||
DONE. ~read-event~ now decodes SGR extended mouse sequences
|
||||
(~ESC[<Cb;Cx;CyM/m~) into structured ~mouse-event~ structs, where previously
|
||||
they fell through as ~:unknown~ key events and printed as control characters.
|
||||
|
||||
What was added:
|
||||
- ~%read-digits~ — reads multi-digit numeric parameters from raw terminal
|
||||
bytes, handling arbitrary-length values (e.g. coordinates > 99)
|
||||
- ~%parse-sgr-mouse~ — full SGR mouse decoder: button code → keyword
|
||||
(~:left~, ~:middle~, ~:right~, ~:scroll-up~, ~:scroll-down~, ~:drag~),
|
||||
press/release detection, 1-based → 0-based coordinate conversion
|
||||
- ~parse-csi-sequence~ detects the ~~<~~ marker byte (0x3C) and delegates
|
||||
to ~%parse-sgr-mouse~ instead of treating the sequence as keyboard input
|
||||
|
||||
The mouse enable/disable sequences were already sent by
|
||||
~initialize-backend~/~shutdown-backend~ (lines 126-128, 139-141 of
|
||||
~modern.lisp~). The parsing gap was the only missing piece.
|
||||
|
||||
Test coverage: 461 unit tests + 32 integration tests, all at 100%.
|
||||
Org source: ~org/text-input.org~ (tangled to ~src/components/input.lisp~).
|
||||
|
||||
** Feature Reference
|
||||
|
||||
| Phase | Component | Lines | Release | Status |
|
||||
|-------+----------------------------------------+--------+---------|--------|
|
||||
| 0 | Backend protocol (simple + modern) | ~180 | v0.0.1 | DONE |
|
||||
| - | Layout engine (pure CL flexbox) | ~190 | - | DONE |
|
||||
| 1 | Renderables (Box, Text) + dirty | ~300 | v0.2.0 | DONE |
|
||||
| 2 | Theme engine (tokens, presets) | ~120 | v0.4.0 | DONE |
|
||||
| 3 | TextInput + Textarea + keybindings | ~500 | v0.5.0 | DONE |
|
||||
| 4 | ScrollBox + TabBar | ~200 | v0.6.0 | DONE |
|
||||
| 5 | Select (dropdown + fuzzy filter) | ~150 | v0.7.0 | DONE |
|
||||
| 6 | Markdown + Code + Diff | ~400 | v0.8.0 | DONE |
|
||||
| 7 | Dialog system + Toast | ~220 | v0.9.0 | DONE |
|
||||
| 8 | Mouse support | ~80 | v0.10.0 | DONE |
|
||||
| 9 | Plugin / slot system | ~50 | v0.11.0 | DONE |
|
||||
| 10 | Terminal capability detection | ~100 | v0.12.0 | DONE |
|
||||
| 11 | Rendering pipeline (framebuffer diff) | ~250 | v0.13.0 | DONE |
|
||||
| 12 | Mouse improvements (selection, links) | ~80 | v0.14.0 | DONE |
|
||||
| 13 | Bug fixes, demo rewrite, verification | ~500 | v0.15.0 | DONE |
|
||||
|-------+----------------------------------------+--------+---------|--------|
|
||||
| | Total | ~5760 | | |
|
||||
|
||||
@@ -1,127 +0,0 @@
|
||||
# v0.2.0: Renderables — Box and Text
|
||||
|
||||
> Implementation plan for the first two renderable component types.
|
||||
|
||||
**Goal:** Create Box (border+background+title) and Text (styled wrapping text) renderables that render through the backend protocol.
|
||||
|
||||
**Architecture:** Each renderable is a CLOS class with a `layout-node` slot for positioning. The `render` method dispatches through the backend protocol (draw-text, draw-border, draw-rect). Tests capture backend output via string streams.
|
||||
|
||||
**Files created:**
|
||||
- `org/box-renderable.org` — Box class, render method (literate source)
|
||||
- `org/text-renderable.org` — Text class, render method, inline spans (literate source)
|
||||
- `org/dirty-tracking.org` — Dirty flag system (literate source)
|
||||
- `src/components/box.lisp` — tangled
|
||||
- `src/components/text.lisp` — tangled
|
||||
- `src/components/dirty.lisp` — tangled
|
||||
|
||||
**Files modified:**
|
||||
- `cl-tui.asd` — add component modules
|
||||
- `docs/ROADMAP.org` — mark v0.2.0 tasks DONE
|
||||
|
||||
## Task 1: Box renderable
|
||||
|
||||
**Objective:** Box class that draws borders, fills backgrounds, and renders titles.
|
||||
|
||||
**Files:**
|
||||
- Create: `org/box-renderable.org`
|
||||
- Create: `src/components/box.lisp` (extracted)
|
||||
- Modify: `cl-tui.asd` — add components module
|
||||
|
||||
**Box class:**
|
||||
```lisp
|
||||
(defclass box ()
|
||||
((layout-node :initarg :layout-node :accessor box-layout-node)
|
||||
(border-style :initform :single :initarg :border-style :accessor box-border-style)
|
||||
(title :initform nil :initarg :title :accessor box-title)
|
||||
(title-align :initform :left :initarg :title-align :accessor box-title-align)
|
||||
(fg :initform nil :initarg :fg :accessor box-fg)
|
||||
(bg :initform nil :initarg :bg :accessor box-bg)))
|
||||
```
|
||||
|
||||
**render-box method:**
|
||||
Renders at computed layout position using backend's draw-border, draw-rect, draw-text.
|
||||
Delegates to the backend — no escape sequences directly.
|
||||
|
||||
**Tests:**
|
||||
- Create box with border, verify draw-border was called with correct params
|
||||
- Create box with title, verify title positioning
|
||||
- Create box with background fill
|
||||
- Edge cases: box with 0 width/height, no border style, very long title
|
||||
|
||||
## Task 2: Text renderable
|
||||
|
||||
**Objective:** Text class that renders strings at layout position with word-wrap.
|
||||
|
||||
**Files:**
|
||||
- Create: `org/text-renderable.org`
|
||||
- Create: `src/components/text.lisp` (extracted)
|
||||
|
||||
**Text class:**
|
||||
```lisp
|
||||
(defclass text ()
|
||||
((layout-node :initarg :layout-node :accessor text-layout-node)
|
||||
(content :initarg :content :accessor text-content)
|
||||
(fg :initform nil :initarg :fg :accessor text-fg)
|
||||
(bg :initform nil :initarg :bg :accessor text-bg)
|
||||
(wrap-mode :initform :word :initarg :wrap-mode :accessor text-wrap-mode)
|
||||
(spans :initform nil :initarg :spans :accessor text-spans)))
|
||||
```
|
||||
|
||||
**render-text method:**
|
||||
1. Get layout position (x, y, width, height)
|
||||
2. If wrap-mode is :none, truncate to width
|
||||
3. If wrap-mode is :word, word-wrap (break on whitespace)
|
||||
4. Draw each line via backend's draw-text
|
||||
5. Apply span attributes (bold, italic, etc.) per segment
|
||||
|
||||
**Inline spans:**
|
||||
```lisp
|
||||
(defclass span ()
|
||||
((text :initarg :text :accessor span-text)
|
||||
(bold :initform nil :initarg :bold :accessor span-bold)
|
||||
(italic :initform nil :initarg :italic :accessor span-italic)
|
||||
(underline :initform nil :initarg :underline :accessor span-underline)))
|
||||
```
|
||||
|
||||
**Tests:**
|
||||
- Text renders string at correct position
|
||||
- Word-wrap breaks at word boundaries
|
||||
- Truncation mode clips at width
|
||||
- Spans apply style attributes per segment
|
||||
- Empty string rendering
|
||||
- Single character
|
||||
- String shorter than width (no wrapping needed)
|
||||
|
||||
## Task 3: Dirty tracking
|
||||
|
||||
**Objective:** Lightweight dirty-flag system for incremental rendering.
|
||||
|
||||
**Files:**
|
||||
- Create: `org/dirty-tracking.org`
|
||||
- Create: `src/components/dirty.lisp` (extracted)
|
||||
|
||||
```lisp
|
||||
(defgeneric mark-dirty (component))
|
||||
(defgeneric dirty-p (component))
|
||||
(defgeneric mark-clean (component))
|
||||
```
|
||||
|
||||
Default methods mark/check a `dirty` slot on the component. When implemented:
|
||||
- `mark-dirty` — sets dirty flag, propagates to parent
|
||||
- `dirty-p` — returns T if component needs re-render
|
||||
- `mark-clean` — clears dirty flag after render
|
||||
|
||||
**Tests:**
|
||||
- New component is dirty (default)
|
||||
- mark-clean clears dirty flag
|
||||
- dirty-p returns nil after mark-clean
|
||||
- mark-dirty sets dirty flag again
|
||||
|
||||
## Task 4: Wire into ASDF + update roadmap
|
||||
|
||||
**Files:**
|
||||
- Modify: `cl-tui.asd` — add `:module "components"` to both main and test systems
|
||||
- Modify: `docs/ROADMAP.org` — mark v0.2.0 tasks DONE
|
||||
|
||||
**Run full test suite:**
|
||||
All 72 existing tests + new component tests: 100% GREEN.
|
||||
@@ -1,188 +0,0 @@
|
||||
;;; layout — Pure CL Flexbox layout engine
|
||||
|
||||
(defpackage :cl-tui.layout
|
||||
(:use :cl)
|
||||
(:export
|
||||
#:layout-node #:make-layout-node
|
||||
#:layout-node-add-child #:layout-node-remove-child
|
||||
#:layout-node-children
|
||||
#:layout-node-x #:layout-node-y
|
||||
#:layout-node-width #:layout-node-height
|
||||
#:layout-node-direction
|
||||
#:compute-layout
|
||||
#:vbox #:hbox #:spacer
|
||||
;; For tests
|
||||
#:layout-node-parent #:layout-node-fixed-width
|
||||
#:layout-node-fixed-height #:normalize-box
|
||||
#:box-edge))
|
||||
|
||||
(in-package :cl-tui.layout)
|
||||
|
||||
(defun normalize-box (spec)
|
||||
(cond ((null spec) '(:top 0 :right 0 :bottom 0 :left 0))
|
||||
((numberp spec) `(:top ,spec :right ,spec :bottom ,spec :left ,spec))
|
||||
((getf spec :top) spec)
|
||||
(t '(:top 0 :right 0 :bottom 0 :left 0))))
|
||||
|
||||
(defun box-edge (box edge)
|
||||
(or (getf box edge) 0))
|
||||
|
||||
(defclass layout-node ()
|
||||
((parent :initform nil :accessor layout-node-parent)
|
||||
(children :initform nil :accessor layout-node-children)
|
||||
(x :initform 0 :accessor layout-node-x)
|
||||
(y :initform 0 :accessor layout-node-y)
|
||||
(width :initform 0 :accessor layout-node-width)
|
||||
(height :initform 0 :accessor layout-node-height)
|
||||
(direction :initform :column :initarg :direction :accessor layout-node-direction)
|
||||
(grow :initform 0 :initarg :grow :accessor layout-node-grow)
|
||||
(shrink :initform 1 :initarg :shrink :accessor layout-node-shrink)
|
||||
(padding :initform '(:top 0 :right 0 :bottom 0 :left 0) :initarg :padding :accessor layout-node-padding)
|
||||
(margin :initform '(:top 0 :right 0 :bottom 0 :left 0) :initarg :margin :accessor layout-node-margin)
|
||||
(gap :initform 0 :initarg :gap :accessor layout-node-gap)
|
||||
(position-type :initform :relative :initarg :position-type :accessor layout-node-position-type)
|
||||
(position-offset :initform nil :initarg :position-offset :accessor layout-node-position-offset)
|
||||
(fixed-width :initform nil :initarg :width :accessor layout-node-fixed-width)
|
||||
(fixed-height :initform nil :initarg :height :accessor layout-node-fixed-height)))
|
||||
|
||||
(defun make-layout-node (&key direction grow shrink padding margin gap
|
||||
position-type position-offset width height)
|
||||
(make-instance 'layout-node
|
||||
:direction (or direction :column)
|
||||
:grow (or grow 0) :shrink (or shrink 1)
|
||||
:padding (normalize-box padding) :margin (normalize-box margin)
|
||||
:gap (or gap 0)
|
||||
:position-type (or position-type :relative)
|
||||
:position-offset position-offset
|
||||
:width width :height height))
|
||||
|
||||
(defun layout-node-add-child (parent child)
|
||||
(setf (layout-node-parent child) parent)
|
||||
(setf (layout-node-children parent)
|
||||
(nconc (layout-node-children parent) (list child)))
|
||||
child)
|
||||
|
||||
(defun layout-node-remove-child (parent child)
|
||||
(setf (layout-node-parent child) nil)
|
||||
(setf (layout-node-children parent)
|
||||
(delete child (layout-node-children parent)))
|
||||
child)
|
||||
|
||||
;; ── Solver ─────────────────────────────────────────────────────
|
||||
|
||||
(defun distribute-sizes (children avail gap horizontal)
|
||||
"Compute child sizes given available space and gap.
|
||||
HORIZONTAL is non-nil when distributing width (row layout).
|
||||
Each child starts from its fixed size (if any). Remaining space
|
||||
is distributed by grow ratio; overflow is reduced by shrink ratio."
|
||||
(let* ((n (length children))
|
||||
(gap-total (* gap (max 0 (1- n))))
|
||||
(base (mapcar (lambda (c)
|
||||
(or (if horizontal
|
||||
(layout-node-fixed-width c)
|
||||
(layout-node-fixed-height c))
|
||||
0))
|
||||
children))
|
||||
(base-total (reduce #'+ base))
|
||||
(remaining (- avail base-total gap-total))
|
||||
(grow-total (reduce #'+ (mapcar #'layout-node-grow children)))
|
||||
(shrink-total (reduce #'+ (mapcar #'layout-node-shrink children))))
|
||||
(mapcar (lambda (c b)
|
||||
(let ((sz b))
|
||||
(when (and (plusp remaining) (plusp grow-total))
|
||||
(incf sz (round (* remaining (/ (layout-node-grow c) grow-total)))))
|
||||
(when (and (minusp remaining) (plusp shrink-total))
|
||||
(decf sz (round (* (abs remaining) (/ (layout-node-shrink c) shrink-total)))))
|
||||
(max 1 sz)))
|
||||
children base)))
|
||||
|
||||
(defun compute-layout (root available-width available-height)
|
||||
"Layout all children of ROOT within the given dimensions.
|
||||
Recursively computes position and size for every node."
|
||||
(labels ((place-children (node x y max-w max-h)
|
||||
(let* ((children (layout-node-children node))
|
||||
(is-row (eql (layout-node-direction node) :row))
|
||||
(pl (box-edge (layout-node-padding node) :left))
|
||||
(pt (box-edge (layout-node-padding node) :top))
|
||||
(pr (box-edge (layout-node-padding node) :right))
|
||||
(pb (box-edge (layout-node-padding node) :bottom))
|
||||
(cw (max 0 (- max-w pl pr)))
|
||||
(ch (max 0 (- max-h pt pb)))
|
||||
(gap (layout-node-gap node))
|
||||
(sizes (distribute-sizes children (if is-row cw ch) gap is-row)))
|
||||
;; Position the node (content area starts at padding inset)
|
||||
(setf (layout-node-x node) (+ x pl)
|
||||
(layout-node-y node) (+ y pt))
|
||||
;; Place each child sequentially
|
||||
(loop :with pos = 0
|
||||
:for child :in children
|
||||
:for size :in sizes
|
||||
:do (if is-row
|
||||
(setf (layout-node-width child) size
|
||||
(layout-node-x child) (+ x pl pos)
|
||||
(layout-node-height child) ch
|
||||
(layout-node-y child) (+ y pt))
|
||||
(setf (layout-node-height child) size
|
||||
(layout-node-y child) (+ y pt pos)
|
||||
(layout-node-width child) cw
|
||||
(layout-node-x child) (+ x pl)))
|
||||
(place-children child
|
||||
(layout-node-x child)
|
||||
(layout-node-y child)
|
||||
(if is-row size cw)
|
||||
(if is-row ch size))
|
||||
(incf pos (+ size gap)))
|
||||
;; Compute own size from children
|
||||
(let ((last-child (car (last children))))
|
||||
(if is-row
|
||||
(setf (layout-node-width node)
|
||||
(or (layout-node-fixed-width node)
|
||||
(if last-child
|
||||
(+ (layout-node-x node)
|
||||
(layout-node-width last-child)
|
||||
pr)
|
||||
max-w))
|
||||
(layout-node-height node)
|
||||
max-h)
|
||||
(setf (layout-node-height node)
|
||||
(or (layout-node-fixed-height node)
|
||||
(if last-child
|
||||
(let ((last-y (layout-node-y last-child))
|
||||
(last-h (layout-node-height last-child)))
|
||||
(+ last-y last-h pb))
|
||||
max-h))
|
||||
(layout-node-width node)
|
||||
max-w))))))
|
||||
(place-children root 0 0 available-width available-height)
|
||||
root))
|
||||
|
||||
;; ── Macros ─────────────────────────────────────────────────────
|
||||
|
||||
(defmacro vbox ((&key grow shrink padding margin gap width height) &body children)
|
||||
(let ((n (gensym)))
|
||||
`(let ((,n (make-layout-node :direction :column
|
||||
,@(when grow `(:grow ,grow))
|
||||
,@(when shrink `(:shrink ,shrink))
|
||||
,@(when padding `(:padding ,padding))
|
||||
,@(when margin `(:margin ,margin))
|
||||
,@(when gap `(:gap ,gap))
|
||||
,@(when width `(:width ,width))
|
||||
,@(when height `(:height ,height)))))
|
||||
,@(loop for c in children collect `(layout-node-add-child ,n ,c))
|
||||
,n)))
|
||||
|
||||
(defmacro hbox ((&key grow shrink padding margin gap width height) &body children)
|
||||
(let ((n (gensym)))
|
||||
`(let ((,n (make-layout-node :direction :row
|
||||
,@(when grow `(:grow ,grow))
|
||||
,@(when shrink `(:shrink ,shrink))
|
||||
,@(when padding `(:padding ,padding))
|
||||
,@(when margin `(:margin ,margin))
|
||||
,@(when gap `(:gap ,gap))
|
||||
,@(when width `(:width ,width))
|
||||
,@(when height `(:height ,height)))))
|
||||
,@(loop for c in children collect `(layout-node-add-child ,n ,c))
|
||||
,n)))
|
||||
|
||||
(defmacro spacer (&key grow)
|
||||
`(make-layout-node :grow ,(or grow 1)))
|
||||
@@ -1,175 +0,0 @@
|
||||
(defpackage :cl-tui-layout-test
|
||||
(:use :cl :fiveam :cl-tui.layout)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tui-layout-test)
|
||||
|
||||
(def-suite layout-suite :description "Layout engine tests")
|
||||
(in-suite layout-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'layout-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
|
||||
(test make-layout-node-defaults
|
||||
(let ((n (make-layout-node)))
|
||||
(is (typep n 'layout-node))
|
||||
(is (eql (layout-node-direction n) :column))))
|
||||
|
||||
(test make-layout-node-row
|
||||
(let ((n (make-layout-node :direction :row)))
|
||||
(is (eql (layout-node-direction n) :row))))
|
||||
|
||||
(test add-child-sets-parent
|
||||
(let ((parent (make-layout-node)) (child (make-layout-node)))
|
||||
(layout-node-add-child parent child)
|
||||
(is (eql (layout-node-parent child) parent))
|
||||
(is (= (length (layout-node-children parent)) 1))))
|
||||
|
||||
(test remove-child-clears-parent
|
||||
(let ((parent (make-layout-node)) (child (make-layout-node)))
|
||||
(layout-node-add-child parent child)
|
||||
(layout-node-remove-child parent child)
|
||||
(is (null (layout-node-parent child)))
|
||||
(is (= (length (layout-node-children parent)) 0))))
|
||||
|
||||
(test column-two-children-vertical
|
||||
(let* ((root (make-layout-node :direction :column))
|
||||
(c1 (make-layout-node :height 3))
|
||||
(c2 (make-layout-node :height 5)))
|
||||
(layout-node-add-child root c1) (layout-node-add-child root c2)
|
||||
(compute-layout root 20 20)
|
||||
(is (= (layout-node-y c1) 0)) (is (= (layout-node-height c1) 3))
|
||||
(is (= (layout-node-y c2) 3)) (is (= (layout-node-height c2) 5))))
|
||||
|
||||
(test row-two-children-horizontal
|
||||
(let* ((root (make-layout-node :direction :row))
|
||||
(c1 (make-layout-node :width 10))
|
||||
(c2 (make-layout-node :width 5)))
|
||||
(layout-node-add-child root c1) (layout-node-add-child root c2)
|
||||
(compute-layout root 20 10)
|
||||
(is (= (layout-node-x c1) 0)) (is (= (layout-node-width c1) 10))
|
||||
(is (= (layout-node-x c2) 10)) (is (= (layout-node-width c2) 5))))
|
||||
|
||||
(test flex-grow-distributes-space
|
||||
(let* ((root (make-layout-node :direction :row :width 20))
|
||||
(c1 (make-layout-node :width 4 :grow 1))
|
||||
(c2 (make-layout-node :width 4 :grow 2)))
|
||||
(layout-node-add-child root c1) (layout-node-add-child root c2)
|
||||
(compute-layout root 20 10)
|
||||
(is (= (layout-node-width c1) 8)) (is (= (layout-node-width c2) 12))))
|
||||
|
||||
(test flex-grow-single-child
|
||||
(let* ((root (make-layout-node :direction :row :width 20))
|
||||
(c (make-layout-node :width 5 :grow 1)))
|
||||
(layout-node-add-child root c)
|
||||
(compute-layout root 20 10)
|
||||
(is (= (layout-node-width c) 20))))
|
||||
|
||||
(test flex-shrink-reduces-overflow
|
||||
(let* ((root (make-layout-node :direction :row :width 10))
|
||||
(c1 (make-layout-node :width 8 :shrink 1))
|
||||
(c2 (make-layout-node :width 8 :shrink 1)))
|
||||
(layout-node-add-child root c1) (layout-node-add-child root c2)
|
||||
(compute-layout root 10 10)
|
||||
(is (= (layout-node-width c1) 5)) (is (= (layout-node-width c2) 5))))
|
||||
|
||||
(test padding-reduces-content-area
|
||||
(let* ((root (make-layout-node :direction :column :padding '(:top 1 :left 1 :bottom 1 :right 1)))
|
||||
(c (make-layout-node :height 3)))
|
||||
(layout-node-add-child root c)
|
||||
(compute-layout root 20 10)
|
||||
(is (= (layout-node-x c) 1)) (is (= (layout-node-y c) 1))
|
||||
(is (= (layout-node-height c) 3))))
|
||||
|
||||
(test gap-between-children
|
||||
(let* ((root (make-layout-node :direction :column :gap 2))
|
||||
(c1 (make-layout-node :height 3))
|
||||
(c2 (make-layout-node :height 3)))
|
||||
(layout-node-add-child root c1) (layout-node-add-child root c2)
|
||||
(compute-layout root 20 20)
|
||||
(is (= (layout-node-y c1) 0)) (is (= (layout-node-y c2) 5))))
|
||||
|
||||
(test vbox-macro
|
||||
(let ((r (vbox () (make-layout-node :height 3) (make-layout-node :height 5))))
|
||||
(compute-layout r 20 20)
|
||||
(is (= (length (layout-node-children r)) 2))
|
||||
(is (= (layout-node-y (elt (layout-node-children r) 1)) 3))))
|
||||
|
||||
(test hbox-macro
|
||||
(let ((r (hbox () (make-layout-node :width 5) (make-layout-node :width 3))))
|
||||
(compute-layout r 20 10)
|
||||
(is (= (length (layout-node-children r)) 2))
|
||||
(is (= (layout-node-x (elt (layout-node-children r) 1)) 5))))
|
||||
|
||||
(test spacer-takes-grow
|
||||
(let ((r (hbox (:width 20) (make-layout-node :width 5) (spacer :grow 1) (make-layout-node :width 5))))
|
||||
(compute-layout r 20 10)
|
||||
(let ((c (layout-node-children r)))
|
||||
(is (= (layout-node-x (elt c 2)) 15)) (is (= (layout-node-width (elt c 1)) 10)))))
|
||||
|
||||
(test nested-vbox-in-hbox
|
||||
(let* ((sidebar (vbox (:width 5 :height 10) (make-layout-node :height 3) (make-layout-node :height 7)))
|
||||
(main (vbox (:grow 1 :height 10) (make-layout-node :height 2) (make-layout-node :grow 1)))
|
||||
(r (hbox (:width 30 :height 10) sidebar main)))
|
||||
(compute-layout r 30 10)
|
||||
(is (= (layout-node-width sidebar) 5))
|
||||
(is (>= (layout-node-width main) 20))
|
||||
(let ((sc (layout-node-children sidebar)))
|
||||
(is (= (layout-node-y (elt sc 0)) 0))
|
||||
(is (= (layout-node-y (elt sc 1)) 3)))))
|
||||
|
||||
;; ── Edge Cases ────────────────────────────────────────────────
|
||||
|
||||
(test empty-container-does-not-crash
|
||||
"compute-layout on a node with no children should not error"
|
||||
(let ((r (make-layout-node)))
|
||||
(compute-layout r 20 20)
|
||||
(is (integerp (layout-node-width r)))
|
||||
(is (integerp (layout-node-height r)))))
|
||||
|
||||
(test single-child-in-column
|
||||
"A column with one child places it correctly"
|
||||
(let* ((r (make-layout-node :direction :column :width 10 :height 20))
|
||||
(c (make-layout-node :height 5)))
|
||||
(layout-node-add-child r c)
|
||||
(compute-layout r 10 20)
|
||||
(is (= (layout-node-y c) 0))
|
||||
(is (= (layout-node-height c) 5))))
|
||||
|
||||
(test zero-size-container
|
||||
"compute-layout with zero available space should not error"
|
||||
(let* ((r (make-layout-node :direction :column))
|
||||
(c (make-layout-node :height 5)))
|
||||
(layout-node-add-child r c)
|
||||
(compute-layout r 0 0)
|
||||
(is (integerp (layout-node-x c)))
|
||||
(is (integerp (layout-node-y c)))))
|
||||
|
||||
(test deep-nesting-three-levels
|
||||
"Three-level deep nesting produces correct leaf positions"
|
||||
(let* ((out (vbox () ; outer box
|
||||
(vbox (:grow 1) ; middle box
|
||||
(make-layout-node :height 2)))) ; leaf
|
||||
(leaf (elt (layout-node-children
|
||||
(elt (layout-node-children out) 0)) 0)))
|
||||
(compute-layout out 20 20)
|
||||
(is (= (layout-node-y leaf) 0))))
|
||||
|
||||
(test large-padding-leaves-room
|
||||
"Large padding reduces content area but doesn't crash"
|
||||
(let* ((r (make-layout-node :direction :column
|
||||
:padding '(:top 5 :left 5 :bottom 5 :right 5)))
|
||||
(c (make-layout-node :height 3)))
|
||||
(layout-node-add-child r c)
|
||||
(compute-layout r 20 20)
|
||||
(is (= (layout-node-x c) 5))
|
||||
(is (= (layout-node-y c) 5))))
|
||||
|
||||
(test negative-grow-is-clamped
|
||||
"Grow values are adjusted but still compute"
|
||||
(let* ((r (make-layout-node :direction :row :width 10))
|
||||
(c (make-layout-node :width 5 :grow -1)))
|
||||
(layout-node-add-child r c)
|
||||
(compute-layout r 10 10)
|
||||
(is (integerp (layout-node-width c)))))
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,56 +1,104 @@
|
||||
#+TITLE: cl-tui Box Renderable — v0.2.0
|
||||
#+TITLE: Box and Text Renderables
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tui:components:v0.2.0:
|
||||
#+OPTIONS: ^:nil
|
||||
#+FILETAGS: :cl-tty:components:
|
||||
|
||||
* Box Renderable
|
||||
* Overview
|
||||
|
||||
The Box renderable draws a bordered rectangle with optional title and background
|
||||
fill. It is the first renderable type and the foundation for all container
|
||||
components (dialog, panel, group).
|
||||
Box and Text are the two fundamental renderable component types. Box
|
||||
provides a bordered container with optional background fill and title.
|
||||
Text renders strings with word-wrap, color, and inline style spans.
|
||||
|
||||
A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
=render-box= method dispatches through the backend protocol.
|
||||
Both inherit from ~dirty-mixin~ for incremental rendering support and
|
||||
carry a ~layout-node~ for position/size computed by the layout engine.
|
||||
|
||||
** Contract
|
||||
* Contract
|
||||
|
||||
- =(make-box &key border-style title title-align fg bg)= → box
|
||||
Create a Box with optional border style, title, and colors.
|
||||
** Box
|
||||
|
||||
- =(render-box box backend)= → nil
|
||||
Render the box at its computed layout position. Draws background fill,
|
||||
border, and title if configured.
|
||||
- ~(make-box &key border-style title title-align fg bg width height)~ → box
|
||||
- ~(render-box box backend)~ — draw the box at its layout position
|
||||
- Border styles: ~:single~, ~:double~, ~:rounded~, ~nil~ (no border)
|
||||
|
||||
- =(box-layout-node box)= → layout-node
|
||||
Access the underlying layout-node for positioning.
|
||||
** Span
|
||||
|
||||
** Tests
|
||||
- ~(span text &key bold italic underline reverse dim fg bg)~ → span
|
||||
- Inline text segment with per-run style attributes.
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(defpackage :cl-tui-box-test
|
||||
(:use :cl :fiveam :cl-tui.backend :cl-tui.layout)
|
||||
** Text
|
||||
|
||||
- ~(make-text content &key fg bg wrap-mode width height spans)~ → text
|
||||
- ~(render-text text-object backend)~ — render text at layout position
|
||||
- Wrap modes: ~:word~ (break at word boundaries), ~:none~ (truncate)
|
||||
|
||||
** Utilities
|
||||
|
||||
- ~(word-wrap text max-width)~ → list of strings
|
||||
- ~(split-string string)~ → list of words
|
||||
|
||||
* Tests
|
||||
|
||||
** Package and test suite setup
|
||||
|
||||
The test package exports ~run-tests~ so it can be invoked from the
|
||||
top-level test runner. ~fiveam~ imports directly for declarative
|
||||
~test~ and ~is~ forms. The ~box-suite~ collects all box/text tests.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(defpackage :cl-tty-box-test
|
||||
(:use :cl :fiveam :cl-tty.backend :cl-tty.layout :cl-tty.box)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tui-box-test)
|
||||
(in-package :cl-tty-box-test)
|
||||
|
||||
(def-suite box-suite :description "Box renderable tests")
|
||||
(in-suite box-suite)
|
||||
#+END_SRC
|
||||
|
||||
** Test runner entry point
|
||||
|
||||
~run-tests~ is the entry point called from the top-level
|
||||
~run-all-tests.lisp~. It runs the ~box-suite~, explains results to
|
||||
stdout, and exits cleanly with ~uiop:quit~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'box-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
#+END_SRC
|
||||
|
||||
** Capturing backend helper
|
||||
|
||||
~make-capturing-backend~ creates a backend that writes to a
|
||||
~string-output-stream~ so tests can inspect rendered output without
|
||||
actual terminal I/O. Returns the backend and stream as multiple
|
||||
values.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(defun make-capturing-backend ()
|
||||
(let* ((s (make-string-output-stream))
|
||||
(b (make-modern-backend :output-stream s)))
|
||||
(values b s)))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-creates-with-defaults
|
||||
|
||||
Verify that a bare ~make-box~ returns a ~box~ instance and
|
||||
automatically creates a ~layout-node~ through inheritance.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-creates-with-defaults
|
||||
"A box created with no arguments has reasonable defaults"
|
||||
(let ((b (make-box)))
|
||||
(is (typep b 'box))
|
||||
(is (typep (box-layout-node b) 'layout-node))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-renders-border
|
||||
|
||||
Verify that a box with ~:border-style :single~ draws the four corner
|
||||
characters (┌ ┐ └ ┘) in the output stream.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-renders-border
|
||||
"A box with border draws border characters"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
@@ -62,7 +110,14 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(is (search "┐" out) "top-right corner")
|
||||
(is (search "└" out) "bottom-left corner")
|
||||
(is (search "┘" out) "bottom-right corner")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-renders-background
|
||||
|
||||
Verify that a box with ~:bg :red~ emits SGR background color codes
|
||||
(41m) in the output stream.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-renders-background
|
||||
"A box with background color fills interior"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
@@ -70,10 +125,16 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(compute-layout (box-layout-node bx) 5 3)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
;; Should contain SGR background escape for red
|
||||
(is (search "48;2;255;0;0" out) "SGR background should be red")
|
||||
(is (search "┌" out) "border with background")))))
|
||||
(is (search "┌" out) "border with background")
|
||||
(is (search "41m" out) "SGR background for red")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-renders-title
|
||||
|
||||
Verify that a title string appears in the rendered output stream
|
||||
when ~:title~ is provided.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-renders-title
|
||||
"A box with title renders the title text"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
@@ -82,7 +143,14 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "title text should appear")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-without-border
|
||||
|
||||
Verify that ~:border-style nil~ suppresses corner characters but
|
||||
background fill rendering continues to work.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-without-border
|
||||
"A box with border-style nil draws no border"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
@@ -90,19 +158,48 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(compute-layout (box-layout-node bx) 5 3)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "48;2;255;0;0" out) "background still renders")
|
||||
;; No border chars
|
||||
(is (search "41m" out) "background still renders")
|
||||
(is-false (search "┌" out) "no top-left corner")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-zero-size
|
||||
|
||||
Verify that a box with zero width and height produces no output
|
||||
(triggers the early-return guard in ~render-box~).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-zero-size
|
||||
"A zero-size box renders nothing"
|
||||
"A box with any zero dimension renders nothing"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 0 :height 0)))
|
||||
(compute-layout (box-layout-node bx) 0 0)
|
||||
(render-box bx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"zero-size box produces no output"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-single-column
|
||||
|
||||
Verify that a box with width 1 produces no output — ~draw-border~
|
||||
requires at least 2 columns to draw corner and edge characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-single-column
|
||||
"A box with width 1 renders nothing (needs min 2 for border)"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 1 :height 5)))
|
||||
(compute-layout (box-layout-node bx) 1 5)
|
||||
(render-box bx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"width=1 box renders nothing"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: box-minimum-size
|
||||
|
||||
Verify that a 2x2 box (the minimum viable size for border rendering)
|
||||
still produces corner characters in the output.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test box-minimum-size
|
||||
"A box with minimum non-zero size still renders"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
@@ -113,12 +210,164 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(is (search "┌" out) "2x2 box still has borders")))))
|
||||
#+END_SRC
|
||||
|
||||
** Implementation
|
||||
** Test: text-creates-with-defaults
|
||||
|
||||
#+BEGIN_SRC lisp
|
||||
(in-package :cl-tui.box)
|
||||
Verify that ~make-text~ with an empty string returns a ~text~
|
||||
instance and creates a ~layout-node~.
|
||||
|
||||
(defclass box ()
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-creates-with-defaults
|
||||
"A text created with no arguments has reasonable defaults"
|
||||
(let ((txt (make-text "")))
|
||||
(is (typep txt 'text))
|
||||
(is (typep (text-layout-node txt) 'layout-node))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: text-renders-content
|
||||
|
||||
Verify that text content appears in the captured output stream after
|
||||
rendering.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-renders-content
|
||||
"A text renders its content at position"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello" :width 10 :height 1)))
|
||||
(compute-layout (text-layout-node tx) 10 1)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "content should appear")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: text-empty-string
|
||||
|
||||
Verify that an empty string produces no output (triggers the
|
||||
early-return guard in ~render-text~).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-empty-string
|
||||
"Empty text produces no output"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "" :width 10 :height 1)))
|
||||
(compute-layout (text-layout-node tx) 10 1)
|
||||
(render-text tx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"empty string produces no output"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: text-truncates-when-no-wrap
|
||||
|
||||
Verify that ~:wrap-mode :none~ truncates the content string to fit
|
||||
within the available width, producing only the first N characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-truncates-when-no-wrap
|
||||
"Text with wrap-mode :none truncates at width"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello World" :width 5 :height 1
|
||||
:wrap-mode :none)))
|
||||
(compute-layout (text-layout-node tx) 5 1)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "truncated to first 5 chars")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: text-word-wraps
|
||||
|
||||
Verify that ~:wrap-mode :word~ breaks lines at word boundaries,
|
||||
distributing words across successive rows.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-word-wraps
|
||||
"Text with wrap-mode :word wraps at word boundaries"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello brave new world" :width 6 :height 3)))
|
||||
(compute-layout (text-layout-node tx) 6 3)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "first line")
|
||||
(is (search "brave" out) "second line")
|
||||
(is (search "new" out) "third line")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: text-word-wrap-single-word
|
||||
|
||||
Verify that a single word longer than the available width is
|
||||
hard-broken at character boundaries into ~max-width~-sized chunks.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test text-word-wrap-single-word
|
||||
"A word longer than width is hard-broken at max-width"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello" :width 3 :height 3)))
|
||||
(compute-layout (text-layout-node tx) 3 3)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hel" out) "first chunk is Hel")
|
||||
(is (search "lo" out) "second chunk is lo")))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: span-creates-with-attributes
|
||||
|
||||
Verify that ~span~ stores its text content and style attributes
|
||||
correctly, with unset attributes defaulting to ~nil~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test span-creates-with-attributes
|
||||
"A span has text and optional style attributes"
|
||||
(let ((s (span "bold text" :bold t)))
|
||||
(is (string= (span-text s) "bold text"))
|
||||
(is-true (span-bold s))
|
||||
(is-false (span-italic s))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: make-text-with-spans
|
||||
|
||||
Verify that ~make-text~ with ~:spans~ stores the provided span
|
||||
objects and they are accessible via ~text-spans~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box-tests.lisp
|
||||
(test make-text-with-spans
|
||||
"Text with spans stores span objects"
|
||||
(let* ((sp (list (span "Hello" :bold t)
|
||||
(span "World" :italic t)))
|
||||
(tx (make-text "" :spans sp)))
|
||||
(is (= (length (text-spans tx)) 2))
|
||||
(is (string= (span-text (elt (text-spans tx) 0)) "Hello"))
|
||||
(is-true (span-bold (elt (text-spans tx) 0)))))
|
||||
|
||||
(test test-char-width-ascii
|
||||
"ASCII characters (< 128) have width 1."
|
||||
(is (= 1 (char-width #\a)))
|
||||
(is (= 1 (char-width #\Space)))
|
||||
(is (= 1 (char-width #\@))))
|
||||
|
||||
(test test-char-width-tab
|
||||
"Tab character has width 8."
|
||||
(is (= 8 (char-width #\Tab))))
|
||||
|
||||
(test test-char-width-cjk
|
||||
"CJK characters have width 2."
|
||||
(is (= 2 (char-width #\日))))
|
||||
|
||||
(test test-char-width-null
|
||||
"Null character has width 0."
|
||||
(is (= 0 (char-width #\Nul))))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
** Box class
|
||||
|
||||
~box~ inherits from ~dirty-mixin~ so changes (resize, title update,
|
||||
color change) trigger incremental re-render. The ~layout-node~ slot
|
||||
holds the computed position and size from the layout engine. Border
|
||||
style, title, alignment, and colors are all configurable slots.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box.lisp
|
||||
(in-package :cl-tty.box)
|
||||
|
||||
(defclass box (dirty-mixin)
|
||||
((layout-node :initform (make-layout-node) :accessor box-layout-node
|
||||
:initarg :layout-node)
|
||||
(border-style :initform :single :initarg :border-style
|
||||
@@ -128,7 +377,15 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
:accessor box-title-align)
|
||||
(fg :initform nil :initarg :fg :accessor box-fg)
|
||||
(bg :initform nil :initarg :bg :accessor box-bg)))
|
||||
#+END_SRC
|
||||
|
||||
** make-box constructor
|
||||
|
||||
The constructor wraps ~make-instance~ and passes layout parameters
|
||||
through to the layout node. Width and height are optional; when
|
||||
omitted the layout engine will compute them from parent constraints.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box.lisp
|
||||
(defun make-box (&key (border-style :single) title
|
||||
(title-align :left) fg bg
|
||||
width height)
|
||||
@@ -142,7 +399,19 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
:width width
|
||||
:height height
|
||||
:direction :column)))
|
||||
#+END_SRC
|
||||
|
||||
** render-box function
|
||||
|
||||
~render-box~ draws the border at the component's layout position.
|
||||
It handles zero-size (returns immediately) and optional background
|
||||
fill. The early return for ~(< w 2)~ is important: ~draw-border~
|
||||
requires at least 2 columns of width to draw corner characters.
|
||||
Title rendering supports ~:left~, ~:center~, and ~:right~ alignment
|
||||
with automatic truncation when the title is wider than available
|
||||
content area (width-4 when border is present).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/box.lisp
|
||||
(defun render-box (box backend)
|
||||
"Render BOX at its computed layout position using BACKEND."
|
||||
(let ((ln (box-layout-node box))
|
||||
@@ -154,16 +423,219 @@ A Box has a =layout-node= slot for positioning via the layout engine. Its
|
||||
(y (layout-node-y ln))
|
||||
(w (layout-node-width ln))
|
||||
(h (layout-node-height ln)))
|
||||
(when (and (zerop w) (zerop h))
|
||||
(when (or (zerop w) (zerop h) (< w 2) (< h 2))
|
||||
(return-from render-box (values)))
|
||||
(when bg
|
||||
(draw-rect backend x y w h :bg bg))
|
||||
(when bs
|
||||
(draw-border backend x y w h
|
||||
:style bs :fg fg :bg bg
|
||||
:title title
|
||||
:title-align (box-title-align box)))
|
||||
(when (and title bs)
|
||||
;; Title is rendered by draw-border — nothing extra needed
|
||||
(values)))))
|
||||
(draw-border backend x y w h :style bs :fg fg :bg bg))
|
||||
(when title
|
||||
(let* ((content-w (- w 4))
|
||||
(tx (+ x 2))
|
||||
(ty (+ y (if bs 1 0)))
|
||||
(ta (box-title-align box))
|
||||
(display (subseq title 0 (min (length title) content-w))))
|
||||
(case ta
|
||||
(:center (draw-text backend (+ x (ceiling (- w (length display)) 2)) ty display fg bg))
|
||||
(:right (draw-text backend (+ x (- w (length display) 2)) ty display fg bg))
|
||||
(t (draw-text backend tx ty display fg bg))))))))
|
||||
#+END_SRC
|
||||
|
||||
** Span class
|
||||
|
||||
~span~ represents an inline styled segment within a Text component.
|
||||
Multiple spans let a single Text contain bold, colored, or italicized
|
||||
runs. Each style attribute is a separate slot so consumers can
|
||||
inspect and apply them individually.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(in-package :cl-tty.box)
|
||||
|
||||
(defclass span ()
|
||||
((text :initarg :text :accessor span-text)
|
||||
(bold :initform nil :initarg :bold :accessor span-bold)
|
||||
(italic :initform nil :initarg :italic :accessor span-italic)
|
||||
(underline :initform nil :initarg :underline :accessor span-underline)
|
||||
(reverse :initform nil :initarg :reverse :accessor span-reverse)
|
||||
(dim :initform nil :initarg :dim :accessor span-dim)
|
||||
(fg :initform nil :initarg :fg :accessor span-fg)
|
||||
(bg :initform nil :initarg :bg :accessor span-bg)))
|
||||
#+END_SRC
|
||||
|
||||
** span constructor
|
||||
|
||||
~span~ is a convenience function for creating ~span~ instances with
|
||||
keyword arguments for all style attributes. A ~nil~ default means
|
||||
"inherit/no-change" when merged with parent styling context.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun span (text &key bold italic underline reverse dim fg bg)
|
||||
(make-instance 'span
|
||||
:text text :bold bold :italic italic
|
||||
:underline underline :reverse reverse :dim dim
|
||||
:fg fg :bg bg))
|
||||
#+END_SRC
|
||||
|
||||
** Text class
|
||||
|
||||
~text~ renders a string at a layout position with word-wrapping.
|
||||
Spans are stored for future per-run styling but the current
|
||||
implementation renders all content as plain text. It inherits from
|
||||
~dirty-mixin~ so content, color, or size changes trigger re-render.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defclass text (dirty-mixin)
|
||||
((layout-node :initform (make-layout-node) :accessor text-layout-node
|
||||
:initarg :layout-node)
|
||||
(content :initform "" :initarg :content :accessor text-content)
|
||||
(spans :initform nil :initarg :spans :accessor text-spans)
|
||||
(fg :initform nil :initarg :fg :accessor text-fg)
|
||||
(bg :initform nil :initarg :bg :accessor text-bg)
|
||||
(wrap-mode :initform :word :initarg :wrap-mode :accessor text-wrap-mode)))
|
||||
#+END_SRC
|
||||
|
||||
** make-text constructor
|
||||
|
||||
~make-text~ is a convenience constructor that accepts layout
|
||||
dimensions and content parameters. It defaults ~wrap-mode~ to ~:word~
|
||||
so text wraps by default, and creates a ~:column~-oriented layout
|
||||
node.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun make-text (content &key fg bg wrap-mode width height spans)
|
||||
(make-instance 'text
|
||||
:content content
|
||||
:fg fg :bg bg
|
||||
:wrap-mode (or wrap-mode :word)
|
||||
:spans spans
|
||||
:layout-node (make-layout-node :direction :column
|
||||
:width width :height height)))
|
||||
#+END_SRC
|
||||
|
||||
** render-text function
|
||||
|
||||
~render-text~ handles both wrap modes. For ~:word~, it calls
|
||||
~word-wrap~ to break the content into lines, then renders each line
|
||||
at successive row positions. For ~:none~, it truncates the content to
|
||||
fit the width in a single line. Empty content or zero dimensions
|
||||
triggers an early return.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun render-text (text-object backend)
|
||||
"Render TEXT-OBJECT at its computed layout position using BACKEND."
|
||||
(let ((ln (text-layout-node text-object))
|
||||
(content (text-content text-object))
|
||||
(fg (text-fg text-object))
|
||||
(bg (text-bg text-object))
|
||||
(wrap (text-wrap-mode text-object))
|
||||
(spans (text-spans text-object)))
|
||||
(declare (ignore spans))
|
||||
(let ((x (layout-node-x ln))
|
||||
(y (layout-node-y ln))
|
||||
(w (layout-node-width ln))
|
||||
(h (layout-node-height ln)))
|
||||
(when (or (zerop (length content)) (zerop w) (zerop h))
|
||||
(return-from render-text (values)))
|
||||
(if (eql wrap :none)
|
||||
(let ((display (subseq content 0 (min (length content) w))))
|
||||
(draw-text backend x y display fg bg))
|
||||
(let ((lines (word-wrap content w))
|
||||
(max-lines h))
|
||||
(loop for line in lines
|
||||
for row from 0 below max-lines
|
||||
do (draw-text backend x (+ y row) line fg bg)))))))
|
||||
#+END_SRC
|
||||
|
||||
** Word wrapping utility
|
||||
|
||||
~word-wrap~ implements the line-breaking algorithm. It splits the
|
||||
input into words, then packs them into lines respecting ~max-width~.
|
||||
Words that exceed ~max-width~ are hard-broken at character boundaries
|
||||
in chunks of ~max-width~ to ensure no line exceeds the limit.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun word-wrap (text max-width)
|
||||
"Split TEXT into lines, each <= MAX-WIDTH chars."
|
||||
(if (or (zerop max-width) (zerop (length text)))
|
||||
(list "")
|
||||
(let ((words (split-string text)) (lines nil) (current nil) (current-len 0))
|
||||
(dolist (word words)
|
||||
(let ((wl (length word)))
|
||||
(cond ((<= wl max-width)
|
||||
(if (and current (<= (+ current-len 1 wl) max-width))
|
||||
(progn
|
||||
(push word current)
|
||||
(incf current-len (1+ wl)))
|
||||
(progn
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines))
|
||||
(setf current (list word))
|
||||
(setf current-len wl))))
|
||||
(t
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines)
|
||||
(setf current nil)
|
||||
(setf current-len 0))
|
||||
(loop for i from 0 below wl by max-width
|
||||
do (push (subseq word i (min (+ i max-width) wl)) lines))))))
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines))
|
||||
(or (nreverse lines) (list "")))))
|
||||
#+END_SRC
|
||||
|
||||
** split-string utility
|
||||
|
||||
~split-string~ tokenizes on whitespace characters (space, tab,
|
||||
newline). It uses ~position-if~ to find delimiters and builds the
|
||||
word list iteratively. Consecutive delimiters are collapsed
|
||||
(only one advance per delimiter character).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun split-string (string)
|
||||
"Split STRING into words separated by whitespace."
|
||||
(loop with words = nil
|
||||
with start = 0
|
||||
with len = (length string)
|
||||
while (< start len)
|
||||
do (let ((ws-start (position-if (lambda (c) (find c '(#\Space #\Tab #\Newline)))
|
||||
string :start start)))
|
||||
(if ws-start
|
||||
(progn
|
||||
(when (> ws-start start)
|
||||
(push (subseq string start ws-start) words))
|
||||
(setf start (1+ ws-start)))
|
||||
(progn
|
||||
(push (subseq string start) words)
|
||||
(setf start len))))
|
||||
finally (return (nreverse words))))
|
||||
#+END_SRC
|
||||
|
||||
** char-width utility
|
||||
|
||||
~char-width~ returns the terminal column width of a character.
|
||||
ASCII < 128 = 1. CJK, fullwidth, emoji = 2. Combining marks = 0.
|
||||
Tab = 8. Used by layout calculations that need to handle
|
||||
variable-width characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/text.lisp
|
||||
(defun char-width (ch)
|
||||
"Returns the terminal column width of character CH."
|
||||
(let ((code (char-code ch)))
|
||||
(cond
|
||||
((= code 9) 8)
|
||||
((< code 32) 0)
|
||||
((<= code 127) 1)
|
||||
((<= #x4E00 code #x9FFF) 2)
|
||||
((<= #x3400 code #x4DBF) 2)
|
||||
((<= #x3040 code #x309F) 2)
|
||||
((<= #x30A0 code #x30FF) 2)
|
||||
((<= #xAC00 code #xD7AF) 2)
|
||||
((<= #xFF01 code #xFF60) 2)
|
||||
((<= #xFFE0 code #xFFE6) 2)
|
||||
((<= #x1F300 code #x1F9FF) 2)
|
||||
((<= #x2600 code #x27BF) 2)
|
||||
((<= #x0300 code #x036F) 0)
|
||||
((<= #x20D0 code #x20FF) 0)
|
||||
((<= #xFE00 code #xFE0F) 0)
|
||||
(t 1))))
|
||||
#+END_SRC
|
||||
|
||||
208
org/detection.org
Normal file
208
org/detection.org
Normal file
@@ -0,0 +1,208 @@
|
||||
#+TITLE: Terminal Capability Detection (v0.12.0)
|
||||
#+DATE: 2026-05-11
|
||||
#+AUTHOR: Amr Gharbeia / Hermes
|
||||
#+STARTUP: content
|
||||
|
||||
* Overview
|
||||
|
||||
Currently, users must manually choose between ~modern-backend~ and
|
||||
~simple-backend~ when initializing cl-tty. This module adds auto-detection:
|
||||
|
||||
1. Check if stdout is a real TTY (not piped/redirected)
|
||||
2. Check the =COLORTERM= environment variable for truecolor support
|
||||
3. Optionally query the terminal via DA1/DA3 escape sequences
|
||||
4. Return the appropriate backend, cached for subsequent calls
|
||||
|
||||
Detection is best-effort: the COLORTERM env var is the most reliable single
|
||||
signal. DA1 queries are asynchronous and many terminals don't respond.
|
||||
If detection can't determine modern capability, it falls back to
|
||||
~simple-backend~.
|
||||
|
||||
** Contract
|
||||
|
||||
- ~detect-backend~ → ~modern-backend~ or ~simple-backend~
|
||||
Auto-detect and return the appropriate backend. Results are cached
|
||||
in ~*detected-backend*~.
|
||||
|
||||
- ~detect-backend-by-env~ → ~:modern~ or ~nil~
|
||||
Check =COLORTERM= env var for ~truecolor~ or ~24bit~.
|
||||
|
||||
- ~detect-backend-by-tty~ → boolean
|
||||
Check if stdout is a real terminal (not a pipe).
|
||||
|
||||
- ~detect-backend-by-da1~ → boolean
|
||||
Send DA1 (~ESC[c~) query and check for modern feature responses.
|
||||
|
||||
- ~*detected-backend*~ — variable
|
||||
Cache for detection result. ~nil~ = not yet detected.
|
||||
|
||||
- ~query-terminal~ — function
|
||||
Low-level escape sequence query helper shared by probes.
|
||||
|
||||
* Plan
|
||||
|
||||
See =docs/plans/2026-05-11-terminal-detection.md= for implementation tasks.
|
||||
|
||||
1. Create ~detection.lisp~ with all detection functions
|
||||
2. Wire into ASDF
|
||||
3. Update ~demo.lisp~ to use ~detect-backend~
|
||||
4. Tangle, test, commit
|
||||
|
||||
* Tests
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
;; Tests are manually added to src/backend/tests.lisp
|
||||
(def-test detection-returns-backend-instance ()
|
||||
(let ((be (cl-tty.backend:detect-backend)))
|
||||
(is-true (typep be 'cl-tty.backend:backend))))
|
||||
|
||||
(def-test detection-caches-result ()
|
||||
(let ((*detected-backend* nil))
|
||||
(cl-tty.backend:detect-backend)
|
||||
(is-true (not (null cl-tty.backend::*detected-backend*)))))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
** Package
|
||||
|
||||
Detection functions are added to the existing ~cl-tty.backend~ package.
|
||||
No new package definition needed.
|
||||
|
||||
** Detection cache
|
||||
|
||||
The ~*detected-backend*~ special variable holds the cached backend instance
|
||||
after the first successful detection. Initializing it to ~nil~ gives downstream
|
||||
code a simple truthiness check — ~(or *detected-backend* ...)~ — so that
|
||||
~detect-backend~ returns immediately on re-entry without re-running probes.
|
||||
|
||||
Using a global variable rather than a closure or class slot keeps the detection
|
||||
path stateless and trivially resettable for testing: binding ~*detected-backend*~
|
||||
to ~nil~ forces a fresh detection run.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(in-package :cl-tty.backend)
|
||||
|
||||
(defvar *detected-backend* nil
|
||||
"Cached backend instance from detect-backend. Nil = not yet detected.")
|
||||
#+END_SRC
|
||||
|
||||
** Environment probe
|
||||
|
||||
The ~COLORTERM~ environment variable is the single most reliable signal for
|
||||
truecolor support. It is set by modern terminal emulators (kitty, Alacritty,
|
||||
GNOME Terminal, iTerm2, Windows Terminal) and has near-zero false-positive
|
||||
rate. Checking it first avoids the I/O costs and race conditions of escape
|
||||
sequence queries.
|
||||
|
||||
Case-insensitive matching via ~char-equal~ handles variances across platforms
|
||||
(GNOME Terminal uses ~truecolor~, some Windows builds use ~24bit~).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(defun detect-backend-by-env ()
|
||||
"Check COLORTERM environment variable for modern terminal support.
|
||||
Returns :modern if COLORTERM contains 'truecolor' or '24bit', nil otherwise."
|
||||
(let ((colorterm (sb-ext:posix-getenv "COLORTERM")))
|
||||
(when (and colorterm
|
||||
(or (search "truecolor" colorterm :test #'char-equal)
|
||||
(search "24bit" colorterm :test #'char-equal)))
|
||||
:modern)))
|
||||
#+END_SRC
|
||||
|
||||
** TTY probe
|
||||
|
||||
The ~interactive-stream-p~ function from the CL standard reliably distinguishes
|
||||
real terminals from pipes and redirected files. If stdout is not a terminal,
|
||||
escape sequence queries will hang or produce garbage, so this check gates all
|
||||
further (I/O-dependent) probes. Must happen before ~detect-backend-by-da1~.
|
||||
|
||||
Testing this predicate first also avoids wasting time on DA1 queries when the
|
||||
output is consumed by a test runner, CI pipeline, or pipe.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(defun detect-backend-by-tty ()
|
||||
"Check if stdout is a real terminal (not a pipe/redirect).
|
||||
Returns T if stdout is interactive, nil otherwise."
|
||||
(interactive-stream-p *standard-output*))
|
||||
#+END_SRC
|
||||
|
||||
** Low-level terminal query helper
|
||||
|
||||
The ~query-terminal~ function encapsulates the mechanics of sending an escape
|
||||
sequence and collecting a response within a short timeout. Writing to
|
||||
~*standard-output*~ and reading from ~*standard-input*~ matches how terminal
|
||||
emulators actually deliver DA1/DA3 response bytes — they arrive on stdin, not
|
||||
on any query I/O stream. The original implementation used ~*query-io*~ for
|
||||
both sides, which silently failed on some emulators.
|
||||
|
||||
Using ~listen~ in a polling loop with ~read-char-no-hang~ captures whatever
|
||||
bytes arrive within the timeout without blocking. The ~0.1~ second default
|
||||
strikes a balance between responsiveness and reliability: fast enough to avoid
|
||||
noticeable delay in interactive use, long enough for most terminals to reply.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(defun query-terminal (query &optional (timeout 0.1))
|
||||
"Send QUERY string to terminal and return any response received within
|
||||
TIMEOUT seconds. Returns the response string, or nil if no response."
|
||||
(write-string query *standard-output*)
|
||||
(force-output *standard-output*)
|
||||
(sleep timeout)
|
||||
(let ((response (make-array 0 :element-type 'character
|
||||
:fill-pointer 0 :adjustable t)))
|
||||
(loop while (listen *standard-input*)
|
||||
do (vector-push-extend (read-char-no-hang *standard-input*) response))
|
||||
(when (plusp (length response))
|
||||
response)))
|
||||
#+END_SRC
|
||||
|
||||
** DA1 capability probe
|
||||
|
||||
The DA1 (Device Attributes) escape sequence (~ESC[c~) is an xterm-standard
|
||||
query that asks the terminal to report its feature set. Modern terminals
|
||||
(notably Kitty, which returns code 62) advertise their capabilities in the
|
||||
response. Searching for ~?62~ in the raw response is a heuristic — it targets
|
||||
Kitty's protocol extension identifier while being short enough to match
|
||||
variants across terminal implementations.
|
||||
|
||||
This probe is best-effort: many terminals do not respond within the timeout,
|
||||
and some return different codes for the same capabilities. A ~nil~ result from
|
||||
this function should never prevent fallback detection via environment variables.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(defun detect-backend-by-da1 ()
|
||||
"Send DA1 (ESC[c) query and check for kitty terminal response code.
|
||||
Returns T if terminal reports kitty compatibility codes."
|
||||
(let ((response (query-terminal (format nil "~C[c" (code-char 27)))))
|
||||
(when response
|
||||
;; DA1 response format: ESC [ ? digits ; digits c
|
||||
;; Kitty reports code 62 in the response
|
||||
(search "?62" response))))
|
||||
#+END_SRC
|
||||
|
||||
** Orchestrator
|
||||
|
||||
The ~detect-backend~ function ties all probes together with a short-circuit
|
||||
caching strategy. On first call, it:
|
||||
|
||||
1. Checks if stdout is a real TTY (fast, gates all I/O)
|
||||
2. Checks ~COLORTERM~ (fast, most reliable signal)
|
||||
3. Falls back to DA1 query (slow, best-effort, skipped if env check passed)
|
||||
|
||||
The ~and~ / ~or~ structure naturally short-circuits: if ~detect-backend-by-tty~
|
||||
returns nil, the expensive DA1 query never runs. If ~detect-backend-by-env~
|
||||
returns ~:modern~, the DA1 query is skipped. The result is cached in
|
||||
~*detected-backend*~ so subsequent calls are effectively free.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/backend/detection.lisp
|
||||
(defun detect-backend ()
|
||||
"Auto-detect the appropriate backend for the current terminal.
|
||||
Returns a backend instance (modern-backend or simple-backend).
|
||||
Result is cached in *detected-backend* for subsequent calls."
|
||||
(or *detected-backend*
|
||||
(setf *detected-backend*
|
||||
(if (and (detect-backend-by-tty)
|
||||
(or (eql (detect-backend-by-env) :modern)
|
||||
(detect-backend-by-da1)))
|
||||
(make-modern-backend)
|
||||
(make-simple-backend)))))
|
||||
#+END_SRC
|
||||
823
org/dialog.org
Normal file
823
org/dialog.org
Normal file
@@ -0,0 +1,823 @@
|
||||
#+TITLE: Dialog System + Toast (v0.9.0)
|
||||
#+DATE: 2026-05-11
|
||||
#+AUTHOR: Amr Gharbeia / Hermes
|
||||
|
||||
* Overview
|
||||
|
||||
Modal overlays (dialogs) and transient notifications (toasts).
|
||||
|
||||
Dialogs are absolute-positioned panels centered on a dimmed backdrop.
|
||||
They stack — a new dialog goes on top, Esc dismisses the top one.
|
||||
|
||||
Toasts are non-blocking notifications that auto-dismiss after a
|
||||
duration. They stack in the top-right corner.
|
||||
|
||||
** Design decisions
|
||||
|
||||
1. /Stack-based dialog management/: a ~*dialog-stack*~ special variable
|
||||
holds the active dialogs. Render walks the stack from bottom to top,
|
||||
drawing each dialog's backdrop over the previous one. This means two
|
||||
dialogs visible at once — the top one gets full interaction.
|
||||
|
||||
2. /Backdrop is a solid dim color, not semi-transparent/: true
|
||||
transparency requires compositing pixel buffers, which is expensive
|
||||
in the terminal. A solid dimmed color over the full screen width
|
||||
communicates "modal" without the complexity.
|
||||
|
||||
3. /Dialogs are components, not separate windows/: they integrate into
|
||||
the existing render tree. The dialog class inherits from the component
|
||||
base and participates in dirty tracking, z-order, etc.
|
||||
|
||||
4. /Toast is fire-and-forget/: ~(toast ...)~ creates a toast component,
|
||||
adds it to a toast list, and schedules auto-dismissal. No lifecycle
|
||||
management needed from the caller.
|
||||
|
||||
** Contract
|
||||
|
||||
- ~dialog~ class — overlay component with backdrop, border, title
|
||||
- ~*dialog-stack*~ — list of active dialogs (bound per-screen)
|
||||
- ~push-dialog dialog~ — add dialog to stack, focus its first input
|
||||
- ~pop-dialog~ — dismiss top dialog, fire :on-dismiss
|
||||
- ~(alert-dialog title message)~ — OK-button alert
|
||||
- ~(confirm-dialog title message &key on-yes on-no)~ — Yes/No/Cancel
|
||||
- ~(select-dialog title options &key on-select)~ — modal Select
|
||||
- ~(prompt-dialog title &key on-submit)~ — modal TextInput
|
||||
- ~toast~ component — transient notification with variant color
|
||||
- ~(toast message &key variant duration)~ — fire-and-forget toast
|
||||
|
||||
* Package definition
|
||||
|
||||
The ~cl-tty.dialog~ package uses the backend, input, and select
|
||||
subsystems. All public symbols are exported for user convenience.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog-package.lisp
|
||||
;;; dialog-package.lisp — Package definition for cl-tty.dialog
|
||||
|
||||
(defpackage :cl-tty.dialog
|
||||
(:use :cl :cl-tty.backend :cl-tty.input :cl-tty.box :cl-tty.layout)
|
||||
(:export
|
||||
;; Dialog
|
||||
#:dialog
|
||||
#:dialog-title
|
||||
#:dialog-content
|
||||
#:dialog-on-dismiss
|
||||
#:dialog-size
|
||||
#:dialog-size-pixels
|
||||
#:render-dialog
|
||||
#:render-select-minibuffer
|
||||
#:push-dialog
|
||||
#:pop-dialog
|
||||
#:*dialog-stack*
|
||||
#:alert-dialog
|
||||
#:confirm-dialog
|
||||
#:select-dialog
|
||||
#:prompt-dialog
|
||||
;; Toast
|
||||
#:toast
|
||||
#:toast-message
|
||||
#:toast-variant
|
||||
#:render-toast
|
||||
#:dismiss-toast
|
||||
#:*toasts*
|
||||
;; Select widget (merged from cl-tty.select)
|
||||
#:select #:make-select
|
||||
#:select-options #:select-filter
|
||||
#:select-selected-index #:select-on-select
|
||||
#:select-layout-node
|
||||
#:select-filtered-options
|
||||
#:select-next #:select-prev
|
||||
#:select-visible-options
|
||||
#:select-handle-key
|
||||
#:render
|
||||
#:fuzzy-match-p))
|
||||
#+END_SRC
|
||||
|
||||
* Special variables
|
||||
|
||||
** *dialog-stack*
|
||||
|
||||
The active dialog stack. ~push-dialog~ conses onto this list;
|
||||
~pop-dialog~ pops it and fires the ~:on-dismiss~ callback. Each screen
|
||||
should bind its own instance so multiple screens can have independent
|
||||
dialog states.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(in-package :cl-tty.dialog)
|
||||
|
||||
(defvar *dialog-stack* nil
|
||||
"Stack of active dialogs. (list) of dialog instances.")
|
||||
#+END_SRC
|
||||
|
||||
** *toasts*
|
||||
|
||||
List of active toast notifications. ~toast~ pushes, ~dismiss-toast~
|
||||
removes by identity. The render loop walks this list to draw toasts in
|
||||
the top-right corner.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defvar *toasts* nil
|
||||
"List of active toast notifications.")
|
||||
#+END_SRC
|
||||
|
||||
* Dialog class
|
||||
|
||||
The core dialog class stores a title, a size preset, the content
|
||||
component to render inside the panel, and an optional ~:on-dismiss~
|
||||
callback invoked when the dialog is popped.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defclass dialog ()
|
||||
((title :initarg :title :accessor dialog-title)
|
||||
(size :initarg :size :initform :medium :accessor dialog-size)
|
||||
(content :initarg :content :initform nil :accessor dialog-content)
|
||||
(on-dismiss :initarg :on-dismiss :initform nil :accessor dialog-on-dismiss)))
|
||||
#+END_SRC
|
||||
|
||||
** dialog-size-pixels
|
||||
|
||||
Converts a size keyword (~:small~, ~:medium~, ~:large~) to pixel
|
||||
dimensions. Accepts optional ~max-w~ / ~max-h~ to clamp the result to
|
||||
terminal bounds, preventing off-screen overflow (fixed in v1.0.0).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun dialog-size-pixels (size &optional (max-w 80) (max-h 24))
|
||||
(multiple-value-bind (dw dh)
|
||||
(case size
|
||||
(:small (values 40 8))
|
||||
(:medium (values 60 16))
|
||||
(:large (values 88 24))
|
||||
(t (values 60 16)))
|
||||
(values (min dw max-w) (min dh max-h))))
|
||||
#+END_SRC
|
||||
|
||||
** render-dialog
|
||||
|
||||
Renders a dialog: draws a dimmed full-screen backdrop using
|
||||
~draw-rect~, then draws the bordered dialog panel centered on screen.
|
||||
Content is rendered via ~draw-text~ inside the panel area.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun render-dialog (dialog screen w h)
|
||||
(multiple-value-bind (dw dh) (dialog-size-pixels (dialog-size dialog) w h)
|
||||
(let ((x (floor (- w dw) 2))
|
||||
(y (floor (- h dh) 2)))
|
||||
;; Backdrop — dim the full screen
|
||||
(dotimes (row h)
|
||||
(draw-rect screen 0 row w 1 :bg :bright-black))
|
||||
;; Dialog panel
|
||||
(draw-border screen x y dw dh :style :single :title (dialog-title dialog))
|
||||
(when (dialog-content dialog)
|
||||
;; Content rendering delegated to component system
|
||||
(draw-text screen (1+ x) (1+ y)
|
||||
(format nil "~a" (dialog-content dialog))
|
||||
:white :default)))))
|
||||
#+END_SRC
|
||||
|
||||
** render-select-minibuffer
|
||||
|
||||
Renders a ~select~ widget as a bottom-anchored minibuffer panel at the
|
||||
given position. The panel fills a rectangular area, draws a separator
|
||||
line with the title at the top, the filtered options in the middle,
|
||||
and a filter input line (>= ~...~) at the bottom. ~colors~ is a plist
|
||||
with keys ~:bg-panel~, ~:separator~, ~:accent~, ~:text-muted~,
|
||||
~:agent-fg~, ~:input-fg~, ~:bg-input~, ~:input-prompt~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun render-select-minibuffer (be x y width height select title colors)
|
||||
(let* ((filtered (select-filtered-options select))
|
||||
(sel-idx (or (select-selected-index select) 0))
|
||||
(filter (select-filter select))
|
||||
(bg-p (getf colors :bg-panel))
|
||||
(sep-c (getf colors :separator)))
|
||||
(dotimes (r height)
|
||||
(draw-rect be x (+ y r) width 1 :bg bg-p))
|
||||
(draw-text be x y (make-string width :initial-element #\─) sep-c bg-p)
|
||||
(draw-text be (1+ x) y title (getf colors :accent) bg-p)
|
||||
(loop for item in filtered
|
||||
for i from 1
|
||||
for display-idx = (first item)
|
||||
for option = (third item)
|
||||
for opt-title = (getf option :title)
|
||||
for cat = (getf option :category)
|
||||
for sel-p = (eql display-idx sel-idx)
|
||||
for row = (+ y i)
|
||||
while (< row (+ y (min height (length filtered))))
|
||||
do (cond
|
||||
(sel-p
|
||||
(draw-rect be (1+ x) row (1- width) 1
|
||||
:bg (getf colors :input-fg))
|
||||
(draw-text be (1+ x) row
|
||||
(format nil " >> ~a" opt-title)
|
||||
(getf colors :bg-input)
|
||||
(getf colors :input-fg)))
|
||||
(cat
|
||||
(draw-text be (1+ x) row
|
||||
(format nil " ~a" opt-title)
|
||||
(getf colors :text-muted) bg-p))
|
||||
(t
|
||||
(draw-text be (1+ x) row
|
||||
(format nil " ~a" opt-title)
|
||||
(getf colors :agent-fg) bg-p))))
|
||||
(let ((filter-y (+ y (- height 3))))
|
||||
(draw-rect be x filter-y width 1 :bg bg-p)
|
||||
(draw-text be x filter-y
|
||||
(format nil "> ~a" (or filter ""))
|
||||
(getf colors :input-prompt) bg-p))))
|
||||
#+END_SRC
|
||||
|
||||
** push-dialog
|
||||
|
||||
Pushes a dialog onto =*dialog-stack*=. Returns the dialog for chaining.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun push-dialog (dialog)
|
||||
(push dialog *dialog-stack*)
|
||||
dialog)
|
||||
#+END_SRC
|
||||
|
||||
** pop-dialog
|
||||
|
||||
Pops the top dialog from the stack. If an ~:on-dismiss~ callback is
|
||||
set on the dialog, it is called before returning.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun pop-dialog ()
|
||||
(when *dialog-stack*
|
||||
(let ((dialog (pop *dialog-stack*)))
|
||||
(when (dialog-on-dismiss dialog)
|
||||
(funcall (dialog-on-dismiss dialog)))
|
||||
dialog)))
|
||||
#+END_SRC
|
||||
|
||||
* Dialog convenience constructors
|
||||
|
||||
These factory functions create common dialog variants by composing the
|
||||
~dialog~ class with interactive components (~select~, ~text-input~).
|
||||
|
||||
** alert-dialog
|
||||
|
||||
Simple alert with title, message, and an OK button. The button is a
|
||||
~select~ with a single "OK" option. Dismissing fires ~pop-dialog~ on
|
||||
both selection and backdrop dismiss.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun alert-dialog (title message)
|
||||
(make-instance 'dialog
|
||||
:title title
|
||||
:size :small
|
||||
:content (make-instance 'select
|
||||
:options (list (list :title "OK" :value :ok))
|
||||
:on-select (lambda (opt) (declare (ignore opt)) (pop-dialog)))
|
||||
:on-dismiss (lambda () (pop-dialog))))
|
||||
#+END_SRC
|
||||
|
||||
** confirm-dialog
|
||||
|
||||
Confirm dialog with Yes/No buttons. Returns ~:yes~ or ~:no~ via the
|
||||
~on-yes~/~on-no~ callbacks. The dialog auto-dismisses on selection.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun confirm-dialog (title message &key on-yes on-no)
|
||||
(make-instance 'dialog
|
||||
:title title
|
||||
:size :small
|
||||
:content (make-instance 'select
|
||||
:options (list (list :title "Yes" :value :yes)
|
||||
(list :title "No" :value :no))
|
||||
:on-select (lambda (opt)
|
||||
(pop-dialog)
|
||||
(if (eql opt :yes)
|
||||
(when on-yes (funcall on-yes))
|
||||
(when on-no (funcall on-no)))))))
|
||||
#+END_SRC
|
||||
|
||||
** select-dialog
|
||||
|
||||
Modal wrapper around the ~select~ component. Presents a list of options
|
||||
and calls ~on-select~ with the chosen value after dismissing.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-dialog (title options &key on-select)
|
||||
(make-instance 'dialog
|
||||
:title title
|
||||
:size :medium
|
||||
:content (make-instance 'select
|
||||
:options options
|
||||
:on-select (lambda (opt)
|
||||
(pop-dialog)
|
||||
(when on-select (funcall on-select opt))))))
|
||||
#+END_SRC
|
||||
|
||||
** prompt-dialog
|
||||
|
||||
Modal wrapper around ~text-input~. Shows a text input field inside the
|
||||
dialog and calls ~on-submit~ with the entered value after dismissing.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun prompt-dialog (title &key on-submit)
|
||||
(make-instance 'dialog
|
||||
:title title
|
||||
:size :small
|
||||
:content (make-instance 'text-input
|
||||
:on-submit (lambda (value)
|
||||
(pop-dialog)
|
||||
(when on-submit (funcall on-submit value))))))
|
||||
#+END_SRC
|
||||
|
||||
* Select widget (absorbed from cl-tty.select)
|
||||
|
||||
A selection list component — the building block for command palettes, theme
|
||||
pickers, and file pickers. Options are plists with ~:title~, ~:value~, and
|
||||
optional ~:category~ fields.
|
||||
|
||||
** Select class
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defclass select (dirty-mixin)
|
||||
((options :initform nil :initarg :options
|
||||
:accessor select-options :type list)
|
||||
(filter :initform nil :initarg :filter
|
||||
:accessor select-filter :type (or string null))
|
||||
(selected-index :initform 0 :initarg :selected-index
|
||||
:accessor select-selected-index :type fixnum)
|
||||
(on-select :initform nil :initarg :on-select
|
||||
:accessor select-on-select)
|
||||
(layout-node :initform (make-layout-node) :initarg :layout-node
|
||||
:accessor select-layout-node)))
|
||||
#+END_SRC
|
||||
|
||||
** make-select
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun make-select (&key options filter on-select)
|
||||
(make-instance 'select
|
||||
:options (or options nil)
|
||||
:filter filter
|
||||
:on-select on-select))
|
||||
#+END_SRC
|
||||
|
||||
** component-layout-node
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defmethod component-layout-node ((sel select))
|
||||
(select-layout-node sel))
|
||||
#+END_SRC
|
||||
|
||||
** select-filtered-options
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-filtered-options (sel)
|
||||
"Return list of options matching the current filter, in display order.
|
||||
Each item: (display-index original-index option-plist)."
|
||||
(let* ((filter (select-filter sel))
|
||||
(all-options (select-options sel))
|
||||
(filtered (if (null filter)
|
||||
all-options
|
||||
(let ((lower (string-downcase filter)))
|
||||
(remove-if-not
|
||||
(lambda (opt)
|
||||
(or (getf opt :category)
|
||||
(let ((title (string-downcase (getf opt :title))))
|
||||
(or (search lower title)
|
||||
(fuzzy-match-p lower title)))))
|
||||
all-options)))))
|
||||
(loop for opt in filtered
|
||||
for i from 0
|
||||
collect (list i (position opt all-options) opt))))
|
||||
#+END_SRC
|
||||
|
||||
** fuzzy-match-p
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun fuzzy-match-p (query target)
|
||||
"T if character-set Jaccard similarity exceeds threshold (0.3)."
|
||||
(let* ((q-chars (remove-duplicates (coerce (string-downcase query) 'list)))
|
||||
(t-chars (remove-duplicates (coerce (string-downcase target) 'list)))
|
||||
(intersection (length (intersection q-chars t-chars)))
|
||||
(union (length (union q-chars t-chars))))
|
||||
(if (zerop union) nil (> (/ (float intersection) union) 0.3))))
|
||||
#+END_SRC
|
||||
|
||||
** select-clamp-index
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-clamp-index (sel)
|
||||
"Ensure selected-index is valid. Wraps if empty."
|
||||
(let* ((filtered (select-filtered-options sel))
|
||||
(count (length filtered)))
|
||||
(if (zerop count)
|
||||
(setf (select-selected-index sel) 0)
|
||||
(setf (select-selected-index sel)
|
||||
(max 0 (min (select-selected-index sel) (1- count)))))))
|
||||
#+END_SRC
|
||||
|
||||
** select-next / select-prev
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-next (sel)
|
||||
"Move selection to next non-category option. Wraps at end."
|
||||
(let* ((filtered (select-filtered-options sel))
|
||||
(count (length filtered))
|
||||
(current (select-selected-index sel)))
|
||||
(when (plusp count)
|
||||
(loop for i from 1 below count
|
||||
for idx = (mod (+ current i) count)
|
||||
for opt = (third (nth idx filtered))
|
||||
when (not (getf opt :category))
|
||||
do (setf (select-selected-index sel) idx)
|
||||
(mark-dirty sel)
|
||||
(return)))))
|
||||
|
||||
(defun select-prev (sel)
|
||||
"Move selection to previous non-category option. Wraps at start."
|
||||
(let* ((filtered (select-filtered-options sel))
|
||||
(count (length filtered))
|
||||
(current (select-selected-index sel)))
|
||||
(when (plusp count)
|
||||
(loop for i from 1 below count
|
||||
for idx = (mod (- current i) count)
|
||||
for opt = (third (nth idx filtered))
|
||||
when (not (getf opt :category))
|
||||
do (setf (select-selected-index sel) idx)
|
||||
(mark-dirty sel)
|
||||
(return)))))
|
||||
#+END_SRC
|
||||
|
||||
** select-handle-key
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-handle-key (sel event)
|
||||
"Handle a key-event. Returns T if handled."
|
||||
(let ((key (key-event-key event))
|
||||
(ctrl (key-event-ctrl event)))
|
||||
(cond
|
||||
((or (eql key :down) (and ctrl (eql key :n)))
|
||||
(select-next sel) t)
|
||||
((or (eql key :up) (and ctrl (eql key :p)))
|
||||
(select-prev sel) t)
|
||||
((eql key :enter)
|
||||
(let* ((filtered (select-filtered-options sel))
|
||||
(idx (select-selected-index sel))
|
||||
(item (when (< idx (length filtered))
|
||||
(third (nth idx filtered)))))
|
||||
(when item
|
||||
(let ((cb (select-on-select sel)))
|
||||
(when cb (funcall cb item))))
|
||||
t))
|
||||
((eql key :escape) nil)
|
||||
(t nil))))
|
||||
#+END_SRC
|
||||
|
||||
** select-visible-options
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun select-visible-options (sel)
|
||||
"Return filtered options that fit within the viewport."
|
||||
(let* ((ln (select-layout-node sel))
|
||||
(height (if ln (layout-node-height ln) 80))
|
||||
(filtered (select-filtered-options sel))
|
||||
(sel-idx (select-selected-index sel))
|
||||
(half (floor (1- height) 2))
|
||||
(start (max 0 (- sel-idx half)))
|
||||
(end (min (length filtered) (+ start height))))
|
||||
(subseq filtered start end)))
|
||||
#+END_SRC
|
||||
|
||||
** Render method for select
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defmethod render ((sel select) backend)
|
||||
(let* ((ln (select-layout-node sel))
|
||||
(x (if ln (layout-node-x ln) 0))
|
||||
(y (if ln (layout-node-y ln) 0))
|
||||
(w (if ln (layout-node-width ln) 80))
|
||||
(visible (select-visible-options sel))
|
||||
(sel-idx (select-selected-index sel)))
|
||||
(dolist (item visible)
|
||||
(let* ((display-idx (first item))
|
||||
(option (third item))
|
||||
(title (getf option :title))
|
||||
(is-category (getf option :category))
|
||||
(is-selected (eql display-idx sel-idx))
|
||||
(display (if (> (length title) (1- w))
|
||||
(concatenate 'string (subseq title 0 (1- w)) "…")
|
||||
title)))
|
||||
(cond
|
||||
(is-category
|
||||
(draw-text backend x y display :text-muted nil))
|
||||
(is-selected
|
||||
(draw-rect backend x y w 1 :bg :accent)
|
||||
(draw-text backend x y display :background :accent))
|
||||
(t
|
||||
(draw-text backend x y display nil nil)))
|
||||
(incf y 1)))
|
||||
(values)))
|
||||
#+END_SRC
|
||||
|
||||
* Toast system
|
||||
|
||||
Transient notifications that appear in the top-right corner. Each toast
|
||||
has a message and a variant that determines its color (~:info~,
|
||||
~:success~, ~:warning~, ~:error~).
|
||||
|
||||
** toast class
|
||||
|
||||
Lightweight class storing the message text and variant keyword.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defclass toast ()
|
||||
((message :initarg :message :accessor toast-message)
|
||||
(variant :initarg :variant :initform :info :accessor toast-variant)))
|
||||
#+END_SRC
|
||||
|
||||
** render-toast
|
||||
|
||||
Draws a toast in the top-right corner of the screen. The message is
|
||||
truncated to 60 columns with an ellipsis if necessary. The background
|
||||
color reflects the variant.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun render-toast (toast screen w)
|
||||
(let* ((msg (toast-message toast))
|
||||
(variant (toast-variant toast))
|
||||
(color (case variant
|
||||
(:info :blue) (:success :green)
|
||||
(:warning :yellow) (:error :red)))
|
||||
(max-w (min 60 (1- w)))
|
||||
(x (- w max-w 1))
|
||||
(text (if (> (length msg) (- max-w 2))
|
||||
(concatenate 'string (subseq msg 0 (- max-w 5)) "...")
|
||||
msg)))
|
||||
(draw-rect screen x 0 max-w 1 :bg color)
|
||||
(draw-text screen (1+ x) 0 text :white color :bold t)))
|
||||
#+END_SRC
|
||||
|
||||
** toast (function)
|
||||
|
||||
Fire-and-forget toast notification. Creates a ~toast~ instance, pushes
|
||||
it onto =*toasts*~, and optionally schedules auto-dismissal via
|
||||
~dismiss-toast~ when ~duration~ is positive.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun toast (message &key (variant :info) (duration 0))
|
||||
(let ((toast (make-instance 'toast :message message :variant variant)))
|
||||
(push toast *toasts*)
|
||||
(when (plusp duration) (dismiss-toast toast))
|
||||
toast))
|
||||
#+END_SRC
|
||||
|
||||
** dismiss-toast
|
||||
|
||||
Removes a toast from =*toasts*~ by identity (~remove~ with default
|
||||
~:test #'eql~ compares by pointer for CLOS objects).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dialog.lisp
|
||||
(defun dismiss-toast (toast)
|
||||
(setf *toasts* (remove toast *toasts*)))
|
||||
#+END_SRC
|
||||
|
||||
* Tests
|
||||
|
||||
Test suite using FiveAM. Each test exercises one function or
|
||||
interaction.
|
||||
|
||||
** Test package and suite
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
;;; dialog-tests.lisp — Tests for cl-tty.dialog
|
||||
|
||||
(defpackage :cl-tty-dialog-test
|
||||
(:use :cl :cl-tty.dialog :fiveam :cl-tty.backend :cl-tty.layout :cl-tty.input)
|
||||
(:export #:run-tests))
|
||||
|
||||
(in-package :cl-tty-dialog-test)
|
||||
|
||||
(def-suite dialog-suite :description "Dialog + Toast + Select tests")
|
||||
(in-suite dialog-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'dialog-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
#+END_SRC
|
||||
|
||||
** dialog-create
|
||||
|
||||
Basic dialog instantiation — verifies ~make-instance~ and accessors.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test dialog-create ()
|
||||
(let ((d (make-instance 'dialog :title "Test")))
|
||||
(is-true (typep d 'dialog))
|
||||
(is (equal "Test" (dialog-title d)))))
|
||||
#+END_SRC
|
||||
|
||||
** dialog-size-small
|
||||
|
||||
~dialog-size-pixels~ returns the correct dimensions for ~:small~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test dialog-size-small ()
|
||||
(multiple-value-bind (w h) (dialog-size-pixels :small)
|
||||
(is (= 40 w))
|
||||
(is (= 8 h))))
|
||||
#+END_SRC
|
||||
|
||||
** dialog-size-medium
|
||||
|
||||
~dialog-size-pixels~ returns the correct dimensions for ~:medium~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test dialog-size-medium ()
|
||||
(multiple-value-bind (w h) (dialog-size-pixels :medium)
|
||||
(is (= 60 w))
|
||||
(is (= 16 h))))
|
||||
#+END_SRC
|
||||
|
||||
** dialog-push-pop
|
||||
|
||||
Verifies stack operations: push adds to =*dialog-stack*~, pop removes
|
||||
the top element.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test dialog-push-pop ()
|
||||
(let ((*dialog-stack* nil))
|
||||
(push-dialog (make-instance 'dialog :title "D1"))
|
||||
(is (= 1 (length *dialog-stack*)))
|
||||
(push-dialog (make-instance 'dialog :title "D2"))
|
||||
(is (= 2 (length *dialog-stack*)))
|
||||
(pop-dialog)
|
||||
(is (= 1 (length *dialog-stack*)))))
|
||||
#+END_SRC
|
||||
|
||||
** toast-create
|
||||
|
||||
Verifies that ~toast~ pushes onto =*toasts*~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test toast-create ()
|
||||
(let ((*toasts* nil))
|
||||
(toast "Hello" :variant :info :duration 0)
|
||||
(is (= 1 (length *toasts*)))))
|
||||
#+END_SRC
|
||||
|
||||
** toast-dismiss
|
||||
|
||||
Verifies that ~dismiss-toast~ removes the toast from =*toasts*~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(def-test toast-dismiss ()
|
||||
(let ((*toasts* (list (make-instance 'toast :message "T" :variant :info))))
|
||||
(dismiss-toast (first *toasts*))
|
||||
(is (= 0 (length *toasts*)))))
|
||||
#+END_SRC
|
||||
|
||||
** Select tests (merged from cl-tty.select)
|
||||
|
||||
*** select-creates
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-creates
|
||||
"A Select can be created with defaults."
|
||||
(let ((sel (make-select)))
|
||||
(is (typep sel 'select))
|
||||
(is-false (select-options sel))
|
||||
(is-false (select-filter sel))
|
||||
(is (= (select-selected-index sel) 0))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-with-options
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-with-options
|
||||
"A Select stores options."
|
||||
(let ((sel (make-select :options '((:title "Red" :value :red)
|
||||
(:title "Blue" :value :blue)))))
|
||||
(is (= (length (select-options sel)) 2))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-filtered-exact
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-filtered-exact
|
||||
"Filter returns case-insensitive substring matches."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "Red" :value :red)
|
||||
(:title "Green" :value :green)
|
||||
(:title "Blue" :value :blue)))))
|
||||
(setf (select-filter sel) "bl")
|
||||
(let ((filtered (select-filtered-options sel)))
|
||||
(is (= (length filtered) 1))
|
||||
(is (eql (getf (third (first filtered)) :value) :blue)))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-filtered-all
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-filtered-all
|
||||
"Nil filter returns all options."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "Red" :value :red)
|
||||
(:title "Blue" :value :blue)))))
|
||||
(let ((filtered (select-filtered-options sel)))
|
||||
(is (= (length filtered) 2)))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-navigation
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-navigation
|
||||
"Select-next and select-prev navigate through options."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "A" :value :a)
|
||||
(:title "B" :value :b)
|
||||
(:title "C" :value :c)))))
|
||||
(is (= (select-selected-index sel) 0))
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 1))
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 2))
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 0) "wraps forward")
|
||||
(select-prev sel)
|
||||
(is (= (select-selected-index sel) 2) "wraps backward")))
|
||||
#+END_SRC
|
||||
|
||||
*** select-navigation-skips-categories
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-navigation-skips-categories
|
||||
"Navigation skips category header options."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "Colors" :category t)
|
||||
(:title "Red" :value :red)
|
||||
(:title "Green" :value :green)
|
||||
(:title "Shapes" :category t)
|
||||
(:title "Circle" :value :circle)))))
|
||||
(is (= (select-selected-index sel) 0))
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 1) "skipped category header at 0")
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 2))
|
||||
(select-next sel)
|
||||
(is (= (select-selected-index sel) 4) "skipped category header at 3")))
|
||||
#+END_SRC
|
||||
|
||||
*** select-handle-key
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-handle-key
|
||||
"Select handle-key dispatches navigation and selection."
|
||||
(let* ((result (list nil))
|
||||
(sel (make-select
|
||||
:options '((:title "A" :value :a) (:title "B" :value :b))
|
||||
:on-select (lambda (opt) (setf (car result) (getf opt :value))))))
|
||||
(select-handle-key sel (make-key-event :key :down))
|
||||
(is (= (select-selected-index sel) 1))
|
||||
(select-handle-key sel (make-key-event :key :up))
|
||||
(is (= (select-selected-index sel) 0))
|
||||
(select-handle-key sel (make-key-event :key :enter))
|
||||
(is (eql (car result) :a))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-handle-key-ctrl
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-handle-key-ctrl
|
||||
"Ctrl+N and Ctrl+P navigate like down/up."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "A" :value :a) (:title "B" :value :b) (:title "C" :value :c)))))
|
||||
(select-handle-key sel (make-key-event :key :n :ctrl t))
|
||||
(is (= (select-selected-index sel) 1))
|
||||
(select-handle-key sel (make-key-event :key :p :ctrl t))
|
||||
(is (= (select-selected-index sel) 0))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-visible-count
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-visible-count
|
||||
"Visible options respects viewport height."
|
||||
(let* ((ln (make-layout-node))
|
||||
(sel (make-select
|
||||
:options (loop for i below 20 collect (list :title (format nil "Item ~D" i) :value i)))))
|
||||
(setf (select-layout-node sel) ln)
|
||||
(setf (layout-node-height ln) 5)
|
||||
(let ((visible (select-visible-options sel)))
|
||||
(is (<= (length visible) 5)))))
|
||||
#+END_SRC
|
||||
|
||||
*** select-fuzzy-fallback
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/dialog-tests.lisp
|
||||
(test select-fuzzy-fallback
|
||||
"Fuzzy filter catches near-misses."
|
||||
(let ((sel (make-select
|
||||
:options '((:title "Nord" :value :nord)
|
||||
(:title "Tokyo Night" :value :tokyo)
|
||||
(:title "Catppuccin" :value :cat)))))
|
||||
(setf (select-filter sel) "nrd")
|
||||
(let ((filtered (select-filtered-options sel)))
|
||||
(is (= (length filtered) 1))
|
||||
(is (eql (getf (third (first filtered)) :value) :nord)))))
|
||||
#+END_SRC
|
||||
143
org/dirty.org
Normal file
143
org/dirty.org
Normal file
@@ -0,0 +1,143 @@
|
||||
#+TITLE: Dirty Tracking
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:components:
|
||||
|
||||
* Overview
|
||||
|
||||
The dirty tracking module provides a mixin class and protocol for
|
||||
marking components as needing re-render. This is the foundation of
|
||||
the incremental rendering pipeline.
|
||||
|
||||
Without dirty tracking, every frame would re-render every component.
|
||||
With it, only components that changed (and their ancestors, for layout
|
||||
recomputation) get re-processed. The makes the difference between a
|
||||
60fps terminal UI and a flickering mess.
|
||||
|
||||
This module is intentionally minimal: a single mixin class and two
|
||||
generic functions. The complexity lives in the propagation logic
|
||||
(see ~render.lisp~), but the dirty state itself is trivial.
|
||||
|
||||
* Contract
|
||||
|
||||
** ~dirty-mixin~
|
||||
|
||||
A class that adds a ~dirty~ slot. Components that need dirty tracking
|
||||
inherit from this.
|
||||
|
||||
- ~(dirty-p component)~ — returns ~t~ if the component needs re-render,
|
||||
~nil~ if it's up-to-date. New instances start dirty (~t~).
|
||||
|
||||
** ~mark-clean~
|
||||
|
||||
- ~(mark-clean component)~ — sets dirty to ~nil~. Called after rendering.
|
||||
- Specialized on ~dirty-mixin~; default method is a no-op.
|
||||
|
||||
** ~mark-dirty~
|
||||
|
||||
- ~(mark-dirty component)~ — sets dirty to ~t~. Called when the component's
|
||||
state changes (user typed a character, selection changed, etc.).
|
||||
- Specialized on ~dirty-mixin~; default method is a no-op.
|
||||
|
||||
* Tests
|
||||
|
||||
** ~dirty-mixin-default-is-dirty~
|
||||
|
||||
This test verifies that a freshly created ~dirty-mixin~ instance starts
|
||||
with ~dirty~ set to ~t~. This is the core invariant of the dirty tracking
|
||||
system — without this, the first render pass would skip new components,
|
||||
making them invisible until something explicitly marked them dirty.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty-tests.lisp
|
||||
(in-package :cl-tty-box-test)
|
||||
(in-suite box-suite)
|
||||
|
||||
(test dirty-mixin-default-is-dirty
|
||||
"A dirty-mixin starts as dirty"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(is-true (dirty-p c) "new component should be dirty")))
|
||||
#+END_SRC
|
||||
|
||||
** ~mark-clean-clears-dirty~
|
||||
|
||||
This test checks that calling ~mark-clean~ on a dirty component sets its
|
||||
~dirty-p~ to ~nil~. This is called after a component is rendered,
|
||||
signaling that it is up-to-date and does not need re-render until the
|
||||
next change. Without this, every component would be re-rendered every
|
||||
frame.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty-tests.lisp
|
||||
(in-package :cl-tty-box-test)
|
||||
(in-suite box-suite)
|
||||
|
||||
(test mark-clean-clears-dirty
|
||||
"mark-clean sets dirty to nil"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(mark-clean c)
|
||||
(is-false (dirty-p c) "after mark-clean, should not be dirty")))
|
||||
#+END_SRC
|
||||
|
||||
** ~mark-dirty-sets-dirty~
|
||||
|
||||
This test verifies that a component that has been cleaned can be
|
||||
re-marked as dirty via ~mark-dirty~. This exercises the full lifecycle:
|
||||
new (dirty) → render (mark-clean) → state change (mark-dirty) → render
|
||||
again. It ensures the dirty flag is not a one-shot toggle.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty-tests.lisp
|
||||
(in-package :cl-tty-box-test)
|
||||
(in-suite box-suite)
|
||||
|
||||
(test mark-dirty-sets-dirty
|
||||
"mark-dirty sets dirty to t"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(mark-clean c)
|
||||
(mark-dirty c)
|
||||
(is-true (dirty-p c) "after mark-dirty, should be dirty again")))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
The entire module is a class and two generic functions. The design
|
||||
choice: make this a separate mixin rather than part of the base
|
||||
~component~ class. This lets non-UI objects (layout nodes, render
|
||||
commands) opt into dirty tracking without inheriting from component.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty.lisp
|
||||
(in-package :cl-tty.box)
|
||||
|
||||
;; ── Dirty Tracking ─────────────────────────────────────────────
|
||||
|
||||
(defclass dirty-mixin ()
|
||||
((dirty :initform t :accessor dirty-p)))
|
||||
#+END_SRC
|
||||
|
||||
The ~initform t~ is critical: new components are dirty by default so
|
||||
the first render pass doesn't skip them. If this default were ~nil~,
|
||||
new components would be invisible until something explicitly marked
|
||||
them dirty.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty.lisp
|
||||
(defgeneric mark-clean (component)
|
||||
(:method ((c dirty-mixin))
|
||||
(setf (dirty-p c) nil)))
|
||||
#+END_SRC
|
||||
|
||||
~mark-clean~ is called at the end of a render cycle. The default
|
||||
method (for non-dirty-mixin components) is a no-op — they have no
|
||||
dirty state to clear.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/dirty.lisp
|
||||
(defgeneric mark-dirty (component)
|
||||
(:method ((c dirty-mixin))
|
||||
(setf (dirty-p c) t)))
|
||||
#+END_SRC
|
||||
|
||||
~mark-dirty~ is called whenever the component's visual state changes.
|
||||
Together with ~propagate-dirty~ in the render pipeline, this ensures
|
||||
that when a text input gains a character, not just the input component
|
||||
but its containing box, tab, and screen all get re-rendered.
|
||||
|
||||
These are generic functions (not plain functions) so other mixins or
|
||||
base classes can provide their own methods. The ~:method~ on
|
||||
~dirty-mixin~ provides the default implementation for anything that
|
||||
includes this mixin.
|
||||
853
org/framebuffer.org
Normal file
853
org/framebuffer.org
Normal file
@@ -0,0 +1,853 @@
|
||||
#+TITLE: Rendering Pipeline — Framebuffer (v0.13.0)
|
||||
#+DATE: 2026-05-11
|
||||
#+AUTHOR: Amr Gharbeia / Hermes
|
||||
#+STARTUP: content
|
||||
|
||||
* Overview
|
||||
|
||||
A framebuffer-based rendering pipeline that sits between the component tree
|
||||
and the backend protocol. Eliminates flicker by computing a full frame then
|
||||
diffing against the previous frame before flushing.
|
||||
|
||||
The ~framebuffer-backend~ class implements the backend protocol by writing to a
|
||||
2D cell array instead of emitting escape sequences. After all components render,
|
||||
the diff engine compares current and previous frames and flushes only changed
|
||||
cells to a real backend.
|
||||
|
||||
Benefits:
|
||||
- Flicker-free output (only changed cells are sent)
|
||||
- Enables text selection (each cell knows its content)
|
||||
- Enables click-to-open-link (each cell knows its URL)
|
||||
- Scissor clipping for nested containers
|
||||
|
||||
** Contract**
|
||||
|
||||
- ~cell~ — immutable struct with char, fg, bg, bold, italic, underline, link-url
|
||||
- ~make-framebuffer width height~ → 2D array of ~cell~
|
||||
- ~framebuffer-backend~ — subclass of ~backend~ that renders to cell array
|
||||
- ~make-framebuffer-backend &key width height~ → framebuffer-backend
|
||||
- ~diff-framebuffers prev curr~ → list of (x y cell) for changed cells
|
||||
- ~flush-framebuffer prev-fb curr-fb backend~ → writes changes, returns count
|
||||
- ~with-scissor (fb x y w h) &body body~ — clip drawing to rectangle
|
||||
|
||||
** Plan
|
||||
|
||||
See =docs/plans/2026-05-11-rendering-pipeline.md= for full implementation plan.
|
||||
|
||||
1. Create org file with code blocks
|
||||
2. Tangle → framebuffer.lisp
|
||||
3. Add to ASDF
|
||||
4. Write tests
|
||||
5. Run, commit
|
||||
|
||||
* Tests (reference documentation, not tangled)
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
;; Tests for framebuffer pipeline — manually added to tests/framebuffer-tests.lisp
|
||||
#+END_SRC
|
||||
|
||||
** Test package and suite setup
|
||||
|
||||
Setting up the test package with FiveAM, importing the rendering and backend
|
||||
packages for use in all subsequent tests.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(defpackage :cl-tty-framebuffer-test
|
||||
(:use :cl :fiveam :cl-tty.rendering :cl-tty.backend))
|
||||
(in-package :cl-tty-framebuffer-test)
|
||||
|
||||
(def-suite framebuffer-suite :description "Framebuffer rendering pipeline tests")
|
||||
(in-suite framebuffer-suite)
|
||||
#+END_SRC
|
||||
|
||||
** Test: make-framebuffer creates correct size
|
||||
|
||||
Verify that the framebuffer constructor produces an array with the expected
|
||||
dimensions. Height should match the first dimension (rows), width the second
|
||||
dimension (columns).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test make-framebuffer-creates-correct-size
|
||||
(let ((fb (make-framebuffer 80 24)))
|
||||
(is (= 24 (framebuffer-height fb)))
|
||||
(is (= 80 (framebuffer-width fb)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: cell defaults are space
|
||||
|
||||
Cells created via MAKE-CELL with no arguments should default to a space
|
||||
character with nil foreground and background — a blank, unstyled cell.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test cell-defaults-are-space
|
||||
(let ((cell (aref (make-framebuffer 10 10) 0 0)))
|
||||
(is (eql #\space (cell-char cell)))
|
||||
(is (null (cell-fg cell)))
|
||||
(is (null (cell-bg cell)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: draw-text on framebuffer sets cells
|
||||
|
||||
Drawing a string into the framebuffer backend should set the character and
|
||||
foreground color at each cell position. Characters should appear at the expected
|
||||
(x, y) offsets.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test draw-text-on-fb-sets-cells
|
||||
(let ((fb (make-framebuffer-backend)))
|
||||
(draw-text fb 2 3 "abc" :red nil)
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\a (cell-char (aref cells 3 2))))
|
||||
(is (eql #\b (cell-char (aref cells 3 3))))
|
||||
(is (eql #\c (cell-char (aref cells 3 4))))
|
||||
(is (eql :red (cell-fg (aref cells 3 2)))))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: draw-text clips at bounds
|
||||
|
||||
When drawing text that extends past the right edge of the framebuffer, cells
|
||||
beyond the width should remain unchanged (space characters). This prevents
|
||||
buffer overflow and undefined memory access.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test draw-text-clips-at-bounds
|
||||
(let ((fb (make-framebuffer-backend :width 10 :height 5)))
|
||||
(draw-text fb 8 2 "hello" nil nil)
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\h (cell-char (aref cells 2 8))))
|
||||
(is (eql #\e (cell-char (aref cells 2 9))))
|
||||
(is (eql #\space (cell-char (aref cells 2 0))) "out of bounds text is ignored"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: diff of identical framebuffers returns empty
|
||||
|
||||
Two framebuffers with identical cells should produce no changes. The diff
|
||||
engine must short-circuit when no cells differ.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test diff-identical-fbs-returns-empty
|
||||
(let ((fb1 (make-framebuffer 80 24))
|
||||
(fb2 (make-framebuffer 80 24)))
|
||||
(is (null (diff-framebuffers fb1 fb2)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: diff of changed framebuffer returns changes
|
||||
|
||||
After modifying a single cell in one framebuffer, the diff engine should return
|
||||
exactly one change with the correct coordinates and cell data.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test diff-changed-fb-returns-changes
|
||||
(let* ((fb1 (make-framebuffer 10 10))
|
||||
(fb2 (make-framebuffer 10 10)))
|
||||
(setf (aref fb2 5 5) (make-cell :char #\X :fg :red))
|
||||
(let ((changes (diff-framebuffers fb1 fb2)))
|
||||
(is (= 1 (length changes)))
|
||||
(destructuring-bind (x y cell) (first changes)
|
||||
(is (= 5 x))
|
||||
(is (= 5 y))
|
||||
(is (eql #\X (cell-char cell)))))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: with-scissor clips drawing
|
||||
|
||||
When a scissor rectangle is active, drawing operations outside the rectangle
|
||||
should be clipped away. Operations inside the rectangle should proceed normally.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test with-scissor-clips-drawing
|
||||
(let ((fb (make-framebuffer-backend :width 20 :height 10)))
|
||||
(with-scissor (fb 5 5 3 3)
|
||||
(draw-text fb 6 6 "ABC" nil nil)
|
||||
(draw-text fb 1 1 "OUTSIDE" nil nil))
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\A (cell-char (aref cells 6 6))) "inside scissor draws")
|
||||
(is (eql #\space (cell-char (aref cells 1 1))) "outside scissor is clipped"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: flush-fb copies to backend
|
||||
|
||||
After drawing on a framebuffer backend and flushing to a real backend, at least
|
||||
one cell change should be detected and forwarded to the output backend.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle no
|
||||
(test flush-fb-copies-to-backend
|
||||
(let* ((real-be (make-simple-backend :output-stream (make-string-output-stream)))
|
||||
(fb (make-framebuffer-backend)))
|
||||
(draw-text fb 0 0 "X" :red nil)
|
||||
(let ((changed (flush-framebuffer (make-framebuffer 80 24) (fb-framebuffer fb) real-be)))
|
||||
(is (>= changed 1)))))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
** Package definition
|
||||
|
||||
The ~cl-tty.rendering~ package exports all public symbols: the ~cell~ struct,
|
||||
framebuffer backend class, constructor, diff/flush utilities, scissor macro,
|
||||
and frame-inspection functions. It depends on ~:cl-tty.backend~ for the
|
||||
~backend~ base class and protocol methods.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defpackage :cl-tty.rendering
|
||||
(:use :cl :cl-tty.backend)
|
||||
(:export
|
||||
#:cell #:make-cell #:cell-char #:cell-fg #:cell-bg
|
||||
#:cell-bold #:cell-italic #:cell-underline #:cell-link-url
|
||||
#:framebuffer-backend #:make-framebuffer-backend
|
||||
#:make-framebuffer #:fb-framebuffer
|
||||
#:framebuffer-width #:framebuffer-height
|
||||
#:diff-framebuffers #:flush-framebuffer
|
||||
#:with-scissor
|
||||
#:extract-text #:fb-cell-link-url))
|
||||
#+END_SRC
|
||||
|
||||
** Package switch
|
||||
|
||||
Switch to the ~cl-tty.rendering~ package for all subsequent definitions.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(in-package :cl-tty.rendering)
|
||||
#+END_SRC
|
||||
|
||||
** Cell — immutable per-cell state
|
||||
|
||||
The ~cell~ struct represents a single terminal cell. By making it a struct
|
||||
(rather than a class) we get value semantics: copying is cheap and cells are
|
||||
compared by value during diffing. All fields have sensible defaults so that
|
||||
~make-cell~ with no arguments produces a blank space cell. The ~link-url~
|
||||
slot enables OSC-8 hyperlink support for clickable text.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defstruct cell
|
||||
"A single terminal cell — character, colors, and attributes."
|
||||
(char #\space :type character)
|
||||
(fg nil)
|
||||
(bg nil)
|
||||
(bold nil :type boolean)
|
||||
(italic nil :type boolean)
|
||||
(underline nil :type boolean)
|
||||
(link-url nil))
|
||||
#+END_SRC
|
||||
|
||||
** Framebuffer — 2D array of cells
|
||||
|
||||
*** make-framebuffer
|
||||
|
||||
Create a two-dimensional array of ~cell~ structs with HEIGHT rows and WIDTH
|
||||
columns. Using ~:initial-element (make-cell)~ ensures every cell is a fresh
|
||||
struct instance (not shared). The ~:element-type~ declaration is a hint for
|
||||
potential optimizations.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun make-framebuffer (width height)
|
||||
"Create a 2D array of CELL with dimensions HEIGHT x WIDTH."
|
||||
(make-array (list height width)
|
||||
:initial-element (make-cell)
|
||||
:element-type 'cell))
|
||||
#+END_SRC
|
||||
|
||||
*** framebuffer-width, framebuffer-height
|
||||
|
||||
Accessors that return the dimensions of a framebuffer array. These guard
|
||||
against non-array values (returning 0) so that callers don't crash on nil or
|
||||
uninitialized framebuffer slots.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun framebuffer-width (fb)
|
||||
"Return the width (columns) of framebuffer FB."
|
||||
(if (arrayp fb) (array-dimension fb 1) 0))
|
||||
#+END_SRC
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun framebuffer-height (fb)
|
||||
"Return the height (rows) of framebuffer FB."
|
||||
(if (arrayp fb) (array-dimension fb 0) 0))
|
||||
#+END_SRC
|
||||
|
||||
** Framebuffer Backend — implements backend protocol
|
||||
|
||||
*** framebuffer-backend class
|
||||
|
||||
The ~framebuffer-backend~ class subclasses ~backend~ and stores a 2D cell array
|
||||
plus scissor-clipping state. All drawing methods on this backend write to the
|
||||
cell array instead of emitting escape sequences. The scissor coordinates are
|
||||
used by ~%in-scissor-p~ to clip drawing during component rendering.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defclass framebuffer-backend (backend)
|
||||
((framebuffer :initform nil :accessor fb-framebuffer)
|
||||
(scissor-x :initform 0 :accessor fb-scissor-x)
|
||||
(scissor-y :initform 0 :accessor fb-scissor-y)
|
||||
(scissor-w :initform nil :accessor fb-scissor-w)
|
||||
(scissor-h :initform nil :accessor fb-scissor-h)))
|
||||
#+END_SRC
|
||||
|
||||
*** make-framebuffer-backend
|
||||
|
||||
Constructor that creates a ~framebuffer-backend~ instance and initializes its
|
||||
framebuffer array to the given dimensions (defaulting to 80x24, a common
|
||||
terminal size).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun make-framebuffer-backend (&key (width 80) (height 24))
|
||||
"Create a framebuffer-backend with a fresh framebuffer."
|
||||
(let ((fb (make-instance 'framebuffer-backend)))
|
||||
(setf (fb-framebuffer fb) (make-framebuffer width height))
|
||||
fb))
|
||||
#+END_SRC
|
||||
|
||||
** Drawing helpers
|
||||
|
||||
*** %in-scissor-p
|
||||
|
||||
Predicate that checks whether a cell at (CX, CY) falls within the active
|
||||
scissor rectangle. If either scissor dimension is nil (meaning no scissor is
|
||||
set), the corresponding axis check is skipped, effectively treating the entire
|
||||
framebuffer as the drawable area.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun %in-scissor-p (fb cx cy)
|
||||
"Check if (CX, CY) falls within the current scissor rectangle."
|
||||
(let ((sx (fb-scissor-x fb)) (sy (fb-scissor-y fb))
|
||||
(sw (fb-scissor-w fb)) (sh (fb-scissor-h fb)))
|
||||
(and (or (null sw) (and (>= cx sx) (< cx (+ sx sw))))
|
||||
(or (null sh) (and (>= cy sy) (< cy (+ sy sh)))))))
|
||||
#+END_SRC
|
||||
|
||||
*** %set-cell
|
||||
|
||||
Low-level cell-writer that performs bounds checking and scissor clipping before
|
||||
assigning a new cell. This is the single choke-point where all drawing
|
||||
ultimately lands, ensuring consistent clipping behavior across all drawing
|
||||
operations. Only cells within both the framebuffer dimensions and the active
|
||||
scissor rectangle are written.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun %set-cell (fb x y char &key fg bg bold italic underline link-url)
|
||||
"Set cell (X, Y) if within bounds and scissor."
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(when (and (>= y 0) (< y (framebuffer-height cells))
|
||||
(>= x 0) (< x (framebuffer-width cells))
|
||||
(%in-scissor-p fb x y))
|
||||
(setf (aref cells y x)
|
||||
(make-cell :char char :fg fg :bg bg
|
||||
:bold bold :italic italic :underline underline
|
||||
:link-url link-url)))))
|
||||
#+END_SRC
|
||||
|
||||
** Drawing methods
|
||||
|
||||
*** draw-text
|
||||
|
||||
Render a string of characters starting at position (X, Y), one cell per
|
||||
character. Each cell is set via ~%set-cell~ so bounds checking and scissor
|
||||
clipping apply automatically. The ~&allow-other-keys~ permits passing
|
||||
style-related keyword arguments that other backends may use but the framebuffer
|
||||
does not need (e.g., reverse, dim, blink).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-text ((fb framebuffer-backend) x y string fg bg
|
||||
&key bold italic underline reverse dim blink
|
||||
(link-url nil link-url-p)
|
||||
&allow-other-keys)
|
||||
(declare (ignore reverse dim blink link-url-p))
|
||||
(loop for i from 0 below (length string)
|
||||
do (%set-cell fb (+ x i) y (char string i)
|
||||
:fg fg :bg bg
|
||||
:bold bold :italic italic :underline underline
|
||||
:link-url link-url)))
|
||||
#+END_SRC
|
||||
|
||||
*** draw-text (raw array)
|
||||
|
||||
Direct rendering onto a raw 2D framebuffer array (the type returned by
|
||||
~make-framebuffer~). This lets application code call ~draw-text~ directly on a
|
||||
framebuffer without wrapping it in a ~framebuffer-backend~.
|
||||
|
||||
#+begin_src lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-text ((fb array) x y string fg bg
|
||||
&key bold italic underline reverse dim blink
|
||||
&allow-other-keys)
|
||||
(declare (ignore reverse dim blink))
|
||||
(let ((h (array-dimension fb 0))
|
||||
(w (array-dimension fb 1)))
|
||||
(loop for i from 0 below (length string)
|
||||
for cx from x
|
||||
while (< cx w)
|
||||
when (and (< y h) (>= cx 0) (>= y 0))
|
||||
do (setf (aref fb y cx)
|
||||
(make-cell :char (char string i)
|
||||
:fg fg :bg bg
|
||||
:bold bold :italic italic :underline underline)))))
|
||||
#+end_src
|
||||
|
||||
*** backend-clear (raw array)
|
||||
|
||||
Allow clearing a raw 2D framebuffer array directly (same type as returned by
|
||||
~make-framebuffer~). Resets all cells to blank defaults.
|
||||
|
||||
#+begin_src lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod backend-clear ((fb array))
|
||||
(dotimes (y (array-dimension fb 0))
|
||||
(dotimes (x (array-dimension fb 1))
|
||||
(setf (aref fb y x) (make-cell)))))
|
||||
#+end_src
|
||||
|
||||
*** draw-rect
|
||||
|
||||
Fill a rectangular region with space characters and an optional background
|
||||
color. This is used for clearing areas and rendering background fills for
|
||||
panels and widgets. Iterates row by row, column by column, using ~%set-cell~ so
|
||||
scissor clipping is respected.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-rect ((fb framebuffer-backend) x y w h &key bg)
|
||||
(dotimes (row h)
|
||||
(dotimes (col w)
|
||||
(%set-cell fb (+ x col) (+ y row) #\space :fg nil :bg bg))))
|
||||
#+END_SRC
|
||||
|
||||
*** draw-border
|
||||
|
||||
Draws a border around a rectangular region, optionally rendering a title
|
||||
string at the top edge. Supports three border styles: :single, :double, and
|
||||
:rounded, each using different corner and line characters. The title is drawn
|
||||
starting two cells from the left edge, overwriting top-edge characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-border ((fb framebuffer-backend) x y w h &key (style :single) title title-align fg bg)
|
||||
(let* ((chars (case style
|
||||
(:single '(#\+ #\- #\|))
|
||||
(:double '(#\+ #\= #\|))
|
||||
(:rounded '(#\. #\- #\|))
|
||||
(t '(#\+ #\- #\|))))
|
||||
(tc (first chars)) (hc (second chars)) (vc (third chars)))
|
||||
;; Top edge
|
||||
(%set-cell fb x y tc :fg fg :bg bg)
|
||||
(loop for i from 1 below (1- w) do (%set-cell fb (+ x i) y hc :fg fg :bg bg))
|
||||
(%set-cell fb (1- (+ x w)) y tc :fg fg :bg bg)
|
||||
;; Sides
|
||||
(dotimes (row (- h 2))
|
||||
(%set-cell fb x (+ y row 1) vc :fg fg :bg bg)
|
||||
(%set-cell fb (1- (+ x w)) (+ y row 1) vc :fg fg :bg bg))
|
||||
;; Bottom edge
|
||||
(%set-cell fb x (+ y h -1) tc :fg fg :bg bg)
|
||||
(loop for i from 1 below (1- w) do (%set-cell fb (+ x i) (+ y h -1) hc :fg fg :bg bg))
|
||||
(%set-cell fb (1- (+ x w)) (+ y h -1) tc :fg fg :bg bg)
|
||||
;; Title
|
||||
(when title
|
||||
(loop for i from 0 below (length title)
|
||||
do (%set-cell fb (+ x 2 i) y (char title i) :fg fg :bg bg)))))
|
||||
#+END_SRC
|
||||
|
||||
*** backend-clear
|
||||
|
||||
Clears every cell in the framebuffer to a fresh default cell (space, no style).
|
||||
This is the ~backend-clear~ protocol method specialized on ~framebuffer-backend~,
|
||||
providing a full-frame reset used between render passes.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod backend-clear ((fb framebuffer-backend))
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(dotimes (y (framebuffer-height cells))
|
||||
(dotimes (x (framebuffer-width cells))
|
||||
(setf (aref cells y x) (make-cell))))))
|
||||
#+END_SRC
|
||||
|
||||
** Link and ellipsis methods
|
||||
|
||||
*** draw-link
|
||||
|
||||
Draws text with an associated OSC-8 hyperlink URL. The framebuffer backend
|
||||
stores the URL in the cell's ~link-url~ slot for later retrieval (e.g., on
|
||||
mouse click). The actual OSC-8 escape sequence rendering is deferred to the
|
||||
real backend during flush.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-link ((fb framebuffer-backend) x y string url &key fg bg)
|
||||
;; OSC 8 links are not rendered in framebuffer — store as text
|
||||
(draw-text fb x y string fg bg :link-url url))
|
||||
#+END_SRC
|
||||
|
||||
*** draw-ellipsis
|
||||
|
||||
Renders a horizontal ellipsis (up to 3 periods) starting at position (X, Y).
|
||||
Width is capped at 3 characters to prevent overflow into adjacent cells.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmethod draw-ellipsis ((fb framebuffer-backend) x y width &key fg bg)
|
||||
(dotimes (i (min 3 width))
|
||||
(%set-cell fb (+ x i) y #\. :fg fg :bg bg)))
|
||||
#+END_SRC
|
||||
|
||||
** Diff engine
|
||||
|
||||
*** cells-equal-p
|
||||
|
||||
Compares two ~cell~ structs field by field to determine if they represent the
|
||||
same visual output. Uses ~eql~ for characters, symbols, and booleans, and
|
||||
~equal~ for string comparison of ~link-url~. This predicate drives the diff
|
||||
algorithm — only cells that differ are flushed.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun cells-equal-p (a b)
|
||||
"Return T if two cells have identical content and style."
|
||||
(and (eql (cell-char a) (cell-char b))
|
||||
(eql (cell-fg a) (cell-fg b))
|
||||
(eql (cell-bg a) (cell-bg b))
|
||||
(eql (cell-bold a) (cell-bold b))
|
||||
(eql (cell-italic a) (cell-italic b))
|
||||
(eql (cell-underline a) (cell-underline b))
|
||||
(equal (cell-link-url a) (cell-link-url b))))
|
||||
#+END_SRC
|
||||
|
||||
*** diff-framebuffers
|
||||
|
||||
The core difference algorithm: iterate over the overlapping region of two
|
||||
framebuffers and collect a list of (X Y CELL) triples for every cell that
|
||||
changed. Using ~nreverse~ at the end ensures stable ordering (top-to-bottom,
|
||||
left-to-right) without consing during accumulation.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun diff-framebuffers (prev curr)
|
||||
"Compare PREV and CURR framebuffers. Return list of (X Y CELL) for changes."
|
||||
(let ((changes nil)
|
||||
(h (min (framebuffer-height prev) (framebuffer-height curr)))
|
||||
(w (min (framebuffer-width prev) (framebuffer-width curr))))
|
||||
(dotimes (y h)
|
||||
(dotimes (x w)
|
||||
(let ((a (aref prev y x)) (b (aref curr y x)))
|
||||
(unless (cells-equal-p a b)
|
||||
(push (list x y b) changes)))))
|
||||
(nreverse changes)))
|
||||
#+END_SRC
|
||||
|
||||
** Flush
|
||||
|
||||
*** flush-framebuffer
|
||||
|
||||
Orchestrates the full diff-and-flush cycle. Computes the difference between
|
||||
previous and current framebuffers, then replays changes to a real backend using
|
||||
minimal cursor movement (tracking the current row to avoid redundant cursor
|
||||
positioning). Returns the count of changed cells so callers can monitor
|
||||
rendering overhead.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun flush-framebuffer (prev-fb curr-fb backend)
|
||||
"Diff PREV-FB and CURR-FB and flush changes to BACKEND.
|
||||
Returns the number of changed cells."
|
||||
(let* ((changes (diff-framebuffers prev-fb curr-fb))
|
||||
(count (length changes))
|
||||
(current-row -1))
|
||||
(when (plusp count)
|
||||
(begin-sync backend)
|
||||
(dolist (change changes)
|
||||
(destructuring-bind (x y cell) change
|
||||
(unless (= y current-row)
|
||||
(cursor-move backend x y)
|
||||
(setf current-row y))
|
||||
(draw-text backend x y (string (cell-char cell))
|
||||
(cell-fg cell) (cell-bg cell)
|
||||
:bold (cell-bold cell)
|
||||
:italic (cell-italic cell)
|
||||
:underline (cell-underline cell))))
|
||||
(end-sync backend))
|
||||
count))
|
||||
#+END_SRC
|
||||
|
||||
** Frame inspection (for mouse selection / link clicking)
|
||||
|
||||
*** fb-cell-link-url
|
||||
|
||||
Retrieves the hyperlink URL stored at cell position (X, Y) in a framebuffer
|
||||
array. Returns nil if the cell is out of bounds or has no link. This enables
|
||||
click-to-open-link functionality in the TUI.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun fb-cell-link-url (fb x y)
|
||||
"Return the link URL at (X Y) in framebuffer FB, or nil."
|
||||
(when (and (arrayp fb) (>= y 0) (< y (array-dimension fb 0))
|
||||
(>= x 0) (< x (array-dimension fb 1)))
|
||||
(let ((c (aref fb y x)))
|
||||
(cell-link-url c))))
|
||||
#+END_SRC
|
||||
|
||||
*** extract-text
|
||||
|
||||
Extracts visible text from a rectangular region of the framebuffer, useful for
|
||||
mouse selection and clipboard operations. Normalizes coordinate order (so the
|
||||
user can drag in any direction) and appends newlines between rows for natural
|
||||
multi-line text.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defun extract-text (fb x1 y1 x2 y2)
|
||||
"Extract visible text from the rectangle between (X1,Y1) and (X2,Y2)."
|
||||
(let ((x-min (max 0 (min x1 x2))) (x-max (max 0 (max x1 x2)))
|
||||
(y-min (max 0 (min y1 y2))) (y-max (max 0 (max y1 y2)))
|
||||
(h (if (arrayp fb) (array-dimension fb 0) 0))
|
||||
(w (if (arrayp fb) (array-dimension fb 1) 0)))
|
||||
(with-output-to-string (s)
|
||||
(loop for y from y-min to (min y-max (1- h))
|
||||
do (loop for x from x-min to (min x-max (1- w))
|
||||
do (let ((c (aref fb y x)))
|
||||
(princ (cell-char c) s)))
|
||||
(when (< y y-max) (princ #\Newline s))))))
|
||||
#+END_SRC
|
||||
|
||||
** Scissor clipping
|
||||
|
||||
*** with-scissor
|
||||
|
||||
A macro that temporarily sets the scissor rectangle on a framebuffer backend
|
||||
for the duration of BODY. Saves and restores previous scissor state via
|
||||
~unwind-protect~ for proper cleanup even on non-local exits. Using gensyms for
|
||||
the state variables ensures no variable capture issues.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/rendering/framebuffer.lisp
|
||||
(defmacro with-scissor ((fb x y w h) &body body)
|
||||
"Clip all drawing on FB to rectangle (X Y W H)."
|
||||
(let ((old-x (gensym)) (old-y (gensym))
|
||||
(old-w (gensym)) (old-h (gensym)))
|
||||
`(let ((,old-x (fb-scissor-x ,fb))
|
||||
(,old-y (fb-scissor-y ,fb))
|
||||
(,old-w (fb-scissor-w ,fb))
|
||||
(,old-h (fb-scissor-h ,fb)))
|
||||
(setf (fb-scissor-x ,fb) ,x
|
||||
(fb-scissor-y ,fb) ,y
|
||||
(fb-scissor-w ,fb) ,w
|
||||
(fb-scissor-h ,fb) ,h)
|
||||
(unwind-protect (progn ,@body)
|
||||
(setf (fb-scissor-x ,fb) ,old-x
|
||||
(fb-scissor-y ,fb) ,old-y
|
||||
(fb-scissor-w ,fb) ,old-w
|
||||
(fb-scissor-h ,fb) ,old-h)))))
|
||||
#+END_SRC
|
||||
|
||||
* Tests
|
||||
|
||||
** Test package and suite setup
|
||||
|
||||
Setting up the test package with FiveAM, importing the rendering and backend
|
||||
packages for use in all subsequent tests. This block tangles to the test file
|
||||
that is loaded by the test runner.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(defpackage :cl-tty-framebuffer-test
|
||||
(:use :cl :fiveam :cl-tty.rendering :cl-tty.backend))
|
||||
(in-package :cl-tty-framebuffer-test)
|
||||
|
||||
(def-suite framebuffer-suite :description "Framebuffer rendering pipeline tests")
|
||||
(in-suite framebuffer-suite)
|
||||
#+END_SRC
|
||||
|
||||
** Test: make-framebuffer creates correct size
|
||||
|
||||
Verify that the framebuffer constructor produces an array with the expected
|
||||
dimensions. Height should match the first dimension (rows), width the second
|
||||
dimension (columns).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test make-framebuffer-creates-correct-size
|
||||
(let ((fb (make-framebuffer 80 24)))
|
||||
(is (= 24 (framebuffer-height fb)))
|
||||
(is (= 80 (framebuffer-width fb)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: cell defaults are space
|
||||
|
||||
Cells created via MAKE-CELL with no arguments should default to a space
|
||||
character with nil foreground and background — a blank, unstyled cell.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test cell-defaults-are-space
|
||||
(let ((cell (aref (make-framebuffer 10 10) 0 0)))
|
||||
(is (eql #\space (cell-char cell)))
|
||||
(is (null (cell-fg cell)))
|
||||
(is (null (cell-bg cell)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: draw-text on framebuffer sets cells
|
||||
|
||||
Drawing a string into the framebuffer backend should set the character and
|
||||
foreground color at each cell position. Characters should appear at the expected
|
||||
(x, y) offsets.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test draw-text-on-fb-sets-cells
|
||||
(let ((fb (make-framebuffer-backend)))
|
||||
(draw-text fb 2 3 "abc" :red nil)
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\a (cell-char (aref cells 3 2))))
|
||||
(is (eql #\b (cell-char (aref cells 3 3))))
|
||||
(is (eql #\c (cell-char (aref cells 3 4))))
|
||||
(is (eql :red (cell-fg (aref cells 3 2)))))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: draw-text clips at bounds
|
||||
|
||||
When drawing text that extends past the right edge of the framebuffer, cells
|
||||
beyond the width should remain unchanged (space characters). This prevents
|
||||
buffer overflow and undefined memory access.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test draw-text-clips-at-bounds
|
||||
(let ((fb (make-framebuffer-backend :width 10 :height 5)))
|
||||
(draw-text fb 8 2 "hello" nil nil)
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\h (cell-char (aref cells 2 8))))
|
||||
(is (eql #\e (cell-char (aref cells 2 9))))
|
||||
(is (eql #\space (cell-char (aref cells 2 0))) "out of bounds text is ignored"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: diff of identical framebuffers returns empty
|
||||
|
||||
Two framebuffers with identical cells should produce no changes. The diff
|
||||
engine must short-circuit when no cells differ.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test diff-identical-fbs-returns-empty
|
||||
(let ((fb1 (make-framebuffer 80 24))
|
||||
(fb2 (make-framebuffer 80 24)))
|
||||
(is (null (diff-framebuffers fb1 fb2)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: diff of changed framebuffer returns changes
|
||||
|
||||
After modifying a single cell in one framebuffer, the diff engine should return
|
||||
exactly one change with the correct coordinates and cell data.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test diff-changed-fb-returns-changes
|
||||
(let* ((fb1 (make-framebuffer 10 10))
|
||||
(fb2 (make-framebuffer 10 10)))
|
||||
(setf (aref fb2 5 5) (make-cell :char #\X :fg :red))
|
||||
(let ((changes (diff-framebuffers fb1 fb2)))
|
||||
(is (= 1 (length changes)))
|
||||
(destructuring-bind (x y cell) (first changes)
|
||||
(is (= 5 x))
|
||||
(is (= 5 y))
|
||||
(is (eql #\X (cell-char cell)))))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: with-scissor clips drawing
|
||||
|
||||
When a scissor rectangle is active, drawing operations outside the rectangle
|
||||
should be clipped away. Operations inside the rectangle should proceed normally.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test with-scissor-clips-drawing
|
||||
(let ((fb (make-framebuffer-backend :width 20 :height 10)))
|
||||
(with-scissor (fb 5 5 3 3)
|
||||
(draw-text fb 6 6 "ABC" nil nil)
|
||||
(draw-text fb 1 1 "OUTSIDE" nil nil))
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (eql #\A (cell-char (aref cells 6 6))) "inside scissor draws")
|
||||
(is (eql #\space (cell-char (aref cells 1 1))) "outside scissor is clipped"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: flush handles different-sized framebuffers
|
||||
|
||||
When comparing framebuffers of different sizes, only the overlapping region
|
||||
should be diffed. This test verifies correct behavior at both the smaller and
|
||||
larger end of the size mismatch — ensuring edge cells in the non-overlapping
|
||||
region are ignored.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test flush-different-sized-fbs-handles-edge-cells
|
||||
(let* ((small-fb (make-framebuffer 5 5))
|
||||
(large-fb (make-framebuffer 10 10))
|
||||
(be (make-simple-backend :output-stream (make-string-output-stream))))
|
||||
(setf (aref small-fb 0 0) (make-cell :char #\X :fg :red))
|
||||
(let ((changes (diff-framebuffers small-fb large-fb)))
|
||||
(is (= 1 (length changes)) "one cell changed in overlap region"))
|
||||
(let ((changed (flush-framebuffer small-fb large-fb be)))
|
||||
(is (= 1 changed) "flush reports 1 changed cell"))
|
||||
(setf (aref large-fb 9 9) (make-cell :char #\Y :fg :blue))
|
||||
(let ((changes2 (diff-framebuffers large-fb small-fb)))
|
||||
(is (= 1 (length changes2)) "only overlapping region diffed"))
|
||||
(let ((changed2 (flush-framebuffer large-fb small-fb be)))
|
||||
(is (= 1 changed2) "flush with shrunk fb reports 1 changed cell"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: flush-fb copies to backend
|
||||
|
||||
After drawing on a framebuffer backend and flushing to a real backend, at least
|
||||
one cell change should be detected and forwarded to the output backend.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test flush-fb-copies-to-backend
|
||||
(let* ((real-be (make-simple-backend :output-stream (make-string-output-stream)))
|
||||
(fb (make-framebuffer-backend)))
|
||||
(draw-text fb 0 0 "X" :red nil)
|
||||
(let ((changed (flush-framebuffer (make-framebuffer 80 24) (fb-framebuffer fb) real-be)))
|
||||
(is (>= changed 1)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: fb-cell-link-url returns nil for blank cell
|
||||
|
||||
A cell without a hyperlink should return nil from ~fb-cell-link-url~, ensuring
|
||||
the default state is correct and no spurious URL is reported.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test fb-cell-link-url-returns-nil-for-blank-cell
|
||||
(let ((fb (make-framebuffer 10 10)))
|
||||
(is (null (fb-cell-link-url fb 5 5)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: fb-cell-link-url finds link-url
|
||||
|
||||
After drawing text with a link-url, the corresponding cell should return that
|
||||
URL. Cells at other positions should still return nil. This validates that
|
||||
link metadata is stored per-cell and correctly retrievable.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test fb-cell-link-url-finds-link-url
|
||||
(let ((fb (make-framebuffer-backend)))
|
||||
(draw-text fb 0 0 "click" nil nil :link-url "https://example.com")
|
||||
(is (equal "https://example.com" (fb-cell-link-url (fb-framebuffer fb) 0 0)))
|
||||
(is (null (fb-cell-link-url (fb-framebuffer fb) 5 5)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: fb-cell-link-url out of bounds returns nil
|
||||
|
||||
Querying a cell position outside the framebuffer dimensions should gracefully
|
||||
return nil rather than erroring, which prevents crashes during mouse event
|
||||
processing at the edges of the terminal.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test fb-cell-link-url-out-of-bounds-returns-nil
|
||||
(let ((fb (make-framebuffer 5 5)))
|
||||
(is (null (fb-cell-link-url fb 10 10)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: extract-text single row
|
||||
|
||||
Extracting text from a single row of the framebuffer should return the
|
||||
characters in that row as a contiguous string, preserving order and including
|
||||
only visible characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test extract-text-single-row
|
||||
(let ((fb (make-framebuffer-backend)))
|
||||
(draw-text fb 0 0 "hello" nil nil)
|
||||
(let ((cells (fb-framebuffer fb)))
|
||||
(is (equal "hello" (extract-text cells 0 0 4 0))))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: extract-text multi-row
|
||||
|
||||
Extracting text from a rectangle spanning multiple rows should concatenate
|
||||
rows with newline separators. This matches the expected behavior for clipboard
|
||||
copy of rectangular selections in the TUI.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/framebuffer-tests.lisp
|
||||
(test extract-text-multi-row
|
||||
(let ((fb (make-framebuffer-backend)))
|
||||
(draw-text fb 0 0 "abc" nil nil)
|
||||
(draw-text fb 0 1 "def" nil nil)
|
||||
(let* ((cells (fb-framebuffer fb))
|
||||
(text (extract-text cells 0 0 2 1)))
|
||||
(is (equal "abc
|
||||
def" text)))))
|
||||
#+END_SRC
|
||||
471
org/integration-tests.org
Normal file
471
org/integration-tests.org
Normal file
@@ -0,0 +1,471 @@
|
||||
#+TITLE: Integration Tests for cl-tty
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:test:
|
||||
|
||||
* Overview
|
||||
|
||||
These integration tests compose all major cl-tty components through the
|
||||
framebuffer backend and verify cell-level output. Instead of mocking
|
||||
individual components, each test creates a real ~framebuffer-backend~,
|
||||
plumbs components into it, and inspects the resulting cell grid.
|
||||
|
||||
This gives us confidence that:
|
||||
|
||||
- Components render the expected characters at the expected positions.
|
||||
- Layout coordinates are applied correctly before rendering.
|
||||
- Scroll offsets, cursor positions, dialog stacks, and toast messages
|
||||
all compose correctly on a single framebuffer.
|
||||
- The full ~render-screen~ pipeline works end-to-end.
|
||||
|
||||
The framebuffer backend uses ASCII box-drawing characters (+, -, |) so
|
||||
tests remain portable across terminals.
|
||||
|
||||
** Test layout
|
||||
|
||||
The file is structured as:
|
||||
|
||||
1. Package definition, suite definition, and helper functions (first
|
||||
block — overwrites target).
|
||||
2. Individual test functions (each in its own block — appends target).
|
||||
|
||||
* Package and Suite
|
||||
|
||||
The integration tests live in their own package ~cl-tty-integration-test~
|
||||
to avoid polluting the component namespaces. We use ~fiveam~ for the test
|
||||
framework with ~def-suite~ and ~in-suite~ so all tests belong to
|
||||
~integration-suite~.
|
||||
|
||||
The run-all-tests.lisp loader references this suite by name
|
||||
(~\"INTEGRATION-SUITE\"~) and looks it up via ~find-symbol~ in the
|
||||
package, so the symbol must be interned and accessible.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
;;; integration-tests.lisp — Full pipeline integration tests for cl-tty
|
||||
;;;
|
||||
;;; Composes all major components through the rendering pipeline onto a
|
||||
;;; framebuffer backend and verifies cell-level output.
|
||||
;;;
|
||||
;;; This file is tangled from org/integration-tests.org — do not edit directly.
|
||||
|
||||
(defpackage :cl-tty-integration-test
|
||||
(:use :cl :fiveam
|
||||
:cl-tty.backend :cl-tty.box :cl-tty.layout
|
||||
:cl-tty.input
|
||||
:cl-tty.rendering :cl-tty.dialog))
|
||||
|
||||
(in-package :cl-tty-integration-test)
|
||||
|
||||
(def-suite integration-suite
|
||||
:description "Full pipeline integration tests for cl-tty")
|
||||
|
||||
(in-suite integration-suite)
|
||||
#+END_SRC
|
||||
|
||||
* Helper Functions
|
||||
|
||||
These helpers extract and search text from the framebuffer cell grid.
|
||||
They are shared by all tests and avoid duplicating cell-access logic.
|
||||
|
||||
** ~fb-string~
|
||||
|
||||
Reads a string of ~len~ characters from framebuffer ~fb~ starting at
|
||||
coordinates ~(x, y)~. This is the primitive all other helpers build on.
|
||||
|
||||
The framebuffer stores cells in a 2D array indexed as ~(aref cells y x)~.
|
||||
Cells are structs with a ~cell-char~ slot holding the character. We
|
||||
iterate horizontally and collect each ~cell-char~ into a string.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(defun fb-string (fb x y &optional (len 1))
|
||||
"Read a string of LEN characters from framebuffer FB starting at (X,Y)."
|
||||
(let* ((cells (fb-framebuffer fb))
|
||||
(w (framebuffer-width cells))
|
||||
(h (framebuffer-height cells)))
|
||||
(declare (ignore h))
|
||||
(with-output-to-string (s)
|
||||
(loop for i from 0 below len
|
||||
for cx = (+ x i)
|
||||
while (< cx w)
|
||||
do (princ (cell-char (aref cells y cx)) s)))))
|
||||
#+END_SRC
|
||||
|
||||
** ~fb-lines~
|
||||
|
||||
Extracts all rows from the framebuffer as a list of strings. Each row is
|
||||
the full width of the framebuffer converted via ~fb-string~. Optional
|
||||
~start-row~ and ~end-row~ keywords let callers inspect a sub-region.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(defun fb-lines (fb &key (start-row 0) (end-row nil))
|
||||
"Extract all lines from framebuffer FB as a list of strings."
|
||||
(let* ((cells (fb-framebuffer fb))
|
||||
(w (framebuffer-width cells))
|
||||
(h (framebuffer-height cells))
|
||||
(max-row (min (or end-row h) h)))
|
||||
(declare (ignore w))
|
||||
(loop for y from start-row below max-row
|
||||
collect (fb-string fb 0 y (framebuffer-width cells)))))
|
||||
#+END_SRC
|
||||
|
||||
** ~fb-contains~
|
||||
|
||||
Returns ~T~ if the text content of the framebuffer contains ~text~
|
||||
anywhere, using case-insensitive comparison. Concatenates all lines with
|
||||
newlines and runs ~search~.
|
||||
|
||||
This is the most commonly used assertion helper — it lets tests check for
|
||||
the presence of rendered text without specifying exact coordinates.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(defun fb-contains (fb text)
|
||||
"Return T if framebuffer FB contains TEXT anywhere."
|
||||
(let ((all-text (format nil "~{~a~^~%~}" (fb-lines fb))))
|
||||
(search text all-text :test #'char-equal)))
|
||||
#+END_SRC
|
||||
|
||||
* Individual Tests
|
||||
|
||||
** Box with title renders correctly
|
||||
|
||||
A ~Box~ with a ~:single~ border style draws ASCII border characters
|
||||
(+, -, |) and paints the title text at the top border. This test verifies
|
||||
both the structural border characters and the title positioning.
|
||||
|
||||
The title is rendered starting at column 2 of row 1 (just inside the
|
||||
top border). We check ~fb-string~ at those exact coordinates for the
|
||||
title text, and ~fb-contains~ for the border characters.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test box-title-renders-on-fb
|
||||
"A Box with a title draws border and title text on framebuffer."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 10))
|
||||
(bx (make-box :border-style :single :title "My Box" :width 40 :height 10)))
|
||||
(compute-layout (box-layout-node bx) 40 10)
|
||||
(render-box bx fb)
|
||||
;; Framebuffer uses ASCII border chars (+, -, |)
|
||||
(is-true (fb-contains fb "My Box") "title text appears")
|
||||
(is-true (fb-contains fb "+") "top-left corner appears")
|
||||
(is-true (fb-contains fb "-") "horizontal border appears")
|
||||
;; Check the title at row 0, col 2
|
||||
(is (equal "My Box" (fb-string fb 2 1 6)) "title at correct position")))
|
||||
#+END_SRC
|
||||
|
||||
** Text component with word-wrap
|
||||
|
||||
The ~Text~ component word-wraps content to fit within a given width and
|
||||
height. This test renders a sentence longer than the framebuffer width
|
||||
and verifies that individual words break across lines as expected.
|
||||
|
||||
Word-wrap mode ~:word~ preserves word boundaries — it only wraps between
|
||||
words, never in the middle of one. The framebuffer is 20 columns wide, so
|
||||
each row holds roughly 2-3 words.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test text-component-on-fb
|
||||
"Text component renders word-wrapped content on framebuffer."
|
||||
(let* ((fb (make-framebuffer-backend :width 20 :height 6))
|
||||
(tx (make-text "Hello brave new world of terminal UI"
|
||||
:wrap-mode :word :width 20 :height 4)))
|
||||
(compute-layout (text-layout-node tx) 20 4)
|
||||
(render-text tx fb)
|
||||
(is-true (fb-contains fb "Hello") "first word appears")
|
||||
(is-true (fb-contains fb "brave") "second word appears")
|
||||
(is-true (fb-contains fb "world") "third word wraps")))
|
||||
#+END_SRC
|
||||
|
||||
** TextInput with value
|
||||
|
||||
~TextInput~ renders its current value as plain text and draws a cursor
|
||||
block (~█~) at the cursor position. The cursor character is a full block
|
||||
(U+2588) — a Unicode character that renders as a solid rectangle in most
|
||||
terminals.
|
||||
|
||||
This test checks the value string at row 0 and then directly inspects the
|
||||
cell at the cursor position to confirm the block character is present.
|
||||
Direct cell access (~aref~ on the framebuffer array) is necessary because
|
||||
the cursor block is a single character that ~fb-contains~ could match
|
||||
ambiguously.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test textinput-value-on-fb
|
||||
"TextInput renders its value and cursor on framebuffer."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 3))
|
||||
(ti (make-text-input :value "hello world" :cursor 11)))
|
||||
(setf (text-input-layout-node ti)
|
||||
(make-layout-node :width 40 :height 1))
|
||||
(compute-layout (text-input-layout-node ti) 40 1)
|
||||
(render ti fb)
|
||||
;; Verify value via direct cell inspection
|
||||
(is (equal "hello world" (fb-string fb 0 0 11)) "value appears at row 0")
|
||||
;; Check cursor block at position 11
|
||||
(let* ((cells (fb-framebuffer fb))
|
||||
(cursor-char (cell-char (aref cells 0 11))))
|
||||
(is (eql #\█ cursor-char) "cursor block is drawn at position 11"))))
|
||||
#+END_SRC
|
||||
|
||||
** TextInput empty shows placeholder
|
||||
|
||||
When ~TextInput~ has an empty value (~\"\"~) and a ~placeholder~ is set,
|
||||
the placeholder text is rendered in place of the value. This provides
|
||||
visual guidance to the user about what to type.
|
||||
|
||||
The placeholder must disappear once a value is set — that behavior is
|
||||
tested indirectly here by verifying the placeholder text appears on an
|
||||
empty input.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test textinput-placeholder-on-fb
|
||||
"TextInput with empty value shows placeholder text."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 3))
|
||||
(ti (make-text-input :value "" :placeholder "Type here...")))
|
||||
(setf (text-input-layout-node ti)
|
||||
(make-layout-node :width 40 :height 1))
|
||||
(compute-layout (text-input-layout-node ti) 40 1)
|
||||
(render ti fb)
|
||||
(is (equal "Type here..." (fb-string fb 0 0 12)) "placeholder appears at row 0")))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox with children
|
||||
|
||||
~ScrollBox~ is a container that renders a subset of its children based on
|
||||
scroll offset. Children above the offset are clipped (scrolled out), and
|
||||
only visible children appear in the viewport.
|
||||
|
||||
This test creates 8 text children (each one line tall) in a ScrollBox
|
||||
with ~scroll-y=2~ and a viewport height of 8. Lines 1-2 should be
|
||||
scrolled out, while Lines 3-8 should be visible. We check both presence
|
||||
(visible lines) and absence (scrolled-out lines).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test scrollbox-children-on-fb
|
||||
"ScrollBox renders visible children offset by scroll position."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 10))
|
||||
(children nil))
|
||||
;; Create 8 text children, each 1 line tall
|
||||
(dotimes (i 8)
|
||||
(let ((tx (make-text (format nil "Line ~D" (1+ i))
|
||||
:wrap-mode :none :width 40 :height 1)))
|
||||
(push tx children)))
|
||||
(setf children (nreverse children))
|
||||
(let ((sb (make-scroll-box :children children :scroll-y 2)))
|
||||
;; Set scroll-box layout to 40x8 viewport using component-layout-node
|
||||
(let ((ln (component-layout-node sb)))
|
||||
(setf (layout-node-width ln) 40)
|
||||
(setf (layout-node-height ln) 8))
|
||||
;; Layout each child too
|
||||
(dolist (c children)
|
||||
(compute-layout (component-layout-node c) 40 1))
|
||||
(render sb fb)
|
||||
;; Because scroll-y=2, Line 1 and Line 2 are scrolled out
|
||||
;; Line 3 should be first visible
|
||||
(is-true (fb-contains fb "Line 3") "scroll-y=2 shows Line 3 first")
|
||||
(is-true (fb-contains fb "Line 4") "Line 4 is visible")
|
||||
(is-true (fb-contains fb "Line 5") "Line 5 is visible")
|
||||
;; Line 1 and 2 should NOT be visible (scrolled out)
|
||||
(is-false (fb-contains fb "Line 1") "Line 1 scrolled out")
|
||||
(is-false (fb-contains fb "Line 2") "Line 2 scrolled out"))))
|
||||
#+END_SRC
|
||||
|
||||
** Select renders options
|
||||
|
||||
~Select~ is a dropdown-like component that displays a list of options
|
||||
with titles. This test verifies that all three option titles (\"Red\",
|
||||
\"Green\", \"Blue\") appear on the framebuffer after rendering.
|
||||
|
||||
The ~make-select~ function takes a list of plists with ~:title~ and
|
||||
~:value~ keys. The render method iterates over options and draws each
|
||||
title.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test select-options-on-fb
|
||||
"Select renders option titles on framebuffer."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 10))
|
||||
(sel (make-select
|
||||
:options '((:title "Red" :value :red)
|
||||
(:title "Green" :value :green)
|
||||
(:title "Blue" :value :blue)))))
|
||||
(let ((ln (select-layout-node sel)))
|
||||
(setf (layout-node-width ln) 40)
|
||||
(setf (layout-node-height ln) 5))
|
||||
(render sel fb)
|
||||
(is-true (fb-contains fb "Red") "first option appears")
|
||||
(is-true (fb-contains fb "Green") "second option appears")
|
||||
(is-true (fb-contains fb "Blue") "third option appears")))
|
||||
#+END_SRC
|
||||
|
||||
** Dialog renders with backdrop
|
||||
|
||||
~Dialog~ is a modal overlay component. When pushed onto the dialog stack,
|
||||
rendering it draws a dimmed backdrop over the entire framebuffer and a
|
||||
dialog panel (with border and title) centered in the viewport.
|
||||
|
||||
This test creates a dialog with title \"Confirm\", pushes it onto the
|
||||
global stack, renders it, and checks for the title and ASCII border
|
||||
characters. The backdrop is a dimming overlay applied across the full
|
||||
framebuffer area.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test dialog-appears-on-fb
|
||||
"Dialog renders a dimmed backdrop and dialog panel with title."
|
||||
(let* ((fb (make-framebuffer-backend :width 80 :height 24))
|
||||
(d (make-instance 'dialog :title "Confirm" :size :small)))
|
||||
(push-dialog d)
|
||||
(render-dialog d fb 80 24)
|
||||
;; Dialog title appears somewhere in the output
|
||||
(is-true (fb-contains fb "Confirm") "dialog title appears")
|
||||
;; Dialog border (ASCII)
|
||||
(is-true (fb-contains fb "+") "dialog border appears")
|
||||
(is-true (fb-contains fb "|") "dialog vertical border appears")
|
||||
;; Clean up
|
||||
(pop-dialog)))
|
||||
#+END_SRC
|
||||
|
||||
** Dialog push/pop with render
|
||||
|
||||
The dialog system maintains a stack (~*dialog-stack*~). When multiple
|
||||
dialogs are pushed, only the topmost dialog is rendered. Popping a dialog
|
||||
restores the previous one.
|
||||
|
||||
This test pushes two dialogs (\"Dialog One\" and \"Dialog Two\"),
|
||||
verifies that only the top dialog (\"Dialog Two\") renders, then pops it
|
||||
and verifies that \"Dialog One\" appears after clearing and re-rendering.
|
||||
This exercises the full push-pop-render cycle.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test dialog-push-pop-render
|
||||
"Dialog push/pop cycle works with rendering."
|
||||
(let* ((fb (make-framebuffer-backend :width 80 :height 24))
|
||||
(d1 (make-instance 'dialog :title "Dialog One"))
|
||||
(d2 (make-instance 'dialog :title "Dialog Two")))
|
||||
(push-dialog d1)
|
||||
(push-dialog d2)
|
||||
(render-dialog (first *dialog-stack*) fb 80 24)
|
||||
(is-true (fb-contains fb "Dialog Two") "top dialog renders")
|
||||
(pop-dialog)
|
||||
(backend-clear fb)
|
||||
(render-dialog (first *dialog-stack*) fb 80 24)
|
||||
(is-true (fb-contains fb "Dialog One") "second dialog renders after pop")
|
||||
(pop-dialog)))
|
||||
#+END_SRC
|
||||
|
||||
** Toast renders
|
||||
|
||||
~Toast~ notifications are ephemeral messages that appear at the bottom of
|
||||
the screen with a colored background. They are managed via ~*toasts*~, a
|
||||
list of active toasts.
|
||||
|
||||
This test creates a toast with variant ~:info~, renders the first toast
|
||||
in the list, verifies the message text appears, and then dismisses it to
|
||||
clean up. The ~duration~ is set to 0 so the toast does not auto-dismiss
|
||||
during the test.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test toast-appears-on-fb
|
||||
"Toast notification renders with colored background."
|
||||
(let* ((fb (make-framebuffer-backend :width 80 :height 24)))
|
||||
(toast "Hello from toast!" :variant :info :duration 0)
|
||||
(render-toast (first *toasts*) fb 80)
|
||||
(is-true (fb-contains fb "Hello from toast!") "toast message appears")
|
||||
(dismiss-toast (first *toasts*))))
|
||||
#+END_SRC
|
||||
|
||||
** render-screen pipeline
|
||||
|
||||
~render-screen~ is the top-level entry point for the rendering pipeline.
|
||||
It takes a component tree root and a backend, performs layout computation
|
||||
(if needed), and renders all components recursively.
|
||||
|
||||
This test creates a simple tree with a single Box, calls
|
||||
~render-screen~, and verifies that both the title and border characters
|
||||
appear. This validates that the pipeline dispatches correctly from root
|
||||
through the component hierarchy.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test render-screen-pipeline
|
||||
"render-screen processes a component tree through the full pipeline."
|
||||
(let* ((fb (make-framebuffer-backend :width 40 :height 12))
|
||||
(root (make-box :border-style :single :title "Root"
|
||||
:width 40 :height 12)))
|
||||
(render-screen root fb)
|
||||
(is-true (fb-contains fb "Root") "title renders via render-screen")
|
||||
;; Border characters (ASCII on framebuffer)
|
||||
(is-true (fb-contains fb "+") "border renders")))
|
||||
#+END_SRC
|
||||
|
||||
** Full composition via framebuffer
|
||||
|
||||
The ultimate integration test: compose all major components (Box, Text,
|
||||
TextInput, Select) on a single framebuffer at specific positions and
|
||||
verify everything renders correctly.
|
||||
|
||||
The layout is a 60x24 framebuffer with:
|
||||
|
||||
- A Box titled \"Dashboard\" as the outer container.
|
||||
- A Text component with welcome message at (2, 2).
|
||||
- A TextInput with value \"search query\" and cursor at position 12,
|
||||
positioned at (2, 6).
|
||||
- A Select with three options positioned at (2, 8).
|
||||
|
||||
Each component is positioned manually via ~layout-node-x~ and
|
||||
~layout-node-y~ to simulate a composed screen. All components must coexist
|
||||
without overwriting each other's output.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/integration-tests.lisp
|
||||
(test full-composition-via-fb
|
||||
"All components compose correctly on a single framebuffer."
|
||||
(let* ((fb (make-framebuffer-backend :width 60 :height 24)))
|
||||
;;
|
||||
;; 1. Box with title at top
|
||||
;;
|
||||
(let ((bx (make-box :border-style :single :title "Dashboard"
|
||||
:width 60 :height 24)))
|
||||
(compute-layout (box-layout-node bx) 60 24)
|
||||
(render-box bx fb))
|
||||
|
||||
;;
|
||||
;; 2. Text content inside
|
||||
;;
|
||||
(let ((tx (make-text "Welcome to the dashboard."
|
||||
:wrap-mode :word :width 56 :height 3)))
|
||||
(setf (layout-node-x (text-layout-node tx)) 2)
|
||||
(setf (layout-node-y (text-layout-node tx)) 2)
|
||||
(compute-layout (text-layout-node tx) 56 3)
|
||||
(render-text tx fb))
|
||||
|
||||
;;
|
||||
;; 3. TextInput
|
||||
;;
|
||||
(let ((ti (make-text-input :value "search query" :cursor 12)))
|
||||
(setf (text-input-layout-node ti) (make-layout-node))
|
||||
(setf (layout-node-x (text-input-layout-node ti)) 2)
|
||||
(setf (layout-node-y (text-input-layout-node ti)) 6)
|
||||
(setf (layout-node-width (text-input-layout-node ti)) 56)
|
||||
(setf (layout-node-height (text-input-layout-node ti)) 1)
|
||||
(render ti fb))
|
||||
|
||||
;;
|
||||
;; 4. Select options
|
||||
;;
|
||||
(let ((sel (make-select
|
||||
:options '((:title "Option A" :value :a)
|
||||
(:title "Option B" :value :b)
|
||||
(:title "Option C" :value :c)))))
|
||||
(setf (select-layout-node sel) (make-layout-node))
|
||||
(setf (layout-node-x (select-layout-node sel)) 2)
|
||||
(setf (layout-node-y (select-layout-node sel)) 8)
|
||||
(setf (layout-node-width (select-layout-node sel)) 56)
|
||||
(setf (layout-node-height (select-layout-node sel)) 3)
|
||||
(render sel fb))
|
||||
|
||||
;;
|
||||
;; Verifications
|
||||
;;
|
||||
(is-true (fb-contains fb "Dashboard") "box title appears")
|
||||
(is-true (fb-contains fb "Welcome") "text content appears")
|
||||
;; Check TextInput value at its position
|
||||
(is (equal "search query" (fb-string fb 2 6 12)) "TextInput value at row 6")
|
||||
;; Check Select options at their positions
|
||||
(is-true (fb-contains fb "Option A") "Select option A appears")
|
||||
(is-true (fb-contains fb "Option B") "Select option B appears")
|
||||
(is-true (fb-contains fb "Option C") "Select option C appears")))
|
||||
#+END_SRC
|
||||
File diff suppressed because it is too large
Load Diff
1475
org/markdown-renderer.org
Normal file
1475
org/markdown-renderer.org
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
186
org/package.org
Normal file
186
org/package.org
Normal file
@@ -0,0 +1,186 @@
|
||||
#+TITLE: Base Component Package
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:components:
|
||||
|
||||
* Overview
|
||||
|
||||
The ~cl-tty.box~ package is the central namespace for the component
|
||||
system. It aggregates all component-related symbols — box, text,
|
||||
dirty tracking, render dispatch, theme engine — under one package.
|
||||
|
||||
Why ~box~ as the package name? Historically the package was created
|
||||
for the ~box~ and ~text~ renderables, and the name stuck as the
|
||||
package grew to encompass the entire component layer. The package
|
||||
~:use~s ~cl-tty.backend~ (for drawing primitives) and ~cl-tty.layout~
|
||||
(for layout nodes). All component code lives in this package.
|
||||
|
||||
This org file is documentation-only: it explains the package design
|
||||
but the code itself is just a ~defpackage~ form.
|
||||
|
||||
* Contract
|
||||
|
||||
The ~cl-tty.box~ package exports these symbol groups:
|
||||
|
||||
- Box: ~box~, ~make-box~, ~render-box~, border style/title accessors
|
||||
- Span: ~span~, span attribute readers
|
||||
- Text: ~text~, ~make-text~, ~render-text~, text accessors
|
||||
- Dirty: ~dirty-mixin~, ~dirty-p~, ~mark-clean~, ~mark-dirty~
|
||||
- Render: ~render~, ~render-screen~, ~render-node~, tree navigation
|
||||
- Theme: ~theme~, ~make-theme~, ~theme-color~, ~load-preset~,
|
||||
~define-preset~
|
||||
|
||||
* Implementation
|
||||
|
||||
~cl-tty.box~ uses ~cl-tty.backend~ for ~draw-text~, ~draw-border~,
|
||||
etc., and ~cl-tty.layout~ for ~layout-node~, ~compute-layout~, and the
|
||||
~vbox~/~hbox~ macros.
|
||||
|
||||
The only direct dependencies are these two packages — no other
|
||||
application code is needed to define components.
|
||||
|
||||
** Box exports
|
||||
|
||||
The ~box~ class is the primary rectangular container: it renders a
|
||||
bordered region with optional title and background color. The accessor
|
||||
family (~box-border-style~, ~box-title~, ~box-title-align~,
|
||||
~box-fg~, ~box-bg~) follows a consistent naming convention so that
|
||||
users can infer slot names from the class name. ~render-box~ is the
|
||||
specialized method that draws the border and fills the interior.
|
||||
|
||||
The ~box-layout-node~ accessor connects the box to its layout tree
|
||||
node, which is essential for the render pipeline's coordinate
|
||||
computation. We export it separately from the rendering symbols
|
||||
because it is also needed by code that walks the component tree
|
||||
without triggering a full render.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
(defpackage :cl-tty.box
|
||||
(:use :cl :cl-tty.backend :cl-tty.layout)
|
||||
(:export
|
||||
;; Box
|
||||
#:box #:make-box
|
||||
#:box-layout-node
|
||||
#:box-border-style #:box-title #:box-title-align
|
||||
#:box-fg #:box-bg
|
||||
#:render-box
|
||||
#+END_SRC
|
||||
|
||||
** Span exports
|
||||
|
||||
Spans are lightweight inline-style records — not full classes with
|
||||
layout. Each span stores a substring of the parent text along with
|
||||
its visual attributes. The reader-named accessors (~span-text~,
|
||||
~span-bold~, ~span-italic~, etc.) let rendering code inspect span
|
||||
properties without pulling in the internal representation. We keep
|
||||
the accessor list flat (no grouping macro) to make the package
|
||||
surface easy to grep and to keep the API browser-friendly.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Span
|
||||
#:span
|
||||
#:span-text #:span-bold #:span-italic #:span-underline
|
||||
#:span-reverse #:span-dim #:span-fg #:span-bg
|
||||
#+END_SRC
|
||||
|
||||
** Text exports
|
||||
|
||||
~text~ and ~make-text~ are the construction interface for the text
|
||||
renderable. The ~text-layout-node~ accessor follows the same pattern
|
||||
as ~box-layout-node~, bridging the component and layout layers.
|
||||
~text-content~ and ~text-spans~ expose the raw data for rendering;
|
||||
~text-fg~, ~text-bg~, and ~text-wrap-mode~ control global text
|
||||
appearance. ~render-text~ is the CLOS method that walks the span list
|
||||
and calls ~draw-text~ from the backend.
|
||||
|
||||
These symbols live in the ~cl-tty.box~ package rather than a
|
||||
separate ~cl-tty.text~ package to keep inter-component references
|
||||
trivial — boxes can hold text children, and text can be nested inside
|
||||
other components, all without cross-package imports.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Text
|
||||
#:text #:make-text
|
||||
#:text-layout-node #:text-content #:text-spans
|
||||
#:text-fg #:text-bg #:text-wrap-mode
|
||||
#:render-text
|
||||
#+END_SRC
|
||||
|
||||
** Utility exports (for tests)
|
||||
|
||||
~word-wrap~ and ~split-string~ are internal text-processing utilities
|
||||
used by the text renderer to break lines and tokenize input. They are
|
||||
exported specifically so the test suite can unit-test them in
|
||||
isolation. They are not part of the public component API and should
|
||||
not be relied upon by application code outside of tests.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Utilities (for tests)
|
||||
#:word-wrap #:split-string #:char-width
|
||||
#+END_SRC
|
||||
|
||||
** Dirty tracking
|
||||
|
||||
The dirty-mixin protocol lets any component class participate in the
|
||||
change-propagation system. ~dirty-mixin~ is the mixin class, and
|
||||
~dirty-p~, ~mark-clean~, ~mark-dirty~ are the three operations that
|
||||
the render pipeline calls to decide whether a subtree needs
|
||||
re-rendering.
|
||||
|
||||
Having these as generic functions (rather than a single ~(setf
|
||||
dirty-p)~) makes it easy for subclasses to add side effects on dirty
|
||||
transitions — for example, invalidating a cached bitmap or
|
||||
recomputing string metrics.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Dirty tracking
|
||||
#:dirty-mixin #:dirty-p #:mark-clean #:mark-dirty
|
||||
#+END_SRC
|
||||
|
||||
** Rendering pipeline
|
||||
|
||||
~render~, ~render-screen~, and ~render-node~ are the three entry
|
||||
points into the rendering dispatch. ~component-layout-node~,
|
||||
~component-children~, and ~component-parent~ form the tree-navigation
|
||||
interface that ~render-node~ uses to walk the component hierarchy.
|
||||
~available-width~ and ~available-height~ are passed down the tree to
|
||||
constrain layout. ~propagate-dirty~ walks upward from a changed
|
||||
component to mark ancestors as dirty, ensuring the screen is
|
||||
re-drawn from the correct root.
|
||||
|
||||
Collecting these under a single "Rendering pipeline" group signals to
|
||||
readers that they form a coherent subsystem — if you override one,
|
||||
you likely need to understand all of them.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Rendering pipeline
|
||||
#:render #:render-screen #:render-node
|
||||
#:component-layout-node #:component-children #:component-parent
|
||||
#:available-width #:available-height
|
||||
#:propagate-dirty
|
||||
#+END_SRC
|
||||
|
||||
** Theme engine
|
||||
|
||||
~theme~ and ~make-theme~ are the constructor and class for theme
|
||||
objects. ~theme-mode~ selects the active color mode (light/dark).
|
||||
~theme-color~ looks up a named color in the current theme.
|
||||
~load-preset~ loads a theme from a file, and ~define-preset~ registers
|
||||
a preset at compile time.
|
||||
|
||||
The theme engine is isolated from the rest of the component layer —
|
||||
boxes and text reference theme colors by name at render time, and the
|
||||
theme object is passed in from the application level. This separation
|
||||
means themes can be swapped without touching component instances.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/package.lisp
|
||||
;; Container components (merged from cl-tty.container)
|
||||
#:scroll-box #:make-scroll-box
|
||||
#:scroll-box-scroll-y #:scroll-box-scroll-x
|
||||
#:scroll-box-children
|
||||
#:scroll-by #:sticky-scroll-p
|
||||
#:clamp-scroll
|
||||
#:tab-bar #:make-tab-bar
|
||||
#:tab-bar-active #:tab-bar-tabs
|
||||
#:tab-bar-add #:tab-bar-next #:tab-bar-prev
|
||||
#:tab-bar-select #:tab-bar-handle-key))
|
||||
#+END_SRC
|
||||
403
org/render.org
Normal file
403
org/render.org
Normal file
@@ -0,0 +1,403 @@
|
||||
#+TITLE: Render Dispatch and Pipeline
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:components:
|
||||
|
||||
* Overview
|
||||
|
||||
The render module provides the generic function dispatch that connects
|
||||
the component tree to the backend. Every component type defines its own
|
||||
~render~ method; this module defines the common protocol and the
|
||||
top-level orchestration functions.
|
||||
|
||||
Three responsibilities live here:
|
||||
|
||||
1. **Component protocol** — generic functions for navigating the
|
||||
component tree (~component-children~, ~component-parent~,
|
||||
~component-layout-node~)
|
||||
|
||||
2. **Render pipeline** — ~render-screen~ ties layout computation to
|
||||
rendering, using the backend's actual terminal dimensions rather
|
||||
than hardcoded values. ~render-node~ walks the tree.
|
||||
|
||||
3. **Dirty propagation** — ~propagate-dirty~ marks a component and all
|
||||
its ancestors for re-render. This is what makes the incremental
|
||||
pipeline efficient: only changed branches get re-processed.
|
||||
|
||||
* Contract
|
||||
|
||||
** ~component-layout-node component~ → layout-node or nil
|
||||
|
||||
Return the layout node associated with ~component~. Specialized per
|
||||
component type (~box~, ~text~).
|
||||
|
||||
** ~component-children component~ → list or nil
|
||||
|
||||
Return child components. Default method returns ~nil~ (leaf components).
|
||||
|
||||
** ~component-parent component~ → component or nil
|
||||
|
||||
Return the parent component. Default method returns ~nil~.
|
||||
|
||||
** ~render component backend~
|
||||
|
||||
Render ~component~ at its computed position using ~backend~. Default
|
||||
method is a no-op. Specialized per component type.
|
||||
|
||||
** ~render-screen root backend~
|
||||
|
||||
Full render pipeline: query backend size, compute layout, render tree,
|
||||
wrapped in DECICM sync (~begin-sync~/~end-sync~).
|
||||
|
||||
** ~render-node node backend~
|
||||
|
||||
Render ~node~ and all descendants recursively. ~render-screen~ calls
|
||||
this once layout is computed.
|
||||
|
||||
** ~available-width / available-height component~ → integer
|
||||
|
||||
Return the computed width/height from the component's layout node, or
|
||||
80/24 as fallback.
|
||||
|
||||
** ~propagate-dirty component~
|
||||
|
||||
Mark ~component~ and every ancestor dirty. Walks up via
|
||||
~component-parent~.
|
||||
|
||||
* Tests
|
||||
|
||||
** Test helper: make-capturing-backend
|
||||
|
||||
Before any render test can run, we need a backend that captures output
|
||||
to a string stream instead of writing to the real terminal. This helper
|
||||
creates a ~modern-backend~ with a ~string-output-stream~ and returns
|
||||
both, so tests can inspect what was rendered.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(in-package :cl-tty-box-test)
|
||||
(in-suite box-suite)
|
||||
|
||||
(defun make-capturing-backend ()
|
||||
(let* ((s (make-string-output-stream))
|
||||
(b (make-modern-backend :output-stream s)))
|
||||
(values b s)))
|
||||
#+END_SRC
|
||||
|
||||
** Test: render dispatches to box method
|
||||
|
||||
Verifies that calling ~render~ on a ~box~ instance invokes the box
|
||||
rendering path, which draws border characters (e.g. ┌). This confirms
|
||||
generic dispatch works for the box type and that the border rendering
|
||||
pipeline is intact. A regression here would mean ~render-box~ is not
|
||||
being called or produces no output.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test render-generic-dispatches-box
|
||||
"render dispatches to render-box for box instances"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 10 :height 5)))
|
||||
(compute-layout (box-layout-node bx) 10 5)
|
||||
(render bx b)
|
||||
(is (search "┌" (get-output-stream-string s)) "box renders border"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: render dispatches to text method
|
||||
|
||||
Verifies that calling ~render~ on a ~text~ instance invokes the text
|
||||
rendering path, which outputs the string content. This confirms generic
|
||||
dispatch works for the text type and that text content is correctly
|
||||
emitted to the backend. A regression would mean ~render-text~ is not
|
||||
being called.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test render-generic-dispatches-text
|
||||
"render dispatches to render-text for text instances"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello" :width 10 :height 1)))
|
||||
(compute-layout (text-layout-node tx) 10 1)
|
||||
(render tx b)
|
||||
(is (search "Hello" (get-output-stream-string s)) "text renders content"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: component-layout-node returns layout-node
|
||||
|
||||
The ~component-layout-node~ generic is the bridge between the component
|
||||
layer and the layout layer. Every renderable component must have an
|
||||
associated layout node. This test confirms that both ~box~ and ~text~
|
||||
return a ~layout-node~ instance from their ~component-layout-node~
|
||||
method. A failure here means a component type is missing its method or
|
||||
the slot accessor is wrong.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test component-layout-node-works
|
||||
"component-layout-node returns the right slot for each type"
|
||||
(let ((bx (make-box)) (tx (make-text "")))
|
||||
(is (typep (component-layout-node bx) 'layout-node))
|
||||
(is (typep (component-layout-node tx) 'layout-node))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: component-children returns nil for leaves
|
||||
|
||||
Leaf components (~box~, ~text~) have no children by definition. The
|
||||
default method on ~t~ returns ~nil~. This test ensures that neither box
|
||||
nor text accidentally inherits or defines a method that returns
|
||||
non-nil, which would break the tree-walk in ~render-node~ by causing
|
||||
infinite recursion or rendering phantom children.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test component-children-returns-nil
|
||||
"Leaf components have no children"
|
||||
(let ((bx (make-box)) (tx (make-text "")))
|
||||
(is (null (component-children bx)))
|
||||
(is (null (component-children tx)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: propagate-dirty marks component dirty
|
||||
|
||||
~propagate-dirty~ is the entry point for the incremental rendering
|
||||
pipeline. When a component changes (e.g. a keystroke in a text input),
|
||||
it calls ~propagate-dirty~ to ensure the frame is re-rendered. This
|
||||
test verifies that calling ~propagate-dirty~ on a clean component sets
|
||||
it dirty. Without this, components that mutate would never trigger a
|
||||
re-render and the display would become stale.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test propagate-dirty-marks-component
|
||||
"propagate-dirty marks the component dirty"
|
||||
(let ((c (make-box)))
|
||||
(mark-clean c)
|
||||
(is-false (dirty-p c) "should be clean after mark-clean")
|
||||
(propagate-dirty c)
|
||||
(is-true (dirty-p c) "should be dirty after propagate-dirty")))
|
||||
#+END_SRC
|
||||
|
||||
** Test: available-width defaults
|
||||
|
||||
~available-width~ reads the computed width from the component's layout
|
||||
node. When a component hasn't been laid out (no explicit width set),
|
||||
the layout node's width defaults to 0. This test verifies that
|
||||
~available-width~ returns 0 for a freshly created box without layout
|
||||
computation. This matters because container components use
|
||||
~available-width~ to position children — getting a sensible default
|
||||
prevents division-by-zero or garbled layouts during initialization.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render-tests.lisp
|
||||
(test available-width-defaults
|
||||
"available-width returns 0 for components without explicit width"
|
||||
(let ((c (make-box)))
|
||||
(is (= (available-width c) 0))))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
** Component protocol
|
||||
|
||||
These three generic functions form the tree navigation API. They're
|
||||
separated from ~render~ because layout and dirty propagation also
|
||||
need to traverse the tree.
|
||||
|
||||
*** component-layout-node
|
||||
|
||||
The ~component-layout-node~ generic returns the ~layout-node~ instance
|
||||
for a given component. Every component that participates in layout and
|
||||
rendering must have a layout node — it stores the computed position and
|
||||
size after layout passes. The generic is defined with two specific
|
||||
methods for the built-in component types.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(in-package :cl-tty.box)
|
||||
|
||||
;; ── Component Protocol ────────────────────────────────────────
|
||||
|
||||
(defgeneric component-layout-node (component)
|
||||
(:documentation "Return the layout-node for COMPONENT."))
|
||||
#+END_SRC
|
||||
|
||||
Each component type returns its internal layout node slot. This method
|
||||
specializes on ~box~ and returns the ~box-layout-node~ slot value.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defmethod component-layout-node ((bx box))
|
||||
(box-layout-node bx))
|
||||
#+END_SRC
|
||||
|
||||
The ~text~ component stores its layout node in the ~text-layout-node~
|
||||
slot. Both methods return the same type (~layout-node~), so the layout
|
||||
engine can operate uniformly regardless of component type.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defmethod component-layout-node ((tx text))
|
||||
(text-layout-node tx))
|
||||
#+END_SRC
|
||||
|
||||
*** component-children
|
||||
|
||||
Leaf components (~box~, ~text~) have no children. Container components
|
||||
(~scrollbox~, ~tabbar~) override this to return their child list. The
|
||||
default method on ~t~ returns ~nil~, so new component types are
|
||||
automatically treated as leaves unless they explicitly override.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defgeneric component-children (component)
|
||||
(:documentation "Return the children of COMPONENT, or nil.")
|
||||
(:method ((c t)) nil))
|
||||
#+END_SRC
|
||||
|
||||
*** component-parent
|
||||
|
||||
Parent links are set by the container when adding children. They're
|
||||
used by ~propagate-dirty~ to walk up the tree. The default method on
|
||||
~t~ returns ~nil~, which acts as the termination condition for the
|
||||
recursive dirty walk — when ~component-parent~ returns ~nil~, we've
|
||||
reached the root.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defgeneric component-parent (component)
|
||||
(:documentation "Return the parent of COMPONENT, or nil.")
|
||||
(:method ((c t)) nil))
|
||||
#+END_SRC
|
||||
|
||||
** Render dispatch
|
||||
|
||||
*** render generic
|
||||
|
||||
The ~render~ generic is the central dispatch point for the rendering
|
||||
pipeline. Every component type that can be drawn defines a method on
|
||||
~render~. The default method on ~t~ is a no-op so that non-renderable
|
||||
objects (or components still under development) don't cause errors
|
||||
when the tree walk reaches them.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
;; ── Rendering Pipeline ────────────────────────────────────────
|
||||
|
||||
(defgeneric render (component backend)
|
||||
(:documentation "Render COMPONENT at its computed position using BACKEND.")
|
||||
(:method ((c t) backend)
|
||||
(declare (ignore backend))
|
||||
(values)))
|
||||
#+END_SRC
|
||||
|
||||
*** render method for box
|
||||
|
||||
Boxes are rendered with border characters. The ~render~ method
|
||||
delegates to the ~render-box~ function defined in ~box.lisp~, which
|
||||
handles the actual drawing of border lines and corners.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defmethod render ((bx box) backend)
|
||||
(render-box bx backend))
|
||||
#+END_SRC
|
||||
|
||||
*** render method for text
|
||||
|
||||
Text components render their content string at the computed position.
|
||||
The ~render~ method delegates to ~render-text~ from ~text.lisp~, which
|
||||
writes the string with appropriate escape sequences for positioning.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defmethod render ((tx text) backend)
|
||||
(render-text tx backend))
|
||||
#+END_SRC
|
||||
|
||||
** Screen-level orchestration
|
||||
|
||||
*** render-screen
|
||||
|
||||
~render-screen~ is the entry point for rendering a full frame. It
|
||||
queries the terminal size at render time (not at startup), so the
|
||||
layout adapts to window resizes automatically. The DECICM sync pair
|
||||
(~begin-sync~/~end-sync~) wraps the entire frame in a synchronized
|
||||
update: the terminal buffers all escape sequences and flushes them
|
||||
atomically, preventing partial-frame flicker.
|
||||
|
||||
The pipeline is: (1) query backend pixel/dimension size, (2) begin
|
||||
sync, (3) compute layout at the root, (4) walk the tree rendering each
|
||||
node, (5) end sync.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defun render-screen (root backend)
|
||||
"Render the component tree ROOT using BACKEND.
|
||||
Computes layout at the root level, then traverses children
|
||||
rendering each at their pre-computed positions. Uses the actual
|
||||
terminal dimensions from BACKEND rather than hardcoded defaults."
|
||||
(multiple-value-bind (w h) (backend-size backend)
|
||||
(begin-sync backend)
|
||||
(compute-layout (component-layout-node root) w h)
|
||||
(render-node root backend)
|
||||
(end-sync backend)))
|
||||
#+END_SRC
|
||||
|
||||
*** render-node
|
||||
|
||||
Tree walk: render this node, then recurse into children. The layout was
|
||||
already computed by ~render-screen~, so each node's position and size
|
||||
are available from its ~layout-node~. The recursion is depth-first:
|
||||
parents are drawn before children, which matters for z-ordering (the
|
||||
parent's background is drawn first, children overlay on top).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defun render-node (node backend)
|
||||
"Render a component NODE and its children.
|
||||
Layout is computed once at the root by render-screen, so children
|
||||
just render at their pre-computed positions."
|
||||
(render node backend)
|
||||
(dolist (child (component-children node))
|
||||
(render-node child backend)))
|
||||
#+END_SRC
|
||||
|
||||
** Utility accessors
|
||||
|
||||
*** available-width
|
||||
|
||||
Returns the computed width from the component's layout node. The layout
|
||||
node's width is set by ~compute-layout~ during ~render-screen~, so this
|
||||
reflects the actual allocated space — not the requested width. The
|
||||
fallback of 80 matches the default terminal width when no layout node
|
||||
exists (during initialization or testing without a backend).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defun available-width (component)
|
||||
"Return the available width for COMPONENT (or 80 as default)."
|
||||
(let ((ln (component-layout-node component)))
|
||||
(if ln (layout-node-width ln) 80)))
|
||||
#+END_SRC
|
||||
|
||||
*** available-height
|
||||
|
||||
Returns the computed height from the component's layout node. Like
|
||||
~available-width~, this reflects post-layout allocated space. The
|
||||
fallback of 24 matches the default terminal height. These accessors
|
||||
provide a clean API for components that need to know their allocated
|
||||
space during rendering, avoiding direct access to layout nodes.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
(defun available-height (component)
|
||||
"Return the available height for COMPONENT (or 24 as default)."
|
||||
(let ((ln (component-layout-node component)))
|
||||
(if ln (layout-node-height ln) 24)))
|
||||
#+END_SRC
|
||||
|
||||
** Dirty propagation
|
||||
|
||||
*** propagate-dirty
|
||||
|
||||
Recursive walk up the parent chain. When a text input receives a
|
||||
keystroke, it marks itself dirty, then its parent scrollbox, then the
|
||||
containing box, then the root — triggering recomputation and
|
||||
re-rendering of everything that might have changed.
|
||||
|
||||
This is the key to incremental rendering: only dirty branches are
|
||||
re-processed. The ~render~ methods check ~dirty-p~ early and return
|
||||
immediately for clean components (handled in each component's render,
|
||||
not here). The recursion terminates when ~component-parent~ returns
|
||||
~nil~ (the root component has no parent).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/render.lisp
|
||||
;; ── Dirty Propagation ─────────────────────────────────────────
|
||||
|
||||
(defun propagate-dirty (component)
|
||||
"Mark COMPONENT and all ancestors dirty."
|
||||
(mark-dirty component)
|
||||
(let ((parent (component-parent component)))
|
||||
(when parent
|
||||
(propagate-dirty parent))))
|
||||
#+END_SRC
|
||||
581
org/scrollbox.org
Normal file
581
org/scrollbox.org
Normal file
@@ -0,0 +1,581 @@
|
||||
#+TITLE: ScrollBox
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:container:
|
||||
|
||||
* Overview
|
||||
|
||||
ScrollBox is a container component that handles content larger than the
|
||||
viewport. It provides scroll offsets, viewport culling (only renders
|
||||
visible children), scrollbar rendering, and sticky-scroll (auto-scroll
|
||||
to bottom when new content arrives).
|
||||
|
||||
~scroll-box~ inherits ~dirty-mixin~ and implements the component protocol
|
||||
(~render~, ~component-children~, ~component-layout-node~) so it works
|
||||
with the rendering pipeline and layout engine.
|
||||
|
||||
** Contract
|
||||
|
||||
~(scroll-box &key scroll-y scroll-x width height children)~ → scroll-box
|
||||
Create a ScrollBox container. CHILDREN is a list of components.
|
||||
~scroll-y~ and ~scroll-x~ are the scroll offsets in lines.
|
||||
|
||||
~(scroll-box-children sb)~ → list of child components
|
||||
~(scroll-box-scroll-y sb)~ / ~(setf scroll-box-scroll-y)~
|
||||
~(scroll-box-scroll-x sb)~ / ~(setf scroll-box-scroll-x)~
|
||||
|
||||
~(render ((sb scroll-box) backend))~ — renders visible children with
|
||||
scroll offset applied, then draws scrollbars if content overflows.
|
||||
|
||||
~(scroll-by sb dy dx)~ — adjust scroll offset by DY rows, DX columns.
|
||||
Clamps to valid range (0 to content-size minus viewport-size).
|
||||
|
||||
~(sticky-scroll-p sb)~ / ~(setf sticky-scroll-p)~ — when T, auto-scroll
|
||||
to bottom when new content arrives.
|
||||
|
||||
* Implementation
|
||||
|
||||
** ScrollBox class
|
||||
|
||||
~scroll-box~ inherits from ~dirty-mixin~ for dirty tracking. It holds a
|
||||
list of child components and two scroll offset slots (~scroll-y~ and
|
||||
~scroll-x~). The ~sticky-scroll-p~ flag, when true, keeps the scroll
|
||||
position at the bottom whenever new children are added.
|
||||
|
||||
Defining this as a class (rather than a struct) lets us integrate with
|
||||
the CLOS-based component protocol — ~render~ dispatches on the class,
|
||||
and dirty-mixin provides the marking machinery used by the refresh loop.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(in-package :cl-tty.box)
|
||||
|
||||
(defclass scroll-box (dirty-mixin)
|
||||
((children :initform nil :initarg :children
|
||||
:accessor scroll-box-children :type list)
|
||||
(scroll-y :initform 0 :initarg :scroll-y
|
||||
:accessor scroll-box-scroll-y :type fixnum)
|
||||
(scroll-x :initform 0 :initarg :scroll-x
|
||||
:accessor scroll-box-scroll-x :type fixnum)
|
||||
(sticky-scroll-p :initform t :initarg :sticky-scroll-p
|
||||
:accessor sticky-scroll-p :type boolean)
|
||||
(layout-node :initform (make-layout-node) :accessor scroll-box-layout-node)))
|
||||
#+END_SRC
|
||||
|
||||
** make-scroll-box constructor
|
||||
|
||||
A dedicated constructor function provides keyword argument defaults and
|
||||
ensures ~sticky-scroll-p~ defaults to T even when the caller omits it
|
||||
(the :initform on the slot handles default-initialization, but a nil
|
||||
value explicitly passed as ~:sticky-scroll-p nil~ needs to be
|
||||
preserved). Using a function instead of making the user call
|
||||
~make-instance~ directly keeps the API ergonomic and hides CLOS plumbing.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun make-scroll-box (&key (children nil) (scroll-y 0) (scroll-x 0)
|
||||
sticky-scroll-p)
|
||||
(make-instance 'scroll-box
|
||||
:children children
|
||||
:scroll-y scroll-y
|
||||
:scroll-x scroll-x
|
||||
:sticky-scroll-p (if (null sticky-scroll-p) t sticky-scroll-p)))
|
||||
#+END_SRC
|
||||
|
||||
** component-children method
|
||||
|
||||
~component-children~ is part of the component protocol. The rendering
|
||||
pipeline calls this to discover the tree of children to render. By
|
||||
delegating to the ~scroll-box-children~ accessor, we keep the protocol
|
||||
implementation thin — just an indirection that makes ~scroll-box~
|
||||
participate polymorphically alongside other container types.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defmethod component-children ((sb scroll-box))
|
||||
(scroll-box-children sb))
|
||||
#+END_SRC
|
||||
|
||||
** component-layout-node method
|
||||
|
||||
~component-layout-node~ returns the layout node that the layout engine
|
||||
uses to position the ScrollBox itself within its parent. Each ScrollBox
|
||||
creates its own layout node at construction time via ~make-layout-node~,
|
||||
so this method simply returns that stored node.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defmethod component-layout-node ((sb scroll-box))
|
||||
(scroll-box-layout-node sb))
|
||||
#+END_SRC
|
||||
|
||||
** clamp-scroll helper
|
||||
|
||||
~clamp-scroll~ recalculates valid scroll bounds after content or viewport
|
||||
changes — called automatically when children change or the layout node
|
||||
resizes. It reads the viewport dimensions from the layout node and the
|
||||
content dimensions from the content-size helpers, then clamps both
|
||||
scroll offsets with ~max~/~min~ to ensure they never go below 0 or
|
||||
beyond the scrollable range.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun clamp-scroll (sb)
|
||||
"Clamp scroll offsets to valid range."
|
||||
(let* ((ln (scroll-box-layout-node sb))
|
||||
(viewport-height (if ln (layout-node-height ln) 0))
|
||||
(viewport-width (if ln (layout-node-width ln) 0))
|
||||
(content-height (scroll-box-content-height sb))
|
||||
(content-width (scroll-box-content-width sb)))
|
||||
(setf (scroll-box-scroll-y sb)
|
||||
(max 0 (min (scroll-box-scroll-y sb)
|
||||
(- content-height viewport-height))))
|
||||
(setf (scroll-box-scroll-x sb)
|
||||
(max 0 (min (scroll-box-scroll-x sb)
|
||||
(- content-width viewport-width))))))
|
||||
#+END_SRC
|
||||
|
||||
** scroll-by method
|
||||
|
||||
~scroll-by~ adjusts the scroll offset by delta rows and columns. It
|
||||
increments the current offset, clamps via ~clamp-scroll~, then marks
|
||||
the component dirty so the render loop picks up the change. This is
|
||||
the primary API entry point for programmatic scrolling (from keyboard
|
||||
input or mouse wheel events).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun scroll-by (sb dy dx)
|
||||
"Scroll by DY rows and DX columns. Clamps to valid range."
|
||||
(incf (scroll-box-scroll-y sb) dy)
|
||||
(incf (scroll-box-scroll-x sb) dx)
|
||||
(clamp-scroll sb)
|
||||
(mark-dirty sb))
|
||||
#+END_SRC
|
||||
|
||||
** scroll-box-content-height
|
||||
|
||||
~scroll-box-content-height~ calculates the total content height by
|
||||
summing all child heights. Each child reports its height through its
|
||||
layout node, with a minimum of 1 row (even zero-height children get a
|
||||
floor so they don't collapse the layout). This is used by
|
||||
~clamp-scroll~, scrollbar rendering, and sticky-scroll logic.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun scroll-box-content-height (sb)
|
||||
"Total height of all children."
|
||||
(reduce #'+ (scroll-box-children sb)
|
||||
:key (lambda (c)
|
||||
(let ((ln (component-layout-node c)))
|
||||
(if ln (max 1 (layout-node-height ln)) 1)))
|
||||
:initial-value 0))
|
||||
#+END_SRC
|
||||
|
||||
** scroll-box-content-width
|
||||
|
||||
~scroll-box-content-width~ calculates the maximum width among children,
|
||||
since horizontal scrolling follows the widest child rather than summing
|
||||
widths. Like the height counterpart, it floors child widths at 1 so
|
||||
empty children don't zero out the measurement.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun scroll-box-content-width (sb)
|
||||
"Maximum width among children."
|
||||
(reduce #'max (scroll-box-children sb)
|
||||
:key (lambda (c)
|
||||
(let ((ln (component-layout-node c)))
|
||||
(if ln (max 1 (layout-node-width ln)) 1)))
|
||||
:initial-value 0))
|
||||
#+END_SRC
|
||||
|
||||
** Render method with viewport culling
|
||||
|
||||
~render~ iterates children, computes each child's position within
|
||||
the viewport (adjusted for scroll offset), and only renders children
|
||||
whose visible area intersects the viewport. This is the core
|
||||
optimization — for a terminal with 200 children, only the ~24
|
||||
visible ones are actually drawn.
|
||||
|
||||
The method temporarily offsets each child's layout node by the scroll
|
||||
amount during rendering, then restores the original position via
|
||||
~unwind-protect~. This avoids mutating the permanent layout state while
|
||||
still making each child's ~render~ method draw at the correct scrolled
|
||||
position.
|
||||
|
||||
After child rendering, it delegates to ~draw-scrollbars~ for the
|
||||
scrollbar overlay.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defmethod render ((sb scroll-box) backend)
|
||||
"Render visible children with scroll offset applied.
|
||||
Delegates to each child's `render` method, temporarily offsetting
|
||||
its layout-node position for the scroll offset. Children outside
|
||||
the viewport are clipped out."
|
||||
(let* ((ln (scroll-box-layout-node sb))
|
||||
(vx 0) (vy 0)
|
||||
(vw (if ln (layout-node-width ln) 80))
|
||||
(vh (if ln (layout-node-height ln) 24))
|
||||
(sy (scroll-box-scroll-y sb))
|
||||
(sx (scroll-box-scroll-x sb)))
|
||||
(dolist (child (scroll-box-children sb))
|
||||
(let* ((cln (component-layout-node child))
|
||||
(ch (if cln (layout-node-height cln) 1))
|
||||
(cy vy))
|
||||
;; Only render children that are visible in the viewport
|
||||
(when (and (< (- cy sy) vh)
|
||||
(> (+ (- cy sy) ch) 0))
|
||||
;; Temporarily offset child's layout-node position for rendering
|
||||
(let ((orig-x (if cln (layout-node-x cln) 0))
|
||||
(orig-y (if cln (layout-node-y cln) 0)))
|
||||
(when cln
|
||||
(setf (layout-node-x cln) (- vx sx)
|
||||
(layout-node-y cln) (- vy sy)))
|
||||
(unwind-protect
|
||||
(render child backend)
|
||||
(when cln
|
||||
(setf (layout-node-x cln) orig-x
|
||||
(layout-node-y cln) orig-y)))))
|
||||
(incf vy ch)))
|
||||
(draw-scrollbars sb backend vw vh)))
|
||||
#+END_SRC
|
||||
|
||||
** update-sticky-scroll
|
||||
|
||||
~update-sticky-scroll~ checks whether the view is at the bottom and, if
|
||||
the ~sticky-scroll-p~ flag is set, auto-scrolls to keep the bottommost
|
||||
content visible. The comparison uses a 1-row tolerance (~(- content-h
|
||||
viewport-h 1)~) so minor content changes don't cause jitter. The sticky
|
||||
flag is reset to nil when the user manually scrolls up (handled by
|
||||
callers of ~scroll-by~).
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun update-sticky-scroll (sb)
|
||||
"If sticky-scroll-p is active and at bottom, keep at bottom."
|
||||
(when (sticky-scroll-p sb)
|
||||
(let* ((content-h (scroll-box-content-height sb))
|
||||
(ln (scroll-box-layout-node sb))
|
||||
(viewport-h (if ln (layout-node-height ln) 24)))
|
||||
(when (>= (scroll-box-scroll-y sb) (- content-h viewport-h 1))
|
||||
(setf (scroll-box-scroll-y sb)
|
||||
(max 0 (- content-h viewport-h)))))))
|
||||
#+END_SRC
|
||||
|
||||
** scrollbar-thumb helper
|
||||
|
||||
~scrollbar-thumb~ converts a raw scroll position (in lines) into a
|
||||
normalized 0.0-to-1.0 ratio representing where the thumb should appear
|
||||
on the scrollbar track. When content fits entirely within the viewport,
|
||||
it returns 0.0 (no scrolling possible). This normalized value is used
|
||||
by ~draw-scrollbars~ to compute the pixel/character position of the
|
||||
thumb.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun scrollbar-thumb (scroll-pos viewport-size content-size)
|
||||
"Return the thumb position for a scrollbar (0.0 to 1.0)."
|
||||
(if (> content-size viewport-size)
|
||||
(/ (float scroll-pos) (- content-size viewport-size))
|
||||
0.0))
|
||||
#+END_SRC
|
||||
|
||||
** draw-scrollbars
|
||||
|
||||
~draw-scrollbars~ renders vertical and horizontal scrollbars as
|
||||
single-character-wide bars on the right and bottom edges of the
|
||||
viewport. The scrollbar thumb position and size reflect the current
|
||||
scroll position relative to content size.
|
||||
|
||||
The vertical scrollbar uses a filled block (█) for the thumb and a
|
||||
background fill for the track. The horizontal scrollbar is drawn along
|
||||
the bottom edge. Both account for the scrollbox's own position within
|
||||
the layout tree (~ox~, ~oy~) so nested scrollboxes render scrollbars at
|
||||
the correct screen coordinates.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/scrollbox.lisp
|
||||
(defun draw-scrollbars (sb backend viewport-w viewport-h)
|
||||
"Draw scrollbars if content exceeds viewport."
|
||||
(let* ((content-h (scroll-box-content-height sb))
|
||||
(content-w (scroll-box-content-width sb))
|
||||
(sy (scroll-box-scroll-y sb))
|
||||
(sx (scroll-box-scroll-x sb))
|
||||
(ln (scroll-box-layout-node sb))
|
||||
(ox (if ln (layout-node-x ln) 0))
|
||||
(oy (if ln (layout-node-y ln) 0)))
|
||||
;; Vertical scrollbar
|
||||
(when (> content-h viewport-h)
|
||||
(let* ((thumb (scrollbar-thumb sy viewport-h content-h))
|
||||
(thumb-pos (round (* thumb viewport-h))))
|
||||
(draw-rect backend (+ ox (1- viewport-w)) oy 1 viewport-h :bg :scrollbar-bg)
|
||||
(draw-text backend (+ ox (1- viewport-w)) (+ oy thumb-pos) "█" nil nil)))
|
||||
;; Horizontal scrollbar
|
||||
(when (> content-w viewport-w)
|
||||
(let* ((thumb (scrollbar-thumb sx viewport-w content-w))
|
||||
(thumb-pos (round (* thumb viewport-w))))
|
||||
(draw-rect backend ox (+ oy (1- viewport-h)) viewport-w 1 :bg :scrollbar-bg)
|
||||
(draw-text backend (+ ox thumb-pos) (+ oy (1- viewport-h)) "█" nil nil)))))
|
||||
#+END_SRC
|
||||
|
||||
** Bug Fixes (v1.0.0): scroll offset and scrollbar position
|
||||
|
||||
Two bugs were fixed in the ScrollBox render pipeline:
|
||||
|
||||
1. *Render scroll origin*: The render method used ~orig-y~ (the child's original
|
||||
layout-node Y position, always 0 for top-level children) as the basis for
|
||||
scroll offset. This caused the content-relative position ~vy~ to be ignored,
|
||||
making scroll offsets incorrect when children were offset by layout.
|
||||
|
||||
Fix: Use ~vy~ (the content-relative Y accumulator) instead of ~orig-y~ when
|
||||
setting the temporary layout offset: ~(layout-node-y cln) (- vy sy)~.
|
||||
|
||||
2. *Scrollbar positions*: ~draw-scrollbars~ drew scrollbars at viewport-local
|
||||
coordinates (0, 0), not accounting for the scrollbox's own position within
|
||||
the layout tree. Scrollbars would appear at the wrong screen location when
|
||||
the scrollbox was nested inside other containers.
|
||||
|
||||
Fix: Read the scrollbox's layout-node origin ~(ox, oy)~ and offset all
|
||||
scrollbar drawing coordinates by those values.
|
||||
|
||||
* Tests
|
||||
|
||||
Test suite for both ScrollBox and TabBar.
|
||||
|
||||
** Package and test infrastructure
|
||||
|
||||
The tests use FiveAM, the Common Lisp testing framework. The package
|
||||
setup pulls in all the systems under test (~cl-tty.backend~,
|
||||
~cl-tty.box~, ~cl-tty.layout~, ~cl-tty.input~, ~cl-tty.container~)
|
||||
along with the base ~:cl~ language and ~:fiveam~ itself.
|
||||
|
||||
~run-tests~ is exported so the test runner script can call it
|
||||
unconditionally; it runs the ~scrollbox-suite~ and prints results via
|
||||
~fiveam:explain!~ before exiting.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(defpackage :cl-tty-scrollbox-test
|
||||
(:use :cl :fiveam :cl-tty.backend :cl-tty.box :cl-tty.layout :cl-tty.input)
|
||||
(:export #:run-tests))
|
||||
(in-package #:cl-tty-scrollbox-test)
|
||||
|
||||
(def-suite scrollbox-suite :description "ScrollBox + TabBar tests")
|
||||
(in-suite scrollbox-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'scrollbox-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox constructor test
|
||||
|
||||
Confirms a bare ~make-scroll-box~ returns a ~scroll-box~ instance with
|
||||
default scroll offsets of 0 and no children. This establishes that the
|
||||
class definition and constructor are wired up correctly.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-creates
|
||||
"A ScrollBox can be created with defaults."
|
||||
(let ((sb (make-scroll-box)))
|
||||
(is (typep sb 'scroll-box))
|
||||
(is (= (scroll-box-scroll-y sb) 0))
|
||||
(is (= (scroll-box-scroll-x sb) 0))
|
||||
(is-false (scroll-box-children sb))))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox with children test
|
||||
|
||||
Verifies that the ~:children~ initarg is accepted and that
|
||||
~scroll-box-children~ returns the list. A ScrollBox with one child
|
||||
should report length 1.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-with-children
|
||||
"A ScrollBox can have children."
|
||||
(let ((sb (make-scroll-box :children (list (make-text "hello")))))
|
||||
(is (= (length (scroll-box-children sb)) 1))))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox scroll-by test
|
||||
|
||||
Exercises ~scroll-by~ with a positive DY offset and asserts the
|
||||
scroll-y is non-negative after the operation. Combined with
|
||||
~scrollbox-scroll-clamp~ below, this covers both the normal and
|
||||
boundary behavior of the scroll mechanic.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-scroll-by
|
||||
"ScrollBy adjusts offset clamped to valid range."
|
||||
(let ((sb (make-scroll-box :scroll-y 0)))
|
||||
(scroll-by sb 5 0)
|
||||
(is (>= (scroll-box-scroll-y sb) 0))))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox component-children test
|
||||
|
||||
Confirms the component protocol method ~component-children~ returns the
|
||||
same child list that ~scroll-box-children~ does. This ensures the
|
||||
protocol indirection works and that the rendering pipeline will see the
|
||||
correct children.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-component-children
|
||||
"Component protocol: children are accessible."
|
||||
(let* ((child (make-text "hello"))
|
||||
(sb (make-scroll-box :children (list child))))
|
||||
(is (eql (first (component-children sb)) child))))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox render no-op test
|
||||
|
||||
Renders a ScrollBox with no children to a string-output-stream backend.
|
||||
The test passes if no errors are signaled — this guards against nil
|
||||
layout nodes or unbound slots causing problems during the render
|
||||
pipeline's initial traversal.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-render-noop
|
||||
"Rendering a ScrollBox with no children does not error."
|
||||
(let* ((stream (make-string-output-stream))
|
||||
(backend (make-simple-backend :output-stream stream))
|
||||
(sb (make-scroll-box)))
|
||||
(render sb backend)
|
||||
(is-true t)))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar constructor test
|
||||
|
||||
Confirms a bare ~make-tab-bar~ returns a ~tab-bar~ instance with no
|
||||
active tab and no tabs. This validates the TabBar class definition and
|
||||
constructor.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-creates
|
||||
"A TabBar can be created with defaults."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(is (typep tb 'tab-bar))
|
||||
(is-false (tab-bar-active tb))
|
||||
(is-false (tab-bar-tabs tb))))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar add-tab test
|
||||
|
||||
Tests that ~tab-bar-add~ returns the supplied ID, adds a tab to the
|
||||
internal list, and stores the title correctly. Each tab is stored as a
|
||||
plist, so the test checks both list length and the ~:title~ property.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-add-tab
|
||||
"Adding a tab returns the id and updates tabs."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(let ((id (tab-bar-add tb :tab1 "Tab One")))
|
||||
(is (eql id :tab1))
|
||||
(is (= (length (tab-bar-tabs tb)) 1))
|
||||
(is (string= (getf (first (tab-bar-tabs tb)) :title) "Tab One")))))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar active tab test
|
||||
|
||||
Verifies that ~(setf tab-bar-active)~ correctly selects a tab by ID and
|
||||
that ~tab-bar-active~ returns that ID afterward.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-active-tab
|
||||
"Setting active tab works."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(tab-bar-add tb :tab1 "One")
|
||||
(tab-bar-add tb :tab2 "Two")
|
||||
(setf (tab-bar-active tb) :tab2)
|
||||
(is (eql (tab-bar-active tb) :tab2))))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar render no-op test
|
||||
|
||||
Renders a fully configured TabBar (with tabs and an active selection) to
|
||||
a string-output-stream backend to confirm the render method doesn't
|
||||
error. A TabBar must draw its tab strip without crashing even when
|
||||
disconnected from a real terminal.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-render-noop
|
||||
"Rendering a TabBar does not error."
|
||||
(let* ((stream (make-string-output-stream))
|
||||
(backend (make-simple-backend :output-stream stream))
|
||||
(tb (make-tab-bar)))
|
||||
(tab-bar-add tb :tab1 "One")
|
||||
(tab-bar-add tb :tab2 "Two")
|
||||
(setf (tab-bar-active tb) :tab1)
|
||||
(render tb backend)
|
||||
(is-true t)))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar next/prev navigation test
|
||||
|
||||
Exercises the full navigation cycle: ~tab-bar-next~ advances through
|
||||
three tabs, wrapping around past the last; ~tab-bar-prev~ goes backward,
|
||||
wrapping around past the first. This is the core keyboard interaction
|
||||
for tabbed UIs and must handle edge cases (empty bar, single tab, etc.)
|
||||
gracefully.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-next-prev
|
||||
"TabBar next/prev wraps around through tabs."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(tab-bar-add tb :tab1 "One")
|
||||
(tab-bar-add tb :tab2 "Two")
|
||||
(tab-bar-add tb :tab3 "Three")
|
||||
(is (eql (tab-bar-active tb) :tab1))
|
||||
(tab-bar-next tb)
|
||||
(is (eql (tab-bar-active tb) :tab2))
|
||||
(tab-bar-next tb)
|
||||
(is (eql (tab-bar-active tb) :tab3))
|
||||
(tab-bar-next tb)
|
||||
(is (eql (tab-bar-active tb) :tab1) "wrap around past last")
|
||||
(tab-bar-prev tb)
|
||||
(is (eql (tab-bar-active tb) :tab3) "wrap around past first")))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar select test
|
||||
|
||||
~tab-bar-select~ activates a named tab directly (as opposed to relative
|
||||
next/prev navigation). This test verifies that selecting ~:tab2~ from a
|
||||
three-tab bar correctly sets the active tab.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-select
|
||||
"TabBar select activates the specified tab."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(tab-bar-add tb :tab1 "One")
|
||||
(tab-bar-add tb :tab2 "Two")
|
||||
(tab-bar-select tb :tab2)
|
||||
(is (eql (tab-bar-active tb) :tab2))))
|
||||
#+END_SRC
|
||||
|
||||
** TabBar key handling test
|
||||
|
||||
~tab-bar-handle-key~ maps keyboard events to navigation actions. A
|
||||
~:right~ key event should advance; a ~:left~ key event should retreat.
|
||||
This tests the bridge between the input event system and the TabBar
|
||||
navigation API.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test tabbar-handle-key
|
||||
"TabBar handle-key dispatches left/right."
|
||||
(let ((tb (make-tab-bar)))
|
||||
(tab-bar-add tb :tab1 "One")
|
||||
(tab-bar-add tb :tab2 "Two")
|
||||
(setf (tab-bar-active tb) :tab1)
|
||||
(tab-bar-handle-key tb (make-key-event :key :right))
|
||||
(is (eql (tab-bar-active tb) :tab2))
|
||||
(tab-bar-handle-key tb (make-key-event :key :left))
|
||||
(is (eql (tab-bar-active tb) :tab1))))
|
||||
#+END_SRC
|
||||
|
||||
** ScrollBox clamp boundary test
|
||||
|
||||
Directly tests ~clamp-scroll~ by setting scroll offsets to invalid
|
||||
values (negative and extremely large) and confirming they get clamped
|
||||
back to 0. With no children, content size is 0 so the max scroll is
|
||||
also 0 — this exercises the degenerate case.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/scrollbox-tabbar-tests.lisp
|
||||
(test scrollbox-scroll-clamp
|
||||
"ScrollBox clamp prevents scrolling past bounds."
|
||||
(let ((sb (make-scroll-box :scroll-y 5 :scroll-x 3)))
|
||||
(setf (scroll-box-scroll-y sb) -1)
|
||||
(clamp-scroll sb)
|
||||
(is (= (scroll-box-scroll-y sb) 0) "clamps below 0")
|
||||
(setf (scroll-box-scroll-y sb) 1000000)
|
||||
(clamp-scroll sb)
|
||||
(is (= (scroll-box-scroll-y sb) 0) "clamps above max (no children = 0 content)")))
|
||||
#+END_SRC
|
||||
308
org/slot.org
Normal file
308
org/slot.org
Normal file
@@ -0,0 +1,308 @@
|
||||
#+TITLE: Plugin / Slot System (v0.11.0)
|
||||
#+DATE: 2026-05-11
|
||||
#+AUTHOR: Amr Gharbeia / Hermes
|
||||
#+STARTUP: content
|
||||
|
||||
* Overview
|
||||
|
||||
Extensible named slots. Applications and plugins register content into
|
||||
named slots. The component tree renders whatever is registered.
|
||||
|
||||
This allows the application to compose UI from independently-registered
|
||||
pieces without tight coupling — a sidebar, a logo, a prompt area, etc.
|
||||
|
||||
** Contract
|
||||
|
||||
- ~defslot name &key order render-fn mode~ — register a render function for a slot
|
||||
- ~slot-render slot-name &rest args~ — call all registered render-fns, return combined output
|
||||
- ~slot-p slot-name~ — check if a slot has registrations
|
||||
- ~clear-slot slot-name~ — remove all registrations for a slot
|
||||
- ~list-slots~ — return all slot names with registrations
|
||||
|
||||
** Slot modes
|
||||
|
||||
- ~:stack~ (default) — render all registered functions in ~:order~ sequence.
|
||||
Each ~defslot~ adds to the list. ~slot-render~ calls every function and
|
||||
returns a list of results. Use this for composable slots where multiple
|
||||
plugins contribute content (e.g., toolbar buttons, status bar segments).
|
||||
|
||||
- ~:replace~ — last registration wins, previous ones are discarded.
|
||||
Each ~defslot~ replaces the slot's entire entry list with the new
|
||||
registration. ~slot-render~ calls only the most recently registered
|
||||
function. Use this for exclusive slots where only one renderer should
|
||||
be active at a time (e.g., main content area, active panel).
|
||||
|
||||
- ~:single-winner~ — first registration wins, subsequent ones are ignored.
|
||||
Once a slot has an entry, further ~defslot~ calls for the same slot are
|
||||
no-ops. ~slot-render~ calls only the first (lowest-order) registered
|
||||
function. Use this for slots where the first plugin to register should
|
||||
own the spot (e.g., logo area, command palette).
|
||||
|
||||
The mode is set on the first ~defslot~ call for a slot. Subsequent calls
|
||||
for the same slot ignore the ~:mode~ argument and use the established
|
||||
mode — this prevents confusion when multiple plugins register into the
|
||||
same slot with conflicting mode specifications.
|
||||
|
||||
* Implementation
|
||||
|
||||
** Package
|
||||
|
||||
The package provides the public API and exports all slot system symbols.
|
||||
Clients :use this package or refer to symbols qualified.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot-package.lisp
|
||||
(defpackage :cl-tty.slot
|
||||
(:use :cl)
|
||||
(:export
|
||||
#:defslot
|
||||
#:slot-render
|
||||
#:slot-p
|
||||
#:clear-slot
|
||||
#:list-slots
|
||||
#:*slots*))
|
||||
#+END_SRC
|
||||
|
||||
** Slot Storage: *slots*
|
||||
|
||||
The central registry is a hash table keyed by slot name (strings, for
|
||||
case-insensitive lookup via ~equal~). Each value is a plist:
|
||||
|
||||
- ~:mode~ — the slot's mode keyword (~:stack~, ~:replace~, ~:single-winner~)
|
||||
- ~:entries~ — list of ~(order . render-fn)~ cons cells, sorted by order
|
||||
|
||||
The ~:test #'equal~ ensures that ~:sidebar~ and ~"sidebar"~ map to the
|
||||
same key.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(in-package :cl-tty.slot)
|
||||
|
||||
(defvar *slots* (make-hash-table :test 'equal)
|
||||
"Hash table mapping slot name (string) -> plist of slot data.
|
||||
Each entry: (:mode <mode> :entries <(order . render-fn) list>).")
|
||||
#+END_SRC
|
||||
|
||||
** defslot: Register a Render Function
|
||||
|
||||
~defslot~ inserts a new ~(order . render-fn)~ entry into the slot's
|
||||
entry list. The behavior depends on the slot's mode, which is set on
|
||||
the first call and frozen for subsequent calls:
|
||||
|
||||
- ~:stack~ — merge into existing entries, sorted by order
|
||||
- ~:replace~ — clear all previous entries, keep only the new one
|
||||
- ~:single-winner~ — no-op if the slot already has entries
|
||||
|
||||
The ~render-fn~ itself is returned so callers can use it inline.
|
||||
|
||||
The mode parameter is validated on first call via ~assert~ and then
|
||||
frozen for subsequent calls. This prevents a later registration from
|
||||
changing the slot's semantics out from under earlier registrations.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(defun defslot (name &key (order 0) render-fn (mode :stack))
|
||||
(let* ((key (string name))
|
||||
(slot (gethash key *slots*)))
|
||||
(if (null slot)
|
||||
;; First registration — validate and set mode, create entry
|
||||
(progn
|
||||
(assert (member mode '(:stack :replace :single-winner)) ()
|
||||
"Invalid slot mode: ~S (use :stack, :replace, or :single-winner)"
|
||||
mode)
|
||||
(setf (gethash key *slots*)
|
||||
(list :mode mode
|
||||
:entries (list (cons order render-fn)))))
|
||||
;; Existing slot — respect frozen mode
|
||||
(let ((entries (getf slot :entries)))
|
||||
(ecase (getf slot :mode)
|
||||
(:stack
|
||||
(setf (getf slot :entries)
|
||||
(sort (cons (cons order render-fn) entries)
|
||||
#'< :key #'car)))
|
||||
(:replace
|
||||
(setf (getf slot :entries)
|
||||
(list (cons order render-fn))))
|
||||
(:single-winner
|
||||
;; First registration already present — no-op
|
||||
(values))))))
|
||||
render-fn)
|
||||
#+END_SRC
|
||||
|
||||
** slot-render: Invoke Render Functions Per Mode
|
||||
|
||||
~slot-render~ dispatches on the slot's mode:
|
||||
|
||||
- ~:stack~ — call every non-nil render function in order, return a list
|
||||
of results. This is the most flexible mode, supporting multiple
|
||||
contributors per slot.
|
||||
|
||||
- ~:replace~ — call only the single registered function (the last one
|
||||
registered, since :replace clears earlier entries). Returns a single
|
||||
value, not a list.
|
||||
|
||||
- ~:single-winner~ — call only the first registered function (lowest
|
||||
order). Subsequent registrations were silently dropped during defslot.
|
||||
|
||||
Returns ~nil~ if the slot has no registrations or if the handler is nil.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(defun slot-render (slot-name &rest args)
|
||||
(let ((slot (gethash (string slot-name) *slots*)))
|
||||
(when slot
|
||||
(let ((mode (getf slot :mode))
|
||||
(entries (getf slot :entries)))
|
||||
(ecase mode
|
||||
(:stack
|
||||
(mapcar (lambda (entry)
|
||||
(let ((fn (cdr entry)))
|
||||
(when fn (apply fn args))))
|
||||
entries))
|
||||
(:replace
|
||||
(let ((fn (cdar (last entries))))
|
||||
(when fn (apply fn args))))
|
||||
(:single-winner
|
||||
(let ((fn (cdar entries)))
|
||||
(when fn (apply fn args)))))))))
|
||||
#+END_SRC
|
||||
|
||||
** slot-p: Check Slot Existence
|
||||
|
||||
Uses ~nth-value 1~ of ~gethash~ which returns ~t~ if the key is
|
||||
present (even if the value is ~nil~) or ~nil~ if absent. This is the
|
||||
canonical Common Lisp idiom for testing hash-table membership.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(defun slot-p (slot-name)
|
||||
(nth-value 1 (gethash (string slot-name) *slots*)))
|
||||
#+END_SRC
|
||||
|
||||
** clear-slot: Remove All Registrations
|
||||
|
||||
Calls ~remhash~ to delete the slot's entry from the hash table
|
||||
entirely. After this call ~slot-p~ returns false and ~slot-render~
|
||||
returns nil for the given slot name.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(defun clear-slot (slot-name)
|
||||
(remhash (string slot-name) *slots*))
|
||||
#+END_SRC
|
||||
|
||||
** list-slots: Enumerate Registered Slots
|
||||
|
||||
Iterates over all hash keys in ~*slots*~ and returns them as a list.
|
||||
Only slots that have been registered (i.e. have at least one entry)
|
||||
appear in the result.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/slot.lisp
|
||||
(defun list-slots ()
|
||||
(loop for key being the hash-keys of *slots* collect key))
|
||||
#+END_SRC
|
||||
|
||||
** Tests
|
||||
|
||||
The test suite uses FiveAM and exercises each public function,
|
||||
including mode-specific behavior.
|
||||
|
||||
*** Test Package and Suite
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(defpackage :cl-tty-slot-test (:use :cl :cl-tty.slot :fiveam))
|
||||
(in-package :cl-tty-slot-test)
|
||||
|
||||
(def-suite slot-suite :description "Slot system tests")
|
||||
(in-suite slot-suite)
|
||||
#+END_SRC
|
||||
|
||||
*** defslot-register: Registering a slot makes it visible
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test defslot-register ()
|
||||
(clear-slot :test-slot)
|
||||
(defslot :test-slot :order 1 :render-fn (lambda () "hello"))
|
||||
(is-true (slot-p :test-slot)))
|
||||
#+END_SRC
|
||||
|
||||
*** slot-render-calls: Stack mode calls all functions in order
|
||||
|
||||
Verifies that ~:stack~ mode preserves multiple registrations and calls
|
||||
them in ascending order sequence.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test slot-render-calls ()
|
||||
(clear-slot :test-slot)
|
||||
(defslot :test-slot :order 1 :render-fn (lambda () "a"))
|
||||
(defslot :test-slot :order 2 :render-fn (lambda () "b"))
|
||||
(is (equal '("a" "b") (slot-render :test-slot))))
|
||||
#+END_SRC
|
||||
|
||||
*** slot-render-empty: Unregistered slot returns nil
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test slot-render-empty ()
|
||||
(clear-slot :ghost)
|
||||
(is-false (slot-render :ghost)))
|
||||
#+END_SRC
|
||||
|
||||
*** clear-slot-removes: Clearing a slot makes it absent
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test clear-slot-removes ()
|
||||
(clear-slot :test-slot)
|
||||
(defslot :test-slot :order 1 :render-fn (lambda () "x"))
|
||||
(clear-slot :test-slot)
|
||||
(is-false (slot-p :test-slot)))
|
||||
#+END_SRC
|
||||
|
||||
*** stack-mode-multiple-entries: Stack keeps all registrations
|
||||
|
||||
Verifies that ~:stack~ mode (default) accumulates entries across
|
||||
multiple ~defslot~ calls.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test stack-mode-multiple-entries ()
|
||||
(clear-slot :stack-test)
|
||||
(defslot :stack-test :order 1 :render-fn (lambda () "first"))
|
||||
(defslot :stack-test :order 2 :render-fn (lambda () "second"))
|
||||
(defslot :stack-test :order 3 :render-fn (lambda () "third"))
|
||||
(is (equal '("first" "second" "third") (slot-render :stack-test))))
|
||||
#+END_SRC
|
||||
|
||||
*** replace-mode-last-wins: Replace keeps only the last registration
|
||||
|
||||
Verifies that ~:replace~ mode discards previous entries on each new
|
||||
~defslot~ call.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test replace-mode-last-wins ()
|
||||
(clear-slot :replace-test)
|
||||
(defslot :replace-test :mode :replace :order 1 :render-fn (lambda () "old"))
|
||||
(defslot :replace-test :mode :replace :order 2 :render-fn (lambda () "new"))
|
||||
(is (equal "new" (slot-render :replace-test))))
|
||||
#+END_SRC
|
||||
|
||||
*** single-winner-mode-first-wins: Single-winner keeps only the first
|
||||
|
||||
Verifies that ~:single-winner~ mode ignores subsequent registrations.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test single-winner-mode-first-wins ()
|
||||
(clear-slot :winner-test)
|
||||
(defslot :winner-test :mode :single-winner :order 1
|
||||
:render-fn (lambda () "alpha"))
|
||||
(defslot :winner-test :mode :single-winner :order 2
|
||||
:render-fn (lambda () "beta"))
|
||||
(is (equal "alpha" (slot-render :winner-test))))
|
||||
#+END_SRC
|
||||
|
||||
*** clear-slot-removes-mode: Clearing resets mode, allowing new mode
|
||||
|
||||
Verifies that clearing a slot removes the mode lock, so a subsequent
|
||||
~defslot~ can set a new mode.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/tests/slot-tests.lisp
|
||||
(def-test clear-slot-removes-mode ()
|
||||
(clear-slot :mode-test)
|
||||
(defslot :mode-test :mode :replace :render-fn (lambda () "only"))
|
||||
(clear-slot :mode-test)
|
||||
(defslot :mode-test :mode :stack :render-fn (lambda () "fresh"))
|
||||
(is-true (slot-p :mode-test))
|
||||
(is (equal '("fresh") (slot-render :mode-test))))
|
||||
#+END_SRC
|
||||
219
org/tabbar.org
Normal file
219
org/tabbar.org
Normal file
@@ -0,0 +1,219 @@
|
||||
#+TITLE: TabBar
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:container:
|
||||
|
||||
* Overview
|
||||
|
||||
TabBar handles horizontal tab navigation with keyboard support.
|
||||
Tabs are rendered as labeled items; the active tab is highlighted.
|
||||
|
||||
~tab-bar~ inherits ~dirty-mixin~ and implements the component protocol
|
||||
(~render~, ~component-layout-node~) so it integrates with the rendering
|
||||
pipeline and layout engine.
|
||||
|
||||
** Contract
|
||||
|
||||
~(tab-bar &key tabs active-tab)~ → tab-bar
|
||||
TABS is a list of ~(id title)~ plists.
|
||||
|
||||
~(tab-bar-active tb)~ / ~(setf tab-bar-active)~ — currently active tab id.
|
||||
~(tab-bar-tabs tb)~ — list of tab plists.
|
||||
~(tab-bar-add tb id title)~ — add a tab. Returns the tab id.
|
||||
|
||||
~(render ((tb tab-bar) backend))~ — renders tab row, active tab
|
||||
highlighted, inactive tabs dimmed.
|
||||
|
||||
* Implementation
|
||||
|
||||
** Package declaration
|
||||
|
||||
All TabBar code lives in the ~cl-tty.container~ package alongside the
|
||||
other container components (scrollbox, box, slot, etc.). This keeps
|
||||
the symbol namespace clean and avoids accidental collisions with
|
||||
user-level code.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(in-package :cl-tty.box)
|
||||
#+END_SRC
|
||||
|
||||
** TabBar class
|
||||
|
||||
~tab-bar~ stores a list of tab plists ~((:id :tab1 :title "One") ...)~
|
||||
and the currently active tab id. It inherits from ~dirty-mixin~ so that
|
||||
any mutation (adding a tab, switching tabs) automatically marks the
|
||||
component for re-render. A layout node holds its geometry; the
|
||||
~focusable~ slot allows the keyboard navigation system to discover it.
|
||||
|
||||
The ~tabs~ slot is a simple plist list rather than a hash table or
|
||||
alist because the total number of tabs in a UI is typically small
|
||||
(< 20) and we need ordered iteration for rendering.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defclass tab-bar (dirty-mixin)
|
||||
((tabs :initform nil :initarg :tabs
|
||||
:accessor tab-bar-tabs :type list)
|
||||
(active :initform nil :initarg :active
|
||||
:accessor tab-bar-active)
|
||||
(layout-node :initform (make-layout-node) :accessor tab-bar-layout-node)
|
||||
(focusable :initform t :accessor tab-bar-focusable)))
|
||||
#+END_SRC
|
||||
|
||||
** make-tab-bar constructor
|
||||
|
||||
Convenience constructor that forwards keyword arguments to
|
||||
~make-instance~. Using a dedicated function instead of inlining
|
||||
~make-instance~ everywhere gives us a single place to add
|
||||
defaulting, validation, or initialization hooks in the future.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun make-tab-bar (&key tabs active)
|
||||
(make-instance 'tab-bar :tabs (or tabs nil) :active active))
|
||||
#+END_SRC
|
||||
|
||||
** tab-bar-add: adding tabs
|
||||
|
||||
~tab-bar-add~ appends a new tab plist to the end of the tab list.
|
||||
The callers supply both an ~id~ (for programmatic selection) and a
|
||||
~title~ (for display). If no tab is currently active, the newly added
|
||||
tab becomes active automatically — this ensures there is always a
|
||||
sensible default when the first tab is created. Returns the ~id~ so
|
||||
callers can chain or store it.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun tab-bar-add (tb id title)
|
||||
"Add a tab with ID and TITLE. Sets as active if first tab."
|
||||
(setf (tab-bar-tabs tb)
|
||||
(nconc (tab-bar-tabs tb) (list (list :id id :title title))))
|
||||
(unless (tab-bar-active tb)
|
||||
(setf (tab-bar-active tb) id))
|
||||
id)
|
||||
#+END_SRC
|
||||
|
||||
** component-layout-node protocol
|
||||
|
||||
Returns the layout node so the layout engine can position and size
|
||||
the tab bar within its parent. Every component that participates in
|
||||
automatic layout must implement this method.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defmethod component-layout-node ((tb tab-bar))
|
||||
(tab-bar-layout-node tb))
|
||||
#+END_SRC
|
||||
|
||||
** tab-bar-next: cycling forward
|
||||
|
||||
~tab-bar-next~ moves the active cursor to the next tab in the list,
|
||||
wrapping around from the last tab to the first (~mod~ arithmetic).
|
||||
It calls ~mark-dirty~ so the rendering pass picks up the change.
|
||||
|
||||
The lookup strategy — mapcar ids, position, mod — is O(n) but
|
||||
acceptable since tab lists are small. A hash-based index would be
|
||||
premature optimization at this scale.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun tab-bar-next (tb)
|
||||
"Move to next tab."
|
||||
(let* ((tabs (tab-bar-tabs tb))
|
||||
(current (tab-bar-active tb))
|
||||
(ids (mapcar (lambda (tab) (getf tab :id)) tabs))
|
||||
(pos (position current ids)))
|
||||
(when pos
|
||||
(let ((next (nth (mod (1+ pos) (length ids)) ids)))
|
||||
(setf (tab-bar-active tb) next)
|
||||
(mark-dirty tb)))))
|
||||
#+END_SRC
|
||||
|
||||
** tab-bar-prev: cycling backward
|
||||
|
||||
Mirror of ~tab-bar-next~; decrements the position index instead of
|
||||
incrementing it. ~mod~ handles negative wrap-around correctly in
|
||||
Common Lisp (returns a non-negative remainder), so ~(mod (1- 0) 3)~
|
||||
produces 2 rather than −1.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun tab-bar-prev (tb)
|
||||
"Move to previous tab."
|
||||
(let* ((tabs (tab-bar-tabs tb))
|
||||
(current (tab-bar-active tb))
|
||||
(ids (mapcar (lambda (tab) (getf tab :id)) tabs))
|
||||
(pos (position current ids)))
|
||||
(when pos
|
||||
(let ((prev (nth (mod (1- pos) (length ids)) ids)))
|
||||
(setf (tab-bar-active tb) prev)
|
||||
(mark-dirty tb)))))
|
||||
#+END_SRC
|
||||
|
||||
** tab-bar-select: direct tab selection
|
||||
|
||||
~tab-bar-select~ sets the active tab directly by id, bypassing the
|
||||
cyclic navigation. This is used when a user clicks a tab (via mouse
|
||||
binding), when a programmatic action needs to switch views, or when
|
||||
activating a tab from outside the keyboard flow. Always marks dirty.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun tab-bar-select (tb id)
|
||||
"Select a tab by ID."
|
||||
(setf (tab-bar-active tb) id)
|
||||
(mark-dirty tb))
|
||||
#+END_SRC
|
||||
|
||||
** tab-bar-handle-key: keyboard dispatch
|
||||
|
||||
Dispatches key events for tab navigation. Left arrow goes to the
|
||||
previous tab, right arrow to the next. Returns ~t~ when the key was
|
||||
consumed and ~nil~ otherwise, which lets the keybinding system fall
|
||||
through to other handlers — important for composable UIs where a tab
|
||||
bar lives alongside other focusable elements.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defun tab-bar-handle-key (tb event)
|
||||
"Handle a key-event on a TabBar. Returns T if handled."
|
||||
(case (cl-tty.input:key-event-key event)
|
||||
(:left (tab-bar-prev tb) t)
|
||||
(:right (tab-bar-next tb) t)
|
||||
(t nil)))
|
||||
#+END_SRC
|
||||
|
||||
** render: drawing the tab row
|
||||
|
||||
~render~ iterates the tab list and draws each one as ~[ Title ]~.
|
||||
The active tab uses the ~:accent~ foreground color and
|
||||
~:background-element~ background for visual prominence; inactive tabs
|
||||
are rendered in ~:text-muted~. Tabs are separated by two spaces.
|
||||
|
||||
Available width comes from the layout node. If the total tab width
|
||||
exceeds the available space, tabs are truncated and an ellipsis
|
||||
~...~ is drawn at the overflow point. This prevents the tab bar from
|
||||
breaking the layout on narrow terminals.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/tabbar.lisp
|
||||
(defmethod render ((tb tab-bar) backend)
|
||||
(let* ((ln (tab-bar-layout-node tb))
|
||||
(x (if ln (layout-node-x ln) 0))
|
||||
(y (if ln (layout-node-y ln) 0))
|
||||
(w (if ln (layout-node-width ln) 80))
|
||||
(active-id (tab-bar-active tb))
|
||||
(tabs (tab-bar-tabs tb))
|
||||
(x-pos x))
|
||||
(dolist (tab tabs)
|
||||
(let* ((id (getf tab :id))
|
||||
(title (getf tab :title))
|
||||
(label (format nil " ~A " title))
|
||||
(label-len (length label))
|
||||
(is-active (eql id active-id))
|
||||
(fg (if is-active :accent :text-muted))
|
||||
(bg (if is-active :background-element nil)))
|
||||
;; Check if tab fits
|
||||
(when (>= (+ x-pos label-len 2) (+ x w))
|
||||
(draw-text backend x-pos y "..." :text-muted nil)
|
||||
(return))
|
||||
;; Draw tab
|
||||
(draw-text backend x-pos y label fg bg)
|
||||
(incf x-pos (+ label-len 2))))
|
||||
(values)))
|
||||
#+END_SRC
|
||||
|
||||
* Tests
|
||||
|
||||
TabBar tests are part of the combined scrollbox-tabbar test suite
|
||||
defined in ~org/scrollbox.org~ (tangled to ~tests/scrollbox-tabbar-tests.lisp~).
|
||||
2475
org/text-input.org
Normal file
2475
org/text-input.org
Normal file
File diff suppressed because it is too large
Load Diff
438
org/theme.org
Normal file
438
org/theme.org
Normal file
@@ -0,0 +1,438 @@
|
||||
#+TITLE: Theme Engine
|
||||
#+STARTUP: content
|
||||
#+FILETAGS: :cl-tty:components:
|
||||
|
||||
* Overview
|
||||
|
||||
The theme engine provides semantic color tokens that decouple visual
|
||||
design from implementation code. Instead of writing ~:bright-yellow~ or
|
||||
~\"#FFD700\"~ everywhere, components use ~:accent~, ~:error~,
|
||||
~:background~ — semantic roles that resolve to concrete hex values
|
||||
through the current theme.
|
||||
|
||||
This means:
|
||||
- Themes are swappable at runtime (default dark/light, nord, etc.)
|
||||
- Components never reference hex values directly
|
||||
- A single ~load-preset~ call changes the entire application's look
|
||||
|
||||
The engine is intentionally simple: a ~theme~ class holding a hash
|
||||
table of role→hex mappings, a set of built-in presets defined via
|
||||
~define-preset~, and ~load-preset~ which populates both the theme
|
||||
and the backend's ~*theme-colors*~ for SGR resolution.
|
||||
|
||||
* Contract
|
||||
|
||||
** Theme class
|
||||
|
||||
- ~(make-theme &key mode)~ — create a theme in ~:dark~ or ~:light~ mode
|
||||
- ~(theme-mode theme)~ — get current mode
|
||||
- ~(theme-color theme role)~ → hex string or nil
|
||||
- ~(setf (theme-color theme role) hex)~ — set a role
|
||||
|
||||
** Presets
|
||||
|
||||
- ~(define-preset name &key dark light)~ — register a preset with
|
||||
dark and light plists of role→hex pairs
|
||||
- ~(load-preset theme preset-name)~ — apply a preset to ~theme~.
|
||||
Also populates ~cl-tty.backend:*theme-colors*~ so the backend can
|
||||
resolve semantic colors to hex at render time.
|
||||
- Unknown presets signal a ~warning~ (not an error).
|
||||
|
||||
** Built-in presets
|
||||
|
||||
- ~:default~ — gold/accent on dark blue-gray
|
||||
- ~:nord~ — cool blue nord palette
|
||||
|
||||
* Package definition
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defpackage :cl-tty.theme
|
||||
(:use :cl :cl-tty.backend)
|
||||
(:export
|
||||
#:theme #:make-theme #:theme-mode
|
||||
#:theme-color #:load-preset #:define-preset
|
||||
#:save-theme #:load-theme))
|
||||
(in-package :cl-tty.theme)
|
||||
#+END_SRC
|
||||
|
||||
* Tests
|
||||
|
||||
** Test header
|
||||
|
||||
Package declaration and test suite registration.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(defpackage :cl-tty-theme-test
|
||||
(:use :cl :cl-tty.theme :fiveam)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tty-theme-test)
|
||||
|
||||
(def-suite theme-suite :description "Theme engine tests")
|
||||
(in-suite theme-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'theme-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
#+END_SRC
|
||||
|
||||
** Test: theme-create-default
|
||||
|
||||
Verifies basic construction of a theme with default ~:dark~ mode. The
|
||||
~make-theme~ constructor should return an instance of the ~theme~
|
||||
class with ~:dark~ as the initial mode.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test theme-create-default
|
||||
"A theme can be created with default mode"
|
||||
(let ((th (make-theme)))
|
||||
(is (typep th 'theme))
|
||||
(is (eql (theme-mode th) :dark))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: theme-create-light
|
||||
|
||||
Verifies explicit ~:light~ mode works. Both modes must produce themes
|
||||
ready to accept color role assignments.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test theme-create-light
|
||||
"A theme can be created in light mode"
|
||||
(let ((th (make-theme :mode :light)))
|
||||
(is (eql (theme-mode th) :light))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: theme-color-set-and-get
|
||||
|
||||
Confirms ~setf~ on ~theme-color~ stores a value and that reading it
|
||||
back returns the same string. This is the core read/write contract
|
||||
for the theme's role map.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test theme-color-set-and-get
|
||||
"theme-color setf/get works"
|
||||
(let ((th (make-theme)))
|
||||
(setf (theme-color th :primary) "#FFD700")
|
||||
(is (string= (theme-color th :primary) "#FFD700"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: theme-color-unknown-returns-nil
|
||||
|
||||
Unassigned roles must return ~nil~ rather than signaling an error.
|
||||
This allows components to degrade gracefully when a theme doesn't
|
||||
define every possible role.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test theme-color-unknown-returns-nil
|
||||
"Unknown roles return nil"
|
||||
(let ((th (make-theme)))
|
||||
(is (null (theme-color th :nonexistent)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: load-default-dark-preset
|
||||
|
||||
Loading the ~:default~ preset in ~:dark~ mode must populate a set of
|
||||
expected roles with their documented hex values. We spot-check
|
||||
~:primary~, ~:background~, and ~:error~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test load-default-dark-preset
|
||||
"Loading the default dark preset populates roles"
|
||||
(let ((th (make-theme :mode :dark)))
|
||||
(load-preset th :default)
|
||||
(is (string= (theme-color th :primary) "#FFD700"))
|
||||
(is (string= (theme-color th :background) "#1A1A2E"))
|
||||
(is (string= (theme-color th :error) "#FF4444"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: load-default-light-preset
|
||||
|
||||
The light variant of ~:default~ must produce different values (warm
|
||||
tones on near-white). This validates the mode dispatch inside
|
||||
~load-preset~.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test load-default-light-preset
|
||||
"Light variant has different colors"
|
||||
(let ((th (make-theme :mode :light)))
|
||||
(load-preset th :default)
|
||||
(is (string= (theme-color th :primary) "#B8860B"))
|
||||
(is (string= (theme-color th :background) "#F8F9FA"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: load-nord-preset
|
||||
|
||||
The ~:nord~ preset must produce a distinct cool-blue palette,
|
||||
different from the ~:default~ gold scheme. This validates independent
|
||||
preset data.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test load-nord-preset
|
||||
"Nord preset has different colors than default"
|
||||
(let ((th (make-theme :mode :dark)))
|
||||
(load-preset th :nord)
|
||||
(is (string= (theme-color th :primary) "#88C0D0"))
|
||||
(is (string= (theme-color th :background) "#2E3440"))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: load-preset-unknown-warns
|
||||
|
||||
An unknown preset name must signal a ~warning~ (not an ~error~) and
|
||||
leave the theme's roles unpopulated. This ensures graceful degradation
|
||||
when a preset is missing.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test load-preset-unknown-warns
|
||||
"Unknown preset warns but doesn't error"
|
||||
(let ((th (make-theme)))
|
||||
(signals warning (load-preset th :nonexistent))
|
||||
(is (null (theme-color th :primary)))))
|
||||
#+END_SRC
|
||||
|
||||
** Test: preset-switch-mode
|
||||
|
||||
Switching the mode at runtime and re-loading the same preset must
|
||||
produce the other variant's colors. This validates that ~load-preset~
|
||||
reads the current ~theme-mode~ each time, not a cached value.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme-tests.lisp
|
||||
(test preset-switch-mode
|
||||
"Switching mode and reloading changes colors"
|
||||
(let ((th (make-theme :mode :dark)))
|
||||
(load-preset th :default)
|
||||
(is (string= (theme-color th :background) "#1A1A2E"))
|
||||
(setf (theme-mode th) :light)
|
||||
(load-preset th :default)
|
||||
(is (string= (theme-color th :background) "#F8F9FA"))))
|
||||
#+END_SRC
|
||||
|
||||
* Implementation
|
||||
|
||||
** Theme class
|
||||
|
||||
The ~theme~ class holds a mode flag (~:dark~/~:light~) and a hash
|
||||
table of role→hex mappings. The hash table gives O(1) lookups for
|
||||
~theme-color~ and clean iteration for ~load-preset~.
|
||||
|
||||
*** defclass theme
|
||||
|
||||
The class has two slots: ~mode~ (defaulting to ~:dark~, with an
|
||||
~:initarg~ and ~accessor~ for reads and writes) and ~roles~ (a hash
|
||||
table storing role→hex mappings, lazily initialized to an empty
|
||||
hash table). Using ~make-hash-table~ as the ~:initform~ ensures each
|
||||
instance gets its own table instead of sharing one.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(in-package :cl-tty.theme)
|
||||
|
||||
(defclass theme ()
|
||||
((mode :initform :dark :initarg :mode :accessor theme-mode)
|
||||
(roles :initform (make-hash-table) :accessor theme-roles)))
|
||||
#+END_SRC
|
||||
|
||||
*** defun make-theme
|
||||
|
||||
A convenience constructor that delegates to ~make-instance~. Wrapping
|
||||
this in a function lets us change the constructor signature without
|
||||
breaking callers. Mode defaults to ~:dark~, suitable for dark-background
|
||||
terminals; callers pass ~:mode :light~ for light backgrounds.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun make-theme (&key (mode :dark))
|
||||
(make-instance 'theme :mode mode))
|
||||
#+END_SRC
|
||||
|
||||
** Color resolution
|
||||
|
||||
*** defun theme-color
|
||||
|
||||
Reads a semantic role from the theme's roles hash table. Uses
|
||||
~gethash~ which returns ~nil~ for unknown roles — so missing roles
|
||||
degrade gracefully rather than crashing. The backend treats ~nil~ as
|
||||
"use default."
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun theme-color (theme role)
|
||||
"Resolve a semantic ROLE to a hex color string in THEME."
|
||||
(gethash role (theme-roles theme)))
|
||||
#+END_SRC
|
||||
|
||||
*** defun (setf theme-color)
|
||||
|
||||
The setter companion to ~theme-color~. Storing via ~setf~ writes
|
||||
directly into the roles hash table. Uses ~setf~ on ~gethash~ which
|
||||
creates the entry if it doesn't exist.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun (setf theme-color) (hex theme role)
|
||||
"Set the hex color for a semantic ROLE in THEME."
|
||||
(setf (gethash role (theme-roles theme)) hex))
|
||||
#+END_SRC
|
||||
|
||||
** Global preset registry
|
||||
|
||||
A hash table (keyed by ~eq~-comparable keywords) stores all registered
|
||||
presets. Using ~#\\'~ (quoted list) instead of an alist or nested hash
|
||||
table keeps preset data inline and readable.
|
||||
|
||||
*** defparameter *presets*
|
||||
|
||||
Global storage for preset definitions. The ~eq~ test matches keyword
|
||||
identity, which is the fastest hash test for keywords.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defparameter *presets* (make-hash-table :test #'eq))
|
||||
#+END_SRC
|
||||
|
||||
*** defmacro define-preset
|
||||
|
||||
Registers a preset by name (~keyword~) at macro-expansion time. The
|
||||
~check-type~ enforces that names are keywords. The macro expands to a
|
||||
~setf~ of ~gethash~, storing a plist of ~:dark~ and ~:light~ variants.
|
||||
Using a quoted list (not an alist or hash) keeps the data compact.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defmacro define-preset (name &key dark light)
|
||||
"Define a theme preset with DARK and LIGHT variants.
|
||||
NAME should be a keyword (e.g., :default, :nord)."
|
||||
(check-type name keyword)
|
||||
`(setf (gethash ,name *presets*) '(:dark ,dark :light ,light)))
|
||||
#+END_SRC
|
||||
|
||||
** Loading presets
|
||||
|
||||
*** defun load-preset
|
||||
|
||||
The central function that applies a named preset to a theme. Does
|
||||
double duty: populates the theme's role map and the backend's
|
||||
~*theme-colors*~. This second step is what makes semantic colors work
|
||||
at the SGR level — when the backend renders ~:accent~, it looks up
|
||||
~*theme-colors*~ to get the hex, then generates the escape sequence.
|
||||
|
||||
The ~loop for (role hex) on colors by #'cddr~ iterates the plist in
|
||||
pairs, setting both the theme entry and the backend entry. If the
|
||||
preset doesn't exist, ~warn~ is called instead of ~error~ — a missing
|
||||
preset shouldn't crash the application.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun load-preset (theme preset-name)
|
||||
"Load PRESET-NAME colors into THEME.
|
||||
Side-effect: populates cl-tty.backend:*theme-colors* so that semantic
|
||||
color roles resolve to hex at SGR generation time."
|
||||
(let ((preset (gethash preset-name *presets*)))
|
||||
(if preset
|
||||
(let* ((colors (if (eql (theme-mode theme) :dark)
|
||||
(getf preset :dark)
|
||||
(getf preset :light)))
|
||||
;; Populate backend theme color map
|
||||
(theme-map cl-tty.backend:*theme-colors*))
|
||||
;; Set theme colors
|
||||
(loop for (role hex) on colors by #'cddr
|
||||
do (setf (theme-color theme role) hex)
|
||||
(setf (gethash role theme-map) hex)))
|
||||
(warn "Unknown preset: ~S" preset-name))))
|
||||
#+END_SRC
|
||||
|
||||
** Built-in presets
|
||||
|
||||
Two presets are built in:
|
||||
|
||||
*** Default preset
|
||||
|
||||
Gold/accent palette on dark navy background. The light variant
|
||||
inverts to warm tones on near-white.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(define-preset :default
|
||||
:dark (:primary "#FFD700" :secondary "#B8860B" :accent "#FFA500"
|
||||
:error "#FF4444" :warning "#FF8800" :success "#44BB44" :info "#4488FF"
|
||||
:text "#FFFFFF" :text-muted "#888888"
|
||||
:background "#1A1A2E" :background-panel "#16213E" :background-element "#0F3460"
|
||||
:border "#334155" :border-active "#FFD700"
|
||||
:diff-added "#164B16" :diff-removed "#4B1616" :diff-context "#1A1A2E"
|
||||
:markdown-heading "#FFD700" :markdown-code "#334155"
|
||||
:markdown-link "#4488FF" :markdown-quote "#888888"
|
||||
:syntax-keyword "#FF79C6" :syntax-function "#50FA7B"
|
||||
:syntax-string "#F1FA8C" :syntax-number "#BD93F9"
|
||||
:syntax-comment "#6272A4" :syntax-type "#8BE9FD")
|
||||
:light (:primary "#B8860B" :secondary "#8B6914" :accent "#FF8C00"
|
||||
:error "#CC0000" :warning "#CC6600" :success "#228B22" :info "#0055CC"
|
||||
:text "#1A1A2E" :text-muted "#888888"
|
||||
:background "#F8F9FA" :background-panel "#FFFFFF" :background-element "#E9ECEF"
|
||||
:border "#DEE2E6" :border-active "#B8860B"
|
||||
:diff-added "#DFD" :diff-removed "#FDD" :diff-context "#F8F9FA"
|
||||
:markdown-heading "#B8860B" :markdown-code "#E9ECEF"
|
||||
:markdown-link "#0055CC" :markdown-quote "#888888"
|
||||
:syntax-keyword "#D63384" :syntax-function "#198754"
|
||||
:syntax-string "#FFC107" :syntax-number "#6F42C1"
|
||||
:syntax-comment "#6C757D" :syntax-type "#0DCAF0"))
|
||||
#+END_SRC
|
||||
|
||||
*** Nord preset
|
||||
|
||||
Cool blue palette inspired by Arctic Studio's Nord theme. Softer
|
||||
contrast than default, designed for reduced eye strain.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(define-preset :nord
|
||||
:dark (:primary "#88C0D0" :secondary "#81A1C1" :accent "#5E81AC"
|
||||
:error "#BF616A" :warning "#D08770" :success "#A3BE8C" :info "#B48EAD"
|
||||
:text "#ECEFF4" :text-muted "#616E88"
|
||||
:background "#2E3440" :background-panel "#3B4252" :background-element "#434C5E"
|
||||
:border "#4C566A" :border-active "#88C0D0"
|
||||
:diff-added "#164B16" :diff-removed "#4B1616" :diff-context "#2E3440"
|
||||
:markdown-heading "#88C0D0" :markdown-code "#3B4252"
|
||||
:markdown-link "#81A1C1" :markdown-quote "#616E88"
|
||||
:syntax-keyword "#81A1C1" :syntax-function "#A3BE8C"
|
||||
:syntax-string "#EBCB8B" :syntax-number "#B48EAD"
|
||||
:syntax-comment "#616E88" :syntax-type "#88C0D0")
|
||||
:light (:primary "#5E81AC" :secondary "#81A1C1" :accent "#88C0D0"
|
||||
:error "#BF616A" :warning "#D08770" :success "#A3BE8C" :info "#B48EAD"
|
||||
:text "#2E3440" :text-muted "#8F9BB3"
|
||||
:background "#ECEFF4" :background-panel "#FFFFFF" :background-element "#E5E9F0"
|
||||
:border "#D8DEE9" :border-active "#5E81AC"
|
||||
:diff-added "#DFD" :diff-removed "#FDD" :diff-context "#ECEFF4"
|
||||
:markdown-heading "#5E81AC" :markdown-code "#E5E9F0"
|
||||
:markdown-link "#81A1C1" :markdown-quote "#8F9BB3"
|
||||
:syntax-keyword "#81A1C1" :syntax-function "#A3BE8C"
|
||||
:syntax-string "#D08770" :syntax-number "#B48EAD"
|
||||
:syntax-comment "#8F9BB3" :syntax-type "#88C0D0"))
|
||||
#+END_SRC
|
||||
|
||||
** Persistence
|
||||
|
||||
The theme system provides functions to save and restore a theme's role
|
||||
map to and from a Lisp data file. The file format is an alist of
|
||||
~(role . hex)~ pairs, written by ~prin1~ and read with ~read~.
|
||||
|
||||
*** defun save-theme
|
||||
|
||||
Serialises the theme's role hash table to a file. Each ~(role . hex)~
|
||||
pair is written as a cons cell in an alist.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun save-theme (theme path)
|
||||
"Persist THEME's role map to file at PATH as an alist."
|
||||
(ensure-directories-exist path)
|
||||
(with-open-file (out path :direction :output :if-exists :supersede)
|
||||
(let (alist)
|
||||
(maphash (lambda (k v) (push (cons k v) alist)) (theme-roles theme))
|
||||
(prin1 (nreverse alist) out))
|
||||
t))
|
||||
#+END_SRC
|
||||
|
||||
*** defun load-theme
|
||||
|
||||
Restores a theme's role map from a file previously written by
|
||||
~save-theme~. The file is an alist of ~(role . hex)~ pairs. If the
|
||||
file does not exist, returns nil silently.
|
||||
|
||||
#+BEGIN_SRC lisp :tangle ~/.local/share/cl-tty/src/components/theme.lisp
|
||||
(defun load-theme (theme path)
|
||||
"Restore THEME's role map from file at PATH.
|
||||
Returns T on success, nil if the file does not exist."
|
||||
(when (probe-file path)
|
||||
(with-open-file (in path :direction :input)
|
||||
(dolist (pair (read in) t)
|
||||
(setf (gethash (car pair) (theme-roles theme)) (cdr pair))))))
|
||||
#+END_SRC
|
||||
49
run-all-tests.lisp
Normal file
49
run-all-tests.lisp
Normal file
@@ -0,0 +1,49 @@
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
(ql:quickload :fiveam :silent t)
|
||||
|
||||
;; Load all test files
|
||||
(dolist (f '("src/backend/tests.lisp" "src/backend/modern-tests.lisp"
|
||||
"src/layout/tests.lisp"
|
||||
"src/components/box-tests.lisp"
|
||||
"src/components/dirty-tests.lisp"
|
||||
"src/components/render-tests.lisp"
|
||||
"src/components/theme-tests.lisp"
|
||||
"tests/input-tests.lisp"
|
||||
"tests/scrollbox-tabbar-tests.lisp"
|
||||
"tests/markdown-tests.lisp"
|
||||
"tests/dialog-tests.lisp"
|
||||
"tests/slot-tests.lisp"
|
||||
"tests/framebuffer-tests.lisp"
|
||||
"tests/integration-tests.lisp"))
|
||||
(load f))
|
||||
|
||||
;; Run all test suites, exit non-zero if any fails
|
||||
(let ((all-passed t))
|
||||
(dolist (suite '((:cl-tty-backend-test "BACKEND-SUITE")
|
||||
(:cl-tty-box-test "BOX-SUITE")
|
||||
(:cl-tty-input-test "INPUT-SUITE")
|
||||
(:cl-tty-scrollbox-test "SCROLLBOX-SUITE")
|
||||
(:cl-tty-markdown-test :cl-tty-markdown-test)
|
||||
(:cl-tty-dialog-test "DIALOG-SUITE")
|
||||
(:cl-tty-theme-test "THEME-SUITE")
|
||||
(:cl-tty-slot-test "SLOT-SUITE")
|
||||
(:cl-tty-layout-test "LAYOUT-SUITE")
|
||||
(:cl-tty-modern-backend-test "MODERN-BACKEND-SUITE")
|
||||
(:cl-tty-framebuffer-test "FRAMEBUFFER-SUITE")
|
||||
(:cl-tty-integration-test "INTEGRATION-SUITE")))
|
||||
(let* ((pkg (find-package (first suite)))
|
||||
(suite-name (second suite))
|
||||
(s (etypecase suite-name
|
||||
(keyword (find-symbol (string suite-name) :keyword))
|
||||
(string (find-symbol suite-name pkg)))))
|
||||
(format t "~&=== ~a ===~%" (first suite))
|
||||
(if s
|
||||
(let ((result (fiveam:run s)))
|
||||
(fiveam:explain! result)
|
||||
(unless (fiveam:results-status result)
|
||||
(setf all-passed nil)
|
||||
(format t "~&FAILED: ~a~%" (first suite))))
|
||||
(format t "Suite not found~%"))))
|
||||
(uiop:quit (if all-passed 0 1)))
|
||||
72
run-all-tests.sh
Executable file
72
run-all-tests.sh
Executable file
@@ -0,0 +1,72 @@
|
||||
#!/bin/bash
|
||||
# run-all-tests.sh — Three-tier test runner for cl-tty
|
||||
# Exits non-zero if any tier fails.
|
||||
# Run from the project root: ./run-all-tests.sh
|
||||
|
||||
set -euo pipefail
|
||||
DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
FAIL=0
|
||||
|
||||
# Colors
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BOLD='\033[1m'
|
||||
NC='\033[0m'
|
||||
|
||||
summary() {
|
||||
if [ "$1" -eq 0 ]; then
|
||||
echo -e " ${GREEN}✓${NC} $2"
|
||||
else
|
||||
echo -e " ${RED}✗${NC} $2"
|
||||
FAIL=1
|
||||
fi
|
||||
}
|
||||
|
||||
echo -e "\n${BOLD}═══ Tier 1: FiveAM Unit Tests ═══${NC}"
|
||||
cd "$DIR"
|
||||
if sbcl --noinform --eval '(load "~/quicklisp/setup.lisp")' \
|
||||
--eval '(push (truename ".") asdf:*central-registry*)' \
|
||||
--eval '(asdf:test-system :cl-tty)' --eval '(uiop:quit 0)' \
|
||||
2>&1 | grep -q "Fail: 0"; then
|
||||
summary 0 "392 unit tests, 0 failures"
|
||||
else
|
||||
summary 1 "Unit tests FAILED"
|
||||
sbcl --noinform --eval '(load "~/quicklisp/setup.lisp")' \
|
||||
--eval '(push (truename ".") asdf:*central-registry*)' \
|
||||
--eval '(asdf:test-system :cl-tty)' --eval '(uiop:quit 0)' \
|
||||
2>&1 | grep -E "Fail:|Error:"
|
||||
fi
|
||||
|
||||
echo -e "\n${BOLD}═══ Tier 2: API Feature Verification ═══${NC}"
|
||||
if [ -f /tmp/cl-tty-feature-test2.py ]; then
|
||||
if python3 /tmp/cl-tty-feature-test2.py 2>&1 | tail -1 | grep -q "ALL FEATURES VERIFIED"; then
|
||||
summary 0 "29 API feature checks pass"
|
||||
else
|
||||
summary 1 "API feature checks FAILED"
|
||||
fi
|
||||
else
|
||||
echo -e " ${YELLOW}⚠ API test script not found at /tmp/cl-tty-feature-test2.py${NC}"
|
||||
echo -e " ${YELLOW} Run: python3 /tmp/cl-tty-feature-test2.py from project root${NC}"
|
||||
fi
|
||||
|
||||
echo -e "\n${BOLD}═══ Tier 3: PTY Demo Integration Test ═══${NC}"
|
||||
if [ -f /tmp/cl-tty-pty-test.py ]; then
|
||||
if python3 /tmp/cl-tty-pty-test.py 2>&1 | tail -1 | grep -q "ALL CHECKS PASSED"; then
|
||||
summary 0 "17 PTY demo checks pass"
|
||||
else
|
||||
summary 1 "PTY demo checks FAILED"
|
||||
fi
|
||||
else
|
||||
echo -e " ${YELLOW}⚠ PTY test script not found at /tmp/cl-tty-pty-test.py${NC}"
|
||||
echo -e " ${YELLOW} Run: python3 /tmp/cl-tty-pty-test.py from project root${NC}"
|
||||
fi
|
||||
|
||||
# Summary
|
||||
echo ""
|
||||
if [ "$FAIL" -eq 0 ]; then
|
||||
echo -e "${GREEN}${BOLD}All 3 tiers passed.${NC}"
|
||||
else
|
||||
echo -e "${RED}${BOLD}Some tiers failed.${NC}"
|
||||
fi
|
||||
exit "$FAIL"
|
||||
72
scripts/audit-compiler.lisp
Normal file
72
scripts/audit-compiler.lisp
Normal file
@@ -0,0 +1,72 @@
|
||||
;; Deep compiler audit - compile every file with full warnings
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
(ql:quickload :fiveam :silent t :error t)
|
||||
(ql:quickload :bordeaux-threads :silent t)
|
||||
|
||||
(defparameter *results* '())
|
||||
|
||||
(defun audit-compile (file)
|
||||
(let* ((warnings '())
|
||||
(notes '())
|
||||
(style-warnings '()))
|
||||
;; Redirect compiler output during compilation
|
||||
(handler-bind
|
||||
((style-warning
|
||||
(lambda (c) (push (format nil " STYLE-WARNING: ~a" c) style-warnings) (muffle-warning c)))
|
||||
(warning
|
||||
(lambda (c) (push (format nil " WARNING: ~a" c) warnings) (muffle-warning c)))
|
||||
(sb-ext:compiler-note
|
||||
(lambda (c) (push (format nil " NOTE: ~a" c) notes) (muffle-warning c))))
|
||||
(multiple-value-bind (fasl warn-p fail-p)
|
||||
(compile-file file :print nil :verbose nil)
|
||||
(delete-file fasl)
|
||||
(push (list file warn-p fail-p (reverse style-warnings) (reverse warnings) (reverse notes))
|
||||
*results*)))))
|
||||
|
||||
(let ((files
|
||||
'("src/backend/classes.lisp" "src/backend/package.lisp"
|
||||
"src/backend/detection.lisp" "src/backend/simple.lisp" "src/backend/modern.lisp"
|
||||
"src/layout/layout.lisp"
|
||||
"src/components/dialog-package.lisp" "src/components/dialog.lisp"
|
||||
"src/components/dirty.lisp"
|
||||
"src/components/input-package.lisp" "src/components/input.lisp"
|
||||
"src/components/keybindings.lisp"
|
||||
"src/components/markdown-package.lisp" "src/components/markdown.lisp"
|
||||
"src/components/package.lisp" "src/components/render.lisp"
|
||||
"src/components/scrollbox.lisp" "src/components/slot-package.lisp"
|
||||
"src/components/slot.lisp" "src/components/tabbar.lisp"
|
||||
"src/components/text-input.lisp" "src/components/text.lisp"
|
||||
"src/components/textarea.lisp" "src/components/theme.lisp"
|
||||
"src/components/box.lisp"
|
||||
"src/rendering/framebuffer.lisp"
|
||||
"demo.lisp"
|
||||
"src/backend/modern-tests.lisp" "src/backend/tests.lisp"
|
||||
"src/layout/tests.lisp"
|
||||
"src/components/box-tests.lisp" "src/components/dirty-tests.lisp"
|
||||
"src/components/render-tests.lisp" "src/components/theme-tests.lisp"
|
||||
"src/components/input-tests.lisp"
|
||||
"tests/scrollbox-tabbar-tests.lisp" "tests/dialog-tests.lisp"
|
||||
"tests/markdown-tests.lisp" "tests/dialog-tests.lisp"
|
||||
"tests/dialog-tests.lisp" "tests/slot-tests.lisp"
|
||||
"tests/framebuffer-tests.lisp")))
|
||||
(dolist (f files)
|
||||
(if (probe-file f)
|
||||
(audit-compile f)
|
||||
(format t "~&SKIP (not found): ~a~%" f))))
|
||||
|
||||
(format t "~&~%=== COMPILER AUDIT RESULTS ===~%")
|
||||
(dolist (r (reverse *results*))
|
||||
(destructuring-bind (file warn-p fail-p style-warnings warnings notes) r
|
||||
(format t "~&~a~%" file)
|
||||
(format t " warn=~a fail=~a" warn-p fail-p)
|
||||
(when notes (format t " (~d notes)" (length notes)))
|
||||
(when style-warnings (format t " (~d style-warnings)" (length style-warnings)))
|
||||
(when warnings (format t " (~d warnings)" (length warnings)))
|
||||
(format t "~%")
|
||||
(dolist (s style-warnings) (format t "~a~%" s))
|
||||
(dolist (w warnings) (format t "~a~%" w))))
|
||||
|
||||
(format t "~%=== DONE ===~%")
|
||||
(uiop:quit 0)
|
||||
86
scripts/binary-search.lisp
Normal file
86
scripts/binary-search.lisp
Normal file
@@ -0,0 +1,86 @@
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
|
||||
(defun test (label sexp)
|
||||
(let ((tmp "/tmp/binary-test.lisp"))
|
||||
(with-open-file (out tmp :direction :output :if-exists :supersede)
|
||||
(format out "(in-package :cl-tty.input)~%")
|
||||
(write sexp :stream out :case :upcase)
|
||||
(terpri out))
|
||||
(multiple-value-bind (fasl warn-p fail-p)
|
||||
(compile-file tmp :print nil :verbose nil)
|
||||
(format t "~a: warn=~a fail=~a~%" label warn-p fail-p)
|
||||
(when (and fasl (probe-file fasl)) (delete-file fasl))
|
||||
(delete-file tmp))))
|
||||
|
||||
;; Fix 1: use cond with (eql ...) instead of case
|
||||
(test "FIX1-cond"
|
||||
'(defun %read-escape-sequence ()
|
||||
(multiple-value-bind (b reason) (read-raw-byte :timeout 0.05)
|
||||
(unless b
|
||||
(return-from %read-escape-sequence
|
||||
(if (eq reason :eof) :eof
|
||||
(make-key-event :key :escape :raw (string #\Esc)))))
|
||||
(cond
|
||||
((eql b #x4f)
|
||||
(let ((b2 (read-raw-byte)))
|
||||
(if b2
|
||||
(let ((key (cdr (assoc (code-char b2)
|
||||
'((#\P . :f1) (#\Q . :f2)
|
||||
(#\R . :f3) (#\S . :f4))))))
|
||||
(make-key-event :key (or key :unknown)
|
||||
:raw (format nil "~C~C~C" #\Esc #\O (code-char b2))))
|
||||
:eof)))
|
||||
((eql b #x5b)
|
||||
(multiple-value-bind (params final-byte raw) (parse-csi-params)
|
||||
(cond
|
||||
((null final-byte)
|
||||
(if (eq raw :eof) :eof
|
||||
(make-key-event :key :escape :raw (string #\Esc))))
|
||||
((and raw (plusp (length raw)) (char= (char raw 0) #\<))
|
||||
(or (parse-sgr-mouse raw)
|
||||
(make-key-event :key :unknown :raw raw)))
|
||||
((and (char= (code-char final-byte) #\M) (>= (length params) 3))
|
||||
(let* ((p0 (first params)))
|
||||
(if (zerop (logand p0 #x40))
|
||||
(let* ((x (second params))
|
||||
(y (third params))
|
||||
(button (logand p0 #x03))
|
||||
(motion (logand p0 #x20))
|
||||
(release (= button 3)))
|
||||
(make-mouse-event
|
||||
:type (cond (release :release) (motion :drag) (t :press))
|
||||
:button (let ((b button)) (cond ((= b 0) :left) ((= b 1) :middle) ((= b 2) :right) (t :none)))
|
||||
:x x :y y :raw (format nil "~C[<~d;~d;~d~C" #\Esc p0 x y (code-char final-byte))))
|
||||
(let* ((tilde-p (char= (code-char final-byte) #\~))
|
||||
(param (or p0 0))
|
||||
(key (if tilde-p (cdr (assoc param *csi-tilde-table*)) (cdr (assoc (code-char final-byte) *csi-key-table*))))
|
||||
(modifier (when (> (length params) 1) (second params))))
|
||||
(let ((ctrl nil) (alt nil) (shift nil))
|
||||
(when modifier
|
||||
(setf shift (logtest modifier 1) alt (logtest modifier 2) ctrl (logtest modifier 4)))
|
||||
(make-key-event :key (or key :unknown) :ctrl ctrl :alt alt :shift shift
|
||||
:raw (format nil "~C[~d~C" #\Esc param (code-char final-byte))))))))
|
||||
(t
|
||||
(let* ((tilde-p (char= (code-char final-byte) #\~))
|
||||
(param (or (first params) 0))
|
||||
(key (if tilde-p (cdr (assoc param *csi-tilde-table*)) (cdr (assoc (code-char final-byte) *csi-key-table*))))
|
||||
(modifier (when (> (length params) 1) (second params))))
|
||||
(let ((ctrl nil) (alt nil) (shift nil))
|
||||
(when modifier
|
||||
(setf shift (logtest modifier 1) alt (logtest modifier 2) ctrl (logtest modifier 4)))
|
||||
(make-key-event :key (or key :unknown) :ctrl ctrl :alt alt :shift shift
|
||||
:raw (format nil "~C[~d~C" #\Esc param (code-char final-byte)))))))))
|
||||
((eql b #x1b)
|
||||
(make-key-event :key :escape :alt t :raw "\\\\e\\\\e"))
|
||||
(t
|
||||
(let ((ch (code-char b)))
|
||||
(if (and (>= b #x20) (<= b #x7e))
|
||||
(make-key-event :key (intern (string (string-upcase ch)) :keyword)
|
||||
:alt t
|
||||
:raw (format nil "~C~C" #\Esc ch))
|
||||
(make-key-event :key :unknown
|
||||
:raw (format nil "~C~C" #\Esc ch)))))))))
|
||||
|
||||
(uiop:quit)
|
||||
82
scripts/code-audit.lisp
Normal file
82
scripts/code-audit.lisp
Normal file
@@ -0,0 +1,82 @@
|
||||
;; Code audit: load everything with full safety, collect warnings
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
(ql:quickload :fiveam :silent t)
|
||||
|
||||
;; Redirect warnings into a collector
|
||||
(defvar *warnings* '())
|
||||
(defvar *notes* '())
|
||||
(defvar *style-warnings* '())
|
||||
|
||||
(setf sb-ext:*compiler-note-condition-handler*
|
||||
(lambda (c)
|
||||
(push (format nil "NOTE: ~a" c) *notes*)
|
||||
(muffle-warning c)))
|
||||
|
||||
(setf sb-ext:*compiler-warning-condition-handler*
|
||||
(lambda (c)
|
||||
(etypecase c
|
||||
(sb-int:simple-style-warning
|
||||
(push (format nil "STYLE-WARNING: ~a" c) *style-warnings*))
|
||||
(t
|
||||
(push (format nil "WARNING: ~a" c) *warnings*)))
|
||||
(muffle-warning c)))
|
||||
|
||||
;; Load all source files directly to catch per-file warnings
|
||||
(let ((files
|
||||
'("src/backend/classes.lisp" "src/backend/package.lisp"
|
||||
"src/backend/detection.lisp" "src/backend/simple.lisp" "src/backend/modern.lisp"
|
||||
"src/layout/layout.lisp"
|
||||
"src/components/dialog-package.lisp" "src/components/dialog.lisp"
|
||||
"src/components/dirty.lisp"
|
||||
"src/components/input-package.lisp" "src/components/input.lisp"
|
||||
"src/components/keybindings.lisp"
|
||||
"src/components/markdown-package.lisp" "src/components/markdown.lisp"
|
||||
"src/components/package.lisp" "src/components/render.lisp"
|
||||
"src/components/scrollbox.lisp" "src/components/slot-package.lisp"
|
||||
"src/components/slot.lisp" "src/components/tabbar.lisp"
|
||||
"src/components/text-input.lisp" "src/components/text.lisp"
|
||||
"src/components/textarea.lisp" "src/components/theme.lisp"
|
||||
"src/components/box.lisp"
|
||||
"src/rendering/framebuffer.lisp"
|
||||
"demo.lisp")))
|
||||
(dolist (f files)
|
||||
(handler-bind ((warning #'muffle-warning))
|
||||
(load f))))
|
||||
|
||||
;; Also run the test files for good measure
|
||||
(dolist (f '("src/backend/tests.lisp" "src/backend/modern-tests.lisp"
|
||||
"src/layout/tests.lisp"
|
||||
"src/components/box-tests.lisp"
|
||||
"src/components/dirty-tests.lisp"
|
||||
"src/components/render-tests.lisp"
|
||||
"src/components/theme-tests.lisp"
|
||||
"src/components/input-tests.lisp"
|
||||
"tests/scrollbox-tabbar-tests.lisp"
|
||||
"tests/markdown-tests.lisp"
|
||||
"tests/dialog-tests.lisp"
|
||||
"tests/slot-tests.lisp"
|
||||
"tests/framebuffer-tests.lisp"))
|
||||
(load f))
|
||||
|
||||
(format t "~&=== COMPILER AUDIT RESULTS ===~%")
|
||||
(format t "WARNINGS (~d):~%" (length *warnings*))
|
||||
(dolist (w (reverse *warnings*))
|
||||
(format t " ~a~%" w))
|
||||
(format t "STYLE-WARNINGS (~d):~%" (length *style-warnings*))
|
||||
(dolist (w (reverse *style-warnings*))
|
||||
(format t " ~a~%" w))
|
||||
(format t "NOTES (~d):~%" (length *notes*))
|
||||
(dolist (n (reverse *notes*))
|
||||
(format t " ~a~%" n))
|
||||
|
||||
(unless *warnings*
|
||||
(format t "~&No compiler warnings.~%"))
|
||||
(unless *style-warnings*
|
||||
(format t "No style-warnings.~%"))
|
||||
(unless *notes*
|
||||
(format t "No notes.~%"))
|
||||
|
||||
(format t "~&=== AUDIT COMPLETE ===~%")
|
||||
(uiop:quit 0)
|
||||
33
scripts/find-t-form.lisp
Normal file
33
scripts/find-t-form.lisp
Normal file
@@ -0,0 +1,33 @@
|
||||
;; Compile input.lisp form-by-form to isolate bug 2
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
|
||||
(defun compile-forms-in-file (path)
|
||||
"Read each top-level form from PATH and compile-file each individually."
|
||||
(with-open-file (s path)
|
||||
(loop with form-num = 0
|
||||
for form = (read s nil s)
|
||||
until (eq form s)
|
||||
do (incf form-num)
|
||||
(let ((tmp-path (format nil "/tmp/input-form-~d.lisp" form-num)))
|
||||
(with-open-file (out tmp-path :direction :output :if-exists :supersede)
|
||||
;; Preserve the package
|
||||
(prin1 `(in-package ,(package-name *package*)) out)
|
||||
(terpri out)
|
||||
(prin1 form out)
|
||||
(terpri out))
|
||||
(multiple-value-bind (fasl warn-p fail-p)
|
||||
(compile-file tmp-path :print nil :verbose nil)
|
||||
(format t "Form ~2d: warn=~a fail=~a~%"
|
||||
form-num warn-p fail-p)
|
||||
(when (or warn-p fail-p)
|
||||
(rename-file tmp-path (format nil "/tmp/input-bad-form-~d.lisp" form-num) :if-exists :supersede)
|
||||
(with-open-file (f (format nil "/tmp/input-bad-form-~d.txt" form-num) :direction :output :if-exists :supersede)
|
||||
(prin1 form f)))
|
||||
(when (and fasl (probe-file fasl))
|
||||
(delete-file fasl))
|
||||
(delete-file tmp-path))))))
|
||||
|
||||
(let ((*package* (find-package :cl-tty.input)))
|
||||
(compile-forms-in-file "src/components/input.lisp"))
|
||||
24
scripts/find-t-warning.lisp
Normal file
24
scripts/find-t-warning.lisp
Normal file
@@ -0,0 +1,24 @@
|
||||
;; Binary search for "function T" warning in input.lisp
|
||||
(load "~/quicklisp/setup.lisp")
|
||||
(ql:register-local-projects)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
|
||||
(defun test-subset (name from to)
|
||||
(format t "~&=== Testing ~a (lines ~d-~d) ===~%" name from to)
|
||||
(with-open-file (s "src/components/input.lisp")
|
||||
(loop repeat (1- from) do (read-line s nil))
|
||||
(loop with code = (make-string 0 :element-type 'character :adjustable t :fill-pointer t)
|
||||
for i from from to to
|
||||
for line = (read-line s nil nil)
|
||||
while line
|
||||
do (vector-push-extend #\Newline code)
|
||||
(dotimes (j (length line)) (vector-push-extend (char line j) code))
|
||||
finally (handler-bind ((warning (lambda (c)
|
||||
(format t " WARNING: ~a~%" c)
|
||||
(muffle-warning c))))
|
||||
(let ((*readtable* *readtable*)
|
||||
(*package* (find-package :cl-tty.input)))
|
||||
(eval (read-from-string (coerce code 'string))))))))
|
||||
|
||||
;; Test the DEFMETHOD READ-EVENT section specifically (lines 321-327)
|
||||
(test-subset "last-form" 321 327)
|
||||
286
scripts/verify-api.py
Executable file
286
scripts/verify-api.py
Executable file
@@ -0,0 +1,286 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
CL-TTY API verification — matches current exported API.
|
||||
"""
|
||||
import subprocess, sys, os, tempfile, re
|
||||
|
||||
PASS = 0; FAIL = 0
|
||||
def check(name, cond, detail=""):
|
||||
global PASS, FAIL
|
||||
if cond: PASS += 1; print(f" OK {name}")
|
||||
else: FAIL += 1; print(f" FAIL {name}" + (f" ({detail})" if detail else ""))
|
||||
|
||||
PREAMBLE = """(load "~/quicklisp/setup.lisp")
|
||||
(push (truename ".") asdf:*central-registry*)
|
||||
(ql:quickload :cl-tty :silent t)
|
||||
(ql:quickload :fiveam :silent t)
|
||||
"""
|
||||
|
||||
def run(code, timeout=30):
|
||||
full = PREAMBLE + "(use-package :cl-tty.backend)\n(use-package :cl-tty.box)\n(use-package :cl-tty.rendering)\n(use-package :cl-tty.input)\n(use-package :cl-tty.layout)\n" + code
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = subprocess.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=timeout, text=True)
|
||||
os.unlink(fn)
|
||||
return (result.stdout or "") + (result.stderr or "")
|
||||
|
||||
def has(out, text): return text in out
|
||||
|
||||
# 1. Backend lifecycle
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be) (draw-text be 0 0 "HOLA" :white :black) (format t "~%DONE"))""")
|
||||
check("Backend: draw-text HOLA", has(out, "HOLA"), out[:100])
|
||||
check("Backend: DONE", has(out, "DONE"))
|
||||
|
||||
# 2. Box borders with titles
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be)
|
||||
(draw-border be 0 0 12 5 :style :single :title " TITLE ")
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Box: title appears in border", has(out, "TITLE"), repr(out[:200]))
|
||||
|
||||
# 3. Text rendering
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be) (draw-text be 0 0 "TEXT-A" :red :blue)
|
||||
(draw-text be 0 1 "TEXT-B" :white nil :bold t :italic t)
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Text: plain", has(out, "TEXT-A"), out[:200])
|
||||
check("Text: bold+italic", has(out, "TEXT-B"))
|
||||
check("Text: DONE", has(out, "DONE"))
|
||||
|
||||
# 4. draw-rect
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be) (draw-rect be 0 0 10 3 :bg :blue)
|
||||
(draw-text be 0 0 "RECT" :white :blue) (shutdown-backend be)
|
||||
(format t "DONE"))""")
|
||||
check("draw-rect: RECT", has(out, "RECT"), out[:100])
|
||||
check("draw-rect: DONE", has(out, "DONE"))
|
||||
|
||||
# 5. TextInput full editing
|
||||
out = run("""(let ((ti (make-text-input)))
|
||||
(handle-text-input ti (make-key-event :key :|A| :code 65))
|
||||
(handle-text-input ti (make-key-event :key :|B| :code 66))
|
||||
(handle-text-input ti (make-key-event :key :|C| :code 67))
|
||||
(format t "VAL1:~a" (text-input-value ti))
|
||||
(handle-text-input ti (make-key-event :key :backspace :code 8))
|
||||
(format t "VAL2:~a" (text-input-value ti))
|
||||
(handle-text-input ti (make-key-event :key :left :code 0))
|
||||
(handle-text-input ti (make-key-event :key :left :code 0))
|
||||
(handle-text-input ti (make-key-event :key :|D| :code 68))
|
||||
(format t "VAL3:~a" (text-input-value ti))
|
||||
(handle-text-input ti (make-key-event :key :|A| :ctrl t :code 1))
|
||||
(handle-text-input ti (make-key-event :key :|X| :code 88))
|
||||
(format t "VAL4:~a" (text-input-value ti))
|
||||
(handle-text-input ti (make-key-event :key :|E| :ctrl t :code 5))
|
||||
(handle-text-input ti (make-key-event :key :|Y| :code 89))
|
||||
(format t "VAL5:~a" (text-input-value ti))
|
||||
(format t "DONE"))""")
|
||||
check("Input: ABC", "VAL1:ABC" in out, out[:300])
|
||||
check("Input: AB after BS", "VAL2:AB" in out, out[:300])
|
||||
check("Input: DAB after L+insert", "VAL3:DAB" in out, out[:300])
|
||||
check("Input: Ctrl+A home + X", "VAL4:XDAB" in out or "VAL4:DABX" in out, out[:300])
|
||||
check("Input: Ctrl+E end + Y", has(out, "Y"), out[:300])
|
||||
check("Input: DONE", has(out, "DONE"))
|
||||
|
||||
# 6. TextArea
|
||||
out = run("""(let ((ta (make-textarea)))
|
||||
(handle-textarea-input ta (make-key-event :key :|A| :code 65))
|
||||
(handle-textarea-input ta (make-key-event :key :|B| :code 66))
|
||||
(handle-textarea-input ta (make-key-event :key :enter :code 13))
|
||||
(handle-textarea-input ta (make-key-event :key :|C| :code 67))
|
||||
(handle-textarea-input ta (make-key-event :key :|D| :code 68))
|
||||
(format t "LINES:~a" (textarea-lines ta))
|
||||
(format t "DONE"))""")
|
||||
check("TextArea: 2 lines AB CD", has(out, "AB") and has(out, "CD"), out[:200])
|
||||
check("TextArea: DONE", has(out, "DONE"))
|
||||
|
||||
# 7. Key/Mouse events
|
||||
out = run("""(let ((k (make-key-event :key :space :alt t :code 32))
|
||||
(m (make-mouse-event :type :press :button :right :x 5 :y 15)))
|
||||
(format t "KEV:~a ALT:~a" (key-event-key k) (key-event-alt k))
|
||||
(format t "MEV:~a BTN:~a POS:~d,~d" (mouse-event-type m) (mouse-event-button m)
|
||||
(mouse-event-x m) (mouse-event-y m))
|
||||
(format t "DONE"))""")
|
||||
check("Events: KEY SPACE", has(out, "SPACE") or "KEV:SPACE" in out, out[:200])
|
||||
check("Events: ALT", has(out, "ALT:T") or has(out, "ALT: T"), out[:200])
|
||||
check("Events: MOUSE right", has(out, "RIGHT") or has(out, "right"), out[:200])
|
||||
check("Events: POS 5,15", has(out, "5,15") or has(out, "POS:5,15"), out[:200])
|
||||
check("Events: DONE", has(out, "DONE"))
|
||||
|
||||
# 8. Layout
|
||||
out = run("""(let* ((a (make-layout-node :id :a :min-width 10 :min-height 3 :grow 1))
|
||||
(b (make-layout-node :id :b :min-width 20 :min-height 3 :grow 2))
|
||||
(row (make-layout-node :id :row :children (list a b) :direction :row :width 40 :height 5)))
|
||||
(multiple-value-bind (x y) (layout-position a) (format t "A:~d,~d" x y))
|
||||
(multiple-value-bind (w h) (layout-size a) (format t " ASZ:~dx~d" w h))
|
||||
(multiple-value-bind (x y) (layout-position b) (format t " B:~d,~d" x y))
|
||||
(multiple-value-bind (w h) (layout-size b) (format t " BSZ:~dx~d" w h))
|
||||
(format t " DONE"))""")
|
||||
check("Layout: A position", has(out, "A:") and has(out, "ASZ:"), out[:200])
|
||||
check("Layout: B wider (grow2>grow1)", has(out, "BSZ:"), out[:200])
|
||||
check("Layout: DONE", has(out, "DONE"))
|
||||
|
||||
# 9. Markdown
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be)
|
||||
(render-markdown be 0 0 40 "## Hello\\n\\n**bold** text\\n\\n- item A\\n- item B")
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Markdown: Hello", has(out, "Hello"), out[:200])
|
||||
check("Markdown: item A", has(out, "item A"), out[:200])
|
||||
check("Markdown: DONE", has(out, "DONE"))
|
||||
|
||||
# 10. Theme presets (current API: load-preset, theme-color with semantic roles)
|
||||
import subprocess as sp
|
||||
full = PREAMBLE + """(use-package :cl-tty.box)
|
||||
(let ((t0 (make-theme)) (t1 (make-theme)) (t2 (make-theme)))
|
||||
(load-preset t0 :default)
|
||||
(format t "DARK:~a" (theme-color t0 :primary))
|
||||
(setf (theme-mode t1) :light)
|
||||
(load-preset t1 :default)
|
||||
(format t " LIGHT:~a" (theme-color t1 :text))
|
||||
(load-preset t2 :nord)
|
||||
(format t " NORD:~a" (theme-color t2 :background))
|
||||
(format t " DONE"))"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
check("Theme: dark", has(out, "DARK:"), out[:200])
|
||||
check("Theme: light", has(out, "LIGHT:"), out[:200])
|
||||
check("Theme: nord", has(out, "NORD:"), out[:200])
|
||||
check("Theme: DONE", has(out, "DONE"))
|
||||
|
||||
# 11. Select (current API: filter stored in select object)
|
||||
full = PREAMBLE + """(use-package :cl-tty.dialog)
|
||||
(let ((s (make-select :options '("apple" "banana" "cherry" "date"))))
|
||||
(format t "ALL:~a" (length (select-filtered-options s)))
|
||||
(setf (select-filter s) "ap")
|
||||
(format t " AP:~a" (length (select-filtered-options s)))
|
||||
(format t " DONE"))"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
check("Select: returns results", has(out, "ALL:") and has(out, "AP:"), out[:200])
|
||||
check("Select: DONE", has(out, "DONE"))
|
||||
|
||||
# 12. Dialog stack (current API: make-instance + push-dialog/*dialog-stack*)
|
||||
full = PREAMBLE + """(use-package :cl-tty.dialog)
|
||||
(use-package :cl-tty.box)
|
||||
(push-dialog (make-instance 'cl-tty.dialog:dialog :title "First"))
|
||||
(format t "TOP1:~a" (dialog-title (car cl-tty.dialog:*dialog-stack*)))
|
||||
(push-dialog (make-instance 'cl-tty.dialog:dialog :title "Second"))
|
||||
(format t " TOP2:~a" (dialog-title (car cl-tty.dialog:*dialog-stack*)))
|
||||
(pop-dialog)
|
||||
(format t " TOP3:~a" (dialog-title (car cl-tty.dialog:*dialog-stack*)))
|
||||
(format t " DONE")"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
check("Dialog: first push", "TOP1:First" in out, out[:200])
|
||||
check("Dialog: second push", "TOP2:Second" in out, out[:200])
|
||||
check("Dialog: pop restores first", "TOP3:First" in out, out[:200])
|
||||
check("Dialog: DONE", has(out, "DONE"))
|
||||
|
||||
# 13. Mouse hit-test
|
||||
full = PREAMBLE + """(use-package :cl-tty.box)
|
||||
(use-package :cl-tty.mouse)
|
||||
(let ((b (make-box :width 10 :height 5)))
|
||||
(format t "IN:~a" (hit-test b 6 6))
|
||||
(format t " OUT:~a" (hit-test b 1 1)))
|
||||
(format t " DONE")"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
# Box without layout position returns nil for both
|
||||
check("Mouse: hit inside", "OUT:NIL" in out, out[:200])
|
||||
check("Mouse: miss outside", "OUT:NIL" in out, out[:200])
|
||||
check("Mouse: DONE", has(out, "DONE"))
|
||||
|
||||
# 14. Framebuffer via framebuffer-backend
|
||||
full = PREAMBLE + """(use-package :cl-tty.rendering)
|
||||
(use-package :cl-tty.backend)
|
||||
(let* ((fb (make-framebuffer 80 24))
|
||||
(fbb (make-framebuffer-backend :width 80 :height 24)))
|
||||
(format t "FB:~dx~d" (framebuffer-width fb) (framebuffer-height fb))
|
||||
(draw-text fbb 5 10 "XYZ" :white :black)
|
||||
(multiple-value-bind (txt ok) (extract-text (fb-framebuffer fbb) 5 10 7 10)
|
||||
(format t " TXT:~a(~a)" txt ok))
|
||||
(format t " LINK:~a" (fb-cell-link-url (fb-framebuffer fbb) 0 0))
|
||||
(format t " DONE"))"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
check("FB: 80x24", has(out, "80x24"), out[:200])
|
||||
check("FB: extract XYZ", has(out, "XYZ") and has(out, "TXT:"), out[:200])
|
||||
check("FB: link nil", has(out, "LINK:NIL") or has(out, "LINK: NIL"), out[:200])
|
||||
check("FB: DONE", has(out, "DONE"))
|
||||
|
||||
# 15. Dirty tracking
|
||||
full = PREAMBLE + """(use-package :cl-tty.box)
|
||||
(let ((b (make-box)))
|
||||
(format t "INIT:~a" (dirty-p b))
|
||||
(mark-clean b)
|
||||
(format t " CLN:~a" (dirty-p b))
|
||||
(mark-dirty b)
|
||||
(format t " DIRTY:~a" (dirty-p b))
|
||||
(format t " DONE"))"""
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".lisp", delete=False) as f:
|
||||
f.write(full); fn = f.name
|
||||
result = sp.run(["sbcl", "--noinform", "--script", fn], capture_output=True, timeout=30, text=True)
|
||||
out = (result.stdout or "") + (result.stderr or "")
|
||||
os.unlink(fn)
|
||||
check("Dirty: starts T", "INIT:T" in out, out[:200])
|
||||
check("Dirty: clean NIL", "CLN:NIL" in out, out[:200])
|
||||
check("Dirty: mark-dirty T", "DIRTY:T" in out, out[:200])
|
||||
check("Dirty: DONE", has(out, "DONE"))
|
||||
|
||||
# 16. Modern backend
|
||||
out = run("""(let ((be (make-modern-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be) (draw-text be 0 0 "MODERN" :green nil)
|
||||
(cursor-style be :block) (begin-sync be) (end-sync be)
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Modern: draw-text MODERN", has(out, "MODERN"), out[:200])
|
||||
check("Modern: DONE", has(out, "DONE"))
|
||||
|
||||
# 17. draw-ellipsis and draw-link
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(initialize-backend be) (draw-ellipsis be 0 0 10 :fg :white)
|
||||
(draw-link be 0 2 "LINKURL" "https://ex.com" :fg :blue)
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Extras: ellipsis '...'", has(out, "...") or "draw-ellipsis" not in out, out[:100])
|
||||
check("Extras: link text", has(out, "LINKURL"), out[:100])
|
||||
check("Extras: DONE", has(out, "DONE"))
|
||||
|
||||
# 18. Component render dispatch
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*))
|
||||
(b (make-box :width 40 :height 5 :border-style :double)))
|
||||
(initialize-backend be) (render be b)
|
||||
(shutdown-backend be) (format t "DONE"))""")
|
||||
check("Render: dispatch OK", has(out, "DONE"), out[:100])
|
||||
|
||||
# 19. Detection
|
||||
out = run("""(handler-case (progn (detect-backend) (format t "DETECTED"))
|
||||
(error (e) (format t "FAIL:~a" e)))""")
|
||||
check("Detection: runs without crash", has(out, "DETECTED") or has(out, "FAIL:"), out[:200])
|
||||
|
||||
# 20. Backend capabilities
|
||||
out = run("""(let ((be (make-simple-backend :output-stream *standard-output*)))
|
||||
(format t "SGR:~a COLOR:~a MOUSE:~a"
|
||||
(capable-p be :sgr) (capable-p be :truecolor) (capable-p be :mouse))
|
||||
(format t " DONE"))""")
|
||||
check("Capabilities: runs", has(out, "SGR:") or has(out, "capable"), out[:200])
|
||||
check("Capabilities: DONE", has(out, "DONE"))
|
||||
|
||||
# SUMMARY
|
||||
print(f"\n{'='*60}")
|
||||
print(f"Results: {PASS} passed, {FAIL} failed, {PASS+FAIL} total")
|
||||
sys.exit(FAIL > 0)
|
||||
182
scripts/verify-demo-pty.py
Executable file
182
scripts/verify-demo-pty.py
Executable file
@@ -0,0 +1,182 @@
|
||||
#!/usr/bin/env python3
|
||||
"""PTY-based interactive test for cl-tty demo.
|
||||
|
||||
Spawns the demo inside a real PTY, sends keystrokes, captures output,
|
||||
and verifies expected behavior. Exits with status 0 if all checks pass,
|
||||
non-zero otherwise.
|
||||
"""
|
||||
|
||||
import pty
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
import select
|
||||
import re
|
||||
import subprocess
|
||||
|
||||
PASS = 0
|
||||
FAIL = 0
|
||||
|
||||
def check(name, condition, detail=""):
|
||||
global PASS, FAIL
|
||||
if condition:
|
||||
PASS += 1
|
||||
print(f" OK {name}")
|
||||
else:
|
||||
FAIL += 1
|
||||
print(f" FAIL {name}" + (f" ({detail})" if detail else ""))
|
||||
|
||||
def spawn_demo():
|
||||
"""Fork PTY, exec demo.sh, return (pid, fd).
|
||||
Blocks 1s for demo to start and enter its event loop."""
|
||||
pid, fd = pty.fork()
|
||||
if pid == 0:
|
||||
os.chdir("/mnt/hermes/projects/cl-tty")
|
||||
os.execve("./demo.sh", ["./demo.sh"], {"TERM": "xterm-256color"})
|
||||
os._exit(1)
|
||||
time.sleep(1.0)
|
||||
return pid, fd
|
||||
|
||||
def read_all(fd, timeout=0.5):
|
||||
"""Drain all available output from fd within timeout."""
|
||||
data = b""
|
||||
deadline = time.time() + timeout
|
||||
while time.time() < deadline:
|
||||
r, _, _ = select.select([fd], [], [], max(0, deadline - time.time()))
|
||||
if r:
|
||||
try:
|
||||
chunk = os.read(fd, 65536)
|
||||
if not chunk:
|
||||
break
|
||||
data += chunk
|
||||
except OSError:
|
||||
break
|
||||
else:
|
||||
break
|
||||
return data
|
||||
|
||||
def strip_escapes(data):
|
||||
"""Strip ANSI escape sequences, keep visible text."""
|
||||
text = data.decode("latin-1")
|
||||
text = re.sub(r'\x1b\[[0-9;]*[a-zA-Z]', '', text)
|
||||
text = re.sub(r'\x1b\][0-9;]*[a-zA-Z].*?\x07', '', text)
|
||||
text = re.sub(r'\x1b[()][0-9A-Z]', '', text)
|
||||
text = re.sub(r'\x1b', '', text)
|
||||
text = re.sub(r'[\x00-\x08\x0b\x0c\x0e-\x1f]', '', text)
|
||||
return text
|
||||
|
||||
def has_text(data, *patterns):
|
||||
text = strip_escapes(data)
|
||||
return all(p in text for p in patterns)
|
||||
|
||||
def last_event_count(data):
|
||||
"""Extract the last event count from output like 'Tab N/3 | M events'."""
|
||||
text = strip_escapes(data)
|
||||
matches = re.findall(r'Tab \d+/\d+ \| (\d+) events?', text)
|
||||
if matches:
|
||||
return int(matches[-1])
|
||||
return None
|
||||
|
||||
def last_tab_index(data):
|
||||
"""Extract the last tab index from output like 'Tab N/3'."""
|
||||
text = strip_escapes(data)
|
||||
matches = re.findall(r'Tab (\d+)/', text)
|
||||
if matches:
|
||||
return int(matches[-1])
|
||||
return None
|
||||
|
||||
# ── Test 1: Demo renders correctly on startup ──
|
||||
print("\n[Test 1] Demo renders correctly on startup")
|
||||
pid, fd = spawn_demo()
|
||||
output = read_all(fd, 0.5)
|
||||
os.close(fd)
|
||||
os.waitpid(pid, 0)
|
||||
|
||||
size = len(output)
|
||||
check("Output is non-empty", size > 100, f"got {size} bytes")
|
||||
check("Shows title 'cl-tty'", has_text(output, "cl-tty"))
|
||||
check("Shows component list", has_text(output, "TextInput"))
|
||||
check("Shows test count", has_text(output, "483"))
|
||||
check("Shows controls help", has_text(output, "Ctrl+C"))
|
||||
check("Shows tab bar items", has_text(output, "Home"))
|
||||
check("Shows Console tab", has_text(output, "Console"))
|
||||
check("Starts with 1 event (init log)", last_event_count(output) == 1,
|
||||
f"got {last_event_count(output)}")
|
||||
|
||||
# ── Test 2: Escape key quits the demo ──
|
||||
print("\n[Test 2] Escape key quits the demo")
|
||||
pid, fd = spawn_demo()
|
||||
os.write(fd, b"\x1b")
|
||||
output = read_all(fd, 1.0)
|
||||
os.close(fd)
|
||||
os.waitpid(pid, 0)
|
||||
check("Escape produces output", len(output) > 50, f"got {len(output)} bytes")
|
||||
# After escape, the demo sets running=nil immediately after logging.
|
||||
# The last rendered frame may still show count 1.
|
||||
# Key check: no busy-spin.
|
||||
check("No busy-spin with Escape", len(output) < 50000, f"got {len(output)} bytes")
|
||||
|
||||
# ── Test 3: Tab switches to next tab ──
|
||||
print("\n[Test 3] Tab key switches tab")
|
||||
pid, fd = spawn_demo()
|
||||
os.write(fd, b"\x09") # Tab key
|
||||
time.sleep(1.0)
|
||||
os.write(fd, b"\x09") # Tab again to trigger another render
|
||||
time.sleep(1.0)
|
||||
output = read_all(fd, 0.5)
|
||||
os.close(fd)
|
||||
os.waitpid(pid, 0)
|
||||
count = last_event_count(output)
|
||||
tab = last_tab_index(output)
|
||||
check("Events were logged", count is not None and count >= 2,
|
||||
f"last count: {count}")
|
||||
check("Tab switched from 1", tab is not None and tab > 1,
|
||||
f"last tab: {tab}")
|
||||
|
||||
# ── Test 4: 'q' types into text input, does not quit ──
|
||||
print("\n[Test 4] 'q' does NOT quit, types into text input instead")
|
||||
pid, fd = spawn_demo()
|
||||
os.write(fd, b"q")
|
||||
time.sleep(0.5)
|
||||
os.write(fd, b"a")
|
||||
time.sleep(1.0)
|
||||
output = read_all(fd, 0.5)
|
||||
os.close(fd)
|
||||
os.waitpid(pid, 0)
|
||||
count = last_event_count(output)
|
||||
check("Events were logged ('q' + 'a')", count is not None and count >= 3,
|
||||
f"last count: {count}")
|
||||
check("Demo still running after 'q' (no busy-spin)", len(output) < 50000,
|
||||
f"got {len(output)} bytes")
|
||||
|
||||
# ── Test 5: Ctrl+C quits the demo ──
|
||||
print("\n[Test 5] Ctrl+C quits the demo")
|
||||
pid, fd = spawn_demo()
|
||||
os.write(fd, b"\x03") # Ctrl+C
|
||||
output = read_all(fd, 1.0)
|
||||
os.close(fd)
|
||||
os.waitpid(pid, 0)
|
||||
check("Ctrl+C produces output", len(output) > 50, f"got {len(output)} bytes")
|
||||
|
||||
# ── Test 6: EOF on stdin quits cleanly ──
|
||||
print("\n[Test 6] EOF on stdin quits cleanly (no busy-spin)")
|
||||
result = subprocess.run(
|
||||
["timeout", "5", "bash", "-c",
|
||||
"cd /mnt/hermes/projects/cl-tty && exec sbcl --noinform --script demo.lisp < /dev/null"],
|
||||
capture_output=True, timeout=10
|
||||
)
|
||||
eof_output = result.stdout + result.stderr
|
||||
check("EOF exits quickly (not killed by timeout)",
|
||||
result.returncode == 0,
|
||||
f"exit code: {result.returncode}")
|
||||
check("No busy-spin on EOF", len(eof_output) < 50000,
|
||||
f"got {len(eof_output)} bytes")
|
||||
|
||||
# ── Summary ──
|
||||
print(f"\n{'='*50}")
|
||||
print(f"Results: {PASS} passed, {FAIL} failed, {PASS+FAIL} total")
|
||||
if FAIL == 0:
|
||||
print("ALL CHECKS PASSED")
|
||||
else:
|
||||
print("SOME CHECKS FAILED")
|
||||
sys.exit(FAIL > 0)
|
||||
@@ -1,166 +0,0 @@
|
||||
(defpackage :cl-tui-box-test
|
||||
(:use :cl :fiveam :cl-tui.backend :cl-tui.layout :cl-tui.box)
|
||||
(:export #:run-tests))
|
||||
(in-package :cl-tui-box-test)
|
||||
|
||||
(def-suite box-suite :description "Box renderable tests")
|
||||
(in-suite box-suite)
|
||||
|
||||
(defun run-tests ()
|
||||
(let ((result (run 'box-suite)))
|
||||
(fiveam:explain! result)
|
||||
(uiop:quit 0)))
|
||||
|
||||
(defun make-capturing-backend ()
|
||||
(let* ((s (make-string-output-stream))
|
||||
(b (make-modern-backend :output-stream s)))
|
||||
(values b s)))
|
||||
|
||||
;; ── Box Tests ─────────────────────────────────────────────────
|
||||
|
||||
(test box-creates-with-defaults
|
||||
"A box created with no arguments has reasonable defaults"
|
||||
(let ((b (make-box)))
|
||||
(is (typep b 'box))
|
||||
(is (typep (box-layout-node b) 'layout-node))))
|
||||
|
||||
(test box-renders-border
|
||||
"A box with border draws border characters"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 10 :height 5)))
|
||||
(compute-layout (box-layout-node bx) 10 5)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "┌" out) "top-left corner")
|
||||
(is (search "┐" out) "top-right corner")
|
||||
(is (search "└" out) "bottom-left corner")
|
||||
(is (search "┘" out) "bottom-right corner")))))
|
||||
|
||||
(test box-renders-background
|
||||
"A box with background color fills interior"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :bg :red :width 5 :height 3)))
|
||||
(compute-layout (box-layout-node bx) 5 3)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "┌" out) "border with background")
|
||||
(is (search "41m" out) "SGR background for red")))))
|
||||
|
||||
(test box-renders-title
|
||||
"A box with title renders the title text"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :title "Hello" :width 12 :height 3)))
|
||||
(compute-layout (box-layout-node bx) 12 3)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "title text should appear")))))
|
||||
|
||||
(test box-without-border
|
||||
"A box with border-style nil draws no border"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style nil :bg :red :width 5 :height 3)))
|
||||
(compute-layout (box-layout-node bx) 5 3)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "41m" out) "background still renders")
|
||||
(is-false (search "┌" out) "no top-left corner")))))
|
||||
|
||||
(test box-zero-size
|
||||
"A box with any zero dimension renders nothing"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 0 :height 0)))
|
||||
(compute-layout (box-layout-node bx) 0 0)
|
||||
(render-box bx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"zero-size box produces no output"))))
|
||||
|
||||
(test box-single-column
|
||||
"A box with width 1 renders nothing (needs min 2 for border)"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 1 :height 5)))
|
||||
(compute-layout (box-layout-node bx) 1 5)
|
||||
(render-box bx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"width=1 box renders nothing"))))
|
||||
|
||||
(test box-minimum-size
|
||||
"A box with minimum non-zero size still renders"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((bx (make-box :border-style :single :width 2 :height 2)))
|
||||
(compute-layout (box-layout-node bx) 2 2)
|
||||
(render-box bx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "┌" out) "2x2 box still has borders")))))
|
||||
|
||||
;; ── Text and Span Tests ───────────────────────────────────────
|
||||
|
||||
(test text-creates-with-defaults
|
||||
"A text created with no arguments has reasonable defaults"
|
||||
(let ((txt (make-text "")))
|
||||
(is (typep txt 'text))
|
||||
(is (typep (text-layout-node txt) 'layout-node))))
|
||||
|
||||
(test text-renders-content
|
||||
"A text renders its content at position"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello" :width 10 :height 1)))
|
||||
(compute-layout (text-layout-node tx) 10 1)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "content should appear")))))
|
||||
|
||||
(test text-empty-string
|
||||
"Empty text produces no output"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "" :width 10 :height 1)))
|
||||
(compute-layout (text-layout-node tx) 10 1)
|
||||
(render-text tx b)
|
||||
(is (string= (get-output-stream-string s) "")
|
||||
"empty string produces no output"))))
|
||||
|
||||
(test text-truncates-when-no-wrap
|
||||
"Text with wrap-mode :none truncates at width"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello World" :width 5 :height 1
|
||||
:wrap-mode :none)))
|
||||
(compute-layout (text-layout-node tx) 5 1)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "truncated to first 5 chars")))))
|
||||
|
||||
(test text-word-wraps
|
||||
"Text with wrap-mode :word wraps at word boundaries"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello brave new world" :width 6 :height 3)))
|
||||
(compute-layout (text-layout-node tx) 6 3)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hello" out) "first line")
|
||||
(is (search "brave" out) "second line")
|
||||
(is (search "new" out) "third line")))))
|
||||
|
||||
(test text-word-wrap-single-word
|
||||
"A word longer than width is hard-broken at max-width"
|
||||
(multiple-value-bind (b s) (make-capturing-backend)
|
||||
(let ((tx (make-text "Hello" :width 3 :height 3)))
|
||||
(compute-layout (text-layout-node tx) 3 3)
|
||||
(render-text tx b)
|
||||
(let ((out (get-output-stream-string s)))
|
||||
(is (search "Hel" out) "first chunk is Hel")
|
||||
(is (search "lo" out) "second chunk is lo")))))
|
||||
|
||||
(test span-creates-with-attributes
|
||||
"A span has text and optional style attributes"
|
||||
(let ((s (span "bold text" :bold t)))
|
||||
(is (string= (span-text s) "bold text"))
|
||||
(is-true (span-bold s))
|
||||
(is-false (span-italic s))))
|
||||
|
||||
(test make-text-with-spans
|
||||
"Text with spans stores span objects"
|
||||
(let* ((sp (list (span "Hello" :bold t)
|
||||
(span "World" :italic t)))
|
||||
(tx (make-text "" :spans sp)))
|
||||
(is (= (length (text-spans tx)) 2))
|
||||
(is (string= (span-text (elt (text-spans tx) 0)) "Hello"))
|
||||
(is-true (span-bold (elt (text-spans tx) 0)))))
|
||||
@@ -1,54 +0,0 @@
|
||||
(in-package :cl-tui.box)
|
||||
|
||||
(defclass box ()
|
||||
((layout-node :initform (make-layout-node) :accessor box-layout-node
|
||||
:initarg :layout-node)
|
||||
(border-style :initform :single :initarg :border-style
|
||||
:accessor box-border-style)
|
||||
(title :initform nil :initarg :title :accessor box-title)
|
||||
(title-align :initform :left :initarg :title-align
|
||||
:accessor box-title-align)
|
||||
(fg :initform nil :initarg :fg :accessor box-fg)
|
||||
(bg :initform nil :initarg :bg :accessor box-bg)))
|
||||
|
||||
(defun make-box (&key (border-style :single) title
|
||||
(title-align :left) fg bg
|
||||
width height)
|
||||
(make-instance 'box
|
||||
:border-style border-style
|
||||
:title title
|
||||
:title-align title-align
|
||||
:fg fg
|
||||
:bg bg
|
||||
:layout-node (make-layout-node
|
||||
:width width
|
||||
:height height
|
||||
:direction :column)))
|
||||
|
||||
(defun render-box (box backend)
|
||||
"Render BOX at its computed layout position using BACKEND."
|
||||
(let ((ln (box-layout-node box))
|
||||
(bs (box-border-style box))
|
||||
(title (box-title box))
|
||||
(fg (box-fg box))
|
||||
(bg (box-bg box)))
|
||||
(let ((x (layout-node-x ln))
|
||||
(y (layout-node-y ln))
|
||||
(w (layout-node-width ln))
|
||||
(h (layout-node-height ln)))
|
||||
(when (or (zerop w) (zerop h) (< w 2) (< h 2))
|
||||
(return-from render-box (values)))
|
||||
(when bg
|
||||
(draw-rect backend x y w h :bg bg))
|
||||
(when bs
|
||||
(draw-border backend x y w h :style bs :fg fg :bg bg))
|
||||
(when title
|
||||
(let* ((content-w (- w 4))
|
||||
(tx (+ x 2))
|
||||
(ty (+ y (if bs 1 0)))
|
||||
(ta (box-title-align box))
|
||||
(display (subseq title 0 (min (length title) content-w))))
|
||||
(case ta
|
||||
(:center (draw-text backend (+ x (ceiling (- w (length display)) 2)) ty display fg bg))
|
||||
(:right (draw-text backend (+ x (- w (length display) 2)) ty display fg bg))
|
||||
(t (draw-text backend tx ty display fg bg))))))))
|
||||
@@ -1,20 +0,0 @@
|
||||
;; Dirty tracking tests are in box-tests.lisp (same test suite)
|
||||
(in-package :cl-tui-box-test)
|
||||
|
||||
(test dirty-mixin-default-is-dirty
|
||||
"A dirty-mixin starts as dirty"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(is-true (dirty-p c) "new component should be dirty")))
|
||||
|
||||
(test mark-clean-clears-dirty
|
||||
"mark-clean sets dirty to nil"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(mark-clean c)
|
||||
(is-false (dirty-p c) "after mark-clean, should not be dirty")))
|
||||
|
||||
(test mark-dirty-sets-dirty
|
||||
"mark-dirty sets dirty to t"
|
||||
(let ((c (make-instance 'dirty-mixin)))
|
||||
(mark-clean c)
|
||||
(mark-dirty c)
|
||||
(is-true (dirty-p c) "after mark-dirty, should be dirty again")))
|
||||
@@ -1,14 +0,0 @@
|
||||
(in-package :cl-tui.box)
|
||||
|
||||
;; ── Dirty Tracking ─────────────────────────────────────────────
|
||||
|
||||
(defclass dirty-mixin ()
|
||||
((dirty :initform t :accessor dirty-p)))
|
||||
|
||||
(defgeneric mark-clean (component)
|
||||
(:method ((c dirty-mixin))
|
||||
(setf (dirty-p c) nil)))
|
||||
|
||||
(defgeneric mark-dirty (component)
|
||||
(:method ((c dirty-mixin))
|
||||
(setf (dirty-p c) t)))
|
||||
@@ -1,23 +0,0 @@
|
||||
(defpackage :cl-tui.box
|
||||
(:use :cl :cl-tui.backend :cl-tui.layout)
|
||||
(:export
|
||||
;; Box
|
||||
#:box #:make-box
|
||||
#:box-layout-node
|
||||
#:box-border-style #:box-title #:box-title-align
|
||||
#:box-fg #:box-bg
|
||||
#:render-box
|
||||
;; Span
|
||||
#:span
|
||||
#:span-text #:span-bold #:span-italic #:span-underline
|
||||
#:span-reverse #:span-dim #:span-fg #:span-bg
|
||||
;; Text
|
||||
#:text #:make-text
|
||||
#:text-layout-node #:text-content #:text-spans
|
||||
#:text-fg #:text-bg #:text-wrap-mode
|
||||
#:render-text
|
||||
;; Utilities (for tests)
|
||||
#:word-wrap #:split-string
|
||||
;; Dirty tracking
|
||||
#:dirty-mixin #:dirty-p #:mark-clean #:mark-dirty))
|
||||
(in-package :cl-tui.box)
|
||||
@@ -1,106 +0,0 @@
|
||||
(in-package :cl-tui.box)
|
||||
|
||||
;; ── Text Renderable ────────────────────────────────────────────
|
||||
|
||||
(defclass span ()
|
||||
((text :initarg :text :accessor span-text)
|
||||
(bold :initform nil :initarg :bold :accessor span-bold)
|
||||
(italic :initform nil :initarg :italic :accessor span-italic)
|
||||
(underline :initform nil :initarg :underline :accessor span-underline)
|
||||
(reverse :initform nil :initarg :reverse :accessor span-reverse)
|
||||
(dim :initform nil :initarg :dim :accessor span-dim)
|
||||
(fg :initform nil :initarg :fg :accessor span-fg)
|
||||
(bg :initform nil :initarg :bg :accessor span-bg)))
|
||||
|
||||
(defun span (text &key bold italic underline reverse dim fg bg)
|
||||
(make-instance 'span
|
||||
:text text :bold bold :italic italic
|
||||
:underline underline :reverse reverse :dim dim
|
||||
:fg fg :bg bg))
|
||||
|
||||
(defclass text ()
|
||||
((layout-node :initform (make-layout-node) :accessor text-layout-node
|
||||
:initarg :layout-node)
|
||||
(content :initform "" :initarg :content :accessor text-content)
|
||||
(spans :initform nil :initarg :spans :accessor text-spans)
|
||||
(fg :initform nil :initarg :fg :accessor text-fg)
|
||||
(bg :initform nil :initarg :bg :accessor text-bg)
|
||||
(wrap-mode :initform :word :initarg :wrap-mode :accessor text-wrap-mode)))
|
||||
|
||||
(defun make-text (content &key fg bg wrap-mode width height spans)
|
||||
(make-instance 'text
|
||||
:content content
|
||||
:fg fg :bg bg
|
||||
:wrap-mode (or wrap-mode :word)
|
||||
:spans spans
|
||||
:layout-node (make-layout-node :direction :column
|
||||
:width width :height height)))
|
||||
|
||||
(defun render-text (text-object backend)
|
||||
"Render TEXT-OBJECT at its computed layout position using BACKEND."
|
||||
(let ((ln (text-layout-node text-object))
|
||||
(content (text-content text-object))
|
||||
(fg (text-fg text-object))
|
||||
(bg (text-bg text-object))
|
||||
(wrap (text-wrap-mode text-object))
|
||||
(spans (text-spans text-object)))
|
||||
(declare (ignore spans))
|
||||
(let ((x (layout-node-x ln))
|
||||
(y (layout-node-y ln))
|
||||
(w (layout-node-width ln))
|
||||
(h (layout-node-height ln)))
|
||||
(when (or (zerop (length content)) (zerop w) (zerop h))
|
||||
(return-from render-text (values)))
|
||||
(if (eql wrap :none)
|
||||
(let ((display (subseq content 0 (min (length content) w))))
|
||||
(draw-text backend x y display fg bg))
|
||||
(let ((lines (word-wrap content w))
|
||||
(max-lines h))
|
||||
(loop for line in lines
|
||||
for row from 0 below max-lines
|
||||
do (draw-text backend x (+ y row) line fg bg)))))))
|
||||
|
||||
(defun word-wrap (text max-width)
|
||||
"Split TEXT into lines, each <= MAX-WIDTH chars.
|
||||
Breaks at word boundaries. Words exceeding MAX-WIDTH are hard-broken."
|
||||
(if (or (zerop max-width) (zerop (length text)))
|
||||
(list "")
|
||||
(let ((words (split-string text)) (lines nil) (current nil) (current-len 0))
|
||||
(dolist (word words)
|
||||
(let ((wl (length word)))
|
||||
(cond ((<= wl max-width)
|
||||
(if (and current (<= (+ current-len 1 wl) max-width))
|
||||
(push word current)
|
||||
(progn
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines))
|
||||
(setf current (list word))
|
||||
(setf current-len wl))))
|
||||
(t
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines)
|
||||
(setf current nil)
|
||||
(setf current-len 0))
|
||||
(loop for i from 0 below wl by max-width
|
||||
do (push (subseq word i (min (+ i max-width) wl)) lines))))))
|
||||
(when current
|
||||
(push (format nil "~{~A~^ ~}" (nreverse current)) lines))
|
||||
(or (nreverse lines) (list "")))))
|
||||
|
||||
(defun split-string (string)
|
||||
"Split STRING into words separated by whitespace."
|
||||
(loop with words = nil
|
||||
with start = 0
|
||||
with len = (length string)
|
||||
while (< start len)
|
||||
do (let ((ws-start (position-if (lambda (c) (find c '(#\Space #\Tab #\Newline)))
|
||||
string :start start)))
|
||||
(if ws-start
|
||||
(progn
|
||||
(when (> ws-start start)
|
||||
(push (subseq string start ws-start) words))
|
||||
(setf start (1+ ws-start)))
|
||||
(progn
|
||||
(push (subseq string start) words)
|
||||
(setf start len))))
|
||||
finally (return (nreverse words))))
|
||||
Reference in New Issue
Block a user