diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2010-05-23 22:45:02 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2010-05-23 22:45:02 +0000 |
commit | 5f11e83ec40e027d9941a83310ca46e5e32821c7 (patch) | |
tree | 443369858d56a918cd55fb337d34f528d8d4d96b /usr.bin/mandoc/man_validate.c | |
parent | 22bfa887a3d98fe67ad553bf37793e74ab6f8142 (diff) |
Unified error and warning message system for all of mandoc,
featuring three message levels, as agreed during the mandoc hackathon:
* FATAL parser failure, cannot produce any output from this input file:
eventually, we hope to convert most of these to ERRORs.
* ERROR, meaning mandoc cannot cope fully with the input syntax and will
probably lose information or produce structurally garbled output;
it will try to produce output anyway but exit non-zero at the end,
which is eventually intended to make the ports infrastructure happy.
* WARNING, meaning you should clean up the input file, but output
is probably mostly OK, so this will not cause error-exit at the end.
This commit is mostly just converting the old system to the new one; before
the classification will become really reliable, we must check all messages.
In particular,
* set up a new central message string table in main.c
* drop the old message string tables from man.c and mdoc.c
* get rid of the piece-meal merr enums in libman and libmdoc
* reduce number of error/warning functions from 16 to 6 (still a lot...)
While here, handle a few problems more gracefully:
* allow .Rv and .Ex to work without a prior .Nm
* allow .An to ignore extra arguments
* allow undeclared columns in .Bl -column
Written by kristaps@.
Diffstat (limited to 'usr.bin/mandoc/man_validate.c')
-rw-r--r-- | usr.bin/mandoc/man_validate.c | 69 |
1 files changed, 39 insertions, 30 deletions
diff --git a/usr.bin/mandoc/man_validate.c b/usr.bin/mandoc/man_validate.c index 20bc8c3d4a6..f0ff2b49c70 100644 --- a/usr.bin/mandoc/man_validate.c +++ b/usr.bin/mandoc/man_validate.c @@ -1,4 +1,4 @@ -/* $Id: man_validate.c,v 1.24 2010/05/23 20:57:16 schwarze Exp $ */ +/* $Id: man_validate.c,v 1.25 2010/05/23 22:45:00 schwarze Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> * @@ -23,6 +23,7 @@ #include <stdarg.h> #include <stdlib.h> +#include "mandoc.h" #include "libman.h" #include "libmandoc.h" @@ -147,17 +148,18 @@ check_root(CHKARGS) { if (MAN_BLINE & m->flags) - return(man_nwarn(m, n, WEXITSCOPE)); + return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); if (MAN_ELINE & m->flags) - return(man_nwarn(m, n, WEXITSCOPE)); + return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT)); m->flags &= ~MAN_BLINE; m->flags &= ~MAN_ELINE; - if (NULL == m->first->child) - return(man_nerr(m, n, WNODATA)); - if (NULL == m->meta.title) { - if ( ! man_nwarn(m, n, WNOTITLE)) + 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 @@ -180,12 +182,15 @@ check_title(CHKARGS) const char *p; assert(n->child); - if ('\0' == *n->child->string) - return(man_nerr(m, n, WNOTITLE)); + /* 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_nwarn(m, n, WTITLECASE)) + if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE)) return(0); return(1); @@ -208,17 +213,16 @@ check_text(CHKARGS) 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; + + c = man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE); + if ( ! (MAN_IGN_ESCAPE & m->pflags) && ! c) + return(c); } if ('\t' == *p || isprint((u_char)*p)) continue; - - return(man_pwarn(m, n->line, pos, WNPRINT)); + if ( ! man_pmsg(m, n->line, pos, MANDOCERR_BADCHAR)) + return(0); } return(1); @@ -231,9 +235,10 @@ 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) @@ -246,10 +251,12 @@ static int check_sec(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)); + 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)); + return(1); } @@ -259,7 +266,7 @@ check_part(CHKARGS) { if (MAN_BODY == n->type && 0 == n->nchild) - return(man_nwarn(m, n, WBODYARGS)); + return(man_nmsg(m, n, MANDOCERR_NOBODY)); return(1); } @@ -280,7 +287,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) { @@ -291,11 +298,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); @@ -307,8 +314,10 @@ check_bline(CHKARGS) { assert( ! (MAN_ELINE & m->flags)); - if (MAN_BLINE & m->flags) - return(man_nerr(m, n, WLNSCOPE)); + if (MAN_BLINE & m->flags) { + man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE); + return(0); + } return(1); } |