-/* $Id: man.c,v 1.24 2009/06/18 20:46:19 kristaps Exp $ */
+/* $Id: man.c,v 1.117 2012/06/12 20:21:04 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* 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 <assert.h>
-#include <ctype.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
+#include "man.h"
+#include "mandoc.h"
#include "libman.h"
+#include "libmandoc.h"
const char *const __man_macronames[MAN_MAX] = {
"br", "TH", "SH", "SS",
"IP", "HP", "SM", "SB",
"BI", "IB", "BR", "RB",
"R", "B", "I", "IR",
- "RI", "na", "i"
+ "RI", "na", "sp", "nf",
+ "fi", "RE", "RS", "DT",
+ "UC", "PD", "AT", "in",
+ "ft", "OP", "EX", "EE"
};
const char * const *man_macronames = __man_macronames;
-static struct man_node *man_node_alloc(int, int,
- enum man_type, int);
+static struct man_node *man_node_alloc(struct man *, int, int,
+ enum man_type, enum mant);
static int man_node_append(struct man *,
struct man_node *);
-static int man_ptext(struct man *, int, char *);
-static int man_pmacro(struct man *, int, char *);
+static void man_node_free(struct man_node *);
+static void man_node_unlink(struct man *,
+ struct man_node *);
+static int man_ptext(struct man *, int, char *, int);
+static int man_pmacro(struct man *, int, char *, int);
static void man_free1(struct man *);
-static int man_alloc1(struct man *);
+static void man_alloc1(struct man *);
+static int man_descope(struct man *, int, int);
const struct man_node *
man_node(const struct man *m)
{
- return(MAN_HALT & m->flags ? NULL : m->first);
+ assert( ! (MAN_HALT & m->flags));
+ return(m->first);
}
man_meta(const struct man *m)
{
- return(MAN_HALT & m->flags ? NULL : &m->meta);
+ assert( ! (MAN_HALT & m->flags));
+ return(&m->meta);
}
-int
+void
man_reset(struct man *man)
{
man_free1(man);
- return(man_alloc1(man));
+ man_alloc1(man);
}
{
man_free1(man);
-
- if (man->htab)
- man_hash_free(man->htab);
free(man);
}
struct man *
-man_alloc(void *data, int pflags, const struct man_cb *cb)
+man_alloc(struct roff *roff, struct mparse *parse)
{
struct man *p;
- if (NULL == (p = calloc(1, sizeof(struct man))))
- return(NULL);
+ p = mandoc_calloc(1, sizeof(struct man));
- if ( ! man_alloc1(p)) {
- free(p);
- return(NULL);
- }
+ man_hash_init();
+ p->parse = parse;
+ p->roff = roff;
- p->data = data;
- p->pflags = pflags;
- (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
-
- if (NULL == (p->htab = man_hash_alloc())) {
- free(p);
- return(NULL);
- }
+ man_alloc1(p);
return(p);
}
man_endparse(struct man *m)
{
- if (MAN_HALT & m->flags)
- return(0);
- else if (man_macroend(m))
+ assert( ! (MAN_HALT & m->flags));
+ if (man_macroend(m))
return(1);
m->flags |= MAN_HALT;
return(0);
int
-man_parseln(struct man *m, int ln, char *buf)
+man_parseln(struct man *m, int ln, char *buf, int offs)
{
- return('.' == *buf ?
- man_pmacro(m, ln, buf) :
- man_ptext(m, ln, buf));
+ m->flags |= MAN_NEWLINE;
+
+ assert( ! (MAN_HALT & m->flags));
+
+ return (roff_getcontrol(m->roff, buf, &offs) ?
+ man_pmacro(m, ln, buf, offs) :
+ man_ptext(m, ln, buf, offs));
}
{
if (man->first)
- man_node_freelist(man->first);
+ man_node_delete(man, man->first);
if (man->meta.title)
free(man->meta.title);
if (man->meta.source)
free(man->meta.source);
+ if (man->meta.date)
+ free(man->meta.date);
if (man->meta.vol)
free(man->meta.vol);
+ if (man->meta.msec)
+ free(man->meta.msec);
}
-static int
+static void
man_alloc1(struct man *m)
{
- bzero(&m->meta, sizeof(struct man_meta));
+ memset(&m->meta, 0, sizeof(struct man_meta));
m->flags = 0;
- m->last = calloc(1, sizeof(struct man_node));
- if (NULL == m->last)
- return(0);
+ m->last = mandoc_calloc(1, sizeof(struct man_node));
m->first = m->last;
m->last->type = MAN_ROOT;
+ m->last->tok = MAN_MAX;
m->next = MAN_NEXT_CHILD;
- return(1);
}
/* NOTREACHED */
}
+ assert(p->parent);
p->parent->nchild++;
+ if ( ! man_valid_pre(man, p))
+ return(0);
+
+ switch (p->type) {
+ case (MAN_HEAD):
+ assert(MAN_BLOCK == p->parent->type);
+ p->parent->head = p;
+ break;
+ case (MAN_TAIL):
+ assert(MAN_BLOCK == p->parent->type);
+ p->parent->tail = p;
+ break;
+ case (MAN_BODY):
+ assert(MAN_BLOCK == p->parent->type);
+ p->parent->body = p;
+ break;
+ default:
+ break;
+ }
+
man->last = p;
switch (p->type) {
+ case (MAN_TBL):
+ /* FALLTHROUGH */
case (MAN_TEXT):
if ( ! man_valid_post(man))
return(0);
- if ( ! man_action_post(man))
- return(0);
break;
default:
break;
static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type, int tok)
+man_node_alloc(struct man *m, int line, int pos,
+ enum man_type type, enum mant tok)
{
struct man_node *p;
- p = calloc(1, sizeof(struct man_node));
- if (NULL == p)
- return(NULL);
-
+ p = mandoc_calloc(1, sizeof(struct man_node));
p->line = line;
p->pos = pos;
p->type = type;
p->tok = tok;
+
+ if (MAN_NEWLINE & m->flags)
+ p->flags |= MAN_LINE;
+ m->flags &= ~MAN_NEWLINE;
return(p);
}
int
-man_elem_alloc(struct man *man, int line, int pos, int tok)
+man_elem_alloc(struct man *m, int line, int pos, enum mant tok)
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_ELEM, tok);
- if (NULL == p)
+ p = man_node_alloc(m, line, pos, MAN_ELEM, tok);
+ if ( ! man_node_append(m, p))
return(0);
- return(man_node_append(man, p));
+ m->next = MAN_NEXT_CHILD;
+ return(1);
}
int
-man_word_alloc(struct man *man,
- int line, int pos, const char *word)
+man_tail_alloc(struct man *m, int line, int pos, enum mant tok)
{
- struct man_node *p;
+ struct man_node *p;
- p = man_node_alloc(line, pos, MAN_TEXT, -1);
- if (NULL == p)
+ p = man_node_alloc(m, line, pos, MAN_TAIL, tok);
+ if ( ! man_node_append(m, p))
return(0);
- if (NULL == (p->string = strdup(word)))
+ m->next = MAN_NEXT_CHILD;
+ return(1);
+}
+
+
+int
+man_head_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+ struct man_node *p;
+
+ p = man_node_alloc(m, line, pos, MAN_HEAD, tok);
+ if ( ! man_node_append(m, p))
return(0);
- return(man_node_append(man, p));
+ m->next = MAN_NEXT_CHILD;
+ return(1);
}
-void
+int
+man_body_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+ struct man_node *p;
+
+ p = man_node_alloc(m, line, pos, MAN_BODY, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
+}
+
+
+int
+man_block_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+ struct man_node *p;
+
+ p = man_node_alloc(m, line, pos, MAN_BLOCK, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
+}
+
+int
+man_word_alloc(struct man *m, int line, int pos, const char *word)
+{
+ struct man_node *n;
+
+ n = man_node_alloc(m, line, pos, MAN_TEXT, MAN_MAX);
+ n->string = roff_strdup(m->roff, word);
+
+ if ( ! man_node_append(m, n))
+ return(0);
+
+ m->next = MAN_NEXT_SIBLING;
+ return(1);
+}
+
+
+/*
+ * Free all of the resources held by a node. This does NOT unlink a
+ * node from its context; for that, see man_node_unlink().
+ */
+static void
man_node_free(struct man_node *p)
{
if (p->string)
free(p->string);
- if (p->parent)
- p->parent->nchild--;
free(p);
}
void
-man_node_freelist(struct man_node *p)
+man_node_delete(struct man *m, struct man_node *p)
{
- if (p->child)
- man_node_freelist(p->child);
- if (p->next)
- man_node_freelist(p->next);
+ while (p->child)
+ man_node_delete(m, p->child);
- assert(0 == p->nchild);
+ man_node_unlink(m, p);
man_node_free(p);
}
+int
+man_addeqn(struct man *m, const struct eqn *ep)
+{
+ struct man_node *n;
-static int
-man_ptext(struct man *m, int line, char *buf)
+ assert( ! (MAN_HALT & m->flags));
+
+ n = man_node_alloc(m, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
+ n->eqn = ep;
+
+ if ( ! man_node_append(m, n))
+ return(0);
+
+ m->next = MAN_NEXT_SIBLING;
+ return(man_descope(m, ep->ln, ep->pos));
+}
+
+int
+man_addspan(struct man *m, const struct tbl_span *sp)
{
+ struct man_node *n;
+
+ assert( ! (MAN_HALT & m->flags));
- if ( ! man_word_alloc(m, line, 0, buf))
+ n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX);
+ n->span = sp;
+
+ if ( ! man_node_append(m, n))
return(0);
+
m->next = MAN_NEXT_SIBLING;
+ return(man_descope(m, sp->line, 0));
+}
+static int
+man_descope(struct man *m, int line, int offs)
+{
/*
- * If this is one of the zany NLINE macros that consumes the
- * next line of input as being influenced, then close out the
- * existing macro "scope" and continue processing.
+ * Co-ordinate what happens with having a next-line scope open:
+ * first close out the element scope (if applicable), then close
+ * out the block scope (also if applicable).
*/
- if ( ! (MAN_NLINE & m->flags))
- return(1);
+ if (MAN_ELINE & m->flags) {
+ m->flags &= ~MAN_ELINE;
+ if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ return(0);
+ }
- m->flags &= ~MAN_NLINE;
- m->last = m->last->parent;
+ if ( ! (MAN_BLINE & m->flags))
+ return(1);
+ m->flags &= ~MAN_BLINE;
- assert(MAN_ROOT != m->last->type);
- if ( ! man_valid_post(m))
+ if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
return(0);
- if ( ! man_action_post(m))
- return(0);
-
- return(1);
+ return(man_body_alloc(m, line, offs, m->last->tok));
}
-
-int
-man_pmacro(struct man *m, int ln, char *buf)
+static int
+man_ptext(struct man *m, int line, char *buf, int offs)
{
- int i, j, c, ppos, fl;
- char mac[5];
- struct man_node *n;
+ int i;
- /* Comments and empties are quickly ignored. */
+ /* Literal free-form text whitespace is preserved. */
- n = m->last;
- fl = MAN_NLINE & m->flags;
+ if (MAN_LITERAL & m->flags) {
+ if ( ! man_word_alloc(m, line, offs, buf + offs))
+ return(0);
+ return(man_descope(m, line, offs));
+ }
- if (0 == buf[1])
- goto out;
+ /* Pump blank lines directly into the backend. */
- i = 1;
+ for (i = offs; ' ' == buf[i]; i++)
+ /* Skip leading whitespace. */ ;
- if (' ' == buf[i]) {
- i++;
- while (buf[i] && ' ' == buf[i])
- i++;
- if (0 == buf[i])
- goto out;
+ if ('\0' == buf[i]) {
+ /* Allocate a blank entry. */
+ if ( ! man_word_alloc(m, line, offs, ""))
+ return(0);
+ return(man_descope(m, line, offs));
}
- ppos = i;
+ /*
+ * Warn if the last un-escaped character is whitespace. Then
+ * strip away the remaining spaces (tabs stay!).
+ */
- /* Copy the first word into a nil-terminated buffer. */
+ i = (int)strlen(buf);
+ assert(i);
- for (j = 0; j < 4; j++, i++) {
- if (0 == (mac[j] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
+ if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
+ if (i > 1 && '\\' != buf[i - 2])
+ man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE);
+
+ for (--i; i && ' ' == buf[i]; i--)
+ /* Spin back to non-space. */ ;
+
+ /* Jump ahead of escaped whitespace. */
+ i += '\\' == buf[i] ? 2 : 1;
+
+ buf[i] = '\0';
}
- mac[j] = 0;
-
- if (j == 4 || j < 1) {
- if ( ! (MAN_IGN_MACRO & m->pflags)) {
- (void)man_verr(m, ln, ppos,
- "ill-formed macro: %s", mac);
- goto err;
- }
- if ( ! man_vwarn(m, ln, ppos,
- "ill-formed macro: %s", mac))
- goto err;
+ if ( ! man_word_alloc(m, line, offs, buf + offs))
+ 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.
+ */
+
+ assert(i);
+ if (mandoc_eos(buf, (size_t)i, 0))
+ m->last->flags |= MAN_EOS;
+
+ return(man_descope(m, line, offs));
+}
+
+static int
+man_pmacro(struct man *m, int ln, char *buf, int offs)
+{
+ int i, ppos;
+ enum mant tok;
+ char mac[5];
+ struct man_node *n;
+
+ if ('"' == buf[offs]) {
+ man_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
return(1);
- }
-
- if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
- if ( ! (MAN_IGN_MACRO & m->pflags)) {
- (void)man_verr(m, ln, ppos,
- "unknown macro: %s", mac);
- goto err;
- }
- if ( ! man_vwarn(m, ln, ppos,
- "unknown macro: %s", mac))
- goto err;
+ } else if ('\0' == buf[offs])
+ return(1);
+
+ ppos = 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++];
+
+ mac[i] = '\0';
+
+ tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
+
+ if (MAN_MAX == tok) {
+ mandoc_vmsg(MANDOCERR_MACRO, m->parse, ln,
+ ppos, "%s", buf + ppos - 1);
return(1);
}
/* The macro is sane. Jump to the next word. */
- while (buf[i] && ' ' == buf[i])
- i++;
+ while (buf[offs] && ' ' == buf[offs])
+ offs++;
- /* Begin recursive parse sequence. */
+ /*
+ * Trailing whitespace. Note that tabs are allowed to be passed
+ * into the parser as "text", so we only warn about spaces here.
+ */
- if ( ! man_macro(m, c, ln, ppos, &i, buf))
- goto err;
+ if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+ man_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE);
+
+ /*
+ * Remove prior ELINE macro, as it's being clobbered by a new
+ * macro. Note that NSCOPED macros do not close out ELINE
+ * macros---they don't print text---so we let those slip by.
+ */
+
+ if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
+ m->flags & MAN_ELINE) {
+ n = m->last;
+ assert(MAN_TEXT != n->type);
+
+ /* Remove repeated NSCOPED macros causing ELINE. */
-out:
- if (fl) {
- /*
- * A NLINE macro has been immediately followed with
- * another. Close out the preceding macro's scope, and
- * continue.
+ if (MAN_NSCOPED & man_macros[n->tok].flags)
+ n = n->parent;
+
+ mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line,
+ n->pos, "%s breaks %s", man_macronames[tok],
+ man_macronames[n->tok]);
+
+ man_node_delete(m, n);
+ m->flags &= ~MAN_ELINE;
+ }
+
+ /*
+ * Remove prior BLINE macro that is being clobbered.
+ */
+ if ((m->flags & MAN_BLINE) &&
+ (MAN_BSCOPE & man_macros[tok].flags)) {
+ n = m->last;
+
+ /* Might be a text node like 8 in
+ * .TP 8
+ * .SH foo
*/
- assert(MAN_ROOT != m->last->type);
- assert(m->last->parent);
- assert(MAN_ROOT != m->last->parent->type);
+ if (MAN_TEXT == n->type)
+ n = n->parent;
- if (n != m->last)
- m->last = m->last->parent;
+ /* Remove element that didn't end BLINE, if any. */
+ if ( ! (MAN_BSCOPE & man_macros[n->tok].flags))
+ n = n->parent;
- if ( ! man_valid_post(m))
- return(0);
- if ( ! man_action_post(m))
- return(0);
- m->next = MAN_NEXT_SIBLING;
- m->flags &= ~MAN_NLINE;
- }
+ assert(MAN_HEAD == n->type);
+ n = n->parent;
+ assert(MAN_BLOCK == n->type);
+ assert(MAN_SCOPED & man_macros[n->tok].flags);
- return(1);
+ mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line,
+ n->pos, "%s breaks %s", man_macronames[tok],
+ man_macronames[n->tok]);
+
+ man_node_delete(m, n);
+ m->flags &= ~MAN_BLINE;
+ }
+
+ /*
+ * Save the fact that we're in the next-line for a block. In
+ * this way, embedded roff instructions can "remember" state
+ * when they exit.
+ */
+
+ if (MAN_BLINE & m->flags)
+ m->flags |= MAN_BPLINE;
+
+ /* Call to handler... */
+
+ assert(man_macros[tok].fp);
+ if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf))
+ goto err;
+
+ /*
+ * We weren't in a block-line scope when entering the
+ * above-parsed macro, so return.
+ */
+
+ if ( ! (MAN_BPLINE & m->flags)) {
+ m->flags &= ~MAN_ILINE;
+ return(1);
+ }
+ m->flags &= ~MAN_BPLINE;
+
+ /*
+ * If we're in a block scope, then allow this macro to slip by
+ * without closing scope around it.
+ */
+
+ if (MAN_ILINE & m->flags) {
+ m->flags &= ~MAN_ILINE;
+ return(1);
+ }
+
+ /*
+ * If we've opened a new next-line element scope, then return
+ * now, as the next line will close out the block scope.
+ */
+
+ if (MAN_ELINE & m->flags)
+ return(1);
+
+ /* Close out the block scope opened in the prior line. */
+
+ assert(MAN_BLINE & m->flags);
+ m->flags &= ~MAN_BLINE;
+
+ if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ return(0);
+ return(man_body_alloc(m, ln, ppos, m->last->tok));
err: /* Error out. */
return(0);
}
-
-int
-man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
+/*
+ * Unlink a node from its context. If "m" is provided, the last parse
+ * point will also be adjusted accordingly.
+ */
+static void
+man_node_unlink(struct man *m, struct man_node *n)
{
- char buf[256];
- va_list ap;
- if (NULL == man->cb.man_err)
- return(0);
+ /* Adjust siblings. */
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- return((*man->cb.man_err)(man->data, ln, pos, buf));
-}
+ if (n->prev)
+ n->prev->next = n->next;
+ if (n->next)
+ n->next->prev = n->prev;
+ /* Adjust parent. */
-int
-man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
+ if (n->parent) {
+ n->parent->nchild--;
+ if (n->parent->child == n)
+ n->parent->child = n->prev ? n->prev : n->next;
+ }
- if (NULL == man->cb.man_warn)
- return(0);
+ /* Adjust parse point, if applicable. */
+
+ if (m && m->last == n) {
+ /*XXX: this can occur when bailing from validation. */
+ /*assert(NULL == n->next);*/
+ if (n->prev) {
+ m->last = n->prev;
+ m->next = MAN_NEXT_SIBLING;
+ } else {
+ m->last = n->parent;
+ m->next = MAN_NEXT_CHILD;
+ }
+ }
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- return((*man->cb.man_warn)(man->data, ln, pos, buf));
+ if (m && m->first == n)
+ m->first = NULL;
}
-
-int
-man_err(struct man *m, int line, int pos,
- int iserr, enum merr type)
+const struct mparse *
+man_mparse(const struct man *m)
{
- const char *p;
-
- p = NULL;
- switch (type) {
- case (WNPRINT):
- p = "invalid character";
- break;
- case (WNMEM):
- p = "memory exhausted";
- break;
- case (WMSEC):
- p = "invalid manual section";
- break;
- case (WDATE):
- p = "invalid date format";
- break;
- case (WLNSCOPE):
- p = "scope of prior line violated";
- break;
- case (WTSPACE):
- p = "trailing whitespace at end of line";
- break;
- case (WTQUOTE):
- p = "unterminated quotation";
- break;
- }
- assert(p);
-
- if (iserr)
- return(man_verr(m, line, pos, p));
- return(man_vwarn(m, line, pos, p));
+ assert(m && m->parse);
+ return(m->parse);
}
git.ckatri.com / mandoc.git / blobdiff