[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.42 and 1.122

version 1.42, 2010/05/25 12:44:53 version 1.122, 2016/01/08 17:48:09
Line 1 
Line 1 
 /*      $Id$ */  /*      $OpenBSD$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2012-2016 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
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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 26 
Line 25 
 #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 "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "libman.h"  #include "roff.h"
   #include "man.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   #include "roff_int.h"
   #include "libman.h"
   
 #define CHKARGS   struct man *m, const struct man_node *n  #define CHKARGS   struct roff_man *man, struct roff_node *n
   
 typedef int     (*v_check)(CHKARGS);  typedef void    (*v_check)(CHKARGS);
   
 struct  man_valid {  static  void      check_par(CHKARGS);
         v_check  *pres;  static  void      check_part(CHKARGS);
         v_check  *posts;  static  void      check_root(CHKARGS);
 };  static  void      check_text(CHKARGS);
   
 static  int       check_bline(CHKARGS);  static  void      post_AT(CHKARGS);
 static  int       check_eq0(CHKARGS);  static  void      post_IP(CHKARGS);
 static  int       check_le1(CHKARGS);  static  void      post_vs(CHKARGS);
 static  int       check_ge2(CHKARGS);  static  void      post_ft(CHKARGS);
 static  int       check_le5(CHKARGS);  static  void      post_OP(CHKARGS);
 static  int       check_par(CHKARGS);  static  void      post_TH(CHKARGS);
 static  int       check_part(CHKARGS);  static  void      post_UC(CHKARGS);
 static  int       check_root(CHKARGS);  static  void      post_UR(CHKARGS);
 static  int       check_sec(CHKARGS);  
 static  int       check_text(CHKARGS);  
 static  int       check_title(CHKARGS);  
   
 static  v_check   posts_eq0[] = { check_eq0, NULL };  static  v_check man_valids[MAN_MAX] = {
 static  v_check   posts_th[] = { check_ge2, check_le5, check_title, NULL };          post_vs,    /* br */
 static  v_check   posts_par[] = { check_par, NULL };          post_TH,    /* TH */
 static  v_check   posts_part[] = { check_part, NULL };          NULL,       /* SH */
 static  v_check   posts_sec[] = { check_sec, NULL };          NULL,       /* SS */
 static  v_check   posts_le1[] = { check_le1, NULL };          NULL,       /* TP */
 static  v_check   pres_bline[] = { check_bline, NULL };          check_par,  /* LP */
           check_par,  /* PP */
 static  const struct man_valid man_valids[MAN_MAX] = {          check_par,  /* P */
         { NULL, posts_eq0 }, /* br */          post_IP,    /* IP */
         { pres_bline, posts_th }, /* TH */          NULL,       /* HP */
         { pres_bline, posts_sec }, /* SH */          NULL,       /* SM */
         { pres_bline, posts_sec }, /* SS */          NULL,       /* SB */
         { pres_bline, posts_par }, /* TP */          NULL,       /* BI */
         { pres_bline, posts_par }, /* LP */          NULL,       /* IB */
         { pres_bline, posts_par }, /* PP */          NULL,       /* BR */
         { pres_bline, posts_par }, /* P */          NULL,       /* RB */
         { pres_bline, posts_par }, /* IP */          NULL,       /* R */
         { pres_bline, posts_par }, /* HP */          NULL,       /* B */
         { NULL, NULL }, /* SM */          NULL,       /* I */
         { NULL, NULL }, /* SB */          NULL,       /* IR */
         { NULL, NULL }, /* BI */          NULL,       /* RI */
         { NULL, NULL }, /* IB */          post_vs,    /* sp */
         { NULL, NULL }, /* BR */          NULL,       /* nf */
         { NULL, NULL }, /* RB */          NULL,       /* fi */
         { NULL, NULL }, /* R */          NULL,       /* RE */
         { NULL, NULL }, /* B */          check_part, /* RS */
         { NULL, NULL }, /* I */          NULL,       /* DT */
         { NULL, NULL }, /* IR */          post_UC,    /* UC */
         { NULL, NULL }, /* RI */          NULL,       /* PD */
         { NULL, posts_eq0 }, /* na */          post_AT,    /* AT */
         { NULL, NULL }, /* i */          NULL,       /* in */
         { NULL, posts_le1 }, /* sp */          post_ft,    /* ft */
         { pres_bline, posts_eq0 }, /* nf */          post_OP,    /* OP */
         { pres_bline, posts_eq0 }, /* fi */          NULL,       /* EX */
         { NULL, NULL }, /* r */          NULL,       /* EE */
         { NULL, NULL }, /* RE */          post_UR,    /* UR */
         { NULL, posts_part }, /* RS */          NULL,       /* UE */
         { NULL, NULL }, /* DT */          NULL,       /* ll */
         { NULL, NULL }, /* UC */  
         { NULL, NULL }, /* PD */  
         { NULL, posts_le1 }, /* Sp */  
         { pres_bline, posts_le1 }, /* Vb */  
         { pres_bline, posts_eq0 }, /* Ve */  
         { NULL, NULL }, /* AT */  
 };  };
   
   
 int  void
 man_valid_pre(struct man *m, const struct man_node *n)  man_node_validate(struct roff_man *man)
 {  {
           struct roff_node *n;
         v_check         *cp;          v_check         *cp;
   
         if (MAN_TEXT == n->type)          n = man->last;
                 return(1);          man->last = man->last->child;
         if (MAN_ROOT == n->type)          while (man->last != NULL) {
                 return(1);                  man_node_validate(man);
                   if (man->last == n)
                           man->last = man->last->child;
                   else
                           man->last = man->last->next;
           }
   
         if (NULL == (cp = man_valids[n->tok].pres))          man->last = n;
                 return(1);          man->next = ROFF_NEXT_SIBLING;
         for ( ; *cp; cp++)          switch (n->type) {
                 if ( ! (*cp)(m, n))          case ROFFT_TEXT:
                         return(0);                  check_text(man, n);
         return(1);                  break;
           case ROFFT_ROOT:
                   check_root(man, n);
                   break;
           case ROFFT_EQN:
           case ROFFT_TBL:
                   break;
           default:
                   cp = man_valids + n->tok;
                   if (*cp)
                           (*cp)(man, n);
                   if (man->last == n)
                           man_state(man, n);
                   break;
           }
 }  }
   
   static void
 int  check_root(CHKARGS)
 man_valid_post(struct man *m)  
 {  {
         v_check         *cp;  
   
         if (MAN_VALID & m->last->flags)          assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
                 return(1);  
         m->last->flags |= MAN_VALID;  
   
         switch (m->last->type) {          if (NULL == man->first->child)
         case (MAN_TEXT):                  mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                 return(check_text(m, m->last));                      n->line, n->pos, NULL);
         case (MAN_ROOT):          else
                 return(check_root(m, m->last));                  man->meta.hasbody = 1;
         default:  
                 break;          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);
         }          }
   }
   
         if (NULL == (cp = man_valids[m->last->tok].posts))  static void
                 return(1);  check_text(CHKARGS)
         for ( ; *cp; cp++)  {
                 if ( ! (*cp)(m, m->last))          char            *cp, *p;
                         return(0);  
   
         return(1);          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);
 }  }
   
   static void
   post_OP(CHKARGS)
   {
   
 static int          if (n->child == NULL)
 check_root(CHKARGS)                  mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
                       n->line, n->pos, "OP");
           else if (n->child->next != NULL && n->child->next->next != NULL) {
                   n = n->child->next->next;
                   mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                       n->line, n->pos, "OP ... %s", n->string);
           }
   }
   
   static void
   post_UR(CHKARGS)
 {  {
   
         if (MAN_BLINE & m->flags)          if (n->type == ROFFT_HEAD && n->child == NULL)
                 return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));                  mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
         if (MAN_ELINE & m->flags)                      n->line, n->pos, "UR");
                 return(man_nmsg(m, n, MANDOCERR_SCOPEEXIT));          check_part(man, n);
   }
   
         m->flags &= ~MAN_BLINE;  static void
         m->flags &= ~MAN_ELINE;  post_ft(CHKARGS)
   {
           char    *cp;
           int      ok;
   
         if (NULL == m->first->child) {          if (n->child == NULL)
                 man_nmsg(m, n, MANDOCERR_NODOCBODY);                  return;
                 return(0);  
         } else if (NULL == m->meta.title) {          ok = 0;
                 if ( ! man_nmsg(m, n, MANDOCERR_NOTITLE))          cp = n->child->string;
                         return(0);          switch (*cp) {
                 /*          case '1':
                  * If a title hasn't been set, do so now (by          case '2':
                  * implication, date and section also aren't set).          case '3':
                  *          case '4':
                  * FIXME: this should be in man_action.c.          case 'I':
                  */          case 'P':
                 m->meta.title = mandoc_strdup("unknown");          case 'R':
                 m->meta.date = time(NULL);                  if ('\0' == cp[1])
                 m->meta.msec = mandoc_strdup("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;
         }          }
   
         return(1);          if (0 == ok) {
                   mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
                       n->line, n->pos, "ft %s", cp);
                   *cp = '\0';
           }
 }  }
   
   static void
   check_part(CHKARGS)
   {
   
 static int          if (n->type == ROFFT_BODY && n->child == NULL)
 check_title(CHKARGS)                  mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
                       n->line, n->pos, man_macronames[n->tok]);
   }
   
   static void
   check_par(CHKARGS)
 {  {
         const char      *p;  
   
         assert(n->child);          switch (n->type) {
         /* FIXME: is this sufficient? */          case ROFFT_BLOCK:
         if ('\0' == *n->child->string) {                  if (n->body->child == NULL)
                 man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);                          roff_node_delete(man, n);
                 return(0);                  break;
           case ROFFT_BODY:
                   if (n->child == NULL)
                           mandoc_vmsg(MANDOCERR_PAR_SKIP,
                               man->parse, n->line, n->pos,
                               "%s empty", man_macronames[n->tok]);
                   break;
           case ROFFT_HEAD:
                   if (n->child != NULL)
                           mandoc_vmsg(MANDOCERR_ARG_SKIP,
                               man->parse, n->line, n->pos,
                               "%s %s%s", man_macronames[n->tok],
                               n->child->string,
                               n->child->next != NULL ? " ..." : "");
                   break;
           default:
                   break;
         }          }
   }
   
         for (p = n->child->string; '\0' != *p; p++)  static void
                 if (isalpha((u_char)*p) && ! isupper((u_char)*p))  post_IP(CHKARGS)
                         if ( ! man_nmsg(m, n, MANDOCERR_UPPERCASE))  {
                                 return(0);  
   
         return(1);          switch (n->type) {
           case ROFFT_BLOCK:
                   if (n->head->child == NULL && n->body->child == NULL)
                           roff_node_delete(man, n);
                   break;
           case ROFFT_BODY:
                   if (n->parent->head->child == NULL && n->child == NULL)
                           mandoc_vmsg(MANDOCERR_PAR_SKIP,
                               man->parse, n->line, n->pos,
                               "%s empty", man_macronames[n->tok]);
                   break;
           default:
                   break;
           }
 }  }
   
   static void
 static int  post_TH(CHKARGS)
 check_text(CHKARGS)  
 {  {
           struct roff_node *nb;
         const char      *p;          const char      *p;
         int              pos, c;  
   
         assert(n->string);          free(man->meta.title);
           free(man->meta.vol);
           free(man->meta.os);
           free(man->meta.msec);
           free(man->meta.date);
   
         for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {          man->meta.title = man->meta.vol = man->meta.date =
                 if ('\\' == *p) {              man->meta.msec = man->meta.os = NULL;
                         c = mandoc_special(p);  
                         if (c) {  
                                 p += c - 1;  
                                 pos += c - 1;  
                                 continue;  
                         }  
   
                         c = man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);          nb = n;
                         if ( ! (MAN_IGN_ESCAPE & m->pflags) && ! c)  
                                 return(c);          /* ->TITLE<- MSEC DATE OS 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");
           }
   
                 if ('\t' == *p || isprint((u_char)*p) || ASCII_HYPH == *p)          /* TITLE ->MSEC<- DATE OS VOL */
                         continue;  
                 if ( ! man_pmsg(m, n->line, pos, MANDOCERR_BADCHAR))          if (n)
                         return(0);                  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);
         }          }
   
         return(1);          /* TITLE MSEC ->DATE<- OS 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 ->OS<- VOL */
 static int \  
 check_##name(CHKARGS) \  
 { \  
         if (n->nchild ineq (x)) \  
                 return(1); \  
         man_vmsg(m, MANDOCERR_SYNTARGCOUNT, n->line, n->pos, \  
                         "line arguments %s %d (have %d)", \  
                         #ineq, (x), n->nchild); \  
         return(0); \  
 }  
   
 INEQ_DEFINE(0, ==, eq0)          if (n && (n = n->next))
 INEQ_DEFINE(1, <=, le1)                  man->meta.os = mandoc_strdup(n->string);
 INEQ_DEFINE(2, >=, ge2)          else if (man->defos != NULL)
 INEQ_DEFINE(5, <=, le5)                  man->meta.os = mandoc_strdup(man->defos);
   
           /* TITLE MSEC DATE OS ->VOL<- */
           /* If missing, use the default VOL name for MSEC. */
   
 static int          if (n && (n = n->next))
 check_sec(CHKARGS)                  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);
   
         if (MAN_HEAD == n->type && 0 == n->nchild) {          if (n != NULL && (n = n->next) != NULL)
                 man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);                  mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                 return(0);                      n->line, n->pos, "TH ... %s", n->string);
         } else if (MAN_BODY == n->type && 0 == n->nchild)  
                 return(man_nmsg(m, n, MANDOCERR_NOBODY));  
   
         return(1);          /*
            * Remove the `TH' node after we've processed it for our
            * meta-data.
            */
           roff_node_delete(man, man->last);
 }  }
   
   static void
 static int  post_UC(CHKARGS)
 check_part(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 && 0 == n->nchild)          const char      *p, *s;
                 return(man_nmsg(m, n, MANDOCERR_NOBODY));  
         return(1);  
 }  
   
           n = n->child;
   
 static int          if (n == NULL || n->type != ROFFT_TEXT)
 check_par(CHKARGS)                  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];
           }
   
         if (MAN_BODY == n->type)          free(man->meta.os);
                 switch (n->tok) {          man->meta.os = mandoc_strdup(p);
                 case (MAN_IP):  
                         /* FALLTHROUGH */  
                 case (MAN_HP):  
                         /* FALLTHROUGH */  
                 case (MAN_TP):  
                         /* Body-less lists are ok. */  
                         break;  
                 default:  
                         if (n->nchild)  
                                 break;  
                         return(man_nmsg(m, n, MANDOCERR_NOBODY));  
                 }  
         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_nmsg(m, n, MANDOCERR_ARGSLOST));  
                 default:  
                         if (n->nchild)  
                                 break;  
                         return(man_nmsg(m, n, MANDOCERR_NOARGS));  
                 }  
   
         return(1);  
 }  }
   
   static void
 static int  post_AT(CHKARGS)
 check_bline(CHKARGS)  
 {  {
           static const char * const unix_versions[] = {
               "7th Edition",
               "System III",
               "System V",
               "System V Release 2",
           };
   
         assert( ! (MAN_ELINE & m->flags));          struct roff_node *nn;
         if (MAN_BLINE & m->flags) {          const char      *p, *s;
                 man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);  
                 return(0);          n = n->child;
   
           if (n == NULL || n->type != ROFFT_TEXT)
                   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 != NULL &&
                               nn->type == ROFFT_TEXT &&
                               nn->string[0] != '\0')
                                   p = unix_versions[3];
                           else
                                   p = unix_versions[2];
                   } else
                           p = unix_versions[0];
         }          }
   
         return(1);          free(man->meta.os);
           man->meta.os = mandoc_strdup(p);
 }  }
   
   static void
   post_vs(CHKARGS)
   {
   
           if (NULL != n->prev)
                   return;
   
           switch (n->parent->tok) {
           case MAN_SH:
           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 TOKEN_NONE:
                   /*
                    * Don't warn about this because it occurs in pod2man
                    * and would cause considerable (unfixable) warnage.
                    */
                   roff_node_delete(man, n);
                   break;
           default:
                   break;
           }
   }
Legend:
Removed from v.1.42  
changed lines
  Added in v.1.122
CVSweb