mandoc/validate.c - diff

Return to validate.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/validate.c between version 1.62 and 1.81

version 1.62, 2009/02/27 09:14:02

version 1.81, 2009/03/12 06:32:17

Line 16

* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

* PERFORMANCE OF THIS SOFTWARE.

#include <sys/types.h>

#include <assert.h>

#include <ctype.h>

#include <stdarg.h>

#include <stdlib.h>

#include "private.h"

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

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

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

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

Line 33

Line 39

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

#define POST_ARGS struct mdoc *mdoc

enum merr {

ENODATA,

ENOPROLOGUE,

ELINE,

EATT,

ENAME,

ELISTTYPE,

EDISPTYPE,

EMULTIDISP,

EMULTILIST,

EARGREP,

EBOOL,

ENESTDISP

};

enum mwarn {

WWRONGMSEC,

WSECOOO,

WSECREP,

WBADSTAND,

WNAMESECINC,

WNOMULTILINE,

WMULTILINE,

WLINE,

WNOLINE,

WPROLOOO,

WPROLREP,

WARGVAL,

WBADSEC,

WBADMSEC

};

typedef int (*v_pre)(PRE_ARGS);

typedef int (*v_post)(POST_ARGS);

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

/* FIXME: ignoring Pp. */

/* FIXME: math symbols. */

struct valids {

v_pre *pre;

v_post *post;

Line 47 struct valids {

Line 81 struct valids {

/* Utility checks. */

static int nwarn(struct mdoc *,

const struct mdoc_node *, enum mwarn);

static int nerr(struct mdoc *,

const struct mdoc_node *, enum merr);

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

static int check_msec(PRE_ARGS, int, enum mdoc_msec *);

static int check_msec(PRE_ARGS, ...);

static int check_sec(PRE_ARGS, ...);

static int check_stdarg(PRE_ARGS);

static int check_text(struct mdoc *,

size_t, size_t, const char *);

int, int, const char *);

static int check_argv(struct mdoc *,

const struct mdoc_node *,

const struct mdoc_argv *);

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);

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

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

static int warn_child_eq(struct mdoc *, const char *, 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);

static int pre_an(PRE_ARGS);

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

static int pre_display(PRE_ARGS);

static int pre_sh(PRE_ARGS);

static int pre_ss(PRE_ARGS);

static int pre_bd(PRE_ARGS);

static int pre_bl(PRE_ARGS);

static int pre_it(PRE_ARGS);

static int pre_cd(PRE_ARGS);

static int pre_dd(PRE_ARGS);

static int pre_display(PRE_ARGS);

static int pre_dt(PRE_ARGS);

static int pre_er(PRE_ARGS);

static int pre_ex(PRE_ARGS);

static int pre_rv(PRE_ARGS);

static int pre_fd(PRE_ARGS);

static int pre_an(PRE_ARGS);

static int pre_it(PRE_ARGS);

static int pre_st(PRE_ARGS);

static int pre_lb(PRE_ARGS);

static int pre_os(PRE_ARGS);

static int pre_prologue(PRE_ARGS);

static int pre_rv(PRE_ARGS);

static int pre_prologue(PRE_ARGS);

static int pre_sh(PRE_ARGS);

static int pre_ss(PRE_ARGS);

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

static int herr_ge1(POST_ARGS);

static int hwarn_le1(POST_ARGS);

static int herr_eq0(POST_ARGS);

static int eerr_eq0(POST_ARGS);

static int eerr_le1(POST_ARGS);

static int eerr_le2(POST_ARGS);

static int eerr_eq1(POST_ARGS);

static int eerr_ge1(POST_ARGS);

Line 104 static int hwarn_eq1(POST_ARGS);

Line 138 static int hwarn_eq1(POST_ARGS);

static int ewarn_ge1(POST_ARGS);

static int ebool(POST_ARGS);

static int post_sh(POST_ARGS);

static int post_sh_body(POST_ARGS);

static int post_sh_head(POST_ARGS);

static int post_fd(POST_ARGS);

static int post_bl(POST_ARGS);

static int post_it(POST_ARGS);

static int post_ex(POST_ARGS);

static int post_an(POST_ARGS);

static int post_at(POST_ARGS);

static int post_xr(POST_ARGS);

static int post_nm(POST_ARGS);

static int post_bf(POST_ARGS);

static int post_bl(POST_ARGS);

static int post_ex(POST_ARGS);

static int post_it(POST_ARGS);

static int post_nm(POST_ARGS);

static int post_root(POST_ARGS);

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);

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

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

static v_pre pres_prologue[] = { pre_prologue, NULL };

static v_pre pres_d1[] = { pre_display, NULL };

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

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

static v_pre pres_it[] = { pre_it, NULL };

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

static v_pre pres_sh[] = { pre_sh, NULL };

static v_pre pres_cd[] = { pre_cd, NULL };

static v_pre pres_dd[] = { pre_prologue, pre_dd, NULL };

static v_pre pres_d1[] = { pre_display, NULL };

static v_pre pres_dt[] = { pre_prologue, pre_dt, NULL };

static v_pre pres_er[] = { pre_er, NULL };

static v_pre pres_ex[] = { pre_ex, NULL };

static v_pre pres_fd[] = { pre_fd, NULL };

static v_pre pres_it[] = { pre_it, NULL };

static v_pre pres_lb[] = { pre_lb, NULL };

static v_pre pres_os[] = { pre_prologue, pre_os, NULL };

static v_pre pres_rv[] = { pre_rv, NULL };

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

static v_pre pres_sh[] = { pre_sh, NULL };

static v_pre pres_st[] = { pre_st, NULL };

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

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

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

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

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

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

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

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

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

static v_post posts_pf[] = { eerr_eq1, NULL };

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

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

static v_post posts_st[] = { eerr_eq1, post_st, NULL };

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

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

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

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

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

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

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

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

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

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

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

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

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

static v_post posts_fd[] = { ewarn_ge1, post_fd, NULL };

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

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

const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* \" */

{ pres_prologue, posts_text }, /* Dd */

{ pres_dd, posts_text }, /* Dd */

{ pres_prologue, NULL }, /* Dt */

{ pres_dt, NULL }, /* Dt */

{ pres_prologue, NULL }, /* Os */

{ pres_os, NULL }, /* Os */

{ pres_sh, posts_sh }, /* Sh */

{ pres_ss, posts_ss }, /* Ss */

{ NULL, posts_pp }, /* Pp */

Line 187 const struct valids mdoc_valids[MDOC_MAX] = {

Line 220 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, posts_text }, /* Ev */

{ pres_ex, posts_ex }, /* Ex */

{ NULL, posts_text }, /* Fa */

{ NULL, posts_fd }, /* Fd */

{ pres_fd, posts_fd }, /* Fd */

{ NULL, NULL }, /* Fl */

{ NULL, posts_text }, /* Fn */

{ NULL, posts_wtext }, /* Ft */

Line 200 const struct valids mdoc_valids[MDOC_MAX] = {

Line 233 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Ot */

{ NULL, NULL }, /* Pa */

{ pres_rv, posts_notext }, /* Rv */

{ pres_st, posts_notext }, /* St */

{ NULL, posts_st }, /* St */

{ NULL, posts_text }, /* Va */

{ NULL, posts_text }, /* Vt */

{ NULL, posts_xr }, /* Xr */

Line 269 const struct valids mdoc_valids[MDOC_MAX] = {

Line 302 const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Hf */

{ NULL, NULL }, /* Fr */

{ NULL, posts_notext }, /* Ud */

{ pres_lb, posts_lb }, /* Lb */

{ NULL, NULL }, /* Lb */

{ NULL, posts_pp }, /* Pp */

{ NULL, posts_lk }, /* Lk */

{ NULL, posts_mt }, /* Mt */

{ NULL, posts_wline }, /* Brq */

{ NULL, NULL }, /* Bro */

{ NULL, NULL }, /* Brc */

};

Line 277 mdoc_valid_pre(struct mdoc *mdoc,

Line 318 mdoc_valid_pre(struct mdoc *mdoc,

const struct mdoc_node *node)

{

v_pre *p;

struct mdoc_arg *argv;

int line, pos;

size_t argc, i, j, line, pos;

const char *tp;

if (MDOC_TEXT == node->type) {

tp = node->data.text.string;

tp = node->string;

line = node->line;

pos = node->pos;

return(check_text(mdoc, line, pos, tp));

}

if (MDOC_BLOCK == node->type || MDOC_ELEM == node->type) {

if ( ! check_args(mdoc, node))

argv = MDOC_BLOCK == node->type ?

return(0);

node->data.block.argv :

node->data.elem.argv;

argc = MDOC_BLOCK == node->type ?

node->data.block.argc :

node->data.elem.argc;

for (i = 0; i < argc; i++) {

if (0 == argv[i].sz)

continue;

for (j = 0; j < argv[i].sz; j++) {

tp = argv[i].value[j];

line = argv[i].line;

pos = argv[i].pos;

if ( ! check_text(mdoc, line, pos, tp))

return(0);

}

if (NULL == mdoc_valids[node->tok].pre)

return(1);

for (p = mdoc_valids[node->tok].pre; *p; p++)

Line 350 mdoc_valid_post(struct mdoc *mdoc)

Line 371 mdoc_valid_post(struct mdoc *mdoc)

}

#define merr(m, t) nerr((m), (m)->last, (t))

static int

nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type)

{

char *p;

p = NULL;

switch (type) {

case (ENESTDISP):

p = "displays may not be nested";

break;

case (EBOOL):

p = "expected boolean value";

break;

case (EARGREP):

p = "argument repeated";

break;

case (EMULTIDISP):

p = "multiple display types specified";

break;

case (EMULTILIST):

p = "multiple list types specified";

break;

case (ELISTTYPE):

p = "missing list type";

break;

case (EDISPTYPE):

p = "missing display type";

break;

case (ELINE):

p = "expected line arguments";

break;

case (ENOPROLOGUE):

p = "document has no prologue";

break;

case (ENODATA):

p = "document has no data";

break;

case (EATT):

p = "expected valid AT&T symbol";

break;

case (ENAME):

p = "default name not yet set";

break;

}

assert(p);

return(mdoc_nerr(m, n, p));

}

#define mwarn(m, t) nwarn((m), (m)->last, (t))

static int

nwarn(struct mdoc *m, const struct mdoc_node *n, enum mwarn type)

{

char *p;

enum mdoc_warn c;

c = WARN_SYNTAX;

p = NULL;

switch (type) {

case (WBADMSEC):

p = "inappropriate manual section";

c = WARN_COMPAT;

break;

case (WBADSEC):

p = "inappropriate document section";

c = WARN_COMPAT;

break;

case (WARGVAL):

p = "argument value suggested";

c = WARN_COMPAT;

break;

case (WPROLREP):

p = "prologue macros repeated";

c = WARN_COMPAT;

break;

case (WPROLOOO):

p = "prologue macros out-of-order";

c = WARN_COMPAT;

break;

case (WNOLINE):

p = "suggested no line arguments";

break;

case (WLINE):

p = "suggested line arguments";

break;

case (WMULTILINE):

p = "suggested multi-line arguments";

break;

case (WNOMULTILINE):

p = "suggested no multi-line arguments";

break;

case (WWRONGMSEC):

p = "document section in wrong manual section";

c = WARN_COMPAT;

break;

case (WSECOOO):

p = "document section out of conventional order";

break;

case (WSECREP):

p = "document section repeated";

break;

case (WBADSTAND):

p = "unknown standard";

break;

case (WNAMESECINC):

p = "NAME section contents incomplete/badly-ordered";

break;

}

assert(p);

return(mdoc_nwarn(m, n, c, p));

}

static inline int

warn_count(struct mdoc *m, const char *k,

int want, const char *v, int has)

{

return(mdoc_warn(m, WARN_SYNTAX,

"suggests %s %s %d (has %d)",

"suggests %s %s %d (has %d)", v, k, want, has));

v, k, want, has));

}

Line 367 err_count(struct mdoc *m, const char *k,

Line 504 err_count(struct mdoc *m, const char *k,

int want, const char *v, int has)

{

return(mdoc_err(m, "requires %s %s %d (has %d)",

return(mdoc_err(m,

v, k, want, has));

"requires %s %s %d (has %d)", v, k, want, has));

}

Line 407 b##lvl##_##name(POST_ARGS) \

Line 544 b##lvl##_##name(POST_ARGS) \

{ \

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

return(1); \

return(func(mdoc, "multiline parameters", (num))); \

return(func(mdoc, "multi-line arguments", (num))); \

}

#define CHECK_ELEM_DEFN(name, lvl, func, num) \

Line 415 static int \

Line 552 static int \

e##lvl##_##name(POST_ARGS) \

{ \

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

return(func(mdoc, "line parameters", (num))); \

return(func(mdoc, "line arguments", (num))); \

}

#define CHECK_HEAD_DEFN(name, lvl, func, num) \

Line 424 h##lvl##_##name(POST_ARGS) \

Line 561 h##lvl##_##name(POST_ARGS) \

{ \

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

return(1); \

return(func(mdoc, "line parameters", (num))); \

return(func(mdoc, "line arguments", (num))); \

}

Line 440 CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_

Line 577 CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_

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

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

CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */

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

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

CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */

CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */

Line 453 static int

Line 589 static int

check_stdarg(PRE_ARGS)

{

if (MDOC_Std == n->data.elem.argv[0].arg &&

if (n->args && 1 == n->args->argc)

1 == n->data.elem.argc)

if (MDOC_Std == n->args->argv[0].arg)

return(1);

return(nwarn(mdoc, n, WARGVAL));

}

static int

check_sec(PRE_ARGS, ...)

{

enum mdoc_sec sec;

va_list ap;

va_start(ap, n);

for (;;) {

/* LINTED */

sec = (enum mdoc_sec)va_arg(ap, int);

if (SEC_CUSTOM == sec)

break;

if (sec != mdoc->lastsec)

continue;

va_end(ap);

return(1);

}

return(mdoc_nwarn(mdoc, n, WARN_COMPAT,

va_end(ap);

"one argument suggested"));

return(nwarn(mdoc, n, WBADSEC));

}

static int

check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs)

check_msec(PRE_ARGS, ...)

{

va_list ap;

int msec;

va_start(ap, n);

for (;;) {

/* LINTED */

if (0 == (msec = va_arg(ap, int)))

break;

if (msec != mdoc->meta.msec)

continue;

va_end(ap);

return(1);

}

va_end(ap);

return(nwarn(mdoc, n, WBADMSEC));

}

static int

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

{

int i;

for (i = 0; i < sz; i++)

if (NULL == n->args)

if (msecs[i] == mdoc->meta.msec)

return(1);

assert(n->args->argc);

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

if ( ! check_argv(m, n, &n->args->argv[i]))

return(0);

return(1);

}

static int

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

const struct mdoc_argv *v)

{

int i;

for (i = 0; i < (int)v->sz; i++)

if ( ! check_text(m, v->line, v->pos, v->value[i]))

return(0);

if (MDOC_Std == v->arg && MDOC_Ex == n->tok) {

/* `Nm' name must be set. */

if (v->sz || m->meta.name)

return(1);

return(mdoc_nwarn(mdoc, n, WARN_COMPAT,

return(nerr(m, n, ENAME));

"invalid manual section"));

}

return(1);

}

static int

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

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

{

size_t c;

/* XXX - indicate deprecated escapes \*(xx and \*x. */

for ( ; *p; p++) {

if ( ! isprint((int)*p) && '\t' != *p)

if ( ! isprint((u_char)*p) && '\t' != *p)

return(mdoc_perr(mdoc, line, pos,

"invalid characters"));

"invalid non-printing character"));

if ('\\' != *p)

continue;

if ((c = mdoc_isescape(p))) {

p += (c - 1);

p += (int)c - 1;

continue;

}

return(mdoc_perr(mdoc, line, pos,

if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))

return(mdoc_perr(mdoc, line, pos,

"invalid escape sequence"));

if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX,

"invalid escape sequence"))

return(0);

}

return(1);

Line 535 pre_display(PRE_ARGS)

Line 744 pre_display(PRE_ARGS)

if (NULL == node)

return(1);

return(mdoc_nerr(mdoc, n, "displays may not be nested"));

return(nerr(mdoc, n, ENESTDISP));

}

static int

pre_bl(PRE_ARGS)

{

int type, i, width, offset;

int i, type, width, offset;

struct mdoc_arg *argv;

size_t argc;

if (MDOC_BLOCK != n->type)

return(1);

if (NULL == n->args)

return(nerr(mdoc, n, ELISTTYPE));

argc = n->data.block.argc;

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

type = offset = width = -1;

/* LINTED */

for (i = 0; i < (int)argc; i++) {

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

argv = &n->data.block.argv[i];

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

switch (argv->arg) {

case (MDOC_Bullet):

/* FALLTHROUGH */

case (MDOC_Dash):

Line 582 pre_bl(PRE_ARGS)

Line 787 pre_bl(PRE_ARGS)

/* FALLTHROUGH */

case (MDOC_Column):

if (-1 == type) {

type = argv->arg;

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

break;

}

return(mdoc_perr(mdoc, argv->line, argv->pos,

return(nerr(mdoc, n, EMULTILIST));

"multiple types specified"));

case (MDOC_Width):

if (-1 == width) {

width = argv->arg;

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

break;

}

return(mdoc_perr(mdoc, argv->line, argv->pos,

return(nerr(mdoc, n, EARGREP));

"multiple -%s arguments",

mdoc_argnames[MDOC_Width]));

case (MDOC_Offset):

if (-1 == offset) {

offset = argv->arg;

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

break;

}

return(mdoc_perr(mdoc, argv->line, argv->pos,

return(nerr(mdoc, n, EARGREP));

"multiple -%s arguments",

mdoc_argnames[MDOC_Offset]));

default:

break;

}

if (-1 == type)

return(mdoc_err(mdoc, "no type specified"));

return(nerr(mdoc, n, ELISTTYPE));

switch (type) {

case (MDOC_Column):

Line 622 pre_bl(PRE_ARGS)

Line 821 pre_bl(PRE_ARGS)

if (-1 == width)

break;

return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,

"superfluous -%s argument",

"superfluous %s argument",

mdoc_argnames[MDOC_Width]));

case (MDOC_Tag):

if (-1 != width)

break;

return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,

return(mdoc_nerr(mdoc, n, "missing %s argument",

"suggest -%s argument",

mdoc_argnames[MDOC_Width]));

default:

break;

Line 641 pre_bl(PRE_ARGS)

Line 839 pre_bl(PRE_ARGS)

static int

pre_bd(PRE_ARGS)

{

int type, err, i;

int i, type, err;

struct mdoc_arg *argv;

size_t argc;

if (MDOC_BLOCK != n->type)

return(1);

if (NULL == n->args)

return(nerr(mdoc, n, EDISPTYPE));

argc = n->data.block.argc;

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

/* LINTED */

for (i = 0, err = type = 0; ! err && i < (int)argc; i++) {

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

argv = &n->data.block.argv[i];

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

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

switch (argv->arg) {

case (MDOC_Ragged):

/* FALLTHROUGH */

case (MDOC_Unfilled):

Line 668 pre_bd(PRE_ARGS)

Line 863 pre_bd(PRE_ARGS)

case (MDOC_File):

if (0 == type++)

break;

return(mdoc_perr(mdoc, argv->line, argv->pos,

return(nerr(mdoc, n, EMULTIDISP));

"multiple types specified"));

default:

break;

}

if (type)

return(1);

return(mdoc_err(mdoc, "no type specified"));

return(nerr(mdoc, n, EDISPTYPE));

}

Line 705 static int

Line 898 static int

pre_it(PRE_ARGS)

{

/* TODO: children too big for -width? */

if (MDOC_BLOCK != n->type)

return(1);

return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));

Line 714 pre_it(PRE_ARGS)

Line 905 pre_it(PRE_ARGS)

static int

pre_st(PRE_ARGS)

pre_an(PRE_ARGS)

{

if (1 == n->data.elem.argc)

if (NULL == n->args || 1 == n->args->argc)

return(1);

return(mdoc_nerr(mdoc, n, "one argument required"));

return(mdoc_nerr(mdoc, n, "only one argument allowed"));

}

static int

pre_an(PRE_ARGS)

pre_lb(PRE_ARGS)

{

if (1 >= n->data.elem.argc)

return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));

return(1);

return(mdoc_nerr(mdoc, n, "one argument allowed"));

}

static int

pre_rv(PRE_ARGS)

{

enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };

if ( ! check_msec(mdoc, n, 2, msecs))

if ( ! check_msec(mdoc, n, 2, 3, 0))

return(0);

return(check_stdarg(mdoc, n));

}

Line 747 pre_rv(PRE_ARGS)

Line 935 pre_rv(PRE_ARGS)

static int

pre_ex(PRE_ARGS)

{

enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };

if ( ! check_msec(mdoc, n, 3, msecs))

if ( ! check_msec(mdoc, n, 1, 6, 8, 0))

return(0);

return(check_stdarg(mdoc, n));

}

Line 758 pre_ex(PRE_ARGS)

Line 945 pre_ex(PRE_ARGS)

static int

pre_er(PRE_ARGS)

{

enum mdoc_msec msecs[] = { MSEC_2 };

return(check_msec(mdoc, n, 1, msecs));

return(check_msec(mdoc, n, 2, 0));

}

static int

pre_cd(PRE_ARGS)

{

enum mdoc_msec msecs[] = { MSEC_4 };

return(check_msec(mdoc, n, 1, msecs));

return(check_msec(mdoc, n, 4, 0));

}

Line 777 static int

Line 962 static int

pre_prologue(PRE_ARGS)

{

if (SEC_PROLOGUE != mdoc->lastnamed)

return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM));

return(mdoc_nerr(mdoc, n, "prologue only"));

}

/* Check for ordering. */

switch (n->tok) {

static int

case (MDOC_Os):

pre_dt(PRE_ARGS)

if (mdoc->meta.title && mdoc->meta.date)

{

break;

return(mdoc_nerr(mdoc, n, "prologue out-of-order"));

case (MDOC_Dt):

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

break;

return(mdoc_nerr(mdoc, n, "prologue out-of-order"));

case (MDOC_Dd):

if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)

break;

return(mdoc_nerr(mdoc, n, "prologue out-of-order"));

default:

abort();

/* NOTREACHED */

}

/* Check for repetition. */

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

if ( ! nwarn(mdoc, n, WPROLOOO))

return(0);

if (mdoc->meta.title)

if ( ! nwarn(mdoc, n, WPROLREP))

return(0);

return(1);

}

switch (n->tok) {

case (MDOC_Os):

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

return(1);

break;

case (MDOC_Dd):

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

return(1);

break;

case (MDOC_Dt):

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

return(1);

break;

default:

abort();

/* NOTREACHED */

}

return(mdoc_nerr(mdoc, n, "prologue repetition"));

static int

pre_os(PRE_ARGS)

{

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

if ( ! nwarn(mdoc, n, WPROLOOO))

return(0);

if (mdoc->meta.os)

if ( ! nwarn(mdoc, n, WPROLREP))

return(0);

return(1);

}

static int

pre_dd(PRE_ARGS)

{

if (mdoc->meta.title || mdoc->meta.os)

if ( ! nwarn(mdoc, n, WPROLOOO))

return(0);

if (mdoc->meta.date)

if ( ! nwarn(mdoc, n, WPROLREP))

return(0);

return(1);

}

static int

post_bf(POST_ARGS)

{

char *p;

Line 833 post_bf(POST_ARGS)

Line 1017 post_bf(POST_ARGS)

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

return(1);

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

head = mdoc->last->head;

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

if (NULL == mdoc->last->args) {

if (NULL == head->child)

if (NULL == head->child ||

return(mdoc_err(mdoc, "argument expected"));

MDOC_TEXT != head->child->type)

return(mdoc_err(mdoc, "text argument expected"));

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

p = head->child->string;

if (xstrcmp(p, "Em"))

return(1);

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

Line 850 post_bf(POST_ARGS)

Line 1035 post_bf(POST_ARGS)

}

if (head->child)

return(mdoc_err(mdoc, "argument expected"));

return(mdoc_err(mdoc, "one argument expected"));

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

return(1);

return(mdoc_err(mdoc, "argument expected"));

}

Line 866 post_nm(POST_ARGS)

Line 1049 post_nm(POST_ARGS)

return(1);

if (mdoc->meta.name)

return(1);

return(mdoc_err(mdoc, "not yet invoked with name"));

return(merr(mdoc, ENAME));

}

static int

post_xr(POST_ARGS)

{

struct mdoc_node *n;

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

return(1);

if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))

return(1);

return(mdoc_nerr(mdoc, n, "invalid manual section"));

}

static int

post_at(POST_ARGS)

{

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

return(1);

if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))

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

return(merr(mdoc, EATT));

if (mdoc_a2att(mdoc->last->child->string))

return(1);

return(mdoc_err(mdoc, "require valid symbol"));

return(merr(mdoc, EATT));

}

Line 899 static int

Line 1071 static int

post_an(POST_ARGS)

{

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

if (mdoc->last->args) {

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

return(1);

return(mdoc_err(mdoc, "argument(s) expected"));

return(merr(mdoc, ELINE));

}

if (mdoc->last->child)

return(1);

return(mdoc_err(mdoc, "argument(s) expected"));

return(merr(mdoc, ELINE));

}

Line 915 static int

Line 1087 static int

post_ex(POST_ARGS)

{

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

if (mdoc->last->args)

if (mdoc->last->child)

return(1);

return(merr(mdoc, ELINE));

return(mdoc_err(mdoc, "argument(s) expected"));

}

if (mdoc->last->child)

return(mdoc_err(mdoc, "argument(s) expected"));

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

return(mdoc_err(mdoc, "argument(s) expected"));

if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)

return(mdoc_err(mdoc, "argument(s) expected"));

return(1);

}

static int

post_it(POST_ARGS)

{

int type, sv, i;

int type, i, cols;

#define TYPE_NONE (0)

struct mdoc_node *n, *c;

#define TYPE_BODY (1)

#define TYPE_HEAD (2)

#define TYPE_OHEAD (3)

size_t argc;

struct mdoc_node *n;

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

return(1);

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

if (NULL == n->args)

return(merr(mdoc, ELISTTYPE));

argc = n->data.block.argc;

type = TYPE_NONE;

sv = -1;

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

/* LINTED */

for (i = 0; TYPE_NONE == type && i < (int)argc; i++)

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

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

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

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

case (MDOC_Tag):

/* FALLTHROUGH */

case (MDOC_Diag):

Line 965 post_it(POST_ARGS)

Line 1121 post_it(POST_ARGS)

case (MDOC_Ohang):

/* FALLTHROUGH */

case (MDOC_Inset):

type = TYPE_HEAD;

/* FALLTHROUGH */

sv = n->data.block.argv[i].arg;

break;

case (MDOC_Bullet):

/* FALLTHROUGH */

case (MDOC_Dash):

Line 977 post_it(POST_ARGS)

Line 1131 post_it(POST_ARGS)

case (MDOC_Hyphen):

/* FALLTHROUGH */

case (MDOC_Item):

type = TYPE_BODY;

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

sv = n->data.block.argv[i].arg;

break;

case (MDOC_Column):

type = TYPE_OHEAD;

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

sv = n->data.block.argv[i].arg;

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

break;

default:

break;

}

assert(TYPE_NONE != type);

if (-1 == type)

return(merr(mdoc, ELISTTYPE));

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

switch (type) {

case (MDOC_Tag):

if (TYPE_HEAD == type) {

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

if (NULL == n->child)

if ( ! mwarn(mdoc, WLINE))

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

"argument(s) suggested"))

return(0);

break;

n = mdoc->last->data.block.body;

case (MDOC_Hang):

if (NULL == n->child)

/* FALLTHROUGH */

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

case (MDOC_Ohang):

"multiline body suggested"))

/* FALLTHROUGH */

case (MDOC_Inset):

/* FALLTHROUGH */

case (MDOC_Diag):

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

if ( ! mwarn(mdoc, WLINE))

return(0);

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

} else if (TYPE_BODY == type) {

if ( ! mwarn(mdoc, WMULTILINE))

if (n->child)

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

"no argument suggested"))

return(0);

break;

n = mdoc->last->data.block.body;

case (MDOC_Bullet):

if (NULL == n->child)

/* FALLTHROUGH */

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

case (MDOC_Dash):

"multiline body suggested"))

/* FALLTHROUGH */

case (MDOC_Enum):

/* FALLTHROUGH */

case (MDOC_Hyphen):

/* FALLTHROUGH */

case (MDOC_Item):

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

if ( ! mwarn(mdoc, WNOLINE))

return(0);

} else {

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

if (NULL == n->child)

if ( ! mwarn(mdoc, WMULTILINE))

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

"argument(s) suggested"))

return(0);

break;

n = mdoc->last->data.block.body;

case (MDOC_Column):

if (n->child)

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

if ( ! mdoc_warn(mdoc, WARN_SYNTAX,

if ( ! mwarn(mdoc, WLINE))

"no multiline body suggested"))

return(0);

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

if ( ! mwarn(mdoc, WNOMULTILINE))

return(0);

c = mdoc->last->child;

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

i++;

if (i == cols)

break;

return(mdoc_err(mdoc, "column mismatch (have "

"%d, want %d)", i, cols));

default:

break;

}

if (MDOC_Column != sv)

return(1);

argc = mdoc->last->parent->parent->data.block.argv->sz;

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

for (i = 0; n; n = n->next)

i++;

if (i == (int)argc)

return(1);

return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));

#undef TYPE_NONE

#undef TYPE_BODY

#undef TYPE_HEAD

#undef TYPE_OHEAD

}

Line 1055 post_bl(POST_ARGS)

Line 1209 post_bl(POST_ARGS)

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

return(1);

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

return(1);

/* LINTED */

for (n = mdoc->last->child; n; n = n->next) {

if (MDOC_BLOCK == n->type)

if (MDOC_It == n->tok)

continue;

break;

return(mdoc_nerr(mdoc, n, "bad child of parent %s",

mdoc_macronames[mdoc->last->tok]));

}

if (NULL == n)

return(1);

return(mdoc_nerr(mdoc, n, "bad child of parent list"));

}

Line 1080 ebool(struct mdoc *mdoc)

Line 1234 ebool(struct mdoc *mdoc)

for (n = mdoc->last->child; n; n = n->next) {

if (MDOC_TEXT != n->type)

break;

if (xstrcmp(n->data.text.string, "on"))

if (xstrcmp(n->string, "on"))

continue;

if (xstrcmp(n->data.text.string, "off"))

if (xstrcmp(n->string, "off"))

continue;

break;

}

if (NULL == n)

return(1);

return(mdoc_nerr(mdoc, n, "expected boolean"));

return(nerr(mdoc, n, EBOOL));

}

Line 1098 post_root(POST_ARGS)

Line 1252 post_root(POST_ARGS)

{

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

return(mdoc_err(mdoc, "document lacks data"));

return(merr(mdoc, ENODATA));

if (SEC_PROLOGUE == mdoc->lastnamed)

return(mdoc_err(mdoc, "document lacks prologue"));

return(merr(mdoc, ENOPROLOGUE));

if (MDOC_BLOCK != mdoc->first->child->type)

return(mdoc_err(mdoc, "lacking post-prologue %s",

return(merr(mdoc, ENODATA));

mdoc_macronames[MDOC_Sh]));

if (MDOC_Sh != mdoc->first->child->tok)

return(mdoc_err(mdoc, "lacking post-prologue %s",

return(merr(mdoc, ENODATA));

mdoc_macronames[MDOC_Sh]));

return(1);

}

static int

post_st(POST_ARGS)

{

if (mdoc_a2st(mdoc->last->child->string))

return(1);

return(mwarn(mdoc, WBADSTAND));

}

static int

post_sh(POST_ARGS)

{

Line 1141 post_sh_body(POST_ARGS)

Line 1303 post_sh_body(POST_ARGS)

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

return(mdoc_warn(mdoc, WARN_SYNTAX,

return(mwarn(mdoc, WNAMESECINC));

"section should have %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_SYNTAX,

if ( ! mwarn(mdoc, WNAMESECINC))

"section should have %s first",

mdoc_macronames[MDOC_Nm])))

return(0);

}

if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)

return(1);

return(mwarn(mdoc, WNAMESECINC));

return(mdoc_warn(mdoc, WARN_SYNTAX,

"section should have %s last",

mdoc_macronames[MDOC_Nd]));

}

Line 1172 post_sh_head(POST_ARGS)

Line 1326 post_sh_head(POST_ARGS)

char buf[64];

enum mdoc_sec sec;

* Process a new section. Sections are either "named" or

* "custom"; custom sections are user-defined, while named ones

* usually follow a conventional order and may only appear in

* certain manual sections.

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

if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf)))

(void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));

return(mdoc_err(mdoc, "argument too long"));

sec = mdoc_atosec(buf);

/* The NAME section should always be first. */

if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)

return(mdoc_warn(mdoc, WARN_SYNTAX,

return(mwarn(mdoc, WSECOOO));

"section NAME should be first"));

if (SEC_CUSTOM == sec)

return(1);

/* Check for repeated or out-of-order sections. */

if (sec == mdoc->lastnamed)

return(mdoc_warn(mdoc, WARN_SYNTAX,

return(mwarn(mdoc, WSECREP));

"section repeated"));

if (sec < mdoc->lastnamed)

return(mdoc_warn(mdoc, WARN_SYNTAX,

return(mwarn(mdoc, WSECOOO));

"section out of order"));

/* Check particular section/manual section conventions. */

switch (sec) {

case (SEC_LIBRARY):

switch (mdoc->meta.msec) {

case (2):

/* FALLTHROUGH */

case (3):

break;

default:

return(mwarn(mdoc, WWRONGMSEC));

}

break;

default:

break;

}

return(1);

}

static int

post_fd(POST_ARGS)

pre_fd(PRE_ARGS)

{

if (SEC_SYNOPSIS == mdoc->last->sec)

return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));

return(1);

return(mdoc_warn(mdoc, WARN_COMPAT,

"suggested only in section SYNOPSIS"));

}

CVSweb