ucw-verb.tex

   1 % The UCW Macro Collection: Verbatim environment
   2 % Written by Martin Mares <mj@ucw.cz> in 2010 and placed into public domain
   3 % -------------------------------------------------------------------------
   4
   5 % We'll use internal macros of plain TeX
   6 \catcode`@=11
   7
   8 % New \frenchspacing, which doesn't leave unwanted spaces in text.
   9 \def\frenchsp@cing{\sfcode`\.\@m \sfcode`\?\@m \sfcode`\!\@m%
  10 \sfcode`\:\@m \sfcode`\;\@m \sfcode`\,\@m}
  11
  12 % Typesetting of one verbatim word: |word|
  13
  14 % Set if spaces should be rendered as "bath-tub" glyphs
  15 \newif\ifshowspaces
  16 \showspacesfalse
  17
  18 \def\make@ther#1{\catcode`#1=12\relax}
  19 \def\setverb@tim{\tt\frenchsp@cing\catcode`\`=13\catcode`\'=13\n@ligs%
  20 \let\do=\make@ther\dospecials\obeyspaces\showsp@ces}
  21
  22 {\catcode`'=13
  23 \catcode``=13
  24 \gdef\n@ligs{\def`{\relax\lq}\def'{\relax\rq}}}
  25
  26 {\obeyspaces
  27 \global\chardef\sp@ce=32
  28 \gdef\showsp@ces{\ifshowspaces\let =\sp@ce\fi}
  29 \global\let =\ }
  30
  31 \catcode124=\active % Make | active
  32 \def\ttst@rt{\begingroup\setverb@tim\let|=\endgroup}
  33 \let|=\ttst@rt
  34
  35 % Typesetting of verbatim blocks:
  36 %       - the block is enclosed in balanced {}'s
  37 %       - leading and trailing empty lines are ignored
  38 %       - all other empty lines are converted to \verbemptylineskip's
  39 %       - tabs are interpreted (one tab stop per \verbtabsize columns)
  40 %       - \showspacestrue works here, too, but it does not apply to tabs
  41
  42 \newskip\verbstartskip          % vskip before \verbatim
  43 \newskip\verbendskip            % vskip after \verbatim
  44 \newskip\verbinterlineskip      % between adjacent non-empty lines
  45 \newskip\verbemptylineskip      % instead of every empty line
  46 \newskip\verbleftskip           % left and right margin
  47 \newskip\verbrightskip
  48
  49 \verbstartskip=3pt plus 1pt minus 0.3pt
  50 \verbendskip=\verbstartskip
  51 \verbinterlineskip=0pt
  52 \verbemptylineskip=5pt plus 2pt
  53 \verbleftskip=0in
  54 \verbrightskip=0pt plus 1fil
  55
  56 % Can be re-defined to customize the verbatim environment
  57 \def\verblocaldefs{}
  58
  59 % Size of a single tab
  60 \newcount\verbtabsize
  61 \verbtabsize=8
  62
  63 \newdimen\v@rbspace
  64 \newdimen\t@b
  65 \newdimen\t@bwidth
  66
  67 % When a complete line is assembled in \box0, \verbship is called to add it
  68 % to the main vertical list. You can override it to get e.g. line numbering.
  69 \def\verbship{%
  70         \ifdim\wd0>0pt
  71                 \ifdim\v@rbspace>0pt
  72                         \penalty-100
  73                         \vskip\v@rbspace
  74                 \else
  75                         \ifdim\v@rbspace=0pt
  76                                 \vskip\verbinterlineskip
  77                         \fi
  78                 \fi
  79                 \line{\hskip\verbleftskip \box0 \hskip\verbrightskip}
  80                 \v@rbspace=0pt
  81         \else
  82                 \advance\v@rbspace by \verbemptylineskip
  83         \fi
  84 }
  85
  86 \newcount\verbcnt
  87 \def\v@rbend{\par\egroup\endgroup\vskip\verbendskip}
  88 \def\v@rbl{\ifnum\verbcnt>0\{\fi\global\advance\verbcnt by 1\relax}
  89 \def\v@rbr{\ifnum\verbcnt>1\}\else\v@rbend\fi\global\advance\verbcnt by -1\relax}
  90
  91 \def\v@rbparams{%
  92         \setverb@tim
  93         \raggedbottom
  94         \verbcnt=0
  95         \v@rbspace=-1000pt
  96         \catcode124=12
  97         \vskip\verbstartskip
  98         \let\par=\endb@x
  99         \obeylines
 100 }
 101
 102 \def\startb@x{\setbox0=\hbox\bgroup}
 103 \def\endb@x{\egroup\verbship\startb@x}
 104
 105 {\catcode`\^^I=\active
 106 \gdef\setupt@bs{\catcode`\^^I=\active
 107 \setbox0=\hbox{\ }\t@bwidth=\wd0\multiply\t@bwidth by \verbtabsize
 108 \def^^I{\egroup\t@b=\wd0\divide\t@b by \t@bwidth%
 109 \multiply\t@b by \t@bwidth%
 110 \advance\t@b by \t@bwidth\advance\t@b by -\wd0\startb@x\box0\hbox to \t@b{}}%
 111 }}
 112
 113 {
 114 \catcode`[=1\catcode`]=2\catcode123=\active\catcode125=\active
 115 \gdef\verbatim[\begingroup\v@rbparams\catcode123=\active\catcode125=\active%
 116 \let{=\v@rbl\let}=\v@rbr\chardef\{=123\chardef\}=125\verblocaldefs\setupt@bs\startb@x%
 117 ]]
 118
 119 % Input file verbatim
 120
 121 \def\verbinput#1{\begingroup\v@rbparams\verblocaldefs\setupt@bs\startb@x\input #1 \egroup\endgroup}
 122
 123 % Let's hide all internal macros
 124 \catcode`@=12