1 /* $Id: mdoc_term.c,v 1.238 2011/11/13 13:15:14 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #include <sys/types.h>
38 struct termpair *ppair;
42 #define DECL_ARGS struct termp *p, \
43 struct termpair *pair, \
44 const struct mdoc_meta *m, \
45 const struct mdoc_node *n
48 int (*pre)(DECL_ARGS);
49 void (*post)(DECL_ARGS);
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 *);
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 *);
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_d1_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);
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_ex_pre(DECL_ARGS);
97 static int termp_fa_pre(DECL_ARGS);
98 static int termp_fd_pre(DECL_ARGS);
99 static int termp_fl_pre(DECL_ARGS);
100 static int termp_fn_pre(DECL_ARGS);
101 static int termp_fo_pre(DECL_ARGS);
102 static int termp_ft_pre(DECL_ARGS);
103 static int termp_igndelim_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_lk_pre(DECL_ARGS);
108 static int termp_nd_pre(DECL_ARGS);
109 static int termp_nm_pre(DECL_ARGS);
110 static int termp_ns_pre(DECL_ARGS);
111 static int termp_quote_pre(DECL_ARGS);
112 static int termp_rs_pre(DECL_ARGS);
113 static int termp_rv_pre(DECL_ARGS);
114 static int termp_sh_pre(DECL_ARGS);
115 static int termp_sm_pre(DECL_ARGS);
116 static int termp_sp_pre(DECL_ARGS);
117 static int termp_ss_pre(DECL_ARGS);
118 static int termp_under_pre(DECL_ARGS);
119 static int termp_ud_pre(DECL_ARGS);
120 static int termp_vt_pre(DECL_ARGS);
121 static int termp_xr_pre(DECL_ARGS);
122 static int termp_xx_pre(DECL_ARGS);
124 static const struct termact termacts[MDOC_MAX] = {
125 { termp_ap_pre, NULL }, /* Ap */
126 { NULL, NULL }, /* Dd */
127 { NULL, NULL }, /* Dt */
128 { NULL, NULL }, /* Os */
129 { termp_sh_pre, termp_sh_post }, /* Sh */
130 { termp_ss_pre, termp_ss_post }, /* Ss */
131 { termp_sp_pre, NULL }, /* Pp */
132 { termp_d1_pre, termp_d1_post }, /* D1 */
133 { termp_d1_pre, termp_d1_post }, /* Dl */
134 { termp_bd_pre, termp_bd_post }, /* Bd */
135 { NULL, NULL }, /* Ed */
136 { termp_bl_pre, termp_bl_post }, /* Bl */
137 { NULL, NULL }, /* El */
138 { termp_it_pre, termp_it_post }, /* It */
139 { termp_under_pre, NULL }, /* Ad */
140 { termp_an_pre, termp_an_post }, /* An */
141 { termp_under_pre, NULL }, /* Ar */
142 { termp_cd_pre, NULL }, /* Cd */
143 { termp_bold_pre, NULL }, /* Cm */
144 { NULL, NULL }, /* Dv */
145 { NULL, NULL }, /* Er */
146 { NULL, NULL }, /* Ev */
147 { termp_ex_pre, NULL }, /* Ex */
148 { termp_fa_pre, NULL }, /* Fa */
149 { termp_fd_pre, NULL }, /* Fd */
150 { termp_fl_pre, NULL }, /* Fl */
151 { termp_fn_pre, NULL }, /* Fn */
152 { termp_ft_pre, NULL }, /* Ft */
153 { termp_bold_pre, NULL }, /* Ic */
154 { termp_in_pre, termp_in_post }, /* In */
155 { termp_li_pre, NULL }, /* Li */
156 { termp_nd_pre, NULL }, /* Nd */
157 { termp_nm_pre, termp_nm_post }, /* Nm */
158 { termp_quote_pre, termp_quote_post }, /* Op */
159 { NULL, NULL }, /* Ot */
160 { termp_under_pre, NULL }, /* Pa */
161 { termp_rv_pre, NULL }, /* Rv */
162 { NULL, NULL }, /* St */
163 { termp_under_pre, NULL }, /* Va */
164 { termp_vt_pre, NULL }, /* Vt */
165 { termp_xr_pre, NULL }, /* Xr */
166 { termp__a_pre, termp____post }, /* %A */
167 { termp_under_pre, termp____post }, /* %B */
168 { NULL, termp____post }, /* %D */
169 { termp_under_pre, termp____post }, /* %I */
170 { termp_under_pre, termp____post }, /* %J */
171 { NULL, termp____post }, /* %N */
172 { NULL, termp____post }, /* %O */
173 { NULL, termp____post }, /* %P */
174 { NULL, termp____post }, /* %R */
175 { termp__t_pre, termp__t_post }, /* %T */
176 { NULL, termp____post }, /* %V */
177 { NULL, NULL }, /* Ac */
178 { termp_quote_pre, termp_quote_post }, /* Ao */
179 { termp_quote_pre, termp_quote_post }, /* Aq */
180 { NULL, NULL }, /* At */
181 { NULL, NULL }, /* Bc */
182 { termp_bf_pre, NULL }, /* Bf */
183 { termp_quote_pre, termp_quote_post }, /* Bo */
184 { termp_quote_pre, termp_quote_post }, /* Bq */
185 { termp_xx_pre, NULL }, /* Bsx */
186 { termp_bx_pre, NULL }, /* Bx */
187 { NULL, NULL }, /* Db */
188 { NULL, NULL }, /* Dc */
189 { termp_quote_pre, termp_quote_post }, /* Do */
190 { termp_quote_pre, termp_quote_post }, /* Dq */
191 { NULL, NULL }, /* Ec */ /* FIXME: no space */
192 { NULL, NULL }, /* Ef */
193 { termp_under_pre, NULL }, /* Em */
194 { termp_quote_pre, termp_quote_post }, /* Eo */
195 { termp_xx_pre, NULL }, /* Fx */
196 { termp_bold_pre, NULL }, /* Ms */
197 { termp_igndelim_pre, NULL }, /* No */
198 { termp_ns_pre, NULL }, /* Ns */
199 { termp_xx_pre, NULL }, /* Nx */
200 { termp_xx_pre, NULL }, /* Ox */
201 { NULL, NULL }, /* Pc */
202 { termp_igndelim_pre, termp_pf_post }, /* Pf */
203 { termp_quote_pre, termp_quote_post }, /* Po */
204 { termp_quote_pre, termp_quote_post }, /* Pq */
205 { NULL, NULL }, /* Qc */
206 { termp_quote_pre, termp_quote_post }, /* Ql */
207 { termp_quote_pre, termp_quote_post }, /* Qo */
208 { termp_quote_pre, termp_quote_post }, /* Qq */
209 { NULL, NULL }, /* Re */
210 { termp_rs_pre, NULL }, /* Rs */
211 { NULL, NULL }, /* Sc */
212 { termp_quote_pre, termp_quote_post }, /* So */
213 { termp_quote_pre, termp_quote_post }, /* Sq */
214 { termp_sm_pre, NULL }, /* Sm */
215 { termp_under_pre, NULL }, /* Sx */
216 { termp_bold_pre, NULL }, /* Sy */
217 { NULL, NULL }, /* Tn */
218 { termp_xx_pre, NULL }, /* Ux */
219 { NULL, NULL }, /* Xc */
220 { NULL, NULL }, /* Xo */
221 { termp_fo_pre, termp_fo_post }, /* Fo */
222 { NULL, NULL }, /* Fc */
223 { termp_quote_pre, termp_quote_post }, /* Oo */
224 { NULL, NULL }, /* Oc */
225 { termp_bk_pre, termp_bk_post }, /* Bk */
226 { NULL, NULL }, /* Ek */
227 { termp_bt_pre, NULL }, /* Bt */
228 { NULL, NULL }, /* Hf */
229 { NULL, NULL }, /* Fr */
230 { termp_ud_pre, NULL }, /* Ud */
231 { NULL, termp_lb_post }, /* Lb */
232 { termp_sp_pre, NULL }, /* Lp */
233 { termp_lk_pre, NULL }, /* Lk */
234 { termp_under_pre, NULL }, /* Mt */
235 { termp_quote_pre, termp_quote_post }, /* Brq */
236 { termp_quote_pre, termp_quote_post }, /* Bro */
237 { NULL, NULL }, /* Brc */
238 { NULL, termp____post }, /* %C */
239 { NULL, NULL }, /* Es */ /* TODO */
240 { NULL, NULL }, /* En */ /* TODO */
241 { termp_xx_pre, NULL }, /* Dx */
242 { NULL, termp____post }, /* %Q */
243 { termp_sp_pre, NULL }, /* br */
244 { termp_sp_pre, NULL }, /* sp */
245 { termp_under_pre, termp____post }, /* %U */
246 { NULL, NULL }, /* Ta */
251 terminal_mdoc(void *arg, const struct mdoc *mdoc)
253 const struct mdoc_node *n;
254 const struct mdoc_meta *m;
257 p = (struct termp *)arg;
259 if (0 == p->defindent)
263 p->maxrmargin = p->defrmargin;
264 p->tabwidth = term_len(p, 5);
266 if (NULL == p->symtab)
267 p->symtab = mchars_alloc();
272 term_begin(p, print_mdoc_head, print_mdoc_foot, m);
275 print_mdoc_nodelist(p, NULL, m, n->child);
282 print_mdoc_nodelist(DECL_ARGS)
285 print_mdoc_node(p, pair, m, n);
287 print_mdoc_nodelist(p, pair, m, n->next);
293 print_mdoc_node(DECL_ARGS)
297 struct termpair npair;
298 size_t offset, rmargin;
302 rmargin = p->rmargin;
303 font = term_fontq(p);
305 memset(&npair, 0, sizeof(struct termpair));
309 * Keeps only work until the end of a line. If a keep was
310 * invoked in a prior line, revert it to PREKEEP.
312 * Also let SYNPRETTY sections behave as if they were wrapped
316 if (TERMP_KEEP & p->flags || MDOC_SYNPRETTY & n->flags) {
317 if (n->prev && n->prev->line != n->line) {
318 p->flags &= ~TERMP_KEEP;
319 p->flags |= TERMP_PREKEEP;
320 } else if (NULL == n->prev) {
321 if (n->parent && n->parent->line != n->line) {
322 p->flags &= ~TERMP_KEEP;
323 p->flags |= TERMP_PREKEEP;
329 * Since SYNPRETTY sections aren't "turned off" with `Ek',
330 * we have to intuit whether we should disable formatting.
333 if ( ! (MDOC_SYNPRETTY & n->flags) &&
334 ((n->prev && MDOC_SYNPRETTY & n->prev->flags) ||
335 (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
336 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
339 * After the keep flags have been set up, we may now
340 * produce output. Note that some pre-handlers do so.
345 if (' ' == *n->string && MDOC_LINE & n->flags)
347 if (MDOC_DELIMC & n->flags)
348 p->flags |= TERMP_NOSPACE;
349 term_word(p, n->string);
350 if (MDOC_DELIMO & n->flags)
351 p->flags |= TERMP_NOSPACE;
357 term_tbl(p, n->span);
360 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
361 chld = (*termacts[n->tok].pre)
366 if (chld && n->child)
367 print_mdoc_nodelist(p, &npair, m, n->child);
369 term_fontpopq(p, font);
379 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
381 (void)(*termacts[n->tok].post)(p, &npair, m, n);
384 * Explicit end tokens not only call the post
385 * handler, but also tell the respective block
386 * that it must not call the post handler again.
388 if (ENDBODY_NOT != n->end)
389 n->pending->flags |= MDOC_ENDED;
392 * End of line terminating an implicit block
393 * while an explicit block is still open.
394 * Continue the explicit block without spacing.
396 if (ENDBODY_NOSPACE == n->end)
397 p->flags |= TERMP_NOSPACE;
401 if (MDOC_EOS & n->flags)
402 p->flags |= TERMP_SENTENCE;
405 p->rmargin = rmargin;
410 print_mdoc_foot(struct termp *p, const void *arg)
412 const struct mdoc_meta *m;
414 m = (const struct mdoc_meta *)arg;
416 term_fontrepl(p, TERMFONT_NONE);
419 * Output the footer in new-groff style, that is, three columns
420 * with the middle being the manual date and flanking columns
421 * being the operating system:
429 p->rmargin = (p->maxrmargin -
430 term_strlen(p, m->date) + term_len(p, 1)) / 2;
431 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
436 p->offset = p->rmargin;
437 p->rmargin = p->maxrmargin - term_strlen(p, m->os);
438 p->flags |= TERMP_NOSPACE;
440 term_word(p, m->date);
443 p->offset = p->rmargin;
444 p->rmargin = p->maxrmargin;
445 p->flags &= ~TERMP_NOBREAK;
446 p->flags |= TERMP_NOSPACE;
452 p->rmargin = p->maxrmargin;
458 print_mdoc_head(struct termp *p, const void *arg)
460 char buf[BUFSIZ], title[BUFSIZ];
461 size_t buflen, titlen;
462 const struct mdoc_meta *m;
464 m = (const struct mdoc_meta *)arg;
467 * The header is strange. It has three components, which are
468 * really two with the first duplicated. It goes like this:
470 * IDENTIFIER TITLE IDENTIFIER
472 * The IDENTIFIER is NAME(SECTION), which is the command-name
473 * (if given, or "unknown" if not) followed by the manual page
474 * section. These are given in `Dt'. The TITLE is a free-form
475 * string depending on the manual volume. If not specified, it
476 * switches on the manual section.
480 p->rmargin = p->maxrmargin;
483 strlcpy(buf, m->vol, BUFSIZ);
484 buflen = term_strlen(p, buf);
487 strlcat(buf, " (", BUFSIZ);
488 strlcat(buf, m->arch, BUFSIZ);
489 strlcat(buf, ")", BUFSIZ);
492 snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
493 titlen = term_strlen(p, title);
495 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
497 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
499 term_strlen(p, buf) + term_len(p, 1)) / 2 :
500 p->maxrmargin - buflen;
505 p->flags |= TERMP_NOSPACE;
506 p->offset = p->rmargin;
507 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
508 p->maxrmargin - titlen : p->maxrmargin;
513 p->flags &= ~TERMP_NOBREAK;
514 if (p->rmargin + titlen <= p->maxrmargin) {
515 p->flags |= TERMP_NOSPACE;
516 p->offset = p->rmargin;
517 p->rmargin = p->maxrmargin;
522 p->flags &= ~TERMP_NOSPACE;
524 p->rmargin = p->maxrmargin;
529 a2height(const struct termp *p, const char *v)
535 if ( ! a2roffsu(v, &su, SCALE_VS))
536 SCALE_VS_INIT(&su, atoi(v));
538 return(term_vspan(p, &su));
543 a2width(const struct termp *p, const char *v)
548 if ( ! a2roffsu(v, &su, SCALE_MAX))
549 SCALE_HS_INIT(&su, term_strlen(p, v));
551 return(term_hspan(p, &su));
556 a2offs(const struct termp *p, const char *v)
562 else if (0 == strcmp(v, "left"))
564 else if (0 == strcmp(v, "indent"))
565 return(term_len(p, p->defindent + 1));
566 else if (0 == strcmp(v, "indent-two"))
567 return(term_len(p, (p->defindent + 1) * 2));
568 else if ( ! a2roffsu(v, &su, SCALE_MAX))
569 SCALE_HS_INIT(&su, term_strlen(p, v));
571 return(term_hspan(p, &su));
576 * Determine how much space to print out before block elements of `It'
577 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
581 print_bvspace(struct termp *p,
582 const struct mdoc_node *bl,
583 const struct mdoc_node *n)
585 const struct mdoc_node *nn;
591 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
593 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
596 /* Do not vspace directly after Ss/Sh. */
598 for (nn = n; nn; nn = nn->parent) {
599 if (MDOC_BLOCK != nn->type)
601 if (MDOC_Ss == nn->tok)
603 if (MDOC_Sh == nn->tok)
605 if (NULL == nn->prev)
610 /* A `-column' does not assert vspace within the list. */
612 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
613 if (n->prev && MDOC_It == n->prev->tok)
616 /* A `-diag' without body does not vspace. */
618 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
619 if (n->prev && MDOC_It == n->prev->tok) {
620 assert(n->prev->body);
621 if (NULL == n->prev->body->child)
631 termp_it_pre(DECL_ARGS)
633 const struct mdoc_node *bl, *nn;
636 size_t width, offset, ncols, dcol;
639 if (MDOC_BLOCK == n->type) {
640 print_bvspace(p, n->parent->parent, n);
644 bl = n->parent->parent->parent;
645 type = bl->norm->Bl.type;
648 * First calculate width and offset. This is pretty easy unless
649 * we're a -column list, in which case all prior columns must
655 if (bl->norm->Bl.offs)
656 offset = a2offs(p, bl->norm->Bl.offs);
660 if (MDOC_HEAD == n->type)
664 * Imitate groff's column handling:
665 * - For each earlier column, add its width.
666 * - For less than 5 columns, add four more blanks per
668 * - For exactly 5 columns, add three more blank per
670 * - For more than 5 columns, add only one column.
672 ncols = bl->norm->Bl.ncols;
675 dcol = ncols < 5 ? term_len(p, 4) :
676 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
679 * Calculate the offset by applying all prior MDOC_BODY,
680 * so we stop at the MDOC_HEAD (NULL == nn->prev).
683 for (i = 0, nn = n->prev;
684 nn->prev && i < (int)ncols;
686 offset += dcol + a2width
687 (p, bl->norm->Bl.cols[i]);
690 * When exceeding the declared number of columns, leave
691 * the remaining widths at 0. This will later be
692 * adjusted to the default width of 10, or, for the last
693 * column, stretched to the right margin.
699 * Use the declared column widths, extended as explained
700 * in the preceding paragraph.
702 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
705 if (NULL == bl->norm->Bl.width)
709 * Note: buffer the width by 2, which is groff's magic
710 * number for buffering single arguments. See the above
711 * handling for column for how this changes.
713 assert(bl->norm->Bl.width);
714 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
719 * List-type can override the width in the case of fixed-head
720 * values (bullet, dash/hyphen, enum). Tags need a non-zero
730 if (width < term_len(p, 4))
731 width = term_len(p, 4);
734 if (width < term_len(p, 5))
735 width = term_len(p, 5);
739 width = term_len(p, 8);
745 width = term_len(p, 10);
752 * Whitespace control. Inset bodies need an initial space,
753 * while diagonal bodies need two.
756 p->flags |= TERMP_NOSPACE;
760 if (MDOC_BODY == n->type)
761 term_word(p, "\\ \\ ");
764 if (MDOC_BODY == n->type)
771 p->flags |= TERMP_NOSPACE;
775 if (MDOC_HEAD == n->type)
776 term_fontpush(p, TERMFONT_BOLD);
783 * Pad and break control. This is the tricky part. These flags
784 * are documented in term_flushln() in term.c. Note that we're
785 * going to unset all of these flags in termp_it_post() when we
797 if (MDOC_HEAD == n->type)
798 p->flags |= TERMP_NOBREAK;
801 if (MDOC_HEAD == n->type)
802 p->flags |= TERMP_NOBREAK;
807 * This is ugly. If `-hang' is specified and the body
808 * is a `Bl' or `Bd', then we want basically to nullify
809 * the "overstep" effect in term_flushln() and treat
810 * this as a `-ohang' list instead.
812 if (n->next->child &&
813 (MDOC_Bl == n->next->child->tok ||
814 MDOC_Bd == n->next->child->tok))
815 p->flags &= ~TERMP_NOBREAK;
817 p->flags |= TERMP_HANG;
820 if (MDOC_HEAD == n->type)
821 p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
823 if (MDOC_HEAD != n->type)
825 if (NULL == n->next || NULL == n->next->child)
826 p->flags |= TERMP_DANGLE;
829 if (MDOC_HEAD == n->type)
833 p->flags &= ~TERMP_NOBREAK;
835 p->flags |= TERMP_NOBREAK;
839 if (MDOC_HEAD == n->type)
840 p->flags |= TERMP_NOBREAK;
847 * Margin control. Set-head-width lists have their right
848 * margins shortened. The body for these lists has the offset
849 * necessarily lengthened. Everybody gets the offset.
857 * Same stipulation as above, regarding `-hang'. We
858 * don't want to recalculate rmargin and offsets when
859 * using `Bd' or `Bl' within `-hang' overstep lists.
861 if (MDOC_HEAD == n->type && n->next->child &&
862 (MDOC_Bl == n->next->child->tok ||
863 MDOC_Bd == n->next->child->tok))
876 if (MDOC_HEAD == n->type)
877 p->rmargin = p->offset + width;
883 p->rmargin = p->offset + width;
885 * XXX - this behaviour is not documented: the
886 * right-most column is filled to the right margin.
888 if (MDOC_HEAD == n->type)
890 if (NULL == n->next && p->rmargin < p->maxrmargin)
891 p->rmargin = p->maxrmargin;
898 * The dash, hyphen, bullet and enum lists all have a special
899 * HEAD character (temporarily bold, in some cases).
902 if (MDOC_HEAD == n->type)
905 term_fontpush(p, TERMFONT_BOLD);
906 term_word(p, "\\[bu]");
912 term_fontpush(p, TERMFONT_BOLD);
913 term_word(p, "\\(hy");
917 (pair->ppair->ppair->count)++;
918 snprintf(buf, sizeof(buf), "%d.",
919 pair->ppair->ppair->count);
927 * If we're not going to process our children, indicate so here.
940 if (MDOC_HEAD == n->type)
944 if (MDOC_HEAD == n->type)
957 termp_it_post(DECL_ARGS)
961 if (MDOC_BLOCK == n->type)
964 type = n->parent->parent->parent->norm->Bl.type;
972 if (MDOC_BODY == n->type)
976 if (MDOC_BODY == n->type)
985 * Now that our output is flushed, we can reset our tags. Since
986 * only `It' sets these flags, we're free to assume that nobody
987 * has munged them in the meanwhile.
990 p->flags &= ~TERMP_DANGLE;
991 p->flags &= ~TERMP_NOBREAK;
992 p->flags &= ~TERMP_TWOSPACE;
993 p->flags &= ~TERMP_HANG;
999 termp_nm_pre(DECL_ARGS)
1002 if (MDOC_BLOCK == n->type)
1005 if (MDOC_BODY == n->type) {
1006 if (NULL == n->child)
1008 p->flags |= TERMP_NOSPACE;
1009 p->offset += term_len(p, 1) +
1010 (NULL == n->prev->child ? term_strlen(p, m->name) :
1011 MDOC_TEXT == n->prev->child->type ?
1012 term_strlen(p, n->prev->child->string) :
1017 if (NULL == n->child && NULL == m->name)
1020 if (MDOC_HEAD == n->type)
1021 synopsis_pre(p, n->parent);
1023 if (MDOC_HEAD == n->type && n->next->child) {
1024 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
1025 p->rmargin = p->offset + term_len(p, 1);
1026 if (NULL == n->child) {
1027 p->rmargin += term_strlen(p, m->name);
1028 } else if (MDOC_TEXT == n->child->type) {
1029 p->rmargin += term_strlen(p, n->child->string);
1031 p->flags |= TERMP_HANG;
1033 p->rmargin += term_len(p, 5);
1034 p->flags |= TERMP_HANG;
1038 term_fontpush(p, TERMFONT_BOLD);
1039 if (NULL == n->child)
1040 term_word(p, m->name);
1047 termp_nm_post(DECL_ARGS)
1050 if (MDOC_HEAD == n->type && n->next->child) {
1052 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1053 } else if (MDOC_BODY == n->type && n->child)
1060 termp_fl_pre(DECL_ARGS)
1063 term_fontpush(p, TERMFONT_BOLD);
1064 term_word(p, "\\-");
1067 p->flags |= TERMP_NOSPACE;
1068 else if (n->next && n->next->line == n->line)
1069 p->flags |= TERMP_NOSPACE;
1077 termp__a_pre(DECL_ARGS)
1080 if (n->prev && MDOC__A == n->prev->tok)
1081 if (NULL == n->next || MDOC__A != n->next->tok)
1082 term_word(p, "and");
1090 termp_an_pre(DECL_ARGS)
1093 if (NULL == n->child)
1097 * If not in the AUTHORS section, `An -split' will cause
1098 * newlines to occur before the author name. If in the AUTHORS
1099 * section, by default, the first `An' invocation is nosplit,
1100 * then all subsequent ones, regardless of whether interspersed
1101 * with other macros/text, are split. -split, in this case,
1102 * will override the condition of the implied first -nosplit.
1105 if (n->sec == SEC_AUTHORS) {
1106 if ( ! (TERMP_ANPREC & p->flags)) {
1107 if (TERMP_SPLIT & p->flags)
1111 if (TERMP_NOSPLIT & p->flags)
1117 if (TERMP_SPLIT & p->flags)
1126 termp_an_post(DECL_ARGS)
1130 if (SEC_AUTHORS == n->sec)
1131 p->flags |= TERMP_ANPREC;
1135 if (AUTH_split == n->norm->An.auth) {
1136 p->flags &= ~TERMP_NOSPLIT;
1137 p->flags |= TERMP_SPLIT;
1138 } else if (AUTH_nosplit == n->norm->An.auth) {
1139 p->flags &= ~TERMP_SPLIT;
1140 p->flags |= TERMP_NOSPLIT;
1148 termp_ns_pre(DECL_ARGS)
1151 if ( ! (MDOC_LINE & n->flags))
1152 p->flags |= TERMP_NOSPACE;
1159 termp_rs_pre(DECL_ARGS)
1162 if (SEC_SEE_ALSO != n->sec)
1164 if (MDOC_BLOCK == n->type && n->prev)
1172 termp_rv_pre(DECL_ARGS)
1177 term_word(p, "The");
1180 for (n = n->child; n; n = n->next) {
1181 term_fontpush(p, TERMFONT_BOLD);
1182 term_word(p, n->string);
1185 p->flags |= TERMP_NOSPACE;
1188 if (nchild > 2 && n->next) {
1189 p->flags |= TERMP_NOSPACE;
1193 if (n->next && NULL == n->next->next)
1194 term_word(p, "and");
1198 term_word(p, "functions return");
1200 term_word(p, "function returns");
1202 term_word(p, "the value 0 if successful; otherwise the value "
1203 "-1 is returned and the global variable");
1205 term_fontpush(p, TERMFONT_UNDER);
1206 term_word(p, "errno");
1209 term_word(p, "is set to indicate the error.");
1210 p->flags |= TERMP_SENTENCE;
1218 termp_ex_pre(DECL_ARGS)
1223 term_word(p, "The");
1226 for (n = n->child; n; n = n->next) {
1227 term_fontpush(p, TERMFONT_BOLD);
1228 term_word(p, n->string);
1231 if (nchild > 2 && n->next) {
1232 p->flags |= TERMP_NOSPACE;
1236 if (n->next && NULL == n->next->next)
1237 term_word(p, "and");
1241 term_word(p, "utilities exit");
1243 term_word(p, "utility exits");
1245 term_word(p, "0 on success, and >0 if an error occurs.");
1247 p->flags |= TERMP_SENTENCE;
1254 termp_nd_pre(DECL_ARGS)
1257 if (MDOC_BODY != n->type)
1260 #if defined(__OpenBSD__) || defined(__linux__)
1261 term_word(p, "\\(en");
1263 term_word(p, "\\(em");
1271 termp_bl_pre(DECL_ARGS)
1274 return(MDOC_HEAD != n->type);
1280 termp_bl_post(DECL_ARGS)
1283 if (MDOC_BLOCK == n->type)
1289 termp_xr_pre(DECL_ARGS)
1292 if (NULL == (n = n->child))
1295 assert(MDOC_TEXT == n->type);
1296 term_word(p, n->string);
1298 if (NULL == (n = n->next))
1301 p->flags |= TERMP_NOSPACE;
1303 p->flags |= TERMP_NOSPACE;
1305 assert(MDOC_TEXT == n->type);
1306 term_word(p, n->string);
1308 p->flags |= TERMP_NOSPACE;
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
1320 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1323 * Obviously, if we're not in a SYNOPSIS or no prior macros
1324 * exist, do nothing.
1326 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
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.
1334 if (n->prev->tok == n->tok &&
1335 MDOC_Ft != n->tok &&
1336 MDOC_Fo != n->tok &&
1337 MDOC_Fn != n->tok) {
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.
1347 switch (n->prev->tok) {
1360 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1373 termp_vt_pre(DECL_ARGS)
1376 if (MDOC_ELEM == n->type) {
1378 return(termp_under_pre(p, pair, m, n));
1379 } else if (MDOC_BLOCK == n->type) {
1382 } else if (MDOC_HEAD == n->type)
1385 return(termp_under_pre(p, pair, m, n));
1391 termp_bold_pre(DECL_ARGS)
1394 term_fontpush(p, TERMFONT_BOLD);
1401 termp_fd_pre(DECL_ARGS)
1405 return(termp_bold_pre(p, pair, m, n));
1411 termp_sh_pre(DECL_ARGS)
1414 /* No vspace between consecutive `Sh' calls. */
1418 if (n->prev && MDOC_Sh == n->prev->tok)
1419 if (NULL == n->prev->body->child)
1424 term_fontpush(p, TERMFONT_BOLD);
1427 p->offset = term_len(p, p->defindent);
1438 termp_sh_post(DECL_ARGS)
1457 termp_bt_pre(DECL_ARGS)
1460 term_word(p, "is currently in beta test.");
1461 p->flags |= TERMP_SENTENCE;
1468 termp_lb_post(DECL_ARGS)
1471 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1478 termp_ud_pre(DECL_ARGS)
1481 term_word(p, "currently under development.");
1482 p->flags |= TERMP_SENTENCE;
1489 termp_d1_pre(DECL_ARGS)
1492 if (MDOC_BLOCK != n->type)
1495 p->offset += term_len(p, p->defindent + 1);
1502 termp_d1_post(DECL_ARGS)
1505 if (MDOC_BLOCK != n->type)
1513 termp_ft_pre(DECL_ARGS)
1516 /* NB: MDOC_LINE does not effect this! */
1518 term_fontpush(p, TERMFONT_UNDER);
1525 termp_fn_pre(DECL_ARGS)
1529 pretty = MDOC_SYNPRETTY & n->flags;
1533 if (NULL == (n = n->child))
1536 assert(MDOC_TEXT == n->type);
1537 term_fontpush(p, TERMFONT_BOLD);
1538 term_word(p, n->string);
1541 p->flags |= TERMP_NOSPACE;
1543 p->flags |= TERMP_NOSPACE;
1545 for (n = n->next; n; n = n->next) {
1546 assert(MDOC_TEXT == n->type);
1547 term_fontpush(p, TERMFONT_UNDER);
1548 term_word(p, n->string);
1552 p->flags |= TERMP_NOSPACE;
1557 p->flags |= TERMP_NOSPACE;
1561 p->flags |= TERMP_NOSPACE;
1571 termp_fa_pre(DECL_ARGS)
1573 const struct mdoc_node *nn;
1575 if (n->parent->tok != MDOC_Fo) {
1576 term_fontpush(p, TERMFONT_UNDER);
1580 for (nn = n->child; nn; nn = nn->next) {
1581 term_fontpush(p, TERMFONT_UNDER);
1582 term_word(p, nn->string);
1586 p->flags |= TERMP_NOSPACE;
1591 if (n->child && n->next && n->next->tok == MDOC_Fa) {
1592 p->flags |= TERMP_NOSPACE;
1602 termp_bd_pre(DECL_ARGS)
1604 size_t tabwidth, rm, rmax;
1605 const struct mdoc_node *nn;
1607 if (MDOC_BLOCK == n->type) {
1608 print_bvspace(p, n, n);
1610 } else if (MDOC_HEAD == n->type)
1613 if (n->norm->Bd.offs)
1614 p->offset += a2offs(p, n->norm->Bd.offs);
1617 * If -ragged or -filled are specified, the block does nothing
1618 * but change the indentation. If -unfilled or -literal are
1619 * specified, text is printed exactly as entered in the display:
1620 * for macro lines, a newline is appended to the line. Blank
1621 * lines are allowed.
1624 if (DISP_literal != n->norm->Bd.type &&
1625 DISP_unfilled != n->norm->Bd.type)
1628 tabwidth = p->tabwidth;
1629 if (DISP_literal == n->norm->Bd.type)
1630 p->tabwidth = term_len(p, 8);
1633 rmax = p->maxrmargin;
1634 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1636 for (nn = n->child; nn; nn = nn->next) {
1637 print_mdoc_node(p, pair, m, nn);
1639 * If the printed node flushes its own line, then we
1640 * needn't do it here as well. This is hacky, but the
1641 * notion of selective eoln whitespace is pretty dumb
1642 * anyway, so don't sweat it.
1664 if (nn->next && nn->next->line == nn->line)
1667 p->flags |= TERMP_NOSPACE;
1670 p->tabwidth = tabwidth;
1672 p->maxrmargin = rmax;
1679 termp_bd_post(DECL_ARGS)
1683 if (MDOC_BODY != n->type)
1687 rmax = p->maxrmargin;
1689 if (DISP_literal == n->norm->Bd.type ||
1690 DISP_unfilled == n->norm->Bd.type)
1691 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1693 p->flags |= TERMP_NOSPACE;
1697 p->maxrmargin = rmax;
1703 termp_bx_pre(DECL_ARGS)
1706 if (NULL != (n = n->child)) {
1707 term_word(p, n->string);
1708 p->flags |= TERMP_NOSPACE;
1709 term_word(p, "BSD");
1711 term_word(p, "BSD");
1715 if (NULL != (n = n->next)) {
1716 p->flags |= TERMP_NOSPACE;
1718 p->flags |= TERMP_NOSPACE;
1719 term_word(p, n->string);
1728 termp_xx_pre(DECL_ARGS)
1760 p->flags |= TERMP_KEEP;
1761 term_word(p, n->child->string);
1770 termp_igndelim_pre(DECL_ARGS)
1773 p->flags |= TERMP_IGNDELIM;
1780 termp_pf_post(DECL_ARGS)
1783 p->flags |= TERMP_NOSPACE;
1789 termp_ss_pre(DECL_ARGS)
1799 term_fontpush(p, TERMFONT_BOLD);
1800 p->offset = term_len(p, (p->defindent+1)/2);
1812 termp_ss_post(DECL_ARGS)
1815 if (MDOC_HEAD == n->type)
1822 termp_cd_pre(DECL_ARGS)
1826 term_fontpush(p, TERMFONT_BOLD);
1833 termp_in_pre(DECL_ARGS)
1838 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1839 term_fontpush(p, TERMFONT_BOLD);
1840 term_word(p, "#include");
1844 term_fontpush(p, TERMFONT_UNDER);
1847 p->flags |= TERMP_NOSPACE;
1854 termp_in_post(DECL_ARGS)
1857 if (MDOC_SYNPRETTY & n->flags)
1858 term_fontpush(p, TERMFONT_BOLD);
1860 p->flags |= TERMP_NOSPACE;
1863 if (MDOC_SYNPRETTY & n->flags)
1870 termp_sp_pre(DECL_ARGS)
1876 len = n->child ? a2height(p, n->child->string) : 1;
1888 for (i = 0; i < len; i++)
1897 termp_quote_pre(DECL_ARGS)
1900 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1954 p->flags |= TERMP_NOSPACE;
1961 termp_quote_post(DECL_ARGS)
1964 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1967 p->flags |= TERMP_NOSPACE;
2024 termp_fo_pre(DECL_ARGS)
2027 if (MDOC_BLOCK == n->type) {
2030 } else if (MDOC_BODY == n->type) {
2031 p->flags |= TERMP_NOSPACE;
2033 p->flags |= TERMP_NOSPACE;
2037 if (NULL == n->child)
2040 /* XXX: we drop non-initial arguments as per groff. */
2042 assert(n->child->string);
2043 term_fontpush(p, TERMFONT_BOLD);
2044 term_word(p, n->child->string);
2051 termp_fo_post(DECL_ARGS)
2054 if (MDOC_BODY != n->type)
2057 p->flags |= TERMP_NOSPACE;
2060 if (MDOC_SYNPRETTY & n->flags) {
2061 p->flags |= TERMP_NOSPACE;
2069 termp_bf_pre(DECL_ARGS)
2072 if (MDOC_HEAD == n->type)
2074 else if (MDOC_BLOCK != n->type)
2077 if (FONT_Em == n->norm->Bf.font)
2078 term_fontpush(p, TERMFONT_UNDER);
2079 else if (FONT_Sy == n->norm->Bf.font)
2080 term_fontpush(p, TERMFONT_BOLD);
2082 term_fontpush(p, TERMFONT_NONE);
2090 termp_sm_pre(DECL_ARGS)
2093 assert(n->child && MDOC_TEXT == n->child->type);
2094 if (0 == strcmp("on", n->child->string)) {
2096 p->flags &= ~TERMP_NOSPACE;
2097 p->flags &= ~TERMP_NONOSPACE;
2099 p->flags |= TERMP_NONOSPACE;
2107 termp_ap_pre(DECL_ARGS)
2110 p->flags |= TERMP_NOSPACE;
2112 p->flags |= TERMP_NOSPACE;
2119 termp____post(DECL_ARGS)
2123 * Handle lists of authors. In general, print each followed by
2124 * a comma. Don't print the comma if there are only two
2127 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2128 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2129 if (NULL == n->prev || MDOC__A != n->prev->tok)
2134 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2137 p->flags |= TERMP_NOSPACE;
2138 if (NULL == n->next) {
2140 p->flags |= TERMP_SENTENCE;
2148 termp_li_pre(DECL_ARGS)
2151 term_fontpush(p, TERMFONT_NONE);
2158 termp_lk_pre(DECL_ARGS)
2160 const struct mdoc_node *nn, *sv;
2162 term_fontpush(p, TERMFONT_UNDER);
2166 if (NULL == nn || NULL == nn->next)
2169 for (nn = nn->next; nn; nn = nn->next)
2170 term_word(p, nn->string);
2174 p->flags |= TERMP_NOSPACE;
2177 term_fontpush(p, TERMFONT_BOLD);
2178 term_word(p, sv->string);
2187 termp_bk_pre(DECL_ARGS)
2196 if (n->parent->args || 0 == n->prev->nchild)
2197 p->flags |= TERMP_PREKEEP;
2210 termp_bk_post(DECL_ARGS)
2213 if (MDOC_BODY == n->type)
2214 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2219 termp__t_post(DECL_ARGS)
2223 * If we're in an `Rs' and there's a journal present, then quote
2224 * us instead of underlining us (for disambiguation).
2226 if (n->parent && MDOC_Rs == n->parent->tok &&
2227 n->parent->norm->Rs.quote_T)
2228 termp_quote_post(p, pair, m, n);
2230 termp____post(p, pair, m, n);
2235 termp__t_pre(DECL_ARGS)
2239 * If we're in an `Rs' and there's a journal present, then quote
2240 * us instead of underlining us (for disambiguation).
2242 if (n->parent && MDOC_Rs == n->parent->tok &&
2243 n->parent->norm->Rs.quote_T)
2244 return(termp_quote_pre(p, pair, m, n));
2246 term_fontpush(p, TERMFONT_UNDER);
2252 termp_under_pre(DECL_ARGS)
2255 term_fontpush(p, TERMFONT_UNDER);