Move `Sh' validation from mdoc_action.c. into mdoc_validate.c.

[mandoc.git] / mdoc_action.c

diff --git a/mdoc_action.c b/mdoc_action.c
index f27ef13b4b585cfe29c914440606b2d14574835f..566310d2214662e667f532fce29bdbb013ee608f 100644 (file)
--- a/mdoc_action.c
+++ b/mdoc_action.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_action.c,v 1.65 2010/06/03 13:44:36 kristaps Exp $ */
+/*     $Id: mdoc_action.c,v 1.81 2010/11/29 13:51:03 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * 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


@@ -32,6 +32,11 @@
 #include "libmdoc.h"
 #include "libmandoc.h"
 
 #include "libmdoc.h"
 #include "libmandoc.h"
 

+/* 
+ * FIXME: this file is deprecated.  All future "actions" should be
+ * pushed into mdoc_validate.c.
+ */
+

 #define        POST_ARGS struct mdoc *m, struct mdoc_node *n
 #define        PRE_ARGS  struct mdoc *m, struct mdoc_node *n
 
 #define        POST_ARGS struct mdoc *m, struct mdoc_node *n
 #define        PRE_ARGS  struct mdoc *m, struct mdoc_node *n
 


@@ -45,9 +50,7 @@ struct        actions {
 
 static int       concat(struct mdoc *, char *,
                        const struct mdoc_node *, size_t);
 
 static int       concat(struct mdoc *, char *,
                        const struct mdoc_node *, size_t);

-static inline int order_rs(enum mdoct);

 
 

-static int       post_ar(POST_ARGS);

 static int       post_at(POST_ARGS);
 static int       post_bl(POST_ARGS);
 static int       post_bl_head(POST_ARGS);
 static int       post_at(POST_ARGS);
 static int       post_bl(POST_ARGS);
 static int       post_bl_head(POST_ARGS);


@@ -57,39 +60,34 @@ static      int       post_dd(POST_ARGS);
 static int       post_display(POST_ARGS);
 static int       post_dt(POST_ARGS);
 static int       post_lb(POST_ARGS);
 static int       post_display(POST_ARGS);
 static int       post_dt(POST_ARGS);
 static int       post_lb(POST_ARGS);

-static int       post_li(POST_ARGS);

 static int       post_nm(POST_ARGS);
 static int       post_os(POST_ARGS);
 static int       post_pa(POST_ARGS);
 static int       post_prol(POST_ARGS);
 static int       post_nm(POST_ARGS);
 static int       post_os(POST_ARGS);
 static int       post_pa(POST_ARGS);
 static int       post_prol(POST_ARGS);

-static int       post_rs(POST_ARGS);
-static int       post_sh(POST_ARGS);

 static int       post_st(POST_ARGS);
 static int       post_std(POST_ARGS);
 
 static int       pre_bd(PRE_ARGS);
 static int       post_st(POST_ARGS);
 static int       post_std(POST_ARGS);
 
 static int       pre_bd(PRE_ARGS);

-static int       pre_bl(PRE_ARGS);

 static int       pre_dl(PRE_ARGS);
 static int       pre_dl(PRE_ARGS);

-static int       pre_offset(PRE_ARGS);

 
 static const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ap */
        { NULL, post_dd }, /* Dd */ 
        { NULL, post_dt }, /* Dt */ 
        { NULL, post_os }, /* Os */ 
 
 static const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ap */
        { NULL, post_dd }, /* Dd */ 
        { NULL, post_dt }, /* Dt */ 
        { NULL, post_os }, /* Os */ 

-       { NULL, post_sh }, /* Sh */ 
+       { NULL, NULL }, /* Sh */ 

        { NULL, NULL }, /* Ss */ 
        { NULL, NULL }, /* Pp */ 
        { NULL, NULL }, /* D1 */
        { pre_dl, post_display }, /* Dl */
        { pre_bd, post_display }, /* Bd */ 
        { NULL, NULL }, /* Ed */
        { NULL, NULL }, /* Ss */ 
        { NULL, NULL }, /* Pp */ 
        { NULL, NULL }, /* D1 */
        { pre_dl, post_display }, /* Dl */
        { pre_bd, post_display }, /* Bd */ 
        { NULL, NULL }, /* Ed */

-       { pre_bl, post_bl }, /* Bl */ 
+       { NULL, post_bl }, /* Bl */ 

        { NULL, NULL }, /* El */
        { NULL, NULL }, /* It */
        { NULL, NULL }, /* Ad */ 
        { NULL, NULL }, /* An */
        { NULL, NULL }, /* El */
        { NULL, NULL }, /* It */
        { NULL, NULL }, /* Ad */ 
        { NULL, NULL }, /* An */

-       { NULL, post_ar }, /* Ar */
+       { NULL, NULL }, /* Ar */

        { NULL, NULL }, /* Cd */
        { NULL, NULL }, /* Cm */
        { NULL, NULL }, /* Dv */ 
        { NULL, NULL }, /* Cd */
        { NULL, NULL }, /* Cm */
        { NULL, NULL }, /* Dv */ 


@@ -103,7 +101,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ft */ 
        { NULL, NULL }, /* Ic */ 
        { NULL, NULL }, /* In */ 
        { NULL, NULL }, /* Ft */ 
        { NULL, NULL }, /* Ic */ 
        { NULL, NULL }, /* In */ 

-       { NULL, post_li }, /* Li */
+       { NULL, NULL }, /* Li */

        { NULL, NULL }, /* Nd */ 
        { NULL, post_nm }, /* Nm */ 
        { NULL, NULL }, /* Op */
        { NULL, NULL }, /* Nd */ 
        { NULL, post_nm }, /* Nm */ 
        { NULL, NULL }, /* Op */


@@ -158,7 +156,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Qo */
        { NULL, NULL }, /* Qq */
        { NULL, NULL }, /* Re */
        { NULL, NULL }, /* Qo */
        { NULL, NULL }, /* Qq */
        { NULL, NULL }, /* Re */

-       { NULL, post_rs }, /* Rs */
+       { NULL, NULL }, /* Rs */

        { NULL, NULL }, /* Sc */
        { NULL, NULL }, /* So */
        { NULL, NULL }, /* Sq */
        { NULL, NULL }, /* Sc */
        { NULL, NULL }, /* So */
        { NULL, NULL }, /* Sq */


@@ -429,52 +427,6 @@ post_at(POST_ARGS)
 }
 
 
 }
 
 

-/*
- * Mark the current section.  The ``named'' section (lastnamed) is set
- * whenever the current section isn't a custom section--we use this to
- * keep track of section ordering.  Also check that the section is
- * allowed within the document's manual section.
- */
-static int
-post_sh(POST_ARGS)
-{
-       enum mdoc_sec    sec;
-       char             buf[BUFSIZ];
-
-       if (MDOC_HEAD != n->type)
-               return(1);
-
-       if ( ! concat(m, buf, n->child, BUFSIZ))
-               return(0);
-       sec = mdoc_str2sec(buf);
-       /*
-        * The first section should always make us move into a non-new
-        * state.
-        */
-       if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
-               m->lastnamed = sec;
-
-       /* Some sections only live in certain manual sections. */
-
-       switch ((m->lastsec = sec)) {
-       case (SEC_RETURN_VALUES):
-               /* FALLTHROUGH */
-       case (SEC_ERRORS):
-               assert(m->meta.msec);
-               if (*m->meta.msec == '2')
-                       break;
-               if (*m->meta.msec == '3')
-                       break;
-               if (*m->meta.msec == '9')
-                       break;
-               return(mdoc_nmsg(m, n, MANDOCERR_SECMSEC));
-       default:
-               break;
-       }
-       return(1);
-}
-
-

 /*
  * Parse out the contents of `Dt'.  See in-line documentation for how we
  * handle the various fields of this macro.
 /*
  * Parse out the contents of `Dt'.  See in-line documentation for how we
  * handle the various fields of this macro.


@@ -633,33 +585,41 @@ static int
 post_bl_tagwidth(POST_ARGS)
 {
        struct mdoc_node *nn;
 post_bl_tagwidth(POST_ARGS)
 {
        struct mdoc_node *nn;

-       size_t            sz;
+       size_t            sz, ssz;

        int               i;
        char              buf[NUMSIZ];
 
        int               i;
        char              buf[NUMSIZ];
 

-       /* Defaults to ten ens. */
-
-       sz = 10; /* XXX: make this a macro value. */
+       sz = 10;

 
        for (nn = n->body->child; nn; nn = nn->next) {
 
        for (nn = n->body->child; nn; nn = nn->next) {

-               if (MDOC_It == nn->tok)
-                       break;
-       }
+               if (MDOC_It != nn->tok)
+                       continue;

 
 

-       if (nn) {

                assert(MDOC_BLOCK == nn->type);
                nn = nn->head->child;
                assert(MDOC_BLOCK == nn->type);
                nn = nn->head->child;

-               if (MDOC_TEXT != nn->type) {
-                       sz = mdoc_macro2len(nn->tok);
-                       if (sz == 0) {
-                               if ( ! mdoc_nmsg(m, n, MANDOCERR_NOWIDTHARG))
-                                       return(0);
-                               sz = 10;
-                       }
-               } else
+
+               if (nn == NULL) {
+                       /* No -width for .Bl and first .It is emtpy */
+                       if ( ! mdoc_nmsg(m, n, MANDOCERR_NOWIDTHARG))
+                               return(0);
+                       break;
+               }
+
+               if (MDOC_TEXT == nn->type) {

                        sz = strlen(nn->string) + 1;
                        sz = strlen(nn->string) + 1;

+                       break;
+               }
+
+               if (0 != (ssz = mdoc_macro2len(nn->tok)))
+                       sz = ssz;
+               else if ( ! mdoc_nmsg(m, n, MANDOCERR_NOWIDTHARG))
+                       return(0);
+
+               break;

        } 
 
        } 
 

+       /* Defaults to ten ens. */
+

        snprintf(buf, NUMSIZ, "%zun", sz);
 
        /*
        snprintf(buf, NUMSIZ, "%zun", sz);
 
        /*


@@ -667,19 +627,21 @@ post_bl_tagwidth(POST_ARGS)
         * We're guaranteed that a MDOC_Width doesn't already exist.
         */
 
         * We're guaranteed that a MDOC_Width doesn't already exist.
         */
 

-       nn = n;
-       assert(nn->args);
-       i = (int)(nn->args->argc)++;
-
-       nn->args->argv = mandoc_realloc(nn->args->argv, 
-                       nn->args->argc * sizeof(struct mdoc_argv));
-
-       nn->args->argv[i].arg = MDOC_Width;
-       nn->args->argv[i].line = n->line;
-       nn->args->argv[i].pos = n->pos;
-       nn->args->argv[i].sz = 1;
-       nn->args->argv[i].value = mandoc_malloc(sizeof(char *));
-       nn->args->argv[i].value[0] = mandoc_strdup(buf);
+       assert(n->args);
+       i = (int)(n->args->argc)++;
+
+       n->args->argv = mandoc_realloc(n->args->argv, 
+                       n->args->argc * sizeof(struct mdoc_argv));
+
+       n->args->argv[i].arg = MDOC_Width;
+       n->args->argv[i].line = n->line;
+       n->args->argv[i].pos = n->pos;
+       n->args->argv[i].sz = 1;
+       n->args->argv[i].value = mandoc_malloc(sizeof(char *));
+       n->args->argv[i].value[0] = mandoc_strdup(buf);
+
+       /* Set our width! */
+       n->data.Bl->width = n->args->argv[i].value[0];

        return(1);
 }
 
        return(1);
 }
 


@@ -696,36 +658,35 @@ post_bl_width(POST_ARGS)
        int               i;
        enum mdoct        tok;
        char              buf[NUMSIZ];
        int               i;
        enum mdoct        tok;
        char              buf[NUMSIZ];

-       char             *p;
-
-       if (NULL == n->args)
-               return(1);
-
-       for (i = 0; i < (int)n->args->argc; i++)
-               if (MDOC_Width == n->args->argv[i].arg)
-                       break;
-
-       if (i == (int)n->args->argc)
-               return(1);
-       p = n->args->argv[i].value[0];

 
        /*
         * If the value to -width is a macro, then we re-write it to be
         * the macro's width as set in share/tmac/mdoc/doc-common.
         */
 
 
        /*
         * If the value to -width is a macro, then we re-write it to be
         * the macro's width as set in share/tmac/mdoc/doc-common.
         */
 

-       if (0 == strcmp(p, "Ds"))
+       if (0 == strcmp(n->data.Bl->width, "Ds"))

                width = 6;
                width = 6;

-       else if (MDOC_MAX == (tok = mdoc_hash_find(p)))
+       else if (MDOC_MAX == (tok = mdoc_hash_find(n->data.Bl->width)))

                return(1);
        else if (0 == (width = mdoc_macro2len(tok))) 
                return(mdoc_nmsg(m, n, MANDOCERR_BADWIDTH));
 
        /* The value already exists: free and reallocate it. */
 
                return(1);
        else if (0 == (width = mdoc_macro2len(tok))) 
                return(mdoc_nmsg(m, n, MANDOCERR_BADWIDTH));
 
        /* The value already exists: free and reallocate it. */
 

+       assert(n->args);
+
+       for (i = 0; i < (int)n->args->argc; i++) 
+               if (MDOC_Width == n->args->argv[i].arg)
+                       break;
+
+       assert(i < (int)n->args->argc);
+

        snprintf(buf, NUMSIZ, "%zun", width);
        free(n->args->argv[i].value[0]);
        n->args->argv[i].value[0] = mandoc_strdup(buf);
        snprintf(buf, NUMSIZ, "%zun", width);
        free(n->args->argv[i].value[0]);
        n->args->argv[i].value[0] = mandoc_strdup(buf);

+
+       /* Set our width! */
+       n->data.Bl->width = n->args->argv[i].value[0];

        return(1);
 }
 
        return(1);
 }
 


@@ -741,7 +702,9 @@ post_bl_head(POST_ARGS)
        int                      i, c;
        struct mdoc_node        *np, *nn, *nnp;
 
        int                      i, c;
        struct mdoc_node        *np, *nn, *nnp;
 

-       if (NULL == n->child)
+       if (LIST_column != n->data.Bl->type)
+               return(1);
+       else if (NULL == n->child)

                return(1);
 
        np = n->parent;
                return(1);
 
        np = n->parent;


@@ -751,8 +714,7 @@ post_bl_head(POST_ARGS)
                if (MDOC_Column == np->args->argv[c].arg)
                        break;
 
                if (MDOC_Column == np->args->argv[c].arg)
                        break;
 

-       if (c == (int)np->args->argc)
-               return(1);
+       assert(c < (int)np->args->argc);

        assert(0 == np->args->argv[c].sz);
 
        /*
        assert(0 == np->args->argv[c].sz);
 
        /*


@@ -765,6 +727,9 @@ post_bl_head(POST_ARGS)
        np->args->argv[c].value = mandoc_malloc
                ((size_t)n->nchild * sizeof(char *));
 
        np->args->argv[c].value = mandoc_malloc
                ((size_t)n->nchild * sizeof(char *));
 

+       n->data.Bl->ncols = np->args->argv[c].sz;
+       n->data.Bl->cols = (const char **)np->args->argv[c].value;
+

        for (i = 0, nn = n->child; nn; i++) {
                np->args->argv[c].value[i] = nn->string;
                nn->string = NULL;
        for (i = 0, nn = n->child; nn; i++) {
                np->args->argv[c].value[i] = nn->string;
                nn->string = NULL;


@@ -782,7 +747,6 @@ post_bl_head(POST_ARGS)
 static int
 post_bl(POST_ARGS)
 {
 static int
 post_bl(POST_ARGS)
 {

-       int               i, r, len;

 
        if (MDOC_HEAD == n->type)
                return(post_bl_head(m, n));
 
        if (MDOC_HEAD == n->type)
                return(post_bl_head(m, n));


@@ -797,22 +761,16 @@ post_bl(POST_ARGS)
         * rewritten into real lengths).
         */
 
         * rewritten into real lengths).
         */
 

-       len = (int)(n->args ? n->args->argc : 0);
-
-       for (r = i = 0; i < len; i++) {
-               if (MDOC_Tag == n->args->argv[i].arg)
-                       r |= 1 << 0;
-               if (MDOC_Width == n->args->argv[i].arg)
-                       r |= 1 << 1;
-       }
-
-       if (r & (1 << 0) && ! (r & (1 << 1))) {
+       if (LIST_tag == n->data.Bl->type && NULL == n->data.Bl->width) {

                if ( ! post_bl_tagwidth(m, n))
                        return(0);
                if ( ! post_bl_tagwidth(m, n))
                        return(0);

-       } else if (r & (1 << 1))
+       } else if (NULL != n->data.Bl->width) {

                if ( ! post_bl_width(m, n))
                        return(0);
                if ( ! post_bl_width(m, n))
                        return(0);

+       } else 
+               return(1);

 
 

+       assert(n->data.Bl->width);

        return(1);
 }
 
        return(1);
 }
 


@@ -831,7 +789,6 @@ post_pa(POST_ARGS)
        
        np = n;
        m->next = MDOC_NEXT_CHILD;
        
        np = n;
        m->next = MDOC_NEXT_CHILD;

-       /* XXX: make into macro value. */

        if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
                return(0);
        m->last = np;
        if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
                return(0);
        m->last = np;


@@ -839,51 +796,6 @@ post_pa(POST_ARGS)
 }
 
 
 }
 
 

-/*
- * Empty `Li' macros get an empty string to make front-ends add an extra
- * space.
- */
-static int
-post_li(POST_ARGS)
-{
-       struct mdoc_node *np;
-
-       if (n->child)
-               return(1);
-       
-       np = n;
-       m->next = MDOC_NEXT_CHILD;
-       if ( ! mdoc_word_alloc(m, n->line, n->pos, ""))
-               return(0);
-       m->last = np;
-       return(1);
-}
-
-
-/*
- * The `Ar' macro defaults to two strings "file ..." if no value is
- * provided as an argument.
- */
-static int
-post_ar(POST_ARGS)
-{
-       struct mdoc_node *np;
-
-       if (n->child)
-               return(1);
-       
-       np = n;
-       m->next = MDOC_NEXT_CHILD;
-       /* XXX: make into macro values. */
-       if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
-               return(0);
-       if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
-               return(0);
-       m->last = np;
-       return(1);
-}
-
-

 /*
  * Parse the date field in `Dd'.
  */
 /*
  * Parse the date field in `Dd'.
  */


@@ -892,6 +804,11 @@ post_dd(POST_ARGS)
 {
        char            buf[DATESIZ];
 
 {
        char            buf[DATESIZ];
 

+       if (NULL == n->child) {
+               m->meta.date = time(NULL);
+               return(post_prol(m, n));
+       }
+

        if ( ! concat(m, buf, n->child, DATESIZ))
                return(0);
 
        if ( ! concat(m, buf, n->child, DATESIZ))
                return(0);
 


@@ -937,61 +854,18 @@ pre_dl(PRE_ARGS)
 }
 
 
 }
 
 

-/* ARGSUSED */
-static int
-pre_offset(PRE_ARGS)
-{
-       int              i;
-
-       /* 
-        * Make sure that an empty offset produces an 8n length space as
-        * stipulated by mdoc.samples. 
-        */
-
-       for (i = 0; n->args && i < (int)n->args->argc; i++) {
-               if (MDOC_Offset != n->args->argv[i].arg) 
-                       continue;
-               if (n->args->argv[i].sz)
-                       break;
-               assert(1 == n->args->refcnt);
-               /* If no value set, length of <string>. */
-               n->args->argv[i].sz++;
-               n->args->argv[i].value = mandoc_malloc(sizeof(char *));
-               n->args->argv[i].value[0] = mandoc_strdup("8n");
-               break;
-       }
-
-       return(1);
-}
-
-
-static int
-pre_bl(PRE_ARGS)
-{
-
-       if (MDOC_BLOCK == n->type)
-               return(pre_offset(m, n));
-       return(1);
-}
-
-

 static int
 pre_bd(PRE_ARGS)
 {
 static int
 pre_bd(PRE_ARGS)
 {

-       int              i;

 
 

-       if (MDOC_BLOCK == n->type)
-               return(pre_offset(m, n));

        if (MDOC_BODY != n->type)
                return(1);
 
        if (MDOC_BODY != n->type)
                return(1);
 

-       /* Enter literal context if `Bd -literal' or `-unfilled'. */
-
-       for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
-               if (MDOC_Literal == n->args->argv[i].arg)
-                       m->flags |= MDOC_LITERAL;
-               else if (MDOC_Unfilled == n->args->argv[i].arg)
-                       m->flags |= MDOC_LITERAL;
+       assert(n->data.Bd);
+       if (DISP_literal == n->data.Bd->type)
+               m->flags |= MDOC_LITERAL;
+       if (DISP_unfilled == n->data.Bd->type)
+               m->flags |= MDOC_LITERAL;

 
        return(1);
 }
 
        return(1);
 }


@@ -1005,67 +879,3 @@ post_display(POST_ARGS)
                m->flags &= ~MDOC_LITERAL;
        return(1);
 }
                m->flags &= ~MDOC_LITERAL;
        return(1);
 }

-
-
-static inline int
-order_rs(enum mdoct t)
-{
-       int             i;
-
-       for (i = 0; i < (int)RSORD_MAX; i++)
-               if (rsord[i] == t)
-                       return(i);
-
-       abort();
-       /* NOTREACHED */
-}
-
-
-/* ARGSUSED */
-static int
-post_rs(POST_ARGS)
-{
-       struct mdoc_node        *nn, *next, *prev;
-       int                      o;
-
-       if (MDOC_BLOCK != n->type)
-               return(1);
-
-       assert(n->body->child);
-       for (next = NULL, nn = n->body->child->next; nn; nn = next) {
-               o = order_rs(nn->tok);
-
-               /* Remove `nn' from the chain. */
-               next = nn->next;
-               if (next)
-                       next->prev = nn->prev;
-
-               prev = nn->prev;
-               if (prev)
-                       prev->next = nn->next;
-
-               nn->prev = nn->next = NULL;
-
-               /* 
-                * Scan back until we reach a node that's ordered before
-                * us, then set ourselves as being the next. 
-                */
-               for ( ; prev; prev = prev->prev)
-                       if (order_rs(prev->tok) <= o)
-                               break;
-
-               nn->prev = prev;
-               if (prev) {
-                       if (prev->next)
-                               prev->next->prev = nn;
-                       nn->next = prev->next;
-                       prev->next = nn;
-                       continue;
-               } 
-
-               n->body->child->prev = nn;
-               nn->next = n->body->child;
-               n->body->child = nn;
-       }
-       return(1);
-}