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

Diff for /mandoc/main.c between version 1.77 and 1.102

version 1.77, 2010/05/16 19:08:11 version 1.102, 2010/08/08 14:45:59
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * 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 22 
Line 23 
 #include <sys/stat.h>  #include <sys/stat.h>
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdint.h>  #include <stdint.h>
Line 30 
Line 32 
 #include <unistd.h>  #include <unistd.h>
   
 #include "mandoc.h"  #include "mandoc.h"
   #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
 #include "roff.h"  #include "roff.h"
 #include "main.h"  
   
   #ifndef MAP_FILE
   #define MAP_FILE        0
   #endif
   
 #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))  #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
   
 /* FIXME: Intel's compiler?  LLVM?  pcc?  */  /* FIXME: Intel's compiler?  LLVM?  pcc?  */
Line 65  enum outt {
Line 71  enum outt {
         OUTT_TREE,          OUTT_TREE,
         OUTT_HTML,          OUTT_HTML,
         OUTT_XHTML,          OUTT_XHTML,
         OUTT_LINT          OUTT_LINT,
           OUTT_PS,
           OUTT_PDF
 };  };
   
 struct  curparse {  struct  curparse {
Line 81  struct curparse {
Line 89  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 */
         struct roff      *roff;          struct roff      *roff;         /* roff parser (!NULL) */
         enum outt         outtype;      /* Output devices... */          struct regset     regs;         /* roff registers */
         out_mdoc          outmdoc;          enum outt         outtype;      /* which output to use */
         out_man           outman;          out_mdoc          outmdoc;      /* mdoc output ptr */
         out_free          outfree;          out_man           outman;       /* man output ptr */
         void             *outdata;          out_free          outfree;      /* free output ptr */
         char              outopts[BUFSIZ];          void             *outdata;      /* data for output */
           char              outopts[BUFSIZ]; /* buf of output opts */
 };  };
   
   static  const char * const      mandocerrs[MANDOCERR_MAX] = {
           "ok",
   
           "generic warning",
   
           "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",
           "tab in non-literal context",
           "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",
           "blocks badly nested",
           "scope open on exit",
   
           "generic error",
   
           "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",
           "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",
           "missing font type",
           "line argument(s) will be lost",
           "body argument(s) will be lost",
   
           "generic fatal error",
   
           "column syntax is inconsistent",
           "displays may not be nested",
           "unsupported display type",
           "blocks badly nested",
           "no such block is open",
           "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  struct roff      *roff_init(struct curparse *);  static  struct roff      *roff_init(struct curparse *);
 static  int               merr(void *, int, int, const char *); /* DEPRECATED */  
 static  int               moptions(enum intt *, char *);  static  int               moptions(enum intt *, char *);
 static  int               mwarn(void *, int, int, const char *); /* DEPRECATED */  
 static  int               mmsg(enum mandocerr, void *,  static  int               mmsg(enum mandocerr, void *,
                                 int, int, const char *);                                  int, int, const char *);
 static  int               pset(const char *, int, struct curparse *,  static  int               pset(const char *, int, struct curparse *,
Line 113  static void    version(void) __attribute__((noreturn))
Line 199  static void    version(void) __attribute__((noreturn))
 static  int               woptions(int *, char *);  static  int               woptions(int *, char *);
   
 static  const char       *progname;  static  const char       *progname;
 static  int               with_error;  static  int               with_fatal;
 static  int               with_warning;  static  int               with_error;
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
Line 177  main(int argc, char *argv[])
Line 263  main(int argc, char *argv[])
         while (*argv) {          while (*argv) {
                 ffile(*argv, &curp);                  ffile(*argv, &curp);
   
                 if (with_error && !(curp.fflags & FL_IGN_ERRORS))                  if (with_fatal && !(curp.fflags & FL_IGN_ERRORS))
                         break;                          break;
                 ++argv;                  ++argv;
         }          }
Line 191  main(int argc, char *argv[])
Line 277  main(int argc, char *argv[])
         if (curp.roff)          if (curp.roff)
                 roff_free(curp.roff);                  roff_free(curp.roff);
   
         return((with_warning || with_error) ?          return((with_fatal || with_error) ?
                         EXIT_FAILURE :  EXIT_SUCCESS);                          EXIT_FAILURE :  EXIT_SUCCESS);
 }  }
   
Line 220  static struct man *
Line 306  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 234  man_init(struct curparse *curp)
Line 316  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));
 }  }
   
   
Line 242  static struct roff *
Line 324  static struct roff *
 roff_init(struct curparse *curp)  roff_init(struct curparse *curp)
 {  {
   
         return(roff_alloc(mmsg, curp));          return(roff_alloc(&curp->regs, mmsg, curp));
 }  }
   
   
Line 250  static struct mdoc *
Line 332  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 266  mdoc_init(struct curparse *curp)
Line 344  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 277  ffile(const char *file, struct curparse *curp)
Line 355  ffile(const char *file, struct curparse *curp)
         curp->file = file;          curp->file = file;
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {          if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                 perror(curp->file);                  perror(curp->file);
                 with_error = 1;                  with_fatal = 1;
                 return;                  return;
         }          }
   
Line 318  read_whole_file(struct curparse *curp, struct buf *fb,
Line 396  read_whole_file(struct curparse *curp, struct buf *fb,
   
         if (-1 == fstat(curp->fd, &st)) {          if (-1 == fstat(curp->fd, &st)) {
                 perror(curp->file);                  perror(curp->file);
                 with_error = 1;                  with_fatal = 1;
                 return(0);                  return(0);
         }          }
   
Line 333  read_whole_file(struct curparse *curp, struct buf *fb,
Line 411  read_whole_file(struct curparse *curp, struct buf *fb,
                 if (st.st_size >= (1U << 31)) {                  if (st.st_size >= (1U << 31)) {
                         fprintf(stderr, "%s: input too large\n",                          fprintf(stderr, "%s: input too large\n",
                                         curp->file);                                          curp->file);
                         with_error = 1;                          with_fatal = 1;
                         return(0);                          return(0);
                 }                  }
                 *with_mmap = 1;                  *with_mmap = 1;
                 fb->sz = (size_t)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 377  read_whole_file(struct curparse *curp, struct buf *fb,
Line 455  read_whole_file(struct curparse *curp, struct buf *fb,
   
         free(fb->buf);          free(fb->buf);
         fb->buf = NULL;          fb->buf = NULL;
         with_error = 1;          with_fatal = 1;
         return(0);          return(0);
 }  }
   
Line 388  fdesc(struct curparse *curp)
Line 466  fdesc(struct curparse *curp)
         struct buf       ln, blk;          struct buf       ln, blk;
         int              i, pos, lnn, lnn_start, with_mmap, of;          int              i, pos, lnn, lnn_start, with_mmap, of;
         enum rofferr     re;          enum rofferr     re;
           unsigned char    c;
         struct man      *man;          struct man      *man;
         struct mdoc     *mdoc;          struct mdoc     *mdoc;
         struct roff     *roff;          struct roff     *roff;
Line 395  fdesc(struct curparse *curp)
Line 474  fdesc(struct curparse *curp)
         man = NULL;          man = NULL;
         mdoc = NULL;          mdoc = NULL;
         roff = NULL;          roff = NULL;
   
         memset(&ln, 0, sizeof(struct buf));          memset(&ln, 0, sizeof(struct buf));
   
         /*          /*
Line 419  fdesc(struct curparse *curp)
Line 499  fdesc(struct curparse *curp)
                                 ++lnn;                                  ++lnn;
                                 break;                                  break;
                         }                          }
   
                           /*
                            * Warn about bogus characters.  If you're using
                            * non-ASCII encoding, you're screwing your
                            * readers.  Since I'd rather this not happen,
                            * I'll be helpful and drop these characters so
                            * we don't display gibberish.  Note to manual
                            * writers: use special characters.
                            */
   
                           c = (unsigned char) blk.buf[i];
                           if ( ! (isascii(c) && (isgraph(c) || isblank(c)))) {
                                   if ( ! mmsg(MANDOCERR_BADCHAR, curp,
                                                   lnn_start, pos,
                                                   "ignoring byte"))
                                           goto bailout;
                                   i++;
                                   continue;
                           }
   
                         /* Trailing backslash is like a plain character. */                          /* Trailing backslash is like a plain character. */
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {                          if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                 if (pos >= (int)ln.sz)                                  if (pos >= (int)ln.sz)
Line 528  fdesc(struct curparse *curp)
Line 628  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_PDF):
                           curp->outdata = pdf_alloc(curp->outopts);
                           curp->outfree = pspdf_free;
                           break;
                   case (OUTT_PS):
                           curp->outdata = ps_alloc(curp->outopts);
                           curp->outfree = pspdf_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 542  fdesc(struct curparse *curp)
Line 660  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_PDF):
                         break;                          /* FALLTHROUGH */
                 default:                  case (OUTT_ASCII):
                         curp->outdata = ascii_alloc(80);                          /* FALLTHROUGH */
                   case (OUTT_PS):
                         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 561  fdesc(struct curparse *curp)
Line 681  fdesc(struct curparse *curp)
                 (*curp->outmdoc)(curp->outdata, mdoc);                  (*curp->outmdoc)(curp->outdata, mdoc);
   
  cleanup:   cleanup:
           memset(&curp->regs, 0, sizeof(struct regset));
         if (mdoc)          if (mdoc)
                 mdoc_reset(mdoc);                  mdoc_reset(mdoc);
         if (man)          if (man)
Line 577  fdesc(struct curparse *curp)
Line 698  fdesc(struct curparse *curp)
         return;          return;
   
  bailout:   bailout:
         with_error = 1;          with_fatal = 1;
         goto cleanup;          goto cleanup;
 }  }
   
Line 673  toptions(struct curparse *curp, char *arg)
Line 794  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 if (0 == strcmp(arg, "pdf"))
                   curp->outtype = OUTT_PDF;
         else {          else {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: Bad argument\n", arg);
                 return(0);                  return(0);
Line 756  woptions(int *wflags, char *arg)
Line 881  woptions(int *wflags, char *arg)
 }  }
   
   
 /* ARGSUSED */  
 static int  static int
 merr(void *arg, int line, int col, const char *msg)  
 {  
         struct curparse *curp;  
   
         curp = (struct curparse *)arg;  
   
         (void)fprintf(stderr, "%s:%d:%d: error: %s\n",  
                         curp->file, line, col + 1, msg);  
   
         with_error = 1;  
   
         return(0);  
 }  
   
   
 static int  
 mwarn(void *arg, int line, int col, const char *msg)  
 {  
         struct curparse *curp;  
   
         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;  
                 return(0);  
         }  
   
         return(1);  
 }  
   
 static  const char * const      mandocerrs[MANDOCERR_MAX] = {  
         "ok",  
         "multi-line scope open on exit",  
         "request for scope closure when no matching scope is open",  
         "macro requires line argument(s)",  
         "line arguments will be lost",  
         "memory exhausted"  
 };  
   
 /*  
  * XXX: this is experimental code that will eventually become the  
  * generic means of covering all warnings and errors!  
  */  
 /* ARGSUSED */  
 static int  
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)  mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
 {  {
 #if 0  
         struct curparse *cp;          struct curparse *cp;
           const char *level;
           int rc;
   
         cp = (struct curparse *)arg;          cp = (struct curparse *)arg;
           level = NULL;
           rc = 1;
   
         fprintf(stderr, "%s:%d:%d: %s", cp->file,          if (t >= MANDOCERR_FATAL) {
                         ln, col + 1, mandocerrs[t]);                  with_fatal = 1;
                   level = "FATAL";
                   rc = 0;
           } else {
                   if ( ! (WARN_WALL & cp->wflags))
                           return(1);
                   if (t >= MANDOCERR_ERROR) {
                           with_error = 1;
                           level = "ERROR";
                   }
                   if (WARN_WERR & cp->wflags) {
                           with_fatal = 1;
                           rc = 0;
                   }
           }
   
           fprintf(stderr, "%s:%d:%d:", cp->file, ln, col + 1);
           if (level)
                   fprintf(stderr, " %s:", level);
           fprintf(stderr, " %s", mandocerrs[t]);
         if (msg)          if (msg)
                 fprintf(stderr, ": %s", msg);                  fprintf(stderr, ": %s", msg);
   
         fputc('\n', stderr);          fputc('\n', stderr);
 #endif  
         return(1);          return(rc);
 }  }
Legend:
Removed from v.1.77  
changed lines
  Added in v.1.102
CVSweb