-/* $Id: man_validate.c,v 1.45 2010/06/28 14:39:17 kristaps Exp $ */
+/* $Id: man_validate.c,v 1.57 2011/01/01 12:59:17 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
#include <limits.h>
#include <stdarg.h>
#include <stdlib.h>
+#include <string.h>
+#include <time.h>
#include "mandoc.h"
#include "libman.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_text(CHKARGS);
static int check_title(CHKARGS);
+static int post_AT(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_eq0[] = { check_eq0, NULL };
-static v_check posts_th[] = { check_ge2, check_le5, check_title, 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_le1[] = { check_le1, NULL };
+static v_check posts_th[] = { check_ge2, check_le5, check_title, 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 */
{ pres_bline, posts_th }, /* TH */
{ NULL, NULL }, /* I */
{ NULL, NULL }, /* IR */
{ NULL, NULL }, /* RI */
- { NULL, posts_eq0 }, /* na */
- { NULL, NULL }, /* i */
- { NULL, posts_le1 }, /* sp */
- { pres_bline, posts_eq0 }, /* nf */
- { pres_bline, posts_eq0 }, /* fi */
- { NULL, NULL }, /* r */
+ { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
+ { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
+ { pres_bline, posts_nf }, /* nf */
+ { pres_bline, posts_fi }, /* fi */
{ NULL, NULL }, /* RE */
{ NULL, posts_part }, /* RS */
{ NULL, NULL }, /* DT */
- { NULL, NULL }, /* UC */
+ { NULL, posts_uc }, /* UC */
{ NULL, NULL }, /* PD */
- { NULL, posts_le1 }, /* Sp */
- { pres_bline, posts_le1 }, /* Vb */
- { pres_bline, posts_eq0 }, /* Ve */
- { NULL, NULL }, /* AT */
+ { 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_TBL):
return(1);
+ default:
+ break;
+ }
if (NULL == (cp = man_valids[n->tok].pres))
return(1);
return(check_text(m, m->last));
case (MAN_ROOT):
return(check_root(m, m->last));
+ case (MAN_TBL):
+ return(1);
default:
break;
}
{
if (MAN_BLINE & m->flags)
- return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
- if (MAN_ELINE & m->flags)
- return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));
+ man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
+ else if (MAN_ELINE & m->flags)
+ man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
m->flags &= ~MAN_BLINE;
m->flags &= ~MAN_ELINE;
man_nmsg(m, n, MANDOCERR_NODOCBODY);
return(0);
} else if (NULL == m->meta.title) {
- if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE))
- return(0);
+ man_nmsg(m, n, MANDOCERR_NOTITLE);
+
/*
* If a title hasn't been set, do so now (by
* implication, date and section also aren't set).
- *
- * FIXME: this should be in man_action.c.
*/
+
m->meta.title = mandoc_strdup("unknown");
m->meta.date = time(NULL);
m->meta.msec = mandoc_strdup("1");
}
for (p = n->child->string; '\0' != *p; p++)
- if (isalpha((u_char)*p) && ! isupper((u_char)*p))
- if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE))
- return(0);
+ /* Only warn about this once... */
+ if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
+ man_nmsg(m, n, MANDOCERR_UPPERCASE);
+ break;
+ }
return(1);
}
{
char *p;
int pos, c;
-
- assert(n->string);
+ size_t sz;
for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
- if ('\\' == *p) {
- c = mandoc_special(p);
- if (c) {
- p += c - 1;
- pos += c - 1;
- continue;
- }
+ sz = strcspn(p, "\t\\");
+ p += (int)sz;
- c = man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
- if ( ! (MAN_IGN_ESCAPE & m->pflags) && ! c)
- return(c);
- }
+ if ('\0' == *p)
+ break;
- /*
- * FIXME: we absolutely cannot let \b get through or it
- * will destroy some assumptions in terms of format.
- */
+ pos += (int)sz;
- if ('\t' == *p || isprint((u_char)*p) || ASCII_HYPH == *p)
- continue;
- if ( ! man_pmsg(m, n->line, pos, MANDOCERR_BADCHAR))
+ if ('\t' == *p) {
+ if (MAN_LITERAL & m->flags)
+ continue;
+ if (man_pmsg(m, n->line, pos, MANDOCERR_BADTAB))
+ continue;
return(0);
+ }
+
+ /* Check the special character. */
+
+ c = mandoc_special(p);
+ if (c) {
+ p += c - 1;
+ pos += c - 1;
+ } else
+ man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
}
return(1);
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) {
+ man_vmsg(m, MANDOCERR_BADFONT,
+ n->line, n->pos, "%s", cp);
+ *cp = '\0';
+ }
+
+ if (1 < n->nchild)
+ man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos,
+ "want one child (have %d)", n->nchild);
+
+ return(1);
+}
static int
check_sec(CHKARGS)
man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
return(0);
} else if (MAN_BODY == n->type && 0 == n->nchild)
- return(man_nmsg(m, n, MANDOCERR_NOBODY));
+ man_nmsg(m, n, MANDOCERR_NOBODY);
return(1);
}
{
if (MAN_BODY == n->type && 0 == n->nchild)
- return(man_nmsg(m, n, MANDOCERR_NOBODY));
+ man_nmsg(m, n, MANDOCERR_NOBODY);
+
return(1);
}
/* Body-less lists are ok. */
break;
default:
- if (n->nchild)
- break;
- return(man_nmsg(m, n, MANDOCERR_NOBODY));
+ if (0 == n->nchild)
+ man_nmsg(m, n, MANDOCERR_NOBODY);
+ break;
}
if (MAN_HEAD == n->type)
switch (n->tok) {
case (MAN_P):
/* FALLTHROUGH */
case (MAN_LP):
- if (0 == n->nchild)
- break;
- return(man_nmsg(m, n, MANDOCERR_ARGSLOST));
- default:
if (n->nchild)
- break;
- return(man_nmsg(m, n, MANDOCERR_NOARGS));
+ man_nmsg(m, n, MANDOCERR_ARGSLOST);
+ break;
+ default:
+ break;
}
return(1);
return(1);
}
+static int
+post_TH(CHKARGS)
+{
+
+ 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.rawdate)
+ free(m->meta.rawdate);
+
+ m->meta.title = m->meta.vol = m->meta.rawdate =
+ 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);
+
+ /* TITLE ->MSEC<- DATE SOURCE VOL */
+
+ n = n->next;
+ assert(n);
+ m->meta.msec = mandoc_strdup(n->string);
+
+ /* 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);
+
+ /* TITLE MSEC DATE ->SOURCE<- VOL */
+
+ if (n && (n = n->next))
+ m->meta.source = mandoc_strdup(n->string);
+
+ /* TITLE MSEC DATE SOURCE ->VOL<- */
+
+ if (n && (n = n->next))
+ m->meta.vol = mandoc_strdup(n->string);
+
+ /*
+ * Remove the `TH' node after we've processed it for our
+ * meta-data.
+ */
+ man_node_delete(m, m->last);
+ return(1);
+}
+
+static int
+post_nf(CHKARGS)
+{
+
+ if (MAN_LITERAL & m->flags)
+ man_nmsg(m, n, MANDOCERR_SCOPEREP);
+
+ m->flags |= MAN_LITERAL;
+ return(1);
+}
+
+static int
+post_fi(CHKARGS)
+{
+
+ if ( ! (MAN_LITERAL & m->flags))
+ man_nmsg(m, n, MANDOCERR_NOSCOPE);
+
+ m->flags &= ~MAN_LITERAL;
+ return(1);
+}
+
+static int
+post_UC(CHKARGS)
+{
+ static const char * const bsd_versions[] = {
+ "3rd Berkeley Distribution",
+ "4th Berkeley Distribution",
+ "4.2 Berkeley Distribution",
+ "4.3 Berkeley Distribution",
+ "4.4 Berkeley Distribution",
+ };
+
+ const char *p, *s;
+
+ n = n->child;
+ n = m->last->child;
+
+ if (NULL == n || MAN_TEXT != n->type)
+ p = bsd_versions[0];
+ else {
+ s = n->string;
+ if (0 == strcmp(s, "3"))
+ p = bsd_versions[0];
+ else if (0 == strcmp(s, "4"))
+ p = bsd_versions[1];
+ else if (0 == strcmp(s, "5"))
+ p = bsd_versions[2];
+ else if (0 == strcmp(s, "6"))
+ p = bsd_versions[3];
+ else if (0 == strcmp(s, "7"))
+ p = bsd_versions[4];
+ else
+ p = bsd_versions[0];
+ }
+
+ if (m->meta.source)
+ free(m->meta.source);
+
+ m->meta.source = mandoc_strdup(p);
+ return(1);
+}
+
+static int
+post_AT(CHKARGS)
+{
+ static const char * const unix_versions[] = {
+ "7th Edition",
+ "System III",
+ "System V",
+ "System V Release 2",
+ };
+
+ const char *p, *s;
+ struct man_node *nn;
+
+ n = n->child;
+
+ if (NULL == n || MAN_TEXT != n->type)
+ p = unix_versions[0];
+ else {
+ s = n->string;
+ if (0 == strcmp(s, "3"))
+ p = unix_versions[0];
+ else if (0 == strcmp(s, "4"))
+ p = unix_versions[1];
+ else if (0 == strcmp(s, "5")) {
+ nn = n->next;
+ if (nn && MAN_TEXT == nn->type && nn->string[0])
+ p = unix_versions[3];
+ else
+ p = unix_versions[2];
+ } else
+ p = unix_versions[0];
+ }
+
+ if (m->meta.source)
+ free(m->meta.source);
+
+ m->meta.source = mandoc_strdup(p);
+ return(1);
+}