path: root/Master/texmf-dist/source/latex/oberdiek/ifvtex.dtx

% \iffalse meta-comment
%
% Copyright (C) 2001, 2006, 2007 by
%    Heiko Oberdiek <oberdiek@uni-freiburg.de>
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3 of this license or (at your option) any later
% version. The latest version of this license is in
%    http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of
% LaTeX version 2005/12/01 or later.
%
% This work has the LPPL maintenance status "maintained".
%
% This Current Maintainer of this work is Heiko Oberdiek.
%
% This work consists of the main source file ifvtex.dtx
% and the derived files
%    ifvtex.sty, ifvtex.pdf, ifvtex.ins, ifvtex.drv,
%    ifvtex-test1.tex.
%
% Distribution:
%    CTAN:macros/latex/contrib/oberdiek/ifvtex.dtx
%    CTAN:macros/latex/contrib/oberdiek/ifvtex.pdf
%
% Unpacking:
%    (a) If ifvtex.ins is present:
%           tex ifvtex.ins
%    (b) Without ifvtex.ins:
%           tex ifvtex.dtx
%    (c) If you insist on using LaTeX
%           latex \let\install=y\input{ifvtex.dtx}
%        (quote the arguments according to the demands of your shell)
%
% Documentation:
%    (a) If ifvtex.drv is present:
%           latex ifvtex.drv
%    (b) Without ifvtex.drv:
%           latex ifvtex.dtx; ...
%    The class ltxdoc loads the configuration file ltxdoc.cfg
%    if available. Here you can specify further options, e.g.
%    use A4 as paper format:
%       \PassOptionsToClass{a4paper}{article}
%
%    Programm calls to get the documentation (example):
%       pdflatex ifvtex.dtx
%       makeindex -s gind.ist ifvtex.idx
%       pdflatex ifvtex.dtx
%       makeindex -s gind.ist ifvtex.idx
%       pdflatex ifvtex.dtx
%
% Installation:
%    TDS:tex/generic/oberdiek/ifvtex.sty
%    TDS:doc/latex/oberdiek/ifvtex.pdf
%    TDS:doc/latex/oberdiek/ifvtex-test1.tex
%    TDS:source/latex/oberdiek/ifvtex.dtx
%
%<*ignore>
\begingroup
  \def\x{LaTeX2e}%
\expandafter\endgroup
\ifcase 0\ifx\install y1\fi\expandafter
         \ifx\csname processbatchFile\endcsname\relax\else1\fi
         \ifx\fmtname\x\else 1\fi\relax
\else\csname fi\endcsname
%</ignore>
%<*install>
\input docstrip.tex
\Msg{************************************************************************}
\Msg{* Installation}
\Msg{* Package: ifvtex 2007/09/09 v1.3 Switches for detecting VTeX and its modes (HO)}
\Msg{************************************************************************}

\keepsilent
\askforoverwritefalse

\preamble

This is a generated file.

Copyright (C) 2001, 2006, 2007 by
   Heiko Oberdiek <oberdiek@uni-freiburg.de>

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3 of this license or (at your option) any later
version. The latest version of this license is in
   http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.

This work has the LPPL maintenance status "maintained".

This Current Maintainer of this work is Heiko Oberdiek.

This work consists of the main source file ifvtex.dtx
and the derived files
   ifvtex.sty, ifvtex.pdf, ifvtex.ins, ifvtex.drv,
   ifvtex-test1.tex.

\endpreamble

\generate{%
  \file{ifvtex.ins}{\from{ifvtex.dtx}{install}}%
  \file{ifvtex.drv}{\from{ifvtex.dtx}{driver}}%
  \usedir{tex/generic/oberdiek}%
  \file{ifvtex.sty}{\from{ifvtex.dtx}{package}}%
  \usedir{doc/latex/oberdiek}%
  \file{ifvtex-test1.tex}{\from{ifvtex.dtx}{test1}}%
}

\obeyspaces
\Msg{************************************************************************}
\Msg{*}
\Msg{* To finish the installation you have to move the following}
\Msg{* file into a directory searched by TeX:}
\Msg{*}
\Msg{*     ifvtex.sty}
\Msg{*}
\Msg{* To produce the documentation run the file `ifvtex.drv'}
\Msg{* through LaTeX.}
\Msg{*}
\Msg{* Happy TeXing!}
\Msg{*}
\Msg{************************************************************************}

\endbatchfile
%</install>
%<*ignore>
\fi
%</ignore>
%<*driver>
\NeedsTeXFormat{LaTeX2e}
\ProvidesFile{ifvtex.drv}%
  [2007/09/09 v1.3 Switches for detecting VTeX and its modes (HO)]%
\documentclass{ltxdoc}
\usepackage{holtxdoc}
\begin{document}
  \DocInput{ifvtex.dtx}%
\end{document}
%</driver>
% \fi
%
% \CheckSum{340}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
% \GetFileInfo{ifvtex.drv}
%
% \title{The \xpackage{ifvtex} package}
% \date{2007/09/09 v1.3}
% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
%
% \maketitle
%
% \begin{abstract}
% This package looks for \VTeX, implements
% and sets the switches \cs{ifvtex}, \cs{ifvtex}\texttt{\meta{mode}},
% \cs{ifvtexgex}. It works with plain or \LaTeX\ formats.
% \end{abstract}
%
% \tableofcontents
%
% \section{Usage}
%
% The package \xpackage{ifvtex} can be used with both \plainTeX\
% and \LaTeX:
% \begin{description}
% \item[\plainTeX:] |\input ifvtex.sty|
% \item[\LaTeXe:]   |\usepackage{ifvtex}|\\
% \end{description}
%
% The package implements switches for \VTeX\ and its different
% modes and interprets \cs{VTeXversion}, \cs{OpMode}, and \cs{gexmode}.
%
% \begin{declcs}{ifvtex}
% \end{declcs}
% The package provides the switch \cs{ifvtex}:
% \begin{quote}
%   |\ifvtex|\\
%   \hspace{1.5em}\dots\ do things, if \VTeX\ is running \dots\\
%   |\else|\\
%   \hspace{1.5em}\dots\ other \TeX\ compiler \dots\\
%   |\fi|
% \end{quote}
% Users of the package \xpackage{ifthen} can use the switch as boolean:
% \begin{quote}
%   |\boolean{ifvtex}|
% \end{quote}
%
% \begin{declcs}{ifvtexdvi}\\
%   \cs{ifvtexpdf}\SpecialUsageIndex{\ifvtexpdf}\\
%   \cs{ifvtexps}\SpecialUsageIndex{\ifvtexps}\\
%   \cs{ifvtexhtml}\SpecialUsageIndex{\ifvtexhtml}
% \end{declcs}
% \VTeX\ knows different output modes that can be asked by these
% switches.
%
% \begin{declcs}{ifvtexgex}
% \end{declcs}
% This switch shows, whether GeX is available.
%
% \StopEventually{
% }
%
% \section{Implemenation}
%
% \subsection{Reload check and package identification}
%
%    \begin{macrocode}
%<*package>
%    \end{macrocode}
%    Reload check, especially if the package is not used with \LaTeX.
%    \begin{macrocode}
\begingroup
  \catcode44 12 % ,
  \catcode45 12 % -
  \catcode46 12 % .
  \catcode58 12 % :
  \catcode64 11 % @
  \expandafter\let\expandafter\x\csname ver@ifvtex.sty\endcsname
  \ifcase 0%
    \ifx\x\relax % plain
    \else
      \ifx\x\empty % LaTeX
      \else
        1%
      \fi
    \fi
  \else
    \expandafter\ifx\csname PackageInfo\endcsname\relax
      \def\x#1#2{%
        \immediate\write-1{Package #1 Info: #2.}%
      }%
    \else
      \def\x#1#2{\PackageInfo{#1}{#2, stopped}}%
    \fi
    \x{ifvtex}{The package is already loaded}%
    \endgroup
    \expandafter\endinput
  \fi
\endgroup
%    \end{macrocode}
%    Package identification:
%    \begin{macrocode}
\begingroup
  \catcode40 12 % (
  \catcode41 12 % )
  \catcode44 12 % ,
  \catcode45 12 % -
  \catcode46 12 % .
  \catcode47 12 % /
  \catcode58 12 % :
  \catcode64 11 % @
  \expandafter\ifx\csname ProvidesPackage\endcsname\relax
    \def\x#1#2#3[#4]{\endgroup
      \immediate\write-1{Package: #3 #4}%
      \xdef#1{#4}%
    }%
  \else
    \def\x#1#2[#3]{\endgroup
      #2[{#3}]%
      \ifx#1\relax
        \xdef#1{#3}%
      \fi
    }%
  \fi
\expandafter\x\csname ver@ifvtex.sty\endcsname
\ProvidesPackage{ifvtex}%
  [2007/09/09 v1.3 Switches for detecting VTeX and its modes (HO)]
%    \end{macrocode}
%
% \subsection{Catcodes}
%
%    \begin{macrocode}
\expandafter\edef\csname ifvtex@AtEnd\endcsname{%
  \catcode64 \the\catcode64\relax
}
\catcode64 11 % @
\def\TMP@EnsureCode#1#2{%
  \edef\ifvtex@AtEnd{%
    \ifvtex@AtEnd
    \catcode#1 \the\catcode#1\relax
  }%
  \catcode#1 #2\relax
}
\TMP@EnsureCode{10}{12}% ^^J
\TMP@EnsureCode{39}{12}% '
\TMP@EnsureCode{44}{12}% ,
\TMP@EnsureCode{45}{12}% -
\TMP@EnsureCode{46}{12}% .
\TMP@EnsureCode{47}{12}% /
\TMP@EnsureCode{58}{12}% :
\TMP@EnsureCode{60}{12}% <
\TMP@EnsureCode{61}{12}% =
\TMP@EnsureCode{62}{12}% >
\TMP@EnsureCode{94}{7}% ^
\TMP@EnsureCode{96}{12}% `
%    \end{macrocode}
%
% \subsection{Check for previously defined \cs{ifvtex}}
%
%    \begin{macrocode}
\begingroup
  \expandafter\ifx\csname ifvtex\endcsname\relax
  \else
    \edef\i/{\expandafter\string\csname ifvtex\endcsname}%
    \expandafter\ifx\csname PackageError\endcsname\relax
      \def\x#1#2{%
        \edef\z{#2}%
        \expandafter\errhelp\expandafter{\z}%
        \errmessage{Package ifvtex Error: #1}%
      }%
      \def\y{^^J}%
      \newlinechar=10 %
    \else
      \def\x#1#2{%
        \PackageError{ifvtex}{#1}{#2}%
      }%
      \def\y{\MessageBreak}%
    \fi
    \x{Name clash, \i/ is already defined}{%
      Incompatible versions of \i/ can cause problems,\y
      therefore package loading is aborted.%
    }%
    \endgroup
    \ifvtex@AtEnd
    \expandafter\endinput
  \fi
\endgroup
%    \end{macrocode}
%
% \subsection{\cs{ifvtex}}
%
%    \begin{macro}{\ifvtex}
%    Create and set the switch. \cs{newif} initializes the
%    switch with \cs{iffalse}.
%    \begin{macrocode}
\newif\ifvtex
%    \end{macrocode}
%    \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname VTeXversion\endcsname\relax
\else
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname OpMOde\endcsname\relax
  \else
    \vtextrue
  \fi
\fi
%    \end{macrocode}
%    \end{macro}
%
% \subsection{Mode and GeX switches}
%
%    \begin{macrocode}
\newif\ifvtexdvi
\newif\ifvtexpdf
\newif\ifvtexps
\newif\ifvtexhtml
\newif\ifvtexgex
\ifvtex
  \ifcase\OpMode\relax
    \vtexdvitrue
  \or % 1
    \vtexpdftrue
  \or % 2
    \vtexpstrue
  \or % 3
    \vtexpstrue
  \or\or\or\or\or\or\or % 10
    \vtexhtmltrue
  \fi
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname gexmode\endcsname\relax
  \else
    \ifnum\gexmode>0 %
      \vtexgextrue
    \fi
  \fi
\fi
%    \end{macrocode}
%
% \subsection{Protocol entry}
%
%     Log comment:
%    \begin{macrocode}
\begingroup
  \expandafter\ifx\csname PackageInfo\endcsname\relax
    \def\x#1#2{%
      \immediate\write-1{Package #1 Info: #2.}%
    }%
  \else
    \let\x\PackageInfo
    \expandafter\let\csname on@line\endcsname\empty
  \fi
  \x{ifvtex}{%
    VTeX %
    \ifvtex
      in \ifvtexdvi DVI\fi
         \ifvtexpdf PDF\fi
         \ifvtexps PS\fi
         \ifvtexhtml HTML\fi
      \space mode %
      with\ifvtexgex\else out\fi\space GeX %
    \else
      not %
    \fi
    detected%
  }%
\endgroup
%    \end{macrocode}
%
%    \begin{macrocode}
\ifvtex@AtEnd
%</package>
%    \end{macrocode}
%
% \section{Test}
%
% \subsection{Catcode checks for loading}
%
%    \begin{macrocode}
%<*test1>
%    \end{macrocode}
%    \begin{macrocode}
\catcode`\@=11 %
\def\RestoreCatcodes{}
\count@=0 %
\loop
  \edef\RestoreCatcodes{%
    \RestoreCatcodes
    \catcode\the\count@=\the\catcode\count@\relax
  }%
\ifnum\count@<255 %
  \advance\count@\@ne
\repeat

\def\RangeCatcodeInvalid#1#2{%
  \count@=#1\relax
  \loop
    \catcode\count@=15 %
  \ifnum\count@<#2\relax
    \advance\count@\@ne
  \repeat
}
\def\Test{%
  \RangeCatcodeInvalid{0}{47}%
  \RangeCatcodeInvalid{58}{64}%
  \RangeCatcodeInvalid{91}{96}%
  \RangeCatcodeInvalid{123}{255}%
  \catcode`\@=12 %
  \catcode`\\=0 %
  \catcode`\{=1 %
  \catcode`\}=2 %
  \catcode`\#=6 %
  \catcode`\[=12 %
  \catcode`\]=12 %
  \catcode`\%=14 %
  \catcode`\ =10 %
  \catcode13=5 %
  \input ifvtex.sty\relax
  \RestoreCatcodes
}
\Test
\csname @@end\endcsname
\end
%    \end{macrocode}
%    \begin{macrocode}
%</test1>
%    \end{macrocode}
%
% \section{Installation}
%
% \subsection{Download}
%
% \paragraph{Package.} This package is available on
% CTAN\footnote{\url{ftp://ftp.ctan.org/tex-archive/}}:
% \begin{description}
% \item[\CTAN{macros/latex/contrib/oberdiek/ifvtex.dtx}] The source file.
% \item[\CTAN{macros/latex/contrib/oberdiek/ifvtex.pdf}] Documentation.
% \end{description}
%
%
% \paragraph{Bundle.} All the packages of the bundle `oberdiek'
% are also available in a TDS compliant ZIP archive. There
% the packages are already unpacked and the documentation files
% are generated. The files and directories obey the TDS standard.
% \begin{description}
% \item[\CTAN{macros/latex/contrib/oberdiek/oberdiek-tds.zip}]
% \end{description}
% \emph{TDS} refers to the standard ``A Directory Structure
% for \TeX\ Files'' (\CTAN{tds/tds.pdf}). Directories
% with \xfile{texmf} in their name are usually organized this way.
%
% \subsection{Bundle installation}
%
% \paragraph{Unpacking.} Unpack the \xfile{oberdiek-tds.zip} in the
% TDS tree (also known as \xfile{texmf} tree) of your choice.
% Example (linux):
% \begin{quote}
%   |unzip oberdiek-tds.zip -d ~/texmf|
% \end{quote}
%
% \paragraph{Script installation.}
% Check the directory \xfile{TDS:scripts/oberdiek/} for
% scripts that need further installation steps.
% Package \xpackage{attachfile2} comes with the Perl script
% \xfile{pdfatfi.pl} that should be installed in such a way
% that it can be called as \texttt{pdfatfi}.
% Example (linux):
% \begin{quote}
%   |chmod +x scripts/oberdiek/pdfatfi.pl|\\
%   |cp scripts/oberdiek/pdfatfi.pl /usr/local/bin/|
% \end{quote}
%
% \subsection{Package installation}
%
% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
% \docstrip\ archive. The files are extracted by running the
% \xfile{.dtx} through \plainTeX:
% \begin{quote}
%   \verb|tex ifvtex.dtx|
% \end{quote}
%
% \paragraph{TDS.} Now the different files must be moved into
% the different directories in your installation TDS tree
% (also known as \xfile{texmf} tree):
% \begin{quote}
% \def\t{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\ttfamily}l@{}}
%   ifvtex.sty & tex/generic/oberdiek/ifvtex.sty\\
%   ifvtex.pdf & doc/latex/oberdiek/ifvtex.pdf\\
%   ifvtex-test1.tex & doc/latex/oberdiek/ifvtex-test1.tex\\
%   ifvtex.dtx & source/latex/oberdiek/ifvtex.dtx\\
% \end{tabular}^^A
% }^^A
% \sbox0{\t}^^A
% \ifdim\wd0>\linewidth
%   \begingroup
%     \advance\linewidth by\leftmargin
%     \advance\linewidth by\rightmargin
%   \edef\x{\endgroup
%     \def\noexpand\lw{\the\linewidth}^^A
%   }\x
%   \def\lwbox{^^A
%     \leavevmode
%     \hbox to \linewidth{^^A
%       \kern-\leftmargin\relax
%       \hss
%       \usebox0
%       \hss
%       \kern-\rightmargin\relax
%     }^^A
%   }^^A
%   \ifdim\wd0>\lw
%     \sbox0{\small\t}^^A
%     \ifdim\wd0>\linewidth
%       \ifdim\wd0>\lw
%         \sbox0{\footnotesize\t}^^A
%         \ifdim\wd0>\linewidth
%           \ifdim\wd0>\lw
%             \sbox0{\scriptsize\t}^^A
%             \ifdim\wd0>\linewidth
%               \ifdim\wd0>\lw
%                 \sbox0{\tiny\t}^^A
%                 \ifdim\wd0>\linewidth
%                   \lwbox
%                 \else
%                   \usebox0
%                 \fi
%               \else
%                 \lwbox
%               \fi
%             \else
%               \usebox0
%             \fi
%           \else
%             \lwbox
%           \fi
%         \else
%           \usebox0
%         \fi
%       \else
%         \lwbox
%       \fi
%     \else
%       \usebox0
%     \fi
%   \else
%     \lwbox
%   \fi
% \else
%   \usebox0
% \fi
% \end{quote}
% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's
% TDS installing feature, then some files can already be in the right
% place, see the documentation of \docstrip.
%
% \subsection{Refresh file name databases}
%
% If your \TeX~distribution
% (\teTeX, \mikTeX, \dots) relies on file name databases, you must refresh
% these. For example, \teTeX\ users run \verb|texhash| or
% \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \paragraph{Attached source.}
%
% The PDF documentation on CTAN also includes the
% \xfile{.dtx} source file. It can be extracted by
% AcrobatReader 6 or higher. Another option is \textsf{pdftk},
% e.g. unpack the file into the current directory:
% \begin{quote}
%   \verb|pdftk ifvtex.pdf unpack_files output .|
% \end{quote}
%
% \paragraph{Unpacking with \LaTeX.}
% The \xfile{.dtx} chooses its action depending on the format:
% \begin{description}
% \item[\plainTeX:] Run \docstrip\ and extract the files.
% \item[\LaTeX:] Generate the documentation.
% \end{description}
% If you insist on using \LaTeX\ for \docstrip\ (really,
% \docstrip\ does not need \LaTeX), then inform the autodetect routine
% about your intention:
% \begin{quote}
%   \verb|latex \let\install=y\input{ifvtex.dtx}|
% \end{quote}
% Do not forget to quote the argument according to the demands
% of your shell.
%
% \paragraph{Generating the documentation.}
% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
% the documentation. The process can be configured by the
% configuration file \xfile{ltxdoc.cfg}. For instance, put this
% line into this file, if you want to have A4 as paper format:
% \begin{quote}
%   \verb|\PassOptionsToClass{a4paper}{article}|
% \end{quote}
% An example follows how to generate the
% documentation with pdf\LaTeX:
% \begin{quote}
%\begin{verbatim}
%pdflatex ifvtex.dtx
%makeindex -s gind.ist ifvtex.idx
%pdflatex ifvtex.dtx
%makeindex -s gind.ist ifvtex.idx
%pdflatex ifvtex.dtx
%\end{verbatim}
% \end{quote}
%
% \begin{History}
%   \begin{Version}{2001/09/26 v1.0}
%   \item
%     First public version.
%   \end{Version}
%   \begin{Version}{2006/02/20 v1.1}
%   \item
%     DTX framework.
%   \item
%     Undefined tests changed.
%   \end{Version}
%   \begin{Version}{2007/01/10 v1.2}
%   \item
%     Fix of the \cs{ProvidesPackage} description.
%   \end{Version}
%   \begin{Version}{2007/09/09 v1.3}
%   \item
%     Catcode section added.
%   \end{Version}
% \end{History}
%
% \PrintIndex
%
% \Finale
\endinput