[BACK]Return to action.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/action.c between version 1.14 and 1.34

version 1.14, 2009/01/20 13:44:05 version 1.34, 2009/03/08 12:40:27
Line 16 
Line 16 
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.   * 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 <time.h>
   
 #include "private.h"  #include "private.h"
Line 28 
Line 33 
  * children have been filled in (post-fix order).   * children have been filled in (post-fix order).
  */   */
   
   enum    merr {
           ENOWIDTH
   };
   
   enum    mwarn {
           WBADSEC,
           WNOWIDTH,
           WBADDATE
   };
   
 struct  actions {  struct  actions {
         int     (*post)(struct mdoc *);          int     (*post)(struct mdoc *);
 };  };
   
 /* Per-macro action routines. */  static  int      nwarn(struct mdoc *,
                           const struct mdoc_node *, enum mwarn);
 static  int      post_sh(struct mdoc *);  static  int      nerr(struct mdoc *,
 static  int      post_os(struct mdoc *);                          const struct mdoc_node *, enum merr);
 static  int      post_dt(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_dd(struct mdoc *);
   static  int      post_dt(struct mdoc *);
 static  int      post_nm(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 *);  static  int      post_prologue(struct mdoc *);
   
 /* Array of macro action routines. */  
   
 const   struct actions mdoc_actions[MDOC_MAX] = {  const   struct actions mdoc_actions[MDOC_MAX] = {
         { NULL }, /* \" */          { NULL }, /* \" */
         { post_dd }, /* Dd */          { post_dd }, /* Dd */
Line 56  const struct actions mdoc_actions[MDOC_MAX] = {
Line 75  const struct actions mdoc_actions[MDOC_MAX] = {
         { NULL }, /* Dl */          { NULL }, /* Dl */
         { NULL }, /* Bd */          { NULL }, /* Bd */
         { NULL }, /* Ed */          { NULL }, /* Ed */
         { NULL }, /* Bl */          { post_bl }, /* Bl */
         { NULL }, /* El */          { NULL }, /* El */
         { NULL }, /* It */          { NULL }, /* It */
         { NULL }, /* Ad */          { NULL }, /* Ad */
         { NULL }, /* An */          { NULL }, /* An */
         { NULL }, /* Ar */          { post_ar }, /* Ar */
         { NULL }, /* Cd */          { NULL }, /* Cd */
         { NULL }, /* Cm */          { NULL }, /* Cm */
         { NULL }, /* Dv */          { NULL }, /* Dv */
         { NULL }, /* Er */          { NULL }, /* Er */
         { NULL }, /* Ev */          { NULL }, /* Ev */
         { NULL }, /* Ex */          { post_ex }, /* Ex */
         { NULL }, /* Fa */          { NULL }, /* Fa */
         { NULL }, /* Fd */          { NULL }, /* Fd */
         { NULL }, /* Fl */          { NULL }, /* Fl */
Line 151  const struct actions mdoc_actions[MDOC_MAX] = {
Line 170  const struct actions mdoc_actions[MDOC_MAX] = {
         { NULL }, /* Hf */          { NULL }, /* Hf */
         { NULL }, /* Fr */          { NULL }, /* Fr */
         { NULL }, /* Ud */          { NULL }, /* Ud */
           { NULL }, /* Lb */
 };  };
   
   
 /*  #define merr(m, t) nerr((m), (m)->last, (t))
  * The `Nm' macro sets the document's name when used the first time with  
  * an argument.  Subsequent calls without a value will result in the  
  * name value being used.  
  */  
 static int  static int
   nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type)
   {
           char            *p;
   
           p = NULL;
   
           switch (type) {
           case (ENOWIDTH):
                   p = "missing width argument";
                   break;
           }
   
           assert(p);
           return(mdoc_nerr(m, n, p));
   }
   
   
   #define mwarn(m, t) nwarn((m), (m)->last, (t))
   static int
   nwarn(struct mdoc *m, const struct mdoc_node *n, 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_nwarn(m, n, c, p));
   }
   
   
   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 (NULL == mdoc->last->args)
                   return(1);
           if (mdoc->last->args->argv[0].sz)
                   return(1);
   
           assert(mdoc->meta.name);
   
           mdoc_msg(mdoc, "writing %s argument: %s",
                           mdoc_argnames[MDOC_Std],
                           mdoc->meta.name);
   
           assert(1 == mdoc->last->args->argv[0].sz);
   
           mdoc->last->args->argv[0].sz = 1;
           mdoc->last->args->argv[0].value = xcalloc(1, sizeof(char *));
           mdoc->last->args->argv[0].value[0] = xstrdup(mdoc->meta.name);
           return(1);
   }
   
   
   static int
 post_nm(struct mdoc *mdoc)  post_nm(struct mdoc *mdoc)
 {  {
         char             buf[64];          char             buf[64];
   
         assert(MDOC_ELEM == mdoc->last->type);  
         assert(MDOC_Nm == mdoc->last->tok);  
   
         if (mdoc->meta.name)          if (mdoc->meta.name)
                 return(1);                  return(1);
   
         if (xstrlcats(buf, mdoc->last->child, 64)) {          (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
                 mdoc->meta.name = xstrdup(buf);          mdoc->meta.name = xstrdup(buf);
                 return(1);          mdoc_msg(mdoc, "name: %s", mdoc->meta.name);
         }  
   
         return(mdoc_err(mdoc, "macro parameters too long"));          return(1);
 }  }
   
   
 /*  
  * We keep track of the current section in order to provide warnings on  
  * section ordering, per-section macros, and so on.  
  */  
 static int  static int
 post_sh(struct mdoc *mdoc)  post_sh(struct mdoc *mdoc)
 {  {
         enum mdoc_sec    sec;          enum mdoc_sec    sec;
         char             buf[64];          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)          if (MDOC_HEAD != mdoc->last->type)
                 return(1);                  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(mwarn(mdoc, WBADSEC));
                   }
                   break;
           default:
                   break;
           }
           return(1);
 }  }
   
   
 /*  
  * Prologue title must be parsed into document meta-data.  
  */  
 static int  static int
 post_dt(struct mdoc *mdoc)  post_dt(struct mdoc *mdoc)
 {  {
         int               i;  
         char             *p;  
         struct mdoc_node *n;          struct mdoc_node *n;
           const char       *cp;
           char             *ep;
           long              lval;
   
         assert(MDOC_ELEM == mdoc->last->type);          if (mdoc->meta.title)
         assert(MDOC_Dt == mdoc->last->tok);                  free(mdoc->meta.title);
           if (mdoc->meta.vol)
                   free(mdoc->meta.vol);
           if (mdoc->meta.arch)
                   free(mdoc->meta.arch);
   
         assert(NULL == mdoc->meta.title);          mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
           mdoc->meta.msec = 0;
   
         for (i = 0, n = mdoc->last->child; n; n = n->next, i++) {          /* Handles: `.Dt'
                 assert(MDOC_TEXT == n->type);           *   --> title = unknown, volume = local, msec = 0, arch = NULL
                 p = n->data.text.string;           */
   
                 switch (i) {          if (NULL == (n = mdoc->last->child)) {
                 case (0):                  mdoc->meta.title = xstrdup("unknown");
                         mdoc->meta.title = xstrdup(p);                  mdoc->meta.vol = xstrdup("local");
                         break;                  mdoc_msg(mdoc, "title: %s", mdoc->meta.title);
                 case (1):                  mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol);
                         mdoc->meta.msec = mdoc_atomsec(p);                  mdoc_msg(mdoc, "arch: <unset>");
                         if (MSEC_DEFAULT != mdoc->meta.msec)                  mdoc_msg(mdoc, "msec: <unset>");
                                 break;                  return(post_prologue(mdoc));
                         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"));  
                 }  
         }          }
   
         if (NULL == mdoc->meta.title)          /* Handles: `.Dt TITLE'
                 mdoc->meta.title = xstrdup("untitled");           *   --> title = TITLE, volume = local, msec = 0, arch = NULL
            */
   
           mdoc->meta.title = xstrdup(n->string);
           mdoc_msg(mdoc, "title: %s", mdoc->meta.title);
   
           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));
           }
   
           /* 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->string))) {
                   mdoc->meta.vol = xstrdup(cp);
                   errno = 0;
                   lval = strtol(n->string, &ep, 10);
                   if (n->string[0] != '\0' && *ep == '\0')
                           mdoc->meta.msec = (int)lval;
           } else
                   mdoc->meta.vol = xstrdup(n->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));
           }
   
           /* Handles: `.Dt TITLE SEC VOL'
            *   --> title = TITLE, volume = VOL is vol ?
            *       format(VOL) :
            *           VOL is arch ? format(arch) :
            *               VOL
            */
   
           if ((cp = mdoc_a2vol(n->string))) {
                   free(mdoc->meta.vol);
                   mdoc->meta.vol = xstrdup(cp);
                   n = n->next;
           } else {
                   cp = mdoc_a2arch(n->string);
                   if (NULL == cp) {
                           free(mdoc->meta.vol);
                           mdoc->meta.vol = xstrdup(n->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));          return(post_prologue(mdoc));
 }  }
   
   
 /*  
  * Prologue operating system must be parsed into document meta-data.  
  */  
 static int  static int
 post_os(struct mdoc *mdoc)  post_os(struct mdoc *mdoc)
 {  {
         char              buf[64];          char              buf[64];
           struct utsname    utsname;
   
         assert(MDOC_ELEM == mdoc->last->type);          if (mdoc->meta.os)
         assert(MDOC_Os == mdoc->last->tok);                  free(mdoc->meta.os);
         assert(NULL == mdoc->meta.os);  
   
         if ( ! xstrlcats(buf, mdoc->last->child, 64))          (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
                 return(mdoc_err(mdoc, "macro parameters too long"));  
   
         mdoc->meta.os = xstrdup(buf[0] ? buf : "local");          if (0 == buf[0]) {
         mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;                  if (-1 == uname(&utsname))
         mdoc->flags |= MDOC_BODYPARSE;                          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));          return(post_prologue(mdoc));
 }  }
   
   
 /*  
  * Prologue date must be parsed into document meta-data.  
  */  
 static int  static int
 post_dd(struct mdoc *mdoc)  post_bl_tagwidth(struct mdoc *mdoc)
 {  {
         char              date[64];          struct mdoc_node  *n;
         size_t            sz;          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.
            */
   
           if (NULL == (n = mdoc->last->body->child))
                   return(1);
   
           /*
            * Use the text width, if a text node, or the default macro
            * width if a macro.
            */
   
           if ((n = n->head->child)) {
                   if (MDOC_TEXT != n->type) {
                           if (0 == (sz = (int)mdoc_macro2len(n->tok)))
                                   sz = -1;
                   } else
                           sz = (int)strlen(n->string) + 1;
           } else
                   sz = -1;
   
           if (-1 == sz) {
                   if ( ! mwarn(mdoc, WNOWIDTH))
                           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 (NULL == mdoc->last->args) {
                   mdoc->last->args = xcalloc
                           (1, sizeof(struct mdoc_arg));
                   mdoc->last->args->refcnt = 1;
           }
   
           n = mdoc->last;
           sz = (int)n->args->argc;
   
           (n->args->argc)++;
   
           n->args->argv = xrealloc(n->args->argv,
                           n->args->argc * sizeof(struct mdoc_arg));
   
           n->args->argv[sz - 1].arg = MDOC_Width;
           n->args->argv[sz - 1].line = mdoc->last->line;
           n->args->argv[sz - 1].pos = mdoc->last->pos;
           n->args->argv[sz - 1].sz = 1;
           n->args->argv[sz - 1].value = xcalloc(1, sizeof(char *));
           n->args->argv[sz - 1].value[0] = xstrdup(buf);
   
           mdoc_msg(mdoc, "adding %s argument: %s",
                           mdoc_argnames[MDOC_Width], buf);
   
           return(1);
   }
   
   
   static int
   post_bl_width(struct mdoc *m)
   {
           size_t            width;
           int               i, tok;
           char              buf[32];
         char             *p;          char             *p;
   
           if (NULL == m->last->args)
                   return(merr(m, ENOWIDTH));
   
           for (i = 0; i < (int)m->last->args->argc; i++)
                   if (MDOC_Width == m->last->args->argv[i].arg)
                           break;
   
           if (i == (int)m->last->args->argc)
                   return(merr(m, ENOWIDTH));
   
           p = m->last->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 (xstrcmp(p, "Ds"))
                   width = 8;
           else if (MDOC_MAX == (tok = mdoc_tokhash_find(m->htab, p)))
                   return(1);
           else if (0 == (width = mdoc_macro2len(tok)))
                   return(mwarn(m, WNOWIDTH));
   
           mdoc_msg(m, "re-writing %s argument: %s -> %zun",
                           mdoc_argnames[MDOC_Width], p, width);
   
           /* The value already exists: free and reallocate it. */
   
           (void)snprintf(buf, sizeof(buf), "%zun", width);
   
           free(m->last->args->argv[i].value[0]);
           m->last->args->argv[i].value[0] = xstrdup(buf);
   
           return(1);
   }
   
   
   static int
   post_bl(struct mdoc *mdoc)
   {
           int               i, r, len;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           /*
            * 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).
            */
   
           len = (int)(mdoc->last->args ? mdoc->last->args->argc : 0);
   
           for (r = i = 0; i < len; i++) {
                   if (MDOC_Tag == mdoc->last->args->argv[i].arg)
                           r |= 1 << 0;
                   if (MDOC_Width == mdoc->last->args->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;          struct mdoc_node *n;
   
         assert(MDOC_ELEM == mdoc->last->type);          if (mdoc->last->child)
         assert(MDOC_Dd == mdoc->last->tok);                  return(1);
   
           n = mdoc->last;
   
         n = mdoc->last->child;          mdoc->next = MDOC_NEXT_CHILD;
         assert(0 == mdoc->meta.date);          if ( ! mdoc_word_alloc(mdoc, mdoc->last->line,
         date[0] = 0;                                  mdoc->last->pos, "file"))
                   return(0);
           mdoc->next = MDOC_NEXT_SIBLING;
           if ( ! mdoc_word_alloc(mdoc, mdoc->last->line,
                                   mdoc->last->pos, "..."))
                   return(0);
   
         sz = 64;          mdoc->last = n;
           mdoc->next = MDOC_NEXT_SIBLING;
           return(1);
   }
   
         for ( ; 0 == mdoc->meta.date && n; n = n->next) {  
                 assert(MDOC_TEXT == n->type);  
                 p = n->data.text.string;  
   
                 if (xstrcmp(p, "$Mdocdate$")) {  static int
                         mdoc->meta.date = time(NULL);  post_dd(struct mdoc *mdoc)
                         continue;  {
                 } else if (xstrcmp(p, "$")) {          char              buf[64];
                         mdoc->meta.date = mdoc_atotime(date);  
                         continue;  
                 } else if (xstrcmp(p, "$Mdocdate:"))  
                         continue;  
   
                 if ( ! xstrlcat(date, n->data.text.string, sz))          (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
                         return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));  
                 if (n->next && ! xstrlcat(date, " ", sz))          if (0 == (mdoc->meta.date = mdoc_atotime(buf))) {
                         return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));                  if ( ! mwarn(mdoc, WBADDATE))
                           return(0);
                   mdoc->meta.date = time(NULL);
         }          }
   
         if (mdoc->meta.date && NULL == n)          mdoc_msg(mdoc, "date: %u", mdoc->meta.date);
                 return(post_prologue(mdoc));          return(post_prologue(mdoc));
         else if (n)  
                 return(mdoc_err(mdoc, "invalid parameter syntax"));  
         if ((mdoc->meta.date = mdoc_atotime(date)))  
                 return(post_prologue(mdoc));  
         return(mdoc_err(mdoc, "invalid parameter syntax"));  
 }  }
   
   
 /*  
  * The end document shouldn't have the prologue macros as part of the  
  * syntax tree (they encompass only meta-data).  
  */  
 static int  static int
 post_prologue(struct mdoc *mdoc)  post_prologue(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          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)          if (mdoc->last->parent->child == mdoc->last)
                 mdoc->last->parent->child = mdoc->last->prev;                  mdoc->last->parent->child = mdoc->last->prev;
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.34
CVSweb