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

Diff for /mandoc/roff.c between version 1.64 and 1.152

version 1.64, 2008/12/12 10:11:10 version 1.152, 2011/07/26 14:09:01
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2011 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 <ctype.h>  #include <ctype.h>
 #include <err.h>  
 #include <stdarg.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  
   
 #include "private.h"  #include "mandoc.h"
 #include "roff.h"  #include "libroff.h"
   #include "libmandoc.h"
   
 /* FIXME: First letters of quoted-text interpreted in rofffindtok. */  /* Maximum number of nested if-else conditionals. */
 /* FIXME: `No' not implemented. */  #define RSTACK_MAX      128
 /* 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? */  
 /* FIXME: Bl -diag supposed to ignore callable children. */  
   
 struct  roffnode {  enum    rofft {
         int               tok;          /* Token id. */          ROFF_ad,
         struct roffnode  *parent;       /* Parent (or NULL). */          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_it,
           ROFF_ne,
           ROFF_nh,
           ROFF_nr,
           ROFF_ns,
           ROFF_ps,
           ROFF_rm,
           ROFF_so,
           ROFF_ta,
           ROFF_tr,
           ROFF_TS,
           ROFF_TE,
           ROFF_T_,
           ROFF_EQ,
           ROFF_EN,
           ROFF_cblock,
           ROFF_ccond,
           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. */   * A single register entity.  If "set" is zero, the value of the
         char             *cur;                  /* Line start. */   * register should be the default one, which is per-register.
         struct tm         tm;                   /* `Dd' results. */   * Registers are assumed to be unsigned ints for now.
         char              name[64];             /* `Nm' results. */   */
         char              os[64];               /* `Os' results. */  struct  reg {
         char              title[64];            /* `Dt' results. */          int               set; /* whether set or not */
         enum roffmsec     section;          unsigned int      u; /* unsigned integer */
         enum roffvol      volume;  
         struct roffcb     cb;                   /* Callbacks. */  
         void             *arg;                  /* Callbacks' arg. */  
         int               csec;                 /* Current section. */  
         int               asec;                 /* Thus-far sections. */  
         int               literal;              /* Literal mode. */  
 };  };
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  struct  roffstr {
 static  void              roffnode_free(struct rofftree *);          char            *name; /* key of symbol */
 static  int               roff_warn(const struct rofftree *,          char            *string; /* current value */
                                 const char *, char *, ...);          struct roffstr  *next; /* next in list */
 static  int               roff_warnp(const struct rofftree *,  };
                                 const char *, int, enum rofferr);  
 static  int               roff_err(const struct rofftree *,  
                                 const char *, char *, ...);  
 static  int               roff_errp(const struct rofftree *,  
                                 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, 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  roff {
 extern  size_t            strlcat(char *, const char *, size_t);          struct mparse   *parse; /* parse point */
 extern  size_t            strlcpy(char *, const char *, size_t);          struct roffnode *last; /* leaf of stack */
 extern  int               vsnprintf(char *, size_t,          enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
                                 const char *, va_list);          int              rstackpos; /* position in rstack */
 extern  char             *strptime(const char *, const char *,          struct reg       regs[REG__MAX];
                                 struct tm *);          struct roffstr  *first_string; /* user-defined strings & macros */
 #endif          const char      *current_string; /* value of last called user macro */
           struct tbl_node *first_tbl; /* first table parsed */
           struct tbl_node *last_tbl; /* last table parsed */
           struct tbl_node *tbl; /* current table being parsed */
           struct eqn_node *last_eqn; /* last equation parsed */
           struct eqn_node *first_eqn; /* first equation parsed */
           struct eqn_node *eqn; /* current equation being parsed */
   };
   
 int  struct  roffnode {
 roff_free(struct rofftree *tree, int flush)          enum rofft       tok; /* type of node */
 {          struct roffnode *parent; /* up one in stack */
         int              error, t;          int              line; /* parse line */
         struct roffnode *n;          int              col; /* parse col */
           char            *name; /* node name, e.g. macro name */
           char            *end; /* end-rules: custom token */
           int              endspan; /* end-rules: next-line or infty */
           enum roffrule    rule; /* current evaluation rule */
   };
   
         error = 0;  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
                            enum rofft tok, /* tok of macro */ \
                            char **bufp, /* input buffer */ \
                            size_t *szp, /* size of input buffer */ \
                            int ln, /* parse line */ \
                            int ppos, /* original pos in buffer */ \
                            int pos, /* current pos in buffer */ \
                            int *offs /* reset offset of buffer data */
   
         if ( ! flush)  typedef enum rofferr (*roffproc)(ROFF_ARGS);
                 goto end;  
   
         error = 1;  struct  roffmac {
           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;
   };
   
         if ( ! (ROFFSec_NAME & tree->asec)) {  struct  predef {
                 (void)roff_err(tree, NULL, "missing `NAME' section");          const char      *name; /* predefined input name */
                 goto end;          const char      *str; /* replacement symbol */
         } 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 PREDEF(__name, __str) \
                 if (0 != tokens[n->tok].ctx)          { (__name), (__str) },
                         continue;  
                 (void)roff_err(tree, NULL, "closing explicit scope "  
                                 "`%s'", toknames[n->tok]);  
                 goto end;  
         }  
   
         while (tree->last) {  static  enum rofferr     roff_block(ROFF_ARGS);
                 t = tree->last->tok;  static  enum rofferr     roff_block_text(ROFF_ARGS);
                 if ( ! roffexit(tree, t))  static  enum rofferr     roff_block_sub(ROFF_ARGS);
                         goto end;  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  char            *roff_getname(struct roff *, char **, int, int);
   static  const char      *roff_getstrn(const struct roff *,
                                   const char *, size_t);
   static  enum rofferr     roff_line_ignore(ROFF_ARGS);
   static  enum rofferr     roff_nr(ROFF_ARGS);
   static  int              roff_res(struct roff *,
                                   char **, size_t *, int, int);
   static  enum rofferr     roff_rm(ROFF_ARGS);
   static  void             roff_setstr(struct roff *,
                                   const char *, const char *, int);
   static  enum rofferr     roff_so(ROFF_ARGS);
   static  enum rofferr     roff_TE(ROFF_ARGS);
   static  enum rofferr     roff_TS(ROFF_ARGS);
   static  enum rofferr     roff_EQ(ROFF_ARGS);
   static  enum rofferr     roff_EN(ROFF_ARGS);
   static  enum rofferr     roff_T_(ROFF_ARGS);
   static  enum rofferr     roff_userdef(ROFF_ARGS);
   
         if ( ! (*tree->cb.rofftail)(tree->arg, &tree->tm,  /* See roff_hash_find() */
                                 tree->os, tree->title,  
                                 tree->section, tree->volume))  
                 goto end;  
   
         error = 0;  #define ASCII_HI         126
   #define ASCII_LO         33
   #define HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
   
 end:  static  struct roffmac  *hash[HASHWIDTH];
   
         while (tree->last)  static  struct roffmac   roffs[ROFF_MAX] = {
                 roffnode_free(tree);          { "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 },
           { "it", roff_line_ignore, NULL, NULL, 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 },
           { "ns", roff_line_ignore, NULL, NULL, 0, NULL },
           { "ps", roff_line_ignore, NULL, NULL, 0, NULL },
           { "rm", roff_rm, NULL, NULL, 0, NULL },
           { "so", roff_so, NULL, NULL, 0, NULL },
           { "ta", roff_line_ignore, NULL, NULL, 0, NULL },
           { "tr", roff_line_ignore, NULL, NULL, 0, NULL },
           { "TS", roff_TS, NULL, NULL, 0, NULL },
           { "TE", roff_TE, NULL, NULL, 0, NULL },
           { "T&", roff_T_, NULL, NULL, 0, NULL },
           { "EQ", roff_EQ, NULL, NULL, 0, NULL },
           { "EN", roff_EN, NULL, NULL, 0, NULL },
           { ".", roff_cblock, NULL, NULL, 0, NULL },
           { "\\}", roff_ccond, NULL, NULL, 0, NULL },
           { NULL, roff_userdef, NULL, NULL, 0, NULL },
   };
   
         free(tree);  /* Array of injected predefined strings. */
   #define PREDEFS_MAX      38
   static  const struct predef predefs[PREDEFS_MAX] = {
   #include "predefs.in"
   };
   
         return(error ? 0 : 1);  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 *);
   
   /* See roff_hash_find() */
   #define ROFF_HASH(p)    (p[0] - ASCII_LO)
   
 struct rofftree *  static void
 roff_alloc(const struct roffcb *cb, void *args)  roff_hash_init(void)
 {  {
         struct rofftree *tree;          struct roffmac   *n;
           int               buc, i;
   
         assert(args);          for (i = 0; i < (int)ROFF_USERDEF; i++) {
         assert(cb);                  assert(roffs[i].name[0] >= ASCII_LO);
                   assert(roffs[i].name[0] <= ASCII_HI);
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))                  buc = ROFF_HASH(roffs[i].name);
                 err(1, "calloc");  
   
         tree->arg = args;                  if (NULL != (n = hash[buc])) {
         tree->section = ROFF_MSEC_MAX;                          for ( ; n->next; n = n->next)
                                   /* Do nothing. */ ;
                           n->next = &roffs[i];
                   } else
                           hash[buc] = &roffs[i];
           }
   }
   
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));  /*
    * 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)
   {
           int              buc;
           struct roffmac  *n;
   
         return(tree);          /*
            * 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 (p[0] < ASCII_LO || p[0] > ASCII_HI)
                   return(ROFF_MAX);
   
           buc = ROFF_HASH(p);
   
           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(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)          r->last = r->last->parent;
                 return(roff_err(tree, buf, "blank line"));          free(p->name);
         else if ('.' != *buf)          free(p->end);
                 return(textparse(tree, buf));          free(p);
   
         return(roffparse(tree, buf));  
 }  }
   
   
 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 ( ! (ROFFSec_NAME & tree->asec))          r->last = p;
                 return(roff_err(tree, buf, "data before `NAME' section"));  }
   
         if (tree->literal)  
                 return(roffdata(tree, 0, buf));  
   
         /* LINTED */  static void
         while (*buf) {  roff_free1(struct roff *r)
                 while (*buf && isspace(*buf))  {
                         buf++;          struct tbl_node *t;
           struct eqn_node *e;
   
                 if (0 == *buf)          while (NULL != (t = r->first_tbl)) {
                         break;                  r->first_tbl = t->next;
                   tbl_free(t);
           }
   
                 bufp = buf++;          r->first_tbl = r->last_tbl = r->tbl = NULL;
   
                 while (*buf && ! isspace(*buf))          while (NULL != (e = r->first_eqn)) {
                         buf++;                  r->first_eqn = e->next;
                   eqn_free(e);
           }
   
                 if (0 != *buf) {          r->first_eqn = r->last_eqn = r->eqn = NULL;
                         *buf++ = 0;  
                         if ( ! roffdata(tree, 1, bufp))  
                                 return(0);  
                         continue;  
                 }  
   
                 if ( ! roffdata(tree, 1, bufp))          while (r->last)
                         return(0);                  roffnode_pop(r);
                 break;  
         }  
   
         return(1);          roff_freestr(r);
 }  }
   
   
 static int  void
 roffargs(const struct rofftree *tree,  roff_reset(struct roff *r)
                 int tok, char *buf, char **argv)  
 {  {
         int              i;          int              i;
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          roff_free1(r);
         assert('.' == *buf);  
   
         p = buf;          memset(&r->regs, 0, sizeof(struct reg) * REG__MAX);
   
         /*          for (i = 0; i < PREDEFS_MAX; i++)
          * This is an ugly little loop.  It parses a line into                  roff_setstr(r, predefs[i].name, predefs[i].str, 0);
          * space-delimited tokens.  If a quote mark is encountered, a  }
          * token is alloted the entire quoted text.  If whitespace is  
          * escaped, it's included in the prior alloted token.  
          */  
   
         /* LINTED */  
         for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) {  
                 if ('\"' == *buf) {  
                         argv[i] = ++buf;  
                         while (*buf && '\"' != *buf)  
                                 buf++;  
                         if (0 == *buf)  
                                 return(roff_err(tree, argv[i],  
                                         "unclosed quote in arg list"));  
                 } else {  
                         argv[i] = buf++;  
                         while (*buf) {  
                                 if ( ! isspace(*buf)) {  
                                         buf++;  
                                         continue;  
                                 }  
                                 if (*(buf - 1) == '\\') {  
                                         buf++;  
                                         continue;  
                                 }  
                                 break;  
                         }  
                         if (0 == *buf)  
                                 continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  void
         if (ROFF_MAXLINEARG == i && *buf)  roff_free(struct roff *r)
                 return(roff_err(tree, p, "too many args"));  {
   
         argv[i] = NULL;          roff_free1(r);
         return(1);          free(r);
 }  }
   
   
 static int  struct roff *
 roffscan(int tok, const int *tokv)  roff_alloc(struct mparse *parse)
 {  {
           struct roff     *r;
           int              i;
   
         if (NULL == tokv)          r = mandoc_calloc(1, sizeof(struct roff));
                 return(1);          r->parse = parse;
           r->rstackpos = -1;
   
           roff_hash_init();
   
         for ( ; ROFF_MAX != *tokv; tokv++)          for (i = 0; i < PREDEFS_MAX; i++)
                 if (tok == *tokv)                  roff_setstr(r, predefs[i].name, predefs[i].str, 0);
                         return(1);  
   
         return(0);          return(r);
 }  }
   
   
   /*
    * Pre-filter each and every line for reserved words (one beginning with
    * `\*', e.g., `\*(ab').  These must be handled before the actual line
    * is processed.
    */
 static int  static int
 roffparse(struct rofftree *tree, char *buf)  roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
 {  {
         int               tok, t;          enum mandoc_esc  esc;
         struct roffnode  *n;          const char      *stesc; /* start of an escape sequence ('\\') */
         char             *argv[ROFF_MAXLINEARG];          const char      *stnam; /* start of the name, after "[(*" */
         char            **argvp;          const char      *cp;    /* end of the name, e.g. before ']' */
           const char      *res;   /* the string to be substituted */
           int              i, maxl;
           size_t           nsz;
           char            *n;
   
         if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))          /* Search for a leading backslash and save a pointer to it. */
                 if (0 == strncmp(buf, ".\\\"", 3))  
                         return(1);  
   
         if (ROFF_MAX == (tok = rofffindtok(buf + 1)))          cp = *bufp + pos;
                 return(roff_err(tree, buf, "bogus line macro"));          while (NULL != (cp = strchr(cp, '\\'))) {
         else if ( ! roffargs(tree, tok, buf, argv))                  stesc = cp++;
                 return(0);  
   
         argvp = (char **)argv;                  /*
                    * The second character must be an asterisk.
                    * If it isn't, skip it anyway:  It is escaped,
                    * so it can't start another escape sequence.
                    */
   
         /*                  if ('\0' == *cp)
          * Prelude macros break some assumptions, so branch now.                          return(1);
          */  
   
         if ( ! (ROFFSec_PR_Dd & tree->asec)) {  
                 assert(NULL == tree->last);  
                 return(roffcall(tree, tok, argvp));  
         }  
   
         /*                  if ('*' != *cp) {
          * First check that our possible parents and parent's possible                          res = cp;
          * children are satisfied.                          esc = mandoc_escape(&cp, NULL, NULL);
          */                          if (ESCAPE_ERROR != esc)
                                   continue;
                           mandoc_msg(MANDOCERR_BADESCAPE,
                                           r->parse, ln, pos, NULL);
                           cp = res;
                           continue;
                   }
   
         if (tree->last && ! roffscan                  cp++;
                         (tree->last->tok, tokens[tok].parents))  
                 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))                   * The third character decides the length
                 return(roff_err(tree, *argvp, "`%s' has invalid "                   * of the name of the string.
                                         "child `%s'", toknames[tok],                   * Save a pointer to the name.
                                         toknames[tree->last->tok]));                   */
   
         /*                  switch (*cp) {
          * Branch if we're not a layout token.                  case ('\0'):
          */                          return(1);
                   case ('('):
                           cp++;
                           maxl = 2;
                           break;
                   case ('['):
                           cp++;
                           maxl = 0;
                           break;
                   default:
                           maxl = 1;
                           break;
                   }
                   stnam = cp;
   
         if (ROFF_LAYOUT != tokens[tok].type)                  /* Advance to the end of the name. */
                 return(roffcall(tree, tok, argvp));  
         if (0 == tokens[tok].ctx)  
                 return(roffcall(tree, tok, argvp));  
   
         /*                  for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
          * First consider implicit-end tags, like as follows:                          if ('\0' == *cp)
          *      .Sh SECTION 1                                  return(1); /* Error. */
          *      .Sh SECTION 2                          if (0 == maxl && ']' == *cp)
          * 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) {  
                 /*  
                  * First search up to the point where we must close.  
                  * If one doesn't exist, then we can open a new scope.  
                  */  
   
                 for (n = tree->last; n; n = n->parent) {  
                         assert(0 == tokens[n->tok].ctx ||  
                                         n->tok == tokens[n->tok].ctx);  
                         if (n->tok == tok)  
                                 break;                                  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                   * Retrieve the replacement string; if it is
                  * close out.                   * undefined, resume searching for escapes.
                  */                   */
   
                 if (NULL == n)                  res = roff_getstrn(r, stnam, (size_t)i);
                         return(roffcall(tree, tok, argvp));  
   
                 /*                  if (NULL == res) {
                  * Close out all intermediary scoped blocks, then hang                          /* TODO: keep track of the correct position. */
                  * the current scope from our predecessor's parent.                          mandoc_msg(MANDOCERR_BADESCAPE, r->parse, ln, pos, NULL);
                  */                          res = "";
                   }
   
                 do {                  /* Replace the escape sequence by the string. */
                         t = tree->last->tok;  
                         if ( ! roffexit(tree, t))  
                                 return(0);  
                 } while (t != tok);  
   
                 return(roffcall(tree, tok, argvp));                  nsz = *szp + strlen(res) + 1;
         }                  n = mandoc_malloc(nsz);
   
         /*                  strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
          * Now consider explicit-end tags, where we want to close back                  strlcat(n, res, nsz);
          * to a specific tag.  Example:                  strlcat(n, cp + (maxl ? 0 : 1), nsz);
          *      .Bl  
          *      .It Item.  
          *      .El  
          * In this, the `El' tag closes out the scope of `Bl'.  
          */  
   
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);                  free(*bufp);
   
         /* LINTED */                  *bufp = n;
         for (n = tree->last; n; n = n->parent)                  *szp = nsz;
                 if (n->tok != tokens[tok].ctx) {                  return(0);
                         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)  
                 return(roff_err(tree, *argv, "`%s' has no starting "  
                                         "tag `%s'", toknames[tok],  
                                         toknames[tokens[tok].ctx]));  
   
         /* LINTED */  
         do {  
                 t = tree->last->tok;  
                 if ( ! roffexit(tree, t))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         return(1);          return(1);
 }  }
   
   
 static int  enum rofferr
 rofffindarg(const char *name)  roff_parseln(struct roff *r, int ln, char **bufp,
                   size_t *szp, int pos, int *offs)
 {  {
         size_t           i;          enum rofft       t;
           enum rofferr     e;
           int              ppos, ctl;
   
         /* FIXME: use a table, this is slow but ok for now. */          /*
            * Run the reserved-word filter only if we have some reserved
            * words to fill in.
            */
   
         /* LINTED */          if (r->first_string && ! roff_res(r, bufp, szp, ln, pos))
         for (i = 0; i < ROFF_ARGMAX; i++)                  return(ROFF_REPARSE);
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  
   
           ppos = pos;
           ctl = mandoc_getcontrol(*bufp, &pos);
   
 static int          /*
 rofffindtok(const char *buf)           * 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
         char             token[4];           * we're not a macro, just let it through.
         int              i;           * Finally, if there's an equation scope open, divert it into it
            * no matter our state.
            */
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)          if (r->last && ! ctl) {
                 token[i] = *buf;                  t = r->last->tok;
                   assert(roffs[t].text);
                   e = (*roffs[t].text)
                           (r, t, bufp, szp, ln, pos, pos, offs);
                   assert(ROFF_IGN == e || ROFF_CONT == e);
                   if (ROFF_CONT != e)
                           return(e);
                   if (r->eqn)
                           return(eqn_read(&r->eqn, ln, *bufp, pos, offs));
                   if (r->tbl)
                           return(tbl_read(r->tbl, ln, *bufp, pos));
                   return(ROFF_CONT);
           } else if ( ! ctl) {
                   if (r->eqn)
                           return(eqn_read(&r->eqn, ln, *bufp, pos, offs));
                   if (r->tbl)
                           return(tbl_read(r->tbl, ln, *bufp, pos));
                   return(ROFF_CONT);
           } else if (r->eqn)
                   return(eqn_read(&r->eqn, ln, *bufp, ppos, offs));
   
         if (i == 3)          /*
                 return(ROFF_MAX);           * If a scope is open, go to the child handler for that macro,
            * as it may want to preprocess before doing anything with it.
            * Don't do so if an equation is open.
            */
   
         token[i] = 0;          if (r->last) {
                   t = r->last->tok;
                   assert(roffs[t].sub);
                   return((*roffs[t].sub)
                                   (r, t, bufp, szp,
                                    ln, ppos, pos, offs));
           }
   
         /* FIXME: use a table, this is slow but ok for now. */          /*
            * Lastly, as we've no scope open, try to look up and execute
            * the new macro.  If no macro is found, simply return and let
            * the compilers handle it.
            */
   
         /* LINTED */          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
         for (i = 0; i < ROFF_MAX; i++)                  return(ROFF_CONT);
                 /* LINTED */  
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);          assert(roffs[t].proc);
           return((*roffs[t].proc)
                           (r, t, bufp, szp,
                            ln, ppos, pos, offs));
 }  }
   
   
 static int  void
 roffchecksec(struct rofftree *tree,  roff_endparse(struct roff *r)
                 const char *start, int sec, int fail)  
 {  {
   
         switch (sec) {          if (r->last)
         case(ROFFSec_PR_Dd):                  mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                 return(1);                                  r->last->line, r->last->col, NULL);
         case(ROFFSec_PR_Dt):  
                 if (ROFFSec_PR_Dd & tree->asec)          if (r->eqn) {
                         return(1);                  mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                 break;                                  r->eqn->eqn.ln, r->eqn->eqn.pos, NULL);
         case(ROFFSec_PR_Os):                  eqn_end(&r->eqn);
                 if (ROFFSec_PR_Dt & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_NAME):  
                 if (ROFFSec_PR_Os & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SYNOP):  
                 if (ROFFSec_NAME & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DESC):  
                 if (ROFFSec_SYNOP & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_RETVAL):  
                 if (ROFFSec_DESC & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ENV):  
                 if (ROFFSec_RETVAL & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_FILES):  
                 if (ROFFSec_ENV & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_EX):  
                 if (ROFFSec_FILES & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DIAG):  
                 if (ROFFSec_EX & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ERRS):  
                 if (ROFFSec_DIAG & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SEEALSO):  
                 if (ROFFSec_ERRS & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_STAND):  
                 if (ROFFSec_SEEALSO & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_HIST):  
                 if (ROFFSec_STAND & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_AUTH):  
                 if (ROFFSec_HIST & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_CAVEATS):  
                 if (ROFFSec_AUTH & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_BUGS):  
                 if (ROFFSec_CAVEATS & tree->asec)  
                         return(1);  
                 break;  
         default:  
                 return(1);  
         }          }
   
         if (fail)          if (r->tbl) {
                 return(0);                  mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
         return(roff_warnp(tree, start, ROFF_Sh, WRN_SECORD));                                  r->tbl->line, r->tbl->pos, NULL);
                   tbl_end(&r->tbl);
           }
 }  }
   
   /*
 static int   * Parse a roff node's type from the input buffer.  This must be in the
 roffispunct(const char *p)   * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(struct roff *r, const char *buf, int *pos)
 {  {
           const char      *mac;
           size_t           maclen;
           enum rofft       t;
   
         if (0 == *p)          if ('\0' == buf[*pos] || '"' == buf[*pos] ||
                 return(0);                          '\t' == buf[*pos] || ' ' == buf[*pos])
         if (0 != *(p + 1))                  return(ROFF_MAX);
                 return(0);  
   
         switch (*p) {          /*
         case('{'):           * We stop the macro parse at an escape, tab, space, or nil.
                 /* FALLTHROUGH */           * However, `\}' is also a valid macro, so make sure we don't
         case('.'):           * clobber it by seeing the `\' as the end of token.
                 /* FALLTHROUGH */           */
         case(','):  
                 /* FALLTHROUGH */  
         case(';'):  
                 /* FALLTHROUGH */  
         case(':'):  
                 /* FALLTHROUGH */  
         case('?'):  
                 /* FALLTHROUGH */  
         case('!'):  
                 /* FALLTHROUGH */  
         case('('):  
                 /* FALLTHROUGH */  
         case(')'):  
                 /* FALLTHROUGH */  
         case('['):  
                 /* FALLTHROUGH */  
         case(']'):  
                 /* FALLTHROUGH */  
         case('}'):  
                 return(1);  
         default:  
                 break;  
         }  
   
         return(0);          mac = buf + *pos;
 }          maclen = strcspn(mac + 1, " \\\t\0") + 1;
   
           t = (r->current_string = roff_getstrn(r, mac, maclen))
               ? ROFF_USERDEF : roff_hash_find(mac, maclen);
   
 static int          *pos += (int)maclen;
 rofffindcallable(const char *name)  
 {  
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))          while (buf[*pos] && ' ' == buf[*pos])
                 return(ROFF_MAX);                  (*pos)++;
         assert(c >= 0 && c < ROFF_MAX);  
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);          return(t);
 }  }
   
   /* ARGSUSED */
 static struct roffnode *  static enum rofferr
 roffnode_new(int tokid, struct rofftree *tree)  roff_cblock(ROFF_ARGS)
 {  {
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode))))  
                 err(1, "malloc");  
   
         p->tok = tokid;          /*
         p->parent = tree->last;           * A block-close `..' should only be invoked as a child of an
         tree->last = p;           * ignore macro, otherwise raise a warning and just ignore it.
            */
   
         return(p);          if (NULL == r->last) {
 }                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
           switch (r->last->tok) {
           case (ROFF_am):
                   /* FALLTHROUGH */
           case (ROFF_ami):
                   /* FALLTHROUGH */
           case (ROFF_am1):
                   /* FALLTHROUGH */
           case (ROFF_de):
                   /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
                   /* FALLTHROUGH */
           case (ROFF_dei):
                   /* FALLTHROUGH */
           case (ROFF_ig):
                   break;
           default:
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
 static int          if ((*bufp)[pos])
 roffargok(int tokid, int argid)                  mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
 {  
         const int       *c;  
   
         if (NULL == (c = tokens[tokid].args))          roffnode_pop(r);
                 return(0);          roffnode_cleanscope(r);
           return(ROFF_IGN);
   
         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):                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                 if (0 == sz)                  return(ROFF_IGN);
                         break;          }
                 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:
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
         }          }
   
         return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur,          if (r->last->endspan > -1) {
                                 argc, argv, (const char **)ordp));                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
 }                  return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
   
 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 !=                          mandoc_msg(MANDOCERR_NOARGS, r->parse, 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
                           mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos,
                               roffs[tok].name);
   
 static int                  while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
 roffnextopt(const struct rofftree *tree, int tok,                          pos++;
                 char ***in, char **val)  
 {  
         char            *arg, **argv;  
         int              v;  
   
         *val = NULL;                  while (isspace((unsigned char)(*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, "", 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] && ! isspace((unsigned char)(*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])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, 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 (ROFFSec_PR_Os & tree->asec)  
                 return(roff_text(tok, tree, argv, type));  
         if (ROFFSec_PR_Dd & tree->asec)  
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));  
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dd, 1))  
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         assert(NULL == tree->last);  
         argv++;  
         tree->asec |= (tree->csec = ROFFSec_PR_Dd);  
   
         /*          /*
          * This is a bit complex because there are many forms the date           * First check whether a custom macro exists at this level.  If
          * can be in:  it can be simply $Mdocdate$, $Mdocdate <date>$,           * it does, then check against it.  This is some of groff's
          * or a raw date.  Process accordingly.           * 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.
          */           */
   
         if (0 == strcmp(*argv, "$Mdocdate$")) {          if (r->last->end) {
                 t = time(NULL);                  for (i = pos, j = 0; r->last->end[j]; j++, i++)
                 if (NULL == localtime_r(&t, &tree->tm))                          if ((*bufp)[i] != r->last->end[j])
                         err(1, "localtime_r");                                  break;
                 return(1);  
         }  
   
         buf[0] = 0;                  if ('\0' == r->last->end[j] &&
         p = *argv;                                  ('\0' == (*bufp)[i] ||
         sz = sizeof(buf);                                   ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
         if (0 != strcmp(*argv, "$Mdocdate:")) {                          while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                 while (*argv) {                                  i++;
                         if (strlcat(buf, *argv++, sz) < sz)  
                                 continue;                          pos = i;
                         return(roff_errp(tree, p, tok, ERR_BADARG));                          if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                   return(ROFF_RERUN);
                           return(ROFF_IGN);
                 }                  }
                 if (strptime(buf, "%b%d,%Y", &tree->tm))  
                         return(1);  
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
         }          }
   
         argv++;          /*
            * If we have no custom end-query or lookup failed, then try
            * pulling it out of the hashtable.
            */
   
         while (*argv && **argv != '$') {          t = roff_parse(r, *bufp, &pos);
                 if (strlcat(buf, *argv++, sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_BADARG));          /*
                 if (strlcat(buf, " ", sz) >= sz)           * Macros other than block-end are only significant
                         return(roff_errp(tree, p, tok, ERR_BADARG));           * in `de' blocks; elsewhere, simply throw them away.
            */
           if (ROFF_cblock != t) {
                   if (ROFF_de == tok)
                           roff_setstr(r, r->last->name, *bufp + ppos, 1);
                   return(ROFF_IGN);
         }          }
   
         if (NULL == *argv)          assert(roffs[t].proc);
                 return(roff_errp(tree, p, tok, ERR_BADARG));          return((*roffs[t].proc)(r, t, bufp, szp,
         if (NULL == strptime(buf, "%b %d %Y", &tree->tm))                                  ln, ppos, pos, offs));
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_block_text(ROFF_ARGS)
 {  {
         size_t           sz;  
   
         if (ROFFSec_PR_Os & tree->asec)          if (ROFF_de == tok)
                 return(roff_text(tok, tree, argv, type));                  roff_setstr(r, r->last->name, *bufp + pos, 1);
         if (ROFFSec_PR_Dt & tree->asec)  
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));  
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dt, 1))  
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         argv++;          return(ROFF_IGN);
         tree->asec |= (tree->csec = ROFFSec_PR_Dt);  }
         sz = sizeof(tree->title);  
   
         if (NULL == *argv)  
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));  
         if (strlcpy(tree->title, *argv, sz) >= sz)  
                 return(roff_errp(tree, *argv, tok, ERR_ARGLEN));  
   
         argv++;  /* ARGSUSED */
         if (NULL == *argv)  static enum rofferr
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));  roff_cond_sub(ROFF_ARGS)
   {
           enum rofft       t;
           enum roffrule    rr;
           char            *ep;
   
         if (ROFF_MSEC_MAX == (tree->section = roff_msec(*argv)))          rr = r->last->rule;
                 return(roff_errp(tree, *argv, tok, ERR_BADARG));          roffnode_cleanscope(r);
   
         argv++;          /*
            * If the macro is unknown, first check if it contains a closing
            * delimiter `\}'.  If it does, close out our scope and return
            * the currently-scoped rule (ignore or continue).  Else, drop
            * into the currently-scoped rule.
            */
   
         if (NULL == *argv) {          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
                 switch (tree->section) {                  ep = &(*bufp)[pos];
                 case(ROFF_MSEC_1):                  for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
                         /* FALLTHROUGH */                          ep++;
                 case(ROFF_MSEC_6):                          if ('}' != *ep)
                         /* FALLTHROUGH */                                  continue;
                 case(ROFF_MSEC_7):  
                         tree->volume = ROFF_VOL_URM;  
                         break;  
                 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);                          /*
                            * Make the \} go away.
                            * This is a little haphazard, as it's not quite
                            * clear how nroff does this.
                            * If we're at the end of line, then just chop
                            * off the \} and resize the buffer.
                            * If we aren't, then conver it to spaces.
                            */
   
         return(1);                          if ('\0' == *(ep + 1)) {
 }                                  *--ep = '\0';
                                   *szp -= 2;
                           } else
                                   *(ep - 1) = *ep = ' ';
   
                           roff_ccond(r, ROFF_ccond, bufp, szp,
                                           ln, pos, pos + 2, offs);
                           break;
                   }
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
           }
   
 static int          /*
 roffsetname(struct rofftree *tree, char **ordp)           * A denied conditional must evaluate its children if and only
 {           * if they're either structurally required (such as loops and
         size_t           sz;           * conditionals) or a closing macro.
            */
         assert(*ordp);  
   
         /* FIXME: not all sections can set this. */          if (ROFFRULE_DENY == rr)
                   if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
         if (NULL != *(ordp + 1))          assert(roffs[t].proc);
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGMNY));          return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
         sz = sizeof(tree->name);  
         if (strlcpy(tree->name, *ordp, sz) >= sz)  
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGLEN));  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Ns(ROFFCALL_ARGS)  roff_cond_text(ROFF_ARGS)
 {  {
         int              j, c, first;          char            *ep;
         char            *morep[1];          enum roffrule    rr;
   
         first = (*argv++ == tree->cur);          rr = r->last->rule;
         morep[0] = NULL;          roffnode_cleanscope(r);
   
         if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))          ep = &(*bufp)[pos];
                 return(0);          for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
                   ep++;
         while (*argv) {                  if ('}' != *ep)
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  
                         if ( ! roffcall(tree, c, argv))  
                                 return(0);  
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {  
                         if ( ! roffdata(tree, 1, *argv++))  
                                 return(0);  
                         continue;                          continue;
                 }                  *ep = '&';
                   roff_ccond(r, ROFF_ccond, bufp, szp,
                                   ln, pos, pos + 2, offs);
           }
           return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   }
   
                 for (j = 0; argv[j]; j++)  static enum roffrule
                         if ( ! roffispunct(argv[j]))  roff_evalcond(const char *v, int *pos)
                                 break;  {
   
                 if (argv[j]) {          switch (v[*pos]) {
                         if ( ! roffdata(tree, 0, *argv++))          case ('n'):
                                 return(0);                  (*pos)++;
                         continue;                  return(ROFFRULE_ALLOW);
                 }          case ('e'):
                   /* FALLTHROUGH */
           case ('o'):
                   /* FALLTHROUGH */
           case ('t'):
                   (*pos)++;
                   return(ROFFRULE_DENY);
           default:
                 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 (ROFFSec_PR_Os & tree->asec)          if (ROFF_it == tok)
                 return(roff_text(tok, tree, argv, type));                  mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos, "it");
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Os, 1))  
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         p = *++argv;          return(ROFF_IGN);
         sz = sizeof(tree->os);  
         tree->asec |= (tree->csec = ROFFSec_PR_Os);  
   
         tree->os[0] = 0;  
   
         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));  
   
         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], *p;          enum roffrule    rule;
   
         /*          /*
          * The roff_layout function is for multi-line macros.  A layout           * An `.el' has no conditional body: it will consume the value
          * has a start and end point, which is either declared           * of the current rstack entry set in prior `ie' calls or
          * explicitly or implicitly.  An explicit start and end is           * defaults to DENY.
          * embodied by `.Bl' and `.El', with the former being the start           *
          * and the latter being an end.  The `.Sh' and `.Ss' tags, on           * If we're not an `el', however, then evaluate the conditional.
          * 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));          rule = ROFF_el == tok ?
                   (r->rstackpos < 0 ?
                    ROFFRULE_DENY : r->rstack[r->rstackpos--]) :
                   roff_evalcond(*bufp, &pos);
   
         if ( ! (ROFFSec_PR_Os & tree->asec))          sv = pos;
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));          while (' ' == (*bufp)[pos])
                   pos++;
   
         if (ROFF_EXIT == type) {  
                 roffnode_free(tree);  
                 if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))  
                         return(0);  
                 return((*tree->cb.roffblkout)(tree->arg, tok));  
         }  
   
         p = *argv++;  
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));  
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  
                 return(0);  
         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))                  mandoc_msg(MANDOCERR_NOARGS, r->parse, 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_Bd):  
                 tree->literal++;  
                 break;  
   
         case (ROFF_Sh):          /*
                 if (NULL == *argv) {           * An if-else will put the NEGATION of the current evaluated
                         argv--;           * conditional into the stack of rules.
                         return(roff_errp(tree, *argv, tok, ERR_ARGGE1));           */
                 }  
   
                 tree->csec = roff_sec((const char **)argv);          if (ROFF_ie == tok) {
                   if (r->rstackpos == RSTACK_MAX - 1) {
                 if ( ! (ROFFSec_OTHER & tree->csec) &&                          mandoc_msg(MANDOCERR_MEM,
                                 tree->asec & tree->csec)                                  r->parse, ln, ppos, NULL);
                         if ( ! roff_warn(tree, *argv, "section repeated"))                          return(ROFF_ERR);
                                 return(0);                  }
                   r->rstack[++r->rstackpos] =
                 if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec))                          ROFFRULE_DENY == r->last->rule ?
                         return(roff_err(tree, *argv, "`NAME' section "                          ROFFRULE_ALLOW : ROFFRULE_DENY;
                                                 "must be first"));  
                 if ( ! roffchecksec(tree, *argv, tree->csec, 0))  
                         return(0);  
   
                 tree->asec |= tree->csec;  
   
                 if ( ! roffspecial(tree, tok, p, argcp,  
                                         (const char **)argvp, 0, argv))  
                         return(0);  
                 break;  
         default:  
                 break;  
         }          }
   
         /* --- End run macro-specific hooks over argv. */          /* If the parent has false as its rule, then so do we. */
   
         if (NULL == *argv)          if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                 return((*tree->cb.roffblkbodyin)                  r->last->rule = ROFFRULE_DENY;
                                 (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));          }
         }  
   
         /*          /*
          * 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 ( ! (ROFFSec_PR_Os & tree->asec))          string = *bufp + pos;
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));          name = roff_getname(r, &string, ln, pos);
           if ('\0' == *name)
                   return(ROFF_IGN);
   
         first = (*argv == tree->cur);          /* Read past initial double-quote. */
         p = *argv++;          if ('"' == *string)
         ordp[0] = NULL;                  string++;
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))          /* The rest is the value. */
                 return(0);          roff_setstr(r, name, string, 0);
           return(ROFF_IGN);
   }
   
         if (NULL == *argv)  int
                 return(roffspecial(tree, tok, p, argcp,  roff_regisset(const struct roff *r, enum regs reg)
                                         (const char **)argvp, 0, ordp));  {
   
         i = 0;          return(r->regs[(int)reg].set);
         while (*argv && i < ROFF_MAXLINEARG) {  }
                 c = ROFF_PARSED & tokens[tok].flags ?  
                         rofffindcallable(*argv) : ROFF_MAX;  
   
                 if (ROFF_MAX == c && ! roffispunct(*argv)) {  unsigned int
                         ordp[i++] = *argv++;  roff_regget(const struct roff *r, enum regs reg)
                         continue;  {
                 }  
                 ordp[i] = NULL;  
   
                 if (ROFF_MAX == c)          return(r->regs[(int)reg].u);
                         break;  }
   
                 if ( ! roffspecial(tree, tok, p, argcp,  void
                                         (const char **)argvp,  roff_regunset(struct roff *r, enum regs reg)
                                         (size_t)i, ordp))  {
                         return(0);  
   
                 return(roffcall(tree, c, argv));          r->regs[(int)reg].set = 0;
         }  }
   
         assert(i != ROFF_MAXLINEARG);  /* ARGSUSED */
         ordp[i] = NULL;  static enum rofferr
   roff_nr(ROFF_ARGS)
   {
           const char      *key;
           char            *val;
           int              iv;
   
         if ( ! roffspecial(tree, tok, p, argcp,          val = *bufp + pos;
                                 (const char**)argvp,          key = roff_getname(r, &val, ln, pos);
                                 (size_t)i, ordp))  
                 return(0);  
   
         /* FIXME: error if there's stuff after the punctuation. */          if (0 == strcmp(key, "nS")) {
                   r->regs[(int)REG_nS].set = 1;
                   if ((iv = mandoc_strntoi(val, strlen(val), 10)) >= 0)
                           r->regs[(int)REG_nS].u = (unsigned)iv;
                   else
                           r->regs[(int)REG_nS].u = 0u;
           }
   
         if ( ! first || NULL == *argv)          return(ROFF_IGN);
                 return(1);  
   
         return(roffpurgepunct(tree, argv));  
 }  }
   
   /* ARGSUSED */
   static enum rofferr
   roff_rm(ROFF_ARGS)
   {
           const char       *name;
           char             *cp;
   
 static int          cp = *bufp + pos;
 macro_default(struct rofftree *tree, int tok, char *args[])          while ('\0' != *cp) {
                   name = roff_getname(r, &cp, ln, (int)(cp - *bufp));
                   if ('\0' != *name)
                           roff_setstr(r, name, NULL, 0);
           }
           return(ROFF_IGN);
   }
   
   /* ARGSUSED */
   static enum rofferr
   roff_TE(ROFF_ARGS)
 {  {
         char            **p;  
         char             *argv[ROFF_MAXLINEARG];  
         int               i, argc[ROFF_MAXLINEARG];  
   
         if ( ! roffparseopts(tree, tok, &args, argc, argv))          if (NULL == r->tbl)
                 return(0);                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
           else
                   tbl_end(&r->tbl);
   
         if ( ! (ROFF_PARSED & tokens[tok].flags))          return(ROFF_IGN);
                 return((*tree->cb.macro)(tree->arg, tok, argc, argv, 0, args));  }
   
         p = args;  /* ARGSUSED */
   static enum rofferr
   roff_T_(ROFF_ARGS)
   {
   
         while (*args) {          if (NULL == r->tbl)
                 c = rofffindcallable(*args);                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                 if (ROFF_MAX == c) {          else
                         if (roffispunct(*args)) {                  tbl_restart(ppos, ln, r->tbl);
   
           return(ROFF_IGN);
   }
   
                         }  int
                 }  roff_closeeqn(struct roff *r)
   {
   
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {          return(r->eqn && ROFF_EQN == eqn_end(&r->eqn) ? 1 : 0);
                         if ( ! (ROFF_LSCOPE & tokens[tok].flags))  }
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                         return(0);  
   
                         if ( ! roffcall(tree, c, argv))  
                                 return(0);  
                         if (ROFF_LSCOPE & tokens[tok].flags)  
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                         return(0);  
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {  void
                         if ( ! roffdata(tree, i++, *argv++))  roff_openeqn(struct roff *r, const char *name, int line,
                                 return(0);                  int offs, const char *buf)
                         continue;  {
                 }          struct eqn_node *e;
           int              poff;
   
                 i = 1;          assert(NULL == r->eqn);
                 for (j = 0; argv[j]; j++)          e = eqn_alloc(name, offs, line, r->parse);
                         if ( ! roffispunct(argv[j]))  
                                 break;  
   
                 if (argv[j]) {          if (r->last_eqn)
                         if (ROFF_LSCOPE & tokens[tok].flags) {                  r->last_eqn->next = e;
                                 if ( ! roffdata(tree, 0, *argv++))          else
                                         return(0);                  r->first_eqn = r->last_eqn = e;
                                 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;          r->eqn = r->last_eqn = e;
                         continue;  
                 }  
   
                 if ( ! (*tree->cb.roffout)(tree->arg, tok))          if (buf) {
                         return(0);                  poff = 0;
                 break;                  eqn_read(&r->eqn, line, buf, offs, &poff);
         }          }
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_EQ(ROFF_ARGS)
 {  {
         int              i, j, first, c, argcp[ROFF_MAXLINEARG];  
         char            *argvp[ROFF_MAXLINEARG];  
   
         /*          roff_openeqn(r, *bufp + pos, ln, ppos, NULL);
          * Text macros are similar to special tokens, except that          return(ROFF_IGN);
          * arguments are instead flushed as pure data: we're only  }
          * concerned with the macro and its arguments.  Example:  
          *  
          * .Fl v W f ;  
          *  
          * ...Produces...  
          *  
          * <fl> v W f </fl> ;  
          */  
   
         if ( ! (ROFFSec_PR_Os & tree->asec))  /* ARGSUSED */
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));  static enum rofferr
   roff_EN(ROFF_ARGS)
   {
   
         first = (*argv == tree->cur);          mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
         argv++;          return(ROFF_IGN);
   }
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  /* ARGSUSED */
                 return(0);  static enum rofferr
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp,  roff_TS(ROFF_ARGS)
                                 (const char **)argvp))  {
                 return(0);          struct tbl_node *t;
         if (NULL == *argv)  
                 return((*tree->cb.roffout)(tree->arg, tok));  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          if (r->tbl) {
                 i = 0;                  mandoc_msg(MANDOCERR_SCOPEBROKEN, r->parse, ln, ppos, NULL);
                 while (*argv)                  tbl_end(&r->tbl);
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }          }
   
           t = tbl_alloc(ppos, ln, r->parse);
   
           if (r->last_tbl)
                   r->last_tbl->next = t;
           else
                   r->first_tbl = r->last_tbl = t;
   
           r->tbl = r->last_tbl = t;
           return(ROFF_IGN);
   }
   
   /* ARGSUSED */
   static enum rofferr
   roff_so(ROFF_ARGS)
   {
           char *name;
   
           mandoc_msg(MANDOCERR_SO, r->parse, ln, ppos, NULL);
   
         /*          /*
          * Deal with punctuation.  Ugly.  Work ahead until we encounter           * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
          * terminating punctuation.  If we encounter it and all           * opening anything that's not in our cwd or anything beneath
          * subsequent tokens are punctuation, then stop processing (the           * it.  Thus, explicitly disallow traversing up the file-system
          * line-dominant macro will print these tokens after closure).           * or using absolute paths.
          * If the punctuation is followed by non-punctuation, then close  
          * and re-open our scope, then continue.  
          */           */
   
         i = 0;          name = *bufp + pos;
         while (*argv) {          if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {                  mandoc_msg(MANDOCERR_SOPATH, r->parse, ln, pos, NULL);
                         if ( ! (ROFF_LSCOPE & tokens[tok].flags))                  return(ROFF_ERR);
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))          }
                                         return(0);  
   
                         if ( ! roffcall(tree, c, argv))  
                                 return(0);  
                         if (ROFF_LSCOPE & tokens[tok].flags)  
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                         return(0);  
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {          *offs = pos;
                         if ( ! roffdata(tree, i++, *argv++))          return(ROFF_SO);
                                 return(0);  }
                         continue;  
                 }  
   
                 i = 1;  /* ARGSUSED */
                 for (j = 0; argv[j]; j++)  static enum rofferr
                         if ( ! roffispunct(argv[j]))  roff_userdef(ROFF_ARGS)
                                 break;  {
           const char       *arg[9];
           char             *cp, *n1, *n2;
           int               i;
   
                 if (argv[j]) {          /*
                         if (ROFF_LSCOPE & tokens[tok].flags) {           * Collect pointers to macro argument strings
                                 if ( ! roffdata(tree, 0, *argv++))           * and null-terminate them.
                                         return(0);           */
                                 continue;          cp = *bufp + pos;
                         }          for (i = 0; i < 9; i++)
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))                  arg[i] = '\0' == *cp ? "" :
                                 return(0);                      mandoc_getarg(r->parse, &cp, ln, &pos);
                         if ( ! roffdata(tree, 0, *argv++))  
                                 return(0);  
                         if ( ! (*tree->cb.roffin)(tree->arg, tok,  
                                                 argcp,  
                                                 (const char **)argvp))  
                                 return(0);  
   
                         i = 0;          /*
            * Expand macro arguments.
            */
           *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;
                 }                  }
   
                 if ( ! (*tree->cb.roffout)(tree->arg, tok))                  *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
                         return(0);                  n2 = mandoc_malloc(*szp);
                 break;  
                   strlcpy(n2, n1, (size_t)(cp - n1 + 1));
                   strlcat(n2, arg[i], *szp);
                   strlcat(n2, cp + 3, *szp);
   
                   cp = n2 + (cp - n1);
                   free(n1);
                   n1 = n2;
         }          }
   
         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);
 }  }
   
   static char *
 /* ARGSUSED */  roff_getname(struct roff *r, char **cpp, int ln, int pos)
 static int  
 roff_noop(ROFFCALL_ARGS)  
 {  {
           char     *name, *cp;
   
         switch (tok) {          name = *cpp;
         case (ROFF_Ed):          if ('\0' == *name)
                 tree->literal--;                  return(name);
                 break;  
         default:          /* Read until end of name. */
                 break;          for (cp = name; '\0' != *cp && ' ' != *cp; cp++) {
                   if ('\\' != *cp)
                           continue;
                   cp++;
                   if ('\\' == *cp)
                           continue;
                   mandoc_msg(MANDOCERR_NAMESC, r->parse, ln, pos, NULL);
                   *cp = '\0';
                   name = cp;
         }          }
   
         return(1);          /* Nil-terminate name. */
 }          if ('\0' != *cp)
                   *(cp++) = '\0';
   
           /* Read past spaces. */
           while (' ' == *cp)
                   cp++;
   
 /* ARGSUSED */          *cpp = cp;
 static int          return(name);
 roff_depr(ROFFCALL_ARGS)  }
   
   /*
    * Store *string into the user-defined string called *name.
    * In multiline mode, append to an existing entry and append '\n';
    * 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(roff_errp(tree, *argv, tok, ERR_DEPREC));          /* 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;
           }
   
 /* FIXME: push this into the filter. */          if (NULL == string)
 static int                  return;
 roff_warnp(const struct rofftree *tree, const char *pos,  
                 int tok, enum rofferr type)  
 {  
         char             *p;  
   
         switch (type) {          /*
         case (WRN_SECORD):           * One additional byte for the '\n' in multiline mode,
                 p = "section at `%s' out of order";           * and one for the terminating '\0'.
                 break;           */
         default:          newch = strlen(string) + (multiline ? 2u : 1u);
                 abort();          if (NULL == n->string) {
                 /* NOTREACHED */                  n->string = mandoc_malloc(newch);
                   *n->string = '\0';
                   oldch = 0;
           } else {
                   oldch = strlen(n->string);
                   n->string = mandoc_realloc(n->string, oldch + newch);
         }          }
   
         return(roff_warn(tree, pos, p, toknames[tok]));          /* Skip existing content in the destination buffer. */
 }          c = n->string + (int)oldch;
   
           /* Append new content to the destination buffer. */
           while (*string) {
                   /*
                    * Rudimentary roff copy mode:
                    * Handle escaped backslashes.
                    */
                   if ('\\' == *string && '\\' == *(string + 1))
                           string++;
                   *c++ = *string++;
           }
   
 static int          /* Append terminating bytes. */
 roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)          if (multiline)
                   *c++ = '\n';
           *c = '\0';
   }
   
   static const char *
   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 void
 /* FIXME: push this into the filter. */  roff_freestr(struct roff *r)
 static int  
 roff_errp(const struct rofftree *tree, const char *pos,  
                 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;
 }  }
   
   const struct tbl_span *
   roff_span(const struct roff *r)
   {
   
           return(r->tbl ? tbl_span(r->tbl) : NULL);
   }
   
 static int  const struct eqn *
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  roff_eqn(const struct roff *r)
 {  {
         va_list          ap;  
         char             buf[128];          return(r->last_eqn ? &r->last_eqn->eqn : NULL);
   }
   
         va_start(ap, fmt);  char
         if (-1 == vsnprintf(buf, sizeof(buf), fmt, ap))  roff_eqndelim(const struct roff *r)
                 err(1, "vsnprintf");  {
         va_end(ap);  
   
         return((*tree->cb.roffmsg)          return('\0');
                         (tree->arg, ROFF_ERROR, tree->cur, pos, buf));  
 }  }
   
Legend:
Removed from v.1.64  
changed lines
  Added in v.1.152
CVSweb