OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / mdoc_action.c

diff --git a/mdoc_action.c b/mdoc_action.c
index 96c3d51d2bddf9be99104712174bfaab92fe2e6c..5bdc2fcd4f316779f526686d0f1e4f2dae146259 100644 (file)
--- a/mdoc_action.c
+++ b/mdoc_action.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_action.c,v 1.60 2010/05/17 23:57:06 kristaps Exp $ */
+/*     $Id: mdoc_action.c,v 1.78 2010/07/30 17:14:09 joerg 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
 


@@ -57,6 +62,7 @@ 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_nm(POST_ARGS);
 static int       post_os(POST_ARGS);
 static int       post_pa(POST_ARGS);


@@ -67,9 +73,7 @@ static        int       post_st(POST_ARGS);
 static int       post_std(POST_ARGS);
 
 static int       pre_bd(PRE_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 */
 
 static const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* Ap */


@@ -83,7 +87,7 @@ static        const struct actions mdoc_actions[MDOC_MAX] = {
        { pre_dl, post_display }, /* Dl */
        { pre_bd, post_display }, /* Bd */ 
        { NULL, NULL }, /* Ed */
        { 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 }, /* El */
        { NULL, NULL }, /* It */
        { NULL, NULL }, /* Ad */ 


@@ -102,7 +106,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, NULL }, /* Li */
+       { NULL, post_li }, /* Li */

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


@@ -193,6 +197,7 @@ static      const struct actions mdoc_actions[MDOC_MAX] = {
        { NULL, NULL }, /* br */
        { NULL, NULL }, /* sp */
        { NULL, NULL }, /* %U */
        { NULL, NULL }, /* br */
        { NULL, NULL }, /* sp */
        { NULL, NULL }, /* %U */

+       { NULL, NULL }, /* Ta */

 };
 
 #define        RSORD_MAX 14
 };
 
 #define        RSORD_MAX 14


@@ -452,6 +457,17 @@ post_sh(POST_ARGS)
        if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
                m->lastnamed = sec;
 
        if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
                m->lastnamed = sec;
 

+       /*
+        * Switch the parser's SYNOPSIS mode, to be copied
+        * into individual nodes when creating them.
+        * Note that this mode can also be set and unset
+        * using the roff nS register.
+        */
+       if (SEC_SYNOPSIS == sec)
+               m->flags |= MDOC_SYNOPSIS;
+       else
+               m->flags &= ~MDOC_SYNOPSIS;
+

        /* Some sections only live in certain manual sections. */
 
        switch ((m->lastsec = sec)) {
        /* Some sections only live in certain manual sections. */
 
        switch ((m->lastsec = sec)) {


@@ -498,8 +514,8 @@ post_dt(POST_ARGS)
        if (NULL == (nn = n->child)) {
                /* XXX: make these macro values. */
                /* FIXME: warn about missing values. */
        if (NULL == (nn = n->child)) {
                /* XXX: make these macro values. */
                /* FIXME: warn about missing values. */

-               m->meta.title = mandoc_strdup("unknown");
-               m->meta.vol = mandoc_strdup("local");
+               m->meta.title = mandoc_strdup("UNKNOWN");
+               m->meta.vol = mandoc_strdup("LOCAL");

                m->meta.msec = mandoc_strdup("1");
                return(post_prol(m, n));
        }
                m->meta.msec = mandoc_strdup("1");
                return(post_prol(m, n));
        }


@@ -508,12 +524,13 @@ post_dt(POST_ARGS)
         *   --> title = TITLE, volume = local, msec = 0, arch = NULL
         */
 
         *   --> title = TITLE, volume = local, msec = 0, arch = NULL
         */
 

-       m->meta.title = mandoc_strdup(nn->string);
+       m->meta.title = mandoc_strdup
+               ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);

 
        if (NULL == (nn = nn->next)) {
                /* FIXME: warn about missing msec. */
                /* XXX: make this a macro value. */
 
        if (NULL == (nn = nn->next)) {
                /* FIXME: warn about missing msec. */
                /* XXX: make this a macro value. */

-               m->meta.vol = mandoc_strdup("local");
+               m->meta.vol = mandoc_strdup("LOCAL");

                m->meta.msec = mandoc_strdup("1");
                return(post_prol(m, n));
        }
                m->meta.msec = mandoc_strdup("1");
                return(post_prol(m, n));
        }


@@ -630,30 +647,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;

 
 

-       sz = 10; /* XXX: make this a macro value. */
-       nn = n->body->child;
+       for (nn = n->body->child; nn; nn = nn->next) {
+               if (MDOC_It != nn->tok)
+                       continue;

 
 

-       if (nn) {

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

-               assert(MDOC_It == nn->tok);

                nn = nn->head->child;
                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);
 
        /*


@@ -661,19 +689,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);
 }
 


@@ -690,36 +720,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);
 }
 


@@ -735,7 +764,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;


@@ -745,8 +776,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);
 
        /*


@@ -759,6 +789,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;


@@ -776,7 +809,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));


@@ -791,22 +823,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);
 }
 


@@ -825,7 +851,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;


@@ -833,6 +858,27 @@ 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.
 /*
  * The `Ar' macro defaults to two strings "file ..." if no value is
  * provided as an argument.


@@ -865,6 +911,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);
 


@@ -910,115 +961,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. 
-        */
-
-       assert(n->args);
-       for (i = 0; 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)
-{
-       int              pos;
-
-       if (MDOC_BLOCK != n->type) {
-               assert(n->parent);
-               assert(MDOC_BLOCK == n->parent->type);
-               assert(MDOC_Bl == n->parent->tok);
-               assert(LIST__NONE != n->parent->data.list);
-               n->data.list = n->parent->data.list;
-               return(1);
-       }
-
-       assert(LIST__NONE == n->data.list);
-
-       for (pos = 0; pos < (int)n->args->argc; pos++) {
-               switch (n->args->argv[pos].arg) {
-               case (MDOC_Bullet):
-                       n->data.list = LIST_bullet;
-                       break;
-               case (MDOC_Dash):
-                       n->data.list = LIST_dash;
-                       break;
-               case (MDOC_Enum):
-                       n->data.list = LIST_enum;
-                       break;
-               case (MDOC_Hyphen):
-                       n->data.list = LIST_hyphen;
-                       break;
-               case (MDOC_Item):
-                       n->data.list = LIST_item;
-                       break;
-               case (MDOC_Tag):
-                       n->data.list = LIST_tag;
-                       break;
-               case (MDOC_Diag):
-                       n->data.list = LIST_diag;
-                       break;
-               case (MDOC_Hang):
-                       n->data.list = LIST_hang;
-                       break;
-               case (MDOC_Ohang):
-                       n->data.list = LIST_ohang;
-                       break;
-               case (MDOC_Inset):
-                       n->data.list = LIST_inset;
-                       break;
-               case (MDOC_Column):
-                       n->data.list = LIST_column;
-                       break;
-               default:
-                       break;
-               }
-               if (LIST__NONE != n->data.list)
-                       break;
-       }
-
-       assert(LIST__NONE != n->data.list);
-       return(pre_offset(m, n));
-}
-
-

 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);
 }