-/* $Id: man_validate.c,v 1.33 2010/03/29 10:10:35 kristaps Exp $ */
+/* $OpenBSD$ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2012-2017 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
* copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#ifdef HAVE_CONFIG_H
#include "config.h"
-#endif
#include <sys/types.h>
#include <limits.h>
#include <stdarg.h>
#include <stdlib.h>
+#include <string.h>
+#include <time.h>
-#include "libman.h"
+#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"
#include "libmandoc.h"
+#include "roff_int.h"
+#include "libman.h"
-#define CHKARGS struct man *m, const struct man_node *n
-
-typedef int (*v_check)(CHKARGS);
-
-struct man_valid {
- v_check *pres;
- v_check *posts;
-};
-
-static int check_bline(CHKARGS);
-static int check_eq0(CHKARGS);
-static int check_le1(CHKARGS);
-static int check_ge2(CHKARGS);
-static int check_le5(CHKARGS);
-static int check_par(CHKARGS);
-static int check_part(CHKARGS);
-static int check_roff(CHKARGS);
-static int check_root(CHKARGS);
-static int check_sec(CHKARGS);
-static int check_text(CHKARGS);
-static int check_title(CHKARGS);
-
-static v_check posts_eq0[] = { check_eq0, NULL };
-static v_check posts_th[] = { check_ge2, check_le5, check_title, 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 pres_bline[] = { check_bline, NULL };
-static v_check pres_roff[] = { check_roff, NULL };
-
-static const struct man_valid man_valids[MAN_MAX] = {
- { NULL, posts_eq0 }, /* br */
- { pres_bline, posts_th }, /* TH */
- { pres_bline, posts_sec }, /* SH */
- { pres_bline, posts_sec }, /* SS */
- { pres_bline, posts_par }, /* 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 */
- { NULL, NULL }, /* SM */
- { NULL, NULL }, /* SB */
- { NULL, NULL }, /* BI */
- { NULL, NULL }, /* IB */
- { NULL, NULL }, /* BR */
- { NULL, NULL }, /* RB */
- { NULL, NULL }, /* R */
- { NULL, NULL }, /* B */
- { 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, NULL }, /* RE */
- { NULL, posts_part }, /* RS */
- { NULL, NULL }, /* DT */
- { NULL, NULL }, /* UC */
- { NULL, NULL }, /* PD */
- { NULL, posts_eq0 }, /* Sp */
- { pres_bline, posts_le1 }, /* Vb */
- { pres_bline, posts_eq0 }, /* Ve */
- { pres_roff, NULL }, /* de */
- { pres_roff, NULL }, /* dei */
- { pres_roff, NULL }, /* am */
- { pres_roff, NULL }, /* ami */
- { pres_roff, NULL }, /* ig */
- { NULL, NULL }, /* . */
+#define CHKARGS struct roff_man *man, struct roff_node *n
+
+typedef void (*v_check)(CHKARGS);
+
+static void check_par(CHKARGS);
+static void check_part(CHKARGS);
+static void check_root(CHKARGS);
+static void check_text(CHKARGS);
+
+static void post_AT(CHKARGS);
+static void post_IP(CHKARGS);
+static void post_OP(CHKARGS);
+static void post_TH(CHKARGS);
+static void post_UC(CHKARGS);
+static void post_UR(CHKARGS);
+static void post_in(CHKARGS);
+static void post_vs(CHKARGS);
+
+static const v_check __man_valids[MAN_MAX - MAN_TH] = {
+ post_TH, /* TH */
+ NULL, /* SH */
+ NULL, /* SS */
+ NULL, /* TP */
+ check_par, /* LP */
+ check_par, /* PP */
+ check_par, /* P */
+ post_IP, /* IP */
+ NULL, /* HP */
+ NULL, /* SM */
+ NULL, /* SB */
+ NULL, /* BI */
+ NULL, /* IB */
+ NULL, /* BR */
+ NULL, /* RB */
+ NULL, /* R */
+ NULL, /* B */
+ NULL, /* I */
+ NULL, /* IR */
+ NULL, /* RI */
+ NULL, /* nf */
+ NULL, /* fi */
+ NULL, /* RE */
+ check_part, /* RS */
+ NULL, /* DT */
+ post_UC, /* UC */
+ NULL, /* PD */
+ post_AT, /* AT */
+ post_in, /* in */
+ post_OP, /* OP */
+ NULL, /* EX */
+ NULL, /* EE */
+ post_UR, /* UR */
+ NULL, /* UE */
+ post_UR, /* MT */
+ NULL, /* ME */
};
+static const v_check *man_valids = __man_valids - MAN_TH;
-int
-man_valid_pre(struct man *m, const struct man_node *n)
+void
+man_node_validate(struct roff_man *man)
{
- v_check *cp;
-
- if (MAN_TEXT == n->type)
- return(1);
- if (MAN_ROOT == n->type)
- return(1);
-
- if (NULL == (cp = man_valids[n->tok].pres))
- return(1);
- for ( ; *cp; cp++)
- if ( ! (*cp)(m, n))
- return(0);
- return(1);
-}
+ struct roff_node *n;
+ const v_check *cp;
+
+ n = man->last;
+ man->last = man->last->child;
+ while (man->last != NULL) {
+ man_node_validate(man);
+ if (man->last == n)
+ man->last = man->last->child;
+ else
+ man->last = man->last->next;
+ }
+ man->last = n;
+ man->next = ROFF_NEXT_SIBLING;
+ switch (n->type) {
+ case ROFFT_TEXT:
+ check_text(man, n);
+ break;
+ case ROFFT_ROOT:
+ check_root(man, n);
+ break;
+ case ROFFT_EQN:
+ case ROFFT_TBL:
+ break;
+ default:
+ if (n->tok < ROFF_MAX) {
+ switch (n->tok) {
+ case ROFF_br:
+ case ROFF_sp:
+ post_vs(man, n);
+ break;
+ default:
+ roff_validate(man);
+ break;
+ }
+ break;
+ }
+ assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
+ cp = man_valids + n->tok;
+ if (*cp)
+ (*cp)(man, n);
+ if (man->last == n)
+ man_state(man, n);
+ break;
+ }
+}
-int
-man_valid_post(struct man *m)
+static void
+check_root(CHKARGS)
{
- v_check *cp;
- if (MAN_VALID & m->last->flags)
- return(1);
- m->last->flags |= MAN_VALID;
+ assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
- switch (m->last->type) {
- case (MAN_TEXT):
- return(check_text(m, m->last));
- case (MAN_ROOT):
- return(check_root(m, m->last));
- default:
- break;
- }
+ if (NULL == man->first->child)
+ mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
+ n->line, n->pos, NULL);
+ else
+ man->meta.hasbody = 1;
- if (NULL == (cp = man_valids[m->last->tok].posts))
- return(1);
- for ( ; *cp; cp++)
- if ( ! (*cp)(m, m->last))
- return(0);
+ if (NULL == man->meta.title) {
+ mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
+ n->line, n->pos, NULL);
- return(1);
-}
+ /*
+ * If a title hasn't been set, do so now (by
+ * implication, date and section also aren't set).
+ */
+ man->meta.title = mandoc_strdup("");
+ man->meta.msec = mandoc_strdup("");
+ man->meta.date = man->quick ? mandoc_strdup("") :
+ mandoc_normdate(man, NULL, n->line, n->pos);
+ }
+
+ if (man->meta.os_e &&
+ (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
+ mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0,
+ man->meta.os_e == MANDOC_OS_OPENBSD ?
+ "(OpenBSD)" : "(NetBSD)");
+}
-static int
-check_root(CHKARGS)
+static void
+check_text(CHKARGS)
{
+ char *cp, *p;
- if (MAN_BLINE & m->flags)
- return(man_nwarn(m, n, WEXITSCOPE));
- if (MAN_ELINE & m->flags)
- return(man_nwarn(m, n, WEXITSCOPE));
+ if (MAN_LITERAL & man->flags)
+ return;
- m->flags &= ~MAN_BLINE;
- m->flags &= ~MAN_ELINE;
+ cp = n->string;
+ for (p = cp; NULL != (p = strchr(p, '\t')); p++)
+ mandoc_msg(MANDOCERR_FI_TAB, man->parse,
+ n->line, n->pos + (p - cp), NULL);
+}
- if (NULL == m->first->child)
- return(man_nerr(m, n, WNODATA));
- if (NULL == m->meta.title)
- return(man_nerr(m, n, WNOTITLE));
+static void
+post_OP(CHKARGS)
+{
- return(1);
+ if (n->child == NULL)
+ mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
+ n->line, n->pos, "OP");
+ else if (n->child->next != NULL && n->child->next->next != NULL) {
+ n = n->child->next->next;
+ mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+ n->line, n->pos, "OP ... %s", n->string);
+ }
}
+static void
+post_UR(CHKARGS)
+{
-static int
-check_title(CHKARGS)
+ if (n->type == ROFFT_HEAD && n->child == NULL)
+ mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
+ n->line, n->pos, roff_name[n->tok]);
+ check_part(man, n);
+}
+
+static void
+check_part(CHKARGS)
{
- const char *p;
- assert(n->child);
- if ('\0' == *n->child->string)
- return(man_nerr(m, n, WNOTITLE));
+ if (n->type == ROFFT_BODY && n->child == NULL)
+ mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
+ n->line, n->pos, roff_name[n->tok]);
+}
- for (p = n->child->string; '\0' != *p; p++)
- if (isalpha((u_char)*p) && ! isupper((u_char)*p))
- if ( ! man_nwarn(m, n, WTITLECASE))
- return(0);
+static void
+check_par(CHKARGS)
+{
- return(1);
+ switch (n->type) {
+ case ROFFT_BLOCK:
+ if (n->body->child == NULL)
+ roff_node_delete(man, n);
+ break;
+ case ROFFT_BODY:
+ if (n->child == NULL)
+ mandoc_vmsg(MANDOCERR_PAR_SKIP,
+ man->parse, n->line, n->pos,
+ "%s empty", roff_name[n->tok]);
+ break;
+ case ROFFT_HEAD:
+ if (n->child != NULL)
+ mandoc_vmsg(MANDOCERR_ARG_SKIP,
+ man->parse, n->line, n->pos, "%s %s%s",
+ roff_name[n->tok], n->child->string,
+ n->child->next != NULL ? " ..." : "");
+ break;
+ default:
+ break;
+ }
}
+static void
+post_IP(CHKARGS)
+{
-static int
-check_text(CHKARGS)
+ switch (n->type) {
+ case ROFFT_BLOCK:
+ if (n->head->child == NULL && n->body->child == NULL)
+ roff_node_delete(man, n);
+ break;
+ case ROFFT_BODY:
+ if (n->parent->head->child == NULL && n->child == NULL)
+ mandoc_vmsg(MANDOCERR_PAR_SKIP,
+ man->parse, n->line, n->pos,
+ "%s empty", roff_name[n->tok]);
+ break;
+ default:
+ break;
+ }
+}
+
+static void
+post_TH(CHKARGS)
{
+ struct roff_node *nb;
const char *p;
- int pos, c;
-
- assert(n->string);
- 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;
+ free(man->meta.title);
+ free(man->meta.vol);
+ free(man->meta.os);
+ free(man->meta.msec);
+ free(man->meta.date);
+
+ man->meta.title = man->meta.vol = man->meta.date =
+ man->meta.msec = man->meta.os = NULL;
+
+ nb = n;
+
+ /* ->TITLE<- MSEC DATE OS VOL */
+
+ n = n->child;
+ 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)) {
+ mandoc_vmsg(MANDOCERR_TITLE_CASE,
+ man->parse, n->line,
+ n->pos + (p - n->string),
+ "TH %s", n->string);
+ break;
}
- if ( ! (MAN_IGN_ESCAPE & m->pflags))
- return(man_perr(m, n->line, pos, WESCAPE));
- if ( ! man_pwarn(m, n->line, pos, WESCAPE))
- return(0);
- continue;
}
+ man->meta.title = mandoc_strdup(n->string);
+ } else {
+ man->meta.title = mandoc_strdup("");
+ mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
+ nb->line, nb->pos, "TH");
+ }
- if ('\t' == *p || isprint((u_char)*p))
- continue;
+ /* TITLE ->MSEC<- DATE OS VOL */
- if (MAN_IGN_CHARS & m->pflags)
- return(man_pwarn(m, n->line, pos, WNPRINT));
- return(man_perr(m, n->line, pos, WNPRINT));
+ if (n)
+ n = n->next;
+ if (n && n->string)
+ man->meta.msec = mandoc_strdup(n->string);
+ else {
+ man->meta.msec = mandoc_strdup("");
+ mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
+ nb->line, nb->pos, "TH %s", man->meta.title);
}
- return(1);
-}
-
+ /* TITLE MSEC ->DATE<- OS VOL */
+
+ if (n)
+ n = n->next;
+ if (n && n->string && '\0' != n->string[0]) {
+ man->meta.date = man->quick ?
+ mandoc_strdup(n->string) :
+ mandoc_normdate(man, n->string, n->line, n->pos);
+ } else {
+ man->meta.date = mandoc_strdup("");
+ mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
+ n ? n->line : nb->line,
+ n ? n->pos : nb->pos, "TH");
+ }
-#define INEQ_DEFINE(x, ineq, name) \
-static int \
-check_##name(CHKARGS) \
-{ \
- if (n->nchild ineq (x)) \
- return(1); \
- return(man_verr(m, n->line, n->pos, \
- "expected line arguments %s %d, have %d", \
- #ineq, (x), n->nchild)); \
-}
+ /* TITLE MSEC DATE ->OS<- VOL */
+
+ if (n && (n = n->next))
+ man->meta.os = mandoc_strdup(n->string);
+ else if (man->os_s != NULL)
+ man->meta.os = mandoc_strdup(man->os_s);
+ if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
+ if (strstr(man->meta.os, "OpenBSD") != NULL)
+ man->meta.os_e = MANDOC_OS_OPENBSD;
+ else if (strstr(man->meta.os, "NetBSD") != NULL)
+ man->meta.os_e = MANDOC_OS_NETBSD;
+ }
-INEQ_DEFINE(0, ==, eq0)
-INEQ_DEFINE(1, <=, le1)
-INEQ_DEFINE(2, >=, ge2)
-INEQ_DEFINE(5, <=, le5)
+ /* TITLE MSEC DATE OS ->VOL<- */
+ /* If missing, use the default VOL name for MSEC. */
+ if (n && (n = n->next))
+ 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);
-static int
-check_sec(CHKARGS)
-{
+ if (n != NULL && (n = n->next) != NULL)
+ mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
+ n->line, n->pos, "TH ... %s", n->string);
- if (MAN_BODY == n->type && 0 == n->nchild)
- return(man_nwarn(m, n, WBODYARGS));
- if (MAN_HEAD == n->type && 0 == n->nchild)
- return(man_nerr(m, n, WHEADARGS));
- return(1);
+ /*
+ * Remove the `TH' node after we've processed it for our
+ * meta-data.
+ */
+ roff_node_delete(man, man->last);
}
-
-static int
-check_part(CHKARGS)
+static void
+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;
+
+ if (n == NULL || n->type != ROFFT_TEXT)
+ 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 (MAN_BODY == n->type && 0 == n->nchild)
- return(man_nwarn(m, n, WBODYARGS));
- return(1);
+ free(man->meta.os);
+ man->meta.os = mandoc_strdup(p);
}
-
-static int
-check_par(CHKARGS)
+static void
+post_AT(CHKARGS)
{
+ static const char * const unix_versions[] = {
+ "7th Edition",
+ "System III",
+ "System V",
+ "System V Release 2",
+ };
+
+ struct roff_node *nn;
+ const char *p, *s;
+
+ n = n->child;
+
+ if (n == NULL || n->type != ROFFT_TEXT)
+ 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 != NULL &&
+ nn->type == ROFFT_TEXT &&
+ nn->string[0] != '\0')
+ p = unix_versions[3];
+ else
+ p = unix_versions[2];
+ } else
+ p = unix_versions[0];
+ }
- 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 (n->nchild)
- break;
- return(man_nwarn(m, n, WBODYARGS));
- }
- if (MAN_HEAD == n->type)
- switch (n->tok) {
- case (MAN_PP):
- /* FALLTHROUGH */
- case (MAN_P):
- /* FALLTHROUGH */
- case (MAN_LP):
- if (0 == n->nchild)
- break;
- return(man_nwarn(m, n, WNHEADARGS));
- default:
- if (n->nchild)
- break;
- return(man_nwarn(m, n, WHEADARGS));
- }
-
- return(1);
+ free(man->meta.os);
+ man->meta.os = mandoc_strdup(p);
}
-
-static int
-check_bline(CHKARGS)
+static void
+post_in(CHKARGS)
{
-
- assert( ! (MAN_ELINE & m->flags));
- if (MAN_BLINE & m->flags)
- return(man_nerr(m, n, WLNSCOPE));
-
- return(1);
+ char *s;
+
+ if (n->parent->tok != MAN_TP ||
+ n->parent->type != ROFFT_HEAD ||
+ n->child == NULL ||
+ *n->child->string == '+' ||
+ *n->child->string == '-')
+ return;
+ mandoc_asprintf(&s, "+%s", n->child->string);
+ free(n->child->string);
+ n->child->string = s;
}
-
-static int
-check_roff(CHKARGS)
+static void
+post_vs(CHKARGS)
{
- if (MAN_BLOCK != n->type)
- return(1);
-
- for (n = n->parent; n; n = n->parent)
- if (MAN_de == n->tok || MAN_dei == n->tok ||
- MAN_am == n->tok ||
- MAN_ami == n->tok ||
- MAN_ig == n->tok)
- return(man_nerr(m, n, WROFFNEST));
-
- return(1);
+ if (NULL != n->prev)
+ return;
+
+ switch (n->parent->tok) {
+ case MAN_SH:
+ case MAN_SS:
+ case MAN_PP:
+ case MAN_LP:
+ case MAN_P:
+ mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
+ "%s after %s", roff_name[n->tok],
+ roff_name[n->parent->tok]);
+ /* FALLTHROUGH */
+ case TOKEN_NONE:
+ /*
+ * Don't warn about this because it occurs in pod2man
+ * and would cause considerable (unfixable) warnage.
+ */
+ roff_node_delete(man, n);
+ break;
+ default:
+ break;
+ }
}
git.ckatri.com / mandoc.git / blobdiff