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
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
|
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>nerdypepper's μblog</title>
<link>https://peppe.rs</link>
<description>programming, design, software</description>
<atom:link href="https://peppe.rs/index.xml" rel="self" type="application/rss+xml" />
<image>
<title>nerdypepper's μblog</title>
<url>https://u.peppe.rs/n.png</url>
<link>https://peppe.rs</link>
</image>
<language>en-us</language>
<copyright>Creative Commons BY-NC-SA 4.0</copyright>
<item>
<title>Curing A Case Of Git-UX</title>
<description><p>Git worktrees are great, but they fall behind the venerable
<code>git checkout</code> sometimes. I attempted to fix that with <a
href="https://github.com/junegunn/fzf">fzf</a> and a bit of bash.</p>
<p><a href="https://asciinema.org/a/D297ztKRzpE4gAHbPTPmkqYps"><img
src="https://asciinema.org/a/D297ztKRzpE4gAHbPTPmkqYps.svg" /></a></p>
<p>Fear not if you haven’t heard of “worktrees”, I have included a
primer here.<br />
<a href="#what-makes-them-clunky">Skip the primer -&gt;</a>.</p>
<h3 id="why-worktrees">Why Worktrees?</h3>
<p>Picture this. You are whacking away on a feature branch. Halfway
there, in fact. Your friend asks you fix something urgently. You proceed
to do one of three things:</p>
<ul>
<li>create a temporary branch, make a WIP commit, begin working on the
fix</li>
<li>stash away your changes, begin working on the fix</li>
<li>unfriend said friend for disturbing your flow</li>
</ul>
<p>All of these options are … subpar. With the temporary branch, you are
forced to create a partial, non-working commit, and then reset said
commit once done with the fix. With the stash approach, you are required
to now keep a mental model of the stash, be aware of untracked files
that don’t get stashed by default, etc. Why won’t git just let you work
on two things at the same time without <em>thinking</em> so much?</p>
<p>That is exactly what worktrees let you do. Worktrees let you have
more than one checkout at a time, each checkout in a separate directory.
Like creating a new clone, but safer (it disallows checking out the same
branch twice) and a lot more space efficient (the new working tree is
“linked” to the “main” worktree, and a good amount of stuff is shared).
When your friend asks you to make the fix, you proceed like so:</p>
<ol type="1">
<li>Create a new working tree with:</li>
</ol>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># git worktree add -b &lt;branch-name&gt; &lt;path&gt; &lt;from&gt;</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> worktree add <span class="at">-b</span> fix-stuff /path/to/tree master</span></code></pre></div>
<ol start="2" type="1">
<li><code>cd</code> into <code>/path/to/tree</code></li>
<li>Fix, test, commit, push, party</li>
<li>Go back to your work, <code>cd -</code></li>
</ol>
<p>Easy as cake. You didn’t have to settle for a partially working
commit, you didn’t to deal with this “stash” thing, <em>and</em> you
didn’t have to unfriend your friend. Treating each branch as a directory
just <em>feels</em> more intuitive, more UNIX-y.</p>
<p>A few weeks later, you find yourself singing in praise of worktrees,
working on several things simultaneously. And at the same time, cursing
them for being a little … clunky.</p>
<h3 id="what-makes-them-clunky">What makes them clunky?</h3>
<p>Worktrees are great at what they claim to do. They stay out of the
way when you need a checkout posthaste. However, as you start using them
regularly, you realize they are not as flexible as
<code>git checkout</code> or <code>git switch</code>.</p>
<h4 id="branch-hopping">Branch-hopping</h4>
<p>You can <code>git checkout &lt;branch&gt;</code> from anywhere within
a git repository. You can’t “jump” to a worktree in the same fashion.
The closest you can get, is to run <code>git worktree list</code>, copy
the path corresponding to your branch, and <code>cd</code> into it.</p>
<p>Branch-hopping with the good ol’ git-checkout:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># anywhere, anytime</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git checkout feature/is-ascii-octdigit</span></code></pre></div>
<p>Meanwhile, in worktree world:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># keeping these paths in your head is hard</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git worktree list</span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/master</span> eac6c33bc63 <span class="pp">[</span><span class="ss">master</span><span class="pp">]</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/improve-std-char-docs</span> 94cba88553e <span class="pp">[</span><span class="ss">improve</span><span class="pp">-</span><span class="ss">std</span><span class="pp">-</span><span class="ss">char</span><span class="pp">-</span><span class="ss">docs</span><span class="pp">]</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/is-ascii-octdigit</span> bc57be3af7a <span class="pp">[</span><span class="ss">feature/is</span><span class="pp">-</span><span class="ss">ascii</span><span class="pp">-</span><span class="ss">octdigit</span><span class="pp">]</span></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="ex">~/my/other/path/oh/god</span> op57or3ns7n <span class="pp">[</span><span class="ss">fix/some</span><span class="pp">-</span><span class="ss">error</span><span class="pp">]</span></span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> cd ~/worktrees/rustc/is-ascii-octdigit</span></code></pre></div>
<h4 id="branch-previewing">Branch-previewing</h4>
<p>You can “preview” branches with <code>git branch -v</code>. However,
to get an idea of what “recent activity” on a worktree looks like, you
might need some juggling. You can’t glean much info about a worktree in
a jiffy.</p>
<p>Branch-previewing with the good ol’ git-branch:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git branch <span class="at">-v</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="ex">+</span> feature/is-ascii-octdigit bc57be3af7a introduce {char, u8}::is_ ...</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="ex">+</span> improve-std-char-docs 94cba88553e add whitespace in assert ...</span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="ex">*</span> master eac6c33bc63 Auto merge of <span class="co">#100869 - n ...</span></span></code></pre></div>
<p>Meanwhile in worktree wonderland:</p>
<pre><code>λ git worktree list
~/worktrees/rustc/master eac6c33bc63 [master]
~/worktrees/rustc/improve-std-char-docs 94cba88553e [improve-std-char-docs]
~/worktrees/rustc/is-ascii-octdigit bc57be3af7a [feature/is-ascii-octdigit]
# aha, so ../is-ascii-octdigit corresponds to `feature/is-ascii-octdigit`
λ git log feature/is-ascii-octdigit
bc57be3af7a introduce {char, u8}::is_ascii_octdigit
eac6c33bc63 Auto merge of #100869 - nnethercote:repl ...
b32223fec10 Auto merge of #100707 - dzvon:fix-typo, ...
aa857eb953e Auto merge of #100537 - petrochenkov:pic ...
# extra work to make the branch &lt;-&gt; worktree correspondence</code></pre>
<h4 id="shell-completions">Shell completions</h4>
<p>Lastly, you can bank on shell completions to fill in your branch
whilst using <code>git checkout</code>. Worktrees have no such
conveniences.</p>
<p>We can mend these minor faults with fzf.</p>
<h3 id="unclunkifying-worktrees">Unclunkifying worktrees</h3>
<p>I’d suggest looking up <a
href="https://github.com/junegunn/fzf">fzf</a> (or <a
href="https://github.com/lotabout/skim">skim</a> or <a
href="https://github.com/jhawthorn/fzy">fzy</a>). These things make it
cake-easy to add interactivity to your shell. Onto fixing the first
minor fault, the inability to “jump” to a worktree from anywhere within
a git repository.</p>
<p>I have a little function called <code>gwj</code> which stands for
“git worktree jump”. The idea is to list all the worktrees, select one
with fzf, and <code>cd</code> to it upon selection:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">gwj ()</span> <span class="kw">{</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a> <span class="bu">local</span> <span class="va">out</span></span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a> <span class="va">out</span><span class="op">=</span><span class="va">$(</span><span class="fu">git</span> worktree list <span class="kw">|</span> <span class="ex">fzf</span> <span class="kw">|</span> <span class="fu">awk</span> <span class="st">&#39;{print $1}&#39;</span><span class="va">)</span></span>
<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> <span class="va">$out</span></span>
<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<p>That is all of it really. Head into a git repository:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># here, &quot;master&quot; is a directory, which contains my main</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="co"># worktree: a checkout of the master branch on rust-lang/rust </span></span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> cd ~/worktrees/rustc/master/library/core/src</span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> <span class="co"># hack away</span></span></code></pre></div>
<p>Preferably one with a few worktrees:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git worktree list</span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/master</span> eac6c33bc63 <span class="pp">[</span><span class="ss">master</span><span class="pp">]</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/improve-std-char-docs</span> 94cba88553e <span class="pp">[</span><span class="ss">improve</span><span class="pp">-</span><span class="ss">std</span><span class="pp">-</span><span class="ss">char</span><span class="pp">-</span><span class="ss">docs</span><span class="pp">]</span></span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a><span class="ex">~/worktrees/rustc/is-ascii-octdigit</span> bc57be3af7a <span class="pp">[</span><span class="ss">feature/is</span><span class="pp">-</span><span class="ss">ascii</span><span class="pp">-</span><span class="ss">octdigit</span><span class="pp">]</span></span></code></pre></div>
<p>And hit <code>gwj</code> (pretend that the pipe, |, is your
cursor):</p>
<div class="sourceCode" id="cb9"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> gwj</span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> <span class="kw">|</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> <span class="ex">4/4</span></span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> ~/worktrees/rustc/master <span class="ex">eac6c33bc63</span> <span class="pp">[</span><span class="ss">master</span><span class="pp">]</span></span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">~/worktrees/rustc/improve-std-char-docs</span> 94cba88553e <span class="pp">[</span><span class="ss">improve</span><span class="pp">-</span><span class="ss">std</span><span class="pp">-</span><span class="ss">char</span><span class="pp">-</span><span class="ss">docs</span><span class="pp">]</span></span>
<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a> <span class="ex">~/worktrees/rustc/is-ascii-octdigit</span> bc57be3af7a <span class="pp">[</span><span class="ss">feature/is</span><span class="pp">-</span><span class="ss">ascii</span><span class="pp">-</span><span class="ss">octdigit</span><span class="pp">]</span></span></code></pre></div>
<p>Approximately type in your branch of choice:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> gwj</span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> docs<span class="kw">|</span></span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> <span class="ex">4/4</span></span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> ~/worktrees/rustc/improve-std-char-docs <span class="ex">94cba88553e</span> <span class="pp">[</span><span class="ss">improve</span><span class="pp">-</span><span class="ss">std</span><span class="pp">-</span><span class="ss">char</span><span class="pp">-</span><span class="ss">docs</span><span class="pp">]</span></span></code></pre></div>
<p>And hit enter. You should find yourself in the selected worktree.</p>
<p>Onward, to the next fault, lack of preview-bility. We can utilize
fzf’s aptly named <code>--preview</code> flag, to, well, preview our
worktree before performing a selection:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">gwj ()</span> <span class="kw">{</span></span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> <span class="bu">local</span> <span class="va">out</span></span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> <span class="va">out</span><span class="op">=</span><span class="va">$(</span></span>
<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> worktree list <span class="kw">|</span></span>
<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">fzf</span> <span class="at">--preview</span><span class="op">=</span><span class="st">&#39;git log --oneline -n10 {2}&#39;</span> <span class="kw">|</span></span>
<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">awk</span> <span class="st">&#39;{print $1}&#39;</span></span>
<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a> <span class="va">)</span></span>
<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> <span class="va">$out</span></span>
<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<p>Once again, hit <code>gwj</code> inside a git repository with linked
worktrees:</p>
<div class="sourceCode" id="cb12"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> gwj</span>
<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="ex">╭─────────────────────────────────────────────────────────╮</span></span>
<span id="cb12-3"><a href="#cb12-3" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> eac6c33bc63 Auto merge of 100869 nnethercote:replace... │</span>
<span id="cb12-4"><a href="#cb12-4" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> b32223fec10 Auto merge of 100707 dzvon:fix-typo, r=d... │</span>
<span id="cb12-5"><a href="#cb12-5" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> aa857eb953e Auto merge of 100537 petrochenkov:picche... │</span>
<span id="cb12-6"><a href="#cb12-6" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> 3892b7074da Auto merge of 100210 mystor:proc_macro_d... │</span>
<span id="cb12-7"><a href="#cb12-7" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> db00199d999 Auto merge of 101249 matthiaskrgr:rollup... │</span>
<span id="cb12-8"><a href="#cb12-8" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> 14d216d33ba Rollup merge of 101240 JohnTitor:JohnTit... │</span>
<span id="cb12-9"><a href="#cb12-9" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> 3da66f03531 Rollup merge of 101236 thomcc:winfs-noze... │</span>
<span id="cb12-10"><a href="#cb12-10" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> 0620f6e90af Rollup merge of 101230 davidtwco:transla... │</span>
<span id="cb12-11"><a href="#cb12-11" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> c30c42ee299 Rollup merge of 101229 mgeisler:link-try... │</span>
<span id="cb12-12"><a href="#cb12-12" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> e5356712b9e Rollup merge of 101165 ldm0:drain_to_ite... │</span>
<span id="cb12-13"><a href="#cb12-13" aria-hidden="true" tabindex="-1"></a><span class="ex">╰─────────────────────────────────────────────────────────╯</span></span>
<span id="cb12-14"><a href="#cb12-14" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span></span>
<span id="cb12-15"><a href="#cb12-15" aria-hidden="true" tabindex="-1"></a> <span class="ex">4/4</span></span>
<span id="cb12-16"><a href="#cb12-16" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> /home/np/worktrees/compiler/master <span class="ex">eac6c...</span></span>
<span id="cb12-17"><a href="#cb12-17" aria-hidden="true" tabindex="-1"></a> <span class="ex">/home/np/worktrees/compiler/improve-std-char-docs</span> 94cba...</span>
<span id="cb12-18"><a href="#cb12-18" aria-hidden="true" tabindex="-1"></a> <span class="ex">/home/np/worktrees/compiler/is-ascii-octdigit</span> bc57b...</span></code></pre></div>
<p>A fancy preview of the last 10 commits on the branch that the
selected worktree corresponds to. In other words, sight for sore eyes.
Our little script is already shaping up to be useful, you hit
<code>gwj</code>, browse through your worktrees, preview each one and
automatically <code>cd</code> to your selection. But we are not done
yet.</p>
<p>The last fault was lack shell completions. A quick review of what a
shell completion really does:</p>
<div class="sourceCode" id="cb13"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git checkout f<span class="op">&lt;</span>tab<span class="op">&gt;</span></span>
<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="ex">feature/is-ascii-octdigit</span></span>
<span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a><span class="ex">fix/some-error</span></span>
<span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="ex">format-doc-tests</span></span>
<span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-6"><a href="#cb13-6" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git checkout feat<span class="op">&lt;</span>tab<span class="op">&gt;</span></span>
<span id="cb13-7"><a href="#cb13-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-8"><a href="#cb13-8" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> git checkout feature/is-ascii-octdigit</span></code></pre></div>
<p>Each time you hit “tab”, the shell produces a few “completion
candidates”, and once you have just a single candidate left, the shell
inserts that for you directly into your edit line. Of course, this
process varies from shell to shell.</p>
<p>fzf narrows down your options as you type into the prompt, but you
still have to:</p>
<ol type="1">
<li>Type <code>gwj</code></li>
<li>Hit enter</li>
<li>Type out a query and narrow down your search</li>
<li>Hit enter</li>
</ol>
<p>We can speed that up a bit, have fzf narrow down the candidates on
startup, just like our shell does:</p>
<div class="sourceCode" id="cb14"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="fu">gwj ()</span> <span class="kw">{</span></span>
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a> <span class="bu">local</span> <span class="va">out</span> <span class="va">query</span></span>
<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a> <span class="va">query</span><span class="op">=</span><span class="st">&quot;</span><span class="va">${1</span><span class="op">:-</span> <span class="va">}</span><span class="st">&quot;</span></span>
<span id="cb14-4"><a href="#cb14-4" aria-hidden="true" tabindex="-1"></a> <span class="va">out</span><span class="op">=</span><span class="va">$(</span></span>
<span id="cb14-5"><a href="#cb14-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> worktree list <span class="kw">|</span></span>
<span id="cb14-6"><a href="#cb14-6" aria-hidden="true" tabindex="-1"></a> <span class="ex">fzf</span> <span class="at">--preview</span><span class="op">=</span><span class="st">&#39;git log --oneline -n10 {2}&#39;</span> <span class="at">--query</span> <span class="st">&quot;</span><span class="va">$query</span><span class="st">&quot;</span> <span class="at">-1</span> <span class="kw">|</span></span>
<span id="cb14-7"><a href="#cb14-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">awk</span> <span class="st">&#39;{print $1}&#39;</span></span>
<span id="cb14-8"><a href="#cb14-8" aria-hidden="true" tabindex="-1"></a> <span class="va">)</span></span>
<span id="cb14-9"><a href="#cb14-9" aria-hidden="true" tabindex="-1"></a> <span class="bu">cd</span> <span class="va">$out</span></span>
<span id="cb14-10"><a href="#cb14-10" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span></code></pre></div>
<p>The change is extremely tiny, blink-and-you’ll-miss-it kinda tiny. We
added a little <code>--query</code> flag, that allows you to prefill the
prompt, and the <code>-1</code> flag, that avoids the interactive finder
if only one match exists on startup:</p>
<div class="sourceCode" id="cb15"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="co"># skip through the fzf prompt:</span></span>
<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> gwj master</span>
<span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a><span class="co"># cd -- ~/worktrees/rustc/master</span></span>
<span id="cb15-4"><a href="#cb15-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb15-5"><a href="#cb15-5" aria-hidden="true" tabindex="-1"></a><span class="co"># more than one option, we end up in the interactive finder</span></span>
<span id="cb15-6"><a href="#cb15-6" aria-hidden="true" tabindex="-1"></a><span class="ex">λ</span> gwj improve</span>
<span id="cb15-7"><a href="#cb15-7" aria-hidden="true" tabindex="-1"></a><span class="ex">╭─────────────────────────────────────────────────────────╮</span></span>
<span id="cb15-8"><a href="#cb15-8" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> eac6c33bc63 Auto merge of 100869 nnethercote:replace... │</span>
<span id="cb15-9"><a href="#cb15-9" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> b32223fec10 Auto merge of 100707 dzvon:fix-typo, r=d... │</span>
<span id="cb15-10"><a href="#cb15-10" aria-hidden="true" tabindex="-1"></a><span class="ex">│</span> aa857eb953e Auto merge of 100537 petrochenkov:picche... │</span>
<span id="cb15-11"><a href="#cb15-11" aria-hidden="true" tabindex="-1"></a><span class="ex">╰─────────────────────────────────────────────────────────╯</span></span>
<span id="cb15-12"><a href="#cb15-12" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> improve</span>
<span id="cb15-13"><a href="#cb15-13" aria-hidden="true" tabindex="-1"></a> <span class="ex">2/2</span></span>
<span id="cb15-14"><a href="#cb15-14" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;</span> /home/np/worktrees/compiler/improve-const-perf <span class="ex">eac6c...</span></span>
<span id="cb15-15"><a href="#cb15-15" aria-hidden="true" tabindex="-1"></a> <span class="ex">/home/np/worktrees/compiler/improve-std-char-docs</span> 94cba...</span></code></pre></div>
<p>Throw some error handling in there, hook up a similar script to
improve the UX of <code>git worktree remove</code>, go wild. A few more
helpers I’ve got:</p>
<div class="sourceCode" id="cb16"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="co"># gwa /path/to/branch-name</span></span>
<span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a><span class="co"># creates a new branch and &quot;switches&quot; to it</span></span>
<span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="kw">function</span><span class="fu"> gwa ()</span> <span class="kw">{</span></span>
<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">git</span> worktree add <span class="st">&quot;</span><span class="va">$1</span><span class="st">&quot;</span> <span class="kw">&amp;&amp;</span> <span class="bu">cd</span> <span class="st">&quot;</span><span class="va">$1</span><span class="st">&quot;</span></span>
<span id="cb16-5"><a href="#cb16-5" aria-hidden="true" tabindex="-1"></a><span class="kw">}</span></span>
<span id="cb16-6"><a href="#cb16-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb16-7"><a href="#cb16-7" aria-hidden="true" tabindex="-1"></a><span class="bu">alias</span> gwls=<span class="st">&quot;git worktree list&quot;</span></span></code></pre></div></description>
<link>https://peppe.rs/posts/curing_a_case_of_git-UX/</link>
<pubDate>Sat, 03 Sep 2022 03:18:00 +0000</pubDate>
<guid>https://peppe.rs/posts/curing_a_case_of_git-UX/</guid>
</item>
<item>
<title>Programming On 34 Keys</title>
<description><p>Minimizing your keyboard layout is a slippery slope. A few months
ago, I built the <a
href="https://github.com/icyphox/ferricy">Ferricy</a>, a
34-key-split-ortho-ergo keyboard. The Ferricy is a fork of the <a
href="https://github.com/davidphilipbarr/Sweep/tree/main/Sweep%20Bling%20MX">Ferris
Sweep MX Bling</a>.</p>
<figure>
<img src="https://u.peppe.rs/otz.jpg"
alt="The Ferricy, designed by icyphox" />
<figcaption aria-hidden="true">The Ferricy, designed by <a
href="https://icyphox.sh">icyphox</a></figcaption>
</figure>
<p>My daily use consists of a bit of prose and a lot of program, my
layout has evolved accordingly.</p>
<h1 id="base-layer">Base Layer</h1>
<figure>
<img src="https://u.peppe.rs/base.png" alt="Colemak with no mods" />
<figcaption aria-hidden="true">Colemak with no mods</figcaption>
</figure>
<p>The base layer contains alphabets, four symbols and four whitespace
keys:</p>
<ul>
<li>Alphas: Stock Colemak, with no modifications whatsoever</li>
<li>Symbols: <code>. , / ;</code></li>
<li>Whitespace: tab, space, enter, backspace (from left to right)</li>
</ul>
<h1 id="layers">Layers</h1>
<p>Keyboard input is complex and it is impossible to skirt around it.
You can either use a keyboard with enough keys to supply all possible
inputs (a mechanical burden), or you can use firmware to supply all
possible inputs (a cognitive burden). Layers are a cognitive burden.</p>
<p>I use 3 layers, heavily inspired by <a
href="https://github.com/manna-harbour/miryoku">Miryoku</a>, but tuned
for programming. Excluding the base Colemak layer:</p>
<ul>
<li><code>NAV</code>: activated on holding <code>space</code> (left
thumb)</li>
<li><code>NUM</code>: activated on holding <code>tab</code> (left
thumb)</li>
<li><code>SYM</code>: activated on holding <code>enter</code> (right
thumb)</li>
</ul>
<h2 id="the-nav-layer">The <code>NAV</code> Layer</h2>
<p>As the name suggests, this layer is focused on navigation. Arrow keys
and the likes.</p>
<figure>
<img src="https://u.peppe.rs/nav.png" alt="NAV, on holding space" />
<figcaption aria-hidden="true"><code>NAV</code>, on holding
<code>space</code></figcaption>
</figure>
<p>Using Vim and Colemak means you lose out on HJKL navigation. However,
on activating the <code>NAV</code> layer, the right home-row is
converted into arrow keys. In essence, by holding space, I can navigate
Vim with the home-row, or Firefox, or my PDF reader. I no longer need to
look for software that allows Vim navigation keys, because it is baked
into the firmware!</p>
<p>My Vim motions are not limited to HJKL. In fact, my Vim motions are
rarely HJKL. I tend to use <code>}</code> (next paragraph) and
<code>)</code> (next sentence) more often. As a result, these have found
their way into my <code>NAV</code> layer, over the likes of
<code>PgDown</code> and <code>End</code>. Having brackets at my index
and middle fingers is nice for programming too.</p>
<h2 id="the-sym-layer">The <code>SYM</code> Layer</h2>
<figure>
<img src="https://u.peppe.rs/sym.png" alt="SYM, on holding enter" />
<figcaption aria-hidden="true"><code>SYM</code>, on holding
<code>enter</code></figcaption>
</figure>
<p>This layer contains all the symbols that you would find by hitting
<code>Shift</code> and a key on the number row. Probably noteworthy to
Vim users: the symbols are arranged in the form of a mirrored numpad for
exactly one reason: to move <code>$</code> to the left of
<code>^</code>. It has always annoyed me that <code>$</code> moves the
cursor to the end of the line and <code>^</code> moves it to the
beginning, but their position on a typical number row are reversed, 4
comes before 6.</p>
<h2 id="the-num-layer">The <code>NUM</code> layer</h2>
<figure>
<img src="https://u.peppe.rs/num.png" alt="NUM, on holding tab" />
<figcaption aria-hidden="true"><code>NUM</code>, on holding
<code>tab</code></figcaption>
</figure>
<p>Another deviation from Miryoku, the numpad just feels <em>right</em>
on my <em>right</em> hand.</p>
<h1 id="zmk-combos">ZMK Combos</h1>
<p>If you have been paying close attention, you might have noticed that
<code>escape</code> didn’t make it to any layer. <code>escape</code> is
too crucial to put on a non-base layer, but at the same time, not as
important to deserve a place on the base layer. That is where ZMK’s
combos come in. Combos let you tap any number of keys, and combine them
to form a single key. I have combos set up for underscore, minus, escape
and caps-word (more on caps-word later):</p>
<figure>
<img src="https://u.peppe.rs/combos.png"
alt="Combos are almost piano-like" />
<figcaption aria-hidden="true">Combos are almost piano-like</figcaption>
</figure>
<h1 id="home-row-mods">Home-row Mods</h1>
<p>Inherited from Miryoku, I have home-row mods for activating
<code>Super</code>, <code>Alt</code>, <code>Shift</code>,
<code>Ctrl</code> and <code>Hyper</code>
(<code>Ctrl + Shift + Alt + Super</code>). The idea is to send
<code>T</code> on tap and <code>Ctrl</code> on hold. Home-row mods are
fairly popular, so I’ll not go into the details.</p>
<figure>
<img src="https://u.peppe.rs/homerow.png"
alt="Super, Alt, Shift, Ctrl, Hyper; on the left half, and mirrored on the right half" />
<figcaption aria-hidden="true">Super, Alt, Shift, Ctrl, Hyper; on the
left half, and mirrored on the right half</figcaption>
</figure>
<p><code>Hyper</code> bridges the gap between firmware and software. You
can never configure key combination that, opens Firefox, for example,
through firmware alone. However, with the <code>Hyper</code> key, and
some <code>sxhkd</code> magic, you can emulate that. Pressing
<code>Hyper + F</code> on a keyboard is just two keys, but the key codes
sent are <code>Ctrl + Shift + Alt + Super + F</code>. That key
combination is not intercepted by any application as a shortcut, except
for the following <code>sxhkd</code> stanza:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">super</span> + alt + shift + ctrl + f</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="ex">xdotool</span> search <span class="st">&quot;Mozilla Firefox&quot;</span> windowactivate</span></code></pre></div>
<p>Alternatively, you can intercept unused <code>F</code> keys:
<code>F13</code> through <code>F24</code>.</p>
<p>Home-row mods are mirrored on each half because it would be
impossible to hit <code>Ctrl + T</code> if not; they lie on the same
key.</p>
<h1 id="caps-word">Caps-word</h1>
<p>Caps-word is a clever caps-lock, built into ZMK. Typing out constants
such as <code>PORT</code> with home-row mods would look like this:</p>
<ul>
<li>hold <code>e</code> (shift) on left hand, and tap <code>p</code> on
right hand</li>
<li>hold <code>e</code> (shift) on left hand, and tap <code>o</code> on
right hand</li>
<li>hold <code>s</code> (shift) on right hand, and tap <code>r</code> on
left hand</li>
<li>hold <code>s</code> (shift) on right hand, and tap <code>t</code> on
left hand</li>
</ul>
<p>This hold-alternate-hold dance gets tiring quickly. With caps-word,
however:</p>
<ul>
<li>toggle <code>caps_word</code></li>
<li>type out <code>p</code>, <code>o</code>, <code>r</code>,
<code>t</code></li>
<li>hit a <em>break</em> character (space, enter will do)</li>
<li>continue</li>
</ul>
<p>Caps-word automatically disables capitalization upon encountering a
breaking character, (which are space, enter or any modifier, by default)
right in the firmware!</p>
<h1 id="findings">Findings</h1>
<p>34-keys has been reasonably comfortable to use, for both prose and
program. My palms do not move across the desk at all, as I reach for
keys. I mostly write Rust and Bash, and my layout has evolved to
accomodate special characters from their grammars (angled brackets and
hyphens, specifically). If you are on a similar journey, I would suggest
focusing on accuracy and comfort over speed. Speed comes with time.</p></description>
<link>https://peppe.rs/posts/programming_on_34_keys/</link>
<pubDate>Sun, 28 Aug 2022 13:51:00 +0000</pubDate>
<guid>https://peppe.rs/posts/programming_on_34_keys/</guid>
</item>
<item>
<title>A Reference Counted Afterlife</title>
<description><p>I took interest in the Egyptian rendition of the afterlife
recently.</p>
<h3 id="parts-of-the-soul">Parts of the Soul</h3>
<p>Ancient Egyptians believed that the soul comprised of several
components:</p>
<ul>
<li><em>ren</em></li>
<li><em>ka</em></li>
<li><em>ib</em></li>
<li><em>ba</em></li>
<li><em>sheut</em></li>
</ul>
<p>Egyptians emphasized on preserving the different parts of the soul.
Mummification for example, served to preserve the physical part of the
soul. The other components have their respective preservation
strategies.</p>
<p>Of all of these bits, I find <em>ren</em>, which simply means
<em>name</em>, to be the most interesting. <em>Ba</em>, the human-headed
chicken that represents <em>personality</em>, is a close favourite.</p>
<p><em>Ren</em> is the name given to a person at birth. Egyptians
believed that this portion of the soul would continue to live on for as
long as it was spoken. If you were someone worthy of continued
existence, your name would be inscribed all over the place. If you were
the type to snatch away bread from children, your name would be
condemned from memory, forgotten.</p>
<h3 id="garbage-collection">Garbage-collection</h3>
<p>The concept of <em>ren</em> seems to be perfectly analogous to
reference counted garbage-collection.</p>
<ul>
<li>A name (<em>ren</em>) is assigned to an object (person) on
initialization (at birth)</li>
<li>Names are used to refer to objects</li>
<li>Objects go out of existence when there are no more references to
them</li>
</ul>
<p>The concept of <em>ren</em> seems to model human-memory. The
similarity with garbage-collection is now easily explained, because
garbage-collection models a program’s memory.</p>
<p>Perhaps some cheeky Egyptian has attained immortality by creating a
<em>ren</em>-cycle.</p></description>
<link>https://peppe.rs/posts/a_reference_counted_afterlife/</link>
<pubDate>Tue, 02 Aug 2022 16:47:00 +0000</pubDate>
<guid>https://peppe.rs/posts/a_reference_counted_afterlife/</guid>
</item>
<item>
<title>Lotus58</title>
<description><p>Earlier this month, I decided that I would laugh at Indian customs in
the face by building a split-ergo mechanical keyboard from scratch
rather than purchasing a Moonlander.</p>
<figure>
<img src="https://u.peppe.rs/i8k.jpg" alt="The finished product" />
<figcaption aria-hidden="true">The finished product</figcaption>
</figure>
<h2 id="sourcing-the-parts">Sourcing the parts</h2>
<p>If you, like me, live in India, you might find this section useful.
My approach to finding parts:</p>
<ul>
<li>Check reputed, local online stores</li>
<li>Check physical hardware stores</li>
<li>Import the part</li>
</ul>
<h3 id="pcbs">PCBs</h3>
<p>This was by far the hardest component to procure. Fabrication
services have certain <em>capabilities</em>. Capabilities are the
limitations of a fabrication service. For example, a service may be
capable of drilling holes no smaller than 0.3mm in diameter. Most sites
have a verification process to check if their capabilities meet your
design’s requirements. I tried a few local PCB fabrication services:</p>
<ul>
<li>Lion PCB: Capabilities did not meet my requirements</li>
<li>PCBPower: Capabilities did not meet my requirements</li>
<li>Circuitwala: Capabilities did not meet my requirements</li>
</ul>
<p>I settled for JLCPCB, a Chinese service. PCBs themselves were 16 USD,
shipping was another 35 USD, and customs was another 3.5K INR
(ouch).</p>
<h3 id="case-material">Case material</h3>
<p>I don’t really have a case for the Lotus58, it is more of a “plastic
sandwich”. I purchased acrylic plates from Robu. Cheap, fast, solid, and
customizable. I cannot recommend Robu enough. A full set of plates (2
top plates and 2 bottom plates) cost me about 500 INR. I also bought a
pair of laptop height raisers on Amazon to create a budget tenting
setup.</p>
<h3 id="electronics">Electronics</h3>
<p>You’ll need a few rather specific electronic components such as
hotswap sockets and TRRS mounts, the rest are commonly available:</p>
<ul>
<li>Hotswap sockets: StacksKB</li>
<li>TRRS mounts (PJ 320A): StacksKB</li>
<li>Diodes (1N4841): StacksKB</li>
<li>M2 screws: StacksKB</li>
<li>M2 spacers: ThinkRobotics</li>
<li>Arduino Pro Micro: Robu</li>
</ul>
<p>I skimped out on optional components such as OLEDs and rotary
encoders.</p>
<h3 id="switches-and-keycaps">Switches and Keycaps</h3>
<p>Arguably the most fun part of the build:</p>
<ul>
<li>Gateron Oil King switches: Rectangles</li>
<li>DSA blanks: Meckeys</li>
</ul>
<h2 id="building-the-keyboard">Building the keyboard</h2>
<p>The the build is extremely straightforward. Through hole components
are easy to solder. Be wary of component placement and orientation.
Check thrice, solder once. Few debugging tips:</p>
<ul>
<li>if a single key does not actuate, check the hotswap for poor
soldering (reflow the joint), and the switch pins for deformation during
installation</li>
<li>if an entire column or row activates on a single key-press, a
connection has been shorted</li>
<li>if only some of the keys on a given row actuate, a diode has been
soldered on the wrong way</li>
</ul>
<h2 id="the-typing-experience">The typing experience</h2>
<p>I decidede to give QWERTY the boot and learn Colemak along with the
new keyboard. The first few weeks were terrible because I could neither
type QWERTY nor Colemak, but I got the hang of it pretty quickly. Typing
websites do help, but it is best to simply use it in your daily
workflow. No site can help you get accustomed to the various things you
use your keyboard for such as switching windows or navigating
vim/tmux.</p>
<h3 id="colemak">Colemak</h3>
<p>Alt layouts such as Colemak are definitely worth it. I find that
Colemak reduces finger movement a lot, a good portion of the keys on the
left hand are the same as QWERTY, it is fairly easy to pick up as
well.</p>
<h3 id="vim">Vim</h3>
<p>Using an alt layout means most programs with keyboard shortcuts are
not going to work as expected, <code>HJKL</code> on vim for movements
being one of them. I took the short route out by creating a new layer
with arrow keys on the home row:</p>
<pre><code>default homerow:
H N E I
&quot;nav&quot; layer:
&lt; v ^ &gt;</code></pre>
<p>The remaining commands in vim are largely mnemonics. Navigating with
home-row arrow keys also means that I can use “HJKL” globally, to scroll
a website, for example.</p>
<h3 id="cutting-down-to-34-keys">Cutting down to 34 keys</h3>
<p>A couple months into my ergo journey, I realized that I could get
away by moving my fingers even lesser. I moved modifiers such as
<code>Super</code>, <code>Ctrl</code>, <code>Alt</code> and
<code>Shift</code> to the home-row as QMK Mod Taps. The rest of the keys
are cleverly placed in layers, not too much unlike the Miryoku layout.
Even for someone that writes Rust (a symbol-heavy grammar), I find
34-keys to be sufficient.</p>
<h2 id="conclusion">Conclusion</h2>
<p>I have been bitten by the ergomech bug.</p>
<figure>
<img src="https://u.peppe.rs/XM3.jpg" alt="The Lotus58 in action" />
<figcaption aria-hidden="true">The Lotus58 in action</figcaption>
</figure></description>
<link>https://peppe.rs/posts/lotus58/</link>
<pubDate>Mon, 13 Jun 2022 13:55:00 +0000</pubDate>
<guid>https://peppe.rs/posts/lotus58/</guid>
</item>
<item>
<title>Lightweight Linting</title>
<description><p><a
href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">Tree-sitter</a>
queries allow you to search for patterns in syntax trees, much like a
regex would, in text. Combine that with some Rust glue to write simple,
custom linters.</p>
<h3 id="tree-sitter-syntax-trees">Tree-sitter syntax trees</h3>
<p>Here is a quick crash course on syntax trees generated by
tree-sitter. Syntax trees produced by tree-sitter are represented by
S-expressions. The generated S-expression for the following Rust
code,</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>would be:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>(source_file</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> (function_item</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a> body: </span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a> (block</span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> (let_declaration </span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div>
<p>Syntax trees generated by tree-sitter have a couple of other cool
properties: they are <em>lossless</em> syntax trees. Given a lossless
syntax tree, you can regenerate the original source code in its
entirety. Consider the following addition to our example:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> main() <span class="op">{</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="co">// a comment goes here</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<p>The tree-sitter syntax tree preserves the comment, while the typical
abstract syntax tree wouldn’t:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a> (source_file</span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> (function_item</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a> body:</span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a> (block</span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> (line_comment)</span>
<span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a> (let_declaration</span>
<span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span>
<span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div>
<h3 id="tree-sitter-queries">Tree-sitter queries</h3>
<p>Tree-sitter provides a DSL to match over CSTs. These queries resemble
our S-expression syntax trees, here is a query to match all line
comments in a Rust CST:</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>(line_comment)</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co">; matches the following rust code</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a><span class="co">; // a comment goes here</span></span></code></pre></div>
<p>Neat, eh? But don’t take my word for it, give it a go on the <a
href="https://tree-sitter.github.io/tree-sitter/playground">tree-sitter
playground</a>. Type in a query like so:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="co">; the web playground requires you to specify a &quot;capture&quot;</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="co">; you will notice the capture and the nodes it captured</span></span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="co">; turn blue</span></span>
<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a>(line_comment) @capture</span></code></pre></div>
<p>Here’s another to match <code>let</code> expressions that bind an
integer to an identifier:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span>
<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span></code></pre></div>
<p>We can <em>capture</em> nodes into variables:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>(let_declaration </span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span>
<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span>
<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a><span class="co">; captures:</span></span>
<span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a><span class="co">; foo</span></span></code></pre></div>
<p>And apply certain <em>predicates</em> to captures:</p>
<div class="sourceCode" id="cb9"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#e</span>q? @my-capture <span class="st">&quot;foo&quot;</span>))</span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span>
<span id="cb9-7"><a href="#cb9-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span>
<span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a><span class="co">; and not:</span></span>
<span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div>
<p>The <code>#match?</code> predicate checks if a capture matches a
regex:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a> (#match? @my-capture <span class="st">&quot;foo|bar&quot;</span>))</span>
<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a><span class="co">; matches both `foo` and `bar`:</span></span>
<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span>
<span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div>
<p>Exhibit indifference, as a stoic programmer would, with the
<em>wildcard</em> pattern:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> value: (<span class="op">_</span>))</span>
<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span>
<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = &quot;foo&quot;;</span></span>
<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 42;</span></span>
<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = bar;</span></span></code></pre></div>
<p><a
href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">The
documentation</a> does the tree-sitter query DSL more justice, but we
now know enough to write our first lint.</p>
<h3 id="write-you-a-tree-sitter-lint">Write you a tree-sitter lint</h3>
<p>Strings in <code>std::env</code> functions are error prone:</p>
<div class="sourceCode" id="cb12"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">&quot;RUST_BACKTACE&quot;</span>)<span class="op">;</span></span>
<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a> <span class="co">// ^^^^ &quot;TACE&quot; instead of &quot;TRACE&quot;</span></span></code></pre></div>
<p>I prefer this instead:</p>
<div class="sourceCode" id="cb13"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="co">// somewhere in a module that is well spellchecked</span></span>
<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="kw">static</span> BACKTRACE<span class="op">:</span> <span class="op">&amp;</span><span class="dt">str</span> <span class="op">=</span> <span class="st">&quot;RUST_BACKTRACE&quot;</span><span class="op">;</span></span>
<span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="co">// rest of the codebase</span></span>
<span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(BACKTRACE)<span class="op">;</span></span></code></pre></div>
<p>Let’s write a lint to find <code>std::env</code> functions that use
strings. Put aside the effectiveness of this lint for the moment, and
take a stab at writing a tree-sitter query. For reference, a function
call like so:</p>
<div class="sourceCode" id="cb14"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>remove_var(<span class="st">&quot;RUST_BACKTRACE&quot;</span>)</span></code></pre></div>
<p>Produces the following S-expression:</p>
<div class="sourceCode" id="cb15"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>(call_expression</span>
<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a> function: (identifier)</span>
<span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span></code></pre></div>
<p>We are definitely looking for a <code>call_expression</code>:</p>
<div class="sourceCode" id="cb16"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>(call_expression) @raise</span></code></pre></div>
<p>Whose function name matches <code>std::env::var</code> or
<code>std::env::remove_var</code> at the very least (I know, I know,
this isn’t the most optimal regex):</p>
<div class="sourceCode" id="cb17"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span>
<span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span>
<span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">&quot;std::env::(var|remove_var)&quot;</span>))</span></code></pre></div>
<p>Let’s turn that <code>std::</code> prefix optional:</p>
<div class="sourceCode" id="cb18"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span>
<span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span>
<span id="cb18-3"><a href="#cb18-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">&quot;(std::|)env::(var|remove_var)&quot;</span>))</span></code></pre></div>
<p>And ensure that <code>arguments</code> is a string:</p>
<div class="sourceCode" id="cb19"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span>
<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span>
<span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span>
<span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">&quot;(std::|)env::(var|remove_var)&quot;</span>))</span></code></pre></div>
<h3 id="running-our-linter">Running our linter</h3>
<p>We could always plug our query into the web playground, but let’s go
a step further:</p>
<div class="sourceCode" id="cb20"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="ex">cargo</span> new <span class="at">--bin</span> toy-lint</span></code></pre></div>
<p>Add <code>tree-sitter</code> and <code>tree-sitter-rust</code> to
your dependencies:</p>
<div class="sourceCode" id="cb21"><pre
class="sourceCode toml"><code class="sourceCode toml"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="co"># within Cargo.toml</span></span>
<span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">]</span></span>
<span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a><span class="dt">tree-sitter</span> <span class="op">=</span> <span class="st">&quot;0.20&quot;</span></span>
<span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">.</span><span class="dt">tree-sitter-rust</span><span class="kw">]</span></span>
<span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a><span class="dt">git</span> <span class="op">=</span> <span class="st">&quot;https://github.com/tree-sitter/tree-sitter-rust&quot;</span></span></code></pre></div>
<p>Let’s load in some Rust code to work with. As <a
href="https://en.wikipedia.org/wiki/Self-reference">an ode to Gödel</a>
(G<code>ode</code>l?), why not load in our linter itself:</p>
<div class="sourceCode" id="cb22"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span>
<span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> src <span class="op">=</span> <span class="pp">include_str!</span>(<span class="st">&quot;main.rs&quot;</span>)<span class="op">;</span></span>
<span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Most tree-sitter APIs require a reference to a <code>Language</code>
struct, we will be working with Rust if you haven’t already guessed:</p>
<div class="sourceCode" id="cb23"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Language<span class="op">;</span></span>
<span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb23-3"><a href="#cb23-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> rust_lang<span class="op">:</span> Language <span class="op">=</span> <span class="pp">tree_sitter_rust::</span>language()<span class="op">;</span></span></code></pre></div>
<p>Enough scaffolding, let’s parse some Rust:</p>
<div class="sourceCode" id="cb24"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Parser<span class="op">;</span></span>
<span id="cb24-2"><a href="#cb24-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-3"><a href="#cb24-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> parser <span class="op">=</span> <span class="pp">Parser::</span>new()<span class="op">;</span></span>
<span id="cb24-4"><a href="#cb24-4" aria-hidden="true" tabindex="-1"></a>parser<span class="op">.</span>set_language(rust_lang)<span class="op">.</span>unwrap()<span class="op">;</span></span>
<span id="cb24-5"><a href="#cb24-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb24-6"><a href="#cb24-6" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> parse_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&amp;</span>src<span class="op">,</span> <span class="cn">None</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div>
<p>The second argument to <code>Parser::parse</code> may be of interest.
Tree-sitter has this cool feature that allows for quick reparsing of
existing parse trees if they contain edits. If you do happen to want to
reparse a source file, you can pass in the old tree:</p>
<div class="sourceCode" id="cb25"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="co">// if you wish to reparse instead of parse</span></span>
<span id="cb25-2"><a href="#cb25-2" aria-hidden="true" tabindex="-1"></a>old_tree<span class="op">.</span>edit(<span class="co">/* redacted */</span>)<span class="op">;</span></span>
<span id="cb25-3"><a href="#cb25-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb25-4"><a href="#cb25-4" aria-hidden="true" tabindex="-1"></a><span class="co">// generate shiny new reparsed tree</span></span>
<span id="cb25-5"><a href="#cb25-5" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> new_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&amp;</span>src<span class="op">,</span> <span class="cn">Some</span>(old_tree))<span class="op">.</span>unwrap()</span></code></pre></div>
<p>Anyhow (<a href="http://github.com/dtolnay/anyhow">hah!</a>), now
that we have a parse tree, we can inspect it:</p>
<div class="sourceCode" id="cb26"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="pp">println!</span>(<span class="st">&quot;{}&quot;</span><span class="op">,</span> parse_tree<span class="op">.</span>root_node()<span class="op">.</span>to_sexp())<span class="op">;</span></span></code></pre></div>
<p>Or better yet, run a query on it:</p>
<div class="sourceCode" id="cb27"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Query<span class="op">;</span></span>
<span id="cb27-2"><a href="#cb27-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb27-3"><a href="#cb27-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> query <span class="op">=</span> <span class="pp">Query::</span>new(</span>
<span id="cb27-4"><a href="#cb27-4" aria-hidden="true" tabindex="-1"></a> rust_lang<span class="op">,</span></span>
<span id="cb27-5"><a href="#cb27-5" aria-hidden="true" tabindex="-1"></a> <span class="st">r#&quot;</span></span>
<span id="cb27-6"><a href="#cb27-6" aria-hidden="true" tabindex="-1"></a><span class="st"> ((call_expression</span></span>
<span id="cb27-7"><a href="#cb27-7" aria-hidden="true" tabindex="-1"></a><span class="st"> function: (_) @fn-name</span></span>
<span id="cb27-8"><a href="#cb27-8" aria-hidden="true" tabindex="-1"></a><span class="st"> arguments: (arguments (string_literal))) @raise</span></span>
<span id="cb27-9"><a href="#cb27-9" aria-hidden="true" tabindex="-1"></a><span class="st"> (#match? @fn-name &quot;(std::|)env::(var|remove_var)&quot;))</span></span>
<span id="cb27-10"><a href="#cb27-10" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;#</span></span>
<span id="cb27-11"><a href="#cb27-11" aria-hidden="true" tabindex="-1"></a>)</span>
<span id="cb27-12"><a href="#cb27-12" aria-hidden="true" tabindex="-1"></a><span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div>
<p>A <code>QueryCursor</code> is tree-sitter’s way of maintaining state
as we iterate through the matches or captures produced by running a
query on the parse tree. Observe:</p>
<div class="sourceCode" id="cb28"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>QueryCursor<span class="op">;</span></span>
<span id="cb28-2"><a href="#cb28-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb28-3"><a href="#cb28-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> query_cursor <span class="op">=</span> <span class="pp">QueryCursor::</span>new()<span class="op">;</span></span>
<span id="cb28-4"><a href="#cb28-4" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> all_matches <span class="op">=</span> query_cursor<span class="op">.</span>matches(</span>
<span id="cb28-5"><a href="#cb28-5" aria-hidden="true" tabindex="-1"></a> <span class="op">&amp;</span>query<span class="op">,</span></span>
<span id="cb28-6"><a href="#cb28-6" aria-hidden="true" tabindex="-1"></a> parse_tree<span class="op">.</span>root_node()<span class="op">,</span></span>
<span id="cb28-7"><a href="#cb28-7" aria-hidden="true" tabindex="-1"></a> src<span class="op">.</span>as_bytes()<span class="op">,</span></span>
<span id="cb28-8"><a href="#cb28-8" aria-hidden="true" tabindex="-1"></a>)<span class="op">;</span></span></code></pre></div>
<p>We begin by passing our query to the cursor, followed by the “root
node”, which is another way of saying, “start from the top”, and lastly,
the source itself. If you have already taken a look at the C API, you
will notice that the last argument, the source (known as the
<code>TextProvider</code>), is not required. The Rust bindings seem to
require this argument to provide predicate functionality such as
<code>#match?</code> and <code>#eq?</code>.</p>
<p>Do something with the matches:</p>
<div class="sourceCode" id="cb29"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="co">// get the index of the capture named &quot;raise&quot;</span></span>
<span id="cb29-2"><a href="#cb29-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> raise_idx <span class="op">=</span> query<span class="op">.</span>capture_index_for_name(<span class="st">&quot;raise&quot;</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span>
<span id="cb29-3"><a href="#cb29-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-4"><a href="#cb29-4" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> each_match <span class="kw">in</span> all_matches <span class="op">{</span></span>
<span id="cb29-5"><a href="#cb29-5" aria-hidden="true" tabindex="-1"></a> <span class="co">// iterate over all captures called &quot;raise&quot;</span></span>
<span id="cb29-6"><a href="#cb29-6" aria-hidden="true" tabindex="-1"></a> <span class="co">// ignore captures such as &quot;fn-name&quot;</span></span>
<span id="cb29-7"><a href="#cb29-7" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> capture <span class="kw">in</span> each_match</span>
<span id="cb29-8"><a href="#cb29-8" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>captures</span>
<span id="cb29-9"><a href="#cb29-9" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>iter()</span>
<span id="cb29-10"><a href="#cb29-10" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>filter(<span class="op">|</span>c<span class="op">|</span> c<span class="op">.</span>idx <span class="op">==</span> raise_idx)</span>
<span id="cb29-11"><a href="#cb29-11" aria-hidden="true" tabindex="-1"></a> <span class="op">{</span></span>
<span id="cb29-12"><a href="#cb29-12" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> range <span class="op">=</span> capture<span class="op">.</span>node<span class="op">.</span>range()<span class="op">;</span></span>
<span id="cb29-13"><a href="#cb29-13" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> text <span class="op">=</span> <span class="op">&amp;</span>src[range<span class="op">.</span>start_byte<span class="op">..</span>range<span class="op">.</span>end_byte]<span class="op">;</span></span>
<span id="cb29-14"><a href="#cb29-14" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> line <span class="op">=</span> range<span class="op">.</span>start_point<span class="op">.</span>row<span class="op">;</span></span>
<span id="cb29-15"><a href="#cb29-15" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> col <span class="op">=</span> range<span class="op">.</span>start_point<span class="op">.</span>column<span class="op">;</span></span>
<span id="cb29-16"><a href="#cb29-16" aria-hidden="true" tabindex="-1"></a> <span class="pp">println!</span>(</span>
<span id="cb29-17"><a href="#cb29-17" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;[Line: {}, Col: {}] Offending source code: `{}`&quot;</span><span class="op">,</span></span>
<span id="cb29-18"><a href="#cb29-18" aria-hidden="true" tabindex="-1"></a> line<span class="op">,</span> col<span class="op">,</span> text</span>
<span id="cb29-19"><a href="#cb29-19" aria-hidden="true" tabindex="-1"></a> )<span class="op">;</span></span>
<span id="cb29-20"><a href="#cb29-20" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb29-21"><a href="#cb29-21" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Lastly, add the following line to your source code, to get the linter
to catch something:</p>
<div class="sourceCode" id="cb30"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a><span class="pp">env::</span>remove_var(<span class="st">&quot;RUST_BACKTRACE&quot;</span>)<span class="op">;</span></span></code></pre></div>
<p>And <code>cargo run</code>:</p>
<pre class="shell"><code>λ cargo run
Compiling toy-lint v0.1.0 (/redacted/path/to/toy-lint)
Finished dev [unoptimized + debuginfo] target(s) in 0.74s
Running `target/debug/toy-lint`
[Line: 40, Col: 4] Offending source code: `env::remove_var(&quot;RUST_BACKTRACE&quot;)`</code></pre>
<p>Thank you tree-sitter!</p>
<h3 id="bonus">Bonus</h3>
<p>Keen readers will notice that I avoided
<code>std::env::set_var</code>. Because <code>set_var</code> is called
with two arguments, a “key” and a “value”, unlike <code>env::var</code>
and <code>env::remove_var</code>. As a result, it requires more
juggling:</p>
<div class="sourceCode" id="cb32"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span>
<span id="cb32-2"><a href="#cb32-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span>
<span id="cb32-3"><a href="#cb32-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments <span class="op">.</span> (string_literal)<span class="op">?</span> <span class="op">.</span> (string_literal) <span class="op">.</span>)) @raise</span>
<span id="cb32-4"><a href="#cb32-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">&quot;(std::|)env::(var|remove_var|set_var)&quot;</span>))</span></code></pre></div>
<p>The interesting part of this query is the humble <code>.</code>, the
<em>anchor</em> operator. Anchors help constrain child nodes in certain
ways. In this case, it ensures that we match exactly two
<code>string_literal</code>s who are siblings or exactly one
<code>string_literal</code> with no siblings. Unfortunately, this query
also matches the following invalid Rust code:</p>
<div class="sourceCode" id="cb33"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a><span class="co">// remove_var accepts only 1 arg!</span></span>
<span id="cb33-2"><a href="#cb33-2" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">&quot;RUST_BACKTRACE&quot;</span><span class="op">,</span> <span class="st">&quot;1&quot;</span>)<span class="op">;</span></span></code></pre></div>
<h3 id="notes">Notes</h3>
<p>All-in-all, the query DSL does a great job in lowering the bar to
writing language tools. The knowledge gained from mastering the query
DSL can be applied to other languages that have tree-sitter grammars
too. This query detects <code>to_json</code> methods that do not accept
additional arguments, in Ruby:</p>
<div class="sourceCode" id="cb34"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a>((method</span>
<span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a> name: (identifier) @fn</span>
<span id="cb34-3"><a href="#cb34-3" aria-hidden="true" tabindex="-1"></a> !parameters)</span>
<span id="cb34-4"><a href="#cb34-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#i</span>s? @fn <span class="st">&quot;to_json&quot;</span>))</span></code></pre></div></description>
<link>https://peppe.rs/posts/lightweight_linting/</link>
<pubDate>Wed, 26 Jan 2022 12:52:00 +0000</pubDate>
<guid>https://peppe.rs/posts/lightweight_linting/</guid>
</item>
<item>
<title>Novice Nix: Flake Templates</title>
<description><p>Flakes are very handy to setup entirely pure, project-specific
dependencies (not just dependencies, but build steps, shell environments
and more) in a declarative way. Writing Flake expressions can get
repetitive though, oftentimes, you’d much rather start off with a
skeleton. Luckily, <code>nix</code> already supports templates!</p>
<p>You might already be familiar with <code>nix flake init</code>, that
drops a “default” flake expression into your current working directory.
If you head over to the manpage:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">nix</span> flake init <span class="at">--help</span></span></code></pre></div>
<p>You will read that <code>nix flake init</code> creates a flake using
the “default template”. Additionally, you can create a flake from a
specific template by passing the <code>-t</code> flag. Where does this
default originate from?</p>
<h2 id="flake-registries">Flake Registries</h2>
<p>Quick detour into registries! Registries are a way to alias popular
flakes using identifiers:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># list a few predefined registries</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix registry list</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> . . </span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="ex">global</span> flake:nixpkgs github:NixOS/nixpkgs</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="ex">global</span> flake:patchelf github:NixOS/patchelf</span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="ex">global</span> flake:nix-serve github:edolstra/nix-serve</span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="ex">global</span> flake:templates github:NixOS/templates</span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="ex">global</span> flake:nickel github:tweag/nickel</span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> . .</span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="co"># you can do </span></span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake show nickel</span>
<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-14"><a href="#cb2-14" aria-hidden="true" tabindex="-1"></a><span class="co"># instead of </span></span>
<span id="cb2-15"><a href="#cb2-15" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake show github:tweag/nickel</span>
<span id="cb2-16"><a href="#cb2-16" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-17"><a href="#cb2-17" aria-hidden="true" tabindex="-1"></a><span class="co"># which is short for</span></span>
<span id="cb2-18"><a href="#cb2-18" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake show git+https://github.com/tweag/nickel</span></code></pre></div>
<p>You might notice a registry called <code>templates</code> aliased to
<code>github:NixOS/templates</code>. Take a peek with
<code>nix flake show</code>:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake show templates</span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="ex">github:NixOS/templates/79f48a7b822f35c068c5e235da2e9fbd154cecee</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="ex">├───defaultTemplate:</span> template: A very basic flake</span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="ex">└───templates</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">├───bash-hello:</span> template: An over-engineered Hello World in bash</span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a> <span class="ex">├───c-hello:</span> template: An over-engineered Hello World in C</span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a> <span class="ex">├───rust-web-server:</span> template: A Rust web server including a NixOS module</span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a> <span class="ex">├───simpleContainer:</span> template: A NixOS container running apache-httpd</span>
<span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a> <span class="ex">└───trivial:</span> template: A very basic flake</span></code></pre></div>
<p>Aha! There is a flake output called <code>defaultTemplate</code>.
This is the template being sourced when you run
<code>nix flake init</code>. Astute readers may conclude the
following:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init</span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="co"># is equivalent to</span></span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> templates#defaultTemplate</span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a><span class="co"># is equivalent to</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> github:NixOS/templates#defaultTemplate</span>
<span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a><span class="co"># which is short for</span></span>
<span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> git+https://github.com/NixOS/templates#defaultTemplate</span></code></pre></div>
<p>Similarly, the other templates can be accessed via:</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> templates#c-hello</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> templates#simpleContainer</span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co"># I think you get the drift ...</span></span></code></pre></div>
<h2 id="rolling-your-own-templates">Rolling your own templates</h2>
<p>Alright, so all we need to do is:</p>
<ul>
<li>create a flake with a <code>templates</code> output</li>
<li>populate our template directories with content</li>
<li>(<strong>optionally</strong>) alias our custom templates flake to an
identifier using registries, for easier access</li>
</ul>
<p>Start off by creating a directory to store your templates in (we will
be converting this to a registry later):</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> mkdir ~/mytemplates</span></code></pre></div>
<p>A flake that exposes a “template” as its output looks something like
this:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode nix"><code class="sourceCode nix"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># inside ~/mytemplates/flake.nix</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="op">{</span></span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;Pepper&#39;s flake templates&quot;</span><span class="op">;</span></span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a> <span class="va">outputs</span> <span class="op">=</span> <span class="op">{</span> <span class="va">self</span><span class="op">,</span> <span class="op">...</span> <span class="op">}</span>: <span class="op">{</span></span>
<span id="cb7-7"><a href="#cb7-7" aria-hidden="true" tabindex="-1"></a> <span class="va">templates</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb7-8"><a href="#cb7-8" aria-hidden="true" tabindex="-1"></a> <span class="va">latex-report</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb7-9"><a href="#cb7-9" aria-hidden="true" tabindex="-1"></a> <span class="va">path</span> <span class="op">=</span> <span class="ss">./latex-report-template</span><span class="op">;</span></span>
<span id="cb7-10"><a href="#cb7-10" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;A latex whitepaper project&quot;</span><span class="op">;</span></span>
<span id="cb7-11"><a href="#cb7-11" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb7-12"><a href="#cb7-12" aria-hidden="true" tabindex="-1"></a> <span class="va">rust-hello</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb7-13"><a href="#cb7-13" aria-hidden="true" tabindex="-1"></a> <span class="va">path</span> <span class="op">=</span> <span class="ss">./rust-hello-template</span><span class="op">;</span></span>
<span id="cb7-14"><a href="#cb7-14" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;Simple Hello World in Rust&quot;</span><span class="op">;</span></span>
<span id="cb7-15"><a href="#cb7-15" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb7-16"><a href="#cb7-16" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb7-17"><a href="#cb7-17" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb7-18"><a href="#cb7-18" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>The <code>path</code> attribute to each template is what gets copied
over when you initialize a flake. Running
<code>nix flake init -t .#latex-report</code> will initialize the
current directory with the contents of
<code>./latex-report-template</code> (we are yet to populate these
directories).</p>
<p>The output of <code>nix flake show</code> should be something
like:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake show</span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="ex">path:/home/np/code/nix-stuff/template-tests?narHash=sha256-{...}</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="ex">└───templates</span></span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> <span class="ex">├───latex-report:</span> template: A latex whitepaper project</span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">└───rust-hello:</span> template: Simple Hello World in Rust</span></code></pre></div>
<p>Populate your template directories with content, here are my template
directories for example:</p>
<div class="sourceCode" id="cb9"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> tree mytemplates</span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="ex">mytemplates/</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="ex">├──</span> flake.nix</span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a><span class="ex">├──</span> latex-report-template</span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a><span class="ex">│ </span> ├── flake.nix</span>
<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a><span class="ex">│ </span> ├── makefile</span>
<span id="cb9-7"><a href="#cb9-7" aria-hidden="true" tabindex="-1"></a><span class="ex">│ </span> └── src</span>
<span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a><span class="ex">│ </span> ├── meta.sty</span>
<span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a><span class="ex">│ </span> └── report.tex</span>
<span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a><span class="ex">└──</span> rust-hello-template</span>
<span id="cb9-11"><a href="#cb9-11" aria-hidden="true" tabindex="-1"></a> <span class="ex">├──</span> Cargo.toml</span>
<span id="cb9-12"><a href="#cb9-12" aria-hidden="true" tabindex="-1"></a> <span class="ex">├──</span> flake.nix</span>
<span id="cb9-13"><a href="#cb9-13" aria-hidden="true" tabindex="-1"></a> <span class="ex">└──</span> src</span>
<span id="cb9-14"><a href="#cb9-14" aria-hidden="true" tabindex="-1"></a> <span class="ex">└──</span> main.rs</span></code></pre></div>
<p>And that’s it! Start using your templates with:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> ~/mytemplates#rust-hello</span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> tree .</span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span></span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="ex">├──</span> Cargo.toml</span>
<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="ex">├──</span> flake.nix</span>
<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a><span class="ex">└──</span> src</span>
<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a> <span class="ex">└──</span> main.rs</span></code></pre></div>
<p>To avoid writing <code>~/mytemplates</code> each time, simply alias
it to a registry:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="co"># alias it to `biscuits`</span></span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix registry add biscuits ~/mytemplates</span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a><span class="co"># you will see it listed under `user` registries</span></span>
<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix registry list</span>
<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> . .</span>
<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a><span class="ex">user</span> flake:biscuits path:/home/np/template-tests</span>
<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a><span class="bu">.</span> . .</span>
<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-10"><a href="#cb11-10" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> nix flake init <span class="at">-t</span> biscuits#latex-report</span></code></pre></div>
<h2 id="extending-the-official-templates">Extending the official
templates</h2>
<p>I personally, would like the <code>biscuits</code> registry to
include not just my homemade templates, but also the templates from
<code>NixOS/templates</code> (and maybe a couple of other repositories
in the wild):</p>
<div class="sourceCode" id="cb12"><pre
class="sourceCode nix"><code class="sourceCode nix"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a> <span class="op">{</span></span>
<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;Pepper&#39;s flake templates&quot;</span><span class="op">;</span></span>
<span id="cb12-3"><a href="#cb12-3" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb12-4"><a href="#cb12-4" aria-hidden="true" tabindex="-1"></a>+ <span class="va">inputs</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb12-5"><a href="#cb12-5" aria-hidden="true" tabindex="-1"></a>+ <span class="va">official-templates</span>.<span class="va">url</span> <span class="op">=</span> <span class="va">github</span><span class="op">:</span><span class="ss">NixOS/templates</span><span class="op">;</span></span>
<span id="cb12-6"><a href="#cb12-6" aria-hidden="true" tabindex="-1"></a>+ <span class="va">other-templates</span>.<span class="va">url</span> <span class="op">=</span> <span class="va">github</span><span class="op">:</span><span class="ss">some-other/templates</span><span class="op">;</span></span>
<span id="cb12-7"><a href="#cb12-7" aria-hidden="true" tabindex="-1"></a>+ <span class="op">};</span></span>
<span id="cb12-8"><a href="#cb12-8" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb12-9"><a href="#cb12-9" aria-hidden="true" tabindex="-1"></a> <span class="va">outputs</span> <span class="op">=</span> <span class="op">{</span> <span class="va">self</span><span class="op">,</span> <span class="va">official-templates</span><span class="op">,</span> <span class="va">other-templates</span> <span class="op">...</span> <span class="op">}</span>: <span class="op">{</span></span>
<span id="cb12-10"><a href="#cb12-10" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb12-11"><a href="#cb12-11" aria-hidden="true" tabindex="-1"></a> <span class="va">templates</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb12-12"><a href="#cb12-12" aria-hidden="true" tabindex="-1"></a> <span class="va">latex-report</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb12-13"><a href="#cb12-13" aria-hidden="true" tabindex="-1"></a> <span class="va">path</span> <span class="op">=</span> <span class="ss">./latex-report-template</span><span class="op">;</span></span>
<span id="cb12-14"><a href="#cb12-14" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;A latex whitepaper project&quot;</span><span class="op">;</span></span>
<span id="cb12-15"><a href="#cb12-15" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb12-16"><a href="#cb12-16" aria-hidden="true" tabindex="-1"></a> <span class="va">rust-hello</span> <span class="op">=</span> <span class="op">{</span></span>
<span id="cb12-17"><a href="#cb12-17" aria-hidden="true" tabindex="-1"></a> <span class="va">path</span> <span class="op">=</span> <span class="ss">./rust-hello-template</span><span class="op">;</span></span>
<span id="cb12-18"><a href="#cb12-18" aria-hidden="true" tabindex="-1"></a> <span class="va">description</span> <span class="op">=</span> <span class="st">&quot;Simple Hello World in Rust, with overloaded Rust toolchain&quot;</span><span class="op">;</span></span>
<span id="cb12-19"><a href="#cb12-19" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb12-20"><a href="#cb12-20" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb12-21"><a href="#cb12-21" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">//</span> official<span class="op">-</span>templates.templates</span>
<span id="cb12-22"><a href="#cb12-22" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">//</span> other<span class="op">-</span>templates.templates<span class="op">;</span></span>
<span id="cb12-23"><a href="#cb12-23" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb12-24"><a href="#cb12-24" aria-hidden="true" tabindex="-1"></a> <span class="op">};</span></span>
<span id="cb12-25"><a href="#cb12-25" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<p>Running <code>nix flake show biscuits</code> will now list templates
from the <code>biscuits</code> registry as well as the ones from
<code>NixOS/templates</code>. Ensure that the names don’t collide
though.</p></description>
<link>https://peppe.rs/posts/novice_nix:_flake_templates/</link>
<pubDate>Tue, 05 Oct 2021 16:49:00 +0000</pubDate>
<guid>https://peppe.rs/posts/novice_nix:_flake_templates/</guid>
</item>
<item>
<title>SDL2 Devlog</title>
<description><p>I have been working on an editor for the <a
href="https://git.peppe.rs/graphics/obi/about">One Bit Image</a> file
format in Rust and SDL2. This entry in my blog follows my progress on
the editor. The days are listed in reverse chronological order, begin
from the bottom, if this is your first time on this page.</p>
<h3 id="day-20">Day 20</h3>
<p>More <code>lisp</code> stuff! I added a new brush, for rectangular
selections. While selection doesn’t do much on its own, the selected
area can be passed onto a <code>lisp</code> procedure, for example, a
procedure to draw horizontal black and white lines:</p>
<figure>
<video src="https://u.peppe.rs/frU.mp4" controls=""><a
href="https://u.peppe.rs/frU.mp4">Day 20</a></video>
<figcaption aria-hidden="true">Day 20</figcaption>
</figure>
<h3 id="day-19">Day 19</h3>
<p>Attempted <a href="https://peppe.rs/art/conduit.png">some isometric
art</a> within the editor. The angles displayed alongside the line brush
are handly, however, having only a rectangular grid did not help. I
implemented an isometric grid today. Isometric grids in pixel art differ
in that the tangent of the isometric angle is exactly 0.5! For every
pixel down, you go exactly two pixels sideways. The math works out
really well in the drawing procedures too, dealing with floating points
is a pain.</p>
<figure>
<img src="https://u.peppe.rs/1Kb.png" alt="Day 19" />
<figcaption aria-hidden="true">Day 19</figcaption>
</figure>
<h3 id="day-18">Day 18</h3>
<p>I added basic support for guides, they can be added and activated
from the <code>lisp</code> REPL. Another long standing improvement I
wanted to make was reworking the pixmap drawing procedure. The old
procedure draws a square for each pixel in the pixmap, coloured
according to its value in the pixmap. Naturally, this means, for an
<strong>NxN</strong> pixmap, there are <strong>N²</strong> calls to SDL!
I reworked this procedure to compress each line of the pixmap using RLE
(run length encoding), and call out to SDL for each run in the line.
This drastically improved drawing speeds on larger grids. The following
is a comparison between the two procedures, the leftmost picture is the
rendered image, the middle picture is the optimized drawing procedure
(draws each run instead of pixel), and the right most picture is the
primitive drawing procedure (draws each pixel):</p>
<figure>
<img src="https://u.peppe.rs/U4B.png" alt="Day 18" />
<figcaption aria-hidden="true">Day 18</figcaption>
</figure>
<h3 id="day-17">Day 17</h3>
<p>I decided to give the text-only statusline a touch up, by adding a
active color and dither level preview. Aligning the “widget” to the
right of statusline involved a lot more than I thought, so I created a
ghetto CSS-like rectangle placement system to position containers inside
containers:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co">// roughly something like this</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> statusline <span class="op">=</span> </span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="pp">Container::</span>new(<span class="pp">Offset::</span>Left(<span class="dv">0</span>)<span class="op">,</span> <span class="pp">Offset::</span>Bottom(<span class="dv">40</span>))</span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>width(<span class="pp">Size::</span>Max)</span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>height(<span class="pp">Size::</span>Absolute(<span class="dv">20</span>))<span class="op">;</span></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> primary <span class="op">=</span> <span class="pp">Container::</span>uninit()</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>width(<span class="pp">Size::</span>Absolute(<span class="dv">16</span>))</span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>height(<span class="pp">Size::</span>Absolute(<span class="dv">16</span>))<span class="op">;</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a>container<span class="op">.</span>place(</span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a> <span class="op">&amp;</span><span class="kw">mut</span> padding_box<span class="op">,</span></span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a> <span class="pp">HorAlign::</span>Right<span class="op">,</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a> <span class="pp">VertAlign::</span>Center</span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a>)<span class="op">;</span></span></code></pre></div>
<p>The result (brush preview on the bottom right):</p>
<figure>
<video src="https://u.peppe.rs/OtU.mp4" controls=""><a
href="https://u.peppe.rs/OtU.mp4">Day 17</a></video>
<figcaption aria-hidden="true">Day 17</figcaption>
</figure>
<h3 id="day-16">Day 16</h3>
<p>The embedded lisp is coming along nicely, users can load a custom
<code>rc.lisp</code>, which is evaluated on startup. To disable to grid
on start, for example:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co">;;; rc.lisp</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>(toggle-grid)</span></code></pre></div>
<p>Some aliases to switch between brushes:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co">;;; rc.lisp</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>(<span class="ex">define</span><span class="fu"> </span>(brush kind)</span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> (<span class="kw">cond</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> ((<span class="kw">eq?</span> kind &#39;f) (brush-fill))</span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a> ((<span class="kw">eq?</span> kind &#39;c) (brush-circle))</span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a> ((<span class="kw">eq?</span> kind &#39;l) (brush-line))</span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a> ((<span class="kw">eq?</span> kind &#39;l+) (brush-line-extend))</span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a> (<span class="kw">else</span> (brush-circle))))</span></code></pre></div>
<p>The following script draws a straight line along a given axis, at a
given distance from the canvas boundary:</p>
<figure>
<video src="https://u.peppe.rs/b3i.mp4" controls=""><a
href="https://u.peppe.rs/b3i.mp4">Day 16</a></video>
<figcaption aria-hidden="true">Day 16</figcaption>
</figure>
<h3 id="day-15">Day 15</h3>
<p>I began writing a standard library for the lisp, in lisp. It includes
basic list operations: <code>car</code>, <code>cdr</code>,
<code>null?</code>, <code>list</code>, higher order functions:
<code>map</code>, <code>filter</code>, <code>fold</code>:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode lisp"><code class="sourceCode commonlisp"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>(define (member? item ls)</span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> (fold <span class="dv">#f</span></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> (<span class="kw">lambda</span> (acc x) (<span class="kw">or</span> acc (eq? item x)))</span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> ls))</span></code></pre></div>
<h3 id="day-14">Day 14</h3>
<p>I attempted a <a href="https://peppe.rs/art/ramen_noodles.png">small
art piece</a> using the editor, while it was largely usable, I felt a
certain lack of feedback. The brushes just didn’t relay as much info as
I’d have liked, for example, the approximate points of the line or the
angle made by the line against the x-axis. Unfortunately, the existing
infrastructure around brushes and line drawing didn’t easily allow for
this either. I went ahead and reimplemented brushes, and added a new
flood fill brush too:</p>
<figure>
<video src="https://u.peppe.rs/8q.mp4" controls=""><a
href="https://u.peppe.rs/8q.mp4">Day 14</a></video>
<figcaption aria-hidden="true">Day 14</figcaption>
</figure>
<h3 id="day-13">Day 13</h3>
<p>I added a few more forms to the <code>lisp</code> evaluator. It
handles recursion, definitions, variable mutation and more. The prelude
contains 20 subroutines so far, including comparision and logic
operators. The REPL interface on the SDL side requires some UX tweaks;
environment based completion, readline motions sound doable.</p>
<figure>
<video src="https://u.peppe.rs/u3.mp4" controls=""><a
href="https://u.peppe.rs/u3.mp4">Day 13</a></video>
<figcaption aria-hidden="true">Day 13</figcaption>
</figure>
<h3 id="day-12">Day 12</h3>
<p>I lifted most of <a
href="https://github.com/murarth/ketos">murarth/ketos</a> into the
editor. <code>ketos</code>’s implementation of <code>lisp</code> is too
vast for my use case. For example, the editor does not need data types
to handle raw strings or byte strings. I have got a basic evaluator
running inside the SDL2 context (notice the <code>lisp</code> REPL at
the bottom of the window). Over the following days, I intend to create a
set of prelude functions to manipulate the pixmap. Users can implement
their own brushes, dithering patterns, keybinds and more
(hopefully).</p>
<figure>
<video src="https://u.peppe.rs/y0.mp4" controls=""><a
href="https://u.peppe.rs/y0.mp4">Day 12</a></video>
<figcaption aria-hidden="true">Day 12</figcaption>
</figure>
<h3 id="day-11">Day 11</h3>
<p>I intend to supplement the editor with scripting language and an
inbuilt REPL for the same. I began by implementing a text box widget
from scratch, with history and readline like editing:</p>
<figure>
<video src="https://u.peppe.rs/Mh.mp4" controls=""><a
href="https://u.peppe.rs/Mh.mp4">Day 11</a></video>
<figcaption aria-hidden="true">Day 11</figcaption>
</figure>
<h3 id="day-10">Day 10</h3>
<p>I started reading up on dithering methods and half-toning, I wanted
to create a dithering brush that would automatically produce popular
dithering patterns. The method that caught my eye (and also the one used
most often in pixel art), was Bayer’s ordered dithering. When applied to
a black and white image, each pixel, based on its intensity, is mapped
to a 4x4 grid of pixels. A completely empty (completely black) 4x4 grid
represents zero intensity, and a filled 4x4 grid represents full
intensity. Bayer’s ordered dithering can produce 15 steps of intensity
between zero and full (by switching on exactly 1 pixel more at each
level), thus, being able to draw 17 “shades” from white to black.
Creating a dithering brush from here was fairly trivial. Our pixmap is
supposed to represent the final dithered image, it must be divided into
4x4 grids. Each grid is colored based on the intensity of the brush
passing over it:</p>
<figure>
<img src="https://u.peppe.rs/Mn.png" alt="Day 10" />
<figcaption aria-hidden="true">Day 10</figcaption>
</figure>
<h3 id="day-9">Day 9</h3>
<p>I started working towards an interface. I like the idea of a largely
read-only HUD, i. e., an interface that simply describes the state of
the application. Changes to this state are initiated via keybinds or
text commands. I am proud of the symmetry indicator; <code>-</code> for
horizontal symmetry, <code>|</code> for vertical symmetry,
<code>+</code> for radial symmetry.</p>
<figure>
<img src="https://u.peppe.rs/hx.png" alt="Day 9" />
<figcaption aria-hidden="true">Day 9</figcaption>
</figure>
<h3 id="day-8">Day 8</h3>
<p>One of my favourite features of GIMP was symmetric editing. I added
some coordinate geometry primitives to my pixmap abstraction, allowing
for mirroring and reflecting figures about lines or points. The result
was an ergonomic function that applies symmetry to any painting
operation, (undo/redo works as expected):</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> line <span class="op">=</span> <span class="kw">self</span><span class="op">.</span>pixmap<span class="op">.</span>get_line(start<span class="op">,</span> end)<span class="op">;</span></span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> sym_line <span class="op">=</span> <span class="kw">self</span><span class="op">.</span>symmetry<span class="op">.</span>apply(<span class="op">&amp;</span>line)<span class="op">;</span></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> point on line<span class="op">.</span>extend(sym_line) <span class="op">{</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a> <span class="co">// draw to window</span></span>
<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<figure>
<video src="https://u.peppe.rs/B1.mp4" controls=""><a
href="https://u.peppe.rs/B1.mp4">Day 8</a></video>
<figcaption aria-hidden="true">Day 8</figcaption>
</figure>
<h3 id="day-7">Day 7</h3>
<p>Bresenham saves the day again! This time, I implemented his line
drawing algorithm, to, well, draw lines. Each point on the line is then
“buffed” based on the active brush size. Today’s changes fit in very
well with the undo system and the brush size feature. Creating the right
abstractions, one at a time :)</p>
<figure>
<video src="https://u.peppe.rs/xt.mp4" controls=""><a
href="https://u.peppe.rs/xt.mp4">Day 7</a></video>
<figcaption aria-hidden="true">Day 7</figcaption>
</figure>
<h3 id="day-6">Day 6</h3>
<p>I extended Bresenham’s algorithm to draw not just circle outlines,
but also generate their fills. Unlike Bresenham’s algorithm, this
variant generates points for two quadrants at once, these points are
mirrored over the dividing axis to generate the other two quadrants.</p>
<figure>
<img src="https://u.peppe.rs/f3.png" alt="Day 6" />
<figcaption aria-hidden="true">Day 6</figcaption>
</figure>
<h3 id="day-5">Day 5</h3>
<p>I discovered and implemented Bresenham’s algorithm for efficient
circle drawing. The algorithm allowed for sized circular brushes,
something I really liked from GIMP. Very convenient that the Wikipedia
page for Bresenham’s algorithm also includes a section about optimizing
for integer based arithmetic. I managed to abstract out another giant
component of the application, the pixmap. Any image is just a grid of
pixels (a pixmap), where the pixel’s value is decided by the application
(1-bit in my case). I could potentially extend the application to a
24-bit image editor!</p>
<figure>
<video src="https://u.peppe.rs/Kh.mp4" controls=""><a
href="https://u.peppe.rs/Kh.mp4">Day 5</a></video>
<figcaption aria-hidden="true">Day 5</figcaption>
</figure>
<h3 id="day-4">Day 4</h3>
<p>I created a generic “undo stack” data structure that allows for
infinite “undos” and “redos”. Every modification operation to the grid
is persisted to the application state. A couple of keybinds allow the
user to revert and re-apply these operations! I expect abstracting this
component will come in handy down the line.</p>
<figure>
<video src="https://u.peppe.rs/w5.mp4" controls=""><a
href="https://u.peppe.rs/w5.mp4">Day 4</a></video>
<figcaption aria-hidden="true">Day 4</figcaption>
</figure>
<h3 id="day-3">Day 3</h3>
<p>I implemented the bare minimum required to call the program an
“editor”. The application displays a grid, tracks mouse events, paints
white to the canvas on left click, and black to the canvas on right
click. I created a make-shift MVC architecture à la Elm in Rust.</p>
<figure>
<video src="https://u.peppe.rs/GF.mp4" controls=""><a
href="https://u.peppe.rs/GF.mp4">Day 3</a></video>
<figcaption aria-hidden="true">Day 3</figcaption>
</figure>
<h3 id="day-2">Day 2</h3>
<p>I started figuring out event handling today. Implemented a couple of
keybinds to zoom in/out of the drawing area. Conversions of SDL2
coordinates (measured in signed 32 bit integers) to my internal “drawing
area” coordinates (measured in unsigned 32 bit integers) is very
annoying. Hopefully the unchecked conversions won’t haunt me later.</p>
<figure>
<video src="https://u.peppe.rs/L4.mp4" controls=""><a
href="https://u.peppe.rs/L4.mp4">Day 2</a></video>
<figcaption aria-hidden="true">Day 2</figcaption>
</figure>
<h3 id="day-1">Day 1</h3>
<p>Getting started with Rust and SDL2 is very straightforward. The
<code>rust-sdl2</code> library contains some detailed examples that
allowed me to get all the way to drawing a grid from a
<code>Vec&lt;bool&gt;</code>:</p>
<figure>
<img src="https://u.peppe.rs/Ma.png" alt="Day 1" />
<figcaption aria-hidden="true">Day 1</figcaption>
</figure></description>
<link>https://peppe.rs/posts/SDL2_devlog/</link>
<pubDate>Sun, 11 Apr 2021 10:46:00 +0000</pubDate>
<guid>https://peppe.rs/posts/SDL2_devlog/</guid>
</item>
<item>
<title>Self-hosting Git</title>
<description><p>Earlier this week, I began migrating my repositories from Github to
<a href="https://git.zx2c4.com/cgit/about/">cgit</a>. If you care at all
about big corporates turning open-source into a T-shirt farming service,
this is the way to go.</p>
<h3 id="offerings">Offerings</h3>
<p>cgit is <em>very</em> bare bones. It is <a
href="https://tools.ietf.org/html/rfc3875">cgi-based</a> web interface
to git, and nothing more. You may browse repositories, view diffs,
commit logs and even clone via http. If you are looking to replace
Github with cgit, keep in mind that cgit does not handle issues or
pull/merge requests. If people wish to contribute to your work, they
would have to send you a patch via email.</p>
<h3 id="setup">Setup</h3>
<p>Installing cgit is fairly straightforward, if you would like to
compile it from source:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># fetch</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone https://git.zx2c4.com <span class="kw">&amp;&amp;</span> <span class="bu">cd</span> cgit</span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> submodule init</span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> submodule update</span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="co"># install</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> NO_LUA=1</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> make install</span></code></pre></div>
<p>This would drop the cgit cgi script (and the default css) into
<code>/var/www/htdocs/cgit</code>. You may configure cgit by editing
<code>/etc/cgitrc</code>. I specify the <code>NO_LUA</code> flag to
compile without lua support, exclude that flag if you would like to
extend cgit via lua scripts.</p>
<h3 id="going-live">Going live</h3>
<p>You might want to use, <a
href="https://github.com/gnosek/fcgiwrap">fcgiwrap</a>, a <a
href="http://www.nongnu.org/fastcgi">fastcgi</a> wrapper for
<code>cgi</code> scripts,</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> apt install fcgiwrap</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sudo</span> systemctl start fcgiwrap.socket</span></code></pre></div>
<p>Expose the cgit cgi script to the web via <code>nginx</code>:</p>
<pre><code># nginx.conf
server {
listen 80;
server_name git.example.com;
# serve static files
location ~* ^.+\.(css|png|ico)$ {
root /var/www/htdocs/cgit;
}
location / {
fastcgi_pass unix:/run/fcgiwrap.socket;
fastcgi_param SCRIPT_FILENAME /var/www/htdocs/cgit/cgit.cgi; # the default location of the cgit cgi script
fastcgi_param PATH_INFO $uri;
fastcgi_param QUERY_STRING $args;
}
}</code></pre>
<p>Point cgit to your git repositories:</p>
<pre><code># /etc/cgitrc
scan-path=/path/to/git/repos</code></pre>
<p><strong><em>Note</em></strong>: <em><code>scan-path</code> works best
if you stick it at the end of your <code>cgitrc</code></em>.</p>
<p>You may now create remote repositories at
<code>/path/to/git/repos</code>, via:</p>
<pre><code>git init --bare</code></pre>
<p>Add the remote to your local repository:</p>
<pre><code>git remote set-url origin user@remote:/above/path
git push origin master</code></pre>
<h3 id="configuration">Configuration</h3>
<p>cgit is fairly easy to configure, all configuration options can be
found <a href="https://git.zx2c4.com/cgit/tree/cgitrc.5.txt">in the
manual</a>, here are a couple of cool ones though:</p>
<p><strong>enable-commit-graph</strong>: Generates a text based
graphical representation of the commit history, similar to
<code>git log --graph --oneline</code>.</p>
<pre><code>| * | Add support for configuration file
* | | simplify command parsing logic
* | | Refactor parsers
* | | Add basic tests
* | | Merge remote-tracking branch &#39;origin/master&#39; in...
|\| |
| * | add installation instructions for nix
| * | switch to pancurses backendv0.2.2
| * | bump to v0.2.2
* | | Merge branch &#39;master&#39; into feature/larger-names...
|\| |
| * | enable feature based compilation to support win...
| * | remove dependency on rustc v1.45, bump to v0.2....
| * | Merge branch &#39;feature/windows&#39; of https://git...
| |\ \
| | * | add windows to github actions
| | * | switch to crossterm backend
| | * | Merge branch &#39;fix/duplicate-habits&#39;
| | |\ \
| | | * | move duplicate check to command parsing blo...</code></pre>
<p><strong>section-from-path</strong>: This option paired with
<code>scan-path</code> will automatically generate sections in your cgit
index page, from the path to each repo. For example, the directory
structure used to generate sections on <a href="https://git.peppe.rs">my
cgit instance</a> looks like this:</p>
<pre><code>├── cli
│ ├── dijo
│ ├── eva
│ ├── pista
│ ├── taizen
│ └── xcursorlocate
├── config
│ ├── dotfiles
│ └── nixos
├── fonts
│ ├── curie
│ └── scientifica
├── languages
│ └── lisk
├── libs
│ ├── cutlass
│ └── fondant
├── terminfo
├── university
│ └── furby
└── web
└── isostatic</code></pre>
<h3 id="ease-of-use">Ease of use</h3>
<p>As I mentioned before, <code>cgit</code> is simply a view into your
git repositories, you will have to manually create new repositories by
entering your remote and using <code>git init --bare</code>. Here are a
couple of scripts I wrote to perform actions on remotes, think of it as
a smaller version of Github’s <code>gh</code> program.</p>
<p>You may save these scripts as <code>git-script-name</code> and drop
them in your <code>$PATH</code>, and git will automatically add an alias
called <code>script-name</code>, callable via:</p>
<pre><code>git script-name</code></pre>
<h4 id="git-new-repo">git-new-repo</h4>
<p>Creates a new repository on your remote, the first arg may be a path
(section/repo-name) or just the repo name:</p>
<pre><code>#! /usr/bin/env bash
#
# usage:
# git new-repo section/repo-name
#
# example:
# git new-repo fonts/scientifica
# creates: user@remote:fonts/scientifica
if [ $# -eq 0 ]; then
echo &quot;requires an arg&quot;
exit 1
fi
ssh user@remote git init --bare &quot;$1&quot;;</code></pre>
<h4 id="git-set-desc">git-set-desc</h4>
<p>To set a one line repository description. It simply copies the local
<code>.git/description</code>, into <code>remote/description</code>.
<code>cgit</code> displays the contents of this file on the index
page:</p>
<pre><code>#! /usr/bin/env bash
#
# usage:
# enter repo description into .git/description and run:
# git set-desc
remote=$(git remote get-url --push origin)
scp .git/description &quot;$remote/description&quot;</code></pre></description>
<link>https://peppe.rs/posts/self-hosting_git/</link>
<pubDate>Sat, 17 Oct 2020 07:04:00 +0000</pubDate>
<guid>https://peppe.rs/posts/self-hosting_git/</guid>
</item>
<item>
<title>NixOS</title>
<description><p>I have been eyeing operating systems with functional package managers
for a while now, aka, NixOS or Guix. Reproducible builds, declarative
and rollback-able system configuration, system consistency, all sound
pretty cool. I have been using NixOS for about a month now.</p>
<h3 id="installation">Installation</h3>
<p>I went with their minimal installation ISO. The installation was
pretty smooth from start to end, no hitches there. The entire <a
href="https://nixos.org/manual/nixos/stable/">manual</a> is available
offline, and is accessible during the installation. Very handy.</p>
<h3 id="setup">Setup</h3>
<p>The entire system is configured via
<code>/etc/nixos/configuration.nix</code>. Wifi, <code>libinput</code>
gestures, audio, locale settings, there are options for literally
everything. You can declaratively write down the packages you want
installed too. With fresh installs of most distros, I usually fumble
with getting things like screen backlight and media keys to work. If I
do manage to fix it, I can’t carry it forward to future installations
trivially. Getting all my hardware to work on NixOS is as easy as:</p>
<pre><code>{
server.xserver.libinput.enable = true; # touchpad
programs.light.enable = true; # backlight
hardware.pulseaudio.enable = true; # audio
networking.wireless.enable = true; # wifi
}</code></pre>
<h3 id="developing-with-nix">Developing with Nix</h3>
<p>Nix makes it easy to enter environments that aren’t affected by your
system configuration using <code>nix-shell</code>.</p>
<p>Builds may be generated by specifying a <code>default.nix</code>
file, and running <code>nix-build</code>. Conventional package managers
require you to specify a dependency list, but there is no guarantee that
this list is complete. The package will build on your machine even if
you forget a dependency. However, with Nix, packages are installed to
<code>/nix/store</code>, and not global paths such as
<code>/usr/bin/...</code>, if your project builds, it means you have
included every last one.</p>
<p>Issues on most my projects have been “unable to build because
<code>libxcb</code> is missing”, or “this version of
<code>openssl</code> is too old”. Tools like <code>cargo</code> and
<code>pip</code> are poor package managers. While they <em>can</em>
guarantee that Rust or Python dependencies are met, they make
assumptions about the target system.</p>
<p>For example, <a href="https://github.com/nerdypepper/site">this
website</a> is now built using Nix, anyone using Nix may simply, clone
the repository and run <code>./generate.sh</code>, and it would <em>just
work</em>, while keeping your global namespace clean™:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co">#! /usr/bin/env nix-shell</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="co">#! nix-shell -i bash -p eva pandoc esh</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="co"># some bash magic ;)</span></span></code></pre></div>
<p>Dependencies are included with the <code>-p</code> flag, the shell
script is executed with an interpreter, specified with the
<code>-i</code> flag.</p>
<h3 id="impressions">Impressions</h3>
<p>NixOS is by no means, simple. As a newcomer, using Nix was not easy,
heck, I had to learn a purely functional, lazy language to just build
programs. There is a lot to be desired on the tooling front as well. A
well fleshed out LSP plugin would be nice (<a
href="https://github.com/nix-community/rnix-lsp">rnix-lsp looks
promising</a>).</p>
<p>Being able to rollback changes at a system level is cool. Package
broke something? Just <code>nixos-rebuild switch --rollback</code>!
Deleted <code>nix</code> by mistake? Find the binary in
<code>/nix/store</code> and rollback! You aren’t punished for not
thinking twice.</p>
<p>I don’t see myself switching to anything else in the near future,
NixOS does a lot of things right. If I ever need to reinstall NixOS, I
can generate an <a
href="https://github.com/nix-community/nixos-generators">image of my
current system</a>.</p>
<p><a href="https://u.peppe.rs/6m.png"><img
src="https://u.peppe.rs/6m.png" /></a></p></description>
<link>https://peppe.rs/posts/nixOS/</link>
<pubDate>Tue, 01 Sep 2020 07:08:00 +0000</pubDate>
<guid>https://peppe.rs/posts/nixOS/</guid>
</item>
<item>
<title>Gripes With Go</title>
<description><p>You’ve read a lot of posts about the shortcomings of the Go
programming language, so what’s one more.</p>
<ol type="1">
<li><a href="#lack-of-sum-types">Lack of sum types</a></li>
<li><a href="#type-assertions">Type assertions</a></li>
<li><a href="#date-and-time">Date and Time</a></li>
<li><a href="#statements-over-expressions">Statements over
Expressions</a></li>
<li><a href="#erroring-out-on-unused-variables">Erroring out on unused
variables</a></li>
<li><a href="#error-handling">Error handling</a></li>
</ol>
<h3 id="lack-of-sum-types">Lack of Sum types</h3>
<p>A “Sum” type is a data type that can hold one of many states at a
given time, similar to how a boolean can hold a true or a false, not too
different from an <code>enum</code> type in C. Go lacks
<code>enum</code> types unfortunately, and you are forced to resort to
crafting your own substitute.</p>
<p>A type to represent gender for example:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode go"><code class="sourceCode go"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> Gender <span class="dt">int</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="kw">const</span> <span class="op">(</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> Male Gender <span class="op">=</span> <span class="ot">iota</span> <span class="co">// assigns Male to 0</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> Female <span class="co">// assigns Female to 1</span></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> Other <span class="co">// assigns Other to 2</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="op">)</span></span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a>fmt<span class="op">.</span>Println<span class="op">(</span><span class="st">&quot;My gender is &quot;</span><span class="op">,</span> Male<span class="op">)</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="co">// My gender is 0</span></span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a><span class="co">// Oops! We have to implement String() for Gender ...</span></span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a><span class="kw">func</span> <span class="op">(</span>g Gender<span class="op">)</span> String<span class="op">()</span> <span class="dt">string</span> <span class="op">{</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a> <span class="cf">switch</span> <span class="op">(</span>g<span class="op">)</span> <span class="op">{</span></span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a> <span class="cf">case</span> <span class="dv">0</span><span class="op">:</span> <span class="cf">return</span> <span class="st">&quot;Male&quot;</span></span>
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a> <span class="cf">case</span> <span class="dv">1</span><span class="op">:</span> <span class="cf">return</span> <span class="st">&quot;Female&quot;</span></span>
<span id="cb1-17"><a href="#cb1-17" aria-hidden="true" tabindex="-1"></a> <span class="cf">default</span><span class="op">:</span> <span class="cf">return</span> <span class="st">&quot;Other&quot;</span></span>
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb1-20"><a href="#cb1-20" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-21"><a href="#cb1-21" aria-hidden="true" tabindex="-1"></a><span class="co">// You can accidentally do stupid stuff like:</span></span>
<span id="cb1-22"><a href="#cb1-22" aria-hidden="true" tabindex="-1"></a>gender <span class="op">:=</span> Male <span class="op">+</span> <span class="dv">1</span></span></code></pre></div>
<p>The Haskell equivalent of the same:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode haskell"><code class="sourceCode haskell"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="kw">data</span> <span class="dt">Gender</span> <span class="ot">=</span> <span class="dt">Male</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="op">|</span> <span class="dt">Female</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="op">|</span> <span class="dt">Other</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">deriving</span> (<span class="dt">Show</span>)</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="fu">print</span> <span class="op">$</span> <span class="st">&quot;My gender is &quot;</span> <span class="op">++</span> (<span class="fu">show</span> <span class="dt">Male</span>)</span></code></pre></div>
<h3 id="type-assertions">Type Assertions</h3>
<p>A downcast with an optional error check? What could go wrong?</p>
<p>Type assertions in Go allow you to do:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode go"><code class="sourceCode go"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="kw">var</span> x <span class="kw">interface</span><span class="op">{}</span> <span class="op">=</span> <span class="dv">7</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>y<span class="op">,</span> goodToGo <span class="op">:=</span> x<span class="op">.(</span><span class="dt">int</span><span class="op">)</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> goodToGo <span class="op">{</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> fmt<span class="op">.</span>Println<span class="op">(</span>y<span class="op">)</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>The error check however is optional:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode go"><code class="sourceCode go"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="kw">var</span> x <span class="kw">interface</span><span class="op">{}</span> <span class="op">=</span> <span class="dv">7</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="kw">var</span> y <span class="op">:=</span> x<span class="op">.(</span><span class="dt">float64</span><span class="op">)</span></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>fmt<span class="op">.</span>Println<span class="op">(</span>y<span class="op">)</span></span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="co">// results in a runtime error:</span></span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="co">// panic: interface conversion: interface {} is int, not float64</span></span></code></pre></div>
<h3 id="date-and-time">Date and Time</h3>
<p>Anyone that has written Go previously, will probably already know
what I am getting at here. For the uninitiated, parsing and formatting
dates in Go requires a “layout”. This “layout” is based on magical
reference date:</p>
<pre><code>Mon Jan 2 15:04:05 MST 2006</code></pre>
<p>Which is the date produced when you write the first seven natural
numbers like so:</p>
<pre><code>01/02 03:04:05 &#39;06 -0700</code></pre>
<p>Parsing a string in <code>YYYY-MM-DD</code> format would look
something like:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode go"><code class="sourceCode go"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="kw">const</span> layout <span class="op">=</span> <span class="st">&quot;2006-01-02&quot;</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a>time<span class="op">.</span>Parse<span class="op">(</span>layout<span class="op">,</span> <span class="st">&quot;2020-08-01&quot;</span><span class="op">)</span></span></code></pre></div>
<p>This so-called “intuitive” method of formatting dates doesn’t allow
you to print <code>0000 hrs</code> as <code>2400 hrs</code>, it doesn’t
allow you to omit the leading zero in 24 hour formats. It is rife with
inconveniences, if only there were a <a
href="https://man7.org/linux/man-pages/man3/strftime.3.html">tried and
tested</a> date formatting convention …</p>
<h3 id="statements-over-expressions">Statements over Expressions</h3>
<p>Statements have side effects, expressions return values. More often
than not, expressions are easier to understand at a glance: evaluate the
LHS and assign the same to the RHS.</p>
<p>Rust allows you to create local namespaces, and treats blocks
(<code>{}</code>) as expressions:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> twenty_seven <span class="op">=</span> <span class="op">{</span></span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> three <span class="op">=</span> <span class="dv">1</span> <span class="op">+</span> <span class="dv">2</span><span class="op">;</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> nine <span class="op">=</span> three <span class="op">*</span> three<span class="op">;</span></span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> nine <span class="op">*</span> three</span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a><span class="op">};</span></span></code></pre></div>
<p>The Go equivalent of the same:</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode go"><code class="sourceCode go"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>twenty_seven <span class="op">:=</span> <span class="ot">nil</span></span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a>three <span class="op">:=</span> <span class="dv">1</span> <span class="op">+</span> <span class="dv">2</span></span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a>nine <span class="op">:=</span> three <span class="op">*</span> three</span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a>twenty_seven <span class="op">=</span> nine <span class="op">*</span> three</span></code></pre></div>
<h3 id="erroring-out-on-unused-variables">Erroring out on unused
variables</h3>
<p>Want to quickly prototype something? Go says no! In all seriousness,
a warning would suffice, I don’t want to have to go back and comment
each unused import out, only to come back and uncomment them a few
seconds later.</p>
<h3 id="error-handling">Error handling</h3>
<div class="sourceCode" id="cb10"><pre
class="sourceCode go"><code class="sourceCode go"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> err <span class="op">!=</span> <span class="ot">nil</span> <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
<p>Need I say more? I will, for good measure:</p>
<ol type="1">
<li>Error handling is optional</li>
<li>Errors are propagated via a clunky <code>if</code> +
<code>return</code> statement</li>
</ol>
<p>I prefer Haskell’s “Monadic” error handling, which is employed by
Rust as well:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="co">// 1. error handling is compulsory</span></span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="co">// 2. errors are propagated with the `?` operator</span></span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> foo() <span class="op">-&gt;</span> <span class="dt">Result</span><span class="op">&lt;</span><span class="dt">String</span><span class="op">,</span> <span class="pp">io::</span><span class="bu">Error</span><span class="op">&gt;</span> <span class="op">{</span></span>
<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> <span class="kw">mut</span> f <span class="op">=</span> <span class="pp">File::</span>open(<span class="st">&quot;foo.txt&quot;</span>)<span class="op">?;</span> <span class="co">// return if error</span></span>
<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> <span class="kw">mut</span> s <span class="op">=</span> <span class="dt">String</span><span class="pp">::</span>new()<span class="op">;</span></span>
<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a> f<span class="op">.</span>read_to_string(<span class="op">&amp;</span><span class="kw">mut</span> s)<span class="op">?;</span> <span class="co">// return if error</span></span>
<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a> <span class="cn">Ok</span>(s) <span class="co">// all good, return a string inside a `Result` context</span></span>
<span id="cb11-10"><a href="#cb11-10" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb11-11"><a href="#cb11-11" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-12"><a href="#cb11-12" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span>
<span id="cb11-13"><a href="#cb11-13" aria-hidden="true" tabindex="-1"></a> <span class="co">// `contents` is an enum known as Result:</span></span>
<span id="cb11-14"><a href="#cb11-14" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> contents <span class="op">=</span> foo()<span class="op">;</span></span>
<span id="cb11-15"><a href="#cb11-15" aria-hidden="true" tabindex="-1"></a> <span class="cf">match</span> contents <span class="op">{</span></span>
<span id="cb11-16"><a href="#cb11-16" aria-hidden="true" tabindex="-1"></a> <span class="cn">Ok</span>(c) <span class="op">=&gt;</span> <span class="pp">println!</span>(c)<span class="op">,</span></span>
<span id="cb11-17"><a href="#cb11-17" aria-hidden="true" tabindex="-1"></a> <span class="cn">Err</span>(e) <span class="op">=&gt;</span> <span class="pp">eprintln!</span>(e)</span>
<span id="cb11-18"><a href="#cb11-18" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb11-19"><a href="#cb11-19" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<h3 id="conclusion">Conclusion</h3>
<p>I did not want to conclude without talking about stylistic choices,
lack of metaprogramming, bizzare export rules, but, I am too busy
converting my <code>interface{}</code> types into actual generic code
for Go v2.</p></description>
<link>https://peppe.rs/posts/gripes_with_go/</link>
<pubDate>Sat, 01 Aug 2020 11:55:00 +0000</pubDate>
<guid>https://peppe.rs/posts/gripes_with_go/</guid>
</item>
<item>
<title>Turing Complete Type Systems</title>
<description><p>Rust’s type system is Turing complete:</p>
<ul>
<li><a href="https://github.com/doctorn/trait-eval/">FizzBuzz with Rust
Traits</a></li>
<li><a href="https://github.com/Ashymad/fortraith">A Forth
implementation with Rust Traits</a></li>
</ul>
<p>It is impossible to determine if a program written in a generally
Turing complete system will ever stop. That is, it is impossible to
write a program <code>f</code> that determines if a program
<code>g</code>, where <code>g</code> is written in a Turing complete
programming language, will ever halt. The <a
href="https://en.wikipedia.org/wiki/Halting_problem">Halting Problem</a>
is in fact, an <a
href="https://en.wikipedia.org/wiki/Undecidable_problem">undecidable
problem</a>.</p>
<p><em>How is any of this relevant?</em></p>
<p>Rust performs compile-time type inference. The type checker, in turn,
compiles and infers types, I would describe it as a compiler inside a
compiler. It is possible that <code>rustc</code> may never finish
compiling your Rust program! I lied, <code>rustc</code> stops after a
while, after hitting the recursion limit.</p>
<p>I understand that this post lacks content.</p></description>
<link>https://peppe.rs/posts/turing_complete_type_systems/</link>
<pubDate>Wed, 17 Jun 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/turing_complete_type_systems/</guid>
</item>
<item>
<title>Auto-currying Rust Functions</title>
<description><p>This post contains a gentle introduction to procedural macros in Rust
and a guide to writing a procedural macro to curry Rust functions. The
source code for the entire library can be found <a
href="https://github.com/nerdypepper/cutlass">here</a>. It is also
available on <a
href="https://crates.io/crates/cutlass">crates.io</a>.</p>
<p>The following links might prove to be useful before getting
started:</p>
<ul>
<li><a
href="https://doc.rust-lang.org/reference/procedural-macros.html">Procedural
Macros</a></li>
<li><a href="https://en.wikipedia.org/wiki/Currying">Currying</a></li>
</ul>
<p>Or you can pretend you read them, because I have included a primer
here :)</p>
<h3 id="contents">Contents</h3>
<ol type="1">
<li><a href="#currying">Currying</a><br />
</li>
<li><a href="#procedural-macros">Procedural Macros</a><br />
</li>
<li><a href="#definitions">Definitions</a><br />
</li>
<li><a href="#refinement">Refinement</a><br />
</li>
<li><a href="#the-in-betweens">The In-betweens</a><br />
5.1 <a href="#dependencies">Dependencies</a><br />
5.2 <a href="#the-attribute-macro">The attribute macro</a><br />
5.3 <a href="#function-body">Function Body</a><br />
5.4 <a href="#function-signature">Function Signature</a><br />
5.5 <a href="#getting-it-together">Getting it together</a><br />
</li>
<li><a href="#debugging-and-testing">Debugging and Testing</a><br />
</li>
<li><a href="#notes">Notes</a><br />
</li>
<li><a href="#conclusion">Conclusion</a></li>
</ol>
<h3 id="currying">Currying</h3>
<p>Currying is the process of transformation of a function call like
<code>f(a, b, c)</code> to <code>f(a)(b)(c)</code>. A curried function
returns a concrete value only when it receives all its arguments! If it
does recieve an insufficient amount of arguments, say 1 of 3, it returns
a <em>curried function</em>, that returns after receiving 2
arguments.</p>
<pre><code>curry(f(a, b, c)) = h(a)(b)(c)
h(x) = g &lt;- curried function that takes upto 2 args (g)
g(y) = k &lt;- curried function that takes upto 1 arg (k)
k(z) = v &lt;- a value (v)
Keen readers will conclude the following,
h(x)(y)(z) = g(y)(z) = k(z) = v</code></pre>
<p>Mathematically, if <code>f</code> is a function that takes two
arguments <code>x</code> and <code>y</code>, such that
<code>x ϵ X</code>, and <code>y ϵ Y</code> , we write it as:</p>
<pre><code>f: (X × Y) -&gt; Z</code></pre>
<p>where <code>×</code> denotes the Cartesian product of set
<code>X</code> and <code>Y</code>, and curried <code>f</code> (denoted
by <code>h</code> here) is written as:</p>
<pre><code>h: X -&gt; (Y -&gt; Z)</code></pre>
<h3 id="procedural-macros">Procedural Macros</h3>
<p>These are functions that take code as input and spit out modified
code as output. Powerful stuff. Rust has three kinds of proc-macros:</p>
<ul>
<li>Function like macros<br />
</li>
<li>Derive macros: <code>#[derive(...)]</code>, used to automatically
implement traits for structs/enums<br />
</li>
<li>and Attribute macros: <code>#[test]</code>, usually slapped onto
functions</li>
</ul>
<p>We will be using Attribute macros to convert a Rust function into a
curried Rust function, which we should be able to call via:
<code>function(arg1)(arg2)</code>.</p>
<h3 id="definitions">Definitions</h3>
<p>Being respectable programmers, we define the input to and the output
from our proc-macro. Here’s a good non-trivial function to start out
with:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Hmm, what would our output look like? What should our proc-macro
generate ideally? Well, if we understood currying correctly, we should
accept an argument and return a function that accepts an argument and
returns … you get the point. Something like this should do:</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add_curried1(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="op">?</span> <span class="op">{</span></span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> <span class="kw">fn</span> add_curried2 (y<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="op">?</span> <span class="op">{</span></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> <span class="kw">fn</span> add_curried3 (z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>A couple of things to note:</p>
<p><strong>Return types</strong><br />
We have placed <code>?</code>s in place of return types. Let’s try to
fix that. <code>add_curried3</code> returns the ‘value’, so
<code>u32</code> is accurate. <code>add_curried2</code> returns
<code>add_curried3</code>. What is the type of
<code>add_curried3</code>? It is a function that takes in a
<code>u32</code> and returns a <code>u32</code>. So a
<code>fn(u32) -&gt; u32</code> will do right? No, I’ll explain why in
the next point, but for now, we will make use of the <code>Fn</code>
trait, our return type is <code>impl Fn(u32) -&gt; u32</code>. This
basically tells the compiler that we will be returning something
function-like, a.k.a, behaves like a <code>Fn</code>. Cool!</p>
<p>If you have been following along, you should be able to tell that the
return type of <code>add_curried1</code> is:</p>
<pre><code>impl Fn(u32) -&gt; (impl Fn(u32) -&gt; u32)</code></pre>
<p>We can drop the parentheses because <code>-&gt;</code> is right
associative:</p>
<pre><code>impl Fn(u32) -&gt; impl Fn(u32) -&gt; u32
</code></pre>
<p><strong>Accessing environment</strong><br />
A function cannot access it’s environment. Our solution will not work.
<code>add_curried3</code> attempts to access <code>x</code>, which is
not allowed! A closure<a href="#fn1" class="footnote-ref" id="fnref1"
role="doc-noteref"><sup>1</sup></a> however, can. If we are returning a
closure, our return type must be <code>impl Fn</code>, and not
<code>fn</code>. The difference between the <code>Fn</code> trait and
function pointers is beyond the scope of this post.</p>
<h3 id="refinement">Refinement</h3>
<p>Armed with knowledge, we refine our expected output, this time,
employing closures:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> <span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Alas, that does not compile either! It errors out with the following
message:</p>
<pre><code>error[E0562]: `impl Trait` not allowed outside of function
and inherent method return types
--&gt; src/main.rs:17:37
|
| fn add(x: u32) -&gt; impl Fn(u32) -&gt; impl Fn(u32) -&gt; u32
| ^^^^^^^^^^^^^^^^^^^
</code></pre>
<p>You are allowed to return an <code>impl Fn</code> only inside a
function. We are currently returning it from another return! Or at
least, that was the most I could make out of the error message.</p>
<p>We are going to have to cheat a bit to fix this issue; with type
aliases and a convenient nightly feature <a href="#fn2"
class="footnote-ref" id="fnref2"
role="doc-noteref"><sup>2</sup></a>:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="at">#![</span>feature<span class="at">(</span>type_alias_impl_trait<span class="at">)]</span> <span class="co">// allows us to use `impl Fn` in type aliases!</span></span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span> <span class="co">// the return value when zero args are to be applied</span></span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span> <span class="co">// the return value when one arg is to be applied</span></span>
<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T1<span class="op">;</span> <span class="co">// the return value when two args are to be applied</span></span>
<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> T2 <span class="op">{</span></span>
<span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> <span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
<span id="cb10-9"><a href="#cb10-9" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Drop that into a cargo project, call <code>add(4)(5)(6)</code>, cross
your fingers, and run <code>cargo +nightly run</code>. You should see a
15 unless you forgot to print it!</p>
<h3 id="the-in-betweens">The In-Betweens</h3>
<p>Let us write the magical bits that take us from function to curried
function.</p>
<p>Initialize your workspace with <code>cargo new --lib currying</code>.
Proc-macro crates are libraries with exactly one export, the macro
itself. Add a <code>tests</code> directory to your crate root. Your
directory should look something like this:</p>
<pre><code>.
├── Cargo.toml
├── src
│ └── lib.rs
└── tests
└── smoke.rs</code></pre>
<h4 id="dependencies">Dependencies</h4>
<p>We will be using a total of 3 external crates:</p>
<ul>
<li><a
href="https://docs.rs/proc-macro2/1.0.12/proc_macro2/">proc_macro2</a></li>
<li><a href="https://docs.rs/syn/1.0.18/syn/index.html">syn</a></li>
<li><a
href="https://docs.rs/quote/1.0.4/quote/index.html">quote</a></li>
</ul>
<p>Here’s a sample <code>Cargo.toml</code>:</p>
<pre><code># Cargo.toml
[dependencies]
proc-macro2 = &quot;1.0.9&quot;
quote = &quot;1.0&quot;
[dependencies.syn]
version = &quot;1.0&quot;
features = [&quot;full&quot;]
[lib]
proc-macro = true # this is important!</code></pre>
<p>We will be using an external <code>proc-macro2</code> crate as well
as an internal <code>proc-macro</code> crate. Not confusing at all!</p>
<h4 id="the-attribute-macro">The attribute macro</h4>
<p>Drop this into <code>src/lib.rs</code>, to get the ball rolling.</p>
<div class="sourceCode" id="cb13"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">proc_macro::</span>TokenStream<span class="op">;</span> <span class="co">// 1</span></span>
<span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">quote::</span>quote<span class="op">;</span></span>
<span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> ItemFn<span class="op">};</span></span>
<span id="cb13-6"><a href="#cb13-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-7"><a href="#cb13-7" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>proc_macro_attribute<span class="at">]</span> <span class="co">// 2</span></span>
<span id="cb13-8"><a href="#cb13-8" aria-hidden="true" tabindex="-1"></a><span class="kw">pub</span> <span class="kw">fn</span> curry(_attr<span class="op">:</span> TokenStream<span class="op">,</span> item<span class="op">:</span> TokenStream) <span class="op">-&gt;</span> TokenStream <span class="op">{</span></span>
<span id="cb13-9"><a href="#cb13-9" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> parsed <span class="op">=</span> <span class="pp">parse_macro_input!</span>(item <span class="kw">as</span> ItemFn)<span class="op">;</span> <span class="co">// 3</span></span>
<span id="cb13-10"><a href="#cb13-10" aria-hidden="true" tabindex="-1"></a> generate_curry(parsed)<span class="op">.</span>into() <span class="co">// 4</span></span>
<span id="cb13-11"><a href="#cb13-11" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb13-12"><a href="#cb13-12" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb13-13"><a href="#cb13-13" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{}</span></span></code></pre></div>
<p><strong>1. Imports</strong></p>
<p>A <code>Tokenstream</code> holds (hopefully valid) Rust code, this is
the type of our input and output. Note that we are importing this type
from <code>proc_macro</code> and not <code>proc_macro2</code>.</p>
<p><code>quote!</code> from the <code>quote</code> crate is a macro that
allows us to quickly produce <code>TokenStream</code>s. Much like the
LISP <code>quote</code> procedure, you can use the <code>quote!</code>
macro for symbolic transformations.</p>
<p><code>ItemFn</code> from the <code>syn</code> crate holds the parsed
<code>TokenStream</code> of a Rust function.
<code>parse_macro_input!</code> is a helper macro provided by
<code>syn</code>.</p>
<p><strong>2. The lone export</strong></p>
<p>Annotate the only <code>pub</code> of our crate with
<code>#[proc_macro_attribute]</code>. This tells rustc that
<code>curry</code> is a procedural macro, and allows us to use it as
<code>#[crate_name::curry]</code> in other crates. Note the signature of
the <code>curry</code> function. <code>_attr</code> is the
<code>TokenStream</code> representing the attribute itself,
<code>item</code> refers to the thing we slapped our macro into, in this
case a function (like <code>add</code>). The return value is a modified
<code>TokenStream</code>, this will contain our curried version of
<code>add</code>.</p>
<p><strong>3. The helper macro</strong></p>
<p>A <code>TokenStream</code> is a little hard to work with, which is
why we have the <code>syn</code> crate, which provides types to
represent Rust tokens. An <code>RArrow</code> struct to represent the
return arrow on a function and so on. One of those types is
<code>ItemFn</code>, that represents an entire Rust function. The
<code>parse_macro_input!</code> automatically puts the input to our
macro into an <code>ItemFn</code>. What a gentleman!</p>
<p><strong>4. Returning <code>TokenStream</code>s </strong></p>
<p>We haven’t filled in <code>generate_curry</code> yet, but we can see
that it returns a <code>proc_macro2::TokenStream</code> and not a
<code>proc_macro::TokenStream</code>, so drop a <code>.into()</code> to
convert it.</p>
<p>Lets move on, and fill in <code>generate_curry</code>, I would
suggest keeping the documentation for <a
href="https://docs.rs/syn/1.0.19/syn/struct.ItemFn.html"><code>syn::ItemFn</code></a>
and <a
href="https://docs.rs/syn/1.0.19/syn/struct.Signature.html"><code>syn::Signature</code></a>
open.</p>
<div class="sourceCode" id="cb14"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
<span id="cb14-4"><a href="#cb14-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span> <span class="co">// function body</span></span>
<span id="cb14-5"><a href="#cb14-5" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span> <span class="co">// function signature</span></span>
<span id="cb14-6"><a href="#cb14-6" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span> <span class="co">// visibility, pub or not</span></span>
<span id="cb14-7"><a href="#cb14-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span> <span class="co">// function name/identifier</span></span>
<span id="cb14-8"><a href="#cb14-8" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span> <span class="co">// comma separated args</span></span>
<span id="cb14-9"><a href="#cb14-9" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span> <span class="co">// return type</span></span>
<span id="cb14-10"><a href="#cb14-10" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>We are simply extracting the bits of the function, we will be reusing
the original function’s visibility and name. Take a look at what
<code>syn::Signature</code> can tell us about a function:</p>
<pre><code> .-- syn::Ident (ident)
/
fn add(x: u32, y: u32) -&gt; u32
(fn_token) / ~~~~~~~,~~~~~~ ~~~~~~
syn::token::Fn --&#39; / \ (output)
&#39; `- syn::ReturnType
Punctuated&lt;FnArg, Comma&gt; (inputs)</code></pre>
<p>Enough analysis, lets produce our first bit of Rust code.</p>
<h4 id="function-body">Function Body</h4>
<p>Recall that the body of a curried <code>add</code> should look like
this:</p>
<div class="sourceCode" id="cb16"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="cf">return</span> <span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span></code></pre></div>
<p>And in general:</p>
<div class="sourceCode" id="cb17"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a><span class="cf">return</span> <span class="kw">move</span> <span class="op">|</span>arg2<span class="op">|</span> <span class="kw">move</span> <span class="op">|</span>arg3<span class="op">|</span> <span class="op">...</span> <span class="op">|</span>argN<span class="op">|</span> <span class="op">&lt;</span>function body here<span class="op">&gt;</span></span></code></pre></div>
<p>We already have the function’s body, provided by
<code>fn_body</code>, in our <code>generate_curry</code> function. All
that’s left to add is the <code>move |arg2| move |arg3| ...</code>
stuff, for which we need to extract the argument identifiers (doc: <a
href="https://docs.rs/syn/1.0.18/syn/punctuated/struct.Punctuated.html">Punctuated</a>,
<a href="https://docs.rs/syn/1.0.18/syn/enum.FnArg.html">FnArg</a>, <a
href="https://docs.rs/syn/1.0.18/syn/struct.PatType.html">PatType</a>):</p>
<div class="sourceCode" id="cb18"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">syn::punctuated::</span>Punctuated<span class="op">;</span></span>
<span id="cb18-3"><a href="#cb18-3" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> FnArg<span class="op">,</span> Pat<span class="op">,</span> ItemFn<span class="op">,</span> Block<span class="op">};</span></span>
<span id="cb18-4"><a href="#cb18-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb18-5"><a href="#cb18-5" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> extract_arg_idents(fn_args<span class="op">:</span> Punctuated<span class="op">&lt;</span>FnArg<span class="op">,</span> <span class="pp">syn::token::</span>Comma<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;&gt;</span> <span class="op">{</span> </span>
<span id="cb18-6"><a href="#cb18-6" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> fn_args<span class="op">.</span>into_iter()<span class="op">.</span>map(extract_arg_pat)<span class="op">.</span><span class="pp">collect::</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span>_<span class="op">&gt;&gt;</span>()<span class="op">;</span></span>
<span id="cb18-7"><a href="#cb18-7" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Alright, so we are iterating over function args
(<code>Punctuated</code> is a collection that you can iterate over) and
mapping an <code>extract_arg_pat</code> to every item. What’s
<code>extract_arg_pat</code>?</p>
<div class="sourceCode" id="cb19"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> extract_arg_pat(a<span class="op">:</span> FnArg) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;</span> <span class="op">{</span></span>
<span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a> <span class="cf">match</span> a <span class="op">{</span></span>
<span id="cb19-5"><a href="#cb19-5" aria-hidden="true" tabindex="-1"></a> <span class="pp">FnArg::</span>Typed(p) <span class="op">=&gt;</span> p<span class="op">.</span>pat<span class="op">,</span></span>
<span id="cb19-6"><a href="#cb19-6" aria-hidden="true" tabindex="-1"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on types with `self`!&quot;</span>)<span class="op">,</span></span>
<span id="cb19-7"><a href="#cb19-7" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb19-8"><a href="#cb19-8" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p><code>FnArg</code> is an enum type as you might have guessed. The
<code>Typed</code> variant encompasses args that are written as
<code>name: type</code> and the other variant, <code>Reciever</code>
refers to <code>self</code> types. Ignore those for now, keep it
simple.</p>
<p>Every <code>FnArg::Typed</code> value contains a <code>pat</code>,
which is in essence, the name of the argument. The type of the arg is
accessible via <code>p.ty</code> (we will be using this later).</p>
<p>With that done, we should be able to write the codegen for the
function body:</p>
<div class="sourceCode" id="cb20"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb20-2"><a href="#cb20-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb20-3"><a href="#cb20-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> generate_body(fn_args<span class="op">:</span> <span class="op">&amp;</span>[<span class="dt">Box</span><span class="op">&lt;</span>Pat<span class="op">&gt;</span>]<span class="op">,</span> body<span class="op">:</span> <span class="dt">Box</span><span class="op">&lt;</span>Block<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
<span id="cb20-4"><a href="#cb20-4" aria-hidden="true" tabindex="-1"></a> <span class="pp">quote!</span> <span class="op">{</span></span>
<span id="cb20-5"><a href="#cb20-5" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> #( <span class="kw">move</span> <span class="op">|</span>#fn_args<span class="op">|</span> )<span class="op">*</span> #body</span>
<span id="cb20-6"><a href="#cb20-6" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb20-7"><a href="#cb20-7" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>That is some scary looking syntax! Allow me to explain. The
<code>quote!{ ... }</code> returns a
<code>proc_macro2::TokenStream</code>, if we wrote
<code>quote!{ let x = 1 + 2; }</code>, it wouldn’t create a new variable
<code>x</code> with value 3, it would literally produce a stream of
tokens with that expression.</p>
<p>The <code>#</code> enables variable interpolation. <code>#body</code>
will look for <code>body</code> in the current scope, take its value,
and insert it in the returned <code>TokenStream</code>. Kinda like quasi
quoting in LISPs, you have written one.</p>
<p>What about <code>#( move |#fn_args| )*</code>? That is repetition.
<code>quote</code> iterates through <code>fn_args</code>, and drops a
<code>move</code> behind each one, it then places pipes
(<code>|</code>), around it.</p>
<p>Let us test our first bit of codegen! Modify
<code>generate_curry</code> like so:</p>
<div class="sourceCode" id="cb21"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> TokenStream <span class="op">{</span></span>
<span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span></span>
<span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span></span>
<span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span></span>
<span id="cb21-7"><a href="#cb21-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span></span>
<span id="cb21-8"><a href="#cb21-8" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span></span>
<span id="cb21-9"><a href="#cb21-9" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span></span>
<span id="cb21-10"><a href="#cb21-10" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-11"><a href="#cb21-11" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> arg_idents <span class="op">=</span> extract_arg_idents(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
<span id="cb21-12"><a href="#cb21-12" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> first_ident <span class="op">=</span> <span class="op">&amp;</span>arg_idents<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
<span id="cb21-13"><a href="#cb21-13" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-14"><a href="#cb21-14" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="co">// remember, our curried body starts with the second argument!</span></span>
<span id="cb21-15"><a href="#cb21-15" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> curried_body <span class="op">=</span> generate_body(<span class="op">&amp;</span>arg_idents[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span> fn_body<span class="op">.</span>clone())<span class="op">;</span></span>
<span id="cb21-16"><a href="#cb21-16" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="pp">println!</span>(<span class="st">&quot;{}&quot;</span><span class="op">,</span> curried_body)<span class="op">;</span></span>
<span id="cb21-17"><a href="#cb21-17" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb21-18"><a href="#cb21-18" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> <span class="pp">TokenStream::</span>new()<span class="op">;</span></span>
<span id="cb21-19"><a href="#cb21-19" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<p>Add a little test to <code>tests/</code>:</p>
<div class="sourceCode" id="cb22"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="co">// tests/smoke.rs</span></span>
<span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span><span class="pp">currying::</span>curry<span class="at">]</span></span>
<span id="cb22-4"><a href="#cb22-4" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb22-5"><a href="#cb22-5" aria-hidden="true" tabindex="-1"></a> x <span class="op">+</span> y <span class="op">+</span> z</span>
<span id="cb22-6"><a href="#cb22-6" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb22-7"><a href="#cb22-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb22-8"><a href="#cb22-8" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>test<span class="at">]</span></span>
<span id="cb22-9"><a href="#cb22-9" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> works() <span class="op">{</span></span>
<span id="cb22-10"><a href="#cb22-10" aria-hidden="true" tabindex="-1"></a> <span class="pp">assert!</span>(<span class="cn">true</span>)<span class="op">;</span></span>
<span id="cb22-11"><a href="#cb22-11" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>You should find something like this in the output of
<code>cargo test</code>:</p>
<pre><code>return move | y | move | z | { x + y + z }</code></pre>
<p>Glorious <code>println!</code> debugging!</p>
<h4 id="function-signature">Function signature</h4>
<p>This section gets into the more complicated bits of the macro,
generating type aliases and the function signature. By the end of this
section, we should have a full working auto-currying macro!</p>
<p>Recall what our generated type aliases should look like, for our
<code>add</code> function:</p>
<div class="sourceCode" id="cb24"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb24-2"><a href="#cb24-2" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
<span id="cb24-3"><a href="#cb24-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T1<span class="op">;</span></span></code></pre></div>
<p>In general:</p>
<div class="sourceCode" id="cb25"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="op">&lt;</span><span class="cf">return</span> <span class="kw">type</span>&gt;<span class="op">;</span></span>
<span id="cb25-2"><a href="#cb25-2" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg N&gt;) -&gt; T0<span class="op">;</span></span>
<span id="cb25-3"><a href="#cb25-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg N - 1&gt;) -&gt; T1<span class="op">;</span></span>
<span id="cb25-4"><a href="#cb25-4" aria-hidden="true" tabindex="-1"></a><span class="op">.</span></span>
<span id="cb25-5"><a href="#cb25-5" aria-hidden="true" tabindex="-1"></a><span class="op">.</span></span>
<span id="cb25-6"><a href="#cb25-6" aria-hidden="true" tabindex="-1"></a><span class="op">.</span></span>
<span id="cb25-7"><a href="#cb25-7" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T(N-1) <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="op">&lt;</span><span class="kw">type</span> of arg 2&gt;) -&gt; T(N-2)<span class="op">;</span></span></code></pre></div>
<p>To codegen that, we need the types of:</p>
<ul>
<li>all our inputs (arguments)</li>
<li>the output (the return type)</li>
</ul>
<p>To fetch the types of all our inputs, we can simply reuse the bits we
wrote to fetch the names of all our inputs! (doc: <a
href="https://docs.rs/syn/1.0.18/syn/enum.Type.html">Type</a>)</p>
<div class="sourceCode" id="cb26"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb26-2"><a href="#cb26-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb26-3"><a href="#cb26-3" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">syn::</span><span class="op">{</span>parse_macro_input<span class="op">,</span> Block<span class="op">,</span> FnArg<span class="op">,</span> ItemFn<span class="op">,</span> Pat<span class="op">,</span> ReturnType<span class="op">,</span> Type<span class="op">};</span></span>
<span id="cb26-4"><a href="#cb26-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb26-5"><a href="#cb26-5" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> extract_type(a<span class="op">:</span> FnArg) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span> <span class="op">{</span></span>
<span id="cb26-6"><a href="#cb26-6" aria-hidden="true" tabindex="-1"></a> <span class="cf">match</span> a <span class="op">{</span></span>
<span id="cb26-7"><a href="#cb26-7" aria-hidden="true" tabindex="-1"></a> <span class="pp">FnArg::</span>Typed(p) <span class="op">=&gt;</span> p<span class="op">.</span>ty<span class="op">,</span> <span class="co">// notice `ty` instead of `pat`</span></span>
<span id="cb26-8"><a href="#cb26-8" aria-hidden="true" tabindex="-1"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on types with `self`!&quot;</span>)<span class="op">,</span></span>
<span id="cb26-9"><a href="#cb26-9" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb26-10"><a href="#cb26-10" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb26-11"><a href="#cb26-11" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb26-12"><a href="#cb26-12" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> extract_arg_types(fn_args<span class="op">:</span> Punctuated<span class="op">&lt;</span>FnArg<span class="op">,</span> <span class="pp">syn::token::</span>Comma<span class="op">&gt;</span>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;&gt;</span> <span class="op">{</span></span>
<span id="cb26-13"><a href="#cb26-13" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> fn_args<span class="op">.</span>into_iter()<span class="op">.</span>map(extract_type)<span class="op">.</span><span class="pp">collect::</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span>_<span class="op">&gt;&gt;</span>()<span class="op">;</span></span>
<span id="cb26-14"><a href="#cb26-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb26-15"><a href="#cb26-15" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>A good reader would have looked at the docs for output member of the
<code>syn::Signature</code> struct. It has the type
<code>syn::ReturnType</code>. So there is no extraction to do here
right? There are actually a couple of things we have to ensure here:</p>
<ol type="1">
<li><p>We need to ensure that the function returns! A function that does
not return is pointless in this case, and I will tell you why, in the <a
href="#notes">Notes</a> section.</p></li>
<li><p>A <code>ReturnType</code> encloses the arrow of the return as
well, we need to get rid of that. Recall:</p>
<div class="sourceCode" id="cb27"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span></span>
<span id="cb27-2"><a href="#cb27-2" aria-hidden="true" tabindex="-1"></a><span class="co">// and not</span></span>
<span id="cb27-3"><a href="#cb27-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="op">-&gt;</span> <span class="dt">u32</span></span></code></pre></div></li>
</ol>
<p>Here is the snippet that handles extraction of the return type (doc:
<a
href="https://docs.rs/syn/1.0.19/syn/enum.ReturnType.html">syn::ReturnType</a>):</p>
<div class="sourceCode" id="cb28"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb28-2"><a href="#cb28-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb28-3"><a href="#cb28-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> extract_return_type(a<span class="op">:</span> ReturnType) <span class="op">-&gt;</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span> <span class="op">{</span></span>
<span id="cb28-4"><a href="#cb28-4" aria-hidden="true" tabindex="-1"></a> <span class="cf">match</span> a <span class="op">{</span></span>
<span id="cb28-5"><a href="#cb28-5" aria-hidden="true" tabindex="-1"></a> <span class="pp">ReturnType::</span>Type(_<span class="op">,</span> p) <span class="op">=&gt;</span> p<span class="op">,</span></span>
<span id="cb28-6"><a href="#cb28-6" aria-hidden="true" tabindex="-1"></a> _ <span class="op">=&gt;</span> <span class="pp">panic!</span>(<span class="st">&quot;Not supported on functions without return types!&quot;</span>)<span class="op">,</span></span>
<span id="cb28-7"><a href="#cb28-7" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb28-8"><a href="#cb28-8" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>You might notice that we are making extensive use of the
<code>panic!</code> macro. Well, that is because it is a good idea to
quit on receiving an unsatisfactory <code>TokenStream</code>.</p>
<p>With all our types ready, we can get on with generating type
aliases:</p>
<div class="sourceCode" id="cb29"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb29-2"><a href="#cb29-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-3"><a href="#cb29-3" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">quote::</span><span class="op">{</span>quote<span class="op">,</span> format_ident<span class="op">};</span></span>
<span id="cb29-4"><a href="#cb29-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-5"><a href="#cb29-5" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> generate_type_aliases(</span>
<span id="cb29-6"><a href="#cb29-6" aria-hidden="true" tabindex="-1"></a> fn_arg_types<span class="op">:</span> <span class="op">&amp;</span>[<span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;</span>]<span class="op">,</span></span>
<span id="cb29-7"><a href="#cb29-7" aria-hidden="true" tabindex="-1"></a> fn_return_type<span class="op">:</span> <span class="dt">Box</span><span class="op">&lt;</span>Type<span class="op">&gt;,</span></span>
<span id="cb29-8"><a href="#cb29-8" aria-hidden="true" tabindex="-1"></a> fn_name<span class="op">:</span> <span class="op">&amp;</span><span class="pp">syn::</span>Ident<span class="op">,</span></span>
<span id="cb29-9"><a href="#cb29-9" aria-hidden="true" tabindex="-1"></a>) <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="pp">proc_macro2::</span>TokenStream<span class="op">&gt;</span> <span class="op">{</span> <span class="co">// 1</span></span>
<span id="cb29-10"><a href="#cb29-10" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-11"><a href="#cb29-11" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> type_t0 <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_T0&quot;</span><span class="op">,</span> fn_name)<span class="op">;</span> <span class="co">// 2</span></span>
<span id="cb29-12"><a href="#cb29-12" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> <span class="kw">mut</span> type_aliases <span class="op">=</span> <span class="pp">vec!</span>[<span class="pp">quote!</span> <span class="op">{</span> <span class="kw">type</span> #type_t0 <span class="op">=</span> #fn_return_type <span class="op">}</span>]<span class="op">;</span></span>
<span id="cb29-13"><a href="#cb29-13" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-14"><a href="#cb29-14" aria-hidden="true" tabindex="-1"></a> <span class="co">// 3</span></span>
<span id="cb29-15"><a href="#cb29-15" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> (i<span class="op">,</span> t) <span class="kw">in</span> (<span class="dv">1</span><span class="op">..</span>)<span class="op">.</span>zip(fn_arg_types<span class="op">.</span>into_iter()<span class="op">.</span>rev()) <span class="op">{</span></span>
<span id="cb29-16"><a href="#cb29-16" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> p <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> i <span class="op">-</span> <span class="dv">1</span>))<span class="op">;</span></span>
<span id="cb29-17"><a href="#cb29-17" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> n <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> i))<span class="op">;</span></span>
<span id="cb29-18"><a href="#cb29-18" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-19"><a href="#cb29-19" aria-hidden="true" tabindex="-1"></a> type_aliases<span class="op">.</span>push(<span class="pp">quote!</span> <span class="op">{</span></span>
<span id="cb29-20"><a href="#cb29-20" aria-hidden="true" tabindex="-1"></a> <span class="kw">type</span> #n <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(#t) <span class="op">-&gt;</span> #p</span>
<span id="cb29-21"><a href="#cb29-21" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span>)<span class="op">;</span></span>
<span id="cb29-22"><a href="#cb29-22" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb29-23"><a href="#cb29-23" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb29-24"><a href="#cb29-24" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> type_aliases<span class="op">;</span></span>
<span id="cb29-25"><a href="#cb29-25" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p><strong>1. The return value</strong><br />
We are returning a <code>Vec&lt;proc_macro2::TokenStream&gt;</code>, i.
e., a list of <code>TokenStream</code>s, where each item is a type
alias.</p>
<p><strong>2. Format identifier?</strong><br />
I’ve got some explanation to do on this line. Clearly, we are trying to
write the first type alias, and initialize our <code>TokenStream</code>
vector with <code>T0</code>, because it is different from the
others:</p>
<div class="sourceCode" id="cb30"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> something</span>
<span id="cb30-2"><a href="#cb30-2" aria-hidden="true" tabindex="-1"></a><span class="co">// the others are of the form</span></span>
<span id="cb30-3"><a href="#cb30-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> Tr <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(something) <span class="op">-&gt;</span> something</span></code></pre></div>
<p><code>format_ident!</code> is similar to <code>format!</code>.
Instead of returning a formatted string, it returns a
<code>syn::Ident</code>. Therefore, <code>type_t0</code> is actually an
identifier for, in the case of our <code>add</code> function,
<code>_add_T0</code>. Why is this formatting important? Namespacing.</p>
<p>Picture this, we have two functions, <code>add</code> and
<code>subtract</code>, that we wish to curry with our macro:</p>
<div class="sourceCode" id="cb31"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb31-1"><a href="#cb31-1" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>curry<span class="at">]</span></span>
<span id="cb31-2"><a href="#cb31-2" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(<span class="op">...</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
<span id="cb31-3"><a href="#cb31-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb31-4"><a href="#cb31-4" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>curry<span class="at">]</span></span>
<span id="cb31-5"><a href="#cb31-5" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> sub(<span class="op">...</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
<p>Here is the same but with macros expanded:</p>
<div class="sourceCode" id="cb32"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb32-2"><a href="#cb32-2" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
<span id="cb32-3"><a href="#cb32-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add( <span class="op">...</span> ) <span class="op">-&gt;</span> T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
<span id="cb32-4"><a href="#cb32-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb32-5"><a href="#cb32-5" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb32-6"><a href="#cb32-6" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> T0<span class="op">;</span></span>
<span id="cb32-7"><a href="#cb32-7" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> sub( <span class="op">...</span> ) <span class="op">-&gt;</span> T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
<p>We end up with two definitions of <code>T0</code>! Now, if we do the
little <code>format_ident!</code> dance we did up there:</p>
<div class="sourceCode" id="cb33"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _add_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb33-2"><a href="#cb33-2" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _add_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T0<span class="op">;</span></span>
<span id="cb33-3"><a href="#cb33-3" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add( <span class="op">...</span> ) <span class="op">-&gt;</span> _add_T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span>
<span id="cb33-4"><a href="#cb33-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb33-5"><a href="#cb33-5" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _sub_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb33-6"><a href="#cb33-6" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _sub_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _sub_T0<span class="op">;</span></span>
<span id="cb33-7"><a href="#cb33-7" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> sub( <span class="op">...</span> ) <span class="op">-&gt;</span> _sub_T1 <span class="op">{</span> <span class="op">...</span> <span class="op">}</span></span></code></pre></div>
<p>Voilà! The type aliases don’t tread on each other. Remember to import
<code>format_ident</code> from the <code>quote</code> crate.</p>
<p><strong>3. The TokenStream Vector</strong></p>
<p>We iterate over our types in reverse order (<code>T0</code> is the
last return, <code>T1</code> is the second last, so on), assign a number
to each iteration with <code>zip</code>, generate type names with
<code>format_ident</code>, push a <code>TokenStream</code> with the help
of <code>quote</code> and variable interpolation.</p>
<p>If you are wondering why we used <code>(1..).zip()</code> instead of
<code>.enumerate()</code>, it’s because we wanted to start counting from
1 instead of 0 (we are already done with <code>T0</code>!).</p>
<h4 id="getting-it-together">Getting it together</h4>
<p>I promised we’d have a fully working macro by the end of last
section. I lied, we have to tie everything together in our
<code>generate_curry</code> function:</p>
<div class="sourceCode" id="cb34"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a><span class="co">// src/lib.rs</span></span>
<span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb34-3"><a href="#cb34-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> generate_curry(parsed<span class="op">:</span> ItemFn) <span class="op">-&gt;</span> <span class="pp">proc_macro2::</span>TokenStream <span class="op">{</span></span>
<span id="cb34-4"><a href="#cb34-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_body <span class="op">=</span> parsed<span class="op">.</span>block<span class="op">;</span></span>
<span id="cb34-5"><a href="#cb34-5" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> sig <span class="op">=</span> parsed<span class="op">.</span>sig<span class="op">;</span></span>
<span id="cb34-6"><a href="#cb34-6" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> vis <span class="op">=</span> parsed<span class="op">.</span>vis<span class="op">;</span></span>
<span id="cb34-7"><a href="#cb34-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_name <span class="op">=</span> sig<span class="op">.</span>ident<span class="op">;</span></span>
<span id="cb34-8"><a href="#cb34-8" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_args <span class="op">=</span> sig<span class="op">.</span>inputs<span class="op">;</span></span>
<span id="cb34-9"><a href="#cb34-9" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> fn_return_type <span class="op">=</span> sig<span class="op">.</span>output<span class="op">;</span></span>
<span id="cb34-10"><a href="#cb34-10" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb34-11"><a href="#cb34-11" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> arg_idents <span class="op">=</span> extract_arg_idents(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
<span id="cb34-12"><a href="#cb34-12" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> first_ident <span class="op">=</span> <span class="op">&amp;</span>arg_idents<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
<span id="cb34-13"><a href="#cb34-13" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> curried_body <span class="op">=</span> generate_body(<span class="op">&amp;</span>arg_idents[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span> fn_body<span class="op">.</span>clone())<span class="op">;</span></span>
<span id="cb34-14"><a href="#cb34-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb34-15"><a href="#cb34-15" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> arg_types <span class="op">=</span> extract_arg_types(fn_args<span class="op">.</span>clone())<span class="op">;</span></span>
<span id="cb34-16"><a href="#cb34-16" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> first_type <span class="op">=</span> <span class="op">&amp;</span>arg_types<span class="op">.</span>first()<span class="op">.</span>unwrap()<span class="op">;</span></span>
<span id="cb34-17"><a href="#cb34-17" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> type_aliases <span class="op">=</span> generate_type_aliases(</span>
<span id="cb34-18"><a href="#cb34-18" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">&amp;</span>arg_types[<span class="dv">1</span><span class="op">..</span>]<span class="op">,</span></span>
<span id="cb34-19"><a href="#cb34-19" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> extract_return_type(fn_return_type)<span class="op">,</span></span>
<span id="cb34-20"><a href="#cb34-20" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">&amp;</span>fn_name<span class="op">,</span></span>
<span id="cb34-21"><a href="#cb34-21" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> )<span class="op">;</span></span>
<span id="cb34-22"><a href="#cb34-22" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb34-23"><a href="#cb34-23" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="kw">let</span> return_type <span class="op">=</span> <span class="pp">format_ident!</span>(<span class="st">&quot;_{}_{}&quot;</span><span class="op">,</span> <span class="op">&amp;</span>fn_name<span class="op">,</span> <span class="pp">format!</span>(<span class="st">&quot;T{}&quot;</span><span class="op">,</span> type_aliases<span class="op">.</span>len() <span class="op">-</span> <span class="dv">1</span>))<span class="op">;</span></span>
<span id="cb34-24"><a href="#cb34-24" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb34-25"><a href="#cb34-25" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="cf">return</span> <span class="pp">quote!</span> <span class="op">{</span></span>
<span id="cb34-26"><a href="#cb34-26" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> #(#type_aliases)<span class="op">;*</span> <span class="op">;</span></span>
<span id="cb34-27"><a href="#cb34-27" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> #vis <span class="kw">fn</span> #fn_name (#first_ident<span class="op">:</span> #first_type) <span class="op">-&gt;</span> #return_type <span class="op">{</span></span>
<span id="cb34-28"><a href="#cb34-28" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> #curried_body <span class="op">;</span></span>
<span id="cb34-29"><a href="#cb34-29" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">}</span></span>
<span id="cb34-30"><a href="#cb34-30" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="op">};</span></span>
<span id="cb34-31"><a href="#cb34-31" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<p>Most of the additions are self explanatory, I’ll go through the
return statement with you. We are returning a
<code>quote!{ ... }</code>, so a <code>proc_macro2::TokenStream</code>.
We are iterating through the <code>type_aliases</code> variable, which
you might recall, is a <code>Vec&lt;TokenStream&gt;</code>. You might
notice the sneaky semicolon before the <code>*</code>. This basically
tells <code>quote</code>, to insert an item, then a semicolon, and then
the next one, another semicolon, and so on. The semicolon is a
separator. We need to manually insert another semicolon at the end of it
all, <code>quote</code> doesn’t insert a separator at the end of the
iteration.</p>
<p>We retain the visibility and name of our original function. Our
curried function takes as args, just the first argument of our original
function. The return type of our curried function is actually, the last
type alias we create. If you think back to our manually curried
<code>add</code> function, we returned <code>T2</code>, which was in
fact, the last type alias we created.</p>
<p>I am sure, at this point, you are itching to test this out, but
before that, let me introduce you to some good methods of debugging
proc-macro code.</p>
<h3 id="debugging-and-testing">Debugging and Testing</h3>
<p>Install <code>cargo-expand</code> via:</p>
<pre><code>cargo install cargo-expand</code></pre>
<p><code>cargo-expand</code> is a neat little tool that expands your
macro in places where it is used, and lets you view the generated code!
For example:</p>
<pre class="shell"><code># create a bin package hello
$ cargo new hello
# view the expansion of the println! macro
$ cargo expand
#![feature(prelude_import)]
#[prelude_import]
use std::prelude::v1::*;
#[macro_use]
extern crate std;
fn main() {
{
::std::io::_print(::core::fmt::Arguments::new_v1(
&amp;[&quot;Hello, world!\n&quot;],
&amp;match () {
() =&gt; [],
},
));
};
}</code></pre>
<p>Writing proc-macros without <code>cargo-expand</code> is tantamount
to driving a vehicle without rear view mirrors! Keep an eye on what is
going on behind your back.</p>
<p>Now, your macro won’t always compile, you might just recieve the bee
movie script as an error. <code>cargo-expand</code> will not work in
such cases. I would suggest printing out your variables to inspect them.
<code>TokenStream</code> implements <code>Display</code> as well as
<code>Debug</code>. We don’t always have to be respectable programmers.
Just print it.</p>
<p>Enough of that, lets get testing:</p>
<div class="sourceCode" id="cb37"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb37-1"><a href="#cb37-1" aria-hidden="true" tabindex="-1"></a><span class="co">// tests/smoke.rs</span></span>
<span id="cb37-2"><a href="#cb37-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb37-3"><a href="#cb37-3" aria-hidden="true" tabindex="-1"></a><span class="at">#![</span>feature<span class="at">(</span>type_alias_impl_trait<span class="at">)]</span></span>
<span id="cb37-4"><a href="#cb37-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb37-5"><a href="#cb37-5" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span><span class="pp">crate_name::</span>curry<span class="at">]</span></span>
<span id="cb37-6"><a href="#cb37-6" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> z<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb37-7"><a href="#cb37-7" aria-hidden="true" tabindex="-1"></a> x <span class="op">+</span> y <span class="op">+</span> z</span>
<span id="cb37-8"><a href="#cb37-8" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb37-9"><a href="#cb37-9" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb37-10"><a href="#cb37-10" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>test<span class="at">]</span></span>
<span id="cb37-11"><a href="#cb37-11" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> works() <span class="op">{</span></span>
<span id="cb37-12"><a href="#cb37-12" aria-hidden="true" tabindex="-1"></a> <span class="pp">assert_eq!</span>(<span class="dv">15</span><span class="op">,</span> add(<span class="dv">4</span>)(<span class="dv">5</span>)(<span class="dv">6</span>))<span class="op">;</span></span>
<span id="cb37-13"><a href="#cb37-13" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<p>Run <code>cargo +nightly test</code>. You should see a pleasing
message:</p>
<pre><code>running 1 test
test tests::works ... ok</code></pre>
<p>Take a look at the expansion for our curry macro, via
<code>cargo +nightly expand --tests smoke</code>:</p>
<div class="sourceCode" id="cb39"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb39-1"><a href="#cb39-1" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _add_T0 <span class="op">=</span> <span class="dt">u32</span><span class="op">;</span></span>
<span id="cb39-2"><a href="#cb39-2" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _add_T1 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T0<span class="op">;</span></span>
<span id="cb39-3"><a href="#cb39-3" aria-hidden="true" tabindex="-1"></a><span class="kw">type</span> _add_T2 <span class="op">=</span> <span class="kw">impl</span> <span class="bu">Fn</span>(<span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T1<span class="op">;</span></span>
<span id="cb39-4"><a href="#cb39-4" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> add(x<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> _add_T2 <span class="op">{</span></span>
<span id="cb39-5"><a href="#cb39-5" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> (<span class="kw">move</span> <span class="op">|</span>y<span class="op">|</span> <span class="op">{</span></span>
<span id="cb39-6"><a href="#cb39-6" aria-hidden="true" tabindex="-1"></a> <span class="kw">move</span> <span class="op">|</span>z<span class="op">|</span> <span class="op">{</span></span>
<span id="cb39-7"><a href="#cb39-7" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> x <span class="op">+</span> y <span class="op">+</span> z<span class="op">;</span></span>
<span id="cb39-8"><a href="#cb39-8" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span>
<span id="cb39-9"><a href="#cb39-9" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span>)<span class="op">;</span></span>
<span id="cb39-10"><a href="#cb39-10" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb39-11"><a href="#cb39-11" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb39-12"><a href="#cb39-12" aria-hidden="true" tabindex="-1"></a><span class="co">// a bunch of other stuff generated by #[test] and assert_eq!</span></span></code></pre></div>
<p>A sight for sore eyes.</p>
<p>Here is a more complex example that generates ten multiples of the
first ten natural numbers:</p>
<div class="sourceCode" id="cb40"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb40-1"><a href="#cb40-1" aria-hidden="true" tabindex="-1"></a><span class="at">#[</span>curry<span class="at">]</span></span>
<span id="cb40-2"><a href="#cb40-2" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> product(x<span class="op">:</span> <span class="dt">u32</span><span class="op">,</span> y<span class="op">:</span> <span class="dt">u32</span>) <span class="op">-&gt;</span> <span class="dt">u32</span> <span class="op">{</span></span>
<span id="cb40-3"><a href="#cb40-3" aria-hidden="true" tabindex="-1"></a> x <span class="op">*</span> y</span>
<span id="cb40-4"><a href="#cb40-4" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb40-5"><a href="#cb40-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb40-6"><a href="#cb40-6" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> multiples() <span class="op">-&gt;</span> <span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">Vec</span><span class="op">&lt;</span><span class="dt">u32</span><span class="op">&gt;&gt;{</span></span>
<span id="cb40-7"><a href="#cb40-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> v <span class="op">=</span> (<span class="dv">1</span><span class="op">..=</span><span class="dv">10</span>)<span class="op">.</span>map(product)<span class="op">;</span></span>
<span id="cb40-8"><a href="#cb40-8" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> (<span class="dv">1</span><span class="op">..=</span><span class="dv">10</span>)</span>
<span id="cb40-9"><a href="#cb40-9" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>map(<span class="op">|</span>x<span class="op">|</span> v<span class="op">.</span>clone()<span class="op">.</span>map(<span class="op">|</span>f<span class="op">|</span> f(x))<span class="op">.</span>collect())</span>
<span id="cb40-10"><a href="#cb40-10" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>collect()<span class="op">;</span></span>
<span id="cb40-11"><a href="#cb40-11" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
<h3 id="notes">Notes</h3>
<p>I didn’t quite explain why we use <code>move |arg|</code> in our
closure. This is because we want to take ownership of the variable
supplied to us. Take a look at this example:</p>
<div class="sourceCode" id="cb41"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb41-1"><a href="#cb41-1" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> v <span class="op">=</span> add(<span class="dv">5</span>)<span class="op">;</span></span>
<span id="cb41-2"><a href="#cb41-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> g<span class="op">;</span></span>
<span id="cb41-3"><a href="#cb41-3" aria-hidden="true" tabindex="-1"></a><span class="op">{</span></span>
<span id="cb41-4"><a href="#cb41-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">5</span><span class="op">;</span></span>
<span id="cb41-5"><a href="#cb41-5" aria-hidden="true" tabindex="-1"></a> g <span class="op">=</span> v(x)<span class="op">;</span></span>
<span id="cb41-6"><a href="#cb41-6" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span>
<span id="cb41-7"><a href="#cb41-7" aria-hidden="true" tabindex="-1"></a><span class="pp">println!</span>(<span class="st">&quot;{}&quot;</span><span class="op">,</span> g(<span class="dv">2</span>))<span class="op">;</span></span></code></pre></div>
<p>Variable <code>x</code> goes out of scope before <code>g</code> can
return a concrete value. If we take ownership of <code>x</code> by
<code>move</code>ing it into our closure, we can expect this to work
reliably. In fact, rustc understands this, and forces you to use
<code>move</code>.</p>
<p>This usage of <code>move</code> is exactly why <strong>a curried
function without a return is useless</strong>. Every variable we pass to
our curried function gets moved into its local scope. Playing with these
variables cannot cause a change outside this scope. Returning is our
only method of interaction with anything beyond this function.</p>
<h3 id="conclusion">Conclusion</h3>
<p>Currying may not seem to be all that useful. Curried functions are
unwieldy in Rust because the standard library is not built around
currying. If you enjoy the possibilities posed by currying, consider
taking a look at Haskell or Scheme.</p>
<p>My original intention with <a href="https://peppe.rs">peppe.rs</a>
was to post condensed articles, a micro blog, but this one turned out
extra long.</p>
<p>Perhaps I should call it a ‘macro’ blog :)</p>
<section id="footnotes" class="footnotes footnotes-end-of-document"
role="doc-endnotes">
<hr />
<ol>
<li id="fn1"><p><a
href="https://doc.rust-lang.org/book/ch13-01-closures.html">https://doc.rust-lang.org/book/ch13-01-closures.html</a><a
href="#fnref1" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
<li id="fn2"><p><a href="https://caniuse.rs">caniuse.rs</a> contains an
indexed list of features and their status.<a href="#fnref2"
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
</ol>
</section></description>
<link>https://peppe.rs/posts/auto-currying_rust_functions/</link>
<pubDate>Fri, 08 May 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/auto-currying_rust_functions/</guid>
</item>
<item>
<title>Pixel Art In GIMP</title>
<description><p>I’ve always been an admirer of pixel art, because of it’s simplicity
and it’s resemblance to bitmap font design. Recently, I decided to take
the dive and make some art of my own.</p>
<p>I used GIMP because I am fairly familiar with it. Aseprite seems to
be the editor of choice for animated pixel art though.</p>
<h3 id="setting-up-the-canvas">Setting up the canvas</h3>
<p>Picking a canvas size is daunting. Too small, and you won’t be able
to fit in enough detail to make a legible piece. Too big and you’ve got
too many pixels to work with!</p>
<p>I would suggest starting out with anywhere between 100x100 and
200x200. <a href="https://u.peppe.rs/u9.png">Here’s</a> a sample
configuration.</p>
<p>Sometimes I use a 10x10 grid, <code>View &gt; Show Grid</code> and
<code>Edit &gt; Preferences &gt; Default Grid &gt; Spacing</code>, but
that can get jarring, so I throw down a couple of guides, drag right or
down from the left or top gutters for vertical and horizontal guides
respectively.</p>
<h3 id="choosing-a-brush">Choosing a Brush</h3>
<p>The most important part of our setup is the brush. Use the Pencil
Tool (<code>n</code> on the keyboard) for hard edge drawings. Here’s a
small comparison if you don’t know the difference between a hard edge
and a soft edge:</p>
<figure>
<img src="https://u.peppe.rs/kz.png" alt="Hard edge vs Soft Edge" />
<figcaption aria-hidden="true">Hard edge vs Soft Edge</figcaption>
</figure>
<p>I turn the size down all the way to 1 (<code>[</code> on the
keyboard). Set <code>Dynamics</code> off. <a
href="https://u.peppe.rs/Fs.png">Here’s</a> a sample brush
configuration.</p>
<h3 id="laying-down-the-pixels">Laying down the pixels!</h3>
<p>With the boring stuff out of the way, we can start with our piece. I
usually follow a three step process:</p>
<ul>
<li>draw a rough outline</li>
<li>fill in the shadows</li>
<li>add highlights</li>
</ul>
<p>But this process is better explained with an example: an onigiri. Let
us start off with a 100x100 canvas.</p>
<h4 id="drawing-the-outline">Drawing the outline</h4>
<p>For the most part, our figure will be symmetric. If you are on GIMP
2.10+, you can take advantage of the Symmetry Painting feature. Go ahead
and enable vertical symmetry,
<code>Window &gt; Dockable Dialogs &gt; Symmetry Painting</code> and
<code>Symmetry Painting &gt; Symmetry &gt; Mirror &gt; Vertical</code>.</p>
<p>If you are running an older version of GIMP, draw in the left side,
duplicate the layer, flip it horizontally, and merge it with the
original.</p>
<p>Your outline might look something like this:</p>
<p><img src="https://u.peppe.rs/mn.png" /></p>
<p>Go ahead and fill it in with the fill tool (<code>Shift + b</code> on
the keyboard), add in some seaweed as well, preferably on a different
layer. You can toggle symmetry on and off to save yourself some
time.</p>
<p><img src="https://u.peppe.rs/xu.png" /></p>
<h4 id="shadows">Shadows</h4>
<p>For now, let us focus on the shadows on the object itself, we’ll come
back to the shadows cast by the object on the surface later.</p>
<p>Shadows on any surface always follow the shape of the surface. A
spherical onigiri would have a circular shadow:</p>
<p><img src="https://u.peppe.rs/FU.png" /></p>
<p>A couple of noticeable changes:</p>
<p><strong>Layers</strong>: The layer containing the seaweed has been
hidden.<br />
<strong>Color</strong>: The color of the shadow is just a slightly
lighter version of the original object (reduce the Value on the HSV
scale).<br />
<strong>Area</strong>: The shadow does not go all the way (notice the
bottom edges).</p>
<p>The shadow does not go all the way because we will be filling in that
area with another, darker shadow! An image might explain better:</p>
<p><img src="https://u.peppe.rs/Br.png" /></p>
<p>To emulate soft lights, reduce the value by 2 to 3 points every
iteration. Notice how area <code>1</code> is much larger than area
<code>4</code>. This is because an onigiri resembles a bottom heavy
oblate spheroid, a sphere that is slightly fatter around the lower
bottom, and areas <code>1</code> and <code>2</code> catch more light
than areas <code>3</code> and <code>4</code>.</p>
<p>Do the same with the seaweed. The seaweed, being a smaller, flatter
object, doesn’t cast much of a shadow, so stop with 1 or 2 iterations of
the gradient:</p>
<p><img src="https://u.peppe.rs/T3.png" /></p>
<p>We’re getting there!</p>
<h4 id="highlights">Highlights</h4>
<p>This step handles the details on the strongly illuminated portions of
the object. Seaweed is a bit glossy, lighten the edges to make it seem
shiny. The rice is not as shiny, but it does form an uneven surface. Add
in some shadows to promote the idea of rice grains. Here is the finished
result:</p>
<p><img src="https://u.peppe.rs/VE.png" /></p>
<h3 id="finishing-touches">Finishing Touches</h3>
<p>Some color correction and <code>a e s t h e t i c</code> Japanese
text later, our piece is complete!</p>
<p><img src="https://u.peppe.rs/cn.png" /></p>
<p>Hold on, why is it so tiny? Well, that’s because our canvas was
100x100, head over to <code>Image &gt; Scale Image</code>, set
<code>Quality &gt; Interpolation</code> to <code>None</code> and scale
it up to 700x700, et voilà!</p>
<p><img src="https://u.peppe.rs/CH.png" /></p></description>
<link>https://peppe.rs/posts/pixel_art_in_GIMP/</link>
<pubDate>Wed, 08 Apr 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/pixel_art_in_GIMP/</guid>
</item>
<item>
<title>Rapid Refactoring With Vim</title>
<description><p>Last weekend, I was tasked with refactoring the 96 unit tests on <a
href="https://github.com/ruma/ruma-events/pull/70">ruma-events</a> to
use strictly typed json objects using <code>serde_json::json!</code>
instead of raw strings. It was rather painless thanks to vim :)</p>
<p>Here’s a small sample of what had to be done (note the lines prefixed
with the arrow):</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>→ <span class="kw">use</span> <span class="pp">serde_json::</span><span class="op">{</span>from_str<span class="op">};</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="at">#[</span>test<span class="at">]</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> deserialize() <span class="op">{</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="pp">assert_eq!</span>(</span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a>→ <span class="pp">from_str::</span><span class="op">&lt;</span>Action<span class="op">&gt;</span>(<span class="st">r#&quot;{&quot;set_tweak&quot;: &quot;highlight&quot;}&quot;#</span>)<span class="op">,</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="pp">Action::</span>SetTweak(<span class="pp">Tweak::</span>Highlight <span class="op">{</span> value<span class="op">:</span> <span class="cn">true</span> <span class="op">}</span>)</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> )<span class="op">;</span></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<p>had to be converted to:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode rust"><code class="sourceCode rust"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>→ <span class="kw">use</span> <span class="pp">serde_json::</span><span class="op">{</span>from_value<span class="op">};</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> </span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="at">#[</span>test<span class="at">]</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> deserialize() <span class="op">{</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a> <span class="pp">assert_eq!</span>(</span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a>→ <span class="pp">from_value::</span><span class="op">&lt;</span>Action<span class="op">&gt;</span>(<span class="pp">json!</span>(<span class="op">{</span><span class="st">&quot;set_tweak&quot;</span><span class="op">:</span> <span class="st">&quot;highlight&quot;</span><span class="op">}</span>))<span class="op">,</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> <span class="pp">Action::</span>SetTweak(<span class="pp">Tweak::</span>Highlight <span class="op">{</span> value<span class="op">:</span> <span class="cn">true</span> <span class="op">}</span>)</span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> )<span class="op">;</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<h3 id="the-arglist">The arglist</h3>
<p>For the initial pass, I decided to handle imports, this was a simple
find and replace operation, done to all the files containing tests.
Luckily, modules (and therefore files) containing tests in Rust are
annotated with the <code>#[cfg(test)]</code> attribute. I opened all
such files:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># `grep -l pattern files` lists all the files</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="co"># matching the pattern</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="ex">vim</span> <span class="va">$(</span><span class="fu">grep</span> <span class="at">-l</span> <span class="st">&#39;cfg\(test\)&#39;</span> ./<span class="pp">**</span>/<span class="pp">*</span>.rs<span class="va">)</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="co"># expands to something like:</span></span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a><span class="ex">vim</span> push_rules.rs room/member.rs key/verification/lib.rs</span></code></pre></div>
<p>Starting vim with more than one file at the shell prompt populates
the arglist. Hit <code>:args</code> to see the list of files currently
ready to edit. The square [brackets] indicate the current file. Navigate
through the arglist with <code>:next</code> and <code>:prev</code>. I
use tpope’s vim-unimpaired <a href="#fn1" class="footnote-ref"
id="fnref1" role="doc-noteref"><sup>1</sup></a>, which adds
<code>]a</code> and <code>[a</code>, mapped to <code>:next</code> and
<code>:prev</code>.</p>
<p>All that’s left to do is the find and replace, for which we will be
using vim’s <code>argdo</code>, applying a substitution to every file in
the arglist:</p>
<pre><code>:argdo s/from_str/from_value/g</code></pre>
<h3 id="the-quickfix-list">The quickfix list</h3>
<p>Next up, replacing <code>r#" ... "#</code> with
<code>json!( ... )</code>. I couldn’t search and replace that trivially,
so I went with a macro call <a href="#fn2" class="footnote-ref"
id="fnref2" role="doc-noteref"><sup>2</sup></a> instead, starting with
the cursor on ‘r’, represented by the caret, in my attempt to breakdown
the process:</p>
<pre><code>BUFFER: r#&quot; ... &quot;#;
^
ACTION: vllsjson!(
BUFFER json!( ... &quot;#;
^
ACTION: &lt;esc&gt;$F#
BUFFER: json!( ... &quot;#;
^
ACTION: vhs)&lt;esc&gt;
BUFFER: json!( ... );</code></pre>
<p>Here’s the recorded <a href="#fn3" class="footnote-ref" id="fnref3"
role="doc-noteref"><sup>3</sup></a> macro in all its glory:
<code>vllsjson!(&lt;esc&gt;$F#vhs)&lt;esc&gt;</code>.</p>
<p>Great! So now we just go ahead, find every occurrence of
<code>r#</code> and apply the macro right? Unfortunately, there were
more than a few occurrences of raw strings that had to stay raw strings.
Enter, the quickfix list.</p>
<p>The idea behind the quickfix list is to jump from one position in a
file to another (maybe in a different file), much like how the arglist
lets you jump from one file to another.</p>
<p>One of the easiest ways to populate this list with a bunch of
positions is to use <code>vimgrep</code>:</p>
<pre><code># basic usage
:vimgrep pattern files
# search for raw strings
:vimgrep &#39;r#&#39; ./**/*.rs</code></pre>
<p>Like <code>:next</code> and <code>:prev</code>, you can navigate the
quickfix list with <code>:cnext</code> and <code>:cprev</code>. Every
time you move up or down the list, vim indicates your index:</p>
<pre><code>(1 of 131): r#&quot;{&quot;set_tweak&quot;: &quot;highlight&quot;}&quot;#;</code></pre>
<p>And just like <code>argdo</code>, you can <code>cdo</code> to apply
commands to <em>every</em> match in the quickfix list:</p>
<pre><code>:cdo norm! @q</code></pre>
<p>But, I had to manually pick out matches, and it involved some button
mashing.</p>
<h3 id="external-filtering">External Filtering</h3>
<p>Some code reviews later, I was asked to format all the json inside
the <code>json!</code> macro. All you have to do is pass a visual
selection through a pretty json printer. Select the range to be
formatted in visual mode, and hit <code>:</code>, you will notice the
command line displaying what seems to be gibberish:</p>
<pre><code>:&#39;&lt;,&#39;&gt;</code></pre>
<p><code>'&lt;</code> and <code>'&gt;</code> are <em>marks</em> <a
href="#fn4" class="footnote-ref" id="fnref4"
role="doc-noteref"><sup>4</sup></a>. More specifically, they are marks
that vim sets automatically every time you make a visual selection,
denoting the start and end of the selection.</p>
<p>A range is one or more line specifiers separated by a
<code>,</code>:</p>
<pre><code>:1,7 lines 1 through 7
:32 just line 32
:. the current line
:.,$ the current line to the last line
:&#39;a,&#39;b mark &#39;a&#39; to mark &#39;b&#39;</code></pre>
<p>Most <code>:</code> commands can be prefixed by ranges.
<code>:help usr_10.txt</code> for more on that.</p>
<p>Alright, lets pass json through <code>python -m json.tool</code>, a
json formatter that accepts <code>stdin</code> (note the use of
<code>!</code> to make use of an external program):</p>
<pre><code>:&#39;&lt;,&#39;&gt;!python -m json.tool</code></pre>
<p>Unfortunately that didn’t quite work for me because the range
included some non-json text as well, a mix of regex and macros helped
fix that. I think you get the drift.</p>
<p>Another fun filter I use from time to time is <code>:!sort</code>, to
sort css attributes, or <code>:!uniq</code> to remove repeated
imports.</p>
<section id="footnotes" class="footnotes footnotes-end-of-document"
role="doc-endnotes">
<hr />
<ol>
<li id="fn1"><p>https://github.com/tpope/vim-unimpaired It also handles
various other mappings, <code>]q</code> and <code>[q</code> to navigate
the quickfix list for example<a href="#fnref1" class="footnote-back"
role="doc-backlink">↩︎</a></p></li>
<li id="fn2"><p><code>:help recording</code><a href="#fnref2"
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
<li id="fn3"><p>When I’m recording a macro, I prefer starting out by
storing it in register <code>q</code>, and then copying it over to
another register if it works as intended. I think of <code>qq</code> as
‘quick record’.<a href="#fnref3" class="footnote-back"
role="doc-backlink">↩︎</a></p></li>
<li id="fn4"><p><code>:help mark-motions</code><a href="#fnref4"
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
</ol>
</section></description>
<link>https://peppe.rs/posts/rapid_refactoring_with_vim/</link>
<pubDate>Tue, 31 Mar 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/rapid_refactoring_with_vim/</guid>
</item>
<item>
<title>Font Size Fallacies</title>
<description><p>I am not an expert with fonts, but I do have some experience <a
href="#fn1" class="footnote-ref" id="fnref1"
role="doc-noteref"><sup>1</sup></a>, and common sense. This post aims to
debunk some misconceptions about font sizes!</p>
<p>11 px on your display is <em>probably not</em> 11 px on my display.
Let’s do some quick math. I have two displays, 1366x768 @ 21” and
another with 1920x1080 @ 13”, call them <code>A</code> and
<code>B</code> for now.</p>
<p>Display <code>A</code> has 1,049,088 pixels. A pixel is a square, of
side say, <code>s</code> cm. The total area covered by my 21” display is
about 1,066 cm^2 (41x26). Thus,</p>
<pre><code>Display A
Dimensions: 1366x768 @ 21&quot; (41x26 sq. cm)
1,049,088 s^2 = 1066
s = 0.0318 cm (side of a pixel on Display A)</code></pre>
<p>Bear with me, as I repeat the number crunching for Display
<code>B</code>:</p>
<pre><code>Display B
Dimensions: 1920x1080 @ 13&quot; (29.5x16.5 sq. cm)
2,073,600 s^2 = 486.75
s = 0.0153 cm (side of a pixel on Display B)</code></pre>
<p>The width of a pixel on Display <code>A</code> is <em>double</em> the
width of a pixel on Display <code>B</code>. The area occupied by a pixel
on Display <code>A</code> is <em>4 times</em> the area occupied by a
pixel on Display <code>B</code>.</p>
<p><em>The size of a pixel varies from display to display!</em></p>
<p>A 5x11 bitmap font on Display <code>A</code> would be around 4 mm
tall whereas the same bitmap font on Display <code>B</code> would be
around 1.9 mm tall. A 11 px tall character on <code>B</code> is visually
equivalent to a 5 px character on <code>A</code>. When you view a
screenshot of Display <code>A</code> on Display <code>B</code>, the
contents are shrunk down by a factor of 2!</p>
<p>So screen resolution is not enough, how else do we measure size?
Pixel Density! Keen readers will realize that the 5^th grade math
problem we solved up there showcases pixel density, or, pixels per cm
(PPCM). Usually we deal with pixels per inch (PPI).</p>
<p><strong>Note:</strong> PPI is not to be confused with DPI <a
href="#fn2" class="footnote-ref" id="fnref2"
role="doc-noteref"><sup>2</sup></a> (dots per inch). DPI is defined for
printers.</p>
<p>In our example, <code>A</code> is a 75 ppi display and <code>B</code>
is around 165 ppi <a href="#fn3" class="footnote-ref" id="fnref3"
role="doc-noteref"><sup>3</sup></a>. A low ppi display appears to be
‘pixelated’, because the pixels are more prominent, much like Display
<code>A</code>. A higher ppi usually means you can view larger images
and render crispier fonts. The average desktop display can stuff 100-200
pixels per inch. Smart phones usually fall into the 400-600 ppi
(XXXHDPI) category. The human eye fails to differentiate detail past 300
ppi.</p>
<p><em>So … streaming an 8K video on a 60” TV provides the same clarity
as a HD video on a smart phone?</em></p>
<p>Absolutely. Well, clarity is subjective, but the amount of detail you
can discern on mobile displays has always been limited. Salty consumers
of the Xperia 1 <a href="#fn4" class="footnote-ref" id="fnref4"
role="doc-noteref"><sup>4</sup></a> will say otherwise.</p>
<p>Maybe I will talk about font rendering in another post, but thats all
for now. Don’t judge a font size by its screenshot.</p>
<section id="footnotes" class="footnotes footnotes-end-of-document"
role="doc-endnotes">
<hr />
<ol>
<li id="fn1"><p>https://github.com/nerdypepper/scientifica<a
href="#fnref1" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
<li id="fn2"><p>https://en.wikipedia.org/wiki/Dots_per_inch<a
href="#fnref2" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
<li id="fn3"><p>https://www.sven.de/dpi/<a href="#fnref3"
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
<li id="fn4"><p>https://en.wikipedia.org/wiki/Sony_Xperia_1<a
href="#fnref4" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
</ol>
</section></description>
<link>https://peppe.rs/posts/font_size_fallacies/</link>
<pubDate>Mon, 16 Mar 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/font_size_fallacies/</guid>
</item>
<item>
<title>Termux Tandem</title>
<description><p>I learnt about <code>termux</code> from a friend on IRC recently. It
looked super gimmicky to me at first, but it eventually proved to be
useful. Here’s what I use it for:</p>
<h3 id="rsync">rsync</h3>
<p>Ever since I degoogled my android device, syncing files between my
phone and my PC has always been a pain. I’m looking at you MTP. But,
with <code>termux</code> and <code>sshd</code> all set up, it’s as
simple as:</p>
<pre><code>$ arp
Address HWtype HWad ...
192.168.43.187 ether d0:0 ...
$ rsync -avz 192.168.43.187:~/frogs ~/pics/frogs</code></pre>
<h3 id="ssh-tmux">ssh &amp; tmux</h3>
<p>My phone doubles as a secondary view into my main machine with
<code>ssh</code> and <code>tmux</code>. When I am away from my PC (read:
sitting across the room), I check build status and IRC messages by
<code>ssh</code>ing into a tmux session running the said build or
weechat.</p>
<h3 id="file-uploads">file uploads</h3>
<p>Not being able to access my (ssh-only) file host was crippling. With
a <code>bash</code> instance on my phone, I just copied over my ssh
keys, and popped in a file upload script (a glorified <code>scp</code>).
Now I just have to figure out a way to clean up these file names …</p>
<pre><code>~/storage/pictures/ $ ls
02muf5g7b2i41.jpg 7alt3cwg77841.jpg cl4bsrge7id11.png
mtZabXG.jpg p8d5c584f2841.jpg vjUxGjq.jpg</code></pre>
<h3 id="cmus">cmus</h3>
<p>Alright, I don’t really listen to music via <code>cmus</code>, but I
did use it a couple times when my default music player was acting up.
<code>cmus</code> is a viable option:</p>
<p><a href="https://u.peppe.rs/CP.jpg"><img
src="https://u.peppe.rs/CP.jpg" /></a></p></description>
<link>https://peppe.rs/posts/termux_tandem/</link>
<pubDate>Sat, 07 Mar 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/termux_tandem/</guid>
</item>
<item>
<title>Call To ARMs</title>
<description><p>My 4th semester involves ARM programming. And proprietary tooling
(Keil C). But we don’t do that here.</p>
<h3 id="building">Building</h3>
<p>Assembling and linking ARM binaries on non-ARM architecture devices
is fairly trivial. I went along with the GNU cross bare metal toolchain
binutils, which provides <code>arm-as</code> and <code>arm-ld</code>
(among a bunch of other utils that I don’t care about for now).</p>
<p>Assemble <code>.s</code> files with:</p>
<pre class="shell"><code>arm-none-eabi-as main.s -g -march=armv8.1-a -o main.out</code></pre>
<p>The <code>-g</code> flag generates extra debugging information that
<code>gdb</code> picks up. The <code>-march</code> option establishes
target architecture.</p>
<p>Link <code>.o</code> files with:</p>
<pre class="shell"><code>arm-none-eabi-ld main.out -o main</code></pre>
<h3 id="running-and-debugging">Running (and Debugging)</h3>
<p>Things get interesting here. <code>gdb</code> on your x86 machine
cannot read nor execute binaries compiled for ARM. So, we simulate an
ARM processor using <code>qemu</code>. Now qemu allows you to run
<code>gdbserver</code> on startup. Connecting our local <code>gdb</code>
instance to <code>gdbserver</code> gives us a view into the program’s
execution. Easy!</p>
<p>Run <code>qemu</code>, with <code>gdbserver</code> on port
<code>1234</code>, with our ARM binary, <code>main</code>:</p>
<pre class="shell"><code>qemu-arm -singlestep -g 1234 main</code></pre>
<p>Start up <code>gdb</code> on your machine, and connect to
<code>qemu</code>’s <code>gdbserver</code>:</p>
<pre><code>(gdb) set architecture armv8-a
(gdb) target remote localhost:1234
(gdb) file main
Reading symbols from main... # yay!</code></pre>
<h3 id="gdb-enhanced">GDB Enhanced</h3>
<p><code>gdb</code> is cool, but it’s not nearly as comfortable as well
fleshed out emulators/IDEs like Keil. Watching registers, CPSR and
memory chunks update <em>is</em> pretty fun.</p>
<p>I came across <code>gdb</code>’s TUI mode (hit <code>C-x C-a</code>
or type <code>tui enable</code> at the prompt). TUI mode is a godsend.
It highlights the current line of execution, shows you disassembly
outputs, updated registers, active breakpoints and more.</p>
<p><em>But</em>, it is an absolute eyesore.</p>
<p>Say hello to <a href="https://github.com/hugsy/gef">GEF</a>! “GDB
Enhanced Features” teaches our old dog some cool new tricks. Here are
some additions that made my ARM debugging experience loads better:</p>
<ul>
<li>Memory watches</li>
<li>Register watches, with up to 7 levels of deref (overkill, I
agree)</li>
<li>Stack tracing</li>
</ul>
<p>And it’s pretty! See for yourself:</p>
<p><a href="https://u.peppe.rs/wq.png"><img
src="https://u.peppe.rs/wq.png" /></a></p>
<h3 id="editing">Editing</h3>
<p>Vim, with <code>syntax off</code> because it dosen’t handle GNU ARM
syntax too well.</p></description>
<link>https://peppe.rs/posts/call_to_ARMs/</link>
<pubDate>Fri, 07 Feb 2020 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/call_to_ARMs/</guid>
</item>
<item>
<title>Color Conundrum</title>
<description><p>This piece aims to highlight (pun intended) some of the reasons
behind my <a href="https://u.peppe.rs/bF.png">color free</a> editor
setup.</p>
<p>Imagine highlighting an entire book because <em>all</em> of it is
important. That is exactly what (most) syntax highlighting does. It is
difficult for the human eye to filter out noise in rainbow barf. Use
color to draw attention, not diverge it.</p>
<p>At the same time, a book devoid of color is <em>boring!</em> What is
the takeaway from this 10 line paragraph? What are the technical terms
used?</p>
<p>Prose and code are certainly different, but the fickle minded human
eye is the same. The eye constantly looks for a frame of reference, a
focal point. It grows tired when it can’t find one.</p>
<p>The following comparison does a better job of explaining (none, ample
and over-the-top highlighting, from left to right):</p>
<p><a href="https://u.peppe.rs/lt.png"><img
src="https://u.peppe.rs/lt.png" /></a></p>
<p>Without highlighting (far left), it is hard to differentiate between
comments and code! The florid color scheme (far right) is no good
either, it contains too many attention grabbers. The center sample is a
healthy balance of both. Function calls and constants stand out, and
repetitive keywords and other noise (<code>let</code>, <code>as</code>)
are mildly dimmed out. Comments and non-code text (sign column, status
text) are dimmed further.</p>
<p>I’ll stop myself before I rant about color contrast and
combinations.</p></description>
<link>https://peppe.rs/posts/color_conundrum/</link>
<pubDate>Mon, 30 Dec 2019 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/color_conundrum/</guid>
</item>
<item>
<title>Static Sites With Bash</title>
<description><p>After going through a bunch of static site generators (<a
href="https://blog.getpelican.com/">pelican</a>, <a
href="https://gohugo.io">hugo</a>, <a
href="https://github.com/icyphox/vite">vite</a>), I decided to roll my
own. If you are more of the ‘show me the code’ kinda guy, <a
href="https://github.com/nerdypepper/site">here</a> you go.</p>
<h3 id="text-formatting">Text formatting</h3>
<p>I chose to write in markdown, and convert to html with <a
href="https://kristaps.bsd.lv/lowdown/">lowdown</a>.</p>
<h3 id="directory-structure">Directory structure</h3>
<p>I host my site on GitHub pages, so <code>docs/</code> has to be the
entry point. Markdown formatted posts go into <code>posts/</code>, get
converted into html, and end up in <code>docs/index.html</code>,
something like this:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="va">posts</span><span class="op">=</span><span class="va">$(</span><span class="fu">ls</span> <span class="at">-t</span> ./posts<span class="va">)</span> <span class="co"># chronological order!</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> f <span class="kw">in</span> <span class="va">$posts</span><span class="kw">;</span> <span class="cf">do</span></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="va">file</span><span class="op">=</span><span class="st">&quot;./posts/&quot;</span><span class="va">$f</span> <span class="co"># `ls` mangled our file paths</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="bu">echo</span> <span class="st">&quot;generating post </span><span class="va">$file</span><span class="st">&quot;</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> <span class="va">html</span><span class="op">=</span><span class="va">$(</span><span class="ex">lowdown</span> <span class="st">&quot;</span><span class="va">$file</span><span class="st">&quot;</span><span class="va">)</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="bu">echo</span> <span class="at">-e</span> <span class="st">&quot;html&quot;</span> <span class="op">&gt;&gt;</span> docs/index.html</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="cf">done</span></span></code></pre></div>
<h3 id="assets">Assets</h3>
<p>Most static site generators recommend dropping image assets into the
site source itself. That does have it’s merits, but I prefer hosting
images separately:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># strip file extension</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="va">ext</span><span class="op">=</span><span class="st">&quot;</span><span class="va">${1</span><span class="op">##</span><span class="pp">*</span>.<span class="va">}</span><span class="st">&quot;</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="co"># generate a random file name</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="va">id</span><span class="op">=</span><span class="va">$(</span> <span class="fu">cat</span> /dev/urandom <span class="kw">|</span> <span class="fu">tr</span> <span class="at">-dc</span> <span class="st">&#39;a-zA-Z0-9&#39;</span> <span class="kw">|</span> <span class="fu">fold</span> <span class="at">-w</span> 2 <span class="kw">|</span> <span class="fu">head</span> <span class="at">-n</span> 1 <span class="va">)</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="va">id</span><span class="op">=</span><span class="st">&quot;</span><span class="va">$id</span><span class="st">.</span><span class="va">$ext</span><span class="st">&quot;</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="co"># copy to my file host</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="fu">scp</span> <span class="at">-P</span> 443 <span class="st">&quot;</span><span class="va">$1</span><span class="st">&quot;</span> emerald:files/<span class="st">&quot;</span><span class="va">$id</span><span class="st">&quot;</span> </span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&quot;https://u.peppe.rs/</span><span class="va">$id</span><span class="st">&quot;</span></span></code></pre></div>
<h3 id="templating">Templating</h3>
<p><a
href="https://github.com/NerdyPepper/site/blob/master/generate.sh"><code>generate.sh</code></a>
brings the above bits and pieces together (with some extra cruft to
avoid javascript). It uses <code>sed</code> to produce nice titles from
the file names (removes underscores, title-case), and
<code>date(1)</code> to add the date to each post listing!</p></description>
<link>https://peppe.rs/posts/static_sites_with_bash/</link>
<pubDate>Fri, 22 Nov 2019 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/static_sites_with_bash/</guid>
</item>
<item>
<title>My Setup</title>
<description><p>Decided to do one of these because everyone does one of these.</p>
<p><img src="https://u.peppe.rs/Hb.png" /></p>
<p>My entire setup is managed with GNU <code>stow</code>, making it
easier to replicate on fresh installations. You can find my
configuration files on <a
href="https://github.com/nerdypepper">GitHub</a>.</p>
<p>I run Void Linux (glibc) on my <a
href="https://store.hp.com/us/en/mdp/laptops/envy-13">HP Envy 13”
(2018)</a>. To keep things simple, I run a raw X session with
<code>2bwm</code> as my window manager, along with <code>dunst</code>
(notification daemon) and Sam’s <a
href="https://github.com/sdhand/compton"><code>compton</code></a>
(compositor) fork.</p>
<p>I am a fan of GNU tools, so I use <code>bash</code> as my shell, and
<code>coreutils</code> to manage files, archives, strings, paths etc. I
edit files with <code>vim</code>, chat with <code>weechat</code>, listen
to music with <code>cmus</code>, monitor processes with
<code>htop</code>, manage sessions with <code>tmux</code>, read pdfs in
<code>zathura</code>. I rarely ever leave the comfort of my terminal
emulator, <code>urxvt</code>.</p>
<p>Most of my academic typesetting is done with TeX, and compiled with
<code>xelatex</code>. Other <em>fun</em> documents are made with GIMP
:).</p></description>
<link>https://peppe.rs/posts/my_setup/</link>
<pubDate>Wed, 06 Nov 2019 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/my_setup/</guid>
</item>
<item>
<title>WPA Woes</title>
<description><p>I finally got around to installing Void GNU/Linux on my main
computer. Rolling release, non-systemd, need I say more?</p>
<p>As with all GNU/Linux distributions, wireless networks had me in a
fix. If you can see this post, it means I’ve managed to get online. It
turns out, <code>wpa_supplicant</code> was detecting the wrong interface
by default (does it ever select the right one?). Let us fix that:</p>
<pre><code>$ sudo rm -r /var/service/wpa_supplicant
$ sudo killall dhcpcd</code></pre>
<p>What is the right interface though?</p>
<pre><code>$ iw dev
...
Interface wlp2s0
...</code></pre>
<p>Aha! Let us run <code>wpa_supplicant</code> on that interface, as a
background process:</p>
<pre><code>$ sudo wpa_supplicant -B -i wlp2s0 -c /etc/wpa_supplicant/wpa_supplicant.conf
$ sudo dhcpcd -B wlp2s0
$ ping google.com
PING ...</code></pre>
<p>Yay! Make those changes perpetual by enabling the service:</p>
<pre><code>------------------------------------------------------
# Add these to /etc/wpa_supplicant/wpa_supplicant.conf
OPTS=&quot;-B&quot;
WPA_INTERFACE=&quot;wlp2s0&quot;
------------------------------------------------------
$ sudo ln -s /etc/sv/wpa_supplicant /var/service/
$ sudo ln -s /etc/sv/dhcpcd /var/service/
$ sudo sv restart wpa_supplicant
$ sudo sv restart dhcpcd</code></pre></description>
<link>https://peppe.rs/posts/WPA_woes/</link>
<pubDate>Sat, 12 Oct 2019 16:23:00 +0000</pubDate>
<guid>https://peppe.rs/posts/WPA_woes/</guid>
</item>
<item>
<title>Bye Bye BDFs</title>
<description><p>Glyph Bitmap Distribution Format is no more, as the creators of <a
href="https://pango.org">Pango</a>, one of the most widely used text
rendering libraries, <a
href="https://blogs.gnome.org/mclasen/2019/05/25/pango-future-directions/">announced</a>
their plans for Pango 1.44.</p>
<p>Until recently, Pango used FreeType to draw fonts. They will be
moving over to <a href="https://harfbuzz.org">Harfbuzz</a>, an evolution
of FreeType.</p>
<p><em>Why?</em></p>
<p>In short, FreeType was hard to work with. It required complex logic,
and provided no advantage over Harfbuzz (other than being able to fetch
opentype metrics with ease).</p>
<p>Upgrading to Pango v1.44 will break your GTK applications (if you use
a <code>bdf</code>/<code>pcf</code> bitmap font). Harfbuzz <em>does</em>
support bitmap-only OpenType fonts, <code>otb</code>s. Convert your
existing fonts over to <code>otb</code>s using <a
href="https://fontforge.github.io">FontForge</a>. It is to be noted that
applications such as <code>xterm</code> and <code>rxvt</code> use
<code>xft</code> (X FreeType) to render fonts, and will remain
unaffected by the update.</p>
<p>Both <a
href="https://github.com/nerdypepper/scientifica">scientifica</a> and <a
href="https://github.com/nerdypepper/curie">curie</a> will soon ship
with bitmap-only OpenType font formats.</p></description>
<link>https://peppe.rs/posts/bye_bye_BDFs/</link>
<pubDate>Wed, 07 Aug 2019 17:26:00 +0000</pubDate>
<guid>https://peppe.rs/posts/bye_bye_BDFs/</guid>
</item>
<item>
<title>Onivim Sucks</title>
<description><p><a href="https://v2.onivim.io">Onivim</a> is a ‘modern modal editor’,
combining fancy interface and language features with vim-style modal
editing. What’s wrong you ask?</p>
<p>Apart from <a href="https://github.com/onivim/oni2/issues/550">buggy
syntax highlighting</a>, <a
href="https://github.com/onivim/oni2/issues/519">broken scrolling</a>
and <a
href="https://github.com/onivim/oni2/issues?q=is%3Aissue+label%3A%22daily+editor+blocker%22+is%3Aopen">others</a>,
Onivim is <strong>proprietary</strong> software. It is licensed under a
commercial <a
href="https://github.com/onivim/oni1/blob/master/Outrun-Labs-EULA-v1.1.md">end
user agreement license</a>, which prohibits redistribution in both
object code and source code formats.</p>
<p>Onivim’s core editor logic (bits that belong to vim), have been
separated from the interface, into <a
href="https://github.com/onivim/libvim">libvim</a>. libvim is licensed
under MIT, which means, this ‘extension’ of vim is perfectly in
adherence to <a
href="http://vimdoc.sourceforge.net/htmldoc/uganda.html#license">vim’s
license text</a>! Outrun Labs are exploiting this loophole (distributing
vim as a library) to commercialize Onivim.</p>
<p>Onivim’s source code is available on <a
href="https://github.com/onivim/oni2">GitHub</a>. They do mention that
the source code trickles down to the <a
href="https://github.com/onivim/oni2-mit">oni2-mit</a> repository, which
(not yet) contains MIT-licensed code, <strong>18 months</strong> after
each commit to the original repository.</p>
<p>Want to contribute to Onivim? Don’t. They make a profit out of your
contributions. Currently, Onivim is priced at $19.99, ‘pre-alpha’
pricing which is 80% off the final price! If you are on the lookout for
an editor, I would suggest using <a href="https://vim.org">Vim</a>,
charity ware that actually works, and costs $100 lesser.</p></description>
<link>https://peppe.rs/posts/onivim_sucks/</link>
<pubDate>Fri, 02 Aug 2019 16:32:00 +0000</pubDate>
<guid>https://peppe.rs/posts/onivim_sucks/</guid>
</item>
<item>
<title>Bash Harder With Vim</title>
<description><p>Bash is tricky, don’t let your editor get in your way. Here’s a
couple of neat additions you could make to your <code>vimrc</code> for a
better shell programming experience.</p>
<h3 id="man-pages-inside-vim">Man pages inside vim</h3>
<p>Source this script to get started:</p>
<pre><code>runtime ftplugin/man.vim</code></pre>
<p>Now, you can open manpages inside vim with <code>:Man</code>! It adds
nicer syntax highlighting and the ability to jump around with
<code>Ctrl-]</code> and <code>Ctrl-T</code>.</p>
<p>By default, the manpage is opened in a horizontal split, I prefer
using a new tab:</p>
<pre><code>let g:ft_man_open_mode = &#39;tab&#39;</code></pre>
<h3 id="scratchpad-to-test-your-commands">Scratchpad to test your
commands</h3>
<p>I often test my <code>sed</code> substitutions, here is a sample from
the script used to generate this site:</p>
<pre><code># a substitution to convert snake_case to Title Case With Spaces
echo &quot;$1&quot; | sed -E -e &quot;s/\..+$//g&quot; -e &quot;s/_(.)/ \u\1/g&quot; -e &quot;s/^(.)/\u\1/g&quot;</code></pre>
<p>Instead of dropping into a new shell, just test it out directly from
vim!</p>
<ul>
<li>Yank the line into a register:</li>
</ul>
<pre><code>yy</code></pre>
<ul>
<li>Paste it into the command-line window:</li>
</ul>
<pre><code>q:p</code></pre>
<ul>
<li>Make edits as required:</li>
</ul>
<pre><code>syntax off # previously run commands
edit index.html # in a buffer!
w | so %
!echo &quot;new_post.md&quot; | sed -E -e &quot;s/\..+$//g&quot; --snip--
^--- note the use of &#39;!&#39;</code></pre>
<ul>
<li>Hit enter with the cursor on the line containing your command!</li>
</ul>
<pre><code>$ vim
New Post # output
Press ENTER or type command to continue</code></pre></description>
<link>https://peppe.rs/posts/bash_harder_with_vim/</link>
<pubDate>Tue, 30 Jul 2019 18:30:00 +0000</pubDate>
<guid>https://peppe.rs/posts/bash_harder_with_vim/</guid>
</item>
<item>
<title>Hold Position!</title>
<description><p>Often times, when I run a vim command that makes “big” changes to a
file (a macro or a <code>:vimgrep</code> command) I lose my original
position and feel disoriented.</p>
<p><em>Save position with <code>winsaveview()</code>!</em></p>
<p>The <code>winsaveview()</code> command returns a
<code>Dictionary</code> that contains information about the view of the
current window. This includes the cursor line number, cursor coloumn,
the top most line in the window and a couple of other values, none of
which concern us.</p>
<p>Before running our command (one that jumps around the buffer, a lot),
we save our view, and restore it once its done, with
<code>winrestview</code>.</p>
<pre><code>let view = winsaveview()
s/\s\+$//gc &quot; find and (confirm) replace trailing blanks
winrestview(view) &quot; restore our original view!</code></pre>
<p>It might seem a little overkill in the above example, just use ``
(double backticks) instead, but it comes in handy when you run your file
through heavier filtering.</p></description>
<link>https://peppe.rs/posts/hold_position!/</link>
<pubDate>Tue, 30 Jul 2019 14:45:00 +0000</pubDate>
<guid>https://peppe.rs/posts/hold_position!/</guid>
</item>
<item>
<title>Get Better At Yanking And Putting In Vim</title>
<description><p>a couple of nifty tricks to help you copy-paste better:</p>
<ol type="1">
<li><p>reselecting previously selected text (i use this to fix botched
selections):</p>
<pre><code>gv &quot; :h gv for more
&quot; you can use `o` in visual mode to go to the `Other` end of the selection
&quot; use a motion to fix the selection</code></pre></li>
<li><p>reselecting previously yanked text:</p>
<pre><code>`[v`]
`[ &quot; marks the beginning of the previously yanked text :h `[
`] &quot; marks the end :h `]
v &quot; visual select everything in between
nnoremap gb `[v`] &quot; &quot;a quick map to perform the above</code></pre></li>
<li><p>pasting and indenting text (in one go):</p>
<pre><code>]p &quot; put (p) and adjust indent to current line
]P &quot; put the text before the cursor (P) and adjust indent to current line</code></pre></li>
</ol></description>
<link>https://peppe.rs/posts/get_better_at_yanking_and_putting_in_vim/</link>
<pubDate>Tue, 30 Jul 2019 08:43:00 +0000</pubDate>
<guid>https://peppe.rs/posts/get_better_at_yanking_and_putting_in_vim/</guid>
</item>
</channel>
</rss>
|