-/* $Id: man.c,v 1.1 2009/03/23 14:22:11 kristaps Exp $ */
+/* $Id: man.c,v 1.46 2009/11/02 08:40:31 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* 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.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
*/
+#include <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
-#include <err.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "libman.h"
+#include "libmandoc.h"
+
+const char *const __man_merrnames[WERRMAX] = {
+ "invalid character", /* WNPRINT */
+ "invalid manual section", /* WMSEC */
+ "invalid date format", /* WDATE */
+ "scope of prior line violated", /* WLNSCOPE */
+ "trailing whitespace", /* WTSPACE */
+ "unterminated quoted parameter", /* WTQUOTE */
+ "document has no body", /* WNODATA */
+ "document has no title/section", /* WNOTITLE */
+ "invalid escape sequence", /* WESCAPE */
+ "invalid number format", /* WNUMFMT */
+ "expected block head arguments", /* WHEADARGS */
+ "expected block body arguments", /* WBODYARGS */
+ "expected empty block head", /* WNHEADARGS */
+ "ill-formed macro", /* WMACROFORM */
+ "scope open on exit", /* WEXITSCOPE */
+ "no scope context", /* WNOSCOPE */
+ "literal context already open", /* WOLITERAL */
+ "no literal context open" /* WNLITERAL */
+};
const char *const __man_macronames[MAN_MAX] = {
- "\\\"", "TH", "SH", "SS",
+ "br", "TH", "SH", "SS",
"TP", "LP", "PP", "P",
"IP", "HP", "SM", "SB",
"BI", "IB", "BR", "RB",
- "R", "B", "I"
+ "R", "B", "I", "IR",
+ "RI", "na", "i", "sp",
+ "nf", "fi", "r", "RE",
+ "RS", "DT", "UC", "PD"
};
const char * const *man_macronames = __man_macronames;
-static struct man_node *man_node_alloc(int, int, enum man_type);
+static struct man_node *man_node_alloc(int, int,
+ enum man_type, int);
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_free1(struct man *);
+static void man_alloc1(struct man *);
+static int pstring(struct man *, int, int,
+ const char *, size_t);
+static int macrowarn(struct man *, int, const char *);
+
+#ifdef __linux__
+extern size_t strlcpy(char *, const char *, size_t);
+#endif
const struct man_node *
-man_node(const struct man *man)
+man_node(const struct man *m)
{
- return(man->first);
+ return(MAN_HALT & m->flags ? NULL : m->first);
}
const struct man_meta *
-man_meta(const struct man *man)
+man_meta(const struct man *m)
{
- return(&man->meta);
+ return(MAN_HALT & m->flags ? NULL : &m->meta);
}
man_reset(struct man *man)
{
- if (man->first)
- man_node_freelist(man->first);
- if (man->meta.title)
- free(man->meta.title);
- if (man->meta.os)
- free(man->meta.os);
- if (man->meta.vol)
- free(man->meta.vol);
-
- bzero(&man->meta, sizeof(struct man_meta));
- man->flags = 0;
- if (NULL == (man->last = calloc(1, sizeof(struct man_node))))
- err(1, "malloc");
- man->first = man->last;
- man->last->type = MAN_ROOT;
- man->next = MAN_NEXT_CHILD;
+ man_free1(man);
+ man_alloc1(man);
}
man_free(struct man *man)
{
- if (man->first)
- man_node_freelist(man->first);
- if (man->meta.title)
- free(man->meta.title);
- if (man->meta.os)
- free(man->meta.os);
- if (man->meta.vol)
- free(man->meta.vol);
- if (man->htab)
- man_hash_free(man->htab);
+ man_free1(man);
free(man);
}
struct man *
-man_alloc(void)
+man_alloc(void *data, int pflags, const struct man_cb *cb)
{
struct man *p;
- if (NULL == (p = calloc(1, sizeof(struct man))))
- err(1, "malloc");
- if (NULL == (p->last = calloc(1, sizeof(struct man_node))))
- err(1, "malloc");
+ p = mandoc_calloc(1, sizeof(struct man));
- p->first = p->last;
- p->last->type = MAN_ROOT;
- p->next = MAN_NEXT_CHILD;
- p->htab = man_hash_alloc();
+ if (cb)
+ memcpy(&p->cb, cb, sizeof(struct man_cb));
+
+ man_hash_init();
+ p->data = data;
+ p->pflags = pflags;
+
+ man_alloc1(p);
return(p);
}
man_endparse(struct man *m)
{
- return(1);
+ if (MAN_HALT & m->flags)
+ return(0);
+ else if (man_macroend(m))
+ return(1);
+ m->flags |= MAN_HALT;
+ return(0);
}
}
+static void
+man_free1(struct man *man)
+{
+
+ if (man->first)
+ man_node_freelist(man->first);
+ if (man->meta.title)
+ free(man->meta.title);
+ if (man->meta.source)
+ free(man->meta.source);
+ if (man->meta.vol)
+ free(man->meta.vol);
+}
+
+
+static void
+man_alloc1(struct man *m)
+{
+
+ memset(&m->meta, 0, sizeof(struct man_meta));
+ m->flags = 0;
+ m->last = mandoc_calloc(1, sizeof(struct man_node));
+ m->first = m->last;
+ m->last->type = MAN_ROOT;
+ m->next = MAN_NEXT_CHILD;
+}
+
+
static int
man_node_append(struct man *man, struct man_node *p)
{
abort();
/* NOTREACHED */
}
+
+ p->parent->nchild++;
-#if 0
if ( ! man_valid_pre(man, p))
return(0);
- if ( ! man_action_pre(man, p))
- return(0);
-#endif
switch (p->type) {
case (MAN_HEAD):
}
man->last = p;
+
+ switch (p->type) {
+ case (MAN_TEXT):
+ if ( ! man_valid_post(man))
+ return(0);
+ if ( ! man_action_post(man))
+ return(0);
+ break;
+ default:
+ break;
+ }
+
return(1);
}
static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type)
+man_node_alloc(int line, int pos, enum man_type type, int tok)
{
struct man_node *p;
- if (NULL == (p = calloc(1, sizeof(struct man_node))))
- err(1, "malloc");
+ p = mandoc_calloc(1, sizeof(struct man_node));
p->line = line;
p->pos = pos;
p->type = type;
-
+ p->tok = tok;
return(p);
}
int
-man_head_alloc(struct man *man, int line, int pos, int tok)
+man_elem_alloc(struct man *m, int line, int pos, int tok)
{
- struct man_node *p;
-
- p = man_node_alloc(line, pos, MAN_HEAD);
- p->tok = tok;
+ struct man_node *p;
- return(man_node_append(man, p));
+ p = man_node_alloc(line, pos, MAN_ELEM, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
}
int
-man_body_alloc(struct man *man, int line, int pos, int tok)
+man_head_alloc(struct man *m, int line, int pos, int tok)
{
- struct man_node *p;
-
- p = man_node_alloc(line, pos, MAN_BODY);
- p->tok = tok;
+ struct man_node *p;
- return(man_node_append(man, p));
+ p = man_node_alloc(line, pos, MAN_HEAD, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
}
int
-man_block_alloc(struct man *man, int line, int pos, int tok)
+man_body_alloc(struct man *m, int line, int pos, int tok)
{
- struct man_node *p;
-
- p = man_node_alloc(line, pos, MAN_BLOCK);
- p->tok = tok;
+ struct man_node *p;
- return(man_node_append(man, p));
+ p = man_node_alloc(line, pos, MAN_BODY, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
}
int
-man_elem_alloc(struct man *man, int line, int pos, int tok)
+man_block_alloc(struct man *m, int line, int pos, int tok)
{
struct man_node *p;
- p = man_node_alloc(line, pos, MAN_ELEM);
- p->tok = tok;
+ p = man_node_alloc(line, pos, MAN_BLOCK, tok);
+ if ( ! man_node_append(m, p))
+ return(0);
+ m->next = MAN_NEXT_CHILD;
+ return(1);
+}
- return(man_node_append(man, p));
+
+static int
+pstring(struct man *m, int line, int pos,
+ const char *p, size_t len)
+{
+ struct man_node *n;
+ size_t sv;
+
+ n = man_node_alloc(line, pos, MAN_TEXT, -1);
+ n->string = mandoc_malloc(len + 1);
+ sv = strlcpy(n->string, p, len + 1);
+
+ /* Prohibit truncation. */
+ assert(sv < len + 1);
+
+ if ( ! man_node_append(m, n))
+ return(0);
+ m->next = MAN_NEXT_SIBLING;
+ return(1);
}
int
-man_word_alloc(struct man *man,
- int line, int pos, const char *word)
+man_word_alloc(struct man *m, int line, int pos, const char *word)
{
- struct man_node *p;
- p = man_node_alloc(line, pos, MAN_TEXT);
- if (NULL == (p->string = strdup(word)))
- err(1, "strdup");
-
- return(man_node_append(man, p));
+ return(pstring(m, line, pos, word, strlen(word)));
}
if (p->string)
free(p->string);
+ if (p->parent)
+ p->parent->nchild--;
free(p);
}
void
man_node_freelist(struct man_node *p)
{
+ struct man_node *n;
if (p->child)
man_node_freelist(p->child);
- if (p->next)
- man_node_freelist(p->next);
-
+ assert(0 == p->nchild);
+ n = p->next;
man_node_free(p);
+ if (n)
+ man_node_freelist(n);
}
static int
man_ptext(struct man *m, int line, char *buf)
{
+ int i, j;
- if (0 == buf[0]) {
- warnx("blank line!");
- return(1);
+ /* Literal free-form text whitespace is preserved. */
+
+ if (MAN_LITERAL & m->flags) {
+ if ( ! man_word_alloc(m, line, 0, buf))
+ return(0);
+ goto descope;
+ }
+
+ /* First de-chunk and allocate words. */
+
+ for (i = 0; ' ' == buf[i]; i++)
+ /* Skip leading whitespace. */ ;
+ if (0 == buf[i]) {
+ if ( ! pstring(m, line, 0, &buf[i], 0))
+ return(0);
+ goto descope;
+ }
+
+ for (j = i; buf[i]; i++) {
+ if (' ' != buf[i])
+ continue;
+
+ /* Escaped whitespace. */
+ if (i && ' ' == buf[i] && '\\' == buf[i - 1])
+ continue;
+
+ buf[i++] = 0;
+ if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ return(0);
+
+ for ( ; ' ' == buf[i]; i++)
+ /* Skip trailing whitespace. */ ;
+
+ j = i;
+ if (0 == buf[i])
+ break;
}
- if ( ! man_word_alloc(m, line, 0, buf))
+ if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
return(0);
- m->next = MAN_NEXT_SIBLING;
- return(1);
+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))
+ return(0);
+ }
+
+ if ( ! (MAN_BLINE & m->flags))
+ return(1);
+ m->flags &= ~MAN_BLINE;
+
+ if ( ! man_unscope(m, m->last->parent))
+ return(0);
+ return(man_body_alloc(m, line, 0, m->last->tok));
+}
+
+
+static int
+macrowarn(struct man *m, int ln, const char *buf)
+{
+ if ( ! (MAN_IGN_MACRO & m->pflags))
+ return(man_verr(m, ln, 0,
+ "unknown macro: %s%s",
+ buf, strlen(buf) > 3 ? "..." : ""));
+ return(man_vwarn(m, ln, 0, "unknown macro: %s%s",
+ buf, strlen(buf) > 3 ? "..." : ""));
}
int
man_pmacro(struct man *m, int ln, char *buf)
{
- int i, c;
- char mac[5];
+ int i, j, c, ppos, fl;
+ char mac[5];
+ struct man_node *n;
/* Comments and empties are quickly ignored. */
- if (0 == buf[1])
+ fl = m->flags;
+
+ if ('\0' == buf[1])
return(1);
- if (' ' == buf[1]) {
- i = 2;
+ i = 1;
+
+ if (' ' == buf[i]) {
+ i++;
while (buf[i] && ' ' == buf[i])
i++;
if (0 == buf[i])
- return(1);
- warnx("invalid syntax");
- return(0);
+ goto out;
}
- if (buf[1] && '\\' == buf[1])
- if (buf[2] && '\"' == buf[2])
- return(1);
+ ppos = i;
/* Copy the first word into a nil-terminated buffer. */
- for (i = 1; i < 5; i++) {
- if (0 == (mac[i - 1] = buf[i]))
+ 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;
+ return(man_perr(m, ln, i, WNPRINT));
}
- mac[i - 1] = 0;
+ mac[j] = '\0';
- if (i == 5 || i <= 1) {
- warnx("unknown macro: %s", mac);
- goto err;
- }
+ if (j == 4 || j < 1) {
+ if ( ! (MAN_IGN_MACRO & m->pflags)) {
+ (void)man_perr(m, ln, ppos, WMACROFORM);
+ goto err;
+ }
+ if ( ! man_pwarn(m, ln, ppos, WMACROFORM))
+ goto err;
+ return(1);
+ }
- if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
- warnx("unknown macro: %s", mac);
- goto err;
+ if (MAN_MAX == (c = man_hash_find(mac))) {
+ if ( ! macrowarn(m, ln, mac))
+ goto err;
+ return(1);
}
/* The macro is sane. Jump to the next word. */
while (buf[i] && ' ' == buf[i])
i++;
+ /* Remove prior ELINE macro, if applicable. */
+
+ if (m->flags & MAN_ELINE) {
+ n = m->last;
+ assert(NULL == n->child);
+ assert(0 == n->nchild);
+ if ( ! man_nwarn(m, n, WLNSCOPE))
+ return(0);
+
+ if (n->prev) {
+ assert(n != n->parent->child);
+ assert(n == n->prev->next);
+ n->prev->next = NULL;
+ m->last = n->prev;
+ m->next = MAN_NEXT_SIBLING;
+ } else {
+ assert(n == n->parent->child);
+ n->parent->child = NULL;
+ m->last = n->parent;
+ m->next = MAN_NEXT_CHILD;
+ }
+
+ man_node_free(n);
+ m->flags &= ~MAN_ELINE;
+ }
+
/* Begin recursive parse sequence. */
- if ( ! (*man_macros[c].fp)(m, c, ln, 1, &i, buf))
+ assert(man_macros[c].fp);
+
+ if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))
goto err;
- return(1);
+out:
+ if ( ! (MAN_BLINE & fl))
+ 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))
+ return(0);
+ return(man_body_alloc(m, ln, 0, m->last->tok));
err: /* Error out. */
-#if 0
- m->flags |= MDOC_HALT;
-#endif
+ m->flags |= MAN_HALT;
return(0);
}
+
+
+int
+man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
+{
+ char buf[256];
+ va_list ap;
+
+ if (NULL == man->cb.man_err)
+ return(0);
+
+ 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));
+}
+
+
+int
+man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)
+{
+ char buf[256];
+ va_list ap;
+
+ if (NULL == man->cb.man_warn)
+ return(0);
+
+ 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));
+}
+
+
+int
+man_err(struct man *m, int line, int pos, int iserr, enum merr type)
+{
+ const char *p;
+
+ p = __man_merrnames[(int)type];
+ assert(p);
+
+ if (iserr)
+ return(man_verr(m, line, pos, p));
+
+ return(man_vwarn(m, line, pos, p));
+}
git.ckatri.com / mandoc.git / blobdiff