trunk/base/alltt.dtx

   1 % \iffalse meta-comment
   2 %
   3 % Copyright 1993-2016
   4 % The LaTeX3 Project and any individual authors listed elsewhere
   5 % in this file.
   6 %
   7 % This file is part of the LaTeX base system.
   8 % -------------------------------------------
   9 %
  10 % It may be distributed and/or modified under the
  11 % conditions of the LaTeX Project Public License, either version 1.3c
  12 % of this license or (at your option) any later version.
  13 % The latest version of this license is in
  14 %    http://www.latex-project.org/lppl.txt
  15 % and version 1.3c or later is part of all distributions of LaTeX
  16 % version 2005/12/01 or later.
  17 %
  18 % This file has the LPPL maintenance status "maintained".
  19 %
  20 % The list of all files belonging to the LaTeX base distribution is
  21 % given in the file `manifest.txt'. See also `legal.txt' for additional
  22 % information.
  23 %
  24 % The list of derived (unpacked) files belonging to the distribution
  25 % and covered by LPPL is defined by the unpacking scripts (with
  26 % extension .ins) which are part of the distribution.
  27 %
  28 % \fi
  29 % \iffalse
  30 %%
  31 %% File `alltt.dtx'.
  32 %% Copyright (C) 1987 by Leslie Lamport
  33 %% Copyright (C) 1994--1997 LaTeX3 project, Johannes Braams
  34 %%                       all rights reserved.
  35 %%
  36 %<*dtx>
  37 \ProvidesFile{alltt.dtx}
  38 %</dtx>
  39 %<package>\NeedsTeXFormat{LaTeX2e}
  40 %<package>\ProvidesPackage{alltt}
  41 %<driver>\ProvidesFile{alltt.drv}
  42 %\ProvidesFile{alltt.dtx}
  43               [1997/06/16 v2.0g defines alltt environment]
  44 %
  45 %<*driver>
  46 \documentclass{ltxdoc}
  47 \begin{document}
  48 \providecommand{\Lenv}[1]{\textsf{#1}}
  49 \providecommand{\pkg}[1]{\texttt{#1}}
  50 \providecommand{\file}[1]{\texttt{#1}}
  51 \DocInput{alltt.dtx}
  52 \end{document}
  53 %</driver>
  54 % \fi
  55 %
  56 % \changes{v2.0g}{1997/06/16}{A few documentation fixes (PR 2520)}
  57 % \changes{v2.0d}{1995/04/02}{A few documentation fixes (PR 1517)}
  58 %
  59 %  \GetFileInfo{alltt.dtx}
  60 %  \title{The \texttt{alltt} environment\thanks{This file
  61 %        has version number \fileversion, last
  62 %        revised \filedate.}}
  63 %  \author{Johannes Braams}
  64 %  \date{\filedate}
  65 %  \MaintainedByLaTeXTeam{latex}
  66 %  \maketitle
  67 %
  68 %    \begin{abstract}
  69 %    This package defines the \Lenv{alltt} environment, which is like
  70 %    the \Lenv{verbatim} environment except that |\|, |{|, and |}|
  71 %    have their usual meanings.
  72 %
  73 %    Thus, other commands and environments can appear within an
  74 %    \Lenv{alltt} environment.
  75 %    \end{abstract}
  76 %
  77 %  \section{Introduction}
  78 %
  79 %  \DescribeEnv{alltt}
  80 %   Here are some things you may want to do in an \Lenv{alltt}
  81 %   environment:
  82 %   \begin{itemize}
  83 %   \item Change fonts--e.g., by typing |{\em emphasized text\/}|
  84 %
  85 %   \item Insert text from a file \file{foo.tex} by typing
  86 %    |\input{foo}|. Beware that each |<return>| starts a new line, so
  87 %    if \file{foo.tex} ends with a |<return>| you can wind up with an
  88 %    extra blank line if you're not careful.
  89 %
  90 %   \item Insert a math formula.  Note that |$| just produces a dollar
  91 %   sign, so you'll have to type |\(...\)| or |\[...\]|.  Also, |^|
  92 %   and |_| just produce their characters; use |\sp| or |\sb| for
  93 %   super- and subscripts, as in |\(x\sp{2}\)|.
  94 %   \end{itemize}
  95 %
  96 %  \StopEventually{}
  97 %
  98 %  \section{The Implementation}
  99 %
 100 %    \begin{macrocode}
 101 %<*package>
 102 %    \end{macrocode}
 103 %
 104 %  \begin{environment}{alltt}
 105 %    The \Lenv{alltt} environment is similar to the \Lenv{verbatim}
 106 %    environment, except that |\|, |{| and |}| have their usual
 107 %    behaviour.
 108 % \changes{v2.0b}{1994/10/29}{Added a missing \cs{dospecials}}
 109 % \changes{v2.0c}{1995/01/27}{Reset \cs{dospecials} after its changed
 110 %    version is executed}
 111 % \changes{v2.0e}{1995/05/13}{brought definition up to date with the
 112 %    verbatim environment}
 113 % \changes{v2.0e}{1995/05/13}{Save and restore (in math mode) the
 114 %    definition of the \texttt{'} character}
 115 %    \begin{macrocode}
 116 \begingroup
 117 \lccode`\~=`\'
 118 \lowercase{\endgroup
 119 \newenvironment{alltt}{%
 120   \trivlist
 121   \item\relax
 122     \if@minipage
 123     \else
 124       \vskip\parskip
 125     \fi
 126     \leftskip\@totalleftmargin
 127     \rightskip\z@skip
 128     \parindent\z@
 129     \parfillskip\@flushglue
 130     \parskip\z@skip
 131     \@@par
 132     \@tempswafalse
 133     \def\par{%
 134       \if@tempswa
 135         \leavevmode\null\@@par\penalty\interlinepenalty
 136     \else
 137       \@tempswatrue
 138       \ifhmode\@@par\penalty\interlinepenalty\fi
 139     \fi}
 140     \obeylines
 141     \verbatim@font
 142     \let\org@prime~%
 143     \@noligs
 144 %    \end{macrocode}
 145 % \changes{v2.0f}{1995/07/24}{Added setting of the \cs{catcode} of the
 146 %    \texttt{'} character}
 147 %    \begin{macrocode}
 148     \everymath\expandafter{\the\everymath
 149       \catcode`\'=12 \let~\org@prime}
 150     \everydisplay\expandafter{\the\everydisplay
 151       \catcode`\'=12 \let~\org@prime}
 152     \let\org@dospecials\dospecials
 153     \g@remfrom@specials{\\}
 154     \g@remfrom@specials{\{}
 155     \g@remfrom@specials{\}}
 156     \let\do\@makeother
 157     \dospecials
 158     \let\dospecials\org@dospecials
 159     \frenchspacing\@vobeyspaces
 160     \everypar \expandafter{\the\everypar \unpenalty}}
 161 {\endtrivlist}}
 162 %    \end{macrocode}
 163 %  \end{environment}
 164 %
 165 %  \begin{macro}{\g@remfrom@specials}
 166 %    In the old implementation of the \pkg{alltt} package a fixed
 167 %    |\dospecials| was used. However nowadays the |\dospecials|
 168 %    command might contain more special characters at run-time then as
 169 %    was defined in the format. Therefore we remove the necessary
 170 %    special character from |\dospecials| at the start of the
 171 %    \Lenv{alltt} environment. For this we need a macro. Remember that
 172 %    the list of special characters in |\dospecials| contains the
 173 %    control sequence |\do| between the characters. We use that to
 174 %    check whether a character has to be removed.
 175 %
 176 %    The macro |\g@remfrom@specials| takes one argument, the chracter
 177 %    to be removed from the list.
 178 %    \begin{macrocode}
 179 \def\g@remfrom@specials#1{%
 180 %    \end{macrocode}
 181 %    We build up a new list in |\@new@speicals|.
 182 %    \begin{macrocode}
 183   \def\@new@specials{}
 184 %    \end{macrocode}
 185 %    The command |\@remove| compares its argument with the argument of\\
 186 %    |\g@remfrom@specials|.
 187 %    \begin{macrocode}
 188   \def\@remove##1{%
 189     \ifx##1#1\else
 190 %    \end{macrocode}
 191 %    When they are not the same the argument of |\@remove| is added
 192 %    (together with |\do|) to the new list.
 193 %    \begin{macrocode}
 194     \g@addto@macro\@new@specials{\do ##1}\fi}
 195 %    \end{macrocode}
 196 %    Now we |\let| |\do| be equal to |\@remove| and execute
 197 %    |\dospecials|.
 198 %    \begin{macrocode}
 199   \let\do\@remove\dospecials
 200 %    \end{macrocode}
 201 %    All that's left is to make |\dospecials| point to the new list.
 202 %    \begin{macrocode}
 203   \let\dospecials\@new@specials
 204   }
 205 %    \end{macrocode}
 206 %  \end{macro}
 207 %
 208 %    \begin{macrocode}
 209 %</package>
 210 %    \end{macrocode}
 211 %
 212 % \Finale
 213 \endinput