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
|
#!/usr/bin/env perl
################################################################################
# texdef -- Show definitions of TeX commands
# Copyright (c) 2011-2012 Martin Scharrer <martin@scharrer-online.de>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
use strict;
use warnings;
use File::Temp qw/tempdir/;
use File::Basename;
use Cwd;
my ($scriptname) = fileparse($0, qw(\.pl \.perl));
my $TEX = 'pdflatex';
if ($scriptname =~ /^(.*)def$/) {
$TEX = $1;
}
my $TEXOPTIONS = " -interaction nonstopmode ";
## Variables for options and settings
my $CLASS = undef;
my $USERCLASS = 0;
my @PACKAGES = ();
my @OTHERDEFS = ();
my $INPREAMBLE = 0;
my $PRINTVERSION = 0;
my $TMPDIR = '';
my $SHOWVALUE = 0;
my $PRINTORIGDEF = 0;
my $FINDDEF = 0;
my $LISTCMD = 0;
my $LISTCMDDEF = 0;
my $BEFORECLASS = 0;
my $PGFKEYS = 0;
my $PGFKEYSPLAIN = 0;
my $FAKECMD = "\0FAKECOMMAND\0";
my @ENVCODE = ();
my %DEFS;
my $LISTSTR = '@TEXDEF@LISTDEFS@'; # used as a dummy command to list definitions
my @FILES; # List of files (sty, cls, ...)
my @FILEORDER; # Order of files
my %ALIAS; # list of aliases; required for registers
my $currfile = ''; # current file name
my @IGNOREDEFREG = (# List of definitions to be ignored. Can be a regex or string
qr/^ver\@.*\.(?:sty|cls)$/,
qr/^opt\@.*\.(?:sty|cls)$/,
qr/^reserved\@[a-z]$/,
qr/-h\@\@k$/,
qr/^catcode\d+$/,
qr/^l\@ngrel\@x$/,
qr/^\@temp/,
qr/^KV\@/,
qr/^KVO\@/,
qr/^KVOdyn\@/,
qr/^KVS\@/,
qr/^currfile/,
qr/^filehook\@atbegin\@/,
qr/^filehook\@atend\@/,
qr/^count\d+$/,
qr/^pgfk@\//
);
my %IGNOREDEF = map { $_ => 1 } qw(
usepackage RequirePackage documentclass LoadClass @classoptionslist
CurrentOption tracingassigns in@@ escapechar
@unprocessedoptions @let@token @gtempa @filelist @filef@und
@declaredoptions @currnamestack @currname @currext
@ifdefinable default@ds ds@ @curroptions
filename@area filename@base filename@ext
);
## Adds arguments to %IGNOREDEF
sub addignore {
my $opt = shift;
my $arg = shift;
my @args = split (/,/, $arg);
if ($opt eq 'ignore-cmds') {
@IGNOREDEF{@args} = (1) x scalar @args;
}
else {
push @IGNOREDEFREG, map { qr/$_/ } @args;
}
}
use Getopt::Long;
my $data = "file.dat";
my $length = 24;
my $verbose;
my $ISLATEX = 0;
my $ISTEX = 0;
my $ISCONTEXT = 0;
my $BEGINENVSTR = '%s';
my $ENDENVSTR = '%s';
my $VERSION = 'Version 1.5 -- 2012/04/29';
sub usage {
print << 'EOT';
texdef -- Show definitions of TeX commands
Version 1.5 -- 2012/04/29
Copyright (C) 2011-2012 Martin Scharrer <martin@scharrer-online.de>
This program comes with ABSOLUTELY NO WARRANTY;
This is free software, and you are welcome to redistribute it under certain conditions;
Usage:
texdef [options] commandname [commandname ...]
latexdef [options] commandname [commandname ...]
Other program names are possible. See the 'tex' option. Command names do not need to start with `\`.
Options:
--tex <flv>, -t <flv> : Use given flavour of TeX: 'tex', 'latex', 'context'.
Variations of 'tex' and 'latex', like 'luatex', 'lualatex', 'xetex', 'xelatex' are supported.
The default is given by the used program name: 'texdef' -> 'tex', 'latexdef' -> 'latex', etc.
--value, -v : Show value of command instead (i.e. \the\command).
--preamble, -P : Show definition of the command inside the preamble.
--beforeclass, -B : Show definition of the command before \documentclass.
--package <pkg>, -p <pkg> : (M) Load given tex-file, package or module depending on whether '*tex', '*latex'
or 'context' is used. For LaTeX the <pkg> can start with `[<options>]` and end
with `<pkgname>` or `{<pkgname>}`.
--class <class>, -c <class> : (LaTeX only) Load given class instead of default ('article').
The <class> can start with `[<classs options>]` and end
with `<classname>` or `{<classname>}`.
--environment <env>, -p <env> : (M) Show definition inside the given environment <env>.
--othercode <code>, -o <code> : (M) Add other code into the preamble before the definition is shown.
This can be used to e.g. load PGF/TikZ libraries.
--before <code>, -b <code> : (M) Place <code> before definition is shown.
The <code> can be arbitray TeX code and doesn't need be be balanced.
--after <code>, -a <code> : (M) Place <code> after definition is shown.
The <code> can be arbitray TeX code and doesn't need be be balanced.
--find, -f : Find file where the command sequence was defined (L).
--Find, -F : Show full filepath of the file where the command sequence was defined (L).
--source, -s : Try to show the original source code of the command definition (L).
--list, -l : List user level command sequences of the given packages (L).
--list-defs, -L : List user level command sequences and their shorten definitions of the given packages (L).
--list-all, -ll : List all command sequences of the given packages (L).
--list-defs-all, -LL : List all command sequences and their shorten definitions of the given packages (L).
--ignore-cmds <cs,cs,..>, -i : Ignore the following command sequence(s) in the above lists. (M)
--ignore-regex <regex,..>, -I : Ignore all command sequences in the above lists which match the given Perl regular expression(s). (M)
--pgf-keys, -k : Takes commands as pgfkeys and displays their definitions. Keys must use the full path but the common '.\@cmd' prefix is applied.
--pgf-Keys, -K : Takes commands as pgfkeys and displays their definitions. Keys must use the full path.
--version, -V : If used alone prints version of this script.
(L) Together with -p or -c prints version of LaTeX package(s) or class, respectively.
--tempdir <directory> : Use given existing directory for temporary files.
--help, -h : Print this help and quit.
Long option can be shorten as long the are still unique. Short options can be combined.
If the option 'environment', 'before' and 'after' are used toegether the
produced code will be inserted in the given order (reversed order for 'after').
(M) = This option can be given multiple times.
(L) = LaTeX only. Requires the packages 'filehook' and 'currfile'.
Examples:
Show the definition of '\chapter' with different classes ('article' (default), 'book' and 'scrbook'):
latexdef chapter
latexdef -c book chapter
latexdef -c scrbook chapter
Show value of `\textwidth` with different class options:
latexdef -c [a4paper]{book} -v paperwidth
latexdef -c [letter]{book} -v paperwidth
Show definition of TikZ's '\draw' outside and inside a 'tikzpicture' environment:
latexdef -p tikz draw
latexdef -p tikz --env tikzpicture draw
Show definition of TikZ's '\draw' inside a node, inside a 'beamer' frame in 'handout' mode:
latexdef -c [handout]beamer -p tikz --env frame --env tikzpicture -b '\node {' -a '};' draw
List all user level command sequences (macros) defined by the 'xspace' LaTeX package:
latexdef -l -p xspace
EOT
exit (1);
}
sub envcode {
my $opt = shift;
my $arg = shift;
push @ENVCODE, [ $opt, $arg ];
}
## Define and process options
Getopt::Long::Configure ("bundling");
GetOptions (
'value|v!' => \$SHOWVALUE,
'version|V!' => \$PRINTVERSION,
'tempdir=s' => \$TMPDIR,
'find|f!' => sub { $FINDDEF = 1 },
'Find|F!' => sub { $FINDDEF = 2 },
'source|s!' => \$PRINTORIGDEF,
'list|l' => sub { $LISTCMD++ },
'list-def|L' => sub { $LISTCMDDEF++ },
'list-all' => sub { $LISTCMD=2 },
'list-def-all' => sub { $LISTCMDDEF=2 },
'ignore-cmds|i=s' => \&addignore,
'ignore-regex|I=s' => \&addignore,
'no-list|no-l' => sub { $LISTCMD=0; $LISTCMDDEF=0; },
'no-list-def|no-L' => sub { $LISTCMDDEF=0 },
'no-list-all|no-ll' => sub { $LISTCMD=0; $LISTCMDDEF=0; },
'no-list-def-all|no-LL' => sub { $LISTCMDDEF=0 },
'preamble|P!' => \$INPREAMBLE,
'beforeclass|B!' => \$BEFORECLASS,
'class|c=s' => \$CLASS,
'package|p=s' => \@PACKAGES,
'otherdefs|o=s' => \@OTHERDEFS,
'environment|e=s' => \&envcode,
'before|b=s' => \&envcode,
'after|a=s' => \&envcode,
'tex|t=s' => \$TEX,
'help|h' => \&usage,
'pgf-keys|k' => \$PGFKEYS,
'pgf-Keys|K' => \$PGFKEYSPLAIN,
) || usage();
# usage() unless @ARGV;
## Format specific settings
if ($TEX =~ /latex$/) {
$ISLATEX = 1;
$BEGINENVSTR = '\begin{%s}' . "\n";
$ENDENVSTR = '\end{%s}' . "\n";
}
elsif ($TEX =~ /tex$/) {
$ISTEX = 1;
$BEGINENVSTR = '\%s' . "\n";
$ENDENVSTR = '\end%s' . "\n";
}
elsif ($TEX =~ /context$/) {
$ISCONTEXT = 1;
$BEGINENVSTR = '\start%s' . "\n";
$ENDENVSTR = '\stop%s' . "\n";
}
$USERCLASS = $CLASS;
$CLASS = 'article' if not $CLASS;
$CLASS =~ /^(?:\[(.*)\])?{?(.*?)}?$/;
$CLASS = $2;
my $CLASSOPTIONS = $1 || '';
if ($FINDDEF == 1 && !$ISLATEX) { die "Error: The --find / -f option is only implemented for LaTeX!\n"; }
if ($FINDDEF == 2 && !$ISLATEX) { die "Error: The --Find / -F option is only implemented for LaTeX!\n"; }
my @cmds = @ARGV;
$LISTCMD = $LISTCMDDEF if $LISTCMDDEF;
if ($LISTCMD && !$ISLATEX) { die "Error: Listing for commands is only implemented for LaTeX!\n"; }
if ($LISTCMD) {
@cmds = ($LISTSTR);
}
if ($PRINTVERSION) {
if (!@PACKAGES && !$USERCLASS) {
print STDERR "texdef: $VERSION\n";
exit (0) if not @cmds;
}
elsif (!@cmds) {
@cmds = ($FAKECMD);
}
}
sub print_versions {
my @files = map { $_.'.sty' } @PACKAGES;
unshift @files, "$USERCLASS.cls" if $USERCLASS;
foreach my $file (@files) {
print "\\message{^^J:TEXDEF: $file: \\csname ver\@$file\\endcsname^^J}%\n";
}
$PRINTVERSION = 0;# only print it once
}
usage() if not @cmds;
my $cwd = getcwd();
my $OS = $^O;
my $DIRSEP;
if ($OS =~ /MSWin/) {
$DIRSEP = ';';
} else {
$DIRSEP = ':';
}
$ENV{TEXINPUTS} = '.' . $DIRSEP . $cwd . $DIRSEP . ($ENV{TEXINPUTS} || '');
if (!$TMPDIR) {
$TMPDIR = tempdir( 'texdef_XXXXXX', CLEANUP => 1, TMPDIR => 1 );
}
chdir $TMPDIR or die "Couldn't change into temporary directory '$TMPDIR'\n";
my $TMPFILE = 'texdeftmp.tex';
sub testdef {
my $cmd = shift;
my $def = shift;
if ($def eq 'macro:->\@latex@error {Can be used only in preamble}\@eha ' && $cmd ne '\@notprerr') {
unshift @cmds, '^' . $cmd;
}
elsif ($def =~ /^(?:\\[a-z]+ )?macro:.*?>(.*)/) {
my $macrodef = $1;
if ($macrodef =~ /^\\protect (.*?) ?$/) {
my $protectedmacro = $1;
unshift @cmds, $protectedmacro;
}
elsif ($macrodef =~ /^\\x\@protect (.*?) ?\\protect (.*?) ?$/) {
my $protectedmacro = $2;
unshift @cmds, $protectedmacro;
}
elsif ($macrodef =~ /^\\\@protected\@testopt {?\\.*? }? *(\\\\.*?) /) {
unshift @cmds, $1;
}
elsif ($macrodef =~ /^\\\@testopt {?(\\.*?) }?/) {
unshift @cmds, $1;
}
}
elsif ($def =~ /^\\(char|mathchar)|(dimen|skip|muskip|count)\d/) {
unshift @cmds, '#' . $cmd;
}
}
my $bschar = 0;
my $pcchar = 0;
my $lbchar = 0;
my $rbchar = 0;
sub special_chars {
return if (!$bschar && !$pcchar && !$lbchar && !$rbchar);
print '\begingroup'."\n";
if ($bschar) {
print '\lccode`.=92 \lowercase{\expandafter\gdef\csname @backslashchar\endcsname{.}}'."\n";
}
if ($pcchar) {
print '\lccode`.=37 \lowercase{\expandafter\gdef\csname @percentchar\endcsname{.}}'."\n";
}
if ($lbchar) {
print '\lccode`.=123 \lowercase{\expandafter\gdef\csname @charlb\endcsname{.}}'."\n";
}
if ($rbchar) {
print '\lccode`.=125 \lowercase{\expandafter\gdef\csname @charrb\endcsname{.}}'."\n";
}
print '\endgroup'."\n";
}
#######################################################################################################################
## Loop around given commands ##
#######################################################################################################################
while (my $cmd = shift @cmds) {
next if $cmd eq '';
my $origcmd = $cmd;
my $showvalue;
my $inpreamble;
if ($cmd ne $FAKECMD) {
if ($PGFKEYS) {
$cmd = "pgfk\@$cmd/.\@cmd";
push @PACKAGES, "pgfkeys";
}
if ($PGFKEYSPLAIN) {
$cmd = "pgfk\@$cmd";
push @PACKAGES, "pgfkeys";
}
if (length ($cmd) > 1) {
$cmd =~ s/^([#^])?\\?//;
my $type = $1 || '';
$showvalue = $type eq '#';
$inpreamble = $type eq '^';
}
$bschar = $cmd =~ s/\\/\\csname\0\@backslashchar\\endcsname\0/g;
$pcchar = $cmd =~ s/\%/\\csname\0\@percentchar\\endcsname\0/g;
$lbchar = $cmd =~ s/\{/\\csname\0\@charlb\\endcsname\0/g;
$rbchar = $cmd =~ s/\}/\\csname\0\@charrb\\endcsname\0/g;
$cmd =~ s/\s/\\space /g;
$cmd =~ s/\0/ /g;
}
open (my $tmpfile, '>', $TMPFILE);
select $tmpfile;
print "\\nonstopmode\n";
if ($ISLATEX) {
#print "\\nofiles\n";
if ($FINDDEF || $LISTCMD || $PRINTORIGDEF) {
# Load the 'filehook' and 'currfile' packages without 'kvoptions' by providing dummy definitions for the 'currfile' options:
print '\makeatletter\expandafter\def\csname ver@kvoptions.sty\endcsname{0000/00/00}\let\SetupKeyvalOptions\@gobble\newcommand\DeclareBoolOption[2][]{}\let\DeclareStringOption\DeclareBoolOption';
print '\let\DeclareVoidOption\@gobbletwo\def\ProcessKeyvalOptions{\@ifstar{}{}}';
print '\def\currfile@mainext{tex}\def\currfile@maindir{\@currdir}\let\ifcurrfile@fink\iffalse\makeatother';
print "\\RequirePackage{filehook}\n";
print "\\RequirePackage{currfile}\n";
print '\makeatletter\expandafter\let\csname ver@kvoptions.sty\endcsname\relax\let\SetupKeyvalOptions\@undefined\let\DeclareBoolOption\@undefined\let\DeclareStringOption\@undefined';
print '\let\DeclareVoidOption\@undefined\let\ProcessKeyvalOptions\@undefined\makeatother';
}
if ($FINDDEF || $PRINTORIGDEF) {
print '{\expandafter}\expandafter\ifx\csname ' . $cmd . '\expandafter\endcsname\csname @undefined\endcsname' . "\n";
print '\AtEndOfFiles{{{\expandafter}\expandafter\ifx\csname ' . $cmd . '\expandafter\endcsname\csname @undefined\endcsname\else' . "\n";
print ' \ClearHook\AtEndOfFiles{}\relax';
print ' {\message{^^J:: \expandafter\string\csname '.$cmd.'\endcsname\space first defined in "\currfilename".^^J}}\fi}}', "\n";
print '\else'. "\n";
print ' {\message{^^J:: \expandafter\string\csname '.$cmd.'\endcsname\space is defined by (La)TeX.^^J}}', "\n";
print '\fi'. "\n";
}
if ($LISTCMD) {
print '\AtBeginOfEveryFile{\message{^^J>> entering file "\currfilename"^^J}}'."\n";
print '\AtEndOfEveryFile{\message{^^J<< leaving file "\currfilename"^^J}}'."\n";
}
if (!$BEFORECLASS) {
print "\\documentclass[$CLASSOPTIONS]{$CLASS}\n";
if ($LISTCMD) {
print '\tracingonline=1\relax'. "\n";
print '\tracingassigns=1\relax'. "\n";
}
foreach my $pkg (@PACKAGES) {
$pkg =~ /^(?:\[(.*)\])?{?(.*?)}?$/;
my ($pkgname,$pkgoptions) = ($2, $1 || '');
print "\\usepackage[$pkgoptions]{$pkgname}\n";
}
{
local $, = "\n";
print @OTHERDEFS, '';
}
unless ($inpreamble || $INPREAMBLE) {
print_versions if $PRINTVERSION;
print '\tracingonline=0\relax'. "\n";
print '\tracingassigns=0\relax'. "\n";
print "\\begin{document}\n";
}
}
else {
if ($LISTCMD) {
print '\tracingonline=1\relax'. "\n";
print '\tracingassigns=1\relax'. "\n";
}
}
}
elsif ($ISCONTEXT) {
foreach my $pkgname (@PACKAGES) {
print "\\usemodule[$pkgname]\n";
}
{
local $, = "\n";
print @OTHERDEFS, '';
}
&special_chars();
print "\\starttext\n" unless $inpreamble || $INPREAMBLE;
}
elsif ($ISTEX) {
foreach my $pkgname (@PACKAGES) {
print "\\input $pkgname \n";
}
{
local $, = "\n";
print @OTHERDEFS, '';
}
&special_chars();
}
foreach my $envc (@ENVCODE) {
my ($envtype,$env) = @$envc;
if ($envtype eq 'environment') {
printf $BEGINENVSTR, $env;
}
elsif ($envtype eq 'before') {
print "$env\n";
}
}
if (!$LISTCMD && $cmd ne $FAKECMD) {
print '\immediate\write0{==============================================================================}%'."\n";
if (length ($cmd) > 1) {
if ($showvalue || $SHOWVALUE) {
print '\immediate\write0{\string\the\expandafter\string\csname ', $cmd, '\endcsname}%'."\n";
print '\immediate\write0{------------------------------------------------------------------------------}%'."\n";
print '\immediate\write0{\expandafter\the\csname ', $cmd, '\endcsname}%'."\n";
} else {
print '\begingroup';
print '\immediate\write0{\expandafter\string\csname ', $cmd, '\endcsname}%'."\n";
print '\immediate\write0{------------------------------------------------------------------------------}%'."\n";
print '\expandafter\endgroup\expandafter\immediate\expandafter\write\expandafter0\expandafter{\expandafter\meaning\csname ', $cmd, '\endcsname}%'."\n";
}
}
else {
if ($showvalue || $SHOWVALUE) {
print '\immediate\write0{\string\the\string\\', $cmd, '}%'."\n";
print '\immediate\write0{------------------------------------------------------------------------------}%'."\n";
print '\immediate\write0{\the\\', $cmd, '}%'."\n";
} else {
print '\immediate\write0{\string\\', $cmd, '}%'."\n";
print '\immediate\write0{------------------------------------------------------------------------------}%'."\n";
print '\immediate\write0{\meaning\\', $cmd, '}%'."\n";
}
}
print '\immediate\write0{==============================================================================}%'."\n";
}
foreach my $envc (reverse @ENVCODE) {
my ($envtype,$env) = @$envc;
if ($envtype eq 'environment') {
printf $ENDENVSTR, $env;
}
elsif ($envtype eq 'after') {
print "$env\n";
}
}
if ($ISLATEX) {
print "\\documentclass[$CLASSOPTIONS]{$CLASS}\n" if $BEFORECLASS;
if ($inpreamble || $INPREAMBLE || $BEFORECLASS) {
print_versions if $PRINTVERSION;
print '\tracingonline=0\relax'. "\n";
print '\tracingassigns=0\relax'. "\n";
print "\\begin{document}\n"
}
print "\\end{document}\n";
}
elsif ($ISCONTEXT) {
print "\\starttext\n" if $inpreamble || $INPREAMBLE;
print "\\stoptext\n";
}
elsif ($ISTEX) {
print "\\bye\n";
}
close ($tmpfile);
select STDOUT;
# Removes all '{' and '}' characters which no real braces.
sub remove_invalid_braces {
$_[0] =~ s/%.*$//; # remove line comments
$_[0] =~ s/\\[{}]//; # remove \{ and \}
}
sub print_orig_def {
my $rmacroname = shift;
my $file = shift;
my $path = shift;
my $found = 0;
open (my $fh, '<', $path) or return;
my $rmacrodef = qr/
^ # Begin of line (no whitespaces!)
(
(?:(?:\\global|\\long|\\protected|\\outer)\s*)* # Prefixes (maybe with whitespace between them)
)
\\(
[gex]?def \s* \\ # TeX definitions
| (?:new|renew|provide)command\s* \*? \s* {? \s* \\ # LaTeX definitions
| (?:new|renew|provide)robustcmd\s* \*? \s* {? \s* \\ # etoolbox definitions
| \@namedef{? # Definition by name only
| Declare[a-zA-z]+ \s* \*? \s* {? \s* \\ # Declare... definitions
| declare[a-zA-z]+ \s* \*? \s* {? \s* \\ # declare... definitions
)
$rmacroname # Macro name without backslash
[^a-zA-Z@]
/xms;
while (my $line = <$fh>) {
if ($line =~ $rmacrodef) {
$found = 1;
print "% $file, line $.:\n";
print $line;
remove_invalid_braces $line;
my $obrace = $line =~ tr/{/{/;
my $cbrace = $line =~ tr/}/}/;
while ($obrace != $cbrace) {
my $line = <$fh>;
print $line;
remove_invalid_braces $line;
$obrace += $line =~ tr/{/{/;
$cbrace += $line =~ tr/}/}/;
}
print "\n";
last;
}
}
close($fh);
return $found;
}
open (my $texpipe, '-|', "$TEX $TEXOPTIONS \"$TMPFILE\" ");
my $name = '';
my $definition = '';
my $errormsg = '';
while (<$texpipe>) {
if (/^::\s*(.*)/) {
my $line = $1;
if ($FINDDEF == 2) {
if ($line =~ /first defined in "(.*)"/) {
my $path = `kpsewhich "$1"`;
chomp $path;
$line =~ s/$1/$path/;
}
}
if ($PRINTORIGDEF) {
if ($line =~ /first defined in "(.*)"/) {
my $file = $1;
my $path = `kpsewhich "$file"`;
chomp $path;
print_orig_def($cmd, $file, $path);
}
elsif ($line =~ /is defined by \(La\)TeX./) {
my $file = 'latex.ltx';
my $path = `kpsewhich "$file"`;
chomp $path;
print_orig_def($cmd, $file, $path);
}
}
else {
print "$line\n";
}
next;
}
if (/^(:TEXDEF:\s*(.*))/) {
my $line = $1;
chomp ($line);
my $text = $2;
while (length $line >= 79) {
$line = <$texpipe>;
chomp ($line);
$text .= $line;
}
print "$text\n";
next;
}
if ($LISTCMD) {
if (/^>> entering file "(.*)"$/) {
push @FILES, $currfile;
$currfile = $1;
push @FILEORDER, $currfile if not exists $DEFS{$currfile};
}
elsif (/^<< leaving file "(.*)"$/) {
$currfile = pop @FILES;
}
elsif (/^{(?:into|reassigning) \s*(.*)}?$/) {
my ($cs, $def) = split (/=/, $1, 2);
$cs =~ s/^\\//;
$def =~ s/\}$//;
if ($LISTCMD > 1 || $cs !~ /[@ ]/) {
if ($def =~ /^\\((?:skip|count|toks|muskip|box|dimen)\d+)$/) {
$ALIAS{$1} = $cs;
}
elsif (exists $ALIAS{$cs}) {
$cs = $ALIAS{$cs}
}
$DEFS{$currfile}{$cs} = $def;
}
}
}
last if /^=+$/;
if ($_ =~ /^!\s*(.*)/ && !$errormsg) {
chomp;
my $line = $1;
$errormsg = $line;
while (length $line >= 79) {
$line = <$texpipe>;
chomp $line;
$errormsg .= $line;
}
}
}
while (<$texpipe>) {
last if /^-+$/;
next if /^$/;
chomp;
$name .= $_;
}
while (<$texpipe>) {
last if /^=+$/;
next if /^$/;
chomp;
$definition .= $_;
if ($_ =~ /^!\s*(.*)/ && !$errormsg) {
$errormsg = $1;
}
}
while (<$texpipe>) {
if ($_ =~ /^!\s*(.*)/ && !$errormsg) {
chomp;
my $line = $1;
$errormsg = $line;
while (length $line >= 79) {
$line = <$texpipe>;
chomp $line;
$errormsg .= $line;
}
}
}
close ($texpipe);
my $error = $? >> 8;
if ($error) {
if ( ($SHOWVALUE || $showvalue) && ($errormsg =~ /^You can't use `.*' after \\the\./) ) {
print STDERR "\n$name:\nError: Given command sequence does not contain a value.\n\n";
}
else {
print STDERR "\n$name:\nCompile error: $errormsg\n\n";
}
next;
}
next if $cmd eq $FAKECMD;
if ($cmd eq $LISTSTR) {
foreach $currfile (@FILEORDER) {
next if not keys %{$DEFS{$currfile}};
print "\nDefined by file '$currfile':\n";
CMD:
foreach my $cmd (sort keys %{$DEFS{$currfile}}) {
next CMD if exists $IGNOREDEF{$cmd};
foreach my $pattern (@IGNOREDEFREG) {
next CMD if $cmd =~ $pattern;
}
print "\\$cmd";
print ": $DEFS{$currfile}{$cmd}" if ($LISTCMDDEF);
print "\n";
}
}
} elsif (!$PRINTORIGDEF) {
print "\n(in preamble)" if $inpreamble;
print "\n$name:\n$definition\n\n";
}
testdef($origcmd,$definition);
}
chdir $cwd;
__END__
|