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

Diff for /mandoc/roff.c between version 1.52 and 1.82

version 1.52, 2008/12/08 16:29:57 version 1.82, 2010/05/17 02:01:05
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.  
  */   */
 #include <sys/param.h>  #ifdef HAVE_CONFIG_H
 #include <sys/types.h>  #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <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"  #include "roff.h"
   
 /* FIXME: First letters of quoted-text interpreted in rofffindtok. */  #define RSTACK_MAX      128
 /* FIXME: `No' not implemented. */  
 /* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  
 /* TODO: warn about empty lists. */  
 /* TODO: (warn) some sections need specific elements. */  
 /* TODO: (warn) NAME section has particular order. */  
 /* TODO: unify empty-content tags a la <br />. */  
 /* TODO: macros with a set number of arguments? */  
 /* TODO: validate Dt macro arguments. */  
 /* FIXME: Bl -diag supposed to ignore callable children. */  
 /* FIXME: Nm has newline when used in NAME section. */  
   
 struct  roffnode {  #define ROFF_CTL(c) \
         int               tok;                  /* Token id. */          ('.' == (c) || '\'' == (c))
         struct roffnode  *parent;               /* Parent (or NULL). */  
   enum    rofft {
           ROFF_am,
           ROFF_ami,
           ROFF_am1,
           ROFF_de,
           ROFF_dei,
           ROFF_de1,
           ROFF_el,
           ROFF_ie,
           ROFF_if,
           ROFF_ig,
           ROFF_cblock,
           ROFF_ccond,
           ROFF_MAX
 };  };
   
 struct  rofftree {  enum    roffrule {
         struct roffnode  *last;                 /* Last parsed node. */          ROFFRULE_ALLOW,
         char             *cur;                  /* Line start. */          ROFFRULE_DENY
         struct tm         tm;                   /* `Dd' results. */  
         char              name[64];             /* `Nm' results. */  
         char              os[64];               /* `Os' results. */  
         char              title[64];            /* `Dt' results. */  
         enum roffmsec     section;  
         char              volume[64];           /* `Dt' results. */  
         int               state;  
 #define ROFF_PRELUDE     (1 << 1)               /* In roff prelude. */  
 #define ROFF_PRELUDE_Os  (1 << 2)               /* `Os' is parsed. */  
 #define ROFF_PRELUDE_Dt  (1 << 3)               /* `Dt' is parsed. */  
 #define ROFF_PRELUDE_Dd  (1 << 4)               /* `Dd' is parsed. */  
 #define ROFF_BODY        (1 << 5)               /* In roff body. */  
         struct roffcb     cb;                   /* Callbacks. */  
         void             *arg;                  /* Callbacks' arg. */  
         int               csec;                 /* Current section. */  
         int               asec;                 /* Thus-far sections. */  
 };  };
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  struct  roff {
 static  void              roffnode_free(struct rofftree *);          struct roffnode *last; /* leaf of stack */
 static  void              roff_warn(const struct rofftree *,          mandocmsg        msg; /* err/warn/fatal messages */
                                 const char *, char *, ...);          void            *data; /* privdata for messages */
 static  void              roff_err(const struct rofftree *,          enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
                                 const char *, char *, ...);          int              rstackpos; /* position in rstack */
 static  int               roffpurgepunct(struct rofftree *, char **);  };
 static  int               roffscan(int, const int *);  
 static  int               rofffindtok(const char *);  
 static  int               rofffindarg(const char *);  
 static  int               rofffindcallable(const char *);  
 static  int               roffismsec(const char *);  
 static  int               roffissec(const char **);  
 static  int               roffispunct(const char *);  
 static  int               roffchecksec(struct rofftree *,  
                                 const char *, int);  
 static  int               roffargs(const struct rofftree *,  
                                 int, char *, char **);  
 static  int               roffargok(int, int);  
 static  int               roffnextopt(const struct rofftree *,  
                                 int, char ***, char **);  
 static  int               roffparseopts(struct rofftree *, int,  
                                 char ***, int *, char **);  
 static  int               roffcall(struct rofftree *, int, char **);  
 static  int               roffexit(struct rofftree *, int);  
 static  int               roffparse(struct rofftree *, char *);  
 static  int               textparse(struct rofftree *, char *);  
 static  int               roffdata(struct rofftree *, int, char *);  
 static  int               roffspecial(struct rofftree *, int,  
                                 const char *, const int *,  
                                 const char **, size_t, char **);  
 static  int               roffsetname(struct rofftree *, char **);  
   
 #ifdef __linux__  struct  roffnode {
 extern  size_t            strlcat(char *, const char *, size_t);          enum rofft       tok; /* type of node */
 extern  size_t            strlcpy(char *, const char *, size_t);          struct roffnode *parent; /* up one in stack */
 extern  int               vsnprintf(char *, size_t,          int              line; /* parse line */
                                 const char *, va_list);          int              col; /* parse col */
 extern  char             *strptime(const char *, const char *,          char            *end; /* end-rules: custom token */
                                 struct tm *);          int              endspan; /* end-rules: next-line or infty */
 #endif          enum roffrule    rule; /* current evaluation rule */
   };
   
 int  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
 roff_free(struct rofftree *tree, int flush)                           enum rofft tok, /* tok of macro */ \
 {                           char **bufp, /* input buffer */ \
         int              error, t;                           size_t *szp, /* size of input buffer */ \
         struct roffnode *n;                           int ln, /* parse line */ \
                            int ppos, /* original pos in buffer */ \
                            int pos, /* current pos in buffer */ \
                            int *offs /* reset offset of buffer data */
   
         error = 0;  typedef enum rofferr (*roffproc)(ROFF_ARGS);
   
         if ( ! flush)  struct  roffmac {
                 goto end;          const char      *name; /* macro name */
           roffproc         proc; /* process new macro */
           roffproc         text; /* process as child text of macro */
           roffproc         sub; /* process as child of macro */
           int              flags;
   #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
   };
   
         error = 1;  static  enum rofferr     roff_block(ROFF_ARGS);
   static  enum rofferr     roff_block_text(ROFF_ARGS);
   static  enum rofferr     roff_block_sub(ROFF_ARGS);
   static  enum rofferr     roff_cblock(ROFF_ARGS);
   static  enum rofferr     roff_ccond(ROFF_ARGS);
   static  enum rofferr     roff_cond(ROFF_ARGS);
   static  enum rofferr     roff_cond_text(ROFF_ARGS);
   static  enum rofferr     roff_cond_sub(ROFF_ARGS);
   
         if (ROFF_PRELUDE & tree->state) {  const   struct roffmac   roffs[ROFF_MAX] = {
                 roff_err(tree, NULL, "prelude never finished");          { "am", roff_block, roff_block_text, roff_block_sub, 0 },
                 goto end;          { "ami", roff_block, roff_block_text, roff_block_sub, 0 },
         } else if ( ! (ROFFSec_NAME & tree->asec)) {          { "am1", roff_block, roff_block_text, roff_block_sub, 0 },
                 roff_err(tree, NULL, "missing `NAME' section");          { "de", roff_block, roff_block_text, roff_block_sub, 0 },
                 goto end;          { "dei", roff_block, roff_block_text, roff_block_sub, 0 },
         } else if ( ! (ROFFSec_NMASK & tree->asec))          { "de1", roff_block, roff_block_text, roff_block_sub, 0 },
                 roff_warn(tree, NULL, "missing suggested `NAME', "          { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },
                                 "`SYNOPSIS', `DESCRIPTION' sections");          { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },
           { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },
           { "ig", roff_block, roff_block_text, roff_block_sub, 0 },
           { ".", roff_cblock, NULL, NULL, 0 },
           { "\\}", roff_ccond, NULL, NULL, 0 },
   };
   
         for (n = tree->last; n; n = n->parent) {  static  void             roff_free1(struct roff *);
                 if (0 != tokens[n->tok].ctx)  static  enum rofft       roff_hash_find(const char *);
                         continue;  static  void             roffnode_cleanscope(struct roff *);
                 roff_err(tree, NULL, "closing explicit scope `%s'",  static  int              roffnode_push(struct roff *,
                                 toknames[n->tok]);                                  enum rofft, int, int);
                 goto end;  static  void             roffnode_pop(struct roff *);
         }  static  enum rofft       roff_parse(const char *, int *);
   
         while (tree->last) {  
                 t = tree->last->tok;  
                 if ( ! roffexit(tree, t))  
                         goto end;  
         }  
   
         if ( ! (*tree->cb.rofftail)(tree->arg))  /*
                 goto end;   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
    * the nil-terminated string name could be found.
         error = 0;   */
   static enum rofft
 end:  roff_hash_find(const char *p)
   
         while (tree->last)  
                 roffnode_free(tree);  
   
         free(tree);  
   
         return(error ? 0 : 1);  
 }  
   
   
 struct rofftree *  
 roff_alloc(const struct roffcb *cb, void *args)  
 {  {
         struct rofftree *tree;          int              i;
   
         assert(args);          /* FIXME: make this be fast and efficient. */
         assert(cb);  
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree))))          for (i = 0; i < (int)ROFF_MAX; i++)
                 err(1, "calloc");                  if (0 == strcmp(roffs[i].name, p))
                           return((enum rofft)i);
   
         tree->state = ROFF_PRELUDE;          return(ROFF_MAX);
         tree->arg = args;  
         tree->section = ROFF_MSEC_MAX;  
   
         (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));  
   
         return(tree);  
 }  }
   
   
 int  /*
 roff_engine(struct rofftree *tree, char *buf)   * Pop the current node off of the stack of roff instructions currently
    * pending.
    */
   static void
   roffnode_pop(struct roff *r)
 {  {
           struct roffnode *p;
   
         tree->cur = buf;          assert(r->last);
         assert(buf);          p = r->last;
   
         if (0 == *buf) {          if (ROFF_el == p->tok)
                 roff_err(tree, buf, "blank line");                  if (r->rstackpos > -1)
                 return(0);                          r->rstackpos--;
         } else if ('.' != *buf)  
                 return(textparse(tree, buf));  
   
         return(roffparse(tree, buf));          r->last = r->last->parent;
           if (p->end)
                   free(p->end);
           free(p);
 }  }
   
   
   /*
    * Push a roff node onto the instruction stack.  This must later be
    * removed with roffnode_pop().
    */
 static int  static int
 textparse(struct rofftree *tree, char *buf)  roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {  {
         char            *bufp;          struct roffnode *p;
   
         /* TODO: literal parsing. */          if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
                   (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
         if ( ! (ROFF_BODY & tree->state)) {  
                 roff_err(tree, buf, "data not in body");  
                 return(0);                  return(0);
         }          }
   
         /* LINTED */          p->tok = tok;
         while (*buf) {          p->parent = r->last;
                 while (*buf && isspace(*buf))          p->line = line;
                         buf++;          p->col = col;
           p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
   
                 if (0 == *buf)          r->last = p;
                         break;  
   
                 bufp = buf++;  
   
                 while (*buf && ! isspace(*buf))  
                         buf++;  
   
                 if (0 != *buf) {  
                         *buf++ = 0;  
                         if ( ! roffdata(tree, 1, bufp))  
                                 return(0);  
                         continue;  
                 }  
   
                 if ( ! roffdata(tree, 1, bufp))  
                         return(0);  
                 break;  
         }  
   
         return(1);          return(1);
 }  }
   
   
 static int  static void
 roffargs(const struct rofftree *tree,  roff_free1(struct roff *r)
                 int tok, char *buf, char **argv)  
 {  {
         int              i;  
         char            *p;  
   
         assert(tok >= 0 && tok < ROFF_MAX);          while (r->last)
         assert('.' == *buf);                  roffnode_pop(r);
   }
   
         p = buf;  
   
         /*  void
          * This is an ugly little loop.  It parses a line into  roff_reset(struct roff *r)
          * space-delimited tokens.  If a quote mark is encountered, a  {
          * token is alloted the entire quoted text.  If whitespace is  
          * escaped, it's included in the prior alloted token.  
          */  
   
         /* LINTED */          roff_free1(r);
         for (i = 0; *buf && i < ROFF_MAXLINEARG; 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) {  
                                 if ( ! isspace(*buf)) {  
                                         buf++;  
                                         continue;  
                                 }  
                                 if (*(buf - 1) == '\\') {  
                                         buf++;  
                                         continue;  
                                 }  
                                 break;  
                         }  
                         if (0 == *buf)  
                                 continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  
         if (ROFF_MAXLINEARG == i && *buf) {  
                 roff_err(tree, p, "too many arguments for `%s'", toknames  
                                 [tok]);  
                 return(0);  
         }  
   
         argv[i] = NULL;  
         return(1);  
 }  }
   
   
 static int  void
 roffscan(int tok, const int *tokv)  roff_free(struct roff *r)
 {  {
   
         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_MAXLINEARG];  
         char            **argvp;  
   
         if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))          if (NULL == (r = calloc(1, sizeof(struct roff)))) {
                 if (0 == strncmp(buf, ".\\\"", 3))                  (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
                         return(1);  
   
         if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {  
                 roff_err(tree, buf, "bogus line macro");  
                 return(0);                  return(0);
         } else if ( ! roffargs(tree, tok, buf, argv))          }
                 return(0);  
   
         argvp = (char **)argv;          r->msg = msg;
           r->data = data;
           r->rstackpos = -1;
           return(r);
   }
   
         /*  
          * Prelude macros break some assumptions, so branch now.  
          */  
   
         if (ROFF_PRELUDE & tree->state) {  
                 assert(NULL == tree->last);  
                 return(roffcall(tree, tok, argvp));  
         }  
   
         assert(ROFF_BODY & tree->state);  enum rofferr
   roff_parseln(struct roff *r, int ln,
                   char **bufp, size_t *szp, int pos, int *offs)
   {
           enum rofft       t;
           int              ppos;
   
         /*  
          * First check that our possible parents and parent's possible  
          * children are satisfied.  
          */  
   
         if (tree->last && ! 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 (tree->last && ! 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(roffcall(tree, tok, argvp));                  t = r->last->tok;
         if (0 == tokens[tok].ctx)                  assert(roffs[t].text);
                 return(roffcall(tree, tok, argvp));                  return((*roffs[t].text)
                                   (r, t, bufp, szp, ln, pos, pos, offs));
           } else if ( ! ROFF_CTL((*bufp)[pos]))
                   return(ROFF_CONT);
   
         /*          /*
          * First consider implicit-end tags, like as follows:           * If a scope is open, go to the child handler for that macro,
          *      .Sh SECTION 1           * as it may want to preprocess before doing anything with it.
          *      .Sh SECTION 2  
          * In this, we want to close the scope of the NAME section.  If  
          * there's an intermediary implicit-end tag, such as  
          *      .Sh SECTION 1  
          *      .Ss Subsection 1  
          *      .Sh SECTION 2  
          * then it must be closed as well.  
          */           */
   
         if (tok == tokens[tok].ctx) {          if (r->last) {
                 /*                  t = r->last->tok;
                  * First search up to the point where we must close.                  assert(roffs[t].sub);
                  * If one doesn't exist, then we can open a new scope.                  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;  
                         }  
                         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  
                  * close out.  
                  */  
   
                 if (NULL == n)  
                         return(roffcall(tree, tok, argvp));  
   
                 /*  
                  * Close out all intermediary scoped blocks, then hang  
                  * the current scope from our predecessor's parent.  
                  */  
   
                 do {  
                         t = tree->last->tok;  
                         if ( ! roffexit(tree, t))  
                                 return(0);  
                 } while (t != tok);  
   
                 return(roffcall(tree, tok, argvp));  
         }          }
   
         /*          /*
          * Now consider explicit-end tags, where we want to close back           * Lastly, as we've no scope open, try to look up and execute
          * to a specific tag.  Example:           * the new macro.  If no macro is found, simply return and let
          *      .Bl           * the compilers handle it.
          *      .It Item.  
          *      .El  
          * In this, the `El' tag closes out the scope of `Bl'.  
          */           */
   
         assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);          ppos = pos;
           if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                   return(ROFF_CONT);
   
         /* LINTED */          assert(roffs[t].proc);
         for (n = tree->last; n; n = n->parent)          return((*roffs[t].proc)
                 if (n->tok != tokens[tok].ctx) {                          (r, t, bufp, szp, ln, ppos, pos, offs));
                         if (n->tok == tokens[n->tok].ctx)  
                                 continue;  
                         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 ( ! roffexit(tree, t))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         return(1);  
 }  }
   
   
 static int  int
 rofffindarg(const char *name)  roff_endparse(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          if (NULL == r->last)
                   return(1);
         /* LINTED */          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
         for (i = 0; i < ROFF_ARGMAX; i++)                                  r->last->col, NULL));
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   
 static int  /*
 rofffindtok(const char *buf)   * Parse a roff node's type from the input buffer.  This must be in the
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(const char *buf, int *pos)
 {  {
         char             token[4];          int              j;
         int              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);
 roffchecksec(struct rofftree *tree, const char *start, int sec)  
 {  
         int              prior;  
   
         switch (sec) {  
         case(ROFFSec_SYNOP):  
                 if ((prior = ROFFSec_NAME) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DESC):  
                 if ((prior = ROFFSec_SYNOP) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_RETVAL):  
                 if ((prior = ROFFSec_DESC) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ENV):  
                 if ((prior = ROFFSec_RETVAL) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_FILES):  
                 if ((prior = ROFFSec_ENV) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_EX):  
                 if ((prior = ROFFSec_FILES) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DIAG):  
                 if ((prior = ROFFSec_EX) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ERRS):  
                 if ((prior = ROFFSec_DIAG) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SEEALSO):  
                 if ((prior = ROFFSec_ERRS) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_STAND):  
                 if ((prior = ROFFSec_SEEALSO) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_HIST):  
                 if ((prior = ROFFSec_STAND) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_AUTH):  
                 if ((prior = ROFFSec_HIST) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_CAVEATS):  
                 if ((prior = ROFFSec_AUTH) & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_BUGS):  
                 if ((prior = ROFFSec_CAVEATS) & tree->asec)  
                         return(1);  
                 break;  
         default:  
                 return(1);  
         }  
   
         roff_warn(tree, start, "section violates conventional order");  
         return(1);  
 }  }
   
   
 static int  /* ARGSUSED */
 roffissec(const char **p)  static enum rofferr
   roff_cblock(ROFF_ARGS)
 {  {
   
         assert(*p);          /*
         if (NULL != *(p + 1)) {           * A block-close `..' should only be invoked as a child of an
                 if (NULL != *(p + 2))           * ignore macro, otherwise raise a warning and just ignore it.
                         return(ROFFSec_OTHER);           */
                 if (0 == strcmp(*p, "RETURN") &&  
                                 0 == strcmp(*(p + 1), "VALUES"))          if (NULL == r->last) {
                         return(ROFFSec_RETVAL);                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                 if (0 == strcmp(*p, "SEE") &&                          return(ROFF_ERR);
                                 0 == strcmp(*(p + 1), "ALSO"))                  return(ROFF_IGN);
                         return(ROFFSec_SEEALSO);  
                 return(ROFFSec_OTHER);  
         }          }
   
         if (0 == strcmp(*p, "NAME"))          switch (r->last->tok) {
                 return(ROFFSec_NAME);          case (ROFF_am):
         else if (0 == strcmp(*p, "SYNOPSIS"))  
                 return(ROFFSec_SYNOP);  
         else if (0 == strcmp(*p, "DESCRIPTION"))  
                 return(ROFFSec_DESC);  
         else if (0 == strcmp(*p, "ENVIRONMENT"))  
                 return(ROFFSec_ENV);  
         else if (0 == strcmp(*p, "FILES"))  
                 return(ROFFSec_FILES);  
         else if (0 == strcmp(*p, "EXAMPLES"))  
                 return(ROFFSec_EX);  
         else if (0 == strcmp(*p, "DIAGNOSTICS"))  
                 return(ROFFSec_DIAG);  
         else if (0 == strcmp(*p, "ERRORS"))  
                 return(ROFFSec_ERRS);  
         else if (0 == strcmp(*p, "STANDARDS"))  
                 return(ROFFSec_STAND);  
         else if (0 == strcmp(*p, "HISTORY"))  
                 return(ROFFSec_HIST);  
         else if (0 == strcmp(*p, "AUTHORS"))  
                 return(ROFFSec_AUTH);  
         else if (0 == strcmp(*p, "CAVEATS"))  
                 return(ROFFSec_CAVEATS);  
         else if (0 == strcmp(*p, "BUGS"))  
                 return(ROFFSec_BUGS);  
   
         return(ROFFSec_OTHER);  
 }  
   
   
 static int  
 roffismsec(const char *p)  
 {  
   
         if (0 == strcmp(p, "1"))  
                 return(ROFF_MSEC_1);  
         else if (0 == strcmp(p, "2"))  
                 return(ROFF_MSEC_2);  
         else if (0 == strcmp(p, "3"))  
                 return(ROFF_MSEC_3);  
         else if (0 == strcmp(p, "3p"))  
                 return(ROFF_MSEC_3p);  
         else if (0 == strcmp(p, "4"))  
                 return(ROFF_MSEC_4);  
         else if (0 == strcmp(p, "5"))  
                 return(ROFF_MSEC_5);  
         else if (0 == strcmp(p, "6"))  
                 return(ROFF_MSEC_6);  
         else if (0 == strcmp(p, "7"))  
                 return(ROFF_MSEC_7);  
         else if (0 == strcmp(p, "8"))  
                 return(ROFF_MSEC_8);  
         else if (0 == strcmp(p, "9"))  
                 return(ROFF_MSEC_9);  
         else if (0 == strcmp(p, "unass"))  
                 return(ROFF_MSEC_UNASS);  
         else if (0 == strcmp(p, "draft"))  
                 return(ROFF_MSEC_DRAFT);  
         else if (0 == strcmp(p, "paper"))  
                 return(ROFF_MSEC_PAPER);  
   
         return(ROFF_MSEC_MAX);  
 }  
   
   
 static int  
 roffispunct(const char *p)  
 {  
   
         if (0 == *p)  
                 return(0);  
         if (0 != *(p + 1))  
                 return(0);  
   
         switch (*p) {  
         case('{'):  
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('.'):          case (ROFF_ami):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(','):          case (ROFF_am1):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(';'):          case (ROFF_de):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(':'):          case (ROFF_dei):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('?'):          case (ROFF_de1):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('!'):          case (ROFF_ig):
                 /* FALLTHROUGH */  
         case('('):  
                 /* FALLTHROUGH */  
         case(')'):  
                 /* FALLTHROUGH */  
         case('['):  
                 /* FALLTHROUGH */  
         case(']'):  
                 /* FALLTHROUGH */  
         case('}'):  
                 return(1);  
         default:  
                 break;                  break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         return(0);          if ((*bufp)[pos])
 }                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   
 static int  
 rofffindcallable(const char *name)  
 {  
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))  
                 return(ROFF_MAX);  
         assert(c >= 0 && c < ROFF_MAX);  
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);  
 }  }
   
   
 static struct roffnode *  
 roffnode_new(int tokid, struct rofftree *tree)  
 {  
         struct roffnode *p;  
   
         if (NULL == (p = malloc(sizeof(struct roffnode))))  
                 err(1, "malloc");  
   
         p->tok = tokid;  
         p->parent = tree->last;  
         tree->last = p;  
   
         return(p);  
 }  
   
   
 static int  
 roffargok(int tokid, int argid)  
 {  
         const int       *c;  
   
         if (NULL == (c = tokens[tokid].args))  
                 return(0);  
   
         for ( ; ROFF_ARGMAX != *c; c++)  
                 if (argid == *c)  
                         return(1);  
   
         return(0);  
 }  
   
   
 static void  static void
 roffnode_free(struct rofftree *tree)  roffnode_cleanscope(struct roff *r)
 {  {
         struct roffnode *p;  
   
         assert(tree->last);          while (r->last) {
                   if (--r->last->endspan < 0)
         p = tree->last;                          break;
         tree->last = tree->last->parent;                  roffnode_pop(r);
         free(p);          }
 }  }
   
   
 static int  /* ARGSUSED */
 roffspecial(struct rofftree *tree, int tok, const char *start,  static enum rofferr
                 const int *argc, const char **argv,  roff_ccond(ROFF_ARGS)
                 size_t sz, char **ordp)  
 {  {
   
         switch (tok) {          if (NULL == r->last) {
         case (ROFF_At):                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                 if (0 == sz)                          return(ROFF_ERR);
                         break;                  return(ROFF_IGN);
                 if (0 == strcmp(*ordp, "v1"))          }
                         break;  
                 else if (0 == strcmp(*ordp, "v2"))  
                         break;  
                 else if (0 == strcmp(*ordp, "v3"))  
                         break;  
                 else if (0 == strcmp(*ordp, "v6"))  
                         break;  
                 else if (0 == strcmp(*ordp, "v7"))  
                         break;  
                 else if (0 == strcmp(*ordp, "32v"))  
                         break;  
                 else if (0 == strcmp(*ordp, "V.1"))  
                         break;  
                 else if (0 == strcmp(*ordp, "V.4"))  
                         break;  
                 roff_err(tree, *ordp, "invalid `At' arg");  
                 return(0);  
   
         case (ROFF_Xr):  
                 if (2 == sz) {  
                         assert(ordp[1]);  
                         if (ROFF_MSEC_MAX != roffismsec(ordp[1]))  
                                 break;  
                         roff_warn(tree, start, "invalid `%s' manual "  
                                         "section", toknames[tok]);  
                 }  
                 /* FALLTHROUGH */  
   
         case (ROFF_Sx):          switch (r->last->tok) {
                 /* FALLTHROUGH*/          case (ROFF_el):
         case (ROFF_Fn):  
                 if (0 != sz)  
                         break;  
                 roff_err(tree, start, "`%s' expects at least "  
                                 "one arg", toknames[tok]);  
                 return(0);  
   
         case (ROFF_Nm):  
                 if (0 == sz) {  
                         if (0 == tree->name[0]) {  
                                 roff_err(tree, start, "`Nm' not set");  
                                 return(0);  
                         }  
                         ordp[0] = tree->name;  
                         ordp[1] = NULL;  
                 } else if ( ! roffsetname(tree, ordp))  
                         return(0);  
                 break;  
   
         case (ROFF_Rv):  
                 /* FALLTHROUGH*/  
         case (ROFF_Ex):  
                 if (1 == sz)  
                         break;  
                 roff_err(tree, start, "`%s' expects one arg",  
                                 toknames[tok]);  
                 return(0);  
   
         case (ROFF_Sm):  
                 if (1 != sz) {  
                         roff_err(tree, start, "`Sm' expects one arg");  
                         return(0);  
                 }  
   
                 if (0 != strcmp(ordp[0], "on") &&  
                                 0 != strcmp(ordp[0], "off")) {  
                         roff_err(tree, start, "`Sm' has invalid argument");  
                         return(0);  
                 }  
                 break;  
   
         case (ROFF_Ud):  
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (ROFF_Ux):          case (ROFF_ie):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (ROFF_Bt):          case (ROFF_if):
                 if (0 != sz) {  
                         roff_err(tree, start, "`%s' expects no args",  
                                         toknames[tok]);  
                         return(0);  
                 }  
                 break;                  break;
         default:          default:
                 break;                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur,          if (r->last->endspan > -1) {
                                 argc, argv, (const char **)ordp));                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
 }                          return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
 static int          roffnode_pop(r);
 roffexit(struct rofftree *tree, int tok)          roffnode_cleanscope(r);
 {          return(ROFF_IGN);
   
         assert(tokens[tok].cb);  
         return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT));  
 }  }
   
   
 static int  /* ARGSUSED */
 roffcall(struct rofftree *tree, int tok, char **argv)  static enum rofferr
   roff_block(ROFF_ARGS)
 {  {
         int              i;          int             sv;
         enum roffmsec    c;          size_t          sz;
   
         if (NULL == tokens[tok].cb) {          if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
                 roff_err(tree, *argv, "`%s' is unsupported",                  if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                                 toknames[tok]);                          return(ROFF_ERR);
                 return(0);                  return(ROFF_IGN);
           } else if (ROFF_ig != tok) {
                   while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                           pos++;
                   while (' ' == (*bufp)[pos])
                           pos++;
         }          }
         if (tokens[tok].sections && ROFF_MSEC_MAX != tree->section) {  
                 i = 0;  
                 while (ROFF_MSEC_MAX !=  
                                 (c = tokens[tok].sections[i++]))  
                         if (c == tree->section)  
                                 break;  
                 if (ROFF_MSEC_MAX == c) {  
                         roff_warn(tree, *argv, "`%s' is not a valid "  
                                         "macro in this manual section",  
                                         toknames[tok]);  
                 }  
         }  
   
         return((*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER));          if ( ! roffnode_push(r, tok, ln, ppos))
 }                  return(ROFF_ERR);
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
 static int          sv = pos;
 roffnextopt(const struct rofftree *tree, int tok,          while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
                 char ***in, char **val)                          '\t' != (*bufp)[pos])
 {                  pos++;
         char            *arg, **argv;  
         int              v;  
   
         *val = NULL;          /*
         argv = *in;           * Note: groff does NOT like escape characters in the input.
         assert(argv);           * Instead of detecting this, we're just going to let it fly and
            * to hell with it.
            */
   
         if (NULL == (arg = *argv))          assert(pos > sv);
                 return(-1);          sz = (size_t)(pos - sv);
         if ('-' != *arg)  
                 return(-1);  
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {          if (1 == sz && '.' == (*bufp)[sv])
                 roff_warn(tree, arg, "argument-like parameter `%s' to "                  return(ROFF_IGN);
                                 "`%s'", arg, toknames[tok]);  
                 return(-1);  
         }  
   
         if ( ! roffargok(tok, v)) {  
                 roff_warn(tree, arg, "invalid argument parameter `%s' to "  
                                 "`%s'", tokargnames[v], toknames[tok]);  
                 return(-1);  
         }  
   
         if ( ! (ROFF_VALUE & tokenargs[v]))  
                 return(v);  
   
         *in = ++argv;          r->last->end = malloc(sz + 1);
   
         if (NULL == *argv) {          if (NULL == r->last->end) {
                 roff_err(tree, arg, "empty value of `%s' for `%s'",                  (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
                                 tokargnames[v], toknames[tok]);                  return(ROFF_ERR);
                 return(ROFF_ARGMAX);  
         }          }
   
         return(v);          memcpy(r->last->end, *bufp + sv, sz);
 }          r->last->end[(int)sz] = '\0';
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
 static int          return(ROFF_IGN);
 roffpurgepunct(struct rofftree *tree, char **argv)  
 {  
         int              i;  
   
         i = 0;  
         while (argv[i])  
                 i++;  
         assert(i > 0);  
         if ( ! roffispunct(argv[--i]))  
                 return(1);  
         while (i >= 0 && roffispunct(argv[i]))  
                 i--;  
         i++;  
   
         /* LINTED */  
         while (argv[i])  
                 if ( ! roffdata(tree, 0, argv[i++]))  
                         return(0);  
         return(1);  
 }  }
   
   
 static int  
 roffparseopts(struct rofftree *tree, int tok,  
                 char ***args, int *argc, char **argv)  
 {  
         int              i, c;  
         char            *v;  
   
         i = 0;  
   
         while (-1 != (c = roffnextopt(tree, tok, args, &v))) {  
                 if (ROFF_ARGMAX == c)  
                         return(0);  
   
                 argc[i] = c;  
                 argv[i] = v;  
                 i++;  
                 *args = *args + 1;  
         }  
   
         argc[i] = ROFF_ARGMAX;  
         argv[i] = NULL;  
         return(1);  
 }  
   
   
 static int  
 roffdata(struct rofftree *tree, int space, char *buf)  
 {  
   
         if (0 == *buf)  
                 return(1);  
         return((*tree->cb.roffdata)(tree->arg,  
                                 space != 0, tree->cur, buf));  
 }  
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_block_sub(ROFF_ARGS)
 {  {
         time_t           t;          enum rofft      t;
         char            *p, buf[32];          int             i, j;
   
         if (ROFF_BODY & tree->state) {          /*
                 assert( ! (ROFF_PRELUDE & tree->state));           * First check whether a custom macro exists at this level.  If
                 assert(ROFF_PRELUDE_Dd & tree->state);           * it does, then check against it.  This is some of groff's
                 return(roff_text(tok, tree, argv, type));           * stranger behaviours.  If we encountered a custom end-scope
         }           * tag and that tag also happens to be a "real" macro, then we
            * need to try interpreting it again as a real macro.  If it's
            * not, then return ignore.  Else continue.
            */
   
         assert(ROFF_PRELUDE & tree->state);          if (r->last->end) {
         assert( ! (ROFF_BODY & tree->state));                  i = pos + 1;
                   while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                           i++;
   
         if (ROFF_PRELUDE_Dd & tree->state) {                  for (j = 0; r->last->end[j]; j++, i++)
                 roff_err(tree, *argv, "repeated `Dd' in prelude");                          if ((*bufp)[i] != r->last->end[j])
                 return(0);                                  break;
         } else if (ROFF_PRELUDE_Dt & tree->state) {  
                 roff_err(tree, *argv, "out-of-order `Dd' in prelude");  
                 return(0);  
         }  
   
         assert(NULL == tree->last);                  if ('\0' == r->last->end[j] &&
                                   ('\0' == (*bufp)[i] ||
                                    ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
         argv++;                          if (ROFF_MAX != roff_parse(*bufp, &pos))
                                   return(ROFF_RERUN);
         if (0 == strcmp(*argv, "$Mdocdate$")) {                          return(ROFF_IGN);
                 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. */  
   
         buf[0] = 0;  
         p = *argv;  
   
         if (0 != strcmp(*argv, "$Mdocdate:")) {  
                 while (*argv) {  
                         if (strlcat(buf, *argv++, sizeof(buf))  
                                         < sizeof(buf))  
                                 continue;  
                         roff_err(tree, p, "bad `Dd' date");  
                         return(0);  
                 }                  }
                 if (strptime(buf, "%b%d,%Y", &tree->tm)) {  
                         tree->state |= ROFF_PRELUDE_Dd;  
                         return(1);  
                 }  
                 roff_err(tree, *argv, "bad `Dd' date");  
                 return(0);  
         }          }
   
         argv++;          /*
         while (*argv && **argv != '$') {           * If we have no custom end-query or lookup failed, then try
                 if (strlcat(buf, *argv++, sizeof(buf))           * pulling it out of the hashtable.
                                 >= 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)) {          ppos = pos;
                 roff_err(tree, *argv, "bad `Dd' Mdocdate");          t = roff_parse(*bufp, &pos);
                 return(0);  
         }  
   
         tree->state |= ROFF_PRELUDE_Dd;          /* If we're not a comment-end, then throw it away. */
         return(1);          if (ROFF_cblock != t)
 }                  return(ROFF_IGN);
   
           assert(roffs[t].proc);
 /* ARGSUSED */          return((*roffs[t].proc)(r, t, bufp,
 static  int                          szp, ln, ppos, pos, offs));
 roff_Dt(ROFFCALL_ARGS)  
 {  
   
         if (ROFF_BODY & tree->state) {  
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dt & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);  
         assert( ! (ROFF_BODY & tree->state));  
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state)) {  
                 roff_err(tree, *argv, "out-of-order `Dt' in prelude");  
                 return(0);  
         } else if (ROFF_PRELUDE_Dt & tree->state) {  
                 roff_err(tree, *argv, "repeated `Dt' in prelude");  
                 return(0);  
         }  
   
         argv++;  
         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++;  
         if (NULL == *argv) {  
                 roff_err(tree, *argv, "`Dt' needs section");  
                 return(0);  
         }  
   
         if (ROFF_MSEC_MAX == (tree->section = roffismsec(*argv))) {  
                 roff_err(tree, *argv, "bad `Dt' section");  
                 return(0);  
         }  
   
         argv++;  
         if (NULL == *argv) {  
                 tree->volume[0] = 0;  
         } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume))  
                         >= sizeof(tree->volume)) {  
                 roff_err(tree, *argv, "`Dt' volume too long");  
                 return(0);  
         }  
   
         assert(NULL == tree->last);  
         tree->state |= ROFF_PRELUDE_Dt;  
   
         return(1);  
 }  }
   
   
 static int  
 roffsetname(struct rofftree *tree, char **ordp)  
 {  
   
         assert(*ordp);  
   
         /* FIXME: not all sections can set this. */  
   
         if (NULL != *(ordp + 1)) {  
                 roff_err(tree, *ordp, "too many `Nm' args");  
                 return(0);  
         }  
   
         if (strlcpy(tree->name, *ordp, sizeof(tree->name))  
                         >= sizeof(tree->name)) {  
                 roff_err(tree, *ordp, "`Nm' arg too long");  
                 return(0);  
         }  
   
         return(1);  
 }  
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Ns(ROFFCALL_ARGS)  roff_block_text(ROFF_ARGS)
 {  {
         int              j, c, first;  
         char            *morep[1];  
   
         first = (*argv++ == tree->cur);          return(ROFF_IGN);
         morep[0] = NULL;  
   
         if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))  
                 return(0);  
   
         while (*argv) {  
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  
                         if ( ! roffcall(tree, c, argv))  
                                 return(0);  
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {  
                         if ( ! roffdata(tree, 1, *argv++))  
                                 return(0);  
                         continue;  
                 }  
   
                 for (j = 0; argv[j]; j++)  
                         if ( ! roffispunct(argv[j]))  
                                 break;  
   
                 if (argv[j]) {  
                         if ( ! roffdata(tree, 0, *argv++))  
                                 return(0);  
                         continue;  
                 }  
   
                 break;  
         }  
   
         if ( ! first)  
                 return(1);  
   
         return(roffpurgepunct(tree, argv));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_cond_sub(ROFF_ARGS)
 {  {
         char            *p;          enum rofft       t;
           enum roffrule    rr;
   
         if (ROFF_BODY & tree->state) {          ppos = pos;
                 assert( ! (ROFF_PRELUDE & tree->state));          rr = r->last->rule;
                 assert(ROFF_PRELUDE_Os & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          roffnode_cleanscope(r);
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||  
                         ! (ROFF_PRELUDE_Dd & tree->state)) {  
                 roff_err(tree, *argv, "out-of-order `Os' in prelude");  
                 return(0);  
         }  
   
         tree->os[0] = 0;          if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   
         p = *++argv;          /*
            * 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);
   
         while (*argv) {          assert(roffs[t].proc);
                 if (strlcat(tree->os, *argv++, sizeof(tree->os))          return((*roffs[t].proc)
                                 < sizeof(tree->os))                          (r, t, bufp, szp, ln, ppos, pos, offs));
                         continue;  
                 roff_err(tree, p, "`Os' value too long");  
                 return(0);  
         }  
   
         if (0 == tree->os[0])  
                 if (strlcpy(tree->os, "LOCAL", sizeof(tree->os))  
                                 >= sizeof(tree->os)) {  
                         roff_err(tree, p, "`Os' value too long");  
                         return(0);  
                 }  
   
         tree->state |= ROFF_PRELUDE_Os;  
         tree->state &= ~ROFF_PRELUDE;  
         tree->state |= ROFF_BODY;  
   
         assert(ROFF_MSEC_MAX != tree->section);  
         assert(0 != tree->title[0]);  
         assert(0 != tree->os[0]);  
   
         assert(NULL == tree->last);  
   
         return((*tree->cb.roffhead)(tree->arg, &tree->tm,  
                                 tree->os, tree->title, tree->section,  
                                 tree->volume));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_layout(ROFFCALL_ARGS)  roff_cond_text(ROFF_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXLINEARG];          char            *ep, *st;
         char            *argvp[ROFF_MAXLINEARG];          enum roffrule    rr;
   
         /*          rr = r->last->rule;
          * The roff_layout function is for multi-line macros.  A layout  
          * has a start and end point, which is either declared  
          * explicitly or implicitly.  An explicit start and end is  
          * embodied by `.Bl' and `.El', with the former being the start  
          * and the latter being an end.  The `.Sh' and `.Ss' tags, on  
          * the other hand, are implicit.  The scope of a layout is the  
          * space between start and end.  Explicit layouts may not close  
          * out implicit ones and vice versa; implicit layouts may close  
          * out other implicit layouts.  
          */  
   
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));  
   
         if (ROFF_PRELUDE & tree->state) {  
                 roff_err(tree, *argv, "bad `%s' in prelude",  
                                 toknames[tok]);  
                 return(0);  
         } else if (ROFF_EXIT == type) {  
                 roffnode_free(tree);  
                 if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))  
                         return(0);  
                 return((*tree->cb.roffblkout)(tree->arg, tok));  
         }  
   
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));  
   
         ++argv;  
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  
                 return(0);  
         if (NULL == roffnode_new(tok, tree))  
                 return(0);  
   
         /*          /*
          * Layouts have two parts: the layout body and header.  The           * We display the value of the text if out current evaluation
          * layout header is the trailing text of the line macro, while           * scope permits us to do so.
          * the layout body is everything following until termination.  
          * Example:  
          *  
          * .It Fl f ) ;  
          * Bar.  
          *  
          * ...Produces...  
          *  
          * <block>  
          *      <head>  
          *              <!Fl f!> ;  
          *      </head>  
          *  
          *      <body>  
          *              Bar.  
          *      </body>  
          * </block>  
          */           */
   
         if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp,          st = &(*bufp)[pos];
                                 (const char **)argvp))          if (NULL == (ep = strstr(st, "\\}"))) {
                 return(0);                  roffnode_cleanscope(r);
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
         /* +++ Begin run macro-specific hooks over argv. */  
   
         switch (tok) {  
         case (ROFF_Sh):  
                 if (NULL == *argv) {  
                         roff_err(tree, *(argv - 1),  
                                         "`Sh' expects arguments");  
                         return(0);  
                 }  
                 tree->csec = roffissec((const char **)argv);  
                 if ( ! (ROFFSec_OTHER & tree->csec) &&  
                                 tree->asec & tree->csec)  
                         roff_warn(tree, *argv, "section repeated");  
                 if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec)) {  
                         roff_err(tree, *argv, "`NAME' section "  
                                         "must be first");  
                         return(0);  
                 } else if ( ! roffchecksec(tree, *argv, tree->csec))  
                         return(0);  
   
                 tree->asec |= tree->csec;  
                 break;  
         default:  
                 break;  
         }          }
   
         /* --- End run macro-specific hooks over argv. */          if (ep > st && '\\' != *(ep - 1))
                   roffnode_pop(r);
   
         if (NULL == *argv)          roffnode_cleanscope(r);
                 return((*tree->cb.roffblkbodyin)          return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
                                 (tree->arg, tok, argcp,  
                                  (const char **)argvp));  
   
         if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp,  
                                 (const char **)argvp))  
                 return(0);  
   
         /*  
          * If there are no parsable parts, then write remaining tokens  
          * into the layout header and exit.  
          */  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {  
                 i = 0;  
                 while (*argv)  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
   
                 if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))  
                         return(0);  
                 return((*tree->cb.roffblkbodyin)(tree->arg, tok, argcp,  
                                  (const char **)argvp));  
         }  
   
         /*  
          * Parsable elements may be in the header (or be the header, for  
          * that matter).  Follow the regular parsing rules for these.  
          */  
   
         i = 0;  
         while (*argv) {  
                 if (ROFF_MAX == (c = rofffindcallable(*argv))) {  
                         assert(tree->arg);  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                         continue;  
                 }  
                 if ( ! roffcall(tree, c, argv))  
                         return(0);  
                 break;  
         }  
   
         /*  
          * If there's trailing punctuation in the header, then write it  
          * out now.  Here we mimic the behaviour of a line-dominant text  
          * macro.  
          */  
   
         if (NULL == *argv) {  
                 if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))  
                         return(0);  
                 return((*tree->cb.roffblkbodyin)  
                                 (tree->arg, tok, argcp,  
                                  (const char **)argvp));  
         }  
   
         /*  
          * Expensive.  Scan to the end of line then work backwards until  
          * a token isn't punctuation.  
          */  
   
         if ( ! roffpurgepunct(tree, argv))  
                 return(0);  
         if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))  
                 return(0);  
         return((*tree->cb.roffblkbodyin)(tree->arg,  
                                 tok, argcp, (const char **)argvp));  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_ordered(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
         int              i, first, c, argcp[ROFF_MAXLINEARG];          int              sv;
         char            *ordp[ROFF_MAXLINEARG], *p,  
                         *argvp[ROFF_MAXLINEARG];  
   
         /*          /* Stack overflow! */
          * Ordered macros pass their arguments directly to handlers,  
          * instead of considering it free-form text.  Thus, the  
          * following macro looks as follows:  
          *  
          * .Xr foo 1 ) ,  
          *  
          * .Xr arg1 arg2 punctuation  
          */  
   
         if (ROFF_PRELUDE & tree->state) {          if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
                 roff_err(tree, *argv, "`%s' disallowed in prelude",                  (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
                                 toknames[tok]);                  return(ROFF_ERR);
                 return(0);  
         }          }
   
         first = (*argv == tree->cur);          if (ROFF_if == tok || ROFF_ie == tok) {
         p = *argv++;                  /*
         ordp[0] = NULL;                   * Read ahead past the conditional.  FIXME: this does
                    * not work, as conditionals don't end on whitespace,
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))                   * but are parsed according to a formal grammar.  It's
                 return(0);                   * good enough for now, however.
                    */
         if (NULL == *argv)                  while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                 return(roffspecial(tree, tok, p, argcp,                          pos++;
                                         (const char **)argvp, 0, ordp));  
   
         i = 0;  
         while (*argv && i < ROFF_MAXLINEARG) {  
                 c = ROFF_PARSED & tokens[tok].flags ?  
                         rofffindcallable(*argv) : ROFF_MAX;  
   
                 if (ROFF_MAX == c && ! roffispunct(*argv)) {  
                         ordp[i++] = *argv++;  
                         continue;  
                 }  
                 ordp[i] = NULL;  
   
                 if (ROFF_MAX == c)  
                         break;  
   
                 if ( ! roffspecial(tree, tok, p, argcp,  
                                         (const char **)argvp,  
                                         (size_t)i, ordp))  
                         return(0);  
   
                 return(roffcall(tree, c, argv));  
         }          }
   
         assert(i != ROFF_MAXLINEARG);          sv = pos;
         ordp[i] = NULL;          while (' ' == (*bufp)[pos])
                   pos++;
   
         if ( ! roffspecial(tree, tok, p, argcp,  
                                 (const char**)argvp,  
                                 (size_t)i, ordp))  
                 return(0);  
   
         /* FIXME: error if there's stuff after the punctuation. */  
   
         if ( ! first || NULL == *argv)  
                 return(1);  
   
         return(roffpurgepunct(tree, argv));  
 }  
   
   
 /* ARGSUSED */  
 static int  
 roff_text(ROFFCALL_ARGS)  
 {  
         int              i, j, first, c, argcp[ROFF_MAXLINEARG];  
         char            *argvp[ROFF_MAXLINEARG];  
   
         /*          /*
          * Text macros are similar to special tokens, except that           * Roff is weird.  If we have just white-space after the
          * arguments are instead flushed as pure data: we're only           * conditional, it's considered the BODY and we exit without
          * concerned with the macro and its arguments.  Example:           * really doing anything.  Warn about this.  It's probably
          *           * wrong.
          * .Fl v W f ;  
          *  
          * ...Produces...  
          *  
          * <fl> v W f </fl> ;  
          */           */
           if ('\0' == (*bufp)[pos] && sv != pos) {
         if (ROFF_PRELUDE & tree->state) {                  if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                 roff_err(tree, *argv, "`%s' disallowed in prelude",                          return(ROFF_ERR);
                                 toknames[tok]);                  return(ROFF_IGN);
                 return(0);  
         }          }
   
         first = (*argv == tree->cur);          if ( ! roffnode_push(r, tok, ln, ppos))
         argv++;                  return(ROFF_ERR);
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))          /* TODO: here we would evaluate the conditional. */
                 return(0);  
         if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp,  
                                 (const char **)argvp))  
                 return(0);  
         if (NULL == *argv)  
                 return((*tree->cb.roffout)(tree->arg, tok));  
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          if (ROFF_el == tok) {
                 i = 0;                  /*
                 while (*argv)                   * An `.el' will get the value of the current rstack
                         if ( ! roffdata(tree, i++, *argv++))                   * entry set in prior `ie' calls or defaults to DENY.
                                 return(0);                   */
                   if (r->rstackpos < 0)
                 return((*tree->cb.roffout)(tree->arg, tok));                          r->last->rule = ROFFRULE_DENY;
                   else
                           r->last->rule = r->rstack[r->rstackpos];
           } else 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;
         }          }
   
           r->last->endspan = 1;
   
           if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   r->last->endspan = -1;
                   pos += 2;
           }
   
         /*          /*
          * Deal with punctuation.  Ugly.  Work ahead until we encounter           * If there are no arguments on the line, the next-line scope is
          * terminating punctuation.  If we encounter it and all           * assumed.
          * subsequent tokens are punctuation, then stop processing (the  
          * line-dominant macro will print these tokens after closure).  
          * If the punctuation is followed by non-punctuation, then close  
          * and re-open our scope, then continue.  
          */           */
   
         i = 0;          if ('\0' == (*bufp)[pos])
         while (*argv) {                  return(ROFF_IGN);
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {  
                         if ( ! (ROFF_LSCOPE & tokens[tok].flags))  
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                         return(0);  
   
                         if ( ! roffcall(tree, c, argv))  
                                 return(0);  
   
                         if (ROFF_LSCOPE & tokens[tok].flags)  
                                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                         return(0);  
   
                         break;  
                 }  
   
                 if ( ! roffispunct(*argv)) {          /* Otherwise re-run the roff parser after recalculating. */
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                         continue;  
                 }  
   
                 i = 1;          *offs = pos;
                 for (j = 0; argv[j]; j++)          return(ROFF_RERUN);
                         if ( ! roffispunct(argv[j]))  
                                 break;  
   
                 if (argv[j]) {  
                         if (ROFF_LSCOPE & tokens[tok].flags) {  
                                 if ( ! roffdata(tree, 0, *argv++))  
                                         return(0);  
                                 continue;  
                         }  
                         if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                                 return(0);  
                         if ( ! roffdata(tree, 0, *argv++))  
                                 return(0);  
                         if ( ! (*tree->cb.roffin)(tree->arg, tok,  
                                                 argcp,  
                                                 (const char **)argvp))  
                                 return(0);  
   
                         i = 0;  
                         continue;  
                 }  
   
                 if ( ! (*tree->cb.roffout)(tree->arg, tok))  
                         return(0);  
                 break;  
         }  
   
         if (NULL == *argv)  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         if ( ! first)  
                 return(1);  
   
         return(roffpurgepunct(tree, argv));  
 }  }
   
   
 /* ARGSUSED */  
 static int  
 roff_noop(ROFFCALL_ARGS)  
 {  
   
         return(1);  
 }  
   
   
 /* ARGSUSED */  
 static int  
 roff_depr(ROFFCALL_ARGS)  
 {  
   
         roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]);  
         return(0);  
 }  
   
   
 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.52  
changed lines
  Added in v.1.82
CVSweb