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/LyXConfig.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 chkconfig.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/LyXConfig.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 %%% LyXConfig.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
  39 %%% Some useful macros.
  40 %   Several commands are defined to test for packages:
  41 %    \AddLayout{<layout>} adds an entry for <layout> in textclass.lst
  42 %    \AddVariable{<name>}{<value>} creates a new variable chk_<name>,
  43 %      and gives it the value <value>.
  44 %    \TestDocClass{<name>}{<command>} if layout <name> has not already
  45 %      been tested for, execute <command>. Note that you will
  46 %      probably not need to use this directly, since the configure
  47 %      script generates the needed macro calls automatically.
  48 %    \TestPackage[<file>]{<name>} tests whether <name>.sty (or <file>,
  49 %      if it is provided) exists.
  50 %   Both commands call \AddVariable to give value 'yes' or 'no' to
  51 %   the variable chk_<name>.
  52 %%%
  53 \newcommand{\prefix}{+} % the character used by grep to filter 'good' output
  54 \newcommand{\AddLayout}[4][\default]{
  55   \def\default{#2}
  56   \immediate\write\layouts{"#2"   "#1"   "#3"   "#4"}}
  57 \newcommand{\AddVariable}[2]{
  58   \immediate\write\sed{s!@chk_#1@!#2!g}
  59   \immediate\write\vars{chk_#1='#2'}}
  60 \newcommand{\AddPackage}[1]{
  61   \immediate\write\packages{#1}}
  62 % Tests whether an item is present
  63 % Syntax: \TestItem{<file>}{<name>}{<type>}{<ext>}{<iftrue>}{<iffalse>}
  64 \newif\ifexists
  65 \newcommand{\TestItem}[6][\default]{
  66   \def\default{#2}
  67   \def\files{#1}
  68   \message{^^J\prefix checking for #3 #2 [#1]...}
  69   \let\firstelement\relax
  70   \existstrue
  71   \@for\file:=\files\do{
  72     \ifx\firstelement\relax
  73        \edef\firstelement{\file}
  74     \fi
  75     \IfFileExists{\file}
  76       {}
  77       {\IfFileExists{\file.#4}{}{\existsfalse}}
  78   }
  79   \ifexists
  80     \message{yes^^J}
  81     \AddVariable{#2}{yes}
  82     #5
  83   \else
  84     \message{no^^J}
  85     \AddVariable{#2}{no}
  86     #6
  87   \fi}
  88 \newcommand{\TestPackage}[2][\default]{
  89   \TestItem[#1]{#2}{package}{sty}{\AddPackage{#2}}{}}
  90 \newcommand{\TestDocClass}[2]{
  91    \def\layoutname{#1}  % remember the name of the layout file
  92    \@ifundefined{layout@#1}
  93      {#2  % execute the command
  94       \global\@namedef{layout@#1}{}}
  95      {} % we have already tried this one.
  96 }
  97 \newcommand{\DeclareLaTeXClass}[2][\default]{
  98   \TestItem[#1]{\layoutname}{document class}{cls}
  99            {\AddLayout[\firstelement]{\layoutname}{#2}{true}}
 100            {\AddLayout[\firstelement]{\layoutname}{#2}{false}}
 101 }
 102 \newcommand{\DeclareLinuxDocClass}[2][\default]{
 103   \message{^^J\prefix checking for linuxdoc class \layoutname... }
 104   \@ifundefined{haslinuxdoc}
 105     {\message{no^^J}
 106      \AddLayout[#1]{\layoutname}{#2}{false}}
 107     {\message{yes^^J}
 108      \AddLayout[#1]{\layoutname}{#2}{true}}
 109 }
 110 % Only for compatibility. Will be removed later.
 111 \let\DeclareSGMLClass=\DeclareDocBookClass
 112
 113 \newcommand{\DeclareDocBookClass}[2][\default]{
 114   \message{^^J\prefix checking for docbook\space\space class \layoutname... }
 115   \@ifundefined{hasdocbook}
 116     {\message{no^^J}
 117      \AddLayout[#1]{\layoutname}{#2}{false}}
 118     {\message{yes^^J}
 119      \AddLayout[#1]{\layoutname}{#2}{true}}
 120 }
 121
 122 % Stolen from article.cls
 123 \newcommand{\today}{\ifcase\month\or
 124   January\or February\or March\or April\or May\or June\or
 125   July\or August\or September\or October\or November\or December\fi
 126   \space\number\day, \number\year}
 127
 128 % Initializes the files
 129 \typeout{\prefix Inspecting your LaTeX configuration.}
 130 \newwrite{\layouts} \immediate\openout \layouts = textclass.lst
 131 \newwrite{\sed} \immediate\openout \sed  = chkconfig.sed
 132 \newwrite{\vars} \immediate\openout \vars = chkconfig.vars
 133 \newwrite{\packages} \immediate\openout \packages = packages.lst
 134
 135 \immediate\write\layouts{%
 136 # This file declares layouts and their associated definition files.^^J%
 137 # It has been automatically generated by configure^^J%
 138 # Use "Options/Reconfigure" if you need to update it after a^^J%
 139 # configuration change. Run ./configure manually to update the^^J%
 140 # system wide version of this file.}
 141
 142 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 143 %%%%% ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 145
 146 %%% Add any new package or document class here.
 147
 148 %%% First, we want the day on which the test has been run.
 149 \AddVariable{date}{\today}
 150
 151 %%% Then, the version of LaTeX we are using
 152 \message{^^J\prefix checking for LaTeX version... \fmtversion}
 153 \AddVariable{fmtversion}{\fmtversion}
 154
 155 %%% And now, the list of available languages
 156 % The trick is to know that \the\everyjob contains something like
 157 %  \typeout{LaTeX2e <2001/06/01>}
 158 %  \typeout{Babel <v3.7h> and hyphenation patterns for american, french, german, ngerman, nohyphenation, loaded.}
 159 % All we have to do is to extract the list from there:
 160 % (1) concatenate all the messages that are displayed everytime the
 161 % format is loaded. The is done by redefining locally \typeout to
 162 % append its argument to the macro \mesg.
 163 \def\mesg{}
 164 {\def\typeout#1{\xdef\mesg{\mesg #1}}
 165  \the\everyjob}
 166 % (2) strip the useless parts from \mesg. This uses the fact that TeX
 167 % allows to define macros with parameters delimited by arbitrary text.
 168 \def\strip#1patterns for #2, loaded.#3\endmark{\def\langs{#2}}
 169 \expandafter\strip\mesg\endmark
 170 % (3) handle the result
 171 \message{^^J\prefix checking for available hyphenation patterns... \langs}
 172 \AddVariable{languages}{\langs}
 173
 174 %%% Check for ec fonts. Most of this code has been shamelessely stolen
 175 %%% from the file ltxcheck.tex in the LaTeX distribution. In particular,
 176 %%% don't ask me how the macro \ecrm works...
 177 \def\ecrm{%
 178   \begingroup
 179     \escapechar-1
 180     \xdef\reserved@a{%
 181       \noexpand\in@
 182         {\expandafter\string\csname ecrm\endcsname}%
 183         {\expandafter\expandafter\expandafter
 184            \string\csname T1/cmr/m/n\endcsname}}%
 185   \endgroup
 186   \reserved@a}
 187
 188 \message{^^J\prefix checking for default encoding (this may take a long time)^^J}
 189 \font\test=ecrm1000\relax
 190 \ifx\test\nullfont
 191   \message{^^J\prefix\prefix checking for ec fonts... no^^J}
 192   \AddVariable{ec}{no}
 193   \AddVariable{fontenc}{default}
 194 \else
 195   \message{^^J\prefix\space\space checking for ec fonts... yes^^J}
 196   \message{^^J\prefix\space\space checking for ec support in LaTeX format...}
 197   \ecrm
 198   \ifin@
 199     \message{yes^^J}
 200     \AddVariable{ec}{yes}
 201     \AddVariable{fontenc}{T1}
 202     \message{^^J \prefix\space\space default encoding will be set to T1^^J}
 203   \else
 204     \message{no^^J}
 205     \AddVariable{ec}{no}
 206     \AddVariable{fontenc}{default}
 207   \fi
 208 \fi
 209
 210
 211 %%% Document classes
 212 % The list of layout files has been put in this file here by the
 213 % configure script.
 214 \input{chklayouts}
 215
 216
 217 %%% Packages
 218 \TestPackage{a4}
 219 \TestPackage{a4wide}
 220 \TestPackage{array}
 221 \TestPackage{babel}
 222 \TestPackage{color} % this one should be there if graphics.sty is there.
 223 \TestPackage{fancyhdr}
 224 \TestPackage{floatflt}
 225 \TestPackage{setspace}
 226 \TestPackage{subfigure}
 227 \TestPackage{geometry}
 228 \TestPackage{longtable}
 229 \TestPackage{algorithm}
 230 \TestPackage{rotating}
 231 \TestPackage{latex8}
 232 \TestPackage{url}
 233 \TestPackage{varioref}
 234 \TestPackage{prettyref}
 235 \TestPackage{natbib}
 236 \TestPackage{dvipost}
 237
 238 % The test for the graphics package is slightly more involved...
 239 \newcommand\groption{dvips}
 240 \TestItem{graphicx}{package}{sty}
 241 %  Let's do some clever things to guess the default driver for the
 242 %  graphicx package. The maintainer of the site might have declared it
 243 %  in the file 'graphics.cfg'. Let's hope there are no strange commands
 244 %  in there...
 245   {\renewcommand\ExecuteOptions[1]{\renewcommand\groption{default}}
 246    \InputIfFileExists{graphics.cfg}{}{}
 247    \AddPackage{graphicx}}
 248   {\renewcommand{\groption}{none}}
 249 \message{^^J\prefix checking for graphics driver... \groption^^J}
 250 \AddVariable{graphicsdriver}{\groption}
 251
 252 % psnfss is in fact the name of a set of style files, among which
 253 % times.sty. If times.sty is here, we will assume that everything is
 254 % fine.
 255 \TestPackage[times.sty]{psnfss}
 256
 257 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 258 %%%%% END ACTUAL CONFIGURATION INSPECTION CODE %%%%%%%%%%%%%%%%%%%%%%%%%%%%
 259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 260
 261 % End of the LaTeX job
 262 \immediate\closeout\layouts
 263 \immediate\closeout\sed
 264 \immediate\closeout\vars
 265 \immediate\closeout\packages
 266 \typeout{\prefix Inspection done.}
 267 \typeout{\prefix Read the file doc/LaTeXConfig.lyx for more information.}
 268 % Get the real \end command, that has been hidden by LaTeX
 269 \@@end