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

Diff for /mandoc/main.c between version 1.5 and 1.20

version 1.5, 2009/03/20 19:56:25 version 1.20, 2009/04/02 16:37:40
Line 27 
Line 27 
 #include <unistd.h>  #include <unistd.h>
   
 #include "mdoc.h"  #include "mdoc.h"
   #include "man.h"
   
   /* Account for FreeBSD and Linux in our declarations. */
   
 #ifdef __linux__  #ifdef __linux__
 extern  int               getsubopt(char **, char * const *, char **);  extern  int               getsubopt(char **, char * const *, char **);
 # ifndef __dead  # ifndef __dead
 #  define __dead __attribute__((__noreturn__))  #  define __dead __attribute__((__noreturn__))
 # endif  # endif
   #elif defined(__dead2)
   # ifndef __dead
   #  define __dead __dead2
   # endif
 #endif  #endif
   
 struct  buf {  struct  buf {
Line 40  struct buf {
Line 47  struct buf {
         size_t            sz;          size_t            sz;
 };  };
   
   enum    intt {
           INTT_AUTO,
           INTT_MDOC,
           INTT_MAN
   };
   
   enum    outt {
           OUTT_ASCII = 0,
           OUTT_TREE,
           OUTT_LINT
   };
   
 struct  curparse {  struct  curparse {
         const char       *file;          const char       *file;
           int               fd;
         int               wflags;          int               wflags;
 #define WARN_WALL         0x03          /* All-warnings mask. */  #define WARN_WALL         0x03          /* All-warnings mask. */
 #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */  #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */
 #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */  #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */  #define WARN_WERR        (1 << 2)       /* Warnings->errors. */
           int               fflags;
           enum intt         inttype;
           struct man       *man;
           struct mdoc      *mdoc;
 };  };
   
 enum outt {  #define IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */
         OUTT_ASCII,  #define IGN_ESCAPE       (1 << 1)       /* Ignore bad escapes. */
         OUTT_LATIN1,  #define IGN_MACRO        (1 << 2)       /* Ignore unknown macros. */
         OUTT_UTF8,  #define NO_IGN_MACRO     (1 << 3)
         OUTT_TREE,  
         OUTT_LINT  
 };  
   
 typedef int             (*out_run)(void *, const struct mdoc *);  typedef int             (*out_run)(void *, const struct man *,
                                   const struct mdoc *);
 typedef void            (*out_free)(void *);  typedef void            (*out_free)(void *);
   
 extern  char             *__progname;  extern  char             *__progname;
   
 extern  void             *ascii_alloc(void);  extern  void             *ascii_alloc(void);
 extern  void             *latin1_alloc(void);  extern  int               terminal_run(void *, const struct man *,
 extern  void             *utf8_alloc(void);                                  const struct mdoc *);
 extern  int               terminal_run(void *, const struct mdoc *);  extern  int               tree_run(void *, const struct man *,
 extern  int               tree_run(void *, const struct mdoc *);                                  const struct mdoc *);
 extern  void              terminal_free(void *);  extern  void              terminal_free(void *);
   
 __dead  static void       version(void);  
 __dead  static void       usage(void);  
 static  int               foptions(int *, char *);  static  int               foptions(int *, char *);
 static  int               toptions(enum outt *, char *);  static  int               toptions(enum outt *, char *);
   static  int               moptions(enum intt *, char *);
 static  int               woptions(int *, char *);  static  int               woptions(int *, char *);
 static  int               merr(void *, int, int, const char *);  static  int               merr(void *, int, int, const char *);
 static  int               mwarn(void *, int, int,  static  int               manwarn(void *, int, int, const char *);
   static  int               mdocwarn(void *, int, int,
                                 enum mdoc_warn, const char *);                                  enum mdoc_warn, const char *);
 static  int               file(struct buf *, struct buf *,  static  int               fstdin(struct buf *, struct buf *,
                                 const char *, struct mdoc *);                                  struct curparse *);
   static  int               ffile(struct buf *, struct buf *,
                                   const char *, struct curparse *);
 static  int               fdesc(struct buf *, struct buf *,  static  int               fdesc(struct buf *, struct buf *,
                                 const char *, int, struct mdoc *);                                  struct curparse *);
   static  int               pset(const char *, size_t, struct curparse *,
                                   struct man **, struct mdoc **);
   static  struct man       *man_init(struct curparse *);
   static  struct mdoc      *mdoc_init(struct curparse *);
   __dead  static void       version(void);
   __dead  static void       usage(void);
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc, fflags, wflags;          int              c, rc;
         struct mdoc_cb   cb;  
         struct mdoc     *mdoc;  
         void            *outdata;          void            *outdata;
         enum outt        outtype;          enum outt        outtype;
         struct buf       ln, blk;          struct buf       ln, blk;
Line 96  main(int argc, char *argv[])
Line 124  main(int argc, char *argv[])
         out_free         outfree;          out_free         outfree;
         struct curparse  curp;          struct curparse  curp;
   
         fflags = wflags = 0;  
         outtype = OUTT_ASCII;          outtype = OUTT_ASCII;
   
         bzero(&curp, sizeof(struct curparse));          bzero(&curp, sizeof(struct curparse));
   
           curp.inttype = INTT_AUTO;
   
         /* LINTED */          /* LINTED */
         while (-1 != (c = getopt(argc, argv, "f:VW:T:")))          while (-1 != (c = getopt(argc, argv, "f:m:VW:T:")))
                 switch (c) {                  switch (c) {
                 case ('f'):                  case ('f'):
                         if ( ! foptions(&fflags, optarg))                          if ( ! foptions(&curp.fflags, optarg))
                                 return(0);                                  return(0);
                         break;                          break;
                   case ('m'):
                           if ( ! moptions(&curp.inttype, optarg))
                                   return(0);
                           break;
                 case ('T'):                  case ('T'):
                         if ( ! toptions(&outtype, optarg))                          if ( ! toptions(&outtype, optarg))
                                 return(0);                                  return(0);
Line 128  main(int argc, char *argv[])
Line 161  main(int argc, char *argv[])
         argv += optind;          argv += optind;
   
         /*          /*
          * Allocate the appropriate front-end.  Note that utf8, ascii           * Allocate the appropriate front-end.  Note that utf8, latin1
          * and latin1 all resolve to the terminal front-end with           * (both not yet implemented) and ascii all resolve to the
          * different encodings (see terminal.c).  Not all frontends have           * terminal front-end with different encodings (see terminal.c).
          * cleanup or alloc routines.           * Not all frontends have cleanup or alloc routines.
          */           */
   
         switch (outtype) {          switch (outtype) {
         case (OUTT_LATIN1):  
                 outdata = latin1_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         case (OUTT_UTF8):  
                 outdata = utf8_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         case (OUTT_TREE):          case (OUTT_TREE):
                 outdata = NULL;                  outdata = NULL;
                 outrun = tree_run;                  outrun = tree_run;
Line 162  main(int argc, char *argv[])
Line 185  main(int argc, char *argv[])
                 break;                  break;
         }          }
   
         /*          /* Configure buffers. */
          * All callbacks route into here, where we print them onto the  
          * screen.  XXX - for now, no path for debugging messages.  
          */  
   
         cb.mdoc_msg = NULL;  
         cb.mdoc_err = merr;  
         cb.mdoc_warn = mwarn;  
   
         bzero(&ln, sizeof(struct buf));          bzero(&ln, sizeof(struct buf));
         bzero(&blk, sizeof(struct buf));          bzero(&blk, sizeof(struct buf));
   
         mdoc = mdoc_alloc(&curp, fflags, &cb);  
   
         /*          /*
          * Loop around available files.           * Main loop around available files.
          */           */
   
         if (NULL == *argv) {          if (NULL == *argv) {
                 curp.file = "<stdin>";  
                 c = fdesc(&blk, &ln, "stdin", STDIN_FILENO, mdoc);  
                 rc = 0;                  rc = 0;
                   c = fstdin(&blk, &ln, &curp);
   
                 if (c && NULL == outrun)                  if (c && NULL == outrun)
                         rc = 1;                          rc = 1;
                 else if (c && outrun && (*outrun)(outdata, mdoc))                  /*else if (c && outrun && (*outrun)(outdata, curp.man, curp.mdoc))
                         rc = 1;                          rc = 1;*/
         } else {          } else {
                 while (*argv) {                  while (*argv) {
                         curp.file = *argv;                          c = ffile(&blk, &ln, *argv, &curp);
                         c = file(&blk, &ln, *argv, mdoc);  
                         if ( ! c)                          if ( ! c)
                                 break;                                  break;
                         if (outrun && ! (*outrun)(outdata, mdoc))                          /*if (outrun && ! (*outrun)(outdata, curp.man, curp.mdoc))
                                   break;*/
                           if (curp.man)
                                   man_reset(curp.man);
                           if (curp.mdoc && ! mdoc_reset(curp.mdoc)) {
                                   warnx("memory exhausted");
                                 break;                                  break;
                         /* Reset the parser for another file. */                          }
                         mdoc_reset(mdoc);  
                         argv++;                          argv++;
                 }                  }
                 rc = NULL == *argv;                  rc = NULL == *argv;
Line 209  main(int argc, char *argv[])
Line 226  main(int argc, char *argv[])
                 free(ln.buf);                  free(ln.buf);
         if (outfree)          if (outfree)
                 (*outfree)(outdata);                  (*outfree)(outdata);
           if (curp.mdoc)
                   mdoc_free(curp.mdoc);
           if (curp.man)
                   man_free(curp.man);
   
         mdoc_free(mdoc);  
   
         return(rc ? EXIT_SUCCESS : EXIT_FAILURE);          return(rc ? EXIT_SUCCESS : EXIT_FAILURE);
 }  }
   
Line 221  version(void)
Line 240  version(void)
 {  {
   
         (void)printf("%s %s\n", __progname, VERSION);          (void)printf("%s %s\n", __progname, VERSION);
         exit(0);          exit(EXIT_SUCCESS);
         /* NOTREACHED */  
 }  }
   
   
Line 230  __dead static void
Line 248  __dead static void
 usage(void)  usage(void)
 {  {
   
         (void)fprintf(stderr, "usage: %s\n", __progname);          (void)fprintf(stderr, "usage: %s [-V] [-foption...] "
         exit(1);                          "[-mformat] [-Toutput] [-Werr...]\n",
         /* NOTREACHED */                          __progname);
           exit(EXIT_FAILURE);
 }  }
   
   
   static struct man *
   man_init(struct curparse *curp)
   {
           int              pflags;
           struct man      *man;
           struct man_cb    mancb;
   
           mancb.man_err = merr;
           mancb.man_warn = manwarn;
   
           /* Set command defaults. */
           pflags = MAN_IGN_MACRO;
   
           if (curp->fflags & IGN_MACRO)
                   pflags |= MAN_IGN_MACRO;
           if (curp->fflags & NO_IGN_MACRO)
                   pflags &= ~MAN_IGN_MACRO;
   
           if (NULL == (man = man_alloc(curp, pflags, &mancb)))
                   warnx("memory exhausted");
   
           return(man);
   }
   
   
   static struct mdoc *
   mdoc_init(struct curparse *curp)
   {
           int              pflags;
           struct mdoc     *mdoc;
           struct mdoc_cb   mdoccb;
   
           mdoccb.mdoc_msg = NULL;
           mdoccb.mdoc_err = merr;
           mdoccb.mdoc_warn = mdocwarn;
   
           pflags = 0;
   
           if (curp->fflags & IGN_SCOPE)
                   pflags |= MDOC_IGN_SCOPE;
           if (curp->fflags & IGN_ESCAPE)
                   pflags |= MDOC_IGN_ESCAPE;
           if (curp->fflags & IGN_MACRO)
                   pflags |= MDOC_IGN_MACRO;
   
           if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb)))
                   warnx("memory allocated");
   
           return(mdoc);
   }
   
   
 static int  static int
 file(struct buf *blk, struct buf *ln,  fstdin(struct buf *blk, struct buf *ln, struct curparse *curp)
                 const char *file, struct mdoc *mdoc)  
 {  {
         int              fd, c;  
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          curp->file = "<stdin>";
                 warn("%s", file);          curp->fd = STDIN_FILENO;
           return(fdesc(blk, ln, curp));
   }
   
   
   static int
   ffile(struct buf *blk, struct buf *ln,
                   const char *file, struct curparse *curp)
   {
           int              c;
   
           curp->file = file;
           if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                   warn("%s", curp->file);
                 return(0);                  return(0);
         }          }
   
         c = fdesc(blk, ln, file, fd, mdoc);          c = fdesc(blk, ln, curp);
   
         if (-1 == close(fd))          if (-1 == close(curp->fd))
                 warn("%s", file);                  warn("%s", curp->file);
   
         return(c);          return(c);
 }  }
   
   
 static int  static int
 fdesc(struct buf *blk, struct buf *ln,  fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
                 const char *f, int fd, struct mdoc *mdoc)  
 {  {
         size_t           sz;          size_t           sz;
         ssize_t          ssz;          ssize_t          ssz;
         struct stat      st;          struct stat      st;
         int              j, i, pos, lnn;          int              j, i, pos, lnn;
           struct man      *man;
           struct mdoc     *mdoc;
   
           sz = BUFSIZ;
           man = NULL;
           mdoc = NULL;
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer, optimised           * Two buffers: ln and buf.  buf is the input buffer optimised
          * for each file's block size.  ln is a line buffer.  Both           * here for each file's block size.  ln is a line buffer.  Both
          * growable, hence passed in by ptr-ptr.           * growable, hence passed in by ptr-ptr.
          */           */
   
         if (-1 == fstat(fd, &st)) {          if (-1 == fstat(curp->fd, &st))
                 warnx("%s", f);                  warnx("%s", curp->file);
                 sz = BUFSIZ;          else if ((size_t)st.st_blksize > sz)
         } else                  sz = st.st_blksize;
                 sz = (unsigned)BUFSIZ > st.st_blksize ?  
                         (size_t)BUFSIZ : st.st_blksize;  
   
         if (sz > blk->sz) {          if (sz > blk->sz) {
                 blk->buf = realloc(blk->buf, sz);                  blk->buf = realloc(blk->buf, sz);
                 if (NULL == blk->buf)                  if (NULL == blk->buf) {
                         err(1, "realloc");                          warn("realloc");
                           return(0);
                   }
                 blk->sz = sz;                  blk->sz = sz;
         }          }
   
         /*          /* Fill buf with file blocksize. */
          * Fill buf with file blocksize and parse newlines into ln.  
          */  
   
         for (lnn = 1, pos = 0; ; ) {          for (lnn = 0, pos = 0; ; ) {
                 if (-1 == (ssz = read(fd, blk->buf, sz))) {                  if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {
                         warn("%s", f);                          warn("%s", curp->file);
                         return(0);                          return(0);
                 } else if (0 == ssz)                  } else if (0 == ssz)
                         break;                          break;
   
                   /* Parse the read block into partial or full lines. */
   
                 for (i = 0; i < (int)ssz; i++) {                  for (i = 0; i < (int)ssz; i++) {
                         if (pos >= (int)ln->sz) {                          if (pos >= (int)ln->sz) {
                                 ln->sz += 256; /* Step-size. */                                  ln->sz += 256; /* Step-size. */
                                 ln->buf = realloc(ln->buf, ln->sz);                                  ln->buf = realloc(ln->buf, ln->sz);
                                 if (NULL == ln->buf)                                  if (NULL == ln->buf) {
                                         err(1, "realloc");                                          warn("realloc");
                                           return(0);
                                   }
                         }                          }
   
                         if ('\n' != blk->buf[i]) {                          if ('\n' != blk->buf[i]) {
Line 324  fdesc(struct buf *blk, struct buf *ln,
Line 413  fdesc(struct buf *blk, struct buf *ln,
                         }                          }
   
                         ln->buf[pos] = 0;                          ln->buf[pos] = 0;
                         if ( ! mdoc_parseln(mdoc, lnn, ln->buf))  
                                 return(0);  
                         lnn++;                          lnn++;
   
                           /*
                            * If no manual parser has been assigned, then
                            * try to assign one in pset(), which may do
                            * nothing at all.  After this, parse the manual
                            * line accordingly.
                            */
   
                           if ( ! (man || mdoc) && ! pset(ln->buf,
                                                   pos, curp, &man, &mdoc))
                                   return(0);
   
                         pos = 0;                          pos = 0;
   
                           if (man && ! man_parseln(man, lnn, ln->buf))
                                   return(0);
                           if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))
                                   return(0);
                 }                  }
         }          }
   
         return(mdoc_endparse(mdoc));          /* Note that a parser may not have been assigned, yet. */
   
           if (mdoc)
                  return(mdoc_endparse(mdoc));
           if (man)
                   return(man_endparse(man));
   
           warnx("%s: not a manual", curp->file);
           return(0);
 }  }
   
   
 static int  static int
   pset(const char *buf, size_t pos, struct curparse *curp,
                   struct man **man, struct mdoc **mdoc)
   {
   
           /*
            * Try to intuit which kind of manual parser should be used.  If
            * passed in by command-line (-man, -mdoc), then use that
            * explicitly.  If passed as -mandoc, then try to guess from the
            * line: either skip comments, use -mdoc when finding `.Dt', or
            * default to -man, which is more lenient.
            */
   
           if (pos >= 3 && 0 == memcmp(buf, ".\\\"", 3))
                   return(1);
   
           switch (curp->inttype) {
           case (INTT_MDOC):
                   if (NULL == curp->mdoc)
                           curp->mdoc = mdoc_init(curp);
                   if (NULL == (*mdoc = curp->mdoc))
                           return(0);
                   warnx("inheriting -mdoc parser");
                   return(1);
           case (INTT_MAN):
                   if (NULL == curp->man)
                           curp->man = man_init(curp);
                   if (NULL == (*man = curp->man))
                           return(0);
                   warnx("inheriting -man parser");
                   return(1);
           default:
                   break;
           }
   
           if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {
                   if (NULL == curp->mdoc)
                           curp->mdoc = mdoc_init(curp);
                   if (NULL == (*mdoc = curp->mdoc))
                           return(0);
                   return(1);
           }
   
           if (NULL == curp->man)
                   curp->man = man_init(curp);
           if (NULL == (*man = curp->man))
                   return(0);
           return(1);
   }
   
   
   static int
   moptions(enum intt *tflags, char *arg)
   {
   
           if (0 == strcmp(arg, "doc"))
                   *tflags = INTT_MDOC;
           else if (0 == strcmp(arg, "andoc"))
                   *tflags = INTT_AUTO;
           else if (0 == strcmp(arg, "an"))
                   *tflags = INTT_MAN;
           else {
                   warnx("bad argument: -m%s", arg);
                   return(0);
           }
   
           return(1);
   }
   
   
   static int
 toptions(enum outt *tflags, char *arg)  toptions(enum outt *tflags, char *arg)
 {  {
   
         if (0 == strcmp(arg, "ascii"))          if (0 == strcmp(arg, "ascii"))
                 *tflags = OUTT_ASCII;                  *tflags = OUTT_ASCII;
         else if (0 == strcmp(arg, "latin1"))  
                 *tflags = OUTT_LATIN1;  
         else if (0 == strcmp(arg, "utf8"))  
                 *tflags = OUTT_UTF8;  
         else if (0 == strcmp(arg, "lint"))          else if (0 == strcmp(arg, "lint"))
                 *tflags = OUTT_LINT;                  *tflags = OUTT_LINT;
         else if (0 == strcmp(arg, "tree"))          else if (0 == strcmp(arg, "tree"))
Line 366  static int
Line 544  static int
 foptions(int *fflags, char *arg)  foptions(int *fflags, char *arg)
 {  {
         char            *v;          char            *v;
         char            *toks[4];          char            *toks[5];
   
         toks[0] = "ign-scope";          toks[0] = "ign-scope";
         toks[1] = "ign-escape";          toks[1] = "ign-escape";
         toks[2] = "ign-macro";          toks[2] = "ign-macro";
         toks[3] = NULL;          toks[4] = "no-ign-macro";
           toks[5] = NULL;
   
         while (*arg)          while (*arg)
                 switch (getsubopt(&arg, toks, &v)) {                  switch (getsubopt(&arg, toks, &v)) {
                 case (0):                  case (0):
                         *fflags |= MDOC_IGN_SCOPE;                          *fflags |= IGN_SCOPE;
                         break;                          break;
                 case (1):                  case (1):
                         *fflags |= MDOC_IGN_ESCAPE;                          *fflags |= IGN_ESCAPE;
                         break;                          break;
                 case (2):                  case (2):
                         *fflags |= MDOC_IGN_MACRO;                          *fflags |= IGN_MACRO;
                         break;                          break;
                   case (3):
                           *fflags |= NO_IGN_MACRO;
                           break;
                 default:                  default:
                         warnx("bad argument: -f%s", arg);                          warnx("bad argument: -f%s", arg);
                         return(0);                          return(0);
Line 447  merr(void *arg, int line, int col, const char *msg)
Line 629  merr(void *arg, int line, int col, const char *msg)
   
   
 static int  static int
 mwarn(void *arg, int line, int col,  mdocwarn(void *arg, int line, int col,
                 enum mdoc_warn type, const char *msg)                  enum mdoc_warn type, const char *msg)
 {  {
         struct curparse *curp;          struct curparse *curp;
Line 482  mwarn(void *arg, int line, int col, 
Line 664  mwarn(void *arg, int line, int col, 
 }  }
   
   
   static int
   manwarn(void *arg, int line, int col, const char *msg)
   {
           struct curparse *curp;
   
           curp = (struct curparse *)arg;
   
           if ( ! (curp->wflags & WARN_WSYNTAX))
                   return(1);
   
           warnx("%s:%d: syntax warning: %s (column %d)",
                           curp->file, line, msg, col);
   
           if ( ! (curp->wflags & WARN_WERR))
                   return(1);
   
           warnx("%s: considering warnings as errors",
                           __progname);
           return(0);
   }
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.20
CVSweb