summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/etoolbox/etoolbox.tex
blob: 1e88f17e6f12dfdd5206de617e4a81596820af19 (plain)
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
% $Id: etoolbox.tex,v 1.5 2008/04/26 18:23:00 lehman stable $
%
% This is the source of etoolbox.pdf. This file is primarily included
% in the distribution for legal reasons. It will not compile as is
% because it depends on unpublished classes and packages.
%
\documentclass{latexdoc}
\usepackage[latin9]{inputenc}
\usepackage[american]{babel}
\usepackage[strict,babel=once]{csquotes}
\usepackage{shortvrb}
\MakeAutoQuote{«}{»}
\MakeAutoQuote*{<}{>}
\MakeShortVerb{\|}

\rcsid{$Id: etoolbox.tex,v 1.5 2008/04/26 18:23:00 lehman stable $}

\titlepage{%
  title={The \sty{etoolbox} package},
  subtitle={An \etex toolbox for class and package authors},
  url={http://www.ctan.org/tex-archive/macros/latex/contrib/etoolbox/},
  author={Philipp Lehman},
  email={plehman@gmx.net},
  revision={\rcsrevision},
  date={\rcstoday}}

\hypersetup{%
  pdftitle={The etoolbox package},
  pdfsubject={An e-TeX toolbox for class and package authors},
  pdfauthor={Philipp Lehman},
  pdfkeywords={tex, e-tex, latex, class, package, programming}}

\begin{document}

\printtitlepage
\tableofcontents

\section{Introduction}
\label{int}

\subsection{About}

The \sty{etoolbox} package is a toolbox of programming facilities geared primarily towards \latex class and package authors. It provides \latex frontends to some of the new primitives provided by \etex as well as some generic tools which are not related to \etex but match the profile of this package. The package is work in progress. Note that the initial versions of this package were released under the name \sty{elatex}.

\subsection{License}

Copyright \textcopyright\ 2007--2008 Philipp Lehman. Permission is granted to copy, distribute and\slash or modify this software under the terms of the \lppl, version 1.3.\fnurl{http://www.ctan.org/tex-archive/macros/latex/base/lppl.txt} This package is author"=maintained.

\subsection[Feedback]{Feedback and contributions}

I started to work on this package when I found myself implementing the same tools and shorthands I had employed in previous \latex packages for yet another package. For the most part, the facilities provided by \sty{etoolbox} address my needs as a package author and future development is likely to be guided by these needs as well. Please note that I will not be able to address any feature requests. However, I am open to contributions by other class and package authors, provided that the contributed code is sufficiently generic, matches the profile of this package, and may be added to the package without requiring significant adaption.

\subsection{Acknowledgments}

The \ltxcmd{ifblank} test of this package is based on code by Donald Arseneau.

\section{User commands}
\label{use}

The facilities in this section are geared towards regular users as well as class and package authors.

\subsection{Definitions}
\label{use:def}

\begin{ltxsyntax}

\cmd{newrobustcmd}{command}[arguments][optarg default]{replacement text}
\cmd*{newrobustcmd*}{command}[arguments][optarg default]{replacement text}

The syntax and behavior of this command is similar to \ltxcmd{newcommand} except that the newly defined \ltxarg{command} will be robust. This command differs from the \ltxcmd{DeclareRobustCommand} command from the \latex kernel in that it issues an error rather than just an informational message if the \ltxarg{command} is already defined. Since it uses \etex's low-level protection mechanism rather than the corresponding higher-level \latex facilities, it also does not require an additional macro to implement the <robustness>. This command itself is also robust.

\cmd{renewrobustcmd}{command}[arguments][optarg default]{replacement text}
\cmd*{renewrobustcmd*}{command}[arguments][optarg default]{replacement text}

The syntax and behavior of this command is similar to \ltxcmd{renewcommand} except that the redefined \ltxarg{command} will be robust. This command itself is also robust.

\cmd{providerobustcmd}{command}[arguments][optarg default]{replacement text}
\cmd*{providerobustcmd*}{command}[arguments][optarg default]{replacement text}

The syntax and behavior of this command is similar to \ltxcmd{providecommand} except that a newly defined \ltxarg{command} will be robust. Note that this command only provides a robust definition if the \ltxarg{command} is undefined. It will not make an already defined \ltxarg{command} robust. This command itself is robust.

\end{ltxsyntax}

\subsection{Patching}
\label{use:pat}

\begin{ltxsyntax}

\cmd{robustify}{command}

Modifies an already defined \ltxarg{command} such that it is robust without altering its parameters, its prefixes, or its replacement text. If the \ltxarg{command} has been defined with \ltxcmd{DeclareRobustCommand}, this will be detected automatically. \latex's high-level protection mechanism will be replaced by the corresponding low-level \etex facility in this case. This command is robust and may only be used in the document preamble.

\end{ltxsyntax}

\subsection[Lengths and counters]{Length and counter assignments}
\label{use:cal}

The facilities in this section are replacements for \ltxcmd{setcounter} and \ltxcmd{setlength} which support arithmetic expressions.

\begin{ltxsyntax}

\cmd{defcounter}{counter}{integer expression}

Assigns a value to a \latex \ltxarg{counter} previously initialized with \ltxcmd{newcounter}. This command is similar in concept and syntax to \ltxcmd{setcounter} except for two major differences. 1) The second argument may be an \ltxarg{integer expression} which will be processed with \ltxcmd{numexpr}. The \ltxarg{integer expression} may be any arbitrary code which is valid in this context. The value assigned to the \ltxarg{counter} will be the result of that calculation. 2) In contrast to \ltxcmd{setcounter}, the assignment is local by default but \ltxcmd{defcounter} may be prefixed with \ltxcmd{global}. The functional equivalent of \ltxcmd{setcounter} would be |\global\defcounter|.

\cmd{deflength}{length}{dimen expression}

Assigns a value to a \ltxarg{length} register previously initialized with \ltxcmd{newlength}. This command is similar in concept and syntax to \ltxcmd{setlength} except that the second argument may be a \ltxarg{dimen expression} which will be processed with \ltxcmd{dimexpr}. The \ltxarg{dimen expression} may be any arbitrary code which is valid in this context. The value assigned to the \ltxarg{length} register will be the result of that calculation. The assignment is local by default but \ltxcmd{deflength} may be prefixed with \ltxcmd{global}. This command may be used as a drop-in replacement for \ltxcmd{setlength}.

\end{ltxsyntax}

\subsection[Predefined hooks]{Predefined all-purpose hooks}
\label{use:pre}

\latex provides two hooks which defer the execution of code either to the beginning or the end of the document body. The \ltxcmd{AtBeginDocument} code is executed at the beginning of the document body, \emph{after} the main \file{aux} file has been read for the first time. The \ltxcmd{AtEndDocument} code is executed at the end of the document body, \emph{before} the main \file{aux} file is read for the second time. The hooks introduced here are similar in concept but defer the execution of their \ltxarg{code} argument to slightly different locations. The \ltxarg{code} may be arbitrary \tex code. Macro parameter characters in the \ltxarg{code} argument need not be doubled.

\begin{ltxsyntax}

\cmd{AtEndPreamble}{code}

This hook differs from \ltxcmd{AtBeginDocument} in that the \ltxarg{code} is executed right at the end of the preamble, before the main \file{aux} file (as written during the previous \latex pass) is read and prior to any \ltxcmd{AtBeginDocument} code. It is sometimes desirable to defer code to the end of the preamble because all requested packages have been loaded at this point. Code deferred with \ltxcmd{AtBeginDocument}, however, is executed too late if it is required in the \file{aux} file.

\cmd{AfterEndDocument}{code}

This hook differs from \ltxcmd{AtEndDocument} in that the \ltxarg{code} is executed at the very end of the document, after the main \file{aux} file (as written during the current \latex pass) has been read and after any \ltxcmd{AtEndDocument} code. This hook is useful if a package needs to evaluate any data in the \file{aux} file at the end of a \latex run.

\cmd{AfterPreamble}{code}

This hook is a variant of \ltxcmd{AtBeginDocument} which may be used in both the preamble and the document body. When used in the preamble, it behaves exactely like \ltxcmd{AtBeginDocument}. When used in the document body, it immediately executes its \ltxarg{code} argument (\ltxcmd{AtBeginDocument} issues an error in this case).

\end{ltxsyntax}

\section{Author commands}

The facilities in this section are geared towards class and package authors.

%\addtocontents{toc}{\protect\columnbreak}

\subsection{Definitions}

\subsubsection{Macro definitions}
\label{aut:def:def}

The facilities in this section are simple but frequently required shorthands which extend the scope of the \ltxcmd{@namedef} and \ltxcmd{@nameuse} macros from the \latex kernel.

\begin{ltxsyntax}

\cmd{csdef}{csname}<arguments>{replacement text}

Similar to the \tex primitive \ltxcmd{def} except that it takes a control sequence name as its first argument. This command is robust and corresponds to \ltxcmd{@namedef}.

\cmd{csgdef}{csname}<arguments>{replacement text}

Similar to the \tex primitive \ltxcmd{gdef} except that it takes a control sequence name as its first argument. This command is robust.

\cmd{csedef}{csname}<arguments>{replacement text}

Similar to the \tex primitive \ltxcmd{edef} except that it takes a control sequence name as its first argument. This command is robust.

\cmd{csxdef}{csname}<arguments>{replacement text}

Similar to the \tex primitive \ltxcmd{xdef} except that it takes a control sequence name as its first argument. This command is robust.

\cmd{protected@csedef}{csname}<arguments>{replacement text}

Similar to \ltxcmd{csedef} except that \latex's protection mechanism is temporarily enabled. To put it in other words: this command is similar to the \latex kernel command \ltxcmd{protected@edef} except that it takes a control sequence name as its first argument. This command is robust.

\cmd{protected@csxdef}{csname}<arguments>{replacement text}

Similar to \ltxcmd{csxdef} except that \latex's protection mechanism is temporarily enabled. To put it in other words: this command is similar to the \latex kernel command \ltxcmd{protected@xdef} except that it takes a control sequence name as its first argument. This command is robust.

\cmd{cslet}{csname}{command}

Similar to the \tex primitive \ltxcmd{let} except that the first argument is a control sequence name. This command is robust and may be prefixed with \ltxcmd{global}.

\cmd{letcs}{command}{csname}

Similar to the \tex primitive \ltxcmd{let} except that the second argument is a control sequence name. This command is robust and may be prefixed with \ltxcmd{global}.

\cmd{csletcs}{csname}{csname}

Similar to the \tex primitive \ltxcmd{let} except that both arguments are control sequence names. This command is robust and may be prefixed with \ltxcmd{global}.

\cmd{csuse}{csname}

Takes a control sequence name as its argument and forms a control sequence token. This command differs from the \ltxcmd{@nameuse} macro from the \latex kernel in that it expands to an empty string if the control sequence is undefined.

\cmd{undef}<command>

Clears a \ltxarg{command} such that \etex's \ltxcmd{ifdefined} and \ltxcmd{ifcsname} tests will consider it as undefined. This command is robust and may be prefixed with \ltxcmd{global}.

\cmd{csundef}{csname}

Similar to \ltxcmd{undef} except that it takes a control sequence name as its argument. This command is robust and may be prefixed with \ltxcmd{global}.

\end{ltxsyntax}

\subsubsection{Arithmetic definitions}
\label{aut:def:cal}

The facilities in this section permit calculations using macros rather than length registers and counters.

\begin{ltxsyntax}

\cmd{numdef}<command>{integer expression}

Similar to \ltxcmd{edef} except that the \ltxarg{integer expression} is processed with \ltxcmd{numexpr}. The \ltxarg{integer expression} may be any arbitrary code which is valid in this context. The replacement text assigned to the \ltxarg{command} will be the result of that calculation. If the \ltxarg{command} is undefined, it will be initialized to <\texttt{0}> before the \ltxarg{integer expression} is processed.

\cmd{numgdef}<command>{integer expression}

Similar to \ltxcmd{numdef} except that the assignment is global.

\cmd{csnumdef}{csname}{integer expression}

Similar to \ltxcmd{numdef} except that it takes a control sequence name as its first argument.

\cmd{csnumgdef}{csname}{integer expression}

Similar to \ltxcmd{numgdef} except that it takes a control sequence name as its first argument.

\cmd{dimdef}<command>{dimen expression}

Similar to \ltxcmd{edef} except that the \ltxarg{dimen expression} is processed with \ltxcmd{dimexpr}. The \ltxarg{dimen expression} may be any arbitrary code which is valid in this context. The replacement text assigned to the \ltxarg{command} will be the result of that calculation. If the \ltxarg{command} is undefined, it will be initialized to <\texttt{0pt}> before the \ltxarg{dimen expression} is processed.

\cmd{dimgdef}<command>{dimen expression}

Similar to \ltxcmd{dimdef} except that the assignment is global.

\cmd{csdimdef}{csname}{dimen expression}

Similar to \ltxcmd{dimdef} except that it takes a control sequence name as its first argument.

\cmd{csdimgdef}{csname}{dimen expression}

Similar to \ltxcmd{dimgdef} except that it takes a control sequence name as its first argument.

\cmd{gluedef}<command>{glue expression}

Similar to \ltxcmd{edef} except that the \ltxarg{glue expression} is processed with \ltxcmd{glueexpr}. The \ltxarg{glue expression} may be any arbitrary code which is valid in this context. The replacement text assigned to the \ltxarg{command} will be the result of that calculation. If the \ltxarg{command} is undefined, it will be initialized to <\texttt{0pt plus 0pt minus 0pt}> before the \ltxarg{glue expression} is processed.

\cmd{gluegdef}<command>{glue expression}

Similar to \ltxcmd{gluedef} except that the assignment is global.

\cmd{csgluedef}{csname}{glue expression}

Similar to \ltxcmd{gluedef} except that it takes a control sequence name as its first argument.

\cmd{csgluegdef}{csname}{glue expression}

Similar to \ltxcmd{gluegdef} except that it takes a control sequence name as its first argument.

\cmd{mudef}<command>{muglue expression}

Similar to \ltxcmd{edef} except that the \ltxarg{muglue expression} is processed with \ltxcmd{muexpr}. The \ltxarg{muglue expression} may be any arbitrary code which is valid in this context. The replacement text assigned to the \ltxarg{command} will be the result of that calculation. If the \ltxarg{command} is undefined, it will be initialized to <\texttt{0mu}> before the \ltxarg{muglue expression} is processed.

\cmd{mugdef}<command>{muglue expression}

Similar to \ltxcmd{mudef} except that the assignment is global.

\cmd{csmudef}{csname}{muglue expression}

Similar to \ltxcmd{mudef} except that it takes a control sequence name as its first argument.

\cmd{csmugdef}{csname}{muglue expression}

Similar to \ltxcmd{mugdef} except that it takes a control sequence name as its first argument.

\end{ltxsyntax}

\subsection{Expansion control}

The facilities in this section are useful to control expansion in an \ltxcmd{edef} or a similar context.

\begin{ltxsyntax}

\cmd{expandonce}<command>

This command expands \ltxarg{command} once and prevents further expansion of the replacement text.

\cmd{csexpandonce}{csname}

Similar to \ltxcmd{expandonce} except that it takes a control sequence name as its argument.

\cmd{protecting}{code}

This command applies \latex's protection mechanism, which normally requires prefixing each fragile command with \ltxcmd{protect}, to an entire chunk of arbitrary \ltxarg{code}. Its behavior depends on the current state of \ltxcmd{protect}. Note that the braces around the \ltxarg{code} are mandatory even if it is a single token.

\end{ltxsyntax}

\subsection{Hook management}
\label{aut:hok}

The facilities in this section are intended for hook management. A \ltxarg{hook} in this context is a plain macro without any parameters and prefixes which is used to collect code to be executed later. These facilities may also be useful to patch simple macros by appending code to their replacement text. For more complex patching operations, see section \ref{aut:pat}. All commands in this section will initialize the \ltxarg{hook} if it is undefined.

\subsubsection{Appending to a hook}
\label{aut:hok:app}

The facilities in this section append arbitrary code to a hook.

\begin{ltxsyntax}

\cmd{appto}<hook>{code}

This command appends arbitrary \ltxarg{code} to a \ltxarg{hook}. If the \ltxarg{code} contains any parameter characters, they need not be doubled. This command is robust.

\cmd{gappto}<hook>{code}

Similar to \ltxcmd{appto} except that the assignment is global. This command may be used as a drop-in replacement for the \ltxcmd{g@addto@macro} command in the \latex kernel.

\cmd{eappto}<hook>{code}

This command appends arbitrary \ltxarg{code} to a \ltxarg{hook}. The \ltxarg{code} is expanded at definition"=time. Only the new \ltxarg{code} is expanded, the current replacement text of the \ltxarg{hook} is not. This command is robust.

\cmd{xappto}<hook>{code}

Similar to \ltxcmd{eappto} except that the assignment is global.

\cmd{protected@eappto}<hook>{code}

Similar to \ltxcmd{eappto} except that \latex's protection mechanism is temporarily enabled.

\cmd{protected@xappto}<hook>{code}

Similar to \ltxcmd{xappto} except that \latex's protection mechanism is temporarily enabled.

\cmd{csappto}{csname}{code}

Similar to \ltxcmd{appto} except that it takes a control sequence name as its first argument.

\cmd{csgappto}{csname}{code}

Similar to \ltxcmd{gappto} except that it takes a control sequence name as its first argument.

\cmd{cseappto}{csname}{code}

Similar to \ltxcmd{eappto} except that it takes a control sequence name as its first argument.

\cmd{csxappto}{csname}{code}

Similar to \ltxcmd{xappto} except that it takes a control sequence name as its first argument.

\cmd{protected@cseappto}<hook>{code}

Similar to \ltxcmd{protected@eappto} except that it takes a control sequence name as its first argument.

\cmd{protected@csxappto}<hook>{code}

Similar to \ltxcmd{protected@xappto} except that it takes a control sequence name as its first argument.

\end{ltxsyntax}

\subsubsection{Prepending to a hook}
\label{aut:hok:pre}

The facilities in this section <prepend> arbitrary code to a hook, \ie the code is inserted at the beginning of the hook rather than being added at the end.

\begin{ltxsyntax}

\cmd{preto}<hook>{code}

Similar to \ltxcmd{appto} except that the \ltxarg{code} is prepended.

\cmd{gpreto}<hook>{code}

Similar to \ltxcmd{preto} except that the assignment is global.

\cmd{epreto}<hook>{code}

Similar to \ltxcmd{eappto} except that the \ltxarg{code} is prepended.

\cmd{xpreto}<hook>{code}

Similar to \ltxcmd{epreto} except that the assignment is global.

\cmd{protected@epreto}<hook>{code}

Similar to \ltxcmd{epreto} except that \latex's protection mechanism is temporarily enabled.

\cmd{protected@xpreto}<hook>{code}

Similar to \ltxcmd{xpreto} except that \latex's protection mechanism is temporarily enabled.

\cmd{cspreto}{csname}{code}

Similar to \ltxcmd{preto} except that it takes a control sequence name as its first argument.

\cmd{csgpreto}{csname}{code}

Similar to \ltxcmd{gpreto} except that it takes a control sequence name as its first argument.

\cmd{csepreto}{csname}{code}

Similar to \ltxcmd{epreto} except that it takes a control sequence name as its first argument.

\cmd{csxpreto}{csname}{code}

Similar to \ltxcmd{xpreto} except that it takes a control sequence name as its first argument.

\cmd{protected@csepreto}<hook>{code}

Similar to \ltxcmd{protected@epreto} except that it takes a control sequence name as its first argument.

\cmd{protected@csxpreto}<hook>{code}

Similar to \ltxcmd{protected@xpreto} except that it takes a control sequence name as its first argument.

\end{ltxsyntax}

\subsection{Patching}
\label{aut:pat}

The facilities in this section are useful to hook into or modify existing code. All commands presented here preserve the parameters and the prefixes of the patched \ltxarg{command}. Note that the patching process involves detokenizing the replacement text of the \ltxarg{command} and retokenizing it under the current category code regime after patching. The category code of <@> is temporarily set to 11. If the replacement text of the \ltxarg{command} includes any tokens with non"=standard category codes, the respective category codes must be adjusted prior to patching. If the code to be replaced or inserted refers to the parameters of the \ltxarg{command} to be patched, the parameter characters need not be doubled when invoking one of the commands below. Note that \ltxcmd{outer} commands may not be patched.

\begin{ltxsyntax}

\cmd{patchcmd}[prefix]{command}{search}{replace}{success}{failure}

This command extracts the replacement text of a \ltxarg{command}, replaces \ltxarg{search} with \ltxarg{replace}, and reassembles the \ltxarg{command}. The pattern match is category code agnostic and matches the first occurence of the \ltxarg{search} pattern in the replacement text of the \ltxarg{command} to be patched. If an optional \ltxarg{prefix} is specified, it replaces the prefixes of the \ltxarg{command}. An empty \ltxarg{prefix} strips all prefixes from the \ltxarg{command}. This command executes \ltxarg{success} if patching succeeds, and \ltxarg{failure} otherwise. It is robust and may only be used in the document preamble. The assignment is local.

\cmd{ifpatchable}{command}{search}{true}{false}

This command executes \ltxarg{true} if the \ltxarg{command} is defined and the \ltxarg{search} pattern is found in its replacement text, and \ltxarg{false} otherwise. This command is robust and may only be used in the document preamble.

\cmd{apptocmd}{command}{code}

This command appends \ltxarg{code} to the replacement text of a \ltxarg{command}. In contrast to the \ltxcmd{appto} command from section \ref{aut:hok:app}, this one may be used to patch commands with an arbitrary number of parameters. The \ltxarg{code} may refer to the parameters of the \ltxarg{command} in this case. This command is robust and may only be used in the document preamble. The assignment is local.

\cmd{pretocmd}{command}{code}

This command is similar to \ltxcmd{apptocmd} except that the \ltxarg{code} is <prepended>, \ie inserted at the beginning of the replacement text of the \ltxarg{command}. In contrast to the \ltxcmd{preto} command from section \ref{aut:hok:app}, this one may be used to patch commands with an arbitrary number of parameters. The \ltxarg{code} may refer to the parameters of the \ltxarg{command} in this case. This command is robust and may only be used in the document preamble. The assignment is local.

\end{ltxsyntax}

\subsection{Generic tests}
\label{aut:tst}

\begin{ltxsyntax}

\cmd{ifdef}{command}{true}{false}

A \latex wrapper for the \etex primitive \ltxcmd{ifdefined}. This command expands to \ltxarg{true} if the \ltxarg{command} is defined, and to \ltxarg{false} otherwise. Note that the \ltxarg{command} is considered as defined even if its meaning is \ltxcmd{relax}.

\cmd{ifundef}{command}{true}{false}

Expands to \ltxarg{true} if the \ltxarg{command} is undefined, and to \ltxarg{false} otherwise. Apart from reversing the logic of the test, this command also differs from \ltxcmd{ifdef} in that the \ltxarg{command} is considered as undefined if its meaning is \ltxcmd{relax}.

\cmd{ifcsdef}{csname}{true}{false}

A \latex wrapper for the \etex primitive \ltxcmd{ifcsname}. This command expands to \ltxarg{true} if \ltxarg{csname} is defined, and to \ltxarg{false} otherwise. Note that \ltxarg{csname} is considered as defined even if its meaning is \ltxcmd{relax}.

\cmd{ifcsundef}{csname}{true}{false}

Expands to \ltxarg{true} if \ltxarg{csname} is undefined, and to \ltxarg{false} otherwise. Apart from reversing the logic of the test, this command also differs from \ltxcmd{ifcsdef} in that the \ltxarg{csname} is considered as undefined if its meaning is \ltxcmd{relax}. This command may be used as a drop-in replacement for the \ltxcmd{@ifundefined} test in the \latex kernel.

\cmd{ifdefvoid}{command}{true}{false}

Expands to \ltxarg{true} if the \ltxarg{command} is undefined, its meaning is \ltxcmd{relax}, or its replacement text is empty, and to \ltxarg{false} otherwise. 

\cmd{ifcsvoid}{csname}{true}{false}

Similar to \ltxcmd{ifdefvoid} except that it takes a control sequence name as its first argument.

\cmd{ifdefequal}{command}{command}{true}{false}

Compares two commands and expands to \ltxarg{true} if they are equal in the sense of the \tex primitive \ltxcmd{ifx}, and to \ltxarg{false} otherwise. In contrast to \ltxcmd{ifx}, this test will also yield \ltxarg{false} if both commands are undefined or have a meaning of \ltxcmd{relax}.

\cmd{ifcsequal}{csname}{csname}{true}{false}

Similar to \ltxcmd{ifdefequal} except that it takes control sequence names as arguments.

\cmd{ifdefstring}{command}{string}{true}{false}

Compares the replacement text of a \ltxarg{command} to a \ltxarg{string} and executes \ltxarg{true} if they are equal, and \ltxarg{false} otherwise. Neither the \ltxarg{command} nor the \ltxarg{string} is expanded in the test and the comparison is category code agnostic. Control sequence tokens in the \ltxarg{string} argument will be detokenized and treated as strings. This command is robust. Note that it will only consider the replacement text of the \ltxarg{command}. For example, this code

\begin{ltxcode}
\long\def\@gobbletwo#1#2{}
\ifdefstring{\@gobbletwo}{}{true}{false}
\end{ltxcode}
%
would yield \ltxarg{true}. The prefix and the parameters of |\@gobbletwo| are ignored.

\cmd{ifcsstring}{csname}{string}{true}{false}

Similar to \ltxcmd{ifdefstring} except that it takes a control sequence name as its first argument.

\cmd{ifstrequal}{string}{string}{true}{false}

Compares two strings and executes \ltxarg{true} if they are equal, and \ltxarg{false} otherwise. The strings are not expanded in the test and the comparison is category code agnostic. Control sequence tokens in any of the \ltxarg{string} arguments will be detokenized and treated as strings. This command is robust.

\cmd{ifblank}{string}{true}{false}

Expands to \ltxarg{true} if the \ltxarg{string} is blank (empty or spaces), and to \ltxarg{false} otherwise. The \ltxarg{string} is not expanded in the test.

\end{ltxsyntax}

\subsection{Boolean switches}
\label{aut:bol}

This package provides two interfaces to boolean switches which are completely independent of each other. The facilities in section \ref{aut:bo1:bol} are a \latex frontend to \ltxcmd{newif}. Those in section \ref{aut:bo1:swi} use a different mechanism.

\subsubsection{\tex switches}
\label{aut:bo1:bol}

Since the facilities in this section are based on \ltxcmd{newif} internally, they may be used to test and alter the state of switches previously defined with \ltxcmd{newif}. They are also compatible with the boolean tests of the \sty{ifthen} package. The \ltxcmd{newif} approach requires a total of three macros per switch.

\begin{ltxsyntax}

\cmd{newbool}{name}

Defines a new boolean switch called \ltxarg{name}. If the switch has already been defined, this command issues an error. The initial state of newly defined switches is \texttt{false}. This command is robust.

\cmd{providebool}{name}

Defines a new boolean switch called \ltxarg{name} unless it has already been defined. This command is robust.

\cmd{booltrue}{name}

Sets the boolean switch \ltxarg{name} to \texttt{true}. This command is robust and may be prefixed with \ltxcmd{global}. It will issue an error if the switch is undefined.

\cmd{boolfalse}{name}

Sets the boolean switch \ltxarg{name} to \texttt{false}. This command is robust and may be prefixed with \ltxcmd{global}. It will issue an error if the switch is undefined.

\cmd{ifbool}{name}{true}{false}

Expands to \ltxarg{true} if the state of the boolean switch \ltxarg{name} is \texttt{true}, and to \ltxarg{false} otherwise. If the switch is undefined, this command issues an error.

\cmd{notbool}{name}{not true}{not false}

Similar to \ltxcmd{ifbool} but reverses the logic of the test.

\end{ltxsyntax}

\subsubsection{\latex switches}
\label{aut:bo1:swi}

In contrast to the switches from section \ref{aut:bo1:bol}, the facilities in this section require only one macro per switch. They also use a separate namespace to avoid name clashes with regular macros.

\begin{ltxsyntax}

\cmd{newtoggle}{name}

Defines a new boolean switch called \ltxarg{name}. If the switch has already been defined, this command issues an error. The initial state of newly defined switches is \texttt{false}. This command is robust.

\cmd{providetoggle}{name}

Defines a new boolean switch called \ltxarg{name} unless it has already been defined. This command is robust.

\cmd{toggletrue}{name}

Sets the boolean switch \ltxarg{name} to \texttt{true}. This command is robust and may be prefixed with \ltxcmd{global}. It will issue an error if the switch is undefined.

\cmd{togglefalse}{name}

Sets the boolean switch \ltxarg{name} to \texttt{false}. This command is robust and may be prefixed with \ltxcmd{global}. It will issue an error if the switch is undefined.

\cmd{iftoggle}{name}{true}{false}

Expands to \ltxarg{true} if the state of the boolean switch \ltxarg{name} is \texttt{true}, and to \ltxarg{false} otherwise. If the switch is undefined, this command issues an error.

\cmd{nottoggle}{name}{not true}{not false}

Similar to \ltxcmd{iftoggle} but reverses the logic of the test.

\end{ltxsyntax}

\subsection{List processing}
\label{aut:lst}

\subsubsection{User input}
\label{aut:lst:inp}

The facilities in this section are primarily designed to handle user input. When building lists for internal use by a package, using the facilities in section \ref{aut:lst:int} is preferable.

\begin{ltxsyntax}

\cmd{DeclareListParser}{command}{separator}

This command defines a list parser similar to the \ltxcmd{docsvlist} command below, which is defined with <|\DeclareListParser{\docsvlist}{,}|>. Note that the list parsers are sensitive to the category code of the \ltxarg{separator}.

\cmd{docsvlist}{item, item, ...}

This command loops over a comma"=separated list and executes the auxiliary command \ltxcmd{do} for every item in the list, passing the item as an argument. In contrast to the \ltxcmd{@for} loop in the \latex kernel, \ltxcmd{docsvlist} is expandable. With a suitable definition of \ltxcmd{do}, lists may be processed inside an \ltxcmd{edef} or a comparable context. You may use \ltxcmd{listbreak} at the end of the replacement text of \ltxcmd{do} to stop processing and discard the remaining items in the list. Whitespace after list separators is ignored. If an item contains a comma or starts with a space, it must be wrapped in curly braces. The braces will be removed as the list is processed. Here is a usage example which prints a comma"=separated list as an \ltxenv{itemize} environment:

\begin{ltxcode}
\begin{itemize}
  \renewcommand*{\do}[1]{\item #1}
  \docsvlist{item1, item2, {item3a, item3b}, item4}
\end{itemize}
\end{ltxcode}
%
Here is another example:

\begin{ltxcode}
\renewcommand*{\do}[1]{* #1\MessageBreak}
\PackageInfo{mypackage}{%
  Example list:\MessageBreak
  \docsvlist{item1, item2, {item3a, item3b}, item4}}
\end{ltxcode}
%
In this example, the list is written to the log file as part of an informational message. The list processing takes place during the \ltxcmd{write} operation.

\end{ltxsyntax}

\subsubsection{Internal lists}
\label{aut:lst:int}

The facilities in this section handle internal lists of data. An <internal list> in this context is a plain macro without any parameters and prefixes which is employed to collect data. These lists use a special character as internal list separator. When processing user input in a list format, see the facilities in section \ref{aut:lst:inp}.

\begin{ltxsyntax}

\cmd{listadd}{listmacro}{item}

This command appends an \ltxarg{item} to a \ltxarg{listmacro}.

\cmd{listgadd}{listmacro}{item}

Similar to \ltxcmd{listadd} except that the assignment is global.

\cmd{listeadd}{listmacro}{item}

Similar to \ltxcmd{listadd} except that the \ltxarg{item} is expanded at definition"=time. Only the new \ltxarg{item} is expanded, the current list is not.

\cmd{listxadd}{listmacro}{item}

Similar to \ltxcmd{listeadd} except that the assignment is global.

\cmd{listcsadd}{listcsname}{item}

Similar to \ltxcmd{listadd} except that it takes a control sequence name as its first argument.

\cmd{listcsgadd}{listcsname}{item}

Similar to \ltxcmd{listcsadd} except that the assignment is global.

\cmd{listcseadd}{listcsname}{item}

Similar to \ltxcmd{listeadd} except that it takes a control sequence name as its first argument.

\cmd{listcsxadd}{listcsname}{item}

Similar to \ltxcmd{listcseadd} except that the assignment is global.

\cmd{dolistloop}{listmacro}

This command loops over all items in a \ltxarg{listmacro} and executes the auxiliary command \ltxcmd{do} for every item in the list, passing the item as an argument. The list loop itself is expandable. You may use \ltxcmd{listbreak} at the end of the replacement text of \ltxcmd{do} to stop processing and discard the remaining items in the list. Here is a usage example which prints an internal list called \ltxcmd{mylist} as an \ltxenv{itemize} environment:

\begin{ltxcode}
\begin{itemize}
  \renewcommand*{\do}[1]{\item #1}
  \dolistloop{\mylist}
\end{itemize}
\end{ltxcode}

\cmd{dolistcsloop}{listcsname}

Similar to \ltxcmd{dolistloop} except that it takes a control sequence name as its argument.

\cmd{ifinlist}{item}{listmacro}

This command checks if an \ltxarg{item} is included in a \ltxarg{listmacro}. Note that this test uses pattern matching based on \tex's argument scanner to check if the search string is included in the list. This means that it is usually faster than looping over all items in the list, but it also implies that the items must not include curly braces which would effectively hide them from the scanner. In other words, this macro is most useful when dealing with lists of plain strings rather than printable data. When dealing with printable text, it may be preferable to use \ltxcmd{dolistloop} to check if an item is in the list as follows:

\begin{ltxcode}
\renewcommand*{\do}[1]{%
  \ifstrequal{#1}{<<item>>}
    {item found!\listbreak}
    {}}
\dolistloop{\mylist}
\end{ltxcode}

\cmd{xifinlist}{item}{listmacro}

Similar to \ltxcmd{ifinlist} except that the \ltxarg{item} is expanded prior to the test.

\cmd{ifinlistcs}{item}{listcsname}

Similar to \ltxcmd{ifinlist} except that it takes a control sequence name as its second argument.

\cmd{xifinlistcs}{item}{listcsname}

Similar to \ltxcmd{xifinlist} except that it takes a control sequence name as its second argument.

\end{ltxsyntax}

\subsection{Miscellaneous tools}
\label{aut:msc}

\begin{ltxsyntax}

\cmd{rmntonum}{numeral}

The \tex primitive \ltxcmd{romannumeral} converts an integer to a Roman numeral but \tex or \latex provide no command which goes the opposite way. \ltxcmd{rmntonum} fills this gap. It takes a Roman numeral as its argument and converts it to the corresponding integer. Since it is expandable, it may also be used in counter assignments or \ltxcmd{ifnum} comparisons:

\begin{ltxcode}
\rmntonum{mcmxcv}
\setcounter{counter}{\rmntonum{CXVI}}
\ifnum\rmntonum{mcmxcviii}<2000 ...
\end{ltxcode}
%
The \ltxarg{numeral} argument must be a literal string. It will be detokenized prior to parsing. The parsing of the numeral is case"=insensitive and whitespace in the argument is ignored. If there is an invalid token in the argument, \ltxcmd{rmntonum} will expand to~\texttt{-1}; an empty argument will yield an empty string. Note that \ltxcmd{rmntonum} will not check the numeral for formal validity. For example, both \texttt{V} and \texttt{VX} will yield~\texttt{5}.

\cmd{ifrmnum}{string}{true}{false}

Expands to \ltxarg{true} if \ltxarg{string} is a Roman numeral, and to \ltxarg{false} otherwise. The \ltxarg{string} will be detokenized prior to performing the test. The test is case"=insensitive and ignores whitespace in the \ltxarg{string}. Note that \ltxcmd{ifrmnum} will not check the numeral for formal validity. For example, both \texttt{V} and \texttt{VXV} will yield \ltxarg{true}. Strictly speaking, what \ltxcmd{ifrmnum} does is parse the \ltxarg{string} in order to find out if it consists of characters which may form a valid Roman numeral.

\end{ltxsyntax}

\section{Revision history}

\begin{changelog}

\begin{release}{1.5}{2008-04-26}

\item Added \ltxcmd{defcounter}\see{use:cal}
\item Added \ltxcmd{deflength}\see{use:cal}
\item Added \ltxcmd{ifdefstring}\see{aut:tst}
\item Added \ltxcmd{ifcsstring}\see{aut:tst}
\item Improved \ltxcmd{rmntonum}\see{aut:msc}
\item Added \ltxcmd{ifrmnum}\see{aut:msc}
\item Added extended \pdf bookmarks to this manual
\item Rearranged manual slightly 

\end{release}

\begin{release}{1.4}{2008-01-24}

\item Resolved conflict with \sty{tex4ht}

\end{release}

\begin{release}{1.3}{2007-10-08}

\item Renamed package from \sty{elatex} to \sty{etoolbox}\see{int}
\item Renamed \ltxcmd{newswitch} to \ltxcmd{newtoggle} (name clash)\see{aut:bo1:swi}
\item Renamed \ltxcmd{provideswitch} to \ltxcmd{providetoggle} (consistency)\see{aut:bo1:swi}
\item Renamed \ltxcmd{switchtrue} to \ltxcmd{toggletrue} (consistency)\see{aut:bo1:swi}
\item Renamed \ltxcmd{switchfalse} to \ltxcmd{togglefalse} (consistency)\see{aut:bo1:swi}
\item Renamed \ltxcmd{ifswitch} to \ltxcmd{iftoggle} (consistency)\see{aut:bo1:swi}
\item Renamed \ltxcmd{notswitch} to \ltxcmd{nottoggle} (consistency)\see{aut:bo1:swi}
\item Added \ltxcmd{AtEndPreamble}\see{use:pre}
\item Added \ltxcmd{AfterEndDocument}\see{use:pre}
\item Added \ltxcmd{AfterPreamble}\see{use:pre}
\item Added \ltxcmd{undef}\see{aut:def:def}
\item Added \ltxcmd{csundef}\see{aut:def:def}
\item Added \ltxcmd{ifdefvoid}\see{aut:tst}
\item Added \ltxcmd{ifcsvoid}\see{aut:tst}
\item Added \ltxcmd{ifdefequal}\see{aut:tst}
\item Added \ltxcmd{ifcsequal}\see{aut:tst}
\item Added \ltxcmd{ifstrequal}\see{aut:tst}
\item Added \ltxcmd{listadd}\see{aut:lst:int}
\item Added \ltxcmd{listeadd}\see{aut:lst:int}
\item Added \ltxcmd{listgadd}\see{aut:lst:int}
\item Added \ltxcmd{listxadd}\see{aut:lst:int}
\item Added \ltxcmd{listcsadd}\see{aut:lst:int}
\item Added \ltxcmd{listcseadd}\see{aut:lst:int}
\item Added \ltxcmd{listcsgadd}\see{aut:lst:int}
\item Added \ltxcmd{listcsxadd}\see{aut:lst:int}
\item Added \ltxcmd{ifinlist}\see{aut:lst:int}
\item Added \ltxcmd{xifinlist}\see{aut:lst:int}
\item Added \ltxcmd{ifinlistcs}\see{aut:lst:int}
\item Added \ltxcmd{xifinlistcs}\see{aut:lst:int}
\item Added \ltxcmd{dolistloop}\see{aut:lst:int}
\item Added \ltxcmd{dolistcsloop}\see{aut:lst:int}

\end{release}

\begin{release}{1.2}{2007-07-13}

\item Renamed \ltxcmd{patchcommand} to \ltxcmd{patchcmd} (name clash)\see{aut:pat}
\item Renamed \ltxcmd{apptocommand} to \ltxcmd{apptocmd} (consistency)\see{aut:pat}
\item Renamed \ltxcmd{pretocommand} to \ltxcmd{pretocmd} (consistency)\see{aut:pat}
\item Added \ltxcmd{newbool}\see{aut:bo1:bol}
\item Added \ltxcmd{providebool}\see{aut:bo1:bol}
\item Added \ltxcmd{booltrue}\see{aut:bo1:bol}
\item Added \ltxcmd{boolfalse}\see{aut:bo1:bol}
\item Added \ltxcmd{ifbool}\see{aut:bo1:bol}
\item Added \ltxcmd{notbool}\see{aut:bo1:bol}
\item Added \ltxcmd{newswitch}\see{aut:bo1:swi}
\item Added \ltxcmd{provideswitch}\see{aut:bo1:swi}
\item Added \ltxcmd{switchtrue}\see{aut:bo1:swi}
\item Added \ltxcmd{switchfalse}\see{aut:bo1:swi}
\item Added \ltxcmd{ifswitch}\see{aut:bo1:swi}
\item Added \ltxcmd{notswitch}\see{aut:bo1:swi}
\item Added \ltxcmd{DeclareListParser}\see{aut:lst:inp}
\item Added \ltxcmd{docsvlist}\see{aut:lst:inp}
\item Added \ltxcmd{rmntonum}\see{aut:msc}

\end{release}

\begin{release}{1.1}{2007-05-28}

\item Added \ltxcmd{protected@csedef}\see{aut:def:def}
\item Added \ltxcmd{protected@csxdef}\see{aut:def:def}
\item Added \ltxcmd{gluedef}\see{aut:def:cal}
\item Added \ltxcmd{gluegdef}\see{aut:def:cal}
\item Added \ltxcmd{csgluedef}\see{aut:def:cal}
\item Added \ltxcmd{csgluegdef}\see{aut:def:cal}
\item Added \ltxcmd{mudef}\see{aut:def:cal}
\item Added \ltxcmd{mugdef}\see{aut:def:cal}
\item Added \ltxcmd{csmudef}\see{aut:def:cal}
\item Added \ltxcmd{csmugdef}\see{aut:def:cal}
\item Added \ltxcmd{protected@eappto}\see{aut:hok:app}
\item Added \ltxcmd{protected@xappto}\see{aut:hok:app}
\item Added \ltxcmd{protected@cseappto}\see{aut:hok:app}
\item Added \ltxcmd{protected@csxappto}\see{aut:hok:app}
\item Added \ltxcmd{protected@epreto}\see{aut:hok:pre}
\item Added \ltxcmd{protected@xpreto}\see{aut:hok:pre}
\item Added \ltxcmd{protected@csepreto}\see{aut:hok:pre}
\item Added \ltxcmd{protected@csxpreto}\see{aut:hok:pre}
\item Fixed bug in \ltxcmd{newrobustcmd}\see{use:def}
\item Fixed bug in \ltxcmd{renewrobustcmd}\see{use:def}
\item Fixed bug in \ltxcmd{providerobustcmd}\see{use:def}

\end{release}

\begin{release}{1.0}{2007-05-07}

\item Initial public release

\end{release}

\end{changelog}

\end{document}