=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.70 retrieving revision 1.84 diff -u -p -r1.70 -r1.84 --- mandoc/mdoc.c 2009/03/23 14:22:11 1.70 +++ mandoc/mdoc.c 2009/06/17 07:59:47 1.84 @@ -1,49 +1,40 @@ -/* $Id: mdoc.c,v 1.70 2009/03/23 14:22:11 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.84 2009/06/17 07:59:47 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include #include -#include #include -#include #include +#include #include #include "libmdoc.h" -/* - * Main caller in the libmdoc library. This begins the parsing routine, - * handles allocation of data, and so forth. Most of the "work" is done - * in macro.c, validate.c and action.c. - */ +enum merr { + ENOCALL, + EBODYPROL, + EPROLBODY, + ESPACE, + ETEXTPROL, + ENOBLANK, + EMALLOC +}; -/* FIXME: have this accept line/pos/tok. */ -static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); -static int mdoc_node_append(struct mdoc *, - struct mdoc_node *); - -static int parsetext(struct mdoc *, int, char *); -static int parsemacro(struct mdoc *, int, char *); -static int macrowarn(struct mdoc *, int, const char *); - - const char *const __mdoc_macronames[MDOC_MAX] = { - "\\\"", "Dd", "Dt", "Os", + "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", "El", "It", "Ad", "An", @@ -72,12 +63,12 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Tn", "Ux", "Xc", "Xo", "Fo", "Fc", "Oo", "Oc", "Bk", "Ek", "Bt", "Hf", - "Fr", "Ud", "Lb", "Ap", - "Lp", "Lk", "Mt", "Brq", + "Fr", "Ud", "Lb", "Lp", + "Lk", "Mt", "Brq", "Bro", /* LINTED */ - "Bro", "Brc", "\%C", "Es", + "Brc", "\%C", "Es", "En", /* LINTED */ - "En", "Dx", "\%Q" + "Dx", "\%Q" }; const char *const __mdoc_argnames[MDOC_ARG_MAX] = { @@ -95,39 +86,35 @@ const char *const __mdoc_argnames[MDOC_ARG_MAX] = { const char * const *mdoc_macronames = __mdoc_macronames; const char * const *mdoc_argnames = __mdoc_argnames; +static void mdoc_free1(struct mdoc *); +static int mdoc_alloc1(struct mdoc *); +static struct mdoc_node *node_alloc(struct mdoc *, int, int, + int, enum mdoc_type); +static int node_append(struct mdoc *, + struct mdoc_node *); +static int parsetext(struct mdoc *, int, char *); +static int parsemacro(struct mdoc *, int, char *); +static int macrowarn(struct mdoc *, int, const char *); +static int perr(struct mdoc *, int, int, enum merr); -/* - * Get the first (root) node of the parse tree. - */ const struct mdoc_node * -mdoc_node(const struct mdoc *mdoc) +mdoc_node(const struct mdoc *m) { - if (MDOC_HALT & mdoc->flags) - return(NULL); - if (mdoc->first) - assert(MDOC_ROOT == mdoc->first->type); - return(mdoc->first); + return(MDOC_HALT & m->flags ? NULL : m->first); } const struct mdoc_meta * -mdoc_meta(const struct mdoc *mdoc) +mdoc_meta(const struct mdoc *m) { - if (MDOC_HALT & mdoc->flags) - return(NULL); - return(&mdoc->meta); + return(MDOC_HALT & m->flags ? NULL : &m->meta); } -/* - * Free up all resources contributed by a parse: the node tree, - * meta-data and so on. Then reallocate the root node for another - * parse. - */ -void -mdoc_reset(struct mdoc *mdoc) +static void +mdoc_free1(struct mdoc *mdoc) { if (mdoc->first) @@ -142,42 +129,51 @@ mdoc_reset(struct mdoc *mdoc) free(mdoc->meta.arch); if (mdoc->meta.vol) free(mdoc->meta.vol); +} + +static int +mdoc_alloc1(struct mdoc *mdoc) +{ + bzero(&mdoc->meta, sizeof(struct mdoc_meta)); mdoc->flags = 0; mdoc->lastnamed = mdoc->lastsec = 0; mdoc->last = calloc(1, sizeof(struct mdoc_node)); if (NULL == mdoc->last) - err(1, "calloc"); + return(0); + mdoc->first = mdoc->last; mdoc->last->type = MDOC_ROOT; mdoc->next = MDOC_NEXT_CHILD; + return(1); } /* + * Free up all resources contributed by a parse: the node tree, + * meta-data and so on. Then reallocate the root node for another + * parse. + */ +int +mdoc_reset(struct mdoc *mdoc) +{ + + mdoc_free1(mdoc); + return(mdoc_alloc1(mdoc)); +} + + +/* * Completely free up all resources. */ void mdoc_free(struct mdoc *mdoc) { - if (mdoc->first) - mdoc_node_freelist(mdoc->first); - if (mdoc->meta.title) - free(mdoc->meta.title); - if (mdoc->meta.os) - free(mdoc->meta.os); - if (mdoc->meta.name) - free(mdoc->meta.name); - if (mdoc->meta.arch) - free(mdoc->meta.arch); - if (mdoc->meta.vol) - free(mdoc->meta.vol); - + mdoc_free1(mdoc); if (mdoc->htab) - mdoc_tokhash_free(mdoc->htab); - + mdoc_hash_free(mdoc->htab); free(mdoc); } @@ -188,20 +184,21 @@ mdoc_alloc(void *data, int pflags, const struct mdoc_c struct mdoc *p; if (NULL == (p = calloc(1, sizeof(struct mdoc)))) - err(1, "calloc"); - - p->data = data; + return(NULL); if (cb) (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - if (NULL == (p->first = calloc(1, sizeof(struct mdoc_node)))) - err(1, "calloc"); - p->last = p->first; - p->last->type = MDOC_ROOT; + p->data = data; p->pflags = pflags; - p->next = MDOC_NEXT_CHILD; - p->htab = mdoc_tokhash_alloc(); - return(p); + + if (NULL == (p->htab = mdoc_hash_alloc())) { + free(p); + return(NULL); + } else if (mdoc_alloc1(p)) + return(p); + + free(p); + return(NULL); } @@ -210,20 +207,15 @@ mdoc_alloc(void *data, int pflags, const struct mdoc_c * through to macro_end in macro.c. */ int -mdoc_endparse(struct mdoc *mdoc) +mdoc_endparse(struct mdoc *m) { - if (MDOC_HALT & mdoc->flags) + if (MDOC_HALT & m->flags) return(0); - if (NULL == mdoc->first) + else if (mdoc_macroend(m)) return(1); - - assert(mdoc->last); - if ( ! macro_end(mdoc)) { - mdoc->flags |= MDOC_HALT; - return(0); - } - return(1); + m->flags |= MDOC_HALT; + return(0); } @@ -235,8 +227,6 @@ int mdoc_parseln(struct mdoc *m, int ln, char *buf) { - /* If in error-mode, then we parse no more. */ - if (MDOC_HALT & m->flags) return(0); @@ -245,24 +235,42 @@ mdoc_parseln(struct mdoc *m, int ln, char *buf) } -void -mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) +int +mdoc_verr(struct mdoc *mdoc, int ln, int pos, + const char *fmt, ...) { - char buf[256]; - va_list ap; + char buf[256]; + va_list ap; - if (NULL == mdoc->cb.mdoc_msg) - return; + if (NULL == mdoc->cb.mdoc_err) + return(0); va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); - (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf); + return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); } int -mdoc_verr(struct mdoc *mdoc, int ln, int pos, +mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, + enum mdoc_warn type, const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == mdoc->cb.mdoc_warn) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf)); +} + + +int +mdoc_nerr(struct mdoc *mdoc, const struct mdoc_node *node, const char *fmt, ...) { char buf[256]; @@ -274,13 +282,14 @@ mdoc_verr(struct mdoc *mdoc, int ln, int pos, va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); - return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); + return((*mdoc->cb.mdoc_err)(mdoc->data, + node->line, node->pos, buf)); } int -mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, - enum mdoc_warn type, const char *fmt, ...) +mdoc_warn(struct mdoc *mdoc, enum mdoc_warn type, + const char *fmt, ...) { char buf[256]; va_list ap; @@ -291,11 +300,62 @@ mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); - return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf)); + return((*mdoc->cb.mdoc_warn)(mdoc->data, mdoc->last->line, + mdoc->last->pos, type, buf)); } int +mdoc_err(struct mdoc *mdoc, const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == mdoc->cb.mdoc_err) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*mdoc->cb.mdoc_err)(mdoc->data, mdoc->last->line, + mdoc->last->pos, buf)); +} + + +int +mdoc_pwarn(struct mdoc *mdoc, int line, int pos, enum mdoc_warn type, + const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == mdoc->cb.mdoc_warn) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*mdoc->cb.mdoc_warn)(mdoc->data, + line, pos, type, buf)); +} + +int +mdoc_perr(struct mdoc *mdoc, int line, int pos, const char *fmt, ...) +{ + char buf[256]; + va_list ap; + + if (NULL == mdoc->cb.mdoc_err) + return(0); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + return((*mdoc->cb.mdoc_err)(mdoc->data, line, pos, buf)); +} + + +int mdoc_macro(struct mdoc *m, int tok, int ln, int pp, int *pos, char *buf) { @@ -304,26 +364,57 @@ mdoc_macro(struct mdoc *m, int tok, if (MDOC_PROLOGUE & mdoc_macros[tok].flags && SEC_PROLOGUE != m->lastnamed) - return(mdoc_perr(m, ln, pp, - "disallowed in document body")); + return(perr(m, ln, pp, EPROLBODY)); if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && SEC_PROLOGUE == m->lastnamed) - return(mdoc_perr(m, ln, pp, - "disallowed in prologue")); + return(perr(m, ln, pp, EBODYPROL)); if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) - return(mdoc_perr(m, ln, pp, "%s not callable", - mdoc_macronames[tok])); + return(perr(m, ln, pp, ENOCALL)); return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); } static int -mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p) +perr(struct mdoc *m, int line, int pos, enum merr type) { + char *p; + p = NULL; + switch (type) { + case (ENOCALL): + p = "not callable"; + break; + case (EPROLBODY): + p = "macro disallowed in document body"; + break; + case (EBODYPROL): + p = "macro disallowed in document prologue"; + break; + case (EMALLOC): + p = "memory exhausted"; + break; + case (ETEXTPROL): + p = "text disallowed in document prologue"; + break; + case (ENOBLANK): + p = "blank lines disallowed in non-literal contexts"; + break; + case (ESPACE): + p = "whitespace disallowed after delimiter"; + break; + } + assert(p); + return(mdoc_perr(m, line, pos, p)); +} + + +static int +node_append(struct mdoc *mdoc, struct mdoc_node *p) +{ + assert(mdoc->last); assert(mdoc->first); assert(MDOC_ROOT != p->type); @@ -366,18 +457,40 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * } mdoc->last = p; + + switch (p->type) { + case (MDOC_TEXT): + if ( ! mdoc_valid_post(mdoc)) + return(0); + if ( ! mdoc_action_post(mdoc)) + return(0); + break; + default: + break; + } + return(1); } static struct mdoc_node * -mdoc_node_alloc(const struct mdoc *mdoc) +node_alloc(struct mdoc *mdoc, int line, + int pos, int tok, enum mdoc_type type) { struct mdoc_node *p; - if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) - err(1, "calloc"); + if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { + (void)perr(mdoc, (mdoc)->last->line, + (mdoc)->last->pos, EMALLOC); + return(NULL); + } + p->sec = mdoc->lastsec; + p->line = line; + p->pos = pos; + p->tok = tok; + if (MDOC_TEXT != (p->type = type)) + assert(p->tok >= 0); return(p); } @@ -388,17 +501,10 @@ mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); - - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_TAIL; - p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL); + if (NULL == p) + return(0); + return(node_append(mdoc, p)); } @@ -410,14 +516,10 @@ mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, assert(mdoc->first); assert(mdoc->last); - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_HEAD; - p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD); + if (NULL == p) + return(0); + return(node_append(mdoc, p)); } @@ -426,17 +528,10 @@ mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); - - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_BODY; - p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); + if (NULL == p) + return(0); + return(node_append(mdoc, p)); } @@ -446,18 +541,13 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->pos = pos; - p->line = line; - p->type = MDOC_BLOCK; - p->tok = tok; + p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); + if (NULL == p) + return(0); p->args = args; - - if (args) + if (p->args) (args->refcnt)++; - - return(mdoc_node_append(mdoc, p)); + return(node_append(mdoc, p)); } @@ -467,18 +557,13 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_ELEM; - p->tok = tok; + p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); + if (NULL == p) + return(0); p->args = args; - - if (args) + if (p->args) (args->refcnt)++; - - return(mdoc_node_append(mdoc, p)); + return(node_append(mdoc, p)); } @@ -488,15 +573,15 @@ mdoc_word_alloc(struct mdoc *mdoc, { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_TEXT; - if (NULL == (p->string = strdup(word))) - err(1, "strdup"); - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT); + if (NULL == p) + return(0); + if (NULL == (p->string = strdup(word))) { + (void)perr(mdoc, (mdoc)->last->line, + (mdoc)->last->pos, EMALLOC); + return(0); + } + return(node_append(mdoc, p)); } @@ -534,12 +619,10 @@ parsetext(struct mdoc *m, int line, char *buf) { if (SEC_PROLOGUE == m->lastnamed) - return(mdoc_perr(m, line, 0, - "text disallowed in prologue")); + return(perr(m, line, 0, ETEXTPROL)); if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) - return(mdoc_perr(m, line, 0, - "blank lines only in literal context")); + return(perr(m, line, 0, ENOBLANK)); if ( ! mdoc_word_alloc(m, line, 0, buf)) return(0); @@ -553,7 +636,8 @@ static int macrowarn(struct mdoc *m, int ln, const char *buf) { if ( ! (MDOC_IGN_MACRO & m->pflags)) - return(mdoc_perr(m, ln, 1, "unknown macro: %s%s", + return(mdoc_perr(m, ln, 1, + "unknown macro: %s%s", buf, strlen(buf) > 3 ? "..." : "")); return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, "unknown macro: %s%s", @@ -561,7 +645,6 @@ macrowarn(struct mdoc *m, int ln, const char *buf) } - /* * Parse a macro line, that is, a line beginning with the control * character. @@ -572,7 +655,7 @@ parsemacro(struct mdoc *m, int ln, char *buf) int i, c; char mac[5]; - /* Comments and empties are quickly ignored. */ + /* Empty lines are ignored. */ if (0 == buf[1]) return(1); @@ -583,13 +666,9 @@ parsemacro(struct mdoc *m, int ln, char *buf) i++; if (0 == buf[i]) return(1); - return(mdoc_perr(m, ln, 1, "invalid syntax")); + return(perr(m, ln, 1, ESPACE)); } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); - /* Copy the first word into a nil-terminated buffer. */ for (i = 1; i < 5; i++) { @@ -607,7 +686,7 @@ parsemacro(struct mdoc *m, int ln, char *buf) return(1); } - if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) { + if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) { if ( ! macrowarn(m, ln, mac)) goto err; return(1);