\verbatim finished

[ucwmac.git] / ucwmac.tex

% The UCW Macro Collection (a successor of mjmac.tex)
% Written by Martin Mares <mj@ucw.cz> in 2010 and placed into public domain
% -------------------------------------------------------------------------

%%% Prolog %%%

% We'll use internal macros of plain TeX
\catcode`@=11

%%% PDF output detection %%%

\newif\ifpdf
\pdffalse

\ifx\pdfoutput\undefined
\else\ifnum\pdfoutput>0
        \pdftrue
\fi\fi

%%% Page size and margins %%%

% If you modify these registers, call \setuppage afterwards
\newdimen\pagewidth
\newdimen\pageheight
\newdimen\leftmargin
\newdimen\rightmargin
\newdimen\topmargin
\newdimen\bottommargin
\newdimen\evenpageshift

\def\setuppage{%
        \hsize=\pagewidth
        \advance\hsize by -\leftmargin
        \advance\hsize by -\rightmargin
        \vsize=\pageheight
        \advance\vsize by -\topmargin
        \advance\vsize by -\bottommargin
        \hoffset=\leftmargin
        \advance\hoffset by -1truein
        \voffset=\topmargin
        \advance\voffset by -1truein
        \ifpdf
                \pdfpagewidth=\pagewidth
                \pdfpageheight=\pageheight
        \fi
}

% Set multiple margins to the same value
\def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
\def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
\def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}

% Define inner/outer margin instead of left/right
\def\setinneroutermargin#1#2{\sethmargins{#1}{#2}\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}

% Use a predefined paper format, calls \setuppage automagically
\def\setpaper#1{%
        \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
        \ifx\currentpaper\relax
                \errmessage{Undefined paper format #1}
        \fi
        \currentpaper
}

% Switch to landscape orientation, calls \setuppage automagically
\def\landscape{%
        \dimen0=\pageheight
        \pageheight=\pagewidth
        \pagewidth=\dimen0
        \setuppage
}

% Common paper sizes
\def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
\defpaper{a3}{297truemm}{420truemm}
\defpaper{a4}{210truemm}{297truemm}
\defpaper{a5}{148truemm}{210truemm}
\defpaper{a6}{105truemm}{148truemm}
\defpaper{letter}{8.5truein}{11truein}
\defpaper{legal}{8.5truein}{14truein}

% Default page parameters
\setmargins{1truein}
\setpaper{a4}

%%% Placing material at specified coordinates %%%

% Set all dimensions of a given box register to zero
\def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
\def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
\def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}

% Variants of \llap and \rlap working equally on both sides and/or vertically
\def\hlap#1{\hbox to 0pt{\hss #1\hss}}
\def\vlap#1{\vbox to 0pt{\vss #1\vss}}
\def\clap#1{\vlap{\hlap{#1}}}

% \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
% reference point lies at the given position wrt. the current ref point
\long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}

% Like \vbox, but with reference point in the upper left corner
\def\vhang#1{\vtop{\hrule height 0pt\relax #1}}

% Like \vhang, but respecting interline skips
\def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}

% Crosshair with reference point in its center
\def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}

%%% Output routine %%%

\newbox\pageunderlays
\newbox\pageoverlays
\newbox\commonunderlays
\newbox\commonoverlays

% In addition to the normal page contents, you can define page overlays
% and underlays, which are zero-size vboxes positioned absolutely in the
% front / in the back of the normal material. Also, there are global
% versions of both which are not reset after every page.
\def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\smashedvbox{#2}}}
\def\pageunderlay{\addlay\pageunderlays}
\def\pageoverlay{\addlay\pageoverlays}
\def\commonunderlay{\addlay\commonoverlays}
\def\commonoverlay{\addlay\commonoverlays}

% Our variation on \plainoutput, which manages inner/outer margins and overlays
\output{\ucwoutput}
\def\ucwoutput{\wigglepage\shipout\vbox{%
        \makeheadline
        \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
        \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
        \pagebody
        \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays}\fi
        \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays}\fi
        \makefootline
}\advancepageno
\ifnum\outputpenalty>-\@MM \else\dosupereject\fi}

\def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}

%%% Itemization %%%

% Default dimensions of itemized lists
\newdimen\itemindent            \itemindent=0.5in
\newdimen\itemnarrow            \itemnarrow=0.5in                       % make lines narrower by this amount
\newskip\itemmarkerskip         \itemmarkerskip=0.4em                   % between marker and the item
\newskip\preitemizeskip         \preitemizeskip=3pt plus 2pt minus 1pt  % before the list
\newskip\postitemizeskip        \postitemizeskip=3pt plus 2pt minus 1pt % after the list
\newskip\interitemskip          \interitemskip=2pt plus 1pt minus 0.5pt % between two items

% Analogues for nested lists
\newdimen\nesteditemindent      \nesteditemindent=0.25in
\newdimen\nesteditemnarrow      \nesteditemnarrow=0.25in
\newskip\prenesteditemizeskip   \prenesteditemizeskip=0pt
\newskip\postnesteditemizeskip  \postnesteditemizeskip=0pt

\newif\ifitems\itemsfalse
\newbox\itembox
\newcount\itemcount

\def\preitemize{
        \ifitems
                \vskip\prenesteditemizeskip
                \advance\leftskip by \nesteditemindent
                \advance\rightskip by \nesteditemnarrow
        \else
                \vskip\preitemizeskip
                \advance\leftskip by \itemindent
                \advance\rightskip by \itemnarrow
        \fi
        \parskip=\interitemskip
}

\def\postitemize{
        \ifitems
                \vskip\postnesteditemizeskip
        \else
                \vskip\postitemizeskip
        \fi
}

\def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}

\def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
\let\:=\singleitem}

\def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}

\def\endlist{\par\endgroup\postitemize}

\def\ibull{\raise0.2ex\hbox{$\bullet$}} % Signs frequently used for \itemize
\def\idot{\raise0.2ex\hbox{$\cdot$}}
\def\istar{\raise0.2ex\hbox{$\ast$}}

\def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
\let\itemnumbering=#1}

\def\numbereditem{\par\leavevmode\advance\itemcount by 1
\llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}

\def\nnorm{\the\itemcount}
\def\ndotted{\nnorm.}
\def\nparen{\nnorm)}
\def\nroman{\romannumeral\itemcount}
\def\nromanp{\nroman)}
\def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
\def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
\def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
\zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
\or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}

%%% Verbatim typesetting %%%

% New \frenchspacing, which doesn't leave unwanted spaces in text.
\def\frenchsp@cing{\sfcode`\.\@m \sfcode`\?\@m \sfcode`\!\@m%
\sfcode`\:\@m \sfcode`\;\@m \sfcode`\,\@m}

% Typesetting of one verbatim word: |word|

% Set if spaces should be rendered as "bath-tub" glyphs
\newif\ifshowspaces
\showspacesfalse

\def\make@ther#1{\catcode`#1=12\relax}
\def\setverb@tim{\tt\frenchsp@cing\catcode`\`=13\catcode`\'=13\n@ligs%
\let\do=\make@ther\dospecials\obeyspaces\showsp@ces}

{\catcode`'=13
\catcode``=13
\gdef\n@ligs{\def`{\relax\lq}\def'{\relax\rq}}}

{\obeyspaces
\global\chardef\sp@ce=32
\gdef\showsp@ces{\ifshowspaces\let =\sp@ce\fi}
\global\let =\ }

\catcode124=\active % Make | active
\def\ttst@rt{\begingroup\setverb@tim\let|=\endgroup}
\let|=\ttst@rt

% Typesetting of verbatim blocks:
%       - the block is enclosed in balanced {}'s
%       - leading and trailing empty lines are ignored
%       - all other empty lines are converted to \verbemptylineskip's
%       - tabs are interpreted (one tab stop per \verbtabsize columns)
%       - \showspacestrue works here, too, but it does not apply to tabs

\newskip\verbstartskip          % vskip before \verbatim
\newskip\verbendskip            % vskip after \verbatim
\newskip\verbinterlineskip      % between adjacent non-empty lines
\newskip\verbemptylineskip      % instead of every empty line
\newskip\verbleftskip           % left and right margin
\newskip\verbrightskip

\verbstartskip=3pt plus 1pt minus 0.3pt
\verbendskip=\verbstartskip
\verbinterlineskip=0pt
\verbemptylineskip=5pt plus 2pt
\verbleftskip=0in
\verbrightskip=0pt plus 1fil

% Can be re-defined to customize the verbatim environment
\def\verblocaldefs{}

% Size of a single tab
\newcount\verbtabsize
\verbtabsize=8

\newdimen\v@rbspace
\newdimen\t@b
\newdimen\t@bwidth

% When a complete line is assembled in \box0, \verbship is called to add it
% to the main vertical list. You can override it to get e.g. line numbering.
\def\verbship{%
        \ifdim\wd0>0pt
                \ifdim\v@rbspace>0pt
                        \penalty-100
                        \vskip\v@rbspace
                \else
                        \ifdim\v@rbspace=0pt
                                \vskip\verbinterlineskip
                        \fi
                \fi
                \line{\hskip\verbleftskip \box0 \hskip\verbrightskip}
                \v@rbspace=0pt
        \else
                \advance\v@rbspace by \verbemptylineskip
        \fi
}

\newcount\verbcnt
\def\v@rbend{\par\egroup\endgroup\vskip\verbendskip}
\def\v@rbl{\ifnum\verbcnt>0\{\fi\global\advance\verbcnt by 1\relax}
\def\v@rbr{\ifnum\verbcnt>1\}\else\v@rbend\fi\global\advance\verbcnt by -1\relax}

\def\v@rbparams{%
        \setverb@tim
        \raggedbottom
        \verbcnt=0
        \v@rbspace=-1000pt
        \catcode124=12
        \vskip\verbstartskip
        \let\par=\endb@x
        \obeylines
}

\def\startb@x{\setbox0=\hbox\bgroup}
\def\endb@x{\egroup\verbship\startb@x}

{\catcode`\^^I=\active
\gdef\setupt@bs{\catcode`\^^I=\active
\setbox0=\hbox{\ }\t@bwidth=\wd0\multiply\t@bwidth by \verbtabsize
\def^^I{\egroup\t@b=\wd0\divide\t@b by \t@bwidth%
\multiply\t@b by \t@bwidth%
\advance\t@b by \t@bwidth\advance\t@b by -\wd0\startb@x\box0\hbox to \t@b{}}%
}}

{
\catcode`[=1\catcode`]=2\catcode123=\active\catcode125=\active
\gdef\verbatim[\begingroup\v@rbparams\catcode123=\active\catcode125=\active%
\let{=\v@rbl\let}=\v@rbr\chardef\{=123\chardef\}=125\verblocaldefs\setupt@bs\startb@x%
]]

% Input file verbatim

\def\verbinput#1{\begingroup\v@rbparams\verblocaldefs\setupt@bs\startb@x\input #1 \egroup\endgroup}

%%% Epilog %%%

% Let's hide all internal macros
\catcode`@=12