-/* $Id: man_validate.c,v 1.54 2010/12/06 13:56:56 kristaps Exp $ */
+/* $Id: man_validate.c,v 1.71 2011/07/24 18:15:14 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 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 <string.h>
#include <time.h>
+#include "man.h"
#include "mandoc.h"
#include "libman.h"
#include "libmandoc.h"
static int check_bline(CHKARGS);
static int check_eq0(CHKARGS);
+static int check_ft(CHKARGS);
static int check_le1(CHKARGS);
static int check_ge2(CHKARGS);
static int check_le5(CHKARGS);
static int check_part(CHKARGS);
static int check_root(CHKARGS);
static int check_sec(CHKARGS);
-static int check_text(CHKARGS);
-static int check_title(CHKARGS);
+static void check_text(CHKARGS);
static int post_AT(CHKARGS);
+static int post_vs(CHKARGS);
static int post_fi(CHKARGS);
static int post_nf(CHKARGS);
static int post_TH(CHKARGS);
static int post_UC(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_fi[] = { check_eq0, post_fi, NULL };
-static v_check posts_le1[] = { check_le1, NULL };
+static v_check posts_ft[] = { check_ft, 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_sec[] = { check_sec, NULL };
-static v_check posts_th[] = { check_ge2, check_le5, check_title, post_TH, 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 const struct man_valid man_valids[MAN_MAX] = {
- { NULL, posts_eq0 }, /* br */
+ { NULL, posts_br }, /* br */
{ pres_bline, posts_th }, /* TH */
{ pres_bline, posts_sec }, /* SH */
{ pres_bline, posts_sec }, /* SS */
- { pres_bline, posts_par }, /* TP */
+ { pres_bline, NULL }, /* TP */
{ pres_bline, posts_par }, /* LP */
{ pres_bline, posts_par }, /* PP */
{ pres_bline, posts_par }, /* P */
- { pres_bline, posts_par }, /* IP */
- { pres_bline, posts_par }, /* HP */
+ { pres_bline, NULL }, /* IP */
+ { pres_bline, NULL }, /* HP */
{ NULL, NULL }, /* SM */
{ NULL, NULL }, /* SB */
{ NULL, NULL }, /* BI */
{ NULL, NULL }, /* IR */
{ NULL, NULL }, /* RI */
{ NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
- { NULL, NULL }, /* i */
- { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
+ { NULL, posts_sp }, /* sp */ /* FIXME: should warn only. */
{ pres_bline, posts_nf }, /* nf */
{ pres_bline, posts_fi }, /* fi */
- { NULL, NULL }, /* r */
{ NULL, NULL }, /* RE */
{ NULL, posts_part }, /* RS */
{ NULL, NULL }, /* DT */
{ NULL, NULL }, /* PD */
{ NULL, posts_at }, /* AT */
{ NULL, NULL }, /* in */
+ { NULL, posts_ft }, /* ft */
};
{
v_check *cp;
- if (MAN_TEXT == n->type)
- return(1);
- if (MAN_ROOT == n->type)
+ switch (n->type) {
+ case (MAN_TEXT):
+ /* FALLTHROUGH */
+ case (MAN_ROOT):
+ /* FALLTHROUGH */
+ case (MAN_EQN):
+ /* FALLTHROUGH */
+ case (MAN_TBL):
return(1);
+ default:
+ break;
+ }
if (NULL == (cp = man_valids[n->tok].pres))
return(1);
switch (m->last->type) {
case (MAN_TEXT):
- return(check_text(m, m->last));
+ check_text(m, m->last);
+ return(1);
case (MAN_ROOT):
return(check_root(m, m->last));
+ case (MAN_EQN):
+ /* FALLTHROUGH */
+ case (MAN_TBL):
+ return(1);
default:
break;
}
*/
m->meta.title = mandoc_strdup("unknown");
- m->meta.date = time(NULL);
m->meta.msec = mandoc_strdup("1");
+ m->meta.date = mandoc_normdate
+ (m->parse, NULL, n->line, n->pos);
}
return(1);
}
-
-static int
-check_title(CHKARGS)
-{
- const char *p;
-
- assert(n->child);
- /* FIXME: is this sufficient? */
- if ('\0' == *n->child->string) {
- man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
- return(0);
- }
-
- for (p = n->child->string; '\0' != *p; p++)
- /* Only warn about this once... */
- if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
- man_nmsg(m, n, MANDOCERR_UPPERCASE);
- break;
- }
-
- return(1);
-}
-
-
-static int
+static void
check_text(CHKARGS)
{
- char *p;
- int pos, c;
+ char *p, *pp, *cpp;
+ int pos;
size_t sz;
- for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
+ p = n->string;
+ pos = n->pos + 1;
+
+ while ('\0' != *p) {
sz = strcspn(p, "\t\\");
+
p += (int)sz;
+ pos += (int)sz;
- if ('\0' == *p)
+ if ('\t' == *p) {
+ if ( ! (MAN_LITERAL & m->flags))
+ man_pmsg(m, n->line, pos, MANDOCERR_BADTAB);
+ p++;
+ pos++;
+ continue;
+ } else if ('\0' == *p)
break;
- pos += (int)sz;
+ pos++;
+ pp = ++p;
- if ('\t' == *p) {
- if (MAN_LITERAL & m->flags)
- continue;
- if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
- continue;
- return(0);
+ if (ESCAPE_ERROR == mandoc_escape
+ ((const char **)&pp, NULL, NULL)) {
+ man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
+ break;
}
- /* Check the special character. */
+ cpp = p;
+ while (NULL != (cpp = memchr(cpp, ASCII_HYPH, pp - cpp)))
+ *cpp = '-';
- c = mandoc_special(p);
- if (c) {
- p += c - 1;
- pos += c - 1;
- } else
- man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
+ pos += pp - p;
+ p = pp;
}
-
- return(1);
}
-
#define INEQ_DEFINE(x, ineq, name) \
static int \
check_##name(CHKARGS) \
{ \
if (n->nchild ineq (x)) \
return(1); \
- man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \
+ mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \
"line arguments %s %d (have %d)", \
#ineq, (x), n->nchild); \
- return(0); \
+ return(1); \
}
INEQ_DEFINE(0, ==, eq0)
INEQ_DEFINE(2, >=, ge2)
INEQ_DEFINE(5, <=, le5)
+static int
+check_ft(CHKARGS)
+{
+ char *cp;
+ int ok;
+
+ if (0 == n->nchild)
+ return(1);
+
+ ok = 0;
+ cp = n->child->string;
+ switch (*cp) {
+ case ('1'):
+ /* FALLTHROUGH */
+ case ('2'):
+ /* FALLTHROUGH */
+ case ('3'):
+ /* FALLTHROUGH */
+ case ('4'):
+ /* FALLTHROUGH */
+ case ('I'):
+ /* FALLTHROUGH */
+ case ('P'):
+ /* FALLTHROUGH */
+ case ('R'):
+ if ('\0' == cp[1])
+ ok = 1;
+ break;
+ case ('B'):
+ if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
+ ok = 1;
+ break;
+ case ('C'):
+ if ('W' == cp[1] && '\0' == cp[2])
+ ok = 1;
+ break;
+ default:
+ break;
+ }
+
+ if (0 == ok) {
+ mandoc_vmsg
+ (MANDOCERR_BADFONT, m->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);
+
+ return(1);
+}
static int
check_sec(CHKARGS)
{
- if (MAN_HEAD == n->type && 0 == n->nchild) {
- man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
- return(0);
- } else if (MAN_BODY == n->type && 0 == n->nchild)
- man_nmsg(m, n, MANDOCERR_NOBODY);
+ if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
+ return(1);
- return(1);
+ man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
+ return(0);
}
{
if (MAN_BODY == n->type && 0 == n->nchild)
- man_nmsg(m, n, MANDOCERR_NOBODY);
+ mandoc_msg(MANDOCERR_ARGCWARN, m->parse, n->line,
+ n->pos, "want children (have none)");
return(1);
}
check_par(CHKARGS)
{
- if (MAN_BODY == n->type)
- switch (n->tok) {
- case (MAN_IP):
- /* FALLTHROUGH */
- case (MAN_HP):
- /* FALLTHROUGH */
- case (MAN_TP):
- /* Body-less lists are ok. */
- break;
- default:
- if (0 == n->nchild)
- man_nmsg(m, n, MANDOCERR_NOBODY);
- break;
- }
- if (MAN_HEAD == n->type)
- switch (n->tok) {
- case (MAN_PP):
- /* FALLTHROUGH */
- case (MAN_P):
- /* FALLTHROUGH */
- case (MAN_LP):
- if (n->nchild)
- man_nmsg(m, n, MANDOCERR_ARGSLOST);
- break;
- default:
- break;
- }
+ switch (n->type) {
+ case (MAN_BLOCK):
+ if (0 == n->body->nchild)
+ man_node_delete(m, n);
+ break;
+ case (MAN_BODY):
+ if (0 == n->nchild)
+ man_nmsg(m, n, MANDOCERR_IGNPAR);
+ break;
+ case (MAN_HEAD):
+ if (n->nchild)
+ man_nmsg(m, n, MANDOCERR_ARGSLOST);
+ break;
+ default:
+ break;
+ }
return(1);
}
static int
post_TH(CHKARGS)
{
+ const char *p;
+ int line, pos;
if (m->meta.title)
free(m->meta.title);
free(m->meta.source);
if (m->meta.msec)
free(m->meta.msec);
- if (m->meta.rawdate)
- free(m->meta.rawdate);
+ if (m->meta.date)
+ free(m->meta.date);
- m->meta.title = m->meta.vol = m->meta.rawdate =
+ line = n->line;
+ pos = n->pos;
+ m->meta.title = m->meta.vol = m->meta.date =
m->meta.msec = m->meta.source = NULL;
- m->meta.date = 0;
/* ->TITLE<- MSEC DATE SOURCE VOL */
n = n->child;
- assert(n);
- m->meta.title = mandoc_strdup(n->string);
+ 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);
+ break;
+ }
+ }
+ m->meta.title = mandoc_strdup(n->string);
+ } else
+ m->meta.title = mandoc_strdup("");
/* TITLE ->MSEC<- DATE SOURCE VOL */
- n = n->next;
- assert(n);
- m->meta.msec = mandoc_strdup(n->string);
+ if (n)
+ n = n->next;
+ if (n && n->string)
+ m->meta.msec = mandoc_strdup(n->string);
+ else
+ m->meta.msec = mandoc_strdup("");
/* TITLE MSEC ->DATE<- SOURCE VOL */
- /*
- * Try to parse the date. If this works, stash the epoch (this
- * is optimal because we can reformat it in the canonical form).
- * If it doesn't parse, isn't specified at all, or is an empty
- * string, then use the current date.
- */
-
- n = n->next;
- if (n && n->string && *n->string) {
- m->meta.date = mandoc_a2time
- (MTIME_ISO_8601, n->string);
- if (0 == m->meta.date) {
- man_nmsg(m, n, MANDOCERR_BADDATE);
- m->meta.rawdate = mandoc_strdup(n->string);
- }
- } else
- m->meta.date = time(NULL);
+ if (n)
+ n = n->next;
+ if (n)
+ pos = n->pos;
+ m->meta.date = mandoc_normdate
+ (m->parse, n ? n->string : NULL, line, pos);
/* TITLE MSEC DATE ->SOURCE<- VOL */
{
if ( ! (MAN_LITERAL & m->flags))
- man_nmsg(m, n, MANDOCERR_NOSCOPE);
+ man_nmsg(m, n, MANDOCERR_WNOSCOPE);
m->flags &= ~MAN_LITERAL;
return(1);
m->meta.source = mandoc_strdup(p);
return(1);
}
+
+static int
+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);
+
+ return(1);
+}