=================================================================== RCS file: /cvs/mandoc/main.c,v retrieving revision 1.110 retrieving revision 1.293 diff -u -p -r1.110 -r1.293 --- mandoc/main.c 2010/12/01 10:31:34 1.110 +++ mandoc/main.c 2017/06/24 14:38:32 1.293 @@ -1,737 +1,936 @@ -/* $Id: main.c,v 1.110 2010/12/01 10:31:34 kristaps Exp $ */ +/* $Id: main.c,v 1.293 2017/06/24 14:38:32 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons - * Copyright (c) 2010 Ingo Schwarze + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2012, 2014-2017 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. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * 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 AUTHOR BE LIABLE FOR + * 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. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif -#include -#include +#include +#include /* MACHINE */ +#include #include #include +#if HAVE_ERR +#include +#endif +#include #include +#include +#if HAVE_SANDBOX_INIT +#include +#endif +#include #include #include #include #include +#include #include +#include "mandoc_aux.h" #include "mandoc.h" -#include "main.h" +#include "roff.h" #include "mdoc.h" #include "man.h" -#include "roff.h" +#include "tag.h" +#include "main.h" +#include "manconf.h" +#include "mansearch.h" -#ifndef MAP_FILE -#define MAP_FILE 0 -#endif - -#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) */ - -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 outmode { + OUTMODE_DEF = 0, + OUTMODE_FLN, + OUTMODE_LST, + OUTMODE_ALL, + OUTMODE_ONE }; -enum intt { - INTT_AUTO, - INTT_MDOC, - INTT_MAN -}; - enum outt { - OUTT_ASCII = 0, - OUTT_TREE, - OUTT_HTML, - OUTT_XHTML, - OUTT_LINT, - OUTT_PS, - OUTT_PDF + OUTT_ASCII = 0, /* -Tascii */ + OUTT_LOCALE, /* -Tlocale */ + OUTT_UTF8, /* -Tutf8 */ + OUTT_TREE, /* -Ttree */ + OUTT_MAN, /* -Tman */ + OUTT_HTML, /* -Thtml */ + OUTT_MARKDOWN, /* -Tmarkdown */ + OUTT_LINT, /* -Tlint */ + OUTT_PS, /* -Tps */ + OUTT_PDF /* -Tpdf */ }; struct curparse { - const char *file; /* Current parse. */ - int fd; /* Current parse. */ - enum mandoclevel wlevel; /* Ignore messages below this. */ - int wstop; /* Stop after a file with a warning. */ - enum intt inttype; /* which parser to use */ - struct man *man; /* man parser */ - struct mdoc *mdoc; /* mdoc parser */ - struct roff *roff; /* roff parser (!NULL) */ - struct regset regs; /* roff registers */ - enum outt outtype; /* which output to use */ - out_mdoc outmdoc; /* mdoc output ptr */ - out_man outman; /* man output ptr */ - out_free outfree; /* free output ptr */ + struct mparse *mp; + struct manoutput *outopts; /* output options */ void *outdata; /* data for output */ - char outopts[BUFSIZ]; /* buf of output opts */ + char *os_s; /* operating system for display */ + int wstop; /* stop after a file with a warning */ + enum mandocerr mmin; /* ignore messages below this */ + enum mandoc_os os_e; /* check base system conventions */ + enum outt outtype; /* which output to use */ }; -static const char * const mandoclevels[MANDOCLEVEL_MAX] = { - "SUCCESS", - "RESERVED", - "WARNING", - "ERROR", - "FATAL", - "BADARG", - "SYSERR" -}; -static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = { - MANDOCERR_OK, - MANDOCERR_WARNING, - MANDOCERR_WARNING, - MANDOCERR_ERROR, - MANDOCERR_FATAL, - MANDOCERR_MAX, - MANDOCERR_MAX -}; +int mandocdb(int, char *[]); -static const char * const mandocerrs[MANDOCERR_MAX] = { - "ok", - - "generic warning", - - "text should be uppercase", - "sections out of conventional order", - "section name repeats", - "out of order prologue", - "repeated prologue entry", - "list type must come first", - "tab in non-literal context", - "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", - "blocks badly nested", - - "generic error", - - "NAME section must come first", - "bad Boolean value", - "child violates parent syntax", - "bad AT&T symbol", - "bad standard", - "list type repeated", - "display type repeated", - "argument repeated", - "ignoring argument", - "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", - "NOT IMPLEMENTED: skipping request", - "line scope broken", - "argument count wrong", - "request scope close w/none open", - "scope already open", - "scope open on exit", - "macro requires line argument(s)", - "macro requires body argument(s)", - "macro requires argument(s)", - "no title in document", - "missing list type", - "missing display type", - "missing font type", - "line argument(s) will be lost", - "body argument(s) will be lost", - "paragraph macro ignored", - - "generic fatal error", - - "column syntax is inconsistent", - "displays may not be nested", - "unsupported display type", - "blocks badly nested", - "no such block is open", - "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", - "static buffer exhausted", -}; - -static void fdesc(struct curparse *); -static void ffile(const char *, struct curparse *); -static int moptions(enum intt *, char *); -static int mmsg(enum mandocerr, void *, - int, int, const char *); -static void pset(const char *, int, struct curparse *, - struct man **, struct mdoc **); +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 *); +static void moptions(int *, char *); +static void mmsg(enum mandocerr, enum mandoclevel, + const char *, int, int, const char *); +static void outdata_alloc(struct curparse *); +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(void) __attribute__((noreturn)); -static void version(void) __attribute__((noreturn)); +static void usage(enum argmode) __attribute__((__noreturn__)); static int woptions(struct curparse *, char *); -static const char *progname; -static enum mandoclevel exit_status = MANDOCLEVEL_OK; +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; + int main(int argc, char *argv[]) { - int c; + struct manconf conf; + struct mansearch search; struct curparse curp; + struct tag_files *tag_files; + struct manpage *res, *resp; + const char *progname, *sec, *thisarg; + char *conf_file, *defpaths, *auxpaths; + char *oarg; + unsigned char *uc; + 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; - progname = strrchr(argv[0], '/'); - if (progname == NULL) +#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 + if (strncmp(progname, "mandocdb", 8) == 0 || + strcmp(progname, BINM_MAKEWHATIS) == 0) + return mandocdb(argc, argv); + +#if HAVE_PLEDGE + if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); +#endif + +#if HAVE_SANDBOX_INIT + if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) + errx((int)MANDOCLEVEL_SYSERR, "sandbox_init"); +#endif + + /* Search options. */ + + memset(&conf, 0, sizeof(conf)); + conf_file = defpaths = NULL; + auxpaths = NULL; + + memset(&search, 0, sizeof(struct mansearch)); + search.outkey = "Nd"; + oarg = NULL; + + 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.mmin = MANDOCERR_MAX; + curp.outopts = &conf.output; + options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; - curp.inttype = INTT_AUTO; - curp.outtype = OUTT_ASCII; - curp.wlevel = MANDOCLEVEL_FATAL; + use_pager = 1; + tag_files = NULL; + show_usage = 0; + outmode = OUTMODE_DEF; - /* LINTED */ - while (-1 != (c = getopt(argc, argv, "m:O:T:VW:"))) + while ((c = getopt(argc, argv, + "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) { + if (c == 'i' && search.argmode == ARG_EXPR) { + optind--; + break; + } switch (c) { - case ('m'): - if ( ! moptions(&curp.inttype, optarg)) - return((int)MANDOCLEVEL_BADARG); + case 'a': + outmode = OUTMODE_ALL; break; - case ('O'): - (void)strlcat(curp.outopts, optarg, BUFSIZ); - (void)strlcat(curp.outopts, ",", BUFSIZ); + case 'C': + conf_file = optarg; break; - case ('T'): + case 'c': + use_pager = 0; + break; + case 'f': + search.argmode = ARG_WORD; + break; + 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 (curp.os_s != NULL) { + warnx("-I %s: Duplicate argument", optarg); + return (int)MANDOCLEVEL_BADARG; + } + curp.os_s = mandoc_strdup(optarg + 3); + 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': + oarg = optarg; + break; + case 'S': + search.arch = optarg; + break; + case 's': + search.sec = optarg; + break; + case 'T': if ( ! toptions(&curp, optarg)) - return((int)MANDOCLEVEL_BADARG); + return (int)MANDOCLEVEL_BADARG; break; - case ('W'): + case 'W': if ( ! woptions(&curp, optarg)) - return((int)MANDOCLEVEL_BADARG); + return (int)MANDOCLEVEL_BADARG; break; - case ('V'): - version(); - /* NOTREACHED */ + case 'w': + outmode = OUTMODE_FLN; + break; default: - usage(); - /* NOTREACHED */ + show_usage = 1; + break; } + } - argc -= optind; - argv += optind; + if (show_usage) + usage(search.argmode); - if (NULL == *argv) { - curp.file = ""; - curp.fd = STDIN_FILENO; + /* Postprocess options. */ - fdesc(&curp); + 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; + } } - while (*argv) { - ffile(*argv, &curp); - if (MANDOCLEVEL_OK != exit_status && curp.wstop) - break; - ++argv; + if (oarg != NULL) { + if (outmode == OUTMODE_LST) + search.outkey = oarg; + else { + while (oarg != NULL) { + thisarg = oarg; + if (manconf_output(&conf.output, + strsep(&oarg, ","), 0) == 0) + continue; + warnx("-O %s: Bad argument", thisarg); + return (int)MANDOCLEVEL_BADARG; + } + } } - 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 (outmode == OUTMODE_FLN || + outmode == OUTMODE_LST || + !isatty(STDOUT_FILENO)) + use_pager = 0; - return((int)exit_status); -} +#if HAVE_PLEDGE + if (!use_pager) + if (pledge("stdio rpath", NULL) == -1) + err((int)MANDOCLEVEL_SYSERR, "pledge"); +#endif + /* Parse arguments. */ -static void -version(void) -{ + if (argc > 0) { + argc -= optind; + argv += optind; + } + resp = NULL; - (void)printf("%s %s\n", progname, VERSION); - exit((int)MANDOCLEVEL_OK); -} + /* + * Quirks for help(1) + * and for a man(1) section argument without -s. + */ + 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 + } -static void -usage(void) -{ + rc = MANDOCLEVEL_OK; - (void)fprintf(stderr, "usage: %s [-V] [-foption] " - "[-mformat] [-Ooption] [-Toutput] " - "[-Werr] [file...]\n", progname); - exit((int)MANDOCLEVEL_BADARG); -} + /* man(1), whatis(1), apropos(1) */ + if (search.argmode != ARG_FILE) { + if (search.argmode == ARG_NAME && + outmode == OUTMODE_ONE) + search.firstmatch = 1; -static void -ffile(const char *file, struct curparse *curp) -{ + /* Access the mandoc database. */ - curp->file = file; - if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { - perror(curp->file); - exit_status = MANDOCLEVEL_SYSERR; - return; - } + manconf_parse(&conf, conf_file, defpaths, auxpaths); + if ( ! mansearch(&search, &conf.manpath, + argc, argv, &res, &sz)) + usage(search.argmode); - fdesc(curp); + if (sz == 0) { + if (search.argmode == ARG_NAME) + fs_search(&search, &conf.manpath, + argc, argv, &res, &sz); + else + warnx("nothing appropriate"); + } - if (-1 == close(curp->fd)) - perror(curp->file); -} + 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. + */ -static void -resize_buf(struct buf *buf, size_t initial) -{ + if (outmode == OUTMODE_ONE) { + argc = 1; + best_prio = 20; + } else if (outmode == OUTMODE_ALL) + argc = (int)sz; - buf->sz = buf->sz ? 2 * buf->sz : initial; - buf->buf = realloc(buf->buf, buf->sz); - if (NULL == buf->buf) { - perror(NULL); - exit((int)MANDOCLEVEL_SYSERR); - } -} + /* 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; + } + } -static int -read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap) -{ - struct stat st; - size_t off; - ssize_t ssz; + /* + * 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 (-1 == fstat(curp->fd, &st)) { - perror(curp->file); - return(0); + if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) + goto out; } - /* - * 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. - */ + /* mandoc(1) */ - if (S_ISREG(st.st_mode)) { - if (st.st_size >= (1U << 31)) { - fprintf(stderr, "%s: input too large\n", - curp->file); - 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); +#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); + + mchars_alloc(); + curp.mp = mparse_alloc(options, curp.mmin, mmsg, + curp.os_e, curp.os_s); + /* - * 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. + * Conditionally start up the lookaside buffer before parsing. */ + if (OUTT_MAN == curp.outtype) + mparse_keep(curp.mp); - *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; - } - resize_buf(fb, 65536); - } - 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; + if (argc < 1) { + if (use_pager) + tag_files = tag_init(); + parse(&curp, STDIN_FILENO, ""); } - free(fb->buf); - fb->buf = NULL; - return(0); -} + 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); -static void -fdesc(struct curparse *curp) -{ - struct buf ln, blk; - int i, pos, lnn, lnn_start, with_mmap, of; - enum rofferr re; - unsigned char c; - struct man *man; - struct mdoc *mdoc; - struct roff *roff; + if (argc > 1 && curp.outtype <= OUTT_UTF8) { + if (curp.outdata == NULL) + outdata_alloc(&curp); + terminal_sepline(curp.outdata); + } + } else if (rc < MANDOCLEVEL_ERROR) + rc = MANDOCLEVEL_ERROR; - man = NULL; - mdoc = NULL; - roff = NULL; + if (MANDOCLEVEL_OK != rc && curp.wstop) + break; - memset(&ln, 0, sizeof(struct buf)); + if (resp != NULL) + resp++; + else + argv++; + if (--argc) + mparse_reset(curp.mp); + } - /* - * Two buffers: ln and buf. buf is the input file and may be - * memory mapped. ln is a line buffer and grows on-demand. - */ + 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; + } + } + mparse_free(curp.mp); + mchars_free(); - if ( ! read_whole_file(curp, &blk, &with_mmap)) { - exit_status = MANDOCLEVEL_SYSERR; - return; +out: + if (search.argmode != ARG_FILE) { + manconf_free(&conf); + mansearch_free(res, sz); } - if (NULL == curp->roff) - curp->roff = roff_alloc(&curp->regs, curp, mmsg); - assert(curp->roff); - roff = curp->roff; + free(curp.os_s); - 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; - } + /* + * When using a pager, finish writing both temporary files, + * fork it, wait for the user to close it, and clean up. + */ - /* - * Warn about bogus characters. If you're using - * non-ASCII encoding, you're screwing your - * readers. Since I'd rather this not happen, - * I'll be helpful and drop these characters so - * we don't display gibberish. Note to manual - * writers: use special characters. - */ + 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 (;;) { - c = (unsigned char) blk.buf[i]; - if ( ! (isascii(c) && (isgraph(c) || isblank(c)))) { - mmsg(MANDOCERR_BADCHAR, curp, - lnn_start, pos, "ignoring byte"); - i++; + /* Stop here until moved to the foreground. */ + + tc_pgid = tcgetpgrp(tag_files->ofd); + if (tc_pgid != man_pgid) { + if (tc_pgid == pager_pid) { + (void)tcsetpgrp(tag_files->ofd, + man_pgid); + if (signum == SIGTTIN) + continue; + } else + tag_files->tcpgid = tc_pgid; + kill(0, signum); continue; } - /* Trailing backslash is like a plain character. */ - if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { - if (pos >= (int)ln.sz) - resize_buf(&ln, 256); - ln.buf[pos++] = blk.buf[i++]; + /* Once in the foreground, activate the pager. */ + + if (pager_pid) { + (void)tcsetpgrp(tag_files->ofd, 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; - } - /* 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; - } + + if (pid == -1) { + warn("wait"); + rc = MANDOCLEVEL_SYSERR; break; } - /* Some other escape sequence, copy and continue. */ - if (pos + 1 >= (int)ln.sz) - resize_buf(&ln, 256); + if (!WIFSTOPPED(status)) + break; - ln.buf[pos++] = blk.buf[i++]; - ln.buf[pos++] = blk.buf[i++]; + signum = WSTOPSIG(status); } + tag_unlink(); + } - if (pos >= (int)ln.sz) - resize_buf(&ln, 256); - ln.buf[pos] = '\0'; + return (int)rc; +} - /* - * 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. - */ +static void +usage(enum argmode argmode) +{ - of = 0; - do { - re = roff_parseln(roff, lnn_start, - &ln.buf, &ln.sz, of, &of); - } while (ROFF_RERUN == re); + switch (argmode) { + case ARG_FILE: + fputs("usage: mandoc [-ac] [-I os=name] " + "[-K encoding] [-mdoc | -man] [-O options]\n" + "\t [-T output] [-W level] [file ...]\n", stderr); + break; + case ARG_NAME: + fputs("usage: man [-acfhklw] [-C file] [-M path] " + "[-m path] [-S subsection]\n" + "\t [[-s] section] name ...\n", stderr); + break; + case ARG_WORD: + fputs("usage: whatis [-afk] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] name ...\n", stderr); + break; + case ARG_EXPR: + fputs("usage: apropos [-afk] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" + "\t [-s section] expression ...\n", stderr); + break; + } + exit((int)MANDOCLEVEL_BADARG); +} - if (ROFF_IGN == re) { - continue; - } else if (ROFF_ERR == re) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; - } +static int +fs_lookup(const struct manpaths *paths, size_t ipath, + const char *sec, const char *arch, const char *name, + struct manpage **res, size_t *ressz) +{ + glob_t globinfo; + struct manpage *page; + char *file; + int globres; + enum form form; - /* - * 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. - */ + 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); - if ( ! (man || mdoc)) - pset(ln.buf + of, pos - of, curp, &man, &mdoc); + 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); - /* Lastly, push down into the parsers themselves. */ + 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 (man && ! man_parseln(man, lnn_start, ln.buf, of)) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; + 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; + +found: + warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s", + name, sec, BINM_MAKEWHATIS, 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 +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]); + + 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 (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of)) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; - } + if (*ressz == lastsz) + warnx("No entry for %s in the manual.", *argv); + lastsz = *ressz; + argv++; + argc--; } +} - /* NOTE a parser may not have been assigned, yet. */ +static void +parse(struct curparse *curp, int fd, const char *file) +{ + enum mandoclevel rctmp; + struct roff_man *man; - if ( ! (man || mdoc)) { - fprintf(stderr, "%s: Not a manual\n", curp->file); - exit_status = MANDOCLEVEL_FATAL; - goto cleanup; - } + /* Begin by parsing the file itself. */ - /* Clean up the parse routine ASTs. */ + assert(file); + assert(fd >= 0); - if (mdoc && ! mdoc_endparse(mdoc)) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; - } - if (man && ! man_endparse(man)) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; - } - if (roff && ! roff_endparse(roff)) { - assert(MANDOCLEVEL_FATAL <= exit_status); - goto cleanup; - } + rctmp = mparse_readfd(curp->mp, fd, file); + if (fd != STDIN_FILENO) + close(fd); + if (rc < rctmp) + rc = rctmp; /* - * With -Wstop and warnings or errors of at least - * the requested level, do not produce output. + * With -Wstop and warnings or errors of at least the requested + * level, do not produce output. */ - if (MANDOCLEVEL_OK != exit_status && curp->wstop) - goto cleanup; + if (rctmp != MANDOCLEVEL_OK && curp->wstop) + return; - /* If unset, allocate output dev now (if applicable). */ + if (curp->outdata == NULL) + outdata_alloc(curp); - if ( ! (curp->outman && curp->outmdoc)) { + mparse_result(curp->mp, &man, NULL); + + /* Execute the out device, if it exists. */ + + if (man == NULL) + return; + if (man->macroset == MACROSET_MDOC) { + if (curp->outtype != OUTT_TREE || !curp->outopts->noval) + mdoc_validate(man); switch (curp->outtype) { - case (OUTT_XHTML): - curp->outdata = xhtml_alloc(curp->outopts); + case OUTT_HTML: + html_mdoc(curp->outdata, man); break; - case (OUTT_HTML): - curp->outdata = html_alloc(curp->outopts); + case OUTT_TREE: + tree_mdoc(curp->outdata, man); break; - case (OUTT_ASCII): - curp->outdata = ascii_alloc(curp->outopts); - curp->outfree = ascii_free; + case OUTT_MAN: + man_mdoc(curp->outdata, man); break; - case (OUTT_PDF): - curp->outdata = pdf_alloc(curp->outopts); - curp->outfree = pspdf_free; + case OUTT_PDF: + case OUTT_ASCII: + case OUTT_UTF8: + case OUTT_LOCALE: + case OUTT_PS: + terminal_mdoc(curp->outdata, man); break; - case (OUTT_PS): - curp->outdata = ps_alloc(curp->outopts); - curp->outfree = pspdf_free; + case OUTT_MARKDOWN: + markdown_mdoc(curp->outdata, man); break; default: break; } - + } + if (man->macroset == MACROSET_MAN) { + if (curp->outtype != OUTT_TREE || !curp->outopts->noval) + man_validate(man); switch (curp->outtype) { - case (OUTT_HTML): - /* FALLTHROUGH */ - case (OUTT_XHTML): - curp->outman = html_man; - curp->outmdoc = html_mdoc; - curp->outfree = html_free; + case OUTT_HTML: + html_man(curp->outdata, man); break; - case (OUTT_TREE): - curp->outman = tree_man; - curp->outmdoc = tree_mdoc; + case OUTT_TREE: + tree_man(curp->outdata, man); break; - case (OUTT_PDF): - /* FALLTHROUGH */ - case (OUTT_ASCII): - /* FALLTHROUGH */ - case (OUTT_PS): - curp->outman = terminal_man; - curp->outmdoc = terminal_mdoc; + 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; } } + mparse_updaterc(curp->mp, &rc); +} - /* Execute the out device, if it exists. */ - - if (man && curp->outman) - (*curp->outman)(curp->outdata, man); - if (mdoc && curp->outmdoc) - (*curp->outmdoc)(curp->outdata, mdoc); - - cleanup: - memset(&curp->regs, 0, sizeof(struct regset)); - 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; +static void +outdata_alloc(struct curparse *curp) +{ + 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; + } } - static void -pset(const char *buf, int pos, struct curparse *curp, - struct man **man, struct mdoc **mdoc) +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, *cp; + size_t linesz; + ssize_t len, written; + 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; + line = NULL; + linesz = 0; + + if (fflush(stdout) == EOF) { + syscall = "fflush"; + goto fail; } - switch (curp->inttype) { - case (INTT_MDOC): - if (NULL == curp->mdoc) - curp->mdoc = mdoc_alloc(&curp->regs, curp, mmsg); - assert(curp->mdoc); - *mdoc = curp->mdoc; - return; - case (INTT_MAN): - if (NULL == curp->man) - curp->man = man_alloc(&curp->regs, curp, mmsg); - assert(curp->man); - *man = curp->man; - return; - default: - break; + if ((stream = fdopen(fd, "r")) == NULL) { + close(fd); + syscall = "fdopen"; + goto fail; } - if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { - if (NULL == curp->mdoc) - curp->mdoc = mdoc_alloc(&curp->regs, curp, mmsg); - assert(curp->mdoc); - *mdoc = curp->mdoc; - return; - } + print = 0; + while ((len = 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++; + len--; + } + } else { + if (strcmp(cp, synb) == 0 || + strcmp(cp, synr) == 0) + print = 1; + continue; + } + } + for (; len > 0; len -= written) { + if ((written = write(STDOUT_FILENO, cp, len)) != -1) + continue; + fclose(stream); + syscall = "write"; + goto fail; + } + } - if (NULL == curp->man) - curp->man = man_alloc(&curp->regs, curp, mmsg); - assert(curp->man); - *man = curp->man; -} + if (ferror(stream)) { + fclose(stream); + syscall = "getline"; + goto fail; + } +done: + free(line); + fclose(stream); + return; +fail: + free(line); + warn("%s: SYSERR: %s", file, syscall); + if (rc < MANDOCLEVEL_SYSERR) + rc = MANDOCLEVEL_SYSERR; +} + static int -moptions(enum intt *tflags, char *arg) +koptions(int *options, 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 { - fprintf(stderr, "%s: Bad argument\n", arg); - return(0); + 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); + return 1; } +static void +moptions(int *options, char *arg) +{ + if (arg == NULL) + return; + if (strcmp(arg, "doc") == 0) + *options |= MPARSE_MDOC; + else if (strcmp(arg, "an") == 0) + *options |= MPARSE_MAN; +} + static int toptions(struct curparse *curp, char *arg) { @@ -740,90 +939,191 @@ toptions(struct curparse *curp, char *arg) 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->mmin = MANDOCERR_BASE; + } 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, "xhtml")) - curp->outtype = OUTT_XHTML; + else if (0 == strcmp(arg, "markdown")) + curp->outtype = OUTT_MARKDOWN; + 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, "ps")) curp->outtype = OUTT_PS; else if (0 == strcmp(arg, "pdf")) curp->outtype = OUTT_PDF; else { - fprintf(stderr, "%s: Bad argument\n", arg); - return(0); + warnx("-T %s: Bad argument", arg); + return 0; } - return(1); + return 1; } - static int woptions(struct curparse *curp, char *arg) { char *v, *o; - const char *toks[6]; + const char *toks[11]; toks[0] = "stop"; toks[1] = "all"; - toks[2] = "warning"; - toks[3] = "error"; - toks[4] = "fatal"; - toks[5] = NULL; + toks[2] = "base"; + toks[3] = "style"; + toks[4] = "warning"; + toks[5] = "error"; + toks[6] = "unsupp"; + toks[7] = "fatal"; + toks[8] = "openbsd"; + toks[9] = "netbsd"; + toks[10] = NULL; while (*arg) { o = arg; - switch (getsubopt(&arg, UNCONST(toks), &v)) { - case (0): + switch (getsubopt(&arg, (char * const *)toks, &v)) { + case 0: curp->wstop = 1; break; - case (1): - /* FALLTHROUGH */ - case (2): - curp->wlevel = MANDOCLEVEL_WARNING; + case 1: + case 2: + curp->mmin = MANDOCERR_BASE; break; - case (3): - curp->wlevel = MANDOCLEVEL_ERROR; + case 3: + curp->mmin = MANDOCERR_STYLE; break; - case (4): - curp->wlevel = MANDOCLEVEL_FATAL; + case 4: + curp->mmin = MANDOCERR_WARNING; break; + case 5: + curp->mmin = MANDOCERR_ERROR; + break; + case 6: + curp->mmin = MANDOCERR_UNSUPP; + break; + case 7: + curp->mmin = MANDOCERR_MAX; + break; + case 8: + curp->mmin = MANDOCERR_BASE; + curp->os_e = MANDOC_OS_OPENBSD; + break; + case 9: + curp->mmin = MANDOCERR_BASE; + curp->os_e = MANDOC_OS_NETBSD; + break; default: - fprintf(stderr, "-W%s: Bad argument\n", o); - return(0); + warnx("-W %s: Bad argument", o); + return 0; } } - - return(1); + return 1; } - -static int -mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) +static void +mmsg(enum mandocerr t, enum mandoclevel lvl, + const char *file, int line, int col, const char *msg) { - struct curparse *cp; - enum mandoclevel level; + const char *mparse_msg; - level = MANDOCLEVEL_FATAL; - while (t < mandoclimits[level]) - /* LINTED */ - level--; + fprintf(stderr, "%s: %s:", getprogname(), + file == NULL ? "" : file); - cp = (struct curparse *)arg; - if (level < cp->wlevel) - return(1); + if (line) + fprintf(stderr, "%d:%d:", line, col + 1); - fprintf(stderr, "%s:%d:%d: %s: %s", - cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]); + fprintf(stderr, " %s", + t < MANDOCERR_STYLE ? "BASE" : mparse_strlevel(lvl)); + + if ((mparse_msg = mparse_strerror(t)) != NULL) + fprintf(stderr, ": %s", mparse_msg); + if (msg) fprintf(stderr, ": %s", msg); + fputc('\n', stderr); +} - if (exit_status < level) - exit_status = level; - - return(level < MANDOCLEVEL_FATAL); +static pid_t +spawn_pager(struct tag_files *tag_files) +{ + 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; + + pager = getenv("MANPAGER"); + if (pager == NULL || *pager == '\0') + pager = getenv("PAGER"); + if (pager == NULL || *pager == '\0') + pager = "more -s"; + cp = mandoc_strdup(pager); + + /* + * 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; + *cp++ = '\0'; + while (*cp == ' ') + cp++; + if (*cp == '\0') + break; + } + + /* For less(1), use the tag file. */ + + if ((cmdlen = strlen(argv[0])) >= 4) { + cp = argv[0] + cmdlen - 4; + if (strcmp(cp, "less") == 0) { + argv[argc++] = mandoc_strdup("-T"); + argv[argc++] = tag_files->tfn; + } + } + argv[argc++] = tag_files->ofn; + argv[argc] = NULL; + + switch (pager_pid = fork()) { + case -1: + err((int)MANDOCLEVEL_SYSERR, "fork"); + case 0: + break; + default: + (void)setpgid(pager_pid, 0); + (void)tcsetpgrp(tag_files->ofd, 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(STDOUT_FILENO) != getpid()) + nanosleep(&timeout, NULL); + + execvp(argv[0], argv); + err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]); }