1 /* $Id: mdoc_term.c,v 1.249 2013/06/02 18:16:57 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012 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_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_bl_post }, /* D1 */
133 { termp_d1_pre, termp_bl_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, termp_fd_post }, /* 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 { NULL, 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 *meta;
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();
270 meta = mdoc_meta(mdoc);
272 term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
275 print_mdoc_nodelist(p, NULL, meta, n->child);
282 print_mdoc_nodelist(DECL_ARGS)
285 print_mdoc_node(p, pair, meta, n);
287 print_mdoc_nodelist(p, pair, meta, n->next);
293 print_mdoc_node(DECL_ARGS)
296 struct termpair npair;
297 size_t offset, rmargin;
301 rmargin = p->rmargin;
302 n->prev_font = term_fontq(p);
304 memset(&npair, 0, sizeof(struct termpair));
308 * Keeps only work until the end of a line. If a keep was
309 * invoked in a prior line, revert it to PREKEEP.
311 * Also let SYNPRETTY sections behave as if they were wrapped
315 if (TERMP_KEEP & p->flags || MDOC_SYNPRETTY & n->flags) {
316 if (n->prev ? (n->prev->line != n->line) :
317 (n->parent && n->parent->line != n->line)) {
318 p->flags &= ~TERMP_KEEP;
319 p->flags |= TERMP_PREKEEP;
324 * Since SYNPRETTY sections aren't "turned off" with `Ek',
325 * we have to intuit whether we should disable formatting.
328 if ( ! (MDOC_SYNPRETTY & n->flags) &&
329 ((n->prev && MDOC_SYNPRETTY & n->prev->flags) ||
330 (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
331 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
334 * After the keep flags have been set up, we may now
335 * produce output. Note that some pre-handlers do so.
340 if (' ' == *n->string && MDOC_LINE & n->flags)
342 if (MDOC_DELIMC & n->flags)
343 p->flags |= TERMP_NOSPACE;
344 term_word(p, n->string);
345 if (MDOC_DELIMO & n->flags)
346 p->flags |= TERMP_NOSPACE;
352 term_tbl(p, n->span);
355 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
356 chld = (*termacts[n->tok].pre)
357 (p, &npair, meta, n);
361 if (chld && n->child)
362 print_mdoc_nodelist(p, &npair, meta, n->child);
365 (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
375 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
377 (void)(*termacts[n->tok].post)(p, &npair, meta, n);
380 * Explicit end tokens not only call the post
381 * handler, but also tell the respective block
382 * that it must not call the post handler again.
384 if (ENDBODY_NOT != n->end)
385 n->pending->flags |= MDOC_ENDED;
388 * End of line terminating an implicit block
389 * while an explicit block is still open.
390 * Continue the explicit block without spacing.
392 if (ENDBODY_NOSPACE == n->end)
393 p->flags |= TERMP_NOSPACE;
397 if (MDOC_EOS & n->flags)
398 p->flags |= TERMP_SENTENCE;
401 p->rmargin = rmargin;
406 print_mdoc_foot(struct termp *p, const void *arg)
408 const struct mdoc_meta *meta;
410 meta = (const struct mdoc_meta *)arg;
412 term_fontrepl(p, TERMFONT_NONE);
415 * Output the footer in new-groff style, that is, three columns
416 * with the middle being the manual date and flanking columns
417 * being the operating system:
425 p->rmargin = (p->maxrmargin -
426 term_strlen(p, meta->date) + term_len(p, 1)) / 2;
427 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
429 term_word(p, meta->os);
432 p->offset = p->rmargin;
433 p->rmargin = p->maxrmargin - term_strlen(p, meta->os);
434 p->flags |= TERMP_NOSPACE;
436 term_word(p, meta->date);
439 p->offset = p->rmargin;
440 p->rmargin = p->maxrmargin;
441 p->flags &= ~TERMP_NOBREAK;
442 p->flags |= TERMP_NOSPACE;
444 term_word(p, meta->os);
448 p->rmargin = p->maxrmargin;
454 print_mdoc_head(struct termp *p, const void *arg)
456 char buf[BUFSIZ], title[BUFSIZ];
457 size_t buflen, titlen;
458 const struct mdoc_meta *meta;
460 meta = (const struct mdoc_meta *)arg;
463 * The header is strange. It has three components, which are
464 * really two with the first duplicated. It goes like this:
466 * IDENTIFIER TITLE IDENTIFIER
468 * The IDENTIFIER is NAME(SECTION), which is the command-name
469 * (if given, or "unknown" if not) followed by the manual page
470 * section. These are given in `Dt'. The TITLE is a free-form
471 * string depending on the manual volume. If not specified, it
472 * switches on the manual section.
476 p->rmargin = p->maxrmargin;
479 strlcpy(buf, meta->vol, BUFSIZ);
480 buflen = term_strlen(p, buf);
483 strlcat(buf, " (", BUFSIZ);
484 strlcat(buf, meta->arch, BUFSIZ);
485 strlcat(buf, ")", BUFSIZ);
488 snprintf(title, BUFSIZ, "%s(%s)", meta->title, meta->msec);
489 titlen = term_strlen(p, title);
491 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
493 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
495 term_strlen(p, buf) + term_len(p, 1)) / 2 :
496 p->maxrmargin - buflen;
501 p->flags |= TERMP_NOSPACE;
502 p->offset = p->rmargin;
503 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
504 p->maxrmargin - titlen : p->maxrmargin;
509 p->flags &= ~TERMP_NOBREAK;
510 if (p->rmargin + titlen <= p->maxrmargin) {
511 p->flags |= TERMP_NOSPACE;
512 p->offset = p->rmargin;
513 p->rmargin = p->maxrmargin;
518 p->flags &= ~TERMP_NOSPACE;
520 p->rmargin = p->maxrmargin;
525 a2height(const struct termp *p, const char *v)
531 if ( ! a2roffsu(v, &su, SCALE_VS))
532 SCALE_VS_INIT(&su, atoi(v));
534 return(term_vspan(p, &su));
539 a2width(const struct termp *p, const char *v)
544 if ( ! a2roffsu(v, &su, SCALE_MAX))
545 SCALE_HS_INIT(&su, term_strlen(p, v));
547 return(term_hspan(p, &su));
552 a2offs(const struct termp *p, const char *v)
558 else if (0 == strcmp(v, "left"))
560 else if (0 == strcmp(v, "indent"))
561 return(term_len(p, p->defindent + 1));
562 else if (0 == strcmp(v, "indent-two"))
563 return(term_len(p, (p->defindent + 1) * 2));
564 else if ( ! a2roffsu(v, &su, SCALE_MAX))
565 SCALE_HS_INIT(&su, term_strlen(p, v));
567 return(term_hspan(p, &su));
572 * Determine how much space to print out before block elements of `It'
573 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
577 print_bvspace(struct termp *p,
578 const struct mdoc_node *bl,
579 const struct mdoc_node *n)
581 const struct mdoc_node *nn;
587 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
589 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
592 /* Do not vspace directly after Ss/Sh. */
594 for (nn = n; nn; nn = nn->parent) {
595 if (MDOC_BLOCK != nn->type)
597 if (MDOC_Ss == nn->tok)
599 if (MDOC_Sh == nn->tok)
601 if (NULL == nn->prev)
606 /* A `-column' does not assert vspace within the list. */
608 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
609 if (n->prev && MDOC_It == n->prev->tok)
612 /* A `-diag' without body does not vspace. */
614 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
615 if (n->prev && MDOC_It == n->prev->tok) {
616 assert(n->prev->body);
617 if (NULL == n->prev->body->child)
627 termp_it_pre(DECL_ARGS)
629 const struct mdoc_node *bl, *nn;
632 size_t width, offset, ncols, dcol;
635 if (MDOC_BLOCK == n->type) {
636 print_bvspace(p, n->parent->parent, n);
640 bl = n->parent->parent->parent;
641 type = bl->norm->Bl.type;
644 * First calculate width and offset. This is pretty easy unless
645 * we're a -column list, in which case all prior columns must
651 if (bl->norm->Bl.offs)
652 offset = a2offs(p, bl->norm->Bl.offs);
656 if (MDOC_HEAD == n->type)
660 * Imitate groff's column handling:
661 * - For each earlier column, add its width.
662 * - For less than 5 columns, add four more blanks per
664 * - For exactly 5 columns, add three more blank per
666 * - For more than 5 columns, add only one column.
668 ncols = bl->norm->Bl.ncols;
671 dcol = ncols < 5 ? term_len(p, 4) :
672 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
675 * Calculate the offset by applying all prior MDOC_BODY,
676 * so we stop at the MDOC_HEAD (NULL == nn->prev).
679 for (i = 0, nn = n->prev;
680 nn->prev && i < (int)ncols;
682 offset += dcol + a2width
683 (p, bl->norm->Bl.cols[i]);
686 * When exceeding the declared number of columns, leave
687 * the remaining widths at 0. This will later be
688 * adjusted to the default width of 10, or, for the last
689 * column, stretched to the right margin.
695 * Use the declared column widths, extended as explained
696 * in the preceding paragraph.
698 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
701 if (NULL == bl->norm->Bl.width)
705 * Note: buffer the width by 2, which is groff's magic
706 * number for buffering single arguments. See the above
707 * handling for column for how this changes.
709 assert(bl->norm->Bl.width);
710 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
715 * List-type can override the width in the case of fixed-head
716 * values (bullet, dash/hyphen, enum). Tags need a non-zero
728 if (width < term_len(p, 2))
729 width = term_len(p, 2);
733 width = term_len(p, 8);
739 width = term_len(p, 10);
746 * Whitespace control. Inset bodies need an initial space,
747 * while diagonal bodies need two.
750 p->flags |= TERMP_NOSPACE;
754 if (MDOC_BODY == n->type)
755 term_word(p, "\\ \\ ");
758 if (MDOC_BODY == n->type)
765 p->flags |= TERMP_NOSPACE;
769 if (MDOC_HEAD == n->type)
770 term_fontpush(p, TERMFONT_BOLD);
777 * Pad and break control. This is the tricky part. These flags
778 * are documented in term_flushln() in term.c. Note that we're
779 * going to unset all of these flags in termp_it_post() when we
786 * Weird special case.
787 * Very narrow enum lists actually hang.
789 if (width == term_len(p, 2))
790 p->flags |= TERMP_HANG;
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 ?
1011 term_strlen(p, meta->name) :
1012 MDOC_TEXT == n->prev->child->type ?
1013 term_strlen(p, n->prev->child->string) :
1018 if (NULL == n->child && NULL == meta->name)
1021 if (MDOC_HEAD == n->type)
1022 synopsis_pre(p, n->parent);
1024 if (MDOC_HEAD == n->type && n->next->child) {
1025 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_HEAD == n->type && n->next->child) {
1053 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1054 } else if (MDOC_BODY == n->type && n->child)
1061 termp_fl_pre(DECL_ARGS)
1064 term_fontpush(p, TERMFONT_BOLD);
1065 term_word(p, "\\-");
1068 p->flags |= TERMP_NOSPACE;
1069 else if (n->next && n->next->line == n->line)
1070 p->flags |= TERMP_NOSPACE;
1078 termp__a_pre(DECL_ARGS)
1081 if (n->prev && MDOC__A == n->prev->tok)
1082 if (NULL == n->next || MDOC__A != n->next->tok)
1083 term_word(p, "and");
1091 termp_an_pre(DECL_ARGS)
1094 if (NULL == n->child)
1098 * If not in the AUTHORS section, `An -split' will cause
1099 * newlines to occur before the author name. If in the AUTHORS
1100 * section, by default, the first `An' invocation is nosplit,
1101 * then all subsequent ones, regardless of whether interspersed
1102 * with other macros/text, are split. -split, in this case,
1103 * will override the condition of the implied first -nosplit.
1106 if (n->sec == SEC_AUTHORS) {
1107 if ( ! (TERMP_ANPREC & p->flags)) {
1108 if (TERMP_SPLIT & p->flags)
1112 if (TERMP_NOSPLIT & p->flags)
1118 if (TERMP_SPLIT & p->flags)
1127 termp_an_post(DECL_ARGS)
1131 if (SEC_AUTHORS == n->sec)
1132 p->flags |= TERMP_ANPREC;
1136 if (AUTH_split == n->norm->An.auth) {
1137 p->flags &= ~TERMP_NOSPLIT;
1138 p->flags |= TERMP_SPLIT;
1139 } else if (AUTH_nosplit == n->norm->An.auth) {
1140 p->flags &= ~TERMP_SPLIT;
1141 p->flags |= TERMP_NOSPLIT;
1149 termp_ns_pre(DECL_ARGS)
1152 if ( ! (MDOC_LINE & n->flags))
1153 p->flags |= TERMP_NOSPACE;
1160 termp_rs_pre(DECL_ARGS)
1163 if (SEC_SEE_ALSO != n->sec)
1165 if (MDOC_BLOCK == n->type && n->prev)
1173 termp_rv_pre(DECL_ARGS)
1178 term_word(p, "The");
1181 for (n = n->child; n; n = n->next) {
1182 term_fontpush(p, TERMFONT_BOLD);
1183 term_word(p, n->string);
1186 p->flags |= TERMP_NOSPACE;
1189 if (nchild > 2 && n->next) {
1190 p->flags |= TERMP_NOSPACE;
1194 if (n->next && NULL == n->next->next)
1195 term_word(p, "and");
1199 term_word(p, "functions return");
1201 term_word(p, "function returns");
1203 term_word(p, "the value 0 if successful; otherwise the value "
1204 "-1 is returned and the global variable");
1206 term_fontpush(p, TERMFONT_UNDER);
1207 term_word(p, "errno");
1210 term_word(p, "is set to indicate the error.");
1211 p->flags |= TERMP_SENTENCE;
1219 termp_ex_pre(DECL_ARGS)
1224 term_word(p, "The");
1227 for (n = n->child; n; n = n->next) {
1228 term_fontpush(p, TERMFONT_BOLD);
1229 term_word(p, n->string);
1232 if (nchild > 2 && n->next) {
1233 p->flags |= TERMP_NOSPACE;
1237 if (n->next && NULL == n->next->next)
1238 term_word(p, "and");
1242 term_word(p, "utilities exit");
1244 term_word(p, "utility exits");
1246 term_word(p, "0 on success, and >0 if an error occurs.");
1248 p->flags |= TERMP_SENTENCE;
1255 termp_nd_pre(DECL_ARGS)
1258 if (MDOC_BODY != n->type)
1261 #if defined(__OpenBSD__) || defined(__linux__)
1262 term_word(p, "\\(en");
1264 term_word(p, "\\(em");
1272 termp_bl_pre(DECL_ARGS)
1275 return(MDOC_HEAD != n->type);
1281 termp_bl_post(DECL_ARGS)
1284 if (MDOC_BLOCK == n->type)
1290 termp_xr_pre(DECL_ARGS)
1293 if (NULL == (n = n->child))
1296 assert(MDOC_TEXT == n->type);
1297 term_word(p, n->string);
1299 if (NULL == (n = n->next))
1302 p->flags |= TERMP_NOSPACE;
1304 p->flags |= TERMP_NOSPACE;
1306 assert(MDOC_TEXT == n->type);
1307 term_word(p, n->string);
1309 p->flags |= TERMP_NOSPACE;
1316 * This decides how to assert whitespace before any of the SYNOPSIS set
1317 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1321 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1324 * Obviously, if we're not in a SYNOPSIS or no prior macros
1325 * exist, do nothing.
1327 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1331 * If we're the second in a pair of like elements, emit our
1332 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1333 * case we soldier on.
1335 if (n->prev->tok == n->tok &&
1336 MDOC_Ft != n->tok &&
1337 MDOC_Fo != n->tok &&
1338 MDOC_Fn != n->tok) {
1344 * If we're one of the SYNOPSIS set and non-like pair-wise after
1345 * another (or Fn/Fo, which we've let slip through) then assert
1346 * vertical space, else only newline and move on.
1348 switch (n->prev->tok) {
1361 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1374 termp_vt_pre(DECL_ARGS)
1377 if (MDOC_ELEM == n->type) {
1379 return(termp_under_pre(p, pair, meta, n));
1380 } else if (MDOC_BLOCK == n->type) {
1383 } else if (MDOC_HEAD == n->type)
1386 return(termp_under_pre(p, pair, meta, n));
1392 termp_bold_pre(DECL_ARGS)
1395 term_fontpush(p, TERMFONT_BOLD);
1402 termp_fd_pre(DECL_ARGS)
1406 return(termp_bold_pre(p, pair, meta, n));
1412 termp_fd_post(DECL_ARGS)
1421 termp_sh_pre(DECL_ARGS)
1424 /* No vspace between consecutive `Sh' calls. */
1428 if (n->prev && MDOC_Sh == n->prev->tok)
1429 if (NULL == n->prev->body->child)
1434 term_fontpush(p, TERMFONT_BOLD);
1437 p->offset = term_len(p, p->defindent);
1438 if (SEC_AUTHORS == n->sec)
1439 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
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, p->defindent + 1);
1514 termp_ft_pre(DECL_ARGS)
1517 /* NB: MDOC_LINE does not effect this! */
1519 term_fontpush(p, TERMFONT_UNDER);
1526 termp_fn_pre(DECL_ARGS)
1530 pretty = MDOC_SYNPRETTY & n->flags;
1534 if (NULL == (n = n->child))
1537 assert(MDOC_TEXT == n->type);
1538 term_fontpush(p, TERMFONT_BOLD);
1539 term_word(p, n->string);
1542 p->flags |= TERMP_NOSPACE;
1544 p->flags |= TERMP_NOSPACE;
1546 for (n = n->next; n; n = n->next) {
1547 assert(MDOC_TEXT == n->type);
1548 term_fontpush(p, TERMFONT_UNDER);
1549 term_word(p, n->string);
1553 p->flags |= TERMP_NOSPACE;
1558 p->flags |= TERMP_NOSPACE;
1562 p->flags |= TERMP_NOSPACE;
1572 termp_fa_pre(DECL_ARGS)
1574 const struct mdoc_node *nn;
1576 if (n->parent->tok != MDOC_Fo) {
1577 term_fontpush(p, TERMFONT_UNDER);
1581 for (nn = n->child; nn; nn = nn->next) {
1582 term_fontpush(p, TERMFONT_UNDER);
1583 term_word(p, nn->string);
1587 p->flags |= TERMP_NOSPACE;
1592 if (n->child && n->next && n->next->tok == MDOC_Fa) {
1593 p->flags |= TERMP_NOSPACE;
1603 termp_bd_pre(DECL_ARGS)
1605 size_t tabwidth, rm, rmax;
1606 struct mdoc_node *nn;
1608 if (MDOC_BLOCK == n->type) {
1609 print_bvspace(p, n, n);
1611 } else if (MDOC_HEAD == n->type)
1614 if (n->norm->Bd.offs)
1615 p->offset += a2offs(p, n->norm->Bd.offs);
1618 * If -ragged or -filled are specified, the block does nothing
1619 * but change the indentation. If -unfilled or -literal are
1620 * specified, text is printed exactly as entered in the display:
1621 * for macro lines, a newline is appended to the line. Blank
1622 * lines are allowed.
1625 if (DISP_literal != n->norm->Bd.type &&
1626 DISP_unfilled != n->norm->Bd.type)
1629 tabwidth = p->tabwidth;
1630 if (DISP_literal == n->norm->Bd.type)
1631 p->tabwidth = term_len(p, 8);
1634 rmax = p->maxrmargin;
1635 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1637 for (nn = n->child; nn; nn = nn->next) {
1638 print_mdoc_node(p, pair, meta, nn);
1640 * If the printed node flushes its own line, then we
1641 * needn't do it here as well. This is hacky, but the
1642 * notion of selective eoln whitespace is pretty dumb
1643 * anyway, so don't sweat it.
1665 if (nn->next && nn->next->line == nn->line)
1668 p->flags |= TERMP_NOSPACE;
1671 p->tabwidth = tabwidth;
1673 p->maxrmargin = rmax;
1680 termp_bd_post(DECL_ARGS)
1684 if (MDOC_BODY != n->type)
1688 rmax = p->maxrmargin;
1690 if (DISP_literal == n->norm->Bd.type ||
1691 DISP_unfilled == n->norm->Bd.type)
1692 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1694 p->flags |= TERMP_NOSPACE;
1698 p->maxrmargin = rmax;
1704 termp_bx_pre(DECL_ARGS)
1707 if (NULL != (n = n->child)) {
1708 term_word(p, n->string);
1709 p->flags |= TERMP_NOSPACE;
1710 term_word(p, "BSD");
1712 term_word(p, "BSD");
1716 if (NULL != (n = n->next)) {
1717 p->flags |= TERMP_NOSPACE;
1719 p->flags |= TERMP_NOSPACE;
1720 term_word(p, n->string);
1729 termp_xx_pre(DECL_ARGS)
1762 p->flags |= TERMP_KEEP;
1763 term_word(p, n->child->string);
1772 termp_igndelim_pre(DECL_ARGS)
1775 p->flags |= TERMP_IGNDELIM;
1782 termp_pf_post(DECL_ARGS)
1785 p->flags |= TERMP_NOSPACE;
1791 termp_ss_pre(DECL_ARGS)
1801 term_fontpush(p, TERMFONT_BOLD);
1802 p->offset = term_len(p, (p->defindent+1)/2);
1814 termp_ss_post(DECL_ARGS)
1817 if (MDOC_HEAD == n->type)
1824 termp_cd_pre(DECL_ARGS)
1828 term_fontpush(p, TERMFONT_BOLD);
1835 termp_in_pre(DECL_ARGS)
1840 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1841 term_fontpush(p, TERMFONT_BOLD);
1842 term_word(p, "#include");
1846 term_fontpush(p, TERMFONT_UNDER);
1849 p->flags |= TERMP_NOSPACE;
1856 termp_in_post(DECL_ARGS)
1859 if (MDOC_SYNPRETTY & n->flags)
1860 term_fontpush(p, TERMFONT_BOLD);
1862 p->flags |= TERMP_NOSPACE;
1865 if (MDOC_SYNPRETTY & n->flags)
1872 termp_sp_pre(DECL_ARGS)
1878 len = n->child ? a2height(p, n->child->string) : 1;
1890 for (i = 0; i < len; i++)
1899 termp_quote_pre(DECL_ARGS)
1902 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1928 term_word(p, "\\(lq");
1949 term_word(p, "\\(oq");
1956 p->flags |= TERMP_NOSPACE;
1963 termp_quote_post(DECL_ARGS)
1966 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1969 p->flags |= TERMP_NOSPACE;
1994 term_word(p, "\\(rq");
2015 term_word(p, "\\(cq");
2026 termp_fo_pre(DECL_ARGS)
2029 if (MDOC_BLOCK == n->type) {
2032 } else if (MDOC_BODY == n->type) {
2033 p->flags |= TERMP_NOSPACE;
2035 p->flags |= TERMP_NOSPACE;
2039 if (NULL == n->child)
2042 /* XXX: we drop non-initial arguments as per groff. */
2044 assert(n->child->string);
2045 term_fontpush(p, TERMFONT_BOLD);
2046 term_word(p, n->child->string);
2053 termp_fo_post(DECL_ARGS)
2056 if (MDOC_BODY != n->type)
2059 p->flags |= TERMP_NOSPACE;
2062 if (MDOC_SYNPRETTY & n->flags) {
2063 p->flags |= TERMP_NOSPACE;
2071 termp_bf_pre(DECL_ARGS)
2074 if (MDOC_HEAD == n->type)
2076 else if (MDOC_BODY != n->type)
2079 if (FONT_Em == n->norm->Bf.font)
2080 term_fontpush(p, TERMFONT_UNDER);
2081 else if (FONT_Sy == n->norm->Bf.font)
2082 term_fontpush(p, TERMFONT_BOLD);
2084 term_fontpush(p, TERMFONT_NONE);
2092 termp_sm_pre(DECL_ARGS)
2095 assert(n->child && MDOC_TEXT == n->child->type);
2096 if (0 == strcmp("on", n->child->string)) {
2098 p->flags &= ~TERMP_NOSPACE;
2099 p->flags &= ~TERMP_NONOSPACE;
2101 p->flags |= TERMP_NONOSPACE;
2109 termp_ap_pre(DECL_ARGS)
2112 p->flags |= TERMP_NOSPACE;
2114 p->flags |= TERMP_NOSPACE;
2121 termp____post(DECL_ARGS)
2125 * Handle lists of authors. In general, print each followed by
2126 * a comma. Don't print the comma if there are only two
2129 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2130 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2131 if (NULL == n->prev || MDOC__A != n->prev->tok)
2136 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2139 p->flags |= TERMP_NOSPACE;
2140 if (NULL == n->next) {
2142 p->flags |= TERMP_SENTENCE;
2150 termp_li_pre(DECL_ARGS)
2153 term_fontpush(p, TERMFONT_NONE);
2160 termp_lk_pre(DECL_ARGS)
2162 const struct mdoc_node *link, *descr;
2164 if (NULL == (link = n->child))
2167 if (NULL != (descr = link->next)) {
2168 term_fontpush(p, TERMFONT_UNDER);
2169 while (NULL != descr) {
2170 term_word(p, descr->string);
2171 descr = descr->next;
2173 p->flags |= TERMP_NOSPACE;
2178 term_fontpush(p, TERMFONT_BOLD);
2179 term_word(p, link->string);
2188 termp_bk_pre(DECL_ARGS)
2197 if (n->parent->args || 0 == n->prev->nchild)
2198 p->flags |= TERMP_PREKEEP;
2211 termp_bk_post(DECL_ARGS)
2214 if (MDOC_BODY == n->type && ! (MDOC_SYNPRETTY & n->flags))
2215 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2220 termp__t_post(DECL_ARGS)
2224 * If we're in an `Rs' and there's a journal present, then quote
2225 * us instead of underlining us (for disambiguation).
2227 if (n->parent && MDOC_Rs == n->parent->tok &&
2228 n->parent->norm->Rs.quote_T)
2229 termp_quote_post(p, pair, meta, n);
2231 termp____post(p, pair, meta, n);
2236 termp__t_pre(DECL_ARGS)
2240 * If we're in an `Rs' and there's a journal present, then quote
2241 * us instead of underlining us (for disambiguation).
2243 if (n->parent && MDOC_Rs == n->parent->tok &&
2244 n->parent->norm->Rs.quote_T)
2245 return(termp_quote_pre(p, pair, meta, n));
2247 term_fontpush(p, TERMFONT_UNDER);
2253 termp_under_pre(DECL_ARGS)
2256 term_fontpush(p, TERMFONT_UNDER);