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

Diff for /mandoc/roff.c between version 1.69 and 1.79

version 1.69, 2010/05/15 18:48:32 version 1.79, 2010/05/17 00:06:36
Line 21 
Line 21 
 #include <assert.h>  #include <assert.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <stdio.h>
   
 #include "mandoc.h"  #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   
   #define ROFF_CTL(c) \
           ('.' == (c) || '\'' == (c))
   
 enum    rofft {  enum    rofft {
         ROFF_de,          ROFF_if,
         ROFF_dei,          ROFF_ig,
           ROFF_cblock,
           ROFF_ccond,
   #if 0
         ROFF_am,          ROFF_am,
         ROFF_ami,          ROFF_ami,
         ROFF_ig,          ROFF_de,
         ROFF_close,          ROFF_dei,
           ROFF_ie,
           ROFF_el,
   #endif
         ROFF_MAX          ROFF_MAX
 };  };
   
Line 41  struct roff {
Line 51  struct roff {
         void            *data; /* privdata for messages */          void            *data; /* privdata for messages */
 };  };
   
   enum    roffrule {
           ROFFRULE_ALLOW,
           ROFFRULE_DENY
   };
   
 struct  roffnode {  struct  roffnode {
         enum rofft       tok; /* type of node */          enum rofft       tok; /* type of node */
         struct roffnode *parent; /* up one in stack */          struct roffnode *parent; /* up one in stack */
         int              line; /* parse line */          int              line; /* parse line */
         int              col; /* parse col */          int              col; /* parse col */
           char            *end; /* end-rules: custom token */
           int              endspan; /* end-rules: next-line or infty */
           enum roffrule    rule;
 };  };
   
 #define ROFF_ARGS        struct roff *r, /* parse ctx */ \  #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
                            enum rofft tok, /* tok of macro */ \
                          char **bufp, /* input buffer */ \                           char **bufp, /* input buffer */ \
                          size_t *szp, /* size of input buffer */ \                           size_t *szp, /* size of input buffer */ \
                          int ln, /* parse line */ \                           int ln, /* parse line */ \
                          int ppos /* current pos in buffer */                           int ppos, /* original pos in buffer */ \
                            int pos, /* current pos in buffer */ \
                            int *offs /* reset offset of buffer data */
   
 typedef enum rofferr (*roffproc)(ROFF_ARGS);  typedef enum rofferr (*roffproc)(ROFF_ARGS);
   
 struct  roffmac {  struct  roffmac {
         const char      *name; /* macro name */          const char      *name; /* macro name */
         roffproc         sub; /* child of control black */          roffproc         proc; /* process new macro */
         roffproc         new; /* root of stack (type = ROFF_MAX) */          roffproc         text; /* process as child text of macro */
           roffproc         sub; /* process as child of macro */
           int              flags;
   #define ROFFMAC_STRUCT  (1 << 0) /* always interpret */
 };  };
   
 static  enum rofferr     roff_ignore(ROFF_ARGS);  static  enum rofferr     roff_if(ROFF_ARGS);
 static  enum rofferr     roff_new_close(ROFF_ARGS);  static  enum rofferr     roff_if_text(ROFF_ARGS);
 static  enum rofferr     roff_new_ig(ROFF_ARGS);  static  enum rofferr     roff_if_sub(ROFF_ARGS);
 static  enum rofferr     roff_sub_ig(ROFF_ARGS);  static  enum rofferr     roff_ig(ROFF_ARGS);
   static  enum rofferr     roff_ig_text(ROFF_ARGS);
   static  enum rofferr     roff_ig_sub(ROFF_ARGS);
   static  enum rofferr     roff_cblock(ROFF_ARGS);
   static  enum rofferr     roff_ccond(ROFF_ARGS);
   
 const   struct roffmac   roffs[ROFF_MAX] = {  const   struct roffmac   roffs[ROFF_MAX] = {
         { "de", NULL, roff_ignore },          { "if", roff_if, roff_if_text, roff_if_sub, ROFFMAC_STRUCT },
         { "dei", NULL, roff_ignore },          { "ig", roff_ig, roff_ig_text, roff_ig_sub, 0 },
         { "am", NULL, roff_ignore },          { ".", roff_cblock, NULL, NULL, 0 },
         { "ami", NULL, roff_ignore },          { "\\}", roff_ccond, NULL, NULL, 0 },
         { "ig", roff_sub_ig, roff_new_ig },  
         { ".", NULL, roff_new_close },  
 };  };
   
 static  void             roff_alloc1(struct roff *);  
 static  void             roff_free1(struct roff *);  static  void             roff_free1(struct roff *);
 static  enum rofft       roff_hash_find(const char *);  static  enum rofft       roff_hash_find(const char *);
   static  void             roffnode_cleanscope(struct roff *);
 static  int              roffnode_push(struct roff *,  static  int              roffnode_push(struct roff *,
                                 enum rofft, int, int);                                  enum rofft, int, int);
 static  void             roffnode_pop(struct roff *);  static  void             roffnode_pop(struct roff *);
Line 113  roffnode_pop(struct roff *r)
Line 139  roffnode_pop(struct roff *r)
 {  {
         struct roffnode *p;          struct roffnode *p;
   
         if (NULL == (p = r->last))          assert(r->last);
                 return;          p = r->last;
         r->last = p->parent;          r->last = r->last->parent;
           if (p->end)
                   free(p->end);
         free(p);          free(p);
 }  }
   
Line 138  roffnode_push(struct roff *r, enum rofft tok, int line
Line 166  roffnode_push(struct roff *r, enum rofft tok, int line
         p->parent = r->last;          p->parent = r->last;
         p->line = line;          p->line = line;
         p->col = col;          p->col = col;
           p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
   
         r->last = p;          r->last = p;
         return(1);          return(1);
Line 153  roff_free1(struct roff *r)
Line 182  roff_free1(struct roff *r)
 }  }
   
   
 static void  
 roff_alloc1(struct roff *r)  
 {  
   
         /* Do nothing for now. */  
 }  
   
   
 void  void
 roff_reset(struct roff *r)  roff_reset(struct roff *r)
 {  {
   
         roff_free1(r);          roff_free1(r);
         roff_alloc1(r);  
 }  }
   
   
Line 196  roff_alloc(const mandocmsg msg, void *data)
Line 216  roff_alloc(const mandocmsg msg, void *data)
   
   
 enum rofferr  enum rofferr
 roff_parseln(struct roff *r, int ln, char **bufp, size_t *szp)  roff_parseln(struct roff *r, int ln,
                   char **bufp, size_t *szp, int pos, int *offs)
 {  {
         enum rofft       t;          enum rofft       t;
         int              ppos;          int              ppos;
   
         if (NULL != r->last) {          /*
                 /*           * First, if a scope is open and we're not a macro, pass the
                  * If there's a node on the stack, then jump directly           * text through the macro's filter.  If a scope isn't open and
                  * into its processing function.           * we're not a macro, just let it through.
                  */           */
   
           if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                 t = r->last->tok;                  t = r->last->tok;
                 assert(roffs[t].sub);                  assert(roffs[t].text);
                 return((*roffs[t].sub)(r, bufp, szp, ln, 0));                  return((*roffs[t].text)
         } else if ('.' != (*bufp)[0] && NULL == r->last)                                  (r, t, bufp, szp, ln, pos, pos, offs));
                 /* Return when in free text without a context. */          } else if ( ! ROFF_CTL((*bufp)[pos]))
                 return(ROFF_CONT);                  return(ROFF_CONT);
   
         /* There's nothing on the stack: make us anew. */          /*
            * If a scope is open, go to the child handler for that macro,
            * as it may want to preprocess before doing anything with it.
            */
   
         if (ROFF_MAX == (t = roff_parse(*bufp, &ppos)))          if (r->last) {
                   t = r->last->tok;
                   assert(roffs[t].sub);
                   return((*roffs[t].sub)
                                   (r, t, bufp, szp, ln, pos, pos, offs));
           }
   
           /*
            * Lastly, as we've no scope open, try to look up and execute
            * the new macro.  If no macro is found, simply return and let
            * the compilers handle it.
            */
   
           ppos = pos;
           if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
                 return(ROFF_CONT);                  return(ROFF_CONT);
   
         assert(roffs[t].new);          assert(roffs[t].proc);
         return((*roffs[t].new)(r, bufp, szp, ln, ppos));          return((*roffs[t].proc)
                           (r, t, bufp, szp, ln, ppos, pos, offs));
 }  }
   
   
   int
   roff_endparse(struct roff *r)
   {
   
           if (NULL == r->last)
                   return(1);
           return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line,
                                   r->last->col, NULL));
   }
   
   
 /*  /*
  * Parse a roff node's type from the input buffer.  This must be in the   * Parse a roff node's type from the input buffer.  This must be in the
  * form of ".foo xxx" in the usual way.   * form of ".foo xxx" in the usual way.
Line 234  roff_parse(const char *buf, int *pos)
Line 286  roff_parse(const char *buf, int *pos)
         char             mac[5];          char             mac[5];
         enum rofft       t;          enum rofft       t;
   
         assert('.' == buf[0]);          assert(ROFF_CTL(buf[*pos]));
         *pos = 1;          (*pos)++;
   
         while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))          while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
                 (*pos)++;                  (*pos)++;
Line 266  roff_parse(const char *buf, int *pos)
Line 318  roff_parse(const char *buf, int *pos)
   
 /* ARGSUSED */  /* ARGSUSED */
 static enum rofferr  static enum rofferr
 roff_ignore(ROFF_ARGS)  roff_cblock(ROFF_ARGS)
 {  {
   
           /*
            * A block-close `..' should only be invoked as a child of an
            * ignore macro, otherwise raise a warning and just ignore it.
            */
   
           if (NULL == r->last) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if (ROFF_ig != r->last->tok) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
           roffnode_pop(r);
           roffnode_cleanscope(r);
         return(ROFF_IGN);          return(ROFF_IGN);
   
 }  }
   
   
   static void
   roffnode_cleanscope(struct roff *r)
   {
   
           while (r->last) {
                   if (--r->last->endspan < 0)
                           break;
                   roffnode_pop(r);
           }
   }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static enum rofferr  static enum rofferr
 roff_sub_ig(ROFF_ARGS)  roff_ccond(ROFF_ARGS)
 {  {
         enum rofft       t;  
         int              pos;  
   
         /* Ignore free-text lines. */          if (NULL == r->last) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
         if ('.' != (*bufp)[ppos])          if (ROFF_if != r->last->tok) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                 return(ROFF_IGN);                  return(ROFF_IGN);
           }
   
         /* Ignore macros unless it's a closing macro. */          if (r->last->endspan > -1) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
         t = roff_parse(*bufp, &pos);                          return(ROFF_ERR);
         if (ROFF_close != t)  
                 return(ROFF_IGN);                  return(ROFF_IGN);
           }
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
         roffnode_pop(r);          roffnode_pop(r);
           roffnode_cleanscope(r);
         return(ROFF_IGN);          return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static enum rofferr  static enum rofferr
 roff_new_close(ROFF_ARGS)  roff_ig(ROFF_ARGS)
 {  {
           int             sv;
           size_t          sz;
   
           if ( ! roffnode_push(r, tok, ln, ppos))
                   return(ROFF_ERR);
   
           if ('\0' == (*bufp)[pos])
                   return(ROFF_IGN);
   
           sv = pos;
           while ((*bufp)[pos] && ' ' != (*bufp)[pos] &&
                           '\t' != (*bufp)[pos])
                   pos++;
   
         /*          /*
         if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))           * 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);                  return(ROFF_ERR);
         */          }
   
           memcpy(r->last->end, *bufp + sv, sz);
           r->last->end[(int)sz] = '\0';
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
         return(ROFF_IGN);          return(ROFF_IGN);
 }  }
   
   
 /* ARGSUSED */  /* ARGSUSED */
 static enum rofferr  static enum rofferr
 roff_new_ig(ROFF_ARGS)  roff_if_sub(ROFF_ARGS)
 {  {
           enum rofft       t;
           enum roffrule    rr;
   
         return(roffnode_push(r, ROFF_ig, ln, ppos) ?          ppos = pos;
                         ROFF_IGN : ROFF_ERR);          rr = r->last->rule;
           roffnode_cleanscope(r);
   
           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));
 }  }
   
   
 int  /* ARGSUSED */
 roff_endparse(struct roff *r)  static enum rofferr
   roff_ig_sub(ROFF_ARGS)
 {  {
           enum rofft      t;
           int             i, j;
   
         if (NULL == r->last)          /*
                 return(1);           * First check whether a custom macro exists at this level.  If
         return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data,           * it does, then check against it.  This is some of groff's
                                 r->last->line, r->last->col, NULL));           * 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.
            */
   
           if (r->last->end) {
                   i = pos + 1;
                   while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                           i++;
   
                   for (j = 0; r->last->end[j]; j++, i++)
                           if ((*bufp)[i] != r->last->end[j])
                                   break;
   
                   if ('\0' == r->last->end[j] &&
                                   ('\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);
                   }
           }
   
           /*
            * If we have no custom end-query or lookup failed, then try
            * pulling it out of the hashtable.
            */
   
           ppos = pos;
           t = roff_parse(*bufp, &pos);
   
           /* If we're not a comment-end, then throw it away. */
           if (ROFF_cblock != t)
                   return(ROFF_IGN);
   
           assert(roffs[t].proc);
           return((*roffs[t].proc)(r, t, bufp,
                           szp, ln, ppos, pos, offs));
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_ig_text(ROFF_ARGS)
   {
   
           return(ROFF_IGN);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_if_text(ROFF_ARGS)
   {
           char            *ep, *st;
   
           st = &(*bufp)[pos];
           if (NULL == (ep = strstr(st, "\\}"))) {
                   roffnode_cleanscope(r);
                   return(ROFF_IGN);
           }
   
           if (ep > st && '\\' != *(ep - 1))
                   roffnode_pop(r);
   
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_if(ROFF_ARGS)
   {
           int              sv;
   
           /*
            * Read ahead past the conditional.
            * FIXME: this does not work, as conditionals don't end on
            * whitespace, but are parsed according to a formal grammar.
            * It's good enough for now, however.
            */
   
           while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                   pos++;
   
           sv = pos;
           while (' ' == (*bufp)[pos])
                   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_ERR);
                   return(ROFF_IGN);
           }
   
           if ( ! roffnode_push(r, tok, ln, ppos))
                   return(ROFF_ERR);
   
           /* Don't evaluate: just assume NO. */
   
           r->last->endspan = 1;
   
           if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   r->last->endspan = -1;
                   pos += 2;
           }
   
           /*
            * 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);
 }  }
Legend:
Removed from v.1.69  
changed lines
  Added in v.1.79
CVSweb