-/* $Id: man.c,v 1.82 2010/07/13 23:53:20 schwarze Exp $ */
+/* $Id: man.c,v 1.107 2011/03/29 08:30:49 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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
#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"
"IP", "HP", "SM", "SB",
"BI", "IB", "BR", "RB",
"R", "B", "I", "IR",
- "RI", "na", "i", "sp",
- "nf", "fi", "r", "RE",
- "RS", "DT", "UC", "PD",
- "Sp", "Vb", "Ve", "AT",
+ "RI", "na", "sp", "nf",
+ "fi", "RE", "RS", "DT",
+ "UC", "PD", "AT", "in",
+ "ft"
};
const char * const *man_macronames = __man_macronames;
-static struct man_node *man_node_alloc(int, 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_pmacro(struct man *, int, char *, int);
static void man_free1(struct man *);
static void man_alloc1(struct man *);
-static int macrowarn(struct man *, int, const char *, int);
+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);
}
struct man *
-man_alloc(struct regset *regs, void *data,
- int pflags, mandocmsg msg)
+man_alloc(struct regset *regs, struct mparse *parse)
{
struct man *p;
p = mandoc_calloc(1, sizeof(struct man));
man_hash_init();
- p->data = data;
- p->pflags = pflags;
- p->msg = msg;
+ p->parse = parse;
p->regs = regs;
man_alloc1(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);
man_parseln(struct man *m, int ln, char *buf, int offs)
{
- if (MAN_HALT & m->flags)
- return(0);
+ m->flags |= MAN_NEWLINE;
- return(('.' == buf[offs] || '\'' == buf[offs]) ?
+ assert( ! (MAN_HALT & m->flags));
+
+ return (mandoc_getcontrol(buf, &offs) ?
man_pmacro(m, ln, buf, offs) :
man_ptext(m, ln, buf, offs));
}
free(man->meta.title);
if (man->meta.source)
free(man->meta.source);
- if (man->meta.rawdate)
- free(man->meta.rawdate);
+ if (man->meta.date)
+ free(man->meta.date);
if (man->meta.vol)
free(man->meta.vol);
if (man->meta.msec)
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;
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, enum mant tok)
+man_node_alloc(struct man *m, int line, int pos,
+ enum man_type type, enum mant tok)
{
struct man_node *p;
p->pos = pos;
p->type = type;
p->tok = tok;
+
+ if (MAN_NEWLINE & m->flags)
+ p->flags |= MAN_LINE;
+ m->flags &= ~MAN_NEWLINE;
return(p);
}
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_ELEM, tok);
+ p = man_node_alloc(m, line, pos, MAN_ELEM, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
+}
+
+
+int
+man_tail_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+ struct man_node *p;
+
+ p = man_node_alloc(m, line, pos, MAN_TAIL, tok);
if ( ! man_node_append(m, p))
return(0);
m->next = MAN_NEXT_CHILD;
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_HEAD, tok);
+ p = man_node_alloc(m, line, pos, MAN_HEAD, tok);
if ( ! man_node_append(m, p))
return(0);
m->next = MAN_NEXT_CHILD;
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_BODY, tok);
+ p = man_node_alloc(m, line, pos, MAN_BODY, tok);
if ( ! man_node_append(m, p))
return(0);
m->next = MAN_NEXT_CHILD;
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_BLOCK, tok);
+ 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)
{
len = strlen(word);
- n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX);
+ n = man_node_alloc(m, line, pos, MAN_TEXT, MAN_MAX);
n->string = mandoc_malloc(len + 1);
sv = strlcpy(n->string, word, len + 1);
man_node_free(p);
}
+int
+man_addeqn(struct man *m, const struct eqn *ep)
+{
+ struct man_node *n;
+
+ assert( ! (MAN_HALT & m->flags));
+
+ n = man_node_alloc(m, ep->line, 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->line, ep->pos));
+}
+
+int
+man_addspan(struct man *m, const struct tbl_span *sp)
+{
+ struct man_node *n;
+
+ assert( ! (MAN_HALT & m->flags));
+
+ 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_ptext(struct man *m, int line, char *buf, int offs)
+man_descope(struct man *m, int line, int offs)
{
- int i;
+ /*
+ * 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).
+ */
- /* Ignore bogus comments. */
+ if (MAN_ELINE & m->flags) {
+ m->flags &= ~MAN_ELINE;
+ if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ return(0);
+ }
- if ('\\' == buf[offs] &&
- '.' == buf[offs + 1] &&
- '"' == buf[offs + 2])
- return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
+ if ( ! (MAN_BLINE & m->flags))
+ return(1);
+ m->flags &= ~MAN_BLINE;
+
+ if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ return(0);
+ return(man_body_alloc(m, line, offs, m->last->tok));
+}
+
+static int
+man_ptext(struct man *m, int line, char *buf, int offs)
+{
+ int i;
/* Literal free-form text whitespace is preserved. */
if (MAN_LITERAL & m->flags) {
if ( ! man_word_alloc(m, line, offs, buf + offs))
return(0);
- goto descope;
+ return(man_descope(m, line, offs));
}
/* Pump blank lines directly into the backend. */
/* Allocate a blank entry. */
if ( ! man_word_alloc(m, line, offs, ""))
return(0);
- goto descope;
+ return(man_descope(m, line, offs));
}
/*
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
if (i > 1 && '\\' != buf[i - 2])
- if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE))
- return(0);
+ man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE);
for (--i; i && ' ' == buf[i]; i--)
/* Spin back to non-space. */ ;
*/
assert(i);
- if (mandoc_eos(buf, (size_t)i))
+ if (mandoc_eos(buf, (size_t)i, 0))
m->last->flags |= MAN_EOS;
-descope:
- /*
- * 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_ELINE & m->flags) {
- m->flags &= ~MAN_ELINE;
- if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
- return(0);
- }
-
- if ( ! (MAN_BLINE & m->flags))
- return(1);
- m->flags &= ~MAN_BLINE;
-
- if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
- return(0);
- return(man_body_alloc(m, line, offs, m->last->tok));
+ return(man_descope(m, line, offs));
}
-
static int
-macrowarn(struct man *m, int ln, const char *buf, int offs)
-{
- int rc;
-
- rc = man_vmsg(m, MANDOCERR_MACRO, ln, offs,
- "unknown macro: %s%s",
- buf, strlen(buf) > 3 ? "..." : "");
-
- return(MAN_IGN_MACRO & m->pflags ? rc : 0);
-}
-
-
-int
man_pmacro(struct man *m, int ln, char *buf, int offs)
{
- int i, j, ppos;
+ int i, ppos;
enum mant tok;
char mac[5];
struct man_node *n;
- /* Comments and empties are quickly ignored. */
-
- offs++;
-
- if ('\0' == buf[offs])
+ if ('"' == buf[offs]) {
+ man_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
+ return(1);
+ } else if ('\0' == buf[offs])
return(1);
- i = offs;
+ ppos = offs;
/*
- * Skip whitespace between the control character and initial
- * text. "Whitespace" is both spaces and tabs.
+ * Copy the first word into a nil-terminated buffer.
+ * Stop copying when a tab, space, or eoln is encountered.
*/
- if (' ' == buf[i] || '\t' == buf[i]) {
- i++;
- while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
- i++;
- if ('\0' == buf[i])
- goto out;
- }
+ i = 0;
+ while (i < 4 && '\0' != buf[offs] &&
+ ' ' != buf[offs] && '\t' != buf[offs])
+ mac[i++] = buf[offs++];
- ppos = i;
+ mac[i] = '\0';
- /* Copy the first word into a nil-terminated buffer. */
+ tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
- for (j = 0; j < 4; j++, i++) {
- if ('\0' == (mac[j] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
-
- /* Check for invalid characters. */
-
- if (isgraph((u_char)buf[i]))
- continue;
- if ( ! man_pmsg(m, ln, i, MANDOCERR_BADCHAR))
- return(0);
- i--;
- }
-
- mac[j] = '\0';
-
- if (j == 4 || j < 1) {
- if ( ! macrowarn(m, ln, mac, ppos))
- goto err;
- return(1);
- }
-
- if (MAN_MAX == (tok = man_hash_find(mac))) {
- if ( ! macrowarn(m, ln, mac, ppos))
- goto err;
+ 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++;
/*
* 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 ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
- 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 clobbering by a new
+ * 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) {
- assert(MAN_TEXT != m->last->type);
-
- /*
- * This occurs in the following construction:
- * .B
- * .br
- * .B
- * .br
- * I hate man macros.
- * Flat-out disallow this madness.
- */
- if (MAN_NSCOPED & man_macros[m->last->tok].flags) {
- man_pmsg(m, ln, ppos, MANDOCERR_SYNTLINESCOPE);
- return(0);
- }
-
n = m->last;
+ assert(MAN_TEXT != n->type);
- assert(n);
- assert(NULL == n->child);
- assert(0 == n->nchild);
+ /* Remove repeated NSCOPED macros causing ELINE. */
- if ( ! man_nmsg(m, n, MANDOCERR_LINESCOPE))
- return(0);
+ if (MAN_NSCOPED & man_macros[n->tok].flags)
+ n = n->parent;
+
+ mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line,
+ n->pos, "%s", man_macronames[n->tok]);
man_node_delete(m, n);
m->flags &= ~MAN_ELINE;
/* Call to handler... */
assert(man_macros[tok].fp);
- if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))
+ if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf))
goto err;
-out:
/*
* We weren't in a block-line scope when entering the
* above-parsed macro, so return.
if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
return(0);
- return(man_body_alloc(m, ln, offs, m->last->tok));
+ return(man_body_alloc(m, ln, ppos, m->last->tok));
err: /* Error out. */
return(0);
}
-
-int
-man_vmsg(struct man *man, enum mandocerr t,
- int ln, int pos, const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
-
- va_start(ap, fmt);
- vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- return((*man->msg)(t, man->data, ln, pos, buf));
-}
-
-
/*
* Unlink a node from its context. If "m" is provided, the last parse
* point will also be adjusted accordingly.