version 1.39, 2009/01/19 17:02:59 |
version 1.52, 2009/02/22 19:23:48 |
|
|
|
|
#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: .Ef arguments */ |
/* FIXME: math symbols. */ |
/* FIXME: math symbols. */ |
/* FIXME: make sure prologue is complete. */ |
|
/* FIXME: valid character-escape checks. */ |
/* FIXME: valid character-escape checks. */ |
/* FIXME: make sure required sections are included (NAME, ...). */ |
/* FIXME: .Fd only in synopsis section. */ |
|
|
struct valids { |
struct valids { |
v_pre *pre; |
v_pre *pre; |
|
|
|
|
/* Utility checks. */ |
/* Utility checks. */ |
|
|
static int pre_check_parent(struct mdoc *, struct mdoc_node *, |
static int 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 check_msec(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 check_stdarg(struct mdoc *, struct mdoc_node *); |
static int post_check_children_count(struct mdoc *); |
static int err_child_lt(struct mdoc *, const char *, int); |
static int post_check_children_lt(struct mdoc *, int); |
static int err_child_gt(struct mdoc *, const char *, int); |
static int post_check_children_gt(struct mdoc *, int); |
static int warn_child_gt(struct mdoc *, const char *, int); |
static int post_check_children_wgt(struct mdoc *, int); |
static int err_child_eq(struct mdoc *, const char *, int); |
static int post_check_children_eq(struct mdoc *, int); |
static int warn_child_eq(struct mdoc *, const char *, int); |
static int post_check_children_weq(struct mdoc *, int); |
|
|
|
|
/* Utility auxiliaries. */ |
|
|
|
static inline int count_child(struct mdoc *); |
|
static inline int warn_count(struct mdoc *, const char *, |
|
int, const char *, int); |
|
static inline int err_count(struct mdoc *, const char *, |
|
int, const char *, int); |
|
|
/* Specific pre-child-parse routines. */ |
/* Specific pre-child-parse routines. */ |
|
|
static int pre_display(struct mdoc *, struct mdoc_node *); |
static int pre_display(struct mdoc *, struct mdoc_node *); |
Line 71 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
Line 86 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
/* Specific post-child-parse routines. */ |
/* Specific post-child-parse routines. */ |
|
|
static int herr_ge1(struct mdoc *); |
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 herr_eq0(struct mdoc *); |
static int eerr_eq0(struct mdoc *); |
static int eerr_eq0(struct mdoc *); |
static int eerr_le1(struct mdoc *); |
static int eerr_le1(struct mdoc *); |
Line 81 static int eerr_ge1(struct mdoc *); |
|
Line 96 static int eerr_ge1(struct mdoc *); |
|
static int ewarn_eq0(struct mdoc *); |
static int ewarn_eq0(struct mdoc *); |
static int ewarn_eq1(struct mdoc *); |
static int ewarn_eq1(struct mdoc *); |
static int bwarn_ge1(struct mdoc *); |
static int bwarn_ge1(struct mdoc *); |
static int berr_eq0(struct mdoc *); |
|
static int ewarn_ge1(struct mdoc *); |
static int ewarn_ge1(struct mdoc *); |
static int ebool(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 *); |
Line 92 static int post_an(struct mdoc *); |
|
Line 108 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_nm(struct mdoc *); |
|
static int post_bf(struct mdoc *); |
static int post_root(struct mdoc *); |
static int post_root(struct mdoc *); |
|
|
/* Collections of pre-child-parse routines. */ |
/* Collections of pre-child-parse routines. */ |
Line 117 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL |
|
Line 134 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL |
|
static v_post posts_text[] = { eerr_ge1, NULL }; |
static v_post posts_text[] = { eerr_ge1, NULL }; |
static v_post posts_wtext[] = { ewarn_ge1, NULL }; |
static v_post posts_wtext[] = { ewarn_ge1, NULL }; |
static v_post posts_notext[] = { eerr_eq0, 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_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; |
static v_post posts_bl[] = { herr_eq0, bwarn_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_in[] = { ewarn_eq1, NULL }; |
static v_post posts_in[] = { ewarn_eq1, NULL }; |
static v_post posts_ss[] = { herr_ge1, NULL }; |
static v_post posts_ss[] = { herr_ge1, NULL }; |
|
static v_post posts_pf[] = { eerr_eq1, NULL }; |
static v_post posts_pp[] = { ewarn_eq0, 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_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[] = { post_at, 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_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL }; |
static v_post posts_nm[] = { post_nm, 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. */ |
/* 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_wline }, /* D1 */ |
{ pres_d1, posts_d1 }, /* D1 */ |
{ pres_d1, posts_wline }, /* Dl */ |
{ pres_d1, posts_d1 }, /* 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 */ |
{ NULL, NULL }, /* El */ |
{ NULL, NULL }, /* El */ |
{ pres_it, posts_it }, /* It */ |
{ pres_it, posts_it }, /* It */ |
{ NULL, posts_text }, /* Ad */ |
{ NULL, posts_text }, /* Ad */ |
{ pres_an, posts_an }, /* An */ |
{ pres_an, posts_an }, /* An */ |
{ NULL, NULL }, /* Ar */ |
{ NULL, NULL }, /* Ar */ |
{ pres_cd, posts_text }, /* Cd */ |
{ pres_cd, posts_text }, /* Cd */ |
{ NULL, NULL }, /* Cm */ |
{ NULL, NULL }, /* Cm */ |
{ NULL, posts_text }, /* Dv */ |
{ NULL, posts_text }, /* Dv */ |
{ pres_er, posts_text }, /* Er */ |
{ pres_er, posts_text }, /* Er */ |
{ NULL, posts_text }, /* Ev */ |
{ NULL, posts_text }, /* Ev */ |
{ pres_ex, posts_ex }, /* Ex */ |
{ pres_ex, posts_ex }, /* Ex */ |
{ NULL, posts_text }, /* Fa */ |
{ NULL, posts_text }, /* Fa */ |
{ NULL, posts_wtext }, /* Fd */ |
/* FIXME: only in SYNOPSIS section. */ |
{ NULL, NULL }, /* Fl */ |
{ NULL, posts_wtext }, /* Fd */ |
{ NULL, posts_text }, /* Fn */ |
{ NULL, NULL }, /* Fl */ |
{ NULL, posts_wtext }, /* Ft */ |
{ NULL, posts_text }, /* Fn */ |
{ NULL, posts_text }, /* Ic */ |
{ NULL, posts_wtext }, /* Ft */ |
{ NULL, posts_in }, /* In */ |
{ NULL, posts_text }, /* Ic */ |
{ NULL, posts_text }, /* Li */ |
{ NULL, posts_in }, /* In */ |
{ NULL, posts_wtext }, /* Nd */ |
{ NULL, posts_text }, /* Li */ |
{ NULL, posts_nm }, /* Nm */ |
{ NULL, posts_wtext }, /* Nd */ |
{ NULL, posts_wline }, /* Op */ |
{ NULL, posts_nm }, /* Nm */ |
{ NULL, NULL }, /* Ot */ |
{ NULL, posts_wline }, /* Op */ |
{ NULL, NULL }, /* Pa */ |
{ NULL, NULL }, /* Ot */ |
{ pres_rv, posts_notext }, /* Rv */ |
{ NULL, NULL }, /* Pa */ |
{ pres_st, posts_notext }, /* St */ |
{ pres_rv, posts_notext }, /* Rv */ |
{ NULL, posts_text }, /* Va */ |
{ pres_st, posts_notext }, /* St */ |
{ NULL, posts_text }, /* Vt */ |
{ NULL, posts_text }, /* Va */ |
{ NULL, posts_xr }, /* Xr */ |
{ NULL, posts_text }, /* Vt */ |
{ NULL, posts_text }, /* %A */ |
{ NULL, posts_xr }, /* Xr */ |
{ NULL, posts_text }, /* %B */ |
{ NULL, posts_text }, /* %A */ |
{ NULL, posts_text }, /* %D */ |
{ NULL, posts_text }, /* %B */ |
{ NULL, posts_text }, /* %I */ |
{ NULL, posts_text }, /* %D */ |
{ NULL, posts_text }, /* %J */ |
{ NULL, posts_text }, /* %I */ |
{ NULL, posts_text }, /* %N */ |
{ NULL, posts_text }, /* %J */ |
{ NULL, posts_text }, /* %O */ |
{ NULL, posts_text }, /* %N */ |
{ NULL, posts_text }, /* %P */ |
{ NULL, posts_text }, /* %O */ |
{ NULL, posts_text }, /* %R */ |
{ NULL, posts_text }, /* %P */ |
{ NULL, posts_text }, /* %T */ |
{ NULL, posts_text }, /* %R */ |
{ NULL, posts_text }, /* %V */ |
{ NULL, posts_text }, /* %T */ |
{ NULL, NULL }, /* Ac */ |
{ NULL, posts_text }, /* %V */ |
{ NULL, NULL }, /* Ao */ |
{ NULL, NULL }, /* Ac */ |
{ NULL, posts_wline }, /* Aq */ |
{ NULL, NULL }, /* Ao */ |
{ NULL, posts_at }, /* At */ |
{ NULL, posts_wline }, /* Aq */ |
{ NULL, NULL }, /* Bc */ |
{ NULL, posts_at }, /* At */ |
{ NULL, posts_bf }, /* Bf */ |
{ NULL, NULL }, /* Bc */ |
{ NULL, NULL }, /* Bo */ |
{ NULL, NULL }, /* Bf */ /* FIXME */ |
{ NULL, posts_wline }, /* Bq */ |
{ NULL, NULL }, /* Bo */ |
{ NULL, NULL }, /* Bsx */ |
{ NULL, posts_wline }, /* Bq */ |
{ NULL, NULL }, /* Bx */ |
{ NULL, NULL }, /* Bsx */ |
{ NULL, posts_bool }, /* Db */ |
{ NULL, NULL }, /* Bx */ |
{ NULL, NULL }, /* Dc */ |
{ NULL, posts_bool }, /* Db */ |
{ NULL, NULL }, /* Do */ |
{ NULL, NULL }, /* Dc */ |
{ NULL, posts_wline }, /* Dq */ |
{ NULL, NULL }, /* Do */ |
{ NULL, NULL }, /* Ec */ |
{ NULL, posts_wline }, /* Dq */ |
{ NULL, NULL }, /* Ef */ |
{ NULL, NULL }, /* Ec */ |
{ NULL, posts_text }, /* Em */ |
{ NULL, NULL }, /* Ef */ /* -symbolic, etc. */ |
{ NULL, NULL }, /* Eo */ |
{ NULL, posts_text }, /* Em */ |
{ NULL, NULL }, /* Fx */ |
{ NULL, NULL }, /* Eo */ |
{ NULL, posts_text }, /* Ms */ |
{ NULL, NULL }, /* Fx */ |
{ NULL, posts_notext }, /* No */ |
{ NULL, posts_text }, /* Ms */ |
{ NULL, posts_notext }, /* Ns */ |
{ NULL, posts_notext }, /* No */ |
{ NULL, NULL }, /* Nx */ |
{ NULL, posts_notext }, /* Ns */ |
{ NULL, NULL }, /* Ox */ |
{ NULL, NULL }, /* Nx */ |
{ NULL, NULL }, /* Pc */ |
{ NULL, NULL }, /* Ox */ |
{ NULL, posts_pf }, /* Pf */ |
{ NULL, NULL }, /* Pc */ |
{ NULL, NULL }, /* Po */ |
{ NULL, NULL }, /* Pf */ |
{ NULL, posts_wline }, /* Pq */ |
{ NULL, NULL }, /* Po */ |
{ NULL, NULL }, /* Qc */ |
{ NULL, posts_wline }, /* Pq */ |
{ NULL, posts_wline }, /* Ql */ |
{ NULL, NULL }, /* Qc */ |
{ NULL, NULL }, /* Qo */ |
{ NULL, posts_wline }, /* Ql */ |
{ NULL, posts_wline }, /* Qq */ |
{ NULL, NULL }, /* Qo */ |
{ NULL, NULL }, /* Re */ |
{ NULL, posts_wline }, /* Qq */ |
{ NULL, posts_rs }, /* Rs */ |
{ NULL, NULL }, /* Re */ |
{ NULL, NULL }, /* Sc */ |
{ NULL, NULL }, /* Rs */ |
{ NULL, NULL }, /* So */ |
{ NULL, NULL }, /* Sc */ |
{ NULL, posts_wline }, /* Sq */ |
{ NULL, NULL }, /* So */ |
{ NULL, posts_bool }, /* Sm */ |
{ NULL, posts_wline }, /* Sq */ |
{ NULL, posts_text }, /* Sx */ |
{ NULL, posts_bool }, /* Sm */ |
{ NULL, posts_text }, /* Sy */ |
{ NULL, posts_text }, /* Sx */ |
{ NULL, posts_text }, /* Tn */ |
{ NULL, posts_text }, /* Sy */ |
{ NULL, NULL }, /* Ux */ |
{ NULL, posts_text }, /* Tn */ |
{ NULL, NULL }, /* Xc */ |
{ NULL, NULL }, /* Ux */ |
{ NULL, NULL }, /* Xo */ |
{ NULL, NULL }, /* Xc */ |
{ NULL, posts_fo }, /* Fo */ |
{ NULL, NULL }, /* Xo */ |
{ NULL, NULL }, /* Fc */ |
{ NULL, NULL }, /* Fo */ |
{ NULL, NULL }, /* Oo */ |
{ NULL, NULL }, /* Fc */ |
{ NULL, NULL }, /* Oc */ |
{ NULL, NULL }, /* Oo */ |
{ NULL, posts_bk }, /* Bk */ |
{ NULL, NULL }, /* Oc */ |
{ NULL, NULL }, /* Ek */ |
{ NULL, NULL }, /* Bk */ |
{ NULL, posts_notext }, /* Bt */ |
{ NULL, NULL }, /* Ek */ |
{ NULL, NULL }, /* Hf */ |
{ NULL, posts_notext }, /* Bt */ |
{ NULL, NULL }, /* Fr */ |
{ NULL, NULL }, /* Hf */ |
{ NULL, posts_notext }, /* Ud */ |
{ NULL, NULL }, /* Fr */ |
|
{ NULL, posts_notext }, /* Ud */ |
|
}; |
}; |
|
|
|
|
static int |
static inline int |
post_check_children_count(struct mdoc *mdoc) |
warn_count(struct mdoc *m, const char *k, |
|
int want, const char *v, int has) |
{ |
{ |
struct mdoc_node *n; |
|
|
return(mdoc_warn(m, WARN_SYNTAX, "suggests %s %d %s " |
|
"(has %d)", v, want, k, has)); |
|
} |
|
|
|
|
|
static inline int |
|
err_count(struct mdoc *m, const char *k, |
|
int want, const char *v, int has) |
|
{ |
|
|
|
return(mdoc_err(m, "requires %s %d %s (has %d)", |
|
v, want, k, has)); |
|
} |
|
|
|
|
|
static inline int |
|
count_child(struct mdoc *mdoc) |
|
{ |
int i; |
int i; |
|
struct mdoc_node *n; |
|
|
for (i = 0, n = mdoc->last->child; n; n = n->next, i++) |
for (i = 0, n = mdoc->last->child; n; n = n->next, i++) |
/* Do nothing */ ; |
/* Do nothing */ ; |
Line 258 post_check_children_count(struct mdoc *mdoc) |
|
Line 297 post_check_children_count(struct mdoc *mdoc) |
|
|
|
|
|
static int |
static int |
post_check_children_wgt(struct mdoc *mdoc, int sz) |
warn_child_gt(struct mdoc *mdoc, const char *p, int sz) |
{ |
{ |
int i; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) > sz) |
if ((i = count_child(mdoc)) > sz) |
return(1); |
return(1); |
return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more " |
return(warn_count(mdoc, ">", sz, p, i)); |
"than %d parameters (has %d)", sz, i)); |
|
} |
} |
|
|
|
|
static int |
static int |
post_check_children_gt(struct mdoc *mdoc, int sz) |
err_child_gt(struct mdoc *mdoc, const char *p, int sz) |
{ |
{ |
int i; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) > sz) |
if ((i = count_child(mdoc)) > sz) |
return(1); |
return(1); |
return(mdoc_err(mdoc, "macro requires more than %d " |
return(err_count(mdoc, ">", sz, p, i)); |
"parameters (has %d)", sz, i)); |
|
} |
} |
|
|
|
|
static int |
static int |
post_check_children_weq(struct mdoc *mdoc, int sz) |
warn_child_eq(struct mdoc *mdoc, const char *p, int sz) |
{ |
{ |
int i; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) == sz) |
if ((i = count_child(mdoc)) == sz) |
return(1); |
return(1); |
return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d " |
return(warn_count(mdoc, "==", sz, p, i)); |
"parameters (has %d)", sz, i)); |
|
} |
} |
|
|
|
|
static int |
static int |
post_check_children_eq(struct mdoc *mdoc, int sz) |
err_child_eq(struct mdoc *mdoc, const char *p, int sz) |
{ |
{ |
int i; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) == sz) |
if ((i = count_child(mdoc)) == sz) |
return(1); |
return(1); |
return(mdoc_err(mdoc, "macro requires %d parameters " |
return(err_count(mdoc, "==", sz, p, i)); |
"(have %d)", sz, i)); |
|
} |
} |
|
|
|
|
static int |
static int |
post_check_children_lt(struct mdoc *mdoc, int sz) |
err_child_lt(struct mdoc *mdoc, const char *p, int sz) |
{ |
{ |
int i; |
int i; |
|
|
if ((i = post_check_children_count(mdoc)) < sz) |
if ((i = count_child(mdoc)) < sz) |
return(1); |
return(1); |
return(mdoc_err(mdoc, "macro requires less than %d " |
return(err_count(mdoc, "<", sz, p, i)); |
"parameters (have %d)", sz, i)); |
|
} |
} |
|
|
|
|
static int |
static int |
pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) |
check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) |
{ |
{ |
|
|
if (1 == node->data.elem.argc && |
if (MDOC_Std == node->data.elem.argv[0].arg && |
MDOC_Std == node->data.elem.argv[0].arg) |
1 == node->data.elem.argc) |
return(1); |
return(1); |
|
|
return(mdoc_nwarn(mdoc, node, WARN_COMPAT, |
return(mdoc_nwarn(mdoc, node, WARN_COMPAT, |
"macro suggests single `%s' argument", |
"macro suggests single `%s' argument", |
mdoc_argnames[MDOC_Std])); |
mdoc_argnames[MDOC_Std])); |
Line 331 pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node * |
|
Line 366 pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node * |
|
|
|
|
|
static int |
static int |
pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, |
check_msec(struct mdoc *mdoc, struct mdoc_node *node, |
int sz, enum mdoc_msec *msecs) |
int sz, enum mdoc_msec *msecs) |
{ |
{ |
int i; |
int i; |
Line 345 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n |
|
Line 380 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n |
|
|
|
|
|
static int |
static int |
pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, |
check_parent(struct mdoc *mdoc, struct mdoc_node *n, |
int tok, enum mdoc_type type) |
int tok, enum mdoc_type t) |
{ |
{ |
|
|
if (type != node->parent->type) |
assert(n->parent); |
return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", |
if ((MDOC_ROOT == t || tok == n->parent->tok) && |
mdoc_type2a(node->parent->type), |
(t == n->parent->type)) |
mdoc_type2a(type))); |
|
if (MDOC_ROOT != type && tok != node->parent->tok) |
|
return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", |
|
mdoc_macronames[node->parent->tok], |
|
mdoc_macronames[tok])); |
|
return(1); |
|
} |
|
|
|
|
|
static int |
|
berr_eq0(struct mdoc *mdoc) |
|
{ |
|
|
|
if (MDOC_BODY != mdoc->last->type) |
|
return(1); |
return(1); |
return(post_check_children_eq(mdoc, 0)); |
|
|
return(mdoc_nerr(mdoc, n, "require parent %s (have %s)", |
|
MDOC_ROOT == t ? "<root>" : |
|
mdoc_macronames[tok], |
|
MDOC_ROOT == n->parent->type ? "<root>" : |
|
mdoc_macronames[n->parent->type])); |
} |
} |
|
|
|
|
Line 377 bwarn_ge1(struct mdoc *mdoc) |
|
Line 403 bwarn_ge1(struct mdoc *mdoc) |
|
|
|
if (MDOC_BODY != mdoc->last->type) |
if (MDOC_BODY != mdoc->last->type) |
return(1); |
return(1); |
return(post_check_children_wgt(mdoc, 0)); |
return(warn_child_gt(mdoc, "multi-line parameters", 0)); |
} |
} |
|
|
|
|
Line 386 ewarn_eq1(struct mdoc *mdoc) |
|
Line 412 ewarn_eq1(struct mdoc *mdoc) |
|
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_weq(mdoc, 1)); |
return(warn_child_eq(mdoc, "line parameters", 1)); |
} |
} |
|
|
|
|
Line 395 ewarn_eq0(struct mdoc *mdoc) |
|
Line 421 ewarn_eq0(struct mdoc *mdoc) |
|
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_weq(mdoc, 0)); |
return(warn_child_eq(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
Line 404 ewarn_ge1(struct mdoc *mdoc) |
|
Line 430 ewarn_ge1(struct mdoc *mdoc) |
|
{ |
{ |
|
|
assert(MDOC_ELEM == mdoc->last->type); |
assert(MDOC_ELEM == mdoc->last->type); |
return(post_check_children_wgt(mdoc, 0)); |
return(warn_child_gt(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
Line 413 eerr_eq1(struct mdoc *mdoc) |
|
Line 439 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(err_child_eq(mdoc, "line parameters", 1)); |
} |
} |
|
|
|
|
Line 422 eerr_le2(struct mdoc *mdoc) |
|
Line 448 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(err_child_lt(mdoc, "line parameters", 3)); |
} |
} |
|
|
|
|
Line 431 eerr_le1(struct mdoc *mdoc) |
|
Line 457 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(err_child_lt(mdoc, "line parameters", 2)); |
} |
} |
|
|
|
|
Line 440 eerr_eq0(struct mdoc *mdoc) |
|
Line 466 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(err_child_eq(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
Line 449 eerr_ge1(struct mdoc *mdoc) |
|
Line 475 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(err_child_gt(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
Line 459 herr_eq0(struct mdoc *mdoc) |
|
Line 485 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(err_child_eq(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
static int |
static int |
hwarn_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); |
return(post_check_children_wgt(mdoc, 0)); |
return(err_child_lt(mdoc, "line parameters", 2)); |
} |
} |
|
|
|
|
Line 479 herr_ge1(struct mdoc *mdoc) |
|
Line 504 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(err_child_gt(mdoc, "line parameters", 0)); |
} |
} |
|
|
|
|
Line 613 pre_ss(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 638 pre_ss(struct mdoc *mdoc, struct mdoc_node *node) |
|
|
|
if (MDOC_BLOCK != node->type) |
if (MDOC_BLOCK != node->type) |
return(1); |
return(1); |
return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); |
return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); |
} |
} |
|
|
|
|
Line 623 pre_sh(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 648 pre_sh(struct mdoc *mdoc, struct mdoc_node *node) |
|
|
|
if (MDOC_BLOCK != node->type) |
if (MDOC_BLOCK != node->type) |
return(1); |
return(1); |
return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); |
return(check_parent(mdoc, node, -1, MDOC_ROOT)); |
} |
} |
|
|
|
|
Line 661 pre_rv(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 686 pre_rv(struct mdoc *mdoc, struct mdoc_node *node) |
|
|
|
msecs[0] = MSEC_2; |
msecs[0] = MSEC_2; |
msecs[1] = MSEC_3; |
msecs[1] = MSEC_3; |
if ( ! pre_check_msecs(mdoc, node, 2, msecs)) |
if ( ! check_msec(mdoc, node, 2, msecs)) |
return(0); |
return(0); |
return(pre_check_stdarg(mdoc, node)); |
return(check_stdarg(mdoc, node)); |
} |
} |
|
|
|
|
Line 678 pre_ex(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 703 pre_ex(struct mdoc *mdoc, struct mdoc_node *node) |
|
msecs[0] = MSEC_1; |
msecs[0] = MSEC_1; |
msecs[1] = MSEC_6; |
msecs[1] = MSEC_6; |
msecs[2] = MSEC_8; |
msecs[2] = MSEC_8; |
if ( ! pre_check_msecs(mdoc, node, 3, msecs)) |
if ( ! check_msec(mdoc, node, 3, msecs)) |
return(0); |
return(0); |
return(pre_check_stdarg(mdoc, node)); |
return(check_stdarg(mdoc, node)); |
} |
} |
|
|
|
|
Line 690 pre_er(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 715 pre_er(struct mdoc *mdoc, struct mdoc_node *node) |
|
enum mdoc_msec msecs[1]; |
enum mdoc_msec msecs[1]; |
|
|
msecs[0] = MSEC_2; |
msecs[0] = MSEC_2; |
return(pre_check_msecs(mdoc, node, 1, msecs)); |
return(check_msec(mdoc, node, 1, msecs)); |
} |
} |
|
|
|
|
Line 700 pre_cd(struct mdoc *mdoc, struct mdoc_node *node) |
|
Line 725 pre_cd(struct mdoc *mdoc, struct mdoc_node *node) |
|
enum mdoc_msec msecs[1]; |
enum mdoc_msec msecs[1]; |
|
|
msecs[0] = MSEC_4; |
msecs[0] = MSEC_4; |
return(pre_check_msecs(mdoc, node, 1, msecs)); |
return(check_msec(mdoc, node, 1, msecs)); |
} |
} |
|
|
|
|
|
|
pre_it(struct mdoc *mdoc, struct mdoc_node *node) |
pre_it(struct mdoc *mdoc, struct mdoc_node *node) |
{ |
{ |
|
|
|
/* TODO: -width attribute must be specified for -tag. */ |
|
/* TODO: children too big for -width? */ |
|
|
if (MDOC_BLOCK != node->type) |
if (MDOC_BLOCK != node->type) |
return(1); |
return(1); |
return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); |
return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); |
} |
} |
|
|
|
|
|
|
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 767 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node |
|
Line 795 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) |
post_nm(struct mdoc *mdoc) |
{ |
{ |
|
|
Line 870 post_it(struct mdoc *mdoc) |
|
Line 932 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 916 post_it(struct mdoc *mdoc) |
|
Line 979 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 940 post_it(struct mdoc *mdoc) |
|
Line 1006 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); |
|
|
|
assert(-1 != sv); |
|
if (MDOC_Column != sv) |
|
return(1); |
return(1); |
|
|
/* Make sure the number of columns is sane. */ |
/* Make sure the number of columns is sane. */ |
Line 976 post_it(struct mdoc *mdoc) |
|
Line 1045 post_it(struct mdoc *mdoc) |
|
#undef TYPE_NONE |
#undef TYPE_NONE |
#undef TYPE_BODY |
#undef TYPE_BODY |
#undef TYPE_HEAD |
#undef TYPE_HEAD |
|
#undef TYPE_OHEAD |
} |
} |
|
|
|
|
|
|
post_root(struct mdoc *mdoc) |
post_root(struct mdoc *mdoc) |
{ |
{ |
|
|
if (NULL == mdoc->last->child) |
if (NULL == mdoc->first->child) |
return(mdoc_err(mdoc, "document has no data")); |
return(mdoc_err(mdoc, "document has no data")); |
if (NULL == mdoc->meta.title) |
if (SEC_PROLOGUE == mdoc->lastnamed) |
return(mdoc_err(mdoc, "document has incomplete prologue")); |
return(mdoc_err(mdoc, "document has incomplete prologue")); |
if (NULL == mdoc->meta.os) |
if (MDOC_BLOCK != mdoc->first->child->type) |
return(mdoc_err(mdoc, "document has incomplete prologue")); |
return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); |
if (0 == mdoc->meta.date) |
if (MDOC_Sh != mdoc->first->child->tok) |
return(mdoc_err(mdoc, "document has incomplete prologue")); |
return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); |
return(1); |
return(1); |
} |
} |
|
|
|
|
/* Warn if conventional sections are out of order. */ |
|
static int |
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); |
|
assert(MDOC_BODY == mdoc->last->type); |
|
if (SEC_NAME != mdoc->lastnamed) |
|
return(1); |
|
|
|
/* |
|
* Warn if the NAME section doesn't contain the `Nm' and `Nd' |
|
* macros (can have multiple `Nm' and one `Nd'). Note that the |
|
* children of the BODY declaration can also be "text". |
|
*/ |
|
|
|
if (NULL == (n = mdoc->last->child)) |
|
return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME " |
|
"should contain %s and %s", |
|
mdoc_macronames[MDOC_Nm], |
|
mdoc_macronames[MDOC_Nd])); |
|
|
|
for ( ; n && n->next; n = n->next) { |
|
if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) |
|
continue; |
|
if (MDOC_TEXT == n->type) |
|
continue; |
|
if ( ! (mdoc_nwarn(mdoc, n, WARN_COMPAT, "section " |
|
"NAME should contain %s as " |
|
"initial body child", |
|
mdoc_macronames[MDOC_Nm]))) |
|
return(0); |
|
} |
|
|
|
if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) |
|
return(1); |
|
|
|
return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME should " |
|
"contain %s as the last child", |
|
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); |
} |
} |
|
|
|
|