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

Diff for /mandoc/Attic/validate.c between version 1.33 and 1.93

version 1.33, 2009/01/16 14:04:26 version 1.93, 2009/03/23 14:22:11
Line 1 
Line 1 
 /* $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the   * purpose with or without fee is hereby granted, provided that the
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/types.h>
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
   #include <stdarg.h>
 #include <stdlib.h>  #include <stdlib.h>
   
 #include "private.h"  #include "libmdoc.h"
   
   /* FIXME: .Bl -diag can't have non-text children in HEAD. */
   /* TODO: ignoring Pp (it's superfluous in some invocations). */
   
 typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);  /*
 typedef int     (*v_post)(struct mdoc *);   * Pre- and post-validate macros as they're parsed.  Pre-validation
    * occurs when the macro has been detected and its arguments parsed.
    * Post-validation occurs when all child macros have also been parsed.
    * In the ELEMENT case, this is simply the parameters of the macro; in
    * the BLOCK case, this is the HEAD, BODY, TAIL and so on.
    */
   
   #define PRE_ARGS        struct mdoc *mdoc, const struct mdoc_node *n
   #define POST_ARGS       struct mdoc *mdoc
   
   enum    merr {
           EESCAPE,
           EPRINT,
           ENODATA,
           ENOPROLOGUE,
           ELINE,
           EATT,
           ENAME,
           ELISTTYPE,
           EDISPTYPE,
           EMULTIDISP,
           EMULTILIST,
           EARGREP,
           EBOOL,
           ENESTDISP
   };
   
   enum    mwarn {
           WESCAPE,
           WWRONGMSEC,
           WSECOOO,
           WSECREP,
           WBADSTAND,
           WNAMESECINC,
           WNOMULTILINE,
           WMULTILINE,
           WLINE,
           WNOLINE,
           WPROLOOO,
           WPROLREP,
           WARGVAL,
           WBADSEC,
           WBADMSEC
   };
   
   typedef int     (*v_pre)(PRE_ARGS);
   typedef int     (*v_post)(POST_ARGS);
   
 struct  valids {  struct  valids {
         v_pre   *pre;          v_pre   *pre;
         v_post  *post;          v_post  *post;
 };  };
   
 static  int     pre_check_parent(struct mdoc *, struct mdoc_node *,  /* Utility checks. */
                         int, enum mdoc_type);  
 static  int     pre_check_msecs(struct mdoc *, struct mdoc_node *,  
                         int, enum mdoc_msec *);  
   
 static  int     pre_display(struct mdoc *, struct mdoc_node *);  static  int     pwarn(struct mdoc *, int, int, enum mwarn);
 static  int     pre_sh(struct mdoc *, struct mdoc_node *);  static  int     perr(struct mdoc *, int, int, enum merr);
 static  int     pre_ss(struct mdoc *, struct mdoc_node *);  static  int     check_parent(PRE_ARGS, int, enum mdoc_type);
 static  int     pre_bd(struct mdoc *, struct mdoc_node *);  static  int     check_msec(PRE_ARGS, ...);
 static  int     pre_bl(struct mdoc *, struct mdoc_node *);  static  int     check_sec(PRE_ARGS, ...);
 static  int     pre_it(struct mdoc *, struct mdoc_node *);  static  int     check_stdarg(PRE_ARGS);
 static  int     pre_cd(struct mdoc *, struct mdoc_node *);  static  int     check_text(struct mdoc *, int, int, const char *);
 static  int     pre_er(struct mdoc *, struct mdoc_node *);  static  int     check_argv(struct mdoc *,
 static  int     pre_ex(struct mdoc *, struct mdoc_node *);                          const struct mdoc_node *,
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);                          const struct mdoc_argv *);
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);  static  int     check_args(struct mdoc *,
 static  int     pre_prologue(struct mdoc *, struct mdoc_node *);                          const struct mdoc_node *);
   static  int     err_child_lt(struct mdoc *, const char *, int);
   static  int     warn_child_lt(struct mdoc *, const char *, int);
   static  int     err_child_gt(struct mdoc *, const char *, int);
   static  int     warn_child_gt(struct mdoc *, const char *, int);
   static  int     err_child_eq(struct mdoc *, const char *, int);
   static  int     warn_child_eq(struct mdoc *, const char *, int);
   static  inline int count_child(struct mdoc *);
   static  inline int warn_count(struct mdoc *, const char *,
                           int, const char *, int);
   static  inline int err_count(struct mdoc *, const char *,
                           int, const char *, int);
   static  int     pre_an(PRE_ARGS);
   static  int     pre_bd(PRE_ARGS);
   static  int     pre_bl(PRE_ARGS);
   static  int     pre_cd(PRE_ARGS);
   static  int     pre_dd(PRE_ARGS);
   static  int     pre_display(PRE_ARGS);
   static  int     pre_dt(PRE_ARGS);
   static  int     pre_er(PRE_ARGS);
   static  int     pre_ex(PRE_ARGS);
   static  int     pre_fd(PRE_ARGS);
   static  int     pre_it(PRE_ARGS);
   static  int     pre_lb(PRE_ARGS);
   static  int     pre_os(PRE_ARGS);
   static  int     pre_prologue(PRE_ARGS);
   static  int     pre_rv(PRE_ARGS);
   static  int     pre_sh(PRE_ARGS);
   static  int     pre_ss(PRE_ARGS);
   static  int     herr_ge1(POST_ARGS);
   static  int     hwarn_le1(POST_ARGS);
   static  int     herr_eq0(POST_ARGS);
   static  int     eerr_eq0(POST_ARGS);
   static  int     eerr_le2(POST_ARGS);
   static  int     eerr_eq1(POST_ARGS);
   static  int     eerr_ge1(POST_ARGS);
   static  int     ewarn_eq0(POST_ARGS);
   static  int     ewarn_eq1(POST_ARGS);
   static  int     bwarn_ge1(POST_ARGS);
   static  int     hwarn_eq1(POST_ARGS);
   static  int     ewarn_ge1(POST_ARGS);
   static  int     ebool(POST_ARGS);
   
 static  int     headchild_err_ge1(struct mdoc *);  static  int     post_an(POST_ARGS);
 static  int     headchild_warn_ge1(struct mdoc *);  static  int     post_args(POST_ARGS);
 static  int     headchild_err_eq0(struct mdoc *);  static  int     post_at(POST_ARGS);
 static  int     elemchild_err_eq0(struct mdoc *);  static  int     post_bf(POST_ARGS);
 static  int     elemchild_err_ge1(struct mdoc *);  static  int     post_bl(POST_ARGS);
 static  int     elemchild_warn_eq0(struct mdoc *);  static  int     post_it(POST_ARGS);
 static  int     bodychild_warn_ge1(struct mdoc *);  static  int     post_nm(POST_ARGS);
 static  int     bodychild_err_eq0(struct mdoc *);  static  int     post_root(POST_ARGS);
 static  int     elemchild_warn_ge1(struct mdoc *);  static  int     post_sh(POST_ARGS);
 static  int     post_sh(struct mdoc *);  static  int     post_sh_body(POST_ARGS);
 static  int     post_bl(struct mdoc *);  static  int     post_sh_head(POST_ARGS);
 static  int     post_it(struct mdoc *);  static  int     post_st(POST_ARGS);
   
 static  v_pre   pres_prologue[] = { pre_prologue, NULL };  #define mwarn(m, t) nwarn((m), (m)->last, (t))
 static  v_pre   pres_d1[] = { pre_display, NULL };  #define merr(m, t) nerr((m), (m)->last, (t))
   #define nwarn(m, n, t) pwarn((m), (n)->line, (n)->pos, (t))
   #define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t))
   
   static  v_pre   pres_an[] = { pre_an, NULL };
 static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };  static  v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
 static  v_pre   pres_bl[] = { pre_bl, 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_cd[] = { pre_cd, NULL };
   static  v_pre   pres_dd[] = { pre_prologue, pre_dd, NULL };
   static  v_pre   pres_d1[] = { pre_display, NULL };
   static  v_pre   pres_dt[] = { pre_prologue, pre_dt, NULL };
 static  v_pre   pres_er[] = { pre_er, NULL };  static  v_pre   pres_er[] = { pre_er, NULL };
 static  v_pre   pres_ex[] = { pre_ex, NULL };  static  v_pre   pres_ex[] = { pre_ex, NULL };
   static  v_pre   pres_fd[] = { pre_fd, NULL };
 static  v_post  posts_bd[] = { headchild_err_eq0, bodychild_warn_ge1, NULL };  static  v_pre   pres_it[] = { pre_it, NULL };
 static  v_post  posts_text[] = { elemchild_err_ge1, NULL };  static  v_pre   pres_lb[] = { pre_lb, NULL };
 static  v_post  posts_wtext[] = { elemchild_warn_ge1, NULL };  static  v_pre   pres_os[] = { pre_prologue, pre_os, NULL };
 static  v_post  posts_notext[] = { elemchild_err_eq0, NULL };  static  v_pre   pres_rv[] = { pre_rv, NULL };
 static  v_post  posts_wline[] = { headchild_warn_ge1, bodychild_err_eq0, NULL };  static  v_pre   pres_sh[] = { pre_sh, NULL };
 static  v_post  posts_sh[] = { headchild_err_ge1, bodychild_warn_ge1, post_sh, NULL };  static  v_pre   pres_ss[] = { pre_ss, NULL };
 static  v_post  posts_bl[] = { headchild_err_eq0, bodychild_warn_ge1, post_bl, NULL };  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_it[] = { post_it, NULL };
 static  v_post  posts_ss[] = { headchild_err_ge1, NULL };  static  v_post  posts_in[] = { ewarn_eq1, NULL };
 static  v_post  posts_pp[] = { elemchild_warn_eq0, NULL };  static  v_post  posts_ss[] = { herr_ge1, NULL };
 static  v_post  posts_d1[] = { headchild_err_ge1, NULL };  static  v_post  posts_pf[] = { eerr_eq1, NULL };
   static  v_post  posts_lb[] = { eerr_eq1, NULL };
   static  v_post  posts_st[] = { eerr_eq1, post_st, NULL };
   static  v_post  posts_pp[] = { ewarn_eq0, NULL };
   static  v_post  posts_ex[] = { eerr_eq0, post_args, NULL };
   static  v_post  posts_rv[] = { eerr_eq0, post_args, 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, NULL };
   static  v_post  posts_nm[] = { post_nm, NULL };
   static  v_post  posts_bf[] = { hwarn_le1, post_bf, NULL };
   static  v_post  posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
   
   
 const   struct valids mdoc_valids[MDOC_MAX] = {  const   struct valids mdoc_valids[MDOC_MAX] = {
         { NULL, NULL }, /* \" */          { NULL, NULL },                         /* \" */
         { pres_prologue, posts_text }, /* Dd */          { pres_dd, posts_text },                /* Dd */
         { pres_prologue, NULL }, /* Dt */          { pres_dt, NULL },                      /* Dt */
         { pres_prologue, NULL }, /* Os */          { pres_os, NULL },                      /* Os */
         /* FIXME: preceding Pp. */          { pres_sh, posts_sh },                  /* Sh */
         /* FIXME: NAME section internal ordering. */          { pres_ss, posts_ss },                  /* Ss */
         { pres_sh, posts_sh }, /* Sh */          { NULL, posts_pp },                     /* Pp */
         /* FIXME: preceding Pp. */          { pres_d1, posts_wline },               /* D1 */
         { pres_ss, posts_ss }, /* Ss */          { pres_d1, posts_wline },               /* Dl */
         /* FIXME: proceeding... */          { pres_bd, posts_bd },                  /* Bd */
         { NULL, posts_pp }, /* Pp */          { NULL, NULL },                         /* Ed */
         { pres_d1, posts_d1 }, /* D1 */          { pres_bl, posts_bl },                  /* Bl */
         { pres_d1, posts_d1 }, /* Dl */          { NULL, NULL },                         /* El */
          /* FIXME: preceding Pp. */          { pres_it, posts_it },                  /* It */
         { pres_bd, posts_bd }, /* Bd */          { NULL, posts_text },                   /* Ad */
         { NULL, NULL }, /* Ed */          { pres_an, posts_an },                  /* An */
         /* FIXME: preceding Pp. */          { NULL, NULL },                         /* Ar */
         { pres_bl, posts_bl }, /* Bl */          { pres_cd, posts_text },                /* Cd */
         { NULL, NULL }, /* El */          { NULL, NULL },                         /* Cm */
         { pres_it, posts_it }, /* It */          { NULL, NULL },                         /* Dv */
         { NULL, posts_text }, /* Ad */          { pres_er, posts_text },                /* Er */
         /* FIXME: argument OR parameters. */          { NULL, NULL },                         /* Ev */
         { NULL, NULL }, /* An */          { pres_ex, posts_ex },                  /* Ex */
         { NULL, NULL }, /* Ar */          { NULL, NULL },                         /* Fa */
         { pres_cd, posts_text }, /* Cd */          { pres_fd, posts_wtext },               /* Fd */
         { NULL, NULL }, /* Cm */          { NULL, NULL },                         /* Fl */
         { NULL, posts_text }, /* Dv */          { NULL, posts_text },                   /* Fn */
         { pres_er, posts_text }, /* Er */          { NULL, posts_wtext },                  /* Ft */
         { NULL, posts_text }, /* Ev */          { NULL, posts_text },                   /* Ic */
         { pres_ex, posts_notext }, /* Ex */ /* FIXME: -std required */          { NULL, posts_in },                     /* In */
         { NULL, posts_text }, /* Fa */          { NULL, NULL },                         /* Li */
         { NULL, NULL }, /* Fd */ /* FIXME: SYNOPSIS section. */          { NULL, posts_wtext },                  /* Nd */
         { NULL, NULL }, /* Fl */          { NULL, posts_nm },                     /* Nm */
         { NULL, posts_text }, /* Fn */          { NULL, posts_wline },                  /* Op */
         { NULL, NULL }, /* Ft */          { NULL, NULL },                         /* Ot */
         { NULL, posts_text }, /* Ic */          { NULL, NULL },                         /* Pa */
         { NULL, posts_wtext }, /* In */          { pres_rv, posts_rv },                  /* Rv */
         { NULL, posts_text }, /* Li */          { NULL, posts_st },                     /* St */
         { NULL, posts_wtext }, /* Nd */          { NULL, NULL },                         /* Va */
         { NULL, NULL }, /* Nm */  /* FIXME: If name not set? */          { NULL, posts_text },                   /* Vt */
         { NULL, posts_wline }, /* Op */          { NULL, posts_xr },                     /* Xr */
         { NULL, NULL }, /* Ot */          { NULL, posts_text },                   /* %A */
         { NULL, NULL }, /* Pa */          { NULL, posts_text },                   /* %B */
         { NULL, posts_notext }, /* Rv */ /* -std required */          { NULL, posts_text },                   /* %D */
         { NULL, posts_notext }, /* St */ /* arg required */          { NULL, posts_text },                   /* %I */
         { NULL, posts_text }, /* Va */          { NULL, posts_text },                   /* %J */
         { NULL, posts_text }, /* Vt */          { NULL, posts_text },                   /* %N */
         { NULL, NULL }, /* Xr */ /* FIXME */          { NULL, posts_text },                   /* %O */
         { NULL, posts_text }, /* %A */          { NULL, posts_text },                   /* %P */
         { NULL, posts_text }, /* %B */          { NULL, posts_text },                   /* %R */
         { NULL, posts_text }, /* %D */          { NULL, posts_text },                   /* %T */
         { NULL, posts_text }, /* %I */          { NULL, posts_text },                   /* %V */
         { NULL, posts_text }, /* %J */          { NULL, NULL },                         /* Ac */
         { NULL, posts_text }, /* %N */          { NULL, NULL },                         /* Ao */
         { NULL, posts_text }, /* %O */          { NULL, posts_wline },                  /* Aq */
         { NULL, posts_text }, /* %P */          { NULL, posts_at },                     /* At */
         { NULL, posts_text }, /* %R */          { NULL, NULL },                         /* Bc */
         { NULL, posts_text }, /* %T */          { NULL, posts_bf },                     /* Bf */
         { NULL, posts_text }, /* %V */          { NULL, NULL },                         /* Bo */
         { NULL, NULL }, /* Ac */          { NULL, posts_wline },                  /* Bq */
         { NULL, NULL }, /* Ao */          { NULL, NULL },                         /* Bsx */
         { NULL, posts_wline }, /* Aq */          { NULL, NULL },                         /* Bx */
         { NULL, NULL }, /* At */ /* FIXME */          { NULL, posts_bool },                   /* Db */
         { NULL, NULL }, /* Bc */          { NULL, NULL },                         /* Dc */
         { NULL, NULL }, /* Bf */          { NULL, NULL },                         /* Do */
         { NULL, NULL }, /* Bo */          { NULL, posts_wline },                  /* Dq */
         { NULL, posts_wline }, /* Bq */          { NULL, NULL },                         /* Ec */
         { NULL, NULL }, /* Bsx */          { NULL, NULL },                         /* Ef */
         { NULL, NULL }, /* Bx */          { NULL, NULL },                         /* Em */
         { NULL, NULL }, /* Db */ /* FIXME: boolean */          { NULL, NULL },                         /* Eo */
         { NULL, NULL }, /* Dc */          { NULL, NULL },                         /* Fx */
         { NULL, NULL }, /* Do */          { NULL, posts_text },                   /* Ms */
         { NULL, posts_wline }, /* Dq */          { NULL, posts_notext },                 /* No */
         { NULL, NULL }, /* Ec */          { NULL, posts_notext },                 /* Ns */
         { NULL, NULL }, /* Ef */ /* -symbolic, etc. */          { NULL, NULL },                         /* Nx */
         { NULL, posts_text }, /* Em */          { NULL, NULL },                         /* Ox */
         { NULL, NULL }, /* Eo */          { NULL, NULL },                         /* Pc */
         { NULL, NULL }, /* Fx */          { NULL, posts_pf },                     /* Pf */
         { NULL, posts_text }, /* Ms */ /* FIXME: which symbols? */          { NULL, NULL },                         /* Po */
         { NULL, posts_notext }, /* No */          { NULL, posts_wline },                  /* Pq */
         { NULL, posts_notext }, /* Ns */          { NULL, NULL },                         /* Qc */
         { NULL, NULL }, /* Nx */          { NULL, posts_wline },                  /* Ql */
         { NULL, NULL }, /* Ox */          { NULL, NULL },                         /* Qo */
         { NULL, NULL }, /* Pc */          { NULL, posts_wline },                  /* Qq */
         { NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */ /* First should be text. */          { NULL, NULL },                         /* Re */
         { NULL, NULL }, /* Po */          { NULL, posts_wline },                  /* Rs */
         { NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */          { NULL, NULL },                         /* Sc */
         { NULL, NULL }, /* Qc */          { NULL, NULL },                         /* So */
         { NULL, posts_wline }, /* Ql */          { NULL, posts_wline },                  /* Sq */
         { NULL, NULL }, /* Qo */          { NULL, posts_bool },                   /* Sm */
         { NULL, posts_wline }, /* Qq */          { NULL, posts_text },                   /* Sx */
         { NULL, NULL }, /* Re */          { NULL, posts_text },                   /* Sy */
         { NULL, NULL }, /* Rs */          { NULL, posts_text },                   /* Tn */
         { NULL, NULL }, /* Sc */          { NULL, NULL },                         /* Ux */
         { NULL, NULL }, /* So */          { NULL, NULL },                         /* Xc */
         { NULL, posts_wline }, /* Sq */          { NULL, NULL },                         /* Xo */
         { NULL, NULL }, /* Sm */ /* FIXME: boolean */          { NULL, posts_fo },                     /* Fo */
         { NULL, posts_text }, /* Sx */          { NULL, NULL },                         /* Fc */
         { NULL, posts_text }, /* Sy */          { NULL, NULL },                         /* Oo */
         { NULL, posts_text }, /* Tn */          { NULL, NULL },                         /* Oc */
         { NULL, NULL }, /* Ux */          { NULL, posts_wline },                  /* Bk */
         { NULL, NULL }, /* Xc */          { NULL, NULL },                         /* Ek */
         { NULL, NULL }, /* Xo */          { NULL, posts_notext },                 /* Bt */
         { NULL, NULL }, /* Fo */          { NULL, NULL },                         /* Hf */
         { NULL, NULL }, /* Fc */          { NULL, NULL },                         /* Fr */
         { NULL, NULL }, /* Oo */          { NULL, posts_notext },                 /* Ud */
         { NULL, NULL }, /* Oc */          { pres_lb, posts_lb },                  /* Lb */
         { NULL, NULL }, /* Bk */          { NULL, NULL },                         /* Ap */
         { NULL, NULL }, /* Ek */          { NULL, posts_pp },                     /* Lp */
         { NULL, posts_notext }, /* Bt */          { NULL, posts_text },                   /* Lk */
         { NULL, NULL }, /* Hf */          { NULL, posts_text },                   /* Mt */
         { NULL, NULL }, /* Fr */          { NULL, posts_wline },                  /* Brq */
         { NULL, posts_notext }, /* Ud */          { NULL, NULL },                         /* Bro */
           { NULL, NULL },                         /* Brc */
           { NULL, posts_text },                   /* %C */
           { NULL, NULL },                         /* Es */
           { NULL, NULL },                         /* En */
           { NULL, NULL },                         /* Dx */
           { NULL, posts_text },                   /* %Q */
 };  };
   
   
 static int  int
 pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node,  mdoc_valid_pre(struct mdoc *mdoc,
                 int sz, enum mdoc_msec *msecs)                  const struct mdoc_node *n)
 {  {
         int              i;          v_pre           *p;
           int              line, pos;
           const char      *tp;
   
         for (i = 0; i < sz; i++)          if (MDOC_TEXT == n->type) {
                 if (msecs[i] == mdoc->meta.msec)                  tp = n->string;
                         return(1);                  line = n->line;
         return(mdoc_nwarn(mdoc, node, WARN_COMPAT,                  pos = n->pos;
                                 "macro is not appropriate for this manual section"));                  return(check_text(mdoc, line, pos, tp));
           }
   
           if ( ! check_args(mdoc, n))
                   return(0);
           if (NULL == mdoc_valids[n->tok].pre)
                   return(1);
           for (p = mdoc_valids[n->tok].pre; *p; p++)
                   if ( ! (*p)(mdoc, n))
                           return(0);
           return(1);
 }  }
   
   
 static int  int
 pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,  mdoc_valid_post(struct mdoc *mdoc)
                 int tok, enum mdoc_type type)  
 {  {
           v_post          *p;
   
         if (type != mdoc->last->parent->type)          /*
                 return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s",           * This check occurs after the macro's children have been filled
                                         mdoc_type2a(mdoc->last->parent->type),           * in: postfix validation.  Since this happens when we're
                                         mdoc_type2a(type)));           * rewinding the scope tree, it's possible to have multiple
         if (MDOC_ROOT != type && tok == mdoc->last->parent->tok)           * invocations (as by design, for now), we set bit MDOC_VALID to
                 return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'",           * indicate that we've validated.
                                         mdoc_macronames[mdoc->last->parent->tok],           */
                                         mdoc_macronames[tok]));  
           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);          return(1);
 }  }
   
   
 static int  static int
 bodychild_err_eq0(struct mdoc *mdoc)  perr(struct mdoc *m, int line, int pos, enum merr type)
 {  {
           char             *p;
         if (MDOC_BODY != mdoc->last->type)  
                 return(1);          p = NULL;
         if (NULL == mdoc->last->child)          switch (type) {
                 return(1);          case (EESCAPE):
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));                  p = "invalid escape sequence";
                   break;
           case (EPRINT):
                   p = "invalid character";
                   break;
           case (ENESTDISP):
                   p = "displays may not be nested";
                   break;
           case (EBOOL):
                   p = "expected boolean value";
                   break;
           case (EARGREP):
                   p = "argument repeated";
                   break;
           case (EMULTIDISP):
                   p = "multiple display types specified";
                   break;
           case (EMULTILIST):
                   p = "multiple list types specified";
                   break;
           case (ELISTTYPE):
                   p = "missing list type";
                   break;
           case (EDISPTYPE):
                   p = "missing display type";
                   break;
           case (ELINE):
                   p = "expected line arguments";
                   break;
           case (ENOPROLOGUE):
                   p = "document has no prologue";
                   break;
           case (ENODATA):
                   p = "document has no data";
                   break;
           case (EATT):
                   p = "expected valid AT&T symbol";
                   break;
           case (ENAME):
                   p = "default name not yet set";
                   break;
           }
           assert(p);
           return(mdoc_perr(m, line, pos, p));
 }  }
   
   
 static int  static int
 bodychild_warn_ge1(struct mdoc *mdoc)  pwarn(struct mdoc *m, int line, int pos, enum mwarn type)
 {  {
           char             *p;
           enum mdoc_warn    c;
   
         if (MDOC_BODY != mdoc->last->type)          c = WARN_SYNTAX;
                 return(1);          p = NULL;
         if (mdoc->last->child)          switch (type) {
                 return(1);          case (WBADMSEC):
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));                  p = "inappropriate manual section";
                   c = WARN_COMPAT;
                   break;
           case (WBADSEC):
                   p = "inappropriate document section";
                   c = WARN_COMPAT;
                   break;
           case (WARGVAL):
                   p = "argument value suggested";
                   c = WARN_COMPAT;
                   break;
           case (WPROLREP):
                   p = "prologue macros repeated";
                   c = WARN_COMPAT;
                   break;
           case (WPROLOOO):
                   p = "prologue macros out-of-order";
                   c = WARN_COMPAT;
                   break;
           case (WESCAPE):
                   p = "invalid escape sequence";
                   break;
           case (WNOLINE):
                   p = "suggested no line arguments";
                   break;
           case (WLINE):
                   p = "suggested line arguments";
                   break;
           case (WMULTILINE):
                   p = "suggested multi-line arguments";
                   break;
           case (WNOMULTILINE):
                   p = "suggested no multi-line arguments";
                   break;
           case (WWRONGMSEC):
                   p = "document section in wrong manual section";
                   c = WARN_COMPAT;
                   break;
           case (WSECOOO):
                   p = "document section out of conventional order";
                   break;
           case (WSECREP):
                   p = "document section repeated";
                   break;
           case (WBADSTAND):
                   p = "unknown standard";
                   break;
           case (WNAMESECINC):
                   p = "NAME section contents incomplete/badly-ordered";
                   break;
           }
           assert(p);
           return(mdoc_pwarn(m, line, pos, c, p));
 }  }
   
   
   
   static inline int
   warn_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
   {
   
           return(mdoc_warn(m, WARN_SYNTAX,
                   "suggests %s %s %d (has %d)", v, k, want, has));
   }
   
   
   static inline int
   err_count(struct mdoc *m, const char *k,
                   int want, const char *v, int has)
   {
   
           return(mdoc_err(m,
                   "requires %s %s %d (has %d)", v, k, want, has));
   }
   
   
   static inline int
   count_child(struct mdoc *mdoc)
   {
           int               i;
           struct mdoc_node *n;
   
           for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                   /* Do nothing */ ;
   
           return(i);
   }
   
   
   /*
    * Build these up with macros because they're basically the same check
    * for different inequalities.  Yes, this could be done with functions,
    * but this is reasonable for now.
    */
   
   #define CHECK_CHILD_DEFN(lvl, name, ineq)                       \
   static int                                                      \
   lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz)    \
   {                                                               \
           int i;                                                  \
           if ((i = count_child(mdoc)) ineq sz)                    \
                   return(1);                                      \
           return(lvl##_count(mdoc, #ineq, sz, p, i));             \
   }
   
   #define CHECK_BODY_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   b##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           if (MDOC_BODY != mdoc->last->type)                      \
                   return(1);                                      \
           return(func(mdoc, "multi-line arguments", (num)));      \
   }
   
   #define CHECK_ELEM_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   e##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           assert(MDOC_ELEM == mdoc->last->type);                  \
           return(func(mdoc, "line arguments", (num)));            \
   }
   
   #define CHECK_HEAD_DEFN(name, lvl, func, num)                   \
   static int                                                      \
   h##lvl##_##name(POST_ARGS)                                      \
   {                                                               \
           if (MDOC_HEAD != mdoc->last->type)                      \
                   return(1);                                      \
           return(func(mdoc, "line arguments", (num)));            \
   }
   
   
   CHECK_CHILD_DEFN(warn, gt, >)                   /* warn_child_gt() */
   CHECK_CHILD_DEFN(err, gt, >)                    /* err_child_gt() */
   CHECK_CHILD_DEFN(warn, eq, ==)                  /* warn_child_eq() */
   CHECK_CHILD_DEFN(err, eq, ==)                   /* err_child_eq() */
   CHECK_CHILD_DEFN(err, lt, <)                    /* err_child_lt() */
   CHECK_CHILD_DEFN(warn, lt, <)                   /* warn_child_lt() */
   CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0)    /* bwarn_ge1() */
   CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1)    /* ewarn_eq1() */
   CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0)    /* ewarn_eq0() */
   CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0)    /* ewarn_gt1() */
   CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1)      /* eerr_eq1() */
   CHECK_ELEM_DEFN(le2, err, err_child_lt, 3)      /* eerr_le2() */
   CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0)      /* eerr_eq0() */
   CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0)      /* eerr_ge1() */
   CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0)      /* herr_eq0() */
   CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2)    /* hwarn_le1() */
   CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0)      /* herr_ge1() */
   CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1)    /* hwarn_eq1() */
   
   
 static int  static int
 elemchild_warn_eq0(struct mdoc *mdoc)  check_stdarg(PRE_ARGS)
 {  {
   
         assert(MDOC_ELEM == mdoc->last->type);          if (n->args && 1 == n->args->argc)
         if (NULL == mdoc->last->child)                  if (MDOC_Std == n->args->argv[0].arg)
                 return(1);                          return(1);
         return(mdoc_pwarn(mdoc, mdoc->last->child->line,          return(nwarn(mdoc, n, WARGVAL));
                         mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));  
 }  }
   
   
 static int  static int
 elemchild_warn_ge1(struct mdoc *mdoc)  check_sec(PRE_ARGS, ...)
 {  {
           enum mdoc_sec    sec;
           va_list          ap;
   
         assert(MDOC_ELEM == mdoc->last->type);          va_start(ap, n);
         if (mdoc->last->child)  
           for (;;) {
                   /* LINTED */
                   sec = (enum mdoc_sec)va_arg(ap, int);
                   if (SEC_CUSTOM == sec)
                           break;
                   if (sec != mdoc->lastsec)
                           continue;
                   va_end(ap);
                 return(1);                  return(1);
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));          }
   
           va_end(ap);
           return(nwarn(mdoc, n, WBADSEC));
 }  }
   
   
 static int  static int
 elemchild_err_eq0(struct mdoc *mdoc)  check_msec(PRE_ARGS, ...)
 {  {
           va_list          ap;
           int              msec;
   
         assert(MDOC_ELEM == mdoc->last->type);          va_start(ap, n);
         if (NULL == mdoc->last->child)          for (;;) {
                   /* LINTED */
                   if (0 == (msec = va_arg(ap, int)))
                           break;
                   if (msec != mdoc->meta.msec)
                           continue;
                   va_end(ap);
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "macro expects no parameters"));          }
   
           va_end(ap);
           return(nwarn(mdoc, n, WBADMSEC));
 }  }
   
   
 static int  static int
 elemchild_err_ge1(struct mdoc *mdoc)  check_args(struct mdoc *m, const struct mdoc_node *n)
 {  {
           int              i;
   
         assert(MDOC_ELEM == mdoc->last->type);          if (NULL == n->args)
         if (mdoc->last->child)  
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "macro expects one or more parameters"));  
           assert(n->args->argc);
           for (i = 0; i < (int)n->args->argc; i++)
                   if ( ! check_argv(m, n, &n->args->argv[i]))
                           return(0);
   
           return(1);
 }  }
   
   
 static int  static int
 headchild_err_eq0(struct mdoc *mdoc)  check_argv(struct mdoc *m, const struct mdoc_node *n,
                   const struct mdoc_argv *v)
 {  {
           int              i;
   
         if (MDOC_HEAD != mdoc->last->type)          for (i = 0; i < (int)v->sz; i++)
                 return(1);                  if ( ! check_text(m, v->line, v->pos, v->value[i]))
         if (NULL == mdoc->last->child)                          return(0);
                 return(1);  
         return(mdoc_perr(mdoc, mdoc->last->child->line,          if (MDOC_Std == v->arg) {
                         mdoc->last->child->pos, "macro expects no parameters"));                  /* `Nm' name must be set. */
                   if (v->sz || m->meta.name)
                           return(1);
                   return(nerr(m, n, ENAME));
           }
   
           return(1);
 }  }
   
   
 static int  static int
 headchild_warn_ge1(struct mdoc *mdoc)  check_text(struct mdoc *mdoc, int line, int pos, const char *p)
 {  {
           size_t           c;
   
         if (MDOC_HEAD != mdoc->last->type)          /* FIXME: indicate deprecated escapes \*(xx and \*x. */
                 return(1);  
         if (mdoc->last->child)          for ( ; *p; p++) {
                 return(1);                  if ('\t' == *p) {
         return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));                          if ( ! (MDOC_LITERAL & mdoc->flags))
                                   return(perr(mdoc, line, pos, EPRINT));
                   } else if ( ! isprint((u_char)*p))
                           return(perr(mdoc, line, pos, EPRINT));
   
                   if ('\\' != *p)
                           continue;
   
                   c = mdoc_isescape(p);
                   if (c) {
                           p += (int)c - 1;
                           continue;
                   }
                   if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
                           return(perr(mdoc, line, pos, EESCAPE));
                   if ( ! pwarn(mdoc, line, pos, WESCAPE))
                           return(0);
           }
   
           return(1);
 }  }
   
   
   
   
 static int  static int
 headchild_err_ge1(struct mdoc *mdoc)  check_parent(PRE_ARGS, int tok, enum mdoc_type t)
 {  {
   
         if (MDOC_HEAD != mdoc->last->type)          assert(n->parent);
           if ((MDOC_ROOT == t || tok == n->parent->tok) &&
                           (t == n->parent->type))
                 return(1);                  return(1);
         if (mdoc->last->child)  
                 return(1);          return(mdoc_nerr(mdoc, n, "require parent %s",
         return(mdoc_err(mdoc, "macro expects one or more parameters"));                  MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
 }  }
   
   
   
 static int  static int
 pre_display(struct mdoc *mdoc, struct mdoc_node *node)  pre_display(PRE_ARGS)
 {  {
         struct mdoc_node *n;          struct mdoc_node *node;
   
         if (MDOC_BLOCK != node->type)          /* Display elements (`Bd', `D1'...) cannot be nested. */
   
           if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
   
         assert(mdoc->last);          /* LINTED */
         for (n = mdoc->last->parent; n; n = n->parent)          for (node = mdoc->last->parent; node; node = node->parent)
                 if (MDOC_BLOCK == n->type)                  if (MDOC_BLOCK == node->type)
                         if (MDOC_Bd == n->tok)                          if (MDOC_Bd == node->tok)
                                 break;                                  break;
         if (NULL == n)          if (NULL == node)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, node, "displays may not be nested"));  
           return(nerr(mdoc, n, ENESTDISP));
 }  }
   
   
 static int  static int
 pre_bl(struct mdoc *mdoc, struct mdoc_node *node)  pre_bl(PRE_ARGS)
 {  {
         int              type, err;          int              i, type, width, offset;
         struct mdoc_arg *argv;  
         size_t           i, argc;  
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         assert(MDOC_Bl == node->tok);          if (NULL == n->args)
                   return(nerr(mdoc, n, ELISTTYPE));
   
         argv = NULL;          /* Make sure that only one type of list is specified.  */
         argc = node->data.block.argc;  
   
         for (i = type = err = 0; i < argc; i++) {          type = offset = width = -1;
                 argv = &node->data.block.argv[(int)i];  
                 assert(argv);          /* LINTED */
                 switch (argv->arg) {          for (i = 0; i < (int)n->args->argc; i++)
                   switch (n->args->argv[i].arg) {
                 case (MDOC_Bullet):                  case (MDOC_Bullet):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Dash):                  case (MDOC_Dash):
Line 398  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
Line 799  pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
                 case (MDOC_Inset):                  case (MDOC_Inset):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Column):                  case (MDOC_Column):
                         if (type)                          if (-1 == type) {
                                 err++;                                  type = n->args->argv[i].arg;
                         type++;                                  break;
                         break;                          }
                           return(nerr(mdoc, n, EMULTILIST));
                   case (MDOC_Width):
                           if (-1 == width) {
                                   width = n->args->argv[i].arg;
                                   break;
                           }
                           return(nerr(mdoc, n, EARGREP));
                   case (MDOC_Offset):
                           if (-1 == offset) {
                                   offset = n->args->argv[i].arg;
                                   break;
                           }
                           return(nerr(mdoc, n, EARGREP));
                 default:                  default:
                         break;                          break;
                 }                  }
   
           if (-1 == type)
                   return(nerr(mdoc, n, ELISTTYPE));
   
           switch (type) {
           case (MDOC_Column):
                   /* FALLTHROUGH */
           case (MDOC_Diag):
                   /* FALLTHROUGH */
           case (MDOC_Inset):
                   /* FALLTHROUGH */
           case (MDOC_Item):
                   if (-1 == width)
                           break;
                   return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
                                   "superfluous %s argument",
                                   mdoc_argnames[MDOC_Width]));
           case (MDOC_Tag):
                   if (-1 != width)
                           break;
                   return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
                                   "suggest %s argument",
                                   mdoc_argnames[MDOC_Width]));
           default:
                   break;
         }          }
         if (0 == type)  
                 return(mdoc_err(mdoc, "no list type specified"));          return(1);
         if (0 == err)  
                 return(1);  
         assert(argv);  
         return(mdoc_perr(mdoc, argv->line,  
                         argv->pos, "only one list type possible"));  
 }  }
   
   
 static int  static int
 pre_bd(struct mdoc *mdoc, struct mdoc_node *node)  pre_bd(PRE_ARGS)
 {  {
         int              type, err;          int              i, type, err;
         struct mdoc_arg *argv;  
         size_t           i, argc;  
   
         if (MDOC_BLOCK != node->type)          if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         assert(MDOC_Bd == node->tok);          if (NULL == n->args)
                   return(nerr(mdoc, n, EDISPTYPE));
   
         argv = NULL;          /* Make sure that only one type of display is specified.  */
         argc = node->data.block.argc;  
   
         for (err = i = type = 0; 0 == err && i < argc; i++) {          /* LINTED */
                 argv = &node->data.block.argv[(int)i];          for (i = 0, err = type = 0; ! err &&
                 assert(argv);                          i < (int)n->args->argc; i++)
                 switch (argv->arg) {                  switch (n->args->argv[i].arg) {
                 case (MDOC_Ragged):                  case (MDOC_Ragged):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Unfilled):                  case (MDOC_Unfilled):
Line 443  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
Line 875  pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
                 case (MDOC_Literal):                  case (MDOC_Literal):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_File):                  case (MDOC_File):
                         if (type)                          if (0 == type++)
                                 err++;                                  break;
                         type++;                          return(nerr(mdoc, n, EMULTIDISP));
                         break;  
                 default:                  default:
                         break;                          break;
                 }                  }
         }  
         if (0 == type)          if (type)
                 return(mdoc_err(mdoc, "no display type specified"));  
         if (0 == err)  
                 return(1);                  return(1);
         assert(argv);          return(nerr(mdoc, n, EDISPTYPE));
         return(mdoc_perr(mdoc, argv->line,  
                         argv->pos, "only one display type possible"));  
 }  }
   
   
 static int  static int
 pre_ss(struct mdoc *mdoc, struct mdoc_node *node)  pre_ss(PRE_ARGS)
 {  {
   
         if (MDOC_BLOCK != mdoc->last->type)          if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         assert(MDOC_Sh == mdoc->last->tok);          return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
         return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));  
 }  }
   
   
 static int  static int
 pre_sh(struct mdoc *mdoc, struct mdoc_node *node)  pre_sh(PRE_ARGS)
 {  {
   
         if (MDOC_BLOCK != mdoc->last->type)          if (MDOC_BLOCK != n->type)
                 return(1);                  return(1);
         assert(MDOC_Sh == mdoc->last->tok);          return(check_parent(mdoc, n, -1, MDOC_ROOT));
         return(pre_check_parent(mdoc, node, -1, MDOC_ROOT));  
 }  }
   
   
 static int  static int
 pre_ex(struct mdoc *mdoc, struct mdoc_node *node)  pre_it(PRE_ARGS)
 {  {
         enum mdoc_msec   msecs[3];  
   
         msecs[0] = MSEC_1;          if (MDOC_BLOCK != n->type)
         msecs[1] = MSEC_6;                  return(1);
         msecs[2] = MSEC_8;          return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
         return(pre_check_msecs(mdoc, node, 3, msecs));  
 }  }
   
   
 static int  static int
 pre_er(struct mdoc *mdoc, struct mdoc_node *node)  pre_an(PRE_ARGS)
 {  {
         enum mdoc_msec   msecs[1];  
   
         msecs[0] = MSEC_2;          if (NULL == n->args || 1 == n->args->argc)
         return(pre_check_msecs(mdoc, node, 1, msecs));                  return(1);
           return(mdoc_nerr(mdoc, n, "only one argument allowed"));
 }  }
   
   
 static int  static int
 pre_cd(struct mdoc *mdoc, struct mdoc_node *node)  pre_lb(PRE_ARGS)
 {  {
         enum mdoc_msec   msecs[1];  
   
         msecs[0] = MSEC_4;          return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
         return(pre_check_msecs(mdoc, node, 1, msecs));  
 }  }
   
   
 static int  static int
 pre_it(struct mdoc *mdoc, struct mdoc_node *node)  pre_rv(PRE_ARGS)
 {  {
   
         if (MDOC_BLOCK != mdoc->last->type)          if ( ! check_msec(mdoc, n, 2, 3, 0))
                 return(1);                  return(0);
         assert(MDOC_It == mdoc->last->tok);          return(check_stdarg(mdoc, n));
         return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));  
 }  }
   
   
 static int  static int
 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)  pre_ex(PRE_ARGS)
 {  {
   
         if (SEC_PROLOGUE != mdoc->sec_lastn)          if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
                 return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));                  return(0);
         assert(MDOC_ELEM == node->type);          return(check_stdarg(mdoc, n));
   }
   
         /* Check for ordering. */  
   
         switch (node->tok) {  static int
         case (MDOC_Os):  pre_er(PRE_ARGS)
                 if (mdoc->meta.title[0] && mdoc->meta.date)  {
                         break;  
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));  
         case (MDOC_Dt):  
                 if (0 == mdoc->meta.title[0] && mdoc->meta.date)  
                         break;  
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));  
         case (MDOC_Dd):  
                 if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)  
                         break;  
                 return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
         /* Check for repetition. */          return(check_msec(mdoc, n, 2, 0));
   }
   
         switch (node->tok) {  
         case (MDOC_Os):  static int
                 if (0 == mdoc->meta.os[0])  pre_cd(PRE_ARGS)
   {
   
           return(check_msec(mdoc, n, 4, 0));
   }
   
   
   static int
   pre_prologue(PRE_ARGS)
   {
   
           return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM));
   }
   
   
   static int
   pre_dt(PRE_ARGS)
   {
   
           if (0 == mdoc->meta.date || mdoc->meta.os)
                   if ( ! nwarn(mdoc, n, WPROLOOO))
                           return(0);
           if (mdoc->meta.title)
                   if ( ! nwarn(mdoc, n, WPROLREP))
                           return(0);
           return(1);
   }
   
   
   static int
   pre_os(PRE_ARGS)
   {
   
           if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
                   if ( ! nwarn(mdoc, n, WPROLOOO))
                           return(0);
           if (mdoc->meta.os)
                   if ( ! nwarn(mdoc, n, WPROLREP))
                           return(0);
           return(1);
   }
   
   
   static int
   pre_dd(PRE_ARGS)
   {
   
           if (mdoc->meta.title || mdoc->meta.os)
                   if ( ! nwarn(mdoc, n, WPROLOOO))
                           return(0);
           if (mdoc->meta.date)
                   if ( ! nwarn(mdoc, n, WPROLREP))
                           return(0);
           return(1);
   }
   
   
   static int
   post_bf(POST_ARGS)
   {
           char             *p;
           struct mdoc_node *head;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           head = mdoc->last->head;
   
           if (NULL == mdoc->last->args) {
                   if (NULL == head->child ||
                                   MDOC_TEXT != head->child->type)
                           return(mdoc_err(mdoc, "text argument expected"));
   
                   p = head->child->string;
                   if (xstrcmp(p, "Em"))
                         return(1);                          return(1);
                 break;                  else if (xstrcmp(p, "Li"))
         case (MDOC_Dd):  
                 if (0 == mdoc->meta.date)  
                         return(1);                          return(1);
                 break;                  else if (xstrcmp(p, "Sm"))
         case (MDOC_Dt):  
                 if (0 == mdoc->meta.title[0])  
                         return(1);                          return(1);
                 break;                  return(mdoc_nerr(mdoc, head->child, "invalid font"));
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
         return(mdoc_nerr(mdoc, node, "prologue macro repeated"));          if (head->child)
                   return(mdoc_err(mdoc, "one argument expected"));
   
           return(1);
 }  }
   
   
 /* Warn if `Bl' type-specific syntax isn't reflected in items. */  
 static int  static int
 post_it(struct mdoc *mdoc)  post_nm(POST_ARGS)
 {  {
         int               type, sv;  
 #define TYPE_NONE        (0)  
 #define TYPE_BODY        (1)  
 #define TYPE_HEAD        (2)  
         size_t            i, argc;  
         struct mdoc_node *n;  
   
         if (MDOC_BLOCK != mdoc->last->type)          if (mdoc->last->child)
                 return(1);                  return(1);
           if (mdoc->meta.name)
                   return(1);
           return(merr(mdoc, ENAME));
   }
   
         assert(MDOC_It == mdoc->last->tok);  
   
         n = mdoc->last->parent;  static int
         assert(n);  post_at(POST_ARGS)
         assert(MDOC_Bl == n->tok);  {
   
         n = n->parent;          if (NULL == mdoc->last->child)
         assert(MDOC_BLOCK == n->type);                  return(1);
         assert(MDOC_Bl == n->tok);          if (MDOC_TEXT != mdoc->last->child->type)
                   return(merr(mdoc, EATT));
           if (mdoc_a2att(mdoc->last->child->string))
                   return(1);
           return(merr(mdoc, EATT));
   }
   
         argc = n->data.block.argc;  
         type = TYPE_NONE;  static int
   post_an(POST_ARGS)
   {
   
           if (mdoc->last->args) {
                   if (NULL == mdoc->last->child)
                           return(1);
                   return(merr(mdoc, ELINE));
           }
   
           if (mdoc->last->child)
                   return(1);
           return(merr(mdoc, ELINE));
   }
   
   
   static int
   post_args(POST_ARGS)
   {
   
           if (mdoc->last->args)
                   return(1);
           return(merr(mdoc, ELINE));
   }
   
   
   static int
   post_it(POST_ARGS)
   {
           int               type, i, cols;
           struct mdoc_node *n, *c;
   
           if (MDOC_BLOCK != mdoc->last->type)
                   return(1);
   
           n = mdoc->last->parent->parent;
           if (NULL == n->args)
                   return(merr(mdoc, ELISTTYPE));
   
         /* Some types require block-head, some not. */          /* Some types require block-head, some not. */
   
         for (i = 0; TYPE_NONE == type && i < argc; i++)          /* LINTED */
                 switch (n->data.block.argv[(int)i].arg) {          for (cols = type = -1, i = 0; -1 == type &&
                           i < (int)n->args->argc; i++)
                   switch (n->args->argv[i].arg) {
                 case (MDOC_Tag):                  case (MDOC_Tag):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Diag):                  case (MDOC_Diag):
Line 618  post_it(struct mdoc *mdoc)
Line 1135  post_it(struct mdoc *mdoc)
                 case (MDOC_Ohang):                  case (MDOC_Ohang):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Inset):                  case (MDOC_Inset):
                         type = TYPE_HEAD;                          /* FALLTHROUGH */
                         sv = n->data.block.argv[(int)i].arg;  
                         break;  
                 case (MDOC_Bullet):                  case (MDOC_Bullet):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Dash):                  case (MDOC_Dash):
Line 630  post_it(struct mdoc *mdoc)
Line 1145  post_it(struct mdoc *mdoc)
                 case (MDOC_Hyphen):                  case (MDOC_Hyphen):
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (MDOC_Item):                  case (MDOC_Item):
                         /* FALLTHROUGH */                          type = n->args->argv[i].arg;
                           break;
                 case (MDOC_Column):                  case (MDOC_Column):
                         type = TYPE_BODY;                          type = n->args->argv[i].arg;
                         sv = n->data.block.argv[(int)i].arg;                          cols = (int)n->args->argv[i].sz;
                         break;                          break;
                 default:                  default:
                         break;                          break;
                 }                  }
   
         assert(TYPE_NONE != type);          if (-1 == type)
                   return(merr(mdoc, ELISTTYPE));
   
         if (TYPE_HEAD == type) {          switch (type) {
                 n = mdoc->last->data.block.head;          case (MDOC_Tag):
                 assert(n);                  if (NULL == mdoc->last->head->child)
                 if (NULL == n->child)                          if ( ! mwarn(mdoc, WLINE))
                         if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))  
                                 return(0);                                  return(0);
                   break;
                 n = mdoc->last->data.block.body;          case (MDOC_Hang):
                 assert(n);                  /* FALLTHROUGH */
                 if (NULL == n->child)          case (MDOC_Ohang):
                         if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))                  /* FALLTHROUGH */
           case (MDOC_Inset):
                   /* FALLTHROUGH */
           case (MDOC_Diag):
                   if (NULL == mdoc->last->head->child)
                           if ( ! mwarn(mdoc, WLINE))
                                 return(0);                                  return(0);
                   if (NULL == mdoc->last->body->child)
                 return(1);                          if ( ! mwarn(mdoc, WMULTILINE))
                                   return(0);
                   break;
           case (MDOC_Bullet):
                   /* FALLTHROUGH */
           case (MDOC_Dash):
                   /* FALLTHROUGH */
           case (MDOC_Enum):
                   /* FALLTHROUGH */
           case (MDOC_Hyphen):
                   /* FALLTHROUGH */
           case (MDOC_Item):
                   if (mdoc->last->head->child)
                           if ( ! mwarn(mdoc, WNOLINE))
                                   return(0);
                   if (NULL == mdoc->last->body->child)
                           if ( ! mwarn(mdoc, WMULTILINE))
                                   return(0);
                   break;
           case (MDOC_Column):
                   if (NULL == mdoc->last->head->child)
                           if ( ! mwarn(mdoc, WLINE))
                                   return(0);
                   if (mdoc->last->body->child)
                           if ( ! mwarn(mdoc, WNOMULTILINE))
                                   return(0);
                   c = mdoc->last->child;
                   for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
                           i++;
                   if (i == cols)
                           break;
                   return(mdoc_err(mdoc, "column mismatch (have "
                                           "%d, want %d)", i, cols));
           default:
                   break;
         }          }
   
         assert(TYPE_BODY == type);          return(1);
         assert(mdoc->last->data.block.head);  }
   
         n = mdoc->last->data.block.head;  
         assert(n);  
         if (n->child)  
                 if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters"))  
                         return(0);  
   
         n = mdoc->last->data.block.body;  static int
         assert(n);  post_bl(POST_ARGS)
         if (NULL == n->child)  {
                 if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))          struct mdoc_node        *n;
                         return(0);  
   
         if (MDOC_Column != sv)          if (MDOC_BODY != mdoc->last->type)
                 return(1);                  return(1);
           if (NULL == mdoc->last->child)
         /* Make sure the number of columns is sane. */  
   
         sv = 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 == (size_t)sv)  
                 return(1);                  return(1);
         return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i));  
   
 #undef  TYPE_NONE          /* LINTED */
 #undef  TYPE_BODY          for (n = mdoc->last->child; n; n = n->next) {
 #undef  TYPE_HEAD                  if (MDOC_BLOCK == n->type)
                           if (MDOC_It == n->tok)
                                   continue;
                   return(mdoc_nerr(mdoc, n, "bad child of parent %s",
                                   mdoc_macronames[mdoc->last->tok]));
           }
   
           return(1);
 }  }
   
   
 /* Make sure that only `It' macros are our body-children. */  
 static int  static int
 post_bl(struct mdoc *mdoc)  ebool(struct mdoc *mdoc)
 {  {
         struct mdoc_node *n;          struct mdoc_node *n;
   
         if (MDOC_BODY != mdoc->last->type)          /* LINTED */
                 return(1);  
         assert(MDOC_Bl == mdoc->last->tok);  
   
         for (n = mdoc->last->child; n; n = n->next) {          for (n = mdoc->last->child; n; n = n->next) {
                 if (MDOC_BLOCK == n->type)                  if (MDOC_TEXT != n->type)
                         if (MDOC_It == n->tok)                          break;
                                 continue;                  if (xstrcmp(n->string, "on"))
                           continue;
                   if (xstrcmp(n->string, "off"))
                           continue;
                 break;                  break;
         }          }
   
         if (NULL == n)          if (NULL == n)
                 return(1);                  return(1);
         return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));          return(nerr(mdoc, n, EBOOL));
 }  }
   
   
 /* Warn if conventional sections are out of order. */  
 static int  static int
 post_sh(struct mdoc *mdoc)  post_root(POST_ARGS)
 {  {
         enum mdoc_sec     sec;  
         int               i;  
         struct mdoc_node *n;  
         char             *args[MDOC_LINEARG_MAX];  
   
         if (MDOC_HEAD != mdoc->last->type)          if (NULL == mdoc->first->child)
                 return(1);                  return(merr(mdoc, ENODATA));
           if (SEC_PROLOGUE == mdoc->lastnamed)
         assert(MDOC_Sh == mdoc->last->tok);                  return(merr(mdoc, ENOPROLOGUE));
   
         n = mdoc->last->child;          if (MDOC_BLOCK != mdoc->first->child->type)
         assert(n);                  return(merr(mdoc, ENODATA));
           if (MDOC_Sh != mdoc->first->child->tok)
                   return(merr(mdoc, ENODATA));
   
         for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {          return(1);
                 assert(MDOC_TEXT == n->type);  }
                 assert(NULL == n->child);  
                 assert(n->data.text.string);  
                 args[i] = n->data.text.string;  
         }  
   
         sec = mdoc_atosec((size_t)i, (const char **)args);  
         if (SEC_CUSTOM == sec)  
                 return(1);  
         if (sec > mdoc->sec_lastn)  
                 return(1);  
   
         if (sec == mdoc->sec_lastn)  static int
                 return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated"));  post_st(POST_ARGS)
         return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order"));  {
   
           if (mdoc_a2st(mdoc->last->child->string))
                   return(1);
           return(mwarn(mdoc, WBADSTAND));
 }  }
   
   
 int  static int
 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)  post_sh(POST_ARGS)
 {  {
         v_pre           *p;  
   
         /* TODO: character-escape checks. */          if (MDOC_HEAD == mdoc->last->type)
                   return(post_sh_head(mdoc));
           if (MDOC_BODY == mdoc->last->type)
                   return(post_sh_body(mdoc));
   
         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);          return(1);
 }  }
   
   
 int  static int
 mdoc_valid_post(struct mdoc *mdoc)  post_sh_body(POST_ARGS)
 {  {
         v_post          *p;          struct mdoc_node *n;
   
         if (MDOC_TEXT == mdoc->last->type)          if (SEC_NAME != mdoc->lastnamed)
                 return(1);                  return(1);
         if (MDOC_ROOT == mdoc->last->type) {  
                 /* TODO: make sure prologue is complete. */          /*
                 return(1);           * Warn if the NAME section doesn't contain the `Nm' and `Nd'
            * macros (can have multiple `Nm' and one `Nd').  Note that the
            * children of the BODY declaration can also be "text".
            */
   
           if (NULL == (n = mdoc->last->child))
                   return(mwarn(mdoc, WNAMESECINC));
   
           for ( ; n && n->next; n = n->next) {
                   if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
                           continue;
                   if (MDOC_TEXT == n->type)
                           continue;
                   if ( ! mwarn(mdoc, WNAMESECINC))
                           return(0);
         }          }
   
         if (NULL == mdoc_valids[mdoc->last->tok].post)          if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
                 return(1);                  return(1);
         for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)          return(mwarn(mdoc, WNAMESECINC));
                 if ( ! (*p)(mdoc))  }
                         return(0);  
   
   
   static int
   post_sh_head(POST_ARGS)
   {
           char              buf[64];
           enum mdoc_sec     sec;
   
           /*
            * Process a new section.  Sections are either "named" or
            * "custom"; custom sections are user-defined, while named ones
            * usually follow a conventional order and may only appear in
            * certain manual sections.
            */
   
           assert(MDOC_Sh == mdoc->last->tok);
   
           (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf));
   
           sec = mdoc_atosec(buf);
   
           /* The NAME section should always be first. */
   
           if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
                   return(mwarn(mdoc, WSECOOO));
           if (SEC_CUSTOM == sec)
                   return(1);
   
           /* Check for repeated or out-of-order sections. */
   
           if (sec == mdoc->lastnamed)
                   return(mwarn(mdoc, WSECREP));
           if (sec < mdoc->lastnamed)
                   return(mwarn(mdoc, WSECOOO));
   
           /* Check particular section/manual section conventions. */
   
           switch (sec) {
           case (SEC_LIBRARY):
                   switch (mdoc->meta.msec) {
                   case (2):
                           /* FALLTHROUGH */
                   case (3):
                           break;
                   default:
                           return(mwarn(mdoc, WWRONGMSEC));
                   }
                   break;
           default:
                   break;
           }
   
         return(1);          return(1);
 }  }
   
   
   static int
   pre_fd(PRE_ARGS)
   {
   
           return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
   }
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.93
CVSweb