]> mj.ucw.cz Git - ucwmac.git/blob - ucwmac.tex
Locale: Use TeX language codes
[ucwmac.git] / ucwmac.tex
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 % -------------------------------------------------------------------------------
4
5 \ifx\ucwmodule\undefined\else\endinput\fi
6
7 %%% Prolog %%%
8
9 % We'll use internal macros of plain TeX
10 \catcode`@=11
11
12 \ifx\eTeXversion\undefined
13 \errmessage{ucwmac requires the e-TeX engine or its successor}
14 \fi
15
16 %%% PDF output detection %%%
17
18 \newif\ifpdf
19 \pdffalse
20
21 \ifx\pdfoutput\undefined
22 \else\ifnum\pdfoutput>0
23         \pdftrue
24         \pdfpkresolution=600    % Provide a reasonable default
25 \fi\fi
26
27 \ifx\directlua\undefined\else
28         % In LuaTeX \pdfpkresolution is not enough
29         \directlua{kpse.init_prog("luatex", 600, "ljfour")}
30 \fi
31
32 %%% Temporary registers %%%
33
34 \newcount\tmpcount
35 \newdimen\tmpdimen
36
37 %%% Auxiliary macros %%%
38
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}}
42
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}
46
47 % Add \protected to an existing macro
48 \def\addprotected#1{\protected\edef#1{\expandafter\unexpanded\expandafter{#1}}}
49
50 % Protect ~
51 \addprotected~
52
53 \def\ucwwarn#1{\immediate\write16{*** UCWmac warning: #1 ***}}
54
55 %%% Page size and margins %%%
56
57 % If you modify these registers, call \setuppage afterwards
58 \ifx\luatexversion\undefined
59         % In LuaTeX, \pagewidth and \pageheight are primitive
60         \newdimen\pagewidth
61         \newdimen\pageheight
62 \fi
63 \newdimen\leftmargin
64 \newdimen\rightmargin
65 \newdimen\topmargin
66 \newdimen\bottommargin
67 \newdimen\evenpageshift
68
69 \def\setuppage{%
70         \hsize=\pagewidth
71         \advance\hsize by -\leftmargin
72         \advance\hsize by -\rightmargin
73         \vsize=\pageheight
74         \advance\vsize by -\topmargin
75         \advance\vsize by -\bottommargin
76         \hoffset=\leftmargin
77         \advance\hoffset by -1truein
78         \voffset=\topmargin
79         \advance\voffset by -1truein
80         \ifpdf
81                 \pdfhorigin=1truein
82                 \pdfvorigin=1truein
83                 \ifx\luatexversion\undefined
84                         \pdfpagewidth=\pagewidth
85                         \pdfpageheight=\pageheight
86                 \fi
87         \fi
88 }
89
90 % Set multiple margins to the same value
91 \def\sethmargins#1{\leftmargin=#1\relax\rightmargin=#1\relax\evenpageshift=0pt\relax}
92 \def\setvmargins#1{\topmargin=#1\relax\bottommargin=#1\relax}
93 \def\setmargins#1{\sethmargins{#1}\setvmargins{#1}}
94
95 % Define inner/outer margin instead of left/right
96 \def\setinneroutermargin#1#2{\leftmargin#1\relax\rightmargin#2\relax\evenpageshift=\rightmargin\advance\evenpageshift by -\leftmargin}
97
98 % Use a predefined paper format, calls \setuppage automagically
99 \def\setpaper#1{%
100         \expandafter\let\expandafter\currentpaper\csname paper-#1\endcsname
101         \ifx\currentpaper\relax
102                 \errmessage{Undefined paper format #1}
103         \fi
104         \currentpaper
105 }
106
107 % Switch to landscape orientation, calls \setuppage automagically
108 \def\landscape{%
109         \dimen0=\pageheight
110         \pageheight=\pagewidth
111         \pagewidth=\dimen0
112         \setuppage
113 }
114
115 % Common paper sizes
116 \def\defpaper#1#2#3{\expandafter\def\csname paper-#1\endcsname{\pagewidth=#2\pageheight=#3\setuppage}}
117 \defpaper{a3}{297truemm}{420truemm}
118 \defpaper{a4}{210truemm}{297truemm}
119 \defpaper{a5}{148truemm}{210truemm}
120 \defpaper{letter}{8.5truein}{11truein}
121 \defpaper{legal}{8.5truein}{14truein}
122
123 % Default page parameters
124 \setmargins{1truein}
125 \setpaper{a4}
126
127 %%% Macros with optional arguments %%%
128
129 % After \def\a{\withoptarg\b}, the macro \a behaves in this way:
130 %       \a[arg]         does \def\optarg{arg} and then it expands \b
131 %       \a              does \let\optarg=\relax and then it expands \b
132 \def\withoptarg#1{\let\xoptcall=#1\futurelet\next\xopt}
133 \def\xopt{\ifx\next[\expandafter\xoptwith\else\let\optarg=\relax\expandafter\xoptcall\fi}
134 \def\xoptwith[#1]{\def\optarg{#1}\xoptcall}
135
136 % A shortcut for defining macros with optional arguments:
137 % \optdef\macro behaves as \def\domacro, while \macro itself is defined
138 % as a wrapper calling \domacro using \withoptarg.
139 \def\optdef#1{%
140         \edef\xoptname{\expandafter\eatbackslash\string#1}%
141         \edef#1{\noexpand\withoptarg\csname do\xoptname\endcsname}%
142         \expandafter\def\csname do\xoptname\endcsname
143 }
144
145 % Trick: \eatbackslash eats the next backslash of category 12
146 \begingroup\lccode`\+=`\\
147 \lowercase{\endgroup\def\eatbackslash+{}}
148
149 % Expand to the optional argument if it exists
150 \def\optargorempty{\ifx\optarg\relax\else\optarg\fi}
151
152 %%% Placing material at specified coordinates %%%
153
154 % Set all dimensions of a given box register to zero
155 \def\smashbox#1{\ht#1=0pt \dp#1=0pt \wd#1=0pt}
156 \long\def\smashedhbox#1{{\setbox0=\hbox{#1}\smashbox0\box0}}
157 \long\def\smashedvbox#1{{\setbox0=\vbox{#1}\smashbox0\box0}}
158
159 % Variants of \llap and \rlap working equally on both sides and/or vertically
160 \def\hlap#1{\hbox to 0pt{\hss #1\hss}}
161 \def\vlap#1{\vbox to 0pt{\vss #1\vss}}
162 \def\clap#1{\vlap{\hlap{#1}}}
163
164 % \placeat{right}{down}{hmaterial} places <hmaterial>, so that its
165 % reference point lies at the given position wrt. the current ref point
166 \long\def\placeat#1#2#3{\smashedhbox{\hskip #1\lower #2\hbox{#3}}}
167
168 % Like \vbox, but with reference point in the upper left corner
169 \long\def\vhang#1{\vtop{\hrule height 0pt\relax #1}}
170
171 % Like \vhang, but respecting interline skips
172 \long\def\vhanglines#1{\vtop{\hbox to 0pt{}#1}}
173
174 % Crosshair with reference point in its center
175 \def\crosshair#1{\clap{\vrule height 0.2pt width #1}\clap{\vrule height #1 width 0.2pt}}
176
177 %%% Output routine %%%
178
179 \newbox\pageunderlays
180 \newbox\pageoverlays
181 \newbox\commonunderlays
182 \newbox\commonoverlays
183
184 % In addition to the normal page contents, you can define page overlays
185 % and underlays, which are zero-size vboxes positioned absolutely in the
186 % front / in the back of the normal material. Also, there are global
187 % versions of both which are not reset after every page.
188 \def\addlay#1#2{\setbox#1=\vbox{\ifvbox#1\box#1\fi\nointerlineskip\smashedvbox{#2}}}
189 \def\pageunderlay{\addlay\pageunderlays}
190 \def\pageoverlay{\addlay\pageoverlays}
191 \def\commonunderlay{\addlay\commonoverlays}
192 \def\commonoverlay{\addlay\commonoverlays}
193
194 % Our variation on \plainoutput, which manages inner/outer margins and overlays
195 \output{\ucwoutput}
196 \newdimen\pagebodydepth
197 \def\ucwoutput{\wigglepage\shipout\vbox{%
198         \makeheadline
199         \ifvbox\commonunderlays\copy\commonunderlays\nointerlineskip\fi
200         \ifvbox\pageunderlays\box\pageunderlays\nointerlineskip\fi
201         \pagebody
202         \pagebodydepth=\prevdepth
203         \nointerlineskip
204         \ifvbox\commonoverlays\vbox to 0pt{\vskip -\vsize\copy\commonoverlays\vss}\nointerlineskip\fi
205         \ifvbox\pageoverlays\vbox to 0pt{\vskip -\vsize\box\pageoverlays\vss}\nointerlineskip\fi
206         \prevdepth=\pagebodydepth
207         \makefootline
208 }\advancepageno
209 \ifnum\outputpenalty>-\@MM \else\dosupereject\fi}
210
211 \def\wigglepage{\ifodd\pageno\else\advance\hoffset by \evenpageshift\fi}
212
213 % Make it easier to redefine footline font (also, fix it so that OFS won't change it unless asked)
214 \let\footfont=\tenrm
215 \footline={\hss\footfont\folio\hss}
216
217 %%% Itemization %%%
218
219 % Usage:
220 %
221 % \itemize\ibull        % or other marker
222 % \:first item
223 % \:second item
224 % \endlist
225 %
226 % \numlist\ndotted      % or other numbering style
227 % \:first
228 % \:second
229 % \endlist
230
231 % Default dimensions of itemized lists
232 \newdimen\itemindent            \itemindent=0.5in
233 \newdimen\itemnarrow            \itemnarrow=0.5in                       % make lines narrower by this amount
234 \newskip\itemmarkerskip         \itemmarkerskip=0.4em                   % between marker and the item
235 \newskip\preitemizeskip         \preitemizeskip=3pt plus 2pt minus 1pt  % before the list
236 \newskip\postitemizeskip        \postitemizeskip=3pt plus 2pt minus 1pt % after the list
237 \newskip\interitemskip          \interitemskip=2pt plus 1pt minus 0.5pt % between two items
238
239 % Analogues for nested lists
240 \newdimen\nesteditemindent      \nesteditemindent=0.25in
241 \newdimen\nesteditemnarrow      \nesteditemnarrow=0.25in
242 \newskip\prenesteditemizeskip   \prenesteditemizeskip=0pt
243 \newskip\postnesteditemizeskip  \postnesteditemizeskip=0pt
244
245 \newif\ifitems\itemsfalse
246 \newbox\itembox
247 \newcount\itemcount
248
249 % Penalties (changed at compatibility level 1)
250 \newcount\preitemizepenalty     \preitemizepenalty=0
251 \newcount\postitemizepenalty    \postitemizepenalty=0
252
253 \def\preitemize{
254         \ifitems
255                 \vskip\prenesteditemizeskip
256                 \advance\leftskip by \nesteditemindent
257                 \advance\rightskip by \nesteditemnarrow
258         \else
259                 \ifnum\preitemizepenalty=0\else\penalty\preitemizepenalty\fi
260                 \vskip\preitemizeskip
261                 \advance\leftskip by \itemindent
262                 \advance\rightskip by \itemnarrow
263         \fi
264         \parskip=\interitemskip
265 }
266
267 \def\postitemize{
268         \ifitems
269                 \vskip\postnesteditemizeskip
270         \else
271                 \ifnum\postitemizepenalty=0\else\penalty\postitemizepenalty\fi
272                 \vskip\postitemizeskip
273         \fi
274 }
275
276 \def\inititemize{\begingroup\preitemize\itemstrue\parindent=0pt}
277
278 \def\itemize#1{\inititemize\setbox\itembox\llap{#1\hskip\itemmarkerskip}%
279 \let\:=\singleitem}
280
281 \def\singleitem{\par\leavevmode\copy\itembox\ignorespaces}
282
283 \def\endlist{\par\endgroup\postitemize}
284
285 % Markers for \itemize
286 \def\ibull{\raise0.2ex\hbox{$\bullet$}}
287 \def\idot{\raise0.2ex\hbox{$\cdot$}}
288 \def\istar{\raise0.2ex\hbox{$\ast$}}
289
290 \def\numlist#1{\inititemize\itemcount=0\let\:=\numbereditem
291 \let\itemnumbering=#1}
292
293 \def\numbereditem{\par\leavevmode\advance\itemcount by 1
294 \llap{\itemnumbering\hskip\itemmarkerskip}\ignorespaces}
295
296 % Numbering styles for \numlist
297 \def\nnorm{\the\itemcount}
298 \def\ndotted{\nnorm.}
299 \def\nparen{\nnorm)}
300 \def\nparenp{(\nnorm)}
301 \def\nroman{\romannumeral\itemcount}
302 \def\nromanp{\nroman)}
303 \def\nalpha{\count@=96\advance\count@ by\itemcount\char\count@)}
304 \def\nAlpha{\count@=64\advance\count@ by\itemcount\char\count@)}
305 \def\ngreek{$\ifcase\itemcount\or\alpha\or\beta\or\gamma\or\delta\or\epsilon\or
306 \zeta\or\eta\or\theta\or\iota\or\kappa\or\lambda\or\mu\or\nu\or\xi\or\pi\or\rho
307 \or\sigma\or\tau\or\upsilon\or\phi\or\chi\or\psi\or\omega\fi$)}
308
309 %%% Miscellanea %%%
310
311 % {\I italic} with automatic italic correction
312 \def\I{\it\aftergroup\/}
313
314 % A breakable dash, to be repeated on the next line
315 \def\={\discretionary{-}{-}{-}}
316
317 % Non-breakable identifiers
318 \def\<#1>{\leavevmode\hbox{\I #1}}
319
320 % Handy shortcuts
321 \let\>=\noindent
322 \def\\{\hfil\break}
323
324 % Variants of \centerline, \leftline and \rightline, which are compatible with
325 % verbatim environments and other catcode hacks
326 \def\cline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
327 \def\lline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\bgroup\aftergroup\hss\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
328 \def\rline{\bgroup\def\linet@mp{\aftergroup\box\aftergroup0\aftergroup\egroup\hss\bgroup\aftergroup\egroup}\afterassignment\linet@mp\setbox0\hbox to \hsize}
329
330 % Insert a PDF picture
331 % \putimage{width specification}{file}
332 \def\putimage#1#2{\hbox{\pdfximage #1{#2}\pdfrefximage\pdflastximage}}
333
334 %%% Colors %%%
335
336 % Use of pdfTeX color stack:
337 % \colorpush\rgb{1 0 0} puts a new color on the stack
338 % \colorset\rgb{1 0 0} replaces the top color on the stack
339 % \colorpop pops the top color
340 % \colorlocal\rgb{1 0 0} set a color locally until the end of the current group
341 \chardef\colorstk=\pdfcolorstackinit page direct{0 g 0 G}
342 \def\colorset#1{\pdfcolorstack\colorstk set #1}
343 \def\colorpush#1{\pdfcolorstack\colorstk push #1}
344 \def\colorpop{\pdfcolorstack\colorstk pop}
345 \def\colorlocal{\aftergroup\colorpop\colorpush}
346
347 % Different ways of describing colors: \rgb{R G B}, \gray{G}, \cmyk{C M Y K}
348 % (all components are real numbers between 0 and 1)
349 \def\rgb#1{{#1 rg #1 RG}}
350 \def\gray#1{{#1 g #1 G}}
351 \def\cmyk#1{{#1 k #1 K}}
352
353 %%% Localization %%%
354
355 % Define a new localized string: \localedef{language}{identifier}{message}
356 % (we use \language codes to identify languages)
357 \def\localedef#1#2{\tmpcount=#1\expandafter\def\csname loc:\the\tmpcount:#2\endcsname}
358
359 % Expand a localized string in the current language: \localemsg{identifier}
360 \def\localestr#1{%
361         \ifcsname loc:\the\language:#1\endcsname
362                 \csname loc:\the\language:#1\endcsname
363         \else
364                 \ucwwarn{Localized string #1 not defined in language \the\language}%
365                 ???%
366         \fi
367 }
368
369 %%% Modules %%%
370
371 % Require a module: load it if it is not already loaded
372 \def\ucwmodule#1{
373         \ifcsname ucwmod:#1\endcsname
374         \else
375                 \input ucw-#1.tex
376         \fi
377 }
378
379 % Definition of a new module (to be placed at the beginning of its file)
380 % (Also guards against repeated loading if somebody uses \input instead of \ucwmodule.)
381 \def\ucwdefmodule#1{
382         \ifcsname ucwmod:#1\endcsname\endinput\fi
383         \expandafter\let\csname ucwmod:#1\endcsname=\relax
384 }
385
386 % Compatibility levels
387 % We try to be backwards compatible as much as we can, so all changes in behavior
388 % (except for addition of new control sequences) are versioned. By default, ucwmac
389 % starts in compatibility level 0, which should produce the same results as historic
390 % versions of ucwmac. Use \ucwcompat{level} to upgrade to a given level, or if you
391 % do not care about compatibility, \ucwcompat\ucwmaxcompat.
392
393 \chardef\ucwcurrentcompat=0     % Currently active compatibility level
394 \chardef\ucwmaxcompat=1         % Maximum supported compatibility level
395
396 \def\ucwcompat#1{
397         \ucwcurrentcompat=#1
398         \ifcase #1
399                 % Level 0 (default): old ucwmac
400         \or     % Level 1
401                 \preitemizepenalty=-500
402                 \postitemizepenalty=-500
403         \else\errmessage{Unsupported compatibility level #1 requested.}
404         \fi
405 }
406
407 %%% Epilog %%%
408
409 % Let's hide all internal macros
410 \catcode`@=12