]> git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
git.ckatri.com / mandoc.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
fix handling of empty .An macros
[mandoc.git] / mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.308 2015/02/05 01:46:56 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>
5 * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19 #include "config.h"
20
21 #include <sys/types.h>
22
23 #include <assert.h>
24 #include <ctype.h>
25 #include <limits.h>
26 #include <stdint.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include "mandoc.h"
32 #include "mandoc_aux.h"
33 #include "out.h"
34 #include "term.h"
35 #include "mdoc.h"
36 #include "main.h"
37
38 struct termpair {
39 struct termpair *ppair;
40 int count;
41 };
42
43 #define DECL_ARGS struct termp *p, \
44 struct termpair *pair, \
45 const struct mdoc_meta *meta, \
46 struct mdoc_node *n
47
48 struct termact {
49 int (*pre)(DECL_ARGS);
50 void (*post)(DECL_ARGS);
51 };
52
53 static int a2width(const struct termp *, const char *);
54
55 static void print_bvspace(struct termp *,
56 const struct mdoc_node *,
57 const struct mdoc_node *);
58 static void print_mdoc_node(DECL_ARGS);
59 static void print_mdoc_nodelist(DECL_ARGS);
60 static void print_mdoc_head(struct termp *, const void *);
61 static void print_mdoc_foot(struct termp *, const void *);
62 static void synopsis_pre(struct termp *,
63 const struct mdoc_node *);
64
65 static void termp____post(DECL_ARGS);
66 static void termp__t_post(DECL_ARGS);
67 static void termp_bd_post(DECL_ARGS);
68 static void termp_bk_post(DECL_ARGS);
69 static void termp_bl_post(DECL_ARGS);
70 static void termp_eo_post(DECL_ARGS);
71 static void termp_fd_post(DECL_ARGS);
72 static void termp_fo_post(DECL_ARGS);
73 static void termp_in_post(DECL_ARGS);
74 static void termp_it_post(DECL_ARGS);
75 static void termp_lb_post(DECL_ARGS);
76 static void termp_nm_post(DECL_ARGS);
77 static void termp_pf_post(DECL_ARGS);
78 static void termp_quote_post(DECL_ARGS);
79 static void termp_sh_post(DECL_ARGS);
80 static void termp_ss_post(DECL_ARGS);
81
82 static int termp__a_pre(DECL_ARGS);
83 static int termp__t_pre(DECL_ARGS);
84 static int termp_an_pre(DECL_ARGS);
85 static int termp_ap_pre(DECL_ARGS);
86 static int termp_bd_pre(DECL_ARGS);
87 static int termp_bf_pre(DECL_ARGS);
88 static int termp_bk_pre(DECL_ARGS);
89 static int termp_bl_pre(DECL_ARGS);
90 static int termp_bold_pre(DECL_ARGS);
91 static int termp_bt_pre(DECL_ARGS);
92 static int termp_bx_pre(DECL_ARGS);
93 static int termp_cd_pre(DECL_ARGS);
94 static int termp_d1_pre(DECL_ARGS);
95 static int termp_eo_pre(DECL_ARGS);
96 static int termp_ex_pre(DECL_ARGS);
97 static int termp_fa_pre(DECL_ARGS);
98 static int termp_fd_pre(DECL_ARGS);
99 static int termp_fl_pre(DECL_ARGS);
100 static int termp_fn_pre(DECL_ARGS);
101 static int termp_fo_pre(DECL_ARGS);
102 static int termp_ft_pre(DECL_ARGS);
103 static int termp_in_pre(DECL_ARGS);
104 static int termp_it_pre(DECL_ARGS);
105 static int termp_li_pre(DECL_ARGS);
106 static int termp_ll_pre(DECL_ARGS);
107 static int termp_lk_pre(DECL_ARGS);
108 static int termp_nd_pre(DECL_ARGS);
109 static int termp_nm_pre(DECL_ARGS);
110 static int termp_ns_pre(DECL_ARGS);
111 static int termp_quote_pre(DECL_ARGS);
112 static int termp_rs_pre(DECL_ARGS);
113 static int termp_rv_pre(DECL_ARGS);
114 static int termp_sh_pre(DECL_ARGS);
115 static int termp_skip_pre(DECL_ARGS);
116 static int termp_sm_pre(DECL_ARGS);
117 static int termp_sp_pre(DECL_ARGS);
118 static int termp_ss_pre(DECL_ARGS);
119 static int termp_under_pre(DECL_ARGS);
120 static int termp_ud_pre(DECL_ARGS);
121 static int termp_vt_pre(DECL_ARGS);
122 static int termp_xr_pre(DECL_ARGS);
123 static int termp_xx_pre(DECL_ARGS);
124
125 static const struct termact termacts[MDOC_MAX] = {
126 { termp_ap_pre, NULL }, /* Ap */
127 { NULL, NULL }, /* Dd */
128 { NULL, NULL }, /* Dt */
129 { NULL, NULL }, /* Os */
130 { termp_sh_pre, termp_sh_post }, /* Sh */
131 { termp_ss_pre, termp_ss_post }, /* Ss */
132 { termp_sp_pre, NULL }, /* Pp */
133 { termp_d1_pre, termp_bl_post }, /* D1 */
134 { termp_d1_pre, termp_bl_post }, /* Dl */
135 { termp_bd_pre, termp_bd_post }, /* Bd */
136 { NULL, NULL }, /* Ed */
137 { termp_bl_pre, termp_bl_post }, /* Bl */
138 { NULL, NULL }, /* El */
139 { termp_it_pre, termp_it_post }, /* It */
140 { termp_under_pre, NULL }, /* Ad */
141 { termp_an_pre, NULL }, /* An */
142 { termp_under_pre, NULL }, /* Ar */
143 { termp_cd_pre, NULL }, /* Cd */
144 { termp_bold_pre, NULL }, /* Cm */
145 { NULL, NULL }, /* Dv */
146 { NULL, NULL }, /* Er */
147 { NULL, NULL }, /* Ev */
148 { termp_ex_pre, NULL }, /* Ex */
149 { termp_fa_pre, NULL }, /* Fa */
150 { termp_fd_pre, termp_fd_post }, /* Fd */
151 { termp_fl_pre, NULL }, /* Fl */
152 { termp_fn_pre, NULL }, /* Fn */
153 { termp_ft_pre, NULL }, /* Ft */
154 { termp_bold_pre, NULL }, /* Ic */
155 { termp_in_pre, termp_in_post }, /* In */
156 { termp_li_pre, NULL }, /* Li */
157 { termp_nd_pre, NULL }, /* Nd */
158 { termp_nm_pre, termp_nm_post }, /* Nm */
159 { termp_quote_pre, termp_quote_post }, /* Op */
160 { termp_ft_pre, NULL }, /* Ot */
161 { termp_under_pre, NULL }, /* Pa */
162 { termp_rv_pre, NULL }, /* Rv */
163 { NULL, NULL }, /* St */
164 { termp_under_pre, NULL }, /* Va */
165 { termp_vt_pre, NULL }, /* Vt */
166 { termp_xr_pre, NULL }, /* Xr */
167 { termp__a_pre, termp____post }, /* %A */
168 { termp_under_pre, termp____post }, /* %B */
169 { NULL, termp____post }, /* %D */
170 { termp_under_pre, termp____post }, /* %I */
171 { termp_under_pre, termp____post }, /* %J */
172 { NULL, termp____post }, /* %N */
173 { NULL, termp____post }, /* %O */
174 { NULL, termp____post }, /* %P */
175 { NULL, termp____post }, /* %R */
176 { termp__t_pre, termp__t_post }, /* %T */
177 { NULL, termp____post }, /* %V */
178 { NULL, NULL }, /* Ac */
179 { termp_quote_pre, termp_quote_post }, /* Ao */
180 { termp_quote_pre, termp_quote_post }, /* Aq */
181 { NULL, NULL }, /* At */
182 { NULL, NULL }, /* Bc */
183 { termp_bf_pre, NULL }, /* Bf */
184 { termp_quote_pre, termp_quote_post }, /* Bo */
185 { termp_quote_pre, termp_quote_post }, /* Bq */
186 { termp_xx_pre, NULL }, /* Bsx */
187 { termp_bx_pre, NULL }, /* Bx */
188 { termp_skip_pre, NULL }, /* Db */
189 { NULL, NULL }, /* Dc */
190 { termp_quote_pre, termp_quote_post }, /* Do */
191 { termp_quote_pre, termp_quote_post }, /* Dq */
192 { NULL, NULL }, /* Ec */ /* FIXME: no space */
193 { NULL, NULL }, /* Ef */
194 { termp_under_pre, NULL }, /* Em */
195 { termp_eo_pre, termp_eo_post }, /* Eo */
196 { termp_xx_pre, NULL }, /* Fx */
197 { termp_bold_pre, NULL }, /* Ms */
198 { termp_li_pre, NULL }, /* No */
199 { termp_ns_pre, NULL }, /* Ns */
200 { termp_xx_pre, NULL }, /* Nx */
201 { termp_xx_pre, NULL }, /* Ox */
202 { NULL, NULL }, /* Pc */
203 { NULL, termp_pf_post }, /* Pf */
204 { termp_quote_pre, termp_quote_post }, /* Po */
205 { termp_quote_pre, termp_quote_post }, /* Pq */
206 { NULL, NULL }, /* Qc */
207 { termp_quote_pre, termp_quote_post }, /* Ql */
208 { termp_quote_pre, termp_quote_post }, /* Qo */
209 { termp_quote_pre, termp_quote_post }, /* Qq */
210 { NULL, NULL }, /* Re */
211 { termp_rs_pre, NULL }, /* Rs */
212 { NULL, NULL }, /* Sc */
213 { termp_quote_pre, termp_quote_post }, /* So */
214 { termp_quote_pre, termp_quote_post }, /* Sq */
215 { termp_sm_pre, NULL }, /* Sm */
216 { termp_under_pre, NULL }, /* Sx */
217 { termp_bold_pre, NULL }, /* Sy */
218 { NULL, NULL }, /* Tn */
219 { termp_xx_pre, NULL }, /* Ux */
220 { NULL, NULL }, /* Xc */
221 { NULL, NULL }, /* Xo */
222 { termp_fo_pre, termp_fo_post }, /* Fo */
223 { NULL, NULL }, /* Fc */
224 { termp_quote_pre, termp_quote_post }, /* Oo */
225 { NULL, NULL }, /* Oc */
226 { termp_bk_pre, termp_bk_post }, /* Bk */
227 { NULL, NULL }, /* Ek */
228 { termp_bt_pre, NULL }, /* Bt */
229 { NULL, NULL }, /* Hf */
230 { termp_under_pre, NULL }, /* Fr */
231 { termp_ud_pre, NULL }, /* Ud */
232 { NULL, termp_lb_post }, /* Lb */
233 { termp_sp_pre, NULL }, /* Lp */
234 { termp_lk_pre, NULL }, /* Lk */
235 { termp_under_pre, NULL }, /* Mt */
236 { termp_quote_pre, termp_quote_post }, /* Brq */
237 { termp_quote_pre, termp_quote_post }, /* Bro */
238 { NULL, NULL }, /* Brc */
239 { NULL, termp____post }, /* %C */
240 { termp_skip_pre, NULL }, /* Es */
241 { termp_quote_pre, termp_quote_post }, /* En */
242 { termp_xx_pre, NULL }, /* Dx */
243 { NULL, termp____post }, /* %Q */
244 { termp_sp_pre, NULL }, /* br */
245 { termp_sp_pre, NULL }, /* sp */
246 { NULL, termp____post }, /* %U */
247 { NULL, NULL }, /* Ta */
248 { termp_ll_pre, NULL }, /* ll */
249 };
250
251
252 void
253 terminal_mdoc(void *arg, const struct mdoc *mdoc)
254 {
255 const struct mdoc_meta *meta;
256 struct mdoc_node *n;
257 struct termp *p;
258
259 p = (struct termp *)arg;
260
261 p->overstep = 0;
262 p->rmargin = p->maxrmargin = p->defrmargin;
263 p->tabwidth = term_len(p, 5);
264
265 n = mdoc_node(mdoc)->child;
266 meta = mdoc_meta(mdoc);
267
268 if (p->synopsisonly) {
269 while (n != NULL) {
270 if (n->tok == MDOC_Sh && n->sec == SEC_SYNOPSIS) {
271 if (n->child->next->child != NULL)
272 print_mdoc_nodelist(p, NULL,
273 meta, n->child->next->child);
274 term_newln(p);
275 break;
276 }
277 n = n->next;
278 }
279 } else {
280 if (p->defindent == 0)
281 p->defindent = 5;
282 term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
283 if (n != NULL) {
284 if (n->tok != MDOC_Sh)
285 term_vspace(p);
286 print_mdoc_nodelist(p, NULL, meta, n);
287 }
288 term_end(p);
289 }
290 }
291
292 static void
293 print_mdoc_nodelist(DECL_ARGS)
294 {
295
296 while (n != NULL) {
297 print_mdoc_node(p, pair, meta, n);
298 n = n->next;
299 }
300 }
301
302 static void
303 print_mdoc_node(DECL_ARGS)
304 {
305 int chld;
306 struct termpair npair;
307 size_t offset, rmargin;
308
309 chld = 1;
310 offset = p->offset;
311 rmargin = p->rmargin;
312 n->prev_font = p->fonti;
313
314 memset(&npair, 0, sizeof(struct termpair));
315 npair.ppair = pair;
316
317 /*
318 * Keeps only work until the end of a line. If a keep was
319 * invoked in a prior line, revert it to PREKEEP.
320 */
321
322 if (p->flags & TERMP_KEEP && n->flags & MDOC_LINE) {
323 p->flags &= ~TERMP_KEEP;
324 p->flags |= TERMP_PREKEEP;
325 }
326
327 /*
328 * After the keep flags have been set up, we may now
329 * produce output. Note that some pre-handlers do so.
330 */
331
332 switch (n->type) {
333 case MDOC_TEXT:
334 if (' ' == *n->string && MDOC_LINE & n->flags)
335 term_newln(p);
336 if (MDOC_DELIMC & n->flags)
337 p->flags |= TERMP_NOSPACE;
338 term_word(p, n->string);
339 if (MDOC_DELIMO & n->flags)
340 p->flags |= TERMP_NOSPACE;
341 break;
342 case MDOC_EQN:
343 if ( ! (n->flags & MDOC_LINE))
344 p->flags |= TERMP_NOSPACE;
345 term_eqn(p, n->eqn);
346 if (n->next != NULL && ! (n->next->flags & MDOC_LINE))
347 p->flags |= TERMP_NOSPACE;
348 break;
349 case MDOC_TBL:
350 term_tbl(p, n->span);
351 break;
352 default:
353 if (termacts[n->tok].pre &&
354 (n->end == ENDBODY_NOT || n->nchild))
355 chld = (*termacts[n->tok].pre)
356 (p, &npair, meta, n);
357 break;
358 }
359
360 if (chld && n->child)
361 print_mdoc_nodelist(p, &npair, meta, n->child);
362
363 term_fontpopq(p,
364 (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
365
366 switch (n->type) {
367 case MDOC_TEXT:
368 break;
369 case MDOC_TBL:
370 break;
371 case MDOC_EQN:
372 break;
373 default:
374 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
375 break;
376 (void)(*termacts[n->tok].post)(p, &npair, meta, n);
377
378 /*
379 * Explicit end tokens not only call the post
380 * handler, but also tell the respective block
381 * that it must not call the post handler again.
382 */
383 if (ENDBODY_NOT != n->end)
384 n->pending->flags |= MDOC_ENDED;
385
386 /*
387 * End of line terminating an implicit block
388 * while an explicit block is still open.
389 * Continue the explicit block without spacing.
390 */
391 if (ENDBODY_NOSPACE == n->end)
392 p->flags |= TERMP_NOSPACE;
393 break;
394 }
395
396 if (MDOC_EOS & n->flags)
397 p->flags |= TERMP_SENTENCE;
398
399 if (MDOC_ll != n->tok) {
400 p->offset = offset;
401 p->rmargin = rmargin;
402 }
403 }
404
405 static void
406 print_mdoc_foot(struct termp *p, const void *arg)
407 {
408 const struct mdoc_meta *meta;
409 size_t sz;
410
411 meta = (const struct mdoc_meta *)arg;
412
413 term_fontrepl(p, TERMFONT_NONE);
414
415 /*
416 * Output the footer in new-groff style, that is, three columns
417 * with the middle being the manual date and flanking columns
418 * being the operating system:
419 *
420 * SYSTEM DATE SYSTEM
421 */
422
423 term_vspace(p);
424
425 p->offset = 0;
426 sz = term_strlen(p, meta->date);
427 p->rmargin = p->maxrmargin > sz ?
428 (p->maxrmargin + term_len(p, 1) - sz) / 2 : 0;
429 p->trailspace = 1;
430 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
431
432 term_word(p, meta->os);
433 term_flushln(p);
434
435 p->offset = p->rmargin;
436 sz = term_strlen(p, meta->os);
437 p->rmargin = p->maxrmargin > sz ? p->maxrmargin - sz : 0;
438 p->flags |= TERMP_NOSPACE;
439
440 term_word(p, meta->date);
441 term_flushln(p);
442
443 p->offset = p->rmargin;
444 p->rmargin = p->maxrmargin;
445 p->trailspace = 0;
446 p->flags &= ~TERMP_NOBREAK;
447 p->flags |= TERMP_NOSPACE;
448
449 term_word(p, meta->os);
450 term_flushln(p);
451
452 p->offset = 0;
453 p->rmargin = p->maxrmargin;
454 p->flags = 0;
455 }
456
457 static void
458 print_mdoc_head(struct termp *p, const void *arg)
459 {
460 const struct mdoc_meta *meta;
461 char *volume, *title;
462 size_t vollen, titlen;
463
464 meta = (const struct mdoc_meta *)arg;
465
466 /*
467 * The header is strange. It has three components, which are
468 * really two with the first duplicated. It goes like this:
469 *
470 * IDENTIFIER TITLE IDENTIFIER
471 *
472 * The IDENTIFIER is NAME(SECTION), which is the command-name
473 * (if given, or "unknown" if not) followed by the manual page
474 * section. These are given in `Dt'. The TITLE is a free-form
475 * string depending on the manual volume. If not specified, it
476 * switches on the manual section.
477 */
478
479 assert(meta->vol);
480 if (NULL == meta->arch)
481 volume = mandoc_strdup(meta->vol);
482 else
483 mandoc_asprintf(&volume, "%s (%s)",
484 meta->vol, meta->arch);
485 vollen = term_strlen(p, volume);
486
487 if (NULL == meta->msec)
488 title = mandoc_strdup(meta->title);
489 else
490 mandoc_asprintf(&title, "%s(%s)",
491 meta->title, meta->msec);
492 titlen = term_strlen(p, title);
493
494 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
495 p->trailspace = 1;
496 p->offset = 0;
497 p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
498 (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
499 vollen < p->maxrmargin ? p->maxrmargin - vollen : 0;
500
501 term_word(p, title);
502 term_flushln(p);
503
504 p->flags |= TERMP_NOSPACE;
505 p->offset = p->rmargin;
506 p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
507 p->maxrmargin - titlen : p->maxrmargin;
508
509 term_word(p, volume);
510 term_flushln(p);
511
512 p->flags &= ~TERMP_NOBREAK;
513 p->trailspace = 0;
514 if (p->rmargin + titlen <= p->maxrmargin) {
515 p->flags |= TERMP_NOSPACE;
516 p->offset = p->rmargin;
517 p->rmargin = p->maxrmargin;
518 term_word(p, title);
519 term_flushln(p);
520 }
521
522 p->flags &= ~TERMP_NOSPACE;
523 p->offset = 0;
524 p->rmargin = p->maxrmargin;
525 free(title);
526 free(volume);
527 }
528
529 static int
530 a2width(const struct termp *p, const char *v)
531 {
532 struct roffsu su;
533
534 if (a2roffsu(v, &su, SCALE_MAX) < 2) {
535 SCALE_HS_INIT(&su, term_strlen(p, v));
536 su.scale /= term_strlen(p, "0");
537 }
538 return(term_hspan(p, &su));
539 }
540
541 /*
542 * Determine how much space to print out before block elements of `It'
543 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
544 * too.
545 */
546 static void
547 print_bvspace(struct termp *p,
548 const struct mdoc_node *bl,
549 const struct mdoc_node *n)
550 {
551 const struct mdoc_node *nn;
552
553 assert(n);
554
555 term_newln(p);
556
557 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
558 return;
559 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
560 return;
561
562 /* Do not vspace directly after Ss/Sh. */
563
564 nn = n;
565 while (nn->prev == NULL) {
566 do {
567 nn = nn->parent;
568 if (nn->type == MDOC_ROOT)
569 return;
570 } while (nn->type != MDOC_BLOCK);
571 if (nn->tok == MDOC_Sh || nn->tok == MDOC_Ss)
572 return;
573 if (nn->tok == MDOC_It &&
574 nn->parent->parent->norm->Bl.type != LIST_item)
575 break;
576 }
577
578 /* A `-column' does not assert vspace within the list. */
579
580 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
581 if (n->prev && MDOC_It == n->prev->tok)
582 return;
583
584 /* A `-diag' without body does not vspace. */
585
586 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
587 if (n->prev && MDOC_It == n->prev->tok) {
588 assert(n->prev->body);
589 if (NULL == n->prev->body->child)
590 return;
591 }
592
593 term_vspace(p);
594 }
595
596
597 static int
598 termp_ll_pre(DECL_ARGS)
599 {
600
601 term_setwidth(p, n->nchild ? n->child->string : NULL);
602 return(0);
603 }
604
605 static int
606 termp_it_pre(DECL_ARGS)
607 {
608 char buf[24];
609 const struct mdoc_node *bl, *nn;
610 size_t ncols, dcol;
611 int i, offset, width;
612 enum mdoc_list type;
613
614 if (MDOC_BLOCK == n->type) {
615 print_bvspace(p, n->parent->parent, n);
616 return(1);
617 }
618
619 bl = n->parent->parent->parent;
620 type = bl->norm->Bl.type;
621
622 /*
623 * Defaults for specific list types.
624 */
625
626 switch (type) {
627 case LIST_bullet:
628 /* FALLTHROUGH */
629 case LIST_dash:
630 /* FALLTHROUGH */
631 case LIST_hyphen:
632 /* FALLTHROUGH */
633 case LIST_enum:
634 width = term_len(p, 2);
635 break;
636 case LIST_hang:
637 width = term_len(p, 8);
638 break;
639 case LIST_column:
640 /* FALLTHROUGH */
641 case LIST_tag:
642 width = term_len(p, 10);
643 break;
644 default:
645 width = 0;
646 break;
647 }
648 offset = 0;
649
650 /*
651 * First calculate width and offset. This is pretty easy unless
652 * we're a -column list, in which case all prior columns must
653 * be accounted for.
654 */
655
656 if (bl->norm->Bl.offs != NULL) {
657 offset = a2width(p, bl->norm->Bl.offs);
658 if (offset < 0 && (size_t)(-offset) > p->offset)
659 offset = -p->offset;
660 else if (offset > SHRT_MAX)
661 offset = 0;
662 }
663
664 switch (type) {
665 case LIST_column:
666 if (MDOC_HEAD == n->type)
667 break;
668
669 /*
670 * Imitate groff's column handling:
671 * - For each earlier column, add its width.
672 * - For less than 5 columns, add four more blanks per
673 * column.
674 * - For exactly 5 columns, add three more blank per
675 * column.
676 * - For more than 5 columns, add only one column.
677 */
678 ncols = bl->norm->Bl.ncols;
679 dcol = ncols < 5 ? term_len(p, 4) :
680 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
681
682 /*
683 * Calculate the offset by applying all prior MDOC_BODY,
684 * so we stop at the MDOC_HEAD (NULL == nn->prev).
685 */
686
687 for (i = 0, nn = n->prev;
688 nn->prev && i < (int)ncols;
689 nn = nn->prev, i++)
690 offset += dcol + a2width(p,
691 bl->norm->Bl.cols[i]);
692
693 /*
694 * When exceeding the declared number of columns, leave
695 * the remaining widths at 0. This will later be
696 * adjusted to the default width of 10, or, for the last
697 * column, stretched to the right margin.
698 */
699 if (i >= (int)ncols)
700 break;
701
702 /*
703 * Use the declared column widths, extended as explained
704 * in the preceding paragraph.
705 */
706 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
707 break;
708 default:
709 if (NULL == bl->norm->Bl.width)
710 break;
711
712 /*
713 * Note: buffer the width by 2, which is groff's magic
714 * number for buffering single arguments. See the above
715 * handling for column for how this changes.
716 */
717 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
718 if (width < 0 && (size_t)(-width) > p->offset)
719 width = -p->offset;
720 else if (width > SHRT_MAX)
721 width = 0;
722 break;
723 }
724
725 /*
726 * Whitespace control. Inset bodies need an initial space,
727 * while diagonal bodies need two.
728 */
729
730 p->flags |= TERMP_NOSPACE;
731
732 switch (type) {
733 case LIST_diag:
734 if (MDOC_BODY == n->type)
735 term_word(p, "\\ \\ ");
736 break;
737 case LIST_inset:
738 if (MDOC_BODY == n->type && n->parent->head->nchild)
739 term_word(p, "\\ ");
740 break;
741 default:
742 break;
743 }
744
745 p->flags |= TERMP_NOSPACE;
746
747 switch (type) {
748 case LIST_diag:
749 if (MDOC_HEAD == n->type)
750 term_fontpush(p, TERMFONT_BOLD);
751 break;
752 default:
753 break;
754 }
755
756 /*
757 * Pad and break control. This is the tricky part. These flags
758 * are documented in term_flushln() in term.c. Note that we're
759 * going to unset all of these flags in termp_it_post() when we
760 * exit.
761 */
762
763 switch (type) {
764 case LIST_enum:
765 /*
766 * Weird special case.
767 * Some very narrow lists actually hang.
768 */
769 /* FALLTHROUGH */
770 case LIST_bullet:
771 /* FALLTHROUGH */
772 case LIST_dash:
773 /* FALLTHROUGH */
774 case LIST_hyphen:
775 if (width <= (int)term_len(p, 2))
776 p->flags |= TERMP_HANG;
777 if (MDOC_HEAD != n->type)
778 break;
779 p->flags |= TERMP_NOBREAK;
780 p->trailspace = 1;
781 break;
782 case LIST_hang:
783 if (MDOC_HEAD != n->type)
784 break;
785
786 /*
787 * This is ugly. If `-hang' is specified and the body
788 * is a `Bl' or `Bd', then we want basically to nullify
789 * the "overstep" effect in term_flushln() and treat
790 * this as a `-ohang' list instead.
791 */
792 if (NULL != n->next &&
793 NULL != n->next->child &&
794 (MDOC_Bl == n->next->child->tok ||
795 MDOC_Bd == n->next->child->tok))
796 break;
797
798 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
799 p->trailspace = 1;
800 break;
801 case LIST_tag:
802 if (MDOC_HEAD != n->type)
803 break;
804
805 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
806 p->trailspace = 2;
807
808 if (NULL == n->next || NULL == n->next->child)
809 p->flags |= TERMP_DANGLE;
810 break;
811 case LIST_column:
812 if (MDOC_HEAD == n->type)
813 break;
814
815 if (NULL == n->next) {
816 p->flags &= ~TERMP_NOBREAK;
817 p->trailspace = 0;
818 } else {
819 p->flags |= TERMP_NOBREAK;
820 p->trailspace = 1;
821 }
822
823 break;
824 case LIST_diag:
825 if (MDOC_HEAD != n->type)
826 break;
827 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
828 p->trailspace = 1;
829 break;
830 default:
831 break;
832 }
833
834 /*
835 * Margin control. Set-head-width lists have their right
836 * margins shortened. The body for these lists has the offset
837 * necessarily lengthened. Everybody gets the offset.
838 */
839
840 p->offset += offset;
841
842 switch (type) {
843 case LIST_hang:
844 /*
845 * Same stipulation as above, regarding `-hang'. We
846 * don't want to recalculate rmargin and offsets when
847 * using `Bd' or `Bl' within `-hang' overstep lists.
848 */
849 if (MDOC_HEAD == n->type &&
850 NULL != n->next &&
851 NULL != n->next->child &&
852 (MDOC_Bl == n->next->child->tok ||
853 MDOC_Bd == n->next->child->tok))
854 break;
855 /* FALLTHROUGH */
856 case LIST_bullet:
857 /* FALLTHROUGH */
858 case LIST_dash:
859 /* FALLTHROUGH */
860 case LIST_enum:
861 /* FALLTHROUGH */
862 case LIST_hyphen:
863 /* FALLTHROUGH */
864 case LIST_tag:
865 if (MDOC_HEAD == n->type)
866 p->rmargin = p->offset + width;
867 else
868 p->offset += width;
869 break;
870 case LIST_column:
871 assert(width);
872 p->rmargin = p->offset + width;
873 /*
874 * XXX - this behaviour is not documented: the
875 * right-most column is filled to the right margin.
876 */
877 if (MDOC_HEAD == n->type)
878 break;
879 if (NULL == n->next && p->rmargin < p->maxrmargin)
880 p->rmargin = p->maxrmargin;
881 break;
882 default:
883 break;
884 }
885
886 /*
887 * The dash, hyphen, bullet and enum lists all have a special
888 * HEAD character (temporarily bold, in some cases).
889 */
890
891 if (MDOC_HEAD == n->type)
892 switch (type) {
893 case LIST_bullet:
894 term_fontpush(p, TERMFONT_BOLD);
895 term_word(p, "\\[bu]");
896 term_fontpop(p);
897 break;
898 case LIST_dash:
899 /* FALLTHROUGH */
900 case LIST_hyphen:
901 term_fontpush(p, TERMFONT_BOLD);
902 term_word(p, "\\(hy");
903 term_fontpop(p);
904 break;
905 case LIST_enum:
906 (pair->ppair->ppair->count)++;
907 (void)snprintf(buf, sizeof(buf), "%d.",
908 pair->ppair->ppair->count);
909 term_word(p, buf);
910 break;
911 default:
912 break;
913 }
914
915 /*
916 * If we're not going to process our children, indicate so here.
917 */
918
919 switch (type) {
920 case LIST_bullet:
921 /* FALLTHROUGH */
922 case LIST_item:
923 /* FALLTHROUGH */
924 case LIST_dash:
925 /* FALLTHROUGH */
926 case LIST_hyphen:
927 /* FALLTHROUGH */
928 case LIST_enum:
929 if (MDOC_HEAD == n->type)
930 return(0);
931 break;
932 case LIST_column:
933 if (MDOC_HEAD == n->type)
934 return(0);
935 break;
936 default:
937 break;
938 }
939
940 return(1);
941 }
942
943 static void
944 termp_it_post(DECL_ARGS)
945 {
946 enum mdoc_list type;
947
948 if (MDOC_BLOCK == n->type)
949 return;
950
951 type = n->parent->parent->parent->norm->Bl.type;
952
953 switch (type) {
954 case LIST_item:
955 /* FALLTHROUGH */
956 case LIST_diag:
957 /* FALLTHROUGH */
958 case LIST_inset:
959 if (MDOC_BODY == n->type)
960 term_newln(p);
961 break;
962 case LIST_column:
963 if (MDOC_BODY == n->type)
964 term_flushln(p);
965 break;
966 default:
967 term_newln(p);
968 break;
969 }
970
971 /*
972 * Now that our output is flushed, we can reset our tags. Since
973 * only `It' sets these flags, we're free to assume that nobody
974 * has munged them in the meanwhile.
975 */
976
977 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
978 TERMP_DANGLE | TERMP_HANG);
979 p->trailspace = 0;
980 }
981
982 static int
983 termp_nm_pre(DECL_ARGS)
984 {
985 const char *cp;
986
987 if (MDOC_BLOCK == n->type) {
988 p->flags |= TERMP_PREKEEP;
989 return(1);
990 }
991
992 if (MDOC_BODY == n->type) {
993 if (NULL == n->child)
994 return(0);
995 p->flags |= TERMP_NOSPACE;
996 cp = NULL;
997 if (n->prev->child != NULL)
998 cp = n->prev->child->string;
999 if (cp == NULL)
1000 cp = meta->name;
1001 if (cp == NULL)
1002 p->offset += term_len(p, 6);
1003 else
1004 p->offset += term_len(p, 1) + term_strlen(p, cp);
1005 return(1);
1006 }
1007
1008 if (NULL == n->child && NULL == meta->name)
1009 return(0);
1010
1011 if (MDOC_HEAD == n->type)
1012 synopsis_pre(p, n->parent);
1013
1014 if (MDOC_HEAD == n->type &&
1015 NULL != n->next && NULL != n->next->child) {
1016 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
1017 p->trailspace = 1;
1018 p->rmargin = p->offset + term_len(p, 1);
1019 if (NULL == n->child) {
1020 p->rmargin += term_strlen(p, meta->name);
1021 } else if (MDOC_TEXT == n->child->type) {
1022 p->rmargin += term_strlen(p, n->child->string);
1023 if (n->child->next)
1024 p->flags |= TERMP_HANG;
1025 } else {
1026 p->rmargin += term_len(p, 5);
1027 p->flags |= TERMP_HANG;
1028 }
1029 }
1030
1031 term_fontpush(p, TERMFONT_BOLD);
1032 if (NULL == n->child)
1033 term_word(p, meta->name);
1034 return(1);
1035 }
1036
1037 static void
1038 termp_nm_post(DECL_ARGS)
1039 {
1040
1041 if (MDOC_BLOCK == n->type) {
1042 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1043 } else if (MDOC_HEAD == n->type &&
1044 NULL != n->next && NULL != n->next->child) {
1045 term_flushln(p);
1046 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1047 p->trailspace = 0;
1048 } else if (MDOC_BODY == n->type && n->child)
1049 term_flushln(p);
1050 }
1051
1052 static int
1053 termp_fl_pre(DECL_ARGS)
1054 {
1055
1056 term_fontpush(p, TERMFONT_BOLD);
1057 term_word(p, "\\-");
1058
1059 if ( ! (n->nchild == 0 &&
1060 (n->next == NULL ||
1061 n->next->type == MDOC_TEXT ||
1062 n->next->flags & MDOC_LINE)))
1063 p->flags |= TERMP_NOSPACE;
1064
1065 return(1);
1066 }
1067
1068 static int
1069 termp__a_pre(DECL_ARGS)
1070 {
1071
1072 if (n->prev && MDOC__A == n->prev->tok)
1073 if (NULL == n->next || MDOC__A != n->next->tok)
1074 term_word(p, "and");
1075
1076 return(1);
1077 }
1078
1079 static int
1080 termp_an_pre(DECL_ARGS)
1081 {
1082
1083 if (n->norm->An.auth == AUTH_split) {
1084 p->flags &= ~TERMP_NOSPLIT;
1085 p->flags |= TERMP_SPLIT;
1086 return(0);
1087 }
1088 if (n->norm->An.auth == AUTH_nosplit) {
1089 p->flags &= ~TERMP_SPLIT;
1090 p->flags |= TERMP_NOSPLIT;
1091 return(0);
1092 }
1093
1094 if (p->flags & TERMP_SPLIT)
1095 term_newln(p);
1096
1097 if (n->sec == SEC_AUTHORS && ! (p->flags & TERMP_NOSPLIT))
1098 p->flags |= TERMP_SPLIT;
1099
1100 return(1);
1101 }
1102
1103 static int
1104 termp_ns_pre(DECL_ARGS)
1105 {
1106
1107 if ( ! (MDOC_LINE & n->flags))
1108 p->flags |= TERMP_NOSPACE;
1109 return(1);
1110 }
1111
1112 static int
1113 termp_rs_pre(DECL_ARGS)
1114 {
1115
1116 if (SEC_SEE_ALSO != n->sec)
1117 return(1);
1118 if (MDOC_BLOCK == n->type && n->prev)
1119 term_vspace(p);
1120 return(1);
1121 }
1122
1123 static int
1124 termp_rv_pre(DECL_ARGS)
1125 {
1126 int nchild;
1127
1128 term_newln(p);
1129
1130 nchild = n->nchild;
1131 if (nchild > 0) {
1132 term_word(p, "The");
1133
1134 for (n = n->child; n; n = n->next) {
1135 term_fontpush(p, TERMFONT_BOLD);
1136 term_word(p, n->string);
1137 term_fontpop(p);
1138
1139 p->flags |= TERMP_NOSPACE;
1140 term_word(p, "()");
1141
1142 if (n->next == NULL)
1143 continue;
1144
1145 if (nchild > 2) {
1146 p->flags |= TERMP_NOSPACE;
1147 term_word(p, ",");
1148 }
1149 if (n->next->next == NULL)
1150 term_word(p, "and");
1151 }
1152
1153 if (nchild > 1)
1154 term_word(p, "functions return");
1155 else
1156 term_word(p, "function returns");
1157
1158 term_word(p, "the value\\~0 if successful;");
1159 } else
1160 term_word(p, "Upon successful completion,"
1161 " the value\\~0 is returned;");
1162
1163 term_word(p, "otherwise the value\\~\\-1 is returned"
1164 " and the global variable");
1165
1166 term_fontpush(p, TERMFONT_UNDER);
1167 term_word(p, "errno");
1168 term_fontpop(p);
1169
1170 term_word(p, "is set to indicate the error.");
1171 p->flags |= TERMP_SENTENCE;
1172
1173 return(0);
1174 }
1175
1176 static int
1177 termp_ex_pre(DECL_ARGS)
1178 {
1179 int nchild;
1180
1181 term_newln(p);
1182 term_word(p, "The");
1183
1184 nchild = n->nchild;
1185 for (n = n->child; n; n = n->next) {
1186 term_fontpush(p, TERMFONT_BOLD);
1187 term_word(p, n->string);
1188 term_fontpop(p);
1189
1190 if (nchild > 2 && n->next) {
1191 p->flags |= TERMP_NOSPACE;
1192 term_word(p, ",");
1193 }
1194
1195 if (n->next && NULL == n->next->next)
1196 term_word(p, "and");
1197 }
1198
1199 if (nchild > 1)
1200 term_word(p, "utilities exit\\~0");
1201 else
1202 term_word(p, "utility exits\\~0");
1203
1204 term_word(p, "on success, and\\~>0 if an error occurs.");
1205
1206 p->flags |= TERMP_SENTENCE;
1207 return(0);
1208 }
1209
1210 static int
1211 termp_nd_pre(DECL_ARGS)
1212 {
1213
1214 if (n->type == MDOC_BODY)
1215 term_word(p, "\\(en");
1216 return(1);
1217 }
1218
1219 static int
1220 termp_bl_pre(DECL_ARGS)
1221 {
1222
1223 return(MDOC_HEAD != n->type);
1224 }
1225
1226 static void
1227 termp_bl_post(DECL_ARGS)
1228 {
1229
1230 if (MDOC_BLOCK == n->type)
1231 term_newln(p);
1232 }
1233
1234 static int
1235 termp_xr_pre(DECL_ARGS)
1236 {
1237
1238 if (NULL == (n = n->child))
1239 return(0);
1240
1241 assert(MDOC_TEXT == n->type);
1242 term_word(p, n->string);
1243
1244 if (NULL == (n = n->next))
1245 return(0);
1246
1247 p->flags |= TERMP_NOSPACE;
1248 term_word(p, "(");
1249 p->flags |= TERMP_NOSPACE;
1250
1251 assert(MDOC_TEXT == n->type);
1252 term_word(p, n->string);
1253
1254 p->flags |= TERMP_NOSPACE;
1255 term_word(p, ")");
1256
1257 return(0);
1258 }
1259
1260 /*
1261 * This decides how to assert whitespace before any of the SYNOPSIS set
1262 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1263 * macro combos).
1264 */
1265 static void
1266 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1267 {
1268 /*
1269 * Obviously, if we're not in a SYNOPSIS or no prior macros
1270 * exist, do nothing.
1271 */
1272 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1273 return;
1274
1275 /*
1276 * If we're the second in a pair of like elements, emit our
1277 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1278 * case we soldier on.
1279 */
1280 if (n->prev->tok == n->tok &&
1281 MDOC_Ft != n->tok &&
1282 MDOC_Fo != n->tok &&
1283 MDOC_Fn != n->tok) {
1284 term_newln(p);
1285 return;
1286 }
1287
1288 /*
1289 * If we're one of the SYNOPSIS set and non-like pair-wise after
1290 * another (or Fn/Fo, which we've let slip through) then assert
1291 * vertical space, else only newline and move on.
1292 */
1293 switch (n->prev->tok) {
1294 case MDOC_Fd:
1295 /* FALLTHROUGH */
1296 case MDOC_Fn:
1297 /* FALLTHROUGH */
1298 case MDOC_Fo:
1299 /* FALLTHROUGH */
1300 case MDOC_In:
1301 /* FALLTHROUGH */
1302 case MDOC_Vt:
1303 term_vspace(p);
1304 break;
1305 case MDOC_Ft:
1306 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1307 term_vspace(p);
1308 break;
1309 }
1310 /* FALLTHROUGH */
1311 default:
1312 term_newln(p);
1313 break;
1314 }
1315 }
1316
1317 static int
1318 termp_vt_pre(DECL_ARGS)
1319 {
1320
1321 if (MDOC_ELEM == n->type) {
1322 synopsis_pre(p, n);
1323 return(termp_under_pre(p, pair, meta, n));
1324 } else if (MDOC_BLOCK == n->type) {
1325 synopsis_pre(p, n);
1326 return(1);
1327 } else if (MDOC_HEAD == n->type)
1328 return(0);
1329
1330 return(termp_under_pre(p, pair, meta, n));
1331 }
1332
1333 static int
1334 termp_bold_pre(DECL_ARGS)
1335 {
1336
1337 term_fontpush(p, TERMFONT_BOLD);
1338 return(1);
1339 }
1340
1341 static int
1342 termp_fd_pre(DECL_ARGS)
1343 {
1344
1345 synopsis_pre(p, n);
1346 return(termp_bold_pre(p, pair, meta, n));
1347 }
1348
1349 static void
1350 termp_fd_post(DECL_ARGS)
1351 {
1352
1353 term_newln(p);
1354 }
1355
1356 static int
1357 termp_sh_pre(DECL_ARGS)
1358 {
1359
1360 switch (n->type) {
1361 case MDOC_BLOCK:
1362 /*
1363 * Vertical space before sections, except
1364 * when the previous section was empty.
1365 */
1366 if (n->prev == NULL ||
1367 MDOC_Sh != n->prev->tok ||
1368 (n->prev->body != NULL &&
1369 n->prev->body->child != NULL))
1370 term_vspace(p);
1371 break;
1372 case MDOC_HEAD:
1373 term_fontpush(p, TERMFONT_BOLD);
1374 break;
1375 case MDOC_BODY:
1376 p->offset = term_len(p, p->defindent);
1377 if (SEC_AUTHORS == n->sec)
1378 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1379 break;
1380 default:
1381 break;
1382 }
1383 return(1);
1384 }
1385
1386 static void
1387 termp_sh_post(DECL_ARGS)
1388 {
1389
1390 switch (n->type) {
1391 case MDOC_HEAD:
1392 term_newln(p);
1393 break;
1394 case MDOC_BODY:
1395 term_newln(p);
1396 p->offset = 0;
1397 break;
1398 default:
1399 break;
1400 }
1401 }
1402
1403 static int
1404 termp_bt_pre(DECL_ARGS)
1405 {
1406
1407 term_word(p, "is currently in beta test.");
1408 p->flags |= TERMP_SENTENCE;
1409 return(0);
1410 }
1411
1412 static void
1413 termp_lb_post(DECL_ARGS)
1414 {
1415
1416 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1417 term_newln(p);
1418 }
1419
1420 static int
1421 termp_ud_pre(DECL_ARGS)
1422 {
1423
1424 term_word(p, "currently under development.");
1425 p->flags |= TERMP_SENTENCE;
1426 return(0);
1427 }
1428
1429 static int
1430 termp_d1_pre(DECL_ARGS)
1431 {
1432
1433 if (MDOC_BLOCK != n->type)
1434 return(1);
1435 term_newln(p);
1436 p->offset += term_len(p, p->defindent + 1);
1437 return(1);
1438 }
1439
1440 static int
1441 termp_ft_pre(DECL_ARGS)
1442 {
1443
1444 /* NB: MDOC_LINE does not effect this! */
1445 synopsis_pre(p, n);
1446 term_fontpush(p, TERMFONT_UNDER);
1447 return(1);
1448 }
1449
1450 static int
1451 termp_fn_pre(DECL_ARGS)
1452 {
1453 size_t rmargin = 0;
1454 int pretty;
1455
1456 pretty = MDOC_SYNPRETTY & n->flags;
1457
1458 synopsis_pre(p, n);
1459
1460 if (NULL == (n = n->child))
1461 return(0);
1462
1463 if (pretty) {
1464 rmargin = p->rmargin;
1465 p->rmargin = p->offset + term_len(p, 4);
1466 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1467 }
1468
1469 assert(MDOC_TEXT == n->type);
1470 term_fontpush(p, TERMFONT_BOLD);
1471 term_word(p, n->string);
1472 term_fontpop(p);
1473
1474 if (pretty) {
1475 term_flushln(p);
1476 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1477 p->offset = p->rmargin;
1478 p->rmargin = rmargin;
1479 }
1480
1481 p->flags |= TERMP_NOSPACE;
1482 term_word(p, "(");
1483 p->flags |= TERMP_NOSPACE;
1484
1485 for (n = n->next; n; n = n->next) {
1486 assert(MDOC_TEXT == n->type);
1487 term_fontpush(p, TERMFONT_UNDER);
1488 if (pretty)
1489 p->flags |= TERMP_NBRWORD;
1490 term_word(p, n->string);
1491 term_fontpop(p);
1492
1493 if (n->next) {
1494 p->flags |= TERMP_NOSPACE;
1495 term_word(p, ",");
1496 }
1497 }
1498
1499 p->flags |= TERMP_NOSPACE;
1500 term_word(p, ")");
1501
1502 if (pretty) {
1503 p->flags |= TERMP_NOSPACE;
1504 term_word(p, ";");
1505 term_flushln(p);
1506 }
1507
1508 return(0);
1509 }
1510
1511 static int
1512 termp_fa_pre(DECL_ARGS)
1513 {
1514 const struct mdoc_node *nn;
1515
1516 if (n->parent->tok != MDOC_Fo) {
1517 term_fontpush(p, TERMFONT_UNDER);
1518 return(1);
1519 }
1520
1521 for (nn = n->child; nn; nn = nn->next) {
1522 term_fontpush(p, TERMFONT_UNDER);
1523 p->flags |= TERMP_NBRWORD;
1524 term_word(p, nn->string);
1525 term_fontpop(p);
1526
1527 if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1528 p->flags |= TERMP_NOSPACE;
1529 term_word(p, ",");
1530 }
1531 }
1532
1533 return(0);
1534 }
1535
1536 static int
1537 termp_bd_pre(DECL_ARGS)
1538 {
1539 size_t tabwidth, lm, len, rm, rmax;
1540 struct mdoc_node *nn;
1541 int offset;
1542
1543 if (MDOC_BLOCK == n->type) {
1544 print_bvspace(p, n, n);
1545 return(1);
1546 } else if (MDOC_HEAD == n->type)
1547 return(0);
1548
1549 /* Handle the -offset argument. */
1550
1551 if (n->norm->Bd.offs == NULL ||
1552 ! strcmp(n->norm->Bd.offs, "left"))
1553 /* nothing */;
1554 else if ( ! strcmp(n->norm->Bd.offs, "indent"))
1555 p->offset += term_len(p, p->defindent + 1);
1556 else if ( ! strcmp(n->norm->Bd.offs, "indent-two"))
1557 p->offset += term_len(p, (p->defindent + 1) * 2);
1558 else {
1559 offset = a2width(p, n->norm->Bd.offs);
1560 if (offset < 0 && (size_t)(-offset) > p->offset)
1561 p->offset = 0;
1562 else if (offset < SHRT_MAX)
1563 p->offset += offset;
1564 }
1565
1566 /*
1567 * If -ragged or -filled are specified, the block does nothing
1568 * but change the indentation. If -unfilled or -literal are
1569 * specified, text is printed exactly as entered in the display:
1570 * for macro lines, a newline is appended to the line. Blank
1571 * lines are allowed.
1572 */
1573
1574 if (DISP_literal != n->norm->Bd.type &&
1575 DISP_unfilled != n->norm->Bd.type &&
1576 DISP_centered != n->norm->Bd.type)
1577 return(1);
1578
1579 tabwidth = p->tabwidth;
1580 if (DISP_literal == n->norm->Bd.type)
1581 p->tabwidth = term_len(p, 8);
1582
1583 lm = p->offset;
1584 rm = p->rmargin;
1585 rmax = p->maxrmargin;
1586 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1587
1588 for (nn = n->child; nn; nn = nn->next) {
1589 if (DISP_centered == n->norm->Bd.type) {
1590 if (MDOC_TEXT == nn->type) {
1591 len = term_strlen(p, nn->string);
1592 p->offset = len >= rm ? 0 :
1593 lm + len >= rm ? rm - len :
1594 (lm + rm - len) / 2;
1595 } else
1596 p->offset = lm;
1597 }
1598 print_mdoc_node(p, pair, meta, nn);
1599 /*
1600 * If the printed node flushes its own line, then we
1601 * needn't do it here as well. This is hacky, but the
1602 * notion of selective eoln whitespace is pretty dumb
1603 * anyway, so don't sweat it.
1604 */
1605 switch (nn->tok) {
1606 case MDOC_Sm:
1607 /* FALLTHROUGH */
1608 case MDOC_br:
1609 /* FALLTHROUGH */
1610 case MDOC_sp:
1611 /* FALLTHROUGH */
1612 case MDOC_Bl:
1613 /* FALLTHROUGH */
1614 case MDOC_D1:
1615 /* FALLTHROUGH */
1616 case MDOC_Dl:
1617 /* FALLTHROUGH */
1618 case MDOC_Lp:
1619 /* FALLTHROUGH */
1620 case MDOC_Pp:
1621 continue;
1622 default:
1623 break;
1624 }
1625 if (p->flags & TERMP_NONEWLINE ||
1626 (nn->next && ! (nn->next->flags & MDOC_LINE)))
1627 continue;
1628 term_flushln(p);
1629 p->flags |= TERMP_NOSPACE;
1630 }
1631
1632 p->tabwidth = tabwidth;
1633 p->rmargin = rm;
1634 p->maxrmargin = rmax;
1635 return(0);
1636 }
1637
1638 static void
1639 termp_bd_post(DECL_ARGS)
1640 {
1641 size_t rm, rmax;
1642
1643 if (MDOC_BODY != n->type)
1644 return;
1645
1646 rm = p->rmargin;
1647 rmax = p->maxrmargin;
1648
1649 if (DISP_literal == n->norm->Bd.type ||
1650 DISP_unfilled == n->norm->Bd.type)
1651 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1652
1653 p->flags |= TERMP_NOSPACE;
1654 term_newln(p);
1655
1656 p->rmargin = rm;
1657 p->maxrmargin = rmax;
1658 }
1659
1660 static int
1661 termp_bx_pre(DECL_ARGS)
1662 {
1663
1664 if (NULL != (n = n->child)) {
1665 term_word(p, n->string);
1666 p->flags |= TERMP_NOSPACE;
1667 term_word(p, "BSD");
1668 } else {
1669 term_word(p, "BSD");
1670 return(0);
1671 }
1672
1673 if (NULL != (n = n->next)) {
1674 p->flags |= TERMP_NOSPACE;
1675 term_word(p, "-");
1676 p->flags |= TERMP_NOSPACE;
1677 term_word(p, n->string);
1678 }
1679
1680 return(0);
1681 }
1682
1683 static int
1684 termp_xx_pre(DECL_ARGS)
1685 {
1686 const char *pp;
1687 int flags;
1688
1689 pp = NULL;
1690 switch (n->tok) {
1691 case MDOC_Bsx:
1692 pp = "BSD/OS";
1693 break;
1694 case MDOC_Dx:
1695 pp = "DragonFly";
1696 break;
1697 case MDOC_Fx:
1698 pp = "FreeBSD";
1699 break;
1700 case MDOC_Nx:
1701 pp = "NetBSD";
1702 break;
1703 case MDOC_Ox:
1704 pp = "OpenBSD";
1705 break;
1706 case MDOC_Ux:
1707 pp = "UNIX";
1708 break;
1709 default:
1710 abort();
1711 /* NOTREACHED */
1712 }
1713
1714 term_word(p, pp);
1715 if (n->child) {
1716 flags = p->flags;
1717 p->flags |= TERMP_KEEP;
1718 term_word(p, n->child->string);
1719 p->flags = flags;
1720 }
1721 return(0);
1722 }
1723
1724 static void
1725 termp_pf_post(DECL_ARGS)
1726 {
1727
1728 if ( ! (n->next == NULL || n->next->flags & MDOC_LINE))
1729 p->flags |= TERMP_NOSPACE;
1730 }
1731
1732 static int
1733 termp_ss_pre(DECL_ARGS)
1734 {
1735
1736 switch (n->type) {
1737 case MDOC_BLOCK:
1738 term_newln(p);
1739 if (n->prev)
1740 term_vspace(p);
1741 break;
1742 case MDOC_HEAD:
1743 term_fontpush(p, TERMFONT_BOLD);
1744 p->offset = term_len(p, (p->defindent+1)/2);
1745 break;
1746 case MDOC_BODY:
1747 p->offset = term_len(p, p->defindent);
1748 break;
1749 default:
1750 break;
1751 }
1752
1753 return(1);
1754 }
1755
1756 static void
1757 termp_ss_post(DECL_ARGS)
1758 {
1759
1760 if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
1761 term_newln(p);
1762 }
1763
1764 static int
1765 termp_cd_pre(DECL_ARGS)
1766 {
1767
1768 synopsis_pre(p, n);
1769 term_fontpush(p, TERMFONT_BOLD);
1770 return(1);
1771 }
1772
1773 static int
1774 termp_in_pre(DECL_ARGS)
1775 {
1776
1777 synopsis_pre(p, n);
1778
1779 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1780 term_fontpush(p, TERMFONT_BOLD);
1781 term_word(p, "#include");
1782 term_word(p, "<");
1783 } else {
1784 term_word(p, "<");
1785 term_fontpush(p, TERMFONT_UNDER);
1786 }
1787
1788 p->flags |= TERMP_NOSPACE;
1789 return(1);
1790 }
1791
1792 static void
1793 termp_in_post(DECL_ARGS)
1794 {
1795
1796 if (MDOC_SYNPRETTY & n->flags)
1797 term_fontpush(p, TERMFONT_BOLD);
1798
1799 p->flags |= TERMP_NOSPACE;
1800 term_word(p, ">");
1801
1802 if (MDOC_SYNPRETTY & n->flags)
1803 term_fontpop(p);
1804 }
1805
1806 static int
1807 termp_sp_pre(DECL_ARGS)
1808 {
1809 struct roffsu su;
1810 size_t i, len;
1811
1812 switch (n->tok) {
1813 case MDOC_sp:
1814 if (n->child) {
1815 if ( ! a2roffsu(n->child->string, &su, SCALE_VS))
1816 su.scale = 1.0;
1817 len = term_vspan(p, &su);
1818 } else
1819 len = 1;
1820 break;
1821 case MDOC_br:
1822 len = 0;
1823 break;
1824 default:
1825 len = 1;
1826 break;
1827 }
1828
1829 if (0 == len)
1830 term_newln(p);
1831 for (i = 0; i < len; i++)
1832 term_vspace(p);
1833
1834 return(0);
1835 }
1836
1837 static int
1838 termp_skip_pre(DECL_ARGS)
1839 {
1840
1841 return(0);
1842 }
1843
1844 static int
1845 termp_quote_pre(DECL_ARGS)
1846 {
1847
1848 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1849 return(1);
1850
1851 switch (n->tok) {
1852 case MDOC_Ao:
1853 /* FALLTHROUGH */
1854 case MDOC_Aq:
1855 term_word(p, n->nchild == 1 &&
1856 n->child->tok == MDOC_Mt ? "<" : "\\(la");
1857 break;
1858 case MDOC_Bro:
1859 /* FALLTHROUGH */
1860 case MDOC_Brq:
1861 term_word(p, "{");
1862 break;
1863 case MDOC_Oo:
1864 /* FALLTHROUGH */
1865 case MDOC_Op:
1866 /* FALLTHROUGH */
1867 case MDOC_Bo:
1868 /* FALLTHROUGH */
1869 case MDOC_Bq:
1870 term_word(p, "[");
1871 break;
1872 case MDOC_Do:
1873 /* FALLTHROUGH */
1874 case MDOC_Dq:
1875 term_word(p, "\\(lq");
1876 break;
1877 case MDOC_En:
1878 if (NULL == n->norm->Es ||
1879 NULL == n->norm->Es->child)
1880 return(1);
1881 term_word(p, n->norm->Es->child->string);
1882 break;
1883 case MDOC_Po:
1884 /* FALLTHROUGH */
1885 case MDOC_Pq:
1886 term_word(p, "(");
1887 break;
1888 case MDOC__T:
1889 /* FALLTHROUGH */
1890 case MDOC_Qo:
1891 /* FALLTHROUGH */
1892 case MDOC_Qq:
1893 term_word(p, "\"");
1894 break;
1895 case MDOC_Ql:
1896 /* FALLTHROUGH */
1897 case MDOC_So:
1898 /* FALLTHROUGH */
1899 case MDOC_Sq:
1900 term_word(p, "\\(oq");
1901 break;
1902 default:
1903 abort();
1904 /* NOTREACHED */
1905 }
1906
1907 p->flags |= TERMP_NOSPACE;
1908 return(1);
1909 }
1910
1911 static void
1912 termp_quote_post(DECL_ARGS)
1913 {
1914
1915 if (n->type != MDOC_BODY && n->type != MDOC_ELEM)
1916 return;
1917
1918 p->flags |= TERMP_NOSPACE;
1919
1920 switch (n->tok) {
1921 case MDOC_Ao:
1922 /* FALLTHROUGH */
1923 case MDOC_Aq:
1924 term_word(p, n->nchild == 1 &&
1925 n->child->tok == MDOC_Mt ? ">" : "\\(ra");
1926 break;
1927 case MDOC_Bro:
1928 /* FALLTHROUGH */
1929 case MDOC_Brq:
1930 term_word(p, "}");
1931 break;
1932 case MDOC_Oo:
1933 /* FALLTHROUGH */
1934 case MDOC_Op:
1935 /* FALLTHROUGH */
1936 case MDOC_Bo:
1937 /* FALLTHROUGH */
1938 case MDOC_Bq:
1939 term_word(p, "]");
1940 break;
1941 case MDOC_Do:
1942 /* FALLTHROUGH */
1943 case MDOC_Dq:
1944 term_word(p, "\\(rq");
1945 break;
1946 case MDOC_En:
1947 if (n->norm->Es == NULL ||
1948 n->norm->Es->child == NULL ||
1949 n->norm->Es->child->next == NULL)
1950 p->flags &= ~TERMP_NOSPACE;
1951 else
1952 term_word(p, n->norm->Es->child->next->string);
1953 break;
1954 case MDOC_Po:
1955 /* FALLTHROUGH */
1956 case MDOC_Pq:
1957 term_word(p, ")");
1958 break;
1959 case MDOC__T:
1960 /* FALLTHROUGH */
1961 case MDOC_Qo:
1962 /* FALLTHROUGH */
1963 case MDOC_Qq:
1964 term_word(p, "\"");
1965 break;
1966 case MDOC_Ql:
1967 /* FALLTHROUGH */
1968 case MDOC_So:
1969 /* FALLTHROUGH */
1970 case MDOC_Sq:
1971 term_word(p, "\\(cq");
1972 break;
1973 default:
1974 abort();
1975 /* NOTREACHED */
1976 }
1977 }
1978
1979 static int
1980 termp_eo_pre(DECL_ARGS)
1981 {
1982
1983 if (n->type != MDOC_BODY)
1984 return(1);
1985
1986 if (n->end == ENDBODY_NOT &&
1987 n->parent->head->child == NULL &&
1988 n->child != NULL &&
1989 n->child->end != ENDBODY_NOT)
1990 term_word(p, "\\&");
1991 else if (n->end != ENDBODY_NOT ? n->child != NULL :
1992 n->parent->head->child != NULL &&
1993 (n->parent->body->child != NULL ||
1994 n->parent->tail->child != NULL))
1995 p->flags |= TERMP_NOSPACE;
1996
1997 return(1);
1998 }
1999
2000 static void
2001 termp_eo_post(DECL_ARGS)
2002 {
2003 int body, tail;
2004
2005 if (n->type != MDOC_BODY)
2006 return;
2007
2008 if (n->end != ENDBODY_NOT) {
2009 p->flags &= ~TERMP_NOSPACE;
2010 return;
2011 }
2012
2013 body = n->child != NULL || n->parent->head->child != NULL;
2014 tail = n->parent->tail != NULL && n->parent->tail->child != NULL;
2015
2016 if (body && tail)
2017 p->flags |= TERMP_NOSPACE;
2018 else if ( ! (body || tail))
2019 term_word(p, "\\&");
2020 else if ( ! tail)
2021 p->flags &= ~TERMP_NOSPACE;
2022 }
2023
2024 static int
2025 termp_fo_pre(DECL_ARGS)
2026 {
2027 size_t rmargin = 0;
2028 int pretty;
2029
2030 pretty = MDOC_SYNPRETTY & n->flags;
2031
2032 if (MDOC_BLOCK == n->type) {
2033 synopsis_pre(p, n);
2034 return(1);
2035 } else if (MDOC_BODY == n->type) {
2036 if (pretty) {
2037 rmargin = p->rmargin;
2038 p->rmargin = p->offset + term_len(p, 4);
2039 p->flags |= TERMP_NOBREAK | TERMP_BRIND |
2040 TERMP_HANG;
2041 }
2042 p->flags |= TERMP_NOSPACE;
2043 term_word(p, "(");
2044 p->flags |= TERMP_NOSPACE;
2045 if (pretty) {
2046 term_flushln(p);
2047 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
2048 TERMP_HANG);
2049 p->offset = p->rmargin;
2050 p->rmargin = rmargin;
2051 }
2052 return(1);
2053 }
2054
2055 if (NULL == n->child)
2056 return(0);
2057
2058 /* XXX: we drop non-initial arguments as per groff. */
2059
2060 assert(n->child->string);
2061 term_fontpush(p, TERMFONT_BOLD);
2062 term_word(p, n->child->string);
2063 return(0);
2064 }
2065
2066 static void
2067 termp_fo_post(DECL_ARGS)
2068 {
2069
2070 if (MDOC_BODY != n->type)
2071 return;
2072
2073 p->flags |= TERMP_NOSPACE;
2074 term_word(p, ")");
2075
2076 if (MDOC_SYNPRETTY & n->flags) {
2077 p->flags |= TERMP_NOSPACE;
2078 term_word(p, ";");
2079 term_flushln(p);
2080 }
2081 }
2082
2083 static int
2084 termp_bf_pre(DECL_ARGS)
2085 {
2086
2087 if (MDOC_HEAD == n->type)
2088 return(0);
2089 else if (MDOC_BODY != n->type)
2090 return(1);
2091
2092 if (FONT_Em == n->norm->Bf.font)
2093 term_fontpush(p, TERMFONT_UNDER);
2094 else if (FONT_Sy == n->norm->Bf.font)
2095 term_fontpush(p, TERMFONT_BOLD);
2096 else
2097 term_fontpush(p, TERMFONT_NONE);
2098
2099 return(1);
2100 }
2101
2102 static int
2103 termp_sm_pre(DECL_ARGS)
2104 {
2105
2106 if (NULL == n->child)
2107 p->flags ^= TERMP_NONOSPACE;
2108 else if (0 == strcmp("on", n->child->string))
2109 p->flags &= ~TERMP_NONOSPACE;
2110 else
2111 p->flags |= TERMP_NONOSPACE;
2112
2113 if (p->col && ! (TERMP_NONOSPACE & p->flags))
2114 p->flags &= ~TERMP_NOSPACE;
2115
2116 return(0);
2117 }
2118
2119 static int
2120 termp_ap_pre(DECL_ARGS)
2121 {
2122
2123 p->flags |= TERMP_NOSPACE;
2124 term_word(p, "'");
2125 p->flags |= TERMP_NOSPACE;
2126 return(1);
2127 }
2128
2129 static void
2130 termp____post(DECL_ARGS)
2131 {
2132
2133 /*
2134 * Handle lists of authors. In general, print each followed by
2135 * a comma. Don't print the comma if there are only two
2136 * authors.
2137 */
2138 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2139 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2140 if (NULL == n->prev || MDOC__A != n->prev->tok)
2141 return;
2142
2143 /* TODO: %U. */
2144
2145 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2146 return;
2147
2148 p->flags |= TERMP_NOSPACE;
2149 if (NULL == n->next) {
2150 term_word(p, ".");
2151 p->flags |= TERMP_SENTENCE;
2152 } else
2153 term_word(p, ",");
2154 }
2155
2156 static int
2157 termp_li_pre(DECL_ARGS)
2158 {
2159
2160 term_fontpush(p, TERMFONT_NONE);
2161 return(1);
2162 }
2163
2164 static int
2165 termp_lk_pre(DECL_ARGS)
2166 {
2167 const struct mdoc_node *link, *descr;
2168
2169 if (NULL == (link = n->child))
2170 return(0);
2171
2172 if (NULL != (descr = link->next)) {
2173 term_fontpush(p, TERMFONT_UNDER);
2174 while (NULL != descr) {
2175 term_word(p, descr->string);
2176 descr = descr->next;
2177 }
2178 p->flags |= TERMP_NOSPACE;
2179 term_word(p, ":");
2180 term_fontpop(p);
2181 }
2182
2183 term_fontpush(p, TERMFONT_BOLD);
2184 term_word(p, link->string);
2185 term_fontpop(p);
2186
2187 return(0);
2188 }
2189
2190 static int
2191 termp_bk_pre(DECL_ARGS)
2192 {
2193
2194 switch (n->type) {
2195 case MDOC_BLOCK:
2196 break;
2197 case MDOC_HEAD:
2198 return(0);
2199 case MDOC_BODY:
2200 if (n->parent->args || 0 == n->prev->nchild)
2201 p->flags |= TERMP_PREKEEP;
2202 break;
2203 default:
2204 abort();
2205 /* NOTREACHED */
2206 }
2207
2208 return(1);
2209 }
2210
2211 static void
2212 termp_bk_post(DECL_ARGS)
2213 {
2214
2215 if (MDOC_BODY == n->type)
2216 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2217 }
2218
2219 static void
2220 termp__t_post(DECL_ARGS)
2221 {
2222
2223 /*
2224 * If we're in an `Rs' and there's a journal present, then quote
2225 * us instead of underlining us (for disambiguation).
2226 */
2227 if (n->parent && MDOC_Rs == n->parent->tok &&
2228 n->parent->norm->Rs.quote_T)
2229 termp_quote_post(p, pair, meta, n);
2230
2231 termp____post(p, pair, meta, n);
2232 }
2233
2234 static int
2235 termp__t_pre(DECL_ARGS)
2236 {
2237
2238 /*
2239 * If we're in an `Rs' and there's a journal present, then quote
2240 * us instead of underlining us (for disambiguation).
2241 */
2242 if (n->parent && MDOC_Rs == n->parent->tok &&
2243 n->parent->norm->Rs.quote_T)
2244 return(termp_quote_pre(p, pair, meta, n));
2245
2246 term_fontpush(p, TERMFONT_UNDER);
2247 return(1);
2248 }
2249
2250 static int
2251 termp_under_pre(DECL_ARGS)
2252 {
2253
2254 term_fontpush(p, TERMFONT_UNDER);
2255 return(1);
2256 }
A git conversion mirror of mandoc.bsd.lv