-/* $Id: mdoc_validate.c,v 1.227 2014/07/05 01:12:20 schwarze Exp $ */
+/* $Id: mdoc_validate.c,v 1.237 2014/07/31 00:41:10 schwarze Exp $ */
/*
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
* Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
static int check_count(struct mdoc *, enum mdoc_type,
enum check_lvl, enum check_ineq, int);
-static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
static void check_text(struct mdoc *, int, int, char *);
static void check_argv(struct mdoc *,
struct mdoc_node *, struct mdoc_argv *);
static int post_en(POST_ARGS);
static int post_es(POST_ARGS);
static int post_eoln(POST_ARGS);
+static int post_ex(POST_ARGS);
static int post_hyph(POST_ARGS);
static int post_ignpar(POST_ARGS);
static int post_it(POST_ARGS);
static int post_sh_body(POST_ARGS);
static int post_sh_head(POST_ARGS);
static int post_st(POST_ARGS);
-static int post_std(POST_ARGS);
static int post_vt(POST_ARGS);
static int pre_an(PRE_ARGS);
static int pre_bd(PRE_ARGS);
static int pre_dd(PRE_ARGS);
static int pre_display(PRE_ARGS);
static int pre_dt(PRE_ARGS);
-static int pre_it(PRE_ARGS);
static int pre_literal(PRE_ARGS);
static int pre_obsolete(PRE_ARGS);
static int pre_os(PRE_ARGS);
static int pre_par(PRE_ARGS);
-static int pre_sh(PRE_ARGS);
-static int pre_ss(PRE_ARGS);
static int pre_std(PRE_ARGS);
static v_post posts_an[] = { post_an, NULL };
static v_post posts_dt[] = { post_dt, post_prol, NULL };
static v_post posts_en[] = { post_en, NULL };
static v_post posts_es[] = { post_es, NULL };
+static v_post posts_ex[] = { post_ex, NULL };
static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
static v_post posts_hyph[] = { post_hyph, NULL };
static v_post posts_hyphtext[] = { ewarn_ge1, post_hyph, NULL };
static v_post posts_sp[] = { post_par, ewarn_le1, NULL };
static v_post posts_ss[] = { post_ignpar, hwarn_ge1, post_hyph, NULL };
static v_post posts_st[] = { post_st, NULL };
-static v_post posts_std[] = { post_std, NULL };
static v_post posts_text[] = { ewarn_ge1, NULL };
static v_post posts_text1[] = { ewarn_eq1, NULL };
static v_post posts_vt[] = { post_vt, NULL };
static v_pre pres_dl[] = { pre_literal, pre_display, NULL };
static v_pre pres_dd[] = { pre_dd, NULL };
static v_pre pres_dt[] = { pre_dt, NULL };
-static v_pre pres_it[] = { pre_it, pre_par, NULL };
+static v_pre pres_it[] = { pre_par, NULL };
static v_pre pres_obsolete[] = { pre_obsolete, NULL };
static v_pre pres_os[] = { pre_os, NULL };
static v_pre pres_pp[] = { pre_par, NULL };
-static v_pre pres_sh[] = { pre_sh, NULL };
-static v_pre pres_ss[] = { pre_ss, NULL };
static v_pre pres_std[] = { pre_std, NULL };
static const struct valids mdoc_valids[MDOC_MAX] = {
{ pres_dd, posts_dd }, /* Dd */
{ pres_dt, posts_dt }, /* Dt */
{ pres_os, posts_os }, /* Os */
- { pres_sh, posts_sh }, /* Sh */
- { pres_ss, posts_ss }, /* Ss */
+ { NULL, posts_sh }, /* Sh */
+ { NULL, posts_ss }, /* Ss */
{ pres_pp, posts_pp }, /* Pp */
{ pres_d1, posts_d1 }, /* D1 */
{ pres_dl, posts_dl }, /* Dl */
{ NULL, NULL }, /* Dv */
{ NULL, NULL }, /* Er */
{ NULL, NULL }, /* Ev */
- { pres_std, posts_std }, /* Ex */
+ { pres_std, posts_ex }, /* Ex */
{ NULL, NULL }, /* Fa */
{ NULL, posts_text }, /* Fd */
{ NULL, NULL }, /* Fl */
{ NULL, NULL }, /* Op */
{ pres_obsolete, NULL }, /* Ot */
{ NULL, posts_defaults }, /* Pa */
- { pres_std, posts_std }, /* Rv */
+ { pres_std, NULL }, /* Rv */
{ NULL, posts_st }, /* St */
{ NULL, NULL }, /* Va */
{ NULL, posts_vt }, /* Vt */
for (i = 0; i < (int)v->sz; i++)
check_text(mdoc, v->line, v->pos, v->value[i]);
-
- /* FIXME: move to post_std(). */
-
- if (MDOC_Std == v->arg)
- if ( ! (v->sz || mdoc->meta.name))
- mdoc_nmsg(mdoc, n, MANDOCERR_NONAME);
}
static void
return;
for (cp = p; NULL != (p = strchr(p, '\t')); p++)
- mdoc_pmsg(mdoc, ln, pos + (int)(p - cp), MANDOCERR_BADTAB);
-}
-
-static int
-check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
-{
-
- assert(n->parent);
- if ((MDOC_ROOT == t || tok == n->parent->tok) &&
- (t == n->parent->type))
- return(1);
-
- mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse,
- n->line, n->pos, "want parent %s",
- MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]);
- return(0);
+ mandoc_msg(MANDOCERR_FI_TAB, mdoc->parse,
+ ln, pos + (int)(p - cp), NULL);
}
-
static int
pre_display(PRE_ARGS)
{
default:
continue;
}
+ if (LIST__NONE == lt)
+ continue;
/* Check: multiple list types. */
- if (LIST__NONE != lt && n->norm->Bl.type != LIST__NONE)
- mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP);
-
- /* Assign list type. */
-
- if (LIST__NONE != lt && n->norm->Bl.type == LIST__NONE) {
- n->norm->Bl.type = lt;
- /* Set column information, too. */
- if (LIST_column == lt) {
- n->norm->Bl.ncols =
- n->args->argv[i].sz;
- n->norm->Bl.cols = (void *)
- n->args->argv[i].value;
- }
+ if (LIST__NONE != n->norm->Bl.type) {
+ mandoc_msg(MANDOCERR_BL_REP,
+ mdoc->parse, n->line, n->pos,
+ mdoc_argnames[argv->arg]);
+ continue;
}
/* The list type should come first. */
- if (n->norm->Bl.type == LIST__NONE)
- if (n->norm->Bl.width ||
- n->norm->Bl.offs ||
- n->norm->Bl.comp)
- mandoc_msg(MANDOCERR_BL_LATETYPE,
- mdoc->parse, n->line, n->pos,
- mdoc_argnames[n->args->argv[0].arg]);
- continue;
+ if (n->norm->Bl.width ||
+ n->norm->Bl.offs ||
+ n->norm->Bl.comp)
+ mandoc_msg(MANDOCERR_BL_LATETYPE,
+ mdoc->parse, n->line, n->pos,
+ mdoc_argnames[n->args->argv[0].arg]);
+
+ n->norm->Bl.type = lt;
+ if (LIST_column == lt) {
+ n->norm->Bl.ncols = argv->sz;
+ n->norm->Bl.cols = (void *)argv->value;
+ }
}
/* Allow lists to default to LIST_item. */
switch (n->norm->Bl.type) {
case LIST_tag:
if (NULL == n->norm->Bl.width)
- mdoc_nmsg(mdoc, n, MANDOCERR_BL_WIDTH);
+ mdoc_nmsg(mdoc, n, MANDOCERR_BL_NOWIDTH);
break;
case LIST_column:
/* FALLTHROUGH */
switch (argv->arg) {
case MDOC_Centred:
- dt = DISP_centred;
+ dt = DISP_centered;
break;
case MDOC_Ragged:
dt = DISP_ragged;
abort();
/* NOTREACHED */
}
+ if (DISP__NONE == dt)
+ continue;
- /* Check whether a type has already been assigned. */
-
- if (DISP__NONE != dt && n->norm->Bd.type != DISP__NONE)
- mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP);
-
- /* Make our type assignment. */
-
- if (DISP__NONE != dt && n->norm->Bd.type == DISP__NONE)
+ if (DISP__NONE == n->norm->Bd.type)
n->norm->Bd.type = dt;
+ else
+ mandoc_msg(MANDOCERR_BD_REP,
+ mdoc->parse, n->line, n->pos,
+ mdoc_argnames[argv->arg]);
}
if (DISP__NONE == n->norm->Bd.type) {
return(1);
}
-static int
-pre_ss(PRE_ARGS)
-{
-
- if (MDOC_BLOCK != n->type)
- return(1);
- return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
-}
-
-static int
-pre_sh(PRE_ARGS)
-{
-
- if (MDOC_BLOCK != n->type)
- return(1);
- return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
-}
-
-static int
-pre_it(PRE_ARGS)
-{
-
- if (MDOC_BLOCK != n->type)
- return(1);
-
- return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
-}
-
static int
pre_an(PRE_ARGS)
{
mdoc_deroff(&mdoc->meta.name, mdoc->last);
- if (NULL == mdoc->meta.name) {
- mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);
- mdoc->meta.name = mandoc_strdup("UNKNOWN");
- }
+ if (NULL == mdoc->meta.name)
+ mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NM_NONAME);
return(1);
}
assert(MDOC_TEXT == n->type);
if (NULL == (std_att = mdoc_a2att(n->string))) {
- mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
+ mandoc_msg(MANDOCERR_AT_BAD, mdoc->parse,
+ n->line, n->pos, n->string);
mandoc_asprintf(&att, "AT&T UNIX %s", n->string);
} else
att = mandoc_strdup(std_att);
int i, cols;
enum mdoc_list lt;
struct mdoc_node *nbl, *nit, *nch;
- enum mandocerr er;
nit = mdoc->last;
if (MDOC_BLOCK != nit->type)
if (MDOC_BODY == nch->type)
i++;
- if (i < cols)
- er = MANDOCERR_ARGCOUNT;
- else if (i == cols || i == cols + 1)
- break;
- else
- er = MANDOCERR_SYNTARGCOUNT;
-
- mandoc_vmsg(er, mdoc->parse, nit->line, nit->pos,
- "columns == %d (have %d)", cols, i);
- return(MANDOCERR_ARGCOUNT == er);
+ if (i < cols || i > cols + 1)
+ mandoc_vmsg(MANDOCERR_ARGCOUNT,
+ mdoc->parse, nit->line, nit->pos,
+ "columns == %d (have %d)", cols, i);
+ break;
default:
abort();
}
width = 6;
else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
return(1);
- else if (0 == (width = macro2len(tok))) {
- mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
- return(1);
- }
+ else
+ width = macro2len(tok);
/* The value already exists: free and reallocate it. */
post_bl_head(POST_ARGS)
{
struct mdoc_node *np, *nn, *nnp;
+ struct mdoc_argv *argv;
int i, j;
if (LIST_column != mdoc->last->norm->Bl.type)
return(hwarn_eq0(mdoc));
/*
- * Convert old-style lists, where the column width specifiers
+ * Append old-style lists, where the column width specifiers
* trail as macro parameters, to the new-style ("normal-form")
* lists where they're argument values following -column.
*/
- /* First, disallow both types and allow normal-form. */
-
- /*
- * TODO: technically, we can accept both and just merge the two
- * lists, but I'll leave that for another day.
- */
-
- if (mdoc->last->norm->Bl.ncols && mdoc->last->nchild) {
- mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS);
- return(0);
- } else if (NULL == mdoc->last->child)
+ if (mdoc->last->child == NULL)
return(1);
np = mdoc->last->parent;
break;
assert(j < (int)np->args->argc);
- assert(0 == np->args->argv[j].sz);
/*
* Accommodate for new-style groff column syntax. Shuffle the
* column field. Then, delete the head children.
*/
- np->args->argv[j].sz = (size_t)mdoc->last->nchild;
- np->args->argv[j].value = mandoc_reallocarray(NULL,
- (size_t)mdoc->last->nchild, sizeof(char *));
+ argv = np->args->argv + j;
+ i = argv->sz;
+ argv->sz += mdoc->last->nchild;
+ argv->value = mandoc_reallocarray(argv->value,
+ argv->sz, sizeof(char *));
- mdoc->last->norm->Bl.ncols = np->args->argv[j].sz;
- mdoc->last->norm->Bl.cols = (void *)np->args->argv[j].value;
+ mdoc->last->norm->Bl.ncols = argv->sz;
+ mdoc->last->norm->Bl.cols = (void *)argv->value;
- for (i = 0, nn = mdoc->last->child; nn; i++) {
- np->args->argv[j].value[i] = nn->string;
+ for (nn = mdoc->last->child; nn; i++) {
+ argv->value[i] = nn->string;
nn->string = NULL;
nnp = nn;
nn = nn->next;
static int
ebool(struct mdoc *mdoc)
{
+ struct mdoc_node *nch;
+ enum mdoct tok;
- if (NULL == mdoc->last->child) {
- if (MDOC_Sm == mdoc->last->tok)
+ tok = mdoc->last->tok;
+ nch = mdoc->last->child;
+
+ if (NULL == nch) {
+ if (MDOC_Sm == tok)
mdoc->flags ^= MDOC_SMOFF;
return(1);
}
check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2);
- assert(MDOC_TEXT == mdoc->last->child->type);
+ assert(MDOC_TEXT == nch->type);
- if (0 == strcmp(mdoc->last->child->string, "on")) {
- if (MDOC_Sm == mdoc->last->tok)
+ if (0 == strcmp(nch->string, "on")) {
+ if (MDOC_Sm == tok)
mdoc->flags &= ~MDOC_SMOFF;
return(1);
}
- if (0 == strcmp(mdoc->last->child->string, "off")) {
- if (MDOC_Sm == mdoc->last->tok)
+ if (0 == strcmp(nch->string, "off")) {
+ if (MDOC_Sm == tok)
mdoc->flags |= MDOC_SMOFF;
return(1);
}
- mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL);
- return(1);
+ mandoc_vmsg(MANDOCERR_SM_BAD,
+ mdoc->parse, nch->line, nch->pos,
+ "%s %s", mdoc_macronames[tok], nch->string);
+ return(mdoc_node_relink(mdoc, nch));
}
static int
post_root(POST_ARGS)
{
- int ret;
struct mdoc_node *n;
- ret = 1;
-
- /* Check that we have a finished prologue. */
+ /* Add missing prologue data. */
if ( ! (MDOC_PBODY & mdoc->flags)) {
- ret = 0;
- mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
+ mandoc_msg(MANDOCERR_PROLOG_BAD, mdoc->parse, 0, 0, "EOF");
+ if (mdoc->meta.date == NULL)
+ mdoc->meta.date = mdoc->quick ?
+ mandoc_strdup("") :
+ mandoc_normdate(mdoc->parse, NULL, 0, 0);
+ if (mdoc->meta.title == NULL)
+ mdoc->meta.title = mandoc_strdup("UNKNOWN");
+ if (mdoc->meta.vol == NULL)
+ mdoc->meta.vol = mandoc_strdup("LOCAL");
+ if (mdoc->meta.arch == NULL)
+ mdoc->meta.msec = mandoc_strdup("1");
+ if (mdoc->meta.os == NULL)
+ mdoc->meta.os = mandoc_strdup("UNKNOWN");
}
n = mdoc->first;
n->child->line, n->child->pos,
mdoc_macronames[n->child->tok]);
- return(ret);
+ return(1);
}
static int
post_st(POST_ARGS)
{
- struct mdoc_node *ch;
+ struct mdoc_node *n, *nch;
const char *p;
- if (NULL == (ch = mdoc->last->child)) {
+ n = mdoc->last;
+ nch = n->child;
+
+ if (NULL == nch) {
mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
- mdoc->last->line, mdoc->last->pos,
- mdoc_macronames[mdoc->last->tok]);
- mdoc_node_delete(mdoc, mdoc->last);
+ n->line, n->pos, mdoc_macronames[n->tok]);
+ mdoc_node_delete(mdoc, n);
return(1);
}
- assert(MDOC_TEXT == ch->type);
+ assert(MDOC_TEXT == nch->type);
- if (NULL == (p = mdoc_a2st(ch->string))) {
- mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
- mdoc_node_delete(mdoc, mdoc->last);
+ if (NULL == (p = mdoc_a2st(nch->string))) {
+ mandoc_msg(MANDOCERR_ST_BAD, mdoc->parse,
+ nch->line, nch->pos, nch->string);
+ mdoc_node_delete(mdoc, n);
} else {
- free(ch->string);
- ch->string = mandoc_strdup(p);
+ free(nch->string);
+ nch->string = mandoc_strdup(p);
}
return(1);
return(1);
}
- /*
- * Make sure only certain types of nodes are allowed within the
- * the `Rs' body. Delete offending nodes and raise a warning.
- * Do this before re-ordering for the sake of clarity.
- */
-
- next = NULL;
- for (nn = mdoc->last->child; nn; nn = next) {
- for (i = 0; i < RSORD_MAX; i++)
- if (nn->tok == rsord[i])
- break;
-
- if (i < RSORD_MAX) {
- if (MDOC__J == rsord[i] || MDOC__B == rsord[i])
- mdoc->last->norm->Rs.quote_T++;
- next = nn->next;
- continue;
- }
-
- next = nn->next;
- mandoc_msg(MANDOCERR_RS_SKIP, mdoc->parse,
- nn->line, nn->pos, mdoc_macronames[nn->tok]);
- mdoc_node_delete(mdoc, nn);
- }
-
- /*
- * Nothing to sort if only invalid nodes were found
- * inside the `Rs' body.
- */
-
- if (NULL == mdoc->last->child)
- return(1);
-
/*
* The full `Rs' block needs special handling to order the
* sub-elements according to `rsord'. Pick through each element
- * and correctly order it. This is a insertion sort.
+ * and correctly order it. This is an insertion sort.
*/
next = NULL;
if (rsord[i] == nn->tok)
break;
+ if (i == RSORD_MAX) {
+ mandoc_msg(MANDOCERR_RS_BAD,
+ mdoc->parse, nn->line, nn->pos,
+ mdoc_macronames[nn->tok]);
+ i = -1;
+ } else if (MDOC__J == nn->tok || MDOC__B == nn->tok)
+ mdoc->last->norm->Rs.quote_T++;
+
/*
* Remove `nn' from the chain. This somewhat
* repeats mdoc_node_unlink(), but since we're
for (j = 0; j < RSORD_MAX; j++)
if (rsord[j] == prev->tok)
break;
+ if (j == RSORD_MAX)
+ j = -1;
if (j <= i)
break;
#else /*!OSNAME */
if (NULL == defbuf) {
if (-1 == uname(&utsname)) {
- mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
+ mandoc_msg(MANDOCERR_OS_UNAME, mdoc->parse,
+ n->line, n->pos, "Os");
defbuf = mandoc_strdup("UNKNOWN");
} else
mandoc_asprintf(&defbuf, "%s %s",
return(1);
}
+/*
+ * If no argument is provided,
+ * fill in the name of the current manual page.
+ */
static int
-post_std(POST_ARGS)
+post_ex(POST_ARGS)
{
- struct mdoc_node *nn, *n;
+ struct mdoc_node *n;
n = mdoc->last;
- /*
- * Macros accepting `-std' as an argument have the name of the
- * current document (`Nm') filled in as the argument if it's not
- * provided.
- */
-
if (n->child)
return(1);
- if (NULL == mdoc->meta.name)
+ if (mdoc->meta.name == NULL) {
+ mdoc_nmsg(mdoc, n, MANDOCERR_EX_NONAME);
return(1);
+ }
- nn = n;
mdoc->next = MDOC_NEXT_CHILD;
if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name))
return(0);
- mdoc->last = nn;
+ mdoc->last = n;
return(1);
}
git.ckatri.com / mandoc.git / blobdiff