=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.33 retrieving revision 1.35 diff -u -p -r1.33 -r1.35 --- mandoc/Attic/validate.c 2009/01/16 14:04:26 1.33 +++ mandoc/Attic/validate.c 2009/01/16 15:58:50 1.35 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.33 2009/01/16 14:04:26 kristaps Exp $ */ +/* $Id: validate.c,v 1.35 2009/01/16 15:58:50 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -45,22 +45,28 @@ static int pre_it(struct mdoc *, struct mdoc_node *); static int pre_cd(struct mdoc *, struct mdoc_node *); static int pre_er(struct mdoc *, struct mdoc_node *); static int pre_ex(struct mdoc *, struct mdoc_node *); +static int pre_an(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 headchild_err_ge1(struct mdoc *); -static int headchild_warn_ge1(struct mdoc *); -static int headchild_err_eq0(struct mdoc *); -static int elemchild_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 bodychild_err_eq0(struct mdoc *); -static int elemchild_warn_ge1(struct mdoc *); +static int head_err_ge1(struct mdoc *); +static int head_warn_ge1(struct mdoc *); +static int head_err_eq0(struct mdoc *); +static int elem_err_eq0(struct mdoc *); +static int elem_err_le1(struct mdoc *); +static int elem_err_eq1(struct mdoc *); +static int elem_err_ge1(struct mdoc *); +static int elem_warn_eq0(struct mdoc *); +static int body_warn_ge1(struct mdoc *); +static int body_err_eq0(struct mdoc *); +static int elem_warn_ge1(struct mdoc *); +static int elem_bool(struct mdoc *); static int post_sh(struct mdoc *); static int post_bl(struct mdoc *); static int post_it(struct mdoc *); +static int post_ex(struct mdoc *); +static int post_an(struct mdoc *); static v_pre pres_prologue[] = { pre_prologue, NULL }; static v_pre pres_d1[] = { pre_display, NULL }; @@ -72,18 +78,24 @@ static v_pre pres_sh[] = { pre_sh, NULL }; static v_pre pres_cd[] = { pre_cd, NULL }; static v_pre pres_er[] = { pre_er, NULL }; static v_pre pres_ex[] = { pre_ex, NULL }; +static v_pre pres_an[] = { pre_an, NULL }; -static v_post posts_bd[] = { headchild_err_eq0, bodychild_warn_ge1, NULL }; -static v_post posts_text[] = { elemchild_err_ge1, NULL }; -static v_post posts_wtext[] = { elemchild_warn_ge1, NULL }; -static v_post posts_notext[] = { elemchild_err_eq0, NULL }; -static v_post posts_wline[] = { headchild_warn_ge1, bodychild_err_eq0, 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_bool[] = { elem_err_eq1, elem_bool, NULL }; +static v_post posts_bd[] = { head_err_eq0, body_warn_ge1, NULL }; +static v_post posts_text[] = { elem_err_ge1, NULL }; +static v_post posts_wtext[] = { elem_warn_ge1, NULL }; +static v_post posts_notext[] = { elem_err_eq0, NULL }; +static v_post posts_wline[] = { head_warn_ge1, body_err_eq0, NULL }; +static v_post posts_sh[] = { head_err_ge1, + body_warn_ge1, post_sh, NULL }; +static v_post posts_bl[] = { head_err_eq0, + body_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_d1[] = { headchild_err_ge1, NULL }; +static v_post posts_ss[] = { head_err_ge1, NULL }; +static v_post posts_pp[] = { elem_warn_eq0, NULL }; +static v_post posts_d1[] = { head_err_ge1, NULL }; +static v_post posts_ex[] = { elem_err_le1, post_ex, NULL }; +static v_post posts_an[] = { post_an, NULL }; const struct valids mdoc_valids[MDOC_MAX] = { @@ -96,7 +108,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { pres_sh, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */ { pres_ss, posts_ss }, /* Ss */ - /* FIXME: proceeding... */ + /* FIXME: proceeding Pp */ { NULL, posts_pp }, /* Pp */ { pres_d1, posts_d1 }, /* D1 */ { pres_d1, posts_d1 }, /* Dl */ @@ -108,17 +120,17 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* El */ { pres_it, posts_it }, /* It */ { NULL, posts_text }, /* Ad */ - /* FIXME: argument OR parameters. */ - { NULL, NULL }, /* An */ + { pres_an, posts_an }, /* An */ { NULL, NULL }, /* Ar */ { pres_cd, posts_text }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, posts_text }, /* Dv */ { pres_er, posts_text }, /* Er */ { NULL, posts_text }, /* Ev */ - { pres_ex, posts_notext }, /* Ex */ /* FIXME: -std required */ + { pres_ex, posts_ex }, /* Ex */ { NULL, posts_text }, /* Fa */ - { NULL, NULL }, /* Fd */ /* FIXME: SYNOPSIS section. */ + /* FIXME: only in SYNOPSIS section. */ + { NULL, NULL }, /* Fd */ { NULL, NULL }, /* Fl */ { NULL, posts_text }, /* Fn */ { NULL, NULL }, /* Ft */ @@ -126,15 +138,16 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_wtext }, /* In */ { NULL, posts_text }, /* Li */ { NULL, posts_wtext }, /* Nd */ - { NULL, NULL }, /* Nm */ /* FIXME: If name not set? */ + /* FIXME: check that name must be set/provided. */ + { NULL, NULL }, /* Nm */ { NULL, posts_wline }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, NULL }, /* Pa */ - { NULL, posts_notext }, /* Rv */ /* -std required */ - { NULL, posts_notext }, /* St */ /* arg required */ + { NULL, posts_notext }, /* Rv */ /* FIXME: -std required */ + { NULL, posts_notext }, /* St */ /* FIXME: arg required */ { NULL, posts_text }, /* Va */ { NULL, posts_text }, /* Vt */ - { NULL, NULL }, /* Xr */ /* FIXME */ + { NULL, NULL }, /* Xr */ /* FIXME: valid arguments */ { NULL, posts_text }, /* %A */ { NULL, posts_text }, /* %B */ { NULL, posts_text }, /* %D */ @@ -149,14 +162,14 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ac */ { NULL, NULL }, /* Ao */ { NULL, posts_wline }, /* Aq */ - { NULL, NULL }, /* At */ /* FIXME */ + { NULL, NULL }, /* At */ /* FIXME: valid arguments */ { NULL, NULL }, /* Bc */ { NULL, NULL }, /* Bf */ { NULL, NULL }, /* Bo */ { NULL, posts_wline }, /* Bq */ { NULL, NULL }, /* Bsx */ { NULL, NULL }, /* Bx */ - { NULL, NULL }, /* Db */ /* FIXME: boolean */ + { NULL, posts_bool }, /* Db */ { NULL, NULL }, /* Dc */ { NULL, NULL }, /* Do */ { NULL, posts_wline }, /* Dq */ @@ -171,7 +184,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */ /* First should be text. */ + { NULL, NULL }, /* Pf */ { NULL, NULL }, /* Po */ { NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */ { NULL, NULL }, /* Qc */ @@ -183,7 +196,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ { NULL, posts_wline }, /* Sq */ - { NULL, NULL }, /* Sm */ /* FIXME: boolean */ + { NULL, posts_bool }, /* Sm */ { NULL, posts_text }, /* Sx */ { NULL, posts_text }, /* Sy */ { NULL, posts_text }, /* Tn */ @@ -222,20 +235,20 @@ pre_check_parent(struct mdoc *mdoc, struct mdoc_node * int tok, enum mdoc_type type) { - if (type != mdoc->last->parent->type) + if (type != node->parent->type) return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", - mdoc_type2a(mdoc->last->parent->type), + mdoc_type2a(node->parent->type), mdoc_type2a(type))); - if (MDOC_ROOT != type && tok == mdoc->last->parent->tok) + if (MDOC_ROOT != type && tok != node->parent->tok) return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", - mdoc_macronames[mdoc->last->parent->tok], + mdoc_macronames[node->parent->tok], mdoc_macronames[tok])); return(1); } static int -bodychild_err_eq0(struct mdoc *mdoc) +body_err_eq0(struct mdoc *mdoc) { if (MDOC_BODY != mdoc->last->type) @@ -247,7 +260,7 @@ bodychild_err_eq0(struct mdoc *mdoc) static int -bodychild_warn_ge1(struct mdoc *mdoc) +body_warn_ge1(struct mdoc *mdoc) { if (MDOC_BODY != mdoc->last->type) @@ -259,7 +272,7 @@ bodychild_warn_ge1(struct mdoc *mdoc) static int -elemchild_warn_eq0(struct mdoc *mdoc) +elem_warn_eq0(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); @@ -271,7 +284,7 @@ elemchild_warn_eq0(struct mdoc *mdoc) static int -elemchild_warn_ge1(struct mdoc *mdoc) +elem_warn_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); @@ -282,18 +295,44 @@ elemchild_warn_ge1(struct mdoc *mdoc) static int -elemchild_err_eq0(struct mdoc *mdoc) +elem_err_eq1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); if (NULL == mdoc->last->child) + return(mdoc_err(mdoc, "macro expects one parameter")); + if (mdoc->last->child->next) + return(mdoc_err(mdoc, "macro expects one parameter")); + return(1); +} + + +static int +elem_err_le1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + if (NULL == mdoc->last->child) return(1); + if (NULL == mdoc->last->child->next) + return(1); + return(mdoc_err(mdoc, "macro expects one or fewer parameters")); +} + + +static int +elem_err_eq0(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + if (NULL == mdoc->last->child) + return(1); return(mdoc_err(mdoc, "macro expects no parameters")); } static int -elemchild_err_ge1(struct mdoc *mdoc) +elem_err_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); @@ -304,7 +343,7 @@ elemchild_err_ge1(struct mdoc *mdoc) static int -headchild_err_eq0(struct mdoc *mdoc) +head_err_eq0(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) @@ -317,7 +356,7 @@ headchild_err_eq0(struct mdoc *mdoc) static int -headchild_warn_ge1(struct mdoc *mdoc) +head_warn_ge1(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) @@ -329,7 +368,7 @@ headchild_warn_ge1(struct mdoc *mdoc) static int -headchild_err_ge1(struct mdoc *mdoc) +head_err_ge1(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) @@ -465,9 +504,8 @@ static int pre_ss(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Sh == mdoc->last->tok); return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); } @@ -476,22 +514,49 @@ static int pre_sh(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Sh == mdoc->last->tok); return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); } static int +pre_an(struct mdoc *mdoc, struct mdoc_node *node) +{ + assert(MDOC_ELEM == node->type); + assert(MDOC_An == node->tok); + if (1 >= node->data.elem.argc) + return(1); + return(mdoc_nerr(mdoc, node, "macro may only have one argument")); +} + + +static int pre_ex(struct mdoc *mdoc, struct mdoc_node *node) { enum mdoc_msec msecs[3]; + assert(MDOC_ELEM == node->type); + msecs[0] = MSEC_1; msecs[1] = MSEC_6; msecs[2] = MSEC_8; - return(pre_check_msecs(mdoc, node, 3, msecs)); + if ( ! pre_check_msecs(mdoc, node, 3, msecs)) + return(0); + + if (1 != node->data.elem.argc) { + if ( ! mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests `%s' argument", + mdoc_argnames[MDOC_Std])) + return(0); + return(1); + } + if (MDOC_Std != node->data.elem.argv[0].arg) + if ( ! mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests `%s' argument", + mdoc_argnames[MDOC_Std])) + return(0); + return(1); } @@ -519,9 +584,8 @@ static int pre_it(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_It == mdoc->last->tok); return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); } @@ -578,6 +642,51 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node } +static int +post_an(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_An == mdoc->last->tok); + + if (0 != mdoc->last->data.elem.argc) { + if (NULL == mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects either argument or parameters")); + } + + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects either argument or parameters")); +} + + +static int +post_ex(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Ex == mdoc->last->tok); + + if (0 == mdoc->last->data.elem.argc) { + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + } + if (mdoc->last->child) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + if (1 != mdoc->last->data.elem.argc) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + if (MDOC_Std != mdoc->last->data.elem.argv[0].arg) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + return(1); +} + + /* Warn if `Bl' type-specific syntax isn't reflected in items. */ static int post_it(struct mdoc *mdoc) @@ -686,7 +795,6 @@ post_it(struct mdoc *mdoc) if (i == (size_t)sv) return(1); return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i)); - #undef TYPE_NONE #undef TYPE_BODY #undef TYPE_HEAD @@ -712,6 +820,27 @@ post_bl(struct mdoc *mdoc) if (NULL == n) return(1); return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'")); +} + + +static int +elem_bool(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(MDOC_ELEM == mdoc->last->type); + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_TEXT != n->type) + break; + if (xstrcmp(n->data.text.string, "on")) + continue; + if (xstrcmp(n->data.text.string, "off")) + continue; + break; + } + if (NULL == n) + return(1); + return(mdoc_nerr(mdoc, n, "expected boolean value [on/off]")); }