=================================================================== RCS file: /cvs/mandoc/main.c,v retrieving revision 1.184 retrieving revision 1.217 diff -u -p -r1.184 -r1.217 --- mandoc/main.c 2014/08/22 04:52:55 1.184 +++ mandoc/main.c 2015/01/20 21:16:51 1.217 @@ -1,7 +1,7 @@ -/* $Id: main.c,v 1.184 2014/08/22 04:52:55 schwarze Exp $ */ +/* $Id: main.c,v 1.217 2015/01/20 21:16:51 schwarze Exp $ */ /* * Copyright (c) 2008-2012 Kristaps Dzonsons - * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze + * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze * Copyright (c) 2010 Joerg Sonnenberger * * Permission to use, copy, modify, and distribute this software for any @@ -19,9 +19,12 @@ #include "config.h" #include +#include /* MACHINE */ #include +#include #include +#include #include #include #include @@ -62,7 +65,6 @@ enum outt { OUTT_TREE, /* -Ttree */ OUTT_MAN, /* -Tman */ OUTT_HTML, /* -Thtml */ - OUTT_XHTML, /* -Txhtml */ OUTT_LINT, /* -Tlint */ OUTT_PS, /* -Tps */ OUTT_PDF /* -Tpdf */ @@ -70,6 +72,7 @@ enum outt { struct curparse { 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 */ @@ -80,11 +83,27 @@ struct curparse { char outopts[BUFSIZ]; /* buf of output opts */ }; +#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(enum argmode) __attribute__((noreturn)); @@ -92,6 +111,8 @@ static void version(void) __attribute__((noreturn)) 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; @@ -101,17 +122,19 @@ main(int argc, char *argv[]) struct curparse curp; struct mansearch search; struct manpaths paths; - char *conf_file, *defpaths, *auxpaths; + char *auxpaths; char *defos; + unsigned char *uc; #if HAVE_SQLITE3 - struct manpage *res; - char **auxargv; + struct manpage *res, *resp; + char *conf_file, *defpaths; size_t isec, i, sz; - int prio, best_prio; + int prio, best_prio, synopsis_only; char sec; #endif - enum mandoclevel rc; + enum mandoclevel rc, rctmp; enum outmode outmode; + int fd; int show_usage; int use_pager; int options; @@ -123,42 +146,58 @@ 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)); - conf_file = defpaths = auxpaths = NULL; +#if HAVE_SQLITE3 + conf_file = defpaths = NULL; +#endif + auxpaths = NULL; memset(&search, 0, sizeof(struct mansearch)); search.outkey = "Nd"; - if (strcmp(progname, "man") == 0) + if (strcmp(progname, BINM_MAN) == 0) search.argmode = ARG_NAME; - else if (strncmp(progname, "apropos", 7) == 0) + else if (strcmp(progname, BINM_APROPOS) == 0) search.argmode = ARG_EXPR; - else if (strncmp(progname, "whatis", 6) == 0) + 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_ASCII; - curp.wlevel = MANDOCLEVEL_FATAL; - options = MPARSE_SO; + curp.outtype = OUTT_LOCALE; + curp.wlevel = MANDOCLEVEL_BADARG; + options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; defos = NULL; use_pager = 1; show_usage = 0; +#if HAVE_SQLITE3 + synopsis_only = 0; +#endif outmode = OUTMODE_DEF; - while (-1 != (c = getopt(argc, argv, "aC:cfI:ikM:m:O:S:s:T:VW:w"))) { + while (-1 != (c = getopt(argc, argv, + "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) { switch (c) { case 'a': outmode = OUTMODE_ALL; break; case 'C': +#if HAVE_SQLITE3 conf_file = optarg; +#endif break; case 'c': use_pager = 0; @@ -166,16 +205,24 @@ main(int argc, char *argv[]) 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", + "%s: -I %s: Bad argument\n", progname, optarg); return((int)MANDOCLEVEL_BADARG); } if (defos) { fprintf(stderr, - "%s: -I%s: Duplicate argument\n", + "%s: -I %s: Duplicate argument\n", progname, optarg); return((int)MANDOCLEVEL_BADARG); } @@ -184,11 +231,21 @@ main(int argc, char *argv[]) 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; @@ -227,6 +284,8 @@ main(int argc, char *argv[]) if (show_usage) usage(search.argmode); + /* Postprocess options. */ + if (outmode == OUTMODE_DEF) { switch (search.argmode) { case ARG_FILE: @@ -242,12 +301,40 @@ main(int argc, char *argv[]) } } + /* Parse arguments. */ + argc -= optind; argv += optind; #if HAVE_SQLITE3 - auxargv = NULL; + resp = NULL; #endif + /* + * 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 = 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; + } + rc = MANDOCLEVEL_OK; /* man(1), whatis(1), apropos(1) */ @@ -257,14 +344,25 @@ main(int argc, char *argv[]) if (argc == 0) usage(search.argmode); + if (search.argmode == ARG_NAME && + outmode == OUTMODE_ONE) + search.firstmatch = 1; + /* Access the mandoc database. */ manpath_parse(&paths, conf_file, defpaths, auxpaths); mansearch_setup(1); if( ! mansearch(&search, &paths, argc, argv, &res, &sz)) usage(search.argmode); - manpath_free(&paths); + if (sz == 0 && search.argmode == ARG_NAME) + fs_search(&search, &paths, argc, argv, &res, &sz); + + if (sz == 0) { + rc = MANDOCLEVEL_BADARG; + goto out; + } + /* * For standard man(1) and -a output mode, * prepare for copying filename pointers @@ -273,18 +371,13 @@ main(int argc, char *argv[]) if (outmode == OUTMODE_ONE) { argc = 1; - argv[0] = res[0].file; - argv[1] = NULL; best_prio = 10; - } else if (outmode == OUTMODE_ALL) { + } else if (outmode == OUTMODE_ALL) argc = (int)sz; - argv = auxargv = mandoc_reallocarray( - NULL, sz + 1, sizeof(char *)); - argv[argc] = NULL; - } /* Iterate all matching manuals. */ + resp = res; for (i = 0; i < sz; i++) { if (outmode == OUTMODE_FLN) puts(res[i].file); @@ -292,9 +385,7 @@ main(int argc, char *argv[]) printf("%s - %s\n", res[i].names, res[i].output == NULL ? "" : res[i].output); - else if (outmode == OUTMODE_ALL) - argv[i] = res[i].file; - else { + else if (outmode == OUTMODE_ONE) { /* Search for the best section. */ isec = strcspn(res[i].file, "123456789"); sec = res[i].file[isec]; @@ -304,7 +395,7 @@ main(int argc, char *argv[]) if (prio >= best_prio) continue; best_prio = prio; - argv[0] = res[i].file; + resp = res + i; } } @@ -325,41 +416,88 @@ main(int argc, char *argv[]) /* mandoc(1) */ - if ( ! moptions(&options, auxpaths)) + if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths)) return((int)MANDOCLEVEL_BADARG); - if (use_pager && isatty(STDOUT_FILENO)) - spawn_pager(); + curp.mchars = mchars_alloc(); + curp.mp = mparse_alloc(options, curp.wlevel, mmsg, + curp.mchars, defos); - curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos); - /* * Conditionally start up the lookaside buffer before parsing. */ if (OUTT_MAN == curp.outtype) mparse_keep(curp.mp); - if (NULL == *argv) + if (argc == 0) { + if (use_pager && isatty(STDOUT_FILENO)) + spawn_pager(); parse(&curp, STDIN_FILENO, "", &rc); + } - while (*argv) { - parse(&curp, -1, *argv, &rc); + while (argc) { + rctmp = mparse_open(curp.mp, &fd, +#if HAVE_SQLITE3 + resp != NULL ? resp->file : +#endif + *argv); + if (rc < rctmp) + rc = rctmp; + + if (fd != -1) { + if (use_pager && isatty(STDOUT_FILENO)) + spawn_pager(); + use_pager = 0; + +#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 + + rctmp = mparse_wait(curp.mp); + if (rc < rctmp) + rc = rctmp; + + if (argc > 1 && curp.outtype <= OUTT_UTF8) + ascii_sepline(curp.outdata); + } + if (MANDOCLEVEL_OK != rc && curp.wstop) break; - ++argv; + +#if HAVE_SQLITE3 + if (resp != NULL) + resp++; + else +#endif + argv++; + if (--argc) + mparse_reset(curp.mp); } if (curp.outfree) (*curp.outfree)(curp.outdata); - if (curp.mp) - mparse_free(curp.mp); + mparse_free(curp.mp); + mchars_free(curp.mchars); #if HAVE_SQLITE3 out: if (search.argmode != ARG_FILE) { + manpath_free(&paths); mansearch_free(res, sz); mansearch_setup(0); - free(auxargv); } #endif @@ -382,29 +520,124 @@ usage(enum argmode argmode) switch (argmode) { case ARG_FILE: - fputs("usage: mandoc [-V] [-Ios=name] [-mformat]" - " [-Ooption] [-Toutput] [-Wlevel]\n" - "\t [file ...]\n", stderr); + fputs("usage: mandoc [-acfhklV] [-Ios=name] " + "[-Kencoding] [-mformat] [-Ooption]\n" + "\t [-Toutput] [-Wlevel] [file ...]\n", stderr); break; case ARG_NAME: - fputs("usage: man [-acfhkVw] [-C file] " - "[-M path] [-m path] [-S arch] [-s section]\n" + 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 [-V] [-C file] [-M path] [-m path] " - "[-S arch] [-s section] name ...\n", stderr); + 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 [-V] [-C file] [-M path] [-m path] " - "[-O outkey] [-S arch]\n" + fputs("usage: apropos [-acfhklVw] [-C file] " + "[-M path] [-m path] [-O outkey] [-S arch]\n" "\t [-s section] expression ...\n", stderr); break; } exit((int)MANDOCLEVEL_BADARG); } +#if HAVE_SQLITE3 +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) +{ + struct manpage *page; + char *file; + int form; + + 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); + + 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 (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; + } + free(file); + } + 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 +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", "3p", "5", "7", "4", "9"}; + 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 (*ressz == lastsz) + fprintf(stderr, + "%s: No entry for %s in the manual.\n", + progname, *argv); + lastsz = *ressz; + argv++; + argc--; + } +} +#endif + +static void parse(struct curparse *curp, int fd, const char *file, enum mandoclevel *level) { @@ -419,11 +652,6 @@ parse(struct curparse *curp, int fd, const char *file, rc = mparse_readfd(curp->mp, fd, file); - /* Stop immediately if the parse has failed. */ - - if (MANDOCLEVEL_FATAL <= rc) - goto cleanup; - /* * With -Wstop and warnings or errors of at least the requested * level, do not produce output. @@ -436,32 +664,34 @@ parse(struct curparse *curp, int fd, const char *file, if ( ! (curp->outman && curp->outmdoc)) { switch (curp->outtype) { - case OUTT_XHTML: - curp->outdata = xhtml_alloc(curp->outopts); - curp->outfree = html_free; - break; case OUTT_HTML: - curp->outdata = html_alloc(curp->outopts); + curp->outdata = html_alloc(curp->mchars, + curp->outopts); curp->outfree = html_free; break; case OUTT_UTF8: - curp->outdata = utf8_alloc(curp->outopts); + curp->outdata = utf8_alloc(curp->mchars, + curp->outopts); curp->outfree = ascii_free; break; case OUTT_LOCALE: - curp->outdata = locale_alloc(curp->outopts); + curp->outdata = locale_alloc(curp->mchars, + curp->outopts); curp->outfree = ascii_free; break; case OUTT_ASCII: - curp->outdata = ascii_alloc(curp->outopts); + curp->outdata = ascii_alloc(curp->mchars, + curp->outopts); curp->outfree = ascii_free; break; case OUTT_PDF: - curp->outdata = pdf_alloc(curp->outopts); + curp->outdata = pdf_alloc(curp->mchars, + curp->outopts); curp->outfree = pspdf_free; break; case OUTT_PS: - curp->outdata = ps_alloc(curp->outopts); + curp->outdata = ps_alloc(curp->mchars, + curp->outopts); curp->outfree = pspdf_free; break; default: @@ -470,8 +700,6 @@ parse(struct curparse *curp, int fd, const char *file, switch (curp->outtype) { case OUTT_HTML: - /* FALLTHROUGH */ - case OUTT_XHTML: curp->outman = html_man; curp->outmdoc = html_mdoc; break; @@ -509,15 +737,100 @@ parse(struct curparse *curp, int fd, const char *file, if (mdoc && curp->outmdoc) (*curp->outmdoc)(curp->outdata, mdoc); - cleanup: - - mparse_reset(curp->mp); - +cleanup: if (*level < rc) *level = rc; } +#if HAVE_SQLITE3 +static enum mandoclevel +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"; + + FILE *stream; + const char *syscall; + char *line; + size_t len, off; + ssize_t nw; + int print; + + fflush(stdout); + + if ((stream = fdopen(fd, "r")) == NULL) { + close(fd); + syscall = "fdopen"; + goto fail; + } + + 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 (ferror(stream)) { + fclose(stream); + syscall = "fgetln"; + goto fail; + } + +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(int *options, char *arg) { @@ -530,7 +843,7 @@ moptions(int *options, char *arg) else if (0 == strcmp(arg, "an")) *options |= MPARSE_MAN; else { - fprintf(stderr, "%s: -m%s: Bad argument\n", + fprintf(stderr, "%s: -m %s: Bad argument\n", progname, arg); return(0); } @@ -558,13 +871,13 @@ toptions(struct curparse *curp, char *arg) 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: -T%s: Bad argument\n", + fprintf(stderr, "%s: -T %s: Bad argument\n", progname, arg); return(0); } @@ -576,14 +889,15 @@ static int woptions(struct curparse *curp, char *arg) { char *v, *o; - const char *toks[6]; + const char *toks[7]; toks[0] = "stop"; toks[1] = "all"; toks[2] = "warning"; toks[3] = "error"; - toks[4] = "fatal"; - toks[5] = NULL; + toks[4] = "unsupp"; + toks[5] = "fatal"; + toks[6] = NULL; while (*arg) { o = arg; @@ -600,10 +914,13 @@ woptions(struct curparse *curp, char *arg) curp->wlevel = MANDOCLEVEL_ERROR; break; case 4: - curp->wlevel = MANDOCLEVEL_FATAL; + curp->wlevel = MANDOCLEVEL_UNSUPP; break; + case 5: + curp->wlevel = MANDOCLEVEL_BADARG; + break; default: - fprintf(stderr, "%s: -W%s: Bad argument\n", + fprintf(stderr, "%s: -W %s: Bad argument\n", progname, o); return(0); }