[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.1 and 1.111

version 1.1, 2009/03/25 15:17:49 version 1.111, 2015/02/06 08:28:35
Line 1 
Line 1 
 /* $Id$ */  /*      $OpenBSD$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * 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   * 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.  
  */   */
   #include "config.h"
   
 #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"
   
 /* FIXME: validate text. */  #define CHKARGS   struct man *man, struct man_node *n
   
 #define POSTARGS  struct man *m, const struct man_node *n  typedef void    (*v_check)(CHKARGS);
   
 typedef int     (*v_post)(POSTARGS);  static  void      check_eq2(CHKARGS);
   static  void      check_le1(CHKARGS);
   static  void      check_le5(CHKARGS);
   static  void      check_par(CHKARGS);
   static  void      check_part(CHKARGS);
   static  void      check_root(CHKARGS);
   static  void      check_text(CHKARGS);
   
 struct  man_valid {  static  void      post_AT(CHKARGS);
         v_post   *posts;  static  void      post_IP(CHKARGS);
 };  static  void      post_vs(CHKARGS);
   static  void      post_fi(CHKARGS);
   static  void      post_ft(CHKARGS);
   static  void      post_nf(CHKARGS);
   static  void      post_TH(CHKARGS);
   static  void      post_UC(CHKARGS);
   static  void      post_UR(CHKARGS);
   
 static  int       count(POSTARGS);  static  v_check man_valids[MAN_MAX] = {
 static  int       check_eq0(POSTARGS);          post_vs,    /* br */
 static  int       check_ge1(POSTARGS);          post_TH,    /* TH */
 static  int       check_ge2(POSTARGS);          NULL,       /* SH */
 static  int       check_le1(POSTARGS);          NULL,       /* SS */
 static  int       check_le2(POSTARGS);          NULL,       /* TP */
 static  int       check_le5(POSTARGS);          check_par,  /* LP */
           check_par,  /* PP */
 static  v_post    posts_le1[] = { check_le1, NULL };          check_par,  /* P */
 static  v_post    posts_le2[] = { check_le2, NULL };          post_IP,    /* IP */
 static  v_post    posts_ge1[] = { check_ge1, NULL };          NULL,       /* HP */
 static  v_post    posts_eq0[] = { check_eq0, NULL };          NULL,       /* SM */
 static  v_post    posts_ge2_le5[] = { check_ge2, check_le5, NULL };          NULL,       /* SB */
           NULL,       /* BI */
 static  const struct man_valid man_valids[MAN_MAX] = {          NULL,       /* IB */
         { NULL }, /* __ */          NULL,       /* BR */
         { posts_ge2_le5 }, /* TH */          NULL,       /* RB */
         { posts_ge1 }, /* SH */          NULL,       /* R */
         { posts_ge1 }, /* SS */          NULL,       /* B */
         { posts_le1 }, /* TP */          NULL,       /* I */
         { posts_eq0 }, /* LP */          NULL,       /* IR */
         { posts_eq0 }, /* PP */          NULL,       /* RI */
         { posts_eq0 }, /* P */          post_vs,    /* sp */
         { posts_le2 }, /* IP */          post_nf,    /* nf */
         { posts_le1 }, /* HP */          post_fi,    /* fi */
         { NULL }, /* SM */          NULL,       /* RE */
         { NULL }, /* SB */          check_part, /* RS */
         { NULL }, /* BI */          NULL,       /* DT */
         { NULL }, /* IB */          post_UC,    /* UC */
         { NULL }, /* BR */          check_le1,  /* PD */
         { NULL }, /* RB */          post_AT,    /* AT */
         { NULL }, /* R */          NULL,       /* in */
         { NULL }, /* B */          post_ft,    /* ft */
         { NULL }, /* I */          check_eq2,  /* OP */
         { NULL }, /* IR */          post_nf,    /* EX */
           post_fi,    /* EE */
           post_UR,    /* UR */
           NULL,       /* UE */
           NULL,       /* ll */
 };  };
   
   
 int  void
 man_valid_post(struct man *m)  man_valid_post(struct man *man)
 {  {
         v_post          *cp;          struct man_node *n;
           v_check         *cp;
   
         if (MAN_VALID & m->last->flags)          n = man->last;
                 return(1);          if (n->flags & MAN_VALID)
                   return;
           n->flags |= MAN_VALID;
   
         m->last->flags |= MAN_VALID;          switch (n->type) {
           case MAN_TEXT:
         switch (m->last->type) {                  check_text(man, n);
         case (MAN_TEXT):                  break;
           case MAN_ROOT:
                   check_root(man, n);
                   break;
           case MAN_EQN:
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MAN_ROOT):          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[m->last->tok].posts))  static void
                 return(1);  check_root(CHKARGS)
         for ( ; *cp; cp++)  {
                 if ( ! (*cp)(m, m->last))  
                         return(0);  
   
         return(1);          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;
   
 static inline int          if (NULL == man->meta.title) {
 count(POSTARGS)                  mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
 {                      n->line, n->pos, NULL);
         int              i;  
   
         for (i = 0; n; n = n->next, i++)                  /*
                 /* Loop. */ ;                   * If a title hasn't been set, do so now (by
         return(i);                   * 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);
           }
 }  }
   
   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++)
                   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(POSTARGS) \  check_##name(CHKARGS) \
 { \  { \
         int              c; \          if (n->nchild ineq (x)) \
         if ((c = count(m, n->child)) ineq (x)) \                  return; \
                 return(1); \          mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
         return(man_vwarn(m, n->line, n->pos, \              "line arguments %s %d (have %d)", \
                         "expected line arguments %s %d, have %d", \              #ineq, (x), n->nchild); \
                         #ineq, (x), c)); \  
 }  }
   
 INEQ_DEFINE(0, ==, eq0)  INEQ_DEFINE(2, ==, eq2)
 INEQ_DEFINE(1, >=, ge1)  
 INEQ_DEFINE(2, >=, ge2)  
 INEQ_DEFINE(1, <=, le1)  INEQ_DEFINE(1, <=, le1)
 INEQ_DEFINE(2, <=, le2)  
 INEQ_DEFINE(5, <=, le5)  INEQ_DEFINE(5, <=, le5)
   
   static void
   post_UR(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);
           check_part(man, n);
   }
   
   static void
   post_ft(CHKARGS)
   {
           char    *cp;
           int      ok;
   
           if (0 == n->nchild)
                   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':
                   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);
   }
   
   static void
   check_part(CHKARGS)
   {
   
           if (n->type == MAN_BODY && n->child == NULL)
                   mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
                       n->line, n->pos, man_macronames[n->tok]);
   }
   
   static void
   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;
           }
   }
   
   static void
   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;
           }
   }
   
   static void
   post_TH(CHKARGS)
   {
           struct man_node *nb;
           const char      *p;
   
           check_le5(man, n);
   
           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_vmsg(MANDOCERR_TITLE_CASE,
                                       man->parse, n->line,
                                       n->pos + (p - n->string),
                                       "TH %s", n->string);
                                   break;
                           }
                   }
                   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 */
   
           if (n)
                   n = n->next;
           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);
           }
   
           /* 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");
           }
   
           /* TITLE MSEC DATE ->SOURCE<- VOL */
   
           if (n && (n = n->next))
                   man->meta.source = mandoc_strdup(n->string);
           else if (man->defos != NULL)
                   man->meta.source = mandoc_strdup(man->defos);
   
           /* 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);
   }
   
   static void
   post_nf(CHKARGS)
   {
   
           if (man->flags & MAN_LITERAL)
                   mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                       n->line, n->pos, "nf");
   
           man->flags |= MAN_LITERAL;
   }
   
   static void
   post_fi(CHKARGS)
   {
   
           if ( ! (MAN_LITERAL & man->flags))
                   mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                       n->line, n->pos, "fi");
   
           man->flags &= ~MAN_LITERAL;
   }
   
   static void
   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);
   }
   
   static void
   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);
   }
   
   static void
   post_vs(CHKARGS)
   {
   
           if (n->tok == MAN_sp)
                   check_le1(man, n);
   
           if (NULL != n->prev)
                   return;
   
           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;
           }
   }
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.111
CVSweb