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

Diff for /mandoc/roff.c between version 1.63 and 1.80

version 1.63, 2008/12/10 16:03:12 version 1.80, 2010/05/17 00:37:26
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 "private.h"  #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   
 /* FIXME: First letters of quoted-text interpreted in rofffindtok. */  #define ROFF_CTL(c) \
 /* FIXME: `No' not implemented. */          ('.' == (c) || '\'' == (c))
 /* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */  
 /* TODO: warn about empty lists. */  
 /* TODO: (warn) some sections need specific elements. */  
 /* TODO: (warn) NAME section has particular order. */  
 /* TODO: macros with a set number of arguments? */  
 /* FIXME: Bl -diag supposed to ignore callable children. */  
   
 struct  roffnode {  enum    rofft {
         int               tok;          /* Token id. */          ROFF_am,
         struct roffnode  *parent;       /* Parent (or NULL). */          ROFF_ami,
           ROFF_am1,
           ROFF_de,
           ROFF_dei,
           ROFF_de1,
           ROFF_if,
           ROFF_ig,
           ROFF_cblock,
           ROFF_ccond,
   #if 0
           ROFF_ie,
           ROFF_el,
   #endif
           ROFF_MAX
 };  };
   
 enum    rofferr {  struct  roff {
         ERR_ARGEQ1,                     /* Macro requires arg == 1. */          struct roffnode *last; /* leaf of stack */
         ERR_ARGEQ0,                     /* Macro requires arg == 0. */          mandocmsg        msg; /* err/warn/fatal messages */
         ERR_ARGGE1,                     /* Macro requires arg >= 1. */          void            *data; /* privdata for messages */
         ERR_ARGGE2,                     /* Macro requires arg >= 2. */  
         ERR_ARGLEN,                     /* Macro argument too long. */  
         ERR_BADARG,                     /* Macro has bad arg. */  
         ERR_ARGMNY,                     /* Too many macro arguments. */  
         ERR_NOTSUP,                     /* Macro not supported. */  
         ERR_DEPREC,                     /* Macro deprecated. */  
         ERR_PR_OOO,                     /* Prelude macro bad order. */  
         ERR_PR_REP,                     /* Prelude macro repeated. */  
         ERR_NOT_PR,                     /* Not allowed in prelude. */  
         WRN_SECORD                      /* Sections out-of-order. */  
 };  };
   
 struct  rofftree {  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;  
         enum roffvol      volume;  
         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  roffnode {
 static  void              roffnode_free(struct rofftree *);          enum rofft       tok; /* type of node */
 static  int               roff_warn(const struct rofftree *,          struct roffnode *parent; /* up one in stack */
                                 const char *, char *, ...);          int              line; /* parse line */
 static  int               roff_warnp(const struct rofftree *,          int              col; /* parse col */
                                 const char *, int, enum rofferr);          char            *end; /* end-rules: custom token */
 static  int               roff_err(const struct rofftree *,          int              endspan; /* end-rules: next-line or infty */
                                 const char *, char *, ...);          enum roffrule    rule;
 static  int               roff_errp(const struct rofftree *,  };
                                 const char *, int, enum rofferr);  
 static  int               roffpurgepunct(struct rofftree *, char **);  
 static  int               roffscan(int, const int *);  
 static  int               rofffindtok(const char *);  
 static  int               rofffindarg(const char *);  
 static  int               rofffindcallable(const char *);  
 static  int               roffispunct(const char *);  
 static  int               roffchecksec(struct rofftree *,  
                                 const char *, int, int);  
 static  int               roffargs(const struct rofftree *,  
                                 int, char *, char **);  
 static  int               roffargok(int, int);  
 static  int               roffnextopt(const struct rofftree *,  
                                 int, char ***, char **);  
 static  int               roffparseopts(struct rofftree *, int,  
                                 char ***, int *, char **);  
 static  int               roffcall(struct rofftree *, int, char **);  
 static  int               roffexit(struct rofftree *, int);  
 static  int               roffparse(struct rofftree *, char *);  
 static  int               textparse(struct rofftree *, char *);  
 static  int               roffdata(struct rofftree *, int, char *);  
 static  int               roffspecial(struct rofftree *, int,  
                                 const char *, const int *,  
                                 const char **, size_t, char **);  
 static  int               roffsetname(struct rofftree *, char **);  
   
 #ifdef __linux__  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
 extern  size_t            strlcat(char *, const char *, size_t);                           enum rofft tok, /* tok of macro */ \
 extern  size_t            strlcpy(char *, const char *, size_t);                           char **bufp, /* input buffer */ \
 extern  int               vsnprintf(char *, size_t,                           size_t *szp, /* size of input buffer */ \
                                 const char *, va_list);                           int ln, /* parse line */ \
 extern  char             *strptime(const char *, const char *,                           int ppos, /* original pos in buffer */ \
                                 struct tm *);                           int pos, /* current pos in buffer */ \
 #endif                           int *offs /* reset offset of buffer data */
   
 int  typedef enum rofferr (*roffproc)(ROFF_ARGS);
 roff_free(struct rofftree *tree, int flush)  
 {  
         int              error, t;  
         struct roffnode *n;  
   
         error = 0;  struct  roffmac {
           const char      *name; /* macro name */
           roffproc         proc; /* process new macro */
           roffproc         text; /* process as child text of macro */
           roffproc         sub; /* process as child of macro */
           int              flags;
   #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
   };
   
         if ( ! flush)  static  enum rofferr     roff_block(ROFF_ARGS);
                 goto end;  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_if(ROFF_ARGS);
   static  enum rofferr     roff_if_text(ROFF_ARGS);
   static  enum rofferr     roff_if_sub(ROFF_ARGS);
   
         error = 1;  const   struct roffmac   roffs[ROFF_MAX] = {
           { "am", roff_block, roff_block_text, roff_block_sub, 0 },
           { "ami", roff_block, roff_block_text, roff_block_sub, 0 },
           { "am1", roff_block, roff_block_text, roff_block_sub, 0 },
           { "de", roff_block, roff_block_text, roff_block_sub, 0 },
           { "dei", roff_block, roff_block_text, roff_block_sub, 0 },
           { "de1", roff_block, roff_block_text, roff_block_sub, 0 },
           { "if", roff_if, roff_if_text, roff_if_sub, ROFFMAC_STRUCT },
           { "ig", roff_block, roff_block_text, roff_block_sub, 0 },
           { ".", roff_cblock, NULL, NULL, 0 },
           { "\\}", roff_ccond, NULL, NULL, 0 },
   };
   
         if ( ! (ROFFSec_NAME & tree->asec)) {  static  void             roff_free1(struct roff *);
                 (void)roff_err(tree, NULL, "missing `NAME' section");  static  enum rofft       roff_hash_find(const char *);
                 goto end;  static  void             roffnode_cleanscope(struct roff *);
         } else if ( ! (ROFFSec_NMASK & tree->asec))  static  int              roffnode_push(struct roff *,
                 (void)roff_warn(tree, NULL, "missing suggested `NAME', "                                  enum rofft, int, int);
                                 "`SYNOPSIS', `DESCRIPTION' sections");  static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(const char *, int *);
   
         for (n = tree->last; n; n = n->parent) {  
                 if (0 != tokens[n->tok].ctx)  
                         continue;  
                 (void)roff_err(tree, NULL, "closing explicit scope "  
                                 "`%s'", toknames[n->tok]);  
                 goto end;  
         }  
   
         while (tree->last) {  /*
                 t = tree->last->tok;   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
                 if ( ! roffexit(tree, t))   * the nil-terminated string name could be found.
                         goto end;   */
         }  static enum rofft
   roff_hash_find(const char *p)
         if ( ! (*tree->cb.rofftail)(tree->arg, &tree->tm,  
                                 tree->os, tree->title,  
                                 tree->section, tree->volume))  
                 goto end;  
   
         error = 0;  
   
 end:  
   
         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->arg = args;          return(ROFF_MAX);
         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;
           r->last = r->last->parent;
         if (0 == *buf)          if (p->end)
                 return(roff_err(tree, buf, "blank line"));                  free(p->end);
         else if ('.' != *buf)          free(p);
                 return(textparse(tree, buf));  
   
         return(roffparse(tree, buf));  
 }  }
   
   
   /*
    * 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 ( ! (ROFFSec_NAME & tree->asec))                  return(0);
                 return(roff_err(tree, buf, "data before `NAME' section"));  
   
         /* LINTED */  
         while (*buf) {  
                 while (*buf && isspace(*buf))  
                         buf++;  
   
                 if (0 == *buf)  
                         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;  
         }          }
   
           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);          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)  
                                 return(roff_err(tree, argv[i],  
                                         "unclosed quote in arg list"));  
                 } else {  
                         argv[i] = buf++;  
                         while (*buf) {  
                                 if ( ! isspace(*buf)) {  
                                         buf++;  
                                         continue;  
                                 }  
                                 if (*(buf - 1) == '\\') {  
                                         buf++;  
                                         continue;  
                                 }  
                                 break;  
                         }  
                         if (0 == *buf)  
                                 continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  
         if (ROFF_MAXLINEARG == i && *buf)  
                 return(roff_err(tree, p, "too many args"));  
   
         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)))  
                 return(roff_err(tree, buf, "bogus line macro"));  
         else if ( ! roffargs(tree, tok, buf, argv))  
                 return(0);                  return(0);
           }
   
         argvp = (char **)argv;          r->msg = msg;
           r->data = data;
           return(r);
   }
   
         /*  
          * Prelude macros break some assumptions, so branch now.  
          */  
   
         if ( ! (ROFFSec_PR_Dd & tree->asec)) {  
                 assert(NULL == tree->last);  
                 return(roffcall(tree, tok, argvp));  
         }  
   
         /*  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 (tree->last && ! roffscan  
                         (tree->last->tok, tokens[tok].parents))  
                 return(roff_err(tree, *argvp, "`%s' has invalid "  
                                         "parent `%s'", toknames[tok],  
                                         toknames[tree->last->tok]));  
   
         if (tree->last && ! roffscan  
                         (tok, tokens[tree->last->tok].children))  
                 return(roff_err(tree, *argvp, "`%s' has invalid "  
                                         "child `%s'", toknames[tok],  
                                         toknames[tree->last->tok]));  
   
         /*          /*
          * 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;  
                         return(roff_err(tree, *argv, "`%s' breaks "  
                                                 "scope of prior`%s'",  
                                                 toknames[tok],  
                                                 toknames[n->tok]));  
                 }  
   
                 /*  
                  * Create a new scope, as no previous one exists to  
                  * 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;  
                         return(roff_err(tree, *argv, "`%s' breaks "  
                                                 "scope of prior `%s'",  
                                                 toknames[tok],  
                                                 toknames[n->tok]));  
                 } else  
                         break;  
   
         if (NULL == n)  
                 return(roff_err(tree, *argv, "`%s' has no starting "  
                                         "tag `%s'", toknames[tok],  
                                         toknames[tokens[tok].ctx]));  
   
         /* LINTED */  
         do {  
                 t = tree->last->tok;  
                 if ( ! roffexit(tree, t))  
                         return(0);  
         } while (t != tokens[tok].ctx);  
   
         return(1);  
 }  }
   
   
 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)
   
         /* LINTED */  
         for (i = 0; i < ROFF_ARGMAX; i++)  
                 /* LINTED */  
                 if (0 == strcmp(name, tokargnames[i]))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  
   
   
 static int  
 rofffindtok(const char *buf)  
 {  
         char             token[4];  
         int              i;  
   
         for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)  
                 token[i] = *buf;  
   
         if (i == 3)  
                 return(ROFF_MAX);  
   
         token[i] = 0;  
   
         /* FIXME: use a table, this is slow but ok for now. */  
   
         /* LINTED */  
         for (i = 0; i < ROFF_MAX; i++)  
                 /* LINTED */  
                 if (0 == strcmp(toknames[i], token))  
                         return((int)i);  
   
         return(ROFF_MAX);  
 }  
   
   
 static int  
 roffchecksec(struct rofftree *tree,  
                 const char *start, int sec, int fail)  
 {  
   
         switch (sec) {  
         case(ROFFSec_PR_Dd):  
                 return(1);                  return(1);
         case(ROFFSec_PR_Dt):          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
                 if (ROFFSec_PR_Dd & tree->asec)                                  r->last->col, NULL));
                         return(1);  
                 break;  
         case(ROFFSec_PR_Os):  
                 if (ROFFSec_PR_Dt & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_NAME):  
                 if (ROFFSec_PR_Os & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SYNOP):  
                 if (ROFFSec_NAME & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DESC):  
                 if (ROFFSec_SYNOP & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_RETVAL):  
                 if (ROFFSec_DESC & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ENV):  
                 if (ROFFSec_RETVAL & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_FILES):  
                 if (ROFFSec_ENV & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_EX):  
                 if (ROFFSec_FILES & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_DIAG):  
                 if (ROFFSec_EX & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_ERRS):  
                 if (ROFFSec_DIAG & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_SEEALSO):  
                 if (ROFFSec_ERRS & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_STAND):  
                 if (ROFFSec_SEEALSO & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_HIST):  
                 if (ROFFSec_STAND & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_AUTH):  
                 if (ROFFSec_HIST & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_CAVEATS):  
                 if (ROFFSec_AUTH & tree->asec)  
                         return(1);  
                 break;  
         case(ROFFSec_BUGS):  
                 if (ROFFSec_CAVEATS & tree->asec)  
                         return(1);  
                 break;  
         default:  
                 return(1);  
         }  
   
         if (fail)  
                 return(0);  
         return(roff_warnp(tree, start, ROFF_Sh, WRN_SECORD));  
 }  }
   
   
 static int  /*
 roffispunct(const char *p)   * 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)
 {  {
           int              j;
           char             mac[5];
           enum rofft       t;
   
         if (0 == *p)          assert(ROFF_CTL(buf[*pos]));
                 return(0);          (*pos)++;
         if (0 != *(p + 1))  
                 return(0);  
   
         switch (*p) {          while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
         case('{'):                  (*pos)++;
                 /* FALLTHROUGH */  
         case('.'):  
                 /* FALLTHROUGH */  
         case(','):  
                 /* FALLTHROUGH */  
         case(';'):  
                 /* FALLTHROUGH */  
         case(':'):  
                 /* FALLTHROUGH */  
         case('?'):  
                 /* FALLTHROUGH */  
         case('!'):  
                 /* FALLTHROUGH */  
         case('('):  
                 /* FALLTHROUGH */  
         case(')'):  
                 /* FALLTHROUGH */  
         case('['):  
                 /* FALLTHROUGH */  
         case(']'):  
                 /* FALLTHROUGH */  
         case('}'):  
                 return(1);  
         default:  
                 break;  
         }  
   
         return(0);          if ('\0' == buf[*pos])
 }  
   
   
 static int  
 rofffindcallable(const char *name)  
 {  
         int              c;  
   
         if (ROFF_MAX == (c = rofffindtok(name)))  
                 return(ROFF_MAX);                  return(ROFF_MAX);
         assert(c >= 0 && c < ROFF_MAX);  
         return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);  
 }  
   
           for (j = 0; j < 4; j++, (*pos)++)
 static struct roffnode *                  if ('\0' == (mac[j] = buf[*pos]))
 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  
 roffnode_free(struct rofftree *tree)  
 {  
         struct roffnode *p;  
   
         assert(tree->last);  
   
         p = tree->last;  
         tree->last = tree->last->parent;  
         free(p);  
 }  
   
   
 static int  
 roffspecial(struct rofftree *tree, int tok, const char *start,  
                 const int *argc, const char **argv,  
                 size_t sz, char **ordp)  
 {  
   
         switch (tok) {  
         case (ROFF_At):  
                 if (0 == sz)  
                         break;                          break;
                 if (ROFF_ATT_MAX != roff_att(*ordp))                  else if (' ' == buf[*pos])
                         break;                          break;
                 return(roff_errp(tree, *ordp, tok, ERR_BADARG));  
   
         case (ROFF_Xr):  
                 if (2 == sz) {  
                         assert(ordp[1]);  
                         if (ROFF_MSEC_MAX != roff_msec(ordp[1]))  
                                 break;  
                         if ( ! roff_warn(tree, start, "invalid `%s' manual "  
                                                 "section", toknames[tok]))  
                                 return(0);  
                 }  
                 /* FALLTHROUGH */  
   
         case (ROFF_Sx):          if (j == 4 || j < 1)
                 /* FALLTHROUGH*/                  return(ROFF_MAX);
         case (ROFF_Fn):  
                 if (0 != sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGGE1));  
   
         case (ROFF_Nm):          mac[j] = '\0';
                 if (0 == sz) {  
                         if (0 != tree->name[0]) {  
                                 ordp[0] = tree->name;  
                                 ordp[1] = NULL;  
                                 break;  
                         }  
                         return(roff_err(tree, start, "`Nm' not set"));  
                 } else if ( ! roffsetname(tree, ordp))  
                         return(0);  
                 break;  
   
         case (ROFF_Rv):          if (ROFF_MAX == (t = roff_hash_find(mac)))
                 /* FALLTHROUGH*/                  return(t);
         case (ROFF_Ex):  
                 if (1 == sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGEQ1));  
   
         case (ROFF_Sm):          while (buf[*pos] && ' ' == buf[*pos])
                 if (1 != sz)                  (*pos)++;
                         return(roff_errp(tree, start, tok, ERR_ARGEQ1));  
                 else if (0 == strcmp(ordp[0], "on") ||  
                                 0 == strcmp(ordp[0], "off"))  
                         break;  
                 return(roff_errp(tree, *ordp, tok, ERR_BADARG));  
   
         case (ROFF_Ud):  
                 /* FALLTHROUGH */  
         case (ROFF_Ux):  
                 /* FALLTHROUGH */  
         case (ROFF_Bt):  
                 if (0 == sz)  
                         break;  
                 return(roff_errp(tree, start, tok, ERR_ARGEQ0));  
         default:  
                 break;  
         }  
   
         return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur,          return(t);
                                 argc, argv, (const char **)ordp));  
 }  }
   
   
 static int  /* ARGSUSED */
 roffexit(struct rofftree *tree, int tok)  static enum rofferr
   roff_cblock(ROFF_ARGS)
 {  {
   
         assert(tokens[tok].cb);          /*
         return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT));           * A block-close `..' should only be invoked as a child of an
 }           * ignore macro, otherwise raise a warning and just ignore it.
            */
   
           if (NULL == r->last) {
 static int                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
 roffcall(struct rofftree *tree, int tok, char **argv)                          return(ROFF_ERR);
 {                  return(ROFF_IGN);
         int              i;  
         enum roffmsec    c;  
   
         if (NULL == tokens[tok].cb)  
                 return(roff_errp(tree, *argv, tok, ERR_NOTSUP));  
   
         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) {  
                         if ( ! roff_warn(tree, *argv, "`%s' is not a valid "  
                                         "macro in this manual section",  
                                         toknames[tok]))  
                                 return(0);  
                 }  
         }          }
   
         return((*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER));          if (ROFF_ig != r->last->tok) {
 }                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
 static int  
 roffnextopt(const struct rofftree *tree, int tok,  
                 char ***in, char **val)  
 {  
         char            *arg, **argv;  
         int              v;  
   
         *val = NULL;  
         argv = *in;  
         assert(argv);  
   
         if (NULL == (arg = *argv))  
                 return(-1);  
         if ('-' != *arg)  
                 return(-1);  
   
         if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {  
                 if ( ! roff_warn(tree, arg, "argument-like parameter `%s' to "  
                                         "`%s'", arg, toknames[tok]))  
                         return(ROFF_ARGMAX);  
                 return(-1);  
         }  
   
         if ( ! roffargok(tok, v)) {  
                 if ( ! roff_warn(tree, arg, "invalid argument parameter `%s' to "  
                                 "`%s'", tokargnames[v], toknames[tok]))  
                         return(ROFF_ARGMAX);  
                 return(-1);  
         }  
   
         if ( ! (ROFF_VALUE & tokenargs[v]))  
                 return(v);  
   
         *in = ++argv;  
   
         if (NULL == *argv) {  
                 (void)roff_err(tree, arg, "empty value of `%s' for `%s'",  
                                 tokargnames[v], toknames[tok]);  
                 return(ROFF_ARGMAX);  
         }          }
   
         return(v);          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  
 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  static void
 roffparseopts(struct rofftree *tree, int tok,  roffnode_cleanscope(struct roff *r)
                 char ***args, int *argc, char **argv)  
 {  {
         int              i, c;  
         char            *v;  
   
         i = 0;          while (r->last) {
                   if (--r->last->endspan < 0)
         while (-1 != (c = roffnextopt(tree, tok, args, &v))) {                          break;
                 if (ROFF_ARGMAX == c)                  roffnode_pop(r);
                         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_ccond(ROFF_ARGS)
 {  {
         time_t           t;  
         char            *p, buf[32];  
         size_t           sz;  
   
         if (ROFFSec_PR_Os & tree->asec)          if (NULL == r->last) {
                 return(roff_text(tok, tree, argv, type));                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         if (ROFFSec_PR_Dd & tree->asec)                          return(ROFF_ERR);
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));                  return(ROFF_IGN);
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dd, 1))          }
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         assert(NULL == tree->last);          if (ROFF_if != r->last->tok) {
         argv++;                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         tree->asec |= (tree->csec = ROFFSec_PR_Dd);                          return(ROFF_ERR);
                   return(ROFF_IGN);
         /*  
          * This is a bit complex because there are many forms the date  
          * can be in:  it can be simply $Mdocdate$, $Mdocdate <date>$,  
          * or a raw date.  Process accordingly.  
          */  
   
         if (0 == strcmp(*argv, "$Mdocdate$")) {  
                 t = time(NULL);  
                 if (NULL == localtime_r(&t, &tree->tm))  
                         err(1, "localtime_r");  
                 return(1);  
         }  
   
         buf[0] = 0;  
         p = *argv;  
         sz = sizeof(buf);  
   
         if (0 != strcmp(*argv, "$Mdocdate:")) {  
                 while (*argv) {  
                         if (strlcat(buf, *argv++, sz) < sz)  
                                 continue;  
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
                 }  
                 if (strptime(buf, "%b%d,%Y", &tree->tm))  
                         return(1);  
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
         }          }
   
         argv++;          if (r->last->endspan > -1) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         while (*argv && **argv != '$') {                          return(ROFF_ERR);
                 if (strlcat(buf, *argv++, sz) >= sz)                  return(ROFF_IGN);
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
                 if (strlcat(buf, " ", sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_BADARG));  
         }          }
   
         if (NULL == *argv)          if ((*bufp)[pos])
                 return(roff_errp(tree, p, tok, ERR_BADARG));                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
         if (NULL == strptime(buf, "%b %d %Y", &tree->tm))                          return(ROFF_ERR);
                 return(roff_errp(tree, p, tok, ERR_BADARG));  
   
         return(1);          roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dt(ROFFCALL_ARGS)  roff_block(ROFF_ARGS)
 {  {
         size_t           sz;          int             sv;
           size_t          sz;
   
         if (ROFFSec_PR_Os & tree->asec)          if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
                 return(roff_text(tok, tree, argv, type));                  if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
         if (ROFFSec_PR_Dt & tree->asec)                          return(ROFF_ERR);
                 return(roff_errp(tree, *argv, tok, ERR_PR_REP));                  return(ROFF_IGN);
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dt, 1))          } else if (ROFF_ig != tok) {
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));                  while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                           pos++;
                   while (' ' == (*bufp)[pos])
                           pos++;
           }
   
         argv++;          if ( ! roffnode_push(r, tok, ln, ppos))
         tree->asec |= (tree->csec = ROFFSec_PR_Dt);                  return(ROFF_ERR);
         sz = sizeof(tree->title);  
   
         if (NULL == *argv)          if ('\0' == (*bufp)[pos])
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));                  return(ROFF_IGN);
         if (strlcpy(tree->title, *argv, sz) >= sz)  
                 return(roff_errp(tree, *argv, tok, ERR_ARGLEN));  
   
         argv++;          sv = pos;
         if (NULL == *argv)          while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
                 return(roff_errp(tree, *argv, tok, ERR_ARGGE2));                          '\t' != (*bufp)[pos])
                   pos++;
   
         if (ROFF_MSEC_MAX == (tree->section = roff_msec(*argv)))          /*
                 return(roff_errp(tree, *argv, tok, ERR_BADARG));           * 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.
            */
   
         argv++;          assert(pos > sv);
           sz = (size_t)(pos - sv);
   
         if (NULL == *argv) {          if (1 == sz && '.' == (*bufp)[sv])
                 switch (tree->section) {                  return(ROFF_IGN);
                 case(ROFF_MSEC_1):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_6):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_7):  
                         tree->volume = ROFF_VOL_URM;  
                         break;  
                 case(ROFF_MSEC_2):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_3):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_3p):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_4):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_5):  
                         tree->volume = ROFF_VOL_PRM;  
                         break;  
                 case(ROFF_MSEC_8):  
                         tree->volume = ROFF_VOL_PRM;  
                         break;  
                 case(ROFF_MSEC_9):  
                         tree->volume = ROFF_VOL_KM;  
                         break;  
                 case(ROFF_MSEC_UNASS):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_DRAFT):  
                         /* FALLTHROUGH */  
                 case(ROFF_MSEC_PAPER):  
                         tree->volume = ROFF_VOL_NONE;  
                         break;  
                 default:  
                         abort();  
                         /* NOTREACHED */  
                 }  
         } else if (ROFF_VOL_MAX == (tree->volume = roff_vol(*argv)))  
                 return(roff_errp(tree, *argv, tok, ERR_BADARG));  
   
         assert(NULL == tree->last);          r->last->end = malloc(sz + 1);
   
         return(1);          if (NULL == r->last->end) {
 }                  (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
                   return(ROFF_ERR);
           }
   
           memcpy(r->last->end, *bufp + sv, sz);
           r->last->end[(int)sz] = '\0';
   
 static int          if ((*bufp)[pos])
 roffsetname(struct rofftree *tree, char **ordp)                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
 {                          return(ROFF_ERR);
         size_t           sz;  
   
         assert(*ordp);  
   
         /* FIXME: not all sections can set this. */          return(ROFF_IGN);
   
         if (NULL != *(ordp + 1))  
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGMNY));  
   
         sz = sizeof(tree->name);  
         if (strlcpy(tree->name, *ordp, sz) >= sz)  
                 return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGLEN));  
   
         return(1);  
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Ns(ROFFCALL_ARGS)  roff_if_sub(ROFF_ARGS)
 {  {
         int              j, c, first;          enum rofft       t;
         char            *morep[1];          enum roffrule    rr;
   
         first = (*argv++ == tree->cur);          ppos = pos;
         morep[0] = NULL;          rr = r->last->rule;
           roffnode_cleanscope(r);
   
         if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))          if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                 return(0);                  return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   
         while (*argv) {          /*
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {           * A denied conditional must evaluate its children if and only
                         if ( ! roffcall(tree, c, argv))           * if they're either structurally required (such as loops and
                                 return(0);           * conditionals) or a closing macro.
                         break;           */
                 }          if (ROFFRULE_DENY == rr)
                   if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
                 if ( ! roffispunct(*argv)) {          assert(roffs[t].proc);
                         if ( ! roffdata(tree, 1, *argv++))          return((*roffs[t].proc)
                                 return(0);                          (r, t, bufp, szp, ln, ppos, pos, offs));
                         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_block_sub(ROFF_ARGS)
 {  {
         char            *p;          enum rofft      t;
         size_t           sz;          int             i, j;
   
         if (ROFFSec_PR_Os & tree->asec)  
                 return(roff_text(tok, tree, argv, type));  
         if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Os, 1))  
                 return(roff_errp(tree, *argv, tok, ERR_PR_OOO));  
   
         p = *++argv;  
         sz = sizeof(tree->os);  
         tree->asec |= (tree->csec = ROFFSec_PR_Os);  
   
         tree->os[0] = 0;  
   
         while (*argv)  
                 if (strlcat(tree->os, *argv++, sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_ARGLEN));  
   
         if (0 == tree->os[0])  
                 if (strlcpy(tree->os, "LOCAL", sz) >= sz)  
                         return(roff_errp(tree, p, tok, ERR_ARGLEN));  
   
         assert(ROFF_MSEC_MAX != tree->section);  
         assert(0 != tree->title[0]);  
         assert(0 != tree->os[0]);  
   
         assert(NULL == tree->last);  
   
         return((*tree->cb.roffhead)(tree->arg, &tree->tm,  
                                 tree->os, tree->title,  
                                 tree->section, tree->volume));  
 }  
   
   
 /* ARGSUSED */  
 static int  
 roff_layout(ROFFCALL_ARGS)  
 {  
         int              i, c, argcp[ROFF_MAXLINEARG];  
         char            *argvp[ROFF_MAXLINEARG], *p;  
   
         /*          /*
          * The roff_layout function is for multi-line macros.  A layout           * First check whether a custom macro exists at this level.  If
          * has a start and end point, which is either declared           * it does, then check against it.  This is some of groff's
          * explicitly or implicitly.  An explicit start and end is           * stranger behaviours.  If we encountered a custom end-scope
          * embodied by `.Bl' and `.El', with the former being the start           * tag and that tag also happens to be a "real" macro, then we
          * and the latter being an end.  The `.Sh' and `.Ss' tags, on           * need to try interpreting it again as a real macro.  If it's
          * the other hand, are implicit.  The scope of a layout is the           * not, then return ignore.  Else continue.
          * 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 (r->last->end) {
                   i = pos + 1;
                   while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                           i++;
   
         if ( ! (ROFFSec_PR_Os & tree->asec))                  for (j = 0; r->last->end[j]; j++, i++)
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));                          if ((*bufp)[i] != r->last->end[j])
                                   break;
   
         if (ROFF_EXIT == type) {                  if ('\0' == r->last->end[j] &&
                 roffnode_free(tree);                                  ('\0' == (*bufp)[i] ||
                 if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))                                   ' ' == (*bufp)[i] ||
                         return(0);                                   '\t' == (*bufp)[i])) {
                 return((*tree->cb.roffblkout)(tree->arg, tok));                          roffnode_pop(r);
         }                          roffnode_cleanscope(r);
   
         p = *argv++;                          if (ROFF_MAX != roff_parse(*bufp, &pos))
         assert( ! (ROFF_CALLABLE & tokens[tok].flags));                                  return(ROFF_RERUN);
                           return(ROFF_IGN);
         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  
          * layout header is the trailing text of the line macro, while  
          * 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,  
                                 (const char **)argvp))  
                 return(0);  
   
         /* +++ Begin run macro-specific hooks over argv. */  
   
         switch (tok) {  
         case (ROFF_Sh):  
                 if (NULL == *argv) {  
                         argv--;  
                         return(roff_errp(tree, *argv, tok, ERR_ARGGE1));  
                 }                  }
   
                 tree->csec = roff_sec((const char **)argv);  
   
                 if ( ! (ROFFSec_OTHER & tree->csec) &&  
                                 tree->asec & tree->csec)  
                         if ( ! roff_warn(tree, *argv, "section repeated"))  
                                 return(0);  
   
                 if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec))  
                         return(roff_err(tree, *argv, "`NAME' section "  
                                                 "must be first"));  
                 if ( ! roffchecksec(tree, *argv, tree->csec, 0))  
                         return(0);  
   
                 tree->asec |= tree->csec;  
   
                 if ( ! roffspecial(tree, tok, p, argcp,  
                                         (const char **)argvp, 0, argv))  
                         return(0);  
                 break;  
         default:  
                 break;  
         }          }
   
         /* --- End run macro-specific hooks over argv. */  
   
         if (NULL == *argv)  
                 return((*tree->cb.roffblkbodyin)  
                                 (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           * If we have no custom end-query or lookup failed, then try
          * into the layout header and exit.           * pulling it out of the hashtable.
          */           */
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          ppos = pos;
                 i = 0;          t = roff_parse(*bufp, &pos);
                 while (*argv)  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
   
                 if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))          /* If we're not a comment-end, then throw it away. */
                         return(0);          if (ROFF_cblock != t)
                 return((*tree->cb.roffblkbodyin)(tree->arg, tok, argcp,                  return(ROFF_IGN);
                                  (const char **)argvp));  
         }  
   
         /*          assert(roffs[t].proc);
          * Parsable elements may be in the header (or be the header, for          return((*roffs[t].proc)(r, t, bufp,
          * that matter).  Follow the regular parsing rules for these.                          szp, ln, ppos, pos, offs));
          */  }
   
         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;  
         }  
   
         /*  /* ARGSUSED */
          * If there's trailing punctuation in the header, then write it  static enum rofferr
          * out now.  Here we mimic the behaviour of a line-dominant text  roff_block_text(ROFF_ARGS)
          * macro.  {
          */  
   
         if (NULL == *argv) {          return(ROFF_IGN);
                 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_if_text(ROFF_ARGS)
 {  {
         int              i, first, c, argcp[ROFF_MAXLINEARG];          char            *ep, *st;
         char            *ordp[ROFF_MAXLINEARG], *p,  
                         *argvp[ROFF_MAXLINEARG];  
   
         /*          st = &(*bufp)[pos];
          * Ordered macros pass their arguments directly to handlers,          if (NULL == (ep = strstr(st, "\\}"))) {
          * instead of considering it free-form text.  Thus, the                  roffnode_cleanscope(r);
          * following macro looks as follows:                  return(ROFF_IGN);
          *  
          * .Xr foo 1 ) ,  
          *  
          * .Xr arg1 arg2 punctuation  
          */  
   
         if ( ! (ROFFSec_PR_Os & tree->asec))  
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));  
   
         first = (*argv == tree->cur);  
         p = *argv++;  
         ordp[0] = NULL;  
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  
                 return(0);  
   
         if (NULL == *argv)  
                 return(roffspecial(tree, tok, p, argcp,  
                                         (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);          if (ep > st && '\\' != *(ep - 1))
         ordp[i] = NULL;                  roffnode_pop(r);
   
         if ( ! roffspecial(tree, tok, p, argcp,          roffnode_cleanscope(r);
                                 (const char**)argvp,          return(ROFF_IGN);
                                 (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 */  /* ARGSUSED */
 static int  static enum rofferr
 roff_text(ROFFCALL_ARGS)  roff_if(ROFF_ARGS)
 {  {
         int              i, j, first, c, argcp[ROFF_MAXLINEARG];          int              sv;
         char            *argvp[ROFF_MAXLINEARG];  
   
         /*          /*
          * Text macros are similar to special tokens, except that           * Read ahead past the conditional.
          * arguments are instead flushed as pure data: we're only           * FIXME: this does not work, as conditionals don't end on
          * concerned with the macro and its arguments.  Example:           * whitespace, but are parsed according to a formal grammar.
          *           * It's good enough for now, however.
          * .Fl v W f ;  
          *  
          * ...Produces...  
          *  
          * <fl> v W f </fl> ;  
          */           */
   
         if ( ! (ROFFSec_PR_Os & tree->asec))          while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                 return(roff_errp(tree, *argv, tok, ERR_NOT_PR));                  pos++;
   
         first = (*argv == tree->cur);          sv = pos;
         argv++;          while (' ' == (*bufp)[pos])
                   pos++;
   
         if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))  
                 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)) {  
                 i = 0;  
                 while (*argv)  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                 return((*tree->cb.roffout)(tree->arg, tok));  
         }  
   
         /*          /*
          * Deal with punctuation.  Ugly.  Work ahead until we encounter           * Roff is weird.  If we have just white-space after the
          * terminating punctuation.  If we encounter it and all           * conditional, it's considered the BODY and we exit without
          * subsequent tokens are punctuation, then stop processing (the           * really doing anything.  Warn about this.  It's probably
          * line-dominant macro will print these tokens after closure).           * wrong.
          * If the punctuation is followed by non-punctuation, then close  
          * and re-open our scope, then continue.  
          */           */
   
         i = 0;          if ('\0' == (*bufp)[pos] && sv != pos) {
         while (*argv) {                  if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                 if (ROFF_MAX != (c = rofffindcallable(*argv))) {                          return(ROFF_ERR);
                         if ( ! (ROFF_LSCOPE & tokens[tok].flags))                  return(ROFF_IGN);
                                 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)) {  
                         if ( ! roffdata(tree, i++, *argv++))  
                                 return(0);  
                         continue;  
                 }  
   
                 i = 1;  
                 for (j = 0; argv[j]; j++)  
                         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)          if ( ! roffnode_push(r, tok, ln, ppos))
                 return((*tree->cb.roffout)(tree->arg, tok));                  return(ROFF_ERR);
         if ( ! first)  
                 return(1);  
   
         return(roffpurgepunct(tree, argv));          /* Don't evaluate: just assume NO. */
 }  
   
           r->last->endspan = 1;
   
 /* ARGSUSED */          if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
 static int                  r->last->endspan = -1;
 roff_noop(ROFFCALL_ARGS)                  pos += 2;
 {          }
   
         return(1);          /*
 }           * If there are no arguments on the line, the next-line scope is
            * assumed.
            */
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
 /* ARGSUSED */          /* Otherwise re-run the roff parser after recalculating. */
 static int  
 roff_depr(ROFFCALL_ARGS)  
 {  
   
         return(roff_errp(tree, *argv, tok, ERR_DEPREC));          *offs = pos;
           return(ROFF_RERUN);
 }  }
   
   
 static int  
 roff_warnp(const struct rofftree *tree, const char *pos,  
                 int tok, enum rofferr type)  
 {  
         char             *p;  
   
         switch (type) {  
         case (WRN_SECORD):  
                 p = "section at `%s' out of order";  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         return(roff_warn(tree, pos, p, toknames[tok]));  
 }  
   
   
 static int  
 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);  
   
         return((*tree->cb.roffmsg)(tree->arg,  
                                 ROFF_WARN, tree->cur, pos, buf));  
 }  
   
   
 static int  
 roff_errp(const struct rofftree *tree, const char *pos,  
                 int tok, enum rofferr type)  
 {  
         char             *p;  
   
         switch (type) {  
         case (ERR_ARGEQ1):  
                 p = "`%s' expects exactly one argument";  
                 break;  
         case (ERR_ARGEQ0):  
                 p = "`%s' expects exactly zero arguments";  
                 break;  
         case (ERR_ARGGE1):  
                 p = "`%s' expects one or more arguments";  
                 break;  
         case (ERR_ARGGE2):  
                 p = "`%s' expects two or more arguments";  
                 break;  
         case (ERR_BADARG):  
                 p = "invalid argument for `%s'";  
                 break;  
         case (ERR_NOTSUP):  
                 p = "macro `%s' is not supported";  
                 break;  
         case(ERR_PR_OOO):  
                 p = "prelude macro `%s' is out of order";  
                 break;  
         case(ERR_PR_REP):  
                 p = "prelude macro `%s' repeated";  
                 break;  
         case(ERR_ARGLEN):  
                 p = "macro argument for `%s' is too long";  
                 break;  
         case(ERR_DEPREC):  
                 p = "macro `%s' is deprecated";  
                 break;  
         case(ERR_NOT_PR):  
                 p = "macro `%s' disallowed in prelude";  
                 break;  
         case(ERR_ARGMNY):  
                 p = "too many arguments for macro `%s'";  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         return(roff_err(tree, pos, p, toknames[tok]));  
 }  
   
   
 static int  
 roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)  
 {  
         va_list          ap;  
         char             buf[128];  
   
         va_start(ap, fmt);  
         if (-1 == vsnprintf(buf, sizeof(buf), fmt, ap))  
                 err(1, "vsnprintf");  
         va_end(ap);  
   
         return((*tree->cb.roffmsg)  
                         (tree->arg, ROFF_ERROR, tree->cur, pos, buf));  
 }  
   
Legend:
Removed from v.1.63  
changed lines
  Added in v.1.80
CVSweb