=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.49 retrieving revision 1.73 diff -u -p -r1.49 -r1.73 --- mandoc/mdoc.c 2009/03/01 23:14:15 1.49 +++ mandoc/mdoc.c 2009/03/31 13:50:19 1.73 @@ -1,6 +1,6 @@ -/* $Id: mdoc.c,v 1.49 2009/03/01 23:14:15 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.73 2009/03/31 13:50:19 kristaps Exp $ */ /* - * Copyright (c) 2008 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 @@ -18,32 +18,23 @@ */ #include #include -#include #include -#include #include +#include #include -#include "private.h" +#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 and validate.c. - */ +enum merr { + ENOCALL, + EBODYPROL, + EPROLBODY, + ESPACE, + ETEXTPROL, + ENOBLANK, + EMALLOC +}; -static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *); -static void argfree(size_t, struct mdoc_arg *); -static void argcpy(struct mdoc_arg *, - const struct mdoc_arg *); - -static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); -static int mdoc_node_append(struct mdoc *, - struct mdoc_node *); -static void mdoc_elem_free(struct mdoc_elem *); -static void mdoc_text_free(struct mdoc_text *); - - const char *const __mdoc_macronames[MDOC_MAX] = { "\\\"", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", @@ -74,7 +65,12 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Tn", "Ux", "Xc", "Xo", "Fo", "Fc", "Oo", "Oc", "Bk", "Ek", "Bt", "Hf", - "Fr", "Ud", + "Fr", "Ud", "Lb", "Ap", + "Lp", "Lk", "Mt", "Brq", + /* LINTED */ + "Bro", "Brc", "\%C", "Es", + /* LINTED */ + "En", "Dx", "\%Q" }; const char *const __mdoc_argnames[MDOC_ARG_MAX] = { @@ -85,160 +81,164 @@ const char *const __mdoc_argnames[MDOC_ARG_MAX] = { "tag", "diag", "hang", "ohang", "inset", "column", "width", "compact", "std", - "p1003.1-88", "p1003.1-90", "p1003.1-96", - "p1003.1-2001", "p1003.1-2004", "p1003.1", - "p1003.1b", "p1003.1b-93", "p1003.1c-95", - "p1003.1g-2000", "p1003.2-92", "p1387.2-95", - "p1003.2", "p1387.2", "isoC-90", - "isoC-amd1", "isoC-tcor1", "isoC-tcor2", - "isoC-99", "ansiC", "ansiC-89", - "ansiC-99", "ieee754", "iso8802-3", - "xpg3", "xpg4", "xpg4.2", - "xpg4.3", "xbd5", "xcu5", - "xsh5", "xns5", "xns5.2d2.0", - "xcurses4.2", "susv2", "susv3", - "svid4", "filled", "words", - "emphasis", "symbolic", + "filled", "words", "emphasis", + "symbolic", "nested" }; 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); +#define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t)) + +/* + * 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) { - 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) { - return(&mdoc->meta); + return(MDOC_HALT & m->flags ? NULL : &m->meta); } -void -mdoc_free(struct mdoc *mdoc) +static void +mdoc_free1(struct mdoc *mdoc) { if (mdoc->first) mdoc_node_freelist(mdoc->first); - if (mdoc->htab) - mdoc_tokhash_free(mdoc->htab); 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); +} + +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) + 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) +{ + + mdoc_free1(mdoc); + if (mdoc->htab) + mdoc_tokhash_free(mdoc->htab); free(mdoc); } struct mdoc * -mdoc_alloc(void *data, const struct mdoc_cb *cb) +mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) { struct mdoc *p; - p = xcalloc(1, sizeof(struct mdoc)); + if (NULL == (p = calloc(1, sizeof(struct mdoc)))) + return(NULL); p->data = data; + p->htab = mdoc_tokhash_alloc(); + p->pflags = pflags; + if (cb) (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - p->last = xcalloc(1, sizeof(struct mdoc_node)); - p->last->type = MDOC_ROOT; - p->first = p->last; - - p->next = MDOC_NEXT_CHILD; - p->htab = mdoc_tokhash_alloc(); - - return(p); + if (mdoc_alloc1(p)) + return(p); + free(p); + return(NULL); } +/* + * Climb back up the parse tree, validating open scopes. Mostly calls + * 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); } +/* + * Main parse routine. Parses a single line -- really just hands off to + * the macro or text parser. + */ int -mdoc_parseln(struct mdoc *mdoc, int line, char *buf) +mdoc_parseln(struct mdoc *m, int ln, char *buf) { - int c, i; - char tmp[5]; - if (MDOC_HALT & mdoc->flags) - return(0); + /* If in error-mode, then we parse no more. */ - mdoc->linetok = 0; - - /* - * FIXME: should puke on whitespace in non-literal displays. - */ - - if ('.' != *buf) { - if (SEC_PROLOGUE == mdoc->lastnamed) - return(mdoc_perr(mdoc, line, 0, - "no text in document prologue")); - if ( ! mdoc_word_alloc(mdoc, line, 0, buf)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; - return(1); - } - - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); - - i = 1; - while (buf[i] && ! isspace((int)buf[i]) && i < (int)sizeof(tmp)) - i++; - - if (i == (int)sizeof(tmp)) { - mdoc->flags |= MDOC_HALT; - return(mdoc_perr(mdoc, line, 1, "unknown macro")); - } else if (i <= 2) { - mdoc->flags |= MDOC_HALT; - return(mdoc_perr(mdoc, line, 1, "unknown macro")); - } - - i--; - - (void)memcpy(tmp, buf + 1, (size_t)i); - tmp[i++] = 0; - - if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) { - mdoc->flags |= MDOC_HALT; - return(mdoc_perr(mdoc, line, 1, "unknown macro")); - } - - while (buf[i] && isspace((int)buf[i])) - i++; - - if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) { - mdoc->flags |= MDOC_HALT; + if (MDOC_HALT & m->flags) return(0); - } - return(1); + + return('.' == *buf ? parsemacro(m, ln, buf) : + parsetext(m, ln, buf)); } @@ -293,82 +293,78 @@ mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, int -mdoc_macro(struct mdoc *mdoc, int tok, - int ln, int ppos, int *pos, char *buf) +mdoc_macro(struct mdoc *m, int tok, + int ln, int pp, int *pos, char *buf) { - assert(mdoc_macros[tok].fp); + /* FIXME - these should happen during validation. */ if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - SEC_PROLOGUE != mdoc->lastnamed) - return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body")); + SEC_PROLOGUE != m->lastnamed) + return(perr(m, ln, pp, EPROLBODY)); + if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - SEC_PROLOGUE == mdoc->lastnamed) - return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document prologue")); - if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) - return(mdoc_perr(mdoc, ln, ppos, "macro not callable")); - return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf)); + SEC_PROLOGUE == m->lastnamed) + return(perr(m, ln, pp, EBODYPROL)); + + if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) + 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) { - const char *nn, *nt, *on, *ot, *act; + char *p; - assert(mdoc->last); - assert(mdoc->first); - assert(MDOC_ROOT != p->type); - - /* See if we exceed the suggest line-max. */ - - switch (p->type) { - case (MDOC_TEXT): - /* FALLTHROUGH */ - case (MDOC_ELEM): - /* FALLTHROUGH */ - case (MDOC_BLOCK): - mdoc->linetok++; + p = NULL; + switch (type) { + case (ENOCALL): + p = "not callable"; break; - default: + 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)); +} - /* This sort-of works (re-opening of text macros...). */ - if (mdoc->linetok > MDOC_LINEARG_SOFTMAX) - if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT, - "suggested %d tokens per line exceeded (has %d)", - MDOC_LINEARG_SOFTMAX, mdoc->linetok)) - return(0); - if (MDOC_TEXT == mdoc->last->type) - on = ""; - else if (MDOC_ROOT == mdoc->last->type) - on = ""; - else - on = mdoc_macronames[mdoc->last->tok]; +static int +node_append(struct mdoc *mdoc, struct mdoc_node *p) +{ - if (MDOC_TEXT == p->type) - nn = ""; - else if (MDOC_ROOT == p->type) - nn = ""; - else - nn = mdoc_macronames[p->tok]; + assert(mdoc->last); + assert(mdoc->first); + assert(MDOC_ROOT != p->type); - ot = mdoc_type2a(mdoc->last->type); - nt = mdoc_type2a(p->type); - switch (mdoc->next) { case (MDOC_NEXT_SIBLING): mdoc->last->next = p; p->prev = mdoc->last; p->parent = mdoc->last->parent; - act = "sibling"; break; case (MDOC_NEXT_CHILD): mdoc->last->child = p; p->parent = mdoc->last; - act = "child"; break; default: abort(); @@ -377,38 +373,60 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * if ( ! mdoc_valid_pre(mdoc, p)) return(0); + if ( ! mdoc_action_pre(mdoc, p)) + return(0); switch (p->type) { case (MDOC_HEAD): assert(MDOC_BLOCK == p->parent->type); - p->parent->data.block.head = p; + p->parent->head = p; break; case (MDOC_TAIL): assert(MDOC_BLOCK == p->parent->type); - p->parent->data.block.tail = p; + p->parent->tail = p; break; case (MDOC_BODY): assert(MDOC_BLOCK == p->parent->type); - p->parent->data.block.body = p; + p->parent->body = p; break; default: break; } mdoc->last = p; - mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'", - nt, nn, act, ot, on); + + 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; - p = xcalloc(1, sizeof(struct mdoc_node)); + if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { + (void)verr(mdoc, 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); } @@ -419,17 +437,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)); } @@ -441,14 +452,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)); } @@ -457,68 +464,40 @@ 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)); } int -mdoc_root_alloc(struct mdoc *mdoc) -{ - struct mdoc_node *p; - - p = mdoc_node_alloc(mdoc); - - p->type = MDOC_ROOT; - - return(mdoc_node_append(mdoc, p)); -} - - -int mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, - int tok, size_t argsz, const struct mdoc_arg *args) + int tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->pos = pos; - p->line = line; - p->type = MDOC_BLOCK; - p->tok = tok; - p->data.block.argc = argsz; - p->data.block.argv = argdup(argsz, args); - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); + if (NULL == p) + return(0); + if ((p->args = args)) + (args->refcnt)++; + return(node_append(mdoc, p)); } int mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, - int tok, size_t argsz, const struct mdoc_arg *args) + int tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_ELEM; - p->tok = tok; - p->data.elem.argc = argsz; - p->data.elem.argv = argdup(argsz, args); - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); + if (NULL == p) + return(0); + if ((p->args = args)) + (args->refcnt)++; + return(node_append(mdoc, p)); } @@ -528,82 +507,25 @@ 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; - p->data.text.string = xstrdup(word); - - 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)verr(mdoc, EMALLOC); + return(0); + } + return(node_append(mdoc, p)); } -static void -argfree(size_t sz, struct mdoc_arg *p) -{ - int i, j; - - if (0 == sz) - return; - - assert(p); - /* LINTED */ - for (i = 0; i < (int)sz; i++) - if (p[i].sz > 0) { - assert(p[i].value); - /* LINTED */ - for (j = 0; j < (int)p[i].sz; j++) - free(p[i].value[j]); - free(p[i].value); - } - free(p); -} - - -static void -mdoc_elem_free(struct mdoc_elem *p) -{ - - argfree(p->argc, p->argv); -} - - -static void -mdoc_block_free(struct mdoc_block *p) -{ - - argfree(p->argc, p->argv); -} - - -static void -mdoc_text_free(struct mdoc_text *p) -{ - - if (p->string) - free(p->string); -} - - void mdoc_node_free(struct mdoc_node *p) { - switch (p->type) { - case (MDOC_TEXT): - mdoc_text_free(&p->data.text); - break; - case (MDOC_ELEM): - mdoc_elem_free(&p->data.elem); - break; - case (MDOC_BLOCK): - mdoc_block_free(&p->data.block); - break; - default: - break; - } - + if (p->string) + free(p->string); + if (p->args) + mdoc_argv_free(p->args); free(p); } @@ -621,67 +543,107 @@ mdoc_node_freelist(struct mdoc_node *p) } -int -mdoc_find(const struct mdoc *mdoc, const char *key) +/* + * Parse free-form text, that is, a line that does not begin with the + * control character. + */ +static int +parsetext(struct mdoc *m, int line, char *buf) { - return(mdoc_tokhash_find(mdoc->htab, key)); + if (SEC_PROLOGUE == m->lastnamed) + return(perr(m, line, 0, ETEXTPROL)); + + if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) + return(perr(m, line, 0, ENOBLANK)); + + if ( ! mdoc_word_alloc(m, line, 0, buf)) + return(0); + + m->next = MDOC_NEXT_SIBLING; + return(1); } -static void -argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src) +static int +macrowarn(struct mdoc *m, int ln, const char *buf) { - int i; - - dst->line = src->line; - dst->pos = src->pos; - dst->arg = src->arg; - if (0 == (dst->sz = src->sz)) - return; - dst->value = xcalloc(dst->sz, sizeof(char *)); - for (i = 0; i < (int)dst->sz; i++) - dst->value[i] = xstrdup(src->value[i]); + if ( ! (MDOC_IGN_MACRO & m->pflags)) + 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", + buf, strlen(buf) > 3 ? "..." : "")); } -static struct mdoc_arg * -argdup(size_t argsz, const struct mdoc_arg *args) + +/* + * Parse a macro line, that is, a line beginning with the control + * character. + */ +int +parsemacro(struct mdoc *m, int ln, char *buf) { - struct mdoc_arg *pp; - int i; + int i, c; + char mac[5]; - if (0 == argsz) - return(NULL); + /* Comments and empties are quickly ignored. */ - pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg)); - for (i = 0; i < (int)argsz; i++) - argcpy(&pp[i], &args[i]); + if (0 == buf[1]) + return(1); - return(pp); -} + if (' ' == buf[1]) { + i = 2; + while (buf[i] && ' ' == buf[i]) + i++; + if (0 == buf[i]) + return(1); + return(perr(m, ln, 1, ESPACE)); + } + if (buf[1] && '\\' == buf[1]) + if (buf[2] && '\"' == buf[2]) + return(1); -/* FIXME: deprecate. */ -char * -mdoc_node2a(struct mdoc_node *node) -{ - static char buf[64]; + /* Copy the first word into a nil-terminated buffer. */ - assert(node); + for (i = 1; i < 5; i++) { + if (0 == (mac[i - 1] = buf[i])) + break; + else if (' ' == buf[i]) + break; + } - buf[0] = 0; - (void)xstrlcat(buf, mdoc_type2a(node->type), 64); - if (MDOC_ROOT == node->type) - return(buf); - (void)xstrlcat(buf, " `", 64); - if (MDOC_TEXT == node->type) - (void)xstrlcat(buf, node->data.text.string, 64); - else - (void)xstrlcat(buf, mdoc_macronames[node->tok], 64); - (void)xstrlcat(buf, "'", 64); + mac[i - 1] = 0; - return(buf); -} + if (i == 5 || i <= 2) { + if ( ! macrowarn(m, ln, mac)) + goto err; + return(1); + } + + if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) { + if ( ! macrowarn(m, ln, mac)) + goto err; + return(1); + } + /* The macro is sane. Jump to the next word. */ + while (buf[i] && ' ' == buf[i]) + i++; + + /* Begin recursive parse sequence. */ + + if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) + goto err; + + return(1); + +err: /* Error out. */ + + m->flags |= MDOC_HALT; + return(0); +}