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

Diff for /mandoc/roff.c between version 1.58 and 1.107

version 1.58, 2008/12/10 10:43:57 version 1.107, 2010/12/06 13:25:25
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
 #include <sys/param.h>  #ifdef HAVE_CONFIG_H
 #include <sys/types.h>  #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
   #include <errno.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  #include <limits.h>
 #include <stdarg.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <stdio.h>
   
 #include "private.h"  #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   #include "libmandoc.h"
   
 /* FIXME: First letters of quoted-text interpreted in rofffindtok. */  #define RSTACK_MAX      128
 /* FIXME: `No' not implemented. */  
 /* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  
 /* TODO: warn about empty lists. */  
 /* TODO: (warn) some sections need specific elements. */  
 /* TODO: (warn) NAME section has particular order. */  
 /* TODO: macros with a set number of arguments? */  
 /* TODO: validate Dt macro arguments. */  
 /* FIXME: Bl -diag supposed to ignore callable children. */  
   
 struct  roffnode {  #define ROFF_CTL(c) \
         int               tok;          /* Token id. */          ('.' == (c) || '\'' == (c))
         struct roffnode  *parent;       /* Parent (or NULL). */  
   #if 1
   #define ROFF_DEBUG(fmt, args...) \
           do { /* Nothing. */ } while (/*CONSTCOND*/ 0)
   #else
   #define ROFF_DEBUG(fmt, args...) \
           do { fprintf(stderr, fmt , ##args); } while (/*CONSTCOND*/ 0)
   #endif
   
   enum    rofft {
           ROFF_ad,
           ROFF_am,
           ROFF_ami,
           ROFF_am1,
           ROFF_de,
           ROFF_dei,
           ROFF_de1,
           ROFF_ds,
           ROFF_el,
           ROFF_hy,
           ROFF_ie,
           ROFF_if,
           ROFF_ig,
           ROFF_ne,
           ROFF_nh,
           ROFF_nr,
           ROFF_rm,
           ROFF_so,
           ROFF_tr,
           ROFF_cblock,
           ROFF_ccond, /* FIXME: remove this. */
           ROFF_USERDEF,
           ROFF_MAX
 };  };
   
 enum    rofferr {  enum    roffrule {
         ERR_ARGEQ1,                     /* Macro requires arg == 1. */          ROFFRULE_ALLOW,
         ERR_ARGEQ0,                     /* Macro requires arg == 0. */          ROFFRULE_DENY
         ERR_ARGGE1,                     /* Macro requires arg >= 1. */  
         ERR_ARGGE2,                     /* Macro requires arg >= 2. */  
         ERR_ARGLEN,                     /* Macro argument too long. */  
         ERR_BADARG,                     /* Macro has bad arg. */  
         ERR_ARGMNY,                     /* Too many macro arguments. */  
         ERR_NOTSUP,                     /* Macro not supported. */  
         ERR_DEPREC,                     /* Macro deprecated. */  
         ERR_PR_OOO,                     /* Prelude macro bad order. */  
         ERR_PR_REP,                     /* Prelude macro repeated. */  
         ERR_NOT_PR,                     /* Not allowed in prelude. */  
         WRN_SECORD,                     /* Sections out-of-order. */  
 };  };
   
 struct  rofftree {  
         struct roffnode  *last;                 /* Last parsed node. */  struct  roffstr {
         char             *cur;                  /* Line start. */          char            *name; /* key of symbol */
         struct tm         tm;                   /* `Dd' results. */          char            *string; /* current value */
         char              name[64];             /* `Nm' results. */          struct roffstr  *next; /* next in list */
         char              os[64];               /* `Os' results. */  
         char              title[64];            /* `Dt' results. */  
         enum roffmsec     section;  
         enum roffvol      volume;  
         int               state;  
 #define ROFF_PRELUDE     (1 << 1)               /* In roff prelude. */ /* FIXME: put into asec. */  
 #define ROFF_PRELUDE_Os  (1 << 2)               /* `Os' is parsed. */  
 #define ROFF_PRELUDE_Dt  (1 << 3)               /* `Dt' is parsed. */  
 #define ROFF_PRELUDE_Dd  (1 << 4)               /* `Dd' is parsed. */  
 #define ROFF_BODY        (1 << 5)               /* In roff body. */  
         struct roffcb     cb;                   /* Callbacks. */  
         void             *arg;                  /* Callbacks' arg. */  
         int               csec;                 /* Current section. */  
         int               asec;                 /* Thus-far sections. */  
 };  };
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  struct  roff {
 static  void              roffnode_free(struct rofftree *);          struct roffnode *last; /* leaf of stack */
 static  int               roff_warn(const struct rofftree *,          mandocmsg        msg; /* err/warn/fatal messages */
                                 const char *, char *, ...);          void            *data; /* privdata for messages */
 static  int               roff_warnp(const struct rofftree *,          enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
                                 const char *, int, enum rofferr);          int              rstackpos; /* position in rstack */
 static  int               roff_err(const struct rofftree *,          struct regset   *regs; /* read/writable registers */
                                 const char *, char *, ...);          struct roffstr  *first_string; /* user-defined strings & macros */
 static  int               roff_errp(const struct rofftree *,          const char      *current_string; /* value of last called user macro */
                                 const char *, int, enum rofferr);  };
 static  int               roffpurgepunct(struct rofftree *, char **);  
 static  int               roffscan(int, const int *);  
 static  int               rofffindtok(const char *);  
 static  int               rofffindarg(const char *);  
 static  int               rofffindcallable(const char *);  
 static  int               roffispunct(const char *);  
 static  int               roffchecksec(struct rofftree *,  
                                 const char *, int);  
 static  int               roffargs(const struct rofftree *,  
                                 int, char *, char **);  
 static  int               roffargok(int, int);  
 static  int               roffnextopt(const struct rofftree *,  
                                 int, char ***, char **);  
 static  int               roffparseopts(struct rofftree *, int,  
                                 char ***, int *, char **);  
 static  int               roffcall(struct rofftree *, int, char **);  
 static  int               roffexit(struct rofftree *, int);  
 static  int               roffparse(struct rofftree *, char *);  
 static  int               textparse(struct rofftree *, char *);  
 static  int               roffdata(struct rofftree *, int, char *);  
 static  int               roffspecial(struct rofftree *, int,  
                                 const char *, const int *,  
                                 const char **, size_t, char **);  
 static  int               roffsetname(struct rofftree *, char **);  
   
 #ifdef __linux__  struct  roffnode {
 extern  size_t            strlcat(char *, const char *, size_t);          enum rofft       tok; /* type of node */
 extern  size_t            strlcpy(char *, const char *, size_t);          struct roffnode *parent; /* up one in stack */
 extern  int               vsnprintf(char *, size_t,          int              line; /* parse line */
                                 const char *, va_list);          int              col; /* parse col */
 extern  char             *strptime(const char *, const char *,          char            *name; /* node name, e.g. macro name */
                                 struct tm *);          char            *end; /* end-rules: custom token */
 #endif          int              endspan; /* end-rules: next-line or infty */
           enum roffrule    rule; /* current evaluation rule */
   };
   
 int  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
 roff_free(struct rofftree *tree, int flush)                           enum rofft tok, /* tok of macro */ \
 {                           char **bufp, /* input buffer */ \
         int              error, t;                           size_t *szp, /* size of input buffer */ \
         struct roffnode *n;                           int ln, /* parse line */ \
                            int ppos, /* original pos in buffer */ \
                            int pos, /* current pos in buffer */ \
                            int *offs /* reset offset of buffer data */
   
         error = 0;  typedef enum rofferr (*roffproc)(ROFF_ARGS);
   
         if ( ! flush)  struct  roffmac {
                 goto end;          const char      *name; /* macro name */
           roffproc         proc; /* process new macro */
           roffproc         text; /* process as child text of macro */
           roffproc         sub; /* process as child of macro */
           int              flags;
   #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
           struct roffmac  *next;
   };
   
         error = 1;  static  enum rofferr     roff_block(ROFF_ARGS);
   static  enum rofferr     roff_block_text(ROFF_ARGS);
   static  enum rofferr     roff_block_sub(ROFF_ARGS);
   static  enum rofferr     roff_cblock(ROFF_ARGS);
   static  enum rofferr     roff_ccond(ROFF_ARGS);
   static  enum rofferr     roff_cond(ROFF_ARGS);
   static  enum rofferr     roff_cond_text(ROFF_ARGS);
   static  enum rofferr     roff_cond_sub(ROFF_ARGS);
   static  enum rofferr     roff_ds(ROFF_ARGS);
   static  enum roffrule    roff_evalcond(const char *, int *);
   static  void             roff_freestr(struct roff *);
   static  const char      *roff_getstrn(const struct roff *,
                                   const char *, size_t);
   static  enum rofferr     roff_line_ignore(ROFF_ARGS);
   static  enum rofferr     roff_line_error(ROFF_ARGS);
   static  enum rofferr     roff_nr(ROFF_ARGS);
   static  int              roff_res(struct roff *,
                                   char **, size_t *, int);
   static  void             roff_setstr(struct roff *,
                                   const char *, const char *, int);
   static  enum rofferr     roff_so(ROFF_ARGS);
   static  enum rofferr     roff_userdef(ROFF_ARGS);
   
         if (ROFF_PRELUDE & tree->state) {  /* See roff_hash_find() */
                 (void)roff_err(tree, NULL, "prelude never finished");  
                 goto end;  
         } else if ( ! (ROFFSec_NAME & tree->asec)) {  
                 (void)roff_err(tree, NULL, "missing `NAME' section");  
                 goto end;  
         } else if ( ! (ROFFSec_NMASK & tree->asec))  
                 (void)roff_warn(tree, NULL, "missing suggested `NAME', "  
                                 "`SYNOPSIS', `DESCRIPTION' sections");  
   
         for (n = tree->last; n; n = n->parent) {  #define ASCII_HI         126
                 if (0 != tokens[n->tok].ctx)  #define ASCII_LO         33
                         continue;  #define HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
                 (void)roff_err(tree, NULL, "closing explicit scope "  
                                 "`%s'", toknames[n->tok]);  
                 goto end;  
         }  
   
         while (tree->last) {  static  struct roffmac  *hash[HASHWIDTH];
                 t = tree->last->tok;  
                 if ( ! roffexit(tree, t))  
                         goto end;  
         }  
   
         if ( ! (*tree->cb.rofftail)(tree->arg))  static  struct roffmac   roffs[ROFF_MAX] = {
                 goto end;          { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
           { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "ds", roff_ds, NULL, NULL, 0, NULL },
           { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
           { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
           { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
           { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
           { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "ne", roff_line_ignore, NULL, NULL, 0, NULL },
           { "nh", roff_line_ignore, NULL, NULL, 0, NULL },
           { "nr", roff_nr, NULL, NULL, 0, NULL },
           { "rm", roff_line_error, NULL, NULL, 0, NULL },
           { "so", roff_so, NULL, NULL, 0, NULL },
           { "tr", roff_line_ignore, NULL, NULL, 0, NULL },
           { ".", roff_cblock, NULL, NULL, 0, NULL },
           { "\\}", roff_ccond, NULL, NULL, 0, NULL },
           { NULL, roff_userdef, NULL, NULL, 0, NULL },
   };
   
         error = 0;  static  void             roff_free1(struct roff *);
   static  enum rofft       roff_hash_find(const char *, size_t);
   static  void             roff_hash_init(void);
   static  void             roffnode_cleanscope(struct roff *);
   static  void             roffnode_push(struct roff *, enum rofft,
                                   const char *, int, int);
   static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(struct roff *, const char *, int *);
   static  int              roff_parse_nat(const char *, unsigned int *);
   
 end:  /* See roff_hash_find() */
   #define ROFF_HASH(p)    (p[0] - ASCII_LO)
   
         while (tree->last)  static void
                 roffnode_free(tree);  roff_hash_init(void)
   {
           struct roffmac   *n;
           int               buc, i;
   
         free(tree);          for (i = 0; i < (int)ROFF_USERDEF; i++) {
                   assert(roffs[i].name[0] >= ASCII_LO);
                   assert(roffs[i].name[0] <= ASCII_HI);
   
         return(error ? 0 : 1);                  buc = ROFF_HASH(roffs[i].name);
   
                   if (NULL != (n = hash[buc])) {
                           for ( ; n->next; n = n->next)
                                   /* Do nothing. */ ;
                           n->next = &roffs[i];
                   } else
                           hash[buc] = &roffs[i];
           }
 }  }
   
   
 struct rofftree *  /*
 roff_alloc(const struct roffcb *cb, void *args)   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
    * the nil-terminated string name could be found.
    */
   static enum rofft
   roff_hash_find(const char *p, size_t s)
 {  {
         struct rofftree *tree;          int              buc;
           struct roffmac  *n;
   
         assert(args);          /*
         assert(cb);           * libroff has an extremely simple hashtable, for the time
            * being, which simply keys on the first character, which must
            * be printable, then walks a chain.  It works well enough until
            * optimised.
            */
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))          if (p[0] < ASCII_LO || p[0] > ASCII_HI)
                 err(1, "calloc");                  return(ROFF_MAX);
   
         tree->state = ROFF_PRELUDE;          buc = ROFF_HASH(p);
         tree->arg = args;  
         tree->section = ROFF_MSEC_MAX;  
   
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));          if (NULL == (n = hash[buc]))
                   return(ROFF_MAX);
           for ( ; n; n = n->next)
                   if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
                           return((enum rofft)(n - roffs));
   
         return(tree);          return(ROFF_MAX);
 }  }
   
   
 int  /*
 roff_engine(struct rofftree *tree, char *buf)   * Pop the current node off of the stack of roff instructions currently
    * pending.
    */
   static void
   roffnode_pop(struct roff *r)
 {  {
           struct roffnode *p;
   
         tree->cur = buf;          assert(r->last);
         assert(buf);          p = r->last;
   
         if (0 == *buf)          if (ROFF_el == p->tok)
                 return(roff_err(tree, buf, "blank line"));                  if (r->rstackpos > -1)
         else if ('.' != *buf)                          r->rstackpos--;
                 return(textparse(tree, buf));  
   
         return(roffparse(tree, buf));          ROFF_DEBUG("roff: popping scope\n");
           r->last = r->last->parent;
           free(p->name);
           free(p->end);
           free(p);
 }  }
   
   
 static int  /*
 textparse(struct rofftree *tree, char *buf)   * Push a roff node onto the instruction stack.  This must later be
    * removed with roffnode_pop().
    */
   static void
   roffnode_push(struct roff *r, enum rofft tok, const char *name,
                   int line, int col)
 {  {
         char            *bufp;          struct roffnode *p;
   
         /* TODO: literal parsing. */          p = mandoc_calloc(1, sizeof(struct roffnode));
           p->tok = tok;
           if (name)
                   p->name = mandoc_strdup(name);
           p->parent = r->last;
           p->line = line;
           p->col = col;
           p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
   
         if ( ! (ROFF_BODY & tree->state))          r->last = p;
                 return(roff_err(tree, buf, "data not in body"));  }
   
         /* LINTED */  
         while (*buf) {  
                 while (*buf && isspace(*buf))  
                         buf++;  
   
                 if (0 == *buf)  static void
                         break;  roff_free1(struct roff *r)
   {
   
                 bufp = buf++;          while (r->last)
                   roffnode_pop(r);
           roff_freestr(r);
   }
   
                 while (*buf && ! isspace(*buf))  
                         buf++;  
   
                 if (0 != *buf) {  void
                         *buf++ = 0;  roff_reset(struct roff *r)
                         if ( ! roffdata(tree, 1, bufp))  {
                                 return(0);  
                         continue;  
                 }  
   
                 if ( ! roffdata(tree, 1, bufp))          roff_free1(r);
                         return(0);  }
                 break;  
         }  
   
         return(1);  
   void
   roff_free(struct roff *r)
   {
   
           roff_free1(r);
           free(r);
 }  }
   
   
 static int  struct roff *
 roffargs(const struct rofftree *tree,  roff_alloc(struct regset *regs, void *data, const mandocmsg msg)
                 int tok, char *buf, char **argv)  
 {  {
         int              i;          struct roff     *r;
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          r = mandoc_calloc(1, sizeof(struct roff));
         assert('.' == *buf);          r->regs = regs;
           r->msg = msg;
           r->data = data;
           r->rstackpos = -1;
   
           roff_hash_init();
           return(r);
   }
   
         p = buf;  
   
         /*  /*
          * This is an ugly little loop.  It parses a line into   * Pre-filter each and every line for reserved words (one beginning with
          * space-delimited tokens.  If a quote mark is encountered, a   * `\*', e.g., `\*(ab').  These must be handled before the actual line
          * token is alloted the entire quoted text.  If whitespace is   * is processed.
          * escaped, it's included in the prior alloted token.   */
          */  static int
   roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
   {
           const char      *cp, *cpp, *st, *res;
           int              i, maxl;
           size_t           nsz;
           char            *n;
   
         /* LINTED */          /* LINTED */
         for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) {          for (cp = &(*bufp)[pos]; (cpp = strstr(cp, "\\*")); cp++) {
                 if ('\"' == *buf) {                  cp = cpp + 2;
                         argv[i] = ++buf;                  switch (*cp) {
                         while (*buf && '\"' != *buf)                  case ('('):
                                 buf++;                          cp++;
                         if (0 == *buf)                          maxl = 2;
                                 return(roff_err(tree, argv[i],                          break;
                                         "unclosed quote in arg list"));                  case ('['):
                 } else {                          cp++;
                         argv[i] = buf++;                          maxl = 0;
                         while (*buf) {                          break;
                                 if ( ! isspace(*buf)) {                  default:
                                         buf++;                          maxl = 1;
                                         continue;                          break;
                                 }  
                                 if (*(buf - 1) == '\\') {  
                                         buf++;  
                                         continue;  
                                 }  
                                 break;  
                         }  
                         if (0 == *buf)  
                                 continue;  
                 }                  }
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);                  st = cp;
         if (ROFF_MAXLINEARG == i && *buf)  
                 return(roff_err(tree, p, "too many args"));  
   
         argv[i] = NULL;                  for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
         return(1);                          if ('\0' == *cp)
 }                                  return(1); /* Error. */
                           if (0 == maxl && ']' == *cp)
                                   break;
                   }
   
                   res = roff_getstrn(r, st, (size_t)i);
   
 static int                  if (NULL == res) {
 roffscan(int tok, const int *tokv)                          cp -= maxl ? 1 : 0;
 {                          continue;
                   }
   
         if (NULL == tokv)                  ROFF_DEBUG("roff: splicing reserved: [%.*s]\n", i, st);
                 return(1);  
   
         for ( ; ROFF_MAX != *tokv; tokv++)                  nsz = *szp + strlen(res) + 1;
                 if (tok == *tokv)                  n = mandoc_malloc(nsz);
                         return(1);  
   
         return(0);                  *n = '\0';
 }  
   
                   strlcat(n, *bufp, (size_t)(cpp - *bufp + 1));
                   strlcat(n, res, nsz);
                   strlcat(n, cp + (maxl ? 0 : 1), nsz);
   
 static int                  free(*bufp);
 roffparse(struct rofftree *tree, char *buf)  
 {  
         int               tok, t;  
         struct roffnode  *n;  
         char             *argv[ROFF_MAXLINEARG];  
         char            **argvp;  
   
         if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))                  *bufp = n;
                 if (0 == strncmp(buf, ".\\\"", 3))                  *szp = nsz;
                         return(1);  
   
         if (ROFF_MAX == (tok = rofffindtok(buf + 1)))  
                 return(roff_err(tree, buf, "bogus line macro"));  
         else if ( ! roffargs(tree, tok, buf, argv))  
                 return(0);                  return(0);
           }
   
         argvp = (char **)argv;          return(1);
   }
   
         /*  
          * Prelude macros break some assumptions, so branch now.  
          */  
   
         if (ROFF_PRELUDE & tree->state) {  
                 assert(NULL == tree->last);  
                 return(roffcall(tree, tok, argvp));  
         }  
   
         assert(ROFF_BODY & tree->state);  enum rofferr
   roff_parseln(struct roff *r, int ln, char **bufp,
                   size_t *szp, int pos, int *offs)
   {
           enum rofft       t;
           int              ppos;
   
         /*          /*
          * First check that our possible parents and parent's possible           * Run the reserved-word filter only if we have some reserved
          * children are satisfied.           * words to fill in.
          */           */
   
         if (tree->last && ! roffscan          if (r->first_string && ! roff_res(r, bufp, szp, pos))
                         (tree->last->tok, tokens[tok].parents))                  return(ROFF_REPARSE);
                 return(roff_err(tree, *argvp, "`%s' has invalid "  
                                         "parent `%s'", toknames[tok],  
                                         toknames[tree->last->tok]));  
   
         if (tree->last && ! roffscan  
                         (tok, tokens[tree->last->tok].children))  
                 return(roff_err(tree, *argvp, "`%s' has invalid "  
                                         "child `%s'", toknames[tok],  
                                         toknames[tree->last->tok]));  
   
         /*          /*
          * Branch if we're not a layout token.           * First, if a scope is open and we're not a macro, pass the
            * text through the macro's filter.  If a scope isn't open and
            * we're not a macro, just let it through.
          */           */
   
         if (ROFF_LAYOUT != tokens[tok].type)          if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                 return(roffcall(tree, tok, argvp));                  t = r->last->tok;
         if (0 == tokens[tok].ctx)                  assert(roffs[t].text);
                 return(roffcall(tree, tok, argvp));                  ROFF_DEBUG("roff: intercept scoped text: %s, [%s]\n",
                                   roffs[t].name, &(*bufp)[pos]);
                   return((*roffs[t].text)
                                   (r, t, bufp, szp,
                                    ln, pos, pos, offs));
           } else if ( ! ROFF_CTL((*bufp)[pos]))
                   return(ROFF_CONT);
   
         /*          /*
          * First consider implicit-end tags, like as follows:           * If a scope is open, go to the child handler for that macro,
          *      .Sh SECTION 1           * as it may want to preprocess before doing anything with it.
          *      .Sh SECTION 2  
          * In this, we want to close the scope of the NAME section.  If  
          * there's an intermediary implicit-end tag, such as  
          *      .Sh SECTION 1  
          *      .Ss Subsection 1  
          *      .Sh SECTION 2  
          * then it must be closed as well.  
          */           */
   
         if (tok == tokens[tok].ctx) {          if (r->last) {
                 /*                  t = r->last->tok;
                  * First search up to the point where we must close.                  assert(roffs[t].sub);
                  * If one doesn't exist, then we can open a new scope.                  ROFF_DEBUG("roff: intercept scoped context: %s, [%s]\n",
                  */                                  roffs[t].name, &(*bufp)[pos]);
                   return((*roffs[t].sub)
                 for (n = tree->last; n; n = n->parent) {                                  (r, t, bufp, szp,
                         assert(0 == tokens[n->tok].ctx ||                                   ln, pos, pos, offs));
                                         n->tok == tokens[n->tok].ctx);  
                         if (n->tok == tok)  
                                 break;  
                         if (ROFF_SHALLOW & tokens[tok].flags) {  
                                 n = NULL;  
                                 break;  
                         }  
                         if (tokens[n->tok].ctx == n->tok)  
                                 continue;  
                         return(roff_err(tree, *argv, "`%s' breaks "  
                                                 "scope of prior`%s'",  
                                                 toknames[tok],  
                                                 toknames[n->tok]));  
                 }  
   
                 /*  
                  * Create a new scope, as no previous one exists to  
                  * close out.  
                  */  
   
                 if (NULL == n)  
                         return(roffcall(tree, tok, argvp));  
   
                 /*  
                  * Close out all intermediary scoped blocks, then hang  
                  * the current scope from our predecessor's parent.  
                  */  
   
                 do {  
                         t = tree->last->tok;  
                         if ( ! roffexit(tree, t))  
                                 return(0);  
                 } while (t != tok);  
   
                 return(roffcall(tree, tok, argvp));  
         }          }
   
         /*          /*
          * Now consider explicit-end tags, where we want to close back           * Lastly, as we've no scope open, try to look up and execute
          * to a specific tag.  Example:           * the new macro.  If no macro is found, simply return and let
          *      .Bl           * the compilers handle it.
          *      .It Item.  
          *      .El  
          * In this, the `El' tag closes out the scope of `Bl'.  
          */           */
   
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);          ppos = pos;
           if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                   return(ROFF_CONT);
   
         /* LINTED */          ROFF_DEBUG("roff: intercept new-scope: [%s], [%s]\n",
         for (n = tree->last; n; n = n->parent)                          ROFF_USERDEF == t ? r->current_string : roffs[t].name,
                 if (n->tok != tokens[tok].ctx) {                          &(*bufp)[pos]);
                         if (n->tok == tokens[n->tok].ctx)  
                                 continue;  
                         return(roff_err(tree, *argv, "`%s' breaks "  
                                                 "scope of prior `%s'",  
                                                 toknames[tok],  
                                                 toknames[n->tok]));  
                 } else  
                         break;  
   
         if (NULL == n)          assert(roffs[t].proc);
                 return(roff_err(tree, *argv, "`%s' has no starting "          return((*roffs[t].proc)
                                         "tag `%s'", toknames[tok],                          (r, t, bufp, szp,
                                         toknames[tokens[tok].ctx]));                           ln, ppos, pos, offs));
   
         /* LINTED */  
         do {  
                 t = tree->last->tok;  
                 if ( ! roffexit(tree, t))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         return(1);  
 }  }
   
   
 static int  int
 rofffindarg(const char *name)  roff_endparse(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          if (NULL == r->last)
                   return(1);
         /* LINTED */          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
         for (i = 0; i < ROFF_ARGMAX; i++)                                  r->last->col, NULL));
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   
 static int  /*
 rofffindtok(const char *buf)   * Parse a roff node's type from the input buffer.  This must be in the
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(struct roff *r, const char *buf, int *pos)
 {  {
         char             token[4];          const char      *mac;
         int              i;          size_t           maclen;
           enum rofft       t;
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)          assert(ROFF_CTL(buf[*pos]));
                 token[i] = *buf;          (*pos)++;
   
         if (i == 3)          while (' ' == buf[*pos] || '\t' == buf[*pos])
                   (*pos)++;
   
           if ('\0' == buf[*pos])
                 return(ROFF_MAX);                  return(ROFF_MAX);
   
         token[i] = 0;          mac = buf + *pos;
           maclen = strcspn(mac, " \\\t\0");
   
         /* FIXME: use a table, this is slow but ok for now. */          t = (r->current_string = roff_getstrn(r, mac, maclen))
               ? ROFF_USERDEF : roff_hash_find(mac, maclen);
   
         /* LINTED */          *pos += maclen;
         for (i = 0; i < ROFF_MAX; i++)          while (buf[*pos] && ' ' == buf[*pos])
                 /* LINTED */                  (*pos)++;
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);          return(t);
 }  }
   
   
 static int  static int
 roffchecksec(struct rofftree *tree, const char *start, int sec)  roff_parse_nat(const char *buf, unsigned int *res)
 {  {
         int              prior;          char            *ep;
           long             lval;
   
         switch (sec) {          errno = 0;
         case(ROFFSec_SYNOP):          lval = strtol(buf, &ep, 10);
                 if ((prior = ROFFSec_NAME) & tree->asec)          if (buf[0] == '\0' || *ep != '\0')
                         return(1);                  return(0);
                 break;          if ((errno == ERANGE &&
         case(ROFFSec_DESC):                          (lval == LONG_MAX || lval == LONG_MIN)) ||
                 if ((prior = ROFFSec_SYNOP) & tree->asec)                          (lval > INT_MAX || lval < 0))
                         return(1);                  return(0);
                 break;  
         case(ROFFSec_RETVAL):  
                 if ((prior = ROFFSec_DESC) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ENV):  
                 if ((prior = ROFFSec_RETVAL) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_FILES):  
                 if ((prior = ROFFSec_ENV) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_EX):  
                 if ((prior = ROFFSec_FILES) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DIAG):  
                 if ((prior = ROFFSec_EX) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ERRS):  
                 if ((prior = ROFFSec_DIAG) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SEEALSO):  
                 if ((prior = ROFFSec_ERRS) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_STAND):  
                 if ((prior = ROFFSec_SEEALSO) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_HIST):  
                 if ((prior = ROFFSec_STAND) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_AUTH):  
                 if ((prior = ROFFSec_HIST) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_CAVEATS):  
                 if ((prior = ROFFSec_AUTH) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_BUGS):  
                 if ((prior = ROFFSec_CAVEATS) & tree->asec)  
                         return(1);  
                 break;  
         default:  
                 return(1);  
         }  
   
         return(roff_warnp(tree, start, ROFF_Sh, WRN_SECORD));          *res = (unsigned int)lval;
           return(1);
 }  }
   
   
 /* FIXME: move this into literals.c (or similar). */  /* ARGSUSED */
 static int  static enum rofferr
 roffispunct(const char *p)  roff_cblock(ROFF_ARGS)
 {  {
   
         if (0 == *p)          /*
                 return(0);           * A block-close `..' should only be invoked as a child of an
         if (0 != *(p + 1))           * ignore macro, otherwise raise a warning and just ignore it.
                 return(0);           */
   
         switch (*p) {          if (NULL == r->last) {
         case('{'):                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           switch (r->last->tok) {
           case (ROFF_am):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('.'):          case (ROFF_ami):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(','):          case (ROFF_am1):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(';'):          case (ROFF_de):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(':'):          case (ROFF_dei):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('?'):          case (ROFF_ig):
                 /* FALLTHROUGH */  
         case('!'):  
                 /* FALLTHROUGH */  
         case('('):  
                 /* FALLTHROUGH */  
         case(')'):  
                 /* FALLTHROUGH */  
         case('['):  
                 /* FALLTHROUGH */  
         case(']'):  
                 /* FALLTHROUGH */  
         case('}'):  
                 return(1);  
         default:  
                 break;                  break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         return(0);          if ((*bufp)[pos])
 }                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   
 static int  
 rofffindcallable(const char *name)  
 {  
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))  
                 return(ROFF_MAX);  
         assert(c >= 0 && c < ROFF_MAX);  
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);  
 }  }
   
   
 static struct roffnode *  
 roffnode_new(int tokid, struct rofftree *tree)  
 {  
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode))))  
                 err(1, "malloc");  
   
         p->tok = tokid;  
         p->parent = tree->last;  
         tree->last = p;  
   
         return(p);  
 }  
   
   
 static int  
 roffargok(int tokid, int argid)  
 {  
         const int       *c;  
   
         if (NULL == (c = tokens[tokid].args))  
                 return(0);  
   
         for ( ; ROFF_ARGMAX != *c; c++)  
                 if (argid == *c)  
                         return(1);  
   
         return(0);  
 }  
   
   
 static void  static void
 roffnode_free(struct rofftree *tree)  roffnode_cleanscope(struct roff *r)
 {  {
         struct roffnode *p;  
   
         assert(tree->last);          while (r->last) {
                   if (--r->last->endspan < 0)
         p = tree->last;                          break;
         tree->last = tree->last->parent;                  roffnode_pop(r);
         free(p);          }
 }  }
   
   
 static int  /* ARGSUSED */
 roffspecial(struct rofftree *tree, int tok, const char *start,  static enum rofferr
                 const int *argc, const char **argv,  roff_ccond(ROFF_ARGS)
                 size_t sz, char **ordp)  
 {  {
   
         switch (tok) {          if (NULL == r->last) {
         case (ROFF_At):                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                 if (0 == sz)                          return(ROFF_ERR);
                         break;                  return(ROFF_IGN);
                 if (ROFF_ATT_MAX != roff_att(*ordp))          }
                         break;  
                 return(roff_errp(tree, *ordp, tok, ERR_BADARG));  
   
         case (ROFF_Xr):  
                 if (2 == sz) {  
                         assert(ordp[1]);  
                         if (ROFF_MSEC_MAX != roff_msec(ordp[1]))  
                                 break;  
                         if ( ! roff_warn(tree, start, "invalid `%s' manual "  
                                                 "section", toknames[tok]))  
                                 return(0);  
                 }  
                 /* FALLTHROUGH */  
   
         case (ROFF_Sx):          switch (r->last->tok) {
                 /* FALLTHROUGH*/          case (ROFF_el):
         case (ROFF_Fn):  
                 if (0 != sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGGE1));  
   
         case (ROFF_Nm):  
                 if (0 == sz) {  
                         if (0 != tree->name[0]) {  
                                 ordp[0] = tree->name;  
                                 ordp[1] = NULL;  
                                 break;  
                         }  
                         return(roff_err(tree, start, "`Nm' not set"));  
                 } else if ( ! roffsetname(tree, ordp))  
                         return(0);  
                 break;  
   
         case (ROFF_Rv):  
                 /* FALLTHROUGH*/  
         case (ROFF_Ex):  
                 if (1 == sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGEQ1));  
   
         case (ROFF_Sm):  
                 if (1 != sz)  
                         return(roff_errp(tree, start, tok, ERR_ARGEQ1));  
                 else if (0 == strcmp(ordp[0], "on") ||  
                                 0 == strcmp(ordp[0], "off"))  
                         break;  
                 return(roff_errp(tree, *ordp, tok, ERR_BADARG));  
   
         case (ROFF_Ud):  
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (ROFF_Ux):          case (ROFF_ie):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (ROFF_Bt):          case (ROFF_if):
                 if (0 == sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGEQ0));  
         default:  
                 break;                  break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur,          if (r->last->endspan > -1) {
                                 argc, argv, (const char **)ordp));                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
 }                          return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
 static int          roffnode_pop(r);
 roffexit(struct rofftree *tree, int tok)          roffnode_cleanscope(r);
 {          return(ROFF_IGN);
   
         assert(tokens[tok].cb);  
         return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT));  
 }  }
   
   
 static int  /* ARGSUSED */
 roffcall(struct rofftree *tree, int tok, char **argv)  static enum rofferr
   roff_block(ROFF_ARGS)
 {  {
         int              i;          int             sv;
         enum roffmsec    c;          size_t          sz;
           char            *name;
   
         if (NULL == tokens[tok].cb)          name = NULL;
                 return(roff_errp(tree, *argv, tok, ERR_NOTSUP));  
   
         if (tokens[tok].sections && ROFF_MSEC_MAX != tree->section) {          if (ROFF_ig != tok) {
                 i = 0;                  if ('\0' == (*bufp)[pos]) {
                 while (ROFF_MSEC_MAX !=                          (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
                                 (c = tokens[tok].sections[i++]))                          return(ROFF_IGN);
                         if (c == tree->section)  
                                 break;  
                 if (ROFF_MSEC_MAX == c) {  
                         if ( ! roff_warn(tree, *argv, "`%s' is not a valid "  
                                         "macro in this manual section",  
                                         toknames[tok]))  
                                 return(0);  
                 }                  }
         }  
   
         return((*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER));                  /*
 }                   * Re-write `de1', since we don't really care about
                    * groff's strange compatibility mode, into `de'.
                    */
   
                   if (ROFF_de1 == tok)
                           tok = ROFF_de;
                   if (ROFF_de == tok)
                           name = *bufp + pos;
                   else
                           (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos,
                               roffs[tok].name);
   
 static int                  while ((*bufp)[pos] && ' ' != (*bufp)[pos])
 roffnextopt(const struct rofftree *tree, int tok,                          pos++;
                 char ***in, char **val)  
 {  
         char            *arg, **argv;  
         int              v;  
   
         *val = NULL;                  while (' ' == (*bufp)[pos])
         argv = *in;                          (*bufp)[pos++] = '\0';
         assert(argv);  
   
         if (NULL == (arg = *argv))  
                 return(-1);  
         if ('-' != *arg)  
                 return(-1);  
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {  
                 if ( ! roff_warn(tree, arg, "argument-like parameter `%s' to "  
                                         "`%s'", arg, toknames[tok]))  
                         return(ROFF_ARGMAX);  
                 return(-1);  
         }  
   
         if ( ! roffargok(tok, v)) {  
                 if ( ! roff_warn(tree, arg, "invalid argument parameter `%s' to "  
                                 "`%s'", tokargnames[v], toknames[tok]))  
                         return(ROFF_ARGMAX);  
                 return(-1);  
         }  
   
         if ( ! (ROFF_VALUE & tokenargs[v]))  
                 return(v);  
   
         *in = ++argv;  
   
         if (NULL == *argv) {  
                 (void)roff_err(tree, arg, "empty value of `%s' for `%s'",  
                                 tokargnames[v], toknames[tok]);  
                 return(ROFF_ARGMAX);  
         }          }
   
         return(v);          roffnode_push(r, tok, name, ln, ppos);
 }  
   
           /*
            * At the beginning of a `de' macro, clear the existing string
            * with the same name, if there is one.  New content will be
            * added from roff_block_text() in multiline mode.
            */
   
 static int          if (ROFF_de == tok)
 roffpurgepunct(struct rofftree *tree, char **argv)                  roff_setstr(r, name, NULL, 0);
 {  
         int              i;  
   
         i = 0;          if ('\0' == (*bufp)[pos])
         while (argv[i])                  return(ROFF_IGN);
                 i++;  
         assert(i > 0);  
         if ( ! roffispunct(argv[--i]))  
                 return(1);  
         while (i >= 0 && roffispunct(argv[i]))  
                 i--;  
         i++;  
   
         /* LINTED */          /* If present, process the custom end-of-line marker. */
         while (argv[i])  
                 if ( ! roffdata(tree, 0, argv[i++]))  
                         return(0);  
         return(1);  
 }  
   
           sv = pos;
           while ((*bufp)[pos] &&
                           ' ' != (*bufp)[pos] &&
                           '\t' != (*bufp)[pos])
                   pos++;
   
 static int          /*
 roffparseopts(struct rofftree *tree, int tok,           * Note: groff does NOT like escape characters in the input.
                 char ***args, int *argc, char **argv)           * Instead of detecting this, we're just going to let it fly and
 {           * to hell with it.
         int              i, c;           */
         char            *v;  
   
         i = 0;          assert(pos > sv);
           sz = (size_t)(pos - sv);
   
         while (-1 != (c = roffnextopt(tree, tok, args, &v))) {          if (1 == sz && '.' == (*bufp)[sv])
                 if (ROFF_ARGMAX == c)                  return(ROFF_IGN);
                         return(0);  
   
                 argc[i] = c;          r->last->end = mandoc_malloc(sz + 1);
                 argv[i] = v;  
                 i++;  
                 *args = *args + 1;  
         }  
   
         argc[i] = ROFF_ARGMAX;          memcpy(r->last->end, *bufp + sv, sz);
         argv[i] = NULL;          r->last->end[(int)sz] = '\0';
         return(1);  
 }  
   
           if ((*bufp)[pos])
                   (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
   
 static int          return(ROFF_IGN);
 roffdata(struct rofftree *tree, int space, char *buf)  
 {  
   
         if (0 == *buf)  
                 return(1);  
         return((*tree->cb.roffdata)(tree->arg,  
                                 space != 0, tree->cur, buf));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_block_sub(ROFF_ARGS)
 {  {
         time_t           t;          enum rofft      t;
         char            *p, buf[32];          int             i, j;
         size_t           sz;  
   
         if (ROFF_BODY & tree->state) {          /*
                 assert( ! (ROFF_PRELUDE & tree->state));           * First check whether a custom macro exists at this level.  If
                 assert(ROFF_PRELUDE_Dd & tree->state);           * it does, then check against it.  This is some of groff's
                 return(roff_text(tok, tree, argv, type));           * stranger behaviours.  If we encountered a custom end-scope
         }           * tag and that tag also happens to be a "real" macro, then we
            * need to try interpreting it again as a real macro.  If it's
            * not, then return ignore.  Else continue.
            */
   
         assert(ROFF_PRELUDE & tree->state);          if (r->last->end) {
         assert( ! (ROFF_BODY & tree->state));                  i = pos + 1;
                   while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                           i++;
   
         if (ROFF_PRELUDE_Dd & tree->state)                  for (j = 0; r->last->end[j]; j++, i++)
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));                          if ((*bufp)[i] != r->last->end[j])
         if (ROFF_PRELUDE_Dt & tree->state)                                  break;
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         assert(NULL == tree->last);                  if ('\0' == r->last->end[j] &&
                                   ('\0' == (*bufp)[i] ||
                                    ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
         argv++;                          if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                   return(ROFF_RERUN);
                           return(ROFF_IGN);
                   }
           }
   
         /*          /*
          * This is a bit complex because there are many forms the date           * If we have no custom end-query or lookup failed, then try
          * can be in:  it can be simply $Mdocdate$, $Mdocdate <date>$,           * pulling it out of the hashtable.
          * or a raw date.  Process accordingly.  
          */           */
   
         if (0 == strcmp(*argv, "$Mdocdate$")) {          ppos = pos;
                 t = time(NULL);          t = roff_parse(r, *bufp, &pos);
                 if (NULL == localtime_r(&t, &tree->tm))  
                         err(1, "localtime_r");  
                 tree->state |= ROFF_PRELUDE_Dd;  
                 return(1);  
         }  
   
         buf[0] = 0;          /*
         p = *argv;           * Macros other than block-end are only significant
         sz = sizeof(buf);           * in `de' blocks; elsewhere, simply throw them away.
            */
         if (0 != strcmp(*argv, "$Mdocdate:")) {          if (ROFF_cblock != t) {
                 while (*argv) {                  if (ROFF_de == tok)
                         if (strlcat(buf, *argv++, sz) < sz)                          roff_setstr(r, r->last->name, *bufp + ppos, 1);
                                 continue;                  return(ROFF_IGN);
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
                 }  
                 if (strptime(buf, "%b%d,%Y", &tree->tm)) {  
                         tree->state |= ROFF_PRELUDE_Dd;  
                         return(1);  
                 }  
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
         }          }
   
         argv++;          assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
         while (*argv && **argv != '$') {                                  ln, ppos, pos, offs));
                 if (strlcat(buf, *argv++, sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
                 if (strlcat(buf, " ", sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
         }  
   
         if (NULL == *argv)  
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
         if (NULL == strptime(buf, "%b %d %Y", &tree->tm))  
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
   
         tree->state |= ROFF_PRELUDE_Dd;  
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_block_text(ROFF_ARGS)
 {  {
         size_t           sz;  
   
         if (ROFF_BODY & tree->state) {          if (ROFF_de == tok)
                 assert( ! (ROFF_PRELUDE & tree->state));                  roff_setstr(r, r->last->name, *bufp + pos, 1);
                 assert(ROFF_PRELUDE_Dt & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          return(ROFF_IGN);
         assert( ! (ROFF_BODY & tree->state));  }
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state))  
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
         if (ROFF_PRELUDE_Dt & tree->state)  
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));  
   
         argv++;  /* ARGSUSED */
         sz = sizeof(tree->title);  static enum rofferr
   roff_cond_sub(ROFF_ARGS)
   {
           enum rofft       t;
           enum roffrule    rr;
   
         if (NULL == *argv)          ppos = pos;
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));          rr = r->last->rule;
         if (strlcpy(tree->title, *argv, sz) >= sz)  
                 return(roff_errp(tree, *argv, tok, ERR_ARGLEN));  
   
         argv++;          /*
         if (NULL == *argv)           * Clean out scope.  If we've closed ourselves, then don't
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));           * continue.
            */
   
         if (ROFF_MSEC_MAX == (tree->section = roff_msec(*argv)))          roffnode_cleanscope(r);
                 return(roff_errp(tree, *argv, tok, ERR_BADARG));  
   
         argv++;          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
                   if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1])
                           return(roff_ccond
                                   (r, ROFF_ccond, bufp, szp,
                                    ln, pos, pos + 2, offs));
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
           }
   
         if (NULL == *argv) {          /*
                 switch (tree->section) {           * A denied conditional must evaluate its children if and only
                 case(ROFF_MSEC_1):           * if they're either structurally required (such as loops and
                         /* FALLTHROUGH */           * conditionals) or a closing macro.
                 case(ROFF_MSEC_6):           */
                         /* FALLTHROUGH */          if (ROFFRULE_DENY == rr)
                 case(ROFF_MSEC_7):                  if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                         tree->volume = ROFF_VOL_URM;                          if (ROFF_ccond != t)
                         break;                                  return(ROFF_IGN);
                 case(ROFF_MSEC_2):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_3):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_3p):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_4):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_5):  
                         tree->volume = ROFF_VOL_PRM;  
                         break;  
                 case(ROFF_MSEC_8):  
                         tree->volume = ROFF_VOL_PRM;  
                         break;  
                 case(ROFF_MSEC_9):  
                         tree->volume = ROFF_VOL_KM;  
                         break;  
                 case(ROFF_MSEC_UNASS):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_DRAFT):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_PAPER):  
                         tree->volume = ROFF_VOL_NONE;  
                         break;  
                 default:  
                         abort();  
                         /* NOTREACHED */  
                 }  
         } else if (ROFF_VOL_MAX == (tree->volume = roff_vol(*argv)))  
                 return(roff_errp(tree, *argv, tok, ERR_BADARG));  
   
         assert(NULL == tree->last);          assert(roffs[t].proc);
         tree->state |= ROFF_PRELUDE_Dt;          return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
         return(1);  
 }  }
   
   
 static int  /* ARGSUSED */
 roffsetname(struct rofftree *tree, char **ordp)  static enum rofferr
   roff_cond_text(ROFF_ARGS)
 {  {
         size_t           sz;          char            *ep, *st;
           enum roffrule    rr;
         assert(*ordp);  
   
         /* FIXME: not all sections can set this. */          rr = r->last->rule;
   
         if (NULL != *(ordp + 1))          /*
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGMNY));           * We display the value of the text if out current evaluation
            * scope permits us to do so.
         sz = sizeof(tree->name);           */
         if (strlcpy(tree->name, *ordp, sz) >= sz)  
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGLEN));  
   
         return(1);          /* FIXME: use roff_ccond? */
 }  
   
           st = &(*bufp)[pos];
           if (NULL == (ep = strstr(st, "\\}"))) {
                   roffnode_cleanscope(r);
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
           }
   
 /* ARGSUSED */          if (ep == st || (ep > st && '\\' != *(ep - 1)))
 static  int                  roffnode_pop(r);
 roff_Ns(ROFFCALL_ARGS)  
 {  
         int              j, c, first;  
         char            *morep[1];  
   
         first = (*argv++ == tree->cur);          roffnode_cleanscope(r);
         morep[0] = NULL;          return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   }
   
         if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))  
                 return(0);  
   
         while (*argv) {  static enum roffrule
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  roff_evalcond(const char *v, int *pos)
                         if ( ! roffcall(tree, c, argv))  {
                                 return(0);  
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {          switch (v[*pos]) {
                         if ( ! roffdata(tree, 1, *argv++))          case ('n'):
                                 return(0);                  (*pos)++;
                         continue;                  return(ROFFRULE_ALLOW);
                 }          case ('e'):
                   /* FALLTHROUGH */
                 for (j = 0; argv[j]; j++)          case ('o'):
                         if ( ! roffispunct(argv[j]))                  /* FALLTHROUGH */
                                 break;          case ('t'):
                   (*pos)++;
                 if (argv[j]) {                  return(ROFFRULE_DENY);
                         if ( ! roffdata(tree, 0, *argv++))          default:
                                 return(0);  
                         continue;  
                 }  
   
                 break;                  break;
         }          }
   
         if ( ! first)          while (v[*pos] && ' ' != v[*pos])
                 return(1);                  (*pos)++;
           return(ROFFRULE_DENY);
         return(roffpurgepunct(tree, argv));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_line_ignore(ROFF_ARGS)
 {  {
         char            *p;  
         size_t           sz;  
   
         if (ROFF_BODY & tree->state) {          return(ROFF_IGN);
                 assert( ! (ROFF_PRELUDE & tree->state));  }
                 assert(ROFF_PRELUDE_Os & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);  /* ARGSUSED */
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||  static enum rofferr
                         ! (ROFF_PRELUDE_Dd & tree->state))  roff_line_error(ROFF_ARGS)
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  {
   
         tree->os[0] = 0;          (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, roffs[tok].name);
           return(ROFF_IGN);
         p = *++argv;  
         sz = sizeof(tree->os);  
   
         while (*argv)  
                 if (strlcat(tree->os, *argv++, sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_ARGLEN));  
   
         if (0 == tree->os[0])  
                 if (strlcpy(tree->os, "LOCAL", sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_ARGLEN));  
   
         tree->state |= ROFF_PRELUDE_Os;  
         tree->state &= ~ROFF_PRELUDE;  
         tree->state |= ROFF_BODY;  
   
         assert(ROFF_MSEC_MAX != tree->section);  
         assert(0 != tree->title[0]);  
         assert(0 != tree->os[0]);  
   
         assert(NULL == tree->last);  
   
         return((*tree->cb.roffhead)(tree->arg, &tree->tm,  
                                 tree->os, tree->title,  
                                 tree->section, tree->volume));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_layout(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXLINEARG];          int              sv;
         char            *argvp[ROFF_MAXLINEARG];          enum roffrule    rule;
   
         /*          /* Stack overflow! */
          * The roff_layout function is for multi-line macros.  A layout  
          * has a start and end point, which is either declared  
          * explicitly or implicitly.  An explicit start and end is  
          * embodied by `.Bl' and `.El', with the former being the start  
          * and the latter being an end.  The `.Sh' and `.Ss' tags, on  
          * the other hand, are implicit.  The scope of a layout is the  
          * space between start and end.  Explicit layouts may not close  
          * out implicit ones and vice versa; implicit layouts may close  
          * out other implicit layouts.  
          */  
   
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));          if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
                   (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
                   return(ROFF_ERR);
           }
   
         if (ROFF_PRELUDE & tree->state)          /* First, evaluate the conditional. */
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));  
   
         if (ROFF_EXIT == type) {          if (ROFF_el == tok) {
                 roffnode_free(tree);                  /*
                 if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))                   * An `.el' will get the value of the current rstack
                         return(0);                   * entry set in prior `ie' calls or defaults to DENY.
                 return((*tree->cb.roffblkout)(tree->arg, tok));                   */
         }                  if (r->rstackpos < 0)
                           rule = ROFFRULE_DENY;
                   else
                           rule = r->rstack[r->rstackpos];
           } else
                   rule = roff_evalcond(*bufp, &pos);
   
         argv++;          sv = pos;
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));  
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))          while (' ' == (*bufp)[pos])
                 return(0);                  pos++;
         if (NULL == roffnode_new(tok, tree))  
                 return(0);  
   
         /*          /*
          * Layouts have two parts: the layout body and header.  The           * Roff is weird.  If we have just white-space after the
          * layout header is the trailing text of the line macro, while           * conditional, it's considered the BODY and we exit without
          * the layout body is everything following until termination.           * really doing anything.  Warn about this.  It's probably
          * Example:           * wrong.
          *  
          * .It Fl f ) ;  
          * Bar.  
          *  
          * ...Produces...  
          *  
          * <block>  
          *      <head>  
          *              <!Fl f!> ;  
          *      </head>  
          *  
          *      <body>  
          *              Bar.  
          *      </body>  
          * </block>  
          */           */
   
         if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp,          if ('\0' == (*bufp)[pos] && sv != pos) {
                                 (const char **)argvp))                  (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
                 return(0);                  return(ROFF_IGN);
           }
   
         /* +++ Begin run macro-specific hooks over argv. */          roffnode_push(r, tok, NULL, ln, ppos);
   
         switch (tok) {          r->last->rule = rule;
         case (ROFF_Sh):  
                 if (NULL == *argv) {  
                         argv--;  
                         return(roff_errp(tree, *argv, tok, ERR_ARGGE1));  
                 }  
   
                 tree->csec = roff_sec((const char **)argv);          ROFF_DEBUG("roff: cond: %s -> %s\n", roffs[tok].name,
                           ROFFRULE_ALLOW == rule ?  "allow" : "deny");
   
                 if ( ! (ROFFSec_OTHER & tree->csec) &&          if (ROFF_ie == tok) {
                                 tree->asec & tree->csec)                  /*
                         if ( ! roff_warn(tree, *argv, "section repeated"))                   * An if-else will put the NEGATION of the current
                                 return(0);                   * evaluated conditional into the stack.
                    */
                   r->rstackpos++;
                   if (ROFFRULE_DENY == r->last->rule)
                           r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
                   else
                           r->rstack[r->rstackpos] = ROFFRULE_DENY;
           }
   
                 if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec))          /* If the parent has false as its rule, then so do we. */
                         return(roff_err(tree, *argv, "`NAME' section "  
                                                 "must be first"));  
                 if ( ! roffchecksec(tree, *argv, tree->csec))  
                         return(0);  
   
                 tree->asec |= tree->csec;          if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule) {
                 break;                  r->last->rule = ROFFRULE_DENY;
         default:                  ROFF_DEBUG("roff: cond override: %s -> deny\n",
                 break;                                  roffs[tok].name);
         }          }
   
         /* --- End run macro-specific hooks over argv. */  
   
         if (NULL == *argv)  
                 return((*tree->cb.roffblkbodyin)  
                                 (tree->arg, tok, argcp,  
                                  (const char **)argvp));  
   
         if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp,  
                                 (const char **)argvp))  
                 return(0);  
   
         /*          /*
          * If there are no parsable parts, then write remaining tokens           * Determine scope.  If we're invoked with "\{" trailing the
          * into the layout header and exit.           * conditional, then we're in a multiline scope.  Else our scope
            * expires on the next line.
          */           */
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          r->last->endspan = 1;
                 i = 0;  
                 while (*argv)  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
   
                 if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))          if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                         return(0);                  r->last->endspan = -1;
                 return((*tree->cb.roffblkbodyin)(tree->arg, tok, argcp,                  pos += 2;
                                  (const char **)argvp));                  ROFF_DEBUG("roff: cond-scope: %s, multi-line\n",
         }                                  roffs[tok].name);
           } else
                   ROFF_DEBUG("roff: cond-scope: %s, one-line\n",
                                   roffs[tok].name);
   
         /*          /*
          * Parsable elements may be in the header (or be the header, for           * If there are no arguments on the line, the next-line scope is
          * that matter).  Follow the regular parsing rules for these.           * assumed.
          */           */
   
         i = 0;          if ('\0' == (*bufp)[pos])
         while (*argv) {                  return(ROFF_IGN);
                 if (ROFF_MAX == (c = rofffindcallable(*argv))) {  
                         assert(tree->arg);  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                         continue;  
                 }  
                 if ( ! roffcall(tree, c, argv))  
                         return(0);  
                 break;  
         }  
   
         /*          /* Otherwise re-run the roff parser after recalculating. */
          * If there's trailing punctuation in the header, then write it  
          * out now.  Here we mimic the behaviour of a line-dominant text  
          * macro.  
          */  
   
         if (NULL == *argv) {          *offs = pos;
                 if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))          return(ROFF_RERUN);
                         return(0);  
                 return((*tree->cb.roffblkbodyin)  
                                 (tree->arg, tok, argcp,  
                                  (const char **)argvp));  
         }  
   
         /*  
          * Expensive.  Scan to the end of line then work backwards until  
          * a token isn't punctuation.  
          */  
   
         if ( ! roffpurgepunct(tree, argv))  
                 return(0);  
         if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))  
                 return(0);  
         return((*tree->cb.roffblkbodyin)(tree->arg,  
                                 tok, argcp, (const char **)argvp));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_ordered(ROFFCALL_ARGS)  roff_ds(ROFF_ARGS)
 {  {
         int              i, first, c, argcp[ROFF_MAXLINEARG];          char            *name, *string;
         char            *ordp[ROFF_MAXLINEARG], *p,  
                         *argvp[ROFF_MAXLINEARG];  
   
         /*          /*
          * Ordered macros pass their arguments directly to handlers,           * A symbol is named by the first word following the macro
          * instead of considering it free-form text.  Thus, the           * invocation up to a space.  Its value is anything after the
          * following macro looks as follows:           * name's trailing whitespace and optional double-quote.  Thus,
          *           *
          * .Xr foo 1 ) ,           *  [.ds foo "bar  "     ]
          *           *
          * .Xr arg1 arg2 punctuation           * will have `bar  "     ' as its value.
          */           */
   
         if (ROFF_PRELUDE & tree->state)          name = *bufp + pos;
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));          if ('\0' == *name)
                   return(ROFF_IGN);
   
         first = (*argv == tree->cur);          string = name;
         p = *argv++;          /* Read until end of name. */
         ordp[0] = NULL;          while (*string && ' ' != *string)
                   string++;
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))          /* Nil-terminate name. */
                 return(0);          if (*string)
                   *(string++) = '\0';
   
           /* Read past spaces. */
           while (*string && ' ' == *string)
                   string++;
   
         if (NULL == *argv)          /* Read passed initial double-quote. */
                 return(roffspecial(tree, tok, p, argcp,          if (*string && '"' == *string)
                                         (const char **)argvp, 0, ordp));                  string++;
   
         i = 0;          /* The rest is the value. */
         while (*argv && i < ROFF_MAXLINEARG) {          roff_setstr(r, name, string, 0);
                 c = ROFF_PARSED & tokens[tok].flags ?          return(ROFF_IGN);
                         rofffindcallable(*argv) : ROFF_MAX;  }
   
                 if (ROFF_MAX == c && ! roffispunct(*argv)) {  
                         ordp[i++] = *argv++;  
                         continue;  
                 }  
                 ordp[i] = NULL;  
   
                 if (ROFF_MAX == c)  /* ARGSUSED */
                         break;  static enum rofferr
   roff_nr(ROFF_ARGS)
   {
           const char      *key, *val;
           struct reg      *rg;
   
                 if ( ! roffspecial(tree, tok, p, argcp,          key = &(*bufp)[pos];
                                         (const char **)argvp,          rg = r->regs->regs;
                                         (size_t)i, ordp))  
                         return(0);  
   
                 return(roffcall(tree, c, argv));          /* Parse register request. */
         }          while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                   pos++;
   
         assert(i != ROFF_MAXLINEARG);          /*
         ordp[i] = NULL;           * Set our nil terminator.  Because this line is going to be
            * ignored anyway, we can munge it as we please.
            */
           if ((*bufp)[pos])
                   (*bufp)[pos++] = '\0';
   
         if ( ! roffspecial(tree, tok, p, argcp,          /* Skip whitespace to register token. */
                                 (const char**)argvp,          while ((*bufp)[pos] && ' ' == (*bufp)[pos])
                                 (size_t)i, ordp))                  pos++;
                 return(0);  
   
         /* FIXME: error if there's stuff after the punctuation. */          val = &(*bufp)[pos];
   
         if ( ! first || NULL == *argv)          /* Process register token. */
                 return(1);  
   
         return(roffpurgepunct(tree, argv));          if (0 == strcmp(key, "nS")) {
 }                  rg[(int)REG_nS].set = 1;
                   if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
                           rg[(int)REG_nS].v.u = 0;
   
                   ROFF_DEBUG("roff: register nS: %u\n",
                                   rg[(int)REG_nS].v.u);
           } else
                   ROFF_DEBUG("roff: ignoring register: %s\n", key);
   
           return(ROFF_IGN);
   }
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_so(ROFF_ARGS)
 {  {
         int              i, j, first, c, argcp[ROFF_MAXLINEARG];          char *name;
         char            *argvp[ROFF_MAXLINEARG];  
   
           (*r->msg)(MANDOCERR_SO, r->data, ln, ppos, NULL);
   
         /*          /*
          * Text macros are similar to special tokens, except that           * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
          * arguments are instead flushed as pure data: we're only           * opening anything that's not in our cwd or anything beneath
          * concerned with the macro and its arguments.  Example:           * it.  Thus, explicitly disallow traversing up the file-system
          *           * or using absolute paths.
          * .Fl v W f ;  
          *  
          * ...Produces...  
          *  
          * <fl> v W f </fl> ;  
          */           */
   
         if (ROFF_PRELUDE & tree->state)          name = *bufp + pos;
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));          if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
                   (*r->msg)(MANDOCERR_SOPATH, r->data, ln, pos, NULL);
                   return(ROFF_ERR);
           }
   
         first = (*argv == tree->cur);          *offs = pos;
         argv++;          return(ROFF_SO);
   }
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  /* ARGSUSED */
                 return(0);  static enum rofferr
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp,  roff_userdef(ROFF_ARGS)
                                 (const char **)argvp))  {
                 return(0);          const char       *arg[9];
         if (NULL == *argv)          char             *cp, *n1, *n2;
                 return((*tree->cb.roffout)(tree->arg, tok));          int               i, quoted, pairs;
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {  
                 i = 0;  
                 while (*argv)  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }  
   
         /*          /*
          * Deal with punctuation.  Ugly.  Work ahead until we encounter           * Collect pointers to macro argument strings
          * terminating punctuation.  If we encounter it and all           * and null-terminate them.
          * subsequent tokens are punctuation, then stop processing (the  
          * line-dominant macro will print these tokens after closure).  
          * If the punctuation is followed by non-punctuation, then close  
          * and re-open our scope, then continue.  
          */           */
           cp = *bufp + pos;
         i = 0;          for (i = 0; i < 9; i++) {
         while (*argv) {                  /* Quoting can only start with a new word. */
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {                  if ('"' == *cp) {
                         if ( ! (ROFF_LSCOPE & tokens[tok].flags))                          quoted = 1;
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))                          cp++;
                                         return(0);                  } else
                           quoted = 0;
                         if ( ! roffcall(tree, c, argv))                  arg[i] = cp;
                                 return(0);                  for (pairs = 0; '\0' != *cp; cp++) {
                         if (ROFF_LSCOPE & tokens[tok].flags)                          /* Unquoted arguments end at blanks. */
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))                          if (0 == quoted) {
                                         return(0);                                  if (' ' == *cp)
                                           break;
                                   continue;
                           }
                           /* After pairs of quotes, move left. */
                           if (pairs)
                                   cp[-pairs] = cp[0];
                           /* Pairs of quotes do not end words, ... */
                           if ('"' == cp[0] && '"' == cp[1]) {
                                   pairs++;
                                   cp++;
                                   continue;
                           }
                           /* ... but solitary quotes do. */
                           if ('"' != *cp)
                                   continue;
                           if (pairs)
                                   cp[-pairs] = '\0';
                           *cp = ' ';
                         break;                          break;
                 }                  }
                   /* Last argument; the remaining ones are empty strings. */
                   if ('\0' == *cp)
                           continue;
                   /* Null-terminate argument and move to the next one. */
                   *cp++ = '\0';
                   while (' ' == *cp)
                           cp++;
           }
   
                 if ( ! roffispunct(*argv)) {          /*
                         if ( ! roffdata(tree, i++, *argv++))           * Expand macro arguments.
                                 return(0);           */
           *szp = 0;
           n1 = cp = mandoc_strdup(r->current_string);
           while (NULL != (cp = strstr(cp, "\\$"))) {
                   i = cp[2] - '1';
                   if (0 > i || 8 < i) {
                           /* Not an argument invocation. */
                           cp += 2;
                         continue;                          continue;
                 }                  }
   
                 i = 1;                  *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
                 for (j = 0; argv[j]; j++)                  n2 = mandoc_malloc(*szp);
                         if ( ! roffispunct(argv[j]))  
                                 break;  
   
                 if (argv[j]) {                  strlcpy(n2, n1, (size_t)(cp - n1 + 1));
                         if (ROFF_LSCOPE & tokens[tok].flags) {                  strlcat(n2, arg[i], *szp);
                                 if ( ! roffdata(tree, 0, *argv++))                  strlcat(n2, cp + 3, *szp);
                                         return(0);  
                                 continue;  
                         }  
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                 return(0);  
                         if ( ! roffdata(tree, 0, *argv++))  
                                 return(0);  
                         if ( ! (*tree->cb.roffin)(tree->arg, tok,  
                                                 argcp,  
                                                 (const char **)argvp))  
                                 return(0);  
   
                         i = 0;                  cp = n2 + (cp - n1);
                         continue;                  free(n1);
                 }                  n1 = n2;
   
                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                         return(0);  
                 break;  
         }          }
   
         if (NULL == *argv)          /*
                 return((*tree->cb.roffout)(tree->arg, tok));           * Replace the macro invocation
         if ( ! first)           * by the expanded macro.
                 return(1);           */
           free(*bufp);
           *bufp = n1;
           if (0 == *szp)
                   *szp = strlen(*bufp) + 1;
   
         return(roffpurgepunct(tree, argv));          return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
              ROFF_REPARSE : ROFF_APPEND);
 }  }
   
   /*
 /* ARGSUSED */   * Store *string into the user-defined string called *name.
 static int   * In multiline mode, append to an existing entry and append '\n';
 roff_noop(ROFFCALL_ARGS)   * else replace the existing entry, if there is one.
    * To clear an existing entry, call with (*r, *name, NULL, 0).
    */
   static void
   roff_setstr(struct roff *r, const char *name, const char *string,
           int multiline)
 {  {
           struct roffstr   *n;
           char             *c;
           size_t            oldch, newch;
   
         return(1);          /* Search for an existing string with the same name. */
 }          n = r->first_string;
           while (n && strcmp(name, n->name))
                   n = n->next;
   
           if (NULL == n) {
                   /* Create a new string table entry. */
                   n = mandoc_malloc(sizeof(struct roffstr));
                   n->name = mandoc_strdup(name);
                   n->string = NULL;
                   n->next = r->first_string;
                   r->first_string = n;
           } else if (0 == multiline) {
                   /* In multiline mode, append; else replace. */
                   free(n->string);
                   n->string = NULL;
           }
   
 /* ARGSUSED */          if (NULL == string)
 static int                  return;
 roff_depr(ROFFCALL_ARGS)  
 {  
   
         return(roff_errp(tree, *argv, tok, ERR_DEPREC));          /*
 }           * One additional byte for the '\n' in multiline mode,
            * and one for the terminating '\0'.
            */
           newch = strlen(string) + (multiline ? 2 : 1);
           if (NULL == n->string) {
                   n->string = mandoc_malloc(newch);
                   *n->string = '\0';
                   oldch = 0;
           } else {
                   oldch = strlen(n->string);
                   n->string = mandoc_realloc(n->string, oldch + newch);
           }
   
           /* Skip existing content in the destination buffer. */
           c = n->string + oldch;
   
 static int          /* Append new content to the destination buffer. */
 roff_warnp(const struct rofftree *tree, const char *pos,          while (*string) {
                 int tok, enum rofferr type)                  /*
 {                   * Rudimentary roff copy mode:
         char             *p;                   * Handle escaped backslashes.
                    */
         switch (type) {                  if ('\\' == *string && '\\' == *(string + 1))
         case (WRN_SECORD):                          string++;
                 p = "section at `%s' out of order";                  *c++ = *string++;
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
         return(roff_warn(tree, pos, p, toknames[tok]));          /* Append terminating bytes. */
           if (multiline)
                   *c++ = '\n';
           *c = '\0';
 }  }
   
   
 static int  static const char *
 roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)  roff_getstrn(const struct roff *r, const char *name, size_t len)
 {  {
         va_list          ap;          const struct roffstr *n;
         char             buf[128];  
   
         va_start(ap, fmt);          n = r->first_string;
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);          while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))
         va_end(ap);                  n = n->next;
   
         return((*tree->cb.roffmsg)(tree->arg,          return(n ? n->string : NULL);
                                 ROFF_WARN, tree->cur, pos, buf));  
 }  }
   
   
 static int  static void
 roff_errp(const struct rofftree *tree, const char *pos,  roff_freestr(struct roff *r)
                 int tok, enum rofferr type)  
 {  {
         char             *p;          struct roffstr   *n, *nn;
   
         switch (type) {          for (n = r->first_string; n; n = nn) {
         case (ERR_ARGEQ1):                  free(n->name);
                 p = "`%s' expects exactly one argument";                  free(n->string);
                 break;                  nn = n->next;
         case (ERR_ARGEQ0):                  free(n);
                 p = "`%s' expects exactly zero arguments";  
                 break;  
         case (ERR_ARGGE1):  
                 p = "`%s' expects one or more arguments";  
                 break;  
         case (ERR_ARGGE2):  
                 p = "`%s' expects two or more arguments";  
                 break;  
         case (ERR_BADARG):  
                 p = "invalid argument for `%s'";  
                 break;  
         case (ERR_NOTSUP):  
                 p = "macro `%s' is not supported";  
                 break;  
         case(ERR_PR_OOO):  
                 p = "prelude macro `%s' is out of order";  
                 break;  
         case(ERR_PR_REP):  
                 p = "prelude macro `%s' repeated";  
                 break;  
         case(ERR_ARGLEN):  
                 p = "macro argument for `%s' is too long";  
                 break;  
         case(ERR_DEPREC):  
                 p = "macro `%s' is deprecated";  
                 break;  
         case(ERR_NOT_PR):  
                 p = "macro `%s' disallowed in prelude";  
                 break;  
         case(ERR_ARGMNY):  
                 p = "too many arguments for macro `%s'";  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
         return(roff_err(tree, pos, p, toknames[tok]));          r->first_string = NULL;
 }  }
   
   
 static int  
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  
 {  
         va_list          ap;  
         char             buf[128];  
   
         va_start(ap, fmt);  
         if (-1 == vsnprintf(buf, sizeof(buf), fmt, ap))  
                 err(1, "vsnprintf");  
         va_end(ap);  
   
         return((*tree->cb.roffmsg)  
                         (tree->arg, ROFF_ERROR, tree->cur, pos, buf));  
 }  
   
Legend:
Removed from v.1.58  
changed lines
  Added in v.1.107
CVSweb