[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.12 and 1.98

version 1.12, 2009/06/18 10:53:58 version 1.98, 2014/07/05 12:34:17
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>
 #include <ctype.h>  #include <ctype.h>
   #include <errno.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"
   
 #define POSTARGS  struct man *m, const struct man_node *n  #define CHKARGS   struct man *man, struct man_node *n
   
 typedef int     (*v_post)(POSTARGS);  typedef int     (*v_check)(CHKARGS);
   
 struct  man_valid {  struct  man_valid {
         v_post   *posts;          v_check  *pres;
           v_check  *posts;
 };  };
   
 static  int       check_eq0(POSTARGS);  static  int       check_eq0(CHKARGS);
 static  int       check_ge1(POSTARGS);  static  int       check_eq2(CHKARGS);
 static  int       check_ge2(POSTARGS);  static  int       check_le1(CHKARGS);
 static  int       check_le1(POSTARGS);  static  int       check_ge2(CHKARGS);
 static  int       check_le2(POSTARGS);  static  int       check_le5(CHKARGS);
 static  int       check_le5(POSTARGS);  static  int       check_head1(CHKARGS);
 static  int       check_text(POSTARGS);  static  int       check_par(CHKARGS);
   static  int       check_part(CHKARGS);
   static  int       check_root(CHKARGS);
   static  void      check_text(CHKARGS);
   
 static  v_post    posts_le1[] = { check_le1, NULL };  static  int       post_AT(CHKARGS);
 static  v_post    posts_le2[] = { check_le2, NULL };  static  int       post_IP(CHKARGS);
 static  v_post    posts_ge1[] = { check_ge1, NULL };  static  int       post_vs(CHKARGS);
 static  v_post    posts_eq0[] = { check_eq0, NULL };  static  int       post_fi(CHKARGS);
 static  v_post    posts_ge2_le5[] = { check_ge2, check_le5, NULL };  static  int       post_ft(CHKARGS);
   static  int       post_nf(CHKARGS);
   static  int       post_sec(CHKARGS);
   static  int       post_TH(CHKARGS);
   static  int       post_UC(CHKARGS);
   static  int       pre_sec(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_eq2[] = { check_eq2, NULL };
   static  v_check   posts_fi[] = { check_eq0, post_fi, NULL };
   static  v_check   posts_ft[] = { post_ft, NULL };
   static  v_check   posts_ip[] = { post_IP, NULL };
   static  v_check   posts_le1[] = { check_le1, 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[] = { post_sec, 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   posts_ur[] = { check_head1, check_part, NULL };
   static  v_check   pres_sec[] = { pre_sec, NULL };
   
 static  const struct man_valid man_valids[MAN_MAX] = {  static  const struct man_valid man_valids[MAN_MAX] = {
         { posts_eq0 }, /* br */          { NULL, posts_br }, /* br */
         { posts_ge2_le5 }, /* TH */          { NULL, posts_th }, /* TH */
         { posts_ge1 }, /* SH */          { pres_sec, posts_sec }, /* SH */
         { posts_ge1 }, /* SS */          { pres_sec, posts_sec }, /* SS */
         { NULL }, /* TP */          { NULL, NULL }, /* TP */
         { posts_eq0 }, /* LP */          { NULL, posts_par }, /* LP */
         { posts_eq0 }, /* PP */          { NULL, posts_par }, /* PP */
         { posts_eq0 }, /* P */          { NULL, posts_par }, /* P */
         { posts_le2 }, /* IP */          { NULL, posts_ip }, /* IP */
         { posts_le1 }, /* HP */          { NULL, NULL }, /* HP */
         { NULL }, /* SM */          { NULL, NULL }, /* SM */
         { NULL }, /* SB */          { NULL, NULL }, /* SB */
         { NULL }, /* BI */          { NULL, NULL }, /* BI */
         { NULL }, /* IB */          { NULL, NULL }, /* IB */
         { NULL }, /* BR */          { NULL, NULL }, /* BR */
         { NULL }, /* RB */          { NULL, NULL }, /* RB */
         { NULL }, /* R */          { NULL, NULL }, /* R */
         { NULL }, /* B */          { NULL, NULL }, /* B */
         { NULL }, /* I */          { NULL, NULL }, /* I */
         { NULL }, /* IR */          { NULL, NULL }, /* IR */
         { NULL }, /* RI */          { NULL, NULL }, /* RI */
         { posts_eq0 }, /* na */          { NULL, posts_eq0 }, /* na */
         { NULL }, /* i */          { NULL, posts_sp }, /* sp */
           { NULL, posts_nf }, /* nf */
           { NULL, posts_fi }, /* fi */
           { NULL, NULL }, /* RE */
           { NULL, posts_part }, /* RS */
           { NULL, NULL }, /* DT */
           { NULL, posts_uc }, /* UC */
           { NULL, posts_le1 }, /* PD */
           { NULL, posts_at }, /* AT */
           { NULL, NULL }, /* in */
           { NULL, posts_ft }, /* ft */
           { NULL, posts_eq2 }, /* OP */
           { NULL, posts_nf }, /* EX */
           { NULL, posts_fi }, /* EE */
           { NULL, posts_ur }, /* UR */
           { NULL, NULL }, /* UE */
           { NULL, NULL }, /* ll */
 };  };
   
   
 int  int
 man_valid_post(struct man *m)  man_valid_pre(struct man *man, struct man_node *n)
 {  {
         v_post          *cp;          v_check         *cp;
   
         if (MAN_VALID & m->last->flags)          switch (n->type) {
           case MAN_TEXT:
                   /* FALLTHROUGH */
           case MAN_ROOT:
                   /* FALLTHROUGH */
           case MAN_EQN:
                   /* FALLTHROUGH */
           case MAN_TBL:
                 return(1);                  return(1);
         m->last->flags |= MAN_VALID;          default:
                   break;
           }
   
         switch (m->last->type) {          if (NULL == (cp = man_valids[n->tok].pres))
         case (MAN_TEXT):  
                 return(check_text(m, m->last));  
         case (MAN_ROOT):  
                 return(1);                  return(1);
           for ( ; *cp; cp++)
                   if ( ! (*cp)(man, n))
                           return(0);
           return(1);
   }
   
   int
   man_valid_post(struct man *man)
   {
           v_check         *cp;
   
           if (MAN_VALID & man->last->flags)
                   return(1);
           man->last->flags |= MAN_VALID;
   
           switch (man->last->type) {
           case MAN_TEXT:
                   check_text(man, man->last);
                   return(1);
           case MAN_ROOT:
                   return(check_root(man, man->last));
           case MAN_EQN:
                   /* FALLTHROUGH */
           case MAN_TBL:
                   return(1);
         default:          default:
                 break;                  break;
         }          }
   
         if (NULL == (cp = man_valids[m->last->tok].posts))          if (NULL == (cp = man_valids[man->last->tok].posts))
                 return(1);                  return(1);
         for ( ; *cp; cp++)          for ( ; *cp; cp++)
                 if ( ! (*cp)(m, m->last))                  if ( ! (*cp)(man, man->last))
                         return(0);                          return(0);
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 check_text(POSTARGS)  check_root(CHKARGS)
 {  {
         const char      *p;  
         int              pos;  
   
         assert(n->string);          if (MAN_BLINE & man->flags)
                   man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
           else if (MAN_ELINE & man->flags)
                   man_nmsg(man, n, MANDOCERR_SCOPEEXIT);
   
         for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {          man->flags &= ~MAN_BLINE;
                 if ('\t' == *p || isprint((u_char)*p))          man->flags &= ~MAN_ELINE;
                         continue;  
   
                 if (MAN_IGN_CHARS & m->pflags)          if (NULL == man->first->child)
                         return(man_pwarn(m, n->line, pos, WNPRINT));                  man_nmsg(man, n, MANDOCERR_DOC_EMPTY);
                 return(man_perr(m, n->line, pos, WNPRINT));          else
                   man->meta.hasbody = 1;
   
           if (NULL == man->meta.title) {
                   man_nmsg(man, n, MANDOCERR_TH_MISSING);
   
                   /*
                    * If a title hasn't been set, do so now (by
                    * implication, date and section also aren't set).
                    */
   
                   man->meta.title = mandoc_strdup("unknown");
                   man->meta.msec = mandoc_strdup("1");
                   man->meta.date = man->quick ? mandoc_strdup("") :
                       mandoc_normdate(man->parse, NULL, n->line, n->pos);
         }          }
   
         return(1);          return(1);
 }  }
   
   static void
   check_text(CHKARGS)
   {
           char            *cp, *p;
   
           if (MAN_LITERAL & man->flags)
                   return;
   
           cp = n->string;
           for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                   man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB);
   }
   
 #define INEQ_DEFINE(x, ineq, name) \  #define INEQ_DEFINE(x, ineq, name) \
 static int \  static int \
 check_##name(POSTARGS) \  check_##name(CHKARGS) \
 { \  { \
         if (n->nchild ineq (x)) \          if (n->nchild ineq (x)) \
                 return(1); \                  return(1); \
         return(man_verr(m, n->line, n->pos, \          mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
                         "expected line arguments %s %d, have %d", \              "line arguments %s %d (have %d)", \
                         #ineq, (x), n->nchild)); \              #ineq, (x), n->nchild); \
           return(1); \
 }  }
   
 INEQ_DEFINE(0, ==, eq0)  INEQ_DEFINE(0, ==, eq0)
 INEQ_DEFINE(1, >=, ge1)  INEQ_DEFINE(2, ==, eq2)
 INEQ_DEFINE(2, >=, ge2)  
 INEQ_DEFINE(1, <=, le1)  INEQ_DEFINE(1, <=, le1)
 INEQ_DEFINE(2, <=, le2)  INEQ_DEFINE(2, >=, ge2)
 INEQ_DEFINE(5, <=, le5)  INEQ_DEFINE(5, <=, le5)
   
   static int
   check_head1(CHKARGS)
   {
   
           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(1);
   }
   
   static int
   post_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_FT_BAD, man->parse,
                       n->line, n->pos, "ft %s", cp);
                   *cp = '\0';
           }
   
           if (1 < n->nchild)
                   mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
                       n->pos, "want one child (have %d)", n->nchild);
   
           return(1);
   }
   
   static int
   pre_sec(CHKARGS)
   {
   
           if (MAN_BLOCK == n->type)
                   man->flags &= ~MAN_LITERAL;
           return(1);
   }
   
   static int
   post_sec(CHKARGS)
   {
   
           if ( ! (MAN_HEAD == n->type && 0 == n->nchild))
                   return(1);
   
           man_nmsg(man, n, MANDOCERR_SYNTARGCOUNT);
           return(0);
   }
   
   static int
   check_part(CHKARGS)
   {
   
           if (MAN_BODY == n->type && 0 == n->nchild)
                   mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
                       n->pos, "want children (have none)");
   
           return(1);
   }
   
   static int
   check_par(CHKARGS)
   {
   
           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);
   }
   
   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
   post_TH(CHKARGS)
   {
           struct man_node *nb;
           const char      *p;
   
           free(man->meta.title);
           free(man->meta.vol);
           free(man->meta.source);
           free(man->meta.msec);
           free(man->meta.date);
   
           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_msg(MANDOCERR_TITLE_CASE,
                                       man->parse, n->line,
                                       n->pos + (p - n->string),
                                       n->string);
                                   break;
                           }
                   }
                   man->meta.title = mandoc_strdup(n->string);
           } else
                   man->meta.title = mandoc_strdup("");
   
           /* TITLE ->MSEC<- DATE SOURCE VOL */
   
           if (n)
                   n = n->next;
           if (n && n->string)
                   man->meta.msec = mandoc_strdup(n->string);
           else
                   man->meta.msec = mandoc_strdup("");
   
           /* 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("");
                   man_nmsg(man, n ? n : nb, MANDOCERR_DATE_MISSING);
           }
   
           /* TITLE MSEC DATE ->SOURCE<- VOL */
   
           if (n && (n = n->next))
                   man->meta.source = mandoc_strdup(n->string);
   
           /* 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
   post_nf(CHKARGS)
   {
   
           if (MAN_LITERAL & man->flags)
                   man_nmsg(man, n, MANDOCERR_NF_SKIP);
   
           man->flags |= MAN_LITERAL;
           return(1);
   }
   
   static int
   post_fi(CHKARGS)
   {
   
           if ( ! (MAN_LITERAL & man->flags))
                   man_nmsg(man, n, MANDOCERR_FI_SKIP);
   
           man->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;
   
           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);
   }
   
   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];
           }
   
           free(man->meta.source);
           man->meta.source = mandoc_strdup(p);
           return(1);
   }
   
   static int
   post_vs(CHKARGS)
   {
   
           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);
   }
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.98
CVSweb