]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_term.c
1 /* $Id: mdoc_term.c,v 1.23 2009/07/12 08:45:56 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.
17 #include <sys/types.h>
29 /* FIXME: macro arguments can be escaped. */
30 /* FIXME: support more offset/width tokens. */
33 #define TTYPE_CMD_FLAG 1
34 #define TTYPE_CMD_ARG 2
35 #define TTYPE_SECTION 3
36 #define TTYPE_FUNC_DECL 4
37 #define TTYPE_VAR_DECL 5
38 #define TTYPE_FUNC_TYPE 6
39 #define TTYPE_FUNC_NAME 7
40 #define TTYPE_FUNC_ARG 8
42 #define TTYPE_SSECTION 10
45 #define TTYPE_CONFIG 13
47 #define TTYPE_INCLUDE 15
49 #define TTYPE_SYMBOL 17
51 #define TTYPE_LINK_ANCHOR 19
52 #define TTYPE_LINK_TEXT 20
53 #define TTYPE_REF_JOURNAL 21
57 const int ttypes
[TTYPE_NMAX
] = {
58 TERMP_BOLD
, /* TTYPE_PROG */
59 TERMP_BOLD
, /* TTYPE_CMD_FLAG */
60 TERMP_UNDER
, /* TTYPE_CMD_ARG */
61 TERMP_BOLD
, /* TTYPE_SECTION */
62 TERMP_BOLD
, /* TTYPE_FUNC_DECL */
63 TERMP_UNDER
, /* TTYPE_VAR_DECL */
64 TERMP_UNDER
, /* TTYPE_FUNC_TYPE */
65 TERMP_BOLD
, /* TTYPE_FUNC_NAME */
66 TERMP_UNDER
, /* TTYPE_FUNC_ARG */
67 TERMP_UNDER
, /* TTYPE_LINK */
68 TERMP_BOLD
, /* TTYPE_SSECTION */
69 TERMP_UNDER
, /* TTYPE_FILE */
70 TERMP_UNDER
, /* TTYPE_EMPH */
71 TERMP_BOLD
, /* TTYPE_CONFIG */
72 TERMP_BOLD
, /* TTYPE_CMD */
73 TERMP_BOLD
, /* TTYPE_INCLUDE */
74 TERMP_BOLD
, /* TTYPE_SYMB */
75 TERMP_BOLD
, /* TTYPE_SYMBOL */
76 TERMP_BOLD
, /* TTYPE_DIAG */
77 TERMP_UNDER
, /* TTYPE_LINK_ANCHOR */
78 TERMP_BOLD
, /* TTYPE_LINK_TEXT */
79 TERMP_UNDER
, /* TTYPE_REF_JOURNAL */
80 TERMP_BOLD
/* TTYPE_LIST */
83 /* XXX - clean this up. */
86 struct termpair
*ppair
;
88 #define TERMPAIR_FLAG (1 << 0)
89 int flag
; /* Whether being used. */
90 size_t offset
; /* Left margin. */
91 size_t rmargin
; /* Right margin. */
92 int count
; /* Enum count. */
95 #define TERMPAIR_SETFLAG(termp, p, fl) \
97 assert(! (TERMPAIR_FLAG & (p)->type)); \
98 (termp)->flags |= (fl); \
100 (p)->type |= TERMPAIR_FLAG; \
101 } while ( /* CONSTCOND */ 0)
104 struct termp *p, struct termpair *pair, \
105 const struct mdoc_meta *meta, \
106 const struct mdoc_node *node
108 #define DECL_PRE(name) \
109 static int name##_pre(DECL_ARGS)
110 #define DECL_POST(name) \
111 static void name##_post(DECL_ARGS)
112 #define DECL_PREPOST(name) \
116 DECL_PREPOST(termp__t
);
117 DECL_PREPOST(termp_aq
);
118 DECL_PREPOST(termp_bd
);
119 DECL_PREPOST(termp_bq
);
120 DECL_PREPOST(termp_brq
);
121 DECL_PREPOST(termp_d1
);
122 DECL_PREPOST(termp_dq
);
123 DECL_PREPOST(termp_fd
);
124 DECL_PREPOST(termp_fn
);
125 DECL_PREPOST(termp_fo
);
126 DECL_PREPOST(termp_ft
);
127 DECL_PREPOST(termp_in
);
128 DECL_PREPOST(termp_it
);
129 DECL_PREPOST(termp_lb
);
130 DECL_PREPOST(termp_op
);
131 DECL_PREPOST(termp_pf
);
132 DECL_PREPOST(termp_pq
);
133 DECL_PREPOST(termp_qq
);
134 DECL_PREPOST(termp_sh
);
135 DECL_PREPOST(termp_ss
);
136 DECL_PREPOST(termp_sq
);
137 DECL_PREPOST(termp_vt
);
181 int (*pre
)(DECL_ARGS
);
182 void (*post
)(DECL_ARGS
);
185 static const struct termact termacts
[MDOC_MAX
] = {
186 { termp_ap_pre
, NULL
}, /* Ap */
187 { NULL
, NULL
}, /* Dd */
188 { NULL
, NULL
}, /* Dt */
189 { NULL
, NULL
}, /* Os */
190 { termp_sh_pre
, termp_sh_post
}, /* Sh */
191 { termp_ss_pre
, termp_ss_post
}, /* Ss */
192 { termp_pp_pre
, NULL
}, /* Pp */
193 { termp_d1_pre
, termp_d1_post
}, /* D1 */
194 { termp_d1_pre
, termp_d1_post
}, /* Dl */
195 { termp_bd_pre
, termp_bd_post
}, /* Bd */
196 { NULL
, NULL
}, /* Ed */
197 { NULL
, termp_bl_post
}, /* Bl */
198 { NULL
, NULL
}, /* El */
199 { termp_it_pre
, termp_it_post
}, /* It */
200 { NULL
, NULL
}, /* Ad */
201 { NULL
, NULL
}, /* An */
202 { termp_ar_pre
, NULL
}, /* Ar */
203 { termp_cd_pre
, NULL
}, /* Cd */
204 { termp_cm_pre
, NULL
}, /* Cm */
205 { NULL
, NULL
}, /* Dv */
206 { NULL
, NULL
}, /* Er */
207 { NULL
, NULL
}, /* Ev */
208 { termp_ex_pre
, NULL
}, /* Ex */
209 { termp_fa_pre
, NULL
}, /* Fa */
210 { termp_fd_pre
, termp_fd_post
}, /* Fd */
211 { termp_fl_pre
, NULL
}, /* Fl */
212 { termp_fn_pre
, termp_fn_post
}, /* Fn */
213 { termp_ft_pre
, termp_ft_post
}, /* Ft */
214 { termp_ic_pre
, NULL
}, /* Ic */
215 { termp_in_pre
, termp_in_post
}, /* In */
216 { NULL
, NULL
}, /* Li */
217 { termp_nd_pre
, NULL
}, /* Nd */
218 { termp_nm_pre
, NULL
}, /* Nm */
219 { termp_op_pre
, termp_op_post
}, /* Op */
220 { NULL
, NULL
}, /* Ot */
221 { termp_pa_pre
, NULL
}, /* Pa */
222 { termp_rv_pre
, NULL
}, /* Rv */
223 { termp_st_pre
, NULL
}, /* St */
224 { termp_va_pre
, NULL
}, /* Va */
225 { termp_vt_pre
, termp_vt_post
}, /* Vt */
226 { termp_xr_pre
, NULL
}, /* Xr */
227 { NULL
, termp____post
}, /* %A */
228 { NULL
, termp____post
}, /* %B */
229 { NULL
, termp____post
}, /* %D */
230 { NULL
, termp____post
}, /* %I */
231 { termp__j_pre
, termp____post
}, /* %J */
232 { NULL
, termp____post
}, /* %N */
233 { NULL
, termp____post
}, /* %O */
234 { NULL
, termp____post
}, /* %P */
235 { NULL
, termp____post
}, /* %R */
236 { termp__t_pre
, termp__t_post
}, /* %T */
237 { NULL
, termp____post
}, /* %V */
238 { NULL
, NULL
}, /* Ac */
239 { termp_aq_pre
, termp_aq_post
}, /* Ao */
240 { termp_aq_pre
, termp_aq_post
}, /* Aq */
241 { termp_at_pre
, NULL
}, /* At */
242 { NULL
, NULL
}, /* Bc */
243 { termp_bf_pre
, NULL
}, /* Bf */
244 { termp_bq_pre
, termp_bq_post
}, /* Bo */
245 { termp_bq_pre
, termp_bq_post
}, /* Bq */
246 { termp_bsx_pre
, NULL
}, /* Bsx */
247 { NULL
, termp_bx_post
}, /* Bx */
248 { NULL
, NULL
}, /* Db */
249 { NULL
, NULL
}, /* Dc */
250 { termp_dq_pre
, termp_dq_post
}, /* Do */
251 { termp_dq_pre
, termp_dq_post
}, /* Dq */
252 { NULL
, NULL
}, /* Ec */
253 { NULL
, NULL
}, /* Ef */
254 { termp_em_pre
, NULL
}, /* Em */
255 { NULL
, NULL
}, /* Eo */
256 { termp_fx_pre
, NULL
}, /* Fx */
257 { termp_ms_pre
, NULL
}, /* Ms */
258 { NULL
, NULL
}, /* No */
259 { termp_ns_pre
, NULL
}, /* Ns */
260 { termp_nx_pre
, NULL
}, /* Nx */
261 { termp_ox_pre
, NULL
}, /* Ox */
262 { NULL
, NULL
}, /* Pc */
263 { termp_pf_pre
, termp_pf_post
}, /* Pf */
264 { termp_pq_pre
, termp_pq_post
}, /* Po */
265 { termp_pq_pre
, termp_pq_post
}, /* Pq */
266 { NULL
, NULL
}, /* Qc */
267 { termp_sq_pre
, termp_sq_post
}, /* Ql */
268 { termp_qq_pre
, termp_qq_post
}, /* Qo */
269 { termp_qq_pre
, termp_qq_post
}, /* Qq */
270 { NULL
, NULL
}, /* Re */
271 { termp_rs_pre
, NULL
}, /* Rs */
272 { NULL
, NULL
}, /* Sc */
273 { termp_sq_pre
, termp_sq_post
}, /* So */
274 { termp_sq_pre
, termp_sq_post
}, /* Sq */
275 { termp_sm_pre
, NULL
}, /* Sm */
276 { termp_sx_pre
, NULL
}, /* Sx */
277 { termp_sy_pre
, NULL
}, /* Sy */
278 { NULL
, NULL
}, /* Tn */
279 { termp_ux_pre
, NULL
}, /* Ux */
280 { NULL
, NULL
}, /* Xc */
281 { NULL
, NULL
}, /* Xo */
282 { termp_fo_pre
, termp_fo_post
}, /* Fo */
283 { NULL
, NULL
}, /* Fc */
284 { termp_op_pre
, termp_op_post
}, /* Oo */
285 { NULL
, NULL
}, /* Oc */
286 { NULL
, NULL
}, /* Bk */
287 { NULL
, NULL
}, /* Ek */
288 { termp_bt_pre
, NULL
}, /* Bt */
289 { NULL
, NULL
}, /* Hf */
290 { NULL
, NULL
}, /* Fr */
291 { termp_ud_pre
, NULL
}, /* Ud */
292 { termp_lb_pre
, termp_lb_post
}, /* Lb */
293 { termp_pp_pre
, NULL
}, /* Lp */
294 { termp_lk_pre
, NULL
}, /* Lk */
295 { termp_mt_pre
, NULL
}, /* Mt */
296 { termp_brq_pre
, termp_brq_post
}, /* Brq */
297 { termp_brq_pre
, termp_brq_post
}, /* Bro */
298 { NULL
, NULL
}, /* Brc */
299 { NULL
, NULL
}, /* %C */
300 { NULL
, NULL
}, /* Es */
301 { NULL
, NULL
}, /* En */
302 { termp_dx_pre
, NULL
}, /* Dx */
303 { NULL
, NULL
}, /* %Q */
307 extern size_t strlcpy(char *, const char *, size_t);
308 extern size_t strlcat(char *, const char *, size_t);
311 static int arg_hasattr(int, const struct mdoc_node
*);
312 static int arg_getattrs(const int *, int *, size_t,
313 const struct mdoc_node
*);
314 static int arg_getattr(int, const struct mdoc_node
*);
315 static size_t arg_offset(const struct mdoc_argv
*);
316 static size_t arg_width(const struct mdoc_argv
*, int);
317 static int arg_listtype(const struct mdoc_node
*);
318 static int fmt_block_vspace(struct termp
*,
319 const struct mdoc_node
*,
320 const struct mdoc_node
*);
321 static void print_node(DECL_ARGS
);
322 static void print_head(struct termp
*,
323 const struct mdoc_meta
*);
324 static void print_body(DECL_ARGS
);
325 static void print_foot(struct termp
*,
326 const struct mdoc_meta
*);
330 mdoc_run(struct termp
*p
, const struct mdoc
*m
)
333 * Main output function. When this is called, assume that the
334 * tree is properly formed.
337 print_head(p
, mdoc_meta(m
));
338 assert(mdoc_node(m
));
339 assert(MDOC_ROOT
== mdoc_node(m
)->type
);
340 if (mdoc_node(m
)->child
)
341 print_body(p
, NULL
, mdoc_meta(m
), mdoc_node(m
)->child
);
342 print_foot(p
, mdoc_meta(m
));
348 print_body(DECL_ARGS
)
351 print_node(p
, pair
, meta
, node
);
354 print_body(p
, pair
, meta
, node
->next
);
359 print_node(DECL_ARGS
)
362 struct termpair npair
;
364 /* Pre-processing. */
369 npair
.offset
= npair
.rmargin
= 0;
373 if (MDOC_TEXT
!= node
->type
) {
374 if (termacts
[node
->tok
].pre
)
375 if ( ! (*termacts
[node
->tok
].pre
)(p
, &npair
, meta
, node
))
377 } else /* MDOC_TEXT == node->type */
378 term_word(p
, node
->string
);
382 if (TERMPAIR_FLAG
& npair
.type
)
383 p
->flags
|= npair
.flag
;
385 if (dochild
&& node
->child
)
386 print_body(p
, &npair
, meta
, node
->child
);
388 if (TERMPAIR_FLAG
& npair
.type
)
389 p
->flags
&= ~npair
.flag
;
391 /* Post-processing. */
393 if (MDOC_TEXT
!= node
->type
)
394 if (termacts
[node
->tok
].post
)
395 (*termacts
[node
->tok
].post
)(p
, &npair
, meta
, node
);
400 print_foot(struct termp
*p
, const struct mdoc_meta
*meta
)
406 * Output the footer in new-groff style, that is, three columns
407 * with the middle being the manual date and flanking columns
408 * being the operating system:
413 if (NULL
== (buf
= malloc(p
->rmargin
)))
415 if (NULL
== (os
= malloc(p
->rmargin
)))
418 tm
= localtime(&meta
->date
);
420 if (0 == strftime(buf
, p
->rmargin
, "%B %d, %Y", tm
))
423 (void)strlcpy(os
, meta
->os
, p
->rmargin
);
428 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
429 p
->flags
|= TERMP_NOSPACE
| TERMP_NOBREAK
;
434 p
->offset
= p
->rmargin
;
435 p
->rmargin
= p
->maxrmargin
- strlen(os
);
436 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
441 p
->offset
= p
->rmargin
;
442 p
->rmargin
= p
->maxrmargin
;
443 p
->flags
&= ~TERMP_NOBREAK
;
444 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
450 p
->rmargin
= p
->maxrmargin
;
459 print_head(struct termp
*p
, const struct mdoc_meta
*meta
)
463 p
->rmargin
= p
->maxrmargin
;
466 if (NULL
== (buf
= malloc(p
->rmargin
)))
468 if (NULL
== (title
= malloc(p
->rmargin
)))
472 * The header is strange. It has three components, which are
473 * really two with the first duplicated. It goes like this:
475 * IDENTIFIER TITLE IDENTIFIER
477 * The IDENTIFIER is NAME(SECTION), which is the command-name
478 * (if given, or "unknown" if not) followed by the manual page
479 * section. These are given in `Dt'. The TITLE is a free-form
480 * string depending on the manual volume. If not specified, it
481 * switches on the manual section.
485 (void)strlcpy(buf
, meta
->vol
, p
->rmargin
);
488 (void)strlcat(buf
, " (", p
->rmargin
);
489 (void)strlcat(buf
, meta
->arch
, p
->rmargin
);
490 (void)strlcat(buf
, ")", p
->rmargin
);
493 (void)snprintf(title
, p
->rmargin
, "%s(%d)",
494 meta
->title
, meta
->msec
);
497 p
->rmargin
= (p
->maxrmargin
- strlen(buf
) + 1) / 2;
498 p
->flags
|= TERMP_NOBREAK
| TERMP_NOSPACE
;
503 p
->offset
= p
->rmargin
;
504 p
->rmargin
= p
->maxrmargin
- strlen(title
);
505 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
510 p
->offset
= p
->rmargin
;
511 p
->rmargin
= p
->maxrmargin
;
512 p
->flags
&= ~TERMP_NOBREAK
;
513 p
->flags
|= TERMP_NOLPAD
| TERMP_NOSPACE
;
519 p
->rmargin
= p
->maxrmargin
;
520 p
->flags
&= ~TERMP_NOSPACE
;
528 arg_width(const struct mdoc_argv
*arg
, int pos
)
533 assert(pos
< (int)arg
->sz
&& pos
>= 0);
534 assert(arg
->value
[pos
]);
536 if (0 == (len
= (int)strlen(arg
->value
[pos
])))
539 for (i
= 0; i
< len
- 1; i
++)
540 if ( ! isdigit((u_char
)arg
->value
[pos
][i
]))
544 if ('n' == arg
->value
[pos
][len
- 1] ||
545 'm' == arg
->value
[pos
][len
- 1]) {
546 v
= (size_t)atoi(arg
->value
[pos
]);
551 return(strlen(arg
->value
[pos
]) + 2);
556 arg_listtype(const struct mdoc_node
*n
)
560 assert(MDOC_BLOCK
== n
->type
);
562 len
= (int)(n
->args
? n
->args
->argc
: 0);
564 for (i
= 0; i
< len
; i
++)
565 switch (n
->args
->argv
[i
].arg
) {
585 return(n
->args
->argv
[i
].arg
);
590 /* FIXME: mandated by parser. */
592 errx(1, "list type not supported");
598 arg_offset(const struct mdoc_argv
*arg
)
602 if (0 == strcmp(*arg
->value
, "left"))
604 if (0 == strcmp(*arg
->value
, "indent"))
606 if (0 == strcmp(*arg
->value
, "indent-two"))
607 return((INDENT
+ 1) * 2);
609 /* FIXME: needs to support field-widths (10n, etc.). */
611 return(strlen(*arg
->value
));
616 arg_hasattr(int arg
, const struct mdoc_node
*n
)
619 return(-1 != arg_getattr(arg
, n
));
624 arg_getattr(int v
, const struct mdoc_node
*n
)
628 return(arg_getattrs(&v
, &val
, 1, n
) ? val
: -1);
633 arg_getattrs(const int *keys
, int *vals
,
634 size_t sz
, const struct mdoc_node
*n
)
641 for (k
= i
= 0; i
< (int)n
->args
->argc
; i
++)
642 for (j
= 0; j
< (int)sz
; j
++)
643 if (n
->args
->argv
[i
].arg
== keys
[j
]) {
653 fmt_block_vspace(struct termp
*p
,
654 const struct mdoc_node
*bl
,
655 const struct mdoc_node
*node
)
657 const struct mdoc_node
*n
;
661 if (arg_hasattr(MDOC_Compact
, bl
))
664 for (n
= node
; n
; n
= n
->parent
) {
665 if (MDOC_BLOCK
!= n
->type
)
667 if (MDOC_Ss
== n
->tok
)
669 if (MDOC_Sh
== n
->tok
)
683 termp_dq_pre(DECL_ARGS
)
686 if (MDOC_BODY
!= node
->type
)
689 term_word(p
, "\\(lq");
690 p
->flags
|= TERMP_NOSPACE
;
697 termp_dq_post(DECL_ARGS
)
700 if (MDOC_BODY
!= node
->type
)
703 p
->flags
|= TERMP_NOSPACE
;
704 term_word(p
, "\\(rq");
710 termp_it_pre(DECL_ARGS
)
712 const struct mdoc_node
*bl
, *n
;
714 int i
, type
, keys
[3], vals
[3], sv
;
715 size_t width
, offset
;
717 if (MDOC_BLOCK
== node
->type
)
718 return(fmt_block_vspace(p
, node
->parent
->parent
, node
));
720 bl
= node
->parent
->parent
->parent
;
722 /* Save parent attributes. */
724 pair
->offset
= p
->offset
;
725 pair
->rmargin
= p
->rmargin
;
726 pair
->flag
= p
->flags
;
728 /* Get list width and offset. */
730 keys
[0] = MDOC_Width
;
731 keys
[1] = MDOC_Offset
;
732 keys
[2] = MDOC_Column
;
734 vals
[0] = vals
[1] = vals
[2] = -1;
738 (void)arg_getattrs(keys
, vals
, 3, bl
);
740 type
= arg_listtype(bl
);
742 /* Calculate real width and offset. */
746 if (MDOC_BODY
== node
->type
)
748 for (i
= 0, n
= node
->prev
; n
; n
= n
->prev
, i
++)
750 (&bl
->args
->argv
[vals
[2]], i
);
751 assert(i
< (int)bl
->args
->argv
[vals
[2]].sz
);
752 width
= arg_width(&bl
->args
->argv
[vals
[2]], i
);
754 offset
+= arg_offset(&bl
->args
->argv
[vals
[1]]);
758 width
= arg_width(&bl
->args
->argv
[vals
[0]], 0);
760 offset
+= arg_offset(&bl
->args
->argv
[vals
[1]]);
765 * List-type can override the width in the case of fixed-head
766 * values (bullet, dash/hyphen, enum). Tags need a non-zero
792 * Whitespace control. Inset bodies need an initial space,
793 * while diagonal bodies need two.
801 if (MDOC_BODY
== node
->type
)
802 p
->flags
&= ~TERMP_NOSPACE
;
804 p
->flags
|= TERMP_NOSPACE
;
807 p
->flags
|= TERMP_NOSPACE
;
812 * Style flags. Diagnostic heads need TTYPE_DIAG.
817 if (MDOC_HEAD
== node
->type
)
818 p
->flags
|= ttypes
[TTYPE_DIAG
];
825 * Pad and break control. This is the tricker part. Lists with
826 * set right-margins for the head get TERMP_NOBREAK because, if
827 * they overrun the margin, they wrap to the new margin.
828 * Correspondingly, the body for these types don't left-pad, as
829 * the head will pad out to to the right.
842 if (MDOC_HEAD
== node
->type
)
843 p
->flags
|= TERMP_NOBREAK
;
845 p
->flags
|= TERMP_NOLPAD
;
846 if (MDOC_HEAD
== node
->type
&& MDOC_Tag
== type
)
847 if (NULL
== node
->next
||
848 NULL
== node
->next
->child
)
849 p
->flags
|= TERMP_NONOBREAK
;
852 if (MDOC_HEAD
== node
->type
) {
854 if (MDOC_BODY
== node
->next
->type
)
855 p
->flags
&= ~TERMP_NOBREAK
;
857 p
->flags
|= TERMP_NOBREAK
;
859 p
->flags
|= TERMP_NOLPAD
;
863 if (MDOC_HEAD
== node
->type
)
864 p
->flags
|= TERMP_NOBREAK
;
871 * Margin control. Set-head-width lists have their right
872 * margins shortened. The body for these lists has the offset
873 * necessarily lengthened. Everybody gets the offset.
888 if (MDOC_HEAD
== node
->type
)
889 p
->rmargin
= p
->offset
+ width
;
894 p
->rmargin
= p
->offset
+ width
;
901 * The dash, hyphen, bullet and enum lists all have a special
902 * HEAD character (temporarily bold, in some cases).
906 if (MDOC_HEAD
== node
->type
)
909 p
->flags
|= TERMP_BOLD
;
910 term_word(p
, "\\[bu]");
915 p
->flags
|= TERMP_BOLD
;
919 (pair
->ppair
->ppair
->count
)++;
920 (void)snprintf(buf
, sizeof(buf
), "%d.",
921 pair
->ppair
->ppair
->count
);
928 p
->flags
= sv
; /* Restore saved flags. */
931 * If we're not going to process our children, indicate so here.
944 if (MDOC_HEAD
== node
->type
)
948 if (MDOC_BODY
== node
->type
)
961 termp_it_post(DECL_ARGS
)
965 if (MDOC_BODY
!= node
->type
&& MDOC_HEAD
!= node
->type
)
968 type
= arg_listtype(node
->parent
->parent
->parent
);
976 if (MDOC_BODY
== node
->type
)
980 if (MDOC_HEAD
== node
->type
)
988 p
->offset
= pair
->offset
;
989 p
->rmargin
= pair
->rmargin
;
990 p
->flags
= pair
->flag
;
996 termp_nm_pre(DECL_ARGS
)
999 if (SEC_SYNOPSIS
== node
->sec
)
1002 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_PROG
]);
1003 if (NULL
== node
->child
)
1004 term_word(p
, meta
->name
);
1012 termp_fl_pre(DECL_ARGS
)
1015 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_CMD_FLAG
]);
1016 term_word(p
, "\\-");
1017 p
->flags
|= TERMP_NOSPACE
;
1024 termp_ar_pre(DECL_ARGS
)
1027 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_CMD_ARG
]);
1034 termp_ns_pre(DECL_ARGS
)
1037 p
->flags
|= TERMP_NOSPACE
;
1044 termp_pp_pre(DECL_ARGS
)
1054 termp_st_pre(DECL_ARGS
)
1058 if (node
->child
&& (cp
= mdoc_a2st(node
->child
->string
)))
1066 termp_rs_pre(DECL_ARGS
)
1069 if (MDOC_BLOCK
== node
->type
&& node
->prev
)
1077 termp_rv_pre(DECL_ARGS
)
1081 /* FIXME: mandated by parser. */
1083 if (-1 == (i
= arg_getattr(MDOC_Std
, node
)))
1084 errx(1, "expected -std argument");
1085 if (1 != node
->args
->argv
[i
].sz
)
1086 errx(1, "expected -std argument");
1089 term_word(p
, "The");
1091 p
->flags
|= ttypes
[TTYPE_FUNC_NAME
];
1092 term_word(p
, *node
->args
->argv
[i
].value
);
1093 p
->flags
&= ~ttypes
[TTYPE_FUNC_NAME
];
1094 p
->flags
|= TERMP_NOSPACE
;
1096 term_word(p
, "() function returns the value 0 if successful;");
1097 term_word(p
, "otherwise the value -1 is returned and the");
1098 term_word(p
, "global variable");
1100 p
->flags
|= ttypes
[TTYPE_VAR_DECL
];
1101 term_word(p
, "errno");
1102 p
->flags
&= ~ttypes
[TTYPE_VAR_DECL
];
1104 term_word(p
, "is set to indicate the error.");
1112 termp_ex_pre(DECL_ARGS
)
1116 /* FIXME: mandated by parser? */
1118 if (-1 == (i
= arg_getattr(MDOC_Std
, node
)))
1119 errx(1, "expected -std argument");
1120 if (1 != node
->args
->argv
[i
].sz
)
1121 errx(1, "expected -std argument");
1123 term_word(p
, "The");
1124 p
->flags
|= ttypes
[TTYPE_PROG
];
1125 term_word(p
, *node
->args
->argv
[i
].value
);
1126 p
->flags
&= ~ttypes
[TTYPE_PROG
];
1127 term_word(p
, "utility exits 0 on success, and >0 if an error occurs.");
1135 termp_nd_pre(DECL_ARGS
)
1139 term_word(p
, "\\-");
1141 term_word(p
, "\\(em");
1149 termp_bl_post(DECL_ARGS
)
1152 if (MDOC_BLOCK
== node
->type
)
1159 termp_op_post(DECL_ARGS
)
1162 if (MDOC_BODY
!= node
->type
)
1164 p
->flags
|= TERMP_NOSPACE
;
1165 term_word(p
, "\\(rB");
1171 termp_xr_pre(DECL_ARGS
)
1173 const struct mdoc_node
*n
;
1175 assert(node
->child
&& MDOC_TEXT
== node
->child
->type
);
1178 term_word(p
, n
->string
);
1179 if (NULL
== (n
= n
->next
))
1181 p
->flags
|= TERMP_NOSPACE
;
1183 p
->flags
|= TERMP_NOSPACE
;
1184 term_word(p
, n
->string
);
1185 p
->flags
|= TERMP_NOSPACE
;
1193 termp_vt_pre(DECL_ARGS
)
1196 /* FIXME: this can be "type name". */
1197 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_VAR_DECL
]);
1204 termp_vt_post(DECL_ARGS
)
1207 if (node
->sec
== SEC_SYNOPSIS
)
1214 termp_fd_pre(DECL_ARGS
)
1218 * FIXME: this naming is bad. This value is used, in general,
1219 * for the #include header or other preprocessor statement.
1221 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_FUNC_DECL
]);
1228 termp_fd_post(DECL_ARGS
)
1231 if (node
->sec
!= SEC_SYNOPSIS
)
1234 if (node
->next
&& MDOC_Fd
!= node
->next
->tok
)
1241 termp_sh_pre(DECL_ARGS
)
1244 switch (node
->type
) {
1247 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_SECTION
]);
1261 termp_sh_post(DECL_ARGS
)
1264 switch (node
->type
) {
1280 termp_op_pre(DECL_ARGS
)
1283 switch (node
->type
) {
1285 term_word(p
, "\\(lB");
1286 p
->flags
|= TERMP_NOSPACE
;
1297 termp_bt_pre(DECL_ARGS
)
1300 term_word(p
, "is currently in beta test.");
1307 termp_lb_pre(DECL_ARGS
)
1311 assert(node
->child
&& MDOC_TEXT
== node
->child
->type
);
1312 lb
= mdoc_a2lib(node
->child
->string
);
1317 term_word(p
, "library");
1324 termp_lb_post(DECL_ARGS
)
1333 termp_ud_pre(DECL_ARGS
)
1336 term_word(p
, "currently under development.");
1343 termp_d1_pre(DECL_ARGS
)
1346 if (MDOC_BLOCK
!= node
->type
)
1349 pair
->offset
= INDENT
+ 1;
1350 p
->offset
+= pair
->offset
;
1357 termp_d1_post(DECL_ARGS
)
1360 if (MDOC_BLOCK
!= node
->type
)
1363 p
->offset
-= pair
->offset
;
1369 termp_aq_pre(DECL_ARGS
)
1372 if (MDOC_BODY
!= node
->type
)
1374 term_word(p
, "\\(la");
1375 p
->flags
|= TERMP_NOSPACE
;
1382 termp_aq_post(DECL_ARGS
)
1385 if (MDOC_BODY
!= node
->type
)
1387 p
->flags
|= TERMP_NOSPACE
;
1388 term_word(p
, "\\(ra");
1394 termp_ft_pre(DECL_ARGS
)
1397 if (SEC_SYNOPSIS
== node
->sec
)
1398 if (node
->prev
&& MDOC_Fo
== node
->prev
->tok
)
1400 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_FUNC_TYPE
]);
1407 termp_ft_post(DECL_ARGS
)
1410 if (SEC_SYNOPSIS
== node
->sec
)
1417 termp_fn_pre(DECL_ARGS
)
1419 const struct mdoc_node
*n
;
1421 assert(node
->child
&& MDOC_TEXT
== node
->child
->type
);
1423 /* FIXME: can be "type funcname" "type varname"... */
1425 p
->flags
|= ttypes
[TTYPE_FUNC_NAME
];
1426 term_word(p
, node
->child
->string
);
1427 p
->flags
&= ~ttypes
[TTYPE_FUNC_NAME
];
1429 p
->flags
|= TERMP_NOSPACE
;
1432 for (n
= node
->child
->next
; n
; n
= n
->next
) {
1433 p
->flags
|= ttypes
[TTYPE_FUNC_ARG
];
1434 term_word(p
, n
->string
);
1435 p
->flags
&= ~ttypes
[TTYPE_FUNC_ARG
];
1442 if (SEC_SYNOPSIS
== node
->sec
)
1451 termp_fn_post(DECL_ARGS
)
1454 if (node
->sec
== SEC_SYNOPSIS
&& node
->next
)
1462 termp_sx_pre(DECL_ARGS
)
1465 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_LINK
]);
1472 termp_fa_pre(DECL_ARGS
)
1474 struct mdoc_node
*n
;
1476 if (node
->parent
->tok
!= MDOC_Fo
) {
1477 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_FUNC_ARG
]);
1481 for (n
= node
->child
; n
; n
= n
->next
) {
1482 p
->flags
|= ttypes
[TTYPE_FUNC_ARG
];
1483 term_word(p
, n
->string
);
1484 p
->flags
&= ~ttypes
[TTYPE_FUNC_ARG
];
1489 if (node
->child
&& node
->next
&& node
->next
->tok
== MDOC_Fa
)
1498 termp_va_pre(DECL_ARGS
)
1501 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_VAR_DECL
]);
1508 termp_bd_pre(DECL_ARGS
)
1513 * This is fairly tricky due primarily to crappy documentation.
1514 * If -ragged or -filled are specified, the block does nothing
1515 * but change the indentation.
1517 * If, on the other hand, -unfilled or -literal are specified,
1518 * then the game changes. Text is printed exactly as entered in
1519 * the display: if a macro line, a newline is appended to the
1520 * line. Blank lines are allowed.
1523 if (MDOC_BLOCK
== node
->type
)
1524 return(fmt_block_vspace(p
, node
, node
));
1525 else if (MDOC_BODY
!= node
->type
)
1528 /* FIXME: display type should be mandated by parser. */
1530 if (NULL
== node
->parent
->args
)
1531 errx(1, "missing display type");
1533 pair
->offset
= p
->offset
;
1535 for (type
= -1, i
= 0;
1536 i
< (int)node
->parent
->args
->argc
; i
++) {
1537 switch (node
->parent
->args
->argv
[i
].arg
) {
1542 case (MDOC_Unfilled
):
1544 case (MDOC_Literal
):
1545 type
= node
->parent
->args
->argv
[i
].arg
;
1546 i
= (int)node
->parent
->args
->argc
;
1553 if (NULL
== node
->parent
->args
)
1554 errx(1, "missing display type");
1556 i
= arg_getattr(MDOC_Offset
, node
->parent
);
1558 if (1 != node
->parent
->args
->argv
[i
].sz
)
1559 errx(1, "expected single value");
1560 p
->offset
+= arg_offset(&node
->parent
->args
->argv
[i
]);
1564 case (MDOC_Literal
):
1566 case (MDOC_Unfilled
):
1573 * Tricky. Iterate through all children. If we're on a
1574 * different parse line, append a newline and then the contents.
1578 p
->flags
|= TERMP_LITERAL
;
1579 ln
= node
->child
? node
->child
->line
: 0;
1581 for (node
= node
->child
; node
; node
= node
->next
) {
1582 if (ln
< node
->line
) {
1584 p
->flags
|= TERMP_NOSPACE
;
1587 print_node(p
, pair
, meta
, node
);
1596 termp_bd_post(DECL_ARGS
)
1599 if (MDOC_BODY
!= node
->type
)
1603 p
->flags
&= ~TERMP_LITERAL
;
1604 p
->offset
= pair
->offset
;
1605 p
->flags
|= TERMP_NOSPACE
;
1611 termp_qq_pre(DECL_ARGS
)
1614 if (MDOC_BODY
!= node
->type
)
1617 p
->flags
|= TERMP_NOSPACE
;
1624 termp_qq_post(DECL_ARGS
)
1627 if (MDOC_BODY
!= node
->type
)
1629 p
->flags
|= TERMP_NOSPACE
;
1636 termp_bsx_pre(DECL_ARGS
)
1639 term_word(p
, "BSDI BSD/OS");
1646 termp_bx_post(DECL_ARGS
)
1650 p
->flags
|= TERMP_NOSPACE
;
1651 term_word(p
, "BSD");
1657 termp_ox_pre(DECL_ARGS
)
1660 term_word(p
, "OpenBSD");
1667 termp_dx_pre(DECL_ARGS
)
1670 term_word(p
, "DragonFly");
1677 termp_ux_pre(DECL_ARGS
)
1680 term_word(p
, "UNIX");
1687 termp_fx_pre(DECL_ARGS
)
1690 term_word(p
, "FreeBSD");
1697 termp_nx_pre(DECL_ARGS
)
1700 term_word(p
, "NetBSD");
1707 termp_sq_pre(DECL_ARGS
)
1710 if (MDOC_BODY
!= node
->type
)
1712 term_word(p
, "\\(oq");
1713 p
->flags
|= TERMP_NOSPACE
;
1720 termp_sq_post(DECL_ARGS
)
1723 if (MDOC_BODY
!= node
->type
)
1725 p
->flags
|= TERMP_NOSPACE
;
1726 term_word(p
, "\\(aq");
1732 termp_pf_pre(DECL_ARGS
)
1735 p
->flags
|= TERMP_IGNDELIM
;
1742 termp_pf_post(DECL_ARGS
)
1745 p
->flags
&= ~TERMP_IGNDELIM
;
1746 p
->flags
|= TERMP_NOSPACE
;
1752 termp_ss_pre(DECL_ARGS
)
1755 switch (node
->type
) {
1762 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_SSECTION
]);
1763 p
->offset
= HALFINDENT
;
1775 termp_ss_post(DECL_ARGS
)
1778 switch (node
->type
) {
1791 termp_pa_pre(DECL_ARGS
)
1794 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_FILE
]);
1801 termp_em_pre(DECL_ARGS
)
1804 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_EMPH
]);
1811 termp_cd_pre(DECL_ARGS
)
1814 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_CONFIG
]);
1822 termp_cm_pre(DECL_ARGS
)
1825 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_CMD_FLAG
]);
1832 termp_ic_pre(DECL_ARGS
)
1835 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_CMD
]);
1842 termp_in_pre(DECL_ARGS
)
1845 /* XXX This conforms to new-groff style. */
1846 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_INCLUDE
]);
1848 if (SEC_SYNOPSIS
== node
->sec
)
1849 term_word(p
, "#include");
1852 p
->flags
|= TERMP_NOSPACE
;
1859 termp_in_post(DECL_ARGS
)
1862 p
->flags
|= TERMP_NOSPACE
;
1865 if (SEC_SYNOPSIS
!= node
->sec
)
1870 * XXX Not entirely correct. If `.In foo bar' is specified in
1871 * the SYNOPSIS section, then it produces a single break after
1872 * the <foo>; mandoc asserts a vertical space. Since this
1873 * construction is rarely used, I think it's fine.
1875 if (node
->next
&& MDOC_In
!= node
->next
->tok
)
1882 termp_at_pre(DECL_ARGS
)
1889 att
= mdoc_a2att(node
->child
->string
);
1900 termp_brq_pre(DECL_ARGS
)
1903 if (MDOC_BODY
!= node
->type
)
1905 term_word(p
, "\\(lC");
1906 p
->flags
|= TERMP_NOSPACE
;
1913 termp_brq_post(DECL_ARGS
)
1916 if (MDOC_BODY
!= node
->type
)
1918 p
->flags
|= TERMP_NOSPACE
;
1919 term_word(p
, "\\(rC");
1925 termp_bq_pre(DECL_ARGS
)
1928 if (MDOC_BODY
!= node
->type
)
1930 term_word(p
, "\\(lB");
1931 p
->flags
|= TERMP_NOSPACE
;
1938 termp_bq_post(DECL_ARGS
)
1941 if (MDOC_BODY
!= node
->type
)
1943 p
->flags
|= TERMP_NOSPACE
;
1944 term_word(p
, "\\(rB");
1950 termp_pq_pre(DECL_ARGS
)
1953 if (MDOC_BODY
!= node
->type
)
1955 term_word(p
, "\\&(");
1956 p
->flags
|= TERMP_NOSPACE
;
1963 termp_pq_post(DECL_ARGS
)
1966 if (MDOC_BODY
!= node
->type
)
1974 termp_fo_pre(DECL_ARGS
)
1976 const struct mdoc_node
*n
;
1978 if (MDOC_BODY
== node
->type
) {
1980 p
->flags
|= TERMP_NOSPACE
;
1982 } else if (MDOC_HEAD
!= node
->type
)
1985 /* XXX - groff shows only first parameter */
1987 p
->flags
|= ttypes
[TTYPE_FUNC_NAME
];
1988 for (n
= node
->child
; n
; n
= n
->next
) {
1989 assert(MDOC_TEXT
== n
->type
);
1990 term_word(p
, n
->string
);
1992 p
->flags
&= ~ttypes
[TTYPE_FUNC_NAME
];
2000 termp_fo_post(DECL_ARGS
)
2003 if (MDOC_BODY
!= node
->type
)
2005 p
->flags
|= TERMP_NOSPACE
;
2007 p
->flags
|= TERMP_NOSPACE
;
2015 termp_bf_pre(DECL_ARGS
)
2017 const struct mdoc_node
*n
;
2019 if (MDOC_HEAD
== node
->type
) {
2021 } else if (MDOC_BLOCK
!= node
->type
)
2024 if (NULL
== (n
= node
->head
->child
)) {
2025 if (arg_hasattr(MDOC_Emphasis
, node
))
2026 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_EMPH
]);
2027 else if (arg_hasattr(MDOC_Symbolic
, node
))
2028 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_SYMB
]);
2033 assert(MDOC_TEXT
== n
->type
);
2034 if (0 == strcmp("Em", n
->string
))
2035 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_EMPH
]);
2036 else if (0 == strcmp("Sy", n
->string
))
2037 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_EMPH
]);
2045 termp_sy_pre(DECL_ARGS
)
2048 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_SYMB
]);
2055 termp_ms_pre(DECL_ARGS
)
2058 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_SYMBOL
]);
2066 termp_sm_pre(DECL_ARGS
)
2069 assert(node
->child
&& MDOC_TEXT
== node
->child
->type
);
2070 if (0 == strcmp("on", node
->child
->string
)) {
2071 p
->flags
&= ~TERMP_NONOSPACE
;
2072 p
->flags
&= ~TERMP_NOSPACE
;
2074 p
->flags
|= TERMP_NONOSPACE
;
2082 termp_ap_pre(DECL_ARGS
)
2085 p
->flags
|= TERMP_NOSPACE
;
2086 term_word(p
, "\\(aq");
2087 p
->flags
|= TERMP_NOSPACE
;
2094 termp__j_pre(DECL_ARGS
)
2097 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_REF_JOURNAL
]);
2104 termp__t_pre(DECL_ARGS
)
2108 p
->flags
|= TERMP_NOSPACE
;
2115 termp__t_post(DECL_ARGS
)
2118 p
->flags
|= TERMP_NOSPACE
;
2120 termp____post(p
, pair
, meta
, node
);
2126 termp____post(DECL_ARGS
)
2129 p
->flags
|= TERMP_NOSPACE
;
2130 term_word(p
, node
->next
? "," : ".");
2136 termp_lk_pre(DECL_ARGS
)
2138 const struct mdoc_node
*n
;
2140 assert(node
->child
);
2143 if (NULL
== n
->next
) {
2144 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_LINK_ANCHOR
]);
2148 p
->flags
|= ttypes
[TTYPE_LINK_ANCHOR
];
2149 term_word(p
, n
->string
);
2150 p
->flags
|= TERMP_NOSPACE
;
2152 p
->flags
&= ~ttypes
[TTYPE_LINK_ANCHOR
];
2154 p
->flags
|= ttypes
[TTYPE_LINK_TEXT
];
2155 for (n
= n
->next
; n
; n
= n
->next
)
2156 term_word(p
, n
->string
);
2158 p
->flags
&= ~ttypes
[TTYPE_LINK_TEXT
];
2165 termp_mt_pre(DECL_ARGS
)
2168 TERMPAIR_SETFLAG(p
, pair
, ttypes
[TTYPE_LINK_ANCHOR
]);