1 /* $Id: mdoc_man.c,v 1.136 2020/02/27 01:43:52 schwarze Exp $ */
3 * Copyright (c) 2011-2020 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.
19 #include <sys/types.h>
26 #include "mandoc_aux.h"
34 #define DECL_ARGS const struct roff_meta *meta, struct roff_node *n
36 typedef int (*int_fp
)(DECL_ARGS
);
37 typedef void (*void_fp
)(DECL_ARGS
);
40 int_fp cond
; /* DON'T run actions */
41 int_fp pre
; /* pre-node action */
42 void_fp post
; /* post-node action */
43 const char *prefix
; /* pre-node string constant */
44 const char *suffix
; /* post-node string constant */
47 static int cond_body(DECL_ARGS
);
48 static int cond_head(DECL_ARGS
);
49 static void font_push(char);
50 static void font_pop(void);
51 static int man_strlen(const char *);
52 static void mid_it(void);
53 static void post__t(DECL_ARGS
);
54 static void post_aq(DECL_ARGS
);
55 static void post_bd(DECL_ARGS
);
56 static void post_bf(DECL_ARGS
);
57 static void post_bk(DECL_ARGS
);
58 static void post_bl(DECL_ARGS
);
59 static void post_dl(DECL_ARGS
);
60 static void post_en(DECL_ARGS
);
61 static void post_enc(DECL_ARGS
);
62 static void post_eo(DECL_ARGS
);
63 static void post_fa(DECL_ARGS
);
64 static void post_fd(DECL_ARGS
);
65 static void post_fl(DECL_ARGS
);
66 static void post_fn(DECL_ARGS
);
67 static void post_fo(DECL_ARGS
);
68 static void post_font(DECL_ARGS
);
69 static void post_in(DECL_ARGS
);
70 static void post_it(DECL_ARGS
);
71 static void post_lb(DECL_ARGS
);
72 static void post_nm(DECL_ARGS
);
73 static void post_percent(DECL_ARGS
);
74 static void post_pf(DECL_ARGS
);
75 static void post_sect(DECL_ARGS
);
76 static void post_vt(DECL_ARGS
);
77 static int pre__t(DECL_ARGS
);
78 static int pre_abort(DECL_ARGS
);
79 static int pre_an(DECL_ARGS
);
80 static int pre_ap(DECL_ARGS
);
81 static int pre_aq(DECL_ARGS
);
82 static int pre_bd(DECL_ARGS
);
83 static int pre_bf(DECL_ARGS
);
84 static int pre_bk(DECL_ARGS
);
85 static int pre_bl(DECL_ARGS
);
86 static void pre_br(DECL_ARGS
);
87 static int pre_dl(DECL_ARGS
);
88 static int pre_en(DECL_ARGS
);
89 static int pre_enc(DECL_ARGS
);
90 static int pre_em(DECL_ARGS
);
91 static int pre_skip(DECL_ARGS
);
92 static int pre_eo(DECL_ARGS
);
93 static int pre_ex(DECL_ARGS
);
94 static int pre_fa(DECL_ARGS
);
95 static int pre_fd(DECL_ARGS
);
96 static int pre_fl(DECL_ARGS
);
97 static int pre_fn(DECL_ARGS
);
98 static int pre_fo(DECL_ARGS
);
99 static void pre_ft(DECL_ARGS
);
100 static int pre_Ft(DECL_ARGS
);
101 static int pre_in(DECL_ARGS
);
102 static int pre_it(DECL_ARGS
);
103 static int pre_lk(DECL_ARGS
);
104 static int pre_li(DECL_ARGS
);
105 static int pre_nm(DECL_ARGS
);
106 static int pre_no(DECL_ARGS
);
107 static void pre_noarg(DECL_ARGS
);
108 static int pre_ns(DECL_ARGS
);
109 static void pre_onearg(DECL_ARGS
);
110 static int pre_pp(DECL_ARGS
);
111 static int pre_rs(DECL_ARGS
);
112 static int pre_sm(DECL_ARGS
);
113 static void pre_sp(DECL_ARGS
);
114 static int pre_sect(DECL_ARGS
);
115 static int pre_sy(DECL_ARGS
);
116 static void pre_syn(struct roff_node
*);
117 static void pre_ta(DECL_ARGS
);
118 static int pre_vt(DECL_ARGS
);
119 static int pre_xr(DECL_ARGS
);
120 static void print_word(const char *);
121 static void print_line(const char *, int);
122 static void print_block(const char *, int);
123 static void print_offs(const char *, int);
124 static void print_width(const struct mdoc_bl
*,
125 const struct roff_node
*);
126 static void print_count(int *);
127 static void print_node(DECL_ARGS
);
129 static const void_fp roff_man_acts
[ROFF_MAX
] = {
144 static const struct mdoc_man_act mdoc_man_acts
[MDOC_MAX
- MDOC_Dd
] = {
145 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dd */
146 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dt */
147 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Os */
148 { NULL
, pre_sect
, post_sect
, ".SH", NULL
}, /* Sh */
149 { NULL
, pre_sect
, post_sect
, ".SS", NULL
}, /* Ss */
150 { NULL
, pre_pp
, NULL
, NULL
, NULL
}, /* Pp */
151 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* D1 */
152 { cond_body
, pre_dl
, post_dl
, NULL
, NULL
}, /* Dl */
153 { cond_body
, pre_bd
, post_bd
, NULL
, NULL
}, /* Bd */
154 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ed */
155 { cond_body
, pre_bl
, post_bl
, NULL
, NULL
}, /* Bl */
156 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* El */
157 { NULL
, pre_it
, post_it
, NULL
, NULL
}, /* It */
158 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ad */
159 { NULL
, pre_an
, NULL
, NULL
, NULL
}, /* An */
160 { NULL
, pre_ap
, NULL
, NULL
, NULL
}, /* Ap */
161 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Ar */
162 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cd */
163 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Cm */
164 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Dv */
165 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Er */
166 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Ev */
167 { NULL
, pre_ex
, NULL
, NULL
, NULL
}, /* Ex */
168 { NULL
, pre_fa
, post_fa
, NULL
, NULL
}, /* Fa */
169 { NULL
, pre_fd
, post_fd
, NULL
, NULL
}, /* Fd */
170 { NULL
, pre_fl
, post_fl
, NULL
, NULL
}, /* Fl */
171 { NULL
, pre_fn
, post_fn
, NULL
, NULL
}, /* Fn */
172 { NULL
, pre_Ft
, post_font
, NULL
, NULL
}, /* Ft */
173 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Ic */
174 { NULL
, pre_in
, post_in
, NULL
, NULL
}, /* In */
175 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Li */
176 { cond_head
, pre_enc
, NULL
, "\\- ", NULL
}, /* Nd */
177 { NULL
, pre_nm
, post_nm
, NULL
, NULL
}, /* Nm */
178 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Op */
179 { NULL
, pre_abort
, NULL
, NULL
, NULL
}, /* Ot */
180 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Pa */
181 { NULL
, pre_ex
, NULL
, NULL
, NULL
}, /* Rv */
182 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* St */
183 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Va */
184 { NULL
, pre_vt
, post_vt
, NULL
, NULL
}, /* Vt */
185 { NULL
, pre_xr
, NULL
, NULL
, NULL
}, /* Xr */
186 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %A */
187 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %B */
188 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %D */
189 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %I */
190 { NULL
, pre_em
, post_percent
, NULL
, NULL
}, /* %J */
191 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %N */
192 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %O */
193 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %P */
194 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %R */
195 { NULL
, pre__t
, post__t
, NULL
, NULL
}, /* %T */
196 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %V */
197 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ac */
198 { cond_body
, pre_aq
, post_aq
, NULL
, NULL
}, /* Ao */
199 { cond_body
, pre_aq
, post_aq
, NULL
, NULL
}, /* Aq */
200 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* At */
201 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bc */
202 { NULL
, pre_bf
, post_bf
, NULL
, NULL
}, /* Bf */
203 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Bo */
204 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Bq */
205 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Bsx */
206 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Bx */
207 { NULL
, pre_skip
, NULL
, NULL
, NULL
}, /* Db */
208 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dc */
209 { cond_body
, pre_enc
, post_enc
, "\\(lq", "\\(rq" }, /* Do */
210 { cond_body
, pre_enc
, post_enc
, "\\(lq", "\\(rq" }, /* Dq */
211 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ec */
212 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ef */
213 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Em */
214 { cond_body
, pre_eo
, post_eo
, NULL
, NULL
}, /* Eo */
215 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Fx */
216 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Ms */
217 { NULL
, pre_no
, NULL
, NULL
, NULL
}, /* No */
218 { NULL
, pre_ns
, NULL
, NULL
, NULL
}, /* Ns */
219 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Nx */
220 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Ox */
221 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Pc */
222 { NULL
, NULL
, post_pf
, NULL
, NULL
}, /* Pf */
223 { cond_body
, pre_enc
, post_enc
, "(", ")" }, /* Po */
224 { cond_body
, pre_enc
, post_enc
, "(", ")" }, /* Pq */
225 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Qc */
226 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* Ql */
227 { cond_body
, pre_enc
, post_enc
, "\"", "\"" }, /* Qo */
228 { cond_body
, pre_enc
, post_enc
, "\"", "\"" }, /* Qq */
229 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Re */
230 { cond_body
, pre_rs
, NULL
, NULL
, NULL
}, /* Rs */
231 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Sc */
232 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* So */
233 { cond_body
, pre_enc
, post_enc
, "\\(oq", "\\(cq" }, /* Sq */
234 { NULL
, pre_sm
, NULL
, NULL
, NULL
}, /* Sm */
235 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Sx */
236 { NULL
, pre_sy
, post_font
, NULL
, NULL
}, /* Sy */
237 { NULL
, pre_li
, post_font
, NULL
, NULL
}, /* Tn */
238 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ux */
239 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xc */
240 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xo */
241 { NULL
, pre_fo
, post_fo
, NULL
, NULL
}, /* Fo */
242 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Fc */
243 { cond_body
, pre_enc
, post_enc
, "[", "]" }, /* Oo */
244 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Oc */
245 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Bk */
246 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ek */
247 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bt */
248 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Hf */
249 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Fr */
250 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ud */
251 { NULL
, NULL
, post_lb
, NULL
, NULL
}, /* Lb */
252 { NULL
, pre_abort
, NULL
, NULL
, NULL
}, /* Lp */
253 { NULL
, pre_lk
, NULL
, NULL
, NULL
}, /* Lk */
254 { NULL
, pre_em
, post_font
, NULL
, NULL
}, /* Mt */
255 { cond_body
, pre_enc
, post_enc
, "{", "}" }, /* Brq */
256 { cond_body
, pre_enc
, post_enc
, "{", "}" }, /* Bro */
257 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Brc */
258 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %C */
259 { NULL
, pre_skip
, NULL
, NULL
, NULL
}, /* Es */
260 { cond_body
, pre_en
, post_en
, NULL
, NULL
}, /* En */
261 { NULL
, pre_bk
, post_bk
, NULL
, NULL
}, /* Dx */
262 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %Q */
263 { NULL
, NULL
, post_percent
, NULL
, NULL
}, /* %U */
264 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ta */
265 { NULL
, pre_skip
, NULL
, NULL
, NULL
}, /* Tg */
267 static const struct mdoc_man_act
*mdoc_man_act(enum roff_tok
);
270 #define MMAN_spc (1 << 0) /* blank character before next word */
271 #define MMAN_spc_force (1 << 1) /* even before trailing punctuation */
272 #define MMAN_nl (1 << 2) /* break man(7) code line */
273 #define MMAN_br (1 << 3) /* break output line */
274 #define MMAN_sp (1 << 4) /* insert a blank output line */
275 #define MMAN_PP (1 << 5) /* reset indentation etc. */
276 #define MMAN_Sm (1 << 6) /* horizontal spacing mode */
277 #define MMAN_Bk (1 << 7) /* word keep mode */
278 #define MMAN_Bk_susp (1 << 8) /* suspend this (after a macro) */
279 #define MMAN_An_split (1 << 9) /* author mode is "split" */
280 #define MMAN_An_nosplit (1 << 10) /* author mode is "nosplit" */
281 #define MMAN_PD (1 << 11) /* inter-paragraph spacing disabled */
282 #define MMAN_nbrword (1 << 12) /* do not break the next word */
284 #define BL_STACK_MAX 32
286 static int Bl_stack
[BL_STACK_MAX
]; /* offsets [chars] */
287 static int Bl_stack_post
[BL_STACK_MAX
]; /* add final .RE */
288 static int Bl_stack_len
; /* number of nested Bl blocks */
289 static int TPremain
; /* characters before tag is full */
298 static const struct mdoc_man_act
*
299 mdoc_man_act(enum roff_tok tok
)
301 assert(tok
>= MDOC_Dd
&& tok
<= MDOC_MAX
);
302 return mdoc_man_acts
+ (tok
- MDOC_Dd
);
306 man_strlen(const char *cp
)
314 rsz
= strcspn(cp
, "\\");
326 switch (mandoc_escape(&cp
, NULL
, NULL
)) {
330 case ESCAPE_NUMBERED
:
333 case ESCAPE_OVERSTRIKE
:
339 case ESCAPE_SKIPCHAR
:
350 font_push(char newfont
)
353 if (fontqueue
.head
+ fontqueue
.size
<= ++fontqueue
.tail
) {
355 fontqueue
.head
= mandoc_realloc(fontqueue
.head
,
358 *fontqueue
.tail
= newfont
;
362 outflags
&= ~MMAN_spc
;
369 if (fontqueue
.tail
> fontqueue
.head
)
371 outflags
&= ~MMAN_spc
;
374 putchar(*fontqueue
.tail
);
378 print_word(const char *s
)
381 if ((MMAN_PP
| MMAN_sp
| MMAN_br
| MMAN_nl
) & outflags
) {
383 * If we need a newline, print it now and start afresh.
385 if (MMAN_PP
& outflags
) {
386 if (MMAN_sp
& outflags
) {
387 if (MMAN_PD
& outflags
) {
389 outflags
&= ~MMAN_PD
;
391 } else if ( ! (MMAN_PD
& outflags
)) {
396 } else if (MMAN_sp
& outflags
)
398 else if (MMAN_br
& outflags
)
400 else if (MMAN_nl
& outflags
)
402 outflags
&= ~(MMAN_PP
|MMAN_sp
|MMAN_br
|MMAN_nl
|MMAN_spc
);
406 } else if (MMAN_spc
& outflags
) {
408 * If we need a space, only print it if
409 * (1) it is forced by `No' or
410 * (2) what follows is not terminating punctuation or
411 * (3) what follows is longer than one character.
413 if (MMAN_spc_force
& outflags
|| '\0' == s
[0] ||
414 NULL
== strchr(".,:;)]?!", s
[0]) || '\0' != s
[1]) {
415 if (MMAN_Bk
& outflags
&&
416 ! (MMAN_Bk_susp
& outflags
))
425 * Reassign needing space if we're not following opening
428 if (MMAN_Sm
& outflags
&& ('\0' == s
[0] ||
429 (('(' != s
[0] && '[' != s
[0]) || '\0' != s
[1])))
430 outflags
|= MMAN_spc
;
432 outflags
&= ~MMAN_spc
;
433 outflags
&= ~(MMAN_spc_force
| MMAN_Bk_susp
);
447 if (MMAN_nbrword
& outflags
) {
453 putchar((unsigned char)*s
);
459 outflags
&= ~MMAN_nbrword
;
463 print_line(const char *s
, int newflags
)
468 outflags
|= newflags
;
472 print_block(const char *s
, int newflags
)
475 outflags
&= ~MMAN_PP
;
476 if (MMAN_sp
& outflags
) {
477 outflags
&= ~(MMAN_sp
| MMAN_br
);
478 if (MMAN_PD
& outflags
) {
479 print_line(".PD", 0);
480 outflags
&= ~MMAN_PD
;
482 } else if (! (MMAN_PD
& outflags
))
483 print_line(".PD 0", MMAN_PD
);
486 outflags
|= MMAN_Bk_susp
| newflags
;
490 print_offs(const char *v
, int keywords
)
497 print_line(".RS", MMAN_Bk_susp
);
499 /* Convert v into a number (of characters). */
500 if (NULL
== v
|| '\0' == *v
|| (keywords
&& !strcmp(v
, "left")))
502 else if (keywords
&& !strcmp(v
, "indent"))
504 else if (keywords
&& !strcmp(v
, "indent-two"))
507 end
= a2roffsu(v
, &su
, SCALE_EN
);
508 if (end
== NULL
|| *end
!= '\0')
510 else if (SCALE_EN
== su
.unit
)
515 * If we are inside an enclosing list,
516 * there is no easy way to add the two
517 * indentations because they are provided
518 * in terms of different units.
527 * We are inside an enclosing list.
528 * Add the two indentations.
531 sz
+= Bl_stack
[Bl_stack_len
- 1];
533 (void)snprintf(buf
, sizeof(buf
), "%dn", sz
);
539 * Set up the indentation for a list item; used from pre_it().
542 print_width(const struct mdoc_bl
*bl
, const struct roff_node
*child
)
547 int numeric
, remain
, sz
, chsz
;
552 /* Convert the width into a number (of characters). */
553 if (bl
->width
== NULL
)
554 sz
= (bl
->type
== LIST_hang
) ? 6 : 0;
556 end
= a2roffsu(bl
->width
, &su
, SCALE_MAX
);
557 if (end
== NULL
|| *end
!= '\0')
558 sz
= man_strlen(bl
->width
);
559 else if (SCALE_EN
== su
.unit
)
567 /* XXX Rough estimation, might have multiple parts. */
568 if (bl
->type
== LIST_enum
)
569 chsz
= (bl
->count
> 8) + 1;
570 else if (child
!= NULL
&& child
->type
== ROFFT_TEXT
)
571 chsz
= man_strlen(child
->string
);
575 /* Maybe we are inside an enclosing list? */
579 * Save our own indentation,
580 * such that child lists can use it.
582 Bl_stack
[Bl_stack_len
++] = sz
+ 2;
584 /* Set up the current list. */
585 if (chsz
> sz
&& bl
->type
!= LIST_tag
)
586 print_block(".HP", MMAN_spc
);
588 print_block(".TP", MMAN_spc
);
592 (void)snprintf(buf
, sizeof(buf
), "%dn", sz
+ 2);
595 print_word(bl
->width
);
600 print_count(int *count
)
604 (void)snprintf(buf
, sizeof(buf
), "%d.\\&", ++*count
);
609 man_mdoc(void *arg
, const struct roff_meta
*mdoc
)
613 printf(".\\\" Automatically generated from an mdoc input file."
615 for (n
= mdoc
->first
->child
; n
!= NULL
; n
= n
->next
) {
616 if (n
->type
!= ROFFT_COMMENT
)
618 printf(".\\\"%s\n", n
->string
);
621 printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
622 mdoc
->title
, (mdoc
->msec
== NULL
? "" : mdoc
->msec
),
623 mdoc
->date
, mdoc
->os
, mdoc
->vol
);
625 /* Disable hyphenation and if nroff, disable justification. */
626 printf(".nh\n.if n .ad l");
628 outflags
= MMAN_nl
| MMAN_Sm
;
629 if (0 == fontqueue
.size
) {
631 fontqueue
.head
= fontqueue
.tail
= mandoc_malloc(8);
632 *fontqueue
.tail
= 'R';
634 for (; n
!= NULL
; n
= n
->next
)
640 print_node(DECL_ARGS
)
642 const struct mdoc_man_act
*act
;
643 struct roff_node
*sub
;
646 if (n
->flags
& NODE_NOPRT
)
650 * Break the line if we were parsed subsequent the current node.
651 * This makes the page structure be more consistent.
653 if (outflags
& MMAN_spc
&&
654 n
->flags
& NODE_LINE
&&
655 !roff_node_transparent(n
))
661 n
->flags
&= ~NODE_ENDED
;
663 if (n
->type
== ROFFT_TEXT
) {
665 * Make sure that we don't happen to start with a
666 * control character at the start of a line.
668 if (MMAN_nl
& outflags
&&
669 ('.' == *n
->string
|| '\'' == *n
->string
)) {
672 outflags
&= ~MMAN_spc
;
674 if (n
->flags
& NODE_DELIMC
)
675 outflags
&= ~(MMAN_spc
| MMAN_spc_force
);
676 else if (outflags
& MMAN_Sm
)
677 outflags
|= MMAN_spc_force
;
678 print_word(n
->string
);
679 if (n
->flags
& NODE_DELIMO
)
680 outflags
&= ~(MMAN_spc
| MMAN_spc_force
);
681 else if (outflags
& MMAN_Sm
)
682 outflags
|= MMAN_spc
;
683 } else if (n
->tok
< ROFF_MAX
) {
684 (*roff_man_acts
[n
->tok
])(meta
, n
);
688 * Conditionally run the pre-node action handler for a
691 act
= mdoc_man_act(n
->tok
);
692 cond
= act
->cond
== NULL
|| (*act
->cond
)(meta
, n
);
693 if (cond
&& act
->pre
!= NULL
&&
694 (n
->end
== ENDBODY_NOT
|| n
->child
!= NULL
))
695 do_sub
= (*act
->pre
)(meta
, n
);
699 * Conditionally run all child nodes.
700 * Note that this iterates over children instead of using
701 * recursion. This prevents unnecessary depth in the stack.
704 for (sub
= n
->child
; sub
; sub
= sub
->next
)
705 print_node(meta
, sub
);
708 * Lastly, conditionally run the post-node handler.
710 if (NODE_ENDED
& n
->flags
)
713 if (cond
&& act
->post
)
714 (*act
->post
)(meta
, n
);
716 if (ENDBODY_NOT
!= n
->end
)
717 n
->body
->flags
|= NODE_ENDED
;
724 return n
->type
== ROFFT_HEAD
;
731 return n
->type
== ROFFT_BODY
;
745 prefix
= mdoc_man_act(n
->tok
)->prefix
;
749 outflags
&= ~MMAN_spc
;
758 suffix
= mdoc_man_act(n
->tok
)->suffix
;
761 outflags
&= ~(MMAN_spc
| MMAN_nl
);
768 outflags
|= MMAN_br
| MMAN_nl
;
780 post_percent(DECL_ARGS
)
782 struct roff_node
*np
, *nn
, *nnn
;
784 if (mdoc_man_act(n
->tok
)->pre
== pre_em
)
787 if ((nn
= roff_node_next(n
)) != NULL
) {
788 np
= roff_node_prev(n
);
789 nnn
= nn
== NULL
? NULL
: roff_node_next(nn
);
790 if (nn
->tok
!= n
->tok
||
791 (np
!= NULL
&& np
->tok
== n
->tok
) ||
792 (nnn
!= NULL
&& nnn
->tok
== n
->tok
))
794 if (nn
->tok
== n
->tok
&&
795 (nnn
== NULL
|| nnn
->tok
!= n
->tok
))
807 if (n
->parent
->tok
== MDOC_Rs
&& n
->parent
->norm
->Rs
.quote_T
) {
809 outflags
&= ~MMAN_spc
;
819 if (n
->parent
->tok
== MDOC_Rs
&& n
->parent
->norm
->Rs
.quote_T
) {
820 outflags
&= ~MMAN_spc
;
824 post_percent(meta
, n
);
828 * Print before a section header.
834 if (n
->type
== ROFFT_HEAD
) {
836 print_block(mdoc_man_act(n
->tok
)->prefix
, 0);
839 outflags
&= ~MMAN_spc
;
845 * Print subsequent a section header.
851 if (n
->type
!= ROFFT_HEAD
)
853 outflags
&= ~MMAN_spc
;
857 if (MDOC_Sh
== n
->tok
&& SEC_AUTHORS
== n
->sec
)
858 outflags
&= ~(MMAN_An_split
| MMAN_An_nosplit
);
861 /* See mdoc_term.c, synopsis_pre() for comments. */
863 pre_syn(struct roff_node
*n
)
865 struct roff_node
*np
;
867 if ((n
->flags
& NODE_SYNPRETTY
) == 0 ||
868 (np
= roff_node_prev(n
)) == NULL
)
871 if (np
->tok
== n
->tok
&&
888 if (MDOC_Fn
!= n
->tok
&& MDOC_Fo
!= n
->tok
) {
903 switch (n
->norm
->An
.auth
) {
905 outflags
&= ~MMAN_An_nosplit
;
906 outflags
|= MMAN_An_split
;
909 outflags
&= ~MMAN_An_split
;
910 outflags
|= MMAN_An_nosplit
;
913 if (MMAN_An_split
& outflags
)
915 else if (SEC_AUTHORS
== n
->sec
&&
916 ! (MMAN_An_nosplit
& outflags
))
917 outflags
|= MMAN_An_split
;
926 outflags
&= ~MMAN_spc
;
928 outflags
&= ~MMAN_spc
;
936 print_word(n
->child
!= NULL
&& n
->child
->next
== NULL
&&
937 n
->child
->tok
== MDOC_Mt
? "<" : "\\(la");
938 outflags
&= ~MMAN_spc
;
946 outflags
&= ~(MMAN_spc
| MMAN_nl
);
947 print_word(n
->child
!= NULL
&& n
->child
->next
== NULL
&&
948 n
->child
->tok
== MDOC_Mt
? ">" : "\\(ra");
954 outflags
&= ~(MMAN_PP
| MMAN_sp
| MMAN_br
);
955 if (n
->norm
->Bd
.type
== DISP_unfilled
||
956 n
->norm
->Bd
.type
== DISP_literal
)
957 print_line(".nf", 0);
958 if (n
->norm
->Bd
.comp
== 0 && roff_node_prev(n
->parent
) != NULL
)
960 print_offs(n
->norm
->Bd
.offs
, 1);
967 enum roff_tok bef
, now
;
969 /* Close out this display. */
970 print_line(".RE", MMAN_nl
);
971 bef
= n
->flags
& NODE_NOFILL
? ROFF_nf
: ROFF_fi
;
973 now
= n
->norm
->Bd
.type
== DISP_unfilled
||
974 n
->norm
->Bd
.type
== DISP_literal
? ROFF_nf
: ROFF_fi
;
975 else if (n
->last
->tok
== ROFF_nf
)
977 else if (n
->last
->tok
== ROFF_fi
)
980 now
= n
->last
->flags
& NODE_NOFILL
? ROFF_nf
: ROFF_fi
;
984 outflags
&= ~MMAN_spc
;
985 print_word(roff_name
[bef
]);
989 /* Maybe we are inside an enclosing list? */
990 if (roff_node_next(n
->parent
) != NULL
)
1006 switch (n
->norm
->Bf
.font
) {
1024 if (n
->type
== ROFFT_BODY
)
1036 outflags
|= MMAN_Bk
;
1048 while ((n
= n
->parent
) != NULL
)
1049 if (n
->tok
== MDOC_Bk
)
1053 outflags
&= ~MMAN_Bk
;
1066 * print_offs() will increase the -offset to account for
1067 * a possible enclosing .It, but any enclosed .It blocks
1068 * just nest and do not add up their indentation.
1070 if (n
->norm
->Bl
.offs
) {
1071 print_offs(n
->norm
->Bl
.offs
, 0);
1072 Bl_stack
[Bl_stack_len
++] = 0;
1075 switch (n
->norm
->Bl
.type
) {
1077 n
->norm
->Bl
.count
= 0;
1085 if (n
->child
!= NULL
) {
1086 print_line(".TS", MMAN_nl
);
1087 for (icol
= 0; icol
< n
->norm
->Bl
.ncols
; icol
++)
1091 outflags
|= MMAN_nl
;
1099 switch (n
->norm
->Bl
.type
) {
1101 if (n
->child
!= NULL
)
1102 print_line(".TE", 0);
1105 n
->norm
->Bl
.count
= 0;
1111 if (n
->norm
->Bl
.offs
) {
1112 print_line(".RE", MMAN_nl
);
1113 assert(Bl_stack_len
);
1115 assert(Bl_stack
[Bl_stack_len
] == 0);
1117 outflags
|= MMAN_PP
| MMAN_nl
;
1118 outflags
&= ~(MMAN_sp
| MMAN_br
);
1121 /* Maybe we are inside an enclosing list? */
1122 if (roff_node_next(n
->parent
) != NULL
)
1129 outflags
|= MMAN_br
;
1135 print_offs("6n", 0);
1142 print_line(".RE", MMAN_nl
);
1144 /* Maybe we are inside an enclosing list? */
1145 if (roff_node_next(n
->parent
) != NULL
)
1161 if (NULL
== n
->norm
->Es
||
1162 NULL
== n
->norm
->Es
->child
)
1165 print_word(n
->norm
->Es
->child
->string
);
1166 outflags
&= ~MMAN_spc
;
1174 if (NULL
== n
->norm
->Es
||
1175 NULL
== n
->norm
->Es
->child
||
1176 NULL
== n
->norm
->Es
->child
->next
)
1179 outflags
&= ~MMAN_spc
;
1180 print_word(n
->norm
->Es
->child
->next
->string
);
1188 if (n
->end
== ENDBODY_NOT
&&
1189 n
->parent
->head
->child
== NULL
&&
1191 n
->child
->end
!= ENDBODY_NOT
)
1193 else if (n
->end
!= ENDBODY_NOT
? n
->child
!= NULL
:
1194 n
->parent
->head
->child
!= NULL
&& (n
->child
!= NULL
||
1195 (n
->parent
->tail
!= NULL
&& n
->parent
->tail
->child
!= NULL
)))
1196 outflags
&= ~(MMAN_spc
| MMAN_nl
);
1205 if (n
->end
!= ENDBODY_NOT
) {
1206 outflags
|= MMAN_spc
;
1210 body
= n
->child
!= NULL
|| n
->parent
->head
->child
!= NULL
;
1211 tail
= n
->parent
->tail
!= NULL
&& n
->parent
->tail
->child
!= NULL
;
1214 outflags
&= ~MMAN_spc
;
1215 else if ( ! (body
|| tail
))
1218 outflags
|= MMAN_spc
;
1226 am_Fa
= MDOC_Fa
== n
->tok
;
1233 if (am_Fa
|| NODE_SYNPRETTY
& n
->flags
)
1234 outflags
|= MMAN_nbrword
;
1235 print_node(meta
, n
);
1237 if (NULL
!= (n
= n
->next
))
1246 struct roff_node
*nn
;
1248 if ((nn
= roff_node_next(n
)) != NULL
&& nn
->tok
== MDOC_Fa
)
1264 outflags
|= MMAN_br
;
1272 if (n
->child
!= NULL
)
1273 outflags
&= ~MMAN_spc
;
1280 struct roff_node
*nn
;
1283 if (n
->child
== NULL
&&
1284 ((nn
= roff_node_next(n
)) != NULL
&&
1285 nn
->type
!= ROFFT_TEXT
&&
1286 (nn
->flags
& NODE_LINE
) == 0))
1287 outflags
&= ~MMAN_spc
;
1300 if (NODE_SYNPRETTY
& n
->flags
)
1301 print_block(".HP 4n", MMAN_nl
);
1304 print_node(meta
, n
);
1306 outflags
&= ~MMAN_spc
;
1308 outflags
&= ~MMAN_spc
;
1321 if (NODE_SYNPRETTY
& n
->flags
) {
1323 outflags
|= MMAN_PP
;
1336 if (n
->child
== NULL
)
1338 if (NODE_SYNPRETTY
& n
->flags
)
1339 print_block(".HP 4n", MMAN_nl
);
1343 outflags
&= ~(MMAN_spc
| MMAN_nl
);
1345 outflags
&= ~MMAN_spc
;
1359 if (n
->child
!= NULL
)
1382 print_line(".ft", 0);
1383 print_word(n
->child
->string
);
1384 outflags
|= MMAN_nl
;
1391 if (NODE_SYNPRETTY
& n
->flags
) {
1394 print_word("#include <");
1395 outflags
&= ~MMAN_spc
;
1398 outflags
&= ~MMAN_spc
;
1408 if (NODE_SYNPRETTY
& n
->flags
) {
1409 outflags
&= ~MMAN_spc
;
1412 outflags
|= MMAN_br
;
1415 outflags
&= ~MMAN_spc
;
1423 const struct roff_node
*bln
;
1427 outflags
|= MMAN_PP
| MMAN_nl
;
1428 bln
= n
->parent
->parent
;
1429 if (bln
->norm
->Bl
.comp
== 0 ||
1430 (n
->parent
->prev
== NULL
&&
1431 roff_node_prev(bln
->parent
) == NULL
))
1432 outflags
|= MMAN_sp
;
1433 outflags
&= ~MMAN_br
;
1434 switch (bln
->norm
->Bl
.type
) {
1440 if (bln
->norm
->Bl
.type
== LIST_diag
)
1441 print_line(".B \"", 0);
1443 print_line(".BR \\& \"", 0);
1444 outflags
&= ~MMAN_spc
;
1449 print_width(&bln
->norm
->Bl
, NULL
);
1451 outflags
|= MMAN_nl
;
1453 if (LIST_bullet
== bln
->norm
->Bl
.type
)
1454 print_word("\\(bu");
1458 outflags
|= MMAN_nl
;
1461 print_width(&bln
->norm
->Bl
, NULL
);
1463 outflags
|= MMAN_nl
;
1464 print_count(&bln
->norm
->Bl
.count
);
1465 outflags
|= MMAN_nl
;
1468 print_width(&bln
->norm
->Bl
, n
->child
);
1470 outflags
|= MMAN_nl
;
1473 print_width(&bln
->norm
->Bl
, n
->child
);
1475 outflags
&= ~MMAN_spc
;
1487 * This function is called after closing out an indented block.
1488 * If we are inside an enclosing list, restore its indentation.
1495 /* Nothing to do outside a list. */
1496 if (0 == Bl_stack_len
|| 0 == Bl_stack
[Bl_stack_len
- 1])
1499 /* The indentation has already been set up. */
1500 if (Bl_stack_post
[Bl_stack_len
- 1])
1503 /* Restore the indentation of the enclosing list. */
1504 print_line(".RS", MMAN_Bk_susp
);
1505 (void)snprintf(buf
, sizeof(buf
), "%dn",
1506 Bl_stack
[Bl_stack_len
- 1]);
1509 /* Remeber to close out this .RS block later. */
1510 Bl_stack_post
[Bl_stack_len
- 1] = 1;
1516 const struct roff_node
*bln
;
1518 bln
= n
->parent
->parent
;
1522 switch (bln
->norm
->Bl
.type
) {
1524 outflags
&= ~MMAN_spc
;
1528 outflags
|= MMAN_br
;
1535 switch (bln
->norm
->Bl
.type
) {
1542 assert(Bl_stack_len
);
1543 Bl_stack
[--Bl_stack_len
] = 0;
1546 * Our indentation had to be restored
1547 * after a child display or child list.
1548 * Close out that indentation block now.
1550 if (Bl_stack_post
[Bl_stack_len
]) {
1551 print_line(".RE", MMAN_nl
);
1552 Bl_stack_post
[Bl_stack_len
] = 0;
1556 if (NULL
!= n
->next
) {
1558 outflags
&= ~MMAN_spc
;
1574 if (SEC_LIBRARY
== n
->sec
)
1575 outflags
|= MMAN_br
;
1581 const struct roff_node
*link
, *descr
, *punct
;
1583 if ((link
= n
->child
) == NULL
)
1586 /* Find beginning of trailing punctuation. */
1588 while (punct
!= link
&& punct
->flags
& NODE_DELIMC
)
1589 punct
= punct
->prev
;
1590 punct
= punct
->next
;
1593 if ((descr
= link
->next
) != NULL
&& descr
!= punct
) {
1595 while (descr
!= punct
) {
1596 print_word(descr
->string
);
1597 descr
= descr
->next
;
1605 print_word(link
->string
);
1608 /* Trailing punctuation. */
1609 while (punct
!= NULL
) {
1610 print_word(punct
->string
);
1611 punct
= punct
->next
;
1617 pre_onearg(DECL_ARGS
)
1619 outflags
|= MMAN_nl
;
1621 outflags
&= ~MMAN_spc
;
1622 print_word(roff_name
[n
->tok
]);
1623 if (n
->child
!= NULL
)
1624 print_word(n
->child
->string
);
1625 outflags
|= MMAN_nl
;
1626 if (n
->tok
== ROFF_ce
)
1627 for (n
= n
->child
->next
; n
!= NULL
; n
= n
->next
)
1628 print_node(meta
, n
);
1645 outflags
|= MMAN_Bk
;
1654 name
= n
->child
== NULL
? NULL
: n
->child
->string
;
1657 if (n
->type
== ROFFT_HEAD
) {
1658 if (roff_node_prev(n
->parent
) == NULL
)
1659 outflags
|= MMAN_sp
;
1660 print_block(".HP", 0);
1661 printf(" %dn", man_strlen(name
) + 1);
1662 outflags
|= MMAN_nl
;
1673 outflags
&= ~MMAN_Bk
;
1677 if (n
->child
!= NULL
&& n
->child
->string
!= NULL
)
1688 outflags
|= MMAN_spc_force
;
1693 pre_noarg(DECL_ARGS
)
1695 outflags
|= MMAN_nl
;
1697 outflags
&= ~MMAN_spc
;
1698 print_word(roff_name
[n
->tok
]);
1699 outflags
|= MMAN_nl
;
1705 outflags
&= ~MMAN_spc
;
1713 if ( ! (n
->next
== NULL
|| n
->next
->flags
& NODE_LINE
))
1714 outflags
&= ~MMAN_spc
;
1721 if (MDOC_It
!= n
->parent
->tok
)
1722 outflags
|= MMAN_PP
;
1723 outflags
|= MMAN_sp
| MMAN_nl
;
1724 outflags
&= ~MMAN_br
;
1732 if (SEC_SEE_ALSO
== n
->sec
) {
1733 outflags
|= MMAN_PP
| MMAN_sp
| MMAN_nl
;
1734 outflags
&= ~MMAN_br
;
1750 if (NULL
== n
->child
)
1751 outflags
^= MMAN_Sm
;
1752 else if (0 == strcmp("on", n
->child
->string
))
1753 outflags
|= MMAN_Sm
;
1755 outflags
&= ~MMAN_Sm
;
1757 if (MMAN_Sm
& outflags
)
1758 outflags
|= MMAN_spc
;
1766 if (outflags
& MMAN_PP
) {
1767 outflags
&= ~MMAN_PP
;
1768 print_line(".PP", 0);
1770 print_line(".sp", 0);
1771 if (n
->child
!= NULL
)
1772 print_word(n
->child
->string
);
1774 outflags
|= MMAN_nl
;
1788 print_line(".ta", 0);
1789 for (n
= n
->child
; n
!= NULL
; n
= n
->next
)
1790 print_word(n
->string
);
1791 outflags
|= MMAN_nl
;
1798 if (NODE_SYNPRETTY
& n
->flags
) {
1817 if (n
->flags
& NODE_SYNPRETTY
&& n
->type
!= ROFFT_BODY
)
1829 print_node(meta
, n
);
1833 outflags
&= ~MMAN_spc
;
1835 print_node(meta
, n
);