version 1.76, 2010/05/16 10:59:36 |
version 1.127, 2010/12/29 14:38:14 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.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 |
|
|
#include <sys/stat.h> |
#include <sys/stat.h> |
|
|
#include <assert.h> |
#include <assert.h> |
|
#include <ctype.h> |
#include <fcntl.h> |
#include <fcntl.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 "main.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "roff.h" |
#include "roff.h" |
#include "main.h" |
|
|
|
|
#ifndef MAP_FILE |
|
#define MAP_FILE 0 |
|
#endif |
|
|
|
#define REPARSE_LIMIT 1000 |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
|
|
/* FIXME: Intel's compiler? LLVM? pcc? */ |
/* FIXME: Intel's compiler? LLVM? pcc? */ |
|
|
OUTT_TREE, |
OUTT_TREE, |
OUTT_HTML, |
OUTT_HTML, |
OUTT_XHTML, |
OUTT_XHTML, |
OUTT_LINT |
OUTT_LINT, |
|
OUTT_PS, |
|
OUTT_PDF |
}; |
}; |
|
|
struct curparse { |
struct curparse { |
const char *file; /* Current parse. */ |
const char *file; /* Current parse. */ |
int fd; /* Current parse. */ |
int fd; /* Current parse. */ |
int wflags; |
int line; /* Line number in the file. */ |
/* FIXME: set by max error */ |
enum mandoclevel wlevel; /* Ignore messages below this. */ |
#define WARN_WALL (1 << 0) /* All-warnings mask. */ |
int wstop; /* Stop after a file with a warning. */ |
#define WARN_WERR (1 << 2) /* Warnings->errors. */ |
enum intt inttype; /* which parser to use */ |
int fflags; |
struct man *pman; /* persistent man parser */ |
#define FL_IGN_SCOPE (1 << 0) /* Ignore scope errors. */ |
struct mdoc *pmdoc; /* persistent mdoc parser */ |
#define FL_NIGN_ESCAPE (1 << 1) /* Don't ignore bad escapes. */ |
struct man *man; /* man parser */ |
#define FL_NIGN_MACRO (1 << 2) /* Don't ignore bad macros. */ |
struct mdoc *mdoc; /* mdoc parser */ |
#define FL_IGN_ERRORS (1 << 4) /* Ignore failed parse. */ |
struct roff *roff; /* roff parser (!NULL) */ |
#define FL_STRICT FL_NIGN_ESCAPE | \ |
struct regset regs; /* roff registers */ |
FL_NIGN_MACRO |
int reparse_count; /* finite interpolation stack */ |
enum intt inttype; /* Input parsers... */ |
enum outt outtype; /* which output to use */ |
struct man *man; |
out_mdoc outmdoc; /* mdoc output ptr */ |
struct mdoc *mdoc; |
out_man outman; /* man output ptr */ |
struct roff *roff; |
out_free outfree; /* free output ptr */ |
enum outt outtype; /* Output devices... */ |
void *outdata; /* data for output */ |
out_mdoc outmdoc; |
char outopts[BUFSIZ]; /* buf of output opts */ |
out_man outman; |
|
out_free outfree; |
|
void *outdata; |
|
char outopts[BUFSIZ]; |
|
}; |
}; |
|
|
|
static const char * const mandoclevels[MANDOCLEVEL_MAX] = { |
|
"SUCCESS", |
|
"RESERVED", |
|
"WARNING", |
|
"ERROR", |
|
"FATAL", |
|
"BADARG", |
|
"SYSERR" |
|
}; |
|
|
|
static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = { |
|
MANDOCERR_OK, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_ERROR, |
|
MANDOCERR_FATAL, |
|
MANDOCERR_MAX, |
|
MANDOCERR_MAX |
|
}; |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
|
"ok", |
|
|
|
"generic warning", |
|
|
|
/* related to the prologue */ |
|
"no title in document", |
|
"document title should be all caps", |
|
"unknown manual section", |
|
"cannot parse date argument", |
|
"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", |
|
"blocks badly nested", |
|
"child violates parent syntax", |
|
"nested displays are not portable", |
|
"already in literal mode", |
|
|
|
/* related to missing macro arguments */ |
|
"skipping empty macro", |
|
"missing display type", |
|
"list type must come first", |
|
"tag lists require a width argument", |
|
"missing font type", |
|
|
|
/* 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", |
|
|
|
"bad table syntax", |
|
"bad table option", |
|
"bad table layout", |
|
"no table layout cells specified", |
|
"input stack limit exceeded, infinite loop?", |
|
"skipping bad character", |
|
"skipping text before the first section header", |
|
"skipping unknown macro", |
|
"NOT IMPLEMENTED: 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 void parsebuf(struct curparse *, struct buf, int); |
|
static void pdesc(struct curparse *); |
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 pfile(const char *, struct curparse *); |
static struct man *man_init(struct curparse *); |
|
static struct mdoc *mdoc_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 void pset(const char *, int, struct curparse *); |
struct man **, struct mdoc **); |
|
static int toptions(struct curparse *, char *); |
static int toptions(struct curparse *, char *); |
static void usage(void) __attribute__((noreturn)); |
static void usage(void) __attribute__((noreturn)); |
static void version(void) __attribute__((noreturn)); |
static void version(void) __attribute__((noreturn)); |
static int woptions(int *, char *); |
static int woptions(struct curparse *, char *); |
|
|
static const char *progname; |
static const char *progname; |
static int with_error; |
static enum mandoclevel file_status = MANDOCLEVEL_OK; |
static int with_warning; |
static enum mandoclevel exit_status = MANDOCLEVEL_OK; |
|
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
Line 132 main(int argc, char *argv[]) |
|
Line 249 main(int argc, char *argv[]) |
|
|
|
curp.inttype = INTT_AUTO; |
curp.inttype = INTT_AUTO; |
curp.outtype = OUTT_ASCII; |
curp.outtype = OUTT_ASCII; |
|
curp.wlevel = MANDOCLEVEL_FATAL; |
|
|
/* LINTED */ |
/* LINTED */ |
while (-1 != (c = getopt(argc, argv, "f:m:O:T:VW:"))) |
while (-1 != (c = getopt(argc, argv, "m:O:T:VW:"))) |
switch (c) { |
switch (c) { |
case ('f'): |
|
if ( ! foptions(&curp.fflags, optarg)) |
|
return(EXIT_FAILURE); |
|
break; |
|
case ('m'): |
case ('m'): |
if ( ! moptions(&curp.inttype, optarg)) |
if ( ! moptions(&curp.inttype, optarg)) |
return(EXIT_FAILURE); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
case ('O'): |
case ('O'): |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
Line 150 main(int argc, char *argv[]) |
|
Line 264 main(int argc, char *argv[]) |
|
break; |
break; |
case ('T'): |
case ('T'): |
if ( ! toptions(&curp, optarg)) |
if ( ! toptions(&curp, optarg)) |
return(EXIT_FAILURE); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
case ('W'): |
case ('W'): |
if ( ! woptions(&curp.wflags, optarg)) |
if ( ! woptions(&curp, optarg)) |
return(EXIT_FAILURE); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
case ('V'): |
case ('V'): |
version(); |
version(); |
Line 176 main(int argc, char *argv[]) |
|
Line 290 main(int argc, char *argv[]) |
|
|
|
while (*argv) { |
while (*argv) { |
ffile(*argv, &curp); |
ffile(*argv, &curp); |
|
if (MANDOCLEVEL_OK != exit_status && curp.wstop) |
if (with_error && !(curp.fflags & FL_IGN_ERRORS)) |
|
break; |
break; |
++argv; |
++argv; |
} |
} |
|
|
if (curp.outfree) |
if (curp.outfree) |
(*curp.outfree)(curp.outdata); |
(*curp.outfree)(curp.outdata); |
if (curp.mdoc) |
if (curp.pmdoc) |
mdoc_free(curp.mdoc); |
mdoc_free(curp.pmdoc); |
if (curp.man) |
if (curp.pman) |
man_free(curp.man); |
man_free(curp.pman); |
if (curp.roff) |
if (curp.roff) |
roff_free(curp.roff); |
roff_free(curp.roff); |
|
|
return((with_warning || with_error) ? |
return((int)exit_status); |
EXIT_FAILURE : EXIT_SUCCESS); |
|
} |
} |
|
|
|
|
|
|
{ |
{ |
|
|
(void)printf("%s %s\n", progname, VERSION); |
(void)printf("%s %s\n", progname, VERSION); |
exit(EXIT_SUCCESS); |
exit((int)MANDOCLEVEL_OK); |
} |
} |
|
|
|
|
|
|
usage(void) |
usage(void) |
{ |
{ |
|
|
(void)fprintf(stderr, "usage: %s [-V] [-foption] " |
(void)fprintf(stderr, "usage: %s " |
"[-mformat] [-Ooption] [-Toutput] " |
"[-V] " |
"[-Werr] [file...]\n", progname); |
"[-foption] " |
exit(EXIT_FAILURE); |
"[-mformat] " |
|
"[-Ooption] " |
|
"[-Toutput] " |
|
"[-Werr] " |
|
"[file...]\n", |
|
progname); |
|
|
|
exit((int)MANDOCLEVEL_BADARG); |
} |
} |
|
|
|
static void |
static struct man * |
ffile(const char *file, struct curparse *curp) |
man_init(struct curparse *curp) |
|
{ |
{ |
int pflags; |
|
struct man_cb mancb; |
|
|
|
mancb.man_err = merr; |
/* |
mancb.man_warn = mwarn; |
* Called once per input file. Get the file ready for reading, |
|
* pass it through to the parser-driver, then close it out. |
|
* XXX: don't do anything special as this is only called for |
|
* files; stdin goes directly to fdesc(). |
|
*/ |
|
|
/* Defaults from mandoc.1. */ |
curp->file = file; |
|
|
pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE; |
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
|
perror(curp->file); |
|
exit_status = MANDOCLEVEL_SYSERR; |
|
return; |
|
} |
|
|
if (curp->fflags & FL_NIGN_MACRO) |
fdesc(curp); |
pflags &= ~MAN_IGN_MACRO; |
|
if (curp->fflags & FL_NIGN_ESCAPE) |
|
pflags &= ~MAN_IGN_ESCAPE; |
|
|
|
return(man_alloc(curp, pflags, &mancb)); |
if (-1 == close(curp->fd)) |
|
perror(curp->file); |
} |
} |
|
|
|
static int |
static struct roff * |
pfile(const char *file, struct curparse *curp) |
roff_init(struct curparse *curp) |
|
{ |
{ |
|
const char *savefile; |
|
int fd, savefd; |
|
|
return(roff_alloc(mmsg, curp)); |
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
} |
perror(file); |
|
file_status = MANDOCLEVEL_SYSERR; |
|
return(0); |
|
} |
|
|
|
savefile = curp->file; |
|
savefd = curp->fd; |
|
|
static struct mdoc * |
curp->file = file; |
mdoc_init(struct curparse *curp) |
curp->fd = fd; |
{ |
|
int pflags; |
|
struct mdoc_cb mdoccb; |
|
|
|
mdoccb.mdoc_err = merr; |
pdesc(curp); |
mdoccb.mdoc_warn = mwarn; |
|
|
|
/* Defaults from mandoc.1. */ |
curp->file = savefile; |
|
curp->fd = savefd; |
|
|
pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE; |
if (-1 == close(fd)) |
|
perror(file); |
|
|
if (curp->fflags & FL_IGN_SCOPE) |
return(MANDOCLEVEL_FATAL > file_status ? 1 : 0); |
pflags |= MDOC_IGN_SCOPE; |
|
if (curp->fflags & FL_NIGN_ESCAPE) |
|
pflags &= ~MDOC_IGN_ESCAPE; |
|
if (curp->fflags & FL_NIGN_MACRO) |
|
pflags &= ~MDOC_IGN_MACRO; |
|
|
|
return(mdoc_alloc(curp, pflags, &mdoccb)); |
|
} |
} |
|
|
|
|
static void |
static void |
ffile(const char *file, struct curparse *curp) |
|
{ |
|
|
|
curp->file = file; |
|
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
|
perror(curp->file); |
|
with_error = 1; |
|
return; |
|
} |
|
|
|
fdesc(curp); |
|
|
|
if (-1 == close(curp->fd)) |
|
perror(curp->file); |
|
} |
|
|
|
|
|
static int |
|
resize_buf(struct buf *buf, size_t initial) |
resize_buf(struct buf *buf, size_t initial) |
{ |
{ |
void *tmp; |
|
size_t sz; |
|
|
|
if (buf->sz == 0) |
buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial; |
sz = initial; |
buf->buf = realloc(buf->buf, buf->sz); |
else |
if (NULL == buf->buf) { |
sz = 2 * buf->sz; |
|
tmp = realloc(buf->buf, sz); |
|
if (NULL == tmp) { |
|
perror(NULL); |
perror(NULL); |
return(0); |
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
buf->buf = tmp; |
|
buf->sz = sz; |
|
return(1); |
|
} |
} |
|
|
|
|
Line 318 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 411 read_whole_file(struct curparse *curp, struct buf *fb, |
|
|
|
if (-1 == fstat(curp->fd, &st)) { |
if (-1 == fstat(curp->fd, &st)) { |
perror(curp->file); |
perror(curp->file); |
with_error = 1; |
|
return(0); |
return(0); |
} |
} |
|
|
Line 333 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 425 read_whole_file(struct curparse *curp, struct buf *fb, |
|
if (st.st_size >= (1U << 31)) { |
if (st.st_size >= (1U << 31)) { |
fprintf(stderr, "%s: input too large\n", |
fprintf(stderr, "%s: input too large\n", |
curp->file); |
curp->file); |
with_error = 1; |
|
return(0); |
return(0); |
} |
} |
*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); |
} |
} |
Line 360 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 451 read_whole_file(struct curparse *curp, struct buf *fb, |
|
curp->file); |
curp->file); |
break; |
break; |
} |
} |
if (! resize_buf(fb, 65536)) |
resize_buf(fb, 65536); |
break; |
|
} |
} |
ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off); |
ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off); |
if (ssz == 0) { |
if (ssz == 0) { |
Line 377 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 467 read_whole_file(struct curparse *curp, struct buf *fb, |
|
|
|
free(fb->buf); |
free(fb->buf); |
fb->buf = NULL; |
fb->buf = NULL; |
with_error = 1; |
|
return(0); |
return(0); |
} |
} |
|
|
Line 385 read_whole_file(struct curparse *curp, struct buf *fb, |
|
Line 474 read_whole_file(struct curparse *curp, struct buf *fb, |
|
static void |
static void |
fdesc(struct curparse *curp) |
fdesc(struct curparse *curp) |
{ |
{ |
struct buf ln, blk; |
|
int i, pos, lnn, lnn_start, with_mmap, of; |
|
enum rofferr re; |
|
struct man *man; |
|
struct mdoc *mdoc; |
|
struct roff *roff; |
|
|
|
man = NULL; |
/* |
mdoc = NULL; |
* Called once per file with an opened file descriptor. All |
roff = NULL; |
* pre-file-parse operations (whether stdin or a file) should go |
memset(&ln, 0, sizeof(struct buf)); |
* here. |
|
* |
|
* This calls down into the nested parser, which drills down and |
|
* fully parses a file and all its dependences (i.e., `so'). It |
|
* then runs the cleanup validators and pushes to output. |
|
*/ |
|
|
|
/* Zero the parse type. */ |
|
|
|
curp->mdoc = NULL; |
|
curp->man = NULL; |
|
file_status = MANDOCLEVEL_OK; |
|
|
|
/* Make sure the mandotory roff parser is initialised. */ |
|
|
|
if (NULL == curp->roff) { |
|
curp->roff = roff_alloc(&curp->regs, curp, mmsg); |
|
assert(curp->roff); |
|
} |
|
|
|
/* Fully parse the file. */ |
|
|
|
pdesc(curp); |
|
|
|
if (MANDOCLEVEL_FATAL <= file_status) |
|
goto cleanup; |
|
|
|
/* NOTE a parser may not have been assigned, yet. */ |
|
|
|
if ( ! (curp->man || curp->mdoc)) { |
|
fprintf(stderr, "%s: Not a manual\n", curp->file); |
|
file_status = MANDOCLEVEL_FATAL; |
|
goto cleanup; |
|
} |
|
|
|
/* Clean up the parse routine ASTs. */ |
|
|
|
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
goto cleanup; |
|
} |
|
|
|
if (curp->man && ! man_endparse(curp->man)) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
goto cleanup; |
|
} |
|
|
|
assert(curp->roff); |
|
if ( ! roff_endparse(curp->roff)) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
goto cleanup; |
|
} |
|
|
/* |
/* |
* Two buffers: ln and buf. buf is the input file and may be |
* With -Wstop and warnings or errors of at least |
* memory mapped. ln is a line buffer and grows on-demand. |
* the requested level, do not produce output. |
*/ |
*/ |
|
|
if ( ! read_whole_file(curp, &blk, &with_mmap)) |
if (MANDOCLEVEL_OK != file_status && curp->wstop) |
|
goto cleanup; |
|
|
|
/* If unset, allocate output dev now (if applicable). */ |
|
|
|
if ( ! (curp->outman && curp->outmdoc)) { |
|
switch (curp->outtype) { |
|
case (OUTT_XHTML): |
|
curp->outdata = xhtml_alloc(curp->outopts); |
|
break; |
|
case (OUTT_HTML): |
|
curp->outdata = html_alloc(curp->outopts); |
|
break; |
|
case (OUTT_ASCII): |
|
curp->outdata = ascii_alloc(curp->outopts); |
|
curp->outfree = ascii_free; |
|
break; |
|
case (OUTT_PDF): |
|
curp->outdata = pdf_alloc(curp->outopts); |
|
curp->outfree = pspdf_free; |
|
break; |
|
case (OUTT_PS): |
|
curp->outdata = ps_alloc(curp->outopts); |
|
curp->outfree = pspdf_free; |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
switch (curp->outtype) { |
|
case (OUTT_HTML): |
|
/* FALLTHROUGH */ |
|
case (OUTT_XHTML): |
|
curp->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
|
case (OUTT_TREE): |
|
curp->outman = tree_man; |
|
curp->outmdoc = tree_mdoc; |
|
break; |
|
case (OUTT_PDF): |
|
/* FALLTHROUGH */ |
|
case (OUTT_ASCII): |
|
/* FALLTHROUGH */ |
|
case (OUTT_PS): |
|
curp->outman = terminal_man; |
|
curp->outmdoc = terminal_mdoc; |
|
break; |
|
default: |
|
break; |
|
} |
|
} |
|
|
|
/* Execute the out device, if it exists. */ |
|
|
|
if (curp->man && curp->outman) |
|
(*curp->outman)(curp->outdata, curp->man); |
|
if (curp->mdoc && curp->outmdoc) |
|
(*curp->outmdoc)(curp->outdata, curp->mdoc); |
|
|
|
cleanup: |
|
|
|
memset(&curp->regs, 0, sizeof(struct regset)); |
|
|
|
/* Reset the current-parse compilers. */ |
|
|
|
if (curp->mdoc) |
|
mdoc_reset(curp->mdoc); |
|
if (curp->man) |
|
man_reset(curp->man); |
|
|
|
assert(curp->roff); |
|
roff_reset(curp->roff); |
|
|
|
if (exit_status < file_status) |
|
exit_status = file_status; |
|
|
|
return; |
|
} |
|
|
|
static void |
|
pdesc(struct curparse *curp) |
|
{ |
|
struct buf blk; |
|
int with_mmap; |
|
|
|
/* |
|
* Run for each opened file; may be called more than once for |
|
* each full parse sequence if the opened file is nested (i.e., |
|
* from `so'). Simply sucks in the whole file and moves into |
|
* the parse phase for the file. |
|
*/ |
|
|
|
if ( ! read_whole_file(curp, &blk, &with_mmap)) { |
|
file_status = MANDOCLEVEL_SYSERR; |
return; |
return; |
|
} |
|
|
if (NULL == curp->roff) |
/* Line number is per-file. */ |
curp->roff = roff_init(curp); |
|
if (NULL == (roff = curp->roff)) |
|
goto bailout; |
|
|
|
for (i = 0, lnn = 1; i < (int)blk.sz;) { |
curp->line = 1; |
pos = 0; |
|
lnn_start = lnn; |
parsebuf(curp, blk, 1); |
while (i < (int)blk.sz) { |
|
|
if (with_mmap) |
|
munmap(blk.buf, blk.sz); |
|
else |
|
free(blk.buf); |
|
} |
|
|
|
static void |
|
parsebuf(struct curparse *curp, struct buf blk, int start) |
|
{ |
|
struct buf ln; |
|
enum rofferr rr; |
|
int i, of, rc; |
|
int pos; /* byte number in the ln buffer */ |
|
int lnn; /* line number in the real file */ |
|
unsigned char c; |
|
|
|
/* |
|
* Main parse routine for an opened file. This is called for |
|
* each opened file and simply loops around the full input file, |
|
* possibly nesting (i.e., with `so'). |
|
*/ |
|
|
|
memset(&ln, 0, sizeof(struct buf)); |
|
|
|
lnn = curp->line; |
|
pos = 0; |
|
|
|
for (i = 0; i < (int)blk.sz; ) { |
|
if (0 == pos && '\0' == blk.buf[i]) |
|
break; |
|
|
|
if (start) { |
|
curp->line = lnn; |
|
curp->reparse_count = 0; |
|
} |
|
|
|
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
if ('\n' == blk.buf[i]) { |
if ('\n' == blk.buf[i]) { |
++i; |
++i; |
++lnn; |
++lnn; |
break; |
break; |
} |
} |
/* Trailing backslash is like a plain character. */ |
|
|
/* |
|
* Warn about bogus characters. If you're using |
|
* non-ASCII encoding, you're screwing your |
|
* readers. Since I'd rather this not happen, |
|
* I'll be helpful and drop these characters so |
|
* we don't display gibberish. Note to manual |
|
* writers: use special characters. |
|
*/ |
|
|
|
c = (unsigned char) blk.buf[i]; |
|
|
|
if ( ! (isascii(c) && |
|
(isgraph(c) || isblank(c)))) { |
|
mmsg(MANDOCERR_BADCHAR, curp, |
|
curp->line, pos, "ignoring byte"); |
|
i++; |
|
continue; |
|
} |
|
|
|
/* Trailing backslash = a plain char. */ |
|
|
if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { |
if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { |
if (pos >= (int)ln.sz) |
if (pos >= (int)ln.sz) |
if (! resize_buf(&ln, 256)) |
resize_buf(&ln, 256); |
goto bailout; |
|
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
continue; |
continue; |
} |
} |
/* Found an escape and at least one other character. */ |
|
|
/* Found escape & at least one other char. */ |
|
|
if ('\n' == blk.buf[i + 1]) { |
if ('\n' == blk.buf[i + 1]) { |
/* Escaped newlines are skipped over */ |
|
i += 2; |
i += 2; |
|
/* Escaped newlines are skipped over */ |
++lnn; |
++lnn; |
continue; |
continue; |
} |
} |
|
|
if ('"' == blk.buf[i + 1]) { |
if ('"' == blk.buf[i + 1]) { |
i += 2; |
i += 2; |
/* Comment, skip to end of line */ |
/* Comment, skip to end of line */ |
Line 444 fdesc(struct curparse *curp) |
|
Line 731 fdesc(struct curparse *curp) |
|
break; |
break; |
} |
} |
} |
} |
|
|
/* Backout trailing whitespaces */ |
/* Backout trailing whitespaces */ |
for (; pos > 0; --pos) { |
for (; pos > 0; --pos) { |
if (ln.buf[pos - 1] != ' ') |
if (ln.buf[pos - 1] != ' ') |
Line 453 fdesc(struct curparse *curp) |
|
Line 741 fdesc(struct curparse *curp) |
|
} |
} |
break; |
break; |
} |
} |
/* Some other escape sequence, copy and continue. */ |
|
|
/* Some other escape sequence, copy & cont. */ |
|
|
if (pos + 1 >= (int)ln.sz) |
if (pos + 1 >= (int)ln.sz) |
if (! resize_buf(&ln, 256)) |
resize_buf(&ln, 256); |
goto bailout; |
|
|
|
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
} |
} |
|
|
if (pos >= (int)ln.sz) |
if (pos >= (int)ln.sz) |
if (! resize_buf(&ln, 256)) |
resize_buf(&ln, 256); |
goto bailout; |
|
ln.buf[pos] = '\0'; |
ln.buf[pos] = '\0'; |
|
|
/* |
/* |
Line 477 fdesc(struct curparse *curp) |
|
Line 766 fdesc(struct curparse *curp) |
|
*/ |
*/ |
|
|
of = 0; |
of = 0; |
do { |
|
re = roff_parseln(roff, lnn_start, |
|
&ln.buf, &ln.sz, of, &of); |
|
} while (ROFF_RERUN == re); |
|
|
|
if (ROFF_IGN == re) |
rerun: |
|
rr = roff_parseln |
|
(curp->roff, curp->line, |
|
&ln.buf, &ln.sz, of, &of); |
|
|
|
switch (rr) { |
|
case (ROFF_REPARSE): |
|
if (REPARSE_LIMIT >= ++curp->reparse_count) |
|
parsebuf(curp, ln, 0); |
|
else |
|
mmsg(MANDOCERR_ROFFLOOP, curp, |
|
curp->line, pos, NULL); |
|
pos = 0; |
continue; |
continue; |
else if (ROFF_ERR == re) |
case (ROFF_APPEND): |
goto bailout; |
pos = strlen(ln.buf); |
|
continue; |
|
case (ROFF_RERUN): |
|
goto rerun; |
|
case (ROFF_IGN): |
|
pos = 0; |
|
continue; |
|
case (ROFF_ERR): |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
|
case (ROFF_SO): |
|
if (pfile(ln.buf + of, curp)) { |
|
pos = 0; |
|
continue; |
|
} else |
|
break; |
|
case (ROFF_CONT): |
|
break; |
|
} |
|
|
/* |
/* |
* If input parsers have not been allocated, do so now. |
* If input parsers have not been allocated, do so now. |
Line 494 fdesc(struct curparse *curp) |
|
Line 809 fdesc(struct curparse *curp) |
|
* parsers with each one. |
* parsers with each one. |
*/ |
*/ |
|
|
if ( ! (man || mdoc)) |
if ( ! (curp->man || curp->mdoc)) |
if ( ! pset(ln.buf + of, pos - of, curp, &man, &mdoc)) |
pset(ln.buf + of, pos - of, curp); |
goto bailout; |
|
|
|
/* Lastly, push down into the parsers themselves. */ |
/* |
|
* Lastly, push down into the parsers themselves. One |
|
* of these will have already been set in the pset() |
|
* routine. |
|
*/ |
|
|
if (man && ! man_parseln(man, lnn_start, ln.buf, of)) |
if (curp->man || curp->mdoc) { |
goto bailout; |
rc = curp->man ? |
if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of)) |
man_parseln(curp->man, |
goto bailout; |
curp->line, ln.buf, of) : |
} |
mdoc_parseln(curp->mdoc, |
|
curp->line, ln.buf, of); |
|
|
/* NOTE a parser may not have been assigned, yet. */ |
if ( ! rc) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
|
} |
|
} |
|
|
if ( ! (man || mdoc)) { |
/* Temporary buffers typically are not full. */ |
fprintf(stderr, "%s: Not a manual\n", curp->file); |
|
goto bailout; |
|
} |
|
|
|
/* Clean up the parse routine ASTs. */ |
if (0 == start && '\0' == blk.buf[i]) |
|
break; |
|
|
if (mdoc && ! mdoc_endparse(mdoc)) |
/* Start the next input line. */ |
goto bailout; |
|
if (man && ! man_endparse(man)) |
|
goto bailout; |
|
if (roff && ! roff_endparse(roff)) |
|
goto bailout; |
|
|
|
/* If unset, allocate output dev now (if applicable). */ |
pos = 0; |
|
|
if ( ! (curp->outman && curp->outmdoc)) { |
|
switch (curp->outtype) { |
|
case (OUTT_XHTML): |
|
curp->outdata = xhtml_alloc(curp->outopts); |
|
curp->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
|
case (OUTT_HTML): |
|
curp->outdata = html_alloc(curp->outopts); |
|
curp->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
|
case (OUTT_TREE): |
|
curp->outman = tree_man; |
|
curp->outmdoc = tree_mdoc; |
|
break; |
|
case (OUTT_LINT): |
|
break; |
|
default: |
|
curp->outdata = ascii_alloc(80); |
|
curp->outman = terminal_man; |
|
curp->outmdoc = terminal_mdoc; |
|
curp->outfree = terminal_free; |
|
break; |
|
} |
|
} |
} |
|
|
/* Execute the out device, if it exists. */ |
free(ln.buf); |
|
|
if (man && curp->outman) |
|
(*curp->outman)(curp->outdata, man); |
|
if (mdoc && curp->outmdoc) |
|
(*curp->outmdoc)(curp->outdata, mdoc); |
|
|
|
cleanup: |
|
if (mdoc) |
|
mdoc_reset(mdoc); |
|
if (man) |
|
man_reset(man); |
|
if (roff) |
|
roff_reset(roff); |
|
if (ln.buf) |
|
free(ln.buf); |
|
if (with_mmap) |
|
munmap(blk.buf, blk.sz); |
|
else |
|
free(blk.buf); |
|
|
|
return; |
|
|
|
bailout: |
|
with_error = 1; |
|
goto cleanup; |
|
} |
} |
|
|
|
static void |
static int |
pset(const char *buf, int pos, struct curparse *curp) |
pset(const char *buf, int pos, struct curparse *curp, |
|
struct man **man, struct mdoc **mdoc) |
|
{ |
{ |
int i; |
int i; |
|
|
Line 594 pset(const char *buf, int pos, struct curparse *curp, |
|
Line 855 pset(const char *buf, int pos, struct curparse *curp, |
|
* explicitly. If passed as -mandoc, then try to guess from the |
* explicitly. If passed as -mandoc, then try to guess from the |
* line: either skip dot-lines, use -mdoc when finding `.Dt', or |
* line: either skip dot-lines, use -mdoc when finding `.Dt', or |
* default to -man, which is more lenient. |
* default to -man, which is more lenient. |
|
* |
|
* Separate out pmdoc/pman from mdoc/man: the first persists |
|
* through all parsers, while the latter is used per-parse. |
*/ |
*/ |
|
|
if ('.' == buf[0] || '\'' == 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; |
if (0 == buf[i]) |
if ('\0' == buf[i]) |
return(1); |
return; |
} |
} |
|
|
switch (curp->inttype) { |
switch (curp->inttype) { |
case (INTT_MDOC): |
case (INTT_MDOC): |
if (NULL == curp->mdoc) |
if (NULL == curp->pmdoc) |
curp->mdoc = mdoc_init(curp); |
curp->pmdoc = mdoc_alloc |
if (NULL == (*mdoc = curp->mdoc)) |
(&curp->regs, curp, mmsg); |
return(0); |
assert(curp->pmdoc); |
return(1); |
curp->mdoc = curp->pmdoc; |
|
return; |
case (INTT_MAN): |
case (INTT_MAN): |
if (NULL == curp->man) |
if (NULL == curp->pman) |
curp->man = man_init(curp); |
curp->pman = man_alloc |
if (NULL == (*man = curp->man)) |
(&curp->regs, curp, mmsg); |
return(0); |
assert(curp->pman); |
return(1); |
curp->man = curp->pman; |
|
return; |
default: |
default: |
break; |
break; |
} |
} |
|
|
if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { |
if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { |
if (NULL == curp->mdoc) |
if (NULL == curp->pmdoc) |
curp->mdoc = mdoc_init(curp); |
curp->pmdoc = mdoc_alloc |
if (NULL == (*mdoc = curp->mdoc)) |
(&curp->regs, curp, mmsg); |
return(0); |
assert(curp->pmdoc); |
return(1); |
curp->mdoc = curp->pmdoc; |
|
return; |
} |
} |
|
|
if (NULL == curp->man) |
if (NULL == curp->pman) |
curp->man = man_init(curp); |
curp->pman = man_alloc(&curp->regs, curp, mmsg); |
if (NULL == (*man = curp->man)) |
assert(curp->pman); |
return(0); |
curp->man = curp->pman; |
return(1); |
|
} |
} |
|
|
|
|
static int |
static int |
moptions(enum intt *tflags, char *arg) |
moptions(enum intt *tflags, char *arg) |
{ |
{ |
Line 655 moptions(enum intt *tflags, char *arg) |
|
Line 920 moptions(enum intt *tflags, char *arg) |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
toptions(struct curparse *curp, char *arg) |
toptions(struct curparse *curp, char *arg) |
{ |
{ |
Line 664 toptions(struct curparse *curp, char *arg) |
|
Line 928 toptions(struct curparse *curp, char *arg) |
|
curp->outtype = OUTT_ASCII; |
curp->outtype = OUTT_ASCII; |
else if (0 == strcmp(arg, "lint")) { |
else if (0 == strcmp(arg, "lint")) { |
curp->outtype = OUTT_LINT; |
curp->outtype = OUTT_LINT; |
curp->wflags |= WARN_WALL; |
curp->wlevel = MANDOCLEVEL_WARNING; |
curp->fflags |= FL_STRICT; |
|
} |
} |
else if (0 == strcmp(arg, "tree")) |
else if (0 == strcmp(arg, "tree")) |
curp->outtype = OUTT_TREE; |
curp->outtype = OUTT_TREE; |
Line 673 toptions(struct curparse *curp, char *arg) |
|
Line 936 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 if (0 == strcmp(arg, "pdf")) |
|
curp->outtype = OUTT_PDF; |
else { |
else { |
fprintf(stderr, "%s: Bad argument\n", arg); |
fprintf(stderr, "%s: Bad argument\n", arg); |
return(0); |
return(0); |
Line 681 toptions(struct curparse *curp, char *arg) |
|
Line 948 toptions(struct curparse *curp, char *arg) |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
foptions(int *fflags, char *arg) |
woptions(struct curparse *curp, char *arg) |
{ |
{ |
char *v, *o; |
char *v, *o; |
const char *toks[8]; |
const char *toks[6]; |
|
|
toks[0] = "ign-scope"; |
toks[0] = "stop"; |
toks[1] = "no-ign-escape"; |
toks[1] = "all"; |
toks[2] = "no-ign-macro"; |
toks[2] = "warning"; |
toks[3] = "ign-errors"; |
toks[3] = "error"; |
toks[4] = "strict"; |
toks[4] = "fatal"; |
toks[5] = "ign-escape"; |
toks[5] = NULL; |
toks[6] = NULL; |
|
|
|
while (*arg) { |
while (*arg) { |
o = arg; |
o = arg; |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
case (0): |
case (0): |
*fflags |= FL_IGN_SCOPE; |
curp->wstop = 1; |
break; |
break; |
case (1): |
case (1): |
*fflags |= FL_NIGN_ESCAPE; |
/* FALLTHROUGH */ |
break; |
|
case (2): |
case (2): |
*fflags |= FL_NIGN_MACRO; |
curp->wlevel = MANDOCLEVEL_WARNING; |
break; |
break; |
case (3): |
case (3): |
*fflags |= FL_IGN_ERRORS; |
curp->wlevel = MANDOCLEVEL_ERROR; |
break; |
break; |
case (4): |
case (4): |
*fflags |= FL_STRICT; |
curp->wlevel = MANDOCLEVEL_FATAL; |
break; |
break; |
case (5): |
|
*fflags &= ~FL_NIGN_ESCAPE; |
|
break; |
|
default: |
default: |
fprintf(stderr, "%s: Bad argument\n", o); |
fprintf(stderr, "-W%s: Bad argument\n", o); |
return(0); |
return(0); |
} |
} |
} |
} |
Line 726 foptions(int *fflags, char *arg) |
|
Line 987 foptions(int *fflags, char *arg) |
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
woptions(int *wflags, char *arg) |
|
{ |
|
char *v, *o; |
|
const char *toks[3]; |
|
|
|
toks[0] = "all"; |
|
toks[1] = "error"; |
|
toks[2] = NULL; |
|
|
|
while (*arg) { |
|
o = arg; |
|
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
|
case (0): |
|
*wflags |= WARN_WALL; |
|
break; |
|
case (1): |
|
*wflags |= WARN_WERR; |
|
break; |
|
default: |
|
fprintf(stderr, "%s: Bad argument\n", o); |
|
return(0); |
|
} |
|
} |
|
|
|
return(1); |
|
} |
|
|
|
|
|
/* ARGSUSED */ |
|
static int |
|
merr(void *arg, int line, int col, const char *msg) |
|
{ |
|
struct curparse *curp; |
|
|
|
curp = (struct curparse *)arg; |
|
|
|
(void)fprintf(stderr, "%s:%d:%d: error: %s\n", |
|
curp->file, line, col + 1, msg); |
|
|
|
with_error = 1; |
|
|
|
return(0); |
|
} |
|
|
|
|
|
static int |
|
mwarn(void *arg, int line, int col, const char *msg) |
|
{ |
|
struct curparse *curp; |
|
|
|
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; |
|
return(0); |
|
} |
|
|
|
return(1); |
|
} |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
|
"ok", |
|
"multi-line scope open on exit", |
|
"request for scope closure when no matching scope is open", |
|
"line arguments will be lost", |
|
"memory exhausted" |
|
}; |
|
|
|
/* |
|
* 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) |
mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) |
{ |
{ |
#if 0 |
|
struct curparse *cp; |
struct curparse *cp; |
|
enum mandoclevel level; |
|
|
|
level = MANDOCLEVEL_FATAL; |
|
while (t < mandoclimits[level]) |
|
/* LINTED */ |
|
level--; |
|
|
cp = (struct curparse *)arg; |
cp = (struct curparse *)arg; |
|
if (level < cp->wlevel) |
|
return(1); |
|
|
fprintf(stderr, "%s:%d:%d: %s", cp->file, |
fprintf(stderr, "%s:%d:%d: %s: %s", |
ln, col + 1, mandocerrs[t]); |
cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]); |
|
|
if (msg) |
if (msg) |
fprintf(stderr, ": %s", msg); |
fprintf(stderr, ": %s", msg); |
|
|
fputc('\n', stderr); |
fputc('\n', stderr); |
#endif |
|
return(1); |
if (file_status < level) |
|
file_status = level; |
|
|
|
return(level < MANDOCLEVEL_FATAL); |
} |
} |