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

version 1.1, 2008/11/29 14:14:21 version 1.50, 2009/02/21 21:00:06
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: make sure required sections are included (NAME, ...). */
   
         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     pre_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     pre_check_msecs(struct mdoc *, struct mdoc_node *,
                           int, enum mdoc_msec *);
   static  int     pre_check_stdarg(struct mdoc *, struct mdoc_node *);
   static  int     post_check_children_count(struct mdoc *);
   static  int     post_check_children_lt(struct mdoc *, const char *, int);
   static  int     post_check_children_gt(struct mdoc *, const char *, int);
   static  int     post_check_children_wgt(struct mdoc *, const char *, int);
   static  int     post_check_children_eq(struct mdoc *, const char *, int);
   static  int     post_check_children_weq(struct mdoc *, 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_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 */
           /* FIXME: only in SYNOPSIS section. */
           { 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 */ /* -symbolic, etc. */
           { 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, NULL }, /* 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 int  static int
 mbuf_indent(struct md_valid *p)  post_check_children_count(struct mdoc *mdoc)
 {  {
         size_t           i;          struct mdoc_node *n;
           int               i;
   
         assert(0 == p->pos);          for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                   /* Do nothing */ ;
           return(i);
   }
   
         for (i = 0; i < MIN(p->indent, 4); i++)  
                 if ( ! md_buf_putstring(p->mbuf, "    "))  
                         return(0);  
   
         p->pos = i * 4;  static int
         return(1);  post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz)
   {
           int               i;
   
           if ((i = post_check_children_count(mdoc)) > sz)
                   return(1);
           return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more "
                                   "than %d %s (has %d)", sz, p, i));
 }  }
   
   
 static int  static int
 mbuf_atnewline(struct md_valid *p)  post_check_children_gt(struct mdoc *mdoc, const char *p, int sz)
 {  {
           int               i;
   
         return(p->pos == MIN(4, p->indent));          if ((i = post_check_children_count(mdoc)) > sz)
                   return(1);
           return(mdoc_err(mdoc, "macro requires more than %d "
                                   "%s (has %d)", sz, p, i));
 }  }
   
   
 static int  static int
 mbuf_newline(struct md_valid *p)  post_check_children_weq(struct mdoc *mdoc, const char *p, int sz)
 {  {
           int               i;
   
         if (mbuf_atnewline(p))          if ((i = post_check_children_count(mdoc)) == sz)
                 return(1);                  return(1);
         if ( ! md_buf_putchar(p->mbuf, '\n'))          return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d "
                 return(0);                                  "%s (has %d)", sz, p, i));
   }
   
         p->pos = 0;  
         return(mbuf_indent(p));  static int
   post_check_children_eq(struct mdoc *mdoc, const char *p, int sz)
   {
           int               i;
   
           if ((i = post_check_children_count(mdoc)) == sz)
                   return(1);
           return(mdoc_err(mdoc, "macro requires %d %s "
                                   "(have %d)", sz, p, i));
 }  }
   
   
 static int  static int
 mbuf_data(struct md_valid *p, char *buf)  post_check_children_lt(struct mdoc *mdoc, const char *p, int sz)
 {  {
         size_t           sz;          int               i;
         char            *bufp;  
   
         assert(p->mbuf);          if ((i = post_check_children_count(mdoc)) < sz)
         assert(0 != p->indent);                  return(1);
           return(mdoc_err(mdoc, "macro requires less than %d "
                                   "%s (have %d)", sz, p, i));
   }
   
         if (MD_LITERAL & p->flags)  
                 return(md_buf_putstring(p->mbuf, buf));  
   
         if (0 == p->pos)  static int
                 mbuf_indent(p);  pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
         /*          if (1 == node->data.elem.argc &&
          * Indent if we're at the beginning of a line.  Don't indent                          MDOC_Std == node->data.elem.argv[0].arg)
          * more than 16 or so characters.                  return(1);
          */          return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
                                   "macro suggests single `%s' argument",
                                   mdoc_argnames[MDOC_Std]));
   }
   
         while (*buf) {  
                 while (*buf && isspace(*buf))  
                         buf++;  
   
                 if (0 == *buf)  static int
                         break;  pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node,
                   int sz, enum mdoc_msec *msecs)
   {
           int              i;
   
                 bufp = buf;          for (i = 0; i < sz; i++)
                 while (*buf && ! isspace(*buf))                  if (msecs[i] == mdoc->meta.msec)
                         buf++;                          return(1);
           return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not "
                                   "appropriate for manual section"));
   }
   
                 if (0 != *buf)  
                         *buf++ = 0;  
   
                 /* Process word. */  static int
   pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,
                   int tok, enum mdoc_type type)
   {
   
                 sz = strlen(bufp);          if (type != node->parent->type)
                   return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s",
                 if (sz + p->pos < 72) {                                          mdoc_type2a(node->parent->type),
                         if ( ! md_buf_putstring(p->mbuf, bufp))                                          mdoc_type2a(type)));
                                 return(0);          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);
   }
   
                         /* FIXME: check punctuation. */  
   
                         if ( ! md_buf_putchar(p->mbuf, ' '))  static int
                                 return(0);  bwarn_ge1(struct mdoc *mdoc)
                         p->pos += sz + 1;  {
                         continue;  
                 }  
   
                 if ( ! mbuf_newline(p))          if (MDOC_BODY != mdoc->last->type)
                         return(0);                  return(1);
           return(post_check_children_wgt(mdoc, "body children", 0));
   }
   
                 if ( ! md_buf_putstring(p->mbuf, bufp))  
                         return(0);  
   
                 /* FIXME: check punctuation. */  static int
   ewarn_eq1(struct mdoc *mdoc)
   {
   
                 if ( ! md_buf_putchar(p->mbuf, ' '))          assert(MDOC_ELEM == mdoc->last->type);
                         return(0);          return(post_check_children_weq(mdoc, "parameters", 1));
                 p->pos += sz + 1;  }
         }  
   
         return(1);  
   static int
   ewarn_eq0(struct mdoc *mdoc)
   {
   
           assert(MDOC_ELEM == mdoc->last->type);
           return(post_check_children_weq(mdoc, "parameters", 0));
 }  }
   
   
 int  static int
 md_line_valid(void *arg, char *buf)  ewarn_ge1(struct mdoc *mdoc)
 {  {
         struct md_valid *p;  
   
         p = (struct md_valid *)arg;          assert(MDOC_ELEM == mdoc->last->type);
         return(roff_engine(p->tree, buf));          return(post_check_children_wgt(mdoc, "parameters", 0));
 }  }
   
   
 int  static int
 md_exit_valid(void *data, int flush)  eerr_eq1(struct mdoc *mdoc)
 {  {
         int              c;  
         struct md_valid *p;  
   
         p = (struct md_valid *)data;          assert(MDOC_ELEM == mdoc->last->type);
         c = roff_free(p->tree, flush);          return(post_check_children_eq(mdoc, "parameters", 1));
         free(p);  }
   
         return(c);  
   static int
   eerr_le2(struct mdoc *mdoc)
   {
   
           assert(MDOC_ELEM == mdoc->last->type);
           return(post_check_children_lt(mdoc, "parameters", 3));
 }  }
   
   
 void *  static int
 md_init_valid(const struct md_args *args,  eerr_le1(struct mdoc *mdoc)
                 struct md_mbuf *mbuf, const struct md_rbuf *rbuf)  
 {  {
         struct roffcb    cb;  
         struct md_valid *p;  
   
         cb.roffhead = roffhead;          assert(MDOC_ELEM == mdoc->last->type);
         cb.rofftail = rofftail;          return(post_check_children_lt(mdoc, "parameters", 2));
         cb.roffin = roffin;  }
         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;  eerr_eq0(struct mdoc *mdoc)
         p->rbuf = rbuf;  {
   
         assert(mbuf);          assert(MDOC_ELEM == mdoc->last->type);
           return(post_check_children_eq(mdoc, "parameters", 0));
   }
   
         if (NULL == (p->tree = roff_alloc(&cb, p))) {  
                 free(p);  
                 return(NULL);  
         }  
   
         return(p);  static int
   eerr_ge1(struct mdoc *mdoc)
   {
   
           assert(MDOC_ELEM == mdoc->last->type);
           return(post_check_children_gt(mdoc, "parameters", 0));
 }  }
   
   
 /* ARGSUSED */  
 static int  static int
 roffhead(void *arg)  herr_eq0(struct mdoc *mdoc)
 {  {
   
         return(1);          if (MDOC_HEAD != mdoc->last->type)
                   return(1);
           return(post_check_children_eq(mdoc, "parameters", 0));
 }  }
   
   
 static int  static int
 rofftail(void *arg)  herr_le1(struct mdoc *mdoc)
 {  {
         struct md_valid *p;          if (MDOC_HEAD != mdoc->last->type)
                   return(1);
           return(post_check_children_lt(mdoc, "parameters", 2));
   }
   
         assert(arg);  
         p = (struct md_valid *)arg;  
   
         if (mbuf_atnewline(p))  static int
   herr_ge1(struct mdoc *mdoc)
   {
   
           if (MDOC_HEAD != mdoc->last->type)
                 return(1);                  return(1);
           return(post_check_children_gt(mdoc, "parameters", 0));
   }
   
         return(md_buf_putchar(p->mbuf, '\n'));  
   static int
   pre_display(struct mdoc *mdoc, struct mdoc_node *node)
   {
           struct mdoc_node *n;
   
           if (MDOC_BLOCK != node->type)
                   return(1);
   
           assert(mdoc->last);
           /* LINTED */
           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);
           return(mdoc_nerr(mdoc, node, "displays may not be nested"));
 }  }
   
   
 static int  static int
 roffspecial(void *arg, int tok)  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
           int              type, err;
           struct mdoc_arg *argv;
           size_t           i, argc;
   
         return(1);          if (MDOC_BLOCK != node->type)
                   return(1);
           assert(MDOC_Bl == node->tok);
   
           argv = NULL;
           argc = node->data.block.argc;
   
           /* LINTED */
           for (i = type = err = 0; i < argc; i++) {
                   argv = &node->data.block.argv[(int)i];
                   assert(argv);
                   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 (type)
                                   err++;
                           type++;
                           break;
                   default:
                           break;
                   }
           }
           if (0 == type)
                   return(mdoc_err(mdoc, "no list type specified"));
           if (0 == err)
                   return(1);
           assert(argv);
           return(mdoc_perr(mdoc, argv->line,
                           argv->pos, "only one list type possible"));
 }  }
   
   
 static int  static int
 roffblkin(void *arg, int tok)  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         struct md_valid *p;          int              type, err;
           struct mdoc_arg *argv;
           size_t           i, argc;
   
         assert(arg);          if (MDOC_BLOCK != node->type)
         p = (struct md_valid *)arg;                  return(1);
           assert(MDOC_Bd == node->tok);
   
         if ( ! mbuf_atnewline(p)) {          argv = NULL;
                 if ( ! md_buf_putchar(p->mbuf, '\n'))          argc = node->data.block.argc;
                         return(0);  
                 p->pos = 0;          /* LINTED */
                 if ( ! mbuf_indent(p))          for (err = i = type = 0; 0 == err && i < argc; i++) {
                         return(0);                  argv = &node->data.block.argv[(int)i];
                   assert(argv);
                   switch (argv->arg) {
                   case (MDOC_Ragged):
                           /* FALLTHROUGH */
                   case (MDOC_Unfilled):
                           /* FALLTHROUGH */
                   case (MDOC_Filled):
                           /* FALLTHROUGH */
                   case (MDOC_Literal):
                           /* FALLTHROUGH */
                   case (MDOC_File):
                           if (type)
                                   err++;
                           type++;
                           break;
                   default:
                           break;
                   }
         }          }
           if (0 == type)
                   return(mdoc_err(mdoc, "no display type specified"));
           if (0 == err)
                   return(1);
           assert(argv);
           return(mdoc_perr(mdoc, argv->line,
                           argv->pos, "only one display type possible"));
   }
   
         if ( ! md_buf_putstring(p->mbuf, toknames[tok]))  
                 return(0);  
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))  static int
                 return(0);  pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
         p->pos = 0;          if (MDOC_BLOCK != node->type)
         p->indent++;                  return(1);
           return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
   }
   
         return(mbuf_indent(p));  
   static int
   pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
           if (MDOC_BLOCK != node->type)
                   return(1);
           return(pre_check_parent(mdoc, node, -1, MDOC_ROOT));
 }  }
   
   
 static int  static int
 roffblkout(void *arg, int tok)  pre_st(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         struct md_valid *p;  
   
         assert(arg);          assert(MDOC_ELEM == node->type);
         p = (struct md_valid *)arg;          assert(MDOC_St == node->tok);
           if (1 == node->data.elem.argc)
                   return(1);
           return(mdoc_nerr(mdoc, node, "macro must have one argument"));
   }
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))  
   static int
   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)
                   return(1);
           return(mdoc_nerr(mdoc, node, "macro may only have one argument"));
   }
   
   
   static int
   pre_rv(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec   msecs[2];
   
           assert(MDOC_ELEM == node->type);
           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));
   }
   
         p->pos = 0;  
         p->indent--;  
   
         return(mbuf_indent(p));  static int
   pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec   msecs[3];
   
           assert(MDOC_ELEM == node->type);
           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(pre_check_stdarg(mdoc, node));
 }  }
   
   
 static int  static int
 roffin(void *arg, int tok, int *argcp, char **argvp)  pre_er(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
           enum mdoc_msec   msecs[1];
   
         return(1);          msecs[0] = MSEC_2;
           return(pre_check_msecs(mdoc, node, 1, msecs));
 }  }
   
   
 static int  static int
 roffout(void *arg, int tok)  pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
           enum mdoc_msec   msecs[1];
   
         return(1);          msecs[0] = MSEC_4;
           return(pre_check_msecs(mdoc, node, 1, msecs));
 }  }
   
   
   static int
   pre_it(struct mdoc *mdoc, struct mdoc_node *node)
   {
   
 static void          /* TODO: -width attribute must be specified for -tag. */
 roffmsg(void *arg, enum roffmsg lvl,          /* TODO: children too big for -width? */
                 const char *buf, const char *pos, char *msg)  
           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)
 {  {
         char            *level;  
         struct md_valid *p;  
   
         assert(arg);          if (SEC_PROLOGUE != mdoc->lastnamed)
         p = (struct md_valid *)arg;                  return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
           assert(MDOC_ELEM == node->type);
   
         switch (lvl) {          /* Check for ordering. */
         case (ROFF_WARN):  
                 if ( ! (MD_WARN_ALL & p->args->warnings))          switch (node->tok) {
                         return;          case (MDOC_Os):
                 level = "warning";                  if (mdoc->meta.title && mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
           case (MDOC_Dt):
                   if (NULL == mdoc->meta.title && mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
           case (MDOC_Dd):
                   if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
                           break;
                   return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
           default:
                   abort();
                   /* NOTREACHED */
           }
   
           /* Check for repetition. */
   
           switch (node->tok) {
           case (MDOC_Os):
                   if (NULL == mdoc->meta.os)
                           return(1);
                 break;                  break;
         case (ROFF_ERROR):          case (MDOC_Dd):
                 level = "error";                  if (0 == mdoc->meta.date)
                           return(1);
                 break;                  break;
           case (MDOC_Dt):
                   if (NULL == mdoc->meta.title)
                           return(1);
                   break;
         default:          default:
                 abort();                  abort();
                   /* NOTREACHED */
         }          }
   
           return(mdoc_nerr(mdoc, node, "prologue macro repeated"));
   }
   
   
   static int
   post_bf(struct mdoc *mdoc)
   {
           char             *p;
           struct mdoc_node *head;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
           assert(MDOC_Bf == mdoc->last->tok);
           head = mdoc->last->data.block.head;
           assert(head);
   
           if (0 == mdoc->last->data.block.argc) {
                   if (head->child) {
                           assert(MDOC_TEXT == head->child->type);
                           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 mode"));
                   }
                   return(mdoc_err(mdoc, "macro expects an argument or parameter"));
           }
           if (head->child)
                   return(mdoc_err(mdoc, "macro expects an argument or parameter"));
           if (1 == mdoc->last->data.block.argc)
                   return(1);
           return(mdoc_err(mdoc, "macro expects an argument or parameter"));
   }
   
   
   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)
   {
           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))
                   return(1);
           assert(MDOC_TEXT == n->type);
           if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))
                   return(1);
           return(mdoc_nerr(mdoc, n, "invalid manual section"));
   }
   
   
   static int
   post_at(struct mdoc *mdoc)
   {
   
           assert(MDOC_ELEM == mdoc->last->type);
           assert(MDOC_At == mdoc->last->tok);
   
           if (NULL == mdoc->last->child)
                   return(1);
           assert(MDOC_TEXT == mdoc->last->child->type);
   
           if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
                   return(1);
           return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol"));
   }
   
   
   static int
   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 (NULL == mdoc->last->child)
                           return(1);
                   return(mdoc_err(mdoc, "macro expects either argument or parameters"));
           }
   
           if (mdoc->last->child)
                   return(1);
           return(mdoc_err(mdoc, "macro expects either argument or parameters"));
   }
   
   
   static int
   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 (mdoc->last->child)
                           return(1);
                   return(mdoc_err(mdoc, "macro expects `%s' or a single child",
                                           mdoc_argnames[MDOC_Std]));
           }
           if (mdoc->last->child)
                   return(mdoc_err(mdoc, "macro expects `%s' or a single child",
                                           mdoc_argnames[MDOC_Std]));
           if (1 != mdoc->last->data.elem.argc)
                   return(mdoc_err(mdoc, "macro expects `%s' or a single child",
                                           mdoc_argnames[MDOC_Std]));
           if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
                   return(mdoc_err(mdoc, "macro expects `%s' or a single child",
                                           mdoc_argnames[MDOC_Std]));
           return(1);
   }
   
   
   /* Warn if `Bl' type-specific syntax isn't reflected in items. */
   static int
   post_it(struct mdoc *mdoc)
   {
           int               type, sv;
   #define TYPE_NONE        (0)
   #define TYPE_BODY        (1)
   #define TYPE_HEAD        (2)
   #define TYPE_OHEAD       (3)
           size_t            i, argc;
           struct mdoc_node *n;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           assert(MDOC_It == mdoc->last->tok);
   
           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;
           type = TYPE_NONE;
           sv = -1;
   
         if (pos)          /* Some types require block-head, some not. */
                 (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);  
   
           /* LINTED */
           for (i = 0; TYPE_NONE == type && i < argc; i++)
                   switch (n->data.block.argv[(int)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[(int)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[(int)i].arg;
                           break;
                   case (MDOC_Column):
                           type = TYPE_OHEAD;
                           sv = n->data.block.argv[(int)i].arg;
                           break;
                   default:
                           break;
                   }
   
           assert(TYPE_NONE != type);
   
           n = mdoc->last->data.block.head;
           assert(n);
   
           if (TYPE_HEAD == type) {
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests 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);
   
           } else if (TYPE_BODY == type) {
                   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);
           } else {
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
                                   return(0);
   
                   n = mdoc->last->data.block.body;
                   assert(n);
                   if (n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"))
                                   return(0);
           }
   
           if (MDOC_Column != sv)
                   return(1);
   
           /* Make sure the number of columns is sane. */
   
           argc = mdoc->last->parent->parent->data.block.argv->sz;
           n = mdoc->last->data.block.head->child;
   
           for (i = 0; n; n = n->next)
                   i++;
   
           if (i == argc)
                   return(1);
           return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i));
   #undef  TYPE_NONE
   #undef  TYPE_BODY
   #undef  TYPE_HEAD
   #undef  TYPE_OHEAD
 }  }
   
   
 static int  static int
 roffdata(void *arg, char *buf)  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);
         return(mbuf_data(p, buf));          assert(MDOC_Bl == mdoc->last->tok);
   
           /* LINTED */
           for (n = mdoc->last->child; n; n = n->next) {
                   if (MDOC_BLOCK == n->type)
                           if (MDOC_It == n->tok)
                                   continue;
                   break;
           }
           if (NULL == n)
                   return(1);
           return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
 }  }
   
   
   static int
   ebool(struct mdoc *mdoc)
   {
           struct mdoc_node *n;
   
           assert(MDOC_ELEM == mdoc->last->type);
           /* 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 value"));
   }
   
   
   static int
   post_root(struct mdoc *mdoc)
   {
   
           if (NULL == mdoc->first->child)
                   return(mdoc_err(mdoc, "document has no data"));
           if (SEC_PROLOGUE == mdoc->lastnamed)
                   return(mdoc_err(mdoc, "document has incomplete prologue"));
           if (MDOC_BLOCK != mdoc->first->child->type)
                   return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
           if (MDOC_Sh != mdoc->first->child->tok)
                   return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
           return(1);
   }
   
   
   static int
   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;
   
           assert(MDOC_Sh == mdoc->last->tok);
           if (SEC_NAME != mdoc->lastnamed)
                   return(1);
   
           if (NULL == (n = mdoc->last->child))
                   return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm]));
           if (MDOC_ELEM != n->type || MDOC_Nm != n->tok)
                   return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm]));
           if (NULL == (n = n->next))
                   return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd]));
           if (MDOC_ELEM != n->type || MDOC_Nd != n->tok)
                   return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd]));
           if (NULL == (n = n->next))
                   return(1);
   
           return(mdoc_warn(mdoc, WARN_SYNTAX, "section NAME usually limited to %s and %s body children",
                                   mdoc_macronames[MDOC_Nm], mdoc_macronames[MDOC_Nd]));
   }
   
   
   static int
   post_sh_head(struct mdoc *mdoc)
   {
           char              buf[64];
           enum mdoc_sec     sec;
   
           assert(MDOC_Sh == mdoc->last->tok);
   
           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.50
CVSweb