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