=================================================================== RCS file: /cvs/mandoc/main.c,v retrieving revision 1.335 retrieving revision 1.341 diff -u -p -r1.335 -r1.341 --- mandoc/main.c 2019/07/26 23:12:15 1.335 +++ mandoc/main.c 2020/01/20 10:37:15 1.341 @@ -1,4 +1,4 @@ -/* $Id: main.c,v 1.335 2019/07/26 23:12:15 schwarze Exp $ */ +/* $Id: main.c,v 1.341 2020/01/20 10:37:15 schwarze Exp $ */ /* * Copyright (c) 2008-2012 Kristaps Dzonsons * Copyright (c) 2010-2012, 2014-2019 Ingo Schwarze @@ -32,6 +32,7 @@ #include #include #include +#include #if HAVE_SANDBOX_INIT #include #endif @@ -78,8 +79,11 @@ enum outt { }; struct outstate { + struct tag_files *tag_files; /* Tagging state variables. */ void *outdata; /* data for output */ + int use_pager; int wstop; /* stop after a file with a warning */ + int had_output; /* Some output was generated. */ enum outt outtype; /* which output to use */ }; @@ -92,12 +96,14 @@ static int fs_lookup(const struct manpaths *, const char *, const char *, struct manpage **, size_t *); static int fs_search(const struct mansearch *, - const struct manpaths *, int, char**, + const struct manpaths *, const char *, struct manpage **, size_t *); static void outdata_alloc(struct outstate *, struct manoutput *); static void parse(struct mparse *, int, const char *, struct outstate *, struct manoutput *); static void passthrough(int, int); +static void process_onefile(struct mparse *, struct manpage *, + int, struct outstate *, struct manconf *); static void run_pager(struct tag_files *); static pid_t spawn_pager(struct tag_files *); static void usage(enum argmode) __attribute__((__noreturn__)); @@ -115,24 +121,24 @@ main(int argc, char *argv[]) struct outstate outst; /* Output state. */ struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */ struct mansearch search; /* Search options. */ - struct manpage *res, *resp; /* Search results. */ + struct manpage *res; /* Complete list of search results. */ + struct manpage *resn; /* Search results for one name. */ struct mparse *mp; /* Opaque parser object. */ - struct tag_files *tag_files; /* Tagging state variables. */ const char *conf_file; /* -C: alternate config file. */ const char *os_s; /* -I: Operating system for display. */ - const char *progname, *sec, *thisarg; + const char *progname, *sec; char *defpaths; /* -M: override manpaths. */ char *auxpaths; /* -m: additional manpaths. */ char *oarg; /* -O: output option string. */ char *tagarg; /* -O tag: default value. */ unsigned char *uc; - size_t sz; /* Number of elements in res[]. */ - size_t i, ssz; + size_t ressz; /* Number of elements in res[]. */ + size_t resnsz; /* Number of elements in resn[]. */ + size_t i, ib, ssz; int options; /* Parser options. */ int show_usage; /* Invalid argument: give up. */ - int use_pager; /* According to command line. */ int prio, best_prio; - int fd, startdir; + int startdir; int c; enum mandoc_os os_e; /* Check base system conventions. */ enum outmode outmode; /* According to command line. */ @@ -195,10 +201,10 @@ main(int argc, char *argv[]) /* Formatter options. */ memset(&outst, 0, sizeof(outst)); + outst.tag_files = NULL; outst.outtype = OUTT_LOCALE; + outst.use_pager = 1; - use_pager = 1; - tag_files = NULL; show_usage = 0; outmode = OUTMODE_DEF; @@ -216,14 +222,14 @@ main(int argc, char *argv[]) conf_file = optarg; break; case 'c': - use_pager = 0; + outst.use_pager = 0; break; case 'f': search.argmode = ARG_WORD; break; case 'h': conf.output.synopsisonly = 1; - use_pager = 0; + outst.use_pager = 0; outmode = OUTMODE_ALL; break; case 'I': @@ -324,7 +330,7 @@ main(int argc, char *argv[]) switch (search.argmode) { case ARG_FILE: outmode = OUTMODE_ALL; - use_pager = 0; + outst.use_pager = 0; break; case ARG_NAME: outmode = OUTMODE_ONE; @@ -353,9 +359,9 @@ main(int argc, char *argv[]) if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST || !isatty(STDOUT_FILENO)) - use_pager = 0; + outst.use_pager = 0; - if (use_pager && + if (outst.use_pager && (conf.output.width == 0 || conf.output.indent == 0) && ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 && ws.ws_col > 1) { @@ -366,7 +372,7 @@ main(int argc, char *argv[]) } #if HAVE_PLEDGE - if (use_pager == 0) { + if (outst.use_pager == 0) { if (pledge("stdio rpath", NULL) == -1) { mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); @@ -381,11 +387,10 @@ main(int argc, char *argv[]) argc -= optind; argv += optind; } - resp = NULL; /* - * Quirks for help(1) - * and for a man(1) section argument without -s. + * Quirks for help(1) and man(1), + * in particular for a section argument without -s. */ if (search.argmode == ARG_NAME) { @@ -409,6 +414,8 @@ main(int argc, char *argv[]) if (search.arch == NULL) search.arch = MACHINE; #endif + if (outmode == OUTMODE_ONE) + search.firstmatch = 1; } /* @@ -422,80 +429,65 @@ main(int argc, char *argv[]) conf.output.tag = tagarg == NULL ? *argv : tagarg + 1; } - /* man(1), whatis(1), apropos(1) */ + /* Read the configuration file. */ - if (search.argmode != ARG_FILE) { - if (search.argmode == ARG_NAME && - outmode == OUTMODE_ONE) - search.firstmatch = 1; - - /* Access the mandoc database. */ - + if (search.argmode != ARG_FILE) manconf_parse(&conf, conf_file, defpaths, auxpaths); - if ( ! mansearch(&search, &conf.manpath, - argc, argv, &res, &sz)) - usage(search.argmode); - if (sz == 0 && search.argmode == ARG_NAME) - (void)fs_search(&search, &conf.manpath, - argc, argv, &res, &sz); + /* man(1): Resolve each name individually. */ - if (search.argmode == ARG_NAME) { - for (c = 0; c < argc; c++) { - if (strchr(argv[c], '/') == NULL) - continue; - if (access(argv[c], R_OK) == -1) { - mandoc_msg_setinfilename(argv[c]); + if (search.argmode == ARG_NAME) { + if (argc < 1) + usage(ARG_NAME); + for (res = NULL, ressz = 0; argc > 0; argc--, argv++) { + (void)mansearch(&search, &conf.manpath, + 1, argv, &resn, &resnsz); + if (resnsz == 0) + (void)fs_search(&search, &conf.manpath, + *argv, &resn, &resnsz); + if (resnsz == 0 && strchr(*argv, '/') == NULL) { + if (search.arch != NULL && + arch_valid(search.arch, OSENUM) == 0) + warnx("Unknown architecture \"%s\".", + search.arch); + else if (search.sec != NULL) + warnx("No entry for %s in " + "section %s of the manual.", + *argv, search.sec); + else + warnx("No entry for %s in " + "the manual.", *argv); + mandoc_msg_setrc(MANDOCLEVEL_BADARG); + continue; + } + if (resnsz == 0) { + if (access(*argv, R_OK) == -1) { + mandoc_msg_setinfilename(*argv); mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "%s", strerror(errno)); mandoc_msg_setinfilename(NULL); continue; } + resnsz = 1; + resn = mandoc_calloc(resnsz, sizeof(*res)); + resn->file = mandoc_strdup(*argv); + resn->ipath = SIZE_MAX; + resn->form = FORM_SRC; + } + if (outmode != OUTMODE_ONE || resnsz == 1) { res = mandoc_reallocarray(res, - sz + 1, sizeof(*res)); - res[sz].file = mandoc_strdup(argv[c]); - res[sz].names = NULL; - res[sz].output = NULL; - res[sz].bits = 0; - res[sz].ipath = SIZE_MAX; - res[sz].sec = 10; - res[sz].form = FORM_SRC; - sz++; + ressz + resnsz, sizeof(*res)); + memcpy(res + ressz, resn, + sizeof(*resn) * resnsz); + ressz += resnsz; + continue; } - } - if (sz == 0) { - if (search.argmode != ARG_NAME) - warnx("nothing appropriate"); - mandoc_msg_setrc(MANDOCLEVEL_BADARG); - goto out; - } + /* Search for the best section. */ - /* - * 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 = 40; - } 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; + for (ib = i = 0; i < resnsz; i++) { + sec = resn[i].file; sec += strcspn(sec, "123456789"); if (sec[0] == '\0') continue; /* No section at all. */ @@ -516,38 +508,54 @@ main(int argc, char *argv[]) if (prio >= best_prio) continue; best_prio = prio; - resp = res + i; + ib = i; } + res = mandoc_reallocarray(res, ressz + 1, + sizeof(*res)); + memcpy(res + ressz++, resn + ib, sizeof(*resn)); } - /* - * 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. - */ + /* apropos(1), whatis(1): Process the full search expression. */ - if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) + } else if (search.argmode != ARG_FILE) { + if (mansearch(&search, &conf.manpath, + argc, argv, &res, &ressz) == 0) + usage(search.argmode); + + if (ressz == 0) { + warnx("nothing appropriate"); + mandoc_msg_setrc(MANDOCLEVEL_BADARG); goto out; - } + } - /* mandoc(1) */ + /* mandoc(1): Take command line arguments as file names. */ -#if HAVE_PLEDGE - if (use_pager) { - if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) { - mandoc_msg(MANDOCERR_PLEDGE, 0, 0, - "%s", strerror(errno)); - return mandoc_msg_getrc(); - } } else { - if (pledge("stdio rpath", NULL) == -1) { - mandoc_msg(MANDOCERR_PLEDGE, 0, 0, - "%s", strerror(errno)); - return mandoc_msg_getrc(); + ressz = argc > 0 ? argc : 1; + res = mandoc_calloc(ressz, sizeof(*res)); + for (i = 0; i < ressz; i++) { + if (argc > 0) + res[i].file = mandoc_strdup(argv[i]); + res[i].ipath = SIZE_MAX; + res[i].form = FORM_SRC; } } -#endif + switch (outmode) { + case OUTMODE_FLN: + for (i = 0; i < ressz; i++) + puts(res[i].file); + goto out; + case OUTMODE_LST: + for (i = 0; i < ressz; i++) + printf("%s - %s\n", res[i].names, + res[i].output == NULL ? "" : + res[i].output); + goto out; + default: + break; + } + if (search.argmode == ARG_FILE && auxpaths != NULL) { if (strcmp(auxpaths, "doc") == 0) options |= MPARSE_MDOC; @@ -558,18 +566,6 @@ main(int argc, char *argv[]) mchars_alloc(); mp = mparse_alloc(options, os_e, os_s); - if (argc < 1) { - if (use_pager) { - tag_files = tag_init(); - if (tag_files != NULL) - tag_files->tagname = conf.output.tag; - } - thisarg = ""; - mandoc_msg_setinfilename(thisarg); - parse(mp, STDIN_FILENO, thisarg, &outst, &conf.output); - mandoc_msg_setinfilename(NULL); - } - /* * Remember the original working directory, if possible. * This will be needed if some names on the command line @@ -579,70 +575,10 @@ main(int argc, char *argv[]) */ startdir = open(".", O_RDONLY | O_DIRECTORY); - while (argc > 0) { - - /* - * Changing directories is not needed in ARG_FILE mode. - * Do it on a best-effort basis. Even in case of - * failure, some functionality may still work. - */ - if (resp != NULL) { - if (resp->ipath != SIZE_MAX) - (void)chdir(conf.manpath.paths[resp->ipath]); - else if (startdir != -1) - (void)fchdir(startdir); - thisarg = resp->file; - } else - thisarg = *argv; - - mandoc_msg_setinfilename(thisarg); - fd = mparse_open(mp, thisarg); - if (fd != -1) { - if (use_pager) { - use_pager = 0; - tag_files = tag_init(); - if (tag_files != NULL) - tag_files->tagname = conf.output.tag; - } - - if (resp == NULL || resp->form == FORM_SRC) - parse(mp, fd, thisarg, &outst, &conf.output); - else - passthrough(fd, conf.output.synopsisonly); - - if (ferror(stdout)) { - if (tag_files != NULL) { - mandoc_msg(MANDOCERR_WRITE, 0, 0, - "%s: %s", tag_files->ofn, - strerror(errno)); - tag_unlink(); - tag_files = NULL; - } else - mandoc_msg(MANDOCERR_WRITE, 0, 0, - "%s", strerror(errno)); - break; - } - - if (argc > 1 && outst.outtype <= OUTT_UTF8) { - if (outst.outdata == NULL) - outdata_alloc(&outst, &conf.output); - terminal_sepline(outst.outdata); - } - } else - mandoc_msg(resp == NULL ? MANDOCERR_BADARG_BAD : - MANDOCERR_OPEN, 0, 0, "%s", strerror(errno)); - - mandoc_msg_setinfilename(NULL); - + for (i = 0; i < ressz; i++) { + process_onefile(mp, res + i, startdir, &outst, &conf); if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) break; - - if (resp != NULL) - resp++; - else - argv++; - if (--argc) - mparse_reset(mp); } if (startdir != -1) { (void)fchdir(startdir); @@ -672,18 +608,16 @@ main(int argc, char *argv[]) mchars_free(); out: - if (search.argmode != ARG_FILE) { + mansearch_free(res, ressz); + if (search.argmode != ARG_FILE) manconf_free(&conf); - mansearch_free(res, sz); - } - if (tag_files != NULL) { + if (outst.tag_files != NULL) { fclose(stdout); tag_write(); - run_pager(tag_files); + run_pager(outst.tag_files); tag_unlink(); - } else if (outst.outtype != OUTT_LINT && - (search.argmode == ARG_FILE || sz > 0)) + } else if (outst.had_output && outst.outtype != OUTT_LINT) mandoc_msg_summary(); return (int)mandoc_msg_getrc(); @@ -796,63 +730,109 @@ found: static int fs_search(const struct mansearch *cfg, const struct manpaths *paths, - int argc, char **argv, struct manpage **res, size_t *ressz) + const char *name, 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; + size_t ipath, isec; assert(cfg->argmode == ARG_NAME); - if (res != NULL) *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) != -1 && - cfg->firstmatch) - return 0; - } else for (isec = 0; isec < nsec; isec++) + *ressz = 0; + for (ipath = 0; ipath < paths->sz; ipath++) { + if (cfg->sec != NULL) { + if (fs_lookup(paths, ipath, cfg->sec, cfg->arch, + name, res, ressz) != -1 && cfg->firstmatch) + return 0; + } else { + for (isec = 0; isec < nsec; isec++) if (fs_lookup(paths, ipath, sections[isec], - cfg->arch, *argv, res, ressz) != -1 && + cfg->arch, name, res, ressz) != -1 && cfg->firstmatch) return 0; } - if (res != NULL && *ressz == lastsz && - strchr(*argv, '/') == NULL) { - if (cfg->arch != NULL && - arch_valid(cfg->arch, OSENUM) == 0) - warnx("Unknown architecture \"%s\".", - cfg->arch); - else if (cfg->sec == NULL) - warnx("No entry for %s in the manual.", - *argv); - else - warnx("No entry for %s in section %s " - "of the manual.", *argv, cfg->sec); - } - lastsz = *ressz; - argv++; - argc--; } return -1; } static void +process_onefile(struct mparse *mp, struct manpage *resp, int startdir, + struct outstate *outst, struct manconf *conf) +{ + int fd; + + /* + * Changing directories is not needed in ARG_FILE mode. + * Do it on a best-effort basis. Even in case of + * failure, some functionality may still work. + */ + if (resp->ipath != SIZE_MAX) + (void)chdir(conf->manpath.paths[resp->ipath]); + else if (startdir != -1) + (void)fchdir(startdir); + + mandoc_msg_setinfilename(resp->file); + if (resp->file != NULL) { + if ((fd = mparse_open(mp, resp->file)) == -1) { + mandoc_msg(resp->ipath == SIZE_MAX ? + MANDOCERR_BADARG_BAD : MANDOCERR_OPEN, + 0, 0, "%s", strerror(errno)); + mandoc_msg_setinfilename(NULL); + return; + } + } else + fd = STDIN_FILENO; + + if (outst->use_pager) { + outst->use_pager = 0; + outst->tag_files = tag_init(conf->output.tag); + } + + if (outst->had_output && outst->outtype <= OUTT_UTF8) { + if (outst->outdata == NULL) + outdata_alloc(outst, &conf->output); + terminal_sepline(outst->outdata); + } + + if (resp->form == FORM_SRC) + parse(mp, fd, resp->file, outst, &conf->output); + else { + passthrough(fd, conf->output.synopsisonly); + outst->had_output = 1; + } + + if (ferror(stdout)) { + if (outst->tag_files != NULL) { + mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s", + outst->tag_files->ofn, strerror(errno)); + tag_unlink(); + outst->tag_files = NULL; + } else + mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s", + strerror(errno)); + } + mandoc_msg_setinfilename(NULL); +} + +static void parse(struct mparse *mp, int fd, const char *file, struct outstate *outst, struct manoutput *outconf) { - struct roff_meta *meta; + static int previous; + struct roff_meta *meta; - /* Begin by parsing the file itself. */ - - assert(file); assert(fd >= 0); + if (file == NULL) + file = ""; + if (previous) + mparse_reset(mp); + else + previous = 1; + mparse_readfd(mp, fd, file); if (fd != STDIN_FILENO) close(fd); @@ -875,6 +855,7 @@ parse(struct mparse *mp, int fd, const char *file, /* Execute the out device, if it exists. */ + outst->had_output = 1; if (meta->macroset == MACROSET_MDOC) { switch (outst->outtype) { case OUTT_HTML: @@ -947,7 +928,7 @@ check_xr(void) search.firstmatch = 1; if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz)) continue; - if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz) != -1) + if (fs_search(&search, &paths, xr->name, NULL, &sz) != -1) continue; if (xr->count == 1) mandoc_msg(MANDOCERR_XR_BAD, xr->line,