=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.17 retrieving revision 1.24 diff -u -p -r1.17 -r1.24 --- mandoc/Attic/validate.c 2009/01/07 15:53:00 1.17 +++ mandoc/Attic/validate.c 2009/01/12 10:31:53 1.24 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.17 2009/01/07 15:53:00 kristaps Exp $ */ +/* $Id: validate.c,v 1.24 2009/01/12 10:31:53 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -22,41 +22,61 @@ #include "private.h" -typedef int (*v_pre)(struct mdoc *, int, int, - int, const struct mdoc_arg *); -typedef int (*v_post)(struct mdoc *, int, int); +typedef int (*v_pre)(struct mdoc *, struct mdoc_node *); +typedef int (*v_post)(struct mdoc *); struct valids { - v_pre pre; + v_pre *pre; v_post *post; }; -static int pre_sh(struct mdoc *, int, int, - int, const struct mdoc_arg *); -static int post_headchild_err_ge1(struct mdoc *, int, int); -static int post_headchild_err_le8(struct mdoc *, int, int); -static int post_bodychild_warn_ge1(struct mdoc *, int, int); +static int pre_display(struct mdoc *, struct mdoc_node *); +static int pre_bd(struct mdoc *, struct mdoc_node *); +static int pre_bl(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 v_post posts_sh[] = { post_headchild_err_ge1, - post_bodychild_warn_ge1, - post_headchild_err_le8, NULL }; +static int headchild_err_ge1(struct mdoc *); +static int headchild_err_eq0(struct mdoc *); +static int elemchild_err_ge1(struct mdoc *); +static int elemchild_warn_eq0(struct mdoc *); +static int bodychild_warn_ge1(struct mdoc *); +static int post_sh(struct mdoc *); +static int post_bl(struct mdoc *); +static v_pre pres_prologue[] = { pre_prologue, NULL }; +static v_pre pres_d1[] = { pre_display, NULL }; +static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; +static v_pre pres_bl[] = { pre_bl, NULL }; +static v_post posts_bd[] = { headchild_err_eq0, + bodychild_warn_ge1, NULL }; +static v_post posts_sh[] = { headchild_err_ge1, + bodychild_warn_ge1, post_sh, NULL }; +static v_post posts_bl[] = { headchild_err_eq0, + bodychild_warn_ge1, post_bl, NULL }; +static v_post posts_ss[] = { headchild_err_ge1, NULL }; +static v_post posts_pp[] = { elemchild_warn_eq0, NULL }; +static v_post posts_dd[] = { elemchild_err_ge1, NULL }; +static v_post posts_d1[] = { headchild_err_ge1, NULL }; + + const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* \" */ - { NULL, NULL }, /* Dd */ /* TODO */ - { NULL, NULL }, /* Dt */ /* TODO */ - { NULL, NULL }, /* Os */ /* TODO */ - { pre_sh, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */ - { NULL, NULL }, /* Ss */ /* FIXME: preceding Pp. */ - { NULL, NULL }, /* Pp */ - { NULL, NULL }, /* D1 */ - { NULL, NULL }, /* Dl */ - { NULL, NULL }, /* Bd */ /* FIXME: preceding Pp. */ + { pres_prologue, posts_dd }, /* Dd */ + { pres_prologue, NULL }, /* Dt */ + { pres_prologue, NULL }, /* Os */ + { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */ + { NULL, posts_ss }, /* Ss */ /* FIXME: preceding Pp. */ + { NULL, posts_pp }, /* Pp */ /* FIXME: proceeding... */ + { pres_d1, posts_d1 }, /* D1 */ + { pres_d1, posts_d1 }, /* Dl */ + { pres_bd, posts_bd }, /* Bd */ /* FIXME: preceding Pp. */ { NULL, NULL }, /* Ed */ - { NULL, NULL }, /* Bl */ /* FIXME: preceding Pp. */ + { pres_bl, posts_bl }, /* Bl */ /* FIXME: preceding Pp. */ { NULL, NULL }, /* El */ { NULL, NULL }, /* It */ { NULL, NULL }, /* Ad */ @@ -155,68 +175,327 @@ const struct valids mdoc_valids[MDOC_MAX] = { static int -post_bodychild_warn_ge1(struct mdoc *mdoc, int tok, int pos) +bodychild_warn_ge1(struct mdoc *mdoc) { if (MDOC_BODY != mdoc->last->type) return(1); if (mdoc->last->child) return(1); + return(mdoc_warn(mdoc, WARN_ARGS_GE1)); +} - return(mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)); + +static int +elemchild_warn_eq0(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + if (NULL == mdoc->last->child) + return(1); + return(mdoc_pwarn(mdoc, mdoc->last->child->line, + mdoc->last->child->pos, WARN_ARGS_EQ0)); } static int -post_headchild_err_ge1(struct mdoc *mdoc, int tok, int pos) +elemchild_err_ge1(struct mdoc *mdoc) { + assert(MDOC_ELEM == mdoc->last->type); + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, ERR_ARGS_GE1)); +} + + +static int +headchild_err_eq0(struct mdoc *mdoc) +{ + if (MDOC_HEAD != mdoc->last->type) return(1); + if (NULL == mdoc->last->child) + return(1); + return(mdoc_perr(mdoc, mdoc->last->child->line, + mdoc->last->child->pos, ERR_ARGS_EQ0)); +} + + +static int +headchild_err_ge1(struct mdoc *mdoc) +{ + + if (MDOC_HEAD != mdoc->last->type) + return(1); if (mdoc->last->child) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + return(mdoc_err(mdoc, ERR_ARGS_GE1)); } static int -post_headchild_err_le8(struct mdoc *mdoc, int tok, int pos) +pre_display(struct mdoc *mdoc, struct mdoc_node *node) { - int i; struct mdoc_node *n; - if (MDOC_HEAD != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - for (i = 0, n = mdoc->last->child; n; n = n->next, i++) - /* Do nothing. */ ; - if (i <= 8) + + 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_err(mdoc, tok, pos, ERR_ARGS_LE8)); + return(mdoc_verr(mdoc, node, ERR_SCOPE_NONEST)); } static int -pre_sh(struct mdoc *mdoc, int tok, int pos, - int argc, const struct mdoc_arg *argv) +pre_bl(struct mdoc *mdoc, struct mdoc_node *node) { + int type, err; + struct mdoc_arg *argv; + size_t i, argc; - return(1); + if (MDOC_BLOCK != node->type) + return(1); + assert(MDOC_Bl == node->data.block.tok); + + argv = NULL; + argc = node->data.block.argc; + + for (i = type = err = 0; i < argc; i++) { + argv = &node->data.block.argv[(int)i]; + assert(argv); + switch (argv->arg) { + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + if (type) + err++; + type++; + break; + default: + break; + } + } + if (0 == type) + return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + if (0 == err) + return(1); + assert(argv); + return(mdoc_perr(mdoc, argv->line, + argv->pos, ERR_SYNTAX_ARGBAD)); } +static int +pre_bd(struct mdoc *mdoc, struct mdoc_node *node) +{ + int type, err; + struct mdoc_arg *argv; + size_t i, argc; + + if (MDOC_BLOCK != node->type) + return(1); + assert(MDOC_Bd == node->data.block.tok); + + argv = NULL; + argc = node->data.block.argc; + + for (err = i = type = 0; 0 == err && i < argc; i++) { + argv = &node->data.block.argv[(int)i]; + assert(argv); + switch (argv->arg) { + case (MDOC_Ragged): + /* FALLTHROUGH */ + case (MDOC_Unfilled): + /* FALLTHROUGH */ + case (MDOC_Literal): + /* FALLTHROUGH */ + case (MDOC_File): + if (type) + err++; + type++; + break; + default: + break; + } + } + if (0 == type) + return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + if (0 == err) + return(1); + assert(argv); + return(mdoc_perr(mdoc, argv->line, + argv->pos, ERR_SYNTAX_ARGBAD)); +} + + +static int +pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE)); + assert(MDOC_ELEM == node->type); + + /* Check for ordering. */ + + 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 */ + } + + /* Check for repetition. */ + + 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 */ + } + + return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP)); +} + + +static int +post_bl(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + if (MDOC_BODY != mdoc->last->type) + return(1); + assert(MDOC_Bl == mdoc->last->data.body.tok); + + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_BLOCK == n->type) + if (MDOC_It == n->data.block.tok) + continue; + break; + } + if (NULL == n) + return(1); + return(mdoc_verr(mdoc, n, ERR_SYNTAX_CHILDBAD)); +} + + +/* + * 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 +post_sh(struct mdoc *mdoc) +{ + enum mdoc_sec sec; + int i; + struct mdoc_node *n; + char *args[MDOC_LINEARG_MAX]; + + if (MDOC_HEAD != mdoc->last->type) + return(1); + + assert(MDOC_Sh == mdoc->last->data.head.tok); + + n = mdoc->last->child; + assert(n); + + 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; + } + + sec = mdoc_atosec((size_t)i, (const char **)args); + if (SEC_CUSTOM == sec) + return(1); + if (sec > mdoc->sec_lastn) + return(1); + + if (sec == mdoc->sec_lastn) + return(mdoc_warn(mdoc, WARN_SEC_REP)); + return(mdoc_warn(mdoc, WARN_SEC_OO)); +} + + int -mdoc_valid_pre(struct mdoc *mdoc, int tok, int pos, - int argc, const struct mdoc_arg *argv) +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) { + v_pre *p; + int t; - if (NULL == mdoc_valids[tok].pre) + 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((*mdoc_valids[tok].pre)(mdoc, tok, pos, argc, argv)); + } + + if (NULL == mdoc_valids[t].pre) + return(1); + for (p = mdoc_valids[t].pre; *p; p++) + if ( ! (*p)(mdoc, node)) + return(0); + return(1); } int -mdoc_valid_post(struct mdoc *mdoc, int pos) +mdoc_valid_post(struct mdoc *mdoc) { v_post *p; int t; @@ -240,9 +519,8 @@ mdoc_valid_post(struct mdoc *mdoc, int pos) if (NULL == mdoc_valids[t].post) return(1); - for (p = mdoc_valids[t].post; *p; p++) - if ( ! (*p)(mdoc, t, pos)) + if ( ! (*p)(mdoc)) return(0); return(1);