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

Diff for /mandoc/roff.c between version 1.15 and 1.153

version 1.15, 2008/11/28 15:25:49 version 1.153, 2011/07/26 14:24:06
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.  
  */   */
   #ifdef HAVE_CONFIG_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 "libmdocml.h"  #include "mandoc.h"
 #include "private.h"  #include "libroff.h"
   #include "libmandoc.h"
   
 /* FIXME: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  /* Maximum number of nested if-else conditionals. */
   #define RSTACK_MAX      128
   
 /* FIXME: warn about "X section only" macros. */  enum    rofft {
           ROFF_ad,
           ROFF_am,
           ROFF_ami,
           ROFF_am1,
           ROFF_de,
           ROFF_dei,
           ROFF_de1,
           ROFF_ds,
           ROFF_el,
           ROFF_hy,
           ROFF_ie,
           ROFF_if,
           ROFF_ig,
           ROFF_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
   };
   
 /* FIXME: warn about empty lists. */  enum    roffrule {
           ROFFRULE_ALLOW,
           ROFFRULE_DENY
   };
   
 /* FIXME: ; : } ) (etc.) after text macros? */  /*
    * A single register entity.  If "set" is zero, the value of the
    * register should be the default one, which is per-register.
    * Registers are assumed to be unsigned ints for now.
    */
   struct  reg {
           int               set; /* whether set or not */
           unsigned int      u; /* unsigned integer */
   };
   
 /* FIXME: NAME section needs specific elements. */  struct  roffstr {
           char            *name; /* key of symbol */
           char            *string; /* current value */
           struct roffstr  *next; /* next in list */
   };
   
 #define ROFF_MAXARG       32  struct  roff {
           struct mparse   *parse; /* parse point */
 enum    roffd {          struct roffnode *last; /* leaf of stack */
         ROFF_ENTER = 0,          enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
         ROFF_EXIT          int              rstackpos; /* position in rstack */
           struct reg       regs[REG__MAX];
           struct roffstr  *first_string; /* user-defined strings & macros */
           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 */
 };  };
   
 enum    rofftype {  struct  roffnode {
         ROFF_COMMENT,          enum rofft       tok; /* type of node */
         ROFF_TEXT,          struct roffnode *parent; /* up one in stack */
         ROFF_LAYOUT,          int              line; /* parse line */
         ROFF_SPECIAL          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 */
 };  };
   
 #define ROFFCALL_ARGS \  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
         int tok, struct rofftree *tree, \                           enum rofft tok, /* tok of macro */ \
         const char *argv[], enum roffd type                           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 */
   
 struct  rofftree;  typedef enum rofferr (*roffproc)(ROFF_ARGS);
   
 struct  rofftok {  struct  roffmac {
         int             (*cb)(ROFFCALL_ARGS);   /* Callback. */          const char      *name; /* macro name */
         const int        *args;                 /* Args (or NULL). */          roffproc         proc; /* process new macro */
         const int        *parents;          roffproc         text; /* process as child text of macro */
         const int        *children;          roffproc         sub; /* process as child of macro */
         int               ctx;          int              flags;
         enum rofftype     type;                 /* Type of macro. */  #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
         int               flags;          struct roffmac  *next;
 #define ROFF_PARSED      (1 << 0)               /* "Parsed". */  
 #define ROFF_CALLABLE    (1 << 1)               /* "Callable". */  
 #define ROFF_QUOTES      (1 << 2)               /* Quoted args. */  
 #define ROFF_SHALLOW     (1 << 3)               /* Nesting block. */  
 };  };
   
 struct  roffarg {  struct  predef {
         int               flags;          const char      *name; /* predefined input name */
 #define ROFF_VALUE       (1 << 0)               /* Has a value. */          const char      *str; /* replacement symbol */
 };  };
   
 struct  roffnode {  #define PREDEF(__name, __str) \
         int               tok;                  /* Token id. */          { (__name), (__str) },
         struct roffnode  *parent;               /* Parent (or NULL). */  
 };  
   
 struct  rofftree {  static  enum rofferr     roff_block(ROFF_ARGS);
         struct roffnode  *last;                 /* Last parsed node. */  static  enum rofferr     roff_block_text(ROFF_ARGS);
         char             *cur;  static  enum rofferr     roff_block_sub(ROFF_ARGS);
   static  enum rofferr     roff_cblock(ROFF_ARGS);
   static  enum rofferr     roff_ccond(ROFF_ARGS);
   static  enum rofferr     roff_cond(ROFF_ARGS);
   static  enum rofferr     roff_cond_text(ROFF_ARGS);
   static  enum rofferr     roff_cond_sub(ROFF_ARGS);
   static  enum rofferr     roff_ds(ROFF_ARGS);
   static  enum roffrule    roff_evalcond(const char *, int *);
   static  void             roff_freestr(struct roff *);
   static  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);
   
         time_t            date;                 /* `Dd' results. */  /* See roff_hash_find() */
         char              os[64];               /* `Os' results. */  
         char              title[64];            /* `Dt' results. */  
         char              section[64];          /* `Dt' results. */  
         char              volume[64];           /* `Dt' results. */  
   
         int               state;  #define ASCII_HI         126
 #define ROFF_PRELUDE     (1 << 1)               /* In roff prelude. */  #define ASCII_LO         33
 #define ROFF_PRELUDE_Os  (1 << 2)               /* `Os' is parsed. */  #define HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
 #define ROFF_PRELUDE_Dt  (1 << 3)               /* `Dt' is parsed. */  
 #define ROFF_PRELUDE_Dd  (1 << 4)               /* `Dd' is parsed. */  
 #define ROFF_BODY        (1 << 5)               /* In roff body. */  
   
         struct roffcb     cb;  static  struct roffmac  *hash[HASHWIDTH];
         void             *arg;  
   static  struct roffmac   roffs[ROFF_MAX] = {
           { "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 },
 };  };
   
 static  int               roff_Dd(ROFFCALL_ARGS);  /* Array of injected predefined strings. */
 static  int               roff_Dt(ROFFCALL_ARGS);  #define PREDEFS_MAX      38
 static  int               roff_Os(ROFFCALL_ARGS);  static  const struct predef predefs[PREDEFS_MAX] = {
   #include "predefs.in"
   };
   
 static  int               roff_layout(ROFFCALL_ARGS);  static  void             roff_free1(struct roff *);
 static  int               roff_text(ROFFCALL_ARGS);  static  enum rofft       roff_hash_find(const char *, size_t);
 static  int               roff_comment(ROFFCALL_ARGS);  static  void             roff_hash_init(void);
 static  int               roff_close(ROFFCALL_ARGS);  static  void             roffnode_cleanscope(struct roff *);
 static  int               roff_special(ROFFCALL_ARGS);  static  void             roffnode_push(struct roff *, enum rofft,
                                   const char *, int, int);
   static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(struct roff *, const char *, int *);
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  /* See roff_hash_find() */
 static  void              roffnode_free(struct rofftree *);  #define ROFF_HASH(p)    (p[0] - ASCII_LO)
   
 static  void              roff_warn(const struct rofftree *,  static void
                                 const char *, char *, ...);  roff_hash_init(void)
 static  void              roff_err(const struct rofftree *,  {
                                 const char *, char *, ...);          struct roffmac   *n;
           int               buc, i;
   
 static  int               roffscan(int, const int *);          for (i = 0; i < (int)ROFF_USERDEF; i++) {
 static  int               rofffindtok(const char *);                  assert(roffs[i].name[0] >= ASCII_LO);
 static  int               rofffindarg(const char *);                  assert(roffs[i].name[0] <= ASCII_HI);
 static  int               rofffindcallable(const char *);  
 static  int               roffargs(const struct rofftree *,  
                                 int, char *, char **);  
 static  int               roffargok(int, int);  
 static  int               roffnextopt(const struct rofftree *,  
                                 int, const char ***, char **);  
 static  int               roffparse(struct rofftree *, char *, size_t);  
 static  int               textparse(const struct rofftree *,  
                                 const char *, size_t);  
   
                   buc = ROFF_HASH(roffs[i].name);
   
 static  const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit,                  if (NULL != (n = hash[buc])) {
         ROFF_ARGMAX };                          for ( ; n->next; n = n->next)
 static  const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled,                                  /* Do nothing. */ ;
         ROFF_Literal, ROFF_File, ROFF_Offset, ROFF_Filled,                          n->next = &roffs[i];
         ROFF_Compact, ROFF_ARGMAX };                  } else
 static  const int roffarg_Bk[] = { ROFF_Words, ROFF_ARGMAX };                          hash[buc] = &roffs[i];
 static  const int roffarg_Ex[] = { ROFF_Std, ROFF_ARGMAX };          }
 static  const int roffarg_Rv[] = { ROFF_Std, ROFF_ARGMAX };  }
 static  const int roffarg_Bl[] = { ROFF_Bullet, ROFF_Dash,  
         ROFF_Hyphen, ROFF_Item, ROFF_Enum, ROFF_Tag, ROFF_Diag,  
         ROFF_Hang, ROFF_Ohang, ROFF_Inset, ROFF_Column, ROFF_Offset,  
         ROFF_Width, ROFF_Compact, ROFF_ARGMAX };  
 static  const int roffarg_St[] = {  
         ROFF_p1003_1_88, ROFF_p1003_1_90, ROFF_p1003_1_96,  
         ROFF_p1003_1_2001, ROFF_p1003_1_2004, ROFF_p1003_1,  
         ROFF_p1003_1b, ROFF_p1003_1b_93, ROFF_p1003_1c_95,  
         ROFF_p1003_1g_2000, ROFF_p1003_2_92, ROFF_p1387_2_95,  
         ROFF_p1003_2, ROFF_p1387_2, ROFF_isoC_90, ROFF_isoC_amd1,  
         ROFF_isoC_tcor1, ROFF_isoC_tcor2, ROFF_isoC_99, ROFF_ansiC,  
         ROFF_ansiC_89, ROFF_ansiC_99, ROFF_ieee754, ROFF_iso8802_3,  
         ROFF_xpg3, ROFF_xpg4, ROFF_xpg4_2, ROFF_xpg4_3, ROFF_xbd5,  
         ROFF_xcu5, ROFF_xsh5, ROFF_xns5, ROFF_xns5_2d2_0,  
         ROFF_xcurses4_2, ROFF_susv2, ROFF_susv3, ROFF_svid4,  
         ROFF_ARGMAX };  
   
 static  const int roffchild_Bl[] = { ROFF_It, ROFF_El, ROFF_MAX };  /*
 static  const int roffchild_Fo[] = { ROFF_Fa, ROFF_Fc, ROFF_MAX };   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
 static  const int roffchild_Oo[] = { ROFF_Op, ROFF_Oc, ROFF_MAX };   * the nil-terminated string name could be found.
 static  const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B,   */
         ROFF__D, ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P,  static enum rofft
         ROFF__R, ROFF__T, ROFF__V, ROFF_MAX };  roff_hash_find(const char *p, size_t s)
   {
           int              buc;
           struct roffmac  *n;
   
 static  const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };          /*
 static  const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX };           * libroff has an extremely simple hashtable, for the time
 static  const int roffparent_Oc[] = { ROFF_Oo, ROFF_Oc, ROFF_MAX };           * being, which simply keys on the first character, which must
 static  const int roffparent_It[] = { ROFF_Bl, ROFF_It, ROFF_MAX };           * be printable, then walks a chain.  It works well enough until
 static  const int roffparent_Re[] = { ROFF_Rs, ROFF_MAX };           * optimised.
            */
   
 /* Table of all known tokens. */          if (p[0] < ASCII_LO || p[0] > ASCII_HI)
 static  const struct rofftok tokens[ROFF_MAX] = {                  return(ROFF_MAX);
         {roff_comment, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */  
         {     roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */  
         {     roff_Dt, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dt */  
         {     roff_Os, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Os */  
         { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */  
         { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */  
         {   roff_text, NULL, NULL, NULL, ROFF_Pp, ROFF_TEXT, 0 }, /* Pp */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* D1 */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Dl */  
         { roff_layout, roffarg_Bd, NULL, NULL, 0, ROFF_LAYOUT, 0 },     /* Bd */  
         {  roff_close, NULL, NULL, NULL, ROFF_Bd, ROFF_LAYOUT, 0 }, /* Ed */  
         { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */  
         {  roff_close, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */  
         { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, ROFF_SHALLOW }, /* It */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */  
         {   roff_text, roffarg_An, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* An */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Cd */ /* XXX man.4 only */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */ /* XXX needs arg */  
         {   roff_text, roffarg_Ex, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ex */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fd */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */ /* XXX needs arg */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ft */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* In */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Nd */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Op */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ot */ /* XXX deprecated */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */  
         {   roff_text, roffarg_Rv, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rv */  
         {   roff_text, roffarg_St, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %D */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %N */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %O */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %P */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %R */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %V */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* At */ /* XXX at most 2 args */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 },  /* Bf */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */  
         {roff_special, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 },  /* Db */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 },  /* Ef */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_LAYOUT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */  
         { roff_layout, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */  
         {  roff_close, NULL, roffparent_Re, NULL, ROFF_Rs, ROFF_LAYOUT, 0 }, /* Re */  
         { roff_layout, NULL, NULL, roffchild_Rs, 0, ROFF_LAYOUT, 0 },   /* Rs */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */  
         {roff_special, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 }, /* Sm */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */  
         { roff_layout, NULL, NULL, roffchild_Fo, 0, ROFF_LAYOUT, 0 }, /* Fo */  
         {  roff_close, NULL, roffparent_Fc, NULL, ROFF_Fo, ROFF_LAYOUT, 0 }, /* Fc */  
         { roff_layout, NULL, NULL, roffchild_Oo, 0, ROFF_LAYOUT, 0 }, /* Oo */  
         {  roff_close, NULL, roffparent_Oc, NULL, ROFF_Oo, ROFF_LAYOUT, 0 }, /* Oc */  
         { roff_layout, roffarg_Bk, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bk */  
         {  roff_close, NULL, NULL, NULL, ROFF_Bk, ROFF_LAYOUT, 0 }, /* Ek */  
         };  
   
 /* Table of all known token arguments. */          buc = ROFF_HASH(p);
 static  const int tokenargs[ROFF_ARGMAX] = {  
         0,              0,              0,              0,  
         0,              ROFF_VALUE,     ROFF_VALUE,     0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         };  
   
 const   char *const toknamesp[ROFF_MAX] = {          if (NULL == (n = hash[buc]))
         "\\\"",         "Dd",           "Dt",           "Os",                  return(ROFF_MAX);
         "Sh",           "Ss",           "Pp",           "D1",          for ( ; n; n = n->next)
         "Dl",           "Bd",           "Ed",           "Bl",                  if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
         "El",           "It",           "Ad",           "An",                          return((enum rofft)(n - roffs));
         "Ar",           "Cd",           "Cm",           "Dv",  
         "Er",           "Ev",           "Ex",           "Fa",  
         "Fd",           "Fl",           "Fn",           "Ft",  
         "Ic",           "In",           "Li",           "Nd",  
         "Nm",           "Op",           "Ot",           "Pa",  
         "Rv",           "St",           "Va",           "Vt",  
         "Xr",           "\%A",          "\%B",          "\%D",  
         "\%I",          "\%J",          "\%N",          "\%O",  
         "\%P",          "\%R",          "\%T",          "\%V",  
         "Ac",           "Ao",           "Aq",           "At",  
         "Bc",           "Bf",           "Bo",           "Bq",  
         "Bsx",          "Bx",           "Db",           "Dc",  
         "Do",           "Dq",           "Ec",           "Ef",  
         "Em",           "Eo",           "Fx",           "Ms",  
         "No",           "Ns",           "Nx",           "Ox",  
         "Pc",           "Pf",           "Po",           "Pq",  
         "Qc",           "Ql",           "Qo",           "Qq",  
         "Re",           "Rs",           "Sc",           "So",  
         "Sq",           "Sm",           "Sx",           "Sy",  
         "Tn",           "Ux",           "Xc",           "Xo",  
         "Fo",           "Fc",           "Oo",           "Oc",  
         "Bk",           "Ek",  
         };  
   
 const   char *const tokargnamesp[ROFF_ARGMAX] = {          return(ROFF_MAX);
         "split",                "nosplit",              "ragged",  }
         "unfilled",             "literal",              "file",  
         "offset",               "bullet",               "dash",  
         "hyphen",               "item",                 "enum",  
         "tag",                  "diag",                 "hang",  
         "ohang",                "inset",                "column",  
         "width",                "compact",              "std",  
         "p1003.1-88",           "p1003.1-90",           "p1003.1-96",  
         "p1003.1-2001",         "p1003.1-2004",         "p1003.1",  
         "p1003.1b",             "p1003.1b-93",          "p1003.1c-95",  
         "p1003.1g-2000",        "p1003.2-92",           "p1387.2-95",  
         "p1003.2",              "p1387.2",              "isoC-90",  
         "isoC-amd1",            "isoC-tcor1",           "isoC-tcor2",  
         "isoC-99",              "ansiC",                "ansiC-89",  
         "ansiC-99",             "ieee754",              "iso8802-3",  
         "xpg3",                 "xpg4",                 "xpg4.2",  
         "xpg4.3",               "xbd5",                 "xcu5",  
         "xsh5",                 "xns5",                 "xns5.2d2.0",  
         "xcurses4.2",           "susv2",                "susv3",  
         "svid4",                "filled",               "words",  
         };  
   
 const   char *const *toknames = toknamesp;  
 const   char *const *tokargnames = tokargnamesp;  
   
   /*
 int   * Pop the current node off of the stack of roff instructions currently
 roff_free(struct rofftree *tree, int flush)   * pending.
    */
   static void
   roffnode_pop(struct roff *r)
 {  {
         int              error;          struct roffnode *p;
         struct roffnode *n;  
   
         error = 0;          assert(r->last);
           p = r->last;
   
         for (n = tree->last; n->parent; n = n->parent)          r->last = r->last->parent;
                 if (tokens[n->tok].ctx == 0) {          free(p->name);
                         roff_warn(tree, NULL, "closing explicit scope "          free(p->end);
                                         "of `%s'", toknames[n->tok]);          free(p);
                         error = 1;  }
                 }  
   
         if (0 == error && (ROFF_PRELUDE & tree->state)) {  
                 roff_warn(tree, NULL, "prelude never finished");  
                 error = 1;  
         }  
   
         while (tree->last)  /*
                 roffnode_free(tree);   * 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)
   {
           struct roffnode *p;
   
         free(tree);          p = mandoc_calloc(1, sizeof(struct roffnode));
         return(error ? 0 : 1);          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;
   
           r->last = p;
 }  }
   
   
 struct rofftree *  static void
 roff_alloc(const struct roffcb *cb, void *args)  roff_free1(struct roff *r)
 {  {
         struct rofftree *tree;          struct tbl_node *t;
           struct eqn_node *e;
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))          while (NULL != (t = r->first_tbl)) {
                 err(1, "calloc");                  r->first_tbl = t->next;
                   tbl_free(t);
           }
   
         tree->state = ROFF_PRELUDE;          r->first_tbl = r->last_tbl = r->tbl = NULL;
         tree->arg = args;  
   
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));          while (NULL != (e = r->first_eqn)) {
                   r->first_eqn = e->next;
                   eqn_free(e);
           }
   
         return(tree);          r->first_eqn = r->last_eqn = r->eqn = NULL;
   
           while (r->last)
                   roffnode_pop(r);
   
           roff_freestr(r);
 }  }
   
   
 int  void
 roff_engine(struct rofftree *tree, char *buf, size_t sz)  roff_reset(struct roff *r)
 {  {
           int              i;
   
         tree->cur = NULL;          roff_free1(r);
   
         if (0 == sz) {          memset(&r->regs, 0, sizeof(struct reg) * REG__MAX);
                 roff_warn(tree, buf, "blank line");  
                 return(0);  
         } else if ('.' != *buf)  
                 return(textparse(tree, buf, sz));  
   
         return(roffparse(tree, buf, sz));          for (i = 0; i < PREDEFS_MAX; i++)
                   roff_setstr(r, predefs[i].name, predefs[i].str, 0);
 }  }
   
   
 static int  void
 textparse(const struct rofftree *tree, const char *buf, size_t sz)  roff_free(struct roff *r)
 {  {
   
         /* Print text. */          roff_free1(r);
         return(1);          free(r);
 }  }
   
   
 static int  struct roff *
 roffargs(const struct rofftree *tree,  roff_alloc(struct mparse *parse)
                 int tok, char *buf, char **argv)  
 {  {
           struct roff     *r;
         int              i;          int              i;
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          r = mandoc_calloc(1, sizeof(struct roff));
         assert('.' == *buf);          r->parse = parse;
           r->rstackpos = -1;
         p = buf;  
   
         /* LINTED */  
         for (i = 0; *buf && i < ROFF_MAXARG; i++) {  
                 if ('\"' == *buf) {  
                         argv[i] = ++buf;  
                         while (*buf && '\"' != *buf)  
                                 buf++;  
                         if (0 == *buf) {  
                                 roff_err(tree, argv[i], "unclosed "  
                                                 "quote in argument "  
                                                 "list for `%s'",  
                                                 toknames[tok]);  
                                 return(0);  
                         }  
                 } else {  
                         argv[i] = buf++;  
                         while (*buf && ! isspace(*buf))  
                                 buf++;  
                         if (0 == *buf)  
                                 continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);          roff_hash_init();
         if (ROFF_MAXARG == i && *buf) {  
                 roff_err(tree, p, "too many arguments for `%s'", toknames  
                                 [tok]);  
                 return(0);  
         }  
   
         argv[i] = NULL;          for (i = 0; i < PREDEFS_MAX; i++)
         return(1);                  roff_setstr(r, predefs[i].name, predefs[i].str, 0);
   
           return(r);
 }  }
   
   /*
 /* XXX */   * 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.
    * This also checks the syntax of regular escapes.
   */
 static int  static int
 roffscan(int tok, const int *tokv)  roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
 {  {
           enum mandoc_esc  esc;
           const char      *stesc; /* start of an escape sequence ('\\') */
           const char      *stnam; /* start of the name, after "[(*" */
           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 (NULL == tokv)          /* Search for a leading backslash and save a pointer to it. */
                 return(1);  
   
         for ( ; ROFF_MAX != *tokv; tokv++)          cp = *bufp + pos;
                 if (tok == *tokv)          while (NULL != (cp = strchr(cp, '\\'))) {
                   stesc = cp++;
   
                   /*
                    * 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)
                         return(1);                          return(1);
   
         return(0);                  if ('*' != *cp) {
 }                          res = cp;
                           esc = mandoc_escape(&cp, NULL, NULL);
                           if (ESCAPE_ERROR != esc)
                                   continue;
                           cp = res;
                           mandoc_msg
                                   (MANDOCERR_BADESCAPE, r->parse,
                                    ln, (int)(stesc - *bufp), NULL);
                           continue;
                   }
   
                   cp++;
   
 static int                  /*
 roffparse(struct rofftree *tree, char *buf, size_t sz)                   * The third character decides the length
 {                   * of the name of the string.
         int               tok, t;                   * Save a pointer to the name.
         struct roffnode  *n;                   */
         char             *argv[ROFF_MAXARG];  
         const char      **argvp;  
   
         assert(sz > 0);                  switch (*cp) {
                   case ('\0'):
                           return(1);
                   case ('('):
                           cp++;
                           maxl = 2;
                           break;
                   case ('['):
                           cp++;
                           maxl = 0;
                           break;
                   default:
                           maxl = 1;
                           break;
                   }
                   stnam = cp;
   
         if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {                  /* Advance to the end of the name. */
                 roff_err(tree, buf + 1, "bogus line macro");  
                 return(0);  
         } else if (NULL == tokens[tok].cb) {  
                 roff_err(tree, buf + 1, "unsupported macro `%s'",  
                                 toknames[tok]);  
                 return(0);  
         } else if (ROFF_COMMENT == tokens[tok].type)  
                 return(1);  
   
         if ( ! roffargs(tree, tok, buf, argv))  
                 return(0);  
   
         argvp = (const char **)argv;                  for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
                           if ('\0' == *cp) {
                                   mandoc_msg
                                           (MANDOCERR_BADESCAPE,
                                            r->parse, ln,
                                            (int)(stesc - *bufp), NULL);
                                   return(1);
                           }
                           if (0 == maxl && ']' == *cp)
                                   break;
                   }
   
         /*                  /*
          * Prelude macros break some assumptions, so branch now.                   * Retrieve the replacement string; if it is
          */                   * undefined, resume searching for escapes.
                    */
         if (ROFF_PRELUDE & tree->state) {  
                 assert(NULL == tree->last);  
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
         } else  
                 assert(tree->last);  
   
         assert(ROFF_BODY & tree->state);                  res = roff_getstrn(r, stnam, (size_t)i);
   
         /*                  if (NULL == res) {
          * First check that our possible parents and parent's possible                          mandoc_msg
          * children are satisfied.                                  (MANDOCERR_BADESCAPE, r->parse,
          */                                   ln, (int)(stesc - *bufp), NULL);
                           res = "";
                   }
   
         if ( ! roffscan(tree->last->tok, tokens[tok].parents)) {                  /* Replace the escape sequence by the string. */
                 roff_err(tree, *argvp, "`%s' has invalid parent `%s'",  
                                 toknames[tok],  
                                 toknames[tree->last->tok]);  
                 return(0);  
         }  
   
         if ( ! roffscan(tok, tokens[tree->last->tok].children)) {                  nsz = *szp + strlen(res) + 1;
                 roff_err(tree, *argvp, "`%s' is invalid child `%s'",                  n = mandoc_malloc(nsz);
                                 toknames[tree->last->tok],  
                                 toknames[tok]);                  strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
                   strlcat(n, res, nsz);
                   strlcat(n, cp + (maxl ? 0 : 1), nsz);
   
                   free(*bufp);
   
                   *bufp = n;
                   *szp = nsz;
                 return(0);                  return(0);
         }          }
   
           return(1);
   }
   
   enum rofferr
   roff_parseln(struct roff *r, int ln, char **bufp,
                   size_t *szp, int pos, int *offs)
   {
           enum rofft       t;
           enum rofferr     e;
           int              ppos, ctl;
   
         /*          /*
          * Branch if we're not a layout token.           * Run the reserved-word filter only if we have some reserved
            * words to fill in.
          */           */
   
         if (ROFF_LAYOUT != tokens[tok].type)          if ( ! roff_res(r, bufp, szp, ln, pos))
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));                  return(ROFF_REPARSE);
   
         /*          ppos = pos;
          * Check our scope rules.          ctl = mandoc_getcontrol(*bufp, &pos);
   
           /*
            * First, if a scope is open and we're not a macro, pass the
            * text through the macro's filter.  If a scope isn't open and
            * we're not a macro, just let it through.
            * Finally, if there's an equation scope open, divert it into it
            * no matter our state.
          */           */
   
         if (0 == tokens[tok].ctx)          if (r->last && ! ctl) {
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));                  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));
   
         /*          /*
          * First consider implicit-end tags, like as follows:           * If a scope is open, go to the child handler for that macro,
          *      .Sh SECTION 1           * as it may want to preprocess before doing anything with it.
          *      .Sh SECTION 2           * Don't do so if an equation is open.
          * In this, we want to close the scope of the NAME section.  If  
          * there's an intermediary implicit-end tag, such as  
          *      .Sh SECTION 1  
          *      .Ss Subsection 1  
          *      .Sh SECTION 2  
          * then it must be closed as well.  
          */           */
   
         if (tok == tokens[tok].ctx) {          if (r->last) {
                 /*                  t = r->last->tok;
                  * First search up to the point where we must close.                  assert(roffs[t].sub);
                  * If one doesn't exist, then we can open a new scope.                  return((*roffs[t].sub)
                  */                                  (r, t, bufp, szp,
                                    ln, ppos, pos, offs));
           }
   
                 for (n = tree->last; n; n = n->parent) {          /*
                         assert(0 == tokens[n->tok].ctx ||           * Lastly, as we've no scope open, try to look up and execute
                                         n->tok == tokens[n->tok].ctx);           * the new macro.  If no macro is found, simply return and let
                         if (n->tok == tok)           * the compilers handle it.
                                 break;           */
                         if (ROFF_SHALLOW & tokens[tok].flags) {  
                                 n = NULL;  
                                 break;  
                         }  
                 }  
   
                 /*          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                  * Create a new scope, as no previous one exists to                  return(ROFF_CONT);
                  * close out.  
                  */  
   
                 if (NULL == n)          assert(roffs[t].proc);
                         return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));          return((*roffs[t].proc)
                           (r, t, bufp, szp,
                            ln, ppos, pos, offs));
   }
   
                 /*  
                  * Close out all intermediary scoped blocks, then hang  
                  * the current scope from our predecessor's parent.  
                  */  
   
                 do {  void
                         t = tree->last->tok;  roff_endparse(struct roff *r)
                         if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  {
                                 return(0);  
                 } while (t != tok);  
   
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));          if (r->last)
                   mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                                   r->last->line, r->last->col, NULL);
   
           if (r->eqn) {
                   mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                                   r->eqn->eqn.ln, r->eqn->eqn.pos, NULL);
                   eqn_end(&r->eqn);
         }          }
   
         /*          if (r->tbl) {
          * Now consider explicit-end tags, where we want to close back                  mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
          * to a specific tag.  Example:                                  r->tbl->line, r->tbl->pos, NULL);
          *      .Bl                  tbl_end(&r->tbl);
          *      .It Item.          }
          *      .El  }
          * In this, the `El' tag closes out the scope of `Bl'.  
          */  
   
         assert(tree->last);  /*
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);   * Parse a roff node's type from the input buffer.  This must be in the
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(struct roff *r, const char *buf, int *pos)
   {
           const char      *mac;
           size_t           maclen;
           enum rofft       t;
   
         /* LINTED */          if ('\0' == buf[*pos] || '"' == buf[*pos] ||
         do {                          '\t' == buf[*pos] || ' ' == buf[*pos])
                 t = tree->last->tok;                  return(ROFF_MAX);
                 if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         assert(tree->last);          /*
         return(1);           * We stop the macro parse at an escape, tab, space, or nil.
 }           * However, `\}' is also a valid macro, so make sure we don't
            * clobber it by seeing the `\' as the end of token.
            */
   
           mac = buf + *pos;
           maclen = strcspn(mac + 1, " \\\t\0") + 1;
   
 static int          t = (r->current_string = roff_getstrn(r, mac, maclen))
 rofffindarg(const char *name)              ? ROFF_USERDEF : roff_hash_find(mac, maclen);
 {  
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          *pos += (int)maclen;
   
         /* LINTED */          while (buf[*pos] && ' ' == buf[*pos])
         for (i = 0; i < ROFF_ARGMAX; i++)                  (*pos)++;
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))          return(t);
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   /* ARGSUSED */
 static int  static enum rofferr
 rofffindtok(const char *buf)  roff_cblock(ROFF_ARGS)
 {  {
         char             token[4];  
         size_t           i;  
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)          /*
                 token[i] = *buf;           * A block-close `..' should only be invoked as a child of an
            * ignore macro, otherwise raise a warning and just ignore it.
            */
   
         if (i == 3)          if (NULL == r->last) {
                 return(ROFF_MAX);                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
         token[i] = 0;          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);
           }
   
         /* FIXME: use a table, this is slow but ok for now. */          if ((*bufp)[pos])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
   
         /* LINTED */          roffnode_pop(r);
         for (i = 0; i < ROFF_MAX; i++)          roffnode_cleanscope(r);
                 /* LINTED */          return(ROFF_IGN);
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);  
 }  }
   
   
 static int  static void
 rofffindcallable(const char *name)  roffnode_cleanscope(struct roff *r)
 {  {
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))          while (r->last) {
                 return(ROFF_MAX);                  if (--r->last->endspan < 0)
         assert(c >= 0 && c < ROFF_MAX);                          break;
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);                  roffnode_pop(r);
           }
 }  }
   
   
 static struct roffnode *  /* ARGSUSED */
 roffnode_new(int tokid, struct rofftree *tree)  static enum rofferr
   roff_ccond(ROFF_ARGS)
 {  {
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode))))  
                 err(1, "malloc");  
   
         p->tok = tokid;          if (NULL == r->last) {
         p->parent = tree->last;                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
         tree->last = p;                  return(ROFF_IGN);
           }
   
         return(p);          switch (r->last->tok) {
           case (ROFF_el):
                   /* FALLTHROUGH */
           case (ROFF_ie):
                   /* FALLTHROUGH */
           case (ROFF_if):
                   break;
           default:
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
           if (r->last->endspan > -1) {
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
 }  }
   
   
 static int  /* ARGSUSED */
 roffargok(int tokid, int argid)  static enum rofferr
   roff_block(ROFF_ARGS)
 {  {
         const int       *c;          int             sv;
           size_t          sz;
           char            *name;
   
         if (NULL == (c = tokens[tokid].args))          name = NULL;
                 return(0);  
   
         for ( ; ROFF_ARGMAX != *c; c++)          if (ROFF_ig != tok) {
                 if (argid == *c)                  if ('\0' == (*bufp)[pos]) {
                         return(1);                          mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
                           return(ROFF_IGN);
                   }
   
         return(0);                  /*
 }                   * 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 void                  while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
 roffnode_free(struct rofftree *tree)                          pos++;
 {  
         struct roffnode *p;  
   
         assert(tree->last);                  while (isspace((unsigned char)(*bufp)[pos]))
                           (*bufp)[pos++] = '\0';
           }
   
         p = tree->last;          roffnode_push(r, tok, name, ln, ppos);
         tree->last = tree->last->parent;  
         free(p);  
 }  
   
           /*
            * 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)
 roffnextopt(const struct rofftree *tree, int tok,                  roff_setstr(r, name, "", 0);
                 const char ***in, char **val)  
 {  
         const char      *arg, **argv;  
         int              v;  
   
         *val = NULL;          if ('\0' == (*bufp)[pos])
         argv = *in;                  return(ROFF_IGN);
         assert(argv);  
   
         if (NULL == (arg = *argv))          /* If present, process the custom end-of-line marker. */
                 return(-1);  
         if ('-' != *arg)  
                 return(-1);  
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {          sv = pos;
                 roff_warn(tree, arg, "argument-like parameter `%s' to "          while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
                                 "`%s'", &arg[1], toknames[tok]);                  pos++;
                 return(-1);  
         }  
   
         if ( ! roffargok(tok, v)) {  
                 roff_warn(tree, arg, "invalid argument parameter `%s' to "  
                                 "`%s'", tokargnames[v], toknames[tok]);  
                 return(-1);  
         }  
   
         if ( ! (ROFF_VALUE & tokenargs[v]))  
                 return(v);  
   
         *in = ++argv;          /*
            * Note: groff does NOT like escape characters in the input.
            * Instead of detecting this, we're just going to let it fly and
            * to hell with it.
            */
   
         if (NULL == *argv) {          assert(pos > sv);
                 roff_err(tree, arg, "empty value of `%s' for `%s'",          sz = (size_t)(pos - sv);
                                 tokargnames[v], toknames[tok]);  
                 return(ROFF_ARGMAX);  
         }  
   
         return(v);          if (1 == sz && '.' == (*bufp)[sv])
                   return(ROFF_IGN);
   
           r->last->end = mandoc_malloc(sz + 1);
   
           memcpy(r->last->end, *bufp + sv, sz);
           r->last->end[(int)sz] = '\0';
   
           if ((*bufp)[pos])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
   
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_block_sub(ROFF_ARGS)
 {  {
           enum rofft      t;
           int             i, j;
   
         if (ROFF_BODY & tree->state) {          /*
                 assert( ! (ROFF_PRELUDE & tree->state));           * First check whether a custom macro exists at this level.  If
                 assert(ROFF_PRELUDE_Dd & tree->state);           * it does, then check against it.  This is some of groff's
                 return(roff_text(tok, tree, argv, type));           * stranger behaviours.  If we encountered a custom end-scope
            * tag and that tag also happens to be a "real" macro, then we
            * need to try interpreting it again as a real macro.  If it's
            * not, then return ignore.  Else continue.
            */
   
           if (r->last->end) {
                   for (i = pos, j = 0; r->last->end[j]; j++, i++)
                           if ((*bufp)[i] != r->last->end[j])
                                   break;
   
                   if ('\0' == r->last->end[j] &&
                                   ('\0' == (*bufp)[i] ||
                                    ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
                           while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                                   i++;
   
                           pos = i;
                           if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                   return(ROFF_RERUN);
                           return(ROFF_IGN);
                   }
         }          }
   
         assert(ROFF_PRELUDE & tree->state);          /*
         assert( ! (ROFF_BODY & tree->state));           * If we have no custom end-query or lookup failed, then try
            * pulling it out of the hashtable.
            */
   
         if (ROFF_PRELUDE_Dd & tree->state) {          t = roff_parse(r, *bufp, &pos);
                 roff_err(tree, *argv, "repeated `Dd' in prelude");  
                 return(0);          /*
         } else if (ROFF_PRELUDE_Dt & tree->state) {           * Macros other than block-end are only significant
                 roff_err(tree, *argv, "out-of-order `Dd' in prelude");           * in `de' blocks; elsewhere, simply throw them away.
                 return(0);           */
           if (ROFF_cblock != t) {
                   if (ROFF_de == tok)
                           roff_setstr(r, r->last->name, *bufp + ppos, 1);
                   return(ROFF_IGN);
         }          }
   
         /* TODO: parse date. */          assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
   }
   
         assert(NULL == tree->last);  
         tree->state |= ROFF_PRELUDE_Dd;  
   
         return(1);  /* ARGSUSED */
   static enum rofferr
   roff_block_text(ROFF_ARGS)
   {
   
           if (ROFF_de == tok)
                   roff_setstr(r, r->last->name, *bufp + pos, 1);
   
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_cond_sub(ROFF_ARGS)
 {  {
           enum rofft       t;
           enum roffrule    rr;
           char            *ep;
   
         if (ROFF_BODY & tree->state) {          rr = r->last->rule;
                 assert( ! (ROFF_PRELUDE & tree->state));          roffnode_cleanscope(r);
                 assert(ROFF_PRELUDE_Dt & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          /*
         assert( ! (ROFF_BODY & tree->state));           * 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 ( ! (ROFF_PRELUDE_Dd & tree->state)) {          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
                 roff_err(tree, *argv, "out-of-order `Dt' in prelude");                  ep = &(*bufp)[pos];
                 return(0);                  for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
         } else if (ROFF_PRELUDE_Dt & tree->state) {                          ep++;
                 roff_err(tree, *argv, "repeated `Dt' in prelude");                          if ('}' != *ep)
                 return(0);                                  continue;
   
                           /*
                            * 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.
                            */
   
                           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);
         }          }
   
         /* TODO: parse date. */          /*
            * A denied conditional must evaluate its children if and only
            * if they're either structurally required (such as loops and
            * conditionals) or a closing macro.
            */
   
         assert(NULL == tree->last);          if (ROFFRULE_DENY == rr)
         tree->state |= ROFF_PRELUDE_Dt;                  if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
         return(1);          assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_cond_text(ROFF_ARGS)
 {  {
           char            *ep;
           enum roffrule    rr;
   
         if (ROFF_EXIT == type) {          rr = r->last->rule;
                 assert(ROFF_PRELUDE_Os & tree->state);          roffnode_cleanscope(r);
                 return(roff_layout(tok, tree, argv, type));  
         } else if (ROFF_BODY & tree->state) {          ep = &(*bufp)[pos];
                 assert( ! (ROFF_PRELUDE & tree->state));          for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
                 assert(ROFF_PRELUDE_Os & tree->state);                  ep++;
                 return(roff_text(tok, tree, argv, type));                  if ('}' != *ep)
                           continue;
                   *ep = '&';
                   roff_ccond(r, ROFF_ccond, bufp, szp,
                                   ln, pos, pos + 2, offs);
         }          }
           return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   }
   
         assert(ROFF_PRELUDE & tree->state);  static enum roffrule
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||  roff_evalcond(const char *v, int *pos)
                         ! (ROFF_PRELUDE_Dd & tree->state)) {  {
                 roff_err(tree, *argv, "out-of-order `Os' in prelude");  
                 return(0);          switch (v[*pos]) {
           case ('n'):
                   (*pos)++;
                   return(ROFFRULE_ALLOW);
           case ('e'):
                   /* FALLTHROUGH */
           case ('o'):
                   /* FALLTHROUGH */
           case ('t'):
                   (*pos)++;
                   return(ROFFRULE_DENY);
           default:
                   break;
         }          }
   
         /* TODO: extract OS. */          while (v[*pos] && ' ' != v[*pos])
                   (*pos)++;
           return(ROFFRULE_DENY);
   }
   
         tree->state |= ROFF_PRELUDE_Os;  /* ARGSUSED */
         tree->state &= ~ROFF_PRELUDE;  static enum rofferr
         tree->state |= ROFF_BODY;  roff_line_ignore(ROFF_ARGS)
   {
   
         assert(NULL == tree->last);          if (ROFF_it == tok)
                   mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos, "it");
   
         return(roff_layout(tok, tree, argv, type));          return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_layout(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];          int              sv;
         char            *v, *argvp[ROFF_MAXARG];          enum roffrule    rule;
   
         if (ROFF_PRELUDE & tree->state) {          /*
                 roff_err(tree, *argv, "`%s' disallowed in prelude",           * An `.el' has no conditional body: it will consume the value
                                 toknames[tok]);           * of the current rstack entry set in prior `ie' calls or
                 return(0);           * defaults to DENY.
         }           *
            * If we're not an `el', however, then evaluate the conditional.
            */
   
         if (ROFF_EXIT == type) {          rule = ROFF_el == tok ?
                 roffnode_free(tree);                  (r->rstackpos < 0 ?
                 return((*tree->cb.roffblkout)(tree->arg, tok));                   ROFFRULE_DENY : r->rstack[r->rstackpos--]) :
         }                  roff_evalcond(*bufp, &pos);
   
         i = 0;          sv = pos;
         argv++;          while (' ' == (*bufp)[pos])
                   pos++;
   
         while (-1 != (c = roffnextopt(tree, tok, &argv, &v))) {          /*
                 if (ROFF_ARGMAX == c)           * Roff is weird.  If we have just white-space after the
                         return(0);           * conditional, it's considered the BODY and we exit without
            * really doing anything.  Warn about this.  It's probably
            * wrong.
            */
   
                 argcp[i] = c;          if ('\0' == (*bufp)[pos] && sv != pos) {
                 argvp[i] = v;                  mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
                 i++;                  return(ROFF_IGN);
                 argv++;  
         }          }
   
         argcp[i] = ROFF_ARGMAX;          roffnode_push(r, tok, NULL, ln, ppos);
         argvp[i] = NULL;  
   
         if (NULL == roffnode_new(tok, tree))          r->last->rule = rule;
                 return(0);  
   
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))          /*
                 return(0);           * An if-else will put the NEGATION of the current evaluated
            * conditional into the stack of rules.
            */
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          if (ROFF_ie == tok) {
                 while (*argv) {                  if (r->rstackpos == RSTACK_MAX - 1) {
                         if ( ! (*tree->cb.roffdata)                          mandoc_msg(MANDOCERR_MEM,
                                         (tree->arg, *argv++))                                  r->parse, ln, ppos, NULL);
                                 return(0);                          return(ROFF_ERR);
                 }                  }
                   r->rstack[++r->rstackpos] =
                 if ( ! ((*tree->cb.roffout)(tree->arg, tok)))                          ROFFRULE_DENY == r->last->rule ?
                         return(0);                          ROFFRULE_ALLOW : ROFFRULE_DENY;
                 return((*tree->cb.roffblkin)(tree->arg, tok));  
         }          }
   
         while (*argv) {          /* If the parent has false as its rule, then so do we. */
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  
                         if (NULL == tokens[c].cb) {  
                                 roff_err(tree, *argv, "unsupported "  
                                                 "macro `%s'",  
                                                 toknames[c]);  
                                 return(0);  
                         }  
                         if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))  
                                 return(0);  
                         break;  
                 }  
   
                 if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))          if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                         return(0);                  r->last->rule = ROFFRULE_DENY;
         }  
   
         if ( ! ((*tree->cb.roffout)(tree->arg, tok)))          /*
                 return(0);           * Determine scope.  If we're invoked with "\{" trailing the
         return((*tree->cb.roffblkin)(tree->arg, tok));           * conditional, then we're in a multiline scope.  Else our scope
            * expires on the next line.
            */
   
           r->last->endspan = 1;
   
           if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   r->last->endspan = -1;
                   pos += 2;
           }
   
           /*
            * If there are no arguments on the line, the next-line scope is
            * assumed.
            */
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
           /* Otherwise re-run the roff parser after recalculating. */
   
           *offs = pos;
           return(ROFF_RERUN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_ds(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];          char            *name, *string;
         char            *v, *argvp[ROFF_MAXARG];  
   
         if (ROFF_PRELUDE & tree->state) {          /*
                 roff_err(tree, *argv, "`%s' disallowed in prelude",           * A symbol is named by the first word following the macro
                                 toknames[tok]);           * invocation up to a space.  Its value is anything after the
                 return(0);           * name's trailing whitespace and optional double-quote.  Thus,
         }           *
            *  [.ds foo "bar  "     ]
            *
            * will have `bar  "     ' as its value.
            */
   
         i = 0;          string = *bufp + pos;
         argv++;          name = roff_getname(r, &string, ln, pos);
           if ('\0' == *name)
                   return(ROFF_IGN);
   
         while (-1 != (c = roffnextopt(tree, tok, &argv, &v))) {          /* Read past initial double-quote. */
                 if (ROFF_ARGMAX == c)          if ('"' == *string)
                         return(0);                  string++;
   
                 argcp[i] = c;          /* The rest is the value. */
                 argvp[i] = v;          roff_setstr(r, name, string, 0);
                 i++;          return(ROFF_IGN);
                 argv++;  }
         }  
   
         argcp[i] = ROFF_ARGMAX;  int
         argvp[i] = NULL;  roff_regisset(const struct roff *r, enum regs reg)
   {
   
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))          return(r->regs[(int)reg].set);
                 return(0);  }
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {  unsigned int
                 while (*argv) {  roff_regget(const struct roff *r, enum regs reg)
                         if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))  {
                                 return(0);  
                 }          return(r->regs[(int)reg].u);
                 return((*tree->cb.roffout)(tree->arg, tok));  }
   
   void
   roff_regunset(struct roff *r, enum regs reg)
   {
   
           r->regs[(int)reg].set = 0;
   }
   
   /* ARGSUSED */
   static enum rofferr
   roff_nr(ROFF_ARGS)
   {
           const char      *key;
           char            *val;
           int              iv;
   
           val = *bufp + pos;
           key = roff_getname(r, &val, ln, pos);
   
           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;
         }          }
   
         while (*argv) {          return(ROFF_IGN);
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  }
                         if (NULL == tokens[c].cb) {  
                                 roff_err(tree, *argv, "unsupported "  /* ARGSUSED */
                                                 "macro `%s'",  static enum rofferr
                                                 toknames[c]);  roff_rm(ROFF_ARGS)
                                 return(0);  {
                         }          const char       *name;
                         if ( ! (*tokens[c].cb)(c, tree,          char             *cp;
                                                 argv, ROFF_ENTER))  
                                 return(0);          cp = *bufp + pos;
                         break;          while ('\0' != *cp) {
                 }                  name = roff_getname(r, &cp, ln, (int)(cp - *bufp));
                 if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))                  if ('\0' != *name)
                         return(0);                          roff_setstr(r, name, NULL, 0);
         }          }
           return(ROFF_IGN);
   }
   
         return((*tree->cb.roffout)(tree->arg, tok));  /* ARGSUSED */
   static enum rofferr
   roff_TE(ROFF_ARGS)
   {
   
           if (NULL == r->tbl)
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
           else
                   tbl_end(&r->tbl);
   
           return(ROFF_IGN);
 }  }
   
   /* ARGSUSED */
   static enum rofferr
   roff_T_(ROFF_ARGS)
   {
   
           if (NULL == r->tbl)
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
           else
                   tbl_restart(ppos, ln, r->tbl);
   
           return(ROFF_IGN);
   }
   
   int
   roff_closeeqn(struct roff *r)
   {
   
           return(r->eqn && ROFF_EQN == eqn_end(&r->eqn) ? 1 : 0);
   }
   
   void
   roff_openeqn(struct roff *r, const char *name, int line,
                   int offs, const char *buf)
   {
           struct eqn_node *e;
           int              poff;
   
           assert(NULL == r->eqn);
           e = eqn_alloc(name, offs, line, r->parse);
   
           if (r->last_eqn)
                   r->last_eqn->next = e;
           else
                   r->first_eqn = r->last_eqn = e;
   
           r->eqn = r->last_eqn = e;
   
           if (buf) {
                   poff = 0;
                   eqn_read(&r->eqn, line, buf, offs, &poff);
           }
   }
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_comment(ROFFCALL_ARGS)  roff_EQ(ROFF_ARGS)
 {  {
   
         return(1);          roff_openeqn(r, *bufp + pos, ln, ppos, NULL);
           return(ROFF_IGN);
 }  }
   
   /* ARGSUSED */
   static enum rofferr
   roff_EN(ROFF_ARGS)
   {
   
           mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
           return(ROFF_IGN);
   }
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_close(ROFFCALL_ARGS)  roff_TS(ROFF_ARGS)
 {  {
           struct tbl_node *t;
   
         return(1);          if (r->tbl) {
                   mandoc_msg(MANDOCERR_SCOPEBROKEN, r->parse, ln, ppos, NULL);
                   tbl_end(&r->tbl);
           }
   
           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);
   
           /*
            * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
            * opening anything that's not in our cwd or anything beneath
            * it.  Thus, explicitly disallow traversing up the file-system
            * or using absolute paths.
            */
   
           name = *bufp + pos;
           if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
                   mandoc_msg(MANDOCERR_SOPATH, r->parse, ln, pos, NULL);
                   return(ROFF_ERR);
           }
   
           *offs = pos;
           return(ROFF_SO);
   }
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_special(ROFFCALL_ARGS)  roff_userdef(ROFF_ARGS)
 {  {
           const char       *arg[9];
           char             *cp, *n1, *n2;
           int               i;
   
         return((*tree->cb.roffspecial)(tree->arg, tok));          /*
            * Collect pointers to macro argument strings
            * and null-terminate them.
            */
           cp = *bufp + pos;
           for (i = 0; i < 9; i++)
                   arg[i] = '\0' == *cp ? "" :
                       mandoc_getarg(r->parse, &cp, ln, &pos);
   
           /*
            * 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;
                   }
   
                   *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
                   n2 = mandoc_malloc(*szp);
   
                   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;
           }
   
           /*
            * Replace the macro invocation
            * by the expanded macro.
            */
           free(*bufp);
           *bufp = n1;
           if (0 == *szp)
                   *szp = strlen(*bufp) + 1;
   
           return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
              ROFF_REPARSE : ROFF_APPEND);
 }  }
   
   static char *
   roff_getname(struct roff *r, char **cpp, int ln, int pos)
   {
           char     *name, *cp;
   
           name = *cpp;
           if ('\0' == *name)
                   return(name);
   
           /* Read until end of name. */
           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;
           }
   
           /* Nil-terminate name. */
           if ('\0' != *cp)
                   *(cp++) = '\0';
   
           /* Read past spaces. */
           while (' ' == *cp)
                   cp++;
   
           *cpp = cp;
           return(name);
   }
   
   /*
    * 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  static void
 roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)  roff_setstr(struct roff *r, const char *name, const char *string,
           int multiline)
 {  {
         va_list          ap;          struct roffstr   *n;
         char             buf[128];          char             *c;
           size_t            oldch, newch;
   
         va_start(ap, fmt);          /* Search for an existing string with the same name. */
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);          n = r->first_string;
         va_end(ap);          while (n && strcmp(name, n->name))
                   n = n->next;
   
         (*tree->cb.roffmsg)(tree->arg,          if (NULL == n) {
                         ROFF_WARN, tree->cur, pos, buf);                  /* 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;
           }
   
           if (NULL == string)
                   return;
   
           /*
            * One additional byte for the '\n' in multiline mode,
            * and one for the terminating '\0'.
            */
           newch = strlen(string) + (multiline ? 2u : 1u);
           if (NULL == n->string) {
                   n->string = mandoc_malloc(newch);
                   *n->string = '\0';
                   oldch = 0;
           } else {
                   oldch = strlen(n->string);
                   n->string = mandoc_realloc(n->string, oldch + newch);
           }
   
           /* Skip existing content in the destination buffer. */
           c = n->string + (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++;
           }
   
           /* Append terminating bytes. */
           if (multiline)
                   *c++ = '\n';
           *c = '\0';
 }  }
   
   static const char *
   roff_getstrn(const struct roff *r, const char *name, size_t len)
   {
           const struct roffstr *n;
   
           n = r->first_string;
           while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))
                   n = n->next;
   
           return(n ? n->string : NULL);
   }
   
 static void  static void
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  roff_freestr(struct roff *r)
 {  {
         va_list          ap;          struct roffstr   *n, *nn;
         char             buf[128];  
   
         va_start(ap, fmt);          for (n = r->first_string; n; n = nn) {
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);                  free(n->name);
         va_end(ap);                  free(n->string);
                   nn = n->next;
                   free(n);
           }
   
         (*tree->cb.roffmsg)(tree->arg,          r->first_string = NULL;
                         ROFF_ERROR, tree->cur, pos, buf);  }
   
   const struct tbl_span *
   roff_span(const struct roff *r)
   {
   
           return(r->tbl ? tbl_span(r->tbl) : NULL);
   }
   
   const struct eqn *
   roff_eqn(const struct roff *r)
   {
   
           return(r->last_eqn ? &r->last_eqn->eqn : NULL);
   }
   
   char
   roff_eqndelim(const struct roff *r)
   {
   
           return('\0');
 }  }
Legend:
Removed from v.1.15  
changed lines
  Added in v.1.153
CVSweb