-/* $Id: mdoc.c,v 1.122 2010/04/08 07:06:15 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.206 2013/12/24 19:11:46 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2012, 2013 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"
-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 */
-};
-
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 parsetext(struct mdoc *, int, char *);
-static int parsemacro(struct mdoc *, int, char *);
-static int macrowarn(struct mdoc *, int, const char *);
-static int pstring(struct mdoc *, int, int,
- const char *, size_t);
+#if 0
+static int mdoc_preptext(struct mdoc *, int, char *, int);
+#endif
+static int mdoc_ptext(struct mdoc *, int, char *, int);
+static int mdoc_pmacro(struct mdoc *, int, char *, int);
const struct mdoc_node *
-mdoc_node(const struct mdoc *m)
+mdoc_node(const struct mdoc *mdoc)
{
- return(MDOC_HALT & m->flags ? NULL : m->first);
+ assert( ! (MDOC_HALT & mdoc->flags));
+ return(mdoc->first);
}
const struct mdoc_meta *
-mdoc_meta(const struct mdoc *m)
+mdoc_meta(const struct mdoc *mdoc)
{
- return(MDOC_HALT & m->flags ? NULL : &m->meta);
+ assert( ! (MDOC_HALT & mdoc->flags));
+ return(&mdoc->meta);
}
free(mdoc->meta.arch);
if (mdoc->meta.vol)
free(mdoc->meta.vol);
+ if (mdoc->meta.msec)
+ free(mdoc->meta.msec);
+ if (mdoc->meta.date)
+ free(mdoc->meta.date);
}
mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
mdoc->first = mdoc->last;
mdoc->last->type = MDOC_ROOT;
+ mdoc->last->tok = MDOC_MAX;
mdoc->next = MDOC_NEXT_CHILD;
}
* Allocate volatile and non-volatile parse resources.
*/
struct mdoc *
-mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
+mdoc_alloc(struct roff *roff, struct mparse *parse, char *defos)
{
struct mdoc *p;
p = mandoc_calloc(1, sizeof(struct mdoc));
- if (cb)
- memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
-
- p->data = data;
- p->pflags = pflags;
+ p->parse = parse;
+ p->defos = defos;
+ p->roff = roff;
mdoc_hash_init();
mdoc_alloc1(p);
* through to macro_end() in macro.c.
*/
int
-mdoc_endparse(struct mdoc *m)
+mdoc_endparse(struct mdoc *mdoc)
{
- if (MDOC_HALT & m->flags)
- return(0);
- else if (mdoc_macroend(m))
+ assert( ! (MDOC_HALT & mdoc->flags));
+ if (mdoc_macroend(mdoc))
return(1);
- m->flags |= MDOC_HALT;
+ mdoc->flags |= MDOC_HALT;
return(0);
}
-
-/*
- * Main parse routine. Parses a single line -- really just hands off to
- * the macro (parsemacro()) or text parser (parsetext()).
- */
int
-mdoc_parseln(struct mdoc *m, int ln, char *buf)
+mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
{
+ struct mdoc_node *n;
- if (MDOC_HALT & m->flags)
- return(0);
+ assert( ! (MDOC_HALT & mdoc->flags));
- return('.' == *buf ? parsemacro(m, ln, buf) :
- parsetext(m, ln, buf));
-}
+ /* No text before an initial macro. */
+ if (SEC_NONE == mdoc->lastnamed) {
+ mdoc_pmsg(mdoc, ep->ln, ep->pos, MANDOCERR_NOTEXT);
+ return(1);
+ }
-int
-mdoc_verr(struct mdoc *mdoc, int ln, int pos,
- const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
+ n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
+ n->eqn = ep;
- if (NULL == mdoc->cb.mdoc_err)
+ if ( ! node_append(mdoc, n))
return(0);
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
-
- return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
+ mdoc->next = MDOC_NEXT_SIBLING;
+ return(1);
}
-
int
-mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
+mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
{
- char buf[256];
- va_list ap;
+ struct mdoc_node *n;
- if (NULL == mdoc->cb.mdoc_warn)
- return(0);
+ assert( ! (MDOC_HALT & mdoc->flags));
+
+ /* No text before an initial macro. */
+
+ if (SEC_NONE == mdoc->lastnamed) {
+ mdoc_pmsg(mdoc, sp->line, 0, MANDOCERR_NOTEXT);
+ return(1);
+ }
+
+ n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
+ n->span = sp;
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
+ if ( ! node_append(mdoc, n))
+ return(0);
- return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
+ mdoc->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_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
+mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
{
- const char *p;
- p = __mdoc_merrnames[(int)type];
- assert(p);
+ assert( ! (MDOC_HALT & mdoc->flags));
- if (iserr)
- return(mdoc_verr(m, line, pos, p));
+ mdoc->flags |= MDOC_NEWLINE;
- return(mdoc_vwarn(m, line, pos, p));
+ /*
+ * 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 (roff_getreg(mdoc->roff, "nS"))
+ mdoc->flags |= MDOC_SYNOPSIS;
+ else
+ mdoc->flags &= ~MDOC_SYNOPSIS;
+
+ return(roff_getcontrol(mdoc->roff, buf, &offs) ?
+ mdoc_pmacro(mdoc, ln, buf, offs) :
+ mdoc_ptext(mdoc, 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_perr(m, ln, pp, EPROLBODY));
+ MDOC_PBODY & mdoc->flags) {
+ mdoc_pmsg(mdoc, 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_pwarn(m, ln, pp, EBODYPROL))
- return(0);
- if (NULL == m->meta.title)
- m->meta.title = mandoc_strdup("unknown");
- if (NULL == m->meta.vol)
- 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->flags |= MDOC_PBODY;
+ ! (MDOC_PBODY & mdoc->flags)) {
+ mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADPROLOG);
+ if (NULL == mdoc->meta.msec)
+ mdoc->meta.msec = mandoc_strdup("1");
+ if (NULL == mdoc->meta.title)
+ mdoc->meta.title = mandoc_strdup("UNKNOWN");
+ if (NULL == mdoc->meta.vol)
+ mdoc->meta.vol = mandoc_strdup("LOCAL");
+ if (NULL == mdoc->meta.os)
+ mdoc->meta.os = mandoc_strdup("LOCAL");
+ if (NULL == mdoc->meta.date)
+ mdoc->meta.date = mandoc_normdate
+ (mdoc->parse, NULL, line, ppos);
+ mdoc->flags |= MDOC_PBODY;
}
- return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
+ return((*mdoc_macros[tok].fp)(mdoc, 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):
+ if (ENDBODY_NOT != p->end)
+ break;
+ /* 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;
static struct mdoc_node *
-node_alloc(struct mdoc *m, int line, int pos,
+node_alloc(struct mdoc *mdoc, int line, int pos,
enum mdoct tok, enum mdoc_type type)
{
struct mdoc_node *p;
p = mandoc_calloc(1, sizeof(struct mdoc_node));
- p->sec = m->lastsec;
+ p->sec = mdoc->lastsec;
p->line = line;
p->pos = pos;
+ p->lastline = line;
p->tok = tok;
p->type = type;
+ /* Flag analysis. */
+
+ if (MDOC_SYNOPSIS & mdoc->flags)
+ p->flags |= MDOC_SYNPRETTY;
+ else
+ p->flags &= ~MDOC_SYNPRETTY;
+ if (MDOC_NEWLINE & mdoc->flags)
+ p->flags |= MDOC_LINE;
+ mdoc->flags &= ~MDOC_NEWLINE;
+
return(p);
}
int
-mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
{
struct mdoc_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_TAIL);
- if ( ! node_append(m, p))
+ p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
+ if ( ! node_append(mdoc, p))
return(0);
- m->next = MDOC_NEXT_CHILD;
+ mdoc->next = MDOC_NEXT_CHILD;
return(1);
}
int
-mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
{
struct mdoc_node *p;
- assert(m->first);
- assert(m->last);
+ assert(mdoc->first);
+ assert(mdoc->last);
- p = node_alloc(m, line, pos, tok, MDOC_HEAD);
- if ( ! node_append(m, p))
+ p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
+ if ( ! node_append(mdoc, p))
return(0);
- m->next = MDOC_NEXT_CHILD;
+ mdoc->next = MDOC_NEXT_CHILD;
return(1);
}
int
-mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
{
struct mdoc_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_BODY);
- if ( ! node_append(m, p))
+ p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
+ if ( ! node_append(mdoc, p))
return(0);
- m->next = MDOC_NEXT_CHILD;
+ mdoc->next = MDOC_NEXT_CHILD;
return(1);
}
int
-mdoc_block_alloc(struct mdoc *m, int line, int pos,
- enum mdoct tok, struct mdoc_arg *args)
+mdoc_endbody_alloc(struct mdoc *mdoc, 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_BLOCK);
- p->args = args;
- if (p->args)
- (args->refcnt)++;
- if ( ! node_append(m, p))
+ p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
+ p->pending = body;
+ p->norm = body->norm;
+ p->end = end;
+ if ( ! node_append(mdoc, p))
return(0);
- m->next = MDOC_NEXT_CHILD;
+ mdoc->next = MDOC_NEXT_SIBLING;
return(1);
}
int
-mdoc_elem_alloc(struct mdoc *m, int line, int pos,
+mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
enum mdoct tok, struct mdoc_arg *args)
{
struct mdoc_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_ELEM);
+ p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
p->args = args;
if (p->args)
(args->refcnt)++;
- if ( ! node_append(m, p))
+
+ 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(mdoc, p))
return(0);
- m->next = MDOC_NEXT_CHILD;
+ mdoc->next = MDOC_NEXT_CHILD;
return(1);
}
-static int
-pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
+int
+mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
+ enum mdoct tok, struct mdoc_arg *args)
{
- struct mdoc_node *n;
- size_t sv;
+ struct mdoc_node *p;
- n = node_alloc(m, line, pos, -1, MDOC_TEXT);
- n->string = mandoc_malloc(len + 1);
- sv = strlcpy(n->string, p, len + 1);
+ p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
+ p->args = args;
+ if (p->args)
+ (args->refcnt)++;
- /* Prohibit truncation. */
- assert(sv < len + 1);
+ switch (tok) {
+ case (MDOC_An):
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
+ }
- if ( ! node_append(m, n))
+ if ( ! node_append(mdoc, p))
return(0);
- m->next = MDOC_NEXT_SIBLING;
+ mdoc->next = MDOC_NEXT_CHILD;
return(1);
}
-
int
-mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
+mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
{
+ struct mdoc_node *n;
- return(pstring(m, line, pos, p, strlen(p)));
-}
+ n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
+ n->string = roff_strdup(mdoc->roff, p);
+
+ if ( ! node_append(mdoc, n))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ return(1);
+}
void
+mdoc_word_append(struct mdoc *mdoc, const char *p)
+{
+ struct mdoc_node *n;
+ char *addstr, *newstr;
+
+ n = mdoc->last;
+ addstr = roff_strdup(mdoc->roff, p);
+ if (-1 == asprintf(&newstr, "%s %s", n->string, addstr)) {
+ perror(NULL);
+ exit((int)MANDOCLEVEL_SYSERR);
+ }
+ free(addstr);
+ free(n->string);
+ n->string = newstr;
+ mdoc->next = MDOC_NEXT_SIBLING;
+}
+
+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)
static void
-mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
+mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
{
/* Adjust siblings. */
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. */
- if (m && m->last == n) {
+ if (mdoc && mdoc->last == n) {
if (n->prev) {
- m->last = n->prev;
- m->next = MDOC_NEXT_SIBLING;
+ mdoc->last = n->prev;
+ mdoc->next = MDOC_NEXT_SIBLING;
} else {
- m->last = n->parent;
- m->next = MDOC_NEXT_CHILD;
+ mdoc->last = n->parent;
+ mdoc->next = MDOC_NEXT_CHILD;
}
}
- if (m && m->first == n)
- m->first = NULL;
+ if (mdoc && mdoc->first == n)
+ mdoc->first = NULL;
}
void
-mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
+mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
{
while (p->child) {
assert(p->nchild);
- mdoc_node_delete(m, p->child);
+ mdoc_node_delete(mdoc, p->child);
}
assert(0 == p->nchild);
- mdoc_node_unlink(m, p);
+ mdoc_node_unlink(mdoc, p);
mdoc_node_free(p);
}
+int
+mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
+{
+
+ mdoc_node_unlink(mdoc, p);
+ return(node_append(mdoc, p));
+}
+
+#if 0
+/*
+ * Pre-treat a text line.
+ * Text lines can consist of equations, which must be handled apart from
+ * the regular text.
+ * Thus, use this function to step through a line checking if it has any
+ * equations embedded in it.
+ * This must handle multiple equations AND equations that do not end at
+ * the end-of-line, i.e., will re-enter in the next roff parse.
+ */
+static int
+mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
+{
+ char *start, *end;
+ char delim;
+
+ while ('\0' != buf[offs]) {
+ /* Mark starting position if eqn is set. */
+ start = NULL;
+ if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
+ if (NULL != (start = strchr(buf + offs, delim)))
+ *start++ = '\0';
+
+ /* Parse text as normal. */
+ if ( ! mdoc_ptext(mdoc, line, buf, offs))
+ return(0);
+
+ /* Continue only if an equation exists. */
+ if (NULL == start)
+ break;
+
+ /* Read past the end of the equation. */
+ offs += start - (buf + offs);
+ assert(start == &buf[offs]);
+ if (NULL != (end = strchr(buf + offs, delim))) {
+ *end++ = '\0';
+ while (' ' == *end)
+ end++;
+ }
+
+ /* Parse the equation itself. */
+ roff_openeqn(mdoc->roff, NULL, line, offs, buf);
+
+ /* Process a finished equation? */
+ if (roff_closeeqn(mdoc->roff))
+ if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
+ return(0);
+ offs += (end - (buf + offs));
+ }
+
+ return(1);
+}
+#endif
/*
* Parse free-form text, that is, a line that does not begin with the
* control character.
*/
static int
-parsetext(struct mdoc *m, int line, char *buf)
+mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
{
- int i, j;
- char sv;
+ char *c, *ws, *end;
+ struct mdoc_node *n;
- 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.
- */
+ /* No text before an initial macro. */
+
+ if (SEC_NONE == mdoc->lastnamed) {
+ mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT);
+ return(1);
+ }
- if (MDOC_LITERAL & m->flags)
- return(mdoc_word_alloc(m, line, 0, buf));
+ assert(mdoc->last);
+ n = mdoc->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->norm->Bl.type) {
+ /* `Bl' is open without any children. */
+ mdoc->flags |= MDOC_FREECOL;
+ return(mdoc_macro(mdoc, 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->norm->Bl.type) {
+ /* `Bl' has block-level `It' children. */
+ mdoc->flags |= MDOC_FREECOL;
+ return(mdoc_macro(mdoc, 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])
+ /* FIXME: replace with strcspn(). */
+ ws = NULL;
+ for (c = end = buf + offs; *c; c++) {
+ switch (*c) {
+ 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 & mdoc->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';
- /* Escaped whitespace. */
- if (i && ' ' == buf[i] && '\\' == buf[i - 1])
- continue;
+ if (ws)
+ mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
- sv = buf[i];
- buf[i++] = '\0';
+ if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
+ mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
- if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ /*
+ * 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(mdoc, line, offs, MDOC_sp, NULL))
return(0);
- /* Trailing whitespace? Check at overwritten byte. */
-
- if (' ' == sv && '\0' == buf[i])
- if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
- return(0);
-
- for ( ; ' ' == buf[i]; i++)
- /* Skip trailing whitespace. */ ;
-
- j = i;
-
- /* Trailing whitespace? */
+ mdoc->next = MDOC_NEXT_SIBLING;
- if (' ' == buf[i - 1] && '\0' == buf[i])
- if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
- return(0);
-
- if ('\0' == buf[i])
- break;
+ return(mdoc_valid_post(mdoc));
}
- if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
return(0);
- m->next = MDOC_NEXT_SIBLING;
- return(1);
-}
+ if (MDOC_LITERAL & mdoc->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(buf < end);
-static int
-macrowarn(struct mdoc *m, int ln, const char *buf)
-{
- 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 ? "..." : ""));
+ if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
+ mdoc->last->flags |= MDOC_EOS;
+
+ return(1);
}
* Parse a macro line, that is, a line beginning with the control
* character.
*/
-int
-parsemacro(struct mdoc *m, int ln, char *buf)
+static int
+mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
{
- int i, j, c;
+ enum mdoct tok;
+ int i, sv;
char mac[5];
+ struct mdoc_node *n;
- /* Empty lines are ignored. */
+ /* Empty post-control lines are ignored. */
- if ('\0' == buf[1])
+ if ('"' == buf[offs]) {
+ mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT);
+ return(1);
+ } else if ('\0' == buf[offs])
return(1);
- i = 1;
+ sv = offs;
+
+ /*
+ * Copy the first word into a nil-terminated buffer.
+ * Stop copying when a tab, space, or eoln is encountered.
+ */
- /* Accept whitespace after the initial control char. */
+ i = 0;
+ while (i < 4 && '\0' != buf[offs] &&
+ ' ' != buf[offs] && '\t' != buf[offs])
+ mac[i++] = buf[offs++];
- if (' ' == buf[i]) {
- i++;
- while (buf[i] && ' ' == buf[i])
- i++;
- if ('\0' == buf[i])
- return(1);
+ mac[i] = '\0';
+
+ tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+
+ if (MDOC_MAX == tok) {
+ mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse,
+ ln, sv, "%s", buf + sv - 1);
+ return(1);
}
- /* Copy the first word into a nil-terminated buffer. */
+ /* Disregard the first trailing tab, if applicable. */
- for (j = 0; j < 4; j++, i++) {
- if ('\0' == (mac[j] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
+ if ('\t' == buf[offs])
+ offs++;
- /* Check for invalid characters. */
+ /* Jump to the next non-whitespace word. */
- if (isgraph((u_char)buf[i]))
- continue;
- return(mdoc_perr(m, ln, i, EPRINT));
- }
+ while (buf[offs] && ' ' == buf[offs])
+ offs++;
- mac[j] = 0;
+ /*
+ * Trailing whitespace. Note that tabs are allowed to be passed
+ * into the parser as "text", so we only warn about spaces here.
+ */
- if (j == 4 || j < 2) {
- if ( ! macrowarn(m, ln, mac))
- goto err;
- return(1);
- }
-
- if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
- if ( ! macrowarn(m, ln, mac))
+ if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+ mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE);
+
+ /*
+ * If an initial macro or a list invocation, divert directly
+ * into macro processing.
+ */
+
+ if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
+ if ( ! mdoc_macro(mdoc, 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 = mdoc->last;
+ assert(mdoc->last);
- /* Trailing whitespace? */
+ /*
+ * 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_pwarn(m, ln, i - 1, ETAILWS))
+ if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+ LIST_column == n->norm->Bl.type) {
+ mdoc->flags |= MDOC_FREECOL;
+ if ( ! mdoc_macro(mdoc, 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, 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->norm->Bl.type) {
+ mdoc->flags |= MDOC_FREECOL;
+ if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
+ goto err;
+ return(1);
+ }
+
+ /* Normal processing of a macro. */
+
+ if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
goto err;
return(1);
err: /* Error out. */
- m->flags |= MDOC_HALT;
+ mdoc->flags |= MDOC_HALT;
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, "fR|\\fP"))
+ return(DELIM_MIDDLE);
+
+ return(DELIM_NONE);
+}
git.ckatri.com / mandoc.git / blobdiff