1 /* $Id: mdoc_man.c,v 1.68 2014/08/06 15:09:05 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_en(DECL_ARGS
);
55 static void post_enc(DECL_ARGS
);
56 static void post_eo(DECL_ARGS
);
57 static void post_fa(DECL_ARGS
);
58 static void post_fd(DECL_ARGS
);
59 static void post_fl(DECL_ARGS
);
60 static void post_fn(DECL_ARGS
);
61 static void post_fo(DECL_ARGS
);
62 static void post_font(DECL_ARGS
);
63 static void post_in(DECL_ARGS
);
64 static void post_it(DECL_ARGS
);
65 static void post_lb(DECL_ARGS
);
66 static void post_nm(DECL_ARGS
);
67 static void post_percent(DECL_ARGS
);
68 static void post_pf(DECL_ARGS
);
69 static void post_sect(DECL_ARGS
);
70 static void post_sp(DECL_ARGS
);
71 static void post_vt(DECL_ARGS
);
72 static int pre__t(DECL_ARGS
);
73 static int pre_an(DECL_ARGS
);
74 static int pre_ap(DECL_ARGS
);
75 static int pre_bd(DECL_ARGS
);
76 static int pre_bf(DECL_ARGS
);
77 static int pre_bk(DECL_ARGS
);
78 static int pre_bl(DECL_ARGS
);
79 static int pre_br(DECL_ARGS
);
80 static int pre_bx(DECL_ARGS
);
81 static int pre_dl(DECL_ARGS
);
82 static int pre_en(DECL_ARGS
);
83 static int pre_enc(DECL_ARGS
);
84 static int pre_em(DECL_ARGS
);
85 static int pre_es(DECL_ARGS
);
86 static int pre_ex(DECL_ARGS
);
87 static int pre_fa(DECL_ARGS
);
88 static int pre_fd(DECL_ARGS
);
89 static int pre_fl(DECL_ARGS
);
90 static int pre_fn(DECL_ARGS
);
91 static int pre_fo(DECL_ARGS
);
92 static int pre_ft(DECL_ARGS
);
93 static int pre_in(DECL_ARGS
);
94 static int pre_it(DECL_ARGS
);
95 static int pre_lk(DECL_ARGS
);
96 static int pre_li(DECL_ARGS
);
97 static int pre_ll(DECL_ARGS
);
98 static int pre_nm(DECL_ARGS
);
99 static int pre_no(DECL_ARGS
);
100 static int pre_ns(DECL_ARGS
);
101 static int pre_pp(DECL_ARGS
);
102 static int pre_rs(DECL_ARGS
);
103 static int pre_rv(DECL_ARGS
);
104 static int pre_sm(DECL_ARGS
);
105 static int pre_sp(DECL_ARGS
);
106 static int pre_sect(DECL_ARGS
);
107 static int pre_sy(DECL_ARGS
);
108 static void pre_syn(const struct mdoc_node
*);
109 static int pre_vt(DECL_ARGS
);
110 static int pre_ux(DECL_ARGS
);
111 static int pre_xr(DECL_ARGS
);
112 static void print_word(const char *);
113 static void print_line(const char *, int);
114 static void print_block(const char *, int);
115 static void print_offs(const char *);
116 static void print_width(const char *,
117 const struct mdoc_node
*, size_t);
118 static void print_count(int *);
119 static void print_node(DECL_ARGS
);
121 static const struct manact manacts
[MDOC_MAX
+ 1] = {
122 { NULL
, pre_ap
, NULL
, NULL
, NULL
}, /* Ap */
123 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dd */
124 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dt */
125 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Os */
126 { NULL
, pre_sect
, post_sect
, ".SH", NULL
}, /* Sh */
127 { NULL
, pre_sect
, post_sect
, ".SS", NULL
}, /* Ss */
128 { NULL
, pre_pp
, NULL
, NULL
, NULL
}, /* Pp */
129 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* D1 */
130 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* Dl */
131 { cond_body
, pre_bd
, post_bd
, NULL
, NULL
}, /* Bd */
132 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ed */
133 { cond_body
, pre_bl
, post_bl
, NULL
, NULL
}, /* Bl */
134 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* El */
135 { NULL
, pre_it
, post_it
, NULL
, NULL
}, /* It */
136 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ad */
137 { NULL
, pre_an
, NULL
, NULL
, NULL
}, /* An */
138 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ar */
139 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cd */
140 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cm */
141 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Dv */
142 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Er */
143 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Ev */
144 { NULL
, pre_ex
, NULL
, NULL
, NULL
}, /* Ex */
145 { NULL
, pre_fa
, post_fa
, NULL
, NULL
}, /* Fa */
146 { NULL
, pre_fd
, post_fd
, NULL
, NULL
}, /* Fd */
147 { NULL
, pre_fl
, post_fl
, NULL
, NULL
}, /* Fl */
148 { NULL
, pre_fn
, post_fn
, NULL
, NULL
}, /* Fn */
149 { NULL
, pre_ft
, post_font
, NULL
, NULL
}, /* Ft */
150 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Ic */
151 { NULL
, pre_in
, post_in
, NULL
, NULL
}, /* In */
152 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Li */
153 { cond_head
, pre_enc
, NULL
, "\\- ", NULL
}, /* Nd */
154 { NULL
, pre_nm
, post_nm
, NULL
, NULL
}, /* Nm */
155 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Op */
156 { NULL
, pre_ft
, post_font
, NULL
, NULL
}, /* Ot */
157 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Pa */
158 { NULL
, pre_rv
, NULL
, NULL
, NULL
}, /* Rv */
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
, pre_em
, post_font
, 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
, pre_es
, NULL
, NULL
, NULL
}, /* Es */
237 { cond_body
, pre_en
, post_en
, 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
, pre_ll
, post_sp
, NULL
, NULL
}, /* ll */
245 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* ROOT */
249 #define MMAN_spc (1 << 0) /* blank character before next word */
250 #define MMAN_spc_force (1 << 1) /* even before trailing punctuation */
251 #define MMAN_nl (1 << 2) /* break man(7) code line */
252 #define MMAN_br (1 << 3) /* break output line */
253 #define MMAN_sp (1 << 4) /* insert a blank output line */
254 #define MMAN_PP (1 << 5) /* reset indentation etc. */
255 #define MMAN_Sm (1 << 6) /* horizontal spacing mode */
256 #define MMAN_Bk (1 << 7) /* word keep mode */
257 #define MMAN_Bk_susp (1 << 8) /* suspend this (after a macro) */
258 #define MMAN_An_split (1 << 9) /* author mode is "split" */
259 #define MMAN_An_nosplit (1 << 10) /* author mode is "nosplit" */
260 #define MMAN_PD (1 << 11) /* inter-paragraph spacing disabled */
261 #define MMAN_nbrword (1 << 12) /* do not break the next word */
263 #define BL_STACK_MAX 32
265 static size_t Bl_stack
[BL_STACK_MAX
]; /* offsets [chars] */
266 static int Bl_stack_post
[BL_STACK_MAX
]; /* add final .RE */
267 static int Bl_stack_len
; /* number of nested Bl blocks */
268 static int TPremain
; /* characters before tag is full */
278 font_push(char newfont
)
281 if (fontqueue
.head
+ fontqueue
.size
<= ++fontqueue
.tail
) {
283 fontqueue
.head
= mandoc_realloc(fontqueue
.head
,
286 *fontqueue
.tail
= newfont
;
290 outflags
&= ~MMAN_spc
;
297 if (fontqueue
.tail
> fontqueue
.head
)
299 outflags
&= ~MMAN_spc
;
302 putchar(*fontqueue
.tail
);
306 print_word(const char *s
)
309 if ((MMAN_PP
| MMAN_sp
| MMAN_br
| MMAN_nl
) & outflags
) {
311 * If we need a newline, print it now and start afresh.
313 if (MMAN_PP
& outflags
) {
314 if (MMAN_sp
& outflags
) {
315 if (MMAN_PD
& outflags
) {
317 outflags
&= ~MMAN_PD
;
319 } else if ( ! (MMAN_PD
& outflags
)) {
324 } else if (MMAN_sp
& outflags
)
326 else if (MMAN_br
& outflags
)
328 else if (MMAN_nl
& outflags
)
330 outflags
&= ~(MMAN_PP
|MMAN_sp
|MMAN_br
|MMAN_nl
|MMAN_spc
);
334 } else if (MMAN_spc
& outflags
) {
336 * If we need a space, only print it if
337 * (1) it is forced by `No' or
338 * (2) what follows is not terminating punctuation or
339 * (3) what follows is longer than one character.
341 if (MMAN_spc_force
& outflags
|| '\0' == s
[0] ||
342 NULL
== strchr(".,:;)]?!", s
[0]) || '\0' != s
[1]) {
343 if (MMAN_Bk
& outflags
&&
344 ! (MMAN_Bk_susp
& outflags
))
353 * Reassign needing space if we're not following opening
356 if (MMAN_Sm
& outflags
&& ('\0' == s
[0] ||
357 (('(' != s
[0] && '[' != s
[0]) || '\0' != s
[1])))
358 outflags
|= MMAN_spc
;
360 outflags
&= ~MMAN_spc
;
361 outflags
&= ~(MMAN_spc_force
| MMAN_Bk_susp
);
375 if (MMAN_nbrword
& outflags
) {
381 putchar((unsigned char)*s
);
387 outflags
&= ~MMAN_nbrword
;
391 print_line(const char *s
, int newflags
)
394 outflags
&= ~MMAN_br
;
397 outflags
|= newflags
;
401 print_block(const char *s
, int newflags
)
404 outflags
&= ~MMAN_PP
;
405 if (MMAN_sp
& outflags
) {
406 outflags
&= ~(MMAN_sp
| MMAN_br
);
407 if (MMAN_PD
& outflags
) {
408 print_line(".PD", 0);
409 outflags
&= ~MMAN_PD
;
411 } else if (! (MMAN_PD
& outflags
))
412 print_line(".PD 0", MMAN_PD
);
415 outflags
|= MMAN_Bk_susp
| newflags
;
419 print_offs(const char *v
)
425 print_line(".RS", MMAN_Bk_susp
);
427 /* Convert v into a number (of characters). */
428 if (NULL
== v
|| '\0' == *v
|| 0 == strcmp(v
, "left"))
430 else if (0 == strcmp(v
, "indent"))
432 else if (0 == strcmp(v
, "indent-two"))
434 else if (a2roffsu(v
, &su
, SCALE_MAX
)) {
435 if (SCALE_EN
== su
.unit
)
440 * If we are inside an enclosing list,
441 * there is no easy way to add the two
442 * indentations because they are provided
443 * in terms of different units.
453 * We are inside an enclosing list.
454 * Add the two indentations.
457 sz
+= Bl_stack
[Bl_stack_len
- 1];
459 (void)snprintf(buf
, sizeof(buf
), "%zun", sz
);
465 * Set up the indentation for a list item; used from pre_it().
468 print_width(const char *v
, const struct mdoc_node
*child
, size_t defsz
)
478 /* Convert v into a number (of characters). */
481 else if (a2roffsu(v
, &su
, SCALE_MAX
)) {
482 if (SCALE_EN
== su
.unit
)
491 /* XXX Rough estimation, might have multiple parts. */
492 chsz
= (NULL
!= child
&& MDOC_TEXT
== child
->type
) ?
493 strlen(child
->string
) : 0;
495 /* Maybe we are inside an enclosing list? */
499 * Save our own indentation,
500 * such that child lists can use it.
502 Bl_stack
[Bl_stack_len
++] = sz
+ 2;
504 /* Set up the current list. */
505 if (defsz
&& chsz
> sz
)
506 print_block(".HP", 0);
508 print_block(".TP", 0);
512 (void)snprintf(buf
, sizeof(buf
), "%zun", sz
+ 2);
520 print_count(int *count
)
524 (void)snprintf(buf
, sizeof(buf
), "%d.", ++*count
);
529 man_man(void *arg
, const struct man
*man
)
533 * Dump the keep buffer.
534 * We're guaranteed by now that this exists (is non-NULL).
535 * Flush stdout afterward, just in case.
537 fputs(mparse_getkeep(man_mparse(man
)), stdout
);
542 man_mdoc(void *arg
, const struct mdoc
*mdoc
)
544 const struct mdoc_meta
*meta
;
545 const struct mdoc_node
*n
;
547 meta
= mdoc_meta(mdoc
);
550 printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
552 (meta
->msec
== NULL
? "" : meta
->msec
),
553 meta
->date
, meta
->os
, meta
->vol
);
555 /* Disable hyphenation and if nroff, disable justification. */
556 printf(".nh\n.if n .ad l");
558 outflags
= MMAN_nl
| MMAN_Sm
;
559 if (0 == fontqueue
.size
) {
561 fontqueue
.head
= fontqueue
.tail
= mandoc_malloc(8);
562 *fontqueue
.tail
= 'R';
569 print_node(DECL_ARGS
)
571 const struct mdoc_node
*sub
;
572 const struct manact
*act
;
576 * Break the line if we were parsed subsequent the current node.
577 * This makes the page structure be more consistent.
579 if (MMAN_spc
& outflags
&& MDOC_LINE
& n
->flags
)
586 if (MDOC_TEXT
== n
->type
) {
588 * Make sure that we don't happen to start with a
589 * control character at the start of a line.
591 if (MMAN_nl
& outflags
&&
592 ('.' == *n
->string
|| '\'' == *n
->string
)) {
595 outflags
&= ~MMAN_spc
;
597 print_word(n
->string
);
600 * Conditionally run the pre-node action handler for a
603 act
= manacts
+ n
->tok
;
604 cond
= NULL
== act
->cond
|| (*act
->cond
)(meta
, n
);
605 if (cond
&& act
->pre
&& ENDBODY_NOT
== n
->end
)
606 do_sub
= (*act
->pre
)(meta
, n
);
610 * Conditionally run all child nodes.
611 * Note that this iterates over children instead of using
612 * recursion. This prevents unnecessary depth in the stack.
615 for (sub
= n
->child
; sub
; sub
= sub
->next
)
616 print_node(meta
, sub
);
619 * Lastly, conditionally run the post-node handler.
621 if (MDOC_ENDED
& n
->flags
)
624 if (cond
&& act
->post
)
625 (*act
->post
)(meta
, n
);
627 if (ENDBODY_NOT
!= n
->end
)
628 n
->pending
->flags
|= MDOC_ENDED
;
630 if (ENDBODY_NOSPACE
== n
->end
)
631 outflags
&= ~(MMAN_spc
| MMAN_nl
);
638 return(MDOC_HEAD
== n
->type
);
645 return(MDOC_BODY
== n
->type
);
653 prefix
= manacts
[n
->tok
].prefix
;
657 outflags
&= ~MMAN_spc
;
666 suffix
= manacts
[n
->tok
].suffix
;
669 outflags
&= ~(MMAN_spc
| MMAN_nl
);
678 outflags
|= MMAN_br
| MMAN_nl
;
683 for (n
= n
->child
; n
; n
= n
->next
) {
685 print_word(n
->string
);
692 outflags
&= ~MMAN_spc
;
695 if (n
->next
->next
== NULL
)
700 print_word("utilities exit\\~0");
702 print_word("utility exits\\~0");
704 print_word("on success, and\\~>0 if an error occurs.");
717 post_percent(DECL_ARGS
)
720 if (pre_em
== manacts
[n
->tok
].pre
)
724 if (n
->prev
&& n
->prev
->tok
== n
->tok
&&
725 n
->next
->tok
== n
->tok
)
737 if (n
->parent
&& MDOC_Rs
== n
->parent
->tok
&&
738 n
->parent
->norm
->Rs
.quote_T
) {
741 outflags
&= ~MMAN_spc
;
751 if (n
->parent
&& MDOC_Rs
== n
->parent
->tok
&&
752 n
->parent
->norm
->Rs
.quote_T
) {
753 outflags
&= ~MMAN_spc
;
758 post_percent(meta
, n
);
762 * Print before a section header.
768 if (MDOC_HEAD
== n
->type
) {
770 print_block(manacts
[n
->tok
].prefix
, 0);
773 outflags
&= ~MMAN_spc
;
779 * Print subsequent a section header.
785 if (MDOC_HEAD
!= n
->type
)
787 outflags
&= ~MMAN_spc
;
791 if (MDOC_Sh
== n
->tok
&& SEC_AUTHORS
== n
->sec
)
792 outflags
&= ~(MMAN_An_split
| MMAN_An_nosplit
);
795 /* See mdoc_term.c, synopsis_pre() for comments. */
797 pre_syn(const struct mdoc_node
*n
)
800 if (NULL
== n
->prev
|| ! (MDOC_SYNPRETTY
& n
->flags
))
803 if (n
->prev
->tok
== n
->tok
&&
811 switch (n
->prev
->tok
) {
824 if (MDOC_Fn
!= n
->tok
&& MDOC_Fo
!= n
->tok
) {
839 switch (n
->norm
->An
.auth
) {
841 outflags
&= ~MMAN_An_nosplit
;
842 outflags
|= MMAN_An_split
;
845 outflags
&= ~MMAN_An_split
;
846 outflags
|= MMAN_An_nosplit
;
849 if (MMAN_An_split
& outflags
)
851 else if (SEC_AUTHORS
== n
->sec
&&
852 ! (MMAN_An_nosplit
& outflags
))
853 outflags
|= MMAN_An_split
;
862 outflags
&= ~MMAN_spc
;
864 outflags
&= ~MMAN_spc
;
872 outflags
&= ~(MMAN_PP
| MMAN_sp
| MMAN_br
);
874 if (DISP_unfilled
== n
->norm
->Bd
.type
||
875 DISP_literal
== n
->norm
->Bd
.type
)
876 print_line(".nf", 0);
877 if (0 == n
->norm
->Bd
.comp
&& NULL
!= n
->parent
->prev
)
879 print_offs(n
->norm
->Bd
.offs
);
887 /* Close out this display. */
888 print_line(".RE", MMAN_nl
);
889 if (DISP_unfilled
== n
->norm
->Bd
.type
||
890 DISP_literal
== n
->norm
->Bd
.type
)
891 print_line(".fi", MMAN_nl
);
893 /* Maybe we are inside an enclosing list? */
894 if (NULL
!= n
->parent
->next
)
910 switch (n
->norm
->Bf
.font
) {
928 if (MDOC_BODY
== n
->type
)
951 if (MDOC_BODY
== n
->type
)
952 outflags
&= ~MMAN_Bk
;
961 * print_offs() will increase the -offset to account for
962 * a possible enclosing .It, but any enclosed .It blocks
963 * just nest and do not add up their indentation.
965 if (n
->norm
->Bl
.offs
) {
966 print_offs(n
->norm
->Bl
.offs
);
967 Bl_stack
[Bl_stack_len
++] = 0;
970 switch (n
->norm
->Bl
.type
) {
972 n
->norm
->Bl
.count
= 0;
980 print_line(".TS", MMAN_nl
);
981 for (icol
= 0; icol
< n
->norm
->Bl
.ncols
; icol
++)
992 switch (n
->norm
->Bl
.type
) {
994 print_line(".TE", 0);
997 n
->norm
->Bl
.count
= 0;
1003 if (n
->norm
->Bl
.offs
) {
1004 print_line(".RE", MMAN_nl
);
1005 assert(Bl_stack_len
);
1007 assert(0 == Bl_stack
[Bl_stack_len
]);
1009 outflags
|= MMAN_PP
| MMAN_nl
;
1010 outflags
&= ~(MMAN_sp
| MMAN_br
);
1013 /* Maybe we are inside an enclosing list? */
1014 if (NULL
!= n
->parent
->next
)
1023 outflags
|= MMAN_br
;
1033 print_word(n
->string
);
1034 outflags
&= ~MMAN_spc
;
1040 outflags
&= ~MMAN_spc
;
1042 outflags
&= ~MMAN_spc
;
1043 print_word(n
->string
);
1059 print_line(".RE", MMAN_nl
);
1061 /* Maybe we are inside an enclosing list? */
1062 if (NULL
!= n
->parent
->next
)
1078 if (NULL
== n
->norm
->Es
||
1079 NULL
== n
->norm
->Es
->child
)
1082 print_word(n
->norm
->Es
->child
->string
);
1083 outflags
&= ~MMAN_spc
;
1091 if (NULL
== n
->norm
->Es
||
1092 NULL
== n
->norm
->Es
->child
||
1093 NULL
== n
->norm
->Es
->child
->next
)
1096 outflags
&= ~MMAN_spc
;
1097 print_word(n
->norm
->Es
->child
->next
->string
);
1105 if (MDOC_HEAD
== n
->type
|| MDOC_BODY
== n
->type
)
1106 outflags
&= ~MMAN_spc
;
1121 am_Fa
= MDOC_Fa
== n
->tok
;
1128 if (am_Fa
|| MDOC_SYNPRETTY
& n
->flags
)
1129 outflags
|= MMAN_nbrword
;
1130 print_node(meta
, n
);
1132 if (NULL
!= (n
= n
->next
))
1142 if (NULL
!= n
->next
&& MDOC_Fa
== n
->next
->tok
)
1160 outflags
|= MMAN_br
;
1169 outflags
&= ~MMAN_spc
;
1178 if (0 == n
->nchild
&& NULL
!= n
->next
&&
1179 n
->next
->line
== n
->line
)
1180 outflags
&= ~MMAN_spc
;
1193 if (MDOC_SYNPRETTY
& n
->flags
)
1194 print_block(".HP 4n", MMAN_nl
);
1197 print_node(meta
, n
);
1199 outflags
&= ~MMAN_spc
;
1201 outflags
&= ~MMAN_spc
;
1214 if (MDOC_SYNPRETTY
& n
->flags
) {
1216 outflags
|= MMAN_PP
;
1229 if (MDOC_SYNPRETTY
& n
->flags
)
1230 print_block(".HP 4n", MMAN_nl
);
1234 outflags
&= ~MMAN_spc
;
1236 outflags
&= ~MMAN_spc
;
1273 if (MDOC_SYNPRETTY
& n
->flags
) {
1276 print_word("#include <");
1277 outflags
&= ~MMAN_spc
;
1280 outflags
&= ~MMAN_spc
;
1290 if (MDOC_SYNPRETTY
& n
->flags
) {
1291 outflags
&= ~MMAN_spc
;
1294 outflags
|= MMAN_br
;
1297 outflags
&= ~MMAN_spc
;
1305 const struct mdoc_node
*bln
;
1309 outflags
|= MMAN_PP
| MMAN_nl
;
1310 bln
= n
->parent
->parent
;
1311 if (0 == bln
->norm
->Bl
.comp
||
1312 (NULL
== n
->parent
->prev
&&
1313 NULL
== bln
->parent
->prev
))
1314 outflags
|= MMAN_sp
;
1315 outflags
&= ~MMAN_br
;
1316 switch (bln
->norm
->Bl
.type
) {
1324 if (bln
->norm
->Bl
.type
== LIST_diag
)
1325 print_line(".B \"", 0);
1327 print_line(".R \"", 0);
1328 outflags
&= ~MMAN_spc
;
1335 print_width(bln
->norm
->Bl
.width
, NULL
, 0);
1337 outflags
|= MMAN_nl
;
1339 if (LIST_bullet
== bln
->norm
->Bl
.type
)
1344 outflags
|= MMAN_nl
;
1347 print_width(bln
->norm
->Bl
.width
, NULL
, 0);
1349 outflags
|= MMAN_nl
;
1350 print_count(&bln
->norm
->Bl
.count
);
1351 outflags
|= MMAN_nl
;
1354 print_width(bln
->norm
->Bl
.width
, n
->child
, 6);
1356 outflags
|= MMAN_nl
;
1359 print_width(bln
->norm
->Bl
.width
, n
->child
, 0);
1361 outflags
&= ~MMAN_spc
;
1373 * This function is called after closing out an indented block.
1374 * If we are inside an enclosing list, restore its indentation.
1381 /* Nothing to do outside a list. */
1382 if (0 == Bl_stack_len
|| 0 == Bl_stack
[Bl_stack_len
- 1])
1385 /* The indentation has already been set up. */
1386 if (Bl_stack_post
[Bl_stack_len
- 1])
1389 /* Restore the indentation of the enclosing list. */
1390 print_line(".RS", MMAN_Bk_susp
);
1391 (void)snprintf(buf
, sizeof(buf
), "%zun",
1392 Bl_stack
[Bl_stack_len
- 1]);
1395 /* Remeber to close out this .RS block later. */
1396 Bl_stack_post
[Bl_stack_len
- 1] = 1;
1402 const struct mdoc_node
*bln
;
1404 bln
= n
->parent
->parent
;
1408 switch (bln
->norm
->Bl
.type
) {
1410 outflags
&= ~MMAN_spc
;
1414 outflags
|= MMAN_br
;
1421 switch (bln
->norm
->Bl
.type
) {
1433 assert(Bl_stack_len
);
1434 Bl_stack
[--Bl_stack_len
] = 0;
1437 * Our indentation had to be restored
1438 * after a child display or child list.
1439 * Close out that indentation block now.
1441 if (Bl_stack_post
[Bl_stack_len
]) {
1442 print_line(".RE", MMAN_nl
);
1443 Bl_stack_post
[Bl_stack_len
] = 0;
1447 if (NULL
!= n
->next
) {
1449 outflags
&= ~MMAN_spc
;
1465 if (SEC_LIBRARY
== n
->sec
)
1466 outflags
|= MMAN_br
;
1472 const struct mdoc_node
*link
, *descr
;
1474 if (NULL
== (link
= n
->child
))
1477 if (NULL
!= (descr
= link
->next
)) {
1479 while (NULL
!= descr
) {
1480 print_word(descr
->string
);
1481 descr
= descr
->next
;
1488 print_word(link
->string
);
1497 print_line(".ll", 0);
1514 if (MDOC_BLOCK
== n
->type
) {
1515 outflags
|= MMAN_Bk
;
1518 if (MDOC_ELEM
!= n
->type
&& MDOC_HEAD
!= n
->type
)
1520 name
= n
->child
? n
->child
->string
: meta
->name
;
1523 if (MDOC_HEAD
== n
->type
) {
1524 if (NULL
== n
->parent
->prev
)
1525 outflags
|= MMAN_sp
;
1526 print_block(".HP", 0);
1527 printf(" %zun", strlen(name
) + 1);
1528 outflags
|= MMAN_nl
;
1531 if (NULL
== n
->child
)
1532 print_word(meta
->name
);
1542 outflags
&= ~MMAN_Bk
;
1547 if (n
->child
!= NULL
|| meta
->name
!= NULL
)
1559 outflags
|= MMAN_spc_force
;
1567 outflags
&= ~MMAN_spc
;
1575 outflags
&= ~MMAN_spc
;
1582 if (MDOC_It
!= n
->parent
->tok
)
1583 outflags
|= MMAN_PP
;
1584 outflags
|= MMAN_sp
| MMAN_nl
;
1585 outflags
&= ~MMAN_br
;
1593 if (SEC_SEE_ALSO
== n
->sec
) {
1594 outflags
|= MMAN_PP
| MMAN_sp
| MMAN_nl
;
1595 outflags
&= ~MMAN_br
;
1605 outflags
|= MMAN_br
| MMAN_nl
;
1611 for (n
= n
->child
; n
; n
= n
->next
) {
1613 print_word(n
->string
);
1616 outflags
&= ~MMAN_spc
;
1619 if (n
->next
== NULL
)
1623 outflags
&= ~MMAN_spc
;
1626 if (n
->next
->next
== NULL
)
1631 print_word("functions return");
1633 print_word("function returns");
1635 print_word("the value\\~0 if successful;");
1637 print_word("Upon successful completion, "
1638 "the value\\~0 is returned;");
1640 print_word("otherwise the value\\~\\-1 is returned"
1641 " and the global variable");
1644 print_word("errno");
1647 print_word("is set to indicate the error.");
1648 outflags
|= MMAN_nl
;
1656 if (NULL
== n
->child
)
1657 outflags
^= MMAN_Sm
;
1658 else if (0 == strcmp("on", n
->child
->string
))
1659 outflags
|= MMAN_Sm
;
1661 outflags
&= ~MMAN_Sm
;
1663 if (MMAN_Sm
& outflags
)
1664 outflags
|= MMAN_spc
;
1673 if (MMAN_PP
& outflags
) {
1674 outflags
&= ~MMAN_PP
;
1675 print_line(".PP", 0);
1677 print_line(".sp", 0);
1685 outflags
|= MMAN_nl
;
1700 if (MDOC_SYNPRETTY
& n
->flags
) {
1719 if (MDOC_SYNPRETTY
& n
->flags
&& MDOC_BODY
!= n
->type
)
1731 print_node(meta
, n
);
1735 outflags
&= ~MMAN_spc
;
1737 print_node(meta
, n
);
1746 print_word(manacts
[n
->tok
].prefix
);
1747 if (NULL
== n
->child
)
1749 outflags
&= ~MMAN_spc
;
1751 outflags
&= ~MMAN_spc
;