mandoc/main.c - diff

Return to main.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/main.c between version 1.186 and 1.218

version 1.186, 2014/08/23 00:34:59

version 1.218, 2015/02/03 21:16:02

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

Line 19

#include "config.h"

#include <sys/types.h>

#include <sys/param.h> /* MACHINE */

#include <assert.h>

#include <ctype.h>

Line 64 enum outt {

Line 65 enum outt {

OUTT_TREE, /* -Ttree */

OUTT_MAN, /* -Tman */

OUTT_HTML, /* -Thtml */

OUTT_XHTML, /* -Txhtml */

OUTT_LINT, /* -Tlint */

OUTT_PS, /* -Tps */

OUTT_PDF /* -Tpdf */

Line 72 enum outt {

struct curparse {

struct mparse *mp;

struct mchars *mchars; /* character table */

enum mandoclevel wlevel; /* ignore messages below this */

int wstop; /* stop after a file with a warning */

enum outt outtype; /* which output to use */

Line 82 struct curparse {

Line 83 struct curparse {

char outopts[BUFSIZ]; /* buf of output opts */

};

static int fs_lookup(const struct manpaths *,

size_t ipath, const char *,

const char *, const char *,

struct manpage **, size_t *);

static void fs_search(const struct mansearch *,

const struct manpaths *, int, char**,

struct manpage **, size_t *);

static int koptions(int *, char *);

#if HAVE_SQLITE3

int mandocdb(int, char**);

#endif

static int moptions(int *, char *);

static void mmsg(enum mandocerr, enum mandoclevel,

const char *, int, int, const char *);

static void parse(struct curparse *, int,

const char *, enum mandoclevel *);

static enum mandoclevel passthrough(const char *);

static enum mandoclevel passthrough(const char *, int, int);

static void spawn_pager(void);

static int toptions(struct curparse *, char *);

static void usage(enum argmode) __attribute__((noreturn));

Line 95 static void version(void) __attribute__((noreturn))

Line 107 static void version(void) __attribute__((noreturn))

static int woptions(struct curparse *, char *);

static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};

static char help_arg[] = "help";

static char *help_argv[] = {help_arg, NULL};

static const char *progname;

Line 104 main(int argc, char *argv[])

Line 118 main(int argc, char *argv[])

struct curparse curp;

struct mansearch search;

struct manpaths paths;

char *conf_file, *defpaths, *auxpaths;

char *auxpaths;

char *defos;

#if HAVE_SQLITE3

unsigned char *uc;

struct manpage *res, *resp;

char *conf_file, *defpaths;

size_t isec, i, sz;

int prio, best_prio;

int prio, best_prio, synopsis_only;

char sec;

#endif

enum mandoclevel rc, rctmp;

enum mandoclevel rc;

enum outmode outmode;

int fd;

int show_usage;

int use_pager;

int options;

Line 125 main(int argc, char *argv[])

Line 140 main(int argc, char *argv[])

else

++progname;

#if HAVE_SQLITE3

if (strcmp(progname, BINM_MAKEWHATIS) == 0)

return(mandocdb(argc, argv));

#endif

/* Search options. */

memset(&paths, 0, sizeof(struct manpaths));

conf_file = defpaths = auxpaths = NULL;

conf_file = defpaths = NULL;

auxpaths = NULL;

memset(&search, 0, sizeof(struct mansearch));

search.outkey = "Nd";

if (strcmp(progname, "man") == 0)

if (strcmp(progname, BINM_MAN) == 0)

search.argmode = ARG_NAME;

else if (strncmp(progname, "apropos", 7) == 0)

else if (strcmp(progname, BINM_APROPOS) == 0)

search.argmode = ARG_EXPR;

else if (strncmp(progname, "whatis", 6) == 0)

else if (strcmp(progname, BINM_WHATIS) == 0)

search.argmode = ARG_WORD;

else if (strncmp(progname, "help", 4) == 0)

search.argmode = ARG_NAME;

else

search.argmode = ARG_FILE;

/* Parser and formatter options. */

memset(&curp, 0, sizeof(struct curparse));

curp.outtype = OUTT_ASCII;

curp.outtype = OUTT_LOCALE;

curp.wlevel = MANDOCLEVEL_FATAL;

curp.wlevel = MANDOCLEVEL_BADARG;

options = MPARSE_SO;

options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;

defos = NULL;

use_pager = 1;

show_usage = 0;

synopsis_only = 0;

outmode = OUTMODE_DEF;

while (-1 != (c = getopt(argc, argv, "aC:cfI:ikM:m:O:S:s:T:VW:w"))) {

while (-1 != (c = getopt(argc, argv,

"aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {

switch (c) {

case 'a':

outmode = OUTMODE_ALL;

Line 168 main(int argc, char *argv[])

Line 193 main(int argc, char *argv[])

case 'f':

search.argmode = ARG_WORD;

break;

case 'h':

(void)strlcat(curp.outopts, "synopsis,", BUFSIZ);

synopsis_only = 1;

use_pager = 0;

outmode = OUTMODE_ALL;

break;

case 'I':

if (strncmp(optarg, "os=", 3)) {

fprintf(stderr,

"%s: -I%s: Bad argument\n",

"%s: -I %s: Bad argument\n",

progname, optarg);

return((int)MANDOCLEVEL_BADARG);

}

if (defos) {

fprintf(stderr,

"%s: -I%s: Duplicate argument\n",

"%s: -I %s: Duplicate argument\n",

progname, optarg);

return((int)MANDOCLEVEL_BADARG);

}

Line 186 main(int argc, char *argv[])

Line 217 main(int argc, char *argv[])

case 'i':

outmode = OUTMODE_INT;

break;

case 'K':

if ( ! koptions(&options, optarg))

return((int)MANDOCLEVEL_BADARG);

break;

case 'k':

search.argmode = ARG_EXPR;

break;

case 'l':

search.argmode = ARG_FILE;

outmode = OUTMODE_ALL;

break;

case 'M':

defpaths = optarg;

break;

Line 250 main(int argc, char *argv[])

Line 289 main(int argc, char *argv[])

argc -= optind;

argv += optind;

#if HAVE_SQLITE3

resp = NULL;

#endif

/* Quirk for a man(1) section argument without -s. */

* Quirks for help(1)

* and for a man(1) section argument without -s.

if (search.argmode == ARG_NAME &&

if (search.argmode == ARG_NAME) {

argv[0] != NULL &&

if (*progname == 'h') {

isdigit((unsigned char)argv[0][0]) &&

if (argc == 0) {

(argv[0][1] == '\0' || !strcmp(argv[0], "3p"))) {

argv = help_argv;

search.sec = argv[0];

argc = 1;

argv++;

}

argc--;

} else if (argc > 1 &&

((uc = argv[0]) != NULL) &&

((isdigit(uc[0]) && (uc[1] == '\0' ||

(isalpha(uc[1]) && uc[2] == '\0'))) ||

(uc[0] == 'n' && uc[1] == '\0'))) {

search.sec = uc;

argv++;

argc--;

}

if (search.arch == NULL)

search.arch = getenv("MACHINE");

if (search.arch == NULL)

search.arch = MACHINE;

}

rc = MANDOCLEVEL_OK;

Line 270 main(int argc, char *argv[])

Line 322 main(int argc, char *argv[])

/* man(1), whatis(1), apropos(1) */

if (search.argmode != ARG_FILE) {

#if HAVE_SQLITE3

if (argc == 0)

usage(search.argmode);

if (search.argmode == ARG_NAME &&

outmode == OUTMODE_ONE)

search.firstmatch = 1;

/* Access the mandoc database. */

manpath_parse(&paths, conf_file, defpaths, auxpaths);

#if HAVE_SQLITE3

mansearch_setup(1);

if( ! mansearch(&search, &paths, argc, argv, &res, &sz))

usage(search.argmode);

manpath_free(&paths);

#else

resp = res;

if (search.argmode != ARG_NAME) {

fputs("mandoc: database support not compiled in\n",

stderr);

return((int)MANDOCLEVEL_BADARG);

}

sz = 0;

#endif

if (sz == 0 && search.argmode == ARG_NAME)

fs_search(&search, &paths, argc, argv, &res, &sz);

if (sz == 0) {

rc = MANDOCLEVEL_BADARG;

goto out;

}

* For standard man(1) and -a output mode,

* prepare for copying filename pointers

Line 297 main(int argc, char *argv[])

Line 367 main(int argc, char *argv[])

/* Iterate all matching manuals. */

resp = res;

for (i = 0; i < sz; i++) {

if (outmode == OUTMODE_FLN)

puts(res[i].file);

Line 326 main(int argc, char *argv[])

Line 397 main(int argc, char *argv[])

if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)

goto out;

#else

fputs("mandoc: database support not compiled in\n",

stderr);

return((int)MANDOCLEVEL_BADARG);

#endif

}

/* mandoc(1) */

if ( ! moptions(&options, auxpaths))

if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))

return((int)MANDOCLEVEL_BADARG);

if (use_pager && isatty(STDOUT_FILENO))

curp.mchars = mchars_alloc();

spawn_pager();

curp.mp = mparse_alloc(options, curp.wlevel, mmsg,

curp.mchars, defos);

curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);

* Conditionally start up the lookaside buffer before parsing.

if (OUTT_MAN == curp.outtype)

mparse_keep(curp.mp);

if (argc == 0)

if (argc == 0) {

if (use_pager && isatty(STDOUT_FILENO))

spawn_pager();

parse(&curp, STDIN_FILENO, "<stdin>", &rc);

}

while (argc) {

#if HAVE_SQLITE3

rctmp = mparse_open(curp.mp, &fd,

if (resp != NULL) {

resp != NULL ? resp->file : *argv);

if (resp->form)

if (rc < rctmp)

parse(&curp, -1, resp->file, &rc);

rc = rctmp;

else

rc = passthrough(resp->file);

if (fd != -1) {

resp++;

if (use_pager && isatty(STDOUT_FILENO))

} else

spawn_pager();

#endif

use_pager = 0;

parse(&curp, -1, *argv++, &rc);

if (resp == NULL)

parse(&curp, fd, *argv, &rc);

else if (resp->form & FORM_SRC) {

/* For .so only; ignore failure. */

chdir(paths.paths[resp->ipath]);

parse(&curp, fd, resp->file, &rc);

} else {

rctmp = passthrough(resp->file, fd,

synopsis_only);

if (rc < rctmp)

rc = rctmp;

}

rctmp = mparse_wait(curp.mp);

if (rc < rctmp)

rc = rctmp;

if (argc > 1 && curp.outtype <= OUTT_UTF8)

ascii_sepline(curp.outdata);

}

if (MANDOCLEVEL_OK != rc && curp.wstop)

break;

argc--;

if (resp != NULL)

resp++;

else

argv++;

if (--argc)

mparse_reset(curp.mp);

}

if (curp.outfree)

(*curp.outfree)(curp.outdata);

if (curp.mp)

mparse_free(curp.mp);

mchars_free(curp.mchars);

#if HAVE_SQLITE3

out:

if (search.argmode != ARG_FILE) {

manpath_free(&paths);

#if HAVE_SQLITE3

mansearch_free(res, sz);

mansearch_setup(0);

}

#endif

}

free(defos);

Line 400 usage(enum argmode argmode)

Line 496 usage(enum argmode argmode)

switch (argmode) {

case ARG_FILE:

fputs("usage: mandoc [-V] [-Ios=name] [-mformat]"

fputs("usage: mandoc [-acfhklV] [-Ios=name] "

" [-Ooption] [-Toutput] [-Wlevel]\n"

"[-Kencoding] [-mformat] [-Ooption]\n"

"\t [file ...]\n", stderr);

"\t [-Toutput] [-Wlevel] [file ...]\n", stderr);

break;

case ARG_NAME:

fputs("usage: man [-acfhkVw] [-C file] "

fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "

"[-M path] [-m path] [-S arch] [-s section]\n"

"[-K encoding] [-M path] [-m path]\n"

"\t [-O option=value] [-S subsection] [-s section] "

"[-T output] [-W level]\n"

"\t [section] name ...\n", stderr);

break;

case ARG_WORD:

fputs("usage: whatis [-V] [-C file] [-M path] [-m path] "

fputs("usage: whatis [-acfhklVw] [-C file] "

"[-S arch] [-s section] name ...\n", stderr);

"[-M path] [-m path] [-O outkey] [-S arch]\n"

"\t [-s section] name ...\n", stderr);

break;

case ARG_EXPR:

fputs("usage: apropos [-V] [-C file] [-M path] [-m path] "

fputs("usage: apropos [-acfhklVw] [-C file] "

"[-O outkey] [-S arch]\n"

"[-M path] [-m path] [-O outkey] [-S arch]\n"

"\t [-s section] expression ...\n", stderr);

break;

}

exit((int)MANDOCLEVEL_BADARG);

}

static int

fs_lookup(const struct manpaths *paths, size_t ipath,

const char *sec, const char *arch, const char *name,

struct manpage **res, size_t *ressz)

{

struct manpage *page;

char *file;

int form;

mandoc_asprintf(&file, "%s/man%s/%s.%s",

paths->paths[ipath], sec, name, sec);

if (access(file, R_OK) != -1) {

form = FORM_SRC;

goto found;

}

free(file);

mandoc_asprintf(&file, "%s/cat%s/%s.0",

paths->paths[ipath], sec, name);

if (access(file, R_OK) != -1) {

form = FORM_CAT;

goto found;

}

free(file);

if (arch != NULL) {

mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",

paths->paths[ipath], sec, arch, name, sec);

if (access(file, R_OK) != -1) {

form = FORM_SRC;

goto found;

}

free(file);

}

return(0);

found:

#if HAVE_SQLITE3

fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry,\n"

" consider running # makewhatis %s\n",

progname, name, sec, paths->paths[ipath]);

#endif

*res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));

page = *res + (*ressz - 1);

page->file = file;

page->names = NULL;

page->output = NULL;

page->ipath = ipath;

page->bits = NAME_FILE & NAME_MASK;

page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;

page->form = form;

return(1);

}

static void

fs_search(const struct mansearch *cfg, const struct manpaths *paths,

int argc, char **argv, struct manpage **res, size_t *ressz)

{

const char *const sections[] =

{"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};

const size_t nsec = sizeof(sections)/sizeof(sections[0]);

size_t ipath, isec, lastsz;

assert(cfg->argmode == ARG_NAME);

*res = NULL;

*ressz = lastsz = 0;

while (argc) {

for (ipath = 0; ipath < paths->sz; ipath++) {

if (cfg->sec != NULL) {

if (fs_lookup(paths, ipath, cfg->sec,

cfg->arch, *argv, res, ressz) &&

cfg->firstmatch)

return;

} else for (isec = 0; isec < nsec; isec++)

if (fs_lookup(paths, ipath, sections[isec],

cfg->arch, *argv, res, ressz) &&

cfg->firstmatch)

return;

}

if (*ressz == lastsz)

fprintf(stderr,

"%s: No entry for %s in the manual.\n",

progname, *argv);

lastsz = *ressz;

argv++;

argc--;

}

static void

parse(struct curparse *curp, int fd, const char *file,

enum mandoclevel *level)

{

Line 437 parse(struct curparse *curp, int fd, const char *file,

Line 628 parse(struct curparse *curp, int fd, const char *file,

rc = mparse_readfd(curp->mp, fd, file);

/* Stop immediately if the parse has failed. */

if (MANDOCLEVEL_FATAL <= rc)

goto cleanup;

* With -Wstop and warnings or errors of at least the requested

* level, do not produce output.

Line 454 parse(struct curparse *curp, int fd, const char *file,

Line 640 parse(struct curparse *curp, int fd, const char *file,

if ( ! (curp->outman && curp->outmdoc)) {

switch (curp->outtype) {

case OUTT_XHTML:

curp->outdata = xhtml_alloc(curp->outopts);

curp->outfree = html_free;

break;

case OUTT_HTML:

curp->outdata = html_alloc(curp->outopts);

curp->outdata = html_alloc(curp->mchars,

curp->outopts);

curp->outfree = html_free;

break;

case OUTT_UTF8:

curp->outdata = utf8_alloc(curp->outopts);

curp->outdata = utf8_alloc(curp->mchars,

curp->outopts);

curp->outfree = ascii_free;

break;

case OUTT_LOCALE:

curp->outdata = locale_alloc(curp->outopts);

curp->outdata = locale_alloc(curp->mchars,

curp->outopts);

curp->outfree = ascii_free;

break;

case OUTT_ASCII:

curp->outdata = ascii_alloc(curp->outopts);

curp->outdata = ascii_alloc(curp->mchars,

curp->outopts);

curp->outfree = ascii_free;

break;

case OUTT_PDF:

curp->outdata = pdf_alloc(curp->outopts);

curp->outdata = pdf_alloc(curp->mchars,

curp->outopts);

curp->outfree = pspdf_free;

break;

case OUTT_PS:

curp->outdata = ps_alloc(curp->outopts);

curp->outdata = ps_alloc(curp->mchars,

curp->outopts);

curp->outfree = pspdf_free;

break;

default:

Line 488 parse(struct curparse *curp, int fd, const char *file,

Line 676 parse(struct curparse *curp, int fd, const char *file,

switch (curp->outtype) {

case OUTT_HTML:

/* FALLTHROUGH */

case OUTT_XHTML:

curp->outman = html_man;

curp->outmdoc = html_mdoc;

break;

Line 527 parse(struct curparse *curp, int fd, const char *file,

Line 713 parse(struct curparse *curp, int fd, const char *file,

if (mdoc && curp->outmdoc)

(*curp->outmdoc)(curp->outdata, mdoc);

cleanup:

mparse_reset(curp->mp);

if (*level < rc)

*level = rc;

}

static enum mandoclevel

passthrough(const char *file)

passthrough(const char *file, int fd, int synopsis_only)

{

char buf[BUFSIZ];

const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";

const char synr[] = "SYNOPSIS";

FILE *stream;

const char *syscall;

ssize_t nr, nw, off;

char *line;

int fd;

size_t len, off;

ssize_t nw;

int print;

fd = open(file, O_RDONLY);

fflush(stdout);

if (fd == -1) {

syscall = "open";

if ((stream = fdopen(fd, "r")) == NULL) {

close(fd);

syscall = "fdopen";

goto fail;

}

while ((nr = read(fd, buf, BUFSIZ)) != -1 && nr != 0)

print = 0;

for (off = 0; off < nr; off += nw)

while ((line = fgetln(stream, &len)) != NULL) {

if ((nw = write(STDOUT_FILENO, buf + off,

if (synopsis_only) {

(size_t)(nr - off))) == -1 || nw == 0) {

if (print) {

if ( ! isspace((unsigned char)*line))

goto done;

while (len &&

isspace((unsigned char)*line)) {

line++;

len--;

}

} else {

if ((len == sizeof(synb) &&

! strncmp(line, synb, len - 1)) ||

(len == sizeof(synr) &&

! strncmp(line, synr, len - 1)))

print = 1;

continue;

}

for (off = 0; off < len; off += nw)

if ((nw = write(STDOUT_FILENO, line + off,

len - off)) == -1 || nw == 0) {

fclose(stream);

syscall = "write";

goto fail;

}

if (nr == 0) {

if (ferror(stream)) {

close(fd);

fclose(stream);

return(MANDOCLEVEL_OK);

syscall = "fgetln";

}

goto fail;

}

syscall = "read";

done:

fclose(stream);

return(MANDOCLEVEL_OK);

fail:

fprintf(stderr, "%s: %s: SYSERR: %s: %s",

progname, file, syscall, strerror(errno));

Line 570 fail:

Line 785 fail:

}

static int

koptions(int *options, char *arg)

{

if ( ! strcmp(arg, "utf-8")) {

*options |= MPARSE_UTF8;

*options &= ~MPARSE_LATIN1;

} else if ( ! strcmp(arg, "iso-8859-1")) {

*options |= MPARSE_LATIN1;

*options &= ~MPARSE_UTF8;

} else if ( ! strcmp(arg, "us-ascii")) {

*options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);

} else {

fprintf(stderr, "%s: -K %s: Bad argument\n",

progname, arg);

return(0);

}

return(1);

}

static int

moptions(int *options, char *arg)

{

Line 582 moptions(int *options, char *arg)

Line 817 moptions(int *options, char *arg)

else if (0 == strcmp(arg, "an"))

*options |= MPARSE_MAN;

else {

fprintf(stderr, "%s: -m%s: Bad argument\n",

fprintf(stderr, "%s: -m %s: Bad argument\n",

progname, arg);

return(0);

}

Line 610 toptions(struct curparse *curp, char *arg)

Line 845 toptions(struct curparse *curp, char *arg)

else if (0 == strcmp(arg, "locale"))

curp->outtype = OUTT_LOCALE;

else if (0 == strcmp(arg, "xhtml"))

curp->outtype = OUTT_XHTML;

curp->outtype = OUTT_HTML;

else if (0 == strcmp(arg, "ps"))

curp->outtype = OUTT_PS;

else if (0 == strcmp(arg, "pdf"))

curp->outtype = OUTT_PDF;

else {

fprintf(stderr, "%s: -T%s: Bad argument\n",

fprintf(stderr, "%s: -T %s: Bad argument\n",

progname, arg);

return(0);

}

Line 628 static int

Line 863 static int

woptions(struct curparse *curp, char *arg)

{

char *v, *o;

const char *toks[6];

const char *toks[7];

toks[0] = "stop";

toks[1] = "all";

toks[2] = "warning";

toks[3] = "error";

toks[4] = "fatal";

toks[4] = "unsupp";

toks[5] = NULL;

toks[5] = "fatal";

toks[6] = NULL;

while (*arg) {

o = arg;

Line 652 woptions(struct curparse *curp, char *arg)

Line 888 woptions(struct curparse *curp, char *arg)

curp->wlevel = MANDOCLEVEL_ERROR;

break;

case 4:

curp->wlevel = MANDOCLEVEL_FATAL;

curp->wlevel = MANDOCLEVEL_UNSUPP;

break;

case 5:

curp->wlevel = MANDOCLEVEL_BADARG;

break;

default:

fprintf(stderr, "%s: -W%s: Bad argument\n",

fprintf(stderr, "%s: -W %s: Bad argument\n",

progname, o);

return(0);

}

CVSweb