version 1.117, 2010/12/05 15:49:37 |
version 1.341, 2020/01/20 10:37:15 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010-2012, 2014-2019 Ingo Schwarze <schwarze@openbsd.org> |
|
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
* copyright notice and this permission notice appear in all copies. |
* 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 |
* 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 |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
*/ |
*/ |
#ifdef HAVE_CONFIG_H |
|
#include "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/stat.h> |
|
#include <sys/wait.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
#include <ctype.h> |
|
#if HAVE_ERR |
|
#include <err.h> |
|
#endif |
|
#include <errno.h> |
#include <fcntl.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 <stdio.h> |
#include <stdint.h> |
#include <stdint.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
|
#include <termios.h> |
|
#include <time.h> |
#include <unistd.h> |
#include <unistd.h> |
|
|
|
#include "mandoc_aux.h" |
#include "mandoc.h" |
#include "mandoc.h" |
#include "main.h" |
#include "mandoc_xr.h" |
|
#include "roff.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "roff.h" |
#include "mandoc_parse.h" |
|
#include "tag.h" |
|
#include "main.h" |
|
#include "manconf.h" |
|
#include "mansearch.h" |
|
|
#ifndef MAP_FILE |
enum outmode { |
#define MAP_FILE 0 |
OUTMODE_DEF = 0, |
#endif |
OUTMODE_FLN, |
|
OUTMODE_LST, |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
OUTMODE_ALL, |
|
OUTMODE_ONE |
/* 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 |
|
}; |
|
|
|
enum outt { |
enum outt { |
OUTT_ASCII = 0, |
OUTT_ASCII = 0, /* -Tascii */ |
OUTT_TREE, |
OUTT_LOCALE, /* -Tlocale */ |
OUTT_HTML, |
OUTT_UTF8, /* -Tutf8 */ |
OUTT_XHTML, |
OUTT_TREE, /* -Ttree */ |
OUTT_LINT, |
OUTT_MAN, /* -Tman */ |
OUTT_PS, |
OUTT_HTML, /* -Thtml */ |
OUTT_PDF |
OUTT_MARKDOWN, /* -Tmarkdown */ |
|
OUTT_LINT, /* -Tlint */ |
|
OUTT_PS, /* -Tps */ |
|
OUTT_PDF /* -Tpdf */ |
}; |
}; |
|
|
struct curparse { |
struct outstate { |
const char *file; /* Current parse. */ |
struct tag_files *tag_files; /* Tagging state variables. */ |
int fd; /* Current parse. */ |
|
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 */ |
|
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 */ |
|
void *outdata; /* data for output */ |
void *outdata; /* data for output */ |
char outopts[BUFSIZ]; /* buf of output opts */ |
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 char * const mandoclevels[MANDOCLEVEL_MAX] = { |
|
"SUCCESS", |
|
"RESERVED", |
|
"WARNING", |
|
"ERROR", |
|
"FATAL", |
|
"BADARG", |
|
"SYSERR" |
|
}; |
|
|
|
static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = { |
int mandocdb(int, char *[]); |
MANDOCERR_OK, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_ERROR, |
|
MANDOCERR_FATAL, |
|
MANDOCERR_MAX, |
|
MANDOCERR_MAX |
|
}; |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
static void check_xr(void); |
"ok", |
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 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__)); |
|
static int woptions(char *, enum mandoc_os *, int *); |
|
|
"generic warning", |
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}; |
|
|
".so is fragile, better use ln(1)", |
|
"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", |
|
"displays may not be nested", |
|
"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", |
|
"uname(3) system call failed", |
|
"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", |
|
"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", |
|
"NOT IMPLEMENTED: .so with absolute path or \"..\"", |
|
"no document body", |
|
"no document prologue", |
|
"static buffer exhausted", |
|
}; |
|
|
|
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 int 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; |
|
static enum mandoclevel file_status = MANDOCLEVEL_OK; |
|
static enum mandoclevel exit_status = MANDOCLEVEL_OK; |
|
|
|
int |
int |
main(int argc, char *argv[]) |
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; |
int c; |
struct curparse curp; |
enum mandoc_os os_e; /* Check base system conventions. */ |
|
enum outmode outmode; /* According to command line. */ |
|
|
progname = strrchr(argv[0], '/'); |
#if HAVE_PROGNAME |
if (progname == NULL) |
progname = getprogname(); |
|
#else |
|
if (argc < 1) |
|
progname = mandoc_strdup("mandoc"); |
|
else if ((progname = strrchr(argv[0], '/')) == NULL) |
progname = argv[0]; |
progname = argv[0]; |
else |
else |
++progname; |
++progname; |
|
setprogname(progname); |
|
#endif |
|
|
memset(&curp, 0, sizeof(struct curparse)); |
mandoc_msg_setoutfile(stderr); |
|
if (strncmp(progname, "mandocdb", 8) == 0 || |
|
strcmp(progname, BINM_MAKEWHATIS) == 0) |
|
return mandocdb(argc, argv); |
|
|
curp.inttype = INTT_AUTO; |
#if HAVE_PLEDGE |
curp.outtype = OUTT_ASCII; |
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) { |
curp.wlevel = MANDOCLEVEL_FATAL; |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); |
|
return mandoc_msg_getrc(); |
/* 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); |
|
} |
} |
|
#endif |
|
#if HAVE_SANDBOX_INIT |
|
if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) |
|
errx((int)MANDOCLEVEL_SYSERR, "sandbox_init"); |
|
#endif |
|
|
while (*argv) { |
/* Search options. */ |
ffile(*argv, &curp); |
|
if (MANDOCLEVEL_OK != exit_status && curp.wstop) |
|
break; |
|
++argv; |
|
} |
|
|
|
if (curp.outfree) |
memset(&conf, 0, sizeof(conf)); |
(*curp.outfree)(curp.outdata); |
conf_file = NULL; |
if (curp.pmdoc) |
defpaths = auxpaths = NULL; |
mdoc_free(curp.pmdoc); |
|
if (curp.pman) |
|
man_free(curp.pman); |
|
if (curp.roff) |
|
roff_free(curp.roff); |
|
|
|
return((int)exit_status); |
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; |
|
|
static void |
/* Parser options. */ |
version(void) |
|
{ |
|
|
|
(void)printf("%s %s\n", progname, VERSION); |
options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; |
exit((int)MANDOCLEVEL_OK); |
os_e = MANDOC_OS_OTHER; |
} |
os_s = NULL; |
|
|
|
/* Formatter options. */ |
|
|
static void |
memset(&outst, 0, sizeof(outst)); |
usage(void) |
outst.tag_files = NULL; |
{ |
outst.outtype = OUTT_LOCALE; |
|
outst.use_pager = 1; |
|
|
(void)fprintf(stderr, "usage: %s " |
show_usage = 0; |
"[-V] " |
outmode = OUTMODE_DEF; |
"[-foption] " |
|
"[-mformat] " |
|
"[-Ooption] " |
|
"[-Toutput] " |
|
"[-Werr] " |
|
"[file...]\n", |
|
progname); |
|
|
|
exit((int)MANDOCLEVEL_BADARG); |
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; |
|
} |
|
} |
|
|
static void |
if (show_usage) |
ffile(const char *file, struct curparse *curp) |
usage(search.argmode); |
{ |
|
|
|
/* |
/* Postprocess 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(). |
|
*/ |
|
|
|
curp->file = file; |
if (outmode == 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; |
|
} |
|
} |
|
|
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
if (oarg != NULL) { |
perror(curp->file); |
if (outmode == OUTMODE_LST) |
exit_status = MANDOCLEVEL_SYSERR; |
search.outkey = oarg; |
return; |
else { |
|
while (oarg != NULL) { |
|
if (manconf_output(&conf.output, |
|
strsep(&oarg, ","), 0) == -1) |
|
return mandoc_msg_getrc(); |
|
} |
|
} |
} |
} |
|
|
fdesc(curp); |
if (outst.outtype != OUTT_TREE || conf.output.noval == 0) |
|
options |= MPARSE_VALIDATE; |
|
|
if (-1 == close(curp->fd)) |
if (outmode == OUTMODE_FLN || |
perror(curp->file); |
outmode == OUTMODE_LST || |
} |
!isatty(STDOUT_FILENO)) |
|
outst.use_pager = 0; |
|
|
static int |
if (outst.use_pager && |
pfile(const char *file, struct curparse *curp) |
(conf.output.width == 0 || conf.output.indent == 0) && |
{ |
ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 && |
const char *savefile; |
ws.ws_col > 1) { |
int fd, savefd; |
if (conf.output.width == 0 && ws.ws_col < 79) |
|
conf.output.width = ws.ws_col - 1; |
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
if (conf.output.indent == 0 && ws.ws_col < 66) |
perror(file); |
conf.output.indent = 3; |
file_status = MANDOCLEVEL_SYSERR; |
|
return(0); |
|
} |
} |
|
|
savefile = curp->file; |
#if HAVE_PLEDGE |
savefd = curp->fd; |
if (outst.use_pager == 0) { |
|
if (pledge("stdio rpath", NULL) == -1) { |
curp->file = file; |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
curp->fd = fd; |
"%s", strerror(errno)); |
|
return mandoc_msg_getrc(); |
pdesc(curp); |
} |
|
|
curp->file = savefile; |
|
curp->fd = savefd; |
|
|
|
if (-1 == close(fd)) |
|
perror(file); |
|
|
|
return(MANDOCLEVEL_FATAL > file_status ? 1 : 0); |
|
} |
|
|
|
|
|
static void |
|
resize_buf(struct buf *buf, size_t initial) |
|
{ |
|
|
|
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); |
|
} |
} |
} |
#endif |
|
|
|
/* Parse arguments. */ |
|
|
static int |
if (argc > 0) { |
read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap) |
argc -= optind; |
{ |
argv += optind; |
struct stat st; |
|
size_t off; |
|
ssize_t ssz; |
|
|
|
if (-1 == fstat(curp->fd, &st)) { |
|
perror(curp->file); |
|
return(0); |
|
} |
} |
|
|
/* |
/* |
* If we're a regular file, try just reading in the whole entry |
* Quirks for help(1) and man(1), |
* via mmap(). This is faster than reading it into blocks, and |
* in particular for a section argument without -s. |
* since each file is only a few bytes to begin with, I'm not |
|
* concerned that this is going to tank any machines. |
|
*/ |
*/ |
|
|
if (S_ISREG(st.st_mode)) { |
if (search.argmode == ARG_NAME) { |
if (st.st_size >= (1U << 31)) { |
if (*progname == 'h') { |
fprintf(stderr, "%s: input too large\n", |
if (argc == 0) { |
curp->file); |
argv = help_argv; |
return(0); |
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; |
if (search.arch == NULL) |
fb->sz = (size_t)st.st_size; |
search.arch = getenv("MACHINE"); |
fb->buf = mmap(NULL, fb->sz, PROT_READ, |
#ifdef MACHINE |
MAP_FILE|MAP_SHARED, curp->fd, 0); |
if (search.arch == NULL) |
if (fb->buf != MAP_FAILED) |
search.arch = MACHINE; |
return(1); |
#endif |
|
if (outmode == OUTMODE_ONE) |
|
search.firstmatch = 1; |
} |
} |
|
|
/* |
/* |
* If this isn't a regular file (like, say, stdin), then we must |
* Use the first argument for -O tag in addition to |
* go the old way and just read things in bit by bit. |
* using it as a search term for man(1) or apropos(1). |
*/ |
*/ |
|
|
*with_mmap = 0; |
if (conf.output.tag != NULL && *conf.output.tag == '\0') { |
off = 0; |
tagarg = argc > 0 && search.argmode == ARG_EXPR ? |
fb->sz = 0; |
strchr(*argv, '=') : NULL; |
fb->buf = NULL; |
conf.output.tag = tagarg == NULL ? *argv : tagarg + 1; |
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; |
|
} |
} |
|
|
free(fb->buf); |
/* Read the configuration file. */ |
fb->buf = NULL; |
|
return(0); |
|
} |
|
|
|
|
if (search.argmode != ARG_FILE) |
|
manconf_parse(&conf, conf_file, defpaths, auxpaths); |
|
|
static void |
/* man(1): Resolve each name individually. */ |
fdesc(struct curparse *curp) |
|
{ |
|
|
|
/* |
if (search.argmode == ARG_NAME) { |
* Called once per file with an opened file descriptor. All |
if (argc < 1) |
* pre-file-parse operations (whether stdin or a file) should go |
usage(ARG_NAME); |
* here. |
for (res = NULL, ressz = 0; argc > 0; argc--, argv++) { |
* |
(void)mansearch(&search, &conf.manpath, |
* This calls down into the nested parser, which drills down and |
1, argv, &resn, &resnsz); |
* fully parses a file and all its dependences (i.e., `so'). It |
if (resnsz == 0) |
* then runs the cleanup validators and pushes to output. |
(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; |
|
} |
|
|
/* Zero the parse type. */ |
/* Search for the best section. */ |
|
|
curp->mdoc = NULL; |
best_prio = 40; |
curp->man = NULL; |
for (ib = i = 0; i < resnsz; i++) { |
file_status = MANDOCLEVEL_OK; |
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)); |
|
} |
|
|
/* Make sure the mandotory roff parser is initialised. */ |
/* apropos(1), whatis(1): Process the full search expression. */ |
|
|
if (NULL == curp->roff) { |
} else if (search.argmode != ARG_FILE) { |
curp->roff = roff_alloc(&curp->regs, curp, mmsg); |
if (mansearch(&search, &conf.manpath, |
assert(curp->roff); |
argc, argv, &res, &ressz) == 0) |
} |
usage(search.argmode); |
|
|
/* Fully parse the file. */ |
if (ressz == 0) { |
|
warnx("nothing appropriate"); |
|
mandoc_msg_setrc(MANDOCLEVEL_BADARG); |
|
goto out; |
|
} |
|
|
pdesc(curp); |
/* mandoc(1): Take command line arguments as file names. */ |
|
|
if (MANDOCLEVEL_FATAL <= file_status) |
} else { |
goto cleanup; |
ressz = argc > 0 ? argc : 1; |
|
res = mandoc_calloc(ressz, sizeof(*res)); |
/* NOTE a parser may not have been assigned, yet. */ |
for (i = 0; i < ressz; i++) { |
|
if (argc > 0) |
if ( ! (curp->man || curp->mdoc)) { |
res[i].file = mandoc_strdup(argv[i]); |
fprintf(stderr, "%s: Not a manual\n", curp->file); |
res[i].ipath = SIZE_MAX; |
file_status = MANDOCLEVEL_FATAL; |
res[i].form = FORM_SRC; |
goto cleanup; |
} |
} |
} |
|
|
/* Clean up the parse routine ASTs. */ |
switch (outmode) { |
|
case OUTMODE_FLN: |
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
for (i = 0; i < ressz; i++) |
assert(MANDOCLEVEL_FATAL <= file_status); |
puts(res[i].file); |
goto cleanup; |
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)) { |
if (search.argmode == ARG_FILE && auxpaths != NULL) { |
assert(MANDOCLEVEL_FATAL <= file_status); |
if (strcmp(auxpaths, "doc") == 0) |
goto cleanup; |
options |= MPARSE_MDOC; |
|
else if (strcmp(auxpaths, "an") == 0) |
|
options |= MPARSE_MAN; |
} |
} |
|
|
assert(curp->roff); |
mchars_alloc(); |
if ( ! roff_endparse(curp->roff)) { |
mp = mparse_alloc(options, os_e, os_s); |
assert(MANDOCLEVEL_FATAL <= file_status); |
|
goto cleanup; |
|
} |
|
|
|
/* |
/* |
* With -Wstop and warnings or errors of at least |
* Remember the original working directory, if possible. |
* the requested level, do not produce output. |
* 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. |
*/ |
*/ |
|
startdir = open(".", O_RDONLY | O_DIRECTORY); |
|
|
if (MANDOCLEVEL_OK != file_status && curp->wstop) |
for (i = 0; i < ressz; i++) { |
goto cleanup; |
process_onefile(mp, res + i, startdir, &outst, &conf); |
|
if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
/* 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); |
|
break; |
break; |
case (OUTT_HTML): |
} |
curp->outdata = html_alloc(curp->outopts); |
if (startdir != -1) { |
break; |
(void)fchdir(startdir); |
case (OUTT_ASCII): |
close(startdir); |
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) { |
if (outst.outdata != NULL) { |
case (OUTT_HTML): |
switch (outst.outtype) { |
/* FALLTHROUGH */ |
case OUTT_HTML: |
case (OUTT_XHTML): |
html_free(outst.outdata); |
curp->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
break; |
case (OUTT_TREE): |
case OUTT_UTF8: |
curp->outman = tree_man; |
case OUTT_LOCALE: |
curp->outmdoc = tree_mdoc; |
case OUTT_ASCII: |
|
ascii_free(outst.outdata); |
break; |
break; |
case (OUTT_PDF): |
case OUTT_PDF: |
/* FALLTHROUGH */ |
case OUTT_PS: |
case (OUTT_ASCII): |
pspdf_free(outst.outdata); |
/* FALLTHROUGH */ |
|
case (OUTT_PS): |
|
curp->outman = terminal_man; |
|
curp->outmdoc = terminal_mdoc; |
|
break; |
break; |
default: |
default: |
break; |
break; |
} |
} |
} |
} |
|
mandoc_xr_free(); |
|
mparse_free(mp); |
|
mchars_free(); |
|
|
/* Execute the out device, if it exists. */ |
out: |
|
mansearch_free(res, ressz); |
|
if (search.argmode != ARG_FILE) |
|
manconf_free(&conf); |
|
|
if (curp->man && curp->outman) |
if (outst.tag_files != NULL) { |
(*curp->outman)(curp->outdata, curp->man); |
fclose(stdout); |
if (curp->mdoc && curp->outmdoc) |
tag_write(); |
(*curp->outmdoc)(curp->outdata, curp->mdoc); |
run_pager(outst.tag_files); |
|
tag_unlink(); |
|
} else if (outst.had_output && outst.outtype != OUTT_LINT) |
|
mandoc_msg_summary(); |
|
|
cleanup: |
return (int)mandoc_msg_getrc(); |
|
} |
|
|
memset(&curp->regs, 0, sizeof(struct regset)); |
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); |
|
} |
|
|
/* Reset the current-parse compilers. */ |
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; |
|
int globres; |
|
enum form form; |
|
|
if (curp->mdoc) |
form = FORM_SRC; |
mdoc_reset(curp->mdoc); |
mandoc_asprintf(&file, "%s/man%s/%s.%s", |
if (curp->man) |
paths->paths[ipath], sec, name, sec); |
man_reset(curp->man); |
if (stat(file, &sb) != -1) |
|
goto found; |
|
free(file); |
|
|
assert(curp->roff); |
mandoc_asprintf(&file, "%s/cat%s/%s.0", |
roff_reset(curp->roff); |
paths->paths[ipath], sec, name); |
|
if (stat(file, &sb) != -1) { |
|
form = FORM_CAT; |
|
goto found; |
|
} |
|
free(file); |
|
|
if (exit_status < file_status) |
if (arch != NULL) { |
exit_status = file_status; |
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); |
|
} |
|
|
return; |
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) |
|
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; |
|
|
static void |
mandoc_asprintf(&file, "%s.%s", name, sec); |
pdesc(struct curparse *curp) |
globres = stat(file, &sb); |
{ |
free(file); |
struct buf blk; |
return globres; |
int with_mmap; |
|
|
|
/* |
found: |
* Run for each opened file; may be called more than once for |
warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s", |
* each full parse sequence if the opened file is nested (i.e., |
name, sec, BINM_MAKEWHATIS, paths->paths[ipath]); |
* from `so'). Simply sucks in the whole file and moves into |
if (res == NULL) { |
* the parse phase for the file. |
free(file); |
*/ |
return 0; |
|
|
if ( ! read_whole_file(curp, &blk, &with_mmap)) { |
|
file_status = MANDOCLEVEL_SYSERR; |
|
return; |
|
} |
} |
|
*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; |
|
} |
|
|
/* Line number is per-file. */ |
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]); |
|
|
curp->line = 1; |
size_t ipath, isec; |
|
|
parsebuf(curp, blk, 1); |
assert(cfg->argmode == ARG_NAME); |
|
if (res != NULL) |
if (with_mmap) |
*res = NULL; |
munmap(blk.buf, blk.sz); |
*ressz = 0; |
else |
for (ipath = 0; ipath < paths->sz; ipath++) { |
free(blk.buf); |
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 |
static void |
parsebuf(struct curparse *curp, struct buf blk, int start) |
process_onefile(struct mparse *mp, struct manpage *resp, int startdir, |
|
struct outstate *outst, struct manconf *conf) |
{ |
{ |
struct buf ln; |
int fd; |
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; |
|
|
|
/* |
/* |
* Main parse routine for an opened file. This is called for |
* Changing directories is not needed in ARG_FILE mode. |
* each opened file and simply loops around the full input file, |
* Do it on a best-effort basis. Even in case of |
* possibly nesting (i.e., with `so'). |
* 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); |
|
|
memset(&ln, 0, sizeof(struct buf)); |
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; |
|
|
lnn = curp->line; |
if (outst->use_pager) { |
pos = 0; |
outst->use_pager = 0; |
|
outst->tag_files = tag_init(conf->output.tag); |
|
} |
|
|
for (i = 0; i < (int)blk.sz; ) { |
if (outst->had_output && outst->outtype <= OUTT_UTF8) { |
if (0 == pos && '\0' == blk.buf[i]) |
if (outst->outdata == NULL) |
break; |
outdata_alloc(outst, &conf->output); |
|
terminal_sepline(outst->outdata); |
|
} |
|
|
if (start) |
if (resp->form == FORM_SRC) |
curp->line = lnn; |
parse(mp, fd, resp->file, outst, &conf->output); |
|
else { |
|
passthrough(fd, conf->output.synopsisonly); |
|
outst->had_output = 1; |
|
} |
|
|
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
if (ferror(stdout)) { |
if ('\n' == blk.buf[i]) { |
if (outst->tag_files != NULL) { |
++i; |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s", |
++lnn; |
outst->tag_files->ofn, strerror(errno)); |
break; |
tag_unlink(); |
} |
outst->tag_files = NULL; |
|
} else |
|
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s", |
|
strerror(errno)); |
|
} |
|
mandoc_msg_setinfilename(NULL); |
|
} |
|
|
/* |
static void |
* Warn about bogus characters. If you're using |
parse(struct mparse *mp, int fd, const char *file, |
* non-ASCII encoding, you're screwing your |
struct outstate *outst, struct manoutput *outconf) |
* readers. Since I'd rather this not happen, |
{ |
* I'll be helpful and drop these characters so |
static int previous; |
* we don't display gibberish. Note to manual |
struct roff_meta *meta; |
* writers: use special characters. |
|
*/ |
|
|
|
c = (unsigned char) blk.buf[i]; |
assert(fd >= 0); |
|
if (file == NULL) |
|
file = "<stdin>"; |
|
|
if ( ! (isascii(c) && |
if (previous) |
(isgraph(c) || isblank(c)))) { |
mparse_reset(mp); |
mmsg(MANDOCERR_BADCHAR, curp, |
else |
curp->line, pos, "ignoring byte"); |
previous = 1; |
i++; |
|
continue; |
|
} |
|
|
|
/* Trailing backslash = a plain char. */ |
mparse_readfd(mp, fd, file); |
|
if (fd != STDIN_FILENO) |
|
close(fd); |
|
|
if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { |
/* |
if (pos >= (int)ln.sz) |
* With -Wstop and warnings or errors of at least the requested |
resize_buf(&ln, 256); |
* level, do not produce output. |
ln.buf[pos++] = blk.buf[i++]; |
*/ |
continue; |
|
} |
|
|
|
/* Found escape & at least one other char. */ |
if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
|
return; |
|
|
if ('\n' == blk.buf[i + 1]) { |
if (outst->outdata == NULL) |
i += 2; |
outdata_alloc(outst, outconf); |
/* Escaped newlines are skipped over */ |
else if (outst->outtype == OUTT_HTML) |
++lnn; |
html_reset(outst); |
continue; |
|
} |
|
|
|
if ('"' == blk.buf[i + 1]) { |
mandoc_xr_reset(); |
i += 2; |
meta = mparse_result(mp); |
/* Comment, skip to end of line */ |
|
for (; i < (int)blk.sz; ++i) { |
|
if ('\n' == blk.buf[i]) { |
|
++i; |
|
++lnn; |
|
break; |
|
} |
|
} |
|
|
|
/* Backout trailing whitespaces */ |
/* Execute the out device, if it exists. */ |
for (; pos > 0; --pos) { |
|
if (ln.buf[pos - 1] != ' ') |
|
break; |
|
if (pos > 2 && ln.buf[pos - 2] == '\\') |
|
break; |
|
} |
|
break; |
|
} |
|
|
|
/* Some other escape sequence, copy & cont. */ |
outst->had_output = 1; |
|
if (meta->macroset == MACROSET_MDOC) { |
if (pos + 1 >= (int)ln.sz) |
switch (outst->outtype) { |
resize_buf(&ln, 256); |
case OUTT_HTML: |
|
html_mdoc(outst->outdata, meta); |
ln.buf[pos++] = blk.buf[i++]; |
|
ln.buf[pos++] = blk.buf[i++]; |
|
} |
|
|
|
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): |
|
parsebuf(curp, ln, 0); |
|
pos = 0; |
|
continue; |
|
case (ROFF_APPEND): |
|
pos = strlen(ln.buf); |
|
continue; |
|
case (ROFF_RERUN): |
|
goto rerun; |
|
case (ROFF_IGN): |
|
pos = 0; |
|
continue; |
|
case (ROFF_ERR): |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
break; |
case (ROFF_SO): |
case OUTT_TREE: |
if (pfile(ln.buf + of, curp)) { |
tree_mdoc(outst->outdata, meta); |
pos = 0; |
|
continue; |
|
} else |
|
break; |
|
case (ROFF_CONT): |
|
break; |
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; |
|
default: |
|
break; |
} |
} |
|
} |
/* |
if (meta->macroset == MACROSET_MAN) { |
* If input parsers have not been allocated, do so now. |
switch (outst->outtype) { |
* We keep these instanced betwen parsers, but set them |
case OUTT_HTML: |
* locally per parse routine since we can use different |
html_man(outst->outdata, meta); |
* 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 (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 ( ! rc) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
|
} |
|
} |
|
|
|
/* Temporary buffers typically are not full. */ |
|
|
|
if (0 == start && '\0' == blk.buf[i]) |
|
break; |
break; |
|
case OUTT_TREE: |
/* Start the next input line. */ |
tree_man(outst->outdata, meta); |
|
break; |
pos = 0; |
case OUTT_MAN: |
|
mparse_copy(mp); |
|
break; |
|
case OUTT_PDF: |
|
case OUTT_ASCII: |
|
case OUTT_UTF8: |
|
case OUTT_LOCALE: |
|
case OUTT_PS: |
|
terminal_man(outst->outdata, meta); |
|
break; |
|
default: |
|
break; |
|
} |
} |
} |
|
if (mandoc_msg_getmin() < MANDOCERR_STYLE) |
free(ln.buf); |
check_xr(); |
} |
} |
|
|
static void |
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; |
|
|
/* |
if (paths.sz == 0) |
* Try to intuit which kind of manual parser should be used. If |
manpath_base(&paths); |
* 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 ('.' == buf[0] || '\'' == buf[0]) { |
for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) { |
for (i = 1; buf[i]; i++) |
if (xr->line == -1) |
if (' ' != buf[i] && '\t' != buf[i]) |
continue; |
break; |
search.arch = NULL; |
if ('\0' == buf[i]) |
search.sec = xr->sec; |
return; |
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) { |
static void |
case (INTT_MDOC): |
outdata_alloc(struct outstate *outst, struct manoutput *outconf) |
if (NULL == curp->pmdoc) |
{ |
curp->pmdoc = mdoc_alloc |
switch (outst->outtype) { |
(&curp->regs, curp, mmsg); |
case OUTT_HTML: |
assert(curp->pmdoc); |
outst->outdata = html_alloc(outconf); |
curp->mdoc = curp->pmdoc; |
break; |
return; |
case OUTT_UTF8: |
case (INTT_MAN): |
outst->outdata = utf8_alloc(outconf); |
if (NULL == curp->pman) |
break; |
curp->pman = man_alloc |
case OUTT_LOCALE: |
(&curp->regs, curp, mmsg); |
outst->outdata = locale_alloc(outconf); |
assert(curp->pman); |
break; |
curp->man = curp->pman; |
case OUTT_ASCII: |
return; |
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: |
default: |
break; |
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 |
static void |
moptions(enum intt *tflags, char *arg) |
passthrough(int fd, int synopsis_only) |
{ |
{ |
|
const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"; |
|
const char synr[] = "SYNOPSIS"; |
|
|
if (0 == strcmp(arg, "doc")) |
FILE *stream; |
*tflags = INTT_MDOC; |
char *line, *cp; |
else if (0 == strcmp(arg, "andoc")) |
size_t linesz; |
*tflags = INTT_AUTO; |
ssize_t len, written; |
else if (0 == strcmp(arg, "an")) |
int lno, print; |
*tflags = INTT_MAN; |
|
else { |
|
fprintf(stderr, "%s: Bad argument\n", arg); |
|
return(0); |
|
} |
|
|
|
return(1); |
stream = NULL; |
} |
line = NULL; |
|
linesz = 0; |
|
|
static int |
if (fflush(stdout) == EOF) { |
toptions(struct curparse *curp, char *arg) |
mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno)); |
{ |
goto done; |
|
|
if (0 == strcmp(arg, "ascii")) |
|
curp->outtype = OUTT_ASCII; |
|
else if (0 == strcmp(arg, "lint")) { |
|
curp->outtype = OUTT_LINT; |
|
curp->wlevel = MANDOCLEVEL_WARNING; |
|
} |
} |
else if (0 == strcmp(arg, "tree")) |
if ((stream = fdopen(fd, "r")) == NULL) { |
curp->outtype = OUTT_TREE; |
close(fd); |
else if (0 == strcmp(arg, "html")) |
mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno)); |
curp->outtype = OUTT_HTML; |
goto done; |
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); |
|
} |
} |
|
|
return(1); |
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)); |
|
|
|
done: |
|
free(line); |
|
if (stream != NULL) |
|
fclose(stream); |
} |
} |
|
|
static int |
static int |
woptions(struct curparse *curp, char *arg) |
woptions(char *arg, enum mandoc_os *os_e, int *wstop) |
{ |
{ |
char *v, *o; |
char *v, *o; |
const char *toks[6]; |
const char *toks[11]; |
|
|
toks[0] = "stop"; |
toks[0] = "stop"; |
toks[1] = "all"; |
toks[1] = "all"; |
toks[2] = "warning"; |
toks[2] = "base"; |
toks[3] = "error"; |
toks[3] = "style"; |
toks[4] = "fatal"; |
toks[4] = "warning"; |
toks[5] = NULL; |
toks[5] = "error"; |
|
toks[6] = "unsupp"; |
|
toks[7] = "fatal"; |
|
toks[8] = "openbsd"; |
|
toks[9] = "netbsd"; |
|
toks[10] = NULL; |
|
|
while (*arg) { |
while (*arg) { |
o = arg; |
o = arg; |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
switch (getsubopt(&arg, (char * const *)toks, &v)) { |
case (0): |
case 0: |
curp->wstop = 1; |
*wstop = 1; |
break; |
break; |
case (1): |
case 1: |
/* FALLTHROUGH */ |
case 2: |
case (2): |
mandoc_msg_setmin(MANDOCERR_BASE); |
curp->wlevel = MANDOCLEVEL_WARNING; |
|
break; |
break; |
case (3): |
case 3: |
curp->wlevel = MANDOCLEVEL_ERROR; |
mandoc_msg_setmin(MANDOCERR_STYLE); |
break; |
break; |
case (4): |
case 4: |
curp->wlevel = MANDOCLEVEL_FATAL; |
mandoc_msg_setmin(MANDOCERR_WARNING); |
break; |
break; |
|
case 5: |
|
mandoc_msg_setmin(MANDOCERR_ERROR); |
|
break; |
|
case 6: |
|
mandoc_msg_setmin(MANDOCERR_UNSUPP); |
|
break; |
|
case 7: |
|
mandoc_msg_setmin(MANDOCERR_BADARG); |
|
break; |
|
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: |
default: |
fprintf(stderr, "-W%s: Bad argument\n", o); |
mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o); |
return(0); |
return -1; |
} |
} |
} |
} |
|
return 0; |
|
} |
|
|
return(1); |
/* |
|
* Wait until moved to the foreground, |
|
* then fork the pager and wait for the user to close it. |
|
*/ |
|
static void |
|
run_pager(struct tag_files *tag_files) |
|
{ |
|
int signum, status; |
|
pid_t man_pgid, tc_pgid; |
|
pid_t pager_pid, wait_pid; |
|
|
|
man_pgid = getpgid(0); |
|
tag_files->tcpgid = man_pgid == getpid() ? getpgid(getppid()) : |
|
man_pgid; |
|
pager_pid = 0; |
|
signum = SIGSTOP; |
|
|
|
for (;;) { |
|
/* 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; |
|
} |
|
|
|
/* 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 ((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 int |
static pid_t |
mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) |
spawn_pager(struct tag_files *tag_files) |
{ |
{ |
struct curparse *cp; |
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ |
enum mandoclevel level; |
#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; |
|
|
level = MANDOCLEVEL_FATAL; |
pager = getenv("MANPAGER"); |
while (t < mandoclimits[level]) |
if (pager == NULL || *pager == '\0') |
/* LINTED */ |
pager = getenv("PAGER"); |
level--; |
if (pager == NULL || *pager == '\0') |
|
pager = "more -s"; |
|
cp = mandoc_strdup(pager); |
|
|
cp = (struct curparse *)arg; |
/* |
if (level < cp->wlevel) |
* Parse the pager command into words. |
return(1); |
* Intentionally do not do anything fancy here. |
|
*/ |
|
|
fprintf(stderr, "%s:%d:%d: %s: %s", |
argc = 0; |
cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]); |
while (argc + 5 < MAX_PAGER_ARGS) { |
if (msg) |
argv[argc++] = cp; |
fprintf(stderr, ": %s", msg); |
cp = strchr(cp, ' '); |
fputc('\n', stderr); |
if (cp == NULL) |
|
break; |
|
*cp++ = '\0'; |
|
while (*cp == ' ') |
|
cp++; |
|
if (*cp == '\0') |
|
break; |
|
} |
|
|
if (file_status < level) |
/* For less(1), use the tag file. */ |
file_status = level; |
|
|
use_ofn = 1; |
return(level < MANDOCLEVEL_FATAL); |
#if HAVE_LESS_T |
|
if (*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++] = tag_files->tfn; |
|
if (tag_files->tagname != NULL) { |
|
argv[argc++] = mandoc_strdup("-t"); |
|
argv[argc++] = tag_files->tagname; |
|
use_ofn = 0; |
|
} |
|
} |
|
} |
|
#endif |
|
if (use_ofn) |
|
argv[argc++] = tag_files->ofn; |
|
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(tag_files->ofd, 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 |
|
tag_files->pager_pid = pager_pid; |
|
return pager_pid; |
|
} |
|
|
|
/* The child process becomes the pager. */ |
|
|
|
if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) { |
|
mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno)); |
|
_exit(mandoc_msg_getrc()); |
|
} |
|
close(tag_files->ofd); |
|
assert(tag_files->tfd == -1); |
|
|
|
/* Do not start the pager before controlling the terminal. */ |
|
|
|
while (tcgetpgrp(STDOUT_FILENO) != getpid()) |
|
nanosleep(&timeout, NULL); |
|
|
|
execvp(argv[0], argv); |
|
mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno)); |
|
_exit(mandoc_msg_getrc()); |
} |
} |