[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.117 and 1.130

version 1.117, 2015/04/18 16:06:40 version 1.130, 2017/06/17 22:43:14
Line 1 
Line 1 
 /*      $OpenBSD$ */  /*      $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-2015 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010, 2012-2017 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 33 
Line 33 
 #include "roff.h"  #include "roff.h"
 #include "man.h"  #include "man.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   #include "roff_int.h"
 #include "libman.h"  #include "libman.h"
   
 #define CHKARGS   struct roff_man *man, struct roff_node *n  #define CHKARGS   struct roff_man *man, struct roff_node *n
Line 46  static void   check_text(CHKARGS);
Line 47  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_vs(CHKARGS);  
 static  void      post_fi(CHKARGS);  
 static  void      post_ft(CHKARGS);  
 static  void      post_nf(CHKARGS);  
 static  void      post_OP(CHKARGS);  static  void      post_OP(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_vs(CHKARGS);
   
 static  v_check man_valids[MAN_MAX] = {  static  const v_check __man_valids[MAN_MAX - MAN_TH] = {
         post_vs,    /* br */  
         post_TH,    /* TH */          post_TH,    /* TH */
         NULL,       /* SH */          NULL,       /* SH */
         NULL,       /* SS */          NULL,       /* SS */
Line 77  static v_check man_valids[MAN_MAX] = {
Line 75  static v_check man_valids[MAN_MAX] = {
         NULL,       /* I */          NULL,       /* I */
         NULL,       /* IR */          NULL,       /* IR */
         NULL,       /* RI */          NULL,       /* RI */
         post_vs,    /* sp */          NULL,       /* nf */
         post_nf,    /* nf */          NULL,       /* fi */
         post_fi,    /* fi */  
         NULL,       /* RE */          NULL,       /* RE */
         check_part, /* RS */          check_part, /* RS */
         NULL,       /* DT */          NULL,       /* DT */
         post_UC,    /* UC */          post_UC,    /* UC */
         NULL,       /* PD */          NULL,       /* PD */
         post_AT,    /* AT */          post_AT,    /* AT */
         NULL,       /* in */          post_in,    /* in */
         post_ft,    /* ft */  
         post_OP,    /* OP */          post_OP,    /* OP */
         post_nf,    /* EX */          NULL,       /* EX */
         post_fi,    /* EE */          NULL,       /* EE */
         post_UR,    /* UR */          post_UR,    /* UR */
         NULL,       /* UE */          NULL,       /* UE */
         NULL,       /* ll */  
 };  };
   static  const v_check *man_valids = __man_valids - MAN_TH;
   
   
 void  void
 man_valid_post(struct roff_man *man)  man_node_validate(struct roff_man *man)
 {  {
         struct roff_node *n;          struct roff_node *n;
         v_check         *cp;          const v_check    *cp;
   
         n = man->last;          n = man->last;
         if (n->flags & MAN_VALID)          man->last = man->last->child;
                 return;          while (man->last != NULL) {
         n->flags |= MAN_VALID;                  man_node_validate(man);
                   if (man->last == n)
                           man->last = man->last->child;
                   else
                           man->last = man->last->next;
           }
   
           man->last = n;
           man->next = ROFF_NEXT_SIBLING;
         switch (n->type) {          switch (n->type) {
         case ROFFT_TEXT:          case ROFFT_TEXT:
                 check_text(man, n);                  check_text(man, n);
Line 116  man_valid_post(struct roff_man *man)
Line 119  man_valid_post(struct roff_man *man)
                 check_root(man, n);                  check_root(man, n);
                 break;                  break;
         case ROFFT_EQN:          case ROFFT_EQN:
                 /* FALLTHROUGH */  
         case ROFFT_TBL:          case ROFFT_TBL:
                 break;                  break;
         default:          default:
                   if (n->tok < ROFF_MAX) {
                           switch (n->tok) {
                           case ROFF_br:
                           case ROFF_sp:
                                   post_vs(man, n);
                                   break;
                           default:
                                   roff_validate(man);
                                   break;
                           }
                           break;
                   }
                   assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
                 cp = man_valids + n->tok;                  cp = man_valids + n->tok;
                 if (*cp)                  if (*cp)
                         (*cp)(man, n);                          (*cp)(man, n);
                   if (man->last == n)
                           man_state(man, n);
                 break;                  break;
         }          }
 }  }
Line 151  check_root(CHKARGS)
Line 168  check_root(CHKARGS)
                 man->meta.title = mandoc_strdup("");                  man->meta.title = mandoc_strdup("");
                 man->meta.msec = mandoc_strdup("");                  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, NULL, n->line, n->pos);
         }          }
   
           if (man->meta.os_e &&
               (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
                   mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0, NULL);
 }  }
   
 static void  static void
Line 173  static void
Line 194  static void
 post_OP(CHKARGS)  post_OP(CHKARGS)
 {  {
   
         if (n->nchild == 0)          if (n->child == NULL)
                 mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,                  mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
                     n->line, n->pos, "OP");                      n->line, n->pos, "OP");
         else if (n->nchild > 2) {          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_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                     n->line, n->pos, "OP ... %s", n->string);                      n->line, n->pos, "OP ... %s", n->string);
Line 194  post_UR(CHKARGS)
Line 215  post_UR(CHKARGS)
 }  }
   
 static void  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';  
         }  
 }  
   
 static void  
 check_part(CHKARGS)  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, man->parse,
                     n->line, n->pos, man_macronames[n->tok]);                      n->line, n->pos, roff_name[n->tok]);
 }  }
   
 static void  static void
Line 255  check_par(CHKARGS)
Line 229  check_par(CHKARGS)
   
         switch (n->type) {          switch (n->type) {
         case ROFFT_BLOCK:          case ROFFT_BLOCK:
                 if (0 == n->body->nchild)                  if (n->body->child == NULL)
                         man_node_delete(man, n);                          roff_node_delete(man, n);
                 break;                  break;
         case ROFFT_BODY:          case ROFFT_BODY:
                 if (0 == n->nchild)                  if (n->child == NULL)
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_vmsg(MANDOCERR_PAR_SKIP,
                             man->parse, n->line, n->pos,                              man->parse, n->line, n->pos,
                             "%s empty", man_macronames[n->tok]);                              "%s empty", roff_name[n->tok]);
                 break;                  break;
         case ROFFT_HEAD:          case ROFFT_HEAD:
                 if (n->nchild)                  if (n->child != NULL)
                         mandoc_vmsg(MANDOCERR_ARG_SKIP,                          mandoc_vmsg(MANDOCERR_ARG_SKIP,
                             man->parse, n->line, n->pos,                              man->parse, n->line, n->pos, "%s %s%s",
                             "%s %s%s", man_macronames[n->tok],                              roff_name[n->tok], n->child->string,
                             n->child->string,                              n->child->next != NULL ? " ..." : "");
                             n->nchild > 1 ? " ..." : "");  
                 break;                  break;
         default:          default:
                 break;                  break;
Line 283  post_IP(CHKARGS)
Line 256  post_IP(CHKARGS)
   
         switch (n->type) {          switch (n->type) {
         case ROFFT_BLOCK:          case ROFFT_BLOCK:
                 if (0 == n->head->nchild && 0 == n->body->nchild)                  if (n->head->child == NULL && n->body->child == NULL)
                         man_node_delete(man, n);                          roff_node_delete(man, n);
                 break;                  break;
         case ROFFT_BODY:          case ROFFT_BODY:
                 if (0 == n->parent->head->nchild && 0 == n->nchild)                  if (n->parent->head->child == NULL && n->child == NULL)
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_vmsg(MANDOCERR_PAR_SKIP,
                             man->parse, n->line, n->pos,                              man->parse, n->line, n->pos,
                             "%s empty", man_macronames[n->tok]);                              "%s empty", roff_name[n->tok]);
                 break;                  break;
         default:          default:
                 break;                  break;
Line 355  post_TH(CHKARGS)
Line 328  post_TH(CHKARGS)
         if (n && n->string && '\0' != n->string[0]) {          if (n && n->string && '\0' != n->string[0]) {
                 man->meta.date = man->quick ?                  man->meta.date = man->quick ?
                     mandoc_strdup(n->string) :                      mandoc_strdup(n->string) :
                     mandoc_normdate(man->parse, n->string,                      mandoc_normdate(man, n->string, n->line, n->pos);
                         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, man->parse,
Line 370  post_TH(CHKARGS)
Line 342  post_TH(CHKARGS)
                 man->meta.os = mandoc_strdup(n->string);                  man->meta.os = mandoc_strdup(n->string);
         else if (man->defos != NULL)          else if (man->defos != NULL)
                 man->meta.os = mandoc_strdup(man->defos);                  man->meta.os = mandoc_strdup(man->defos);
           man->meta.os_e = man->meta.os == NULL ? MDOC_OS_OTHER :
               strstr(man->meta.os, "OpenBSD") != NULL ? MDOC_OS_OPENBSD :
               strstr(man->meta.os, "NetBSD") != NULL ? MDOC_OS_NETBSD :
               MDOC_OS_OTHER;
   
         /* 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 388  post_TH(CHKARGS)
Line 364  post_TH(CHKARGS)
          * Remove the `TH' node after we've processed it for our           * Remove the `TH' node after we've processed it for our
          * meta-data.           * meta-data.
          */           */
         man_node_delete(man, man->last);          roff_node_delete(man, man->last);
 }  }
   
 static void  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)  post_UC(CHKARGS)
 {  {
         static const char * const bsd_versions[] = {          static const char * const bsd_versions[] = {
Line 490  post_AT(CHKARGS)
Line 444  post_AT(CHKARGS)
 }  }
   
 static void  static void
   post_in(CHKARGS)
   {
           char    *s;
   
           if (n->parent->tok != MAN_TP ||
               n->parent->type != ROFFT_HEAD ||
               n->child == NULL ||
               *n->child->string == '+' ||
               *n->child->string == '-')
                   return;
           mandoc_asprintf(&s, "+%s", n->child->string);
           free(n->child->string);
           n->child->string = s;
   }
   
   static void
 post_vs(CHKARGS)  post_vs(CHKARGS)
 {  {
   
Line 498  post_vs(CHKARGS)
Line 468  post_vs(CHKARGS)
   
         switch (n->parent->tok) {          switch (n->parent->tok) {
         case MAN_SH:          case MAN_SH:
                 /* FALLTHROUGH */  
         case MAN_SS:          case MAN_SS:
           case MAN_PP:
           case MAN_LP:
           case MAN_P:
                 mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,                  mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
                     "%s after %s", man_macronames[n->tok],                      "%s after %s", roff_name[n->tok],
                     man_macronames[n->parent->tok]);                      roff_name[n->parent->tok]);
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case MAN_MAX:          case TOKEN_NONE:
                 /*                  /*
                  * Don't warn about this because it occurs in pod2man                   * Don't warn about this because it occurs in pod2man
                  * and would cause considerable (unfixable) warnage.                   * and would cause considerable (unfixable) warnage.
                  */                   */
                 man_node_delete(man, n);                  roff_node_delete(man, n);
                 break;                  break;
         default:          default:
                 break;                  break;
Legend:
Removed from v.1.117  
changed lines
  Added in v.1.130
CVSweb