]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_action.c
Updated libman AST documentation.
[mandoc.git] / mdoc_action.c
index 26b1940b39b6a27d6150b64b5829370554d5138c..87882138ee00bef4f6d1f9e23a949a6bfdbd074b 100644 (file)
@@ -1,20 +1,18 @@
-/* $Id: mdoc_action.c,v 1.7 2009/04/06 09:48:35 kristaps Exp $ */
+/*     $Id: mdoc_action.c,v 1.34 2009/07/26 10:29:39 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #include <sys/utsname.h>
 
 
 #include "libmdoc.h"
 
-enum   mwarn {
-       WBADSEC,
-       WNOWIDTH,
-       WBADDATE
-};
-
-enum   merr {
-       ETOOLONG,
-       EMALLOC,
-       ENUMFMT
-};
-
 #define        PRE_ARGS  struct mdoc *m, const struct mdoc_node *n
 #define        POST_ARGS struct mdoc *m
 
@@ -46,33 +32,29 @@ struct      actions {
        int     (*post)(POST_ARGS);
 };
 
-static int       pwarn(struct mdoc *, int, int, enum mwarn);
-static int       perr(struct mdoc *, int, int, enum merr);
-static int       concat(struct mdoc *, const struct mdoc_node *, 
-                       char *, size_t);
-
 static int       post_ar(POST_ARGS);
+static int       post_at(POST_ARGS);
 static int       post_bl(POST_ARGS);
-static int       post_bl_width(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_nm(POST_ARGS);
 static int       post_os(POST_ARGS);
 static int       post_prol(POST_ARGS);
 static int       post_sh(POST_ARGS);
+static int       post_st(POST_ARGS);
 static int       post_std(POST_ARGS);
+static int       post_tilde(POST_ARGS);
 
 static int       pre_bd(PRE_ARGS);
 static int       pre_dl(PRE_ARGS);
 
-#define        vwarn(m, t) pwarn((m), (m)->last->line, (m)->last->pos, (t))
-#define        verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t))
-#define        nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t))
-
 const  struct actions mdoc_actions[MDOC_MAX] = {
-       { NULL, NULL }, /* \" */
+       { NULL, NULL }, /* Ap */
        { NULL, post_dd }, /* Dd */ 
        { NULL, post_dt }, /* Dt */ 
        { NULL, post_os }, /* Os */ 
@@ -89,7 +71,7 @@ const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ad */ 
        { NULL, NULL }, /* An */
        { NULL, post_ar }, /* Ar */
-       { NULL, NULL }, /* Cd */
+       { NULL, NULL }, /* Cd */ /* FIXME: tabs are accepted! */
        { NULL, NULL }, /* Cm */
        { NULL, NULL }, /* Dv */ 
        { NULL, NULL }, /* Er */ 
@@ -107,9 +89,9 @@ const        struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, post_nm }, /* Nm */ 
        { NULL, NULL }, /* Op */
        { NULL, NULL }, /* Ot */
-       { NULL, NULL }, /* Pa */
+       { NULL, post_tilde }, /* Pa */
        { NULL, post_std }, /* Rv */
-       { NULL, NULL }, /* St */
+       { NULL, post_st }, /* St */
        { NULL, NULL }, /* Va */
        { NULL, NULL }, /* Vt */ 
        { NULL, NULL }, /* Xr */
@@ -127,7 +109,7 @@ const       struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ac */
        { NULL, NULL }, /* Ao */
        { NULL, NULL }, /* Aq */
-       { NULL, NULL }, /* At */ 
+       { NULL, post_at }, /* At */ 
        { NULL, NULL }, /* Bc */
        { NULL, NULL }, /* Bf */ 
        { NULL, NULL }, /* Bo */
@@ -178,10 +160,9 @@ const      struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Hf */
        { NULL, NULL }, /* Fr */
        { NULL, NULL }, /* Ud */
-       { NULL, NULL }, /* Lb */
-       { NULL, NULL }, /* Ap */
+       { NULL, post_lb }, /* Lb */
        { NULL, NULL }, /* Lp */
-       { NULL, NULL }, /* Lk */
+       { NULL, post_tilde }, /* Lk */
        { NULL, NULL }, /* Mt */
        { NULL, NULL }, /* Brq */
        { NULL, NULL }, /* Bro */
@@ -191,11 +172,15 @@ const     struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* En */
        { NULL, NULL }, /* Dx */
        { NULL, NULL }, /* %Q */
+       { NULL, NULL }, /* br */
+       { NULL, NULL }, /* sp */
 };
 
+static int       concat(struct mdoc *, const struct mdoc_node *, 
+                       char *, size_t);
 
 #ifdef __linux__
-extern size_t  strlcat(char *, const char *, size_t);
+extern size_t    strlcat(char *, const char *, size_t);
 #endif
 
 
@@ -249,64 +234,17 @@ concat(struct mdoc *m, const struct mdoc_node *n,
        for ( ; n; n = n->next) {
                assert(MDOC_TEXT == n->type);
                if (strlcat(buf, n->string, sz) >= sz)
-                       return(nerr(m, n, ETOOLONG));
+                       return(mdoc_nerr(m, n, ETOOLONG));
                if (NULL == n->next)
                        continue;
                if (strlcat(buf, " ", sz) >= sz)
-                       return(nerr(m, n, ETOOLONG));
+                       return(mdoc_nerr(m, n, ETOOLONG));
        }
 
        return(1);
 }
 
 
-static int
-perr(struct mdoc *m, int line, int pos, enum merr type)
-{
-       char            *p;
-
-       p = NULL;
-       switch (type) {
-       case (ENUMFMT):
-               p = "bad number format";
-               break;
-       case (ETOOLONG):
-               p = "argument text too long";
-               break;
-       case (EMALLOC):
-               p = "memory exhausted";
-               break;
-       }
-       assert(p);
-       return(mdoc_perr(m, line, pos, p));
-}
-
-
-static int
-pwarn(struct mdoc *m, int line, int pos, enum mwarn type)
-{
-       char            *p;
-       int              c;
-
-       p = NULL;
-       c = WARN_SYNTAX;
-       switch (type) {
-       case (WBADSEC):
-               p = "inappropriate document section in manual section";
-               c = WARN_COMPAT;
-               break;
-       case (WNOWIDTH):
-               p = "cannot determine default width";
-               break;
-       case (WBADDATE):
-               p = "malformed date syntax";
-               break;
-       }
-       assert(p);
-       return(mdoc_pwarn(m, line, pos, c, p));
-}
-
-
 static int
 post_std(POST_ARGS)
 {
@@ -325,12 +263,12 @@ post_std(POST_ARGS)
 
        m->last->args->argv[0].value = calloc(1, sizeof(char *));
        if (NULL == m->last->args->argv[0].value)
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        m->last->args->argv[0].sz = 1;
        m->last->args->argv[0].value[0] = strdup(m->meta.name);
        if (NULL == m->last->args->argv[0].value[0])
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        return(1);
 }
@@ -349,8 +287,83 @@ post_nm(POST_ARGS)
                return(0);
 
        if (NULL == (m->meta.name = strdup(buf)))
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
+
+       return(1);
+}
+
+
+static int
+post_lb(POST_ARGS)
+{
+       const char      *p;
+       char            *buf;
+       size_t           sz;
+
+       assert(MDOC_TEXT == m->last->child->type);
+       p = mdoc_a2lib(m->last->child->string);
+       if (NULL == p) {
+               sz = strlen(m->last->child->string) +
+                       2 + strlen("\\(lqlibrary\\(rq");
+               buf = malloc(sz);
+               if (NULL == buf)
+                       return(mdoc_nerr(m, m->last, EMALLOC));
+               (void)snprintf(buf, sz, "library \\(lq%s\\(rq", 
+                               m->last->child->string);
+               free(m->last->child->string);
+               m->last->child->string = buf;
+               return(1);
+       }
+
+       free(m->last->child->string);
+       m->last->child->string = strdup(p);
+       if (NULL == m->last->child->string)
+               return(mdoc_nerr(m, m->last, EMALLOC));
+       return(1);
+}
+
+
+static int
+post_st(POST_ARGS)
+{
+       const char      *p;
+
+       assert(MDOC_TEXT == m->last->child->type);
+       p = mdoc_a2st(m->last->child->string);
+       assert(p);
+       free(m->last->child->string);
+       m->last->child->string = strdup(p);
+       if (NULL == m->last->child->string)
+               return(mdoc_nerr(m, m->last, EMALLOC));
+       return(1);
+}
+
+
+static int
+post_at(POST_ARGS)
+{
+       struct mdoc_node *n;
+       const char       *p;
+
+       if (m->last->child) {
+               assert(MDOC_TEXT == m->last->child->type);
+               p = mdoc_a2att(m->last->child->string);
+               assert(p);
+               free(m->last->child->string);
+               m->last->child->string = strdup(p);
+               if (NULL == m->last->child->string)
+                       return(mdoc_nerr(m, m->last, EMALLOC));
+               return(1);
+       }
+
+       n = m->last;
+       m->next = MDOC_NEXT_CHILD;
+
+       if ( ! mdoc_word_alloc(m, n->line, n->pos, "AT&T UNIX"))
+               return(0);
 
+       m->last = n;
+       m->next = MDOC_NEXT_SIBLING;
        return(1);
 }
 
@@ -388,7 +401,7 @@ post_sh(POST_ARGS)
                case (9):
                        break;
                default:
-                       return(vwarn(m, WBADSEC));
+                       return(mdoc_nwarn(m, m->last, EBADSEC));
                }
                break;
        default:
@@ -422,9 +435,9 @@ post_dt(POST_ARGS)
 
        if (NULL == (n = m->last->child)) {
                if (NULL == (m->meta.title = strdup("unknown")))
-                       return(verr(m, EMALLOC));
+                       return(mdoc_nerr(m, m->last, EMALLOC));
                if (NULL == (m->meta.vol = strdup("local")))
-                       return(verr(m, EMALLOC));
+                       return(mdoc_nerr(m, m->last, EMALLOC));
                return(post_prol(m));
        }
 
@@ -433,11 +446,11 @@ post_dt(POST_ARGS)
         */
 
        if (NULL == (m->meta.title = strdup(n->string)))
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        if (NULL == (n = n->next)) {
                if (NULL == (m->meta.vol = strdup("local")))
-                       return(verr(m, EMALLOC));
+                       return(mdoc_nerr(m, m->last, EMALLOC));
                return(post_prol(m));
        }
 
@@ -451,13 +464,13 @@ post_dt(POST_ARGS)
        cp = mdoc_a2msec(n->string);
        if (cp) {
                if (NULL == (m->meta.vol = strdup(cp)))
-                       return(verr(m, EMALLOC));
+                       return(mdoc_nerr(m, m->last, EMALLOC));
                errno = 0;
                lval = strtol(n->string, &ep, 10);
                if (n->string[0] != '\0' && *ep == '\0')
                        m->meta.msec = (int)lval;
        } else if (NULL == (m->meta.vol = strdup(n->string)))
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        if (NULL == (n = n->next))
                return(post_prol(m));
@@ -473,16 +486,15 @@ post_dt(POST_ARGS)
        if (cp) {
                free(m->meta.vol);
                if (NULL == (m->meta.vol = strdup(cp)))
-                       return(verr(m, EMALLOC));
-               n = n->next;
+                       return(mdoc_nerr(m, m->last, EMALLOC));
        } else {
                cp = mdoc_a2arch(n->string);
                if (NULL == cp) {
                        free(m->meta.vol);
                        if (NULL == (m->meta.vol = strdup(n->string)))
-                               return(verr(m, EMALLOC));
+                               return(mdoc_nerr(m, m->last, EMALLOC));
                } else if (NULL == (m->meta.arch = strdup(cp)))
-                       return(verr(m, EMALLOC));
+                       return(mdoc_nerr(m, m->last, EMALLOC));
        }       
 
        /* Ignore any subsequent parameters... */
@@ -506,18 +518,17 @@ post_os(POST_ARGS)
 
        if (0 == buf[0]) {
                if (-1 == uname(&utsname))
-                       return(mdoc_err(m, "utsname"));
+                       return(mdoc_nerr(m, m->last, EUTSNAME));
                if (strlcat(buf, utsname.sysname, 64) >= 64)
-                       return(verr(m, ETOOLONG));
+                       return(mdoc_nerr(m, m->last, ETOOLONG));
                if (strlcat(buf, " ", 64) >= 64)
-                       return(verr(m, ETOOLONG));
+                       return(mdoc_nerr(m, m->last, ETOOLONG));
                if (strlcat(buf, utsname.release, 64) >= 64)
-                       return(verr(m, ETOOLONG));
+                       return(mdoc_nerr(m, m->last, ETOOLONG));
        }
 
        if (NULL == (m->meta.os = strdup(buf)))
-               return(verr(m, EMALLOC));
-       m->lastnamed = m->lastsec = SEC_BODY;
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        return(post_prol(m));
 }
@@ -539,7 +550,8 @@ post_bl_tagwidth(struct mdoc *m)
         * width if a macro.
         */
 
-       if ((n = m->last->body->child)) {
+       n = m->last->body->child;
+       if (n) {
                assert(MDOC_BLOCK == n->type);
                assert(MDOC_It == n->tok);
                n = n->head->child;
@@ -550,14 +562,14 @@ post_bl_tagwidth(struct mdoc *m)
        if (n) {
                if (MDOC_TEXT != n->type) {
                        if (0 == (sz = (int)mdoc_macro2len(n->tok)))
-                               if ( ! vwarn(m, WNOWIDTH))
+                               if ( ! mdoc_nwarn(m, m->last, ENOWIDTH))
                                        return(0);
                } else
                        sz = (int)strlen(n->string) + 1;
        } 
 
        if (-1 == snprintf(buf, sizeof(buf), "%dn", sz))
-               return(verr(m, ENUMFMT));
+               return(mdoc_nerr(m, m->last, ENUMFMT));
 
        /*
         * We have to dynamically add this to the macro's argument list.
@@ -572,7 +584,7 @@ post_bl_tagwidth(struct mdoc *m)
                        n->args->argc * sizeof(struct mdoc_argv));
 
        if (NULL == n->args->argv)
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        n->args->argv[sz].arg = MDOC_Width;
        n->args->argv[sz].line = m->last->line;
@@ -581,9 +593,9 @@ post_bl_tagwidth(struct mdoc *m)
        n->args->argv[sz].value = calloc(1, sizeof(char *));
 
        if (NULL == n->args->argv[sz].value)
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
        if (NULL == (n->args->argv[sz].value[0] = strdup(buf)))
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
 
        return(1);
 }
@@ -614,21 +626,69 @@ post_bl_width(struct mdoc *m)
         */
 
        if (0 == strcmp(p, "Ds"))
-               width = 8;
+               width = 6;
        else if (MDOC_MAX == (tok = mdoc_hash_find(m->htab, p)))
                return(1);
        else if (0 == (width = mdoc_macro2len(tok))) 
-               return(vwarn(m, WNOWIDTH));
+               return(mdoc_nwarn(m, m->last, ENOWIDTH));
 
        /* The value already exists: free and reallocate it. */
 
        if (-1 == snprintf(buf, sizeof(buf), "%zun", width))
-               return(verr(m, ENUMFMT));
+               return(mdoc_nerr(m, m->last, ENUMFMT));
 
        free(m->last->args->argv[i].value[0]);
        m->last->args->argv[i].value[0] = strdup(buf);
        if (NULL == m->last->args->argv[i].value[0])
-               return(verr(m, EMALLOC));
+               return(mdoc_nerr(m, m->last, EMALLOC));
+
+       return(1);
+}
+
+
+static int
+post_bl_head(POST_ARGS)
+{
+       int                      i, c;
+       struct mdoc_node        *n, *nn, *nnp;
+
+       if (NULL == m->last->child)
+               return(1);
+
+       n = m->last->parent;
+       assert(n->args);
+
+       for (c = 0; c < (int)n->args->argc; c++) 
+               if (MDOC_Column == n->args->argv[c].arg)
+                       break;
+
+       /* Only process -column. */
+
+       if (c == (int)n->args->argc)
+               return(1);
+       
+       assert(0 == n->args->argv[c].sz);
+
+       /*
+        * Accomodate 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.
+        */
+
+       n->args->argv[c].sz = (size_t)m->last->nchild;
+       n->args->argv[c].value = malloc
+               ((size_t)m->last->nchild * sizeof(char *));
+
+       for (i = 0, nn = m->last->child; nn; i++) {
+               n->args->argv[c].value[i] = nn->string;
+               nn->string = NULL;
+               nnp = nn;
+               nn = nn->next;
+               mdoc_node_free(nnp);
+       }
+
+       m->last->nchild = 0;
+       m->last->child = NULL;
 
        return(1);
 }
@@ -639,6 +699,8 @@ post_bl(POST_ARGS)
 {
        int               i, r, len;
 
+       if (MDOC_HEAD == m->last->type)
+               return(post_bl_head(m));
        if (MDOC_BLOCK != m->last->type)
                return(1);
 
@@ -670,6 +732,27 @@ post_bl(POST_ARGS)
 }
 
 
+static int
+post_tilde(POST_ARGS)
+{
+       struct mdoc_node *n;
+
+       if (m->last->child)
+               return(1);
+       
+       n = m->last;
+       m->next = MDOC_NEXT_CHILD;
+
+       /* XXX: not documented for `Lk'. */
+       if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "~"))
+               return(0);
+
+       m->last = n;
+       m->next = MDOC_NEXT_SIBLING;
+       return(1);
+}
+
+
 static int
 post_ar(POST_ARGS)
 {
@@ -680,12 +763,10 @@ post_ar(POST_ARGS)
        
        n = m->last;
        m->next = MDOC_NEXT_CHILD;
-       if ( ! mdoc_word_alloc(m, m->last->line,
-                               m->last->pos, "file"))
+       if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "file"))
                return(0);
        m->next = MDOC_NEXT_SIBLING;
-       if ( ! mdoc_word_alloc(m, m->last->line, 
-                               m->last->pos, "..."))
+       if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "..."))
                return(0);
 
        m->last = n;
@@ -704,7 +785,7 @@ post_dd(POST_ARGS)
                return(0);
 
        if (0 == (m->meta.date = mdoc_atotime(buf))) {
-               if ( ! vwarn(m, WBADDATE))
+               if ( ! mdoc_nwarn(m, m->last, EBADDATE))
                        return(0);
                m->meta.date = time(NULL);
        }
@@ -740,6 +821,9 @@ post_prol(POST_ARGS)
        }
 
        mdoc_node_freelist(n);
+
+       if (m->meta.title && m->meta.date && m->meta.os)
+               m->flags |= MDOC_PBODY;
        return(1);
 }
 
@@ -748,9 +832,9 @@ static int
 pre_dl(PRE_ARGS)
 {
 
-       if (MDOC_BODY != n->type)
-               return(1);
-       m->flags |= MDOC_LITERAL;
+       if (MDOC_BODY == n->type)
+               m->flags |= MDOC_LITERAL;
+
        return(1);
 }
 
@@ -763,7 +847,12 @@ pre_bd(PRE_ARGS)
        if (MDOC_BODY != n->type)
                return(1);
 
-       /* Enter literal context if `Bd -literal' or * -unfilled'. */
+       /* Enter literal context if `Bd -literal' or `-unfilled'. */
+
+       /* 
+        * TODO: `-offset' without an argument should be the width of
+        * the literal "<string>".
+        */
 
        for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
                if (MDOC_Literal == n->args->argv[i].arg)