lib/chkconfig.ltx

   1 % This is chkconfig.ltx, a script which tries to autodetect and
   2 %    document your LaTeX configuration.
   3 % Author: Jean-Marc Lasgouttes (Jean-Marc.Lasgouttes@inria.fr)
   4 % with minimal changes by Asger Alstrup (alstrup@diku.dk).
   5 %
   6 % This script should only be run from the configure script to update
   7 % the files textclass.lst and doc/LaTeXConfig.lyx
   8 %
   9 % This script is in fact a complete rewrite of the original chkconfig
  10 % script. Expect bugs.
  11
  12 %%% If you want to add new packages/documentclasses to be recognized,
  13 %%% read the explanation that follow and jump to the section 'Actual
  14 %%% inspection code' below. You do not need to understand the ugly
  15 %%% LaTeX code below to help improving chklatex.ltx :-)
  16 %%%
  17 %%% If you want to add the new package <name>, all you need most of
  18 %%% the times is a two-steps work:
  19 %%% 1- Add the command \TestPackage{<name>}. The syntax is:
  20 %%%    \TestPackage[<file>]{<name>}, which  tests whether <name>.sty
  21 %%%    (or <file>, if this optional parameter is provided) exists.
  22 %%% 2- Add a description for <name> in doc/LaTeXConfig.lyx.in,
  23 %%%    containing in particular a line like
  24 %%%         Found   @chk_<name>@
  25 %%%    This line will be replaced at configure time by the proper text.
  26 %%%
  27 %%% For document classes, things are even simpler, since you do not
  28 %%% need to edit this file. Just put your layout file in some place
  29 %%% where LyX can find it and add if you wish a description in
  30 %%% LaTeXConfig.lyx.in, as described above.
  31
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  33 %%%%%%%%%%%%%%%%%%%%%%% Initialization part (skip) %%%%%%%%%%%%%%%%%%%%%
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35
  36 % we do not want to stop on errors
  37 \nonstopmode\makeatletter
  38 % Have we been called from the configure script?
  39 \@ifundefined{srcdir}
  40  {\message{%
  41 **** WARNING: For proper results, you should not run this script directly.^^J%
  42 **** Please use the `configure' script.^^J}
  43   \newcommand\srcdir{.}}
  44  {\def\input@path{{\srcdir/}}}
  45
  46 %%% Some useful macros.
  47 %   Several commands are defined to test for packages:
  48 %    \AddLayout{<layout>} adds an entry for <layout> in textclass.lst
  49 %    \AddVariable{<name>}{<value>} creates a new variable chk_<name>,
  50 %      and gives it the value <value>.
  51 %    \TestDocClass[<file>]{<name>} tests whether <name>.cls (or <file>,
  52 %      if it is provided) exists and creates a new entry with
  53 %      \AddLayout if this is the case. Note that you will probably not
  54 %      need to use this directly, since the configure script generates
  55 %      the needed macro calls automatically.
  56 %    \TestPackage[<file>]{<name>} tests whether <name>.sty (or <file>,
  57 %      if it is provided) exists.
  58 %   Both commands call \AddVariable to give value 'yes' or 'no' to
  59 %   the variable chk_<name>.
  60 %%%
  61 \newcommand{\prefix}{+} % the character used by grep to filter 'good' output
  62 \newcommand{\AddLayout}[3][\default]{
  63   \def\default{#2}
  64   \immediate\write\layouts{"#2"   "#1"   "#3"}}
  65 \newcommand{\AddVariable}[2]{
  66   \immediate\write\sed{s!@chk_#1@!#2!g}
  67   \immediate\write\vars{chk_#1='#2'}}
  68 \newcommand{\AddPackage}[1]{
  69   \immediate\write\packages{#1}}
  70 % Tests whether an item is present
  71 % Syntax: \TestItem{<file>}{<name>}{<type>}{<ext>}{<iftrue>}{<iffalse>}
  72 \newif\ifexists
  73 \newcommand{\TestItem}[6][\default]{
  74   \def\default{#2}
  75   \def\files{#1}
  76   \message{^^J\prefix checking for #3 #2 [#1]...}
  77   \let\firstelement\relax
  78   \existstrue
  79   \@for\file:=\files\do{
  80     \ifx\firstelement\relax
  81        \edef\firstelement{\file}
  82     \fi
  83     \IfFileExists{\file}
  84       {}
  85       {\IfFileExists{\file.#4}{}{\existsfalse}}
  86   }
  87   \ifexists
  88     \message{yes^^J}
  89     \AddVariable{#2}{yes}
  90     #5
  91   \else
  92     \message{no^^J}
  93     \AddVariable{#2}{no}
  94     #6
  95   \fi}
  96 \newcommand{\TestPackage}[2][\default]{
  97   \TestItem[#1]{#2}{package}{sty}{\AddPackage{#2}}{}}
  98 \newcommand{\TestDocClass}[1]{
  99    \def\layoutname{#1}  % remember the name of the layout file
 100    \@ifundefined{layout@#1}
 101      {\bgroup
 102         \catcode`\#=9  % consider # as a space
 103         \input{layouts/#1.layout}  % read the layout file
 104       \egroup
 105       \global\@namedef{layout@#1}{}}
 106      {} % we have already tried this one.
 107 }
 108 \newcommand{\DeclareLaTeXClass}[2][\default]{
 109   \TestItem[#1]{\layoutname}{document class}{cls}
 110            {\AddLayout[\firstelement]{\layoutname}{#2}}{}
 111   \expandafter\endinput
 112 }
 113 \newcommand{\DeclareLinuxDocClass}[2][\default]{
 114   \message{^^J\prefix checking for linuxdoc class \layoutname... }
 115   \@ifundefined{haslinuxdoc}
 116     {\message{no^^J}}
 117     {\message{yes^^J}
 118      \AddLayout[#1]{\layoutname}{#2}}
 119   \expandafter\endinput
 120 }
 121 % Only for compatibility. Will be removed later.
 122 \let\DeclareSGMLClass=\DeclareDocBookClass
 123
 124 \newcommand{\DeclareDocBookClass}[2][\default]{
 125   \message{^^J\prefix checking for docbook\space\space class \layoutname... }
 126   \@ifundefined{hasdocbook}
 127     {\message{no^^J}}
 128     {\message{yes^^J}
 129      \AddLayout[#1]{\layoutname}{#2}}
 130   \expandafter\endinput
 131 }
 132
 133 % Stolen from article.cls
 134 \newcommand{\today}{\ifcase\month\or
 135   January\or February\or March\or April\or May\or June\or
 136   July\or August\or September\or October\or November\or December\fi
 137   \space\number\day, \number\year}
 138
 139 % Initializes the files
 140 \typeout{\prefix Inspecting your LaTeX configuration.}
 141 \newwrite{\layouts} \immediate\openout \layouts = textclass.lst
 142 \newwrite{\sed} \immediate\openout \sed  = chkconfig.sed
 143 \newwrite{\vars} \immediate\openout \vars = chkconfig.vars
 144 \newwrite{\packages} \immediate\openout \packages = packages.lst
 145
 146 \immediate\write\layouts{%
 147 # This file declares layouts and their associated definition files.^^J%
 148 # It has been automatically generated by configure^^J%
 149 # Use "Options/Reconfigure" if you need to update it after a^^J%
 150 # configuration change. Run ./configure manually to update the^^J%
 151 # system wide version of this file.}
 152
 153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 154 %%%%% ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 155 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 156
 157 %%% Add any new package or document class here.
 158
 159 %%% First, we want the day on which the test has been run.
 160 \AddVariable{date}{\today}
 161
 162 %%% Then, the version of LaTeX we are using
 163 \message{^^J\prefix checking for LaTeX version... \fmtversion}
 164 \AddVariable{fmtversion}{\fmtversion}
 165
 166 %%% Check for ec fonts. Most of this code has been shamelessely stolen
 167 %%% from the file ltxcheck.tex in the LaTeX distribution. In particular,
 168 %%% don't ask me how the macro \ecrm works...
 169 \def\ecrm{%
 170   \begingroup
 171     \escapechar-1
 172     \xdef\reserved@a{%
 173       \noexpand\in@
 174         {\expandafter\string\csname ecrm\endcsname}%
 175         {\expandafter\expandafter\expandafter
 176            \string\csname T1/cmr/m/n\endcsname}}%
 177   \endgroup
 178   \reserved@a}
 179
 180 \message{^^J\prefix checking for default encoding (this may take a long time)^^J}
 181 \font\test=ecrm1000\relax
 182 \ifx\test\nullfont
 183   \message{^^J\prefix\prefix checking for ec fonts... no^^J}
 184   \AddVariable{ec}{no}
 185   \AddVariable{fontenc}{default}
 186 \else
 187   \message{^^J\prefix\space\space checking for ec fonts... yes^^J}
 188   \message{^^J\prefix\space\space checking for ec support in LaTeX format...}
 189   \ecrm
 190   \ifin@
 191     \message{yes^^J}
 192     \AddVariable{ec}{yes}
 193     \AddVariable{fontenc}{T1}
 194     \message{^^J \prefix\space\space default encoding will be set to T1^^J}
 195   \else
 196     \message{no^^J}
 197     \AddVariable{ec}{no}
 198     \AddVariable{fontenc}{default}
 199   \fi
 200 \fi
 201
 202
 203 %%% Document classes
 204 % The list of layout files has been put in this file here by the
 205 % configure script.
 206 \input{chklayouts}
 207
 208
 209 %%% Packages
 210 \TestPackage{a4}
 211 \TestPackage{a4wide}
 212 \TestPackage{babel}
 213 \TestPackage{color} % this one should be there if graphics.sty is there.
 214 \TestPackage{fancyhdr}
 215 \TestPackage{floatflt}
 216 \TestPackage{setspace}
 217 \TestPackage{subfigure}
 218 \TestPackage{geometry}
 219 \TestPackage{longtable}
 220 \TestPackage{algorithm}
 221 \TestPackage{rotating}
 222 \TestPackage{latex8}
 223 \TestPackage{url}
 224 \TestPackage{varioref}
 225 \TestPackage{prettyref}
 226
 227 % The test for the graphics package is slightly more involved...
 228 \newcommand\groption{dvips}
 229 \TestItem{graphics}{package}{sty}
 230 %  Let's do some clever things to guess the default driver for the
 231 %  graphics package. The maintainer of the site might have declared it
 232 %  in the file 'graphics.cfg'. Let's hope there are no strange commands
 233 %  in there...
 234   {\renewcommand\ExecuteOptions[1]{\renewcommand\groption{default}}
 235    \InputIfFileExists{graphics.cfg}{}{}
 236    \AddPackage{graphics}}
 237   {\renewcommand{\groption}{none}}
 238 \message{^^J\prefix checking for graphics driver... \groption^^J}
 239 \AddVariable{graphicsdriver}{\groption}
 240
 241 % psnfss is in fact the name of a set of style files, among which
 242 % times.sty. If times.sty is here, we will assume that everything is
 243 % fine.
 244 \TestPackage[times.sty]{psnfss}
 245
 246 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 247 %%%%% END ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%
 248 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 249
 250 % End of the LaTeX job
 251 \immediate\closeout\layouts
 252 \immediate\closeout\sed
 253 \immediate\closeout\vars
 254 \immediate\closeout\packages
 255 \typeout{\prefix Inspection done.}
 256 \typeout{\prefix Read the file doc/LaTeXConfig.lyx for more information.}
 257 % Get the real \end command, that has been hidden by LaTeX
 258 \@@end