=================================================================== RCS file: /cvs/mandoc/man_validate.c,v retrieving revision 1.88 retrieving revision 1.107 diff -u -p -r1.88 -r1.107 --- mandoc/man_validate.c 2014/01/06 22:39:25 1.88 +++ mandoc/man_validate.c 2014/11/28 05:51:32 1.107 @@ -1,4 +1,4 @@ -/* $Id: man_validate.c,v 1.88 2014/01/06 22:39:25 schwarze Exp $ */ +/* $OpenBSD: man_validate.c,v 1.107 2014/11/28 05:51:32 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze @@ -15,9 +15,7 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include @@ -32,190 +30,132 @@ #include "man.h" #include "mandoc.h" +#include "mandoc_aux.h" #include "libman.h" #include "libmandoc.h" #define CHKARGS struct man *man, struct man_node *n -typedef int (*v_check)(CHKARGS); +typedef void (*v_check)(CHKARGS); -struct man_valid { - v_check *pres; - v_check *posts; -}; - -static int check_eq0(CHKARGS); -static int check_eq2(CHKARGS); -static int check_le1(CHKARGS); -static int check_ge2(CHKARGS); -static int check_le5(CHKARGS); -static int check_head1(CHKARGS); -static int check_par(CHKARGS); -static int check_part(CHKARGS); -static int check_root(CHKARGS); +static void check_eq0(CHKARGS); +static void check_eq2(CHKARGS); +static void check_le1(CHKARGS); +static void check_le5(CHKARGS); +static void check_par(CHKARGS); +static void check_part(CHKARGS); +static void check_root(CHKARGS); static void check_text(CHKARGS); -static int post_AT(CHKARGS); -static int post_IP(CHKARGS); -static int post_vs(CHKARGS); -static int post_fi(CHKARGS); -static int post_ft(CHKARGS); -static int post_nf(CHKARGS); -static int post_sec(CHKARGS); -static int post_TH(CHKARGS); -static int post_UC(CHKARGS); -static int pre_sec(CHKARGS); +static void post_AT(CHKARGS); +static void post_IP(CHKARGS); +static void post_vs(CHKARGS); +static void post_fi(CHKARGS); +static void post_ft(CHKARGS); +static void post_nf(CHKARGS); +static void post_TH(CHKARGS); +static void post_UC(CHKARGS); +static void post_UR(CHKARGS); -static v_check posts_at[] = { post_AT, NULL }; -static v_check posts_br[] = { post_vs, check_eq0, NULL }; -static v_check posts_eq0[] = { check_eq0, NULL }; -static v_check posts_eq2[] = { check_eq2, NULL }; -static v_check posts_fi[] = { check_eq0, post_fi, NULL }; -static v_check posts_ft[] = { post_ft, NULL }; -static v_check posts_ip[] = { post_IP, NULL }; -static v_check posts_le1[] = { check_le1, NULL }; -static v_check posts_nf[] = { check_eq0, post_nf, NULL }; -static v_check posts_par[] = { check_par, NULL }; -static v_check posts_part[] = { check_part, NULL }; -static v_check posts_sec[] = { post_sec, NULL }; -static v_check posts_sp[] = { post_vs, check_le1, NULL }; -static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL }; -static v_check posts_uc[] = { post_UC, NULL }; -static v_check posts_ur[] = { check_head1, check_part, NULL }; -static v_check pres_sec[] = { pre_sec, NULL }; - -static const struct man_valid man_valids[MAN_MAX] = { - { NULL, posts_br }, /* br */ - { NULL, posts_th }, /* TH */ - { pres_sec, posts_sec }, /* SH */ - { pres_sec, posts_sec }, /* SS */ - { NULL, NULL }, /* TP */ - { NULL, posts_par }, /* LP */ - { NULL, posts_par }, /* PP */ - { NULL, posts_par }, /* P */ - { NULL, posts_ip }, /* IP */ - { NULL, NULL }, /* HP */ - { NULL, NULL }, /* SM */ - { NULL, NULL }, /* SB */ - { NULL, NULL }, /* BI */ - { NULL, NULL }, /* IB */ - { NULL, NULL }, /* BR */ - { NULL, NULL }, /* RB */ - { NULL, NULL }, /* R */ - { NULL, NULL }, /* B */ - { NULL, NULL }, /* I */ - { NULL, NULL }, /* IR */ - { NULL, NULL }, /* RI */ - { NULL, posts_eq0 }, /* na */ - { NULL, posts_sp }, /* sp */ - { NULL, posts_nf }, /* nf */ - { NULL, posts_fi }, /* fi */ - { NULL, NULL }, /* RE */ - { NULL, posts_part }, /* RS */ - { NULL, NULL }, /* DT */ - { NULL, posts_uc }, /* UC */ - { NULL, posts_le1 }, /* PD */ - { NULL, posts_at }, /* AT */ - { NULL, NULL }, /* in */ - { NULL, posts_ft }, /* ft */ - { NULL, posts_eq2 }, /* OP */ - { NULL, posts_nf }, /* EX */ - { NULL, posts_fi }, /* EE */ - { NULL, posts_ur }, /* UR */ - { NULL, NULL }, /* UE */ +static v_check man_valids[MAN_MAX] = { + post_vs, /* br */ + post_TH, /* TH */ + NULL, /* SH */ + NULL, /* SS */ + NULL, /* TP */ + check_par, /* LP */ + check_par, /* PP */ + check_par, /* P */ + post_IP, /* IP */ + NULL, /* HP */ + NULL, /* SM */ + NULL, /* SB */ + NULL, /* BI */ + NULL, /* IB */ + NULL, /* BR */ + NULL, /* RB */ + NULL, /* R */ + NULL, /* B */ + NULL, /* I */ + NULL, /* IR */ + NULL, /* RI */ + check_eq0, /* na */ + post_vs, /* sp */ + post_nf, /* nf */ + post_fi, /* fi */ + NULL, /* RE */ + check_part, /* RS */ + NULL, /* DT */ + post_UC, /* UC */ + check_le1, /* PD */ + post_AT, /* AT */ + NULL, /* in */ + post_ft, /* ft */ + check_eq2, /* OP */ + post_nf, /* EX */ + post_fi, /* EE */ + post_UR, /* UR */ + NULL, /* UE */ + NULL, /* ll */ }; -int -man_valid_pre(struct man *man, struct man_node *n) -{ - v_check *cp; - - switch (n->type) { - case (MAN_TEXT): - /* FALLTHROUGH */ - case (MAN_ROOT): - /* FALLTHROUGH */ - case (MAN_EQN): - /* FALLTHROUGH */ - case (MAN_TBL): - return(1); - default: - break; - } - - if (NULL == (cp = man_valids[n->tok].pres)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(man, n)) - return(0); - return(1); -} - - -int +void man_valid_post(struct man *man) { + struct man_node *n; v_check *cp; - if (MAN_VALID & man->last->flags) - return(1); - man->last->flags |= MAN_VALID; + n = man->last; + if (n->flags & MAN_VALID) + return; + n->flags |= MAN_VALID; - switch (man->last->type) { - case (MAN_TEXT): - check_text(man, man->last); - return(1); - case (MAN_ROOT): - return(check_root(man, man->last)); - case (MAN_EQN): + switch (n->type) { + case MAN_TEXT: + check_text(man, n); + break; + case MAN_ROOT: + check_root(man, n); + break; + case MAN_EQN: /* FALLTHROUGH */ - case (MAN_TBL): - return(1); + case MAN_TBL: + break; default: + cp = man_valids + n->tok; + if (*cp) + (*cp)(man, n); break; } - - if (NULL == (cp = man_valids[man->last->tok].posts)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(man, man->last)) - return(0); - - return(1); } - -static int -check_root(CHKARGS) +static void +check_root(CHKARGS) { - if (MAN_BLINE & man->flags) - man_nmsg(man, n, MANDOCERR_SCOPEEXIT); - else if (MAN_ELINE & man->flags) - man_nmsg(man, n, MANDOCERR_SCOPEEXIT); + assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); - man->flags &= ~MAN_BLINE; - man->flags &= ~MAN_ELINE; + if (NULL == man->first->child) + mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse, + n->line, n->pos, NULL); + else + man->meta.hasbody = 1; - if (NULL == man->first->child) { - man_nmsg(man, n, MANDOCERR_NODOCBODY); - return(0); - } else if (NULL == man->meta.title) { - man_nmsg(man, n, MANDOCERR_NOTITLE); + if (NULL == man->meta.title) { + mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, + n->line, n->pos, NULL); /* * If a title hasn't been set, do so now (by * implication, date and section also aren't set). */ - man->meta.title = mandoc_strdup("unknown"); - man->meta.msec = mandoc_strdup("1"); + man->meta.title = mandoc_strdup(""); + man->meta.msec = mandoc_strdup(""); man->meta.date = man->quick ? mandoc_strdup("") : mandoc_normdate(man->parse, NULL, n->line, n->pos); } - - return(1); } static void @@ -228,71 +168,69 @@ check_text(CHKARGS) cp = n->string; for (p = cp; NULL != (p = strchr(p, '\t')); p++) - man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB); + mandoc_msg(MANDOCERR_FI_TAB, man->parse, + n->line, n->pos + (p - cp), NULL); } #define INEQ_DEFINE(x, ineq, name) \ -static int \ +static void \ check_##name(CHKARGS) \ { \ if (n->nchild ineq (x)) \ - return(1); \ + return; \ mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \ - "line arguments %s %d (have %d)", \ - #ineq, (x), n->nchild); \ - return(1); \ + "line arguments %s %d (have %d)", \ + #ineq, (x), n->nchild); \ } INEQ_DEFINE(0, ==, eq0) INEQ_DEFINE(2, ==, eq2) INEQ_DEFINE(1, <=, le1) -INEQ_DEFINE(2, >=, ge2) INEQ_DEFINE(5, <=, le5) -static int -check_head1(CHKARGS) +static void +post_UR(CHKARGS) { if (MAN_HEAD == n->type && 1 != n->nchild) mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, "line arguments eq 1 (have %d)", n->nchild); - - return(1); + check_part(man, n); } -static int +static void post_ft(CHKARGS) { char *cp; int ok; if (0 == n->nchild) - return(1); + return; ok = 0; cp = n->child->string; switch (*cp) { - case ('1'): + case '1': /* FALLTHROUGH */ - case ('2'): + case '2': /* FALLTHROUGH */ - case ('3'): + case '3': /* FALLTHROUGH */ - case ('4'): + case '4': /* FALLTHROUGH */ - case ('I'): + case 'I': /* FALLTHROUGH */ - case ('P'): + case 'P': /* FALLTHROUGH */ - case ('R'): + case 'R': if ('\0' == cp[1]) ok = 1; break; - case ('B'): + case 'B': if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2])) ok = 1; break; - case ('C'): + case 'C': if ('W' == cp[1] && '\0' == cp[2]) ok = 1; break; @@ -301,101 +239,81 @@ post_ft(CHKARGS) } if (0 == ok) { - mandoc_vmsg - (MANDOCERR_BADFONT, man->parse, - n->line, n->pos, "%s", cp); + mandoc_vmsg(MANDOCERR_FT_BAD, man->parse, + n->line, n->pos, "ft %s", cp); *cp = '\0'; } if (1 < n->nchild) - mandoc_vmsg - (MANDOCERR_ARGCOUNT, man->parse, n->line, - n->pos, "want one child (have %d)", - n->nchild); - - return(1); + mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, + n->pos, "want one child (have %d)", n->nchild); } -static int -pre_sec(CHKARGS) -{ - - if (MAN_BLOCK == n->type) - man->flags &= ~MAN_LITERAL; - return(1); -} - -static int -post_sec(CHKARGS) -{ - - if ( ! (MAN_HEAD == n->type && 0 == n->nchild)) - return(1); - - man_nmsg(man, n, MANDOCERR_SYNTARGCOUNT); - return(0); -} - -static int +static void check_part(CHKARGS) { if (MAN_BODY == n->type && 0 == n->nchild) - mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line, - n->pos, "want children (have none)"); - - return(1); + mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line, + n->pos, "want children (have none)"); } - -static int +static void check_par(CHKARGS) { switch (n->type) { - case (MAN_BLOCK): + case MAN_BLOCK: if (0 == n->body->nchild) man_node_delete(man, n); break; - case (MAN_BODY): + case MAN_BODY: if (0 == n->nchild) - man_nmsg(man, n, MANDOCERR_IGNPAR); + mandoc_vmsg(MANDOCERR_PAR_SKIP, + man->parse, n->line, n->pos, + "%s empty", man_macronames[n->tok]); break; - case (MAN_HEAD): + case MAN_HEAD: if (n->nchild) - man_nmsg(man, n, MANDOCERR_ARGSLOST); + mandoc_vmsg(MANDOCERR_ARG_SKIP, + man->parse, n->line, n->pos, + "%s %s%s", man_macronames[n->tok], + n->child->string, + n->nchild > 1 ? " ..." : ""); break; default: break; } - - return(1); } -static int +static void post_IP(CHKARGS) { switch (n->type) { - case (MAN_BLOCK): + case MAN_BLOCK: if (0 == n->head->nchild && 0 == n->body->nchild) man_node_delete(man, n); break; - case (MAN_BODY): + case MAN_BODY: if (0 == n->parent->head->nchild && 0 == n->nchild) - man_nmsg(man, n, MANDOCERR_IGNPAR); + mandoc_vmsg(MANDOCERR_PAR_SKIP, + man->parse, n->line, n->pos, + "%s empty", man_macronames[n->tok]); break; default: break; } - return(1); } -static int +static void post_TH(CHKARGS) { + struct man_node *nb; const char *p; + check_le5(man, n); + free(man->meta.title); free(man->meta.vol); free(man->meta.source); @@ -403,23 +321,31 @@ post_TH(CHKARGS) free(man->meta.date); man->meta.title = man->meta.vol = man->meta.date = - man->meta.msec = man->meta.source = NULL; + man->meta.msec = man->meta.source = NULL; + nb = n; + /* ->TITLE<- MSEC DATE SOURCE VOL */ n = n->child; if (n && n->string) { for (p = n->string; '\0' != *p; p++) { /* Only warn about this once... */ - if (isalpha((unsigned char)*p) && - ! isupper((unsigned char)*p)) { - man_nmsg(man, n, MANDOCERR_UPPERCASE); + if (isalpha((unsigned char)*p) && + ! isupper((unsigned char)*p)) { + mandoc_vmsg(MANDOCERR_TITLE_CASE, + man->parse, n->line, + n->pos + (p - n->string), + "TH %s", n->string); break; } } man->meta.title = mandoc_strdup(n->string); - } else + } else { man->meta.title = mandoc_strdup(""); + mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, + nb->line, nb->pos, "TH"); + } /* TITLE ->MSEC<- DATE SOURCE VOL */ @@ -427,8 +353,11 @@ post_TH(CHKARGS) n = n->next; if (n && n->string) man->meta.msec = mandoc_strdup(n->string); - else + else { man->meta.msec = mandoc_strdup(""); + mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse, + nb->line, nb->pos, "TH %s", man->meta.title); + } /* TITLE MSEC ->DATE<- SOURCE VOL */ @@ -439,8 +368,12 @@ post_TH(CHKARGS) mandoc_strdup(n->string) : mandoc_normdate(man->parse, n->string, n->line, n->pos); - } else + } else { man->meta.date = mandoc_strdup(""); + mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, + n ? n->line : nb->line, + n ? n->pos : nb->pos, "TH"); + } /* TITLE MSEC DATE ->SOURCE<- VOL */ @@ -461,32 +394,35 @@ post_TH(CHKARGS) * meta-data. */ man_node_delete(man, man->last); - return(1); } -static int +static void post_nf(CHKARGS) { + check_eq0(man, n); + if (MAN_LITERAL & man->flags) - man_nmsg(man, n, MANDOCERR_SCOPEREP); + mandoc_msg(MANDOCERR_NF_SKIP, man->parse, + n->line, n->pos, "nf"); man->flags |= MAN_LITERAL; - return(1); } -static int +static void post_fi(CHKARGS) { + check_eq0(man, n); + if ( ! (MAN_LITERAL & man->flags)) - man_nmsg(man, n, MANDOCERR_WNOSCOPE); + mandoc_msg(MANDOCERR_FI_SKIP, man->parse, + n->line, n->pos, "fi"); man->flags &= ~MAN_LITERAL; - return(1); } -static int +static void post_UC(CHKARGS) { static const char * const bsd_versions[] = { @@ -521,10 +457,9 @@ post_UC(CHKARGS) free(man->meta.source); man->meta.source = mandoc_strdup(p); - return(1); } -static int +static void post_AT(CHKARGS) { static const char * const unix_versions[] = { @@ -559,24 +494,30 @@ post_AT(CHKARGS) free(man->meta.source); man->meta.source = mandoc_strdup(p); - return(1); } -static int +static void post_vs(CHKARGS) { + if (n->tok == MAN_br) + check_eq0(man, n); + else + check_le1(man, n); + if (NULL != n->prev) - return(1); + return; switch (n->parent->tok) { - case (MAN_SH): + case MAN_SH: /* FALLTHROUGH */ - case (MAN_SS): - man_nmsg(man, n, MANDOCERR_IGNPAR); + case MAN_SS: + mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos, + "%s after %s", man_macronames[n->tok], + man_macronames[n->parent->tok]); /* FALLTHROUGH */ - case (MAN_MAX): - /* + case MAN_MAX: + /* * Don't warn about this because it occurs in pod2man * and would cause considerable (unfixable) warnage. */ @@ -585,6 +526,4 @@ post_vs(CHKARGS) default: break; } - - return(1); }