summaryrefslogtreecommitdiff
path: root/support/texref/texref
blob: 950a87553bfe1dc7d8b969287e2899da90aafd5a (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
#! /usr/local/bin/perl

$VERSION=1.01;  # 12 Sep 1999 13:57:21
use vars qw($VERSION);

$Author='Michael Friendly (friendly@yorku.ca)';    # Copyright 1999
$License = 'LPPL';      # released under the LPPL license

########################################################################
# texref: a Perl script for finding cross-refs in a LaTeX file

# texref reads a .tex file, and (recursively) all \input{} and
# \include{} files referenced therein, collecting the names of all
# \labels and \*ref{}s as it goes.  It then prints the list of labels
# together with information about where those labels are referenced
# in the .tex file(s).

# Pretty documentation: run pod2man or pod2text on this script,
# or just read the documentation after __END__

# A C/C++ program of the same name was written by Maurizio Loreti
# <maurizio.loreti@pd.infn.it> and is available by ftp at
# cmssun1.pd.infn.it/pub/MLO/texref.tar.gz

# Changes:
# 1.00  Initial version. [Thanks to Bernd Schandl
#       <bschand@math.clemson.edu> for suggestions.]
# 1.01  Added $opt_sortby = input, and made it the default.
###################### Start of configuration ######################

$opt_aux       = 1;           # Search .aux files for extended label info
$opt_sort      = 1;           # Sort labels
$opt_sortby    = 'input';     # Sort by label|def|input
$VERBOSE       = 0;           # Lots of messages...

# How to search for files on the various TeX paths:

# If teTeX is installed, use kpsetool to locate tex/bst/sty files before
# trying the TEXINPUTS path, for efficiency.
$KPSEWHICH     = '/usr/local/teTeX/bin/kpsewhich';   # won't fail if not -x
# Otherwise, uncomment the following statement
#undef $KPSEWHICH;

$TEXINPUTS = "TEXINPUTS";     # Name of TEXINPUTS environment variable

# These patterns are currently NOT USED.  Why don't they work when used
# in get_xrefs?
# Patterns for include-type statements, leaving filename in #1
$include_pat = join('|',
      ('\\input\b\{?(\S+)\}',
       '\\include\s*\{(\S+)\}'
      ));

# Patterns for references to a label, leaving label in $1
$ref_pat = '\\[a-z]*ref\{([^}]+)\}';       # pattern for single ref

$refs_pat = '\\[a-z]*refs\{([^}]+)\}';     # pattern for multiple refs

$ref_range = '\\[a-z]*range\{([^}]+)\}\{([^}]+)\}';  # for ref range

###################### End of configuration ######################

######################### Initializations ########################

# remove path from our name

   $progname = $0;
   $progname =~ s@(.*)/@@i;

    $in_preamble = 1;
    @labels = ();

################## get and process command options ###############

    use Getopt::Long;
    $result = GetOptions ('aux!', 'help', 'match=s', 'out=s', 'sort',
        'sortby=s', 'unref', 'verbose');

    &usage() if $opt_help;        # and exit

    if ($opt_out) {
        open(STDOUT, ">$opt_out") or die "$progname: -out $opt_out: can't create.\n";
    } else {
        select(STDOUT); $| = 1;
    }


    $VERBOSE=1 if $opt_verbose;

    $texfile = $ARGV[0] || &usage(); # usage doesn't return
    shift;

########################################################################
# Split the tex filename up into a path, name, and extension
#
($TEXFILEPATH,$TEXFILENAME,$TEXFILEEXT) = &splitfn($texfile,".tex");

########################################################################
# Locate the requested TeX file.  It's either in the current (or
# specified) directory or no path was specified and it's on the
# TEXINPUTS path.
#
$Qtexfile   = &cleanup_texfilename($texfile);
if (! -e $Qtexfile  ) {
    if ($texfile !~ /[\/\\]/) { # no path...
   $Qtexfile   = &find_on_path("$ENV{$TEXINPUTS}", "$texfile", 'tex');
   $Qtexfile   = &find_on_path("$ENV{$TEXINPUTS}", "$texfile".".tex", 'tex')
       if $Qtexfile   eq "";
   die "Cannot find \"$texfile\[.tex\]\" on $TEXINPUTS path.\n"
       if $Qtexfile   eq "";

   $texfile = $Qtexfile  ;
    } else {
   die "Cannot find \"$texfile\[.tex\]\".\n";
    }
} else {
    $texfile = $Qtexfile;
}

# Main
&get_xrefs($texfile);

if ($opt_aux) {
    &find_auxfiles($TEXFILENAME);
    print "Found AUX files: ", @aux, "\n" if $VERBOSE;

    unshift (@aux, $TEXFILENAME) unless $AUXSEEN{$TEXFILENAME . '.aux'};
    foreach (@aux) {
        &parse_auxfile($_);
    }
}

#print "labels:\n", join(' ', @labels), "\n";

if ($opt_sort) {
    @keys = ($opt_sortby =~ /label/) ?
        (sort keys %label_def) :
		  ($opt_sortby =~ /def/) ?
        (sort {$label_def{$a} cmp $label_def{$b} }keys %label_def) :
		  @labels;
}
else {
    @keys = keys %label_def;
}
foreach (@keys) {
    $lab = $_;
    if ($opt_match) {
        next unless $lab =~ m%$opt_match%;
    }
    if ($label_ref{$lab}) {
    print "$lab\t($label_def{$lab}): ", join(', ',@{$label_ref{$lab}}),"\n" unless $opt_unref;
#    print "$lab\t($label_def{$lab}): @{$label_ref{$lab}}\n" unless $opt_unref;
    }
    else {
    print "$lab\t($label_def{$lab}): UNREF\n";
    }
}


exit;

########################################################################
# Parse the TeX file looking for \label and \ref.  Build the
# hashes %label_def and %label_ref to hold the definitions and
# references.

sub get_xrefs {
	local($texfile) = @_;
	local($in_preamble,$p,$lineno);
	local(*TEXFILE);

	open (TEXFILE, $texfile) || die "Can't read $texfile.\n";

	$lineno=0;
	while (<TEXFILE>) {
		chop;
		$lineno++;
		s/%.*//;                               # decomment
		last if /\\endinput/;                  # are we done?

		if (/\\begin\s*\{document\s*\}/) {
			$in_preamble = 0;
		}
		next if $in_preamble;

		if (m#\\label\{([^}]+)\}#) {
			next if $1 =~ m/\#\d/;      # avoid tex command defs
			push(@labels, $1) unless $seen{'LABEL' . $1}++;
			$label_def{$1} = "$texfile $lineno";
			}

		# parse different kinds of references, store info in $label{$key}
		while (m#\\[a-z]*ref\{([^}]+)\}#g) {
			$ref = $1;
			next if $ref =~ m/\#\d/;      # avoid tex command defs
			push @{ $label_ref{$1} }, "$texfile $lineno";
			}

		# multiple refs: \refs{fig:one,fig:two} --> $1
		while (m#\\[a-z]*refs\{([^}]+)\}#g) {
			@refs = split(',',$1);
			foreach $ref (@refs) {
				next if $ref =~ m/\#\d/;      # avoid tex command defs
				push @{ $label_ref{$ref} }, "$texfile $lineno";
				}
			}

		# range refs: \figrange{fig:one}{fig:two} --> $1 $2
		while (m#\\[a-z]*range\{([^}]+)\}\{([^}]+)\}#g) {
			@refs = ($1, $2);
			foreach $ref (@refs) {
				next if $ref =~/#\d/;      # avoid tex command defs
				push @{ $label_ref{$ref} }, "$texfile $lineno";
				}
			}

		# Search recursively in included files
		if (m#\\(input|include)\b\{?([/\w\d.]+)#) {
			$p = $2;
			$p .= '.tex' unless $p =~ /\.tex$/;
			if ($opt_expand) {
				$fullname = &find_on_path($ENV{"$TEXINPUTS"}, $p, 'tex');
				if ($fullname ne "" && -r $fullname) {
						$p = $fullname;
				}
			}
			if (-r $p) {
				print STDERR "Recursing into $p\n" if $VERBOSE;
				&get_xrefs($p);
			}
		}
  }

  close (TEXFILE);
}

########################################################################
# Parse a TeX .aux file looking for \newlabel.  Append the label number
# and page location to the %label_def entry.

sub parse_auxfile {
    my ($texfilename) = shift;
    local ($auxfile) = &auxfile($texfilename, "aux");
    local ($rest, $curfile);
    if (-r $auxfile) {
      print STDERR "Reading $auxfile ..." if $VERBOSE;
        open (AUXFILE, $auxfile);
        while (<AUXFILE>) {
            chop;

            if (/\\newlabel\{([^{}]+)\}/) {
                local ($label, $number, $page, $def);
                $label = $1;
                $rest = $';
                $rest =~ s/[{}]/ /g;
                ($number, $page) = split(' ', $rest);
                $def = $label_def{$label} . " #$number P$page";
                $label_def{$label} = $def;
            }
       }
    close (AUXFILE);
    print STDERR "done\n" if $VERBOSE;
    }
}

########################################################################
# Cleanup the TeX filename.  Add the extension ".tex" if it doesn't
# already have an extension.
#
sub cleanup_texfilename {
  local($texfile) = @_;
  local($path,$base,$ext) = &splitfn($texfile,".tex");

  $ext = "tex" if ($ext eq "");
	$path = "" if $path eq './';
  $path . $base . "." . $ext;
}

########################################################################
# This helpful little routine locates a file on a TeX path.  The path can
# be ":" or ";" delimited.  If the file is found, it's fully qualified
# name is returned, otherwise the null string is returned.  If the
# input path contains "/" or "\" then either it is returned (if the file
# specified exists) or the empty string is returned, the path _is not_
# searched.
#
sub find_on_path {
    local($path, $file, $type) = @_;
    local($dir, $filename);

    $filename = "";

    if ($KPSEWHICH && -x $KPSEWHICH) {
       chop($filename = `$KPSEWHICH $type $file`);
         #print "kpse: $filename\n";
      $filename = "" if $filename =~ /not found/;
    }

   unless ($filename) {
    if ($file =~ /\/|\\/) {
   $filename = $file if -e $file;
    } else {
   foreach $dir (split(/;|:/,$path)) {
        #print "looking for $file in $dir\n";
       $dir =~ s/\\/\//g;
       $filename = $dir . "/" . $file;
       last if -e $filename;
       $filename = "";
   }
    }
    }
    $filename;
}

########################################################################
# Break a filename into it's path, basename, and extension components.
# The path returned always ends with a slash.  "./" is returned if the
# file has no path.  If the filename passed in does not exist, the
# default extension passed in is tried (actually, is assumed to be
# correct).
#
sub splitfn {
  local ($filename, $defext) = @_;
  local ($path, $basename, $ext) = ("", "", "");

  $filename =~ tr/\\/\//;    # translate \ into /

  $filename = $filename . $defext if ! -r $filename;

  if ($filename =~ /\//) {
    ($path = $filename) =~ s/\/[^\/]*$//;
    ($basename = $filename) =~ s/.*\///;
    }
  else {
    $path = ".";
    $basename = $filename;
  }

  if ($basename =~ /\./) {
    ($ext = $basename) =~ s/.*\.//;
    $basename =~ s/\.[^.]*$//;
  }

  ($path . "/",$basename,$ext);
}

sub find_auxfiles {
    my ($texfilename) = shift;
    # look for new aux files...
    local ($curfile);
    local ($logfile) = &auxfile($texfilename, "log");

    if (-r $logfile) {
      print STDERR "Reading $logfile ..." if $VERBOSE;
   open (LOGFILE, $logfile);
   while (<LOGFILE>) {
        chop;
        while (/\(([^\s]+\.aux)\)/g) {
            $curfile = $1;
            push (@aux, $curfile) unless $AUXSEEN{$curfile}++;
        }
   }
    close (LOGFILE);
    print STDERR "done\n" if $VERBOSE;
    }
}

########################################################################
# Input: an extension, `ext'
# Output: the filename $TEXFILENAME . `.ext'
# Note: auxilliary files are always placed in the current directory,
# the path is ignored.
#
sub auxfile {
    local($texfilename, $ext) = @_;
    local($dot)='';
    $dot = "." if $ext ne "" && $ext !~ /^\./;
    return ($texfilename =~ /$dot$ext/) ?
        $texfilename :
        $texfilename . $dot . $ext;
}


########################################################################
#
sub usage {

  print <<"EOF";
Find LaTex cross references, Version: $VERSION, $Author
Usage: $progname <options> texfile[.tex]
  where <options> may be abbreviated to unique truncations, and are:
   -aux|noaux          do (dont) find & read .aux file(s) for label #, page
   -help               print this measly help
   -match=regexp       regexp to select labels printed
   -out=filename       send output to a file
   -sort|nosort        do (dont) sort the labels
   -sortby=label       if sorting, sort by the label string
          =def           by label def string
   -unref              print only unreferenced labels
   -verbose            lots of messages
EOF

  exit 1;
}
__END__

=head1 NAME

texref - Find cross-references for a LaTeX file

=head1 SYNOPSIS

B<texref>
[B<-(no)aux>]
[B<-help>]
[B<-match> I<regexp>]
[B<-out> I<filename>]
[B<-(no)sort>]
[B<-sortby label|def|input>]
[B<-unref>]
[B<-verbose>]
I<file>[.tex]

=head1 DESCRIPTION

B<texref> reads a .tex file, and (recursively) all \input{} and
\include{} files referenced therein, collecting the names of all
\labels and \*ref{}s as it goes.  It then prints the list of labels
together with information about where those labels are referenced
in the .tex file(s).

References to labels are recognized as commands of the form

   \[a-z]*ref{key}

This allows for custom LaTeX referencing commands, such as

   \newcommand{figref}[1]{Figure~\ref{#1}}

as well as the varioref package, which uses the \vref{key} command.
In addition, the program recognizes lists of references, encoded
as commands of the form,

   \[a-z]*refs{key1,key2,key3}

which expand to something like 'Figure 1, Figure 2, and Figure 3'.
These could be provided by the LaTeX commands

   \newcommand{\figrefs}[1]{\dorefs{#1}{Figures}}
   \newcommand{\tabrefs}[1]{\dorefs{#1}{Tables}}
   \newcommand{\exrefs}[1]{\dorefs{#1}{Examples}}
   \makeatletter
   \newcommand{\dorefs}[2]{%
      \let\@dummy\@empty
      #2~%
      \@for\@term:=#1\do{%
         \@dummy
         \edef\@dummy{\ref{\@term}, }}%
      \expandafter\format@last\@dummy}
   \def\format@last#1, {and #1}
   \makeatother

Finally, the program recognizes reference ranges, like \figrange{key1}{key3}
which expand to 'Figure 1--3', from commands like

   \newcommand{\figrange}[2]{Figures~\ref{#1}--\ref{#2}}
   \newcommand{\tabrange}[2]{Tables~\ref{#1}--\ref{#2}}


Labels are described by the filename and line number where they
are defined;  if the B<-aux> option is in effect, the corresponding
I<.aux> files are also read (\newlabel{} lines) to obtain the label
number and the page location in the document, assuming the file
has been processed by LaTeX.


=head1 OPTIONS AND ARGUMENTS

All options may be abbreviated to their unique truncations, so B<-h>, B<-he>,
B<-hel> all print help.
Options which take an argument may be followed by a blank or '='.
Those values may need to be quoted if they contain characters interpreted
by your shell.

=over 4

=item B<-aux> | B<-noaux>

If the B<-aux> option is in effect, the .log file is read to find
the I<.aux> files corresponding to the .tex file.  Then, each .aux
file is read (looking for \newlabel{} lines) to obtain the label
number and the page location in the document.  This assumes that
the .tex file has been processed by LaTeX so that the information
in the .aux files is up to date.  The default is B<-aux> (unless
changed in the configuration section).

=item B<-help>

Print a brief help message and exit.

=item B<-match>S< >I<rexexp>

Print only the labels which match the I<rexexp>.  If you use systematic
labels (e.g., fig:name for figures, sec:name for sections, etc.)
B<-match> 'fig:' will select only figure labels, etc.  Use a pipe to grep to
select more finely (e.g., to find figure labels in Chapter 4).

=item B<-out>S< >I<filename>

Send the output to a named file rather than to STDOUT.

=item B<-sort> | B<-nosort>

Sort (or do not sort) the labels in the output.  If sorting, the sort
order can be set by the B<-sortby> option.  If not sorting, the
order in the output is apparently haphazard (the order of perl keys
for a hash).

=item B<-sortby>S< >[label|def|input]

If sorting, B<-sortby>=label means that the output is sorted by the
label string.  B<-sortby>=def means that the output is sorted by
the label definition string, which normally looks line

  filename linenumber labelnum pagenum

B<-sortby>=input (the default) simply lists the labels in the order
encountered in the input file(s).  This order is easiest to use
for resolving unreferenced labels.
 
=item B<-unref>

If specified, only labels for which no corresponding \*ref references
have been found are printed.

=item B<-verbose>

Lots of messages, written to STDERR.

=back 4

=head1 EXAMPLES

To show the output format, the following command uses all defaults:

   % texref drew
   sec:mosaic      (drew.tex 186 #2 P2): drew.tex 137
   eq:pij  (drew.tex 212 #1 P2): UNREF
   tab:hairdat     (tab/hairdat.tex 3 #1 P3): drew.tex 222, drew.tex 455
   fig:mosaic3i    (drew.tex 248 #1 P3): drew.tex 231, drew.tex 234
   fig:mosaic34    (drew.tex 306 #2 P5): drew.tex 282, drew.tex 311, drew.tex 322, drew.tex 486
   eq:pijkl        (drew.tex 344 #2 P5): drew.tex 348
    ...

To print only unrefereced labels:

    % texref -unr drew
    eq:pij  (drew.tex 212 #1 P2): UNREF

=head1 LIMITATIONS

The program is tuned to LaTeX, not TeX.

It does not handle references to subfigures, as provided by the
subfigure and subfigmat packages.

There is no -undef option to print labels which are referenced but not
defined.  But you did catch these when you LaTeX'd your file, right?

The output format is inflexible.

=head1 BUGS

Sorting by def sorts the label definitions as strings, so 'myfile 1020'
appears before 'myfile 723', which appears before 'myfile 9'.



=head1 SEE ALSO

ftp://cmssun1.pd.infn.it/pub/MLO/texref.tar.gz

texdepend: CTAN support/texdepend

texfind: CTAN support/texfind

=head1 AUTHOR

Michael Friendly <friendly@yorku.ca>

=head1 LICENSE

B<texref> is distributed under the terms of the LaTeX Project Public
License (LPPL).  This means that you may freely copy or distribute this
software, but if you modify it and distribute it (even locally) you must
change the name to avoid confusion.
See: CTAN:: help/Catalog/Licenses.html.