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

Diff for /mandoc/Attic/validate.c between version 1.1 and 1.53

version 1.1, 2008/11/29 14:14:21 version 1.53, 2009/02/23 22:51:10
Line 16 
Line 16 
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.   * PERFORMANCE OF THIS SOFTWARE.
  */   */
 #include <sys/param.h>  
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <err.h>  
 #include <stdio.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  
   
 #include "libmdocml.h"  
 #include "private.h"  #include "private.h"
   
 #ifdef  __linux__ /* FIXME */  /*
 #define strlcat         strncat   * Pre- and post-validate macros as they're parsed.  Pre-validation
 #endif   * 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.
    */
   
 struct  md_valid {  typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);
         const struct md_args    *args;  typedef int     (*v_post)(struct mdoc *);
         const struct md_rbuf    *rbuf;  
         struct md_mbuf  *mbuf;  
         struct rofftree *tree;  
   
         size_t           indent;  /* FIXME: some sections should only occur in specific msecs. */
         size_t           pos;  /* FIXME: ignoring Pp. */
   /* FIXME: math symbols. */
   /* FIXME: valid character-escape checks. */
   /* FIXME: .Fd only in synopsis section. */
   
         int              flags;  struct  valids {
 #define MD_LITERAL      (1 << 0)          v_pre   *pre;
           v_post  *post;
 };  };
   
 static  void             roffmsg(void *arg, enum roffmsg,  /* Utility checks. */
                                 const char *, const char *, char *);  
 static  int              roffhead(void *);  
 static  int              rofftail(void *);  
 static  int              roffin(void *, int, int *, char **);  
 static  int              roffdata(void *, char *);  
 static  int              roffout(void *, int);  
 static  int              roffblkin(void *, int);  
 static  int              roffblkout(void *, int);  
 static  int              roffspecial(void *, int);  
   
 static  int              mbuf_newline(struct md_valid *);  static  int     check_parent(struct mdoc *, struct mdoc_node *,
 static  int              mbuf_indent(struct md_valid *);                          int, enum mdoc_type);
 static  int              mbuf_data(struct md_valid *, char *);  static  int     check_msec(struct mdoc *, struct mdoc_node *,
                           int, enum mdoc_msec *);
   static  int     check_stdarg(struct mdoc *, struct mdoc_node *);
   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 int  static  inline int count_child(struct mdoc *);
 mbuf_indent(struct md_valid *p)  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_sh(struct mdoc *, struct mdoc_node *);
   static  int     pre_ss(struct mdoc *, struct mdoc_node *);
   static  int     pre_bd(struct mdoc *, struct mdoc_node *);
   static  int     pre_bl(struct mdoc *, struct mdoc_node *);
   static  int     pre_it(struct mdoc *, struct mdoc_node *);
   static  int     pre_cd(struct mdoc *, struct mdoc_node *);
   static  int     pre_er(struct mdoc *, struct mdoc_node *);
   static  int     pre_ex(struct mdoc *, struct mdoc_node *);
   static  int     pre_rv(struct mdoc *, struct mdoc_node *);
   static  int     pre_an(struct mdoc *, struct mdoc_node *);
   static  int     pre_st(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 *);
   
   /* Specific post-child-parse routines. */
   
   static  int     herr_ge1(struct mdoc *);
   static  int     herr_le1(struct mdoc *);
   static  int     herr_eq0(struct mdoc *);
   static  int     eerr_eq0(struct mdoc *);
   static  int     eerr_le1(struct mdoc *);
   static  int     eerr_le2(struct mdoc *);
   static  int     eerr_eq1(struct mdoc *);
   static  int     eerr_ge1(struct mdoc *);
   static  int     ewarn_eq0(struct mdoc *);
   static  int     ewarn_eq1(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_body(struct mdoc *);
   static  int     post_sh_head(struct mdoc *);
   static  int     post_bl(struct mdoc *);
   static  int     post_it(struct mdoc *);
   static  int     post_ex(struct mdoc *);
   static  int     post_an(struct mdoc *);
   static  int     post_at(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 *);
   
   /* 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] = {
           { NULL, NULL },                         /* \" */
           { pres_prologue, posts_text },          /* Dd */
           { pres_prologue, NULL },                /* Dt */
           { pres_prologue, NULL },                /* Os */
           { pres_sh, posts_sh },                  /* Sh */
           { pres_ss, posts_ss },                  /* Ss */
           { NULL, posts_pp },                     /* Pp */
           { pres_d1, posts_wline },               /* D1 */
           { pres_d1, posts_wline },               /* Dl */
           { pres_bd, posts_bd },                  /* Bd */
           { NULL, NULL },                         /* Ed */
           { pres_bl, posts_bl },                  /* Bl */
           { NULL, NULL },                         /* El */
           { pres_it, posts_it },                  /* It */
           { NULL, posts_text },                   /* Ad */
           { pres_an, posts_an },                  /* An */
           { NULL, NULL },                         /* Ar */
           { pres_cd, posts_text },                /* Cd */
           { NULL, NULL },                         /* Cm */
           { NULL, posts_text },                   /* Dv */
           { pres_er, posts_text },                /* Er */
           { NULL, posts_text },                   /* Ev */
           { pres_ex, posts_ex },                  /* Ex */
           { NULL, posts_text },                   /* Fa */
           { NULL, posts_wtext },                  /* Fd */
           { NULL, NULL },                         /* Fl */
           { NULL, posts_text },                   /* Fn */
           { NULL, posts_wtext },                  /* Ft */
           { NULL, posts_text },                   /* Ic */
           { NULL, posts_in },                     /* In */
           { NULL, posts_text },                   /* Li */
           { NULL, posts_wtext },                  /* Nd */
           { NULL, posts_nm },                     /* Nm */
           { NULL, posts_wline },                  /* Op */
           { NULL, NULL },                         /* Ot */
           { NULL, NULL },                         /* Pa */
           { pres_rv, posts_notext },              /* Rv */
           { pres_st, posts_notext },              /* St */
           { NULL, posts_text },                   /* Va */
           { NULL, posts_text },                   /* Vt */
           { NULL, posts_xr },                     /* Xr */
           { NULL, posts_text },                   /* %A */
           { NULL, posts_text },                   /* %B */
           { NULL, posts_text },                   /* %D */
           { NULL, posts_text },                   /* %I */
           { NULL, posts_text },                   /* %J */
           { NULL, posts_text },                   /* %N */
           { NULL, posts_text },                   /* %O */
           { NULL, posts_text },                   /* %P */
           { NULL, posts_text },                   /* %R */
           { NULL, posts_text },                   /* %T */
           { NULL, posts_text },                   /* %V */
           { NULL, NULL },                         /* Ac */
           { NULL, NULL },                         /* Ao */
           { NULL, posts_wline },                  /* Aq */
           { NULL, posts_at },                     /* At */
           { NULL, NULL },                         /* Bc */
           { NULL, posts_bf },                     /* Bf */
           { NULL, NULL },                         /* Bo */
           { NULL, posts_wline },                  /* Bq */
           { NULL, NULL },                         /* Bsx */
           { NULL, NULL },                         /* Bx */
           { NULL, posts_bool },                   /* Db */
           { NULL, NULL },                         /* Dc */
           { NULL, NULL },                         /* Do */
           { NULL, posts_wline },                  /* Dq */
           { NULL, NULL },                         /* Ec */
           { NULL, NULL },                         /* Ef */
           { NULL, posts_text },                   /* Em */
           { NULL, NULL },                         /* Eo */
           { NULL, NULL },                         /* Fx */
           { NULL, posts_text },                   /* Ms */
           { NULL, posts_notext },                 /* No */
           { NULL, posts_notext },                 /* Ns */
           { NULL, NULL },                         /* Nx */
           { NULL, NULL },                         /* Ox */
           { NULL, NULL },                         /* Pc */
           { NULL, posts_pf },                     /* Pf */
           { NULL, NULL },                         /* Po */
           { NULL, posts_wline },                  /* Pq */
           { NULL, NULL },                         /* Qc */
           { NULL, posts_wline },                  /* Ql */
           { NULL, NULL },                         /* Qo */
           { NULL, posts_wline },                  /* Qq */
           { NULL, NULL },                         /* Re */
           { NULL, posts_rs },                     /* Rs */
           { NULL, NULL },                         /* Sc */
           { NULL, NULL },                         /* So */
           { NULL, posts_wline },                  /* Sq */
           { NULL, posts_bool },                   /* Sm */
           { NULL, posts_text },                   /* Sx */
           { NULL, posts_text },                   /* Sy */
           { NULL, posts_text },                   /* Tn */
           { NULL, NULL },                         /* Ux */
           { NULL, NULL },                         /* Xc */
           { NULL, NULL },                         /* Xo */
           { NULL, posts_fo },                     /* Fo */
           { NULL, NULL },                         /* Fc */
           { NULL, NULL },                         /* Oo */
           { NULL, NULL },                         /* Oc */
           { NULL, posts_bk },                     /* Bk */
           { NULL, NULL },                         /* Ek */
           { NULL, posts_notext },                 /* Bt */
           { NULL, NULL },                         /* Hf */
           { NULL, NULL },                         /* Fr */
           { NULL, posts_notext },                 /* Ud */
   };
   
   
   static inline int
   warn_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
 {  {
         size_t           i;  
   
         assert(0 == p->pos);          return(mdoc_warn(m, WARN_SYNTAX, "suggests %s %d %s "
                                   "(has %d)", v, want, k, has));
   }
   
         for (i = 0; i < MIN(p->indent, 4); i++)  
                 if ( ! md_buf_putstring(p->mbuf, "    "))  
                         return(0);  
   
         p->pos = i * 4;  static inline int
         return(1);  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 int  static inline int
 mbuf_atnewline(struct md_valid *p)  count_child(struct mdoc *mdoc)
 {  {
           int               i;
           struct mdoc_node *n;
   
         return(p->pos == MIN(4, p->indent));          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(struct mdoc *mdoc)                              \
   {                                                               \
           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(struct mdoc *mdoc)                              \
   {                                                               \
           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(struct mdoc *mdoc)                              \
   {                                                               \
           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
 mbuf_newline(struct md_valid *p)  check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         if (mbuf_atnewline(p))          if (MDOC_Std == node->data.elem.argv[0].arg &&
                           1 == node->data.elem.argc)
                 return(1);                  return(1);
         if ( ! md_buf_putchar(p->mbuf, '\n'))  
                 return(0);  
   
         p->pos = 0;          return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
         return(mbuf_indent(p));                                  "one argument suggested"));
 }  }
   
   
 static int  static int
 mbuf_data(struct md_valid *p, char *buf)  check_msec(struct mdoc *mdoc, struct mdoc_node *node,
                   int sz, enum mdoc_msec *msecs)
 {  {
         size_t           sz;          int              i;
         char            *bufp;  
   
         assert(p->mbuf);          for (i = 0; i < sz; i++)
         assert(0 != p->indent);                  if (msecs[i] == mdoc->meta.msec)
                           return(1);
           return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
                                   "wrong manual section"));
   }
   
         if (MD_LITERAL & p->flags)  
                 return(md_buf_putstring(p->mbuf, buf));  
   
         if (0 == p->pos)  static int
                 mbuf_indent(p);  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
   {
           struct mdoc_node *n;
   
         /*          /* Display elements (`Bd', `D1'...) cannot be nested. */
          * Indent if we're at the beginning of a line.  Don't indent  
          * more than 16 or so characters.  
          */  
   
         while (*buf) {          if (MDOC_BLOCK != node->type)
                 while (*buf && isspace(*buf))                  return(1);
                         buf++;  
   
                 if (0 == *buf)          /* LINTED */
                         break;          for (n = mdoc->last->parent; n; n = n->parent)
                   if (MDOC_BLOCK == n->type)
                           if (MDOC_Bd == n->tok)
                                   break;
           if (NULL == n)
                   return(1);
   
                 bufp = buf;          return(mdoc_nerr(mdoc, node, "displays may not be nested"));
                 while (*buf && ! isspace(*buf))  }
                         buf++;  
   
                 if (0 != *buf)  
                         *buf++ = 0;  
   
                 /* Process word. */  static int
   pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
   {
           int              type, err, i;
           struct mdoc_arg *argv;
           size_t           argc;
   
                 sz = strlen(bufp);          if (MDOC_BLOCK != node->type)
                   return(1);
                 if (sz + p->pos < 72) {  
                         if ( ! md_buf_putstring(p->mbuf, bufp))  
                                 return(0);  
   
                         /* FIXME: check punctuation. */          argc = node->data.block.argc;
   
                         if ( ! md_buf_putchar(p->mbuf, ' '))          /* Make sure that only one type of list is specified.  */
                                 return(0);  
                         p->pos += sz + 1;          /* LINTED */
                         continue;          for (i = 0, type = err = 0; i < (int)argc; i++) {
                   argv = &node->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 ( ! mbuf_newline(p))          if (type)
                         return(0);                  return(1);
           return(mdoc_err(mdoc, "no type specified"));
   }
   
                 if ( ! md_buf_putstring(p->mbuf, bufp))  
                         return(0);  
   
                 /* FIXME: check punctuation. */  static int
   pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
   {
           int              type, err, i;
           struct mdoc_arg *argv;
           size_t           argc;
   
                 if ( ! md_buf_putchar(p->mbuf, ' '))          if (MDOC_BLOCK != node->type)
                         return(0);                  return(1);
                 p->pos += sz + 1;  
           argc = node->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 = &node->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;
                   }
         }          }
   
         return(1);          if (type)
                   return(1);
           return(mdoc_err(mdoc, "no type specified"));
 }  }
   
   
 int  static int
 md_line_valid(void *arg, char *buf)  pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         struct md_valid *p;  
   
         p = (struct md_valid *)arg;          if (MDOC_BLOCK != node->type)
         return(roff_engine(p->tree, buf));                  return(1);
           return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
 }  }
   
   
 int  static int
 md_exit_valid(void *data, int flush)  pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int              c;  
         struct md_valid *p;  
   
         p = (struct md_valid *)data;          if (MDOC_BLOCK != node->type)
         c = roff_free(p->tree, flush);                  return(1);
         free(p);          return(check_parent(mdoc, node, -1, MDOC_ROOT));
   }
   
         return(c);  
   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));
 }  }
   
   
 void *  static int
 md_init_valid(const struct md_args *args,  pre_st(struct mdoc *mdoc, struct mdoc_node *node)
                 struct md_mbuf *mbuf, const struct md_rbuf *rbuf)  
 {  {
         struct roffcb    cb;  
         struct md_valid *p;  
   
         cb.roffhead = roffhead;          if (1 == node->data.elem.argc)
         cb.rofftail = rofftail;                  return(1);
         cb.roffin = roffin;          return(mdoc_nerr(mdoc, node, "one argument required"));
         cb.roffout = roffout;  }
         cb.roffblkin = roffblkin;  
         cb.roffblkout = roffblkout;  
         cb.roffspecial = roffspecial;  
         cb.roffmsg = roffmsg;  
         cb.roffdata = roffdata;  
   
         if (NULL == (p = calloc(1, sizeof(struct md_valid))))  
                 err(1, "malloc");  
   
         p->args = args;  static int
         p->mbuf = mbuf;  pre_an(struct mdoc *mdoc, struct mdoc_node *node)
         p->rbuf = rbuf;  {
   
         assert(mbuf);          if (1 >= node->data.elem.argc)
                   return(1);
           return(mdoc_nerr(mdoc, node, "one argument allowed"));
   }
   
         if (NULL == (p->tree = roff_alloc(&cb, p))) {  
                 free(p);  static int
                 return(NULL);  pre_rv(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };
   
           if ( ! check_msec(mdoc, node, 2, msecs))
                   return(0);
           return(check_stdarg(mdoc, node));
   }
   
   
   static int
   pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };
   
           if ( ! check_msec(mdoc, node, 3, msecs))
                   return(0);
           return(check_stdarg(mdoc, node));
   }
   
   
   static int
   pre_er(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec msecs[] = { MSEC_2 };
   
           return(check_msec(mdoc, node, 1, msecs));
   }
   
   
   static int
   pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec msecs[] = { MSEC_4 };
   
           return(check_msec(mdoc, node, 1, msecs));
   }
   
   
   static int
   pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
           if (SEC_PROLOGUE != mdoc->lastnamed)
                   return(mdoc_nerr(mdoc, node, "prologue only"));
   
           /* Check for ordering. */
   
           switch (node->tok) {
           case (MDOC_Os):
                   if (mdoc->meta.title && mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
           case (MDOC_Dt):
                   if (NULL == mdoc->meta.title && mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
           case (MDOC_Dd):
                   if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node,
                                   "prologue out-of-order"));
           default:
                   abort();
                   /* NOTREACHED */
         }          }
   
         return(p);          /* Check for repetition. */
   
           switch (node->tok) {
           case (MDOC_Os):
                   if (NULL == mdoc->meta.os)
                           return(1);
                   break;
           case (MDOC_Dd):
                   if (0 == mdoc->meta.date)
                           return(1);
                   break;
           case (MDOC_Dt):
                   if (NULL == mdoc->meta.title)
                           return(1);
                   break;
           default:
                   abort();
                   /* NOTREACHED */
           }
   
           return(mdoc_nerr(mdoc, node, "prologue repetition"));
 }  }
   
   
 /* ARGSUSED */  
 static int  static int
 roffhead(void *arg)  post_bf(struct mdoc *mdoc)
 {  {
           char             *p;
           struct mdoc_node *head;
   
         return(1);          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  static int
 rofftail(void *arg)  post_nm(struct mdoc *mdoc)
 {  {
         struct md_valid *p;  
   
         assert(arg);          if (mdoc->last->child)
         p = (struct md_valid *)arg;                  return(1);
           if (mdoc->meta.name)
                   return(1);
           return(mdoc_err(mdoc, "not yet invoked with name"));
   }
   
         if (mbuf_atnewline(p))  
   static int
   post_xr(struct mdoc *mdoc)
   {
           struct mdoc_node *n;
   
           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"));
   }
   
         return(md_buf_putchar(p->mbuf, '\n'));  
   static int
   post_at(struct mdoc *mdoc)
   {
   
           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  static int
 roffspecial(void *arg, int tok)  post_an(struct mdoc *mdoc)
 {  {
   
           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(struct mdoc *mdoc)
   {
   
           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);          return(1);
 }  }
   
   
 static int  static int
 roffblkin(void *arg, int tok)  post_it(struct mdoc *mdoc)
 {  {
         struct md_valid *p;          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;
   
         assert(arg);          if (MDOC_BLOCK != mdoc->last->type)
         p = (struct md_valid *)arg;                  return(1);
   
         if ( ! mbuf_atnewline(p)) {          n = mdoc->last->parent->parent;
                 if ( ! md_buf_putchar(p->mbuf, '\n'))  
                         return(0);          argc = n->data.block.argc;
                 p->pos = 0;          type = TYPE_NONE;
                 if ( ! mbuf_indent(p))          sv = -1;
                         return(0);  
           /* Some types require block-head, some not. */
   
           /* LINTED */
           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;
                   }
   
           assert(TYPE_NONE != type);
   
           n = mdoc->last->data.block.head;
   
           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);
         }          }
   
         if ( ! md_buf_putstring(p->mbuf, toknames[tok]))          if (MDOC_Column != sv)
                 return(0);                  return(1);
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))          argc = mdoc->last->parent->parent->data.block.argv->sz;
                 return(0);          n = mdoc->last->data.block.head->child;
   
         p->pos = 0;          for (i = 0; n; n = n->next)
         p->indent++;                  i++;
   
         return(mbuf_indent(p));          if (i == (int)argc)
                   return(1);
   
           return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));
   #undef  TYPE_NONE
   #undef  TYPE_BODY
   #undef  TYPE_HEAD
   #undef  TYPE_OHEAD
 }  }
   
   
 static int  static int
 roffblkout(void *arg, int tok)  post_bl(struct mdoc *mdoc)
 {  {
         struct md_valid *p;          struct mdoc_node        *n;
   
         assert(arg);          if (MDOC_BODY != mdoc->last->type)
         p = (struct md_valid *)arg;                  return(1);
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))          /* LINTED */
                 return(0);          for (n = mdoc->last->child; n; n = n->next) {
                   if (MDOC_BLOCK == n->type)
                           if (MDOC_It == n->tok)
                                   continue;
                   break;
           }
   
         p->pos = 0;          if (NULL == n)
         p->indent--;                  return(1);
   
         return(mbuf_indent(p));          return(mdoc_nerr(mdoc, n, "bad child of parent list"));
 }  }
   
   
 static int  static int
 roffin(void *arg, int tok, int *argcp, char **argvp)  ebool(struct mdoc *mdoc)
 {  {
           struct mdoc_node *n;
   
         return(1);          /* 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;
           }
   
           if (NULL == n)
                   return(1);
           return(mdoc_nerr(mdoc, n, "expected boolean"));
 }  }
   
   
 static int  static int
 roffout(void *arg, int tok)  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);          return(1);
 }  }
   
   
   static int
   post_sh(struct mdoc *mdoc)
   {
   
 static void          if (MDOC_HEAD == mdoc->last->type)
 roffmsg(void *arg, enum roffmsg lvl,                  return(post_sh_head(mdoc));
                 const char *buf, const char *pos, char *msg)          if (MDOC_BODY == mdoc->last->type)
                   return(post_sh_body(mdoc));
   
           return(1);
   }
   
   
   static int
   post_sh_body(struct mdoc *mdoc)
 {  {
         char            *level;          struct mdoc_node *n;
         struct md_valid *p;  
   
         assert(arg);          if (SEC_NAME != mdoc->lastnamed)
         p = (struct md_valid *)arg;                  return(1);
   
         switch (lvl) {          /*
         case (ROFF_WARN):           * Warn if the NAME section doesn't contain the `Nm' and `Nd'
                 if ( ! (MD_WARN_ALL & p->args->warnings))           * macros (can have multiple `Nm' and one `Nd').  Note that the
                         return;           * children of the BODY declaration can also be "text".
                 level = "warning";           */
                 break;  
         case (ROFF_ERROR):          if (NULL == (n = mdoc->last->child))
                 level = "error";                  return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME "
                 break;                                          "should contain %s and %s",
         default:                                          mdoc_macronames[MDOC_Nm],
                 abort();                                          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_COMPAT, "section "
                                           "NAME should contain %s as "
                                           "initial body child",
                                           mdoc_macronames[MDOC_Nm])))
                           return(0);
         }          }
   
         if (pos)  
                 (void)fprintf(stderr, "%s:%zu: %s: %s\n",  
                                 p->rbuf->name, p->rbuf->line, level, msg);  
         else  
                 (void)fprintf(stderr, "%s: %s: %s\n",  
                                 p->rbuf->name, level, msg);  
   
           if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
                   return(1);
   
           return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME should "
                                   "contain %s as the last child",
                                   mdoc_macronames[MDOC_Nd]));
 }  }
   
   
 static int  static int
 roffdata(void *arg, char *buf)  post_sh_head(struct mdoc *mdoc)
 {  {
         struct md_valid *p;          char              buf[64];
           enum mdoc_sec     sec;
   
         assert(arg);          assert(MDOC_Sh == mdoc->last->tok);
         p = (struct md_valid *)arg;  
         return(mbuf_data(p, buf));          if ( ! xstrlcats(buf, mdoc->last->child, 64))
                   return(mdoc_err(mdoc, "macro parameters too long"));
   
           sec = mdoc_atosec(buf);
   
           if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
                   return(mdoc_err(mdoc, "section NAME must 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 conventional order"));
   
           return(1);
 }  }
   
   
   int
   mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
   {
           v_pre           *p;
   
           if (MDOC_TEXT == node->type)
                   return(1);
           assert(MDOC_ROOT != node->type);
   
           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)
   {
           v_post          *p;
   
           if (MDOC_VALID & mdoc->last->flags)
                   return(1);
           mdoc->last->flags |= MDOC_VALID;
   
           if (MDOC_TEXT == mdoc->last->type)
                   return(1);
           if (MDOC_ROOT == mdoc->last->type)
                   return(post_root(mdoc));
   
           if (NULL == mdoc_valids[mdoc->last->tok].post)
                   return(1);
           for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
                   if ( ! (*p)(mdoc))
                           return(0);
   
           return(1);
   }
   
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.53
CVSweb