=================================================================== RCS file: /cvs/mandoc/man_validate.c,v retrieving revision 1.60 retrieving revision 1.123 diff -u -p -r1.60 -r1.123 --- mandoc/man_validate.c 2011/01/17 00:21:29 1.60 +++ mandoc/man_validate.c 2017/04/24 23:06:18 1.123 @@ -1,22 +1,21 @@ -/* $Id: man_validate.c,v 1.60 2011/01/17 00:21:29 schwarze Exp $ */ +/* $OpenBSD: man_validate.c,v 1.123 2017/04/24 23:06:18 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012-2017 Ingo Schwarze * * 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 @@ -29,263 +28,206 @@ #include #include +#include "mandoc_aux.h" #include "mandoc.h" -#include "libman.h" +#include "roff.h" +#include "man.h" #include "libmandoc.h" +#include "roff_int.h" +#include "libman.h" -#define CHKARGS struct man *m, struct man_node *n +#define CHKARGS struct roff_man *man, struct roff_node *n -typedef int (*v_check)(CHKARGS); +typedef void (*v_check)(CHKARGS); -struct man_valid { - v_check *pres; - v_check *posts; -}; +static void check_par(CHKARGS); +static void check_part(CHKARGS); +static void check_root(CHKARGS); +static void check_text(CHKARGS); -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_par(CHKARGS); -static int check_part(CHKARGS); -static int check_root(CHKARGS); -static int check_sec(CHKARGS); -static int check_text(CHKARGS); +static void post_AT(CHKARGS); +static void post_IP(CHKARGS); +static void post_vs(CHKARGS); +static void post_ft(CHKARGS); +static void post_OP(CHKARGS); +static void post_TH(CHKARGS); +static void post_UC(CHKARGS); +static void post_UR(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_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, 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 */ - { pres_bline, posts_sec }, /* SH */ - { pres_bline, 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 }, /* 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 */ /* 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, posts_uc }, /* UC */ - { NULL, NULL }, /* PD */ - { NULL, posts_at }, /* AT */ - { NULL, NULL }, /* in */ - { NULL, posts_ft }, /* ft */ +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 */ + post_vs, /* br */ + post_vs, /* sp */ + NULL, /* nf */ + NULL, /* fi */ + NULL, /* RE */ + check_part, /* RS */ + NULL, /* DT */ + post_UC, /* UC */ + NULL, /* PD */ + post_AT, /* AT */ + NULL, /* in */ + post_ft, /* ft */ + post_OP, /* OP */ + NULL, /* EX */ + NULL, /* EE */ + post_UR, /* UR */ + NULL, /* UE */ + NULL, /* ll */ }; +static const v_check *man_valids = __man_valids - MAN_TH; -int -man_valid_pre(struct man *m, struct man_node *n) +void +man_node_validate(struct roff_man *man) { - v_check *cp; + struct roff_node *n; + const v_check *cp; - switch (n->type) { - case (MAN_TEXT): - /* FALLTHROUGH */ - case (MAN_ROOT): - /* FALLTHROUGH */ - case (MAN_TBL): - return(1); - default: - break; + 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; } - if (NULL == (cp = man_valids[n->tok].pres)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(m, n)) - return(0); - return(1); -} - - -int -man_valid_post(struct man *m) -{ - v_check *cp; - - if (MAN_VALID & m->last->flags) - return(1); - m->last->flags |= MAN_VALID; - - switch (m->last->type) { - case (MAN_TEXT): - return(check_text(m, m->last)); - case (MAN_ROOT): - return(check_root(m, m->last)); - case (MAN_TBL): - return(1); + 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: + cp = man_valids + n->tok; + if (*cp) + (*cp)(man, n); + if (man->last == n) + man_state(man, n); break; } - - if (NULL == (cp = man_valids[m->last->tok].posts)) - return(1); - for ( ; *cp; cp++) - if ( ! (*cp)(m, m->last)) - return(0); - - return(1); } - -static int -check_root(CHKARGS) +static void +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); + assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0); - m->flags &= ~MAN_BLINE; - m->flags &= ~MAN_ELINE; + if (NULL == man->first->child) + mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse, + n->line, n->pos, NULL); + else + man->meta.hasbody = 1; - 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->meta.title) { + mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse, + n->line, n->pos, NULL); /* * 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.date = time(NULL); - m->meta.msec = mandoc_strdup("1"); + man->meta.title = mandoc_strdup(""); + man->meta.msec = mandoc_strdup(""); + man->meta.date = man->quick ? mandoc_strdup("") : + mandoc_normdate(man->parse, NULL, n->line, n->pos); } - - return(1); } - -static int -check_text(CHKARGS) +static void +check_text(CHKARGS) { - char *p; - int pos, c; - size_t sz; + char *cp, *p; - for (p = n->string, pos = n->pos + 1; *p; p++, pos++) { - sz = strcspn(p, "\t\\"); - p += (int)sz; + if (MAN_LITERAL & man->flags) + return; - if ('\0' == *p) - break; + 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); +} - pos += (int)sz; +static void +post_OP(CHKARGS) +{ - 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); + 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); } - - return(1); } +static void +post_UR(CHKARGS) +{ -#define INEQ_DEFINE(x, ineq, name) \ -static int \ -check_##name(CHKARGS) \ -{ \ - if (n->nchild ineq (x)) \ - return(1); \ - man_vmsg(m, MANDOCERR_ARGCOUNT, n->line, n->pos, \ - "line arguments %s %d (have %d)", \ - #ineq, (x), n->nchild); \ - return(1); \ + if (n->type == ROFFT_HEAD && n->child == NULL) + mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse, + n->line, n->pos, "UR"); + check_part(man, n); } -INEQ_DEFINE(0, ==, eq0) -INEQ_DEFINE(1, <=, le1) -INEQ_DEFINE(2, >=, ge2) -INEQ_DEFINE(5, <=, le5) - -static int -check_ft(CHKARGS) +static void +post_ft(CHKARGS) { char *cp; int ok; - if (0 == n->nchild) - return(1); + if (n->child == NULL) + return; 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'): + case '1': + case '2': + case '3': + case '4': + case 'I': + case 'P': + 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; @@ -294,187 +236,163 @@ check_ft(CHKARGS) } if (0 == ok) { - man_vmsg(m, MANDOCERR_BADFONT, - n->line, n->pos, "%s", cp); + mandoc_vmsg(MANDOCERR_FT_BAD, man->parse, + n->line, n->pos, "ft %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) -{ - - 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); - - return(1); -} - - -static int +static void check_part(CHKARGS) { - if (MAN_BODY == n->type && 0 == n->nchild) - man_nmsg(m, n, MANDOCERR_NOBODY); - - return(1); + if (n->type == ROFFT_BODY && n->child == NULL) + mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse, + n->line, n->pos, roff_name[n->tok]); } - -static int +static void check_par(CHKARGS) { switch (n->type) { - case (MAN_BLOCK): - if (0 == n->body->nchild) - man_node_delete(m, n); + case ROFFT_BLOCK: + if (n->body->child == NULL) + roff_node_delete(man, n); break; - case (MAN_BODY): - if (0 == n->nchild) - man_nmsg(m, n, MANDOCERR_IGNPAR); + 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 (MAN_HEAD): - if (n->nchild) - man_nmsg(m, n, MANDOCERR_ARGSLOST); + 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; } - - return(1); } - -static int -check_bline(CHKARGS) +static void +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 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; } - - return(1); } -static int +static void post_TH(CHKARGS) { + struct roff_node *nb; const char *p; - 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); + free(man->meta.title); + free(man->meta.vol); + free(man->meta.os); + free(man->meta.msec); + free(man->meta.date); - m->meta.title = m->meta.vol = m->meta.rawdate = - m->meta.msec = m->meta.source = NULL; - m->meta.date = 0; + man->meta.title = man->meta.vol = man->meta.date = + man->meta.msec = man->meta.os = NULL; - /* ->TITLE<- MSEC DATE SOURCE VOL */ + 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((u_char)*p) && ! isupper((u_char)*p)) { - man_nmsg(m, n, MANDOCERR_UPPERCASE); + 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; } } - m->meta.title = mandoc_strdup(n->string); - } else - m->meta.title = mandoc_strdup(""); + 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"); + } - /* TITLE ->MSEC<- DATE SOURCE VOL */ + /* TITLE ->MSEC<- DATE OS VOL */ if (n) n = n->next; if (n && n->string) - m->meta.msec = mandoc_strdup(n->string); - else - m->meta.msec = mandoc_strdup(""); + 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); + } - /* TITLE MSEC ->DATE<- SOURCE VOL */ + /* TITLE MSEC ->DATE<- OS 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. - */ - if (n) 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->string && '\0' != n->string[0]) { + 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(""); + mandoc_msg(MANDOCERR_DATE_MISSING, man->parse, + n ? n->line : nb->line, + n ? n->pos : nb->pos, "TH"); + } - /* TITLE MSEC DATE ->SOURCE<- VOL */ + /* TITLE MSEC DATE ->OS<- VOL */ if (n && (n = n->next)) - m->meta.source = mandoc_strdup(n->string); + man->meta.os = mandoc_strdup(n->string); + else if (man->defos != NULL) + man->meta.os = mandoc_strdup(man->defos); - /* TITLE MSEC DATE SOURCE ->VOL<- */ + /* TITLE MSEC DATE OS ->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); + if (n != NULL && (n = n->next) != NULL) + mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, + n->line, n->pos, "TH ... %s", n->string); + /* * Remove the `TH' node after we've processed it for our * meta-data. */ - man_node_delete(m, m->last); - return(1); + roff_node_delete(man, man->last); } -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_WNOSCOPE); - - m->flags &= ~MAN_LITERAL; - return(1); -} - -static int +static void post_UC(CHKARGS) { static const char * const bsd_versions[] = { @@ -488,9 +406,8 @@ post_UC(CHKARGS) const char *p, *s; n = n->child; - n = m->last->child; - if (NULL == n || MAN_TEXT != n->type) + if (n == NULL || n->type != ROFFT_TEXT) p = bsd_versions[0]; else { s = n->string; @@ -508,14 +425,11 @@ post_UC(CHKARGS) p = bsd_versions[0]; } - if (m->meta.source) - free(m->meta.source); - - m->meta.source = mandoc_strdup(p); - return(1); + free(man->meta.os); + man->meta.os = mandoc_strdup(p); } -static int +static void post_AT(CHKARGS) { static const char * const unix_versions[] = { @@ -525,12 +439,12 @@ post_AT(CHKARGS) "System V Release 2", }; + struct roff_node *nn; const char *p, *s; - struct man_node *nn; n = n->child; - if (NULL == n || MAN_TEXT != n->type) + if (n == NULL || n->type != ROFFT_TEXT) p = unix_versions[0]; else { s = n->string; @@ -540,7 +454,9 @@ post_AT(CHKARGS) p = unix_versions[1]; else if (0 == strcmp(s, "5")) { nn = n->next; - if (nn && MAN_TEXT == nn->type && nn->string[0]) + if (nn != NULL && + nn->type == ROFFT_TEXT && + nn->string[0] != '\0') p = unix_versions[3]; else p = unix_versions[2]; @@ -548,9 +464,32 @@ post_AT(CHKARGS) p = unix_versions[0]; } - if (m->meta.source) - free(m->meta.source); + free(man->meta.os); + man->meta.os = mandoc_strdup(p); +} - m->meta.source = mandoc_strdup(p); - return(1); +static void +post_vs(CHKARGS) +{ + + if (NULL != n->prev) + return; + + switch (n->parent->tok) { + case MAN_SH: + case MAN_SS: + 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; + } }