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.343 and 1.360

version 1.343, 2017/06/25 17:43:45

version 1.360, 2018/08/01 16:00:58

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

Line 33

#include "mandoc_aux.h"

#include "mandoc.h"

#include "mandoc_xr.h"

#include "roff.h"

#include "mdoc.h"

#include "libmandoc.h"

Line 52 enum check_ineq {

Line 53 enum check_ineq {

typedef void (*v_post)(POST_ARGS);

static int build_list(struct roff_man *, int);

static void check_text(struct roff_man *, int, int, char *);

static void check_argv(struct roff_man *,

struct roff_node *, struct mdoc_argv *);

static void check_args(struct roff_man *, struct roff_node *);

static void check_text(struct roff_man *, int, int, char *);

static void check_text_em(struct roff_man *, int, int, char *);

static void check_toptext(struct roff_man *, int, int, const char *);

static int child_an(const struct roff_node *);

static size_t macro2len(enum roff_tok);

Line 77 static void post_defaults(POST_ARGS);

Line 79 static void post_defaults(POST_ARGS);

static void post_display(POST_ARGS);

static void post_dd(POST_ARGS);

static void post_delim(POST_ARGS);

static void post_delim_nb(POST_ARGS);

static void post_dt(POST_ARGS);

static void post_en(POST_ARGS);

static void post_es(POST_ARGS);

Line 108 static void post_sh_authors(POST_ARGS);

Line 111 static void post_sh_authors(POST_ARGS);

static void post_sm(POST_ARGS);

static void post_st(POST_ARGS);

static void post_std(POST_ARGS);

static void post_sx(POST_ARGS);

static void post_useless(POST_ARGS);

static void post_xr(POST_ARGS);

static void post_xx(POST_ARGS);

Line 126 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

Line 130 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

post_bl, /* Bl */

NULL, /* El */

post_it, /* It */

post_delim, /* Ad */

post_delim_nb, /* Ad */

post_an, /* An */

NULL, /* Ap */

post_defaults, /* Ar */

NULL, /* Cd */

post_delim, /* Cm */

post_delim_nb, /* Cm */

post_delim, /* Dv */

post_delim_nb, /* Dv */

post_delim, /* Er */

post_delim_nb, /* Er */

post_delim, /* Ev */

post_delim_nb, /* Ev */

post_ex, /* Ex */

post_fa, /* Fa */

NULL, /* Fd */

post_delim, /* Fl */

post_delim_nb, /* Fl */

post_fn, /* Fn */

post_delim, /* Ft */

post_delim_nb, /* Ft */

post_delim, /* Ic */

post_delim_nb, /* Ic */

post_delim, /* In */

post_delim_nb, /* In */

post_defaults, /* Li */

post_nd, /* Nd */

post_nm, /* Nm */

post_delim, /* Op */

post_delim_nb, /* Op */

post_obsolete, /* Ot */

post_defaults, /* Pa */

post_rv, /* Rv */

post_st, /* St */

post_delim, /* Va */

post_delim_nb, /* Va */

post_delim, /* Vt */

post_delim_nb, /* Vt */

post_xr, /* Xr */

NULL, /* %A */

post_hyph, /* %B */ /* FIXME: can be used outside Rs/Re. */

Line 166 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

Line 170 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

post_hyph, /* %T */ /* FIXME: can be used outside Rs/Re. */

NULL, /* %V */

NULL, /* Ac */

post_delim, /* Ao */

NULL, /* Ao */

post_delim, /* Aq */

post_delim_nb, /* Aq */

post_at, /* At */

NULL, /* Bc */

post_bf, /* Bf */

post_delim, /* Bo */

NULL, /* Bo */

NULL, /* Bq */

post_xx, /* Bsx */

post_bx, /* Bx */

Line 181 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

Line 185 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

NULL, /* Dq */

NULL, /* Ec */

NULL, /* Ef */

post_delim, /* Em */

post_delim_nb, /* Em */

NULL, /* Eo */

post_xx, /* Fx */

post_delim, /* Ms */

post_delim_nb, /* Ms */

NULL, /* No */

post_ns, /* Ns */

post_xx, /* Nx */

post_xx, /* Ox */

NULL, /* Pc */

NULL, /* Pf */

post_delim, /* Po */

NULL, /* Po */

post_delim, /* Pq */

post_delim_nb, /* Pq */

NULL, /* Qc */

post_delim, /* Ql */

post_delim_nb, /* Ql */

post_delim, /* Qo */

NULL, /* Qo */

post_delim, /* Qq */

post_delim_nb, /* Qq */

NULL, /* Re */

post_rs, /* Rs */

NULL, /* Sc */

post_delim, /* So */

NULL, /* So */

post_delim, /* Sq */

post_delim_nb, /* Sq */

post_sm, /* Sm */

post_hyph, /* Sx */

post_sx, /* Sx */

post_delim, /* Sy */

post_delim_nb, /* Sy */

post_useless, /* Tn */

post_xx, /* Ux */

NULL, /* Xc */

NULL, /* Xo */

post_fo, /* Fo */

NULL, /* Fc */

post_delim, /* Oo */

NULL, /* Oo */

NULL, /* Oc */

post_bk, /* Bk */

NULL, /* Ek */

Line 221 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

Line 225 static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd]

post_eoln, /* Ud */

post_lb, /* Lb */

post_par, /* Lp */

post_delim, /* Lk */

post_delim_nb, /* Lk */

post_defaults, /* Mt */

post_delim, /* Brq */

post_delim_nb, /* Brq */

post_delim, /* Bro */

NULL, /* Bro */

NULL, /* Brc */

NULL, /* %C */

post_es, /* Es */

Line 285 static const char * const secnames[SEC__MAX] = {

Line 289 static const char * const secnames[SEC__MAX] = {

void

mdoc_node_validate(struct roff_man *mdoc)

{

struct roff_node *n;

struct roff_node *n, *np;

const v_post *p;

n = mdoc->last;

Line 302 mdoc_node_validate(struct roff_man *mdoc)

Line 306 mdoc_node_validate(struct roff_man *mdoc)

mdoc->next = ROFF_NEXT_SIBLING;

switch (n->type) {

case ROFFT_TEXT:

np = n->parent;

if (n->sec != SEC_SYNOPSIS ||

(n->parent->tok != MDOC_Cd && n->parent->tok != MDOC_Fd))

(np->tok != MDOC_Cd && np->tok != MDOC_Fd))

check_text(mdoc, n->line, n->pos, n->string);

if (n->parent->tok == MDOC_It ||

if (np->tok != MDOC_Ql && np->tok != MDOC_Dl &&

(n->parent->type == ROFFT_BODY &&

(np->tok != MDOC_Bd ||

(n->parent->tok == MDOC_Sh ||

(mdoc->flags & MDOC_LITERAL) == 0) &&

n->parent->tok == MDOC_Ss)))

(np->tok != MDOC_It || np->type != ROFFT_HEAD ||

np->parent->parent->norm->Bl.type != LIST_diag))

check_text_em(mdoc, n->line, n->pos, n->string);

if (np->tok == MDOC_It || (np->type == ROFFT_BODY &&

(np->tok == MDOC_Sh || np->tok == MDOC_Ss)))

check_toptext(mdoc, n->line, n->pos, n->string);

break;

case ROFFT_COMMENT:

case ROFFT_EQN:

case ROFFT_TBL:

break;

Line 392 check_text(struct roff_man *mdoc, int ln, int pos, cha

Line 402 check_text(struct roff_man *mdoc, int ln, int pos, cha

}

static void

check_text_em(struct roff_man *mdoc, int ln, int pos, char *p)

{

const struct roff_node *np, *nn;

char *cp;

np = mdoc->last->prev;

nn = mdoc->last->next;

/* Look for em-dashes wrongly encoded as "--". */

for (cp = p; *cp != '\0'; cp++) {

if (cp[0] != '-' || cp[1] != '-')

continue;

cp++;

/* Skip input sequences of more than two '-'. */

if (cp[1] == '-') {

while (cp[1] == '-')

cp++;

continue;

}

/* Skip "--" directly attached to something else. */

if ((cp - p > 1 && cp[-2] != ' ') ||

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

continue;

/* Require a letter right before or right afterwards. */

if ((cp - p > 2 ?

isalpha((unsigned char)cp[-3]) :

np != NULL &&

np->type == ROFFT_TEXT &&

*np->string != '\0' &&

isalpha((unsigned char)np->string[

strlen(np->string) - 1])) ||

(cp[1] != '\0' && cp[2] != '\0' ?

isalpha((unsigned char)cp[2]) :

nn != NULL &&

nn->type == ROFFT_TEXT &&

isalpha((unsigned char)*nn->string))) {

mandoc_msg(MANDOCERR_DASHDASH, mdoc->parse,

ln, pos + (int)(cp - p) - 1, NULL);

break;

}

static void

check_toptext(struct roff_man *mdoc, int ln, int pos, const char *p)

{

const char *cp, *cpr;

Line 430 static void

Line 491 static void

post_delim(POST_ARGS)

{

const struct roff_node *nch;

const char *lc;

enum mdelim delim;

enum roff_tok tok;

tok = mdoc->last->tok;

nch = mdoc->last->last;

if (nch == NULL || nch->type != ROFFT_TEXT)

return;

lc = strchr(nch->string, '\0') - 1;

if (lc < nch->string)

return;

delim = mdoc_isdelim(lc);

if (delim == DELIM_NONE || delim == DELIM_OPEN)

return;

if (*lc == ')' && (tok == MDOC_Nd || tok == MDOC_Sh ||

tok == MDOC_Ss || tok == MDOC_Fo))

return;

mandoc_vmsg(MANDOCERR_DELIM, mdoc->parse,

nch->line, nch->pos + (lc - nch->string),

"%s%s %s", roff_name[tok],

nch == mdoc->last->child ? "" : " ...", nch->string);

}

static void

post_delim_nb(POST_ARGS)

{

const struct roff_node *nch;

const char *lc, *cp;

int nw;

enum mdelim delim;

Line 499 post_delim(POST_ARGS)

Line 588 post_delim(POST_ARGS)

/* At least three alphabetic words with a sentence ending. */

if (strchr("!.:?", *lc) != NULL && (tok == MDOC_Em ||

tok == MDOC_Li || tok == MDOC_Po || tok == MDOC_Pq ||

tok == MDOC_Li || tok == MDOC_Pq || tok == MDOC_Sy)) {

tok == MDOC_Sy)) {

nw = 0;

for (cp = lc - 1; cp >= nch->string; cp--) {

if (*cp == ' ') {

Line 515 post_delim(POST_ARGS)

Line 603 post_delim(POST_ARGS)

}

mandoc_vmsg(MANDOCERR_DELIM, mdoc->parse,

mandoc_vmsg(MANDOCERR_DELIM_NB, mdoc->parse,

nch->line, nch->pos + (lc - nch->string),

"%s%s %s", roff_name[tok],

nch == mdoc->last->child ? "" : " ...", nch->string);

Line 669 post_bl_norm(POST_ARGS)

Line 757 post_bl_norm(POST_ARGS)

switch (n->norm->Bl.type) {

case LIST_tag:

if (NULL == n->norm->Bl.width)

if (n->norm->Bl.width == NULL)

mandoc_msg(MANDOCERR_BL_NOWIDTH, mdoc->parse,

n->line, n->pos, "Bl -tag");

break;

Line 678 post_bl_norm(POST_ARGS)

Line 766 post_bl_norm(POST_ARGS)

case LIST_ohang:

case LIST_inset:

case LIST_item:

if (n->norm->Bl.width)

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

mandoc_vmsg(MANDOCERR_BL_SKIPW, mdoc->parse,

wa->line, wa->pos, "Bl -%s",

mdoc_argnames[mdoclt]);

n->norm->Bl.width = NULL;

break;

case LIST_bullet:

case LIST_dash:

case LIST_hyphen:

if (NULL == n->norm->Bl.width)

if (n->norm->Bl.width == NULL)

n->norm->Bl.width = "2n";

break;

case LIST_enum:

if (NULL == n->norm->Bl.width)

if (n->norm->Bl.width == NULL)

n->norm->Bl.width = "3n";

break;

default:

Line 896 post_lb(POST_ARGS)

Line 985 post_lb(POST_ARGS)

struct roff_node *n;

const char *p;

post_delim(mdoc);

post_delim_nb(mdoc);

n = mdoc->last;

assert(n->child->type == ROFFT_TEXT);

Line 915 post_lb(POST_ARGS)

Line 1004 post_lb(POST_ARGS)

roff_word_alloc(mdoc, n->line, n->pos, "library");

mdoc->last->flags = NODE_NOSRC;

roff_word_alloc(mdoc, n->line, n->pos, "\\(Lq");

roff_word_alloc(mdoc, n->line, n->pos, "\\(lq");

mdoc->last->flags = NODE_DELIMO | NODE_NOSRC;

mdoc->last = mdoc->last->next;

roff_word_alloc(mdoc, n->line, n->pos, "\\(Rq");

roff_word_alloc(mdoc, n->line, n->pos, "\\(rq");

mdoc->last->flags = NODE_DELIMC | NODE_NOSRC;

mdoc->last = n;

}

Line 967 post_std(POST_ARGS)

Line 1056 post_std(POST_ARGS)

{

struct roff_node *n;

post_delim(mdoc);

n = mdoc->last;

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

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

Line 1134 post_fo(POST_ARGS)

Line 1225 post_fo(POST_ARGS)

"Fo ... %s", n->child->next->string);

while (n->child != n->last)

roff_node_delete(mdoc, n->last);

}

} else

post_delim(mdoc);

post_fname(mdoc);

}

Line 1158 post_fa(POST_ARGS)

Line 1250 post_fa(POST_ARGS)

break;

}

post_delim(mdoc);

post_delim_nb(mdoc);

}

static void

Line 1168 post_nm(POST_ARGS)

Line 1260 post_nm(POST_ARGS)

n = mdoc->last;

if (n->sec == SEC_NAME && n->child != NULL &&

n->child->type == ROFFT_TEXT && mdoc->meta.msec != NULL)

mandoc_xr_add(mdoc->meta.msec, n->child->string, -1, -1);

if (n->last != NULL &&

(n->last->tok == MDOC_Pp ||

n->last->tok == MDOC_Lp))

Line 1181 post_nm(POST_ARGS)

Line 1277 post_nm(POST_ARGS)

mandoc_msg(MANDOCERR_NM_NONAME, mdoc->parse,

n->line, n->pos, "Nm");

if (n->type == ROFFT_ELEM)

switch (n->type) {

case ROFFT_ELEM:

post_delim_nb(mdoc);

break;

case ROFFT_HEAD:

post_delim(mdoc);

break;

default:

return;

}

if ((n->type != ROFFT_ELEM && n->type != ROFFT_HEAD) ||

if ((n->child != NULL && n->child->type == ROFFT_TEXT) ||

(n->child != NULL && n->child->type == ROFFT_TEXT) ||

mdoc->meta.name == NULL)

return;

Line 1199 static void

Line 1302 static void

post_nd(POST_ARGS)

{

struct roff_node *n;

size_t sz;

n = mdoc->last;

Line 1213 post_nd(POST_ARGS)

Line 1315 post_nd(POST_ARGS)

if (n->child == NULL)

mandoc_msg(MANDOCERR_ND_EMPTY, mdoc->parse,

n->line, n->pos, "Nd");

else if (n->last->type == ROFFT_TEXT &&

else

(sz = strlen(n->last->string)) != 0 &&

post_delim(mdoc);

n->last->string[sz - 1] == '.')

mandoc_msg(MANDOCERR_ND_DOT, mdoc->parse,

n->last->line, n->last->pos + sz - 1, NULL);

post_hyph(mdoc);

}

Line 1275 post_defaults(POST_ARGS)

Line 1374 post_defaults(POST_ARGS)

struct roff_node *nn;

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

post_delim(mdoc);

post_delim_nb(mdoc);

return;

}

Line 1350 post_an(POST_ARGS)

Line 1449 post_an(POST_ARGS)

mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,

np->line, np->pos, "An");

else

post_delim(mdoc);

post_delim_nb(mdoc);

} else if (nch != NULL)

mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,

nch->line, nch->pos, "An ... %s", nch->string);

Line 1378 post_xx(POST_ARGS)

Line 1477 post_xx(POST_ARGS)

{

struct roff_node *n;

const char *os;

char *v;

post_delim(mdoc);

post_delim_nb(mdoc);

n = mdoc->last;

switch (n->tok) {

Line 1394 post_xx(POST_ARGS)

Line 1494 post_xx(POST_ARGS)

break;

case MDOC_Nx:

os = "NetBSD";

if (n->child == NULL)

break;

v = n->child->string;

if ((v[0] != '0' && v[0] != '1') || v[1] != '.' ||

v[2] < '0' || v[2] > '9' ||

v[3] < 'a' || v[3] > 'z' || v[4] != '\0')

break;

n->child->flags |= NODE_NOPRT;

mdoc->next = ROFF_NEXT_CHILD;

roff_word_alloc(mdoc, n->child->line, n->child->pos, v);

v = mdoc->last->string;

v[3] = toupper((unsigned char)v[3]);

mdoc->last->flags |= NODE_NOSRC;

mdoc->last = n;

break;

case MDOC_Ox:

os = "OpenBSD";

Line 1460 post_it(POST_ARGS)

Line 1574 post_it(POST_ARGS)

assert(nit->head->child == NULL);

i = 0;

if (nit->head->next->child == NULL &&

for (nch = nit->child; nch != NULL; nch = nch->next)

nit->head->next->next == NULL) {

if (nch->type == ROFFT_BODY)

mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,

i++;

nit->line, nit->pos, "It");

roff_node_delete(mdoc, nit);

break;

}

i = 0;

for (nch = nit->child; nch != NULL; nch = nch->next) {

if (nch->type != ROFFT_BODY)

continue;

if (i++ && nch->flags & NODE_LINE)

mandoc_msg(MANDOCERR_TA_LINE, mdoc->parse,

nch->line, nch->pos, "Ta");

}

if (i < cols || i > cols + 1)

mandoc_vmsg(MANDOCERR_BL_COL,

mdoc->parse, nit->line, nit->pos,

"%d columns, %d cells", cols, i);

else if (nit->head->next->child != NULL &&

nit->head->next->child->line > nit->line)

mandoc_msg(MANDOCERR_IT_NOARG, mdoc->parse,

nit->line, nit->pos, "Bl -column It");

break;

default:

abort();

Line 1842 post_root(POST_ARGS)

Line 1971 post_root(POST_ARGS)

arch++;

if (*arch == NULL) {

n = mdoc->first->child;

while (n->tok != MDOC_Dt)

while (n->tok != MDOC_Dt ||

n->child == NULL ||

n->child->next == NULL ||

n->child->next->next == NULL)

n = n->next;

n = n->child->next->next;

mandoc_vmsg(MANDOCERR_ARCH_BAD,

Line 1856 post_root(POST_ARGS)

Line 1988 post_root(POST_ARGS)

/* Check that we begin with a proper `Sh'. */

n = mdoc->first->child;

while (n != NULL && n->tok != TOKEN_NONE &&

while (n != NULL &&

mdoc_macros[n->tok].flags & MDOC_PROLOGUE)

(n->type == ROFFT_COMMENT ||

(n->tok >= MDOC_Dd &&

mdoc_macros[n->tok].flags & MDOC_PROLOGUE)))

n = n->next;

if (n == NULL)

Line 1983 post_hyph(POST_ARGS)

Line 2117 post_hyph(POST_ARGS)

static void

post_ns(POST_ARGS)

{

struct roff_node *n;

if (mdoc->last->flags & NODE_LINE)

n = mdoc->last;

if (n->flags & NODE_LINE ||

(n->next != NULL && n->next->flags & NODE_DELIMC))

mandoc_msg(MANDOCERR_NS_SKIP, mdoc->parse,

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

n->line, n->pos, NULL);

}

static void

post_sx(POST_ARGS)

{

post_delim(mdoc);

post_hyph(mdoc);

}

static void

post_sh(POST_ARGS)

{

Line 2318 post_xr(POST_ARGS)

Line 2462 post_xr(POST_ARGS)

if (nch->next == NULL) {

mandoc_vmsg(MANDOCERR_XR_NOSEC, mdoc->parse,

n->line, n->pos, "Xr %s", nch->string);

} else

} else {

assert(nch->next == n->last);

post_delim(mdoc);

if(mandoc_xr_add(nch->next->string, nch->string,

nch->line, nch->pos))

mandoc_vmsg(MANDOCERR_XR_SELF, mdoc->parse,

nch->line, nch->pos, "Xr %s %s",

nch->string, nch->next->string);

}

post_delim_nb(mdoc);

}

static void

Line 2333 post_ignpar(POST_ARGS)

Line 2483 post_ignpar(POST_ARGS)

post_prevpar(mdoc);

return;

case ROFFT_HEAD:

post_delim(mdoc);

post_hyph(mdoc);

return;

case ROFFT_BODY:

Line 2569 post_bx(POST_ARGS)

Line 2720 post_bx(POST_ARGS)

struct roff_node *n, *nch;

const char *macro;

post_delim(mdoc);

post_delim_nb(mdoc);

n = mdoc->last;

nch = n->child;

Line 2634 post_os(POST_ARGS)

Line 2785 post_os(POST_ARGS)

else if (mdoc->flags & MDOC_PBODY)

mandoc_msg(MANDOCERR_PROLOG_LATE, mdoc->parse,

n->line, n->pos, "Os");

post_delim(mdoc);

* Set the operating system by way of the `Os' macro.

CVSweb