]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.110 2010/01/30 08:42:21 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
;
43 #define DECL_ARGS struct termp *p, \
44 struct termpair *pair, \
45 const struct mdoc_meta *m, \
46 const struct mdoc_node *n
49 int (*pre
)(DECL_ARGS
);
50 void (*post
)(DECL_ARGS
);
53 static size_t a2width(const struct mdoc_argv
*, int);
54 static size_t a2height(const struct mdoc_node
*);
55 static size_t a2offs(const struct mdoc_argv
*);
57 static int arg_hasattr(int, const struct mdoc_node
*);
58 static int arg_getattrs(const int *, int *, size_t,
59 const struct mdoc_node
*);
60 static int arg_getattr(int, const struct mdoc_node
*);
61 static int arg_listtype(const struct mdoc_node
*);
62 static void print_bvspace(struct termp
*,
63 const struct mdoc_node
*,
64 const struct mdoc_node
*);
65 static void print_mdoc_node(DECL_ARGS
);
66 static void print_mdoc_head(DECL_ARGS
);
67 static void print_mdoc_nodelist(DECL_ARGS
);
68 static void print_foot(DECL_ARGS
);
70 static void termp____post(DECL_ARGS
);
71 static void termp_an_post(DECL_ARGS
);
72 static void termp_aq_post(DECL_ARGS
);
73 static void termp_bd_post(DECL_ARGS
);
74 static void termp_bl_post(DECL_ARGS
);
75 static void termp_bq_post(DECL_ARGS
);
76 static void termp_brq_post(DECL_ARGS
);
77 static void termp_bx_post(DECL_ARGS
);
78 static void termp_d1_post(DECL_ARGS
);
79 static void termp_dq_post(DECL_ARGS
);
80 static void termp_fd_post(DECL_ARGS
);
81 static void termp_fn_post(DECL_ARGS
);
82 static void termp_fo_post(DECL_ARGS
);
83 static void termp_ft_post(DECL_ARGS
);
84 static void termp_in_post(DECL_ARGS
);
85 static void termp_it_post(DECL_ARGS
);
86 static void termp_lb_post(DECL_ARGS
);
87 static void termp_op_post(DECL_ARGS
);
88 static void termp_pf_post(DECL_ARGS
);
89 static void termp_pq_post(DECL_ARGS
);
90 static void termp_qq_post(DECL_ARGS
);
91 static void termp_sh_post(DECL_ARGS
);
92 static void termp_sq_post(DECL_ARGS
);
93 static void termp_ss_post(DECL_ARGS
);
94 static void termp_vt_post(DECL_ARGS
);
96 static int termp__t_pre(DECL_ARGS
);
97 static int termp_an_pre(DECL_ARGS
);
98 static int termp_ap_pre(DECL_ARGS
);
99 static int termp_aq_pre(DECL_ARGS
);
100 static int termp_bd_pre(DECL_ARGS
);
101 static int termp_bf_pre(DECL_ARGS
);
102 static int termp_bold_pre(DECL_ARGS
);
103 static int termp_bq_pre(DECL_ARGS
);
104 static int termp_brq_pre(DECL_ARGS
);
105 static int termp_bt_pre(DECL_ARGS
);
106 static int termp_cd_pre(DECL_ARGS
);
107 static int termp_d1_pre(DECL_ARGS
);
108 static int termp_dq_pre(DECL_ARGS
);
109 static int termp_ex_pre(DECL_ARGS
);
110 static int termp_fa_pre(DECL_ARGS
);
111 static int termp_fl_pre(DECL_ARGS
);
112 static int termp_fn_pre(DECL_ARGS
);
113 static int termp_fo_pre(DECL_ARGS
);
114 static int termp_ft_pre(DECL_ARGS
);
115 static int termp_in_pre(DECL_ARGS
);
116 static int termp_it_pre(DECL_ARGS
);
117 static int termp_li_pre(DECL_ARGS
);
118 static int termp_lk_pre(DECL_ARGS
);
119 static int termp_nd_pre(DECL_ARGS
);
120 static int termp_nm_pre(DECL_ARGS
);
121 static int termp_ns_pre(DECL_ARGS
);
122 static int termp_op_pre(DECL_ARGS
);
123 static int termp_pf_pre(DECL_ARGS
);
124 static int termp_pq_pre(DECL_ARGS
);
125 static int termp_qq_pre(DECL_ARGS
);
126 static int termp_rs_pre(DECL_ARGS
);
127 static int termp_rv_pre(DECL_ARGS
);
128 static int termp_sh_pre(DECL_ARGS
);
129 static int termp_sm_pre(DECL_ARGS
);
130 static int termp_sp_pre(DECL_ARGS
);
131 static int termp_sq_pre(DECL_ARGS
);
132 static int termp_ss_pre(DECL_ARGS
);
133 static int termp_under_pre(DECL_ARGS
);
134 static int termp_ud_pre(DECL_ARGS
);
135 static int termp_vt_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_vt_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
]));
473 return(term_hspan(&su
));
478 arg_listtype(const struct mdoc_node
*n
)
482 assert(MDOC_BLOCK
== n
->type
);
484 len
= (int)(n
->args
? n
->args
->argc
: 0);
486 for (i
= 0; i
< len
; i
++)
487 switch (n
->args
->argv
[i
].arg
) {
509 return(n
->args
->argv
[i
].arg
);
519 a2offs(const struct mdoc_argv
*arg
)
523 if ('\0' == arg
->value
[0][0])
525 else if (0 == strcmp(arg
->value
[0], "left"))
527 else if (0 == strcmp(arg
->value
[0], "indent"))
529 else if (0 == strcmp(arg
->value
[0], "indent-two"))
530 return((INDENT
+ 1) * 2);
531 else if ( ! a2roffsu(arg
->value
[0], &su
, SCALE_MAX
))
532 SCALE_HS_INIT(&su
, strlen(arg
->value
[0]));
534 return(term_hspan(&su
));
539 * Return 1 if an argument has a particular argument value or 0 if it
540 * does not. See arg_getattr().
543 arg_hasattr(int arg
, const struct mdoc_node
*n
)
546 return(-1 != arg_getattr(arg
, n
));
551 * Get the index of an argument in a node's argument list or -1 if it
552 * does not exist. See arg_getattrs().
555 arg_getattr(int v
, const struct mdoc_node
*n
)
559 return(arg_getattrs(&v
, &val
, 1, n
) ? val
: -1);
564 * Walk through the argument list for a node and fill an array "vals"
565 * with the positions of the argument structures listed in "keys".
566 * Return the number of elements that were written into "vals", which
570 arg_getattrs(const int *keys
, int *vals
,
571 size_t sz
, const struct mdoc_node
*n
)
578 for (k
= i
= 0; i
< (int)n
->args
->argc
; i
++)
579 for (j
= 0; j
< (int)sz
; j
++)
580 if (n
->args
->argv
[i
].arg
== keys
[j
]) {
589 * Determine how much space to print out before block elements of `It'
590 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
594 print_bvspace(struct termp
*p
,
595 const struct mdoc_node
*bl
,
596 const struct mdoc_node
*n
)
598 const struct mdoc_node
*nn
;
601 if (arg_hasattr(MDOC_Compact
, bl
))
604 /* Do not vspace directly after Ss/Sh. */
606 for (nn
= n
; nn
; nn
= nn
->parent
) {
607 if (MDOC_BLOCK
!= nn
->type
)
609 if (MDOC_Ss
== nn
->tok
)
611 if (MDOC_Sh
== nn
->tok
)
613 if (NULL
== nn
->prev
)
618 /* A `-column' does not assert vspace within the list. */
620 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Column
, bl
))
621 if (n
->prev
&& MDOC_It
== n
->prev
->tok
)
624 /* A `-diag' without body does not vspace. */
626 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Diag
, bl
))
627 if (n
->prev
&& MDOC_It
== n
->prev
->tok
) {
628 assert(n
->prev
->body
);
629 if (NULL
== n
->prev
->body
->child
)
639 termp_dq_pre(DECL_ARGS
)
642 if (MDOC_BODY
!= n
->type
)
645 term_word(p
, "\\(lq");
646 p
->flags
|= TERMP_NOSPACE
;
653 termp_dq_post(DECL_ARGS
)
656 if (MDOC_BODY
!= n
->type
)
659 p
->flags
|= TERMP_NOSPACE
;
660 term_word(p
, "\\(rq");
666 termp_it_pre(DECL_ARGS
)
668 const struct mdoc_node
*bl
, *nn
;
670 int i
, type
, keys
[3], vals
[3];
671 size_t width
, offset
, ncols
, dcol
;
673 if (MDOC_BLOCK
== n
->type
) {
674 print_bvspace(p
, n
->parent
->parent
, n
);
678 bl
= n
->parent
->parent
->parent
;
680 /* Get list width, offset, and list type from argument list. */
682 keys
[0] = MDOC_Width
;
683 keys
[1] = MDOC_Offset
;
684 keys
[2] = MDOC_Column
;
686 vals
[0] = vals
[1] = vals
[2] = -1;
688 arg_getattrs(keys
, vals
, 3, bl
);
690 type
= arg_listtype(bl
);
694 * First calculate width and offset. This is pretty easy unless
695 * we're a -column list, in which case all prior columns must
702 offset
= a2offs(&bl
->args
->argv
[vals
[1]]);
706 if (MDOC_BODY
== n
->type
)
709 * Imitate groff's column handling:
710 * - For each earlier column, add its width.
711 * - For less than 5 columns, add four more blanks per
713 * - For exactly 5 columns, add three more blank per
715 * - For more than 5 columns, add only one column.
717 ncols
= bl
->args
->argv
[vals
[2]].sz
;
719 dcol
= ncols
< 5 ? 4 : ncols
== 5 ? 3 : 1;
721 for (i
= 0, nn
= n
->prev
;
722 nn
&& i
< (int)ncols
;
724 offset
+= dcol
+ a2width
725 (&bl
->args
->argv
[vals
[2]], i
);
729 * When exceeding the declared number of columns, leave
730 * the remaining widths at 0. This will later be
731 * adjusted to the default width of 10, or, for the last
732 * column, stretched to the right margin.
738 * Use the declared column widths, extended as explained
739 * in the preceding paragraph.
741 width
= a2width(&bl
->args
->argv
[vals
[2]], i
) + dcol
;
748 * Note: buffer the width by 2, which is groff's magic
749 * number for buffering single arguments. See the above
750 * handling for column for how this changes.
752 width
= a2width(&bl
->args
->argv
[vals
[0]], 0) + 2;
757 * List-type can override the width in the case of fixed-head
758 * values (bullet, dash/hyphen, enum). Tags need a non-zero
790 * Whitespace control. Inset bodies need an initial space,
791 * while diagonal bodies need two.
794 p
->flags
|= TERMP_NOSPACE
;
798 if (MDOC_BODY
== n
->type
)
799 term_word(p
, "\\ \\ ");
802 if (MDOC_BODY
== n
->type
)
809 p
->flags
|= TERMP_NOSPACE
;
813 if (MDOC_HEAD
== n
->type
)
814 term_fontpush(p
, TERMFONT_BOLD
);
821 * Pad and break control. This is the tricky part. These flags
822 * are documented in term_flushln() in term.c. Note that we're
823 * going to unset all of these flags in termp_it_post() when we
835 if (MDOC_HEAD
== n
->type
)
836 p
->flags
|= TERMP_NOBREAK
;
838 p
->flags
|= TERMP_NOLPAD
;
841 if (MDOC_HEAD
== n
->type
)
842 p
->flags
|= TERMP_NOBREAK
;
844 p
->flags
|= TERMP_NOLPAD
;
846 if (MDOC_HEAD
!= n
->type
)
850 * This is ugly. If `-hang' is specified and the body
851 * is a `Bl' or `Bd', then we want basically to nullify
852 * the "overstep" effect in term_flushln() and treat
853 * this as a `-ohang' list instead.
855 if (n
->next
->child
&&
856 (MDOC_Bl
== n
->next
->child
->tok
||
857 MDOC_Bd
== n
->next
->child
->tok
)) {
858 p
->flags
&= ~TERMP_NOBREAK
;
859 p
->flags
&= ~TERMP_NOLPAD
;
861 p
->flags
|= TERMP_HANG
;
864 if (MDOC_HEAD
== n
->type
)
865 p
->flags
|= TERMP_NOBREAK
| TERMP_TWOSPACE
;
867 p
->flags
|= TERMP_NOLPAD
;
869 if (MDOC_HEAD
!= n
->type
)
871 if (NULL
== n
->next
|| NULL
== n
->next
->child
)
872 p
->flags
|= TERMP_DANGLE
;
875 if (MDOC_HEAD
== n
->type
) {
877 if (MDOC_BODY
== n
->next
->type
)
878 p
->flags
&= ~TERMP_NOBREAK
;
880 p
->flags
|= TERMP_NOBREAK
;
882 p
->flags
|= TERMP_NOLPAD
;
886 if (MDOC_HEAD
== n
->type
)
887 p
->flags
|= TERMP_NOBREAK
;
894 * Margin control. Set-head-width lists have their right
895 * margins shortened. The body for these lists has the offset
896 * necessarily lengthened. Everybody gets the offset.
904 * Same stipulation as above, regarding `-hang'. We
905 * don't want to recalculate rmargin and offsets when
906 * using `Bd' or `Bl' within `-hang' overstep lists.
908 if (MDOC_HEAD
== n
->type
&& n
->next
->child
&&
909 (MDOC_Bl
== n
->next
->child
->tok
||
910 MDOC_Bd
== n
->next
->child
->tok
))
923 if (MDOC_HEAD
== n
->type
)
924 p
->rmargin
= p
->offset
+ width
;
930 p
->rmargin
= p
->offset
+ width
;
932 * XXX - this behaviour is not documented: the
933 * right-most column is filled to the right margin.
935 if (MDOC_HEAD
== n
->type
&&
936 MDOC_BODY
== n
->next
->type
&&
937 p
->rmargin
< p
->maxrmargin
)
938 p
->rmargin
= p
->maxrmargin
;
945 * The dash, hyphen, bullet and enum lists all have a special
946 * HEAD character (temporarily bold, in some cases).
949 if (MDOC_HEAD
== n
->type
)
952 term_fontpush(p
, TERMFONT_BOLD
);
953 term_word(p
, "\\[bu]");
959 term_fontpush(p
, TERMFONT_BOLD
);
960 term_word(p
, "\\(hy");
964 (pair
->ppair
->ppair
->count
)++;
965 snprintf(buf
, sizeof(buf
), "%d.",
966 pair
->ppair
->ppair
->count
);
974 * If we're not going to process our children, indicate so here.
987 if (MDOC_HEAD
== n
->type
)
991 if (MDOC_BODY
== n
->type
)
1004 termp_it_post(DECL_ARGS
)
1008 if (MDOC_BLOCK
== n
->type
)
1011 type
= arg_listtype(n
->parent
->parent
->parent
);
1020 if (MDOC_BODY
== n
->type
)
1024 if (MDOC_HEAD
== n
->type
)
1033 * Now that our output is flushed, we can reset our tags. Since
1034 * only `It' sets these flags, we're free to assume that nobody
1035 * has munged them in the meanwhile.
1038 p
->flags
&= ~TERMP_DANGLE
;
1039 p
->flags
&= ~TERMP_NOBREAK
;
1040 p
->flags
&= ~TERMP_TWOSPACE
;
1041 p
->flags
&= ~TERMP_NOLPAD
;
1042 p
->flags
&= ~TERMP_HANG
;
1048 termp_nm_pre(DECL_ARGS
)
1051 if (SEC_SYNOPSIS
== n
->sec
)
1054 term_fontpush(p
, TERMFONT_BOLD
);
1056 if (NULL
== n
->child
)
1057 term_word(p
, m
->name
);
1064 termp_fl_pre(DECL_ARGS
)
1067 term_fontpush(p
, TERMFONT_BOLD
);
1068 term_word(p
, "\\-");
1070 /* A blank `Fl' should incur a subsequent space. */
1073 p
->flags
|= TERMP_NOSPACE
;
1081 termp_an_pre(DECL_ARGS
)
1084 if (NULL
== n
->child
)
1088 * If not in the AUTHORS section, `An -split' will cause
1089 * newlines to occur before the author name. If in the AUTHORS
1090 * section, by default, the first `An' invocation is nosplit,
1091 * then all subsequent ones, regardless of whether interspersed
1092 * with other macros/text, are split. -split, in this case,
1093 * will override the condition of the implied first -nosplit.
1096 if (n
->sec
== SEC_AUTHORS
) {
1097 if ( ! (TERMP_ANPREC
& p
->flags
)) {
1098 if (TERMP_SPLIT
& p
->flags
)
1102 if (TERMP_NOSPLIT
& p
->flags
)
1108 if (TERMP_SPLIT
& p
->flags
)
1117 termp_an_post(DECL_ARGS
)
1121 if (SEC_AUTHORS
== n
->sec
)
1122 p
->flags
|= TERMP_ANPREC
;
1126 if (arg_getattr(MDOC_Split
, n
) > -1) {
1127 p
->flags
&= ~TERMP_NOSPLIT
;
1128 p
->flags
|= TERMP_SPLIT
;
1130 p
->flags
&= ~TERMP_SPLIT
;
1131 p
->flags
|= TERMP_NOSPLIT
;
1139 termp_ns_pre(DECL_ARGS
)
1142 p
->flags
|= TERMP_NOSPACE
;
1149 termp_rs_pre(DECL_ARGS
)
1152 if (SEC_SEE_ALSO
!= n
->sec
)
1154 if (MDOC_BLOCK
== n
->type
&& n
->prev
)
1162 termp_rv_pre(DECL_ARGS
)
1164 const struct mdoc_node
*nn
;
1167 term_word(p
, "The");
1169 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1170 term_fontpush(p
, TERMFONT_BOLD
);
1171 term_word(p
, nn
->string
);
1173 p
->flags
|= TERMP_NOSPACE
;
1174 if (nn
->next
&& NULL
== nn
->next
->next
)
1175 term_word(p
, "(), and");
1177 term_word(p
, "(),");
1183 term_word(p
, "functions return");
1185 term_word(p
, "function returns");
1187 term_word(p
, "the value 0 if successful; otherwise the value "
1188 "-1 is returned and the global variable");
1190 term_fontpush(p
, TERMFONT_UNDER
);
1191 term_word(p
, "errno");
1194 term_word(p
, "is set to indicate the error.");
1202 termp_ex_pre(DECL_ARGS
)
1204 const struct mdoc_node
*nn
;
1206 term_word(p
, "The");
1208 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1209 term_fontpush(p
, TERMFONT_BOLD
);
1210 term_word(p
, nn
->string
);
1212 p
->flags
|= TERMP_NOSPACE
;
1213 if (nn
->next
&& NULL
== nn
->next
->next
)
1214 term_word(p
, ", and");
1218 p
->flags
&= ~TERMP_NOSPACE
;
1222 term_word(p
, "utilities exit");
1224 term_word(p
, "utility exits");
1226 term_word(p
, "0 on success, and >0 if an error occurs.");
1234 termp_nd_pre(DECL_ARGS
)
1237 if (MDOC_BODY
!= n
->type
)
1240 #if defined(__OpenBSD__) || defined(__linux__)
1241 term_word(p
, "\\(en");
1243 term_word(p
, "\\(em");
1251 termp_bl_post(DECL_ARGS
)
1254 if (MDOC_BLOCK
== n
->type
)
1261 termp_op_post(DECL_ARGS
)
1264 if (MDOC_BODY
!= n
->type
)
1266 p
->flags
|= TERMP_NOSPACE
;
1267 term_word(p
, "\\(rB");
1273 termp_xr_pre(DECL_ARGS
)
1275 const struct mdoc_node
*nn
;
1277 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
1280 term_word(p
, nn
->string
);
1281 if (NULL
== (nn
= nn
->next
))
1283 p
->flags
|= TERMP_NOSPACE
;
1285 p
->flags
|= TERMP_NOSPACE
;
1286 term_word(p
, nn
->string
);
1287 p
->flags
|= TERMP_NOSPACE
;
1295 termp_vt_pre(DECL_ARGS
)
1298 if (MDOC_ELEM
== n
->type
)
1299 return(termp_under_pre(p
, pair
, m
, n
));
1300 else if (MDOC_HEAD
== n
->type
)
1302 else if (MDOC_BLOCK
== n
->type
)
1305 return(termp_under_pre(p
, pair
, m
, n
));
1311 termp_vt_post(DECL_ARGS
)
1314 if (MDOC_BLOCK
!= n
->type
)
1316 if (n
->next
&& MDOC_Vt
== n
->next
->tok
)
1325 termp_bold_pre(DECL_ARGS
)
1328 term_fontpush(p
, TERMFONT_BOLD
);
1335 termp_fd_post(DECL_ARGS
)
1338 if (n
->sec
!= SEC_SYNOPSIS
)
1342 if (n
->next
&& MDOC_Fd
!= n
->next
->tok
)
1349 termp_sh_pre(DECL_ARGS
)
1352 /* No vspace between consecutive `Sh' calls. */
1356 if (n
->prev
&& MDOC_Sh
== n
->prev
->tok
)
1357 if (NULL
== n
->prev
->body
->child
)
1362 term_fontpush(p
, TERMFONT_BOLD
);
1376 termp_sh_post(DECL_ARGS
)
1395 termp_op_pre(DECL_ARGS
)
1400 term_word(p
, "\\(lB");
1401 p
->flags
|= TERMP_NOSPACE
;
1412 termp_bt_pre(DECL_ARGS
)
1415 term_word(p
, "is currently in beta test.");
1422 termp_lb_post(DECL_ARGS
)
1425 if (SEC_LIBRARY
== n
->sec
)
1432 termp_ud_pre(DECL_ARGS
)
1435 term_word(p
, "currently under development.");
1442 termp_d1_pre(DECL_ARGS
)
1445 if (MDOC_BLOCK
!= n
->type
)
1448 p
->offset
+= (INDENT
+ 1);
1455 termp_d1_post(DECL_ARGS
)
1458 if (MDOC_BLOCK
!= n
->type
)
1466 termp_aq_pre(DECL_ARGS
)
1469 if (MDOC_BODY
!= n
->type
)
1471 term_word(p
, "\\(la");
1472 p
->flags
|= TERMP_NOSPACE
;
1479 termp_aq_post(DECL_ARGS
)
1482 if (MDOC_BODY
!= n
->type
)
1484 p
->flags
|= TERMP_NOSPACE
;
1485 term_word(p
, "\\(ra");
1491 termp_ft_pre(DECL_ARGS
)
1494 if (SEC_SYNOPSIS
== n
->sec
)
1495 if (n
->prev
&& MDOC_Fo
== n
->prev
->tok
)
1498 term_fontpush(p
, TERMFONT_UNDER
);
1505 termp_ft_post(DECL_ARGS
)
1508 if (SEC_SYNOPSIS
== n
->sec
)
1515 termp_fn_pre(DECL_ARGS
)
1517 const struct mdoc_node
*nn
;
1519 term_fontpush(p
, TERMFONT_BOLD
);
1520 term_word(p
, n
->child
->string
);
1523 p
->flags
|= TERMP_NOSPACE
;
1526 for (nn
= n
->child
->next
; nn
; nn
= nn
->next
) {
1527 term_fontpush(p
, TERMFONT_UNDER
);
1528 term_word(p
, nn
->string
);
1537 if (SEC_SYNOPSIS
== n
->sec
)
1546 termp_fn_post(DECL_ARGS
)
1549 if (n
->sec
== SEC_SYNOPSIS
&& n
->next
)
1556 termp_fa_pre(DECL_ARGS
)
1558 const struct mdoc_node
*nn
;
1560 if (n
->parent
->tok
!= MDOC_Fo
) {
1561 term_fontpush(p
, TERMFONT_UNDER
);
1565 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1566 term_fontpush(p
, TERMFONT_UNDER
);
1567 term_word(p
, nn
->string
);
1574 if (n
->child
&& n
->next
&& n
->next
->tok
== MDOC_Fa
)
1583 termp_bd_pre(DECL_ARGS
)
1586 const struct mdoc_node
*nn
;
1588 if (MDOC_BLOCK
== n
->type
) {
1589 print_bvspace(p
, n
, n
);
1591 } else if (MDOC_BODY
!= n
->type
)
1596 for (type
= -1, i
= 0; i
< (int)nn
->args
->argc
; i
++) {
1597 switch (nn
->args
->argv
[i
].arg
) {
1598 case (MDOC_Centred
):
1604 case (MDOC_Unfilled
):
1606 case (MDOC_Literal
):
1607 type
= nn
->args
->argv
[i
].arg
;
1610 p
->offset
+= a2offs(&nn
->args
->argv
[i
]);
1618 * If -ragged or -filled are specified, the block does nothing
1619 * but change the indentation. If -unfilled or -literal are
1620 * specified, text is printed exactly as entered in the display:
1621 * for macro lines, a newline is appended to the line. Blank
1622 * lines are allowed.
1626 if (MDOC_Literal
!= type
&& MDOC_Unfilled
!= type
)
1629 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1630 p
->flags
|= TERMP_NOSPACE
;
1631 print_mdoc_node(p
, pair
, m
, nn
);
1632 if (NULL
== nn
->next
)
1634 if (nn
->prev
&& nn
->prev
->line
< nn
->line
)
1636 else if (NULL
== nn
->prev
)
1646 termp_bd_post(DECL_ARGS
)
1649 if (MDOC_BODY
!= n
->type
)
1651 p
->flags
|= TERMP_NOSPACE
;
1658 termp_qq_pre(DECL_ARGS
)
1661 if (MDOC_BODY
!= n
->type
)
1664 p
->flags
|= TERMP_NOSPACE
;
1671 termp_qq_post(DECL_ARGS
)
1674 if (MDOC_BODY
!= n
->type
)
1676 p
->flags
|= TERMP_NOSPACE
;
1683 termp_bx_post(DECL_ARGS
)
1687 p
->flags
|= TERMP_NOSPACE
;
1688 term_word(p
, "BSD");
1694 termp_xx_pre(DECL_ARGS
)
1730 termp_sq_pre(DECL_ARGS
)
1733 if (MDOC_BODY
!= n
->type
)
1735 term_word(p
, "\\(oq");
1736 p
->flags
|= TERMP_NOSPACE
;
1743 termp_sq_post(DECL_ARGS
)
1746 if (MDOC_BODY
!= n
->type
)
1748 p
->flags
|= TERMP_NOSPACE
;
1749 term_word(p
, "\\(aq");
1755 termp_pf_pre(DECL_ARGS
)
1758 p
->flags
|= TERMP_IGNDELIM
;
1765 termp_pf_post(DECL_ARGS
)
1768 p
->flags
&= ~TERMP_IGNDELIM
;
1769 p
->flags
|= TERMP_NOSPACE
;
1775 termp_ss_pre(DECL_ARGS
)
1785 term_fontpush(p
, TERMFONT_BOLD
);
1786 p
->offset
= HALFINDENT
;
1798 termp_ss_post(DECL_ARGS
)
1801 if (MDOC_HEAD
== n
->type
)
1808 termp_cd_pre(DECL_ARGS
)
1811 term_fontpush(p
, TERMFONT_BOLD
);
1819 termp_in_pre(DECL_ARGS
)
1822 term_fontpush(p
, TERMFONT_BOLD
);
1823 if (SEC_SYNOPSIS
== n
->sec
)
1824 term_word(p
, "#include");
1827 p
->flags
|= TERMP_NOSPACE
;
1834 termp_in_post(DECL_ARGS
)
1837 term_fontpush(p
, TERMFONT_BOLD
);
1838 p
->flags
|= TERMP_NOSPACE
;
1842 if (SEC_SYNOPSIS
!= n
->sec
)
1847 * XXX Not entirely correct. If `.In foo bar' is specified in
1848 * the SYNOPSIS section, then it produces a single break after
1849 * the <foo>; mandoc asserts a vertical space. Since this
1850 * construction is rarely used, I think it's fine.
1852 if (n
->next
&& MDOC_In
!= n
->next
->tok
)
1859 termp_sp_pre(DECL_ARGS
)
1865 len
= n
->child
? a2height(n
->child
) : 1;
1877 for (i
= 0; i
< len
; i
++)
1886 termp_brq_pre(DECL_ARGS
)
1889 if (MDOC_BODY
!= n
->type
)
1891 term_word(p
, "\\(lC");
1892 p
->flags
|= TERMP_NOSPACE
;
1899 termp_brq_post(DECL_ARGS
)
1902 if (MDOC_BODY
!= n
->type
)
1904 p
->flags
|= TERMP_NOSPACE
;
1905 term_word(p
, "\\(rC");
1911 termp_bq_pre(DECL_ARGS
)
1914 if (MDOC_BODY
!= n
->type
)
1916 term_word(p
, "\\(lB");
1917 p
->flags
|= TERMP_NOSPACE
;
1924 termp_bq_post(DECL_ARGS
)
1927 if (MDOC_BODY
!= n
->type
)
1929 p
->flags
|= TERMP_NOSPACE
;
1930 term_word(p
, "\\(rB");
1936 termp_pq_pre(DECL_ARGS
)
1939 if (MDOC_BODY
!= n
->type
)
1941 term_word(p
, "\\&(");
1942 p
->flags
|= TERMP_NOSPACE
;
1949 termp_pq_post(DECL_ARGS
)
1952 if (MDOC_BODY
!= n
->type
)
1960 termp_fo_pre(DECL_ARGS
)
1962 const struct mdoc_node
*nn
;
1964 if (MDOC_BODY
== n
->type
) {
1965 p
->flags
|= TERMP_NOSPACE
;
1967 p
->flags
|= TERMP_NOSPACE
;
1969 } else if (MDOC_HEAD
!= n
->type
)
1972 term_fontpush(p
, TERMFONT_BOLD
);
1973 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1974 assert(MDOC_TEXT
== nn
->type
);
1975 term_word(p
, nn
->string
);
1985 termp_fo_post(DECL_ARGS
)
1988 if (MDOC_BODY
!= n
->type
)
1990 p
->flags
|= TERMP_NOSPACE
;
1992 p
->flags
|= TERMP_NOSPACE
;
2000 termp_bf_pre(DECL_ARGS
)
2002 const struct mdoc_node
*nn
;
2004 if (MDOC_HEAD
== n
->type
)
2006 else if (MDOC_BLOCK
!= n
->type
)
2009 if (NULL
== (nn
= n
->head
->child
)) {
2010 if (arg_hasattr(MDOC_Emphasis
, n
))
2011 term_fontpush(p
, TERMFONT_UNDER
);
2012 else if (arg_hasattr(MDOC_Symbolic
, n
))
2013 term_fontpush(p
, TERMFONT_BOLD
);
2015 term_fontpush(p
, TERMFONT_NONE
);
2020 assert(MDOC_TEXT
== nn
->type
);
2021 if (0 == strcmp("Em", nn
->string
))
2022 term_fontpush(p
, TERMFONT_UNDER
);
2023 else if (0 == strcmp("Sy", nn
->string
))
2024 term_fontpush(p
, TERMFONT_BOLD
);
2026 term_fontpush(p
, TERMFONT_NONE
);
2034 termp_sm_pre(DECL_ARGS
)
2037 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
2038 if (0 == strcmp("on", n
->child
->string
))
2039 p
->flags
&= ~TERMP_NONOSPACE
;
2041 p
->flags
|= TERMP_NONOSPACE
;
2049 termp_ap_pre(DECL_ARGS
)
2052 p
->flags
|= TERMP_NOSPACE
;
2053 term_word(p
, "\\(aq");
2054 p
->flags
|= TERMP_NOSPACE
;
2061 termp____post(DECL_ARGS
)
2066 p
->flags
|= TERMP_NOSPACE
;
2069 term_word(p
, "\\(rq");
2070 p
->flags
|= TERMP_NOSPACE
;
2075 term_word(p
, n
->next
? "," : ".");
2081 termp_li_pre(DECL_ARGS
)
2084 term_fontpush(p
, TERMFONT_NONE
);
2091 termp_lk_pre(DECL_ARGS
)
2093 const struct mdoc_node
*nn
;
2095 term_fontpush(p
, TERMFONT_UNDER
);
2098 if (NULL
== nn
->next
)
2101 term_word(p
, nn
->string
);
2104 p
->flags
|= TERMP_NOSPACE
;
2107 term_fontpush(p
, TERMFONT_BOLD
);
2108 for (nn
= nn
->next
; nn
; nn
= nn
->next
)
2109 term_word(p
, nn
->string
);
2118 termp_under_pre(DECL_ARGS
)
2121 term_fontpush(p
, TERMFONT_UNDER
);
2128 termp__t_pre(DECL_ARGS
)
2131 term_word(p
, "\\(lq");
2132 p
->flags
|= TERMP_NOSPACE
;