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

Diff for /mandoc/roff.c between version 1.31 and 1.130

version 1.31, 2008/12/02 00:10:37 version 1.130, 2011/03/29 09:00:48
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 "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
   #include <errno.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  #include <limits.h>
 #include <stdarg.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <stdio.h>
   
 #include "libmdocml.h"  #include "mandoc.h"
 #include "private.h"  #include "libroff.h"
   #include "libmandoc.h"
   
 /* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  #define RSTACK_MAX      128
   
 /* TODO: warn about "X section only" macros. */  enum    rofft {
           ROFF_ad,
 /* TODO: warn about empty lists. */          ROFF_am,
           ROFF_ami,
 /* TODO: (warn) some sections need specific elements. */          ROFF_am1,
           ROFF_de,
 /* TODO: (warn) NAME section has particular order. */          ROFF_dei,
           ROFF_de1,
 /* TODO: unify empty-content tags a la <br />. */          ROFF_ds,
           ROFF_el,
 /* TODO: macros with a set number of arguments? */          ROFF_hy,
           ROFF_ie,
 #define ROFF_MAXARG       32          ROFF_if,
           ROFF_ig,
 enum    roffd {          ROFF_it,
         ROFF_ENTER = 0,          ROFF_ne,
         ROFF_EXIT          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, /* FIXME: remove this. */
           ROFF_USERDEF,
           ROFF_MAX
 };  };
   
 enum    rofftype {  enum    roffrule {
         ROFF_COMMENT,          ROFFRULE_ALLOW,
         ROFF_TEXT,          ROFFRULE_DENY
         ROFF_LAYOUT,  
         ROFF_SPECIAL  
 };  };
   
 #define ROFFCALL_ARGS \  struct  roffstr {
         int tok, struct rofftree *tree, \          char            *name; /* key of symbol */
         char *argv[], enum roffd type          char            *string; /* current value */
           struct roffstr  *next; /* next in list */
 struct  rofftree;  
   
 struct  rofftok {  
         int             (*cb)(ROFFCALL_ARGS);   /* Callback. */  
         const int        *args;                 /* Args (or NULL). */  
         const int        *parents;  
         const int        *children;  
         int               ctx;  
         enum rofftype     type;                 /* Type of macro. */  
         int               flags;  
 #define ROFF_PARSED      (1 << 0)               /* "Parsed". */  
 #define ROFF_CALLABLE    (1 << 1)               /* "Callable". */  
 #define ROFF_SHALLOW     (1 << 2)               /* Nesting block. */  
 #define ROFF_LSCOPE      (1 << 3)  
 };  };
   
 struct  roffarg {  struct  roff {
         int               flags;          struct mparse   *parse; /* parse point */
 #define ROFF_VALUE       (1 << 0)               /* Has a value. */          struct roffnode *last; /* leaf of stack */
           enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
           int              rstackpos; /* position in rstack */
           struct regset   *regs; /* read/writable registers */
           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 */
 };  };
   
 struct  roffnode {  struct  roffnode {
         int               tok;                  /* Token id. */          enum rofft       tok; /* type of node */
         struct roffnode  *parent;               /* Parent (or NULL). */          struct roffnode *parent; /* up one in stack */
           int              line; /* parse line */
           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 */
 };  };
   
 struct  rofftree {  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
         struct roffnode  *last;                 /* Last parsed node. */                           enum rofft tok, /* tok of macro */ \
         char             *cur;                           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 tm         tm;                   /* `Dd' results. */  typedef enum rofferr (*roffproc)(ROFF_ARGS);
         char              os[64];               /* `Os' results. */  
         char              title[64];            /* `Dt' results. */  
         char              section[64];          /* `Dt' results. */  
         char              volume[64];           /* `Dt' results. */  
   
         int               state;  struct  roffmac {
 #define ROFF_PRELUDE     (1 << 1)               /* In roff prelude. */          const char      *name; /* macro name */
 #define ROFF_PRELUDE_Os  (1 << 2)               /* `Os' is parsed. */          roffproc         proc; /* process new macro */
 #define ROFF_PRELUDE_Dt  (1 << 3)               /* `Dt' is parsed. */          roffproc         text; /* process as child text of macro */
 #define ROFF_PRELUDE_Dd  (1 << 4)               /* `Dd' is parsed. */          roffproc         sub; /* process as child of macro */
 #define ROFF_BODY        (1 << 5)               /* In roff body. */          int              flags;
   #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
         struct roffcb     cb;          struct roffmac  *next;
         void             *arg;  
 };  };
   
 static  int               roff_Dd(ROFFCALL_ARGS);  static  enum rofferr     roff_block(ROFF_ARGS);
 static  int               roff_Dt(ROFFCALL_ARGS);  static  enum rofferr     roff_block_text(ROFF_ARGS);
 static  int               roff_Os(ROFFCALL_ARGS);  static  enum rofferr     roff_block_sub(ROFF_ARGS);
 static  int               roff_Ns(ROFFCALL_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);
   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);
   
 static  int               roff_layout(ROFFCALL_ARGS);  /* See roff_hash_find() */
 static  int               roff_text(ROFFCALL_ARGS);  
 static  int               roff_noop(ROFFCALL_ARGS);  
 static  int               roff_depr(ROFFCALL_ARGS);  
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  #define ASCII_HI         126
 static  void              roffnode_free(struct rofftree *);  #define ASCII_LO         33
   #define HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
   
 static  void              roff_warn(const struct rofftree *,  static  struct roffmac  *hash[HASHWIDTH];
                                 const char *, char *, ...);  
 static  void              roff_err(const struct rofftree *,  
                                 const char *, char *, ...);  
   
 static  int               roffpurgepunct(struct rofftree *, char **);  static  struct roffmac   roffs[ROFF_MAX] = {
 static  int               roffscan(int, const int *);          { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
 static  int               rofffindtok(const char *);          { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static  int               rofffindarg(const char *);          { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static  int               rofffindcallable(const char *);          { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static  int               roffargs(const struct rofftree *,          { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                                 int, char *, char **);          { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static  int               roffargok(int, int);          { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static  int               roffnextopt(const struct rofftree *,          { "ds", roff_ds, NULL, NULL, 0, NULL },
                                 int, char ***, char **);          { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
 static  int               roffparseopts(struct rofftree *, int,          { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
                                 char ***, int *, char **);          { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
 static  int               roffparse(struct rofftree *, char *);          { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
 static  int               textparse(const struct rofftree *, char *);          { "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  void             roff_free1(struct roff *);
   static  enum rofft       roff_hash_find(const char *, size_t);
   static  void             roff_hash_init(void);
   static  void             roffnode_cleanscope(struct roff *);
   static  void             roffnode_push(struct roff *, enum rofft,
                                   const char *, int, int);
   static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(struct roff *, const char *, int *);
   static  int              roff_parse_nat(const char *, unsigned int *);
   
 static  const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit,  /* See roff_hash_find() */
         ROFF_ARGMAX };  #define ROFF_HASH(p)    (p[0] - ASCII_LO)
 static  const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled,  
         ROFF_Literal, ROFF_File, ROFF_Offset, ROFF_Filled,  
         ROFF_Compact, ROFF_ARGMAX };  
 static  const int roffarg_Bk[] = { ROFF_Words, ROFF_ARGMAX };  
 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 void
 static  const int roffchild_Fo[] = { ROFF_Fa, ROFF_Fc, ROFF_MAX };  roff_hash_init(void)
 static  const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B,  {
         ROFF__D, ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P,          struct roffmac   *n;
         ROFF__R, ROFF__T, ROFF__V, ROFF_MAX };          int               buc, i;
   
 static  const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };          for (i = 0; i < (int)ROFF_USERDEF; i++) {
 static  const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX };                  assert(roffs[i].name[0] >= ASCII_LO);
 static  const int roffparent_Oc[] = { ROFF_Oo, ROFF_MAX };                  assert(roffs[i].name[0] <= ASCII_HI);
 static  const int roffparent_It[] = { ROFF_Bl, ROFF_It, ROFF_MAX };  
 static  const int roffparent_Re[] = { ROFF_Rs, ROFF_MAX };  
   
 /* Table of all known tokens. */                  buc = ROFF_HASH(roffs[i].name);
 static  const struct rofftok tokens[ROFF_MAX] = {  
         {   roff_noop, 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, 0 }, /* Os */  
         { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, 0 }, /* Sh */  
         { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, 0 }, /* Ss */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Pp */ /* XXX 0 args */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_LSCOPE }, /* D1 */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_LSCOPE }, /* Dl */  
         { roff_layout, roffarg_Bd, NULL, NULL, 0, ROFF_LAYOUT, 0 },     /* Bd */  
         {   roff_noop, NULL, NULL, NULL, ROFF_Bd, ROFF_LAYOUT, 0 }, /* Ed */  
         { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */  
         {   roff_noop, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */  
         { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, ROFF_PARSED | ROFF_SHALLOW }, /* It */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */ /* FIXME */  
         {   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, 0 }, /* 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, 0 }, /* 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 | ROFF_LSCOPE }, /* Op */  
         {   roff_depr, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ot */  
         {   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 | ROFF_LSCOPE }, /* 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 */  
         { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bf */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Bq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */  
         {        NULL, 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 | ROFF_LSCOPE }, /* Dq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */  
         {   roff_noop, NULL, NULL, NULL, ROFF_Bf, ROFF_LAYOUT, 0 }, /* Ef */  
         {   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 */  
         {     roff_Ns, 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 */  
         {        NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* 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_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_LSCOPE }, /* Qq */  
         {   roff_noop, 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 | ROFF_LSCOPE }, /* Sq */  
         {        NULL, 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_noop, NULL, roffparent_Fc, NULL, ROFF_Fo, ROFF_LAYOUT, 0 }, /* Fc */  
         { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Oo */  
         {   roff_noop, NULL, roffparent_Oc, NULL, ROFF_Oo, ROFF_LAYOUT, 0 }, /* Oc */  
         { roff_layout, roffarg_Bk, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bk */  
         {   roff_noop, NULL, NULL, NULL, ROFF_Bk, ROFF_LAYOUT, 0 }, /* Ek */  
         {        NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Bt */  
         {        NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Hf */  
         {   roff_depr, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fr */  
         {        NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ud */  
         };  
   
 /* Table of all known token arguments. */                  if (NULL != (n = hash[buc])) {
 static  const int tokenargs[ROFF_ARGMAX] = {                          for ( ; n->next; n = n->next)
         0,              0,              0,              0,                                  /* Do nothing. */ ;
         0,              ROFF_VALUE,     ROFF_VALUE,     0,                          n->next = &roffs[i];
         0,              0,              0,              0,                  } else
         0,              0,              0,              0,                          hash[buc] = &roffs[i];
         0,              0,              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,  
         };  
   
 const   char *const toknamesp[ROFF_MAX] = {  
         "\\\"",         "Dd",           "Dt",           "Os",  
         "Sh",           "Ss",           "Pp",           "D1",  
         "Dl",           "Bd",           "Ed",           "Bl",  
         "El",           "It",           "Ad",           "An",  
         "Ar",           "Cd",           "Cm",           "Dv",  
         "Er",           "Ev",           "Ex",           "Fa",  
         "Fd",           "Fl",           "Fn",           "Ft",  
         "Ic",           "In",           "Li",           "Nd",  
         "Nm",           "Op",           "Ot",           "Pa",  
         "Rv",           "St",           "Va",           "Vt",  
         /* LINTED */  
         "Xr",           "\%A",          "\%B",          "\%D",  
         /* LINTED */  
         "\%I",          "\%J",          "\%N",          "\%O",  
         /* LINTED */  
         "\%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",           "Bt",           "Hf",  
         "Fr",           "Ud",  
         };  
   
 const   char *const tokargnamesp[ROFF_ARGMAX] = {  /*
         "split",                "nosplit",              "ragged",   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
         "unfilled",             "literal",              "file",   * the nil-terminated string name could be found.
         "offset",               "bullet",               "dash",   */
         "hyphen",               "item",                 "enum",  static enum rofft
         "tag",                  "diag",                 "hang",  roff_hash_find(const char *p, size_t s)
         "ohang",                "inset",                "column",  {
         "width",                "compact",              "std",          int              buc;
         "p1003.1-88",           "p1003.1-90",           "p1003.1-96",          struct roffmac  *n;
         "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;           * 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);
   
 int          buc = ROFF_HASH(p);
 roff_free(struct rofftree *tree, int flush)  
 {  
         int              error, t;  
         struct roffnode *n;  
   
         error = 0;          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));
   
         if ( ! flush)          return(ROFF_MAX);
                 goto end;  }
   
         error = 1;  
   
         if (ROFF_PRELUDE & tree->state) {  /*
                 roff_err(tree, NULL, "prelude never finished");   * Pop the current node off of the stack of roff instructions currently
                 goto end;   * pending.
         }   */
   static void
   roffnode_pop(struct roff *r)
   {
           struct roffnode *p;
   
         for (n = tree->last; n; n = n->parent) {          assert(r->last);
                 if (0 != tokens[n->tok].ctx)          p = r->last;
                         continue;  
                 roff_err(tree, NULL, "closing explicit scope `%s'",  
                                 toknames[n->tok]);  
                 goto end;  
         }  
   
         while (tree->last) {          if (ROFF_el == p->tok)
                 t = tree->last->tok;                  if (r->rstackpos > -1)
                 if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))                          r->rstackpos--;
                         goto end;  
         }  
   
         if ( ! (*tree->cb.rofftail)(tree->arg))          r->last = r->last->parent;
                 goto end;          free(p->name);
           free(p->end);
           free(p);
   }
   
         error = 0;  
   
 end:  /*
    * 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;
   
         while (tree->last)          p = mandoc_calloc(1, sizeof(struct roffnode));
                 roffnode_free(tree);          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;
   
         free(tree);          r->last = p;
   
         return(error ? 0 : 1);  
 }  }
   
   
 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;
   
         assert(args);          while (NULL != (t = r->first_tbl)) {
         assert(cb);                  r->first_tbl = t->next;
                   tbl_free(t);
           }
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))          r->first_tbl = r->last_tbl = r->tbl = NULL;
                 err(1, "calloc");  
   
         tree->state = ROFF_PRELUDE;          while (NULL != (e = r->first_eqn)) {
         tree->arg = args;                  r->first_eqn = e->next;
                   eqn_free(e);
           }
   
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));          r->first_eqn = r->last_eqn = r->eqn = NULL;
   
         return(tree);          while (r->last)
                   roffnode_pop(r);
   
           roff_freestr(r);
 }  }
   
   
 int  void
 roff_engine(struct rofftree *tree, char *buf)  roff_reset(struct roff *r)
 {  {
   
         tree->cur = buf;          roff_free1(r);
         assert(buf);  
   
         if (0 == *buf) {  
                 roff_err(tree, buf, "blank line");  
                 return(0);  
         } else if ('.' != *buf)  
                 return(textparse(tree, buf));  
   
         return(roffparse(tree, buf));  
 }  }
   
   
 static int  void
 textparse(const struct rofftree *tree, char *buf)  roff_free(struct roff *r)
 {  {
   
         if ( ! (ROFF_BODY & tree->state)) {          roff_free1(r);
                 roff_err(tree, buf, "data not in body");          free(r);
                 return(0);  
         }  
         return((*tree->cb.roffdata)(tree->arg, 1, buf));  
 }  }
   
   
 static int  struct roff *
 roffargs(const struct rofftree *tree,  roff_alloc(struct regset *regs, struct mparse *parse)
                 int tok, char *buf, char **argv)  
 {  {
         int              i;          struct roff     *r;
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          r = mandoc_calloc(1, sizeof(struct roff));
         assert('.' == *buf);          r->regs = regs;
           r->parse = parse;
         p = buf;          r->rstackpos = -1;
   
         /* 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) {          return(r);
                 roff_err(tree, p, "too many arguments for `%s'", toknames  
                                 [tok]);  
                 return(0);  
         }  
   
         argv[i] = NULL;  
         return(1);  
 }  }
   
   
   /*
    * 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
 roffscan(int tok, const int *tokv)  roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
 {  {
           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, '\\'))) {
                         return(1);                  stesc = cp++;
   
         return(0);                  /*
 }                   * 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);
                   if ('*' != *cp++)
                           continue;
   
 static int                  /*
 roffparse(struct rofftree *tree, char *buf)                   * 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];  
         char            **argvp;  
   
         if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))                  switch (*cp) {
                 if (0 == strncmp(buf, ".\\\"", 3))                  case ('\0'):
                         return(1);                          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);  
         }  
   
         assert(ROFF___ != tok);                  for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
         if ( ! roffargs(tree, tok, buf, argv))                          if ('\0' == *cp)
                 return(0);                                  return(1); /* Error. */
                           if (0 == maxl && ']' == *cp)
                                   break;
                   }
   
         argvp = (char **)argv;                  /*
                    * Retrieve the replacement string; if it is
                    * undefined, resume searching for escapes.
                    */
   
         /*                  res = roff_getstrn(r, stnam, (size_t)i);
          * Prelude macros break some assumptions, so branch now.  
          */  
   
         if (ROFF_PRELUDE & tree->state) {  
                 assert(NULL == tree->last);  
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
         }  
   
         assert(ROFF_BODY & tree->state);                  if (NULL == res) {
                           cp -= maxl ? 1 : 0;
                           continue;
                   }
   
         /*                  /* Replace the escape sequence by the string. */
          * First check that our possible parents and parent's possible  
          * children are satisfied.  
          */  
   
         if (tree->last && ! roffscan                  nsz = *szp + strlen(res) + 1;
                         (tree->last->tok, tokens[tok].parents)) {                  n = mandoc_malloc(nsz);
                 roff_err(tree, *argvp, "`%s' has invalid parent `%s'",  
                                 toknames[tok],  
                                 toknames[tree->last->tok]);  
                 return(0);  
         }  
   
         if (tree->last && ! roffscan                  strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
                         (tok, tokens[tree->last->tok].children)) {                  strlcat(n, res, nsz);
                 roff_err(tree, *argvp, "`%s' is invalid child of `%s'",                  strlcat(n, cp + (maxl ? 0 : 1), nsz);
                                 toknames[tok],  
                                 toknames[tree->last->tok]);                  free(*bufp);
   
                   *bufp = n;
                   *szp = nsz;
                 return(0);                  return(0);
         }          }
   
         /*          return(1);
          * Branch if we're not a layout token.  }
          */  
   
         if (ROFF_LAYOUT != tokens[tok].type)  
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
         if (0 == tokens[tok].ctx)  
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
   
   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;
   
         /*          /*
          * First consider implicit-end tags, like as follows:           * Run the reserved-word filter only if we have some reserved
          *      .Sh SECTION 1           * words to fill in.
          *      .Sh SECTION 2  
          * In this, we want to close the scope of the NAME section.  If  
          * there's an intermediary implicit-end tag, such as  
          *      .Sh SECTION 1  
          *      .Ss Subsection 1  
          *      .Sh SECTION 2  
          * then it must be closed as well.  
          */           */
   
         if (tok == tokens[tok].ctx) {          if (r->first_string && ! roff_res(r, bufp, szp, pos))
                 /*                  return(ROFF_REPARSE);
                  * 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) {          ppos = pos;
                         assert(0 == tokens[n->tok].ctx ||          ctl = mandoc_getcontrol(*bufp, &pos);
                                         n->tok == tokens[n->tok].ctx);  
                         if (n->tok == tok)  
                                 break;  
                         if (ROFF_SHALLOW & tokens[tok].flags) {  
                                 n = NULL;  
                                 break;  
                         }  
                         if (tokens[n->tok].ctx == n->tok)  
                                 continue;  
                         roff_err(tree, *argv, "`%s' breaks `%s' scope",  
                                         toknames[tok], toknames[n->tok]);  
                         return(0);  
                 }  
   
                 /*          /*
                  * Create a new scope, as no previous one exists to           * First, if a scope is open and we're not a macro, pass the
                  * close out.           * 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 (NULL == n)          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));
                   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));
                   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));
   
                 /*          /*
                  * Close out all intermediary scoped blocks, then hang           * If a scope is open, go to the child handler for that macro,
                  * the current scope from our predecessor's parent.           * as it may want to preprocess before doing anything with it.
                  */           * Don't do so if an equation is open.
            */
   
                 do {          if (r->last) {
                         t = tree->last->tok;                  t = r->last->tok;
                         if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))                  assert(roffs[t].sub);
                                 return(0);                  return((*roffs[t].sub)
                 } while (t != tok);                                  (r, t, bufp, szp,
                                    ln, ppos, pos, offs));
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
         }          }
   
         /*          /*
          * Now consider explicit-end tags, where we want to close back           * Lastly, as we've no scope open, try to look up and execute
          * to a specific tag.  Example:           * the new macro.  If no macro is found, simply return and let
          *      .Bl           * the compilers handle it.
          *      .It Item.  
          *      .El  
          * In this, the `El' tag closes out the scope of `Bl'.  
          */           */
   
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                   return(ROFF_CONT);
   
         for (n = tree->last; n; n = n->parent)          assert(roffs[t].proc);
                 if (n->tok != tokens[tok].ctx) {          return((*roffs[t].proc)
                         if (n->tok == tokens[n->tok].ctx)                          (r, t, bufp, szp,
                                 continue;                           ln, ppos, pos, offs));
                         roff_err(tree, *argv, "`%s' breaks `%s' scope",  
                                         toknames[tok], toknames[n->tok]);  
                         return(0);  
                 } else  
                         break;  
   
   
         if (NULL == n) {  
                 roff_err(tree, *argv, "`%s' has no starting tag `%s'",  
                                 toknames[tok],  
                                 toknames[tokens[tok].ctx]);  
                 return(0);  
         }  
   
         /* LINTED */  
         do {  
                 t = tree->last->tok;  
                 if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         return(1);  
 }  }
   
   
 static int  void
 rofffindarg(const char *name)  roff_endparse(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          if (r->last)
                   mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                                   r->last->line, r->last->col, NULL);
   
         /* LINTED */          if (r->eqn) {
         for (i = 0; i < ROFF_ARGMAX; i++)                  mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                 /* LINTED */                                  r->eqn->eqn.line, r->eqn->eqn.pos, NULL);
                 if (0 == strcmp(name, tokargnames[i]))                  eqn_end(r->eqn);
                         return((int)i);                  r->eqn = NULL;
           }
         return(ROFF_ARGMAX);  
           if (r->tbl) {
                   mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
                                   r->tbl->line, r->tbl->pos, NULL);
                   tbl_end(r->tbl);
                   r->tbl = NULL;
           }
 }  }
   
   /*
 static int   * Parse a roff node's type from the input buffer.  This must be in the
 rofffindtok(const char *buf)   * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(struct roff *r, const char *buf, int *pos)
 {  {
         char             token[4];          const char      *mac;
         int              i;          size_t           maclen;
           enum rofft       t;
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)          if ('\0' == buf[*pos] || '"' == buf[*pos])
                 token[i] = *buf;  
   
         if (i == 3)  
                 return(ROFF_MAX);                  return(ROFF_MAX);
   
         token[i] = 0;          mac = buf + *pos;
           maclen = strcspn(mac, " \\\t\0");
   
         /* FIXME: use a table, this is slow but ok for now. */          t = (r->current_string = roff_getstrn(r, mac, maclen))
               ? ROFF_USERDEF : roff_hash_find(mac, maclen);
   
         /* LINTED */          *pos += (int)maclen;
         for (i = 0; i < ROFF_MAX; i++)  
                 /* LINTED */  
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);          while (buf[*pos] && ' ' == buf[*pos])
                   (*pos)++;
   
           return(t);
 }  }
   
   
 static int  static int
 roffispunct(const char *p)  roff_parse_nat(const char *buf, unsigned int *res)
 {  {
           char            *ep;
           long             lval;
   
         if (0 == *p)          errno = 0;
           lval = strtol(buf, &ep, 10);
           if (buf[0] == '\0' || *ep != '\0')
                 return(0);                  return(0);
         if (0 != *(p + 1))          if ((errno == ERANGE &&
                           (lval == LONG_MAX || lval == LONG_MIN)) ||
                           (lval > INT_MAX || lval < 0))
                 return(0);                  return(0);
   
         switch (*p) {          *res = (unsigned int)lval;
         case('{'):          return(1);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_cblock(ROFF_ARGS)
   {
   
           /*
            * A block-close `..' should only be invoked as a child of an
            * ignore macro, otherwise raise a warning and just ignore it.
            */
   
           if (NULL == r->last) {
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
           }
   
           switch (r->last->tok) {
           case (ROFF_am):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('.'):          case (ROFF_ami):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(','):          case (ROFF_am1):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(';'):          case (ROFF_de):
                   /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(':'):          case (ROFF_dei):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('?'):          case (ROFF_ig):
                 /* FALLTHROUGH */  
         case('!'):  
                 /* FALLTHROUGH */  
         case('('):  
                 /* FALLTHROUGH */  
         case(')'):  
                 /* FALLTHROUGH */  
         case('['):  
                 /* FALLTHROUGH */  
         case(']'):  
                 /* FALLTHROUGH */  
         case('}'):  
                 return(1);  
         default:  
                 break;                  break;
           default:
                   mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
         }          }
   
         return(0);          if ((*bufp)[pos])
                   mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   
 }  }
   
   
 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] && ' ' != (*bufp)[pos])
 roffnode_free(struct rofftree *tree)                          pos++;
 {  
         struct roffnode *p;  
   
         assert(tree->last);                  while (' ' == (*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.
            */
   
           if (ROFF_de == tok)
                   roff_setstr(r, name, "", 0);
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
           /* If present, process the custom end-of-line marker. */
   
           sv = pos;
           while ((*bufp)[pos] &&
                           ' ' != (*bufp)[pos] &&
                           '\t' != (*bufp)[pos])
                   pos++;
   
           /*
            * 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.
            */
   
           assert(pos > sv);
           sz = (size_t)(pos - sv);
   
           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);
 }  }
   
   
 static int  /* ARGSUSED */
 roffnextopt(const struct rofftree *tree, int tok,  static enum rofferr
                 char ***in, char **val)  roff_block_sub(ROFF_ARGS)
 {  {
         char            *arg, **argv;          enum rofft      t;
         int              v;          int             i, j;
   
         *val = NULL;          /*
         argv = *in;           * First check whether a custom macro exists at this level.  If
         assert(argv);           * it does, then check against it.  This is some of groff's
            * 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 (NULL == (arg = *argv))          if (r->last->end) {
                 return(-1);                  for (i = pos, j = 0; r->last->end[j]; j++, i++)
         if ('-' != *arg)                          if ((*bufp)[i] != r->last->end[j])
                 return(-1);                                  break;
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {                  if ('\0' == r->last->end[j] &&
                 roff_warn(tree, arg, "argument-like parameter `%s' to "                                  ('\0' == (*bufp)[i] ||
                                 "`%s'", &arg[1], toknames[tok]);                                   ' ' == (*bufp)[i] ||
                 return(-1);                                   '\t' == (*bufp)[i])) {
         }                          roffnode_pop(r);
                           roffnode_cleanscope(r);
         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;                          while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                                   i++;
   
         if (NULL == *argv) {                          pos = i;
                 roff_err(tree, arg, "empty value of `%s' for `%s'",                          if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                 tokargnames[v], toknames[tok]);                                  return(ROFF_RERUN);
                 return(ROFF_ARGMAX);                          return(ROFF_IGN);
                   }
         }          }
   
         return(v);          /*
            * If we have no custom end-query or lookup failed, then try
            * pulling it out of the hashtable.
            */
   
           if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                   return(ROFF_IGN);
   
           /*
            * Macros other than block-end are only significant
            * 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);
           }
   
           assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
 }  }
   
   
 static int  /* ARGSUSED */
 roffpurgepunct(struct rofftree *tree, char **argv)  static enum rofferr
   roff_block_text(ROFF_ARGS)
 {  {
         int              i;  
   
         i = 0;          if (ROFF_de == tok)
         while (argv[i])                  roff_setstr(r, r->last->name, *bufp + pos, 1);
                 i++;  
         assert(i > 0);  
         if ( ! roffispunct(argv[--i]))  
                 return(1);  
         while (i >= 0 && roffispunct(argv[i]))  
                 i--;  
         i++;  
   
         /* LINTED */          return(ROFF_IGN);
         while (argv[i])  
                 if ( ! (*tree->cb.roffdata)(tree->arg, 0, argv[i++]))  
                         return(0);  
         return(1);  
 }  }
   
   
 static int  /* ARGSUSED */
 roffparseopts(struct rofftree *tree, int tok,  static enum rofferr
                 char ***args, int *argc, char **argv)  roff_cond_sub(ROFF_ARGS)
 {  {
         int              i, c;          enum rofft       t;
         char            *v;          enum roffrule    rr;
   
         i = 0;          rr = r->last->rule;
   
         while (-1 != (c = roffnextopt(tree, tok, args, &v))) {          /*
                 if (ROFF_ARGMAX == c)           * Clean out scope.  If we've closed ourselves, then don't
                         return(0);           * continue.
            */
   
                 argc[i] = c;          roffnode_cleanscope(r);
                 argv[i] = v;  
                 i++;          if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
                 *args = *args + 1;                  if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1])
                           return(roff_ccond
                                   (r, ROFF_ccond, bufp, szp,
                                    ln, pos, pos + 2, offs));
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
         }          }
   
         argc[i] = ROFF_ARGMAX;          /*
         argv[i] = NULL;           * A denied conditional must evaluate its children if and only
         return(1);           * if they're either structurally required (such as loops and
            * conditionals) or a closing macro.
            */
           if (ROFFRULE_DENY == rr)
                   if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
           assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_cond_text(ROFF_ARGS)
 {  {
         time_t           t;          char            *ep, *st;
         char            *p, buf[32];          enum roffrule    rr;
   
         if (ROFF_BODY & tree->state) {          rr = r->last->rule;
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dd & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          /*
         assert( ! (ROFF_BODY & tree->state));           * We display the value of the text if out current evaluation
            * scope permits us to do so.
            */
   
         if (ROFF_PRELUDE_Dd & tree->state) {          /* FIXME: use roff_ccond? */
                 roff_err(tree, *argv, "repeated `Dd' in prelude");  
                 return(0);          st = &(*bufp)[pos];
         } else if (ROFF_PRELUDE_Dt & tree->state) {          if (NULL == (ep = strstr(st, "\\}"))) {
                 roff_err(tree, *argv, "out-of-order `Dd' in prelude");                  roffnode_cleanscope(r);
                 return(0);                  return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
         }          }
   
         assert(NULL == tree->last);          if (ep == st || (ep > st && '\\' != *(ep - 1)))
                   roffnode_pop(r);
   
         argv++;          roffnode_cleanscope(r);
           return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   }
   
         if (0 == strcmp(*argv, "$Mdocdate$")) {  
                 t = time(NULL);  
                 if (NULL == localtime_r(&t, &tree->tm))  
                         err(1, "localtime_r");  
                 tree->state |= ROFF_PRELUDE_Dd;  
                 return(1);  
         }  
   
         /* Build this from Mdocdate or raw date. */  static enum roffrule
   roff_evalcond(const char *v, int *pos)
         buf[0] = 0;  {
         p = *argv;  
   
         if (0 != strcmp(*argv, "$Mdocdate:")) {          switch (v[*pos]) {
                 while (*argv) {          case ('n'):
                         if (strlcat(buf, *argv++, sizeof(buf))                  (*pos)++;
                                         < sizeof(buf))                  return(ROFFRULE_ALLOW);
                                 continue;          case ('e'):
                         roff_err(tree, p, "bad `Dd' date");                  /* FALLTHROUGH */
                         return(0);          case ('o'):
                 }                  /* FALLTHROUGH */
                 if (strptime(buf, "%b%d,%Y", &tree->tm)) {          case ('t'):
                         tree->state |= ROFF_PRELUDE_Dd;                  (*pos)++;
                         return(1);                  return(ROFFRULE_DENY);
                 }          default:
                 roff_err(tree, *argv, "bad `Dd' date");                  break;
                 return(0);  
         }          }
   
         argv++;          while (v[*pos] && ' ' != v[*pos])
         while (*argv && **argv != '$') {                  (*pos)++;
                 if (strlcat(buf, *argv++, sizeof(buf))          return(ROFFRULE_DENY);
                                 >= sizeof(buf)) {  }
                         roff_err(tree, p, "bad `Dd' Mdocdate");  
                         return(0);  
                 }  
                 if (strlcat(buf, " ", sizeof(buf))  
                                 >= sizeof(buf)) {  
                         roff_err(tree, p, "bad `Dd' Mdocdate");  
                         return(0);  
                 }  
         }  
         if (NULL == *argv) {  
                 roff_err(tree, p, "bad `Dd' Mdocdate");  
                 return(0);  
         }  
   
         if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) {  /* ARGSUSED */
                 roff_err(tree, *argv, "bad `Dd' Mdocdate");  static enum rofferr
                 return(0);  roff_line_ignore(ROFF_ARGS)
         }  {
   
         tree->state |= ROFF_PRELUDE_Dd;          if (ROFF_it == tok)
         return(1);                  mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos, "it");
   
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
           int              sv;
           enum roffrule    rule;
   
         if (ROFF_BODY & tree->state) {          /* Stack overflow! */
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dt & tree->state);          if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
                 return(roff_text(tok, tree, argv, type));                  mandoc_msg(MANDOCERR_MEM, r->parse, ln, ppos, NULL);
                   return(ROFF_ERR);
         }          }
   
         assert(ROFF_PRELUDE & tree->state);          /* First, evaluate the conditional. */
         assert( ! (ROFF_BODY & tree->state));  
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state)) {          if (ROFF_el == tok) {
                 roff_err(tree, *argv, "out-of-order `Dt' in prelude");                  /*
                 return(0);                   * An `.el' will get the value of the current rstack
         } else if (ROFF_PRELUDE_Dt & tree->state) {                   * entry set in prior `ie' calls or defaults to DENY.
                 roff_err(tree, *argv, "repeated `Dt' in prelude");                   */
                 return(0);                  if (r->rstackpos < 0)
         }                          rule = ROFFRULE_DENY;
                   else
                           rule = r->rstack[r->rstackpos];
           } else
                   rule = roff_evalcond(*bufp, &pos);
   
         argv++;          sv = pos;
         if (NULL == *argv) {  
                 roff_err(tree, *argv, "`Dt' needs document title");  
                 return(0);  
         } else if (strlcpy(tree->title, *argv, sizeof(tree->title))  
                         >= sizeof(tree->title)) {  
                 roff_err(tree, *argv, "`Dt' document title too long");  
                 return(0);  
         }  
   
         argv++;          while (' ' == (*bufp)[pos])
         if (NULL == *argv) {                  pos++;
                 roff_err(tree, *argv, "`Dt' needs section");  
                 return(0);  
         } else if (strlcpy(tree->section, *argv, sizeof(tree->section))  
                         >= sizeof(tree->section)) {  
                 roff_err(tree, *argv, "`Dt' section too long");  
                 return(0);  
         }  
   
         argv++;          /*
         if (NULL == *argv) {           * Roff is weird.  If we have just white-space after the
                 tree->volume[0] = 0;           * conditional, it's considered the BODY and we exit without
         } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume))           * really doing anything.  Warn about this.  It's probably
                         >= sizeof(tree->volume)) {           * wrong.
                 roff_err(tree, *argv, "`Dt' volume too long");           */
                 return(0);  
           if ('\0' == (*bufp)[pos] && sv != pos) {
                   mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
                   return(ROFF_IGN);
         }          }
   
         assert(NULL == tree->last);          roffnode_push(r, tok, NULL, ln, ppos);
         tree->state |= ROFF_PRELUDE_Dt;  
   
         return(1);          r->last->rule = rule;
 }  
   
           if (ROFF_ie == tok) {
                   /*
                    * An if-else will put the NEGATION of the current
                    * evaluated conditional into the stack.
                    */
                   r->rstackpos++;
                   if (ROFFRULE_DENY == r->last->rule)
                           r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
                   else
                           r->rstack[r->rstackpos] = ROFFRULE_DENY;
           }
   
 /* ARGSUSED */          /* If the parent has false as its rule, then so do we. */
 static  int  
 roff_Ns(ROFFCALL_ARGS)  
 {  
         int              j, c, first;  
   
         first = (*argv == tree->cur);          if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                   r->last->rule = ROFFRULE_DENY;
   
         argv++;          /*
            * Determine scope.  If we're invoked with "\{" trailing the
            * conditional, then we're in a multiline scope.  Else our scope
            * expires on the next line.
            */
   
         if (ROFF_MAX != (c = rofffindcallable(*argv))) {          r->last->endspan = 1;
                 if (NULL == tokens[c].cb) {  
                         roff_err(tree, *argv, "unsupported macro `%s'",          if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                                         toknames[c]);                  r->last->endspan = -1;
                         return(0);                  pos += 2;
                 }  
                 if ( ! (*tree->cb.roffspecial)(tree->arg, tok))  
                         return(0);  
                 if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))  
                         return(0);  
                 if ( ! first)  
                         return(1);  
                 return(roffpurgepunct(tree, argv));  
         }          }
   
         if ( ! (*tree->cb.roffdata)(tree->arg, 0, *argv++))          /*
                 return(0);           * If there are no arguments on the line, the next-line scope is
            * assumed.
            */
   
         while (*argv) {          if ('\0' == (*bufp)[pos])
                 if (ROFF_MAX == (c = rofffindcallable(*argv))) {                  return(ROFF_IGN);
                         if ( ! roffispunct(*argv)) {  
                                 if ( ! (*tree->cb.roffdata)  
                                                 (tree->arg, 1, *argv++))  
                                         return(0);  
                                 continue;  
                         }  
   
                         /* FIXME: this is identical to that of  
                          * roff_text. */  
   
                         /* See if only punctuation remains. */          /* Otherwise re-run the roff parser after recalculating. */
   
                         for (j = 0; argv[j]; j++)          *offs = pos;
                                 if ( ! roffispunct(argv[j]))          return(ROFF_RERUN);
                                         break;  }
   
                         if (argv[j]) {  
                                 if ( ! (*tree->cb.roffdata)  
                                                 (tree->arg, 0, *argv++))  
                                         return(0);  
                                 continue;  
                         }  
   
                         /*  Only punctuation remains. */  /* ARGSUSED */
   static enum rofferr
   roff_ds(ROFF_ARGS)
   {
           char            *name, *string;
   
                         break;          /*
                 }           * A symbol is named by the first word following the macro
                 if (NULL == tokens[c].cb) {           * invocation up to a space.  Its value is anything after the
                         roff_err(tree, *argv, "unsupported macro `%s'",           * name's trailing whitespace and optional double-quote.  Thus,
                                         toknames[c]);           *
                         return(0);           *  [.ds foo "bar  "     ]
                 }           *
                 if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))           * will have `bar  "     ' as its value.
                         return(0);           */
                 break;  
         }  
   
         if ( ! first)          string = *bufp + pos;
                 return(1);          name = roff_getname(r, &string, ln, pos);
         return(roffpurgepunct(tree, argv));          if ('\0' == *name)
                   return(ROFF_IGN);
   
           /* Read past initial double-quote. */
           if ('"' == *string)
                   string++;
   
           /* The rest is the value. */
           roff_setstr(r, name, string, 0);
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_nr(ROFF_ARGS)
 {  {
         char            *p;          const char      *key;
           char            *val;
           struct reg      *rg;
   
         if (ROFF_BODY & tree->state) {          val = *bufp + pos;
                 assert( ! (ROFF_PRELUDE & tree->state));          key = roff_getname(r, &val, ln, pos);
                 assert(ROFF_PRELUDE_Os & tree->state);          rg = r->regs->regs;
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          if (0 == strcmp(key, "nS")) {
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||                  rg[(int)REG_nS].set = 1;
                         ! (ROFF_PRELUDE_Dd & tree->state)) {                  if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
                 roff_err(tree, *argv, "out-of-order `Os' in prelude");                          rg[(int)REG_nS].v.u = 0;
                 return(0);  
         }          }
   
         tree->os[0] = 0;          return(ROFF_IGN);
   }
   
         p = *++argv;  /* ARGSUSED */
   static enum rofferr
   roff_rm(ROFF_ARGS)
   {
           const char       *name;
           char             *cp;
   
         while (*argv) {          cp = *bufp + pos;
                 if (strlcat(tree->os, *argv++, sizeof(tree->os))          while ('\0' != *cp) {
                                 < sizeof(tree->os))                  name = roff_getname(r, &cp, ln, (int)(cp - *bufp));
                         continue;                  if ('\0' != *name)
                 roff_err(tree, p, "`Os' value too long");                          roff_setstr(r, name, NULL, 0);
                 return(0);  
         }          }
           return(ROFF_IGN);
   }
   
         if (0 == tree->os[0])  /* ARGSUSED */
                 if (strlcpy(tree->os, "LOCAL", sizeof(tree->os))  static enum rofferr
                                 >= sizeof(tree->os)) {  roff_TE(ROFF_ARGS)
                         roff_err(tree, p, "`Os' value too long");  {
                         return(0);  
                 }  
   
         tree->state |= ROFF_PRELUDE_Os;          if (NULL == r->tbl)
         tree->state &= ~ROFF_PRELUDE;                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
         tree->state |= ROFF_BODY;          else
                   tbl_end(r->tbl);
   
         assert(NULL == tree->last);          r->tbl = NULL;
           return(ROFF_IGN);
         return((*tree->cb.roffhead)(tree->arg));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_layout(ROFFCALL_ARGS)  roff_T_(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];  
         char            *argvp[ROFF_MAXARG];  
   
         if (ROFF_PRELUDE & tree->state) {          if (NULL == r->tbl)
                 roff_err(tree, *argv, "bad `%s' in prelude",                  mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                                 toknames[tok]);          else
                 return(0);                  tbl_restart(ppos, ln, r->tbl);
         } else if (ROFF_EXIT == type) {  
                 roffnode_free(tree);  
                 return((*tree->cb.roffblkout)(tree->arg, tok));  
         }  
   
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));          return(ROFF_IGN);
   }
   
         ++argv;  /* ARGSUSED */
   static enum rofferr
   roff_EQ(ROFF_ARGS)
   {
           struct eqn_node *e;
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))          assert(NULL == r->eqn);
                 return(0);          e = eqn_alloc(ppos, ln);
         if (NULL == roffnode_new(tok, tree))  
                 return(0);  
   
         /*          if (r->last_eqn)
          * Layouts have two parts: the layout body and header.  The                  r->last_eqn->next = e;
          * layout header is the trailing text of the line macro, while          else
          * the layout body is everything following until termination.                  r->first_eqn = r->last_eqn = e;
          */  
   
         if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp, argvp))          r->eqn = r->last_eqn = e;
                 return(0);          return(ROFF_IGN);
         if (NULL == *argv)  }
                 return(1);  
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))  
                 return(0);  
   
         /*  /* ARGSUSED */
          * If there are no parsable parts, then write remaining tokens  static enum rofferr
          * into the layout header and exit.  roff_EN(ROFF_ARGS)
          */  {
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
                 i = 0;          return(ROFF_IGN);
                 while (*argv) {  }
                         if ( ! (*tree->cb.roffdata)(tree->arg, i, *argv++))  
                                 return(0);  
                         i = 1;  
                 }  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }  
   
         /*  /* ARGSUSED */
          * Parsable elements may be in the header (or be the header, for  static enum rofferr
          * that matter).  Follow the regular parsing rules for these.  roff_TS(ROFF_ARGS)
          */  {
           struct tbl_node *t;
   
         i = 0;          if (r->tbl) {
         while (*argv) {                  mandoc_msg(MANDOCERR_SCOPEBROKEN, r->parse, ln, ppos, NULL);
                 if (ROFF_MAX == (c = rofffindcallable(*argv))) {                  tbl_end(r->tbl);
                         assert(tree->arg);          }
                         if ( ! (*tree->cb.roffdata)  
                                         (tree->arg, i, *argv++))  
                                 return(0);  
                         i = 1;  
                         continue;  
                 }  
   
                 if (NULL == tokens[c].cb) {          t = tbl_alloc(ppos, ln, r->parse);
                         roff_err(tree, *argv, "unsupported macro `%s'",  
                                         toknames[c]);  
                         return(0);  
                 }  
   
                 if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))          if (r->last_tbl)
                         return(0);                  r->last_tbl->next = t;
           else
                   r->first_tbl = r->last_tbl = t;
   
                 break;          r->tbl = r->last_tbl = t;
         }          return(ROFF_IGN);
   }
   
         /*  /* ARGSUSED */
          * If there's trailing punctuation in the header, then write it  static enum rofferr
          * out now.  Here we mimic the behaviour of a line-dominant text  roff_so(ROFF_ARGS)
          * macro.  {
          */          char *name;
   
         if (NULL == *argv)          mandoc_msg(MANDOCERR_SO, r->parse, ln, ppos, NULL);
                 return((*tree->cb.roffout)(tree->arg, tok));  
   
         /*          /*
          * Expensive.  Scan to the end of line then work backwards until           * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
          * a token isn't punctuation.           * opening anything that's not in our cwd or anything beneath
            * it.  Thus, explicitly disallow traversing up the file-system
            * or using absolute paths.
          */           */
   
         if ( ! roffpurgepunct(tree, argv))          name = *bufp + pos;
                 return(0);          if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
                   mandoc_msg(MANDOCERR_SOPATH, r->parse, ln, pos, NULL);
                   return(ROFF_ERR);
           }
   
         return((*tree->cb.roffout)(tree->arg, tok));          *offs = pos;
           return(ROFF_SO);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_userdef(ROFF_ARGS)
 {  {
         int              i, j, first, c, argcp[ROFF_MAXARG];          const char       *arg[9];
         char            *argvp[ROFF_MAXARG];          char             *cp, *n1, *n2;
           int               i;
   
         if (ROFF_PRELUDE & tree->state) {          /*
                 roff_err(tree, *argv, "`%s' disallowed in prelude",           * Collect pointers to macro argument strings
                                 toknames[tok]);           * and null-terminate them.
                 return(0);           */
         }          cp = *bufp + pos;
           for (i = 0; i < 9; i++)
                   arg[i] = '\0' == *cp ? "" :
                       mandoc_getarg(r->parse, &cp, ln, &pos);
   
         first = (*argv == tree->cur);          /*
         argv++;           * 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;
                   }
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))                  *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
                 return(0);                  n2 = mandoc_malloc(*szp);
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))  
                 return(0);  
         if (NULL == *argv)  
                 return((*tree->cb.roffout)(tree->arg, tok));  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {                  strlcpy(n2, n1, (size_t)(cp - n1 + 1));
                 i = 0;                  strlcat(n2, arg[i], *szp);
                 while (*argv) {                  strlcat(n2, cp + 3, *szp);
                         if ( ! (*tree->cb.roffdata)(tree->arg, i, *argv++))  
                                 return(0);                  cp = n2 + (cp - n1);
                         i = 1;                  free(n1);
                 }                  n1 = n2;
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }          }
   
         /*          /*
          * Deal with punctuation.  Ugly.  Work ahead until we encounter           * Replace the macro invocation
          * terminating punctuation.  If we encounter it and all           * by the expanded macro.
          * subsequent tokens are punctuation, then stop processing (the  
          * line-dominant macro will print these tokens after closure).  
          */           */
           free(*bufp);
           *bufp = n1;
           if (0 == *szp)
                   *szp = strlen(*bufp) + 1;
   
         i = 0;          return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
         while (*argv) {             ROFF_REPARSE : ROFF_APPEND);
                 if (ROFF_MAX == (c = rofffindcallable(*argv))) {  }
                         if ( ! roffispunct(*argv)) {  
                                 if ( ! (*tree->cb.roffdata)  
                                                 (tree->arg, i, *argv++))  
                                         return(0);  
                                 i = 1;  
                                 continue;  
                         }  
   
                         /* See if only punctuation remains. */  static char *
   roff_getname(struct roff *r, char **cpp, int ln, int pos)
   {
           char     *name, *cp;
   
                         i = 1;          name = *cpp;
                         for (j = 0; argv[j]; j++)          if ('\0' == *name)
                                 if ( ! roffispunct(argv[j]))                  return(name);
                                         break;  
   
                         if (argv[j]) {          /* Read until end of name. */
                                 if ( ! (*tree->cb.roffdata)          for (cp = name; '\0' != *cp && ' ' != *cp; cp++) {
                                                 (tree->arg, 0, *argv++))                  if ('\\' != *cp)
                                         return(0);                          continue;
                                 continue;                  cp++;
                         }                  if ('\\' == *cp)
                           continue;
                   mandoc_msg(MANDOCERR_NAMESC, r->parse, ln, pos, NULL);
                   *cp = '\0';
                   name = cp;
           }
   
                         /*  Only punctuation remains. */          /* Nil-terminate name. */
           if ('\0' != *cp)
                   *(cp++) = '\0';
   
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))          /* Read past spaces. */
                                 return(0);          while (' ' == *cp)
                         break;                  cp++;
                 }  
   
                 /*          *cpp = cp;
                  * A sub-command has been found.  Execute it and          return(name);
                  * discontinue parsing for arguments.  If we're  }
                  * line-scoped, then close out after it returns; if we  
                  * aren't, then close out before.  
                  */  
   
                 if (NULL == tokens[c].cb) {  /*
                         roff_err(tree, *argv, "unsupported macro `%s'",   * Store *string into the user-defined string called *name.
                                         toknames[c]);   * In multiline mode, append to an existing entry and append '\n';
                         return(0);   * else replace the existing entry, if there is one.
                 }   * To clear an existing entry, call with (*r, *name, NULL, 0).
    */
                 if ( ! (ROFF_LSCOPE & tokens[tok].flags))  static void
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))  roff_setstr(struct roff *r, const char *name, const char *string,
                                 return(0);          int multiline)
   {
                 if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))          struct roffstr   *n;
                         return(0);          char             *c;
           size_t            oldch, newch;
   
                 if (ROFF_LSCOPE & tokens[tok].flags)          /* Search for an existing string with the same name. */
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))          n = r->first_string;
                                 return(0);          while (n && strcmp(name, n->name))
                   n = n->next;
   
                 break;          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;
         }          }
   
         if (NULL == *argv)          if (NULL == string)
                 return((*tree->cb.roffout)(tree->arg, tok));                  return;
         if ( ! first)  
                 return(1);  
   
         return(roffpurgepunct(tree, argv));          /*
 }           * 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;
   
 /* ARGSUSED */          /* Append new content to the destination buffer. */
 static int          while (*string) {
 roff_noop(ROFFCALL_ARGS)                  /*
 {                   * Rudimentary roff copy mode:
                    * Handle escaped backslashes.
                    */
                   if ('\\' == *string && '\\' == *(string + 1))
                           string++;
                   *c++ = *string++;
           }
   
         return(1);          /* Append terminating bytes. */
           if (multiline)
                   *c++ = '\n';
           *c = '\0';
 }  }
   
   static const char *
 /* ARGSUSED */  roff_getstrn(const struct roff *r, const char *name, size_t len)
 static int  
 roff_depr(ROFFCALL_ARGS)  
 {  {
           const struct roffstr *n;
   
         roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]);          n = r->first_string;
         return(0);          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_warn(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_WARN, tree->cur, pos, buf);  
 }  }
   
   const struct tbl_span *
 static void  roff_span(const struct roff *r)
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  
 {  {
         va_list          ap;  
         char             buf[128];          return(r->tbl ? tbl_span(r->tbl) : NULL);
   }
   
         va_start(ap, fmt);  const struct eqn *
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);  roff_eqn(const struct roff *r)
         va_end(ap);  {
   
         (*tree->cb.roffmsg)(tree->arg,          return(r->last_eqn ? &r->last_eqn->eqn : NULL);
                         ROFF_ERROR, tree->cur, pos, buf);  
 }  }
Legend:
Removed from v.1.31  
changed lines
  Added in v.1.130
CVSweb