Documented the strings script.

[mandoc.git] / action.c

diff --git a/action.c b/action.c
index f9bc34d47853c0d60f81c3f8d812943c6853a782..d5605a38adcb81f84ac75bccd640e53c4cc37969 100644 (file)
--- a/action.c
+++ b/action.c
@@ -1,4 +1,4 @@
-/* $Id: action.c,v 1.12 2009/01/19 17:02:58 kristaps Exp $ */
+/* $Id: action.c,v 1.32 2009/03/06 14:24:49 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -16,12 +16,22 @@
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.
  */
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.
  */

+#include <sys/utsname.h>
+

 #include <assert.h>
 #include <assert.h>

+#include <errno.h>
+#include <stdio.h>

 #include <stdlib.h>
 #include <stdlib.h>

+#include <string.h>

 #include <time.h>
 
 #include "private.h"
 
 #include <time.h>
 
 #include "private.h"
 

+/*
+ * Actions are executed on macros after they've been post-validated: in
+ * other words, a macro will not be "acted upon" until all of its
+ * children have been filled in (post-fix order).
+ */

 
 struct actions {
        int     (*post)(struct mdoc *);
 
 struct actions {
        int     (*post)(struct mdoc *);


@@ -29,11 +39,18 @@ struct      actions {
 
 /* Per-macro action routines. */
 
 
 /* Per-macro action routines. */
 

-static int      post_sh(struct mdoc *);
-static int      post_os(struct mdoc *);
-static int      post_dt(struct mdoc *);
-static int      post_dd(struct mdoc *);
-static int      post_nm(struct mdoc *);
+static int      post_ar(struct mdoc *);
+static int      post_bl(struct mdoc *);
+static int      post_bl_width(struct mdoc *);
+static int      post_bl_tagwidth(struct mdoc *);
+static int      post_dd(struct mdoc *);
+static int      post_dt(struct mdoc *);
+static int      post_nm(struct mdoc *);
+static int      post_os(struct mdoc *);
+static int      post_sh(struct mdoc *);
+static int      post_ex(struct mdoc *);
+
+static int      post_prologue(struct mdoc *);

 
 /* Array of macro action routines. */
 
 
 /* Array of macro action routines. */
 


@@ -49,18 +66,18 @@ const       struct actions mdoc_actions[MDOC_MAX] = {
        { NULL }, /* Dl */
        { NULL }, /* Bd */ 
        { NULL }, /* Ed */
        { NULL }, /* Dl */
        { NULL }, /* Bd */ 
        { NULL }, /* Ed */

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

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

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

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

-       { NULL }, /* Ex */
+       { post_ex }, /* Ex */

        { NULL }, /* Fa */ 
        { NULL }, /* Fd */ 
        { NULL }, /* Fl */
        { NULL }, /* Fa */ 
        { NULL }, /* Fd */ 
        { NULL }, /* Fl */


@@ -144,26 +161,49 @@ const     struct actions mdoc_actions[MDOC_MAX] = {
        { NULL }, /* Hf */
        { NULL }, /* Fr */
        { NULL }, /* Ud */
        { NULL }, /* Hf */
        { NULL }, /* Fr */
        { NULL }, /* Ud */

+       { NULL }, /* Lb */

 };
 
 
 };
 
 

+static int
+post_ex(struct mdoc *mdoc)
+{
+
+       /*
+        * If `.Ex -std' is invoked without an argument, fill it in with
+        * our name (if it's been set).
+        */
+
+       if (0 == mdoc->last->data.elem.argc)
+               return(1);
+       if (mdoc->last->data.elem.argv[0].sz)
+               return(1);
+
+       assert(mdoc->meta.name);
+
+       mdoc_msg(mdoc, "writing %s argument: %s", 
+                       mdoc_argnames[MDOC_Std], mdoc->meta.name);
+
+       mdoc->last->data.elem.argv[0].sz = 1;
+       mdoc->last->data.elem.argv[0].value = xcalloc(1, sizeof(char *));
+       mdoc->last->data.elem.argv[0].value[0] = xstrdup(mdoc->meta.name);
+       return(1);
+}
+
+

 static int
 post_nm(struct mdoc *mdoc)
 {
        char             buf[64];
 
 static int
 post_nm(struct mdoc *mdoc)
 {
        char             buf[64];
 

-       assert(MDOC_ELEM == mdoc->last->type);
-       assert(MDOC_Nm == mdoc->last->tok);
-

        if (mdoc->meta.name)
                return(1);
 
        if (mdoc->meta.name)
                return(1);
 

-       if (xstrlcats(buf, mdoc->last->child, 64)) {
-               mdoc->meta.name = xstrdup(buf);
-               return(1);
-       }
+       (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
+       mdoc->meta.name = xstrdup(buf);
+       mdoc_msg(mdoc, "name: %s", mdoc->meta.name);

 
 

-       return(mdoc_err(mdoc, "macro parameters too long"));
+       return(1);

 }
 
 
 }
 
 


@@ -173,60 +213,143 @@ post_sh(struct mdoc *mdoc)
        enum mdoc_sec    sec;
        char             buf[64];
 
        enum mdoc_sec    sec;
        char             buf[64];
 

+       /*
+        * We keep track of the current section /and/ the "named"
+        * section, which is one of the conventional ones, in order to
+        * check ordering.
+        */
+

        if (MDOC_HEAD != mdoc->last->type)
                return(1);
        if (MDOC_HEAD != mdoc->last->type)
                return(1);

-       if (xstrlcats(buf, mdoc->last->child, 64)) {
-               if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
-                       mdoc->sec_lastn = sec;
-               mdoc->sec_last = sec;
-               return(1);
-       }

 
 

-       return(mdoc_err(mdoc, "macro parameters too long"));
+       (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
+       if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
+               mdoc->lastnamed = sec;
+
+       mdoc->lastsec = sec;
+
+       switch (mdoc->lastsec) {
+       case (SEC_RETURN_VALUES):
+               /* FALLTHROUGH */
+       case (SEC_ERRORS):
+               switch (mdoc->meta.msec) {
+               case (2):
+                       /* FALLTHROUGH */
+               case (3):
+                       /* FALLTHROUGH */
+               case (9):
+                       break;
+               default:
+                       return(mdoc_warn(mdoc, WARN_COMPAT,
+                                       "inappropriate section for "
+                                       "manual section"));
+               }
+               break;
+       default:
+               break;
+       }
+       return(1);

 }
 
 
 static int
 post_dt(struct mdoc *mdoc)
 {
 }
 
 
 static int
 post_dt(struct mdoc *mdoc)
 {

-       int               i;
-       char             *p;

        struct mdoc_node *n;
        struct mdoc_node *n;

+       const char       *cp;
+       char             *ep;
+       long              lval;
+
+       if (mdoc->meta.title)
+               free(mdoc->meta.title);
+       if (mdoc->meta.vol)
+               free(mdoc->meta.vol);
+       if (mdoc->meta.arch)
+               free(mdoc->meta.arch);
+
+       mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
+       mdoc->meta.msec = 0;
+
+       /* Handles: `.Dt' 
+        *   --> title = unknown, volume = local, msec = 0, arch = NULL
+        */
+
+       if (NULL == (n = mdoc->last->child)) {
+               mdoc->meta.title = xstrdup("unknown");
+               mdoc->meta.vol = xstrdup("local");
+               mdoc_msg(mdoc, "title: %s", mdoc->meta.title);
+               mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol);
+               mdoc_msg(mdoc, "arch: <unset>");
+               mdoc_msg(mdoc, "msec: <unset>");
+               return(post_prologue(mdoc));
+       }

 
 

-       assert(MDOC_ELEM == mdoc->last->type);
-       assert(MDOC_Dt == mdoc->last->tok);
+       /* Handles: `.Dt TITLE' 
+        *   --> title = TITLE, volume = local, msec = 0, arch = NULL
+        */

 
 

-       assert(NULL == mdoc->meta.title);
+       mdoc->meta.title = xstrdup(n->data.text.string);
+       mdoc_msg(mdoc, "title: %s", mdoc->meta.title);

 
 

-       for (i = 0, n = mdoc->last->child; n; n = n->next, i++) {
-               assert(MDOC_TEXT == n->type);
-               p = n->data.text.string;
+       if (NULL == (n = n->next)) {
+               mdoc->meta.vol = xstrdup("local");
+               mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol);
+               mdoc_msg(mdoc, "arch: <unset>");
+               mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec);
+               return(post_prologue(mdoc));
+       }

 
 

-               switch (i) {
-               case (0):
-                       mdoc->meta.title = xstrdup(p);
-                       break;
-               case (1):
-                       mdoc->meta.msec = mdoc_atomsec(p);
-                       if (MSEC_DEFAULT != mdoc->meta.msec)
-                               break;
-                       return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
-               case (2):
-                       mdoc->meta.vol = mdoc_atovol(p);
-                       if (VOL_DEFAULT != mdoc->meta.vol)
-                               break;
-                       mdoc->meta.arch = mdoc_atoarch(p);
-                       if (ARCH_DEFAULT != mdoc->meta.arch)
-                               break;
-                       return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
-               default:
-                       return(mdoc_nerr(mdoc, n, "too many parameters"));
-               }
+       /* Handles: `.Dt TITLE SEC'
+        *   --> title = TITLE, volume = SEC is msec ? 
+        *           format(msec) : SEC,
+        *       msec = SEC is msec ? atoi(msec) : 0,
+        *       arch = NULL
+        */
+
+       if ((cp = mdoc_a2msec(n->data.text.string))) {
+               mdoc->meta.vol = xstrdup(cp);
+               errno = 0;
+               lval = strtol(n->data.text.string, &ep, 10);
+               if (n->data.text.string[0] != '\0' && *ep == '\0')
+                       mdoc->meta.msec = (int)lval;
+       } else 
+               mdoc->meta.vol = xstrdup(n->data.text.string);
+
+       if (NULL == (n = n->next)) {
+               mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol);
+               mdoc_msg(mdoc, "arch: <unset>");
+               mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec);
+               return(post_prologue(mdoc));

        }
 
        }
 

-       if (NULL == mdoc->meta.title)
-               mdoc->meta.title = xstrdup("untitled");
-       return(1);
+       /* Handles: `.Dt TITLE SEC VOL'
+        *   --> title = TITLE, volume = VOL is vol ?
+        *       format(VOL) : 
+        *           VOL is arch ? format(arch) : 
+        *               VOL
+        */
+
+       if ((cp = mdoc_a2vol(n->data.text.string))) {
+               free(mdoc->meta.vol);
+               mdoc->meta.vol = xstrdup(cp);
+               n = n->next;
+       } else {
+               cp = mdoc_a2arch(n->data.text.string);
+               if (NULL == cp) {
+                       free(mdoc->meta.vol);
+                       mdoc->meta.vol = xstrdup(n->data.text.string);
+               } else
+                       mdoc->meta.arch = xstrdup(cp);
+       }       
+
+       mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol);
+       mdoc_msg(mdoc, "arch: %s", mdoc->meta.arch ?
+                       mdoc->meta.arch : "<unset>");
+       mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec);
+
+       /* Ignore any subsequent parameters... */
+
+       return(post_prologue(mdoc));

 }
 
 
 }
 
 


@@ -234,63 +357,241 @@ static int
 post_os(struct mdoc *mdoc)
 {
        char              buf[64];
 post_os(struct mdoc *mdoc)
 {
        char              buf[64];

+       struct utsname    utsname;
+
+       if (mdoc->meta.os)
+               free(mdoc->meta.os);
+
+       (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
+
+       if (0 == buf[0]) {
+               if (-1 == uname(&utsname))
+                       return(mdoc_err(mdoc, "utsname"));
+               (void)xstrlcpy(buf, utsname.sysname, sizeof(buf));
+               (void)xstrlcat(buf, " ", sizeof(buf));
+               (void)xstrlcat(buf, utsname.release, sizeof(buf));
+       }
+
+       mdoc->meta.os = xstrdup(buf);
+       mdoc_msg(mdoc, "system: %s", mdoc->meta.os);
+
+       mdoc->lastnamed = mdoc->lastsec = SEC_BODY;
+
+       return(post_prologue(mdoc));
+}
+
+
+static int
+post_bl_tagwidth(struct mdoc *mdoc)
+{
+       struct mdoc_node  *n;
+       struct mdoc_block *b;
+       int                sz;
+       char               buf[32];
+
+       /*
+        * If -tag has been specified and -width has not been, then try
+        * to intuit our width from the first body element.  
+        */
+
+       b = &mdoc->last->data.block;

 
 

-       assert(MDOC_ELEM == mdoc->last->type);
-       assert(MDOC_Os == mdoc->last->tok);
-       assert(NULL == mdoc->meta.os);
+       if (NULL == (n = b->body->child))
+               return(1);
+       assert(MDOC_It == n->tok);
+
+       /*
+        * Use the text width, if a text node, or the default macro
+        * width if a macro.
+        */
+
+       if ((n = n->data.block.head->child)) {
+               if (MDOC_TEXT != n->type) {
+                       if (0 == (sz = mdoc_macro2len(n->tok)))
+                               sz = -1;
+               } else
+                       sz = (int)strlen(n->data.text.string) + 1;
+       } else
+               sz = -1;
+
+       if (-1 == sz) {
+               if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+                               "cannot determine default %s",
+                               mdoc_argnames[MDOC_Width]))
+                       return(0);
+               sz = 10;
+       }
+
+       (void)snprintf(buf, sizeof(buf), "%dn", sz);
+
+       /*
+        * We have to dynamically add this to the macro's argument list.
+        * We're guaranteed that a MDOC_Width doesn't already exist.
+        */

 
 

-       if ( ! xstrlcats(buf, mdoc->last->child, 64))
-               return(mdoc_err(mdoc, "macro parameters too long")); 
+       (b->argc)++;
+       b->argv = xrealloc(b->argv, b->argc * sizeof(struct mdoc_arg));
+
+       b->argv[b->argc - 1].arg = MDOC_Width;
+       b->argv[b->argc - 1].line = mdoc->last->line;
+       b->argv[b->argc - 1].pos = mdoc->last->pos;
+       b->argv[b->argc - 1].sz = 1;
+       b->argv[b->argc - 1].value = xcalloc(1, sizeof(char *));
+       b->argv[b->argc - 1].value[0] = xstrdup(buf);
+
+       mdoc_msg(mdoc, "adding %s argument: %dn", 
+                       mdoc_argnames[MDOC_Width], sz);

 
 

-       mdoc->meta.os = xstrdup(buf[0] ? buf : "local");
-       mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;

        return(1);
 }
 
 
 static int
        return(1);
 }
 
 
 static int

-post_dd(struct mdoc *mdoc)
+post_bl_width(struct mdoc *mdoc)

 {
 {

-       char              date[64];
-       size_t            sz;
-       char             *p;
-       struct mdoc_node *n;
+       size_t            width;
+       int               i, tok;
+       char              buf[32];
+       char            **p;

 
 

-       assert(MDOC_ELEM == mdoc->last->type);
-       assert(MDOC_Dd == mdoc->last->tok);
+       for (i = 0; i < (int)mdoc->last->data.block.argc; i++) 
+               if (MDOC_Width == mdoc->last->data.block.argv[i].arg)
+                       break;

 
 

-       n = mdoc->last->child; 
-       assert(0 == mdoc->meta.date);
-       date[0] = 0;
+       assert(i < (int)mdoc->last->data.block.argc);
+       assert(1 == mdoc->last->data.block.argv[i].sz);
+       p = &mdoc->last->data.block.argv[i].value[0];

 
 

-       sz = 64;
+       /*
+        * 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.
+        */

 
 

-       for ( ; 0 == mdoc->meta.date && n; n = n->next) {
-               assert(MDOC_TEXT == n->type);
-               p = n->data.text.string;
+       if (xstrcmp(*p, "Ds"))
+               width = 8;
+       else if (MDOC_MAX == (tok = mdoc_find(mdoc, *p)))
+               return(1);
+       else if (0 == (width = mdoc_macro2len(tok))) 
+               return(mdoc_warn(mdoc, WARN_SYNTAX,
+                                       "%s macro has no length", 
+                                       mdoc_argnames[MDOC_Width]));

 
 

-               if (xstrcmp(p, "$Mdocdate: January 19 2009 $")) {
-                       mdoc->meta.date = time(NULL);
-                       continue;
-               } else if (xstrcmp(p, "$")) {
-                       mdoc->meta.date = mdoc_atotime(date);
-                       continue;
-               } else if (xstrcmp(p, "$Mdocdate:"))
-                       continue;
+       mdoc_msg(mdoc, "re-writing %s argument: %s -> %zun", 
+                       mdoc_argnames[MDOC_Width], *p, width);

 
 

-               if ( ! xstrlcat(date, n->data.text.string, sz))
-                       return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
-               if (n->next && ! xstrlcat(date, " ", sz))
-                       return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
-       }
+       /* The value already exists: free and reallocate it. */

 
 

-       if (mdoc->meta.date && NULL == n)
+       (void)snprintf(buf, sizeof(buf), "%zun", width);
+
+       free(*p);
+       *p = strdup(buf);
+
+       return(1);
+}
+
+
+static int
+post_bl(struct mdoc *mdoc)
+{
+       int               i, r;
+
+       if (MDOC_BLOCK != mdoc->last->type)

                return(1);
                return(1);

-       else if (n)
-               return(mdoc_err(mdoc, "invalid parameter syntax"));
-       if ((mdoc->meta.date = mdoc_atotime(date)))
+
+       /*
+        * These are fairly complicated, so we've broken them into two
+        * functions.  post_bl_tagwidth() is called when a -tag is
+        * specified, but no -width (it must be guessed).  The second
+        * when a -width is specified (macro indicators must be
+        * rewritten into real lengths).
+        */
+
+       for (r = i = 0; i < (int)mdoc->last->data.block.argc; i++) {
+               if (MDOC_Tag == mdoc->last->data.block.argv[i].arg)
+                       r |= 1 << 0;
+               if (MDOC_Width == mdoc->last->data.block.argv[i].arg)
+                       r |= 1 << 1;
+       }
+
+       if (r & (1 << 0) && ! (r & (1 << 1))) {
+               if ( ! post_bl_tagwidth(mdoc))
+                       return(0);
+       } else if (r & (1 << 1))
+               if ( ! post_bl_width(mdoc))
+                       return(0);
+
+       return(1);
+}
+
+
+static int
+post_ar(struct mdoc *mdoc)
+{
+       struct mdoc_node *n;
+
+       if (mdoc->last->child)

                return(1);
                return(1);

-       return(mdoc_err(mdoc, "invalid parameter syntax"));
+       
+       n = mdoc->last;
+
+       mdoc->next = MDOC_NEXT_CHILD;
+       if ( ! mdoc_word_alloc(mdoc, mdoc->last->line,
+                               mdoc->last->pos, "file"))
+               return(0);
+       mdoc->next = MDOC_NEXT_SIBLING;
+       if ( ! mdoc_word_alloc(mdoc, mdoc->last->line, 
+                               mdoc->last->pos, "..."))
+               return(0);
+
+       mdoc->last = n;
+       mdoc->next = MDOC_NEXT_SIBLING;
+       return(1);
+}
+
+
+static int
+post_dd(struct mdoc *mdoc)
+{
+       char              buf[64];
+
+       (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
+
+       if (0 == (mdoc->meta.date = mdoc_atotime(buf)))
+               return(mdoc_err(mdoc, "invalid date syntax"));
+
+       mdoc_msg(mdoc, "date: %u", mdoc->meta.date);
+       return(post_prologue(mdoc));
+}
+
+
+static int
+post_prologue(struct mdoc *mdoc)
+{
+       struct mdoc_node *n;
+
+       /* 
+        * The end document shouldn't have the prologue macros as part
+        * of the syntax tree (they encompass only meta-data).  
+        */
+
+       if (mdoc->last->parent->child == mdoc->last)
+               mdoc->last->parent->child = mdoc->last->prev;
+       if (mdoc->last->prev)
+               mdoc->last->prev->next = NULL;
+
+       n = mdoc->last;
+       assert(NULL == mdoc->last->next);
+
+       if (mdoc->last->prev) {
+               mdoc->last = mdoc->last->prev;
+               mdoc->next = MDOC_NEXT_SIBLING;
+       } else {
+               mdoc->last = mdoc->last->parent;
+               mdoc->next = MDOC_NEXT_CHILD;
+       }
+
+       mdoc_node_freelist(n);
+       return(1);

 }
 
 
 }