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

Diff for /mandoc/roff.c between version 1.1 and 1.90

version 1.1, 2008/11/24 14:24:55 version 1.90, 2010/06/27 15:52:41
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
   #include <errno.h>
 #include <ctype.h>  #include <ctype.h>
 #include <err.h>  #include <limits.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <stdio.h>
   
 #include "libmdocml.h"  #include "mandoc.h"
 #include "private.h"  #include "regs.h"
   #include "roff.h"
   
 #define ROFF_MAXARG       10  #define RSTACK_MAX      128
   
 enum    roffd {  #define ROFF_CTL(c) \
         ROFF_ENTER = 0,          ('.' == (c) || '\'' == (c))
         ROFF_EXIT  
 };  
   
 enum    rofftype {  #if 1
         ROFF_TITLE,  #define ROFF_DEBUG(fmt, args...) \
         ROFF_COMMENT,          do { /* Nothing. */ } while (/*CONSTCOND*/ 0)
         ROFF_TEXT,  #else
         ROFF_LAYOUT  #define ROFF_DEBUG(fmt, args...) \
           do { fprintf(stderr, fmt , ##args); } while (/*CONSTCOND*/ 0)
   #endif
   
   enum    rofft {
           ROFF_am,
           ROFF_ami,
           ROFF_am1,
           ROFF_de,
           ROFF_dei,
           ROFF_de1,
           ROFF_ds,
           ROFF_el,
           ROFF_ie,
           ROFF_if,
           ROFF_ig,
           ROFF_rm,
           ROFF_tr,
           ROFF_cblock,
           ROFF_ccond,
           ROFF_nr,
           ROFF_MAX
 };  };
   
 #define ROFFCALL_ARGS \  enum    roffrule {
         struct rofftree *tree, const char *argv[], enum roffd type          ROFFRULE_ALLOW,
           ROFFRULE_DENY
 struct  rofftree;  
   
 struct  rofftok {  
         char             *name;  
         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 {  struct  roff {
         char             *name;          struct roffnode *last; /* leaf of stack */
         int               flags;          mandocmsg        msg; /* err/warn/fatal messages */
 #define ROFF_VALUE       (1 << 0)          void            *data; /* privdata for messages */
           enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
           int              rstackpos; /* position in rstack */
           struct regset   *regs; /* read/writable registers */
 };  };
   
 struct  roffnode {  struct  roffnode {
         int               tok;          enum rofft       tok; /* type of node */
         struct roffnode  *parent;          struct roffnode *parent; /* up one in stack */
         size_t            line;          int              line; /* parse line */
           int              col; /* parse col */
           char            *end; /* end-rules: custom token */
           int              endspan; /* end-rules: next-line or infty */
           enum roffrule    rule; /* current evaluation rule */
 };  };
   
 struct  rofftree {  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
         struct roffnode  *last;                           enum rofft tok, /* tok of macro */ \
         time_t            date;                           char **bufp, /* input buffer */ \
         char              title[256];                           size_t *szp, /* size of input buffer */ \
         char              section[256];                           int ln, /* parse line */ \
         char              volume[256];                           int ppos, /* original pos in buffer */ \
         int               state;                           int pos, /* current pos in buffer */ \
 #define ROFF_PRELUDE     (1 << 1)                           int *offs /* reset offset of buffer data */
 #define ROFF_PRELUDE_Os  (1 << 2)  
 #define ROFF_PRELUDE_Dt  (1 << 3)  
 #define ROFF_PRELUDE_Dd  (1 << 4)  
 #define ROFF_BODY        (1 << 5)  
         struct md_mbuf  *mbuf; /* NULL if ROFF_EXIT and error. */  
   
         const struct md_args    *args;  typedef enum rofferr (*roffproc)(ROFF_ARGS);
         const struct md_rbuf    *rbuf;  
   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 */
           struct roffmac  *next;
 };  };
   
 #define ROFF___           0  static  enum rofferr     roff_block(ROFF_ARGS);
 #define ROFF_Dd           1  static  enum rofferr     roff_block_text(ROFF_ARGS);
 #define ROFF_Dt           2  static  enum rofferr     roff_block_sub(ROFF_ARGS);
 #define ROFF_Os           3  static  enum rofferr     roff_cblock(ROFF_ARGS);
 #define ROFF_Sh           4  static  enum rofferr     roff_ccond(ROFF_ARGS);
 #define ROFF_An           5  static  enum rofferr     roff_cond(ROFF_ARGS);
 #define ROFF_Li           6  static  enum rofferr     roff_cond_text(ROFF_ARGS);
 #define ROFF_MAX          7  static  enum rofferr     roff_cond_sub(ROFF_ARGS);
   static  enum rofferr     roff_line(ROFF_ARGS);
   static  enum rofferr     roff_nr(ROFF_ARGS);
   static  enum roffrule    roff_evalcond(const char *, int *);
   
 static  int               roff_Dd(ROFFCALL_ARGS);  /* See roff_hash_find() */
 static  int               roff_Dt(ROFFCALL_ARGS);  
 static  int               roff_Os(ROFFCALL_ARGS);  
 static  int               roff_Sh(ROFFCALL_ARGS);  
 static  int               roff_An(ROFFCALL_ARGS);  
 static  int               roff_Li(ROFFCALL_ARGS);  
   
 static  struct roffnode  *roffnode_new(int, size_t,  #define ASCII_HI         126
                                 struct rofftree *);  #define ASCII_LO         33
 static  void              roffnode_free(int, struct rofftree *);  #define HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
   
 static  int               rofffindtok(const char *);  static  struct roffmac  *hash[HASHWIDTH];
 static  int               rofffindarg(const char *);  
 static  int               roffargs(int, char *, char **);  
 static  int               roffparse(struct rofftree *, char *, size_t);  
 static  int               textparse(const struct rofftree *,  
                                 const char *, size_t);  
   
 static  void              dbg_enter(const struct md_args *, int);  static  struct roffmac   roffs[ROFF_MAX] = {
 static  void              dbg_leave(const struct md_args *, int);          { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
 static const struct rofftok tokens[ROFF_MAX] = {          { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
         { "\\\"",    NULL, ROFF_COMMENT, 0 },          { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
         {   "Dd", roff_Dd, ROFF_TITLE, 0 },          { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
         {   "Dt", roff_Dt, ROFF_TITLE, 0 },          { "ds", roff_line, NULL, NULL, 0, NULL },
         {   "Os", roff_Os, ROFF_TITLE, 0 },          { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
         {   "Sh", roff_Sh, ROFF_LAYOUT, 0 },          { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
         {   "An", roff_An, ROFF_TEXT, ROFF_PARSED },          { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
         {   "Li", roff_Li, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE },          { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
           { "rm", roff_line, NULL, NULL, 0, NULL },
           { "tr", roff_line, NULL, NULL, 0, NULL },
           { ".", roff_cblock, NULL, NULL, 0, NULL },
           { "\\}", roff_ccond, NULL, NULL, 0, NULL },
           { "nr", roff_nr, NULL, NULL, 0, NULL },
 };  };
   
 #define ROFF_Split        0  static  void             roff_free1(struct roff *);
 #define ROFF_Nosplit      1  static  enum rofft       roff_hash_find(const char *);
 #define ROFF_ARGMAX       2  static  void             roff_hash_init(void);
   static  void             roffnode_cleanscope(struct roff *);
   static  int              roffnode_push(struct roff *,
                                   enum rofft, int, int);
   static  void             roffnode_pop(struct roff *);
   static  enum rofft       roff_parse(const char *, int *);
   static  int              roff_parse_nat(const char *, int *);
   
 static const struct roffarg tokenargs[ROFF_ARGMAX] = {  /* See roff_hash_find() */
         {  "split",     0 },  #define ROFF_HASH(p)    (p[0] - ASCII_LO)
         {  "nosplit",   0 },  
 };  
   
   static void
 int  roff_hash_init(void)
 roff_free(struct rofftree *tree, int flush)  
 {  {
         int              error;          struct roffmac   *n;
           int               buc, i;
   
         assert(tree->mbuf);          for (i = 0; i < (int)ROFF_MAX; i++) {
         if ( ! flush)                  assert(roffs[i].name[0] >= ASCII_LO);
                 tree->mbuf = NULL;                  assert(roffs[i].name[0] <= ASCII_HI);
   
         /* LINTED */                  buc = ROFF_HASH(roffs[i].name);
         while (tree->last)  
                 if ( ! (*tokens[tree->last->tok].cb)  
                                 (tree, NULL, ROFF_EXIT))  
                         /* Disallow flushing. */  
                         tree->mbuf = NULL;  
   
         error = tree->mbuf ? 0 : 1;                  if (NULL != (n = hash[buc])) {
                           for ( ; n->next; n = n->next)
         if (tree->mbuf && (ROFF_PRELUDE & tree->state)) {                                  /* Do nothing. */ ;
                 warnx("%s: prelude never finished",                          n->next = &roffs[i];
                                 tree->rbuf->name);                  } else
                 error = 1;                          hash[buc] = &roffs[i];
         }          }
   
         free(tree);  
         return(error ? 0 : 1);  
 }  }
   
   
 struct rofftree *  /*
 roff_alloc(const struct md_args *args, struct md_mbuf *out,   * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
                 const struct md_rbuf *in)   * the nil-terminated string name could be found.
    */
   static enum rofft
   roff_hash_find(const char *p)
 {  {
         struct rofftree *tree;          int              buc;
           struct roffmac  *n;
   
         if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) {          /*
                 warn("malloc");           * libroff has an extremely simple hashtable, for the time
                 return(NULL);           * being, which simply keys on the first character, which must
         }           * be printable, then walks a chain.  It works well enough until
            * optimised.
            */
   
         tree->state = ROFF_PRELUDE;          if (p[0] < ASCII_LO || p[0] > ASCII_HI)
         tree->args = args;                  return(ROFF_MAX);
         tree->mbuf = out;  
         tree->rbuf = in;  
   
         return(tree);          buc = ROFF_HASH(p);
   
           if (NULL == (n = hash[buc]))
                   return(ROFF_MAX);
           for ( ; n; n = n->next)
                   if (0 == strcmp(n->name, p))
                           return((enum rofft)(n - roffs));
   
           return(ROFF_MAX);
 }  }
   
   
 int  /*
 roff_engine(struct rofftree *tree, char *buf, size_t sz)   * Pop the current node off of the stack of roff instructions currently
    * pending.
    */
   static void
   roffnode_pop(struct roff *r)
 {  {
           struct roffnode *p;
   
         if (0 == sz) {          assert(r->last);
                 warnx("%s: blank line (line %zu)",          p = r->last;
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         } else if ('.' != *buf)  
                 return(textparse(tree, buf, sz));  
   
         return(roffparse(tree, buf, sz));          if (ROFF_el == p->tok)
                   if (r->rstackpos > -1)
                           r->rstackpos--;
   
           r->last = r->last->parent;
           if (p->end)
                   free(p->end);
           free(p);
 }  }
   
   
   /*
    * Push a roff node onto the instruction stack.  This must later be
    * removed with roffnode_pop().
    */
 static int  static int
 textparse(const struct rofftree *tree, const char *buf, size_t sz)  roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {  {
           struct roffnode *p;
         if (NULL == tree->last) {  
                 warnx("%s: unexpected text (line %zu)",          if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
                                 tree->rbuf->name,                  (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
                                 tree->rbuf->line);  
                 return(0);                  return(0);
         } else if (NULL == tree->last->parent) {  
                 warnx("%s: disallowed text (line %zu)",  
                                 tree->rbuf->name,  
                                 tree->rbuf->line);  
                 return(0);  
         }          }
   
         /* Print text. */          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(int tok, char *buf, char **argv)  roff_free1(struct roff *r)
 {  {
         int              i;  
   
         (void)tok;/* FIXME: quotable strings? */          while (r->last)
                   roffnode_pop(r);
   }
   
         assert(tok >= 0 && tok < ROFF_MAX);  
         assert('.' == *buf);  
   
         /* LINTED */  void
         for (i = 0; *buf && i < ROFF_MAXARG; i++) {  roff_reset(struct roff *r)
                 argv[i] = buf++;  {
                 while (*buf && ! isspace(*buf))  
                         buf++;  
                 if (0 == *buf) {  
                         continue;  
                 }  
                 *buf++ = 0;  
                 while (*buf && isspace(*buf))  
                         buf++;  
         }  
   
         assert(i > 0);  
         if (i < ROFF_MAXARG)  
                 argv[i] = NULL;  
   
         return(ROFF_MAXARG > i);          roff_free1(r);
 }  }
   
   
 static int  void
 roffparse(struct rofftree *tree, char *buf, size_t sz)  roff_free(struct roff *r)
 {  {
         int               tok, t;  
         struct roffnode  *node;  
         char             *argv[ROFF_MAXARG];  
         const char      **argvp;  
   
         assert(sz > 0);          roff_free1(r);
           free(r);
   }
   
         /*  
          * Extract the token identifier from the buffer.  If there's no  
          * callback for the token (comment, etc.) then exit immediately.  
          * We don't do any error handling (yet), so if the token doesn't  
          * exist, die.  
          */  
   
         if (3 > sz) {  struct roff *
                 warnx("%s: malformed line (line %zu)",  roff_alloc(struct regset *regs, const mandocmsg msg, void *data)
                                 tree->rbuf->name,  {
                                 tree->rbuf->line);          struct roff     *r;
   
           if (NULL == (r = calloc(1, sizeof(struct roff)))) {
                   (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
                 return(0);                  return(0);
         } else if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {  
                 warnx("%s: unknown line token `%c%c' (line %zu)",  
                                 tree->rbuf->name,  
                                 *(buf + 1), *(buf + 2),  
                                 tree->rbuf->line);  
                 return(0);  
         } else if (ROFF_COMMENT == tokens[tok].type)  
                 /* Ignore comment tokens. */  
                 return(1);  
   
         if ( ! roffargs(tok, buf, argv)) {  
                 warnx("%s: too many arguments to `%s' (line %zu)",  
                                 tree->rbuf->name, tokens[tok].name,  
                                 tree->rbuf->line);  
                 return(0);  
         }          }
   
         /* Domain cross-contamination (and sanity) checks. */          r->regs = regs;
           r->msg = msg;
           r->data = data;
           r->rstackpos = -1;
   
           roff_hash_init();
           return(r);
   }
   
         switch (tokens[tok].type) {  
         case (ROFF_TITLE):  
                 if (ROFF_PRELUDE & tree->state) {  
                         assert( ! (ROFF_BODY & tree->state));  
                         break;  
                 }  
                 assert(ROFF_BODY & tree->state);  
                 warnx("%s: prelude token `%s' in body (line %zu)",  
                                 tree->rbuf->name, tokens[tok].name,  
                                 tree->rbuf->line);  
                 return(0);  
         case (ROFF_LAYOUT):  
                 /* FALLTHROUGH */  
         case (ROFF_TEXT):  
                 if (ROFF_BODY & tree->state) {  
                         assert( ! (ROFF_PRELUDE & tree->state));  
                         break;  
                 }  
                 assert(ROFF_PRELUDE & tree->state);  
                 warnx("%s: body token `%s' in prelude (line %zu)",  
                                 tree->rbuf->name, tokens[tok].name,  
                                 tree->rbuf->line);  
                 return(0);  
         case (ROFF_COMMENT):  
                 return(1);  
         default:  
                 abort();  
         }  
   
   enum rofferr
   roff_parseln(struct roff *r, int ln, char **bufp,
                   size_t *szp, int pos, int *offs)
   {
           enum rofft       t;
           int              ppos;
   
         /*          /*
          * If this is a non-nestable layout token and we're below a           * First, if a scope is open and we're not a macro, pass the
          * token of the same type, then recurse upward to the token,           * text through the macro's filter.  If a scope isn't open and
          * closing out the interim scopes.           * we're not a macro, just let it through.
          *  
          * 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 (r->last && ! ROFF_CTL((*bufp)[pos])) {
                   t = r->last->tok;
                   assert(roffs[t].text);
                   ROFF_DEBUG("roff: intercept scoped text: %s, [%s]\n",
                                   roffs[t].name, &(*bufp)[pos]);
                   return((*roffs[t].text)
                                   (r, t, bufp, szp,
                                    ln, pos, pos, offs));
           } else if ( ! ROFF_CTL((*bufp)[pos])) {
                   ROFF_DEBUG("roff: pass non-scoped text: [%s]\n",
                                   &(*bufp)[pos]);
                   return(ROFF_CONT);
           }
   
         if (ROFF_LAYOUT == tokens[tok].type &&          /*
                         ! (ROFF_NESTED & tokens[tok].flags)) {           * If a scope is open, go to the child handler for that macro,
                 for (node = tree->last; node; node = node->parent) {           * as it may want to preprocess before doing anything with it.
                         if (node->tok == tok)           */
                                 break;  
   
                         /* Don't break nested scope. */          if (r->last) {
                   t = r->last->tok;
                         if ( ! (ROFF_NESTED & tokens[node->tok].flags))                  assert(roffs[t].sub);
                                 continue;                  ROFF_DEBUG("roff: intercept scoped context: %s\n",
                         warnx("%s: scope of %s (line %zu) broken by "                                  roffs[t].name);
                                         "%s (line %zu)",                  return((*roffs[t].sub)
                                         tree->rbuf->name,                                  (r, t, bufp, szp,
                                         tokens[tok].name,                                   ln, pos, pos, offs));
                                         node->line,  
                                         tokens[node->tok].name,  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
         }          }
   
         if (node) {          /*
                 assert(ROFF_LAYOUT == tokens[tok].type);           * Lastly, as we've no scope open, try to look up and execute
                 assert( ! (ROFF_NESTED & tokens[tok].flags));           * the new macro.  If no macro is found, simply return and let
                 assert(node->tok == tok);           * the compilers handle it.
            */
   
                 /* Clear up to last scoped token. */          ppos = pos;
           if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) {
                 /* LINTED */                  ROFF_DEBUG("roff: pass non-scoped non-macro: [%s]\n",
                 do {                                  &(*bufp)[pos]);
                         t = tree->last->tok;                  return(ROFF_CONT);
                         if ( ! (*tokens[tree->last->tok].cb)  
                                         (tree, NULL, ROFF_EXIT))  
                                 return(0);  
                 } while (t != tok);  
         }          }
   
         /* Proceed with actual token processing. */          ROFF_DEBUG("roff: intercept new-scope: %s, [%s]\n",
                           roffs[t].name, &(*bufp)[pos]);
         argvp = (const char **)&argv[1];          assert(roffs[t].proc);
         return((*tokens[tok].cb)(tree, argvp, ROFF_ENTER));          return((*roffs[t].proc)
                           (r, t, bufp, szp,
                            ln, ppos, pos, offs));
 }  }
   
   
 static int  int
 rofffindarg(const char *name)  roff_endparse(struct roff *r)
 {  {
         size_t           i;  
   
         /* FIXME: use a table, this is slow but ok for now. */          if (NULL == r->last)
                   return(1);
         /* LINTED */          return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
         for (i = 0; i < ROFF_ARGMAX; i++)                                  r->last->col, NULL));
                 /* LINTED */  
                 if (0 == strcmp(name, tokenargs[i].name))  
                         return((int)i);  
   
         return(ROFF_ARGMAX);  
 }  }
   
   
 static int  /*
 rofffindtok(const char *name)   * 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)
 {  {
         size_t           i;          int              j;
           char             mac[5];
           enum rofft       t;
   
         /* FIXME: use a table, this is slow but ok for now. */          assert(ROFF_CTL(buf[*pos]));
           (*pos)++;
   
         /* LINTED */          while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
         for (i = 0; i < ROFF_MAX; i++)                  (*pos)++;
                 /* LINTED */  
                 if (0 == strncmp(name, tokens[i].name, 2))  
                         return((int)i);  
   
         return(ROFF_MAX);  
 }  
   
           if ('\0' == buf[*pos])
                   return(ROFF_MAX);
   
 /* FIXME: accept only struct rofftree *. */          for (j = 0; j < 4; j++, (*pos)++)
 static struct roffnode *                  if ('\0' == (mac[j] = buf[*pos]))
 roffnode_new(int tokid, size_t line, struct rofftree *tree)                          break;
 {                  else if (' ' == buf[*pos] || (j && '\\' == buf[*pos]))
         struct roffnode *p;                          break;
   
         if (NULL == (p = malloc(sizeof(struct roffnode)))) {  
                 warn("malloc");  
                 return(NULL);  
         }  
   
         p->line = line;          if (j == 4 || j < 1)
         p->tok = tokid;                  return(ROFF_MAX);
         p->parent = tree->last;  
         tree->last = p;  
         return(p);  
 }  
   
           mac[j] = '\0';
   
 static void          if (ROFF_MAX == (t = roff_hash_find(mac)))
 roffnode_free(int tokid, struct rofftree *tree)                  return(t);
 {  
         struct roffnode *p;  
   
         assert(tree->last);          while (buf[*pos] && ' ' == buf[*pos])
         assert(tree->last->tok == tokid);                  (*pos)++;
   
         p = tree->last;          return(t);
         tree->last = tree->last->parent;  
         free(p);  
 }  }
   
   
 static int dbg_lvl = 0;  static int
   roff_parse_nat(const char *buf, int *res)
   {
           char            *ep;
           long             lval;
   
           errno = 0;
           lval = strtol(buf, &ep, 10);
           if (buf[0] == '\0' || *ep != '\0')
                   return(0);
           if ((errno == ERANGE &&
                           (lval == LONG_MAX || lval == LONG_MIN)) ||
                           (lval > INT_MAX || lval <= 0))
                   return(0);
   
 static void          *res = (int)lval;
 dbg_enter(const struct md_args *args, int tokid)          return(1);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_cblock(ROFF_ARGS)
 {  {
         int              i;  
         static char      buf[72];  
   
         assert(args);          /*
         if ( ! (args->dbg & MD_DBG_TREE))           * A block-close `..' should only be invoked as a child of an
                 return;           * ignore macro, otherwise raise a warning and just ignore it.
         assert(tokid >= 0 && tokid <= ROFF_MAX);           */
   
         buf[0] = buf[71] = 0;          if (NULL == r->last) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         switch (tokens[tokid].type) {          switch (r->last->tok) {
         case (ROFF_LAYOUT):          case (ROFF_am):
                 (void)strncat(buf, "[body-layout] ", sizeof(buf) - 1);                  /* FALLTHROUGH */
           case (ROFF_ami):
                   /* FALLTHROUGH */
           case (ROFF_am1):
                   /* FALLTHROUGH */
           case (ROFF_de):
                   /* FALLTHROUGH */
           case (ROFF_dei):
                   /* FALLTHROUGH */
           case (ROFF_de1):
                   /* FALLTHROUGH */
           case (ROFF_ig):
                 break;                  break;
         case (ROFF_TEXT):  
                 (void)strncat(buf, "[  body-text] ", sizeof(buf) - 1);  
                 break;  
         case (ROFF_TITLE):  
                 (void)strncat(buf, "[    prelude] ", sizeof(buf) - 1);  
                 break;  
         default:          default:
                 abort();                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         /* LINTED */          if ((*bufp)[pos])
         for (i = 0; i < dbg_lvl; i++)                  if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                 (void)strncat(buf, "  ", sizeof(buf) - 1);                          return(ROFF_ERR);
   
         (void)strncat(buf, tokens[tokid].name, sizeof(buf) - 1);          roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   
         (void)printf("%s\n", buf);  
   
         dbg_lvl++;  
 }  }
   
   
 /* FIXME: accept only struct rofftree *. */  
 static void  static void
 dbg_leave(const struct md_args *args, int tokid)  roffnode_cleanscope(struct roff *r)
 {  {
         assert(args);  
         if ( ! (args->dbg & MD_DBG_TREE))  
                 return;  
   
         assert(tokid >= 0 && tokid <= ROFF_MAX);          while (r->last) {
         assert(dbg_lvl > 0);                  if (--r->last->endspan < 0)
         dbg_lvl--;                          break;
                   roffnode_pop(r);
           }
 }  }
   
   
 /* FIXME: accept only struct rofftree *. */  
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Dd(ROFFCALL_ARGS)  roff_ccond(ROFF_ARGS)
 {  {
   
         dbg_enter(tree->args, ROFF_Dd);          if (NULL == r->last) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         assert(ROFF_PRELUDE & tree->state);          switch (r->last->tok) {
         if (ROFF_PRELUDE_Dt & tree->state ||          case (ROFF_el):
                         ROFF_PRELUDE_Dd & tree->state) {                  /* FALLTHROUGH */
                 warnx("%s: prelude `Dd' out-of-order (line %zu)",          case (ROFF_ie):
                                 tree->rbuf->name, tree->rbuf->line);                  /* FALLTHROUGH */
                 return(0);          case (ROFF_if):
                   break;
           default:
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
         }          }
   
         assert(NULL == tree->last);          if (r->last->endspan > -1) {
         tree->state |= ROFF_PRELUDE_Dd;                  if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         dbg_leave(tree->args, ROFF_Dd);          if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
         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)
 {  {
           int             sv;
           size_t          sz;
   
         dbg_enter(tree->args, ROFF_Dt);          if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
                   if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           } else if (ROFF_ig != tok) {
                   while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                           pos++;
                   while (' ' == (*bufp)[pos])
                           pos++;
           }
   
         assert(ROFF_PRELUDE & tree->state);          if ( ! roffnode_push(r, tok, ln, ppos))
         if ( ! (ROFF_PRELUDE_Dd & tree->state) ||                  return(ROFF_ERR);
                         (ROFF_PRELUDE_Dt & tree->state)) {  
                 warnx("%s: prelude `Dt' out-of-order (line %zu)",          if ('\0' == (*bufp)[pos])
                                 tree->rbuf->name, tree->rbuf->line);                  return(ROFF_IGN);
                 return(0);  
           sv = pos;
           while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
                           '\t' != (*bufp)[pos])
                   pos++;
   
           /*
            * Note: groff does NOT like escape characters in the input.
            * Instead of detecting this, we're just going to let it fly and
            * to hell with it.
            */
   
           assert(pos > sv);
           sz = (size_t)(pos - sv);
   
           if (1 == sz && '.' == (*bufp)[sv])
                   return(ROFF_IGN);
   
           r->last->end = malloc(sz + 1);
   
           if (NULL == r->last->end) {
                   (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
                   return(ROFF_ERR);
         }          }
   
         assert(NULL == tree->last);          memcpy(r->last->end, *bufp + sv, sz);
         tree->state |= ROFF_PRELUDE_Dt;          r->last->end[(int)sz] = '\0';
   
         dbg_leave(tree->args, ROFF_Dt);          if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
         return(1);          return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static  int  static enum rofferr
 roff_Os(ROFFCALL_ARGS)  roff_block_sub(ROFF_ARGS)
 {  {
           enum rofft      t;
           int             i, j;
   
         if (ROFF_EXIT == type) {          /*
                 roffnode_free(ROFF_Os, tree);           * First check whether a custom macro exists at this level.  If
                 dbg_leave(tree->args, ROFF_Os);           * it does, then check against it.  This is some of groff's
                 return(1);           * stranger behaviours.  If we encountered a custom end-scope
         }           * tag and that tag also happens to be a "real" macro, then we
            * need to try interpreting it again as a real macro.  If it's
            * not, then return ignore.  Else continue.
            */
   
         dbg_enter(tree->args, ROFF_Os);          if (r->last->end) {
                   i = pos + 1;
                   while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                           i++;
   
         assert(ROFF_PRELUDE & tree->state);                  for (j = 0; r->last->end[j]; j++, i++)
         if ( ! (ROFF_PRELUDE_Dt & tree->state) ||                          if ((*bufp)[i] != r->last->end[j])
                         ! (ROFF_PRELUDE_Dd & tree->state)) {                                  break;
                 warnx("%s: prelude `Os' out-of-order (line %zu)",  
                                 tree->rbuf->name, tree->rbuf->line);                  if ('\0' == r->last->end[j] &&
                 return(0);                                  ('\0' == (*bufp)[i] ||
                                    ' ' == (*bufp)[i] ||
                                    '\t' == (*bufp)[i])) {
                           roffnode_pop(r);
                           roffnode_cleanscope(r);
   
                           if (ROFF_MAX != roff_parse(*bufp, &pos))
                                   return(ROFF_RERUN);
                           return(ROFF_IGN);
                   }
         }          }
   
         assert(NULL == tree->last);          /*
         if (NULL == roffnode_new(ROFF_Os, tree->rbuf->line, tree))           * If we have no custom end-query or lookup failed, then try
                 return(0);           * pulling it out of the hashtable.
            */
   
         tree->state |= ROFF_PRELUDE_Os;          ppos = pos;
         tree->state &= ~ROFF_PRELUDE;          t = roff_parse(*bufp, &pos);
         tree->state |= ROFF_BODY;  
   
         return(1);          /* If we're not a comment-end, then throw it away. */
           if (ROFF_cblock != t)
                   return(ROFF_IGN);
   
           assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_Sh(ROFFCALL_ARGS)  roff_block_text(ROFF_ARGS)
 {  {
   
         if (ROFF_EXIT == type) {          return(ROFF_IGN);
                 roffnode_free(ROFF_Sh, tree);  }
                 dbg_leave(tree->args, ROFF_Sh);  
                 return(1);  
         }  
   
         dbg_enter(tree->args, ROFF_Sh);  
   
         if (NULL == roffnode_new(ROFF_Sh, tree->rbuf->line, tree))  /* ARGSUSED */
                 return(0);  static enum rofferr
   roff_cond_sub(ROFF_ARGS)
   {
           enum rofft       t;
           enum roffrule    rr;
           struct roffnode *l;
   
         return(1);          ppos = pos;
           rr = r->last->rule;
   
           /*
            * Clean out scope.  If we've closed ourselves, then don't
            * continue.
            */
   
           l = r->last;
           roffnode_cleanscope(r);
   
           if (l != r->last)
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   
           if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
   
           /*
            * A denied conditional must evaluate its children if and only
            * if they're either structurally required (such as loops and
            * conditionals) or a closing macro.
            */
           if (ROFFRULE_DENY == rr)
                   if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                           if (ROFF_ccond != t)
                                   return(ROFF_IGN);
   
           assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp, szp,
                                   ln, ppos, pos, offs));
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_Li(ROFFCALL_ARGS)  roff_cond_text(ROFF_ARGS)
 {  {
           char            *ep, *st;
           enum roffrule    rr;
   
         dbg_enter(tree->args, ROFF_Li);          rr = r->last->rule;
         dbg_leave(tree->args, ROFF_Li);  
   
         return(1);          /*
            * We display the value of the text if out current evaluation
            * scope permits us to do so.
            */
   
           st = &(*bufp)[pos];
           if (NULL == (ep = strstr(st, "\\}"))) {
                   roffnode_cleanscope(r);
                   return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
           }
   
           if (ep == st || (ep > st && '\\' != *(ep - 1)))
                   roffnode_pop(r);
   
           roffnode_cleanscope(r);
           return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
 }  }
   
   
 static int  static enum roffrule
 roffnextopt(const char ***in, char **val)  roff_evalcond(const char *v, int *pos)
 {  {
         const char      *arg, **argv;  
         int              v;  
   
         *val = NULL;          switch (v[*pos]) {
         argv = *in;          case ('n'):
         assert(argv);                  (*pos)++;
                   return(ROFFRULE_ALLOW);
           case ('e'):
                   /* FALLTHROUGH */
           case ('o'):
                   /* FALLTHROUGH */
           case ('t'):
                   (*pos)++;
                   return(ROFFRULE_DENY);
           default:
                   break;
           }
   
         if (NULL == (arg = *argv))          while (v[*pos] && ' ' != v[*pos])
                 return(-1);                  (*pos)++;
         if ('-' != *arg)          return(ROFFRULE_DENY);
                 return(-1);  }
         if (ROFF_ARGMAX == (v = rofffindarg(&arg[1])))  
                 return(-1);  
         if ( ! (ROFF_VALUE & tokenargs[v].flags))  
                 return(v);  
   
         *in = ++argv;  
   
         /* FIXME: what if this looks like a roff token or argument? */  /* ARGSUSED */
   static enum rofferr
   roff_line(ROFF_ARGS)
   {
   
         return(*argv ? v : ROFF_ARGMAX);          return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static int  static enum rofferr
 roff_An(ROFFCALL_ARGS)  roff_cond(ROFF_ARGS)
 {  {
         int              c;          int              sv;
         char            *val;          enum roffrule    rule;
   
         dbg_enter(tree->args, ROFF_An);          /* Stack overflow! */
   
         while (-1 != (c = roffnextopt(&argv, &val))) {          if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
                 switch (c) {                  (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
                 case (ROFF_Split):                  return(ROFF_ERR);
                         /* Process argument. */  
                         break;  
                 case (ROFF_Nosplit):  
                         /* Process argument. */  
                         break;  
                 default:  
                         warnx("%s: error parsing `An' args (line %zu)",  
                                         tree->rbuf->name,  
                                         tree->rbuf->line);  
                         return(0);  
                 }  
                 argv++;  
         }          }
   
         /* Print header. */          /* First, evaluate the conditional. */
   
         while (*argv) {          if (ROFF_el == tok) {
                 if (/* is_parsable && */ 2 >= strlen(*argv)) {                  /*
                         if (ROFF_MAX != (c = rofffindtok(*argv))) {                   * An `.el' will get the value of the current rstack
                                 if (ROFF_CALLABLE & tokens[c].flags) {                   * entry set in prior `ie' calls or defaults to DENY.
                                         /* Call to token. */                   */
                                         if ( ! (*tokens[c].cb)(tree, (const char **)argv + 1, ROFF_ENTER))                  if (r->rstackpos < 0)
                                                 return(0);                          rule = ROFFRULE_DENY;
                                 }                  else
                                 /* Print token. */                          rule = r->rstack[r->rstackpos];
                         } else {          } else
                                 /* Print token. */                  rule = roff_evalcond(*bufp, &pos);
                         }  
                 } else {          sv = pos;
                         /* Print token. */  
                 }          while (' ' == (*bufp)[pos])
                 argv++;                  pos++;
   
           /*
            * Roff is weird.  If we have just white-space after the
            * conditional, it's considered the BODY and we exit without
            * really doing anything.  Warn about this.  It's probably
            * wrong.
            */
   
           if ('\0' == (*bufp)[pos] && sv != pos) {
                   if ((*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
                           return(ROFF_IGN);
                   return(ROFF_ERR);
         }          }
   
         /* Print footer. */          if ( ! roffnode_push(r, tok, ln, ppos))
                   return(ROFF_ERR);
   
         dbg_leave(tree->args, ROFF_An);          r->last->rule = rule;
   
         return(1);          ROFF_DEBUG("roff: cond: %s -> %s\n", roffs[tok].name,
                           ROFFRULE_ALLOW == rule ?  "allow" : "deny");
   
           if (ROFF_ie == tok) {
                   /*
                    * An if-else will put the NEGATION of the current
                    * evaluated conditional into the stack.
                    */
                   r->rstackpos++;
                   if (ROFFRULE_DENY == r->last->rule)
                           r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
                   else
                           r->rstack[r->rstackpos] = ROFFRULE_DENY;
           }
   
           /* If the parent has false as its rule, then so do we. */
   
           if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule) {
                   r->last->rule = ROFFRULE_DENY;
                   ROFF_DEBUG("roff: cond override: %s -> deny\n",
                                   roffs[tok].name);
           }
   
           /*
            * Determine scope.  If we're invoked with "\{" trailing the
            * conditional, then we're in a multiline scope.  Else our scope
            * expires on the next line.
            */
   
           r->last->endspan = 1;
   
           if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   r->last->endspan = -1;
                   pos += 2;
                   ROFF_DEBUG("roff: cond-scope: %s, multi-line\n",
                                   roffs[tok].name);
           } else
                   ROFF_DEBUG("roff: cond-scope: %s, one-line\n",
                                   roffs[tok].name);
   
           /*
            * If there are no arguments on the line, the next-line scope is
            * assumed.
            */
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
           /* Otherwise re-run the roff parser after recalculating. */
   
           *offs = pos;
           return(ROFF_RERUN);
 }  }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_nr(ROFF_ARGS)
   {
           const char      *key, *val;
   
           key = &(*bufp)[pos];
   
           /* Parse register request. */
           while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                   pos++;
   
           /*
            * Set our nil terminator.  Because this line is going to be
            * ignored anyway, we can munge it as we please.
            */
           if ((*bufp)[pos])
                   (*bufp)[pos++] = '\0';
   
           /* Skip whitespace to register token. */
           while ((*bufp)[pos] && ' ' == (*bufp)[pos])
                   pos++;
   
           val = &(*bufp)[pos];
   
           /* Process register token. */
   
           if (0 == strcmp(key, "nS")) {
                   if ( ! roff_parse_nat(val, &r->regs->regs[(int)REG_nS].i))
                           r->regs->regs[(int)REG_nS].i = 0;
   
                   ROFF_DEBUG("roff: register nS: %d\n",
                                   r->regs->regs[(int)REG_nS].i);
           } else
                   ROFF_DEBUG("roff: ignoring register: %s\n", key);
   
           return(ROFF_IGN);
   }
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.90
CVSweb