-/* $Id: mdoc.c,v 1.20 2009/01/07 15:53:00 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.260 2017/02/16 03:00:23 schwarze Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2012-2017 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.
+ * 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 AUTHORS DISCLAIM ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * 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.
*/
+#include "config.h"
+
+#include <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
-#include <err.h>
#include <stdarg.h>
-#include <stdlib.h>
#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
-
-#include "private.h"
-
-const char *const __mdoc_macronames[MDOC_MAX] = {
- "\\\"", "Dd", "Dt", "Os",
+#include <time.h>
+
+#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "mdoc.h"
+#include "libmandoc.h"
+#include "roff_int.h"
+#include "libmdoc.h"
+
+const char *const __mdoc_macronames[MDOC_MAX + 1] = {
+ "text",
+ "Ap", "Dd", "Dt", "Os",
"Sh", "Ss", "Pp", "D1",
"Dl", "Bd", "Ed", "Bl",
"El", "It", "Ad", "An",
"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",
+ "Xr", "%A", "%B", "%D",
+ "%I", "%J", "%N", "%O",
+ "%P", "%R", "%T", "%V",
"Ac", "Ao", "Aq", "At",
"Bc", "Bf", "Bo", "Bq",
"Bsx", "Bx", "Db", "Dc",
"Tn", "Ux", "Xc", "Xo",
"Fo", "Fc", "Oo", "Oc",
"Bk", "Ek", "Bt", "Hf",
- "Fr", "Ud",
- };
+ "Fr", "Ud", "Lb", "Lp",
+ "Lk", "Mt", "Brq", "Bro",
+ "Brc", "%C", "Es", "En",
+ "Dx", "%Q", "br", "sp",
+ "%U", "Ta", "ll",
+};
-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",
- "p1003.1-88", "p1003.1-90", "p1003.1-96",
- "p1003.1-2001", "p1003.1-2004", "p1003.1",
- "p1003.1b", "p1003.1b-93", "p1003.1c-95",
- "p1003.1g-2000", "p1003.2-92", "p1387.2-95",
- "p1003.2", "p1387.2", "isoC-90",
- "isoC-amd1", "isoC-tcor1", "isoC-tcor2",
- "isoC-99", "ansiC", "ansiC-89",
- "ansiC-99", "ieee754", "iso8802-3",
- "xpg3", "xpg4", "xpg4.2",
- "xpg4.3", "xbd5", "xcu5",
- "xsh5", "xns5", "xns5.2d2.0",
- "xcurses4.2", "susv2", "susv3",
- "svid4", "filled", "words",
- "emphasis", "symbolic",
+ "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 struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
- { NULL, 0 }, /* \" */
- { macro_prologue, MDOC_PROLOGUE }, /* Dd */
- { macro_prologue, MDOC_PROLOGUE }, /* Dt */
- { macro_prologue, MDOC_PROLOGUE }, /* Os */
- { macro_scoped, 0 }, /* Sh */
- { macro_scoped, 0 }, /* Ss */
- { macro_text, 0 }, /* Pp */
- { macro_scoped_line, MDOC_PARSED }, /* D1 */
- { macro_scoped_line, MDOC_PARSED }, /* Dl */
- { macro_scoped, MDOC_EXPLICIT }, /* Bd */
- { macro_close_explicit, 0 }, /* Ed */
- { macro_scoped, MDOC_EXPLICIT }, /* Bl */
- { macro_close_explicit, 0 }, /* El */
- { macro_scoped, MDOC_NESTED | MDOC_PARSED }, /* It */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
- { macro_constant, MDOC_PARSED }, /* An */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
- { macro_constant, MDOC_QUOTABLE }, /* Cd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
- { macro_constant, 0 }, /* Ex */
- { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fa */
- { macro_constant, 0 }, /* Fd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
- { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fn */
- { macro_text, MDOC_PARSED }, /* Ft */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
- { macro_constant, 0 }, /* In */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
- { macro_constant, 0 }, /* Nd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
- { macro_obsolete, 0 }, /* Ot */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
- { macro_constant, 0 }, /* Rv */
- /* XXX - supposed to be (but isn't) callable. */
- { macro_constant_delimited, MDOC_PARSED }, /* St */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
- { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %A */
- { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %B */
- { macro_constant, MDOC_QUOTABLE }, /* %D */
- { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %I */
- { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %J */
- { macro_constant, MDOC_QUOTABLE }, /* %N */
- { macro_constant, MDOC_QUOTABLE }, /* %O */
- { macro_constant, MDOC_QUOTABLE }, /* %P */
- { macro_constant, MDOC_QUOTABLE }, /* %R */
- { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %T */
- { macro_constant, MDOC_QUOTABLE }, /* %V */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Ao */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
- { macro_constant, 0 }, /* At */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
- { macro_scoped, MDOC_EXPLICIT }, /* Bf */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Bo */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
- { macro_constant_delimited, MDOC_PARSED }, /* Bsx */
- { macro_constant_delimited, MDOC_PARSED }, /* Bx */
- { macro_constant, 0 }, /* Db */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Do */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
- { macro_close_explicit, 0 }, /* Ef */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Eo */
- { macro_constant_delimited, MDOC_PARSED }, /* Fx */
- { macro_text, MDOC_PARSED }, /* Ms */
- { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */
- { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
- { macro_constant_delimited, MDOC_PARSED }, /* Nx */
- { macro_constant_delimited, MDOC_PARSED }, /* Ox */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
- { macro_constant, MDOC_PARSED }, /* Pf */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Po */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Qo */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
- { macro_close_explicit, 0 }, /* Re */
- { macro_scoped, MDOC_EXPLICIT }, /* Rs */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* So */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
- { macro_constant, 0 }, /* Sm */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
- { macro_constant_delimited, MDOC_PARSED }, /* Ux */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Xo */
- /* XXX - .Fo supposed to be (but isn't) callable. */
- { macro_scoped, MDOC_EXPLICIT | MDOC_PARSED }, /* Fo */
- /* XXX - .Fc supposed to be (but isn't) callable. */
- { macro_close_explicit, MDOC_PARSED }, /* Fc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Oo */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
- { macro_scoped, MDOC_EXPLICIT }, /* Bk */
- { macro_close_explicit, 0 }, /* Ek */
- { macro_constant, 0 }, /* Bt */
- { macro_constant, 0 }, /* Hf */
- { macro_obsolete, 0 }, /* Fr */
- { macro_constant, 0 }, /* Ud */
-};
-
-const char * const *mdoc_macronames = __mdoc_macronames;
+const char * const *mdoc_macronames = __mdoc_macronames + 1;
const char * const *mdoc_argnames = __mdoc_argnames;
-const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
-
-static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *);
-static void argfree(size_t, struct mdoc_arg *);
-static void argcpy(struct mdoc_arg *,
- const struct mdoc_arg *);
+static int mdoc_ptext(struct roff_man *, int, char *, int);
+static int mdoc_pmacro(struct roff_man *, int, char *, int);
-static void mdoc_node_freelist(struct mdoc_node *);
-static void mdoc_node_append(struct mdoc *, int,
- struct mdoc_node *);
-static void mdoc_elem_free(struct mdoc_elem *);
-static void mdoc_text_free(struct mdoc_text *);
-
-const struct mdoc_node *
-mdoc_result(struct mdoc *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 roff_man *mdoc, int ln, char *buf, int offs)
{
- return(mdoc->first);
+ if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
+ mdoc->flags |= MDOC_NEWLINE;
+
+ /*
+ * 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);
}
-
void
-mdoc_free(struct mdoc *mdoc)
+mdoc_macro(MACRO_PROT_ARGS)
{
+ assert(tok > TOKEN_NONE && tok < MDOC_MAX);
- if (mdoc->first)
- mdoc_node_freelist(mdoc->first);
- if (mdoc->htab)
- mdoc_tokhash_free(mdoc->htab);
-
- free(mdoc);
+ (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
}
-
-struct mdoc *
-mdoc_alloc(void *data, const struct mdoc_cb *cb)
+void
+mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok)
{
- struct mdoc *p;
-
- p = xcalloc(1, sizeof(struct mdoc));
-
- p->data = data;
- (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
+ struct roff_node *p;
- p->htab = mdoc_tokhash_alloc();
- return(p);
+ p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
+ roff_node_append(mdoc, p);
+ mdoc->next = ROFF_NEXT_CHILD;
}
-
-int
-mdoc_endparse(struct mdoc *mdoc)
+struct roff_node *
+mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok,
+ struct roff_node *body)
{
-
- if (MDOC_HALT & mdoc->flags)
- return(0);
- if (NULL == mdoc->first)
- return(1);
-
- assert(mdoc->last);
- if ( ! macro_end(mdoc)) {
- mdoc->flags |= MDOC_HALT;
- return(0);
- }
- return(1);
+ struct roff_node *p;
+
+ body->flags |= NODE_ENDED;
+ body->parent->flags |= NODE_ENDED;
+ p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
+ p->body = body;
+ p->norm = body->norm;
+ p->end = ENDBODY_SPACE;
+ roff_node_append(mdoc, p);
+ mdoc->next = ROFF_NEXT_SIBLING;
+ return p;
}
-
-int
-mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
+struct roff_node *
+mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
+ int tok, struct mdoc_arg *args)
{
- int c, i;
- char tmp[5];
-
- if (MDOC_HALT & mdoc->flags)
- return(0);
-
- if ('.' != *buf) {
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, -1, 0, ERR_SYNTAX_NOTEXT));
- mdoc_word_alloc(mdoc, 0, buf);
- mdoc->next = MDOC_NEXT_SIBLING;
- return(1);
- }
-
- if (buf[1] && '\\' == buf[1])
- if (buf[2] && '\"' == buf[2])
- return(1);
-
- i = 1;
- while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp))
- i++;
-
- if (i == (int)sizeof(tmp)) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));
- } else if (i <= 2) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP));
+ struct roff_node *p;
+
+ p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
+ p->args = args;
+ if (p->args)
+ (args->refcnt)++;
+
+ switch (tok) {
+ case MDOC_Bd:
+ case MDOC_Bf:
+ case MDOC_Bl:
+ case MDOC_En:
+ case MDOC_Rs:
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
}
+ roff_node_append(mdoc, p);
+ mdoc->next = ROFF_NEXT_CHILD;
+ return p;
+}
- i--;
-
- (void)memcpy(tmp, buf + 1, (size_t)i);
- tmp[i++] = 0;
-
- if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_err(mdoc, c, 1, ERR_MACRO_NOTSUP));
- }
+void
+mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
+ int tok, struct mdoc_arg *args)
+{
+ struct roff_node *p;
- while (buf[i] && isspace(buf[i]))
- i++;
+ p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
+ p->args = args;
+ if (p->args)
+ (args->refcnt)++;
- if ( ! mdoc_macro(mdoc, c, 1, &i, buf)) {
- mdoc->flags |= MDOC_HALT;
- return(0);
+ switch (tok) {
+ case MDOC_An:
+ p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+ break;
+ default:
+ break;
}
- return(1);
+ roff_node_append(mdoc, p);
+ mdoc->next = ROFF_NEXT_CHILD;
}
-
void
-mdoc_msg(struct mdoc *mdoc, int pos, const char *fmt, ...)
+mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
{
- va_list ap;
- char buf[256];
-
- if (NULL == mdoc->cb.mdoc_msg)
- return;
-
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf), fmt, ap);
- va_end(ap);
- (*mdoc->cb.mdoc_msg)(mdoc->data, pos, buf);
+ roff_node_unlink(mdoc, p);
+ p->prev = p->next = NULL;
+ roff_node_append(mdoc, p);
}
-
-int
-mdoc_err(struct mdoc *mdoc, int tok, int pos, enum mdoc_err type)
+/*
+ * Parse free-form text, that is, a line that does not begin with the
+ * control character.
+ */
+static int
+mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
{
+ struct roff_node *n;
+ char *c, *ws, *end;
+
+ n = mdoc->last;
+
+ /*
+ * If a column list contains plain text, assume an implicit item
+ * macro. This can happen one or more times at the beginning
+ * of such a list, intermixed with non-It mdoc macros and with
+ * nodes generated on the roff level, for example by tbl.
+ */
+
+ if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+ n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
+ (n->parent != NULL && n->parent->tok == MDOC_Bl &&
+ n->parent->norm->Bl.type == LIST_column)) {
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
+ return 1;
+ }
- if (NULL == mdoc->cb.mdoc_err)
- return(0);
- return((*mdoc->cb.mdoc_err)(mdoc->data, tok, pos, type));
-}
-
+ /*
+ * Search for the beginning of unescaped trailing whitespace (ws)
+ * and for the first character not to be output (end).
+ */
+
+ /* FIXME: replace with strcspn(). */
+ ws = NULL;
+ for (c = end = buf + offs; *c; c++) {
+ switch (*c) {
+ case ' ':
+ if (NULL == ws)
+ ws = c;
+ continue;
+ case '\t':
+ /*
+ * Always warn about trailing tabs,
+ * even outside literal context,
+ * where they should be put on the next line.
+ */
+ if (NULL == ws)
+ ws = c;
+ /*
+ * Strip trailing tabs in literal context only;
+ * outside, they affect the next line.
+ */
+ if (MDOC_LITERAL & mdoc->flags)
+ continue;
+ break;
+ case '\\':
+ /* Skip the escaped character, too, if any. */
+ if (c[1])
+ c++;
+ /* FALLTHROUGH */
+ default:
+ ws = NULL;
+ break;
+ }
+ end = c + 1;
+ }
+ *end = '\0';
+
+ if (ws)
+ mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+ line, (int)(ws-buf), NULL);
+
+ if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
+ mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
+ line, (int)(c - buf), NULL);
+
+ /*
+ * 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.
+ */
+ roff_elem_alloc(mdoc, line, offs, MDOC_sp);
+ mdoc->last->flags |= NODE_VALID | NODE_ENDED;
+ mdoc->next = ROFF_NEXT_SIBLING;
+ return 1;
+ }
-int
-mdoc_warn(struct mdoc *mdoc, int tok, int pos, enum mdoc_warn type)
-{
+ roff_word_alloc(mdoc, line, offs, buf+offs);
+
+ if (mdoc->flags & MDOC_LITERAL)
+ return 1;
+
+ /*
+ * 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(buf < end);
+
+ if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
+ mdoc->last->flags |= NODE_EOS;
+
+ for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) {
+ if (c - buf < offs + 2)
+ continue;
+ if (end - c < 4)
+ break;
+ if (isalpha((unsigned char)c[-2]) &&
+ isalpha((unsigned char)c[-1]) &&
+ c[1] == ' ' &&
+ isupper((unsigned char)(c[2] == ' ' ? c[3] : c[2])) &&
+ (c[-2] != 'n' || c[-1] != 'c') &&
+ (c[-2] != 'v' || c[-1] != 's'))
+ mandoc_msg(MANDOCERR_EOS, mdoc->parse,
+ line, (int)(c - buf), NULL);
+ }
- if (NULL == mdoc->cb.mdoc_warn)
- return(0);
- return((*mdoc->cb.mdoc_warn)(mdoc->data, tok, pos, type));
+ return 1;
}
-
-int
-mdoc_macro(struct mdoc *mdoc, int tok, int ppos, int *pos, char *buf)
+/*
+ * Parse a macro line, that is, a line beginning with the control
+ * character.
+ */
+static int
+mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
{
+ struct roff_node *n;
+ const char *cp;
+ int tok;
+ int i, sv;
+ char mac[5];
- if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
- SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
-
- if (NULL == (mdoc_macros[tok].fp)) {
- (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTSUP);
- return(0);
- }
+ sv = offs;
- if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
- (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTCALL);
- return(0);
- }
+ /*
+ * Copy the first word into a nil-terminated buffer.
+ * Stop when a space, tab, escape, or eoln is encountered.
+ */
- return((*mdoc_macros[tok].fp)(mdoc, tok, ppos, pos, buf));
-}
+ i = 0;
+ while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
+ mac[i++] = buf[offs++];
+ mac[i] = '\0';
-static void
-mdoc_node_append(struct mdoc *mdoc, int pos, struct mdoc_node *p)
-{
- const char *nn, *on, *nt, *ot, *act;
+ tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE;
- switch (p->type) {
- case (MDOC_TEXT):
- nn = p->data.text.string;
- nt = "text";
- break;
- case (MDOC_BODY):
- nn = mdoc_macronames[p->data.body.tok];
- nt = "body";
- break;
- case (MDOC_ELEM):
- nn = mdoc_macronames[p->data.elem.tok];
- nt = "elem";
- break;
- case (MDOC_HEAD):
- nn = mdoc_macronames[p->data.head.tok];
- nt = "head";
- break;
- case (MDOC_TAIL):
- nn = mdoc_macronames[p->data.tail.tok];
- nt = "tail";
- break;
- case (MDOC_BLOCK):
- nn = mdoc_macronames[p->data.block.tok];
- nt = "block";
- break;
- default:
- abort();
- /* NOTREACHED */
+ if (tok == TOKEN_NONE) {
+ mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
+ ln, sv, buf + sv - 1);
+ return 1;
}
- if (NULL == mdoc->first) {
- assert(NULL == mdoc->last);
- mdoc->first = p;
- mdoc->last = p;
- mdoc_msg(mdoc, pos, "parse: root %s `%s'", nt, nn);
- return;
- }
+ /* Skip a leading escape sequence or tab. */
- switch (mdoc->last->type) {
- case (MDOC_TEXT):
- on = "<text>";
- ot = "text";
- break;
- case (MDOC_BODY):
- on = mdoc_macronames[mdoc->last->data.body.tok];
- ot = "body";
- break;
- case (MDOC_ELEM):
- on = mdoc_macronames[mdoc->last->data.elem.tok];
- ot = "elem";
- break;
- case (MDOC_HEAD):
- on = mdoc_macronames[mdoc->last->data.head.tok];
- ot = "head";
- break;
- case (MDOC_TAIL):
- on = mdoc_macronames[mdoc->last->data.tail.tok];
- ot = "tail";
+ switch (buf[offs]) {
+ case '\\':
+ cp = buf + offs + 1;
+ mandoc_escape(&cp, NULL, NULL);
+ offs = cp - buf;
break;
- case (MDOC_BLOCK):
- on = mdoc_macronames[mdoc->last->data.block.tok];
- ot = "block";
+ case '\t':
+ offs++;
break;
default:
- abort();
- /* NOTREACHED */
- }
-
- switch (mdoc->next) {
- case (MDOC_NEXT_SIBLING):
- mdoc->last->next = p;
- p->prev = mdoc->last;
- p->parent = mdoc->last->parent;
- act = "sibling";
- break;
- case (MDOC_NEXT_CHILD):
- mdoc->last->child = p;
- p->parent = mdoc->last;
- act = "child";
break;
- default:
- abort();
- /* NOTREACHED */
}
- mdoc_msg(mdoc, pos, "parse: %s `%s' %s of %s `%s'",
- nt, nn, act, ot, on);
+ /* Jump to the next non-whitespace word. */
- mdoc->last = p;
-}
+ 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.
+ */
-void
-mdoc_tail_alloc(struct mdoc *mdoc, int pos, int tok)
-{
- struct mdoc_node *p;
-
- assert(mdoc->first);
- assert(mdoc->last);
-
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->type = MDOC_TAIL;
- p->data.tail.tok = tok;
-
- mdoc_node_append(mdoc, pos, p);
-}
-
-
-void
-mdoc_head_alloc(struct mdoc *mdoc, int pos, int tok)
-{
- struct mdoc_node *p;
-
- assert(mdoc->first);
- assert(mdoc->last);
-
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->type = MDOC_HEAD;
- p->data.head.tok = tok;
-
- mdoc_node_append(mdoc, pos, p);
-}
-
-
-void
-mdoc_body_alloc(struct mdoc *mdoc, int pos, int tok)
-{
- struct mdoc_node *p;
-
- assert(mdoc->first);
- assert(mdoc->last);
+ if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+ mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+ ln, offs - 1, NULL);
- p = xcalloc(1, sizeof(struct mdoc_node));
+ /*
+ * If an initial macro or a list invocation, divert directly
+ * into macro processing.
+ */
- p->type = MDOC_BODY;
- p->data.body.tok = tok;
+ n = mdoc->last;
+ if (n == NULL || tok == MDOC_It || tok == MDOC_El) {
+ mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
+ return 1;
+ }
- mdoc_node_append(mdoc, pos, p);
-}
+ /*
+ * If a column list contains a non-It macro, assume an implicit
+ * item macro. This can happen one or more times at the
+ * beginning of such a list, intermixed with text lines and
+ * with nodes generated on the roff level, for example by tbl.
+ */
+
+ if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+ n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
+ (n->parent != NULL && n->parent->tok == MDOC_Bl &&
+ n->parent->norm->Bl.type == LIST_column)) {
+ mdoc->flags |= MDOC_FREECOL;
+ mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
+ return 1;
+ }
+ /* Normal processing of a macro. */
-void
-mdoc_block_alloc(struct mdoc *mdoc, int pos, int tok,
- size_t argsz, const struct mdoc_arg *args)
-{
- struct mdoc_node *p;
+ mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
- p = xcalloc(1, sizeof(struct mdoc_node));
+ /* In quick mode (for mandocdb), abort after the NAME section. */
- p->type = MDOC_BLOCK;
- p->data.block.tok = tok;
- p->data.block.argc = argsz;
- p->data.block.argv = argdup(argsz, args);
+ if (mdoc->quick && MDOC_Sh == tok &&
+ SEC_NAME != mdoc->last->sec)
+ return 2;
- mdoc_node_append(mdoc, pos, p);
+ return 1;
}
-
-void
-mdoc_elem_alloc(struct mdoc *mdoc, int pos, int tok,
- size_t argsz, const struct mdoc_arg *args)
+enum mdelim
+mdoc_isdelim(const char *p)
{
- struct mdoc_node *p;
-
- p = xcalloc(1, sizeof(struct mdoc_node));
- p->type = MDOC_ELEM;
- p->data.elem.tok = tok;
- p->data.elem.argc = argsz;
- p->data.elem.argv = argdup(argsz, args);
-
- mdoc_node_append(mdoc, pos, p);
-}
-
-void
-mdoc_word_alloc(struct mdoc *mdoc, int pos, const char *word)
-{
- struct mdoc_node *p;
-
- p = xcalloc(1, sizeof(struct mdoc_node));
- p->type = MDOC_TEXT;
- p->data.text.string = xstrdup(word);
-
- mdoc_node_append(mdoc, pos, p);
-}
-
-
-static void
-argfree(size_t sz, struct mdoc_arg *p)
-{
- int i, j;
-
- if (0 == sz)
- return;
-
- assert(p);
- /* LINTED */
- for (i = 0; i < (int)sz; i++)
- if (p[i].sz > 0) {
- assert(p[i].value);
- /* LINTED */
- for (j = 0; j < (int)p[i].sz; j++)
- free(p[i].value[j]);
- free(p[i].value);
+ if ('\0' == p[0])
+ return DELIM_NONE;
+
+ if ('\0' == p[1])
+ switch (p[0]) {
+ case '(':
+ case '[':
+ return DELIM_OPEN;
+ case '|':
+ return DELIM_MIDDLE;
+ case '.':
+ case ',':
+ case ';':
+ case ':':
+ case '?':
+ case '!':
+ case ')':
+ case ']':
+ return DELIM_CLOSE;
+ default:
+ return DELIM_NONE;
}
- free(p);
-}
-
-static void
-mdoc_elem_free(struct mdoc_elem *p)
-{
-
- argfree(p->argc, p->argv);
-}
+ if ('\\' != p[0])
+ return DELIM_NONE;
+ if (0 == strcmp(p + 1, "."))
+ return DELIM_CLOSE;
+ if (0 == strcmp(p + 1, "fR|\\fP"))
+ return DELIM_MIDDLE;
-static void
-mdoc_block_free(struct mdoc_block *p)
-{
-
- argfree(p->argc, p->argv);
+ return DELIM_NONE;
}
-
-static void
-mdoc_text_free(struct mdoc_text *p)
-{
-
- if (p->string)
- free(p->string);
-}
-
-
void
-mdoc_node_free(struct mdoc_node *p)
-{
-
- switch (p->type) {
- case (MDOC_TEXT):
- mdoc_text_free(&p->data.text);
- break;
- case (MDOC_ELEM):
- mdoc_elem_free(&p->data.elem);
- break;
- case (MDOC_BLOCK):
- mdoc_block_free(&p->data.block);
- break;
- default:
- break;
- }
-
- free(p);
-}
-
-
-static void
-mdoc_node_freelist(struct mdoc_node *p)
+mdoc_validate(struct roff_man *mdoc)
{
- if (p->child)
- mdoc_node_freelist(p->child);
- if (p->next)
- mdoc_node_freelist(p->next);
-
- mdoc_node_free(p);
+ mdoc->last = mdoc->first;
+ mdoc_node_validate(mdoc);
+ mdoc_state_reset(mdoc);
}
-
-
-int
-mdoc_find(const struct mdoc *mdoc, const char *key)
-{
-
- return(mdoc_tokhash_find(mdoc->htab, key));
-}
-
-
-static void
-argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)
-{
- int i;
-
- dst->arg = src->arg;
- if (0 == (dst->sz = src->sz))
- return;
- dst->value = xcalloc(dst->sz, sizeof(char *));
- for (i = 0; i < (int)dst->sz; i++)
- dst->value[i] = xstrdup(src->value[i]);
-}
-
-
-static struct mdoc_arg *
-argdup(size_t argsz, const struct mdoc_arg *args)
-{
- struct mdoc_arg *pp;
- int i;
-
- if (0 == argsz)
- return(NULL);
-
- pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));
- for (i = 0; i < (int)argsz; i++)
- argcpy(&pp[i], &args[i]);
-
- return(pp);
-}
-
git.ckatri.com / mandoc.git / blobdiff