-/* $Id: mdoc.c,v 1.145 2010/05/31 21:32:57 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.241 2015/04/02 23:48:19 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2012-2015 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
* copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#ifdef HAVE_CONFIG_H
#include "config.h"
-#endif
#include <sys/types.h>
#include <string.h>
#include <time.h>
+#include "mandoc_aux.h"
#include "mandoc.h"
-#include "libmdoc.h"
+#include "roff.h"
+#include "mdoc.h"
#include "libmandoc.h"
+#include "libmdoc.h"
-const char *const __mdoc_macronames[MDOC_MAX] = {
+const char *const __mdoc_macronames[MDOC_MAX + 1] = {
"Ap", "Dd", "Dt", "Os",
"Sh", "Ss", "Pp", "D1",
"Dl", "Bd", "Ed", "Bl",
"Ic", "In", "Li", "Nd",
"Nm", "Op", "Ot", "Pa",
"Rv", "St", "Va", "Vt",
- /* LINTED */
"Xr", "%A", "%B", "%D",
- /* LINTED */
"%I", "%J", "%N", "%O",
- /* LINTED */
"%P", "%R", "%T", "%V",
"Ac", "Ao", "Aq", "At",
"Bc", "Bf", "Bo", "Bq",
"Bk", "Ek", "Bt", "Hf",
"Fr", "Ud", "Lb", "Lp",
"Lk", "Mt", "Brq", "Bro",
- /* LINTED */
"Brc", "%C", "Es", "En",
- /* LINTED */
"Dx", "%Q", "br", "sp",
- /* LINTED */
- "%U", "Ta"
+ "%U", "Ta", "ll", "text",
};
-const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
+const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
"split", "nosplit", "ragged",
- "unfilled", "literal", "file",
- "offset", "bullet", "dash",
- "hyphen", "item", "enum",
- "tag", "diag", "hang",
- "ohang", "inset", "column",
- "width", "compact", "std",
+ "unfilled", "literal", "file",
+ "offset", "bullet", "dash",
+ "hyphen", "item", "enum",
+ "tag", "diag", "hang",
+ "ohang", "inset", "column",
+ "width", "compact", "std",
"filled", "words", "emphasis",
"symbolic", "nested", "centered"
};
const char * const *mdoc_macronames = __mdoc_macronames;
const char * const *mdoc_argnames = __mdoc_argnames;
-static void mdoc_node_free(struct mdoc_node *);
-static void mdoc_node_unlink(struct mdoc *,
- struct mdoc_node *);
+static void mdoc_node_free(struct roff_node *);
+static void mdoc_node_unlink(struct mdoc *,
+ struct roff_node *);
static void mdoc_free1(struct mdoc *);
static void mdoc_alloc1(struct mdoc *);
-static struct mdoc_node *node_alloc(struct mdoc *, int, int,
- enum mdoct, enum mdoc_type);
-static int node_append(struct mdoc *,
- struct mdoc_node *);
+static struct roff_node *node_alloc(struct mdoc *, int, int,
+ int, enum roff_type);
+static void node_append(struct mdoc *, struct roff_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)
+const struct roff_node *
+mdoc_node(const struct mdoc *mdoc)
{
- return(MDOC_HALT & m->flags ? NULL : m->first);
+ return(mdoc->first);
}
-
-const struct mdoc_meta *
-mdoc_meta(const struct mdoc *m)
+const struct roff_meta *
+mdoc_meta(const struct mdoc *mdoc)
{
- return(MDOC_HALT & m->flags ? NULL : &m->meta);
+ return(&mdoc->meta);
}
-
/*
* Frees volatile resources (parse tree, meta-data, fields).
*/
if (mdoc->first)
mdoc_node_delete(mdoc, mdoc->first);
- if (mdoc->meta.title)
- free(mdoc->meta.title);
- if (mdoc->meta.os)
- free(mdoc->meta.os);
- if (mdoc->meta.name)
- free(mdoc->meta.name);
- if (mdoc->meta.arch)
- free(mdoc->meta.arch);
- if (mdoc->meta.vol)
- free(mdoc->meta.vol);
- if (mdoc->meta.msec)
- free(mdoc->meta.msec);
+ free(mdoc->meta.msec);
+ free(mdoc->meta.vol);
+ free(mdoc->meta.arch);
+ free(mdoc->meta.date);
+ free(mdoc->meta.title);
+ free(mdoc->meta.os);
+ free(mdoc->meta.name);
}
-
/*
* Allocate all volatile resources (parse tree, meta-data, fields).
*/
mdoc_alloc1(struct mdoc *mdoc)
{
- memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
+ memset(&mdoc->meta, 0, sizeof(mdoc->meta));
mdoc->flags = 0;
mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
- mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
+ mdoc->last = mandoc_calloc(1, sizeof(*mdoc->last));
mdoc->first = mdoc->last;
- mdoc->last->type = MDOC_ROOT;
+ mdoc->last->type = ROFFT_ROOT;
+ mdoc->last->tok = MDOC_MAX;
mdoc->next = MDOC_NEXT_CHILD;
}
-
/*
* Free up volatile resources (see mdoc_free1()) then re-initialises the
* data with mdoc_alloc1(). After invocation, parse data has been reset
mdoc_alloc1(mdoc);
}
-
/*
* Completely free up all volatile and non-volatile parse resources.
* After invocation, the pointer is no longer usable.
free(mdoc);
}
-
/*
- * Allocate volatile and non-volatile parse resources.
+ * Allocate volatile and non-volatile parse resources.
*/
struct mdoc *
-mdoc_alloc(void *data, int pflags, mandocmsg msg)
+mdoc_alloc(struct roff *roff, struct mparse *parse,
+ const char *defos, int quick)
{
struct mdoc *p;
p = mandoc_calloc(1, sizeof(struct mdoc));
- p->msg = msg;
- p->data = data;
- p->pflags = pflags;
+ p->parse = parse;
+ p->defos = defos;
+ p->quick = quick;
+ p->roff = roff;
mdoc_hash_init();
mdoc_alloc1(p);
return(p);
}
-
-/*
- * Climb back up the parse tree, validating open scopes. Mostly calls
- * through to macro_end() in macro.c.
- */
-int
-mdoc_endparse(struct mdoc *m)
+void
+mdoc_endparse(struct mdoc *mdoc)
{
- if (MDOC_HALT & m->flags)
- return(0);
- else if (mdoc_macroend(m))
- return(1);
- m->flags |= MDOC_HALT;
- return(0);
+ mdoc_macroend(mdoc);
}
-
-/*
- * 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)
+void
+mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
{
+ struct roff_node *n;
+
+ n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, ROFFT_EQN);
+ n->eqn = ep;
+ if (ep->ln > mdoc->last->line)
+ n->flags |= MDOC_LINE;
+ node_append(mdoc, n);
+ mdoc->next = MDOC_NEXT_SIBLING;
+}
- if (MDOC_HALT & m->flags)
- return(0);
+void
+mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
+{
+ struct roff_node *n;
- m->flags |= MDOC_NEWLINE;
- return(('.' == buf[offs] || '\'' == buf[offs]) ?
- mdoc_pmacro(m, ln, buf, offs) :
- mdoc_ptext(m, ln, buf, offs));
+ n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, ROFFT_TBL);
+ n->span = sp;
+ node_append(mdoc, n);
+ mdoc->next = MDOC_NEXT_SIBLING;
}
-
+/*
+ * 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 *mdoc, 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);
+ if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
+ mdoc->flags |= MDOC_NEWLINE;
- return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
+ /*
+ * 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)
+void
+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));
-
- /* 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);
- 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;
+ if (mdoc->flags & MDOC_PBODY) {
+ if (tok == MDOC_Dt) {
+ mandoc_vmsg(MANDOCERR_DT_LATE,
+ mdoc->parse, line, ppos,
+ "Dt %s", buf + *pos);
+ return;
+ }
+ } else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) {
+ if (mdoc->meta.title == NULL) {
+ mandoc_vmsg(MANDOCERR_DT_NOTITLE,
+ mdoc->parse, line, ppos, "%s %s",
+ mdoc_macronames[tok], buf + *pos);
+ mdoc->meta.title = mandoc_strdup("UNTITLED");
+ }
+ if (NULL == mdoc->meta.vol)
+ mdoc->meta.vol = mandoc_strdup("LOCAL");
+ mdoc->flags |= MDOC_PBODY;
}
-
- return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
+ (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
}
-static int
-node_append(struct mdoc *mdoc, struct mdoc_node *p)
+static void
+node_append(struct mdoc *mdoc, struct roff_node *p)
{
assert(mdoc->last);
assert(mdoc->first);
- assert(MDOC_ROOT != p->type);
+ assert(p->type != ROFFT_ROOT);
switch (mdoc->next) {
- case (MDOC_NEXT_SIBLING):
+ case MDOC_NEXT_SIBLING:
mdoc->last->next = p;
p->prev = mdoc->last;
p->parent = mdoc->last->parent;
break;
- case (MDOC_NEXT_CHILD):
+ case MDOC_NEXT_CHILD:
mdoc->last->child = p;
p->parent = mdoc->last;
break;
p->parent->nchild++;
- if ( ! mdoc_valid_pre(mdoc, p))
- return(0);
- if ( ! mdoc_action_pre(mdoc, p))
- return(0);
+ /*
+ * 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_HEAD):
- assert(MDOC_BLOCK == p->parent->type);
+ case ROFFT_BODY:
+ if (ENDBODY_NOT != p->end)
+ break;
+ /* FALLTHROUGH */
+ case ROFFT_TAIL:
+ /* FALLTHROUGH */
+ case ROFFT_HEAD:
+ p->norm = p->parent->norm;
+ break;
+ default:
+ break;
+ }
+
+ mdoc_valid_pre(mdoc, p);
+
+ switch (p->type) {
+ case ROFFT_HEAD:
+ assert(p->parent->type == ROFFT_BLOCK);
p->parent->head = p;
break;
- case (MDOC_TAIL):
- assert(MDOC_BLOCK == p->parent->type);
+ case ROFFT_TAIL:
+ assert(p->parent->type == ROFFT_BLOCK);
p->parent->tail = p;
break;
- case (MDOC_BODY):
- assert(MDOC_BLOCK == p->parent->type);
+ case ROFFT_BODY:
+ if (p->end)
+ break;
+ assert(p->parent->type == ROFFT_BLOCK);
p->parent->body = p;
break;
default:
mdoc->last = p;
switch (p->type) {
- case (MDOC_TEXT):
- if ( ! mdoc_valid_post(mdoc))
- return(0);
- if ( ! mdoc_action_post(mdoc))
- return(0);
+ case ROFFT_TBL:
+ /* FALLTHROUGH */
+ case ROFFT_TEXT:
+ mdoc_valid_post(mdoc);
break;
default:
break;
}
-
- return(1);
}
-
-static struct mdoc_node *
-node_alloc(struct mdoc *m, int line, int pos,
- enum mdoct tok, enum mdoc_type type)
+static struct roff_node *
+node_alloc(struct mdoc *mdoc, int line, int pos,
+ int tok, enum roff_type type)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- p = mandoc_calloc(1, sizeof(struct mdoc_node));
- p->sec = m->lastsec;
+ p = mandoc_calloc(1, sizeof(*p));
+ p->sec = mdoc->lastsec;
p->line = line;
p->pos = pos;
p->tok = tok;
p->type = type;
- if (MDOC_NEWLINE & m->flags)
+
+ /* 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;
- m->flags &= ~MDOC_NEWLINE;
+ mdoc->flags &= ~MDOC_NEWLINE;
+
return(p);
}
-
-int
-mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+void
+mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_TAIL);
- if ( ! node_append(m, p))
- return(0);
- m->next = MDOC_NEXT_CHILD;
- return(1);
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_TAIL);
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_CHILD;
}
-
-int
-mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+struct roff_node *
+mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- assert(m->first);
- assert(m->last);
-
- p = node_alloc(m, line, pos, tok, MDOC_HEAD);
- if ( ! node_append(m, p))
- return(0);
- m->next = MDOC_NEXT_CHILD;
- return(1);
+ assert(mdoc->first);
+ assert(mdoc->last);
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_HEAD);
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_CHILD;
+ return(p);
}
-
-int
-mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
+struct roff_node *
+mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_BODY);
- if ( ! node_append(m, p))
- return(0);
- m->next = MDOC_NEXT_CHILD;
- return(1);
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY);
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_CHILD;
+ return(p);
}
+struct roff_node *
+mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, int tok,
+ struct roff_node *body, enum mdoc_endbody end)
+{
+ struct roff_node *p;
+
+ body->flags |= MDOC_ENDED;
+ body->parent->flags |= MDOC_ENDED;
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY);
+ p->body = body;
+ p->norm = body->norm;
+ p->end = end;
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ return(p);
+}
-int
-mdoc_block_alloc(struct mdoc *m, int line, int pos,
- enum mdoct tok, struct mdoc_arg *args)
+struct roff_node *
+mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
+ int tok, struct mdoc_arg *args)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_BLOCK);
p->args = args;
if (p->args)
(args->refcnt)++;
- if ( ! node_append(m, p))
- return(0);
- m->next = MDOC_NEXT_CHILD;
- return(1);
-}
+ switch (tok) {
+ case MDOC_Bd:
+ /* FALLTHROUGH */
+ case MDOC_Bf:
+ /* FALLTHROUGH */
+ case MDOC_Bl:
+ /* FALLTHROUGH */
+ case MDOC_En:
+ /* FALLTHROUGH */
+ case MDOC_Rs:
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
+ }
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_CHILD;
+ return(p);
+}
-int
-mdoc_elem_alloc(struct mdoc *m, int line, int pos,
- enum mdoct tok, struct mdoc_arg *args)
+void
+mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
+ int tok, struct mdoc_arg *args)
{
- struct mdoc_node *p;
+ struct roff_node *p;
- p = node_alloc(m, line, pos, tok, MDOC_ELEM);
+ p = node_alloc(mdoc, line, pos, tok, ROFFT_ELEM);
p->args = args;
if (p->args)
(args->refcnt)++;
- if ( ! node_append(m, p))
- return(0);
- m->next = MDOC_NEXT_CHILD;
- return(1);
-}
+ switch (tok) {
+ case MDOC_An:
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
+ }
+ node_append(mdoc, p);
+ mdoc->next = MDOC_NEXT_CHILD;
+}
-int
-mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
+void
+mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
{
- struct mdoc_node *n;
- size_t sv, len;
-
- len = strlen(p);
-
- n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
- n->string = mandoc_malloc(len + 1);
- sv = strlcpy(n->string, p, len + 1);
+ struct roff_node *n;
- /* Prohibit truncation. */
- assert(sv < len + 1);
-
- if ( ! node_append(m, n))
- return(0);
-
- m->next = MDOC_NEXT_SIBLING;
- return(1);
+ n = node_alloc(mdoc, line, pos, MDOC_MAX, ROFFT_TEXT);
+ n->string = roff_strdup(mdoc->roff, p);
+ node_append(mdoc, n);
+ mdoc->next = MDOC_NEXT_SIBLING;
}
-
void
-mdoc_node_free(struct mdoc_node *p)
+mdoc_word_append(struct mdoc *mdoc, const char *p)
+{
+ struct roff_node *n;
+ char *addstr, *newstr;
+
+ n = mdoc->last;
+ addstr = roff_strdup(mdoc->roff, p);
+ mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
+ free(addstr);
+ free(n->string);
+ n->string = newstr;
+ mdoc->next = MDOC_NEXT_SIBLING;
+}
+
+static void
+mdoc_node_free(struct roff_node *p)
{
+ if (p->type == ROFFT_BLOCK || p->type == ROFFT_ELEM)
+ free(p->norm);
if (p->string)
free(p->string);
if (p->args)
free(p);
}
-
static void
-mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
+mdoc_node_unlink(struct mdoc *mdoc, struct roff_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 roff_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);
}
+void
+mdoc_node_relink(struct mdoc *mdoc, struct roff_node *p)
+{
+
+ mdoc_node_unlink(mdoc, p);
+ node_append(mdoc, p);
+}
/*
* Parse free-form text, that is, a line that does not begin with the
* control character.
*/
static int
-mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
+mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
{
+ struct roff_node *n;
char *c, *ws, *end;
- struct mdoc_node *n;
-
- /* Ignore bogus comments. */
-
- 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_pmsg(m, line, offs, MANDOCERR_NOTEXT));
- assert(m->last);
- n = m->last;
+ assert(mdoc->last);
+ n = mdoc->last;
/*
* 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
+ * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry
+ * (a ROFFT_BODY means it's already open, in which case we should
* process within its context in the normal way).
*/
- if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
- LIST_column == n->data.list) {
+ if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+ n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
/* `Bl' is open without any children. */
- m->flags |= MDOC_FREECOL;
- return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
+ return(1);
}
- if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
- NULL != n->parent &&
- MDOC_Bl == n->parent->tok &&
- LIST_column == n->parent->data.list) {
+ if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
+ 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));
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
+ return(1);
}
/*
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;
* Strip trailing tabs in literal context only;
* outside, they affect the next line.
*/
- if (MDOC_LITERAL & m->flags)
+ if (MDOC_LITERAL & mdoc->flags)
continue;
break;
case '\\':
*end = '\0';
if (ws)
- if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE))
- return(0);
+ mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+ line, (int)(ws-buf), NULL);
- if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
- if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN))
- return(0);
+ if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
+ mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
+ line, (int)(c - buf), NULL);
/*
- * 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))
- return(0);
-
- m->next = MDOC_NEXT_SIBLING;
+ mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ mdoc_valid_post(mdoc);
return(1);
}
- if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
- return(0);
+ mdoc_word_alloc(mdoc, line, offs, buf+offs);
- if (MDOC_LITERAL & m->flags)
+ if (mdoc->flags & MDOC_LITERAL)
return(1);
/*
assert(buf < end);
if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
- m->last->flags |= MDOC_EOS;
-
+ mdoc->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. */
- /* 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, int offs)
+static int
+mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
{
- enum mdoct tok;
- int i, j, sv;
+ struct roff_node *n;
+ const char *cp;
+ int tok;
+ int i, sv;
char mac[5];
- struct mdoc_node *n;
-
- /* Empty lines are ignored. */
- offs++;
-
- if ('\0' == buf[offs])
- return(1);
-
- i = offs;
-
- /* Accept whitespace after the initial control char. */
-
- if (' ' == buf[i]) {
- i++;
- while (buf[i] && ' ' == buf[i])
- i++;
- if ('\0' == buf[i])
- return(1);
- }
+ sv = offs;
- sv = i;
+ /*
+ * Copy the first word into a nil-terminated buffer.
+ * Stop when a space, tab, escape, or eoln is encountered.
+ */
- /* Copy the first word into a nil-terminated buffer. */
+ i = 0;
+ while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
+ mac[i++] = buf[offs++];
- for (j = 0; j < 4; j++, i++) {
- if ('\0' == (mac[j] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
+ mac[i] = '\0';
- /* Check for invalid characters. */
+ tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
- if (isgraph((u_char)buf[i]))
- continue;
- if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
- return(0);
- i--;
+ if (tok == MDOC_MAX) {
+ mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
+ ln, sv, buf + sv - 1);
+ return(1);
}
- mac[j] = '\0';
+ /* Skip a leading escape sequence or tab. */
- 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))
- goto err;
- return(1);
+ switch (buf[offs]) {
+ case '\\':
+ cp = buf + offs + 1;
+ mandoc_escape(&cp, NULL, NULL);
+ offs = cp - buf;
+ break;
+ case '\t':
+ offs++;
+ break;
+ default:
+ break;
}
- /* The macro is sane. Jump to the next word. */
+ /* Jump to the next non-whitespace word. */
- while (buf[i] && ' ' == buf[i])
- i++;
+ while (buf[offs] && ' ' == buf[offs])
+ offs++;
- /*
+ /*
* 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_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
- goto err;
+ if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+ mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+ ln, offs - 1, NULL);
/*
* 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;
+ if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
+ mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
return(1);
}
- n = m->last;
- assert(m->last);
+ n = mdoc->last;
+ assert(mdoc->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.list) {
- m->flags |= MDOC_FREECOL;
- if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
- goto err;
+ if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+ n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
return(1);
}
* then open an `It' block context around the parsed macro.
*/
- if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
- NULL != n->parent &&
- MDOC_Bl == n->parent->tok &&
- LIST_column == n->parent->data.list) {
- m->flags |= MDOC_FREECOL;
- if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
- goto err;
+ if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
+ NULL != n->parent &&
+ MDOC_Bl == n->parent->tok &&
+ LIST_column == n->parent->norm->Bl.type) {
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
return(1);
}
/* Normal processing of a macro. */
- if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
- goto err;
+ mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
+
+ /* In quick mode (for mandocdb), abort after the NAME section. */
+
+ if (mdoc->quick && MDOC_Sh == tok &&
+ SEC_NAME != mdoc->last->sec)
+ return(2);
return(1);
+}
+
+enum mdelim
+mdoc_isdelim(const char *p)
+{
-err: /* Error out. */
+ if ('\0' == p[0])
+ return(DELIM_NONE);
- m->flags |= MDOC_HALT;
- return(0);
+ 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);
}
+void
+mdoc_deroff(char **dest, const struct roff_node *n)
+{
+ char *cp;
+ size_t sz;
+
+ if (n->type != ROFFT_TEXT) {
+ for (n = n->child; n; n = n->next)
+ mdoc_deroff(dest, n);
+ return;
+ }
+ /* Skip leading whitespace. */
+
+ for (cp = n->string; '\0' != *cp; cp++)
+ if (0 == isspace((unsigned char)*cp))
+ break;
+
+ /* Skip trailing whitespace. */
+
+ for (sz = strlen(cp); sz; sz--)
+ if (0 == isspace((unsigned char)cp[sz-1]))
+ break;
+
+ /* Skip empty strings. */
+
+ if (0 == sz)
+ return;
+
+ if (NULL == *dest) {
+ *dest = mandoc_strndup(cp, sz);
+ return;
+ }
+
+ mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
+ free(*dest);
+ *dest = cp;
+}