[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.98 and 1.112

version 1.98, 2014/07/05 12:34:17 version 1.112, 2015/02/06 09:38:43
Line 1 
Line 1 
 /*      $Id$ */  /*      $OpenBSD$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
Line 15 
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"  #include "config.h"
 #endif  
   
 #include <sys/types.h>  #include <sys/types.h>
   
Line 38 
Line 36 
   
 #define CHKARGS   struct man *man, struct man_node *n  #define CHKARGS   struct man *man, struct man_node *n
   
 typedef int     (*v_check)(CHKARGS);  typedef void    (*v_check)(CHKARGS);
   
 struct  man_valid {  static  void      check_eq2(CHKARGS);
         v_check  *pres;  static  void      check_le5(CHKARGS);
         v_check  *posts;  static  void      check_par(CHKARGS);
 };  static  void      check_part(CHKARGS);
   static  void      check_root(CHKARGS);
 static  int       check_eq0(CHKARGS);  
 static  int       check_eq2(CHKARGS);  
 static  int       check_le1(CHKARGS);  
 static  int       check_ge2(CHKARGS);  
 static  int       check_le5(CHKARGS);  
 static  int       check_head1(CHKARGS);  
 static  int       check_par(CHKARGS);  
 static  int       check_part(CHKARGS);  
 static  int       check_root(CHKARGS);  
 static  void      check_text(CHKARGS);  static  void      check_text(CHKARGS);
   
 static  int       post_AT(CHKARGS);  static  void      post_AT(CHKARGS);
 static  int       post_IP(CHKARGS);  static  void      post_IP(CHKARGS);
 static  int       post_vs(CHKARGS);  static  void      post_vs(CHKARGS);
 static  int       post_fi(CHKARGS);  static  void      post_fi(CHKARGS);
 static  int       post_ft(CHKARGS);  static  void      post_ft(CHKARGS);
 static  int       post_nf(CHKARGS);  static  void      post_nf(CHKARGS);
 static  int       post_sec(CHKARGS);  static  void      post_TH(CHKARGS);
 static  int       post_TH(CHKARGS);  static  void      post_UC(CHKARGS);
 static  int       post_UC(CHKARGS);  static  void      post_UR(CHKARGS);
 static  int       pre_sec(CHKARGS);  
   
 static  v_check   posts_at[] = { post_AT, NULL };  static  v_check man_valids[MAN_MAX] = {
 static  v_check   posts_br[] = { post_vs, check_eq0, NULL };          post_vs,    /* br */
 static  v_check   posts_eq0[] = { check_eq0, NULL };          post_TH,    /* TH */
 static  v_check   posts_eq2[] = { check_eq2, NULL };          NULL,       /* SH */
 static  v_check   posts_fi[] = { check_eq0, post_fi, NULL };          NULL,       /* SS */
 static  v_check   posts_ft[] = { post_ft, NULL };          NULL,       /* TP */
 static  v_check   posts_ip[] = { post_IP, NULL };          check_par,  /* LP */
 static  v_check   posts_le1[] = { check_le1, NULL };          check_par,  /* PP */
 static  v_check   posts_nf[] = { check_eq0, post_nf, NULL };          check_par,  /* P */
 static  v_check   posts_par[] = { check_par, NULL };          post_IP,    /* IP */
 static  v_check   posts_part[] = { check_part, NULL };          NULL,       /* HP */
 static  v_check   posts_sec[] = { post_sec, NULL };          NULL,       /* SM */
 static  v_check   posts_sp[] = { post_vs, check_le1, NULL };          NULL,       /* SB */
 static  v_check   posts_th[] = { check_ge2, check_le5, post_TH, NULL };          NULL,       /* BI */
 static  v_check   posts_uc[] = { post_UC, NULL };          NULL,       /* IB */
 static  v_check   posts_ur[] = { check_head1, check_part, NULL };          NULL,       /* BR */
 static  v_check   pres_sec[] = { pre_sec, NULL };          NULL,       /* RB */
           NULL,       /* R */
 static  const struct man_valid man_valids[MAN_MAX] = {          NULL,       /* B */
         { NULL, posts_br }, /* br */          NULL,       /* I */
         { NULL, posts_th }, /* TH */          NULL,       /* IR */
         { pres_sec, posts_sec }, /* SH */          NULL,       /* RI */
         { pres_sec, posts_sec }, /* SS */          post_vs,    /* sp */
         { NULL, NULL }, /* TP */          post_nf,    /* nf */
         { NULL, posts_par }, /* LP */          post_fi,    /* fi */
         { NULL, posts_par }, /* PP */          NULL,       /* RE */
         { NULL, posts_par }, /* P */          check_part, /* RS */
         { NULL, posts_ip }, /* IP */          NULL,       /* DT */
         { NULL, NULL }, /* HP */          post_UC,    /* UC */
         { NULL, NULL }, /* SM */          NULL,       /* PD */
         { NULL, NULL }, /* SB */          post_AT,    /* AT */
         { NULL, NULL }, /* BI */          NULL,       /* in */
         { NULL, NULL }, /* IB */          post_ft,    /* ft */
         { NULL, NULL }, /* BR */          check_eq2,  /* OP */
         { NULL, NULL }, /* RB */          post_nf,    /* EX */
         { NULL, NULL }, /* R */          post_fi,    /* EE */
         { NULL, NULL }, /* B */          post_UR,    /* UR */
         { NULL, NULL }, /* I */          NULL,       /* UE */
         { NULL, NULL }, /* IR */          NULL,       /* ll */
         { NULL, NULL }, /* RI */  
         { NULL, posts_eq0 }, /* na */  
         { 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  void
 man_valid_pre(struct man *man, struct man_node *n)  
 {  
         v_check         *cp;  
   
         switch (n->type) {  
         case MAN_TEXT:  
                 /* FALLTHROUGH */  
         case MAN_ROOT:  
                 /* FALLTHROUGH */  
         case MAN_EQN:  
                 /* FALLTHROUGH */  
         case MAN_TBL:  
                 return(1);  
         default:  
                 break;  
         }  
   
         if (NULL == (cp = man_valids[n->tok].pres))  
                 return(1);  
         for ( ; *cp; cp++)  
                 if ( ! (*cp)(man, n))  
                         return(0);  
         return(1);  
 }  
   
 int  
 man_valid_post(struct man *man)  man_valid_post(struct man *man)
 {  {
           struct man_node *n;
         v_check         *cp;          v_check         *cp;
   
         if (MAN_VALID & man->last->flags)          n = man->last;
                 return(1);          if (n->flags & MAN_VALID)
         man->last->flags |= MAN_VALID;                  return;
           n->flags |= MAN_VALID;
   
         switch (man->last->type) {          switch (n->type) {
         case MAN_TEXT:          case MAN_TEXT:
                 check_text(man, man->last);                  check_text(man, n);
                 return(1);                  break;
         case MAN_ROOT:          case MAN_ROOT:
                 return(check_root(man, man->last));                  check_root(man, n);
                   break;
         case MAN_EQN:          case MAN_EQN:
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case MAN_TBL:          case MAN_TBL:
                 return(1);                  break;
         default:          default:
                   cp = man_valids + n->tok;
                   if (*cp)
                           (*cp)(man, n);
                 break;                  break;
         }          }
   
         if (NULL == (cp = man_valids[man->last->tok].posts))  
                 return(1);  
         for ( ; *cp; cp++)  
                 if ( ! (*cp)(man, man->last))  
                         return(0);  
   
         return(1);  
 }  }
   
 static int  static void
 check_root(CHKARGS)  check_root(CHKARGS)
 {  {
   
         if (MAN_BLINE & man->flags)          assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
                 man_nmsg(man, n, MANDOCERR_SCOPEEXIT);  
         else if (MAN_ELINE & man->flags)  
                 man_nmsg(man, n, MANDOCERR_SCOPEEXIT);  
   
         man->flags &= ~MAN_BLINE;  
         man->flags &= ~MAN_ELINE;  
   
         if (NULL == man->first->child)          if (NULL == man->first->child)
                 man_nmsg(man, n, MANDOCERR_DOC_EMPTY);                  mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                       n->line, n->pos, NULL);
         else          else
                 man->meta.hasbody = 1;                  man->meta.hasbody = 1;
   
         if (NULL == man->meta.title) {          if (NULL == man->meta.title) {
                 man_nmsg(man, n, MANDOCERR_TH_MISSING);                  mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
                       n->line, n->pos, NULL);
   
                 /*                  /*
                  * If a title hasn't been set, do so now (by                   * If a title hasn't been set, do so now (by
                  * implication, date and section also aren't set).                   * implication, date and section also aren't set).
                  */                   */
   
                 man->meta.title = mandoc_strdup("unknown");                  man->meta.title = mandoc_strdup("");
                 man->meta.msec = mandoc_strdup("1");                  man->meta.msec = mandoc_strdup("");
                 man->meta.date = man->quick ? mandoc_strdup("") :                  man->meta.date = man->quick ? mandoc_strdup("") :
                     mandoc_normdate(man->parse, NULL, n->line, n->pos);                      mandoc_normdate(man->parse, NULL, n->line, n->pos);
         }          }
   
         return(1);  
 }  }
   
 static void  static void
Line 230  check_text(CHKARGS)
Line 165  check_text(CHKARGS)
   
         cp = n->string;          cp = n->string;
         for (p = cp; NULL != (p = strchr(p, '\t')); p++)          for (p = cp; NULL != (p = strchr(p, '\t')); p++)
                 man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB);                  mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                       n->line, n->pos + (p - cp), NULL);
 }  }
   
 #define INEQ_DEFINE(x, ineq, name) \  #define INEQ_DEFINE(x, ineq, name) \
 static int \  static void \
 check_##name(CHKARGS) \  check_##name(CHKARGS) \
 { \  { \
         if (n->nchild ineq (x)) \          if (n->nchild ineq (x)) \
                 return(1); \                  return; \
         mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \          mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
             "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(2, ==, eq2)  INEQ_DEFINE(2, ==, eq2)
 INEQ_DEFINE(1, <=, le1)  
 INEQ_DEFINE(2, >=, ge2)  
 INEQ_DEFINE(5, <=, le5)  INEQ_DEFINE(5, <=, le5)
   
 static int  static void
 check_head1(CHKARGS)  post_UR(CHKARGS)
 {  {
   
         if (MAN_HEAD == n->type && 1 != n->nchild)          if (MAN_HEAD == n->type && 1 != n->nchild)
                 mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,                  mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
                     n->pos, "line arguments eq 1 (have %d)", n->nchild);                      n->pos, "line arguments eq 1 (have %d)", n->nchild);
           check_part(man, n);
         return(1);  
 }  }
   
 static int  static void
 post_ft(CHKARGS)  post_ft(CHKARGS)
 {  {
         char    *cp;          char    *cp;
         int      ok;          int      ok;
   
         if (0 == n->nchild)          if (0 == n->nchild)
                 return(1);                  return;
   
         ok = 0;          ok = 0;
         cp = n->child->string;          cp = n->child->string;
Line 307  post_ft(CHKARGS)
Line 238  post_ft(CHKARGS)
                     n->line, n->pos, "ft %s", cp);                      n->line, n->pos, "ft %s", cp);
                 *cp = '\0';                  *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  static void
 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)  check_part(CHKARGS)
 {  {
   
         if (MAN_BODY == n->type && 0 == n->nchild)          if (n->type == MAN_BODY && n->child == NULL)
                 mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,                  mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
                     n->pos, "want children (have none)");                      n->line, n->pos, man_macronames[n->tok]);
   
         return(1);  
 }  }
   
 static int  static void
 check_par(CHKARGS)  check_par(CHKARGS)
 {  {
   
Line 372  check_par(CHKARGS)
Line 275  check_par(CHKARGS)
         default:          default:
                 break;                  break;
         }          }
   
         return(1);  
 }  }
   
 static int  static void
 post_IP(CHKARGS)  post_IP(CHKARGS)
 {  {
   
Line 394  post_IP(CHKARGS)
Line 295  post_IP(CHKARGS)
         default:          default:
                 break;                  break;
         }          }
         return(1);  
 }  }
   
 static int  static void
 post_TH(CHKARGS)  post_TH(CHKARGS)
 {  {
         struct man_node *nb;          struct man_node *nb;
         const char      *p;          const char      *p;
   
           check_le5(man, n);
   
         free(man->meta.title);          free(man->meta.title);
         free(man->meta.vol);          free(man->meta.vol);
         free(man->meta.source);          free(man->meta.source);
Line 422  post_TH(CHKARGS)
Line 324  post_TH(CHKARGS)
                         /* Only warn about this once... */                          /* Only warn about this once... */
                         if (isalpha((unsigned char)*p) &&                          if (isalpha((unsigned char)*p) &&
                             ! isupper((unsigned char)*p)) {                              ! isupper((unsigned char)*p)) {
                                 mandoc_msg(MANDOCERR_TITLE_CASE,                                  mandoc_vmsg(MANDOCERR_TITLE_CASE,
                                     man->parse, n->line,                                      man->parse, n->line,
                                     n->pos + (p - n->string),                                      n->pos + (p - n->string),
                                     n->string);                                      "TH %s", n->string);
                                 break;                                  break;
                         }                          }
                 }                  }
                 man->meta.title = mandoc_strdup(n->string);                  man->meta.title = mandoc_strdup(n->string);
         } else          } else {
                 man->meta.title = mandoc_strdup("");                  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 SOURCE VOL */
   
Line 439  post_TH(CHKARGS)
Line 344  post_TH(CHKARGS)
                 n = n->next;                  n = n->next;
         if (n && n->string)          if (n && n->string)
                 man->meta.msec = mandoc_strdup(n->string);                  man->meta.msec = mandoc_strdup(n->string);
         else          else {
                 man->meta.msec = mandoc_strdup("");                  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<- SOURCE VOL */
   
Line 453  post_TH(CHKARGS)
Line 361  post_TH(CHKARGS)
                         n->line, n->pos);                          n->line, n->pos);
         } else {          } else {
                 man->meta.date = mandoc_strdup("");                  man->meta.date = mandoc_strdup("");
                 man_nmsg(man, n ? n : nb, MANDOCERR_DATE_MISSING);                  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 ->SOURCE<- VOL */
   
         if (n && (n = n->next))          if (n && (n = n->next))
                 man->meta.source = mandoc_strdup(n->string);                  man->meta.source = mandoc_strdup(n->string);
           else if (man->defos != NULL)
                   man->meta.source = mandoc_strdup(man->defos);
   
         /* TITLE MSEC DATE SOURCE ->VOL<- */          /* TITLE MSEC DATE SOURCE ->VOL<- */
         /* If missing, use the default VOL name for MSEC. */          /* If missing, use the default VOL name for MSEC. */
Line 475  post_TH(CHKARGS)
Line 387  post_TH(CHKARGS)
          * meta-data.           * meta-data.
          */           */
         man_node_delete(man, man->last);          man_node_delete(man, man->last);
         return(1);  
 }  }
   
 static int  static void
 post_nf(CHKARGS)  post_nf(CHKARGS)
 {  {
   
         if (MAN_LITERAL & man->flags)          if (man->flags & MAN_LITERAL)
                 man_nmsg(man, n, MANDOCERR_NF_SKIP);                  mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                       n->line, n->pos, "nf");
   
         man->flags |= MAN_LITERAL;          man->flags |= MAN_LITERAL;
         return(1);  
 }  }
   
 static int  static void
 post_fi(CHKARGS)  post_fi(CHKARGS)
 {  {
   
         if ( ! (MAN_LITERAL & man->flags))          if ( ! (MAN_LITERAL & man->flags))
                 man_nmsg(man, n, MANDOCERR_FI_SKIP);                  mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                       n->line, n->pos, "fi");
   
         man->flags &= ~MAN_LITERAL;          man->flags &= ~MAN_LITERAL;
         return(1);  
 }  }
   
 static int  static void
 post_UC(CHKARGS)  post_UC(CHKARGS)
 {  {
         static const char * const bsd_versions[] = {          static const char * const bsd_versions[] = {
Line 535  post_UC(CHKARGS)
Line 446  post_UC(CHKARGS)
   
         free(man->meta.source);          free(man->meta.source);
         man->meta.source = mandoc_strdup(p);          man->meta.source = mandoc_strdup(p);
         return(1);  
 }  }
   
 static int  static void
 post_AT(CHKARGS)  post_AT(CHKARGS)
 {  {
         static const char * const unix_versions[] = {          static const char * const unix_versions[] = {
Line 573  post_AT(CHKARGS)
Line 483  post_AT(CHKARGS)
   
         free(man->meta.source);          free(man->meta.source);
         man->meta.source = mandoc_strdup(p);          man->meta.source = mandoc_strdup(p);
         return(1);  
 }  }
   
 static int  static void
 post_vs(CHKARGS)  post_vs(CHKARGS)
 {  {
   
         if (NULL != n->prev)          if (NULL != n->prev)
                 return(1);                  return;
   
         switch (n->parent->tok) {          switch (n->parent->tok) {
         case MAN_SH:          case MAN_SH:
Line 601  post_vs(CHKARGS)
Line 510  post_vs(CHKARGS)
         default:          default:
                 break;                  break;
         }          }
   
         return(1);  
 }  }
Legend:
Removed from v.1.98  
changed lines
  Added in v.1.112
CVSweb