]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_validate.c
FreeBSD, NetBSD and DragonFly use the same names as Linux.
[mandoc.git] / man_validate.c
index c09ab36c5f9173488721a8476cc982a11a373b4a..e40b089f53b8df2207a13159883eafb8e80240c4 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_validate.c,v 1.63 2011/03/07 01:35:51 schwarze Exp $ */
+/*     $Id: man_validate.c,v 1.80 2012/01/03 15:16:24 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -30,6 +30,7 @@
 #include <string.h>
 #include <time.h>
 
+#include "man.h"
 #include "mandoc.h"
 #include "libman.h"
 #include "libmandoc.h"
@@ -43,49 +44,52 @@ struct      man_valid {
        v_check  *posts;
 };
 
-static int       check_bline(CHKARGS);
 static int       check_eq0(CHKARGS);
-static int       check_ft(CHKARGS);
+static int       check_eq2(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_text(CHKARGS);
+static void      check_text(CHKARGS);
 
 static int       post_AT(CHKARGS);
+static int       post_vs(CHKARGS);
 static int       post_fi(CHKARGS);
+static int       post_ft(CHKARGS);
 static int       post_nf(CHKARGS);
+static int       post_sec(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_le1[] = { check_le1, NULL };
-static v_check   posts_ft[] = { check_ft, NULL };
+static v_check   posts_ft[] = { post_ft, 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_sec[] = { check_sec, NULL };
+static v_check   posts_sec[] = { post_sec, 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   pres_bline[] = { check_bline, NULL };
-
+static v_check   pres_sec[] = { pre_sec, NULL };
 
 static const struct man_valid man_valids[MAN_MAX] = {
-       { NULL, posts_eq0 }, /* br */
-       { pres_bline, posts_th }, /* TH */
-       { pres_bline, posts_sec }, /* SH */
-       { pres_bline, posts_sec }, /* SS */
-       { pres_bline, NULL }, /* TP */
-       { pres_bline, posts_par }, /* LP */
-       { pres_bline, posts_par }, /* PP */
-       { pres_bline, posts_par }, /* P */
-       { pres_bline, NULL }, /* IP */
-       { pres_bline, NULL }, /* HP */
+       { NULL, posts_br }, /* br */
+       { NULL, posts_th }, /* TH */
+       { pres_sec, posts_sec }, /* SH */
+       { pres_sec, posts_sec }, /* SS */
+       { NULL, NULL }, /* TP */
+       { NULL, posts_par }, /* LP */
+       { NULL, posts_par }, /* PP */
+       { NULL, posts_par }, /* P */
+       { NULL, NULL }, /* IP */
+       { NULL, NULL }, /* HP */
        { NULL, NULL }, /* SM */
        { NULL, NULL }, /* SB */
        { NULL, NULL }, /* BI */
@@ -97,10 +101,10 @@ static     const struct man_valid man_valids[MAN_MAX] = {
        { NULL, NULL }, /* I */
        { NULL, NULL }, /* IR */
        { NULL, NULL }, /* RI */
-       { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
-       { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
-       { pres_bline, posts_nf }, /* nf */
-       { pres_bline, posts_fi }, /* fi */
+       { 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 */
@@ -109,6 +113,7 @@ static      const struct man_valid man_valids[MAN_MAX] = {
        { NULL, posts_at }, /* AT */
        { NULL, NULL }, /* in */
        { NULL, posts_ft }, /* ft */
+       { NULL, posts_eq2 }, /* OP */
 };
 
 
@@ -150,7 +155,8 @@ man_valid_post(struct man *m)
 
        switch (m->last->type) {
        case (MAN_TEXT): 
-               return(check_text(m, m->last));
+               check_text(m, m->last);
+               return(1);
        case (MAN_ROOT):
                return(check_root(m, m->last));
        case (MAN_EQN):
@@ -196,71 +202,46 @@ check_root(CHKARGS)
 
                m->meta.title = mandoc_strdup("unknown");
                m->meta.msec = mandoc_strdup("1");
-               m->meta.date = mandoc_normdate(NULL,
-                   m->msg, m->data, n->line, n->pos);
+               m->meta.date = mandoc_normdate
+                       (m->parse, NULL, n->line, n->pos);
        }
 
        return(1);
 }
 
-
-static int
-check_text(CHKARGS) 
+static void
+check_text(CHKARGS)
 {
-       char            *p;
-       int              pos, c;
-       size_t           sz;
-
-       for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
-               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_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
-                               continue;
-                       return(0);
-               }
-
-               /* Check the special character. */
+       char            *cp, *p;
 
-               c = mandoc_special(p);
-               if (c) {
-                       p += c - 1;
-                       pos += c - 1;
-               } else
-                       man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
-       }
+       if (MAN_LITERAL & m->flags)
+               return;
 
-       return(1);
+       cp = n->string;
+       for (p = cp; NULL != (p = strchr(p, '\t')); p++)
+               man_pmsg(m, n->line, (int)(p - cp), MANDOCERR_BADTAB);
 }
 
-
 #define        INEQ_DEFINE(x, ineq, name) \
 static int \
 check_##name(CHKARGS) \
 { \
        if (n->nchild ineq (x)) \
                return(1); \
-       man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos, \
+       mandoc_vmsg(MANDOCERR_ARGCOUNT, m->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_ft(CHKARGS)
+post_ft(CHKARGS)
 {
        char    *cp;
        int      ok;
@@ -300,38 +281,48 @@ check_ft(CHKARGS)
        }
 
        if (0 == ok) {
-               man_vmsg(m, MANDOCERR_BADFONT,
-                               n->line, n->pos, "%s", cp);
+               mandoc_vmsg
+                       (MANDOCERR_BADFONT, m->parse,
+                        n->line, n->pos, "%s", cp);
                *cp = '\0';
        }
 
        if (1 < n->nchild)
-               man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos,
-                               "want one child (have %d)", n->nchild);
+               mandoc_vmsg
+                       (MANDOCERR_ARGCOUNT, m->parse, n->line, 
+                        n->pos, "want one child (have %d)", 
+                        n->nchild);
 
        return(1);
 }
 
 static int
-check_sec(CHKARGS)
+pre_sec(CHKARGS)
 {
 
-       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)
-               man_nmsg(m, n, MANDOCERR_NOBODY);
-
+       if (MAN_BLOCK == n->type)
+               m->flags &= ~MAN_LITERAL;
        return(1);
 }
 
+static int
+post_sec(CHKARGS)
+{
+
+       if ( ! (MAN_HEAD == n->type && 0 == n->nchild)) 
+               return(1);
+
+       man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
+       return(0);
+}
 
 static int
 check_part(CHKARGS)
 {
 
        if (MAN_BODY == n->type && 0 == n->nchild)
-               man_nmsg(m, n, MANDOCERR_NOBODY);
+               mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line, 
+                               n->pos, "want children (have none)");
 
        return(1);
 }
@@ -362,19 +353,6 @@ check_par(CHKARGS)
 }
 
 
-static int
-check_bline(CHKARGS)
-{
-
-       assert( ! (MAN_ELINE & m->flags));
-       if (MAN_BLINE & m->flags) {
-               man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
-               return(0);
-       }
-
-       return(1);
-}
-
 static int
 post_TH(CHKARGS)
 {
@@ -403,7 +381,8 @@ post_TH(CHKARGS)
        if (n && n->string) {
                for (p = n->string; '\0' != *p; p++) {
                        /* Only warn about this once... */
-                       if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
+                       if (isalpha((unsigned char)*p) && 
+                                       ! isupper((unsigned char)*p)) {
                                man_nmsg(m, n, MANDOCERR_UPPERCASE);
                                break;
                        }
@@ -425,10 +404,12 @@ post_TH(CHKARGS)
 
        if (n)
                n = n->next;
-       if (n)
+       if (n && n->string && '\0' != n->string[0]) {
                pos = n->pos;
-       m->meta.date = mandoc_normdate(n ? n->string : NULL,
-           m->msg, m->data, line, pos);
+               m->meta.date = mandoc_normdate
+                   (m->parse, n->string, line, pos);
+       } else
+               m->meta.date = mandoc_strdup("");
 
        /* TITLE MSEC DATE ->SOURCE<- VOL */
 
@@ -436,9 +417,13 @@ post_TH(CHKARGS)
                m->meta.source = mandoc_strdup(n->string);
 
        /* TITLE MSEC DATE SOURCE ->VOL<- */
+       /* If missing, use the default VOL name for MSEC. */
 
        if (n && (n = n->next))
                m->meta.vol = mandoc_strdup(n->string);
+       else if ('\0' != m->meta.msec[0] &&
+           (NULL != (p = mandoc_a2msec(m->meta.msec))))
+               m->meta.vol = mandoc_strdup(p);
 
        /*
         * Remove the `TH' node after we've processed it for our
@@ -484,7 +469,6 @@ post_UC(CHKARGS)
        const char      *p, *s;
 
        n = n->child;
-       n = m->last->child;
 
        if (NULL == n || MAN_TEXT != n->type)
                p = bsd_versions[0];
@@ -550,3 +534,17 @@ post_AT(CHKARGS)
        m->meta.source = mandoc_strdup(p);
        return(1);
 }
+
+static int
+post_vs(CHKARGS)
+{
+
+       /* 
+        * Don't warn about this because it occurs in pod2man and would
+        * cause considerable (unfixable) warnage.
+        */
+       if (NULL == n->prev && MAN_ROOT == n->parent->type)
+               man_node_delete(m, n);
+
+       return(1);
+}