=================================================================== RCS file: /cvs/mandoc/main.c,v retrieving revision 1.11 retrieving revision 1.267 diff -u -p -r1.11 -r1.267 --- mandoc/main.c 2009/03/23 15:20:51 1.11 +++ mandoc/main.c 2016/07/08 22:29:05 1.267 @@ -1,550 +1,1100 @@ -/* $Id: main.c,v 1.11 2009/03/23 15:20:51 kristaps Exp $ */ +/* $Id: main.c,v 1.267 2016/07/08 22:29:05 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2012, 2014-2016 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 copyright notice and this permission notice appear in all - * copies. + * 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. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 "config.h" +#include +#include /* MACHINE */ +#include + #include +#include +#if HAVE_ERR #include +#endif +#include #include +#include +#include #include +#include #include #include +#include #include +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" #include "mdoc.h" #include "man.h" +#include "tag.h" +#include "main.h" +#include "manconf.h" +#include "mansearch.h" -#ifdef __linux__ -extern int getsubopt(char **, char * const *, char **); -# ifndef __dead -# define __dead __attribute__((__noreturn__)) +#if !defined(__GNUC__) || (__GNUC__ < 2) +# if !defined(lint) +# define __attribute__(x) # endif -#elif defined(__FreeBSD__) -# ifndef __dead -# define __dead __dead2 -# endif -#endif +#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */ -struct buf { - char *buf; - size_t sz; +enum outmode { + OUTMODE_DEF = 0, + OUTMODE_FLN, + OUTMODE_LST, + OUTMODE_ALL, + OUTMODE_INT, + OUTMODE_ONE }; -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 outt { + 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 */ }; -enum intt { - INTT_MDOC = 0, - INTT_MAN +struct curparse { + struct mparse *mp; + enum mandoclevel wlevel; /* ignore messages below this */ + int wstop; /* stop after a file with a warning */ + enum outt outtype; /* which output to use */ + void *outdata; /* data for output */ + struct manoutput *outopts; /* output options */ }; -enum outt { - OUTT_ASCII = 0, - OUTT_LATIN1, - OUTT_UTF8, - OUTT_TREE, - OUTT_LINT -}; +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 *); +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 *); +static void passthrough(const char *, int, int); +static pid_t spawn_pager(struct tag_files *); +static int toptions(struct curparse *, char *); +static void usage(enum argmode) __attribute__((noreturn)); +static int woptions(struct curparse *, char *); -typedef int (*out_run)(void *, const struct man *, - const struct mdoc *); -typedef void (*out_free)(void *); +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 enum mandoclevel rc; -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 man *, - const struct mdoc *); -extern int tree_run(void *, const struct man *, - 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 manconf conf; struct curparse curp; + struct mansearch search; + struct tag_files *tag_files; + const char *progname; + char *auxpaths; + char *defos; + unsigned char *uc; + struct manpage *res, *resp; + char *conf_file, *defpaths; + const char *sec; + size_t i, sz; + int prio, best_prio; + enum outmode outmode; + int fd; + int show_usage; + int options; + int use_pager; + int status, signum; + int c; + pid_t pager_pid, tc_pgid, man_pgid, pid; - fflags = 0; - outtype = OUTT_ASCII; - inttype = INTT_MDOC; +#if HAVE_PROGNAME + progname = getprogname(); +#else + if (argc < 1) + progname = mandoc_strdup("mandoc"); + else if ((progname = strrchr(argv[0], '/')) == NULL) + progname = argv[0]; + else + ++progname; + setprogname(progname); +#endif - bzero(&curp, sizeof(struct curparse)); +#if HAVE_SQLITE3 + if (strncmp(progname, "mandocdb", 8) == 0 || + strcmp(progname, BINM_MAKEWHATIS) == 0) + return mandocdb(argc, argv); +#endif - /* LINTED */ - while (-1 != (c = getopt(argc, argv, "f:m:VW:T:"))) +#if HAVE_PLEDGE + if (pledge("stdio rpath tmppath tty proc exec flock", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); +#endif + + /* Search options. */ + + memset(&conf, 0, sizeof(conf)); + conf_file = defpaths = NULL; + 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; + curp.outopts = &conf.output; + options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; + defos = NULL; + + use_pager = 1; + tag_files = NULL; + show_usage = 0; + outmode = OUTMODE_DEF; + + while (-1 != (c = getopt(argc, argv, + "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) { switch (c) { - case ('f'): - if ( ! foptions(&fflags, optarg)) - return(0); + case 'a': + outmode = OUTMODE_ALL; break; - case ('m'): - if ( ! moptions(&inttype, optarg)) - return(0); + case 'C': + conf_file = optarg; break; - case ('T'): - if ( ! toptions(&outtype, optarg)) - return(0); + case 'c': + use_pager = 0; break; - case ('W'): - if ( ! woptions(&curp.wflags, optarg)) - return(0); + case 'f': + search.argmode = ARG_WORD; break; - case ('V'): - version(); - /* NOTREACHED */ + case 'h': + conf.output.synopsisonly = 1; + use_pager = 0; + outmode = OUTMODE_ALL; + break; + case 'I': + if (strncmp(optarg, "os=", 3)) { + warnx("-I %s: Bad argument", optarg); + return (int)MANDOCLEVEL_BADARG; + } + if (defos) { + warnx("-I %s: Duplicate argument", 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': + defpaths = optarg; + break; + case 'm': + auxpaths = optarg; + break; + case 'O': + search.outkey = optarg; + while (optarg != NULL) + manconf_output(&conf.output, + strsep(&optarg, ",")); + break; + case 'S': + search.arch = optarg; + break; + case 's': + search.sec = optarg; + break; + case 'T': + if ( ! toptions(&curp, optarg)) + return (int)MANDOCLEVEL_BADARG; + break; + case 'W': + if ( ! woptions(&curp, optarg)) + return (int)MANDOCLEVEL_BADARG; + break; + case 'w': + outmode = OUTMODE_FLN; + break; default: - usage(); - /* NOTREACHED */ + show_usage = 1; + break; } + } - argc -= optind; - argv += optind; + if (show_usage) + usage(search.argmode); - /* - * 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. - */ + /* Postprocess options. */ - 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; + 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; + } } + if (outmode == OUTMODE_FLN || + outmode == OUTMODE_LST || + !isatty(STDOUT_FILENO)) + use_pager = 0; + +#if HAVE_PLEDGE + if (!use_pager) + if (pledge("stdio rpath flock", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); +#endif + + /* Parse arguments. */ + + if (argc > 0) { + argc -= optind; + argv += optind; + } + resp = NULL; + /* - * All callbacks route into here, where we print them onto the - * screen. XXX - for now, no path for debugging messages. + * Quirks for help(1) + * and for a man(1) section argument without -s. */ - cb.mdoc_msg = NULL; - cb.mdoc_err = merr; - cb.mdoc_warn = mwarn; + if (search.argmode == ARG_NAME) { + if (*progname == 'h') { + if (argc == 0) { + argv = help_argv; + argc = 1; + } + } else if (argc > 1 && + ((uc = (unsigned char *)argv[0]) != NULL) && + ((isdigit(uc[0]) && (uc[1] == '\0' || + (isalpha(uc[1]) && uc[2] == '\0'))) || + (uc[0] == 'n' && uc[1] == '\0'))) { + search.sec = (char *)uc; + argv++; + argc--; + } + if (search.arch == NULL) + search.arch = getenv("MACHINE"); +#ifdef MACHINE + if (search.arch == NULL) + search.arch = MACHINE; +#endif + } - bzero(&ln, sizeof(struct buf)); - bzero(&blk, sizeof(struct buf)); + rc = MANDOCLEVEL_OK; - man = NULL; - mdoc = NULL; + /* man(1), whatis(1), apropos(1) */ - switch (inttype) { - case (INTT_MAN): - man = man_alloc(); - break; - default: - mdoc = mdoc_alloc(&curp, fflags, &cb); - break; + if (search.argmode != ARG_FILE) { + if (argc == 0) + usage(search.argmode); + + if (search.argmode == ARG_NAME && + outmode == OUTMODE_ONE) + search.firstmatch = 1; + + /* Access the mandoc database. */ + + manconf_parse(&conf, conf_file, defpaths, auxpaths); +#if HAVE_SQLITE3 + mansearch_setup(1); + if ( ! mansearch(&search, &conf.manpath, + argc, argv, &res, &sz)) + usage(search.argmode); +#else + if (search.argmode != ARG_NAME) { + fputs("mandoc: database support not compiled in\n", + stderr); + return (int)MANDOCLEVEL_BADARG; + } + sz = 0; +#endif + + if (sz == 0) { + if (search.argmode == ARG_NAME) + fs_search(&search, &conf.manpath, + argc, argv, &res, &sz); + else + warnx("nothing appropriate"); + } + + if (sz == 0) { + rc = MANDOCLEVEL_BADARG; + goto out; + } + + /* + * For standard man(1) and -a output mode, + * prepare for copying filename pointers + * into the program parameter array. + */ + + if (outmode == OUTMODE_ONE) { + argc = 1; + best_prio = 20; + } else if (outmode == OUTMODE_ALL) + argc = (int)sz; + + /* Iterate all matching manuals. */ + + 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. */ + sec = res[i].file; + sec += strcspn(sec, "123456789"); + if (sec[0] == '\0') + continue; + prio = sec_prios[sec[0] - '1']; + if (sec[1] != '/') + prio += 10; + if (prio >= best_prio) + continue; + best_prio = prio; + resp = res + i; + } + } + + /* + * 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. + */ + + if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) + goto out; } + /* mandoc(1) */ + +#if HAVE_PLEDGE + if (use_pager) { + if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); + } else { + if (pledge("stdio rpath", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); + } +#endif + + if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths)) + return (int)MANDOCLEVEL_BADARG; + + mchars_alloc(); + curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos); + /* - * Loop around available files. + * Conditionally start up the lookaside buffer before parsing. */ + if (OUTT_MAN == curp.outtype) + mparse_keep(curp.mp); - if (NULL == *argv) { - curp.file = ""; - rc = 0; - c = fdesc(&blk, &ln, "stdin", - STDIN_FILENO, man, mdoc); + if (argc < 1) { + if (use_pager) + tag_files = tag_init(); + parse(&curp, STDIN_FILENO, ""); + } - if (c && NULL == outrun) - rc = 1; - else if (c && outrun && (*outrun)(outdata, man, mdoc)) - rc = 1; - } else { - while (*argv) { - curp.file = *argv; - c = file(&blk, &ln, *argv, man, mdoc); - if ( ! c) - break; - if (outrun && ! (*outrun)(outdata, man, mdoc)) - break; - if (man) - man_reset(man); - if (mdoc) - mdoc_reset(mdoc); + while (argc > 0) { + fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv); + if (fd != -1) { + if (use_pager) { + tag_files = tag_init(); + use_pager = 0; + } + if (resp == NULL) + parse(&curp, fd, *argv); + else if (resp->form & FORM_SRC) { + /* For .so only; ignore failure. */ + chdir(conf.manpath.paths[resp->ipath]); + parse(&curp, fd, resp->file); + } else + passthrough(resp->file, fd, + conf.output.synopsisonly); + + if (argc > 1 && curp.outtype <= OUTT_UTF8) + terminal_sepline(curp.outdata); + } else if (rc < MANDOCLEVEL_ERROR) + rc = MANDOCLEVEL_ERROR; + + if (MANDOCLEVEL_OK != rc && curp.wstop) + break; + + if (resp != NULL) + resp++; + else argv++; + if (--argc) + mparse_reset(curp.mp); + } + + if (curp.outdata != NULL) { + switch (curp.outtype) { + case OUTT_HTML: + html_free(curp.outdata); + break; + case OUTT_UTF8: + case OUTT_LOCALE: + case OUTT_ASCII: + ascii_free(curp.outdata); + break; + case OUTT_PDF: + case OUTT_PS: + pspdf_free(curp.outdata); + break; + default: + break; } - rc = NULL == *argv; } + mparse_free(curp.mp); + mchars_free(); - 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); +out: + if (search.argmode != ARG_FILE) { + manconf_free(&conf); +#if HAVE_SQLITE3 + mansearch_free(res, sz); + mansearch_setup(0); +#endif + } - return(rc ? EXIT_SUCCESS : EXIT_FAILURE); -} + free(defos); + /* + * When using a pager, finish writing both temporary files, + * fork it, wait for the user to close it, and clean up. + */ -__dead static void -version(void) -{ + if (tag_files != NULL) { + fclose(stdout); + tag_write(); + man_pgid = getpgid(0); + tag_files->tcpgid = man_pgid == getpid() ? + getpgid(getppid()) : man_pgid; + pager_pid = 0; + signum = SIGSTOP; + for (;;) { - (void)printf("%s %s\n", __progname, VERSION); - exit(0); - /* NOTREACHED */ -} + /* Stop here until moved to the foreground. */ + tc_pgid = tcgetpgrp(STDIN_FILENO); + if (tc_pgid != man_pgid) { + if (tc_pgid == pager_pid) { + (void)tcsetpgrp(STDIN_FILENO, + man_pgid); + if (signum == SIGTTIN) + continue; + } else + tag_files->tcpgid = tc_pgid; + kill(0, signum); + continue; + } -__dead static void -usage(void) -{ + /* Once in the foreground, activate the pager. */ - (void)fprintf(stderr, "usage: %s\n", __progname); - exit(1); - /* NOTREACHED */ + if (pager_pid) { + (void)tcsetpgrp(STDIN_FILENO, pager_pid); + kill(pager_pid, SIGCONT); + } else + pager_pid = spawn_pager(tag_files); + + /* Wait for the pager to stop or exit. */ + + while ((pid = waitpid(pager_pid, &status, + WUNTRACED)) == -1 && errno == EINTR) + continue; + + if (pid == -1) { + warn("wait"); + rc = MANDOCLEVEL_SYSERR; + break; + } + if (!WIFSTOPPED(status)) + break; + + signum = WSTOPSIG(status); + } + tag_unlink(); + } + + return (int)rc; } +static void +usage(enum argmode argmode) +{ + switch (argmode) { + case ARG_FILE: + fputs("usage: mandoc [-acfhkl] [-I os=name] " + "[-K encoding] [-mformat] [-O option]\n" + "\t [-T output] [-W level] [file ...]\n", stderr); + break; + case ARG_NAME: + fputs("usage: man [-acfhklw] [-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 [-acfhklw] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] name ...\n", stderr); + break; + case ARG_EXPR: + fputs("usage: apropos [-acfhklw] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] expression ...\n", stderr); + break; + } + exit((int)MANDOCLEVEL_BADARG); +} + static int -file(struct buf *blk, struct buf *ln, const char *file, - struct man *man, struct mdoc *mdoc) +fs_lookup(const struct manpaths *paths, size_t ipath, + const char *sec, const char *arch, const char *name, + struct manpage **res, size_t *ressz) { - int fd, c; + glob_t globinfo; + struct manpage *page; + char *file; + int form, globres; - if (-1 == (fd = open(file, O_RDONLY, 0))) { - warn("%s", file); - return(0); + form = FORM_SRC; + mandoc_asprintf(&file, "%s/man%s/%s.%s", + paths->paths[ipath], sec, name, sec); + if (access(file, R_OK) != -1) + goto found; + free(file); + + 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); - c = fdesc(blk, ln, file, fd, man, mdoc); + 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) + goto found; + free(file); + } - if (-1 == close(fd)) - warn("%s", file); + mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*", + paths->paths[ipath], sec, name); + globres = glob(file, 0, NULL, &globinfo); + if (globres != 0 && globres != GLOB_NOMATCH) + warn("%s: glob", file); + free(file); + if (globres == 0) + file = mandoc_strdup(*globinfo.gl_pathv); + globfree(&globinfo); + if (globres != 0) + return 0; - return(c); +found: +#if HAVE_SQLITE3 + warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s", + name, sec, BINM_MAKEWHATIS, paths->paths[ipath]); +#endif + *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 +fs_search(const struct mansearch *cfg, const struct manpaths *paths, + int argc, char **argv, struct manpage **res, size_t *ressz) +{ + const char *const sections[] = + {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"}; + const size_t nsec = sizeof(sections)/sizeof(sections[0]); -static int -fdesc(struct buf *blk, struct buf *ln, - const char *f, int fd, - struct man *man, struct mdoc *mdoc) + size_t ipath, isec, lastsz; + + assert(cfg->argmode == ARG_NAME); + + *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) + warnx("No entry for %s in the manual.", *argv); + lastsz = *ressz; + argv++; + argc--; + } +} + +static void +parse(struct curparse *curp, int fd, const char *file) { - size_t sz; - ssize_t ssz; - struct stat st; - int j, i, pos, lnn; + enum mandoclevel rctmp; + struct roff_man *man; - assert( ! (man && mdoc)); + /* Begin by parsing the file itself. */ + assert(file); + assert(fd >= 0); + + rctmp = mparse_readfd(curp->mp, fd, file); + if (fd != STDIN_FILENO) + close(fd); + if (rc < rctmp) + rc = rctmp; + /* - * 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. + * With -Wstop and warnings or errors of at least the requested + * level, do not produce output. */ - sz = BUFSIZ; + if (rctmp != MANDOCLEVEL_OK && curp->wstop) + return; - if (-1 == fstat(fd, &st)) - warnx("%s", f); - else if ((size_t)st.st_blksize > sz) - sz = st.st_blksize; + /* If unset, allocate output dev now (if applicable). */ - if (sz > blk->sz) { - blk->buf = realloc(blk->buf, sz); - if (NULL == blk->buf) - err(1, "realloc"); - blk->sz = sz; + if (curp->outdata == NULL) { + switch (curp->outtype) { + case OUTT_HTML: + curp->outdata = html_alloc(curp->outopts); + break; + case OUTT_UTF8: + curp->outdata = utf8_alloc(curp->outopts); + break; + case OUTT_LOCALE: + curp->outdata = locale_alloc(curp->outopts); + break; + case OUTT_ASCII: + curp->outdata = ascii_alloc(curp->outopts); + break; + case OUTT_PDF: + curp->outdata = pdf_alloc(curp->outopts); + break; + case OUTT_PS: + curp->outdata = ps_alloc(curp->outopts); + break; + default: + break; + } } - /* - * Fill buf with file blocksize and parse newlines into ln. - */ + mparse_result(curp->mp, &man, NULL); - for (lnn = 1, pos = 0; ; ) { - if (-1 == (ssz = read(fd, blk->buf, sz))) { - warn("%s", f); - return(0); - } else if (0 == ssz) + /* Execute the out device, if it exists. */ + + if (man == NULL) + return; + if (man->macroset == MACROSET_MDOC) { + mdoc_validate(man); + switch (curp->outtype) { + case OUTT_HTML: + html_mdoc(curp->outdata, man); break; + case OUTT_TREE: + tree_mdoc(curp->outdata, man); + break; + case OUTT_MAN: + man_mdoc(curp->outdata, man); + break; + case OUTT_PDF: + case OUTT_ASCII: + case OUTT_UTF8: + case OUTT_LOCALE: + case OUTT_PS: + terminal_mdoc(curp->outdata, man); + break; + default: + break; + } + } + if (man->macroset == MACROSET_MAN) { + man_validate(man); + switch (curp->outtype) { + case OUTT_HTML: + html_man(curp->outdata, man); + break; + case OUTT_TREE: + tree_man(curp->outdata, man); + break; + case OUTT_MAN: + man_man(curp->outdata, man); + break; + case OUTT_PDF: + case OUTT_ASCII: + case OUTT_UTF8: + case OUTT_LOCALE: + case OUTT_PS: + terminal_man(curp->outdata, man); + break; + default: + 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"); - } +static void +passthrough(const char *file, int fd, int synopsis_only) +{ + const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"; + const char synr[] = "SYNOPSIS"; - if ('\n' != blk->buf[i]) { - ln->buf[pos++] = blk->buf[i]; - continue; - } + FILE *stream; + const char *syscall; + char *line, *cp; + size_t linesz; + int print; - /* Check for CPP-escaped newline. */ + line = NULL; + linesz = 0; - if (pos > 0 && '\\' == ln->buf[pos - 1]) { - for (j = pos - 1; j >= 0; j--) - if ('\\' != ln->buf[j]) - break; + if ((stream = fdopen(fd, "r")) == NULL) { + close(fd); + syscall = "fdopen"; + goto fail; + } - if ( ! ((pos - j) % 2)) { - pos--; - lnn++; - continue; - } + print = 0; + while (getline(&line, &linesz, stream) != -1) { + cp = line; + if (synopsis_only) { + if (print) { + if ( ! isspace((unsigned char)*cp)) + goto done; + while (isspace((unsigned char)*cp)) + cp++; + } else { + if (strcmp(cp, synb) == 0 || + strcmp(cp, synr) == 0) + print = 1; + 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 (fputs(cp, stdout)) { + fclose(stream); + syscall = "fputs"; + goto fail; + } } - if (mdoc) - return(mdoc_endparse(mdoc)); + if (ferror(stream)) { + fclose(stream); + syscall = "getline"; + goto fail; + } - return(man_endparse(man)); +done: + free(line); + fclose(stream); + return; + +fail: + free(line); + warn("%s: SYSERR: %s", file, syscall); + if (rc < MANDOCLEVEL_SYSERR) + rc = MANDOCLEVEL_SYSERR; } +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 { + warnx("-K %s: Bad argument", arg); + return 0; + } + return 1; +} + static int -moptions(enum intt *tflags, char *arg) +moptions(int *options, char *arg) { - if (0 == strcmp(arg, "mdoc")) - *tflags = INTT_MDOC; - else if (0 == strcmp(arg, "man")) - *tflags = INTT_MAN; + if (arg == NULL) + /* nothing to do */; + else if (0 == strcmp(arg, "doc")) + *options |= MPARSE_MDOC; + else if (0 == strcmp(arg, "andoc")) + /* nothing to do */; + else if (0 == strcmp(arg, "an")) + *options |= MPARSE_MAN; else { - warnx("bad argument: -m%s", arg); - return(0); + warnx("-m %s: Bad argument", arg); + return 0; } - return(1); + return 1; } - static int -toptions(enum outt *tflags, char *arg) +toptions(struct curparse *curp, char *arg) { if (0 == strcmp(arg, "ascii")) - *tflags = OUTT_ASCII; - else if (0 == strcmp(arg, "latin1")) - *tflags = OUTT_LATIN1; + curp->outtype = OUTT_ASCII; + else if (0 == strcmp(arg, "lint")) { + curp->outtype = OUTT_LINT; + 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")) - *tflags = OUTT_UTF8; - else if (0 == strcmp(arg, "lint")) - *tflags = OUTT_LINT; - else if (0 == strcmp(arg, "tree")) - *tflags = OUTT_TREE; + curp->outtype = OUTT_UTF8; + else if (0 == strcmp(arg, "locale")) + curp->outtype = OUTT_LOCALE; + else if (0 == strcmp(arg, "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 { - warnx("bad argument: -T%s", arg); - return(0); + warnx("-T %s: Bad argument", arg); + return 0; } - return(1); + 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) +woptions(struct curparse *curp, char *arg) { - char *v; - char *toks[4]; + char *v, *o; + const char *toks[7]; - toks[0] = "ign-scope"; - toks[1] = "ign-escape"; - toks[2] = "ign-macro"; - toks[3] = NULL; + toks[0] = "stop"; + toks[1] = "all"; + toks[2] = "warning"; + toks[3] = "error"; + toks[4] = "unsupp"; + toks[5] = "fatal"; + toks[6] = NULL; - while (*arg) - switch (getsubopt(&arg, toks, &v)) { - case (0): - *fflags |= MDOC_IGN_SCOPE; + while (*arg) { + o = arg; + switch (getsubopt(&arg, UNCONST(toks), &v)) { + case 0: + curp->wstop = 1; break; - case (1): - *fflags |= MDOC_IGN_ESCAPE; + case 1: + case 2: + curp->wlevel = MANDOCLEVEL_WARNING; break; - case (2): - *fflags |= MDOC_IGN_MACRO; + case 3: + curp->wlevel = MANDOCLEVEL_ERROR; break; + case 4: + curp->wlevel = MANDOCLEVEL_UNSUPP; + break; + case 5: + curp->wlevel = MANDOCLEVEL_BADARG; + break; default: - warnx("bad argument: -f%s", arg); - return(0); + warnx("-W %s: Bad argument", o); + return 0; } + } - return(1); + 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) +static void +mmsg(enum mandocerr t, enum mandoclevel lvl, + const char *file, int line, int col, const char *msg) { - char *v; - char *toks[5]; + const char *mparse_msg; - toks[0] = "all"; - toks[1] = "compat"; - toks[2] = "syntax"; - toks[3] = "error"; - toks[4] = NULL; + fprintf(stderr, "%s: %s:", getprogname(), file); - 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); - } + 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); -/* ARGSUSED */ -static int -merr(void *arg, int line, int col, const char *msg) -{ - struct curparse *curp; + if (msg) + fprintf(stderr, ": %s", msg); - curp = (struct curparse *)arg; - - warnx("%s:%d: error: %s (column %d)", - curp->file, line, msg, col); - return(0); + fputc('\n', stderr); } - -static int -mwarn(void *arg, int line, int col, - enum mdoc_warn type, const char *msg) +static pid_t +spawn_pager(struct tag_files *tag_files) { - struct curparse *curp; - char *wtype; + const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ +#define MAX_PAGER_ARGS 16 + char *argv[MAX_PAGER_ARGS]; + const char *pager; + char *cp; + size_t cmdlen; + int argc; + pid_t pager_pid; - curp = (struct curparse *)arg; - wtype = NULL; + pager = getenv("MANPAGER"); + if (pager == NULL || *pager == '\0') + pager = getenv("PAGER"); + if (pager == NULL || *pager == '\0') + pager = "more -s"; + cp = mandoc_strdup(pager); - switch (type) { - case (WARN_COMPAT): - wtype = "compat"; - if (curp->wflags & WARN_WCOMPAT) + /* + * Parse the pager command into words. + * Intentionally do not do anything fancy here. + */ + + argc = 0; + while (argc + 4 < MAX_PAGER_ARGS) { + argv[argc++] = cp; + cp = strchr(cp, ' '); + if (cp == NULL) break; - return(1); - case (WARN_SYNTAX): - wtype = "syntax"; - if (curp->wflags & WARN_WSYNTAX) + *cp++ = '\0'; + while (*cp == ' ') + cp++; + if (*cp == '\0') break; - return(1); } - assert(wtype); - warnx("%s:%d: %s warning: %s (column %d)", - curp->file, line, wtype, msg, col); + /* For more(1) and less(1), use the tag file. */ - if ( ! (curp->wflags & WARN_WERR)) - return(1); + if ((cmdlen = strlen(argv[0])) >= 4) { + cp = argv[0] + cmdlen - 4; + if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) { + argv[argc++] = mandoc_strdup("-T"); + argv[argc++] = tag_files->tfn; + } + } + argv[argc++] = tag_files->ofn; + argv[argc] = NULL; - warnx("%s: considering warnings as errors", - __progname); - return(0); -} + switch (pager_pid = fork()) { + case -1: + err((int)MANDOCLEVEL_SYSERR, "fork"); + case 0: + break; + default: + (void)setpgid(pager_pid, 0); + (void)tcsetpgrp(STDIN_FILENO, pager_pid); +#if HAVE_PLEDGE + if (pledge("stdio rpath tmppath tty proc", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); +#endif + tag_files->pager_pid = pager_pid; + return pager_pid; + } + /* The child process becomes the pager. */ + if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) + err((int)MANDOCLEVEL_SYSERR, "pager stdout"); + close(tag_files->ofd); + close(tag_files->tfd); + + /* Do not start the pager before controlling the terminal. */ + + while (tcgetpgrp(STDIN_FILENO) != getpid()) + nanosleep(&timeout, NULL); + + execvp(argv[0], argv); + err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]); +}