mandoc/mdoc_validate.c - diff

Return to mdoc_validate.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_validate.c between version 1.246 and 1.257

version 1.246, 2014/09/07 00:05:28

version 1.257, 2014/11/27 16:20:31

Line 67 static void check_text(struct mdoc *, int, int, char

static void check_argv(struct mdoc *,

struct mdoc_node *, struct mdoc_argv *);

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

static int child_an(const struct mdoc_node *);

static enum mdoc_sec a2sec(const char *);

static size_t macro2len(enum mdoct);

static void rewrite_macro2len(char **);

static int ebool(POST_ARGS);

static int berr_ge1(POST_ARGS);

static int bwarn_ge1(POST_ARGS);

static int ewarn_eq0(POST_ARGS);

Line 87 static int post_bf(POST_ARGS);

Line 88 static int post_bf(POST_ARGS);

static int post_bk(POST_ARGS);

static int post_bl(POST_ARGS);

static int post_bl_block(POST_ARGS);

static int post_bl_block_width(POST_ARGS);

static int post_bl_block_tag(POST_ARGS);

static int post_bl_head(POST_ARGS);

static int post_bx(POST_ARGS);

Line 99 static int post_en(POST_ARGS);

static int post_es(POST_ARGS);

static int post_eoln(POST_ARGS);

static int post_ex(POST_ARGS);

static int post_fa(POST_ARGS);

static int post_fn(POST_ARGS);

static int post_fname(POST_ARGS);

static int post_fo(POST_ARGS);

static int post_hyph(POST_ARGS);

static int post_hyphtext(POST_ARGS);

Line 114 static int post_par(POST_ARGS);

Line 117 static int post_par(POST_ARGS);

static int post_root(POST_ARGS);

static int post_rs(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_sh_name(POST_ARGS);

static int post_sh_see_also(POST_ARGS);

static int post_sh_authors(POST_ARGS);

static int post_sm(POST_ARGS);

static int post_st(POST_ARGS);

static int post_vt(POST_ARGS);

static int pre_an(PRE_ARGS);

Line 154 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 160 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Er */

{ NULL, NULL }, /* Ev */

{ pre_std, post_ex }, /* Ex */

{ NULL, NULL }, /* Fa */

{ NULL, post_fa }, /* Fa */

{ NULL, ewarn_ge1 }, /* Fd */

{ NULL, NULL }, /* Fl */

{ NULL, NULL }, /* Fn */

{ NULL, post_fn }, /* Fn */

{ NULL, NULL }, /* Ft */

{ NULL, NULL }, /* Ic */

{ NULL, ewarn_eq1 }, /* In */

Line 193 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 199 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Bq */

{ NULL, NULL }, /* Bsx */

{ NULL, post_bx }, /* Bx */

{ NULL, ebool }, /* Db */

{ pre_obsolete, NULL }, /* Db */

{ NULL, NULL }, /* Dc */

{ NULL, NULL }, /* Do */

{ NULL, NULL }, /* Dq */

Line 203 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 209 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Eo */

{ NULL, NULL }, /* Fx */

{ NULL, NULL }, /* Ms */

{ NULL, ewarn_eq0 }, /* No */

{ NULL, NULL }, /* No */

{ NULL, post_ns }, /* Ns */

{ NULL, NULL }, /* Nx */

{ NULL, NULL }, /* Ox */

Line 220 static const struct valids mdoc_valids[MDOC_MAX] = {

Line 226 static const struct valids mdoc_valids[MDOC_MAX] = {

{ NULL, NULL }, /* Sc */

{ NULL, NULL }, /* So */

{ NULL, NULL }, /* Sq */

{ NULL, ebool }, /* Sm */

{ NULL, post_sm }, /* Sm */

{ NULL, post_hyph }, /* Sx */

{ NULL, NULL }, /* Sy */

{ NULL, NULL }, /* Tn */

Line 347 mdoc_valid_post(struct mdoc *mdoc)

Line 353 mdoc_valid_post(struct mdoc *mdoc)

case MDOC_ROOT:

return(post_root(mdoc));

default:

* Closing delimiters are not special at the

* beginning of a block, opening delimiters

* are not special at the end.

if (n->child != NULL)

n->child->flags &= ~MDOC_DELIMC;

if (n->last != NULL)

n->last->flags &= ~MDOC_DELIMO;

/* Call the macro's postprocessor. */

p = mdoc_valids[n->tok].post;

return(*p ? (*p)(mdoc) : 1);

}

Line 591 pre_bl(PRE_ARGS)

Line 611 pre_bl(PRE_ARGS)

mdoc->parse, argv->line,

argv->pos, "Bl -width %s",

argv->value[0]);

rewrite_macro2len(argv->value);

n->norm->Bl.width = argv->value[0];

break;

case MDOC_Offset:

Line 605 pre_bl(PRE_ARGS)

Line 626 pre_bl(PRE_ARGS)

mdoc->parse, argv->line,

argv->pos, "Bl -offset %s",

argv->value[0]);

rewrite_macro2len(argv->value);

n->norm->Bl.offs = argv->value[0];

break;

default:

Line 752 pre_bd(PRE_ARGS)

Line 774 pre_bd(PRE_ARGS)

mdoc->parse, argv->line,

argv->pos, "Bd -offset %s",

argv->value[0]);

rewrite_macro2len(argv->value);

n->norm->Bd.offs = argv->value[0];

break;

case MDOC_Compact:

Line 996 post_eoln(POST_ARGS)

Line 1019 post_eoln(POST_ARGS)

}

static int

post_fname(POST_ARGS)

{

const struct mdoc_node *n;

const char *cp;

size_t pos;

n = mdoc->last->child;

pos = strcspn(n->string, "()");

cp = n->string + pos;

if ( ! (cp[0] == '\0' || (cp[0] == '(' && cp[1] == '*')))

mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse,

n->line, n->pos + pos, n->string);

return(1);

}

static int

post_fn(POST_ARGS)

{

post_fname(mdoc);

post_fa(mdoc);

return(1);

}

static int

post_fo(POST_ARGS)

{

hwarn_eq1(mdoc);

bwarn_ge1(mdoc);

if (mdoc->last->type == MDOC_HEAD && mdoc->last->nchild)

post_fname(mdoc);

return(1);

}

static int

post_fa(POST_ARGS)

{

const struct mdoc_node *n;

const char *cp;

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

for (cp = n->string; *cp != '\0'; cp++) {

/* Ignore callbacks and alterations. */

if (*cp == '(' || *cp == '{')

break;

if (*cp != ',')

continue;

mandoc_msg(MANDOCERR_FA_COMMA, mdoc->parse,

n->line, n->pos + (cp - n->string),

n->string);

break;

}

return(1);

}

static int

post_vt(POST_ARGS)

{

const struct mdoc_node *n;

Line 1104 post_defaults(POST_ARGS)

Line 1176 post_defaults(POST_ARGS)

if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))

return(0);

break;

case MDOC_Li:

if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))

return(0);

break;

case MDOC_Pa:

/* FALLTHROUGH */

case MDOC_Mt:

Line 1281 post_bl_block(POST_ARGS)

Line 1349 post_bl_block(POST_ARGS)

if ( ! post_bl_block_tag(mdoc))

return(0);

assert(n->norm->Bl.width);

} else if (NULL != n->norm->Bl.width) {

if ( ! post_bl_block_width(mdoc))

return(0);

assert(n->norm->Bl.width);

}

for (ni = n->body->child; ni; ni = ni->next) {

Line 1324 post_bl_block(POST_ARGS)

Line 1388 post_bl_block(POST_ARGS)

return(1);

}

static int

post_bl_block_width(POST_ARGS)

* If the argument of -offset or -width is a macro,

* replace it with the associated default width.

void

rewrite_macro2len(char **arg)

{

size_t width;

int i;

enum mdoct tok;

struct mdoc_node *n;

char buf[24];

n = mdoc->last;

if (*arg == NULL)

return;

else if ( ! strcmp(*arg, "Ds"))

* Calculate the real width of a list from the -width string,

* which may contain a macro (with a known default width), a

* literal string, or a scaling width.

* If the value to -width is a macro, then we re-write it to be

* the macro's width as set in share/tmac/mdoc/doc-common.

if (0 == strcmp(n->norm->Bl.width, "Ds"))

width = 6;

else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))

else if ((tok = mdoc_hash_find(*arg)) == MDOC_MAX)

return(1);

return;

else

width = macro2len(tok);

/* The value already exists: free and reallocate it. */

free(*arg);

mandoc_asprintf(arg, "%zun", width);

assert(n->args);

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

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

break;

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

(void)snprintf(buf, sizeof(buf), "%un", (unsigned int)width);

free(n->args->argv[i].value[0]);

n->args->argv[i].value[0] = mandoc_strdup(buf);

/* Set our width! */

n->norm->Bl.width = n->args->argv[i].value[0];

return(1);

}

static int

Line 1382 post_bl_block_tag(POST_ARGS)

Line 1423 post_bl_block_tag(POST_ARGS)

* Calculate the -width for a `Bl -tag' list if it hasn't been

* provided. Uses the first head macro. NOTE AGAIN: this is

* ONLY if the -width argument has NOT been provided. See

* post_bl_block_width() for converting the -width string.

* rewrite_macro2len() for converting the -width string.

sz = 10;

Line 1581 post_bk(POST_ARGS)

Line 1622 post_bk(POST_ARGS)

}

static int

ebool(struct mdoc *mdoc)

post_sm(struct mdoc *mdoc)

{

struct mdoc_node *nch;

enum mdoct tok;

tok = mdoc->last->tok;

nch = mdoc->last->child;

if (NULL == nch) {

if (nch == NULL) {

if (MDOC_Sm == tok)

mdoc->flags ^= MDOC_SMOFF;

return(1);

}

check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2);

assert(nch->type == MDOC_TEXT);

assert(MDOC_TEXT == nch->type);

if ( ! strcmp(nch->string, "on")) {

mdoc->flags &= ~MDOC_SMOFF;

if (0 == strcmp(nch->string, "on")) {

if (MDOC_Sm == tok)

mdoc->flags &= ~MDOC_SMOFF;

return(1);

}

if (0 == strcmp(nch->string, "off")) {

if ( ! strcmp(nch->string, "off")) {

if (MDOC_Sm == tok)

mdoc->flags |= MDOC_SMOFF;

return(1);

}

mandoc_vmsg(MANDOCERR_SM_BAD,

mdoc->parse, nch->line, nch->pos,

"%s %s", mdoc_macronames[tok], nch->string);

"%s %s", mdoc_macronames[mdoc->last->tok], nch->string);

return(mdoc_node_relink(mdoc, nch));

}

Line 1847 post_sh(POST_ARGS)

Line 1881 post_sh(POST_ARGS)

post_ignpar(mdoc);

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

switch (mdoc->last->type) {

case MDOC_HEAD:

return(post_sh_head(mdoc));

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

case MDOC_BODY:

return(post_sh_body(mdoc));

switch (mdoc->lastsec) {

case SEC_NAME:

return(post_sh_name(mdoc));

case SEC_SEE_ALSO:

return(post_sh_see_also(mdoc));

case SEC_AUTHORS:

return(post_sh_authors(mdoc));

default:

break;

}

break;

default:

break;

}

return(1);

}

static int

post_sh_body(POST_ARGS)

post_sh_name(POST_ARGS)

{

struct mdoc_node *n;

if (SEC_NAME != mdoc->lastsec)

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

Line 1890 post_sh_body(POST_ARGS)

Line 1935 post_sh_body(POST_ARGS)

mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse,

n->line, n->pos, mdoc_macronames[n->tok]);

return(1);

}

static int

post_sh_see_also(POST_ARGS)

{

const struct mdoc_node *n;

const char *name, *sec;

const char *lastname, *lastsec, *lastpunct;

int cmp;

n = mdoc->last->child;

lastname = lastsec = lastpunct = NULL;

while (n != NULL) {

if (n->tok != MDOC_Xr || n->nchild < 2)

break;

/* Process one .Xr node. */

name = n->child->string;

sec = n->child->next->string;

if (lastsec != NULL) {

if (lastpunct[0] != ',' || lastpunct[1] != '\0')

mandoc_vmsg(MANDOCERR_XR_PUNCT,

mdoc->parse, n->line, n->pos,

"%s before %s(%s)", lastpunct,

name, sec);

cmp = strcmp(lastsec, sec);

if (cmp > 0)

mandoc_vmsg(MANDOCERR_XR_ORDER,

mdoc->parse, n->line, n->pos,

"%s(%s) after %s(%s)", name,

sec, lastname, lastsec);

else if (cmp == 0 &&

strcasecmp(lastname, name) > 0)

mandoc_vmsg(MANDOCERR_XR_ORDER,

mdoc->parse, n->line, n->pos,

"%s after %s", name, lastname);

}

lastname = name;

lastsec = sec;

/* Process the following node. */

n = n->next;

if (n == NULL)

break;

if (n->tok == MDOC_Xr) {

lastpunct = "none";

continue;

}

if (n->type != MDOC_TEXT)

break;

for (name = n->string; *name != '\0'; name++)

if (isalpha((const unsigned char)*name))

return(1);

lastpunct = n->string;

if (n->next == NULL)

mandoc_vmsg(MANDOCERR_XR_PUNCT, mdoc->parse,

n->line, n->pos, "%s after %s(%s)",

lastpunct, lastname, lastsec);

n = n->next;

}

return(1);

}

static int

child_an(const struct mdoc_node *n)

{

for (n = n->child; n != NULL; n = n->next)

if ((n->tok == MDOC_An && n->nchild) || child_an(n))

return(1);

return(0);

}

static int

post_sh_authors(POST_ARGS)

{

if ( ! child_an(mdoc->last))

mandoc_msg(MANDOCERR_AN_MISSING, mdoc->parse,

mdoc->last->line, mdoc->last->pos, NULL);

return(1);

}

CVSweb