version 1.42, 2009/01/19 23:11:43 |
version 1.48, 2009/02/21 14:56:58 |
|
|
|
|
#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: make sure prologue is complete. */ |
|
/* FIXME: valid character-escape checks. */ |
/* FIXME: valid character-escape checks. */ |
/* FIXME: make sure required sections are included (NAME, ...). */ |
/* FIXME: make sure required sections are included (NAME, ...). */ |
|
|
Line 72 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
Line 79 static int pre_prologue(struct mdoc *, struct mdoc_nod |
|
|
|
static int herr_ge1(struct mdoc *); |
static int herr_ge1(struct mdoc *); |
static int herr_le1(struct mdoc *); |
static int herr_le1(struct mdoc *); |
static int hwarn_ge1(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 82 static int eerr_ge1(struct mdoc *); |
|
Line 88 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 119 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL |
|
Line 126 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_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_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. */ |
|
|
Line 141 const struct valids mdoc_valids[MDOC_MAX] = { |
|
Line 150 const struct valids mdoc_valids[MDOC_MAX] = { |
|
{ 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 224 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 235 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 365 pre_check_parent(struct mdoc *mdoc, struct mdoc_node * |
|
Line 373 pre_check_parent(struct mdoc *mdoc, struct mdoc_node * |
|
|
|
|
|
static int |
static int |
berr_eq0(struct mdoc *mdoc) |
|
{ |
|
|
|
if (MDOC_BODY != mdoc->last->type) |
|
return(1); |
|
return(post_check_children_eq(mdoc, "body children", 0)); |
|
} |
|
|
|
|
|
static int |
|
bwarn_ge1(struct mdoc *mdoc) |
bwarn_ge1(struct mdoc *mdoc) |
{ |
{ |
|
|
Line 467 herr_eq0(struct mdoc *mdoc) |
|
Line 465 herr_eq0(struct mdoc *mdoc) |
|
|
|
|
|
static int |
static int |
hwarn_ge1(struct mdoc *mdoc) |
|
{ |
|
|
|
if (MDOC_HEAD != mdoc->last->type) |
|
return(1); |
|
return(post_check_children_wgt(mdoc, "parameters", 0)); |
|
} |
|
|
|
|
|
static int |
|
herr_le1(struct mdoc *mdoc) |
herr_le1(struct mdoc *mdoc) |
{ |
{ |
if (MDOC_HEAD != mdoc->last->type) |
if (MDOC_HEAD != mdoc->last->type) |
|
|
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. */ |
|
|
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(pre_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 916 post_it(struct mdoc *mdoc) |
|
Line 906 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 962 post_it(struct mdoc *mdoc) |
|
Line 953 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 986 post_it(struct mdoc *mdoc) |
|
Line 980 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 1022 post_it(struct mdoc *mdoc) |
|
Line 1019 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); |
|
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); |
} |
} |
|
|
|
|