]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.125 2010/05/17 22:11:42 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>
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 int arg_listtype(const struct mdoc_node
*);
65 static void print_bvspace(struct termp
*,
66 const struct mdoc_node
*,
67 const struct mdoc_node
*);
68 static void print_mdoc_node(DECL_ARGS
);
69 static void print_mdoc_head(DECL_ARGS
);
70 static void print_mdoc_nodelist(DECL_ARGS
);
71 static void print_foot(DECL_ARGS
);
73 static void termp____post(DECL_ARGS
);
74 static void termp_an_post(DECL_ARGS
);
75 static void termp_aq_post(DECL_ARGS
);
76 static void termp_bd_post(DECL_ARGS
);
77 static void termp_bl_post(DECL_ARGS
);
78 static void termp_bq_post(DECL_ARGS
);
79 static void termp_brq_post(DECL_ARGS
);
80 static void termp_bx_post(DECL_ARGS
);
81 static void termp_d1_post(DECL_ARGS
);
82 static void termp_dq_post(DECL_ARGS
);
83 static void termp_fd_post(DECL_ARGS
);
84 static void termp_fn_post(DECL_ARGS
);
85 static void termp_fo_post(DECL_ARGS
);
86 static void termp_ft_post(DECL_ARGS
);
87 static void termp_in_post(DECL_ARGS
);
88 static void termp_it_post(DECL_ARGS
);
89 static void termp_lb_post(DECL_ARGS
);
90 static void termp_op_post(DECL_ARGS
);
91 static void termp_pf_post(DECL_ARGS
);
92 static void termp_pq_post(DECL_ARGS
);
93 static void termp_qq_post(DECL_ARGS
);
94 static void termp_sh_post(DECL_ARGS
);
95 static void termp_sq_post(DECL_ARGS
);
96 static void termp_ss_post(DECL_ARGS
);
97 static void termp_vt_post(DECL_ARGS
);
99 static int termp_an_pre(DECL_ARGS
);
100 static int termp_ap_pre(DECL_ARGS
);
101 static int termp_aq_pre(DECL_ARGS
);
102 static int termp_bd_pre(DECL_ARGS
);
103 static int termp_bf_pre(DECL_ARGS
);
104 static int termp_bl_pre(DECL_ARGS
);
105 static int termp_bold_pre(DECL_ARGS
);
106 static int termp_bq_pre(DECL_ARGS
);
107 static int termp_brq_pre(DECL_ARGS
);
108 static int termp_bt_pre(DECL_ARGS
);
109 static int termp_cd_pre(DECL_ARGS
);
110 static int termp_d1_pre(DECL_ARGS
);
111 static int termp_dq_pre(DECL_ARGS
);
112 static int termp_ex_pre(DECL_ARGS
);
113 static int termp_fa_pre(DECL_ARGS
);
114 static int termp_fl_pre(DECL_ARGS
);
115 static int termp_fn_pre(DECL_ARGS
);
116 static int termp_fo_pre(DECL_ARGS
);
117 static int termp_ft_pre(DECL_ARGS
);
118 static int termp_in_pre(DECL_ARGS
);
119 static int termp_it_pre(DECL_ARGS
);
120 static int termp_li_pre(DECL_ARGS
);
121 static int termp_lk_pre(DECL_ARGS
);
122 static int termp_nd_pre(DECL_ARGS
);
123 static int termp_nm_pre(DECL_ARGS
);
124 static int termp_ns_pre(DECL_ARGS
);
125 static int termp_op_pre(DECL_ARGS
);
126 static int termp_pf_pre(DECL_ARGS
);
127 static int termp_pq_pre(DECL_ARGS
);
128 static int termp_qq_pre(DECL_ARGS
);
129 static int termp_rs_pre(DECL_ARGS
);
130 static int termp_rv_pre(DECL_ARGS
);
131 static int termp_sh_pre(DECL_ARGS
);
132 static int termp_sm_pre(DECL_ARGS
);
133 static int termp_sp_pre(DECL_ARGS
);
134 static int termp_sq_pre(DECL_ARGS
);
135 static int termp_ss_pre(DECL_ARGS
);
136 static int termp_under_pre(DECL_ARGS
);
137 static int termp_ud_pre(DECL_ARGS
);
138 static int termp_vt_pre(DECL_ARGS
);
139 static int termp_xr_pre(DECL_ARGS
);
140 static int termp_xx_pre(DECL_ARGS
);
142 static const struct termact termacts
[MDOC_MAX
] = {
143 { termp_ap_pre
, NULL
}, /* Ap */
144 { NULL
, NULL
}, /* Dd */
145 { NULL
, NULL
}, /* Dt */
146 { NULL
, NULL
}, /* Os */
147 { termp_sh_pre
, termp_sh_post
}, /* Sh */
148 { termp_ss_pre
, termp_ss_post
}, /* Ss */
149 { termp_sp_pre
, NULL
}, /* Pp */
150 { termp_d1_pre
, termp_d1_post
}, /* D1 */
151 { termp_d1_pre
, termp_d1_post
}, /* Dl */
152 { termp_bd_pre
, termp_bd_post
}, /* Bd */
153 { NULL
, NULL
}, /* Ed */
154 { termp_bl_pre
, termp_bl_post
}, /* Bl */
155 { NULL
, NULL
}, /* El */
156 { termp_it_pre
, termp_it_post
}, /* It */
157 { NULL
, NULL
}, /* Ad */
158 { termp_an_pre
, termp_an_post
}, /* An */
159 { termp_under_pre
, NULL
}, /* Ar */
160 { termp_cd_pre
, NULL
}, /* Cd */
161 { termp_bold_pre
, NULL
}, /* Cm */
162 { NULL
, NULL
}, /* Dv */
163 { NULL
, NULL
}, /* Er */
164 { NULL
, NULL
}, /* Ev */
165 { termp_ex_pre
, NULL
}, /* Ex */
166 { termp_fa_pre
, NULL
}, /* Fa */
167 { termp_bold_pre
, termp_fd_post
}, /* Fd */
168 { termp_fl_pre
, NULL
}, /* Fl */
169 { termp_fn_pre
, termp_fn_post
}, /* Fn */
170 { termp_ft_pre
, termp_ft_post
}, /* Ft */
171 { termp_bold_pre
, NULL
}, /* Ic */
172 { termp_in_pre
, termp_in_post
}, /* In */
173 { termp_li_pre
, NULL
}, /* Li */
174 { termp_nd_pre
, NULL
}, /* Nd */
175 { termp_nm_pre
, NULL
}, /* Nm */
176 { termp_op_pre
, termp_op_post
}, /* Op */
177 { NULL
, NULL
}, /* Ot */
178 { termp_under_pre
, NULL
}, /* Pa */
179 { termp_rv_pre
, NULL
}, /* Rv */
180 { NULL
, NULL
}, /* St */
181 { termp_under_pre
, NULL
}, /* Va */
182 { termp_vt_pre
, termp_vt_post
}, /* Vt */
183 { termp_xr_pre
, NULL
}, /* Xr */
184 { NULL
, termp____post
}, /* %A */
185 { termp_under_pre
, termp____post
}, /* %B */
186 { NULL
, termp____post
}, /* %D */
187 { termp_under_pre
, termp____post
}, /* %I */
188 { termp_under_pre
, termp____post
}, /* %J */
189 { NULL
, termp____post
}, /* %N */
190 { NULL
, termp____post
}, /* %O */
191 { NULL
, termp____post
}, /* %P */
192 { NULL
, termp____post
}, /* %R */
193 { termp_under_pre
, termp____post
}, /* %T */
194 { NULL
, termp____post
}, /* %V */
195 { NULL
, NULL
}, /* Ac */
196 { termp_aq_pre
, termp_aq_post
}, /* Ao */
197 { termp_aq_pre
, termp_aq_post
}, /* Aq */
198 { NULL
, NULL
}, /* At */
199 { NULL
, NULL
}, /* Bc */
200 { termp_bf_pre
, NULL
}, /* Bf */
201 { termp_bq_pre
, termp_bq_post
}, /* Bo */
202 { termp_bq_pre
, termp_bq_post
}, /* Bq */
203 { termp_xx_pre
, NULL
}, /* Bsx */
204 { NULL
, termp_bx_post
}, /* Bx */
205 { NULL
, NULL
}, /* Db */
206 { NULL
, NULL
}, /* Dc */
207 { termp_dq_pre
, termp_dq_post
}, /* Do */
208 { termp_dq_pre
, termp_dq_post
}, /* Dq */
209 { NULL
, NULL
}, /* Ec */ /* FIXME: no space */
210 { NULL
, NULL
}, /* Ef */
211 { termp_under_pre
, NULL
}, /* Em */
212 { NULL
, NULL
}, /* Eo */
213 { termp_xx_pre
, NULL
}, /* Fx */
214 { termp_bold_pre
, NULL
}, /* Ms */ /* FIXME: convert to symbol? */
215 { NULL
, NULL
}, /* No */
216 { termp_ns_pre
, NULL
}, /* Ns */
217 { termp_xx_pre
, NULL
}, /* Nx */
218 { termp_xx_pre
, NULL
}, /* Ox */
219 { NULL
, NULL
}, /* Pc */
220 { termp_pf_pre
, termp_pf_post
}, /* Pf */
221 { termp_pq_pre
, termp_pq_post
}, /* Po */
222 { termp_pq_pre
, termp_pq_post
}, /* Pq */
223 { NULL
, NULL
}, /* Qc */
224 { termp_sq_pre
, termp_sq_post
}, /* Ql */
225 { termp_qq_pre
, termp_qq_post
}, /* Qo */
226 { termp_qq_pre
, termp_qq_post
}, /* Qq */
227 { NULL
, NULL
}, /* Re */
228 { termp_rs_pre
, NULL
}, /* Rs */
229 { NULL
, NULL
}, /* Sc */
230 { termp_sq_pre
, termp_sq_post
}, /* So */
231 { termp_sq_pre
, termp_sq_post
}, /* Sq */
232 { termp_sm_pre
, NULL
}, /* Sm */
233 { termp_under_pre
, NULL
}, /* Sx */
234 { termp_bold_pre
, NULL
}, /* Sy */
235 { NULL
, NULL
}, /* Tn */
236 { termp_xx_pre
, NULL
}, /* Ux */
237 { NULL
, NULL
}, /* Xc */
238 { NULL
, NULL
}, /* Xo */
239 { termp_fo_pre
, termp_fo_post
}, /* Fo */
240 { NULL
, NULL
}, /* Fc */
241 { termp_op_pre
, termp_op_post
}, /* Oo */
242 { NULL
, NULL
}, /* Oc */
243 { NULL
, NULL
}, /* Bk */
244 { NULL
, NULL
}, /* Ek */
245 { termp_bt_pre
, NULL
}, /* Bt */
246 { NULL
, NULL
}, /* Hf */
247 { NULL
, NULL
}, /* Fr */
248 { termp_ud_pre
, NULL
}, /* Ud */
249 { NULL
, termp_lb_post
}, /* Lb */
250 { termp_sp_pre
, NULL
}, /* Lp */
251 { termp_lk_pre
, NULL
}, /* Lk */
252 { termp_under_pre
, NULL
}, /* Mt */
253 { termp_brq_pre
, termp_brq_post
}, /* Brq */
254 { termp_brq_pre
, termp_brq_post
}, /* Bro */
255 { NULL
, NULL
}, /* Brc */
256 { NULL
, termp____post
}, /* %C */
257 { NULL
, NULL
}, /* Es */ /* TODO */
258 { NULL
, NULL
}, /* En */ /* TODO */
259 { termp_xx_pre
, NULL
}, /* Dx */
260 { NULL
, termp____post
}, /* %Q */
261 { termp_sp_pre
, NULL
}, /* br */
262 { termp_sp_pre
, NULL
}, /* sp */
263 { termp_under_pre
, termp____post
}, /* %U */
268 terminal_mdoc(void *arg
, const struct mdoc
*mdoc
)
270 const struct mdoc_node
*n
;
271 const struct mdoc_meta
*m
;
274 p
= (struct termp
*)arg
;
277 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 arg_listtype(const struct mdoc_node
*n
)
520 assert(MDOC_BLOCK
== n
->type
);
522 len
= (int)(n
->args
? n
->args
->argc
: 0);
524 for (i
= 0; i
< len
; i
++)
525 switch (n
->args
->argv
[i
].arg
) {
547 return(n
->args
->argv
[i
].arg
);
557 a2offs(const struct mdoc_argv
*arg
)
561 if ('\0' == arg
->value
[0][0])
563 else if (0 == strcmp(arg
->value
[0], "left"))
565 else if (0 == strcmp(arg
->value
[0], "indent"))
567 else if (0 == strcmp(arg
->value
[0], "indent-two"))
568 return((INDENT
+ 1) * 2);
569 else if ( ! a2roffsu(arg
->value
[0], &su
, SCALE_MAX
))
570 SCALE_HS_INIT(&su
, strlen(arg
->value
[0]));
572 return(term_hspan(&su
));
577 * Return 1 if an argument has a particular argument value or 0 if it
578 * does not. See arg_getattr().
581 arg_hasattr(int arg
, const struct mdoc_node
*n
)
584 return(-1 != arg_getattr(arg
, n
));
589 * Get the index of an argument in a node's argument list or -1 if it
590 * does not exist. See arg_getattrs().
593 arg_getattr(int v
, const struct mdoc_node
*n
)
597 return(arg_getattrs(&v
, &val
, 1, n
) ? val
: -1);
602 * Walk through the argument list for a node and fill an array "vals"
603 * with the positions of the argument structures listed in "keys".
604 * Return the number of elements that were written into "vals", which
608 arg_getattrs(const int *keys
, int *vals
,
609 size_t sz
, const struct mdoc_node
*n
)
616 for (k
= i
= 0; i
< (int)n
->args
->argc
; i
++)
617 for (j
= 0; j
< (int)sz
; j
++)
618 if (n
->args
->argv
[i
].arg
== keys
[j
]) {
627 * Determine how much space to print out before block elements of `It'
628 * (and thus `Bl') and `Bd'. And then go ahead and print that space,
632 print_bvspace(struct termp
*p
,
633 const struct mdoc_node
*bl
,
634 const struct mdoc_node
*n
)
636 const struct mdoc_node
*nn
;
639 if (arg_hasattr(MDOC_Compact
, bl
))
642 /* Do not vspace directly after Ss/Sh. */
644 for (nn
= n
; nn
; nn
= nn
->parent
) {
645 if (MDOC_BLOCK
!= nn
->type
)
647 if (MDOC_Ss
== nn
->tok
)
649 if (MDOC_Sh
== nn
->tok
)
651 if (NULL
== nn
->prev
)
656 /* A `-column' does not assert vspace within the list. */
658 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Column
, bl
))
659 if (n
->prev
&& MDOC_It
== n
->prev
->tok
)
662 /* A `-diag' without body does not vspace. */
664 if (MDOC_Bl
== bl
->tok
&& arg_hasattr(MDOC_Diag
, bl
))
665 if (n
->prev
&& MDOC_It
== n
->prev
->tok
) {
666 assert(n
->prev
->body
);
667 if (NULL
== n
->prev
->body
->child
)
677 termp_dq_pre(DECL_ARGS
)
680 if (MDOC_BODY
!= n
->type
)
683 term_word(p
, "\\(lq");
684 p
->flags
|= TERMP_NOSPACE
;
691 termp_dq_post(DECL_ARGS
)
694 if (MDOC_BODY
!= n
->type
)
697 p
->flags
|= TERMP_NOSPACE
;
698 term_word(p
, "\\(rq");
704 termp_it_pre(DECL_ARGS
)
706 const struct mdoc_node
*bl
, *nn
;
708 int i
, type
, keys
[3], vals
[3];
709 size_t width
, offset
, ncols
, dcol
;
711 if (MDOC_BLOCK
== n
->type
) {
712 print_bvspace(p
, n
->parent
->parent
, n
);
716 bl
= n
->parent
->parent
->parent
;
718 /* Get list width, offset, and list type from argument list. */
720 keys
[0] = MDOC_Width
;
721 keys
[1] = MDOC_Offset
;
722 keys
[2] = MDOC_Column
;
724 vals
[0] = vals
[1] = vals
[2] = -1;
726 arg_getattrs(keys
, vals
, 3, bl
);
728 type
= arg_listtype(bl
);
732 * First calculate width and offset. This is pretty easy unless
733 * we're a -column list, in which case all prior columns must
740 offset
= a2offs(&bl
->args
->argv
[vals
[1]]);
744 if (MDOC_BODY
== n
->type
)
747 * Imitate groff's column handling:
748 * - For each earlier column, add its width.
749 * - For less than 5 columns, add four more blanks per
751 * - For exactly 5 columns, add three more blank per
753 * - For more than 5 columns, add only one column.
755 ncols
= bl
->args
->argv
[vals
[2]].sz
;
757 dcol
= ncols
< 5 ? 4 : ncols
== 5 ? 3 : 1;
759 for (i
= 0, nn
= n
->prev
;
760 nn
&& i
< (int)ncols
;
762 offset
+= dcol
+ a2width
763 (&bl
->args
->argv
[vals
[2]], i
);
767 * When exceeding the declared number of columns, leave
768 * the remaining widths at 0. This will later be
769 * adjusted to the default width of 10, or, for the last
770 * column, stretched to the right margin.
776 * Use the declared column widths, extended as explained
777 * in the preceding paragraph.
779 width
= a2width(&bl
->args
->argv
[vals
[2]], i
) + dcol
;
786 * Note: buffer the width by 2, which is groff's magic
787 * number for buffering single arguments. See the above
788 * handling for column for how this changes.
790 width
= a2width(&bl
->args
->argv
[vals
[0]], 0) + 2;
795 * List-type can override the width in the case of fixed-head
796 * values (bullet, dash/hyphen, enum). Tags need a non-zero
828 * Whitespace control. Inset bodies need an initial space,
829 * while diagonal bodies need two.
832 p
->flags
|= TERMP_NOSPACE
;
836 if (MDOC_BODY
== n
->type
)
837 term_word(p
, "\\ \\ ");
840 if (MDOC_BODY
== n
->type
)
847 p
->flags
|= TERMP_NOSPACE
;
851 if (MDOC_HEAD
== n
->type
)
852 term_fontpush(p
, TERMFONT_BOLD
);
859 * Pad and break control. This is the tricky part. These flags
860 * are documented in term_flushln() in term.c. Note that we're
861 * going to unset all of these flags in termp_it_post() when we
873 if (MDOC_HEAD
== n
->type
)
874 p
->flags
|= TERMP_NOBREAK
;
876 p
->flags
|= TERMP_NOLPAD
;
879 if (MDOC_HEAD
== n
->type
)
880 p
->flags
|= TERMP_NOBREAK
;
882 p
->flags
|= TERMP_NOLPAD
;
884 if (MDOC_HEAD
!= n
->type
)
888 * This is ugly. If `-hang' is specified and the body
889 * is a `Bl' or `Bd', then we want basically to nullify
890 * the "overstep" effect in term_flushln() and treat
891 * this as a `-ohang' list instead.
893 if (n
->next
->child
&&
894 (MDOC_Bl
== n
->next
->child
->tok
||
895 MDOC_Bd
== n
->next
->child
->tok
)) {
896 p
->flags
&= ~TERMP_NOBREAK
;
897 p
->flags
&= ~TERMP_NOLPAD
;
899 p
->flags
|= TERMP_HANG
;
902 if (MDOC_HEAD
== n
->type
)
903 p
->flags
|= TERMP_NOBREAK
| TERMP_TWOSPACE
;
905 p
->flags
|= TERMP_NOLPAD
;
907 if (MDOC_HEAD
!= n
->type
)
909 if (NULL
== n
->next
|| NULL
== n
->next
->child
)
910 p
->flags
|= TERMP_DANGLE
;
913 if (MDOC_HEAD
== n
->type
) {
915 if (MDOC_BODY
== n
->next
->type
)
916 p
->flags
&= ~TERMP_NOBREAK
;
918 p
->flags
|= TERMP_NOBREAK
;
920 p
->flags
|= TERMP_NOLPAD
;
924 if (MDOC_HEAD
== n
->type
)
925 p
->flags
|= TERMP_NOBREAK
;
932 * Margin control. Set-head-width lists have their right
933 * margins shortened. The body for these lists has the offset
934 * necessarily lengthened. Everybody gets the offset.
942 * Same stipulation as above, regarding `-hang'. We
943 * don't want to recalculate rmargin and offsets when
944 * using `Bd' or `Bl' within `-hang' overstep lists.
946 if (MDOC_HEAD
== n
->type
&& n
->next
->child
&&
947 (MDOC_Bl
== n
->next
->child
->tok
||
948 MDOC_Bd
== n
->next
->child
->tok
))
961 if (MDOC_HEAD
== n
->type
)
962 p
->rmargin
= p
->offset
+ width
;
968 p
->rmargin
= p
->offset
+ width
;
970 * XXX - this behaviour is not documented: the
971 * right-most column is filled to the right margin.
973 if (MDOC_HEAD
== n
->type
&&
974 MDOC_BODY
== n
->next
->type
&&
975 p
->rmargin
< p
->maxrmargin
)
976 p
->rmargin
= p
->maxrmargin
;
983 * The dash, hyphen, bullet and enum lists all have a special
984 * HEAD character (temporarily bold, in some cases).
987 if (MDOC_HEAD
== n
->type
)
990 term_fontpush(p
, TERMFONT_BOLD
);
991 term_word(p
, "\\[bu]");
997 term_fontpush(p
, TERMFONT_BOLD
);
998 term_word(p
, "\\(hy");
1002 (pair
->ppair
->ppair
->count
)++;
1003 snprintf(buf
, sizeof(buf
), "%d.",
1004 pair
->ppair
->ppair
->count
);
1012 * If we're not going to process our children, indicate so here.
1025 if (MDOC_HEAD
== n
->type
)
1029 if (MDOC_BODY
== n
->type
)
1042 termp_it_post(DECL_ARGS
)
1046 if (MDOC_BLOCK
== n
->type
)
1049 type
= arg_listtype(n
->parent
->parent
->parent
);
1058 if (MDOC_BODY
== n
->type
)
1062 if (MDOC_HEAD
== n
->type
)
1071 * Now that our output is flushed, we can reset our tags. Since
1072 * only `It' sets these flags, we're free to assume that nobody
1073 * has munged them in the meanwhile.
1076 p
->flags
&= ~TERMP_DANGLE
;
1077 p
->flags
&= ~TERMP_NOBREAK
;
1078 p
->flags
&= ~TERMP_TWOSPACE
;
1079 p
->flags
&= ~TERMP_NOLPAD
;
1080 p
->flags
&= ~TERMP_HANG
;
1086 termp_nm_pre(DECL_ARGS
)
1089 if (NULL
== n
->child
&& NULL
== m
->name
)
1091 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1094 term_fontpush(p
, TERMFONT_BOLD
);
1096 if (NULL
== n
->child
)
1097 term_word(p
, m
->name
);
1105 termp_fl_pre(DECL_ARGS
)
1108 term_fontpush(p
, TERMFONT_BOLD
);
1109 term_word(p
, "\\-");
1112 p
->flags
|= TERMP_NOSPACE
;
1113 else if (n
->next
&& n
->next
->line
== n
->line
)
1114 p
->flags
|= TERMP_NOSPACE
;
1122 termp_an_pre(DECL_ARGS
)
1125 if (NULL
== n
->child
)
1129 * If not in the AUTHORS section, `An -split' will cause
1130 * newlines to occur before the author name. If in the AUTHORS
1131 * section, by default, the first `An' invocation is nosplit,
1132 * then all subsequent ones, regardless of whether interspersed
1133 * with other macros/text, are split. -split, in this case,
1134 * will override the condition of the implied first -nosplit.
1137 if (n
->sec
== SEC_AUTHORS
) {
1138 if ( ! (TERMP_ANPREC
& p
->flags
)) {
1139 if (TERMP_SPLIT
& p
->flags
)
1143 if (TERMP_NOSPLIT
& p
->flags
)
1149 if (TERMP_SPLIT
& p
->flags
)
1158 termp_an_post(DECL_ARGS
)
1162 if (SEC_AUTHORS
== n
->sec
)
1163 p
->flags
|= TERMP_ANPREC
;
1167 if (arg_hasattr(MDOC_Split
, n
)) {
1168 p
->flags
&= ~TERMP_NOSPLIT
;
1169 p
->flags
|= TERMP_SPLIT
;
1171 p
->flags
&= ~TERMP_SPLIT
;
1172 p
->flags
|= TERMP_NOSPLIT
;
1180 termp_ns_pre(DECL_ARGS
)
1183 p
->flags
|= TERMP_NOSPACE
;
1190 termp_rs_pre(DECL_ARGS
)
1193 if (SEC_SEE_ALSO
!= n
->sec
)
1195 if (MDOC_BLOCK
== n
->type
&& n
->prev
)
1203 termp_rv_pre(DECL_ARGS
)
1205 const struct mdoc_node
*nn
;
1208 term_word(p
, "The");
1210 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1211 term_fontpush(p
, TERMFONT_BOLD
);
1212 term_word(p
, nn
->string
);
1214 p
->flags
|= TERMP_NOSPACE
;
1215 if (nn
->next
&& NULL
== nn
->next
->next
)
1216 term_word(p
, "(), and");
1218 term_word(p
, "(),");
1223 if (n
->child
&& n
->child
->next
)
1224 term_word(p
, "functions return");
1226 term_word(p
, "function returns");
1228 term_word(p
, "the value 0 if successful; otherwise the value "
1229 "-1 is returned and the global variable");
1231 term_fontpush(p
, TERMFONT_UNDER
);
1232 term_word(p
, "errno");
1235 term_word(p
, "is set to indicate the error.");
1243 termp_ex_pre(DECL_ARGS
)
1245 const struct mdoc_node
*nn
;
1247 term_word(p
, "The");
1249 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1250 term_fontpush(p
, TERMFONT_BOLD
);
1251 term_word(p
, nn
->string
);
1253 p
->flags
|= TERMP_NOSPACE
;
1254 if (nn
->next
&& NULL
== nn
->next
->next
)
1255 term_word(p
, ", and");
1259 p
->flags
&= ~TERMP_NOSPACE
;
1262 if (n
->child
&& n
->child
->next
)
1263 term_word(p
, "utilities exit");
1265 term_word(p
, "utility exits");
1267 term_word(p
, "0 on success, and >0 if an error occurs.");
1275 termp_nd_pre(DECL_ARGS
)
1278 if (MDOC_BODY
!= n
->type
)
1281 #if defined(__OpenBSD__) || defined(__linux__)
1282 term_word(p
, "\\(en");
1284 term_word(p
, "\\(em");
1292 termp_bl_pre(DECL_ARGS
)
1295 return(MDOC_HEAD
!= n
->type
);
1301 termp_bl_post(DECL_ARGS
)
1304 if (MDOC_BLOCK
== n
->type
)
1311 termp_op_post(DECL_ARGS
)
1314 if (MDOC_BODY
!= n
->type
)
1316 p
->flags
|= TERMP_NOSPACE
;
1317 term_word(p
, "\\(rB");
1323 termp_xr_pre(DECL_ARGS
)
1325 const struct mdoc_node
*nn
;
1327 if (NULL
== n
->child
)
1330 assert(MDOC_TEXT
== n
->child
->type
);
1333 term_word(p
, nn
->string
);
1334 if (NULL
== (nn
= nn
->next
))
1336 p
->flags
|= TERMP_NOSPACE
;
1338 p
->flags
|= TERMP_NOSPACE
;
1339 term_word(p
, nn
->string
);
1340 p
->flags
|= TERMP_NOSPACE
;
1348 termp_vt_pre(DECL_ARGS
)
1351 if (MDOC_ELEM
== n
->type
)
1352 return(termp_under_pre(p
, pair
, m
, n
));
1353 else if (MDOC_HEAD
== n
->type
)
1355 else if (MDOC_BLOCK
== n
->type
)
1358 return(termp_under_pre(p
, pair
, m
, n
));
1364 termp_vt_post(DECL_ARGS
)
1367 if (MDOC_BLOCK
!= n
->type
)
1369 if (n
->next
&& MDOC_Vt
== n
->next
->tok
)
1378 termp_bold_pre(DECL_ARGS
)
1381 term_fontpush(p
, TERMFONT_BOLD
);
1388 termp_fd_post(DECL_ARGS
)
1391 if (n
->sec
!= SEC_SYNOPSIS
|| ! (MDOC_LINE
& n
->flags
))
1395 if (n
->next
&& MDOC_Fd
!= n
->next
->tok
)
1402 termp_sh_pre(DECL_ARGS
)
1405 /* No vspace between consecutive `Sh' calls. */
1409 if (n
->prev
&& MDOC_Sh
== n
->prev
->tok
)
1410 if (NULL
== n
->prev
->body
->child
)
1415 term_fontpush(p
, TERMFONT_BOLD
);
1429 termp_sh_post(DECL_ARGS
)
1448 termp_op_pre(DECL_ARGS
)
1453 term_word(p
, "\\(lB");
1454 p
->flags
|= TERMP_NOSPACE
;
1465 termp_bt_pre(DECL_ARGS
)
1468 term_word(p
, "is currently in beta test.");
1475 termp_lb_post(DECL_ARGS
)
1478 if (SEC_LIBRARY
== n
->sec
&& MDOC_LINE
& n
->flags
)
1485 termp_ud_pre(DECL_ARGS
)
1488 term_word(p
, "currently under development.");
1495 termp_d1_pre(DECL_ARGS
)
1498 if (MDOC_BLOCK
!= n
->type
)
1501 p
->offset
+= (INDENT
+ 1);
1508 termp_d1_post(DECL_ARGS
)
1511 if (MDOC_BLOCK
!= n
->type
)
1519 termp_aq_pre(DECL_ARGS
)
1522 if (MDOC_BODY
!= n
->type
)
1524 term_word(p
, "\\(la");
1525 p
->flags
|= TERMP_NOSPACE
;
1532 termp_aq_post(DECL_ARGS
)
1535 if (MDOC_BODY
!= n
->type
)
1537 p
->flags
|= TERMP_NOSPACE
;
1538 term_word(p
, "\\(ra");
1544 termp_ft_pre(DECL_ARGS
)
1547 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1548 if (n
->prev
&& MDOC_Fo
== n
->prev
->tok
)
1551 term_fontpush(p
, TERMFONT_UNDER
);
1558 termp_ft_post(DECL_ARGS
)
1561 if (SEC_SYNOPSIS
== n
->sec
&& MDOC_LINE
& n
->flags
)
1568 termp_fn_pre(DECL_ARGS
)
1570 const struct mdoc_node
*nn
;
1572 term_fontpush(p
, TERMFONT_BOLD
);
1573 term_word(p
, n
->child
->string
);
1576 p
->flags
|= TERMP_NOSPACE
;
1579 for (nn
= n
->child
->next
; nn
; nn
= nn
->next
) {
1580 term_fontpush(p
, TERMFONT_UNDER
);
1581 term_word(p
, nn
->string
);
1590 if (SEC_SYNOPSIS
== n
->sec
)
1599 termp_fn_post(DECL_ARGS
)
1602 if (n
->sec
== SEC_SYNOPSIS
&& n
->next
&& MDOC_LINE
& n
->flags
)
1609 termp_fa_pre(DECL_ARGS
)
1611 const struct mdoc_node
*nn
;
1613 if (n
->parent
->tok
!= MDOC_Fo
) {
1614 term_fontpush(p
, TERMFONT_UNDER
);
1618 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1619 term_fontpush(p
, TERMFONT_UNDER
);
1620 term_word(p
, nn
->string
);
1627 if (n
->child
&& n
->next
&& n
->next
->tok
== MDOC_Fa
)
1636 termp_bd_pre(DECL_ARGS
)
1640 const struct mdoc_node
*nn
;
1642 if (MDOC_BLOCK
== n
->type
) {
1643 print_bvspace(p
, n
, n
);
1645 } else if (MDOC_HEAD
== n
->type
)
1650 type
= arg_disptype(nn
);
1653 if (-1 != (i
= arg_getattr(MDOC_Offset
, nn
)))
1654 p
->offset
+= a2offs(&nn
->args
->argv
[i
]);
1657 * If -ragged or -filled are specified, the block does nothing
1658 * but change the indentation. If -unfilled or -literal are
1659 * specified, text is printed exactly as entered in the display:
1660 * for macro lines, a newline is appended to the line. Blank
1661 * lines are allowed.
1664 if (MDOC_Literal
!= type
&& MDOC_Unfilled
!= type
)
1668 rmax
= p
->maxrmargin
;
1669 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
1671 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
1672 p
->flags
|= TERMP_NOSPACE
;
1673 print_mdoc_node(p
, pair
, m
, nn
);
1674 if (NULL
== nn
->next
)
1676 if (nn
->prev
&& nn
->prev
->line
< nn
->line
)
1678 else if (NULL
== nn
->prev
)
1683 p
->maxrmargin
= rmax
;
1690 termp_bd_post(DECL_ARGS
)
1695 if (MDOC_BODY
!= n
->type
)
1698 type
= arg_disptype(n
->parent
);
1702 rmax
= p
->maxrmargin
;
1704 if (MDOC_Literal
== type
|| MDOC_Unfilled
== type
)
1705 p
->rmargin
= p
->maxrmargin
= TERM_MAXMARGIN
;
1707 p
->flags
|= TERMP_NOSPACE
;
1711 p
->maxrmargin
= rmax
;
1717 termp_qq_pre(DECL_ARGS
)
1720 if (MDOC_BODY
!= n
->type
)
1723 p
->flags
|= TERMP_NOSPACE
;
1730 termp_qq_post(DECL_ARGS
)
1733 if (MDOC_BODY
!= n
->type
)
1735 p
->flags
|= TERMP_NOSPACE
;
1742 termp_bx_post(DECL_ARGS
)
1746 p
->flags
|= TERMP_NOSPACE
;
1747 term_word(p
, "BSD");
1753 termp_xx_pre(DECL_ARGS
)
1789 termp_sq_pre(DECL_ARGS
)
1792 if (MDOC_BODY
!= n
->type
)
1794 term_word(p
, "\\(oq");
1795 p
->flags
|= TERMP_NOSPACE
;
1802 termp_sq_post(DECL_ARGS
)
1805 if (MDOC_BODY
!= n
->type
)
1807 p
->flags
|= TERMP_NOSPACE
;
1808 term_word(p
, "\\(aq");
1814 termp_pf_pre(DECL_ARGS
)
1817 p
->flags
|= TERMP_IGNDELIM
;
1824 termp_pf_post(DECL_ARGS
)
1827 p
->flags
&= ~TERMP_IGNDELIM
;
1828 p
->flags
|= TERMP_NOSPACE
;
1834 termp_ss_pre(DECL_ARGS
)
1844 term_fontpush(p
, TERMFONT_BOLD
);
1845 p
->offset
= HALFINDENT
;
1857 termp_ss_post(DECL_ARGS
)
1860 if (MDOC_HEAD
== n
->type
)
1867 termp_cd_pre(DECL_ARGS
)
1870 term_fontpush(p
, TERMFONT_BOLD
);
1878 termp_in_pre(DECL_ARGS
)
1881 term_fontpush(p
, TERMFONT_BOLD
);
1882 if (SEC_SYNOPSIS
== n
->sec
)
1883 term_word(p
, "#include");
1886 p
->flags
|= TERMP_NOSPACE
;
1893 termp_in_post(DECL_ARGS
)
1896 term_fontpush(p
, TERMFONT_BOLD
);
1897 p
->flags
|= TERMP_NOSPACE
;
1901 if (SEC_SYNOPSIS
!= n
->sec
&& ! (MDOC_LINE
& n
->flags
))
1906 * XXX Not entirely correct. If `.In foo bar' is specified in
1907 * the SYNOPSIS section, then it produces a single break after
1908 * the <foo>; mandoc asserts a vertical space. Since this
1909 * construction is rarely used, I think it's fine.
1911 if (n
->next
&& MDOC_In
!= n
->next
->tok
)
1918 termp_sp_pre(DECL_ARGS
)
1924 len
= n
->child
? a2height(n
->child
) : 1;
1936 for (i
= 0; i
< len
; i
++)
1945 termp_brq_pre(DECL_ARGS
)
1948 if (MDOC_BODY
!= n
->type
)
1950 term_word(p
, "\\(lC");
1951 p
->flags
|= TERMP_NOSPACE
;
1958 termp_brq_post(DECL_ARGS
)
1961 if (MDOC_BODY
!= n
->type
)
1963 p
->flags
|= TERMP_NOSPACE
;
1964 term_word(p
, "\\(rC");
1970 termp_bq_pre(DECL_ARGS
)
1973 if (MDOC_BODY
!= n
->type
)
1975 term_word(p
, "\\(lB");
1976 p
->flags
|= TERMP_NOSPACE
;
1983 termp_bq_post(DECL_ARGS
)
1986 if (MDOC_BODY
!= n
->type
)
1988 p
->flags
|= TERMP_NOSPACE
;
1989 term_word(p
, "\\(rB");
1995 termp_pq_pre(DECL_ARGS
)
1998 if (MDOC_BODY
!= n
->type
)
2000 term_word(p
, "\\&(");
2001 p
->flags
|= TERMP_NOSPACE
;
2008 termp_pq_post(DECL_ARGS
)
2011 if (MDOC_BODY
!= n
->type
)
2019 termp_fo_pre(DECL_ARGS
)
2021 const struct mdoc_node
*nn
;
2023 if (MDOC_BODY
== n
->type
) {
2024 p
->flags
|= TERMP_NOSPACE
;
2026 p
->flags
|= TERMP_NOSPACE
;
2028 } else if (MDOC_HEAD
!= n
->type
)
2031 term_fontpush(p
, TERMFONT_BOLD
);
2032 for (nn
= n
->child
; nn
; nn
= nn
->next
) {
2033 assert(MDOC_TEXT
== nn
->type
);
2034 term_word(p
, nn
->string
);
2044 termp_fo_post(DECL_ARGS
)
2047 if (MDOC_BODY
!= n
->type
)
2049 p
->flags
|= TERMP_NOSPACE
;
2051 p
->flags
|= TERMP_NOSPACE
;
2059 termp_bf_pre(DECL_ARGS
)
2061 const struct mdoc_node
*nn
;
2063 if (MDOC_HEAD
== n
->type
)
2065 else if (MDOC_BLOCK
!= n
->type
)
2068 if (NULL
== (nn
= n
->head
->child
)) {
2069 if (arg_hasattr(MDOC_Emphasis
, n
))
2070 term_fontpush(p
, TERMFONT_UNDER
);
2071 else if (arg_hasattr(MDOC_Symbolic
, n
))
2072 term_fontpush(p
, TERMFONT_BOLD
);
2074 term_fontpush(p
, TERMFONT_NONE
);
2079 assert(MDOC_TEXT
== nn
->type
);
2080 if (0 == strcmp("Em", nn
->string
))
2081 term_fontpush(p
, TERMFONT_UNDER
);
2082 else if (0 == strcmp("Sy", nn
->string
))
2083 term_fontpush(p
, TERMFONT_BOLD
);
2085 term_fontpush(p
, TERMFONT_NONE
);
2093 termp_sm_pre(DECL_ARGS
)
2096 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
2097 if (0 == strcmp("on", n
->child
->string
))
2098 p
->flags
&= ~TERMP_NONOSPACE
;
2100 p
->flags
|= TERMP_NONOSPACE
;
2108 termp_ap_pre(DECL_ARGS
)
2111 p
->flags
|= TERMP_NOSPACE
;
2112 term_word(p
, "\\(aq");
2113 p
->flags
|= TERMP_NOSPACE
;
2120 termp____post(DECL_ARGS
)
2125 p
->flags
|= TERMP_NOSPACE
;
2126 term_word(p
, n
->next
? "," : ".");
2132 termp_li_pre(DECL_ARGS
)
2135 term_fontpush(p
, TERMFONT_NONE
);
2142 termp_lk_pre(DECL_ARGS
)
2144 const struct mdoc_node
*nn
;
2146 term_fontpush(p
, TERMFONT_UNDER
);
2149 if (NULL
== nn
->next
)
2152 term_word(p
, nn
->string
);
2155 p
->flags
|= TERMP_NOSPACE
;
2158 term_fontpush(p
, TERMFONT_BOLD
);
2159 for (nn
= nn
->next
; nn
; nn
= nn
->next
)
2160 term_word(p
, nn
->string
);
2169 termp_under_pre(DECL_ARGS
)
2172 term_fontpush(p
, TERMFONT_UNDER
);