version 1.156, 2011/03/20 16:05:21 |
version 1.179, 2014/08/16 23:04:25 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2011, 2012, 2014 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 |
|
|
* 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/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <stdint.h> |
#include <stdint.h> |
|
|
#include <unistd.h> |
#include <unistd.h> |
|
|
#include "mandoc.h" |
#include "mandoc.h" |
|
#include "mandoc_aux.h" |
#include "main.h" |
#include "main.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "roff.h" |
|
|
|
#if !defined(__GNUC__) || (__GNUC__ < 2) |
#if !defined(__GNUC__) || (__GNUC__ < 2) |
# if !defined(lint) |
# if !defined(lint) |
Line 44 typedef void (*out_free)(void *); |
|
Line 45 typedef void (*out_free)(void *); |
|
|
|
enum outt { |
enum outt { |
OUTT_ASCII = 0, /* -Tascii */ |
OUTT_ASCII = 0, /* -Tascii */ |
|
OUTT_LOCALE, /* -Tlocale */ |
|
OUTT_UTF8, /* -Tutf8 */ |
OUTT_TREE, /* -Ttree */ |
OUTT_TREE, /* -Ttree */ |
|
OUTT_MAN, /* -Tman */ |
OUTT_HTML, /* -Thtml */ |
OUTT_HTML, /* -Thtml */ |
OUTT_XHTML, /* -Txhtml */ |
OUTT_XHTML, /* -Txhtml */ |
OUTT_LINT, /* -Tlint */ |
OUTT_LINT, /* -Tlint */ |
Line 56 struct curparse { |
|
Line 60 struct curparse { |
|
struct mparse *mp; |
struct mparse *mp; |
enum mandoclevel wlevel; /* ignore messages below this */ |
enum mandoclevel wlevel; /* ignore messages below this */ |
int wstop; /* stop after a file with a warning */ |
int wstop; /* stop after a file with a warning */ |
enum outt outtype; /* which output to use */ |
enum outt outtype; /* which output to use */ |
out_mdoc outmdoc; /* mdoc output ptr */ |
out_mdoc outmdoc; /* mdoc output ptr */ |
out_man outman; /* man output ptr */ |
out_man outman; /* man output ptr */ |
out_free outfree; /* free 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 */ |
char outopts[BUFSIZ]; /* buf of output opts */ |
}; |
}; |
|
|
static const char * const mandoclevels[MANDOCLEVEL_MAX] = { |
#if HAVE_SQLITE3 |
"SUCCESS", |
int apropos(int, char**); |
"RESERVED", |
#endif |
"WARNING", |
|
"ERROR", |
|
"FATAL", |
|
"BADARG", |
|
"SYSERR" |
|
}; |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
static int moptions(int *, char *); |
"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", |
|
}; |
|
|
|
static int moptions(enum mparset *, char *); |
|
static void mmsg(enum mandocerr, enum mandoclevel, |
static void mmsg(enum mandocerr, enum mandoclevel, |
const char *, int, int, const char *); |
const char *, int, int, const char *); |
static void parse(struct curparse *, int, |
static void parse(struct curparse *, int, |
const char *, enum mandoclevel *); |
const char *, enum mandoclevel *); |
static int toptions(struct curparse *, char *); |
static int toptions(struct curparse *, char *); |
static void usage(void) __attribute__((noreturn)); |
static void usage(void) __attribute__((noreturn)); |
Line 193 static int woptions(struct curparse *, char *); |
|
Line 84 static int woptions(struct curparse *, char *); |
|
|
|
static const char *progname; |
static const char *progname; |
|
|
|
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
int c; |
int c; |
struct curparse curp; |
struct curparse curp; |
enum mparset type; |
int options; |
enum mandoclevel rc; |
enum mandoclevel rc; |
|
char *defos; |
|
|
progname = strrchr(argv[0], '/'); |
progname = strrchr(argv[0], '/'); |
if (progname == NULL) |
if (progname == NULL) |
Line 207 main(int argc, char *argv[]) |
|
Line 100 main(int argc, char *argv[]) |
|
else |
else |
++progname; |
++progname; |
|
|
|
#if HAVE_SQLITE3 |
|
if (0 == strncmp(progname, "apropos", 7) || |
|
0 == strncmp(progname, "whatis", 6)) |
|
return(apropos(argc, argv)); |
|
#endif |
|
|
memset(&curp, 0, sizeof(struct curparse)); |
memset(&curp, 0, sizeof(struct curparse)); |
|
|
type = MPARSE_AUTO; |
options = MPARSE_SO; |
curp.outtype = OUTT_ASCII; |
curp.outtype = OUTT_ASCII; |
curp.wlevel = MANDOCLEVEL_FATAL; |
curp.wlevel = MANDOCLEVEL_FATAL; |
|
defos = NULL; |
|
|
/* LINTED */ |
while (-1 != (c = getopt(argc, argv, "I:m:O:T:VW:"))) |
while (-1 != (c = getopt(argc, argv, "m:O:T:VW:"))) |
|
switch (c) { |
switch (c) { |
case ('m'): |
case 'I': |
if ( ! moptions(&type, optarg)) |
if (strncmp(optarg, "os=", 3)) { |
|
fprintf(stderr, |
|
"%s: -I%s: Bad argument\n", |
|
progname, optarg); |
return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
|
} |
|
if (defos) { |
|
fprintf(stderr, |
|
"%s: -I%s: Duplicate argument\n", |
|
progname, optarg); |
|
return((int)MANDOCLEVEL_BADARG); |
|
} |
|
defos = mandoc_strdup(optarg + 3); |
break; |
break; |
case ('O'): |
case 'm': |
|
if ( ! moptions(&options, optarg)) |
|
return((int)MANDOCLEVEL_BADARG); |
|
break; |
|
case 'O': |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
(void)strlcat(curp.outopts, ",", BUFSIZ); |
(void)strlcat(curp.outopts, ",", BUFSIZ); |
break; |
break; |
case ('T'): |
case 'T': |
if ( ! toptions(&curp, optarg)) |
if ( ! toptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
case ('W'): |
case 'W': |
if ( ! woptions(&curp, optarg)) |
if ( ! woptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
case ('V'): |
case 'V': |
version(); |
version(); |
/* NOTREACHED */ |
/* NOTREACHED */ |
default: |
default: |
Line 240 main(int argc, char *argv[]) |
|
Line 154 main(int argc, char *argv[]) |
|
/* NOTREACHED */ |
/* NOTREACHED */ |
} |
} |
|
|
curp.mp = mparse_alloc(type, curp.wlevel, mmsg, &curp); |
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); |
|
|
argc -= optind; |
argc -= optind; |
argv += optind; |
argv += optind; |
|
|
Line 261 main(int argc, char *argv[]) |
|
Line 181 main(int argc, char *argv[]) |
|
(*curp.outfree)(curp.outdata); |
(*curp.outfree)(curp.outdata); |
if (curp.mp) |
if (curp.mp) |
mparse_free(curp.mp); |
mparse_free(curp.mp); |
|
free(defos); |
|
|
return((int)rc); |
return((int)rc); |
} |
} |
|
|
|
|
fprintf(stderr, "usage: %s " |
fprintf(stderr, "usage: %s " |
"[-V] " |
"[-V] " |
"[-foption] " |
"[-Ios=name] " |
"[-mformat] " |
"[-mformat] " |
"[-Ooption] " |
"[-Ooption] " |
"[-Toutput] " |
"[-Toutput] " |
"[-Werr] " |
"[-Wlevel]\n" |
"[file...]\n", |
"\t [file ...]\n", |
progname); |
progname); |
|
|
exit((int)MANDOCLEVEL_BADARG); |
exit((int)MANDOCLEVEL_BADARG); |
} |
} |
|
|
static void |
static void |
parse(struct curparse *curp, int fd, |
parse(struct curparse *curp, int fd, const char *file, |
const char *file, enum mandoclevel *level) |
enum mandoclevel *level) |
{ |
{ |
enum mandoclevel rc; |
enum mandoclevel rc; |
struct mdoc *mdoc; |
struct mdoc *mdoc; |
Line 322 parse(struct curparse *curp, int fd, |
|
Line 243 parse(struct curparse *curp, int fd, |
|
|
|
if ( ! (curp->outman && curp->outmdoc)) { |
if ( ! (curp->outman && curp->outmdoc)) { |
switch (curp->outtype) { |
switch (curp->outtype) { |
case (OUTT_XHTML): |
case OUTT_XHTML: |
curp->outdata = xhtml_alloc(curp->outopts); |
curp->outdata = xhtml_alloc(curp->outopts); |
|
curp->outfree = html_free; |
break; |
break; |
case (OUTT_HTML): |
case OUTT_HTML: |
curp->outdata = html_alloc(curp->outopts); |
curp->outdata = html_alloc(curp->outopts); |
|
curp->outfree = html_free; |
break; |
break; |
case (OUTT_ASCII): |
case OUTT_UTF8: |
|
curp->outdata = utf8_alloc(curp->outopts); |
|
curp->outfree = ascii_free; |
|
break; |
|
case OUTT_LOCALE: |
|
curp->outdata = locale_alloc(curp->outopts); |
|
curp->outfree = ascii_free; |
|
break; |
|
case OUTT_ASCII: |
curp->outdata = ascii_alloc(curp->outopts); |
curp->outdata = ascii_alloc(curp->outopts); |
curp->outfree = ascii_free; |
curp->outfree = ascii_free; |
break; |
break; |
case (OUTT_PDF): |
case OUTT_PDF: |
curp->outdata = pdf_alloc(curp->outopts); |
curp->outdata = pdf_alloc(curp->outopts); |
curp->outfree = pspdf_free; |
curp->outfree = pspdf_free; |
break; |
break; |
case (OUTT_PS): |
case OUTT_PS: |
curp->outdata = ps_alloc(curp->outopts); |
curp->outdata = ps_alloc(curp->outopts); |
curp->outfree = pspdf_free; |
curp->outfree = pspdf_free; |
break; |
break; |
Line 345 parse(struct curparse *curp, int fd, |
|
Line 276 parse(struct curparse *curp, int fd, |
|
} |
} |
|
|
switch (curp->outtype) { |
switch (curp->outtype) { |
case (OUTT_HTML): |
case OUTT_HTML: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (OUTT_XHTML): |
case OUTT_XHTML: |
curp->outman = html_man; |
curp->outman = html_man; |
curp->outmdoc = html_mdoc; |
curp->outmdoc = html_mdoc; |
curp->outfree = html_free; |
|
break; |
break; |
case (OUTT_TREE): |
case OUTT_TREE: |
curp->outman = tree_man; |
curp->outman = tree_man; |
curp->outmdoc = tree_mdoc; |
curp->outmdoc = tree_mdoc; |
break; |
break; |
case (OUTT_PDF): |
case OUTT_MAN: |
|
curp->outmdoc = man_mdoc; |
|
curp->outman = man_man; |
|
break; |
|
case OUTT_PDF: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (OUTT_ASCII): |
case OUTT_ASCII: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (OUTT_PS): |
case OUTT_UTF8: |
|
/* FALLTHROUGH */ |
|
case OUTT_LOCALE: |
|
/* FALLTHROUGH */ |
|
case OUTT_PS: |
curp->outman = terminal_man; |
curp->outman = terminal_man; |
curp->outmdoc = terminal_mdoc; |
curp->outmdoc = terminal_mdoc; |
break; |
break; |
Line 369 parse(struct curparse *curp, int fd, |
|
Line 307 parse(struct curparse *curp, int fd, |
|
} |
} |
} |
} |
|
|
mparse_result(curp->mp, &mdoc, &man); |
mparse_result(curp->mp, &mdoc, &man, NULL); |
|
|
/* Execute the out device, if it exists. */ |
/* Execute the out device, if it exists. */ |
|
|
Line 387 parse(struct curparse *curp, int fd, |
|
Line 325 parse(struct curparse *curp, int fd, |
|
} |
} |
|
|
static int |
static int |
moptions(enum mparset *tflags, char *arg) |
moptions(int *options, char *arg) |
{ |
{ |
|
|
if (0 == strcmp(arg, "doc")) |
if (0 == strcmp(arg, "doc")) |
*tflags = MPARSE_MDOC; |
*options |= MPARSE_MDOC; |
else if (0 == strcmp(arg, "andoc")) |
else if (0 == strcmp(arg, "andoc")) |
*tflags = MPARSE_AUTO; |
/* nothing to do */; |
else if (0 == strcmp(arg, "an")) |
else if (0 == strcmp(arg, "an")) |
*tflags = MPARSE_MAN; |
*options |= MPARSE_MAN; |
else { |
else { |
fprintf(stderr, "%s: Bad argument\n", arg); |
fprintf(stderr, "%s: -m%s: Bad argument\n", |
|
progname, arg); |
return(0); |
return(0); |
} |
} |
|
|
Line 415 toptions(struct curparse *curp, char *arg) |
|
Line 354 toptions(struct curparse *curp, char *arg) |
|
curp->wlevel = MANDOCLEVEL_WARNING; |
curp->wlevel = MANDOCLEVEL_WARNING; |
} else if (0 == strcmp(arg, "tree")) |
} else if (0 == strcmp(arg, "tree")) |
curp->outtype = OUTT_TREE; |
curp->outtype = OUTT_TREE; |
|
else if (0 == strcmp(arg, "man")) |
|
curp->outtype = OUTT_MAN; |
else if (0 == strcmp(arg, "html")) |
else if (0 == strcmp(arg, "html")) |
curp->outtype = OUTT_HTML; |
curp->outtype = OUTT_HTML; |
|
else if (0 == strcmp(arg, "utf8")) |
|
curp->outtype = OUTT_UTF8; |
|
else if (0 == strcmp(arg, "locale")) |
|
curp->outtype = OUTT_LOCALE; |
else if (0 == strcmp(arg, "xhtml")) |
else if (0 == strcmp(arg, "xhtml")) |
curp->outtype = OUTT_XHTML; |
curp->outtype = OUTT_XHTML; |
else if (0 == strcmp(arg, "ps")) |
else if (0 == strcmp(arg, "ps")) |
Line 424 toptions(struct curparse *curp, char *arg) |
|
Line 369 toptions(struct curparse *curp, char *arg) |
|
else if (0 == strcmp(arg, "pdf")) |
else if (0 == strcmp(arg, "pdf")) |
curp->outtype = OUTT_PDF; |
curp->outtype = OUTT_PDF; |
else { |
else { |
fprintf(stderr, "%s: Bad argument\n", arg); |
fprintf(stderr, "%s: -T%s: Bad argument\n", |
|
progname, arg); |
return(0); |
return(0); |
} |
} |
|
|
|
|
woptions(struct curparse *curp, char *arg) |
woptions(struct curparse *curp, char *arg) |
{ |
{ |
char *v, *o; |
char *v, *o; |
const char *toks[6]; |
const char *toks[6]; |
|
|
toks[0] = "stop"; |
toks[0] = "stop"; |
toks[1] = "all"; |
toks[1] = "all"; |
Line 447 woptions(struct curparse *curp, char *arg) |
|
Line 393 woptions(struct curparse *curp, char *arg) |
|
while (*arg) { |
while (*arg) { |
o = arg; |
o = arg; |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
case (0): |
case 0: |
curp->wstop = 1; |
curp->wstop = 1; |
break; |
break; |
case (1): |
case 1: |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (2): |
case 2: |
curp->wlevel = MANDOCLEVEL_WARNING; |
curp->wlevel = MANDOCLEVEL_WARNING; |
break; |
break; |
case (3): |
case 3: |
curp->wlevel = MANDOCLEVEL_ERROR; |
curp->wlevel = MANDOCLEVEL_ERROR; |
break; |
break; |
case (4): |
case 4: |
curp->wlevel = MANDOCLEVEL_FATAL; |
curp->wlevel = MANDOCLEVEL_FATAL; |
break; |
break; |
default: |
default: |
fprintf(stderr, "-W%s: Bad argument\n", o); |
fprintf(stderr, "%s: -W%s: Bad argument\n", |
|
progname, o); |
return(0); |
return(0); |
} |
} |
} |
} |
Line 471 woptions(struct curparse *curp, char *arg) |
|
Line 418 woptions(struct curparse *curp, char *arg) |
|
} |
} |
|
|
static void |
static void |
mmsg(enum mandocerr t, enum mandoclevel lvl, |
mmsg(enum mandocerr t, enum mandoclevel lvl, |
const char *file, int line, int col, const char *msg) |
const char *file, int line, int col, const char *msg) |
{ |
{ |
|
const char *mparse_msg; |
|
|
fprintf(stderr, "%s:%d:%d: %s: %s", |
fprintf(stderr, "%s: %s:", progname, file); |
file, line, col + 1, |
|
mandoclevels[lvl], mandocerrs[t]); |
if (line) |
|
fprintf(stderr, "%d:%d:", line, col + 1); |
|
|
|
fprintf(stderr, " %s", mparse_strlevel(lvl)); |
|
|
|
if (NULL != (mparse_msg = mparse_strerror(t))) |
|
fprintf(stderr, ": %s", mparse_msg); |
|
|
if (msg) |
if (msg) |
fprintf(stderr, ": %s", msg); |
fprintf(stderr, ": %s", msg); |