version 1.72, 2010/05/15 18:43:59 |
version 1.91, 2010/06/26 15:36:37 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
* |
* |
* 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 |
|
|
#include <unistd.h> |
#include <unistd.h> |
|
|
#include "mandoc.h" |
#include "mandoc.h" |
|
#include "regs.h" |
|
#include "main.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "roff.h" |
#include "roff.h" |
#include "main.h" |
|
|
|
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
|
|
|
|
OUTT_TREE, |
OUTT_TREE, |
OUTT_HTML, |
OUTT_HTML, |
OUTT_XHTML, |
OUTT_XHTML, |
OUTT_LINT |
OUTT_LINT, |
|
OUTT_PS |
}; |
}; |
|
|
struct curparse { |
struct curparse { |
Line 81 struct curparse { |
|
Line 83 struct curparse { |
|
#define FL_NIGN_MACRO (1 << 2) /* Don't ignore bad macros. */ |
#define FL_NIGN_MACRO (1 << 2) /* Don't ignore bad macros. */ |
#define FL_IGN_ERRORS (1 << 4) /* Ignore failed parse. */ |
#define FL_IGN_ERRORS (1 << 4) /* Ignore failed parse. */ |
#define FL_STRICT FL_NIGN_ESCAPE | \ |
#define FL_STRICT FL_NIGN_ESCAPE | \ |
FL_NIGN_MACRO |
FL_NIGN_MACRO /* ignore nothing */ |
enum intt inttype; /* Input parsers... */ |
enum intt inttype; /* which parser to use */ |
struct man *man; |
struct man *man; /* man parser */ |
struct mdoc *mdoc; |
struct mdoc *mdoc; /* mdoc parser */ |
struct roff *roff; |
struct roff *roff; /* roff parser (!NULL) */ |
enum outt outtype; /* Output devices... */ |
enum outt outtype; /* which output to use */ |
out_mdoc outmdoc; |
out_mdoc outmdoc; /* mdoc output ptr */ |
out_man outman; |
out_man outman; /* man output ptr */ |
out_free outfree; |
out_free outfree; /* free output ptr */ |
void *outdata; |
void *outdata; /* data for output */ |
char outopts[BUFSIZ]; |
char outopts[BUFSIZ]; /* buf of output opts */ |
}; |
}; |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
|
"ok", |
|
"text should be uppercase", |
|
"sections out of conventional order", |
|
"section name repeats", |
|
"out of order prologue", |
|
"repeated prologue entry", |
|
"list type must come first", |
|
"bad standard", |
|
"bad library", |
|
"bad escape sequence", |
|
"unterminated quoted string", |
|
"argument requires the width argument", |
|
"superfluous width argument", |
|
"ignoring argument", |
|
"bad date argument", |
|
"bad width argument", |
|
"unknown manual section", |
|
"section not in conventional manual section", |
|
"end of line whitespace", |
|
"scope open on exit", |
|
"NAME section must come first", |
|
"bad Boolean value", |
|
"child violates parent syntax", |
|
"bad AT&T symbol", |
|
"list type repeated", |
|
"display type repeated", |
|
"argument repeated", |
|
"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", |
|
"line scope broken", |
|
"scope broken", |
|
"argument count wrong", |
|
"request scope close w/none open", |
|
"scope already open", |
|
"macro requires line argument(s)", |
|
"macro requires body argument(s)", |
|
"macro requires argument(s)", |
|
"no title in document", |
|
"missing list type", |
|
"missing display type", |
|
"line argument(s) will be lost", |
|
"body argument(s) will be lost", |
|
"column syntax is inconsistent", |
|
"missing font type", |
|
"displays may not be nested", |
|
"unsupported display type", |
|
"no scope to rewind: syntax violated", |
|
"scope broken, syntax violated", |
|
"line scope broken, syntax violated", |
|
"argument count wrong, violates syntax", |
|
"child violates parent syntax", |
|
"argument count wrong, violates syntax", |
|
"no document body", |
|
"no document prologue", |
|
"utsname system call failed", |
|
"memory exhausted", |
|
}; |
|
|
static void fdesc(struct curparse *); |
static void fdesc(struct curparse *); |
static void ffile(const char *, struct curparse *); |
static void ffile(const char *, struct curparse *); |
static int foptions(int *, char *); |
static int foptions(int *, char *); |
static struct man *man_init(struct curparse *); |
static struct man *man_init(struct curparse *); |
static struct mdoc *mdoc_init(struct curparse *); |
static struct mdoc *mdoc_init(struct curparse *); |
static struct roff *roff_init(struct curparse *); |
static struct roff *roff_init(struct curparse *); |
static int merr(void *, int, int, const char *); /* DEPRECATED */ |
|
static int moptions(enum intt *, char *); |
static int moptions(enum intt *, char *); |
static int mwarn(void *, int, int, const char *); /* DEPRECATED */ |
|
static int mmsg(enum mandocerr, void *, |
static int mmsg(enum mandocerr, void *, |
int, int, const char *); |
int, int, const char *); |
static int pset(const char *, int, struct curparse *, |
static int pset(const char *, int, struct curparse *, |
Line 220 static struct man * |
|
Line 288 static struct man * |
|
man_init(struct curparse *curp) |
man_init(struct curparse *curp) |
{ |
{ |
int pflags; |
int pflags; |
struct man_cb mancb; |
|
|
|
mancb.man_err = merr; |
|
mancb.man_warn = mwarn; |
|
|
|
/* Defaults from mandoc.1. */ |
/* Defaults from mandoc.1. */ |
|
|
pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE; |
pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE; |
Line 234 man_init(struct curparse *curp) |
|
Line 298 man_init(struct curparse *curp) |
|
if (curp->fflags & FL_NIGN_ESCAPE) |
if (curp->fflags & FL_NIGN_ESCAPE) |
pflags &= ~MAN_IGN_ESCAPE; |
pflags &= ~MAN_IGN_ESCAPE; |
|
|
return(man_alloc(curp, pflags, &mancb)); |
return(man_alloc(curp, pflags, mmsg)); |
} |
} |
|
|
|
|
Line 250 static struct mdoc * |
|
Line 314 static struct mdoc * |
|
mdoc_init(struct curparse *curp) |
mdoc_init(struct curparse *curp) |
{ |
{ |
int pflags; |
int pflags; |
struct mdoc_cb mdoccb; |
|
|
|
mdoccb.mdoc_err = merr; |
|
mdoccb.mdoc_warn = mwarn; |
|
|
|
/* Defaults from mandoc.1. */ |
/* Defaults from mandoc.1. */ |
|
|
pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE; |
pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE; |
Line 266 mdoc_init(struct curparse *curp) |
|
Line 326 mdoc_init(struct curparse *curp) |
|
if (curp->fflags & FL_NIGN_MACRO) |
if (curp->fflags & FL_NIGN_MACRO) |
pflags &= ~MDOC_IGN_MACRO; |
pflags &= ~MDOC_IGN_MACRO; |
|
|
return(mdoc_alloc(curp, pflags, &mdoccb)); |
return(mdoc_alloc(curp, pflags, mmsg)); |
} |
} |
|
|
|
|
Line 339 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 399 read_whole_file(struct curparse *curp, struct buf *fb, |
|
*with_mmap = 1; |
*with_mmap = 1; |
fb->sz = (size_t)st.st_size; |
fb->sz = (size_t)st.st_size; |
fb->buf = mmap(NULL, fb->sz, PROT_READ, |
fb->buf = mmap(NULL, fb->sz, PROT_READ, |
MAP_FILE, curp->fd, 0); |
MAP_FILE|MAP_SHARED, curp->fd, 0); |
if (fb->buf != MAP_FAILED) |
if (fb->buf != MAP_FAILED) |
return(1); |
return(1); |
} |
} |
|
|
fdesc(struct curparse *curp) |
fdesc(struct curparse *curp) |
{ |
{ |
struct buf ln, blk; |
struct buf ln, blk; |
int i, pos, lnn, lnn_start, with_mmap; |
int i, pos, lnn, lnn_start, with_mmap, of; |
enum rofferr re; |
enum rofferr re; |
struct man *man; |
struct man *man; |
struct mdoc *mdoc; |
struct mdoc *mdoc; |
struct roff *roff; |
struct roff *roff; |
|
struct regset regs; |
|
|
man = NULL; |
man = NULL; |
mdoc = NULL; |
mdoc = NULL; |
roff = NULL; |
roff = NULL; |
memset(&ln, 0, sizeof(struct buf)); |
memset(&ln, 0, sizeof(struct buf)); |
|
memset(®s, 0, sizeof(struct regset)); |
|
|
/* |
/* |
* Two buffers: ln and buf. buf is the input file and may be |
* Two buffers: ln and buf. buf is the input file and may be |
Line 467 fdesc(struct curparse *curp) |
|
Line 529 fdesc(struct curparse *curp) |
|
goto bailout; |
goto bailout; |
ln.buf[pos] = '\0'; |
ln.buf[pos] = '\0'; |
|
|
re = roff_parseln(roff, lnn_start, &ln.buf, &ln.sz); |
/* |
|
* 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; |
|
do { |
|
re = roff_parseln(roff, ®s, lnn_start, |
|
&ln.buf, &ln.sz, of, &of); |
|
} while (ROFF_RERUN == re); |
|
|
if (ROFF_IGN == re) |
if (ROFF_IGN == re) |
continue; |
continue; |
else if (ROFF_ERR == re) |
else if (ROFF_ERR == re) |
goto bailout; |
goto bailout; |
|
|
/* If unset, assign parser in pset(). */ |
/* |
|
* If input parsers have not been allocated, do so now. |
|
* We keep these instanced betwen parsers, but set them |
|
* locally per parse routine since we can use different |
|
* parsers with each one. |
|
*/ |
|
|
if ( ! (man || mdoc) && ! pset(ln.buf, pos, curp, &man, &mdoc)) |
if ( ! (man || mdoc)) |
goto bailout; |
if ( ! pset(ln.buf + of, pos - of, curp, &man, &mdoc)) |
|
goto bailout; |
|
|
/* Pass down into parsers. */ |
/* Lastly, push down into the parsers themselves. */ |
|
|
if (man && ! man_parseln(man, lnn_start, ln.buf)) |
if (man && ! man_parseln(man, ®s, lnn_start, ln.buf, of)) |
goto bailout; |
goto bailout; |
if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf)) |
if (mdoc && ! mdoc_parseln(mdoc, ®s, lnn_start, ln.buf, of)) |
goto bailout; |
goto bailout; |
} |
} |
|
|
Line 493 fdesc(struct curparse *curp) |
|
Line 575 fdesc(struct curparse *curp) |
|
goto bailout; |
goto bailout; |
} |
} |
|
|
|
/* Clean up the parse routine ASTs. */ |
|
|
if (mdoc && ! mdoc_endparse(mdoc)) |
if (mdoc && ! mdoc_endparse(mdoc)) |
goto bailout; |
goto bailout; |
if (man && ! man_endparse(man)) |
if (man && ! man_endparse(man)) |
Line 506 fdesc(struct curparse *curp) |
|
Line 590 fdesc(struct curparse *curp) |
|
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->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
break; |
case (OUTT_HTML): |
case (OUTT_HTML): |
curp->outdata = html_alloc(curp->outopts); |
curp->outdata = html_alloc(curp->outopts); |
|
break; |
|
case (OUTT_ASCII): |
|
curp->outdata = ascii_alloc(curp->outopts); |
|
curp->outfree = ascii_free; |
|
break; |
|
case (OUTT_PS): |
|
curp->outdata = ps_alloc(); |
|
curp->outfree = ps_free; |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
switch (curp->outtype) { |
|
case (OUTT_HTML): |
|
/* FALLTHROUGH */ |
|
case (OUTT_XHTML): |
curp->outman = html_man; |
curp->outman = html_man; |
curp->outmdoc = html_mdoc; |
curp->outmdoc = html_mdoc; |
curp->outfree = html_free; |
curp->outfree = html_free; |
Line 520 fdesc(struct curparse *curp) |
|
Line 618 fdesc(struct curparse *curp) |
|
curp->outman = tree_man; |
curp->outman = tree_man; |
curp->outmdoc = tree_mdoc; |
curp->outmdoc = tree_mdoc; |
break; |
break; |
case (OUTT_LINT): |
case (OUTT_ASCII): |
break; |
/* FALLTHROUGH */ |
default: |
case (OUTT_PS): |
curp->outdata = ascii_alloc(80); |
|
curp->outman = terminal_man; |
curp->outman = terminal_man; |
curp->outmdoc = terminal_mdoc; |
curp->outmdoc = terminal_mdoc; |
curp->outfree = terminal_free; |
|
break; |
break; |
|
default: |
|
break; |
} |
} |
} |
} |
|
|
Line 574 pset(const char *buf, int pos, struct curparse *curp, |
|
Line 672 pset(const char *buf, int pos, struct curparse *curp, |
|
* default to -man, which is more lenient. |
* default to -man, which is more lenient. |
*/ |
*/ |
|
|
if (buf[0] == '.') { |
if ('.' == buf[0] || '\'' == buf[0]) { |
for (i = 1; buf[i]; i++) |
for (i = 1; buf[i]; i++) |
if (' ' != buf[i] && '\t' != buf[i]) |
if (' ' != buf[i] && '\t' != buf[i]) |
break; |
break; |
Line 651 toptions(struct curparse *curp, char *arg) |
|
Line 749 toptions(struct curparse *curp, char *arg) |
|
curp->outtype = OUTT_HTML; |
curp->outtype = OUTT_HTML; |
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")) |
|
curp->outtype = OUTT_PS; |
else { |
else { |
fprintf(stderr, "%s: Bad argument\n", arg); |
fprintf(stderr, "%s: Bad argument\n", arg); |
return(0); |
return(0); |
Line 734 woptions(int *wflags, char *arg) |
|
Line 834 woptions(int *wflags, char *arg) |
|
} |
} |
|
|
|
|
/* ARGSUSED */ |
|
static int |
static int |
merr(void *arg, int line, int col, const char *msg) |
mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) |
{ |
{ |
struct curparse *curp; |
struct curparse *cp; |
|
|
curp = (struct curparse *)arg; |
cp = (struct curparse *)arg; |
|
|
(void)fprintf(stderr, "%s:%d:%d: error: %s\n", |
if (t <= MANDOCERR_ERROR) { |
curp->file, line, col + 1, msg); |
if ( ! (cp->wflags & WARN_WALL)) |
|
return(1); |
|
with_warning = 1; |
|
} else |
|
with_error = 1; |
|
|
with_error = 1; |
fprintf(stderr, "%s:%d:%d: %s", cp->file, |
|
ln, col + 1, mandocerrs[t]); |
|
|
return(0); |
if (msg) |
} |
fprintf(stderr, ": %s", msg); |
|
|
|
fputc('\n', stderr); |
|
|
static int |
/* This is superfluous, but whatever. */ |
mwarn(void *arg, int line, int col, const char *msg) |
if (t > MANDOCERR_ERROR) |
{ |
return(0); |
struct curparse *curp; |
if (cp->wflags & WARN_WERR) { |
|
|
curp = (struct curparse *)arg; |
|
|
|
if ( ! (curp->wflags & WARN_WALL)) |
|
return(1); |
|
|
|
(void)fprintf(stderr, "%s:%d:%d: warning: %s\n", |
|
curp->file, line, col + 1, msg); |
|
|
|
with_warning = 1; |
|
if (curp->wflags & WARN_WERR) { |
|
with_error = 1; |
with_error = 1; |
return(0); |
return(0); |
} |
} |
|
|
return(1); |
|
} |
|
|
|
/* |
|
* XXX: this is experimental code that will eventually become the |
|
* generic means of covering all warnings and errors! |
|
*/ |
|
/* ARGSUSED */ |
|
static int |
|
mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) |
|
{ |
|
struct curparse *cp; |
|
|
|
cp = (struct curparse *)arg; |
|
|
|
/*fprintf(stderr, "%s:%d:%d: %s\n", cp->file, ln, col + 1, msg);*/ |
|
|
|
return(1); |
return(1); |
} |
} |