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

Diff for /mandoc/roff.c between version 1.66 and 1.78

version 1.66, 2010/05/15 07:52:11 version 1.78, 2010/05/16 22:28:33
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>   * 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 above   * purpose with or without fee is hereby granted, provided that the above
Line 18 
Line 18 
 #include "config.h"  #include "config.h"
 #endif  #endif
   
   #include <assert.h>
 #include <stdlib.h>  #include <stdlib.h>
   #include <string.h>
   #include <stdio.h>
   
   #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   
   #define ROFF_CTL(c) \
           ('.' == (c) || '\'' == (c))
   #if     0
   #define ROFF_MDEBUG(p, str) \
           fprintf(stderr, "%s: %s (%d:%d)\n", (str), \
                   roffs[(p)->last->tok].name, \
                   (p)->last->line, (p)->last->col)
   #else
   #define ROFF_MDEBUG(p, str) while (/* CONSTCOND */ 0)
   #endif
   
   enum    rofft {
           ROFF_if,
           ROFF_ig,
           ROFF_cblock,
           ROFF_ccond,
   #if 0
           ROFF_am,
           ROFF_ami,
           ROFF_de,
           ROFF_dei,
           ROFF_close,
   #endif
           ROFF_MAX
   };
   
   struct  roff {
           struct roffnode *last; /* leaf of stack */
           mandocmsg        msg; /* err/warn/fatal messages */
           void            *data; /* privdata for messages */
   };
   
   struct  roffnode {
           enum rofft       tok; /* type of node */
           struct roffnode *parent; /* up one in stack */
           char            *end; /* end-token: custom */
           int              line; /* parse line */
           int              col; /* parse col */
           int              endspan;
   };
   
   #define ROFF_ARGS        struct roff *r, /* parse ctx */ \
                            enum rofft tok, /* tok of macro */ \
                            char **bufp, /* input buffer */ \
                            size_t *szp, /* size of input buffer */ \
                            int ln, /* parse line */ \
                            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);
   
   struct  roffmac {
           const char      *name; /* macro name */
           roffproc         proc;
           roffproc         text;
   };
   
   static  enum rofferr     roff_if(ROFF_ARGS);
   static  enum rofferr     roff_if_text(ROFF_ARGS);
   static  enum rofferr     roff_ig(ROFF_ARGS);
   static  enum rofferr     roff_ig_text(ROFF_ARGS);
   static  enum rofferr     roff_cblock(ROFF_ARGS);
   static  enum rofferr     roff_ccond(ROFF_ARGS);
   
   const   struct roffmac   roffs[ROFF_MAX] = {
           { "if", roff_if, roff_if_text },
           { "ig", roff_ig, roff_ig_text },
           { ".", roff_cblock, NULL },
           { "\\}", roff_ccond, NULL },
   };
   
   static  void             roff_free1(struct roff *);
   static  enum rofft       roff_hash_find(const char *);
   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 *);
   
   
   /*
    * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
    * the nil-terminated string name could be found.
    */
   static enum rofft
   roff_hash_find(const char *p)
   {
           int              i;
   
           /* FIXME: make this be fast and efficient. */
   
           for (i = 0; i < (int)ROFF_MAX; i++)
                   if (0 == strcmp(roffs[i].name, p))
                           return((enum rofft)i);
   
           return(ROFF_MAX);
   }
   
   
   /*
    * Pop the current node off of the stack of roff instructions currently
    * pending.
    */
   static void
   roffnode_pop(struct roff *r)
   {
           struct roffnode *p;
   
           assert(r->last);
           p = r->last;
           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
   roffnode_push(struct roff *r, enum rofft tok, int line, int col)
   {
           struct roffnode *p;
   
           if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
                   (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
                   return(0);
           }
   
           p->tok = tok;
           p->parent = r->last;
           p->line = line;
           p->col = col;
   
           r->last = p;
           return(1);
   }
   
   
   static void
   roff_free1(struct roff *r)
   {
   
           while (r->last)
                   roffnode_pop(r);
   }
   
   
   void
   roff_reset(struct roff *r)
   {
   
           roff_free1(r);
   }
   
   
   void
   roff_free(struct roff *r)
   {
   
           roff_free1(r);
           free(r);
   }
   
   
   struct roff *
   roff_alloc(const mandocmsg msg, void *data)
   {
           struct roff     *r;
   
           if (NULL == (r = calloc(1, sizeof(struct roff)))) {
                   (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
                   return(0);
           }
   
           r->msg = msg;
           r->data = data;
           return(r);
   }
   
   
   enum rofferr
   roff_parseln(struct roff *r, int ln,
                   char **bufp, size_t *szp, int pos, int *offs)
   {
           enum rofft       t;
           int              ppos, i, j, wtf;
   
           if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                   /*
                    * If a scope is open and we're not a macro, pass it
                    * through our text detector and continue as quickly as
                    * possible.
                    */
                   t = r->last->tok;
                   assert(roffs[t].text);
                   return((*roffs[t].text)
                                   (r, t, bufp, szp, ln, pos, pos, offs));
           } else if ( ! ROFF_CTL((*bufp)[pos]))
                   /*
                    * Don't do anything if we're free-form text.
                    */
                   return(ROFF_CONT);
   
           /* A macro-ish line with a possibly-open macro context. */
   
           wtf = 0;
   
           if (r->last && r->last->end) {
                   /*
                    * We have a scope open that has a custom end-macro
                    * handler.  Try to match it against the input.
                    */
                   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);
                           wtf = 1;
                   }
           }
   
           ppos = pos;
           if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) {
                   /*
                    * This is some of groff's 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 (wtf)
                           return(ROFF_IGN);
                   else if (NULL == r->last)
                           return(ROFF_CONT);
   
                   /* FIXME: this assumes that we ignore!? */
                   return(ROFF_IGN);
           }
   
           assert(roffs[t].proc);
           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
    * form of ".foo xxx" in the usual way.
    */
   static enum rofft
   roff_parse(const char *buf, int *pos)
   {
           int              j;
           char             mac[5];
           enum rofft       t;
   
           assert(ROFF_CTL(buf[*pos]));
           (*pos)++;
   
           while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
                   (*pos)++;
   
           if ('\0' == buf[*pos])
                   return(ROFF_MAX);
   
           for (j = 0; j < 4; j++, (*pos)++)
                   if ('\0' == (mac[j] = buf[*pos]))
                           break;
                   else if (' ' == buf[*pos])
                           break;
   
           if (j == 4 || j < 1)
                   return(ROFF_MAX);
   
           mac[j] = '\0';
   
           if (ROFF_MAX == (t = roff_hash_find(mac)))
                   return(t);
   
           while (buf[*pos] && ' ' == buf[*pos])
                   (*pos)++;
   
           return(t);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_cblock(ROFF_ARGS)
   {
   
           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);
   
           ROFF_MDEBUG(r, "closing ignore block");
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   
   }
   
   
   static void
   roffnode_cleanscope(struct roff *r)
   {
   
           while (r->last) {
                   if (--r->last->endspan < 0)
                           break;
                   ROFF_MDEBUG(r, "closing implicit scope");
                   roffnode_pop(r);
           }
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_ccond(ROFF_ARGS)
   {
   
           if (NULL == r->last) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if (ROFF_if != r->last->tok) {
                   if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
                           return(ROFF_ERR);
                   return(ROFF_IGN);
           }
   
           if (r->last->endspan > -1) {
                   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);
   
           ROFF_MDEBUG(r, "closing explicit scope");
           roffnode_pop(r);
           roffnode_cleanscope(r);
           return(ROFF_IGN);
   }
   
   
   /* ARGSUSED */
   static enum rofferr
   roff_ig(ROFF_ARGS)
   {
           int             sv;
           size_t          sz;
   
           if ( ! roffnode_push(r, tok, ln, ppos))
                   return(ROFF_ERR);
   
           if ('\0' == (*bufp)[pos]) {
                   ROFF_MDEBUG(r, "opening ignore block");
                   return(ROFF_IGN);
           }
   
           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);
   
           r->last->end = malloc(sz + 1);
   
           if (NULL == r->last->end) {
                   (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
                   return(ROFF_ERR);
           }
   
           memcpy(r->last->end, *bufp + sv, sz);
           r->last->end[(int)sz] = '\0';
   
           ROFF_MDEBUG(r, "opening explicit ignore block");
   
           if ((*bufp)[pos])
                   if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
                           return(ROFF_ERR);
   
           return(ROFF_IGN);
   }
   
   
   /* 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)) {
                   ROFF_MDEBUG(r, "closing explicit scope (in-line)");
                   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]) {
                   ROFF_MDEBUG(r, "opening explicit scope");
                   r->last->endspan = -1;
                   pos += 2;
           } else
                   ROFF_MDEBUG(r, "opening implicit scope");
   
           /*
            * 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.66  
changed lines
  Added in v.1.78
CVSweb