[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.149 and 1.159

version 1.149, 2019/06/27 15:07:30 version 1.159, 2023/10/24 20:53:12
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
    * Copyright (c) 2010, 2012-2020, 2023 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 31 
Line 33 
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
   #include "mandoc_xr.h"
 #include "roff.h"  #include "roff.h"
 #include "man.h"  #include "man.h"
 #include "libmandoc.h"  #include "libmandoc.h"
 #include "roff_int.h"  #include "roff_int.h"
 #include "libman.h"  #include "libman.h"
   #include "tag.h"
   
 #define CHKARGS   struct roff_man *man, struct roff_node *n  #define CHKARGS   struct roff_man *man, struct roff_node *n
   
 typedef void    (*v_check)(CHKARGS);  typedef void    (*v_check)(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_EE(CHKARGS);
 static  void      post_EX(CHKARGS);  static  void      post_EX(CHKARGS);
 static  void      post_IP(CHKARGS);  static  void      post_IP(CHKARGS);
   static  void      post_MR(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 62  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 68  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_par,  /* LP */
         check_par,  /* PP */          check_par,  /* PP */
         check_abort,/* P */          check_par,  /* P */
         post_IP,    /* IP */          post_IP,    /* IP */
         NULL,       /* HP */          NULL,       /* HP */
         NULL,       /* SM */          NULL,       /* SM */
Line 96  static const v_check man_valids[MAN_MAX - MAN_TH] = {
Line 102  static const v_check man_valids[MAN_MAX - MAN_TH] = {
         NULL,       /* UE */          NULL,       /* UE */
         post_UR,    /* MT */          post_UR,    /* MT */
         NULL,       /* ME */          NULL,       /* ME */
           post_MR,    /* MR */
 };  };
   
   
Line 107  man_validate(struct roff_man *man)
Line 114  man_validate(struct roff_man *man)
         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;  
         switch (n->tok) {  
         case MAN_LP:  
         case MAN_P:  
                 n->tok = MAN_PP;  
                 break;  
         default:  
                 break;  
         }  
   
         /*  
          * Iterate over all children, recursing into each one           * Iterate over all children, recursing into each one
          * in turn, depth-first.           * in turn, depth-first.
          */           */
   
           n = man->last;
         man->last = man->last->child;          man->last = man->last->child;
         while (man->last != NULL) {          while (man->last != NULL) {
                 man_validate(man);                  man_validate(man);
Line 185  check_root(CHKARGS)
Line 178  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 = mandoc_normdate(man, NULL, n->line, n->pos);                  man->meta.date = mandoc_normdate(NULL, NULL);
         }          }
   
         if (man->meta.os_e &&          if (man->meta.os_e &&
Line 195  check_root(CHKARGS)
Line 188  check_root(CHKARGS)
                     "(OpenBSD)" : "(NetBSD)");                      "(OpenBSD)" : "(NetBSD)");
 }  }
   
   /*
    * 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_abort(CHKARGS)  check_tag(struct roff_node *n, struct roff_node *nt)
 {  {
         abort();          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_FONTCR:
                           case ESCAPE_FONTCB:
                           case ESCAPE_FONTCI:
                           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  static void
Line 246  static void
Line 295  static void
 post_SH(CHKARGS)  post_SH(CHKARGS)
 {  {
         struct roff_node        *nc;          struct roff_node        *nc;
           char                    *cp, *tag;
   
         if (n->type != ROFFT_BODY || (nc = n->child) == NULL)          nc = n->child;
           switch (n->type) {
           case ROFFT_HEAD:
                   tag = NULL;
                   deroff(&tag, n);
                   if (tag != NULL) {
                           for (cp = tag; *cp != '\0'; cp++)
                                   if (*cp == ' ')
                                           *cp = '_';
                           if (nc != NULL && nc->type == ROFFT_TEXT &&
                               strcmp(nc->string, tag) == 0)
                                   tag_put(NULL, TAG_STRONG, n);
                           else
                                   tag_put(tag, TAG_FALLBACK, n);
                           free(tag);
                   }
                 return;                  return;
           case ROFFT_BODY:
                   if (nc != NULL)
                           break;
                   return;
           default:
                   return;
           }
   
         if (nc->tok == MAN_PP && nc->body->child != NULL) {          if ((nc->tok == MAN_LP || nc->tok == MAN_PP || nc->tok == MAN_P) &&
               nc->body->child != NULL) {
                 while (nc->body->last != NULL) {                  while (nc->body->last != NULL) {
                         man->next = ROFF_NEXT_CHILD;                          man->next = ROFF_NEXT_CHILD;
                         roff_node_relink(man, nc->body->last);                          roff_node_relink(man, nc->body->last);
Line 258  post_SH(CHKARGS)
Line 331  post_SH(CHKARGS)
                 }                  }
         }          }
   
         if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {          if (nc->tok == MAN_LP || nc->tok == MAN_PP || nc->tok == MAN_P ||
               nc->tok == ROFF_sp || nc->tok == ROFF_br) {
                 mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,                  mandoc_msg(MANDOCERR_PAR_SKIP, nc->line, nc->pos,
                     "%s after %s", roff_name[nc->tok], roff_name[n->tok]);                      "%s after %s", roff_name[nc->tok], roff_name[n->tok]);
                 roff_node_delete(man, nc);                  roff_node_delete(man, nc);
Line 283  post_UR(CHKARGS)
Line 357  post_UR(CHKARGS)
         if (n->type == ROFFT_HEAD && n->child == NULL)          if (n->type == ROFFT_HEAD && n->child == NULL)
                 mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,                  mandoc_msg(MANDOCERR_UR_NOHEAD, n->line, n->pos,
                     "%s", roff_name[n->tok]);                      "%s", roff_name[n->tok]);
         check_part(man, n);  
 }  }
   
 static void  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, n->line, n->pos,                  mandoc_msg(MANDOCERR_BLK_EMPTY, n->line, n->pos,
                     "%s", roff_name[n->tok]);                      "%s", roff_name[n->tok]);
Line 332  check_par(CHKARGS)
Line 404  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_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,                          mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
Line 348  post_IP(CHKARGS)
Line 422  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 389  post_TH(CHKARGS)
Line 494  post_TH(CHKARGS)
   
         if (n != NULL)          if (n != NULL)
                 n = n->next;                  n = n->next;
         if (n != NULL && n->string != NULL)          if (n != NULL && n->string != NULL) {
                 man->meta.msec = mandoc_strdup(n->string);                  man->meta.msec = mandoc_strdup(n->string);
         else {                  if (man->filesec != '\0' &&
                       man->filesec != *n->string &&
                       *n->string >= '1' && *n->string <= '9')
                           mandoc_msg(MANDOCERR_MSEC_FILE, n->line, n->pos,
                               "*.%c vs TH ... %c", man->filesec, *n->string);
           } else {
                 man->meta.msec = mandoc_strdup("");                  man->meta.msec = mandoc_strdup("");
                 mandoc_msg(MANDOCERR_MSEC_MISSING,                  mandoc_msg(MANDOCERR_MSEC_MISSING,
                     nb->line, nb->pos, "TH %s", man->meta.title);                      nb->line, nb->pos, "TH %s", man->meta.title);
Line 401  post_TH(CHKARGS)
Line 511  post_TH(CHKARGS)
   
         if (n != NULL)          if (n != NULL)
                 n = n->next;                  n = n->next;
         if (n != NULL && n->string != NULL && n->string[0] != '\0')          if (man->quick && n != NULL)
                 man->meta.date = 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,          else
                     n == NULL ? nb->line : n->line,                  man->meta.date = mandoc_normdate(n, nb);
                     n == NULL ? nb->pos : n->pos, "TH");  
         }  
   
         /* TITLE MSEC DATE ->OS<- VOL */          /* TITLE MSEC DATE ->OS<- VOL */
   
Line 442  post_TH(CHKARGS)
Line 547  post_TH(CHKARGS)
          * meta-data.           * meta-data.
          */           */
         roff_node_delete(man, man->last);          roff_node_delete(man, man->last);
   }
   
   static void
   post_MR(CHKARGS)
   {
           struct roff_node *nch;
   
           if ((nch = n->child) == NULL) {
                   mandoc_msg(MANDOCERR_NM_NONAME, n->line, n->pos, "MR");
                   return;
           }
           if (nch->next == NULL) {
                   mandoc_msg(MANDOCERR_XR_NOSEC,
                       n->line, n->pos, "MR %s", nch->string);
                   return;
           }
           if (mandoc_xr_add(nch->next->string, nch->string, nch->line, nch->pos))
                   mandoc_msg(MANDOCERR_XR_SELF, nch->line, nch->pos,
                       "MR %s %s", nch->string, nch->next->string);
           if ((nch = nch->next->next) == NULL || nch->next == NULL)
                   return;
   
           mandoc_msg(MANDOCERR_ARG_EXCESS, nch->next->line, nch->next->pos,
               "MR ... %s", nch->next->string);
           while (nch->next != NULL)
                   roff_node_delete(man, nch->next);
 }  }
   
 static void  static void
Legend:
Removed from v.1.149  
changed lines
  Added in v.1.159
CVSweb