=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.28 retrieving revision 1.36 diff -u -p -r1.28 -r1.36 --- mandoc/Attic/validate.c 2009/01/14 11:58:24 1.28 +++ mandoc/Attic/validate.c 2009/01/17 16:15:27 1.36 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.28 2009/01/14 11:58:24 kristaps Exp $ */ +/* $Id: validate.c,v 1.36 2009/01/17 16:15:27 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -26,50 +26,95 @@ typedef int (*v_pre)(struct mdoc *, struct mdoc_node * typedef int (*v_post)(struct mdoc *); +/* FIXME: some sections should only occur in specific msecs. */ +/* FIXME: ignoring Pp. */ +/* FIXME: math symbols. */ + struct valids { v_pre *pre; v_post *post; }; +static int pre_check_parent(struct mdoc *, struct mdoc_node *, + int, enum mdoc_type); +static int pre_check_msecs(struct mdoc *, struct mdoc_node *, + int, enum mdoc_msec *); +static int pre_check_stdarg(struct mdoc *, struct mdoc_node *); +static int post_check_children_count(struct mdoc *); +static int post_check_children_lt(struct mdoc *, int); +static int post_check_children_gt(struct mdoc *, int); +static int post_check_children_eq(struct mdoc *, int); static int pre_display(struct mdoc *, struct mdoc_node *); +static int pre_sh(struct mdoc *, struct mdoc_node *); +static int pre_ss(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_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_rv(struct mdoc *, struct mdoc_node *); +static int pre_an(struct mdoc *, struct mdoc_node *); +static int pre_st(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_le2(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 int post_at(struct mdoc *); +static int post_xr(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_pre pres_it[] = { pre_it, NULL }; +static v_pre pres_ss[] = { pre_ss, NULL }; +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_rv[] = { pre_rv, NULL }; +static v_pre pres_an[] = { pre_an, NULL }; +static v_pre pres_st[] = { pre_st, 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 }; +static v_post posts_at[] = { elem_err_eq1, post_at, NULL }; +static v_post posts_xr[] = { elem_err_ge1, elem_err_le2, + post_xr, NULL }; const struct valids mdoc_valids[MDOC_MAX] = { @@ -77,37 +122,29 @@ const struct valids mdoc_valids[MDOC_MAX] = { { pres_prologue, posts_text }, /* Dd */ { pres_prologue, NULL }, /* Dt */ { pres_prologue, NULL }, /* Os */ - /* FIXME: preceding Pp. */ /* FIXME: NAME section internal ordering. */ - /* FIXME: can only be a child of root. */ - { NULL, posts_sh }, /* Sh */ - /* FIXME: preceding Pp. */ - /* FIXME: can only be a child of Sh. */ - { NULL, posts_ss }, /* Ss */ - /* FIXME: proceeding... */ + { pres_sh, posts_sh }, /* Sh */ + { pres_ss, posts_ss }, /* Ss */ { NULL, posts_pp }, /* Pp */ { pres_d1, posts_d1 }, /* D1 */ { pres_d1, posts_d1 }, /* Dl */ - /* FIXME: preceding Pp. */ { pres_bd, posts_bd }, /* Bd */ { NULL, NULL }, /* Ed */ - /* FIXME: preceding Pp. */ { pres_bl, posts_bl }, /* Bl */ { NULL, NULL }, /* El */ { pres_it, posts_it }, /* It */ { NULL, posts_text }, /* Ad */ - /* FIXME */ - { NULL, NULL }, /* An */ + { pres_an, posts_an }, /* An */ { NULL, NULL }, /* Ar */ - - { NULL, posts_text }, /* Cd */ /* FIXME: section 4 only. */ + { pres_cd, posts_text }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, posts_text }, /* Dv */ - { NULL, posts_text }, /* Er */ /* FIXME: section 2 only. */ + { pres_er, posts_text }, /* Er */ { NULL, posts_text }, /* Ev */ - { NULL, posts_notext }, /* Ex */ /* FIXME: sections 1,6,8 only. */ /* -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 */ @@ -115,15 +152,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 */ + { pres_rv, posts_notext }, /* Rv */ + { pres_st, posts_notext }, /* St */ { NULL, posts_text }, /* Va */ { NULL, posts_text }, /* Vt */ - { NULL, NULL }, /* Xr */ /* FIXME */ + { NULL, posts_xr }, /* Xr */ { NULL, posts_text }, /* %A */ { NULL, posts_text }, /* %B */ { NULL, posts_text }, /* %D */ @@ -138,14 +176,14 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ac */ { NULL, NULL }, /* Ao */ { NULL, posts_wline }, /* Aq */ - { NULL, NULL }, /* At */ /* FIXME */ + { NULL, posts_at }, /* At */ { 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 */ @@ -154,15 +192,15 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_text }, /* Em */ { NULL, NULL }, /* Eo */ { NULL, NULL }, /* Fx */ - { NULL, posts_text }, /* Ms */ /* FIXME: which symbols? */ + { NULL, posts_text }, /* Ms */ { NULL, posts_notext }, /* No */ { NULL, posts_notext }, /* Ns */ { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */ + { NULL, NULL }, /* Pf */ { NULL, NULL }, /* Po */ - { NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */ + { NULL, posts_wline }, /* Pq */ { NULL, NULL }, /* Qc */ { NULL, posts_wline }, /* Ql */ { NULL, NULL }, /* Qo */ @@ -172,7 +210,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 */ @@ -193,108 +231,218 @@ const struct valids mdoc_valids[MDOC_MAX] = { static int -bodychild_err_eq0(struct mdoc *mdoc) +post_check_children_count(struct mdoc *mdoc) { + struct mdoc_node *n; + int i; + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + return(i); +} + + +static int +post_check_children_gt(struct mdoc *mdoc, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) > sz) + return(1); + return(mdoc_err(mdoc, "macro requires more than %d " + "parameters (have %d)", sz, i)); +} + + +static int +post_check_children_eq(struct mdoc *mdoc, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) == sz) + return(1); + return(mdoc_err(mdoc, "macro requires %d parameters " + "(have %d)", sz, i)); +} + + +static int +post_check_children_lt(struct mdoc *mdoc, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) < sz) + return(1); + return(mdoc_err(mdoc, "macro requires less than %d " + "parameters (have %d)", sz, i)); +} + + +static int +pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (1 == node->data.elem.argc && + MDOC_Std == node->data.elem.argv[0].arg) + return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests single `%s' argument", + mdoc_argnames[MDOC_Std])); +} + + +static int +pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, + int sz, enum mdoc_msec *msecs) +{ + int i; + + for (i = 0; i < sz; i++) + if (msecs[i] == mdoc->meta.msec) + return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro is not appropriate for this manual section")); +} + + +static int +pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, + int tok, enum mdoc_type type) +{ + + if (type != node->parent->type) + return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", + mdoc_type2a(node->parent->type), + mdoc_type2a(type))); + if (MDOC_ROOT != type && tok != node->parent->tok) + return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", + mdoc_macronames[node->parent->tok], + mdoc_macronames[tok])); + return(1); +} + + +static int +body_err_eq0(struct mdoc *mdoc) +{ + if (MDOC_BODY != mdoc->last->type) return(1); if (NULL == mdoc->last->child) return(1); - return(mdoc_warn(mdoc, WARN_ARGS_EQ0)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children")); } static int -bodychild_warn_ge1(struct mdoc *mdoc) +body_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, WARN_SYNTAX, "macro suggests one or more body children")); } static int -elemchild_warn_eq0(struct mdoc *mdoc) +elem_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)); + mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters")); } static int -elemchild_warn_ge1(struct mdoc *mdoc) +elem_warn_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); if (mdoc->last->child) return(1); - return(mdoc_warn(mdoc, WARN_ARGS_GE1)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters")); } 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(1); - return(mdoc_err(mdoc, ERR_ARGS_EQ0)); + return(post_check_children_eq(mdoc, 1)); } static int -elemchild_err_ge1(struct mdoc *mdoc) +elem_err_le2(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - if (mdoc->last->child) - return(1); - return(mdoc_err(mdoc, ERR_ARGS_GE1)); + return(post_check_children_lt(mdoc, 3)); } static int -headchild_err_eq0(struct mdoc *mdoc) +elem_err_le1(struct mdoc *mdoc) { + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, 2)); +} + + +static int +elem_err_eq0(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, 0)); +} + + +static int +elem_err_ge1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_gt(mdoc, 0)); +} + + +static int +head_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)); + return(post_check_children_eq(mdoc, 0)); } static int -headchild_warn_ge1(struct mdoc *mdoc) +head_warn_ge1(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) return(1); if (mdoc->last->child) return(1); - return(mdoc_warn(mdoc, WARN_ARGS_GE1)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters")); } static int -headchild_err_ge1(struct mdoc *mdoc) +head_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)); + return(post_check_children_gt(mdoc, 0)); } @@ -306,13 +454,14 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node) if (MDOC_BLOCK != node->type) return(1); - for (n = mdoc->last; n; n = n->parent) + assert(mdoc->last); + for (n = mdoc->last->parent; 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)); + return(mdoc_nerr(mdoc, node, "displays may not be nested")); } @@ -364,12 +513,12 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) } } if (0 == type) - return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + return(mdoc_err(mdoc, "no list type specified")); if (0 == err) return(1); assert(argv); return(mdoc_perr(mdoc, argv->line, - argv->pos, ERR_SYNTAX_ARGBAD)); + argv->pos, "only one list type possible")); } @@ -395,6 +544,8 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) /* FALLTHROUGH */ case (MDOC_Unfilled): /* FALLTHROUGH */ + case (MDOC_Filled): + /* FALLTHROUGH */ case (MDOC_Literal): /* FALLTHROUGH */ case (MDOC_File): @@ -407,55 +558,145 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) } } if (0 == type) - return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + return(mdoc_err(mdoc, "no display type specified")); if (0 == err) return(1); assert(argv); return(mdoc_perr(mdoc, argv->line, - argv->pos, ERR_SYNTAX_ARGBAD)); + argv->pos, "only one display type possible")); } static int -pre_it(struct mdoc *mdoc, struct mdoc_node *node) +pre_ss(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_Sh, MDOC_BODY)); +} - 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_sh(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); } static int +pre_st(struct mdoc *mdoc, struct mdoc_node *node) +{ + + assert(MDOC_ELEM == node->type); + assert(MDOC_St == node->tok); + if (1 == node->data.elem.argc) + return(1); + return(mdoc_nerr(mdoc, node, "macro must have one argument")); +} + + +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_rv(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[2]; + + assert(MDOC_ELEM == node->type); + assert(MDOC_Rv == node->tok); + + msecs[0] = MSEC_2; + msecs[1] = MSEC_3; + if ( ! pre_check_msecs(mdoc, node, 2, msecs)) + return(0); + return(pre_check_stdarg(mdoc, node)); +} + + +static int +pre_ex(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[3]; + + assert(MDOC_ELEM == node->type); + assert(MDOC_Ex == node->tok); + + msecs[0] = MSEC_1; + msecs[1] = MSEC_6; + msecs[2] = MSEC_8; + if ( ! pre_check_msecs(mdoc, node, 3, msecs)) + return(0); + return(pre_check_stdarg(mdoc, node)); +} + + +static int +pre_er(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; + + msecs[0] = MSEC_2; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} + + +static int +pre_cd(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; + + msecs[0] = MSEC_4; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} + + +static int +pre_it(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); +} + + +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)); + return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); assert(MDOC_ELEM == node->type); /* Check for ordering. */ switch (node->tok) { case (MDOC_Os): - if (mdoc->meta.title[0] && mdoc->meta.date) + if (mdoc->meta.title && mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); case (MDOC_Dt): - if (0 == mdoc->meta.title[0] && mdoc->meta.date) + if (NULL == mdoc->meta.title && mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); case (MDOC_Dd): - if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date) + if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); default: abort(); /* NOTREACHED */ @@ -465,7 +706,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node switch (node->tok) { case (MDOC_Os): - if (0 == mdoc->meta.os[0]) + if (NULL == mdoc->meta.os) return(1); break; case (MDOC_Dd): @@ -473,7 +714,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node return(1); break; case (MDOC_Dt): - if (0 == mdoc->meta.title[0]) + if (NULL == mdoc->meta.title) return(1); break; default: @@ -481,10 +722,89 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node /* NOTREACHED */ } - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP)); + return(mdoc_nerr(mdoc, node, "prologue macro repeated")); } +static int +post_xr(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Xr == mdoc->last->tok); + assert(mdoc->last->child); + assert(MDOC_TEXT == mdoc->last->child->type); + + if (NULL == (n = mdoc->last->child->next)) + return(1); + assert(MDOC_TEXT == n->type); + if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string)) + return(1); + return(mdoc_nerr(mdoc, n, "invalid manual section")); +} + + +static int +post_at(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_At == mdoc->last->tok); + assert(mdoc->last->child); + assert(MDOC_TEXT == mdoc->last->child->type); + + if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) + return(1); + return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol")); +} + + +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) @@ -549,32 +869,34 @@ post_it(struct mdoc *mdoc) assert(TYPE_NONE != type); if (TYPE_HEAD == type) { - if (NULL == (n = mdoc->last->data.block.head)) { - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + n = mdoc->last->data.block.head; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) 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)) + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) 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)) + assert(TYPE_BODY == type); + assert(mdoc->last->data.block.head); + + n = mdoc->last->data.block.head; + assert(n); + if (n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters")) 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)) + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) return(0); if (MDOC_Column != sv) @@ -590,8 +912,7 @@ post_it(struct mdoc *mdoc) if (i == (size_t)sv) return(1); - return(mdoc_err(mdoc, ERR_SYNTAX_ARGFORM)); - + return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i)); #undef TYPE_NONE #undef TYPE_BODY #undef TYPE_HEAD @@ -616,43 +937,52 @@ post_bl(struct mdoc *mdoc) } if (NULL == n) return(1); - return(mdoc_verr(mdoc, n, ERR_SYNTAX_CHILDBAD)); + 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]")); +} + + /* Warn if conventional sections are out of order. */ static int post_sh(struct mdoc *mdoc) { + char buf[64]; 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->tok); - n = mdoc->last->child; - assert(n); + if ( ! xstrlcats(buf, mdoc->last->child, 64)) + return(mdoc_err(mdoc, "macro parameters too long")); - 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) + if (SEC_CUSTOM == (sec = mdoc_atosec(buf))) 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)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); + return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); } @@ -683,8 +1013,10 @@ mdoc_valid_post(struct mdoc *mdoc) if (MDOC_TEXT == mdoc->last->type) return(1); - if (MDOC_ROOT == mdoc->last->type) + if (MDOC_ROOT == mdoc->last->type) { + /* TODO: make sure prologue is complete. */ return(1); + } if (NULL == mdoc_valids[mdoc->last->tok].post) return(1);