-/* $Id: man_validate.c,v 1.77 2011/11/03 20:48:52 schwarze Exp $ */
+/* $Id: man_validate.c,v 1.93 2014/06/20 23:02:31 schwarze Exp $ */
/*
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
#include "man.h"
#include "mandoc.h"
+#include "mandoc_aux.h"
#include "libman.h"
#include "libmandoc.h"
-#define CHKARGS struct man *m, struct man_node *n
+#define CHKARGS struct man *man, struct man_node *n
typedef int (*v_check)(CHKARGS);
v_check *posts;
};
-static int check_bline(CHKARGS);
static int check_eq0(CHKARGS);
+static int check_eq2(CHKARGS);
static int check_le1(CHKARGS);
static int check_ge2(CHKARGS);
static int check_le5(CHKARGS);
+static int check_head1(CHKARGS);
static int check_par(CHKARGS);
static int check_part(CHKARGS);
static int check_root(CHKARGS);
static void check_text(CHKARGS);
static int post_AT(CHKARGS);
+static int post_IP(CHKARGS);
static int post_vs(CHKARGS);
static int post_fi(CHKARGS);
static int post_ft(CHKARGS);
static v_check posts_at[] = { post_AT, NULL };
static v_check posts_br[] = { post_vs, check_eq0, NULL };
static v_check posts_eq0[] = { check_eq0, NULL };
+static v_check posts_eq2[] = { check_eq2, NULL };
static v_check posts_fi[] = { check_eq0, post_fi, NULL };
static v_check posts_ft[] = { post_ft, NULL };
+static v_check posts_ip[] = { post_IP, NULL };
+static v_check posts_le1[] = { check_le1, NULL };
static v_check posts_nf[] = { check_eq0, post_nf, NULL };
static v_check posts_par[] = { check_par, NULL };
static v_check posts_part[] = { check_part, NULL };
static v_check posts_sp[] = { post_vs, check_le1, NULL };
static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL };
static v_check posts_uc[] = { post_UC, NULL };
-static v_check pres_bline[] = { check_bline, NULL };
-static v_check pres_sec[] = { check_bline, pre_sec, NULL};
+static v_check posts_ur[] = { check_head1, check_part, NULL };
+static v_check pres_sec[] = { pre_sec, NULL };
static const struct man_valid man_valids[MAN_MAX] = {
{ NULL, posts_br }, /* br */
- { pres_bline, posts_th }, /* TH */
+ { NULL, posts_th }, /* TH */
{ pres_sec, posts_sec }, /* SH */
{ pres_sec, posts_sec }, /* SS */
- { pres_bline, NULL }, /* TP */
- { pres_bline, posts_par }, /* LP */
- { pres_bline, posts_par }, /* PP */
- { pres_bline, posts_par }, /* P */
- { pres_bline, NULL }, /* IP */
- { pres_bline, NULL }, /* HP */
+ { NULL, NULL }, /* TP */
+ { NULL, posts_par }, /* LP */
+ { NULL, posts_par }, /* PP */
+ { NULL, posts_par }, /* P */
+ { NULL, posts_ip }, /* IP */
+ { NULL, NULL }, /* HP */
{ NULL, NULL }, /* SM */
{ NULL, NULL }, /* SB */
{ NULL, NULL }, /* BI */
{ NULL, NULL }, /* I */
{ NULL, NULL }, /* IR */
{ NULL, NULL }, /* RI */
- { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
- { NULL, posts_sp }, /* sp */ /* FIXME: should warn only. */
- { pres_bline, posts_nf }, /* nf */
- { pres_bline, posts_fi }, /* fi */
+ { NULL, posts_eq0 }, /* na */
+ { NULL, posts_sp }, /* sp */
+ { NULL, posts_nf }, /* nf */
+ { NULL, posts_fi }, /* fi */
{ NULL, NULL }, /* RE */
{ NULL, posts_part }, /* RS */
{ NULL, NULL }, /* DT */
{ NULL, posts_uc }, /* UC */
- { NULL, NULL }, /* PD */
+ { NULL, posts_le1 }, /* PD */
{ NULL, posts_at }, /* AT */
{ NULL, NULL }, /* in */
{ NULL, posts_ft }, /* ft */
+ { NULL, posts_eq2 }, /* OP */
+ { NULL, posts_nf }, /* EX */
+ { NULL, posts_fi }, /* EE */
+ { NULL, posts_ur }, /* UR */
+ { NULL, NULL }, /* UE */
+ { NULL, NULL }, /* ll */
};
int
-man_valid_pre(struct man *m, struct man_node *n)
+man_valid_pre(struct man *man, struct man_node *n)
{
v_check *cp;
switch (n->type) {
- case (MAN_TEXT):
+ case MAN_TEXT:
/* FALLTHROUGH */
- case (MAN_ROOT):
+ case MAN_ROOT:
/* FALLTHROUGH */
- case (MAN_EQN):
+ case MAN_EQN:
/* FALLTHROUGH */
- case (MAN_TBL):
+ case MAN_TBL:
return(1);
default:
break;
if (NULL == (cp = man_valids[n->tok].pres))
return(1);
for ( ; *cp; cp++)
- if ( ! (*cp)(m, n))
+ if ( ! (*cp)(man, n))
return(0);
return(1);
}
-
int
-man_valid_post(struct man *m)
+man_valid_post(struct man *man)
{
v_check *cp;
- if (MAN_VALID & m->last->flags)
+ if (MAN_VALID & man->last->flags)
return(1);
- m->last->flags |= MAN_VALID;
+ man->last->flags |= MAN_VALID;
- switch (m->last->type) {
- case (MAN_TEXT):
- check_text(m, m->last);
+ switch (man->last->type) {
+ case MAN_TEXT:
+ check_text(man, man->last);
return(1);
- case (MAN_ROOT):
- return(check_root(m, m->last));
- case (MAN_EQN):
+ case MAN_ROOT:
+ return(check_root(man, man->last));
+ case MAN_EQN:
/* FALLTHROUGH */
- case (MAN_TBL):
+ case MAN_TBL:
return(1);
default:
break;
}
- if (NULL == (cp = man_valids[m->last->tok].posts))
+ if (NULL == (cp = man_valids[man->last->tok].posts))
return(1);
for ( ; *cp; cp++)
- if ( ! (*cp)(m, m->last))
+ if ( ! (*cp)(man, man->last))
return(0);
return(1);
}
-
static int
-check_root(CHKARGS)
+check_root(CHKARGS)
{
- if (MAN_BLINE & m->flags)
- man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
- else if (MAN_ELINE & m->flags)
- man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
+ if (MAN_BLINE & man->flags)
+ man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
+ else if (MAN_ELINE & man->flags)
+ man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
- m->flags &= ~MAN_BLINE;
- m->flags &= ~MAN_ELINE;
+ man->flags &= ~MAN_BLINE;
+ man->flags &= ~MAN_ELINE;
- if (NULL == m->first->child) {
- man_nmsg(m, n, MANDOCERR_NODOCBODY);
- return(0);
- } else if (NULL == m->meta.title) {
- man_nmsg(m, n, MANDOCERR_NOTITLE);
+ if (NULL == man->first->child)
+ man_nmsg(man, n, MANDOCERR_DOC_EMPTY);
+ else
+ man->meta.hasbody = 1;
+
+ if (NULL == man->meta.title) {
+ man_nmsg(man, n, MANDOCERR_TH_MISSING);
/*
* If a title hasn't been set, do so now (by
* implication, date and section also aren't set).
*/
- m->meta.title = mandoc_strdup("unknown");
- m->meta.msec = mandoc_strdup("1");
- m->meta.date = mandoc_normdate
- (m->parse, NULL, n->line, n->pos);
+ man->meta.title = mandoc_strdup("unknown");
+ man->meta.msec = mandoc_strdup("1");
+ man->meta.date = man->quick ? mandoc_strdup("") :
+ mandoc_normdate(man->parse, NULL, n->line, n->pos);
}
return(1);
{
char *cp, *p;
- if (MAN_LITERAL & m->flags)
+ if (MAN_LITERAL & man->flags)
return;
cp = n->string;
for (p = cp; NULL != (p = strchr(p, '\t')); p++)
- man_pmsg(m, n->line, (int)(p - cp), MANDOCERR_BADTAB);
+ man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB);
}
#define INEQ_DEFINE(x, ineq, name) \
{ \
if (n->nchild ineq (x)) \
return(1); \
- mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \
- "line arguments %s %d (have %d)", \
- #ineq, (x), n->nchild); \
+ mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
+ "line arguments %s %d (have %d)", \
+ #ineq, (x), n->nchild); \
return(1); \
}
INEQ_DEFINE(0, ==, eq0)
+INEQ_DEFINE(2, ==, eq2)
INEQ_DEFINE(1, <=, le1)
INEQ_DEFINE(2, >=, ge2)
INEQ_DEFINE(5, <=, le5)
+static int
+check_head1(CHKARGS)
+{
+
+ if (MAN_HEAD == n->type && 1 != n->nchild)
+ mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
+ n->pos, "line arguments eq 1 (have %d)", n->nchild);
+
+ return(1);
+}
+
static int
post_ft(CHKARGS)
{
ok = 0;
cp = n->child->string;
switch (*cp) {
- case ('1'):
+ case '1':
/* FALLTHROUGH */
- case ('2'):
+ case '2':
/* FALLTHROUGH */
- case ('3'):
+ case '3':
/* FALLTHROUGH */
- case ('4'):
+ case '4':
/* FALLTHROUGH */
- case ('I'):
+ case 'I':
/* FALLTHROUGH */
- case ('P'):
+ case 'P':
/* FALLTHROUGH */
- case ('R'):
+ case 'R':
if ('\0' == cp[1])
ok = 1;
break;
- case ('B'):
+ case 'B':
if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
ok = 1;
break;
- case ('C'):
+ case 'C':
if ('W' == cp[1] && '\0' == cp[2])
ok = 1;
break;
}
if (0 == ok) {
- mandoc_vmsg
- (MANDOCERR_BADFONT, m->parse,
- n->line, n->pos, "%s", cp);
+ mandoc_vmsg(MANDOCERR_BADFONT, man->parse, n->line,
+ n->pos, "%s", cp);
*cp = '\0';
}
if (1 < n->nchild)
- mandoc_vmsg
- (MANDOCERR_ARGCOUNT, m->parse, n->line,
- n->pos, "want one child (have %d)",
- n->nchild);
+ mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
+ n->pos, "want one child (have %d)", n->nchild);
return(1);
}
{
if (MAN_BLOCK == n->type)
- m->flags &= ~MAN_LITERAL;
+ man->flags &= ~MAN_LITERAL;
return(1);
}
post_sec(CHKARGS)
{
- if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
+ if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
return(1);
- man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
+ man_nmsg(man, n, MANDOCERR_SYNTARGCOUNT);
return(0);
}
{
if (MAN_BODY == n->type && 0 == n->nchild)
- mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line,
- n->pos, "want children (have none)");
+ mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
+ n->pos, "want children (have none)");
return(1);
}
-
static int
check_par(CHKARGS)
{
switch (n->type) {
- case (MAN_BLOCK):
+ case MAN_BLOCK:
if (0 == n->body->nchild)
- man_node_delete(m, n);
+ man_node_delete(man, n);
break;
- case (MAN_BODY):
+ case MAN_BODY:
if (0 == n->nchild)
- man_nmsg(m, n, MANDOCERR_IGNPAR);
+ man_nmsg(man, n, MANDOCERR_IGNPAR);
break;
- case (MAN_HEAD):
+ case MAN_HEAD:
if (n->nchild)
- man_nmsg(m, n, MANDOCERR_ARGSLOST);
+ man_nmsg(man, n, MANDOCERR_ARGSLOST);
break;
default:
break;
return(1);
}
-
static int
-check_bline(CHKARGS)
+post_IP(CHKARGS)
{
- assert( ! (MAN_ELINE & m->flags));
- if (MAN_BLINE & m->flags) {
- man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
- return(0);
+ switch (n->type) {
+ case MAN_BLOCK:
+ if (0 == n->head->nchild && 0 == n->body->nchild)
+ man_node_delete(man, n);
+ break;
+ case MAN_BODY:
+ if (0 == n->parent->head->nchild && 0 == n->nchild)
+ man_nmsg(man, n, MANDOCERR_IGNPAR);
+ break;
+ default:
+ break;
}
-
return(1);
}
static int
post_TH(CHKARGS)
{
+ struct man_node *nb;
const char *p;
- int line, pos;
-
- if (m->meta.title)
- free(m->meta.title);
- if (m->meta.vol)
- free(m->meta.vol);
- if (m->meta.source)
- free(m->meta.source);
- if (m->meta.msec)
- free(m->meta.msec);
- if (m->meta.date)
- free(m->meta.date);
-
- line = n->line;
- pos = n->pos;
- m->meta.title = m->meta.vol = m->meta.date =
- m->meta.msec = m->meta.source = NULL;
+
+ free(man->meta.title);
+ free(man->meta.vol);
+ free(man->meta.source);
+ free(man->meta.msec);
+ free(man->meta.date);
+
+ man->meta.title = man->meta.vol = man->meta.date =
+ man->meta.msec = man->meta.source = NULL;
+
+ nb = n;
/* ->TITLE<- MSEC DATE SOURCE VOL */
if (n && n->string) {
for (p = n->string; '\0' != *p; p++) {
/* Only warn about this once... */
- if (isalpha((unsigned char)*p) &&
- ! isupper((unsigned char)*p)) {
- man_nmsg(m, n, MANDOCERR_UPPERCASE);
+ if (isalpha((unsigned char)*p) &&
+ ! isupper((unsigned char)*p)) {
+ man_nmsg(man, n, MANDOCERR_TITLE_CASE);
break;
}
}
- m->meta.title = mandoc_strdup(n->string);
+ man->meta.title = mandoc_strdup(n->string);
} else
- m->meta.title = mandoc_strdup("");
+ man->meta.title = mandoc_strdup("");
/* TITLE ->MSEC<- DATE SOURCE VOL */
if (n)
n = n->next;
if (n && n->string)
- m->meta.msec = mandoc_strdup(n->string);
+ man->meta.msec = mandoc_strdup(n->string);
else
- m->meta.msec = mandoc_strdup("");
+ man->meta.msec = mandoc_strdup("");
/* TITLE MSEC ->DATE<- SOURCE VOL */
if (n)
n = n->next;
if (n && n->string && '\0' != n->string[0]) {
- pos = n->pos;
- m->meta.date = mandoc_normdate
- (m->parse, n->string, line, pos);
- } else
- m->meta.date = mandoc_strdup("");
+ man->meta.date = man->quick ?
+ mandoc_strdup(n->string) :
+ mandoc_normdate(man->parse, n->string,
+ n->line, n->pos);
+ } else {
+ man->meta.date = mandoc_strdup("");
+ man_nmsg(man, n ? n : nb, MANDOCERR_DATE_MISSING);
+ }
/* TITLE MSEC DATE ->SOURCE<- VOL */
if (n && (n = n->next))
- m->meta.source = mandoc_strdup(n->string);
+ man->meta.source = mandoc_strdup(n->string);
/* TITLE MSEC DATE SOURCE ->VOL<- */
+ /* If missing, use the default VOL name for MSEC. */
if (n && (n = n->next))
- m->meta.vol = mandoc_strdup(n->string);
+ man->meta.vol = mandoc_strdup(n->string);
+ else if ('\0' != man->meta.msec[0] &&
+ (NULL != (p = mandoc_a2msec(man->meta.msec))))
+ man->meta.vol = mandoc_strdup(p);
/*
* Remove the `TH' node after we've processed it for our
* meta-data.
*/
- man_node_delete(m, m->last);
+ man_node_delete(man, man->last);
return(1);
}
post_nf(CHKARGS)
{
- if (MAN_LITERAL & m->flags)
- man_nmsg(m, n, MANDOCERR_SCOPEREP);
+ if (MAN_LITERAL & man->flags)
+ man_nmsg(man, n, MANDOCERR_SCOPEREP);
- m->flags |= MAN_LITERAL;
+ man->flags |= MAN_LITERAL;
return(1);
}
post_fi(CHKARGS)
{
- if ( ! (MAN_LITERAL & m->flags))
- man_nmsg(m, n, MANDOCERR_WNOSCOPE);
+ if ( ! (MAN_LITERAL & man->flags))
+ man_nmsg(man, n, MANDOCERR_WNOSCOPE);
- m->flags &= ~MAN_LITERAL;
+ man->flags &= ~MAN_LITERAL;
return(1);
}
p = bsd_versions[0];
}
- if (m->meta.source)
- free(m->meta.source);
-
- m->meta.source = mandoc_strdup(p);
+ free(man->meta.source);
+ man->meta.source = mandoc_strdup(p);
return(1);
}
p = unix_versions[0];
}
- if (m->meta.source)
- free(m->meta.source);
-
- m->meta.source = mandoc_strdup(p);
+ free(man->meta.source);
+ man->meta.source = mandoc_strdup(p);
return(1);
}
post_vs(CHKARGS)
{
- /*
- * Don't warn about this because it occurs in pod2man and would
- * cause considerable (unfixable) warnage.
- */
- if (NULL == n->prev && MAN_ROOT == n->parent->type)
- man_node_delete(m, n);
+ if (NULL != n->prev)
+ return(1);
+
+ switch (n->parent->tok) {
+ case MAN_SH:
+ /* FALLTHROUGH */
+ case MAN_SS:
+ man_nmsg(man, n, MANDOCERR_IGNPAR);
+ /* FALLTHROUGH */
+ case MAN_MAX:
+ /*
+ * Don't warn about this because it occurs in pod2man
+ * and would cause considerable (unfixable) warnage.
+ */
+ man_node_delete(man, n);
+ break;
+ default:
+ break;
+ }
return(1);
}
git.ckatri.com / mandoc.git / blobdiff