[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.2 and 1.36

version 1.2, 2009/03/25 21:46:24 version 1.36, 2010/05/14 16:19:26
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *   *
  * 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * 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 "libman.h"  #include "libman.h"
   #include "libmandoc.h"
   
 /* FIXME: validate text. */  #define CHKARGS   struct man *m, const struct man_node *n
   
 #define POSTARGS  struct man *m, const struct man_node *n  typedef int     (*v_check)(CHKARGS);
   
 typedef int     (*v_post)(POSTARGS);  
   
 struct  man_valid {  struct  man_valid {
         v_post   *posts;          v_check  *pres;
           v_check  *posts;
 };  };
   
 static  int       count(POSTARGS);  static  int       check_bline(CHKARGS);
 static  int       check_eq0(POSTARGS);  static  int       check_eq0(CHKARGS);
 static  int       check_ge1(POSTARGS);  static  int       check_le1(CHKARGS);
 static  int       check_ge2(POSTARGS);  static  int       check_ge2(CHKARGS);
 static  int       check_le1(POSTARGS);  static  int       check_le5(CHKARGS);
 static  int       check_le2(POSTARGS);  static  int       check_par(CHKARGS);
 static  int       check_le5(POSTARGS);  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_post    posts_le1[] = { check_le1, NULL };  static  v_check   posts_eq0[] = { check_eq0, NULL };
 static  v_post    posts_le2[] = { check_le2, NULL };  static  v_check   posts_th[] = { check_ge2, check_le5, check_title, NULL };
 static  v_post    posts_ge1[] = { check_ge1, NULL };  static  v_check   posts_par[] = { check_par, NULL };
 static  v_post    posts_eq0[] = { check_eq0, NULL };  static  v_check   posts_part[] = { check_part, NULL };
 static  v_post    posts_ge2_le5[] = { check_ge2, check_le5, 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] = {  static  const struct man_valid man_valids[MAN_MAX] = {
         { NULL }, /* __ */          { NULL, posts_eq0 }, /* br */
         { posts_ge2_le5 }, /* TH */          { pres_bline, posts_th }, /* TH */
         { posts_ge1 }, /* SH */          { pres_bline, posts_sec }, /* SH */
         { posts_ge1 }, /* SS */          { pres_bline, posts_sec }, /* SS */
         { posts_le1 }, /* TP */          { pres_bline, posts_par }, /* TP */
         { posts_eq0 }, /* LP */          { pres_bline, posts_par }, /* LP */
         { posts_eq0 }, /* PP */          { pres_bline, posts_par }, /* PP */
         { posts_eq0 }, /* P */          { pres_bline, posts_par }, /* P */
         { posts_le2 }, /* IP */          { pres_bline, posts_par }, /* IP */
         { posts_le1 }, /* HP */          { pres_bline, posts_par }, /* 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, 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_le1 }, /* 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 }, /* . */
 };  };
   
   
 int  int
   man_valid_pre(struct man *m, const struct man_node *n)
   {
           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);
   }
   
   
   int
 man_valid_post(struct man *m)  man_valid_post(struct man *m)
 {  {
         v_post          *cp;          v_check         *cp;
   
         if (MAN_VALID & m->last->flags)          if (MAN_VALID & m->last->flags)
                 return(1);                  return(1);
Line 84  man_valid_post(struct man *m)
Line 136  man_valid_post(struct man *m)
   
         switch (m->last->type) {          switch (m->last->type) {
         case (MAN_TEXT):          case (MAN_TEXT):
                 /* FALLTHROUGH */                  return(check_text(m, m->last));
         case (MAN_ROOT):          case (MAN_ROOT):
                 return(1);                  return(check_root(m, m->last));
         default:          default:
                 break;                  break;
         }          }
Line 101  man_valid_post(struct man *m)
Line 153  man_valid_post(struct man *m)
 }  }
   
   
 static inline int  static int
 count(POSTARGS)  check_root(CHKARGS)
 {  {
         int              i;  
   
         for (i = 0; n; n = n->next, i++)          if (MAN_BLINE & m->flags)
                 /* Loop. */ ;                  return(man_nwarn(m, n, WEXITSCOPE));
         return(i);          if (MAN_ELINE & m->flags)
                   return(man_nwarn(m, n, WEXITSCOPE));
   
           m->flags &= ~MAN_BLINE;
           m->flags &= ~MAN_ELINE;
   
           if (NULL == m->first->child)
                   return(man_nerr(m, n, WNODATA));
           if (NULL == m->meta.title) {
                   if ( ! man_nwarn(m, n, WNOTITLE))
                           return(0);
                   /*
                    * 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 = 1;
           }
   
           return(1);
 }  }
   
   
   static int
   check_title(CHKARGS)
   {
           const char      *p;
   
           assert(n->child);
           if ('\0' == *n->child->string)
                   return(man_nerr(m, n, WNOTITLE));
   
           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);
   
           return(1);
   }
   
   
   static int
   check_text(CHKARGS)
   {
           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;
                           }
                           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;
                   }
   
                   if ('\t' == *p || isprint((u_char)*p))
                           continue;
   
                   return(man_pwarn(m, n->line, pos, WNPRINT));
           }
   
           return(1);
   }
   
   
 #define INEQ_DEFINE(x, ineq, name) \  #define INEQ_DEFINE(x, ineq, name) \
 static int \  static int \
 check_##name(POSTARGS) \  check_##name(CHKARGS) \
 { \  { \
         int              c; \          if (n->nchild ineq (x)) \
         if ((c = count(m, n->child)) ineq (x)) \  
                 return(1); \                  return(1); \
         return(man_vwarn(m, n->line, n->pos, \          return(man_verr(m, n->line, n->pos, \
                         "expected line arguments %s %d, have %d", \                          "expected line arguments %s %d, have %d", \
                         #ineq, (x), c)); \                          #ineq, (x), n->nchild)); \
 }  }
   
 INEQ_DEFINE(0, ==, eq0)  INEQ_DEFINE(0, ==, eq0)
 INEQ_DEFINE(1, >=, ge1)  
 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_sec(CHKARGS)
   {
   
           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);
   }
   
   
   static int
   check_part(CHKARGS)
   {
   
           if (MAN_BODY == n->type && 0 == n->nchild)
                   return(man_nwarn(m, n, WBODYARGS));
           return(1);
   }
   
   
   static int
   check_par(CHKARGS)
   {
   
           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);
   }
   
   
   static int
   check_bline(CHKARGS)
   {
   
           assert( ! (MAN_ELINE & m->flags));
           if (MAN_BLINE & m->flags)
                   return(man_nerr(m, n, WLNSCOPE));
   
           return(1);
   }
   
   
   static int
   check_roff(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);
   }
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.36
CVSweb