=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.6 retrieving revision 1.23 diff -u -p -r1.6 -r1.23 --- mandoc/Attic/validate.c 2008/11/30 20:53:34 1.6 +++ mandoc/Attic/validate.c 2009/01/09 15:15:31 1.23 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.6 2008/11/30 20:53:34 kristaps Exp $ */ +/* $Id: validate.c,v 1.23 2009/01/09 15:15:31 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,455 +16,361 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -#include - #include -#include -#include -#include #include -#include -#include "libmdocml.h" #include "private.h" -#define INDENT 4 -#define COLUMNS 72 -#ifdef __linux__ /* FIXME */ -#define strlcat strncat -#endif +typedef int (*v_pre)(struct mdoc *, struct mdoc_node *); +typedef int (*v_post)(struct mdoc *); -enum md_tok { - MD_BLKIN, - MD_BLKOUT, - MD_IN, - MD_OUT, - MD_TEXT -}; -struct md_valid { - const struct md_args *args; - const struct md_rbuf *rbuf; - - struct md_mbuf *mbuf; - struct rofftree *tree; - size_t indent; - size_t pos; - enum md_tok last; - int flags; -#define MD_LITERAL (1 << 0) /* FIXME */ +struct valids { + v_pre pre; + v_post *post; }; -static void roffmsg(void *arg, enum roffmsg, - const char *, const char *, char *); -static int roffhead(void *); -static int rofftail(void *); -static int roffin(void *, int, int, int *, char **); -static int roffdata(void *, int, char *); -static int roffout(void *, int); -static int roffblkin(void *, int, int *, char **); -static int roffblkout(void *, int); -static int roffspecial(void *, int); -static int mbuf_newline(struct md_valid *); -static int mbuf_indent(struct md_valid *); -static int mbuf_data(struct md_valid *, int, char *); -static int mbuf_putstring(struct md_valid *, - const char *); -static int mbuf_nputstring(struct md_valid *, - const char *, size_t); +static int pre_display(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int post_headchild_err_ge1(struct mdoc *); +static int post_elemchild_err_ge1(struct mdoc *); +static int post_elemchild_warn_eq0(struct mdoc *); +static int post_bodychild_warn_ge1(struct mdoc *); +static int post_sh(struct mdoc *); +static v_post posts_sh[] = { post_headchild_err_ge1, + post_bodychild_warn_ge1, post_sh, NULL }; +static v_post posts_ss[] = { post_headchild_err_ge1, NULL }; +static v_post posts_pp[] = { post_elemchild_warn_eq0, NULL }; +static v_post posts_dd[] = { post_elemchild_err_ge1, NULL }; +static v_post posts_display[] = { post_headchild_err_ge1, NULL }; -static int -mbuf_putstring(struct md_valid *p, const char *buf) -{ - return(mbuf_nputstring(p, buf, strlen(buf))); -} +const struct valids mdoc_valids[MDOC_MAX] = { + { NULL, NULL }, /* \" */ + { pre_prologue, posts_dd }, /* Dd */ + { pre_prologue, NULL }, /* Dt */ + { pre_prologue, NULL }, /* Os */ + { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */ + { NULL, posts_ss }, /* Ss */ /* FIXME: preceding Pp. */ + { NULL, posts_pp }, /* Pp */ /* FIXME: proceeding... */ + { pre_display, posts_display }, /* D1 */ + { pre_display, posts_display }, /* Dl */ + { pre_display, NULL }, /* Bd */ /* FIXME: preceding Pp. */ + { NULL, NULL }, /* Ed */ + { NULL, NULL }, /* Bl */ /* FIXME: preceding Pp. */ + { NULL, NULL }, /* El */ + { NULL, NULL }, /* It */ + { NULL, NULL }, /* Ad */ + { NULL, NULL }, /* An */ + { NULL, NULL }, /* Ar */ + { NULL, NULL }, /* Cd */ + { NULL, NULL }, /* Cm */ + { NULL, NULL }, /* Dv */ + { NULL, NULL }, /* Er */ + { NULL, NULL }, /* Ev */ + { NULL, NULL }, /* Ex */ + { NULL, NULL }, /* Fa */ + { NULL, NULL }, /* Fd */ + { NULL, NULL }, /* Fl */ + { NULL, NULL }, /* Fn */ + { NULL, NULL }, /* Ft */ + { NULL, NULL }, /* Ic */ + { NULL, NULL }, /* In */ + { NULL, NULL }, /* Li */ + { NULL, NULL }, /* Nd */ + { NULL, NULL }, /* Nm */ + { NULL, NULL }, /* Op */ + { NULL, NULL }, /* Ot */ + { NULL, NULL }, /* Pa */ + { NULL, NULL }, /* Rv */ + { NULL, NULL }, /* St */ + { NULL, NULL }, /* Va */ + { NULL, NULL }, /* Vt */ + { NULL, NULL }, /* Xr */ + { NULL, NULL }, /* %A */ + { NULL, NULL }, /* %B */ + { NULL, NULL }, /* %D */ + { NULL, NULL }, /* %I */ + { NULL, NULL }, /* %J */ + { NULL, NULL }, /* %N */ + { NULL, NULL }, /* %O */ + { NULL, NULL }, /* %P */ + { NULL, NULL }, /* %R */ + { NULL, NULL }, /* %T */ + { NULL, NULL }, /* %V */ + { NULL, NULL }, /* Ac */ + { NULL, NULL }, /* Ao */ + { NULL, NULL }, /* Aq */ + { NULL, NULL }, /* At */ /* FIXME */ + { NULL, NULL }, /* Bc */ + { NULL, NULL }, /* Bf */ + { NULL, NULL }, /* Bo */ + { NULL, NULL }, /* Bq */ + { NULL, NULL }, /* Bsx */ + { NULL, NULL }, /* Bx */ + { NULL, NULL }, /* Db */ + { NULL, NULL }, /* Dc */ + { NULL, NULL }, /* Do */ + { NULL, NULL }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ /* -symbolic, etc. */ + { NULL, NULL }, /* Em */ + { NULL, NULL }, /* Eo */ + { NULL, NULL }, /* Fx */ + { NULL, NULL }, /* Ms */ + { NULL, NULL }, /* No */ + { NULL, NULL }, /* Ns */ + { NULL, NULL }, /* Nx */ + { NULL, NULL }, /* Ox */ + { NULL, NULL }, /* Pc */ + { NULL, NULL }, /* Pf */ /* 2 or more arguments */ + { NULL, NULL }, /* Po */ + { NULL, NULL }, /* Pq */ /* FIXME: ignore following Sh/Ss */ + { NULL, NULL }, /* Qc */ + { NULL, NULL }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, NULL }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, NULL }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, NULL }, /* Sq */ + { NULL, NULL }, /* Sm */ + { NULL, NULL }, /* Sx */ + { NULL, NULL }, /* Sy */ + { NULL, NULL }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, NULL }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, NULL }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, NULL }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, NULL }, /* Ud */ +}; static int -mbuf_nputstring(struct md_valid *p, const char *buf, size_t sz) +post_bodychild_warn_ge1(struct mdoc *mdoc) { - p->pos += sz; - return(md_buf_puts(p->mbuf, buf, sz)); -} + if (MDOC_BODY != mdoc->last->type) + return(1); + if (mdoc->last->child) + return(1); - -static int -mbuf_indent(struct md_valid *p) -{ - size_t i; - - assert(p->pos == 0); - - /* LINTED */ - for (i = 0; i < MIN(p->indent, INDENT); i++) - if ( ! md_buf_putstring(p->mbuf, " ")) - return(0); - - p->pos += i * INDENT; - return(1); + return(mdoc_warn(mdoc, WARN_ARGS_GE1)); } static int -mbuf_newline(struct md_valid *p) +post_elemchild_warn_eq0(struct mdoc *mdoc) { - if ( ! md_buf_putchar(p->mbuf, '\n')) - return(0); - - p->pos = 0; - return(1); + assert(MDOC_ELEM == mdoc->last->type); + if (NULL == mdoc->last->child) + return(1); + return(mdoc_warn(mdoc, WARN_ARGS_EQ0)); } static int -mbuf_data(struct md_valid *p, int space, char *buf) +post_elemchild_err_ge1(struct mdoc *mdoc) { - size_t sz; - char *bufp; - assert(p->mbuf); - assert(0 != p->indent); - - /* - * FIXME: punctuation/no-space stuff shouldn't have a newline - * before it. - */ - - if (MD_LITERAL & p->flags) - return(mbuf_putstring(p, buf)); - - while (*buf) { - while (*buf && isspace(*buf)) - buf++; - - if (0 == *buf) - break; - - bufp = buf; - while (*buf && ! isspace(*buf)) - buf++; - - if (0 != *buf) - *buf++ = 0; - - sz = strlen(bufp); - - if (0 == p->pos) { - if ( ! mbuf_indent(p)) - return(0); - if ( ! mbuf_nputstring(p, bufp, sz)) - return(0); - if (p->indent * INDENT + sz >= COLUMNS) { - if ( ! mbuf_newline(p)) - return(0); - continue; - } - continue; - } - - if (sz + p->pos >= COLUMNS) { - if ( ! mbuf_newline(p)) - return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if (space) - if ( ! mbuf_nputstring(p, " ", 1)) - return(0); - - if ( ! mbuf_nputstring(p, bufp, sz)) - return(0); - } - - return(1); + assert(MDOC_ELEM == mdoc->last->type); + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, ERR_ARGS_GE1)); } -int -md_line_valid(void *arg, char *buf) -{ - struct md_valid *p; - - p = (struct md_valid *)arg; - return(roff_engine(p->tree, buf)); -} - - -int -md_exit_valid(void *data, int flush) -{ - int c; - struct md_valid *p; - - p = (struct md_valid *)data; - c = roff_free(p->tree, flush); - free(p); - - return(c); -} - - -void * -md_init_valid(const struct md_args *args, - struct md_mbuf *mbuf, const struct md_rbuf *rbuf) -{ - struct roffcb cb; - struct md_valid *p; - - cb.roffhead = roffhead; - cb.rofftail = rofftail; - cb.roffin = roffin; - cb.roffout = roffout; - cb.roffblkin = roffblkin; - cb.roffblkout = roffblkout; - cb.roffspecial = roffspecial; - cb.roffmsg = roffmsg; - cb.roffdata = roffdata; - - if (NULL == (p = calloc(1, sizeof(struct md_valid)))) - err(1, "malloc"); - - p->args = args; - p->mbuf = mbuf; - p->rbuf = rbuf; - - assert(mbuf); - - if (NULL == (p->tree = roff_alloc(&cb, p))) { - free(p); - return(NULL); - } - - return(p); -} - - -/* ARGSUSED */ static int -roffhead(void *arg) +post_headchild_err_ge1(struct mdoc *mdoc) { - struct md_valid *p; - assert(arg); - p = (struct md_valid *)arg; - - if ( ! mbuf_putstring(p, "\n")) - return(0); - if ( ! mbuf_nputstring(p, "", 6)) - return(0); - - p->indent++; - return(mbuf_newline(p)); + if (MDOC_HEAD != mdoc->last->type) + return(1); + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, ERR_ARGS_GE1)); } static int -rofftail(void *arg) +pre_display(struct mdoc *mdoc, struct mdoc_node *node) { - struct md_valid *p; + struct mdoc_node *n; - assert(arg); - p = (struct md_valid *)arg; - - if (0 != p->pos && ! mbuf_newline(p)) - return(0); - - if ( ! mbuf_nputstring(p, "", 7)) - return(0); - return(mbuf_newline(p)); + for (n = mdoc->last; n; n = n->parent) + if (MDOC_BLOCK == n->type) + if (MDOC_Bd == n->data.block.tok) + break; + if (NULL == n) + return(1); + return(mdoc_verr(mdoc, node, ERR_SCOPE_NONEST)); } -/* ARGSUSED */ static int -roffspecial(void *arg, int tok) +pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) { - return(1); -} + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE)); + assert(MDOC_ELEM == node->type); + /* Check for ordering. */ -static int -roffblkin(void *arg, int tok, int *argc, char **argv) -{ - struct md_valid *p; - int i; + switch (node->data.elem.tok) { + case (MDOC_Os): + if (mdoc->meta.title[0] && mdoc->meta.date) + break; + return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + case (MDOC_Dt): + if (0 == mdoc->meta.title[0] && mdoc->meta.date) + break; + return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + case (MDOC_Dd): + if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date) + break; + return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + default: + abort(); + /* NOTREACHED */ + } - assert(arg); - p = (struct md_valid *)arg; + /* Check for repetition. */ - if (0 != p->pos) { - if ( ! mbuf_newline(p)) - return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if ( ! mbuf_indent(p)) - return(0); - - if ( ! mbuf_nputstring(p, "<", 1)) - return(0); - if ( ! mbuf_putstring(p, toknames[tok])) - return(0); - - for (i = 0; ROFF_ARGMAX != argc[i]; i++) { - if ( ! mbuf_nputstring(p, " ", 1)) - return(0); - if ( ! mbuf_putstring(p, tokargnames[argc[i]])) - return(0); - if ( ! mbuf_nputstring(p, "=\"", 2)) - return(0); - if ( ! mbuf_putstring(p, argv[i] ? argv[i] : "true")) - return(0); - if ( ! mbuf_nputstring(p, "\"", 1)) - return(0); + switch (node->data.elem.tok) { + case (MDOC_Os): + if (0 == mdoc->meta.os[0]) + return(1); + break; + case (MDOC_Dd): + if (0 == mdoc->meta.date) + return(1); + break; + case (MDOC_Dt): + if (0 == mdoc->meta.title[0]) + return(1); + break; + default: + abort(); + /* NOTREACHED */ } - if ( ! mbuf_nputstring(p, ">", 1)) - return(0); - if ( ! mbuf_newline(p)) - return(0); - - p->indent++; - return(1); + return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP)); } +/* + * Warn if sections (those that are with a known title, such as NAME, + * DESCRIPTION, and so forth) are out of the conventional order. + */ static int -roffblkout(void *arg, int tok) +post_sh(struct mdoc *mdoc) { - struct md_valid *p; + enum mdoc_sec sec; + int i; + struct mdoc_node *n; + char *args[MDOC_LINEARG_MAX]; - assert(arg); - p = (struct md_valid *)arg; + if (MDOC_HEAD != mdoc->last->type) + return(1); + + assert(MDOC_Sh == mdoc->last->data.head.tok); - p->indent--; + n = mdoc->last->child; + assert(n); - if (0 != p->pos) { - if ( ! mbuf_newline(p)) - return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if ( ! mbuf_indent(p)) - return(0); + for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) { + assert(MDOC_TEXT == n->type); + assert(NULL == n->child); + assert(n->data.text.string); + args[i] = n->data.text.string; + } - if ( ! mbuf_nputstring(p, "", 1)) - return(0); - if ( ! mbuf_newline(p)) - return(0); + sec = mdoc_atosec((size_t)i, (const char **)args); + if (SEC_CUSTOM == sec) + return(1); + if (sec > mdoc->sec_lastn) + return(1); - return(1); + if (sec == mdoc->sec_lastn) + return(mdoc_warn(mdoc, WARN_SEC_REP)); + return(mdoc_warn(mdoc, WARN_SEC_OO)); } -static int -roffin(void *arg, int tok, int space, int *argc, char **argv) +int +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) { - struct md_valid *p; - int i; + int t; - assert(arg); - p = (struct md_valid *)arg; - - if (0 == p->pos && ! mbuf_indent(p)) - return(0); - - /* - * FIXME: put into a buffer before writing (check line length). - */ - - if (space && ! mbuf_nputstring(p, " ", 1)) - return(0); - if ( ! mbuf_nputstring(p, "<", 1)) - return(0); - if ( ! mbuf_putstring(p, toknames[tok])) - return(0); - - for (i = 0; ROFF_ARGMAX != argc[i]; i++) { - if ( ! mbuf_nputstring(p, " ", 1)) - return(0); - if ( ! mbuf_putstring(p, tokargnames[argc[i]])) - return(0); - if ( ! mbuf_nputstring(p, "=\"", 2)) - return(0); - if ( ! mbuf_putstring(p, argv[i] ? argv[i] : "true")) - return(0); - if ( ! mbuf_nputstring(p, "\"", 1)) - return(0); + switch (node->type) { + case (MDOC_BODY): + t = node->data.body.tok; + break; + case (MDOC_ELEM): + t = node->data.elem.tok; + break; + case (MDOC_BLOCK): + t = node->data.block.tok; + break; + case (MDOC_HEAD): + t = node->data.head.tok; + break; + default: + return(1); } - return(mbuf_nputstring(p, ">", 1)); + if (NULL == mdoc_valids[t].pre) + return(1); + return((*mdoc_valids[t].pre)(mdoc, node)); } -static int -roffout(void *arg, int tok) +int +mdoc_valid_post(struct mdoc *mdoc) { - struct md_valid *p; + v_post *p; + int t; - assert(arg); - p = (struct md_valid *)arg; - - if (0 == p->pos && ! mbuf_indent(p)) - return(0); - - if ( ! mbuf_nputstring(p, "", 1)); -} - - -static void -roffmsg(void *arg, enum roffmsg lvl, - const char *buf, const char *pos, char *msg) -{ - char *level; - struct md_valid *p; - - assert(arg); - p = (struct md_valid *)arg; - - switch (lvl) { - case (ROFF_WARN): - if ( ! (MD_WARN_ALL & p->args->warnings)) - return; - level = "warning"; + switch (mdoc->last->type) { + case (MDOC_BODY): + t = mdoc->last->data.body.tok; break; - case (ROFF_ERROR): - level = "error"; + case (MDOC_ELEM): + t = mdoc->last->data.elem.tok; break; + case (MDOC_BLOCK): + t = mdoc->last->data.block.tok; + break; + case (MDOC_HEAD): + t = mdoc->last->data.head.tok; + break; default: - abort(); + return(1); } - - if (pos) - (void)fprintf(stderr, "%s:%zu: %s: %s (column %zu)\n", - p->rbuf->name, p->rbuf->line, level, - msg, pos - buf); - else - (void)fprintf(stderr, "%s: %s: %s\n", - p->rbuf->name, level, msg); -} + if (NULL == mdoc_valids[t].post) + return(1); + for (p = mdoc_valids[t].post; *p; p++) + if ( ! (*p)(mdoc)) + return(0); -static int -roffdata(void *arg, int space, char *buf) -{ - struct md_valid *p; - - assert(arg); - p = (struct md_valid *)arg; - return(mbuf_data(p, space, buf)); + return(1); } +