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

Diff for /mandoc/Attic/validate.c between version 1.8 and 1.38

version 1.8, 2008/12/30 13:43:53 version 1.38, 2009/01/17 20:10:36
Line 17 
Line 17 
  * PERFORMANCE OF THIS SOFTWARE.   * PERFORMANCE OF THIS SOFTWARE.
  */   */
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  
 #ifdef  __linux__  
 #include <time.h>  
 #endif  
   
 #include "private.h"  #include "private.h"
   
 /* FIXME: maxlineargs should be per LINE, no per TOKEN. */  typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);
 /* FIXME: prologue check should be in macro_call. */  typedef int     (*v_post)(struct mdoc *);
   
 #define _CC(p)  ((const char **)p)  /* FIXME: some sections should only occur in specific msecs. */
   /* FIXME: ignoring Pp. */
   /* FIXME: math symbols. */
   /* FIXME: make sure prologue is complete. */
   /* FIXME: valid character-escape checks. */
   
 static  int       scope_rewind_exp(struct mdoc *, int, int, int);  struct  valids {
 static  int       scope_rewind_imp(struct mdoc *, int, int);          v_pre   *pre;
 static  int       append_text(struct mdoc *, int,          v_post  *post;
                         int, int, char *[]);  };
 static  int       append_const(struct mdoc *, int, int, int, char *[]);  
 static  int       append_constarg(struct mdoc *, int, int,  
                          int, const struct mdoc_arg *);  
 static  int       append_scoped(struct mdoc *, int, int, int,  
                         const char *[], int, const struct mdoc_arg *);  
 static  int       append_delims(struct mdoc *, int, int *, char *);  
   
   /* Utility checks. */
   
 static int  static  int     pre_check_parent(struct mdoc *, struct mdoc_node *,
 append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf)                          int, enum mdoc_type);
 {  static  int     pre_check_msecs(struct mdoc *, struct mdoc_node *,
         int              c, lastarg;                          int, enum mdoc_msec *);
         char            *p;  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 *, int);
   static  int     post_check_children_gt(struct mdoc *, int);
   static  int     post_check_children_eq(struct mdoc *, int);
   
         if (0 == buf[*pos])  /* Specific pre-child-parse routines. */
                 return(1);  
   
         mdoc_msg(mdoc, *pos, "`%s' flushing punctuation",  static  int     pre_display(struct mdoc *, struct mdoc_node *);
                         mdoc_macronames[tok]);  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 *);
   
         for (;;) {  /* Specific post-child-parse routines. */
                 lastarg = *pos;  
                 c = mdoc_args(mdoc, tok, pos, buf, 0, &p);  
                 if (ARGS_ERROR == c)  
                         return(0);  
                 else if (ARGS_EOLN == c)  
                         break;  
                 assert(mdoc_isdelim(p));  
                 mdoc_word_alloc(mdoc, lastarg, p);  
         }  
   
         return(1);  static  int     herr_ge1(struct mdoc *);
 }  static  int     hwarn_ge1(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     bwarn_ge1(struct mdoc *);
   static  int     berr_eq0(struct mdoc *);
   static  int     ewarn_ge1(struct mdoc *);
   static  int     ebool(struct mdoc *);
   static  int     post_sh(struct mdoc *);
   static  int     post_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_root(struct mdoc *);
   
   /* Collections of pre-child-parse routines. */
   
 static int  static  v_pre   pres_prologue[] = { pre_prologue, NULL };
 scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok)  static  v_pre   pres_d1[] = { pre_display, NULL };
 {  static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
         struct mdoc_node *n;  static  v_pre   pres_bl[] = { pre_bl, NULL };
         int               t;  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 };
   
         n = mdoc->last ? mdoc->last->parent : NULL;  /* Collections of post-child-parse routines. */
   
         /* LINTED */  static  v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
         for ( ; n; n = n->parent) {  static  v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
                 if (MDOC_BLOCK != n->type)  static  v_post  posts_text[] = { eerr_ge1, NULL };
                         continue;  static  v_post  posts_wtext[] = { ewarn_ge1, NULL };
                 if (tok == (t = n->data.block.tok))  static  v_post  posts_notext[] = { eerr_eq0, NULL };
                         break;  static  v_post  posts_wline[] = { hwarn_ge1, berr_eq0, NULL };
                 if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags))  static  v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
                         continue;  static  v_post  posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };
                 return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK));  static  v_post  posts_it[] = { post_it, NULL };
         }  static  v_post  posts_ss[] = { herr_ge1, NULL };
   static  v_post  posts_pp[] = { ewarn_eq0, NULL };
   static  v_post  posts_d1[] = { herr_ge1, 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 };
   
         if (n) {  /* Per-macro pre- and post-child-check routine collections. */
                 mdoc->last = n;  
                 mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'",  
                                 mdoc_macronames[tok]);  
                 return(1);  
         }  
   
         mdoc_msg(mdoc, ppos, "scope: new implicit `%s'",  const   struct valids mdoc_valids[MDOC_MAX] = {
                         mdoc_macronames[tok]);          { NULL, NULL }, /* \" */
         return(1);          { pres_prologue, posts_text }, /* Dd */
 }          { pres_prologue, NULL }, /* Dt */
           { pres_prologue, NULL }, /* Os */
           /* FIXME: NAME section internal ordering. */
           { pres_sh, posts_sh }, /* Sh */
           { pres_ss, posts_ss }, /* Ss */
           { NULL, posts_pp }, /* Pp */
           { pres_d1, posts_d1 }, /* D1 */
           { pres_d1, posts_d1 }, /* 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, NULL }, /* Fd */
           { NULL, NULL }, /* Fl */
           { NULL, posts_text }, /* Fn */
           { NULL, NULL }, /* Ft */
           { NULL, posts_text }, /* Ic */
           { NULL, posts_wtext }, /* 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, NULL }, /* 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, NULL }, /* 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, NULL }, /* Fo */
           { NULL, NULL }, /* Fc */
           { NULL, NULL }, /* Oo */
           { NULL, NULL }, /* Oc */
           { NULL, NULL }, /* Bk */
           { NULL, NULL }, /* Ek */
           { NULL, posts_notext }, /* Bt */
           { NULL, NULL }, /* Hf */
           { NULL, NULL }, /* Fr */
           { NULL, posts_notext }, /* Ud */
   };
   
   
 static int  static int
 scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int dst)  post_check_children_count(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
           int               i;
   
         assert(mdoc->last);          for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                   /* Do nothing */ ;
           return(i);
   }
   
         /* LINTED */  
         for (n = mdoc->last->parent; n; n = n->parent) {  
                 if (MDOC_BLOCK != n->type)  
                         continue;  
                 if (dst == n->data.block.tok)  
                         break;  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK));  
         }  
   
         if (NULL == (mdoc->last = n))  static int
                 return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX));  post_check_children_gt(struct mdoc *mdoc, int sz)
   {
           int               i;
   
         mdoc_msg(mdoc, ppos, "scope: rewound explicit `%s' to `%s'",          if ((i = post_check_children_count(mdoc)) > sz)
                         mdoc_macronames[tok], mdoc_macronames[dst]);                  return(1);
           return(mdoc_err(mdoc, "macro requires more than %d "
         return(1);                                  "parameters (have %d)", sz, i));
 }  }
   
   
 static int  static int
 append_constarg(struct mdoc *mdoc, int tok, int pos,  post_check_children_eq(struct mdoc *mdoc, int sz)
                 int argc, const struct mdoc_arg *argv)  
 {  {
           int               i;
   
         switch (tok) {          if ((i = post_check_children_count(mdoc)) == sz)
         default:                  return(1);
                 break;          return(mdoc_err(mdoc, "macro requires %d parameters "
         }                                  "(have %d)", sz, i));
   
         mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL);  
         return(1);  
 }  }
   
   
 /*  
  * Append a node with implicit or explicit scoping ONLY.  ALL macros  
  * with the implicit- or explicit-scope callback must be included here.  
  */  
 static int  static int
 append_scoped(struct mdoc *mdoc, int tok, int pos,  post_check_children_lt(struct mdoc *mdoc, int sz)
                 int sz, const char *args[],  
                 int argc, const struct mdoc_arg *argv)  
 {  {
         enum mdoc_sec     sec;          int               i;
         struct mdoc_node *node;  
   
         switch (tok) {          if ((i = post_check_children_count(mdoc)) < sz)
          /* ======= ADD MORE MACRO CHECKS BELOW. ======= */                  return(1);
           return(mdoc_err(mdoc, "macro requires less than %d "
                                   "parameters (have %d)", sz, i));
   }
   
         case (MDOC_Sh):  
                 /*  
                  * Check rules for section ordering.  We can have  
                  * "known" sections (like NAME and so on) and "custom"  
                  * sections, which are unknown.  If we have a known  
                  * section, we should fall within the conventional  
                  * section order.  
                  */  
                 if (0 == sz)  
                         return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));  
   
                 sec = mdoc_atosec((size_t)sz, _CC(args));  static int
                 if (SEC_CUSTOM != sec && sec < mdoc->sec_lastn)  pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
                         if ( ! mdoc_warn(mdoc, tok, pos, WARN_SEC_OO))  {
                                 return(0);  
   
                 if (SEC_BODY == mdoc->sec_last && SEC_NAME != sec)          if (1 == node->data.elem.argc &&
                         return(mdoc_err(mdoc, tok, pos, ERR_SEC_NAME));                          MDOC_Std == node->data.elem.argv[0].arg)
                 if (SEC_CUSTOM != sec)                  return(1);
                         mdoc->sec_lastn = sec;          return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
                 mdoc->sec_last = sec;                                  "macro suggests single `%s' argument",
                 break;                                  mdoc_argnames[MDOC_Std]));
   }
   
         case (MDOC_Ss):  
                 if (0 != sz)  
                         break;  
                 return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));  
   
         case (MDOC_Bd):  
                 /*  
                  * We can't be nested within any other block displays  
                  * (or really any other kind of display, although Bd is  
                  * the only multi-line one that will show up).  
                  */  
                 assert(mdoc->last);  
                 node = mdoc->last->parent;  
                 /* LINTED */  
                 for ( ; node; node = node->parent) {  
                         if (node->type != MDOC_BLOCK)  
                                 continue;  
                         if (node->data.block.tok != MDOC_Bd)  
                                 continue;  
                         break;  
                 }  
                 if (NULL == node)  
                         break;  
                 return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST));  
   
         case (MDOC_Bl):  static int
                 break;  pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node,
                   int sz, enum mdoc_msec *msecs)
   {
           int              i;
   
          /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */          for (i = 0; i < sz; i++)
         default:                  if (msecs[i] == mdoc->meta.msec)
                 abort();                          return(1);
                 /* NOTREACHED */          return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not "
         }                                  "appropriate for manual section"));
   }
   
         mdoc_block_alloc(mdoc, pos, tok, (size_t)argc, argv);  
         mdoc_head_alloc(mdoc, pos, tok, (size_t)sz, _CC(args));  static int
         mdoc_body_alloc(mdoc, pos, tok);  pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,
                   int tok, enum mdoc_type type)
   {
   
           if (type != node->parent->type)
                   return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s",
                                           mdoc_type2a(node->parent->type),
                                           mdoc_type2a(type)));
           if (MDOC_ROOT != type && tok != node->parent->tok)
                   return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'",
                                           mdoc_macronames[node->parent->tok],
                                           mdoc_macronames[tok]));
         return(1);          return(1);
 }  }
   
   
 static int  static int
 append_const(struct mdoc *mdoc, int tok,  berr_eq0(struct mdoc *mdoc)
                 int pos, int sz, char *args[])  
 {  {
   
         switch (tok) {          if (MDOC_BODY != mdoc->last->type)
          /* ======= ADD MORE MACRO CHECKS BELOW. ======= */                  return(1);
           if (NULL == mdoc->last->child)
                   return(1);
           return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));
   }
   
         /* FIXME: this is the ugliest part of this page. */  
         case (MDOC_At):  
                 /* This needs special handling. */  
                 if (0 == sz)  
                         break;  
                 else if (sz > 2)  
                         return(mdoc_err(mdoc, tok, pos, ERR_ARGS_LE2));  
   
                 if (ATT_DEFAULT != mdoc_atoatt(args[0])) {  static int
                         mdoc_elem_alloc(mdoc, pos, tok, 0,  bwarn_ge1(struct mdoc *mdoc)
                                         NULL, 1, _CC(&args[0]));  {
                 } else {  
                         mdoc_elem_alloc(mdoc, pos, tok,  
                                         0, NULL, 0, NULL);  
                         if (mdoc_isdelim(args[0]))  
                                 return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT));  
                         mdoc_word_alloc(mdoc, pos, args[0]);  
                 }  
   
                 if (1 == sz)          if (MDOC_BODY != mdoc->last->type)
                         return(1);  
                 if (mdoc_isdelim(args[1]))  
                         return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT));  
                 mdoc_word_alloc(mdoc, pos, args[1]);  
                 return(1);                  return(1);
           if (mdoc->last->child)
                   return(1);
           return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));
   }
   
         case (MDOC_Nd):  
                 if (sz > 0)  
                         break;  
                 if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1))  
                         return(0);  
                 break;  
   
         case (MDOC_Hf):  
                 if (1 == sz)  
                         break;  
                 return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ1));  
   
         case (MDOC_Bx):  static int
                 /* FALLTHROUGH */  ewarn_eq0(struct mdoc *mdoc)
         case (MDOC_Bsx):  {
                 /* FALLTHROUGH */  
         case (MDOC_Os):  
                 /* FALLTHROUGH */  
         case (MDOC_Fx):  
                 /* FALLTHROUGH */  
         case (MDOC_Nx):  
                 assert(sz <= 1);  
                 break;  
   
         case (MDOC_Ux):          assert(MDOC_ELEM == mdoc->last->type);
                 assert(0 == sz);          if (NULL == mdoc->last->child)
                 break;                  return(1);
           return(mdoc_pwarn(mdoc, mdoc->last->child->line,
                           mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));
   }
   
         case (MDOC_Bt):  
                 /* FALLTHROUGH */  
         case (MDOC_Ud):  
                 if (0 == sz)  
                         break;  
                 return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ0));  
   
          /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */  static int
         default:  ewarn_ge1(struct mdoc *mdoc)
                 abort();  {
                 /* NOTREACHED */  
         }  
   
         mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args));          assert(MDOC_ELEM == mdoc->last->type);
         return(1);          if (mdoc->last->child)
                   return(1);
           return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
 }  }
   
   
 static int  static int
 append_text(struct mdoc *mdoc, int tok,  eerr_eq1(struct mdoc *mdoc)
                 int pos, int sz, char *args[])  
 {  {
   
         switch (tok) {          assert(MDOC_ELEM == mdoc->last->type);
          /* ======= ADD MORE MACRO CHECKS BELOW. ======= */          return(post_check_children_eq(mdoc, 1));
         case (MDOC_Pp):  }
                 if (0 == sz)  
                         break;  
                 if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0))  
                         return(0);  
                 break;  
   
         case (MDOC_Ft):  
                 /* FALLTHROUGH */  
         case (MDOC_Li):  
                 /* FALLTHROUGH */  
         case (MDOC_Ms):  
                 /* FALLTHROUGH */  
         case (MDOC_Pa):  
                 /* FALLTHROUGH */  
         case (MDOC_Tn):  
                 if (0 < sz)  
                         break;  
                 if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1))  
                         return(0);  
                 break;  
   
         case (MDOC_Ar):  static int
                 /* FALLTHROUGH */  eerr_le2(struct mdoc *mdoc)
         case (MDOC_Cm):  {
                 /* FALLTHROUGH */  
         case (MDOC_Fl):  
                 /* These can have no arguments. */  
                 break;  
   
         case (MDOC_Ad):          assert(MDOC_ELEM == mdoc->last->type);
                 /* FALLTHROUGH */          return(post_check_children_lt(mdoc, 3));
         case (MDOC_Em):  
                 /* FALLTHROUGH */  
         case (MDOC_Er):  
                 /* FALLTHROUGH */  
         case (MDOC_Ev):  
                 /* FALLTHROUGH */  
         case (MDOC_Fa):  
                 /* FALLTHROUGH */  
         case (MDOC_Dv):  
                 /* FALLTHROUGH */  
         case (MDOC_Ic):  
                 /* FALLTHROUGH */  
         case (MDOC_Sy):  
                 /* FALLTHROUGH */  
         case (MDOC_Sx):  
                 /* FALLTHROUGH */  
         case (MDOC_Va):  
                 /* FALLTHROUGH */  
         case (MDOC_Vt):  
                 if (0 < sz)  
                         break;  
                 return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));  
          /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args));  
         return(1);  
 }  }
   
   
 int  static int
 macro_text(MACRO_PROT_ARGS)  eerr_le1(struct mdoc *mdoc)
 {  {
         int               lastarg, lastpunct, c, j;  
         char             *args[MDOC_LINEARG_MAX];  
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          assert(MDOC_ELEM == mdoc->last->type);
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));          return(post_check_children_lt(mdoc, 2));
   }
   
         /* Token pre-processing.  */  
   
         switch (tok) {  static int
         case (MDOC_Pp):  eerr_eq0(struct mdoc *mdoc)
                 /* `.Pp' ignored when following `.Sh' or `.Ss'. */  {
                 assert(mdoc->last);  
                 if (MDOC_BODY != mdoc->last->type)  
                         break;  
                 switch (mdoc->last->data.body.tok) {  
                 case (MDOC_Ss):  
                         /* FALLTHROUGH */  
                 case (MDOC_Sh):  
                         if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_AFTER_BLK))  
                                 return(0);  
                         return(1);  
                 default:  
                         break;  
                 }  
                 break;  
         default:  
                 break;  
         }  
   
         /* Process line parameters. */          assert(MDOC_ELEM == mdoc->last->type);
           return(post_check_children_eq(mdoc, 0));
   }
   
         j = 0;  
         lastarg = ppos;  
         lastpunct = 0;  
   
 again:  static int
         if (j == MDOC_LINEARG_MAX)  eerr_ge1(struct mdoc *mdoc)
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  {
   
         /*          assert(MDOC_ELEM == mdoc->last->type);
          * Parse out the next argument, unquoted and unescaped.   If          return(post_check_children_gt(mdoc, 0));
          * we're a word (which may be punctuation followed eventually by  }
          * a real word), then fall into checking for callables.  If  
          * only punctuation remains and we're the first, then flush  
          * arguments, punctuation and exit; else, return to the caller.  
          */  
   
         lastarg = *pos;  
   
         switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &args[j])) {  static int
         case (ARGS_ERROR):  herr_eq0(struct mdoc *mdoc)
                 return(0);  {
         case (ARGS_WORD):  
                 break;  
         case (ARGS_PUNCT):  
                 if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))  
                         return(0);  
                 if (ppos > 1)  
                         return(1);  
                 return(append_delims(mdoc, tok, pos, buf));  
         case (ARGS_EOLN):  
                 if (lastpunct)  
                         return(1);  
                 return(append_text(mdoc, tok, ppos, j, args));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         /*          if (MDOC_HEAD != mdoc->last->type)
          * Command found.  First flush out arguments, then call the                  return(1);
          * command.  If we're the line macro when it exits, flush          return(post_check_children_eq(mdoc, 0));
          * terminal punctuation.  }
          */  
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, args[j]))) {  
                 if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))  
                         return(0);  
                 if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))  
                         return(0);  
                 if (ppos > 1)  
                         return(1);  
                 return(append_delims(mdoc, tok, pos, buf));  
         }  
   
         /* Word/non-term-punctuation found. */  static int
   hwarn_ge1(struct mdoc *mdoc)
   {
   
         if ( ! mdoc_isdelim(args[j])) {          if (MDOC_HEAD != mdoc->last->type)
                 /* Words are appended to the array of arguments. */                  return(1);
                 j++;          if (mdoc->last->child)
                 lastpunct = 0;                  return(1);
                 goto again;          return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
         }  }
   
         /*  
          * For punctuation, flush all collected words, then flush  
          * punctuation, then start collecting again.   Of course, this  
          * is non-terminal punctuation.  
          */  
   
         if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))  static int
                 return(0);  herr_ge1(struct mdoc *mdoc)
   {
   
         mdoc_word_alloc(mdoc, lastarg, args[j]);          if (MDOC_HEAD != mdoc->last->type)
         j = 0;                  return(1);
         lastpunct = 1;          return(post_check_children_gt(mdoc, 0));
   
         goto again;  
         /* NOTREACHED */  
 }  }
   
   
 int  static int
 macro_prologue_dtitle(MACRO_PROT_ARGS)  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int               lastarg, j;          struct mdoc_node *n;
         char             *args[MDOC_LINEARG_MAX];  
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          if (MDOC_BLOCK != node->type)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));                  return(1);
         if (0 == mdoc->meta.date)  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));  
         if (mdoc->meta.title[0])  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));  
   
         j = -1;          assert(mdoc->last);
         lastarg = ppos;          /* 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"));
   }
   
 again:  
         if (j == MDOC_LINEARG_MAX)  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  
   
         lastarg = *pos;  static int
   pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
   {
           int              type, err;
           struct mdoc_arg *argv;
           size_t           i, argc;
   
         switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) {          if (MDOC_BLOCK != node->type)
         case (ARGS_EOLN):  
                 if (mdoc->meta.title)  
                         return(1);  
                 if ( ! mdoc_warn(mdoc, tok, ppos, WARN_ARGS_GE1))  
                         return(0);  
                 (void)xstrlcpy(mdoc->meta.title,  
                                 "UNTITLED", META_TITLE_SZ);  
                 return(1);                  return(1);
         case (ARGS_ERROR):          assert(MDOC_Bl == node->tok);
                 return(0);  
         default:          argv = NULL;
                 break;          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"));
   }
   
         if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn  
                         (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))  
                 return(0);  
   
         if (0 == j) {  static int
                 if (xstrlcpy(mdoc->meta.title, args[0], META_TITLE_SZ))  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
                         goto again;  {
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));          int              type, err;
           struct mdoc_arg *argv;
           size_t           i, argc;
   
         } else if (1 == j) {          if (MDOC_BLOCK != node->type)
                 mdoc->meta.msec = mdoc_atomsec(args[1]);                  return(1);
                 if (MSEC_DEFAULT != mdoc->meta.msec)          assert(MDOC_Bd == node->tok);
                         goto again;  
                 return(mdoc_err(mdoc, tok, -1, ERR_SYNTAX_ARGFORM));  
   
         } else if (2 == j) {          argv = NULL;
                 mdoc->meta.vol = mdoc_atovol(args[2]);          argc = node->data.block.argc;
                 if (VOL_DEFAULT != mdoc->meta.vol)  
                         goto again;  
                 mdoc->meta.arch = mdoc_atoarch(args[2]);  
                 if (ARCH_DEFAULT != mdoc->meta.arch)  
                         goto again;  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));  
         }  
   
         return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));          /* LINTED */
           for (err = i = type = 0; 0 == err && i < argc; i++) {
                   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"));
 }  }
   
   
 int  static int
 macro_prologue_os(MACRO_PROT_ARGS)  pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int               lastarg, j;  
         char             *args[MDOC_LINEARG_MAX];  
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          if (MDOC_BLOCK != node->type)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));                  return(1);
         if (0 == mdoc->meta.title[0])          return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));  }
         if (mdoc->meta.os[0])  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));  
   
         j = -1;  
         lastarg = ppos;  
   
 again:  static int
         if (j == MDOC_LINEARG_MAX)  pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  {
   
         lastarg = *pos;          if (MDOC_BLOCK != node->type)
   
         switch (mdoc_args(mdoc, tok, pos, buf,  
                                 ARGS_QUOTED, &args[++j])) {  
         case (ARGS_EOLN):  
                 mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;  
                 return(1);                  return(1);
         case (ARGS_ERROR):          return(pre_check_parent(mdoc, node, -1, MDOC_ROOT));
                 return(0);  
         default:  
                 break;  
         }  
   
         if ( ! xstrlcat(mdoc->meta.os, args[j], sizeof(mdoc->meta.os)))  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));  
         if ( ! xstrlcat(mdoc->meta.os, " ", sizeof(mdoc->meta.os)))  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));  
   
         goto again;  
         /* NOTREACHED */  
 }  }
   
   
 int  static int
 macro_prologue_ddate(MACRO_PROT_ARGS)  pre_st(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int               lastarg, j;  
         char             *args[MDOC_LINEARG_MAX], date[64];  
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          assert(MDOC_ELEM == node->type);
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));          assert(MDOC_St == node->tok);
         if (mdoc->meta.title[0])          if (1 == node->data.elem.argc)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));                  return(1);
         if (mdoc->meta.date)          return(mdoc_nerr(mdoc, node, "macro must have one argument"));
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));  }
   
         j = -1;  
         date[0] = 0;  
         lastarg = ppos;  
   
 again:  static int
         if (j == MDOC_LINEARG_MAX)  pre_an(struct mdoc *mdoc, struct mdoc_node *node)
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  {
   
         lastarg = *pos;          assert(MDOC_ELEM == node->type);
         switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) {          assert(MDOC_An == node->tok);
         case (ARGS_EOLN):          if (1 >= node->data.elem.argc)
                 if (mdoc->meta.date)                  return(1);
                         return(1);          return(mdoc_nerr(mdoc, node, "macro may only have one argument"));
                 mdoc->meta.date = mdoc_atotime(date);  }
                 if (mdoc->meta.date)  
                         return(1);  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SYNTAX_ARGFORM));  
         case (ARGS_ERROR):  
                 return(0);  
         default:  
                 break;  
         }  
   
         if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn  
                         (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))  
                 return(0);  
   
         if (0 == j) {  
                 if (xstrcmp("$Mdocdate$", args[j])) {  
                         mdoc->meta.date = time(NULL);  
                         goto again;  
                 } else if (xstrcmp("$Mdocdate:", args[j]))  
                         goto again;  
         } else if (4 == j)  
                 if ( ! xstrcmp("$", args[j]))  
                         goto again;  
   
         if ( ! xstrlcat(date, args[j], sizeof(date)))  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));  
         if ( ! xstrlcat(date, " ", sizeof(date)))  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));  
   
         goto again;  static int
         /* NOTREACHED */  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(pre_check_stdarg(mdoc, node));
 }  }
   
   
 int  static int
 macro_scoped_explicit(MACRO_PROT_ARGS)  pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         int               c, lastarg, j;          enum mdoc_msec   msecs[3];
         struct mdoc_arg   argv[MDOC_LINEARG_MAX];  
         struct mdoc_node *n;  
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          assert(MDOC_ELEM == node->type);
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));          assert(MDOC_Ex == node->tok);
   
         /*          msecs[0] = MSEC_1;
          * First close out the explicit scope.  The `end' tags (such as          msecs[1] = MSEC_6;
          * `.El' to `.Bl' don't cause anything to happen: we merely          msecs[2] = MSEC_8;
          * readjust our last parse point.          if ( ! pre_check_msecs(mdoc, node, 3, msecs))
          */                  return(0);
           return(pre_check_stdarg(mdoc, node));
   }
   
         switch (tok) {  
         case (MDOC_El):  
                 return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bl));  
         case (MDOC_Ed):  
                 return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bd));  
         default:  
                 break;  
         }  
   
         assert(MDOC_EXPLICIT & mdoc_macros[tok].flags);  static int
   pre_er(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec   msecs[1];
   
         /* Token pre-processing. */          msecs[0] = MSEC_2;
           return(pre_check_msecs(mdoc, node, 1, msecs));
   }
   
         switch (tok) {  
         case (MDOC_Bl):  
                 /* FALLTHROUGH */  
         case (MDOC_Bd):  
                 /* `.Pp' ignored when preceding `.Bl' or `.Bd'. */  
                 assert(mdoc->last);  
                 if (MDOC_ELEM != mdoc->last->type)  
                         break;  
                 if (MDOC_Pp != mdoc->last->data.elem.tok)  
                         break;  
                 if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK))  
                         return(0);  
                 assert(mdoc->last->prev);  
                 n = mdoc->last;  
                 mdoc->last = mdoc->last->prev;  
                 mdoc->last->next = NULL;  
                 mdoc_node_free(n);  
                 break;  
         default:  
                 break;  
         }  
   
         lastarg = *pos;  static int
   pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
   {
           enum mdoc_msec   msecs[1];
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          msecs[0] = MSEC_4;
                 lastarg = *pos;          return(pre_check_msecs(mdoc, node, 1, msecs));
                 c = mdoc_argv(mdoc, tok, &argv[j], pos, buf);  }
                 if (0 == c)  
                         break;  
                 else if (1 == c)  
                         continue;  
   
                 mdoc_argv_free(j, argv);  
                 return(0);  
         }  
   
         if (MDOC_LINEARG_MAX == j) {  static int
                 mdoc_argv_free(j, argv);  pre_it(struct mdoc *mdoc, struct mdoc_node *node)
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  {
         }  
   
         c = append_scoped(mdoc, tok, ppos, 0, NULL, j, argv);          if (MDOC_BLOCK != node->type)
         mdoc_argv_free(j, argv);                  return(1);
         return(c);          return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));
 }  }
   
   
 /*  static int
  * Implicity-scoped macros, like `.Ss', have a scope that terminates  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
  * with a subsequent call to the same macro.  Implicit macros cannot  
  * break the scope of explicitly-scoped macros; however, they can break  
  * the scope of other implicit macros (so `.Sh' can break `.Ss').  This  
  * is ok with macros like `.It' because they exist only within an  
  * explicit context.  
  *  
  * These macros put line arguments (which it's allowed to have) into the  
  * HEAD section and open a BODY scope to be used until the macro scope  
  * closes.  
  */  
 int  
 macro_scoped_implicit(MACRO_PROT_ARGS)  
 {  {
         int               lastarg, j;  
         char             *args[MDOC_LINEARG_MAX];  
         struct mdoc_node *n;  
   
         assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));          if (SEC_PROLOGUE != mdoc->sec_lastn)
                   return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
           assert(MDOC_ELEM == node->type);
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          /* Check for ordering. */
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));  
   
         /* Token pre-processing. */          switch (node->tok) {
           case (MDOC_Os):
         switch (tok) {                  if (mdoc->meta.title && mdoc->meta.date)
         case (MDOC_Ss):  
                 /* FALLTHROUGH */  
         case (MDOC_Sh):  
                 /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */  
                 if (NULL == mdoc->last)  
                         break;                          break;
                 if (MDOC_ELEM != mdoc->last->type)                  return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
           case (MDOC_Dt):
                   if (NULL == mdoc->meta.title && mdoc->meta.date)
                         break;                          break;
                 if (MDOC_Pp != mdoc->last->data.elem.tok)                  return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
           case (MDOC_Dd):
                   if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
                         break;                          break;
                 if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK))                  return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
                         return(0);  
                 assert(mdoc->last->prev);  
                 n = mdoc->last;  
                 mdoc_msg(mdoc, ppos, "removing prior `Pp' macro");  
                 mdoc->last = mdoc->last->prev;  
                 mdoc->last->next = NULL;  
                 mdoc_node_free(n);  
                 break;  
         default:          default:
                 break;                  abort();
                   /* NOTREACHED */
         }          }
   
         /* Rewind our scope. */          /* Check for repetition. */
   
         if ( ! scope_rewind_imp(mdoc, ppos, tok))          switch (node->tok) {
                 return(0);          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 */
           }
   
         j = 0;          return(mdoc_nerr(mdoc, node, "prologue macro repeated"));
         lastarg = ppos;  }
   
         /*  
          * Process until we hit a line.  Note that current implicit  
          * macros don't have any arguments, so we don't need to do any  
          * argument processing.  
          */  
   
 again:  static int
         if (j == MDOC_LINEARG_MAX)  post_nm(struct mdoc *mdoc)
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  {
   
         lastarg = *pos;          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]));
   }
   
         switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) {  
         case (ARGS_ERROR):  
                 return(0);  
         case (ARGS_EOLN):  
                 return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL));  
         default:  
                 break;  
         }  
   
         if (MDOC_MAX != mdoc_find(mdoc, args[j]))  static int
                 if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))  post_xr(struct mdoc *mdoc)
                         return(0);  {
           struct mdoc_node *n;
   
         j++;          assert(MDOC_ELEM == mdoc->last->type);
         goto again;          assert(MDOC_Xr == mdoc->last->tok);
         /* NOTREACHED */          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
  * A line-scoped macro opens a scope for the contents of its line, which  post_at(struct mdoc *mdoc)
  * are placed under the HEAD node.  Punctuation trailing the line is put  
  * as a sibling to the HEAD node, under the BLOCK node.  
  */  
 int  
 macro_scoped_line(MACRO_PROT_ARGS)  
 {  {
         int               lastarg, c, j;  
         char              *p;  
         struct mdoc_node  *n;  
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          assert(MDOC_ELEM == mdoc->last->type);
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));          assert(MDOC_At == mdoc->last->tok);
   
         assert(1 == ppos);          if (NULL == mdoc->last->child)
                   return(1);
         /* Token pre-processing.  */          assert(MDOC_TEXT == mdoc->last->child->type);
   
         switch (tok) {          if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
         case (MDOC_D1):                  return(1);
                 /* FALLTHROUGH */          return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol"));
         case (MDOC_Dl):  }
                 /* These can't be nested in a display block. */  
                 assert(mdoc->last);  
                 for (n = mdoc->last->parent ; n; n = n->parent)  
                         if (MDOC_BLOCK != n->type)  
                                 continue;  
                         else if (MDOC_Bd == n->data.block.tok)  
                                 break;  
                 if (NULL == n)  
                         break;  
                 return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NONEST));  
         default:  
                 break;  
         }  
   
         /*  
          * All line-scoped macros have a HEAD and optionally a BODY  
          * section.  We open our scope here; when we exit this function,  
          * we'll rewind our scope appropriately.  
          */  
   
         mdoc_block_alloc(mdoc, ppos, tok, 0, NULL);  static int
         mdoc_head_alloc(mdoc, ppos, tok, 0, NULL);  post_an(struct mdoc *mdoc)
   {
   
         /* Process line parameters. */          assert(MDOC_ELEM == mdoc->last->type);
           assert(MDOC_An == mdoc->last->tok);
   
         j = 0;          if (0 != mdoc->last->data.elem.argc) {
         lastarg = ppos;                  if (NULL == mdoc->last->child)
                           return(1);
                   return(mdoc_err(mdoc, "macro expects either argument or parameters"));
           }
   
 again:          if (mdoc->last->child)
         if (j == MDOC_LINEARG_MAX)                  return(1);
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));          return(mdoc_err(mdoc, "macro expects either argument or parameters"));
   }
   
         lastarg = *pos;  
         c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p);  
   
         switch (c) {  static int
         case (ARGS_ERROR):  post_ex(struct mdoc *mdoc)
                 return(0);  {
         case (ARGS_WORD):  
                 break;  
         case (ARGS_PUNCT):  
                 if ( ! append_delims(mdoc, tok, pos, buf))  
                         return(0);  
                 return(scope_rewind_imp(mdoc, ppos, tok));  
         case (ARGS_EOLN):  
                 return(scope_rewind_imp(mdoc, ppos, tok));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {          assert(MDOC_ELEM == mdoc->last->type);
                 if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))          assert(MDOC_Ex == mdoc->last->tok);
                         return(0);  
                 if ( ! append_delims(mdoc, tok, pos, buf))  
                         return(0);  
                 return(scope_rewind_imp(mdoc, ppos, tok));  
         }  
   
         if (mdoc_isdelim(p))          if (0 == mdoc->last->data.elem.argc) {
                 j = 0;                  if (mdoc->last->child)
                           return(1);
         mdoc_word_alloc(mdoc, lastarg, p);                  return(mdoc_err(mdoc, "macro expects `%s' or a single child",
         goto again;                                          mdoc_argnames[MDOC_Std]));
         /* NOTREACHED */          }
           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. */
  * Partial-line scope is identical to line scope (macro_scoped_line())  static int
  * except that trailing punctuation is appended to the BLOCK, instead of  post_it(struct mdoc *mdoc)
  * contained within the HEAD.  
  */  
 int  
 macro_scoped_pline(MACRO_PROT_ARGS)  
 {  {
         int               lastarg, c, j;          int               type, sv;
         char              *p;  #define TYPE_NONE        (0)
   #define TYPE_BODY        (1)
   #define TYPE_HEAD        (2)
           size_t            i, argc;
           struct mdoc_node *n;
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          if (MDOC_BLOCK != mdoc->last->type)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));                  return(1);
   
         /* Token pre-processing.  */          assert(MDOC_It == mdoc->last->tok);
   
         switch (tok) {          n = mdoc->last->parent;
         case (MDOC_Ql):          assert(n);
                 if ( ! mdoc_warn(mdoc, tok, ppos, WARN_COMPAT_TROFF))          assert(MDOC_Bl == n->tok);
                         return(0);  
                 break;  
         default:  
                 break;  
         }  
   
         mdoc_block_alloc(mdoc, ppos, tok, 0, NULL);          n = n->parent;
         mdoc_head_alloc(mdoc, ppos, tok, 0, NULL);          assert(MDOC_BLOCK == n->type);
           assert(MDOC_Bl == n->tok);
   
         /* Process line parameters. */          argc = n->data.block.argc;
           type = TYPE_NONE;
           sv = -1;
   
           /* Some types require block-head, some not. */
   
         j = 0;          /* LINTED */
         lastarg = ppos;          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):
                           /* FALLTHROUGH */
                   case (MDOC_Column):
                           type = TYPE_BODY;
                           sv = n->data.block.argv[(int)i].arg;
                           break;
                   default:
                           break;
                   }
   
 again:          assert(TYPE_NONE != type);
         if (j == MDOC_LINEARG_MAX)  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  
   
         lastarg = *pos;          if (TYPE_HEAD == type) {
         c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p);                  n = mdoc->last->data.block.head;
                   assert(n);
                   if (NULL == n->child)
                           if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
                                   return(0);
   
         switch (c) {                  n = mdoc->last->data.block.body;
         case (ARGS_ERROR):                  assert(n);
                 return(0);                  if (NULL == n->child)
         case (ARGS_WORD):                          if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
                 break;                                  return(0);
         case (ARGS_PUNCT):  
                 if ( ! scope_rewind_imp(mdoc, ppos, tok))                  return(1);
                         return(0);  
                 if (ppos > 1)  
                         return(1);  
                 return(append_delims(mdoc, tok, pos, buf));  
         case (ARGS_EOLN):  
                 return(scope_rewind_imp(mdoc, ppos, tok));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {          assert(TYPE_BODY == type);
                 if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))          assert(mdoc->last->data.block.head);
   
           n = mdoc->last->data.block.head;
           assert(n);
           if (n->child)
                   if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters"))
                         return(0);                          return(0);
                 if ( ! scope_rewind_imp(mdoc, ppos, tok))  
           n = mdoc->last->data.block.body;
           assert(n);
           if (NULL == n->child)
                   if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
                         return(0);                          return(0);
                 if (ppos > 1)  
                         return(1);  
                 return(append_delims(mdoc, tok, pos, buf));  
         }  
   
         if (mdoc_isdelim(p))          assert(-1 != sv);
                 j = 0;          if (MDOC_Column != sv)
                   return(1);
   
         mdoc_word_alloc(mdoc, lastarg, p);          /* Make sure the number of columns is sane. */
         goto again;  
         /* NOTREACHED */  
 }  
   
           argc = mdoc->last->parent->parent->data.block.argv->sz;
           n = mdoc->last->data.block.head->child;
   
 /*          for (i = 0; n; n = n->next)
  * A delimited-constant macro is similar to a general text macro: the                  i++;
  * macro is followed by a 0 or 1 arguments (possibly-unspecified) then  
  * terminating punctuation, other words, or another callable macro.  
  */  
 int  
 macro_constant_delimited(MACRO_PROT_ARGS)  
 {  
         int               lastarg, flushed, c, maxargs;  
         char             *p;  
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          if (i == argc)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));                  return(1);
           return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i));
   #undef  TYPE_NONE
   #undef  TYPE_BODY
   #undef  TYPE_HEAD
   }
   
         /* Process line parameters. */  
   
         lastarg = ppos;  static int
         flushed = 0;  post_bl(struct mdoc *mdoc)
   {
           struct mdoc_node *n;
   
         /* Token pre-processing. */          if (MDOC_BODY != mdoc->last->type)
                   return(1);
           assert(MDOC_Bl == mdoc->last->tok);
   
         switch (tok) {          /* LINTED */
         case (MDOC_Ux):          for (n = mdoc->last->child; n; n = n->next) {
                 maxargs = 0;                  if (MDOC_BLOCK == n->type)
                           if (MDOC_It == n->tok)
                                   continue;
                 break;                  break;
         default:  
                 maxargs = 1;  
                 break;  
         }          }
           if (NULL == n)
                   return(1);
           return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
   }
   
 again:  
         lastarg = *pos;  
   
         switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) {  static int
         case (ARGS_ERROR):  ebool(struct mdoc *mdoc)
                 return(0);  {
         case (ARGS_WORD):          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;                  break;
         case (ARGS_PUNCT):  
                 if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p))  
                         return(0);  
                 if (ppos > 1)  
                         return(1);  
                 return(append_delims(mdoc, tok, pos, buf));  
         case (ARGS_EOLN):  
                 if (flushed)  
                         return(1);  
                 return(append_const(mdoc, tok, ppos, 0, &p));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
           if (NULL == n)
                   return(1);
           return(mdoc_nerr(mdoc, n, "expected boolean value"));
   }
   
         /* Accepts no arguments: flush out symbol and continue. */  
   
         if (0 == maxargs) {  static int
                 if ( ! append_const(mdoc, tok, ppos, 0, &p))  post_root(struct mdoc *mdoc)
                         return(0);  {
                 flushed = 1;  
         }  
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {          if (NULL == mdoc->last->child)
                 if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p))                  return(mdoc_err(mdoc, "document has no data"));
                         return(0);          if (NULL == mdoc->meta.title)
                 if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))                  return(mdoc_err(mdoc, "document has no incomplete prologue"));
                         return(0);          if (NULL == mdoc->meta.os)
                 if (ppos > 1)                  return(mdoc_err(mdoc, "document has no incomplete prologue"));
                         return(1);          if (0 == mdoc->meta.date)
                 return(append_delims(mdoc, tok, pos, buf));                  return(mdoc_err(mdoc, "document has no incomplete prologue"));
         }          return(1);
   
         /*  
          * We only accept one argument; subsequent tokens are considered  
          * as literal words (until a macro).  
          */  
   
         if ( ! flushed && ! mdoc_isdelim(p)) {  
                if ( ! append_const(mdoc, tok, ppos, 1, &p))  
                         return(0);  
                 flushed = 1;  
                 goto again;  
         } else if ( ! flushed) {  
                 if ( ! append_const(mdoc, tok, ppos, 0, &p))  
                         return(0);  
                 flushed = 1;  
         }  
   
         mdoc_word_alloc(mdoc, lastarg, p);  
         goto again;  
         /* NOTREACHED */  
 }  }
   
   
 int  /* Warn if conventional sections are out of order. */
 macro_constant(MACRO_PROT_ARGS)  static int
   post_sh(struct mdoc *mdoc)
 {  {
         int               lastarg, j;          char              buf[64];
         char             *args[MDOC_LINEARG_MAX];          enum mdoc_sec     sec;
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          if (MDOC_HEAD != mdoc->last->type)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));                  return(1);
           assert(MDOC_Sh == mdoc->last->tok);
   
         j = 0;          if ( ! xstrlcats(buf, mdoc->last->child, 64))
         lastarg = ppos;                  return(mdoc_err(mdoc, "macro parameters too long"));
   
 again:          if (SEC_CUSTOM == (sec = mdoc_atosec(buf)))
         if (j == MDOC_LINEARG_MAX)                  return(1);
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));          if (sec > mdoc->sec_lastn)
                   return(1);
           if (sec == mdoc->sec_lastn)
                   return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated"));
           return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order"));
   }
   
         lastarg = *pos;  
   
         switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) {  int
         case (ARGS_ERROR):  mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
                 return(0);  {
         case (ARGS_WORD):          v_pre           *p;
                 break;  
         case (ARGS_EOLN):  
                 return(append_const(mdoc, tok, ppos, j, args));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         if (MDOC_MAX != mdoc_find(mdoc, args[j]))          if (MDOC_TEXT == node->type)
                 if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))                  return(1);
                         return(0);          assert(MDOC_ROOT != node->type);
   
         j++;          if (NULL == mdoc_valids[node->tok].pre)
         goto again;                  return(1);
         /* NOTREACHED */          for (p = mdoc_valids[node->tok].pre; *p; p++)
                   if ( ! (*p)(mdoc, node))
                           return(0);
           return(1);
 }  }
   
   
 int  int
 macro_constant_argv(MACRO_PROT_ARGS)  mdoc_valid_post(struct mdoc *mdoc)
 {  {
         int               c, lastarg, j;          v_post          *p;
         struct mdoc_arg   argv[MDOC_LINEARG_MAX];  
   
         if (SEC_PROLOGUE == mdoc->sec_lastn)          if (MDOC_TEXT == mdoc->last->type)
                 return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));                  return(1);
           if (MDOC_ROOT == mdoc->last->type)
                   return(post_root(mdoc));
   
         lastarg = *pos;          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);
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          return(1);
                 lastarg = *pos;  
                 c = mdoc_argv(mdoc, tok, &argv[j], pos, buf);  
                 if (0 == c)  
                         break;  
                 else if (1 == c)  
                         continue;  
   
                 mdoc_argv_free(j, argv);  
                 return(0);  
         }  
   
         if (MDOC_LINEARG_MAX == j) {  
                 mdoc_argv_free(j, argv);  
                 return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));  
         }  
   
         c = append_constarg(mdoc, tok, ppos, j, argv);  
         mdoc_argv_free(j, argv);  
         return(c);  
 }  }
   
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.38
CVSweb