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