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.83 and 1.95

version 1.83, 2010/05/26 09:35:35

version 1.95, 2010/06/12 11:41:50

Line 34

/* FIXME: .Bl -diag can't have non-text children in HEAD. */

/* TODO: ignoring Pp (it's superfluous in some invocations). */

#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n

#define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n

#define POST_ARGS struct mdoc *mdoc

typedef int (*v_pre)(PRE_ARGS);

Line 47 struct valids {

static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);

static int check_stdarg(PRE_ARGS);

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

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

static int check_argv(struct mdoc *,

const struct mdoc_node *,

struct mdoc_node *, struct mdoc_argv *);

const struct mdoc_argv *);

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

static int check_args(struct mdoc *,

const struct mdoc_node *);

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

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

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

Line 83 static int post_at(POST_ARGS);

Line 81 static int post_at(POST_ARGS);

static int post_bf(POST_ARGS);

static int post_bl(POST_ARGS);

static int post_bl_head(POST_ARGS);

static int post_dt(POST_ARGS);

static int post_it(POST_ARGS);

static int post_lb(POST_ARGS);

static int post_nm(POST_ARGS);

Line 92 static int post_sh(POST_ARGS);

Line 91 static int post_sh(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_eoln(POST_ARGS);

static int post_vt(POST_ARGS);

static int pre_an(PRE_ARGS);

static int pre_bd(PRE_ARGS);

Line 111 static v_post posts_bd[] = { hwarn_eq0, bwarn_ge1, NU

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

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

static v_post posts_bool[] = { eerr_eq1, ebool, NULL };

static v_post posts_eoln[] = { post_eoln, NULL };

static v_post posts_dt[] = { post_dt, NULL };

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

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

static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };

Line 127 static v_post posts_text1[] = { eerr_eq1, NULL };

Line 129 static v_post posts_text1[] = { eerr_eq1, NULL };

static v_post posts_vt[] = { post_vt, NULL };

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

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

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

static v_pre pres_an[] = { pre_an, NULL };

static v_pre pres_bd[] = { pre_display, pre_bd, NULL };

static v_pre pres_bl[] = { pre_bl, NULL };

Line 146 static v_pre pres_ss[] = { pre_ss, NULL };

Line 147 static v_pre pres_ss[] = { pre_ss, NULL };

const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Ap */

{ pres_dd, posts_text }, /* Dd */

{ pres_dt, NULL }, /* Dt */

{ pres_dt, posts_dt }, /* Dt */

{ pres_os, NULL }, /* Os */

{ pres_sh, posts_sh }, /* Sh */

{ pres_ss, posts_ss }, /* Ss */

Line 184 const struct valids mdoc_valids[MDOC_MAX] = {

Line 185 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, posts_st }, /* St */

{ NULL, NULL }, /* Va */

{ NULL, posts_vt }, /* Vt */

{ NULL, posts_xr }, /* Xr */

{ NULL, posts_wtext }, /* Xr */

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

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

{ NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */

Line 246 const struct valids mdoc_valids[MDOC_MAX] = {

Line 247 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Oc */

{ NULL, posts_wline }, /* Bk */

{ NULL, NULL }, /* Ek */

{ NULL, posts_notext }, /* Bt */

{ NULL, posts_eoln }, /* Bt */

{ NULL, NULL }, /* Hf */

{ NULL, NULL }, /* Fr */

{ NULL, posts_notext }, /* Ud */

{ NULL, posts_eoln }, /* Ud */

{ NULL, posts_lb }, /* Lb */

{ NULL, posts_notext }, /* Lp */

{ NULL, posts_text }, /* Lk */

Line 265 const struct valids mdoc_valids[MDOC_MAX] = {

Line 266 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, posts_notext }, /* br */

{ NULL, posts_sp }, /* sp */

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

{ NULL, NULL }, /* Ta */

};

int

mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)

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

{

v_pre *p;

int line, pos;

const char *tp;

char *tp;

if (MDOC_TEXT == n->type) {

tp = n->string;

Line 391 CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */

Line 393 CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */

CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */

CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */

CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */

CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */

CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_ge1() */

CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */

CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */

CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */

Line 415 check_stdarg(PRE_ARGS)

Line 417 check_stdarg(PRE_ARGS)

static int

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

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

{

int i;

Line 432 check_args(struct mdoc *m, const struct mdoc_node *n)

Line 434 check_args(struct mdoc *m, const struct mdoc_node *n)

static int

check_argv(struct mdoc *m, const struct mdoc_node *n,

check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)

const struct mdoc_argv *v)

{

int i;

Line 453 check_argv(struct mdoc *m, const struct mdoc_node *n,

Line 454 check_argv(struct mdoc *m, const struct mdoc_node *n,

static int

check_text(struct mdoc *mdoc, int line, int pos, const char *p)

check_text(struct mdoc *mdoc, int line, int pos, char *p)

{

int c;

Line 531 pre_display(PRE_ARGS)

Line 532 pre_display(PRE_ARGS)

static int

pre_bl(PRE_ARGS)

{

int pos, type, width, offset;

int i, width, offs, cmpt, dupl;

enum mdoc_list lt;

if (MDOC_BLOCK != n->type)

if (MDOC_BLOCK != n->type) {

assert(n->parent);

assert(MDOC_BLOCK == n->parent->type);

assert(MDOC_Bl == n->parent->tok);

assert(LIST__NONE != n->parent->data.list);

n->data.list = n->parent->data.list;

return(1);

if (NULL == n->args) {

mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);

return(0);

}

/* Make sure that only one type of list is specified. */

* First figure out which kind of list to use: bind ourselves to

* the first mentioned list type and warn about any remaining

* ones. If we find no list type, we default to LIST_item.

type = offset = width = -1;

assert(LIST__NONE == n->data.list);

offs = width = cmpt = -1;

/* LINTED */

for (pos = 0; pos < (int)n->args->argc; pos++)

for (i = 0; n->args && i < (int)n->args->argc; i++) {

switch (n->args->argv[pos].arg) {

lt = LIST__NONE;

dupl = 0;

switch (n->args->argv[i].arg) {

/* Set list types. */

case (MDOC_Bullet):

/* FALLTHROUGH */

lt = LIST_bullet;

break;

case (MDOC_Dash):

/* FALLTHROUGH */

lt = LIST_dash;

break;

case (MDOC_Enum):

/* FALLTHROUGH */

lt = LIST_enum;

break;

case (MDOC_Hyphen):

/* FALLTHROUGH */

lt = LIST_hyphen;

break;

case (MDOC_Item):

/* FALLTHROUGH */

lt = LIST_item;

break;

case (MDOC_Tag):

/* FALLTHROUGH */

lt = LIST_tag;

break;

case (MDOC_Diag):

/* FALLTHROUGH */

lt = LIST_diag;

break;

case (MDOC_Hang):

/* FALLTHROUGH */

lt = LIST_hang;

break;

case (MDOC_Ohang):

/* FALLTHROUGH */

lt = LIST_ohang;

break;

case (MDOC_Inset):

/* FALLTHROUGH */

lt = LIST_inset;

break;

case (MDOC_Column):

if (type < 0) {

lt = LIST_column;

type = n->args->argv[pos].arg;

break;

/* Set list arguments. */

}

if (mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP))

break;

return(0);

case (MDOC_Compact):

if (type >= 0)

if (cmpt >= 0)

break;

dupl++;

if (mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))

cmpt = i;

break;

return(0);

case (MDOC_Width):

if (width >= 0)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))

dupl++;

return(0);

width = i;

if (type < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))

return(0);

width = n->args->argv[pos].arg;

break;

case (MDOC_Offset):

if (offset >= 0)

if (offs >= 0)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))

dupl++;

return(0);

offs = i;

if (type < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))

return(0);

offset = n->args->argv[pos].arg;

break;

default:

break;

}

if (type < 0) {

/* Check: duplicate auxiliary arguments. */

mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);

return(0);

if (dupl)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))

return(0);

/* Check: multiple list types. */

if (LIST__NONE != lt && n->data.list != LIST__NONE)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP))

return(0);

/* Assign list type. */

if (LIST__NONE != lt && n->data.list == LIST__NONE)

n->data.list = lt;

/* The list type should come first. */

if (n->data.list == LIST__NONE)

if (width >= 0 || offs >= 0 || cmpt >= 0)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST))

return(0);

continue;

}

/* Allow lists to default to LIST_item. */

if (LIST__NONE == n->data.list) {

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE))

return(0);

n->data.list = LIST_item;

}

* Validate the width field. Some list types don't need width

* types and should be warned about them. Others should have it

* and must also be warned.

switch (type) {

switch (n->data.list) {

case (MDOC_Tag):

case (LIST_tag):

if (width < 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG))

if (width >= 0)

return(0);

break;

if (mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG))

case (MDOC_Column):

break;

return(0);

case (LIST_column):

/* FALLTHROUGH */

case (MDOC_Diag):

case (LIST_diag):

/* FALLTHROUGH */

case (MDOC_Ohang):

case (LIST_ohang):

/* FALLTHROUGH */

case (MDOC_Inset):

case (LIST_inset):

/* FALLTHROUGH */

case (MDOC_Item):

case (LIST_item):

if (width >= 0 && ! mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG))

if (width < 0)

return(0);

break;

if (mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG))

break;

return(0);

default:

break;

}

Line 640 pre_bl(PRE_ARGS)

Line 683 pre_bl(PRE_ARGS)

static int

pre_bd(PRE_ARGS)

{

int i, type, err;

int i, dup, comp;

enum mdoc_disp dt;

const char *offs;

if (MDOC_BLOCK != n->type)

if (MDOC_BLOCK != n->type) {

assert(n->parent);

assert(MDOC_BLOCK == n->parent->type);

assert(MDOC_Bd == n->parent->tok);

assert(DISP__NONE != n->parent->data.Bd.type);

memcpy(&n->data.Bd, &n->parent->data.Bd,

sizeof(struct mdoc_bd));

return(1);

if (NULL == n->args) {

mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);

return(0);

}

/* Make sure that only one type of display is specified. */

assert(DISP__NONE == n->data.Bd.type);

/* LINTED */

for (i = 0, err = type = 0; ! err &&

for (i = 0; n->args && i < (int)n->args->argc; i++) {

i < (int)n->args->argc; i++)

dt = DISP__NONE;

dup = comp = 0;

offs = NULL;

switch (n->args->argv[i].arg) {

case (MDOC_Centred):

/* FALLTHROUGH */

dt = DISP_centred;

break;

case (MDOC_Ragged):

/* FALLTHROUGH */

dt = DISP_ragged;

break;

case (MDOC_Unfilled):

/* FALLTHROUGH */

dt = DISP_unfilled;

break;

case (MDOC_Filled):

/* FALLTHROUGH */

dt = DISP_filled;

break;

case (MDOC_Literal):

if (0 == type++)

dt = DISP_literal;

break;

case (MDOC_File):

mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP);

return(0);

case (MDOC_Offset):

/* NB: this can be empty! */

if (n->args->argv[i].sz) {

offs = n->args->argv[i].value[0];

dup = (NULL != n->data.Bd.offs);

break;

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP))

}

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV))

return(0);

break;

default:

case (MDOC_Compact):

comp = 1;

dup = n->data.Bd.comp;

break;

default:

abort();

/* NOTREACHED */

}

if (type)

/* Check whether we have duplicates. */

return(1);

mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);

if (dup && ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP))

return(0);

/* Make our auxiliary assignments. */

if (offs && ! dup)

n->data.Bd.offs = offs;

if (comp && ! dup)

n->data.Bd.comp = comp;

/* Check whether a type has already been assigned. */

if (DISP__NONE != dt && n->data.Bd.type != DISP__NONE)

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP))

return(0);

/* Make our type assignment. */

if (DISP__NONE != dt && n->data.Bd.type == DISP__NONE)

n->data.Bd.type = dt;

}

if (DISP__NONE == n->data.Bd.type) {

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE))

return(0);

n->data.Bd.type = DISP_ragged;

}

return(1);

}

Line 737 pre_rv(PRE_ARGS)

Line 834 pre_rv(PRE_ARGS)

static int

pre_dt(PRE_ARGS)

post_dt(POST_ARGS)

{

const struct mdoc_node *nn;

const char *p;

/* FIXME: make sure is capitalised. */

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

for (p = nn->string; *p; p++) {

if (toupper((u_char)*p) == *p)

continue;

if ( ! mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE))

return(0);

break;

}

return(1);

}

static int

pre_dt(PRE_ARGS)

{

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

if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO))

return(0);

Line 829 post_lb(POST_ARGS)

Line 943 post_lb(POST_ARGS)

static int

post_eoln(POST_ARGS)

{

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

return(1);

return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST));

}

static int

post_vt(POST_ARGS)

{

const struct mdoc_node *n;

Line 898 post_an(POST_ARGS)

Line 1022 post_an(POST_ARGS)

static int

post_it(POST_ARGS)

{

int type, i, cols;

int i, cols, rc;

enum mdoc_list lt;

struct mdoc_node *n, *c;

enum mandocerr er;

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

return(1);

n = mdoc->last->parent->parent;

if (NULL == n->args) {

lt = n->data.list;

mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);

return(0);

}

/* Some types require block-head, some not. */

if (LIST__NONE == lt) {

/* LINTED */

for (cols = type = -1, i = 0; -1 == type &&

i < (int)n->args->argc; i++)

switch (n->args->argv[i].arg) {

case (MDOC_Tag):

/* FALLTHROUGH */

case (MDOC_Diag):

/* FALLTHROUGH */

case (MDOC_Hang):

/* FALLTHROUGH */

case (MDOC_Ohang):

/* FALLTHROUGH */

case (MDOC_Inset):

/* FALLTHROUGH */

case (MDOC_Bullet):

/* FALLTHROUGH */

case (MDOC_Dash):

/* FALLTHROUGH */

case (MDOC_Enum):

/* FALLTHROUGH */

case (MDOC_Hyphen):

/* FALLTHROUGH */

case (MDOC_Item):

type = n->args->argv[i].arg;

break;

case (MDOC_Column):

type = n->args->argv[i].arg;

cols = (int)n->args->argv[i].sz;

break;

default:

break;

}

if (-1 == type) {

mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);

return(0);

}

switch (type) {

switch (lt) {

case (MDOC_Tag):

case (LIST_tag):

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

if (mdoc->last->head->child)

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))

break;

return(0);

/* FIXME: give this a dummy value. */

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))

return(0);

break;

case (MDOC_Hang):

case (LIST_hang):

/* FALLTHROUGH */

case (MDOC_Ohang):

case (LIST_ohang):

/* FALLTHROUGH */

case (MDOC_Inset):

case (LIST_inset):

/* FALLTHROUGH */

case (MDOC_Diag):

case (LIST_diag):

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

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))

return(0);

Line 970 post_it(POST_ARGS)

Line 1060 post_it(POST_ARGS)

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))

return(0);

break;

case (MDOC_Bullet):

case (LIST_bullet):

/* FALLTHROUGH */

case (MDOC_Dash):

case (LIST_dash):

/* FALLTHROUGH */

case (MDOC_Enum):

case (LIST_enum):

/* FALLTHROUGH */

case (MDOC_Hyphen):

case (LIST_hyphen):

/* FALLTHROUGH */

case (MDOC_Item):

case (LIST_item):

if (mdoc->last->head->child)

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST))

return(0);

Line 986 post_it(POST_ARGS)

Line 1076 post_it(POST_ARGS)

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))

return(0);

break;

case (MDOC_Column):

case (LIST_column):

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

cols = -1;

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS))

for (i = 0; i < (int)n->args->argc; i++)

return(0);

if (MDOC_Column == n->args->argv[i].arg) {

if (mdoc->last->body->child)

cols = (int)n->args->argv[i].sz;

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BODYLOST))

break;

return(0);

}

c = mdoc->last->child;

for (i = 0; c && MDOC_HEAD == c->type; c = c->next)

i++;

if (i < cols) {

assert(-1 != cols);

if ( ! mdoc_vmsg(mdoc, MANDOCERR_ARGCOUNT,

assert(NULL == mdoc->last->head->child);

mdoc->last->line,

mdoc->last->pos,

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

"columns == %d (have %d)",

if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY))

cols, i))

return(0);

for (i = 0, c = mdoc->last->child; c; c = c->next)

if (MDOC_BODY == c->type)

i++;

if (i < cols)

er = MANDOCERR_ARGCOUNT;

else if (i == cols || i == cols + 1)

break;

} else if (i == cols || i == cols + 1)

else

break;

er = MANDOCERR_SYNTARGCOUNT;

mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT,

rc = mdoc_vmsg(mdoc, er,

mdoc->last->line, mdoc->last->pos,

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

return(0);

return(rc);

default:

break;

}

Line 1023 post_it(POST_ARGS)

Line 1117 post_it(POST_ARGS)

static int

post_bl_head(POST_ARGS)

{

int i;

const struct mdoc_node *n;

struct mdoc_node *n;

const struct mdoc_argv *a;

assert(mdoc->last->parent);

n = mdoc->last->parent;

assert(n->args);

for (i = 0; i < (int)n->args->argc; i++) {

if (LIST_column == n->data.list) {

a = &n->args->argv[i];

for (i = 0; i < (int)n->args->argc; i++)

if (a->arg == MDOC_Column) {

if (MDOC_Column == n->args->argv[i].arg)

if (a->sz && mdoc->last->nchild)

break;

return(mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS));

assert(i < (int)n->args->argc);

return(1);

if (n->args->argv[i].sz && mdoc->last->nchild) {

mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS);

return(0);

}

return(1);

}

if (0 == (i = mdoc->last->nchild))

CVSweb