=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.21 retrieving revision 1.25 diff -u -p -r1.21 -r1.25 --- mandoc/Attic/validate.c 2009/01/09 14:45:44 1.21 +++ mandoc/Attic/validate.c 2009/01/12 12:52:21 1.25 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.21 2009/01/09 14:45:44 kristaps Exp $ */ +/* $Id: validate.c,v 1.25 2009/01/12 12:52:21 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -27,39 +27,62 @@ typedef int (*v_post)(struct mdoc *); struct valids { - v_pre pre; + v_pre *pre; v_post *post; }; +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_it(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_bodychild_warn_ge1(struct mdoc *); + +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 int post_it(struct mdoc *); -static v_post posts_sh[] = { post_headchild_err_ge1, - post_bodychild_warn_ge1, post_sh, NULL }; -static v_post posts_dd[] = { post_elemchild_err_ge1, NULL }; +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_pre pres_it[] = { pre_it, 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_it[] = { post_it, 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 }, /* \" */ - { pre_prologue, posts_dd }, /* Dd */ - { pre_prologue, NULL }, /* Dt */ - { pre_prologue, NULL }, /* Os */ + { pres_prologue, posts_dd }, /* Dd */ + { pres_prologue, NULL }, /* Dt */ + { pres_prologue, NULL }, /* Os */ { NULL, 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. */ + { 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 */ + { pres_it, posts_it }, /* It */ { NULL, NULL }, /* Ad */ { NULL, NULL }, /* An */ { NULL, NULL }, /* Ar */ @@ -156,23 +179,34 @@ const struct valids mdoc_valids[MDOC_MAX] = { static int -post_bodychild_warn_ge1(struct mdoc *mdoc) +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)); } static int -post_elemchild_err_ge1(struct mdoc *mdoc) +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 +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)); @@ -180,11 +214,24 @@ post_elemchild_err_ge1(struct mdoc *mdoc) static int -post_headchild_err_ge1(struct mdoc *mdoc) +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, ERR_ARGS_GE1)); @@ -192,6 +239,139 @@ post_headchild_err_ge1(struct mdoc *mdoc) static int +pre_display(struct mdoc *mdoc, struct mdoc_node *node) +{ + struct mdoc_node *n; + + if (MDOC_BLOCK != node->type) + return(1); + + for (n = mdoc->last; n; n = n->parent) + if (MDOC_BLOCK == n->type) + if (MDOC_Bd == n->tok) + break; + if (NULL == n) + return(1); + return(mdoc_verr(mdoc, node, ERR_SCOPE_NONEST)); +} + + +static int +pre_bl(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_Bl == node->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->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_it(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != mdoc->last->type) + return(1); + assert(MDOC_It == mdoc->last->tok); + + if (MDOC_BODY != mdoc->last->parent->type) + return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD)); + if (MDOC_Bl != mdoc->last->parent->tok) + return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD)); + + return(1); +} + + +static int pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) { @@ -201,7 +381,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node /* Check for ordering. */ - switch (node->data.elem.tok) { + switch (node->tok) { case (MDOC_Os): if (mdoc->meta.title[0] && mdoc->meta.date) break; @@ -221,7 +401,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node /* Check for repetition. */ - switch (node->data.elem.tok) { + switch (node->tok) { case (MDOC_Os): if (0 == mdoc->meta.os[0]) return(1); @@ -243,11 +423,131 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node } -/* - * Warn if sections (those that are with a known title, such as NAME, - * DESCRIPTION, and so forth) are out of the conventional order. - */ +/* Warn if `Bl' type-specific syntax isn't reflected in items. */ static int +post_it(struct mdoc *mdoc) +{ + int type, sv; +#define TYPE_NONE (0) +#define TYPE_BODY (1) +#define TYPE_HEAD (2) + size_t i, argc; + struct mdoc_node *n; + + if (MDOC_BLOCK != mdoc->last->type) + return(1); + + assert(MDOC_It == mdoc->last->tok); + + n = mdoc->last->parent; + assert(n); + assert(MDOC_Bl == n->tok); + + n = n->parent; + assert(MDOC_BLOCK == n->type); + assert(MDOC_Bl == n->tok); + + argc = n->data.block.argc; + type = TYPE_NONE; + + for (i = 0; TYPE_NONE == type && i < argc; i++) + switch (n->data.block.argv[(int)i].arg) { + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + type = TYPE_HEAD; + sv = n->data.block.argv[(int)i].arg; + break; + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Column): + type = TYPE_BODY; + sv = n->data.block.argv[(int)i].arg; + break; + default: + break; + } + + assert(TYPE_NONE != type); + + if (TYPE_HEAD == type) { + if (NULL == (n = mdoc->last->data.block.head)) { + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + return(0); + } else if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + return(0); + + if (NULL == (n = mdoc->last->data.block.body)) { + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY)) + return(0); + } else if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY)) + return(0); + + return(1); + } + + if (NULL == (n = mdoc->last->data.block.head)) { + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + return(0); + } else if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + return(0); + + if ((n = mdoc->last->data.block.body) && n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX_NOBODY)) + return(0); + + /* TODO: make sure columns are aligned. */ + assert(MDOC_Column != sv); + + return(1); + +#undef TYPE_NONE +#undef TYPE_BODY +#undef TYPE_HEAD +} + + +/* Make sure that only `It' macros are our body-children. */ +static int +post_bl(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + if (MDOC_BODY != mdoc->last->type) + return(1); + assert(MDOC_Bl == mdoc->last->tok); + + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_BLOCK == n->type) + if (MDOC_It == n->tok) + continue; + break; + } + if (NULL == n) + return(1); + return(mdoc_verr(mdoc, n, ERR_SYNTAX_CHILDBAD)); +} + + +/* Warn if conventional sections are out of order. */ +static int post_sh(struct mdoc *mdoc) { enum mdoc_sec sec; @@ -258,7 +558,7 @@ post_sh(struct mdoc *mdoc) if (MDOC_HEAD != mdoc->last->type) return(1); - assert(MDOC_Sh == mdoc->last->data.head.tok); + assert(MDOC_Sh == mdoc->last->tok); n = mdoc->last->child; assert(n); @@ -285,28 +585,20 @@ post_sh(struct mdoc *mdoc) int mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) { - int t; + v_pre *p; - 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: + /* TODO: character-escape checks. */ + + if (MDOC_TEXT == node->type) return(1); - } + assert(MDOC_ROOT != node->type); - if (NULL == mdoc_valids[t].pre) + if (NULL == mdoc_valids[node->tok].pre) return(1); - return((*mdoc_valids[t].pre)(mdoc, node)); + for (p = mdoc_valids[node->tok].pre; *p; p++) + if ( ! (*p)(mdoc, node)) + return(0); + return(1); } @@ -314,29 +606,15 @@ int mdoc_valid_post(struct mdoc *mdoc) { v_post *p; - int t; - switch (mdoc->last->type) { - case (MDOC_BODY): - t = mdoc->last->data.body.tok; - break; - 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: + if (MDOC_TEXT == mdoc->last->type) return(1); - } - - if (NULL == mdoc_valids[t].post) + if (MDOC_ROOT == mdoc->last->type) return(1); - for (p = mdoc_valids[t].post; *p; p++) + if (NULL == mdoc_valids[mdoc->last->tok].post) + return(1); + for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) if ( ! (*p)(mdoc)) return(0);