mandoc/validate.c - diff

Return to validate.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/validate.c between version 1.38 and 1.45

version 1.38, 2009/01/17 20:10:36

version 1.45, 2009/01/20 20:56:21

Line 21

#include "private.h"

* Pre- and post-validate macros as they're parsed. Pre-validation

* occurs when the macro has been detected and its arguments parsed.

* Post-validation occurs when all child macros have also been parsed.

* In the ELEMENT case, this is simply the parameters of the macro; in

* the BLOCK case, this is the HEAD, BODY, TAIL and so on.

typedef int (*v_pre)(struct mdoc *, struct mdoc_node *);

typedef int (*v_post)(struct mdoc *);

/* FIXME: some sections should only occur in specific msecs. */

/* FIXME: ignoring Pp. */

/* FIXME: math symbols. */

/* FIXME: make sure prologue is complete. */

/* FIXME: valid character-escape checks. */

/* FIXME: make sure required sections are included (NAME, ...). */

struct valids {

v_pre *pre;

Line 43 static int pre_check_msecs(struct mdoc *, struct mdoc_

Line 51 static int pre_check_msecs(struct mdoc *, struct mdoc_

int, enum mdoc_msec *);

static int pre_check_stdarg(struct mdoc *, struct mdoc_node *);

static int post_check_children_count(struct mdoc *);

static int post_check_children_lt(struct mdoc *, int);

static int post_check_children_lt(struct mdoc *, const char *, int);

static int post_check_children_gt(struct mdoc *, int);

static int post_check_children_gt(struct mdoc *, const char *, int);

static int post_check_children_eq(struct mdoc *, int);

static int post_check_children_wgt(struct mdoc *, const char *, int);

static int post_check_children_eq(struct mdoc *, const char *, int);

static int post_check_children_weq(struct mdoc *, const char *, int);

/* Specific pre-child-parse routines. */

Line 68 static int pre_prologue(struct mdoc *, struct mdoc_nod

Line 78 static int pre_prologue(struct mdoc *, struct mdoc_nod

/* Specific post-child-parse routines. */

static int herr_ge1(struct mdoc *);

static int hwarn_ge1(struct mdoc *);

static int herr_le1(struct mdoc *);

static int herr_eq0(struct mdoc *);

static int eerr_eq0(struct mdoc *);

static int eerr_le1(struct mdoc *);

Line 76 static int eerr_le2(struct mdoc *);

Line 86 static int eerr_le2(struct mdoc *);

static int eerr_eq1(struct mdoc *);

static int eerr_ge1(struct mdoc *);

static int ewarn_eq0(struct mdoc *);

static int ewarn_eq1(struct mdoc *);

static int bwarn_ge1(struct mdoc *);

static int berr_eq0(struct mdoc *);

static int ewarn_ge1(struct mdoc *);

static int ebool(struct mdoc *);

static int post_sh(struct mdoc *);

Line 88 static int post_an(struct mdoc *);

Line 98 static int post_an(struct mdoc *);

static int post_at(struct mdoc *);

static int post_xr(struct mdoc *);

static int post_nm(struct mdoc *);

static int post_bf(struct mdoc *);

static int post_root(struct mdoc *);

/* Collections of pre-child-parse routines. */

Line 113 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL

Line 124 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL

static v_post posts_text[] = { eerr_ge1, NULL };

static v_post posts_wtext[] = { ewarn_ge1, NULL };

static v_post posts_notext[] = { eerr_eq0, NULL };

static v_post posts_wline[] = { hwarn_ge1, berr_eq0, NULL };

static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };

static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };

static v_post posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };

static v_post posts_it[] = { post_it, NULL };

static v_post posts_in[] = { ewarn_eq1, NULL };

static v_post posts_ss[] = { herr_ge1, NULL };

static v_post posts_pp[] = { ewarn_eq0, NULL };

static v_post posts_d1[] = { herr_ge1, NULL };

static v_post posts_ex[] = { eerr_le1, post_ex, NULL };

static v_post posts_an[] = { post_an, NULL };

static v_post posts_at[] = { post_at, NULL };

static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };

static v_post posts_nm[] = { post_nm, NULL };

static v_post posts_bf[] = { herr_le1, post_bf, NULL };

static v_post posts_rs[] = { herr_eq0, bwarn_ge1, NULL };

static v_post posts_fo[] = { bwarn_ge1, NULL };

static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL };

/* Per-macro pre- and post-child-check routine collections. */

Line 137 const struct valids mdoc_valids[MDOC_MAX] = {

Line 152 const struct valids mdoc_valids[MDOC_MAX] = {

{ pres_sh, posts_sh }, /* Sh */

{ pres_ss, posts_ss }, /* Ss */

{ NULL, posts_pp }, /* Pp */

{ pres_d1, posts_d1 }, /* D1 */

{ pres_d1, posts_wline }, /* D1 */

{ pres_d1, posts_d1 }, /* Dl */

{ pres_d1, posts_wline }, /* Dl */

{ pres_bd, posts_bd }, /* Bd */

{ NULL, NULL }, /* Ed */

{ pres_bl, posts_bl }, /* Bl */

Line 155 const struct valids mdoc_valids[MDOC_MAX] = {

Line 170 const struct valids mdoc_valids[MDOC_MAX] = {

{ pres_ex, posts_ex }, /* Ex */

{ NULL, posts_text }, /* Fa */

/* FIXME: only in SYNOPSIS section. */

{ NULL, NULL }, /* Fd */

{ NULL, posts_wtext }, /* Fd */

{ NULL, NULL }, /* Fl */

{ NULL, posts_text }, /* Fn */

{ NULL, NULL }, /* Ft */

{ NULL, posts_wtext }, /* Ft */

{ NULL, posts_text }, /* Ic */

{ NULL, posts_wtext }, /* In */

{ NULL, posts_in }, /* In */

{ NULL, posts_text }, /* Li */

{ NULL, posts_wtext }, /* Nd */

{ NULL, posts_nm }, /* Nm */

Line 188 const struct valids mdoc_valids[MDOC_MAX] = {

Line 203 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, posts_wline }, /* Aq */

{ NULL, posts_at }, /* At */

{ NULL, NULL }, /* Bc */

{ NULL, NULL }, /* Bf */

{ NULL, posts_bf }, /* Bf */

{ NULL, NULL }, /* Bo */

{ NULL, posts_wline }, /* Bq */

{ NULL, NULL }, /* Bsx */

Line 216 const struct valids mdoc_valids[MDOC_MAX] = {

Line 231 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Qo */

{ NULL, posts_wline }, /* Qq */

{ NULL, NULL }, /* Re */

{ NULL, NULL }, /* Rs */

{ NULL, posts_rs }, /* Rs */

{ NULL, NULL }, /* Sc */

{ NULL, NULL }, /* So */

{ NULL, posts_wline }, /* Sq */

Line 227 const struct valids mdoc_valids[MDOC_MAX] = {

Line 242 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Ux */

{ NULL, NULL }, /* Xc */

{ NULL, NULL }, /* Xo */

{ NULL, NULL }, /* Fo */

{ NULL, posts_fo }, /* Fo */

{ NULL, NULL }, /* Fc */

{ NULL, NULL }, /* Oo */

{ NULL, NULL }, /* Oc */

{ NULL, NULL }, /* Bk */

{ NULL, posts_bk }, /* Bk */

{ NULL, NULL }, /* Ek */

{ NULL, posts_notext }, /* Bt */

{ NULL, NULL }, /* Hf */

Line 253 post_check_children_count(struct mdoc *mdoc)

Line 268 post_check_children_count(struct mdoc *mdoc)

static int

post_check_children_gt(struct mdoc *mdoc, int sz)

post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz)

{

int i;

if ((i = post_check_children_count(mdoc)) > sz)

return(1);

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more "

"than %d %s (has %d)", sz, p, i));

}

static int

post_check_children_gt(struct mdoc *mdoc, const char *p, int sz)

{

int i;

if ((i = post_check_children_count(mdoc)) > sz)

return(1);

return(mdoc_err(mdoc, "macro requires more than %d "

"parameters (have %d)", sz, i));

"%s (has %d)", sz, p, i));

}

static int

post_check_children_eq(struct mdoc *mdoc, int sz)

post_check_children_weq(struct mdoc *mdoc, const char *p, int sz)

{

int i;

if ((i = post_check_children_count(mdoc)) == sz)

return(1);

return(mdoc_err(mdoc, "macro requires %d parameters "

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d "

"(have %d)", sz, i));

"%s (has %d)", sz, p, i));

}

static int

post_check_children_lt(struct mdoc *mdoc, int sz)

post_check_children_eq(struct mdoc *mdoc, const char *p, int sz)

{

int i;

if ((i = post_check_children_count(mdoc)) == sz)

return(1);

return(mdoc_err(mdoc, "macro requires %d %s "

"(have %d)", sz, p, i));

}

static int

post_check_children_lt(struct mdoc *mdoc, const char *p, int sz)

{

int i;

if ((i = post_check_children_count(mdoc)) < sz)

return(1);

return(mdoc_err(mdoc, "macro requires less than %d "

"parameters (have %d)", sz, i));

"%s (have %d)", sz, p, i));

}

Line 333 pre_check_parent(struct mdoc *mdoc, struct mdoc_node *

Line 372 pre_check_parent(struct mdoc *mdoc, struct mdoc_node *

static int

berr_eq0(struct mdoc *mdoc)

bwarn_ge1(struct mdoc *mdoc)

{

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

return(1);

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

return(post_check_children_wgt(mdoc, "body children", 0));

return(1);

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));

}

static int

bwarn_ge1(struct mdoc *mdoc)

ewarn_eq1(struct mdoc *mdoc)

{

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

assert(MDOC_ELEM == mdoc->last->type);

return(1);

return(post_check_children_weq(mdoc, "parameters", 1));

if (mdoc->last->child)

return(1);

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));

}

Line 361 ewarn_eq0(struct mdoc *mdoc)

Line 395 ewarn_eq0(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

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

return(post_check_children_weq(mdoc, "parameters", 0));

return(1);

return(mdoc_pwarn(mdoc, mdoc->last->child->line,

mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));

}

Line 373 ewarn_ge1(struct mdoc *mdoc)

Line 404 ewarn_ge1(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

if (mdoc->last->child)

return(post_check_children_wgt(mdoc, "parameters", 0));

return(1);

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));

}

Line 384 eerr_eq1(struct mdoc *mdoc)

Line 413 eerr_eq1(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

return(post_check_children_eq(mdoc, 1));

return(post_check_children_eq(mdoc, "parameters", 1));

}

Line 393 eerr_le2(struct mdoc *mdoc)

Line 422 eerr_le2(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

return(post_check_children_lt(mdoc, 3));

return(post_check_children_lt(mdoc, "parameters", 3));

}

Line 402 eerr_le1(struct mdoc *mdoc)

Line 431 eerr_le1(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

return(post_check_children_lt(mdoc, 2));

return(post_check_children_lt(mdoc, "parameters", 2));

}

Line 411 eerr_eq0(struct mdoc *mdoc)

Line 440 eerr_eq0(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

return(post_check_children_eq(mdoc, 0));

return(post_check_children_eq(mdoc, "parameters", 0));

}

Line 420 eerr_ge1(struct mdoc *mdoc)

Line 449 eerr_ge1(struct mdoc *mdoc)

{

assert(MDOC_ELEM == mdoc->last->type);

return(post_check_children_gt(mdoc, 0));

return(post_check_children_gt(mdoc, "parameters", 0));

}

Line 430 herr_eq0(struct mdoc *mdoc)

Line 459 herr_eq0(struct mdoc *mdoc)

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

return(1);

return(post_check_children_eq(mdoc, 0));

return(post_check_children_eq(mdoc, "parameters", 0));

}

static int

hwarn_ge1(struct mdoc *mdoc)

herr_le1(struct mdoc *mdoc)

{

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

return(1);

if (mdoc->last->child)

return(post_check_children_lt(mdoc, "parameters", 2));

return(1);

return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));

}

Line 452 herr_ge1(struct mdoc *mdoc)

Line 478 herr_ge1(struct mdoc *mdoc)

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

return(1);

return(post_check_children_gt(mdoc, 0));

return(post_check_children_gt(mdoc, "parameters", 0));

}

Line 740 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node

Line 766 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node

static int

post_bf(struct mdoc *mdoc)

{

char *p;

struct mdoc_node *head;

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

return(1);

assert(MDOC_Bf == mdoc->last->tok);

head = mdoc->last->data.block.head;

assert(head);

if (0 == mdoc->last->data.block.argc) {

if (head->child) {

assert(MDOC_TEXT == head->child->type);

p = head->child->data.text.string;

if (xstrcmp(p, "Em"))

return(1);

else if (xstrcmp(p, "Li"))

return(1);

else if (xstrcmp(p, "Sm"))

return(1);

return(mdoc_nerr(mdoc, head->child, "invalid font mode"));

}

return(mdoc_err(mdoc, "macro expects an argument or parameter"));

}

if (head->child)

return(mdoc_err(mdoc, "macro expects an argument or parameter"));

if (1 == mdoc->last->data.block.argc)

return(1);

return(mdoc_err(mdoc, "macro expects an argument or parameter"));

}

static int

post_nm(struct mdoc *mdoc)

{

Line 1003 post_root(struct mdoc *mdoc)

Line 1063 post_root(struct mdoc *mdoc)

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

return(mdoc_err(mdoc, "document has no data"));

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

return(mdoc_err(mdoc, "document has no incomplete prologue"));

return(mdoc_err(mdoc, "document has incomplete prologue"));

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

return(mdoc_err(mdoc, "document has no incomplete prologue"));

return(mdoc_err(mdoc, "document has incomplete prologue"));

if (0 == mdoc->meta.date)

return(mdoc_err(mdoc, "document has no incomplete prologue"));

return(mdoc_err(mdoc, "document has incomplete prologue"));

return(1);

}

Line 1058 int

Line 1118 int

mdoc_valid_post(struct mdoc *mdoc)

{

v_post *p;

if (MDOC_VALID & mdoc->last->flags)

return(1);

mdoc->last->flags |= MDOC_VALID;

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

return(1);

CVSweb