[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.140 and 1.151

version 1.140, 2018/12/14 01:18:25 version 1.151, 2020/03/13 15:32:28
Line 1 
Line 1 
 /*      $OpenBSD$ */  /* $Id$ */
 /*  /*
    * Copyright (c) 2010, 2012-2020 Ingo Schwarze <schwarze@openbsd.org>
  * 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-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 14 
Line 14 
  * 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.
    *
    * Validation module for man(7) syntax trees used by mandoc(1).
  */   */
 #include "config.h"  #include "config.h"
   
Line 32 
Line 34 
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   #include "tag.h"
 #include "man.h"  #include "man.h"
 #include "libmandoc.h"  #include "libmandoc.h"
 #include "roff_int.h"  #include "roff_int.h"
Line 41 
Line 44 
   
 typedef void    (*v_check)(CHKARGS);  typedef void    (*v_check)(CHKARGS);
   
 static  void      check_abort(CHKARGS);  static  void      check_abort(CHKARGS) __attribute__((__noreturn__));
 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);
   static  void      check_tag(struct roff_node *, struct roff_node *);
 static  void      check_text(CHKARGS);  static  void      check_text(CHKARGS);
   
 static  void      post_AT(CHKARGS);  static  void      post_AT(CHKARGS);
   static  void      post_EE(CHKARGS);
   static  void      post_EX(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_SH(CHKARGS);
 static  void      post_TH(CHKARGS);  static  void      post_TH(CHKARGS);
   static  void      post_TP(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);
Line 60  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 67  static const v_check man_valids[MAN_MAX - MAN_TH] = {
         post_TH,    /* TH */          post_TH,    /* TH */
         post_SH,    /* SH */          post_SH,    /* SH */
         post_SH,    /* SS */          post_SH,    /* SS */
         NULL,       /* TP */          post_TP,    /* TP */
         NULL,       /* TQ */          post_TP,    /* TQ */
         check_abort,/* LP */          check_abort,/* LP */
         check_par,  /* PP */          check_par,  /* PP */
         check_abort,/* P */          check_abort,/* P */
Line 78  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 85  static const v_check man_valids[MAN_MAX - MAN_TH] = {
         NULL,       /* I */          NULL,       /* I */
         NULL,       /* IR */          NULL,       /* IR */
         NULL,       /* RI */          NULL,       /* RI */
         NULL,       /* nf */  
         NULL,       /* fi */  
         NULL,       /* RE */          NULL,       /* RE */
         check_part, /* RS */          check_part, /* RS */
         NULL,       /* DT */          NULL,       /* DT */
Line 90  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 95  static const v_check man_valids[MAN_MAX - MAN_TH] = {
         NULL,       /* SY */          NULL,       /* SY */
         NULL,       /* YS */          NULL,       /* YS */
         post_OP,    /* OP */          post_OP,    /* OP */
         NULL,       /* EX */          post_EX,    /* EX */
         NULL,       /* EE */          post_EE,    /* EE */
         post_UR,    /* UR */          post_UR,    /* UR */
         NULL,       /* UE */          NULL,       /* UE */
         post_UR,    /* MT */          post_UR,    /* MT */
Line 101  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 106  static const v_check man_valids[MAN_MAX - MAN_TH] = {
   
 /* Validate the subtree rooted at man->last. */  /* Validate the subtree rooted at man->last. */
 void  void
 man_node_validate(struct roff_man *man)  man_validate(struct roff_man *man)
 {  {
         struct roff_node *n;          struct roff_node *n;
         const v_check    *cp;          const v_check    *cp;
Line 128  man_node_validate(struct roff_man *man)
Line 133  man_node_validate(struct roff_man *man)
   
         man->last = man->last->child;          man->last = man->last->child;
         while (man->last != NULL) {          while (man->last != NULL) {
                 man_node_validate(man);                  man_validate(man);
                 if (man->last == n)                  if (man->last == n)
                         man->last = man->last->child;                          man->last = man->last->child;
                 else                  else
Line 160  man_node_validate(struct roff_man *man)
Line 165  man_node_validate(struct roff_man *man)
                 if (*cp)                  if (*cp)
                         (*cp)(man, n);                          (*cp)(man, n);
                 if (man->last == n)                  if (man->last == n)
                         man_state(man, n);                          n->flags |= NODE_VALID;
                 break;                  break;
         }          }
 }  }
Line 171  check_root(CHKARGS)
Line 176  check_root(CHKARGS)
         assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);          assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
   
         if (n->last == NULL || n->last->type == ROFFT_COMMENT)          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 187  check_root(CHKARGS)
Line 190  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 = mandoc_normdate(NULL, NULL);
                     mandoc_normdate(man, NULL, n->line, n->pos);  
         }          }
   
         if (man->meta.os_e &&          if (man->meta.os_e &&
             (man->meta.rcsids & (1 << man->meta.os_e)) == 0)              (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
                 mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0,                  mandoc_msg(MANDOCERR_RCS_MISSING, 0, 0,
                     man->meta.os_e == MANDOC_OS_OPENBSD ?                      man->meta.os_e == MANDOC_OS_OPENBSD ?
                     "(OpenBSD)" : "(NetBSD)");                      "(OpenBSD)" : "(NetBSD)");
 }  }
Line 204  check_abort(CHKARGS)
Line 206  check_abort(CHKARGS)
         abort();          abort();
 }  }
   
   /*
    * Skip leading whitespace, dashes, backslashes, and font escapes,
    * then create a tag if the first following byte is a letter.
    * Priority is high unless whitespace is present.
    */
 static void  static void
   check_tag(struct roff_node *n, struct roff_node *nt)
   {
           const char      *cp, *arg;
           int              prio, sz;
   
           if (nt == NULL || nt->type != ROFFT_TEXT)
                   return;
   
           cp = nt->string;
           prio = TAG_STRONG;
           for (;;) {
                   switch (*cp) {
                   case ' ':
                   case '\t':
                           prio = TAG_WEAK;
                           /* FALLTHROUGH */
                   case '-':
                           cp++;
                           break;
                   case '\\':
                           cp++;
                           switch (mandoc_escape(&cp, &arg, &sz)) {
                           case ESCAPE_FONT:
                           case ESCAPE_FONTBOLD:
                           case ESCAPE_FONTITALIC:
                           case ESCAPE_FONTBI:
                           case ESCAPE_FONTROMAN:
                           case ESCAPE_FONTCW:
                           case ESCAPE_FONTPREV:
                           case ESCAPE_IGNORE:
                                   break;
                           case ESCAPE_SPECIAL:
                                   if (sz != 1)
                                           return;
                                   switch (*arg) {
                                   case '-':
                                   case 'e':
                                           break;
                                   default:
                                           return;
                                   }
                                   break;
                           default:
                                   return;
                           }
                           break;
                   default:
                           if (isalpha((unsigned char)*cp))
                                   tag_put(cp, prio, n);
                           return;
                   }
           }
   }
   
   static void
 check_text(CHKARGS)  check_text(CHKARGS)
 {  {
         char            *cp, *p;          char            *cp, *p;
   
         if (MAN_LITERAL & man->flags)          if (n->flags & NODE_NOFILL)
                 return;                  return;
   
         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
   post_EE(CHKARGS)
   {
           if ((n->flags & NODE_NOFILL) == 0)
                   mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "EE");
   }
   
   static void
   post_EX(CHKARGS)
   {
           if (n->flags & NODE_NOFILL)
                   mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "EX");
   }
   
   static void
 post_OP(CHKARGS)  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);
         }          }
 }  }
Line 249  post_SH(CHKARGS)
Line 324  post_SH(CHKARGS)
         }          }
   
         if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {          if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
                 mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,                  mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
                     nc->line, nc->pos, "%s after %s",                      "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
                     roff_name[nc->tok], roff_name[n->tok]);  
                 roff_node_delete(man, nc);                  roff_node_delete(man, nc);
         }          }
   
Line 261  post_SH(CHKARGS)
Line 335  post_SH(CHKARGS)
          */           */
   
         if ((nc = n->last) != NULL && nc->tok == ROFF_br) {          if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
                 mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,                  mandoc_msg(MANDOCERR_PAR_SKIP,
                     nc->line, nc->pos, "%s at the end of %s",                      nc->line, nc->pos, "%s at the end of %s",
                     roff_name[nc->tok], roff_name[n->tok]);                      roff_name[nc->tok], roff_name[n->tok]);
                 roff_node_delete(man, nc);                  roff_node_delete(man, nc);
Line 272  static void
Line 346  static void
 post_UR(CHKARGS)  post_UR(CHKARGS)
 {  {
         if (n->type == ROFFT_HEAD && n->child == NULL)          if (n->type == ROFFT_HEAD && n->child == NULL)
                 mandoc_msg(MANDOCERR_UR_NOHEAD, man->parse,                  mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
                     n->line, n->pos, roff_name[n->tok]);                      "%s", roff_name[n->tok]);
         check_part(man, n);          check_part(man, n);
 }  }
   
Line 282  check_part(CHKARGS)
Line 356  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 298  check_par(CHKARGS)
Line 372  check_par(CHKARGS)
         case ROFFT_BODY:          case ROFFT_BODY:
                 if (n->child != NULL &&                  if (n->child != NULL &&
                     (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {                      (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_msg(MANDOCERR_PAR_SKIP,
                             man->parse, n->child->line, n->child->pos,                              n->child->line, n->child->pos,
                             "%s after %s", roff_name[n->child->tok],                              "%s after %s", roff_name[n->child->tok],
                             roff_name[n->tok]);                              roff_name[n->tok]);
                         roff_node_delete(man, n->child);                          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 324  check_par(CHKARGS)
Line 397  check_par(CHKARGS)
 static void  static void
 post_IP(CHKARGS)  post_IP(CHKARGS)
 {  {
   
         switch (n->type) {          switch (n->type) {
         case ROFFT_BLOCK:          case ROFFT_BLOCK:
                 if (n->head->child == NULL && n->body->child == NULL)                  if (n->head->child == NULL && n->body->child == NULL)
                         roff_node_delete(man, n);                          roff_node_delete(man, n);
                 break;                  break;
           case ROFFT_HEAD:
                   check_tag(n, n->child);
                   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 341  post_IP(CHKARGS)
Line 415  post_IP(CHKARGS)
         }          }
 }  }
   
   /*
    * The first next-line element in the head is the tag.
    * If that's a font macro, use its first child instead.
    */
 static void  static void
   post_TP(CHKARGS)
   {
           struct roff_node *nt;
   
           if (n->type != ROFFT_HEAD || (nt = n->child) == NULL)
                   return;
   
           while ((nt->flags & NODE_LINE) == 0)
                   if ((nt = nt->next) == NULL)
                           return;
   
           switch (nt->tok) {
           case MAN_B:
           case MAN_BI:
           case MAN_BR:
           case MAN_I:
           case MAN_IB:
           case MAN_IR:
                   nt = nt->child;
                   break;
           default:
                   break;
           }
           check_tag(n, nt);
   }
   
   static void
 post_TH(CHKARGS)  post_TH(CHKARGS)
 {  {
         struct roff_node *nb;          struct roff_node *nb;
Line 361  post_TH(CHKARGS)
Line 466  post_TH(CHKARGS)
         /* ->TITLE<- MSEC DATE OS VOL */          /* ->TITLE<- MSEC DATE OS VOL */
   
         n = n->child;          n = n->child;
         if (n && n->string) {          if (n != NULL && n->string != NULL) {
                 for (p = n->string; '\0' != *p; p++) {                  for (p = n->string; *p != '\0'; p++) {
                         /* 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 376  post_TH(CHKARGS)
Line 480  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 */
   
         if (n)          if (n != NULL)
                 n = n->next;                  n = n->next;
         if (n && n->string)          if (n != NULL && n->string != NULL)
                 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);
         }          }
   
         /* TITLE MSEC ->DATE<- OS VOL */          /* TITLE MSEC ->DATE<- OS VOL */
   
         if (n)          if (n != NULL)
                 n = n->next;                  n = n->next;
         if (n && n->string && '\0' != n->string[0]) {          if (man->quick && n != NULL)
                 man->meta.date = man->quick ?  
                     mandoc_strdup(n->string) :  
                     mandoc_normdate(man, n->string, n->line, n->pos);  
         } else {  
                 man->meta.date = mandoc_strdup("");                  man->meta.date = mandoc_strdup("");
                 mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,          else
                     n ? n->line : nb->line,                  man->meta.date = mandoc_normdate(n, nb);
                     n ? n->pos : nb->pos, "TH");  
         }  
   
         /* TITLE MSEC DATE ->OS<- VOL */          /* TITLE MSEC DATE ->OS<- VOL */
   
Line 430  post_TH(CHKARGS)
Line 527  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);
   
         /*          /*
Legend:
Removed from v.1.140  
changed lines
  Added in v.1.151
CVSweb