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

Diff for /mandoc/roff.c between version 1.19 and 1.86

version 1.19, 2008/11/29 16:23:22 version 1.86, 2010/06/01 11:47:28
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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 AUTHOR DISCLAIMS 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 AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  
 #include <stdarg.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <stdio.h>
   
 #include "libmdocml.h"  #include "mandoc.h"
 #include "private.h"  #include "roff.h"
   
 /* FIXME: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  #define RSTACK_MAX      128
   
 /* FIXME: warn about "X section only" macros. */  #define ROFF_CTL(c) \
           ('.' == (c) || '\'' == (c))
   
 /* FIXME: warn about empty lists. */  enum    rofft {
           ROFF_am,
 /* FIXME: ; : } ) (etc.) after text macros? */          ROFF_ami,
           ROFF_am1,
 /* FIXME: NAME section needs specific elements. */          ROFF_de,
           ROFF_dei,
 /* FIXME: don't print Os, just do roffbegin. */          ROFF_de1,
           ROFF_ds,
 #define ROFF_MAXARG       32          ROFF_el,
           ROFF_ie,
 enum    roffd {          ROFF_if,
         ROFF_ENTER = 0,          ROFF_ig,
         ROFF_EXIT          ROFF_rm,
           ROFF_tr,
           ROFF_cblock,
           ROFF_ccond,
           ROFF_MAX
 };  };
   
 enum    rofftype {  enum    roffrule {
         ROFF_COMMENT,          ROFFRULE_ALLOW,
         ROFF_TEXT,          ROFFRULE_DENY
         ROFF_LAYOUT,  
         ROFF_SPECIAL  
 };  };
   
 #define ROFFCALL_ARGS \  struct  roff {
         int tok, struct rofftree *tree, \          struct roffnode *last; /* leaf of stack */
         char *argv[], enum roffd type          mandocmsg        msg; /* err/warn/fatal messages */
           void            *data; /* privdata for messages */
 struct  rofftree;          enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
           int              rstackpos; /* position in rstack */
 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_QUOTES      (1 << 2)               /* Quoted args. */  
 #define ROFF_SHALLOW     (1 << 3)               /* Nesting block. */  
 #define ROFF_PUNCT       (1 << 4)  
 };  };
   
 struct  roffarg {  
         int               flags;  
 #define ROFF_VALUE       (1 << 0)               /* Has a value. */  
 };  
   
 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            *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 */
   
         time_t            date;                 /* `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  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_line(ROFF_ARGS);
   
 static  int               roff_layout(ROFFCALL_ARGS);  /* See roff_hash_find() */
 static  int               roff_text(ROFFCALL_ARGS);  
 static  int               roff_comment(ROFFCALL_ARGS);  
 static  int               roff_close(ROFFCALL_ARGS);  
 static  int               roff_special(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               roffscan(int, const int *);  static  struct roffmac   roffs[ROFF_MAX] = {
 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_line, NULL, NULL, 0, NULL },
                                 int, char ***, char **);          { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
 static  int               roffparse(struct rofftree *, char *);          { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
 static  int               textparse(const struct rofftree *, char *);          { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
           { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "rm", roff_line, NULL, NULL, 0, NULL },
           { "tr", roff_line, NULL, NULL, 0, NULL },
           { ".", roff_cblock, NULL, NULL, 0, NULL },
           { "\\}", roff_ccond, NULL, NULL, 0, NULL },
   };
   
   static  void             roff_free1(struct roff *);
   static  enum rofft       roff_hash_find(const char *);
   static  void             roff_hash_init(void);
   static  void             roffnode_cleanscope(struct roff *);
   static  int              roffnode_push(struct roff *,
                                   enum rofft, int, int);
   static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(const char *, 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_Oo[] = { ROFF_Op, ROFF_Oc, ROFF_MAX };  
 static  const int roffchild_Rs[] = { ROFF_Re, ROFF__A, ROFF__B,  
         ROFF__D, ROFF__I, ROFF__J, ROFF__N, ROFF__O, ROFF__P,  
         ROFF__R, ROFF__T, ROFF__V, ROFF_MAX };  
   
 static  const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX };  
 static  const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX };  
 static  const int roffparent_Oc[] = { ROFF_Oo, ROFF_Oc, ROFF_MAX };  
 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. */  
 static  const struct rofftok tokens[ROFF_MAX] = {  
         {roff_comment, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */  
         {     roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */  
         {     roff_Dt, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dt */  
         {     roff_Os, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Os */  
         { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */  
         { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */  
         {   roff_text, NULL, NULL, NULL, ROFF_Pp, ROFF_TEXT, 0 }, /* Pp */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* D1 */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Dl */  
         { roff_layout, roffarg_Bd, NULL, NULL, 0, ROFF_LAYOUT, 0 },     /* Bd */  
         {  roff_close, NULL, NULL, NULL, ROFF_Bd, ROFF_LAYOUT, 0 }, /* Ed */  
         { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */  
         {  roff_close, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */  
         { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, ROFF_SHALLOW }, /* It */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Ad */  
         {   roff_text, roffarg_An, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* An */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Ar */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Cd */ /* XXX man.4 only */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Dv */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Er */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* 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 | ROFF_PUNCT }, /* 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 | ROFF_PUNCT }, /* Fl */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Fn */ /* XXX needs arg */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Ft */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* 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 | ROFF_PUNCT }, /* Li */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Nd */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Nm */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Op */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ot */ /* XXX deprecated */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* 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 | ROFF_PUNCT }, /* Va */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Vt */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Xr */ /* XXX needs arg */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %D */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %N */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %O */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %P */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %R */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %V */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* At */ /* XXX at most 2 args */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 },  /* Bf */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Bsx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Bx */  
         {roff_special, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 },  /* Db */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 },  /* Ef */ /* FIXME */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* 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 | ROFF_PUNCT }, /* Fx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Ms */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Nx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Ox */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_LAYOUT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */  
         { roff_layout, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */  
         {  roff_close, NULL, roffparent_Re, NULL, ROFF_Rs, ROFF_LAYOUT, 0 }, /* Re */  
         { roff_layout, NULL, NULL, roffchild_Rs, 0, ROFF_LAYOUT, 0 },   /* Rs */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */  
         {roff_special, NULL, NULL, NULL, 0, ROFF_SPECIAL, 0 }, /* Sm */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Sy */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE | ROFF_PUNCT }, /* Tn */  
         {   roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_PUNCT }, /* Ux */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */  
         {   NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */  
         { roff_layout, NULL, NULL, roffchild_Fo, 0, ROFF_LAYOUT, 0 }, /* Fo */  
         {  roff_close, NULL, roffparent_Fc, NULL, ROFF_Fo, ROFF_LAYOUT, 0 }, /* Fc */  
         { roff_layout, NULL, NULL, roffchild_Oo, 0, ROFF_LAYOUT, 0 }, /* Oo */  
         {  roff_close, NULL, roffparent_Oc, NULL, ROFF_Oo, ROFF_LAYOUT, 0 }, /* Oc */  
         { roff_layout, roffarg_Bk, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bk */  
         {  roff_close, NULL, NULL, NULL, ROFF_Bk, ROFF_LAYOUT, 0 }, /* Ek */  
         };  
   
 /* Table of all known token arguments. */  
 static  const int tokenargs[ROFF_ARGMAX] = {  
         0,              0,              0,              0,  
         0,              ROFF_VALUE,     ROFF_VALUE,     0,  
         0,              0,              0,              0,  
         0,              0,              0,              0,  
         0,              0,              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",  
         "Xr",           "\%A",          "\%B",          "\%D",  
         "\%I",          "\%J",          "\%N",          "\%O",  
         "\%P",          "\%R",          "\%T",          "\%V",  
         "Ac",           "Ao",           "Aq",           "At",  
         "Bc",           "Bf",           "Bo",           "Bq",  
         "Bsx",          "Bx",           "Db",           "Dc",  
         "Do",           "Dq",           "Ec",           "Ef",  
         "Em",           "Eo",           "Fx",           "Ms",  
         "No",           "Ns",           "Nx",           "Ox",  
         "Pc",           "Pf",           "Po",           "Pq",  
         "Qc",           "Ql",           "Qo",           "Qq",  
         "Re",           "Rs",           "Sc",           "So",  
         "Sq",           "Sm",           "Sx",           "Sy",  
         "Tn",           "Ux",           "Xc",           "Xo",  
         "Fo",           "Fc",           "Oo",           "Oc",  
         "Bk",           "Ek",  
         };  
   
 const   char *const tokargnamesp[ROFF_ARGMAX] = {  
         "split",                "nosplit",              "ragged",  
         "unfilled",             "literal",              "file",  
         "offset",               "bullet",               "dash",  
         "hyphen",               "item",                 "enum",  
         "tag",                  "diag",                 "hang",  
         "ohang",                "inset",                "column",  
         "width",                "compact",              "std",  
         "p1003.1-88",           "p1003.1-90",           "p1003.1-96",  
         "p1003.1-2001",         "p1003.1-2004",         "p1003.1",  
         "p1003.1b",             "p1003.1b-93",          "p1003.1c-95",  
         "p1003.1g-2000",        "p1003.2-92",           "p1387.2-95",  
         "p1003.2",              "p1387.2",              "isoC-90",  
         "isoC-amd1",            "isoC-tcor1",           "isoC-tcor2",  
         "isoC-99",              "ansiC",                "ansiC-89",  
         "ansiC-99",             "ieee754",              "iso8802-3",  
         "xpg3",                 "xpg4",                 "xpg4.2",  
         "xpg4.3",               "xbd5",                 "xcu5",  
         "xsh5",                 "xns5",                 "xns5.2d2.0",  
         "xcurses4.2",           "susv2",                "susv3",  
         "svid4",                "filled",               "words",  
         };  
   
 const   char *const *toknames = toknamesp;  
 const   char *const *tokargnames = tokargnamesp;  
   
   
 int  
 roff_free(struct rofftree *tree, int flush)  
 {  {
         int              error, t;          struct roffmac   *n;
         struct roffnode *n;          int               buc, i;
   
         error = 0;          for (i = 0; i < (int)ROFF_MAX; i++) {
                   assert(roffs[i].name[0] >= ASCII_LO);
                   assert(roffs[i].name[0] <= ASCII_HI);
   
         if ( ! flush)                  buc = ROFF_HASH(roffs[i].name);
                 goto end;  
   
         error = 1;                  if (NULL != (n = hash[buc])) {
                           for ( ; n->next; n = n->next)
         if (ROFF_PRELUDE & tree->state) {                                  /* Do nothing. */ ;
                 roff_warn(tree, NULL, "prelude never finished");                          n->next = &roffs[i];
                 goto end;                  } else
         }                          hash[buc] = &roffs[i];
   
         for (n = tree->last; n->parent; n = n->parent) {  
                 if (0 != tokens[n->tok].ctx)  
                         continue;  
                 roff_warn(tree, NULL, "closing explicit scope `%s'",  
                                 toknames[n->tok]);  
                 goto end;  
         }          }
   }
   
         while (tree->last) {  
                 t = tree->last->tok;  
                 if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  
                         goto end;  
         }  
   
         error = 0;  /*
    * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
    * the nil-terminated string name could be found.
    */
   static enum rofft
   roff_hash_find(const char *p)
   {
           int              buc;
           struct roffmac  *n;
   
 end:          /*
            * 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.
            */
   
         while (tree->last)          if (p[0] < ASCII_LO || p[0] > ASCII_HI)
                 roffnode_free(tree);                  return(ROFF_MAX);
   
         free(tree);          buc = ROFF_HASH(p);
   
         return(error ? 0 : 1);          if (NULL == (n = hash[buc]))
                   return(ROFF_MAX);
           for ( ; n; n = n->next)
                   if (0 == strcmp(n->name, p))
                           return((enum rofft)(n - roffs));
   
           return(ROFF_MAX);
 }  }
   
   
 struct rofftree *  /*
 roff_alloc(const struct roffcb *cb, void *args)   * Pop the current node off of the stack of roff instructions currently
    * pending.
    */
   static void
   roffnode_pop(struct roff *r)
 {  {
         struct rofftree *tree;          struct roffnode *p;
   
         assert(args);          assert(r->last);
         assert(cb);          p = r->last;
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))          if (ROFF_el == p->tok)
                 err(1, "calloc");                  if (r->rstackpos > -1)
                           r->rstackpos--;
   
         tree->state = ROFF_PRELUDE;          r->last = r->last->parent;
         tree->arg = args;          if (p->end)
                   free(p->end);
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));          free(p);
   
         return(tree);  
 }  }
   
   
 int  /*
 roff_engine(struct rofftree *tree, char *buf)   * Push a roff node onto the instruction stack.  This must later be
    * removed with roffnode_pop().
    */
   static int
   roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {  {
           struct roffnode *p;
   
         tree->cur = buf;          if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
         assert(buf);                  (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
   
         if (0 == *buf) {  
                 roff_warn(tree, buf, "blank line");  
                 return(0);                  return(0);
         } else if ('.' != *buf)          }
                 return(textparse(tree, buf));  
   
         return(roffparse(tree, buf));          p->tok = tok;
           p->parent = r->last;
           p->line = line;
           p->col = col;
           p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
   
           r->last = p;
           return(1);
 }  }
   
   
 static int  static void
 textparse(const struct rofftree *tree, char *buf)  roff_free1(struct roff *r)
 {  {
   
         return((*tree->cb.roffdata)(tree->arg, buf));          while (r->last)
                   roffnode_pop(r);
 }  }
   
   
 static int  void
 roffargs(const struct rofftree *tree,  roff_reset(struct roff *r)
                 int tok, char *buf, char **argv)  
 {  {
         int              i;  
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          roff_free1(r);
         assert('.' == *buf);  
   
         p = buf;  
   
         /* LINTED */  
         for (i = 0; *buf && i < ROFF_MAXARG; i++) {  
                 if ('\"' == *buf) {  
                         argv[i] = ++buf;  
                         while (*buf && '\"' != *buf)  
                                 buf++;  
                         if (0 == *buf) {  
                                 roff_err(tree, argv[i], "unclosed "  
                                                 "quote in argument "  
                                                 "list for `%s'",  
                                                 toknames[tok]);  
                                 return(0);  
                         }  
                 } else {  
                         argv[i] = buf++;  
                         while (*buf && ! isspace(*buf))  
                                 buf++;  
                         if (0 == *buf)  
                                 continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  
         if (ROFF_MAXARG == i && *buf) {  
                 roff_err(tree, p, "too many arguments for `%s'", toknames  
                                 [tok]);  
                 return(0);  
         }  
   
         argv[i] = NULL;  
         return(1);  
 }  }
   
   
 /* XXX */  void
 static int  roff_free(struct roff *r)
 roffscan(int tok, const int *tokv)  
 {  {
   
         if (NULL == tokv)          roff_free1(r);
                 return(1);          free(r);
   
         for ( ; ROFF_MAX != *tokv; tokv++)  
                 if (tok == *tokv)  
                         return(1);  
   
         return(0);  
 }  }
   
   
 static int  struct roff *
 roffparse(struct rofftree *tree, char *buf)  roff_alloc(const mandocmsg msg, void *data)
 {  {
         int               tok, t;          struct roff     *r;
         struct roffnode  *n;  
         char             *argv[ROFF_MAXARG];  
         char            **argvp;  
   
         if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {          if (NULL == (r = calloc(1, sizeof(struct roff)))) {
                 roff_err(tree, buf + 1, "bogus line macro");                  (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
                 return(0);                  return(0);
         } else if (NULL == tokens[tok].cb) {          }
                 roff_err(tree, buf + 1, "unsupported macro `%s'",  
                                 toknames[tok]);  
                 return(0);  
         } else if (ROFF_COMMENT == tokens[tok].type)  
                 return(1);  
   
         if ( ! roffargs(tree, tok, buf, argv))  
                 return(0);  
   
         argvp = (char **)argv;          r->msg = msg;
           r->data = data;
         /*          r->rstackpos = -1;
          * Prelude macros break some assumptions, so branch now.  
          */  
   
         if (ROFF_PRELUDE & tree->state) {          roff_hash_init();
                 assert(NULL == tree->last);          return(r);
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  }
         } else  
                 assert(tree->last);  
   
         assert(ROFF_BODY & tree->state);  
   
         /*  enum rofferr
          * First check that our possible parents and parent's possible  roff_parseln(struct roff *r, int ln,
          * children are satisfied.                  char **bufp, size_t *szp, int pos, int *offs)
          */  {
           enum rofft       t;
           int              ppos;
   
         if ( ! roffscan(tree->last->tok, tokens[tok].parents)) {  
                 roff_err(tree, *argvp, "`%s' has invalid parent `%s'",  
                                 toknames[tok],  
                                 toknames[tree->last->tok]);  
                 return(0);  
         }  
   
         if ( ! roffscan(tok, tokens[tree->last->tok].children)) {  
                 roff_err(tree, *argvp, "`%s' is invalid child of `%s'",  
                                 toknames[tok],  
                                 toknames[tree->last->tok]);  
                 return(0);  
         }  
   
         /*          /*
          * Branch if we're not a layout token.           * First, if a scope is open and we're not a macro, pass the
            * text through the macro's filter.  If a scope isn't open and
            * we're not a macro, just let it through.
          */           */
   
         if (ROFF_LAYOUT != tokens[tok].type)          if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));                  t = r->last->tok;
                   assert(roffs[t].text);
                   return((*roffs[t].text)
                                   (r, t, bufp, szp, ln, pos, pos, offs));
           } else if ( ! ROFF_CTL((*bufp)[pos]))
                   return(ROFF_CONT);
   
         /*  
          * Check our scope rules.  
          */  
   
         if (0 == tokens[tok].ctx)  
                 return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
   
         /*          /*
          * First consider implicit-end tags, like as follows:           * If a scope is open, go to the child handler for that macro,
          *      .Sh SECTION 1           * as it may want to preprocess before doing anything with it.
          *      .Sh SECTION 2  
          * In this, we want to close the scope of the NAME section.  If  
          * there's an intermediary implicit-end tag, such as  
          *      .Sh SECTION 1  
          *      .Ss Subsection 1  
          *      .Sh SECTION 2  
          * then it must be closed as well.  
          */           */
   
         if (tok == tokens[tok].ctx) {          if (r->last) {
                 /*                  t = r->last->tok;
                  * First search up to the point where we must close.                  assert(roffs[t].sub);
                  * If one doesn't exist, then we can open a new scope.                  return((*roffs[t].sub)
                  */                                  (r, t, bufp, szp, ln, pos, pos, offs));
   
                 for (n = tree->last; n; n = n->parent) {  
                         assert(0 == tokens[n->tok].ctx ||  
                                         n->tok == tokens[n->tok].ctx);  
                         if (n->tok == tok)  
                                 break;  
                         if (ROFF_SHALLOW & tokens[tok].flags) {  
                                 n = NULL;  
                                 break;  
                         }  
                 }  
   
                 /*  
                  * Create a new scope, as no previous one exists to  
                  * close out.  
                  */  
   
                 if (NULL == n)  
                         return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
   
                 /*  
                  * Close out all intermediary scoped blocks, then hang  
                  * the current scope from our predecessor's parent.  
                  */  
   
                 do {  
                         t = tree->last->tok;  
                         if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  
                                 return(0);  
                 } while (t != tok);  
   
                 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(tree->last);          ppos = pos;
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);          if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                   return(ROFF_CONT);
   
         /* LINTED */          assert(roffs[t].proc);
         do {          return((*roffs[t].proc)
                 t = tree->last->tok;                          (r, t, bufp, szp, ln, ppos, pos, offs));
                 if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         assert(tree->last);  
         return(1);  
 }  }
   
   
 static int  int
 rofffindarg(const char *name)  roff_endparse(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          if (NULL == r->last)
                   return(1);
         /* LINTED */          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
         for (i = 0; i < ROFF_ARGMAX; i++)                                  r->last->col, NULL));
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   
 static int  /*
 rofffindtok(const char *buf)   * Parse a roff node's type from the input buffer.  This must be in the
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(const char *buf, int *pos)
 {  {
         char             token[4];          int              j;
         size_t           i;          char             mac[5];
           enum rofft       t;
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)          assert(ROFF_CTL(buf[*pos]));
                 token[i] = *buf;          (*pos)++;
   
         if (i == 3)          while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
                   (*pos)++;
   
           if ('\0' == buf[*pos])
                 return(ROFF_MAX);                  return(ROFF_MAX);
   
         token[i] = 0;          for (j = 0; j < 4; j++, (*pos)++)
                   if ('\0' == (mac[j] = buf[*pos]))
                           break;
                   else if (' ' == buf[*pos] || (j && '\\' == buf[*pos]))
                           break;
   
         /* FIXME: use a table, this is slow but ok for now. */          if (j == 4 || j < 1)
                   return(ROFF_MAX);
   
         /* LINTED */          mac[j] = '\0';
         for (i = 0; i < ROFF_MAX; i++)  
                 /* LINTED */  
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);          if (ROFF_MAX == (t = roff_hash_find(mac)))
 }                  return(t);
   
           while (buf[*pos] && ' ' == buf[*pos])
                   (*pos)++;
   
 static int          return(t);
 rofffindcallable(const char *name)  
 {  
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))  
                 return(ROFF_MAX);  
         assert(c >= 0 && c < ROFF_MAX);  
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);  
 }  }
   
   
 static struct roffnode *  /* ARGSUSED */
 roffnode_new(int tokid, struct rofftree *tree)  static enum rofferr
   roff_cblock(ROFF_ARGS)
 {  {
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode))))  
                 err(1, "malloc");  
   
         p->tok = tokid;          /*
         p->parent = tree->last;           * A block-close `..' should only be invoked as a child of an
         tree->last = p;           * ignore macro, otherwise raise a warning and just ignore it.
            */
   
         return(p);          if (NULL == r->last) {
 }                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           switch (r->last->tok) {
           case (ROFF_am):
                   /* FALLTHROUGH */
           case (ROFF_ami):
                   /* FALLTHROUGH */
           case (ROFF_am1):
                   /* FALLTHROUGH */
           case (ROFF_de):
                   /* FALLTHROUGH */
           case (ROFF_dei):
                   /* FALLTHROUGH */
           case (ROFF_de1):
                   /* FALLTHROUGH */
           case (ROFF_ig):
                   break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
 static int          if ((*bufp)[pos])
 roffargok(int tokid, int argid)                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
 {                          return(ROFF_ERR);
         const int       *c;  
   
         if (NULL == (c = tokens[tokid].args))          roffnode_pop(r);
                 return(0);          roffnode_cleanscope(r);
           return(ROFF_IGN);
   
         for ( ; ROFF_ARGMAX != *c; c++)  
                 if (argid == *c)  
                         return(1);  
   
         return(0);  
 }  }
   
   
 static void  static void
 roffnode_free(struct rofftree *tree)  roffnode_cleanscope(struct roff *r)
 {  {
         struct roffnode *p;  
   
         assert(tree->last);          while (r->last) {
                   if (--r->last->endspan < 0)
         p = tree->last;                          break;
         tree->last = tree->last->parent;                  roffnode_pop(r);
         free(p);          }
 }  }
   
   
 static int  /* ARGSUSED */
 roffnextopt(const struct rofftree *tree, int tok,  static enum rofferr
                 char ***in, char **val)  roff_ccond(ROFF_ARGS)
 {  {
         char            *arg, **argv;  
         int              v;  
   
         *val = NULL;          if (NULL == r->last) {
         argv = *in;                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         assert(argv);                          return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         if (NULL == (arg = *argv))          switch (r->last->tok) {
                 return(-1);          case (ROFF_el):
         if ('-' != *arg)                  /* FALLTHROUGH */
                 return(-1);          case (ROFF_ie):
                   /* FALLTHROUGH */
           case (ROFF_if):
                   break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {          if (r->last->endspan > -1) {
                 roff_warn(tree, arg, "argument-like parameter `%s' to "                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                                 "`%s'", &arg[1], toknames[tok]);                          return(ROFF_ERR);
                 return(-1);                  return(ROFF_IGN);
         }  
   
         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;  
   
         if (NULL == *argv) {  
                 roff_err(tree, arg, "empty value of `%s' for `%s'",  
                                 tokargnames[v], toknames[tok]);  
                 return(ROFF_ARGMAX);  
         }          }
   
         return(v);          if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_block(ROFF_ARGS)
 {  {
           int             sv;
           size_t          sz;
   
         if (ROFF_BODY & tree->state) {          if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
                 assert( ! (ROFF_PRELUDE & tree->state));                  if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                 assert(ROFF_PRELUDE_Dd & tree->state);                          return(ROFF_ERR);
                 return(roff_text(tok, tree, argv, type));                  return(ROFF_IGN);
           } else if (ROFF_ig != tok) {
                   while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                           pos++;
                   while (' ' == (*bufp)[pos])
                           pos++;
         }          }
   
         assert(ROFF_PRELUDE & tree->state);          if ( ! roffnode_push(r, tok, ln, ppos))
         assert( ! (ROFF_BODY & tree->state));                  return(ROFF_ERR);
   
         if (ROFF_PRELUDE_Dd & tree->state) {          if ('\0' == (*bufp)[pos])
                 roff_err(tree, *argv, "repeated `Dd' in prelude");                  return(ROFF_IGN);
                 return(0);  
         } else if (ROFF_PRELUDE_Dt & tree->state) {  
                 roff_err(tree, *argv, "out-of-order `Dd' in prelude");  
                 return(0);  
         }  
   
         /* TODO: parse date. */          sv = pos;
           while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
                           '\t' != (*bufp)[pos])
                   pos++;
   
         assert(NULL == tree->last);          /*
         tree->state |= ROFF_PRELUDE_Dd;           * 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.
            */
   
         return(1);          assert(pos > sv);
 }          sz = (size_t)(pos - sv);
   
           if (1 == sz && '.' == (*bufp)[sv])
                   return(ROFF_IGN);
   
 /* ARGSUSED */          r->last->end = malloc(sz + 1);
 static  int  
 roff_Dt(ROFFCALL_ARGS)  
 {  
   
         if (ROFF_BODY & tree->state) {          if (NULL == r->last->end) {
                 assert( ! (ROFF_PRELUDE & tree->state));                  (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
                 assert(ROFF_PRELUDE_Dt & tree->state);                  return(ROFF_ERR);
                 return(roff_text(tok, tree, argv, type));  
         }          }
   
         assert(ROFF_PRELUDE & tree->state);          memcpy(r->last->end, *bufp + sv, sz);
         assert( ! (ROFF_BODY & tree->state));          r->last->end[(int)sz] = '\0';
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state)) {          if ((*bufp)[pos])
                 roff_err(tree, *argv, "out-of-order `Dt' in prelude");                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                 return(0);                          return(ROFF_ERR);
         } else if (ROFF_PRELUDE_Dt & tree->state) {  
                 roff_err(tree, *argv, "repeated `Dt' in prelude");  
                 return(0);  
         }  
   
         /* TODO: parse date. */          return(ROFF_IGN);
   
         assert(NULL == tree->last);  
         tree->state |= ROFF_PRELUDE_Dt;  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_block_sub(ROFF_ARGS)
 {  {
           enum rofft      t;
           int             i, j;
   
         if (ROFF_EXIT == type) {          /*
                 roffnode_free(tree);           * First check whether a custom macro exists at this level.  If
                 return((*tree->cb.rofftail)(tree->arg));           * it does, then check against it.  This is some of groff's
         } else if (ROFF_BODY & tree->state) {           * stranger behaviours.  If we encountered a custom end-scope
                 assert( ! (ROFF_PRELUDE & tree->state));           * tag and that tag also happens to be a "real" macro, then we
                 assert(ROFF_PRELUDE_Os & tree->state);           * need to try interpreting it again as a real macro.  If it's
                 return(roff_text(tok, tree, argv, type));           * not, then return ignore.  Else continue.
         }           */
   
         assert(ROFF_PRELUDE & tree->state);          if (r->last->end) {
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||                  i = pos + 1;
                         ! (ROFF_PRELUDE_Dd & tree->state)) {                  while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                 roff_err(tree, *argv, "out-of-order `Os' in prelude");                          i++;
                 return(0);  
         }  
   
         /* TODO: extract OS. */                  for (j = 0; r->last->end[j]; j++, i++)
                           if ((*bufp)[i] != r->last->end[j])
                                   break;
   
         tree->state |= ROFF_PRELUDE_Os;                  if ('\0' == r->last->end[j] &&
         tree->state &= ~ROFF_PRELUDE;                                  ('\0' == (*bufp)[i] ||
         tree->state |= ROFF_BODY;                                   ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
         assert(NULL == tree->last);                          if (ROFF_MAX != roff_parse(*bufp, &pos))
                                   return(ROFF_RERUN);
                           return(ROFF_IGN);
                   }
           }
   
         if (NULL == roffnode_new(tok, tree))          /*
                 return(0);           * If we have no custom end-query or lookup failed, then try
            * pulling it out of the hashtable.
            */
   
         return((*tree->cb.roffhead)(tree->arg));          ppos = pos;
           t = roff_parse(*bufp, &pos);
   
           /* If we're not a comment-end, then throw it away. */
           if (ROFF_cblock != 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_layout(ROFFCALL_ARGS)  roff_block_text(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];  
         char            *v, *argvp[ROFF_MAXARG];  
   
         if (ROFF_PRELUDE & tree->state) {          return(ROFF_IGN);
                 roff_err(tree, *argv, "`%s' disallowed in prelude",  }
                                 toknames[tok]);  
                 return(0);  
         }  
   
         if (ROFF_EXIT == type) {  
                 roffnode_free(tree);  
                 return((*tree->cb.roffblkout)(tree->arg, tok));  
         }  
   
         i = 0;  /* ARGSUSED */
         argv++;  static enum rofferr
   roff_cond_sub(ROFF_ARGS)
   {
           enum rofft       t;
           enum roffrule    rr;
   
         while (-1 != (c = roffnextopt(tree, tok, &argv, &v))) {          ppos = pos;
                 if (ROFF_ARGMAX == c)          rr = r->last->rule;
                         return(0);  
   
                 argcp[i] = c;          roff_cond_text(r, tok, bufp, szp, ln, ppos, pos, offs);
                 argvp[i] = v;  
                 i++;  
                 argv++;  
         }  
   
         argcp[i] = ROFF_ARGMAX;          if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
         argvp[i] = NULL;                  return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   
         if (NULL == roffnode_new(tok, tree))          /*
                 return(0);           * A denied conditional must evaluate its children if and only
            * if they're either structurally required (such as loops and
            * conditionals) or a closing macro.
            */
           if (ROFFRULE_DENY == rr)
                   if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
         if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp, argvp))          assert(roffs[t].proc);
                 return(0);          return((*roffs[t].proc)
                           (r, t, bufp, szp, ln, ppos, pos, offs));
   }
   
         if (NULL == *argv)  
                 return(1);  
   
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))  /* ARGSUSED */
                 return(0);  static enum rofferr
   roff_cond_text(ROFF_ARGS)
   {
           char            *ep, *st;
           enum roffrule    rr;
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          rr = r->last->rule;
                 while (*argv) {  
                         if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))  
                                 return(0);  
                 }  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }  
   
         while (*argv) {          /*
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {           * We display the value of the text if out current evaluation
                         if (NULL == tokens[c].cb) {           * scope permits us to do so.
                                 roff_err(tree, *argv, "unsupported "           */
                                                 "macro `%s'",  
                                                 toknames[c]);  
                                 return(0);  
                         }  
                         if ( ! (*tokens[c].cb)(c, tree, argv, ROFF_ENTER))  
                                 return(0);  
                         break;  
                 }  
   
                 assert(tree->arg);          st = &(*bufp)[pos];
                 if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))          if (NULL == (ep = strstr(st, "\\}"))) {
                         return(0);                  roffnode_cleanscope(r);
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
         }          }
   
         return((*tree->cb.roffout)(tree->arg, tok));          if (ep == st || (ep > st && '\\' != *(ep - 1)))
                   roffnode_pop(r);
   
           roffnode_cleanscope(r);
           return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];          int              cpos;  /* position of the condition */
         char            *v, *argvp[ROFF_MAXARG];          int              sv;
   
         if (ROFF_PRELUDE & tree->state) {          /* Stack overflow! */
                 roff_err(tree, *argv, "`%s' disallowed in prelude",  
                                 toknames[tok]);          if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
                 return(0);                  (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
                   return(ROFF_ERR);
         }          }
   
         i = 0;          cpos = pos;
         argv++;  
   
         while (-1 != (c = roffnextopt(tree, tok, &argv, &v))) {          if (ROFF_if == tok || ROFF_ie == tok) {
                 if (ROFF_ARGMAX == c)                  /*
                         return(0);                   * Read ahead past the conditional.  FIXME: this does
                    * not work, as conditionals don't end on whitespace,
                    * but are parsed according to a formal grammar.  It's
                    * good enough for now, however.
                    */
                   while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                           pos++;
           }
   
                 argcp[i] = c;          sv = pos;
                 argvp[i] = v;          while (' ' == (*bufp)[pos])
                 i++;                  pos++;
                 argv++;  
           /*
            * Roff is weird.  If we have just white-space after the
            * conditional, it's considered the BODY and we exit without
            * really doing anything.  Warn about this.  It's probably
            * wrong.
            */
           if ('\0' == (*bufp)[pos] && sv != pos) {
                   if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         argcp[i] = ROFF_ARGMAX;          if ( ! roffnode_push(r, tok, ln, ppos))
         argvp[i] = NULL;                  return(ROFF_ERR);
   
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp))          /* XXX: Implement more conditionals. */
                 return(0);  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          if (ROFF_if == tok || ROFF_ie == tok)
                 while (*argv) {                  r->last->rule = 'n' == (*bufp)[cpos] ?
                         if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))                      ROFFRULE_ALLOW : ROFFRULE_DENY;
                                 return(0);          else if (ROFF_el == tok) {
                 }                  /*
                 return((*tree->cb.roffout)(tree->arg, tok));                   * An `.el' will get the value of the current rstack
                    * entry set in prior `ie' calls or defaults to DENY.
                    */
                   if (r->rstackpos < 0)
                           r->last->rule = ROFFRULE_DENY;
                   else
                           r->last->rule = r->rstack[r->rstackpos];
         }          }
           if (ROFF_ie == tok) {
         while (*argv) {                  /*
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {                   * An if-else will put the NEGATION of the current
                         if (NULL == tokens[c].cb) {                   * evaluated conditional into the stack.
                                 roff_err(tree, *argv, "unsupported "                   */
                                                 "macro `%s'",                  r->rstackpos++;
                                                 toknames[c]);                  if (ROFFRULE_DENY == r->last->rule)
                                 return(0);                          r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
                         }                  else
                         if ( ! (*tokens[c].cb)(c, tree,                          r->rstack[r->rstackpos] = ROFFRULE_DENY;
                                                 argv, ROFF_ENTER))  
                                 return(0);  
                         break;  
                 }  
                 if ( ! (*tree->cb.roffdata)(tree->arg, *argv++))  
                         return(0);  
         }          }
           if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                   r->last->rule = ROFFRULE_DENY;
   
         return((*tree->cb.roffout)(tree->arg, tok));          r->last->endspan = 1;
 }  
   
           if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   r->last->endspan = -1;
                   pos += 2;
           }
   
 /* ARGSUSED */          /*
 static int           * If there are no arguments on the line, the next-line scope is
 roff_comment(ROFFCALL_ARGS)           * assumed.
 {           */
   
         return(1);          if ('\0' == (*bufp)[pos])
 }                  return(ROFF_IGN);
   
           /* Otherwise re-run the roff parser after recalculating. */
   
 /* ARGSUSED */          *offs = pos;
 static int          return(ROFF_RERUN);
 roff_close(ROFFCALL_ARGS)  
 {  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_special(ROFFCALL_ARGS)  roff_line(ROFF_ARGS)
 {  {
   
         return((*tree->cb.roffspecial)(tree->arg, tok));          return(ROFF_IGN);
 }  
   
   
 static void  
 roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)  
 {  
         va_list          ap;  
         char             buf[128];  
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);  
         va_end(ap);  
   
         (*tree->cb.roffmsg)(tree->arg,  
                         ROFF_WARN, tree->cur, pos, buf);  
 }  
   
   
 static void  
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  
 {  
         va_list          ap;  
         char             buf[128];  
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf), fmt, ap);  
         va_end(ap);  
   
         (*tree->cb.roffmsg)(tree->arg,  
                         ROFF_ERROR, tree->cur, pos, buf);  
 }  }
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.86
CVSweb