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
|
% \iffalse meta-comment
%
%% File: l3keys.dtx
%
% Copyright (C) 2006-2019 The LaTeX3 Project
%
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
% license or (at your option) any later version. The latest version
% of this license is in the file
%
% https://www.latex-project.org/lppl.txt
%
% This file is part of the "l3kernel bundle" (The Work in LPPL)
% and all files in that bundle must be distributed together.
%
% -----------------------------------------------------------------------
%
% The development version of the bundle can be found at
%
% https://github.com/latex3/latex3
%
% for those people who are interested.
%
%<*driver>
\documentclass[full,kernel]{l3doc}
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
%
% \title{^^A
% The \pkg{l3keys} package\\ Key--value interfaces^^A
% }
%
% \author{^^A
% The \LaTeX3 Project\thanks
% {^^A
% E-mail:
% \href{mailto:latex-team@latex-project.org}
% {latex-team@latex-project.org}^^A
% }^^A
% }
%
% \date{Released 2019-01-28}
%
% \maketitle
%
% \begin{documentation}
%
% The key--value method is a popular system for creating large numbers
% of settings for controlling function or package behaviour. The
% system normally results in input of the form
% \begin{verbatim}
% \MyModuleSetup{
% key-one = value one,
% key-two = value two
% }
% \end{verbatim}
% or
% \begin{verbatim}
% \MyModuleMacro[
% key-one = value one,
% key-two = value two
% ]{argument}
% \end{verbatim}
% for the user.
%
% The high level functions here are intended as a method to create
% key--value controls. Keys are themselves created using a key--value
% interface, minimising the number of functions and arguments
% required. Each key is created by setting one or more \emph{properties}
% of the key:
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key-one .code:n = code including parameter #1,
% key-two .tl_set:N = \l_mymodule_store_tl
% }
% \end{verbatim}
% These values can then be set as with other key--value approaches:
% \begin{verbatim}
% \keys_set:nn { mymodule }
% {
% key-one = value one,
% key-two = value two
% }
% \end{verbatim}
%
% At a document level, \cs{keys_set:nn} is used within a
% document function, for example
% \begin{verbatim}
% \DeclareDocumentCommand \MyModuleSetup { m }
% { \keys_set:nn { mymodule } { #1 } }
% \DeclareDocumentCommand \MyModuleMacro { o m }
% {
% \group_begin:
% \keys_set:nn { mymodule } { #1 }
% % Main code for \MyModuleMacro
% \group_end:
% }
% \end{verbatim}
%
% Key names may contain any tokens, as they are handled internally
% using \cs{tl_to_str:n}. As discussed in
% section~\ref{sec:l3keys:subdivision}, it is suggested that the character
% |/| is reserved for sub-division of keys into logical
% groups. Functions and variables are \emph{not} expanded when creating
% key names, and so
% \begin{verbatim}
% \tl_set:Nn \l_mymodule_tmp_tl { key }
% \keys_define:nn { mymodule }
% {
% \l_mymodule_tmp_tl .code:n = code
% }
% \end{verbatim}
% creates a key called |\l_mymodule_tmp_tl|, and not one called
% \texttt{key}.
%
% \section{Creating keys}
%
% \begin{function}[updated = 2017-11-14]{\keys_define:nn}
% \begin{syntax}
% \cs{keys_define:nn} \Arg{module} \Arg{keyval list}
% \end{syntax}
% Parses the \meta{keyval list} and defines the keys listed there for
% \meta{module}. The \meta{module} name should be a text value, but
% there are no restrictions on the nature of the text. In practice the
% \meta{module} should be chosen to be unique to the module in question
% (unless deliberately adding keys to an existing module).
%
% The \meta{keyval list} should consist of one or more key names along
% with an associated key \emph{property}. The properties of a key
% determine how it acts. The individual properties are described
% in the following text; a typical use of \cs{keys_define:nn} might
% read
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% keyname .code:n = Some~code~using~#1,
% keyname .value_required:n = true
% }
% \end{verbatim}
% where the properties of the key begin from the |.| after the key
% name.
% \end{function}
%
% The various properties available take either no arguments at
% all, or require one or more arguments. This is indicated in the
% name of the property using an argument specification. In the following
% discussion, each property is illustrated attached to an
% arbitrary \meta{key}, which when used may be supplied with a
% \meta{value}. All key \emph{definitions} are local.
%
% Key properties are applied in the reading order and so the ordering
% is significant. Key properties which define \enquote{actions}, such
% as |.code:n|, |.tl_set:N|, \emph{etc.}, override one another.
% Some other properties are mutually exclusive, notably |.value_required:n|
% and |.value_forbidden:n|, and so they replace one another. However,
% properties covering non-exclusive behaviours may be given in any order. Thus
% for example the following definitions are equivalent.
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% keyname .code:n = Some~code~using~#1,
% keyname .value_required:n = true
% }
% \keys_define:nn { mymodule }
% {
% keyname .value_required:n = true,
% keyname .code:n = Some~code~using~#1
% }
% \end{verbatim}
% Note that with the exception of the special |.undefine:| property, all
% key properties define the key within the current \TeX{} scope.
%
% \begin{function}[updated = 2013-07-08]
% {.bool_set:N, .bool_set:c, .bool_gset:N, .bool_gset:c}
% \begin{syntax}
% \meta{key} .bool_set:N = \meta{boolean}
% \end{syntax}
% Defines \meta{key} to set \meta{boolean} to \meta{value} (which
% must be either \texttt{true} or \texttt{false}). If the variable
% does not exist, it will be created globally at the point that
% the key is set up.
% \end{function}
%
% \begin{function}[added = 2011-08-28, updated = 2013-07-08]
% {
% .bool_set_inverse:N, .bool_set_inverse:c,
% .bool_gset_inverse:N, .bool_gset_inverse:c
% }
% \begin{syntax}
% \meta{key} .bool_set_inverse:N = \meta{boolean}
% \end{syntax}
% Defines \meta{key} to set \meta{boolean} to the logical
% inverse of \meta{value} (which must be either \texttt{true} or
% \texttt{false}).
% If the \meta{boolean} does not exist, it will be created globally
% at the point that the key is set up.
% \end{function}
%
% \begin{function}{.choice:}
% \begin{syntax}
% \meta{key} .choice:
% \end{syntax}
% Sets \meta{key} to act as a choice key. Each valid choice
% for \meta{key} must then be created, as discussed in
% section~\ref{sec:l3keys:choice}.
% \end{function}
%
% \begin{function}[added = 2011-08-21, updated = 2013-07-10]
% {.choices:nn, .choices:Vn, .choices:on, .choices:xn}
% \begin{syntax}
% \meta{key} .choices:nn = \Arg{choices} \Arg{code}
% \end{syntax}
% Sets \meta{key} to act as a choice key, and defines a series \meta{choices}
% which are implemented using the \meta{code}. Inside \meta{code},
% \cs{l_keys_choice_tl} will be the name of the choice made, and
% \cs{l_keys_choice_int} will be the position of the choice in the list
% of \meta{choices} (indexed from~$1$).
% Choices are discussed in detail in section~\ref{sec:l3keys:choice}.
% \end{function}
%
% \begin{function}[added = 2011-09-11]
% {.clist_set:N, .clist_set:c, .clist_gset:N, .clist_gset:c}
% \begin{syntax}
% \meta{key} .clist_set:N = \meta{comma list variable}
% \end{syntax}
% Defines \meta{key} to set \meta{comma list variable} to \meta{value}.
% Spaces around commas and empty items will be stripped.
% If the variable does not exist, it
% is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}[updated = 2013-07-10]{.code:n}
% \begin{syntax}
% \meta{key} .code:n = \Arg{code}
% \end{syntax}
% Stores the \meta{code} for execution when \meta{key} is used.
% The \meta{code} can include one parameter (|#1|), which will be the
% \meta{value} given for the \meta{key}.
% \end{function}
%
% \begin{function}[updated = 2013-07-09]
% {.default:n, .default:V, .default:o, .default:x}
% \begin{syntax}
% \meta{key} .default:n = \Arg{default}
% \end{syntax}
% Creates a \meta{default} value for \meta{key}, which is used if no
% value is given. This will be used if only the key name is given,
% but not if a blank \meta{value} is given:
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .code:n = Hello~#1,
% key .default:n = World
% }
% \keys_set:nn { mymodule }
% {
% key = Fred, % Prints 'Hello Fred'
% key, % Prints 'Hello World'
% key = , % Prints 'Hello '
% }
% \end{verbatim}
% The default does not affect keys where values are required or
% forbidden. Thus a required value cannot be supplied by a default
% value, and giving a default value for a key which cannot take a value
% does not trigger an error.
% \end{function}
%
% \begin{function}{.dim_set:N, .dim_set:c, .dim_gset:N, .dim_gset:c}
% \begin{syntax}
% \meta{key} .dim_set:N = \meta{dimension}
% \end{syntax}
% Defines \meta{key} to set \meta{dimension} to \meta{value} (which
% must a dimension expression). If the variable does not exist, it
% is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}{.fp_set:N, .fp_set:c, .fp_gset:N, .fp_gset:c}
% \begin{syntax}
% \meta{key} .fp_set:N = \meta{floating point}
% \end{syntax}
% Defines \meta{key} to set \meta{floating point} to \meta{value}
% (which must a floating point expression). If the variable does not exist,
% it is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}[added = 2013-07-14]
% {.groups:n}
% \begin{syntax}
% \meta{key} .groups:n = \Arg{groups}
% \end{syntax}
% Defines \meta{key} as belonging to the \meta{groups} declared. Groups
% provide a \enquote{secondary axis} for selectively setting keys, and are
% described in Section~\ref{sec:l3keys:selective}.
% \end{function}
%
% \begin{function}[added = 2016-11-22]{.inherit:n}
% \begin{syntax}
% \meta{key} .inherit:n = \Arg{parents}
% \end{syntax}
% Specifies that the \meta{key} path should inherit the keys listed
% as \meta{parents}. For example, after setting
% \begin{verbatim}
% \keys_define:n { foo } { test .code:n = \tl_show:n {#1} }
% \keys_define:n { } { bar .inherit:n = foo }
% \end{verbatim}
% setting
% \begin{verbatim}
% \keys_set:n { bar } { test = a }
% \end{verbatim}
% will be equivalent to
% \begin{verbatim}
% \keys_set:n { foo } { test = a }
% \end{verbatim}
% \end{function}
%
% \begin{function}[updated = 2013-07-09]
% {.initial:n, .initial:V, .initial:o, .initial:x}
% \begin{syntax}
% \meta{key} .initial:n = \Arg{value}
% \end{syntax}
% Initialises the \meta{key} with the \meta{value}, equivalent to
% \begin{quote}
% \cs{keys_set:nn} \Arg{module} \{ \meta{key} = \meta{value} \}
% \end{quote}
% \end{function}
%
% \begin{function}{.int_set:N, .int_set:c, .int_gset:N, .int_gset:c}
% \begin{syntax}
% \meta{key} .int_set:N = \meta{integer}
% \end{syntax}
% Defines \meta{key} to set \meta{integer} to \meta{value} (which
% must be an integer expression). If the variable does not exist, it
% is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}[updated = 2013-07-10]{.meta:n}
% \begin{syntax}
% \meta{key} .meta:n = \Arg{keyval list}
% \end{syntax}
% Makes \meta{key} a meta-key, which will set \meta{keyval list} in
% one go. The \meta{keyval list} can refer as |#1| to the value given
% at the time the \meta{key} is used (or, if no value is given, the
% \meta{key}'s default value).
% \end{function}
%
% \begin{function}[added = 2013-07-10]{.meta:nn}
% \begin{syntax}
% \meta{key} .meta:nn = \Arg{path} \Arg{keyval list}
% \end{syntax}
% Makes \meta{key} a meta-key, which will set \meta{keyval list} in
% one go using the \meta{path} in place of the current one. The
% \meta{keyval list} can refer as |#1| to the value given at the time
% the \meta{key} is used (or, if no value is given, the \meta{key}'s
% default value).
% \end{function}
%
% \begin{function}[added = 2011-08-21]{.multichoice:}
% \begin{syntax}
% \meta{key} .multichoice:
% \end{syntax}
% Sets \meta{key} to act as a multiple choice key. Each valid choice
% for \meta{key} must then be created, as discussed in
% section~\ref{sec:l3keys:choice}.
% \end{function}
%
% \begin{function}[added = 2011-08-21, updated = 2013-07-10]
% {.multichoices:nn, .multichoices:Vn, .multichoices:on, .multichoices:xn}
% \begin{syntax}
% \meta{key} .multichoices:nn \Arg{choices} \Arg{code}
% \end{syntax}
% Sets \meta{key} to act as a multiple choice key, and defines a series
% \meta{choices}
% which are implemented using the \meta{code}. Inside \meta{code},
% \cs{l_keys_choice_tl} will be the name of the choice made, and
% \cs{l_keys_choice_int} will be the position of the choice in the list
% of \meta{choices} (indexed from~$1$).
% Choices are discussed in detail in section~\ref{sec:l3keys:choice}.
% \end{function}
%
% \begin{function}{.skip_set:N, .skip_set:c, .skip_gset:N, .skip_gset:c}
% \begin{syntax}
% \meta{key} .skip_set:N = \meta{skip}
% \end{syntax}
% Defines \meta{key} to set \meta{skip} to \meta{value} (which
% must be a skip expression). If the variable does not exist, it
% is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}{.tl_set:N, .tl_set:c, .tl_gset:N, .tl_gset:c}
% \begin{syntax}
% \meta{key} .tl_set:N = \meta{token list variable}
% \end{syntax}
% Defines \meta{key} to set \meta{token list variable} to \meta{value}.
% If the variable does not exist, it is created globally
% at the point that the key is set up.
% \end{function}
%
% \begin{function}{.tl_set_x:N, .tl_set_x:c, .tl_gset_x:N, .tl_gset_x:c}
% \begin{syntax}
% \meta{key} .tl_set_x:N = \meta{token list variable}
% \end{syntax}
% Defines \meta{key} to set \meta{token list variable} to \meta{value},
% which will be subjected to an \texttt{x}-type expansion
% (\emph{i.e.}~using \cs{tl_set:Nx}). If the variable does not exist,
% it is created globally at the point that the key is set up.
% \end{function}
%
% \begin{function}[added = 2015-07-14]{.undefine:}
% \begin{syntax}
% \meta{key} .undefine:
% \end{syntax}
% Removes the definition of the \meta{key} within the current scope.
% \end{function}
%
% \begin{function}[added = 2015-07-14]{.value_forbidden:n}
% \begin{syntax}
% \meta{key} .value_forbidden:n = \texttt{true\string|false}
% \end{syntax}
% Specifies that \meta{key} cannot receive a \meta{value} when used.
% If a \meta{value} is given then an error will be issued. Setting
% the property \texttt{false} cancels the restriction.
% \end{function}
%
% \begin{function}[added = 2015-07-14]{.value_required:n}
% \begin{syntax}
% \meta{key} .value_required:n = \texttt{true\string|false}
% \end{syntax}
% Specifies that \meta{key} must receive a \meta{value} when used.
% If a \meta{value} is not given then an error will be issued. Setting
% the property \texttt{false} cancels the restriction.
% \end{function}
%
% \section{Sub-dividing keys}
% \label{sec:l3keys:subdivision}
%
% When creating large numbers of keys, it may be desirable to divide
% them into several sub-groups for a given module. This can be achieved
% either by adding a sub-division to the module name:
% \begin{verbatim}
% \keys_define:nn { module / subgroup }
% { key .code:n = code }
% \end{verbatim}
% or to the key name:
% \begin{verbatim}
% \keys_define:nn { mymodule }
% { subgroup / key .code:n = code }
% \end{verbatim}
% As illustrated, the best choice of token for sub-dividing keys in
% this way is |/|. This is because of the method that is
% used to represent keys internally. Both of the above code fragments
% set the same key, which has full name \texttt{module/subgroup/key}.
%
% As illustrated in the next section, this subdivision is
% particularly relevant to making multiple choices.
%
% \section{Choice and multiple choice keys}
% \label{sec:l3keys:choice}
%
% The \pkg{l3keys} system supports two types of choice key, in which a series
% of pre-defined input values are linked to varying implementations. Choice
% keys are usually created so that the various values are mutually-exclusive:
% only one can apply at any one time. \enquote{Multiple} choice keys are also
% supported: these allow a selection of values to be chosen at the same time.
%
% Mutually-exclusive choices are created by setting the \texttt{.choice:}
% property:
% \begin{verbatim}
% \keys_define:nn { mymodule }
% { key .choice: }
% \end{verbatim}
% For keys which are set up as choices, the valid choices are generated
% by creating sub-keys of the choice key. This can be carried out in
% two ways.
%
% In many cases, choices execute similar code which is dependant only
% on the name of the choice or the position of the choice in the
% list of all possibilities. Here, the keys can share the same code, and can
% be rapidly created using the \texttt{.choices:nn} property.
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .choices:nn =
% { choice-a, choice-b, choice-c }
% {
% You~gave~choice~'\tl_use:N \l_keys_choice_tl',~
% which~is~in~position~\int_use:N \l_keys_choice_int \c_space_tl
% in~the~list.
% }
% }
% \end{verbatim}
% The index \cs{l_keys_choice_int} in the list of choices starts at~$1$.
%
% \begin{variable}{\l_keys_choice_int, \l_keys_choice_tl}
% Inside the code block for a choice generated using \texttt{.choices:nn},
% the variables \cs{l_keys_choice_tl} and \cs{l_keys_choice_int} are
% available to indicate the name of the current choice, and its position in
% the comma list. The position is indexed from~$1$. Note that, as with
% standard key code generated using \texttt{.code:n}, the value passed to
% the key (i.e.~the choice name) is also available as |#1|.
% \end{variable}
%
% On the other hand, it is sometimes useful to create choices which
% use entirely different code from one another. This can be achieved
% by setting the \texttt{.choice:} property of a key, then manually
% defining sub-keys.
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .choice:,
% key / choice-a .code:n = code-a,
% key / choice-b .code:n = code-b,
% key / choice-c .code:n = code-c,
% }
% \end{verbatim}
%
% It is possible to mix the two methods, but manually-created choices
% should \emph{not} use \cs{l_keys_choice_tl} or \cs{l_keys_choice_int}.
% These variables do not have defined behaviour when used outside of
% code created using \texttt{.choices:nn}
% (\emph{i.e.}~anything might happen).
%
% It is possible to allow choice keys to take values which have not previously
% been defined by adding code for the special \texttt{unknown} choice. The
% general behavior of the \texttt{unknown} key is described in
% Section~\ref{sec:l3keys:unknown}. A typical example in the case of a choice
% would be to issue a custom error message:
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .choice:,
% key / choice-a .code:n = code-a,
% key / choice-b .code:n = code-b,
% key / choice-c .code:n = code-c,
% key / unknown .code:n =
% \msg_error:nnxxx { mymodule } { unknown-choice }
% { key } % Name of choice key
% { choice-a , choice-b , choice-c } % Valid choices
% { \exp_not:n {#1} } % Invalid choice given
% %
% %
% }
% \end{verbatim}
%
% Multiple choices are created in a very similar manner to mutually-exclusive
% choices, using the properties \texttt{.multichoice:} and
% \texttt{.multichoices:nn}. As with mutually exclusive choices, multiple
% choices are define as sub-keys. Thus both
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .multichoices:nn =
% { choice-a, choice-b, choice-c }
% {
% You~gave~choice~'\tl_use:N \l_keys_choice_tl',~
% which~is~in~position~
% \int_use:N \l_keys_choice_int \c_space_tl
% in~the~list.
% }
% }
% \end{verbatim}
% and
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% key .multichoice:,
% key / choice-a .code:n = code-a,
% key / choice-b .code:n = code-b,
% key / choice-c .code:n = code-c,
% }
% \end{verbatim}
% are valid.
%
% When a multiple choice key is set
% \begin{verbatim}
% \keys_set:nn { mymodule }
% {
% key = { a , b , c } % 'key' defined as a multiple choice
% }
% \end{verbatim}
% each choice is applied in turn, equivalent to a \texttt{clist} mapping or
% to applying each value individually:
% \begin{verbatim}
% \keys_set:nn { mymodule }
% {
% key = a ,
% key = b ,
% key = c ,
% }
% \end{verbatim}
% Thus each separate choice will have passed to it the
% \cs{l_keys_choice_tl} and \cs{l_keys_choice_int} in exactly
% the same way as described for \texttt{.choices:nn}.
%
% \section{Setting keys}
%
% \begin{function}[updated = 2017-11-14]
% {\keys_set:nn, \keys_set:nV, \keys_set:nv, \keys_set:no}
% \begin{syntax}
% \cs{keys_set:nn} \Arg{module} \Arg{keyval list}
% \end{syntax}
% Parses the \meta{keyval list}, and sets those keys which are defined
% for \meta{module}. The behaviour on finding an unknown key can be set
% by defining a special \texttt{unknown} key: this is illustrated
% later.
% \end{function}
%
% \begin{variable}[updated = 2015-07-14]
% {\l_keys_key_tl, \l_keys_path_tl, \l_keys_value_tl}
% For each key processed, information of the full \emph{path} of the
% key, the \emph{name} of the key and the \emph{value} of the key is
% available within three token list variables. These may be used within
% the code of the key.
%
% The \emph{value} is everything after the \texttt{=}, which may be
% empty if no value was given. This is stored in \cs{l_keys_value_tl}, and
% is not processed in any way by \cs{keys_set:nn}.
%
% The \emph{path} of the key is a \enquote{full} description of the key,
% and is unique for each key. It consists of the module and full key name,
% thus for example
% \begin{verbatim}
% \keys_set:nn { mymodule } { key-a = some-value }
% \end{verbatim}
% has path \texttt{mymodule/key-a} while
% \begin{verbatim}
% \keys_set:nn { mymodule } { subset / key-a = some-value }
% \end{verbatim}
% has path \texttt{mymodule/subset/key-a}. This information is stored in
% \cs{l_keys_path_tl}, and will have been processed by \cs{tl_to_str:n}.
%
% The \emph{name} of the key is the part of the path after the last
% \texttt{/}, and thus is not unique. In the preceding examples, both keys
% have name \texttt{key-a} despite having different paths. This information
% is stored in \cs{l_keys_key_tl}, and will have been processed by
% \cs{tl_to_str:n}.
% \end{variable}
%
% \section{Handling of unknown keys}
% \label{sec:l3keys:unknown}
%
% If a key has not previously been defined (is unknown), \cs{keys_set:nn}
% looks for a special \texttt{unknown} key for the same module, and if this is
% not defined raises an error indicating that the key name was unknown. This
% mechanism can be used for example to issue custom error texts.
% \begin{verbatim}
% \keys_define:nn { mymodule }
% {
% unknown .code:n =
% You~tried~to~set~key~'\l_keys_key_tl'~to~'#1'.
% }
% \end{verbatim}
%
% \begin{function}[added = 2011-08-23, updated = 2017-05-27]
% {
% \keys_set_known:nnN, \keys_set_known:nVN,
% \keys_set_known:nvN, \keys_set_known:noN,
% \keys_set_known:nn, \keys_set_known:nV,
% \keys_set_known:nv, \keys_set_known:no
% }
% \begin{syntax}
% \cs{keys_set_known:nnN} \Arg{module} \Arg{keyval list} \meta{tl}
% \end{syntax}
% In some cases, the desired behavior is to simply ignore unknown keys,
% collecting up information on these for later processing. The
% \cs{keys_set_known:nnN} function parses the \meta{keyval list}, and sets
% those keys which are defined for \meta{module}. Any keys which are unknown
% are not processed further by the parser.
% The key--value pairs for each \emph{unknown} key name are
% stored in the \meta{tl} in a comma-separated form (\emph{i.e.}~an edited
% version of the \meta{keyval list}). The \cs{keys_set_known:nn} version
% skips this stage.
%
% Use of \cs{keys_set_known:nnN} can be nested, with the correct residual
% \meta{keyval list} returned at each stage.
% \end{function}
%
% \section{Selective key setting}
% \label{sec:l3keys:selective}
%
% In some cases it may be useful to be able to select only some keys for
% setting, even though these keys have the same path. For example, with
% a set of keys defined using
% \begin{verbatim}
% \keys define:nn { mymodule }
% {
% key-one .code:n = { \my_func:n {#1} } ,
% key-two .tl_set:N = \l_my_a_tl ,
% key-three .tl_set:N = \l_my_b_tl ,
% key-four .fp_set:N = \l_my_a_fp ,
% }
% \end{verbatim}
% the use of \cs{keys_set:nn} attempts to set all four keys. However, in
% some contexts it may only be sensible to set some keys, or to control the
% order of setting. To do this, keys may be assigned to \emph{groups}:
% arbitrary sets which are independent of the key tree. Thus modifying the
% example to read
% \begin{verbatim}
% \keys define:nn { mymodule }
% {
% key-one .code:n = { \my_func:n {#1} } ,
% key-one .groups:n = { first } ,
% key-two .tl_set:N = \l_my_a_tl ,
% key-two .groups:n = { first } ,
% key-three .tl_set:N = \l_my_b_tl ,
% key-three .groups:n = { second } ,
% key-four .fp_set:N = \l_my_a_fp ,
% }
% \end{verbatim}
% assigns \texttt{key-one} and \texttt{key-two} to group \texttt{first},
% \texttt{key-three} to group \texttt{second}, while \texttt{key-four} is
% not assigned to a group.
%
% Selective key setting may be achieved either by selecting one or more
% groups to be made \enquote{active}, or by marking one or more groups to
% be ignored in key setting.
%
% \begin{function}[added = 2013-07-14, updated = 2017-05-27]
% {
% \keys_set_filter:nnnN, \keys_set_filter:nnVN,
% \keys_set_filter:nnvN, \keys_set_filter:nnoN,
% \keys_set_filter:nnn, \keys_set_filter:nnV,
% \keys_set_filter:nnv, \keys_set_filter:nno
% }
% \begin{syntax}
% \cs{keys_set_filter:nnnN} \Arg{module} \Arg{groups} \Arg{keyval list} \meta{tl}
% \end{syntax}
% Activates key filtering in an \enquote{opt-out} sense: keys assigned to any
% of the \meta{groups} specified are ignored. The \meta{groups} are
% given as a comma-separated list. Unknown keys are not assigned to any
% group and are thus always set. The key--value pairs for each
% key which is filtered out are stored in the \meta{tl} in a
% comma-separated form (\emph{i.e.}~an edited version of the \meta{keyval
% list}). The \cs{keys_set_filter:nnn} version skips this stage.
%
% Use of \cs{keys_set_filter:nnnN} can be nested, with the correct residual
% \meta{keyval list} returned at each stage.
% \end{function}
%
% \begin{function}[added = 2013-07-14, updated = 2017-05-27]
% {
% \keys_set_groups:nnn, \keys_set_groups:nnV,
% \keys_set_groups:nnv, \keys_set_groups:nno
% }
% \begin{syntax}
% \cs{keys_set_groups:nnn} \Arg{module} \Arg{groups} \Arg{keyval list}
% \end{syntax}
% Activates key filtering in an \enquote{opt-in} sense: only keys assigned to
% one or more of the \meta{groups} specified are set. The \meta{groups} are
% given as a comma-separated list. Unknown keys are not assigned to any
% group and are thus never set.
% \end{function}
%
% \section{Utility functions for keys}
%
% \begin{function}[EXP, pTF, updated = 2017-11-14]{\keys_if_exist:nn}
% \begin{syntax}
% \cs{keys_if_exist_p:nn} \Arg{module} \Arg{key} \\
% \cs{keys_if_exist:nnTF} \Arg{module} \Arg{key} \Arg{true code} \Arg{false code}
% \end{syntax}
% Tests if the \meta{key} exists for \meta{module}, \emph{i.e.}~if any code
% has been defined for \meta{key}.
% \end{function}
%
% \begin{function}[added = 2011-08-21,EXP,pTF, updated = 2017-11-14]
% {\keys_if_choice_exist:nnn}
% \begin{syntax}
% \cs{keys_if_choice_exist_p:nnn} \Arg{module} \Arg{key} \Arg{choice} \\
% \cs{keys_if_choice_exist:nnnTF} \Arg{module} \Arg{key} \Arg{choice} \Arg{true code} \Arg{false code}
% \end{syntax}
% Tests if the \meta{choice} is defined for the \meta{key} within the
% \meta{module}, \emph{i.e.}~if any code has been defined for
% \meta{key}/\meta{choice}. The test is \texttt{false} if the \meta{key}
% itself is not defined.
% \end{function}
%
% \begin{function}[updated = 2015-08-09]{\keys_show:nn}
% \begin{syntax}
% \cs{keys_show:nn} \Arg{module} \Arg{key}
% \end{syntax}
% Displays in the terminal
% the information associated to the \meta{key} for a \meta{module},
% including the function which is used to actually implement it.
% \end{function}
%
% \begin{function}[added = 2014-08-22, updated = 2015-08-09]{\keys_log:nn}
% \begin{syntax}
% \cs{keys_log:nn} \Arg{module} \Arg{key}
% \end{syntax}
% Writes in the log file the information associated to the \meta{key}
% for a \meta{module}. See also \cs{keys_show:nn} which displays the
% result in the terminal.
% \end{function}
%
% \section{Low-level interface for parsing key--val lists}
%
% To re-cap from earlier, a key--value list is input of the form
% \begin{verbatim}
% KeyOne = ValueOne ,
% KeyTwo = ValueTwo ,
% KeyThree
% \end{verbatim}
% where each key--value pair is separated by a comma from the rest of
% the list, and each key--value pair does not necessarily contain an
% equals sign or a value! Processing this type of input correctly
% requires a number of careful steps, to correctly account for
% braces, spaces and the category codes of separators.
%
% While the functions described earlier are used as a high-level interface
% for processing such input, in special circumstances you may wish to use
% a lower-level approach.
% The low-level parsing system converts a \meta{key--value list}
% into \meta{keys} and associated \meta{values}. After the parsing phase
% is completed, the resulting keys and values (or keys alone) are
% available for further processing. This processing is not carried out by the
% low-level parser itself, and so the parser requires the names of
% two functions along with the key--value list. One function is
% needed to process key--value pairs (it receives two arguments),
% and a second function is required for keys given without any value
% (it is called with a single argument).
%
% The parser does not double |#| tokens or expand any input. Active
% tokens |=| and |,| appearing at the outer level of braces are converted
% to category \enquote{other} (12) so that the parser does not \enquote{miss}
% any due to category code changes. Spaces are removed from the ends
% of the keys and values. Keys and values which are given in braces
% have exactly one set removed (after space trimming), thus
% \begin{verbatim}
% key = {value here},
% \end{verbatim}
% and
% \begin{verbatim}
% key = value here,
% \end{verbatim}
% are treated identically.
%
% \begin{function}[updated = 2011-09-08]{\keyval_parse:NNn}
% \begin{syntax}
% \cs{keyval_parse:NNn} \meta{function_1} \meta{function_2} \Arg{key--value list}
% \end{syntax}
% Parses the \meta{key--value list} into a series of \meta{keys} and
% associated \meta{values}, or keys alone (if no \meta{value} was
% given). \meta{function_1} should take one argument, while
% \meta{function_2} should absorb two arguments. After
% \cs{keyval_parse:NNn} has parsed the \meta{key--value list},
% \meta{function_1} is used to process keys given with no value
% and \meta{function_2} is used to process keys given with a
% value. The order of the \meta{keys} in the \meta{key--value list}
% is preserved. Thus
% \begin{verbatim}
% \keyval_parse:NNn \function:n \function:nn
% { key1 = value1 , key2 = value2, key3 = , key4 }
% \end{verbatim}
% is converted into an input stream
% \begin{verbatim}
% \function:nn { key1 } { value1 }
% \function:nn { key2 } { value2 }
% \function:nn { key3 } { }
% \function:n { key4 }
% \end{verbatim}
% Note that there is a difference between an empty value (an equals
% sign followed by nothing) and a missing value (no equals sign at
% all). Spaces are trimmed from the ends of the \meta{key} and \meta{value},
% then one \emph{outer} set of braces is removed from the \meta{key}
% and \meta{value} as part of the processing.
% \end{function}
%
% \end{documentation}
%
% \begin{implementation}
%
% \section{\pkg{l3keys} Implementation}
%
% \begin{macrocode}
%<*initex|package>
% \end{macrocode}
%
% \subsection{Low-level interface}
%
% The low-level key parser is based heavily on \pkg{keyval}, but with a number
% of additional \enquote{safety} requirements and with the idea that the
% parsed list of key--value pairs can be processed in a variety of ways.
% The net result is that this code needs around twice the amount of time
% as \pkg{keyval} to parse the same list of keys. To optimise speed as far
% as reasonably practical, a number of lower-level approaches are taken
% rather than using the higher-level \pkg{expl3} interfaces.
%
% \begin{macrocode}
%<@@=keyval>
% \end{macrocode}
%
% \begin{variable}{\l_@@_key_tl, \l_@@_value_tl}
% The current key name and value.
% \begin{macrocode}
\tl_new:N \l_@@_key_tl
\tl_new:N \l_@@_value_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_sanitise_tl}
% A token list variable for dealing with awkward category codes in the
% input.
% \begin{macrocode}
\tl_new:N \l_@@_sanitise_tl
% \end{macrocode}
% \end{variable}
%
% \begin{macro}{\keyval_parse:NNn}
% The main function starts off by normalising category codes in package mode.
% That's relatively \enquote{expensive} so is skipped (hopefully) in format
% mode. We then hand off to the parser. The use of \cs{q_mark} here prevents
% loss of braces from the key argument. Notice that by passing the two
% processor commands along the input stack we avoid the need to track these
% at all.
% \begin{macrocode}
\cs_new_protected:Npn \keyval_parse:NNn #1#2#3
{
%<*initex>
\@@_loop:NNw #1#2 \q_mark #3 , \q_recursion_tail ,
%</initex>
%<*package>
\tl_set:Nn \l_@@_sanitise_tl {#3}
\@@_sanitise_equals:
\@@_sanitise_comma:
\exp_after:wN \@@_loop:NNw \exp_after:wN #1 \exp_after:wN #2
\exp_after:wN \q_mark \l_@@_sanitise_tl , \q_recursion_tail ,
%</package>
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_sanitise_equals:, \@@_sanitise_comma:}
% \begin{macro}
% {
% \@@_sanitise_equals_auxi:w, \@@_sanitise_equals_auxii:w,
% \@@_sanitise_comma_auxi:w, \@@_sanitise_comma_auxii:w,
% \@@_sanitise_aux:w
% }
% A reasonably fast search and replace set up specifically for the active
% tokens. The nature of the input is known so everything is hard-coded.
% With only two tokens to cover, the speed gain from using dedicated
% functions is worth it.
% \begin{macrocode}
%<*package>
\group_begin:
\char_set_catcode_active:n { `\= }
\char_set_catcode_active:n { `\, }
\cs_new_protected:Npn \@@_sanitise_equals:
{
\exp_after:wN \@@_sanitise_equals_auxi:w \l_@@_sanitise_tl
\q_mark = \q_nil =
\exp_after:wN \@@_sanitise_aux:w \l_@@_sanitise_tl
}
\cs_new_protected:Npn \@@_sanitise_equals_auxi:w #1 =
{
\tl_set:Nn \l_@@_sanitise_tl {#1}
\@@_sanitise_equals_auxii:w
}
\cs_new_protected:Npn \@@_sanitise_equals_auxii:w #1 =
{
\if_meaning:w \q_nil #1 \scan_stop:
\else:
\tl_set:Nx \l_@@_sanitise_tl
{
\exp_not:o \l_@@_sanitise_tl
\token_to_str:N =
\exp_not:n {#1}
}
\exp_after:wN \@@_sanitise_equals_auxii:w
\fi:
}
\cs_new_protected:Npn \@@_sanitise_comma:
{
\exp_after:wN \@@_sanitise_comma_auxi:w \l_@@_sanitise_tl
\q_mark , \q_nil ,
\exp_after:wN \@@_sanitise_aux:w \l_@@_sanitise_tl
}
\cs_new_protected:Npn \@@_sanitise_comma_auxi:w #1 ,
{
\tl_set:Nn \l_@@_sanitise_tl {#1}
\@@_sanitise_comma_auxii:w
}
\cs_new_protected:Npn \@@_sanitise_comma_auxii:w #1 ,
{
\if_meaning:w \q_nil #1 \scan_stop:
\else:
\tl_set:Nx \l_@@_sanitise_tl
{
\exp_not:o \l_@@_sanitise_tl
\token_to_str:N ,
\exp_not:n {#1}
}
\exp_after:wN \@@_sanitise_comma_auxii:w
\fi:
}
\group_end:
\cs_new_protected:Npn \@@_sanitise_aux:w #1 \q_mark
{ \tl_set:Nn \l_@@_sanitise_tl {#1} }
%</package>
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_loop:NNw}
% A fast test for the end of the loop, remembering to remove the leading
% quark first. Assuming that is not the case, look for a key and value then
% loop around, re-inserting a leading quark in front of the next position.
% \begin{macrocode}
\cs_new_protected:Npn \@@_loop:NNw #1#2#3 ,
{
\exp_after:wN \if_meaning:w \exp_after:wN \q_recursion_tail
\use_none:n #3 \prg_do_nothing:
\else:
\@@_split:NNw #1#2#3 == \q_stop
\exp_after:wN \@@_loop:NNw \exp_after:wN #1 \exp_after:wN #2
\exp_after:wN \q_mark
\fi:
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_split:NNw, \@@_split_value:NNw}
% \begin{macro}{\@@_split_tidy:w}
% \begin{macro}{\@@_action:}
% The value is picked up separately from the key so there can be another
% quark inserted at the front, keeping braces and allowing both parts to
% share the same code paths. The key is found first then there's a check
% that there is something there: this is biased to the common case of there
% actually being a key. For the value, we first need to see if there is
% anything to do: if there is, extract it. The appropriate action is then
% inserted in front of the key and value. Doing this using an assignment is
% marginally faster than an an expansion chain.
% \begin{macrocode}
\cs_new_protected:Npn \@@_split:NNw #1#2#3 =
{
\@@_def:Nn \l_@@_key_tl {#3}
\if_meaning:w \l_@@_key_tl \c_empty_tl
\exp_after:wN \@@_split_tidy:w
\else:
\exp_after:wN \@@_split_value:NNw
\exp_after:wN #1
\exp_after:wN #2
\exp_after:wN \q_mark
\fi:
}
\cs_new_protected:Npn \@@_split_value:NNw #1#2#3 = #4 \q_stop
{
\if:w \scan_stop: \tl_to_str:n {#4} \scan_stop:
\cs_set:Npx \@@_action:
{ \exp_not:N #1 { \exp_not:o \l_@@_key_tl } }
\else:
\if:w
\scan_stop:
\__kernel_tl_to_str:w \exp_after:wN { \use_none:n #4 }
\scan_stop:
\@@_def:Nn \l_@@_value_tl {#3}
\cs_set:Npx \@@_action:
{
\exp_not:N #2
{ \exp_not:o \l_@@_key_tl }
{ \exp_not:o \l_@@_value_tl }
}
\else:
\cs_set:Npn \@@_action:
{
\__kernel_msg_error:nn { kernel }
{ misplaced-equals-sign }
}
\fi:
\fi:
\@@_action:
}
\cs_new_protected:Npn \@@_split_tidy:w #1 \q_stop
{
\if:w
\scan_stop:
\__kernel_tl_to_str:w \exp_after:wN { \use_none:n #1 }
\scan_stop:
\else:
\exp_after:wN \@@_empty_key:
\fi:
}
\cs_new:Npn \@@_action: { }
\cs_new_protected:Npn \@@_empty_key:
{ \__kernel_msg_error:nn { kernel } { misplaced-equals-sign } }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_def:Nn}
% \begin{macro}[EXP]{\@@_def_aux:n}
% \begin{macro}[EXP]{\@@_def_aux:w}
% First remove the leading quark, then trim spaces off, and finally remove
% a set of braces.
% \begin{macrocode}
\cs_new_protected:Npn \@@_def:Nn #1#2
{
\tl_set:Nx #1
{ \tl_trim_spaces_apply:oN { \use_none:n #2 } \@@_def_aux:n }
}
\cs_new:Npn \@@_def_aux:n #1
{ \@@_def_aux:w #1 \q_stop }
\cs_new:Npn \@@_def_aux:w #1 \q_stop { \exp_not:n {#1} }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% One message for the low level parsing system.
% \begin{macrocode}
\__kernel_msg_new:nnnn { kernel } { misplaced-equals-sign }
{ Misplaced~equals~sign~in~key-value~input~\msg_line_number: }
{
LaTeX~is~attempting~to~parse~some~key-value~input~but~found~
two~equals~signs~not~separated~by~a~comma.
}
% \end{macrocode}
%
% \subsection{Constants and variables}
%
% \begin{macrocode}
%<@@=keys>
% \end{macrocode}
%
% \begin{variable}
% {
% \c_@@_code_root_tl ,
% \c_@@_default_root_tl ,
% \c_@@_groups_root_tl ,
% \c_@@_inherit_root_tl ,
% \c_@@_type_root_tl ,
% \c_@@_validate_root_tl
% }
% Various storage areas for the different data which make up keys.
% \begin{macrocode}
\tl_const:Nn \c_@@_code_root_tl { key~code~>~ }
\tl_const:Nn \c_@@_default_root_tl { key~default~>~ }
\tl_const:Nn \c_@@_groups_root_tl { key~groups~>~ }
\tl_const:Nn \c_@@_inherit_root_tl { key~inherit~>~ }
\tl_const:Nn \c_@@_type_root_tl { key~type~>~ }
\tl_const:Nn \c_@@_validate_root_tl { key~validate~>~ }
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_@@_props_root_tl}
% The prefix for storing properties.
% \begin{macrocode}
\tl_const:Nn \c_@@_props_root_tl { key~prop~>~ }
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_keys_choice_int, \l_keys_choice_tl}
% Publicly accessible data on which choice is being used when several
% are generated as a set.
% \begin{macrocode}
\int_new:N \l_keys_choice_int
\tl_new:N \l_keys_choice_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_groups_clist}
% Used for storing and recovering the list of groups which apply to a key:
% set as a comma list but at one point we have to use this for a token
% list recovery.
% \begin{macrocode}
\clist_new:N \l_@@_groups_clist
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_keys_key_tl}
% The name of a key itself: needed when setting keys.
% \begin{macrocode}
\tl_new:N \l_keys_key_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_module_tl}
% The module for an entire set of keys.
% \begin{macrocode}
\tl_new:N \l_@@_module_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_no_value_bool}
% A marker is needed internally to show if only a key or a key plus a
% value was seen: this is recorded here.
% \begin{macrocode}
\bool_new:N \l_@@_no_value_bool
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_only_known_bool}
% Used to track if only \enquote{known} keys are being set.
% \begin{macrocode}
\bool_new:N \l_@@_only_known_bool
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_keys_path_tl}
% The \enquote{path} of the current key is stored here: this is
% available to the programmer and so is public.
% \begin{macrocode}
\tl_new:N \l_keys_path_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_inherit_tl}
% \begin{macrocode}
\tl_new:N \l_@@_inherit_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_property_tl}
% The \enquote{property} begin set for a key at definition time is
% stored here.
% \begin{macrocode}
\tl_new:N \l_@@_property_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_selective_bool, \l_@@_filtered_bool}
% Two flags for using key groups: one to indicate that \enquote{selective}
% setting is active, a second to specify which type (\enquote{opt-in}
% or \enquote{opt-out}).
% \begin{macrocode}
\bool_new:N \l_@@_selective_bool
\bool_new:N \l_@@_filtered_bool
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_selective_seq}
% The list of key groups being filtered in or out during selective setting.
% \begin{macrocode}
\seq_new:N \l_@@_selective_seq
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_unused_clist}
% Used when setting only some keys to store those left over.
% \begin{macrocode}
\tl_new:N \l_@@_unused_clist
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_keys_value_tl}
% The value given for a key: may be empty if no value was given.
% \begin{macrocode}
\tl_new:N \l_keys_value_tl
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_@@_tmp_bool}
% Scratch space.
% \begin{macrocode}
\bool_new:N \l_@@_tmp_bool
% \end{macrocode}
% \end{variable}
%
% \subsection{The key defining mechanism}
%
% \begin{macro}{\keys_define:nn}
% \begin{macro}{\@@_define:nnn, \@@_define:onn}
% The public function for definitions is just a wrapper for the lower
% level mechanism, more or less. The outer function is designed to
% keep a track of the current module, to allow safe nesting. The module is set
% removing any leading |/| (which is not needed here).
% \begin{macrocode}
\cs_new_protected:Npn \keys_define:nn
{ \@@_define:onn \l_@@_module_tl }
\cs_new_protected:Npn \@@_define:nnn #1#2#3
{
\tl_set:Nx \l_@@_module_tl { \@@_remove_spaces:n {#2} }
\keyval_parse:NNn \@@_define:n \@@_define:nn {#3}
\tl_set:Nn \l_@@_module_tl {#1}
}
\cs_generate_variant:Nn \@@_define:nnn { o }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_define:n}
% \begin{macro}{\@@_define:nn}
% \begin{macro}{\@@_define_aux:nn}
% The outer functions here record whether a value was given and then
% converge on a common internal mechanism. There is first a search for
% a property in the current key name, then a check to make sure it is
% known before the code hands off to the next step.
% \begin{macrocode}
\cs_new_protected:Npn \@@_define:n #1
{
\bool_set_true:N \l_@@_no_value_bool
\@@_define_aux:nn {#1} { }
}
\cs_new_protected:Npn \@@_define:nn #1#2
{
\bool_set_false:N \l_@@_no_value_bool
\@@_define_aux:nn {#1} {#2}
}
\cs_new_protected:Npn \@@_define_aux:nn #1#2
{
\@@_property_find:n {#1}
\cs_if_exist:cTF { \c_@@_props_root_tl \l_@@_property_tl }
{ \@@_define_code:n {#2} }
{
\tl_if_empty:NF \l_@@_property_tl
{
\__kernel_msg_error:nnxx { kernel } { key-property-unknown }
{ \l_@@_property_tl } { \l_keys_path_tl }
}
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_property_find:n}
% \begin{macro}{\@@_property_find:w}
% Searching for a property means finding the last |.| in the input,
% and storing the text before and after it. Everything is turned into
% strings, so there is no problem using an \texttt{x}-type expansion.
% \begin{macrocode}
\cs_new_protected:Npn \@@_property_find:n #1
{
\tl_set:Nx \l_@@_property_tl { \@@_remove_spaces:n {#1} }
\exp_after:wN \@@_property_find:w \l_@@_property_tl . .
\q_stop {#1}
}
\cs_new_protected:Npn \@@_property_find:w #1 . #2 . #3 \q_stop #4
{
\tl_if_blank:nTF {#3}
{
\tl_clear:N \l_@@_property_tl
\__kernel_msg_error:nnn { kernel } { key-no-property } {#4}
}
{
\str_if_eq:nnTF {#3} { . }
{
\tl_set:Nx \l_keys_path_tl
{
\tl_if_empty:NF \l_@@_module_tl
{ \l_@@_module_tl / }
#1
}
\tl_set:Nn \l_@@_property_tl { . #2 }
}
{
\tl_set:Nx \l_keys_path_tl { \l_@@_module_tl / #1 . #2 }
\@@_property_search:w #3 \q_stop
}
}
}
\cs_new_protected:Npn \@@_property_search:w #1 . #2 \q_stop
{
\str_if_eq:nnTF {#2} { . }
{
\tl_set:Nx \l_keys_path_tl { \l_keys_path_tl }
\tl_set:Nn \l_@@_property_tl { . #1 }
}
{
\tl_set:Nx \l_keys_path_tl { \l_keys_path_tl . #1 }
\@@_property_search:w #2 \q_stop
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_define_code:n}
% \begin{macro}[EXP]{\@@_define_code:w}
% Two possible cases. If there is a value for the key, then just use
% the function. If not, then a check to make sure there is no need for
% a value with the property. If there should be one then complain,
% otherwise execute it. There is no need to check for a |:| as if it
% was missing the earlier tests would have failed.
% \begin{macrocode}
\cs_new_protected:Npn \@@_define_code:n #1
{
\bool_if:NTF \l_@@_no_value_bool
{
\exp_after:wN \@@_define_code:w
\l_@@_property_tl \q_stop
{ \use:c { \c_@@_props_root_tl \l_@@_property_tl } }
{
\__kernel_msg_error:nnxx { kernel }
{ key-property-requires-value } { \l_@@_property_tl }
{ \l_keys_path_tl }
}
}
{ \use:c { \c_@@_props_root_tl \l_@@_property_tl } {#1} }
}
\exp_last_unbraced:NNNNo
\cs_new:Npn \__keys_define_code:w #1 \c_colon_str #2 \q_stop
{ \tl_if_empty:nTF {#2} }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \subsection{Turning properties into actions}
%
% \begin{macro}{\@@_bool_set:Nn, \@@_bool_set:cn}
% Boolean keys are really just choices, but all done by hand. The
% second argument here is the scope: either empty or \texttt{ g } for
% global.
% \begin{macrocode}
\cs_new_protected:Npn \@@_bool_set:Nn #1#2
{
\bool_if_exist:NF #1 { \bool_new:N #1 }
\@@_choice_make:
\@@_cmd_set:nx { \l_keys_path_tl / true }
{ \exp_not:c { bool_ #2 set_true:N } \exp_not:N #1 }
\@@_cmd_set:nx { \l_keys_path_tl / false }
{ \exp_not:c { bool_ #2 set_false:N } \exp_not:N #1 }
\@@_cmd_set:nn { \l_keys_path_tl / unknown }
{
\__kernel_msg_error:nnx { kernel } { boolean-values-only }
{ \l_keys_key_tl }
}
\@@_default_set:n { true }
}
\cs_generate_variant:Nn \@@_bool_set:Nn { c }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_bool_set_inverse:Nn, \@@_bool_set_inverse:cn}
% Inverse boolean setting is much the same.
% \begin{macrocode}
\cs_new_protected:Npn \@@_bool_set_inverse:Nn #1#2
{
\bool_if_exist:NF #1 { \bool_new:N #1 }
\@@_choice_make:
\@@_cmd_set:nx { \l_keys_path_tl / true }
{ \exp_not:c { bool_ #2 set_false:N } \exp_not:N #1 }
\@@_cmd_set:nx { \l_keys_path_tl / false }
{ \exp_not:c { bool_ #2 set_true:N } \exp_not:N #1 }
\@@_cmd_set:nn { \l_keys_path_tl / unknown }
{
\__kernel_msg_error:nnx { kernel } { boolean-values-only }
{ \l_keys_key_tl }
}
\@@_default_set:n { true }
}
\cs_generate_variant:Nn \@@_bool_set_inverse:Nn { c }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_choice_make:, \@@_multichoice_make:}
% \begin{macro}{\@@_choice_make:N}
% \begin{macro}{\@@_choice_make_aux:N}
% To make a choice from a key, two steps: set the code, and set the
% unknown key. As multichoices and choices are essentially the same bar one
% function, the code is given together.
% \begin{macrocode}
\cs_new_protected:Npn \@@_choice_make:
{ \@@_choice_make:N \@@_choice_find:n }
\cs_new_protected:Npn \@@_multichoice_make:
{ \@@_choice_make:N \@@_multichoice_find:n }
\cs_new_protected:Npn \@@_choice_make:N #1
{
\cs_if_exist:cTF
{ \c_@@_type_root_tl \@@_parent:o \l_keys_path_tl }
{
\str_if_eq:vnTF
{ \c_@@_type_root_tl \@@_parent:o \l_keys_path_tl }
{ choice }
{
\__kernel_msg_error:nnxx { kernel } { nested-choice-key }
{ \l_keys_path_tl } { \@@_parent:o \l_keys_path_tl }
}
{ \@@_choice_make_aux:N #1 }
}
{ \@@_choice_make_aux:N #1 }
}
\cs_new_protected:Npn \@@_choice_make_aux:N #1
{
\cs_set_nopar:cpn { \c_@@_type_root_tl \l_keys_path_tl }
{ choice }
\@@_cmd_set:nn { \l_keys_path_tl } { #1 {##1} }
\@@_cmd_set:nn { \l_keys_path_tl / unknown }
{
\__kernel_msg_error:nnxx { kernel } { key-choice-unknown }
{ \l_keys_path_tl } {##1}
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_choices_make:nn, \@@_multichoices_make:nn}
% \begin{macro}{\@@_choices_make:Nnn}
% Auto-generating choices means setting up the root key as a choice, then
% defining each choice in turn.
% \begin{macrocode}
\cs_new_protected:Npn \@@_choices_make:nn
{ \@@_choices_make:Nnn \@@_choice_make: }
\cs_new_protected:Npn \@@_multichoices_make:nn
{ \@@_choices_make:Nnn \@@_multichoice_make: }
\cs_new_protected:Npn \@@_choices_make:Nnn #1#2#3
{
#1
\int_zero:N \l_keys_choice_int
\clist_map_inline:nn {#2}
{
\int_incr:N \l_keys_choice_int
\@@_cmd_set:nx
{ \l_keys_path_tl / \@@_remove_spaces:n {##1} }
{
\tl_set:Nn \exp_not:N \l_keys_choice_tl {##1}
\int_set:Nn \exp_not:N \l_keys_choice_int
{ \int_use:N \l_keys_choice_int }
\exp_not:n {#3}
}
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}
% {\@@_cmd_set:nn, \@@_cmd_set:nx, \@@_cmd_set:Vn, \@@_cmd_set:Vo}
% Setting the code for a key first logs if appropriate that we are
% defining a new key, then saves the code.
% \begin{macrocode}
\__kernel_patch:nnNNpn
{
\cs_if_exist:cF { \c_@@_code_root_tl #1 }
{ \__kernel_debug_log:x { Defining~key~#1~\msg_line_context: } }
}
{ }
\cs_new_protected:Npn \@@_cmd_set:nn #1#2
{ \cs_set_protected:cpn { \c_@@_code_root_tl #1 } ##1 {#2} }
\cs_generate_variant:Nn \@@_cmd_set:nn { nx , Vn , Vo }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_default_set:n}
% Setting a default value is easy. These are stored using \cs{cs_set:cpx} as this
% avoids any worries about whether a token list exists.
% \begin{macrocode}
\cs_new_protected:Npn \@@_default_set:n #1
{
\tl_if_empty:nTF {#1}
{
\cs_set_eq:cN
{ \c_@@_default_root_tl \l_keys_path_tl }
\tex_undefined:D
}
{
\cs_set:cpx
{ \c_@@_default_root_tl \l_keys_path_tl }
{ \exp_not:n {#1} }
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_groups_set:n}
% Assigning a key to one or more groups uses comma lists. As the list of
% groups only exists if there is anything to do, the setting is done using
% a scratch list. For the usual grouping reasons we use the low-level
% approach to undefining a list. We also use the low-level approach for
% the other case to avoid tripping up the |check-declarations| code.
% \begin{macrocode}
\cs_new_protected:Npn \@@_groups_set:n #1
{
\clist_set:Nn \l_@@_groups_clist {#1}
\clist_if_empty:NTF \l_@@_groups_clist
{
\cs_set_eq:cN { \c_@@_groups_root_tl \l_keys_path_tl }
\tex_undefined:D
}
{
\cs_set_eq:cN { \c_@@_groups_root_tl \l_keys_path_tl }
\l_@@_groups_clist
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_inherit:n}
% Inheritance means ignoring anything already said about the key:
% zap the lot and set up.
% \begin{macrocode}
\cs_new_protected:Npn \@@_inherit:n #1
{
\@@_undefine:
\cs_set_nopar:cpn { \c_@@_inherit_root_tl \l_keys_path_tl } {#1}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_initialise:n}
% A set up for initialisation: just run the code if it exists.
% \begin{macrocode}
\cs_new_protected:Npn \@@_initialise:n #1
{
\cs_if_exist_use:cT { \c_@@_code_root_tl \l_keys_path_tl } { {#1} }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_meta_make:n}
% \begin{macro}{\@@_meta_make:nn}
% To create a meta-key, simply set up to pass data through.
% \begin{macrocode}
\cs_new_protected:Npn \@@_meta_make:n #1
{
\@@_cmd_set:Vo \l_keys_path_tl
{
\exp_after:wN \keys_set:nn
\exp_after:wN { \l_@@_module_tl } {#1}
}
}
\cs_new_protected:Npn \@@_meta_make:nn #1#2
{ \@@_cmd_set:Vn \l_keys_path_tl { \keys_set:nn {#1} {#2} } }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_undefine:}
% Undefining a key has to be done without \cs{cs_undefine:c} as that
% function acts globally.
% \begin{macrocode}
\cs_new_protected:Npn \@@_undefine:
{
\clist_map_inline:nn
{ code , default , groups , inherit , type , validate }
{
\cs_set_eq:cN
{ \tl_use:c { c_@@_ ##1 _root_tl } \l_keys_path_tl }
\tex_undefined:D
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_value_requirement:nn}
% \begin{macro}{\@@_validate_forbidden:, \@@_validate_required:}
% \begin{macro}{\@@_validate_cleanup:w}
% Validating key input is done using a second function which runs before
% the main key code. Setting that up means setting it equal to a generic
% stub which does the check. This approach makes the lookup very fast at
% the cost of one additional csname per key that needs it. The cleanup here
% has to know the structure of the following code.
% \begin{macrocode}
\cs_new_protected:Npn \@@_value_requirement:nn #1#2
{
\str_case:nnF {#2}
{
{ true }
{
\cs_set_eq:cc
{ \c_@@_validate_root_tl \l_keys_path_tl }
{ @@_validate_ #1 : }
}
{ false }
{
\cs_if_eq:ccT
{ \c_@@_validate_root_tl \l_keys_path_tl }
{ @@_validate_ #1 : }
{
\cs_set_eq:cN
{ \c_@@_validate_root_tl \l_keys_path_tl }
\tex_undefined:D
}
}
}
{
\__kernel_msg_error:nnx { kernel }
{ key-property-boolean-values-only }
{ .value_ #1 :n }
}
}
\cs_new_protected:Npn \@@_validate_forbidden:
{
\bool_if:NF \l_@@_no_value_bool
{
\__kernel_msg_error:nnxx { kernel } { value-forbidden }
{ \l_keys_path_tl } { \l_keys_value_tl }
\@@_validate_cleanup:w
}
}
\cs_new_protected:Npn \@@_validate_required:
{
\bool_if:NT \l_@@_no_value_bool
{
\__kernel_msg_error:nnx { kernel } { value-required }
{ \l_keys_path_tl }
\@@_validate_cleanup:w
}
}
\cs_new_protected:Npn \@@_validate_cleanup:w #1 \cs_end: #2#3 { }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_variable_set:NnnN, \@@_variable_set:cnnN}
% Setting a variable takes the type and scope separately so that
% it is easy to make a new variable if needed.
% \begin{macrocode}
\cs_new_protected:Npn \@@_variable_set:NnnN #1#2#3#4
{
\use:c { #2_if_exist:NF } #1 { \use:c { #2 _new:N } #1 }
\@@_cmd_set:nx { \l_keys_path_tl }
{
\exp_not:c { #2 _ #3 set:N #4 }
\exp_not:N #1
\exp_not:n { {##1} }
}
}
\cs_generate_variant:Nn \@@_variable_set:NnnN { c }
% \end{macrocode}
% \end{macro}
%
% \subsection{Creating key properties}
%
% The key property functions are all wrappers for internal functions,
% meaning that things stay readable and can also be altered later on.
%
% Importantly, while key properties have \enquote{normal} argument specs, the
% underlying code always supplies one braced argument to these. As such, argument
% expansion is handled by hand rather than using the standard tools. This shows
% up particularly for the two-argument properties, where things would otherwise
% go badly wrong.
%
% \begin{macro}{.bool_set:N, .bool_set:c}
% \begin{macro}{.bool_gset:N, .bool_gset:c}
% One function for this.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_set:N } #1
{ \@@_bool_set:Nn #1 { } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_set:c } #1
{ \@@_bool_set:cn {#1} { } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_gset:N } #1
{ \@@_bool_set:Nn #1 { g } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_gset:c } #1
{ \@@_bool_set:cn {#1} { g } }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.bool_set_inverse:N, .bool_set_inverse:c}
% \begin{macro}{.bool_gset_inverse:N, .bool_gset_inverse:c}
% One function for this.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_set_inverse:N } #1
{ \@@_bool_set_inverse:Nn #1 { } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_set_inverse:c } #1
{ \@@_bool_set_inverse:cn {#1} { } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_gset_inverse:N } #1
{ \@@_bool_set_inverse:Nn #1 { g } }
\cs_new_protected:cpn { \c_@@_props_root_tl .bool_gset_inverse:c } #1
{ \@@_bool_set_inverse:cn {#1} { g } }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.choice:}
% Making a choice is handled internally, as it is also needed by
% \texttt{.generate_choices:n}.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .choice: }
{ \@@_choice_make: }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}
% {.choices:nn, .choices:Vn, .choices:on, .choices:xn}
% For auto-generation of a series of mutually-exclusive choices.
% Here, |#1| consists of two separate
% arguments, hence the slightly odd-looking implementation.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .choices:nn } #1
{ \@@_choices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .choices:Vn } #1
{ \exp_args:NV \@@_choices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .choices:on } #1
{ \exp_args:No \@@_choices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .choices:xn } #1
{ \exp_args:Nx \@@_choices_make:nn #1 }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.code:n}
% Creating code is simply a case of passing through to the underlying
% \texttt{set} function.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .code:n } #1
{ \@@_cmd_set:nn { \l_keys_path_tl } {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.clist_set:N, .clist_set:c}
% \begin{macro}{.clist_gset:N, .clist_gset:c}
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .clist_set:N } #1
{ \@@_variable_set:NnnN #1 { clist } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .clist_set:c } #1
{ \@@_variable_set:cnnN {#1} { clist } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .clist_gset:N } #1
{ \@@_variable_set:NnnN #1 { clist } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .clist_gset:c } #1
{ \@@_variable_set:cnnN {#1} { clist } { g } n }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.default:n, .default:V, .default:o, .default:x}
% Expansion is left to the internal functions.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .default:n } #1
{ \@@_default_set:n {#1} }
\cs_new_protected:cpn { \c_@@_props_root_tl .default:V } #1
{ \exp_args:NV \@@_default_set:n #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .default:o } #1
{ \exp_args:No \@@_default_set:n {#1} }
\cs_new_protected:cpn { \c_@@_props_root_tl .default:x } #1
{ \exp_args:Nx \@@_default_set:n {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.dim_set:N, .dim_set:c}
% \begin{macro}{.dim_gset:N, .dim_gset:c}
% Setting a variable is very easy: just pass the data along.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .dim_set:N } #1
{ \@@_variable_set:NnnN #1 { dim } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .dim_set:c } #1
{ \@@_variable_set:cnnN {#1} { dim } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .dim_gset:N } #1
{ \@@_variable_set:NnnN #1 { dim } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .dim_gset:c } #1
{ \@@_variable_set:cnnN {#1} { dim } { g } n }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.fp_set:N, .fp_set:c}
% \begin{macro}{.fp_gset:N, .fp_gset:c}
% Setting a variable is very easy: just pass the data along.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .fp_set:N } #1
{ \@@_variable_set:NnnN #1 { fp } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .fp_set:c } #1
{ \@@_variable_set:cnnN {#1} { fp } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .fp_gset:N } #1
{ \@@_variable_set:NnnN #1 { fp } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .fp_gset:c } #1
{ \@@_variable_set:cnnN {#1} { fp } { g } n }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.groups:n}
% A single property to create groups of keys.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .groups:n } #1
{ \@@_groups_set:n {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.inherit:n}
% Nothing complex: only one variant at the moment!
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .inherit:n } #1
{ \@@_inherit:n {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.initial:n, .initial:V, .initial:o, .initial:x}
% The standard hand-off approach.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .initial:n } #1
{ \@@_initialise:n {#1} }
\cs_new_protected:cpn { \c_@@_props_root_tl .initial:V } #1
{ \exp_args:NV \@@_initialise:n #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .initial:o } #1
{ \exp_args:No \@@_initialise:n {#1} }
\cs_new_protected:cpn { \c_@@_props_root_tl .initial:x } #1
{ \exp_args:Nx \@@_initialise:n {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.int_set:N, .int_set:c}
% \begin{macro}{.int_gset:N, .int_gset:c}
% Setting a variable is very easy: just pass the data along.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .int_set:N } #1
{ \@@_variable_set:NnnN #1 { int } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .int_set:c } #1
{ \@@_variable_set:cnnN {#1} { int } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .int_gset:N } #1
{ \@@_variable_set:NnnN #1 { int } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .int_gset:c } #1
{ \@@_variable_set:cnnN {#1} { int } { g } n }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.meta:n}
% Making a meta is handled internally.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .meta:n } #1
{ \@@_meta_make:n {#1} }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.meta:nn}
% Meta with path: potentially lots of variants, but for the moment
% no so many defined.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .meta:nn } #1
{ \@@_meta_make:nn #1 }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.multichoice:}
% \begin{macro}
% {
% .multichoices:nn, .multichoices:Vn, .multichoices:on,
% .multichoices:xn,
% }
% The same idea as \texttt{.choice:} and \texttt{.choices:nn}, but
% where more than one choice is allowed.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .multichoice: }
{ \@@_multichoice_make: }
\cs_new_protected:cpn { \c_@@_props_root_tl .multichoices:nn } #1
{ \@@_multichoices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .multichoices:Vn } #1
{ \exp_args:NV \@@_multichoices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .multichoices:on } #1
{ \exp_args:No \@@_multichoices_make:nn #1 }
\cs_new_protected:cpn { \c_@@_props_root_tl .multichoices:xn } #1
{ \exp_args:Nx \@@_multichoices_make:nn #1 }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.skip_set:N, .skip_set:c}
% \begin{macro}{.skip_gset:N, .skip_gset:c}
% Setting a variable is very easy: just pass the data along.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .skip_set:N } #1
{ \@@_variable_set:NnnN #1 { skip } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .skip_set:c } #1
{ \@@_variable_set:cnnN {#1} { skip } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .skip_gset:N } #1
{ \@@_variable_set:NnnN #1 { skip } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .skip_gset:c } #1
{ \@@_variable_set:cnnN {#1} { skip } { g } n }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.tl_set:N, .tl_set:c}
% \begin{macro}{.tl_gset:N, .tl_gset:c}
% \begin{macro}{.tl_set_x:N, .tl_set_x:c}
% \begin{macro}{.tl_gset_x:N, .tl_gset_x:c}
% Setting a variable is very easy: just pass the data along.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_set:N } #1
{ \@@_variable_set:NnnN #1 { tl } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_set:c } #1
{ \@@_variable_set:cnnN {#1} { tl } { } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_set_x:N } #1
{ \@@_variable_set:NnnN #1 { tl } { } x }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_set_x:c } #1
{ \@@_variable_set:cnnN {#1} { tl } { } x }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_gset:N } #1
{ \@@_variable_set:NnnN #1 { tl } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_gset:c } #1
{ \@@_variable_set:cnnN {#1} { tl } { g } n }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_gset_x:N } #1
{ \@@_variable_set:NnnN #1 { tl } { g } x }
\cs_new_protected:cpn { \c_@@_props_root_tl .tl_gset_x:c } #1
{ \@@_variable_set:cnnN {#1} { tl } { g } x }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{.undefine:}
% Another simple wrapper.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .undefine: }
{ \@@_undefine: }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{.value_forbidden:n}
% \begin{macro}{.value_required:n}
% These are very similar, so both call the same function.
% \begin{macrocode}
\cs_new_protected:cpn { \c_@@_props_root_tl .value_forbidden:n } #1
{ \@@_value_requirement:nn { forbidden } {#1} }
\cs_new_protected:cpn { \c_@@_props_root_tl .value_required:n } #1
{ \@@_value_requirement:nn { required } {#1} }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \subsection{Setting keys}
%
% \begin{macro}{\keys_set:nn, \keys_set:nV, \keys_set:nv, \keys_set:no}
% \begin{macro}{\@@_set:nnn, \@@_set:onn}
% A simple wrapper again.
% \begin{macrocode}
\cs_new_protected:Npn \keys_set:nn
{ \@@_set:onn { \l_@@_module_tl } }
\cs_new_protected:Npn \@@_set:nnn #1#2#3
{
\tl_set:Nx \l_@@_module_tl { \@@_remove_spaces:n {#2} }
\keyval_parse:NNn \@@_set:n \@@_set:nn {#3}
\tl_set:Nn \l_@@_module_tl {#1}
}
\cs_generate_variant:Nn \keys_set:nn { nV , nv , no }
\cs_generate_variant:Nn \@@_set:nnn { o }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}
% {
% \keys_set_known:nnN, \keys_set_known:nVN,
% \keys_set_known:nvN, \keys_set_known:noN
% }
% \begin{macro}{\@@_set_known:nnnN, \@@_set_known:onnN}
% \begin{macro}
% {
% \keys_set_known:nn, \keys_set_known:nV,
% \keys_set_known:nv, \keys_set_known:no
% }
% \begin{macro}{\@@_keys_set_known:nn}
% Setting known keys simply means setting the appropriate flag, then
% running the standard code. To allow for nested setting, any existing
% value of \cs{l_@@_unused_clist} is saved on the stack and reset
% afterwards. Note that for speed/simplicity reasons we use a \texttt{tl}
% operation to set the \texttt{clist} here!
% \begin{macrocode}
\cs_new_protected:Npn \keys_set_known:nnN
{ \@@_set_known:onnN \l_@@_unused_clist }
\cs_generate_variant:Nn \keys_set_known:nnN { nV , nv , no }
\cs_new_protected:Npn \@@_set_known:nnnN #1#2#3#4
{
\clist_clear:N \l_@@_unused_clist
\keys_set_known:nn {#2} {#3}
\tl_set:Nx #4 { \exp_not:o { \l_@@_unused_clist } }
\tl_set:Nn \l_@@_unused_clist {#1}
}
\cs_generate_variant:Nn \@@_set_known:nnnN { o }
\cs_new_protected:Npn \keys_set_known:nn #1#2
{
\bool_if:NTF \l_@@_only_known_bool
{ \keys_set:nn }
{ \@@_set_known:nn }
{#1} {#2}
}
\cs_generate_variant:Nn \keys_set_known:nn { nV , nv , no }
\cs_new_protected:Npn \@@_set_known:nn #1#2
{
\bool_set_true:N \l_@@_only_known_bool
\keys_set:nn {#1} {#2}
\bool_set_false:N \l_@@_only_known_bool
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}
% {
% \keys_set_filter:nnnN, \keys_set_filter:nnVN, \keys_set_filter:nnvN,
% \keys_set_filter:nnoN
% }
% \begin{macro}{\@@_set_filter:nnnnN, \@@_set_filter:onnnN}
% \begin{macro}
% {
% \keys_set_filter:nnn, \keys_set_filter:nnV, \keys_set_filter:nnv,
% \keys_set_filter:nno
% }
% \begin{macro}{\@@_set_filter:nnn}
% \begin{macro}
% {
% \keys_set_groups:nnn, \keys_set_groups:nnV, \keys_set_groups:nnv,
% \keys_set_groups:nno
% }
% \begin{macro}{\@@_set_groups:nnn}
% \begin{macro}{\@@_set_selective:nnn}
% \begin{macro}{\@@_set_selective:nnnn, \@@_set_selective:onnn}
% \begin{macro}{\@@_set_selective:nn}
% The idea of setting keys in a selective manner again uses flags
% wrapped around the basic code. The comments on \cs{keys_set_known:nnN}
% also apply here. We have a bit more shuffling to do to keep everything
% nestable.
% \begin{macrocode}
\cs_new_protected:Npn \keys_set_filter:nnnN
{ \@@_set_filter:onnnN \l_@@_unused_clist }
\cs_generate_variant:Nn \keys_set_filter:nnnN { nnV , nnv , nno }
\cs_new_protected:Npn \@@_set_filter:nnnnN #1#2#3#4#5
{
\clist_clear:N \l_@@_unused_clist
\keys_set_filter:nnn {#2} {#3} {#4}
\tl_set:Nx #5 { \exp_not:o { \l_@@_unused_clist } }
\tl_set:Nn \l_@@_unused_clist {#1}
}
\cs_generate_variant:Nn \@@_set_filter:nnnnN { o }
\cs_new_protected:Npn \keys_set_filter:nnn #1#2#3
{
\bool_if:NTF \l_@@_filtered_bool
{ \@@_set_selective:nnn }
{ \@@_set_filter:nnn }
{#1} {#2} {#3}
}
\cs_generate_variant:Nn \keys_set_filter:nnn { nnV , nnv , nno }
\cs_new_protected:Npn \@@_set_filter:nnn #1#2#3
{
\bool_set_true:N \l_@@_filtered_bool
\@@_set_selective:nnn {#1} {#2} {#3}
\bool_set_false:N \l_@@_filtered_bool
}
\cs_new_protected:Npn \keys_set_groups:nnn #1#2#3
{
\bool_if:NTF \l_@@_filtered_bool
{ \@@_set_groups:nnn }
{ \@@_set_selective:nnn }
{#1} {#2} {#3}
}
\cs_generate_variant:Nn \keys_set_groups:nnn { nnV , nnv , nno }
\cs_new_protected:Npn \@@_set_groups:nnn #1#2#3
{
\bool_set_false:N \l_@@_filtered_bool
\@@_set_selective:nnn {#1} {#2} {#3}
\bool_set_true:N \l_@@_filtered_bool
}
\cs_new_protected:Npn \@@_set_selective:nnn
{ \@@_set_selective:onnn \l_@@_selective_seq }
\cs_new_protected:Npn \@@_set_selective:nnnn #1#2#3#4
{
\seq_set_from_clist:Nn \l_@@_selective_seq {#3}
\bool_if:NTF \l_@@_selective_bool
{ \keys_set:nn }
{ \@@_set_selective:nn }
{#2} {#4}
\tl_set:Nn \l_@@_selective_seq {#1}
}
\cs_generate_variant:Nn \@@_set_selective:nnnn { o }
\cs_new_protected:Npn \@@_set_selective:nn #1#2
{
\bool_set_true:N \l_@@_selective_bool
\keys_set:nn {#1} {#2}
\bool_set_false:N \l_@@_selective_bool
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_set:n, \@@_set:nn}
% \begin{macro}{\@@_set_aux:nnn, \@@_set_aux:onn}
% \begin{macro}{\@@_find_key_module:w}
% \begin{macro}{\@@_set_aux:, \@@_set_selective:}
% A shared system once again. First, set the current path and add a
% default if needed. There are then checks to see if the a value is
% required or forbidden. If everything passes, move on to execute the
% code.
% \begin{macrocode}
\cs_new_protected:Npn \@@_set:n #1
{
\bool_set_true:N \l_@@_no_value_bool
\@@_set_aux:onn \l_@@_module_tl {#1} { }
}
\cs_new_protected:Npn \@@_set:nn #1#2
{
\bool_set_false:N \l_@@_no_value_bool
\@@_set_aux:onn \l_@@_module_tl {#1} {#2}
}
% \end{macrocode}
% The key path here can be fully defined, after which there is a search
% for the key and module names: the user may have passed them with part
% of what is actually the module (for our purposes) in the key name. As
% that happens on a per-key basis, we use the stack approach to restore
% the module name without a group.
% \begin{macrocode}
\cs_new_protected:Npn \@@_set_aux:nnn #1#2#3
{
\tl_set:Nx \l_keys_path_tl
{
\tl_if_blank:nF {#1}
{ #1 / }
\@@_remove_spaces:n {#2}
}
\tl_clear:N \l_@@_module_tl
\exp_after:wN \@@_find_key_module:w \l_keys_path_tl / \q_stop
\@@_value_or_default:n {#3}
\bool_if:NTF \l_@@_selective_bool
{ \@@_set_selective: }
{ \@@_execute: }
\tl_set:Nn \l_@@_module_tl {#1}
}
\cs_generate_variant:Nn \@@_set_aux:nnn { o }
\cs_new_protected:Npn \@@_find_key_module:w #1 / #2 \q_stop
{
\tl_if_blank:nTF {#2}
{ \tl_set:Nn \l_keys_key_tl {#1} }
{
\tl_put_right:Nx \l_@@_module_tl
{
\tl_if_empty:NF \l_@@_module_tl { / }
#1
}
\@@_find_key_module:w #2 \q_stop
}
}
% \end{macrocode}
% If selective setting is active, there are a number of possible sub-cases
% to consider. The key name may not be known at all or if it is, it may not
% have any groups assigned. There is then the question of whether the
% selection is opt-in or opt-out.
% \begin{macrocode}
\cs_new_protected:Npn \@@_set_selective:
{
\cs_if_exist:cTF { \c_@@_groups_root_tl \l_keys_path_tl }
{
\clist_set_eq:Nc \l_@@_groups_clist
{ \c_@@_groups_root_tl \l_keys_path_tl }
\@@_check_groups:
}
{
\bool_if:NTF \l_@@_filtered_bool
{ \@@_execute: }
{ \@@_store_unused: }
}
}
% \end{macrocode}
% In the case where selective setting requires a comparison of the list
% of groups which apply to a key with the list of those which have been
% set active. That requires two mappings, and again a different outcome
% depending on whether opt-in or opt-out is set.
% \begin{macrocode}
\cs_new_protected:Npn \@@_check_groups:
{
\bool_set_false:N \l_@@_tmp_bool
\seq_map_inline:Nn \l_@@_selective_seq
{
\clist_map_inline:Nn \l_@@_groups_clist
{
\str_if_eq:nnT {##1} {####1}
{
\bool_set_true:N \l_@@_tmp_bool
\clist_map_break:n { \seq_map_break: }
}
}
}
\bool_if:NTF \l_@@_tmp_bool
{
\bool_if:NTF \l_@@_filtered_bool
{ \@@_store_unused: }
{ \@@_execute: }
}
{
\bool_if:NTF \l_@@_filtered_bool
{ \@@_execute: }
{ \@@_store_unused: }
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_value_or_default:n}
% If a value is given, return it as |#1|, otherwise send a default if
% available.
% \begin{macrocode}
\cs_new_protected:Npn \@@_value_or_default:n #1
{
\bool_if:NTF \l_@@_no_value_bool
{
\cs_if_exist:cTF { \c_@@_default_root_tl \l_keys_path_tl }
{
\tl_set_eq:Nc
\l_keys_value_tl
{ \c_@@_default_root_tl \l_keys_path_tl }
}
{ \tl_clear:N \l_keys_value_tl }
}
{ \tl_set:Nn \l_keys_value_tl {#1} }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_execute:, \@@_execute_inherit:, \@@_execute_unknown:}
% \begin{macro}[EXP]{\@@_execute:nn}
% \begin{macro}{\@@_store_unused:}
% Actually executing a key is done in two parts. First, look for the
% key itself, then look for the \texttt{unknown} key with the same
% path. If both of these fail, complain. What exactly happens if a key
% is unknown depends on whether unknown keys are being skipped or if
% an error should be raised.
% \begin{macrocode}
\cs_new_protected:Npn \@@_execute:
{
\cs_if_exist:cTF { \c_@@_code_root_tl \l_keys_path_tl }
{
\cs_if_exist_use:c { \c_@@_validate_root_tl \l_keys_path_tl }
\cs:w \c_@@_code_root_tl \l_keys_path_tl \exp_after:wN \cs_end:
\exp_after:wN { \l_keys_value_tl }
}
{
\bool_if:NTF \l_@@_only_known_bool
{ \@@_store_unused: }
{
\cs_if_exist:cTF
{ \c_@@_inherit_root_tl \@@_parent:o \l_keys_path_tl }
{ \@@_execute_inherit: }
{ \@@_execute_unknown: }
}
}
}
% \end{macrocode}
% To deal with the case where there is no hit, we leave
% \cs{@@_execute_unknown:} in the input stream and clean it up using the
% break function: that avoids needing a boolean.
% \begin{macrocode}
\cs_new_protected:Npn \@@_execute_inherit:
{
\clist_map_inline:cn
{ \c_@@_inherit_root_tl \@@_parent:o \l_keys_path_tl }
{
\cs_if_exist:cT
{ \c_@@_code_root_tl ##1 / \l_keys_key_tl }
{
\tl_set:Nn \l_@@_inherit_tl {##1}
\cs:w \c_@@_code_root_tl ##1 / \l_keys_key_tl
\exp_after:wN \cs_end: \exp_after:wN
{ \l_keys_value_tl }
\clist_map_break:n { \use_none:n }
}
}
\@@_execute_unknown:
}
\cs_new_protected:Npn \@@_execute_unknown:
{
\cs_if_exist:cTF
{ \c_@@_code_root_tl \l_@@_module_tl / unknown }
{
\cs:w \c_@@_code_root_tl \l_@@_module_tl / unknown
\exp_after:wN \cs_end: \exp_after:wN { \l_keys_value_tl }
}
{
\__kernel_msg_error:nnxx { kernel } { key-unknown }
{ \l_keys_path_tl } { \l_@@_module_tl }
}
}
\cs_new:Npn \@@_execute:nn #1#2
{
\cs_if_exist:cTF { \c_@@_code_root_tl #1 }
{
\cs:w \c_@@_code_root_tl #1 \exp_after:wN \cs_end:
\exp_after:wN { \l_keys_value_tl }
}
{#2}
}
\cs_new_protected:Npn \@@_store_unused:
{
\clist_put_right:Nx \l_@@_unused_clist
{
\exp_not:o \l_keys_key_tl
\bool_if:NF \l_@@_no_value_bool
{ = { \exp_not:o \l_keys_value_tl } }
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_choice_find:n}
% \begin{macro}[EXP]{\@@_choice_find:nn}
% \begin{macro}[EXP]{\@@_multichoice_find:n}
% Executing a choice has two parts. First, try the choice given, then
% if that fails call the unknown key. That always exists, as it is created
% when a choice is first made. So there is no need for any escape code.
% For multiple choices, the same code ends up used in a mapping.
% \begin{macrocode}
\cs_new:Npn \@@_choice_find:n #1
{
\tl_if_empty:NTF \l_@@_inherit_tl
{ \@@_choice_find:nn { \l_keys_path_tl } {#1} }
{
\@@_choice_find:nn
{ \l_@@_inherit_tl / \l_keys_key_tl } {#1}
}
}
\cs_new:Npn \@@_choice_find:nn #1#2
{
\cs_if_exist:cTF { \c_@@_code_root_tl #1 / \@@_remove_spaces:n {#2} }
{ \use:c { \c_@@_code_root_tl #1 / \@@_remove_spaces:n {#2} } {#2} }
{ \use:c { \c_@@_code_root_tl #1 / unknown } {#2} }
}
\cs_new:Npn \@@_multichoice_find:n #1
{ \clist_map_function:nN {#1} \@@_choice_find:n }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \subsection{Utilities}
%
% \begin{macro}[EXP]{\@@_parent:n, \@@_parent:o}
% \begin{macro}[EXP]{\@@_parent:w}
% Used to strip off the ending part of the key path after the last~|/|.
% \begin{macrocode}
\cs_new:Npn \@@_parent:n #1
{ \@@_parent:w #1 / / \q_stop { } }
\cs_generate_variant:Nn \@@_parent:n { o }
\cs_new:Npn \@@_parent:w #1 / #2 / #3 \q_stop #4
{
\tl_if_blank:nTF {#2}
{ \use_none:n #4 }
{
\@@_parent:w #2 / #3 \q_stop { #4 / #1 }
}
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_remove_spaces:n}
% Used in a few places so worth handling as a dedicated function.
% \begin{macrocode}
\cs_new:Npn \@@_remove_spaces:n #1
{ \tl_trim_spaces:o { \tl_to_str:n {#1} } }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[EXP,pTF]{\keys_if_exist:nn}
% A utility for others to see if a key exists.
% \begin{macrocode}
\prg_new_conditional:Npnn \keys_if_exist:nn #1#2 { p , T , F , TF }
{
\cs_if_exist:cTF
{ \c_@@_code_root_tl \@@_remove_spaces:n { #1 / #2 } }
{ \prg_return_true: }
{ \prg_return_false: }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[EXP,pTF]{\keys_if_choice_exist:nnn}
% Just an alternative view on \cs{keys_if_exist:nnTF}.
% \begin{macrocode}
\prg_new_conditional:Npnn \keys_if_choice_exist:nnn #1#2#3
{ p , T , F , TF }
{
\cs_if_exist:cTF
{ \c_@@_code_root_tl \@@_remove_spaces:n { #1 / #2 / #3 } }
{ \prg_return_true: }
{ \prg_return_false: }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\keys_show:nn, \keys_log:nn, \@@_show:Nnn}
% To show a key, show its code using a message.
% \begin{macrocode}
\cs_new_protected:Npn \keys_show:nn
{ \@@_show:Nnn \msg_show:nnxxxx }
\cs_new_protected:Npn \keys_log:nn
{ \@@_show:Nnn \msg_log:nnxxxx }
\cs_new_protected:Npn \@@_show:Nnn #1#2#3
{
#1 { LaTeX / kernel } { show-key }
{ \@@_remove_spaces:n { #2 / #3 } }
{
\keys_if_exist:nnT {#2} {#3}
{
\exp_args:Nnf \msg_show_item_unbraced:nn { code }
{
\exp_args:Nc \token_get_replacement_spec:N
{
\c_@@_code_root_tl
\@@_remove_spaces:n { #2 / #3 }
}
}
}
}
{ } { }
}
% \end{macrocode}
% \end{macro}
%
% \subsection{Messages}
%
% For when there is a need to complain.
% \begin{macrocode}
\__kernel_msg_new:nnnn { kernel } { boolean-values-only }
{ Key~'#1'~accepts~boolean~values~only. }
{ The~key~'#1'~only~accepts~the~values~'true'~and~'false'. }
\__kernel_msg_new:nnnn { kernel } { key-choice-unknown }
{ Key~'#1'~accepts~only~a~fixed~set~of~choices. }
{
The~key~'#1'~only~accepts~predefined~values,~
and~'#2'~is~not~one~of~these.
}
\__kernel_msg_new:nnnn { kernel } { key-unknown }
{ The~key~'#1'~is~unknown~and~is~being~ignored. }
{
The~module~'#2'~does~not~have~a~key~called~'#1'.\\
Check~that~you~have~spelled~the~key~name~correctly.
}
\__kernel_msg_new:nnnn { kernel } { nested-choice-key }
{ Attempt~to~define~'#1'~as~a~nested~choice~key. }
{
The~key~'#1'~cannot~be~defined~as~a~choice~as~the~parent~key~'#2'~is~
itself~a~choice.
}
\__kernel_msg_new:nnnn { kernel } { value-forbidden }
{ The~key~'#1'~does~not~take~a~value. }
{
The~key~'#1'~should~be~given~without~a~value.\\
The~value~'#2'~was~present:~the~key~will~be~ignored.
}
\__kernel_msg_new:nnnn { kernel } { value-required }
{ The~key~'#1'~requires~a~value. }
{
The~key~'#1'~must~have~a~value.\\
No~value~was~present:~the~key~will~be~ignored.
}
\__kernel_msg_new:nnn { kernel } { show-key }
{
The~key~#1~
\tl_if_empty:nTF {#2}
{ is~undefined. }
{ has~the~properties: #2 . }
}
% \end{macrocode}
%
% \begin{macrocode}
%</initex|package>
% \end{macrocode}
%
%\end{implementation}
%
%\PrintIndex
|