]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_validate.c
Clean up consts (noted by Joerg Sonnenberger and Ulrich Sporlein).
[mandoc.git] / mdoc_validate.c
index 4a31b458f1749278b8ed1bedc79b3f50593158e1..974d6448bbd0295acb0dd70b127d184d0f82e49d 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_validate.c,v 1.27 2009/07/12 16:34:16 kristaps Exp $ */
+/*     $Id: mdoc_validate.c,v 1.44 2009/09/24 15:08:41 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -18,6 +18,8 @@
 
 #include <assert.h>
 #include <ctype.h>
+#include <errno.h>
+#include <limits.h>
 #include <stdarg.h>
 #include <stdlib.h>
 #include <string.h>
@@ -28,9 +30,8 @@
 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
 /* TODO: ignoring Pp (it's superfluous in some invocations). */
 
-#define        PRE_ARGS        struct mdoc *mdoc, const struct mdoc_node *n
-#define        POST_ARGS       struct mdoc *mdoc
-
+#define        PRE_ARGS  struct mdoc *mdoc, const struct mdoc_node *n
+#define        POST_ARGS struct mdoc *mdoc
 
 typedef        int     (*v_pre)(PRE_ARGS);
 typedef        int     (*v_post)(POST_ARGS);
@@ -40,110 +41,116 @@ struct    valids {
        v_post  *post;
 };
 
-static int     check_parent(PRE_ARGS, int, enum mdoc_type);
-static int     check_msec(PRE_ARGS, ...);
-static int     check_sec(PRE_ARGS, ...);
-static int     check_stdarg(PRE_ARGS);
-static int     check_text(struct mdoc *, int, int, const char *);
-static int     check_argv(struct mdoc *, 
+static int      check_parent(PRE_ARGS, int, enum mdoc_type);
+static int      check_msec(PRE_ARGS, ...);
+static int      check_sec(PRE_ARGS, ...);
+static int      check_stdarg(PRE_ARGS);
+static int      check_text(struct mdoc *, int, int, const char *);
+static int      check_argv(struct mdoc *, 
                        const struct mdoc_node *,
                        const struct mdoc_argv *);
-static int     check_args(struct mdoc *, 
+static int      check_args(struct mdoc *, 
                        const struct mdoc_node *);
-static int     err_child_lt(struct mdoc *, const char *, int);
-static int     warn_child_lt(struct mdoc *, const char *, int);
-static int     err_child_gt(struct mdoc *, const char *, int);
-static int     warn_child_gt(struct mdoc *, const char *, int);
-static int     err_child_eq(struct mdoc *, const char *, int);
-static int     warn_child_eq(struct mdoc *, const char *, int);
-static int     warn_print(struct mdoc *, int, int);
-static int     warn_count(struct mdoc *, const char *, 
+static int      err_child_lt(struct mdoc *, const char *, int);
+static int      warn_child_lt(struct mdoc *, const char *, int);
+static int      err_child_gt(struct mdoc *, const char *, int);
+static int      warn_child_gt(struct mdoc *, const char *, int);
+static int      err_child_eq(struct mdoc *, const char *, int);
+static int      warn_child_eq(struct mdoc *, const char *, int);
+static int      warn_print(struct mdoc *, int, int);
+static int      warn_count(struct mdoc *, const char *, 
                        int, const char *, int);
-static int     err_count(struct mdoc *, const char *, 
+static int      err_count(struct mdoc *, const char *, 
                        int, const char *, int);
-static int     pre_an(PRE_ARGS);
-static int     pre_bd(PRE_ARGS);
-static int     pre_bl(PRE_ARGS);
-static int     pre_cd(PRE_ARGS);
-static int     pre_dd(PRE_ARGS);
-static int     pre_display(PRE_ARGS);
-static int     pre_dt(PRE_ARGS);
-static int     pre_er(PRE_ARGS);
-static int     pre_ex(PRE_ARGS);
-static int     pre_fd(PRE_ARGS);
-static int     pre_it(PRE_ARGS);
-static int     pre_lb(PRE_ARGS);
-static int     pre_os(PRE_ARGS);
-static int     pre_rv(PRE_ARGS);
-static int     pre_sh(PRE_ARGS);
-static int     pre_ss(PRE_ARGS);
-static int     herr_ge1(POST_ARGS);
-static int     hwarn_le1(POST_ARGS);
-static int     herr_eq0(POST_ARGS);
-static int     eerr_eq0(POST_ARGS);
-static int     eerr_le2(POST_ARGS);
-static int     eerr_eq1(POST_ARGS);
-static int     eerr_ge1(POST_ARGS);
-static int     ewarn_eq0(POST_ARGS);
-static int     bwarn_ge1(POST_ARGS);
-static int     berr_ge1(POST_ARGS);
-static int     hwarn_eq1(POST_ARGS);
-static int     ewarn_ge1(POST_ARGS);
-static int     ebool(POST_ARGS);
-static int     post_an(POST_ARGS);
-static int     post_args(POST_ARGS);
-static int     post_at(POST_ARGS);
-static int     post_bf(POST_ARGS);
-static int     post_bl(POST_ARGS);
-static int     post_bl_head(POST_ARGS);
-static int     post_it(POST_ARGS);
-static int     post_nm(POST_ARGS);
-static int     post_root(POST_ARGS);
-static int     post_sh(POST_ARGS);
-static int     post_sh_body(POST_ARGS);
-static int     post_sh_head(POST_ARGS);
-static int     post_st(POST_ARGS);
-
-static v_pre   pres_an[] = { pre_an, NULL };
-static v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
-static v_pre   pres_bl[] = { pre_bl, NULL };
-static v_pre   pres_cd[] = { pre_cd, NULL };
-static v_pre   pres_dd[] = { pre_dd, NULL };
-static v_pre   pres_d1[] = { pre_display, NULL };
-static v_pre   pres_dt[] = { pre_dt, NULL };
-static v_pre   pres_er[] = { pre_er, NULL };
-static v_pre   pres_ex[] = { pre_ex, NULL };
-static v_pre   pres_fd[] = { pre_fd, NULL };
-static v_pre   pres_it[] = { pre_it, NULL };
-static v_pre   pres_lb[] = { pre_lb, NULL };
-static v_pre   pres_os[] = { pre_os, NULL };
-static v_pre   pres_rv[] = { pre_rv, NULL };
-static v_pre   pres_sh[] = { pre_sh, NULL };
-static v_pre   pres_ss[] = { pre_ss, NULL };
-static v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
-static v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
-static v_post  posts_text[] = { eerr_ge1, NULL };
-static v_post  posts_wtext[] = { ewarn_ge1, NULL };
-static v_post  posts_notext[] = { eerr_eq0, NULL };
-static v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
-static v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
-static v_post  posts_bl[] = { bwarn_ge1, post_bl, NULL };
-static v_post  posts_it[] = { post_it, NULL };
-static v_post  posts_in[] = { eerr_eq1, NULL };
-static v_post  posts_ss[] = { herr_ge1, NULL };
-static v_post  posts_nd[] = { berr_ge1, NULL };
-static v_post  posts_pf[] = { eerr_eq1, NULL };
-static v_post  posts_lb[] = { eerr_eq1, NULL };
-static v_post  posts_st[] = { eerr_eq1, post_st, NULL };
-static v_post  posts_pp[] = { ewarn_eq0, NULL };
-static v_post  posts_ex[] = { eerr_eq0, post_args, NULL };
-static v_post  posts_rv[] = { eerr_eq0, post_args, NULL };
-static v_post  posts_an[] = { post_an, NULL };
-static v_post  posts_at[] = { post_at, NULL };
-static v_post  posts_xr[] = { eerr_ge1, eerr_le2, NULL };
-static v_post  posts_nm[] = { post_nm, NULL };
-static v_post  posts_bf[] = { hwarn_le1, post_bf, NULL };
-static v_post  posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
+
+#ifdef __linux__
+extern size_t   strlcat(char *, const char *, size_t);
+#endif
+
+static int      berr_ge1(POST_ARGS);
+static int      bwarn_ge1(POST_ARGS);
+static int      ebool(POST_ARGS);
+static int      eerr_eq0(POST_ARGS);
+static int      eerr_eq1(POST_ARGS);
+static int      eerr_ge1(POST_ARGS);
+static int      eerr_le2(POST_ARGS);
+static int      ewarn_ge1(POST_ARGS);
+static int      herr_eq0(POST_ARGS);
+static int      herr_ge1(POST_ARGS);
+static int      hwarn_eq1(POST_ARGS);
+static int      hwarn_le1(POST_ARGS);
+
+static int      post_an(POST_ARGS);
+static int      post_at(POST_ARGS);
+static int      post_bf(POST_ARGS);
+static int      post_bl(POST_ARGS);
+static int      post_bl_head(POST_ARGS);
+static int      post_it(POST_ARGS);
+static int      post_lb(POST_ARGS);
+static int      post_nm(POST_ARGS);
+static int      post_root(POST_ARGS);
+static int      post_rs(POST_ARGS);
+static int      post_sh(POST_ARGS);
+static int      post_sh_body(POST_ARGS);
+static int      post_sh_head(POST_ARGS);
+static int      post_sp(POST_ARGS);
+static int      post_st(POST_ARGS);
+static int      pre_an(PRE_ARGS);
+static int      pre_bd(PRE_ARGS);
+static int      pre_bl(PRE_ARGS);
+static int      pre_cd(PRE_ARGS);
+static int      pre_dd(PRE_ARGS);
+static int      pre_display(PRE_ARGS);
+static int      pre_dt(PRE_ARGS);
+static int      pre_er(PRE_ARGS);
+static int      pre_ex(PRE_ARGS);
+static int      pre_fd(PRE_ARGS);
+static int      pre_it(PRE_ARGS);
+static int      pre_lb(PRE_ARGS);
+static int      pre_os(PRE_ARGS);
+static int      pre_rv(PRE_ARGS);
+static int      pre_sh(PRE_ARGS);
+static int      pre_ss(PRE_ARGS);
+
+static v_post   posts_an[] = { post_an, NULL };
+static v_post   posts_at[] = { post_at, NULL };
+static v_post   posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
+static v_post   posts_bf[] = { hwarn_le1, post_bf, NULL };
+static v_post   posts_bl[] = { bwarn_ge1, post_bl, NULL };
+static v_post   posts_bool[] = { eerr_eq1, ebool, NULL };
+static v_post   posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
+static v_post   posts_in[] = { eerr_eq1, NULL };
+static v_post   posts_it[] = { post_it, NULL };
+static v_post   posts_lb[] = { eerr_eq1, post_lb, NULL };
+static v_post   posts_nd[] = { berr_ge1, NULL };
+static v_post   posts_nm[] = { post_nm, NULL };
+static v_post   posts_notext[] = { eerr_eq0, NULL };
+static v_post   posts_pf[] = { eerr_eq1, NULL };
+static v_post   posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
+static v_post   posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
+static v_post   posts_sp[] = { post_sp, NULL };
+static v_post   posts_ss[] = { herr_ge1, NULL };
+static v_post   posts_st[] = { eerr_eq1, post_st, NULL };
+static v_post   posts_text[] = { eerr_ge1, NULL };
+static v_post   posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
+static v_post   posts_wtext[] = { ewarn_ge1, NULL };
+static v_post   posts_xr[] = { eerr_ge1, eerr_le2, NULL };
+static v_pre    pres_an[] = { pre_an, NULL };
+static v_pre    pres_bd[] = { pre_display, pre_bd, NULL };
+static v_pre    pres_bl[] = { pre_bl, NULL };
+static v_pre    pres_cd[] = { pre_cd, NULL };
+static v_pre    pres_d1[] = { pre_display, NULL };
+static v_pre    pres_dd[] = { pre_dd, NULL };
+static v_pre    pres_dt[] = { pre_dt, NULL };
+static v_pre    pres_er[] = { pre_er, NULL };
+static v_pre    pres_ex[] = { pre_ex, NULL };
+static v_pre    pres_fd[] = { pre_fd, NULL };
+static v_pre    pres_it[] = { pre_it, NULL };
+static v_pre    pres_lb[] = { pre_lb, NULL };
+static v_pre    pres_os[] = { pre_os, NULL };
+static v_pre    pres_rv[] = { pre_rv, NULL };
+static v_pre    pres_sh[] = { pre_sh, NULL };
+static v_pre    pres_ss[] = { pre_ss, NULL };
 
 const  struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Ap */
@@ -152,7 +159,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { pres_os, NULL },                      /* Os */
        { pres_sh, posts_sh },                  /* Sh */ 
        { pres_ss, posts_ss },                  /* Ss */ 
-       { NULL, posts_pp },                     /* Pp */ 
+       { NULL, posts_notext },                 /* Pp */ 
        { pres_d1, posts_wline },               /* D1 */
        { pres_d1, posts_wline },               /* Dl */
        { pres_bd, posts_bd },                  /* Bd */
@@ -168,7 +175,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Dv */ 
        { pres_er, posts_text },                /* Er */ 
        { NULL, NULL },                         /* Ev */ 
-       { pres_ex, posts_ex },                  /* Ex */ 
+       { pres_ex, NULL },                      /* Ex */ 
        { NULL, NULL },                         /* Fa */ 
        { pres_fd, posts_wtext },               /* Fd */
        { NULL, NULL },                         /* Fl */
@@ -182,7 +189,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, posts_wline },                  /* Op */
        { NULL, NULL },                         /* Ot */
        { NULL, NULL },                         /* Pa */
-       { pres_rv, posts_rv },                  /* Rv */
+       { pres_rv, NULL },                      /* Rv */
        { NULL, posts_st },                     /* St */ 
        { NULL, NULL },                         /* Va */
        { NULL, posts_text },                   /* Vt */ 
@@ -231,7 +238,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Qo */
        { NULL, posts_wline },                  /* Qq */
        { NULL, NULL },                         /* Re */
-       { NULL, posts_wline },                  /* Rs */
+       { NULL, posts_rs },                     /* Rs */
        { NULL, NULL },                         /* Sc */
        { NULL, NULL },                         /* So */
        { NULL, posts_wline },                  /* Sq */
@@ -253,7 +260,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Fr */
        { NULL, posts_notext },                 /* Ud */
        { pres_lb, posts_lb },                  /* Lb */
-       { NULL, posts_pp },                     /* Lp */ 
+       { NULL, posts_notext },                 /* Lp */ 
        { NULL, NULL },                         /* Lk */ 
        { NULL, posts_text },                   /* Mt */ 
        { NULL, posts_wline },                  /* Brq */ 
@@ -264,17 +271,13 @@ const     struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* En */
        { NULL, NULL },                         /* Dx */
        { NULL, posts_text },                   /* %Q */
+       { NULL, posts_notext },                 /* br */
+       { NULL, posts_sp },                     /* sp */
 };
 
 
-#ifdef __linux__
-extern size_t  strlcat(char *, const char *, size_t);
-#endif
-
-
 int
-mdoc_valid_pre(struct mdoc *mdoc, 
-               const struct mdoc_node *n)
+mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)
 {
        v_pre           *p;
        int              line, pos;
@@ -303,14 +306,6 @@ mdoc_valid_post(struct mdoc *mdoc)
 {
        v_post          *p;
 
-       /*
-        * This check occurs after the macro's children have been filled
-        * in: postfix validation.  Since this happens when we're
-        * rewinding the scope tree, it's possible to have multiple
-        * invocations (as by design, for now), we set bit MDOC_VALID to
-        * indicate that we've validated.
-        */
-
        if (MDOC_VALID & mdoc->last->flags)
                return(1);
        mdoc->last->flags |= MDOC_VALID;
@@ -410,7 +405,6 @@ CHECK_CHILD_DEFN(err, lt, <)                        /* err_child_lt() */
 CHECK_CHILD_DEFN(warn, lt, <)                  /* warn_child_lt() */
 CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0)   /* bwarn_ge1() */
 CHECK_BODY_DEFN(ge1, err, err_child_gt, 0)     /* berr_ge1() */
-CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0)   /* ewarn_eq0() */
 CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0)   /* ewarn_gt1() */
 CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1)     /* eerr_eq1() */
 CHECK_ELEM_DEFN(le2, err, err_child_lt, 3)     /* eerr_le2() */
@@ -542,7 +536,7 @@ check_text(struct mdoc *mdoc, int line, int pos, const char *p)
                }
                if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
                        return(mdoc_perr(mdoc, line, pos, EESCAPE));
-               if ( ! mdoc_perr(mdoc, line, pos, EESCAPE))
+               if ( ! mdoc_pwarn(mdoc, line, pos, EESCAPE))
                        return(0);
        }
 
@@ -867,13 +861,23 @@ post_bf(POST_ARGS)
                return(1);
        else if (0 == strcmp(p, "Li"))
                return(1);
-       else if (0 == strcmp(p, "Sm"))
+       else if (0 == strcmp(p, "Sy"))
                return(1);
 
        return(mdoc_nerr(mdoc, head, EFONT));
 }
 
 
+static int
+post_lb(POST_ARGS)
+{
+
+       if (mdoc_a2lib(mdoc->last->child->string))
+               return(1);
+       return(mdoc_nwarn(mdoc, mdoc->last, ELIB));
+}
+
+
 static int
 post_nm(POST_ARGS)
 {
@@ -907,7 +911,7 @@ post_an(POST_ARGS)
        if (mdoc->last->args) {
                if (NULL == mdoc->last->child)
                        return(1);
-               return(mdoc_nerr(mdoc, mdoc->last, ELINE));
+               return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
        }
 
        if (mdoc->last->child)
@@ -916,16 +920,6 @@ post_an(POST_ARGS)
 }
 
 
-static int
-post_args(POST_ARGS)
-{
-
-       if (mdoc->last->args)
-               return(1);
-       return(mdoc_nerr(mdoc, mdoc->last, ELINE));
-}
-
-
 static int
 post_it(POST_ARGS)
 {
@@ -1023,11 +1017,20 @@ post_it(POST_ARGS)
                c = mdoc->last->child;
                for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
                        i++;
-               if (i == cols)
+
+               if (i < cols || i == (cols + 1)) {
+                       if ( ! mdoc_vwarn(mdoc, mdoc->last->line, 
+                                       mdoc->last->pos, "column "
+                                       "mismatch: have %d, want %d", 
+                                       i, cols))
+                               return(0);
+                       break;
+               } else if (i == cols)
                        break;
-               return(mdoc_verr(mdoc, mdoc->last->line, mdoc->last->pos,
-                               "column mismatch (have %d, want %d)", 
-                               i, cols));
+
+               return(mdoc_verr(mdoc, mdoc->last->line, 
+                               mdoc->last->pos, "column mismatch: "
+                               "have %d, want %d", i, cols));
        default:
                break;
        }
@@ -1076,9 +1079,7 @@ post_bl(POST_ARGS)
                if (MDOC_BLOCK == n->type) 
                        if (MDOC_It == n->tok)
                                continue;
-               return(mdoc_verr(mdoc, n->line, n->pos, 
-                               "bad child of parent %s",
-                               mdoc_macronames[mdoc->last->tok]));
+               return(mdoc_nerr(mdoc, n, EBADCHILD));
        }
 
        return(1);
@@ -1125,13 +1126,88 @@ post_root(POST_ARGS)
 }
 
 
+static int
+post_sp(POST_ARGS)
+{
+       long             lval;
+       char            *ep, *buf;
+
+       if (NULL == mdoc->last->child)
+               return(1);
+       else if ( ! eerr_eq1(mdoc))
+               return(0);
+
+       assert(MDOC_TEXT == mdoc->last->child->type);
+       buf = mdoc->last->child->string;
+       assert(buf);
+       
+       /* From OpenBSD's strtol(3). */
+       errno = 0;
+       lval = strtol(buf, &ep, 10);
+       if (buf[0] == '\0' || *ep != '\0')
+               return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT));
+
+       if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) ||
+                       (lval > INT_MAX || lval < 0))
+               return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT));
+
+       return(1);
+}
+
+
+
+
 static int
 post_st(POST_ARGS)
 {
 
        if (mdoc_a2st(mdoc->last->child->string))
                return(1);
-       return(mdoc_nwarn(mdoc, mdoc->last, EBADSTAND));
+       return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
+}
+
+
+static int
+post_rs(POST_ARGS)
+{
+       struct mdoc_node        *nn;
+
+       if (MDOC_BODY != mdoc->last->type)
+               return(1);
+
+       for (nn = mdoc->last->child; nn; nn = nn->next)
+               switch (nn->tok) {
+               case(MDOC__Q):
+                       /* FALLTHROUGH */
+               case(MDOC__C):
+                       /* FALLTHROUGH */
+               case(MDOC__A):
+                       /* FALLTHROUGH */
+               case(MDOC__B):
+                       /* FALLTHROUGH */
+               case(MDOC__D):
+                       /* FALLTHROUGH */
+               case(MDOC__I):
+                       /* FALLTHROUGH */
+               case(MDOC__J):
+                       /* FALLTHROUGH */
+               case(MDOC__N):
+                       /* FALLTHROUGH */
+               case(MDOC__O):
+                       /* FALLTHROUGH */
+               case(MDOC__P):
+                       /* FALLTHROUGH */
+               case(MDOC__R):
+                       /* FALLTHROUGH */
+               case(MDOC__T):
+                       /* FALLTHROUGH */
+               case(MDOC__V):
+                       break;
+               default:
+                       return(mdoc_nerr(mdoc, nn, EBADCHILD));
+               }
+
+       return(1);
 }
 
 
@@ -1153,7 +1229,7 @@ post_sh_body(POST_ARGS)
 {
        struct mdoc_node *n;
 
-       if (SEC_NAME != mdoc->lastnamed)
+       if (SEC_NAME != mdoc->lastsec)
                return(1);
 
        /*
@@ -1168,10 +1244,13 @@ post_sh_body(POST_ARGS)
        for ( ; n && n->next; n = n->next) {
                if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
                        continue;
+               if (MDOC_TEXT == n->type)
+                       continue;
                if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
                        return(0);
        }
 
+       assert(n);
        if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
                return(1);
        return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));