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

Diff for /mandoc/Attic/validate.c between version 1.36 and 1.54

version 1.36, 2009/01/17 16:15:27 version 1.54, 2009/02/24 11:43:13
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 *);  typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);
 typedef int     (*v_post)(struct mdoc *);  typedef int     (*v_post)(struct mdoc *);
   
   
 /* FIXME: some sections should only occur in specific msecs. */  /* FIXME: some sections should only occur in specific msecs. */
 /* FIXME: ignoring Pp. */  /* FIXME: ignoring Pp. */
 /* FIXME: math symbols. */  /* 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;
 };  };
   
 static  int     pre_check_parent(struct mdoc *, struct mdoc_node *,  /* Utility checks. */
   
   static  int     check_parent(struct mdoc *, struct mdoc_node *,
                         int, enum mdoc_type);                          int, enum mdoc_type);
 static  int     pre_check_msecs(struct mdoc *, struct mdoc_node *,  static  int     check_msec(struct mdoc *, struct mdoc_node *,
                         int, enum mdoc_msec *);                          int, enum mdoc_msec *);
 static  int     pre_check_stdarg(struct mdoc *, struct mdoc_node *);  static  int     check_stdarg(struct mdoc *, struct mdoc_node *);
 static  int     post_check_children_count(struct mdoc *);  static  int     err_child_lt(struct mdoc *, const char *, int);
 static  int     post_check_children_lt(struct mdoc *, int);  static  int     err_child_gt(struct mdoc *, const char *, int);
 static  int     post_check_children_gt(struct mdoc *, int);  static  int     warn_child_gt(struct mdoc *, const char *, int);
 static  int     post_check_children_eq(struct mdoc *, 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(struct mdoc *, struct mdoc_node *);  static  int     pre_display(struct mdoc *, struct mdoc_node *);
 static  int     pre_sh(struct mdoc *, struct mdoc_node *);  static  int     pre_sh(struct mdoc *, struct mdoc_node *);
 static  int     pre_ss(struct mdoc *, struct mdoc_node *);  static  int     pre_ss(struct mdoc *, struct mdoc_node *);
Line 61  static int pre_prologue(struct mdoc *, struct mdoc_nod
Line 81  static int pre_prologue(struct mdoc *, struct mdoc_nod
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     pre_prologue(struct mdoc *, struct mdoc_node *);
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     pre_prologue(struct mdoc *, struct mdoc_node *);
   
 static  int     head_err_ge1(struct mdoc *);  /* Specific post-child-parse routines. */
 static  int     head_warn_ge1(struct mdoc *);  
 static  int     head_err_eq0(struct mdoc *);  static  int     herr_ge1(struct mdoc *);
 static  int     elem_err_eq0(struct mdoc *);  static  int     herr_le1(struct mdoc *);
 static  int     elem_err_le1(struct mdoc *);  static  int     herr_eq0(struct mdoc *);
 static  int     elem_err_le2(struct mdoc *);  static  int     eerr_eq0(struct mdoc *);
 static  int     elem_err_eq1(struct mdoc *);  static  int     eerr_le1(struct mdoc *);
 static  int     elem_err_ge1(struct mdoc *);  static  int     eerr_le2(struct mdoc *);
 static  int     elem_warn_eq0(struct mdoc *);  static  int     eerr_eq1(struct mdoc *);
 static  int     body_warn_ge1(struct mdoc *);  static  int     eerr_ge1(struct mdoc *);
 static  int     body_err_eq0(struct mdoc *);  static  int     ewarn_eq0(struct mdoc *);
 static  int     elem_warn_ge1(struct mdoc *);  static  int     ewarn_eq1(struct mdoc *);
 static  int     elem_bool(struct mdoc *);  static  int     bwarn_ge1(struct mdoc *);
   static  int     ewarn_ge1(struct mdoc *);
   static  int     ebool(struct mdoc *);
 static  int     post_sh(struct mdoc *);  static  int     post_sh(struct mdoc *);
   static  int     post_sh_body(struct mdoc *);
   static  int     post_sh_head(struct mdoc *);
 static  int     post_bl(struct mdoc *);  static  int     post_bl(struct mdoc *);
 static  int     post_it(struct mdoc *);  static  int     post_it(struct mdoc *);
 static  int     post_ex(struct mdoc *);  static  int     post_ex(struct mdoc *);
 static  int     post_an(struct mdoc *);  static  int     post_an(struct mdoc *);
 static  int     post_at(struct mdoc *);  static  int     post_at(struct mdoc *);
 static  int     post_xr(struct mdoc *);  static  int     post_xr(struct mdoc *);
   static  int     post_nm(struct mdoc *);
   static  int     post_bf(struct mdoc *);
   static  int     post_root(struct mdoc *);
   static  int     pre_text(struct mdoc *, const struct mdoc_node *);
   
   /* Collections of pre-child-parse routines. */
   
 static  v_pre   pres_prologue[] = { pre_prologue, NULL };  static  v_pre   pres_prologue[] = { pre_prologue, NULL };
 static  v_pre   pres_d1[] = { pre_display, NULL };  static  v_pre   pres_d1[] = { pre_display, NULL };
 static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };  static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
Line 96  static v_pre pres_rv[] = { pre_rv, NULL };
Line 126  static v_pre pres_rv[] = { pre_rv, NULL };
 static  v_pre   pres_an[] = { pre_an, NULL };  static  v_pre   pres_an[] = { pre_an, NULL };
 static  v_pre   pres_st[] = { pre_st, NULL };  static  v_pre   pres_st[] = { pre_st, NULL };
   
 static  v_post  posts_bool[] = { elem_err_eq1, elem_bool, NULL };  /* Collections of post-child-parse routines. */
 static  v_post  posts_bd[] = { head_err_eq0, body_warn_ge1, NULL };  
 static  v_post  posts_text[] = { elem_err_ge1, NULL };  static  v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
 static  v_post  posts_wtext[] = { elem_warn_ge1, NULL };  static  v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
 static  v_post  posts_notext[] = { elem_err_eq0, NULL };  static  v_post  posts_text[] = { eerr_ge1, NULL };
 static  v_post  posts_wline[] = { head_warn_ge1, body_err_eq0, NULL };  static  v_post  posts_wtext[] = { ewarn_ge1, NULL };
 static  v_post  posts_sh[] = { head_err_ge1,  static  v_post  posts_notext[] = { eerr_eq0, NULL };
                         body_warn_ge1, post_sh, NULL };  static  v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
 static  v_post  posts_bl[] = { head_err_eq0,  static  v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
                         body_warn_ge1, post_bl, 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_it[] = { post_it, NULL };
 static  v_post  posts_ss[] = { head_err_ge1, NULL };  static  v_post  posts_in[] = { ewarn_eq1, NULL };
 static  v_post  posts_pp[] = { elem_warn_eq0, NULL };  static  v_post  posts_ss[] = { herr_ge1, NULL };
 static  v_post  posts_d1[] = { head_err_ge1, NULL };  static  v_post  posts_pf[] = { eerr_eq1, NULL };
 static  v_post  posts_ex[] = { elem_err_le1, post_ex, 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_an[] = { post_an, NULL };
 static  v_post  posts_at[] = { elem_err_eq1, post_at, NULL };  static  v_post  posts_at[] = { post_at, NULL };
 static  v_post  posts_xr[] = { elem_err_ge1, elem_err_le2,  static  v_post  posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
                         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 },                         /* \" */
         { pres_prologue, posts_text }, /* Dd */          { pres_prologue, posts_text },          /* Dd */
         { pres_prologue, NULL }, /* Dt */          { pres_prologue, NULL },                /* Dt */
         { pres_prologue, NULL }, /* Os */          { pres_prologue, NULL },                /* Os */
         /* FIXME: NAME section internal ordering. */          { pres_sh, posts_sh },                  /* Sh */
         { pres_sh, posts_sh }, /* Sh */          { pres_ss, posts_ss },                  /* Ss */
         { pres_ss, posts_ss }, /* Ss */          { NULL, posts_pp },                     /* Pp */
         { NULL, posts_pp }, /* Pp */          { pres_d1, posts_wline },               /* D1 */
         { pres_d1, posts_d1 }, /* D1 */          { pres_d1, posts_wline },               /* Dl */
         { pres_d1, posts_d1 }, /* Dl */          { pres_bd, posts_bd },                  /* Bd */
         { pres_bd, posts_bd }, /* Bd */          { NULL, NULL },                         /* Ed */
         { NULL, NULL }, /* Ed */          { pres_bl, posts_bl },                  /* Bl */
         { pres_bl, posts_bl }, /* Bl */          { NULL, NULL },                         /* El */
         { NULL, NULL }, /* El */          { pres_it, posts_it },                  /* It */
         { pres_it, posts_it }, /* It */          { NULL, posts_text },                   /* Ad */
         { NULL, posts_text }, /* Ad */          { pres_an, posts_an },                  /* An */
         { pres_an, posts_an }, /* An */          { NULL, NULL },                         /* Ar */
         { NULL, NULL }, /* Ar */          { pres_cd, posts_text },                /* Cd */
         { pres_cd, posts_text }, /* Cd */          { NULL, NULL },                         /* Cm */
         { NULL, NULL }, /* Cm */          { NULL, posts_text },                   /* Dv */
         { NULL, posts_text }, /* Dv */          { pres_er, posts_text },                /* Er */
         { pres_er, posts_text }, /* Er */          { NULL, posts_text },                   /* Ev */
         { NULL, posts_text }, /* Ev */          { pres_ex, posts_ex },                  /* Ex */
         { pres_ex, posts_ex }, /* Ex */          { NULL, posts_text },                   /* Fa */
         { NULL, posts_text }, /* Fa */          { NULL, posts_wtext },                  /* Fd */
         /* FIXME: only in SYNOPSIS section. */          { NULL, NULL },                         /* Fl */
         { NULL, NULL }, /* Fd */          { NULL, posts_text },                   /* Fn */
         { NULL, NULL }, /* Fl */          { NULL, posts_wtext },                  /* Ft */
         { NULL, posts_text }, /* Fn */          { NULL, posts_text },                   /* Ic */
         { NULL, NULL }, /* Ft */          { NULL, posts_in },                     /* In */
         { NULL, posts_text }, /* Ic */          { NULL, posts_text },                   /* Li */
         { NULL, posts_wtext }, /* In */          { NULL, posts_wtext },                  /* Nd */
         { NULL, posts_text }, /* Li */          { NULL, posts_nm },                     /* Nm */
         { NULL, posts_wtext }, /* Nd */          { NULL, posts_wline },                  /* Op */
         /* FIXME: check that name must be set/provided. */          { NULL, NULL },                         /* Ot */
         { NULL, NULL }, /* Nm */          { NULL, NULL },                         /* Pa */
         { NULL, posts_wline }, /* Op */          { pres_rv, posts_notext },              /* Rv */
         { NULL, NULL }, /* Ot */          { pres_st, posts_notext },              /* St */
         { NULL, NULL }, /* Pa */          { NULL, posts_text },                   /* Va */
         { pres_rv, posts_notext }, /* Rv */          { NULL, posts_text },                   /* Vt */
         { pres_st, posts_notext }, /* St */          { NULL, posts_xr },                     /* Xr */
         { NULL, posts_text }, /* Va */          { NULL, posts_text },                   /* %A */
         { NULL, posts_text }, /* Vt */          { NULL, posts_text },                   /* %B */
         { NULL, posts_xr }, /* Xr */          { NULL, posts_text },                   /* %D */
         { NULL, posts_text }, /* %A */          { NULL, posts_text },                   /* %I */
         { NULL, posts_text }, /* %B */          { NULL, posts_text },                   /* %J */
         { NULL, posts_text }, /* %D */          { NULL, posts_text },                   /* %N */
         { NULL, posts_text }, /* %I */          { NULL, posts_text },                   /* %O */
         { NULL, posts_text }, /* %J */          { NULL, posts_text },                   /* %P */
         { NULL, posts_text }, /* %N */          { NULL, posts_text },                   /* %R */
         { NULL, posts_text }, /* %O */          { NULL, posts_text },                   /* %T */
         { NULL, posts_text }, /* %P */          { NULL, posts_text },                   /* %V */
         { NULL, posts_text }, /* %R */          { NULL, NULL },                         /* Ac */
         { NULL, posts_text }, /* %T */          { NULL, NULL },                         /* Ao */
         { NULL, posts_text }, /* %V */          { NULL, posts_wline },                  /* Aq */
         { NULL, NULL }, /* Ac */          { NULL, posts_at },                     /* At */
         { NULL, NULL }, /* Ao */          { NULL, NULL },                         /* Bc */
         { NULL, posts_wline }, /* Aq */          { NULL, posts_bf },                     /* Bf */
         { NULL, posts_at }, /* At */          { NULL, NULL },                         /* Bo */
         { NULL, NULL }, /* Bc */          { NULL, posts_wline },                  /* Bq */
         { NULL, NULL }, /* Bf */          { NULL, NULL },                         /* Bsx */
         { NULL, NULL }, /* Bo */          { NULL, NULL },                         /* Bx */
         { NULL, posts_wline }, /* Bq */          { NULL, posts_bool },                   /* Db */
         { NULL, NULL }, /* Bsx */          { NULL, NULL },                         /* Dc */
         { NULL, NULL }, /* Bx */          { NULL, NULL },                         /* Do */
         { NULL, posts_bool }, /* Db */          { NULL, posts_wline },                  /* Dq */
         { NULL, NULL }, /* Dc */          { NULL, NULL },                         /* Ec */
         { NULL, NULL }, /* Do */          { NULL, NULL },                         /* Ef */
         { NULL, posts_wline }, /* Dq */          { NULL, posts_text },                   /* Em */
         { NULL, NULL }, /* Ec */          { NULL, NULL },                         /* Eo */
         { NULL, NULL }, /* Ef */ /* -symbolic, etc. */          { NULL, NULL },                         /* Fx */
         { NULL, posts_text }, /* Em */          { NULL, posts_text },                   /* Ms */
         { NULL, NULL }, /* Eo */          { NULL, posts_notext },                 /* No */
         { NULL, NULL }, /* Fx */          { NULL, posts_notext },                 /* Ns */
         { NULL, posts_text }, /* Ms */          { NULL, NULL },                         /* Nx */
         { NULL, posts_notext }, /* No */          { NULL, NULL },                         /* Ox */
         { NULL, posts_notext }, /* Ns */          { NULL, NULL },                         /* Pc */
         { NULL, NULL }, /* Nx */          { NULL, posts_pf },                     /* Pf */
         { NULL, NULL }, /* Ox */          { NULL, NULL },                         /* Po */
         { NULL, NULL }, /* Pc */          { NULL, posts_wline },                  /* Pq */
         { NULL, NULL }, /* Pf */          { NULL, NULL },                         /* Qc */
         { NULL, NULL }, /* Po */          { NULL, posts_wline },                  /* Ql */
         { NULL, posts_wline }, /* Pq */          { NULL, NULL },                         /* Qo */
         { NULL, NULL }, /* Qc */          { NULL, posts_wline },                  /* Qq */
         { NULL, posts_wline }, /* Ql */          { NULL, NULL },                         /* Re */
         { NULL, NULL }, /* Qo */          { NULL, posts_rs },                     /* Rs */
         { NULL, posts_wline }, /* Qq */          { NULL, NULL },                         /* Sc */
         { NULL, NULL }, /* Re */          { NULL, NULL },                         /* So */
         { NULL, NULL }, /* Rs */          { NULL, posts_wline },                  /* Sq */
         { NULL, NULL }, /* Sc */          { NULL, posts_bool },                   /* Sm */
         { NULL, NULL }, /* So */          { NULL, posts_text },                   /* Sx */
         { NULL, posts_wline }, /* Sq */          { NULL, posts_text },                   /* Sy */
         { NULL, posts_bool }, /* Sm */          { NULL, posts_text },                   /* Tn */
         { NULL, posts_text }, /* Sx */          { NULL, NULL },                         /* Ux */
         { NULL, posts_text }, /* Sy */          { NULL, NULL },                         /* Xc */
         { NULL, posts_text }, /* Tn */          { NULL, NULL },                         /* Xo */
         { NULL, NULL }, /* Ux */          { NULL, posts_fo },                     /* Fo */
         { NULL, NULL }, /* Xc */          { NULL, NULL },                         /* Fc */
         { NULL, NULL }, /* Xo */          { NULL, NULL },                         /* Oo */
         { NULL, NULL }, /* Fo */          { NULL, NULL },                         /* Oc */
         { NULL, NULL }, /* Fc */          { NULL, posts_bk },                     /* Bk */
         { NULL, NULL }, /* Oo */          { NULL, NULL },                         /* Ek */
         { NULL, NULL }, /* Oc */          { NULL, posts_notext },                 /* Bt */
         { NULL, NULL }, /* Bk */          { NULL, NULL },                         /* Hf */
         { NULL, NULL }, /* Ek */          { NULL, NULL },                         /* Fr */
         { NULL, posts_notext }, /* Bt */          { NULL, posts_notext },                 /* Ud */
         { NULL, NULL }, /* Hf */  
         { NULL, NULL }, /* Fr */  
         { NULL, posts_notext }, /* Ud */  
 };  };
   
   
 static int  static inline int
 post_check_children_count(struct mdoc *mdoc)  warn_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
 {  {
         struct mdoc_node *n;  
         int               i;  
   
         for (i = 0, n = mdoc->last->child; n; n = n->next, i++)          return(mdoc_warn(m, WARN_SYNTAX, "suggests %s %d %s "
                 /* Do nothing */ ;                                  "(has %d)", v, want, k, has));
         return(i);  
 }  }
   
   
 static int  static inline int
 post_check_children_gt(struct mdoc *mdoc, int sz)  err_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
 {  {
         int               i;  
   
         if ((i = post_check_children_count(mdoc)) > sz)          return(mdoc_err(m, "requires %s %d %s (has %d)",
                 return(1);                                  v, want, k, has));
         return(mdoc_err(mdoc, "macro requires more than %d "  
                                 "parameters (have %d)", sz, i));  
 }  }
   
   
 static int  static inline int
 post_check_children_eq(struct mdoc *mdoc, int sz)  count_child(struct mdoc *mdoc)
 {  {
         int               i;          int               i;
           struct mdoc_node *n;
   
         if ((i = post_check_children_count(mdoc)) == sz)          for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                 return(1);                  /* Do nothing */ ;
         return(mdoc_err(mdoc, "macro requires %d parameters "  
                                 "(have %d)", sz, i));  
 }  
   
           return(i);
 static int  
 post_check_children_lt(struct mdoc *mdoc, int sz)  
 {  
         int               i;  
   
         if ((i = post_check_children_count(mdoc)) < sz)  
                 return(1);  
         return(mdoc_err(mdoc, "macro requires less than %d "  
                                 "parameters (have %d)", sz, i));  
 }  }
   
   
 static int  /*
 pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)   * 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.
    */
   
         if (1 == node->data.elem.argc &&  #define CHECK_CHILD_DEFN(lvl, name, ineq)                       \
                         MDOC_Std == node->data.elem.argv[0].arg)  static int                                                      \
                 return(1);  lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz)    \
         return(mdoc_nwarn(mdoc, node, WARN_COMPAT,  {                                                               \
                                 "macro suggests single `%s' argument",          int i;                                                  \
                                 mdoc_argnames[MDOC_Std]));          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  static int                                                      \
 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node,  b##lvl##_##name(struct mdoc *mdoc)                              \
                 int sz, enum mdoc_msec *msecs)  {                                                               \
 {          if (MDOC_BODY != mdoc->last->type)                      \
         int              i;                  return(1);                                      \
           return(func(mdoc, "multiline parameters", (num)));      \
         for (i = 0; i < sz; i++)  
                 if (msecs[i] == mdoc->meta.msec)  
                         return(1);  
         return(mdoc_nwarn(mdoc, node, WARN_COMPAT,  
                                 "macro is not appropriate for this manual section"));  
 }  }
   
   #define CHECK_ELEM_DEFN(name, lvl, func, num)                   \
 static int  static int                                                      \
 pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,  e##lvl##_##name(struct mdoc *mdoc)                              \
                 int tok, enum mdoc_type type)  {                                                               \
 {          assert(MDOC_ELEM == mdoc->last->type);                  \
           return(func(mdoc, "line parameters", (num)));           \
         if (type != node->parent->type)  
                 return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s",  
                                         mdoc_type2a(node->parent->type),  
                                         mdoc_type2a(type)));  
         if (MDOC_ROOT != type && tok != node->parent->tok)  
                 return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'",  
                                         mdoc_macronames[node->parent->tok],  
                                         mdoc_macronames[tok]));  
         return(1);  
 }  }
   
   #define CHECK_HEAD_DEFN(name, lvl, func, num)                   \
 static int  static int                                                      \
 body_err_eq0(struct mdoc *mdoc)  h##lvl##_##name(struct mdoc *mdoc)                              \
 {  {                                                               \
           if (MDOC_HEAD != mdoc->last->type)                      \
         if (MDOC_BODY != mdoc->last->type)                  return(1);                                      \
                 return(1);          return(func(mdoc, "multiline parameters", (num)));      \
         if (NULL == mdoc->last->child)  
                 return(1);  
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));  
 }  }
   
   
 static int  CHECK_CHILD_DEFN(warn, gt, >)                   /* warn_child_gt() */
 body_warn_ge1(struct mdoc *mdoc)  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() */
   
         if (MDOC_BODY != mdoc->last->type)  
                 return(1);  
         if (mdoc->last->child)  
                 return(1);  
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));  
 }  
   
   
 static int  static int
 elem_warn_eq0(struct mdoc *mdoc)  check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          if (MDOC_Std == node->data.elem.argv[0].arg &&
         if (NULL == mdoc->last->child)                          1 == node->data.elem.argc)
                 return(1);                  return(1);
         return(mdoc_pwarn(mdoc, mdoc->last->child->line,  
                         mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));  
 }  
   
           return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
 static int                                  "one argument suggested"));
 elem_warn_ge1(struct mdoc *mdoc)  
 {  
   
         assert(MDOC_ELEM == mdoc->last->type);  
         if (mdoc->last->child)  
                 return(1);  
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));  
 }  }
   
   
 static int  static int
 elem_err_eq1(struct mdoc *mdoc)  check_msec(struct mdoc *mdoc, struct mdoc_node *node,
                   int sz, enum mdoc_msec *msecs)
 {  {
           int              i;
   
         assert(MDOC_ELEM == mdoc->last->type);          for (i = 0; i < sz; i++)
         return(post_check_children_eq(mdoc, 1));                  if (msecs[i] == mdoc->meta.msec)
                           return(1);
           return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
                                   "wrong manual section"));
 }  }
   
   
 static int  static int
 elem_err_le2(struct mdoc *mdoc)  check_parent(struct mdoc *mdoc, struct mdoc_node *n,
                   int tok, enum mdoc_type t)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(n->parent);
         return(post_check_children_lt(mdoc, 3));          if ((MDOC_ROOT == t || tok == n->parent->tok) &&
 }                          (t == n->parent->type))
   
   
 static int  
 elem_err_le1(struct mdoc *mdoc)  
 {  
   
         assert(MDOC_ELEM == mdoc->last->type);  
         return(post_check_children_lt(mdoc, 2));  
 }  
   
   
 static int  
 elem_err_eq0(struct mdoc *mdoc)  
 {  
   
         assert(MDOC_ELEM == mdoc->last->type);  
         return(post_check_children_eq(mdoc, 0));  
 }  
   
   
 static int  
 elem_err_ge1(struct mdoc *mdoc)  
 {  
   
         assert(MDOC_ELEM == mdoc->last->type);  
         return(post_check_children_gt(mdoc, 0));  
 }  
   
   
 static int  
 head_err_eq0(struct mdoc *mdoc)  
 {  
   
         if (MDOC_HEAD != mdoc->last->type)  
                 return(1);                  return(1);
         return(post_check_children_eq(mdoc, 0));  
 }  
   
           return(mdoc_nerr(mdoc, n, "require parent %s",
 static int                  MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
 head_warn_ge1(struct mdoc *mdoc)  
 {  
   
         if (MDOC_HEAD != mdoc->last->type)  
                 return(1);  
         if (mdoc->last->child)  
                 return(1);  
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));  
 }  }
   
   
 static int  
 head_err_ge1(struct mdoc *mdoc)  
 {  
   
         if (MDOC_HEAD != mdoc->last->type)  
                 return(1);  
         return(post_check_children_gt(mdoc, 0));  
 }  
   
   
 static int  static int
 pre_display(struct mdoc *mdoc, struct mdoc_node *node)  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
   
           /* Display elements (`Bd', `D1'...) cannot be nested. */
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != node->type)
                 return(1);                  return(1);
   
         assert(mdoc->last);          /* LINTED */
         for (n = mdoc->last->parent; n; n = n->parent)          for (n = mdoc->last->parent; n; n = n->parent)
                 if (MDOC_BLOCK == n->type)                  if (MDOC_BLOCK == n->type)
                         if (MDOC_Bd == n->tok)                          if (MDOC_Bd == n->tok)
                                 break;                                  break;
         if (NULL == n)          if (NULL == n)
                 return(1);                  return(1);
   
         return(mdoc_nerr(mdoc, node, "displays may not be nested"));          return(mdoc_nerr(mdoc, node, "displays may not be nested"));
 }  }
   
Line 468  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
Line 426  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 static int  static int
 pre_bl(struct mdoc *mdoc, struct mdoc_node *node)  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int              type, err;          int              type, err, i;
         struct mdoc_arg *argv;          struct mdoc_arg *argv;
         size_t           i, argc;          size_t           argc;
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != node->type)
                 return(1);                  return(1);
         assert(MDOC_Bl == node->tok);  
   
         argv = NULL;  
         argc = node->data.block.argc;          argc = node->data.block.argc;
   
         for (i = type = err = 0; i < argc; i++) {          /* Make sure that only one type of list is specified.  */
                 argv = &node->data.block.argv[(int)i];  
                 assert(argv);          /* LINTED */
           for (i = 0, type = err = 0; i < (int)argc; i++) {
                   argv = &node->data.block.argv[i];
   
                 switch (argv->arg) {                  switch (argv->arg) {
                 case (MDOC_Bullet):                  case (MDOC_Bullet):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
Line 504  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
Line 463  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
                 case (MDOC_Inset):                  case (MDOC_Inset):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Column):                  case (MDOC_Column):
                         if (type)                          if (0 == type++)
                                 err++;                                  break;
                         type++;                          return(mdoc_perr(mdoc, argv->line, argv->pos,
                         break;                                          "multiple types specified"));
                 default:                  default:
                         break;                          break;
                 }                  }
         }          }
         if (0 == type)  
                 return(mdoc_err(mdoc, "no list type specified"));          if (type)
         if (0 == err)  
                 return(1);                  return(1);
         assert(argv);          return(mdoc_err(mdoc, "no type specified"));
         return(mdoc_perr(mdoc, argv->line,  
                         argv->pos, "only one list type possible"));  
 }  }
   
   
 static int  static int
 pre_bd(struct mdoc *mdoc, struct mdoc_node *node)  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int              type, err;          int              type, err, i;
         struct mdoc_arg *argv;          struct mdoc_arg *argv;
         size_t           i, argc;          size_t           argc;
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != node->type)
                 return(1);                  return(1);
         assert(MDOC_Bd == node->tok);  
   
         argv = NULL;  
         argc = node->data.block.argc;          argc = node->data.block.argc;
   
         for (err = i = type = 0; 0 == err && i < argc; i++) {          /* Make sure that only one type of display is specified.  */
                 argv = &node->data.block.argv[(int)i];  
                 assert(argv);          /* LINTED */
           for (i = 0, err = type = 0; ! err && i < (int)argc; i++) {
                   argv = &node->data.block.argv[i];
   
                 switch (argv->arg) {                  switch (argv->arg) {
                 case (MDOC_Ragged):                  case (MDOC_Ragged):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
Line 549  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
Line 506  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
                 case (MDOC_Literal):                  case (MDOC_Literal):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_File):                  case (MDOC_File):
                         if (type)                          if (0 == type++)
                                 err++;                                  break;
                         type++;                          return(mdoc_perr(mdoc, argv->line, argv->pos,
                         break;                                          "multiple types specified"));
                 default:                  default:
                         break;                          break;
                 }                  }
         }          }
         if (0 == type)  
                 return(mdoc_err(mdoc, "no display type specified"));          if (type)
         if (0 == err)  
                 return(1);                  return(1);
         assert(argv);          return(mdoc_err(mdoc, "no type specified"));
         return(mdoc_perr(mdoc, argv->line,  
                         argv->pos, "only one display type possible"));  
 }  }
   
   
Line 573  pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
Line 527  pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != node->type)
                 return(1);                  return(1);
         return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));          return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
 }  }
   
   
Line 583  pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
Line 537  pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != node->type)
                 return(1);                  return(1);
         return(pre_check_parent(mdoc, node, -1, MDOC_ROOT));          return(check_parent(mdoc, node, -1, MDOC_ROOT));
 }  }
   
   
 static int  static int
   pre_it(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
           /* TODO: -width attribute must be specified for -tag. */
           /* TODO: children too big for -width? */
   
           if (MDOC_BLOCK != node->type)
                   return(1);
           return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));
   }
   
   
   static int
 pre_st(struct mdoc *mdoc, struct mdoc_node *node)  pre_st(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         assert(MDOC_ELEM == node->type);  
         assert(MDOC_St == node->tok);  
         if (1 == node->data.elem.argc)          if (1 == node->data.elem.argc)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, node, "macro must have one argument"));          return(mdoc_nerr(mdoc, node, "one argument required"));
 }  }
   
   
Line 603  static int
Line 568  static int
 pre_an(struct mdoc *mdoc, struct mdoc_node *node)  pre_an(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         assert(MDOC_ELEM == node->type);  
         assert(MDOC_An == node->tok);  
         if (1 >= node->data.elem.argc)          if (1 >= node->data.elem.argc)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, node, "macro may only have one argument"));          return(mdoc_nerr(mdoc, node, "one argument allowed"));
 }  }
   
   
 static int  static int
 pre_rv(struct mdoc *mdoc, struct mdoc_node *node)  pre_rv(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         enum mdoc_msec   msecs[2];          enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };
   
         assert(MDOC_ELEM == node->type);          if ( ! check_msec(mdoc, node, 2, msecs))
         assert(MDOC_Rv == node->tok);  
   
         msecs[0] = MSEC_2;  
         msecs[1] = MSEC_3;  
         if ( ! pre_check_msecs(mdoc, node, 2, msecs))  
                 return(0);                  return(0);
         return(pre_check_stdarg(mdoc, node));          return(check_stdarg(mdoc, node));
 }  }
   
   
 static int  static int
 pre_ex(struct mdoc *mdoc, struct mdoc_node *node)  pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         enum mdoc_msec   msecs[3];          enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };
   
         assert(MDOC_ELEM == node->type);          if ( ! check_msec(mdoc, node, 3, msecs))
         assert(MDOC_Ex == node->tok);  
   
         msecs[0] = MSEC_1;  
         msecs[1] = MSEC_6;  
         msecs[2] = MSEC_8;  
         if ( ! pre_check_msecs(mdoc, node, 3, msecs))  
                 return(0);                  return(0);
         return(pre_check_stdarg(mdoc, node));          return(check_stdarg(mdoc, node));
 }  }
   
   
 static int  static int
 pre_er(struct mdoc *mdoc, struct mdoc_node *node)  pre_er(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         enum mdoc_msec   msecs[1];          enum mdoc_msec msecs[] = { MSEC_2 };
   
         msecs[0] = MSEC_2;          return(check_msec(mdoc, node, 1, msecs));
         return(pre_check_msecs(mdoc, node, 1, msecs));  
 }  }
   
   
 static int  static int
 pre_cd(struct mdoc *mdoc, struct mdoc_node *node)  pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         enum mdoc_msec   msecs[1];          enum mdoc_msec msecs[] = { MSEC_4 };
   
         msecs[0] = MSEC_4;          return(check_msec(mdoc, node, 1, msecs));
         return(pre_check_msecs(mdoc, node, 1, msecs));  
 }  }
   
   
 static int  static int
 pre_it(struct mdoc *mdoc, struct mdoc_node *node)  
 {  
   
         if (MDOC_BLOCK != node->type)  
                 return(1);  
         return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));  
 }  
   
   
 static int  
 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          if (SEC_PROLOGUE != mdoc->lastnamed)
                 return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));                  return(mdoc_nerr(mdoc, node, "prologue only"));
         assert(MDOC_ELEM == node->type);  
   
         /* Check for ordering. */          /* Check for ordering. */
   
Line 688  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 627  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
         case (MDOC_Os):          case (MDOC_Os):
                 if (mdoc->meta.title && mdoc->meta.date)                  if (mdoc->meta.title && mdoc->meta.date)
                         break;                          break;
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));                  return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
         case (MDOC_Dt):          case (MDOC_Dt):
                 if (NULL == mdoc->meta.title && mdoc->meta.date)                  if (NULL == mdoc->meta.title && mdoc->meta.date)
                         break;                          break;
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));                  return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
         case (MDOC_Dd):          case (MDOC_Dd):
                 if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)                  if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
                         break;                          break;
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));                  return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
         default:          default:
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
Line 722  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 664  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
         return(mdoc_nerr(mdoc, node, "prologue macro repeated"));          return(mdoc_nerr(mdoc, node, "prologue repetition"));
 }  }
   
   
 static int  static int
   post_bf(struct mdoc *mdoc)
   {
           char             *p;
           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(struct mdoc *mdoc)
   {
   
           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(struct mdoc *mdoc)  post_xr(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
   
         assert(MDOC_ELEM == mdoc->last->type);  
         assert(MDOC_Xr == mdoc->last->tok);  
         assert(mdoc->last->child);  
         assert(MDOC_TEXT == mdoc->last->child->type);  
   
         if (NULL == (n = mdoc->last->child->next))          if (NULL == (n = mdoc->last->child->next))
                 return(1);                  return(1);
         assert(MDOC_TEXT == n->type);  
         if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))          if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, n, "invalid manual section"));          return(mdoc_nerr(mdoc, n, "invalid manual section"));
Line 749  static int
Line 731  static int
 post_at(struct mdoc *mdoc)  post_at(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          if (NULL == mdoc->last->child)
         assert(MDOC_At == mdoc->last->tok);                  return(1);
         assert(mdoc->last->child);  
         assert(MDOC_TEXT == mdoc->last->child->type);  
   
         if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))          if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol"));          return(mdoc_err(mdoc, "require valid symbol"));
 }  }
   
   
Line 764  static int
Line 743  static int
 post_an(struct mdoc *mdoc)  post_an(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);  
         assert(MDOC_An == mdoc->last->tok);  
   
         if (0 != mdoc->last->data.elem.argc) {          if (0 != mdoc->last->data.elem.argc) {
                 if (NULL == mdoc->last->child)                  if (NULL == mdoc->last->child)
                         return(1);                          return(1);
                 return(mdoc_err(mdoc, "macro expects either argument or parameters"));                  return(mdoc_err(mdoc, "argument(s) expected"));
         }          }
   
         if (mdoc->last->child)          if (mdoc->last->child)
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "macro expects either argument or parameters"));          return(mdoc_err(mdoc, "argument(s) expected"));
 }  }
   
   
Line 783  static int
Line 759  static int
 post_ex(struct mdoc *mdoc)  post_ex(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);  
         assert(MDOC_Ex == mdoc->last->tok);  
   
         if (0 == mdoc->last->data.elem.argc) {          if (0 == mdoc->last->data.elem.argc) {
                 if (mdoc->last->child)                  if (mdoc->last->child)
                         return(1);                          return(1);
                 return(mdoc_err(mdoc, "macro expects `%s' or a single child",                  return(mdoc_err(mdoc, "argument(s) expected"));
                                         mdoc_argnames[MDOC_Std]));  
         }          }
         if (mdoc->last->child)          if (mdoc->last->child)
                 return(mdoc_err(mdoc, "macro expects `%s' or a single child",                  return(mdoc_err(mdoc, "argument(s) expected"));
                                         mdoc_argnames[MDOC_Std]));  
         if (1 != mdoc->last->data.elem.argc)          if (1 != mdoc->last->data.elem.argc)
                 return(mdoc_err(mdoc, "macro expects `%s' or a single child",                  return(mdoc_err(mdoc, "argument(s) expected"));
                                         mdoc_argnames[MDOC_Std]));  
         if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)          if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
                 return(mdoc_err(mdoc, "macro expects `%s' or a single child",                  return(mdoc_err(mdoc, "argument(s) expected"));
                                         mdoc_argnames[MDOC_Std]));  
         return(1);          return(1);
 }  }
   
   
 /* Warn if `Bl' type-specific syntax isn't reflected in items. */  
 static int  static int
 post_it(struct mdoc *mdoc)  post_it(struct mdoc *mdoc)
 {  {
         int               type, sv;          int               type, sv, i;
 #define TYPE_NONE        (0)  #define TYPE_NONE        (0)
 #define TYPE_BODY        (1)  #define TYPE_BODY        (1)
 #define TYPE_HEAD        (2)  #define TYPE_HEAD        (2)
         size_t            i, argc;  #define TYPE_OHEAD       (3)
           size_t            argc;
         struct mdoc_node *n;          struct mdoc_node *n;
   
         if (MDOC_BLOCK != mdoc->last->type)          if (MDOC_BLOCK != mdoc->last->type)
                 return(1);                  return(1);
   
         assert(MDOC_It == mdoc->last->tok);          n = mdoc->last->parent->parent;
   
         n = mdoc->last->parent;  
         assert(n);  
         assert(MDOC_Bl == n->tok);  
   
         n = n->parent;  
         assert(MDOC_BLOCK == n->type);  
         assert(MDOC_Bl == n->tok);  
   
         argc = n->data.block.argc;          argc = n->data.block.argc;
         type = TYPE_NONE;          type = TYPE_NONE;
           sv = -1;
   
         /* Some types require block-head, some not. */          /* Some types require block-head, some not. */
   
         for (i = 0; TYPE_NONE == type && i < argc; i++)          /* LINTED */
                 switch (n->data.block.argv[(int)i].arg) {          for (i = 0; TYPE_NONE == type && i < (int)argc; i++)
                   switch (n->data.block.argv[i].arg) {
                 case (MDOC_Tag):                  case (MDOC_Tag):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Diag):                  case (MDOC_Diag):
Line 846  post_it(struct mdoc *mdoc)
Line 810  post_it(struct mdoc *mdoc)
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Inset):                  case (MDOC_Inset):
                         type = TYPE_HEAD;                          type = TYPE_HEAD;
                         sv = n->data.block.argv[(int)i].arg;                          sv = n->data.block.argv[i].arg;
                         break;                          break;
                 case (MDOC_Bullet):                  case (MDOC_Bullet):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
Line 857  post_it(struct mdoc *mdoc)
Line 821  post_it(struct mdoc *mdoc)
                 case (MDOC_Hyphen):                  case (MDOC_Hyphen):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Item):                  case (MDOC_Item):
                         /* FALLTHROUGH */  
                 case (MDOC_Column):  
                         type = TYPE_BODY;                          type = TYPE_BODY;
                         sv = n->data.block.argv[(int)i].arg;                          sv = n->data.block.argv[i].arg;
                         break;                          break;
                   case (MDOC_Column):
                           type = TYPE_OHEAD;
                           sv = n->data.block.argv[i].arg;
                           break;
                 default:                  default:
                         break;                          break;
                 }                  }
   
         assert(TYPE_NONE != type);          assert(TYPE_NONE != type);
   
           n = mdoc->last->data.block.head;
   
         if (TYPE_HEAD == type) {          if (TYPE_HEAD == type) {
                 n = mdoc->last->data.block.head;  
                 assert(n);  
                 if (NULL == n->child)                  if (NULL == n->child)
                         if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))                          if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "argument(s) suggested"))
                                 return(0);                                  return(0);
   
                 n = mdoc->last->data.block.body;                  n = mdoc->last->data.block.body;
                 assert(n);  
                 if (NULL == n->child)                  if (NULL == n->child)
                         if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))                          if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                                           "multiline body suggested"))
                                 return(0);                                  return(0);
   
                 return(1);          } 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);
         }          }
   
         assert(TYPE_BODY == type);          if (MDOC_Column != sv)
         assert(mdoc->last->data.block.head);  
   
         n = mdoc->last->data.block.head;  
         assert(n);  
         if (n->child)  
                 if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters"))  
                         return(0);  
   
         n = mdoc->last->data.block.body;  
         assert(n);  
         if (NULL == n->child)  
                 if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))  
                         return(0);  
   
         if (MDOC_Column != sv)  
                 return(1);                  return(1);
   
         /* Make sure the number of columns is sane. */          argc = mdoc->last->parent->parent->data.block.argv->sz;
   
         sv = mdoc->last->parent->parent->data.block.argv->sz;  
         n = mdoc->last->data.block.head->child;          n = mdoc->last->data.block.head->child;
   
         for (i = 0; n; n = n->next)          for (i = 0; n; n = n->next)
                 i++;                  i++;
   
         if (i == (size_t)sv)          if (i == (int)argc)
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i));  
           return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));
 #undef  TYPE_NONE  #undef  TYPE_NONE
 #undef  TYPE_BODY  #undef  TYPE_BODY
 #undef  TYPE_HEAD  #undef  TYPE_HEAD
   #undef  TYPE_OHEAD
 }  }
   
   
 /* Make sure that only `It' macros are our body-children. */  
 static int  static int
 post_bl(struct mdoc *mdoc)  post_bl(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node        *n;
   
         if (MDOC_BODY != mdoc->last->type)          if (MDOC_BODY != mdoc->last->type)
                 return(1);                  return(1);
         assert(MDOC_Bl == mdoc->last->tok);  
   
           /* LINTED */
         for (n = mdoc->last->child; n; n = n->next) {          for (n = mdoc->last->child; n; n = n->next) {
                 if (MDOC_BLOCK == n->type)                  if (MDOC_BLOCK == n->type)
                         if (MDOC_It == n->tok)                          if (MDOC_It == n->tok)
                                 continue;                                  continue;
                 break;                  break;
         }          }
   
         if (NULL == n)          if (NULL == n)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));  
           return(mdoc_nerr(mdoc, n, "bad child of parent list"));
 }  }
   
   
 static int  static int
 elem_bool(struct mdoc *mdoc)  ebool(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
   
         assert(MDOC_ELEM == mdoc->last->type);          /* LINTED */
         for (n = mdoc->last->child; n; n = n->next) {          for (n = mdoc->last->child; n; n = n->next) {
                 if (MDOC_TEXT != n->type)                  if (MDOC_TEXT != n->type)
                         break;                          break;
Line 956  elem_bool(struct mdoc *mdoc)
Line 930  elem_bool(struct mdoc *mdoc)
                         continue;                          continue;
                 break;                  break;
         }          }
   
         if (NULL == n)          if (NULL == n)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, n, "expected boolean value [on/off]"));          return(mdoc_nerr(mdoc, n, "expected boolean"));
 }  }
   
   
 /* Warn if conventional sections are out of order. */  
 static int  static int
   pre_text(struct mdoc *mdoc, const struct mdoc_node *n)
   {
           size_t           c;
           const char      *p;
   
           for (p = n->data.text.string; *p; p++) {
                   if ('\\' != *p)
                           continue;
                   if ((c = mdoc_isescape(p))) {
                           p += (c - 1);
                           continue;
                   }
                   return(mdoc_nerr(mdoc, n, "bad escape sequence"));
           }
   
           return(1);
   }
   
   
   static int
   post_root(struct mdoc *mdoc)
   {
   
           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(struct mdoc *mdoc)  post_sh(struct mdoc *mdoc)
 {  {
   
           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(struct mdoc *mdoc)
   {
           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 (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
                   return(1);
   
           return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section should have %s last",
                                   mdoc_macronames[MDOC_Nd]));
   }
   
   
   static int
   post_sh_head(struct mdoc *mdoc)
   {
         char              buf[64];          char              buf[64];
         enum mdoc_sec     sec;          enum mdoc_sec     sec;
   
         if (MDOC_HEAD != mdoc->last->type)  
                 return(1);  
         assert(MDOC_Sh == mdoc->last->tok);          assert(MDOC_Sh == mdoc->last->tok);
   
         if ( ! xstrlcats(buf, mdoc->last->child, 64))          if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf)))
                 return(mdoc_err(mdoc, "macro parameters too long"));                  return(mdoc_err(mdoc, "argument too long"));
   
         if (SEC_CUSTOM == (sec = mdoc_atosec(buf)))          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);                  return(1);
         if (sec > mdoc->sec_lastn)          if (sec == mdoc->lastnamed)
                 return(1);                  return(mdoc_warn(mdoc, WARN_SYNTAX,
         if (sec == mdoc->sec_lastn)                                  "section repeated"));
                 return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated"));          if (sec < mdoc->lastnamed)
         return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order"));                  return(mdoc_warn(mdoc, WARN_SYNTAX,
                                   "section out of order"));
   
           return(1);
 }  }
   
   
Line 991  mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no
Line 1064  mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no
 {  {
         v_pre           *p;          v_pre           *p;
   
         /* TODO: character-escape checks. */  
   
         if (MDOC_TEXT == node->type)          if (MDOC_TEXT == node->type)
                 return(1);                  return(pre_text(mdoc, node));
         assert(MDOC_ROOT != node->type);          assert(MDOC_ROOT != node->type);
   
         if (NULL == mdoc_valids[node->tok].pre)          if (NULL == mdoc_valids[node->tok].pre)
Line 1011  mdoc_valid_post(struct mdoc *mdoc)
Line 1082  mdoc_valid_post(struct mdoc *mdoc)
 {  {
         v_post          *p;          v_post          *p;
   
           /*
            * This check occurs after the macro's children have been filled
            * in: postfix validation.  Since this happens when we're
            * rewinding the scope tree, it's possible to have multiple
            * invocations (as by design, for now), we set bit MDOC_VALID to
            * indicate that we've validated.
            */
   
           if (MDOC_VALID & mdoc->last->flags)
                   return(1);
           mdoc->last->flags |= MDOC_VALID;
   
         if (MDOC_TEXT == mdoc->last->type)          if (MDOC_TEXT == mdoc->last->type)
                 return(1);                  return(1);
         if (MDOC_ROOT == mdoc->last->type) {          if (MDOC_ROOT == mdoc->last->type)
                 /* TODO: make sure prologue is complete. */                  return(post_root(mdoc));
                 return(1);  
         }  
   
         if (NULL == mdoc_valids[mdoc->last->tok].post)          if (NULL == mdoc_valids[mdoc->last->tok].post)
                 return(1);                  return(1);
Legend:
Removed from v.1.36  
changed lines
  Added in v.1.54
CVSweb