]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.130 2010/05/24 21:51:20 schwarze 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>
41 struct termpair
*ppair
;
45 #define DECL_ARGS struct termp *p, \
46 struct termpair *pair, \
47 const struct mdoc_meta *m, \
48 const struct mdoc_node *n
51 int (*pre
)(DECL_ARGS
);
52 void (*post
)(DECL_ARGS
);
55 static size_t a2width(const struct mdoc_argv
*, int);
56 static size_t a2height(const struct mdoc_node
*);
57 static size_t a2offs(const struct mdoc_argv
*);
59 static int arg_hasattr(int, const struct mdoc_node
*);
60 static int arg_getattrs(const int *, int *, size_t,
61 const struct mdoc_node
*);
62 static int arg_getattr(int, const struct mdoc_node
*);
63 static int arg_disptype(const struct mdoc_node
*);
64 static void print_bvspace(struct termp
*,
65 const struct mdoc_node
*,
66 const struct mdoc_node
*);
67 static void print_mdoc_node(DECL_ARGS
);
68 static void print_mdoc_head(DECL_ARGS
);
69 static void print_mdoc_nodelist(DECL_ARGS
);
70 static void print_foot(DECL_ARGS
);
72 static void termp____post(DECL_ARGS
);
73 static void termp_an_post(DECL_ARGS
);
74 static void termp_aq_post(DECL_ARGS
);
75 static void termp_bd_post(DECL_ARGS
);
76 static void termp_bl_post(DECL_ARGS
);
77 static void termp_bq_post(DECL_ARGS
);
78 static void termp_brq_post(DECL_ARGS
);
79 static void termp_bx_post(DECL_ARGS
);
80 static void termp_d1_post(DECL_ARGS
);
81 static void termp_dq_post(DECL_ARGS
);
82 static void termp_fd_post(DECL_ARGS
);
83 static void termp_fn_post(DECL_ARGS
);
84 static void termp_fo_post(DECL_ARGS
);
85 static void termp_ft_post(DECL_ARGS
);
86 static void termp_in_post(DECL_ARGS
);
87 static void termp_it_post(DECL_ARGS
);
88 static void termp_lb_post(DECL_ARGS
);
89 static void termp_op_post(DECL_ARGS
);
90 static void termp_pf_post(DECL_ARGS
);
91 static void termp_pq_post(DECL_ARGS
);
92 static void termp_qq_post(DECL_ARGS
);
93 static void termp_sh_post(DECL_ARGS
);
94 static void termp_sq_post(DECL_ARGS
);
95 static void termp_ss_post(DECL_ARGS
);
96 static void termp_vt_post(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_bl_pre(DECL_ARGS
);
104 static int termp_bold_pre(DECL_ARGS
);
105 static int termp_bq_pre(DECL_ARGS
);
106 static int termp_brq_pre(DECL_ARGS
);
107 static int termp_bt_pre(DECL_ARGS
);
108 static int termp_cd_pre(DECL_ARGS
);
109 static int termp_d1_pre(DECL_ARGS
);
110 static int termp_dq_pre(DECL_ARGS
);
111 static int termp_ex_pre(DECL_ARGS
);
112 static int termp_fa_pre(DECL_ARGS
);
113 static int termp_fl_pre(DECL_ARGS
);
114 static int termp_fn_pre(DECL_ARGS
);
115 static int termp_fo_pre(DECL_ARGS
);
116 static int termp_ft_pre(DECL_ARGS
);
117 static int termp_in_pre(DECL_ARGS
);
118 static int termp_it_pre(DECL_ARGS
);
119 static int termp_li_pre(DECL_ARGS
);
120 static int termp_lk_pre(DECL_ARGS
);
121 static int termp_nd_pre(DECL_ARGS
);
122 static int termp_nm_pre(DECL_ARGS
);
123 static int termp_ns_pre(DECL_ARGS
);
124 static int termp_op_pre(DECL_ARGS
);
125 static int termp_pf_pre(DECL_ARGS
);
126 static int termp_pq_pre(DECL_ARGS
);
127 static int termp_qq_pre(DECL_ARGS
);
128 static int termp_rs_pre(DECL_ARGS
);
129 static int termp_rv_pre(DECL_ARGS
);
130 static int termp_sh_pre(DECL_ARGS
);
131 static int termp_sm_pre(DECL_ARGS
);
132 static int termp_sp_pre(DECL_ARGS
);
133 static int termp_sq_pre(DECL_ARGS
);
134 static int termp_ss_pre(DECL_ARGS
);
135 static int termp_under_pre(DECL_ARGS
);
136 static int termp_ud_pre(DECL_ARGS
);
137 static int termp_vt_pre(DECL_ARGS
);
138 static int termp_xr_pre(DECL_ARGS
);
139 static int termp_xx_pre(DECL_ARGS
);
141 static const struct termact termacts
[MDOC_MAX
] = {
142 { termp_ap_pre
, NULL
}, /* Ap */
143 { NULL
, NULL
}, /* Dd */
144 { NULL
, NULL
}, /* Dt */
145 { NULL
, NULL
}, /* Os */
146 { termp_sh_pre
, termp_sh_post
}, /* Sh */
147 { termp_ss_pre
, termp_ss_post
}, /* Ss */
148 { termp_sp_pre
, NULL
}, /* Pp */
149 { termp_d1_pre
, termp_d1_post
}, /* D1 */
150 { termp_d1_pre
, termp_d1_post
}, /* Dl */
151 { termp_bd_pre
, termp_bd_post
}, /* Bd */
152 { NULL
, NULL
}, /* Ed */
153 { termp_bl_pre
, termp_bl_post
}, /* Bl */
154 { NULL
, NULL
}, /* El */
155 { termp_it_pre
, termp_it_post
}, /* It */
156 { NULL
, NULL
}, /* Ad */
157 { termp_an_pre
, termp_an_post
}, /* An */
158 { termp_under_pre
, NULL
}, /* Ar */
159 { termp_cd_pre
, NULL
}, /* Cd */
160 { termp_bold_pre
, NULL
}, /* Cm */
161 { NULL
, NULL
}, /* Dv */
162 { NULL
, NULL
}, /* Er */
163 { NULL
, NULL
}, /* Ev */
164 { termp_ex_pre
, NULL
}, /* Ex */
165 { termp_fa_pre
, NULL
}, /* Fa */
166 { termp_bold_pre
, termp_fd_post
}, /* Fd */
167 { termp_fl_pre
, NULL
}, /* Fl */
168 { termp_fn_pre
, termp_fn_post
}, /* Fn */
169 { termp_ft_pre
, termp_ft_post
}, /* Ft */
170 { termp_bold_pre
, NULL
}, /* Ic */
171 { termp_in_pre
, termp_in_post
}, /* In */
172 { termp_li_pre
, NULL
}, /* Li */
173 { termp_nd_pre
, NULL
}, /* Nd */
174 { termp_nm_pre
, NULL
}, /* Nm */
175 { termp_op_pre
, termp_op_post
}, /* Op */
176 { NULL
, NULL
}, /* Ot */
177 { termp_under_pre
, NULL
}, /* Pa */
178 { termp_rv_pre
, NULL
}, /* Rv */
179 { NULL
, NULL
}, /* St */
180 { termp_under_pre
, NULL
}, /* Va */
181 { termp_vt_pre
, termp_vt_post
}, /* Vt */
182 { termp_xr_pre
, NULL
}, /* Xr */
183 { NULL
, termp____post
}, /* %A */
184 { termp_under_pre
, termp____post
}, /* %B */
185 { NULL
, termp____post
}, /* %D */
186 { termp_under_pre
, termp____post
}, /* %I */
187 { termp_under_pre
, termp____post
}, /* %J */
188 { NULL
, termp____post
}, /* %N */
189 { NULL
, termp____post
}, /* %O */
190 { NULL
, termp____post
}, /* %P */
191 { NULL
, termp____post
}, /* %R */
192 { termp_under_pre
, termp____post
}, /* %T */
193 { NULL
, termp____post
}, /* %V */
194 { NULL
, NULL
}, /* Ac */
195 { termp_aq_pre
, termp_aq_post
}, /* Ao */
196 { termp_aq_pre
, termp_aq_post
}, /* Aq */
197 { NULL
, NULL
}, /* At */
198 { NULL
, NULL
}, /* Bc */
199 { termp_bf_pre
, NULL
}, /* Bf */
200 { termp_bq_pre
, termp_bq_post
}, /* Bo */
201 { termp_bq_pre
, termp_bq_post
}, /* Bq */
202 { termp_xx_pre
, NULL
}, /* Bsx */
203 { NULL
, termp_bx_post
}, /* Bx */
204 { NULL
, NULL
}, /* Db */
205 { NULL
, NULL
}, /* Dc */
206 { termp_dq_pre
, termp_dq_post
}, /* Do */
207 { termp_dq_pre
, termp_dq_post
}, /* Dq */
208 { NULL
, NULL
}, /* Ec */ /* FIXME: no space */
209 { NULL
, NULL
}, /* Ef */
210 { termp_under_pre
, NULL
}, /* Em */
211 { NULL
, NULL
}, /* Eo */
212 { termp_xx_pre
, NULL
}, /* Fx */
213 { termp_bold_pre
, NULL
}, /* Ms */ /* FIXME: convert to symbol? */
214 { NULL
, NULL
}, /* No */
215 { termp_ns_pre
, NULL
}, /* Ns */
216 { termp_xx_pre
, NULL
}, /* Nx */
217 { termp_xx_pre
, NULL
}, /* Ox */
218 { NULL
, NULL
}, /* Pc */
219 { termp_pf_pre
, termp_pf_post
}, /* Pf */
220 { termp_pq_pre
, termp_pq_post
}, /* Po */
221 { termp_pq_pre
, termp_pq_post
}, /* Pq */
222 { NULL
, NULL
}, /* Qc */
223 { termp_sq_pre
, termp_sq_post
}, /* Ql */
224 { termp_qq_pre
, termp_qq_post
}, /* Qo */
225 { termp_qq_pre
, termp_qq_post
}, /* Qq */
226 { NULL
, NULL
}, /* Re */
227 { termp_rs_pre
, NULL
}, /* Rs */
228 { NULL
, NULL
}, /* Sc */
229 { termp_sq_pre
, termp_sq_post
}, /* So */
230 { termp_sq_pre
, termp_sq_post
}, /* Sq */
231 { termp_sm_pre
, NULL
}, /* Sm */
232 { termp_under_pre
, NULL
}, /* Sx */
233 { termp_bold_pre
, NULL
}, /* Sy */
234 { NULL
, NULL
}, /* Tn */
235 { termp_xx_pre
, NULL
}, /* Ux */
236 { NULL
, NULL
}, /* Xc */
237 { NULL
, NULL
}, /* Xo */
238 { termp_fo_pre
, termp_fo_post
}, /* Fo */
239 { NULL
, NULL
}, /* Fc */
240 { termp_op_pre
, termp_op_post
}, /* Oo */
241 { NULL
, NULL
}, /* Oc */
242 { NULL
, NULL
}, /* Bk */
243 { NULL
, NULL
}, /* Ek */
244 { termp_bt_pre
, NULL
}, /* Bt */
245 { NULL
, NULL
}, /* Hf */
246 { NULL
, NULL
}, /* Fr */
247 { termp_ud_pre
, NULL
}, /* Ud */
248 { NULL
, termp_lb_post
}, /* Lb */
249 { termp_sp_pre
, NULL
}, /* Lp */
250 { termp_lk_pre
, NULL
}, /* Lk */
251 { termp_under_pre
, NULL
}, /* Mt */
252 { termp_brq_pre
, termp_brq_post
}, /* Brq */
253 { termp_brq_pre
, termp_brq_post
}, /* Bro */
254 { NULL
, NULL
}, /* Brc */
255 { NULL
, termp____post
}, /* %C */
256 { NULL
, NULL
}, /* Es */ /* TODO */
257 { NULL
, NULL
}, /* En */ /* TODO */
258 { termp_xx_pre
, NULL
}, /* Dx */
259 { NULL
, termp____post
}, /* %Q */
260 { termp_sp_pre
, NULL
}, /* br */
261 { termp_sp_pre
, NULL
}, /* sp */
262 { termp_under_pre
, termp____post
}, /* %U */
267 terminal_mdoc(void *arg
, const struct mdoc
*mdoc
)
269 const struct mdoc_node
*n
;
270 const struct mdoc_meta
*m
;
273 p
= (struct termp
*)arg
;
276 p
->maxrmargin
= p
->defrmargin
;
279 if (NULL
== p
->symtab
)
281 case (TERMENC_ASCII
):
282 p
->symtab
= chars_init(CHARS_ASCII
);
292 print_mdoc_head(p
, NULL
, m
, n
);
294 print_mdoc_nodelist(p
, NULL
, m
, n
->child
);
295 print_foot(p
, NULL
, m
, n
);
300 print_mdoc_nodelist(DECL_ARGS
)
303 print_mdoc_node(p
, pair
, m
, n
);
305 print_mdoc_nodelist(p
, pair
, m
, n
->next
);
311 print_mdoc_node(DECL_ARGS
)
315 struct termpair npair
;
316 size_t offset
, rmargin
;
320 rmargin
= p
->rmargin
;
321 font
= term_fontq(p
);
323 memset(&npair
, 0, sizeof(struct termpair
));
326 if (MDOC_TEXT
!= n
->type
) {
327 if (termacts
[n
->tok
].pre
)
328 chld
= (*termacts
[n
->tok
].pre
)(p
, &npair
, m
, n
);
330 term_word(p
, n
->string
);
332 if (chld
&& n
->child
)
333 print_mdoc_nodelist(p
, &npair
, m
, n
->child
);
335 term_fontpopq(p
, font
);
337 if (MDOC_TEXT
!= n
->type
)
338 if (termacts
[n
->tok
].post
)
339 (*termacts
[n
->tok
].post
)(p
, &npair
, m
, n
);
341 if (MDOC_EOS
& n
->flags
)
342 p
->flags
|= TERMP_SENTENCE
;
345 p
->rmargin
= rmargin
;
351 print_foot(DECL_ARGS
)
353 char buf
[DATESIZ
], os
[BUFSIZ
];
355 term_fontrepl(p
, TERMFONT_NONE
);
358 * Output the footer in new-groff style, that is, three columns
359 * with the middle being the manual date and flanking columns
360 * being the operating system:
365 time2a(m
->date
, buf
, DATESIZ
);
366 strlcpy(os
, m
->os
, BUFSIZ
);
371 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
372 p
->flags
|= TERMP_NOSPACE
| TERMP_NOBREAK
;
377 p
->offset
= p
->rmargin
;
378 p
->rmargin
= p
->maxrmargin
- strlen(os
);
379 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
384 p
->offset
= p
->rmargin
;
385 p
->rmargin
= p
->maxrmargin
;
386 p
->flags
&= ~TERMP_NOBREAK
;
387 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
393 p
->rmargin
= p
->maxrmargin
;
400 print_mdoc_head(DECL_ARGS
)
402 char buf
[BUFSIZ
], title
[BUFSIZ
];
404 p
->rmargin
= p
->maxrmargin
;
408 * The header is strange. It has three components, which are
409 * really two with the first duplicated. It goes like this:
411 * IDENTIFIER TITLE IDENTIFIER
413 * The IDENTIFIER is NAME(SECTION), which is the command-name
414 * (if given, or "unknown" if not) followed by the manual page
415 * section. These are given in `Dt'. The TITLE is a free-form
416 * string depending on the manual volume. If not specified, it
417 * switches on the manual section.
421 strlcpy(buf
, m
->vol
, BUFSIZ
);
424 strlcat(buf
, " (", BUFSIZ
);
425 strlcat(buf
, m
->arch
, BUFSIZ
);
426 strlcat(buf
, ")", BUFSIZ
);
429 snprintf(title
, BUFSIZ
, "%s(%s)", m
->title
, m
->msec
);
432 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
433 p
->flags
|= TERMP_NOBREAK
| TERMP_NOSPACE
;
438 p
->offset
= p
->rmargin
;
439 p
->rmargin
= p
->maxrmargin
- strlen(title
);
440 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
445 p
->offset
= p
->rmargin
;
446 p
->rmargin
= p
->maxrmargin
;
447 p
->flags
&= ~TERMP_NOBREAK
;
448 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
454 p
->rmargin
= p
->maxrmargin
;
455 p
->flags
&= ~TERMP_NOSPACE
;
460 a2height(const struct mdoc_node
*n
)
464 assert(MDOC_TEXT
== n
->type
);
466 if ( ! a2roffsu(n
->string
, &su
, SCALE_VS
))
467 SCALE_VS_INIT(&su
, strlen(n
->string
));
469 return(term_vspan(&su
));
474 a2width(const struct mdoc_argv
*arg
, int pos
)
478 assert(arg
->value
[pos
]);
479 if ( ! a2roffsu(arg
->value
[pos
], &su
, SCALE_MAX
))
480 SCALE_HS_INIT(&su
, strlen(arg
->value
[pos
]));
482 return(term_hspan(&su
));
487 arg_disptype(const struct mdoc_node
*n
)
491 assert(MDOC_BLOCK
== n
->type
);
493 len
= (int)(n
->args
? n
->args
->argc
: 0);
495 for (i
= 0; i
< len
; i
++)
496 switch (n
->args
->argv
[i
].arg
) {
503 case (MDOC_Unfilled
):
506 return(n
->args
->argv
[i
].arg
);
516 a2offs(const struct mdoc_argv
*arg
)
520 if ('\0' == arg
->value
[0][0])
522 else if (0 == strcmp(arg
->value
[0], "left"))
524 else if (0 == strcmp(arg
->value
[0], "indent"))
526 else if (0 == strcmp(arg
->value
[0], "indent-two"))
527 return((INDENT
+ 1) * 2);
528 else if ( ! a2roffsu(arg
->value
[0], &su
, SCALE_MAX
))
529 SCALE_HS_INIT(&su
, strlen(arg
->value
[0]));
531 return(term_hspan(&su
));
536 * Return 1 if an argument has a particular argument value or 0 if it
537 * does not. See arg_getattr().
540 arg_hasattr(int arg
, const struct mdoc_node
*n
)
543 return(-1 != arg_getattr(arg
, n
));
548 * Get the index of an argument in a node's argument list or -1 if it
549 * does not exist. See arg_getattrs().
552 arg_getattr(int v
, const struct mdoc_node
*n
)
556 return(arg_getattrs(&v
, &val
, 1, n
) ? val
: -1);
561 * Walk through the argument list for a node and fill an array "vals"
562 * with the positions of the argument structures listed in "keys".
563 * Return the number of elements that were written into "vals", which
567 arg_getattrs(const int *keys
, int *vals
,
568 size_t sz
, const struct mdoc_node
*n
)
575 for (k
= i
= 0; i
< (int)n
->args
->argc
; i
++)
576 for (j
= 0; j
< (int)sz
; j
++)
577 if (n
->args
->argv
[i
].arg
== keys
[j
]) {
586 * Determine how much space to print out before block elements of `It'
587 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
591 print_bvspace(struct termp
*p
,
592 const struct mdoc_node
*bl
,
593 const struct mdoc_node
*n
)
595 const struct mdoc_node
*nn
;
598 if (arg_hasattr(MDOC_Compact
, bl
))
601 /* Do not vspace directly after Ss/Sh. */
603 for (nn
= n
; nn
; nn
= nn
->parent
) {
604 if (MDOC_BLOCK
!= nn
->type
)
606 if (MDOC_Ss
== nn
->tok
)
608 if (MDOC_Sh
== nn
->tok
)
610 if (NULL
== nn
->prev
)
615 /* A `-column' does not assert vspace within the list. */
617 if (MDOC_Bl
== bl
->tok
&& LIST_column
== bl
->data
.list
)
618 if (n
->prev
&& MDOC_It
== n
->prev
->tok
)
621 /* A `-diag' without body does not vspace. */
623 if (MDOC_Bl
== bl
->tok
&& LIST_diag
== bl
->data
.list
)
624 if (n
->prev
&& MDOC_It
== n
->prev
->tok
) {
625 assert(n
->prev
->body
);
626 if (NULL
== n
->prev
->body
->child
)
636 termp_dq_pre(DECL_ARGS
)
639 if (MDOC_BODY
!= n
->type
)
642 term_word(p
, "\\(lq");
643 p
->flags
|= TERMP_NOSPACE
;
650 termp_dq_post(DECL_ARGS
)
653 if (MDOC_BODY
!= n
->type
)
656 p
->flags
|= TERMP_NOSPACE
;
657 term_word(p
, "\\(rq");
663 termp_it_pre(DECL_ARGS
)
665 const struct mdoc_node
*bl
, *nn
;
667 int i
, keys
[3], vals
[3];
668 size_t width
, offset
, ncols
, dcol
;
671 if (MDOC_BLOCK
== n
->type
) {
672 print_bvspace(p
, n
->parent
->parent
, n
);
676 bl
= n
->parent
->parent
->parent
;
678 /* Get list width, offset, and list type from argument list. */
680 keys
[0] = MDOC_Width
;
681 keys
[1] = MDOC_Offset
;
682 keys
[2] = MDOC_Column
;
684 vals
[0] = vals
[1] = vals
[2] = -1;
686 arg_getattrs(keys
, vals
, 3, bl
);
688 type
= bl
->data
.list
;
691 * First calculate width and offset. This is pretty easy unless
692 * we're a -column list, in which case all prior columns must
699 offset
= a2offs(&bl
->args
->argv
[vals
[1]]);
703 if (MDOC_BODY
== n
->type
)
706 * Imitate groff's column handling:
707 * - For each earlier column, add its width.
708 * - For less than 5 columns, add four more blanks per
710 * - For exactly 5 columns, add three more blank per
712 * - For more than 5 columns, add only one column.
714 ncols
= bl
->args
->argv
[vals
[2]].sz
;
716 dcol
= ncols
< 5 ? 4 : ncols
== 5 ? 3 : 1;
718 for (i
= 0, nn
= n
->prev
;
719 nn
&& i
< (int)ncols
;
721 offset
+= dcol
+ a2width
722 (&bl
->args
->argv
[vals
[2]], i
);
726 * When exceeding the declared number of columns, leave
727 * the remaining widths at 0. This will later be
728 * adjusted to the default width of 10, or, for the last
729 * column, stretched to the right margin.
735 * Use the declared column widths, extended as explained
736 * in the preceding paragraph.
738 width
= a2width(&bl
->args
->argv
[vals
[2]], i
) + dcol
;
745 * Note: buffer the width by 2, which is groff's magic
746 * number for buffering single arguments. See the above
747 * handling for column for how this changes.
749 width
= a2width(&bl
->args
->argv
[vals
[0]], 0) + 2;
754 * List-type can override the width in the case of fixed-head
755 * values (bullet, dash/hyphen, enum). Tags need a non-zero
787 * Whitespace control. Inset bodies need an initial space,
788 * while diagonal bodies need two.
791 p
->flags
|= TERMP_NOSPACE
;
795 if (MDOC_BODY
== n
->type
)
796 term_word(p
, "\\ \\ ");
799 if (MDOC_BODY
== n
->type
)
806 p
->flags
|= TERMP_NOSPACE
;
810 if (MDOC_HEAD
== n
->type
)
811 term_fontpush(p
, TERMFONT_BOLD
);
818 * Pad and break control. This is the tricky part. These flags
819 * are documented in term_flushln() in term.c. Note that we're
820 * going to unset all of these flags in termp_it_post() when we
832 if (MDOC_HEAD
== n
->type
)
833 p
->flags
|= TERMP_NOBREAK
;
835 p
->flags
|= TERMP_NOLPAD
;
838 if (MDOC_HEAD
== n
->type
)
839 p
->flags
|= TERMP_NOBREAK
;
841 p
->flags
|= TERMP_NOLPAD
;
843 if (MDOC_HEAD
!= n
->type
)
847 * This is ugly. If `-hang' is specified and the body
848 * is a `Bl' or `Bd', then we want basically to nullify
849 * the "overstep" effect in term_flushln() and treat
850 * this as a `-ohang' list instead.
852 if (n
->next
->child
&&
853 (MDOC_Bl
== n
->next
->child
->tok
||
854 MDOC_Bd
== n
->next
->child
->tok
)) {
855 p
->flags
&= ~TERMP_NOBREAK
;
856 p
->flags
&= ~TERMP_NOLPAD
;
858 p
->flags
|= TERMP_HANG
;
861 if (MDOC_HEAD
== n
->type
)
862 p
->flags
|= TERMP_NOBREAK
| TERMP_TWOSPACE
;
864 p
->flags
|= TERMP_NOLPAD
;
866 if (MDOC_HEAD
!= n
->type
)
868 if (NULL
== n
->next
|| NULL
== n
->next
->child
)
869 p
->flags
|= TERMP_DANGLE
;
872 if (MDOC_HEAD
== n
->type
) {
874 if (MDOC_BODY
== n
->next
->type
)
875 p
->flags
&= ~TERMP_NOBREAK
;
877 p
->flags
|= TERMP_NOBREAK
;
879 p
->flags
|= TERMP_NOLPAD
;
883 if (MDOC_HEAD
== n
->type
)
884 p
->flags
|= TERMP_NOBREAK
;
891 * Margin control. Set-head-width lists have their right
892 * margins shortened. The body for these lists has the offset
893 * necessarily lengthened. Everybody gets the offset.
901 * Same stipulation as above, regarding `-hang'. We
902 * don't want to recalculate rmargin and offsets when
903 * using `Bd' or `Bl' within `-hang' overstep lists.
905 if (MDOC_HEAD
== n
->type
&& n
->next
->child
&&
906 (MDOC_Bl
== n
->next
->child
->tok
||
907 MDOC_Bd
== n
->next
->child
->tok
))
920 if (MDOC_HEAD
== n
->type
)
921 p
->rmargin
= p
->offset
+ width
;
927 p
->rmargin
= p
->offset
+ width
;
929 * XXX - this behaviour is not documented: the
930 * right-most column is filled to the right margin.
932 if (MDOC_HEAD
== n
->type
&&
933 MDOC_BODY
== n
->next
->type
&&
934 p
->rmargin
< p
->maxrmargin
)
935 p
->rmargin
= p
->maxrmargin
;
942 * The dash, hyphen, bullet and enum lists all have a special
943 * HEAD character (temporarily bold, in some cases).
946 if (MDOC_HEAD
== n
->type
)
949 term_fontpush(p
, TERMFONT_BOLD
);
950 term_word(p
, "\\[bu]");
956 term_fontpush(p
, TERMFONT_BOLD
);
957 term_word(p
, "\\(hy");
961 (pair
->ppair
->ppair
->count
)++;
962 snprintf(buf
, sizeof(buf
), "%d.",
963 pair
->ppair
->ppair
->count
);
971 * If we're not going to process our children, indicate so here.
984 if (MDOC_HEAD
== n
->type
)
988 if (MDOC_BODY
== n
->type
)
1001 termp_it_post(DECL_ARGS
)
1003 enum mdoc_list type
;
1005 if (MDOC_BLOCK
== n
->type
)
1008 type
= n
->parent
->parent
->parent
->data
.list
;
1016 if (MDOC_BODY
== n
->type
)
1020 if (MDOC_HEAD
== n
->type
)
1029 * Now that our output is flushed, we can reset our tags. Since
1030 * only `It' sets these flags, we're free to assume that nobody
1031 * has munged them in the meanwhile.
1034 p
->flags
&= ~TERMP_DANGLE
;
1035 p
->flags
&= ~TERMP_NOBREAK
;
1036 p
->flags
&= ~TERMP_TWOSPACE
;
1037 p
->flags
&= ~TERMP_NOLPAD
;
1038 p
->flags
&= ~TERMP_HANG
;
1044 termp_nm_pre(DECL_ARGS
)
1047 if (NULL
== n
->child
&& NULL
== m
->name
)
1050 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1053 term_fontpush(p
, TERMFONT_BOLD
);
1055 if (NULL
== n
->child
)
1056 term_word(p
, m
->name
);
1064 termp_fl_pre(DECL_ARGS
)
1067 term_fontpush(p
, TERMFONT_BOLD
);
1068 term_word(p
, "\\-");
1071 p
->flags
|= TERMP_NOSPACE
;
1072 else if (n
->next
&& n
->next
->line
== n
->line
)
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_hasattr(MDOC_Split
, n
)) {
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
, "(),");
1182 if (n
->child
&& n
->child
->next
)
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
;
1221 if (n
->child
&& n
->child
->next
)
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_pre(DECL_ARGS
)
1254 return(MDOC_HEAD
!= n
->type
);
1260 termp_bl_post(DECL_ARGS
)
1263 if (MDOC_BLOCK
== n
->type
)
1270 termp_op_post(DECL_ARGS
)
1273 if (MDOC_BODY
!= n
->type
)
1275 p
->flags
|= TERMP_NOSPACE
;
1276 term_word(p
, "\\(rB");
1282 termp_xr_pre(DECL_ARGS
)
1284 const struct mdoc_node
*nn
;
1286 if (NULL
== n
->child
)
1289 assert(MDOC_TEXT
== n
->child
->type
);
1292 term_word(p
, nn
->string
);
1293 if (NULL
== (nn
= nn
->next
))
1295 p
->flags
|= TERMP_NOSPACE
;
1297 p
->flags
|= TERMP_NOSPACE
;
1298 term_word(p
, nn
->string
);
1299 p
->flags
|= TERMP_NOSPACE
;
1307 termp_vt_pre(DECL_ARGS
)
1310 if (MDOC_ELEM
== n
->type
)
1311 return(termp_under_pre(p
, pair
, m
, n
));
1312 else if (MDOC_HEAD
== n
->type
)
1314 else if (MDOC_BLOCK
== n
->type
)
1317 return(termp_under_pre(p
, pair
, m
, n
));
1323 termp_vt_post(DECL_ARGS
)
1326 if (MDOC_BLOCK
!= n
->type
)
1328 if (n
->next
&& MDOC_Vt
== n
->next
->tok
)
1337 termp_bold_pre(DECL_ARGS
)
1340 term_fontpush(p
, TERMFONT_BOLD
);
1347 termp_fd_post(DECL_ARGS
)
1350 if (n
->sec
!= SEC_SYNOPSIS
|| ! (MDOC_LINE
& n
->flags
))
1354 if (n
->next
&& MDOC_Fd
!= n
->next
->tok
)
1361 termp_sh_pre(DECL_ARGS
)
1364 /* No vspace between consecutive `Sh' calls. */
1368 if (n
->prev
&& MDOC_Sh
== n
->prev
->tok
)
1369 if (NULL
== n
->prev
->body
->child
)
1374 term_fontpush(p
, TERMFONT_BOLD
);
1388 termp_sh_post(DECL_ARGS
)
1407 termp_op_pre(DECL_ARGS
)
1412 term_word(p
, "\\(lB");
1413 p
->flags
|= TERMP_NOSPACE
;
1424 termp_bt_pre(DECL_ARGS
)
1427 term_word(p
, "is currently in beta test.");
1434 termp_lb_post(DECL_ARGS
)
1437 if (SEC_LIBRARY
== n
->sec
&& MDOC_LINE
& n
->flags
)
1444 termp_ud_pre(DECL_ARGS
)
1447 term_word(p
, "currently under development.");
1454 termp_d1_pre(DECL_ARGS
)
1457 if (MDOC_BLOCK
!= n
->type
)
1460 p
->offset
+= (INDENT
+ 1);
1467 termp_d1_post(DECL_ARGS
)
1470 if (MDOC_BLOCK
!= n
->type
)
1478 termp_aq_pre(DECL_ARGS
)
1481 if (MDOC_BODY
!= n
->type
)
1483 term_word(p
, "\\(la");
1484 p
->flags
|= TERMP_NOSPACE
;
1491 termp_aq_post(DECL_ARGS
)
1494 if (MDOC_BODY
!= n
->type
)
1496 p
->flags
|= TERMP_NOSPACE
;
1497 term_word(p
, "\\(ra");
1503 termp_ft_pre(DECL_ARGS
)
1506 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1507 if (n
->prev
&& MDOC_Fo
== n
->prev
->tok
)
1510 term_fontpush(p
, TERMFONT_UNDER
);
1517 termp_ft_post(DECL_ARGS
)
1520 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1527 termp_fn_pre(DECL_ARGS
)
1529 const struct mdoc_node
*nn
;
1531 term_fontpush(p
, TERMFONT_BOLD
);
1532 term_word(p
, n
->child
->string
);
1535 p
->flags
|= TERMP_NOSPACE
;
1538 for (nn
= n
->child
->next
; nn
; nn
= nn
->next
) {
1539 term_fontpush(p
, TERMFONT_UNDER
);
1540 term_word(p
, nn
->string
);
1549 if (SEC_SYNOPSIS
== n
->sec
)
1558 termp_fn_post(DECL_ARGS
)
1561 if (n
->sec
== SEC_SYNOPSIS
&& n
->next
&& MDOC_LINE
& n
->flags
)
1568 termp_fa_pre(DECL_ARGS
)
1570 const struct mdoc_node
*nn
;
1572 if (n
->parent
->tok
!= MDOC_Fo
) {
1573 term_fontpush(p
, TERMFONT_UNDER
);
1577 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1578 term_fontpush(p
, TERMFONT_UNDER
);
1579 term_word(p
, nn
->string
);
1586 if (n
->child
&& n
->next
&& n
->next
->tok
== MDOC_Fa
)
1595 termp_bd_pre(DECL_ARGS
)
1600 const struct mdoc_node
*nn
;
1602 if (MDOC_BLOCK
== n
->type
) {
1603 print_bvspace(p
, n
, n
);
1605 } else if (MDOC_HEAD
== n
->type
)
1610 type
= arg_disptype(nn
);
1613 if (-1 != (i
= arg_getattr(MDOC_Offset
, nn
)))
1614 p
->offset
+= a2offs(&nn
->args
->argv
[i
]);
1617 * If -ragged or -filled are specified, the block does nothing
1618 * but change the indentation. If -unfilled or -literal are
1619 * specified, text is printed exactly as entered in the display:
1620 * for macro lines, a newline is appended to the line. Blank
1621 * lines are allowed.
1624 if (MDOC_Literal
!= type
&& MDOC_Unfilled
!= type
)
1627 tabwidth
= p
->tabwidth
;
1630 rmax
= p
->maxrmargin
;
1631 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
1633 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1634 p
->flags
|= TERMP_NOSPACE
;
1635 print_mdoc_node(p
, pair
, m
, nn
);
1636 if (NULL
== nn
->prev
||
1637 nn
->prev
->line
< nn
->line
||
1641 p
->tabwidth
= tabwidth
;
1644 p
->maxrmargin
= rmax
;
1651 termp_bd_post(DECL_ARGS
)
1656 if (MDOC_BODY
!= n
->type
)
1659 type
= arg_disptype(n
->parent
);
1663 rmax
= p
->maxrmargin
;
1665 if (MDOC_Literal
== type
|| MDOC_Unfilled
== type
)
1666 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
1668 p
->flags
|= TERMP_NOSPACE
;
1672 p
->maxrmargin
= rmax
;
1678 termp_qq_pre(DECL_ARGS
)
1681 if (MDOC_BODY
!= n
->type
)
1684 p
->flags
|= TERMP_NOSPACE
;
1691 termp_qq_post(DECL_ARGS
)
1694 if (MDOC_BODY
!= n
->type
)
1696 p
->flags
|= TERMP_NOSPACE
;
1703 termp_bx_post(DECL_ARGS
)
1707 p
->flags
|= TERMP_NOSPACE
;
1708 term_word(p
, "BSD");
1714 termp_xx_pre(DECL_ARGS
)
1750 termp_sq_pre(DECL_ARGS
)
1753 if (MDOC_BODY
!= n
->type
)
1755 term_word(p
, "\\(oq");
1756 p
->flags
|= TERMP_NOSPACE
;
1763 termp_sq_post(DECL_ARGS
)
1766 if (MDOC_BODY
!= n
->type
)
1768 p
->flags
|= TERMP_NOSPACE
;
1769 term_word(p
, "\\(aq");
1775 termp_pf_pre(DECL_ARGS
)
1778 p
->flags
|= TERMP_IGNDELIM
;
1785 termp_pf_post(DECL_ARGS
)
1788 p
->flags
&= ~TERMP_IGNDELIM
;
1789 p
->flags
|= TERMP_NOSPACE
;
1795 termp_ss_pre(DECL_ARGS
)
1805 term_fontpush(p
, TERMFONT_BOLD
);
1806 p
->offset
= HALFINDENT
;
1818 termp_ss_post(DECL_ARGS
)
1821 if (MDOC_HEAD
== n
->type
)
1828 termp_cd_pre(DECL_ARGS
)
1831 term_fontpush(p
, TERMFONT_BOLD
);
1839 termp_in_pre(DECL_ARGS
)
1842 term_fontpush(p
, TERMFONT_BOLD
);
1843 if (SEC_SYNOPSIS
== n
->sec
)
1844 term_word(p
, "#include");
1847 p
->flags
|= TERMP_NOSPACE
;
1854 termp_in_post(DECL_ARGS
)
1857 term_fontpush(p
, TERMFONT_BOLD
);
1858 p
->flags
|= TERMP_NOSPACE
;
1862 if (SEC_SYNOPSIS
!= n
->sec
&& ! (MDOC_LINE
& n
->flags
))
1867 * XXX Not entirely correct. If `.In foo bar' is specified in
1868 * the SYNOPSIS section, then it produces a single break after
1869 * the <foo>; mandoc asserts a vertical space. Since this
1870 * construction is rarely used, I think it's fine.
1872 if (n
->next
&& MDOC_In
!= n
->next
->tok
)
1879 termp_sp_pre(DECL_ARGS
)
1885 len
= n
->child
? a2height(n
->child
) : 1;
1897 for (i
= 0; i
< len
; i
++)
1906 termp_brq_pre(DECL_ARGS
)
1909 if (MDOC_BODY
!= n
->type
)
1911 term_word(p
, "\\(lC");
1912 p
->flags
|= TERMP_NOSPACE
;
1919 termp_brq_post(DECL_ARGS
)
1922 if (MDOC_BODY
!= n
->type
)
1924 p
->flags
|= TERMP_NOSPACE
;
1925 term_word(p
, "\\(rC");
1931 termp_bq_pre(DECL_ARGS
)
1934 if (MDOC_BODY
!= n
->type
)
1936 term_word(p
, "\\(lB");
1937 p
->flags
|= TERMP_NOSPACE
;
1944 termp_bq_post(DECL_ARGS
)
1947 if (MDOC_BODY
!= n
->type
)
1949 p
->flags
|= TERMP_NOSPACE
;
1950 term_word(p
, "\\(rB");
1956 termp_pq_pre(DECL_ARGS
)
1959 if (MDOC_BODY
!= n
->type
)
1961 term_word(p
, "\\&(");
1962 p
->flags
|= TERMP_NOSPACE
;
1969 termp_pq_post(DECL_ARGS
)
1972 if (MDOC_BODY
!= n
->type
)
1980 termp_fo_pre(DECL_ARGS
)
1982 const struct mdoc_node
*nn
;
1984 if (MDOC_BODY
== n
->type
) {
1985 p
->flags
|= TERMP_NOSPACE
;
1987 p
->flags
|= TERMP_NOSPACE
;
1989 } else if (MDOC_HEAD
!= n
->type
)
1992 term_fontpush(p
, TERMFONT_BOLD
);
1993 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1994 assert(MDOC_TEXT
== nn
->type
);
1995 term_word(p
, nn
->string
);
2005 termp_fo_post(DECL_ARGS
)
2008 if (MDOC_BODY
!= n
->type
)
2010 p
->flags
|= TERMP_NOSPACE
;
2012 p
->flags
|= TERMP_NOSPACE
;
2020 termp_bf_pre(DECL_ARGS
)
2022 const struct mdoc_node
*nn
;
2024 if (MDOC_HEAD
== n
->type
)
2026 else if (MDOC_BLOCK
!= n
->type
)
2029 if (NULL
== (nn
= n
->head
->child
)) {
2030 if (arg_hasattr(MDOC_Emphasis
, n
))
2031 term_fontpush(p
, TERMFONT_UNDER
);
2032 else if (arg_hasattr(MDOC_Symbolic
, n
))
2033 term_fontpush(p
, TERMFONT_BOLD
);
2035 term_fontpush(p
, TERMFONT_NONE
);
2040 assert(MDOC_TEXT
== nn
->type
);
2041 if (0 == strcmp("Em", nn
->string
))
2042 term_fontpush(p
, TERMFONT_UNDER
);
2043 else if (0 == strcmp("Sy", nn
->string
))
2044 term_fontpush(p
, TERMFONT_BOLD
);
2046 term_fontpush(p
, TERMFONT_NONE
);
2054 termp_sm_pre(DECL_ARGS
)
2057 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
2058 if (0 == strcmp("on", n
->child
->string
))
2059 p
->flags
&= ~TERMP_NONOSPACE
;
2061 p
->flags
|= TERMP_NONOSPACE
;
2069 termp_ap_pre(DECL_ARGS
)
2072 p
->flags
|= TERMP_NOSPACE
;
2073 term_word(p
, "\\(aq");
2074 p
->flags
|= TERMP_NOSPACE
;
2081 termp____post(DECL_ARGS
)
2086 p
->flags
|= TERMP_NOSPACE
;
2087 term_word(p
, n
->next
? "," : ".");
2093 termp_li_pre(DECL_ARGS
)
2096 term_fontpush(p
, TERMFONT_NONE
);
2103 termp_lk_pre(DECL_ARGS
)
2105 const struct mdoc_node
*nn
;
2107 term_fontpush(p
, TERMFONT_UNDER
);
2110 if (NULL
== nn
->next
)
2113 term_word(p
, nn
->string
);
2116 p
->flags
|= TERMP_NOSPACE
;
2119 term_fontpush(p
, TERMFONT_BOLD
);
2120 for (nn
= nn
->next
; nn
; nn
= nn
->next
)
2121 term_word(p
, nn
->string
);
2130 termp_under_pre(DECL_ARGS
)
2133 term_fontpush(p
, TERMFONT_UNDER
);