[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.37

version 1.36, 2009/01/17 16:15:27 version 1.37, 2009/01/17 16:47:02
Line 21 
Line 21 
   
 #include "private.h"  #include "private.h"
   
   
 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: make sure prologue is complete. */
   /* FIXME: valid character-escape checks. */
   
 struct  valids {  struct  valids {
         v_pre   *pre;          v_pre   *pre;
         v_post  *post;          v_post  *post;
 };  };
   
   /* Utility checks. */
   
 static  int     pre_check_parent(struct mdoc *, struct mdoc_node *,  static  int     pre_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     pre_check_msecs(struct mdoc *, struct mdoc_node *,
Line 45  static int post_check_children_lt(struct mdoc *, int);
Line 47  static int post_check_children_lt(struct mdoc *, int);
 static  int     post_check_children_gt(struct mdoc *, int);  static  int     post_check_children_gt(struct mdoc *, int);
 static  int     post_check_children_eq(struct mdoc *, int);  static  int     post_check_children_eq(struct mdoc *, 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 65  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     hwarn_ge1(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     bwarn_ge1(struct mdoc *);
 static  int     elem_bool(struct mdoc *);  static  int     berr_eq0(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_bl(struct mdoc *);  static  int     post_bl(struct mdoc *);
 static  int     post_it(struct mdoc *);  static  int     post_it(struct mdoc *);
Line 81  static int post_ex(struct mdoc *);
Line 87  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_root(struct mdoc *);
   
   /* 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 106  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[] = { hwarn_ge1, berr_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_ss[] = { herr_ge1, NULL };
 static  v_post  posts_pp[] = { elem_warn_eq0, NULL };  static  v_post  posts_pp[] = { ewarn_eq0, NULL };
 static  v_post  posts_d1[] = { head_err_ge1, NULL };  static  v_post  posts_d1[] = { herr_ge1, NULL };
 static  v_post  posts_ex[] = { elem_err_le1, post_ex, 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 };
   
   /* 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 }, /* \" */
Line 152  const struct valids mdoc_valids[MDOC_MAX] = {
Line 163  const struct valids mdoc_valids[MDOC_MAX] = {
         { NULL, posts_wtext }, /* In */          { NULL, posts_wtext }, /* In */
         { NULL, posts_text }, /* Li */          { NULL, posts_text }, /* Li */
         { NULL, posts_wtext }, /* Nd */          { NULL, posts_wtext }, /* Nd */
         /* FIXME: check that name must be set/provided. */          { NULL, posts_nm }, /* Nm */
         { NULL, NULL }, /* Nm */  
         { NULL, posts_wline }, /* Op */          { NULL, posts_wline }, /* Op */
         { NULL, NULL }, /* Ot */          { NULL, NULL }, /* Ot */
         { NULL, NULL }, /* Pa */          { NULL, NULL }, /* Pa */
Line 300  pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n
Line 310  pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n
         for (i = 0; i < sz; i++)          for (i = 0; i < sz; i++)
                 if (msecs[i] == mdoc->meta.msec)                  if (msecs[i] == mdoc->meta.msec)
                         return(1);                          return(1);
         return(mdoc_nwarn(mdoc, node, WARN_COMPAT,          return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not "
                                 "macro is not appropriate for this manual section"));                                  "appropriate for manual section"));
 }  }
   
   
Line 323  pre_check_parent(struct mdoc *mdoc, struct mdoc_node *
Line 333  pre_check_parent(struct mdoc *mdoc, struct mdoc_node *
   
   
 static int  static int
 body_err_eq0(struct mdoc *mdoc)  berr_eq0(struct mdoc *mdoc)
 {  {
   
         if (MDOC_BODY != mdoc->last->type)          if (MDOC_BODY != mdoc->last->type)
Line 335  body_err_eq0(struct mdoc *mdoc)
Line 345  body_err_eq0(struct mdoc *mdoc)
   
   
 static int  static int
 body_warn_ge1(struct mdoc *mdoc)  bwarn_ge1(struct mdoc *mdoc)
 {  {
   
         if (MDOC_BODY != mdoc->last->type)          if (MDOC_BODY != mdoc->last->type)
Line 347  body_warn_ge1(struct mdoc *mdoc)
Line 357  body_warn_ge1(struct mdoc *mdoc)
   
   
 static int  static int
 elem_warn_eq0(struct mdoc *mdoc)  ewarn_eq0(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 359  elem_warn_eq0(struct mdoc *mdoc)
Line 369  elem_warn_eq0(struct mdoc *mdoc)
   
   
 static int  static int
 elem_warn_ge1(struct mdoc *mdoc)  ewarn_ge1(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 370  elem_warn_ge1(struct mdoc *mdoc)
Line 380  elem_warn_ge1(struct mdoc *mdoc)
   
   
 static int  static int
 elem_err_eq1(struct mdoc *mdoc)  eerr_eq1(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 379  elem_err_eq1(struct mdoc *mdoc)
Line 389  elem_err_eq1(struct mdoc *mdoc)
   
   
 static int  static int
 elem_err_le2(struct mdoc *mdoc)  eerr_le2(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 388  elem_err_le2(struct mdoc *mdoc)
Line 398  elem_err_le2(struct mdoc *mdoc)
   
   
 static int  static int
 elem_err_le1(struct mdoc *mdoc)  eerr_le1(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 397  elem_err_le1(struct mdoc *mdoc)
Line 407  elem_err_le1(struct mdoc *mdoc)
   
   
 static int  static int
 elem_err_eq0(struct mdoc *mdoc)  eerr_eq0(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 406  elem_err_eq0(struct mdoc *mdoc)
Line 416  elem_err_eq0(struct mdoc *mdoc)
   
   
 static int  static int
 elem_err_ge1(struct mdoc *mdoc)  eerr_ge1(struct mdoc *mdoc)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
Line 415  elem_err_ge1(struct mdoc *mdoc)
Line 425  elem_err_ge1(struct mdoc *mdoc)
   
   
 static int  static int
 head_err_eq0(struct mdoc *mdoc)  herr_eq0(struct mdoc *mdoc)
 {  {
   
         if (MDOC_HEAD != mdoc->last->type)          if (MDOC_HEAD != mdoc->last->type)
Line 425  head_err_eq0(struct mdoc *mdoc)
Line 435  head_err_eq0(struct mdoc *mdoc)
   
   
 static int  static int
 head_warn_ge1(struct mdoc *mdoc)  hwarn_ge1(struct mdoc *mdoc)
 {  {
   
         if (MDOC_HEAD != mdoc->last->type)          if (MDOC_HEAD != mdoc->last->type)
Line 437  head_warn_ge1(struct mdoc *mdoc)
Line 447  head_warn_ge1(struct mdoc *mdoc)
   
   
 static int  static int
 head_err_ge1(struct mdoc *mdoc)  herr_ge1(struct mdoc *mdoc)
 {  {
   
         if (MDOC_HEAD != mdoc->last->type)          if (MDOC_HEAD != mdoc->last->type)
Line 727  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
Line 737  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
   
   
 static int  static int
   post_nm(struct mdoc *mdoc)
   {
   
           assert(MDOC_ELEM == mdoc->last->type);
           assert(MDOC_Nm == mdoc->last->tok);
           if (mdoc->last->child)
                   return(1);
           if (mdoc->meta.name)
                   return(1);
           return(mdoc_err(mdoc, "macro `%s' has not been invoked with a name",
                                   mdoc_macronames[MDOC_Nm]));
   }
   
   
   static int
 post_xr(struct mdoc *mdoc)  post_xr(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
Line 751  post_at(struct mdoc *mdoc)
Line 776  post_at(struct mdoc *mdoc)
   
         assert(MDOC_ELEM == mdoc->last->type);          assert(MDOC_ELEM == mdoc->last->type);
         assert(MDOC_At == mdoc->last->tok);          assert(MDOC_At == mdoc->last->tok);
         assert(mdoc->last->child);  
           if (NULL == mdoc->last->child)
                   return(1);
         assert(MDOC_TEXT == mdoc->last->child->type);          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))
Line 919  post_it(struct mdoc *mdoc)
Line 946  post_it(struct mdoc *mdoc)
 }  }
   
   
 /* Make sure that only `It' macros are our body-children. */  
 static int  static int
 post_bl(struct mdoc *mdoc)  post_bl(struct mdoc *mdoc)
 {  {
Line 942  post_bl(struct mdoc *mdoc)
Line 968  post_bl(struct mdoc *mdoc)
   
   
 static int  static int
 elem_bool(struct mdoc *mdoc)  ebool(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
   
Line 958  elem_bool(struct mdoc *mdoc)
Line 984  elem_bool(struct mdoc *mdoc)
         }          }
         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 value"));
 }  }
   
   
   static int
   post_root(struct mdoc *mdoc)
   {
   
           if (NULL == mdoc->last->child)
                   return(mdoc_err(mdoc, "document has no data"));
           if (NULL == mdoc->meta.title)
                   return(mdoc_err(mdoc, "document has no incomplete prologue"));
           if (NULL == mdoc->meta.os)
                   return(mdoc_err(mdoc, "document has no incomplete prologue"));
           if (0 == mdoc->meta.date)
                   return(mdoc_err(mdoc, "document has no incomplete prologue"));
           return(1);
   }
   
   
 /* Warn if conventional sections are out of order. */  /* Warn if conventional sections are out of order. */
 static int  static int
 post_sh(struct mdoc *mdoc)  post_sh(struct mdoc *mdoc)
Line 991  mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no
Line 1033  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(1);
         assert(MDOC_ROOT != node->type);          assert(MDOC_ROOT != node->type);
Line 1013  mdoc_valid_post(struct mdoc *mdoc)
Line 1053  mdoc_valid_post(struct mdoc *mdoc)
   
         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.37
CVSweb