=================================================================== RCS file: /cvs/mandoc/man_validate.c,v retrieving revision 1.48 retrieving revision 1.109 diff -u -p -r1.48 -r1.109 --- mandoc/man_validate.c 2010/07/31 23:52:58 1.48 +++ mandoc/man_validate.c 2015/01/24 02:41:49 1.109 @@ -1,6 +1,7 @@ -/* $Id: man_validate.c,v 1.48 2010/07/31 23:52:58 schwarze Exp $ */ +/* $OpenBSD: man_validate.c,v 1.109 2015/01/24 02:41:49 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,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 @@ -27,314 +26,505 @@ #include #include #include +#include +#include "man.h" #include "mandoc.h" +#include "mandoc_aux.h" #include "libman.h" #include "libmandoc.h" -#define CHKARGS struct man *m, struct man_node *n +#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 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 check_bline(CHKARGS); -static int check_eq0(CHKARGS); -static int check_le1(CHKARGS); -static int check_ge2(CHKARGS); -static int check_le5(CHKARGS); -static int check_par(CHKARGS); -static int check_part(CHKARGS); -static int check_root(CHKARGS); -static int check_sec(CHKARGS); -static int check_text(CHKARGS); -static int check_title(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_eq0[] = { check_eq0, NULL }; -static v_check posts_th[] = { check_ge2, check_le5, check_title, NULL }; -static v_check posts_par[] = { check_par, NULL }; -static v_check posts_part[] = { check_part, NULL }; -static v_check posts_sec[] = { check_sec, NULL }; -static v_check posts_le1[] = { check_le1, NULL }; -static v_check pres_bline[] = { check_bline, NULL }; - -static const struct man_valid man_valids[MAN_MAX] = { - { NULL, posts_eq0 }, /* br */ - { pres_bline, posts_th }, /* TH */ - { pres_bline, posts_sec }, /* SH */ - { pres_bline, posts_sec }, /* SS */ - { pres_bline, posts_par }, /* TP */ - { pres_bline, posts_par }, /* LP */ - { pres_bline, posts_par }, /* PP */ - { pres_bline, posts_par }, /* P */ - { pres_bline, posts_par }, /* IP */ - { pres_bline, posts_par }, /* 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 */ /* FIXME: should warn only. */ - { NULL, NULL }, /* i */ - { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */ - { pres_bline, posts_eq0 }, /* nf */ - { pres_bline, posts_eq0 }, /* fi */ - { NULL, NULL }, /* r */ - { NULL, NULL }, /* RE */ - { NULL, posts_part }, /* RS */ - { NULL, NULL }, /* DT */ - { NULL, NULL }, /* UC */ - { NULL, NULL }, /* PD */ - { NULL, posts_le1 }, /* Sp */ /* FIXME: should warn only. */ - { pres_bline, posts_le1 }, /* Vb */ /* FIXME: should warn only. */ - { pres_bline, posts_eq0 }, /* Ve */ - { NULL, NULL }, /* AT */ - { NULL, NULL }, /* in */ +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 */ + 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 *m, struct man_node *n) +void +man_valid_post(struct man *man) { + struct man_node *n; v_check *cp; - if (MAN_TEXT == n->type) - return(1); - if (MAN_ROOT == n->type) - return(1); + n = man->last; + if (n->flags & MAN_VALID) + return; + n->flags |= MAN_VALID; - if (NULL == (cp = man_valids[n->tok].pres)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(m, n)) - return(0); - return(1); + 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: + break; + default: + cp = man_valids + n->tok; + if (*cp) + (*cp)(man, n); + break; + } } - -int -man_valid_post(struct man *m) +static void +check_root(CHKARGS) { - v_check *cp; - if (MAN_VALID & m->last->flags) - return(1); - m->last->flags |= MAN_VALID; + assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); - switch (m->last->type) { - case (MAN_TEXT): - return(check_text(m, m->last)); - case (MAN_ROOT): - return(check_root(m, m->last)); - default: - break; + 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->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(""); + man->meta.msec = mandoc_strdup(""); + man->meta.date = man->quick ? mandoc_strdup("") : + mandoc_normdate(man->parse, NULL, n->line, n->pos); } +} - if (NULL == (cp = man_valids[m->last->tok].posts)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(m, m->last)) - return(0); +static void +check_text(CHKARGS) +{ + char *cp, *p; - return(1); + if (MAN_LITERAL & man->flags) + return; + + cp = n->string; + for (p = cp; NULL != (p = strchr(p, '\t')); p++) + mandoc_msg(MANDOCERR_FI_TAB, man->parse, + n->line, n->pos + (p - cp), NULL); } +#define INEQ_DEFINE(x, ineq, name) \ +static void \ +check_##name(CHKARGS) \ +{ \ + if (n->nchild ineq (x)) \ + return; \ + mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \ + "line arguments %s %d (have %d)", \ + #ineq, (x), n->nchild); \ +} -static int -check_root(CHKARGS) +INEQ_DEFINE(0, ==, eq0) +INEQ_DEFINE(2, ==, eq2) +INEQ_DEFINE(1, <=, le1) +INEQ_DEFINE(5, <=, le5) + +static void +post_UR(CHKARGS) { - if (MAN_BLINE & m->flags) - return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); - if (MAN_ELINE & m->flags) - return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); + 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); + check_part(man, n); +} - m->flags &= ~MAN_BLINE; - m->flags &= ~MAN_ELINE; +static void +post_ft(CHKARGS) +{ + char *cp; + int ok; - if (NULL == m->first->child) { - man_nmsg(m, n, MANDOCERR_NODOCBODY); - return(0); - } else if (NULL == m->meta.title) { - if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE)) - return(0); - /* - * If a title hasn't been set, do so now (by - * implication, date and section also aren't set). - * - * FIXME: this should be in man_action.c. - */ - m->meta.title = mandoc_strdup("unknown"); - m->meta.date = time(NULL); - m->meta.msec = mandoc_strdup("1"); + if (0 == n->nchild) + return; + + ok = 0; + cp = n->child->string; + switch (*cp) { + case '1': + /* FALLTHROUGH */ + case '2': + /* FALLTHROUGH */ + case '3': + /* FALLTHROUGH */ + case '4': + /* FALLTHROUGH */ + case 'I': + /* FALLTHROUGH */ + case 'P': + /* FALLTHROUGH */ + case 'R': + if ('\0' == cp[1]) + ok = 1; + break; + case 'B': + if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2])) + ok = 1; + break; + case 'C': + if ('W' == cp[1] && '\0' == cp[2]) + ok = 1; + break; + default: + break; } - return(1); + if (0 == ok) { + 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); } +static void +check_part(CHKARGS) +{ -static int -check_title(CHKARGS) + if (MAN_BODY == n->type && 0 == n->nchild) + mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line, + n->pos, "want children (have none)"); +} + +static void +check_par(CHKARGS) { - const char *p; - assert(n->child); - /* FIXME: is this sufficient? */ - if ('\0' == *n->child->string) { - man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); - return(0); + switch (n->type) { + case MAN_BLOCK: + if (0 == n->body->nchild) + man_node_delete(man, n); + break; + case MAN_BODY: + if (0 == n->nchild) + mandoc_vmsg(MANDOCERR_PAR_SKIP, + man->parse, n->line, n->pos, + "%s empty", man_macronames[n->tok]); + break; + case MAN_HEAD: + if (n->nchild) + 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; } +} - for (p = n->child->string; '\0' != *p; p++) - if (isalpha((u_char)*p) && ! isupper((u_char)*p)) - if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE)) - return(0); +static void +post_IP(CHKARGS) +{ - return(1); + switch (n->type) { + case MAN_BLOCK: + if (0 == n->head->nchild && 0 == n->body->nchild) + man_node_delete(man, n); + break; + case MAN_BODY: + if (0 == n->parent->head->nchild && 0 == n->nchild) + mandoc_vmsg(MANDOCERR_PAR_SKIP, + man->parse, n->line, n->pos, + "%s empty", man_macronames[n->tok]); + break; + default: + break; + } } - -static int -check_text(CHKARGS) +static void +post_TH(CHKARGS) { - char *p; - int pos, c; - size_t sz; + struct man_node *nb; + const char *p; - for (p = n->string, pos = n->pos + 1; *p; p++, pos++) { - sz = strcspn(p, "\t\\"); - p += (int)sz; + check_le5(man, n); - if ('\0' == *p) - break; + free(man->meta.title); + free(man->meta.vol); + free(man->meta.source); + free(man->meta.msec); + free(man->meta.date); - pos += (int)sz; + man->meta.title = man->meta.vol = man->meta.date = + man->meta.msec = man->meta.source = NULL; - if ('\t' == *p) { - if (MAN_LITERAL & m->flags) - continue; - if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB)) - continue; - return(0); - } + nb = n; - /* Check the special character. */ + /* ->TITLE<- MSEC DATE SOURCE VOL */ - c = mandoc_special(p); - if (c) { - p += c - 1; - pos += c - 1; - continue; + 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)) { + 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 { + man->meta.title = mandoc_strdup(""); + mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, + nb->line, nb->pos, "TH"); + } - c = man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE); - if ( ! (MAN_IGN_ESCAPE & m->pflags) && ! c) - return(c); + /* TITLE ->MSEC<- DATE SOURCE VOL */ + + if (n) + n = n->next; + if (n && n->string) + man->meta.msec = mandoc_strdup(n->string); + else { + man->meta.msec = mandoc_strdup(""); + mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse, + nb->line, nb->pos, "TH %s", man->meta.title); } - return(1); -} + /* TITLE MSEC ->DATE<- SOURCE VOL */ + if (n) + n = n->next; + if (n && n->string && '\0' != n->string[0]) { + man->meta.date = man->quick ? + mandoc_strdup(n->string) : + mandoc_normdate(man->parse, n->string, + n->line, n->pos); + } else { + man->meta.date = mandoc_strdup(""); + mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, + n ? n->line : nb->line, + n ? n->pos : nb->pos, "TH"); + } -#define INEQ_DEFINE(x, ineq, name) \ -static int \ -check_##name(CHKARGS) \ -{ \ - if (n->nchild ineq (x)) \ - return(1); \ - man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \ - "line arguments %s %d (have %d)", \ - #ineq, (x), n->nchild); \ - return(0); \ -} + /* TITLE MSEC DATE ->SOURCE<- VOL */ -INEQ_DEFINE(0, ==, eq0) -INEQ_DEFINE(1, <=, le1) -INEQ_DEFINE(2, >=, ge2) -INEQ_DEFINE(5, <=, le5) + if (n && (n = n->next)) + man->meta.source = mandoc_strdup(n->string); + else if (man->defos != NULL) + man->meta.source = mandoc_strdup(man->defos); + /* TITLE MSEC DATE SOURCE ->VOL<- */ + /* If missing, use the default VOL name for MSEC. */ -static int -check_sec(CHKARGS) + if (n && (n = n->next)) + man->meta.vol = mandoc_strdup(n->string); + else if ('\0' != man->meta.msec[0] && + (NULL != (p = mandoc_a2msec(man->meta.msec)))) + man->meta.vol = mandoc_strdup(p); + + /* + * Remove the `TH' node after we've processed it for our + * meta-data. + */ + man_node_delete(man, man->last); +} + +static void +post_nf(CHKARGS) { - if (MAN_HEAD == n->type && 0 == n->nchild) { - man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); - return(0); - } else if (MAN_BODY == n->type && 0 == n->nchild) - return(man_nmsg(m, n, MANDOCERR_NOBODY)); + check_eq0(man, n); - return(1); + if (MAN_LITERAL & man->flags) + mandoc_msg(MANDOCERR_NF_SKIP, man->parse, + n->line, n->pos, "nf"); + + man->flags |= MAN_LITERAL; } - -static int -check_part(CHKARGS) +static void +post_fi(CHKARGS) { - if (MAN_BODY == n->type && 0 == n->nchild) - return(man_nmsg(m, n, MANDOCERR_NOBODY)); - return(1); -} + check_eq0(man, n); + if ( ! (MAN_LITERAL & man->flags)) + mandoc_msg(MANDOCERR_FI_SKIP, man->parse, + n->line, n->pos, "fi"); -static int -check_par(CHKARGS) + man->flags &= ~MAN_LITERAL; +} + +static void +post_UC(CHKARGS) { + static const char * const bsd_versions[] = { + "3rd Berkeley Distribution", + "4th Berkeley Distribution", + "4.2 Berkeley Distribution", + "4.3 Berkeley Distribution", + "4.4 Berkeley Distribution", + }; - if (MAN_BODY == n->type) - switch (n->tok) { - case (MAN_IP): - /* FALLTHROUGH */ - case (MAN_HP): - /* FALLTHROUGH */ - case (MAN_TP): - /* Body-less lists are ok. */ - break; - default: - if (n->nchild) - break; - return(man_nmsg(m, n, MANDOCERR_NOBODY)); - } - if (MAN_HEAD == n->type) - switch (n->tok) { - case (MAN_PP): - /* FALLTHROUGH */ - case (MAN_P): - /* FALLTHROUGH */ - case (MAN_LP): - if (0 == n->nchild) - break; - return(man_nmsg(m, n, MANDOCERR_ARGSLOST)); - default: - if (n->nchild) - break; - return(man_nmsg(m, n, MANDOCERR_NOARGS)); - } + const char *p, *s; - return(1); -} + n = n->child; + if (NULL == n || MAN_TEXT != n->type) + p = bsd_versions[0]; + else { + s = n->string; + if (0 == strcmp(s, "3")) + p = bsd_versions[0]; + else if (0 == strcmp(s, "4")) + p = bsd_versions[1]; + else if (0 == strcmp(s, "5")) + p = bsd_versions[2]; + else if (0 == strcmp(s, "6")) + p = bsd_versions[3]; + else if (0 == strcmp(s, "7")) + p = bsd_versions[4]; + else + p = bsd_versions[0]; + } -static int -check_bline(CHKARGS) + free(man->meta.source); + man->meta.source = mandoc_strdup(p); +} + +static void +post_AT(CHKARGS) { + static const char * const unix_versions[] = { + "7th Edition", + "System III", + "System V", + "System V Release 2", + }; - assert( ! (MAN_ELINE & m->flags)); - if (MAN_BLINE & m->flags) { - man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE); - return(0); + const char *p, *s; + struct man_node *nn; + + n = n->child; + + if (NULL == n || MAN_TEXT != n->type) + p = unix_versions[0]; + else { + s = n->string; + if (0 == strcmp(s, "3")) + p = unix_versions[0]; + else if (0 == strcmp(s, "4")) + p = unix_versions[1]; + else if (0 == strcmp(s, "5")) { + nn = n->next; + if (nn && MAN_TEXT == nn->type && nn->string[0]) + p = unix_versions[3]; + else + p = unix_versions[2]; + } else + p = unix_versions[0]; } - return(1); + free(man->meta.source); + man->meta.source = mandoc_strdup(p); } +static void +post_vs(CHKARGS) +{ + + if (n->tok == MAN_br) + check_eq0(man, n); + else + check_le1(man, n); + + if (NULL != n->prev) + return; + + switch (n->parent->tok) { + case MAN_SH: + /* FALLTHROUGH */ + 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: + /* + * Don't warn about this because it occurs in pod2man + * and would cause considerable (unfixable) warnage. + */ + man_node_delete(man, n); + break; + default: + break; + } +}