]> 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
Use <em> for .Em and .Bf -emphasis.
[mandoc.git] / mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.276 2014/08/10 23:54:41 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 (n->next->child &&
810 (MDOC_Bl == n->next->child->tok ||
811 MDOC_Bd == n->next->child->tok))
812 break;
813
814 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
815 p->trailspace = 1;
816 break;
817 case LIST_tag:
818 if (MDOC_HEAD != n->type)
819 break;
820
821 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
822 p->trailspace = 2;
823
824 if (NULL == n->next || NULL == n->next->child)
825 p->flags |= TERMP_DANGLE;
826 break;
827 case LIST_column:
828 if (MDOC_HEAD == n->type)
829 break;
830
831 if (NULL == n->next) {
832 p->flags &= ~TERMP_NOBREAK;
833 p->trailspace = 0;
834 } else {
835 p->flags |= TERMP_NOBREAK;
836 p->trailspace = 1;
837 }
838
839 break;
840 case LIST_diag:
841 if (MDOC_HEAD != n->type)
842 break;
843 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
844 p->trailspace = 1;
845 break;
846 default:
847 break;
848 }
849
850 /*
851 * Margin control. Set-head-width lists have their right
852 * margins shortened. The body for these lists has the offset
853 * necessarily lengthened. Everybody gets the offset.
854 */
855
856 p->offset += offset;
857
858 switch (type) {
859 case LIST_hang:
860 /*
861 * Same stipulation as above, regarding `-hang'. We
862 * don't want to recalculate rmargin and offsets when
863 * using `Bd' or `Bl' within `-hang' overstep lists.
864 */
865 if (MDOC_HEAD == n->type && n->next->child &&
866 (MDOC_Bl == n->next->child->tok ||
867 MDOC_Bd == n->next->child->tok))
868 break;
869 /* FALLTHROUGH */
870 case LIST_bullet:
871 /* FALLTHROUGH */
872 case LIST_dash:
873 /* FALLTHROUGH */
874 case LIST_enum:
875 /* FALLTHROUGH */
876 case LIST_hyphen:
877 /* FALLTHROUGH */
878 case LIST_tag:
879 assert(width);
880 if (MDOC_HEAD == n->type)
881 p->rmargin = p->offset + width;
882 else {
883 p->offset += width;
884 if (p->rmargin < p->offset)
885 p->rmargin = p->offset;
886 }
887 break;
888 case LIST_column:
889 assert(width);
890 p->rmargin = p->offset + width;
891 /*
892 * XXX - this behaviour is not documented: the
893 * right-most column is filled to the right margin.
894 */
895 if (MDOC_HEAD == n->type)
896 break;
897 if (NULL == n->next && p->rmargin < p->maxrmargin)
898 p->rmargin = p->maxrmargin;
899 break;
900 default:
901 break;
902 }
903
904 /*
905 * The dash, hyphen, bullet and enum lists all have a special
906 * HEAD character (temporarily bold, in some cases).
907 */
908
909 if (MDOC_HEAD == n->type)
910 switch (type) {
911 case LIST_bullet:
912 term_fontpush(p, TERMFONT_BOLD);
913 term_word(p, "\\[bu]");
914 term_fontpop(p);
915 break;
916 case LIST_dash:
917 /* FALLTHROUGH */
918 case LIST_hyphen:
919 term_fontpush(p, TERMFONT_BOLD);
920 term_word(p, "\\(hy");
921 term_fontpop(p);
922 break;
923 case LIST_enum:
924 (pair->ppair->ppair->count)++;
925 (void)snprintf(buf, sizeof(buf), "%d.",
926 pair->ppair->ppair->count);
927 term_word(p, buf);
928 break;
929 default:
930 break;
931 }
932
933 /*
934 * If we're not going to process our children, indicate so here.
935 */
936
937 switch (type) {
938 case LIST_bullet:
939 /* FALLTHROUGH */
940 case LIST_item:
941 /* FALLTHROUGH */
942 case LIST_dash:
943 /* FALLTHROUGH */
944 case LIST_hyphen:
945 /* FALLTHROUGH */
946 case LIST_enum:
947 if (MDOC_HEAD == n->type)
948 return(0);
949 break;
950 case LIST_column:
951 if (MDOC_HEAD == n->type)
952 return(0);
953 break;
954 default:
955 break;
956 }
957
958 return(1);
959 }
960
961 static void
962 termp_it_post(DECL_ARGS)
963 {
964 enum mdoc_list type;
965
966 if (MDOC_BLOCK == n->type)
967 return;
968
969 type = n->parent->parent->parent->norm->Bl.type;
970
971 switch (type) {
972 case LIST_item:
973 /* FALLTHROUGH */
974 case LIST_diag:
975 /* FALLTHROUGH */
976 case LIST_inset:
977 if (MDOC_BODY == n->type)
978 term_newln(p);
979 break;
980 case LIST_column:
981 if (MDOC_BODY == n->type)
982 term_flushln(p);
983 break;
984 default:
985 term_newln(p);
986 break;
987 }
988
989 /*
990 * Now that our output is flushed, we can reset our tags. Since
991 * only `It' sets these flags, we're free to assume that nobody
992 * has munged them in the meanwhile.
993 */
994
995 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
996 TERMP_DANGLE | TERMP_HANG);
997 p->trailspace = 0;
998 }
999
1000 static int
1001 termp_nm_pre(DECL_ARGS)
1002 {
1003
1004 if (MDOC_BLOCK == n->type) {
1005 p->flags |= TERMP_PREKEEP;
1006 return(1);
1007 }
1008
1009 if (MDOC_BODY == n->type) {
1010 if (NULL == n->child)
1011 return(0);
1012 p->flags |= TERMP_NOSPACE;
1013 p->offset += term_len(p, 1) +
1014 (NULL == n->prev->child ?
1015 term_strlen(p, meta->name) :
1016 MDOC_TEXT == n->prev->child->type ?
1017 term_strlen(p, n->prev->child->string) :
1018 term_len(p, 5));
1019 if (p->rmargin < p->offset)
1020 p->rmargin = p->offset;
1021 return(1);
1022 }
1023
1024 if (NULL == n->child && NULL == meta->name)
1025 return(0);
1026
1027 if (MDOC_HEAD == n->type)
1028 synopsis_pre(p, n->parent);
1029
1030 if (MDOC_HEAD == n->type && n->next->child) {
1031 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
1032 p->trailspace = 1;
1033 p->rmargin = p->offset + term_len(p, 1);
1034 if (NULL == n->child) {
1035 p->rmargin += term_strlen(p, meta->name);
1036 } else if (MDOC_TEXT == n->child->type) {
1037 p->rmargin += term_strlen(p, n->child->string);
1038 if (n->child->next)
1039 p->flags |= TERMP_HANG;
1040 } else {
1041 p->rmargin += term_len(p, 5);
1042 p->flags |= TERMP_HANG;
1043 }
1044 }
1045
1046 term_fontpush(p, TERMFONT_BOLD);
1047 if (NULL == n->child)
1048 term_word(p, meta->name);
1049 return(1);
1050 }
1051
1052 static void
1053 termp_nm_post(DECL_ARGS)
1054 {
1055
1056 if (MDOC_BLOCK == n->type) {
1057 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1058 } else if (MDOC_HEAD == n->type && n->next->child) {
1059 term_flushln(p);
1060 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1061 p->trailspace = 0;
1062 } else if (MDOC_BODY == n->type && n->child)
1063 term_flushln(p);
1064 }
1065
1066 static int
1067 termp_fl_pre(DECL_ARGS)
1068 {
1069
1070 term_fontpush(p, TERMFONT_BOLD);
1071 term_word(p, "\\-");
1072
1073 if (n->child)
1074 p->flags |= TERMP_NOSPACE;
1075 else if (n->next && n->next->line == n->line)
1076 p->flags |= TERMP_NOSPACE;
1077
1078 return(1);
1079 }
1080
1081 static int
1082 termp__a_pre(DECL_ARGS)
1083 {
1084
1085 if (n->prev && MDOC__A == n->prev->tok)
1086 if (NULL == n->next || MDOC__A != n->next->tok)
1087 term_word(p, "and");
1088
1089 return(1);
1090 }
1091
1092 static int
1093 termp_an_pre(DECL_ARGS)
1094 {
1095
1096 if (NULL == n->child)
1097 return(1);
1098
1099 /*
1100 * If not in the AUTHORS section, `An -split' will cause
1101 * newlines to occur before the author name. If in the AUTHORS
1102 * section, by default, the first `An' invocation is nosplit,
1103 * then all subsequent ones, regardless of whether interspersed
1104 * with other macros/text, are split. -split, in this case,
1105 * will override the condition of the implied first -nosplit.
1106 */
1107
1108 if (n->sec == SEC_AUTHORS) {
1109 if ( ! (TERMP_ANPREC & p->flags)) {
1110 if (TERMP_SPLIT & p->flags)
1111 term_newln(p);
1112 return(1);
1113 }
1114 if (TERMP_NOSPLIT & p->flags)
1115 return(1);
1116 term_newln(p);
1117 return(1);
1118 }
1119
1120 if (TERMP_SPLIT & p->flags)
1121 term_newln(p);
1122
1123 return(1);
1124 }
1125
1126 static void
1127 termp_an_post(DECL_ARGS)
1128 {
1129
1130 if (n->child) {
1131 if (SEC_AUTHORS == n->sec)
1132 p->flags |= TERMP_ANPREC;
1133 return;
1134 }
1135
1136 if (AUTH_split == n->norm->An.auth) {
1137 p->flags &= ~TERMP_NOSPLIT;
1138 p->flags |= TERMP_SPLIT;
1139 } else if (AUTH_nosplit == n->norm->An.auth) {
1140 p->flags &= ~TERMP_SPLIT;
1141 p->flags |= TERMP_NOSPLIT;
1142 }
1143
1144 }
1145
1146 static int
1147 termp_ns_pre(DECL_ARGS)
1148 {
1149
1150 if ( ! (MDOC_LINE & n->flags))
1151 p->flags |= TERMP_NOSPACE;
1152 return(1);
1153 }
1154
1155 static int
1156 termp_rs_pre(DECL_ARGS)
1157 {
1158
1159 if (SEC_SEE_ALSO != n->sec)
1160 return(1);
1161 if (MDOC_BLOCK == n->type && n->prev)
1162 term_vspace(p);
1163 return(1);
1164 }
1165
1166 static int
1167 termp_rv_pre(DECL_ARGS)
1168 {
1169 int nchild;
1170
1171 term_newln(p);
1172
1173 nchild = n->nchild;
1174 if (nchild > 0) {
1175 term_word(p, "The");
1176
1177 for (n = n->child; n; n = n->next) {
1178 term_fontpush(p, TERMFONT_BOLD);
1179 term_word(p, n->string);
1180 term_fontpop(p);
1181
1182 p->flags |= TERMP_NOSPACE;
1183 term_word(p, "()");
1184
1185 if (n->next == NULL)
1186 continue;
1187
1188 if (nchild > 2) {
1189 p->flags |= TERMP_NOSPACE;
1190 term_word(p, ",");
1191 }
1192 if (n->next->next == NULL)
1193 term_word(p, "and");
1194 }
1195
1196 if (nchild > 1)
1197 term_word(p, "functions return");
1198 else
1199 term_word(p, "function returns");
1200
1201 term_word(p, "the value\\~0 if successful;");
1202 } else
1203 term_word(p, "Upon successful completion,"
1204 " the value\\~0 is returned;");
1205
1206 term_word(p, "otherwise the value\\~\\-1 is returned"
1207 " and the global variable");
1208
1209 term_fontpush(p, TERMFONT_UNDER);
1210 term_word(p, "errno");
1211 term_fontpop(p);
1212
1213 term_word(p, "is set to indicate the error.");
1214 p->flags |= TERMP_SENTENCE;
1215
1216 return(0);
1217 }
1218
1219 static int
1220 termp_ex_pre(DECL_ARGS)
1221 {
1222 int nchild;
1223
1224 term_newln(p);
1225 term_word(p, "The");
1226
1227 nchild = n->nchild;
1228 for (n = n->child; n; n = n->next) {
1229 term_fontpush(p, TERMFONT_BOLD);
1230 term_word(p, n->string);
1231 term_fontpop(p);
1232
1233 if (nchild > 2 && n->next) {
1234 p->flags |= TERMP_NOSPACE;
1235 term_word(p, ",");
1236 }
1237
1238 if (n->next && NULL == n->next->next)
1239 term_word(p, "and");
1240 }
1241
1242 if (nchild > 1)
1243 term_word(p, "utilities exit\\~0");
1244 else
1245 term_word(p, "utility exits\\~0");
1246
1247 term_word(p, "on success, and\\~>0 if an error occurs.");
1248
1249 p->flags |= TERMP_SENTENCE;
1250 return(0);
1251 }
1252
1253 static int
1254 termp_nd_pre(DECL_ARGS)
1255 {
1256
1257 if (MDOC_BODY != n->type)
1258 return(1);
1259
1260 #if defined(__OpenBSD__) || defined(__linux__)
1261 term_word(p, "\\(en");
1262 #else
1263 term_word(p, "\\(em");
1264 #endif
1265 return(1);
1266 }
1267
1268 static int
1269 termp_bl_pre(DECL_ARGS)
1270 {
1271
1272 return(MDOC_HEAD != n->type);
1273 }
1274
1275 static void
1276 termp_bl_post(DECL_ARGS)
1277 {
1278
1279 if (MDOC_BLOCK == n->type)
1280 term_newln(p);
1281 }
1282
1283 static int
1284 termp_xr_pre(DECL_ARGS)
1285 {
1286
1287 if (NULL == (n = n->child))
1288 return(0);
1289
1290 assert(MDOC_TEXT == n->type);
1291 term_word(p, n->string);
1292
1293 if (NULL == (n = n->next))
1294 return(0);
1295
1296 p->flags |= TERMP_NOSPACE;
1297 term_word(p, "(");
1298 p->flags |= TERMP_NOSPACE;
1299
1300 assert(MDOC_TEXT == n->type);
1301 term_word(p, n->string);
1302
1303 p->flags |= TERMP_NOSPACE;
1304 term_word(p, ")");
1305
1306 return(0);
1307 }
1308
1309 /*
1310 * This decides how to assert whitespace before any of the SYNOPSIS set
1311 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1312 * macro combos).
1313 */
1314 static void
1315 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1316 {
1317 /*
1318 * Obviously, if we're not in a SYNOPSIS or no prior macros
1319 * exist, do nothing.
1320 */
1321 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1322 return;
1323
1324 /*
1325 * If we're the second in a pair of like elements, emit our
1326 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1327 * case we soldier on.
1328 */
1329 if (n->prev->tok == n->tok &&
1330 MDOC_Ft != n->tok &&
1331 MDOC_Fo != n->tok &&
1332 MDOC_Fn != n->tok) {
1333 term_newln(p);
1334 return;
1335 }
1336
1337 /*
1338 * If we're one of the SYNOPSIS set and non-like pair-wise after
1339 * another (or Fn/Fo, which we've let slip through) then assert
1340 * vertical space, else only newline and move on.
1341 */
1342 switch (n->prev->tok) {
1343 case MDOC_Fd:
1344 /* FALLTHROUGH */
1345 case MDOC_Fn:
1346 /* FALLTHROUGH */
1347 case MDOC_Fo:
1348 /* FALLTHROUGH */
1349 case MDOC_In:
1350 /* FALLTHROUGH */
1351 case MDOC_Vt:
1352 term_vspace(p);
1353 break;
1354 case MDOC_Ft:
1355 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1356 term_vspace(p);
1357 break;
1358 }
1359 /* FALLTHROUGH */
1360 default:
1361 term_newln(p);
1362 break;
1363 }
1364 }
1365
1366 static int
1367 termp_vt_pre(DECL_ARGS)
1368 {
1369
1370 if (MDOC_ELEM == n->type) {
1371 synopsis_pre(p, n);
1372 return(termp_under_pre(p, pair, meta, n));
1373 } else if (MDOC_BLOCK == n->type) {
1374 synopsis_pre(p, n);
1375 return(1);
1376 } else if (MDOC_HEAD == n->type)
1377 return(0);
1378
1379 return(termp_under_pre(p, pair, meta, n));
1380 }
1381
1382 static int
1383 termp_bold_pre(DECL_ARGS)
1384 {
1385
1386 term_fontpush(p, TERMFONT_BOLD);
1387 return(1);
1388 }
1389
1390 static int
1391 termp_fd_pre(DECL_ARGS)
1392 {
1393
1394 synopsis_pre(p, n);
1395 return(termp_bold_pre(p, pair, meta, n));
1396 }
1397
1398 static void
1399 termp_fd_post(DECL_ARGS)
1400 {
1401
1402 term_newln(p);
1403 }
1404
1405 static int
1406 termp_sh_pre(DECL_ARGS)
1407 {
1408
1409 /* No vspace between consecutive `Sh' calls. */
1410
1411 switch (n->type) {
1412 case MDOC_BLOCK:
1413 if (n->prev && MDOC_Sh == n->prev->tok)
1414 if (NULL == n->prev->body->child)
1415 break;
1416 term_vspace(p);
1417 break;
1418 case MDOC_HEAD:
1419 term_fontpush(p, TERMFONT_BOLD);
1420 break;
1421 case MDOC_BODY:
1422 p->offset = term_len(p, p->defindent);
1423 if (SEC_AUTHORS == n->sec)
1424 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1425 break;
1426 default:
1427 break;
1428 }
1429 return(1);
1430 }
1431
1432 static void
1433 termp_sh_post(DECL_ARGS)
1434 {
1435
1436 switch (n->type) {
1437 case MDOC_HEAD:
1438 term_newln(p);
1439 break;
1440 case MDOC_BODY:
1441 term_newln(p);
1442 p->offset = 0;
1443 break;
1444 default:
1445 break;
1446 }
1447 }
1448
1449 static int
1450 termp_bt_pre(DECL_ARGS)
1451 {
1452
1453 term_word(p, "is currently in beta test.");
1454 p->flags |= TERMP_SENTENCE;
1455 return(0);
1456 }
1457
1458 static void
1459 termp_lb_post(DECL_ARGS)
1460 {
1461
1462 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1463 term_newln(p);
1464 }
1465
1466 static int
1467 termp_ud_pre(DECL_ARGS)
1468 {
1469
1470 term_word(p, "currently under development.");
1471 p->flags |= TERMP_SENTENCE;
1472 return(0);
1473 }
1474
1475 static int
1476 termp_d1_pre(DECL_ARGS)
1477 {
1478
1479 if (MDOC_BLOCK != n->type)
1480 return(1);
1481 term_newln(p);
1482 p->offset += term_len(p, p->defindent + 1);
1483 return(1);
1484 }
1485
1486 static int
1487 termp_ft_pre(DECL_ARGS)
1488 {
1489
1490 /* NB: MDOC_LINE does not effect this! */
1491 synopsis_pre(p, n);
1492 term_fontpush(p, TERMFONT_UNDER);
1493 return(1);
1494 }
1495
1496 static int
1497 termp_fn_pre(DECL_ARGS)
1498 {
1499 size_t rmargin = 0;
1500 int pretty;
1501
1502 pretty = MDOC_SYNPRETTY & n->flags;
1503
1504 synopsis_pre(p, n);
1505
1506 if (NULL == (n = n->child))
1507 return(0);
1508
1509 if (pretty) {
1510 rmargin = p->rmargin;
1511 p->rmargin = p->offset + term_len(p, 4);
1512 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1513 }
1514
1515 assert(MDOC_TEXT == n->type);
1516 term_fontpush(p, TERMFONT_BOLD);
1517 term_word(p, n->string);
1518 term_fontpop(p);
1519
1520 if (pretty) {
1521 term_flushln(p);
1522 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1523 p->offset = p->rmargin;
1524 p->rmargin = rmargin;
1525 }
1526
1527 p->flags |= TERMP_NOSPACE;
1528 term_word(p, "(");
1529 p->flags |= TERMP_NOSPACE;
1530
1531 for (n = n->next; n; n = n->next) {
1532 assert(MDOC_TEXT == n->type);
1533 term_fontpush(p, TERMFONT_UNDER);
1534 if (pretty)
1535 p->flags |= TERMP_NBRWORD;
1536 term_word(p, n->string);
1537 term_fontpop(p);
1538
1539 if (n->next) {
1540 p->flags |= TERMP_NOSPACE;
1541 term_word(p, ",");
1542 }
1543 }
1544
1545 p->flags |= TERMP_NOSPACE;
1546 term_word(p, ")");
1547
1548 if (pretty) {
1549 p->flags |= TERMP_NOSPACE;
1550 term_word(p, ";");
1551 term_flushln(p);
1552 }
1553
1554 return(0);
1555 }
1556
1557 static int
1558 termp_fa_pre(DECL_ARGS)
1559 {
1560 const struct mdoc_node *nn;
1561
1562 if (n->parent->tok != MDOC_Fo) {
1563 term_fontpush(p, TERMFONT_UNDER);
1564 return(1);
1565 }
1566
1567 for (nn = n->child; nn; nn = nn->next) {
1568 term_fontpush(p, TERMFONT_UNDER);
1569 p->flags |= TERMP_NBRWORD;
1570 term_word(p, nn->string);
1571 term_fontpop(p);
1572
1573 if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1574 p->flags |= TERMP_NOSPACE;
1575 term_word(p, ",");
1576 }
1577 }
1578
1579 return(0);
1580 }
1581
1582 static int
1583 termp_bd_pre(DECL_ARGS)
1584 {
1585 size_t tabwidth, lm, len, rm, rmax;
1586 struct mdoc_node *nn;
1587
1588 if (MDOC_BLOCK == n->type) {
1589 print_bvspace(p, n, n);
1590 return(1);
1591 } else if (MDOC_HEAD == n->type)
1592 return(0);
1593
1594 if (n->norm->Bd.offs)
1595 p->offset += a2offs(p, n->norm->Bd.offs);
1596
1597 /*
1598 * If -ragged or -filled are specified, the block does nothing
1599 * but change the indentation. If -unfilled or -literal are
1600 * specified, text is printed exactly as entered in the display:
1601 * for macro lines, a newline is appended to the line. Blank
1602 * lines are allowed.
1603 */
1604
1605 if (DISP_literal != n->norm->Bd.type &&
1606 DISP_unfilled != n->norm->Bd.type &&
1607 DISP_centered != n->norm->Bd.type)
1608 return(1);
1609
1610 tabwidth = p->tabwidth;
1611 if (DISP_literal == n->norm->Bd.type)
1612 p->tabwidth = term_len(p, 8);
1613
1614 lm = p->offset;
1615 rm = p->rmargin;
1616 rmax = p->maxrmargin;
1617 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1618
1619 for (nn = n->child; nn; nn = nn->next) {
1620 if (DISP_centered == n->norm->Bd.type) {
1621 if (MDOC_TEXT == nn->type) {
1622 len = term_strlen(p, nn->string);
1623 p->offset = len >= rm ? 0 :
1624 lm + len >= rm ? rm - len :
1625 (lm + rm - len) / 2;
1626 } else
1627 p->offset = lm;
1628 }
1629 print_mdoc_node(p, pair, meta, nn);
1630 /*
1631 * If the printed node flushes its own line, then we
1632 * needn't do it here as well. This is hacky, but the
1633 * notion of selective eoln whitespace is pretty dumb
1634 * anyway, so don't sweat it.
1635 */
1636 switch (nn->tok) {
1637 case MDOC_Sm:
1638 /* FALLTHROUGH */
1639 case MDOC_br:
1640 /* FALLTHROUGH */
1641 case MDOC_sp:
1642 /* FALLTHROUGH */
1643 case MDOC_Bl:
1644 /* FALLTHROUGH */
1645 case MDOC_D1:
1646 /* FALLTHROUGH */
1647 case MDOC_Dl:
1648 /* FALLTHROUGH */
1649 case MDOC_Lp:
1650 /* FALLTHROUGH */
1651 case MDOC_Pp:
1652 continue;
1653 default:
1654 break;
1655 }
1656 if (nn->next && nn->next->line == nn->line)
1657 continue;
1658 term_flushln(p);
1659 p->flags |= TERMP_NOSPACE;
1660 }
1661
1662 p->tabwidth = tabwidth;
1663 p->rmargin = rm;
1664 p->maxrmargin = rmax;
1665 return(0);
1666 }
1667
1668 static void
1669 termp_bd_post(DECL_ARGS)
1670 {
1671 size_t rm, rmax;
1672
1673 if (MDOC_BODY != n->type)
1674 return;
1675
1676 rm = p->rmargin;
1677 rmax = p->maxrmargin;
1678
1679 if (DISP_literal == n->norm->Bd.type ||
1680 DISP_unfilled == n->norm->Bd.type)
1681 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1682
1683 p->flags |= TERMP_NOSPACE;
1684 term_newln(p);
1685
1686 p->rmargin = rm;
1687 p->maxrmargin = rmax;
1688 }
1689
1690 static int
1691 termp_bx_pre(DECL_ARGS)
1692 {
1693
1694 if (NULL != (n = n->child)) {
1695 term_word(p, n->string);
1696 p->flags |= TERMP_NOSPACE;
1697 term_word(p, "BSD");
1698 } else {
1699 term_word(p, "BSD");
1700 return(0);
1701 }
1702
1703 if (NULL != (n = n->next)) {
1704 p->flags |= TERMP_NOSPACE;
1705 term_word(p, "-");
1706 p->flags |= TERMP_NOSPACE;
1707 term_word(p, n->string);
1708 }
1709
1710 return(0);
1711 }
1712
1713 static int
1714 termp_xx_pre(DECL_ARGS)
1715 {
1716 const char *pp;
1717 int flags;
1718
1719 pp = NULL;
1720 switch (n->tok) {
1721 case MDOC_Bsx:
1722 pp = "BSD/OS";
1723 break;
1724 case MDOC_Dx:
1725 pp = "DragonFly";
1726 break;
1727 case MDOC_Fx:
1728 pp = "FreeBSD";
1729 break;
1730 case MDOC_Nx:
1731 pp = "NetBSD";
1732 break;
1733 case MDOC_Ox:
1734 pp = "OpenBSD";
1735 break;
1736 case MDOC_Ux:
1737 pp = "UNIX";
1738 break;
1739 default:
1740 abort();
1741 /* NOTREACHED */
1742 }
1743
1744 term_word(p, pp);
1745 if (n->child) {
1746 flags = p->flags;
1747 p->flags |= TERMP_KEEP;
1748 term_word(p, n->child->string);
1749 p->flags = flags;
1750 }
1751 return(0);
1752 }
1753
1754 static void
1755 termp_pf_post(DECL_ARGS)
1756 {
1757
1758 p->flags |= TERMP_NOSPACE;
1759 }
1760
1761 static int
1762 termp_ss_pre(DECL_ARGS)
1763 {
1764
1765 switch (n->type) {
1766 case MDOC_BLOCK:
1767 term_newln(p);
1768 if (n->prev)
1769 term_vspace(p);
1770 break;
1771 case MDOC_HEAD:
1772 term_fontpush(p, TERMFONT_BOLD);
1773 p->offset = term_len(p, (p->defindent+1)/2);
1774 break;
1775 case MDOC_BODY:
1776 p->offset = term_len(p, p->defindent);
1777 break;
1778 default:
1779 break;
1780 }
1781
1782 return(1);
1783 }
1784
1785 static void
1786 termp_ss_post(DECL_ARGS)
1787 {
1788
1789 if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
1790 term_newln(p);
1791 }
1792
1793 static int
1794 termp_cd_pre(DECL_ARGS)
1795 {
1796
1797 synopsis_pre(p, n);
1798 term_fontpush(p, TERMFONT_BOLD);
1799 return(1);
1800 }
1801
1802 static int
1803 termp_in_pre(DECL_ARGS)
1804 {
1805
1806 synopsis_pre(p, n);
1807
1808 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1809 term_fontpush(p, TERMFONT_BOLD);
1810 term_word(p, "#include");
1811 term_word(p, "<");
1812 } else {
1813 term_word(p, "<");
1814 term_fontpush(p, TERMFONT_UNDER);
1815 }
1816
1817 p->flags |= TERMP_NOSPACE;
1818 return(1);
1819 }
1820
1821 static void
1822 termp_in_post(DECL_ARGS)
1823 {
1824
1825 if (MDOC_SYNPRETTY & n->flags)
1826 term_fontpush(p, TERMFONT_BOLD);
1827
1828 p->flags |= TERMP_NOSPACE;
1829 term_word(p, ">");
1830
1831 if (MDOC_SYNPRETTY & n->flags)
1832 term_fontpop(p);
1833 }
1834
1835 static int
1836 termp_sp_pre(DECL_ARGS)
1837 {
1838 size_t i, len;
1839
1840 switch (n->tok) {
1841 case MDOC_sp:
1842 len = n->child ? a2height(p, n->child->string) : 1;
1843 break;
1844 case MDOC_br:
1845 len = 0;
1846 break;
1847 default:
1848 len = 1;
1849 break;
1850 }
1851
1852 if (0 == len)
1853 term_newln(p);
1854 for (i = 0; i < len; i++)
1855 term_vspace(p);
1856
1857 return(0);
1858 }
1859
1860 static int
1861 termp_es_pre(DECL_ARGS)
1862 {
1863
1864 return(0);
1865 }
1866
1867 static int
1868 termp_quote_pre(DECL_ARGS)
1869 {
1870
1871 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1872 return(1);
1873
1874 switch (n->tok) {
1875 case MDOC_Ao:
1876 /* FALLTHROUGH */
1877 case MDOC_Aq:
1878 term_word(p, "<");
1879 break;
1880 case MDOC_Bro:
1881 /* FALLTHROUGH */
1882 case MDOC_Brq:
1883 term_word(p, "{");
1884 break;
1885 case MDOC_Oo:
1886 /* FALLTHROUGH */
1887 case MDOC_Op:
1888 /* FALLTHROUGH */
1889 case MDOC_Bo:
1890 /* FALLTHROUGH */
1891 case MDOC_Bq:
1892 term_word(p, "[");
1893 break;
1894 case MDOC_Do:
1895 /* FALLTHROUGH */
1896 case MDOC_Dq:
1897 term_word(p, "\\(lq");
1898 break;
1899 case MDOC_En:
1900 if (NULL == n->norm->Es ||
1901 NULL == n->norm->Es->child)
1902 return(1);
1903 term_word(p, n->norm->Es->child->string);
1904 break;
1905 case MDOC_Eo:
1906 break;
1907 case MDOC_Po:
1908 /* FALLTHROUGH */
1909 case MDOC_Pq:
1910 term_word(p, "(");
1911 break;
1912 case MDOC__T:
1913 /* FALLTHROUGH */
1914 case MDOC_Qo:
1915 /* FALLTHROUGH */
1916 case MDOC_Qq:
1917 term_word(p, "\"");
1918 break;
1919 case MDOC_Ql:
1920 /* FALLTHROUGH */
1921 case MDOC_So:
1922 /* FALLTHROUGH */
1923 case MDOC_Sq:
1924 term_word(p, "\\(oq");
1925 break;
1926 default:
1927 abort();
1928 /* NOTREACHED */
1929 }
1930
1931 p->flags |= TERMP_NOSPACE;
1932 return(1);
1933 }
1934
1935 static void
1936 termp_quote_post(DECL_ARGS)
1937 {
1938
1939 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1940 return;
1941
1942 if (MDOC_En != n->tok)
1943 p->flags |= TERMP_NOSPACE;
1944
1945 switch (n->tok) {
1946 case MDOC_Ao:
1947 /* FALLTHROUGH */
1948 case MDOC_Aq:
1949 term_word(p, ">");
1950 break;
1951 case MDOC_Bro:
1952 /* FALLTHROUGH */
1953 case MDOC_Brq:
1954 term_word(p, "}");
1955 break;
1956 case MDOC_Oo:
1957 /* FALLTHROUGH */
1958 case MDOC_Op:
1959 /* FALLTHROUGH */
1960 case MDOC_Bo:
1961 /* FALLTHROUGH */
1962 case MDOC_Bq:
1963 term_word(p, "]");
1964 break;
1965 case MDOC_Do:
1966 /* FALLTHROUGH */
1967 case MDOC_Dq:
1968 term_word(p, "\\(rq");
1969 break;
1970 case MDOC_En:
1971 if (NULL != n->norm->Es &&
1972 NULL != n->norm->Es->child &&
1973 NULL != n->norm->Es->child->next) {
1974 p->flags |= TERMP_NOSPACE;
1975 term_word(p, n->norm->Es->child->next->string);
1976 }
1977 break;
1978 case MDOC_Eo:
1979 break;
1980 case MDOC_Po:
1981 /* FALLTHROUGH */
1982 case MDOC_Pq:
1983 term_word(p, ")");
1984 break;
1985 case MDOC__T:
1986 /* FALLTHROUGH */
1987 case MDOC_Qo:
1988 /* FALLTHROUGH */
1989 case MDOC_Qq:
1990 term_word(p, "\"");
1991 break;
1992 case MDOC_Ql:
1993 /* FALLTHROUGH */
1994 case MDOC_So:
1995 /* FALLTHROUGH */
1996 case MDOC_Sq:
1997 term_word(p, "\\(cq");
1998 break;
1999 default:
2000 abort();
2001 /* NOTREACHED */
2002 }
2003 }
2004
2005 static int
2006 termp_fo_pre(DECL_ARGS)
2007 {
2008 size_t rmargin = 0;
2009 int pretty;
2010
2011 pretty = MDOC_SYNPRETTY & n->flags;
2012
2013 if (MDOC_BLOCK == n->type) {
2014 synopsis_pre(p, n);
2015 return(1);
2016 } else if (MDOC_BODY == n->type) {
2017 if (pretty) {
2018 rmargin = p->rmargin;
2019 p->rmargin = p->offset + term_len(p, 4);
2020 p->flags |= TERMP_NOBREAK | TERMP_BRIND |
2021 TERMP_HANG;
2022 }
2023 p->flags |= TERMP_NOSPACE;
2024 term_word(p, "(");
2025 p->flags |= TERMP_NOSPACE;
2026 if (pretty) {
2027 term_flushln(p);
2028 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
2029 TERMP_HANG);
2030 p->offset = p->rmargin;
2031 p->rmargin = rmargin;
2032 }
2033 return(1);
2034 }
2035
2036 if (NULL == n->child)
2037 return(0);
2038
2039 /* XXX: we drop non-initial arguments as per groff. */
2040
2041 assert(n->child->string);
2042 term_fontpush(p, TERMFONT_BOLD);
2043 term_word(p, n->child->string);
2044 return(0);
2045 }
2046
2047 static void
2048 termp_fo_post(DECL_ARGS)
2049 {
2050
2051 if (MDOC_BODY != n->type)
2052 return;
2053
2054 p->flags |= TERMP_NOSPACE;
2055 term_word(p, ")");
2056
2057 if (MDOC_SYNPRETTY & n->flags) {
2058 p->flags |= TERMP_NOSPACE;
2059 term_word(p, ";");
2060 term_flushln(p);
2061 }
2062 }
2063
2064 static int
2065 termp_bf_pre(DECL_ARGS)
2066 {
2067
2068 if (MDOC_HEAD == n->type)
2069 return(0);
2070 else if (MDOC_BODY != n->type)
2071 return(1);
2072
2073 if (FONT_Em == n->norm->Bf.font)
2074 term_fontpush(p, TERMFONT_UNDER);
2075 else if (FONT_Sy == n->norm->Bf.font)
2076 term_fontpush(p, TERMFONT_BOLD);
2077 else
2078 term_fontpush(p, TERMFONT_NONE);
2079
2080 return(1);
2081 }
2082
2083 static int
2084 termp_sm_pre(DECL_ARGS)
2085 {
2086
2087 if (NULL == n->child)
2088 p->flags ^= TERMP_NONOSPACE;
2089 else if (0 == strcmp("on", n->child->string))
2090 p->flags &= ~TERMP_NONOSPACE;
2091 else
2092 p->flags |= TERMP_NONOSPACE;
2093
2094 if (p->col && ! (TERMP_NONOSPACE & p->flags))
2095 p->flags &= ~TERMP_NOSPACE;
2096
2097 return(0);
2098 }
2099
2100 static int
2101 termp_ap_pre(DECL_ARGS)
2102 {
2103
2104 p->flags |= TERMP_NOSPACE;
2105 term_word(p, "'");
2106 p->flags |= TERMP_NOSPACE;
2107 return(1);
2108 }
2109
2110 static void
2111 termp____post(DECL_ARGS)
2112 {
2113
2114 /*
2115 * Handle lists of authors. In general, print each followed by
2116 * a comma. Don't print the comma if there are only two
2117 * authors.
2118 */
2119 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2120 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2121 if (NULL == n->prev || MDOC__A != n->prev->tok)
2122 return;
2123
2124 /* TODO: %U. */
2125
2126 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2127 return;
2128
2129 p->flags |= TERMP_NOSPACE;
2130 if (NULL == n->next) {
2131 term_word(p, ".");
2132 p->flags |= TERMP_SENTENCE;
2133 } else
2134 term_word(p, ",");
2135 }
2136
2137 static int
2138 termp_li_pre(DECL_ARGS)
2139 {
2140
2141 term_fontpush(p, TERMFONT_NONE);
2142 return(1);
2143 }
2144
2145 static int
2146 termp_lk_pre(DECL_ARGS)
2147 {
2148 const struct mdoc_node *link, *descr;
2149
2150 if (NULL == (link = n->child))
2151 return(0);
2152
2153 if (NULL != (descr = link->next)) {
2154 term_fontpush(p, TERMFONT_UNDER);
2155 while (NULL != descr) {
2156 term_word(p, descr->string);
2157 descr = descr->next;
2158 }
2159 p->flags |= TERMP_NOSPACE;
2160 term_word(p, ":");
2161 term_fontpop(p);
2162 }
2163
2164 term_fontpush(p, TERMFONT_BOLD);
2165 term_word(p, link->string);
2166 term_fontpop(p);
2167
2168 return(0);
2169 }
2170
2171 static int
2172 termp_bk_pre(DECL_ARGS)
2173 {
2174
2175 switch (n->type) {
2176 case MDOC_BLOCK:
2177 break;
2178 case MDOC_HEAD:
2179 return(0);
2180 case MDOC_BODY:
2181 if (n->parent->args || 0 == n->prev->nchild)
2182 p->flags |= TERMP_PREKEEP;
2183 break;
2184 default:
2185 abort();
2186 /* NOTREACHED */
2187 }
2188
2189 return(1);
2190 }
2191
2192 static void
2193 termp_bk_post(DECL_ARGS)
2194 {
2195
2196 if (MDOC_BODY == n->type)
2197 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2198 }
2199
2200 static void
2201 termp__t_post(DECL_ARGS)
2202 {
2203
2204 /*
2205 * If we're in an `Rs' and there's a journal present, then quote
2206 * us instead of underlining us (for disambiguation).
2207 */
2208 if (n->parent && MDOC_Rs == n->parent->tok &&
2209 n->parent->norm->Rs.quote_T)
2210 termp_quote_post(p, pair, meta, n);
2211
2212 termp____post(p, pair, meta, n);
2213 }
2214
2215 static int
2216 termp__t_pre(DECL_ARGS)
2217 {
2218
2219 /*
2220 * If we're in an `Rs' and there's a journal present, then quote
2221 * us instead of underlining us (for disambiguation).
2222 */
2223 if (n->parent && MDOC_Rs == n->parent->tok &&
2224 n->parent->norm->Rs.quote_T)
2225 return(termp_quote_pre(p, pair, meta, n));
2226
2227 term_fontpush(p, TERMFONT_UNDER);
2228 return(1);
2229 }
2230
2231 static int
2232 termp_under_pre(DECL_ARGS)
2233 {
2234
2235 term_fontpush(p, TERMFONT_UNDER);
2236 return(1);
2237 }
A git conversion mirror of mandoc.bsd.lv