/* $Id$ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the * above copyright notice and this permission notice appear in all * copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ #include #include #include #include #include #include #include #include #include "mdoc.h" #include "man.h" #ifdef __linux__ extern int getsubopt(char **, char * const *, char **); # ifndef __dead # define __dead __attribute__((__noreturn__)) # endif #elif defined(__FreeBSD__) # ifndef __dead # define __dead __dead2 # endif #endif struct buf { char *buf; size_t sz; }; struct curparse { const char *file; int wflags; #define WARN_WALL 0x03 /* All-warnings mask. */ #define WARN_WCOMPAT (1 << 0) /* Compatibility warnings. */ #define WARN_WSYNTAX (1 << 1) /* Syntax warnings. */ #define WARN_WERR (1 << 2) /* Warnings->errors. */ }; enum intt { INTT_MDOC = 0, INTT_MAN }; enum outt { OUTT_ASCII = 0, OUTT_LATIN1, OUTT_UTF8, OUTT_TREE, OUTT_LINT }; typedef int (*out_run)(void *, const struct mdoc *); typedef void (*out_free)(void *); extern char *__progname; extern void *ascii_alloc(void); extern void *latin1_alloc(void); extern void *utf8_alloc(void); extern int terminal_run(void *, const struct mdoc *); extern int tree_run(void *, const struct mdoc *); extern void terminal_free(void *); static int foptions(int *, char *); static int toptions(enum outt *, char *); static int moptions(enum intt *, char *); static int woptions(int *, char *); static int merr(void *, int, int, const char *); static int mwarn(void *, int, int, enum mdoc_warn, const char *); static int file(struct buf *, struct buf *, const char *, struct man *, struct mdoc *); static int fdesc(struct buf *, struct buf *, const char *, int, struct man *, struct mdoc *); __dead static void version(void); __dead static void usage(void); int main(int argc, char *argv[]) { int c, rc, fflags; struct mdoc_cb cb; struct man *man; struct mdoc *mdoc; void *outdata; enum outt outtype; enum intt inttype; struct buf ln, blk; out_run outrun; out_free outfree; struct curparse curp; fflags = 0; outtype = OUTT_ASCII; inttype = INTT_MDOC; bzero(&curp, sizeof(struct curparse)); /* LINTED */ while (-1 != (c = getopt(argc, argv, "f:m:VW:T:"))) switch (c) { case ('f'): if ( ! foptions(&fflags, optarg)) return(0); break; case ('m'): if ( ! moptions(&inttype, optarg)) return(0); break; case ('T'): if ( ! toptions(&outtype, optarg)) return(0); break; case ('W'): if ( ! woptions(&curp.wflags, optarg)) return(0); break; case ('V'): version(); /* NOTREACHED */ default: usage(); /* NOTREACHED */ } argc -= optind; argv += optind; /* * Allocate the appropriate front-end. Note that utf8, ascii * and latin1 all resolve to the terminal front-end with * different encodings (see terminal.c). Not all frontends have * cleanup or alloc routines. */ 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): outdata = NULL; outrun = tree_run; outfree = NULL; break; case (OUTT_LINT): outdata = NULL; outrun = NULL; outfree = NULL; break; default: outdata = ascii_alloc(); outrun = terminal_run; outfree = terminal_free; break; } /* * 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(&blk, sizeof(struct buf)); man = NULL; mdoc = NULL; switch (inttype) { case (INTT_MAN): man = man_alloc(); break; default: mdoc = mdoc_alloc(&curp, fflags, &cb); break; } /* * Loop around available files. */ if (NULL == *argv) { curp.file = ""; rc = 0; c = fdesc(&blk, &ln, "stdin", STDIN_FILENO, man, mdoc); if (c && NULL == outrun) rc = 1; #if 0 else if (c && outrun && (*outrun)(outdata, mdoc)) rc = 1; #endif } else { while (*argv) { curp.file = *argv; c = file(&blk, &ln, *argv, man, mdoc); if ( ! c) break; #if 0 if (outrun && ! (*outrun)(outdata, mdoc)) break; #endif if (man) man_reset(man); if (mdoc) mdoc_reset(mdoc); argv++; } rc = NULL == *argv; } if (blk.buf) free(blk.buf); if (ln.buf) free(ln.buf); if (outfree) (*outfree)(outdata); if (mdoc) mdoc_free(mdoc); if (man) man_free(man); return(rc ? EXIT_SUCCESS : EXIT_FAILURE); } __dead static void version(void) { (void)printf("%s %s\n", __progname, VERSION); exit(0); /* NOTREACHED */ } __dead static void usage(void) { (void)fprintf(stderr, "usage: %s\n", __progname); exit(1); /* NOTREACHED */ } static int file(struct buf *blk, struct buf *ln, const char *file, struct man *man, struct mdoc *mdoc) { int fd, c; if (-1 == (fd = open(file, O_RDONLY, 0))) { warn("%s", file); return(0); } c = fdesc(blk, ln, file, fd, man, mdoc); if (-1 == close(fd)) warn("%s", file); return(c); } static int fdesc(struct buf *blk, struct buf *ln, const char *f, int fd, struct man *man, struct mdoc *mdoc) { size_t sz; ssize_t ssz; struct stat st; int j, i, pos, lnn; assert( ! (man && mdoc)); /* * Two buffers: ln and buf. buf is the input buffer, optimised * for each file's block size. ln is a line buffer. Both * growable, hence passed in by ptr-ptr. */ sz = BUFSIZ; if (-1 == fstat(fd, &st)) warnx("%s", f); else if ((size_t)st.st_blksize > sz) sz = st.st_blksize; if (sz > blk->sz) { blk->buf = realloc(blk->buf, sz); if (NULL == blk->buf) err(1, "realloc"); blk->sz = sz; } /* * Fill buf with file blocksize and parse newlines into ln. */ for (lnn = 1, pos = 0; ; ) { if (-1 == (ssz = read(fd, blk->buf, sz))) { warn("%s", f); return(0); } else if (0 == ssz) break; for (i = 0; i < (int)ssz; i++) { if (pos >= (int)ln->sz) { ln->sz += 256; /* Step-size. */ ln->buf = realloc(ln->buf, ln->sz); if (NULL == ln->buf) err(1, "realloc"); } if ('\n' != blk->buf[i]) { ln->buf[pos++] = blk->buf[i]; continue; } /* Check for CPP-escaped newline. */ if (pos > 0 && '\\' == ln->buf[pos - 1]) { for (j = pos - 1; j >= 0; j--) if ('\\' != ln->buf[j]) break; if ( ! ((pos - j) % 2)) { pos--; lnn++; continue; } } ln->buf[pos] = 0; if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf)) return(0); if (man && ! man_parseln(man, lnn, ln->buf)) return(0); lnn++; pos = 0; } } if (mdoc) return(mdoc_endparse(mdoc)); return(man_endparse(man)); } static int moptions(enum intt *tflags, char *arg) { if (0 == strcmp(arg, "mdoc")) *tflags = INTT_MDOC; else if (0 == strcmp(arg, "man")) *tflags = INTT_MAN; else { warnx("bad argument: -m%s", arg); return(0); } return(1); } static int toptions(enum outt *tflags, char *arg) { if (0 == strcmp(arg, "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")) *tflags = OUTT_LINT; else if (0 == strcmp(arg, "tree")) *tflags = OUTT_TREE; else { warnx("bad argument: -T%s", arg); return(0); } return(1); } /* * Parse out the options for [-fopt...] setting compiler options. These * can be comma-delimited or called again. */ static int foptions(int *fflags, char *arg) { char *v; char *toks[4]; toks[0] = "ign-scope"; toks[1] = "ign-escape"; toks[2] = "ign-macro"; toks[3] = NULL; while (*arg) switch (getsubopt(&arg, toks, &v)) { case (0): *fflags |= MDOC_IGN_SCOPE; break; case (1): *fflags |= MDOC_IGN_ESCAPE; break; case (2): *fflags |= MDOC_IGN_MACRO; break; default: warnx("bad argument: -f%s", arg); return(0); } return(1); } /* * Parse out the options for [-Werr...], which sets warning modes. * These can be comma-delimited or called again. */ static int woptions(int *wflags, char *arg) { char *v; char *toks[5]; toks[0] = "all"; toks[1] = "compat"; toks[2] = "syntax"; toks[3] = "error"; toks[4] = NULL; while (*arg) switch (getsubopt(&arg, toks, &v)) { case (0): *wflags |= WARN_WALL; break; case (1): *wflags |= WARN_WCOMPAT; break; case (2): *wflags |= WARN_WSYNTAX; break; case (3): *wflags |= WARN_WERR; break; default: warnx("bad argument: -W%s", arg); return(0); } return(1); } /* ARGSUSED */ static int merr(void *arg, int line, int col, const char *msg) { struct curparse *curp; curp = (struct curparse *)arg; warnx("%s:%d: error: %s (column %d)", curp->file, line, msg, col); return(0); } static int mwarn(void *arg, int line, int col, enum mdoc_warn type, const char *msg) { struct curparse *curp; char *wtype; curp = (struct curparse *)arg; wtype = NULL; switch (type) { case (WARN_COMPAT): wtype = "compat"; if (curp->wflags & WARN_WCOMPAT) break; return(1); case (WARN_SYNTAX): wtype = "syntax"; if (curp->wflags & WARN_WSYNTAX) break; return(1); } assert(wtype); warnx("%s:%d: %s warning: %s (column %d)", curp->file, line, wtype, msg, col); if ( ! (curp->wflags & WARN_WERR)) return(1); warnx("%s: considering warnings as errors", __progname); return(0); }