]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_validate.c
First, use \(dq instead of \*q for double-quote. Second, use `Li' to
[mandoc.git] / mdoc_validate.c
index c4e7130fa56e1c1b0c84e8a930044bd556ec3589..4de6d29ae4e389156d169f821b16ad36b43f7e6d 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_validate.c,v 1.159 2011/03/15 16:23:51 kristaps Exp $ */
+/*     $Id: mdoc_validate.c,v 1.174 2011/08/16 12:23:51 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
@@ -33,6 +33,7 @@
 #include <string.h>
 #include <time.h>
 
+#include "mdoc.h"
 #include "mandoc.h"
 #include "libmdoc.h"
 #include "libmandoc.h"
@@ -71,9 +72,9 @@ static        void     check_text(struct mdoc *, int, int, char *);
 static void     check_argv(struct mdoc *, 
                        struct mdoc_node *, struct mdoc_argv *);
 static void     check_args(struct mdoc *, struct mdoc_node *);
-
-static int      concat(struct mdoc *, char *, 
-                       const struct mdoc_node *, size_t);
+static int      concat(char *, const struct mdoc_node *, size_t);
+static enum mdoc_sec   a2sec(const char *);
+static size_t          macro2len(enum mdoct);
 
 static int      ebool(POST_ARGS);
 static int      berr_ge1(POST_ARGS);
@@ -152,9 +153,9 @@ static      v_post   posts_notext[] = { ewarn_eq0, NULL };
 static v_post   posts_ns[] = { post_ns, NULL };
 static v_post   posts_os[] = { post_os, post_prol, NULL };
 static v_post   posts_rs[] = { post_rs, NULL };
-static v_post   posts_sh[] = { post_ignpar, hwarn_ge1, bwarn_ge1, post_sh, NULL };
+static v_post   posts_sh[] = { post_ignpar, hwarn_ge1, post_sh, NULL };
 static v_post   posts_sp[] = { ewarn_le1, NULL };
-static v_post   posts_ss[] = { post_ignpar, hwarn_ge1, bwarn_ge1, NULL };
+static v_post   posts_ss[] = { post_ignpar, hwarn_ge1, NULL };
 static v_post   posts_st[] = { post_st, NULL };
 static v_post   posts_std[] = { post_std, NULL };
 static v_post   posts_text[] = { ewarn_ge1, NULL };
@@ -177,7 +178,7 @@ static      v_pre    pres_sh[] = { pre_sh, NULL };
 static v_pre    pres_ss[] = { pre_ss, NULL };
 static v_pre    pres_std[] = { pre_std, NULL };
 
-const  struct valids mdoc_valids[MDOC_MAX] = {
+static const struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Ap */
        { pres_dd, posts_dd },                  /* Dd */
        { pres_dt, posts_dt },                  /* Dt */
@@ -321,6 +322,30 @@ static     const enum mdoct rsord[RSORD_MAX] = {
        MDOC__U
 };
 
+static const char * const secnames[SEC__MAX] = {
+       NULL,
+       "NAME",
+       "LIBRARY",
+       "SYNOPSIS",
+       "DESCRIPTION",
+       "IMPLEMENTATION NOTES",
+       "RETURN VALUES",
+       "ENVIRONMENT",
+       "FILES",
+       "EXIT STATUS",
+       "EXAMPLES",
+       "DIAGNOSTICS",
+       "COMPATIBILITY",
+       "ERRORS",
+       "SEE ALSO",
+       "STANDARDS",
+       "HISTORY",
+       "AUTHORS",
+       "CAVEATS",
+       "BUGS",
+       "SECURITY CONSIDERATIONS",
+       NULL
+};
 
 int
 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
@@ -420,10 +445,10 @@ check_count(struct mdoc *m, enum mdoc_type type,
        }
 
        t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT;
-
-       return(mdoc_vmsg(m, t, m->last->line, m->last->pos,
+       mandoc_vmsg(t, m->parse, m->last->line, m->last->pos,
                        "want %s%d children (have %d)",
-                       p, val, m->last->nchild));
+                       p, val, m->last->nchild);
+       return(1);
 }
 
 static int
@@ -518,31 +543,13 @@ check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)
 static void
 check_text(struct mdoc *m, int ln, int pos, char *p)
 {
-       int              c;
-       size_t           sz;
-
-       for ( ; *p; p++, pos++) {
-               sz = strcspn(p, "\t\\");
-               p += (int)sz;
-
-               if ('\0' == *p)
-                       break;
-
-               pos += (int)sz;
-
-               if ('\t' == *p) {
-                       if ( ! (MDOC_LITERAL & m->flags))
-                               mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB);
-                       continue;
-               }
+       char            *cp;
 
-               if (0 == (c = mandoc_special(p))) {
-                       mdoc_pmsg(m, ln, pos, MANDOCERR_BADESCAPE);
+       cp = p;
+       for (cp = p; NULL != (p = strchr(p, '\t')); p++) {
+               if (MDOC_LITERAL & m->flags)
                        continue;
-               }
-
-               p += c - 1;
-               pos += c - 1;
+               mdoc_pmsg(m, ln, (int)(p - cp), MANDOCERR_BADTAB);
        }
 }
 
@@ -555,10 +562,9 @@ check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
                        (t == n->parent->type))
                return(1);
 
-       mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD,
-                               n->line, n->pos, "want parent %s",
-                               MDOC_ROOT == t ? "<root>" : 
-                                       mdoc_macronames[tok]);
+       mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, n->line, 
+                       n->pos, "want parent %s", MDOC_ROOT == t ? 
+                       "<root>" : mdoc_macronames[tok]);
        return(0);
 }
 
@@ -865,7 +871,7 @@ pre_sh(PRE_ARGS)
        if (MDOC_BLOCK != n->type)
                return(1);
 
-       mdoc->regs->regs[(int)REG_nS].set = 0;
+       roff_regunset(mdoc->roff, REG_nS);
        return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
 }
 
@@ -1099,6 +1105,7 @@ static int
 post_nm(POST_ARGS)
 {
        char             buf[BUFSIZ];
+       int              c;
 
        /* If no child specified, make sure we have the meta name. */
 
@@ -1110,11 +1117,14 @@ post_nm(POST_ARGS)
 
        /* If no meta name, set it from the child. */
 
-       if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
+       buf[0] = '\0';
+       if (-1 == (c = concat(buf, mdoc->last->child, BUFSIZ))) {
+               mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
                return(0);
+       }
 
+       assert(c);
        mdoc->meta.name = mandoc_strdup(buf);
-
        return(1);
 }
 
@@ -1240,7 +1250,7 @@ post_an(POST_ARGS)
 static int
 post_it(POST_ARGS)
 {
-       int               i, cols, rc;
+       int               i, cols;
        enum mdoc_list    lt;
        struct mdoc_node *n, *c;
        enum mandocerr    er;
@@ -1306,10 +1316,10 @@ post_it(POST_ARGS)
                else
                        er = MANDOCERR_SYNTARGCOUNT;
 
-               rc = mdoc_vmsg(mdoc, er
-                               mdoc->last->line, mdoc->last->pos, 
+               mandoc_vmsg(er, mdoc->parse, mdoc->last->line
+                               mdoc->last->pos, 
                                "columns == %d (have %d)", cols, i);
-               return(rc);
+               return(MANDOCERR_ARGCOUNT == er);
        default:
                break;
        }
@@ -1370,7 +1380,7 @@ post_bl_block_width(POST_ARGS)
                width = 6;
        else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
                return(1);
-       else if (0 == (width = mdoc_macro2len(tok)))  {
+       else if (0 == (width = macro2len(tok)))  {
                mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
                return(1);
        }
@@ -1385,7 +1395,7 @@ post_bl_block_width(POST_ARGS)
 
        assert(i < (int)n->args->argc);
 
-       snprintf(buf, NUMSIZ, "%zun", width);
+       snprintf(buf, NUMSIZ, "%un", (unsigned int)width);
        free(n->args->argv[i].value[0]);
        n->args->argv[i].value[0] = mandoc_strdup(buf);
 
@@ -1427,7 +1437,7 @@ post_bl_block_tag(POST_ARGS)
                        break;
                }
 
-               if (0 != (ssz = mdoc_macro2len(nn->tok)))
+               if (0 != (ssz = macro2len(nn->tok)))
                        sz = ssz;
 
                break;
@@ -1435,7 +1445,7 @@ post_bl_block_tag(POST_ARGS)
 
        /* Defaults to ten ens. */
 
-       snprintf(buf, NUMSIZ, "%zun", sz);
+       snprintf(buf, NUMSIZ, "%un", (unsigned int)sz);
 
        /*
         * We have to dynamically add this to the macro's argument list.
@@ -1501,7 +1511,7 @@ post_bl_head(POST_ARGS)
        assert(0 == np->args->argv[j].sz);
 
        /*
-        * Accomodate for new-style groff column syntax.  Shuffle the
+        * Accommodate for new-style groff column syntax.  Shuffle the
         * child nodes, all of which must be TEXT, as arguments for the
         * column field.  Then, delete the head children.
         */
@@ -1810,6 +1820,7 @@ post_sh_head(POST_ARGS)
 {
        char             buf[BUFSIZ];
        enum mdoc_sec    sec;
+       int              c;
 
        /*
         * Process a new section.  Sections are either "named" or
@@ -1818,10 +1829,13 @@ post_sh_head(POST_ARGS)
         * manual sections.
         */
 
-       if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
+       sec = SEC_CUSTOM;
+       buf[0] = '\0';
+       if (-1 == (c = concat(buf, mdoc->last->child, BUFSIZ))) {
+               mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
                return(0);
-
-       sec = mdoc_str2sec(buf);
+       } else if (1 == c)
+               sec = a2sec(buf);
 
        /* The NAME should be first. */
 
@@ -1970,22 +1984,27 @@ post_dd(POST_ARGS)
 {
        char              buf[DATESIZE];
        struct mdoc_node *n;
+       int               c;
 
        if (mdoc->meta.date)
                free(mdoc->meta.date);
 
        n = mdoc->last;
        if (NULL == n->child || '\0' == n->child->string[0]) {
-               mdoc->meta.date = mandoc_normdate(NULL,
-                   mdoc->msg, mdoc->data, n->line, n->pos);
+               mdoc->meta.date = mandoc_normdate
+                       (mdoc->parse, NULL, n->line, n->pos);
                return(1);
        }
 
-       if ( ! concat(mdoc, buf, n->child, DATESIZE))
+       buf[0] = '\0';
+       if (-1 == (c = concat(buf, n->child, DATESIZE))) {
+               mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
                return(0);
+       }
 
-       mdoc->meta.date = mandoc_normdate(buf,
-           mdoc->msg, mdoc->data, n->line, n->pos);
+       assert(c);
+       mdoc->meta.date = mandoc_normdate
+               (mdoc->parse, buf, n->line, n->pos);
 
        return(1);
 }
@@ -2012,7 +2031,7 @@ post_dt(POST_ARGS)
 
        if (NULL != (nn = n->child))
                for (p = nn->string; *p; p++) {
-                       if (toupper((u_char)*p) == *p)
+                       if (toupper((unsigned char)*p) == *p)
                                continue;
 
                        /* 
@@ -2138,6 +2157,7 @@ post_os(POST_ARGS)
 {
        struct mdoc_node *n;
        char              buf[BUFSIZ];
+       int               c;
 #ifndef OSNAME
        struct utsname    utsname;
 #endif
@@ -2154,8 +2174,13 @@ post_os(POST_ARGS)
        if (mdoc->meta.os)
                free(mdoc->meta.os);
 
-       if ( ! concat(mdoc, buf, n->child, BUFSIZ))
+       buf[0] = '\0';
+       if (-1 == (c = concat(buf, n->child, BUFSIZ))) {
+               mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
                return(0);
+       }
+
+       assert(c);
 
        /* XXX: yes, these can all be dynamically-adjusted buffers, but
         * it's really not worth the extra hackery.
@@ -2168,7 +2193,7 @@ post_os(POST_ARGS)
                        return(0);
                }
 #else /*!OSNAME */
-               if (uname(&utsname)) {
+               if (-1 == uname(&utsname)) {
                        mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
                         mdoc->meta.os = mandoc_strdup("UNKNOWN");
                         return(post_prol(mdoc));
@@ -2222,36 +2247,130 @@ post_std(POST_ARGS)
        return(1);
 }
 
+/*
+ * Concatenate a node, stopping at the first non-text.
+ * Concatenation is separated by a single whitespace.  
+ * Returns -1 on fatal (string overrun) error, 0 if child nodes were
+ * encountered, 1 otherwise.
+ */
 static int
-concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
+concat(char *p, const struct mdoc_node *n, size_t sz)
 {
 
-       p[0] = '\0';
+       for ( ; NULL != n; n = n->next) {
+               if (MDOC_TEXT != n->type) 
+                       return(0);
+               if ('\0' != p[0] && strlcat(p, " ", sz) >= sz)
+                       return(-1);
+               if (strlcat(p, n->string, sz) >= sz)
+                       return(-1);
+               concat(p, n->child, sz);
+       }
 
-       /*
-        * Concatenate sibling nodes together.  All siblings must be of
-        * type MDOC_TEXT or an assertion is raised.  Concatenation is
-        * separated by a single whitespace.  Returns 0 on fatal (string
-        * overrun) error.
-        */
+       return(1);
+}
 
-       for ( ; n; n = n->next) {
-               assert(MDOC_TEXT == n->type);
+static enum mdoc_sec 
+a2sec(const char *p)
+{
+       int              i;
 
-               if (strlcat(p, n->string, sz) >= sz) {
-                       mdoc_nmsg(m, n, MANDOCERR_MEM);
-                       return(0);
-               }
+       for (i = 0; i < (int)SEC__MAX; i++) 
+               if (secnames[i] && 0 == strcmp(p, secnames[i]))
+                       return((enum mdoc_sec)i);
 
-               if (NULL == n->next)
-                       continue;
+       return(SEC_CUSTOM);
+}
 
-               if (strlcat(p, " ", sz) >= sz) {
-                       mdoc_nmsg(m, n, MANDOCERR_MEM);
-                       return(0);
-               }
-       }
+static size_t
+macro2len(enum mdoct macro)
+{
 
-       return(1);
+       switch (macro) {
+       case(MDOC_Ad):
+               return(12);
+       case(MDOC_Ao):
+               return(12);
+       case(MDOC_An):
+               return(12);
+       case(MDOC_Aq):
+               return(12);
+       case(MDOC_Ar):
+               return(12);
+       case(MDOC_Bo):
+               return(12);
+       case(MDOC_Bq):
+               return(12);
+       case(MDOC_Cd):
+               return(12);
+       case(MDOC_Cm):
+               return(10);
+       case(MDOC_Do):
+               return(10);
+       case(MDOC_Dq):
+               return(12);
+       case(MDOC_Dv):
+               return(12);
+       case(MDOC_Eo):
+               return(12);
+       case(MDOC_Em):
+               return(10);
+       case(MDOC_Er):
+               return(17);
+       case(MDOC_Ev):
+               return(15);
+       case(MDOC_Fa):
+               return(12);
+       case(MDOC_Fl):
+               return(10);
+       case(MDOC_Fo):
+               return(16);
+       case(MDOC_Fn):
+               return(16);
+       case(MDOC_Ic):
+               return(10);
+       case(MDOC_Li):
+               return(16);
+       case(MDOC_Ms):
+               return(6);
+       case(MDOC_Nm):
+               return(10);
+       case(MDOC_No):
+               return(12);
+       case(MDOC_Oo):
+               return(10);
+       case(MDOC_Op):
+               return(14);
+       case(MDOC_Pa):
+               return(32);
+       case(MDOC_Pf):
+               return(12);
+       case(MDOC_Po):
+               return(12);
+       case(MDOC_Pq):
+               return(12);
+       case(MDOC_Ql):
+               return(16);
+       case(MDOC_Qo):
+               return(12);
+       case(MDOC_So):
+               return(12);
+       case(MDOC_Sq):
+               return(12);
+       case(MDOC_Sy):
+               return(6);
+       case(MDOC_Sx):
+               return(16);
+       case(MDOC_Tn):
+               return(10);
+       case(MDOC_Va):
+               return(12);
+       case(MDOC_Vt):
+               return(12);
+       case(MDOC_Xr):
+               return(10);
+       default:
+               break;
+       };
+       return(0);
 }
-