[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.129 and 1.142

version 1.129, 2017/06/17 16:47:48 version 1.142, 2018/12/16 00:21:05
Line 1 
Line 1 
 /*      $OpenBSD$ */  /*      $Id$ */
 /*  /*
  * 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-2017 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010, 2012-2018 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 24 
Line 24 
 #include <errno.h>  #include <errno.h>
 #include <limits.h>  #include <limits.h>
 #include <stdarg.h>  #include <stdarg.h>
   #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <time.h>  #include <time.h>
Line 40 
Line 41 
   
 typedef void    (*v_check)(CHKARGS);  typedef void    (*v_check)(CHKARGS);
   
   static  void      check_abort(CHKARGS);
 static  void      check_par(CHKARGS);  static  void      check_par(CHKARGS);
 static  void      check_part(CHKARGS);  static  void      check_part(CHKARGS);
 static  void      check_root(CHKARGS);  static  void      check_root(CHKARGS);
Line 48  static void   check_text(CHKARGS);
Line 50  static void   check_text(CHKARGS);
 static  void      post_AT(CHKARGS);  static  void      post_AT(CHKARGS);
 static  void      post_IP(CHKARGS);  static  void      post_IP(CHKARGS);
 static  void      post_OP(CHKARGS);  static  void      post_OP(CHKARGS);
   static  void      post_SH(CHKARGS);
 static  void      post_TH(CHKARGS);  static  void      post_TH(CHKARGS);
 static  void      post_UC(CHKARGS);  static  void      post_UC(CHKARGS);
 static  void      post_UR(CHKARGS);  static  void      post_UR(CHKARGS);
 static  void      post_in(CHKARGS);  static  void      post_in(CHKARGS);
 static  void      post_vs(CHKARGS);  
   
 static  const v_check __man_valids[MAN_MAX - MAN_TH] = {  static  const v_check man_valids[MAN_MAX - MAN_TH] = {
         post_TH,    /* TH */          post_TH,    /* TH */
         NULL,       /* SH */          post_SH,    /* SH */
         NULL,       /* SS */          post_SH,    /* SS */
         NULL,       /* TP */          NULL,       /* TP */
         check_par,  /* LP */          NULL,       /* TQ */
           check_abort,/* LP */
         check_par,  /* PP */          check_par,  /* PP */
         check_par,  /* P */          check_abort,/* P */
         post_IP,    /* IP */          post_IP,    /* IP */
         NULL,       /* HP */          NULL,       /* HP */
         NULL,       /* SM */          NULL,       /* SM */
Line 84  static const v_check __man_valids[MAN_MAX - MAN_TH] = 
Line 87  static const v_check __man_valids[MAN_MAX - MAN_TH] = 
         NULL,       /* PD */          NULL,       /* PD */
         post_AT,    /* AT */          post_AT,    /* AT */
         post_in,    /* in */          post_in,    /* in */
           NULL,       /* SY */
           NULL,       /* YS */
         post_OP,    /* OP */          post_OP,    /* OP */
         NULL,       /* EX */          NULL,       /* EX */
         NULL,       /* EE */          NULL,       /* EE */
         post_UR,    /* UR */          post_UR,    /* UR */
         NULL,       /* UE */          NULL,       /* UE */
           post_UR,    /* MT */
           NULL,       /* ME */
 };  };
 static  const v_check *man_valids = __man_valids - MAN_TH;  
   
   
   /* Validate the subtree rooted at man->last. */
 void  void
 man_node_validate(struct roff_man *man)  man_node_validate(struct roff_man *man)
 {  {
         struct roff_node *n;          struct roff_node *n;
         const v_check    *cp;          const v_check    *cp;
   
           /*
            * Translate obsolete macros such that later code
            * does not need to look for them.
            */
   
         n = man->last;          n = man->last;
           switch (n->tok) {
           case MAN_LP:
           case MAN_P:
                   n->tok = MAN_PP;
                   break;
           default:
                   break;
           }
   
           /*
            * Iterate over all children, recursing into each one
            * in turn, depth-first.
            */
   
         man->last = man->last->child;          man->last = man->last->child;
         while (man->last != NULL) {          while (man->last != NULL) {
                 man_node_validate(man);                  man_node_validate(man);
Line 109  man_node_validate(struct roff_man *man)
Line 135  man_node_validate(struct roff_man *man)
                         man->last = man->last->next;                          man->last = man->last->next;
         }          }
   
           /* Finally validate the macro itself. */
   
         man->last = n;          man->last = n;
         man->next = ROFF_NEXT_SIBLING;          man->next = ROFF_NEXT_SIBLING;
         switch (n->type) {          switch (n->type) {
Line 118  man_node_validate(struct roff_man *man)
Line 146  man_node_validate(struct roff_man *man)
         case ROFFT_ROOT:          case ROFFT_ROOT:
                 check_root(man, n);                  check_root(man, n);
                 break;                  break;
           case ROFFT_COMMENT:
         case ROFFT_EQN:          case ROFFT_EQN:
         case ROFFT_TBL:          case ROFFT_TBL:
                 break;                  break;
         default:          default:
                 if (n->tok < ROFF_MAX) {                  if (n->tok < ROFF_MAX) {
                         switch (n->tok) {                          roff_validate(man);
                         case ROFF_br:  
                         case ROFF_sp:  
                                 post_vs(man, n);  
                                 break;  
                         default:  
                                 roff_validate(man);  
                                 break;  
                         }  
                         break;                          break;
                 }                  }
                 assert(n->tok >= MAN_TH && n->tok < MAN_MAX);                  assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
                 cp = man_valids + n->tok;                  cp = man_valids + (n->tok - MAN_TH);
                 if (*cp)                  if (*cp)
                         (*cp)(man, n);                          (*cp)(man, n);
                 if (man->last == n)                  if (man->last == n)
Line 147  man_node_validate(struct roff_man *man)
Line 168  man_node_validate(struct roff_man *man)
 static void  static void
 check_root(CHKARGS)  check_root(CHKARGS)
 {  {
   
         assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);          assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
   
         if (NULL == man->first->child)          if (n->last == NULL || n->last->type == ROFFT_COMMENT)
                 mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,                  mandoc_msg(MANDOCERR_DOC_EMPTY, n->line, n->pos, NULL);
                     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) {
                 mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,                  mandoc_msg(MANDOCERR_TH_NOTITLE, n->line, n->pos, NULL);
                     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
Line 170  check_root(CHKARGS)
Line 188  check_root(CHKARGS)
                 man->meta.date = man->quick ? mandoc_strdup("") :                  man->meta.date = man->quick ? mandoc_strdup("") :
                     mandoc_normdate(man, NULL, n->line, n->pos);                      mandoc_normdate(man, NULL, n->line, n->pos);
         }          }
   
           if (man->meta.os_e &&
               (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
                   mandoc_msg(MANDOCERR_RCS_MISSING, 0, 0,
                       man->meta.os_e == MANDOC_OS_OPENBSD ?
                       "(OpenBSD)" : "(NetBSD)");
 }  }
   
 static void  static void
   check_abort(CHKARGS)
   {
           abort();
   }
   
   static void
 check_text(CHKARGS)  check_text(CHKARGS)
 {  {
         char            *cp, *p;          char            *cp, *p;
Line 182  check_text(CHKARGS)
Line 212  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++)
                 mandoc_msg(MANDOCERR_FI_TAB, man->parse,                  mandoc_msg(MANDOCERR_FI_TAB,
                     n->line, n->pos + (p - cp), NULL);                      n->line, n->pos + (int)(p - cp), NULL);
 }  }
   
 static void  static void
Line 191  post_OP(CHKARGS)
Line 221  post_OP(CHKARGS)
 {  {
   
         if (n->child == NULL)          if (n->child == NULL)
                 mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,                  mandoc_msg(MANDOCERR_OP_EMPTY, n->line, n->pos, "OP");
                     n->line, n->pos, "OP");  
         else if (n->child->next != NULL && n->child->next->next != NULL) {          else if (n->child->next != NULL && n->child->next->next != NULL) {
                 n = n->child->next->next;                  n = n->child->next->next;
                 mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,                  mandoc_msg(MANDOCERR_ARG_EXCESS,
                     n->line, n->pos, "OP ... %s", n->string);                      n->line, n->pos, "OP ... %s", n->string);
         }          }
 }  }
   
 static void  static void
 post_UR(CHKARGS)  post_SH(CHKARGS)
 {  {
           struct roff_node        *nc;
   
           if (n->type != ROFFT_BODY || (nc = n->child) == NULL)
                   return;
   
           if (nc->tok == MAN_PP && nc->body->child != NULL) {
                   while (nc->body->last != NULL) {
                           man->next = ROFF_NEXT_CHILD;
                           roff_node_relink(man, nc->body->last);
                           man->last = n;
                   }
           }
   
           if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
                   mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
                       "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
                   roff_node_delete(man, nc);
           }
   
           /*
            * Trailing PP is empty, so it is deleted by check_par().
            * Trailing sp is significant.
            */
   
           if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
                   mandoc_msg(MANDOCERR_PAR_SKIP,
                       nc->line, nc->pos, "%s at the end of %s",
                       roff_name[nc->tok], roff_name[n->tok]);
                   roff_node_delete(man, nc);
           }
   }
   
   static void
   post_UR(CHKARGS)
   {
         if (n->type == ROFFT_HEAD && n->child == NULL)          if (n->type == ROFFT_HEAD && n->child == NULL)
                 mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,                  mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
                     n->line, n->pos, "UR");                      "%s", roff_name[n->tok]);
         check_part(man, n);          check_part(man, n);
 }  }
   
Line 215  check_part(CHKARGS)
Line 278  check_part(CHKARGS)
 {  {
   
         if (n->type == ROFFT_BODY && n->child == NULL)          if (n->type == ROFFT_BODY && n->child == NULL)
                 mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,                  mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos,
                     n->line, n->pos, roff_name[n->tok]);                      "%s", roff_name[n->tok]);
 }  }
   
 static void  static void
Line 229  check_par(CHKARGS)
Line 292  check_par(CHKARGS)
                         roff_node_delete(man, n);                          roff_node_delete(man, n);
                 break;                  break;
         case ROFFT_BODY:          case ROFFT_BODY:
                   if (n->child != NULL &&
                       (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
                           mandoc_msg(MANDOCERR_PAR_SKIP,
                               n->child->line, n->child->pos,
                               "%s after %s", roff_name[n->child->tok],
                               roff_name[n->tok]);
                           roff_node_delete(man, n->child);
                   }
                 if (n->child == NULL)                  if (n->child == NULL)
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
                             man->parse, n->line, n->pos,  
                             "%s empty", roff_name[n->tok]);                              "%s empty", roff_name[n->tok]);
                 break;                  break;
         case ROFFT_HEAD:          case ROFFT_HEAD:
                 if (n->child != NULL)                  if (n->child != NULL)
                         mandoc_vmsg(MANDOCERR_ARG_SKIP,                          mandoc_msg(MANDOCERR_ARG_SKIP,
                             man->parse, n->line, n->pos, "%s %s%s",                              n->line, n->pos, "%s %s%s",
                             roff_name[n->tok], n->child->string,                              roff_name[n->tok], n->child->string,
                             n->child->next != NULL ? " ..." : "");                              n->child->next != NULL ? " ..." : "");
                 break;                  break;
Line 257  post_IP(CHKARGS)
Line 327  post_IP(CHKARGS)
                 break;                  break;
         case ROFFT_BODY:          case ROFFT_BODY:
                 if (n->parent->head->child == NULL && n->child == NULL)                  if (n->parent->head->child == NULL && n->child == NULL)
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
                             man->parse, n->line, n->pos,  
                             "%s empty", roff_name[n->tok]);                              "%s empty", roff_name[n->tok]);
                 break;                  break;
         default:          default:
Line 291  post_TH(CHKARGS)
Line 360  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_vmsg(MANDOCERR_TITLE_CASE,                                  mandoc_msg(MANDOCERR_TITLE_CASE, n->line,
                                     man->parse, n->line,                                      n->pos + (int)(p - n->string),
                                     n->pos + (p - n->string),  
                                     "TH %s", n->string);                                      "TH %s", n->string);
                                 break;                                  break;
                         }                          }
Line 301  post_TH(CHKARGS)
Line 369  post_TH(CHKARGS)
                 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,                  mandoc_msg(MANDOCERR_TH_NOTITLE, nb->line, nb->pos, "TH");
                     nb->line, nb->pos, "TH");  
         }          }
   
         /* TITLE ->MSEC<- DATE OS VOL */          /* TITLE ->MSEC<- DATE OS VOL */
Line 313  post_TH(CHKARGS)
Line 380  post_TH(CHKARGS)
                 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,                  mandoc_msg(MANDOCERR_MSEC_MISSING,
                     nb->line, nb->pos, "TH %s", man->meta.title);                      nb->line, nb->pos, "TH %s", man->meta.title);
         }          }
   
Line 327  post_TH(CHKARGS)
Line 394  post_TH(CHKARGS)
                     mandoc_normdate(man, n->string, n->line, n->pos);                      mandoc_normdate(man, n->string, n->line, n->pos);
         } else {          } else {
                 man->meta.date = mandoc_strdup("");                  man->meta.date = mandoc_strdup("");
                 mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,                  mandoc_msg(MANDOCERR_DATE_MISSING,
                     n ? n->line : nb->line,                      n ? n->line : nb->line,
                     n ? n->pos : nb->pos, "TH");                      n ? n->pos : nb->pos, "TH");
         }          }
Line 336  post_TH(CHKARGS)
Line 403  post_TH(CHKARGS)
   
         if (n && (n = n->next))          if (n && (n = n->next))
                 man->meta.os = mandoc_strdup(n->string);                  man->meta.os = mandoc_strdup(n->string);
         else if (man->defos != NULL)          else if (man->os_s != NULL)
                 man->meta.os = mandoc_strdup(man->defos);                  man->meta.os = mandoc_strdup(man->os_s);
           if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
                   if (strstr(man->meta.os, "OpenBSD") != NULL)
                           man->meta.os_e = MANDOC_OS_OPENBSD;
                   else if (strstr(man->meta.os, "NetBSD") != NULL)
                           man->meta.os_e = MANDOC_OS_NETBSD;
           }
   
         /* TITLE MSEC DATE OS ->VOL<- */          /* TITLE MSEC DATE OS ->VOL<- */
         /* If missing, use the default VOL name for MSEC. */          /* If missing, use the default VOL name for MSEC. */
Line 349  post_TH(CHKARGS)
Line 422  post_TH(CHKARGS)
                 man->meta.vol = mandoc_strdup(p);                  man->meta.vol = mandoc_strdup(p);
   
         if (n != NULL && (n = n->next) != NULL)          if (n != NULL && (n = n->next) != NULL)
                 mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,                  mandoc_msg(MANDOCERR_ARG_EXCESS,
                     n->line, n->pos, "TH ... %s", n->string);                      n->line, n->pos, "TH ... %s", n->string);
   
         /*          /*
Line 449  post_in(CHKARGS)
Line 522  post_in(CHKARGS)
         mandoc_asprintf(&s, "+%s", n->child->string);          mandoc_asprintf(&s, "+%s", n->child->string);
         free(n->child->string);          free(n->child->string);
         n->child->string = s;          n->child->string = s;
 }  
   
 static void  
 post_vs(CHKARGS)  
 {  
   
         if (NULL != n->prev)  
                 return;  
   
         switch (n->parent->tok) {  
         case MAN_SH:  
         case MAN_SS:  
         case MAN_PP:  
         case MAN_LP:  
         case MAN_P:  
                 mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,  
                     "%s after %s", roff_name[n->tok],  
                     roff_name[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.129  
changed lines
  Added in v.1.142
CVSweb