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