1 % The UCW Macro Collection (a successor of mjmac.tex)
2 % Written by Martin Mares <mj@ucw.cz> in 2010--2018 and placed into public domain
3 % -------------------------------------------------------------------------------
5 \ifx\ucwmodule\undefined\else\endinput\fi
9 % We'll use internal macros of plain TeX
12 \ifx\eTeXversion\undefined
13 \errmessage{ucwmac requires the e-TeX engine or its successor}
16 %%% PDF output detection %%%
21 \ifx\pdfoutput\undefined
22 \else\ifnum\pdfoutput>0
24 \pdfpkresolution=600 % Provide a reasonable default
27 \ifx\luatexversion\undefined\else
28 % In LuaTeX \pdfpkresolution is not enough
29 \directlua{kpse.init_prog("luatex", 600, "ljfour")}
32 %%% Temporary registers %%%
37 %%% Auxiliary macros %%%
39 % Prepend/append #2 to the definition of #1
40 \long\def\prependef#1#2{\expandafter\def\expandafter#1\expandafter{#2#1}}
41 \long\def\appendef#1#2{\expandafter\def\expandafter#1\expandafter{#1#2}}
43 % Variants of \def and \let, where the control sequence name is given as a string
44 \def\sdef#1{\expandafter\def\csname#1\endcsname}
45 \def\slet#1#2{\expandafter\let\csname#1\expandafter\endcsname\csname#2\endcsname}
47 % Assign a control sequence given as a string, complain if it is not defined.
48 \def\sget#1#2{\ifcsname#2\endcsname
49 \expandafter\let\expandafter#1\csname#2\endcsname
51 \errmessage{Undefined control sequence #2}%
56 % Add \protected to an existing macro
57 \def\addprotected#1{\protected\edef#1{\expandafter\unexpanded\expandafter{#1}}}
62 \def\ucwwarn#1{\immediate\write16{*** UCWmac warning: #1 ***}}
64 % Replace all occurrences of #1 in \tmpb by #2.
65 % Thanks to Petr Olsak's OPmac for an efficient implementation.
66 \bgroup \catcode`!=3 \catcode`?=3
67 \gdef\replacestrings#1#2{\long\def\replacestringsA##1#1{\def\tmpb{##1}\replacestringsB}%
68 \long\def\replacestringsB##1#1{\ifx!##1\relax \else\appendef\tmpb{#2##1}%
69 \expandafter\replacestringsB\fi}%
70 \expandafter\replacestringsA\tmpb?#1!#1%
71 \long\def\replacestringsA##1?{\def\tmpb{##1}}\expandafter\replacestringsA\tmpb
75 %%% Page size and margins %%%
77 % If you modify these registers, call \setuppage afterwards
78 \ifx\luatexversion\undefined
79 % In LuaTeX, \pagewidth and \pageheight are primitive
80 % (also, we need \csname here, because \newdimen is \outer)
81 \csname newdimen\endcsname\pagewidth
82 \csname newdimen\endcsname\pageheight
87 \newdimen\bottommargin
88 \newdimen\evenpageshift
92 \advance\hsize by -\leftmargin
93 \advance\hsize by -\rightmargin
95 \advance\vsize by -\topmargin
96 \advance\vsize by -\bottommargin
98 \advance\hoffset by -1truein
100 \advance\voffset by -1truein
104 \ifx\luatexversion\undefined
105 \pdfpagewidth=\pagewidth
106 \pdfpageheight=\pageheight
111 % Set multiple margins to the same value
112 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
113 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
114 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
116 % Define inner/outer margin instead of left/right
117 \def\setinneroutermargin#1#2{\leftmargin#1\relax\rightmargin#2\relax\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
119 % Use a predefined paper format, calls \setuppage automagically
121 \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
122 \ifx\currentpaper\relax
123 \errmessage{Undefined paper format #1}
128 % Switch to landscape orientation, calls \setuppage automagically
131 \pageheight=\pagewidth
137 \def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
138 \defpaper{a3}{297truemm}{420truemm}
139 \defpaper{a4}{210truemm}{297truemm}
140 \defpaper{a5}{148truemm}{210truemm}
141 \defpaper{letter}{8.5truein}{11truein}
142 \defpaper{legal}{8.5truein}{14truein}
144 % Default page parameters
148 %%% Macros with optional arguments %%%
150 % After \def\a{\withoptarg\b}, the macro \a behaves in this way:
151 % \a[arg] does \def\optarg{arg} and then it expands \b
152 % \a does \let\optarg=\relax and then it expands \b
153 \def\withoptarg#1{\let\xoptcall=#1\futurelet\next\xopt}
154 \def\xopt{\ifx\next[\expandafter\xoptwith\else\let\optarg=\relax\expandafter\xoptcall\fi}
155 \def\xoptwith[#1]{\def\optarg{#1}\xoptcall}
157 % A shortcut for defining macros with optional arguments:
158 % \optdef\macro behaves as \def\domacro, while \macro itself is defined
159 % as a wrapper calling \domacro using \withoptarg.
161 \edef\xoptname{\expandafter\eatbackslash\string#1}%
162 \edef#1{\noexpand\withoptarg\csname do\xoptname\endcsname}%
163 \expandafter\def\csname do\xoptname\endcsname
166 % Trick: \eatbackslash eats the next backslash of category 12
167 \begingroup\lccode`\+=`\\
168 \lowercase{\endgroup\def\eatbackslash+{}}
170 % Expand to the optional argument if it exists
171 \def\optargorempty{\ifx\optarg\relax\else\optarg\fi}
173 %%% Placing material at specified coordinates %%%
175 % Set all dimensions of a given box register to zero
176 \def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
177 \long\def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
178 \long\def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}
180 % Variants of \llap and \rlap working equally on both sides and/or vertically
181 \def\hlap#1{\hbox to 0pt{\hss #1\hss}}
182 \def\vlap#1{\vbox to 0pt{\vss #1\vss}}
183 \def\clap#1{\vlap{\hlap{#1}}}
185 % \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
186 % reference point lies at the given position wrt. the current ref point
187 \long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}
189 % Like \vbox, but with reference point in the upper left corner
190 \long\def\vhang#1{\vtop{\hrule height 0pt\relax #1}}
192 % Like \vhang, but respecting interline skips
193 \long\def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}
195 % Crosshair with reference point in its center
196 \def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}
198 %%% Output routine %%%
200 \newbox\pageunderlays
202 \newbox\commonunderlays
203 \newbox\commonoverlays
205 % In addition to the normal page contents, you can define page overlays
206 % and underlays, which are zero-size vboxes positioned absolutely in the
207 % front / in the back of the normal material. Also, there are global
208 % versions of both which are not reset after every page.
209 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\nointerlineskip\smashedvbox{#2}}}
210 \def\pageunderlay{\addlay\pageunderlays}
211 \def\pageoverlay{\addlay\pageoverlays}
212 \def\commonunderlay{\addlay\commonoverlays}
213 \def\commonoverlay{\addlay\commonoverlays}
215 % Our variation on \plainoutput, which manages inner/outer margins and overlays
217 \newdimen\pagebodydepth
218 \def\ucwoutput{\wigglepage\shipout\vbox{%
220 \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
221 \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
223 \pagebodydepth=\prevdepth
225 \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays\vss}\nointerlineskip\fi
226 \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays\vss}\nointerlineskip\fi
227 \prevdepth=\pagebodydepth
230 \ifnum\outputpenalty>-\@MM \else\dosupereject\fi}
232 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
234 % Make it easier to redefine footline font (also, fix it so that OFS won't change it unless asked)
236 \footline={\hss\footfont\folio\hss}
247 % Available styles (others can be defined by \sdef{item:<style>}{<marker>})
261 % Meta-styles (can be used to modify an arbitrary style, currently hard-wired)
263 % #. % with a dot behind
264 % #) % with a parenthesis behind
265 % (#) % enclosed in parentheses
266 % [#] % enclosed in square brackets
270 % \itemize\ibull % or other marker
275 % \numlist\ndotted % or other numbering style
280 % Default dimensions of itemized lists
281 \newdimen\itemindent \itemindent=0.5in
282 \newdimen\itemnarrow \itemnarrow=0.5in % make lines narrower by this amount
283 \newskip\itemmarkerskip \itemmarkerskip=0.4em % between marker and the item
284 \newskip\preitemizeskip \preitemizeskip=3pt plus 2pt minus 1pt % before the list
285 \newskip\postitemizeskip \postitemizeskip=3pt plus 2pt minus 1pt % after the list
286 \newskip\interitemskip \interitemskip=2pt plus 1pt minus 0.5pt % between two items
288 % Analogues for nested lists
289 \newdimen\nesteditemindent \nesteditemindent=0.25in
290 \newdimen\nesteditemnarrow \nesteditemnarrow=0.25in
291 \newskip\prenesteditemizeskip \prenesteditemizeskip=0pt
292 \newskip\postnesteditemizeskip \postnesteditemizeskip=0pt
294 \newif\ifitems\itemsfalse
299 \newcount\preitemizepenalty \preitemizepenalty=-500
300 \newcount\postitemizepenalty \postitemizepenalty=-500
304 \vskip\prenesteditemizeskip
305 \advance\leftskip by \nesteditemindent
306 \advance\rightskip by \nesteditemnarrow
308 \ifnum\preitemizepenalty=0\else\penalty\preitemizepenalty\fi
309 \vskip\preitemizeskip
310 \advance\leftskip by \itemindent
311 \advance\rightskip by \itemnarrow
313 \parskip=\interitemskip
318 \vskip\postnesteditemizeskip
320 \ifnum\postitemizepenalty=0\else\penalty\postitemizepenalty\fi
321 \vskip\postitemizeskip
325 \def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
327 \def\list#1{\inititemize\itemcount=0\liststyle{#1}\let\:=\listitem}
328 \def\listitem{\par\leavevmode\advance\itemcount by 1
329 \llap{\listmarker\hskip\itemmarkerskip}\ignorespaces}
333 \ifcsname item:\markertmp\endcsname
334 \sget\listmarker{item:\markertmp}%
336 \sget\listmarker{metaitem:\markertometa#1^^X}%
337 \sget\markerinner{item:\markertoinner#1^^X}%
341 \def\markertometa#1{%
351 \expandafter\markertometa
355 \def\markertoinner#1{%
365 \expandafter\markertoinner
369 \def\endlist{\par\endgroup\postitemize}
372 \sdef{item:o}{\raise0.2ex\hbox{$\bullet$}}
373 \sdef{item:O}{\raise0.2ex\hbox{$\circ$}}
374 \sdef{item:*}{\raise0.2ex\hbox{$\ast$}}
376 \sdef{item:.}{\raise0.2ex\hbox{$\cdot$}}
377 \sdef{item:n}{\the\itemcount}
378 \sdef{item:i}{\romannumeral\itemcount}
379 \sdef{item:I}{\uppercase\expandafter{\romannumeral\itemcount}}
380 \sdef{item:a}{\char\numexpr 96+\itemcount\relax}
381 \sdef{item:A}{\char\numexpr 64+\itemcount\relax}
382 \sdef{item:g}{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
383 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
384 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$}
387 \sdef{metaitem:=.}{\markerinner.}
388 \sdef{metaitem:=)}{\markerinner)}
389 \sdef{metaitem:(=)}{(\markerinner)}
390 \sdef{metaitem:[=]}{[\markerinner]}
394 \def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
397 \def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
399 \def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
400 \let\itemnumbering=#1}
402 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
403 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
407 \def\ibull{\raise0.2ex\hbox{$\bullet$}}
408 \def\idot{\raise0.2ex\hbox{$\cdot$}}
409 \def\istar{\raise0.2ex\hbox{$\ast$}}
411 \def\nnorm{\the\itemcount}
412 \def\ndotted{\nnorm.}
414 \def\nparenp{(\nnorm)}
415 \def\nroman{\romannumeral\itemcount}
416 \def\nromanp{\nroman)}
417 \def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
418 \def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
419 \def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
420 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
421 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
425 % {\I italic} with automatic italic correction
426 \def\I{\it\aftergroup\/}
428 % A breakable dash, to be repeated on the next line
429 \def\={\discretionary{-}{-}{-}}
431 % Non-breakable identifiers
432 \def\<#1>{\leavevmode\hbox{\I #1}}
438 % Variants of \centerline, \leftline and \rightline, which are compatible with
439 % verbatim environments and other catcode hacks
440 \def\cline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
441 \def\lline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
442 \def\rline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
444 % Insert a PDF picture
445 % \putimage{width specification}{file}
446 \def\putimage#1#2{\hbox{\pdfximage #1{#2}\pdfrefximage\pdflastximage}}
450 % Use of pdfTeX color stack:
451 % \colorpush\rgb{1 0 0} puts a new color on the stack
452 % \colorset\rgb{1 0 0} replaces the top color on the stack
453 % \colorpop pops the top color
454 % \colorlocal\rgb{1 0 0} set a color locally until the end of the current group
455 \chardef\colorstk=\pdfcolorstackinit page direct{0 g 0 G}
456 \def\colorset#1{\pdfcolorstack\colorstk set #1}
457 \def\colorpush#1{\pdfcolorstack\colorstk push #1}
458 \def\colorpop{\pdfcolorstack\colorstk pop}
459 \def\colorlocal{\aftergroup\colorpop\colorpush}
461 % Different ways of describing colors: \rgb{R G B}, \gray{G}, \cmyk{C M Y K}
462 % (all components are real numbers between 0 and 1)
463 \def\rgb#1{{#1 rg #1 RG}}
464 \def\gray#1{{#1 g #1 G}}
465 \def\cmyk#1{{#1 k #1 K}}
469 % Define a new localized string: \localedef{language}{identifier}{message}
470 % (we use \language codes to identify languages)
471 \def\localedef#1#2{\tmpcount=#1\expandafter\def\csname loc:\the\tmpcount:#2\endcsname}
473 % Expand a localized string in the current language: \localemsg{identifier}
475 \ifcsname loc:\the\language:#1\endcsname
476 \csname loc:\the\language:#1\endcsname
478 \ucwwarn{Localized string #1 not defined in language \the\language}%
485 % Require a module: load it if it is not already loaded
487 \ifcsname ucwmod:#1\endcsname
493 % Definition of a new module (to be placed at the beginning of its file)
494 % (Also guards against repeated loading if somebody uses \input instead of \ucwmodule.)
496 \ifcsname ucwmod:#1\endcsname\endinput\fi
497 \expandafter\let\csname ucwmod:#1\endcsname=\relax
502 % Let's hide all internal macros