[BACK]Return to man_validate.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man_validate.c between version 1.19 and 1.105

version 1.19, 2009/08/19 09:14:50 version 1.105, 2014/08/06 15:09:05
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 14 
Line 15 
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
Line 22 
Line 27 
 #include <limits.h>  #include <limits.h>
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdlib.h>  #include <stdlib.h>
   #include <string.h>
   #include <time.h>
   
   #include "man.h"
   #include "mandoc.h"
   #include "mandoc_aux.h"
 #include "libman.h"  #include "libman.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   
 #define CHKARGS   struct man *m, const struct man_node *n  #define CHKARGS   struct man *man, struct man_node *n
   
 typedef int     (*v_check)(CHKARGS);  typedef int     (*v_check)(CHKARGS);
   
 struct  man_valid {  
         v_check  *pres;  
         v_check  *posts;  
 };  
   
 static  int       check_bline(CHKARGS);  
 static  int       check_eline(CHKARGS);  
 static  int       check_eq0(CHKARGS);  static  int       check_eq0(CHKARGS);
 static  int       check_eq1(CHKARGS);  static  int       check_eq2(CHKARGS);
 static  int       check_ge2(CHKARGS);  static  int       check_le1(CHKARGS);
 static  int       check_le5(CHKARGS);  static  int       check_le5(CHKARGS);
 static  int       check_par(CHKARGS);  static  int       check_par(CHKARGS);
   static  int       check_part(CHKARGS);
 static  int       check_root(CHKARGS);  static  int       check_root(CHKARGS);
 static  int       check_sec(CHKARGS);  
 static  int       check_sp(CHKARGS);  
 static  int       check_text(CHKARGS);  static  int       check_text(CHKARGS);
   
 static  v_check   posts_eq0[] = { check_eq0, NULL };  static  int       post_AT(CHKARGS);
 static  v_check   posts_ge2_le5[] = { check_ge2, check_le5, NULL };  static  int       post_IP(CHKARGS);
 static  v_check   posts_par[] = { check_par, NULL };  static  int       post_vs(CHKARGS);
 static  v_check   posts_sec[] = { check_sec, NULL };  static  int       post_fi(CHKARGS);
 static  v_check   posts_sp[] = { check_sp, NULL };  static  int       post_ft(CHKARGS);
 static  v_check   pres_eline[] = { check_eline, NULL };  static  int       post_nf(CHKARGS);
 static  v_check   pres_bline[] = { check_bline, NULL };  static  int       post_TH(CHKARGS);
   static  int       post_UC(CHKARGS);
   static  int       post_UR(CHKARGS);
   
 static  const struct man_valid man_valids[MAN_MAX] = {  static  v_check man_valids[MAN_MAX] = {
         { pres_bline, posts_eq0 }, /* br */          post_vs,    /* br */
         { pres_bline, posts_ge2_le5 }, /* TH */          post_TH,    /* TH */
         { pres_bline, posts_sec }, /* SH */          NULL,       /* SH */
         { pres_bline, posts_sec }, /* SS */          NULL,       /* SS */
         { pres_bline, posts_par }, /* TP */          NULL,       /* TP */
         { pres_bline, posts_par }, /* LP */          check_par,  /* LP */
         { pres_bline, posts_par }, /* PP */          check_par,  /* PP */
         { pres_bline, posts_par }, /* P */          check_par,  /* P */
         { pres_bline, posts_par }, /* IP */          post_IP,    /* IP */
         { pres_bline, posts_par }, /* HP */          NULL,       /* HP */
         { pres_eline, NULL }, /* SM */          NULL,       /* SM */
         { pres_eline, NULL }, /* SB */          NULL,       /* SB */
         { NULL, NULL }, /* BI */          NULL,       /* BI */
         { NULL, NULL }, /* IB */          NULL,       /* IB */
         { NULL, NULL }, /* BR */          NULL,       /* BR */
         { NULL, NULL }, /* RB */          NULL,       /* RB */
         { pres_eline, NULL }, /* R */          NULL,       /* R */
         { pres_eline, NULL }, /* B */          NULL,       /* B */
         { pres_eline, NULL }, /* I */          NULL,       /* I */
         { NULL, NULL }, /* IR */          NULL,       /* IR */
         { NULL, NULL }, /* RI */          NULL,       /* RI */
         { pres_bline, posts_eq0 }, /* na */          check_eq0,  /* na */
         { NULL, NULL }, /* i */          post_vs,    /* sp */
         { pres_bline, posts_sp }, /* sp */          post_nf,    /* nf */
         { pres_bline, posts_eq0 }, /* nf */          post_fi,    /* fi */
         { pres_bline, posts_eq0 }, /* fi */          NULL,       /* RE */
         { NULL, NULL }, /* r */          check_part, /* RS */
         { NULL, NULL }, /* RE */          NULL,       /* DT */
         { NULL, NULL }, /* RS */          post_UC,    /* UC */
           check_le1,  /* PD */
           post_AT,    /* AT */
           NULL,       /* in */
           post_ft,    /* ft */
           check_eq2,  /* OP */
           post_nf,    /* EX */
           post_fi,    /* EE */
           post_UR,    /* UR */
           NULL,       /* UE */
           NULL,       /* ll */
 };  };
   
   
 int  int
 man_valid_pre(struct man *m, const struct man_node *n)  man_valid_post(struct man *man)
 {  {
           struct man_node *n;
         v_check         *cp;          v_check         *cp;
   
         if (MAN_TEXT == n->type)          n = man->last;
           if (n->flags & MAN_VALID)
                 return(1);                  return(1);
         if (MAN_ROOT == n->type)          n->flags |= MAN_VALID;
   
           switch (n->type) {
           case MAN_TEXT:
                   return(check_text(man, n));
           case MAN_ROOT:
                   return(check_root(man, n));
           case MAN_EQN:
                   /* FALLTHROUGH */
           case MAN_TBL:
                 return(1);                  return(1);
           default:
                   cp = man_valids + n->tok;
                   return(*cp ? (*cp)(man, n) : 1);
           }
   }
   
         if (NULL == (cp = man_valids[n->tok].pres))  static int
   check_root(CHKARGS)
   {
   
           assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
   
           if (NULL == man->first->child)
                   mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                       n->line, n->pos, NULL);
           else
                   man->meta.hasbody = 1;
   
           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).
                    */
   
                   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)
   {
           char            *cp, *p;
   
           if (MAN_LITERAL & man->flags)
                 return(1);                  return(1);
         for ( ; *cp; cp++)  
                 if ( ! (*cp)(m, n))          cp = n->string;
                         return(0);          for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                   mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                       n->line, n->pos + (p - cp), NULL);
         return(1);          return(1);
 }  }
   
   #define INEQ_DEFINE(x, ineq, name) \
   static int \
   check_##name(CHKARGS) \
   { \
           if (n->nchild ineq (x)) \
                   return(1); \
           mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
               "line arguments %s %d (have %d)", \
               #ineq, (x), n->nchild); \
           return(1); \
   }
   
 int  INEQ_DEFINE(0, ==, eq0)
 man_valid_post(struct man *m)  INEQ_DEFINE(2, ==, eq2)
   INEQ_DEFINE(1, <=, le1)
   INEQ_DEFINE(5, <=, le5)
   
   static int
   post_UR(CHKARGS)
 {  {
         v_check         *cp;  
   
         if (MAN_VALID & m->last->flags)          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(check_part(man, n));
   }
   
   static int
   post_ft(CHKARGS)
   {
           char    *cp;
           int      ok;
   
           if (0 == n->nchild)
                 return(1);                  return(1);
         m->last->flags |= MAN_VALID;  
   
         switch (m->last->type) {          ok = 0;
         case (MAN_TEXT):          cp = n->child->string;
                 return(check_text(m, m->last));          switch (*cp) {
         case (MAN_ROOT):          case '1':
                 return(check_root(m, m->last));                  /* 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:          default:
                 break;                  break;
         }          }
   
         if (NULL == (cp = man_valids[m->last->tok].posts))          if (0 == ok) {
                 return(1);                  mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
         for ( ; *cp; cp++)                      n->line, n->pos, "ft %s", cp);
                 if ( ! (*cp)(m, m->last))                  *cp = '\0';
                         return(0);          }
   
           if (1 < n->nchild)
                   mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
                       n->pos, "want one child (have %d)", n->nchild);
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_root(CHKARGS)  check_part(CHKARGS)
 {  {
   
         /* FIXME: closing out explicit scope! */          if (MAN_BODY == n->type && 0 == n->nchild)
                   mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
                       n->pos, "want children (have none)");
   
         /* XXX - make this into a warning? */          return(1);
         if (MAN_BLINE & m->flags)  }
                 return(man_nerr(m, n, WEXITSCOPE));  
         /* XXX - make this into a warning? */  
         if (MAN_ELINE & m->flags)  
                 return(man_nerr(m, n, WEXITSCOPE));  
   
         if (NULL == m->first->child)  static int
                 return(man_nerr(m, n, WNODATA));  check_par(CHKARGS)
         if (NULL == m->meta.title)  {
                 return(man_nerr(m, n, WNOTITLE));  
   
           switch (n->type) {
           case MAN_BLOCK:
                   if (0 == n->body->nchild)
                           man_node_delete(man, n);
                   break;
           case MAN_BODY:
                   if (0 == n->nchild)
                           mandoc_vmsg(MANDOCERR_PAR_SKIP,
                               man->parse, n->line, n->pos,
                               "%s empty", man_macronames[n->tok]);
                   break;
           case MAN_HEAD:
                   if (n->nchild)
                           mandoc_vmsg(MANDOCERR_ARG_SKIP,
                               man->parse, n->line, n->pos,
                               "%s %s%s", man_macronames[n->tok],
                               n->child->string,
                               n->nchild > 1 ? " ..." : "");
                   break;
           default:
                   break;
           }
   
         return(1);          return(1);
 }  }
   
   static int
   post_IP(CHKARGS)
   {
   
           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)
                           mandoc_vmsg(MANDOCERR_PAR_SKIP,
                               man->parse, n->line, n->pos,
                               "%s empty", man_macronames[n->tok]);
                   break;
           default:
                   break;
           }
           return(1);
   }
   
 static int  static int
 check_text(CHKARGS)  post_TH(CHKARGS)
 {  {
           struct man_node *nb;
         const char      *p;          const char      *p;
         int              pos, c;  
   
         assert(n->string);          check_le5(man, n);
   
         for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {          free(man->meta.title);
                 if ('\\' == *p) {          free(man->meta.vol);
                         c = mandoc_special(p);          free(man->meta.source);
                         if (c) {          free(man->meta.msec);
                                 p += c - 1;          free(man->meta.date);
                                 pos += c - 1;  
                                 continue;          man->meta.title = man->meta.vol = man->meta.date =
               man->meta.msec = man->meta.source = NULL;
   
           nb = n;
   
           /* ->TITLE<- MSEC DATE SOURCE 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))          /* TITLE ->MSEC<- DATE SOURCE VOL */
                         continue;  
   
                 if (MAN_IGN_CHARS & m->pflags)          if (n)
                         return(man_pwarn(m, n->line, pos, WNPRINT));                  n = n->next;
                 return(man_perr(m, n->line, pos, WNPRINT));          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<- SOURCE 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->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");
           }
   
 #define INEQ_DEFINE(x, ineq, name) \          /* TITLE MSEC DATE ->SOURCE<- VOL */
 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)); \  
 }  
   
 INEQ_DEFINE(0, ==, eq0)          if (n && (n = n->next))
 INEQ_DEFINE(1, ==, eq1)                  man->meta.source = mandoc_strdup(n->string);
 INEQ_DEFINE(2, >=, ge2)  
 INEQ_DEFINE(5, <=, le5)  
   
           /* TITLE MSEC DATE SOURCE ->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);
   
           /*
            * Remove the `TH' node after we've processed it for our
            * meta-data.
            */
           man_node_delete(man, man->last);
           return(1);
   }
   
 static int  static int
 check_sp(CHKARGS)  post_nf(CHKARGS)
 {  {
         long             lval;  
         char            *ep, *buf;  
   
         if (NULL == n->child)          check_eq0(man, n);
                 return(1);  
         else if ( ! check_eq1(m, n))  
                 return(0);  
   
         assert(MAN_TEXT == n->child->type);          if (MAN_LITERAL & man->flags)
         buf = n->child->string;                  mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
         assert(buf);                      n->line, n->pos, "nf");
   
         /* From OpenBSD's strtol(3). */  
   
         errno = 0;          man->flags |= MAN_LITERAL;
         lval = strtol(buf, &ep, 10);  
         if (buf[0] == '\0' || *ep != '\0')  
                 return(man_nerr(m, n->child, WNUMFMT));  
   
         if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) ||  
                         (lval > INT_MAX || lval < 0))  
                 return(man_nerr(m, n->child, WNUMFMT));  
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_sec(CHKARGS)  post_fi(CHKARGS)
 {  {
   
         if (MAN_BODY == n->type && 0 == n->nchild)          check_eq0(man, n);
                 return(man_nwarn(m, n, WBODYARGS));  
         if (MAN_HEAD == n->type && 0 == n->nchild)          if ( ! (MAN_LITERAL & man->flags))
                 return(man_nerr(m, n, WHEADARGS));                  mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                       n->line, n->pos, "fi");
   
           man->flags &= ~MAN_LITERAL;
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_par(CHKARGS)  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",
           };
   
         if (MAN_BODY == n->type)          const char      *p, *s;
                 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));  
                 }  
   
           n = n->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];
           }
   
           free(man->meta.source);
           man->meta.source = mandoc_strdup(p);
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_eline(CHKARGS)  post_AT(CHKARGS)
 {  {
           static const char * const unix_versions[] = {
               "7th Edition",
               "System III",
               "System V",
               "System V Release 2",
           };
   
         if (MAN_ELINE & m->flags)          const char      *p, *s;
                 return(man_nerr(m, n, WLNSCOPE));          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];
           }
   
           free(man->meta.source);
           man->meta.source = mandoc_strdup(p);
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_bline(CHKARGS)  post_vs(CHKARGS)
 {  {
   
         if (MAN_BLINE & m->flags)          if (n->tok == MAN_br)
                 return(man_nerr(m, n, WLNSCOPE));                  check_eq0(man, n);
         if (MAN_ELINE & m->flags)          else
                 return(man_nerr(m, n, WLNSCOPE));                  check_le1(man, n);
   
           if (NULL != n->prev)
                   return(1);
   
           switch (n->parent->tok) {
           case MAN_SH:
                   /* FALLTHROUGH */
           case MAN_SS:
                   mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
                       "%s after %s", man_macronames[n->tok],
                       man_macronames[n->parent->tok]);
                   /* 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);          return(1);
 }  }
   
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.105
CVSweb