]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_man.c
1 /* $Id: mdoc_man.c,v 1.59 2014/03/23 11:25:26 schwarze Exp $ */
3 * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
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.
26 #include "mandoc_aux.h"
32 #define DECL_ARGS const struct mdoc_meta *meta, \
33 const struct mdoc_node *n
36 int (*cond
)(DECL_ARGS
); /* DON'T run actions */
37 int (*pre
)(DECL_ARGS
); /* pre-node action */
38 void (*post
)(DECL_ARGS
); /* post-node action */
39 const char *prefix
; /* pre-node string constant */
40 const char *suffix
; /* post-node string constant */
43 static int cond_body(DECL_ARGS
);
44 static int cond_head(DECL_ARGS
);
45 static void font_push(char);
46 static void font_pop(void);
47 static void mid_it(void);
48 static void post__t(DECL_ARGS
);
49 static void post_bd(DECL_ARGS
);
50 static void post_bf(DECL_ARGS
);
51 static void post_bk(DECL_ARGS
);
52 static void post_bl(DECL_ARGS
);
53 static void post_dl(DECL_ARGS
);
54 static void post_enc(DECL_ARGS
);
55 static void post_eo(DECL_ARGS
);
56 static void post_fa(DECL_ARGS
);
57 static void post_fd(DECL_ARGS
);
58 static void post_fl(DECL_ARGS
);
59 static void post_fn(DECL_ARGS
);
60 static void post_fo(DECL_ARGS
);
61 static void post_font(DECL_ARGS
);
62 static void post_in(DECL_ARGS
);
63 static void post_it(DECL_ARGS
);
64 static void post_lb(DECL_ARGS
);
65 static void post_nm(DECL_ARGS
);
66 static void post_percent(DECL_ARGS
);
67 static void post_pf(DECL_ARGS
);
68 static void post_sect(DECL_ARGS
);
69 static void post_sp(DECL_ARGS
);
70 static void post_vt(DECL_ARGS
);
71 static int pre__t(DECL_ARGS
);
72 static int pre_an(DECL_ARGS
);
73 static int pre_ap(DECL_ARGS
);
74 static int pre_bd(DECL_ARGS
);
75 static int pre_bf(DECL_ARGS
);
76 static int pre_bk(DECL_ARGS
);
77 static int pre_bl(DECL_ARGS
);
78 static int pre_br(DECL_ARGS
);
79 static int pre_bx(DECL_ARGS
);
80 static int pre_dl(DECL_ARGS
);
81 static int pre_enc(DECL_ARGS
);
82 static int pre_em(DECL_ARGS
);
83 static int pre_fa(DECL_ARGS
);
84 static int pre_fd(DECL_ARGS
);
85 static int pre_fl(DECL_ARGS
);
86 static int pre_fn(DECL_ARGS
);
87 static int pre_fo(DECL_ARGS
);
88 static int pre_ft(DECL_ARGS
);
89 static int pre_in(DECL_ARGS
);
90 static int pre_it(DECL_ARGS
);
91 static int pre_lk(DECL_ARGS
);
92 static int pre_li(DECL_ARGS
);
93 static int pre_nm(DECL_ARGS
);
94 static int pre_no(DECL_ARGS
);
95 static int pre_ns(DECL_ARGS
);
96 static int pre_pp(DECL_ARGS
);
97 static int pre_rs(DECL_ARGS
);
98 static int pre_sm(DECL_ARGS
);
99 static int pre_sp(DECL_ARGS
);
100 static int pre_sect(DECL_ARGS
);
101 static int pre_sy(DECL_ARGS
);
102 static void pre_syn(const struct mdoc_node
*);
103 static int pre_vt(DECL_ARGS
);
104 static int pre_ux(DECL_ARGS
);
105 static int pre_xr(DECL_ARGS
);
106 static void print_word(const char *);
107 static void print_line(const char *, int);
108 static void print_block(const char *, int);
109 static void print_offs(const char *);
110 static void print_width(const char *,
111 const struct mdoc_node
*, size_t);
112 static void print_count(int *);
113 static void print_node(DECL_ARGS
);
115 static const struct manact manacts
[MDOC_MAX
+ 1] = {
116 { NULL
, pre_ap
, NULL
, NULL
, NULL
}, /* Ap */
117 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dd */
118 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dt */
119 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Os */
120 { NULL
, pre_sect
, post_sect
, ".SH", NULL
}, /* Sh */
121 { NULL
, pre_sect
, post_sect
, ".SS", NULL
}, /* Ss */
122 { NULL
, pre_pp
, NULL
, NULL
, NULL
}, /* Pp */
123 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* D1 */
124 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* Dl */
125 { cond_body
, pre_bd
, post_bd
, NULL
, NULL
}, /* Bd */
126 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ed */
127 { cond_body
, pre_bl
, post_bl
, NULL
, NULL
}, /* Bl */
128 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* El */
129 { NULL
, pre_it
, post_it
, NULL
, NULL
}, /* It */
130 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ad */
131 { NULL
, pre_an
, NULL
, NULL
, NULL
}, /* An */
132 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ar */
133 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cd */
134 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cm */
135 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Dv */
136 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Er */
137 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Ev */
138 { NULL
, pre_enc
, post_enc
, "The \\fB",
139 "\\fP\nutility exits 0 on success, and >0 if an error occurs."
141 { NULL
, pre_fa
, post_fa
, NULL
, NULL
}, /* Fa */
142 { NULL
, pre_fd
, post_fd
, NULL
, NULL
}, /* Fd */
143 { NULL
, pre_fl
, post_fl
, NULL
, NULL
}, /* Fl */
144 { NULL
, pre_fn
, post_fn
, NULL
, NULL
}, /* Fn */
145 { NULL
, pre_ft
, post_font
, NULL
, NULL
}, /* Ft */
146 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Ic */
147 { NULL
, pre_in
, post_in
, NULL
, NULL
}, /* In */
148 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Li */
149 { cond_head
, pre_enc
, NULL
, "\\- ", NULL
}, /* Nd */
150 { NULL
, pre_nm
, post_nm
, NULL
, NULL
}, /* Nm */
151 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Op */
152 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ot */
153 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Pa */
154 { NULL
, pre_enc
, post_enc
, "The \\fB",
155 "\\fP\nfunction returns the value 0 if successful;\n"
156 "otherwise the value -1 is returned and the global\n"
157 "variable \\fIerrno\\fP is set to indicate the error."
159 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* St */
160 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Va */
161 { NULL
, pre_vt
, post_vt
, NULL
, NULL
}, /* Vt */
162 { NULL
, pre_xr
, NULL
, NULL
, NULL
}, /* Xr */
163 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %A */
164 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %B */
165 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %D */
166 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %I */
167 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %J */
168 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %N */
169 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %O */
170 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %P */
171 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %R */
172 { NULL
, pre__t
, post__t
, NULL
, NULL
}, /* %T */
173 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %V */
174 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ac */
175 { cond_body
, pre_enc
, post_enc
, "<", ">" }, /* Ao */
176 { cond_body
, pre_enc
, post_enc
, "<", ">" }, /* Aq */
177 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* At */
178 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bc */
179 { NULL
, pre_bf
, post_bf
, NULL
, NULL
}, /* Bf */
180 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Bo */
181 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Bq */
182 { NULL
, pre_ux
, NULL
, "BSD/OS", NULL
}, /* Bsx */
183 { NULL
, pre_bx
, NULL
, NULL
, NULL
}, /* Bx */
184 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Db */
185 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dc */
186 { cond_body
, pre_enc
, post_enc
, "\\(lq", "\\(rq" }, /* Do */
187 { cond_body
, pre_enc
, post_enc
, "\\(lq", "\\(rq" }, /* Dq */
188 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ec */
189 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ef */
190 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Em */
191 { NULL
, NULL
, post_eo
, NULL
, NULL
}, /* Eo */
192 { NULL
, pre_ux
, NULL
, "FreeBSD", NULL
}, /* Fx */
193 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Ms */
194 { NULL
, pre_no
, NULL
, NULL
, NULL
}, /* No */
195 { NULL
, pre_ns
, NULL
, NULL
, NULL
}, /* Ns */
196 { NULL
, pre_ux
, NULL
, "NetBSD", NULL
}, /* Nx */
197 { NULL
, pre_ux
, NULL
, "OpenBSD", NULL
}, /* Ox */
198 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Pc */
199 { NULL
, NULL
, post_pf
, NULL
, NULL
}, /* Pf */
200 { cond_body
, pre_enc
, post_enc
, "(", ")" }, /* Po */
201 { cond_body
, pre_enc
, post_enc
, "(", ")" }, /* Pq */
202 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Qc */
203 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* Ql */
204 { cond_body
, pre_enc
, post_enc
, "\"", "\"" }, /* Qo */
205 { cond_body
, pre_enc
, post_enc
, "\"", "\"" }, /* Qq */
206 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Re */
207 { cond_body
, pre_rs
, NULL
, NULL
, NULL
}, /* Rs */
208 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Sc */
209 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* So */
210 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* Sq */
211 { NULL
, pre_sm
, NULL
, NULL
, NULL
}, /* Sm */
212 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Sx */
213 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Sy */
214 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Tn */
215 { NULL
, pre_ux
, NULL
, "UNIX", NULL
}, /* Ux */
216 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xc */
217 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xo */
218 { NULL
, pre_fo
, post_fo
, NULL
, NULL
}, /* Fo */
219 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Fc */
220 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Oo */
221 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Oc */
222 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Bk */
223 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ek */
224 { NULL
, pre_ux
, NULL
, "is currently in beta test.", NULL
}, /* Bt */
225 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Hf */
226 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Fr */
227 { NULL
, pre_ux
, NULL
, "currently under development.", NULL
}, /* Ud */
228 { NULL
, NULL
, post_lb
, NULL
, NULL
}, /* Lb */
229 { NULL
, pre_pp
, NULL
, NULL
, NULL
}, /* Lp */
230 { NULL
, pre_lk
, NULL
, NULL
, NULL
}, /* Lk */
231 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Mt */
232 { cond_body
, pre_enc
, post_enc
, "{", "}" }, /* Brq */
233 { cond_body
, pre_enc
, post_enc
, "{", "}" }, /* Bro */
234 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Brc */
235 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %C */
236 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Es */
237 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* En */
238 { NULL
, pre_ux
, NULL
, "DragonFly", NULL
}, /* Dx */
239 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %Q */
240 { NULL
, pre_br
, NULL
, NULL
, NULL
}, /* br */
241 { NULL
, pre_sp
, post_sp
, NULL
, NULL
}, /* sp */
242 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %U */
243 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ta */
244 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* ROOT */
248 #define MMAN_spc (1 << 0) /* blank character before next word */
249 #define MMAN_spc_force (1 << 1) /* even before trailing punctuation */
250 #define MMAN_nl (1 << 2) /* break man(7) code line */
251 #define MMAN_br (1 << 3) /* break output line */
252 #define MMAN_sp (1 << 4) /* insert a blank output line */
253 #define MMAN_PP (1 << 5) /* reset indentation etc. */
254 #define MMAN_Sm (1 << 6) /* horizontal spacing mode */
255 #define MMAN_Bk (1 << 7) /* word keep mode */
256 #define MMAN_Bk_susp (1 << 8) /* suspend this (after a macro) */
257 #define MMAN_An_split (1 << 9) /* author mode is "split" */
258 #define MMAN_An_nosplit (1 << 10) /* author mode is "nosplit" */
259 #define MMAN_PD (1 << 11) /* inter-paragraph spacing disabled */
260 #define MMAN_nbrword (1 << 12) /* do not break the next word */
262 #define BL_STACK_MAX 32
264 static size_t Bl_stack
[BL_STACK_MAX
]; /* offsets [chars] */
265 static int Bl_stack_post
[BL_STACK_MAX
]; /* add final .RE */
266 static int Bl_stack_len
; /* number of nested Bl blocks */
267 static int TPremain
; /* characters before tag is full */
276 font_push(char newfont
)
279 if (fontqueue
.head
+ fontqueue
.size
<= ++fontqueue
.tail
) {
281 fontqueue
.head
= mandoc_realloc(fontqueue
.head
,
284 *fontqueue
.tail
= newfont
;
288 outflags
&= ~MMAN_spc
;
295 if (fontqueue
.tail
> fontqueue
.head
)
297 outflags
&= ~MMAN_spc
;
300 putchar(*fontqueue
.tail
);
304 print_word(const char *s
)
307 if ((MMAN_PP
| MMAN_sp
| MMAN_br
| MMAN_nl
) & outflags
) {
309 * If we need a newline, print it now and start afresh.
311 if (MMAN_PP
& outflags
) {
312 if (MMAN_sp
& outflags
) {
313 if (MMAN_PD
& outflags
) {
315 outflags
&= ~MMAN_PD
;
317 } else if ( ! (MMAN_PD
& outflags
)) {
322 } else if (MMAN_sp
& outflags
)
324 else if (MMAN_br
& outflags
)
326 else if (MMAN_nl
& outflags
)
328 outflags
&= ~(MMAN_PP
|MMAN_sp
|MMAN_br
|MMAN_nl
|MMAN_spc
);
332 } else if (MMAN_spc
& outflags
) {
334 * If we need a space, only print it if
335 * (1) it is forced by `No' or
336 * (2) what follows is not terminating punctuation or
337 * (3) what follows is longer than one character.
339 if (MMAN_spc_force
& outflags
|| '\0' == s
[0] ||
340 NULL
== strchr(".,:;)]?!", s
[0]) || '\0' != s
[1]) {
341 if (MMAN_Bk
& outflags
&&
342 ! (MMAN_Bk_susp
& outflags
))
351 * Reassign needing space if we're not following opening
354 if (MMAN_Sm
& outflags
&& ('\0' == s
[0] ||
355 (('(' != s
[0] && '[' != s
[0]) || '\0' != s
[1])))
356 outflags
|= MMAN_spc
;
358 outflags
&= ~MMAN_spc
;
359 outflags
&= ~(MMAN_spc_force
| MMAN_Bk_susp
);
373 if (MMAN_nbrword
& outflags
) {
379 putchar((unsigned char)*s
);
385 outflags
&= ~MMAN_nbrword
;
389 print_line(const char *s
, int newflags
)
392 outflags
&= ~MMAN_br
;
395 outflags
|= newflags
;
399 print_block(const char *s
, int newflags
)
402 outflags
&= ~MMAN_PP
;
403 if (MMAN_sp
& outflags
) {
404 outflags
&= ~(MMAN_sp
| MMAN_br
);
405 if (MMAN_PD
& outflags
) {
406 print_line(".PD", 0);
407 outflags
&= ~MMAN_PD
;
409 } else if (! (MMAN_PD
& outflags
))
410 print_line(".PD 0", MMAN_PD
);
413 outflags
|= MMAN_Bk_susp
| newflags
;
417 print_offs(const char *v
)
423 print_line(".RS", MMAN_Bk_susp
);
425 /* Convert v into a number (of characters). */
426 if (NULL
== v
|| '\0' == *v
|| 0 == strcmp(v
, "left"))
428 else if (0 == strcmp(v
, "indent"))
430 else if (0 == strcmp(v
, "indent-two"))
432 else if (a2roffsu(v
, &su
, SCALE_MAX
)) {
433 if (SCALE_EN
== su
.unit
)
438 * If we are inside an enclosing list,
439 * there is no easy way to add the two
440 * indentations because they are provided
441 * in terms of different units.
451 * We are inside an enclosing list.
452 * Add the two indentations.
455 sz
+= Bl_stack
[Bl_stack_len
- 1];
457 snprintf(buf
, sizeof(buf
), "%zun", sz
);
463 * Set up the indentation for a list item; used from pre_it().
466 print_width(const char *v
, const struct mdoc_node
*child
, size_t defsz
)
476 /* Convert v into a number (of characters). */
479 else if (a2roffsu(v
, &su
, SCALE_MAX
)) {
480 if (SCALE_EN
== su
.unit
)
489 /* XXX Rough estimation, might have multiple parts. */
490 chsz
= (NULL
!= child
&& MDOC_TEXT
== child
->type
) ?
491 strlen(child
->string
) : 0;
493 /* Maybe we are inside an enclosing list? */
497 * Save our own indentation,
498 * such that child lists can use it.
500 Bl_stack
[Bl_stack_len
++] = sz
+ 2;
502 /* Set up the current list. */
503 if (defsz
&& chsz
> sz
)
504 print_block(".HP", 0);
506 print_block(".TP", 0);
510 snprintf(buf
, sizeof(buf
), "%zun", sz
+ 2);
518 print_count(int *count
)
522 snprintf(buf
, sizeof(buf
), "%d.", ++*count
);
527 man_man(void *arg
, const struct man
*man
)
531 * Dump the keep buffer.
532 * We're guaranteed by now that this exists (is non-NULL).
533 * Flush stdout afterward, just in case.
535 fputs(mparse_getkeep(man_mparse(man
)), stdout
);
540 man_mdoc(void *arg
, const struct mdoc
*mdoc
)
542 const struct mdoc_meta
*meta
;
543 const struct mdoc_node
*n
;
545 meta
= mdoc_meta(mdoc
);
548 printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
549 meta
->title
, meta
->msec
, meta
->date
,
550 meta
->os
, meta
->vol
);
552 /* Disable hyphenation and if nroff, disable justification. */
553 printf(".nh\n.if n .ad l");
555 outflags
= MMAN_nl
| MMAN_Sm
;
556 if (0 == fontqueue
.size
) {
558 fontqueue
.head
= fontqueue
.tail
= mandoc_malloc(8);
559 *fontqueue
.tail
= 'R';
566 print_node(DECL_ARGS
)
568 const struct mdoc_node
*sub
;
569 const struct manact
*act
;
573 * Break the line if we were parsed subsequent the current node.
574 * This makes the page structure be more consistent.
576 if (MMAN_spc
& outflags
&& MDOC_LINE
& n
->flags
)
583 if (MDOC_TEXT
== n
->type
) {
585 * Make sure that we don't happen to start with a
586 * control character at the start of a line.
588 if (MMAN_nl
& outflags
&& ('.' == *n
->string
||
589 '\'' == *n
->string
)) {
592 outflags
&= ~MMAN_spc
;
594 print_word(n
->string
);
597 * Conditionally run the pre-node action handler for a
600 act
= manacts
+ n
->tok
;
601 cond
= NULL
== act
->cond
|| (*act
->cond
)(meta
, n
);
602 if (cond
&& act
->pre
)
603 do_sub
= (*act
->pre
)(meta
, n
);
607 * Conditionally run all child nodes.
608 * Note that this iterates over children instead of using
609 * recursion. This prevents unnecessary depth in the stack.
612 for (sub
= n
->child
; sub
; sub
= sub
->next
)
613 print_node(meta
, sub
);
616 * Lastly, conditionally run the post-node handler.
618 if (cond
&& act
->post
)
619 (*act
->post
)(meta
, n
);
626 return(MDOC_HEAD
== n
->type
);
633 return(MDOC_BODY
== n
->type
);
641 prefix
= manacts
[n
->tok
].prefix
;
645 outflags
&= ~MMAN_spc
;
654 suffix
= manacts
[n
->tok
].suffix
;
657 outflags
&= ~MMAN_spc
;
669 post_percent(DECL_ARGS
)
672 if (pre_em
== manacts
[n
->tok
].pre
)
676 if (n
->prev
&& n
->prev
->tok
== n
->tok
&&
677 n
->next
->tok
== n
->tok
)
689 if (n
->parent
&& MDOC_Rs
== n
->parent
->tok
&&
690 n
->parent
->norm
->Rs
.quote_T
) {
693 outflags
&= ~MMAN_spc
;
703 if (n
->parent
&& MDOC_Rs
== n
->parent
->tok
&&
704 n
->parent
->norm
->Rs
.quote_T
) {
705 outflags
&= ~MMAN_spc
;
710 post_percent(meta
, n
);
714 * Print before a section header.
720 if (MDOC_HEAD
== n
->type
) {
722 print_block(manacts
[n
->tok
].prefix
, 0);
725 outflags
&= ~MMAN_spc
;
731 * Print subsequent a section header.
737 if (MDOC_HEAD
!= n
->type
)
739 outflags
&= ~MMAN_spc
;
743 if (MDOC_Sh
== n
->tok
&& SEC_AUTHORS
== n
->sec
)
744 outflags
&= ~(MMAN_An_split
| MMAN_An_nosplit
);
747 /* See mdoc_term.c, synopsis_pre() for comments. */
749 pre_syn(const struct mdoc_node
*n
)
752 if (NULL
== n
->prev
|| ! (MDOC_SYNPRETTY
& n
->flags
))
755 if (n
->prev
->tok
== n
->tok
&&
763 switch (n
->prev
->tok
) {
776 if (MDOC_Fn
!= n
->tok
&& MDOC_Fo
!= n
->tok
) {
791 switch (n
->norm
->An
.auth
) {
793 outflags
&= ~MMAN_An_nosplit
;
794 outflags
|= MMAN_An_split
;
797 outflags
&= ~MMAN_An_split
;
798 outflags
|= MMAN_An_nosplit
;
801 if (MMAN_An_split
& outflags
)
803 else if (SEC_AUTHORS
== n
->sec
&&
804 ! (MMAN_An_nosplit
& outflags
))
805 outflags
|= MMAN_An_split
;
814 outflags
&= ~MMAN_spc
;
816 outflags
&= ~MMAN_spc
;
824 outflags
&= ~(MMAN_PP
| MMAN_sp
| MMAN_br
);
826 if (DISP_unfilled
== n
->norm
->Bd
.type
||
827 DISP_literal
== n
->norm
->Bd
.type
)
828 print_line(".nf", 0);
829 if (0 == n
->norm
->Bd
.comp
&& NULL
!= n
->parent
->prev
)
831 print_offs(n
->norm
->Bd
.offs
);
839 /* Close out this display. */
840 print_line(".RE", MMAN_nl
);
841 if (DISP_unfilled
== n
->norm
->Bd
.type
||
842 DISP_literal
== n
->norm
->Bd
.type
)
843 print_line(".fi", MMAN_nl
);
845 /* Maybe we are inside an enclosing list? */
846 if (NULL
!= n
->parent
->next
)
862 switch (n
->norm
->Bf
.font
) {
880 if (MDOC_BODY
== n
->type
)
903 if (MDOC_BODY
== n
->type
)
904 outflags
&= ~MMAN_Bk
;
913 * print_offs() will increase the -offset to account for
914 * a possible enclosing .It, but any enclosed .It blocks
915 * just nest and do not add up their indentation.
917 if (n
->norm
->Bl
.offs
) {
918 print_offs(n
->norm
->Bl
.offs
);
919 Bl_stack
[Bl_stack_len
++] = 0;
922 switch (n
->norm
->Bl
.type
) {
924 n
->norm
->Bl
.count
= 0;
932 print_line(".TS", MMAN_nl
);
933 for (icol
= 0; icol
< n
->norm
->Bl
.ncols
; icol
++)
944 switch (n
->norm
->Bl
.type
) {
946 print_line(".TE", 0);
949 n
->norm
->Bl
.count
= 0;
955 if (n
->norm
->Bl
.offs
) {
956 print_line(".RE", MMAN_nl
);
957 assert(Bl_stack_len
);
959 assert(0 == Bl_stack
[Bl_stack_len
]);
961 outflags
|= MMAN_PP
| MMAN_nl
;
962 outflags
&= ~(MMAN_sp
| MMAN_br
);
965 /* Maybe we are inside an enclosing list? */
966 if (NULL
!= n
->parent
->next
)
985 print_word(n
->string
);
986 outflags
&= ~MMAN_spc
;
992 outflags
&= ~MMAN_spc
;
994 outflags
&= ~MMAN_spc
;
995 print_word(n
->string
);
1011 print_line(".RE", MMAN_nl
);
1013 /* Maybe we are inside an enclosing list? */
1014 if (NULL
!= n
->parent
->next
)
1030 if (MDOC_HEAD
== n
->type
|| MDOC_BODY
== n
->type
)
1031 outflags
&= ~MMAN_spc
;
1039 am_Fa
= MDOC_Fa
== n
->tok
;
1046 if (am_Fa
|| MDOC_SYNPRETTY
& n
->flags
)
1047 outflags
|= MMAN_nbrword
;
1048 print_node(meta
, n
);
1050 if (NULL
!= (n
= n
->next
))
1060 if (NULL
!= n
->next
&& MDOC_Fa
== n
->next
->tok
)
1078 outflags
|= MMAN_br
;
1087 outflags
&= ~MMAN_spc
;
1096 if (0 == n
->nchild
&& NULL
!= n
->next
&&
1097 n
->next
->line
== n
->line
)
1098 outflags
&= ~MMAN_spc
;
1111 if (MDOC_SYNPRETTY
& n
->flags
)
1112 print_block(".HP 4n", MMAN_nl
);
1115 print_node(meta
, n
);
1117 outflags
&= ~MMAN_spc
;
1119 outflags
&= ~MMAN_spc
;
1132 if (MDOC_SYNPRETTY
& n
->flags
) {
1134 outflags
|= MMAN_PP
;
1147 if (MDOC_SYNPRETTY
& n
->flags
)
1148 print_block(".HP 4n", MMAN_nl
);
1152 outflags
&= ~MMAN_spc
;
1154 outflags
&= ~MMAN_spc
;
1191 if (MDOC_SYNPRETTY
& n
->flags
) {
1194 print_word("#include <");
1195 outflags
&= ~MMAN_spc
;
1198 outflags
&= ~MMAN_spc
;
1208 if (MDOC_SYNPRETTY
& n
->flags
) {
1209 outflags
&= ~MMAN_spc
;
1212 outflags
|= MMAN_br
;
1215 outflags
&= ~MMAN_spc
;
1223 const struct mdoc_node
*bln
;
1227 outflags
|= MMAN_PP
| MMAN_nl
;
1228 bln
= n
->parent
->parent
;
1229 if (0 == bln
->norm
->Bl
.comp
||
1230 (NULL
== n
->parent
->prev
&&
1231 NULL
== bln
->parent
->prev
))
1232 outflags
|= MMAN_sp
;
1233 outflags
&= ~MMAN_br
;
1234 switch (bln
->norm
->Bl
.type
) {
1242 if (bln
->norm
->Bl
.type
== LIST_diag
)
1243 print_line(".B \"", 0);
1245 print_line(".R \"", 0);
1246 outflags
&= ~MMAN_spc
;
1253 print_width(bln
->norm
->Bl
.width
, NULL
, 0);
1255 outflags
|= MMAN_nl
;
1257 if (LIST_bullet
== bln
->norm
->Bl
.type
)
1264 print_width(bln
->norm
->Bl
.width
, NULL
, 0);
1266 outflags
|= MMAN_nl
;
1267 print_count(&bln
->norm
->Bl
.count
);
1270 print_width(bln
->norm
->Bl
.width
, n
->child
, 6);
1274 print_width(bln
->norm
->Bl
.width
, n
->child
, 0);
1276 outflags
&= ~MMAN_spc
;
1281 outflags
|= MMAN_nl
;
1289 * This function is called after closing out an indented block.
1290 * If we are inside an enclosing list, restore its indentation.
1297 /* Nothing to do outside a list. */
1298 if (0 == Bl_stack_len
|| 0 == Bl_stack
[Bl_stack_len
- 1])
1301 /* The indentation has already been set up. */
1302 if (Bl_stack_post
[Bl_stack_len
- 1])
1305 /* Restore the indentation of the enclosing list. */
1306 print_line(".RS", MMAN_Bk_susp
);
1307 snprintf(buf
, sizeof(buf
), "%zun", Bl_stack
[Bl_stack_len
- 1]);
1310 /* Remeber to close out this .RS block later. */
1311 Bl_stack_post
[Bl_stack_len
- 1] = 1;
1317 const struct mdoc_node
*bln
;
1319 bln
= n
->parent
->parent
;
1323 switch (bln
->norm
->Bl
.type
) {
1325 outflags
&= ~MMAN_spc
;
1329 outflags
|= MMAN_br
;
1336 switch (bln
->norm
->Bl
.type
) {
1348 assert(Bl_stack_len
);
1349 Bl_stack
[--Bl_stack_len
] = 0;
1352 * Our indentation had to be restored
1353 * after a child display or child list.
1354 * Close out that indentation block now.
1356 if (Bl_stack_post
[Bl_stack_len
]) {
1357 print_line(".RE", MMAN_nl
);
1358 Bl_stack_post
[Bl_stack_len
] = 0;
1362 if (NULL
!= n
->next
) {
1364 outflags
&= ~MMAN_spc
;
1380 if (SEC_LIBRARY
== n
->sec
)
1381 outflags
|= MMAN_br
;
1387 const struct mdoc_node
*link
, *descr
;
1389 if (NULL
== (link
= n
->child
))
1392 if (NULL
!= (descr
= link
->next
)) {
1394 while (NULL
!= descr
) {
1395 print_word(descr
->string
);
1396 descr
= descr
->next
;
1403 print_word(link
->string
);
1421 if (MDOC_BLOCK
== n
->type
) {
1422 outflags
|= MMAN_Bk
;
1425 if (MDOC_ELEM
!= n
->type
&& MDOC_HEAD
!= n
->type
)
1427 name
= n
->child
? n
->child
->string
: meta
->name
;
1430 if (MDOC_HEAD
== n
->type
) {
1431 if (NULL
== n
->parent
->prev
)
1432 outflags
|= MMAN_sp
;
1433 print_block(".HP", 0);
1434 printf(" %zun", strlen(name
) + 1);
1435 outflags
|= MMAN_nl
;
1438 if (NULL
== n
->child
)
1439 print_word(meta
->name
);
1449 outflags
&= ~MMAN_Bk
;
1465 outflags
|= MMAN_spc_force
;
1473 outflags
&= ~MMAN_spc
;
1481 outflags
&= ~MMAN_spc
;
1488 if (MDOC_It
!= n
->parent
->tok
)
1489 outflags
|= MMAN_PP
;
1490 outflags
|= MMAN_sp
| MMAN_nl
;
1491 outflags
&= ~MMAN_br
;
1499 if (SEC_SEE_ALSO
== n
->sec
) {
1500 outflags
|= MMAN_PP
| MMAN_sp
| MMAN_nl
;
1501 outflags
&= ~MMAN_br
;
1510 assert(n
->child
&& MDOC_TEXT
== n
->child
->type
);
1511 if (0 == strcmp("on", n
->child
->string
))
1512 outflags
|= MMAN_Sm
| MMAN_spc
;
1514 outflags
&= ~MMAN_Sm
;
1522 if (MMAN_PP
& outflags
) {
1523 outflags
&= ~MMAN_PP
;
1524 print_line(".PP", 0);
1526 print_line(".sp", 0);
1534 outflags
|= MMAN_nl
;
1549 if (MDOC_SYNPRETTY
& n
->flags
) {
1568 if (MDOC_SYNPRETTY
& n
->flags
&& MDOC_BODY
!= n
->type
)
1580 print_node(meta
, n
);
1584 outflags
&= ~MMAN_spc
;
1586 print_node(meta
, n
);
1595 print_word(manacts
[n
->tok
].prefix
);
1596 if (NULL
== n
->child
)
1598 outflags
&= ~MMAN_spc
;
1600 outflags
&= ~MMAN_spc
;