-/* $Id: mdoc.c,v 1.136 2010/05/17 22:11:42 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.188 2011/03/28 23:52:13 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 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/types.h>
#include <assert.h>
-#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
+#include "mdoc.h"
#include "mandoc.h"
#include "libmdoc.h"
#include "libmandoc.h"
/* LINTED */
"Dx", "%Q", "br", "sp",
/* LINTED */
- "%U"
+ "%U", "Ta"
};
const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
struct mdoc_node *);
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)
{
- return(MDOC_HALT & m->flags ? NULL : m->first);
+ assert( ! (MDOC_HALT & m->flags));
+ return(m->first);
}
mdoc_meta(const struct mdoc *m)
{
- return(MDOC_HALT & m->flags ? NULL : &m->meta);
+ assert( ! (MDOC_HALT & m->flags));
+ return(&m->meta);
}
free(mdoc->meta.vol);
if (mdoc->meta.msec)
free(mdoc->meta.msec);
+ if (mdoc->meta.date)
+ free(mdoc->meta.date);
}
* Allocate volatile and non-volatile parse resources.
*/
struct mdoc *
-mdoc_alloc(void *data, int pflags, mandocmsg msg)
+mdoc_alloc(struct regset *regs, struct mparse *parse)
{
struct mdoc *p;
p = mandoc_calloc(1, sizeof(struct mdoc));
- p->msg = msg;
- p->data = data;
- p->pflags = pflags;
+ p->parse = parse;
+ p->regs = regs;
mdoc_hash_init();
mdoc_alloc1(p);
mdoc_endparse(struct mdoc *m)
{
- if (MDOC_HALT & m->flags)
- return(0);
- else if (mdoc_macroend(m))
+ assert( ! (MDOC_HALT & m->flags));
+ if (mdoc_macroend(m))
return(1);
m->flags |= MDOC_HALT;
return(0);
}
+int
+mdoc_addeqn(struct mdoc *m, const struct eqn *ep)
+{
+ struct mdoc_node *n;
+
+ assert( ! (MDOC_HALT & m->flags));
+
+ /* No text before an initial macro. */
+
+ if (SEC_NONE == m->lastnamed) {
+ mdoc_pmsg(m, ep->line, ep->pos, MANDOCERR_NOTEXT);
+ return(1);
+ }
+
+ n = node_alloc(m, ep->line, ep->pos, MDOC_MAX, MDOC_EQN);
+ n->eqn = ep;
+
+ if ( ! node_append(m, n))
+ return(0);
+
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
+}
-/*
- * Main parse routine. Parses a single line -- really just hands off to
- * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
- */
int
-mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
+mdoc_addspan(struct mdoc *m, const struct tbl_span *sp)
{
+ struct mdoc_node *n;
+
+ assert( ! (MDOC_HALT & m->flags));
+
+ /* No text before an initial macro. */
+
+ if (SEC_NONE == m->lastnamed) {
+ mdoc_pmsg(m, sp->line, 0, MANDOCERR_NOTEXT);
+ return(1);
+ }
+
+ n = node_alloc(m, sp->line, 0, MDOC_MAX, MDOC_TBL);
+ n->span = sp;
- if (MDOC_HALT & m->flags)
+ if ( ! node_append(m, n))
return(0);
- m->flags |= MDOC_NEWLINE;
- return(('.' == buf[offs] || '\'' == buf[offs]) ?
- mdoc_pmacro(m, ln, buf, offs) :
- mdoc_ptext(m, ln, buf, offs));
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
}
+/*
+ * Main parse routine. Parses a single line -- really just hands off to
+ * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
+ */
int
-mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
- int ln, int pos, const char *fmt, ...)
+mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
{
- char buf[256];
- va_list ap;
- va_start(ap, fmt);
- vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
+ assert( ! (MDOC_HALT & m->flags));
- return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
-}
+ m->flags |= MDOC_NEWLINE;
+ /*
+ * 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(mandoc_getcontrol(buf, &offs) ?
+ mdoc_pmacro(m, ln, buf, offs) :
+ mdoc_ptext(m, ln, buf, offs));
+}
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 we're in the body, deny prologue calls. */
if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
- MDOC_PBODY & m->flags)
- return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY));
+ MDOC_PBODY & m->flags) {
+ mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
+ return(1);
+ }
/* If we're in the prologue, deny "body" macros. */
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
! (MDOC_PBODY & m->flags)) {
- if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG))
- return(0);
+ mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
+ if (NULL == m->meta.msec)
+ m->meta.msec = mandoc_strdup("1");
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");
- if (0 == m->meta.date)
- m->meta.date = time(NULL);
+ m->meta.os = mandoc_strdup("LOCAL");
+ if (NULL == m->meta.date)
+ m->meta.date = mandoc_normdate
+ (m->parse, NULL, line, ppos);
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->nchild++;
+ /*
+ * Copy over the normalised-data pointer of our parent. Not
+ * everybody has one, but copying a null pointer is fine.
+ */
+
+ switch (p->type) {
+ case (MDOC_BODY):
+ /* FALLTHROUGH */
+ case (MDOC_TAIL):
+ /* FALLTHROUGH */
+ case (MDOC_HEAD):
+ p->norm = p->parent->norm;
+ break;
+ default:
+ break;
+ }
+
if ( ! mdoc_valid_pre(mdoc, p))
return(0);
- if ( ! mdoc_action_pre(mdoc, p))
- return(0);
switch (p->type) {
case (MDOC_HEAD):
p->parent->tail = p;
break;
case (MDOC_BODY):
+ if (p->end)
+ break;
assert(MDOC_BLOCK == p->parent->type);
p->parent->body = p;
break;
mdoc->last = p;
switch (p->type) {
+ case (MDOC_TBL):
+ /* FALLTHROUGH */
case (MDOC_TEXT):
if ( ! mdoc_valid_post(mdoc))
return(0);
- if ( ! mdoc_action_post(mdoc))
- return(0);
break;
default:
break;
p->pos = pos;
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)
p->args = args;
if (p->args)
(args->refcnt)++;
+
+ switch (tok) {
+ case (MDOC_Bd):
+ /* FALLTHROUGH */
+ case (MDOC_Bf):
+ /* FALLTHROUGH */
+ case (MDOC_Bl):
+ /* FALLTHROUGH */
+ case (MDOC_Rs):
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
+ }
+
if ( ! node_append(m, p))
return(0);
m->next = MDOC_NEXT_CHILD;
p->args = args;
if (p->args)
(args->refcnt)++;
+
+ switch (tok) {
+ case (MDOC_An):
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
+ }
+
if ( ! node_append(m, p))
return(0);
m->next = MDOC_NEXT_CHILD;
return(1);
}
-
int
mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
{
}
-void
+static void
mdoc_node_free(struct mdoc_node *p)
{
+ if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
+ free(p->norm);
if (p->string)
free(p->string);
if (p->args)
n->parent->nchild--;
if (n->parent->child == n)
n->parent->child = n->prev ? n->prev : n->next;
+ if (n->parent->last == n)
+ n->parent->last = n->prev ? n->prev : NULL;
}
/* Adjust parse point, if applicable. */
static int
mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
{
- int i;
+ char *c, *ws, *end;
+ struct mdoc_node *n;
- /* Ignore bogus comments. */
+ /* No text before an initial macro. */
- if ('\\' == buf[offs] &&
- '.' == buf[offs + 1] &&
- '"' == buf[offs + 2])
- return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
+ if (SEC_NONE == m->lastnamed) {
+ mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
+ return(1);
+ }
- /* No text before an initial macro. */
+ assert(m->last);
+ n = m->last;
- if (SEC_NONE == m->lastnamed)
- return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));
+ /*
+ * 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).
+ */
- /* Literal just gets pulled in as-is. */
-
- if (MDOC_LITERAL & m->flags)
- return(mdoc_word_alloc(m, line, offs, buf + offs));
+ if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+ LIST_column == n->norm->Bl.type) {
+ /* `Bl' is open without any children. */
+ m->flags |= MDOC_FREECOL;
+ return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+ }
- /* Check for a blank line, which may also consist of spaces. */
+ if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+ NULL != n->parent &&
+ MDOC_Bl == n->parent->tok &&
+ LIST_column == n->parent->norm->Bl.type) {
+ /* `Bl' has block-level `It' children. */
+ m->flags |= MDOC_FREECOL;
+ return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+ }
- for (i = offs; ' ' == buf[i]; i++)
- /* Skip to first non-space. */ ;
+ /*
+ * Search for the beginning of unescaped trailing whitespace (ws)
+ * and for the first character not to be output (end).
+ */
- if ('\0' == buf[i]) {
- if ( ! mdoc_pmsg(m, line, offs, MANDOCERR_NOBLANKLN))
- return(0);
+ /* 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';
+
+ if (ws)
+ mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
+
+ if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
+ mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
/*
- * Insert a `Pp' in the case of a blank line. Technically,
+ * Insert a `sp' 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))
+ if ( ! mdoc_elem_alloc(m, line, offs, MDOC_sp, NULL))
return(0);
m->next = MDOC_NEXT_SIBLING;
return(1);
}
- /*
- * Warn if the last un-escaped character is whitespace. Then
- * strip away the remaining spaces (tabs stay!).
- */
-
- i = (int)strlen(buf);
- assert(i);
-
- if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
- if (i > 1 && '\\' != buf[i - 2])
- if ( ! mdoc_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE))
- return(0);
-
- for (--i; i && ' ' == buf[i]; i--)
- /* Spin back to non-space. */ ;
-
- /* Jump ahead of escaped whitespace. */
- i += '\\' == buf[i] ? 2 : 1;
-
- buf[i] = '\0';
- }
-
- /* Allocate the whole word. */
-
- if ( ! mdoc_word_alloc(m, line, offs, buf + offs))
+ if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
return(0);
+ if (MDOC_LITERAL & m->flags)
+ return(1);
+
/*
* 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.
*/
- assert(i);
- if (mandoc_eos(buf, (size_t)i))
+ assert(buf < end);
+
+ if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
m->last->flags |= MDOC_EOS;
return(1);
}
-static int
-macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
-{
- int rc;
-
- rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,
- "unknown macro: %s%s",
- buf, strlen(buf) > 3 ? "..." : "");
-
- /* FIXME: logic should be in driver. */
- return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
-}
-
-
/*
* Parse a macro line, that is, a line beginning with the control
* character.
*/
-int
+static int
mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
{
- enum mdoct tok;
- int i, j, sv;
- char mac[5];
-
- /* Empty lines are ignored. */
+ enum mdoct tok;
+ int i, sv;
+ char mac[5];
+ struct mdoc_node *n;
- offs++;
+ /* Empty post-control lines are ignored. */
- if ('\0' == buf[offs])
+ if ('"' == buf[offs]) {
+ mdoc_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
+ return(1);
+ } else if ('\0' == buf[offs])
return(1);
- i = offs;
+ sv = offs;
+
+ /*
+ * Copy the first word into a nil-terminated buffer.
+ * Stop copying when a tab, space, or eoln is encountered.
+ */
+
+ i = 0;
+ while (i < 4 && '\0' != buf[offs] &&
+ ' ' != buf[offs] && '\t' != buf[offs])
+ mac[i++] = buf[offs++];
- /* Accept whitespace after the initial control char. */
+ mac[i] = '\0';
- if (' ' == buf[i]) {
- i++;
- while (buf[i] && ' ' == buf[i])
- i++;
- if ('\0' == buf[i])
- return(1);
+ tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+
+ if (MDOC_MAX == tok) {
+ mandoc_vmsg(MANDOCERR_MACRO, m->parse,
+ ln, sv, "%s", buf + sv - 1);
+ return(1);
}
- sv = i;
+ /* Disregard the first trailing tab, if applicable. */
- /* Copy the first word into a nil-terminated buffer. */
+ if ('\t' == buf[offs])
+ offs++;
- for (j = 0; j < 4; j++, i++) {
- if ('\0' == (mac[j] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
+ /* Jump to the next non-whitespace word. */
- /* Check for invalid characters. */
+ while (buf[offs] && ' ' == buf[offs])
+ offs++;
- if (isgraph((u_char)buf[i]))
- continue;
- if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
- return(0);
- i--;
- }
+ /*
+ * Trailing whitespace. Note that tabs are allowed to be passed
+ * into the parser as "text", so we only warn about spaces here.
+ */
- mac[j] = '\0';
+ if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+ mdoc_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE);
- if (j == 4 || j < 2) {
- if ( ! macrowarn(m, ln, mac, sv))
- goto err;
- return(1);
- }
-
- if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
- if ( ! macrowarn(m, ln, mac, sv))
+ /*
+ * 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, &offs, buf))
goto err;
return(1);
}
- /* The macro is sane. Jump to the next word. */
-
- while (buf[i] && ' ' == buf[i])
- i++;
+ n = m->last;
+ assert(m->last);
- /*
- * Trailing whitespace. Note that tabs are allowed to be passed
- * into the parser as "text", so we only warn about spaces here.
+ /*
+ * If the first macro of a `Bl -column', open an `It' block
+ * context around the parsed macro.
*/
- if ('\0' == buf[i] && ' ' == buf[i - 1])
- if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
+ if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+ LIST_column == n->norm->Bl.type) {
+ m->flags |= MDOC_FREECOL;
+ if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
goto err;
+ return(1);
+ }
- /*
- * Begin recursive parse sequence. Since we're at the start of
- * the line, we don't need to do callable/parseable checks.
+ /*
+ * 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, tok, ln, sv, &i, buf))
+
+ if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+ NULL != n->parent &&
+ MDOC_Bl == n->parent->tok &&
+ LIST_column == n->parent->norm->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, &offs, buf))
goto err;
return(1);
return(0);
}
+enum mdelim
+mdoc_isdelim(const char *p)
+{
+ if ('\0' == p[0])
+ return(DELIM_NONE);
+
+ if ('\0' == p[1])
+ switch (p[0]) {
+ case('('):
+ /* FALLTHROUGH */
+ case('['):
+ return(DELIM_OPEN);
+ case('|'):
+ return(DELIM_MIDDLE);
+ case('.'):
+ /* FALLTHROUGH */
+ case(','):
+ /* FALLTHROUGH */
+ case(';'):
+ /* FALLTHROUGH */
+ case(':'):
+ /* FALLTHROUGH */
+ case('?'):
+ /* FALLTHROUGH */
+ case('!'):
+ /* FALLTHROUGH */
+ case(')'):
+ /* FALLTHROUGH */
+ case(']'):
+ return(DELIM_CLOSE);
+ default:
+ return(DELIM_NONE);
+ }
+
+ if ('\\' != p[0])
+ return(DELIM_NONE);
+
+ if (0 == strcmp(p + 1, "."))
+ return(DELIM_CLOSE);
+ if (0 == strcmp(p + 1, "*(Ba"))
+ return(DELIM_MIDDLE);
+
+ return(DELIM_NONE);
+}
git.ckatri.com / mandoc.git / blobdiff