=================================================================== RCS file: /cvs/mandoc/man_validate.c,v retrieving revision 1.18 retrieving revision 1.50 diff -u -p -r1.18 -r1.50 --- mandoc/man_validate.c 2009/08/18 11:46:44 1.18 +++ mandoc/man_validate.c 2010/10/11 15:45:36 1.50 @@ -1,6 +1,6 @@ -/* $Id: man_validate.c,v 1.18 2009/08/18 11:46:44 kristaps Exp $ */ +/* $Id: man_validate.c,v 1.50 2010/10/11 15:45:36 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * * 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 +14,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 +26,14 @@ #include #include #include +#include +#include +#include "mandoc.h" #include "libman.h" #include "libmandoc.h" -#define CHKARGS struct man *m, const struct man_node *n +#define CHKARGS struct man *m, struct man_node *n typedef int (*v_check)(CHKARGS); @@ -36,28 +43,28 @@ struct man_valid { }; static int check_bline(CHKARGS); -static int check_eline(CHKARGS); static int check_eq0(CHKARGS); -static int check_eq1(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_sp(CHKARGS); static int check_text(CHKARGS); +static int check_title(CHKARGS); static v_check posts_eq0[] = { check_eq0, NULL }; -static v_check posts_ge2_le5[] = { check_ge2, check_le5, 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_sp[] = { check_sp, NULL }; -static v_check pres_eline[] = { check_eline, 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] = { - { pres_bline, posts_eq0 }, /* br */ - { pres_bline, posts_ge2_le5 }, /* TH */ + { NULL, posts_eq0 }, /* br */ + { pres_bline, posts_th }, /* TH */ { pres_bline, posts_sec }, /* SH */ { pres_bline, posts_sec }, /* SS */ { pres_bline, posts_par }, /* TP */ @@ -66,28 +73,38 @@ static const struct man_valid man_valids[MAN_MAX] = { { pres_bline, posts_par }, /* P */ { pres_bline, posts_par }, /* IP */ { pres_bline, posts_par }, /* HP */ - { pres_eline, NULL }, /* SM */ - { pres_eline, NULL }, /* SB */ + { 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, posts_eq0 }, /* na */ /* FIXME: should warn only. */ { NULL, NULL }, /* i */ - { pres_bline, posts_sp }, /* sp */ + { 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 */ }; int -man_valid_pre(struct man *m, const struct man_node *n) +man_valid_pre(struct man *m, struct man_node *n) { v_check *cp; @@ -137,51 +154,88 @@ static int check_root(CHKARGS) { - /* XXX - make this into a warning? */ if (MAN_BLINE & m->flags) - return(man_nerr(m, n, WEXITSCOPE)); - /* XXX - make this into a warning? */ + return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WEXITSCOPE)); + return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); - if (NULL == m->first->child) - return(man_nerr(m, n, WNODATA)); - if (NULL == m->meta.title) - return(man_nerr(m, n, WNOTITLE)); + m->flags &= ~MAN_BLINE; + m->flags &= ~MAN_ELINE; + 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"); + } + return(1); } static int -check_text(CHKARGS) +check_title(CHKARGS) { const char *p; - int pos, c; - assert(n->string); + assert(n->child); + /* FIXME: is this sufficient? */ + if ('\0' == *n->child->string) { + man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT); + return(0); + } + 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); + + return(1); +} + + +static int +check_text(CHKARGS) +{ + char *p; + int pos, c; + size_t sz; + 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; + sz = strcspn(p, "\t\\"); + p += (int)sz; + + if ('\0' == *p) + break; + + pos += (int)sz; + + if ('\t' == *p) { + if (MAN_LITERAL & m->flags) 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 (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB)) + continue; + return(0); } - if ('\t' == *p || isprint((u_char)*p)) - continue; + /* Check the special character. */ - if (MAN_IGN_CHARS & m->pflags) - return(man_pwarn(m, n->line, pos, WNPRINT)); - return(man_perr(m, n->line, pos, WNPRINT)); + c = mandoc_special(p); + if (c) { + p += c - 1; + pos += c - 1; + } else + man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE); } return(1); @@ -194,55 +248,38 @@ 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)); \ + man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \ + "line arguments %s %d (have %d)", \ + #ineq, (x), n->nchild); \ + return(0); \ } INEQ_DEFINE(0, ==, eq0) -INEQ_DEFINE(1, ==, eq1) +INEQ_DEFINE(1, <=, le1) INEQ_DEFINE(2, >=, ge2) INEQ_DEFINE(5, <=, le5) static int -check_sp(CHKARGS) +check_sec(CHKARGS) { - long lval; - char *ep, *buf; - if (NULL == n->child) - return(1); - else if ( ! check_eq1(m, n)) + 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)); - assert(MAN_TEXT == n->child->type); - buf = n->child->string; - assert(buf); - - /* From OpenBSD's strtol(3). */ - - errno = 0; - lval = strtol(buf, &ep, 10); - if (buf[0] == '\0' || *ep != '\0') - return(man_nerr(m, n->child, WNUMFMT)); - - if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) || - (lval > INT_MAX || lval < 0)) - return(man_nerr(m, n->child, WNUMFMT)); - 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)); + return(man_nmsg(m, n, MANDOCERR_NOBODY)); return(1); } @@ -263,7 +300,7 @@ check_par(CHKARGS) default: if (n->nchild) break; - return(man_nwarn(m, n, WBODYARGS)); + return(man_nmsg(m, n, MANDOCERR_NOBODY)); } if (MAN_HEAD == n->type) switch (n->tok) { @@ -274,11 +311,11 @@ check_par(CHKARGS) case (MAN_LP): if (0 == n->nchild) break; - return(man_nwarn(m, n, WNHEADARGS)); + return(man_nmsg(m, n, MANDOCERR_ARGSLOST)); default: if (n->nchild) break; - return(man_nwarn(m, n, WHEADARGS)); + return(man_nmsg(m, n, MANDOCERR_NOARGS)); } return(1); @@ -286,23 +323,15 @@ check_par(CHKARGS) static int -check_eline(CHKARGS) -{ - - if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); - return(1); -} - - -static int check_bline(CHKARGS) { - if (MAN_BLINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); - if (MAN_ELINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); + assert( ! (MAN_ELINE & m->flags)); + if (MAN_BLINE & m->flags) { + man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE); + return(0); + } + return(1); }