Migrate `Nm' and `Pa' handling from mdoc_action.c into mdoc_validate.c.

[mandoc.git] / mdoc_validate.c

diff --git a/mdoc_validate.c b/mdoc_validate.c
index 7a4ff5271e4d9b1a6e8f403740958e20ea8f7572..be4d747c6b3ac74066b9bc26a5a8f5baae1efeca 100644 (file)
--- a/mdoc_validate.c
+++ b/mdoc_validate.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_validate.c,v 1.125 2010/11/29 13:51:03 kristaps Exp $ */
+/*     $Id: mdoc_validate.c,v 1.129 2010/11/29 16:06:46 kristaps Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
 /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *


@@ -86,6 +86,7 @@ static        int      post_bf(POST_ARGS);
 static int      post_bl(POST_ARGS);
 static int      post_bl_head(POST_ARGS);
 static int      post_defaults(POST_ARGS);
 static int      post_bl(POST_ARGS);
 static int      post_bl_head(POST_ARGS);
 static int      post_defaults(POST_ARGS);

+static int      post_literal(POST_ARGS);

 static int      post_eoln(POST_ARGS);
 static int      post_dt(POST_ARGS);
 static int      post_it(POST_ARGS);
 static int      post_eoln(POST_ARGS);
 static int      post_dt(POST_ARGS);
 static int      post_it(POST_ARGS);


@@ -105,6 +106,7 @@ static      int      pre_dd(PRE_ARGS);
 static int      pre_display(PRE_ARGS);
 static int      pre_dt(PRE_ARGS);
 static int      pre_it(PRE_ARGS);
 static int      pre_display(PRE_ARGS);
 static int      pre_dt(PRE_ARGS);
 static int      pre_it(PRE_ARGS);

+static int      pre_literal(PRE_ARGS);

 static int      pre_os(PRE_ARGS);
 static int      pre_par(PRE_ARGS);
 static int      pre_rv(PRE_ARGS);
 static int      pre_os(PRE_ARGS);
 static int      pre_par(PRE_ARGS);
 static int      pre_rv(PRE_ARGS);


@@ -112,13 +114,15 @@ static    int      pre_sh(PRE_ARGS);
 static int      pre_ss(PRE_ARGS);
 
 static v_post   posts_an[] = { post_an, NULL };
 static int      pre_ss(PRE_ARGS);
 
 static v_post   posts_an[] = { post_an, NULL };

-static v_post   posts_at[] = { post_at, NULL };
-static v_post   posts_bd_bk[] = { hwarn_eq0, bwarn_ge1, NULL };
+static v_post   posts_at[] = { post_at, post_defaults, NULL };
+static v_post   posts_bd[] = { post_literal, hwarn_eq0, bwarn_ge1, NULL };

 static v_post   posts_bf[] = { hwarn_le1, post_bf, NULL };
 static v_post   posts_bf[] = { hwarn_le1, post_bf, NULL };

+static v_post   posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL };

 static v_post   posts_bl[] = { bwarn_ge1, post_bl, NULL };
 static v_post   posts_bool[] = { eerr_eq1, ebool, NULL };
 static v_post   posts_eoln[] = { post_eoln, NULL };
 static v_post   posts_defaults[] = { post_defaults, NULL };
 static v_post   posts_bl[] = { bwarn_ge1, post_bl, NULL };
 static v_post   posts_bool[] = { eerr_eq1, ebool, NULL };
 static v_post   posts_eoln[] = { post_eoln, NULL };
 static v_post   posts_defaults[] = { post_defaults, NULL };

+static v_post   posts_dl[] = { post_literal, bwarn_ge1, herr_eq0, NULL };

 static v_post   posts_dt[] = { post_dt, NULL };
 static v_post   posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
 static v_post   posts_it[] = { post_it, NULL };
 static v_post   posts_dt[] = { post_dt, NULL };
 static v_post   posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
 static v_post   posts_it[] = { post_it, NULL };


@@ -137,9 +141,10 @@ static     v_post   posts_vt[] = { post_vt, NULL };
 static v_post   posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
 static v_post   posts_wtext[] = { ewarn_ge1, NULL };
 static v_pre    pres_an[] = { pre_an, NULL };
 static v_post   posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
 static v_post   posts_wtext[] = { ewarn_ge1, NULL };
 static v_pre    pres_an[] = { pre_an, NULL };

-static v_pre    pres_bd[] = { pre_display, pre_bd, pre_par, NULL };
+static v_pre    pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL };

 static v_pre    pres_bl[] = { pre_bl, pre_par, NULL };
 static v_pre    pres_d1[] = { pre_display, NULL };
 static v_pre    pres_bl[] = { pre_bl, pre_par, NULL };
 static v_pre    pres_d1[] = { pre_display, NULL };

+static v_pre    pres_dl[] = { pre_literal, pre_display, NULL };

 static v_pre    pres_dd[] = { pre_dd, NULL };
 static v_pre    pres_dt[] = { pre_dt, NULL };
 static v_pre    pres_er[] = { NULL, NULL };
 static v_pre    pres_dd[] = { pre_dd, NULL };
 static v_pre    pres_dt[] = { pre_dt, NULL };
 static v_pre    pres_er[] = { NULL, NULL };


@@ -161,8 +166,8 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { pres_ss, posts_ss },                  /* Ss */ 
        { pres_pp, posts_notext },              /* Pp */ 
        { pres_d1, posts_wline },               /* D1 */
        { pres_ss, posts_ss },                  /* Ss */ 
        { pres_pp, posts_notext },              /* Pp */ 
        { pres_d1, posts_wline },               /* D1 */

-       { pres_d1, posts_wline },               /* Dl */
-       { pres_bd, posts_bd_bk },               /* Bd */
+       { pres_dl, posts_dl },                  /* Dl */
+       { pres_bd, posts_bd },                  /* Bd */

        { NULL, NULL },                         /* Ed */
        { pres_bl, posts_bl },                  /* Bl */ 
        { NULL, NULL },                         /* El */
        { NULL, NULL },                         /* Ed */
        { pres_bl, posts_bl },                  /* Bl */ 
        { NULL, NULL },                         /* El */


@@ -188,7 +193,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, posts_nm },                     /* Nm */
        { NULL, posts_wline },                  /* Op */
        { NULL, NULL },                         /* Ot */
        { NULL, posts_nm },                     /* Nm */
        { NULL, posts_wline },                  /* Op */
        { NULL, NULL },                         /* Ot */

-       { NULL, NULL },                         /* Pa */
+       { NULL, posts_defaults },               /* Pa */

        { pres_rv, NULL },                      /* Rv */
        { NULL, posts_st },                     /* St */ 
        { NULL, NULL },                         /* Va */
        { pres_rv, NULL },                      /* Rv */
        { NULL, posts_st },                     /* St */ 
        { NULL, NULL },                         /* Va */


@@ -253,7 +258,7 @@ const       struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Fc */ 
        { NULL, NULL },                         /* Oo */
        { NULL, NULL },                         /* Oc */
        { NULL, NULL },                         /* Fc */ 
        { NULL, NULL },                         /* Oo */
        { NULL, NULL },                         /* Oc */

-       { NULL, posts_bd_bk },                  /* Bk */
+       { NULL, posts_bk },                     /* Bk */

        { NULL, NULL },                         /* Ek */
        { NULL, posts_eoln },                   /* Bt */
        { NULL, NULL },                         /* Hf */
        { NULL, NULL },                         /* Ek */
        { NULL, posts_eoln },                   /* Bt */
        { NULL, NULL },                         /* Hf */


@@ -582,6 +587,7 @@ pre_display(PRE_ARGS)
                if (MDOC_BLOCK == node->type)
                        if (MDOC_Bd == node->tok)
                                break;
                if (MDOC_BLOCK == node->type)
                        if (MDOC_Bd == node->tok)
                                break;

+

        if (NULL == node)
                return(1);
 
        if (NULL == node)
                return(1);
 


@@ -1077,16 +1083,37 @@ post_bf(POST_ARGS)
        return(1);
 }
 
        return(1);
 }
 

-

 static int
 post_lb(POST_ARGS)
 {
 static int
 post_lb(POST_ARGS)
 {

+       const char      *p;
+       char            *buf;
+       size_t           sz;
+
+       assert(mdoc->last->child);
+       assert(MDOC_TEXT == mdoc->last->child->type);

 
 

-       if (mdoc_a2lib(mdoc->last->child->string))
+       p = mdoc_a2lib(mdoc->last->child->string);
+
+       /* If lookup ok, replace with table value. */
+
+       if (p) {
+               free(mdoc->last->child->string);
+               mdoc->last->child->string = mandoc_strdup(p);

                return(1);
                return(1);

-       return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADLIB));
-}
+       }
+
+       /* If not, use "library ``xxxx''. */

 
 

+       sz = strlen(mdoc->last->child->string) +
+               2 + strlen("\\(lqlibrary\\(rq");
+       buf = mandoc_malloc(sz);
+       snprintf(buf, sz, "library \\(lq%s\\(rq", 
+                       mdoc->last->child->string);
+       free(mdoc->last->child->string);
+       mdoc->last->child->string = buf;
+       return(1);
+}

 
 static int
 post_eoln(POST_ARGS)
 
 static int
 post_eoln(POST_ARGS)


@@ -1127,12 +1154,58 @@ post_vt(POST_ARGS)
 static int
 post_nm(POST_ARGS)
 {
 static int
 post_nm(POST_ARGS)
 {

+       struct mdoc_node *nn;
+       char              buf[BUFSIZ];

 
 

-       if (mdoc->last->child)
+       /* If no child specified, make sure we have the meta name. */
+
+       if (NULL == mdoc->last->child && NULL == mdoc->meta.name) {
+               mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);

                return(1);
                return(1);

-       if (mdoc->meta.name)
+       } else if (mdoc->meta.name)

                return(1);
                return(1);

-       return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME));
+
+       /* If no meta name, set it from the child. */
+
+       buf[0] = '\0';
+
+       for (nn = mdoc->last->child; nn; nn = nn->next) {
+               /* XXX - copied from concat(). */
+               assert(MDOC_TEXT == nn->type);
+
+               if (strlcat(buf, nn->string, BUFSIZ) >= BUFSIZ) {
+                       mdoc_nmsg(mdoc, nn, MANDOCERR_MEM);
+                       return(0);
+               }
+
+               if (NULL == nn->next)
+                       continue;
+
+               if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
+                       mdoc_nmsg(mdoc, nn, MANDOCERR_MEM);
+                       return(0);
+               }
+       }
+
+       mdoc->meta.name = mandoc_strdup(buf);
+       return(1);
+}
+
+static int
+post_literal(POST_ARGS)
+{
+       
+       /*
+        * The `Dl' (note "el" not "one") and `Bd' macros unset the
+        * MDOC_LITERAL flag as they leave.  Note that `Bd' only sets
+        * this in literal mode, but it doesn't hurt to just switch it
+        * off in general since displays can't be nested.
+        */
+
+       if (MDOC_BODY == mdoc->last->type)
+               mdoc->last->flags &= ~MDOC_LITERAL;
+
+       return(1);

 }
 
 static int
 }
 
 static int


@@ -1142,8 +1215,8 @@ post_defaults(POST_ARGS)
 
        /*
         * The `Ar' defaults to "file ..." if no value is provided as an
 
        /*
         * The `Ar' defaults to "file ..." if no value is provided as an

-        * argument; the `Mt' macro uses "~"; the `Li' just gets an
-        * empty string.
+        * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
+        * gets an empty string.

         */
 
        if (mdoc->last->child)
         */
 
        if (mdoc->last->child)


@@ -1159,10 +1232,18 @@ post_defaults(POST_ARGS)
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
                        return(0);
                break;
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
                        return(0);
                break;

+       case (MDOC_At):
+               if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T"))
+                       return(0);
+               if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX"))
+                       return(0);
+               break;

        case (MDOC_Li):
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
                        return(0);
                break;
        case (MDOC_Li):
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
                        return(0);
                break;

+       case (MDOC_Pa):
+               /* FALLTHROUGH */

        case (MDOC_Mt):
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
                        return(0);
        case (MDOC_Mt):
                if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
                        return(0);


@@ -1179,15 +1260,39 @@ post_defaults(POST_ARGS)
 static int
 post_at(POST_ARGS)
 {
 static int
 post_at(POST_ARGS)
 {

+       const char       *p, *q;
+       char             *buf;
+       size_t            sz;

 
 

+       /*
+        * If we have a child, look it up in the standard keys.  If a
+        * key exist, use that instead of the child; if it doesn't,
+        * prefix "AT&T UNIX " to the existing data.
+        */
+       

        if (NULL == mdoc->last->child)
                return(1);
        if (NULL == mdoc->last->child)
                return(1);

+

        assert(MDOC_TEXT == mdoc->last->child->type);
        assert(MDOC_TEXT == mdoc->last->child->type);

-       if (mdoc_a2att(mdoc->last->child->string))
-               return(1);
-       return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT));
-}
+       p = mdoc_a2att(mdoc->last->child->string);
+
+       if (p) {
+               free(mdoc->last->child->string);
+               mdoc->last->child->string = mandoc_strdup(p);
+       } else {
+               mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
+               p = "AT&T UNIX ";
+               q = mdoc->last->child->string;
+               sz = strlen(p) + strlen(q) + 1;
+               buf = mandoc_malloc(sz);
+               strlcpy(buf, p, sz);
+               strlcat(buf, q, sz);
+               free(mdoc->last->child->string);
+               mdoc->last->child->string = buf;
+       }

 
 

+       return(1);
+}

 
 static int
 post_an(POST_ARGS)
 
 static int
 post_an(POST_ARGS)


@@ -1387,16 +1492,25 @@ post_root(POST_ARGS)
        return(0);
 }
 
        return(0);
 }
 

-

 static int
 post_st(POST_ARGS)
 {
 static int
 post_st(POST_ARGS)
 {

+       const char      *p;

 
 

-       if (mdoc_a2st(mdoc->last->child->string))
-               return(1);
-       return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD));
-}
+       assert(MDOC_TEXT == mdoc->last->child->type);

 
 

+       p = mdoc_a2st(mdoc->last->child->string);
+
+       if (p == NULL) {
+               mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
+               mdoc_node_delete(mdoc, mdoc->last);
+       } else {
+               free(mdoc->last->child->string);
+               mdoc->last->child->string = mandoc_strdup(p);
+       }
+
+       return(1);
+}

 
 static int
 post_rs(POST_ARGS)
 
 static int
 post_rs(POST_ARGS)


@@ -1664,3 +1778,34 @@ pre_par(PRE_ARGS)
        mdoc_node_delete(mdoc, mdoc->last);
        return(1);
 }
        mdoc_node_delete(mdoc, mdoc->last);
        return(1);
 }

+
+static int
+pre_literal(PRE_ARGS)
+{
+
+       if (MDOC_BODY != n->type)
+               return(1);
+
+       /*
+        * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
+        * -unfilled' macros set MDOC_LITERAL on entrance to the body.
+        */
+
+       switch (n->tok) {
+       case (MDOC_Dl):
+               mdoc->flags |= MDOC_LITERAL;
+               break;
+       case (MDOC_Bd):
+               assert(n->data.Bd);
+               if (DISP_literal == n->data.Bd->type)
+                       mdoc->flags |= MDOC_LITERAL;
+               if (DISP_unfilled == n->data.Bd->type)
+                       mdoc->flags |= MDOC_LITERAL;
+               break;
+       default:
+               abort();
+               /* NOTREACHED */
+       }
+       
+       return(1);
+}