look at COHERENT troff

[mandoc.git] / man_validate.c

diff --git a/man_validate.c b/man_validate.c
index c17eb9ecdac662d7eabf678dd4cbc00a4d48bb84..3a695d00b0369cc0dd58235b3162b29a00e53d10 100644 (file)
--- a/man_validate.c
+++ b/man_validate.c
@@ -1,23 +1,21 @@
-/*     $Id: man_validate.c,v 1.105 2014/08/06 15:09:05 schwarze Exp $ */
+/*     $OpenBSD$ */

 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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"
 #include "config.h"

-#endif

 
 #include <sys/types.h>
 
 
 #include <sys/types.h>
 


@@ -30,34 +28,32 @@
 #include <string.h>
 #include <time.h>
 
 #include <string.h>
 #include <time.h>
 

-#include "man.h"
-#include "mandoc.h"

 #include "mandoc_aux.h"
 #include "mandoc_aux.h"

-#include "libman.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"

 #include "libmandoc.h"
 #include "libmandoc.h"

+#include "libman.h"
+
+#define        CHKARGS   struct man *man, struct roff_node *n
+
+typedef        void    (*v_check)(CHKARGS);

 
 

-#define        CHKARGS   struct man *man, struct man_node *n
-
-typedef        int     (*v_check)(CHKARGS);
-
-static int       check_eq0(CHKARGS);
-static int       check_eq2(CHKARGS);
-static int       check_le1(CHKARGS);
-static int       check_le5(CHKARGS);
-static int       check_par(CHKARGS);
-static int       check_part(CHKARGS);
-static int       check_root(CHKARGS);
-static int       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       post_UR(CHKARGS);
+static void      check_par(CHKARGS);
+static void      check_part(CHKARGS);
+static void      check_root(CHKARGS);
+static void      check_text(CHKARGS);
+
+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_OP(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 */
 
 static v_check man_valids[MAN_MAX] = {
        post_vs,    /* br */


@@ -81,7 +77,6 @@ static        v_check man_valids[MAN_MAX] = {
        NULL,       /* I */
        NULL,       /* IR */
        NULL,       /* RI */
        NULL,       /* I */
        NULL,       /* IR */
        NULL,       /* RI */

-       check_eq0,  /* na */

        post_vs,    /* sp */
        post_nf,    /* nf */
        post_fi,    /* fi */
        post_vs,    /* sp */
        post_nf,    /* nf */
        post_fi,    /* fi */


@@ -89,11 +84,11 @@ static      v_check man_valids[MAN_MAX] = {
        check_part, /* RS */
        NULL,       /* DT */
        post_UC,    /* UC */
        check_part, /* RS */
        NULL,       /* DT */
        post_UC,    /* UC */

-       check_le1,  /* PD */
+       NULL,       /* PD */

        post_AT,    /* AT */
        NULL,       /* in */
        post_ft,    /* ft */
        post_AT,    /* AT */
        NULL,       /* in */
        post_ft,    /* ft */

-       check_eq2,  /* OP */
+       post_OP,    /* OP */

        post_nf,    /* EX */
        post_fi,    /* EE */
        post_UR,    /* UR */
        post_nf,    /* EX */
        post_fi,    /* EE */
        post_UR,    /* UR */


@@ -102,33 +97,37 @@ static     v_check man_valids[MAN_MAX] = {
 };
 
 
 };
 
 

-int
+void

 man_valid_post(struct man *man)
 {
 man_valid_post(struct man *man)
 {

-       struct man_node *n;
+       struct roff_node *n;

        v_check         *cp;
 
        n = man->last;
        if (n->flags & MAN_VALID)
        v_check         *cp;
 
        n = man->last;
        if (n->flags & MAN_VALID)

-               return(1);
+               return;

        n->flags |= MAN_VALID;
 
        switch (n->type) {
        n->flags |= MAN_VALID;
 
        switch (n->type) {

-       case MAN_TEXT:
-               return(check_text(man, n));
-       case MAN_ROOT:
-               return(check_root(man, n));
-       case MAN_EQN:
+       case ROFFT_TEXT:
+               check_text(man, n);
+               break;
+       case ROFFT_ROOT:
+               check_root(man, n);
+               break;
+       case ROFFT_EQN:

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case MAN_TBL:
-               return(1);
+       case ROFFT_TBL:
+               break;

        default:
                cp = man_valids + n->tok;
        default:
                cp = man_valids + n->tok;

-               return(*cp ? (*cp)(man, n) : 1);
+               if (*cp)
+                       (*cp)(man, n);
+               break;

        }
 }
 
        }
 }
 

-static int
+static void

 check_root(CHKARGS)
 {
 
 check_root(CHKARGS)
 {
 


@@ -154,61 +153,54 @@ check_root(CHKARGS)
                man->meta.date = man->quick ? mandoc_strdup("") :
                    mandoc_normdate(man->parse, NULL, n->line, n->pos);
        }
                man->meta.date = man->quick ? mandoc_strdup("") :
                    mandoc_normdate(man->parse, NULL, n->line, n->pos);
        }

-
-       return(1);

 }
 
 }
 

-static int
+static void

 check_text(CHKARGS)
 {
        char            *cp, *p;
 
        if (MAN_LITERAL & man->flags)
 check_text(CHKARGS)
 {
        char            *cp, *p;
 
        if (MAN_LITERAL & man->flags)

-               return(1);
+               return;

 
        cp = n->string;
        for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                    n->line, n->pos + (p - cp), NULL);
 
        cp = n->string;
        for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                    n->line, n->pos + (p - cp), NULL);

-       return(1);

 }
 
 }
 

-#define        INEQ_DEFINE(x, ineq, name) \
-static int \
-check_##name(CHKARGS) \
-{ \
-       if (n->nchild ineq (x)) \
-               return(1); \
-       mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
-           "line arguments %s %d (have %d)", \
-           #ineq, (x), n->nchild); \
-       return(1); \
-}
+static void
+post_OP(CHKARGS)
+{

 
 

-INEQ_DEFINE(0, ==, eq0)
-INEQ_DEFINE(2, ==, eq2)
-INEQ_DEFINE(1, <=, le1)
-INEQ_DEFINE(5, <=, le5)
+       if (n->nchild == 0)
+               mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
+                   n->line, n->pos, "OP");
+       else if (n->nchild > 2) {
+               n = n->child->next->next;
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+                   n->line, n->pos, "OP ... %s", n->string);
+       }
+}

 
 

-static int
+static void

 post_UR(CHKARGS)
 {
 
 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(check_part(man, n));
+       if (n->type == ROFFT_HEAD && n->child == NULL)
+               mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
+                   n->line, n->pos, "UR");
+       check_part(man, n);

 }
 
 }
 

-static int
+static void

 post_ft(CHKARGS)
 {
        char    *cp;
        int      ok;
 
        if (0 == n->nchild)
 post_ft(CHKARGS)
 {
        char    *cp;
        int      ok;
 
        if (0 == n->nchild)

-               return(1);
+               return;

 
        ok = 0;
        cp = n->child->string;
 
        ok = 0;
        cp = n->child->string;


@@ -246,41 +238,33 @@ post_ft(CHKARGS)
                    n->line, n->pos, "ft %s", cp);
                *cp = '\0';
        }
                    n->line, n->pos, "ft %s", cp);
                *cp = '\0';
        }

-
-       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
+static void

 check_part(CHKARGS)
 {
 
 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);
+       if (n->type == ROFFT_BODY && n->child == NULL)
+               mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
+                   n->line, n->pos, man_macronames[n->tok]);

 }
 
 }
 

-static int
+static void

 check_par(CHKARGS)
 {
 
        switch (n->type) {
 check_par(CHKARGS)
 {
 
        switch (n->type) {

-       case MAN_BLOCK:
+       case ROFFT_BLOCK:

                if (0 == n->body->nchild)
                        man_node_delete(man, n);
                break;
                if (0 == n->body->nchild)
                        man_node_delete(man, n);
                break;

-       case MAN_BODY:
+       case ROFFT_BODY:

                if (0 == n->nchild)
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
                            "%s empty", man_macronames[n->tok]);
                break;
                if (0 == n->nchild)
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
                            "%s empty", man_macronames[n->tok]);
                break;

-       case MAN_HEAD:
+       case ROFFT_HEAD:

                if (n->nchild)
                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                            man->parse, n->line, n->pos,
                if (n->nchild)
                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                            man->parse, n->line, n->pos,


@@ -291,20 +275,18 @@ check_par(CHKARGS)
        default:
                break;
        }
        default:
                break;
        }

-
-       return(1);

 }
 
 }
 

-static int
+static void

 post_IP(CHKARGS)
 {
 
        switch (n->type) {
 post_IP(CHKARGS)
 {
 
        switch (n->type) {

-       case MAN_BLOCK:
+       case ROFFT_BLOCK:

                if (0 == n->head->nchild && 0 == n->body->nchild)
                        man_node_delete(man, n);
                break;
                if (0 == n->head->nchild && 0 == n->body->nchild)
                        man_node_delete(man, n);
                break;

-       case MAN_BODY:
+       case ROFFT_BODY:

                if (0 == n->parent->head->nchild && 0 == n->nchild)
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
                if (0 == n->parent->head->nchild && 0 == n->nchild)
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,


@@ -313,29 +295,26 @@ post_IP(CHKARGS)
        default:
                break;
        }
        default:
                break;
        }

-       return(1);

 }
 
 }
 

-static int
+static void

 post_TH(CHKARGS)
 {
 post_TH(CHKARGS)
 {

-       struct man_node *nb;
+       struct roff_node *nb;

        const char      *p;
 
        const char      *p;
 

-       check_le5(man, n);
-

        free(man->meta.title);
        free(man->meta.vol);
        free(man->meta.title);
        free(man->meta.vol);

-       free(man->meta.source);
+       free(man->meta.os);

        free(man->meta.msec);
        free(man->meta.date);
 
        man->meta.title = man->meta.vol = man->meta.date =
        free(man->meta.msec);
        free(man->meta.date);
 
        man->meta.title = man->meta.vol = man->meta.date =

-           man->meta.msec = man->meta.source = NULL;
+           man->meta.msec = man->meta.os = NULL;

 
        nb = n;
 
 
        nb = n;
 

-       /* ->TITLE<- MSEC DATE SOURCE VOL */
+       /* ->TITLE<- MSEC DATE OS VOL */

 
        n = n->child;
        if (n && n->string) {
 
        n = n->child;
        if (n && n->string) {


@@ -357,7 +336,7 @@ post_TH(CHKARGS)
                    nb->line, nb->pos, "TH");
        }
 
                    nb->line, nb->pos, "TH");
        }
 

-       /* TITLE ->MSEC<- DATE SOURCE VOL */
+       /* TITLE ->MSEC<- DATE OS VOL */

 
        if (n)
                n = n->next;
 
        if (n)
                n = n->next;


@@ -369,7 +348,7 @@ post_TH(CHKARGS)
                    nb->line, nb->pos, "TH %s", man->meta.title);
        }
 
                    nb->line, nb->pos, "TH %s", man->meta.title);
        }
 

-       /* TITLE MSEC ->DATE<- SOURCE VOL */
+       /* TITLE MSEC ->DATE<- OS VOL */

 
        if (n)
                n = n->next;
 
        if (n)
                n = n->next;


@@ -385,12 +364,14 @@ post_TH(CHKARGS)
                    n ? n->pos : nb->pos, "TH");
        }
 
                    n ? n->pos : nb->pos, "TH");
        }
 

-       /* TITLE MSEC DATE ->SOURCE<- VOL */
+       /* TITLE MSEC DATE ->OS<- VOL */

 
        if (n && (n = n->next))
 
        if (n && (n = n->next))

-               man->meta.source = mandoc_strdup(n->string);
+               man->meta.os = mandoc_strdup(n->string);
+       else if (man->defos != NULL)
+               man->meta.os = mandoc_strdup(man->defos);

 
 

-       /* TITLE MSEC DATE SOURCE ->VOL<- */
+       /* TITLE MSEC DATE OS ->VOL<- */

        /* If missing, use the default VOL name for MSEC. */
 
        if (n && (n = n->next))
        /* If missing, use the default VOL name for MSEC. */
 
        if (n && (n = n->next))


@@ -399,43 +380,40 @@ post_TH(CHKARGS)
            (NULL != (p = mandoc_a2msec(man->meta.msec))))
                man->meta.vol = mandoc_strdup(p);
 
            (NULL != (p = mandoc_a2msec(man->meta.msec))))
                man->meta.vol = mandoc_strdup(p);
 

+       if (n != NULL && (n = n->next) != NULL)
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+                   n->line, n->pos, "TH ... %s", n->string);
+

        /*
         * Remove the `TH' node after we've processed it for our
         * meta-data.
         */
        man_node_delete(man, man->last);
        /*
         * Remove the `TH' node after we've processed it for our
         * meta-data.
         */
        man_node_delete(man, man->last);

-       return(1);

 }
 
 }
 

-static int
+static void

 post_nf(CHKARGS)
 {
 
 post_nf(CHKARGS)
 {
 

-       check_eq0(man, n);
-
-       if (MAN_LITERAL & man->flags)
+       if (man->flags & MAN_LITERAL)

                mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                    n->line, n->pos, "nf");
 
        man->flags |= MAN_LITERAL;
                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)
 {
 
 post_fi(CHKARGS)
 {
 

-       check_eq0(man, n);
-

        if ( ! (MAN_LITERAL & man->flags))
                mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                    n->line, n->pos, "fi");
 
        man->flags &= ~MAN_LITERAL;
        if ( ! (MAN_LITERAL & man->flags))
                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[] = {
 post_UC(CHKARGS)
 {
        static const char * const bsd_versions[] = {


@@ -450,7 +428,7 @@ post_UC(CHKARGS)
 
        n = n->child;
 
 
        n = n->child;
 

-       if (NULL == n || MAN_TEXT != n->type)
+       if (n == NULL || n->type != ROFFT_TEXT)

                p = bsd_versions[0];
        else {
                s = n->string;
                p = bsd_versions[0];
        else {
                s = n->string;


@@ -468,12 +446,11 @@ post_UC(CHKARGS)
                        p = bsd_versions[0];
        }
 
                        p = bsd_versions[0];
        }
 

-       free(man->meta.source);
-       man->meta.source = mandoc_strdup(p);
-       return(1);
+       free(man->meta.os);
+       man->meta.os = mandoc_strdup(p);

 }
 
 }
 

-static int
+static void

 post_AT(CHKARGS)
 {
        static const char * const unix_versions[] = {
 post_AT(CHKARGS)
 {
        static const char * const unix_versions[] = {


@@ -483,12 +460,12 @@ post_AT(CHKARGS)
            "System V Release 2",
        };
 
            "System V Release 2",
        };
 

+       struct roff_node *nn;

        const char      *p, *s;
        const char      *p, *s;

-       struct man_node *nn;

 
        n = n->child;
 
 
        n = n->child;
 

-       if (NULL == n || MAN_TEXT != n->type)
+       if (n == NULL || n->type != ROFFT_TEXT)

                p = unix_versions[0];
        else {
                s = n->string;
                p = unix_versions[0];
        else {
                s = n->string;


@@ -498,7 +475,9 @@ post_AT(CHKARGS)
                        p = unix_versions[1];
                else if (0 == strcmp(s, "5")) {
                        nn = n->next;
                        p = unix_versions[1];
                else if (0 == strcmp(s, "5")) {
                        nn = n->next;

-                       if (nn && MAN_TEXT == nn->type && nn->string[0])
+                       if (nn != NULL &&
+                           nn->type == ROFFT_TEXT &&
+                           nn->string[0] != '\0')

                                p = unix_versions[3];
                        else
                                p = unix_versions[2];
                                p = unix_versions[3];
                        else
                                p = unix_versions[2];


@@ -506,22 +485,16 @@ post_AT(CHKARGS)
                        p = unix_versions[0];
        }
 
                        p = unix_versions[0];
        }
 

-       free(man->meta.source);
-       man->meta.source = mandoc_strdup(p);
-       return(1);
+       free(man->meta.os);
+       man->meta.os = mandoc_strdup(p);

 }
 
 }
 

-static int
+static void

 post_vs(CHKARGS)
 {
 
 post_vs(CHKARGS)
 {
 

-       if (n->tok == MAN_br)
-               check_eq0(man, n);
-       else
-               check_le1(man, n);
-

        if (NULL != n->prev)
        if (NULL != n->prev)

-               return(1);
+               return;

 
        switch (n->parent->tok) {
        case MAN_SH:
 
        switch (n->parent->tok) {
        case MAN_SH:


@@ -541,6 +514,4 @@ post_vs(CHKARGS)
        default:
                break;
        }
        default:
                break;
        }

-
-       return(1);

 }
 }