ucwmac.tex

   1 % The UCW Macro Collection (a successor of mjmac.tex)
   2 % Written by Martin Mares <mj@ucw.cz> in 2010 and placed into public domain
   3 % -------------------------------------------------------------------------
   4
   5 %%% Prolog %%%
   6
   7 % We'll use internal macros of plain TeX
   8 \catcode`@=11
   9
  10 %%% PDF output detection %%%
  11
  12 \newif\ifpdf
  13 \pdffalse
  14
  15 \ifx\pdfoutput\undefined
  16 \else\ifnum\pdfoutput>0
  17         \pdftrue
  18 \fi\fi
  19
  20 %%% Page size and margins %%%
  21
  22 % If you modify these registers, call \setuppage afterwards
  23 \newdimen\pagewidth
  24 \newdimen\pageheight
  25 \newdimen\leftmargin
  26 \newdimen\rightmargin
  27 \newdimen\topmargin
  28 \newdimen\bottommargin
  29 \newdimen\evenpageshift
  30
  31 \def\setuppage{%
  32         \hsize=\pagewidth
  33         \advance\hsize by -\leftmargin
  34         \advance\hsize by -\rightmargin
  35         \vsize=\pageheight
  36         \advance\vsize by -\topmargin
  37         \advance\vsize by -\bottommargin
  38         \hoffset=\leftmargin
  39         \advance\hoffset by -1truein
  40         \voffset=\topmargin
  41         \advance\voffset by -1truein
  42         \ifpdf
  43                 \pdfpagewidth=\pagewidth
  44                 \pdfpageheight=\pageheight
  45         \fi
  46 }
  47
  48 % Set multiple margins to the same value
  49 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
  50 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
  51 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
  52
  53 % Define inner/outer margin instead of left/right
  54 \def\setinneroutermargin#1#2{\sethmargins{#1}{#2}\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
  55
  56 % Use a predefined paper format, calls \setuppage automagically
  57 \def\setpaper#1{%
  58         \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
  59         \ifx\currentpaper\relax
  60                 \errmessage{Undefined paper format #1}
  61         \fi
  62         \currentpaper
  63 }
  64
  65 % Switch to landscape orientation, calls \setuppage automagically
  66 \def\landscape{%
  67         \dimen0=\pageheight
  68         \pageheight=\pagewidth
  69         \pagewidth=\dimen0
  70         \setuppage
  71 }
  72
  73 % Common paper sizes
  74 \def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
  75 \defpaper{a3}{297truemm}{420truemm}
  76 \defpaper{a4}{210truemm}{297truemm}
  77 \defpaper{a5}{148truemm}{210truemm}
  78 \defpaper{a6}{105truemm}{148truemm}
  79 \defpaper{letter}{8.5truein}{11truein}
  80 \defpaper{legal}{8.5truein}{14truein}
  81
  82 % Default page parameters
  83 \setmargins{1truein}
  84 \setpaper{a4}
  85
  86 %%% Placing material at specified coordinates %%%
  87
  88 % Set all dimensions of a given box register to zero
  89 \def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
  90 \def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
  91 \def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}
  92
  93 % Variants of \llap and \rlap working equally on both sides and/or vertically
  94 \def\hlap#1{\hbox to 0pt{\hss #1\hss}}
  95 \def\vlap#1{\vbox to 0pt{\vss #1\vss}}
  96 \def\clap#1{\vlap{\hlap{#1}}}
  97
  98 % \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
  99 % reference point lies at the given position wrt. the current ref point
 100 \long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}
 101
 102 % Like \vbox, but with reference point in the upper left corner
 103 \def\vhang#1{\vtop{\hrule height 0pt\relax #1}}
 104
 105 % Like \vhang, but respecting interline skips
 106 \def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}
 107
 108 % Crosshair with reference point in its center
 109 \def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}
 110
 111 %%% Output routine %%%
 112
 113 \newbox\pageunderlays
 114 \newbox\pageoverlays
 115 \newbox\commonunderlays
 116 \newbox\commonoverlays
 117
 118 % In addition to the normal page contents, you can define page overlays
 119 % and underlays, which are zero-size vboxes positioned absolutely in the
 120 % front / in the back of the normal material. Also, there are global
 121 % versions of both which are not reset after every page.
 122 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\smashedvbox{#2}}}
 123 \def\pageunderlay{\addlay\pageunderlays}
 124 \def\pageoverlay{\addlay\pageoverlays}
 125 \def\commonunderlay{\addlay\commonoverlays}
 126 \def\commonoverlay{\addlay\commonoverlays}
 127
 128 % Our variation on \plainoutput, which manages inner/outer margins and overlays
 129 \output{\ucwoutput}
 130 \def\ucwoutput{\wigglepage\shipout\vbox{%
 131         \makeheadline
 132         \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
 133         \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
 134         \pagebody
 135         \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays}\fi
 136         \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays}\fi
 137         \makefootline
 138 }\advancepageno
 139 \ifnum\outputpenalty>-\@MM \else\dosupereject\fi}
 140
 141 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
 142
 143 %%% Itemization %%%
 144
 145 % Default dimensions of itemized lists
 146 \newdimen\itemindent            \itemindent=0.5in
 147 \newdimen\itemnarrow            \itemnarrow=0.5in                       % make lines narrower by this amount
 148 \newskip\itemmarkerskip         \itemmarkerskip=0.4em                   % between marker and the item
 149 \newskip\preitemizeskip         \preitemizeskip=3pt plus 2pt minus 1pt  % before the list
 150 \newskip\postitemizeskip        \postitemizeskip=3pt plus 2pt minus 1pt % after the list
 151 \newskip\interitemskip          \interitemskip=2pt plus 1pt minus 0.5pt % between two items
 152
 153 % Analogues for nested lists
 154 \newdimen\nesteditemindent      \nesteditemindent=0.25in
 155 \newdimen\nesteditemnarrow      \nesteditemnarrow=0.25in
 156 \newskip\prenesteditemizeskip   \prenesteditemizeskip=0pt
 157 \newskip\postnesteditemizeskip  \postnesteditemizeskip=0pt
 158
 159 \newif\ifitems\itemsfalse
 160 \newbox\itembox
 161 \newcount\itemcount
 162
 163 \def\preitemize{
 164         \ifitems
 165                 \vskip\prenesteditemizeskip
 166                 \advance\leftskip by \nesteditemindent
 167                 \advance\rightskip by \nesteditemnarrow
 168         \else
 169                 \vskip\preitemizeskip
 170                 \advance\leftskip by \itemindent
 171                 \advance\rightskip by \itemnarrow
 172         \fi
 173         \parskip=\interitemskip
 174 }
 175
 176 \def\postitemize{
 177         \ifitems
 178                 \vskip\postnesteditemizeskip
 179         \else
 180                 \vskip\postitemizeskip
 181         \fi
 182 }
 183
 184 \def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
 185
 186 \def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
 187 \let\:=\singleitem}
 188
 189 \def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
 190
 191 \def\endlist{\par\endgroup\postitemize}
 192
 193 \def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
 194 \def\idot{\raise0.2ex\hbox{$\cdot$}}
 195 \def\istar{\raise0.2ex\hbox{$\ast$}}
 196
 197 \def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
 198 \let\itemnumbering=#1}
 199
 200 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
 201 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
 202
 203 \def\nnorm{\the\itemcount}
 204 \def\ndotted{\nnorm.}
 205 \def\nparen{\nnorm)}
 206 \def\nroman{\romannumeral\itemcount}
 207 \def\nromanp{\nroman)}
 208 \def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
 209 \def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
 210 \def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
 211 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
 212 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
 213
 214 %%% Verbatim typesetting %%%
 215
 216 % New \frenchspacing, which doesn't leave unwanted spaces in text.
 217 \def\frenchsp@cing{\sfcode`\.\@m \sfcode`\?\@m \sfcode`\!\@m%
 218 \sfcode`\:\@m \sfcode`\;\@m \sfcode`\,\@m}
 219
 220 % Typesetting of one verbatim word
 221
 222 \newif\ifshowspaces
 223 \showspacesfalse
 224
 225 \def\make@ther#1{\catcode`#1=12\relax}
 226 \def\setverb@tim{\tt\frenchsp@cing\catcode`\`=13\catcode`\'=13\n@ligs%
 227 \let\do=\make@ther\dospecials\obeyspaces\showsp@ces}
 228
 229 {\catcode`'=13
 230 \catcode``=13
 231 \gdef\n@ligs{\def`{\relax\lq}\def'{\relax\rq}}}
 232
 233 {\obeyspaces
 234 \global\chardef\sp@ce=32
 235 \gdef\showsp@ces{\ifshowspaces\let =\sp@ce\fi}
 236 \global\let =\ }
 237
 238 \catcode124=\active % Make | active
 239 \def\ttst@rt{\begingroup\setverb@tim\let|=\endgroup}
 240 \let|=\ttst@rt
 241
 242 % Typesetting of verbatim block (enclosed in balanced {}'s)
 243
 244 \newskip\verbglue
 245 \newskip\verblineglue
 246 \newskip\verbleftskip
 247 \newskip\verbrightskip
 248
 249 \verbglue=3pt plus 1pt minus 0.3pt
 250 \verblineglue=0pt plus 1.5pt
 251 \verbleftskip=1in
 252 \verbrightskip=0pt plus 1fil
 253 \def\verblocaldefs{}
 254
 255 \newdimen\tabwidth
 256 \newcount\tabsize
 257 \tabsize=8
 258 \newdimen\t@b
 259
 260 \newdimen\v@rbspace
 261
 262 \def\verbship{%
 263         \ifdim\wd0>0pt
 264                 \ifdim\v@rbspace>0pt \vskip\v@rbspace \fi
 265                 \line{\hskip\verbleftskip \vrule\box0\vrule \hskip\verbrightskip}
 266                 \v@rbspace=0pt
 267         \else
 268                 \advance\v@rbspace by 0.3\baselineskip  %FIXME
 269         \fi
 270 }
 271
 272 \newcount\verbcnt
 273 \def\v@rbend{\par\egroup\endgroup\vskip\verbglue}
 274 \def\v@rbl{\ifnum\verbcnt>0\{\fi\global\advance\verbcnt by 1\relax}
 275 \def\v@rbr{\ifnum\verbcnt>1\}\else\v@rbend\fi\global\advance\verbcnt by -1\relax}
 276
 277 \def\v@rbparams{\setverb@tim\raggedbottom
 278 \verbcnt=0
 279 \v@rbspace=-1000pt
 280 \catcode124=12\setupt@bs\vskip\verbglue\defb@x\obeylines}
 281
 282 \def\startb@x{\setbox0=\hbox\bgroup}
 283 \def\defb@x{\def\par{\egroup\verbship\startb@x}}
 284
 285 {\catcode`\^^I=\active
 286 \gdef\setupt@bs{\catcode`\^^I=\active
 287 \setbox0=\hbox{\tt\ }\tabwidth=\wd0\multiply\tabwidth by \tabsize%FIXME!!!
 288 \def^^I{\egroup\t@b=\wd0\divide\t@b by \tabwidth%
 289 \multiply\t@b by \tabwidth%
 290 \advance\t@b by \tabwidth\advance\t@b by -\wd0\startb@x\box0\hbox to \t@b{}}%
 291 }}
 292
 293 {
 294 \catcode`[=1\catcode`]=2\catcode123=\active\catcode125=\active
 295 \gdef\verbatim[\begingroup\v@rbparams\catcode123=\active\catcode125=\active%
 296 \let{=\v@rbl\let}=\v@rbr\chardef\{=123\chardef\}=125\verblocaldefs\startb@x%
 297 ]]
 298
 299 % Input file verbatim
 300
 301 \def\verbinput#1{\begingroup\v@rbparams\verblocaldefs\input #1\endgroup}
 302
 303 %%% Epilog %%%
 304
 305 % Let's hide all internal macros
 306 \catcode`@=12