-
Notifications
You must be signed in to change notification settings - Fork 1
/
unravel.dtx
9539 lines (9538 loc) · 319 KB
/
unravel.dtx
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
% \iffalse
%% File: unravel.dtx Copyright (C) 2013, 2015, 2018-2019, 2021, 2024 Bruno Le Floch
%%
%% 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
%%
%% http://www.latex-project.org/lppl.txt
%%
%% -----------------------------------------------------------------------
%
%<*driver>
%\fi
%\iffalse
\documentclass[full]{l3doc}
\usepackage{unravel}
\begin{document}
\DocInput{unravel.dtx}
\end{document}
%</driver>
% \fi
%
% \title{The \textsf{unravel} package: \\
% watching TeX digest tokens\thanks{This
% file has version number 0.3c, last revised 2024/01/05.}}
% \author{Bruno Le Floch}
% \date{2024/01/05}
%
% \maketitle
% \tableofcontents
%
% \begin{documentation}
%
% \section{\pkg{unravel} documentation}
%
% The aim of this \LaTeX{} package is to help debug complicated macros.
% This is done by letting the user step through the execution of some
% \TeX{} code, going through the details of nested expansions,
% performing assignments, as well as some simple typesetting commands.
% To use this package, one should normally run \TeX{} in a terminal.
%
% \subsection{Commands}
%
% \begin{function}{\unravel}
% \begin{syntax}
% \cs{unravel} \oarg{key-value list} \marg{code}
% \end{syntax}
% This command shows in the terminal the steps performed by \TeX{}
% when running the \meta{code}. By default, it pauses to let the
% user read the description of every step: simply press |<return>| to
% proceed. Typing |s|\meta{integer} instead will go forward
% \meta{integer} steps somewhat silently. In the future it will be
% possible to use a negative \meta{integer} to go back a few steps.
% Typing |h| gives a list of various other possibilities.
% The available \meta{key-value} options are described in
% Section~\ref{sec:options}.
% \end{function}
%
% \begin{function}{\unravelsetup}
% \begin{syntax}
% \cs{unravelsetup} \marg{options}
% \end{syntax}
% Sets \meta{options} that apply to all subsequent \cs{unravel}. See
% options in Section~\ref{sec:options}.
% \end{function}
%
% \begin{function}{\unravel:nn}
% \begin{syntax}
% \cs{unravel:nn} \Arg{options} \Arg{code}
% \end{syntax}
% See \cs{unravel}.
% \end{function}
%
% \begin{function}{\unravel_get:nnN}
% \begin{syntax}
% \cs{unravel_get:nnN} \Arg{options} \Arg{code} \meta{tl var}
% \end{syntax}
% Performs \cs{unravel:nn} with the \meta{options} and \meta{code}
% then saves the output into the \meta{tl var}. The option
% |mute| is useful in this case.
% \end{function}
%
% \begin{function}{\unravel_setup:n}
% \begin{syntax}
% \cs{unravel_setup:n} \Arg{options}
% \end{syntax}
% See \cs{unravelsetup}.
% \end{function}
%
% \subsection{Examples}
%
% The \pkg{unravel} package is currently based on the behaviour of
% \pdfTeX{}, but it should work in all engines supported by \pkg{expl3}
% (\pdfTeX{}, \XeTeX{}, \LuaTeX{}, ep\TeX{}, eup\TeX{}) as long as none
% of the primitives specific to those engines is used. Any
% difference between how \pkg{unravel} and (pdf)\TeX{} process a given
% piece of code, unless described in the section~\ref{sec:differences},
% should be reported on the issue tracker
% (\url{https://github.com/blefloch/latex-unravel/issues}).
%
% As a simple example, one can run \LaTeX{} on the following file.
% \begin{verbatim}
% \documentclass{article}
% \usepackage{unravel}
% \unravel
% {
% \title{My title}
% \author{Me}
% \date{\today}
% }
% \begin{document}
% \maketitle
% \end{document}
% \end{verbatim}
%
% A more elaborate example is to understand how \tn{newcommand} works.
% \begin{verbatim}
% \documentclass{article}
% \usepackage{unravel}
% \begin{document}
% \unravel
% {
% \newcommand*{\foo}[1]{bar(#1)}
% \foo{3}
% }
% \end{document}
% \end{verbatim}
%
% The \pkg{unravel} package understands deeply nested expansions as can
% be seen for instance by unravelling functions from \pkg{l3fp}, such as
% with the following code (given the current default settings, this code
% runs for roughly 2000 steps: you can type |s1980| as a response to the
% prompt, then press ``enter'' a few times to see the last few steps of
% expansion).
% \begin{verbatim}
% \documentclass{article}
% \usepackage{unravel}
% \begin{document}
% \ExplSyntaxOn
% \unravel { \fp_eval:n { 3.45 * 2 pi } }
% \ExplSyntaxOff
% \end{document}
% \end{verbatim}
%
% Given all the work that \pkg{unravel} has to do to emulate \TeX{}, it
% is not fast on very large pieces of code. For instance, running it on
% |\documentclass{article}| takes about thirty seconds on my machine, and
% finishes after somewhat less than $21000$ steps.
% \begin{verbatim}
% \RequirePackage{unravel}
% \unravel{\documentclass{article}\relax}
% \usepackage{lipsum}
% \begin{document}
% \lipsum
% \end{document}
% \end{verbatim}
% The \tn{relax} command is needed after |\documentclass{article}|
% because this command tries to look for an optional argument:
% \cs{unravel} would not find any token, and would give up, as \TeX{}
% would if your file ended just after |\documentclass{article}|. After
% running the above through \pdfTeX{}, one can check that the result is
% identical to that without \pkg{unravel}. Note that
% \cs{unravel}|{\usepackage{lipsum}\relax}|, despite taking roughly as many steps
% to complete, is ten times slower, because \tn{newcommand} uses
% delimited arguments, which prevent some optimizations that
% \pkg{unravel} can otherwise obtain. For comparison,
% |\unravel{\lipsum[1-30]}| also takes $20000$ step and is ten times
% faster than loading the package.
%
% \subsection{Options}
% \label{sec:options}
%
% \begin{function}{explicit-prompt}
% Boolean option (default \texttt{false}) determining whether to give
% an explicit prompt. If \texttt{true}, the text ``|Your input=|''
% will appear at the beginning of lines where user input is expected.
% \end{function}
%
% \begin{function}{internal-debug}
% Boolean option (default \texttt{false}) used to debug \pkg{unravel}
% itself.
% \end{function}
%
% \begin{function}{machine}
% Option which takes no value and makes \pkg{unravel} produce an
% output that is somewhat more suitable for automatic processing. In
% particular, it sets |max-action|, |max-output|, |max-input| to very
% large values, and |number-steps| to \texttt{false}.
% \end{function}
%
% \begin{function}{max-action, max-output, max-input}
% Integer options (defaults $50$, $300$, $300$) determining the
% maximum number of characters displayed for the action, the output
% part, and the input part.
% \end{function}
%
% \begin{function}{mute}
% Make none of the steps produce any output, by setting
% |trace-assigns|, |trace-expansion|, |trace-other|, |welcome-message|
% to \texttt{false}. This is only useful with \cs{unravel_get:nnN} or
% when other options change some of these settings.
% \end{function}
%
% \begin{function}{number-steps}
% Boolean option (default \texttt{true}) determining whether to
% number steps.
% \end{function}
%
% \begin{function}{online}
% Integer option (default~$1$) determining where to write the output:
% terminal and log if the option is positive, log only if the option
% is zero, neither if the option is negative.
% \end{function}
%
% \begin{function}{output-file}
% Name of a file where the output is written instead of the log file.
% Setting this option also sets \texttt{online} to zero. If
% \texttt{online} is further modified to be positive then the output
% is written to the terminal as well (hence inevitably to the log
% file), while if it is made negative then the output is written
% nowhere.
% \end{function}
%
% \begin{function}{prompt-input}
% Comma-delimited list option (empty by default) whose items are used
% one by one as if the user typed them at the prompt. Since the
% key-value list is itself comma-delimited, the value here must be
% wrapped in braces. For instance, |prompt-input = {s10, m, u\def}|
% skips $10$ steps, shows the first token's meaning, then continues
% silently until the first token is~|\def|, and any subsequent prompt
% is treated normally with user interaction. This can be useful when
% repeatedly debugging complicated code when the issue is known to lie
% quite late in the code.
%
% As for any |clist|, spaces are discarded around each comma and empty
% entries are removed, then for each item one pair of braces is
% removed (if any is present); to get an empty item use an empty brace
% group, such as in |prompt-input = {s10, {}, x}|. Category codes are
% those in effect when the |prompt-input| option is read.
% \end{function}
%
% \begin{function}{trace-assigns, trace-expansion, trace-other}
% Boolean options (default \texttt{true}) controlling what steps
% produce any output at all. The keys |trace-assigns|,
% |trace-expansion|, |trace-other| control tracing of different types
% of steps.
% \end{function}
%
% \begin{function}{welcome-message}
% Boolean option (default \texttt{true}) determining whether to
% display the welcome message.
% \end{function}
%
% \subsection{Differences between \pkg{unravel} and \TeX{}'s processing}
% \label{sec:differences}
%
% Bugs are listed at \url{https://github.com/blefloch/latex-unravel/issues}.
%
% Differences.
% \begin{itemize}
% \item Kerning between letters of a word is omitted, which can lead to
% incorrect widths.
% \item Some primitives are not implemented yet: alignments
% (\tn{halign}, \tn{valign}, \tn{noalign}, \tn{omit}, \tn{span},
% \tn{cr}, \tn{crcr},~|&|), some math mode primitives, and
% \tn{pdfprimitive}, as well as
% many primitives specific to engines other than \pdfTeX{}.
% This list may sadly be incomplete!
% \item \tn{aftergroup} is only partially implemented.
% \item \tn{everyhbox}, \tn{everyvbox}, \tn{everymath},
% \tn{everydisplay}, \tn{lastkern}, \tn{lastnodetype},
% \tn{lastpenalty}, \tn{lastskip}, \tn{currentifbranch}
% may have wrong values. Perhaps
% \tn{currentgrouplevel} and \tn{currentgrouptype} too.
% \item Setting \tn{globaldefs} to a non-zero value may cause problems.
% \item Tokens passed to \tn{aftergroup} are lost when \pkg{unravel} is
% done.
% \item For \pkg{unravel}, category codes are fixed when a file is read
% using \tn{input},
% while \TeX{} only fixes category codes when the corresponding
% characters are converted to tokens. Similarly, the argument of
% \tn{scantokens} is converted to the new category code regime in
% one go, and the result must be balanced.
% \item Explicit begin-group and end-group characters other than the
% usual left and right braces may make \pkg{unravel} choke, or may be
% silently replaced by the usual left and right braces.
% \item \tn{endinput} is ignored with a warning, as it is very difficult
% to implement it in a way similar to \TeX{}'s, and as it is most
% often used at the very end of files, in a redundant way.
% \item \tn{outer} is not supported.
% \item \cs{unravel} cannot be nested.
% \item Control sequences of the form \cs{notexpanded:\ldots{}} are
% reserved for use by \pkg{unravel}.
% \end{itemize}
%
% \subsection{Future perhaps}
%
% \begin{itemize}
% \item Use the |file-error| fatal error message: first implement
% \cs{@@_file_if_exist:nTF} and use it to determine whether
% \tn{input} will throw a fatal error in \tn{batchmode} and
% \tn{nonstopmode}.
% \item Use the |interwoven-preambles| fatal error message once
% alignments are implemented.
% \item Find out why so many input levels are used (see the log of the
% |unravel003| testfile for instance)
% \end{itemize}
%
% \end{documentation}
%
% \begin{implementation}
%
% \section{\pkg{unravel} implementation}
%
% Some support packages are loaded first, then we declare the package's
% name, date, version, and purpose.
%
% \begin{macrocode}
%<*package>
% \end{macrocode}
%
% \begin{macrocode}
%<@@=unravel>
% \end{macrocode}
%
% Catcode settings. In a group, set |\c| to be a synonym of |\catcode|
% for short, set the catcode of space to be 10 (using |\fam| to avoid
% needing a space or an equal sign to separate the two integer
% arguments of |\catcode|) and that of |%| to be 14 (using |\fam| again
% to avoid needing the digit 7 to have catcode other: we need the digit
% 5 anyway in two steps). Then make |-|, |6|, |7|, |8|, |9| other (we
% must assume that |0| through |5| are already other), and make |:|,
% |_|, |h|, |j|, |k|, |q|, |s|, |w|, |x|, |y|, |z| letters (other
% lowercase letters already need to be letters in the rest of the
% code). Make sure there is no |\endlinechar|. We are finally ready
% to safely test whether the package has already been loaded and bail
% out in case it has. Expanding |\fi| before ending the group ensures
% that the whole line has been read by \TeX{} before restoring earlier
% catcodes.
% \begin{macrocode}
\begingroup\let\c\catcode\fam32\c\fam10\advance\fam5\c\fam14\c45 12 %
\c54 12\c55 12\c56 12\c57 12\c58 11\c95 11\c104 11\c106 11\c107 11 %
\c113 11\c115 11\c119 11\c120 11\c121 11\c122 11\endlinechar-1 %
\expandafter\ifx\csname unravel\endcsname\relax
\else\endinput\expandafter\endgroup\fi
% \end{macrocode}
%
% Set |T| and |X| to be letters for an error message. Set up braces
% and |#| for definitions, |=| for nicer character code assignments,
% |>| for integer comparison, |+| for integer expressions.
% \begin{macrocode}
\c84 11\c88 11\c35 6\c123 1\c125 2\c62 12\c61 12\c43 12 %
% \end{macrocode}
%
% If \eTeX{}'s \tn{numexpr} or \tn{protected} are not available, bail
% out with an error.
% \begin{macrocode}
\expandafter\ifx\csname numexpr\endcsname\relax
\errmessage{unravel requires \numexpr from eTeX}
\endinput\expandafter\endgroup\fi
\expandafter\ifx\csname protected\endcsname\relax
\errmessage{unravel requires \protected from eTeX}
\endinput\expandafter\endgroup\fi
% \end{macrocode}
%
% If \pkg{unravel} is loaded within a group, bail out because
% \pkg{expl3} would not be loaded properly.
% \begin{macrocode}
\expandafter\ifx\csname currentgrouplevel\endcsname\relax\else
\ifnum\currentgrouplevel>1 \errmessage{unravel loaded in a group}
\endinput\expandafter\expandafter\expandafter\endgroup\fi\fi
% \end{macrocode}
%
% Make spaces ignored and make |~| a space, to prettify code.
% \begin{macrocode}
\catcode 32 = 9 \relax
\catcode 126 = 10 \relax
% \end{macrocode}
%
% \begin{variable}{\l_@@_setup_restore_tl}
% This token list variable will contain code to restore category
% codes to their value when the package was loaded.
% \begin{macrocode}
\gdef \l_@@_setup_restore_tl { }
% \end{macrocode}
% \end{variable}
%
% \begin{macro}{\@@_setup_restore:}
% Use the token list to restore catcodes to their former values, then
% empty the list since there is no catcode to restore anymore. This
% mechanism cannot be nested.
% \begin{macrocode}
\protected \gdef \@@_setup_restore:
{
\l_@@_setup_restore_tl
\def \l_@@_setup_restore_tl { }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_setup_save:}
% \begin{macro}[EXP]{\@@_setup_save_aux:n}
% This saves into \cs{l_@@_setup_restore_tl} the current catcodes
% (from $0$ to $255$ only), \tn{endlinechar}, \tn{escapechar},
% \tn{newlinechar}.
% \begin{macrocode}
\protected \gdef \@@_setup_save:
{
\edef \l_@@_setup_restore_tl
{
\@@_setup_save_aux:w 0 =
\endlinechar = \the \endlinechar
\escapechar = \the \escapechar
\newlinechar = \the \newlinechar
\relax
}
}
\long \gdef \@@_setup_save_aux:w #1 =
{
\catcode #1 = \the \catcode #1 ~
\ifnum 255 > #1 ~
\expandafter \@@_setup_save_aux:w
\the \numexpr #1 + 1 \expandafter =
\fi
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_setup_catcodes:nnn}
% This sets all characters from |#1| to |#2| (inclusive) to have
% catcode |#3|.
% \begin{macrocode}
\protected \long \gdef \@@_setup_catcodes:nnn #1 #2 #3
{
\ifnum #1 > #2 ~ \else
\catcode #1 = #3 ~
\expandafter \@@_setup_catcodes:nnn \expandafter
{ \the \numexpr #1 + 1 } {#2} {#3}
\fi
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_setup_latexe:}
% This saves the catcodes and related parameters, then sets them to
% the value they normally have in a \LaTeXe{} package (in particular,
% |@| is a letter).
% \begin{macrocode}
\protected \gdef \@@_setup_latexe:
{
\@@_setup_save:
\@@_setup_catcodes:nnn {0} {8} {15}
\catcode 9 = 10 ~
\catcode 10 = 12 ~
\catcode 11 = 15 ~
\catcode 12 = 13 ~
\catcode 13 = 5 ~
\@@_setup_catcodes:nnn {14} {31} {15}
\catcode 32 = 10 ~
\catcode 33 = 12 ~
\catcode 34 = 12 ~
\catcode 35 = 6 ~
\catcode 36 = 3 ~
\catcode 37 = 14 ~
\catcode 38 = 4 ~
\@@_setup_catcodes:nnn {39} {63} {12}
\@@_setup_catcodes:nnn {64} {90} {11}
\catcode 91 = 12 ~
\catcode 92 = 0 ~
\catcode 93 = 12 ~
\catcode 94 = 7 ~
\catcode 95 = 8 ~
\catcode 96 = 12 ~
\@@_setup_catcodes:nnn {97} {122} {11}
\catcode 123 = 1 ~
\catcode 124 = 12 ~
\catcode 125 = 2 ~
\catcode 126 = 13 ~
\catcode 127 = 15 ~
\@@_setup_catcodes:nnn {128} {255} {12}
\endlinechar = 13 ~
\escapechar = 92 ~
\newlinechar = 10 ~
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_setup_unravel:}
% Catcodes for \pkg{unravel} (in particular, |@| is other, |:| and
% |_| are letters, spaces are ignored, |~| is a space).
% \begin{macrocode}
\protected \gdef \@@_setup_unravel:
{
\@@_setup_save:
\@@_setup_catcodes:nnn {0} {8} {15}
\catcode 9 = 9 ~
\catcode 10 = 12 ~
\catcode 11 = 15 ~
\catcode 12 = 13 ~
\catcode 13 = 5 ~
\@@_setup_catcodes:nnn {14} {31} {15}
\catcode 32 = 9 ~
\catcode 33 = 12 ~
\catcode 34 = 12 ~
\catcode 35 = 6 ~
\catcode 36 = 3 ~
\catcode 37 = 14 ~
\catcode 38 = 4 ~
\@@_setup_catcodes:nnn {39} {57} {12}
\catcode 58 = 11 ~
\@@_setup_catcodes:nnn {59} {64} {12}
\@@_setup_catcodes:nnn {65} {90} {11}
\catcode 91 = 12 ~
\catcode 92 = 0 ~
\catcode 93 = 12 ~
\catcode 94 = 7 ~
\catcode 95 = 11 ~
\catcode 96 = 12 ~
\@@_setup_catcodes:nnn {97} {122} {11}
\catcode 123 = 1 ~
\catcode 124 = 12 ~
\catcode 125 = 2 ~
\catcode 126 = 10 ~
\catcode 127 = 15 ~
\@@_setup_catcodes:nnn {128} {255} {12}
\escapechar = 92 ~
\endlinechar = 32 ~
\newlinechar = 10 ~
}
% \end{macrocode}
% \end{macro}
%
% End the group where all catcodes where changed, but expand
% \cs{@@_setup_latexe:} to sanitize catcodes again outside the
% group. The catcodes are saved.
% \begin{macrocode}
\expandafter \endgroup \@@_setup_latexe:
% \end{macrocode}
%
% Load the \pkg{gtl} dependency.
% \begin{macrocode}
\RequirePackage{gtl}[2024/01/04]
% \end{macrocode}
%
% Before loading \pkg{unravel}, restore catcodes, so that the implicit
% \cs{ExplSyntaxOn} in \cs{ProvidesExplPackage} picks up the correct
% catcodes to restore when \cs{ExplSyntaxOff} is run at the end of the
% package. The place where catcodes are restored are beyond
% \pkg{unravel}'s reach, which is why we cannot bypass \pkg{expl3} and
% simply restore the catcodes once everything is done. To avoid issues
% with crazy catcodes, make \TeX{} read the arguments of
% \cs{ProvidesExplPackage} before restoring catcodes. Then immediately
% go to the catcodes we want.
% \begin{macrocode}
\csname use:n\endcsname
{%
\csname @@_setup_restore:\endcsname
\ProvidesExplPackage
{unravel} {2024/01/05} {0.3c} {Watching TeX digest tokens}%
\csname @@_setup_unravel:\endcsname
}%
% \end{macrocode}
%
% \subsection{Primitives, variants, and helpers}
%
% \subsubsection{Adjustments to \pkg{expl3}}
%
% In upcoming versions of \pkg{expl3}, the \cs{group_align_safe_begin:}
% and \cs{group_align_safe_end:} commands may involve an explicit
% end-group character token with non-standard character code, which
% would wrongly be normalized by \pkg{gtl} (used by \pkg{unravel}),
% hence break. To avoid this we change here the definitions slightly.
% \begin{macrocode}
\cs_gset:Npn \group_align_safe_begin:
{ \exp:w \if_false: { \fi: -`} \exp_stop_f: }
\cs_gset:Npn \group_align_safe_end:
{ \if_int_compare:w `{ = \c_zero_int } \fi: }
% \end{macrocode}
%
% \subsubsection{Renamed primitives}
%
% \begin{macro}
% {
% \@@_currentgrouptype:, \@@_everyeof:w, \@@_everypar:w,
% \@@_set_escapechar:n, \@@_nullfont:,
% \@@_hbox:w, \@@_the:w,
% }
% Copy primitives which are used multiple times, to avoid littering
% the code with |:D| commands. Primitives are left as |:D| in the
% code when that is clearer (typically when testing the meaning of
% a token against that of a primitive).
% \begin{macrocode}
\cs_new_eq:NN \@@_currentgrouptype: \tex_currentgrouptype:D
\cs_new_protected:Npn \@@_set_escapechar:n
{ \int_set:Nn \tex_escapechar:D }
\cs_new_eq:NN \@@_everyeof:w \tex_everyeof:D
\cs_new_eq:NN \@@_everypar:w \tex_everypar:D
\cs_new_eq:NN \@@_hbox:w \tex_hbox:D
\cs_new_eq:NN \@@_mag: \tex_mag:D
\cs_new_eq:NN \@@_nullfont: \tex_nullfont:D
\cs_new_eq:NN \@@_the:w \tex_the:D
\cs_new_eq:NN \@@_number:w \tex_number:D
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_special_relax:}
% A special marker slightly different from \tn{relax} (its
% \tn{meaning} is \tn{relax} but it differs from \tn{relax} according
% to \tn{ifx}). In the right-hand side of our assignment,
% \cs{@@_special_relax:} could be replaced by any other expandable
% command.
% \begin{macrocode}
\exp_after:wN \cs_new_eq:NN
\exp_after:wN \@@_special_relax:
\exp_not:N \@@_special_relax:
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\c_@@_prompt_ior, \c_@@_noprompt_ior}
% These are not quite primitives, but are very low-level
% |ior| streams to prompt the user explicitly or not.
% \begin{macrocode}
\int_const:Nn \c_@@_prompt_ior { 16 }
\int_const:Nn \c_@@_noprompt_ior { -1 }
% \end{macrocode}
% \end{macro}
%
% \subsubsection{Variants}
%
% Variants that we need.
% \begin{macrocode}
\cs_generate_variant:Nn \seq_push:Nn { Nf }
\cs_generate_variant:Nn \str_head:n { f }
\cs_generate_variant:Nn \tl_to_str:n { o }
\cs_generate_variant:Nn \tl_if_eq:nnTF { o }
\cs_generate_variant:Nn \tl_if_head_eq_meaning:nNT { V }
\cs_generate_variant:Nn \tl_if_head_eq_meaning:nNTF { V }
\cs_generate_variant:Nn \tl_if_single_token:nT { V }
\cs_generate_variant:Nn \gtl_gput_right:Nn { NV }
\cs_generate_variant:Nn \gtl_if_empty:NTF { c }
\cs_generate_variant:Nn \gtl_if_tl:NT { c }
\cs_generate_variant:Nn \gtl_to_str:N { c }
\cs_generate_variant:Nn \gtl_gpop_left:NN { c }
\cs_generate_variant:Nn \gtl_get_left:NN { c }
\cs_generate_variant:Nn \gtl_gset:Nn { c }
\cs_generate_variant:Nn \gtl_gconcat:NNN { ccc , cNc }
\cs_generate_variant:Nn \gtl_gclear:N { c }
\cs_generate_variant:Nn \gtl_gclear_new:N { c }
\cs_generate_variant:Nn \gtl_left_tl:N { c }
% \end{macrocode}
%
% \begin{macro}{\@@_tl_if_in:ooTF}
% Analogue of \cs{tl_if_in:ooTF} but with an extra group because that
% function redefines an auxiliary that may appear in the code being
% debugged (see Github issue |#27|).
% \begin{macrocode}
\cs_new_protected:Npn \@@_tl_if_in:ooTF #1#2#3#4
{
\group_begin:
\exp_args:Noo \tl_if_in:nnTF {#1} {#2}
{ \group_end: #3 } { \group_end: #4 }
}
% \end{macrocode}
% \end{macro}
%
% \subsubsection{Miscellanous helpers}
%
% \begin{macro}{\@@_tmp:w}
% Temporary function used to define other functions.
% \begin{macrocode}
\cs_new_protected:Npn \@@_tmp:w { }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_file_get:nN}
% \begin{macro}{\@@_file_get_aux:wN}
% \begin{macrocode}
\cs_set_protected:Npn \@@_tmp:w #1
{
\cs_new_protected:Npn \@@_file_get:nN ##1##2
{
\group_begin:
\@@_everyeof:w { #1 ##2 }
\exp_after:wN \@@_file_get_aux:wN
\exp_after:wN \prg_do_nothing:
\tex_input:D ##1 \scan_stop:
}
\cs_new_protected:Npn \@@_file_get_aux:wN ##1 #1 ##2
{
\group_end:
\tl_set:Ne ##2
{ \exp_not:o {##1} \exp_not:V \@@_everyeof:w }
}
}
\exp_args:No \@@_tmp:w { \token_to_str:N : : }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_tl_first_int:N}
% \begin{macro}[EXP]{\@@_tl_first_int_aux:Nn}
% Function that finds an explicit number in a token list. This is
% used for instance when implementing \tn{read}, to find the stream
% \meta{number} within the whole \tn{read} \meta{number} |to|
% \meta{cs} construction. The auxiliary initially has itself as a
% first argument, and once a first digit is found it has
% \cs{use_none_delimit_by_q_stop:w}. That first argument is used
% whenever what follows is not a digit, hence initially we loop,
% while after the first digit is found any non-digit stops the
% recursion. If no integer is found, $0$ is left in the token list.
% The surrounding \cs{int_eval:n} lets us dump digits in the input
% stream while keeping the function fully expandable.
% \begin{macrocode}
\cs_new:Npn \@@_tl_first_int:N #1
{
\int_eval:n
{
\exp_after:wN \@@_tl_first_int_aux:Nn
\exp_after:wN \@@_tl_first_int_aux:Nn
#1 ? 0 ? \q_stop
}
}
\cs_new:Npn \@@_tl_first_int_aux:Nn #1#2
{
\tl_if_single:nT {#2}
{
\token_if_eq_catcode:NNT + #2
{
\if_int_compare:w 1 < 1 #2 \exp_stop_f:
#2
\exp_after:wN \use_i_ii:nnn
\exp_after:wN \@@_tl_first_int_aux:Nn
\exp_after:wN \use_none_delimit_by_q_stop:w
\fi:
}
}
#1
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_use_ii_i:nn}
% \begin{macrocode}
\cs_new:Npn \@@_use_ii_i:nn #1#2 { #2 #1 }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_prompt_input:Nn}
% \begin{macro}[rEXP]{\@@_prompt_input:w}
% \begin{macro}[EXP]{\@@_prompt_input_aux:w, \@@_use_none_delimit_by_q_recursion_tail:w}
% \begin{variable}{\q_@@_recursion_tail}
% \begin{macrocode}
\cs_new_protected:Npn \@@_prompt_input:Nn #1#2
{
\clist_gset:Ne #1
{ \@@_prompt_input:w \prg_do_nothing: #2 , \q_@@_recursion_tail , }
}
\cs_new:Npn \@@_prompt_input:w #1 ,
{
\tl_trim_spaces_apply:oN {#1} \@@_use_ii_i:nn
\@@_prompt_input_aux:w ,
}
\cs_new:Npn \@@_prompt_input_aux:w #1 ,
{
\@@_use_none_delimit_by_q_recursion_tail:w #1
\use_none:nnnnn \q_@@_recursion_tail
{ \tl_to_str:n {#1} } ,
\@@_prompt_input:w \prg_do_nothing:
}
\cs_new:Npn \@@_use_none_delimit_by_q_recursion_tail:w
#1 \q_@@_recursion_tail { }
\quark_new:N \q_@@_recursion_tail
% \end{macrocode}
% \end{variable}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \subsubsection{String helpers}
%
% \begin{macro}{\@@_strip_escape:w}
% \begin{macro}{\@@_strip_escape_aux:N, \@@_strip_escape_aux:w}
% This is based on the 2013-07-19 (and earlier) version of
% \cs{cs_to_str:N}. There are three cases. If the escape character
% is printable, the charcode test is false, and
% \cs{@@_strip_escape_aux:N} removes one character. If the escape
% character is a space, the charcode test is true, and if there is no
% escape charcter, the test is unfinished after |\token_to_str:N \ |.
% In both of those cases, \cs{@@_strip_escape_aux:w} inserts
% |-\@@_number:w \fi: \c_zero_int|. If the escape character was a
% space, the test was true, and \cs{int_value:w} converts
% \cs{c_zero_int} to~|0|, hence the leading roman numeral expansion
% removes a space from what follows (it is important that what follows
% cannot start with a digit). Otherwise, the test takes~|-| as its
% second operand, is false, and the roman numeral expansion only sees
% \cs{c_zero_int}, thus does not remove anything from what follows.
% \begin{macrocode}
\cs_new:Npn \@@_strip_escape:w
{
\tex_romannumeral:D
\if_charcode:w \token_to_str:N \ \@@_strip_escape_aux:w \fi:
\@@_strip_escape_aux:N
}
\cs_new:Npn \@@_strip_escape_aux:N #1 { \c_zero_int }
\cs_new:Npn \@@_strip_escape_aux:w #1#2
{ - \@@_number:w #1 \c_zero_int }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_to_str:Nn}
% Use the type-appropriate conversion to string.
% \begin{macrocode}
\cs_new:Npn \@@_to_str:Nn #1
{
\if_meaning:w T #1
\exp_after:wN \tl_to_str:n
\else:
\exp_after:wN \gtl_to_str:n
\fi:
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_str_truncate_left:nn}
% \begin{macro}{\@@_str_truncate_left_aux:nnn}
% Truncate the string |#1| to a maximum of |#2| characters. If it is
% longer, replace some characters on the left of the string by
% |(123~more~chars)~| with the appropriate number instead of~|123|.
% In any reasonable case, $25$ is big enough to fit this extra text.
% \begin{macrocode}
\cs_new:Npn \@@_str_truncate_left:nn #1#2
{
\exp_args:Nf \@@_str_truncate_left_aux:nnn
{ \str_count:n {#1} } {#1} {#2}
}
\cs_new:Npn \@@_str_truncate_left_aux:nnn #1#2#3
{
\int_compare:nNnTF {#1} > {#3}
{
( \int_eval:n { #1 - #3 + 25 } ~ more~chars ) ~
\str_range:nnn {#2} { #1 - #3 + 26 } {#1}
}
{ \tl_to_str:n {#2} }
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\@@_str_truncate_right:nn}
% \begin{macro}{\@@_str_truncate_right_aux:nnn}
% Truncate the string |#1| to a maximum of |#2| characters. If it is
% longer, replace some characters on the right of the string by
% |~(123~more~chars)| with the appropriate number instead of~|123|.
% In any reasonable case, $25$ is big enough to fit this extra text.
% \begin{macrocode}
\cs_new:Npn \@@_str_truncate_right:nn #1#2
{
\exp_args:Nf \@@_str_truncate_right_aux:nnn
{ \str_count:n {#1} } {#1} {#2}
}
\cs_new:Npn \@@_str_truncate_right_aux:nnn #1#2#3
{
\int_compare:nNnTF {#1} > {#3}
{
\str_range:nnn {#2} { 1 } { #3 - 25 } ~
( \int_eval:n { #1 - #3 + 25 } ~ more~chars )
}
{ \tl_to_str:n {#2} }
}
% \end{macrocode}
% \end{macro}
% \end{macro}
%
% \subsubsection{Helpers for control flow}
%
% \begin{macro}[EXP]{\@@_exit:w, \@@_exit_hard:w, \@@_exit_point:}
% Jump to the very end of this instance of \cs{unravel}.
% \begin{macrocode}
\cs_new_eq:NN \@@_exit_point: \prg_do_nothing:
\cs_new:Npn \@@_exit:w #1 \@@_exit_point: { }
\cs_new:Npn \@@_exit_hard:w #1 \@@_exit_point: #2 \@@_exit_point: { }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[EXP]{\@@_break:w, \@@_break_point:}
% Useful to jump out of complicated conditionals.
% \begin{macrocode}
\cs_new_eq:NN \@@_break_point: \prg_do_nothing:
\cs_new:Npn \@@_break:w #1 \@@_break_point: { }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_cmd_if_internal:TF}
% Test whether the \cs{l_@@_head_cmd_int} denotes an ``internal''
% command, between |min_internal| and |max_internal| (see
% Section~\ref{sec:numeric-codes}).
% \begin{macrocode}
\prg_new_conditional:Npnn \@@_cmd_if_internal: { TF }
{
\int_compare:nNnTF
\l_@@_head_cmd_int < { \@@_tex_use:n { min_internal } }
{ \prg_return_false: }
{
\int_compare:nNnTF
\l_@@_head_cmd_int
> { \@@_tex_use:n { max_internal } }
{ \prg_return_false: }
{ \prg_return_true: }
}
}
% \end{macrocode}
% \end{macro}
%
% \subsubsection{Helpers concerning tokens}
%
% \begin{macro}{\@@_active_do:nn}
% Apply some code to an active character token constructed from its
% character code.
% \begin{macrocode}
\cs_new_protected:Npn \@@_active_do:nn #1#2
{
\group_begin:
\char_set_active_eq:nN {#1} \scan_stop:
\use:e
{
\group_end:
\exp_not:n {#2} { \char_generate:nn {#1} { 13 } }
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_token_to_char:N}
% \begin{macro}{\@@_meaning_to_char:n, \@@_meaning_to_char:o}
% \begin{macro}
% {\@@_meaning_to_char_auxi:w, \@@_meaning_to_char_auxii:w}
% From the meaning of a character token (with arbitrary character
% code, except active), extract the character itself (with string
% category codes). This is somewhat robust against wrong input.
% \begin{macrocode}
\cs_new:Npn \@@_meaning_to_char:n #1
{ \@@_meaning_to_char_auxi:w #1 \q_mark ~ {} ~ \q_mark \q_stop }
\cs_new:Npn \@@_meaning_to_char_auxi:w #1 ~ #2 ~ #3 \q_mark #4 \q_stop
{ \@@_meaning_to_char_auxii:w #3 ~ #3 ~ \q_stop }
\cs_new:Npn \@@_meaning_to_char_auxii:w #1 ~ #2 ~ #3 \q_stop
{ \tl_if_empty:nTF {#2} { ~ } {#2} }
\cs_generate_variant:Nn \@@_meaning_to_char:n { o }
\cs_new:Npn \@@_token_to_char:N #1
{ \@@_meaning_to_char:o { \token_to_meaning:N #1 } }
% \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}[EXP,pTF]{\@@_token_if_expandable:N}
% We need to cook up our own version of \cs{token_if_expandable:NTF}
% because the \pkg{expl3} one does not think that |undefined| is
% expandable.
% \begin{macrocode}
\prg_new_conditional:Npnn \@@_token_if_expandable:N #1
{ p , T , F , TF }
{
\exp_after:wN \if_meaning:w \exp_not:N #1 #1
\prg_return_false:
\else:
\prg_return_true:
\fi:
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[EXP,pTF]{\@@_token_if_protected:N}
% Returns \texttt{true} if the token is either not expandable or is a
% protected macro.
% \begin{macrocode}
\prg_new_conditional:Npnn \@@_token_if_protected:N #1
{ p , T , F , TF }
{
\@@_token_if_expandable:NTF #1
{
\token_if_protected_macro:NTF #1
{ \prg_return_true: }
{
\token_if_protected_long_macro:NTF #1
{ \prg_return_true: }
{ \prg_return_false: }
}
}
{ \prg_return_true: }
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[TF]{\@@_token_if_active_char:N}
% Lowercase the token after setting its \tn{lccode} (more precisely
% the \tn{lccode} of the first character in its string representation)