[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.332 and 1.339

version 1.332, 2017/06/08 00:23:30 version 1.339, 2017/06/17 22:43:14
Line 53  typedef void (*v_post)(POST_ARGS);
Line 53  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_text(struct roff_man *, int, int, char *);
 static  void     check_bsd(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_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 **);
Line 75  static void  post_bx(POST_ARGS);
Line 75  static void  post_bx(POST_ARGS);
 static  void     post_defaults(POST_ARGS);  static  void     post_defaults(POST_ARGS);
 static  void     post_display(POST_ARGS);  static  void     post_display(POST_ARGS);
 static  void     post_dd(POST_ARGS);  static  void     post_dd(POST_ARGS);
   static  void     post_delim(POST_ARGS);
 static  void     post_dt(POST_ARGS);  static  void     post_dt(POST_ARGS);
 static  void     post_en(POST_ARGS);  static  void     post_en(POST_ARGS);
 static  void     post_es(POST_ARGS);  static  void     post_es(POST_ARGS);
Line 124  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 125  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         post_bl,        /* Bl */          post_bl,        /* Bl */
         NULL,           /* El */          NULL,           /* El */
         post_it,        /* It */          post_it,        /* It */
         NULL,           /* Ad */          post_delim,     /* Ad */
         post_an,        /* An */          post_an,        /* An */
         NULL,           /* Ap */          NULL,           /* Ap */
         post_defaults,  /* Ar */          post_defaults,  /* Ar */
         NULL,           /* Cd */          NULL,           /* Cd */
         NULL,           /* Cm */          post_delim,     /* Cm */
         NULL,           /* Dv */          post_delim,     /* Dv */
         NULL,           /* Er */          post_delim,     /* Er */
         NULL,           /* Ev */          post_delim,     /* Ev */
         post_ex,        /* Ex */          post_ex,        /* Ex */
         post_fa,        /* Fa */          post_fa,        /* Fa */
         NULL,           /* Fd */          NULL,           /* Fd */
         NULL,           /* Fl */          post_delim,     /* Fl */
         post_fn,        /* Fn */          post_fn,        /* Fn */
         NULL,           /* Ft */          post_delim,     /* Ft */
         NULL,           /* Ic */          post_delim,     /* Ic */
         NULL,           /* In */          post_delim,     /* In */
         post_defaults,  /* Li */          post_defaults,  /* Li */
         post_nd,        /* Nd */          post_nd,        /* Nd */
         post_nm,        /* Nm */          post_nm,        /* Nm */
         NULL,           /* Op */          post_delim,     /* Op */
         post_obsolete,  /* Ot */          post_obsolete,  /* Ot */
         post_defaults,  /* Pa */          post_defaults,  /* Pa */
         post_rv,        /* Rv */          post_rv,        /* Rv */
         post_st,        /* St */          post_st,        /* St */
         NULL,           /* Va */          post_delim,     /* Va */
         NULL,           /* Vt */          post_delim,     /* Vt */
         post_xr,        /* Xr */          post_xr,        /* Xr */
         NULL,           /* %A */          NULL,           /* %A */
         post_hyph,      /* %B */ /* FIXME: can be used outside Rs/Re. */          post_hyph,      /* %B */ /* FIXME: can be used outside Rs/Re. */
Line 164  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 165  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 */
         NULL,           /* Ao */          post_delim,     /* Ao */
         NULL,           /* Aq */          post_delim,     /* Aq */
         post_at,        /* At */          post_at,        /* At */
         NULL,           /* Bc */          NULL,           /* Bc */
         post_bf,        /* Bf */          post_bf,        /* Bf */
         NULL,           /* Bo */          post_delim,     /* Bo */
         NULL,           /* Bq */          NULL,           /* Bq */
         post_xx,        /* Bsx */          post_xx,        /* Bsx */
         post_bx,        /* Bx */          post_bx,        /* Bx */
Line 179  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
Line 180  static const v_post __mdoc_valids[MDOC_MAX - MDOC_Dd] 
         NULL,           /* Dq */          NULL,           /* Dq */
         NULL,           /* Ec */          NULL,           /* Ec */
         NULL,           /* Ef */          NULL,           /* Ef */
         NULL,           /* Em */          post_delim,     /* Em */
         NULL,           /* Eo */          NULL,           /* Eo */
         post_xx,        /* Fx */          post_xx,        /* Fx */
         NULL,           /* Ms */          post_delim,     /* Ms */
         NULL,           /* No */          NULL,           /* No */
         post_ns,        /* Ns */          post_ns,        /* Ns */
         post_xx,        /* Nx */          post_xx,        /* Nx */
         post_xx,        /* Ox */          post_xx,        /* Ox */
         NULL,           /* Pc */          NULL,           /* Pc */
         NULL,           /* Pf */          NULL,           /* Pf */
         NULL,           /* Po */          post_delim,     /* Po */
         NULL,           /* Pq */          post_delim,     /* Pq */
         NULL,           /* Qc */          NULL,           /* Qc */
         NULL,           /* Ql */          post_delim,     /* Ql */
         NULL,           /* Qo */          post_delim,     /* Qo */
         NULL,           /* Qq */          post_delim,     /* Qq */
         NULL,           /* Re */          NULL,           /* Re */
         post_rs,        /* Rs */          post_rs,        /* Rs */
         NULL,           /* Sc */          NULL,           /* Sc */
         NULL,           /* So */          post_delim,     /* So */
         NULL,           /* Sq */          post_delim,     /* Sq */
         post_sm,        /* Sm */          post_sm,        /* Sm */
         post_hyph,      /* Sx */          post_hyph,      /* Sx */
         NULL,           /* Sy */          post_delim,     /* Sy */
         post_useless,   /* Tn */          post_useless,   /* Tn */
         post_xx,        /* Ux */          post_xx,        /* Ux */
         NULL,           /* Xc */          NULL,           /* Xc */
         NULL,           /* Xo */          NULL,           /* Xo */
         post_fo,        /* Fo */          post_fo,        /* Fo */
         NULL,           /* Fc */          NULL,           /* Fc */
         NULL,           /* Oo */          post_delim,     /* Oo */
         NULL,           /* Oc */          NULL,           /* Oc */
         post_bk,        /* Bk */          post_bk,        /* Bk */
         NULL,           /* Ek */          NULL,           /* Ek */
         post_eoln,      /* Bt */          post_eoln,      /* Bt */
         NULL,           /* Hf */          post_obsolete,  /* Hf */
         post_obsolete,  /* Fr */          post_obsolete,  /* Fr */
         post_eoln,      /* Ud */          post_eoln,      /* Ud */
         post_lb,        /* Lb */          post_lb,        /* Lb */
         post_par,       /* Lp */          post_par,       /* Lp */
         NULL,           /* Lk */          post_delim,     /* Lk */
         post_defaults,  /* Mt */          post_defaults,  /* Mt */
         NULL,           /* Brq */          post_delim,     /* Brq */
         NULL,           /* Bro */          post_delim,     /* Bro */
         NULL,           /* Brc */          NULL,           /* Brc */
         NULL,           /* %C */          NULL,           /* %C */
         post_es,        /* Es */          post_es,        /* Es */
Line 303  mdoc_node_validate(struct roff_man *mdoc)
Line 304  mdoc_node_validate(struct roff_man *mdoc)
                 if (n->sec != SEC_SYNOPSIS ||                  if (n->sec != SEC_SYNOPSIS ||
                     (n->parent->tok != MDOC_Cd && n->parent->tok != MDOC_Fd))                      (n->parent->tok != MDOC_Cd && n->parent->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_Sh ||                  if (n->parent->tok == MDOC_It ||
                     n->parent->tok == MDOC_Ss ||                      (n->parent->type == ROFFT_BODY &&
                     n->parent->tok == MDOC_It)                       (n->parent->tok == MDOC_Sh ||
                         check_bsd(mdoc, n->line, n->pos, n->string);                        n->parent->tok == MDOC_Ss)))
                           check_toptext(mdoc, n->line, n->pos, n->string);
                 break;                  break;
         case ROFFT_EQN:          case ROFFT_EQN:
         case ROFFT_TBL:          case ROFFT_TBL:
Line 389  check_text(struct roff_man *mdoc, int ln, int pos, cha
Line 391  check_text(struct roff_man *mdoc, int ln, int pos, cha
 }  }
   
 static void  static void
 check_bsd(struct roff_man *mdoc, int ln, int pos, char *p)  check_toptext(struct roff_man *mdoc, int ln, int pos, const char *p)
 {  {
         const char      *cp;          const char      *cp, *cpr;
   
           if (*p == '\0')
                   return;
   
         if ((cp = strstr(p, "OpenBSD")) != NULL)          if ((cp = strstr(p, "OpenBSD")) != NULL)
                 mandoc_msg(MANDOCERR_BX, mdoc->parse,                  mandoc_msg(MANDOCERR_BX, mdoc->parse,
                     ln, pos + (cp - p), "Ox");                      ln, pos + (cp - p), "Ox");
Line 405  check_bsd(struct roff_man *mdoc, int ln, int pos, char
Line 410  check_bsd(struct roff_man *mdoc, int ln, int pos, char
         if ((cp = strstr(p, "DragonFly")) != NULL)          if ((cp = strstr(p, "DragonFly")) != NULL)
                 mandoc_msg(MANDOCERR_BX, mdoc->parse,                  mandoc_msg(MANDOCERR_BX, mdoc->parse,
                     ln, pos + (cp - p), "Dx");                      ln, pos + (cp - p), "Dx");
   
           cp = p;
           while ((cp = strstr(cp + 1, "()")) != NULL) {
                   for (cpr = cp - 1; cpr >= p; cpr--)
                           if (*cpr != '_' && !isalnum((unsigned char)*cpr))
                                   break;
                   if ((cpr < p || *cpr == ' ') && cpr + 1 < cp) {
                           cpr++;
                           mandoc_vmsg(MANDOCERR_FUNC, mdoc->parse,
                               ln, pos + (cpr - p),
                               "%.*s()", (int)(cp - cpr), cpr);
                   }
           }
 }  }
   
 static void  static void
   post_delim(POST_ARGS)
   {
           const struct roff_node  *nch;
           const char              *lc, *cp;
           int                      nw;
           enum mdelim              delim;
           enum roff_tok            tok;
   
           /*
            * Find candidates: at least two bytes,
            * the last one a closing or middle delimiter.
            */
   
           tok = mdoc->last->tok;
           nch = mdoc->last->last;
           if (nch == NULL || nch->type != ROFFT_TEXT)
                   return;
           lc = strchr(nch->string, '\0') - 1;
           if (lc <= nch->string)
                   return;
           delim = mdoc_isdelim(lc);
           if (delim == DELIM_NONE || delim == DELIM_OPEN)
                   return;
   
           /*
            * Reduce false positives by allowing various cases.
            */
   
           /* Escaped delimiters. */
           if (lc > nch->string + 1 && lc[-2] == '\\' &&
               (lc[-1] == '&' || lc[-1] == 'e'))
                   return;
   
           /* Specific byte sequences. */
           switch (*lc) {
           case ')':
                   for (cp = lc; cp >= nch->string; cp--)
                           if (*cp == '(')
                                   return;
                   break;
           case '.':
                   if (lc > nch->string + 1 && lc[-2] == '.' && lc[-1] == '.')
                           return;
                   if (lc[-1] == '.')
                           return;
                   break;
           case ';':
                   if (tok == MDOC_Vt)
                           return;
                   break;
           case '?':
                   if (lc[-1] == '?')
                           return;
                   break;
           case ']':
                   for (cp = lc; cp >= nch->string; cp--)
                           if (*cp == '[')
                                   return;
                   break;
           case '|':
                   if (lc == nch->string + 1 && lc[-1] == '|')
                           return;
           default:
                   break;
           }
   
           /* Exactly two non-alphanumeric bytes. */
           if (lc == nch->string + 1 && !isalnum((unsigned char)lc[-1]))
                   return;
   
           /* At least three alphabetic words with a sentence ending. */
           if (strchr("!.:?", *lc) != NULL && (tok == MDOC_Em ||
               tok == MDOC_Li || tok == MDOC_Po || tok == MDOC_Pq ||
               tok == MDOC_Sy)) {
                   nw = 0;
                   for (cp = lc - 1; cp >= nch->string; cp--) {
                           if (*cp == ' ') {
                                   nw++;
                                   if (cp > nch->string && cp[-1] == ',')
                                           cp--;
                           } else if (isalpha((unsigned int)*cp)) {
                                   if (nw > 1)
                                           return;
                           } else
                                   break;
                   }
           }
   
           mandoc_vmsg(MANDOCERR_DELIM, mdoc->parse,
               nch->line, nch->pos + (lc - nch->string),
               "%s%s %s", roff_name[tok],
               nch == mdoc->last->child ? "" : " ...", nch->string);
   }
   
   static void
 post_bl_norm(POST_ARGS)  post_bl_norm(POST_ARGS)
 {  {
         struct roff_node *n;          struct roff_node *n;
Line 782  post_lb(POST_ARGS)
Line 895  post_lb(POST_ARGS)
         struct roff_node        *n;          struct roff_node        *n;
         const char              *p;          const char              *p;
   
           post_delim(mdoc);
   
         n = mdoc->last;          n = mdoc->last;
         assert(n->child->type == ROFFT_TEXT);          assert(n->child->type == ROFFT_TEXT);
         mdoc->next = ROFF_NEXT_CHILD;          mdoc->next = ROFF_NEXT_CHILD;
Line 1042  post_fa(POST_ARGS)
Line 1157  post_fa(POST_ARGS)
                         break;                          break;
                 }                  }
         }          }
           post_delim(mdoc);
 }  }
   
 static void  static void
Line 1064  post_nm(POST_ARGS)
Line 1180  post_nm(POST_ARGS)
                 mandoc_msg(MANDOCERR_NM_NONAME, mdoc->parse,                  mandoc_msg(MANDOCERR_NM_NONAME, mdoc->parse,
                     n->line, n->pos, "Nm");                      n->line, n->pos, "Nm");
   
           if (n->type == ROFFT_ELEM)
                   post_delim(mdoc);
   
         if ((n->type != ROFFT_ELEM && n->type != ROFFT_HEAD) ||          if ((n->type != ROFFT_ELEM && n->type != ROFFT_HEAD) ||
             (n->child != NULL && n->child->type == ROFFT_TEXT) ||              (n->child != NULL && n->child->type == ROFFT_TEXT) ||
             mdoc->meta.name == NULL)              mdoc->meta.name == NULL)
Line 1154  post_defaults(POST_ARGS)
Line 1273  post_defaults(POST_ARGS)
 {  {
         struct roff_node *nn;          struct roff_node *nn;
   
           if (mdoc->last->child != NULL) {
                   post_delim(mdoc);
                   return;
           }
   
         /*          /*
          * The `Ar' defaults to "file ..." if no value is provided as an           * The `Ar' defaults to "file ..." if no value is provided as an
          * argument; the `Mt' and `Pa' macros use "~"; the `Li' just           * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
          * gets an empty string.           * gets an empty string.
          */           */
   
         if (mdoc->last->child != NULL)  
                 return;  
   
         nn = mdoc->last;          nn = mdoc->last;
   
         switch (nn->tok) {          switch (nn->tok) {
         case MDOC_Ar:          case MDOC_Ar:
                 mdoc->next = ROFF_NEXT_CHILD;                  mdoc->next = ROFF_NEXT_CHILD;
Line 1228  post_an(POST_ARGS)
Line 1348  post_an(POST_ARGS)
                 if (nch == NULL)                  if (nch == NULL)
                         mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,                          mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
                             np->line, np->pos, "An");                              np->line, np->pos, "An");
                   else
                           post_delim(mdoc);
         } else if (nch != NULL)          } else if (nch != NULL)
                 mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,                  mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,
                     nch->line, nch->pos, "An ... %s", nch->string);                      nch->line, nch->pos, "An ... %s", nch->string);
Line 1256  post_xx(POST_ARGS)
Line 1378  post_xx(POST_ARGS)
         struct roff_node        *n;          struct roff_node        *n;
         const char              *os;          const char              *os;
   
           post_delim(mdoc);
   
         n = mdoc->last;          n = mdoc->last;
         switch (n->tok) {          switch (n->tok) {
         case MDOC_Bsx:          case MDOC_Bsx:
Line 1666  post_root(POST_ARGS)
Line 1790  post_root(POST_ARGS)
         /* Add missing prologue data. */          /* Add missing prologue data. */
   
         if (mdoc->meta.date == NULL)          if (mdoc->meta.date == NULL)
                 mdoc->meta.date = mdoc->quick ?                  mdoc->meta.date = mdoc->quick ? mandoc_strdup("") :
                     mandoc_strdup("") :                      mandoc_normdate(mdoc, NULL, 0, 0);
                     mandoc_normdate(mdoc->parse, NULL, 0, 0);  
   
         if (mdoc->meta.title == NULL) {          if (mdoc->meta.title == NULL) {
                 mandoc_msg(MANDOCERR_DT_NOTITLE,                  mandoc_msg(MANDOCERR_DT_NOTITLE,
Line 1683  post_root(POST_ARGS)
Line 1806  post_root(POST_ARGS)
                 mandoc_msg(MANDOCERR_OS_MISSING,                  mandoc_msg(MANDOCERR_OS_MISSING,
                     mdoc->parse, 0, 0, NULL);                      mdoc->parse, 0, 0, NULL);
                 mdoc->meta.os = mandoc_strdup("");                  mdoc->meta.os = mandoc_strdup("");
         }          } else if (mdoc->meta.os_e &&
               (mdoc->meta.rcsids & (1 << mdoc->meta.os_e)) == 0)
                   mandoc_msg(MANDOCERR_RCS_MISSING,
                       mdoc->parse, 0, 0, NULL);
   
         /* Check that we begin with a proper `Sh'. */          /* Check that we begin with a proper `Sh'. */
   
Line 2090  post_xr(POST_ARGS)
Line 2216  post_xr(POST_ARGS)
         if (nch->next == NULL) {          if (nch->next == NULL) {
                 mandoc_vmsg(MANDOCERR_XR_NOSEC, mdoc->parse,                  mandoc_vmsg(MANDOCERR_XR_NOSEC, mdoc->parse,
                     n->line, n->pos, "Xr %s", nch->string);                      n->line, n->pos, "Xr %s", nch->string);
                 return;          } else
         }                  assert(nch->next == n->last);
         assert(nch->next == n->last);          post_delim(mdoc);
 }  }
   
 static void  static void
Line 2224  post_dd(POST_ARGS)
Line 2350  post_dd(POST_ARGS)
   
         if (n->child == NULL || n->child->string[0] == '\0') {          if (n->child == NULL || n->child->string[0] == '\0') {
                 mdoc->meta.date = mdoc->quick ? mandoc_strdup("") :                  mdoc->meta.date = mdoc->quick ? mandoc_strdup("") :
                     mandoc_normdate(mdoc->parse, NULL, n->line, n->pos);                      mandoc_normdate(mdoc, NULL, n->line, n->pos);
                 return;                  return;
         }          }
   
Line 2233  post_dd(POST_ARGS)
Line 2359  post_dd(POST_ARGS)
         if (mdoc->quick)          if (mdoc->quick)
                 mdoc->meta.date = datestr;                  mdoc->meta.date = datestr;
         else {          else {
                 mdoc->meta.date = mandoc_normdate(mdoc->parse,                  mdoc->meta.date = mandoc_normdate(mdoc,
                     datestr, n->line, n->pos);                      datestr, n->line, n->pos);
                 free(datestr);                  free(datestr);
         }          }
Line 2341  post_bx(POST_ARGS)
Line 2467  post_bx(POST_ARGS)
         struct roff_node        *n, *nch;          struct roff_node        *n, *nch;
         const char              *macro;          const char              *macro;
   
           post_delim(mdoc);
   
         n = mdoc->last;          n = mdoc->last;
         nch = n->child;          nch = n->child;
   
Line 2443  post_os(POST_ARGS)
Line 2571  post_os(POST_ARGS)
 out:    mdoc->meta.os_e = strstr(mdoc->meta.os, "OpenBSD") != NULL ?  out:    mdoc->meta.os_e = strstr(mdoc->meta.os, "OpenBSD") != NULL ?
             MDOC_OS_OPENBSD : strstr(mdoc->meta.os, "NetBSD") != NULL ?              MDOC_OS_OPENBSD : strstr(mdoc->meta.os, "NetBSD") != NULL ?
             MDOC_OS_NETBSD : MDOC_OS_OTHER;              MDOC_OS_NETBSD : MDOC_OS_OTHER;
   
           /*
            * This is the earliest point where we can check
            * Mdocdate conventions because we don't know
            * the operating system earlier.
            */
   
           while (n->tok != MDOC_Dd)
                   if ((n = n->prev) == NULL)
                           return;
           if ((n = n->child) == NULL)
                   return;
           if (strncmp(n->string, "$" "Mdocdate", 9)) {
                   if (mdoc->meta.os_e == MDOC_OS_OPENBSD)
                           mandoc_vmsg(MANDOCERR_MDOCDATE_MISSING,
                               mdoc->parse, n->line, n->pos,
                               "Dd %s", n->string);
           } else {
                   if (mdoc->meta.os_e == MDOC_OS_NETBSD)
                           mandoc_vmsg(MANDOCERR_MDOCDATE,
                               mdoc->parse, n->line, n->pos,
                               "Dd %s", n->string);
           }
 }  }
   
 enum roff_sec  enum roff_sec
Legend:
Removed from v.1.332  
changed lines
  Added in v.1.339
CVSweb