version 1.36, 2009/01/17 16:15:27 |
version 1.47, 2009/01/21 17:56:32 |
|
|
|
|
#include "private.h" |
#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_pre)(struct mdoc *, struct mdoc_node *); |
typedef int (*v_post)(struct mdoc *); |
typedef int (*v_post)(struct mdoc *); |
|
|
|
|
/* FIXME: some sections should only occur in specific msecs. */ |
/* FIXME: some sections should only occur in specific msecs. */ |
/* FIXME: ignoring Pp. */ |
/* FIXME: ignoring Pp. */ |
/* FIXME: math symbols. */ |
/* FIXME: math symbols. */ |
|
/* FIXME: valid character-escape checks. */ |
|
/* FIXME: make sure required sections are included (NAME, ...). */ |
|
|
struct valids { |
struct valids { |
v_pre *pre; |
v_pre *pre; |
v_post *post; |
v_post *post; |
}; |
}; |
|
|
|
/* Utility checks. */ |
|
|
static int pre_check_parent(struct mdoc *, struct mdoc_node *, |
static int pre_check_parent(struct mdoc *, struct mdoc_node *, |
int, enum mdoc_type); |
int, enum mdoc_type); |
static int pre_check_msecs(struct mdoc *, struct mdoc_node *, |
static int pre_check_msecs(struct mdoc *, struct mdoc_node *, |
int, enum mdoc_msec *); |
int, enum mdoc_msec *); |
static int pre_check_stdarg(struct mdoc *, struct mdoc_node *); |
static int pre_check_stdarg(struct mdoc *, struct mdoc_node *); |
static int post_check_children_count(struct mdoc *); |
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. */ |
|
|
static int pre_display(struct mdoc *, struct mdoc_node *); |
static int pre_display(struct mdoc *, struct mdoc_node *); |
static int pre_sh(struct mdoc *, struct mdoc_node *); |
static int pre_sh(struct mdoc *, struct mdoc_node *); |
static int pre_ss(struct mdoc *, struct mdoc_node *); |
static int pre_ss(struct mdoc *, struct mdoc_node *); |
Line 61 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
Line 75 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
static int pre_prologue(struct mdoc *, struct mdoc_node *); |
static int pre_prologue(struct mdoc *, struct mdoc_node *); |
static int pre_prologue(struct mdoc *, struct mdoc_node *); |
static int pre_prologue(struct mdoc *, struct mdoc_node *); |
|
|
static int head_err_ge1(struct mdoc *); |
/* Specific post-child-parse routines. */ |
static int head_warn_ge1(struct mdoc *); |
|
static int head_err_eq0(struct mdoc *); |
static int herr_ge1(struct mdoc *); |
static int elem_err_eq0(struct mdoc *); |
static int herr_le1(struct mdoc *); |
static int elem_err_le1(struct mdoc *); |
static int herr_eq0(struct mdoc *); |
static int elem_err_le2(struct mdoc *); |
static int eerr_eq0(struct mdoc *); |
static int elem_err_eq1(struct mdoc *); |
static int eerr_le1(struct mdoc *); |
static int elem_err_ge1(struct mdoc *); |
static int eerr_le2(struct mdoc *); |
static int elem_warn_eq0(struct mdoc *); |
static int eerr_eq1(struct mdoc *); |
static int body_warn_ge1(struct mdoc *); |
static int eerr_ge1(struct mdoc *); |
static int body_err_eq0(struct mdoc *); |
static int ewarn_eq0(struct mdoc *); |
static int elem_warn_ge1(struct mdoc *); |
static int ewarn_eq1(struct mdoc *); |
static int elem_bool(struct mdoc *); |
static int bwarn_ge1(struct mdoc *); |
|
static int ewarn_ge1(struct mdoc *); |
|
static int ebool(struct mdoc *); |
static int post_sh(struct mdoc *); |
static int post_sh(struct mdoc *); |
|
static int post_sh_body(struct mdoc *); |
|
static int post_sh_head(struct mdoc *); |
static int post_bl(struct mdoc *); |
static int post_bl(struct mdoc *); |
static int post_it(struct mdoc *); |
static int post_it(struct mdoc *); |
static int post_ex(struct mdoc *); |
static int post_ex(struct mdoc *); |
static int post_an(struct mdoc *); |
static int post_an(struct mdoc *); |
static int post_at(struct mdoc *); |
static int post_at(struct mdoc *); |
static int post_xr(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. */ |
|
|
static v_pre pres_prologue[] = { pre_prologue, NULL }; |
static v_pre pres_prologue[] = { pre_prologue, NULL }; |
static v_pre pres_d1[] = { pre_display, NULL }; |
static v_pre pres_d1[] = { pre_display, NULL }; |
static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; |
static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; |
Line 96 static v_pre pres_rv[] = { pre_rv, NULL }; |
|
Line 119 static v_pre pres_rv[] = { pre_rv, NULL }; |
|
static v_pre pres_an[] = { pre_an, NULL }; |
static v_pre pres_an[] = { pre_an, NULL }; |
static v_pre pres_st[] = { pre_st, NULL }; |
static v_pre pres_st[] = { pre_st, NULL }; |
|
|
static v_post posts_bool[] = { elem_err_eq1, elem_bool, NULL }; |
/* Collections of post-child-parse routines. */ |
static v_post posts_bd[] = { head_err_eq0, body_warn_ge1, NULL }; |
|
static v_post posts_text[] = { elem_err_ge1, NULL }; |
static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; |
static v_post posts_wtext[] = { elem_warn_ge1, NULL }; |
static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL }; |
static v_post posts_notext[] = { elem_err_eq0, NULL }; |
static v_post posts_text[] = { eerr_ge1, NULL }; |
static v_post posts_wline[] = { head_warn_ge1, body_err_eq0, NULL }; |
static v_post posts_wtext[] = { ewarn_ge1, NULL }; |
static v_post posts_sh[] = { head_err_ge1, |
static v_post posts_notext[] = { eerr_eq0, NULL }; |
body_warn_ge1, post_sh, NULL }; |
static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL }; |
static v_post posts_bl[] = { head_err_eq0, |
static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; |
body_warn_ge1, post_bl, 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_it[] = { post_it, NULL }; |
static v_post posts_ss[] = { head_err_ge1, NULL }; |
static v_post posts_in[] = { ewarn_eq1, NULL }; |
static v_post posts_pp[] = { elem_warn_eq0, NULL }; |
static v_post posts_ss[] = { herr_ge1, NULL }; |
static v_post posts_d1[] = { head_err_ge1, NULL }; |
static v_post posts_pp[] = { ewarn_eq0, NULL }; |
static v_post posts_ex[] = { elem_err_le1, post_ex, NULL }; |
static v_post posts_ex[] = { eerr_le1, post_ex, NULL }; |
static v_post posts_an[] = { post_an, NULL }; |
static v_post posts_an[] = { post_an, NULL }; |
static v_post posts_at[] = { elem_err_eq1, post_at, NULL }; |
static v_post posts_at[] = { post_at, NULL }; |
static v_post posts_xr[] = { elem_err_ge1, elem_err_le2, |
static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL }; |
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. */ |
|
|
const struct valids mdoc_valids[MDOC_MAX] = { |
const struct valids mdoc_valids[MDOC_MAX] = { |
{ NULL, NULL }, /* \" */ |
{ NULL, NULL }, /* \" */ |
{ pres_prologue, posts_text }, /* Dd */ |
{ pres_prologue, posts_text }, /* Dd */ |
{ pres_prologue, NULL }, /* Dt */ |
{ pres_prologue, NULL }, /* Dt */ |
{ pres_prologue, NULL }, /* Os */ |
{ pres_prologue, NULL }, /* Os */ |
/* FIXME: NAME section internal ordering. */ |
|
{ pres_sh, posts_sh }, /* Sh */ |
{ pres_sh, posts_sh }, /* Sh */ |
{ pres_ss, posts_ss }, /* Ss */ |
{ pres_ss, posts_ss }, /* Ss */ |
{ NULL, posts_pp }, /* Pp */ |
{ 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 */ |
{ pres_bd, posts_bd }, /* Bd */ |
{ NULL, NULL }, /* Ed */ |
{ NULL, NULL }, /* Ed */ |
{ pres_bl, posts_bl }, /* Bl */ |
{ pres_bl, posts_bl }, /* Bl */ |
Line 144 const struct valids mdoc_valids[MDOC_MAX] = { |
|
Line 171 const struct valids mdoc_valids[MDOC_MAX] = { |
|
{ pres_ex, posts_ex }, /* Ex */ |
{ pres_ex, posts_ex }, /* Ex */ |
{ NULL, posts_text }, /* Fa */ |
{ NULL, posts_text }, /* Fa */ |
/* FIXME: only in SYNOPSIS section. */ |
/* FIXME: only in SYNOPSIS section. */ |
{ NULL, NULL }, /* Fd */ |
{ NULL, posts_wtext }, /* Fd */ |
{ NULL, NULL }, /* Fl */ |
{ NULL, NULL }, /* Fl */ |
{ NULL, posts_text }, /* Fn */ |
{ NULL, posts_text }, /* Fn */ |
{ NULL, NULL }, /* Ft */ |
{ NULL, posts_wtext }, /* Ft */ |
{ NULL, posts_text }, /* Ic */ |
{ NULL, posts_text }, /* Ic */ |
{ NULL, posts_wtext }, /* In */ |
{ NULL, posts_in }, /* In */ |
{ NULL, posts_text }, /* Li */ |
{ NULL, posts_text }, /* Li */ |
{ NULL, posts_wtext }, /* Nd */ |
{ NULL, posts_wtext }, /* Nd */ |
/* FIXME: check that name must be set/provided. */ |
{ NULL, posts_nm }, /* Nm */ |
{ NULL, NULL }, /* Nm */ |
|
{ NULL, posts_wline }, /* Op */ |
{ NULL, posts_wline }, /* Op */ |
{ NULL, NULL }, /* Ot */ |
{ NULL, NULL }, /* Ot */ |
{ NULL, NULL }, /* Pa */ |
{ NULL, NULL }, /* Pa */ |
Line 178 const struct valids mdoc_valids[MDOC_MAX] = { |
|
Line 204 const struct valids mdoc_valids[MDOC_MAX] = { |
|
{ NULL, posts_wline }, /* Aq */ |
{ NULL, posts_wline }, /* Aq */ |
{ NULL, posts_at }, /* At */ |
{ NULL, posts_at }, /* At */ |
{ NULL, NULL }, /* Bc */ |
{ NULL, NULL }, /* Bc */ |
{ NULL, NULL }, /* Bf */ |
{ NULL, posts_bf }, /* Bf */ |
{ NULL, NULL }, /* Bo */ |
{ NULL, NULL }, /* Bo */ |
{ NULL, posts_wline }, /* Bq */ |
{ NULL, posts_wline }, /* Bq */ |
{ NULL, NULL }, /* Bsx */ |
{ NULL, NULL }, /* Bsx */ |
Line 206 const struct valids mdoc_valids[MDOC_MAX] = { |
|
Line 232 const struct valids mdoc_valids[MDOC_MAX] = { |
|
{ NULL, NULL }, /* Qo */ |
{ NULL, NULL }, /* Qo */ |
{ NULL, posts_wline }, /* Qq */ |
{ NULL, posts_wline }, /* Qq */ |
{ NULL, NULL }, /* Re */ |
{ NULL, NULL }, /* Re */ |
{ NULL, NULL }, /* Rs */ |
{ NULL, posts_rs }, /* Rs */ |
{ NULL, NULL }, /* Sc */ |
{ NULL, NULL }, /* Sc */ |
{ NULL, NULL }, /* So */ |
{ NULL, NULL }, /* So */ |
{ NULL, posts_wline }, /* Sq */ |
{ NULL, posts_wline }, /* Sq */ |
Line 217 const struct valids mdoc_valids[MDOC_MAX] = { |
|
Line 243 const struct valids mdoc_valids[MDOC_MAX] = { |
|
{ NULL, NULL }, /* Ux */ |
{ NULL, NULL }, /* Ux */ |
{ NULL, NULL }, /* Xc */ |
{ NULL, NULL }, /* Xc */ |
{ NULL, NULL }, /* Xo */ |
{ NULL, NULL }, /* Xo */ |
{ NULL, NULL }, /* Fo */ |
{ NULL, posts_fo }, /* Fo */ |
{ NULL, NULL }, /* Fc */ |
{ NULL, NULL }, /* Fc */ |
{ NULL, NULL }, /* Oo */ |
{ NULL, NULL }, /* Oo */ |
{ NULL, NULL }, /* Oc */ |
{ NULL, NULL }, /* Oc */ |
{ NULL, NULL }, /* Bk */ |
{ NULL, posts_bk }, /* Bk */ |
{ NULL, NULL }, /* Ek */ |
{ NULL, NULL }, /* Ek */ |
{ NULL, posts_notext }, /* Bt */ |
{ NULL, posts_notext }, /* Bt */ |
{ NULL, NULL }, /* Hf */ |
{ NULL, NULL }, /* Hf */ |
Line 243 post_check_children_count(struct mdoc *mdoc) |
|
Line 269 post_check_children_count(struct mdoc *mdoc) |
|
|
|
|
|
static int |
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; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) > sz) |
if ((i = post_check_children_count(mdoc)) > sz) |
return(1); |
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 " |
return(mdoc_err(mdoc, "macro requires more than %d " |
"parameters (have %d)", sz, i)); |
"%s (has %d)", sz, p, i)); |
} |
} |
|
|
|
|
static int |
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; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) == sz) |
if ((i = post_check_children_count(mdoc)) == sz) |
return(1); |
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 |
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; |
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) |
if ((i = post_check_children_count(mdoc)) < sz) |
return(1); |
return(1); |
return(mdoc_err(mdoc, "macro requires less than %d " |
return(mdoc_err(mdoc, "macro requires less than %d " |
"parameters (have %d)", sz, i)); |
"%s (have %d)", sz, p, i)); |
} |
} |
|
|
|
|
Line 300 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n |
|
Line 350 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n |
|
for (i = 0; i < sz; i++) |
for (i = 0; i < sz; i++) |
if (msecs[i] == mdoc->meta.msec) |
if (msecs[i] == mdoc->meta.msec) |
return(1); |
return(1); |
return(mdoc_nwarn(mdoc, node, WARN_COMPAT, |
return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not " |
"macro is not appropriate for this manual section")); |
"appropriate for manual section")); |
} |
} |
|
|
|
|
Line 323 pre_check_parent(struct mdoc *mdoc, struct mdoc_node * |
|
Line 373 pre_check_parent(struct mdoc *mdoc, struct mdoc_node * |
|
|
|
|
|
static int |
static int |
body_err_eq0(struct mdoc *mdoc) |
bwarn_ge1(struct mdoc *mdoc) |
{ |
{ |
|
|
if (MDOC_BODY != mdoc->last->type) |
if (MDOC_BODY != mdoc->last->type) |
return(1); |
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 |
static int |
body_warn_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")); |
|
} |
} |
|
|
|
|
static int |
static int |
elem_warn_eq0(struct mdoc *mdoc) |
ewarn_eq0(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
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")); |
|
} |
} |
|
|
|
|
static int |
static int |
elem_warn_ge1(struct mdoc *mdoc) |
ewarn_ge1(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
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")); |
|
} |
} |
|
|
|
|
static int |
static int |
elem_err_eq1(struct mdoc *mdoc) |
eerr_eq1(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_eq(mdoc, 1)); |
return(post_check_children_eq(mdoc, "parameters", 1)); |
} |
} |
|
|
|
|
static int |
static int |
elem_err_le2(struct mdoc *mdoc) |
eerr_le2(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_lt(mdoc, 3)); |
return(post_check_children_lt(mdoc, "parameters", 3)); |
} |
} |
|
|
|
|
static int |
static int |
elem_err_le1(struct mdoc *mdoc) |
eerr_le1(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_lt(mdoc, 2)); |
return(post_check_children_lt(mdoc, "parameters", 2)); |
} |
} |
|
|
|
|
static int |
static int |
elem_err_eq0(struct mdoc *mdoc) |
eerr_eq0(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_eq(mdoc, 0)); |
return(post_check_children_eq(mdoc, "parameters", 0)); |
} |
} |
|
|
|
|
static int |
static int |
elem_err_ge1(struct mdoc *mdoc) |
eerr_ge1(struct mdoc *mdoc) |
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_gt(mdoc, 0)); |
return(post_check_children_gt(mdoc, "parameters", 0)); |
} |
} |
|
|
|
|
static int |
static int |
head_err_eq0(struct mdoc *mdoc) |
herr_eq0(struct mdoc *mdoc) |
{ |
{ |
|
|
if (MDOC_HEAD != mdoc->last->type) |
if (MDOC_HEAD != mdoc->last->type) |
return(1); |
return(1); |
return(post_check_children_eq(mdoc, 0)); |
return(post_check_children_eq(mdoc, "parameters", 0)); |
} |
} |
|
|
|
|
static int |
static int |
head_warn_ge1(struct mdoc *mdoc) |
herr_le1(struct mdoc *mdoc) |
{ |
{ |
|
|
if (MDOC_HEAD != mdoc->last->type) |
if (MDOC_HEAD != mdoc->last->type) |
return(1); |
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")); |
|
} |
} |
|
|
|
|
static int |
static int |
head_err_ge1(struct mdoc *mdoc) |
herr_ge1(struct mdoc *mdoc) |
{ |
{ |
|
|
if (MDOC_HEAD != mdoc->last->type) |
if (MDOC_HEAD != mdoc->last->type) |
return(1); |
return(1); |
return(post_check_children_gt(mdoc, 0)); |
return(post_check_children_gt(mdoc, "parameters", 0)); |
} |
} |
|
|
|
|
Line 455 pre_display(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 492 pre_display(struct mdoc *mdoc, struct mdoc_node *node) |
|
return(1); |
return(1); |
|
|
assert(mdoc->last); |
assert(mdoc->last); |
|
/* LINTED */ |
for (n = mdoc->last->parent; n; n = n->parent) |
for (n = mdoc->last->parent; n; n = n->parent) |
if (MDOC_BLOCK == n->type) |
if (MDOC_BLOCK == n->type) |
if (MDOC_Bd == n->tok) |
if (MDOC_Bd == n->tok) |
Line 479 pre_bl(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 517 pre_bl(struct mdoc *mdoc, struct mdoc_node *node) |
|
argv = NULL; |
argv = NULL; |
argc = node->data.block.argc; |
argc = node->data.block.argc; |
|
|
|
/* LINTED */ |
for (i = type = err = 0; i < argc; i++) { |
for (i = type = err = 0; i < argc; i++) { |
argv = &node->data.block.argv[(int)i]; |
argv = &node->data.block.argv[(int)i]; |
assert(argv); |
assert(argv); |
Line 536 pre_bd(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 575 pre_bd(struct mdoc *mdoc, struct mdoc_node *node) |
|
argv = NULL; |
argv = NULL; |
argc = node->data.block.argc; |
argc = node->data.block.argc; |
|
|
|
/* LINTED */ |
for (err = i = type = 0; 0 == err && i < argc; i++) { |
for (err = i = type = 0; 0 == err && i < argc; i++) { |
argv = &node->data.block.argv[(int)i]; |
argv = &node->data.block.argv[(int)i]; |
assert(argv); |
assert(argv); |
|
|
pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) |
pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) |
{ |
{ |
|
|
if (SEC_PROLOGUE != mdoc->sec_lastn) |
if (SEC_PROLOGUE != mdoc->lastnamed) |
return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); |
return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); |
assert(MDOC_ELEM == node->type); |
assert(MDOC_ELEM == node->type); |
|
|
Line 727 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node |
|
Line 767 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node |
|
|
|
|
|
static int |
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) |
|
{ |
|
|
|
assert(MDOC_ELEM == mdoc->last->type); |
|
assert(MDOC_Nm == mdoc->last->tok); |
|
if (mdoc->last->child) |
|
return(1); |
|
if (mdoc->meta.name) |
|
return(1); |
|
return(mdoc_err(mdoc, "macro `%s' has not been invoked with a name", |
|
mdoc_macronames[MDOC_Nm])); |
|
} |
|
|
|
|
|
static int |
post_xr(struct mdoc *mdoc) |
post_xr(struct mdoc *mdoc) |
{ |
{ |
struct mdoc_node *n; |
struct mdoc_node *n; |
Line 751 post_at(struct mdoc *mdoc) |
|
Line 840 post_at(struct mdoc *mdoc) |
|
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_At == mdoc->last->tok); |
assert(MDOC_At == mdoc->last->tok); |
assert(mdoc->last->child); |
|
|
if (NULL == mdoc->last->child) |
|
return(1); |
assert(MDOC_TEXT == mdoc->last->child->type); |
assert(MDOC_TEXT == mdoc->last->child->type); |
|
|
if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) |
if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) |
Line 813 post_it(struct mdoc *mdoc) |
|
Line 904 post_it(struct mdoc *mdoc) |
|
#define TYPE_NONE (0) |
#define TYPE_NONE (0) |
#define TYPE_BODY (1) |
#define TYPE_BODY (1) |
#define TYPE_HEAD (2) |
#define TYPE_HEAD (2) |
|
#define TYPE_OHEAD (3) |
size_t i, argc; |
size_t i, argc; |
struct mdoc_node *n; |
struct mdoc_node *n; |
|
|
Line 831 post_it(struct mdoc *mdoc) |
|
Line 923 post_it(struct mdoc *mdoc) |
|
|
|
argc = n->data.block.argc; |
argc = n->data.block.argc; |
type = TYPE_NONE; |
type = TYPE_NONE; |
|
sv = -1; |
|
|
/* Some types require block-head, some not. */ |
/* Some types require block-head, some not. */ |
|
|
|
/* LINTED */ |
for (i = 0; TYPE_NONE == type && i < argc; i++) |
for (i = 0; TYPE_NONE == type && i < argc; i++) |
switch (n->data.block.argv[(int)i].arg) { |
switch (n->data.block.argv[(int)i].arg) { |
case (MDOC_Tag): |
case (MDOC_Tag): |
Line 857 post_it(struct mdoc *mdoc) |
|
Line 951 post_it(struct mdoc *mdoc) |
|
case (MDOC_Hyphen): |
case (MDOC_Hyphen): |
/* FALLTHROUGH */ |
/* FALLTHROUGH */ |
case (MDOC_Item): |
case (MDOC_Item): |
/* FALLTHROUGH */ |
|
case (MDOC_Column): |
|
type = TYPE_BODY; |
type = TYPE_BODY; |
sv = n->data.block.argv[(int)i].arg; |
sv = n->data.block.argv[(int)i].arg; |
break; |
break; |
|
case (MDOC_Column): |
|
type = TYPE_OHEAD; |
|
sv = n->data.block.argv[(int)i].arg; |
|
break; |
default: |
default: |
break; |
break; |
} |
} |
|
|
assert(TYPE_NONE != type); |
assert(TYPE_NONE != type); |
|
|
|
n = mdoc->last->data.block.head; |
|
assert(n); |
|
|
if (TYPE_HEAD == type) { |
if (TYPE_HEAD == type) { |
n = mdoc->last->data.block.head; |
|
assert(n); |
|
if (NULL == n->child) |
if (NULL == n->child) |
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) |
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) |
return(0); |
return(0); |
Line 881 post_it(struct mdoc *mdoc) |
|
Line 978 post_it(struct mdoc *mdoc) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) |
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) |
return(0); |
return(0); |
|
|
return(1); |
} else if (TYPE_BODY == type) { |
|
if (n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters")) |
|
return(0); |
|
|
|
n = mdoc->last->data.block.body; |
|
assert(n); |
|
if (NULL == n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) |
|
return(0); |
|
} else { |
|
if (NULL == n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) |
|
return(0); |
|
|
|
n = mdoc->last->data.block.body; |
|
assert(n); |
|
if (n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children")) |
|
return(0); |
} |
} |
|
|
assert(TYPE_BODY == type); |
if (MDOC_Column != sv) |
assert(mdoc->last->data.block.head); |
|
|
|
n = mdoc->last->data.block.head; |
|
assert(n); |
|
if (n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters")) |
|
return(0); |
|
|
|
n = mdoc->last->data.block.body; |
|
assert(n); |
|
if (NULL == n->child) |
|
if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) |
|
return(0); |
|
|
|
if (MDOC_Column != sv) |
|
return(1); |
return(1); |
|
|
/* Make sure the number of columns is sane. */ |
/* Make sure the number of columns is sane. */ |
|
|
sv = mdoc->last->parent->parent->data.block.argv->sz; |
argc = mdoc->last->parent->parent->data.block.argv->sz; |
n = mdoc->last->data.block.head->child; |
n = mdoc->last->data.block.head->child; |
|
|
for (i = 0; n; n = n->next) |
for (i = 0; n; n = n->next) |
i++; |
i++; |
|
|
if (i == (size_t)sv) |
if (i == argc) |
return(1); |
return(1); |
return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i)); |
return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i)); |
#undef TYPE_NONE |
#undef TYPE_NONE |
#undef TYPE_BODY |
#undef TYPE_BODY |
#undef TYPE_HEAD |
#undef TYPE_HEAD |
|
#undef TYPE_OHEAD |
} |
} |
|
|
|
|
/* Make sure that only `It' macros are our body-children. */ |
|
static int |
static int |
post_bl(struct mdoc *mdoc) |
post_bl(struct mdoc *mdoc) |
{ |
{ |
Line 929 post_bl(struct mdoc *mdoc) |
|
Line 1030 post_bl(struct mdoc *mdoc) |
|
return(1); |
return(1); |
assert(MDOC_Bl == mdoc->last->tok); |
assert(MDOC_Bl == mdoc->last->tok); |
|
|
|
/* LINTED */ |
for (n = mdoc->last->child; n; n = n->next) { |
for (n = mdoc->last->child; n; n = n->next) { |
if (MDOC_BLOCK == n->type) |
if (MDOC_BLOCK == n->type) |
if (MDOC_It == n->tok) |
if (MDOC_It == n->tok) |
Line 942 post_bl(struct mdoc *mdoc) |
|
Line 1044 post_bl(struct mdoc *mdoc) |
|
|
|
|
|
static int |
static int |
elem_bool(struct mdoc *mdoc) |
ebool(struct mdoc *mdoc) |
{ |
{ |
struct mdoc_node *n; |
struct mdoc_node *n; |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
|
/* LINTED */ |
for (n = mdoc->last->child; n; n = n->next) { |
for (n = mdoc->last->child; n; n = n->next) { |
if (MDOC_TEXT != n->type) |
if (MDOC_TEXT != n->type) |
break; |
break; |
Line 958 elem_bool(struct mdoc *mdoc) |
|
Line 1061 elem_bool(struct mdoc *mdoc) |
|
} |
} |
if (NULL == n) |
if (NULL == n) |
return(1); |
return(1); |
return(mdoc_nerr(mdoc, n, "expected boolean value [on/off]")); |
return(mdoc_nerr(mdoc, n, "expected boolean value")); |
} |
} |
|
|
|
|
/* Warn if conventional sections are out of order. */ |
|
static int |
static int |
|
post_root(struct mdoc *mdoc) |
|
{ |
|
|
|
if (NULL == mdoc->first->child) |
|
return(mdoc_err(mdoc, "document has no data")); |
|
if (SEC_PROLOGUE == mdoc->lastnamed) |
|
return(mdoc_err(mdoc, "document has incomplete prologue")); |
|
if (MDOC_BLOCK != mdoc->first->child->type) |
|
return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); |
|
if (MDOC_Sh != mdoc->first->child->tok) |
|
return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); |
|
return(1); |
|
} |
|
|
|
|
|
static int |
post_sh(struct mdoc *mdoc) |
post_sh(struct mdoc *mdoc) |
{ |
{ |
|
|
|
if (MDOC_HEAD == mdoc->last->type) |
|
return(post_sh_head(mdoc)); |
|
if (MDOC_BODY == mdoc->last->type) |
|
return(post_sh_body(mdoc)); |
|
return(1); |
|
} |
|
|
|
|
|
static int |
|
post_sh_body(struct mdoc *mdoc) |
|
{ |
|
struct mdoc_node *n; |
|
|
|
assert(MDOC_Sh == mdoc->last->tok); |
|
if (SEC_NAME != mdoc->lastnamed) |
|
return(1); |
|
|
|
if (NULL == (n = mdoc->last->child)) |
|
return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm])); |
|
if (MDOC_ELEM != n->type || MDOC_Nm != n->tok) |
|
return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm])); |
|
if (NULL == (n = n->next)) |
|
return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd])); |
|
if (MDOC_ELEM != n->type || MDOC_Nd != n->tok) |
|
return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd])); |
|
if (NULL == (n = n->next)) |
|
return(1); |
|
|
|
return(mdoc_warn(mdoc, WARN_SYNTAX, "section NAME usually limited to %s and %s body children", |
|
mdoc_macronames[MDOC_Nm], mdoc_macronames[MDOC_Nd])); |
|
} |
|
|
|
|
|
static int |
|
post_sh_head(struct mdoc *mdoc) |
|
{ |
char buf[64]; |
char buf[64]; |
enum mdoc_sec sec; |
enum mdoc_sec sec; |
|
|
if (MDOC_HEAD != mdoc->last->type) |
|
return(1); |
|
assert(MDOC_Sh == mdoc->last->tok); |
assert(MDOC_Sh == mdoc->last->tok); |
|
|
if ( ! xstrlcats(buf, mdoc->last->child, 64)) |
if ( ! xstrlcats(buf, mdoc->last->child, 64)) |
return(mdoc_err(mdoc, "macro parameters too long")); |
return(mdoc_err(mdoc, "macro parameters too long")); |
|
|
if (SEC_CUSTOM == (sec = mdoc_atosec(buf))) |
sec = mdoc_atosec(buf); |
|
|
|
if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec) |
|
return(mdoc_err(mdoc, "section NAME must be first")); |
|
if (SEC_CUSTOM == sec) |
return(1); |
return(1); |
if (sec > mdoc->sec_lastn) |
if (sec == mdoc->lastnamed) |
return(1); |
|
if (sec == mdoc->sec_lastn) |
|
return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); |
return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); |
return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); |
if (sec < mdoc->lastnamed) |
|
return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); |
|
|
|
return(1); |
} |
} |
|
|
|
|
Line 991 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no |
|
Line 1149 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no |
|
{ |
{ |
v_pre *p; |
v_pre *p; |
|
|
/* TODO: character-escape checks. */ |
|
|
|
if (MDOC_TEXT == node->type) |
if (MDOC_TEXT == node->type) |
return(1); |
return(1); |
assert(MDOC_ROOT != node->type); |
assert(MDOC_ROOT != node->type); |
Line 1011 mdoc_valid_post(struct mdoc *mdoc) |
|
Line 1167 mdoc_valid_post(struct mdoc *mdoc) |
|
{ |
{ |
v_post *p; |
v_post *p; |
|
|
|
if (MDOC_VALID & mdoc->last->flags) |
|
return(1); |
|
mdoc->last->flags |= MDOC_VALID; |
|
|
if (MDOC_TEXT == mdoc->last->type) |
if (MDOC_TEXT == mdoc->last->type) |
return(1); |
return(1); |
if (MDOC_ROOT == mdoc->last->type) { |
if (MDOC_ROOT == mdoc->last->type) |
/* TODO: make sure prologue is complete. */ |
return(post_root(mdoc)); |
return(1); |
|
} |
|
|
|
if (NULL == mdoc_valids[mdoc->last->tok].post) |
if (NULL == mdoc_valids[mdoc->last->tok].post) |
return(1); |
return(1); |