mandoc/mdoc_validate.c - diff

Return to mdoc_validate.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_validate.c between version 1.264 and 1.276

version 1.264, 2014/12/18 19:23:41

version 1.276, 2015/02/06 16:06:25

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

Line 48 enum check_ineq {

CHECK_EQ

};

enum check_lvl {

CHECK_WARN,

CHECK_ERROR,

};

typedef void (*v_pre)(PRE_ARGS);

typedef void (*v_post)(POST_ARGS);

Line 61 struct valids {

Line 56 struct valids {

v_post post;

};

static void check_count(struct mdoc *, enum mdoc_type,

enum check_lvl, enum check_ineq, int);

static void check_text(struct mdoc *, int, int, char *);

static void check_argv(struct mdoc *,

struct mdoc_node *, struct mdoc_argv *);

Line 72 static enum mdoc_sec a2sec(const char *);

Line 65 static enum mdoc_sec a2sec(const char *);

static size_t macro2len(enum mdoct);

static void rewrite_macro2len(char **);

static void bwarn_ge1(POST_ARGS);

static void ewarn_eq1(POST_ARGS);

static void ewarn_ge1(POST_ARGS);

static void hwarn_eq0(POST_ARGS);

static void post_an(POST_ARGS);

static void post_at(POST_ARGS);

static void post_bf(POST_ARGS);

Line 99 static void post_fn(POST_ARGS);

Line 87 static void post_fn(POST_ARGS);

static void post_fname(POST_ARGS);

static void post_fo(POST_ARGS);

static void post_hyph(POST_ARGS);

static void post_hyphtext(POST_ARGS);

static void post_ignpar(POST_ARGS);

static void post_it(POST_ARGS);

static void post_lb(POST_ARGS);

Line 157 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 144 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Ev */

{ pre_std, post_ex }, /* Ex */

{ NULL, post_fa }, /* Fa */

{ NULL, ewarn_ge1 }, /* Fd */

{ NULL, NULL }, /* Fd */

{ NULL, NULL }, /* Fl */

{ NULL, post_fn }, /* Fn */

{ NULL, NULL }, /* Ft */

{ NULL, NULL }, /* Ic */

{ NULL, ewarn_eq1 }, /* In */

{ NULL, NULL }, /* In */

{ NULL, post_defaults }, /* Li */

{ NULL, post_nd }, /* Nd */

{ NULL, post_nm }, /* Nm */

Line 173 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 160 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, post_st }, /* St */

{ NULL, NULL }, /* Va */

{ NULL, post_vt }, /* Vt */

{ NULL, ewarn_ge1 }, /* Xr */

{ NULL, NULL }, /* Xr */

{ NULL, ewarn_ge1 }, /* %A */

{ NULL, NULL }, /* %A */

{ NULL, post_hyphtext }, /* %B */ /* FIXME: can be used outside Rs/Re. */

{ NULL, post_hyph }, /* %B */ /* FIXME: can be used outside Rs/Re. */

{ NULL, ewarn_ge1 }, /* %D */

{ NULL, NULL }, /* %D */

{ NULL, ewarn_ge1 }, /* %I */

{ NULL, NULL }, /* %I */

{ NULL, ewarn_ge1 }, /* %J */

{ NULL, NULL }, /* %J */

{ NULL, post_hyphtext }, /* %N */

{ NULL, post_hyph }, /* %N */

{ NULL, post_hyphtext }, /* %O */

{ NULL, post_hyph }, /* %O */

{ NULL, ewarn_ge1 }, /* %P */

{ NULL, NULL }, /* %P */

{ NULL, post_hyphtext }, /* %R */

{ NULL, post_hyph }, /* %R */

{ NULL, post_hyphtext }, /* %T */ /* FIXME: can be used outside Rs/Re. */

{ NULL, post_hyph }, /* %T */ /* FIXME: can be used outside Rs/Re. */

{ NULL, ewarn_ge1 }, /* %V */

{ NULL, NULL }, /* %V */

{ NULL, NULL }, /* Ac */

{ NULL, NULL }, /* Ao */

{ NULL, NULL }, /* Aq */

Line 246 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 233 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Brq */

{ NULL, NULL }, /* Bro */

{ NULL, NULL }, /* Brc */

{ NULL, ewarn_ge1 }, /* %C */

{ NULL, NULL }, /* %C */

{ pre_obsolete, post_es }, /* Es */

{ pre_obsolete, post_en }, /* En */

{ NULL, NULL }, /* Dx */

{ NULL, ewarn_ge1 }, /* %Q */

{ NULL, NULL }, /* %Q */

{ NULL, post_par }, /* br */

{ NULL, post_par }, /* sp */

{ NULL, ewarn_eq1 }, /* %U */

{ NULL, NULL }, /* %U */

{ NULL, NULL }, /* Ta */

{ NULL, NULL }, /* ll */

};

Line 373 mdoc_valid_post(struct mdoc *mdoc)

Line 360 mdoc_valid_post(struct mdoc *mdoc)

}

static void

check_count(struct mdoc *mdoc, enum mdoc_type type,

enum check_lvl lvl, enum check_ineq ineq, int val)

{

const char *p;

enum mandocerr t;

if (mdoc->last->type != type)

return;

switch (ineq) {

case CHECK_LT:

p = "less than ";

if (mdoc->last->nchild < val)

return;

break;

case CHECK_GT:

p = "more than ";

if (mdoc->last->nchild > val)

return;

break;

case CHECK_EQ:

p = "";

if (val == mdoc->last->nchild)

return;

break;

default:

abort();

/* NOTREACHED */

}

t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT;

mandoc_vmsg(t, mdoc->parse, mdoc->last->line,

mdoc->last->pos, "want %s%d children (have %d)",

p, val, mdoc->last->nchild);

}

static void

bwarn_ge1(POST_ARGS)

{

check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0);

}

static void

ewarn_eq1(POST_ARGS)

{

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);

}

static void

ewarn_ge1(POST_ARGS)

{

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0);

}

static void

hwarn_eq0(POST_ARGS)

{

check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0);

}

static void

check_args(struct mdoc *mdoc, struct mdoc_node *n)

{

int i;

Line 941 post_lb(POST_ARGS)

Line 867 post_lb(POST_ARGS)

const char *stdlibname;

char *libname;

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);

n = mdoc->last->child;

assert(MDOC_TEXT == n->type);

Line 994 post_fn(POST_ARGS)

Line 919 post_fn(POST_ARGS)

static void

post_fo(POST_ARGS)

{

const struct mdoc_node *n;

check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1);

n = mdoc->last;

bwarn_ge1(mdoc);

if (mdoc->last->type == MDOC_HEAD && mdoc->last->nchild)

if (n->type != MDOC_HEAD)

post_fname(mdoc);

return;

if (n->child == NULL) {

mandoc_msg(MANDOCERR_FO_NOHEAD, mdoc->parse,

n->line, n->pos, "Fo");

return;

}

if (n->child != n->last) {

mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,

n->child->next->line, n->child->next->pos,

"Fo ... %s", n->child->next->string);

while (n->child != n->last)

mdoc_node_delete(mdoc, n->last);

}

post_fname(mdoc);

}

static void

Line 1047 post_vt(POST_ARGS)

Line 988 post_vt(POST_ARGS)

static void

post_nm(POST_ARGS)

{

struct mdoc_node *n;

n = mdoc->last;

if (n->last != NULL &&

(n->last->tok == MDOC_Pp ||

n->last->tok == MDOC_Lp))

mdoc_node_relink(mdoc, n->last);

if (NULL != mdoc->meta.name)

return;

mdoc_deroff(&mdoc->meta.name, mdoc->last);

mdoc_deroff(&mdoc->meta.name, n);

if (NULL == mdoc->meta.name)

mandoc_msg(MANDOCERR_NM_NONAME, mdoc->parse,

mdoc->last->line, mdoc->last->pos, "Nm");

n->line, n->pos, "Nm");

}

static void

post_nd(POST_ARGS)

{

struct mdoc_node *n;

check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0);

n = mdoc->last;

if (n->type != MDOC_BODY)

return;

if (n->child == NULL)

mandoc_msg(MANDOCERR_ND_EMPTY, mdoc->parse,

n->line, n->pos, "Nd");

post_hyph(mdoc);

}

static void

post_d1(POST_ARGS)

{

struct mdoc_node *n;

bwarn_ge1(mdoc);

n = mdoc->last;

if (n->type != MDOC_BODY)

return;

if (n->child == NULL)

mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,

n->line, n->pos, "D1");

post_hyph(mdoc);

}

static void

post_literal(POST_ARGS)

{

struct mdoc_node *n;

if (mdoc->last->tok == MDOC_Bd)

n = mdoc->last;

hwarn_eq0(mdoc);

bwarn_ge1(mdoc);

if (n->type != MDOC_BODY)

* The `Dl' (note "el" not "one") and `Bd' macros unset the

return;

* MDOC_LITERAL flag as they leave. Note that `Bd' only sets

* this in literal mode, but it doesn't hurt to just switch it

* off in general since displays can't be nested.

if (MDOC_BODY == mdoc->last->type)

if (n->child == NULL)

mdoc->flags &= ~MDOC_LITERAL;

mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,

n->line, n->pos, mdoc_macronames[n->tok]);

if (n->tok == MDOC_Bd &&

n->norm->Bd.type != DISP_literal &&

n->norm->Bd.type != DISP_unfilled)

return;

mdoc->flags &= ~MDOC_LITERAL;

}

static void

Line 1164 post_at(POST_ARGS)

Line 1134 post_at(POST_ARGS)

static void

post_an(POST_ARGS)

{

struct mdoc_node *np;

struct mdoc_node *np, *nch;

np = mdoc->last;

if (AUTH__NONE == np->norm->An.auth) {

nch = np->child;

if (0 == np->child)

if (np->norm->An.auth == AUTH__NONE) {

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0);

if (nch == NULL)

} else if (np->child)

mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0);

np->line, np->pos, "An");

} else if (nch != NULL)

mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,

nch->line, nch->pos, "An ... %s", nch->string);

}

static void

Line 1248 post_it(POST_ARGS)

Line 1221 post_it(POST_ARGS)

i++;

if (i < cols || i > cols + 1)

mandoc_vmsg(MANDOCERR_ARGCOUNT,

mandoc_vmsg(MANDOCERR_BL_COL,

mdoc->parse, nit->line, nit->pos,

"columns == %d (have %d)", cols, i);

"%d columns, %d cells", cols, i);

break;

default:

abort();

Line 1404 post_bl_block_tag(POST_ARGS)

Line 1377 post_bl_block_tag(POST_ARGS)

static void

post_bl_head(POST_ARGS)

{

struct mdoc_node *np, *nn, *nnp;

struct mdoc_node *nbl, *nh, *nch, *nnext;

struct mdoc_argv *argv;

int i, j;

if (LIST_column != mdoc->last->norm->Bl.type) {

nh = mdoc->last;

/* FIXME: this should be ERROR class... */

hwarn_eq0(mdoc);

if (nh->norm->Bl.type != LIST_column) {

if ((nch = nh->child) == NULL)

return;

mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,

nch->line, nch->pos, "Bl ... %s", nch->string);

while (nch != NULL) {

mdoc_node_delete(mdoc, nch);

nch = nh->child;

}

return;

}

Line 1420 post_bl_head(POST_ARGS)

Line 1401 post_bl_head(POST_ARGS)

* lists where they're argument values following -column.

if (mdoc->last->child == NULL)

if (nh->child == NULL)

return;

np = mdoc->last->parent;

nbl = nh->parent;

assert(np->args);

for (j = 0; j < (int)nbl->args->argc; j++)

if (nbl->args->argv[j].arg == MDOC_Column)

for (j = 0; j < (int)np->args->argc; j++)

if (MDOC_Column == np->args->argv[j].arg)

break;

assert(j < (int)np->args->argc);

assert(j < (int)nbl->args->argc);

* Accommodate for new-style groff column syntax. Shuffle the

Line 1438 post_bl_head(POST_ARGS)

Line 1417 post_bl_head(POST_ARGS)

* column field. Then, delete the head children.

argv = np->args->argv + j;

argv = nbl->args->argv + j;

i = argv->sz;

argv->sz += mdoc->last->nchild;

argv->sz += nh->nchild;

argv->value = mandoc_reallocarray(argv->value,

argv->sz, sizeof(char *));

mdoc->last->norm->Bl.ncols = argv->sz;

nh->norm->Bl.ncols = argv->sz;

mdoc->last->norm->Bl.cols = (void *)argv->value;

nh->norm->Bl.cols = (void *)argv->value;

for (nn = mdoc->last->child; nn; i++) {

for (nch = nh->child; nch != NULL; nch = nnext) {

argv->value[i] = nn->string;

argv->value[i++] = nch->string;

nn->string = NULL;

nch->string = NULL;

nnp = nn;

nnext = nch->next;

nn = nn->next;

mdoc_node_delete(NULL, nch);

mdoc_node_delete(NULL, nnp);

}

nh->nchild = 0;

mdoc->last->nchild = 0;

nh->child = NULL;

mdoc->last->child = NULL;

}

static void

Line 1480 post_bl(POST_ARGS)

Line 1457 post_bl(POST_ARGS)

return;

}

bwarn_ge1(mdoc);

nchild = nbody->child;

while (NULL != nchild) {

if (nchild == NULL) {

if (MDOC_It == nchild->tok || MDOC_Sm == nchild->tok) {

mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,

nbody->line, nbody->pos, "Bl");

return;

}

while (nchild != NULL) {

if (nchild->tok == MDOC_It ||

(nchild->tok == MDOC_Sm &&

nchild->next != NULL &&

nchild->next->tok == MDOC_It)) {

nchild = nchild->next;

continue;

}

Line 1539 post_bl(POST_ARGS)

Line 1522 post_bl(POST_ARGS)

static void

post_bk(POST_ARGS)

{

struct mdoc_node *n;

hwarn_eq0(mdoc);

n = mdoc->last;

bwarn_ge1(mdoc);

if (n->type == MDOC_BLOCK && n->body->child == NULL) {

mandoc_msg(MANDOCERR_BLK_EMPTY,

mdoc->parse, n->line, n->pos, "Bk");

mdoc_node_delete(mdoc, n);

}

static void

Line 1623 post_st(POST_ARGS)

Line 1612 post_st(POST_ARGS)

n = mdoc->last;

nch = n->child;

if (NULL == nch) {

mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,

n->line, n->pos, mdoc_macronames[n->tok]);

mdoc_node_delete(mdoc, n);

return;

}

assert(MDOC_TEXT == nch->type);

if (NULL == (p = mdoc_a2st(nch->string))) {

Line 1645 post_st(POST_ARGS)

Line 1627 post_st(POST_ARGS)

static void

post_rs(POST_ARGS)

{

struct mdoc_node *nn, *next, *prev;

struct mdoc_node *np, *nch, *next, *prev;

int i, j;

switch (mdoc->last->type) {

np = mdoc->last;

case MDOC_HEAD:

check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0);

if (np->type != MDOC_BODY)

return;

case MDOC_BODY:

if (mdoc->last->child)

if (np->child == NULL) {

break;

mandoc_msg(MANDOCERR_RS_EMPTY, mdoc->parse,

check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0);

np->line, np->pos, "Rs");

return;

default:

return;

}

Line 1668 post_rs(POST_ARGS)

Line 1648 post_rs(POST_ARGS)

next = NULL;

for (nn = mdoc->last->child->next; nn; nn = next) {

for (nch = np->child->next; nch != NULL; nch = next) {

/* Determine order of `nn'. */

/* Determine order number of this child. */

for (i = 0; i < RSORD_MAX; i++)

if (rsord[i] == nn->tok)

if (rsord[i] == nch->tok)

break;

if (i == RSORD_MAX) {

mandoc_msg(MANDOCERR_RS_BAD,

mdoc->parse, nn->line, nn->pos,

mdoc->parse, nch->line, nch->pos,

mdoc_macronames[nn->tok]);

mdoc_macronames[nch->tok]);

i = -1;

} else if (MDOC__J == nn->tok || MDOC__B == nn->tok)

} else if (nch->tok == MDOC__J || nch->tok == MDOC__B)

mdoc->last->norm->Rs.quote_T++;

np->norm->Rs.quote_T++;

* Remove `nn' from the chain. This somewhat

* Remove this child from the chain. This somewhat

* repeats mdoc_node_unlink(), but since we're

* just re-ordering, there's no need for the

* full unlink process.

if (NULL != (next = nn->next))

if ((next = nch->next) != NULL)

next->prev = nn->prev;

next->prev = nch->prev;

if (NULL != (prev = nn->prev))

if ((prev = nch->prev) != NULL)

prev->next = nn->next;

prev->next = nch->next;

nn->prev = nn->next = NULL;

nch->prev = nch->next = NULL;

* Scan back until we reach a node that's

* ordered before `nn'.

* to be ordered before this child.

for ( ; prev ; prev = prev->prev) {

Line 1715 post_rs(POST_ARGS)

Line 1695 post_rs(POST_ARGS)

}

* Set `nn' back into its correct place in front

* Set this child back into its correct place

* of the `prev' node.

* in front of the `prev' node.

nn->prev = prev;

nch->prev = prev;

if (prev) {

if (prev == NULL) {

if (prev->next)

np->child->prev = nch;

prev->next->prev = nn;

nch->next = np->child;

nn->next = prev->next;

np->child = nch;

prev->next = nn;

} else {

mdoc->last->child->prev = nn;

if (prev->next)

nn->next = mdoc->last->child;

prev->next->prev = nch;

mdoc->last->child = nn;

nch->next = prev->next;

prev->next = nch;

}

Line 1741 post_rs(POST_ARGS)

Line 1721 post_rs(POST_ARGS)

static void

post_hyph(POST_ARGS)

{

struct mdoc_node *n, *nch;

struct mdoc_node *nch;

char *cp;

n = mdoc->last;

for (nch = mdoc->last->child; nch != NULL; nch = nch->next) {

switch (n->type) {

if (nch->type != MDOC_TEXT)

case MDOC_HEAD:

if (MDOC_Sh == n->tok || MDOC_Ss == n->tok)

break;

return;

case MDOC_BODY:

if (MDOC_D1 == n->tok || MDOC_Nd == n->tok)

break;

return;

case MDOC_ELEM:

break;

default:

return;

}

for (nch = n->child; nch; nch = nch->next) {

if (MDOC_TEXT != nch->type)

continue;

cp = nch->string;

if ('\0' == *cp)

if (*cp == '\0')

continue;

while ('\0' != *(++cp))

while (*(++cp) != '\0')

if ('-' == *cp &&

if (*cp == '-' &&

isalpha((unsigned char)cp[-1]) &&

isalpha((unsigned char)cp[1]))

*cp = ASCII_HYPH;

Line 1775 post_hyph(POST_ARGS)

Line 1739 post_hyph(POST_ARGS)

}

static void

post_hyphtext(POST_ARGS)

{

ewarn_ge1(mdoc);

post_hyph(mdoc);

}

static void

post_ns(POST_ARGS)

{

Line 2061 post_ignpar(POST_ARGS)

Line 2017 post_ignpar(POST_ARGS)

{

struct mdoc_node *np;

check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0);

switch (mdoc->last->type) {

post_hyph(mdoc);

case MDOC_HEAD:

post_hyph(mdoc);

if (MDOC_BODY != mdoc->last->type)

return;

case MDOC_BODY:

break;

default:

return;

}

if (NULL != (np = mdoc->last->child))

if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {

Line 2123 post_par(POST_ARGS)

Line 2083 post_par(POST_ARGS)

{

struct mdoc_node *np;

if (mdoc->last->tok == MDOC_sp)

np = mdoc->last;

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2);

else

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0);

if (MDOC_ELEM != mdoc->last->type &&

if (np->tok == MDOC_sp) {

MDOC_BLOCK != mdoc->last->type)

if (np->nchild > 1)

return;

mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,

np->child->next->line, np->child->next->pos,

"sp ... %s", np->child->next->string);

} else if (np->child != NULL)

mandoc_vmsg(MANDOCERR_ARG_SKIP,

mdoc->parse, np->line, np->pos, "%s %s",

mdoc_macronames[np->tok], np->child->string);

if (NULL == (np = mdoc->last->prev)) {

np = mdoc->last->parent;

CVSweb