mandoc/main.c - diff

Return to main.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/main.c between version 1.227 and 1.248

version 1.227, 2015/03/17 13:35:52

version 1.248, 2015/10/12 00:08:15

Line 8

* 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

Line 24

#include <assert.h>

#include <ctype.h>

#include <errno.h>

#include <err.h>

#include <fcntl.h>

#include <glob.h>

#include <signal.h>

Line 34

#include <string.h>

#include <unistd.h>

#include "mandoc.h"

#include "mandoc_aux.h"

#include "main.h"

#include "mandoc.h"

#include "roff.h"

#include "mdoc.h"

#include "man.h"

#include "manpath.h"

#include "tag.h"

#include "main.h"

#include "manconf.h"

#include "mansearch.h"

#if !defined(__GNUC__) || (__GNUC__ < 2)

Line 57 enum outmode {

Line 59 enum outmode {

OUTMODE_ONE

};

typedef void (*out_mdoc)(void *, const struct mdoc *);

typedef void (*out_mdoc)(void *, const struct roff_man *);

typedef void (*out_man)(void *, const struct man *);

typedef void (*out_man)(void *, const struct roff_man *);

typedef void (*out_free)(void *);

enum outt {

Line 83 struct curparse {

Line 85 struct curparse {

out_man outman; /* man output ptr */

out_free outfree; /* free output ptr */

void *outdata; /* data for output */

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

struct manoutput *outopts; /* output options */

};

static int fs_lookup(const struct manpaths *,

Line 93 static int fs_lookup(const struct manpaths *,

Line 95 static int fs_lookup(const struct manpaths *,

static void fs_search(const struct mansearch *,

const struct manpaths *, int, char**,

struct manpage **, size_t *);

static void handle_sigpipe(int);

static int koptions(int *, char *);

#if HAVE_SQLITE3

int mandocdb(int, char**);

Line 103 static void mmsg(enum mandocerr, enum mandoclevel,

Line 104 static void mmsg(enum mandocerr, enum mandoclevel,

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

static void parse(struct curparse *, int, const char *);

static void passthrough(const char *, int, int);

static pid_t spawn_pager(void);

static pid_t spawn_pager(struct tag_files *);

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

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

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

extern char *__progname;

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;

static enum mandoclevel rc;

int

main(int argc, char *argv[])

{

struct manconf conf;

struct curparse curp;

struct mansearch search;

struct manpaths paths;

struct tag_files *tag_files;

char *auxpaths;

char *defos;

unsigned char *uc;

struct manpage *res, *resp;

char *conf_file, *defpaths;

size_t isec, i, sz;

int prio, best_prio, synopsis_only;

int prio, best_prio;

char sec;

enum mandoclevel rctmp;

enum outmode outmode;

int fd;

int show_usage;

int options;

int use_pager;

int c;

pid_t pager_pid; /* 0: don't use; 1: not yet spawned. */

#if !HAVE_PROGNAME

if (argc < 1)

progname = "mandoc";

__progname = mandoc_strdup("mandoc");

else if ((progname = strrchr(argv[0], '/')) == NULL)

else if ((__progname = strrchr(argv[0], '/')) == NULL)

progname = argv[0];

__progname = argv[0];

else

++progname;

++__progname;

#endif

#if HAVE_SQLITE3

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

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

return(mandocdb(argc, argv));

return mandocdb(argc, argv);

#endif

/* Search options. */

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

memset(&conf, 0, sizeof(conf));

conf_file = defpaths = NULL;

auxpaths = NULL;

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

search.outkey = "Nd";

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

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

search.argmode = ARG_NAME;

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

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

search.argmode = ARG_EXPR;

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

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

search.argmode = ARG_WORD;

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

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

search.argmode = ARG_NAME;

else

search.argmode = ARG_FILE;

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

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

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

curp.outtype = OUTT_LOCALE;

curp.wlevel = MANDOCLEVEL_BADARG;

curp.outopts = &conf.output;

options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;

defos = NULL;

pager_pid = 1;

use_pager = 1;

tag_files = NULL;

show_usage = 0;

synopsis_only = 0;

outmode = OUTMODE_DEF;

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

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

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

conf_file = optarg;

break;

case 'c':

pager_pid = 0;

use_pager = 0;

break;

case 'f':

search.argmode = ARG_WORD;

break;

case 'h':

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

conf.output.synopsisonly = 1;

synopsis_only = 1;

use_pager = 0;

pager_pid = 0;

outmode = OUTMODE_ALL;

break;

case 'I':

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

fprintf(stderr,

warnx("-I %s: Bad argument", optarg);

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

return (int)MANDOCLEVEL_BADARG;

progname, optarg);

return((int)MANDOCLEVEL_BADARG);

}

if (defos) {

fprintf(stderr,

warnx("-I %s: Duplicate argument", optarg);

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

return (int)MANDOCLEVEL_BADARG;

progname, optarg);

return((int)MANDOCLEVEL_BADARG);

}

defos = mandoc_strdup(optarg + 3);

break;

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

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

break;

case 'K':

if ( ! koptions(&options, optarg))

return((int)MANDOCLEVEL_BADARG);

return (int)MANDOCLEVEL_BADARG;

break;

case 'k':

search.argmode = ARG_EXPR;

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

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

break;

case 'O':

search.outkey = optarg;

(void)strlcat(curp.outopts, optarg, BUFSIZ);

while (optarg != NULL)

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

manconf_output(&conf.output,

strsep(&optarg, ","));

break;

case 'S':

search.arch = optarg;

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

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

break;

case 'T':

if ( ! toptions(&curp, optarg))

return((int)MANDOCLEVEL_BADARG);

return (int)MANDOCLEVEL_BADARG;

break;

case 'W':

if ( ! woptions(&curp, optarg))

return((int)MANDOCLEVEL_BADARG);

return (int)MANDOCLEVEL_BADARG;

break;

case 'w':

outmode = OUTMODE_FLN;

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

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

switch (search.argmode) {

case ARG_FILE:

outmode = OUTMODE_ALL;

pager_pid = 0;

use_pager = 0;

break;

case ARG_NAME:

outmode = OUTMODE_ONE;

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

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

}

if (outmode == OUTMODE_FLN ||

outmode == OUTMODE_LST ||

!isatty(STDOUT_FILENO))

use_pager = 0;

/* Parse arguments. */

if (argc > 0) {

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

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

if (search.argmode == ARG_NAME) {

if (*progname == 'h') {

if (*__progname == 'h') {

if (argc == 0) {

argv = help_argv;

argc = 1;

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

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

/* Access the mandoc database. */

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

manconf_parse(&conf, conf_file, defpaths, auxpaths);

#if HAVE_SQLITE3

mansearch_setup(1);

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

if ( ! mansearch(&search, &conf.manpath,

argc, argv, &res, &sz))

usage(search.argmode);

#else

if (search.argmode != ARG_NAME) {

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

stderr);

return((int)MANDOCLEVEL_BADARG);

return (int)MANDOCLEVEL_BADARG;

}

sz = 0;

#endif

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

if (sz == 0) {

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

if (search.argmode == ARG_NAME)

fs_search(&search, &conf.manpath,

argc, argv, &res, &sz);

else

warnx("nothing appropriate");

}

if (sz == 0) {

rc = MANDOCLEVEL_BADARG;

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

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

/* mandoc(1) */

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

return((int)MANDOCLEVEL_BADARG);

return (int)MANDOCLEVEL_BADARG;

curp.mchars = mchars_alloc();

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

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

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

mparse_keep(curp.mp);

if (argc < 1) {

if (pager_pid == 1 && isatty(STDOUT_FILENO))

if (use_pager)

pager_pid = spawn_pager();

tag_files = tag_init();

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

}

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

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

rc = rctmp;

if (fd != -1) {

if (pager_pid == 1 && isatty(STDOUT_FILENO))

if (use_pager) {

pager_pid = spawn_pager();

tag_files = tag_init();

use_pager = 0;

}

if (resp == NULL)

parse(&curp, fd, *argv);

else if (resp->form & FORM_SRC) {

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

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

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

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

} else

passthrough(resp->file, fd, synopsis_only);

passthrough(resp->file, fd,

conf.output.synopsisonly);

rctmp = mparse_wait(curp.mp);

if (rc < rctmp)

rc = rctmp;

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

ascii_sepline(curp.outdata);

}

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

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

out:

if (search.argmode != ARG_FILE) {

manpath_free(&paths);

manconf_free(&conf);

#if HAVE_SQLITE3

mansearch_free(res, sz);

mansearch_setup(0);

Line 480 out:

Line 492 out:

free(defos);

* If a pager is attached, flush the pipe leading to it

* When using a pager, finish writing both temporary files,

* and signal end of file such that the user can browse

* fork it, wait for the user to close it, and clean up.

* to the end. Then wait for the user to close the pager.

if (pager_pid != 0 && pager_pid != 1) {

if (tag_files != NULL) {

fclose(stdout);

waitpid(pager_pid, NULL, 0);

tag_write();

waitpid(spawn_pager(tag_files), NULL, 0);

tag_unlink();

}

return((int)rc);

return (int)rc;

}

static void

Line 499 usage(enum argmode argmode)

Line 512 usage(enum argmode argmode)

switch (argmode) {

case ARG_FILE:

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

fputs("usage: mandoc [-acfhkl] [-I os=name] "

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

"[-K encoding] [-mformat] [-O option]\n"

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

"\t [-T output] [-W level] [file ...]\n", stderr);

break;

case ARG_NAME:

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

Line 557 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 570 fs_lookup(const struct manpaths *paths, size_t ipath,

free(file);

}

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

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)

fprintf(stderr, "%s: %s: glob: %s\n",

warn("%s: glob", file);

progname, file, strerror(errno));

free(file);

if (globres == 0)

file = mandoc_strdup(*globinfo.gl_pathv);

globfree(&globinfo);

if (globres != 0)

return(0);

return 0;

found:

#if HAVE_SQLITE3

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

warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s\n",

" consider running # makewhatis %s\n",

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

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

#endif

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

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

page->file = file;

Line 586 found:

Line 596 found:

page->bits = NAME_FILE & NAME_MASK;

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

page->form = form;

return(1);

return 1;

}

static void

Line 617 fs_search(const struct mansearch *cfg, const struct ma

Line 627 fs_search(const struct mansearch *cfg, const struct ma

return;

}

if (*ressz == lastsz)

fprintf(stderr,

warnx("No entry for %s in the manual.", *argv);

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

progname, *argv);

lastsz = *ressz;

argv++;

argc--;

Line 630 static void

Line 638 static void

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

{

enum mandoclevel rctmp;

struct mdoc *mdoc;

struct roff_man *man;

struct man *man;

/* Begin by parsing the file itself. */

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

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

curp->outman = man_man;

break;

case OUTT_PDF:

/* FALLTHROUGH */

case OUTT_ASCII:

/* FALLTHROUGH */

case OUTT_UTF8:

/* FALLTHROUGH */

case OUTT_LOCALE:

/* FALLTHROUGH */

case OUTT_PS:

curp->outman = terminal_man;

curp->outmdoc = terminal_mdoc;

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

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

}

mparse_result(curp->mp, &mdoc, &man, NULL);

mparse_result(curp->mp, &man, NULL);

/* Execute the out device, if it exists. */

if (man && curp->outman)

if (man == NULL)

return;

if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)

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

if (curp->outman != NULL && man->macroset == MACROSET_MAN)

(*curp->outman)(curp->outdata, man);

if (mdoc && curp->outmdoc)

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

}

static void

Line 789 done:

Line 794 done:

return;

fail:

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

warn("%s: SYSERR: %s", file, syscall);

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

if (rc < MANDOCLEVEL_SYSERR)

rc = MANDOCLEVEL_SYSERR;

}

Line 808 koptions(int *options, char *arg)

Line 812 koptions(int *options, char *arg)

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

*options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);

} else {

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

warnx("-K %s: Bad argument", arg);

progname, arg);

return 0;

return(0);

}

return(1);

return 1;

}

static int

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

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

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

*options |= MPARSE_MAN;

else {

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

warnx("-m %s: Bad argument", arg);

progname, arg);

return 0;

return(0);

}

return(1);

return 1;

}

static int

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

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

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

curp->outtype = OUTT_PDF;

else {

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

warnx("-T %s: Bad argument", arg);

progname, arg);

return 0;

return(0);

}

return(1);

return 1;

}

static int

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

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

curp->wstop = 1;

break;

case 1:

/* FALLTHROUGH */

case 2:

curp->wlevel = MANDOCLEVEL_WARNING;

break;

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

curp->wlevel = MANDOCLEVEL_BADARG;

break;

default:

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

warnx("-W %s: Bad argument", o);

progname, o);

return 0;

return(0);

}

return(1);

return 1;

}

static void

Line 920 mmsg(enum mandocerr t, enum mandoclevel lvl,

Line 919 mmsg(enum mandocerr t, enum mandoclevel lvl,

{

const char *mparse_msg;

fprintf(stderr, "%s: %s:", progname, file);

fprintf(stderr, "%s: %s:", __progname, file);

if (line)

fprintf(stderr, "%d:%d:", line, col + 1);

Line 936 mmsg(enum mandocerr t, enum mandoclevel lvl,

Line 935 mmsg(enum mandocerr t, enum mandoclevel lvl,

fputc('\n', stderr);

}

static void

handle_sigpipe(int signum)

{

exit((int)rc);

}

static pid_t

spawn_pager(void)

spawn_pager(struct tag_files *tag_files)

{

#define MAX_PAGER_ARGS 16

char *argv[MAX_PAGER_ARGS];

const char *pager;

char *cp;

int fildes[2];

size_t cmdlen;

int argc;

pid_t pager_pid;

if (pipe(fildes) == -1) {

fprintf(stderr, "%s: pipe: %s\n",

progname, strerror(errno));

return(0);

}

switch (pager_pid = fork()) {

case -1:

fprintf(stderr, "%s: fork: %s\n",

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

case 0:

break;

default:

close(fildes[0]);

if (dup2(fildes[1], STDOUT_FILENO) == -1) {

fprintf(stderr, "%s: dup output: %s\n",

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

close(fildes[1]);

signal(SIGPIPE, handle_sigpipe);

return(pager_pid);

}

/* The child process becomes the pager. */

close(fildes[1]);

if (dup2(fildes[0], STDIN_FILENO) == -1) {

fprintf(stderr, "%s: dup input: %s\n",

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

close(fildes[0]);

pager = getenv("MANPAGER");

if (pager == NULL || *pager == '\0')

pager = getenv("PAGER");

if (pager == NULL || *pager == '\0')

pager = "/usr/bin/more -s";

pager = "more -s";

cp = mandoc_strdup(pager);

Line 1002 spawn_pager(void)

Line 959 spawn_pager(void)

argc = 0;

while (argc + 1 < MAX_PAGER_ARGS) {

while (argc + 4 < MAX_PAGER_ARGS) {

argv[argc++] = cp;

cp = strchr(cp, ' ');

if (cp == NULL)

Line 1013 spawn_pager(void)

Line 970 spawn_pager(void)

if (*cp == '\0')

break;

}

/* For more(1) and less(1), use the tag file. */

if ((cmdlen = strlen(argv[0])) >= 4) {

cp = argv[0] + cmdlen - 4;

if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {

argv[argc++] = mandoc_strdup("-T");

argv[argc++] = tag_files->tfn;

}

argv[argc++] = tag_files->ofn;

argv[argc] = NULL;

/* Hand over to the pager. */

switch (pager_pid = fork()) {

case -1:

err((int)MANDOCLEVEL_SYSERR, "fork");

case 0:

break;

default:

return pager_pid;

}

/* The child process becomes the pager. */

if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)

err((int)MANDOCLEVEL_SYSERR, "pager stdout");

close(tag_files->ofd);

close(tag_files->tfd);

execvp(argv[0], argv);

fprintf(stderr, "%s: exec: %s\n",

err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

CVSweb