Since resetting of offsets works quite differently in man(7) and mdoc(7),

[mandoc.git] / man_validate.c

diff --git a/man_validate.c b/man_validate.c
index 59baf88a718a27b1057f8dbf047c9b1f6697dca1..4bfaf764e6c8c542efad2d0960eeb99d5e85e019 100644 (file)
--- a/man_validate.c
+++ b/man_validate.c
@@ -1,7 +1,7 @@
-/*     $OpenBSD$ */
+/*     $Id: man_validate.c,v 1.146 2018/12/31 10:04:39 schwarze Exp $ */

 /*
  * 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-2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2018 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -24,6 +24,7 @@
 #include <errno.h>
 #include <limits.h>
 #include <stdarg.h>
 #include <errno.h>
 #include <limits.h>
 #include <stdarg.h>

+#include <stdio.h>

 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>


@@ -40,31 +41,32 @@
 
 typedef        void    (*v_check)(CHKARGS);
 
 
 typedef        void    (*v_check)(CHKARGS);
 

+static void      check_abort(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      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_EE(CHKARGS);
+static void      post_EX(CHKARGS);

 static void      post_IP(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_OP(CHKARGS);

+static void      post_SH(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 v_check man_valids[MAN_MAX] = {
-       post_vs,    /* br */
+static const v_check man_valids[MAN_MAX - MAN_TH] = {

        post_TH,    /* TH */
        post_TH,    /* TH */

-       NULL,       /* SH */
-       NULL,       /* SS */
+       post_SH,    /* SH */
+       post_SH,    /* SS */

        NULL,       /* TP */
        NULL,       /* TP */

-       check_par,  /* LP */
+       NULL,       /* TQ */
+       check_abort,/* LP */

        check_par,  /* PP */
        check_par,  /* PP */

-       check_par,  /* P */
+       check_abort,/* P */

        post_IP,    /* IP */
        NULL,       /* HP */
        NULL,       /* SM */
        post_IP,    /* IP */
        NULL,       /* HP */
        NULL,       /* SM */


@@ -78,37 +80,65 @@ 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,       /* 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 */
+       post_in,    /* in */
+       NULL,       /* SY */
+       NULL,       /* YS */

        post_OP,    /* OP */
        post_OP,    /* OP */

-       post_nf,    /* EX */
-       post_fi,    /* EE */
+       post_EX,    /* EX */
+       post_EE,    /* EE */

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

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

 };
 
 
 };
 
 

+/* Validate the subtree rooted at man->last. */

 void
 void

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

 {
        struct roff_node *n;
 {
        struct roff_node *n;

-       v_check         *cp;
+       const v_check    *cp;
+
+       /*
+        * Translate obsolete macros such that later code
+        * does not need to look for them.
+        */

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

-       if (n->flags & MAN_VALID)
-               return;
-       n->flags |= MAN_VALID;
+       switch (n->tok) {
+       case MAN_LP:
+       case MAN_P:
+               n->tok = MAN_PP;
+               break;
+       default:
+               break;
+       }

 
 

+       /*
+        * Iterate over all children, recursing into each one
+        * in turn, depth-first.
+        */
+
+       man->last = man->last->child;
+       while (man->last != NULL) {
+               man_validate(man);
+               if (man->last == n)
+                       man->last = man->last->child;
+               else
+                       man->last = man->last->next;
+       }
+
+       /* Finally validate the macro itself. */
+
+       man->last = n;
+       man->next = ROFF_NEXT_SIBLING;

        switch (n->type) {
        case ROFFT_TEXT:
                check_text(man, n);
        switch (n->type) {
        case ROFFT_TEXT:
                check_text(man, n);


@@ -116,14 +146,21 @@ man_valid_post(struct roff_man *man)
        case ROFFT_ROOT:
                check_root(man, n);
                break;
        case ROFFT_ROOT:
                check_root(man, n);
                break;

+       case ROFFT_COMMENT:

        case ROFFT_EQN:
        case ROFFT_EQN:

-               /* FALLTHROUGH */

        case ROFFT_TBL:
                break;
        default:
        case ROFFT_TBL:
                break;
        default:

-               cp = man_valids + n->tok;
+               if (n->tok < ROFF_MAX) {
+                       roff_validate(man);
+                       break;
+               }
+               assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
+               cp = man_valids + (n->tok - MAN_TH);

                if (*cp)
                        (*cp)(man, n);
                if (*cp)
                        (*cp)(man, n);

+               if (man->last == n)
+                       n->flags |= NODE_VALID;

                break;
        }
 }
                break;
        }
 }


@@ -131,18 +168,15 @@ man_valid_post(struct roff_man *man)
 static void
 check_root(CHKARGS)
 {
 static void
 check_root(CHKARGS)
 {

-

        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
 
        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
 

-       if (NULL == man->first->child)
-               mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
-                   n->line, n->pos, NULL);
+       if (n->last == NULL || n->last->type == ROFFT_COMMENT)
+               mandoc_msg(MANDOCERR_DOC_EMPTY, n->line, n->pos, NULL);

        else
                man->meta.hasbody = 1;
 
        if (NULL == man->meta.title) {
        else
                man->meta.hasbody = 1;
 
        if (NULL == man->meta.title) {

-               mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
-                   n->line, n->pos, NULL);
+               mandoc_msg(MANDOCERR_TH_NOTITLE, n->line, n->pos, NULL);

 
                /*
                 * If a title hasn't been set, do so now (by
 
                /*
                 * If a title hasn't been set, do so now (by


@@ -152,8 +186,20 @@ 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, 0, 0,
+                   man->meta.os_e == MANDOC_OS_OPENBSD ?
+                   "(OpenBSD)" : "(NetBSD)");
+}
+
+static void
+check_abort(CHKARGS)
+{
+       abort();

 }
 
 static void
 }
 
 static void


@@ -161,93 +207,93 @@ check_text(CHKARGS)
 {
        char            *cp, *p;
 
 {
        char            *cp, *p;
 

-       if (MAN_LITERAL & man->flags)
+       if (n->flags & NODE_NOFILL)

                return;
 
        cp = n->string;
        for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                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);
+               mandoc_msg(MANDOCERR_FI_TAB,
+                   n->line, n->pos + (int)(p - cp), NULL);

 }
 
 static void
 }
 
 static void

-post_OP(CHKARGS)
+post_EE(CHKARGS)

 {
 {

+       if ((n->flags & NODE_NOFILL) == 0)
+               mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "EE");
+}

 
 

-       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 void
+post_EX(CHKARGS)
+{
+       if (n->flags & NODE_NOFILL)
+               mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "EX");

 }
 
 static void
 }
 
 static void

-post_UR(CHKARGS)
+post_OP(CHKARGS)

 {
 
 {
 

-       if (n->type == ROFFT_HEAD && n->child == NULL)
-               mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
-                   n->line, n->pos, "UR");
-       check_part(man, n);
+       if (n->child == NULL)
+               mandoc_msg(MANDOCERR_OP_EMPTY, n->line, n->pos, "OP");
+       else if (n->child->next != NULL && n->child->next->next != NULL) {
+               n = n->child->next->next;
+               mandoc_msg(MANDOCERR_ARG_EXCESS,
+                   n->line, n->pos, "OP ... %s", n->string);
+       }

 }
 
 static void
 }
 
 static void

-post_ft(CHKARGS)
+post_SH(CHKARGS)

 {
 {

-       char    *cp;
-       int      ok;
+       struct roff_node        *nc;

 
 

-       if (0 == n->nchild)
+       if (n->type != ROFFT_BODY || (nc = n->child) == NULL)

                return;
 
                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 (nc->tok == MAN_PP && nc->body->child != NULL) {
+               while (nc->body->last != NULL) {
+                       man->next = ROFF_NEXT_CHILD;
+                       roff_node_relink(man, nc->body->last);
+                       man->last = n;
+               }
+       }
+
+       if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
+               mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
+                   "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
+               roff_node_delete(man, nc);

        }
 
        }
 

-       if (0 == ok) {
-               mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
-                   n->line, n->pos, "ft %s", cp);
-               *cp = '\0';
+       /*
+        * Trailing PP is empty, so it is deleted by check_par().
+        * Trailing sp is significant.
+        */
+
+       if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
+               mandoc_msg(MANDOCERR_PAR_SKIP,
+                   nc->line, nc->pos, "%s at the end of %s",
+                   roff_name[nc->tok], roff_name[n->tok]);
+               roff_node_delete(man, nc);

        }
 }
 
        }
 }
 

+static void
+post_UR(CHKARGS)
+{
+       if (n->type == ROFFT_HEAD && n->child == NULL)
+               mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
+                   "%s", roff_name[n->tok]);
+       check_part(man, n);
+}
+

 static void
 check_part(CHKARGS)
 {
 
        if (n->type == ROFFT_BODY && n->child == NULL)
 static void
 check_part(CHKARGS)
 {
 
        if (n->type == ROFFT_BODY && n->child == NULL)

-               mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
-                   n->line, n->pos, man_macronames[n->tok]);
+               mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos,
+                   "%s", roff_name[n->tok]);

 }
 
 static void
 }
 
 static void


@@ -256,22 +302,28 @@ check_par(CHKARGS)
 
        switch (n->type) {
        case ROFFT_BLOCK:
 
        switch (n->type) {
        case ROFFT_BLOCK:

-               if (0 == n->body->nchild)
+               if (n->body->child == NULL)

                        roff_node_delete(man, n);
                break;
        case ROFFT_BODY:
                        roff_node_delete(man, n);
                break;
        case ROFFT_BODY:

-               if (0 == n->nchild)
-                       mandoc_vmsg(MANDOCERR_PAR_SKIP,
-                           man->parse, n->line, n->pos,
-                           "%s empty", man_macronames[n->tok]);
+               if (n->child != NULL &&
+                   (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
+                       mandoc_msg(MANDOCERR_PAR_SKIP,
+                           n->child->line, n->child->pos,
+                           "%s after %s", roff_name[n->child->tok],
+                           roff_name[n->tok]);
+                       roff_node_delete(man, n->child);
+               }
+               if (n->child == NULL)
+                       mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
+                           "%s empty", roff_name[n->tok]);

                break;
        case ROFFT_HEAD:
                break;
        case ROFFT_HEAD:

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

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


@@ -284,14 +336,13 @@ post_IP(CHKARGS)
 
        switch (n->type) {
        case ROFFT_BLOCK:
 
        switch (n->type) {
        case ROFFT_BLOCK:

-               if (0 == n->head->nchild && 0 == n->body->nchild)
+               if (n->head->child == NULL && n->body->child == NULL)

                        roff_node_delete(man, n);
                break;
        case ROFFT_BODY:
                        roff_node_delete(man, n);
                break;
        case ROFFT_BODY:

-               if (0 == n->parent->head->nchild && 0 == n->nchild)
-                       mandoc_vmsg(MANDOCERR_PAR_SKIP,
-                           man->parse, n->line, n->pos,
-                           "%s empty", man_macronames[n->tok]);
+               if (n->parent->head->child == NULL && n->child == NULL)
+                       mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
+                           "%s empty", roff_name[n->tok]);

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


@@ -323,9 +374,8 @@ post_TH(CHKARGS)
                        /* Only warn about this once... */
                        if (isalpha((unsigned char)*p) &&
                            ! isupper((unsigned char)*p)) {
                        /* Only warn about this once... */
                        if (isalpha((unsigned char)*p) &&
                            ! isupper((unsigned char)*p)) {

-                               mandoc_vmsg(MANDOCERR_TITLE_CASE,
-                                   man->parse, n->line,
-                                   n->pos + (p - n->string),
+                               mandoc_msg(MANDOCERR_TITLE_CASE, n->line,
+                                   n->pos + (int)(p - n->string),

                                    "TH %s", n->string);
                                break;
                        }
                                    "TH %s", n->string);
                                break;
                        }


@@ -333,8 +383,7 @@ post_TH(CHKARGS)
                man->meta.title = mandoc_strdup(n->string);
        } else {
                man->meta.title = mandoc_strdup("");
                man->meta.title = mandoc_strdup(n->string);
        } else {
                man->meta.title = mandoc_strdup("");

-               mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
-                   nb->line, nb->pos, "TH");
+               mandoc_msg(MANDOCERR_TH_NOTITLE, nb->line, nb->pos, "TH");

        }
 
        /* TITLE ->MSEC<- DATE OS VOL */
        }
 
        /* TITLE ->MSEC<- DATE OS VOL */


@@ -345,7 +394,7 @@ post_TH(CHKARGS)
                man->meta.msec = mandoc_strdup(n->string);
        else {
                man->meta.msec = mandoc_strdup("");
                man->meta.msec = mandoc_strdup(n->string);
        else {
                man->meta.msec = mandoc_strdup("");

-               mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
+               mandoc_msg(MANDOCERR_MSEC_MISSING,

                    nb->line, nb->pos, "TH %s", man->meta.title);
        }
 
                    nb->line, nb->pos, "TH %s", man->meta.title);
        }
 


@@ -356,11 +405,10 @@ post_TH(CHKARGS)
        if (n && n->string && '\0' != n->string[0]) {
                man->meta.date = man->quick ?
                    mandoc_strdup(n->string) :
        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("");
        } else {
                man->meta.date = mandoc_strdup("");

-               mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
+               mandoc_msg(MANDOCERR_DATE_MISSING,

                    n ? n->line : nb->line,
                    n ? n->pos : nb->pos, "TH");
        }
                    n ? n->line : nb->line,
                    n ? n->pos : nb->pos, "TH");
        }


@@ -369,8 +417,14 @@ post_TH(CHKARGS)
 
        if (n && (n = n->next))
                man->meta.os = mandoc_strdup(n->string);
 
        if (n && (n = n->next))
                man->meta.os = mandoc_strdup(n->string);

-       else if (man->defos != NULL)
-               man->meta.os = mandoc_strdup(man->defos);
+       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 OS ->VOL<- */
        /* If missing, use the default VOL name for MSEC. */
 
        /* TITLE MSEC DATE OS ->VOL<- */
        /* If missing, use the default VOL name for MSEC. */


@@ -382,7 +436,7 @@ post_TH(CHKARGS)
                man->meta.vol = mandoc_strdup(p);
 
        if (n != NULL && (n = n->next) != NULL)
                man->meta.vol = mandoc_strdup(p);
 
        if (n != NULL && (n = n->next) != NULL)

-               mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+               mandoc_msg(MANDOCERR_ARG_EXCESS,

                    n->line, n->pos, "TH ... %s", n->string);
 
        /*
                    n->line, n->pos, "TH ... %s", n->string);
 
        /*


@@ -392,28 +446,6 @@ post_TH(CHKARGS)
        roff_node_delete(man, man->last);
 }
 
        roff_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;
-}
-

 static void
 post_UC(CHKARGS)
 {
 static void
 post_UC(CHKARGS)
 {


@@ -491,28 +523,17 @@ post_AT(CHKARGS)
 }
 
 static void
 }
 
 static void

-post_vs(CHKARGS)
+post_in(CHKARGS)

 {
 {

+       char    *s;

 
 

-       if (NULL != n->prev)
+       if (n->parent->tok != MAN_TP ||
+           n->parent->type != ROFFT_HEAD ||
+           n->child == NULL ||
+           *n->child->string == '+' ||
+           *n->child->string == '-')

                return;
                return;

-
-       switch (n->parent->tok) {
-       case MAN_SH:
-               /* FALLTHROUGH */
-       case MAN_SS:
-               mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
-                   "%s after %s", man_macronames[n->tok],
-                   man_macronames[n->parent->tok]);
-               /* FALLTHROUGH */
-       case TOKEN_NONE:
-               /*
-                * Don't warn about this because it occurs in pod2man
-                * and would cause considerable (unfixable) warnage.
-                */
-               roff_node_delete(man, n);
-               break;
-       default:
-               break;
-       }
+       mandoc_asprintf(&s, "+%s", n->child->string);
+       free(n->child->string);
+       n->child->string = s;

 }
 }