]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc.c
1 /* $Id: mdoc.c,v 1.27 2009/01/12 12:52:21 kristaps Exp $ */
3 * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the
7 * above copyright notice and this permission notice appear in all
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 * PERFORMANCE OF THIS SOFTWARE.
29 const char *const __mdoc_macronames
[MDOC_MAX
] = {
30 "\\\"", "Dd", "Dt", "Os",
31 "Sh", "Ss", "Pp", "D1",
32 "Dl", "Bd", "Ed", "Bl",
33 "El", "It", "Ad", "An",
34 "Ar", "Cd", "Cm", "Dv",
35 "Er", "Ev", "Ex", "Fa",
36 "Fd", "Fl", "Fn", "Ft",
37 "Ic", "In", "Li", "Nd",
38 "Nm", "Op", "Ot", "Pa",
39 "Rv", "St", "Va", "Vt",
41 "Xr", "\%A", "\%B", "\%D",
43 "\%I", "\%J", "\%N", "\%O",
45 "\%P", "\%R", "\%T", "\%V",
46 "Ac", "Ao", "Aq", "At",
47 "Bc", "Bf", "Bo", "Bq",
48 "Bsx", "Bx", "Db", "Dc",
49 "Do", "Dq", "Ec", "Ef",
50 "Em", "Eo", "Fx", "Ms",
51 "No", "Ns", "Nx", "Ox",
52 "Pc", "Pf", "Po", "Pq",
53 "Qc", "Ql", "Qo", "Qq",
54 "Re", "Rs", "Sc", "So",
55 "Sq", "Sm", "Sx", "Sy",
56 "Tn", "Ux", "Xc", "Xo",
57 "Fo", "Fc", "Oo", "Oc",
58 "Bk", "Ek", "Bt", "Hf",
62 const char *const __mdoc_argnames
[MDOC_ARG_MAX
] = {
63 "split", "nosplit", "ragged",
64 "unfilled", "literal", "file",
65 "offset", "bullet", "dash",
66 "hyphen", "item", "enum",
67 "tag", "diag", "hang",
68 "ohang", "inset", "column",
69 "width", "compact", "std",
70 "p1003.1-88", "p1003.1-90", "p1003.1-96",
71 "p1003.1-2001", "p1003.1-2004", "p1003.1",
72 "p1003.1b", "p1003.1b-93", "p1003.1c-95",
73 "p1003.1g-2000", "p1003.2-92", "p1387.2-95",
74 "p1003.2", "p1387.2", "isoC-90",
75 "isoC-amd1", "isoC-tcor1", "isoC-tcor2",
76 "isoC-99", "ansiC", "ansiC-89",
77 "ansiC-99", "ieee754", "iso8802-3",
78 "xpg3", "xpg4", "xpg4.2",
79 "xpg4.3", "xbd5", "xcu5",
80 "xsh5", "xns5", "xns5.2d2.0",
81 "xcurses4.2", "susv2", "susv3",
82 "svid4", "filled", "words",
83 "emphasis", "symbolic",
86 const struct mdoc_macro __mdoc_macros
[MDOC_MAX
] = {
88 { macro_constant
, MDOC_PROLOGUE
}, /* Dd */
89 { macro_constant
, MDOC_PROLOGUE
}, /* Dt */
90 { macro_constant
, MDOC_PROLOGUE
}, /* Os */
91 { macro_scoped
, 0 }, /* Sh */
92 { macro_scoped
, 0 }, /* Ss */
93 { macro_text
, 0 }, /* Pp */
94 { macro_scoped_line
, MDOC_PARSED
}, /* D1 */
95 { macro_scoped_line
, MDOC_PARSED
}, /* Dl */
96 { macro_scoped
, MDOC_EXPLICIT
}, /* Bd */
97 { macro_close_explicit
, 0 }, /* Ed */
98 { macro_scoped
, MDOC_EXPLICIT
}, /* Bl */
99 { macro_close_explicit
, 0 }, /* El */
100 { macro_scoped
, MDOC_NESTED
| MDOC_PARSED
}, /* It */
101 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ad */
102 { macro_constant
, MDOC_PARSED
}, /* An */
103 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ar */
104 { macro_constant
, MDOC_QUOTABLE
}, /* Cd */
105 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Cm */
106 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dv */
107 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Er */
108 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ev */
109 { macro_constant
, 0 }, /* Ex */
110 { macro_text
, MDOC_CALLABLE
| MDOC_QUOTABLE
| MDOC_PARSED
}, /* Fa */
111 { macro_constant
, 0 }, /* Fd */
112 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Fl */
113 { macro_text
, MDOC_CALLABLE
| MDOC_QUOTABLE
| MDOC_PARSED
}, /* Fn */
114 { macro_text
, MDOC_PARSED
}, /* Ft */
115 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ic */
116 { macro_constant
, 0 }, /* In */
117 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Li */
118 { macro_constant
, 0 }, /* Nd */
119 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Nm */
120 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Op */
121 { macro_obsolete
, 0 }, /* Ot */
122 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Pa */
123 { macro_constant
, 0 }, /* Rv */
124 /* XXX - .St supposed to be (but isn't) callable. */
125 { macro_constant_delimited
, MDOC_PARSED
}, /* St */
126 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Va */
127 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Vt */
128 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Xr */
129 { macro_constant
, MDOC_QUOTABLE
}, /* %A */
130 { macro_constant
, MDOC_QUOTABLE
}, /* %B */
131 { macro_constant
, MDOC_QUOTABLE
}, /* %D */
132 { macro_constant
, MDOC_QUOTABLE
}, /* %I */
133 { macro_constant
, MDOC_QUOTABLE
}, /* %J */
134 { macro_constant
, MDOC_QUOTABLE
}, /* %N */
135 { macro_constant
, MDOC_QUOTABLE
}, /* %O */
136 { macro_constant
, MDOC_QUOTABLE
}, /* %P */
137 { macro_constant
, MDOC_QUOTABLE
}, /* %R */
138 { macro_constant
, MDOC_QUOTABLE
}, /* %T */
139 { macro_constant
, MDOC_QUOTABLE
}, /* %V */
140 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ac */
141 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ao */
142 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Aq */
143 { macro_constant
, 0 }, /* At */
144 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bc */
145 { macro_scoped
, MDOC_EXPLICIT
}, /* Bf */
146 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bo */
147 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Bq */
148 { macro_constant_delimited
, MDOC_PARSED
}, /* Bsx */
149 { macro_constant_delimited
, MDOC_PARSED
}, /* Bx */
150 { macro_constant
, 0 }, /* Db */
151 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dc */
152 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Do */
153 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Dq */
154 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ec */
155 { macro_close_explicit
, 0 }, /* Ef */
156 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Em */
157 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Eo */
158 { macro_constant_delimited
, MDOC_PARSED
}, /* Fx */
159 { macro_text
, MDOC_PARSED
}, /* Ms */
160 { macro_constant_delimited
, MDOC_CALLABLE
| MDOC_PARSED
}, /* No */
161 { macro_constant_delimited
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ns */
162 { macro_constant_delimited
, MDOC_PARSED
}, /* Nx */
163 { macro_constant_delimited
, MDOC_PARSED
}, /* Ox */
164 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Pc */
165 { macro_constant
, MDOC_PARSED
}, /* Pf */
166 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Po */
167 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Pq */
168 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Qc */
169 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Ql */
170 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Qo */
171 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Qq */
172 { macro_close_explicit
, 0 }, /* Re */
173 { macro_scoped
, MDOC_EXPLICIT
}, /* Rs */
174 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sc */
175 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* So */
176 { macro_scoped_line
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sq */
177 { macro_constant
, 0 }, /* Sm */
178 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sx */
179 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Sy */
180 { macro_text
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Tn */
181 { macro_constant_delimited
, MDOC_PARSED
}, /* Ux */
182 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Xc */
183 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Xo */
184 /* XXX - .Fo supposed to be (but isn't) callable. */
185 { macro_scoped
, MDOC_EXPLICIT
| MDOC_PARSED
}, /* Fo */
186 /* XXX - .Fc supposed to be (but isn't) callable. */
187 { macro_close_explicit
, MDOC_PARSED
}, /* Fc */
188 { macro_constant_scoped
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Oo */
189 { macro_close_explicit
, MDOC_CALLABLE
| MDOC_PARSED
}, /* Oc */
190 { macro_scoped
, MDOC_EXPLICIT
}, /* Bk */
191 { macro_close_explicit
, 0 }, /* Ek */
192 { macro_constant
, 0 }, /* Bt */
193 { macro_constant
, 0 }, /* Hf */
194 { macro_obsolete
, 0 }, /* Fr */
195 { macro_constant
, 0 }, /* Ud */
198 const char * const *mdoc_macronames
= __mdoc_macronames
;
199 const char * const *mdoc_argnames
= __mdoc_argnames
;
200 const struct mdoc_macro
* const mdoc_macros
= __mdoc_macros
;
203 static struct mdoc_arg
*argdup(size_t, const struct mdoc_arg
*);
204 static void argfree(size_t, struct mdoc_arg
*);
205 static void argcpy(struct mdoc_arg
*,
206 const struct mdoc_arg
*);
208 static void mdoc_node_freelist(struct mdoc_node
*);
209 static int mdoc_node_append(struct mdoc
*,
211 static void mdoc_elem_free(struct mdoc_elem
*);
212 static void mdoc_text_free(struct mdoc_text
*);
215 const struct mdoc_node
*
216 mdoc_result(struct mdoc
*mdoc
)
224 mdoc_free(struct mdoc
*mdoc
)
228 mdoc_node_freelist(mdoc
->first
);
230 mdoc_tokhash_free(mdoc
->htab
);
237 mdoc_alloc(void *data
, const struct mdoc_cb
*cb
)
241 p
= xcalloc(1, sizeof(struct mdoc
));
244 (void)memcpy(&p
->cb
, cb
, sizeof(struct mdoc_cb
));
246 p
->last
= xcalloc(1, sizeof(struct mdoc_node
));
247 p
->last
->type
= MDOC_ROOT
;
250 p
->next
= MDOC_NEXT_CHILD
;
251 p
->htab
= mdoc_tokhash_alloc();
258 mdoc_endparse(struct mdoc
*mdoc
)
261 if (MDOC_HALT
& mdoc
->flags
)
263 if (NULL
== mdoc
->first
)
267 if ( ! macro_end(mdoc
)) {
268 mdoc
->flags
|= MDOC_HALT
;
276 mdoc_parseln(struct mdoc
*mdoc
, int line
, char *buf
)
281 if (MDOC_HALT
& mdoc
->flags
)
285 if (SEC_PROLOGUE
!= mdoc
->sec_lastn
) {
286 if ( ! mdoc_word_alloc(mdoc
, line
, 0, buf
))
288 mdoc
->next
= MDOC_NEXT_SIBLING
;
291 return(mdoc_perr(mdoc
, line
, 0, ERR_SYNTAX_NOTEXT
));
294 if (buf
[1] && '\\' == buf
[1])
295 if (buf
[2] && '\"' == buf
[2])
299 while (buf
[i
] && ! isspace(buf
[i
]) && i
< (int)sizeof(tmp
))
302 if (i
== (int)sizeof(tmp
)) {
303 mdoc
->flags
|= MDOC_HALT
;
304 return(mdoc_perr(mdoc
, line
, 1, ERR_MACRO_NOTSUP
));
306 mdoc
->flags
|= MDOC_HALT
;
307 return(mdoc_perr(mdoc
, line
, 1, ERR_MACRO_NOTSUP
));
312 (void)memcpy(tmp
, buf
+ 1, (size_t)i
);
315 if (MDOC_MAX
== (c
= mdoc_find(mdoc
, tmp
))) {
316 mdoc
->flags
|= MDOC_HALT
;
317 return(mdoc_perr(mdoc
, line
, 1, ERR_MACRO_NOTSUP
));
320 while (buf
[i
] && isspace(buf
[i
]))
323 if ( ! mdoc_macro(mdoc
, c
, line
, 1, &i
, buf
)) {
324 mdoc
->flags
|= MDOC_HALT
;
332 mdoc_msg(struct mdoc
*mdoc
, const char *fmt
, ...)
338 if (NULL
== mdoc
->cb
.mdoc_msg
)
345 (void)vsnprintf(buf
, sizeof(buf
), fmt
, ap
);
348 (*mdoc
->cb
.mdoc_msg
)(mdoc
->data
, n
->line
, n
->pos
, buf
);
353 mdoc_perr(struct mdoc
*mdoc
,
354 int line
, int pos
, enum mdoc_err type
)
357 if (NULL
== mdoc
->cb
.mdoc_err
)
359 return((*mdoc
->cb
.mdoc_err
)(mdoc
->data
, line
, pos
, type
));
364 mdoc_pwarn(struct mdoc
*mdoc
,
365 int line
, int pos
, enum mdoc_warn type
)
368 if (NULL
== mdoc
->cb
.mdoc_warn
)
370 return((*mdoc
->cb
.mdoc_warn
)(mdoc
->data
, line
, pos
, type
));
375 mdoc_macro(struct mdoc
*mdoc
, int tok
,
376 int ln
, int ppos
, int *pos
, char *buf
)
379 if ( ! (MDOC_PROLOGUE
& mdoc_macros
[tok
].flags
) &&
380 SEC_PROLOGUE
== mdoc
->sec_lastn
)
381 return(mdoc_perr(mdoc
, ln
, ppos
, ERR_SEC_PROLOGUE
));
383 if (NULL
== (mdoc_macros
[tok
].fp
))
384 return(mdoc_perr(mdoc
, ln
, ppos
, ERR_MACRO_NOTSUP
));
386 if (1 != ppos
&& ! (MDOC_CALLABLE
& mdoc_macros
[tok
].flags
))
387 return(mdoc_perr(mdoc
, ln
, ppos
, ERR_MACRO_NOTCALL
));
389 return((*mdoc_macros
[tok
].fp
)(mdoc
, tok
, ln
, ppos
, pos
, buf
));
394 mdoc_node_append(struct mdoc
*mdoc
, struct mdoc_node
*p
)
396 const char *on
, *ot
, *act
;
400 assert(MDOC_ROOT
!= p
->type
);
402 if (MDOC_TEXT
== mdoc
->last
->type
)
404 else if (MDOC_ROOT
== mdoc
->last
->type
)
407 on
= mdoc_macronames
[mdoc
->last
->tok
];
409 /* FIXME: put this into util.c. */
410 switch (mdoc
->last
->type
) {
437 switch (mdoc
->next
) {
438 case (MDOC_NEXT_SIBLING
):
439 mdoc
->last
->next
= p
;
440 p
->prev
= mdoc
->last
;
441 p
->parent
= mdoc
->last
->parent
;
444 case (MDOC_NEXT_CHILD
):
445 mdoc
->last
->child
= p
;
446 p
->parent
= mdoc
->last
;
454 if ( ! mdoc_valid_pre(mdoc
, p
))
456 if ( ! mdoc_action_pre(mdoc
, p
))
461 assert(MDOC_BLOCK
== p
->parent
->type
);
462 p
->parent
->data
.block
.head
= p
;
465 assert(MDOC_BLOCK
== p
->parent
->type
);
466 p
->parent
->data
.block
.tail
= p
;
469 assert(MDOC_BLOCK
== p
->parent
->type
);
470 p
->parent
->data
.block
.body
= p
;
477 mdoc_msg(mdoc
, "parse: %s of %s `%s'", act
, ot
, on
);
483 mdoc_tail_alloc(struct mdoc
*mdoc
, int line
, int pos
, int tok
)
490 p
= xcalloc(1, sizeof(struct mdoc_node
));
497 return(mdoc_node_append(mdoc
, p
));
502 mdoc_head_alloc(struct mdoc
*mdoc
, int line
, int pos
, int tok
)
509 p
= xcalloc(1, sizeof(struct mdoc_node
));
516 return(mdoc_node_append(mdoc
, p
));
521 mdoc_body_alloc(struct mdoc
*mdoc
, int line
, int pos
, int tok
)
528 p
= xcalloc(1, sizeof(struct mdoc_node
));
535 return(mdoc_node_append(mdoc
, p
));
540 mdoc_root_alloc(struct mdoc
*mdoc
)
544 p
= xcalloc(1, sizeof(struct mdoc_node
));
548 return(mdoc_node_append(mdoc
, p
));
553 mdoc_block_alloc(struct mdoc
*mdoc
, int line
, int pos
,
554 int tok
, size_t argsz
, const struct mdoc_arg
*args
)
558 p
= xcalloc(1, sizeof(struct mdoc_node
));
562 p
->type
= MDOC_BLOCK
;
564 p
->data
.block
.argc
= argsz
;
565 p
->data
.block
.argv
= argdup(argsz
, args
);
567 return(mdoc_node_append(mdoc
, p
));
572 mdoc_elem_alloc(struct mdoc
*mdoc
, int line
, int pos
,
573 int tok
, size_t argsz
, const struct mdoc_arg
*args
)
577 p
= xcalloc(1, sizeof(struct mdoc_node
));
583 p
->data
.elem
.argc
= argsz
;
584 p
->data
.elem
.argv
= argdup(argsz
, args
);
586 return(mdoc_node_append(mdoc
, p
));
591 mdoc_word_alloc(struct mdoc
*mdoc
,
592 int line
, int pos
, const char *word
)
596 p
= xcalloc(1, sizeof(struct mdoc_node
));
600 p
->data
.text
.string
= xstrdup(word
);
602 return(mdoc_node_append(mdoc
, p
));
607 argfree(size_t sz
, struct mdoc_arg
*p
)
616 for (i
= 0; i
< (int)sz
; i
++)
620 for (j
= 0; j
< (int)p
[i
].sz
; j
++)
629 mdoc_elem_free(struct mdoc_elem
*p
)
632 argfree(p
->argc
, p
->argv
);
637 mdoc_block_free(struct mdoc_block
*p
)
640 argfree(p
->argc
, p
->argv
);
645 mdoc_text_free(struct mdoc_text
*p
)
654 mdoc_node_free(struct mdoc_node
*p
)
659 mdoc_text_free(&p
->data
.text
);
662 mdoc_elem_free(&p
->data
.elem
);
665 mdoc_block_free(&p
->data
.block
);
676 mdoc_node_freelist(struct mdoc_node
*p
)
680 mdoc_node_freelist(p
->child
);
682 mdoc_node_freelist(p
->next
);
689 mdoc_find(const struct mdoc
*mdoc
, const char *key
)
692 return(mdoc_tokhash_find(mdoc
->htab
, key
));
697 argcpy(struct mdoc_arg
*dst
, const struct mdoc_arg
*src
)
701 dst
->line
= src
->line
;
704 if (0 == (dst
->sz
= src
->sz
))
706 dst
->value
= xcalloc(dst
->sz
, sizeof(char *));
707 for (i
= 0; i
< (int)dst
->sz
; i
++)
708 dst
->value
[i
] = xstrdup(src
->value
[i
]);
712 static struct mdoc_arg
*
713 argdup(size_t argsz
, const struct mdoc_arg
*args
)
721 pp
= xcalloc((size_t)argsz
, sizeof(struct mdoc_arg
));
722 for (i
= 0; i
< (int)argsz
; i
++)
723 argcpy(&pp
[i
], &args
[i
]);