[BACK]Return to mdoc_validate.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_validate.c between version 1.349 and 1.363

version 1.349, 2017/07/15 16:40:29 version 1.363, 2018/12/03 21:00:11
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>   * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
Line 53  enum check_ineq {
Line 53  enum check_ineq {
 typedef void    (*v_post)(POST_ARGS);  typedef void    (*v_post)(POST_ARGS);
   
 static  int      build_list(struct roff_man *, int);  static  int      build_list(struct roff_man *, int);
 static  void     check_text(struct roff_man *, int, int, char *);  
 static  void     check_argv(struct roff_man *,  static  void     check_argv(struct roff_man *,
                         struct roff_node *, struct mdoc_argv *);                          struct roff_node *, struct mdoc_argv *);
 static  void     check_args(struct roff_man *, struct roff_node *);  static  void     check_args(struct roff_man *, struct roff_node *);
   static  void     check_text(struct roff_man *, int, int, char *);
   static  void     check_text_em(struct roff_man *, int, int, char *);
 static  void     check_toptext(struct roff_man *, int, int, const char *);  static  void     check_toptext(struct roff_man *, int, int, const char *);
 static  int      child_an(const struct roff_node *);  static  int      child_an(const struct roff_node *);
 static  size_t          macro2len(enum roff_tok);  static  size_t          macro2len(enum roff_tok);
 static  void     rewrite_macro2len(struct roff_man *, char **);  static  void     rewrite_macro2len(struct roff_man *, char **);
 static  int      similar(const char *, const char *);  static  int      similar(const char *, const char *);
   
   static  void     post_abort(POST_ARGS);
 static  void     post_an(POST_ARGS);  static  void     post_an(POST_ARGS);
 static  void     post_an_norm(POST_ARGS);  static  void     post_an_norm(POST_ARGS);
 static  void     post_at(POST_ARGS);  static  void     post_at(POST_ARGS);
Line 115  static void  post_useless(POST_ARGS);
Line 117  static void  post_useless(POST_ARGS);
 static  void     post_xr(POST_ARGS);  static  void     post_xr(POST_ARGS);
 static  void     post_xx(POST_ARGS);  static  void     post_xx(POST_ARGS);
   
 static  const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] = {  static  const v_post mdoc_valids[MDOC_MAX - MDOC_Dd] = {
         post_dd,        /* Dd */          post_dd,        /* Dd */
         post_dt,        /* Dt */          post_dt,        /* Dt */
         post_os,        /* Os */          post_os,        /* Os */
Line 150  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 152  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         post_nd,        /* Nd */          post_nd,        /* Nd */
         post_nm,        /* Nm */          post_nm,        /* Nm */
         post_delim_nb,  /* Op */          post_delim_nb,  /* Op */
         post_obsolete,  /* Ot */          post_abort,     /* Ot */
         post_defaults,  /* Pa */          post_defaults,  /* Pa */
         post_rv,        /* Rv */          post_rv,        /* Rv */
         post_st,        /* St */          post_st,        /* St */
Line 169  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 171  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         post_hyph,      /* %T */ /* FIXME: can be used outside Rs/Re. */          post_hyph,      /* %T */ /* FIXME: can be used outside Rs/Re. */
         NULL,           /* %V */          NULL,           /* %V */
         NULL,           /* Ac */          NULL,           /* Ac */
         post_delim_nb,  /* Ao */          NULL,           /* Ao */
         post_delim_nb,  /* Aq */          post_delim_nb,  /* Aq */
         post_at,        /* At */          post_at,        /* At */
         NULL,           /* Bc */          NULL,           /* Bc */
         post_bf,        /* Bf */          post_bf,        /* Bf */
         post_delim_nb,  /* Bo */          NULL,           /* Bo */
         NULL,           /* Bq */          NULL,           /* Bq */
         post_xx,        /* Bsx */          post_xx,        /* Bsx */
         post_bx,        /* Bx */          post_bx,        /* Bx */
Line 194  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 196  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         post_xx,        /* Ox */          post_xx,        /* Ox */
         NULL,           /* Pc */          NULL,           /* Pc */
         NULL,           /* Pf */          NULL,           /* Pf */
         post_delim_nb,  /* Po */          NULL,           /* Po */
         post_delim_nb,  /* Pq */          post_delim_nb,  /* Pq */
         NULL,           /* Qc */          NULL,           /* Qc */
         post_delim_nb,  /* Ql */          post_delim_nb,  /* Ql */
         post_delim_nb,  /* Qo */          NULL,           /* Qo */
         post_delim_nb,  /* Qq */          post_delim_nb,  /* Qq */
         NULL,           /* Re */          NULL,           /* Re */
         post_rs,        /* Rs */          post_rs,        /* Rs */
         NULL,           /* Sc */          NULL,           /* Sc */
         post_delim_nb,  /* So */          NULL,           /* So */
         post_delim_nb,  /* Sq */          post_delim_nb,  /* Sq */
         post_sm,        /* Sm */          post_sm,        /* Sm */
         post_sx,        /* Sx */          post_sx,        /* Sx */
Line 214  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 216  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         NULL,           /* Xo */          NULL,           /* Xo */
         post_fo,        /* Fo */          post_fo,        /* Fo */
         NULL,           /* Fc */          NULL,           /* Fc */
         post_delim_nb,  /* Oo */          NULL,           /* Oo */
         NULL,           /* Oc */          NULL,           /* Oc */
         post_bk,        /* Bk */          post_bk,        /* Bk */
         NULL,           /* Ek */          NULL,           /* Ek */
Line 223  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 225  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         post_obsolete,  /* Fr */          post_obsolete,  /* Fr */
         post_eoln,      /* Ud */          post_eoln,      /* Ud */
         post_lb,        /* Lb */          post_lb,        /* Lb */
         post_par,       /* Lp */          post_abort,     /* Lp */
         post_delim_nb,  /* Lk */          post_delim_nb,  /* Lk */
         post_defaults,  /* Mt */          post_defaults,  /* Mt */
         post_delim_nb,  /* Brq */          post_delim_nb,  /* Brq */
         post_delim_nb,  /* Bro */          NULL,           /* Bro */
         NULL,           /* Brc */          NULL,           /* Brc */
         NULL,           /* %C */          NULL,           /* %C */
         post_es,        /* Es */          post_es,        /* Es */
Line 237  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 239  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         NULL,           /* %U */          NULL,           /* %U */
         NULL,           /* Ta */          NULL,           /* Ta */
 };  };
 static  const v_post *const mdoc_valids = __mdoc_valids - MDOC_Dd;  
   
 #define RSORD_MAX 14 /* Number of `Rs' blocks. */  #define RSORD_MAX 14 /* Number of `Rs' blocks. */
   
Line 285  static const char * const secnames[SEC__MAX] = {
Line 286  static const char * const secnames[SEC__MAX] = {
 };  };
   
   
   /* Validate the subtree rooted at mdoc->last. */
 void  void
 mdoc_node_validate(struct roff_man *mdoc)  mdoc_node_validate(struct roff_man *mdoc)
 {  {
         struct roff_node *n;          struct roff_node *n, *np;
         const v_post *p;          const v_post *p;
   
           /*
            * Translate obsolete macros to modern macros first
            * such that later code does not need to look
            * for the obsolete versions.
            */
   
         n = mdoc->last;          n = mdoc->last;
           switch (n->tok) {
           case MDOC_Lp:
                   n->tok = MDOC_Pp;
                   break;
           case MDOC_Ot:
                   post_obsolete(mdoc);
                   n->tok = MDOC_Ft;
                   break;
           default:
                   break;
           }
   
           /*
            * Iterate over all children, recursing into each one
            * in turn, depth-first.
            */
   
         mdoc->last = mdoc->last->child;          mdoc->last = mdoc->last->child;
         while (mdoc->last != NULL) {          while (mdoc->last != NULL) {
                 mdoc_node_validate(mdoc);                  mdoc_node_validate(mdoc);
Line 301  mdoc_node_validate(struct roff_man *mdoc)
Line 326  mdoc_node_validate(struct roff_man *mdoc)
                         mdoc->last = mdoc->last->next;                          mdoc->last = mdoc->last->next;
         }          }
   
           /* Finally validate the macro itself. */
   
         mdoc->last = n;          mdoc->last = n;
         mdoc->next = ROFF_NEXT_SIBLING;          mdoc->next = ROFF_NEXT_SIBLING;
         switch (n->type) {          switch (n->type) {
         case ROFFT_TEXT:          case ROFFT_TEXT:
                   np = n->parent;
                 if (n->sec != SEC_SYNOPSIS ||                  if (n->sec != SEC_SYNOPSIS ||
                     (n->parent->tok != MDOC_Cd && n->parent->tok != MDOC_Fd))                      (np->tok != MDOC_Cd && np->tok != MDOC_Fd))
                         check_text(mdoc, n->line, n->pos, n->string);                          check_text(mdoc, n->line, n->pos, n->string);
                 if (n->parent->tok == MDOC_It ||                  if (np->tok != MDOC_Ql && np->tok != MDOC_Dl &&
                     (n->parent->type == ROFFT_BODY &&                      (np->tok != MDOC_Bd ||
                      (n->parent->tok == MDOC_Sh ||                       (mdoc->flags & MDOC_LITERAL) == 0) &&
                       n->parent->tok == MDOC_Ss)))                      (np->tok != MDOC_It || np->type != ROFFT_HEAD ||
                        np->parent->parent->norm->Bl.type != LIST_diag))
                           check_text_em(mdoc, n->line, n->pos, n->string);
                   if (np->tok == MDOC_It || (np->type == ROFFT_BODY &&
                       (np->tok == MDOC_Sh || np->tok == MDOC_Ss)))
                         check_toptext(mdoc, n->line, n->pos, n->string);                          check_toptext(mdoc, n->line, n->pos, n->string);
                 break;                  break;
           case ROFFT_COMMENT:
         case ROFFT_EQN:          case ROFFT_EQN:
         case ROFFT_TBL:          case ROFFT_TBL:
                 break;                  break;
Line 350  mdoc_node_validate(struct roff_man *mdoc)
Line 383  mdoc_node_validate(struct roff_man *mdoc)
                 }                  }
   
                 assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);                  assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
                 p = mdoc_valids + n->tok;                  p = mdoc_valids + (n->tok - MDOC_Dd);
                 if (*p)                  if (*p)
                         (*p)(mdoc);                          (*p)(mdoc);
                 if (mdoc->last == n)                  if (mdoc->last == n)
Line 395  check_text(struct roff_man *mdoc, int ln, int pos, cha
Line 428  check_text(struct roff_man *mdoc, int ln, int pos, cha
 }  }
   
 static void  static void
   check_text_em(struct roff_man *mdoc, int ln, int pos, char *p)
   {
           const struct roff_node  *np, *nn;
           char                    *cp;
   
           np = mdoc->last->prev;
           nn = mdoc->last->next;
   
           /* Look for em-dashes wrongly encoded as "--". */
   
           for (cp = p; *cp != '\0'; cp++) {
                   if (cp[0] != '-' || cp[1] != '-')
                           continue;
                   cp++;
   
                   /* Skip input sequences of more than two '-'. */
   
                   if (cp[1] == '-') {
                           while (cp[1] == '-')
                                   cp++;
                           continue;
                   }
   
                   /* Skip "--" directly attached to something else. */
   
                   if ((cp - p > 1 && cp[-2] != ' ') ||
                       (cp[1] != '\0' && cp[1] != ' '))
                           continue;
   
                   /* Require a letter right before or right afterwards. */
   
                   if ((cp - p > 2 ?
                        isalpha((unsigned char)cp[-3]) :
                        np != NULL &&
                        np->type == ROFFT_TEXT &&
                        *np->string != '\0' &&
                        isalpha((unsigned char)np->string[
                          strlen(np->string) - 1])) ||
                       (cp[1] != '\0' && cp[2] != '\0' ?
                        isalpha((unsigned char)cp[2]) :
                        nn != NULL &&
                        nn->type == ROFFT_TEXT &&
                        isalpha((unsigned char)*nn->string))) {
                           mandoc_msg(MANDOCERR_DASHDASH, mdoc->parse,
                               ln, pos + (int)(cp - p) - 1, NULL);
                           break;
                   }
           }
   }
   
   static void
 check_toptext(struct roff_man *mdoc, int ln, int pos, const char *p)  check_toptext(struct roff_man *mdoc, int ln, int pos, const char *p)
 {  {
         const char      *cp, *cpr;          const char      *cp, *cpr;
Line 430  check_toptext(struct roff_man *mdoc, int ln, int pos, 
Line 514  check_toptext(struct roff_man *mdoc, int ln, int pos, 
 }  }
   
 static void  static void
   post_abort(POST_ARGS)
   {
           abort();
   }
   
   static void
 post_delim(POST_ARGS)  post_delim(POST_ARGS)
 {  {
         const struct roff_node  *nch;          const struct roff_node  *nch;
Line 530  post_delim_nb(POST_ARGS)
Line 620  post_delim_nb(POST_ARGS)
   
         /* At least three alphabetic words with a sentence ending. */          /* At least three alphabetic words with a sentence ending. */
         if (strchr("!.:?", *lc) != NULL && (tok == MDOC_Em ||          if (strchr("!.:?", *lc) != NULL && (tok == MDOC_Em ||
             tok == MDOC_Li || tok == MDOC_Po || tok == MDOC_Pq ||              tok == MDOC_Li || tok == MDOC_Pq || tok == MDOC_Sy)) {
             tok == MDOC_Sy)) {  
                 nw = 0;                  nw = 0;
                 for (cp = lc - 1; cp >= nch->string; cp--) {                  for (cp = lc - 1; cp >= nch->string; cp--) {
                         if (*cp == ' ') {                          if (*cp == ' ') {
Line 947  post_lb(POST_ARGS)
Line 1036  post_lb(POST_ARGS)
   
         roff_word_alloc(mdoc, n->line, n->pos, "library");          roff_word_alloc(mdoc, n->line, n->pos, "library");
         mdoc->last->flags = NODE_NOSRC;          mdoc->last->flags = NODE_NOSRC;
         roff_word_alloc(mdoc, n->line, n->pos, "\\(Lq");          roff_word_alloc(mdoc, n->line, n->pos, "\\(lq");
         mdoc->last->flags = NODE_DELIMO | NODE_NOSRC;          mdoc->last->flags = NODE_DELIMO | NODE_NOSRC;
         mdoc->last = mdoc->last->next;          mdoc->last = mdoc->last->next;
         roff_word_alloc(mdoc, n->line, n->pos, "\\(Rq");          roff_word_alloc(mdoc, n->line, n->pos, "\\(rq");
         mdoc->last->flags = NODE_DELIMC | NODE_NOSRC;          mdoc->last->flags = NODE_DELIMC | NODE_NOSRC;
         mdoc->last = n;          mdoc->last = n;
 }  }
Line 1137  post_fname(POST_ARGS)
Line 1226  post_fname(POST_ARGS)
         if ( ! (cp[0] == '\0' || (cp[0] == '(' && cp[1] == '*')))          if ( ! (cp[0] == '\0' || (cp[0] == '(' && cp[1] == '*')))
                 mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse,                  mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse,
                     n->line, n->pos + pos, n->string);                      n->line, n->pos + pos, n->string);
         if (n->sec == SEC_SYNOPSIS && mdoc->meta.msec != NULL)  
                 mandoc_xr_add(mdoc->meta.msec, n->string, -1, -1);  
 }  }
   
 static void  static void
Line 1205  post_nm(POST_ARGS)
Line 1292  post_nm(POST_ARGS)
   
         n = mdoc->last;          n = mdoc->last;
   
         if ((n->sec == SEC_NAME || n->sec == SEC_SYNOPSIS) &&          if (n->sec == SEC_NAME && n->child != NULL &&
             n->child != NULL && n->child->type == ROFFT_TEXT &&              n->child->type == ROFFT_TEXT && mdoc->meta.msec != NULL)
             mdoc->meta.msec != NULL)  
                 mandoc_xr_add(mdoc->meta.msec, n->child->string, -1, -1);                  mandoc_xr_add(mdoc->meta.msec, n->child->string, -1, -1);
   
         if (n->last != NULL &&          if (n->last != NULL && n->last->tok == MDOC_Pp)
             (n->last->tok == MDOC_Pp ||  
              n->last->tok == MDOC_Lp))  
                 mdoc_node_relink(mdoc, n->last);                  mdoc_node_relink(mdoc, n->last);
   
         if (mdoc->meta.name == NULL)          if (mdoc->meta.name == NULL)
Line 1423  post_xx(POST_ARGS)
Line 1507  post_xx(POST_ARGS)
 {  {
         struct roff_node        *n;          struct roff_node        *n;
         const char              *os;          const char              *os;
           char                    *v;
   
         post_delim_nb(mdoc);          post_delim_nb(mdoc);
   
Line 1439  post_xx(POST_ARGS)
Line 1524  post_xx(POST_ARGS)
                 break;                  break;
         case MDOC_Nx:          case MDOC_Nx:
                 os = "NetBSD";                  os = "NetBSD";
                   if (n->child == NULL)
                           break;
                   v = n->child->string;
                   if ((v[0] != '0' && v[0] != '1') || v[1] != '.' ||
                       v[2] < '0' || v[2] > '9' ||
                       v[3] < 'a' || v[3] > 'z' || v[4] != '\0')
                           break;
                   n->child->flags |= NODE_NOPRT;
                   mdoc->next = ROFF_NEXT_CHILD;
                   roff_word_alloc(mdoc, n->child->line, n->child->pos, v);
                   v = mdoc->last->string;
                   v[3] = toupper((unsigned char)v[3]);
                   mdoc->last->flags |= NODE_NOSRC;
                   mdoc->last = n;
                 break;                  break;
         case MDOC_Ox:          case MDOC_Ox:
                 os = "OpenBSD";                  os = "OpenBSD";
Line 1550  post_bl_block(POST_ARGS)
Line 1649  post_bl_block(POST_ARGS)
                 while (nc != NULL) {                  while (nc != NULL) {
                         switch (nc->tok) {                          switch (nc->tok) {
                         case MDOC_Pp:                          case MDOC_Pp:
                         case MDOC_Lp:  
                         case ROFF_br:                          case ROFF_br:
                                 break;                                  break;
                         default:                          default:
Line 1902  post_root(POST_ARGS)
Line 2000  post_root(POST_ARGS)
                         arch++;                          arch++;
                 if (*arch == NULL) {                  if (*arch == NULL) {
                         n = mdoc->first->child;                          n = mdoc->first->child;
                         while (n->tok != MDOC_Dt)                          while (n->tok != MDOC_Dt ||
                               n->child == NULL ||
                               n->child->next == NULL ||
                               n->child->next->next == NULL)
                                 n = n->next;                                  n = n->next;
                         n = n->child->next->next;                          n = n->child->next->next;
                         mandoc_vmsg(MANDOCERR_ARCH_BAD,                          mandoc_vmsg(MANDOCERR_ARCH_BAD,
Line 1916  post_root(POST_ARGS)
Line 2017  post_root(POST_ARGS)
         /* Check that we begin with a proper `Sh'. */          /* Check that we begin with a proper `Sh'. */
   
         n = mdoc->first->child;          n = mdoc->first->child;
         while (n != NULL && n->tok != TOKEN_NONE &&          while (n != NULL &&
             mdoc_macros[n->tok].flags & MDOC_PROLOGUE)              (n->type == ROFFT_COMMENT ||
                (n->tok >= MDOC_Dd &&
                 mdoc_macro(n->tok)->flags & MDOC_PROLOGUE)))
                 n = n->next;                  n = n->next;
   
         if (n == NULL)          if (n == NULL)
Line 2419  post_ignpar(POST_ARGS)
Line 2522  post_ignpar(POST_ARGS)
         }          }
   
         if ((np = mdoc->last->child) != NULL)          if ((np = mdoc->last->child) != NULL)
                 if (np->tok == MDOC_Pp || np->tok == MDOC_Lp) {                  if (np->tok == MDOC_Pp) {
                         mandoc_vmsg(MANDOCERR_PAR_SKIP,                          mandoc_vmsg(MANDOCERR_PAR_SKIP,
                             mdoc->parse, np->line, np->pos,                              mdoc->parse, np->line, np->pos,
                             "%s after %s", roff_name[np->tok],                              "%s after %s", roff_name[np->tok],
Line 2428  post_ignpar(POST_ARGS)
Line 2531  post_ignpar(POST_ARGS)
                 }                  }
   
         if ((np = mdoc->last->last) != NULL)          if ((np = mdoc->last->last) != NULL)
                 if (np->tok == MDOC_Pp || np->tok == MDOC_Lp) {                  if (np->tok == MDOC_Pp) {
                         mandoc_vmsg(MANDOCERR_PAR_SKIP, mdoc->parse,                          mandoc_vmsg(MANDOCERR_PAR_SKIP, mdoc->parse,
                             np->line, np->pos, "%s at the end of %s",                              np->line, np->pos, "%s at the end of %s",
                             roff_name[np->tok],                              roff_name[np->tok],
Line 2449  post_prevpar(POST_ARGS)
Line 2552  post_prevpar(POST_ARGS)
                 return;                  return;
   
         /*          /*
          * Don't allow prior `Lp' or `Pp' prior to a paragraph-type           * Don't allow `Pp' prior to a paragraph-type
          * block:  `Lp', `Pp', or non-compact `Bd' or `Bl'.           * block: `Pp' or non-compact `Bd' or `Bl'.
          */           */
   
         if (n->prev->tok != MDOC_Pp &&          if (n->prev->tok != MDOC_Pp && n->prev->tok != ROFF_br)
             n->prev->tok != MDOC_Lp &&  
             n->prev->tok != ROFF_br)  
                 return;                  return;
         if (n->tok == MDOC_Bl && n->norm->Bl.comp)          if (n->tok == MDOC_Bl && n->norm->Bl.comp)
                 return;                  return;
Line 2493  post_par(POST_ARGS)
Line 2594  post_par(POST_ARGS)
                 np = mdoc->last->parent;                  np = mdoc->last->parent;
                 if (np->tok != MDOC_Sh && np->tok != MDOC_Ss)                  if (np->tok != MDOC_Sh && np->tok != MDOC_Ss)
                         return;                          return;
         } else if (np->tok != MDOC_Pp && np->tok != MDOC_Lp &&          } else if (np->tok != MDOC_Pp &&
             (mdoc->last->tok != ROFF_br ||              (mdoc->last->tok != ROFF_br ||
              (np->tok != ROFF_sp && np->tok != ROFF_br)))               (np->tok != ROFF_sp && np->tok != ROFF_br)))
                 return;                  return;
Legend:
Removed from v.1.349  
changed lines
  Added in v.1.363
CVSweb