]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_validate.c
During validation, drop .br before a text line starting with a
[mandoc.git] / man_validate.c
index 59baf88a718a27b1057f8dbf047c9b1f6697dca1..806a6cdc794c9fe09313308085b4e5de614aa4b3 100644 (file)
@@ -1,7 +1,7 @@
 /*     $OpenBSD$ */
 /*
  * 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
@@ -40,6 +40,7 @@
 
 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);
@@ -47,24 +48,22 @@ 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_SH(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 */
-       NULL,       /* SH */
-       NULL,       /* SS */
+       post_SH,    /* SH */
+       post_SH,    /* SS */
        NULL,       /* TP */
-       check_par,  /* LP */
+       NULL,       /* TQ */
+       check_abort,/* LP */
        check_par,  /* PP */
-       check_par,  /* P */
+       check_abort,/* P */
        post_IP,    /* IP */
        NULL,       /* HP */
        NULL,       /* SM */
@@ -78,37 +77,67 @@ static      v_check man_valids[MAN_MAX] = {
        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,       /* in */
-       post_ft,    /* ft */
+       post_in,    /* in */
+       NULL,       /* SY */
+       NULL,       /* YS */
        post_OP,    /* OP */
-       post_nf,    /* EX */
-       post_fi,    /* EE */
+       NULL,       /* EX */
+       NULL,       /* EE */
        post_UR,    /* UR */
        NULL,       /* UE */
-       NULL,       /* ll */
+       post_UR,    /* MT */
+       NULL,       /* ME */
 };
 
 
+/* Validate the subtree rooted at man->last. */
 void
-man_valid_post(struct roff_man *man)
+man_node_validate(struct roff_man *man)
 {
        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;
-       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_node_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);
@@ -116,14 +145,21 @@ man_valid_post(struct roff_man *man)
        case ROFFT_ROOT:
                check_root(man, n);
                break;
+       case ROFFT_COMMENT:
        case ROFFT_EQN:
-               /* FALLTHROUGH */
        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 (man->last == n)
+                       man_state(man, n);
                break;
        }
 }
@@ -131,10 +167,9 @@ man_valid_post(struct roff_man *man)
 static void
 check_root(CHKARGS)
 {
-
        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
 
-       if (NULL == man->first->child)
+       if (n->last == NULL || n->last->type == ROFFT_COMMENT)
                mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                    n->line, n->pos, NULL);
        else
@@ -152,8 +187,20 @@ check_root(CHKARGS)
                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
+check_abort(CHKARGS)
+{
+       abort();
 }
 
 static void
@@ -174,10 +221,10 @@ static void
 post_OP(CHKARGS)
 {
 
-       if (n->nchild == 0)
+       if (n->child == NULL)
                mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
                    n->line, n->pos, "OP");
-       else if (n->nchild > 2) {
+       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);
@@ -185,60 +232,48 @@ post_OP(CHKARGS)
 }
 
 static void
-post_UR(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);
-}
-
-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;
 
-       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 (0 == ok) {
-               mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
-                   n->line, n->pos, "ft %s", cp);
-               *cp = '\0';
+       if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
+               mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,
+                   nc->line, nc->pos, "%s after %s",
+                   roff_name[nc->tok], roff_name[n->tok]);
+               roff_node_delete(man, nc);
        }
+
+       /*
+        * 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_vmsg(MANDOCERR_PAR_SKIP, man->parse,
+                   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, man->parse,
+                   n->line, n->pos, roff_name[n->tok]);
+       check_part(man, n);
 }
 
 static void
@@ -247,7 +282,7 @@ 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]);
+                   n->line, n->pos, roff_name[n->tok]);
 }
 
 static void
@@ -256,22 +291,29 @@ check_par(CHKARGS)
 
        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:
-               if (0 == n->nchild)
+               if (n->child != NULL &&
+                   (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
+                       mandoc_vmsg(MANDOCERR_PAR_SKIP,
+                           man->parse, 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_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
-                           "%s empty", man_macronames[n->tok]);
+                           "%s empty", roff_name[n->tok]);
                break;
        case ROFFT_HEAD:
-               if (n->nchild)
+               if (n->child != NULL)
                        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;
@@ -284,14 +326,14 @@ post_IP(CHKARGS)
 
        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:
-               if (0 == n->parent->head->nchild && 0 == n->nchild)
+               if (n->parent->head->child == NULL && n->child == NULL)
                        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;
@@ -356,8 +398,7 @@ post_TH(CHKARGS)
        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,
@@ -369,8 +410,14 @@ post_TH(CHKARGS)
 
        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. */
@@ -392,28 +439,6 @@ post_TH(CHKARGS)
        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)
 {
@@ -491,28 +516,17 @@ post_AT(CHKARGS)
 }
 
 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;
-
-       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;
 }