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

Diff for /mandoc/roff.c between version 1.4 and 1.61

version 1.4, 2008/11/25 12:14:02 version 1.61, 2008/12/10 13:15:55
Line 16 
Line 16 
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.   * PERFORMANCE OF THIS SOFTWARE.
  */   */
   #include <sys/param.h>
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  #include <err.h>
   #include <stdarg.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  #include <stdio.h>
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <time.h>
   
 #include "libmdocml.h"  
 #include "private.h"  #include "private.h"
   #include "roff.h"
   
 #define ROFF_MAXARG       10  /* FIXME: First letters of quoted-text interpreted in rofffindtok. */
   /* 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: macros with a set number of arguments? */
   /* TODO: validate Dt macro arguments. */
   /* FIXME: Bl -diag supposed to ignore callable children. */
   
 enum    roffd {  struct  roffnode {
         ROFF_ENTER = 0,          int               tok;          /* Token id. */
         ROFF_EXIT          struct roffnode  *parent;       /* Parent (or NULL). */
 };  };
   
 /* FIXME: prolog roffs can be text roffs, too. */  enum    rofferr {
           ERR_ARGEQ1,                     /* Macro requires arg == 1. */
 enum    rofftype {          ERR_ARGEQ0,                     /* Macro requires arg == 0. */
         ROFF_COMMENT,          ERR_ARGGE1,                     /* Macro requires arg >= 1. */
         ROFF_TEXT,          ERR_ARGGE2,                     /* Macro requires arg >= 2. */
         ROFF_LAYOUT          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. */
 };  };
   
 #define ROFFCALL_ARGS \  
         int tok, struct rofftree *tree, \  
         const char *argv[], enum roffd type  
   
 struct  rofftree;  
   
 struct  rofftok {  
         int             (*cb)(ROFFCALL_ARGS);  
         enum rofftype     type;  
         int               flags;  
 #define ROFF_NESTED      (1 << 0)  
 #define ROFF_PARSED      (1 << 1)  
 #define ROFF_CALLABLE    (1 << 2)  
 #define ROFF_QUOTES      (1 << 3)  
 };  
   
 struct  roffarg {  
         int               tok;  
         int               flags;  
 #define ROFF_VALUE       (1 << 0)  
 };  
   
 struct  roffnode {  
         int               tok;  
         struct roffnode  *parent;  
         size_t            line;  
 };  
   
 struct  rofftree {  struct  rofftree {
         struct roffnode  *last;          struct roffnode  *last;                 /* Last parsed node. */
         time_t            date;          char             *cur;                  /* Line start. */
         char              os[64];          struct tm         tm;                   /* `Dd' results. */
         char              title[64];          char              name[64];             /* `Nm' results. */
         char              section[64];          char              os[64];               /* `Os' results. */
         char              volume[64];          char              title[64];            /* `Dt' results. */
         int               state;          enum roffmsec     section;
 #define ROFF_PRELUDE     (1 << 1)          enum roffvol      volume;
 #define ROFF_PRELUDE_Os  (1 << 2)          struct roffcb     cb;                   /* Callbacks. */
 #define ROFF_PRELUDE_Dt  (1 << 3)          void             *arg;                  /* Callbacks' arg. */
 #define ROFF_PRELUDE_Dd  (1 << 4)          int               csec;                 /* Current section. */
 #define ROFF_BODY        (1 << 5)          int               asec;                 /* Thus-far sections. */
   
         roffin           roffin;  
         roffblkin        roffblkin;  
         roffout          roffout;  
         roffblkout       roffblkout;  
   
         struct md_mbuf          *mbuf; /* NULL if !flush. */  
         const struct md_args    *args;  
         const struct md_rbuf    *rbuf;  
 };  };
   
 static  int               roff_Dd(ROFFCALL_ARGS);  
 static  int               roff_Dt(ROFFCALL_ARGS);  
 static  int               roff_Os(ROFFCALL_ARGS);  
   
 static  int               roff_layout(ROFFCALL_ARGS);  
 static  int               roff_text(ROFFCALL_ARGS);  
   
 static  struct roffnode  *roffnode_new(int, struct rofftree *);  static  struct roffnode  *roffnode_new(int, struct rofftree *);
 static  void              roffnode_free(int, struct rofftree *);  static  void              roffnode_free(struct rofftree *);
   static  int               roff_warn(const struct rofftree *,
                                   const char *, char *, ...);
   static  int               roff_warnp(const struct rofftree *,
                                   const char *, int, enum rofferr);
   static  int               roff_err(const struct rofftree *,
                                   const char *, char *, ...);
   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               rofffindtok(const char *);
 static  int               rofffindarg(const char *);  static  int               rofffindarg(const char *);
 static  int               rofffindcallable(const char *);  static  int               rofffindcallable(const char *);
 static  int               roffargs(int, char *, char **);  static  int               roffispunct(const char *);
 static  int               roffparse(struct rofftree *, char *, size_t);  static  int               roffchecksec(struct rofftree *,
 static  int               textparse(const struct rofftree *,                                  const char *, int, int);
                                 const char *, size_t);  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__
   extern  size_t            strlcat(char *, const char *, size_t);
   extern  size_t            strlcpy(char *, const char *, size_t);
   extern  int               vsnprintf(char *, size_t,
                                   const char *, va_list);
   extern  char             *strptime(const char *, const char *,
                                   struct tm *);
   #endif
   
 static  const struct rofftok tokens[ROFF_MAX] = {  
         {        NULL, ROFF_COMMENT, 0 },  
         {     roff_Dd, ROFF_TEXT, 0 },                  /* Dd */  
         {     roff_Dt, ROFF_TEXT, 0 },                  /* Dt */  
         {     roff_Os, ROFF_TEXT, 0 },                  /* Os */  
         { roff_layout, ROFF_LAYOUT, ROFF_PARSED },      /* Sh */  
         { roff_layout, ROFF_LAYOUT, ROFF_PARSED },      /* Ss XXX */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* Pp */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* D1 */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* Dl */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* Bd */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* Ed */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* Bl */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* El */  
         { roff_layout, ROFF_LAYOUT, 0 },                /* It */  
         {   roff_text, ROFF_TEXT, ROFF_PARSED },        /* An */  
         {   roff_text, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */  
 };  
   
 /* FIXME: multiple owners? */  
   
 static  const struct roffarg tokenargs[ROFF_ARGMAX] = {  
         { ROFF_An, 0 },                         /* split */  
         { ROFF_An, 0 },                         /* nosplit */  
         { ROFF_Bd, 0 },                         /* ragged */  
         { ROFF_Bd, 0 },                         /* unfilled */  
         { ROFF_Bd, 0 },                         /* literal */  
         { ROFF_Bd, ROFF_VALUE },                /* file */  
         { ROFF_Bd, ROFF_VALUE },                /* offset */  
         { ROFF_Bl, 0 },                         /* bullet */  
         { ROFF_Bl, 0 },                         /* dash */  
         { ROFF_Bl, 0 },                         /* hyphen */  
         { ROFF_Bl, 0 },                         /* item */  
         { ROFF_Bl, 0 },                         /* enum */  
         { ROFF_Bl, 0 },                         /* tag */  
         { ROFF_Bl, 0 },                         /* diag */  
         { ROFF_Bl, 0 },                         /* hang */  
         { ROFF_Bl, 0 },                         /* ohang */  
         { ROFF_Bl, 0 },                         /* inset */  
         { ROFF_Bl, 0 },                         /* column */  
 };  
   
 static  const char *const toknames[ROFF_MAX] = ROFF_NAMES;  
 static  const char *const tokargnames[ROFF_ARGMAX] = ROFF_ARGNAMES;  
   
   
 int  int
 roff_free(struct rofftree *tree, int flush)  roff_free(struct rofftree *tree, int flush)
 {  {
         int              error;          int              error, t;
           struct roffnode *n;
   
         assert(tree->mbuf);          error = 0;
   
         if ( ! flush)          if ( ! flush)
                 tree->mbuf = NULL;                  goto end;
   
         /* LINTED */          error = 1;
         while (tree->last)  
                 if ( ! (*tokens[tree->last->tok].cb)  
                                 (tree->last->tok, tree, NULL, ROFF_EXIT))  
                         /* Disallow flushing. */  
                         tree->mbuf = NULL;  
   
         error = tree->mbuf ? 0 : 1;          if ( ! (ROFFSec_NAME & tree->asec)) {
                   (void)roff_err(tree, NULL, "missing `NAME' section");
                   goto end;
           } else if ( ! (ROFFSec_NMASK & tree->asec))
                   (void)roff_warn(tree, NULL, "missing suggested `NAME', "
                                   "`SYNOPSIS', `DESCRIPTION' sections");
   
         if (tree->mbuf && (ROFF_PRELUDE & tree->state)) {          for (n = tree->last; n; n = n->parent) {
                 warnx("%s: prelude never finished",                  if (0 != tokens[n->tok].ctx)
                                 tree->rbuf->name);                          continue;
                 error = 1;                  (void)roff_err(tree, NULL, "closing explicit scope "
                                   "`%s'", toknames[n->tok]);
                   goto end;
         }          }
   
           while (tree->last) {
                   t = tree->last->tok;
                   if ( ! roffexit(tree, t))
                           goto end;
           }
   
           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);          free(tree);
   
         return(error ? 0 : 1);          return(error ? 0 : 1);
 }  }
   
   
 struct rofftree *  struct rofftree *
 roff_alloc(const struct md_args *args, struct md_mbuf *out,  roff_alloc(const struct roffcb *cb, void *args)
                 const struct md_rbuf *in, roffin textin,  
                 roffout textout, roffblkin blkin, roffblkout blkout)  
 {  {
         struct rofftree *tree;          struct rofftree *tree;
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) {          assert(args);
                 warn("malloc");          assert(cb);
                 return(NULL);  
         }  
   
         tree->state = ROFF_PRELUDE;          if (NULL == (tree = calloc(1, sizeof(struct rofftree))))
         tree->args = args;                  err(1, "calloc");
         tree->mbuf = out;  
         tree->rbuf = in;  
         tree->roffin = textin;  
         tree->roffout = textout;  
         tree->roffblkin = blkin;  
         tree->roffblkout = blkout;  
   
           tree->arg = args;
           tree->section = ROFF_MSEC_MAX;
   
           (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));
   
         return(tree);          return(tree);
 }  }
   
   
 int  int
 roff_engine(struct rofftree *tree, char *buf, size_t sz)  roff_engine(struct rofftree *tree, char *buf)
 {  {
   
         if (0 == sz) {          tree->cur = buf;
                 warnx("%s: blank line (line %zu)",          assert(buf);
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         } else if ('.' != *buf)  
                 return(textparse(tree, buf, sz));  
   
         return(roffparse(tree, buf, sz));          if (0 == *buf)
                   return(roff_err(tree, buf, "blank line"));
           else if ('.' != *buf)
                   return(textparse(tree, buf));
   
           return(roffparse(tree, buf));
 }  }
   
   
 static int  static int
 textparse(const struct rofftree *tree, const char *buf, size_t sz)  textparse(struct rofftree *tree, char *buf)
 {  {
           char            *bufp;
         if (NULL == tree->last) {  
                 warnx("%s: unexpected text (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         } else if (NULL == tree->last->parent) {  
                 warnx("%s: disallowed text (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         }  
   
         /* Print text. */          /* TODO: literal parsing. */
   
           if ( ! (ROFFSec_NAME & tree->asec))
                   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;
           }
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 roffargs(int tok, char *buf, char **argv)  roffargs(const struct rofftree *tree,
                   int tok, char *buf, char **argv)
 {  {
         int              i;          int              i;
           char            *p;
   
         (void)tok;/* FIXME: quotable strings? */  
   
         assert(tok >= 0 && tok < ROFF_MAX);          assert(tok >= 0 && tok < ROFF_MAX);
         assert('.' == *buf);          assert('.' == *buf);
   
           p = buf;
   
           /*
            * This is an ugly little loop.  It parses a line into
            * 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 */          /* LINTED */
         for (i = 0; *buf && i < ROFF_MAXARG; i++) {          for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) {
                 argv[i] = buf++;                  if ('\"' == *buf) {
                 while (*buf && ! isspace(*buf))                          argv[i] = ++buf;
                         buf++;                          while (*buf && '\"' != *buf)
                 if (0 == *buf) {                                  buf++;
                         continue;                          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;                  *buf++ = 0;
                 while (*buf && isspace(*buf))                  while (*buf && isspace(*buf))
                         buf++;                          buf++;
         }          }
   
         assert(i > 0);          assert(i > 0);
         if (i < ROFF_MAXARG)          if (ROFF_MAXLINEARG == i && *buf)
                 argv[i] = NULL;                  return(roff_err(tree, p, "too many args"));
   
         return(ROFF_MAXARG > i);          argv[i] = NULL;
           return(1);
 }  }
   
   
 static int  static int
 roffparse(struct rofftree *tree, char *buf, size_t sz)  roffscan(int tok, const int *tokv)
 {  {
         int               tok, t;  
         struct roffnode  *node;  
         char             *argv[ROFF_MAXARG];  
         const char      **argvp;  
   
         assert(sz > 0);          if (NULL == tokv)
                   return(1);
   
         /*          for ( ; ROFF_MAX != *tokv; tokv++)
          * Extract the token identifier from the buffer.  If there's no                  if (tok == *tokv)
          * callback for the token (comment, etc.) then exit immediately.                          return(1);
          * We don't do any error handling (yet), so if the token doesn't  
          * exist, die.  
          */  
   
         if (3 > sz) {          return(0);
                 warnx("%s: malformed line (line %zu)",  }
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
   static int
   roffparse(struct rofftree *tree, char *buf)
   {
           int               tok, t;
           struct roffnode  *n;
           char             *argv[ROFF_MAXLINEARG];
           char            **argvp;
   
           if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))
                   if (0 == strncmp(buf, ".\\\"", 3))
                           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);
         } else if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {  
                 warnx("%s: unknown line token `%c%c' (line %zu)",          argvp = (char **)argv;
                                 tree->rbuf->name,  
                                 *(buf + 1), *(buf + 2),          /*
                                 tree->rbuf->line);           * Prelude macros break some assumptions, so branch now.
                 return(0);           */
         } else if (ROFF_COMMENT == tokens[tok].type)  
                 /* Ignore comment tokens. */  
                 return(1);  
   
         if ( ! roffargs(tok, buf, argv)) {          if ( ! (ROFFSec_PR_Dd & tree->asec)) {
                 warnx("%s: too many arguments to `%s' (line %zu)",                  assert(NULL == tree->last);
                                 tree->rbuf->name, toknames[tok],                  return(roffcall(tree, tok, argvp));
                                 tree->rbuf->line);          }
                 return(0);  
         }  
   
           /*
            * First check that our possible parents and parent's possible
            * children are satisfied.
            */
   
           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]));
   
         /*          /*
          * If this is a non-nestable layout token and we're below a           * Branch if we're not a layout token.
          * token of the same type, then recurse upward to the token,  
          * closing out the interim scopes.  
          *  
          * If there's a nested token on the chain, then raise an error  
          * as nested tokens have corresponding "ending" tokens and we're  
          * breaking their scope.  
          */           */
   
         node = NULL;          if (ROFF_LAYOUT != tokens[tok].type)
                   return(roffcall(tree, tok, argvp));
           if (0 == tokens[tok].ctx)
                   return(roffcall(tree, tok, argvp));
   
         if (ROFF_LAYOUT == tokens[tok].type &&          /*
                         ! (ROFF_NESTED & tokens[tok].flags)) {           * First consider implicit-end tags, like as follows:
                 for (node = tree->last; node; node = node->parent) {           *      .Sh SECTION 1
                         if (node->tok == tok)           *      .Sh SECTION 2
                                 break;           * 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.
            */
   
                         /* Don't break nested scope. */          if (tok == tokens[tok].ctx) {
                   /*
                    * First search up to the point where we must close.
                    * If one doesn't exist, then we can open a new scope.
                    */
   
                         if ( ! (ROFF_NESTED & tokens[node->tok].flags))                  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;                                  continue;
                         warnx("%s: scope of %s (line %zu) broken by "                          return(roff_err(tree, *argv, "`%s' breaks "
                                         "%s (line %zu)",                                                  "scope of prior`%s'",
                                         tree->rbuf->name,                                                  toknames[tok],
                                         toknames[tok], node->line,                                                  toknames[n->tok]));
                                         toknames[node->tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 }                  }
         }  
   
         if (node) {                  /*
                 assert(ROFF_LAYOUT == tokens[tok].type);                   * Create a new scope, as no previous one exists to
                 assert( ! (ROFF_NESTED & tokens[tok].flags));                   * close out.
                 assert(node->tok == tok);                   */
   
                 /* Clear up to last scoped token. */                  if (NULL == n)
                           return(roffcall(tree, tok, argvp));
   
                 /* LINTED */                  /*
                    * Close out all intermediary scoped blocks, then hang
                    * the current scope from our predecessor's parent.
                    */
   
                 do {                  do {
                         t = tree->last->tok;                          t = tree->last->tok;
                         if ( ! (*tokens[tree->last->tok].cb)                          if ( ! roffexit(tree, t))
                                         (tree->last->tok, tree, NULL, ROFF_EXIT))  
                                 return(0);                                  return(0);
                 } while (t != tok);                  } while (t != tok);
   
                   return(roffcall(tree, tok, argvp));
         }          }
   
         /* Proceed with actual token processing. */          /*
            * Now consider explicit-end tags, where we want to close back
            * to a specific tag.  Example:
            *      .Bl
            *      .It Item.
            *      .El
            * In this, the `El' tag closes out the scope of `Bl'.
            */
   
         argvp = (const char **)&argv[1];          assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);
         return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER));  
           /* LINTED */
           for (n = tree->last; n; n = n->parent)
                   if (n->tok != tokens[tok].ctx) {
                           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);
 }  }
   
   
Line 394  rofffindarg(const char *name)
Line 489  rofffindarg(const char *name)
   
   
 static int  static int
 rofffindtok(const char *name)  rofffindtok(const char *buf)
 {  {
         size_t           i;          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. */          /* FIXME: use a table, this is slow but ok for now. */
   
         /* LINTED */          /* LINTED */
         for (i = 0; i < ROFF_MAX; i++)          for (i = 0; i < ROFF_MAX; i++)
                 /* LINTED */                  /* LINTED */
                 if (0 == strncmp(name, toknames[i], 2))                  if (0 == strcmp(toknames[i], token))
                         return((int)i);                          return((int)i);
   
         return(ROFF_MAX);          return(ROFF_MAX);
 }  }
   
   
 static int  static int
   roffchecksec(struct rofftree *tree,
                   const char *start, int sec, int fail)
   {
   
           switch (sec) {
           case(ROFFSec_PR_Dd):
                   return(1);
           case(ROFFSec_PR_Dt):
                   if (ROFFSec_PR_Dd & tree->asec)
                           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)
   {
   
           if (0 == *p)
                   return(0);
           if (0 != *(p + 1))
                   return(0);
   
           switch (*p) {
           case('{'):
                   /* 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);
   }
   
   
   static int
 rofffindcallable(const char *name)  rofffindcallable(const char *name)
 {  {
         int              c;          int              c;
   
         if (ROFF_MAX == (c = rofffindtok(name)))          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);          return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);
 }  }
   
Line 426  roffnode_new(int tokid, struct rofftree *tree)
Line 659  roffnode_new(int tokid, struct rofftree *tree)
 {  {
         struct roffnode *p;          struct roffnode *p;
   
         if (NULL == (p = malloc(sizeof(struct roffnode)))) {          if (NULL == (p = malloc(sizeof(struct roffnode))))
                 warn("malloc");                  err(1, "malloc");
                 return(NULL);  
         }  
   
         p->line = tree->rbuf->line;  
         p->tok = tokid;          p->tok = tokid;
         p->parent = tree->last;          p->parent = tree->last;
         tree->last = p;          tree->last = p;
   
         return(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(int tokid, struct rofftree *tree)  roffnode_free(struct rofftree *tree)
 {  {
         struct roffnode *p;          struct roffnode *p;
   
         assert(tree->last);          assert(tree->last);
         assert(tree->last->tok == tokid);  
   
         p = tree->last;          p = tree->last;
         tree->last = tree->last->parent;          tree->last = tree->last->parent;
Line 453  roffnode_free(int tokid, struct rofftree *tree)
Line 699  roffnode_free(int tokid, struct rofftree *tree)
 }  }
   
   
   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;
                   if (ROFF_ATT_MAX != roff_att(*ordp))
                           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):
                   /* FALLTHROUGH*/
           case (ROFF_Fn):
                   if (0 != sz)
                           break;
                   return(roff_errp(tree, start, tok, ERR_ARGGE1));
   
           case (ROFF_Nm):
                   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):
                   /* FALLTHROUGH*/
           case (ROFF_Ex):
                   if (1 == sz)
                           break;
                   return(roff_errp(tree, start, tok, ERR_ARGEQ1));
   
           case (ROFF_Sm):
                   if (1 != sz)
                           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,
                                   argc, argv, (const char **)ordp));
   }
   
   
   static int
   roffexit(struct rofftree *tree, int tok)
   {
   
           assert(tokens[tok].cb);
           return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT));
   }
   
   
   static int
   roffcall(struct rofftree *tree, int tok, char **argv)
   {
           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));
   }
   
   
   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);
   }
   
   
   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
   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  int
 roff_Dd(ROFFCALL_ARGS)  roff_Dd(ROFFCALL_ARGS)
 {  {
           time_t           t;
           char            *p, buf[32];
           size_t           sz;
   
         if (ROFF_BODY & tree->state) {          if (ROFFSec_PR_Os & tree->asec)
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dd & tree->state);  
                 return(roff_text(tok, tree, argv, type));                  return(roff_text(tok, tree, argv, type));
         }          if (ROFFSec_PR_Dd & tree->asec)
                   return(roff_errp(tree, *argv, tok, ERR_PR_REP));
           if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dd, 1))
                   return(roff_errp(tree, *argv, tok, ERR_PR_OOO));
   
         assert(ROFF_PRELUDE & tree->state);          assert(NULL == tree->last);
         assert( ! (ROFF_BODY & tree->state));          argv++;
           tree->asec |= (tree->csec = ROFFSec_PR_Dd);
   
         if (ROFF_PRELUDE_Dd & tree->state ||          /*
                         ROFF_PRELUDE_Dt & tree->state) {           * This is a bit complex because there are many forms the date
                 warnx("%s: prelude `Dd' out-of-order (line %zu)",           * can be in:  it can be simply $Mdocdate$, $Mdocdate <date>$,
                                 tree->rbuf->name, tree->rbuf->line);           * or a raw date.  Process accordingly.
                 return(0);           */
   
           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));
         }          }
   
         /* TODO: parse date. */          argv++;
   
         assert(NULL == tree->last);          while (*argv && **argv != '$') {
         tree->state |= ROFF_PRELUDE_Dd;                  if (strlcat(buf, *argv++, sz) >= sz)
                           return(roff_errp(tree, p, tok, ERR_BADARG));
                   if (strlcat(buf, " ", sz) >= sz)
                           return(roff_errp(tree, p, tok, ERR_BADARG));
           }
   
           if (NULL == *argv)
                   return(roff_errp(tree, p, tok, ERR_BADARG));
           if (NULL == strptime(buf, "%b %d %Y", &tree->tm))
                   return(roff_errp(tree, p, tok, ERR_BADARG));
   
         return(1);          return(1);
 }  }
   
Line 487  roff_Dd(ROFFCALL_ARGS)
Line 984  roff_Dd(ROFFCALL_ARGS)
 static  int  static  int
 roff_Dt(ROFFCALL_ARGS)  roff_Dt(ROFFCALL_ARGS)
 {  {
           size_t           sz;
   
         if (ROFF_BODY & tree->state) {          if (ROFFSec_PR_Os & tree->asec)
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Dt & tree->state);  
                 return(roff_text(tok, tree, argv, type));                  return(roff_text(tok, tree, argv, type));
         }          if (ROFFSec_PR_Dt & tree->asec)
                   return(roff_errp(tree, *argv, tok, ERR_PR_REP));
           if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dt, 1))
                   return(roff_errp(tree, *argv, tok, ERR_PR_OOO));
   
         assert(ROFF_PRELUDE & tree->state);          argv++;
         assert( ! (ROFF_BODY & tree->state));          tree->asec |= (tree->csec = ROFFSec_PR_Dt);
           sz = sizeof(tree->title);
   
         if ( ! (ROFF_PRELUDE_Dd & tree->state) ||          if (NULL == *argv)
                         (ROFF_PRELUDE_Dt & tree->state)) {                  return(roff_errp(tree, *argv, tok, ERR_ARGGE2));
                 warnx("%s: prelude `Dt' out-of-order (line %zu)",          if (strlcpy(tree->title, *argv, sz) >= sz)
                                 tree->rbuf->name, tree->rbuf->line);                  return(roff_errp(tree, *argv, tok, ERR_ARGLEN));
                 return(0);  
         }  
   
         /* TODO: parse date. */          argv++;
           if (NULL == *argv)
                   return(roff_errp(tree, *argv, tok, ERR_ARGGE2));
   
           if (ROFF_MSEC_MAX == (tree->section = roff_msec(*argv)))
                   return(roff_errp(tree, *argv, tok, ERR_BADARG));
   
           argv++;
   
           if (NULL == *argv) {
                   switch (tree->section) {
                   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);          assert(NULL == tree->last);
         tree->state |= ROFF_PRELUDE_Dt;  
   
         return(1);          return(1);
 }  }
   
   
   static int
   roffsetname(struct rofftree *tree, char **ordp)
   {
           size_t           sz;
   
           assert(*ordp);
   
           /* FIXME: not all sections can set this. */
   
           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  int
 roff_Os(ROFFCALL_ARGS)  roff_Ns(ROFFCALL_ARGS)
 {  {
           int              j, c, first;
           char            *morep[1];
   
         if (ROFF_EXIT == type) {          first = (*argv++ == tree->cur);
                 assert(ROFF_PRELUDE_Os & tree->state);          morep[0] = NULL;
                 return(roff_layout(tok, tree, argv, type));  
         } else if (ROFF_BODY & tree->state) {  
                 assert( ! (ROFF_PRELUDE & tree->state));  
                 assert(ROFF_PRELUDE_Os & tree->state);  
                 return(roff_text(tok, tree, argv, type));  
         }  
   
         assert(ROFF_PRELUDE & tree->state);          if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||  
                         ! (ROFF_PRELUDE_Dd & tree->state)) {  
                 warnx("%s: prelude `Os' out-of-order (line %zu)",  
                                 tree->rbuf->name, tree->rbuf->line);  
                 return(0);                  return(0);
         }  
   
         /* TODO: extract OS. */          while (*argv) {
                   if (ROFF_MAX != (c = rofffindcallable(*argv))) {
                           if ( ! roffcall(tree, c, argv))
                                   return(0);
                           break;
                   }
   
         tree->state |= ROFF_PRELUDE_Os;                  if ( ! roffispunct(*argv)) {
         tree->state &= ~ROFF_PRELUDE;                          if ( ! roffdata(tree, 1, *argv++))
         tree->state |= ROFF_BODY;                                  return(0);
                           continue;
                   }
   
         assert(NULL == tree->last);                  for (j = 0; argv[j]; j++)
                           if ( ! roffispunct(argv[j]))
                                   break;
   
         return(roff_layout(tok, tree, argv, type));                  if (argv[j]) {
                           if ( ! roffdata(tree, 0, *argv++))
                                   return(0);
                           continue;
                   }
   
                   break;
           }
   
           if ( ! first)
                   return(1);
   
           return(roffpurgepunct(tree, argv));
 }  }
   
   
 /* ARGUSED */  /* ARGSUSED */
 static int  static  int
 roffnextopt(const char ***in, char **val)  roff_Os(ROFFCALL_ARGS)
 {  {
         const char      *arg, **argv;          char            *p;
         int              v;          size_t           sz;
   
         *val = NULL;          if (ROFFSec_PR_Os & tree->asec)
         argv = *in;                  return(roff_text(tok, tree, argv, type));
         assert(argv);          if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Os, 1))
                   return(roff_errp(tree, *argv, tok, ERR_PR_OOO));
   
         if (NULL == (arg = *argv))          p = *++argv;
                 return(-1);          sz = sizeof(tree->os);
         if ('-' != *arg)          tree->asec |= (tree->csec = ROFFSec_PR_Os);
                 return(-1);  
         if (ROFF_ARGMAX == (v = rofffindarg(&arg[1])))  
                 return(-1);  
         if ( ! (ROFF_VALUE & tokenargs[v].flags))  
                 return(v);  
   
         *in = ++argv;          tree->os[0] = 0;
   
         /* FIXME: what if this looks like a roff token or argument? */          while (*argv)
                   if (strlcat(tree->os, *argv++, sz) >= sz)
                           return(roff_errp(tree, p, tok, ERR_ARGLEN));
   
         return(*argv ? v : ROFF_ARGMAX);          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));
 }  }
   
   
Line 579  roffnextopt(const char ***in, char **val)
Line 1165  roffnextopt(const char ***in, char **val)
 static int  static int
 roff_layout(ROFFCALL_ARGS)  roff_layout(ROFFCALL_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];          int              i, c, argcp[ROFF_MAXLINEARG];
         char            *v, *argvp[ROFF_MAXARG];          char            *argvp[ROFF_MAXLINEARG];
   
         if (ROFF_PRELUDE & tree->state) {          /*
                 warnx("%s: macro `%s' called in prelude (line %zu)",           * The roff_layout function is for multi-line macros.  A layout
                                 tree->rbuf->name, toknames[tok],           * has a start and end point, which is either declared
                                 tree->rbuf->line);           * explicitly or implicitly.  An explicit start and end is
                 return(0);           * 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 ( ! ROFFSec_NAME & tree->asec)
                   return(roff_errp(tree, *argv, tok, ERR_NOT_PR));
   
         if (ROFF_EXIT == type) {          if (ROFF_EXIT == type) {
                 roffnode_free(tok, tree);                  roffnode_free(tree);
                 return((*tree->roffblkout)(tok));                  if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))
                           return(0);
                   return((*tree->cb.roffblkout)(tree->arg, tok));
         }          }
   
         i = 0;          argv++;
         while (-1 != (c = roffnextopt(&argv, &v))) {          assert( ! (ROFF_CALLABLE & tokens[tok].flags));
                 if (ROFF_ARGMAX == c) {  
                         warnx("%s: error parsing `%s' args (line %zu)",  
                                         tree->rbuf->name,  
                                         toknames[tok],  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
                 argcp[i] = c;  
                 argvp[i] = v;  
                 argv++;  
         }  
   
           if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
                   return(0);
         if (NULL == roffnode_new(tok, tree))          if (NULL == roffnode_new(tok, tree))
                 return(0);                  return(0);
   
         if ( ! (*tree->roffin)(tok, argcp, argvp))          /*
            * 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);                  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;
                   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
            * into the layout header and exit.
            */
   
         if ( ! (ROFF_PARSED & tokens[tok].flags)) {          if ( ! (ROFF_PARSED & tokens[tok].flags)) {
                 /* TODO: print all tokens. */                  i = 0;
                   while (*argv)
                           if ( ! roffdata(tree, i++, *argv++))
                                   return(0);
   
                 if ( ! ((*tree->roffout)(tok)))                  if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
                         return(0);                          return(0);
                 return((*tree->roffblkin)(tok));                  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) {          while (*argv) {
                 if (2 >= strlen(*argv) && ROFF_MAX !=                  if (ROFF_MAX == (c = rofffindcallable(*argv))) {
                                 (c = rofffindcallable(*argv)))                          assert(tree->arg);
                         if ( ! (*tokens[c].cb)(c, tree,                          if ( ! roffdata(tree, i++, *argv++))
                                                 argv + 1, ROFF_ENTER))  
                                 return(0);                                  return(0);
                           continue;
                   }
                   if ( ! roffcall(tree, c, argv))
                           return(0);
                   break;
           }
   
                 /* TODO: print token. */          /*
                 argv++;           * 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));
         }          }
   
         if ( ! ((*tree->roffout)(tok)))          /*
                 return(0);           * Expensive.  Scan to the end of line then work backwards until
            * a token isn't punctuation.
            */
   
         return((*tree->roffblkin)(tok));          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 int
 roff_text(ROFFCALL_ARGS)  roff_ordered(ROFFCALL_ARGS)
 {  {
         int              i, c, argcp[ROFF_MAXARG];          int              i, first, c, argcp[ROFF_MAXLINEARG];
         char            *v, *argvp[ROFF_MAXARG];          char            *ordp[ROFF_MAXLINEARG], *p,
                           *argvp[ROFF_MAXLINEARG];
   
         if (ROFF_PRELUDE & tree->state) {          /*
                 warnx("%s: macro `%s' called in prelude (line %zu)",           * Ordered macros pass their arguments directly to handlers,
                                 tree->rbuf->name, toknames[tok],           * instead of considering it free-form text.  Thus, the
                                 tree->rbuf->line);           * following macro looks as follows:
            *
            * .Xr foo 1 ) ,
            *
            * .Xr arg1 arg2 punctuation
            */
   
           if ( ! ROFFSec_NAME & 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);                  return(0);
         }  
   
           if (NULL == *argv)
                   return(roffspecial(tree, tok, p, argcp,
                                           (const char **)argvp, 0, ordp));
   
         i = 0;          i = 0;
         while (-1 != (c = roffnextopt(&argv, &v))) {          while (*argv && i < ROFF_MAXLINEARG) {
                 if (ROFF_ARGMAX == c) {                  c = ROFF_PARSED & tokens[tok].flags ?
                         warnx("%s: error parsing `%s' args (line %zu)",                          rofffindcallable(*argv) : ROFF_MAX;
                                         tree->rbuf->name,  
                                         toknames[tok],                  if (ROFF_MAX == c && ! roffispunct(*argv)) {
                                         tree->rbuf->line);                          ordp[i++] = *argv++;
                         return(0);                          continue;
                 }                  }
                 argcp[i] = c;                  ordp[i] = NULL;
                 argvp[i] = v;  
                 argv++;                  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));
         }          }
   
         if ( ! (*tree->roffin)(tok, argcp, argvp))          assert(i != ROFF_MAXLINEARG);
           ordp[i] = NULL;
   
           if ( ! roffspecial(tree, tok, p, argcp,
                                   (const char**)argvp,
                                   (size_t)i, ordp))
                 return(0);                  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
            * arguments are instead flushed as pure data: we're only
            * concerned with the macro and its arguments.  Example:
            *
            * .Fl v W f ;
            *
            * ...Produces...
            *
            * <fl> v W f </fl> ;
            */
   
           if ( ! ROFFSec_NAME & tree->asec)
                   return(roff_errp(tree, *argv, tok, ERR_NOT_PR));
   
           first = (*argv == tree->cur);
           argv++;
   
           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)) {          if ( ! (ROFF_PARSED & tokens[tok].flags)) {
                 /* TODO: print all tokens. */                  i = 0;
                 return((*tree->roffout)(tok));                  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
            * terminating punctuation.  If we encounter it and all
            * 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;
         while (*argv) {          while (*argv) {
                 if (2 >= strlen(*argv) && ROFF_MAX !=                  if (ROFF_MAX != (c = rofffindcallable(*argv))) {
                                 (c = rofffindcallable(*argv)))                          if ( ! (ROFF_LSCOPE & tokens[tok].flags))
                         if ( ! (*tokens[c].cb)(c, tree,                                  if ( ! (*tree->cb.roffout)(tree->arg, tok))
                                                 argv + 1, ROFF_ENTER))                                          return(0);
   
                           if ( ! roffcall(tree, c, argv))
                                 return(0);                                  return(0);
                           if (ROFF_LSCOPE & tokens[tok].flags)
                                   if ( ! (*tree->cb.roffout)(tree->arg, tok))
                                           return(0);
                           break;
                   }
   
                 /* TODO: print token. */                  if ( ! roffispunct(*argv)) {
                 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;
         }          }
   
         return((*tree->roffout)(tok));          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)
   {
   
           return(roff_errp(tree, *argv, tok, ERR_DEPREC));
   }
   
   
   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.4  
changed lines
  Added in v.1.61
CVSweb