1 /* $Id: mdoc_term.c,v 1.226 2011/04/04 16:27:03 kristaps 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>
41 struct termpair *ppair;
45 #define DECL_ARGS struct termp *p, \
46 struct termpair *pair, \
47 const struct mdoc_meta *m, \
48 const struct mdoc_node *n
51 int (*pre)(DECL_ARGS);
52 void (*post)(DECL_ARGS);
55 static size_t a2width(const struct termp *, const char *);
56 static size_t a2height(const struct termp *, const char *);
57 static size_t a2offs(const struct termp *, const char *);
59 static void print_bvspace(struct termp *,
60 const struct mdoc_node *,
61 const struct mdoc_node *);
62 static void print_mdoc_node(DECL_ARGS);
63 static void print_mdoc_nodelist(DECL_ARGS);
64 static void print_mdoc_head(struct termp *, const void *);
65 static void print_mdoc_foot(struct termp *, const void *);
66 static void synopsis_pre(struct termp *,
67 const struct mdoc_node *);
69 static void termp____post(DECL_ARGS);
70 static void termp__t_post(DECL_ARGS);
71 static void termp_an_post(DECL_ARGS);
72 static void termp_bd_post(DECL_ARGS);
73 static void termp_bk_post(DECL_ARGS);
74 static void termp_bl_post(DECL_ARGS);
75 static void termp_d1_post(DECL_ARGS);
76 static void termp_fo_post(DECL_ARGS);
77 static void termp_in_post(DECL_ARGS);
78 static void termp_it_post(DECL_ARGS);
79 static void termp_lb_post(DECL_ARGS);
80 static void termp_nm_post(DECL_ARGS);
81 static void termp_pf_post(DECL_ARGS);
82 static void termp_quote_post(DECL_ARGS);
83 static void termp_sh_post(DECL_ARGS);
84 static void termp_ss_post(DECL_ARGS);
86 static int termp__a_pre(DECL_ARGS);
87 static int termp__t_pre(DECL_ARGS);
88 static int termp_an_pre(DECL_ARGS);
89 static int termp_ap_pre(DECL_ARGS);
90 static int termp_bd_pre(DECL_ARGS);
91 static int termp_bf_pre(DECL_ARGS);
92 static int termp_bk_pre(DECL_ARGS);
93 static int termp_bl_pre(DECL_ARGS);
94 static int termp_bold_pre(DECL_ARGS);
95 static int termp_bt_pre(DECL_ARGS);
96 static int termp_bx_pre(DECL_ARGS);
97 static int termp_cd_pre(DECL_ARGS);
98 static int termp_d1_pre(DECL_ARGS);
99 static int termp_ex_pre(DECL_ARGS);
100 static int termp_fa_pre(DECL_ARGS);
101 static int termp_fd_pre(DECL_ARGS);
102 static int termp_fl_pre(DECL_ARGS);
103 static int termp_fn_pre(DECL_ARGS);
104 static int termp_fo_pre(DECL_ARGS);
105 static int termp_ft_pre(DECL_ARGS);
106 static int termp_igndelim_pre(DECL_ARGS);
107 static int termp_in_pre(DECL_ARGS);
108 static int termp_it_pre(DECL_ARGS);
109 static int termp_li_pre(DECL_ARGS);
110 static int termp_lk_pre(DECL_ARGS);
111 static int termp_nd_pre(DECL_ARGS);
112 static int termp_nm_pre(DECL_ARGS);
113 static int termp_ns_pre(DECL_ARGS);
114 static int termp_quote_pre(DECL_ARGS);
115 static int termp_rs_pre(DECL_ARGS);
116 static int termp_rv_pre(DECL_ARGS);
117 static int termp_sh_pre(DECL_ARGS);
118 static int termp_sm_pre(DECL_ARGS);
119 static int termp_sp_pre(DECL_ARGS);
120 static int termp_ss_pre(DECL_ARGS);
121 static int termp_under_pre(DECL_ARGS);
122 static int termp_ud_pre(DECL_ARGS);
123 static int termp_vt_pre(DECL_ARGS);
124 static int termp_xr_pre(DECL_ARGS);
125 static int termp_xx_pre(DECL_ARGS);
127 static const struct termact termacts[MDOC_MAX] = {
128 { termp_ap_pre, NULL }, /* Ap */
129 { NULL, NULL }, /* Dd */
130 { NULL, NULL }, /* Dt */
131 { NULL, NULL }, /* Os */
132 { termp_sh_pre, termp_sh_post }, /* Sh */
133 { termp_ss_pre, termp_ss_post }, /* Ss */
134 { termp_sp_pre, NULL }, /* Pp */
135 { termp_d1_pre, termp_d1_post }, /* D1 */
136 { termp_d1_pre, termp_d1_post }, /* Dl */
137 { termp_bd_pre, termp_bd_post }, /* Bd */
138 { NULL, NULL }, /* Ed */
139 { termp_bl_pre, termp_bl_post }, /* Bl */
140 { NULL, NULL }, /* El */
141 { termp_it_pre, termp_it_post }, /* It */
142 { termp_under_pre, NULL }, /* Ad */
143 { termp_an_pre, termp_an_post }, /* An */
144 { termp_under_pre, NULL }, /* Ar */
145 { termp_cd_pre, NULL }, /* Cd */
146 { termp_bold_pre, NULL }, /* Cm */
147 { NULL, NULL }, /* Dv */
148 { NULL, NULL }, /* Er */
149 { NULL, NULL }, /* Ev */
150 { termp_ex_pre, NULL }, /* Ex */
151 { termp_fa_pre, NULL }, /* Fa */
152 { termp_fd_pre, NULL }, /* Fd */
153 { termp_fl_pre, NULL }, /* Fl */
154 { termp_fn_pre, NULL }, /* Fn */
155 { termp_ft_pre, NULL }, /* Ft */
156 { termp_bold_pre, NULL }, /* Ic */
157 { termp_in_pre, termp_in_post }, /* In */
158 { termp_li_pre, NULL }, /* Li */
159 { termp_nd_pre, NULL }, /* Nd */
160 { termp_nm_pre, termp_nm_post }, /* Nm */
161 { termp_quote_pre, termp_quote_post }, /* Op */
162 { NULL, NULL }, /* Ot */
163 { termp_under_pre, NULL }, /* Pa */
164 { termp_rv_pre, NULL }, /* Rv */
165 { NULL, NULL }, /* St */
166 { termp_under_pre, NULL }, /* Va */
167 { termp_vt_pre, NULL }, /* Vt */
168 { termp_xr_pre, NULL }, /* Xr */
169 { termp__a_pre, termp____post }, /* %A */
170 { termp_under_pre, termp____post }, /* %B */
171 { NULL, termp____post }, /* %D */
172 { termp_under_pre, termp____post }, /* %I */
173 { termp_under_pre, termp____post }, /* %J */
174 { NULL, termp____post }, /* %N */
175 { NULL, termp____post }, /* %O */
176 { NULL, termp____post }, /* %P */
177 { NULL, termp____post }, /* %R */
178 { termp__t_pre, termp__t_post }, /* %T */
179 { NULL, termp____post }, /* %V */
180 { NULL, NULL }, /* Ac */
181 { termp_quote_pre, termp_quote_post }, /* Ao */
182 { termp_quote_pre, termp_quote_post }, /* Aq */
183 { NULL, NULL }, /* At */
184 { NULL, NULL }, /* Bc */
185 { termp_bf_pre, NULL }, /* Bf */
186 { termp_quote_pre, termp_quote_post }, /* Bo */
187 { termp_quote_pre, termp_quote_post }, /* Bq */
188 { termp_xx_pre, NULL }, /* Bsx */
189 { termp_bx_pre, NULL }, /* Bx */
190 { NULL, NULL }, /* Db */
191 { NULL, NULL }, /* Dc */
192 { termp_quote_pre, termp_quote_post }, /* Do */
193 { termp_quote_pre, termp_quote_post }, /* Dq */
194 { NULL, NULL }, /* Ec */ /* FIXME: no space */
195 { NULL, NULL }, /* Ef */
196 { termp_under_pre, NULL }, /* Em */
197 { NULL, NULL }, /* Eo */
198 { termp_xx_pre, NULL }, /* Fx */
199 { termp_bold_pre, NULL }, /* Ms */
200 { termp_igndelim_pre, NULL }, /* No */
201 { termp_ns_pre, NULL }, /* Ns */
202 { termp_xx_pre, NULL }, /* Nx */
203 { termp_xx_pre, NULL }, /* Ox */
204 { NULL, NULL }, /* Pc */
205 { termp_igndelim_pre, termp_pf_post }, /* Pf */
206 { termp_quote_pre, termp_quote_post }, /* Po */
207 { termp_quote_pre, termp_quote_post }, /* Pq */
208 { NULL, NULL }, /* Qc */
209 { termp_quote_pre, termp_quote_post }, /* Ql */
210 { termp_quote_pre, termp_quote_post }, /* Qo */
211 { termp_quote_pre, termp_quote_post }, /* Qq */
212 { NULL, NULL }, /* Re */
213 { termp_rs_pre, NULL }, /* Rs */
214 { NULL, NULL }, /* Sc */
215 { termp_quote_pre, termp_quote_post }, /* So */
216 { termp_quote_pre, termp_quote_post }, /* Sq */
217 { termp_sm_pre, NULL }, /* Sm */
218 { termp_under_pre, NULL }, /* Sx */
219 { termp_bold_pre, NULL }, /* Sy */
220 { NULL, NULL }, /* Tn */
221 { termp_xx_pre, NULL }, /* Ux */
222 { NULL, NULL }, /* Xc */
223 { NULL, NULL }, /* Xo */
224 { termp_fo_pre, termp_fo_post }, /* Fo */
225 { NULL, NULL }, /* Fc */
226 { termp_quote_pre, termp_quote_post }, /* Oo */
227 { NULL, NULL }, /* Oc */
228 { termp_bk_pre, termp_bk_post }, /* Bk */
229 { NULL, NULL }, /* Ek */
230 { termp_bt_pre, NULL }, /* Bt */
231 { NULL, NULL }, /* Hf */
232 { NULL, NULL }, /* Fr */
233 { termp_ud_pre, NULL }, /* Ud */
234 { NULL, termp_lb_post }, /* Lb */
235 { termp_sp_pre, NULL }, /* Lp */
236 { termp_lk_pre, NULL }, /* Lk */
237 { termp_under_pre, NULL }, /* Mt */
238 { termp_quote_pre, termp_quote_post }, /* Brq */
239 { termp_quote_pre, termp_quote_post }, /* Bro */
240 { NULL, NULL }, /* Brc */
241 { NULL, termp____post }, /* %C */
242 { NULL, NULL }, /* Es */ /* TODO */
243 { NULL, NULL }, /* En */ /* TODO */
244 { termp_xx_pre, NULL }, /* Dx */
245 { NULL, termp____post }, /* %Q */
246 { termp_sp_pre, NULL }, /* br */
247 { termp_sp_pre, NULL }, /* sp */
248 { termp_under_pre, termp____post }, /* %U */
249 { NULL, NULL }, /* Ta */
254 terminal_mdoc(void *arg, const struct mdoc *mdoc)
256 const struct mdoc_node *n;
257 const struct mdoc_meta *m;
260 p = (struct termp *)arg;
263 p->maxrmargin = p->defrmargin;
264 p->tabwidth = term_len(p, 5);
266 if (NULL == p->symtab)
268 case (TERMENC_ASCII):
269 p->symtab = chars_init(CHARS_ASCII);
279 term_begin(p, print_mdoc_head, print_mdoc_foot, m);
282 print_mdoc_nodelist(p, NULL, m, n->child);
289 print_mdoc_nodelist(DECL_ARGS)
292 print_mdoc_node(p, pair, m, n);
294 print_mdoc_nodelist(p, pair, m, n->next);
300 print_mdoc_node(DECL_ARGS)
304 struct termpair npair;
305 size_t offset, rmargin;
309 rmargin = p->rmargin;
310 font = term_fontq(p);
312 memset(&npair, 0, sizeof(struct termpair));
316 * Keeps only work until the end of a line. If a keep was
317 * invoked in a prior line, revert it to PREKEEP.
319 * Also let SYNPRETTY sections behave as if they were wrapped
323 if (TERMP_KEEP & p->flags || MDOC_SYNPRETTY & n->flags) {
324 if (n->prev && n->prev->line != n->line) {
325 p->flags &= ~TERMP_KEEP;
326 p->flags |= TERMP_PREKEEP;
327 } else if (NULL == n->prev) {
328 if (n->parent && n->parent->line != n->line) {
329 p->flags &= ~TERMP_KEEP;
330 p->flags |= TERMP_PREKEEP;
336 * Since SYNPRETTY sections aren't "turned off" with `Ek',
337 * we have to intuit whether we should disable formatting.
340 if ( ! (MDOC_SYNPRETTY & n->flags) &&
341 ((n->prev && MDOC_SYNPRETTY & n->prev->flags) ||
342 (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
343 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
346 * After the keep flags have been set up, we may now
347 * produce output. Note that some pre-handlers do so.
352 if (' ' == *n->string && MDOC_LINE & n->flags)
354 if (MDOC_DELIMC & n->flags)
355 p->flags |= TERMP_NOSPACE;
356 term_word(p, n->string);
357 if (MDOC_DELIMO & n->flags)
358 p->flags |= TERMP_NOSPACE;
361 term_word(p, n->eqn->data);
364 term_tbl(p, n->span);
367 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
368 chld = (*termacts[n->tok].pre)
373 if (chld && n->child)
374 print_mdoc_nodelist(p, &npair, m, n->child);
376 term_fontpopq(p, font);
386 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
388 (void)(*termacts[n->tok].post)(p, &npair, m, n);
391 * Explicit end tokens not only call the post
392 * handler, but also tell the respective block
393 * that it must not call the post handler again.
395 if (ENDBODY_NOT != n->end)
396 n->pending->flags |= MDOC_ENDED;
399 * End of line terminating an implicit block
400 * while an explicit block is still open.
401 * Continue the explicit block without spacing.
403 if (ENDBODY_NOSPACE == n->end)
404 p->flags |= TERMP_NOSPACE;
408 if (MDOC_EOS & n->flags)
409 p->flags |= TERMP_SENTENCE;
412 p->rmargin = rmargin;
417 print_mdoc_foot(struct termp *p, const void *arg)
419 const struct mdoc_meta *m;
421 m = (const struct mdoc_meta *)arg;
423 term_fontrepl(p, TERMFONT_NONE);
426 * Output the footer in new-groff style, that is, three columns
427 * with the middle being the manual date and flanking columns
428 * being the operating system:
436 p->rmargin = (p->maxrmargin -
437 term_strlen(p, m->date) + term_len(p, 1)) / 2;
438 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
443 p->offset = p->rmargin;
444 p->rmargin = p->maxrmargin - term_strlen(p, m->os);
445 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
447 term_word(p, m->date);
450 p->offset = p->rmargin;
451 p->rmargin = p->maxrmargin;
452 p->flags &= ~TERMP_NOBREAK;
453 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
459 p->rmargin = p->maxrmargin;
465 print_mdoc_head(struct termp *p, const void *arg)
467 char buf[BUFSIZ], title[BUFSIZ];
468 const struct mdoc_meta *m;
470 m = (const struct mdoc_meta *)arg;
472 p->rmargin = p->maxrmargin;
476 * The header is strange. It has three components, which are
477 * really two with the first duplicated. It goes like this:
479 * IDENTIFIER TITLE IDENTIFIER
481 * The IDENTIFIER is NAME(SECTION), which is the command-name
482 * (if given, or "unknown" if not) followed by the manual page
483 * section. These are given in `Dt'. The TITLE is a free-form
484 * string depending on the manual volume. If not specified, it
485 * switches on the manual section.
489 strlcpy(buf, m->vol, BUFSIZ);
492 strlcat(buf, " (", BUFSIZ);
493 strlcat(buf, m->arch, BUFSIZ);
494 strlcat(buf, ")", BUFSIZ);
497 snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
500 p->rmargin = (p->maxrmargin -
501 term_strlen(p, buf) + term_len(p, 1)) / 2;
502 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
507 p->offset = p->rmargin;
508 p->rmargin = p->maxrmargin - term_strlen(p, title);
509 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
514 p->offset = p->rmargin;
515 p->rmargin = p->maxrmargin;
516 p->flags &= ~TERMP_NOBREAK;
517 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
523 p->rmargin = p->maxrmargin;
524 p->flags &= ~TERMP_NOSPACE;
529 a2height(const struct termp *p, const char *v)
534 if ( ! a2roffsu(v, &su, SCALE_VS))
535 SCALE_VS_INIT(&su, term_len(p, 1));
537 return(term_vspan(p, &su));
542 a2width(const struct termp *p, const char *v)
547 if ( ! a2roffsu(v, &su, SCALE_MAX))
548 SCALE_HS_INIT(&su, term_strlen(p, v));
550 return(term_hspan(p, &su));
555 a2offs(const struct termp *p, const char *v)
561 else if (0 == strcmp(v, "left"))
563 else if (0 == strcmp(v, "indent"))
564 return(term_len(p, INDENT + 1));
565 else if (0 == strcmp(v, "indent-two"))
566 return(term_len(p, (INDENT + 1) * 2));
567 else if ( ! a2roffsu(v, &su, SCALE_MAX))
568 SCALE_HS_INIT(&su, term_strlen(p, v));
570 return(term_hspan(p, &su));
575 * Determine how much space to print out before block elements of `It'
576 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
580 print_bvspace(struct termp *p,
581 const struct mdoc_node *bl,
582 const struct mdoc_node *n)
584 const struct mdoc_node *nn;
588 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
590 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
593 /* Do not vspace directly after Ss/Sh. */
595 for (nn = n; nn; nn = nn->parent) {
596 if (MDOC_BLOCK != nn->type)
598 if (MDOC_Ss == nn->tok)
600 if (MDOC_Sh == nn->tok)
602 if (NULL == nn->prev)
607 /* A `-column' does not assert vspace within the list. */
609 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
610 if (n->prev && MDOC_It == n->prev->tok)
613 /* A `-diag' without body does not vspace. */
615 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
616 if (n->prev && MDOC_It == n->prev->tok) {
617 assert(n->prev->body);
618 if (NULL == n->prev->body->child)
628 termp_it_pre(DECL_ARGS)
630 const struct mdoc_node *bl, *nn;
633 size_t width, offset, ncols, dcol;
636 if (MDOC_BLOCK == n->type) {
637 print_bvspace(p, n->parent->parent, n);
641 bl = n->parent->parent->parent;
642 type = bl->norm->Bl.type;
645 * First calculate width and offset. This is pretty easy unless
646 * we're a -column list, in which case all prior columns must
652 if (bl->norm->Bl.offs)
653 offset = a2offs(p, bl->norm->Bl.offs);
657 if (MDOC_HEAD == n->type)
661 * Imitate groff's column handling:
662 * - For each earlier column, add its width.
663 * - For less than 5 columns, add four more blanks per
665 * - For exactly 5 columns, add three more blank per
667 * - For more than 5 columns, add only one column.
669 ncols = bl->norm->Bl.ncols;
672 dcol = ncols < 5 ? term_len(p, 4) :
673 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
676 * Calculate the offset by applying all prior MDOC_BODY,
677 * so we stop at the MDOC_HEAD (NULL == nn->prev).
680 for (i = 0, nn = n->prev;
681 nn->prev && i < (int)ncols;
683 offset += dcol + a2width
684 (p, bl->norm->Bl.cols[i]);
687 * When exceeding the declared number of columns, leave
688 * the remaining widths at 0. This will later be
689 * adjusted to the default width of 10, or, for the last
690 * column, stretched to the right margin.
696 * Use the declared column widths, extended as explained
697 * in the preceding paragraph.
699 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
702 if (NULL == bl->norm->Bl.width)
706 * Note: buffer the width by 2, which is groff's magic
707 * number for buffering single arguments. See the above
708 * handling for column for how this changes.
710 assert(bl->norm->Bl.width);
711 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
716 * List-type can override the width in the case of fixed-head
717 * values (bullet, dash/hyphen, enum). Tags need a non-zero
727 if (width < term_len(p, 4))
728 width = term_len(p, 4);
731 if (width < term_len(p, 5))
732 width = term_len(p, 5);
736 width = term_len(p, 8);
742 width = term_len(p, 10);
749 * Whitespace control. Inset bodies need an initial space,
750 * while diagonal bodies need two.
753 p->flags |= TERMP_NOSPACE;
757 if (MDOC_BODY == n->type)
758 term_word(p, "\\ \\ ");
761 if (MDOC_BODY == n->type)
768 p->flags |= TERMP_NOSPACE;
772 if (MDOC_HEAD == n->type)
773 term_fontpush(p, TERMFONT_BOLD);
780 * Pad and break control. This is the tricky part. These flags
781 * are documented in term_flushln() in term.c. Note that we're
782 * going to unset all of these flags in termp_it_post() when we
794 if (MDOC_HEAD == n->type)
795 p->flags |= TERMP_NOBREAK;
797 p->flags |= TERMP_NOLPAD;
800 if (MDOC_HEAD == n->type)
801 p->flags |= TERMP_NOBREAK;
803 p->flags |= TERMP_NOLPAD;
805 if (MDOC_HEAD != n->type)
809 * This is ugly. If `-hang' is specified and the body
810 * is a `Bl' or `Bd', then we want basically to nullify
811 * the "overstep" effect in term_flushln() and treat
812 * this as a `-ohang' list instead.
814 if (n->next->child &&
815 (MDOC_Bl == n->next->child->tok ||
816 MDOC_Bd == n->next->child->tok)) {
817 p->flags &= ~TERMP_NOBREAK;
818 p->flags &= ~TERMP_NOLPAD;
820 p->flags |= TERMP_HANG;
823 if (MDOC_HEAD == n->type)
824 p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
826 p->flags |= TERMP_NOLPAD;
828 if (MDOC_HEAD != n->type)
830 if (NULL == n->next || NULL == n->next->child)
831 p->flags |= TERMP_DANGLE;
834 if (MDOC_HEAD == n->type)
838 p->flags &= ~TERMP_NOBREAK;
840 p->flags |= TERMP_NOBREAK;
843 if (MDOC_BODY == n->prev->type)
844 p->flags |= TERMP_NOLPAD;
848 if (MDOC_HEAD == n->type)
849 p->flags |= TERMP_NOBREAK;
856 * Margin control. Set-head-width lists have their right
857 * margins shortened. The body for these lists has the offset
858 * necessarily lengthened. Everybody gets the offset.
866 * Same stipulation as above, regarding `-hang'. We
867 * don't want to recalculate rmargin and offsets when
868 * using `Bd' or `Bl' within `-hang' overstep lists.
870 if (MDOC_HEAD == n->type && n->next->child &&
871 (MDOC_Bl == n->next->child->tok ||
872 MDOC_Bd == n->next->child->tok))
885 if (MDOC_HEAD == n->type)
886 p->rmargin = p->offset + width;
892 p->rmargin = p->offset + width;
894 * XXX - this behaviour is not documented: the
895 * right-most column is filled to the right margin.
897 if (MDOC_HEAD == n->type)
899 if (NULL == n->next && p->rmargin < p->maxrmargin)
900 p->rmargin = p->maxrmargin;
907 * The dash, hyphen, bullet and enum lists all have a special
908 * HEAD character (temporarily bold, in some cases).
911 if (MDOC_HEAD == n->type)
914 term_fontpush(p, TERMFONT_BOLD);
915 term_word(p, "\\[bu]");
921 term_fontpush(p, TERMFONT_BOLD);
922 term_word(p, "\\(hy");
926 (pair->ppair->ppair->count)++;
927 snprintf(buf, sizeof(buf), "%d.",
928 pair->ppair->ppair->count);
936 * If we're not going to process our children, indicate so here.
949 if (MDOC_HEAD == n->type)
953 if (MDOC_HEAD == n->type)
966 termp_it_post(DECL_ARGS)
970 if (MDOC_BLOCK == n->type)
973 type = n->parent->parent->parent->norm->Bl.type;
981 if (MDOC_BODY == n->type)
985 if (MDOC_BODY == n->type)
994 * Now that our output is flushed, we can reset our tags. Since
995 * only `It' sets these flags, we're free to assume that nobody
996 * has munged them in the meanwhile.
999 p->flags &= ~TERMP_DANGLE;
1000 p->flags &= ~TERMP_NOBREAK;
1001 p->flags &= ~TERMP_TWOSPACE;
1002 p->flags &= ~TERMP_NOLPAD;
1003 p->flags &= ~TERMP_HANG;
1009 termp_nm_pre(DECL_ARGS)
1012 if (MDOC_BLOCK == n->type)
1015 if (MDOC_BODY == n->type) {
1016 if (NULL == n->child)
1018 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1019 p->offset += term_len(p, 1) +
1020 (NULL == n->prev->child ? term_strlen(p, m->name) :
1021 MDOC_TEXT == n->prev->child->type ?
1022 term_strlen(p, n->prev->child->string) :
1027 if (NULL == n->child && NULL == m->name)
1030 if (MDOC_HEAD == n->type)
1031 synopsis_pre(p, n->parent);
1033 if (MDOC_HEAD == n->type && n->next->child) {
1034 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
1035 p->rmargin = p->offset + term_len(p, 1);
1036 if (NULL == n->child) {
1037 p->rmargin += term_strlen(p, m->name);
1038 } else if (MDOC_TEXT == n->child->type) {
1039 p->rmargin += term_strlen(p, n->child->string);
1041 p->flags |= TERMP_HANG;
1043 p->rmargin += term_len(p, 5);
1044 p->flags |= TERMP_HANG;
1048 term_fontpush(p, TERMFONT_BOLD);
1049 if (NULL == n->child)
1050 term_word(p, m->name);
1057 termp_nm_post(DECL_ARGS)
1060 if (MDOC_HEAD == n->type && n->next->child) {
1062 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1063 } else if (MDOC_BODY == n->type && n->child) {
1065 p->flags &= ~TERMP_NOLPAD;
1072 termp_fl_pre(DECL_ARGS)
1075 term_fontpush(p, TERMFONT_BOLD);
1076 term_word(p, "\\-");
1079 p->flags |= TERMP_NOSPACE;
1080 else if (n->next && n->next->line == n->line)
1081 p->flags |= TERMP_NOSPACE;
1089 termp__a_pre(DECL_ARGS)
1092 if (n->prev && MDOC__A == n->prev->tok)
1093 if (NULL == n->next || MDOC__A != n->next->tok)
1094 term_word(p, "and");
1102 termp_an_pre(DECL_ARGS)
1105 if (NULL == n->child)
1109 * If not in the AUTHORS section, `An -split' will cause
1110 * newlines to occur before the author name. If in the AUTHORS
1111 * section, by default, the first `An' invocation is nosplit,
1112 * then all subsequent ones, regardless of whether interspersed
1113 * with other macros/text, are split. -split, in this case,
1114 * will override the condition of the implied first -nosplit.
1117 if (n->sec == SEC_AUTHORS) {
1118 if ( ! (TERMP_ANPREC & p->flags)) {
1119 if (TERMP_SPLIT & p->flags)
1123 if (TERMP_NOSPLIT & p->flags)
1129 if (TERMP_SPLIT & p->flags)
1138 termp_an_post(DECL_ARGS)
1142 if (SEC_AUTHORS == n->sec)
1143 p->flags |= TERMP_ANPREC;
1147 if (AUTH_split == n->norm->An.auth) {
1148 p->flags &= ~TERMP_NOSPLIT;
1149 p->flags |= TERMP_SPLIT;
1150 } else if (AUTH_nosplit == n->norm->An.auth) {
1151 p->flags &= ~TERMP_SPLIT;
1152 p->flags |= TERMP_NOSPLIT;
1160 termp_ns_pre(DECL_ARGS)
1163 if ( ! (MDOC_LINE & n->flags))
1164 p->flags |= TERMP_NOSPACE;
1171 termp_rs_pre(DECL_ARGS)
1174 if (SEC_SEE_ALSO != n->sec)
1176 if (MDOC_BLOCK == n->type && n->prev)
1184 termp_rv_pre(DECL_ARGS)
1189 term_word(p, "The");
1192 for (n = n->child; n; n = n->next) {
1193 term_fontpush(p, TERMFONT_BOLD);
1194 term_word(p, n->string);
1197 p->flags |= TERMP_NOSPACE;
1200 if (nchild > 2 && n->next) {
1201 p->flags |= TERMP_NOSPACE;
1205 if (n->next && NULL == n->next->next)
1206 term_word(p, "and");
1210 term_word(p, "functions return");
1212 term_word(p, "function returns");
1214 term_word(p, "the value 0 if successful; otherwise the value "
1215 "-1 is returned and the global variable");
1217 term_fontpush(p, TERMFONT_UNDER);
1218 term_word(p, "errno");
1221 term_word(p, "is set to indicate the error.");
1222 p->flags |= TERMP_SENTENCE;
1230 termp_ex_pre(DECL_ARGS)
1235 term_word(p, "The");
1238 for (n = n->child; n; n = n->next) {
1239 term_fontpush(p, TERMFONT_BOLD);
1240 term_word(p, n->string);
1243 if (nchild > 2 && n->next) {
1244 p->flags |= TERMP_NOSPACE;
1248 if (n->next && NULL == n->next->next)
1249 term_word(p, "and");
1253 term_word(p, "utilities exit");
1255 term_word(p, "utility exits");
1257 term_word(p, "0 on success, and >0 if an error occurs.");
1259 p->flags |= TERMP_SENTENCE;
1266 termp_nd_pre(DECL_ARGS)
1269 if (MDOC_BODY != n->type)
1272 #if defined(__OpenBSD__) || defined(__linux__)
1273 term_word(p, "\\(en");
1275 term_word(p, "\\(em");
1283 termp_bl_pre(DECL_ARGS)
1286 return(MDOC_HEAD != n->type);
1292 termp_bl_post(DECL_ARGS)
1295 if (MDOC_BLOCK == n->type)
1301 termp_xr_pre(DECL_ARGS)
1304 if (NULL == (n = n->child))
1307 assert(MDOC_TEXT == n->type);
1308 term_word(p, n->string);
1310 if (NULL == (n = n->next))
1313 p->flags |= TERMP_NOSPACE;
1315 p->flags |= TERMP_NOSPACE;
1317 assert(MDOC_TEXT == n->type);
1318 term_word(p, n->string);
1320 p->flags |= TERMP_NOSPACE;
1327 * This decides how to assert whitespace before any of the SYNOPSIS set
1328 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1332 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1335 * Obviously, if we're not in a SYNOPSIS or no prior macros
1336 * exist, do nothing.
1338 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1342 * If we're the second in a pair of like elements, emit our
1343 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1344 * case we soldier on.
1346 if (n->prev->tok == n->tok &&
1347 MDOC_Ft != n->tok &&
1348 MDOC_Fo != n->tok &&
1349 MDOC_Fn != n->tok) {
1355 * If we're one of the SYNOPSIS set and non-like pair-wise after
1356 * another (or Fn/Fo, which we've let slip through) then assert
1357 * vertical space, else only newline and move on.
1359 switch (n->prev->tok) {
1372 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1385 termp_vt_pre(DECL_ARGS)
1388 if (MDOC_ELEM == n->type) {
1390 return(termp_under_pre(p, pair, m, n));
1391 } else if (MDOC_BLOCK == n->type) {
1394 } else if (MDOC_HEAD == n->type)
1397 return(termp_under_pre(p, pair, m, n));
1403 termp_bold_pre(DECL_ARGS)
1406 term_fontpush(p, TERMFONT_BOLD);
1413 termp_fd_pre(DECL_ARGS)
1417 return(termp_bold_pre(p, pair, m, n));
1423 termp_sh_pre(DECL_ARGS)
1426 /* No vspace between consecutive `Sh' calls. */
1430 if (n->prev && MDOC_Sh == n->prev->tok)
1431 if (NULL == n->prev->body->child)
1436 term_fontpush(p, TERMFONT_BOLD);
1439 p->offset = term_len(p, INDENT);
1450 termp_sh_post(DECL_ARGS)
1469 termp_bt_pre(DECL_ARGS)
1472 term_word(p, "is currently in beta test.");
1473 p->flags |= TERMP_SENTENCE;
1480 termp_lb_post(DECL_ARGS)
1483 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1490 termp_ud_pre(DECL_ARGS)
1493 term_word(p, "currently under development.");
1494 p->flags |= TERMP_SENTENCE;
1501 termp_d1_pre(DECL_ARGS)
1504 if (MDOC_BLOCK != n->type)
1507 p->offset += term_len(p, (INDENT + 1));
1514 termp_d1_post(DECL_ARGS)
1517 if (MDOC_BLOCK != n->type)
1525 termp_ft_pre(DECL_ARGS)
1528 /* NB: MDOC_LINE does not effect this! */
1530 term_fontpush(p, TERMFONT_UNDER);
1537 termp_fn_pre(DECL_ARGS)
1541 pretty = MDOC_SYNPRETTY & n->flags;
1545 if (NULL == (n = n->child))
1548 assert(MDOC_TEXT == n->type);
1549 term_fontpush(p, TERMFONT_BOLD);
1550 term_word(p, n->string);
1553 p->flags |= TERMP_NOSPACE;
1555 p->flags |= TERMP_NOSPACE;
1557 for (n = n->next; n; n = n->next) {
1558 assert(MDOC_TEXT == n->type);
1559 term_fontpush(p, TERMFONT_UNDER);
1560 term_word(p, n->string);
1564 p->flags |= TERMP_NOSPACE;
1569 p->flags |= TERMP_NOSPACE;
1573 p->flags |= TERMP_NOSPACE;
1583 termp_fa_pre(DECL_ARGS)
1585 const struct mdoc_node *nn;
1587 if (n->parent->tok != MDOC_Fo) {
1588 term_fontpush(p, TERMFONT_UNDER);
1592 for (nn = n->child; nn; nn = nn->next) {
1593 term_fontpush(p, TERMFONT_UNDER);
1594 term_word(p, nn->string);
1598 p->flags |= TERMP_NOSPACE;
1603 if (n->child && n->next && n->next->tok == MDOC_Fa) {
1604 p->flags |= TERMP_NOSPACE;
1614 termp_bd_pre(DECL_ARGS)
1616 size_t tabwidth, rm, rmax;
1617 const struct mdoc_node *nn;
1619 if (MDOC_BLOCK == n->type) {
1620 print_bvspace(p, n, n);
1622 } else if (MDOC_HEAD == n->type)
1625 if (n->norm->Bd.offs)
1626 p->offset += a2offs(p, n->norm->Bd.offs);
1629 * If -ragged or -filled are specified, the block does nothing
1630 * but change the indentation. If -unfilled or -literal are
1631 * specified, text is printed exactly as entered in the display:
1632 * for macro lines, a newline is appended to the line. Blank
1633 * lines are allowed.
1636 if (DISP_literal != n->norm->Bd.type &&
1637 DISP_unfilled != n->norm->Bd.type)
1640 tabwidth = p->tabwidth;
1641 if (DISP_literal == n->norm->Bd.type)
1642 p->tabwidth = term_len(p, 8);
1645 rmax = p->maxrmargin;
1646 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1648 for (nn = n->child; nn; nn = nn->next) {
1649 print_mdoc_node(p, pair, m, nn);
1651 * If the printed node flushes its own line, then we
1652 * needn't do it here as well. This is hacky, but the
1653 * notion of selective eoln whitespace is pretty dumb
1654 * anyway, so don't sweat it.
1676 if (nn->next && nn->next->line == nn->line)
1679 p->flags |= TERMP_NOSPACE;
1682 p->tabwidth = tabwidth;
1684 p->maxrmargin = rmax;
1691 termp_bd_post(DECL_ARGS)
1695 if (MDOC_BODY != n->type)
1699 rmax = p->maxrmargin;
1701 if (DISP_literal == n->norm->Bd.type ||
1702 DISP_unfilled == n->norm->Bd.type)
1703 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1705 p->flags |= TERMP_NOSPACE;
1709 p->maxrmargin = rmax;
1715 termp_bx_pre(DECL_ARGS)
1718 if (NULL != (n = n->child)) {
1719 term_word(p, n->string);
1720 p->flags |= TERMP_NOSPACE;
1721 term_word(p, "BSD");
1723 term_word(p, "BSD");
1727 if (NULL != (n = n->next)) {
1728 p->flags |= TERMP_NOSPACE;
1730 p->flags |= TERMP_NOSPACE;
1731 term_word(p, n->string);
1740 termp_xx_pre(DECL_ARGS)
1772 p->flags |= TERMP_KEEP;
1773 term_word(p, n->child->string);
1782 termp_igndelim_pre(DECL_ARGS)
1785 p->flags |= TERMP_IGNDELIM;
1792 termp_pf_post(DECL_ARGS)
1795 p->flags |= TERMP_NOSPACE;
1801 termp_ss_pre(DECL_ARGS)
1811 term_fontpush(p, TERMFONT_BOLD);
1812 p->offset = term_len(p, HALFINDENT);
1824 termp_ss_post(DECL_ARGS)
1827 if (MDOC_HEAD == n->type)
1834 termp_cd_pre(DECL_ARGS)
1838 term_fontpush(p, TERMFONT_BOLD);
1845 termp_in_pre(DECL_ARGS)
1850 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1851 term_fontpush(p, TERMFONT_BOLD);
1852 term_word(p, "#include");
1856 term_fontpush(p, TERMFONT_UNDER);
1859 p->flags |= TERMP_NOSPACE;
1866 termp_in_post(DECL_ARGS)
1869 if (MDOC_SYNPRETTY & n->flags)
1870 term_fontpush(p, TERMFONT_BOLD);
1872 p->flags |= TERMP_NOSPACE;
1875 if (MDOC_SYNPRETTY & n->flags)
1882 termp_sp_pre(DECL_ARGS)
1888 len = n->child ? a2height(p, n->child->string) : 1;
1900 for (i = 0; i < len; i++)
1909 termp_quote_pre(DECL_ARGS)
1912 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1964 p->flags |= TERMP_NOSPACE;
1971 termp_quote_post(DECL_ARGS)
1974 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1977 p->flags |= TERMP_NOSPACE;
2032 termp_fo_pre(DECL_ARGS)
2035 if (MDOC_BLOCK == n->type) {
2038 } else if (MDOC_BODY == n->type) {
2039 p->flags |= TERMP_NOSPACE;
2041 p->flags |= TERMP_NOSPACE;
2045 if (NULL == n->child)
2048 /* XXX: we drop non-initial arguments as per groff. */
2050 assert(n->child->string);
2051 term_fontpush(p, TERMFONT_BOLD);
2052 term_word(p, n->child->string);
2059 termp_fo_post(DECL_ARGS)
2062 if (MDOC_BODY != n->type)
2065 p->flags |= TERMP_NOSPACE;
2068 if (MDOC_SYNPRETTY & n->flags) {
2069 p->flags |= TERMP_NOSPACE;
2077 termp_bf_pre(DECL_ARGS)
2080 if (MDOC_HEAD == n->type)
2082 else if (MDOC_BLOCK != n->type)
2085 if (FONT_Em == n->norm->Bf.font)
2086 term_fontpush(p, TERMFONT_UNDER);
2087 else if (FONT_Sy == n->norm->Bf.font)
2088 term_fontpush(p, TERMFONT_BOLD);
2090 term_fontpush(p, TERMFONT_NONE);
2098 termp_sm_pre(DECL_ARGS)
2101 assert(n->child && MDOC_TEXT == n->child->type);
2102 if (0 == strcmp("on", n->child->string)) {
2104 p->flags &= ~TERMP_NOSPACE;
2105 p->flags &= ~TERMP_NONOSPACE;
2107 p->flags |= TERMP_NONOSPACE;
2115 termp_ap_pre(DECL_ARGS)
2118 p->flags |= TERMP_NOSPACE;
2120 p->flags |= TERMP_NOSPACE;
2127 termp____post(DECL_ARGS)
2131 * Handle lists of authors. In general, print each followed by
2132 * a comma. Don't print the comma if there are only two
2135 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2136 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2137 if (NULL == n->prev || MDOC__A != n->prev->tok)
2142 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2145 p->flags |= TERMP_NOSPACE;
2146 if (NULL == n->next) {
2148 p->flags |= TERMP_SENTENCE;
2156 termp_li_pre(DECL_ARGS)
2159 term_fontpush(p, TERMFONT_NONE);
2166 termp_lk_pre(DECL_ARGS)
2168 const struct mdoc_node *nn, *sv;
2170 term_fontpush(p, TERMFONT_UNDER);
2174 if (NULL == nn || NULL == nn->next)
2177 for (nn = nn->next; nn; nn = nn->next)
2178 term_word(p, nn->string);
2182 p->flags |= TERMP_NOSPACE;
2185 term_fontpush(p, TERMFONT_BOLD);
2186 term_word(p, sv->string);
2195 termp_bk_pre(DECL_ARGS)
2204 if (n->parent->args || 0 == n->prev->nchild)
2205 p->flags |= TERMP_PREKEEP;
2218 termp_bk_post(DECL_ARGS)
2221 if (MDOC_BODY == n->type)
2222 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2227 termp__t_post(DECL_ARGS)
2231 * If we're in an `Rs' and there's a journal present, then quote
2232 * us instead of underlining us (for disambiguation).
2234 if (n->parent && MDOC_Rs == n->parent->tok &&
2235 n->parent->norm->Rs.quote_T)
2236 termp_quote_post(p, pair, m, n);
2238 termp____post(p, pair, m, n);
2243 termp__t_pre(DECL_ARGS)
2247 * If we're in an `Rs' and there's a journal present, then quote
2248 * us instead of underlining us (for disambiguation).
2250 if (n->parent && MDOC_Rs == n->parent->tok &&
2251 n->parent->norm->Rs.quote_T)
2252 return(termp_quote_pre(p, pair, m, n));
2254 term_fontpush(p, TERMFONT_UNDER);
2260 termp_under_pre(DECL_ARGS)
2263 term_fontpush(p, TERMFONT_UNDER);