1 /* $Id: mdoc_term.c,v 1.275 2014/08/06 15:09:05 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2012, 2013, 2014 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>
33 #include "mandoc_aux.h"
40 struct termpair *ppair;
44 #define DECL_ARGS struct termp *p, \
45 struct termpair *pair, \
46 const struct mdoc_meta *meta, \
50 int (*pre)(DECL_ARGS);
51 void (*post)(DECL_ARGS);
54 static size_t a2width(const struct termp *, const char *);
55 static size_t a2height(const struct termp *, const char *);
56 static size_t a2offs(const struct termp *, const char *);
58 static void print_bvspace(struct termp *,
59 const struct mdoc_node *,
60 const struct mdoc_node *);
61 static void print_mdoc_node(DECL_ARGS);
62 static void print_mdoc_nodelist(DECL_ARGS);
63 static void print_mdoc_head(struct termp *, const void *);
64 static void print_mdoc_foot(struct termp *, const void *);
65 static void synopsis_pre(struct termp *,
66 const struct mdoc_node *);
68 static void termp____post(DECL_ARGS);
69 static void termp__t_post(DECL_ARGS);
70 static void termp_an_post(DECL_ARGS);
71 static void termp_bd_post(DECL_ARGS);
72 static void termp_bk_post(DECL_ARGS);
73 static void termp_bl_post(DECL_ARGS);
74 static void termp_fd_post(DECL_ARGS);
75 static void termp_fo_post(DECL_ARGS);
76 static void termp_in_post(DECL_ARGS);
77 static void termp_it_post(DECL_ARGS);
78 static void termp_lb_post(DECL_ARGS);
79 static void termp_nm_post(DECL_ARGS);
80 static void termp_pf_post(DECL_ARGS);
81 static void termp_quote_post(DECL_ARGS);
82 static void termp_sh_post(DECL_ARGS);
83 static void termp_ss_post(DECL_ARGS);
85 static int termp__a_pre(DECL_ARGS);
86 static int termp__t_pre(DECL_ARGS);
87 static int termp_an_pre(DECL_ARGS);
88 static int termp_ap_pre(DECL_ARGS);
89 static int termp_bd_pre(DECL_ARGS);
90 static int termp_bf_pre(DECL_ARGS);
91 static int termp_bk_pre(DECL_ARGS);
92 static int termp_bl_pre(DECL_ARGS);
93 static int termp_bold_pre(DECL_ARGS);
94 static int termp_bt_pre(DECL_ARGS);
95 static int termp_bx_pre(DECL_ARGS);
96 static int termp_cd_pre(DECL_ARGS);
97 static int termp_d1_pre(DECL_ARGS);
98 static int termp_es_pre(DECL_ARGS);
99 static int termp_ex_pre(DECL_ARGS);
100 static int termp_fa_pre(DECL_ARGS);
101 static int termp_fd_pre(DECL_ARGS);
102 static int termp_fl_pre(DECL_ARGS);
103 static int termp_fn_pre(DECL_ARGS);
104 static int termp_fo_pre(DECL_ARGS);
105 static int termp_ft_pre(DECL_ARGS);
106 static int termp_in_pre(DECL_ARGS);
107 static int termp_it_pre(DECL_ARGS);
108 static int termp_li_pre(DECL_ARGS);
109 static int termp_ll_pre(DECL_ARGS);
110 static int termp_lk_pre(DECL_ARGS);
111 static int termp_nd_pre(DECL_ARGS);
112 static int termp_nm_pre(DECL_ARGS);
113 static int termp_ns_pre(DECL_ARGS);
114 static int termp_quote_pre(DECL_ARGS);
115 static int termp_rs_pre(DECL_ARGS);
116 static int termp_rv_pre(DECL_ARGS);
117 static int termp_sh_pre(DECL_ARGS);
118 static int termp_sm_pre(DECL_ARGS);
119 static int termp_sp_pre(DECL_ARGS);
120 static int termp_ss_pre(DECL_ARGS);
121 static int termp_under_pre(DECL_ARGS);
122 static int termp_ud_pre(DECL_ARGS);
123 static int termp_vt_pre(DECL_ARGS);
124 static int termp_xr_pre(DECL_ARGS);
125 static int termp_xx_pre(DECL_ARGS);
127 static const struct termact termacts[MDOC_MAX] = {
128 { termp_ap_pre, NULL }, /* Ap */
129 { NULL, NULL }, /* Dd */
130 { NULL, NULL }, /* Dt */
131 { NULL, NULL }, /* Os */
132 { termp_sh_pre, termp_sh_post }, /* Sh */
133 { termp_ss_pre, termp_ss_post }, /* Ss */
134 { termp_sp_pre, NULL }, /* Pp */
135 { termp_d1_pre, termp_bl_post }, /* D1 */
136 { termp_d1_pre, termp_bl_post }, /* Dl */
137 { termp_bd_pre, termp_bd_post }, /* Bd */
138 { NULL, NULL }, /* Ed */
139 { termp_bl_pre, termp_bl_post }, /* Bl */
140 { NULL, NULL }, /* El */
141 { termp_it_pre, termp_it_post }, /* It */
142 { termp_under_pre, NULL }, /* Ad */
143 { termp_an_pre, termp_an_post }, /* An */
144 { termp_under_pre, NULL }, /* Ar */
145 { termp_cd_pre, NULL }, /* Cd */
146 { termp_bold_pre, NULL }, /* Cm */
147 { NULL, NULL }, /* Dv */
148 { NULL, NULL }, /* Er */
149 { NULL, NULL }, /* Ev */
150 { termp_ex_pre, NULL }, /* Ex */
151 { termp_fa_pre, NULL }, /* Fa */
152 { termp_fd_pre, termp_fd_post }, /* Fd */
153 { termp_fl_pre, NULL }, /* Fl */
154 { termp_fn_pre, NULL }, /* Fn */
155 { termp_ft_pre, NULL }, /* Ft */
156 { termp_bold_pre, NULL }, /* Ic */
157 { termp_in_pre, termp_in_post }, /* In */
158 { termp_li_pre, NULL }, /* Li */
159 { termp_nd_pre, NULL }, /* Nd */
160 { termp_nm_pre, termp_nm_post }, /* Nm */
161 { termp_quote_pre, termp_quote_post }, /* Op */
162 { termp_ft_pre, NULL }, /* Ot */
163 { termp_under_pre, NULL }, /* Pa */
164 { termp_rv_pre, NULL }, /* Rv */
165 { NULL, NULL }, /* St */
166 { termp_under_pre, NULL }, /* Va */
167 { termp_vt_pre, NULL }, /* Vt */
168 { termp_xr_pre, NULL }, /* Xr */
169 { termp__a_pre, termp____post }, /* %A */
170 { termp_under_pre, termp____post }, /* %B */
171 { NULL, termp____post }, /* %D */
172 { termp_under_pre, termp____post }, /* %I */
173 { termp_under_pre, termp____post }, /* %J */
174 { NULL, termp____post }, /* %N */
175 { NULL, termp____post }, /* %O */
176 { NULL, termp____post }, /* %P */
177 { NULL, termp____post }, /* %R */
178 { termp__t_pre, termp__t_post }, /* %T */
179 { NULL, termp____post }, /* %V */
180 { NULL, NULL }, /* Ac */
181 { termp_quote_pre, termp_quote_post }, /* Ao */
182 { termp_quote_pre, termp_quote_post }, /* Aq */
183 { NULL, NULL }, /* At */
184 { NULL, NULL }, /* Bc */
185 { termp_bf_pre, NULL }, /* Bf */
186 { termp_quote_pre, termp_quote_post }, /* Bo */
187 { termp_quote_pre, termp_quote_post }, /* Bq */
188 { termp_xx_pre, NULL }, /* Bsx */
189 { termp_bx_pre, NULL }, /* Bx */
190 { NULL, NULL }, /* Db */
191 { NULL, NULL }, /* Dc */
192 { termp_quote_pre, termp_quote_post }, /* Do */
193 { termp_quote_pre, termp_quote_post }, /* Dq */
194 { NULL, NULL }, /* Ec */ /* FIXME: no space */
195 { NULL, NULL }, /* Ef */
196 { termp_under_pre, NULL }, /* Em */
197 { termp_quote_pre, termp_quote_post }, /* Eo */
198 { termp_xx_pre, NULL }, /* Fx */
199 { termp_bold_pre, NULL }, /* Ms */
200 { NULL, NULL }, /* No */
201 { termp_ns_pre, NULL }, /* Ns */
202 { termp_xx_pre, NULL }, /* Nx */
203 { termp_xx_pre, NULL }, /* Ox */
204 { NULL, NULL }, /* Pc */
205 { NULL, termp_pf_post }, /* Pf */
206 { termp_quote_pre, termp_quote_post }, /* Po */
207 { termp_quote_pre, termp_quote_post }, /* Pq */
208 { NULL, NULL }, /* Qc */
209 { termp_quote_pre, termp_quote_post }, /* Ql */
210 { termp_quote_pre, termp_quote_post }, /* Qo */
211 { termp_quote_pre, termp_quote_post }, /* Qq */
212 { NULL, NULL }, /* Re */
213 { termp_rs_pre, NULL }, /* Rs */
214 { NULL, NULL }, /* Sc */
215 { termp_quote_pre, termp_quote_post }, /* So */
216 { termp_quote_pre, termp_quote_post }, /* Sq */
217 { termp_sm_pre, NULL }, /* Sm */
218 { termp_under_pre, NULL }, /* Sx */
219 { termp_bold_pre, NULL }, /* Sy */
220 { NULL, NULL }, /* Tn */
221 { termp_xx_pre, NULL }, /* Ux */
222 { NULL, NULL }, /* Xc */
223 { NULL, NULL }, /* Xo */
224 { termp_fo_pre, termp_fo_post }, /* Fo */
225 { NULL, NULL }, /* Fc */
226 { termp_quote_pre, termp_quote_post }, /* Oo */
227 { NULL, NULL }, /* Oc */
228 { termp_bk_pre, termp_bk_post }, /* Bk */
229 { NULL, NULL }, /* Ek */
230 { termp_bt_pre, NULL }, /* Bt */
231 { NULL, NULL }, /* Hf */
232 { termp_under_pre, NULL }, /* Fr */
233 { termp_ud_pre, NULL }, /* Ud */
234 { NULL, termp_lb_post }, /* Lb */
235 { termp_sp_pre, NULL }, /* Lp */
236 { termp_lk_pre, NULL }, /* Lk */
237 { termp_under_pre, NULL }, /* Mt */
238 { termp_quote_pre, termp_quote_post }, /* Brq */
239 { termp_quote_pre, termp_quote_post }, /* Bro */
240 { NULL, NULL }, /* Brc */
241 { NULL, termp____post }, /* %C */
242 { termp_es_pre, NULL }, /* Es */
243 { termp_quote_pre, termp_quote_post }, /* En */
244 { termp_xx_pre, NULL }, /* Dx */
245 { NULL, termp____post }, /* %Q */
246 { termp_sp_pre, NULL }, /* br */
247 { termp_sp_pre, NULL }, /* sp */
248 { NULL, termp____post }, /* %U */
249 { NULL, NULL }, /* Ta */
250 { termp_ll_pre, NULL }, /* ll */
255 terminal_mdoc(void *arg, const struct mdoc *mdoc)
257 const struct mdoc_node *n;
258 const struct mdoc_meta *meta;
261 p = (struct termp *)arg;
263 if (0 == p->defindent)
267 p->maxrmargin = p->defrmargin;
268 p->tabwidth = term_len(p, 5);
270 if (NULL == p->symtab)
271 p->symtab = mchars_alloc();
274 meta = mdoc_meta(mdoc);
276 term_begin(p, print_mdoc_head, print_mdoc_foot, meta);
279 if (MDOC_Sh != n->child->tok)
281 print_mdoc_nodelist(p, NULL, meta, n->child);
288 print_mdoc_nodelist(DECL_ARGS)
291 print_mdoc_node(p, pair, meta, n);
293 print_mdoc_nodelist(p, pair, meta, n->next);
297 print_mdoc_node(DECL_ARGS)
300 struct termpair npair;
301 size_t offset, rmargin;
305 rmargin = p->rmargin;
306 n->prev_font = term_fontq(p);
308 memset(&npair, 0, sizeof(struct termpair));
312 * Keeps only work until the end of a line. If a keep was
313 * invoked in a prior line, revert it to PREKEEP.
316 if (TERMP_KEEP & p->flags) {
317 if (n->prev ? (n->prev->lastline != n->line) :
318 (n->parent && n->parent->line != n->line)) {
319 p->flags &= ~TERMP_KEEP;
320 p->flags |= TERMP_PREKEEP;
325 * After the keep flags have been set up, we may now
326 * produce output. Note that some pre-handlers do so.
331 if (' ' == *n->string && MDOC_LINE & n->flags)
333 if (MDOC_DELIMC & n->flags)
334 p->flags |= TERMP_NOSPACE;
335 term_word(p, n->string);
336 if (MDOC_DELIMO & n->flags)
337 p->flags |= TERMP_NOSPACE;
343 term_tbl(p, n->span);
346 if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
347 chld = (*termacts[n->tok].pre)
348 (p, &npair, meta, n);
352 if (chld && n->child)
353 print_mdoc_nodelist(p, &npair, meta, n->child);
356 (ENDBODY_NOT == n->end ? n : n->pending)->prev_font);
366 if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
368 (void)(*termacts[n->tok].post)(p, &npair, meta, n);
371 * Explicit end tokens not only call the post
372 * handler, but also tell the respective block
373 * that it must not call the post handler again.
375 if (ENDBODY_NOT != n->end)
376 n->pending->flags |= MDOC_ENDED;
379 * End of line terminating an implicit block
380 * while an explicit block is still open.
381 * Continue the explicit block without spacing.
383 if (ENDBODY_NOSPACE == n->end)
384 p->flags |= TERMP_NOSPACE;
388 if (MDOC_EOS & n->flags)
389 p->flags |= TERMP_SENTENCE;
391 if (MDOC_ll != n->tok) {
393 p->rmargin = rmargin;
398 print_mdoc_foot(struct termp *p, const void *arg)
400 const struct mdoc_meta *meta;
402 meta = (const struct mdoc_meta *)arg;
404 term_fontrepl(p, TERMFONT_NONE);
407 * Output the footer in new-groff style, that is, three columns
408 * with the middle being the manual date and flanking columns
409 * being the operating system:
417 p->rmargin = (p->maxrmargin -
418 term_strlen(p, meta->date) + term_len(p, 1)) / 2;
420 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
422 term_word(p, meta->os);
425 p->offset = p->rmargin;
426 p->rmargin = p->maxrmargin - term_strlen(p, meta->os);
427 p->flags |= TERMP_NOSPACE;
429 term_word(p, meta->date);
432 p->offset = p->rmargin;
433 p->rmargin = p->maxrmargin;
435 p->flags &= ~TERMP_NOBREAK;
436 p->flags |= TERMP_NOSPACE;
438 term_word(p, meta->os);
442 p->rmargin = p->maxrmargin;
447 print_mdoc_head(struct termp *p, const void *arg)
449 const struct mdoc_meta *meta;
450 char *volume, *title;
451 size_t vollen, titlen;
453 meta = (const struct mdoc_meta *)arg;
456 * The header is strange. It has three components, which are
457 * really two with the first duplicated. It goes like this:
459 * IDENTIFIER TITLE IDENTIFIER
461 * The IDENTIFIER is NAME(SECTION), which is the command-name
462 * (if given, or "unknown" if not) followed by the manual page
463 * section. These are given in `Dt'. The TITLE is a free-form
464 * string depending on the manual volume. If not specified, it
465 * switches on the manual section.
469 p->rmargin = p->maxrmargin;
472 if (NULL == meta->arch)
473 volume = mandoc_strdup(meta->vol);
475 mandoc_asprintf(&volume, "%s (%s)",
476 meta->vol, meta->arch);
477 vollen = term_strlen(p, volume);
479 if (NULL == meta->msec)
480 title = mandoc_strdup(meta->title);
482 mandoc_asprintf(&title, "%s(%s)",
483 meta->title, meta->msec);
484 titlen = term_strlen(p, title);
486 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
489 p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
490 (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
491 p->maxrmargin - vollen;
496 p->flags |= TERMP_NOSPACE;
497 p->offset = p->rmargin;
498 p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
499 p->maxrmargin - titlen : p->maxrmargin;
501 term_word(p, volume);
504 p->flags &= ~TERMP_NOBREAK;
506 if (p->rmargin + titlen <= p->maxrmargin) {
507 p->flags |= TERMP_NOSPACE;
508 p->offset = p->rmargin;
509 p->rmargin = p->maxrmargin;
514 p->flags &= ~TERMP_NOSPACE;
516 p->rmargin = p->maxrmargin;
522 a2height(const struct termp *p, const char *v)
528 if ( ! a2roffsu(v, &su, SCALE_VS))
529 SCALE_VS_INIT(&su, atoi(v));
531 return(term_vspan(p, &su));
535 a2width(const struct termp *p, const char *v)
540 if ( ! a2roffsu(v, &su, SCALE_MAX))
541 SCALE_HS_INIT(&su, term_strlen(p, v));
543 return(term_hspan(p, &su));
547 a2offs(const struct termp *p, const char *v)
553 else if (0 == strcmp(v, "left"))
555 else if (0 == strcmp(v, "indent"))
556 return(term_len(p, p->defindent + 1));
557 else if (0 == strcmp(v, "indent-two"))
558 return(term_len(p, (p->defindent + 1) * 2));
559 else if ( ! a2roffsu(v, &su, SCALE_MAX))
560 SCALE_HS_INIT(&su, term_strlen(p, v));
562 return(term_hspan(p, &su));
566 * Determine how much space to print out before block elements of `It'
567 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
571 print_bvspace(struct termp *p,
572 const struct mdoc_node *bl,
573 const struct mdoc_node *n)
575 const struct mdoc_node *nn;
581 if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
583 if (MDOC_Bl == bl->tok && bl->norm->Bl.comp)
586 /* Do not vspace directly after Ss/Sh. */
588 for (nn = n; nn; nn = nn->parent) {
589 if (MDOC_BLOCK != nn->type)
591 if (MDOC_Ss == nn->tok)
593 if (MDOC_Sh == nn->tok)
595 if (NULL == nn->prev)
600 /* A `-column' does not assert vspace within the list. */
602 if (MDOC_Bl == bl->tok && LIST_column == bl->norm->Bl.type)
603 if (n->prev && MDOC_It == n->prev->tok)
606 /* A `-diag' without body does not vspace. */
608 if (MDOC_Bl == bl->tok && LIST_diag == bl->norm->Bl.type)
609 if (n->prev && MDOC_It == n->prev->tok) {
610 assert(n->prev->body);
611 if (NULL == n->prev->body->child)
620 termp_ll_pre(DECL_ARGS)
623 term_setwidth(p, n->nchild ? n->child->string : NULL);
628 termp_it_pre(DECL_ARGS)
630 const struct mdoc_node *bl, *nn;
633 size_t width, offset, ncols, dcol;
636 if (MDOC_BLOCK == n->type) {
637 print_bvspace(p, n->parent->parent, n);
641 bl = n->parent->parent->parent;
642 type = bl->norm->Bl.type;
645 * First calculate width and offset. This is pretty easy unless
646 * we're a -column list, in which case all prior columns must
652 if (bl->norm->Bl.offs)
653 offset = a2offs(p, bl->norm->Bl.offs);
657 if (MDOC_HEAD == n->type)
661 * Imitate groff's column handling:
662 * - For each earlier column, add its width.
663 * - For less than 5 columns, add four more blanks per
665 * - For exactly 5 columns, add three more blank per
667 * - For more than 5 columns, add only one column.
669 ncols = bl->norm->Bl.ncols;
670 dcol = ncols < 5 ? term_len(p, 4) :
671 ncols == 5 ? term_len(p, 3) : term_len(p, 1);
674 * Calculate the offset by applying all prior MDOC_BODY,
675 * so we stop at the MDOC_HEAD (NULL == nn->prev).
678 for (i = 0, nn = n->prev;
679 nn->prev && i < (int)ncols;
681 offset += dcol + a2width(p,
682 bl->norm->Bl.cols[i]);
685 * When exceeding the declared number of columns, leave
686 * the remaining widths at 0. This will later be
687 * adjusted to the default width of 10, or, for the last
688 * column, stretched to the right margin.
694 * Use the declared column widths, extended as explained
695 * in the preceding paragraph.
697 width = a2width(p, bl->norm->Bl.cols[i]) + dcol;
700 if (NULL == bl->norm->Bl.width)
704 * Note: buffer the width by 2, which is groff's magic
705 * number for buffering single arguments. See the above
706 * handling for column for how this changes.
708 assert(bl->norm->Bl.width);
709 width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
714 * List-type can override the width in the case of fixed-head
715 * values (bullet, dash/hyphen, enum). Tags need a non-zero
727 if (width < term_len(p, 2))
728 width = term_len(p, 2);
732 width = term_len(p, 8);
738 width = term_len(p, 10);
745 * Whitespace control. Inset bodies need an initial space,
746 * while diagonal bodies need two.
749 p->flags |= TERMP_NOSPACE;
753 if (MDOC_BODY == n->type)
754 term_word(p, "\\ \\ ");
757 if (MDOC_BODY == n->type && n->parent->head->nchild)
764 p->flags |= TERMP_NOSPACE;
768 if (MDOC_HEAD == n->type)
769 term_fontpush(p, TERMFONT_BOLD);
776 * Pad and break control. This is the tricky part. These flags
777 * are documented in term_flushln() in term.c. Note that we're
778 * going to unset all of these flags in termp_it_post() when we
785 * Weird special case.
786 * Very narrow enum lists actually hang.
788 if (width == term_len(p, 2))
789 p->flags |= TERMP_HANG;
796 if (MDOC_HEAD != n->type)
798 p->flags |= TERMP_NOBREAK;
802 if (MDOC_HEAD != n->type)
806 * This is ugly. If `-hang' is specified and the body
807 * is a `Bl' or `Bd', then we want basically to nullify
808 * the "overstep" effect in term_flushln() and treat
809 * this as a `-ohang' list instead.
811 if (n->next->child &&
812 (MDOC_Bl == n->next->child->tok ||
813 MDOC_Bd == n->next->child->tok))
816 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
820 if (MDOC_HEAD != n->type)
823 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
826 if (NULL == n->next || NULL == n->next->child)
827 p->flags |= TERMP_DANGLE;
830 if (MDOC_HEAD == n->type)
833 if (NULL == n->next) {
834 p->flags &= ~TERMP_NOBREAK;
837 p->flags |= TERMP_NOBREAK;
843 if (MDOC_HEAD != n->type)
845 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
853 * Margin control. Set-head-width lists have their right
854 * margins shortened. The body for these lists has the offset
855 * necessarily lengthened. Everybody gets the offset.
863 * Same stipulation as above, regarding `-hang'. We
864 * don't want to recalculate rmargin and offsets when
865 * using `Bd' or `Bl' within `-hang' overstep lists.
867 if (MDOC_HEAD == n->type && n->next->child &&
868 (MDOC_Bl == n->next->child->tok ||
869 MDOC_Bd == n->next->child->tok))
882 if (MDOC_HEAD == n->type)
883 p->rmargin = p->offset + width;
886 if (p->rmargin < p->offset)
887 p->rmargin = p->offset;
892 p->rmargin = p->offset + width;
894 * XXX - this behaviour is not documented: the
895 * right-most column is filled to the right margin.
897 if (MDOC_HEAD == n->type)
899 if (NULL == n->next && p->rmargin < p->maxrmargin)
900 p->rmargin = p->maxrmargin;
907 * The dash, hyphen, bullet and enum lists all have a special
908 * HEAD character (temporarily bold, in some cases).
911 if (MDOC_HEAD == n->type)
914 term_fontpush(p, TERMFONT_BOLD);
915 term_word(p, "\\[bu]");
921 term_fontpush(p, TERMFONT_BOLD);
922 term_word(p, "\\(hy");
926 (pair->ppair->ppair->count)++;
927 (void)snprintf(buf, sizeof(buf), "%d.",
928 pair->ppair->ppair->count);
936 * If we're not going to process our children, indicate so here.
949 if (MDOC_HEAD == n->type)
953 if (MDOC_HEAD == n->type)
964 termp_it_post(DECL_ARGS)
968 if (MDOC_BLOCK == n->type)
971 type = n->parent->parent->parent->norm->Bl.type;
979 if (MDOC_BODY == n->type)
983 if (MDOC_BODY == n->type)
992 * Now that our output is flushed, we can reset our tags. Since
993 * only `It' sets these flags, we're free to assume that nobody
994 * has munged them in the meanwhile.
997 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
998 TERMP_DANGLE | TERMP_HANG);
1003 termp_nm_pre(DECL_ARGS)
1006 if (MDOC_BLOCK == n->type) {
1007 p->flags |= TERMP_PREKEEP;
1011 if (MDOC_BODY == n->type) {
1012 if (NULL == n->child)
1014 p->flags |= TERMP_NOSPACE;
1015 p->offset += term_len(p, 1) +
1016 (NULL == n->prev->child ?
1017 term_strlen(p, meta->name) :
1018 MDOC_TEXT == n->prev->child->type ?
1019 term_strlen(p, n->prev->child->string) :
1021 if (p->rmargin < p->offset)
1022 p->rmargin = p->offset;
1026 if (NULL == n->child && NULL == meta->name)
1029 if (MDOC_HEAD == n->type)
1030 synopsis_pre(p, n->parent);
1032 if (MDOC_HEAD == n->type && n->next->child) {
1033 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
1035 p->rmargin = p->offset + term_len(p, 1);
1036 if (NULL == n->child) {
1037 p->rmargin += term_strlen(p, meta->name);
1038 } else if (MDOC_TEXT == n->child->type) {
1039 p->rmargin += term_strlen(p, n->child->string);
1041 p->flags |= TERMP_HANG;
1043 p->rmargin += term_len(p, 5);
1044 p->flags |= TERMP_HANG;
1048 term_fontpush(p, TERMFONT_BOLD);
1049 if (NULL == n->child)
1050 term_word(p, meta->name);
1055 termp_nm_post(DECL_ARGS)
1058 if (MDOC_BLOCK == n->type) {
1059 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
1060 } else if (MDOC_HEAD == n->type && n->next->child) {
1062 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1064 } else if (MDOC_BODY == n->type && n->child)
1069 termp_fl_pre(DECL_ARGS)
1072 term_fontpush(p, TERMFONT_BOLD);
1073 term_word(p, "\\-");
1076 p->flags |= TERMP_NOSPACE;
1077 else if (n->next && n->next->line == n->line)
1078 p->flags |= TERMP_NOSPACE;
1084 termp__a_pre(DECL_ARGS)
1087 if (n->prev && MDOC__A == n->prev->tok)
1088 if (NULL == n->next || MDOC__A != n->next->tok)
1089 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)
1129 termp_an_post(DECL_ARGS)
1133 if (SEC_AUTHORS == n->sec)
1134 p->flags |= TERMP_ANPREC;
1138 if (AUTH_split == n->norm->An.auth) {
1139 p->flags &= ~TERMP_NOSPLIT;
1140 p->flags |= TERMP_SPLIT;
1141 } else if (AUTH_nosplit == n->norm->An.auth) {
1142 p->flags &= ~TERMP_SPLIT;
1143 p->flags |= TERMP_NOSPLIT;
1149 termp_ns_pre(DECL_ARGS)
1152 if ( ! (MDOC_LINE & n->flags))
1153 p->flags |= TERMP_NOSPACE;
1158 termp_rs_pre(DECL_ARGS)
1161 if (SEC_SEE_ALSO != n->sec)
1163 if (MDOC_BLOCK == n->type && n->prev)
1169 termp_rv_pre(DECL_ARGS)
1177 term_word(p, "The");
1179 for (n = n->child; n; n = n->next) {
1180 term_fontpush(p, TERMFONT_BOLD);
1181 term_word(p, n->string);
1184 p->flags |= TERMP_NOSPACE;
1187 if (n->next == NULL)
1191 p->flags |= TERMP_NOSPACE;
1194 if (n->next->next == NULL)
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;");
1205 term_word(p, "Upon successful completion,"
1206 " the value\\~0 is returned;");
1208 term_word(p, "otherwise the value\\~\\-1 is returned"
1209 " and the global variable");
1211 term_fontpush(p, TERMFONT_UNDER);
1212 term_word(p, "errno");
1215 term_word(p, "is set to indicate the error.");
1216 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\\~0");
1247 term_word(p, "utility exits\\~0");
1249 term_word(p, "on success, and\\~>0 if an error occurs.");
1251 p->flags |= TERMP_SENTENCE;
1256 termp_nd_pre(DECL_ARGS)
1259 if (MDOC_BODY != n->type)
1262 #if defined(__OpenBSD__) || defined(__linux__)
1263 term_word(p, "\\(en");
1265 term_word(p, "\\(em");
1271 termp_bl_pre(DECL_ARGS)
1274 return(MDOC_HEAD != n->type);
1278 termp_bl_post(DECL_ARGS)
1281 if (MDOC_BLOCK == n->type)
1286 termp_xr_pre(DECL_ARGS)
1289 if (NULL == (n = n->child))
1292 assert(MDOC_TEXT == n->type);
1293 term_word(p, n->string);
1295 if (NULL == (n = n->next))
1298 p->flags |= TERMP_NOSPACE;
1300 p->flags |= TERMP_NOSPACE;
1302 assert(MDOC_TEXT == n->type);
1303 term_word(p, n->string);
1305 p->flags |= TERMP_NOSPACE;
1312 * This decides how to assert whitespace before any of the SYNOPSIS set
1313 * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
1317 synopsis_pre(struct termp *p, const struct mdoc_node *n)
1320 * Obviously, if we're not in a SYNOPSIS or no prior macros
1321 * exist, do nothing.
1323 if (NULL == n->prev || ! (MDOC_SYNPRETTY & n->flags))
1327 * If we're the second in a pair of like elements, emit our
1328 * newline and return. UNLESS we're `Fo', `Fn', `Fn', in which
1329 * case we soldier on.
1331 if (n->prev->tok == n->tok &&
1332 MDOC_Ft != n->tok &&
1333 MDOC_Fo != n->tok &&
1334 MDOC_Fn != n->tok) {
1340 * If we're one of the SYNOPSIS set and non-like pair-wise after
1341 * another (or Fn/Fo, which we've let slip through) then assert
1342 * vertical space, else only newline and move on.
1344 switch (n->prev->tok) {
1357 if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
1369 termp_vt_pre(DECL_ARGS)
1372 if (MDOC_ELEM == n->type) {
1374 return(termp_under_pre(p, pair, meta, n));
1375 } else if (MDOC_BLOCK == n->type) {
1378 } else if (MDOC_HEAD == n->type)
1381 return(termp_under_pre(p, pair, meta, n));
1385 termp_bold_pre(DECL_ARGS)
1388 term_fontpush(p, TERMFONT_BOLD);
1393 termp_fd_pre(DECL_ARGS)
1397 return(termp_bold_pre(p, pair, meta, n));
1401 termp_fd_post(DECL_ARGS)
1408 termp_sh_pre(DECL_ARGS)
1411 /* No vspace between consecutive `Sh' calls. */
1415 if (n->prev && MDOC_Sh == n->prev->tok)
1416 if (NULL == n->prev->body->child)
1421 term_fontpush(p, TERMFONT_BOLD);
1424 p->offset = term_len(p, p->defindent);
1425 if (SEC_AUTHORS == n->sec)
1426 p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
1435 termp_sh_post(DECL_ARGS)
1452 termp_bt_pre(DECL_ARGS)
1455 term_word(p, "is currently in beta test.");
1456 p->flags |= TERMP_SENTENCE;
1461 termp_lb_post(DECL_ARGS)
1464 if (SEC_LIBRARY == n->sec && MDOC_LINE & n->flags)
1469 termp_ud_pre(DECL_ARGS)
1472 term_word(p, "currently under development.");
1473 p->flags |= TERMP_SENTENCE;
1478 termp_d1_pre(DECL_ARGS)
1481 if (MDOC_BLOCK != n->type)
1484 p->offset += term_len(p, p->defindent + 1);
1489 termp_ft_pre(DECL_ARGS)
1492 /* NB: MDOC_LINE does not effect this! */
1494 term_fontpush(p, TERMFONT_UNDER);
1499 termp_fn_pre(DECL_ARGS)
1504 pretty = MDOC_SYNPRETTY & n->flags;
1508 if (NULL == (n = n->child))
1512 rmargin = p->rmargin;
1513 p->rmargin = p->offset + term_len(p, 4);
1514 p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
1517 assert(MDOC_TEXT == n->type);
1518 term_fontpush(p, TERMFONT_BOLD);
1519 term_word(p, n->string);
1524 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
1525 p->offset = p->rmargin;
1526 p->rmargin = rmargin;
1529 p->flags |= TERMP_NOSPACE;
1531 p->flags |= TERMP_NOSPACE;
1533 for (n = n->next; n; n = n->next) {
1534 assert(MDOC_TEXT == n->type);
1535 term_fontpush(p, TERMFONT_UNDER);
1537 p->flags |= TERMP_NBRWORD;
1538 term_word(p, n->string);
1542 p->flags |= TERMP_NOSPACE;
1547 p->flags |= TERMP_NOSPACE;
1551 p->flags |= TERMP_NOSPACE;
1560 termp_fa_pre(DECL_ARGS)
1562 const struct mdoc_node *nn;
1564 if (n->parent->tok != MDOC_Fo) {
1565 term_fontpush(p, TERMFONT_UNDER);
1569 for (nn = n->child; nn; nn = nn->next) {
1570 term_fontpush(p, TERMFONT_UNDER);
1571 p->flags |= TERMP_NBRWORD;
1572 term_word(p, nn->string);
1575 if (nn->next || (n->next && n->next->tok == MDOC_Fa)) {
1576 p->flags |= TERMP_NOSPACE;
1585 termp_bd_pre(DECL_ARGS)
1587 size_t tabwidth, lm, len, rm, rmax;
1588 struct mdoc_node *nn;
1590 if (MDOC_BLOCK == n->type) {
1591 print_bvspace(p, n, n);
1593 } else if (MDOC_HEAD == n->type)
1596 if (n->norm->Bd.offs)
1597 p->offset += a2offs(p, n->norm->Bd.offs);
1600 * If -ragged or -filled are specified, the block does nothing
1601 * but change the indentation. If -unfilled or -literal are
1602 * specified, text is printed exactly as entered in the display:
1603 * for macro lines, a newline is appended to the line. Blank
1604 * lines are allowed.
1607 if (DISP_literal != n->norm->Bd.type &&
1608 DISP_unfilled != n->norm->Bd.type &&
1609 DISP_centered != n->norm->Bd.type)
1612 tabwidth = p->tabwidth;
1613 if (DISP_literal == n->norm->Bd.type)
1614 p->tabwidth = term_len(p, 8);
1618 rmax = p->maxrmargin;
1619 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1621 for (nn = n->child; nn; nn = nn->next) {
1622 if (DISP_centered == n->norm->Bd.type) {
1623 if (MDOC_TEXT == nn->type) {
1624 len = term_strlen(p, nn->string);
1625 p->offset = len >= rm ? 0 :
1626 lm + len >= rm ? rm - len :
1627 (lm + rm - len) / 2;
1631 print_mdoc_node(p, pair, meta, nn);
1633 * If the printed node flushes its own line, then we
1634 * needn't do it here as well. This is hacky, but the
1635 * notion of selective eoln whitespace is pretty dumb
1636 * anyway, so don't sweat it.
1658 if (nn->next && nn->next->line == nn->line)
1661 p->flags |= TERMP_NOSPACE;
1664 p->tabwidth = tabwidth;
1666 p->maxrmargin = rmax;
1671 termp_bd_post(DECL_ARGS)
1675 if (MDOC_BODY != n->type)
1679 rmax = p->maxrmargin;
1681 if (DISP_literal == n->norm->Bd.type ||
1682 DISP_unfilled == n->norm->Bd.type)
1683 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1685 p->flags |= TERMP_NOSPACE;
1689 p->maxrmargin = rmax;
1693 termp_bx_pre(DECL_ARGS)
1696 if (NULL != (n = n->child)) {
1697 term_word(p, n->string);
1698 p->flags |= TERMP_NOSPACE;
1699 term_word(p, "BSD");
1701 term_word(p, "BSD");
1705 if (NULL != (n = n->next)) {
1706 p->flags |= TERMP_NOSPACE;
1708 p->flags |= TERMP_NOSPACE;
1709 term_word(p, n->string);
1716 termp_xx_pre(DECL_ARGS)
1749 p->flags |= TERMP_KEEP;
1750 term_word(p, n->child->string);
1757 termp_pf_post(DECL_ARGS)
1760 p->flags |= TERMP_NOSPACE;
1764 termp_ss_pre(DECL_ARGS)
1774 term_fontpush(p, TERMFONT_BOLD);
1775 p->offset = term_len(p, (p->defindent+1)/2);
1778 p->offset = term_len(p, p->defindent);
1788 termp_ss_post(DECL_ARGS)
1791 if (n->type == MDOC_HEAD || n->type == MDOC_BODY)
1796 termp_cd_pre(DECL_ARGS)
1800 term_fontpush(p, TERMFONT_BOLD);
1805 termp_in_pre(DECL_ARGS)
1810 if (MDOC_SYNPRETTY & n->flags && MDOC_LINE & n->flags) {
1811 term_fontpush(p, TERMFONT_BOLD);
1812 term_word(p, "#include");
1816 term_fontpush(p, TERMFONT_UNDER);
1819 p->flags |= TERMP_NOSPACE;
1824 termp_in_post(DECL_ARGS)
1827 if (MDOC_SYNPRETTY & n->flags)
1828 term_fontpush(p, TERMFONT_BOLD);
1830 p->flags |= TERMP_NOSPACE;
1833 if (MDOC_SYNPRETTY & n->flags)
1838 termp_sp_pre(DECL_ARGS)
1844 len = n->child ? a2height(p, n->child->string) : 1;
1856 for (i = 0; i < len; i++)
1863 termp_es_pre(DECL_ARGS)
1870 termp_quote_pre(DECL_ARGS)
1873 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1899 term_word(p, "\\(lq");
1902 if (NULL == n->norm->Es ||
1903 NULL == n->norm->Es->child)
1905 term_word(p, n->norm->Es->child->string);
1926 term_word(p, "\\(oq");
1933 p->flags |= TERMP_NOSPACE;
1938 termp_quote_post(DECL_ARGS)
1941 if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
1944 if (MDOC_En != n->tok)
1945 p->flags |= TERMP_NOSPACE;
1970 term_word(p, "\\(rq");
1973 if (NULL != n->norm->Es &&
1974 NULL != n->norm->Es->child &&
1975 NULL != n->norm->Es->child->next) {
1976 p->flags |= TERMP_NOSPACE;
1977 term_word(p, n->norm->Es->child->next->string);
1999 term_word(p, "\\(cq");
2008 termp_fo_pre(DECL_ARGS)
2013 pretty = MDOC_SYNPRETTY & n->flags;
2015 if (MDOC_BLOCK == n->type) {
2018 } else if (MDOC_BODY == n->type) {
2020 rmargin = p->rmargin;
2021 p->rmargin = p->offset + term_len(p, 4);
2022 p->flags |= TERMP_NOBREAK | TERMP_BRIND |
2025 p->flags |= TERMP_NOSPACE;
2027 p->flags |= TERMP_NOSPACE;
2030 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
2032 p->offset = p->rmargin;
2033 p->rmargin = rmargin;
2038 if (NULL == n->child)
2041 /* XXX: we drop non-initial arguments as per groff. */
2043 assert(n->child->string);
2044 term_fontpush(p, TERMFONT_BOLD);
2045 term_word(p, n->child->string);
2050 termp_fo_post(DECL_ARGS)
2053 if (MDOC_BODY != n->type)
2056 p->flags |= TERMP_NOSPACE;
2059 if (MDOC_SYNPRETTY & n->flags) {
2060 p->flags |= TERMP_NOSPACE;
2067 termp_bf_pre(DECL_ARGS)
2070 if (MDOC_HEAD == n->type)
2072 else if (MDOC_BODY != n->type)
2075 if (FONT_Em == n->norm->Bf.font)
2076 term_fontpush(p, TERMFONT_UNDER);
2077 else if (FONT_Sy == n->norm->Bf.font)
2078 term_fontpush(p, TERMFONT_BOLD);
2080 term_fontpush(p, TERMFONT_NONE);
2086 termp_sm_pre(DECL_ARGS)
2089 if (NULL == n->child)
2090 p->flags ^= TERMP_NONOSPACE;
2091 else if (0 == strcmp("on", n->child->string))
2092 p->flags &= ~TERMP_NONOSPACE;
2094 p->flags |= TERMP_NONOSPACE;
2096 if (p->col && ! (TERMP_NONOSPACE & p->flags))
2097 p->flags &= ~TERMP_NOSPACE;
2103 termp_ap_pre(DECL_ARGS)
2106 p->flags |= TERMP_NOSPACE;
2108 p->flags |= TERMP_NOSPACE;
2113 termp____post(DECL_ARGS)
2117 * Handle lists of authors. In general, print each followed by
2118 * a comma. Don't print the comma if there are only two
2121 if (MDOC__A == n->tok && n->next && MDOC__A == n->next->tok)
2122 if (NULL == n->next->next || MDOC__A != n->next->next->tok)
2123 if (NULL == n->prev || MDOC__A != n->prev->tok)
2128 if (NULL == n->parent || MDOC_Rs != n->parent->tok)
2131 p->flags |= TERMP_NOSPACE;
2132 if (NULL == n->next) {
2134 p->flags |= TERMP_SENTENCE;
2140 termp_li_pre(DECL_ARGS)
2143 term_fontpush(p, TERMFONT_NONE);
2148 termp_lk_pre(DECL_ARGS)
2150 const struct mdoc_node *link, *descr;
2152 if (NULL == (link = n->child))
2155 if (NULL != (descr = link->next)) {
2156 term_fontpush(p, TERMFONT_UNDER);
2157 while (NULL != descr) {
2158 term_word(p, descr->string);
2159 descr = descr->next;
2161 p->flags |= TERMP_NOSPACE;
2166 term_fontpush(p, TERMFONT_BOLD);
2167 term_word(p, link->string);
2174 termp_bk_pre(DECL_ARGS)
2183 if (n->parent->args || 0 == n->prev->nchild)
2184 p->flags |= TERMP_PREKEEP;
2195 termp_bk_post(DECL_ARGS)
2198 if (MDOC_BODY == n->type)
2199 p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
2203 termp__t_post(DECL_ARGS)
2207 * If we're in an `Rs' and there's a journal present, then quote
2208 * us instead of underlining us (for disambiguation).
2210 if (n->parent && MDOC_Rs == n->parent->tok &&
2211 n->parent->norm->Rs.quote_T)
2212 termp_quote_post(p, pair, meta, n);
2214 termp____post(p, pair, meta, n);
2218 termp__t_pre(DECL_ARGS)
2222 * If we're in an `Rs' and there's a journal present, then quote
2223 * us instead of underlining us (for disambiguation).
2225 if (n->parent && MDOC_Rs == n->parent->tok &&
2226 n->parent->norm->Rs.quote_T)
2227 return(termp_quote_pre(p, pair, meta, n));
2229 term_fontpush(p, TERMFONT_UNDER);
2234 termp_under_pre(DECL_ARGS)
2237 term_fontpush(p, TERMFONT_UNDER);