1 /* $Id: mdoc_term.c,v 1.255 2013/12/25 00:39:31 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012, 2013 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 *meta, \
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_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);
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_in_pre(DECL_ARGS);
104 static int termp_it_pre(DECL_ARGS);
105 static int termp_li_pre(DECL_ARGS);
106 static int termp_lk_pre(DECL_ARGS);
107 static int termp_nd_pre(DECL_ARGS);
108 static int termp_nm_pre(DECL_ARGS);
109 static int termp_ns_pre(DECL_ARGS);
110 static int termp_quote_pre(DECL_ARGS);
111 static int termp_rs_pre(DECL_ARGS);
112 static int termp_rv_pre(DECL_ARGS);
113 static int termp_sh_pre(DECL_ARGS);
114 static int termp_sm_pre(DECL_ARGS);
115 static int termp_sp_pre(DECL_ARGS);
116 static int termp_ss_pre(DECL_ARGS);
117 static int termp_under_pre(DECL_ARGS);
118 static int termp_ud_pre(DECL_ARGS);
119 static int termp_vt_pre(DECL_ARGS);
120 static int termp_xr_pre(DECL_ARGS);
121 static int termp_xx_pre(DECL_ARGS);
123 static const struct termact termacts[MDOC_MAX] = {
124 { termp_ap_pre, NULL }, /* Ap */
125 { NULL, NULL }, /* Dd */
126 { NULL, NULL }, /* Dt */
127 { NULL, NULL }, /* Os */
128 { termp_sh_pre, termp_sh_post }, /* Sh */
129 { termp_ss_pre, termp_ss_post }, /* Ss */
130 { termp_sp_pre, NULL }, /* Pp */
131 { termp_d1_pre, termp_bl_post }, /* D1 */
132 { termp_d1_pre, termp_bl_post }, /* Dl */
133 { termp_bd_pre, termp_bd_post }, /* Bd */
134 { NULL, NULL }, /* Ed */
135 { termp_bl_pre, termp_bl_post }, /* Bl */
136 { NULL, NULL }, /* El */
137 { termp_it_pre, termp_it_post }, /* It */
138 { termp_under_pre, NULL }, /* Ad */
139 { termp_an_pre, termp_an_post }, /* An */
140 { termp_under_pre, NULL }, /* Ar */
141 { termp_cd_pre, NULL }, /* Cd */
142 { termp_bold_pre, NULL }, /* Cm */
143 { NULL, NULL }, /* Dv */
144 { NULL, NULL }, /* Er */
145 { NULL, NULL }, /* Ev */
146 { termp_ex_pre, NULL }, /* Ex */
147 { termp_fa_pre, NULL }, /* Fa */
148 { termp_fd_pre, termp_fd_post }, /* Fd */
149 { termp_fl_pre, NULL }, /* Fl */
150 { termp_fn_pre, NULL }, /* Fn */
151 { termp_ft_pre, NULL }, /* Ft */
152 { termp_bold_pre, NULL }, /* Ic */
153 { termp_in_pre, termp_in_post }, /* In */
154 { termp_li_pre, NULL }, /* Li */
155 { termp_nd_pre, NULL }, /* Nd */
156 { termp_nm_pre, termp_nm_post }, /* Nm */
157 { termp_quote_pre, termp_quote_post }, /* Op */
158 { NULL, NULL }, /* Ot */
159 { termp_under_pre, NULL }, /* Pa */
160 { termp_rv_pre, NULL }, /* Rv */
161 { NULL, NULL }, /* St */
162 { termp_under_pre, NULL }, /* Va */
163 { termp_vt_pre, NULL }, /* Vt */
164 { termp_xr_pre, NULL }, /* Xr */
165 { termp__a_pre, termp____post }, /* %A */
166 { termp_under_pre, termp____post }, /* %B */
167 { NULL, termp____post }, /* %D */
168 { termp_under_pre, termp____post }, /* %I */
169 { termp_under_pre, termp____post }, /* %J */
170 { NULL, termp____post }, /* %N */
171 { NULL, termp____post }, /* %O */
172 { NULL, termp____post }, /* %P */
173 { NULL, termp____post }, /* %R */
174 { termp__t_pre, termp__t_post }, /* %T */
175 { NULL, termp____post }, /* %V */
176 { NULL, NULL }, /* Ac */
177 { termp_quote_pre, termp_quote_post }, /* Ao */
178 { termp_quote_pre, termp_quote_post }, /* Aq */
179 { NULL, NULL }, /* At */
180 { NULL, NULL }, /* Bc */
181 { termp_bf_pre, NULL }, /* Bf */
182 { termp_quote_pre, termp_quote_post }, /* Bo */
183 { termp_quote_pre, termp_quote_post }, /* Bq */
184 { termp_xx_pre, NULL }, /* Bsx */
185 { termp_bx_pre, NULL }, /* Bx */
186 { NULL, NULL }, /* Db */
187 { NULL, NULL }, /* Dc */
188 { termp_quote_pre, termp_quote_post }, /* Do */
189 { termp_quote_pre, termp_quote_post }, /* Dq */
190 { NULL, NULL }, /* Ec */ /* FIXME: no space */
191 { NULL, NULL }, /* Ef */
192 { termp_under_pre, NULL }, /* Em */
193 { termp_quote_pre, termp_quote_post }, /* Eo */
194 { termp_xx_pre, NULL }, /* Fx */
195 { termp_bold_pre, NULL }, /* Ms */
196 { NULL, NULL }, /* No */
197 { termp_ns_pre, NULL }, /* Ns */
198 { termp_xx_pre, NULL }, /* Nx */
199 { termp_xx_pre, NULL }, /* Ox */
200 { NULL, NULL }, /* Pc */
201 { NULL, termp_pf_post }, /* Pf */
202 { termp_quote_pre, termp_quote_post }, /* Po */
203 { termp_quote_pre, termp_quote_post }, /* Pq */
204 { NULL, NULL }, /* Qc */
205 { termp_quote_pre, termp_quote_post }, /* Ql */
206 { termp_quote_pre, termp_quote_post }, /* Qo */
207 { termp_quote_pre, termp_quote_post }, /* Qq */
208 { NULL, NULL }, /* Re */
209 { termp_rs_pre, NULL }, /* Rs */
210 { NULL, NULL }, /* Sc */
211 { termp_quote_pre, termp_quote_post }, /* So */
212 { termp_quote_pre, termp_quote_post }, /* Sq */
213 { termp_sm_pre, NULL }, /* Sm */
214 { termp_under_pre, NULL }, /* Sx */
215 { termp_bold_pre, NULL }, /* Sy */
216 { NULL, NULL }, /* Tn */
217 { termp_xx_pre, NULL }, /* Ux */
218 { NULL, NULL }, /* Xc */
219 { NULL, NULL }, /* Xo */
220 { termp_fo_pre, termp_fo_post }, /* Fo */
221 { NULL, NULL }, /* Fc */
222 { termp_quote_pre, termp_quote_post }, /* Oo */
223 { NULL, NULL }, /* Oc */
224 { termp_bk_pre, termp_bk_post }, /* Bk */
225 { NULL, NULL }, /* Ek */
226 { termp_bt_pre, NULL }, /* Bt */
227 { NULL, NULL }, /* Hf */
228 { NULL, NULL }, /* Fr */
229 { termp_ud_pre, NULL }, /* Ud */
230 { NULL, termp_lb_post }, /* Lb */
231 { termp_sp_pre, NULL }, /* Lp */
232 { termp_lk_pre, NULL }, /* Lk */
233 { termp_under_pre, NULL }, /* Mt */
234 { termp_quote_pre, termp_quote_post }, /* Brq */
235 { termp_quote_pre, termp_quote_post }, /* Bro */
236 { NULL, NULL }, /* Brc */
237 { NULL, termp____post }, /* %C */
238 { NULL, NULL }, /* Es */ /* TODO */
239 { NULL, NULL }, /* En */ /* TODO */
240 { termp_xx_pre, NULL }, /* Dx */
241 { NULL, termp____post }, /* %Q */
242 { termp_sp_pre, NULL }, /* br */
243 { termp_sp_pre, NULL }, /* sp */
244 { NULL, termp____post }, /* %U */
245 { NULL, NULL }, /* Ta */
250 terminal_mdoc(void *arg, const struct mdoc *mdoc)
252 const struct mdoc_node *n;
253 const struct mdoc_meta *meta;
256 p = (struct termp *)arg;
258 if (0 == p->defindent)
262 p->maxrmargin = p->defrmargin;
263 p->tabwidth = term_len(p, 5);
265 if (NULL == p->symtab)
266 p->symtab = mchars_alloc();
269 meta = mdoc_meta(mdoc);
271 term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
274 print_mdoc_nodelist(p, NULL, meta, n->child);
281 print_mdoc_nodelist(DECL_ARGS)
284 print_mdoc_node(p, pair, meta, n);
286 print_mdoc_nodelist(p, pair, meta, n->next);
292 print_mdoc_node(DECL_ARGS)
295 struct termpair npair;
296 size_t offset, rmargin;
300 rmargin = p->rmargin;
301 n->prev_font = term_fontq(p);
303 memset(&npair, 0, sizeof(struct termpair));
307 * Keeps only work until the end of a line. If a keep was
308 * invoked in a prior line, revert it to PREKEEP.
311 if (TERMP_KEEP & p->flags) {
312 if (n->prev ? (n->prev->lastline != n->line) :
313 (n->parent && n->parent->line != n->line)) {
314 p->flags &= ~TERMP_KEEP;
315 p->flags |= TERMP_PREKEEP;
320 * After the keep flags have been set up, we may now
321 * produce output. Note that some pre-handlers do so.
326 if (' ' == *n->string && MDOC_LINE & n->flags)
328 if (MDOC_DELIMC & n->flags)
329 p->flags |= TERMP_NOSPACE;
330 term_word(p, n->string);
331 if (MDOC_DELIMO & n->flags)
332 p->flags |= TERMP_NOSPACE;
338 term_tbl(p, n->span);
341 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
342 chld = (*termacts[n->tok].pre)
343 (p, &npair, meta, n);
347 if (chld && n->child)
348 print_mdoc_nodelist(p, &npair, meta, n->child);
351 (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
361 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
363 (void)(*termacts[n->tok].post)(p, &npair, meta, n);
366 * Explicit end tokens not only call the post
367 * handler, but also tell the respective block
368 * that it must not call the post handler again.
370 if (ENDBODY_NOT != n->end)
371 n->pending->flags |= MDOC_ENDED;
374 * End of line terminating an implicit block
375 * while an explicit block is still open.
376 * Continue the explicit block without spacing.
378 if (ENDBODY_NOSPACE == n->end)
379 p->flags |= TERMP_NOSPACE;
383 if (MDOC_EOS & n->flags)
384 p->flags |= TERMP_SENTENCE;
387 p->rmargin = rmargin;
392 print_mdoc_foot(struct termp *p, const void *arg)
394 const struct mdoc_meta *meta;
396 meta = (const struct mdoc_meta *)arg;
398 term_fontrepl(p, TERMFONT_NONE);
401 * Output the footer in new-groff style, that is, three columns
402 * with the middle being the manual date and flanking columns
403 * being the operating system:
411 p->rmargin = (p->maxrmargin -
412 term_strlen(p, meta->date) + term_len(p, 1)) / 2;
414 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
416 term_word(p, meta->os);
419 p->offset = p->rmargin;
420 p->rmargin = p->maxrmargin - term_strlen(p, meta->os);
421 p->flags |= TERMP_NOSPACE;
423 term_word(p, meta->date);
426 p->offset = p->rmargin;
427 p->rmargin = p->maxrmargin;
429 p->flags &= ~TERMP_NOBREAK;
430 p->flags |= TERMP_NOSPACE;
432 term_word(p, meta->os);
436 p->rmargin = p->maxrmargin;
442 print_mdoc_head(struct termp *p, const void *arg)
444 char buf[BUFSIZ], title[BUFSIZ];
445 size_t buflen, titlen;
446 const struct mdoc_meta *meta;
448 meta = (const struct mdoc_meta *)arg;
451 * The header is strange. It has three components, which are
452 * really two with the first duplicated. It goes like this:
454 * IDENTIFIER TITLE IDENTIFIER
456 * The IDENTIFIER is NAME(SECTION), which is the command-name
457 * (if given, or "unknown" if not) followed by the manual page
458 * section. These are given in `Dt'. The TITLE is a free-form
459 * string depending on the manual volume. If not specified, it
460 * switches on the manual section.
464 p->rmargin = p->maxrmargin;
467 strlcpy(buf, meta->vol, BUFSIZ);
468 buflen = term_strlen(p, buf);
471 strlcat(buf, " (", BUFSIZ);
472 strlcat(buf, meta->arch, BUFSIZ);
473 strlcat(buf, ")", BUFSIZ);
476 snprintf(title, BUFSIZ, "%s(%s)", meta->title, meta->msec);
477 titlen = term_strlen(p, title);
479 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
482 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
484 term_strlen(p, buf) + term_len(p, 1)) / 2 :
485 p->maxrmargin - buflen;
490 p->flags |= TERMP_NOSPACE;
491 p->offset = p->rmargin;
492 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
493 p->maxrmargin - titlen : p->maxrmargin;
498 p->flags &= ~TERMP_NOBREAK;
500 if (p->rmargin + titlen <= p->maxrmargin) {
501 p->flags |= TERMP_NOSPACE;
502 p->offset = p->rmargin;
503 p->rmargin = p->maxrmargin;
508 p->flags &= ~TERMP_NOSPACE;
510 p->rmargin = p->maxrmargin;
515 a2height(const struct termp *p, const char *v)
521 if ( ! a2roffsu(v, &su, SCALE_VS))
522 SCALE_VS_INIT(&su, atoi(v));
524 return(term_vspan(p, &su));
529 a2width(const struct termp *p, const char *v)
534 if ( ! a2roffsu(v, &su, SCALE_MAX))
535 SCALE_HS_INIT(&su, term_strlen(p, v));
537 return(term_hspan(p, &su));
542 a2offs(const struct termp *p, const char *v)
548 else if (0 == strcmp(v, "left"))
550 else if (0 == strcmp(v, "indent"))
551 return(term_len(p, p->defindent + 1));
552 else if (0 == strcmp(v, "indent-two"))
553 return(term_len(p, (p->defindent + 1) * 2));
554 else if ( ! a2roffsu(v, &su, SCALE_MAX))
555 SCALE_HS_INIT(&su, term_strlen(p, v));
557 return(term_hspan(p, &su));
562 * Determine how much space to print out before block elements of `It'
563 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
567 print_bvspace(struct termp *p,
568 const struct mdoc_node *bl,
569 const struct mdoc_node *n)
571 const struct mdoc_node *nn;
577 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
579 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
582 /* Do not vspace directly after Ss/Sh. */
584 for (nn = n; nn; nn = nn->parent) {
585 if (MDOC_BLOCK != nn->type)
587 if (MDOC_Ss == nn->tok)
589 if (MDOC_Sh == nn->tok)
591 if (NULL == nn->prev)
596 /* A `-column' does not assert vspace within the list. */
598 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
599 if (n->prev && MDOC_It == n->prev->tok)
602 /* A `-diag' without body does not vspace. */
604 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
605 if (n->prev && MDOC_It == n->prev->tok) {
606 assert(n->prev->body);
607 if (NULL == n->prev->body->child)
617 termp_it_pre(DECL_ARGS)
619 const struct mdoc_node *bl, *nn;
622 size_t width, offset, ncols, dcol;
625 if (MDOC_BLOCK == n->type) {
626 print_bvspace(p, n->parent->parent, n);
630 bl = n->parent->parent->parent;
631 type = bl->norm->Bl.type;
634 * First calculate width and offset. This is pretty easy unless
635 * we're a -column list, in which case all prior columns must
641 if (bl->norm->Bl.offs)
642 offset = a2offs(p, bl->norm->Bl.offs);
646 if (MDOC_HEAD == n->type)
650 * Imitate groff's column handling:
651 * - For each earlier column, add its width.
652 * - For less than 5 columns, add four more blanks per
654 * - For exactly 5 columns, add three more blank per
656 * - For more than 5 columns, add only one column.
658 ncols = bl->norm->Bl.ncols;
661 dcol = ncols < 5 ? term_len(p, 4) :
662 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
665 * Calculate the offset by applying all prior MDOC_BODY,
666 * so we stop at the MDOC_HEAD (NULL == nn->prev).
669 for (i = 0, nn = n->prev;
670 nn->prev && i < (int)ncols;
672 offset += dcol + a2width
673 (p, bl->norm->Bl.cols[i]);
676 * When exceeding the declared number of columns, leave
677 * the remaining widths at 0. This will later be
678 * adjusted to the default width of 10, or, for the last
679 * column, stretched to the right margin.
685 * Use the declared column widths, extended as explained
686 * in the preceding paragraph.
688 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
691 if (NULL == bl->norm->Bl.width)
695 * Note: buffer the width by 2, which is groff's magic
696 * number for buffering single arguments. See the above
697 * handling for column for how this changes.
699 assert(bl->norm->Bl.width);
700 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
705 * List-type can override the width in the case of fixed-head
706 * values (bullet, dash/hyphen, enum). Tags need a non-zero
718 if (width < term_len(p, 2))
719 width = term_len(p, 2);
723 width = term_len(p, 8);
729 width = term_len(p, 10);
736 * Whitespace control. Inset bodies need an initial space,
737 * while diagonal bodies need two.
740 p->flags |= TERMP_NOSPACE;
744 if (MDOC_BODY == n->type)
745 term_word(p, "\\ \\ ");
748 if (MDOC_BODY == n->type)
755 p->flags |= TERMP_NOSPACE;
759 if (MDOC_HEAD == n->type)
760 term_fontpush(p, TERMFONT_BOLD);
767 * Pad and break control. This is the tricky part. These flags
768 * are documented in term_flushln() in term.c. Note that we're
769 * going to unset all of these flags in termp_it_post() when we
776 * Weird special case.
777 * Very narrow enum lists actually hang.
779 if (width == term_len(p, 2))
780 p->flags |= TERMP_HANG;
787 if (MDOC_HEAD != n->type)
789 p->flags |= TERMP_NOBREAK;
793 if (MDOC_HEAD != n->type)
797 * This is ugly. If `-hang' is specified and the body
798 * is a `Bl' or `Bd', then we want basically to nullify
799 * the "overstep" effect in term_flushln() and treat
800 * this as a `-ohang' list instead.
802 if (n->next->child &&
803 (MDOC_Bl == n->next->child->tok ||
804 MDOC_Bd == n->next->child->tok))
807 p->flags |= TERMP_NOBREAK | TERMP_HANG;
811 if (MDOC_HEAD != n->type)
814 p->flags |= TERMP_NOBREAK;
817 if (NULL == n->next || NULL == n->next->child)
818 p->flags |= TERMP_DANGLE;
821 if (MDOC_HEAD == n->type)
824 if (NULL == n->next) {
825 p->flags &= ~TERMP_NOBREAK;
828 p->flags |= TERMP_NOBREAK;
834 if (MDOC_HEAD != n->type)
836 p->flags |= TERMP_NOBREAK;
844 * Margin control. Set-head-width lists have their right
845 * margins shortened. The body for these lists has the offset
846 * necessarily lengthened. Everybody gets the offset.
854 * Same stipulation as above, regarding `-hang'. We
855 * don't want to recalculate rmargin and offsets when
856 * using `Bd' or `Bl' within `-hang' overstep lists.
858 if (MDOC_HEAD == n->type && n->next->child &&
859 (MDOC_Bl == n->next->child->tok ||
860 MDOC_Bd == n->next->child->tok))
873 if (MDOC_HEAD == n->type)
874 p->rmargin = p->offset + width;
880 p->rmargin = p->offset + width;
882 * XXX - this behaviour is not documented: the
883 * right-most column is filled to the right margin.
885 if (MDOC_HEAD == n->type)
887 if (NULL == n->next && p->rmargin < p->maxrmargin)
888 p->rmargin = p->maxrmargin;
895 * The dash, hyphen, bullet and enum lists all have a special
896 * HEAD character (temporarily bold, in some cases).
899 if (MDOC_HEAD == n->type)
902 term_fontpush(p, TERMFONT_BOLD);
903 term_word(p, "\\[bu]");
909 term_fontpush(p, TERMFONT_BOLD);
910 term_word(p, "\\(hy");
914 (pair->ppair->ppair->count)++;
915 snprintf(buf, sizeof(buf), "%d.",
916 pair->ppair->ppair->count);
924 * If we're not going to process our children, indicate so here.
937 if (MDOC_HEAD == n->type)
941 if (MDOC_HEAD == n->type)
954 termp_it_post(DECL_ARGS)
958 if (MDOC_BLOCK == n->type)
961 type = n->parent->parent->parent->norm->Bl.type;
969 if (MDOC_BODY == n->type)
973 if (MDOC_BODY == n->type)
982 * Now that our output is flushed, we can reset our tags. Since
983 * only `It' sets these flags, we're free to assume that nobody
984 * has munged them in the meanwhile.
987 p->flags &= ~TERMP_DANGLE;
988 p->flags &= ~TERMP_NOBREAK;
989 p->flags &= ~TERMP_HANG;
996 termp_nm_pre(DECL_ARGS)
999 if (MDOC_BLOCK == n->type) {
1000 p->flags |= TERMP_PREKEEP;
1004 if (MDOC_BODY == n->type) {
1005 if (NULL == n->child)
1007 p->flags |= TERMP_NOSPACE;
1008 p->offset += term_len(p, 1) +
1009 (NULL == n->prev->child ?
1010 term_strlen(p, meta->name) :
1011 MDOC_TEXT == n->prev->child->type ?
1012 term_strlen(p, n->prev->child->string) :
1017 if (NULL == n->child && NULL == meta->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;
1026 p->rmargin = p->offset + term_len(p, 1);
1027 if (NULL == n->child) {
1028 p->rmargin += term_strlen(p, meta->name);
1029 } else if (MDOC_TEXT == n->child->type) {
1030 p->rmargin += term_strlen(p, n->child->string);
1032 p->flags |= TERMP_HANG;
1034 p->rmargin += term_len(p, 5);
1035 p->flags |= TERMP_HANG;
1039 term_fontpush(p, TERMFONT_BOLD);
1040 if (NULL == n->child)
1041 term_word(p, meta->name);
1048 termp_nm_post(DECL_ARGS)
1051 if (MDOC_BLOCK == n->type) {
1052 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1053 } else if (MDOC_HEAD == n->type && n->next->child) {
1055 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1057 } else if (MDOC_BODY == n->type && n->child)
1064 termp_fl_pre(DECL_ARGS)
1067 term_fontpush(p, TERMFONT_BOLD);
1068 term_word(p, "\\-");
1071 p->flags |= TERMP_NOSPACE;
1072 else if (n->next && n->next->line == n->line)
1073 p->flags |= TERMP_NOSPACE;
1081 termp__a_pre(DECL_ARGS)
1084 if (n->prev && MDOC__A == n->prev->tok)
1085 if (NULL == n->next || MDOC__A != n->next->tok)
1086 term_word(p, "and");
1094 termp_an_pre(DECL_ARGS)
1097 if (NULL == n->child)
1101 * If not in the AUTHORS section, `An -split' will cause
1102 * newlines to occur before the author name. If in the AUTHORS
1103 * section, by default, the first `An' invocation is nosplit,
1104 * then all subsequent ones, regardless of whether interspersed
1105 * with other macros/text, are split. -split, in this case,
1106 * will override the condition of the implied first -nosplit.
1109 if (n->sec == SEC_AUTHORS) {
1110 if ( ! (TERMP_ANPREC & p->flags)) {
1111 if (TERMP_SPLIT & p->flags)
1115 if (TERMP_NOSPLIT & p->flags)
1121 if (TERMP_SPLIT & p->flags)
1130 termp_an_post(DECL_ARGS)
1134 if (SEC_AUTHORS == n->sec)
1135 p->flags |= TERMP_ANPREC;
1139 if (AUTH_split == n->norm->An.auth) {
1140 p->flags &= ~TERMP_NOSPLIT;
1141 p->flags |= TERMP_SPLIT;
1142 } else if (AUTH_nosplit == n->norm->An.auth) {
1143 p->flags &= ~TERMP_SPLIT;
1144 p->flags |= TERMP_NOSPLIT;
1152 termp_ns_pre(DECL_ARGS)
1155 if ( ! (MDOC_LINE & n->flags))
1156 p->flags |= TERMP_NOSPACE;
1163 termp_rs_pre(DECL_ARGS)
1166 if (SEC_SEE_ALSO != n->sec)
1168 if (MDOC_BLOCK == n->type && n->prev)
1176 termp_rv_pre(DECL_ARGS)
1181 term_word(p, "The");
1184 for (n = n->child; n; n = n->next) {
1185 term_fontpush(p, TERMFONT_BOLD);
1186 term_word(p, n->string);
1189 p->flags |= TERMP_NOSPACE;
1192 if (nchild > 2 && n->next) {
1193 p->flags |= TERMP_NOSPACE;
1197 if (n->next && NULL == n->next->next)
1198 term_word(p, "and");
1202 term_word(p, "functions return");
1204 term_word(p, "function returns");
1206 term_word(p, "the value 0 if successful; otherwise the value "
1207 "-1 is returned and the global variable");
1209 term_fontpush(p, TERMFONT_UNDER);
1210 term_word(p, "errno");
1213 term_word(p, "is set to indicate the error.");
1214 p->flags |= TERMP_SENTENCE;
1222 termp_ex_pre(DECL_ARGS)
1227 term_word(p, "The");
1230 for (n = n->child; n; n = n->next) {
1231 term_fontpush(p, TERMFONT_BOLD);
1232 term_word(p, n->string);
1235 if (nchild > 2 && n->next) {
1236 p->flags |= TERMP_NOSPACE;
1240 if (n->next && NULL == n->next->next)
1241 term_word(p, "and");
1245 term_word(p, "utilities exit");
1247 term_word(p, "utility exits");
1249 term_word(p, "0 on success, and >0 if an error occurs.");
1251 p->flags |= TERMP_SENTENCE;
1258 termp_nd_pre(DECL_ARGS)
1261 if (MDOC_BODY != n->type)
1264 #if defined(__OpenBSD__) || defined(__linux__)
1265 term_word(p, "\\(en");
1267 term_word(p, "\\(em");
1275 termp_bl_pre(DECL_ARGS)
1278 return(MDOC_HEAD != n->type);
1284 termp_bl_post(DECL_ARGS)
1287 if (MDOC_BLOCK == n->type)
1293 termp_xr_pre(DECL_ARGS)
1296 if (NULL == (n = n->child))
1299 assert(MDOC_TEXT == n->type);
1300 term_word(p, n->string);
1302 if (NULL == (n = n->next))
1305 p->flags |= TERMP_NOSPACE;
1307 p->flags |= TERMP_NOSPACE;
1309 assert(MDOC_TEXT == n->type);
1310 term_word(p, n->string);
1312 p->flags |= TERMP_NOSPACE;
1319 * This decides how to assert whitespace before any of the SYNOPSIS set
1320 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1324 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1327 * Obviously, if we're not in a SYNOPSIS or no prior macros
1328 * exist, do nothing.
1330 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1334 * If we're the second in a pair of like elements, emit our
1335 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1336 * case we soldier on.
1338 if (n->prev->tok == n->tok &&
1339 MDOC_Ft != n->tok &&
1340 MDOC_Fo != n->tok &&
1341 MDOC_Fn != n->tok) {
1347 * If we're one of the SYNOPSIS set and non-like pair-wise after
1348 * another (or Fn/Fo, which we've let slip through) then assert
1349 * vertical space, else only newline and move on.
1351 switch (n->prev->tok) {
1364 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1377 termp_vt_pre(DECL_ARGS)
1380 if (MDOC_ELEM == n->type) {
1382 return(termp_under_pre(p, pair, meta, n));
1383 } else if (MDOC_BLOCK == n->type) {
1386 } else if (MDOC_HEAD == n->type)
1389 return(termp_under_pre(p, pair, meta, n));
1395 termp_bold_pre(DECL_ARGS)
1398 term_fontpush(p, TERMFONT_BOLD);
1405 termp_fd_pre(DECL_ARGS)
1409 return(termp_bold_pre(p, pair, meta, n));
1415 termp_fd_post(DECL_ARGS)
1424 termp_sh_pre(DECL_ARGS)
1427 /* No vspace between consecutive `Sh' calls. */
1431 if (n->prev && MDOC_Sh == n->prev->tok)
1432 if (NULL == n->prev->body->child)
1437 term_fontpush(p, TERMFONT_BOLD);
1440 p->offset = term_len(p, p->defindent);
1441 if (SEC_AUTHORS == n->sec)
1442 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1453 termp_sh_post(DECL_ARGS)
1472 termp_bt_pre(DECL_ARGS)
1475 term_word(p, "is currently in beta test.");
1476 p->flags |= TERMP_SENTENCE;
1483 termp_lb_post(DECL_ARGS)
1486 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1493 termp_ud_pre(DECL_ARGS)
1496 term_word(p, "currently under development.");
1497 p->flags |= TERMP_SENTENCE;
1504 termp_d1_pre(DECL_ARGS)
1507 if (MDOC_BLOCK != n->type)
1510 p->offset += term_len(p, p->defindent + 1);
1517 termp_ft_pre(DECL_ARGS)
1520 /* NB: MDOC_LINE does not effect this! */
1522 term_fontpush(p, TERMFONT_UNDER);
1529 termp_fn_pre(DECL_ARGS)
1531 size_t width, rmargin = 0;
1534 pretty = MDOC_SYNPRETTY & n->flags;
1538 if (NULL == (n = n->child))
1542 width = term_len(p, 4);
1543 rmargin = p->rmargin;
1544 p->rmargin = p->offset + width;
1545 p->flags |= TERMP_NOBREAK | TERMP_HANG;
1548 assert(MDOC_TEXT == n->type);
1549 term_fontpush(p, TERMFONT_BOLD);
1550 term_word(p, n->string);
1555 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1556 p->offset = p->rmargin;
1557 p->rmargin = rmargin;
1560 p->flags |= TERMP_NOSPACE;
1562 p->flags |= TERMP_NOSPACE;
1564 for (n = n->next; n; n = n->next) {
1565 assert(MDOC_TEXT == n->type);
1566 term_fontpush(p, TERMFONT_UNDER);
1568 p->flags |= TERMP_NBRWORD;
1569 term_word(p, n->string);
1573 p->flags |= TERMP_NOSPACE;
1578 p->flags |= TERMP_NOSPACE;
1582 p->flags |= TERMP_NOSPACE;
1593 termp_fa_pre(DECL_ARGS)
1595 const struct mdoc_node *nn;
1597 if (n->parent->tok != MDOC_Fo) {
1598 term_fontpush(p, TERMFONT_UNDER);
1602 for (nn = n->child; nn; nn = nn->next) {
1603 term_fontpush(p, TERMFONT_UNDER);
1604 term_word(p, nn->string);
1608 p->flags |= TERMP_NOSPACE;
1613 if (n->child && n->next && n->next->tok == MDOC_Fa) {
1614 p->flags |= TERMP_NOSPACE;
1624 termp_bd_pre(DECL_ARGS)
1626 size_t tabwidth, rm, rmax;
1627 struct mdoc_node *nn;
1629 if (MDOC_BLOCK == n->type) {
1630 print_bvspace(p, n, n);
1632 } else if (MDOC_HEAD == n->type)
1635 if (n->norm->Bd.offs)
1636 p->offset += a2offs(p, n->norm->Bd.offs);
1639 * If -ragged or -filled are specified, the block does nothing
1640 * but change the indentation. If -unfilled or -literal are
1641 * specified, text is printed exactly as entered in the display:
1642 * for macro lines, a newline is appended to the line. Blank
1643 * lines are allowed.
1646 if (DISP_literal != n->norm->Bd.type &&
1647 DISP_unfilled != n->norm->Bd.type)
1650 tabwidth = p->tabwidth;
1651 if (DISP_literal == n->norm->Bd.type)
1652 p->tabwidth = term_len(p, 8);
1655 rmax = p->maxrmargin;
1656 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1658 for (nn = n->child; nn; nn = nn->next) {
1659 print_mdoc_node(p, pair, meta, nn);
1661 * If the printed node flushes its own line, then we
1662 * needn't do it here as well. This is hacky, but the
1663 * notion of selective eoln whitespace is pretty dumb
1664 * anyway, so don't sweat it.
1686 if (nn->next && nn->next->line == nn->line)
1689 p->flags |= TERMP_NOSPACE;
1692 p->tabwidth = tabwidth;
1694 p->maxrmargin = rmax;
1701 termp_bd_post(DECL_ARGS)
1705 if (MDOC_BODY != n->type)
1709 rmax = p->maxrmargin;
1711 if (DISP_literal == n->norm->Bd.type ||
1712 DISP_unfilled == n->norm->Bd.type)
1713 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1715 p->flags |= TERMP_NOSPACE;
1719 p->maxrmargin = rmax;
1725 termp_bx_pre(DECL_ARGS)
1728 if (NULL != (n = n->child)) {
1729 term_word(p, n->string);
1730 p->flags |= TERMP_NOSPACE;
1731 term_word(p, "BSD");
1733 term_word(p, "BSD");
1737 if (NULL != (n = n->next)) {
1738 p->flags |= TERMP_NOSPACE;
1740 p->flags |= TERMP_NOSPACE;
1741 term_word(p, n->string);
1750 termp_xx_pre(DECL_ARGS)
1783 p->flags |= TERMP_KEEP;
1784 term_word(p, n->child->string);
1793 termp_pf_post(DECL_ARGS)
1796 p->flags |= TERMP_NOSPACE;
1802 termp_ss_pre(DECL_ARGS)
1812 term_fontpush(p, TERMFONT_BOLD);
1813 p->offset = term_len(p, (p->defindent+1)/2);
1825 termp_ss_post(DECL_ARGS)
1828 if (MDOC_HEAD == n->type)
1835 termp_cd_pre(DECL_ARGS)
1839 term_fontpush(p, TERMFONT_BOLD);
1846 termp_in_pre(DECL_ARGS)
1851 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1852 term_fontpush(p, TERMFONT_BOLD);
1853 term_word(p, "#include");
1857 term_fontpush(p, TERMFONT_UNDER);
1860 p->flags |= TERMP_NOSPACE;
1867 termp_in_post(DECL_ARGS)
1870 if (MDOC_SYNPRETTY & n->flags)
1871 term_fontpush(p, TERMFONT_BOLD);
1873 p->flags |= TERMP_NOSPACE;
1876 if (MDOC_SYNPRETTY & n->flags)
1883 termp_sp_pre(DECL_ARGS)
1889 len = n->child ? a2height(p, n->child->string) : 1;
1901 for (i = 0; i < len; i++)
1910 termp_quote_pre(DECL_ARGS)
1913 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1939 term_word(p, "\\(lq");
1960 term_word(p, "\\(oq");
1967 p->flags |= TERMP_NOSPACE;
1974 termp_quote_post(DECL_ARGS)
1977 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1980 p->flags |= TERMP_NOSPACE;
2005 term_word(p, "\\(rq");
2026 term_word(p, "\\(cq");
2037 termp_fo_pre(DECL_ARGS)
2040 if (MDOC_BLOCK == n->type) {
2043 } else if (MDOC_BODY == n->type) {
2044 p->flags |= TERMP_NOSPACE;
2046 p->flags |= TERMP_NOSPACE;
2050 if (NULL == n->child)
2053 /* XXX: we drop non-initial arguments as per groff. */
2055 assert(n->child->string);
2056 term_fontpush(p, TERMFONT_BOLD);
2057 term_word(p, n->child->string);
2064 termp_fo_post(DECL_ARGS)
2067 if (MDOC_BODY != n->type)
2070 p->flags |= TERMP_NOSPACE;
2073 if (MDOC_SYNPRETTY & n->flags) {
2074 p->flags |= TERMP_NOSPACE;
2082 termp_bf_pre(DECL_ARGS)
2085 if (MDOC_HEAD == n->type)
2087 else if (MDOC_BODY != n->type)
2090 if (FONT_Em == n->norm->Bf.font)
2091 term_fontpush(p, TERMFONT_UNDER);
2092 else if (FONT_Sy == n->norm->Bf.font)
2093 term_fontpush(p, TERMFONT_BOLD);
2095 term_fontpush(p, TERMFONT_NONE);
2103 termp_sm_pre(DECL_ARGS)
2106 assert(n->child && MDOC_TEXT == n->child->type);
2107 if (0 == strcmp("on", n->child->string)) {
2109 p->flags &= ~TERMP_NOSPACE;
2110 p->flags &= ~TERMP_NONOSPACE;
2112 p->flags |= TERMP_NONOSPACE;
2120 termp_ap_pre(DECL_ARGS)
2123 p->flags |= TERMP_NOSPACE;
2125 p->flags |= TERMP_NOSPACE;
2132 termp____post(DECL_ARGS)
2136 * Handle lists of authors. In general, print each followed by
2137 * a comma. Don't print the comma if there are only two
2140 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2141 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2142 if (NULL == n->prev || MDOC__A != n->prev->tok)
2147 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2150 p->flags |= TERMP_NOSPACE;
2151 if (NULL == n->next) {
2153 p->flags |= TERMP_SENTENCE;
2161 termp_li_pre(DECL_ARGS)
2164 term_fontpush(p, TERMFONT_NONE);
2171 termp_lk_pre(DECL_ARGS)
2173 const struct mdoc_node *link, *descr;
2175 if (NULL == (link = n->child))
2178 if (NULL != (descr = link->next)) {
2179 term_fontpush(p, TERMFONT_UNDER);
2180 while (NULL != descr) {
2181 term_word(p, descr->string);
2182 descr = descr->next;
2184 p->flags |= TERMP_NOSPACE;
2189 term_fontpush(p, TERMFONT_BOLD);
2190 term_word(p, link->string);
2199 termp_bk_pre(DECL_ARGS)
2208 if (n->parent->args || 0 == n->prev->nchild)
2209 p->flags |= TERMP_PREKEEP;
2222 termp_bk_post(DECL_ARGS)
2225 if (MDOC_BODY == n->type)
2226 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2231 termp__t_post(DECL_ARGS)
2235 * If we're in an `Rs' and there's a journal present, then quote
2236 * us instead of underlining us (for disambiguation).
2238 if (n->parent && MDOC_Rs == n->parent->tok &&
2239 n->parent->norm->Rs.quote_T)
2240 termp_quote_post(p, pair, meta, n);
2242 termp____post(p, pair, meta, n);
2247 termp__t_pre(DECL_ARGS)
2251 * If we're in an `Rs' and there's a journal present, then quote
2252 * us instead of underlining us (for disambiguation).
2254 if (n->parent && MDOC_Rs == n->parent->tok &&
2255 n->parent->norm->Rs.quote_T)
2256 return(termp_quote_pre(p, pair, meta, n));
2258 term_fontpush(p, TERMFONT_UNDER);
2264 termp_under_pre(DECL_ARGS)
2267 term_fontpush(p, TERMFONT_UNDER);