-/* $Id: man.c,v 1.111 2011/07/28 14:17:11 kristaps Exp $ */
+/* $Id: man.c,v 1.130 2014/05/07 14:14:17 schwarze Exp $ */
/*
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.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 <stdlib.h>
#include <stdio.h>
#include "man.h"
#include "mandoc.h"
+#include "mandoc_aux.h"
#include "libman.h"
#include "libmandoc.h"
-const char *const __man_macronames[MAN_MAX] = {
+const char *const __man_macronames[MAN_MAX] = {
"br", "TH", "SH", "SS",
- "TP", "LP", "PP", "P",
+ "TP", "LP", "PP", "P",
"IP", "HP", "SM", "SB",
"BI", "IB", "BR", "RB",
"R", "B", "I", "IR",
"RI", "na", "sp", "nf",
"fi", "RE", "RS", "DT",
"UC", "PD", "AT", "in",
- "ft"
+ "ft", "OP", "EX", "EE",
+ "UR", "UE", "ll"
};
const char * const *man_macronames = __man_macronames;
-static struct man_node *man_node_alloc(struct man *, 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 *,
+static int man_node_append(struct man *,
struct man_node *);
static void man_node_free(struct man_node *);
-static void man_node_unlink(struct man *,
+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);
const struct man_node *
-man_node(const struct man *m)
+man_node(const struct man *man)
{
- assert( ! (MAN_HALT & m->flags));
- return(m->first);
+ assert( ! (MAN_HALT & man->flags));
+ return(man->first);
}
-
const struct man_meta *
-man_meta(const struct man *m)
+man_meta(const struct man *man)
{
- assert( ! (MAN_HALT & m->flags));
- return(&m->meta);
+ assert( ! (MAN_HALT & man->flags));
+ return(&man->meta);
}
-
void
man_reset(struct man *man)
{
man_alloc1(man);
}
-
void
man_free(struct man *man)
{
free(man);
}
-
struct man *
-man_alloc(struct roff *roff, struct mparse *parse)
+man_alloc(struct roff *roff, struct mparse *parse, int quick)
{
struct man *p;
man_hash_init();
p->parse = parse;
+ p->quick = quick;
p->roff = roff;
man_alloc1(p);
return(p);
}
-
int
-man_endparse(struct man *m)
+man_endparse(struct man *man)
{
- assert( ! (MAN_HALT & m->flags));
- if (man_macroend(m))
+ assert( ! (MAN_HALT & man->flags));
+ if (man_macroend(man))
return(1);
- m->flags |= MAN_HALT;
+ man->flags |= MAN_HALT;
return(0);
}
-
int
-man_parseln(struct man *m, int ln, char *buf, int offs)
+man_parseln(struct man *man, int ln, char *buf, int offs)
{
- m->flags |= MAN_NEWLINE;
+ man->flags |= MAN_NEWLINE;
- assert( ! (MAN_HALT & m->flags));
+ assert( ! (MAN_HALT & man->flags));
- return (mandoc_getcontrol(buf, &offs) ?
- man_pmacro(m, ln, buf, offs) :
- man_ptext(m, ln, buf, offs));
+ return (roff_getcontrol(man->roff, buf, &offs) ?
+ man_pmacro(man, ln, buf, offs) :
+ man_ptext(man, ln, buf, offs));
}
-
static void
man_free1(struct man *man)
{
free(man->meta.msec);
}
-
static void
-man_alloc1(struct man *m)
+man_alloc1(struct man *man)
{
- 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->last->tok = MAN_MAX;
- m->next = MAN_NEXT_CHILD;
+ memset(&man->meta, 0, sizeof(struct man_meta));
+ man->flags = 0;
+ man->last = mandoc_calloc(1, sizeof(struct man_node));
+ man->first = man->last;
+ man->last->type = MAN_ROOT;
+ man->last->tok = MAN_MAX;
+ man->next = MAN_NEXT_CHILD;
}
assert(MAN_ROOT != p->type);
switch (man->next) {
- case (MAN_NEXT_SIBLING):
+ case MAN_NEXT_SIBLING:
man->last->next = p;
p->prev = man->last;
p->parent = man->last->parent;
break;
- case (MAN_NEXT_CHILD):
+ case MAN_NEXT_CHILD:
man->last->child = p;
p->parent = man->last;
break;
abort();
/* NOTREACHED */
}
-
+
assert(p->parent);
p->parent->nchild++;
return(0);
switch (p->type) {
- case (MAN_HEAD):
+ case MAN_HEAD:
assert(MAN_BLOCK == p->parent->type);
p->parent->head = p;
break;
- case (MAN_TAIL):
+ case MAN_TAIL:
assert(MAN_BLOCK == p->parent->type);
p->parent->tail = p;
break;
- case (MAN_BODY):
+ case MAN_BODY:
assert(MAN_BLOCK == p->parent->type);
p->parent->body = p;
break;
man->last = p;
switch (p->type) {
- case (MAN_TBL):
+ case MAN_TBL:
/* FALLTHROUGH */
- case (MAN_TEXT):
+ case MAN_TEXT:
if ( ! man_valid_post(man))
return(0);
break;
return(1);
}
-
static struct man_node *
-man_node_alloc(struct man *m, int line, int pos,
+man_node_alloc(struct man *man, int line, int pos,
enum man_type type, enum mant tok)
{
struct man_node *p;
p->type = type;
p->tok = tok;
- if (MAN_NEWLINE & m->flags)
+ if (MAN_NEWLINE & man->flags)
p->flags |= MAN_LINE;
- m->flags &= ~MAN_NEWLINE;
+ man->flags &= ~MAN_NEWLINE;
return(p);
}
-
int
-man_elem_alloc(struct man *m, int line, int pos, enum mant tok)
+man_elem_alloc(struct man *man, int line, int pos, enum mant tok)
{
struct man_node *p;
- p = man_node_alloc(m, line, pos, MAN_ELEM, tok);
- if ( ! man_node_append(m, p))
+ p = man_node_alloc(man, line, pos, MAN_ELEM, tok);
+ if ( ! man_node_append(man, p))
return(0);
- m->next = MAN_NEXT_CHILD;
+ man->next = MAN_NEXT_CHILD;
return(1);
}
-
int
-man_tail_alloc(struct man *m, int line, int pos, enum mant tok)
+man_tail_alloc(struct man *man, 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))
+ p = man_node_alloc(man, line, pos, MAN_TAIL, tok);
+ if ( ! man_node_append(man, p))
return(0);
- m->next = MAN_NEXT_CHILD;
+ man->next = MAN_NEXT_CHILD;
return(1);
}
-
int
-man_head_alloc(struct man *m, int line, int pos, enum mant tok)
+man_head_alloc(struct man *man, 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))
+ p = man_node_alloc(man, line, pos, MAN_HEAD, tok);
+ if ( ! man_node_append(man, p))
return(0);
- m->next = MAN_NEXT_CHILD;
+ man->next = MAN_NEXT_CHILD;
return(1);
}
-
int
-man_body_alloc(struct man *m, int line, int pos, enum mant tok)
+man_body_alloc(struct man *man, 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))
+ p = man_node_alloc(man, line, pos, MAN_BODY, tok);
+ if ( ! man_node_append(man, p))
return(0);
- m->next = MAN_NEXT_CHILD;
+ man->next = MAN_NEXT_CHILD;
return(1);
}
-
int
-man_block_alloc(struct man *m, int line, int pos, enum mant tok)
+man_block_alloc(struct man *man, 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))
+ p = man_node_alloc(man, line, pos, MAN_BLOCK, tok);
+ if ( ! man_node_append(man, p))
return(0);
- m->next = MAN_NEXT_CHILD;
+ man->next = MAN_NEXT_CHILD;
return(1);
}
int
-man_word_alloc(struct man *m, int line, int pos, const char *word)
+man_word_alloc(struct man *man, 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);
+ n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX);
+ n->string = roff_strdup(man->roff, word);
- if ( ! man_node_append(m, n))
+ if ( ! man_node_append(man, n))
return(0);
- m->next = MAN_NEXT_SIBLING;
+ man->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().
free(p);
}
-
void
-man_node_delete(struct man *m, struct man_node *p)
+man_node_delete(struct man *man, struct man_node *p)
{
while (p->child)
- man_node_delete(m, p->child);
+ man_node_delete(man, p->child);
- man_node_unlink(m, p);
+ man_node_unlink(man, p);
man_node_free(p);
}
int
-man_addeqn(struct man *m, const struct eqn *ep)
+man_addeqn(struct man *man, const struct eqn *ep)
{
struct man_node *n;
- assert( ! (MAN_HALT & m->flags));
+ assert( ! (MAN_HALT & man->flags));
- n = man_node_alloc(m, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
+ n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
n->eqn = ep;
- if ( ! man_node_append(m, n))
+ if ( ! man_node_append(man, n))
return(0);
- m->next = MAN_NEXT_SIBLING;
- return(man_descope(m, ep->ln, ep->pos));
+ man->next = MAN_NEXT_SIBLING;
+ return(man_descope(man, ep->ln, ep->pos));
}
int
-man_addspan(struct man *m, const struct tbl_span *sp)
+man_addspan(struct man *man, const struct tbl_span *sp)
{
struct man_node *n;
- assert( ! (MAN_HALT & m->flags));
+ assert( ! (MAN_HALT & man->flags));
- n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX);
+ n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX);
n->span = sp;
- if ( ! man_node_append(m, n))
+ if ( ! man_node_append(man, n))
return(0);
- m->next = MAN_NEXT_SIBLING;
- return(man_descope(m, sp->line, 0));
+ man->next = MAN_NEXT_SIBLING;
+ return(man_descope(man, sp->line, 0));
}
static int
-man_descope(struct man *m, int line, int offs)
+man_descope(struct man *man, int line, int offs)
{
/*
* Co-ordinate what happens with having a next-line scope open:
* 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))
+ if (MAN_ELINE & man->flags) {
+ man->flags &= ~MAN_ELINE;
+ if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
return(0);
}
- if ( ! (MAN_BLINE & m->flags))
+ if ( ! (MAN_BLINE & man->flags))
return(1);
- m->flags &= ~MAN_BLINE;
+ man->flags &= ~MAN_BLINE;
- if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
return(0);
- return(man_body_alloc(m, line, offs, m->last->tok));
+ return(man_body_alloc(man, line, offs, man->last->tok));
}
static int
-man_ptext(struct man *m, int line, char *buf, int offs)
+man_ptext(struct man *man, 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))
+ if (MAN_LITERAL & man->flags) {
+ if ( ! man_word_alloc(man, line, offs, buf + offs))
return(0);
- return(man_descope(m, line, offs));
+ return(man_descope(man, line, offs));
}
- /* Pump blank lines directly into the backend. */
-
for (i = offs; ' ' == buf[i]; i++)
/* Skip leading whitespace. */ ;
+ /*
+ * Blank lines are ignored right after headings
+ * but add a single vertical space elsewhere.
+ */
+
if ('\0' == buf[i]) {
/* Allocate a blank entry. */
- if ( ! man_word_alloc(m, line, offs, ""))
- return(0);
- return(man_descope(m, line, offs));
+ if (MAN_SH != man->last->tok &&
+ MAN_SS != man->last->tok) {
+ if ( ! man_elem_alloc(man, line, offs, MAN_sp))
+ return(0);
+ man->next = MAN_NEXT_SIBLING;
+ }
+ return(1);
}
- /*
+ /*
* Warn if the last un-escaped character is whitespace. Then
- * strip away the remaining spaces (tabs stay!).
+ * strip away the remaining spaces (tabs stay!).
*/
i = (int)strlen(buf);
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
if (i > 1 && '\\' != buf[i - 2])
- man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE);
+ man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE);
for (--i; i && ' ' == buf[i]; i--)
/* Spin back to non-space. */ ;
buf[i] = '\0';
}
- if ( ! man_word_alloc(m, line, offs, buf + offs))
+ if ( ! man_word_alloc(man, line, offs, buf + offs))
return(0);
/*
*/
assert(i);
- if (mandoc_eos(buf, (size_t)i, 0))
- m->last->flags |= MAN_EOS;
+ if (mandoc_eos(buf, (size_t)i))
+ man->last->flags |= MAN_EOS;
- return(man_descope(m, line, offs));
+ return(man_descope(man, line, offs));
}
static int
-man_pmacro(struct man *m, int ln, char *buf, int offs)
+man_pmacro(struct man *man, int ln, char *buf, int offs)
{
int i, ppos;
enum mant tok;
struct man_node *n;
if ('"' == buf[offs]) {
- man_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
+ man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT);
return(1);
} else if ('\0' == buf[offs])
return(1);
*/
i = 0;
- while (i < 4 && '\0' != buf[offs] &&
- ' ' != buf[offs] && '\t' != buf[offs])
+ 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);
+ mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln, ppos,
+ "%s", buf + ppos - 1);
return(1);
}
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[offs] && ' ' == buf[offs - 1])
- man_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE);
+ man_pmsg(man, 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;
+ man->flags & MAN_ELINE) {
+ n = man->last;
assert(MAN_TEXT != n->type);
/* Remove repeated NSCOPED macros causing ELINE. */
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]);
+ mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,
+ n->pos, "%s breaks %s", man_macronames[tok],
+ man_macronames[n->tok]);
- man_node_delete(m, n);
- m->flags &= ~MAN_ELINE;
+ man_node_delete(man, n);
+ man->flags &= ~MAN_ELINE;
+ }
+
+ /*
+ * Remove prior BLINE macro that is being clobbered.
+ */
+ if ((man->flags & MAN_BLINE) &&
+ (MAN_BSCOPE & man_macros[tok].flags)) {
+ n = man->last;
+
+ /* Might be a text node like 8 in
+ * .TP 8
+ * .SH foo
+ */
+ if (MAN_TEXT == n->type)
+ n = n->parent;
+
+ /* Remove element that didn't end BLINE, if any. */
+ if ( ! (MAN_BSCOPE & man_macros[n->tok].flags))
+ n = n->parent;
+
+ assert(MAN_HEAD == n->type);
+ n = n->parent;
+ assert(MAN_BLOCK == n->type);
+ assert(MAN_SCOPED & man_macros[n->tok].flags);
+
+ mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,
+ n->pos, "%s breaks %s", man_macronames[tok],
+ man_macronames[n->tok]);
+
+ man_node_delete(man, n);
+ man->flags &= ~MAN_BLINE;
}
/*
* when they exit.
*/
- if (MAN_BLINE & m->flags)
- m->flags |= MAN_BPLINE;
+ if (MAN_BLINE & man->flags)
+ man->flags |= MAN_BPLINE;
/* Call to handler... */
assert(man_macros[tok].fp);
- if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf))
+ if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf))
goto err;
- /*
+ /* In quick mode (for mandocdb), abort after the NAME section. */
+
+ if (man->quick && MAN_SH == tok) {
+ n = man->last;
+ if (MAN_BODY == n->type &&
+ strcmp(n->prev->child->string, "NAME"))
+ return(2);
+ }
+
+ /*
* 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;
+ if ( ! (MAN_BPLINE & man->flags)) {
+ man->flags &= ~MAN_ILINE;
return(1);
}
- m->flags &= ~MAN_BPLINE;
+ man->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;
+ if (MAN_ILINE & man->flags) {
+ man->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)
+ if (MAN_ELINE & man->flags)
return(1);
/* Close out the block scope opened in the prior line. */
- assert(MAN_BLINE & m->flags);
- m->flags &= ~MAN_BLINE;
+ assert(MAN_BLINE & man->flags);
+ man->flags &= ~MAN_BLINE;
- if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+ if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
return(0);
- return(man_body_alloc(m, ln, ppos, m->last->tok));
+ return(man_body_alloc(man, ln, ppos, man->last->tok));
err: /* Error out. */
- m->flags |= MAN_HALT;
+ man->flags |= MAN_HALT;
return(0);
}
/*
- * Unlink a node from its context. If "m" is provided, the last parse
+ * Unlink a node from its context. If "man" is provided, the last parse
* point will also be adjusted accordingly.
*/
static void
-man_node_unlink(struct man *m, struct man_node *n)
+man_node_unlink(struct man *man, struct man_node *n)
{
/* Adjust siblings. */
/* Adjust parse point, if applicable. */
- if (m && m->last == n) {
+ if (man && man->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;
+ man->last = n->prev;
+ man->next = MAN_NEXT_SIBLING;
} else {
- m->last = n->parent;
- m->next = MAN_NEXT_CHILD;
+ man->last = n->parent;
+ man->next = MAN_NEXT_CHILD;
}
}
- if (m && m->first == n)
- m->first = NULL;
+ if (man && man->first == n)
+ man->first = NULL;
+}
+
+const struct mparse *
+man_mparse(const struct man *man)
+{
+
+ assert(man && man->parse);
+ return(man->parse);
+}
+
+void
+man_deroff(char **dest, const struct man_node *n)
+{
+ char *cp;
+ size_t sz;
+
+ if (MAN_TEXT != n->type) {
+ for (n = n->child; n; n = n->next)
+ man_deroff(dest, n);
+ return;
+ }
+
+ /* Skip leading whitespace and escape sequences. */
+
+ cp = n->string;
+ while ('\0' != *cp) {
+ if ('\\' == *cp) {
+ cp++;
+ mandoc_escape((const char **)&cp, NULL, NULL);
+ } else if (isspace((unsigned char)*cp))
+ cp++;
+ else
+ 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;
}
git.ckatri.com / mandoc.git / blobdiff