]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_action.c
Migrate `Nm' and `Pa' handling from mdoc_action.c into mdoc_validate.c.
[mandoc.git] / mdoc_action.c
index 3cc87e418036abf24a23d8a19ab732b91e0ca2d1..4bd8203a6b9c73043cf8d2e3eaa1937435a463a4 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_action.c,v 1.71 2010/06/19 20:46:28 kristaps Exp $ */
+/*     $Id: mdoc_action.c,v 1.85 2010/11/29 16:06:46 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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
 #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
 
@@ -45,49 +50,35 @@ struct      actions {
 
 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_bl_tagwidth(POST_ARGS);
 static int       post_bl_width(POST_ARGS);
 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_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_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       pre_dl(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 */ 
-       { 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 }, /* Dl */
+       { NULL, NULL }, /* Bd */ 
        { NULL, NULL }, /* Ed */
        { NULL, post_bl }, /* Bl */ 
        { 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 */ 
@@ -101,14 +92,14 @@ static     const struct actions mdoc_actions[MDOC_MAX] = {
        { 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 }, /* Nm */ 
        { NULL, NULL }, /* Op */
        { NULL, NULL }, /* Ot */
-       { NULL, post_pa }, /* Pa */
+       { NULL, NULL }, /* Pa */
        { NULL, post_std }, /* Rv */
-       { NULL, post_st }, /* St */
+       { NULL, NULL }, /* St */
        { NULL, NULL }, /* Va */
        { NULL, NULL }, /* Vt */ 
        { NULL, NULL }, /* Xr */
@@ -126,7 +117,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ac */
        { NULL, NULL }, /* Ao */
        { NULL, NULL }, /* Aq */
-       { NULL, post_at }, /* At */ 
+       { NULL, NULL }, /* At */ 
        { NULL, NULL }, /* Bc */
        { NULL, NULL }, /* Bf */ 
        { NULL, NULL }, /* Bo */
@@ -156,7 +147,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { 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 */
@@ -177,7 +168,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Hf */
        { NULL, NULL }, /* Fr */
        { NULL, NULL }, /* Ud */
-       { NULL, post_lb }, /* Lb */
+       { NULL, NULL }, /* Lb */
        { NULL, NULL }, /* Lp */
        { NULL, NULL }, /* Lk */
        { NULL, NULL }, /* Mt */
@@ -195,25 +186,6 @@ static     const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ta */
 };
 
-#define        RSORD_MAX 14
-
-static const enum mdoct rsord[RSORD_MAX] = {
-       MDOC__A,
-       MDOC__T,
-       MDOC__B,
-       MDOC__I,
-       MDOC__J,
-       MDOC__R,
-       MDOC__N,
-       MDOC__V,
-       MDOC__P,
-       MDOC__Q,
-       MDOC__D,
-       MDOC__O,
-       MDOC__C,
-       MDOC__U
-};
-
 
 int
 mdoc_action_pre(struct mdoc *m, struct mdoc_node *n)
@@ -314,165 +286,6 @@ post_std(POST_ARGS)
        return(1);
 }
 
-
-/*
- * The `Nm' macro's first use sets the name of the document.  See also
- * post_std(), etc.
- */
-static int
-post_nm(POST_ARGS)
-{
-       char             buf[BUFSIZ];
-
-       if (m->meta.name)
-               return(1);
-       if ( ! concat(m, buf, n->child, BUFSIZ))
-               return(0);
-       m->meta.name = mandoc_strdup(buf);
-       return(1);
-}
-
-
-/*
- * Look up the value of `Lb' for matching predefined strings.  If it has
- * one, then substitute the current value for the formatted value.  Note
- * that the lookup may fail (we can provide arbitrary strings).
- */
-/* ARGSUSED */
-static int
-post_lb(POST_ARGS)
-{
-       const char      *p;
-       char            *buf;
-       size_t           sz;
-
-       assert(MDOC_TEXT == n->child->type);
-       p = mdoc_a2lib(n->child->string);
-
-       if (p) {
-               free(n->child->string);
-               n->child->string = mandoc_strdup(p);
-               return(1);
-       }
-
-       sz = strlen(n->child->string) +
-               2 + strlen("\\(lqlibrary\\(rq");
-       buf = mandoc_malloc(sz);
-       snprintf(buf, sz, "library \\(lq%s\\(rq", n->child->string);
-       free(n->child->string);
-       n->child->string = buf;
-       return(1);
-}
-
-
-/*
- * Substitute the value of `St' for the corresponding formatted string.
- * We're guaranteed that this exists (it's been verified during the
- * validation phase).
- */
-/* ARGSUSED */
-static int
-post_st(POST_ARGS)
-{
-       const char      *p;
-
-       assert(MDOC_TEXT == n->child->type);
-       p = mdoc_a2st(n->child->string);
-       if (p != NULL) {
-               free(n->child->string);
-               n->child->string = mandoc_strdup(p);
-       }
-       return(1);
-}
-
-
-/*
- * Look up the standard string in a table.  We know that it exists from
- * the validation phase, so assert on failure.  If a standard key wasn't
- * supplied, supply the default ``AT&T UNIX''.
- */
-static int
-post_at(POST_ARGS)
-{
-       struct mdoc_node *nn;
-       const char       *p, *q;
-       char             *buf;
-       size_t            sz;
-
-       if (n->child) {
-               assert(MDOC_TEXT == n->child->type);
-               p = mdoc_a2att(n->child->string);
-               if (p) {
-                       free(n->child->string);
-                       n->child->string = mandoc_strdup(p);
-               } else {
-                       p = "AT&T UNIX ";
-                       q = n->child->string;
-                       sz = strlen(p) + strlen(q) + 1;
-                       buf = mandoc_malloc(sz);
-                       strlcpy(buf, p, sz);
-                       strlcat(buf, q, sz);
-                       free(n->child->string);
-                       n->child->string = buf;
-               }
-               return(1);
-       }
-
-       nn = n;
-       m->next = MDOC_NEXT_CHILD;
-       if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
-               return(0);
-       m->last = nn;
-       return(1);
-}
-
-
-/*
- * 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.
@@ -644,6 +457,13 @@ post_bl_tagwidth(POST_ARGS)
                assert(MDOC_BLOCK == nn->type);
                nn = nn->head->child;
 
+               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;
                        break;
@@ -680,7 +500,7 @@ post_bl_tagwidth(POST_ARGS)
        n->args->argv[i].value[0] = mandoc_strdup(buf);
 
        /* Set our width! */
-       n->data.Bl.width = n->args->argv[i].value[0];
+       n->data.Bl->width = n->args->argv[i].value[0];
        return(1);
 }
 
@@ -703,9 +523,9 @@ post_bl_width(POST_ARGS)
         * the macro's width as set in share/tmac/mdoc/doc-common.
         */
 
-       if (0 == strcmp(n->data.Bl.width, "Ds"))
+       if (0 == strcmp(n->data.Bl->width, "Ds"))
                width = 6;
-       else if (MDOC_MAX == (tok = mdoc_hash_find(n->data.Bl.width)))
+       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));
@@ -725,7 +545,7 @@ post_bl_width(POST_ARGS)
        n->args->argv[i].value[0] = mandoc_strdup(buf);
 
        /* Set our width! */
-       n->data.Bl.width = n->args->argv[i].value[0];
+       n->data.Bl->width = n->args->argv[i].value[0];
        return(1);
 }
 
@@ -741,7 +561,7 @@ post_bl_head(POST_ARGS)
        int                      i, c;
        struct mdoc_node        *np, *nn, *nnp;
 
-       if (LIST_column != n->data.Bl.type)
+       if (LIST_column != n->data.Bl->type)
                return(1);
        else if (NULL == n->child)
                return(1);
@@ -766,6 +586,9 @@ post_bl_head(POST_ARGS)
        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;
@@ -783,8 +606,6 @@ post_bl_head(POST_ARGS)
 static int
 post_bl(POST_ARGS)
 {
-       struct mdoc_node *nn;
-       const char       *ww;
 
        if (MDOC_HEAD == n->type)
                return(post_bl_head(m, n));
@@ -799,98 +620,19 @@ post_bl(POST_ARGS)
         * rewritten into real lengths).
         */
 
-       ww = n->data.Bl.width;
-
-       if (LIST_tag == n->data.Bl.type && NULL == n->data.Bl.width) {
+       if (LIST_tag == n->data.Bl->type && NULL == n->data.Bl->width) {
                if ( ! post_bl_tagwidth(m, n))
                        return(0);
-       } else if (NULL != n->data.Bl.width) {
+       } else if (NULL != n->data.Bl->width) {
                if ( ! post_bl_width(m, n))
                        return(0);
        } else 
                return(1);
 
-       assert(n->data.Bl.width);
-
-       /* If it has changed, propogate new width to children. */
-
-       if (ww == n->data.Bl.width)
-               return(1);
-
-       for (nn = n->child; nn; nn = nn->next)
-               if (MDOC_Bl == nn->tok)
-                       nn->data.Bl.width = n->data.Bl.width;
-
-       return(1);
-}
-
-
-/*
- * The `Pa' macro defaults to a tilde if no value is provided as an
- * argument.
- */
-static int
-post_pa(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);
-}
-
-
-/*
- * 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;
+       assert(n->data.Bl->width);
        return(1);
 }
 
-
 /*
  * Parse the date field in `Dd'.
  */
@@ -899,6 +641,11 @@ post_dd(POST_ARGS)
 {
        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);
 
@@ -929,106 +676,3 @@ post_prol(POST_ARGS)
                m->flags |= MDOC_PBODY;
        return(1);
 }
-
-
-/*
- * Trigger a literal context.
- */
-static int
-pre_dl(PRE_ARGS)
-{
-
-       if (MDOC_BODY == n->type)
-               m->flags |= MDOC_LITERAL;
-       return(1);
-}
-
-
-static int
-pre_bd(PRE_ARGS)
-{
-
-       if (MDOC_BODY != n->type)
-               return(1);
-
-       if (DISP_literal == n->data.Bd.type)
-               m->flags |= MDOC_LITERAL;
-       if (DISP_unfilled == n->data.Bd.type)
-               m->flags |= MDOC_LITERAL;
-
-       return(1);
-}
-
-
-static int
-post_display(POST_ARGS)
-{
-
-       if (MDOC_BODY == n->type)
-               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);
-}