-/* $Id: main.c,v 1.153 2011/03/17 12:08:01 kristaps Exp $ */
+/* $Id: main.c,v 1.352 2020/07/21 15:10:01 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
*
* 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.
+ *
+ * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
*/
-#ifdef HAVE_CONFIG_H
#include "config.h"
-#endif
-#include <sys/mman.h>
+#include <sys/types.h>
+#include <sys/ioctl.h>
+#include <sys/param.h> /* MACHINE */
#include <sys/stat.h>
+#include <sys/wait.h>
#include <assert.h>
#include <ctype.h>
+#if HAVE_ERR
+#include <err.h>
+#endif
+#include <errno.h>
#include <fcntl.h>
+#include <glob.h>
+#include <limits.h>
+#if HAVE_SANDBOX_INIT
+#include <sandbox.h>
+#endif
+#include <signal.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
+#include <termios.h>
+#include <time.h>
#include <unistd.h>
+#include "mandoc_aux.h"
#include "mandoc.h"
-#include "main.h"
+#include "mandoc_xr.h"
+#include "roff.h"
#include "mdoc.h"
#include "man.h"
-#include "roff.h"
-
-#ifndef MAP_FILE
-#define MAP_FILE 0
-#endif
-
-#define REPARSE_LIMIT 1000
-
-/* 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 intt {
- INTT_AUTO,
- INTT_MDOC,
- INTT_MAN
+#include "mandoc_parse.h"
+#include "tag.h"
+#include "term_tag.h"
+#include "main.h"
+#include "manconf.h"
+#include "mansearch.h"
+
+enum outmode {
+ OUTMODE_DEF = 0,
+ OUTMODE_FLN,
+ OUTMODE_LST,
+ OUTMODE_ALL,
+ OUTMODE_ONE
};
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 {
- enum mandoclevel exit_status; /* status of all file parses */
- const char *file; /* current file-name */
- enum mandoclevel file_status; /* error status of current parse */
- int fd; /* current file-descriptor */
- int line; /* line number in the file */
- 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 *pman; /* persistent man parser */
- struct mdoc *pmdoc; /* persistent mdoc parser */
- struct man *man; /* man parser */
- struct mdoc *mdoc; /* mdoc parser */
- struct roff *roff; /* roff parser (!NULL) */
- struct regset regs; /* roff registers */
- int reparse_count; /* finite interpolation stack */
- 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 outstate {
+ struct tag_files *tag_files; /* Tagging state variables. */
void *outdata; /* data for output */
- char outopts[BUFSIZ]; /* buf of output opts */
-};
-
-static const char * const mandoclevels[MANDOCLEVEL_MAX] = {
- "SUCCESS",
- "RESERVED",
- "WARNING",
- "ERROR",
- "FATAL",
- "BADARG",
- "SYSERR"
+ 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 */
};
-static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = {
- MANDOCERR_OK,
- MANDOCERR_WARNING,
- MANDOCERR_WARNING,
- MANDOCERR_ERROR,
- MANDOCERR_FATAL,
- MANDOCERR_MAX,
- MANDOCERR_MAX
-};
-static const char * const mandocerrs[MANDOCERR_MAX] = {
- "ok",
-
- "generic warning",
-
- /* related to the prologue */
- "no title in document",
- "document title should be all caps",
- "unknown manual section",
- "date missing, using today's date",
- "cannot parse date, using it verbatim",
- "prologue macros out of order",
- "duplicate prologue macro",
- "macro not allowed in prologue",
- "macro not allowed in body",
-
- /* related to document structure */
- ".so is fragile, better use ln(1)",
- "NAME section must come first",
- "bad NAME section contents",
- "manual name not yet set",
- "sections out of conventional order",
- "duplicate section name",
- "section not in conventional manual section",
-
- /* related to macros and nesting */
- "skipping obsolete macro",
- "skipping paragraph macro",
- "skipping no-space macro",
- "blocks badly nested",
- "child violates parent syntax",
- "nested displays are not portable",
- "already in literal mode",
-
- /* related to missing macro arguments */
- "skipping empty macro",
- "argument count wrong",
- "missing display type",
- "list type must come first",
- "tag lists require a width argument",
- "missing font type",
- "skipping end of block that is not open",
-
- /* related to bad macro arguments */
- "skipping argument",
- "duplicate argument",
- "duplicate display type",
- "duplicate list type",
- "unknown AT&T UNIX version",
- "bad Boolean value",
- "unknown font",
- "unknown standard specifier",
- "bad width argument",
-
- /* related to plain text */
- "blank line in non-literal context",
- "tab in non-literal context",
- "end of line whitespace",
- "bad comment style",
- "unknown escape sequence",
- "unterminated quoted string",
-
- "generic error",
-
- /* related to tables */
- "bad table syntax",
- "bad table option",
- "bad table layout",
- "no table layout cells specified",
- "no table data cells specified",
- "ignore data in cell",
- "data block still open",
- "ignoring extra data cells",
-
- "input stack limit exceeded, infinite loop?",
- "skipping bad character",
- "escaped character not allowed in a name",
- "skipping text before the first section header",
- "skipping unknown macro",
- "NOT IMPLEMENTED, please use groff: skipping request",
- "line scope broken",
- "argument count wrong",
- "skipping end of block that is not open",
- "missing end of block",
- "scope open on exit",
- "uname(3) system call failed",
- "macro requires line argument(s)",
- "macro requires body argument(s)",
- "macro requires argument(s)",
- "missing list type",
- "line argument(s) will be lost",
- "body argument(s) will be lost",
-
- "generic fatal error",
-
- "column syntax is inconsistent",
- "NOT IMPLEMENTED: .Bd -file",
- "line scope broken, syntax violated",
- "argument count wrong, violates syntax",
- "child violates parent syntax",
- "argument count wrong, violates syntax",
- "NOT IMPLEMENTED: .so with absolute path or \"..\"",
- "no document body",
- "no document prologue",
- "static buffer exhausted",
-};
+int mandocdb(int, char *[]);
+
+static void check_xr(void);
+static int fs_lookup(const struct manpaths *,
+ size_t ipath, const char *,
+ const char *, const char *,
+ struct manpage **, size_t *);
+static int fs_search(const struct mansearch *,
+ const struct manpaths *, const char *,
+ struct manpage **, size_t *);
+static void glob_esc(char **, const char *, const char *);
+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 outstate *, char *);
+static pid_t spawn_pager(struct outstate *, char *);
+static void usage(enum argmode) __attribute__((__noreturn__));
+static int woptions(char *, enum mandoc_os *, int *);
+
+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 void parsebuf(struct curparse *, struct buf, int);
-static void pdesc(struct curparse *);
-static void fdesc(struct curparse *);
-static void ffile(const char *, struct curparse *);
-static int pfile(const char *, struct curparse *);
-static int moptions(enum intt *, char *);
-static void mmsg(enum mandocerr, void *,
- int, int, const char *);
-static void pset(const char *, int, struct curparse *);
-static int toptions(struct curparse *, char *);
-static void usage(void) __attribute__((noreturn));
-static void version(void) __attribute__((noreturn));
-static int woptions(struct curparse *, char *);
-
-static const char *progname;
int
main(int argc, char *argv[])
{
+ struct manconf conf; /* Manpaths and output options. */
+ struct outstate outst; /* Output state. */
+ struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */
+ struct mansearch search; /* Search options. */
+ struct manpage *res; /* Complete list of search results. */
+ struct manpage *resn; /* Search results for one name. */
+ struct mparse *mp; /* Opaque parser object. */
+ const char *conf_file; /* -C: alternate config file. */
+ const char *os_s; /* -I: Operating system for display. */
+ 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 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 prio, best_prio;
+ int startdir;
int c;
- struct curparse curp;
-
- progname = strrchr(argv[0], '/');
- if (progname == NULL)
+ enum mandoc_os os_e; /* Check base system conventions. */
+ enum outmode outmode; /* According to command line. */
+
+#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
- memset(&curp, 0, sizeof(struct curparse));
-
- curp.inttype = INTT_AUTO;
- curp.outtype = OUTT_ASCII;
- curp.wlevel = MANDOCLEVEL_FATAL;
- curp.exit_status = MANDOCLEVEL_OK;
-
- /* LINTED */
- while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))
- switch (c) {
- case ('m'):
- if ( ! moptions(&curp.inttype, optarg))
- return((int)MANDOCLEVEL_BADARG);
- break;
- case ('O'):
- (void)strlcat(curp.outopts, optarg, BUFSIZ);
- (void)strlcat(curp.outopts, ",", BUFSIZ);
- break;
- case ('T'):
- if ( ! toptions(&curp, optarg))
- return((int)MANDOCLEVEL_BADARG);
- break;
- case ('W'):
- if ( ! woptions(&curp, optarg))
- return((int)MANDOCLEVEL_BADARG);
- break;
- case ('V'):
- version();
- /* NOTREACHED */
- default:
- usage();
- /* NOTREACHED */
- }
-
- argc -= optind;
- argv += optind;
-
- if (NULL == *argv) {
- curp.file = "<stdin>";
- curp.fd = STDIN_FILENO;
-
- fdesc(&curp);
- }
+ mandoc_msg_setoutfile(stderr);
+ if (strncmp(progname, "mandocdb", 8) == 0 ||
+ strcmp(progname, BINM_MAKEWHATIS) == 0)
+ return mandocdb(argc, argv);
- while (*argv) {
- ffile(*argv, &curp);
- if (MANDOCLEVEL_OK != curp.exit_status && curp.wstop)
- break;
- ++argv;
+#if HAVE_PLEDGE
+ if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {
+ mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
+ return mandoc_msg_getrc();
}
+#endif
+#if HAVE_SANDBOX_INIT
+ if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
+ errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
+#endif
- if (curp.outfree)
- (*curp.outfree)(curp.outdata);
- if (curp.pmdoc)
- mdoc_free(curp.pmdoc);
- if (curp.pman)
- man_free(curp.pman);
- if (curp.roff)
- roff_free(curp.roff);
-
- return((int)curp.exit_status);
-}
-
-
-static void
-version(void)
-{
+ /* Search options. */
- (void)printf("%s %s\n", progname, VERSION);
- exit((int)MANDOCLEVEL_OK);
-}
+ memset(&conf, 0, sizeof(conf));
+ conf_file = NULL;
+ defpaths = auxpaths = NULL;
+ memset(&search, 0, sizeof(struct mansearch));
+ search.outkey = "Nd";
+ oarg = NULL;
-static void
-usage(void)
-{
+ 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;
- (void)fprintf(stderr, "usage: %s "
- "[-V] "
- "[-foption] "
- "[-mformat] "
- "[-Ooption] "
- "[-Toutput] "
- "[-Werr] "
- "[file...]\n",
- progname);
+ /* Parser options. */
- exit((int)MANDOCLEVEL_BADARG);
-}
+ options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
+ os_e = MANDOC_OS_OTHER;
+ os_s = NULL;
-static void
-ffile(const char *file, struct curparse *curp)
-{
+ /* Formatter options. */
- /*
- * Called once per input file. Get the file ready for reading,
- * pass it through to the parser-driver, then close it out.
- * XXX: don't do anything special as this is only called for
- * files; stdin goes directly to fdesc().
- */
+ memset(&outst, 0, sizeof(outst));
+ outst.tag_files = NULL;
+ outst.outtype = OUTT_LOCALE;
+ outst.use_pager = 1;
- curp->file = file;
+ show_usage = 0;
+ outmode = OUTMODE_DEF;
- if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
- perror(curp->file);
- curp->exit_status = MANDOCLEVEL_SYSERR;
- return;
+ 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 'a':
+ outmode = OUTMODE_ALL;
+ break;
+ case 'C':
+ conf_file = optarg;
+ break;
+ case 'c':
+ outst.use_pager = 0;
+ break;
+ case 'f':
+ search.argmode = ARG_WORD;
+ break;
+ case 'h':
+ conf.output.synopsisonly = 1;
+ outst.use_pager = 0;
+ outmode = OUTMODE_ALL;
+ break;
+ case 'I':
+ if (strncmp(optarg, "os=", 3) != 0) {
+ mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
+ "-I %s", optarg);
+ return mandoc_msg_getrc();
+ }
+ if (os_s != NULL) {
+ mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,
+ "-I %s", optarg);
+ return mandoc_msg_getrc();
+ }
+ os_s = optarg + 3;
+ break;
+ case 'K':
+ options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
+ if (strcmp(optarg, "utf-8") == 0)
+ options |= MPARSE_UTF8;
+ else if (strcmp(optarg, "iso-8859-1") == 0)
+ options |= MPARSE_LATIN1;
+ else if (strcmp(optarg, "us-ascii") != 0) {
+ mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
+ "-K %s", optarg);
+ return mandoc_msg_getrc();
+ }
+ 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 (strcmp(optarg, "ascii") == 0)
+ outst.outtype = OUTT_ASCII;
+ else if (strcmp(optarg, "lint") == 0) {
+ outst.outtype = OUTT_LINT;
+ mandoc_msg_setoutfile(stdout);
+ mandoc_msg_setmin(MANDOCERR_BASE);
+ } else if (strcmp(optarg, "tree") == 0)
+ outst.outtype = OUTT_TREE;
+ else if (strcmp(optarg, "man") == 0)
+ outst.outtype = OUTT_MAN;
+ else if (strcmp(optarg, "html") == 0)
+ outst.outtype = OUTT_HTML;
+ else if (strcmp(optarg, "markdown") == 0)
+ outst.outtype = OUTT_MARKDOWN;
+ else if (strcmp(optarg, "utf8") == 0)
+ outst.outtype = OUTT_UTF8;
+ else if (strcmp(optarg, "locale") == 0)
+ outst.outtype = OUTT_LOCALE;
+ else if (strcmp(optarg, "ps") == 0)
+ outst.outtype = OUTT_PS;
+ else if (strcmp(optarg, "pdf") == 0)
+ outst.outtype = OUTT_PDF;
+ else {
+ mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
+ "-T %s", optarg);
+ return mandoc_msg_getrc();
+ }
+ break;
+ case 'W':
+ if (woptions(optarg, &os_e, &outst.wstop) == -1)
+ return mandoc_msg_getrc();
+ break;
+ case 'w':
+ outmode = OUTMODE_FLN;
+ break;
+ default:
+ show_usage = 1;
+ break;
+ }
}
- fdesc(curp);
+ if (show_usage)
+ usage(search.argmode);
- if (-1 == close(curp->fd))
- perror(curp->file);
-}
+ /* Postprocess options. */
-static int
-pfile(const char *file, struct curparse *curp)
-{
- const char *savefile;
- int fd, savefd;
-
- if (-1 == (fd = open(file, O_RDONLY, 0))) {
- perror(file);
- curp->file_status = MANDOCLEVEL_SYSERR;
- return(0);
+ switch (outmode) {
+ case OUTMODE_DEF:
+ switch (search.argmode) {
+ case ARG_FILE:
+ outmode = OUTMODE_ALL;
+ outst.use_pager = 0;
+ break;
+ case ARG_NAME:
+ outmode = OUTMODE_ONE;
+ break;
+ default:
+ outmode = OUTMODE_LST;
+ break;
+ }
+ break;
+ case OUTMODE_FLN:
+ if (search.argmode == ARG_FILE)
+ outmode = OUTMODE_ALL;
+ break;
+ case OUTMODE_ALL:
+ break;
+ case OUTMODE_LST:
+ case OUTMODE_ONE:
+ abort();
}
- savefile = curp->file;
- savefd = curp->fd;
-
- curp->file = file;
- curp->fd = fd;
-
- pdesc(curp);
-
- curp->file = savefile;
- curp->fd = savefd;
-
- if (-1 == close(fd))
- perror(file);
-
- return(MANDOCLEVEL_FATAL > curp->file_status ? 1 : 0);
-}
-
-
-static void
-resize_buf(struct buf *buf, size_t initial)
-{
+ if (oarg != NULL) {
+ if (outmode == OUTMODE_LST)
+ search.outkey = oarg;
+ else {
+ while (oarg != NULL) {
+ if (manconf_output(&conf.output,
+ strsep(&oarg, ","), 0) == -1)
+ return mandoc_msg_getrc();
+ }
+ }
+ }
- buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;
- buf->buf = mandoc_realloc(buf->buf, buf->sz);
-}
+ if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
+ options |= MPARSE_VALIDATE;
+
+ if (outmode == OUTMODE_FLN ||
+ outmode == OUTMODE_LST ||
+ (conf.output.outfilename == NULL &&
+ conf.output.tagfilename == NULL &&
+ isatty(STDOUT_FILENO) == 0))
+ outst.use_pager = 0;
+
+ if (outst.use_pager &&
+ (conf.output.width == 0 || conf.output.indent == 0) &&
+ ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
+ ws.ws_col > 1) {
+ if (conf.output.width == 0 && ws.ws_col < 79)
+ conf.output.width = ws.ws_col - 1;
+ if (conf.output.indent == 0 && ws.ws_col < 66)
+ conf.output.indent = 3;
+ }
+#if HAVE_PLEDGE
+ if (outst.use_pager == 0)
+ c = pledge("stdio rpath", NULL);
+ else if (conf.output.outfilename != NULL ||
+ conf.output.tagfilename != NULL)
+ c = pledge("stdio rpath wpath cpath", NULL);
+ else
+ c = pledge("stdio rpath tmppath tty proc exec", NULL);
+ if (c == -1) {
+ mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
+ return mandoc_msg_getrc();
+ }
+#endif
-static int
-read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
-{
- struct stat st;
- size_t off;
- ssize_t ssz;
+ /* Parse arguments. */
- if (-1 == fstat(curp->fd, &st)) {
- perror(curp->file);
- return(0);
+ if (argc > 0) {
+ argc -= optind;
+ argv += optind;
}
/*
- * 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.
+ * Quirks for help(1) and man(1),
+ * in particular for a section argument without -s.
*/
- if (S_ISREG(st.st_mode)) {
- if (st.st_size >= (1U << 31)) {
- fprintf(stderr, "%s: input too large\n",
- curp->file);
- return(0);
+ 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[0] == 'n' && uc[1] == '\0'))) {
+ search.sec = (char *)uc;
+ argv++;
+ argc--;
}
- *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 (search.arch == NULL)
+ search.arch = getenv("MACHINE");
+#ifdef MACHINE
+ if (search.arch == NULL)
+ search.arch = MACHINE;
+#endif
+ if (outmode == OUTMODE_ONE)
+ search.firstmatch = 1;
}
/*
- * 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.
+ * Use the first argument for -O tag in addition to
+ * using it as a search term for man(1) or apropos(1).
*/
- *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 (conf.output.tag != NULL && *conf.output.tag == '\0') {
+ tagarg = argc > 0 && search.argmode == ARG_EXPR ?
+ strchr(*argv, '=') : NULL;
+ conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
}
- free(fb->buf);
- fb->buf = NULL;
- return(0);
-}
-
-
-static void
-fdesc(struct curparse *curp)
-{
-
- /*
- * Called once per file with an opened file descriptor. All
- * pre-file-parse operations (whether stdin or a file) should go
- * here.
- *
- * This calls down into the nested parser, which drills down and
- * fully parses a file and all its dependences (i.e., `so'). It
- * then runs the cleanup validators and pushes to output.
- */
+ /* Read the configuration file. */
- /* Zero the parse type. */
+ if (search.argmode != ARG_FILE)
+ manconf_parse(&conf, conf_file, defpaths, auxpaths);
- curp->mdoc = NULL;
- curp->man = NULL;
- curp->file_status = MANDOCLEVEL_OK;
+ /* man(1): Resolve each name individually. */
- /* Make sure the mandotory roff parser is initialised. */
+ if (search.argmode == ARG_NAME) {
+ if (argc < 1) {
+ if (outmode != OUTMODE_FLN)
+ usage(ARG_NAME);
+ if (conf.manpath.sz == 0) {
+ warnx("The manpath is empty.");
+ mandoc_msg_setrc(MANDOCLEVEL_BADARG);
+ } else {
+ for (i = 0; i + 1 < conf.manpath.sz; i++)
+ printf("%s:", conf.manpath.paths[i]);
+ printf("%s\n", conf.manpath.paths[i]);
+ }
+ manconf_free(&conf);
+ return (int)mandoc_msg_getrc();
+ }
+ 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,
+ ressz + resnsz, sizeof(*res));
+ memcpy(res + ressz, resn,
+ sizeof(*resn) * resnsz);
+ ressz += resnsz;
+ continue;
+ }
- if (NULL == curp->roff) {
- curp->roff = roff_alloc(&curp->regs, curp, mmsg);
- assert(curp->roff);
- }
+ /* Search for the best section. */
+
+ best_prio = 40;
+ for (ib = i = 0; i < resnsz; i++) {
+ sec = resn[i].file;
+ sec += strcspn(sec, "123456789");
+ if (sec[0] == '\0')
+ continue; /* No section at all. */
+ prio = sec_prios[sec[0] - '1'];
+ if (search.sec != NULL) {
+ ssz = strlen(search.sec);
+ if (strncmp(sec, search.sec, ssz) == 0)
+ sec += ssz;
+ } else
+ sec++; /* Prefer without suffix. */
+ if (*sec != '/')
+ prio += 10; /* Wrong dir name. */
+ if (search.sec != NULL &&
+ (strlen(sec) <= ssz + 3 ||
+ strcmp(sec + strlen(sec) - ssz,
+ search.sec) != 0))
+ prio += 20; /* Wrong file ext. */
+ if (prio >= best_prio)
+ continue;
+ best_prio = prio;
+ ib = i;
+ }
+ res = mandoc_reallocarray(res, ressz + 1,
+ sizeof(*res));
+ memcpy(res + ressz++, resn + ib, sizeof(*resn));
+ }
- /* Fully parse the file. */
+ /* apropos(1), whatis(1): Process the full search expression. */
- pdesc(curp);
+ } else if (search.argmode != ARG_FILE) {
+ if (mansearch(&search, &conf.manpath,
+ argc, argv, &res, &ressz) == 0)
+ usage(search.argmode);
- if (MANDOCLEVEL_FATAL <= curp->file_status)
- goto cleanup;
+ if (ressz == 0) {
+ warnx("nothing appropriate");
+ mandoc_msg_setrc(MANDOCLEVEL_BADARG);
+ goto out;
+ }
- /* NOTE a parser may not have been assigned, yet. */
+ /* mandoc(1): Take command line arguments as file names. */
- if ( ! (curp->man || curp->mdoc)) {
- fprintf(stderr, "%s: Not a manual\n", curp->file);
- curp->file_status = MANDOCLEVEL_FATAL;
- goto cleanup;
+ } else {
+ 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;
+ }
}
- /* Clean up the parse routine ASTs. */
-
- if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {
- assert(MANDOCLEVEL_FATAL <= curp->file_status);
- goto cleanup;
+ 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 (curp->man && ! man_endparse(curp->man)) {
- assert(MANDOCLEVEL_FATAL <= curp->file_status);
- goto cleanup;
+ if (search.argmode == ARG_FILE && auxpaths != NULL) {
+ if (strcmp(auxpaths, "doc") == 0)
+ options |= MPARSE_MDOC;
+ else if (strcmp(auxpaths, "an") == 0)
+ options |= MPARSE_MAN;
}
- assert(curp->roff);
- roff_endparse(curp->roff);
+ mchars_alloc();
+ mp = mparse_alloc(options, os_e, os_s);
/*
- * With -Wstop and warnings or errors of at least
- * the requested level, do not produce output.
+ * Remember the original working directory, if possible.
+ * This will be needed if some names on the command line
+ * are page names and some are relative file names.
+ * Do not error out if the current directory is not
+ * readable: Maybe it won't be needed after all.
*/
-
- if (MANDOCLEVEL_OK != curp->file_status && curp->wstop)
- goto cleanup;
-
- /* If unset, allocate output dev now (if applicable). */
-
- if ( ! (curp->outman && curp->outmdoc)) {
- switch (curp->outtype) {
- case (OUTT_XHTML):
- curp->outdata = xhtml_alloc(curp->outopts);
+ startdir = open(".", O_RDONLY | O_DIRECTORY);
+ for (i = 0; i < ressz; i++) {
+ process_onefile(mp, res + i, startdir, &outst, &conf);
+ if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
break;
- case (OUTT_HTML):
- curp->outdata = html_alloc(curp->outopts);
- break;
- case (OUTT_ASCII):
- curp->outdata = ascii_alloc(curp->outopts);
- curp->outfree = ascii_free;
- break;
- case (OUTT_PDF):
- curp->outdata = pdf_alloc(curp->outopts);
- curp->outfree = pspdf_free;
- break;
- case (OUTT_PS):
- curp->outdata = ps_alloc(curp->outopts);
- curp->outfree = pspdf_free;
- break;
- default:
- break;
- }
-
- switch (curp->outtype) {
- case (OUTT_HTML):
- /* FALLTHROUGH */
- case (OUTT_XHTML):
- curp->outman = html_man;
- curp->outmdoc = html_mdoc;
- curp->outfree = html_free;
+ }
+ if (startdir != -1) {
+ (void)fchdir(startdir);
+ close(startdir);
+ }
+ if (conf.output.tag != NULL && conf.output.tag_found == 0) {
+ mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
+ conf.output.tag = NULL;
+ }
+ if (outst.outdata != NULL) {
+ switch (outst.outtype) {
+ case OUTT_HTML:
+ html_free(outst.outdata);
break;
- case (OUTT_TREE):
- curp->outman = tree_man;
- curp->outmdoc = tree_mdoc;
+ case OUTT_UTF8:
+ case OUTT_LOCALE:
+ case OUTT_ASCII:
+ ascii_free(outst.outdata);
break;
- case (OUTT_PDF):
- /* FALLTHROUGH */
- case (OUTT_ASCII):
- /* FALLTHROUGH */
- case (OUTT_PS):
- curp->outman = terminal_man;
- curp->outmdoc = terminal_mdoc;
+ case OUTT_PDF:
+ case OUTT_PS:
+ pspdf_free(outst.outdata);
break;
default:
break;
}
}
+ mandoc_xr_free();
+ mparse_free(mp);
+ mchars_free();
+
+out:
+ mansearch_free(res, ressz);
+ if (search.argmode != ARG_FILE)
+ manconf_free(&conf);
+
+ if (outst.tag_files != NULL) {
+ if (term_tag_close() != -1 &&
+ conf.output.outfilename == NULL &&
+ conf.output.tagfilename == NULL)
+ run_pager(&outst, conf.output.tag);
+ term_tag_unlink();
+ } else if (outst.had_output && outst.outtype != OUTT_LINT)
+ mandoc_msg_summary();
+
+ return (int)mandoc_msg_getrc();
+}
- /* Execute the out device, if it exists. */
-
- if (curp->man && curp->outman)
- (*curp->outman)(curp->outdata, curp->man);
- if (curp->mdoc && curp->outmdoc)
- (*curp->outmdoc)(curp->outdata, curp->mdoc);
-
- cleanup:
-
- memset(&curp->regs, 0, sizeof(struct regset));
-
- /* Reset the current-parse compilers. */
+static void
+usage(enum argmode argmode)
+{
+ 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 (curp->mdoc)
- mdoc_reset(curp->mdoc);
- if (curp->man)
- man_reset(curp->man);
+static void
+glob_esc(char **dst, const char *src, const char *suffix)
+{
+ while (*src != '\0') {
+ if (strchr("*?[", *src) != NULL)
+ *(*dst)++ = '\\';
+ *(*dst)++ = *src++;
+ }
+ while (*suffix != '\0')
+ *(*dst)++ = *suffix++;
+}
- assert(curp->roff);
- roff_reset(curp->roff);
+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 stat sb;
+ glob_t globinfo;
+ struct manpage *page;
+ char *file, *cp;
+ int globres;
+ enum form form;
+
+ const char *const slman = "/man";
+ const char *const slash = "/";
+ const char *const sglob = ".[01-9]*";
+
+ form = FORM_SRC;
+ mandoc_asprintf(&file, "%s/man%s/%s.%s",
+ paths->paths[ipath], sec, name, sec);
+ if (stat(file, &sb) != -1)
+ goto found;
+ free(file);
+
+ mandoc_asprintf(&file, "%s/cat%s/%s.0",
+ paths->paths[ipath], sec, name);
+ if (stat(file, &sb) != -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 (stat(file, &sb) != -1)
+ goto found;
+ free(file);
+ }
- if (curp->exit_status < curp->file_status)
- curp->exit_status = curp->file_status;
+ cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
+ strlen(slman) + strlen(sec) * 2 + strlen(slash) +
+ strlen(name) * 2 + strlen(sglob) + 1);
+ glob_esc(&cp, paths->paths[ipath], slman);
+ glob_esc(&cp, sec, slash);
+ glob_esc(&cp, name, sglob);
+ *cp = '\0';
+ globres = glob(file, 0, NULL, &globinfo);
+ if (globres != 0 && globres != GLOB_NOMATCH)
+ mandoc_msg(MANDOCERR_GLOB, 0, 0,
+ "%s: %s", file, strerror(errno));
+ free(file);
+ if (globres == 0)
+ file = mandoc_strdup(*globinfo.gl_pathv);
+ globfree(&globinfo);
+ if (globres == 0) {
+ if (stat(file, &sb) != -1)
+ goto found;
+ free(file);
+ }
+ if (res != NULL || ipath + 1 != paths->sz)
+ return -1;
+
+ mandoc_asprintf(&file, "%s.%s", name, sec);
+ globres = stat(file, &sb);
+ free(file);
+ return globres;
+
+found:
+ warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
+ name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
+ if (res == NULL) {
+ free(file);
+ return 0;
+ }
+ *res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));
+ page = *res + (*ressz - 1);
+ page->file = file;
+ page->names = NULL;
+ page->output = NULL;
+ page->bits = NAME_FILE & NAME_MASK;
+ page->ipath = ipath;
+ page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
+ page->form = form;
+ return 0;
+}
- return;
+static int
+fs_search(const struct mansearch *cfg, const struct manpaths *paths,
+ 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;
+
+ assert(cfg->argmode == ARG_NAME);
+ if (res != NULL)
+ *res = NULL;
+ *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, name, res, ressz) != -1 &&
+ cfg->firstmatch)
+ return 0;
+ }
+ }
+ return -1;
}
static void
-pdesc(struct curparse *curp)
+process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
+ struct outstate *outst, struct manconf *conf)
{
- struct buf blk;
- int with_mmap;
+ int fd;
/*
- * Run for each opened file; may be called more than once for
- * each full parse sequence if the opened file is nested (i.e.,
- * from `so'). Simply sucks in the whole file and moves into
- * the parse phase for the file.
+ * 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 ( ! read_whole_file(curp, &blk, &with_mmap)) {
- curp->file_status = MANDOCLEVEL_SYSERR;
- return;
+ 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 = term_tag_init(conf->output.outfilename,
+ conf->output.tagfilename);
+ if ((conf->output.outfilename != NULL ||
+ conf->output.tagfilename != NULL) &&
+ pledge("stdio rpath cpath", NULL) == -1) {
+ mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
+ "%s", strerror(errno));
+ exit(mandoc_msg_getrc());
+ }
+ }
+ if (outst->had_output && outst->outtype <= OUTT_UTF8) {
+ if (outst->outdata == NULL)
+ outdata_alloc(outst, &conf->output);
+ terminal_sepline(outst->outdata);
}
- /* Line number is per-file. */
-
- curp->line = 1;
-
- parsebuf(curp, blk, 1);
+ if (resp->form == FORM_SRC)
+ parse(mp, fd, resp->file, outst, &conf->output);
+ else {
+ passthrough(fd, conf->output.synopsisonly);
+ outst->had_output = 1;
+ }
- if (with_mmap)
- munmap(blk.buf, blk.sz);
- else
- free(blk.buf);
+ if (ferror(stdout)) {
+ if (outst->tag_files != NULL) {
+ mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
+ outst->tag_files->ofn, strerror(errno));
+ term_tag_unlink();
+ outst->tag_files = NULL;
+ } else
+ mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
+ strerror(errno));
+ }
+ mandoc_msg_setinfilename(NULL);
}
-/*
- * Main parse routine for an opened file. This is called for each
- * opened file and simply loops around the full input file, possibly
- * nesting (i.e., with `so').
- */
static void
-parsebuf(struct curparse *curp, struct buf blk, int start)
+parse(struct mparse *mp, int fd, const char *file,
+ struct outstate *outst, struct manoutput *outconf)
{
- const struct tbl_span *span;
- struct buf ln;
- enum rofferr rr;
- int i, of, rc;
- int pos; /* byte number in the ln buffer */
- int lnn; /* line number in the real file */
- unsigned char c;
-
- memset(&ln, 0, sizeof(struct buf));
-
- lnn = curp->line;
- pos = 0;
-
- for (i = 0; i < (int)blk.sz; ) {
- if (0 == pos && '\0' == blk.buf[i])
- break;
-
- if (start) {
- curp->line = lnn;
- curp->reparse_count = 0;
- }
-
- while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) {
-
- /*
- * When finding an unescaped newline character,
- * leave the character loop to process the line.
- * Skip a preceding carriage return, if any.
- */
-
- if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz &&
- '\n' == blk.buf[i + 1])
- ++i;
- if ('\n' == blk.buf[i]) {
- ++i;
- ++lnn;
- break;
- }
-
- /*
- * 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.
- */
-
- c = (unsigned char) blk.buf[i];
-
- if ( ! (isascii(c) &&
- (isgraph(c) || isblank(c)))) {
- mmsg(MANDOCERR_BADCHAR, curp,
- curp->line, pos, "ignoring byte");
- i++;
- continue;
- }
+ static int previous;
+ struct roff_meta *meta;
- /* Trailing backslash = a plain char. */
+ assert(fd >= 0);
+ if (file == NULL)
+ file = "<stdin>";
- if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
- if (pos >= (int)ln.sz)
- resize_buf(&ln, 256);
- ln.buf[pos++] = blk.buf[i++];
- continue;
- }
+ if (previous)
+ mparse_reset(mp);
+ else
+ previous = 1;
- /*
- * Found escape and at least one other character.
- * When it's a newline character, skip it.
- * When there is a carriage return in between,
- * skip that one as well.
- */
-
- if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz &&
- '\n' == blk.buf[i + 2])
- ++i;
- if ('\n' == blk.buf[i + 1]) {
- i += 2;
- ++lnn;
- continue;
- }
+ mparse_readfd(mp, fd, file);
+ if (fd != STDIN_FILENO)
+ close(fd);
- 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;
- }
- }
+ /*
+ * With -Wstop and warnings or errors of at least the requested
+ * level, do not produce output.
+ */
- /* Backout trailing whitespaces */
- for (; pos > 0; --pos) {
- if (ln.buf[pos - 1] != ' ')
- break;
- if (pos > 2 && ln.buf[pos - 2] == '\\')
- break;
- }
- break;
- }
+ if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
+ return;
- /* Some other escape sequence, copy & cont. */
+ if (outst->outdata == NULL)
+ outdata_alloc(outst, outconf);
+ else if (outst->outtype == OUTT_HTML)
+ html_reset(outst->outdata);
- if (pos + 1 >= (int)ln.sz)
- resize_buf(&ln, 256);
+ mandoc_xr_reset();
+ meta = mparse_result(mp);
- ln.buf[pos++] = blk.buf[i++];
- ln.buf[pos++] = blk.buf[i++];
- }
+ /* Execute the out device, if it exists. */
- if (pos >= (int)ln.sz)
- resize_buf(&ln, 256);
-
- ln.buf[pos] = '\0';
-
- /*
- * 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.
- */
-
- of = 0;
-
-rerun:
- rr = roff_parseln
- (curp->roff, curp->line,
- &ln.buf, &ln.sz, of, &of);
-
- switch (rr) {
- case (ROFF_REPARSE):
- if (REPARSE_LIMIT >= ++curp->reparse_count)
- parsebuf(curp, ln, 0);
- else
- mmsg(MANDOCERR_ROFFLOOP, curp,
- curp->line, pos, NULL);
- pos = 0;
- continue;
- case (ROFF_APPEND):
- pos = (int)strlen(ln.buf);
- continue;
- case (ROFF_RERUN):
- goto rerun;
- case (ROFF_IGN):
- pos = 0;
- continue;
- case (ROFF_ERR):
- assert(MANDOCLEVEL_FATAL <= curp->file_status);
+ outst->had_output = 1;
+ if (meta->macroset == MACROSET_MDOC) {
+ switch (outst->outtype) {
+ case OUTT_HTML:
+ html_mdoc(outst->outdata, meta);
+ break;
+ case OUTT_TREE:
+ tree_mdoc(outst->outdata, meta);
+ break;
+ case OUTT_MAN:
+ man_mdoc(outst->outdata, meta);
+ break;
+ case OUTT_PDF:
+ case OUTT_ASCII:
+ case OUTT_UTF8:
+ case OUTT_LOCALE:
+ case OUTT_PS:
+ terminal_mdoc(outst->outdata, meta);
+ break;
+ case OUTT_MARKDOWN:
+ markdown_mdoc(outst->outdata, meta);
break;
- case (ROFF_SO):
- if (pfile(ln.buf + of, curp)) {
- pos = 0;
- continue;
- } else
- break;
default:
break;
}
-
- /*
- * If we encounter errors in the recursive parsebuf()
- * call, make sure we don't continue parsing.
- */
-
- if (MANDOCLEVEL_FATAL <= curp->file_status)
+ }
+ if (meta->macroset == MACROSET_MAN) {
+ switch (outst->outtype) {
+ case OUTT_HTML:
+ html_man(outst->outdata, meta);
break;
-
- /*
- * 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.
- */
-
- if ( ! (curp->man || curp->mdoc))
- pset(ln.buf + of, pos - of, curp);
-
- /*
- * Lastly, push down into the parsers themselves. One
- * of these will have already been set in the pset()
- * routine.
- * If libroff returns ROFF_TBL, then add it to the
- * currently open parse. Since we only get here if
- * there does exist data (see tbl_data.c), we're
- * guaranteed that something's been allocated.
- * Do the same for ROFF_EQN.
- */
-
- rc = -1;
-
- if (ROFF_TBL == rr)
- while (NULL != (span = roff_span(curp->roff))) {
- rc = curp->man ?
- man_addspan(curp->man, span) :
- mdoc_addspan(curp->mdoc, span);
- if (0 == rc)
- break;
- }
- else if (ROFF_EQN == rr)
- rc = curp->mdoc ?
- mdoc_addeqn(curp->mdoc,
- roff_eqn(curp->roff)) :
- man_addeqn(curp->man,
- roff_eqn(curp->roff));
- else if (curp->man || curp->mdoc)
- rc = curp->man ?
- man_parseln(curp->man,
- curp->line, ln.buf, of) :
- mdoc_parseln(curp->mdoc,
- curp->line, ln.buf, of);
-
- if (0 == rc) {
- assert(MANDOCLEVEL_FATAL <= curp->file_status);
+ case OUTT_TREE:
+ tree_man(outst->outdata, meta);
break;
- }
-
- /* Temporary buffers typically are not full. */
-
- if (0 == start && '\0' == blk.buf[i])
+ case OUTT_MAN:
+ mparse_copy(mp);
break;
-
- /* Start the next input line. */
-
- pos = 0;
+ case OUTT_PDF:
+ case OUTT_ASCII:
+ case OUTT_UTF8:
+ case OUTT_LOCALE:
+ case OUTT_PS:
+ terminal_man(outst->outdata, meta);
+ break;
+ default:
+ break;
+ }
}
-
- free(ln.buf);
+ if (outconf->tag != NULL && outconf->tag_found == 0 &&
+ tag_exists(outconf->tag))
+ outconf->tag_found = 1;
+ if (mandoc_msg_getmin() < MANDOCERR_STYLE)
+ check_xr();
}
static void
-pset(const char *buf, int pos, struct curparse *curp)
+check_xr(void)
{
- int i;
+ static struct manpaths paths;
+ struct mansearch search;
+ struct mandoc_xr *xr;
+ size_t sz;
- /*
- * 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.
- *
- * Separate out pmdoc/pman from mdoc/man: the first persists
- * through all parsers, while the latter is used per-parse.
- */
+ if (paths.sz == 0)
+ manpath_base(&paths);
- if ('.' == buf[0] || '\'' == buf[0]) {
- for (i = 1; buf[i]; i++)
- if (' ' != buf[i] && '\t' != buf[i])
- break;
- if ('\0' == buf[i])
- return;
+ for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
+ if (xr->line == -1)
+ continue;
+ search.arch = NULL;
+ search.sec = xr->sec;
+ search.outkey = NULL;
+ search.argmode = ARG_NAME;
+ search.firstmatch = 1;
+ if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
+ continue;
+ if (fs_search(&search, &paths, xr->name, NULL, &sz) != -1)
+ continue;
+ if (xr->count == 1)
+ mandoc_msg(MANDOCERR_XR_BAD, xr->line,
+ xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
+ else
+ mandoc_msg(MANDOCERR_XR_BAD, xr->line,
+ xr->pos + 1, "Xr %s %s (%d times)",
+ xr->name, xr->sec, xr->count);
}
+}
- switch (curp->inttype) {
- case (INTT_MDOC):
- if (NULL == curp->pmdoc)
- curp->pmdoc = mdoc_alloc
- (&curp->regs, curp, mmsg);
- assert(curp->pmdoc);
- curp->mdoc = curp->pmdoc;
- return;
- case (INTT_MAN):
- if (NULL == curp->pman)
- curp->pman = man_alloc
- (&curp->regs, curp, mmsg);
- assert(curp->pman);
- curp->man = curp->pman;
- return;
+static void
+outdata_alloc(struct outstate *outst, struct manoutput *outconf)
+{
+ switch (outst->outtype) {
+ case OUTT_HTML:
+ outst->outdata = html_alloc(outconf);
+ break;
+ case OUTT_UTF8:
+ outst->outdata = utf8_alloc(outconf);
+ break;
+ case OUTT_LOCALE:
+ outst->outdata = locale_alloc(outconf);
+ break;
+ case OUTT_ASCII:
+ outst->outdata = ascii_alloc(outconf);
+ break;
+ case OUTT_PDF:
+ outst->outdata = pdf_alloc(outconf);
+ break;
+ case OUTT_PS:
+ outst->outdata = ps_alloc(outconf);
+ break;
default:
break;
}
-
- if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) {
- if (NULL == curp->pmdoc)
- curp->pmdoc = mdoc_alloc
- (&curp->regs, curp, mmsg);
- assert(curp->pmdoc);
- curp->mdoc = curp->pmdoc;
- return;
- }
-
- if (NULL == curp->pman)
- curp->pman = man_alloc(&curp->regs, curp, mmsg);
- assert(curp->pman);
- curp->man = curp->pman;
}
-static int
-moptions(enum intt *tflags, char *arg)
+static void
+passthrough(int fd, int synopsis_only)
{
-
- 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);
+ const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
+ const char synr[] = "SYNOPSIS";
+
+ FILE *stream;
+ char *line, *cp;
+ size_t linesz;
+ ssize_t len, written;
+ int lno, print;
+
+ stream = NULL;
+ line = NULL;
+ linesz = 0;
+
+ if (fflush(stdout) == EOF) {
+ mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
+ goto done;
}
-
- return(1);
-}
-
-static int
-toptions(struct curparse *curp, char *arg)
-{
-
- if (0 == strcmp(arg, "ascii"))
- curp->outtype = OUTT_ASCII;
- else if (0 == strcmp(arg, "lint")) {
- curp->outtype = OUTT_LINT;
- curp->wlevel = MANDOCLEVEL_WARNING;
+ if ((stream = fdopen(fd, "r")) == NULL) {
+ close(fd);
+ mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
+ goto done;
}
- else if (0 == strcmp(arg, "tree"))
- curp->outtype = OUTT_TREE;
- 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, "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);
+
+ lno = print = 0;
+ while ((len = getline(&line, &linesz, stream)) != -1) {
+ lno++;
+ 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) {
+ mandoc_msg(MANDOCERR_WRITE, 0, 0,
+ "%s", strerror(errno));
+ goto done;
+ }
+ }
}
+ if (ferror(stream))
+ mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
- return(1);
+done:
+ free(line);
+ if (stream != NULL)
+ fclose(stream);
}
static int
-woptions(struct curparse *curp, char *arg)
+woptions(char *arg, enum mandoc_os *os_e, int *wstop)
{
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):
- curp->wstop = 1;
+ switch (getsubopt(&arg, (char * const *)toks, &v)) {
+ case 0:
+ *wstop = 1;
+ break;
+ case 1:
+ case 2:
+ mandoc_msg_setmin(MANDOCERR_BASE);
+ break;
+ case 3:
+ mandoc_msg_setmin(MANDOCERR_STYLE);
+ break;
+ case 4:
+ mandoc_msg_setmin(MANDOCERR_WARNING);
+ break;
+ case 5:
+ mandoc_msg_setmin(MANDOCERR_ERROR);
break;
- case (1):
- /* FALLTHROUGH */
- case (2):
- curp->wlevel = MANDOCLEVEL_WARNING;
+ case 6:
+ mandoc_msg_setmin(MANDOCERR_UNSUPP);
break;
- case (3):
- curp->wlevel = MANDOCLEVEL_ERROR;
+ case 7:
+ mandoc_msg_setmin(MANDOCERR_BADARG);
break;
- case (4):
- curp->wlevel = MANDOCLEVEL_FATAL;
+ case 8:
+ mandoc_msg_setmin(MANDOCERR_BASE);
+ *os_e = MANDOC_OS_OPENBSD;
+ break;
+ case 9:
+ mandoc_msg_setmin(MANDOCERR_BASE);
+ *os_e = MANDOC_OS_NETBSD;
break;
default:
- fprintf(stderr, "-W%s: Bad argument\n", o);
- return(0);
+ mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
+ return -1;
}
}
-
- return(1);
+ return 0;
}
+/*
+ * Wait until moved to the foreground,
+ * then fork the pager and wait for the user to close it.
+ */
static void
-mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
+run_pager(struct outstate *outst, char *tag_target)
{
- struct curparse *cp;
- enum mandoclevel level;
+ int signum, status;
+ pid_t man_pgid, tc_pgid;
+ pid_t pager_pid, wait_pid;
- level = MANDOCLEVEL_FATAL;
- while (t < mandoclimits[level])
- /* LINTED */
- level--;
+ man_pgid = getpgid(0);
+ outst->tag_files->tcpgid =
+ man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
+ pager_pid = 0;
+ signum = SIGSTOP;
- cp = (struct curparse *)arg;
- if (level < cp->wlevel)
- return;
+ for (;;) {
+ /* Stop here until moved to the foreground. */
+
+ tc_pgid = tcgetpgrp(STDOUT_FILENO);
+ if (tc_pgid != man_pgid) {
+ if (tc_pgid == pager_pid) {
+ (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
+ if (signum == SIGTTIN)
+ continue;
+ } else
+ outst->tag_files->tcpgid = tc_pgid;
+ kill(0, signum);
+ continue;
+ }
+
+ /* Once in the foreground, activate the pager. */
+
+ if (pager_pid) {
+ (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
+ kill(pager_pid, SIGCONT);
+ } else
+ pager_pid = spawn_pager(outst, tag_target);
+
+ /* Wait for the pager to stop or exit. */
+
+ while ((wait_pid = waitpid(pager_pid, &status,
+ WUNTRACED)) == -1 && errno == EINTR)
+ continue;
+
+ if (wait_pid == -1) {
+ mandoc_msg(MANDOCERR_WAIT, 0, 0,
+ "%s", strerror(errno));
+ break;
+ }
+ if (!WIFSTOPPED(status))
+ break;
+
+ signum = WSTOPSIG(status);
+ }
+}
+
+static pid_t
+spawn_pager(struct outstate *outst, char *tag_target)
+{
+ const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
+#define MAX_PAGER_ARGS 16
+ char *argv[MAX_PAGER_ARGS];
+ const char *pager;
+ char *cp;
+#if HAVE_LESS_T
+ size_t cmdlen;
+#endif
+ int argc, use_ofn;
+ pid_t pager_pid;
+
+ assert(outst->tag_files->ofd == -1);
+ assert(outst->tag_files->tfs == NULL);
+
+ pager = getenv("MANPAGER");
+ if (pager == NULL || *pager == '\0')
+ pager = getenv("PAGER");
+ if (pager == NULL || *pager == '\0')
+ pager = BINM_PAGER;
+ cp = mandoc_strdup(pager);
+
+ /*
+ * Parse the pager command into words.
+ * Intentionally do not do anything fancy here.
+ */
+
+ argc = 0;
+ while (argc + 5 < 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. */
+
+ use_ofn = 1;
+#if HAVE_LESS_T
+ if (*outst->tag_files->tfn != '\0' &&
+ (cmdlen = strlen(argv[0])) >= 4) {
+ cp = argv[0] + cmdlen - 4;
+ if (strcmp(cp, "less") == 0) {
+ argv[argc++] = mandoc_strdup("-T");
+ argv[argc++] = outst->tag_files->tfn;
+ if (tag_target != NULL) {
+ argv[argc++] = mandoc_strdup("-t");
+ argv[argc++] = tag_target;
+ use_ofn = 0;
+ }
+ }
+ }
+#endif
+ if (use_ofn) {
+ if (outst->outtype == OUTT_HTML && tag_target != NULL)
+ mandoc_asprintf(&argv[argc], "file://%s#%s",
+ outst->tag_files->ofn, tag_target);
+ else
+ argv[argc] = outst->tag_files->ofn;
+ argc++;
+ }
+ argv[argc] = NULL;
+
+ switch (pager_pid = fork()) {
+ case -1:
+ mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
+ exit(mandoc_msg_getrc());
+ case 0:
+ break;
+ default:
+ (void)setpgid(pager_pid, 0);
+ (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
+#if HAVE_PLEDGE
+ if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
+ mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
+ "%s", strerror(errno));
+ exit(mandoc_msg_getrc());
+ }
+#endif
+ outst->tag_files->pager_pid = pager_pid;
+ return pager_pid;
+ }
+
+ /*
+ * The child process becomes the pager.
+ * Do not start it before controlling the terminal.
+ */
- fprintf(stderr, "%s:%d:%d: %s: %s",
- cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]);
- if (msg)
- fprintf(stderr, ": %s", msg);
- fputc('\n', stderr);
+ while (tcgetpgrp(STDOUT_FILENO) != getpid())
+ nanosleep(&timeout, NULL);
- if (cp->file_status < level)
- cp->file_status = level;
+ execvp(argv[0], argv);
+ mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
+ _exit(mandoc_msg_getrc());
}
git.ckatri.com / mandoc.git / blobdiff