]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_validate.c
Properly checked in Ingo Schwarze' prologue/body-breaking patch, which I'd munged.
[mandoc.git] / man_validate.c
index fa847caebdb1621ea8660b73973c653031c8f0f3..d4c4009336fe8a8411458bf4c4c75c90b7682a86 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_validate.c,v 1.21 2009/08/20 11:51:07 kristaps Exp $ */
+/*     $Id: man_validate.c,v 1.34 2010/04/03 14:12:48 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * 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 <sys/types.h>
 
 #include <assert.h>
@@ -36,28 +40,30 @@ 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_roff(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 v_check   pres_roff[] = { check_roff, 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,26 +72,37 @@ 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 */
        { NULL, NULL }, /* i */
-       { pres_bline, posts_sp }, /* sp */
+       { NULL, posts_le1 }, /* sp */
        { pres_bline, posts_eq0 }, /* nf */
        { pres_bline, posts_eq0 }, /* fi */
        { NULL, NULL }, /* r */
        { NULL, NULL }, /* RE */
-       { NULL, NULL }, /* RS */ /* FIXME: warn if empty body. */
+       { NULL, posts_part }, /* RS */
        { NULL, NULL }, /* DT */
+       { NULL, NULL }, /* UC */
+       { NULL, NULL }, /* PD */
+       { NULL, posts_eq0 }, /* Sp */
+       { pres_bline, posts_le1 }, /* Vb */
+       { pres_bline, posts_eq0 }, /* Ve */
+       { pres_roff, NULL }, /* de */
+       { pres_roff, NULL }, /* dei */
+       { pres_roff, NULL }, /* am */
+       { pres_roff, NULL }, /* ami */
+       { pres_roff, NULL }, /* ig */
+       { NULL, NULL }, /* . */
 };
 
 
@@ -140,18 +157,48 @@ 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_nwarn(m, n, WEXITSCOPE));
        if (MAN_ELINE & m->flags)
-               return(man_nerr(m, n, WEXITSCOPE));
+               return(man_nwarn(m, n, WEXITSCOPE));
+
+       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 (NULL == m->meta.title) {
+               if ( ! man_nwarn(m, n, WNOTITLE))
+                       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 = 1;
+       }
+
+       return(1);
+}
+
+
+static int
+check_title(CHKARGS) 
+{
+       const char      *p;
+
+       assert(n->child);
+       if ('\0' == *n->child->string)
                return(man_nerr(m, n, WNOTITLE));
 
+       for (p = n->child->string; '\0' != *p; p++)
+               if (isalpha((u_char)*p) && ! isupper((u_char)*p))
+                       if ( ! man_nwarn(m, n, WTITLECASE))
+                               return(0);
+
        return(1);
 }
 
@@ -203,49 +250,29 @@ check_##name(CHKARGS) \
 }
 
 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))
-               return(0);
-
-       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));
 
+       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(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(1);
 }
 
@@ -289,23 +316,30 @@ check_par(CHKARGS)
 
 
 static int
-check_eline(CHKARGS)
+check_bline(CHKARGS)
 {
 
-       if (MAN_ELINE & m->flags)
+       assert( ! (MAN_ELINE & m->flags));
+       if (MAN_BLINE & m->flags)
                return(man_nerr(m, n, WLNSCOPE));
+
        return(1);
 }
 
 
 static int
-check_bline(CHKARGS)
+check_roff(CHKARGS)
 {
 
-       if (MAN_BLINE & m->flags)
-               return(man_nerr(m, n, WLNSCOPE));
-       if (MAN_ELINE & m->flags)
-               return(man_nerr(m, n, WLNSCOPE));
+       if (MAN_BLOCK != n->type)
+               return(1);
+
+       for (n = n->parent; n; n = n->parent)
+               if (MAN_de == n->tok || MAN_dei == n->tok ||
+                               MAN_am == n->tok || 
+                               MAN_ami == n->tok ||
+                               MAN_ig == n->tok)
+                       return(man_nerr(m, n, WROFFNEST));
+
        return(1);
 }
-