Moved prologue-pruning into action.c.

[mandoc.git] / validate.c

diff --git a/validate.c b/validate.c
index 95ca922a683b8afba8514d06f84f4f88dad3fc4b..b68e6ad9013e8c1bf139e7ec3c6bb7dd90b458e3 100644 (file)
--- a/validate.c
+++ b/validate.c
@@ -1,4 +1,4 @@
-/* $Id: validate.c,v 1.37 2009/01/17 16:47:02 kristaps Exp $ */
+/* $Id: validate.c,v 1.43 2009/01/20 12:51:28 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -27,8 +27,8 @@ typedef       int     (*v_post)(struct mdoc *);
 /* FIXME: some sections should only occur in specific msecs. */
 /* FIXME: ignoring Pp. */
 /* FIXME: math symbols. */
-/* FIXME: make sure prologue is complete. */
 /* FIXME: valid character-escape checks. */
+/* FIXME: make sure required sections are included (NAME, ...). */
 
 struct valids {
        v_pre   *pre;
@@ -43,9 +43,11 @@ static       int     pre_check_msecs(struct mdoc *, struct mdoc_node *,
                        int, enum mdoc_msec *);
 static int     pre_check_stdarg(struct mdoc *, struct mdoc_node *);
 static int     post_check_children_count(struct mdoc *);
-static int     post_check_children_lt(struct mdoc *, int);
-static int     post_check_children_gt(struct mdoc *, int);
-static int     post_check_children_eq(struct mdoc *, int);
+static int     post_check_children_lt(struct mdoc *, const char *, int);
+static int     post_check_children_gt(struct mdoc *, const char *, int);
+static int     post_check_children_wgt(struct mdoc *, const char *, int);
+static int     post_check_children_eq(struct mdoc *, const char *, int);
+static int     post_check_children_weq(struct mdoc *, const char *, int);
 
 /* Specific pre-child-parse routines. */
 
@@ -68,7 +70,7 @@ static        int     pre_prologue(struct mdoc *, struct mdoc_node *);
 /* Specific post-child-parse routines. */
 
 static int     herr_ge1(struct mdoc *);
-static int     hwarn_ge1(struct mdoc *);
+static int     herr_le1(struct mdoc *);
 static int     herr_eq0(struct mdoc *);
 static int     eerr_eq0(struct mdoc *);
 static int     eerr_le1(struct mdoc *);
@@ -76,8 +78,8 @@ static        int     eerr_le2(struct mdoc *);
 static int     eerr_eq1(struct mdoc *);
 static int     eerr_ge1(struct mdoc *);
 static int     ewarn_eq0(struct mdoc *);
+static int     ewarn_eq1(struct mdoc *);
 static int     bwarn_ge1(struct mdoc *);
-static int     berr_eq0(struct mdoc *);
 static int     ewarn_ge1(struct mdoc *);
 static int     ebool(struct mdoc *);
 static int     post_sh(struct mdoc *);
@@ -88,6 +90,7 @@ static        int     post_an(struct mdoc *);
 static int     post_at(struct mdoc *);
 static int     post_xr(struct mdoc *);
 static int     post_nm(struct mdoc *);
+static int     post_bf(struct mdoc *);
 static int     post_root(struct mdoc *);
 
 /* Collections of pre-child-parse routines. */
@@ -113,18 +116,19 @@ static    v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
 static v_post  posts_text[] = { eerr_ge1, NULL };
 static v_post  posts_wtext[] = { ewarn_ge1, NULL };
 static v_post  posts_notext[] = { eerr_eq0, NULL };
-static v_post  posts_wline[] = { hwarn_ge1, berr_eq0, NULL };
+static v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
 static v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
 static v_post  posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };
 static v_post  posts_it[] = { post_it, NULL };
+static v_post  posts_in[] = { ewarn_eq1, NULL };
 static v_post  posts_ss[] = { herr_ge1, NULL };
 static v_post  posts_pp[] = { ewarn_eq0, NULL };
-static v_post  posts_d1[] = { herr_ge1, NULL };
 static v_post  posts_ex[] = { eerr_le1, post_ex, NULL };
 static v_post  posts_an[] = { post_an, NULL };
 static v_post  posts_at[] = { post_at, NULL };
 static v_post  posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
 static v_post  posts_nm[] = { post_nm, NULL };
+static v_post  posts_bf[] = { herr_le1, post_bf, NULL };
 
 /* Per-macro pre- and post-child-check routine collections. */
 
@@ -137,8 +141,8 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { pres_sh, posts_sh }, /* Sh */ 
        { pres_ss, posts_ss }, /* Ss */ 
        { NULL, posts_pp }, /* Pp */ 
-       { pres_d1, posts_d1 }, /* D1 */
-       { pres_d1, posts_d1 }, /* Dl */
+       { pres_d1, posts_wline }, /* D1 */
+       { pres_d1, posts_wline }, /* Dl */
        { pres_bd, posts_bd }, /* Bd */
        { NULL, NULL }, /* Ed */
        { pres_bl, posts_bl }, /* Bl */ 
@@ -155,12 +159,12 @@ const     struct valids mdoc_valids[MDOC_MAX] = {
        { pres_ex, posts_ex }, /* Ex */ 
        { NULL, posts_text }, /* Fa */ 
        /* FIXME: only in SYNOPSIS section. */
-       { NULL, NULL }, /* Fd */
+       { NULL, posts_wtext }, /* Fd */
        { NULL, NULL }, /* Fl */
        { NULL, posts_text }, /* Fn */ 
-       { NULL, NULL }, /* Ft */ 
+       { NULL, posts_wtext }, /* Ft */ 
        { NULL, posts_text }, /* Ic */ 
-       { NULL, posts_wtext }, /* In */ 
+       { NULL, posts_in }, /* In */ 
        { NULL, posts_text }, /* Li */
        { NULL, posts_wtext }, /* Nd */
        { NULL, posts_nm }, /* Nm */
@@ -188,7 +192,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, posts_wline }, /* Aq */
        { NULL, posts_at }, /* At */ 
        { NULL, NULL }, /* Bc */
-       { NULL, NULL }, /* Bf */ 
+       { NULL, posts_bf }, /* Bf */
        { NULL, NULL }, /* Bo */
        { NULL, posts_wline }, /* Bq */
        { NULL, NULL }, /* Bsx */
@@ -253,38 +257,62 @@ post_check_children_count(struct mdoc *mdoc)
 
 
 static int
-post_check_children_gt(struct mdoc *mdoc, int sz)
+post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz)
+{
+       int               i;
+
+       if ((i = post_check_children_count(mdoc)) > sz)
+               return(1);
+       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more "
+                               "than %d %s (has %d)", sz, p, i));
+}
+
+
+static int
+post_check_children_gt(struct mdoc *mdoc, const char *p, int sz)
 {
        int               i;
 
        if ((i = post_check_children_count(mdoc)) > sz)
                return(1);
        return(mdoc_err(mdoc, "macro requires more than %d "
-                               "parameters (have %d)", sz, i));
+                               "%s (has %d)", sz, p, i));
+}
+
+
+static int
+post_check_children_weq(struct mdoc *mdoc, const char *p, int sz)
+{
+       int               i;
+
+       if ((i = post_check_children_count(mdoc)) == sz)
+               return(1);
+       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d "
+                               "%s (has %d)", sz, p, i));
 }
 
 
 static int
-post_check_children_eq(struct mdoc *mdoc, int sz)
+post_check_children_eq(struct mdoc *mdoc, const char *p, int sz)
 {
        int               i;
 
        if ((i = post_check_children_count(mdoc)) == sz)
                return(1);
-       return(mdoc_err(mdoc, "macro requires %d parameters "
-                               "(have %d)", sz, i));
+       return(mdoc_err(mdoc, "macro requires %d %s "
+                               "(have %d)", sz, p, i));
 }
 
 
 static int
-post_check_children_lt(struct mdoc *mdoc, int sz)
+post_check_children_lt(struct mdoc *mdoc, const char *p, int sz)
 {
        int               i;
 
        if ((i = post_check_children_count(mdoc)) < sz)
                return(1);
        return(mdoc_err(mdoc, "macro requires less than %d "
-                               "parameters (have %d)", sz, i));
+                               "%s (have %d)", sz, p, i));
 }
 
 
@@ -333,26 +361,21 @@ pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,
 
 
 static int
-berr_eq0(struct mdoc *mdoc)
+bwarn_ge1(struct mdoc *mdoc)
 {
 
        if (MDOC_BODY != mdoc->last->type)
                return(1);
-       if (NULL == mdoc->last->child)
-               return(1);
-       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));
+       return(post_check_children_wgt(mdoc, "body children", 0));
 }
 
 
 static int
-bwarn_ge1(struct mdoc *mdoc)
+ewarn_eq1(struct mdoc *mdoc)
 {
 
-       if (MDOC_BODY != mdoc->last->type)
-               return(1);
-       if (mdoc->last->child)
-               return(1);
-       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));
+       assert(MDOC_ELEM == mdoc->last->type);
+       return(post_check_children_weq(mdoc, "parameters", 1));
 }
 
 
@@ -361,10 +384,7 @@ ewarn_eq0(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       if (NULL == mdoc->last->child)
-               return(1);
-       return(mdoc_pwarn(mdoc, mdoc->last->child->line,
-                       mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));
+       return(post_check_children_weq(mdoc, "parameters", 0));
 }
 
 
@@ -373,9 +393,7 @@ ewarn_ge1(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       if (mdoc->last->child)
-               return(1);
-       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
+       return(post_check_children_wgt(mdoc, "parameters", 0));
 }
 
 
@@ -384,7 +402,7 @@ eerr_eq1(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       return(post_check_children_eq(mdoc, 1));
+       return(post_check_children_eq(mdoc, "parameters", 1));
 }
 
 
@@ -393,7 +411,7 @@ eerr_le2(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       return(post_check_children_lt(mdoc, 3));
+       return(post_check_children_lt(mdoc, "parameters", 3));
 }
 
 
@@ -402,7 +420,7 @@ eerr_le1(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       return(post_check_children_lt(mdoc, 2));
+       return(post_check_children_lt(mdoc, "parameters", 2));
 }
 
 
@@ -411,7 +429,7 @@ eerr_eq0(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       return(post_check_children_eq(mdoc, 0));
+       return(post_check_children_eq(mdoc, "parameters", 0));
 }
 
 
@@ -420,7 +438,7 @@ eerr_ge1(struct mdoc *mdoc)
 {
 
        assert(MDOC_ELEM == mdoc->last->type);
-       return(post_check_children_gt(mdoc, 0));
+       return(post_check_children_gt(mdoc, "parameters", 0));
 }
 
 
@@ -430,19 +448,16 @@ herr_eq0(struct mdoc *mdoc)
 
        if (MDOC_HEAD != mdoc->last->type)
                return(1);
-       return(post_check_children_eq(mdoc, 0));
+       return(post_check_children_eq(mdoc, "parameters", 0));
 }
 
 
 static int
-hwarn_ge1(struct mdoc *mdoc)
+herr_le1(struct mdoc *mdoc)
 {
-
        if (MDOC_HEAD != mdoc->last->type)
                return(1);
-       if (mdoc->last->child)
-               return(1);
-       return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
+       return(post_check_children_lt(mdoc, "parameters", 2));
 }
 
 
@@ -452,7 +467,7 @@ herr_ge1(struct mdoc *mdoc)
 
        if (MDOC_HEAD != mdoc->last->type)
                return(1);
-       return(post_check_children_gt(mdoc, 0));
+       return(post_check_children_gt(mdoc, "parameters", 0));
 }
 
 
@@ -465,6 +480,7 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node)
                return(1);
 
        assert(mdoc->last);
+       /* LINTED */
        for (n = mdoc->last->parent; n; n = n->parent) 
                if (MDOC_BLOCK == n->type)
                        if (MDOC_Bd == n->tok)
@@ -489,6 +505,7 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
        argv = NULL;
        argc = node->data.block.argc; 
 
+       /* LINTED */
        for (i = type = err = 0; i < argc; i++) {
                argv = &node->data.block.argv[(int)i];
                assert(argv);
@@ -546,6 +563,7 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
        argv = NULL;
        argc = node->data.block.argc;
 
+       /* LINTED */
        for (err = i = type = 0; 0 == err && i < argc; i++) {
                argv = &node->data.block.argv[(int)i];
                assert(argv);
@@ -736,6 +754,40 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
 }
 
 
+static int
+post_bf(struct mdoc *mdoc)
+{
+       char             *p;
+       struct mdoc_node *head;
+
+       if (MDOC_BLOCK != mdoc->last->type)
+               return(1);
+       assert(MDOC_Bf == mdoc->last->tok);
+       head = mdoc->last->data.block.head;
+       assert(head);
+
+       if (0 == mdoc->last->data.block.argc) {
+               if (head->child) {
+                       assert(MDOC_TEXT == head->child->type);
+                       p = head->child->data.text.string;
+                       if (xstrcmp(p, "Em"))
+                               return(1);
+                       else if (xstrcmp(p, "Li"))
+                               return(1);
+                       else if (xstrcmp(p, "Sm"))
+                               return(1);
+                       return(mdoc_nerr(mdoc, head->child, "invalid font mode"));
+               }
+               return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+       }
+       if (head->child)
+               return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+       if (1 == mdoc->last->data.block.argc)
+               return(1);
+       return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+}
+
+
 static int
 post_nm(struct mdoc *mdoc)
 {
@@ -858,9 +910,11 @@ post_it(struct mdoc *mdoc)
 
        argc = n->data.block.argc;
        type = TYPE_NONE;
+       sv = -1;
        
        /* Some types require block-head, some not. */
 
+       /* LINTED */
        for (i = 0; TYPE_NONE == type && i < argc; i++)
                switch (n->data.block.argv[(int)i].arg) {
                case (MDOC_Tag):
@@ -926,20 +980,21 @@ post_it(struct mdoc *mdoc)
                if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
                        return(0);
 
+       assert(-1 != sv);
        if (MDOC_Column != sv) 
                return(1);
 
        /* Make sure the number of columns is sane. */
 
-       sv = mdoc->last->parent->parent->data.block.argv->sz;
+       argc = mdoc->last->parent->parent->data.block.argv->sz;
        n = mdoc->last->data.block.head->child;
 
        for (i = 0; n; n = n->next)
                i++;
 
-       if (i == (size_t)sv)
+       if (i == argc)
                return(1);
-       return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i));
+       return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i));
 #undef TYPE_NONE
 #undef TYPE_BODY
 #undef TYPE_HEAD
@@ -955,6 +1010,7 @@ post_bl(struct mdoc *mdoc)
                return(1);
        assert(MDOC_Bl == mdoc->last->tok);
 
+       /* LINTED */
        for (n = mdoc->last->child; n; n = n->next) {
                if (MDOC_BLOCK == n->type) 
                        if (MDOC_It == n->tok)
@@ -973,6 +1029,7 @@ ebool(struct mdoc *mdoc)
        struct mdoc_node *n;
 
        assert(MDOC_ELEM == mdoc->last->type);
+       /* LINTED */
        for (n = mdoc->last->child; n; n = n->next) {
                if (MDOC_TEXT != n->type)
                        break;
@@ -995,11 +1052,11 @@ post_root(struct mdoc *mdoc)
        if (NULL == mdoc->last->child)
                return(mdoc_err(mdoc, "document has no data"));
        if (NULL == mdoc->meta.title)
-               return(mdoc_err(mdoc, "document has no incomplete prologue"));
+               return(mdoc_err(mdoc, "document has incomplete prologue"));
        if (NULL == mdoc->meta.os)
-               return(mdoc_err(mdoc, "document has no incomplete prologue"));
+               return(mdoc_err(mdoc, "document has incomplete prologue"));
        if (0 == mdoc->meta.date)
-               return(mdoc_err(mdoc, "document has no incomplete prologue"));
+               return(mdoc_err(mdoc, "document has incomplete prologue"));
        return(1);
 }
 
@@ -1051,6 +1108,10 @@ mdoc_valid_post(struct mdoc *mdoc)
 {
        v_post          *p;
 
+       if (MDOC_VALID & mdoc->last->flags)
+               return(1);
+       mdoc->last->flags |= MDOC_VALID;
+
        if (MDOC_TEXT == mdoc->last->type)
                return(1);
        if (MDOC_ROOT == mdoc->last->type)