]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.107 2010/01/01 17:14:30 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
39 struct termpair
*ppair
;
44 #define DECL_ARGS struct termp *p, \
45 struct termpair *pair, \
46 const struct mdoc_meta *m, \
47 const struct mdoc_node *n
50 int (*pre
)(DECL_ARGS
);
51 void (*post
)(DECL_ARGS
);
54 static size_t a2width(const struct mdoc_argv
*, int);
55 static size_t a2height(const struct mdoc_node
*);
56 static size_t a2offs(const struct mdoc_argv
*);
58 static int arg_hasattr(int, const struct mdoc_node
*);
59 static int arg_getattrs(const int *, int *, size_t,
60 const struct mdoc_node
*);
61 static int arg_getattr(int, const struct mdoc_node
*);
62 static int arg_listtype(const struct mdoc_node
*);
63 static void print_bvspace(struct termp
*,
64 const struct mdoc_node
*,
65 const struct mdoc_node
*);
66 static void print_mdoc_node(DECL_ARGS
);
67 static void print_mdoc_head(DECL_ARGS
);
68 static void print_mdoc_nodelist(DECL_ARGS
);
69 static void print_foot(DECL_ARGS
);
71 static void termp____post(DECL_ARGS
);
72 static void termp_an_post(DECL_ARGS
);
73 static void termp_aq_post(DECL_ARGS
);
74 static void termp_bd_post(DECL_ARGS
);
75 static void termp_bl_post(DECL_ARGS
);
76 static void termp_bq_post(DECL_ARGS
);
77 static void termp_brq_post(DECL_ARGS
);
78 static void termp_bx_post(DECL_ARGS
);
79 static void termp_d1_post(DECL_ARGS
);
80 static void termp_dq_post(DECL_ARGS
);
81 static void termp_fd_post(DECL_ARGS
);
82 static void termp_fn_post(DECL_ARGS
);
83 static void termp_fo_post(DECL_ARGS
);
84 static void termp_ft_post(DECL_ARGS
);
85 static void termp_in_post(DECL_ARGS
);
86 static void termp_it_post(DECL_ARGS
);
87 static void termp_lb_post(DECL_ARGS
);
88 static void termp_op_post(DECL_ARGS
);
89 static void termp_pf_post(DECL_ARGS
);
90 static void termp_pq_post(DECL_ARGS
);
91 static void termp_qq_post(DECL_ARGS
);
92 static void termp_sh_post(DECL_ARGS
);
93 static void termp_sq_post(DECL_ARGS
);
94 static void termp_ss_post(DECL_ARGS
);
95 static void termp_vt_post(DECL_ARGS
);
97 static int termp__t_pre(DECL_ARGS
);
98 static int termp_an_pre(DECL_ARGS
);
99 static int termp_ap_pre(DECL_ARGS
);
100 static int termp_aq_pre(DECL_ARGS
);
101 static int termp_bd_pre(DECL_ARGS
);
102 static int termp_bf_pre(DECL_ARGS
);
103 static int termp_bold_pre(DECL_ARGS
);
104 static int termp_bq_pre(DECL_ARGS
);
105 static int termp_brq_pre(DECL_ARGS
);
106 static int termp_bt_pre(DECL_ARGS
);
107 static int termp_cd_pre(DECL_ARGS
);
108 static int termp_d1_pre(DECL_ARGS
);
109 static int termp_dq_pre(DECL_ARGS
);
110 static int termp_ex_pre(DECL_ARGS
);
111 static int termp_fa_pre(DECL_ARGS
);
112 static int termp_fl_pre(DECL_ARGS
);
113 static int termp_fn_pre(DECL_ARGS
);
114 static int termp_fo_pre(DECL_ARGS
);
115 static int termp_ft_pre(DECL_ARGS
);
116 static int termp_in_pre(DECL_ARGS
);
117 static int termp_it_pre(DECL_ARGS
);
118 static int termp_li_pre(DECL_ARGS
);
119 static int termp_lk_pre(DECL_ARGS
);
120 static int termp_nd_pre(DECL_ARGS
);
121 static int termp_nm_pre(DECL_ARGS
);
122 static int termp_ns_pre(DECL_ARGS
);
123 static int termp_op_pre(DECL_ARGS
);
124 static int termp_pf_pre(DECL_ARGS
);
125 static int termp_pq_pre(DECL_ARGS
);
126 static int termp_qq_pre(DECL_ARGS
);
127 static int termp_rs_pre(DECL_ARGS
);
128 static int termp_rv_pre(DECL_ARGS
);
129 static int termp_sh_pre(DECL_ARGS
);
130 static int termp_sm_pre(DECL_ARGS
);
131 static int termp_sp_pre(DECL_ARGS
);
132 static int termp_sq_pre(DECL_ARGS
);
133 static int termp_ss_pre(DECL_ARGS
);
134 static int termp_under_pre(DECL_ARGS
);
135 static int termp_ud_pre(DECL_ARGS
);
136 static int termp_xr_pre(DECL_ARGS
);
137 static int termp_xx_pre(DECL_ARGS
);
139 static const struct termact termacts
[MDOC_MAX
] = {
140 { termp_ap_pre
, NULL
}, /* Ap */
141 { NULL
, NULL
}, /* Dd */
142 { NULL
, NULL
}, /* Dt */
143 { NULL
, NULL
}, /* Os */
144 { termp_sh_pre
, termp_sh_post
}, /* Sh */
145 { termp_ss_pre
, termp_ss_post
}, /* Ss */
146 { termp_sp_pre
, NULL
}, /* Pp */
147 { termp_d1_pre
, termp_d1_post
}, /* D1 */
148 { termp_d1_pre
, termp_d1_post
}, /* Dl */
149 { termp_bd_pre
, termp_bd_post
}, /* Bd */
150 { NULL
, NULL
}, /* Ed */
151 { NULL
, termp_bl_post
}, /* Bl */
152 { NULL
, NULL
}, /* El */
153 { termp_it_pre
, termp_it_post
}, /* It */
154 { NULL
, NULL
}, /* Ad */
155 { termp_an_pre
, termp_an_post
}, /* An */
156 { termp_under_pre
, NULL
}, /* Ar */
157 { termp_cd_pre
, NULL
}, /* Cd */
158 { termp_bold_pre
, NULL
}, /* Cm */
159 { NULL
, NULL
}, /* Dv */
160 { NULL
, NULL
}, /* Er */
161 { NULL
, NULL
}, /* Ev */
162 { termp_ex_pre
, NULL
}, /* Ex */
163 { termp_fa_pre
, NULL
}, /* Fa */
164 { termp_bold_pre
, termp_fd_post
}, /* Fd */
165 { termp_fl_pre
, NULL
}, /* Fl */
166 { termp_fn_pre
, termp_fn_post
}, /* Fn */
167 { termp_ft_pre
, termp_ft_post
}, /* Ft */
168 { termp_bold_pre
, NULL
}, /* Ic */
169 { termp_in_pre
, termp_in_post
}, /* In */
170 { termp_li_pre
, NULL
}, /* Li */
171 { termp_nd_pre
, NULL
}, /* Nd */
172 { termp_nm_pre
, NULL
}, /* Nm */
173 { termp_op_pre
, termp_op_post
}, /* Op */
174 { NULL
, NULL
}, /* Ot */
175 { termp_under_pre
, NULL
}, /* Pa */
176 { termp_rv_pre
, NULL
}, /* Rv */
177 { NULL
, NULL
}, /* St */
178 { termp_under_pre
, NULL
}, /* Va */
179 { termp_under_pre
, termp_vt_post
}, /* Vt */
180 { termp_xr_pre
, NULL
}, /* Xr */
181 { NULL
, termp____post
}, /* %A */
182 { termp_under_pre
, termp____post
}, /* %B */
183 { NULL
, termp____post
}, /* %D */
184 { termp_under_pre
, termp____post
}, /* %I */
185 { termp_under_pre
, termp____post
}, /* %J */
186 { NULL
, termp____post
}, /* %N */
187 { NULL
, termp____post
}, /* %O */
188 { NULL
, termp____post
}, /* %P */
189 { NULL
, termp____post
}, /* %R */
190 { termp__t_pre
, termp____post
}, /* %T */
191 { NULL
, termp____post
}, /* %V */
192 { NULL
, NULL
}, /* Ac */
193 { termp_aq_pre
, termp_aq_post
}, /* Ao */
194 { termp_aq_pre
, termp_aq_post
}, /* Aq */
195 { NULL
, NULL
}, /* At */
196 { NULL
, NULL
}, /* Bc */
197 { termp_bf_pre
, NULL
}, /* Bf */
198 { termp_bq_pre
, termp_bq_post
}, /* Bo */
199 { termp_bq_pre
, termp_bq_post
}, /* Bq */
200 { termp_xx_pre
, NULL
}, /* Bsx */
201 { NULL
, termp_bx_post
}, /* Bx */
202 { NULL
, NULL
}, /* Db */
203 { NULL
, NULL
}, /* Dc */
204 { termp_dq_pre
, termp_dq_post
}, /* Do */
205 { termp_dq_pre
, termp_dq_post
}, /* Dq */
206 { NULL
, NULL
}, /* Ec */
207 { NULL
, NULL
}, /* Ef */
208 { termp_under_pre
, NULL
}, /* Em */
209 { NULL
, NULL
}, /* Eo */
210 { termp_xx_pre
, NULL
}, /* Fx */
211 { termp_bold_pre
, NULL
}, /* Ms */ /* FIXME: convert to symbol? */
212 { NULL
, NULL
}, /* No */
213 { termp_ns_pre
, NULL
}, /* Ns */
214 { termp_xx_pre
, NULL
}, /* Nx */
215 { termp_xx_pre
, NULL
}, /* Ox */
216 { NULL
, NULL
}, /* Pc */
217 { termp_pf_pre
, termp_pf_post
}, /* Pf */
218 { termp_pq_pre
, termp_pq_post
}, /* Po */
219 { termp_pq_pre
, termp_pq_post
}, /* Pq */
220 { NULL
, NULL
}, /* Qc */
221 { termp_sq_pre
, termp_sq_post
}, /* Ql */
222 { termp_qq_pre
, termp_qq_post
}, /* Qo */
223 { termp_qq_pre
, termp_qq_post
}, /* Qq */
224 { NULL
, NULL
}, /* Re */
225 { termp_rs_pre
, NULL
}, /* Rs */
226 { NULL
, NULL
}, /* Sc */
227 { termp_sq_pre
, termp_sq_post
}, /* So */
228 { termp_sq_pre
, termp_sq_post
}, /* Sq */
229 { termp_sm_pre
, NULL
}, /* Sm */
230 { termp_under_pre
, NULL
}, /* Sx */
231 { termp_bold_pre
, NULL
}, /* Sy */
232 { NULL
, NULL
}, /* Tn */
233 { termp_xx_pre
, NULL
}, /* Ux */
234 { NULL
, NULL
}, /* Xc */
235 { NULL
, NULL
}, /* Xo */
236 { termp_fo_pre
, termp_fo_post
}, /* Fo */
237 { NULL
, NULL
}, /* Fc */
238 { termp_op_pre
, termp_op_post
}, /* Oo */
239 { NULL
, NULL
}, /* Oc */
240 { NULL
, NULL
}, /* Bk */
241 { NULL
, NULL
}, /* Ek */
242 { termp_bt_pre
, NULL
}, /* Bt */
243 { NULL
, NULL
}, /* Hf */
244 { NULL
, NULL
}, /* Fr */
245 { termp_ud_pre
, NULL
}, /* Ud */
246 { NULL
, termp_lb_post
}, /* Lb */
247 { termp_sp_pre
, NULL
}, /* Lp */
248 { termp_lk_pre
, NULL
}, /* Lk */
249 { termp_under_pre
, NULL
}, /* Mt */
250 { termp_brq_pre
, termp_brq_post
}, /* Brq */
251 { termp_brq_pre
, termp_brq_post
}, /* Bro */
252 { NULL
, NULL
}, /* Brc */
253 { NULL
, termp____post
}, /* %C */
254 { NULL
, NULL
}, /* Es */ /* TODO */
255 { NULL
, NULL
}, /* En */ /* TODO */
256 { termp_xx_pre
, NULL
}, /* Dx */
257 { NULL
, termp____post
}, /* %Q */
258 { termp_sp_pre
, NULL
}, /* br */
259 { termp_sp_pre
, NULL
}, /* sp */
260 { termp_under_pre
, termp____post
}, /* %U */
265 terminal_mdoc(void *arg
, const struct mdoc
*mdoc
)
267 const struct mdoc_node
*n
;
268 const struct mdoc_meta
*m
;
271 p
= (struct termp
*)arg
;
273 if (NULL
== p
->symtab
)
275 case (TERMENC_ASCII
):
276 p
->symtab
= chars_init(CHARS_ASCII
);
286 print_mdoc_head(p
, NULL
, m
, n
);
288 print_mdoc_nodelist(p
, NULL
, m
, n
->child
);
289 print_foot(p
, NULL
, m
, n
);
294 print_mdoc_nodelist(DECL_ARGS
)
297 print_mdoc_node(p
, pair
, m
, n
);
299 print_mdoc_nodelist(p
, pair
, m
, n
->next
);
305 print_mdoc_node(DECL_ARGS
)
309 struct termpair npair
;
310 size_t offset
, rmargin
;
314 rmargin
= p
->rmargin
;
315 font
= term_fontq(p
);
317 memset(&npair
, 0, sizeof(struct termpair
));
320 if (MDOC_TEXT
!= n
->type
) {
321 if (termacts
[n
->tok
].pre
)
322 chld
= (*termacts
[n
->tok
].pre
)(p
, &npair
, m
, n
);
324 term_word(p
, n
->string
);
326 if (chld
&& n
->child
)
327 print_mdoc_nodelist(p
, &npair
, m
, n
->child
);
329 term_fontpopq(p
, font
);
331 if (MDOC_TEXT
!= n
->type
)
332 if (termacts
[n
->tok
].post
)
333 (*termacts
[n
->tok
].post
)(p
, &npair
, m
, n
);
336 p
->rmargin
= rmargin
;
342 print_foot(DECL_ARGS
)
344 char buf
[DATESIZ
], os
[BUFSIZ
];
346 term_fontrepl(p
, TERMFONT_NONE
);
349 * Output the footer in new-groff style, that is, three columns
350 * with the middle being the manual date and flanking columns
351 * being the operating system:
356 time2a(m
->date
, buf
, DATESIZ
);
357 strlcpy(os
, m
->os
, BUFSIZ
);
362 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
363 p
->flags
|= TERMP_NOSPACE
| TERMP_NOBREAK
;
368 p
->offset
= p
->rmargin
;
369 p
->rmargin
= p
->maxrmargin
- strlen(os
);
370 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
375 p
->offset
= p
->rmargin
;
376 p
->rmargin
= p
->maxrmargin
;
377 p
->flags
&= ~TERMP_NOBREAK
;
378 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
384 p
->rmargin
= p
->maxrmargin
;
391 print_mdoc_head(DECL_ARGS
)
393 char buf
[BUFSIZ
], title
[BUFSIZ
];
395 p
->rmargin
= p
->maxrmargin
;
399 * The header is strange. It has three components, which are
400 * really two with the first duplicated. It goes like this:
402 * IDENTIFIER TITLE IDENTIFIER
404 * The IDENTIFIER is NAME(SECTION), which is the command-name
405 * (if given, or "unknown" if not) followed by the manual page
406 * section. These are given in `Dt'. The TITLE is a free-form
407 * string depending on the manual volume. If not specified, it
408 * switches on the manual section.
412 strlcpy(buf
, m
->vol
, BUFSIZ
);
415 strlcat(buf
, " (", BUFSIZ
);
416 strlcat(buf
, m
->arch
, BUFSIZ
);
417 strlcat(buf
, ")", BUFSIZ
);
420 snprintf(title
, BUFSIZ
, "%s(%d)", m
->title
, m
->msec
);
423 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
424 p
->flags
|= TERMP_NOBREAK
| TERMP_NOSPACE
;
429 p
->offset
= p
->rmargin
;
430 p
->rmargin
= p
->maxrmargin
- strlen(title
);
431 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
436 p
->offset
= p
->rmargin
;
437 p
->rmargin
= p
->maxrmargin
;
438 p
->flags
&= ~TERMP_NOBREAK
;
439 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
445 p
->rmargin
= p
->maxrmargin
;
446 p
->flags
&= ~TERMP_NOSPACE
;
451 a2height(const struct mdoc_node
*n
)
455 assert(MDOC_TEXT
== n
->type
);
457 if ( ! a2roffsu(n
->string
, &su
, SCALE_VS
))
458 SCALE_VS_INIT(&su
, strlen(n
->string
));
460 return(term_vspan(&su
));
465 a2width(const struct mdoc_argv
*arg
, int pos
)
469 assert(arg
->value
[pos
]);
470 if ( ! a2roffsu(arg
->value
[pos
], &su
, SCALE_MAX
))
471 SCALE_HS_INIT(&su
, strlen(arg
->value
[pos
]));
474 * This is a bit if a magic number on groff's part. Be careful
475 * in changing it, as the MDOC_Column handler will subtract one
476 * from this for >5 columns (don't go below zero!).
478 return(term_hspan(&su
) + 2);
483 arg_listtype(const struct mdoc_node
*n
)
487 assert(MDOC_BLOCK
== n
->type
);
489 len
= (int)(n
->args
? n
->args
->argc
: 0);
491 for (i
= 0; i
< len
; i
++)
492 switch (n
->args
->argv
[i
].arg
) {
514 return(n
->args
->argv
[i
].arg
);
524 a2offs(const struct mdoc_argv
*arg
)
528 if ('\0' == arg
->value
[0][0])
530 else if (0 == strcmp(arg
->value
[0], "left"))
532 else if (0 == strcmp(arg
->value
[0], "indent"))
534 else if (0 == strcmp(arg
->value
[0], "indent-two"))
535 return((INDENT
+ 1) * 2);
536 else if ( ! a2roffsu(arg
->value
[0], &su
, SCALE_MAX
))
537 SCALE_HS_INIT(&su
, strlen(arg
->value
[0]));
539 return(term_hspan(&su
));
544 arg_hasattr(int arg
, const struct mdoc_node
*n
)
547 return(-1 != arg_getattr(arg
, n
));
552 arg_getattr(int v
, const struct mdoc_node
*n
)
556 return(arg_getattrs(&v
, &val
, 1, n
) ? val
: -1);
561 arg_getattrs(const int *keys
, int *vals
,
562 size_t sz
, const struct mdoc_node
*n
)
569 for (k
= i
= 0; i
< (int)n
->args
->argc
; i
++)
570 for (j
= 0; j
< (int)sz
; j
++)
571 if (n
->args
->argv
[i
].arg
== keys
[j
]) {
580 print_bvspace(struct termp
*p
,
581 const struct mdoc_node
*bl
,
582 const struct mdoc_node
*n
)
584 const struct mdoc_node
*nn
;
587 if (arg_hasattr(MDOC_Compact
, bl
))
590 /* Do not vspace directly after Ss/Sh. */
592 for (nn
= n
; nn
; nn
= nn
->parent
) {
593 if (MDOC_BLOCK
!= nn
->type
)
595 if (MDOC_Ss
== nn
->tok
)
597 if (MDOC_Sh
== nn
->tok
)
599 if (NULL
== nn
->prev
)
604 /* A `-column' does not assert vspace within the list. */
606 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Column
, bl
))
607 if (n
->prev
&& MDOC_It
== n
->prev
->tok
)
610 /* A `-diag' without body does not vspace. */
612 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Diag
, bl
))
613 if (n
->prev
&& MDOC_It
== n
->prev
->tok
) {
614 assert(n
->prev
->body
);
615 if (NULL
== n
->prev
->body
->child
)
625 termp_dq_pre(DECL_ARGS
)
628 if (MDOC_BODY
!= n
->type
)
631 term_word(p
, "\\(lq");
632 p
->flags
|= TERMP_NOSPACE
;
639 termp_dq_post(DECL_ARGS
)
642 if (MDOC_BODY
!= n
->type
)
645 p
->flags
|= TERMP_NOSPACE
;
646 term_word(p
, "\\(rq");
652 termp_it_pre(DECL_ARGS
)
654 const struct mdoc_node
*bl
, *nn
;
656 int i
, type
, keys
[3], vals
[3];
657 size_t width
, offset
, ncols
;
660 if (MDOC_BLOCK
== n
->type
) {
661 print_bvspace(p
, n
->parent
->parent
, n
);
665 bl
= n
->parent
->parent
->parent
;
667 /* Save parent attributes. */
669 pair
->flag
= p
->flags
;
671 /* Get list width and offset. */
673 keys
[0] = MDOC_Width
;
674 keys
[1] = MDOC_Offset
;
675 keys
[2] = MDOC_Column
;
677 vals
[0] = vals
[1] = vals
[2] = -1;
681 (void)arg_getattrs(keys
, vals
, 3, bl
);
683 type
= arg_listtype(bl
);
687 offset
= a2offs(&bl
->args
->argv
[vals
[1]]);
689 /* Calculate real width and offset. */
693 if (MDOC_BODY
== n
->type
)
697 * Imitate groff's column handling.
698 * For each earlier column, add its width.
699 * For less than 5 columns, add two more blanks per column.
700 * For exactly 5 columns, add only one more blank per column.
701 * For more than 5 columns, SUBTRACT one column. We can
702 * do this because a2width() pads exactly 2 spaces.
704 ncols
= bl
->args
->argv
[vals
[2]].sz
;
705 dcol
= ncols
< 5 ? 2 : ncols
== 5 ? 1 : -1;
706 for (i
=0, nn
=n
->prev
; nn
&& i
< (int)ncols
; nn
=nn
->prev
, i
++)
707 offset
+= a2width(&bl
->args
->argv
[vals
[2]], i
) +
711 * Use the declared column widths,
712 * extended as explained in the preceding paragraph.
715 width
= a2width(&bl
->args
->argv
[vals
[2]], i
) +
719 * When exceeding the declared number of columns,
720 * leave the remaining widths at 0.
721 * This will later be adjusted to the default width of 10,
722 * or, for the last column, stretched to the right margin.
727 width
= a2width(&bl
->args
->argv
[vals
[0]], 0);
732 * List-type can override the width in the case of fixed-head
733 * values (bullet, dash/hyphen, enum). Tags need a non-zero
765 * Whitespace control. Inset bodies need an initial space,
766 * while diagonal bodies need two.
769 p
->flags
|= TERMP_NOSPACE
;
773 if (MDOC_BODY
== n
->type
)
774 term_word(p
, "\\ \\ ");
777 if (MDOC_BODY
== n
->type
)
784 p
->flags
|= TERMP_NOSPACE
;
788 if (MDOC_HEAD
== n
->type
)
789 term_fontpush(p
, TERMFONT_BOLD
);
796 * Pad and break control. This is the tricker part. Lists with
797 * set right-margins for the head get TERMP_NOBREAK because, if
798 * they overrun the margin, they wrap to the new margin.
799 * Correspondingly, the body for these types don't left-pad, as
800 * the head will pad out to to the right.
811 if (MDOC_HEAD
== n
->type
)
812 p
->flags
|= TERMP_NOBREAK
;
814 p
->flags
|= TERMP_NOLPAD
;
817 if (MDOC_HEAD
== n
->type
)
818 p
->flags
|= TERMP_NOBREAK
;
820 p
->flags
|= TERMP_NOLPAD
;
822 if (MDOC_HEAD
!= n
->type
)
826 * This is ugly. If `-hang' is specified and the body
827 * is a `Bl' or `Bd', then we want basically to nullify
828 * the "overstep" effect in term_flushln() and treat
829 * this as a `-ohang' list instead.
831 if (n
->next
->child
&&
832 (MDOC_Bl
== n
->next
->child
->tok
||
833 MDOC_Bd
== n
->next
->child
->tok
)) {
834 p
->flags
&= ~TERMP_NOBREAK
;
835 p
->flags
&= ~TERMP_NOLPAD
;
837 p
->flags
|= TERMP_HANG
;
840 if (MDOC_HEAD
== n
->type
)
841 p
->flags
|= TERMP_NOBREAK
| TERMP_TWOSPACE
;
843 p
->flags
|= TERMP_NOLPAD
;
845 if (MDOC_HEAD
!= n
->type
)
847 if (NULL
== n
->next
|| NULL
== n
->next
->child
)
848 p
->flags
|= TERMP_DANGLE
;
851 if (MDOC_HEAD
== n
->type
) {
853 if (MDOC_BODY
== n
->next
->type
)
854 p
->flags
&= ~TERMP_NOBREAK
;
856 p
->flags
|= TERMP_NOBREAK
;
858 p
->flags
|= TERMP_NOLPAD
;
862 if (MDOC_HEAD
== n
->type
)
863 p
->flags
|= TERMP_NOBREAK
;
870 * Margin control. Set-head-width lists have their right
871 * margins shortened. The body for these lists has the offset
872 * necessarily lengthened. Everybody gets the offset.
880 * Same stipulation as above, regarding `-hang'. We
881 * don't want to recalculate rmargin and offsets when
882 * using `Bd' or `Bl' within `-hang' overstep lists.
884 if (MDOC_HEAD
== n
->type
&& n
->next
->child
&&
885 (MDOC_Bl
== n
->next
->child
->tok
||
886 MDOC_Bd
== n
->next
->child
->tok
))
899 if (MDOC_HEAD
== n
->type
)
900 p
->rmargin
= p
->offset
+ width
;
906 p
->rmargin
= p
->offset
+ width
;
908 * XXX - this behaviour is not documented: the
909 * right-most column is filled to the right margin.
911 if (MDOC_HEAD
== n
->type
&&
912 MDOC_BODY
== n
->next
->type
&&
913 p
->rmargin
< p
->maxrmargin
)
914 p
->rmargin
= p
->maxrmargin
;
921 * The dash, hyphen, bullet and enum lists all have a special
922 * HEAD character (temporarily bold, in some cases).
925 if (MDOC_HEAD
== n
->type
)
928 term_fontpush(p
, TERMFONT_BOLD
);
929 term_word(p
, "\\[bu]");
935 term_fontpush(p
, TERMFONT_BOLD
);
936 term_word(p
, "\\(hy");
940 (pair
->ppair
->ppair
->count
)++;
941 (void)snprintf(buf
, sizeof(buf
), "%d.",
942 pair
->ppair
->ppair
->count
);
950 * If we're not going to process our children, indicate so here.
963 if (MDOC_HEAD
== n
->type
)
967 if (MDOC_BODY
== n
->type
)
980 termp_it_post(DECL_ARGS
)
984 if (MDOC_BODY
!= n
->type
&& MDOC_HEAD
!= n
->type
)
987 type
= arg_listtype(n
->parent
->parent
->parent
);
996 if (MDOC_BODY
== n
->type
)
1000 if (MDOC_HEAD
== n
->type
)
1008 p
->flags
= pair
->flag
;
1014 termp_nm_pre(DECL_ARGS
)
1017 if (SEC_SYNOPSIS
== n
->sec
)
1020 term_fontpush(p
, TERMFONT_BOLD
);
1022 if (NULL
== n
->child
)
1023 term_word(p
, m
->name
);
1030 termp_fl_pre(DECL_ARGS
)
1033 term_fontpush(p
, TERMFONT_BOLD
);
1034 term_word(p
, "\\-");
1036 /* A blank `Fl' should incur a subsequent space. */
1039 p
->flags
|= TERMP_NOSPACE
;
1047 termp_an_pre(DECL_ARGS
)
1050 if (NULL
== n
->child
)
1054 * If not in the AUTHORS section, `An -split' will cause
1055 * newlines to occur before the author name. If in the AUTHORS
1056 * section, by default, the first `An' invocation is nosplit,
1057 * then all subsequent ones, regardless of whether interspersed
1058 * with other macros/text, are split. -split, in this case,
1059 * will override the condition of the implied first -nosplit.
1062 if (n
->sec
== SEC_AUTHORS
) {
1063 if ( ! (TERMP_ANPREC
& p
->flags
)) {
1064 if (TERMP_SPLIT
& p
->flags
)
1068 if (TERMP_NOSPLIT
& p
->flags
)
1074 if (TERMP_SPLIT
& p
->flags
)
1083 termp_an_post(DECL_ARGS
)
1087 if (SEC_AUTHORS
== n
->sec
)
1088 p
->flags
|= TERMP_ANPREC
;
1092 if (arg_getattr(MDOC_Split
, n
) > -1) {
1093 p
->flags
&= ~TERMP_NOSPLIT
;
1094 p
->flags
|= TERMP_SPLIT
;
1096 p
->flags
&= ~TERMP_SPLIT
;
1097 p
->flags
|= TERMP_NOSPLIT
;
1105 termp_ns_pre(DECL_ARGS
)
1108 p
->flags
|= TERMP_NOSPACE
;
1115 termp_rs_pre(DECL_ARGS
)
1118 if (SEC_SEE_ALSO
!= n
->sec
)
1120 if (MDOC_BLOCK
== n
->type
&& n
->prev
)
1128 termp_rv_pre(DECL_ARGS
)
1130 const struct mdoc_node
*nn
;
1133 term_word(p
, "The");
1135 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1136 term_fontpush(p
, TERMFONT_BOLD
);
1137 term_word(p
, nn
->string
);
1139 p
->flags
|= TERMP_NOSPACE
;
1140 if (nn
->next
&& NULL
== nn
->next
->next
)
1141 term_word(p
, "(), and");
1143 term_word(p
, "(),");
1149 term_word(p
, "functions return");
1151 term_word(p
, "function returns");
1153 term_word(p
, "the value 0 if successful; otherwise the value "
1154 "-1 is returned and the global variable");
1156 term_fontpush(p
, TERMFONT_UNDER
);
1157 term_word(p
, "errno");
1160 term_word(p
, "is set to indicate the error.");
1168 termp_ex_pre(DECL_ARGS
)
1170 const struct mdoc_node
*nn
;
1172 term_word(p
, "The");
1174 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1175 term_fontpush(p
, TERMFONT_BOLD
);
1176 term_word(p
, nn
->string
);
1178 p
->flags
|= TERMP_NOSPACE
;
1179 if (nn
->next
&& NULL
== nn
->next
->next
)
1180 term_word(p
, ", and");
1184 p
->flags
&= ~TERMP_NOSPACE
;
1188 term_word(p
, "utilities exit");
1190 term_word(p
, "utility exits");
1192 term_word(p
, "0 on success, and >0 if an error occurs.");
1200 termp_nd_pre(DECL_ARGS
)
1203 if (MDOC_BODY
!= n
->type
)
1206 #if defined(__OpenBSD__) || defined(__linux__)
1207 term_word(p
, "\\(en");
1209 term_word(p
, "\\(em");
1217 termp_bl_post(DECL_ARGS
)
1220 if (MDOC_BLOCK
== n
->type
)
1227 termp_op_post(DECL_ARGS
)
1230 if (MDOC_BODY
!= n
->type
)
1232 p
->flags
|= TERMP_NOSPACE
;
1233 term_word(p
, "\\(rB");
1239 termp_xr_pre(DECL_ARGS
)
1241 const struct mdoc_node
*nn
;
1243 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
1246 term_word(p
, nn
->string
);
1247 if (NULL
== (nn
= nn
->next
))
1249 p
->flags
|= TERMP_NOSPACE
;
1251 p
->flags
|= TERMP_NOSPACE
;
1252 term_word(p
, nn
->string
);
1253 p
->flags
|= TERMP_NOSPACE
;
1262 termp_vt_post(DECL_ARGS
)
1265 if (n
->sec
!= SEC_SYNOPSIS
)
1267 if (n
->next
&& MDOC_Vt
== n
->next
->tok
)
1276 termp_bold_pre(DECL_ARGS
)
1279 term_fontpush(p
, TERMFONT_BOLD
);
1286 termp_fd_post(DECL_ARGS
)
1289 if (n
->sec
!= SEC_SYNOPSIS
)
1293 if (n
->next
&& MDOC_Fd
!= n
->next
->tok
)
1300 termp_sh_pre(DECL_ARGS
)
1303 /* No vspace between consecutive `Sh' calls. */
1307 if (n
->prev
&& MDOC_Sh
== n
->prev
->tok
)
1308 if (NULL
== n
->prev
->body
->child
)
1313 term_fontpush(p
, TERMFONT_BOLD
);
1327 termp_sh_post(DECL_ARGS
)
1346 termp_op_pre(DECL_ARGS
)
1351 term_word(p
, "\\(lB");
1352 p
->flags
|= TERMP_NOSPACE
;
1363 termp_bt_pre(DECL_ARGS
)
1366 term_word(p
, "is currently in beta test.");
1373 termp_lb_post(DECL_ARGS
)
1376 if (SEC_LIBRARY
== n
->sec
)
1383 termp_ud_pre(DECL_ARGS
)
1386 term_word(p
, "currently under development.");
1393 termp_d1_pre(DECL_ARGS
)
1396 if (MDOC_BLOCK
!= n
->type
)
1399 p
->offset
+= (INDENT
+ 1);
1406 termp_d1_post(DECL_ARGS
)
1409 if (MDOC_BLOCK
!= n
->type
)
1417 termp_aq_pre(DECL_ARGS
)
1420 if (MDOC_BODY
!= n
->type
)
1422 term_word(p
, "\\(la");
1423 p
->flags
|= TERMP_NOSPACE
;
1430 termp_aq_post(DECL_ARGS
)
1433 if (MDOC_BODY
!= n
->type
)
1435 p
->flags
|= TERMP_NOSPACE
;
1436 term_word(p
, "\\(ra");
1442 termp_ft_pre(DECL_ARGS
)
1445 if (SEC_SYNOPSIS
== n
->sec
)
1446 if (n
->prev
&& MDOC_Fo
== n
->prev
->tok
)
1449 term_fontpush(p
, TERMFONT_UNDER
);
1456 termp_ft_post(DECL_ARGS
)
1459 if (SEC_SYNOPSIS
== n
->sec
)
1466 termp_fn_pre(DECL_ARGS
)
1468 const struct mdoc_node
*nn
;
1470 term_fontpush(p
, TERMFONT_BOLD
);
1471 term_word(p
, n
->child
->string
);
1474 p
->flags
|= TERMP_NOSPACE
;
1477 for (nn
= n
->child
->next
; nn
; nn
= nn
->next
) {
1478 term_fontpush(p
, TERMFONT_UNDER
);
1479 term_word(p
, nn
->string
);
1488 if (SEC_SYNOPSIS
== n
->sec
)
1497 termp_fn_post(DECL_ARGS
)
1500 if (n
->sec
== SEC_SYNOPSIS
&& n
->next
)
1507 termp_fa_pre(DECL_ARGS
)
1509 const struct mdoc_node
*nn
;
1511 if (n
->parent
->tok
!= MDOC_Fo
) {
1512 term_fontpush(p
, TERMFONT_UNDER
);
1516 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1517 term_fontpush(p
, TERMFONT_UNDER
);
1518 term_word(p
, nn
->string
);
1525 if (n
->child
&& n
->next
&& n
->next
->tok
== MDOC_Fa
)
1534 termp_bd_pre(DECL_ARGS
)
1537 const struct mdoc_node
*nn
;
1539 if (MDOC_BLOCK
== n
->type
) {
1540 print_bvspace(p
, n
, n
);
1542 } else if (MDOC_BODY
!= n
->type
)
1547 for (type
= -1, i
= 0; i
< (int)nn
->args
->argc
; i
++) {
1548 switch (nn
->args
->argv
[i
].arg
) {
1549 case (MDOC_Centred
):
1555 case (MDOC_Unfilled
):
1557 case (MDOC_Literal
):
1558 type
= nn
->args
->argv
[i
].arg
;
1561 p
->offset
+= a2offs(&nn
->args
->argv
[i
]);
1569 * If -ragged or -filled are specified, the block does nothing
1570 * but change the indentation. If -unfilled or -literal are
1571 * specified, text is printed exactly as entered in the display:
1572 * for macro lines, a newline is appended to the line. Blank
1573 * lines are allowed.
1577 if (MDOC_Literal
!= type
&& MDOC_Unfilled
!= type
)
1580 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1581 p
->flags
|= TERMP_NOSPACE
;
1582 print_mdoc_node(p
, pair
, m
, nn
);
1583 if (NULL
== nn
->next
)
1585 if (nn
->prev
&& nn
->prev
->line
< nn
->line
)
1587 else if (NULL
== nn
->prev
)
1597 termp_bd_post(DECL_ARGS
)
1600 if (MDOC_BODY
!= n
->type
)
1602 p
->flags
|= TERMP_NOSPACE
;
1609 termp_qq_pre(DECL_ARGS
)
1612 if (MDOC_BODY
!= n
->type
)
1615 p
->flags
|= TERMP_NOSPACE
;
1622 termp_qq_post(DECL_ARGS
)
1625 if (MDOC_BODY
!= n
->type
)
1627 p
->flags
|= TERMP_NOSPACE
;
1634 termp_bx_post(DECL_ARGS
)
1638 p
->flags
|= TERMP_NOSPACE
;
1639 term_word(p
, "BSD");
1645 termp_xx_pre(DECL_ARGS
)
1681 termp_sq_pre(DECL_ARGS
)
1684 if (MDOC_BODY
!= n
->type
)
1686 term_word(p
, "\\(oq");
1687 p
->flags
|= TERMP_NOSPACE
;
1694 termp_sq_post(DECL_ARGS
)
1697 if (MDOC_BODY
!= n
->type
)
1699 p
->flags
|= TERMP_NOSPACE
;
1700 term_word(p
, "\\(aq");
1706 termp_pf_pre(DECL_ARGS
)
1709 p
->flags
|= TERMP_IGNDELIM
;
1716 termp_pf_post(DECL_ARGS
)
1719 p
->flags
&= ~TERMP_IGNDELIM
;
1720 p
->flags
|= TERMP_NOSPACE
;
1726 termp_ss_pre(DECL_ARGS
)
1736 term_fontpush(p
, TERMFONT_BOLD
);
1737 p
->offset
= HALFINDENT
;
1749 termp_ss_post(DECL_ARGS
)
1752 if (MDOC_HEAD
== n
->type
)
1759 termp_cd_pre(DECL_ARGS
)
1762 term_fontpush(p
, TERMFONT_BOLD
);
1770 termp_in_pre(DECL_ARGS
)
1773 term_fontpush(p
, TERMFONT_BOLD
);
1774 if (SEC_SYNOPSIS
== n
->sec
)
1775 term_word(p
, "#include");
1778 p
->flags
|= TERMP_NOSPACE
;
1785 termp_in_post(DECL_ARGS
)
1788 term_fontpush(p
, TERMFONT_BOLD
);
1789 p
->flags
|= TERMP_NOSPACE
;
1793 if (SEC_SYNOPSIS
!= n
->sec
)
1798 * XXX Not entirely correct. If `.In foo bar' is specified in
1799 * the SYNOPSIS section, then it produces a single break after
1800 * the <foo>; mandoc asserts a vertical space. Since this
1801 * construction is rarely used, I think it's fine.
1803 if (n
->next
&& MDOC_In
!= n
->next
->tok
)
1810 termp_sp_pre(DECL_ARGS
)
1816 len
= n
->child
? a2height(n
->child
) : 1;
1828 for (i
= 0; i
< len
; i
++)
1837 termp_brq_pre(DECL_ARGS
)
1840 if (MDOC_BODY
!= n
->type
)
1842 term_word(p
, "\\(lC");
1843 p
->flags
|= TERMP_NOSPACE
;
1850 termp_brq_post(DECL_ARGS
)
1853 if (MDOC_BODY
!= n
->type
)
1855 p
->flags
|= TERMP_NOSPACE
;
1856 term_word(p
, "\\(rC");
1862 termp_bq_pre(DECL_ARGS
)
1865 if (MDOC_BODY
!= n
->type
)
1867 term_word(p
, "\\(lB");
1868 p
->flags
|= TERMP_NOSPACE
;
1875 termp_bq_post(DECL_ARGS
)
1878 if (MDOC_BODY
!= n
->type
)
1880 p
->flags
|= TERMP_NOSPACE
;
1881 term_word(p
, "\\(rB");
1887 termp_pq_pre(DECL_ARGS
)
1890 if (MDOC_BODY
!= n
->type
)
1892 term_word(p
, "\\&(");
1893 p
->flags
|= TERMP_NOSPACE
;
1900 termp_pq_post(DECL_ARGS
)
1903 if (MDOC_BODY
!= n
->type
)
1911 termp_fo_pre(DECL_ARGS
)
1913 const struct mdoc_node
*nn
;
1915 if (MDOC_BODY
== n
->type
) {
1916 p
->flags
|= TERMP_NOSPACE
;
1918 p
->flags
|= TERMP_NOSPACE
;
1920 } else if (MDOC_HEAD
!= n
->type
)
1923 term_fontpush(p
, TERMFONT_BOLD
);
1924 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1925 assert(MDOC_TEXT
== nn
->type
);
1926 term_word(p
, nn
->string
);
1936 termp_fo_post(DECL_ARGS
)
1939 if (MDOC_BODY
!= n
->type
)
1941 p
->flags
|= TERMP_NOSPACE
;
1943 p
->flags
|= TERMP_NOSPACE
;
1951 termp_bf_pre(DECL_ARGS
)
1953 const struct mdoc_node
*nn
;
1955 if (MDOC_HEAD
== n
->type
)
1957 else if (MDOC_BLOCK
!= n
->type
)
1960 if (NULL
== (nn
= n
->head
->child
)) {
1961 if (arg_hasattr(MDOC_Emphasis
, n
))
1962 term_fontpush(p
, TERMFONT_UNDER
);
1963 else if (arg_hasattr(MDOC_Symbolic
, n
))
1964 term_fontpush(p
, TERMFONT_BOLD
);
1966 term_fontpush(p
, TERMFONT_NONE
);
1971 assert(MDOC_TEXT
== nn
->type
);
1972 if (0 == strcmp("Em", nn
->string
))
1973 term_fontpush(p
, TERMFONT_UNDER
);
1974 else if (0 == strcmp("Sy", nn
->string
))
1975 term_fontpush(p
, TERMFONT_BOLD
);
1977 term_fontpush(p
, TERMFONT_NONE
);
1985 termp_sm_pre(DECL_ARGS
)
1988 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
1989 if (0 == strcmp("on", n
->child
->string
)) {
1990 p
->flags
&= ~TERMP_NONOSPACE
;
1991 p
->flags
&= ~TERMP_NOSPACE
;
1993 p
->flags
|= TERMP_NONOSPACE
;
2001 termp_ap_pre(DECL_ARGS
)
2004 p
->flags
|= TERMP_NOSPACE
;
2005 term_word(p
, "\\(aq");
2006 p
->flags
|= TERMP_NOSPACE
;
2013 termp____post(DECL_ARGS
)
2018 p
->flags
|= TERMP_NOSPACE
;
2021 term_word(p
, "\\(rq");
2022 p
->flags
|= TERMP_NOSPACE
;
2027 term_word(p
, n
->next
? "," : ".");
2033 termp_li_pre(DECL_ARGS
)
2036 term_fontpush(p
, TERMFONT_NONE
);
2043 termp_lk_pre(DECL_ARGS
)
2045 const struct mdoc_node
*nn
;
2047 term_fontpush(p
, TERMFONT_UNDER
);
2050 if (NULL
== nn
->next
)
2053 term_word(p
, nn
->string
);
2056 p
->flags
|= TERMP_NOSPACE
;
2059 term_fontpush(p
, TERMFONT_BOLD
);
2060 for (nn
= nn
->next
; nn
; nn
= nn
->next
)
2061 term_word(p
, nn
->string
);
2070 termp_under_pre(DECL_ARGS
)
2073 term_fontpush(p
, TERMFONT_UNDER
);
2080 termp__t_pre(DECL_ARGS
)
2083 term_word(p
, "\\(lq");
2084 p
->flags
|= TERMP_NOSPACE
;