1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
|
#!/usr/bin/env python3
"""Record the documentation site's clips and theme shots from a hidden window.
zig build -Dplatform=gui -Doptimize=ReleaseSafe --prefix <scratch dir>
python3 -B test/record_demos.py <scratch dir>/bin/pardes-gui [clip ... | themes]
Each clip drives a throwaway session (PARDES_TEST: an offscreen capture,
the virtual clock) through its stdin's window-pixel mouse events, its keys
and its 9P files, keeps the settled frame after every step, and lays the
frames out on a timeline with a drawn pointer: a click glides there,
stops, and presses and releases still, a ring and the button's name drawn.
ffmpeg encodes the timeline to docs/site/media/<clip>.webm and .mp4, with
<clip>.png as its poster and captions.txt beside them (clips.toml, which
the site reads, is kept by hand). `themes` instead writes
docs/site/media/themes/<theme>.png for each theme of src/themes, in the
Themes builtin's order, and themes.toml.
Needs a Wayland display for the hidden window, gcc and git for the demo
project, 9ns (cloud9) for the scripting clip, Pillow and numpy, and the
Intel SDM vol. 2 for the PDF clips (--pdf; read where it is, never copied).
Frames and the intermediate video go under --work (default
../.scratch/rec/work, beside the checkout). The demo project lives at
/tmp/hello, a short path for the tags, and the session's home at
/tmp/pardes-rec-home; both are removed after. Nothing of the caller's
environment that names a session, a mount or a bus reaches the recording.
"""
import argparse
import contextlib
import fcntl
import json
import os
from pathlib import Path
import shutil
import signal
import struct
import subprocess
import sys
import termios
import threading
import time
from PIL import Image, ImageDraw, ImageFont
sys.path.insert(0, str(Path(__file__).resolve().parent))
from ninep import Client # noqa: E402
REPO = Path(__file__).resolve().parent.parent
MEDIA = REPO / 'docs/site/media'
BADGE_FONT = REPO / 'assets/AdwaitaMono-Regular.ttf'
FPS = 30
COLS, ROWS = 60, 20
# A test window's text is 27 px (16 px cells); tags draw at 82% of it
# (config.gui_tagline_font_percent), 13 px a character.
TAG_W = 13
# acme's pale yellow and blue read at the size a landing page shows a clip,
# and are the site's own colours.
THEME = ['acme']
WIDTH = 960 # the clips' width: the window's own, never scaled
PROJECT = Path('/tmp/hello')
HOME = Path('/tmp/pardes-rec-home')
# Nothing of the caller's session reaches the recording: no live pardes,
# no mount, no bus, no editor.
SCRUB = ('NINE_MOUNT', 'NAMESPACE', 'DBUS_SESSION_BUS_ADDRESS', 'GIT_EDITOR', 'EDITOR', 'VISUAL', 'PAGER',
'GIT_PAGER', 'MANPAGER', 'LESS', 'PROMPT_COMMAND', 'ENV', 'BASH_ENV', 'TMUX', 'ZMX_SESSION')
def clean_env():
env = {k: v for k, v in os.environ.items() if not k.startswith('PARDES_') and k not in SCRUB}
display = Path(os.environ.get('WAYLAND_DISPLAY', 'wayland-0'))
if not display.is_absolute():
display = Path(os.environ.get('XDG_RUNTIME_DIR', '/run/user/%d' % os.getuid())) / display
env.update(WAYLAND_DISPLAY=str(display), SDL_VIDEODRIVER='wayland', TERM='xterm-256color',
LANG='C.UTF-8', LC_ALL='C.UTF-8', GIT_AUTHOR_DATE='2026-09-30T12:00:00', GIT_COMMITTER_DATE='2026-09-30T12:00:00')
return env
MAIN_C = '''#include <stdio.h>
static int square(int n)
{
return n * n;
}
int main(void)
{
int sum = 0;
for (int i = 1; i <= 4; i++) sum += square(i);
pritnf("sum: %d\\n", sum);
return 0;
}
'''
README = '''hello: prints the sum of the first four squares.
Build it with make, run it with ./hello.
'''
MAKEFILE = '''CFLAGS = -Wall -fno-diagnostics-show-caret -fno-diagnostics-show-option
hello: src/main.c
\t@cc $(CFLAGS) -o hello src/main.c
'''
def make_project():
shutil.rmtree(PROJECT, ignore_errors=True)
(PROJECT / 'src').mkdir(parents=True)
(PROJECT / 'src/main.c').write_text(MAIN_C)
(PROJECT / 'Makefile').write_text(MAKEFILE)
(PROJECT / 'README').write_text(README)
(PROJECT / 'notes.txt').write_text(NOTES)
class Session:
"""A hidden pardes-gui window, its capture directory, its 9P client."""
def __init__(self, binary, work, name, args, init='', cols=COLS, rows=ROWS):
self.binary, self.work, self.name = Path(binary).resolve(), work, name
self.cols, self.rows = cols, rows
self.caps = work / 'cap'
self.frames = work / 'frames'
for d in (self.caps, self.frames):
shutil.rmtree(d, ignore_errors=True)
d.mkdir(parents=True)
shutil.rmtree(HOME, ignore_errors=True)
HOME.mkdir(mode=0o700)
(HOME / 'config/pardes').mkdir(parents=True)
theme = '' if THEME[0] == 'default' else f'Theme {THEME[0]}\n'
(HOME / 'config/pardes/init').write_text('Shell /bin/sh\n' + theme + 'MessageLinger 0\n' + init)
env = clean_env()
env.update(HOME=str(HOME), XDG_RUNTIME_DIR=str(HOME), XDG_CONFIG_HOME=str(HOME / 'config'),
PARDES_NOTIME='1', PARDES_DUMP=str(HOME / 'demo.dump.zon'),
PARDES_TEST='1', PARDES_TEST_CLOCK='1', PARDES_TEST_COLS=str(cols), PARDES_TEST_ROWS=str(rows),
PARDES_TEST_CAPTURE_DIR=str(self.caps))
for language in ['RS', 'C', 'GO', 'TS', 'PY', 'ZIG']:
env['PARDES_LSP_' + language] = ''
master, slave = os.openpty()
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack('HHHH', rows, cols, 0, 0))
self.master = master
self.child = subprocess.Popen(
[str(self.binary), '--9p=' + name, *map(str, args)], cwd=PROJECT, env=env,
stdin=slave, stdout=slave, stderr=open(work / 'stderr.log', 'wb'), start_new_session=True,
preexec_fn=lambda: fcntl.ioctl(0, termios.TIOCSCTTY, 0))
os.close(slave)
self.reader = threading.Thread(target=self._drain, daemon=True)
self.reader.start()
address = HOME / f'pardes-9p-{name}.sock'
deadline = time.monotonic() + 30
while not address.exists():
if self.child.poll() is not None or time.monotonic() > deadline:
raise RuntimeError('session did not start; see ' + str(work / 'stderr.log'))
time.sleep(.01)
self.client = Client(str(address))
self.client.__enter__()
self.shots = [] # the timeline: see shot()
self.pointer = None # the drawn pointer's (x, y), None for none
self.button = None # the SDL button held, drawn as a ring and its name
self.badge = None # a key or two, drawn in the corner
self.held = [] # the buttons a chord holds, each drawn as a ring and on a mouse
self.settle()
def _drain(self):
try:
while os.read(self.master, 65536):
pass
except OSError:
pass
def close(self):
with contextlib.suppress(Exception):
self.client.__exit__(None, None, None)
if self.child.poll() is None:
self.child.terminate()
try:
self.child.wait(timeout=10)
except subprocess.TimeoutExpired:
self.child.kill()
self.child.wait()
# The session's own process group: its shells and their children.
with contextlib.suppress(ProcessLookupError, PermissionError):
os.killpg(self.child.pid, signal.SIGKILL)
with contextlib.suppress(OSError):
os.close(self.master)
self.reader.join(timeout=2)
# 9P
def read(self, path):
return self.client.read(path).decode(errors='replace')
def write(self, path, data):
self.client.write(path, data.encode() if isinstance(data, str) else data)
def panes(self):
return {int(r.split()[0]): r.split()[1] for r in self.read('/index').splitlines() if r.strip()}
def tag(self, serial):
return self.read(f'/pane/{serial}/tag')
def screen(self):
s = json.loads(self.client.read('/screen'))
cols = s['cols']
return [''.join((cell[0] or ' ') for cell in s['cells'][r * cols:(r + 1) * cols]) for r in range(s['rows'])]
def find(self, text, after=0, nth=0):
"""The (col, row) of `text` on screen, searching rows from `after`."""
for r, line in enumerate(self.screen()):
if r < after:
continue
at = line.find(text)
while at >= 0:
if nth == 0:
return at, r
nth -= 1
at = line.find(text, at + 1)
raise LookupError(f'{text!r} not on screen:\n' + '\n'.join(self.screen()))
def terminal_rows(self):
"""The screen's rows below the (one) terminal's tag."""
rows = self.screen()
return rows[next(i for i, line in enumerate(rows) if 'Tty+sh' in line) + 1:]
def wait(self, predicate, what, seconds=20):
deadline = time.monotonic() + seconds
while time.monotonic() < deadline:
with contextlib.suppress(Exception):
if predicate():
return
time.sleep(.03)
raise RuntimeError('timed out waiting for ' + what + '\n' + '\n'.join(self.screen()))
def wait_text(self, text, seconds=20):
self.wait(lambda: any(text in line for line in self.screen()), repr(text), seconds)
# the window
def cell_px(self, col, row):
"""The pixel at the middle of a cell (the window is an exact grid)."""
w, h = self.size()
cw, ch = w / self.cols, h / self.rows
return int((col + .5) * cw), int((row + .55) * ch)
def tag_px(self, col, row, start=3, offset=.5):
"""The pixel over a tag's character: a tag is drawn in the tagline
font, narrower than the grid, from its first column `start` (3 in a
pane's or column's tag, 0 in the workspace's)."""
w, h = self.size()
cw, ch = w / self.cols, h / self.rows
return int(start * cw + (col - start + offset) * TAG_W), int((row + .55) * ch)
def tag_word(self, serial, word):
"""The pixel over the middle of `word` in pane `serial`'s tag, which
may run past the grid's columns (/screen cuts a tag at its width,
the window wraps it at its own): its rows hold (width - 3 cells) /
TAG_W characters each."""
tag = self.tag(serial)
w, h = self.size()
cw, ch = w / self.cols, h / self.rows
per_row = int((w - 3 * cw) // TAG_W)
top = self.find(tag[:min(len(tag), self.cols - 4)], 0)[1]
at = tag.index(word) + len(word) // 2
return int(3 * cw + (at % per_row + .5) * TAG_W), int((top + at // per_row + .55) * ch)
def size(self):
with open(self.caps / 'latest.ppm', 'rb') as f:
f.readline()
w, h = map(int, f.readline().split())
return w, h
def mouse(self, kind, button, x, y):
os.write(self.master, f'\x1b]777;mouse;{kind};{button};{x};{y}\x07'.encode())
time.sleep(.05)
def keys(self, data):
os.write(self.master, data.encode() if isinstance(data, str) else data)
time.sleep(.03)
def status(self):
try:
step, frames, idle = (self.caps / 'status').read_text().split()[:3]
return int(step), int(frames), idle == '1'
except (FileNotFoundError, ValueError):
return None
def settle(self):
"""The frame once the window says it is idle (test/gui_golden.py)."""
deadline = time.monotonic() + 60
start = None
while time.monotonic() < deadline:
now = self.status()
if now is not None:
if start is None:
start = now[0]
elif now[0] >= start + 2 and now[2] and now[1] > 0:
data = (self.caps / 'latest.ppm').read_bytes()
if data.startswith(b'P6'):
return data
time.sleep(.02)
raise RuntimeError('the window never went idle')
# the timeline
def shot(self, seconds, poster=False, ring=None, ring_button=None):
"""Hold the settled frame for `seconds`, the pointer where it is.
`poster` marks the frame drawn as the clip's still; `ring` draws a
click there ('press' while held, 'pulse' just after)."""
data = self.settle()
path = self.frames / f'{len(self.shots):04d}.ppm'
path.write_bytes(data)
self.shots.append(dict(frame=path, secs=seconds, start=self.pointer, end=self.pointer,
button=self.button, badge=self.badge, poster=poster, ring=ring,
ring_button=ring_button or self.button, held=tuple(self.held)))
def glide(self, x, y, seconds=.6):
"""Glide the drawn pointer to (x, y) over the frame on screen, then
move the window's pointer there (dragging any button held)."""
if self.shots and self.pointer is not None:
last = self.shots[-1]
self.shots.append(dict(last, secs=seconds, start=self.pointer, end=(x, y), poster=False, ring=None,
held=tuple(self.held)))
self.pointer = (x, y)
self.mouse('motion', self.button or (self.held[0] if self.held else 0), x, y)
def chord_press(self, x, y, rest=.4, hold=.5):
"""Glide to (x, y), stop, and press B1 there, holding it."""
if self.pointer != (x, y):
self.glide(x, y)
self.shot(rest)
self.mouse('down', 1, x, y)
self.held = [1]
self.shot(hold)
def chord_click(self, button, done, what, hold=.45, after=1.0):
"""With B1 held and the pointer still, click `button`: both rings
and the mouse's two buttons lit on the press, then a pulse."""
self.mouse('down', button, *self.pointer)
self.held.append(button)
self.shot(hold, ring='press', ring_button=button)
self.mouse('up', button, *self.pointer)
self.held.remove(button)
self.wait(done, what)
self.shot(after, ring='pulse', ring_button=button)
def chord_release(self, after=.6):
"""Let B1 go, the pointer still."""
self.mouse('up', 1, *self.pointer)
self.held = []
self.shot(after)
def click(self, button, x, y, done=None, what='the click', rest=.4, hold=.35, after=1.0):
"""Glide to (x, y) and stop; a beat later press `button` (SDL: 1
left, 2 middle, 3 right) and release it with the pointer still, a
ring and the button's name drawn on the press; once `done()` says
the click took, hold the result `after` seconds, the ring pulsing
out, before anything moves again."""
if self.pointer != (x, y):
self.glide(x, y)
self.shot(rest)
self.mouse('down', button, x, y)
self.button = button
self.shot(hold, ring='press')
self.mouse('up', button, x, y)
self.button = None
if done is not None:
self.wait(done, what)
self.shot(after, ring='pulse', ring_button=button)
def press(self, keys, per_key=.4):
"""Send each (key bytes, badge) of `keys`, a frame a key with the
badge in the corner."""
for key, badge in keys:
self.badge = badge
self.keys(key)
self.shot(per_key)
self.badge = None
def type(self, text, expect, per_key=.07):
"""Type `text` a key at a time, a frame per key, once `expect(prefix)`
says the window shows what is typed so far."""
for i, ch in enumerate(text):
self.keys(ch)
prefix = text[:i + 1]
self.wait(lambda: expect(prefix), 'echo of ' + repr(prefix))
self.shot(per_key)
# composing
def pointer_sprite(scale):
"""An arrow pointer, white with a dark outline, its hotspot at (1, 1)."""
pts = [(0, 0), (0, 17), (4, 13), (7, 20), (10, 19), (7, 12), (12, 12)]
pts = [(x * scale + 1, y * scale + 1) for x, y in pts]
im = Image.new('RGBA', (int(13 * scale) + 4, int(21 * scale) + 4), (0, 0, 0, 0))
ImageDraw.Draw(im).polygon(pts, fill=(255, 255, 255, 255), outline=(20, 20, 20, 255), width=2)
return im
# acme's colours for the buttons: B2 red, B3 green; B1, which acme leaves
# black, is blue here so a held left button shows on the mouse.
BUTTONS = {1: ('click', (30, 80, 190)), 2: ('middle-click', (170, 0, 0)), 3: ('right-click', (0, 110, 40))}
def draw_badge(img, text, xy, font, fill=(40, 40, 40), anchor='lt'):
d = ImageDraw.Draw(img, 'RGBA')
box = d.textbbox(xy, text, font=font, anchor=anchor)
pad = 7
d.rounded_rectangle((box[0] - pad, box[1] - pad, box[2] + pad, box[3] + pad), radius=8, fill=fill + (235,))
d.text(xy, text, font=font, fill=(255, 255, 255), anchor=anchor)
class Painter:
def __init__(self, size):
self.sprite = pointer_sprite(1.7)
self.font = ImageFont.truetype(str(BADGE_FONT), 24)
self.size = size
def chord(self, img, x, y, held, ring, button, since):
"""A chord: a ring for every button down (left inside, middle,
right outside), a mouse whose held buttons are lit, and its name."""
w, h = self.size
d = ImageDraw.Draw(img, 'RGBA')
radius = {1: 15, 2: 23, 3: 31}
for b in held:
r = radius[b]
d.ellipse((x - r, y - r, x + r, y + r), outline=BUTTONS[b][1] + (255,), width=4)
clicked = [b for b in held if b != 1]
if ring == 'pulse' and button and button not in held:
t = min(since / .45, 1)
r = radius[button] + 18 * t
if t < 1:
d.ellipse((x - r, y - r, x + r, y + r), outline=BUTTONS[button][1] + (int(255 * (1 - t)),), width=4)
if since < .7:
clicked = [button]
lit = set(held) | set(clicked)
names = {2: 'middle', 3: 'right'}
label = 'left held' + ''.join(f' + {names[b]}-click' for b in clicked)
width = self.font.getlength(label) + 14
# The mouse, below and right of the pointer (else left of it): three
# buttons over a body, the held ones lit, the name beside it.
mx, my, mw, mh = x + 40, y + 30, 52, 74
if my + mh + 8 > h:
my = y - 34 - mh
if mx + mw + 12 + width + 16 > w:
mx = x - 40 - mw
d.rounded_rectangle((mx, my, mx + mw, my + mh), radius=18, fill=(250, 250, 250, 245), outline=(30, 30, 30, 255),
width=3)
third = mw / 3
for b in (1, 2, 3):
box = (mx + third * (b - 1) + 3, my + 3, mx + third * b - 3, my + mh * .42)
if b in lit:
d.rectangle(box, fill=BUTTONS[b][1] + (255,))
d.line((mx + 3, my + mh * .42 + 2, mx + mw - 3, my + mh * .42 + 2), fill=(30, 30, 30, 255), width=2)
for b in (1, 2):
lx = mx + third * b
d.line((lx, my + 3, lx, my + mh * .42), fill=(30, 30, 30, 255), width=2)
colour = BUTTONS[clicked[-1]][1] if clicked else BUTTONS[1][1]
lx = mx + mw + 12 if mx > x else mx - 12 - width
draw_badge(img, label, (lx, my + mh / 2), self.font, fill=colour, anchor='lm')
def paint(self, img, pointer, badge, ring=None, button=None, since=0.0, held=()):
"""`img` with the badge, the pointer, and a click: `ring` 'press'
(a ring and the button's name) or 'pulse' (`since` seconds after the
release: the ring widening and fading, the name kept a moment)."""
img = img.copy()
w, h = self.size
if badge:
draw_badge(img, badge, (w - 16, h - 16), self.font, anchor='rb')
if pointer is not None:
x, y = pointer
if held:
self.chord(img, x, y, held, ring, button, since)
elif ring and button:
label, colour = BUTTONS[button]
d = ImageDraw.Draw(img, 'RGBA')
if ring == 'press':
r, alpha, named = 16, 255, True
else:
t = min(since / .45, 1)
r, alpha, named = 16 + 22 * t, int(255 * (1 - t)), since < .6
if alpha > 0:
d.ellipse((x - r, y - r, x + r, y + r), outline=colour + (alpha,), width=4)
if named:
# The name sits below the pointer, kept inside the frame.
lx = min(x + 22, w - 16 - self.font.getlength(label))
ly = y + 40 if y + 70 < h else y - 60
draw_badge(img, label, (lx, ly), self.font, fill=colour)
img.paste(self.sprite, (int(x) - 1, int(y) - 1), self.sprite)
return img
def ease(t):
return t * t * (3 - 2 * t)
def lerp(a, b, t):
if a is None or b is None:
return b if t >= .5 else a
return (a[0] + (b[0] - a[0]) * t, a[1] + (b[1] - a[1]) * t)
def compose(shots, out):
"""The shots at FPS with the pointer drawn, ending in a dissolve back to
the first frame so the clip loops; written lossless (FFV1) to `out`.
Answers the clip's length in seconds and its poster image."""
first = Image.open(shots[0]['frame']).convert('RGB')
painter = Painter(first.size)
w, h = first.size
ff = subprocess.Popen(['ffmpeg', '-v', 'error', '-y', '-f', 'rawvideo', '-pix_fmt', 'rgb24', '-s', f'{w}x{h}',
'-r', str(FPS), '-i', '-', '-c:v', 'ffv1', str(out)], stdin=subprocess.PIPE)
poster = None
clock, emitted = 0.0, 0
loaded = (None, None)
for shot in shots:
if loaded[0] != shot['frame']:
loaded = (shot['frame'], Image.open(shot['frame']).convert('RGB'))
img = loaded[1]
clock += shot['secs']
n = round(clock * FPS) - emitted
for i in range(n):
t = ease((i + 1) / n)
frame = painter.paint(img, lerp(shot['start'], shot['end'], t), shot['badge'], shot['ring'],
shot['ring_button'], i / FPS, shot.get('held', ()))
ff.stdin.write(frame.tobytes())
if shot['poster'] and poster is None:
# A chord's still keeps its rings and mouse; a click's has none.
chord = shot.get('held') or ()
poster = painter.paint(img, shot['end'], None, shot['ring'] if chord else None, shot['ring_button'], 0.0,
chord)
emitted += n
last = shots[-1]
n = round(.7 * FPS)
for i in range(n):
t = ease((i + 1) / n)
frame = Image.blend(loaded[1], first, t)
ff.stdin.write(painter.paint(frame, lerp(last['end'], shots[0]['start'], t), None).tobytes())
emitted += n
ff.stdin.close()
if ff.wait() != 0:
raise RuntimeError('ffmpeg (lossless) failed')
return emitted / FPS, poster or painter.paint(first, None, None)
def encode(lossless, name, poster, crf_webm=30, crf_mp4=20):
"""<name>.webm (VP9) and .mp4 (H.264, yuv420p, faststart) and the poster
PNG, in MEDIA."""
MEDIA.mkdir(parents=True, exist_ok=True)
webm, mp4 = MEDIA / (name + '.webm'), MEDIA / (name + '.mp4')
scale = [] if poster.width == WIDTH else ['-vf', f'scale={WIDTH}:-2:flags=lanczos']
subprocess.run(['ffmpeg', '-v', 'error', '-y', '-i', str(lossless), *scale, '-c:v', 'libvpx-vp9',
'-b:v', '0', '-crf', str(crf_webm), '-row-mt', '1', '-deadline', 'good', '-cpu-used', '1',
'-g', '240', '-pix_fmt', 'yuv420p', '-an', str(webm)], check=True)
subprocess.run(['ffmpeg', '-v', 'error', '-y', '-i', str(lossless), *scale, '-c:v', 'libx264',
'-preset', 'veryslow', '-crf', str(crf_mp4), '-tune', 'animation', '-pix_fmt', 'yuv420p',
'-movflags', '+faststart', '-an', str(mp4)], check=True)
if poster.width != WIDTH:
poster = poster.resize((WIDTH, round(poster.height * WIDTH / poster.width)), Image.LANCZOS)
poster.save(MEDIA / (name + '.png'), optimize=True)
return [webm, mp4, MEDIA / (name + '.png')]
# the clips
def hero_setup(s):
"""README and main.c under it."""
s.write('/pane/1/look', f'{PROJECT}/src/main.c\n')
s.wait(lambda: len(s.panes()) == 2, 'main.c')
s.mouse('motion', 0, *s.cell_px(36, 9))
def pane_rows(s, name, rows=6):
"""The first `rows` screen rows under the tag that starts with `name`."""
screen = s.screen()
top = next(i for i, line in enumerate(screen) if line[3:].startswith(name))
return screen[top + 1:top + 1 + rows]
def text_is_the_interface(s):
"""B2 on `make` in the README's text runs it, opening its output pane;
B3 on the error there puts main.c on line 12."""
s.pointer = s.cell_px(36, 9)
s.shot(1.4)
col, row = s.find('with make,', 0)
s.click(2, *s.cell_px(col + 6, row),
done=lambda: any(kind == 'cmd' and '(make) exit' in s.tag(n) for n, kind in s.panes().items()),
what='make', after=1.2)
col, row = s.find('src/main.c:12:5', 0)
s.click(3, *s.cell_px(col + 4, row),
done=lambda: any(line.startswith(' 12 ') for line in pane_rows(s, f'{PROJECT}/src/main.c')),
what='main.c at line 12', after=2.8)
s.shots[-1]['poster'] = True
def shell_setup(s):
"""A terminal under the file, at the project, with a short prompt."""
s.write('/pane/1/exec', 'Tty\n')
s.wait(lambda: 2 in s.panes(), 'the terminal')
s.write('/pane/2/pty/data', f"cd {PROJECT}; PS1='$ '; clear\r")
s.wait(lambda: any(line.rstrip() == ' $' for line in s.screen()), 'the prompt')
# The pointer rests off the tags, so no word's hint is up.
s.mouse('motion', 0, *s.cell_px(COLS - 2, ROWS - 1))
def mounted_shell_setup(s):
"""A terminal under the file whose shell sees the session as files:
cloud9's 9ns mounts the pane's $PARDES_9P in a private namespace."""
shell_setup(s)
mount = HOME / 'n'
mount.mkdir()
s.write('/pane/2/pty/data', f'exec 9ns --unix "$PARDES_9P" --mount {mount} -- /bin/sh\r')
time.sleep(1.5) # 9ns mounts and starts the shell that reads the next line
s.write('/pane/2/pty/data', "cd \"$NINE_MOUNT\" && PS1='$ ' && clear\r")
s.wait(lambda: [line.rstrip() for line in s.terminal_rows() if line.strip()] == [' $'], 'the mounted shell')
def scripting_over_9p(s):
"""A shell reads the session's files and writes a pane's body."""
s.shot(1.0)
for command, done in [('ls', lambda: any('index' in line for line in s.terminal_rows()[1:])),
('cat index', lambda: any(' term ' in line for line in s.terminal_rows())),
("echo 'hello from a script' > pane/1/body", lambda: 'hello from' in s.screen()[3])]:
s.type(command, lambda typed: at_prompt(s, typed)(), per_key=.06)
s.keys('\r')
s.wait(done, command)
s.wait(lambda: [line.rstrip() for line in s.terminal_rows() if line.strip()][-1] == ' $', 'the prompt')
s.shot(1.3)
s.shots[-1]['secs'] = 2.4
s.shots[-1]['poster'] = True
def at_prompt(s, text):
return lambda: any(line.startswith(' $ ' + text) for line in s.screen())
def terminals_are_panes(s):
"""A shell under the file; Ctrl-b and its output is text to move over."""
s.write('/pane/1/dot', '12\n')
s.shot(1.0)
s.type('make', lambda typed: at_prompt(s, typed)())
s.keys('\r')
s.wait(lambda: 'Error 1' in '\n'.join(s.screen()), 'make')
s.wait(lambda: any(line.rstrip() == ' $' for line in s.screen()), 'the next prompt')
s.shot(1.4)
s.press([('\x02', 'Ctrl-b')], per_key=.8)
s.press([('k', 'k'), ('k', 'k k'), ('k', 'k k k')], per_key=.4)
s.press([('x', 'x')], per_key=2.4)
s.shots[-1]['poster'] = True
def diff_setup(s):
"""The project committed, then its typo fixed; a lone terminal."""
env = dict(clean_env(), HOME=str(HOME), GIT_AUTHOR_NAME='demo', GIT_AUTHOR_EMAIL='[email protected]',
GIT_COMMITTER_NAME='demo', GIT_COMMITTER_EMAIL='[email protected]')
for args in (['init', '-q'], ['add', '.'], ['commit', '-qm', 'hello'], ['config', 'diff.context', '1']):
subprocess.run(['git', '-C', str(PROJECT), *args], check=True, env=env, capture_output=True)
main = PROJECT / 'src/main.c'
main.write_text(main.read_text().replace('pritnf', 'printf'))
shell_setup(s)
s.write('/pane/1/exec', 'Del\n')
s.wait(lambda: list(s.panes()) == [2], 'the README to close')
def diff_review(s):
"""git diff in a shell pages into +Pager as a diff; B3 on its + line
opens the file at that line."""
s.pointer = s.cell_px(40, 6)
s.shot(.9)
s.type('git diff', lambda typed: at_prompt(s, typed)())
s.keys('\r')
s.wait(lambda: 'pager' in s.panes().values() or len(s.panes()) == 2, 'the pager')
s.wait_text('+ printf')
s.shot(1.4)
col, row = s.find('+ printf', 0)
s.click(3, *s.cell_px(col, row), done=lambda: len(s.panes()) == 3, what='main.c to open', after=2.6)
s.shots[-1]['poster'] = True
def mandelbrot(path, center=(-0.75, 0.0), span=3.2, limit=200, width=1200, height=800, bands=40):
"""The Mandelbrot set around `center`, `span` wide, smoothly coloured:
a deep blue through white to gold, the inside black. `bands` is the
escape count one sweep of the palette takes (a deep zoom cycles it)."""
import numpy as np
x = np.linspace(center[0] - span / 2, center[0] + span / 2, width)
half = span * height / width / 2
y = np.linspace(center[1] + half, center[1] - half, height)
c = x[None, :] + 1j * y[:, None]
z = np.zeros_like(c)
count = np.zeros(c.shape)
alive = np.ones(c.shape, bool)
for n in range(limit):
z[alive] = z[alive] ** 2 + c[alive]
escaped = alive & (np.abs(z) > 4)
# The smooth (normalised) iteration count, so the bands blend.
count[escaped] = n + 1 - np.log2(np.log2(np.abs(z[escaped])))
alive &= ~escaped
if limit > 2 * bands:
t = (count / bands) % 1 # a zoom: the palette repeats down the spirals
t = np.where(t < .5, t * 2, (1 - t) * 2)
else:
t = np.sqrt(np.clip(count / bands, 0, 1))
stops = np.array([[0, 7, 100], [32, 107, 203], [237, 255, 255], [255, 170, 0], [80, 2, 0]], float)
pos = np.linspace(0, 1, len(stops))
rgb = np.stack([np.interp(t, pos, stops[:, k]) for k in range(3)], axis=-1)
rgb[alive] = 0
Image.fromarray(rgb.astype(np.uint8)).save(path)
def image_setup(s):
"""A lone terminal at the project, which holds two pictures: the
Mandelbrot set and a zoom into its seahorse valley."""
mandelbrot(PROJECT / 'mandelbrot.png')
mandelbrot(PROJECT / 'seahorse.png', center=(-0.7453, 0.1127), span=0.012, limit=600, bands=60)
shell_setup(s)
s.write('/pane/1/exec', 'Del\n')
s.wait(lambda: list(s.panes()) == [2], 'the README to close')
def image_pane(s):
"""ls in a shell; B3 on each PNG's name opens it in a pane."""
s.pointer = s.cell_px(40, 8)
s.shot(1.0)
s.type('ls', lambda typed: at_prompt(s, typed)())
s.keys('\r')
s.wait(lambda: any('seahorse.png' in line for line in s.terminal_rows()), 'ls')
s.shot(.9)
col, row = s.find('mandelbrot.png', 0)
s.click(3, *s.cell_px(col + 4, row), done=lambda: len(s.panes()) == 2, what='the set', after=2.4)
s.shots[-1]['poster'] = True
# Del gives its rows back, so the zoom opens as large.
image = next(n for n, kind in s.panes().items() if kind == 'image')
s.click(2, *s.tag_word(image, 'Del'), done=lambda: len(s.panes()) == 1, what='Del', after=.6)
col, row = s.find('seahorse.png', 0)
s.click(3, *s.cell_px(col + 4, row), done=lambda: len(s.panes()) == 2, what='the zoom', after=3.0)
# The Intel 64 and IA-32 SDM, vol. 2 (2,515 pages), opened where it is.
PDF = [Path('/home/goblin/01-resources/intel-devref-ii.pdf')]
def pdf_args():
return [PDF[0]]
def pdf_setup(s):
s.mouse('motion', 0, *s.cell_px(COLS - 2, ROWS - 1))
def pdf_tag(s, word, pane=None):
"""The pixel over `word` in the PDF pane's tag."""
pane = pane or next(n for n, kind in s.panes().items() if kind == 'pdf')
return s.tag_word(pane, word)
def page_of(s, pane):
tag = s.tag(pane)
return int(tag[tag.index('[') + 1:tag.index('/', tag.index('['))])
def pdf_navigation(s):
"""Page through the Intel SDM, jump to CPUID from its sections, search
a word and step through the hits."""
pdf = next(n for n, kind in s.panes().items() if kind == 'pdf')
s.pointer = s.cell_px(44, 12)
s.shot(1.2)
s.press([('\x06', 'Ctrl-f'), ('\x06', 'Ctrl-f Ctrl-f')], per_key=.7)
s.click(2, *pdf_tag(s, 'PdfSections'), done=lambda: len(s.panes()) == 2, what='the sections', after=.8)
listing = next(n for n in s.panes() if n != pdf)
top = s.find('+PdfSections', 0)[1]
s.write('/focus', f'{listing}\n')
s.badge = '200G'
for key in '200G':
s.keys(key)
s.wait(lambda: any('CPUID' in line for line in s.screen()[top:]), 'the CPUID row')
s.shot(1.0)
s.badge = None
# A row's file.pdf:PAGE:SECTION is the place to look at.
col, row = s.find('pdf:317:200', after=top + 1)
s.click(3, *s.cell_px(col + 4, row), done=lambda: page_of(s, pdf) == 317, what='page 317', after=1.2)
s.click(2, *s.tag_word(listing, 'Del'), done=lambda: list(s.panes()) == [pdf], what='the listing to close',
after=.8)
s.write('/focus', f'{pdf}\n')
s.badge = '/'
s.keys('/')
s.shot(.25)
# Its first hits are on the pages after CPUID's first.
s.type('apic id', lambda typed: True, per_key=.08)
s.badge = '/apic id Enter'
s.keys('\r')
s.wait(lambda: any(kind == 'text' for kind in s.panes().values()), 'the hits')
s.shot(1.0)
s.badge = None
hits = next(n for n, kind in s.panes().items() if kind == 'text')
# The hit list folds to its tag, and the page has the column again.
s.click(2, *s.tag_word(hits, 'Collapse'), done=lambda: 'collapsed' in s.read(f'/pane/{hits}/ctl'),
what='the hits to fold', after=.8)
s.write('/focus', f'{pdf}\n')
for k in range(1, 4):
s.badge = ' '.join(['n'] * k)
s.keys('n')
s.shot(.8)
s.badge = None
s.shots[-1]['secs'] = 1.6
s.shots[-1]['poster'] = True
def pdf_tint_setup(s):
"""CPUID's page, and two words of the user's in the tag: PdfFit and a
page address (MOV's)."""
s.write('/pane/1/look', f'{PDF[0]}:317\n')
s.wait(lambda: page_of(s, 1) == 317, 'page 317')
s.write('/pane/1/tag', f' PdfFit {PDF[0].name}:762')
pdf_setup(s)
def pdf_tint_fit(s):
"""PdfTint through its three looks, PdfFit both ways, then a look at
a page address."""
s.pointer = s.cell_px(44, 12)
s.shot(1.2)
for _ in range(3):
before = s.read('/pane/1/ctl').split()[-1]
s.click(2, *pdf_tag(s, 'PdfTint'), done=lambda: s.read('/pane/1/ctl').split()[-1] != before,
what='the tint', after=1.0)
for fit in ('height', 'width'):
s.click(2, *pdf_tag(s, 'PdfFit'), done=lambda: f'fit:{fit}' in s.read('/pane/1/ctl'), what='the fit',
after=1.3)
s.click(3, *pdf_tag(s, f'{PDF[0].name}:762'), done=lambda: page_of(s, 1) == 762, what='page 762', after=2.0)
s.shots[-1]['poster'] = True
THEMES = MEDIA / 'themes'
THEME_WIDTH = 640
THEME_MAX_BYTES = 120_000
def theme_scene(s):
"""One column: a C file with its syntax colours and a selection, a
shell that ran make (gcc's colours), and git diff paged into +Pager."""
env = dict(clean_env(), HOME=str(HOME), GIT_AUTHOR_NAME='demo', GIT_AUTHOR_EMAIL='[email protected]',
GIT_COMMITTER_NAME='demo', GIT_COMMITTER_EMAIL='[email protected]')
for args in (['init', '-q'], ['add', '.'], ['commit', '-qm', 'hello'], ['config', 'diff.context', '1']):
subprocess.run(['git', '-C', str(PROJECT), *args], check=True, env=env, capture_output=True)
main = PROJECT / 'src/main.c'
main.write_text(main.read_text().replace('i <= 4', 'i <= 5'))
s.write('/pane/1/exec', 'Tty\n')
s.wait(lambda: 2 in s.panes(), 'the terminal')
s.write('/pane/2/pty/data', f"cd {PROJECT}; PS1='$ '; clear; make; git diff\r")
s.wait(lambda: len(s.panes()) == 3, 'the pager')
s.wait(lambda: 'Error 1' in s.read('/pane/2/body'), 'make')
s.write('/pane/1/dot', '12\n')
# The pager shows its hunk, the end of the diff.
pager = next(n for n, kind in s.panes().items() if n not in (1, 2))
s.write(f'/pane/{pager}/dot', '$\n')
def theme_order(s):
"""The themes as the Themes builtin lists them, up to the imported
ones: pardes's own, the ports and the legacy pair (src/themes)."""
s.write('/ctl', 'Themes\n')
s.wait(lambda: any(s.read(f'/pane/{n}/name').strip().endswith('+Themes') for n in s.panes()), '+Themes')
pane = next(n for n in s.panes() if s.read(f'/pane/{n}/name').strip().endswith('+Themes'))
names = []
for line in s.read(f'/pane/{pane}/body').splitlines():
if line.startswith('# Imported'):
break
if line.startswith('Theme '):
names.append(line.split()[1])
s.write(f'/pane/{pane}/ctl', 'Del\n')
s.wait(lambda: pane not in s.panes(), '+Themes to close')
return names
def save_theme_png(data, path):
"""The capture at THEME_WIDTH, as small a PNG as reads: full colour if it
fits THEME_MAX_BYTES, else 256 colours. Answers light or dark, from the
colour most of the window is."""
import io
img = Image.open(io.BytesIO(data)).convert('RGB')
ground = max(img.getcolors(1 << 24), key=lambda c: c[0])[1]
lum = sum(w * (v / 255) ** 2.2 for w, v in zip((.2126, .7152, .0722), ground))
small = img.resize((THEME_WIDTH, round(img.height * THEME_WIDTH / img.width)), Image.LANCZOS)
small.save(path, optimize=True)
if path.stat().st_size > THEME_MAX_BYTES:
small.quantize(256, method=Image.Quantize.MEDIANCUT, dither=Image.Dither.NONE).save(path, optimize=True)
return 'light' if lum > .18 else 'dark'
def record_themes(binary, work):
"""docs/site/media/themes/<theme>.png for every theme of src/themes, in
the Themes builtin's order, and themes.toml listing them."""
make_project()
s = Session(binary, work / 'themes', 'rec-themes', [PROJECT / 'src/main.c'], rows=22)
try:
theme_scene(s)
names = theme_order(s)
THEMES.mkdir(parents=True, exist_ok=True)
rows = []
for name in names:
s.write('/ctl', f'Theme {name}\n')
# A pointer move puts away the word's flash that a command
# leaves up until the pointer moves.
s.mouse('motion', 0, *s.cell_px(COLS - 2, 1))
s.mouse('motion', 0, *s.cell_px(COLS - 3, 1))
kind = save_theme_png(s.settle(), THEMES / f'{name}.png')
rows.append((name, kind))
print(f'{name}.png {kind} {(THEMES / f"{name}.png").stat().st_size / 1e3:.0f} KB', flush=True)
finally:
s.close()
toml = ['# The Themes page gallery, in the order the Themes builtin walks them:',
'# media/themes/<file> for each, made by test/record_demos.py themes.',
'ready = true', '']
for name, kind in rows:
toml += ['[[theme]]', f'name = "{name}"', f'file = "{name}.png"', f'kind = "{kind}"', '']
(THEMES / 'themes.toml').write_text('\n'.join(toml))
NOTES = '''To buy: apples plums pears
In the bowl: bananas
'''
def chords_setup(s):
s.mouse('motion', 0, *s.cell_px(COLS - 2, ROWS - 1))
def body_text(s):
return s.read('/pane/1/body')
def chords(s):
"""acme's chords: B1 sweeps and stays down; B2 cuts, B3 pastes, B2 then
B3 copies."""
s.pointer = s.cell_px(40, 12)
s.shot(.8)
# Cut: sweep " plums", B2 with B1 still down.
col, row = s.find(' plums', 0)
s.chord_press(*s.cell_px(col, row), rest=.25, hold=.3)
s.glide(*s.cell_px(col + 7, row), seconds=.45)
s.shot(.3)
s.chord_click(2, lambda: 'plums' not in body_text(s), 'the cut', after=.75)
s.shots[-2]['poster'] = True
s.chord_release(after=.25)
# Paste after "bananas": B1 down there, B3.
col, row = s.find('bananas', 0)
s.chord_press(*s.cell_px(col + 7, row), rest=.25, hold=.3)
s.chord_click(3, lambda: 'bananas plums' in body_text(s), 'the paste', after=.8)
s.chord_release(after=.25)
# Copy: sweep "apples", B2 then B3 with B1 down: it is back, and kept.
col, row = s.find('apples', 0)
s.chord_press(*s.cell_px(col, row), rest=.25, hold=.3)
s.glide(*s.cell_px(col + 6, row), seconds=.45)
s.shot(.3)
s.chord_click(2, lambda: 'apples' not in body_text(s), 'the copy\'s cut', after=.45)
s.chord_click(3, lambda: 'apples' in body_text(s), 'the copy\'s paste', after=.8)
s.chord_release(after=1.0)
def column(s, serial):
"""Column `serial`'s (first cell, width) from /layout."""
for line in s.read('/layout').splitlines():
parts = line.split()
if parts and parts[0] == str(serial):
return int(parts[2]), int(parts[3])
raise LookupError(f'no column {serial}')
def col_tag_px(s, serial, at, offset=.5):
"""The pixel over character `at` of column `serial`'s tag (row 1 of the
window, wrapping at the column's width in the tagline font)."""
x0, width = column(s, serial)
w, h = s.size()
cw, ch = w / s.cols, h / s.rows
per_row = int((width * cw - 3 * cw) // TAG_W)
return int((x0 + 3) * cw + (at % per_row + offset) * TAG_W), int((1 + at // per_row + .55) * ch)
def columns_setup(s):
s.write('/pane/1/look', f'{PROJECT}/src/main.c\n')
s.wait(lambda: len(s.panes()) == 2, 'main.c')
s.mouse('motion', 0, *s.cell_px(s.cols - 2, s.rows - 1))
def columns(s):
"""Newcol makes a column; a name typed in its tag and looked at opens
there; Alt-c gives a pane a column of its own."""
s.pointer = s.cell_px(30, 12)
s.shot(1.0)
s.click(2, *s.tag_px(3, 0, start=0), done=lambda: len(s.read('/layout').splitlines()) == 3, what='Newcol',
after=.8)
new = s.read('/layout').splitlines()[1].split()[0]
tag = s.read(f'/col/{new}/tag').rstrip('\n')
# B1 just past the tag's last word puts the typing there.
s.click(1, *col_tag_px(s, new, len(tag), offset=.4), after=.2)
s.type(' Makefile', lambda typed: s.read(f'/col/{new}/tag').rstrip('\n').endswith(typed), per_key=.06)
s.shot(.3)
at = s.read(f'/col/{new}/tag').index('Makefile') + 4
s.click(3, *col_tag_px(s, new, at), done=lambda: len(s.panes()) == 3, what='the Makefile', after=1.3)
# Alt-c on main.c: it leaves for a column of its own.
main = next(n for n in s.panes() if s.read(f'/pane/{n}/name').strip().endswith('main.c'))
col, row = s.find('int main', 0)
s.click(1, *s.cell_px(col + 4, row), done=lambda: s.read('/focus').strip() == str(main), what='focus',
after=.3)
s.badge = 'Alt-c'
s.keys('\x1bc')
s.wait(lambda: len(s.read('/layout').splitlines()) == 4, 'the new column')
s.shot(2.2, poster=True)
s.badge = None
def search_setup(s):
(PROJECT / 'tests').mkdir()
(PROJECT / 'tests/check.sh').write_text('#!/bin/sh\n# 1 + 4 + 9 + 16: the sum of the squares is 30\n'
'./hello | grep -q "sum: 30"\n')
s.write('/pane/1/look', f'{PROJECT}/src/main.c\n')
s.wait(lambda: len(s.panes()) == 2, 'main.c')
s.write('/focus', '2\n')
s.mouse('motion', 0, *s.cell_px(COLS - 2, ROWS - 1))
def search(s):
"""Grep (SPC f g) lists the hits in +Search; n and N walk them; B3 on
one opens its file there."""
s.pointer = s.cell_px(44, 8)
s.shot(1.0)
s.press([(' ', 'SPC'), ('f', 'SPC f'), ('g', 'SPC f g')], per_key=.35)
s.badge = 'SPC f g square'
s.type('square', lambda typed: True, per_key=.07)
s.badge = 'Enter'
s.keys('\r')
s.wait(lambda: any(s.read(f'/pane/{n}/name').strip().endswith('+Search') for n in s.panes()), '+Search')
s.shot(1.0)
s.press([('n', 'n'), ('n', 'n n'), ('N', 'n n N')], per_key=.7)
s.shots[-2]['poster'] = True # the listing whole, the second hit current
s.badge = None
col, row = s.find('check.sh:', 0)
s.click(3, *s.cell_px(col + 3, row), done=lambda: len(s.panes()) == 4, what='check.sh', after=2.2)
def where_setup(s):
"""main.c, with pwd in the column's tag and in main.c's."""
s.write('/col/1/tag', ' pwd')
s.write('/pane/1/tag', ' pwd')
s.mouse('motion', 0, *s.cell_px(COLS - 2, ROWS - 1))
def where_commands_run(s):
"""pwd from the column's tag prints the session's directory; from
main.c's tag, main.c's."""
s.pointer = s.cell_px(40, 12)
s.shot(1.2)
tag = s.read('/col/1/tag')
s.click(2, *col_tag_px(s, 1, tag.index('pwd') + 1),
done=lambda: any(kind == 'cmd' and 'exit' in s.tag(n) for n, kind in s.panes().items()), what='pwd',
after=1.6)
s.click(2, *s.tag_word(1, 'pwd'),
done=lambda: any(kind == 'cmd' and s.read(f'/pane/{n}/body').startswith('% pwd\n/tmp/hello/src')
and 'exit' in s.tag(n) for n, kind in s.panes().items()),
what='pwd in src', after=2.6)
s.shots[-1]['poster'] = True
GIT_ID = dict(GIT_AUTHOR_NAME='demo', GIT_AUTHOR_EMAIL='[email protected]',
GIT_COMMITTER_NAME='demo', GIT_COMMITTER_EMAIL='[email protected]')
def edit_setup(s):
"""main.c over a shell that sees the session as files ($m, as in the
scripting chapter: 9ns mounts the pane's $PARDES_9P), and Undo in
main.c's tag."""
shell_setup(s)
mount = HOME / 'n'
mount.mkdir()
s.write('/pane/2/pty/data', f'exec 9ns --unix "$PARDES_9P" --mount {mount} -- /bin/sh\r')
time.sleep(1.5) # 9ns mounts and starts the shell that reads the next line
s.write('/pane/2/pty/data', f"m=$NINE_MOUNT; cd {PROJECT}; PS1='$ '; clear\r")
s.wait(lambda: [line.rstrip() for line in s.terminal_rows() if line.strip()] == [' $'], 'the mounted shell')
s.write('/pane/1/tag', ' Undo')
s.write('/pane/1/dot', '$\n')
s.mouse('motion', 0, *s.cell_px(COLS - 2, 1))
def edit_via_ctl(s):
"""An Edit written to the pane's ctl changes every sum; one Undo puts
them all back."""
s.pointer = s.cell_px(44, 7)
s.shot(1.0)
command = "echo 'Edit ,x/sum/c/total/' > $m/pane/1/ctl"
s.type(command, lambda typed: at_prompt(s, typed)(), per_key=.055)
s.keys('\r')
s.wait(lambda: 'sum' not in s.read('/pane/1/body'), 'the edit')
s.shot(1.6, poster=True)
s.click(2, *s.tag_word(1, 'Undo'), done=lambda: s.read('/pane/1/body').count('sum') == 4, what='Undo',
after=2.0)
def wait_setup(s):
"""A git repo with a change staged, and a lone shell whose EDITOR is
pardes --wait (a `pardes` on its PATH: this pardes-gui)."""
env = dict(clean_env(), HOME=str(HOME), **GIT_ID)
for args in (['init', '-q'], ['add', '.'], ['commit', '-qm', 'hello']):
subprocess.run(['git', '-C', str(PROJECT), *args], check=True, env=env, capture_output=True)
main = PROJECT / 'src/main.c'
main.write_text(main.read_text().replace('pritnf', 'printf'))
(HOME / 'bin').mkdir()
(HOME / 'bin/pardes').symlink_to(s.binary)
shell_setup(s)
ids = ' '.join(f'{k}={v}' for k, v in GIT_ID.items())
s.write('/pane/2/pty/data', f"export PATH=$HOME/bin:$PATH EDITOR='pardes --wait' {ids}; git add -A; clear\r")
s.write('/pane/1/exec', 'Del\n')
s.wait(lambda: list(s.panes()) == [2], 'the README to close')
s.wait(lambda: [line.rstrip() for line in s.terminal_rows() if line.strip()] == [' $'], 'the prompt')
def wait_editor(s):
"""git commit opens its message in a pane of this session; Save and
Del, and git commit returns."""
s.pointer = s.cell_px(44, 9)
s.shot(1.0)
s.type('git commit', lambda typed: at_prompt(s, typed)(), per_key=.07)
s.keys('\r')
s.wait(lambda: len(s.panes()) == 2, 'the message pane')
msg = next(n for n in s.panes() if n != 2)
s.shot(1.0)
s.press([('i', 'i')], per_key=.3)
s.badge = 'i'
s.type('Fix the printf typo', lambda typed: typed in s.read(f'/pane/{msg}/body'), per_key=.05)
# Esc as a CSI u sequence: a bare ESC byte waits in the stdin feed's
# parser for what follows, and the next mouse event would join it.
s.press([('\x1b[27u', 'Esc')], per_key=.4)
s.shots[-1]['poster'] = True # git waiting, its message typed in the pane
s.click(2, *s.tag_word(msg, 'Save'), done=lambda: s.read(f'/pane/{msg}/dirty').strip() == '0', what='Save',
after=.6)
s.click(2, *s.tag_word(msg, 'Del'), done=lambda: list(s.panes()) == [2], what='Del', after=.3)
s.wait(lambda: any('Fix the printf typo' in line for line in s.terminal_rows()), 'git commit')
s.wait(lambda: [line.rstrip() for line in s.terminal_rows() if line.strip()][-1] == ' $', 'the prompt')
s.shot(2.4)
CLIPS = {
'pdf-navigation': dict(
setup=pdf_setup, run=pdf_navigation, args=pdf_args,
caption='A 2,515-page PDF: page, jump to CPUID, search, step hits.'),
'image-pane': dict(
setup=image_setup, run=image_pane, args=[PROJECT / 'README'],
caption="Right-click an image's name, even in a shell, to open it."),
'pdf-tint-fit': dict(
setup=pdf_tint_setup, run=pdf_tint_fit, args=pdf_args,
caption='PdfTint tints the page, PdfFit fits it, a page address jumps.'),
'text-is-the-interface': dict(
setup=hero_setup, run=text_is_the_interface, args=[PROJECT / 'README'],
caption='Middle-click make in the README; right-click the error.'),
'terminals-are-panes': dict(
setup=shell_setup, run=terminals_are_panes, args=[PROJECT / 'src/main.c'],
caption='A terminal is a pane: Ctrl-b, then move over its output.'),
'scripting-over-9p': dict(
setup=mounted_shell_setup, run=scripting_over_9p, args=[PROJECT / 'README'],
caption='A script drives the session through its virtual filesystem (9P).'),
'diff-review': dict(
setup=diff_setup, run=diff_review, args=[PROJECT / 'README'],
caption='Right-click a diff line to open that line of the file.'),
'chords': dict(
setup=chords_setup, run=chords, args=[PROJECT / 'notes.txt'],
caption='Hold left, click middle to cut; click right to paste.'),
'columns': dict(
setup=columns_setup, run=columns, args=[PROJECT / 'README'], cols=80, rows=26,
caption='Newcol adds a column; a look opens there; Alt-c moves a pane.'),
'search': dict(
setup=search_setup, run=search, args=[PROJECT / 'README'],
caption='Grep lists the hits; n and N walk them; right-click opens one.'),
'where-commands-run': dict(
setup=where_setup, run=where_commands_run, args=[PROJECT / 'src/main.c'],
caption="A file's tag runs in its directory; the column tag, in the session's."),
'edit-via-ctl': dict(
setup=edit_setup, run=edit_via_ctl, args=[PROJECT / 'src/main.c'],
caption='An Edit written to ctl changes every sum; one Undo restores.'),
'wait-editor': dict(
setup=wait_setup, run=wait_editor, args=[PROJECT / 'README'],
caption="git commit's message opens in a pane; Del returns it to git."),
}
def record(binary, work, name):
clip = CLIPS[name]
make_project()
args = clip['args']() if callable(clip['args']) else clip['args']
s = Session(binary, work / name, 'rec-' + name, args, init=clip.get('init', ''),
cols=clip.get('cols', COLS), rows=clip.get('rows', ROWS))
try:
if 'setup' in clip:
clip['setup'](s)
clip['run'](s)
finally:
s.close()
seconds, poster = compose(s.shots, work / name / 'lossless.mkv')
files = encode(work / name / 'lossless.mkv', name, poster)
for f in files:
print(f'{f.name} {f.stat().st_size / 1e6:.2f} MB')
print(f'{name}: {seconds:.1f} s')
return seconds
def main():
parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('binary', type=Path, help='a pardes-gui built with -Dplatform=gui')
parser.add_argument('clips', nargs='*',
help='which clips (default: all), or themes for the theme gallery: ' + ', '.join(CLIPS))
parser.add_argument('--work', type=Path, default=REPO.parent / '.scratch/rec/work',
help='frames and intermediates (large; default %(default)s)')
parser.add_argument('--theme', default=THEME[0], help='a theme name, or default (default %(default)s)')
parser.add_argument('--pdf', type=Path, default=PDF[0],
help='the PDF the pdf clips page through, opened read-only (default %(default)s)')
args = parser.parse_args()
THEME[0] = args.theme
PDF[0] = args.pdf.resolve()
names = args.clips or list(CLIPS)
for name in names:
if name not in CLIPS and name != 'themes':
parser.error(f'no clip {name!r}: ' + ', '.join(CLIPS))
try:
for name in names:
if name == 'themes':
record_themes(args.binary, args.work.resolve())
else:
record(args.binary, args.work.resolve(), name)
finally:
shutil.rmtree(PROJECT, ignore_errors=True)
shutil.rmtree(HOME, ignore_errors=True)
captions = MEDIA / 'captions.txt'
lines = dict(line.split(': ', 1) for line in captions.read_text().splitlines() if ': ' in line) \
if captions.exists() else {}
for name in names:
if name in CLIPS:
lines[name] = CLIPS[name]['caption']
captions.write_text(''.join(f'{name}: {lines[name]}\n' for name in CLIPS if name in lines))
if __name__ == '__main__':
main()
|