1 /* $Id: mdoc_term.c,v 1.256 2013/12/25 14:40:34 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>
5 * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 #include <sys/types.h>
39 struct termpair *ppair;
43 #define DECL_ARGS struct termp *p, \
44 struct termpair *pair, \
45 const struct mdoc_meta *meta, \
49 int (*pre)(DECL_ARGS);
50 void (*post)(DECL_ARGS);
53 static size_t a2width(const struct termp *, const char *);
54 static size_t a2height(const struct termp *, const char *);
55 static size_t a2offs(const struct termp *, const char *);
57 static void print_bvspace(struct termp *,
58 const struct mdoc_node *,
59 const struct mdoc_node *);
60 static void print_mdoc_node(DECL_ARGS);
61 static void print_mdoc_nodelist(DECL_ARGS);
62 static void print_mdoc_head(struct termp *, const void *);
63 static void print_mdoc_foot(struct termp *, const void *);
64 static void synopsis_pre(struct termp *,
65 const struct mdoc_node *);
67 static void termp____post(DECL_ARGS);
68 static void termp__t_post(DECL_ARGS);
69 static void termp_an_post(DECL_ARGS);
70 static void termp_bd_post(DECL_ARGS);
71 static void termp_bk_post(DECL_ARGS);
72 static void termp_bl_post(DECL_ARGS);
73 static void termp_fd_post(DECL_ARGS);
74 static void termp_fo_post(DECL_ARGS);
75 static void termp_in_post(DECL_ARGS);
76 static void termp_it_post(DECL_ARGS);
77 static void termp_lb_post(DECL_ARGS);
78 static void termp_nm_post(DECL_ARGS);
79 static void termp_pf_post(DECL_ARGS);
80 static void termp_quote_post(DECL_ARGS);
81 static void termp_sh_post(DECL_ARGS);
82 static void termp_ss_post(DECL_ARGS);
84 static int termp__a_pre(DECL_ARGS);
85 static int termp__t_pre(DECL_ARGS);
86 static int termp_an_pre(DECL_ARGS);
87 static int termp_ap_pre(DECL_ARGS);
88 static int termp_bd_pre(DECL_ARGS);
89 static int termp_bf_pre(DECL_ARGS);
90 static int termp_bk_pre(DECL_ARGS);
91 static int termp_bl_pre(DECL_ARGS);
92 static int termp_bold_pre(DECL_ARGS);
93 static int termp_bt_pre(DECL_ARGS);
94 static int termp_bx_pre(DECL_ARGS);
95 static int termp_cd_pre(DECL_ARGS);
96 static int termp_d1_pre(DECL_ARGS);
97 static int termp_ex_pre(DECL_ARGS);
98 static int termp_fa_pre(DECL_ARGS);
99 static int termp_fd_pre(DECL_ARGS);
100 static int termp_fl_pre(DECL_ARGS);
101 static int termp_fn_pre(DECL_ARGS);
102 static int termp_fo_pre(DECL_ARGS);
103 static int termp_ft_pre(DECL_ARGS);
104 static int termp_in_pre(DECL_ARGS);
105 static int termp_it_pre(DECL_ARGS);
106 static int termp_li_pre(DECL_ARGS);
107 static int termp_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 { NULL, 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 { NULL, 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.
312 if (TERMP_KEEP & p->flags) {
313 if (n->prev ? (n->prev->lastline != n->line) :
314 (n->parent && n->parent->line != n->line)) {
315 p->flags &= ~TERMP_KEEP;
316 p->flags |= TERMP_PREKEEP;
321 * After the keep flags have been set up, we may now
322 * produce output. Note that some pre-handlers do so.
327 if (' ' == *n->string && MDOC_LINE & n->flags)
329 if (MDOC_DELIMC & n->flags)
330 p->flags |= TERMP_NOSPACE;
331 term_word(p, n->string);
332 if (MDOC_DELIMO & n->flags)
333 p->flags |= TERMP_NOSPACE;
339 term_tbl(p, n->span);
342 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
343 chld = (*termacts[n->tok].pre)
344 (p, &npair, meta, n);
348 if (chld && n->child)
349 print_mdoc_nodelist(p, &npair, meta, n->child);
352 (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
362 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
364 (void)(*termacts[n->tok].post)(p, &npair, meta, n);
367 * Explicit end tokens not only call the post
368 * handler, but also tell the respective block
369 * that it must not call the post handler again.
371 if (ENDBODY_NOT != n->end)
372 n->pending->flags |= MDOC_ENDED;
375 * End of line terminating an implicit block
376 * while an explicit block is still open.
377 * Continue the explicit block without spacing.
379 if (ENDBODY_NOSPACE == n->end)
380 p->flags |= TERMP_NOSPACE;
384 if (MDOC_EOS & n->flags)
385 p->flags |= TERMP_SENTENCE;
388 p->rmargin = rmargin;
393 print_mdoc_foot(struct termp *p, const void *arg)
395 const struct mdoc_meta *meta;
397 meta = (const struct mdoc_meta *)arg;
399 term_fontrepl(p, TERMFONT_NONE);
402 * Output the footer in new-groff style, that is, three columns
403 * with the middle being the manual date and flanking columns
404 * being the operating system:
412 p->rmargin = (p->maxrmargin -
413 term_strlen(p, meta->date) + term_len(p, 1)) / 2;
415 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
417 term_word(p, meta->os);
420 p->offset = p->rmargin;
421 p->rmargin = p->maxrmargin - term_strlen(p, meta->os);
422 p->flags |= TERMP_NOSPACE;
424 term_word(p, meta->date);
427 p->offset = p->rmargin;
428 p->rmargin = p->maxrmargin;
430 p->flags &= ~TERMP_NOBREAK;
431 p->flags |= TERMP_NOSPACE;
433 term_word(p, meta->os);
437 p->rmargin = p->maxrmargin;
443 print_mdoc_head(struct termp *p, const void *arg)
445 char buf[BUFSIZ], title[BUFSIZ];
446 size_t buflen, titlen;
447 const struct mdoc_meta *meta;
449 meta = (const struct mdoc_meta *)arg;
452 * The header is strange. It has three components, which are
453 * really two with the first duplicated. It goes like this:
455 * IDENTIFIER TITLE IDENTIFIER
457 * The IDENTIFIER is NAME(SECTION), which is the command-name
458 * (if given, or "unknown" if not) followed by the manual page
459 * section. These are given in `Dt'. The TITLE is a free-form
460 * string depending on the manual volume. If not specified, it
461 * switches on the manual section.
465 p->rmargin = p->maxrmargin;
468 strlcpy(buf, meta->vol, BUFSIZ);
469 buflen = term_strlen(p, buf);
472 strlcat(buf, " (", BUFSIZ);
473 strlcat(buf, meta->arch, BUFSIZ);
474 strlcat(buf, ")", BUFSIZ);
477 snprintf(title, BUFSIZ, "%s(%s)", meta->title, meta->msec);
478 titlen = term_strlen(p, title);
480 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
483 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
485 term_strlen(p, buf) + term_len(p, 1)) / 2 :
486 p->maxrmargin - buflen;
491 p->flags |= TERMP_NOSPACE;
492 p->offset = p->rmargin;
493 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
494 p->maxrmargin - titlen : p->maxrmargin;
499 p->flags &= ~TERMP_NOBREAK;
501 if (p->rmargin + titlen <= p->maxrmargin) {
502 p->flags |= TERMP_NOSPACE;
503 p->offset = p->rmargin;
504 p->rmargin = p->maxrmargin;
509 p->flags &= ~TERMP_NOSPACE;
511 p->rmargin = p->maxrmargin;
516 a2height(const struct termp *p, const char *v)
522 if ( ! a2roffsu(v, &su, SCALE_VS))
523 SCALE_VS_INIT(&su, atoi(v));
525 return(term_vspan(p, &su));
530 a2width(const struct termp *p, const char *v)
535 if ( ! a2roffsu(v, &su, SCALE_MAX))
536 SCALE_HS_INIT(&su, term_strlen(p, v));
538 return(term_hspan(p, &su));
543 a2offs(const struct termp *p, const char *v)
549 else if (0 == strcmp(v, "left"))
551 else if (0 == strcmp(v, "indent"))
552 return(term_len(p, p->defindent + 1));
553 else if (0 == strcmp(v, "indent-two"))
554 return(term_len(p, (p->defindent + 1) * 2));
555 else if ( ! a2roffsu(v, &su, SCALE_MAX))
556 SCALE_HS_INIT(&su, term_strlen(p, v));
558 return(term_hspan(p, &su));
563 * Determine how much space to print out before block elements of `It'
564 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
568 print_bvspace(struct termp *p,
569 const struct mdoc_node *bl,
570 const struct mdoc_node *n)
572 const struct mdoc_node *nn;
578 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
580 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
583 /* Do not vspace directly after Ss/Sh. */
585 for (nn = n; nn; nn = nn->parent) {
586 if (MDOC_BLOCK != nn->type)
588 if (MDOC_Ss == nn->tok)
590 if (MDOC_Sh == nn->tok)
592 if (NULL == nn->prev)
597 /* A `-column' does not assert vspace within the list. */
599 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
600 if (n->prev && MDOC_It == n->prev->tok)
603 /* A `-diag' without body does not vspace. */
605 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
606 if (n->prev && MDOC_It == n->prev->tok) {
607 assert(n->prev->body);
608 if (NULL == n->prev->body->child)
618 termp_it_pre(DECL_ARGS)
620 const struct mdoc_node *bl, *nn;
623 size_t width, offset, ncols, dcol;
626 if (MDOC_BLOCK == n->type) {
627 print_bvspace(p, n->parent->parent, n);
631 bl = n->parent->parent->parent;
632 type = bl->norm->Bl.type;
635 * First calculate width and offset. This is pretty easy unless
636 * we're a -column list, in which case all prior columns must
642 if (bl->norm->Bl.offs)
643 offset = a2offs(p, bl->norm->Bl.offs);
647 if (MDOC_HEAD == n->type)
651 * Imitate groff's column handling:
652 * - For each earlier column, add its width.
653 * - For less than 5 columns, add four more blanks per
655 * - For exactly 5 columns, add three more blank per
657 * - For more than 5 columns, add only one column.
659 ncols = bl->norm->Bl.ncols;
662 dcol = ncols < 5 ? term_len(p, 4) :
663 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
666 * Calculate the offset by applying all prior MDOC_BODY,
667 * so we stop at the MDOC_HEAD (NULL == nn->prev).
670 for (i = 0, nn = n->prev;
671 nn->prev && i < (int)ncols;
673 offset += dcol + a2width
674 (p, bl->norm->Bl.cols[i]);
677 * When exceeding the declared number of columns, leave
678 * the remaining widths at 0. This will later be
679 * adjusted to the default width of 10, or, for the last
680 * column, stretched to the right margin.
686 * Use the declared column widths, extended as explained
687 * in the preceding paragraph.
689 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
692 if (NULL == bl->norm->Bl.width)
696 * Note: buffer the width by 2, which is groff's magic
697 * number for buffering single arguments. See the above
698 * handling for column for how this changes.
700 assert(bl->norm->Bl.width);
701 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
706 * List-type can override the width in the case of fixed-head
707 * values (bullet, dash/hyphen, enum). Tags need a non-zero
719 if (width < term_len(p, 2))
720 width = term_len(p, 2);
724 width = term_len(p, 8);
730 width = term_len(p, 10);
737 * Whitespace control. Inset bodies need an initial space,
738 * while diagonal bodies need two.
741 p->flags |= TERMP_NOSPACE;
745 if (MDOC_BODY == n->type)
746 term_word(p, "\\ \\ ");
749 if (MDOC_BODY == n->type)
756 p->flags |= TERMP_NOSPACE;
760 if (MDOC_HEAD == n->type)
761 term_fontpush(p, TERMFONT_BOLD);
768 * Pad and break control. This is the tricky part. These flags
769 * are documented in term_flushln() in term.c. Note that we're
770 * going to unset all of these flags in termp_it_post() when we
777 * Weird special case.
778 * Very narrow enum lists actually hang.
780 if (width == term_len(p, 2))
781 p->flags |= TERMP_HANG;
788 if (MDOC_HEAD != n->type)
790 p->flags |= TERMP_NOBREAK;
794 if (MDOC_HEAD != n->type)
798 * This is ugly. If `-hang' is specified and the body
799 * is a `Bl' or `Bd', then we want basically to nullify
800 * the "overstep" effect in term_flushln() and treat
801 * this as a `-ohang' list instead.
803 if (n->next->child &&
804 (MDOC_Bl == n->next->child->tok ||
805 MDOC_Bd == n->next->child->tok))
808 p->flags |= TERMP_NOBREAK | TERMP_HANG;
812 if (MDOC_HEAD != n->type)
815 p->flags |= TERMP_NOBREAK;
818 if (NULL == n->next || NULL == n->next->child)
819 p->flags |= TERMP_DANGLE;
822 if (MDOC_HEAD == n->type)
825 if (NULL == n->next) {
826 p->flags &= ~TERMP_NOBREAK;
829 p->flags |= TERMP_NOBREAK;
835 if (MDOC_HEAD != n->type)
837 p->flags |= TERMP_NOBREAK;
845 * Margin control. Set-head-width lists have their right
846 * margins shortened. The body for these lists has the offset
847 * necessarily lengthened. Everybody gets the offset.
855 * Same stipulation as above, regarding `-hang'. We
856 * don't want to recalculate rmargin and offsets when
857 * using `Bd' or `Bl' within `-hang' overstep lists.
859 if (MDOC_HEAD == n->type && n->next->child &&
860 (MDOC_Bl == n->next->child->tok ||
861 MDOC_Bd == n->next->child->tok))
874 if (MDOC_HEAD == n->type)
875 p->rmargin = p->offset + width;
881 p->rmargin = p->offset + width;
883 * XXX - this behaviour is not documented: the
884 * right-most column is filled to the right margin.
886 if (MDOC_HEAD == n->type)
888 if (NULL == n->next && p->rmargin < p->maxrmargin)
889 p->rmargin = p->maxrmargin;
896 * The dash, hyphen, bullet and enum lists all have a special
897 * HEAD character (temporarily bold, in some cases).
900 if (MDOC_HEAD == n->type)
903 term_fontpush(p, TERMFONT_BOLD);
904 term_word(p, "\\[bu]");
910 term_fontpush(p, TERMFONT_BOLD);
911 term_word(p, "\\(hy");
915 (pair->ppair->ppair->count)++;
916 snprintf(buf, sizeof(buf), "%d.",
917 pair->ppair->ppair->count);
925 * If we're not going to process our children, indicate so here.
938 if (MDOC_HEAD == n->type)
942 if (MDOC_HEAD == n->type)
955 termp_it_post(DECL_ARGS)
959 if (MDOC_BLOCK == n->type)
962 type = n->parent->parent->parent->norm->Bl.type;
970 if (MDOC_BODY == n->type)
974 if (MDOC_BODY == n->type)
983 * Now that our output is flushed, we can reset our tags. Since
984 * only `It' sets these flags, we're free to assume that nobody
985 * has munged them in the meanwhile.
988 p->flags &= ~TERMP_DANGLE;
989 p->flags &= ~TERMP_NOBREAK;
990 p->flags &= ~TERMP_HANG;
997 termp_nm_pre(DECL_ARGS)
1000 if (MDOC_BLOCK == n->type) {
1001 p->flags |= TERMP_PREKEEP;
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;
1027 p->rmargin = p->offset + term_len(p, 1);
1028 if (NULL == n->child) {
1029 p->rmargin += term_strlen(p, meta->name);
1030 } else if (MDOC_TEXT == n->child->type) {
1031 p->rmargin += term_strlen(p, n->child->string);
1033 p->flags |= TERMP_HANG;
1035 p->rmargin += term_len(p, 5);
1036 p->flags |= TERMP_HANG;
1040 term_fontpush(p, TERMFONT_BOLD);
1041 if (NULL == n->child)
1042 term_word(p, meta->name);
1049 termp_nm_post(DECL_ARGS)
1052 if (MDOC_BLOCK == n->type) {
1053 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1054 } else if (MDOC_HEAD == n->type && n->next->child) {
1056 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1058 } else if (MDOC_BODY == n->type && n->child)
1065 termp_fl_pre(DECL_ARGS)
1068 term_fontpush(p, TERMFONT_BOLD);
1069 term_word(p, "\\-");
1072 p->flags |= TERMP_NOSPACE;
1073 else if (n->next && n->next->line == n->line)
1074 p->flags |= TERMP_NOSPACE;
1082 termp__a_pre(DECL_ARGS)
1085 if (n->prev && MDOC__A == n->prev->tok)
1086 if (NULL == n->next || MDOC__A != n->next->tok)
1087 term_word(p, "and");
1095 termp_an_pre(DECL_ARGS)
1098 if (NULL == n->child)
1102 * If not in the AUTHORS section, `An -split' will cause
1103 * newlines to occur before the author name. If in the AUTHORS
1104 * section, by default, the first `An' invocation is nosplit,
1105 * then all subsequent ones, regardless of whether interspersed
1106 * with other macros/text, are split. -split, in this case,
1107 * will override the condition of the implied first -nosplit.
1110 if (n->sec == SEC_AUTHORS) {
1111 if ( ! (TERMP_ANPREC & p->flags)) {
1112 if (TERMP_SPLIT & p->flags)
1116 if (TERMP_NOSPLIT & p->flags)
1122 if (TERMP_SPLIT & p->flags)
1131 termp_an_post(DECL_ARGS)
1135 if (SEC_AUTHORS == n->sec)
1136 p->flags |= TERMP_ANPREC;
1140 if (AUTH_split == n->norm->An.auth) {
1141 p->flags &= ~TERMP_NOSPLIT;
1142 p->flags |= TERMP_SPLIT;
1143 } else if (AUTH_nosplit == n->norm->An.auth) {
1144 p->flags &= ~TERMP_SPLIT;
1145 p->flags |= TERMP_NOSPLIT;
1153 termp_ns_pre(DECL_ARGS)
1156 if ( ! (MDOC_LINE & n->flags))
1157 p->flags |= TERMP_NOSPACE;
1164 termp_rs_pre(DECL_ARGS)
1167 if (SEC_SEE_ALSO != n->sec)
1169 if (MDOC_BLOCK == n->type && n->prev)
1177 termp_rv_pre(DECL_ARGS)
1182 term_word(p, "The");
1185 for (n = n->child; n; n = n->next) {
1186 term_fontpush(p, TERMFONT_BOLD);
1187 term_word(p, n->string);
1190 p->flags |= TERMP_NOSPACE;
1193 if (nchild > 2 && n->next) {
1194 p->flags |= TERMP_NOSPACE;
1198 if (n->next && NULL == n->next->next)
1199 term_word(p, "and");
1203 term_word(p, "functions return");
1205 term_word(p, "function returns");
1207 term_word(p, "the value 0 if successful; otherwise the value "
1208 "-1 is returned and the global variable");
1210 term_fontpush(p, TERMFONT_UNDER);
1211 term_word(p, "errno");
1214 term_word(p, "is set to indicate the error.");
1215 p->flags |= TERMP_SENTENCE;
1223 termp_ex_pre(DECL_ARGS)
1228 term_word(p, "The");
1231 for (n = n->child; n; n = n->next) {
1232 term_fontpush(p, TERMFONT_BOLD);
1233 term_word(p, n->string);
1236 if (nchild > 2 && n->next) {
1237 p->flags |= TERMP_NOSPACE;
1241 if (n->next && NULL == n->next->next)
1242 term_word(p, "and");
1246 term_word(p, "utilities exit");
1248 term_word(p, "utility exits");
1250 term_word(p, "0 on success, and >0 if an error occurs.");
1252 p->flags |= TERMP_SENTENCE;
1259 termp_nd_pre(DECL_ARGS)
1262 if (MDOC_BODY != n->type)
1265 #if defined(__OpenBSD__) || defined(__linux__)
1266 term_word(p, "\\(en");
1268 term_word(p, "\\(em");
1276 termp_bl_pre(DECL_ARGS)
1279 return(MDOC_HEAD != n->type);
1285 termp_bl_post(DECL_ARGS)
1288 if (MDOC_BLOCK == n->type)
1294 termp_xr_pre(DECL_ARGS)
1297 if (NULL == (n = n->child))
1300 assert(MDOC_TEXT == n->type);
1301 term_word(p, n->string);
1303 if (NULL == (n = n->next))
1306 p->flags |= TERMP_NOSPACE;
1308 p->flags |= TERMP_NOSPACE;
1310 assert(MDOC_TEXT == n->type);
1311 term_word(p, n->string);
1313 p->flags |= TERMP_NOSPACE;
1320 * This decides how to assert whitespace before any of the SYNOPSIS set
1321 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1325 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1328 * Obviously, if we're not in a SYNOPSIS or no prior macros
1329 * exist, do nothing.
1331 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1335 * If we're the second in a pair of like elements, emit our
1336 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1337 * case we soldier on.
1339 if (n->prev->tok == n->tok &&
1340 MDOC_Ft != n->tok &&
1341 MDOC_Fo != n->tok &&
1342 MDOC_Fn != n->tok) {
1348 * If we're one of the SYNOPSIS set and non-like pair-wise after
1349 * another (or Fn/Fo, which we've let slip through) then assert
1350 * vertical space, else only newline and move on.
1352 switch (n->prev->tok) {
1365 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1378 termp_vt_pre(DECL_ARGS)
1381 if (MDOC_ELEM == n->type) {
1383 return(termp_under_pre(p, pair, meta, n));
1384 } else if (MDOC_BLOCK == n->type) {
1387 } else if (MDOC_HEAD == n->type)
1390 return(termp_under_pre(p, pair, meta, n));
1396 termp_bold_pre(DECL_ARGS)
1399 term_fontpush(p, TERMFONT_BOLD);
1406 termp_fd_pre(DECL_ARGS)
1410 return(termp_bold_pre(p, pair, meta, n));
1416 termp_fd_post(DECL_ARGS)
1425 termp_sh_pre(DECL_ARGS)
1428 /* No vspace between consecutive `Sh' calls. */
1432 if (n->prev && MDOC_Sh == n->prev->tok)
1433 if (NULL == n->prev->body->child)
1438 term_fontpush(p, TERMFONT_BOLD);
1441 p->offset = term_len(p, p->defindent);
1442 if (SEC_AUTHORS == n->sec)
1443 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1454 termp_sh_post(DECL_ARGS)
1473 termp_bt_pre(DECL_ARGS)
1476 term_word(p, "is currently in beta test.");
1477 p->flags |= TERMP_SENTENCE;
1484 termp_lb_post(DECL_ARGS)
1487 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1494 termp_ud_pre(DECL_ARGS)
1497 term_word(p, "currently under development.");
1498 p->flags |= TERMP_SENTENCE;
1505 termp_d1_pre(DECL_ARGS)
1508 if (MDOC_BLOCK != n->type)
1511 p->offset += term_len(p, p->defindent + 1);
1518 termp_ft_pre(DECL_ARGS)
1521 /* NB: MDOC_LINE does not effect this! */
1523 term_fontpush(p, TERMFONT_UNDER);
1530 termp_fn_pre(DECL_ARGS)
1532 size_t width, rmargin = 0;
1535 pretty = MDOC_SYNPRETTY & n->flags;
1539 if (NULL == (n = n->child))
1543 width = term_len(p, 4);
1544 rmargin = p->rmargin;
1545 p->rmargin = p->offset + width;
1546 p->flags |= TERMP_NOBREAK | TERMP_HANG;
1549 assert(MDOC_TEXT == n->type);
1550 term_fontpush(p, TERMFONT_BOLD);
1551 term_word(p, n->string);
1556 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
1557 p->offset = p->rmargin;
1558 p->rmargin = rmargin;
1561 p->flags |= TERMP_NOSPACE;
1563 p->flags |= TERMP_NOSPACE;
1565 for (n = n->next; n; n = n->next) {
1566 assert(MDOC_TEXT == n->type);
1567 term_fontpush(p, TERMFONT_UNDER);
1569 p->flags |= TERMP_NBRWORD;
1570 term_word(p, n->string);
1574 p->flags |= TERMP_NOSPACE;
1579 p->flags |= TERMP_NOSPACE;
1583 p->flags |= TERMP_NOSPACE;
1594 termp_fa_pre(DECL_ARGS)
1596 const struct mdoc_node *nn;
1598 if (n->parent->tok != MDOC_Fo) {
1599 term_fontpush(p, TERMFONT_UNDER);
1603 for (nn = n->child; nn; nn = nn->next) {
1604 term_fontpush(p, TERMFONT_UNDER);
1605 if (MDOC_SYNPRETTY & n->flags)
1606 p->flags |= TERMP_NBRWORD;
1607 term_word(p, nn->string);
1610 if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1611 p->flags |= TERMP_NOSPACE;
1622 termp_bd_pre(DECL_ARGS)
1624 size_t tabwidth, rm, rmax;
1625 struct mdoc_node *nn;
1627 if (MDOC_BLOCK == n->type) {
1628 print_bvspace(p, n, n);
1630 } else if (MDOC_HEAD == n->type)
1633 if (n->norm->Bd.offs)
1634 p->offset += a2offs(p, n->norm->Bd.offs);
1637 * If -ragged or -filled are specified, the block does nothing
1638 * but change the indentation. If -unfilled or -literal are
1639 * specified, text is printed exactly as entered in the display:
1640 * for macro lines, a newline is appended to the line. Blank
1641 * lines are allowed.
1644 if (DISP_literal != n->norm->Bd.type &&
1645 DISP_unfilled != n->norm->Bd.type)
1648 tabwidth = p->tabwidth;
1649 if (DISP_literal == n->norm->Bd.type)
1650 p->tabwidth = term_len(p, 8);
1653 rmax = p->maxrmargin;
1654 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1656 for (nn = n->child; nn; nn = nn->next) {
1657 print_mdoc_node(p, pair, meta, nn);
1659 * If the printed node flushes its own line, then we
1660 * needn't do it here as well. This is hacky, but the
1661 * notion of selective eoln whitespace is pretty dumb
1662 * anyway, so don't sweat it.
1684 if (nn->next && nn->next->line == nn->line)
1687 p->flags |= TERMP_NOSPACE;
1690 p->tabwidth = tabwidth;
1692 p->maxrmargin = rmax;
1699 termp_bd_post(DECL_ARGS)
1703 if (MDOC_BODY != n->type)
1707 rmax = p->maxrmargin;
1709 if (DISP_literal == n->norm->Bd.type ||
1710 DISP_unfilled == n->norm->Bd.type)
1711 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1713 p->flags |= TERMP_NOSPACE;
1717 p->maxrmargin = rmax;
1723 termp_bx_pre(DECL_ARGS)
1726 if (NULL != (n = n->child)) {
1727 term_word(p, n->string);
1728 p->flags |= TERMP_NOSPACE;
1729 term_word(p, "BSD");
1731 term_word(p, "BSD");
1735 if (NULL != (n = n->next)) {
1736 p->flags |= TERMP_NOSPACE;
1738 p->flags |= TERMP_NOSPACE;
1739 term_word(p, n->string);
1748 termp_xx_pre(DECL_ARGS)
1781 p->flags |= TERMP_KEEP;
1782 term_word(p, n->child->string);
1791 termp_pf_post(DECL_ARGS)
1794 p->flags |= TERMP_NOSPACE;
1800 termp_ss_pre(DECL_ARGS)
1810 term_fontpush(p, TERMFONT_BOLD);
1811 p->offset = term_len(p, (p->defindent+1)/2);
1823 termp_ss_post(DECL_ARGS)
1826 if (MDOC_HEAD == n->type)
1833 termp_cd_pre(DECL_ARGS)
1837 term_fontpush(p, TERMFONT_BOLD);
1844 termp_in_pre(DECL_ARGS)
1849 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1850 term_fontpush(p, TERMFONT_BOLD);
1851 term_word(p, "#include");
1855 term_fontpush(p, TERMFONT_UNDER);
1858 p->flags |= TERMP_NOSPACE;
1865 termp_in_post(DECL_ARGS)
1868 if (MDOC_SYNPRETTY & n->flags)
1869 term_fontpush(p, TERMFONT_BOLD);
1871 p->flags |= TERMP_NOSPACE;
1874 if (MDOC_SYNPRETTY & n->flags)
1881 termp_sp_pre(DECL_ARGS)
1887 len = n->child ? a2height(p, n->child->string) : 1;
1899 for (i = 0; i < len; i++)
1908 termp_quote_pre(DECL_ARGS)
1911 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1937 term_word(p, "\\(lq");
1958 term_word(p, "\\(oq");
1965 p->flags |= TERMP_NOSPACE;
1972 termp_quote_post(DECL_ARGS)
1975 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1978 p->flags |= TERMP_NOSPACE;
2003 term_word(p, "\\(rq");
2024 term_word(p, "\\(cq");
2035 termp_fo_pre(DECL_ARGS)
2037 size_t width, rmargin = 0;
2040 pretty = MDOC_SYNPRETTY & n->flags;
2042 if (MDOC_BLOCK == n->type) {
2045 } else if (MDOC_BODY == n->type) {
2047 width = term_len(p, 4);
2048 rmargin = p->rmargin;
2049 p->rmargin = p->offset + width;
2050 p->flags |= TERMP_NOBREAK | TERMP_HANG;
2052 p->flags |= TERMP_NOSPACE;
2054 p->flags |= TERMP_NOSPACE;
2057 p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
2058 p->offset = p->rmargin;
2059 p->rmargin = rmargin;
2064 if (NULL == n->child)
2067 /* XXX: we drop non-initial arguments as per groff. */
2069 assert(n->child->string);
2070 term_fontpush(p, TERMFONT_BOLD);
2071 term_word(p, n->child->string);
2078 termp_fo_post(DECL_ARGS)
2081 if (MDOC_BODY != n->type)
2084 p->flags |= TERMP_NOSPACE;
2087 if (MDOC_SYNPRETTY & n->flags) {
2088 p->flags |= TERMP_NOSPACE;
2097 termp_bf_pre(DECL_ARGS)
2100 if (MDOC_HEAD == n->type)
2102 else if (MDOC_BODY != n->type)
2105 if (FONT_Em == n->norm->Bf.font)
2106 term_fontpush(p, TERMFONT_UNDER);
2107 else if (FONT_Sy == n->norm->Bf.font)
2108 term_fontpush(p, TERMFONT_BOLD);
2110 term_fontpush(p, TERMFONT_NONE);
2118 termp_sm_pre(DECL_ARGS)
2121 assert(n->child && MDOC_TEXT == n->child->type);
2122 if (0 == strcmp("on", n->child->string)) {
2124 p->flags &= ~TERMP_NOSPACE;
2125 p->flags &= ~TERMP_NONOSPACE;
2127 p->flags |= TERMP_NONOSPACE;
2135 termp_ap_pre(DECL_ARGS)
2138 p->flags |= TERMP_NOSPACE;
2140 p->flags |= TERMP_NOSPACE;
2147 termp____post(DECL_ARGS)
2151 * Handle lists of authors. In general, print each followed by
2152 * a comma. Don't print the comma if there are only two
2155 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2156 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2157 if (NULL == n->prev || MDOC__A != n->prev->tok)
2162 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2165 p->flags |= TERMP_NOSPACE;
2166 if (NULL == n->next) {
2168 p->flags |= TERMP_SENTENCE;
2176 termp_li_pre(DECL_ARGS)
2179 term_fontpush(p, TERMFONT_NONE);
2186 termp_lk_pre(DECL_ARGS)
2188 const struct mdoc_node *link, *descr;
2190 if (NULL == (link = n->child))
2193 if (NULL != (descr = link->next)) {
2194 term_fontpush(p, TERMFONT_UNDER);
2195 while (NULL != descr) {
2196 term_word(p, descr->string);
2197 descr = descr->next;
2199 p->flags |= TERMP_NOSPACE;
2204 term_fontpush(p, TERMFONT_BOLD);
2205 term_word(p, link->string);
2214 termp_bk_pre(DECL_ARGS)
2223 if (n->parent->args || 0 == n->prev->nchild)
2224 p->flags |= TERMP_PREKEEP;
2237 termp_bk_post(DECL_ARGS)
2240 if (MDOC_BODY == n->type)
2241 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2246 termp__t_post(DECL_ARGS)
2250 * If we're in an `Rs' and there's a journal present, then quote
2251 * us instead of underlining us (for disambiguation).
2253 if (n->parent && MDOC_Rs == n->parent->tok &&
2254 n->parent->norm->Rs.quote_T)
2255 termp_quote_post(p, pair, meta, n);
2257 termp____post(p, pair, meta, n);
2262 termp__t_pre(DECL_ARGS)
2266 * If we're in an `Rs' and there's a journal present, then quote
2267 * us instead of underlining us (for disambiguation).
2269 if (n->parent && MDOC_Rs == n->parent->tok &&
2270 n->parent->norm->Rs.quote_T)
2271 return(termp_quote_pre(p, pair, meta, n));
2273 term_fontpush(p, TERMFONT_UNDER);
2279 termp_under_pre(DECL_ARGS)
2282 term_fontpush(p, TERMFONT_UNDER);