version 1.15, 2009/03/25 21:03:13 |
version 1.19, 2009/04/02 16:26:35 |
|
|
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
|
|
|
/* Account for FreeBSD and Linux in our declarations. */ |
|
|
#ifdef __linux__ |
#ifdef __linux__ |
extern int getsubopt(char **, char * const *, char **); |
extern int getsubopt(char **, char * const *, char **); |
# ifndef __dead |
# ifndef __dead |
|
|
size_t sz; |
size_t sz; |
}; |
}; |
|
|
struct curparse { |
|
const char *file; |
|
int wflags; |
|
#define WARN_WALL 0x03 /* All-warnings mask. */ |
|
#define WARN_WCOMPAT (1 << 0) /* Compatibility warnings. */ |
|
#define WARN_WSYNTAX (1 << 1) /* Syntax warnings. */ |
|
#define WARN_WERR (1 << 2) /* Warnings->errors. */ |
|
}; |
|
|
|
#define IGN_SCOPE (1 << 0) /* Flag to ignore scope. */ |
|
#define IGN_ESCAPE (1 << 1) /* Flag to ignore bad escapes. */ |
|
#define IGN_MACRO (1 << 2) /* Flag to ignore unknown macros. */ |
|
|
|
enum intt { |
enum intt { |
INTT_MDOC = 0, |
INTT_AUTO, |
|
INTT_MDOC, |
INTT_MAN |
INTT_MAN |
}; |
}; |
|
|
enum outt { |
enum outt { |
OUTT_ASCII = 0, |
OUTT_ASCII = 0, |
OUTT_LATIN1, |
|
OUTT_UTF8, |
|
OUTT_TREE, |
OUTT_TREE, |
OUTT_LINT |
OUTT_LINT |
}; |
}; |
|
|
|
struct curparse { |
|
const char *file; |
|
int fd; |
|
int wflags; |
|
#define WARN_WALL 0x03 /* All-warnings mask. */ |
|
#define WARN_WCOMPAT (1 << 0) /* Compatibility warnings. */ |
|
#define WARN_WSYNTAX (1 << 1) /* Syntax warnings. */ |
|
#define WARN_WERR (1 << 2) /* Warnings->errors. */ |
|
int fflags; |
|
enum intt inttype; |
|
struct man *man; |
|
struct mdoc *mdoc; |
|
}; |
|
|
|
#define IGN_SCOPE (1 << 0) /* Ignore scope errors. */ |
|
#define IGN_ESCAPE (1 << 1) /* Ignore bad escapes. */ |
|
#define IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
|
|
typedef int (*out_run)(void *, const struct man *, |
typedef int (*out_run)(void *, const struct man *, |
const struct mdoc *); |
const struct mdoc *); |
typedef void (*out_free)(void *); |
typedef void (*out_free)(void *); |
Line 78 typedef void (*out_free)(void *); |
|
Line 84 typedef void (*out_free)(void *); |
|
extern char *__progname; |
extern char *__progname; |
|
|
extern void *ascii_alloc(void); |
extern void *ascii_alloc(void); |
extern void *latin1_alloc(void); |
|
extern void *utf8_alloc(void); |
|
extern int terminal_run(void *, const struct man *, |
extern int terminal_run(void *, const struct man *, |
const struct mdoc *); |
const struct mdoc *); |
extern int tree_run(void *, const struct man *, |
extern int tree_run(void *, const struct man *, |
Line 94 static int merr(void *, int, int, const char *); |
|
Line 98 static int merr(void *, int, int, const char *); |
|
static int manwarn(void *, int, int, const char *); |
static int manwarn(void *, int, int, const char *); |
static int mdocwarn(void *, int, int, |
static int mdocwarn(void *, int, int, |
enum mdoc_warn, const char *); |
enum mdoc_warn, const char *); |
static int file(struct buf *, struct buf *, |
static int fstdin(struct buf *, struct buf *, |
const char *, |
struct curparse *); |
struct man *, struct mdoc *); |
static int ffile(struct buf *, struct buf *, |
|
const char *, struct curparse *); |
static int fdesc(struct buf *, struct buf *, |
static int fdesc(struct buf *, struct buf *, |
const char *, int, |
struct curparse *); |
struct man *, struct mdoc *); |
static int pset(const char *, size_t, struct curparse *, |
|
struct man **, struct mdoc **); |
|
static struct man *man_init(struct curparse *); |
|
static struct mdoc *mdoc_init(struct curparse *); |
__dead static void version(void); |
__dead static void version(void); |
__dead static void usage(void); |
__dead static void usage(void); |
|
|
Line 108 __dead static void usage(void); |
|
Line 115 __dead static void usage(void); |
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
int c, rc, fflags, pflags; |
int c, rc; |
struct mdoc_cb mdoccb; |
|
struct man_cb mancb; |
|
struct man *man; |
|
struct mdoc *mdoc; |
|
void *outdata; |
void *outdata; |
enum outt outtype; |
enum outt outtype; |
enum intt inttype; |
|
struct buf ln, blk; |
struct buf ln, blk; |
out_run outrun; |
out_run outrun; |
out_free outfree; |
out_free outfree; |
struct curparse curp; |
struct curparse curp; |
|
|
fflags = 0; |
|
outtype = OUTT_ASCII; |
outtype = OUTT_ASCII; |
inttype = INTT_MDOC; |
|
|
|
bzero(&curp, sizeof(struct curparse)); |
bzero(&curp, sizeof(struct curparse)); |
|
|
|
curp.inttype = INTT_AUTO; |
|
|
/* LINTED */ |
/* LINTED */ |
while (-1 != (c = getopt(argc, argv, "f:m:VW:T:"))) |
while (-1 != (c = getopt(argc, argv, "f:m:VW:T:"))) |
switch (c) { |
switch (c) { |
case ('f'): |
case ('f'): |
if ( ! foptions(&fflags, optarg)) |
if ( ! foptions(&curp.fflags, optarg)) |
return(0); |
return(0); |
break; |
break; |
case ('m'): |
case ('m'): |
if ( ! moptions(&inttype, optarg)) |
if ( ! moptions(&curp.inttype, optarg)) |
return(0); |
return(0); |
break; |
break; |
case ('T'): |
case ('T'): |
Line 158 main(int argc, char *argv[]) |
|
Line 160 main(int argc, char *argv[]) |
|
argv += optind; |
argv += optind; |
|
|
/* |
/* |
* Allocate the appropriate front-end. Note that utf8, ascii |
* Allocate the appropriate front-end. Note that utf8, latin1 |
* and latin1 all resolve to the terminal front-end with |
* (both not yet implemented) and ascii all resolve to the |
* different encodings (see terminal.c). Not all frontends have |
* terminal front-end with different encodings (see terminal.c). |
* cleanup or alloc routines. |
* Not all frontends have cleanup or alloc routines. |
*/ |
*/ |
|
|
switch (outtype) { |
switch (outtype) { |
case (OUTT_LATIN1): |
|
outdata = latin1_alloc(); |
|
outrun = terminal_run; |
|
outfree = terminal_free; |
|
break; |
|
case (OUTT_UTF8): |
|
outdata = utf8_alloc(); |
|
outrun = terminal_run; |
|
outfree = terminal_free; |
|
break; |
|
case (OUTT_TREE): |
case (OUTT_TREE): |
outdata = NULL; |
outdata = NULL; |
outrun = tree_run; |
outrun = tree_run; |
Line 192 main(int argc, char *argv[]) |
|
Line 184 main(int argc, char *argv[]) |
|
break; |
break; |
} |
} |
|
|
/* |
/* Configure buffers. */ |
* All callbacks route into here, where we print them onto the |
|
* screen. XXX - for now, no path for debugging messages. |
|
*/ |
|
|
|
mdoccb.mdoc_msg = NULL; |
|
mdoccb.mdoc_err = merr; |
|
mdoccb.mdoc_warn = mdocwarn; |
|
|
|
mancb.man_err = merr; |
|
mancb.man_warn = manwarn; |
|
|
|
bzero(&ln, sizeof(struct buf)); |
bzero(&ln, sizeof(struct buf)); |
bzero(&blk, sizeof(struct buf)); |
bzero(&blk, sizeof(struct buf)); |
|
|
man = NULL; |
|
mdoc = NULL; |
|
pflags = 0; |
|
|
|
switch (inttype) { |
|
case (INTT_MAN): |
|
if (fflags & IGN_MACRO) |
|
pflags |= MAN_IGN_MACRO; |
|
|
|
man = man_alloc(&curp, pflags, &mancb); |
|
break; |
|
default: |
|
if (fflags & IGN_SCOPE) |
|
pflags |= MDOC_IGN_SCOPE; |
|
if (fflags & IGN_ESCAPE) |
|
pflags |= MDOC_IGN_ESCAPE; |
|
if (fflags & IGN_MACRO) |
|
pflags |= MDOC_IGN_MACRO; |
|
|
|
mdoc = mdoc_alloc(&curp, pflags, &mdoccb); |
|
break; |
|
} |
|
|
|
/* |
/* |
* Loop around available files. |
* Main loop around available files. |
*/ |
*/ |
|
|
if (NULL == *argv) { |
if (NULL == *argv) { |
curp.file = "<stdin>"; |
|
rc = 0; |
rc = 0; |
c = fdesc(&blk, &ln, "stdin", |
c = fstdin(&blk, &ln, &curp); |
STDIN_FILENO, man, mdoc); |
|
|
|
if (c && NULL == outrun) |
if (c && NULL == outrun) |
rc = 1; |
rc = 1; |
else if (c && outrun && (*outrun)(outdata, man, mdoc)) |
/*else if (c && outrun && (*outrun)(outdata, curp.man, curp.mdoc)) |
rc = 1; |
rc = 1;*/ |
} else { |
} else { |
while (*argv) { |
while (*argv) { |
curp.file = *argv; |
c = ffile(&blk, &ln, *argv, &curp); |
c = file(&blk, &ln, *argv, man, mdoc); |
|
if ( ! c) |
if ( ! c) |
break; |
break; |
if (outrun && ! (*outrun)(outdata, man, mdoc)) |
/*if (outrun && ! (*outrun)(outdata, curp.man, curp.mdoc)) |
|
break;*/ |
|
if (curp.man) |
|
man_reset(curp.man); |
|
if (curp.mdoc && ! mdoc_reset(curp.mdoc)) { |
|
warnx("memory exhausted"); |
break; |
break; |
if (man) |
} |
man_reset(man); |
|
if (mdoc) |
|
mdoc_reset(mdoc); |
|
|
|
argv++; |
argv++; |
} |
} |
rc = NULL == *argv; |
rc = NULL == *argv; |
Line 268 main(int argc, char *argv[]) |
|
Line 225 main(int argc, char *argv[]) |
|
free(ln.buf); |
free(ln.buf); |
if (outfree) |
if (outfree) |
(*outfree)(outdata); |
(*outfree)(outdata); |
if (mdoc) |
if (curp.mdoc) |
mdoc_free(mdoc); |
mdoc_free(curp.mdoc); |
if (man) |
if (curp.man) |
man_free(man); |
man_free(curp.man); |
|
|
return(rc ? EXIT_SUCCESS : EXIT_FAILURE); |
return(rc ? EXIT_SUCCESS : EXIT_FAILURE); |
} |
} |
|
|
{ |
{ |
|
|
(void)printf("%s %s\n", __progname, VERSION); |
(void)printf("%s %s\n", __progname, VERSION); |
exit(0); |
exit(EXIT_SUCCESS); |
/* NOTREACHED */ |
|
} |
} |
|
|
|
|
|
|
(void)fprintf(stderr, "usage: %s [-V] [-foption...] " |
(void)fprintf(stderr, "usage: %s [-V] [-foption...] " |
"[-mformat] [-Toutput] [-Werr...]\n", |
"[-mformat] [-Toutput] [-Werr...]\n", |
__progname); |
__progname); |
exit(1); |
exit(EXIT_FAILURE); |
/* NOTREACHED */ |
|
} |
} |
|
|
|
|
|
static struct man * |
|
man_init(struct curparse *curp) |
|
{ |
|
int pflags; |
|
struct man *man; |
|
struct man_cb mancb; |
|
|
|
mancb.man_err = merr; |
|
mancb.man_warn = manwarn; |
|
|
|
pflags = 0; |
|
|
|
if (curp->fflags & IGN_MACRO) |
|
pflags |= MAN_IGN_MACRO; |
|
|
|
if (NULL == (man = man_alloc(curp, pflags, &mancb))) |
|
warnx("memory exhausted"); |
|
|
|
return(man); |
|
} |
|
|
|
|
|
static struct mdoc * |
|
mdoc_init(struct curparse *curp) |
|
{ |
|
int pflags; |
|
struct mdoc *mdoc; |
|
struct mdoc_cb mdoccb; |
|
|
|
mdoccb.mdoc_msg = NULL; |
|
mdoccb.mdoc_err = merr; |
|
mdoccb.mdoc_warn = mdocwarn; |
|
|
|
pflags = 0; |
|
|
|
if (curp->fflags & IGN_SCOPE) |
|
pflags |= MDOC_IGN_SCOPE; |
|
if (curp->fflags & IGN_ESCAPE) |
|
pflags |= MDOC_IGN_ESCAPE; |
|
if (curp->fflags & IGN_MACRO) |
|
pflags |= MDOC_IGN_MACRO; |
|
|
|
if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb))) |
|
warnx("memory allocated"); |
|
|
|
return(mdoc); |
|
} |
|
|
|
|
static int |
static int |
file(struct buf *blk, struct buf *ln, const char *file, |
fstdin(struct buf *blk, struct buf *ln, struct curparse *curp) |
struct man *man, struct mdoc *mdoc) |
|
{ |
{ |
int fd, c; |
|
|
|
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
curp->file = "<stdin>"; |
warn("%s", file); |
curp->fd = STDIN_FILENO; |
|
return(fdesc(blk, ln, curp)); |
|
} |
|
|
|
|
|
static int |
|
ffile(struct buf *blk, struct buf *ln, |
|
const char *file, struct curparse *curp) |
|
{ |
|
int c; |
|
|
|
curp->file = file; |
|
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
|
warn("%s", curp->file); |
return(0); |
return(0); |
} |
} |
|
|
c = fdesc(blk, ln, file, fd, man, mdoc); |
c = fdesc(blk, ln, curp); |
|
|
if (-1 == close(fd)) |
if (-1 == close(curp->fd)) |
warn("%s", file); |
warn("%s", curp->file); |
|
|
return(c); |
return(c); |
} |
} |
|
|
|
|
static int |
static int |
fdesc(struct buf *blk, struct buf *ln, |
fdesc(struct buf *blk, struct buf *ln, struct curparse *curp) |
const char *f, int fd, |
|
struct man *man, struct mdoc *mdoc) |
|
{ |
{ |
size_t sz; |
size_t sz; |
ssize_t ssz; |
ssize_t ssz; |
struct stat st; |
struct stat st; |
int j, i, pos, lnn; |
int j, i, pos, lnn; |
|
struct man *man; |
|
struct mdoc *mdoc; |
|
|
assert( ! (man && mdoc)); |
sz = BUFSIZ; |
|
man = NULL; |
|
mdoc = NULL; |
|
|
/* |
/* |
* Two buffers: ln and buf. buf is the input buffer, optimised |
* Two buffers: ln and buf. buf is the input buffer optimised |
* for each file's block size. ln is a line buffer. Both |
* here for each file's block size. ln is a line buffer. Both |
* growable, hence passed in by ptr-ptr. |
* growable, hence passed in by ptr-ptr. |
*/ |
*/ |
|
|
sz = BUFSIZ; |
if (-1 == fstat(curp->fd, &st)) |
|
warnx("%s", curp->file); |
if (-1 == fstat(fd, &st)) |
|
warnx("%s", f); |
|
else if ((size_t)st.st_blksize > sz) |
else if ((size_t)st.st_blksize > sz) |
sz = st.st_blksize; |
sz = st.st_blksize; |
|
|
if (sz > blk->sz) { |
if (sz > blk->sz) { |
blk->buf = realloc(blk->buf, sz); |
blk->buf = realloc(blk->buf, sz); |
if (NULL == blk->buf) |
if (NULL == blk->buf) { |
err(1, "realloc"); |
warn("realloc"); |
|
return(0); |
|
} |
blk->sz = sz; |
blk->sz = sz; |
} |
} |
|
|
/* |
/* Fill buf with file blocksize. */ |
* Fill buf with file blocksize and parse newlines into ln. |
|
*/ |
|
|
|
for (lnn = 1, pos = 0; ; ) { |
for (lnn = 0, pos = 0; ; ) { |
if (-1 == (ssz = read(fd, blk->buf, sz))) { |
if (-1 == (ssz = read(curp->fd, blk->buf, sz))) { |
warn("%s", f); |
warn("%s", curp->file); |
return(0); |
return(0); |
} else if (0 == ssz) |
} else if (0 == ssz) |
break; |
break; |
|
|
|
/* Parse the read block into partial or full lines. */ |
|
|
for (i = 0; i < (int)ssz; i++) { |
for (i = 0; i < (int)ssz; i++) { |
if (pos >= (int)ln->sz) { |
if (pos >= (int)ln->sz) { |
ln->sz += 256; /* Step-size. */ |
ln->sz += 256; /* Step-size. */ |
ln->buf = realloc(ln->buf, ln->sz); |
ln->buf = realloc(ln->buf, ln->sz); |
if (NULL == ln->buf) |
if (NULL == ln->buf) { |
err(1, "realloc"); |
warn("realloc"); |
|
return(0); |
|
} |
} |
} |
|
|
if ('\n' != blk->buf[i]) { |
if ('\n' != blk->buf[i]) { |
Line 390 fdesc(struct buf *blk, struct buf *ln, |
|
Line 409 fdesc(struct buf *blk, struct buf *ln, |
|
} |
} |
|
|
ln->buf[pos] = 0; |
ln->buf[pos] = 0; |
if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf)) |
lnn++; |
|
|
|
/* |
|
* If no manual parser has been assigned, then |
|
* try to assign one in pset(), which may do |
|
* nothing at all. After this, parse the manual |
|
* line accordingly. |
|
*/ |
|
|
|
if ( ! (man || mdoc) && ! pset(ln->buf, |
|
pos, curp, &man, &mdoc)) |
return(0); |
return(0); |
|
|
|
pos = 0; |
|
|
if (man && ! man_parseln(man, lnn, ln->buf)) |
if (man && ! man_parseln(man, lnn, ln->buf)) |
return(0); |
return(0); |
lnn++; |
if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf)) |
pos = 0; |
return(0); |
} |
} |
} |
} |
|
|
|
/* Note that a parser may not have been assigned, yet. */ |
|
|
if (mdoc) |
if (mdoc) |
return(mdoc_endparse(mdoc)); |
return(mdoc_endparse(mdoc)); |
|
if (man) |
|
return(man_endparse(man)); |
|
|
return(man_endparse(man)); |
warnx("%s: not a manual", curp->file); |
|
return(0); |
} |
} |
|
|
|
|
static int |
static int |
|
pset(const char *buf, size_t pos, struct curparse *curp, |
|
struct man **man, struct mdoc **mdoc) |
|
{ |
|
|
|
/* |
|
* Try to intuit which kind of manual parser should be used. If |
|
* passed in by command-line (-man, -mdoc), then use that |
|
* explicitly. If passed as -mandoc, then try to guess from the |
|
* line: either skip comments, use -mdoc when finding `.Dt', or |
|
* default to -man, which is more lenient. |
|
*/ |
|
|
|
if (pos >= 3 && 0 == memcmp(buf, ".\\\"", 3)) |
|
return(1); |
|
|
|
switch (curp->inttype) { |
|
case (INTT_MDOC): |
|
if (NULL == curp->mdoc) |
|
curp->mdoc = mdoc_init(curp); |
|
if (NULL == (*mdoc = curp->mdoc)) |
|
return(0); |
|
warnx("inheriting -mdoc parser"); |
|
return(1); |
|
case (INTT_MAN): |
|
if (NULL == curp->man) |
|
curp->man = man_init(curp); |
|
if (NULL == (*man = curp->man)) |
|
return(0); |
|
warnx("inheriting -man parser"); |
|
return(1); |
|
default: |
|
break; |
|
} |
|
|
|
if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { |
|
if (NULL == curp->mdoc) |
|
curp->mdoc = mdoc_init(curp); |
|
if (NULL == (*mdoc = curp->mdoc)) |
|
return(0); |
|
return(1); |
|
} |
|
|
|
if (NULL == curp->man) |
|
curp->man = man_init(curp); |
|
if (NULL == (*man = curp->man)) |
|
return(0); |
|
return(1); |
|
} |
|
|
|
|
|
static int |
moptions(enum intt *tflags, char *arg) |
moptions(enum intt *tflags, char *arg) |
{ |
{ |
|
|
if (0 == strcmp(arg, "mdoc")) |
if (0 == strcmp(arg, "doc")) |
*tflags = INTT_MDOC; |
*tflags = INTT_MDOC; |
else if (0 == strcmp(arg, "man")) |
else if (0 == strcmp(arg, "andoc")) |
|
*tflags = INTT_AUTO; |
|
else if (0 == strcmp(arg, "an")) |
*tflags = INTT_MAN; |
*tflags = INTT_MAN; |
else { |
else { |
warnx("bad argument: -m%s", arg); |
warnx("bad argument: -m%s", arg); |
Line 429 toptions(enum outt *tflags, char *arg) |
|
Line 519 toptions(enum outt *tflags, char *arg) |
|
|
|
if (0 == strcmp(arg, "ascii")) |
if (0 == strcmp(arg, "ascii")) |
*tflags = OUTT_ASCII; |
*tflags = OUTT_ASCII; |
else if (0 == strcmp(arg, "latin1")) |
|
*tflags = OUTT_LATIN1; |
|
else if (0 == strcmp(arg, "utf8")) |
|
*tflags = OUTT_UTF8; |
|
else if (0 == strcmp(arg, "lint")) |
else if (0 == strcmp(arg, "lint")) |
*tflags = OUTT_LINT; |
*tflags = OUTT_LINT; |
else if (0 == strcmp(arg, "tree")) |
else if (0 == strcmp(arg, "tree")) |