-/* $Id: main.c,v 1.66 2010/05/15 05:11:50 kristaps Exp $ */
+/* $Id: main.c,v 1.101 2010/07/29 22:00:39 joerg Exp $ */
/*
- * 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
* purpose with or without fee is hereby granted, provided that the above
#include <sys/stat.h>
#include <assert.h>
+#include <ctype.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <unistd.h>
+#include "mandoc.h"
+#include "main.h"
#include "mdoc.h"
#include "man.h"
-#include "main.h"
+#include "roff.h"
+
+#ifndef MAP_FILE
+#define MAP_FILE 0
+#endif
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a))
OUTT_TREE,
OUTT_HTML,
OUTT_XHTML,
- OUTT_LINT
+ OUTT_LINT,
+ OUTT_PS,
+ OUTT_PDF
};
struct curparse {
const char *file; /* Current parse. */
int fd; /* Current parse. */
int wflags;
+ /* FIXME: set by max error */
#define WARN_WALL (1 << 0) /* All-warnings mask. */
#define WARN_WERR (1 << 2) /* Warnings->errors. */
int fflags;
#define FL_NIGN_MACRO (1 << 2) /* Don't ignore bad macros. */
#define FL_IGN_ERRORS (1 << 4) /* Ignore failed parse. */
#define FL_STRICT FL_NIGN_ESCAPE | \
- FL_NIGN_MACRO
- enum intt inttype; /* Input parsers... */
- struct man *man;
- struct mdoc *mdoc;
- enum outt outtype; /* Output devices... */
- out_mdoc outmdoc;
- out_man outman;
- out_free outfree;
- void *outdata;
- char outopts[BUFSIZ];
+ FL_NIGN_MACRO /* ignore nothing */
+ enum intt inttype; /* which parser to use */
+ struct man *man; /* man parser */
+ struct mdoc *mdoc; /* mdoc parser */
+ struct roff *roff; /* roff parser (!NULL) */
+ struct regset regs; /* roff registers */
+ enum outt outtype; /* which output to use */
+ out_mdoc outmdoc; /* mdoc output ptr */
+ out_man outman; /* man output ptr */
+ out_free outfree; /* free output ptr */
+ void *outdata; /* data for output */
+ char outopts[BUFSIZ]; /* buf of output opts */
+};
+
+static const char * const mandocerrs[MANDOCERR_MAX] = {
+ "ok",
+
+ "generic warning",
+
+ "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",
+ "tab in non-literal context",
+ "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",
+ "blocks badly nested",
+ "scope open on exit",
+
+ "generic error",
+
+ "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",
+ "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",
+ "missing font type",
+ "line argument(s) will be lost",
+ "body argument(s) will be lost",
+
+ "generic fatal error",
+
+ "column syntax is inconsistent",
+ "displays may not be nested",
+ "unsupported display type",
+ "blocks badly nested",
+ "no such block is open",
+ "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 int foptions(int *, char *);
static struct man *man_init(struct curparse *);
static struct mdoc *mdoc_init(struct curparse *);
-static int merr(void *, int, int, const char *);
+static struct roff *roff_init(struct curparse *);
static int moptions(enum intt *, char *);
-static int mwarn(void *, int, int, const char *);
+static int mmsg(enum mandocerr, void *,
+ int, int, const char *);
static int pset(const char *, int, struct curparse *,
struct man **, struct mdoc **);
static int toptions(struct curparse *, char *);
static int woptions(int *, char *);
static const char *progname;
-static int with_error;
-static int with_warning;
+static int with_fatal;
+static int with_error;
int
main(int argc, char *argv[])
while (*argv) {
ffile(*argv, &curp);
- if (with_error && !(curp.fflags & FL_IGN_ERRORS))
+ if (with_fatal && !(curp.fflags & FL_IGN_ERRORS))
break;
++argv;
}
if (curp.outfree)
(*curp.outfree)(curp.outdata);
-
- return((with_warning || with_error) ?
+ if (curp.mdoc)
+ mdoc_free(curp.mdoc);
+ if (curp.man)
+ man_free(curp.man);
+ if (curp.roff)
+ roff_free(curp.roff);
+
+ return((with_fatal || with_error) ?
EXIT_FAILURE : EXIT_SUCCESS);
}
man_init(struct curparse *curp)
{
int pflags;
- struct man_cb mancb;
-
- mancb.man_err = merr;
- mancb.man_warn = mwarn;
/* Defaults from mandoc.1. */
if (curp->fflags & FL_NIGN_ESCAPE)
pflags &= ~MAN_IGN_ESCAPE;
- return(man_alloc(curp, pflags, &mancb));
+ return(man_alloc(&curp->regs, curp, pflags, mmsg));
+}
+
+
+static struct roff *
+roff_init(struct curparse *curp)
+{
+
+ return(roff_alloc(&curp->regs, mmsg, curp));
}
mdoc_init(struct curparse *curp)
{
int pflags;
- struct mdoc_cb mdoccb;
-
- mdoccb.mdoc_err = merr;
- mdoccb.mdoc_warn = mwarn;
/* Defaults from mandoc.1. */
if (curp->fflags & FL_NIGN_MACRO)
pflags &= ~MDOC_IGN_MACRO;
- return(mdoc_alloc(curp, pflags, &mdoccb));
+ return(mdoc_alloc(&curp->regs, curp, pflags, mmsg));
}
curp->file = file;
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
perror(curp->file);
- with_error = 1;
+ with_fatal = 1;
return;
}
}
+static int
+resize_buf(struct buf *buf, size_t initial)
+{
+ void *tmp;
+ size_t sz;
+
+ if (buf->sz == 0)
+ sz = initial;
+ else
+ sz = 2 * buf->sz;
+ tmp = realloc(buf->buf, sz);
+ if (NULL == tmp) {
+ perror(NULL);
+ return(0);
+ }
+ buf->buf = tmp;
+ buf->sz = sz;
+ return(1);
+}
+
+
static int
read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
{
struct stat st;
- char *buf;
- size_t sz, off;
+ size_t off;
ssize_t ssz;
if (-1 == fstat(curp->fd, &st)) {
perror(curp->file);
- with_error = 1;
+ with_fatal = 1;
return(0);
}
if (st.st_size >= (1U << 31)) {
fprintf(stderr, "%s: input too large\n",
curp->file);
- with_error = 1;
+ with_fatal = 1;
return(0);
}
*with_mmap = 1;
- fb->sz = st.st_size;
+ fb->sz = (size_t)st.st_size;
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)
return(1);
}
curp->file);
break;
}
- if (fb->sz == 0)
- sz = 65536;
- else
- sz = 2 * fb->sz;
- buf = realloc(fb->buf, sz);
- if (NULL == buf) {
- perror(NULL);
+ if (! resize_buf(fb, 65536))
break;
- }
- fb->buf = buf;
- fb->sz = sz;
}
- ssz = read(curp->fd, fb->buf + off, fb->sz - off);
+ ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off);
if (ssz == 0) {
fb->sz = off;
return(1);
perror(curp->file);
break;
}
- off += ssz;
+ off += (size_t)ssz;
}
free(fb->buf);
fb->buf = NULL;
- with_error = 1;
+ with_fatal = 1;
return(0);
}
static void
fdesc(struct curparse *curp)
{
- size_t sz;
struct buf ln, blk;
- int j, i, pos, lnn, comment, with_mmap;
+ int i, pos, lnn, lnn_start, with_mmap, of;
+ enum rofferr re;
struct man *man;
struct mdoc *mdoc;
+ struct roff *roff;
- sz = BUFSIZ;
man = NULL;
mdoc = NULL;
+ roff = NULL;
+
memset(&ln, 0, sizeof(struct buf));
/*
- * Two buffers: ln and buf. buf is the input buffer optimised
- * here for each file's block size. ln is a line buffer. Both
- * growable, hence passed in by ptr-ptr.
+ * Two buffers: ln and buf. buf is the input file and may be
+ * memory mapped. ln is a line buffer and grows on-demand.
*/
- if (!read_whole_file(curp, &blk, &with_mmap))
+ if ( ! read_whole_file(curp, &blk, &with_mmap))
return;
- /* Fill buf with file blocksize. */
+ if (NULL == curp->roff)
+ curp->roff = roff_init(curp);
+ if (NULL == (roff = curp->roff))
+ goto bailout;
- for (i = lnn = pos = comment = 0; i < (int)blk.sz; ++i) {
- if (pos >= (int)ln.sz) {
- ln.sz += 256; /* Step-size. */
- ln.buf = realloc(ln.buf, ln.sz);
- if (NULL == ln.buf) {
- perror(NULL);
- goto bailout;
- }
+ for (i = 0, lnn = 1; i < (int)blk.sz;) {
+ pos = 0;
+ lnn_start = lnn;
+ while (i < (int)blk.sz) {
+ if ('\n' == blk.buf[i]) {
+ ++i;
+ ++lnn;
+ break;
}
- if ('\n' != blk.buf[i]) {
- if (comment)
- continue;
- ln.buf[pos++] = blk.buf[i];
-
- /* Handle in-line `\"' comments. */
-
- if (1 == pos || '\"' != ln.buf[pos - 1])
- continue;
+ /*
+ * 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.
+ */
+
+ if ( ! isgraph((u_char)blk.buf[i]) &&
+ ! isblank((u_char)blk.buf[i])) {
+ if ( ! mmsg(MANDOCERR_BADCHAR, curp,
+ lnn_start, pos,
+ "ignoring byte"))
+ goto bailout;
+ i++;
+ continue;
+ }
- for (j = pos - 2; j >= 0; j--)
- if ('\\' != ln.buf[j])
+ /* Trailing backslash is like a plain character. */
+ if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
+ if (pos >= (int)ln.sz)
+ if (! resize_buf(&ln, 256))
+ goto bailout;
+ ln.buf[pos++] = blk.buf[i++];
+ continue;
+ }
+ /* Found an escape and at least one other character. */
+ if ('\n' == blk.buf[i + 1]) {
+ /* Escaped newlines are skipped over */
+ i += 2;
+ ++lnn;
+ continue;
+ }
+ if ('"' == blk.buf[i + 1]) {
+ i += 2;
+ /* Comment, skip to end of line */
+ for (; i < (int)blk.sz; ++i) {
+ if ('\n' == blk.buf[i]) {
+ ++i;
+ ++lnn;
break;
-
- if ( ! ((pos - 2 - j) % 2))
- continue;
-
- comment = 1;
- pos -= 2;
+ }
+ }
+ /* Backout trailing whitespaces */
for (; pos > 0; --pos) {
if (ln.buf[pos - 1] != ' ')
break;
if (pos > 2 && ln.buf[pos - 2] == '\\')
break;
}
- continue;
- }
-
- /* Handle escaped `\\n' newlines. */
-
- if (pos > 0 && 0 == comment &&
- '\\' == ln.buf[pos - 1]) {
- for (j = pos - 1; j >= 0; j--)
- if ('\\' != ln.buf[j])
- break;
- if ( ! ((pos - j) % 2)) {
- pos--;
- lnn++;
- continue;
- }
+ break;
}
+ /* Some other escape sequence, copy and continue. */
+ if (pos + 1 >= (int)ln.sz)
+ if (! resize_buf(&ln, 256))
+ goto bailout;
- ln.buf[pos] = 0;
- lnn++;
-
- /* If unset, assign parser in pset(). */
+ ln.buf[pos++] = blk.buf[i++];
+ ln.buf[pos++] = blk.buf[i++];
+ }
- if ( ! (man || mdoc) && ! pset(ln.buf,
- pos, curp, &man, &mdoc))
+ if (pos >= (int)ln.sz)
+ if (! resize_buf(&ln, 256))
+ goto bailout;
+ ln.buf[pos] = '\0';
+
+ /*
+ * 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, lnn_start,
+ &ln.buf, &ln.sz, of, &of);
+ } while (ROFF_RERUN == re);
+
+ if (ROFF_IGN == re)
+ continue;
+ else if (ROFF_ERR == re)
+ goto bailout;
+
+ /*
+ * 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))
+ if ( ! pset(ln.buf + of, pos - of, curp, &man, &mdoc))
goto bailout;
- pos = comment = 0;
-
- /* Pass down into parsers. */
+ /* Lastly, push down into the parsers themselves. */
- if (man && ! man_parseln(man, lnn, ln.buf))
- goto bailout;
- if (mdoc && ! mdoc_parseln(mdoc, lnn, ln.buf))
- goto bailout;
+ if (man && ! man_parseln(man, lnn_start, ln.buf, of))
+ goto bailout;
+ if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of))
+ goto bailout;
}
/* NOTE a parser may not have been assigned, yet. */
goto bailout;
}
+ /* Clean up the parse routine ASTs. */
+
if (mdoc && ! mdoc_endparse(mdoc))
goto bailout;
if (man && ! man_endparse(man))
goto bailout;
+ if (roff && ! roff_endparse(roff))
+ goto bailout;
/* If unset, allocate output dev now (if applicable). */
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);
+ 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;
curp->outman = tree_man;
curp->outmdoc = tree_mdoc;
break;
- case (OUTT_LINT):
- break;
- default:
- curp->outdata = ascii_alloc();
+ case (OUTT_PDF):
+ /* FALLTHROUGH */
+ case (OUTT_ASCII):
+ /* FALLTHROUGH */
+ case (OUTT_PS):
curp->outman = terminal_man;
curp->outmdoc = terminal_mdoc;
- curp->outfree = terminal_free;
+ break;
+ default:
break;
}
}
(*curp->outmdoc)(curp->outdata, mdoc);
cleanup:
- if (curp->mdoc) {
- mdoc_free(curp->mdoc);
- curp->mdoc = NULL;
- }
- if (curp->man) {
- man_free(curp->man);
- curp->man = NULL;
- }
+ memset(&curp->regs, 0, sizeof(struct regset));
+ 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;
+ with_fatal = 1;
goto cleanup;
}
* default to -man, which is more lenient.
*/
- if (buf[0] == '.') {
+ if ('.' == buf[0] || '\'' == buf[0]) {
for (i = 1; buf[i]; i++)
if (' ' != buf[i] && '\t' != buf[i])
break;
curp->outtype = OUTT_HTML;
else if (0 == strcmp(arg, "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 {
fprintf(stderr, "%s: Bad argument\n", arg);
return(0);
}
-/* ARGSUSED */
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;
-
- 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);
+ struct curparse *cp;
+ const char *level;
+ int rc;
+
+ cp = (struct curparse *)arg;
+ level = NULL;
+ rc = 1;
+
+ if (t >= MANDOCERR_FATAL) {
+ with_fatal = 1;
+ level = "FATAL";
+ rc = 0;
+ } else {
+ if ( ! (WARN_WALL & cp->wflags))
+ return(1);
+ if (t >= MANDOCERR_ERROR) {
+ with_error = 1;
+ level = "ERROR";
+ }
+ if (WARN_WERR & cp->wflags) {
+ with_fatal = 1;
+ rc = 0;
+ }
}
- return(1);
-}
+ fprintf(stderr, "%s:%d:%d:", cp->file, ln, col + 1);
+ if (level)
+ fprintf(stderr, " %s:", level);
+ fprintf(stderr, " %s", mandocerrs[t]);
+ if (msg)
+ fprintf(stderr, ": %s", msg);
+ fputc('\n', stderr);
+ return(rc);
+}
git.ckatri.com / mandoc.git / blobdiff