summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/scripts/ltxfileinfo/ltxfileinfo
blob: 23ea0784f5029044e2a5710818c880c26105d28d (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
#!/bin/bash

<<'LATEX'
= ltxfileinfo - print version information for a LaTeX file

== Synopsis

  ltxfileinfo [options] filename

== Options

  Options:
  -h, --help      print this help
  -d, --date      print file's date only
  -v, --version   print file's version only
  -i, --info      print file's description text only
  -l, --location  print file's full path only (same output as kpsewhich)
  -f, --flat      output as 1 line with 4 tab-separated file, date, version and info fields
  -s, --star      mark mal-formatted data with a star
  -c, --color     mark mal-formatted data with red color (ANSI coloring)

== Description
\B{ltxfileinfo} displays version information for LaTeX files. If no path
information is given, the file is searched using kpsewhich. As an extra,
for developers, the script will (use the |--star| or |--color| options)
check the valididity of the |\Provides...| statement in the files.
The script uses code from Uwe Lück's |readprov.sty|.

Without an option, the output will be of the form:

  $ ltxfileinfo ctable.sty
  name: ctable.sty
  date: 2012/08/23
  vers: v1.24
  info: Easy, key=value directed, option-rich, typesetting of floats
  loca: /usr/local/texlive/2012/../texmf-local/tex/latex/ctable/ctable.sty

Missing information is represented by |--|:

  $ ltxfileinfo yhmath.sty
  name: yhmath.sty
  date: --
  vers: --
  info: --
  loca: /usr/local/texlive/2012/texmf-dist/tex/latex/yhmath/yhmath.sty

\B{ltxfileinfo} tries to detect (and report) mal-formatted dates and versions; 
use the |--star| option to mark such fields with a star, of use the |--color|
option to color invalid fields red, if you work in a terminal with ANSI-coloring
capabilities.
These options are useful for developers
who want to check the correctness of their |\Provides...| statements.
For example:

  $ ltxfileinfo -s arfonts.sty
  file: arfonts.sty (ARfonts.sty*)
  date: 2006/01/01
  vers: --*
  info: Part of the Arabi package
  loca: /usr/local/texlive/2012/texmf-dist/tex/latex/arabi/arfonts.sty

We see here, that the |\ProvidesPackage| statement has an incorrect first
argument and has no version information.

== Other output formats
With the |--date| option, only the file's date will be shown, unlabeled.
The |--version|, |--location|, |--info| options are treated analogously.

  $ ltxfileinfo -v chronology.sty
  v1.0

The |--flat| option prints the fields (except loca:, the last field) on one
line, unlabeled and tab-separated:
 
  $ ltxfileinfo --star --flat chronology.sty
  chronology.sty        2010/6/12*      v1.0    Horizontal timeline

The date is starred, because its format is not yyyy/mm/dd (and the |--star|
option is given.)

== Bugs

On my system, I have a total of 8699 kpsewhich-detectable files that contain a |\Provides...| statement. 
I ran them all through |ltxfileinfo| and made the following summary of detected errors:

  8695  Total \Provides... containing files tested 
  
   660  \Provides... could not be interpreted; reason:
        160  Argument of \Provides... not equal to file's name
          8  Latex3 package (not handled yet)
        480  Unidentified problem with \ProvidesPackage statement
         12  \Provides... used in file without a ... extension
  
  8035  Files could be evaluated
        482  had no date
         95  had a mal-formatted date 
       2666  had no version
        357  had a mal-formatted version
        765  had a \Provides... first argument different from the filename

The .dtx files have more problems than other files:

  1345  .dtx files:
  
   320   \Provides... could not be interpreted; reason:
         81  Argument of \Provides... not equal to...
          6  Latex3 package (not handled yet)
        233  Unidentified problem with \ProvidesPackage statement
  
  1025  Files could be evaluated
         49  had no date
         15  had a mal-formatted date 
         99  had no version
         52  had a mal-formatted version
        468  had a \Provides... first argument different from the filename
LATEX

VERSION=2.00
MYNAME=`basename $0`

# print error message, remove temporary files, and exit
function die {
   echo "$arg     `mark error:` $*"
   exit 1
}

function help {
   cat <<-EOF
	This is ltxfileinfo version $VERSION

	ltxfileinfo [options] filename
	
	Options:
	-h, --help      print this help
	-d, --date      print file's date only
	-v, --version   print file's version only
	-i, --info      print file's description text only
	-l, --location  print file's full path only (same output as kpsewhich)
	-f, --flat      output as 1 line with 4 tab-separated file, date, version and info fields
	-s, --star      mark improvements with respect to nicefilelist.sty with a star
	-c, --color     mark improvements with respect to nicefilelist.sty with red color
	-D, --debug     don't remove temporary files 
	EOF
}

# remove leading and trailing whitespace from a string
function trim {
   local var="$*"
   var="${var#"${var%%[![:space:]]*}"}"   # remove leading whitespace
   var="${var%"${var##*[![:space:]]}"}"   # remove trailing whitespace
   echo -n "$var"
}

# mark a string by appending a * (--mark star)
function mark {
   echo "$mark1$*$mark2"
}

# special treatment for .mbs and .bst files:
function dombsbst {
   # look at the first \ProvidesFile only:
   out="File: "`grep '\\ProvidesFile{' $loca |head -1 |sed 's/^[ %]*\\\\ProvidesFile{//;s/}\[/ /;s/\]$//'`
}

# unpack the fields
function extract {
  shift # remove File:
  file=$1
  shift # remove filename
  if [ "$1" = "" ]; then
     date=--; vers=--; info=--; return
  elif [[ "$1" =~ ^[0-9]+/[0-9]+/[0-9]+ ]]; then
     date=$1
     shift
  else
     date="--"
  fi
  if [ "$1" = "" ]; then
     vers=--; info=--; return
  elif [[ "$1" =~ ^v?[[:digit:]][.[:digit:]]+[a-z]* ]]; then
     vers=$1
     shift
     info="${*:---}"
     return
  else
     fixed=
     # sometimes the version is of the form v.1.3 or vers:1.3 or such:
     for i in version ver. ver: ver v. V v; do
        if [[ $1 =~ $i[[:digit:]][.[:digit:]]*[a-z]* ]]; then
           vers=$1
           shift
           fixed=1
           break
        fi
     done
     if [ ! $fixed ]; then
        # sometimes the version is reported as "v 1.3" or "vers: 1.3" or such:
        for i in version ver: ver v. V v; do 
           if [ $1 = $i ]; then
              if [[ "$2" =~ [[:digit:]][.[:digit:]]+[a-z]* ]]; then
                 vers="$1 $2"
                 shift
                 shift
                 fixed=1
                 break
              fi
           fi
        done
     fi
     info="${*:---}"
     if [ ! $fixed ]; then
        vers=--
     fi
  fi
}

# display the results
function display {
   # file should be equal to arg (the argument)
   test $file != $arg && file="$arg (`mark $file`)"
   
   # to be correct, date must be of the form yyyy/mm/dd
   if [[ ! "$date" =~ ^[[:digit:]]{4}/[[:digit:]]{2}/[[:digit:]]{2}$ ]]; then
      date=`mark $date`
   else
      # also, the number must be valid:
      if [ "$( date -d "$date" +%arg 2>&1 | grep invalid )" != "" ] ; then
         date=`mark $date`
      fi
   fi
   
   # version should be 1.2 or 1.2.3, maybe prefixed with v and suffixed with zero or more lower case letters
   if [[ ! "$vers" =~ ^v?[[:digit:]]+.[[:digit:]]+(.[[:digit:]]+)?[[:lower:]]*$ ]]; then vers=`mark $vers`; fi
   
   if [ ! "$key" ]; then
      if [ $flat ]; then 
         echo -e "$file\t$date\t$vers\t$info"
      else
         cat <<-EOF
	file: $file
	date: $date
	vers: $vers
	info: $info
	loca: $loca
	EOF
      fi
   else
      eval "echo \$$key"
   fi  
}

if ! options=$(getopt -o hdvlifcsDI \
                      -l help,date,version,location,info,flat,star,color,debug -- "$@"); then exit 1; fi
eval set -- "$options"

while [ $# -gt 0 ]; do
   case $1 in
   -h|--help)     help; exit 0;;
   -d|--date)     key=date;;
   -v|--version)  key=vers;;
   -i|--info)     key=info;;
   -l|--location) key=loca;;
   -f|--flat)     flat=1;;
   -s|--star)     mark1=''; mark2='*';;
   -c|--color)    mark1=''; mark2='';;
   -D|--debug)    debug=1;;
   -I)            instscript $MYNAME; exit 0;; # not for general use
   (--)           shift; break;;
   (*)            break;;
   esac
   shift
done

arg=$1
test "$arg" = "" && help
loca=`kpsewhich "$arg"`
test "$loca" = ""                                       && die not found by kpsewhich
prov=`grep '\\\\Provides' "$loca"`
test "$prov" = ""                                       && die no \\Provides...
test "$prov" = "${prov/ProvidesExplPackage//}"          || die 'Latex3 package (not handled yet)'

# the file must contain a \ProvidesXXX statement, where XXX is Class, Package, or File:
for i in Class Package File; do 
   if [[ "$prov" =~ \\Provides$i[[:space:]]*\{ ]]; then found=1; break; fi
done
test $found || die Found no \\ProvidesClass/Package/File statement

# readprov.sty does not work on .mbs and .bst files: special treatment;
# \ProvideFile statements in them mostly refer to merlin.mbs, or other names
if [[ $arg =~ \.mbs$ || $arg =~ \.bst$ ]]; then dombsbst; fi

DIR=`mktemp -d`
test $debug || trap "rm -rf $DIR" 0 1 2 15
test $debug && echo $DIR
cp "$loca" $DIR
cd $DIR

# The following code is mostly from Uwe Lueck's readprov.sty:
echo '
\makeatletter
\def\GetFileInfo#1{%
  \def\filename{#1}%
  \def\@tempb##1 ##2 ##3\relax##4\relax{%
    \def\filedate{##1}%
    \def\fileversion{##2}%
    \def\fileinfo{##3}}%
    \read@file@info\@tempb{#1}} 
\newcommand*{\read@file@info}[2]{%
  \expandafter \expandafter \expandafter
    #1\csname ver@#2\endcsname \relax? ? \relax\relax}
\newcommand*{\ReadFileInfos}[1]{%
  \begingroup
    \let\RP@@provfile\@providesfile
    \def\@providesfile##1[##2]{\RP@@provfile{##1}[{##2}]\endinput}%
    \def\ProvidesClass  ##1{\ProvidesFile{##1.\@clsextension}}%
    \def\ProvidesPackage##1{\ProvidesFile{##1.\@pkgextension}}%
    \@for\@tempa:=#1\do{%
      \edef\@tempa{\expandafter\read@no@spaces\@tempa\@nil}%
      \input{\@tempa}%
      \global\let\@gtempa\@tempa}%
  \endgroup
  \GetFileInfo\@gtempa%
}
\def\read@no@spaces#1#2\@nil{#1#2}%
\def\NeedsTeXFormat#1{\expandafter\@needsformat}
\ReadFileInfos{'$loca'}
\endinput
' > ltxfileinfo.tex

pdflatex -interaction=batchmode ltxfileinfo.tex >& /dev/null

IFS= # do not remove any whitespace
base=${arg%.*} # strip the extension
shopt -s nocasematch # MS people don't pay attention to case differences in file names...
while read line; do
   if [[ "$line" =~ ^File:.$base ]]; then 
      out="$line"
      while [ ${#line} -eq 79 ]; do # gather continuation lines
         read line
         out="$out$line"
      done  
   fi
done <ltxfileinfo.log
IFS=' '			# back to 
shopt -u nocasematch	# normal

# if the \Provides statement is not recognized, try to find out why, and die:
if [ "$out" = "" ]; then
   read -r provtype provarg <<<`sed -n '/\\Provides\(Class\|Package\|File\)\s*{[^}]*}/s/.*\(Class\|Package\|File\)\s*{\([^}]*\)}.*/\1 \2/p' "$loca"`
   if [[ "$provarg" = "" || "$provarg" =~ '\\' ]]; then die Unidentified problem with \\ProvidesPackage statement; fi
   case $provtype in
   Package) 
     if [[ ! "$arg" =~ \.(sty|dtx)$ ]]; then
       die \\ProvidesPackage used in file without a .sty extension
     elif [[ "$provarg" =~ \.sty$ ]]; then
       die "Argument of \\ProvidesPackage ($provarg) should not contain .sty extension"
     elif [ "$provarg" != "$base" ]; then
       die "Argument of \\ProvidesPackage ($provarg) not equal to file's base name ($base)"
     else
       die Unidentified problem with \\ProvidesPackage statement
     fi
     ;;
   Class)
     if [[ ! "$arg" =~ \.(cls|dtx)$ ]]; then
       die \\ProvidesClass used in file without a .cls extension
     elif [[ "$provarg" =~ \.cls$ ]]; then
       die "Argument of \\ProvidesClass ($provarg) should not contain .cls extension"
     elif [ "$provarg" != "$base" ]; then
       die "Argument of \\ProvidesClass ($provarg) not equal to file's base name ($base)"
     else
       die Unidentified problem with \\ProvidesPackage statement
     fi
     ;;
   File)
     if [ "$arg" != "$provarg" ]; then
       die "Argument of \\ProvidesFile ($provarg) not equal to file's name ($arg)"
     else
       die Unidentified problem with \\ProvidesPackage statement
     fi
     ;;
   *)
     die Found \\Provides$provarg statement - cannot handle it
     ;;  
   esac
fi

extract $out
display
exit 0

# template for README file:
<<'README'
This is release %VERSION% of the ltxfileinfo script
License: GPL

Short description:
ltxfileinfo is a bash script; it prints information about a latex class,
style and other files to standard output.
The script is based on Uwe Lueck's readprov.sty, so it prints information
only for files that contain a \ProvidesFile, \ProvidesClass or
\ProvidesPackage statement.
The script tries to correct errors in these \Provides... statements and it
has options, useful for developers, to make errors in those statements visible.

Usage example:

$ ltxfileinfo article.cls
name: article.cls
date: 2007/10/19
vers: v1.4h
info: Standard LaTeX document class
loca: /usr/local/texlive/2009/texmf-dist/tex/latex/base/article.cls

major changes of release %VERSION% relative to 1.1
- completely rewritten as a bash script, using code from readprov.sty
- now also can evaluate xelatex oriented files
- can now handle any LaTeX file containing a \Provides... statement
- options for \Provides... statement validation
README