]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_markdown.c
1 /* $Id: mdoc_markdown.c,v 1.24 2018/04/11 17:11:13 schwarze Exp $ */
3 * Copyright (c) 2017 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 AUTHORS DISCLAIM ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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>
24 #include "mandoc_aux.h"
31 int (*cond
)(struct roff_node
*n
);
32 int (*pre
)(struct roff_node
*n
);
33 void (*post
)(struct roff_node
*n
);
34 const char *prefix
; /* pre-node string constant */
35 const char *suffix
; /* post-node string constant */
38 static void md_nodelist(struct roff_node
*);
39 static void md_node(struct roff_node
*);
40 static const char *md_stack(char c
);
41 static void md_preword(void);
42 static void md_rawword(const char *);
43 static void md_word(const char *);
44 static void md_named(const char *);
45 static void md_char(unsigned char);
46 static void md_uri(const char *);
48 static int md_cond_head(struct roff_node
*);
49 static int md_cond_body(struct roff_node
*);
51 static int md_pre_raw(struct roff_node
*);
52 static int md_pre_word(struct roff_node
*);
53 static int md_pre_skip(struct roff_node
*);
54 static void md_pre_syn(struct roff_node
*);
55 static int md_pre_An(struct roff_node
*);
56 static int md_pre_Ap(struct roff_node
*);
57 static int md_pre_Bd(struct roff_node
*);
58 static int md_pre_Bk(struct roff_node
*);
59 static int md_pre_Bl(struct roff_node
*);
60 static int md_pre_D1(struct roff_node
*);
61 static int md_pre_Dl(struct roff_node
*);
62 static int md_pre_En(struct roff_node
*);
63 static int md_pre_Eo(struct roff_node
*);
64 static int md_pre_Fa(struct roff_node
*);
65 static int md_pre_Fd(struct roff_node
*);
66 static int md_pre_Fn(struct roff_node
*);
67 static int md_pre_Fo(struct roff_node
*);
68 static int md_pre_In(struct roff_node
*);
69 static int md_pre_It(struct roff_node
*);
70 static int md_pre_Lk(struct roff_node
*);
71 static int md_pre_Mt(struct roff_node
*);
72 static int md_pre_Nd(struct roff_node
*);
73 static int md_pre_Nm(struct roff_node
*);
74 static int md_pre_No(struct roff_node
*);
75 static int md_pre_Ns(struct roff_node
*);
76 static int md_pre_Pp(struct roff_node
*);
77 static int md_pre_Rs(struct roff_node
*);
78 static int md_pre_Sh(struct roff_node
*);
79 static int md_pre_Sm(struct roff_node
*);
80 static int md_pre_Vt(struct roff_node
*);
81 static int md_pre_Xr(struct roff_node
*);
82 static int md_pre__T(struct roff_node
*);
83 static int md_pre_br(struct roff_node
*);
85 static void md_post_raw(struct roff_node
*);
86 static void md_post_word(struct roff_node
*);
87 static void md_post_pc(struct roff_node
*);
88 static void md_post_Bk(struct roff_node
*);
89 static void md_post_Bl(struct roff_node
*);
90 static void md_post_D1(struct roff_node
*);
91 static void md_post_En(struct roff_node
*);
92 static void md_post_Eo(struct roff_node
*);
93 static void md_post_Fa(struct roff_node
*);
94 static void md_post_Fd(struct roff_node
*);
95 static void md_post_Fl(struct roff_node
*);
96 static void md_post_Fn(struct roff_node
*);
97 static void md_post_Fo(struct roff_node
*);
98 static void md_post_In(struct roff_node
*);
99 static void md_post_It(struct roff_node
*);
100 static void md_post_Lb(struct roff_node
*);
101 static void md_post_Nm(struct roff_node
*);
102 static void md_post_Pf(struct roff_node
*);
103 static void md_post_Vt(struct roff_node
*);
104 static void md_post__T(struct roff_node
*);
106 static const struct md_act __md_acts
[MDOC_MAX
- MDOC_Dd
] = {
107 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dd */
108 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dt */
109 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Os */
110 { NULL
, md_pre_Sh
, NULL
, NULL
, NULL
}, /* Sh */
111 { NULL
, md_pre_Sh
, NULL
, NULL
, NULL
}, /* Ss */
112 { NULL
, md_pre_Pp
, NULL
, NULL
, NULL
}, /* Pp */
113 { md_cond_body
, md_pre_D1
, md_post_D1
, NULL
, NULL
}, /* D1 */
114 { md_cond_body
, md_pre_Dl
, md_post_D1
, NULL
, NULL
}, /* Dl */
115 { md_cond_body
, md_pre_Bd
, md_post_D1
, NULL
, NULL
}, /* Bd */
116 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ed */
117 { md_cond_body
, md_pre_Bl
, md_post_Bl
, NULL
, NULL
}, /* Bl */
118 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* El */
119 { NULL
, md_pre_It
, md_post_It
, NULL
, NULL
}, /* It */
120 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Ad */
121 { NULL
, md_pre_An
, NULL
, NULL
, NULL
}, /* An */
122 { NULL
, md_pre_Ap
, NULL
, NULL
, NULL
}, /* Ap */
123 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Ar */
124 { NULL
, md_pre_raw
, md_post_raw
, "**", "**" }, /* Cd */
125 { NULL
, md_pre_raw
, md_post_raw
, "**", "**" }, /* Cm */
126 { NULL
, md_pre_raw
, md_post_raw
, "`", "`" }, /* Dv */
127 { NULL
, md_pre_raw
, md_post_raw
, "`", "`" }, /* Er */
128 { NULL
, md_pre_raw
, md_post_raw
, "`", "`" }, /* Ev */
129 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ex */
130 { NULL
, md_pre_Fa
, md_post_Fa
, NULL
, NULL
}, /* Fa */
131 { NULL
, md_pre_Fd
, md_post_Fd
, "**", "**" }, /* Fd */
132 { NULL
, md_pre_raw
, md_post_Fl
, "**-", "**" }, /* Fl */
133 { NULL
, md_pre_Fn
, md_post_Fn
, NULL
, NULL
}, /* Fn */
134 { NULL
, md_pre_Fd
, md_post_raw
, "*", "*" }, /* Ft */
135 { NULL
, md_pre_raw
, md_post_raw
, "**", "**" }, /* Ic */
136 { NULL
, md_pre_In
, md_post_In
, NULL
, NULL
}, /* In */
137 { NULL
, md_pre_raw
, md_post_raw
, "`", "`" }, /* Li */
138 { md_cond_head
, md_pre_Nd
, NULL
, NULL
, NULL
}, /* Nd */
139 { NULL
, md_pre_Nm
, md_post_Nm
, "**", "**" }, /* Nm */
140 { md_cond_body
, md_pre_word
, md_post_word
, "[", "]" }, /* Op */
141 { NULL
, md_pre_Fd
, md_post_raw
, "*", "*" }, /* Ot */
142 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Pa */
143 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Rv */
144 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* St */
145 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Va */
146 { NULL
, md_pre_Vt
, md_post_Vt
, "*", "*" }, /* Vt */
147 { NULL
, md_pre_Xr
, NULL
, NULL
, NULL
}, /* Xr */
148 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %A */
149 { NULL
, md_pre_raw
, md_post_pc
, "*", "*" }, /* %B */
150 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %D */
151 { NULL
, md_pre_raw
, md_post_pc
, "*", "*" }, /* %I */
152 { NULL
, md_pre_raw
, md_post_pc
, "*", "*" }, /* %J */
153 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %N */
154 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %O */
155 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %P */
156 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %R */
157 { NULL
, md_pre__T
, md_post__T
, NULL
, NULL
}, /* %T */
158 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %V */
159 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ac */
160 { md_cond_body
, md_pre_word
, md_post_word
, "<", ">" }, /* Ao */
161 { md_cond_body
, md_pre_word
, md_post_word
, "<", ">" }, /* Aq */
162 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* At */
163 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bc */
164 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bf XXX not implemented */
165 { md_cond_body
, md_pre_word
, md_post_word
, "[", "]" }, /* Bo */
166 { md_cond_body
, md_pre_word
, md_post_word
, "[", "]" }, /* Bq */
167 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bsx */
168 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bx */
169 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Db */
170 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dc */
171 { md_cond_body
, md_pre_word
, md_post_word
, "\"", "\"" }, /* Do */
172 { md_cond_body
, md_pre_word
, md_post_word
, "\"", "\"" }, /* Dq */
173 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ec */
174 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ef */
175 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Em */
176 { md_cond_body
, md_pre_Eo
, md_post_Eo
, NULL
, NULL
}, /* Eo */
177 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Fx */
178 { NULL
, md_pre_raw
, md_post_raw
, "**", "**" }, /* Ms */
179 { NULL
, md_pre_No
, NULL
, NULL
, NULL
}, /* No */
180 { NULL
, md_pre_Ns
, NULL
, NULL
, NULL
}, /* Ns */
181 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Nx */
182 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ox */
183 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Pc */
184 { NULL
, NULL
, md_post_Pf
, NULL
, NULL
}, /* Pf */
185 { md_cond_body
, md_pre_word
, md_post_word
, "(", ")" }, /* Po */
186 { md_cond_body
, md_pre_word
, md_post_word
, "(", ")" }, /* Pq */
187 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Qc */
188 { md_cond_body
, md_pre_raw
, md_post_raw
, "'`", "`'" }, /* Ql */
189 { md_cond_body
, md_pre_word
, md_post_word
, "\"", "\"" }, /* Qo */
190 { md_cond_body
, md_pre_word
, md_post_word
, "\"", "\"" }, /* Qq */
191 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Re */
192 { md_cond_body
, md_pre_Rs
, NULL
, NULL
, NULL
}, /* Rs */
193 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Sc */
194 { md_cond_body
, md_pre_word
, md_post_word
, "'", "'" }, /* So */
195 { md_cond_body
, md_pre_word
, md_post_word
, "'", "'" }, /* Sq */
196 { NULL
, md_pre_Sm
, NULL
, NULL
, NULL
}, /* Sm */
197 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Sx */
198 { NULL
, md_pre_raw
, md_post_raw
, "**", "**" }, /* Sy */
199 { NULL
, md_pre_raw
, md_post_raw
, "`", "`" }, /* Tn */
200 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ux */
201 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xc */
202 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Xo */
203 { NULL
, md_pre_Fo
, md_post_Fo
, "**", "**" }, /* Fo */
204 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Fc */
205 { md_cond_body
, md_pre_word
, md_post_word
, "[", "]" }, /* Oo */
206 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Oc */
207 { NULL
, md_pre_Bk
, md_post_Bk
, NULL
, NULL
}, /* Bk */
208 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ek */
209 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Bt */
210 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Hf */
211 { NULL
, md_pre_raw
, md_post_raw
, "*", "*" }, /* Fr */
212 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ud */
213 { NULL
, NULL
, md_post_Lb
, NULL
, NULL
}, /* Lb */
214 { NULL
, md_pre_Pp
, NULL
, NULL
, NULL
}, /* Lp */
215 { NULL
, md_pre_Lk
, NULL
, NULL
, NULL
}, /* Lk */
216 { NULL
, md_pre_Mt
, NULL
, NULL
, NULL
}, /* Mt */
217 { md_cond_body
, md_pre_word
, md_post_word
, "{", "}" }, /* Brq */
218 { md_cond_body
, md_pre_word
, md_post_word
, "{", "}" }, /* Bro */
219 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Brc */
220 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %C */
221 { NULL
, md_pre_skip
, NULL
, NULL
, NULL
}, /* Es */
222 { md_cond_body
, md_pre_En
, md_post_En
, NULL
, NULL
}, /* En */
223 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Dx */
224 { NULL
, NULL
, md_post_pc
, NULL
, NULL
}, /* %Q */
225 { NULL
, md_pre_Lk
, md_post_pc
, NULL
, NULL
}, /* %U */
226 { NULL
, NULL
, NULL
, NULL
, NULL
}, /* Ta */
228 static const struct md_act
*const md_acts
= __md_acts
- MDOC_Dd
;
231 #define MD_spc (1 << 0) /* Blank character before next word. */
232 #define MD_spc_force (1 << 1) /* Even before trailing punctuation. */
233 #define MD_nonl (1 << 2) /* Prevent linebreak in markdown code. */
234 #define MD_nl (1 << 3) /* Break markdown code line. */
235 #define MD_br (1 << 4) /* Insert an output line break. */
236 #define MD_sp (1 << 5) /* Insert a paragraph break. */
237 #define MD_Sm (1 << 6) /* Horizontal spacing mode. */
238 #define MD_Bk (1 << 7) /* Word keep mode. */
239 #define MD_An_split (1 << 8) /* Author mode is "split". */
240 #define MD_An_nosplit (1 << 9) /* Author mode is "nosplit". */
242 static int escflags
; /* Escape in generated markdown code: */
243 #define ESC_BOL (1 << 0) /* "#*+-" near the beginning of a line. */
244 #define ESC_NUM (1 << 1) /* "." after a leading number. */
245 #define ESC_HYP (1 << 2) /* "(" immediately after "]". */
246 #define ESC_SQU (1 << 4) /* "]" when "[" is open. */
247 #define ESC_FON (1 << 5) /* "*" immediately after unrelated "*". */
248 #define ESC_EOL (1 << 6) /* " " at the and of a line. */
250 static int code_blocks
, quote_blocks
, list_blocks
;
254 markdown_mdoc(void *arg
, const struct roff_man
*mdoc
)
257 md_word(mdoc
->meta
.title
);
258 if (mdoc
->meta
.msec
!= NULL
) {
261 md_word(mdoc
->meta
.msec
);
265 md_word(mdoc
->meta
.vol
);
266 if (mdoc
->meta
.arch
!= NULL
) {
268 md_word(mdoc
->meta
.arch
);
273 md_nodelist(mdoc
->first
->child
);
276 md_word(mdoc
->meta
.os
);
278 md_word(mdoc
->meta
.date
);
283 md_nodelist(struct roff_node
*n
)
292 md_node(struct roff_node
*n
)
294 const struct md_act
*act
;
295 int cond
, process_children
;
297 if (n
->type
== ROFFT_COMMENT
|| n
->flags
& NODE_NOPRT
)
300 if (outflags
& MD_nonl
)
301 outflags
&= ~(MD_nl
| MD_sp
);
302 else if (outflags
& MD_spc
&& n
->flags
& NODE_LINE
)
307 process_children
= 1;
308 n
->flags
&= ~NODE_ENDED
;
310 if (n
->type
== ROFFT_TEXT
) {
311 if (n
->flags
& NODE_DELIMC
)
312 outflags
&= ~(MD_spc
| MD_spc_force
);
313 else if (outflags
& MD_Sm
)
314 outflags
|= MD_spc_force
;
316 if (n
->flags
& NODE_DELIMO
)
317 outflags
&= ~(MD_spc
| MD_spc_force
);
318 else if (outflags
& MD_Sm
)
320 } else if (n
->tok
< ROFF_MAX
) {
323 process_children
= md_pre_br(n
);
326 process_children
= md_pre_Pp(n
);
329 process_children
= 0;
333 assert(n
->tok
>= MDOC_Dd
&& n
->tok
< MDOC_MAX
);
334 act
= md_acts
+ n
->tok
;
335 cond
= act
->cond
== NULL
|| (*act
->cond
)(n
);
336 if (cond
&& act
->pre
!= NULL
&&
337 (n
->end
== ENDBODY_NOT
|| n
->child
!= NULL
))
338 process_children
= (*act
->pre
)(n
);
341 if (process_children
&& n
->child
!= NULL
)
342 md_nodelist(n
->child
);
344 if (n
->flags
& NODE_ENDED
)
347 if (cond
&& act
->post
!= NULL
)
350 if (n
->end
!= ENDBODY_NOT
)
351 n
->body
->flags
|= NODE_ENDED
;
371 stack
= mandoc_realloc(stack
, sz
);
377 return stack
== NULL
? "" : stack
;
381 * Handle vertical and horizontal spacing.
389 * If a list block is nested inside a code block or a blockquote,
390 * blank lines for paragraph breaks no longer work; instead,
391 * they terminate the list. Work around this markdown issue
392 * by using mere line breaks instead.
395 if (list_blocks
&& outflags
& MD_sp
) {
401 * End the old line if requested.
402 * Escape whitespace at the end of the markdown line
403 * such that it won't look like an output line break.
406 if (outflags
& MD_sp
)
408 else if (outflags
& MD_br
) {
411 } else if (outflags
& MD_nl
&& escflags
& ESC_EOL
)
414 /* Start a new line if necessary. */
416 if (outflags
& (MD_nl
| MD_br
| MD_sp
)) {
418 for (cp
= md_stack('\0'); *cp
!= '\0'; cp
++) {
423 outflags
&= ~(MD_nl
| MD_br
| MD_sp
);
427 /* Handle horizontal spacing. */
429 } else if (outflags
& MD_spc
) {
430 if (outflags
& MD_Bk
)
431 fputs(" ", stdout
);
434 escflags
&= ~ESC_FON
;
438 outflags
&= ~(MD_spc_force
| MD_nonl
);
439 if (outflags
& MD_Sm
)
446 * Print markdown syntax elements.
447 * Can also be used for constant strings when neither escaping
448 * nor delimiter handling is required.
451 md_rawword(const char *s
)
458 if (escflags
& ESC_FON
) {
459 escflags
&= ~ESC_FON
;
460 if (*s
== '*' && !code_blocks
)
461 fputs("‌", stdout
);
475 escflags
&= ~ESC_SQU
;
485 escflags
&= ~ESC_EOL
;
489 * Print text and mdoc(7) syntax elements.
492 md_word(const char *s
)
494 const char *seq
, *prevfont
, *currfont
, *nextfont
;
496 int bs
, sz
, uc
, breakline
;
498 /* No spacing before closing delimiters. */
499 if (s
[0] != '\0' && s
[1] == '\0' &&
500 strchr("!),.:;?]", s
[0]) != NULL
&&
501 (outflags
& MD_spc_force
) == 0)
509 /* No spacing after opening delimiters. */
510 if ((s
[0] == '(' || s
[0] == '[') && s
[1] == '\0')
514 prevfont
= currfont
= "";
515 while ((c
= *s
++) != '\0') {
527 bs
= escflags
& ESC_BOL
&& !code_blocks
;
535 bs
= escflags
& ESC_BOL
&& !code_blocks
;
538 bs
= escflags
& ESC_HYP
&& !code_blocks
;
541 bs
= escflags
& ESC_NUM
&& !code_blocks
;
550 bs
= escflags
& ESC_NUM
&& !code_blocks
;
553 if (code_blocks
== 0) {
559 if (escflags
& ESC_BOL
&& !code_blocks
) {
565 if (code_blocks
== 0) {
573 switch (mandoc_escape(&s
, &seq
, &sz
)) {
575 uc
= mchars_num2uc(seq
+ 1, sz
- 1);
577 case ESCAPE_NUMBERED
:
578 uc
= mchars_num2char(seq
, sz
);
581 uc
= mchars_spec2cp(seq
, sz
);
583 case ESCAPE_FONTBOLD
:
586 case ESCAPE_FONTITALIC
:
593 case ESCAPE_FONTROMAN
:
596 case ESCAPE_FONTPREV
:
603 case ESCAPE_SKIPCHAR
:
604 case ESCAPE_OVERSTRIKE
:
605 /* XXX not implemented */
611 if (nextfont
!= NULL
&& !code_blocks
) {
612 if (*currfont
!= '\0') {
614 md_rawword(currfont
);
618 if (*currfont
!= '\0') {
620 md_rawword(currfont
);
624 if ((uc
< 0x20 && uc
!= 0x09) ||
625 (uc
> 0x7E && uc
< 0xA0))
628 seq
= mchars_uc2str(uc
);
630 outcount
+= strlen(seq
);
635 escflags
&= ~ESC_FON
;
640 bs
= escflags
& ESC_SQU
&& !code_blocks
;
650 (*s
== '\0' || *s
== ' ' || *s
== ASCII_NBRSP
)) {
653 while (*s
== ' ' || *s
== ASCII_NBRSP
)
657 if (*currfont
!= '\0') {
659 md_rawword(currfont
);
660 } else if (s
[-2] == ' ')
663 escflags
&= ~ESC_EOL
;
667 * Print a single HTML named character reference.
670 md_named(const char *s
)
673 escflags
&= ~(ESC_FON
| ESC_EOL
);
678 * Print a single raw character and maintain certain escape flags.
681 md_char(unsigned char c
)
688 escflags
&= ~ESC_FON
;
692 escflags
&= ~ESC_HYP
;
693 if (c
== ' ' || c
== '\t' || c
== '>')
696 escflags
&= ~ESC_NUM
;
697 else if (escflags
& ESC_BOL
)
699 escflags
&= ~ESC_BOL
;
703 md_cond_head(struct roff_node
*n
)
705 return n
->type
== ROFFT_HEAD
;
709 md_cond_body(struct roff_node
*n
)
711 return n
->type
== ROFFT_BODY
;
715 md_pre_raw(struct roff_node
*n
)
719 if ((prefix
= md_acts
[n
->tok
].prefix
) != NULL
) {
729 md_post_raw(struct roff_node
*n
)
733 if ((suffix
= md_acts
[n
->tok
].suffix
) != NULL
) {
734 outflags
&= ~(MD_spc
| MD_nl
);
742 md_pre_word(struct roff_node
*n
)
746 if ((prefix
= md_acts
[n
->tok
].prefix
) != NULL
) {
754 md_post_word(struct roff_node
*n
)
758 if ((suffix
= md_acts
[n
->tok
].suffix
) != NULL
) {
759 outflags
&= ~(MD_spc
| MD_nl
);
765 md_post_pc(struct roff_node
*n
)
768 if (n
->parent
->tok
!= MDOC_Rs
)
770 if (n
->next
!= NULL
) {
772 if (n
->prev
!= NULL
&&
773 n
->prev
->tok
== n
->tok
&&
774 n
->next
->tok
== n
->tok
)
783 md_pre_skip(struct roff_node
*n
)
789 md_pre_syn(struct roff_node
*n
)
791 if (n
->prev
== NULL
|| ! (n
->flags
& NODE_SYNPRETTY
))
794 if (n
->prev
->tok
== n
->tok
&&
802 switch (n
->prev
->tok
) {
811 if (n
->tok
!= MDOC_Fn
&& n
->tok
!= MDOC_Fo
) {
823 md_pre_An(struct roff_node
*n
)
825 switch (n
->norm
->An
.auth
) {
827 outflags
&= ~MD_An_nosplit
;
828 outflags
|= MD_An_split
;
831 outflags
&= ~MD_An_split
;
832 outflags
|= MD_An_nosplit
;
835 if (outflags
& MD_An_split
)
837 else if (n
->sec
== SEC_AUTHORS
&&
838 ! (outflags
& MD_An_nosplit
))
839 outflags
|= MD_An_split
;
845 md_pre_Ap(struct roff_node
*n
)
854 md_pre_Bd(struct roff_node
*n
)
856 switch (n
->norm
->Bd
.type
) {
866 md_pre_Bk(struct roff_node
*n
)
880 md_post_Bk(struct roff_node
*n
)
882 if (n
->type
== ROFFT_BODY
)
887 md_pre_Bl(struct roff_node
*n
)
889 n
->norm
->Bl
.count
= 0;
890 if (n
->norm
->Bl
.type
== LIST_column
)
897 md_post_Bl(struct roff_node
*n
)
899 n
->norm
->Bl
.count
= 0;
900 if (n
->norm
->Bl
.type
== LIST_column
)
906 md_pre_D1(struct roff_node
*n
)
909 * Markdown blockquote syntax does not work inside code blocks.
910 * The best we can do is fall back to another nested code block.
924 md_post_D1(struct roff_node
*n
)
935 md_pre_Dl(struct roff_node
*n
)
938 * Markdown code block syntax does not work inside blockquotes.
939 * The best we can do is fall back to another nested blockquote.
953 md_pre_En(struct roff_node
*n
)
955 if (n
->norm
->Es
== NULL
||
956 n
->norm
->Es
->child
== NULL
)
959 md_word(n
->norm
->Es
->child
->string
);
965 md_post_En(struct roff_node
*n
)
967 if (n
->norm
->Es
== NULL
||
968 n
->norm
->Es
->child
== NULL
||
969 n
->norm
->Es
->child
->next
== NULL
)
973 md_word(n
->norm
->Es
->child
->next
->string
);
977 md_pre_Eo(struct roff_node
*n
)
979 if (n
->end
== ENDBODY_NOT
&&
980 n
->parent
->head
->child
== NULL
&&
982 n
->child
->end
!= ENDBODY_NOT
)
984 else if (n
->end
!= ENDBODY_NOT
? n
->child
!= NULL
:
985 n
->parent
->head
->child
!= NULL
&& (n
->child
!= NULL
||
986 (n
->parent
->tail
!= NULL
&& n
->parent
->tail
->child
!= NULL
)))
987 outflags
&= ~(MD_spc
| MD_nl
);
992 md_post_Eo(struct roff_node
*n
)
994 if (n
->end
!= ENDBODY_NOT
) {
999 if (n
->child
== NULL
&& n
->parent
->head
->child
== NULL
)
1002 if (n
->parent
->tail
!= NULL
&& n
->parent
->tail
->child
!= NULL
)
1003 outflags
&= ~MD_spc
;
1009 md_pre_Fa(struct roff_node
*n
)
1013 am_Fa
= n
->tok
== MDOC_Fa
;
1020 outflags
&= ~MD_spc
;
1022 outflags
&= ~MD_spc
;
1024 if ((n
= n
->next
) != NULL
)
1031 md_post_Fa(struct roff_node
*n
)
1033 if (n
->next
!= NULL
&& n
->next
->tok
== MDOC_Fa
)
1038 md_pre_Fd(struct roff_node
*n
)
1046 md_post_Fd(struct roff_node
*n
)
1053 md_post_Fl(struct roff_node
*n
)
1056 if (n
->child
== NULL
&& n
->next
!= NULL
&&
1057 n
->next
->type
!= ROFFT_TEXT
&& !(n
->next
->flags
& NODE_LINE
))
1058 outflags
&= ~MD_spc
;
1062 md_pre_Fn(struct roff_node
*n
)
1066 if ((n
= n
->child
) == NULL
)
1070 outflags
&= ~MD_spc
;
1072 outflags
&= ~MD_spc
;
1074 outflags
&= ~MD_spc
;
1077 if ((n
= n
->next
) != NULL
)
1083 md_post_Fn(struct roff_node
*n
)
1086 if (n
->flags
& NODE_SYNPRETTY
) {
1093 md_pre_Fo(struct roff_node
*n
)
1100 if (n
->child
== NULL
)
1105 outflags
&= ~(MD_spc
| MD_nl
);
1115 md_post_Fo(struct roff_node
*n
)
1119 if (n
->child
!= NULL
)
1131 md_pre_In(struct roff_node
*n
)
1133 if (n
->flags
& NODE_SYNPRETTY
) {
1136 outflags
&= ~MD_spc
;
1137 md_word("#include <");
1140 outflags
&= ~MD_spc
;
1143 outflags
&= ~MD_spc
;
1148 md_post_In(struct roff_node
*n
)
1150 if (n
->flags
& NODE_SYNPRETTY
) {
1151 outflags
&= ~MD_spc
;
1155 outflags
&= ~MD_spc
;
1161 md_pre_It(struct roff_node
*n
)
1163 struct roff_node
*bln
;
1170 bln
= n
->parent
->parent
;
1171 if (bln
->norm
->Bl
.comp
== 0 &&
1172 bln
->norm
->Bl
.type
!= LIST_column
)
1176 switch (bln
->norm
->Bl
.type
) {
1198 if (bln
->norm
->Bl
.count
< 99)
1199 bln
->norm
->Bl
.count
++;
1200 printf("%d.\t", bln
->norm
->Bl
.count
);
1201 escflags
&= ~ESC_FON
;
1209 outflags
&= ~MD_spc
;
1210 outflags
|= MD_nonl
;
1213 if (code_blocks
|| quote_blocks
)
1218 bln
= n
->parent
->parent
;
1219 switch (bln
->norm
->Bl
.type
) {
1238 md_post_It(struct roff_node
*n
)
1240 struct roff_node
*bln
;
1243 if (n
->type
!= ROFFT_BODY
)
1246 bln
= n
->parent
->parent
;
1247 switch (bln
->norm
->Bl
.type
) {
1253 if (code_blocks
|| quote_blocks
)
1262 if (n
->next
== NULL
)
1265 /* Calculate the array index of the current column. */
1268 while ((n
= n
->prev
) != NULL
&& n
->type
!= ROFFT_HEAD
)
1272 * If a width was specified for this column,
1273 * subtract what printed, and
1274 * add the same spacing as in mdoc_term.c.
1277 nc
= bln
->norm
->Bl
.ncols
;
1278 i
= i
< nc
? strlen(bln
->norm
->Bl
.cols
[i
]) - outcount
+
1279 (nc
< 5 ? 4 : nc
== 5 ? 3 : 1) : 1;
1285 outflags
&= ~MD_spc
;
1286 escflags
&= ~ESC_FON
;
1296 md_post_Lb(struct roff_node
*n
)
1298 if (n
->sec
== SEC_LIBRARY
)
1303 md_uri(const char *s
)
1305 while (*s
!= '\0') {
1306 if (strchr("%()<>", *s
) != NULL
) {
1307 printf("%%%2.2hhX", *s
);
1318 md_pre_Lk(struct roff_node
*n
)
1320 const struct roff_node
*link
, *descr
, *punct
;
1322 if ((link
= n
->child
) == NULL
)
1325 /* Find beginning of trailing punctuation. */
1327 while (punct
!= link
&& punct
->flags
& NODE_DELIMC
)
1328 punct
= punct
->prev
;
1329 punct
= punct
->next
;
1334 descr
= link
; /* no text */
1336 outflags
&= ~MD_spc
;
1338 md_word(descr
->string
);
1339 descr
= descr
->next
;
1340 } while (descr
!= punct
);
1341 outflags
&= ~MD_spc
;
1345 md_uri(link
->string
);
1346 outflags
&= ~MD_spc
;
1349 /* Trailing punctuation. */
1350 while (punct
!= NULL
) {
1351 md_word(punct
->string
);
1352 punct
= punct
->next
;
1358 md_pre_Mt(struct roff_node
*n
)
1360 const struct roff_node
*nch
;
1363 outflags
&= ~MD_spc
;
1364 for (nch
= n
->child
; nch
!= NULL
; nch
= nch
->next
)
1365 md_word(nch
->string
);
1366 outflags
&= ~MD_spc
;
1367 md_rawword("](mailto:");
1368 for (nch
= n
->child
; nch
!= NULL
; nch
= nch
->next
) {
1369 md_uri(nch
->string
);
1370 if (nch
->next
!= NULL
) {
1375 outflags
&= ~MD_spc
;
1381 md_pre_Nd(struct roff_node
*n
)
1390 md_pre_Nm(struct roff_node
*n
)
1408 md_post_Nm(struct roff_node
*n
)
1424 md_pre_No(struct roff_node
*n
)
1426 outflags
|= MD_spc_force
;
1431 md_pre_Ns(struct roff_node
*n
)
1433 outflags
&= ~MD_spc
;
1438 md_post_Pf(struct roff_node
*n
)
1440 if (n
->next
!= NULL
&& (n
->next
->flags
& NODE_LINE
) == 0)
1441 outflags
&= ~MD_spc
;
1445 md_pre_Pp(struct roff_node
*n
)
1452 md_pre_Rs(struct roff_node
*n
)
1454 if (n
->sec
== SEC_SEE_ALSO
)
1460 md_pre_Sh(struct roff_node
*n
)
1464 if (n
->sec
== SEC_AUTHORS
)
1465 outflags
&= ~(MD_An_split
| MD_An_nosplit
);
1469 md_rawword(n
->tok
== MDOC_Sh
? "#" : "##");
1481 md_pre_Sm(struct roff_node
*n
)
1483 if (n
->child
== NULL
)
1485 else if (strcmp("on", n
->child
->string
) == 0)
1490 if (outflags
& MD_Sm
)
1497 md_pre_Vt(struct roff_node
*n
)
1513 md_post_Vt(struct roff_node
*n
)
1526 md_pre_Xr(struct roff_node
*n
)
1535 outflags
&= ~MD_spc
;
1543 md_pre__T(struct roff_node
*n
)
1545 if (n
->parent
->tok
== MDOC_Rs
&& n
->parent
->norm
->Rs
.quote_T
)
1549 outflags
&= ~MD_spc
;
1554 md_post__T(struct roff_node
*n
)
1556 outflags
&= ~MD_spc
;
1557 if (n
->parent
->tok
== MDOC_Rs
&& n
->parent
->norm
->Rs
.quote_T
)
1565 md_pre_br(struct roff_node
*n
)