more bits for 1.14.2

[mandoc.git] / man_validate.c

diff --git a/man_validate.c b/man_validate.c
index 4a4c3560019dd9e9d9960e14e6cf1dd9f315068f..12ba6e22e97b209b559826fc3e4e59e6368849c7 100644 (file)
--- a/man_validate.c
+++ b/man_validate.c
@@ -1,15 +1,15 @@
 /*     $OpenBSD$ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*     $OpenBSD$ */
 /*
  * 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-2017 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
  * 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


@@ -28,18 +28,18 @@
 #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 "roff_int.h"
+#include "libman.h"

 
 

-#define        CHKARGS   struct man *man, struct man_node *n
+#define        CHKARGS   struct roff_man *man, struct roff_node *n

 
 typedef        void    (*v_check)(CHKARGS);
 
 
 typedef        void    (*v_check)(CHKARGS);
 

-static void      check_eq2(CHKARGS);
-static void      check_le5(CHKARGS);

 static void      check_par(CHKARGS);
 static void      check_part(CHKARGS);
 static void      check_root(CHKARGS);
 static void      check_par(CHKARGS);
 static void      check_part(CHKARGS);
 static void      check_root(CHKARGS);


@@ -47,16 +47,14 @@ static      void      check_text(CHKARGS);
 
 static void      post_AT(CHKARGS);
 static void      post_IP(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 void      post_TH(CHKARGS);
 static void      post_UC(CHKARGS);
 static void      post_UR(CHKARGS);

+static void      post_in(CHKARGS);
+static void      post_vs(CHKARGS);

 
 

-static v_check man_valids[MAN_MAX] = {
-       post_vs,    /* br */
+static const v_check __man_valids[MAN_MAX - MAN_TH] = {

        post_TH,    /* TH */
        NULL,       /* SH */
        NULL,       /* SS */
        post_TH,    /* TH */
        NULL,       /* SH */
        NULL,       /* SS */


@@ -77,52 +75,73 @@ static      v_check man_valids[MAN_MAX] = {
        NULL,       /* I */
        NULL,       /* IR */
        NULL,       /* RI */
        NULL,       /* I */
        NULL,       /* IR */
        NULL,       /* RI */

-       post_vs,    /* sp */
-       post_nf,    /* nf */
-       post_fi,    /* fi */
+       NULL,       /* nf */
+       NULL,       /* fi */

        NULL,       /* RE */
        check_part, /* RS */
        NULL,       /* DT */
        post_UC,    /* UC */
        NULL,       /* PD */
        post_AT,    /* AT */
        NULL,       /* RE */
        check_part, /* RS */
        NULL,       /* DT */
        post_UC,    /* UC */
        NULL,       /* PD */
        post_AT,    /* AT */

-       NULL,       /* in */
-       post_ft,    /* ft */
-       check_eq2,  /* OP */
-       post_nf,    /* EX */
-       post_fi,    /* EE */
+       post_in,    /* in */
+       post_OP,    /* OP */
+       NULL,       /* EX */
+       NULL,       /* EE */

        post_UR,    /* UR */
        NULL,       /* UE */
        post_UR,    /* UR */
        NULL,       /* UE */

-       NULL,       /* ll */
+       post_UR,    /* MT */
+       NULL,       /* ME */

 };
 };

+static const v_check *man_valids = __man_valids - MAN_TH;

 
 
 void
 
 
 void

-man_valid_post(struct man *man)
+man_node_validate(struct roff_man *man)

 {
 {

-       struct man_node *n;
-       v_check         *cp;
+       struct roff_node *n;
+       const v_check    *cp;

 
        n = man->last;
 
        n = man->last;

-       if (n->flags & MAN_VALID)
-               return;
-       n->flags |= MAN_VALID;
+       man->last = man->last->child;
+       while (man->last != NULL) {
+               man_node_validate(man);
+               if (man->last == n)
+                       man->last = man->last->child;
+               else
+                       man->last = man->last->next;
+       }

 
 

+       man->last = n;
+       man->next = ROFF_NEXT_SIBLING;

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

-       case MAN_TEXT:
+       case ROFFT_TEXT:

                check_text(man, n);
                break;
                check_text(man, n);
                break;

-       case MAN_ROOT:
+       case ROFFT_ROOT:

                check_root(man, n);
                break;
                check_root(man, n);
                break;

-       case MAN_EQN:
-               /* FALLTHROUGH */
-       case MAN_TBL:
+       case ROFFT_EQN:
+       case ROFFT_TBL:

                break;
        default:
                break;
        default:

+               if (n->tok < ROFF_MAX) {
+                       switch (n->tok) {
+                       case ROFF_br:
+                       case ROFF_sp:
+                               post_vs(man, n);
+                               break;
+                       default:
+                               roff_validate(man);
+                               break;
+                       }
+                       break;
+               }
+               assert(n->tok >= MAN_TH && n->tok < MAN_MAX);

                cp = man_valids + n->tok;
                if (*cp)
                        (*cp)(man, n);
                cp = man_valids + n->tok;
                if (*cp)
                        (*cp)(man, n);

+               if (man->last == n)
+                       man_state(man, n);

                break;
        }
 }
                break;
        }
 }


@@ -151,8 +170,14 @@ check_root(CHKARGS)
                man->meta.title = mandoc_strdup("");
                man->meta.msec = mandoc_strdup("");
                man->meta.date = man->quick ? mandoc_strdup("") :
                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);
+                   mandoc_normdate(man, NULL, n->line, n->pos);

        }
        }

+
+       if (man->meta.os_e &&
+           (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
+               mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0,
+                   man->meta.os_e == MANDOC_OS_OPENBSD ?
+                   "(OpenBSD)" : "(NetBSD)");

 }
 
 static void
 }
 
 static void


@@ -169,84 +194,37 @@ check_text(CHKARGS)
                    n->line, n->pos + (p - cp), NULL);
 }
 
                    n->line, n->pos + (p - cp), NULL);
 }
 

-#define        INEQ_DEFINE(x, ineq, name) \
-static void \
-check_##name(CHKARGS) \
-{ \
-       if (n->nchild ineq (x)) \
-               return; \
-       mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
-           "line arguments %s %d (have %d)", \
-           #ineq, (x), n->nchild); \
-}
-
-INEQ_DEFINE(2, ==, eq2)
-INEQ_DEFINE(5, <=, le5)
-

 static void
 static void

-post_UR(CHKARGS)
+post_OP(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);
-       check_part(man, n);
+       if (n->child == NULL)
+               mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
+                   n->line, n->pos, "OP");
+       else if (n->child->next != NULL && n->child->next->next != NULL) {
+               n = n->child->next->next;
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+                   n->line, n->pos, "OP ... %s", n->string);
+       }

 }
 
 static void
 }
 
 static void

-post_ft(CHKARGS)
+post_UR(CHKARGS)

 {
 {

-       char    *cp;
-       int      ok;
-
-       if (0 == n->nchild)
-               return;
-
-       ok = 0;
-       cp = n->child->string;
-       switch (*cp) {
-       case '1':
-               /* FALLTHROUGH */
-       case '2':
-               /* FALLTHROUGH */
-       case '3':
-               /* FALLTHROUGH */
-       case '4':
-               /* FALLTHROUGH */
-       case 'I':
-               /* FALLTHROUGH */
-       case 'P':
-               /* FALLTHROUGH */
-       case 'R':
-               if ('\0' == cp[1])
-                       ok = 1;
-               break;
-       case 'B':
-               if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
-                       ok = 1;
-               break;
-       case 'C':
-               if ('W' == cp[1] && '\0' == cp[2])
-                       ok = 1;
-               break;
-       default:
-               break;
-       }

 
 

-       if (0 == ok) {
-               mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
-                   n->line, n->pos, "ft %s", cp);
-               *cp = '\0';
-       }
+       if (n->type == ROFFT_HEAD && n->child == NULL)
+               mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
+                   n->line, n->pos, roff_name[n->tok]);
+       check_part(man, n);

 }
 
 static void
 check_part(CHKARGS)
 {
 
 }
 
 static void
 check_part(CHKARGS)
 {
 

-       if (n->type == MAN_BODY && n->child == NULL)
+       if (n->type == ROFFT_BODY && n->child == NULL)

                mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
                mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,

-                   n->line, n->pos, man_macronames[n->tok]);
+                   n->line, n->pos, roff_name[n->tok]);

 }
 
 static void
 }
 
 static void


@@ -254,23 +232,22 @@ check_par(CHKARGS)
 {
 
        switch (n->type) {
 {
 
        switch (n->type) {

-       case MAN_BLOCK:
-               if (0 == n->body->nchild)
-                       man_node_delete(man, n);
+       case ROFFT_BLOCK:
+               if (n->body->child == NULL)
+                       roff_node_delete(man, n);

                break;
                break;

-       case MAN_BODY:
-               if (0 == n->nchild)
+       case ROFFT_BODY:
+               if (n->child == NULL)

                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,

-                           "%s empty", man_macronames[n->tok]);
+                           "%s empty", roff_name[n->tok]);

                break;
                break;

-       case MAN_HEAD:
-               if (n->nchild)
+       case ROFFT_HEAD:
+               if (n->child != NULL)

                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                        mandoc_vmsg(MANDOCERR_ARG_SKIP,

-                           man->parse, n->line, n->pos,
-                           "%s %s%s", man_macronames[n->tok],
-                           n->child->string,
-                           n->nchild > 1 ? " ..." : "");
+                           man->parse, n->line, n->pos, "%s %s%s",
+                           roff_name[n->tok], n->child->string,
+                           n->child->next != NULL ? " ..." : "");

                break;
        default:
                break;
                break;
        default:
                break;


@@ -282,15 +259,15 @@ post_IP(CHKARGS)
 {
 
        switch (n->type) {
 {
 
        switch (n->type) {

-       case MAN_BLOCK:
-               if (0 == n->head->nchild && 0 == n->body->nchild)
-                       man_node_delete(man, n);
+       case ROFFT_BLOCK:
+               if (n->head->child == NULL && n->body->child == NULL)
+                       roff_node_delete(man, n);

                break;
                break;

-       case MAN_BODY:
-               if (0 == n->parent->head->nchild && 0 == n->nchild)
+       case ROFFT_BODY:
+               if (n->parent->head->child == NULL && n->child == NULL)

                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,

-                           "%s empty", man_macronames[n->tok]);
+                           "%s empty", roff_name[n->tok]);

                break;
        default:
                break;
                break;
        default:
                break;


@@ -300,23 +277,21 @@ post_IP(CHKARGS)
 static void
 post_TH(CHKARGS)
 {
 static void
 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) {


@@ -338,7 +313,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;


@@ -350,15 +325,14 @@ 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->string && '\0' != n->string[0]) {
                man->meta.date = man->quick ?
                    mandoc_strdup(n->string) :
 
        if (n)
                n = n->next;
        if (n && n->string && '\0' != n->string[0]) {
                man->meta.date = man->quick ?
                    mandoc_strdup(n->string) :

-                   mandoc_normdate(man->parse, n->string,
-                       n->line, n->pos);
+                   mandoc_normdate(man, n->string, n->line, n->pos);

        } else {
                man->meta.date = mandoc_strdup("");
                mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
        } else {
                man->meta.date = mandoc_strdup("");
                mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,


@@ -366,14 +340,20 @@ 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);
-       else if (man->defos != NULL)
-               man->meta.source = mandoc_strdup(man->defos);
+               man->meta.os = mandoc_strdup(n->string);
+       else if (man->os_s != NULL)
+               man->meta.os = mandoc_strdup(man->os_s);
+       if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
+               if (strstr(man->meta.os, "OpenBSD") != NULL)
+                       man->meta.os_e = MANDOC_OS_OPENBSD;
+               else if (strstr(man->meta.os, "NetBSD") != NULL)
+                       man->meta.os_e = MANDOC_OS_NETBSD;
+       }

 
 

-       /* 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))


@@ -382,33 +362,15 @@ 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.
         */
        /*
         * Remove the `TH' node after we've processed it for our
         * meta-data.
         */

-       man_node_delete(man, man->last);
-}
-
-static void
-post_nf(CHKARGS)
-{
-
-       if (man->flags & MAN_LITERAL)
-               mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
-                   n->line, n->pos, "nf");
-
-       man->flags |= MAN_LITERAL;
-}
-
-static void
-post_fi(CHKARGS)
-{
-
-       if ( ! (MAN_LITERAL & man->flags))
-               mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
-                   n->line, n->pos, "fi");
-
-       man->flags &= ~MAN_LITERAL;
+       roff_node_delete(man, man->last);

 }
 
 static void
 }
 
 static void


@@ -426,7 +388,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;


@@ -444,8 +406,8 @@ post_UC(CHKARGS)
                        p = bsd_versions[0];
        }
 
                        p = bsd_versions[0];
        }
 

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

 }
 
 static void
 }
 
 static void


@@ -458,12 +420,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;


@@ -473,7 +435,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];


@@ -481,8 +445,24 @@ post_AT(CHKARGS)
                        p = unix_versions[0];
        }
 
                        p = unix_versions[0];
        }
 

-       free(man->meta.source);
-       man->meta.source = mandoc_strdup(p);
+       free(man->meta.os);
+       man->meta.os = mandoc_strdup(p);
+}
+
+static void
+post_in(CHKARGS)
+{
+       char    *s;
+
+       if (n->parent->tok != MAN_TP ||
+           n->parent->type != ROFFT_HEAD ||
+           n->child == NULL ||
+           *n->child->string == '+' ||
+           *n->child->string == '-')
+               return;
+       mandoc_asprintf(&s, "+%s", n->child->string);
+       free(n->child->string);
+       n->child->string = s;

 }
 
 static void
 }
 
 static void


@@ -494,18 +474,20 @@ post_vs(CHKARGS)
 
        switch (n->parent->tok) {
        case MAN_SH:
 
        switch (n->parent->tok) {
        case MAN_SH:

-               /* FALLTHROUGH */

        case MAN_SS:
        case MAN_SS:

+       case MAN_PP:
+       case MAN_LP:
+       case MAN_P:

                mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
                mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,

-                   "%s after %s", man_macronames[n->tok],
-                   man_macronames[n->parent->tok]);
+                   "%s after %s", roff_name[n->tok],
+                   roff_name[n->parent->tok]);

                /* FALLTHROUGH */
                /* FALLTHROUGH */

-       case MAN_MAX:
+       case TOKEN_NONE:

                /*
                 * Don't warn about this because it occurs in pod2man
                 * and would cause considerable (unfixable) warnage.
                 */
                /*
                 * Don't warn about this because it occurs in pod2man
                 * and would cause considerable (unfixable) warnage.
                 */

-               man_node_delete(man, n);
+               roff_node_delete(man, n);

                break;
        default:
                break;
                break;
        default:
                break;