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

Diff for /mandoc/Attic/validate.c between version 1.21 and 1.55

version 1.21, 2009/01/09 14:45:44 version 1.55, 2009/02/24 12:20:52
Line 21 
Line 21 
   
 #include "private.h"  #include "private.h"
   
   /*
    * Pre- and post-validate macros as they're parsed.  Pre-validation
    * occurs when the macro has been detected and its arguments parsed.
    * Post-validation occurs when all child macros have also been parsed.
    * In the ELEMENT case, this is simply the parameters of the macro; in
    * the BLOCK case, this is the HEAD, BODY, TAIL and so on.
    */
   
 typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);  #define PRE_ARGS        struct mdoc *mdoc, const struct mdoc_node *n
 typedef int     (*v_post)(struct mdoc *);  #define POST_ARGS       struct mdoc *mdoc
   
   typedef int     (*v_pre)(PRE_ARGS);
   typedef int     (*v_post)(POST_ARGS);
   
   /* FIXME: some sections should only occur in specific msecs. */
   /* FIXME: ignoring Pp. */
   /* FIXME: math symbols. */
   /* FIXME: .Fd only in synopsis section. */
   
 struct  valids {  struct  valids {
         v_pre    pre;          v_pre   *pre;
         v_post  *post;          v_post  *post;
 };  };
   
   /* Utility checks. */
   
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     check_parent(PRE_ARGS, int, enum mdoc_type);
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     check_msec(PRE_ARGS, int, enum mdoc_msec *);
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     check_stdarg(PRE_ARGS);
 static  int     post_headchild_err_ge1(struct mdoc *);  
 static  int     post_elemchild_err_ge1(struct mdoc *);  
 static  int     post_bodychild_warn_ge1(struct mdoc *);  
 static  int     post_sh(struct mdoc *);  
   
 static  v_post  posts_sh[] = { post_headchild_err_ge1,  static  int     check_text(struct mdoc *,
                         post_bodychild_warn_ge1, post_sh, NULL };                          size_t, size_t, const char *);
 static  v_post  posts_dd[] = { post_elemchild_err_ge1, NULL };  
   
   static  int     err_child_lt(struct mdoc *, const char *, int);
   static  int     err_child_gt(struct mdoc *, const char *, int);
   static  int     warn_child_gt(struct mdoc *, const char *, int);
   static  int     err_child_eq(struct mdoc *, const char *, int);
   static  int     warn_child_eq(struct mdoc *, const char *, int);
   
   /* Utility auxiliaries. */
   
   static  inline int count_child(struct mdoc *);
   static  inline int warn_count(struct mdoc *, const char *,
                           int, const char *, int);
   static  inline int err_count(struct mdoc *, const char *,
                           int, const char *, int);
   
   /* Specific pre-child-parse routines. */
   
   static  int     pre_display(PRE_ARGS);
   static  int     pre_sh(PRE_ARGS);
   static  int     pre_ss(PRE_ARGS);
   static  int     pre_bd(PRE_ARGS);
   static  int     pre_bl(PRE_ARGS);
   static  int     pre_it(PRE_ARGS);
   static  int     pre_cd(PRE_ARGS);
   static  int     pre_er(PRE_ARGS);
   static  int     pre_ex(PRE_ARGS);
   static  int     pre_rv(PRE_ARGS);
   static  int     pre_an(PRE_ARGS);
   static  int     pre_st(PRE_ARGS);
   static  int     pre_prologue(PRE_ARGS);
   static  int     pre_prologue(PRE_ARGS);
   static  int     pre_prologue(PRE_ARGS);
   
   /* Specific post-child-parse routines. */
   
   static  int     herr_ge1(POST_ARGS);
   static  int     herr_le1(POST_ARGS);
   static  int     herr_eq0(POST_ARGS);
   static  int     eerr_eq0(POST_ARGS);
   static  int     eerr_le1(POST_ARGS);
   static  int     eerr_le2(POST_ARGS);
   static  int     eerr_eq1(POST_ARGS);
   static  int     eerr_ge1(POST_ARGS);
   static  int     ewarn_eq0(POST_ARGS);
   static  int     ewarn_eq1(POST_ARGS);
   static  int     bwarn_ge1(POST_ARGS);
   static  int     ewarn_ge1(POST_ARGS);
   static  int     ebool(POST_ARGS);
   
   static  int     post_sh(POST_ARGS);
   static  int     post_sh_body(POST_ARGS);
   static  int     post_sh_head(POST_ARGS);
   static  int     post_bl(POST_ARGS);
   static  int     post_it(POST_ARGS);
   static  int     post_ex(POST_ARGS);
   static  int     post_an(POST_ARGS);
   static  int     post_at(POST_ARGS);
   static  int     post_xr(POST_ARGS);
   static  int     post_nm(POST_ARGS);
   static  int     post_bf(POST_ARGS);
   static  int     post_root(POST_ARGS);
   
   /* Collections of pre-child-parse routines. */
   
   static  v_pre   pres_prologue[] = { pre_prologue, NULL };
   static  v_pre   pres_d1[] = { pre_display, NULL };
   static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
   static  v_pre   pres_bl[] = { pre_bl, NULL };
   static  v_pre   pres_it[] = { pre_it, NULL };
   static  v_pre   pres_ss[] = { pre_ss, NULL };
   static  v_pre   pres_sh[] = { pre_sh, NULL };
   static  v_pre   pres_cd[] = { pre_cd, NULL };
   static  v_pre   pres_er[] = { pre_er, NULL };
   static  v_pre   pres_ex[] = { pre_ex, NULL };
   static  v_pre   pres_rv[] = { pre_rv, NULL };
   static  v_pre   pres_an[] = { pre_an, NULL };
   static  v_pre   pres_st[] = { pre_st, NULL };
   
   /* Collections of post-child-parse routines. */
   
   static  v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
   static  v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
   static  v_post  posts_text[] = { eerr_ge1, NULL };
   static  v_post  posts_wtext[] = { ewarn_ge1, NULL };
   static  v_post  posts_notext[] = { eerr_eq0, NULL };
   static  v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
   static  v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
   static  v_post  posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };
   static  v_post  posts_it[] = { post_it, NULL };
   static  v_post  posts_in[] = { ewarn_eq1, NULL };
   static  v_post  posts_ss[] = { herr_ge1, NULL };
   static  v_post  posts_pf[] = { eerr_eq1, NULL };
   static  v_post  posts_pp[] = { ewarn_eq0, NULL };
   static  v_post  posts_ex[] = { eerr_le1, post_ex, NULL };
   static  v_post  posts_an[] = { post_an, NULL };
   static  v_post  posts_at[] = { post_at, NULL };
   static  v_post  posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
   static  v_post  posts_nm[] = { post_nm, NULL };
   static  v_post  posts_bf[] = { herr_le1, post_bf, NULL };
   static  v_post  posts_rs[] = { herr_eq0, bwarn_ge1, NULL };
   static  v_post  posts_fo[] = { bwarn_ge1, NULL };
   static  v_post  posts_bk[] = { herr_eq0, bwarn_ge1, NULL };
   
   /* Per-macro pre- and post-child-check routine collections. */
   
 const   struct valids mdoc_valids[MDOC_MAX] = {  const   struct valids mdoc_valids[MDOC_MAX] = {
         { NULL, NULL }, /* \" */          { NULL, NULL },                         /* \" */
         { pre_prologue, posts_dd }, /* Dd */          { pres_prologue, posts_text },          /* Dd */
         { pre_prologue, NULL }, /* Dt */          { pres_prologue, NULL },                /* Dt */
         { pre_prologue, NULL }, /* Os */          { pres_prologue, NULL },                /* Os */
         { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */          { pres_sh, posts_sh },                  /* Sh */
         { NULL, NULL }, /* Ss */ /* FIXME: preceding Pp. */          { pres_ss, posts_ss },                  /* Ss */
         { NULL, NULL }, /* Pp */          { NULL, posts_pp },                     /* Pp */
         { NULL, NULL }, /* D1 */          { pres_d1, posts_wline },               /* D1 */
         { NULL, NULL }, /* Dl */          { pres_d1, posts_wline },               /* Dl */
         { NULL, NULL }, /* Bd */ /* FIXME: preceding Pp. */          { pres_bd, posts_bd },                  /* Bd */
         { NULL, NULL }, /* Ed */          { NULL, NULL },                         /* Ed */
         { NULL, NULL }, /* Bl */ /* FIXME: preceding Pp. */          { pres_bl, posts_bl },                  /* Bl */
         { NULL, NULL }, /* El */          { NULL, NULL },                         /* El */
         { NULL, NULL }, /* It */          { pres_it, posts_it },                  /* It */
         { NULL, NULL }, /* Ad */          { NULL, posts_text },                   /* Ad */
         { NULL, NULL }, /* An */          { pres_an, posts_an },                  /* An */
         { NULL, NULL }, /* Ar */          { NULL, NULL },                         /* Ar */
         { NULL, NULL }, /* Cd */          { pres_cd, posts_text },                /* Cd */
         { NULL, NULL }, /* Cm */          { NULL, NULL },                         /* Cm */
         { NULL, NULL }, /* Dv */          { NULL, posts_text },                   /* Dv */
         { NULL, NULL }, /* Er */          { pres_er, posts_text },                /* Er */
         { NULL, NULL }, /* Ev */          { NULL, posts_text },                   /* Ev */
         { NULL, NULL }, /* Ex */          { pres_ex, posts_ex },                  /* Ex */
         { NULL, NULL }, /* Fa */          { NULL, posts_text },                   /* Fa */
         { NULL, NULL }, /* Fd */          { NULL, posts_wtext },                  /* Fd */
         { NULL, NULL }, /* Fl */          { NULL, NULL },                         /* Fl */
         { NULL, NULL }, /* Fn */          { NULL, posts_text },                   /* Fn */
         { NULL, NULL }, /* Ft */          { NULL, posts_wtext },                  /* Ft */
         { NULL, NULL }, /* Ic */          { NULL, posts_text },                   /* Ic */
         { NULL, NULL }, /* In */          { NULL, posts_in },                     /* In */
         { NULL, NULL }, /* Li */          { NULL, posts_text },                   /* Li */
         { NULL, NULL }, /* Nd */          { NULL, posts_wtext },                  /* Nd */
         { NULL, NULL }, /* Nm */          { NULL, posts_nm },                     /* Nm */
         { NULL, NULL }, /* Op */          { NULL, posts_wline },                  /* Op */
         { NULL, NULL }, /* Ot */          { NULL, NULL },                         /* Ot */
         { NULL, NULL }, /* Pa */          { NULL, NULL },                         /* Pa */
         { NULL, NULL }, /* Rv */          { pres_rv, posts_notext },              /* Rv */
         { NULL, NULL }, /* St */          { pres_st, posts_notext },              /* St */
         { NULL, NULL }, /* Va */          { NULL, posts_text },                   /* Va */
         { NULL, NULL }, /* Vt */          { NULL, posts_text },                   /* Vt */
         { NULL, NULL }, /* Xr */          { NULL, posts_xr },                     /* Xr */
         { NULL, NULL }, /* %A */          { NULL, posts_text },                   /* %A */
         { NULL, NULL }, /* %B */          { NULL, posts_text },                   /* %B */
         { NULL, NULL }, /* %D */          { NULL, posts_text },                   /* %D */
         { NULL, NULL }, /* %I */          { NULL, posts_text },                   /* %I */
         { NULL, NULL }, /* %J */          { NULL, posts_text },                   /* %J */
         { NULL, NULL }, /* %N */          { NULL, posts_text },                   /* %N */
         { NULL, NULL }, /* %O */          { NULL, posts_text },                   /* %O */
         { NULL, NULL }, /* %P */          { NULL, posts_text },                   /* %P */
         { NULL, NULL }, /* %R */          { NULL, posts_text },                   /* %R */
         { NULL, NULL }, /* %T */          { NULL, posts_text },                   /* %T */
         { NULL, NULL }, /* %V */          { NULL, posts_text },                   /* %V */
         { NULL, NULL }, /* Ac */          { NULL, NULL },                         /* Ac */
         { NULL, NULL }, /* Ao */          { NULL, NULL },                         /* Ao */
         { NULL, NULL }, /* Aq */          { NULL, posts_wline },                  /* Aq */
         { NULL, NULL }, /* At */ /* FIXME */          { NULL, posts_at },                     /* At */
         { NULL, NULL }, /* Bc */          { NULL, NULL },                         /* Bc */
         { NULL, NULL }, /* Bf */          { NULL, posts_bf },                     /* Bf */
         { NULL, NULL }, /* Bo */          { NULL, NULL },                         /* Bo */
         { NULL, NULL }, /* Bq */          { NULL, posts_wline },                  /* Bq */
         { NULL, NULL }, /* Bsx */          { NULL, NULL },                         /* Bsx */
         { NULL, NULL }, /* Bx */          { NULL, NULL },                         /* Bx */
         { NULL, NULL }, /* Db */          { NULL, posts_bool },                   /* Db */
         { NULL, NULL }, /* Dc */          { NULL, NULL },                         /* Dc */
         { NULL, NULL }, /* Do */          { NULL, NULL },                         /* Do */
         { NULL, NULL }, /* Dq */          { NULL, posts_wline },                  /* Dq */
         { NULL, NULL }, /* Ec */          { NULL, NULL },                         /* Ec */
         { NULL, NULL }, /* Ef */ /* -symbolic, etc. */          { NULL, NULL },                         /* Ef */
         { NULL, NULL }, /* Em */          { NULL, posts_text },                   /* Em */
         { NULL, NULL }, /* Eo */          { NULL, NULL },                         /* Eo */
         { NULL, NULL }, /* Fx */          { NULL, NULL },                         /* Fx */
         { NULL, NULL }, /* Ms */          { NULL, posts_text },                   /* Ms */
         { NULL, NULL }, /* No */          { NULL, posts_notext },                 /* No */
         { NULL, NULL }, /* Ns */          { NULL, posts_notext },                 /* Ns */
         { NULL, NULL }, /* Nx */          { NULL, NULL },                         /* Nx */
         { NULL, NULL }, /* Ox */          { NULL, NULL },                         /* Ox */
         { NULL, NULL }, /* Pc */          { NULL, NULL },                         /* Pc */
         { NULL, NULL }, /* Pf */ /* 2 or more arguments */          { NULL, posts_pf },                     /* Pf */
         { NULL, NULL }, /* Po */          { NULL, NULL },                         /* Po */
         { NULL, NULL }, /* Pq */ /* FIXME: ignore following Sh/Ss */          { NULL, posts_wline },                  /* Pq */
         { NULL, NULL }, /* Qc */          { NULL, NULL },                         /* Qc */
         { NULL, NULL }, /* Ql */          { NULL, posts_wline },                  /* Ql */
         { NULL, NULL }, /* Qo */          { NULL, NULL },                         /* Qo */
         { NULL, NULL }, /* Qq */          { NULL, posts_wline },                  /* Qq */
         { NULL, NULL }, /* Re */          { NULL, NULL },                         /* Re */
         { NULL, NULL }, /* Rs */          { NULL, posts_rs },                     /* Rs */
         { NULL, NULL }, /* Sc */          { NULL, NULL },                         /* Sc */
         { NULL, NULL }, /* So */          { NULL, NULL },                         /* So */
         { NULL, NULL }, /* Sq */          { NULL, posts_wline },                  /* Sq */
         { NULL, NULL }, /* Sm */          { NULL, posts_bool },                   /* Sm */
         { NULL, NULL }, /* Sx */          { NULL, posts_text },                   /* Sx */
         { NULL, NULL }, /* Sy */          { NULL, posts_text },                   /* Sy */
         { NULL, NULL }, /* Tn */          { NULL, posts_text },                   /* Tn */
         { NULL, NULL }, /* Ux */          { NULL, NULL },                         /* Ux */
         { NULL, NULL }, /* Xc */          { NULL, NULL },                         /* Xc */
         { NULL, NULL }, /* Xo */          { NULL, NULL },                         /* Xo */
         { NULL, NULL }, /* Fo */          { NULL, posts_fo },                     /* Fo */
         { NULL, NULL }, /* Fc */          { NULL, NULL },                         /* Fc */
         { NULL, NULL }, /* Oo */          { NULL, NULL },                         /* Oo */
         { NULL, NULL }, /* Oc */          { NULL, NULL },                         /* Oc */
         { NULL, NULL }, /* Bk */          { NULL, posts_bk },                     /* Bk */
         { NULL, NULL }, /* Ek */          { NULL, NULL },                         /* Ek */
         { NULL, NULL }, /* Bt */          { NULL, posts_notext },                 /* Bt */
         { NULL, NULL }, /* Hf */          { NULL, NULL },                         /* Hf */
         { NULL, NULL }, /* Fr */          { NULL, NULL },                         /* Fr */
         { NULL, NULL }, /* Ud */          { NULL, posts_notext },                 /* Ud */
 };  };
   
   
   static inline int
   warn_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
   {
   
           return(mdoc_warn(m, WARN_SYNTAX,
                                   "suggests %s %d %s (has %d)",
                                   v, want, k, has));
   }
   
   
   static inline int
   err_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
   {
   
           return(mdoc_err(m, "requires %s %d %s (has %d)",
                                   v, want, k, has));
   }
   
   
   static inline int
   count_child(struct mdoc *mdoc)
   {
           int               i;
           struct mdoc_node *n;
   
           for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                   /* Do nothing */ ;
   
           return(i);
   }
   
   
   /*
    * Build these up with macros because they're basically the same check
    * for different inequalities.  Yes, this could be done with functions,
    * but this is reasonable for now.
    */
   
   #define CHECK_CHILD_DEFN(lvl, name, ineq)                       \
   static int                                                      \
   lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz)    \
   {                                                               \
           int i;                                                  \
           if ((i = count_child(mdoc)) ineq sz)                    \
                   return(1);                                      \
           return(lvl##_count(mdoc, #ineq, sz, p, i));             \
   }
   
   #define CHECK_BODY_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   b##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           if (MDOC_BODY != mdoc->last->type)                      \
                   return(1);                                      \
           return(func(mdoc, "multiline parameters", (num)));      \
   }
   
   #define CHECK_ELEM_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   e##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           assert(MDOC_ELEM == mdoc->last->type);                  \
           return(func(mdoc, "line parameters", (num)));           \
   }
   
   #define CHECK_HEAD_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   h##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           if (MDOC_HEAD != mdoc->last->type)                      \
                   return(1);                                      \
           return(func(mdoc, "multiline parameters", (num)));      \
   }
   
   
   CHECK_CHILD_DEFN(warn, gt, >)                   /* warn_child_gt() */
   CHECK_CHILD_DEFN(err, gt, >)                    /* err_child_gt() */
   CHECK_CHILD_DEFN(warn, eq, ==)                  /* warn_child_eq() */
   CHECK_CHILD_DEFN(err, eq, ==)                   /* err_child_eq() */
   CHECK_CHILD_DEFN(err, lt, <)                    /* err_child_lt() */
   CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0)    /* bwarn_ge1() */
   CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1)    /* ewarn_eq1() */
   CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0)    /* ewarn_eq0() */
   CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0)    /* ewarn_gt1() */
   CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1)      /* eerr_eq1() */
   CHECK_ELEM_DEFN(le2, err, err_child_lt, 3)      /* eerr_le2() */
   CHECK_ELEM_DEFN(le1, err, err_child_lt, 2)      /* eerr_le1() */
   CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0)      /* eerr_eq0() */
   CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0)      /* eerr_ge1() */
   CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0)      /* herr_eq0() */
   CHECK_HEAD_DEFN(le1, err, err_child_lt, 2)      /* herr_le1() */
   CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0)      /* herr_ge1() */
   
   
 static int  static int
 post_bodychild_warn_ge1(struct mdoc *mdoc)  check_stdarg(PRE_ARGS)
 {  {
   
         if (MDOC_BODY != mdoc->last->type)          if (MDOC_Std == n->data.elem.argv[0].arg &&
                           1 == n->data.elem.argc)
                 return(1);                  return(1);
         if (mdoc->last->child)  
           return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
                                   "one argument suggested"));
   }
   
   
   static int
   check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs)
   {
           int              i;
   
           for (i = 0; i < sz; i++)
                   if (msecs[i] == mdoc->meta.msec)
                           return(1);
           return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
                                   "invalid manual section"));
   }
   
   
   static int
   check_text(struct mdoc *mdoc, size_t line, size_t pos, const char *p)
   {
           size_t           c;
   
           for ( ; *p; p++) {
                   if ('\\' != *p)
                           continue;
                   if ((c = mdoc_isescape(p))) {
                           p += (c - 1);
                           continue;
                   }
                   return(mdoc_perr(mdoc, line, pos,
                                   "invalid escape sequence"));
           }
   
           return(1);
   }
   
   
   
   
   static int
   check_parent(PRE_ARGS, int tok, enum mdoc_type t)
   {
   
           assert(n->parent);
           if ((MDOC_ROOT == t || tok == n->parent->tok) &&
                           (t == n->parent->type))
                 return(1);                  return(1);
   
         return(mdoc_warn(mdoc, WARN_ARGS_GE1));          return(mdoc_nerr(mdoc, n, "require parent %s",
                   MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
 }  }
   
   
   
 static int  static int
 post_elemchild_err_ge1(struct mdoc *mdoc)  pre_display(PRE_ARGS)
 {  {
           struct mdoc_node *node;
   
         assert(MDOC_ELEM == mdoc->last->type);          /* Display elements (`Bd', `D1'...) cannot be nested. */
         if (mdoc->last->child)  
           if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         return(mdoc_err(mdoc, ERR_ARGS_GE1));  
           /* LINTED */
           for (node = mdoc->last->parent; node; node = node->parent)
                   if (MDOC_BLOCK == node->type)
                           if (MDOC_Bd == node->tok)
                                   break;
           if (NULL == node)
                   return(1);
   
           return(mdoc_nerr(mdoc, n, "displays may not be nested"));
 }  }
   
   
 static int  static int
 post_headchild_err_ge1(struct mdoc *mdoc)  pre_bl(PRE_ARGS)
 {  {
           int              type, err, i;
           struct mdoc_arg *argv;
           size_t           argc;
   
         if (MDOC_HEAD != mdoc->last->type)          if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         if (mdoc->last->child)  
           argc = n->data.block.argc;
   
           /* Make sure that only one type of list is specified.  */
   
           /* LINTED */
           for (i = 0, type = err = 0; i < (int)argc; i++) {
                   argv = &n->data.block.argv[i];
   
                   switch (argv->arg) {
                   case (MDOC_Bullet):
                           /* FALLTHROUGH */
                   case (MDOC_Dash):
                           /* FALLTHROUGH */
                   case (MDOC_Enum):
                           /* FALLTHROUGH */
                   case (MDOC_Hyphen):
                           /* FALLTHROUGH */
                   case (MDOC_Item):
                           /* FALLTHROUGH */
                   case (MDOC_Tag):
                           /* FALLTHROUGH */
                   case (MDOC_Diag):
                           /* FALLTHROUGH */
                   case (MDOC_Hang):
                           /* FALLTHROUGH */
                   case (MDOC_Ohang):
                           /* FALLTHROUGH */
                   case (MDOC_Inset):
                           /* FALLTHROUGH */
                   case (MDOC_Column):
                           if (0 == type++)
                                   break;
                           return(mdoc_perr(mdoc, argv->line, argv->pos,
                                           "multiple types specified"));
                   default:
                           break;
                   }
           }
   
           if (type)
                 return(1);                  return(1);
         return(mdoc_err(mdoc, ERR_ARGS_GE1));          return(mdoc_err(mdoc, "no type specified"));
 }  }
   
   
 static int  static int
 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)  pre_bd(PRE_ARGS)
 {  {
           int              type, err, i;
           struct mdoc_arg *argv;
           size_t           argc;
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          if (MDOC_BLOCK != n->type)
                 return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE));                  return(1);
         assert(MDOC_ELEM == node->type);  
   
           argc = n->data.block.argc;
   
           /* Make sure that only one type of display is specified.  */
   
           /* LINTED */
           for (i = 0, err = type = 0; ! err && i < (int)argc; i++) {
                   argv = &n->data.block.argv[i];
   
                   switch (argv->arg) {
                   case (MDOC_Ragged):
                           /* FALLTHROUGH */
                   case (MDOC_Unfilled):
                           /* FALLTHROUGH */
                   case (MDOC_Filled):
                           /* FALLTHROUGH */
                   case (MDOC_Literal):
                           /* FALLTHROUGH */
                   case (MDOC_File):
                           if (0 == type++)
                                   break;
                           return(mdoc_perr(mdoc, argv->line, argv->pos,
                                           "multiple types specified"));
                   default:
                           break;
                   }
           }
   
           if (type)
                   return(1);
           return(mdoc_err(mdoc, "no type specified"));
   }
   
   
   static int
   pre_ss(PRE_ARGS)
   {
   
           if (MDOC_BLOCK != n->type)
                   return(1);
           return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
   }
   
   
   static int
   pre_sh(PRE_ARGS)
   {
   
           if (MDOC_BLOCK != n->type)
                   return(1);
           return(check_parent(mdoc, n, -1, MDOC_ROOT));
   }
   
   
   static int
   pre_it(PRE_ARGS)
   {
   
           /* TODO: -width attribute must be specified for -tag. */
           /* TODO: children too big for -width? */
   
           if (MDOC_BLOCK != n->type)
                   return(1);
           return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
   }
   
   
   static int
   pre_st(PRE_ARGS)
   {
   
           if (1 == n->data.elem.argc)
                   return(1);
           return(mdoc_nerr(mdoc, n, "one argument required"));
   }
   
   
   static int
   pre_an(PRE_ARGS)
   {
   
           if (1 >= n->data.elem.argc)
                   return(1);
           return(mdoc_nerr(mdoc, n, "one argument allowed"));
   }
   
   
   static int
   pre_rv(PRE_ARGS)
   {
           enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };
   
           if ( ! check_msec(mdoc, n, 2, msecs))
                   return(0);
           return(check_stdarg(mdoc, n));
   }
   
   
   static int
   pre_ex(PRE_ARGS)
   {
           enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };
   
           if ( ! check_msec(mdoc, n, 3, msecs))
                   return(0);
           return(check_stdarg(mdoc, n));
   }
   
   
   static int
   pre_er(PRE_ARGS)
   {
           enum mdoc_msec msecs[] = { MSEC_2 };
   
           return(check_msec(mdoc, n, 1, msecs));
   }
   
   
   static int
   pre_cd(PRE_ARGS)
   {
           enum mdoc_msec msecs[] = { MSEC_4 };
   
           return(check_msec(mdoc, n, 1, msecs));
   }
   
   
   static int
   pre_prologue(PRE_ARGS)
   {
   
           if (SEC_PROLOGUE != mdoc->lastnamed)
                   return(mdoc_nerr(mdoc, n, "prologue only"));
   
         /* Check for ordering. */          /* Check for ordering. */
   
         switch (node->data.elem.tok) {          switch (n->tok) {
         case (MDOC_Os):          case (MDOC_Os):
                 if (mdoc->meta.title[0] && mdoc->meta.date)                  if (mdoc->meta.title && mdoc->meta.date)
                         break;                          break;
                 return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));                  return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
         case (MDOC_Dt):          case (MDOC_Dt):
                 if (0 == mdoc->meta.title[0] && mdoc->meta.date)                  if (NULL == mdoc->meta.title && mdoc->meta.date)
                         break;                          break;
                 return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));                  return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
         case (MDOC_Dd):          case (MDOC_Dd):
                 if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)                  if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
                         break;                          break;
                 return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));                  return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
Line 221  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 669  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
   
         /* Check for repetition. */          /* Check for repetition. */
   
         switch (node->data.elem.tok) {          switch (n->tok) {
         case (MDOC_Os):          case (MDOC_Os):
                 if (0 == mdoc->meta.os[0])                  if (NULL == mdoc->meta.os)
                         return(1);                          return(1);
                 break;                  break;
         case (MDOC_Dd):          case (MDOC_Dd):
Line 231  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 679  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
                         return(1);                          return(1);
                 break;                  break;
         case (MDOC_Dt):          case (MDOC_Dt):
                 if (0 == mdoc->meta.title[0])                  if (NULL == mdoc->meta.title)
                         return(1);                          return(1);
                 break;                  break;
         default:          default:
Line 239  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 687  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
         return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP));          return(mdoc_nerr(mdoc, n, "prologue repetition"));
 }  }
   
   
 /*  
  * Warn if sections (those that are with a known title, such as NAME,  
  * DESCRIPTION, and so forth) are out of the conventional order.  
  */  
 static int  static int
 post_sh(struct mdoc *mdoc)  post_bf(POST_ARGS)
 {  {
         enum mdoc_sec     sec;          char             *p;
         int               i;          struct mdoc_node *head;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           head = mdoc->last->data.block.head;
   
           if (0 == mdoc->last->data.block.argc) {
                   if (NULL == head->child)
                           return(mdoc_err(mdoc, "argument expected"));
   
                   p = head->child->data.text.string;
                   if (xstrcmp(p, "Em"))
                           return(1);
                   else if (xstrcmp(p, "Li"))
                           return(1);
                   else if (xstrcmp(p, "Sm"))
                           return(1);
                   return(mdoc_nerr(mdoc, head->child, "invalid font"));
           }
   
           if (head->child)
                   return(mdoc_err(mdoc, "argument expected"));
   
           if (1 == mdoc->last->data.block.argc)
                   return(1);
           return(mdoc_err(mdoc, "argument expected"));
   }
   
   
   static int
   post_nm(POST_ARGS)
   {
   
           if (mdoc->last->child)
                   return(1);
           if (mdoc->meta.name)
                   return(1);
           return(mdoc_err(mdoc, "not yet invoked with name"));
   }
   
   
   static int
   post_xr(POST_ARGS)
   {
         struct mdoc_node *n;          struct mdoc_node *n;
         char             *args[MDOC_LINEARG_MAX];  
   
         if (MDOC_HEAD != mdoc->last->type)          if (NULL == (n = mdoc->last->child->next))
                 return(1);                  return(1);
           if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))
                   return(1);
           return(mdoc_nerr(mdoc, n, "invalid manual section"));
   }
   
   
   static int
   post_at(POST_ARGS)
   {
   
           if (NULL == mdoc->last->child)
                   return(1);
           if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
                   return(1);
           return(mdoc_err(mdoc, "require valid symbol"));
   }
   
   
   static int
   post_an(POST_ARGS)
   {
   
           if (0 != mdoc->last->data.elem.argc) {
                   if (NULL == mdoc->last->child)
                           return(1);
                   return(mdoc_err(mdoc, "argument(s) expected"));
           }
   
           if (mdoc->last->child)
                   return(1);
           return(mdoc_err(mdoc, "argument(s) expected"));
   }
   
   
   static int
   post_ex(POST_ARGS)
   {
   
           if (0 == mdoc->last->data.elem.argc) {
                   if (mdoc->last->child)
                           return(1);
                   return(mdoc_err(mdoc, "argument(s) expected"));
           }
           if (mdoc->last->child)
                   return(mdoc_err(mdoc, "argument(s) expected"));
           if (1 != mdoc->last->data.elem.argc)
                   return(mdoc_err(mdoc, "argument(s) expected"));
           if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
                   return(mdoc_err(mdoc, "argument(s) expected"));
   
           return(1);
   }
   
   
   static int
   post_it(POST_ARGS)
   {
           int               type, sv, i;
   #define TYPE_NONE        (0)
   #define TYPE_BODY        (1)
   #define TYPE_HEAD        (2)
   #define TYPE_OHEAD       (3)
           size_t            argc;
           struct mdoc_node *n;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           n = mdoc->last->parent->parent;
   
           argc = n->data.block.argc;
           type = TYPE_NONE;
           sv = -1;
   
         assert(MDOC_Sh == mdoc->last->data.head.tok);          /* Some types require block-head, some not. */
   
         n = mdoc->last->child;          /* LINTED */
         assert(n);          for (i = 0; TYPE_NONE == type && i < (int)argc; i++)
                   switch (n->data.block.argv[i].arg) {
                   case (MDOC_Tag):
                           /* FALLTHROUGH */
                   case (MDOC_Diag):
                           /* FALLTHROUGH */
                   case (MDOC_Hang):
                           /* FALLTHROUGH */
                   case (MDOC_Ohang):
                           /* FALLTHROUGH */
                   case (MDOC_Inset):
                           type = TYPE_HEAD;
                           sv = n->data.block.argv[i].arg;
                           break;
                   case (MDOC_Bullet):
                           /* FALLTHROUGH */
                   case (MDOC_Dash):
                           /* FALLTHROUGH */
                   case (MDOC_Enum):
                           /* FALLTHROUGH */
                   case (MDOC_Hyphen):
                           /* FALLTHROUGH */
                   case (MDOC_Item):
                           type = TYPE_BODY;
                           sv = n->data.block.argv[i].arg;
                           break;
                   case (MDOC_Column):
                           type = TYPE_OHEAD;
                           sv = n->data.block.argv[i].arg;
                           break;
                   default:
                           break;
                   }
   
         for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {          assert(TYPE_NONE != type);
                 assert(MDOC_TEXT == n->type);  
                 assert(NULL == n->child);          n = mdoc->last->data.block.head;
                 assert(n->data.text.string);  
                 args[i] = n->data.text.string;          if (TYPE_HEAD == type) {
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "argument(s) suggested"))
                                   return(0);
   
                   n = mdoc->last->data.block.body;
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "multiline body suggested"))
                                   return(0);
   
           } else if (TYPE_BODY == type) {
                   if (n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "no argument suggested"))
                                   return(0);
   
                   n = mdoc->last->data.block.body;
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "multiline body suggested"))
                                   return(0);
           } else {
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "argument(s) suggested"))
                                   return(0);
   
                   n = mdoc->last->data.block.body;
                   if (n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "no multiline body suggested"))
                                   return(0);
         }          }
   
         sec = mdoc_atosec((size_t)i, (const char **)args);          if (MDOC_Column != sv)
         if (SEC_CUSTOM == sec)  
                 return(1);                  return(1);
         if (sec > mdoc->sec_lastn)  
           argc = mdoc->last->parent->parent->data.block.argv->sz;
           n = mdoc->last->data.block.head->child;
   
           for (i = 0; n; n = n->next)
                   i++;
   
           if (i == (int)argc)
                 return(1);                  return(1);
   
         if (sec == mdoc->sec_lastn)          return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));
                 return(mdoc_warn(mdoc, WARN_SEC_REP));  #undef  TYPE_NONE
         return(mdoc_warn(mdoc, WARN_SEC_OO));  #undef  TYPE_BODY
   #undef  TYPE_HEAD
   #undef  TYPE_OHEAD
 }  }
   
   
 int  static int
 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)  post_bl(POST_ARGS)
 {  {
         int              t;          struct mdoc_node        *n;
   
         switch (node->type) {          if (MDOC_BODY != mdoc->last->type)
         case (MDOC_BODY):                  return(1);
                 t = node->data.body.tok;  
           /* LINTED */
           for (n = mdoc->last->child; n; n = n->next) {
                   if (MDOC_BLOCK == n->type)
                           if (MDOC_It == n->tok)
                                   continue;
                 break;                  break;
         case (MDOC_ELEM):          }
                 t = node->data.elem.tok;  
           if (NULL == n)
                   return(1);
   
           return(mdoc_nerr(mdoc, n, "bad child of parent list"));
   }
   
   
   static int
   ebool(struct mdoc *mdoc)
   {
           struct mdoc_node *n;
   
           /* LINTED */
           for (n = mdoc->last->child; n; n = n->next) {
                   if (MDOC_TEXT != n->type)
                           break;
                   if (xstrcmp(n->data.text.string, "on"))
                           continue;
                   if (xstrcmp(n->data.text.string, "off"))
                           continue;
                 break;                  break;
         case (MDOC_BLOCK):          }
                 t = node->data.block.tok;  
                 break;          if (NULL == n)
         case (MDOC_HEAD):  
                 t = node->data.head.tok;  
                 break;  
         default:  
                 return(1);                  return(1);
           return(mdoc_nerr(mdoc, n, "expected boolean"));
   }
   
   
   static int
   post_root(POST_ARGS)
   {
   
           if (NULL == mdoc->first->child)
                   return(mdoc_err(mdoc, "document lacks data"));
           if (SEC_PROLOGUE == mdoc->lastnamed)
                   return(mdoc_err(mdoc, "document lacks prologue"));
   
           if (MDOC_BLOCK != mdoc->first->child->type)
                   return(mdoc_err(mdoc, "lacking post-prologue %s",
                                           mdoc_macronames[MDOC_Sh]));
           if (MDOC_Sh != mdoc->first->child->tok)
                   return(mdoc_err(mdoc, "lacking post-prologue %s",
                                           mdoc_macronames[MDOC_Sh]));
   
           return(1);
   }
   
   
   static int
   post_sh(POST_ARGS)
   {
   
           if (MDOC_HEAD == mdoc->last->type)
                   return(post_sh_head(mdoc));
           if (MDOC_BODY == mdoc->last->type)
                   return(post_sh_body(mdoc));
   
           return(1);
   }
   
   
   static int
   post_sh_body(POST_ARGS)
   {
           struct mdoc_node *n;
   
           if (SEC_NAME != mdoc->lastnamed)
                   return(1);
   
           /*
            * Warn if the NAME section doesn't contain the `Nm' and `Nd'
            * macros (can have multiple `Nm' and one `Nd').  Note that the
            * children of the BODY declaration can also be "text".
            */
   
           if (NULL == (n = mdoc->last->child))
                   return(mdoc_warn(mdoc, WARN_SYNTAX,
                                           "section should have %s and %s",
                                           mdoc_macronames[MDOC_Nm],
                                           mdoc_macronames[MDOC_Nd]));
   
           for ( ; n && n->next; n = n->next) {
                   if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
                           continue;
                   if (MDOC_TEXT == n->type)
                           continue;
                   if ( ! (mdoc_nwarn(mdoc, n, WARN_SYNTAX,
                                           "section should have %s first",
                                           mdoc_macronames[MDOC_Nm])))
                           return(0);
         }          }
   
         if (NULL == mdoc_valids[t].pre)          if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
                 return(1);                  return(1);
         return((*mdoc_valids[t].pre)(mdoc, node));  
           return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section should have %s last",
                                   mdoc_macronames[MDOC_Nd]));
 }  }
   
   
   static int
   post_sh_head(POST_ARGS)
   {
           char              buf[64];
           enum mdoc_sec     sec;
   
           assert(MDOC_Sh == mdoc->last->tok);
   
           if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf)))
                   return(mdoc_err(mdoc, "argument too long"));
   
           sec = mdoc_atosec(buf);
   
           if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
                   return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section NAME should be first"));
           if (SEC_CUSTOM == sec)
                   return(1);
           if (sec == mdoc->lastnamed)
                   return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section repeated"));
           if (sec < mdoc->lastnamed)
                   return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section out of order"));
   
           return(1);
   }
   
   
 int  int
   mdoc_valid_pre(struct mdoc *mdoc,
                   const struct mdoc_node *node)
   {
           v_pre           *p;
           struct mdoc_arg *argv;
           size_t           argc, i, j, line, pos;
           const char      *tp;
   
           if (MDOC_TEXT == node->type) {
                   tp = node->data.text.string;
                   line = node->line;
                   pos = node->pos;
                   return(check_text(mdoc, line, pos, tp));
           }
   
           if (MDOC_BLOCK == node->type || MDOC_ELEM == node->type) {
                   argv = MDOC_BLOCK == node->type ?
                           node->data.block.argv :
                           node->data.elem.argv;
                   argc = MDOC_BLOCK == node->type ?
                           node->data.block.argc :
                           node->data.elem.argc;
   
                   for (i = 0; i < argc; i++) {
                           if (0 == argv[i].sz)
                                   continue;
                           for (j = 0; j < argv[i].sz; j++) {
                                   tp = argv[i].value[j];
                                   line = argv[i].line;
                                   pos = argv[i].pos;
                                   if ( ! check_text(mdoc, line, pos, tp))
                                           return(0);
                           }
                   }
           }
   
           if (NULL == mdoc_valids[node->tok].pre)
                   return(1);
           for (p = mdoc_valids[node->tok].pre; *p; p++)
                   if ( ! (*p)(mdoc, node))
                           return(0);
           return(1);
   }
   
   
   int
 mdoc_valid_post(struct mdoc *mdoc)  mdoc_valid_post(struct mdoc *mdoc)
 {  {
         v_post          *p;          v_post          *p;
         int              t;  
   
         switch (mdoc->last->type) {          /*
         case (MDOC_BODY):           * This check occurs after the macro's children have been filled
                 t = mdoc->last->data.body.tok;           * in: postfix validation.  Since this happens when we're
                 break;           * rewinding the scope tree, it's possible to have multiple
         case (MDOC_ELEM):           * invocations (as by design, for now), we set bit MDOC_VALID to
                 t = mdoc->last->data.elem.tok;           * indicate that we've validated.
                 break;           */
         case (MDOC_BLOCK):  
                 t = mdoc->last->data.block.tok;          if (MDOC_VALID & mdoc->last->flags)
                 break;  
         case (MDOC_HEAD):  
                 t = mdoc->last->data.head.tok;  
                 break;  
         default:  
                 return(1);                  return(1);
         }          mdoc->last->flags |= MDOC_VALID;
   
         if (NULL == mdoc_valids[t].post)          if (MDOC_TEXT == mdoc->last->type)
                 return(1);                  return(1);
           if (MDOC_ROOT == mdoc->last->type)
                   return(post_root(mdoc));
   
         for (p = mdoc_valids[t].post; *p; p++)          if (NULL == mdoc_valids[mdoc->last->tok].post)
                   return(1);
           for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
                 if ( ! (*p)(mdoc))                  if ( ! (*p)(mdoc))
                         return(0);                          return(0);
   
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.55
CVSweb