=================================================================== RCS file: /cvs/mandoc/main.c,v retrieving revision 1.83 retrieving revision 1.216 diff -u -p -r1.83 -r1.216 --- mandoc/main.c 2010/06/06 20:44:53 1.83 +++ mandoc/main.c 2015/01/16 21:15:05 1.216 @@ -1,6 +1,8 @@ -/* $Id: main.c,v 1.83 2010/06/06 20:44:53 joerg Exp $ */ +/* $Id: main.c,v 1.216 2015/01/16 21:15:05 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze + * Copyright (c) 2010 Joerg Sonnenberger * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,14 +16,14 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif -#include -#include +#include +#include /* MACHINE */ #include +#include +#include #include #include #include @@ -30,161 +32,113 @@ #include #include "mandoc.h" +#include "mandoc_aux.h" +#include "main.h" #include "mdoc.h" #include "man.h" -#include "roff.h" -#include "main.h" +#include "manpath.h" +#include "mansearch.h" -#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) - -/* FIXME: Intel's compiler? LLVM? pcc? */ - #if !defined(__GNUC__) || (__GNUC__ < 2) # if !defined(lint) # define __attribute__(x) # endif #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */ +enum outmode { + OUTMODE_DEF = 0, + OUTMODE_FLN, + OUTMODE_LST, + OUTMODE_ALL, + OUTMODE_INT, + OUTMODE_ONE +}; + typedef void (*out_mdoc)(void *, const struct mdoc *); typedef void (*out_man)(void *, const struct man *); typedef void (*out_free)(void *); -struct buf { - char *buf; - size_t sz; -}; - -enum intt { - INTT_AUTO, - INTT_MDOC, - INTT_MAN -}; - enum outt { - OUTT_ASCII = 0, - OUTT_TREE, - OUTT_HTML, - OUTT_XHTML, - OUTT_LINT + OUTT_ASCII = 0, /* -Tascii */ + OUTT_LOCALE, /* -Tlocale */ + OUTT_UTF8, /* -Tutf8 */ + OUTT_TREE, /* -Ttree */ + OUTT_MAN, /* -Tman */ + OUTT_HTML, /* -Thtml */ + OUTT_LINT, /* -Tlint */ + OUTT_PS, /* -Tps */ + OUTT_PDF /* -Tpdf */ }; struct curparse { - const char *file; /* Current parse. */ - int fd; /* Current parse. */ - int wflags; - /* FIXME: set by max error */ -#define WARN_WALL (1 << 0) /* All-warnings mask. */ -#define WARN_WERR (1 << 2) /* Warnings->errors. */ - int fflags; -#define FL_IGN_SCOPE (1 << 0) /* Ignore scope errors. */ -#define FL_NIGN_ESCAPE (1 << 1) /* Don't ignore bad escapes. */ -#define FL_NIGN_MACRO (1 << 2) /* Don't ignore bad macros. */ -#define FL_IGN_ERRORS (1 << 4) /* Ignore failed parse. */ -#define FL_STRICT FL_NIGN_ESCAPE | \ - FL_NIGN_MACRO /* ignore nothing */ - enum intt inttype; /* which parser to use */ - struct man *man; /* man parser */ - struct mdoc *mdoc; /* mdoc parser */ - struct roff *roff; /* roff parser (!NULL) */ - enum outt outtype; /* which output to use */ + struct mparse *mp; + struct mchars *mchars; /* character table */ + enum mandoclevel wlevel; /* ignore messages below this */ + int wstop; /* stop after a file with a warning */ + enum outt outtype; /* which output to use */ out_mdoc outmdoc; /* mdoc output ptr */ - out_man outman; /* man output ptr */ + out_man outman; /* man output ptr */ 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", - "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", - "line argument(s) will be lost", - "body argument(s) will be lost", - "column syntax is inconsistent", - "missing font type", - "missing display type", - "displays may not be nested", - "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 ffile(const char *, struct curparse *); -static int foptions(int *, char *); -static struct man *man_init(struct curparse *); -static struct mdoc *mdoc_init(struct curparse *); -static struct roff *roff_init(struct curparse *); -static int moptions(enum intt *, char *); -static int mmsg(enum mandocerr, void *, - int, int, const char *); -static int pset(const char *, int, struct curparse *, - struct man **, struct mdoc **); +#if HAVE_SQLITE3 +static int fs_lookup(const struct manpaths *, + size_t ipath, const char *, + const char *, const char *, + struct manpage **, size_t *); +static void fs_search(const struct mansearch *, + const struct manpaths *, int, char**, + struct manpage **, size_t *); +#endif +static int koptions(int *, char *); +#if HAVE_SQLITE3 +int mandocdb(int, char**); +#endif +static int moptions(int *, char *); +static void mmsg(enum mandocerr, enum mandoclevel, + const char *, int, int, const char *); +static void parse(struct curparse *, int, + const char *, enum mandoclevel *); +#if HAVE_SQLITE3 +static enum mandoclevel passthrough(const char *, int, int); +#endif +static void spawn_pager(void); static int toptions(struct curparse *, char *); -static void usage(void) __attribute__((noreturn)); +static void usage(enum argmode) __attribute__((noreturn)); static void version(void) __attribute__((noreturn)); -static int woptions(int *, char *); +static int woptions(struct curparse *, char *); +static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9}; +static char help_arg[] = "help"; +static char *help_argv[] = {help_arg, NULL}; static const char *progname; -static int with_error; -static int with_warning; + int main(int argc, char *argv[]) { - int c; struct curparse curp; + struct mansearch search; + struct manpaths paths; + char *auxpaths; + char *defos; + unsigned char *uc; +#if HAVE_SQLITE3 + struct manpage *res, *resp; + char *conf_file, *defpaths; + size_t isec, i, sz; + int prio, best_prio, synopsis_only; + char sec; +#endif + enum mandoclevel rc, rctmp; + enum outmode outmode; + int fd; + int show_usage; + int use_pager; + int options; + int c; progname = strrchr(argv[0], '/'); if (progname == NULL) @@ -192,423 +146,590 @@ main(int argc, char *argv[]) else ++progname; +#if HAVE_SQLITE3 + if (strcmp(progname, BINM_MAKEWHATIS) == 0) + return(mandocdb(argc, argv)); +#endif + + /* Search options. */ + + memset(&paths, 0, sizeof(struct manpaths)); +#if HAVE_SQLITE3 + conf_file = defpaths = NULL; +#endif + auxpaths = NULL; + + memset(&search, 0, sizeof(struct mansearch)); + search.outkey = "Nd"; + + if (strcmp(progname, BINM_MAN) == 0) + search.argmode = ARG_NAME; + else if (strcmp(progname, BINM_APROPOS) == 0) + search.argmode = ARG_EXPR; + else if (strcmp(progname, BINM_WHATIS) == 0) + search.argmode = ARG_WORD; + else if (strncmp(progname, "help", 4) == 0) + search.argmode = ARG_NAME; + else + search.argmode = ARG_FILE; + + /* Parser and formatter options. */ + memset(&curp, 0, sizeof(struct curparse)); + curp.outtype = OUTT_LOCALE; + curp.wlevel = MANDOCLEVEL_BADARG; + options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; + defos = NULL; - curp.inttype = INTT_AUTO; - curp.outtype = OUTT_ASCII; + use_pager = 1; + show_usage = 0; +#if HAVE_SQLITE3 + synopsis_only = 0; +#endif + outmode = OUTMODE_DEF; - /* LINTED */ - while (-1 != (c = getopt(argc, argv, "f:m:O:T:VW:"))) + while (-1 != (c = getopt(argc, argv, + "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) { switch (c) { - case ('f'): - if ( ! foptions(&curp.fflags, optarg)) - return(EXIT_FAILURE); + case 'a': + outmode = OUTMODE_ALL; break; - case ('m'): - if ( ! moptions(&curp.inttype, optarg)) - return(EXIT_FAILURE); + case 'C': +#if HAVE_SQLITE3 + conf_file = optarg; +#endif break; - case ('O'): + case 'c': + use_pager = 0; + break; + case 'f': + search.argmode = ARG_WORD; + break; + case 'h': + (void)strlcat(curp.outopts, "synopsis,", BUFSIZ); +#if HAVE_SQLITE3 + synopsis_only = 1; +#endif + use_pager = 0; + outmode = OUTMODE_ALL; + break; + case 'I': + if (strncmp(optarg, "os=", 3)) { + fprintf(stderr, + "%s: -I %s: Bad argument\n", + progname, optarg); + return((int)MANDOCLEVEL_BADARG); + } + if (defos) { + fprintf(stderr, + "%s: -I %s: Duplicate argument\n", + progname, optarg); + return((int)MANDOCLEVEL_BADARG); + } + defos = mandoc_strdup(optarg + 3); + break; + case 'i': + outmode = OUTMODE_INT; + break; + case 'K': + if ( ! koptions(&options, optarg)) + return((int)MANDOCLEVEL_BADARG); + break; + case 'k': + search.argmode = ARG_EXPR; + break; + case 'l': + search.argmode = ARG_FILE; + outmode = OUTMODE_ALL; + break; + case 'M': +#if HAVE_SQLITE3 + defpaths = optarg; +#endif + break; + case 'm': + auxpaths = optarg; + break; + case 'O': + search.outkey = optarg; (void)strlcat(curp.outopts, optarg, BUFSIZ); (void)strlcat(curp.outopts, ",", BUFSIZ); break; - case ('T'): + case 'S': + search.arch = optarg; + break; + case 's': + search.sec = optarg; + break; + case 'T': if ( ! toptions(&curp, optarg)) - return(EXIT_FAILURE); + return((int)MANDOCLEVEL_BADARG); break; - case ('W'): - if ( ! woptions(&curp.wflags, optarg)) - return(EXIT_FAILURE); + case 'W': + if ( ! woptions(&curp, optarg)) + return((int)MANDOCLEVEL_BADARG); break; - case ('V'): + case 'w': + outmode = OUTMODE_FLN; + break; + case 'V': version(); /* NOTREACHED */ default: - usage(); - /* NOTREACHED */ + show_usage = 1; + break; } + } + if (show_usage) + usage(search.argmode); + + /* Postprocess options. */ + + if (outmode == OUTMODE_DEF) { + switch (search.argmode) { + case ARG_FILE: + outmode = OUTMODE_ALL; + use_pager = 0; + break; + case ARG_NAME: + outmode = OUTMODE_ONE; + break; + default: + outmode = OUTMODE_LST; + break; + } + } + + /* Parse arguments. */ + argc -= optind; argv += optind; +#if HAVE_SQLITE3 + resp = NULL; +#endif - if (NULL == *argv) { - curp.file = ""; - curp.fd = STDIN_FILENO; + /* + * Quirks for help(1) + * and for a man(1) section argument without -s. + */ - fdesc(&curp); + if (search.argmode == ARG_NAME) { + if (*progname == 'h') { + if (argc == 0) { + argv = help_argv; + argc = 1; + } + } else if (argc > 1 && + ((uc = argv[0]) != NULL) && + ((isdigit(uc[0]) && (uc[1] == '\0' || + (isalpha(uc[1]) && uc[2] == '\0'))) || + (uc[0] == 'n' && uc[1] == '\0'))) { + search.sec = uc; + argv++; + argc--; + } + if (search.arch == NULL) + search.arch = getenv("MACHINE"); + if (search.arch == NULL) + search.arch = MACHINE; } - while (*argv) { - ffile(*argv, &curp); + rc = MANDOCLEVEL_OK; - if (with_error && !(curp.fflags & FL_IGN_ERRORS)) - break; - ++argv; - } + /* man(1), whatis(1), apropos(1) */ - if (curp.outfree) - (*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); + if (search.argmode != ARG_FILE) { +#if HAVE_SQLITE3 + if (argc == 0) + usage(search.argmode); - return((with_warning || with_error) ? - EXIT_FAILURE : EXIT_SUCCESS); -} + if (search.argmode == ARG_NAME && + outmode == OUTMODE_ONE) + search.firstmatch = 1; + /* Access the mandoc database. */ -static void -version(void) -{ + manpath_parse(&paths, conf_file, defpaths, auxpaths); + mansearch_setup(1); + if( ! mansearch(&search, &paths, argc, argv, &res, &sz)) + usage(search.argmode); - (void)printf("%s %s\n", progname, VERSION); - exit(EXIT_SUCCESS); -} + if (sz == 0 && search.argmode == ARG_NAME) + fs_search(&search, &paths, argc, argv, &res, &sz); + if (sz == 0) { + rc = MANDOCLEVEL_BADARG; + goto out; + } -static void -usage(void) -{ + /* + * For standard man(1) and -a output mode, + * prepare for copying filename pointers + * into the program parameter array. + */ - (void)fprintf(stderr, "usage: %s [-V] [-foption] " - "[-mformat] [-Ooption] [-Toutput] " - "[-Werr] [file...]\n", progname); - exit(EXIT_FAILURE); -} + if (outmode == OUTMODE_ONE) { + argc = 1; + best_prio = 10; + } else if (outmode == OUTMODE_ALL) + argc = (int)sz; + /* Iterate all matching manuals. */ -static struct man * -man_init(struct curparse *curp) -{ - int pflags; + resp = res; + for (i = 0; i < sz; i++) { + if (outmode == OUTMODE_FLN) + puts(res[i].file); + else if (outmode == OUTMODE_LST) + printf("%s - %s\n", res[i].names, + res[i].output == NULL ? "" : + res[i].output); + else if (outmode == OUTMODE_ONE) { + /* Search for the best section. */ + isec = strcspn(res[i].file, "123456789"); + sec = res[i].file[isec]; + if ('\0' == sec) + continue; + prio = sec_prios[sec - '1']; + if (prio >= best_prio) + continue; + best_prio = prio; + resp = res + i; + } + } - /* Defaults from mandoc.1. */ + /* + * For man(1), -a and -i output mode, fall through + * to the main mandoc(1) code iterating files + * and running the parsers on each of them. + */ - pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE; + if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) + goto out; +#else + fputs("mandoc: database support not compiled in\n", + stderr); + return((int)MANDOCLEVEL_BADARG); +#endif + } - if (curp->fflags & FL_NIGN_MACRO) - pflags &= ~MAN_IGN_MACRO; - if (curp->fflags & FL_NIGN_ESCAPE) - pflags &= ~MAN_IGN_ESCAPE; + /* mandoc(1) */ - return(man_alloc(curp, pflags, mmsg)); -} + if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths)) + return((int)MANDOCLEVEL_BADARG); + curp.mchars = mchars_alloc(); + curp.mp = mparse_alloc(options, curp.wlevel, mmsg, + curp.mchars, defos); -static struct roff * -roff_init(struct curparse *curp) -{ + /* + * Conditionally start up the lookaside buffer before parsing. + */ + if (OUTT_MAN == curp.outtype) + mparse_keep(curp.mp); - return(roff_alloc(mmsg, curp)); -} + if (argc == 0) { + if (use_pager && isatty(STDOUT_FILENO)) + spawn_pager(); + parse(&curp, STDIN_FILENO, "", &rc); + } + while (argc) { + rctmp = mparse_open(curp.mp, &fd, +#if HAVE_SQLITE3 + resp != NULL ? resp->file : +#endif + *argv); + if (rc < rctmp) + rc = rctmp; -static struct mdoc * -mdoc_init(struct curparse *curp) -{ - int pflags; + if (fd != -1) { + if (use_pager && isatty(STDOUT_FILENO)) + spawn_pager(); + use_pager = 0; - /* Defaults from mandoc.1. */ +#if HAVE_SQLITE3 + if (resp == NULL) +#endif + parse(&curp, fd, *argv, &rc); +#if HAVE_SQLITE3 + else if (resp->form & FORM_SRC) { + /* For .so only; ignore failure. */ + chdir(paths.paths[resp->ipath]); + parse(&curp, fd, resp->file, &rc); + } else { + rctmp = passthrough(resp->file, fd, + synopsis_only); + if (rc < rctmp) + rc = rctmp; + } +#endif - pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE; + rctmp = mparse_wait(curp.mp); + if (rc < rctmp) + rc = rctmp; - if (curp->fflags & FL_IGN_SCOPE) - pflags |= MDOC_IGN_SCOPE; - if (curp->fflags & FL_NIGN_ESCAPE) - pflags &= ~MDOC_IGN_ESCAPE; - if (curp->fflags & FL_NIGN_MACRO) - pflags &= ~MDOC_IGN_MACRO; + if (argc > 1 && curp.outtype <= OUTT_UTF8) + ascii_sepline(curp.outdata); + } - return(mdoc_alloc(curp, pflags, mmsg)); -} + if (MANDOCLEVEL_OK != rc && curp.wstop) + break; +#if HAVE_SQLITE3 + if (resp != NULL) + resp++; + else +#endif + argv++; + if (--argc) + mparse_reset(curp.mp); + } -static void -ffile(const char *file, struct curparse *curp) -{ + if (curp.outfree) + (*curp.outfree)(curp.outdata); + mparse_free(curp.mp); + mchars_free(curp.mchars); - curp->file = file; - if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { - perror(curp->file); - with_error = 1; - return; +#if HAVE_SQLITE3 +out: + if (search.argmode != ARG_FILE) { + manpath_free(&paths); + mansearch_free(res, sz); + mansearch_setup(0); } +#endif - fdesc(curp); + free(defos); - if (-1 == close(curp->fd)) - perror(curp->file); + return((int)rc); } +static void +version(void) +{ -static int -resize_buf(struct buf *buf, size_t initial) + printf("mandoc %s\n", VERSION); + exit((int)MANDOCLEVEL_OK); +} + +static void +usage(enum argmode argmode) { - void *tmp; - size_t sz; - if (buf->sz == 0) - sz = initial; - else - sz = 2 * buf->sz; - tmp = realloc(buf->buf, sz); - if (NULL == tmp) { - perror(NULL); - return(0); + switch (argmode) { + case ARG_FILE: + fputs("usage: mandoc [-acfhklV] [-Ios=name] " + "[-Kencoding] [-mformat] [-Ooption]\n" + "\t [-Toutput] [-Wlevel] [file ...]\n", stderr); + break; + case ARG_NAME: + fputs("usage: man [-acfhklVw] [-C file] [-I os=name] " + "[-K encoding] [-M path] [-m path]\n" + "\t [-O option=value] [-S subsection] [-s section] " + "[-T output] [-W level]\n" + "\t [section] name ...\n", stderr); + break; + case ARG_WORD: + fputs("usage: whatis [-acfhklVw] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] name ...\n", stderr); + break; + case ARG_EXPR: + fputs("usage: apropos [-acfhklVw] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] expression ...\n", stderr); + break; } - buf->buf = tmp; - buf->sz = sz; - return(1); + exit((int)MANDOCLEVEL_BADARG); } - +#if HAVE_SQLITE3 static int -read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap) +fs_lookup(const struct manpaths *paths, size_t ipath, + const char *sec, const char *arch, const char *name, + struct manpage **res, size_t *ressz) { - struct stat st; - size_t off; - ssize_t ssz; + struct manpage *page; + char *file; + int form; - if (-1 == fstat(curp->fd, &st)) { - perror(curp->file); - with_error = 1; - return(0); + mandoc_asprintf(&file, "%s/man%s/%s.%s", + paths->paths[ipath], sec, name, sec); + if (access(file, R_OK) != -1) { + form = FORM_SRC; + goto found; } + free(file); - /* - * If we're a regular file, try just reading in the whole entry - * via mmap(). This is faster than reading it into blocks, and - * since each file is only a few bytes to begin with, I'm not - * concerned that this is going to tank any machines. - */ - - if (S_ISREG(st.st_mode)) { - if (st.st_size >= (1U << 31)) { - fprintf(stderr, "%s: input too large\n", - curp->file); - with_error = 1; - return(0); - } - *with_mmap = 1; - fb->sz = (size_t)st.st_size; - fb->buf = mmap(NULL, fb->sz, PROT_READ, - MAP_FILE|MAP_SHARED, curp->fd, 0); - if (fb->buf != MAP_FAILED) - return(1); + mandoc_asprintf(&file, "%s/cat%s/%s.0", + paths->paths[ipath], sec, name); + if (access(file, R_OK) != -1) { + form = FORM_CAT; + goto found; } + free(file); - /* - * If this isn't a regular file (like, say, stdin), then we must - * go the old way and just read things in bit by bit. - */ - - *with_mmap = 0; - off = 0; - fb->sz = 0; - fb->buf = NULL; - for (;;) { - if (off == fb->sz) { - if (fb->sz == (1U << 31)) { - fprintf(stderr, "%s: input too large\n", - curp->file); - break; - } - if (! resize_buf(fb, 65536)) - break; + if (arch != NULL) { + mandoc_asprintf(&file, "%s/man%s/%s/%s.%s", + paths->paths[ipath], sec, arch, name, sec); + if (access(file, R_OK) != -1) { + form = FORM_SRC; + goto found; } - ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off); - if (ssz == 0) { - fb->sz = off; - return(1); - } - if (ssz == -1) { - perror(curp->file); - break; - } - off += (size_t)ssz; + free(file); } - - free(fb->buf); - fb->buf = NULL; - with_error = 1; return(0); + +found: + fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry,\n" + " consider running # makewhatis %s\n", + progname, name, sec, paths->paths[ipath]); + + *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage)); + page = *res + (*ressz - 1); + page->file = file; + page->names = NULL; + page->output = NULL; + page->ipath = ipath; + page->bits = NAME_FILE & NAME_MASK; + page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10; + page->form = form; + return(1); } - static void -fdesc(struct curparse *curp) +fs_search(const struct mansearch *cfg, const struct manpaths *paths, + int argc, char **argv, struct manpage **res, size_t *ressz) { - struct buf ln, blk; - int i, pos, lnn, lnn_start, with_mmap, of; - enum rofferr re; - struct man *man; - struct mdoc *mdoc; - struct roff *roff; + const char *const sections[] = + {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"}; + const size_t nsec = sizeof(sections)/sizeof(sections[0]); - man = NULL; - mdoc = NULL; - roff = NULL; - memset(&ln, 0, sizeof(struct buf)); + size_t ipath, isec, lastsz; - /* - * Two buffers: ln and buf. buf is the input file and may be - * memory mapped. ln is a line buffer and grows on-demand. - */ + assert(cfg->argmode == ARG_NAME); - if ( ! read_whole_file(curp, &blk, &with_mmap)) - return; - - if (NULL == curp->roff) - curp->roff = roff_init(curp); - if (NULL == (roff = curp->roff)) - goto bailout; - - for (i = 0, lnn = 1; i < (int)blk.sz;) { - pos = 0; - lnn_start = lnn; - while (i < (int)blk.sz) { - if ('\n' == blk.buf[i]) { - ++i; - ++lnn; - 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; - } - /* Found an escape and at least one other character. */ - if ('\n' == blk.buf[i + 1]) { - /* Escaped newlines are skipped over */ - i += 2; - ++lnn; - 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++]; + *res = NULL; + *ressz = lastsz = 0; + while (argc) { + for (ipath = 0; ipath < paths->sz; ipath++) { + if (cfg->sec != NULL) { + if (fs_lookup(paths, ipath, cfg->sec, + cfg->arch, *argv, res, ressz) && + cfg->firstmatch) + return; + } else for (isec = 0; isec < nsec; isec++) + if (fs_lookup(paths, ipath, sections[isec], + cfg->arch, *argv, res, ressz) && + cfg->firstmatch) + return; } + if (*ressz == lastsz) + fprintf(stderr, + "%s: No entry for %s in the manual.\n", + progname, *argv); + lastsz = *ressz; + argv++; + argc--; + } +} +#endif - if (pos >= (int)ln.sz) - if (! resize_buf(&ln, 256)) - goto bailout; - ln.buf[pos] = '\0'; +static void +parse(struct curparse *curp, int fd, const char *file, + enum mandoclevel *level) +{ + enum mandoclevel rc; + struct mdoc *mdoc; + struct man *man; - /* - * 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. - */ + /* Begin by parsing the file itself. */ - of = 0; - do { - re = roff_parseln(roff, lnn_start, - &ln.buf, &ln.sz, of, &of); - } while (ROFF_RERUN == re); + assert(file); + assert(fd >= -1); - if (ROFF_IGN == re) - continue; - else if (ROFF_ERR == re) - goto bailout; + rc = mparse_readfd(curp->mp, fd, file); - /* - * 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. - */ + /* + * With -Wstop and warnings or errors of at least the requested + * level, do not produce output. + */ - if ( ! (man || mdoc)) - if ( ! pset(ln.buf + of, pos - of, curp, &man, &mdoc)) - goto bailout; + if (MANDOCLEVEL_OK != rc && curp->wstop) + goto cleanup; - /* Lastly, push down into the parsers themselves. */ - - if (man && ! man_parseln(man, lnn_start, ln.buf, of)) - goto bailout; - if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of)) - goto bailout; - } - - /* NOTE a parser may not have been assigned, yet. */ - - if ( ! (man || mdoc)) { - fprintf(stderr, "%s: Not a manual\n", curp->file); - goto bailout; - } - - /* Clean up the parse routine ASTs. */ - - if (mdoc && ! mdoc_endparse(mdoc)) - goto bailout; - if (man && ! man_endparse(man)) - goto bailout; - if (roff && ! roff_endparse(roff)) - goto bailout; - /* If unset, allocate output dev now (if applicable). */ if ( ! (curp->outman && curp->outmdoc)) { switch (curp->outtype) { - case (OUTT_XHTML): - curp->outdata = xhtml_alloc(curp->outopts); - curp->outman = html_man; - curp->outmdoc = html_mdoc; + case OUTT_HTML: + curp->outdata = html_alloc(curp->mchars, + curp->outopts); curp->outfree = html_free; break; - case (OUTT_HTML): - curp->outdata = html_alloc(curp->outopts); + case OUTT_UTF8: + curp->outdata = utf8_alloc(curp->mchars, + curp->outopts); + curp->outfree = ascii_free; + break; + case OUTT_LOCALE: + curp->outdata = locale_alloc(curp->mchars, + curp->outopts); + curp->outfree = ascii_free; + break; + case OUTT_ASCII: + curp->outdata = ascii_alloc(curp->mchars, + curp->outopts); + curp->outfree = ascii_free; + break; + case OUTT_PDF: + curp->outdata = pdf_alloc(curp->mchars, + curp->outopts); + curp->outfree = pspdf_free; + break; + case OUTT_PS: + curp->outdata = ps_alloc(curp->mchars, + curp->outopts); + curp->outfree = pspdf_free; + break; + default: + break; + } + + switch (curp->outtype) { + case OUTT_HTML: curp->outman = html_man; curp->outmdoc = html_mdoc; - curp->outfree = html_free; break; - case (OUTT_TREE): + case OUTT_TREE: curp->outman = tree_man; curp->outmdoc = tree_mdoc; break; - case (OUTT_LINT): + case OUTT_MAN: + curp->outmdoc = man_mdoc; + curp->outman = man_man; break; - default: - curp->outdata = ascii_alloc(80); + case OUTT_PDF: + /* FALLTHROUGH */ + case OUTT_ASCII: + /* FALLTHROUGH */ + case OUTT_UTF8: + /* FALLTHROUGH */ + case OUTT_LOCALE: + /* FALLTHROUGH */ + case OUTT_PS: curp->outman = terminal_man; curp->outmdoc = terminal_mdoc; - curp->outfree = terminal_free; break; + default: + break; } } + mparse_result(curp->mp, &mdoc, &man, NULL); + /* Execute the out device, if it exists. */ if (man && curp->outman) @@ -616,102 +737,120 @@ fdesc(struct curparse *curp) if (mdoc && curp->outmdoc) (*curp->outmdoc)(curp->outdata, mdoc); - cleanup: - if (mdoc) - mdoc_reset(mdoc); - if (man) - man_reset(man); - if (roff) - roff_reset(roff); - if (ln.buf) - free(ln.buf); - if (with_mmap) - munmap(blk.buf, blk.sz); - else - free(blk.buf); - - return; - - bailout: - with_error = 1; - goto cleanup; +cleanup: + if (*level < rc) + *level = rc; } - -static int -pset(const char *buf, int pos, struct curparse *curp, - struct man **man, struct mdoc **mdoc) +#if HAVE_SQLITE3 +static enum mandoclevel +passthrough(const char *file, int fd, int synopsis_only) { - int i; + const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"; + const char synr[] = "SYNOPSIS"; - /* - * 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 dot-lines, use -mdoc when finding `.Dt', or - * default to -man, which is more lenient. - */ + FILE *stream; + const char *syscall; + char *line; + size_t len, off; + ssize_t nw; + int print; - if ('.' == buf[0] || '\'' == buf[0]) { - for (i = 1; buf[i]; i++) - if (' ' != buf[i] && '\t' != buf[i]) - break; - if (0 == buf[i]) - return(1); + fflush(stdout); + + if ((stream = fdopen(fd, "r")) == NULL) { + close(fd); + syscall = "fdopen"; + goto fail; } - switch (curp->inttype) { - case (INTT_MDOC): - if (NULL == curp->mdoc) - curp->mdoc = mdoc_init(curp); - if (NULL == (*mdoc = curp->mdoc)) - return(0); - return(1); - case (INTT_MAN): - if (NULL == curp->man) - curp->man = man_init(curp); - if (NULL == (*man = curp->man)) - return(0); - return(1); - default: - break; + print = 0; + while ((line = fgetln(stream, &len)) != NULL) { + if (synopsis_only) { + if (print) { + if ( ! isspace((unsigned char)*line)) + goto done; + while (len && + isspace((unsigned char)*line)) { + line++; + len--; + } + } else { + if ((len == sizeof(synb) && + ! strncmp(line, synb, len - 1)) || + (len == sizeof(synr) && + ! strncmp(line, synr, len - 1))) + print = 1; + continue; + } + } + for (off = 0; off < len; off += nw) + if ((nw = write(STDOUT_FILENO, line + off, + len - off)) == -1 || nw == 0) { + fclose(stream); + syscall = "write"; + goto fail; + } } - 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 (ferror(stream)) { + fclose(stream); + syscall = "fgetln"; + goto fail; + } - if (NULL == curp->man) - curp->man = man_init(curp); - if (NULL == (*man = curp->man)) +done: + fclose(stream); + return(MANDOCLEVEL_OK); + +fail: + fprintf(stderr, "%s: %s: SYSERR: %s: %s", + progname, file, syscall, strerror(errno)); + return(MANDOCLEVEL_SYSERR); +} +#endif + +static int +koptions(int *options, char *arg) +{ + + if ( ! strcmp(arg, "utf-8")) { + *options |= MPARSE_UTF8; + *options &= ~MPARSE_LATIN1; + } else if ( ! strcmp(arg, "iso-8859-1")) { + *options |= MPARSE_LATIN1; + *options &= ~MPARSE_UTF8; + } else if ( ! strcmp(arg, "us-ascii")) { + *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1); + } else { + fprintf(stderr, "%s: -K %s: Bad argument\n", + progname, arg); return(0); + } return(1); } - static int -moptions(enum intt *tflags, char *arg) +moptions(int *options, char *arg) { - if (0 == strcmp(arg, "doc")) - *tflags = INTT_MDOC; + if (arg == NULL) + /* nothing to do */; + else if (0 == strcmp(arg, "doc")) + *options |= MPARSE_MDOC; else if (0 == strcmp(arg, "andoc")) - *tflags = INTT_AUTO; + /* nothing to do */; else if (0 == strcmp(arg, "an")) - *tflags = INTT_MAN; + *options |= MPARSE_MAN; else { - fprintf(stderr, "%s: Bad argument\n", arg); + fprintf(stderr, "%s: -m %s: Bad argument\n", + progname, arg); return(0); } return(1); } - static int toptions(struct curparse *curp, char *arg) { @@ -720,61 +859,65 @@ toptions(struct curparse *curp, char *arg) curp->outtype = OUTT_ASCII; else if (0 == strcmp(arg, "lint")) { curp->outtype = OUTT_LINT; - curp->wflags |= WARN_WALL; - curp->fflags |= FL_STRICT; - } - else if (0 == strcmp(arg, "tree")) + curp->wlevel = MANDOCLEVEL_WARNING; + } else if (0 == strcmp(arg, "tree")) curp->outtype = OUTT_TREE; + else if (0 == strcmp(arg, "man")) + curp->outtype = OUTT_MAN; else if (0 == strcmp(arg, "html")) curp->outtype = OUTT_HTML; + else if (0 == strcmp(arg, "utf8")) + curp->outtype = OUTT_UTF8; + else if (0 == strcmp(arg, "locale")) + curp->outtype = OUTT_LOCALE; else if (0 == strcmp(arg, "xhtml")) - curp->outtype = OUTT_XHTML; + curp->outtype = OUTT_HTML; + else if (0 == strcmp(arg, "ps")) + curp->outtype = OUTT_PS; + else if (0 == strcmp(arg, "pdf")) + curp->outtype = OUTT_PDF; else { - fprintf(stderr, "%s: Bad argument\n", arg); + fprintf(stderr, "%s: -T %s: Bad argument\n", + progname, arg); return(0); } return(1); } - static int -foptions(int *fflags, char *arg) +woptions(struct curparse *curp, char *arg) { char *v, *o; - const char *toks[8]; + const char *toks[6]; - toks[0] = "ign-scope"; - toks[1] = "no-ign-escape"; - toks[2] = "no-ign-macro"; - toks[3] = "ign-errors"; - toks[4] = "strict"; - toks[5] = "ign-escape"; - toks[6] = NULL; + toks[0] = "stop"; + toks[1] = "all"; + toks[2] = "warning"; + toks[3] = "error"; + toks[4] = "fatal"; + toks[5] = NULL; while (*arg) { o = arg; switch (getsubopt(&arg, UNCONST(toks), &v)) { - case (0): - *fflags |= FL_IGN_SCOPE; + case 0: + curp->wstop = 1; break; - case (1): - *fflags |= FL_NIGN_ESCAPE; + case 1: + /* FALLTHROUGH */ + case 2: + curp->wlevel = MANDOCLEVEL_WARNING; break; - case (2): - *fflags |= FL_NIGN_MACRO; + case 3: + curp->wlevel = MANDOCLEVEL_ERROR; break; - case (3): - *fflags |= FL_IGN_ERRORS; + case 4: + curp->wlevel = MANDOCLEVEL_BADARG; break; - case (4): - *fflags |= FL_STRICT; - break; - case (5): - *fflags &= ~FL_NIGN_ESCAPE; - break; default: - fprintf(stderr, "%s: Bad argument\n", o); + fprintf(stderr, "%s: -W %s: Bad argument\n", + progname, o); return(0); } } @@ -782,64 +925,100 @@ foptions(int *fflags, char *arg) return(1); } - -static int -woptions(int *wflags, char *arg) +static void +mmsg(enum mandocerr t, enum mandoclevel lvl, + const char *file, int line, int col, const char *msg) { - char *v, *o; - const char *toks[3]; + const char *mparse_msg; - toks[0] = "all"; - toks[1] = "error"; - toks[2] = NULL; + fprintf(stderr, "%s: %s:", progname, file); - while (*arg) { - o = arg; - switch (getsubopt(&arg, UNCONST(toks), &v)) { - case (0): - *wflags |= WARN_WALL; - break; - case (1): - *wflags |= WARN_WERR; - break; - default: - fprintf(stderr, "%s: Bad argument\n", o); - return(0); - } - } + if (line) + fprintf(stderr, "%d:%d:", line, col + 1); - return(1); -} + fprintf(stderr, " %s", mparse_strlevel(lvl)); + if (NULL != (mparse_msg = mparse_strerror(t))) + fprintf(stderr, ": %s", mparse_msg); -static int -mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) + if (msg) + fprintf(stderr, ": %s", msg); + + fputc('\n', stderr); +} + +static void +spawn_pager(void) { - struct curparse *cp; +#define MAX_PAGER_ARGS 16 + char *argv[MAX_PAGER_ARGS]; + const char *pager; + char *cp; + int fildes[2]; + int argc; - cp = (struct curparse *)arg; + if (pipe(fildes) == -1) { + fprintf(stderr, "%s: pipe: %s\n", + progname, strerror(errno)); + return; + } - if (t <= MANDOCERR_ERROR) { - if ( ! (cp->wflags & WARN_WALL)) - return(1); - with_warning = 1; - } else - with_error = 1; + switch (fork()) { + case -1: + fprintf(stderr, "%s: fork: %s\n", + progname, strerror(errno)); + exit((int)MANDOCLEVEL_SYSERR); + case 0: + close(fildes[0]); + if (dup2(fildes[1], STDOUT_FILENO) == -1) { + fprintf(stderr, "%s: dup output: %s\n", + progname, strerror(errno)); + exit((int)MANDOCLEVEL_SYSERR); + } + return; + default: + break; + } - fprintf(stderr, "%s:%d:%d: %s", cp->file, - ln, col + 1, mandocerrs[t]); + /* The original process becomes the pager. */ - if (msg) - fprintf(stderr, ": %s", msg); + close(fildes[1]); + if (dup2(fildes[0], STDIN_FILENO) == -1) { + fprintf(stderr, "%s: dup input: %s\n", + progname, strerror(errno)); + exit((int)MANDOCLEVEL_SYSERR); + } - fputc('\n', stderr); + pager = getenv("MANPAGER"); + if (pager == NULL || *pager == '\0') + pager = getenv("PAGER"); + if (pager == NULL || *pager == '\0') + pager = "/usr/bin/more -s"; + cp = mandoc_strdup(pager); - /* This is superfluous, but whatever. */ - if (t > MANDOCERR_ERROR) - return(0); - if (cp->wflags & WARN_WERR) { - with_error = 1; - return(0); + /* + * Parse the pager command into words. + * Intentionally do not do anything fancy here. + */ + + argc = 0; + while (argc + 1 < MAX_PAGER_ARGS) { + argv[argc++] = cp; + cp = strchr(cp, ' '); + if (cp == NULL) + break; + *cp++ = '\0'; + while (*cp == ' ') + cp++; + if (*cp == '\0') + break; } - return(1); + argv[argc] = NULL; + + /* Hand over to the pager. */ + + execvp(argv[0], argv); + fprintf(stderr, "%s: exec: %s\n", + progname, strerror(errno)); + exit((int)MANDOCLEVEL_SYSERR); }