-/* $Id: mdoc.c,v 1.123 2010/04/08 07:53:01 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.159 2010/07/18 17:00:26 schwarze 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 <string.h>
#include <time.h>
+#include "mandoc.h"
#include "libmdoc.h"
#include "libmandoc.h"
-const char *const __mdoc_merrnames[MERRMAX] = {
- "trailing whitespace", /* ETAILWS */
- "unexpected quoted parameter", /* EQUOTPARM */
- "unterminated quoted parameter", /* EQUOTTERM */
- "argument parameter suggested", /* EARGVAL */
- "macro disallowed in prologue", /* EBODYPROL */
- "macro disallowed in body", /* EPROLBODY */
- "text disallowed in prologue", /* ETEXTPROL */
- "blank line disallowed", /* ENOBLANK */
- "text parameter too long", /* ETOOLONG */
- "invalid escape sequence", /* EESCAPE */
- "invalid character", /* EPRINT */
- "document has no body", /* ENODAT */
- "document has no prologue", /* ENOPROLOGUE */
- "expected line arguments", /* ELINE */
- "invalid AT&T argument", /* EATT */
- "default name not yet set", /* ENAME */
- "missing list type", /* ELISTTYPE */
- "missing display type", /* EDISPTYPE */
- "too many display types", /* EMULTIDISP */
- "too many list types", /* EMULTILIST */
- "NAME section must be first", /* ESECNAME */
- "badly-formed NAME section", /* ENAMESECINC */
- "argument repeated", /* EARGREP */
- "expected boolean parameter", /* EBOOL */
- "inconsistent column syntax", /* ECOLMIS */
- "nested display invalid", /* ENESTDISP */
- "width argument missing", /* EMISSWIDTH */
- "invalid section for this manual section", /* EWRONGMSEC */
- "section out of conventional order", /* ESECOOO */
- "section repeated", /* ESECREP */
- "invalid standard argument", /* EBADSTAND */
- "multi-line arguments discouraged", /* ENOMULTILINE */
- "multi-line arguments suggested", /* EMULTILINE */
- "line arguments discouraged", /* ENOLINE */
- "prologue macro out of conventional order", /* EPROLOOO */
- "prologue macro repeated", /* EPROLREP */
- "invalid manual section", /* EBADMSEC */
- "invalid section", /* EBADSEC */
- "invalid font mode", /* EFONT */
- "invalid date syntax", /* EBADDATE */
- "invalid number format", /* ENUMFMT */
- "superfluous width argument", /* ENOWIDTH */
- "system: utsname error", /* EUTSNAME */
- "obsolete macro", /* EOBS */
- "end-of-line scope violation", /* EIMPBRK */
- "empty macro ignored", /* EIGNE */
- "unclosed explicit scope", /* EOPEN */
- "unterminated quoted phrase", /* EQUOTPHR */
- "closure macro without prior context", /* ENOCTX */
- "no description found for library", /* ELIB */
- "bad child for parent context", /* EBADCHILD */
- "list arguments preceding type", /* ENOTYPE */
- "deprecated comment style", /* EBADCOMMENT */
-};
-
const char *const __mdoc_macronames[MDOC_MAX] = {
"Ap", "Dd", "Dt", "Os",
"Sh", "Ss", "Pp", "D1",
/* LINTED */
"Dx", "%Q", "br", "sp",
/* LINTED */
- "%U"
+ "%U", "Ta"
};
const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
enum mdoct, enum mdoc_type);
static int node_append(struct mdoc *,
struct mdoc_node *);
-static int mdoc_ptext(struct mdoc *, int, char *);
-static int mdoc_pmacro(struct mdoc *, int, char *);
-static int macrowarn(struct mdoc *, int, const char *);
-static int pstring(struct mdoc *, int, int,
- const char *, size_t);
+static int mdoc_ptext(struct mdoc *, int, char *, int);
+static int mdoc_pmacro(struct mdoc *, int, char *, int);
+static int macrowarn(struct mdoc *, int,
+ const char *, int);
+
const struct mdoc_node *
mdoc_node(const struct mdoc *m)
free(mdoc->meta.arch);
if (mdoc->meta.vol)
free(mdoc->meta.vol);
+ if (mdoc->meta.msec)
+ free(mdoc->meta.msec);
}
* Allocate volatile and non-volatile parse resources.
*/
struct mdoc *
-mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
+mdoc_alloc(struct regset *regs, void *data,
+ int pflags, mandocmsg msg)
{
struct mdoc *p;
p = mandoc_calloc(1, sizeof(struct mdoc));
- if (cb)
- memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
-
+ p->msg = msg;
p->data = data;
p->pflags = pflags;
+ p->regs = regs;
mdoc_hash_init();
mdoc_alloc1(p);
* the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
*/
int
-mdoc_parseln(struct mdoc *m, int ln, char *buf)
+mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
{
if (MDOC_HALT & m->flags)
return(0);
- return('.' == *buf ? mdoc_pmacro(m, ln, buf) :
- mdoc_ptext(m, ln, buf));
-}
-
+ m->flags |= MDOC_NEWLINE;
-int
-mdoc_verr(struct mdoc *mdoc, int ln, int pos,
- const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
-
- if (NULL == mdoc->cb.mdoc_err)
- return(0);
-
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
+ /*
+ * Let the roff nS register switch SYNOPSIS mode early,
+ * such that the parser knows at all times
+ * whether this mode is on or off.
+ * Note that this mode is also switched by the Sh macro.
+ */
+ if (m->regs->regs[(int)REG_nS].set) {
+ if (m->regs->regs[(int)REG_nS].v.u)
+ m->flags |= MDOC_SYNOPSIS;
+ else
+ m->flags &= ~MDOC_SYNOPSIS;
+ }
- return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
+ return(('.' == buf[offs] || '\'' == buf[offs]) ?
+ mdoc_pmacro(m, ln, buf, offs) :
+ mdoc_ptext(m, ln, buf, offs));
}
int
-mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
+mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
+ int ln, int pos, const char *fmt, ...)
{
char buf[256];
va_list ap;
- if (NULL == mdoc->cb.mdoc_warn)
- return(0);
-
va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
+ vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
va_end(ap);
- return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
-}
-
-
-int
-mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
-{
- const char *p;
-
- p = __mdoc_merrnames[(int)type];
- assert(p);
-
- if (iserr)
- return(mdoc_verr(m, line, pos, p));
-
- return(mdoc_vwarn(m, line, pos, p));
+ return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
}
int
-mdoc_macro(struct mdoc *m, enum mdoct tok,
- int ln, int pp, int *pos, char *buf)
+mdoc_macro(MACRO_PROT_ARGS)
{
assert(tok < MDOC_MAX);
if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
MDOC_PBODY & m->flags)
- return(mdoc_perr(m, ln, pp, EPROLBODY));
+ return(mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY));
/* If we're in the prologue, deny "body" macros. */
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
! (MDOC_PBODY & m->flags)) {
- if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))
+ if ( ! mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG))
return(0);
if (NULL == m->meta.title)
- m->meta.title = mandoc_strdup("unknown");
+ m->meta.title = mandoc_strdup("UNKNOWN");
if (NULL == m->meta.vol)
- m->meta.vol = mandoc_strdup("local");
+ m->meta.vol = mandoc_strdup("LOCAL");
if (NULL == m->meta.os)
- m->meta.os = mandoc_strdup("local");
+ m->meta.os = mandoc_strdup("LOCAL");
if (0 == m->meta.date)
m->meta.date = time(NULL);
m->flags |= MDOC_PBODY;
}
- return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
+ return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
}
p->parent->tail = p;
break;
case (MDOC_BODY):
+ if (p->end)
+ break;
assert(MDOC_BLOCK == p->parent->type);
p->parent->body = p;
break;
p->tok = tok;
p->type = type;
+ /* Flag analysis. */
+
+ if (MDOC_SYNOPSIS & m->flags)
+ p->flags |= MDOC_SYNPRETTY;
+ else
+ p->flags &= ~MDOC_SYNPRETTY;
+ if (MDOC_NEWLINE & m->flags)
+ p->flags |= MDOC_LINE;
+ m->flags &= ~MDOC_NEWLINE;
+
return(p);
}
}
+int
+mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
+ struct mdoc_node *body, enum mdoc_endbody end)
+{
+ struct mdoc_node *p;
+
+ p = node_alloc(m, line, pos, tok, MDOC_BODY);
+ p->pending = body;
+ p->end = end;
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
+}
+
+
int
mdoc_block_alloc(struct mdoc *m, int line, int pos,
enum mdoct tok, struct mdoc_arg *args)
}
-static int
-pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
+int
+mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
{
struct mdoc_node *n;
- size_t sv;
+ size_t sv, len;
+
+ len = strlen(p);
- n = node_alloc(m, line, pos, -1, MDOC_TEXT);
+ n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
n->string = mandoc_malloc(len + 1);
sv = strlcpy(n->string, p, len + 1);
if ( ! node_append(m, n))
return(0);
+
m->next = MDOC_NEXT_SIBLING;
return(1);
}
-int
-mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
+static void
+mdoc_node_free(struct mdoc_node *p)
{
- return(pstring(m, line, pos, p, strlen(p)));
-}
-
+ /*
+ * XXX: if these end up being problematic in terms of memory
+ * management and dereferencing freed blocks, then make them
+ * into reference-counted double-pointers.
+ */
-void
-mdoc_node_free(struct mdoc_node *p)
-{
+ if (MDOC_Bd == p->tok && MDOC_BLOCK == p->type)
+ if (p->data.Bd)
+ free(p->data.Bd);
+ if (MDOC_Bl == p->tok && MDOC_BLOCK == p->type)
+ if (p->data.Bl)
+ free(p->data.Bl);
+ if (MDOC_Bf == p->tok && MDOC_HEAD == p->type)
+ if (p->data.Bf)
+ free(p->data.Bf);
if (p->string)
free(p->string);
* control character.
*/
static int
-mdoc_ptext(struct mdoc *m, int line, char *buf)
+mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
{
- int i, j;
- char sv;
+ char *c, *ws, *end;
+ struct mdoc_node *n;
/* Ignore bogus comments. */
- if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])
- return(mdoc_pwarn(m, line, 0, EBADCOMMENT));
+ if ('\\' == buf[offs] &&
+ '.' == buf[offs + 1] &&
+ '"' == buf[offs + 2])
+ return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
+
+ /* No text before an initial macro. */
if (SEC_NONE == m->lastnamed)
- return(mdoc_perr(m, line, 0, ETEXTPROL));
-
- /*
- * If in literal mode, then pass the buffer directly to the
- * back-end, as it should be preserved as a single term.
- */
+ return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));
- if (MDOC_LITERAL & m->flags)
- return(mdoc_word_alloc(m, line, 0, buf));
+ assert(m->last);
+ n = m->last;
- /* Disallow blank/white-space lines in non-literal mode. */
+ /*
+ * Divert directly to list processing if we're encountering a
+ * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
+ * (a MDOC_BODY means it's already open, in which case we should
+ * process within its context in the normal way).
+ */
- for (i = 0; ' ' == buf[i]; i++)
- /* Skip leading whitespace. */ ;
+ if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+ LIST_column == n->data.Bl->type) {
+ /* `Bl' is open without any children. */
+ m->flags |= MDOC_FREECOL;
+ return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+ }
- if ('\0' == buf[i]) {
- if ( ! mdoc_pwarn(m, line, 0, ENOBLANK))
- return(0);
- /*
- * Assume that a `Pp' should be inserted in the case of
- * a blank line. Technically, blank lines aren't
- * allowed, but enough manuals assume this behaviour
- * that we want to work around it.
- */
- if ( ! mdoc_elem_alloc(m, line, 0, MDOC_Pp, NULL))
- return(0);
+ if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+ NULL != n->parent &&
+ MDOC_Bl == n->parent->tok &&
+ LIST_column == n->parent->data.Bl->type) {
+ /* `Bl' has block-level `It' children. */
+ m->flags |= MDOC_FREECOL;
+ return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
}
/*
- * Break apart a free-form line into tokens. Spaces are
- * stripped out of the input.
+ * Search for the beginning of unescaped trailing whitespace (ws)
+ * and for the first character not to be output (end).
*/
- for (j = i; buf[i]; i++) {
- if (' ' != buf[i])
- continue;
-
- /* Escaped whitespace. */
- if (i && ' ' == buf[i] && '\\' == buf[i - 1])
+ /* FIXME: replace with strcspn(). */
+ ws = NULL;
+ for (c = end = buf + offs; *c; c++) {
+ switch (*c) {
+ case '-':
+ if (mandoc_hyph(buf + offs, c))
+ *c = ASCII_HYPH;
+ ws = NULL;
+ break;
+ case ' ':
+ if (NULL == ws)
+ ws = c;
continue;
+ case '\t':
+ /*
+ * Always warn about trailing tabs,
+ * even outside literal context,
+ * where they should be put on the next line.
+ */
+ if (NULL == ws)
+ ws = c;
+ /*
+ * Strip trailing tabs in literal context only;
+ * outside, they affect the next line.
+ */
+ if (MDOC_LITERAL & m->flags)
+ continue;
+ break;
+ case '\\':
+ /* Skip the escaped character, too, if any. */
+ if (c[1])
+ c++;
+ /* FALLTHROUGH */
+ default:
+ ws = NULL;
+ break;
+ }
+ end = c + 1;
+ }
+ *end = '\0';
- sv = buf[i];
- buf[i++] = '\0';
-
- if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ if (ws)
+ if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE))
return(0);
- /* Trailing whitespace? Check at overwritten byte. */
+ if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
+ if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN))
+ return(0);
- if (' ' == sv && '\0' == buf[i])
- if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
- return(0);
+ /*
+ * Insert a `Pp' in the case of a blank line. Technically,
+ * blank lines aren't allowed, but enough manuals assume this
+ * behaviour that we want to work around it.
+ */
+ if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL))
+ return(0);
- for ( ; ' ' == buf[i]; i++)
- /* Skip trailing whitespace. */ ;
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
+ }
- j = i;
+ if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
+ return(0);
- /* Trailing whitespace? */
+ if (MDOC_LITERAL & m->flags)
+ return(1);
- if (' ' == buf[i - 1] && '\0' == buf[i])
- if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
- return(0);
+ /*
+ * End-of-sentence check. If the last character is an unescaped
+ * EOS character, then flag the node as being the end of a
+ * sentence. The front-end will know how to interpret this.
+ */
- if ('\0' == buf[i])
- break;
- }
+ assert(buf < end);
- if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
- return(0);
+ if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
+ m->last->flags |= MDOC_EOS;
- m->next = MDOC_NEXT_SIBLING;
return(1);
}
-
static int
-macrowarn(struct mdoc *m, int ln, const char *buf)
+macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
{
- if ( ! (MDOC_IGN_MACRO & m->pflags))
- return(mdoc_verr(m, ln, 0,
- "unknown macro: %s%s",
- buf, strlen(buf) > 3 ? "..." : ""));
- return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",
- buf, strlen(buf) > 3 ? "..." : ""));
+ int rc;
+
+ rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,
+ "unknown macro: %s%s",
+ buf, strlen(buf) > 3 ? "..." : "");
+
+ /* FIXME: logic should be in driver. */
+ /* FIXME: broken, will error out and not omit a message. */
+ return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
}
* Parse a macro line, that is, a line beginning with the control
* character.
*/
-int
-mdoc_pmacro(struct mdoc *m, int ln, char *buf)
+static int
+mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
{
- int i, j, c;
+ enum mdoct tok;
+ int i, j, sv;
char mac[5];
+ struct mdoc_node *n;
/* Empty lines are ignored. */
- if ('\0' == buf[1])
+ offs++;
+
+ if ('\0' == buf[offs])
return(1);
- i = 1;
+ i = offs;
/* Accept whitespace after the initial control char. */
return(1);
}
+ sv = i;
+
/* Copy the first word into a nil-terminated buffer. */
for (j = 0; j < 4; j++, i++) {
if (isgraph((u_char)buf[i]))
continue;
- return(mdoc_perr(m, ln, i, EPRINT));
+ if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
+ return(0);
+ i--;
}
- mac[j] = 0;
+ mac[j] = '\0';
if (j == 4 || j < 2) {
- if ( ! macrowarn(m, ln, mac))
+ if ( ! macrowarn(m, ln, mac, sv))
goto err;
return(1);
}
- if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
- if ( ! macrowarn(m, ln, mac))
+ if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
+ if ( ! macrowarn(m, ln, mac, sv))
goto err;
return(1);
}
while (buf[i] && ' ' == buf[i])
i++;
- /* Trailing whitespace? */
+ /*
+ * Trailing whitespace. Note that tabs are allowed to be passed
+ * into the parser as "text", so we only warn about spaces here.
+ */
if ('\0' == buf[i] && ' ' == buf[i - 1])
- if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
+ if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
goto err;
- /*
- * Begin recursive parse sequence. Since we're at the start of
- * the line, we don't need to do callable/parseable checks.
+ /*
+ * If an initial macro or a list invocation, divert directly
+ * into macro processing.
+ */
+
+ if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
+ if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
+ goto err;
+ return(1);
+ }
+
+ n = m->last;
+ assert(m->last);
+
+ /*
+ * If the first macro of a `Bl -column', open an `It' block
+ * context around the parsed macro.
+ */
+
+ if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+ LIST_column == n->data.Bl->type) {
+ m->flags |= MDOC_FREECOL;
+ if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
+ goto err;
+ return(1);
+ }
+
+ /*
+ * If we're following a block-level `It' within a `Bl -column'
+ * context (perhaps opened in the above block or in ptext()),
+ * then open an `It' block context around the parsed macro.
*/
- if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
+
+ if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+ NULL != n->parent &&
+ MDOC_Bl == n->parent->tok &&
+ LIST_column == n->parent->data.Bl->type) {
+ m->flags |= MDOC_FREECOL;
+ if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
+ goto err;
+ return(1);
+ }
+
+ /* Normal processing of a macro. */
+
+ if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
goto err;
return(1);
git.ckatri.com / mandoc.git / blobdiff