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

Diff for /mandoc/main.c between version 1.68 and 1.93

version 1.68, 2010/05/15 09:46:31 version 1.93, 2010/06/29 14:53:14
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009 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 29 
Line 29 
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
   #include "mandoc.h"
   #include "regs.h"
   #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
 #include "main.h"  #include "roff.h"
   
 #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))  #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
   
Line 63  enum outt {
Line 66  enum outt {
         OUTT_TREE,          OUTT_TREE,
         OUTT_HTML,          OUTT_HTML,
         OUTT_XHTML,          OUTT_XHTML,
         OUTT_LINT          OUTT_LINT,
           OUTT_PS
 };  };
   
 struct  curparse {  struct  curparse {
         const char       *file;         /* Current parse. */          const char       *file;         /* Current parse. */
         int               fd;           /* Current parse. */          int               fd;           /* Current parse. */
         int               wflags;          int               wflags;
           /* FIXME: set by max error */
 #define WARN_WALL        (1 << 0)       /* All-warnings mask. */  #define WARN_WALL        (1 << 0)       /* All-warnings mask. */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */  #define WARN_WERR        (1 << 2)       /* Warnings->errors. */
         int               fflags;          int               fflags;
Line 78  struct curparse {
Line 83  struct curparse {
 #define FL_NIGN_MACRO    (1 << 2)       /* Don't ignore bad macros. */  #define FL_NIGN_MACRO    (1 << 2)       /* Don't ignore bad macros. */
 #define FL_IGN_ERRORS    (1 << 4)       /* Ignore failed parse. */  #define FL_IGN_ERRORS    (1 << 4)       /* Ignore failed parse. */
 #define FL_STRICT         FL_NIGN_ESCAPE | \  #define FL_STRICT         FL_NIGN_ESCAPE | \
                           FL_NIGN_MACRO                            FL_NIGN_MACRO /* ignore nothing */
         enum intt         inttype;      /* Input parsers... */          enum intt         inttype;      /* which parser to use */
         struct man       *man;          struct man       *man;          /* man parser */
         struct mdoc      *mdoc;          struct mdoc      *mdoc;         /* mdoc parser */
         enum outt         outtype;      /* Output devices... */          struct roff      *roff;         /* roff parser (!NULL) */
         out_mdoc          outmdoc;          struct regset     regs;         /* roff registers */
         out_man           outman;          enum outt         outtype;      /* which output to use */
         out_free          outfree;          out_mdoc          outmdoc;      /* mdoc output ptr */
         void             *outdata;          out_man           outman;       /* man output ptr */
         char              outopts[BUFSIZ];          out_free          outfree;      /* free output ptr */
           void             *outdata;      /* data for output */
           char              outopts[BUFSIZ]; /* buf of output opts */
 };  };
   
   static  const char * const      mandocerrs[MANDOCERR_MAX] = {
           "ok",
           "text should be uppercase",
           "sections out of conventional order",
           "section name repeats",
           "out of order prologue",
           "repeated prologue entry",
           "list type must come first",
           "bad standard",
           "bad library",
           "bad escape sequence",
           "unterminated quoted string",
           "argument requires the width argument",
           "superfluous width argument",
           "ignoring argument",
           "bad date argument",
           "bad width argument",
           "unknown manual section",
           "section not in conventional manual section",
           "end of line whitespace",
           "scope open on exit",
           "NAME section must come first",
           "bad Boolean value",
           "child violates parent syntax",
           "bad AT&T symbol",
           "list type repeated",
           "display type repeated",
           "argument repeated",
           "manual name not yet set",
           "obsolete macro ignored",
           "empty macro ignored",
           "macro not allowed in body",
           "macro not allowed in prologue",
           "bad character",
           "bad NAME section contents",
           "no blank lines",
           "no text in this context",
           "bad comment style",
           "unknown macro will be lost",
           "line scope broken",
           "scope broken",
           "argument count wrong",
           "request scope close w/none open",
           "scope already open",
           "macro requires line argument(s)",
           "macro requires body argument(s)",
           "macro requires argument(s)",
           "no title in document",
           "missing list type",
           "missing display type",
           "line argument(s) will be lost",
           "body argument(s) will be lost",
           "column syntax is inconsistent",
           "missing font type",
           "displays may not be nested",
           "unsupported display type",
           "no scope to rewind: syntax violated",
           "scope broken, syntax violated",
           "line scope broken, syntax violated",
           "argument count wrong, violates syntax",
           "child violates parent syntax",
           "argument count wrong, violates syntax",
           "no document body",
           "no document prologue",
           "utsname system call failed",
           "memory exhausted",
   };
   
 static  void              fdesc(struct curparse *);  static  void              fdesc(struct curparse *);
 static  void              ffile(const char *, struct curparse *);  static  void              ffile(const char *, struct curparse *);
 static  int               foptions(int *, char *);  static  int               foptions(int *, char *);
 static  struct man       *man_init(struct curparse *);  static  struct man       *man_init(struct curparse *);
 static  struct mdoc      *mdoc_init(struct curparse *);  static  struct mdoc      *mdoc_init(struct curparse *);
 static  int               merr(void *, int, int, const char *);  static  struct roff      *roff_init(struct curparse *);
 static  int               moptions(enum intt *, char *);  static  int               moptions(enum intt *, char *);
 static  int               mwarn(void *, int, int, const char *);  static  int               mmsg(enum mandocerr, void *,
                                   int, int, const char *);
 static  int               pset(const char *, int, struct curparse *,  static  int               pset(const char *, int, struct curparse *,
                                 struct man **, struct mdoc **);                                  struct man **, struct mdoc **);
 static  int               toptions(struct curparse *, char *);  static  int               toptions(struct curparse *, char *);
Line 177  main(int argc, char *argv[])
Line 253  main(int argc, char *argv[])
   
         if (curp.outfree)          if (curp.outfree)
                 (*curp.outfree)(curp.outdata);                  (*curp.outfree)(curp.outdata);
           if (curp.mdoc)
                   mdoc_free(curp.mdoc);
           if (curp.man)
                   man_free(curp.man);
           if (curp.roff)
                   roff_free(curp.roff);
   
         return((with_warning || with_error) ?          return((with_warning || with_error) ?
                         EXIT_FAILURE :  EXIT_SUCCESS);                          EXIT_FAILURE :  EXIT_SUCCESS);
Line 207  static struct man *
Line 289  static struct man *
 man_init(struct curparse *curp)  man_init(struct curparse *curp)
 {  {
         int              pflags;          int              pflags;
         struct man_cb    mancb;  
   
         mancb.man_err = merr;  
         mancb.man_warn = mwarn;  
   
         /* Defaults from mandoc.1. */          /* Defaults from mandoc.1. */
   
         pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE;          pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE;
Line 221  man_init(struct curparse *curp)
Line 299  man_init(struct curparse *curp)
         if (curp->fflags & FL_NIGN_ESCAPE)          if (curp->fflags & FL_NIGN_ESCAPE)
                 pflags &= ~MAN_IGN_ESCAPE;                  pflags &= ~MAN_IGN_ESCAPE;
   
         return(man_alloc(curp, pflags, &mancb));          return(man_alloc(&curp->regs, curp, pflags, mmsg));
 }  }
   
   
   static struct roff *
   roff_init(struct curparse *curp)
   {
   
           return(roff_alloc(&curp->regs, mmsg, curp));
   }
   
   
 static struct mdoc *  static struct mdoc *
 mdoc_init(struct curparse *curp)  mdoc_init(struct curparse *curp)
 {  {
         int              pflags;          int              pflags;
         struct mdoc_cb   mdoccb;  
   
         mdoccb.mdoc_err = merr;  
         mdoccb.mdoc_warn = mwarn;  
   
         /* Defaults from mandoc.1. */          /* Defaults from mandoc.1. */
   
         pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE;          pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE;
Line 245  mdoc_init(struct curparse *curp)
Line 327  mdoc_init(struct curparse *curp)
         if (curp->fflags & FL_NIGN_MACRO)          if (curp->fflags & FL_NIGN_MACRO)
                 pflags &= ~MDOC_IGN_MACRO;                  pflags &= ~MDOC_IGN_MACRO;
   
         return(mdoc_alloc(curp, pflags, &mdoccb));          return(mdoc_alloc(&curp->regs, curp, pflags, mmsg));
 }  }
   
   
Line 316  read_whole_file(struct curparse *curp, struct buf *fb,
Line 398  read_whole_file(struct curparse *curp, struct buf *fb,
                         return(0);                          return(0);
                 }                  }
                 *with_mmap = 1;                  *with_mmap = 1;
                 fb->sz = st.st_size;                  fb->sz = (size_t)st.st_size;
                 fb->buf = mmap(NULL, fb->sz, PROT_READ,                  fb->buf = mmap(NULL, fb->sz, PROT_READ,
                                 MAP_FILE, curp->fd, 0);                                  MAP_FILE|MAP_SHARED, curp->fd, 0);
                 if (fb->buf != MAP_FAILED)                  if (fb->buf != MAP_FAILED)
                         return(1);                          return(1);
         }          }
Line 342  read_whole_file(struct curparse *curp, struct buf *fb,
Line 424  read_whole_file(struct curparse *curp, struct buf *fb,
                         if (! resize_buf(fb, 65536))                          if (! resize_buf(fb, 65536))
                                 break;                                  break;
                 }                  }
                 ssz = read(curp->fd, fb->buf + off, fb->sz - off);                  ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off);
                 if (ssz == 0) {                  if (ssz == 0) {
                         fb->sz = off;                          fb->sz = off;
                         return(1);                          return(1);
Line 351  read_whole_file(struct curparse *curp, struct buf *fb,
Line 433  read_whole_file(struct curparse *curp, struct buf *fb,
                         perror(curp->file);                          perror(curp->file);
                         break;                          break;
                 }                  }
                 off += ssz;                  off += (size_t)ssz;
         }          }
   
         free(fb->buf);          free(fb->buf);
Line 365  static void
Line 447  static void
 fdesc(struct curparse *curp)  fdesc(struct curparse *curp)
 {  {
         struct buf       ln, blk;          struct buf       ln, blk;
         int              j, i, pos, lnn, comment, with_mmap;          int              i, pos, lnn, lnn_start, with_mmap, of;
           enum rofferr     re;
         struct man      *man;          struct man      *man;
         struct mdoc     *mdoc;          struct mdoc     *mdoc;
           struct roff     *roff;
   
         man = NULL;          man = NULL;
         mdoc = NULL;          mdoc = NULL;
           roff = NULL;
   
         memset(&ln, 0, sizeof(struct buf));          memset(&ln, 0, sizeof(struct buf));
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer optimised           * Two buffers: ln and buf.  buf is the input file and may be
          * here for each file's block size.  ln is a line buffer.  Both           * memory mapped.  ln is a line buffer and grows on-demand.
          * growable, hence passed in by ptr-ptr.  
          */           */
   
         if (!read_whole_file(curp, &blk, &with_mmap))          if ( ! read_whole_file(curp, &blk, &with_mmap))
                 return;                  return;
   
         /* Fill buf with file blocksize. */          if (NULL == curp->roff)
                   curp->roff = roff_init(curp);
           if (NULL == (roff = curp->roff))
                   goto bailout;
   
         for (i = lnn = pos = comment = 0; i < (int)blk.sz; ++i) {          for (i = 0, lnn = 1; i < (int)blk.sz;) {
                 if (pos >= (int)ln.sz) {                  pos = 0;
                         if (! resize_buf(&ln, 256))                  lnn_start = lnn;
                                 goto bailout;                  while (i < (int)blk.sz) {
                 }                          if ('\n' == blk.buf[i]) {
                                   ++i;
                 if ('\n' != blk.buf[i]) {                                  ++lnn;
                         if (comment)                                  break;
                           }
                           /* Trailing backslash is like a plain character. */
                           if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                   if (pos >= (int)ln.sz)
                                           if (! resize_buf(&ln, 256))
                                                   goto bailout;
                                   ln.buf[pos++] = blk.buf[i++];
                                 continue;                                  continue;
                         ln.buf[pos++] = blk.buf[i];  
   
                         /* Handle in-line `\"' comments. */  
   
                         if (1 == pos || '\"' != ln.buf[pos - 1])  
                                 continue;  
   
                         for (j = pos - 2; j >= 0; j--)  
                                 if ('\\' != ln.buf[j])  
                                         break;  
   
                         if ( ! ((pos - 2 - j) % 2))  
                                 continue;  
   
                         comment = 1;  
                         pos -= 2;  
                         for (; pos > 0; --pos) {  
                                 if (ln.buf[pos - 1] != ' ')  
                                         break;  
                                 if (pos > 2 && ln.buf[pos - 2] == '\\')  
                                         break;  
                         }                          }
                         continue;                          /* Found an escape and at least one other character. */
                 }                          if ('\n' == blk.buf[i + 1]) {
                                   /* Escaped newlines are skipped over */
                 /* Handle escaped `\\n' newlines. */                                  i += 2;
                                   ++lnn;
                 if (pos > 0 && 0 == comment && '\\' == ln.buf[pos - 1]) {  
                         for (j = pos - 1; j >= 0; j--)  
                                 if ('\\' != ln.buf[j])  
                                         break;  
                         if ( ! ((pos - j) % 2)) {  
                                 pos--;  
                                 lnn++;  
                                 continue;                                  continue;
                         }                          }
                           if ('"' == blk.buf[i + 1]) {
                                   i += 2;
                                   /* Comment, skip to end of line */
                                   for (; i < (int)blk.sz; ++i) {
                                           if ('\n' == blk.buf[i]) {
                                                   ++i;
                                                   ++lnn;
                                                   break;
                                           }
                                   }
                                   /* Backout trailing whitespaces */
                                   for (; pos > 0; --pos) {
                                           if (ln.buf[pos - 1] != ' ')
                                                   break;
                                           if (pos > 2 && ln.buf[pos - 2] == '\\')
                                                   break;
                                   }
                                   break;
                           }
                           /* Some other escape sequence, copy and continue. */
                           if (pos + 1 >= (int)ln.sz)
                                   if (! resize_buf(&ln, 256))
                                           goto bailout;
   
                           ln.buf[pos++] = blk.buf[i++];
                           ln.buf[pos++] = blk.buf[i++];
                 }                  }
   
                 ln.buf[pos] = 0;                  if (pos >= (int)ln.sz)
                 lnn++;                          if (! resize_buf(&ln, 256))
                                   goto bailout;
                   ln.buf[pos] = '\0';
   
                 /* If unset, assign parser in pset(). */                  /*
                    * A significant amount of complexity is contained by
                    * the roff preprocessor.  It's line-oriented but can be
                    * expressed on one line, so we need at times to
                    * readjust our starting point and re-run it.  The roff
                    * preprocessor can also readjust the buffers with new
                    * data, so we pass them in wholesale.
                    */
   
                 if ( ! (man || mdoc) && ! pset(ln.buf, pos, curp, &man, &mdoc))                  of = 0;
                   do {
                           re = roff_parseln(roff, lnn_start,
                                           &ln.buf, &ln.sz, of, &of);
                   } while (ROFF_RERUN == re);
   
                   if (ROFF_IGN == re)
                           continue;
                   else if (ROFF_ERR == re)
                         goto bailout;                          goto bailout;
   
                 pos = comment = 0;                  /*
                    * If input parsers have not been allocated, do so now.
                    * We keep these instanced betwen parsers, but set them
                    * locally per parse routine since we can use different
                    * parsers with each one.
                    */
   
                 /* Pass down into parsers. */                  if ( ! (man || mdoc))
                           if ( ! pset(ln.buf + of, pos - of, curp, &man, &mdoc))
                                   goto bailout;
   
                 if (man && ! man_parseln(man, lnn, ln.buf))                  /* Lastly, push down into the parsers themselves. */
   
                   if (man && ! man_parseln(man, lnn_start, ln.buf, of))
                         goto bailout;                          goto bailout;
                 if (mdoc && ! mdoc_parseln(mdoc, lnn, ln.buf))                  if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of))
                         goto bailout;                          goto bailout;
         }          }
   
Line 456  fdesc(struct curparse *curp)
Line 575  fdesc(struct curparse *curp)
                 goto bailout;                  goto bailout;
         }          }
   
           /* Clean up the parse routine ASTs. */
   
         if (mdoc && ! mdoc_endparse(mdoc))          if (mdoc && ! mdoc_endparse(mdoc))
                 goto bailout;                  goto bailout;
         if (man && ! man_endparse(man))          if (man && ! man_endparse(man))
                 goto bailout;                  goto bailout;
           if (roff && ! roff_endparse(roff))
                   goto bailout;
   
         /* If unset, allocate output dev now (if applicable). */          /* If unset, allocate output dev now (if applicable). */
   
Line 467  fdesc(struct curparse *curp)
Line 590  fdesc(struct curparse *curp)
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_XHTML):                  case (OUTT_XHTML):
                         curp->outdata = xhtml_alloc(curp->outopts);                          curp->outdata = xhtml_alloc(curp->outopts);
                         curp->outman = html_man;  
                         curp->outmdoc = html_mdoc;  
                         curp->outfree = html_free;  
                         break;                          break;
                 case (OUTT_HTML):                  case (OUTT_HTML):
                         curp->outdata = html_alloc(curp->outopts);                          curp->outdata = html_alloc(curp->outopts);
                           break;
                   case (OUTT_ASCII):
                           curp->outdata = ascii_alloc(curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case (OUTT_PS):
                           curp->outdata = ps_alloc(curp->outopts);
                           curp->outfree = ps_free;
                           break;
                   default:
                           break;
                   }
   
                   switch (curp->outtype) {
                   case (OUTT_HTML):
                           /* FALLTHROUGH */
                   case (OUTT_XHTML):
                         curp->outman = html_man;                          curp->outman = html_man;
                         curp->outmdoc = html_mdoc;                          curp->outmdoc = html_mdoc;
                         curp->outfree = html_free;                          curp->outfree = html_free;
Line 481  fdesc(struct curparse *curp)
Line 618  fdesc(struct curparse *curp)
                         curp->outman = tree_man;                          curp->outman = tree_man;
                         curp->outmdoc = tree_mdoc;                          curp->outmdoc = tree_mdoc;
                         break;                          break;
                 case (OUTT_LINT):                  case (OUTT_ASCII):
                         break;                          /* FALLTHROUGH */
                 default:                  case (OUTT_PS):
                         curp->outdata = ascii_alloc();  
                         curp->outman = terminal_man;                          curp->outman = terminal_man;
                         curp->outmdoc = terminal_mdoc;                          curp->outmdoc = terminal_mdoc;
                         curp->outfree = terminal_free;  
                         break;                          break;
                   default:
                           break;
                 }                  }
         }          }
   
Line 500  fdesc(struct curparse *curp)
Line 637  fdesc(struct curparse *curp)
                 (*curp->outmdoc)(curp->outdata, mdoc);                  (*curp->outmdoc)(curp->outdata, mdoc);
   
  cleanup:   cleanup:
         if (curp->mdoc) {          memset(&curp->regs, 0, sizeof(struct regset));
                 mdoc_free(curp->mdoc);          if (mdoc)
                 curp->mdoc = NULL;                  mdoc_reset(mdoc);
         }          if (man)
         if (curp->man) {                  man_reset(man);
                 man_free(curp->man);          if (roff)
                 curp->man = NULL;                  roff_reset(roff);
         }  
         if (ln.buf)          if (ln.buf)
                 free(ln.buf);                  free(ln.buf);
         if (with_mmap)          if (with_mmap)
                 munmap(blk.buf, blk.sz);                  munmap(blk.buf, blk.sz);
         else          else
                 free(blk.buf);                  free(blk.buf);
   
         return;          return;
   
  bailout:   bailout:
Line 536  pset(const char *buf, int pos, struct curparse *curp,
Line 673  pset(const char *buf, int pos, struct curparse *curp,
          * default to -man, which is more lenient.           * default to -man, which is more lenient.
          */           */
   
         if (buf[0] == '.') {          if ('.' == buf[0] || '\'' == buf[0]) {
                 for (i = 1; buf[i]; i++)                  for (i = 1; buf[i]; i++)
                         if (' ' != buf[i] && '\t' != buf[i])                          if (' ' != buf[i] && '\t' != buf[i])
                                 break;                                  break;
Line 613  toptions(struct curparse *curp, char *arg)
Line 750  toptions(struct curparse *curp, char *arg)
                 curp->outtype = OUTT_HTML;                  curp->outtype = OUTT_HTML;
         else if (0 == strcmp(arg, "xhtml"))          else if (0 == strcmp(arg, "xhtml"))
                 curp->outtype = OUTT_XHTML;                  curp->outtype = OUTT_XHTML;
           else if (0 == strcmp(arg, "ps"))
                   curp->outtype = OUTT_PS;
         else {          else {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: Bad argument\n", arg);
                 return(0);                  return(0);
Line 696  woptions(int *wflags, char *arg)
Line 835  woptions(int *wflags, char *arg)
 }  }
   
   
 /* ARGSUSED */  
 static int  static int
 merr(void *arg, int line, int col, const char *msg)  mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
 {  {
         struct curparse *curp;          struct curparse *cp;
   
         curp = (struct curparse *)arg;          cp = (struct curparse *)arg;
   
         (void)fprintf(stderr, "%s:%d:%d: error: %s\n",          if (t <= MANDOCERR_ERROR) {
                         curp->file, line, col + 1, msg);                  if ( ! (cp->wflags & WARN_WALL))
                           return(1);
                   with_warning = 1;
           } else
                   with_error = 1;
   
         with_error = 1;          fprintf(stderr, "%s:%d:%d: %s", cp->file,
                           ln, col + 1, mandocerrs[t]);
   
         return(0);          if (msg)
 }                  fprintf(stderr, ": %s", msg);
   
           fputc('\n', stderr);
   
 static int          /* This is superfluous, but whatever. */
 mwarn(void *arg, int line, int col, const char *msg)          if (t > MANDOCERR_ERROR)
 {                  return(0);
         struct curparse *curp;          if (cp->wflags & WARN_WERR) {
   
         curp = (struct curparse *)arg;  
   
         if ( ! (curp->wflags & WARN_WALL))  
                 return(1);  
   
         (void)fprintf(stderr, "%s:%d:%d: warning: %s\n",  
                         curp->file, line, col + 1, msg);  
   
         with_warning = 1;  
         if (curp->wflags & WARN_WERR) {  
                 with_error = 1;                  with_error = 1;
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
Legend:
Removed from v.1.68  
changed lines
  Added in v.1.93
CVSweb