Debian Codegraph @

texmf-dist/tex/plain/zztex/zzvmode.tex

raw
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %
3 % Module: ZzTeX Vertical Mode Facilities
4 %
5 % Synopsis:
6 %
7 % Author: Paul C. Anagnostopoulos
8 % Created: 21 September 1989
9 %
10 % Copyright 1989--2020 by Paul C. Anagnostopoulos
11 % under The MIT License (opensource.org/licenses/MIT)
12 %
13 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14
15 % Interline Skip
16 % --------- ----
17
18
19 \def \nointerlineskip {%
20 \prevdepth = -1000pt}
21
22 \def \offinterlineskip {%
23 \baselineskip = -1000pt
24 \lineskip = 0pt
25 \lineskiplimit = \maxdimen}
26
27 % Vertical Skiping Environment
28 % -------- ------- -----------
29
30
31 % The following registers make up the vertical skiping environment.
32
33 \definecount{\zvskenvtype}{0} % Previous vertical skip type.
34 \definecount{\zvskenvpen}{0} % Previous columnbreak penalty.
35 \defineskip{\zvskenvreq}{0pt} % Previous required base-to-base skip.
36 \defineskip{\zvskenvskip}{0pt} % Previous actual skip amount.
37
38 \chardef \zvskenvdiscard = 0 % Just initialized the environment.
39 \chardef \zvskenvpar = 1 % Previous element was a paragraph.
40 \chardef \zvskenvabove = 2 % Just finished an above skip.
41 \chardef \zvskenvbelow = 3 % Just finished a below skip.
42 \chardef \zvskenvmath = 4 % Previous element was a paragraph ending
43 % with a math display.
44
45 \definecount{\zvskenvnopen}{20000\relax}
46
47 \let \noskip = \mindimen
48
49
50 % The vertical skiping environment is maintained in the vertical context.
51
52 \zdeclareeveryvcontext{\zvskenvvcontext}
53
54 \def \zvskenvvcontext {%
55 \zsavevcontext{\zvskenvtype=\the\zvskenvtype
56 \zvskenvpen=\the\zvskenvpen
57 \zvskenvreq=\the\zvskenvreq
58 \zvskenvskip=\the\zvskenvskip}%
59 \zvskpar
60 \global\zvskenvtype = \zvskenvdiscard}
61
62 % Base-to-Base Skiping
63 % ------------ -------
64
65
66 \declareeverypar{\zvskpar}
67
68 \def \zvskpar {%
69 \global\zvskenvtype = \zvskenvpar
70 \global\zvskenvpen = \zvskenvnopen
71 \global\zvskenvreq = \parskip \global\advance \zvskenvreq by \baselineskip
72 \global\zvskenvskip = 0pt}
73
74
75 %~ This command produces vertical space so that the base-to-base
76 %~ distance above the next element is equal to the *glue*. The
77 %~ space is preceded by the specified *penalty*. If there is a font
78 %~ change for the next element, it must be specified before this command.
79
80 \def \bbskipabove #1#2{% {penalty}{glue} %^vspace
81 \if \neqlp{\zvskenvtype}{\zvskenvdiscard}%
82 {\zvskprevmath{\parskip}{\baselineskip}%
83 \zparseglue #2\zmark
84 \setflag \znosk = {\dimeqlp{\zskipa}{\noskip}}%
85 \vpenalty{#1}%
86 \ifcase \zvskenvtype
87 \relax
88 \or
89 \if \znosk \zskipa = \zvskenvreq \fi
90 \or
91 \zskipa = \zvskenvreq
92 \or
93 \if \dimlssp{\zskipa}{\zvskenvreq}\zskipa = \zvskenvreq \fi
94 \or
95 \if \dimlssp{\zskipa}{\zvskenvreq}\zskipa = \zvskenvreq \fi
96 \fi
97 \if \notp{\dimzerop{\zvskenvskip}}\vskip -\zvskenvskip \fi
98 \zskipb = \zskipa
99 \advance \zskipb by -\parskip
100 \advance \zskipb by -\baselineskip
101 \vskip \zskipb
102 \if \notp{\znosk}%
103 \global\zvskenvtype = \zvskenvabove
104 \global\zvskenvreq = \zskipa
105 \fi
106 \global\zvskenvskip = \zskipb}%
107 \fi}
108
109 %~ This command produces vertical space so that the base-to-base
110 %~ distance below the current element is equal to the *glue*. The
111 %~ space is preceded by the specified *penalty*.
112
113 \def \bbskipbelow #1#2{% {penalty}{glue} %^vspace
114 \zvskbelow{#1}{#2}{\parskip}{\baselineskip}}
115
116 \def \bbskipbelowblock #1#2{% {penalty}{glue}
117 \zvskbelow{#1}{#2}{\enclosingparskip}{\enclosingbaselineskip}}
118
119 % This macro "returns" a value in \parnext:
120 % \noindent if next token does not start a new paragraph.
121 % empty if next token starts a new paragraph.
122
123 \def \bbskipbelowblockpar #1#2#3{% {token}{penalty}{glue}
124 {\setflag \znext = \false % Set \true if token starts new paragraph.
125 \ifcat \noexpand#1\relax \setflag \znext = \true \fi
126 \ifcat \noexpand#1\endgraf \setflag \znext = \true \fi
127 \ifcat \noexpand#1\egroup \setflag \znext = \true \fi
128 \ifcat \noexpand#1&\setflag \znext = \true \fi
129 \ifx #1\noindent \setflag \znext = \false \fi
130 \xdef \parnext {\if \znext \else \noindent \fi}%
131 \zskipa = #3\relax
132 \if \andp{\znext}{\dimneqlp{#3}{\noskip}}%
133 \tdimena = \zskipa
134 \advance \zskipa by -\tdimena
135 \advance \zskipa by \enclosingparskip
136 \advance \zskipa by \enclosingbaselineskip
137 \if \dimlssp{\zskipa}{#3}\zskipa = #3\fi
138 \fi
139 \zvskbelow{#2}{\zskipa}{\enclosingparskip}{\enclosingbaselineskip}}}
140
141 \def \zvskbelow #1#2#3#4{% {penalty}{glue}{parskip}{baselineskip}
142 {\zvskprevmath{#3}{#4}%
143 \zparseglue #2\zmark
144 \setflag \znosk = {\dimeqlp{\zskipa}{\noskip}}%
145 \vpenalty{#1}%
146 \ifcase \zvskenvtype
147 \zzerror{Skiping type is discard}%
148 \or
149 \if \znosk \zskipa = #3 \advance \zskipa by #4\fi
150 \or
151 \error{skipab}{A `skip below' follows a `skip above'}%
152 \or
153 \if \znosk \zskipa = \zvskenvreq \fi
154 \or
155 \if \dimlssp{\zskipa}{\zvskenvreq}\zskipa = \zvskenvreq \fi
156 \fi
157 \if \notp{\dimzerop{\zvskenvskip}}\vskip -\zvskenvskip \fi
158 \zskipb = \zskipa
159 \advance \zskipb by -#3%
160 \advance \zskipb by -#4%
161 \vskip \zskipb
162 \if \notp{\znosk}%
163 \if \neqlp{\zvskenvtype}{\zvskenvmath}% % Stay as math type so
164 \global\zvskenvtype = \zvskenvbelow % subsequent below skip
165 \fi % won't override.
166 \global\zvskenvreq = \zskipa
167 \fi
168 \global\zvskenvskip = \zskipb}}
169
170 \def \zvskprevmath #1#2{% {parskip}{baselineskip}
171 \if \eqlp{\mathdisplayprevgraf}{\prevgraf}%
172 \global\zvskenvtype = \zvskenvmath
173 \global\zvskenvpen = \mathdisplayprevpenalty
174 \global\zvskenvreq = \mathdisplayprevskip
175 \global\advance \zvskenvreq by #1
176 \global\advance \zvskenvreq by #2
177 \global\zvskenvskip = \mathdisplayprevskip
178 \global\mathdisplayprevgraf = -1\relax
179 \fi}
180
181 %~ This command forces the next base-to-base skip command
182 %~ regardless of the relationship between the previous element
183 %~ and the next one.
184
185 \def \forcenextbbskip {% %^vspace
186 \global\zvskenvtype = \zvskenvpar
187 \global\mathdisplayprevgraf = -1\relax}
188
189 \definecount{\zvpen}{0}
190
191 \def \vpenalty #1{% {penalty}
192 \zvpen = \if \emptyargp{#1}\breaknever \else #1\fi
193 \if \orp{\eqlp{\zvskenvpen}{\zvskenvnopen}}
194 {\eqlp{\zvpen}{\breaknever}}%
195 \columnbreak{\zvpen}%
196 \global\zvskenvpen = \zvpen\relax
197 \else \if \andp{\posp{\zvskenvpen}}{\gtrp{\zvpen}{\zvskenvpen}}%
198 \columnbreak{\zvpen}%
199 \global\zvskenvpen = \zvpen\relax
200 \fi\fi}
201
202 \def \forcenextpenalty {%
203 \global\zvskenvpen = \zvskenvnopen}
204
205 \def \repeatpenalty {%
206 \if \neqlp{\zvskenvpen}{\zvskenvnopen}%
207 \columnbreak{\zvskenvpen}%
208 \fi}
209
210 %~ This command inserts the specified amount of extra vertical space
211 %~ between the previous element and the next one.
212
213 \def \vspace #1{% {glue} %^vspace
214 \if \neqlp{\zvskenvtype}{\zvskenvdiscard}%
215 \zparseglue #1\zmark
216 \vskip \zskipa
217 \fi}
218
219 %~ This command inserts extra vertical space between the previous element
220 %~ and the next one. The space is measured in lines; a fractional number
221 %~ is allowed.
222
223 \def \linespace #1{\vspace{#1\baselineskip}}% {lines} %^vspace
224
225 \def \zparseglue #1#2\zmark{% {token}{tokens...}
226 \def \znext {#1}%
227 \def \zskip {\skip}%
228 \if \tokeqlp{\znext}{\zskip}%
229 \setskip \zskipa = #2\relax
230 \else
231 \zskipa = #1#2\relax
232 \fi}
233
234 % Top to Text Skipping
235 % --- -- ---- --------
236
237
238 % These commands use \zskipb so as not to screw up \fakepar.
239
240 \def \vsinkfromtypearea #1{% {sinkage}
241 \endgraf
242 \nobreak % So \fakepar can't break.
243 \fakepar % So \bbskipabove won't discard.
244 \vbox{}% % Force start of page if not already.
245 \kern -\pagetotal
246 \kern -\headerheight
247 \bbskipabove{\breaknever}{#1}}
248
249 \let \vsink = \vsinkfromtypearea
250
251 \def \vsinkfromtrim #1{% {sinkage}
252 \zskipb = #1\relax
253 \advance \zskipb by -\headmargin
254 \vsinkfromtypearea{\zskipb}}
255
256 \def \vsinkfromtextarea #1{% {sinkage}
257 \zskipb = #1\relax
258 \advance \zskipb by \headerheight
259 \if \topdeltaadjustment
260 \advance \zskipb by \topdelta
261 \fi
262 \vsinkfromtypearea{\zskipb}}
263
264 % Rules
265 % -----
266
267
268 \def \parrule #1#2{% {shift}{dimensions}
269 \endgraf
270 {\if \notp{\baselinetoprules}\zadjrule{#2}\fi
271 \hfuzz = 100pc
272 \noindent \hspace{#1}\vbox{\hrule height 0pt depth 0pt #2}\endgraf}}
273
274 \def \colorparrule #1#2#3{% {color}{shift}{dimensions}
275 \endgraf
276 {\if \notp{\baselinetoprules}\zadjrule{#3}\fi
277 \hfuzz = 100pc
278 \noindent \hspace{#2}%
279 \color{#1}\vbox{\hrule height 0pt depth 0pt #3}\endcolor \endgraf}}
280
281 \def \scotchrule #1#2#3{% {shift}{width}{height,gap,...}
282 \endgraf
283 {\hfuzz = 100pc
284 \commalist{\zscotchlist}{#3}%
285 \tcounta = 1\relax
286 \maplist{\zscotchb{#1}{#2}{##1}}{\zscotchlist}}}
287
288 \def \zscotchb #1#2#3{% {shift}{width}{dimension}
289 \if \andp{\eqlp{\tcounta}{1}}{\notp{\baselinetoprules}}%
290 \zadjrule{height #3 depth 0pt}%
291 \fi
292 \if \oddp{\tcounta}
293 \noindent \hspace{#1}\vbox{\hrule height #3 depth 0pt width #2}\endgraf
294 \parskip = 0pt
295 \else
296 \nobreak
297 \vspace{#3}%
298 \nointerlineskip
299 \fi
300 \increment \tcounta}
301
302 \def \zadjrule #1{% {dimensions}
303 \if \notp{\innermodep}%
304 \fakepar
305 \tdimena = \baselineskip
306 \advance \tdimena by -\prevdepth
307 \setbox \zboxa = \hbox{\vrule #1}%
308 \advance \tdimena by -\ht\zboxa
309 \vskip \tdimena
310 \vskip \topskip
311 \rule{height 0pt depth 0pt width 0pt}%
312 \penalty \breaknever
313 \vskip -\topskip
314 \parskip = 0pt \baselineskip = \ht\zboxa
315 \fi}
316
317 % Vertical Alignment
318 % -------- ---------
319
320
321 \def \bottomout {%
322 \hrule width 0pt height 0pt % Make sure \vskip isn't discarded.
323 \vskip 0pt plus 1filll}
324
325 % Counting Lines
326 % -------- -----
327
328
329 \definecount{\zlinect}{0}
330
331
332 \def \countlines #1#2#3#4{% {\count}{width}{font}{text}
333 \setbox\zboxa = \vbox{%
334 \hsize = #2%
335 #3%
336 #4\par}%
337 \global\zlinect = 0
338 \setbox\zboxa = \vbox{\unvbox\zboxa \zscanvbox}%
339 #1=\zlinect}
340
341 \def \zscanvbox {%
342 \loop
343 \setflag \zscanagain = \false
344 \setbox\zboxa = \lastbox
345 \if \hboxp{\zboxa}%
346 \global\increment \zlinect
347 \setflag \zscanagain = \true
348 \else\if \notp{\dimzerop{\lastskip}}%
349 \unskip
350 \setflag \zscanagain = \true
351 \else\if \notp{\dimzerop{\lastkern}}%
352 \unkern
353 \setflag \zscanagain = \true
354 \else\if \notp{\zerop{\lastpenalty}}%
355 \unpenalty
356 \setflag \zscanagain = \true
357 \fi\fi\fi\fi
358 \if \zscanagain \repeat}
359
360 % Special Boxes
361 % ------- -----
362
363
364 \definedimen{\zibprevdepth}{0pt}
365
366
367 \long\def \interjectbox #1#2{% {right-shift}{content}
368 {\zibprevdepth = \prevdepth
369 \penalty \breaknever
370 \nointerlineskip
371 \moveright #1 \vbox to 0pt{%
372 \zpushvcontext
373 #1\relax
374 \zpopvcontext}%
375 \prevdepth = \zibprevdepth}}
376
377 \long\def \smashbox #1{%
378 \vbox to 0pt{%
379 #1\relax
380 \vss}}