]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_validate.c
When a file is given on the command line, actually exists, and its name
[mandoc.git] / man_validate.c
index 706f69499f4996964dea63ada9183e766b62c7d6..48f2ed5b46963b5865ecb0f45d009becdc45e0cc 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_validate.c,v 1.101 2014/07/30 23:01:39 schwarze Exp $ */
+/*     $OpenBSD$ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,9 +15,7 @@
  * 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>
 
 
 #define        CHKARGS   struct man *man, struct man_node *n
 
-typedef        int     (*v_check)(CHKARGS);
+typedef        void    (*v_check)(CHKARGS);
 
-struct man_valid {
-       v_check  *pres;
-       v_check  *posts;
-};
-
-static int       check_eq0(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 void      check_eq0(CHKARGS);
+static void      check_eq2(CHKARGS);
+static void      check_le1(CHKARGS);
+static void      check_le5(CHKARGS);
+static void      check_par(CHKARGS);
+static void      check_part(CHKARGS);
+static void      check_root(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_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_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] = {
-       { 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 */
-       { NULL, NULL }, /* R */
-       { NULL, NULL }, /* B */
-       { NULL, NULL }, /* I */
-       { NULL, NULL }, /* IR */
-       { NULL, NULL }, /* RI */
-       { NULL, posts_eq0 }, /* na */
-       { NULL, posts_sp }, /* sp */
-       { NULL, posts_nf }, /* nf */
-       { NULL, posts_fi }, /* fi */
-       { NULL, NULL }, /* RE */
-       { 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 */
+static void      post_AT(CHKARGS);
+static void      post_IP(CHKARGS);
+static void      post_vs(CHKARGS);
+static void      post_fi(CHKARGS);
+static void      post_ft(CHKARGS);
+static void      post_nf(CHKARGS);
+static void      post_TH(CHKARGS);
+static void      post_UC(CHKARGS);
+static void      post_UR(CHKARGS);
+
+static v_check man_valids[MAN_MAX] = {
+       post_vs,    /* br */
+       post_TH,    /* TH */
+       NULL,       /* SH */
+       NULL,       /* SS */
+       NULL,       /* TP */
+       check_par,  /* LP */
+       check_par,  /* PP */
+       check_par,  /* P */
+       post_IP,    /* IP */
+       NULL,       /* HP */
+       NULL,       /* SM */
+       NULL,       /* SB */
+       NULL,       /* BI */
+       NULL,       /* IB */
+       NULL,       /* BR */
+       NULL,       /* RB */
+       NULL,       /* R */
+       NULL,       /* B */
+       NULL,       /* I */
+       NULL,       /* IR */
+       NULL,       /* RI */
+       check_eq0,  /* na */
+       post_vs,    /* sp */
+       post_nf,    /* nf */
+       post_fi,    /* fi */
+       NULL,       /* RE */
+       check_part, /* RS */
+       NULL,       /* DT */
+       post_UC,    /* UC */
+       check_le1,  /* PD */
+       post_AT,    /* AT */
+       NULL,       /* in */
+       post_ft,    /* ft */
+       check_eq2,  /* OP */
+       post_nf,    /* EX */
+       post_fi,    /* EE */
+       post_UR,    /* UR */
+       NULL,       /* UE */
+       NULL,       /* ll */
 };
 
 
-int
-man_valid_pre(struct man *man, struct man_node *n)
-{
-       v_check         *cp;
-
-       switch (n->type) {
-       case MAN_TEXT:
-               /* FALLTHROUGH */
-       case MAN_ROOT:
-               /* FALLTHROUGH */
-       case MAN_EQN:
-               /* FALLTHROUGH */
-       case MAN_TBL:
-               return(1);
-       default:
-               break;
-       }
-
-       if (NULL == (cp = man_valids[n->tok].pres))
-               return(1);
-       for ( ; *cp; cp++)
-               if ( ! (*cp)(man, n))
-                       return(0);
-       return(1);
-}
-
-int
+void
 man_valid_post(struct man *man)
 {
+       struct man_node *n;
        v_check         *cp;
 
-       if (MAN_VALID & man->last->flags)
-               return(1);
-       man->last->flags |= MAN_VALID;
+       n = man->last;
+       if (n->flags & MAN_VALID)
+               return;
+       n->flags |= MAN_VALID;
 
-       switch (man->last->type) {
+       switch (n->type) {
        case MAN_TEXT:
-               check_text(man, man->last);
-               return(1);
+               check_text(man, n);
+               break;
        case MAN_ROOT:
-               return(check_root(man, man->last));
+               check_root(man, n);
+               break;
        case MAN_EQN:
                /* FALLTHROUGH */
        case MAN_TBL:
-               return(1);
+               break;
        default:
+               cp = man_valids + n->tok;
+               if (*cp)
+                       (*cp)(man, n);
                break;
        }
-
-       if (NULL == (cp = man_valids[man->last->tok].posts))
-               return(1);
-       for ( ; *cp; cp++)
-               if ( ! (*cp)(man, man->last))
-                       return(0);
-
-       return(1);
 }
 
-static int
+static void
 check_root(CHKARGS)
 {
 
        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
 
        if (NULL == man->first->child)
-               man_nmsg(man, n, MANDOCERR_DOC_EMPTY);
+               mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
+                   n->line, n->pos, NULL);
        else
                man->meta.hasbody = 1;
 
        if (NULL == man->meta.title) {
-               man_nmsg(man, n, MANDOCERR_TH_MISSING);
+               mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
+                   n->line, n->pos, NULL);
 
                /*
                 * 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.title = mandoc_strdup("");
+               man->meta.msec = mandoc_strdup("");
                man->meta.date = man->quick ? mandoc_strdup("") :
                    mandoc_normdate(man->parse, NULL, n->line, n->pos);
        }
-
-       return(1);
 }
 
 static void
@@ -227,42 +173,39 @@ check_text(CHKARGS)
 }
 
 #define        INEQ_DEFINE(x, ineq, name) \
-static int \
+static void \
 check_##name(CHKARGS) \
 { \
        if (n->nchild ineq (x)) \
-               return(1); \
+               return; \
        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(2, ==, eq2)
 INEQ_DEFINE(1, <=, le1)
-INEQ_DEFINE(2, >=, ge2)
 INEQ_DEFINE(5, <=, le5)
 
-static int
-check_head1(CHKARGS)
+static void
+post_UR(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);
+       check_part(man, n);
 }
 
-static int
+static void
 post_ft(CHKARGS)
 {
        char    *cp;
        int      ok;
 
        if (0 == n->nchild)
-               return(1);
+               return;
 
        ok = 0;
        cp = n->child->string;
@@ -304,31 +247,18 @@ post_ft(CHKARGS)
        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
+static void
 check_part(CHKARGS)
 {
 
        if (MAN_BODY == n->type && 0 == n->nchild)
                mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
                    n->pos, "want children (have none)");
-
-       return(1);
 }
 
-static int
+static void
 check_par(CHKARGS)
 {
 
@@ -354,11 +284,9 @@ check_par(CHKARGS)
        default:
                break;
        }
-
-       return(1);
 }
 
-static int
+static void
 post_IP(CHKARGS)
 {
 
@@ -376,15 +304,16 @@ post_IP(CHKARGS)
        default:
                break;
        }
-       return(1);
 }
 
-static int
+static void
 post_TH(CHKARGS)
 {
        struct man_node *nb;
        const char      *p;
 
+       check_le5(man, n);
+
        free(man->meta.title);
        free(man->meta.vol);
        free(man->meta.source);
@@ -404,16 +333,19 @@ post_TH(CHKARGS)
                        /* Only warn about this once... */
                        if (isalpha((unsigned char)*p) &&
                            ! isupper((unsigned char)*p)) {
-                               mandoc_msg(MANDOCERR_TITLE_CASE,
+                               mandoc_vmsg(MANDOCERR_TITLE_CASE,
                                    man->parse, n->line,
                                    n->pos + (p - n->string),
-                                   n->string);
+                                   "TH %s", n->string);
                                break;
                        }
                }
                man->meta.title = mandoc_strdup(n->string);
-       } else
+       } else {
                man->meta.title = mandoc_strdup("");
+               mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
+                   nb->line, nb->pos, "TH");
+       }
 
        /* TITLE ->MSEC<- DATE SOURCE VOL */
 
@@ -421,8 +353,11 @@ post_TH(CHKARGS)
                n = n->next;
        if (n && n->string)
                man->meta.msec = mandoc_strdup(n->string);
-       else
+       else {
                man->meta.msec = mandoc_strdup("");
+               mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
+                   nb->line, nb->pos, "TH %s", man->meta.title);
+       }
 
        /* TITLE MSEC ->DATE<- SOURCE VOL */
 
@@ -435,13 +370,17 @@ post_TH(CHKARGS)
                        n->line, n->pos);
        } else {
                man->meta.date = mandoc_strdup("");
-               man_nmsg(man, n ? n : nb, MANDOCERR_DATE_MISSING);
+               mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
+                   n ? n->line : nb->line,
+                   n ? n->pos : nb->pos, "TH");
        }
 
        /* TITLE MSEC DATE ->SOURCE<- VOL */
 
        if (n && (n = n->next))
                man->meta.source = mandoc_strdup(n->string);
+       else if (man->defos != NULL)
+               man->meta.source = mandoc_strdup(man->defos);
 
        /* TITLE MSEC DATE SOURCE ->VOL<- */
        /* If missing, use the default VOL name for MSEC. */
@@ -457,32 +396,35 @@ post_TH(CHKARGS)
         * meta-data.
         */
        man_node_delete(man, man->last);
-       return(1);
 }
 
-static int
+static void
 post_nf(CHKARGS)
 {
 
+       check_eq0(man, n);
+
        if (MAN_LITERAL & man->flags)
-               man_nmsg(man, n, MANDOCERR_NF_SKIP);
+               mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
+                   n->line, n->pos, "nf");
 
        man->flags |= MAN_LITERAL;
-       return(1);
 }
 
-static int
+static void
 post_fi(CHKARGS)
 {
 
+       check_eq0(man, n);
+
        if ( ! (MAN_LITERAL & man->flags))
-               man_nmsg(man, n, MANDOCERR_FI_SKIP);
+               mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
+                   n->line, n->pos, "fi");
 
        man->flags &= ~MAN_LITERAL;
-       return(1);
 }
 
-static int
+static void
 post_UC(CHKARGS)
 {
        static const char * const bsd_versions[] = {
@@ -517,10 +459,9 @@ post_UC(CHKARGS)
 
        free(man->meta.source);
        man->meta.source = mandoc_strdup(p);
-       return(1);
 }
 
-static int
+static void
 post_AT(CHKARGS)
 {
        static const char * const unix_versions[] = {
@@ -555,15 +496,19 @@ post_AT(CHKARGS)
 
        free(man->meta.source);
        man->meta.source = mandoc_strdup(p);
-       return(1);
 }
 
-static int
+static void
 post_vs(CHKARGS)
 {
 
+       if (n->tok == MAN_br)
+               check_eq0(man, n);
+       else
+               check_le1(man, n);
+
        if (NULL != n->prev)
-               return(1);
+               return;
 
        switch (n->parent->tok) {
        case MAN_SH:
@@ -583,6 +528,4 @@ post_vs(CHKARGS)
        default:
                break;
        }
-
-       return(1);
 }