=================================================================== RCS file: /cvs/mandoc/man_validate.c,v retrieving revision 1.19 retrieving revision 1.101 diff -u -p -r1.19 -r1.101 --- mandoc/man_validate.c 2009/08/19 09:14:50 1.19 +++ mandoc/man_validate.c 2014/07/30 23:01:39 1.101 @@ -1,6 +1,7 @@ -/* $Id: man_validate.c,v 1.19 2009/08/19 09:14:50 kristaps Exp $ */ +/* $Id: man_validate.c,v 1.101 2014/07/30 23:01:39 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 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,6 +15,10 @@ * 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 #include @@ -22,11 +27,16 @@ #include #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, const struct man_node *n +#define CHKARGS struct man *man, struct man_node *n typedef int (*v_check)(CHKARGS); @@ -35,278 +45,544 @@ struct man_valid { v_check *posts; }; -static int check_bline(CHKARGS); -static int check_eline(CHKARGS); static int check_eq0(CHKARGS); -static int check_eq1(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 int check_sec(CHKARGS); -static int check_sp(CHKARGS); -static int check_text(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_TH(CHKARGS); +static int post_UC(CHKARGS); +static int pre_sec(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_ge2_le5[] = { check_ge2, check_le5, 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_sec[] = { check_sec, NULL }; -static v_check posts_sp[] = { check_sp, NULL }; -static v_check pres_eline[] = { check_eline, NULL }; -static v_check pres_bline[] = { check_bline, NULL }; +static v_check posts_part[] = { check_part, 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] = { - { pres_bline, posts_eq0 }, /* br */ - { pres_bline, posts_ge2_le5 }, /* 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 */ - { pres_eline, NULL }, /* SM */ - { pres_eline, NULL }, /* SB */ + { NULL, posts_br }, /* br */ + { NULL, posts_th }, /* TH */ + { pres_sec, NULL }, /* SH */ + { pres_sec, NULL }, /* 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 */ - { pres_eline, NULL }, /* R */ - { pres_eline, NULL }, /* B */ - { pres_eline, NULL }, /* I */ + { NULL, NULL }, /* R */ + { NULL, NULL }, /* B */ + { NULL, NULL }, /* I */ { NULL, NULL }, /* IR */ { NULL, NULL }, /* RI */ - { pres_bline, posts_eq0 }, /* na */ - { NULL, NULL }, /* i */ - { pres_bline, posts_sp }, /* sp */ - { pres_bline, posts_eq0 }, /* nf */ - { pres_bline, posts_eq0 }, /* fi */ - { NULL, NULL }, /* r */ + { NULL, posts_eq0 }, /* na */ + { NULL, posts_sp }, /* sp */ + { NULL, posts_nf }, /* nf */ + { NULL, posts_fi }, /* fi */ { NULL, NULL }, /* RE */ - { NULL, NULL }, /* RS */ + { 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 */ + { NULL, NULL }, /* ll */ }; int -man_valid_pre(struct man *m, const struct man_node *n) +man_valid_pre(struct man *man, struct man_node *n) { v_check *cp; - if (MAN_TEXT == n->type) + switch (n->type) { + case MAN_TEXT: + /* FALLTHROUGH */ + case MAN_ROOT: + /* FALLTHROUGH */ + case MAN_EQN: + /* FALLTHROUGH */ + case MAN_TBL: return(1); - if (MAN_ROOT == n->type) - return(1); + default: + break; + } if (NULL == (cp = man_valids[n->tok].pres)) return(1); for ( ; *cp; cp++) - if ( ! (*cp)(m, n)) + if ( ! (*cp)(man, n)) return(0); return(1); } - int -man_valid_post(struct man *m) +man_valid_post(struct man *man) { v_check *cp; - if (MAN_VALID & m->last->flags) + if (MAN_VALID & man->last->flags) return(1); - m->last->flags |= MAN_VALID; + man->last->flags |= MAN_VALID; - switch (m->last->type) { - case (MAN_TEXT): - return(check_text(m, m->last)); - case (MAN_ROOT): - return(check_root(m, m->last)); + 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: + /* FALLTHROUGH */ + case MAN_TBL: + return(1); default: break; } - if (NULL == (cp = man_valids[m->last->tok].posts)) + if (NULL == (cp = man_valids[man->last->tok].posts)) return(1); for ( ; *cp; cp++) - if ( ! (*cp)(m, m->last)) + if ( ! (*cp)(man, man->last)) return(0); return(1); } - static int -check_root(CHKARGS) +check_root(CHKARGS) { - /* FIXME: closing out explicit scope! */ + assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); - /* XXX - make this into a warning? */ - if (MAN_BLINE & m->flags) - return(man_nerr(m, n, WEXITSCOPE)); - /* XXX - make this into a warning? */ - if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WEXITSCOPE)); + if (NULL == man->first->child) + man_nmsg(man, n, MANDOCERR_DOC_EMPTY); + else + man->meta.hasbody = 1; - if (NULL == m->first->child) - return(man_nerr(m, n, WNODATA)); - if (NULL == m->meta.title) - return(man_nerr(m, n, WNOTITLE)); + if (NULL == man->meta.title) { + man_nmsg(man, n, MANDOCERR_TH_MISSING); + /* + * 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.date = man->quick ? mandoc_strdup("") : + mandoc_normdate(man->parse, NULL, n->line, n->pos); + } + return(1); } - -static int -check_text(CHKARGS) +static void +check_text(CHKARGS) { - const char *p; - int pos, c; + char *cp, *p; - assert(n->string); + if (MAN_LITERAL & man->flags) + return; - for (p = n->string, pos = n->pos + 1; *p; p++, pos++) { - if ('\\' == *p) { - c = mandoc_special(p); - if (c) { - p += c - 1; - pos += c - 1; - continue; - } - if ( ! (MAN_IGN_ESCAPE & m->pflags)) - return(man_perr(m, n->line, pos, WESCAPE)); - if ( ! man_pwarn(m, n->line, pos, WESCAPE)) - return(0); - continue; - } - - if ('\t' == *p || isprint((u_char)*p)) - continue; - - if (MAN_IGN_CHARS & m->pflags) - return(man_pwarn(m, n->line, pos, WNPRINT)); - return(man_perr(m, n->line, pos, WNPRINT)); - } - - return(1); + 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 int \ check_##name(CHKARGS) \ { \ if (n->nchild ineq (x)) \ return(1); \ - return(man_verr(m, n->line, n->pos, \ - "expected line arguments %s %d, have %d", \ - #ineq, (x), n->nchild)); \ + mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \ + "line arguments %s %d (have %d)", \ + #ineq, (x), n->nchild); \ + return(1); \ } INEQ_DEFINE(0, ==, eq0) -INEQ_DEFINE(1, ==, eq1) +INEQ_DEFINE(2, ==, eq2) +INEQ_DEFINE(1, <=, le1) INEQ_DEFINE(2, >=, ge2) INEQ_DEFINE(5, <=, le5) +static int +check_head1(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); +} + static int -check_sp(CHKARGS) +post_ft(CHKARGS) { - long lval; - char *ep, *buf; + char *cp; + int ok; - if (NULL == n->child) + if (0 == n->nchild) return(1); - else if ( ! check_eq1(m, n)) - return(0); - assert(MAN_TEXT == n->child->type); - buf = n->child->string; - assert(buf); - - /* From OpenBSD's strtol(3). */ + 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; + } - errno = 0; - lval = strtol(buf, &ep, 10); - if (buf[0] == '\0' || *ep != '\0') - return(man_nerr(m, n->child, WNUMFMT)); + if (0 == ok) { + mandoc_vmsg(MANDOCERR_FT_BAD, man->parse, + n->line, n->pos, "ft %s", cp); + *cp = '\0'; + } - if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) || - (lval > INT_MAX || lval < 0)) - return(man_nerr(m, n->child, WNUMFMT)); + if (1 < n->nchild) + mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, + n->pos, "want one child (have %d)", n->nchild); return(1); } +static int +pre_sec(CHKARGS) +{ + if (MAN_BLOCK == n->type) + man->flags &= ~MAN_LITERAL; + return(1); +} + static int -check_sec(CHKARGS) +check_part(CHKARGS) { if (MAN_BODY == n->type && 0 == n->nchild) - return(man_nwarn(m, n, WBODYARGS)); - if (MAN_HEAD == n->type && 0 == n->nchild) - return(man_nerr(m, n, WHEADARGS)); + mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line, + n->pos, "want children (have none)"); + return(1); } - static int check_par(CHKARGS) { - 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) + 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; + } + + return(1); +} + +static int +post_IP(CHKARGS) +{ + + 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; + } + return(1); +} + +static int +post_TH(CHKARGS) +{ + struct man_node *nb; + const char *p; + + free(man->meta.title); + free(man->meta.vol); + free(man->meta.source); + free(man->meta.msec); + free(man->meta.date); + + man->meta.title = man->meta.vol = man->meta.date = + 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)) { + mandoc_msg(MANDOCERR_TITLE_CASE, + man->parse, n->line, + n->pos + (p - n->string), + n->string); break; - return(man_nwarn(m, n, WBODYARGS)); + } } - 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_nwarn(m, n, WNHEADARGS)); - default: - if (n->nchild) - break; - return(man_nwarn(m, n, WHEADARGS)); - } + man->meta.title = mandoc_strdup(n->string); + } else + man->meta.title = mandoc_strdup(""); + /* 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(""); + + /* 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(""); + man_nmsg(man, n ? n : nb, MANDOCERR_DATE_MISSING); + } + + /* TITLE MSEC DATE ->SOURCE<- VOL */ + + if (n && (n = n->next)) + man->meta.source = mandoc_strdup(n->string); + + /* TITLE MSEC DATE SOURCE ->VOL<- */ + /* If missing, use the default VOL name for MSEC. */ + + 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); return(1); } +static int +post_nf(CHKARGS) +{ + if (MAN_LITERAL & man->flags) + man_nmsg(man, n, MANDOCERR_NF_SKIP); + + man->flags |= MAN_LITERAL; + return(1); +} + static int -check_eline(CHKARGS) +post_fi(CHKARGS) { - if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); + if ( ! (MAN_LITERAL & man->flags)) + man_nmsg(man, n, MANDOCERR_FI_SKIP); + + man->flags &= ~MAN_LITERAL; return(1); } +static int +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", + }; + const char *p, *s; + + 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]; + } + + free(man->meta.source); + man->meta.source = mandoc_strdup(p); + return(1); +} + static int -check_bline(CHKARGS) +post_AT(CHKARGS) { + static const char * const unix_versions[] = { + "7th Edition", + "System III", + "System V", + "System V Release 2", + }; - if (MAN_BLINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); - if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); + 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]; + } + + free(man->meta.source); + man->meta.source = mandoc_strdup(p); return(1); } +static int +post_vs(CHKARGS) +{ + + if (NULL != n->prev) + return(1); + + 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; + } + + return(1); +}