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

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

version 1.1, 2008/11/29 14:14:21 version 1.23, 2009/01/09 15:15:31
Line 16 
Line 16 
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.   * PERFORMANCE OF THIS SOFTWARE.
  */   */
 #include <sys/param.h>  
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <err.h>  
 #include <stdio.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  
   
 #include "libmdocml.h"  
 #include "private.h"  #include "private.h"
   
 #ifdef  __linux__ /* FIXME */  
 #define strlcat         strncat  
 #endif  
   
 struct  md_valid {  typedef int     (*v_pre)(struct mdoc *, struct mdoc_node *);
         const struct md_args    *args;  typedef int     (*v_post)(struct mdoc *);
         const struct md_rbuf    *rbuf;  
         struct md_mbuf  *mbuf;  
         struct rofftree *tree;  
   
         size_t           indent;  
         size_t           pos;  
   
         int              flags;  struct  valids {
 #define MD_LITERAL      (1 << 0)          v_pre    pre;
           v_post  *post;
 };  };
   
 static  void             roffmsg(void *arg, enum roffmsg,  
                                 const char *, const char *, char *);  
 static  int              roffhead(void *);  
 static  int              rofftail(void *);  
 static  int              roffin(void *, int, int *, char **);  
 static  int              roffdata(void *, char *);  
 static  int              roffout(void *, int);  
 static  int              roffblkin(void *, int);  
 static  int              roffblkout(void *, int);  
 static  int              roffspecial(void *, int);  
   
 static  int              mbuf_newline(struct md_valid *);  static  int     pre_display(struct mdoc *, struct mdoc_node *);
 static  int              mbuf_indent(struct md_valid *);  static  int     pre_prologue(struct mdoc *, struct mdoc_node *);
 static  int              mbuf_data(struct md_valid *, char *);  static  int     pre_prologue(struct mdoc *, struct mdoc_node *);
   static  int     pre_prologue(struct mdoc *, struct mdoc_node *);
   static  int     post_headchild_err_ge1(struct mdoc *);
   static  int     post_elemchild_err_ge1(struct mdoc *);
   static  int     post_elemchild_warn_eq0(struct mdoc *);
   static  int     post_bodychild_warn_ge1(struct mdoc *);
   static  int     post_sh(struct mdoc *);
   
   static  v_post  posts_sh[] = { post_headchild_err_ge1,
                           post_bodychild_warn_ge1, post_sh, NULL };
   static  v_post  posts_ss[] = { post_headchild_err_ge1, NULL };
   static  v_post  posts_pp[] = { post_elemchild_warn_eq0, NULL };
   static  v_post  posts_dd[] = { post_elemchild_err_ge1, NULL };
   static  v_post  posts_display[] = { post_headchild_err_ge1, NULL };
   
 static int  
 mbuf_indent(struct md_valid *p)  
 {  
         size_t           i;  
   
         assert(0 == p->pos);  const   struct valids mdoc_valids[MDOC_MAX] = {
           { NULL, NULL }, /* \" */
           { pre_prologue, posts_dd }, /* Dd */
           { pre_prologue, NULL }, /* Dt */
           { pre_prologue, NULL }, /* Os */
           { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */
           { NULL, posts_ss }, /* Ss */ /* FIXME: preceding Pp. */
           { NULL, posts_pp }, /* Pp */ /* FIXME: proceeding... */
           { pre_display, posts_display }, /* D1 */
           { pre_display, posts_display }, /* Dl */
           { pre_display, NULL }, /* Bd */ /* FIXME: preceding Pp. */
           { NULL, NULL }, /* Ed */
           { NULL, NULL }, /* Bl */ /* FIXME: preceding Pp. */
           { NULL, NULL }, /* El */
           { NULL, NULL }, /* It */
           { NULL, NULL }, /* Ad */
           { NULL, NULL }, /* An */
           { NULL, NULL }, /* Ar */
           { NULL, NULL }, /* Cd */
           { NULL, NULL }, /* Cm */
           { NULL, NULL }, /* Dv */
           { NULL, NULL }, /* Er */
           { NULL, NULL }, /* Ev */
           { NULL, NULL }, /* Ex */
           { NULL, NULL }, /* Fa */
           { NULL, NULL }, /* Fd */
           { NULL, NULL }, /* Fl */
           { NULL, NULL }, /* Fn */
           { NULL, NULL }, /* Ft */
           { NULL, NULL }, /* Ic */
           { NULL, NULL }, /* In */
           { NULL, NULL }, /* Li */
           { NULL, NULL }, /* Nd */
           { NULL, NULL }, /* Nm */
           { NULL, NULL }, /* Op */
           { NULL, NULL }, /* Ot */
           { NULL, NULL }, /* Pa */
           { NULL, NULL }, /* Rv */
           { NULL, NULL }, /* St */
           { NULL, NULL }, /* Va */
           { NULL, NULL }, /* Vt */
           { NULL, NULL }, /* Xr */
           { NULL, NULL }, /* %A */
           { NULL, NULL }, /* %B */
           { NULL, NULL }, /* %D */
           { NULL, NULL }, /* %I */
           { NULL, NULL }, /* %J */
           { NULL, NULL }, /* %N */
           { NULL, NULL }, /* %O */
           { NULL, NULL }, /* %P */
           { NULL, NULL }, /* %R */
           { NULL, NULL }, /* %T */
           { NULL, NULL }, /* %V */
           { NULL, NULL }, /* Ac */
           { NULL, NULL }, /* Ao */
           { NULL, NULL }, /* Aq */
           { NULL, NULL }, /* At */ /* FIXME */
           { NULL, NULL }, /* Bc */
           { NULL, NULL }, /* Bf */
           { NULL, NULL }, /* Bo */
           { NULL, NULL }, /* Bq */
           { NULL, NULL }, /* Bsx */
           { NULL, NULL }, /* Bx */
           { NULL, NULL }, /* Db */
           { NULL, NULL }, /* Dc */
           { NULL, NULL }, /* Do */
           { NULL, NULL }, /* Dq */
           { NULL, NULL }, /* Ec */
           { NULL, NULL }, /* Ef */ /* -symbolic, etc. */
           { NULL, NULL }, /* Em */
           { NULL, NULL }, /* Eo */
           { NULL, NULL }, /* Fx */
           { NULL, NULL }, /* Ms */
           { NULL, NULL }, /* No */
           { NULL, NULL }, /* Ns */
           { NULL, NULL }, /* Nx */
           { NULL, NULL }, /* Ox */
           { NULL, NULL }, /* Pc */
           { NULL, NULL }, /* Pf */ /* 2 or more arguments */
           { NULL, NULL }, /* Po */
           { NULL, NULL }, /* Pq */ /* FIXME: ignore following Sh/Ss */
           { NULL, NULL }, /* Qc */
           { NULL, NULL }, /* Ql */
           { NULL, NULL }, /* Qo */
           { NULL, NULL }, /* Qq */
           { NULL, NULL }, /* Re */
           { NULL, NULL }, /* Rs */
           { NULL, NULL }, /* Sc */
           { NULL, NULL }, /* So */
           { NULL, NULL }, /* Sq */
           { NULL, NULL }, /* Sm */
           { NULL, NULL }, /* Sx */
           { NULL, NULL }, /* Sy */
           { NULL, NULL }, /* 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, NULL }, /* Bt */
           { NULL, NULL }, /* Hf */
           { NULL, NULL }, /* Fr */
           { NULL, NULL }, /* Ud */
   };
   
         for (i = 0; i < MIN(p->indent, 4); i++)  
                 if ( ! md_buf_putstring(p->mbuf, "    "))  
                         return(0);  
   
         p->pos = i * 4;  
         return(1);  
 }  
   
   
 static int  static int
 mbuf_atnewline(struct md_valid *p)  post_bodychild_warn_ge1(struct mdoc *mdoc)
 {  {
   
         return(p->pos == MIN(4, p->indent));          if (MDOC_BODY != mdoc->last->type)
                   return(1);
           if (mdoc->last->child)
                   return(1);
   
           return(mdoc_warn(mdoc, WARN_ARGS_GE1));
 }  }
   
   
 static int  static int
 mbuf_newline(struct md_valid *p)  post_elemchild_warn_eq0(struct mdoc *mdoc)
 {  {
   
         if (mbuf_atnewline(p))          assert(MDOC_ELEM == mdoc->last->type);
           if (NULL == mdoc->last->child)
                 return(1);                  return(1);
         if ( ! md_buf_putchar(p->mbuf, '\n'))          return(mdoc_warn(mdoc, WARN_ARGS_EQ0));
                 return(0);  
   
         p->pos = 0;  
         return(mbuf_indent(p));  
 }  }
   
   
 static int  static int
 mbuf_data(struct md_valid *p, char *buf)  post_elemchild_err_ge1(struct mdoc *mdoc)
 {  {
         size_t           sz;  
         char            *bufp;  
   
         assert(p->mbuf);          assert(MDOC_ELEM == mdoc->last->type);
         assert(0 != p->indent);          if (mdoc->last->child)
                   return(1);
         if (MD_LITERAL & p->flags)          return(mdoc_err(mdoc, ERR_ARGS_GE1));
                 return(md_buf_putstring(p->mbuf, buf));  
   
         if (0 == p->pos)  
                 mbuf_indent(p);  
   
         /*  
          * Indent if we're at the beginning of a line.  Don't indent  
          * more than 16 or so characters.  
          */  
   
         while (*buf) {  
                 while (*buf && isspace(*buf))  
                         buf++;  
   
                 if (0 == *buf)  
                         break;  
   
                 bufp = buf;  
                 while (*buf && ! isspace(*buf))  
                         buf++;  
   
                 if (0 != *buf)  
                         *buf++ = 0;  
   
                 /* Process word. */  
   
                 sz = strlen(bufp);  
   
                 if (sz + p->pos < 72) {  
                         if ( ! md_buf_putstring(p->mbuf, bufp))  
                                 return(0);  
   
                         /* FIXME: check punctuation. */  
   
                         if ( ! md_buf_putchar(p->mbuf, ' '))  
                                 return(0);  
                         p->pos += sz + 1;  
                         continue;  
                 }  
   
                 if ( ! mbuf_newline(p))  
                         return(0);  
   
                 if ( ! md_buf_putstring(p->mbuf, bufp))  
                         return(0);  
   
                 /* FIXME: check punctuation. */  
   
                 if ( ! md_buf_putchar(p->mbuf, ' '))  
                         return(0);  
                 p->pos += sz + 1;  
         }  
   
         return(1);  
 }  }
   
   
 int  
 md_line_valid(void *arg, char *buf)  
 {  
         struct md_valid *p;  
   
         p = (struct md_valid *)arg;  
         return(roff_engine(p->tree, buf));  
 }  
   
   
 int  
 md_exit_valid(void *data, int flush)  
 {  
         int              c;  
         struct md_valid *p;  
   
         p = (struct md_valid *)data;  
         c = roff_free(p->tree, flush);  
         free(p);  
   
         return(c);  
 }  
   
   
 void *  
 md_init_valid(const struct md_args *args,  
                 struct md_mbuf *mbuf, const struct md_rbuf *rbuf)  
 {  
         struct roffcb    cb;  
         struct md_valid *p;  
   
         cb.roffhead = roffhead;  
         cb.rofftail = rofftail;  
         cb.roffin = roffin;  
         cb.roffout = roffout;  
         cb.roffblkin = roffblkin;  
         cb.roffblkout = roffblkout;  
         cb.roffspecial = roffspecial;  
         cb.roffmsg = roffmsg;  
         cb.roffdata = roffdata;  
   
         if (NULL == (p = calloc(1, sizeof(struct md_valid))))  
                 err(1, "malloc");  
   
         p->args = args;  
         p->mbuf = mbuf;  
         p->rbuf = rbuf;  
   
         assert(mbuf);  
   
         if (NULL == (p->tree = roff_alloc(&cb, p))) {  
                 free(p);  
                 return(NULL);  
         }  
   
         return(p);  
 }  
   
   
 /* ARGSUSED */  
 static int  static int
 roffhead(void *arg)  post_headchild_err_ge1(struct mdoc *mdoc)
 {  {
   
         return(1);          if (MDOC_HEAD != mdoc->last->type)
                   return(1);
           if (mdoc->last->child)
                   return(1);
           return(mdoc_err(mdoc, ERR_ARGS_GE1));
 }  }
   
   
 static int  static int
 rofftail(void *arg)  pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
         struct md_valid *p;          struct mdoc_node *n;
   
         assert(arg);          for (n = mdoc->last; n; n = n->parent)
         p = (struct md_valid *)arg;                  if (MDOC_BLOCK == n->type)
                           if (MDOC_Bd == n->data.block.tok)
         if (mbuf_atnewline(p))                                  break;
           if (NULL == n)
                 return(1);                  return(1);
           return(mdoc_verr(mdoc, node, ERR_SCOPE_NONEST));
         return(md_buf_putchar(p->mbuf, '\n'));  
 }  }
   
   
 static int  static int
 roffspecial(void *arg, int tok)  pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
   
         return(1);          if (SEC_PROLOGUE != mdoc->sec_lastn)
 }                  return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE));
           assert(MDOC_ELEM == node->type);
   
           /* Check for ordering. */
   
 static int          switch (node->data.elem.tok) {
 roffblkin(void *arg, int tok)          case (MDOC_Os):
 {                  if (mdoc->meta.title[0] && mdoc->meta.date)
         struct md_valid *p;                          break;
                   return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
           case (MDOC_Dt):
                   if (0 == mdoc->meta.title[0] && mdoc->meta.date)
                           break;
                   return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
           case (MDOC_Dd):
                   if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)
                           break;
                   return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
           default:
                   abort();
                   /* NOTREACHED */
           }
   
         assert(arg);          /* Check for repetition. */
         p = (struct md_valid *)arg;  
   
         if ( ! mbuf_atnewline(p)) {          switch (node->data.elem.tok) {
                 if ( ! md_buf_putchar(p->mbuf, '\n'))          case (MDOC_Os):
                         return(0);                  if (0 == mdoc->meta.os[0])
                 p->pos = 0;                          return(1);
                 if ( ! mbuf_indent(p))                  break;
                         return(0);          case (MDOC_Dd):
                   if (0 == mdoc->meta.date)
                           return(1);
                   break;
           case (MDOC_Dt):
                   if (0 == mdoc->meta.title[0])
                           return(1);
                   break;
           default:
                   abort();
                   /* NOTREACHED */
         }          }
   
         if ( ! md_buf_putstring(p->mbuf, toknames[tok]))          return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP));
                 return(0);  
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))  
                 return(0);  
   
         p->pos = 0;  
         p->indent++;  
   
         return(mbuf_indent(p));  
 }  }
   
   
   /*
    * Warn if sections (those that are with a known title, such as NAME,
    * DESCRIPTION, and so forth) are out of the conventional order.
    */
 static int  static int
 roffblkout(void *arg, int tok)  post_sh(struct mdoc *mdoc)
 {  {
         struct md_valid *p;          enum mdoc_sec     sec;
           int               i;
           struct mdoc_node *n;
           char             *args[MDOC_LINEARG_MAX];
   
         assert(arg);          if (MDOC_HEAD != mdoc->last->type)
         p = (struct md_valid *)arg;                  return(1);
   
           assert(MDOC_Sh == mdoc->last->data.head.tok);
   
         if ( ! md_buf_putchar(p->mbuf, '\n'))          n = mdoc->last->child;
                 return(0);          assert(n);
   
         p->pos = 0;          for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {
         p->indent--;                  assert(MDOC_TEXT == n->type);
                   assert(NULL == n->child);
                   assert(n->data.text.string);
                   args[i] = n->data.text.string;
           }
   
         return(mbuf_indent(p));          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_SEC_REP));
 roffin(void *arg, int tok, int *argcp, char **argvp)          return(mdoc_warn(mdoc, WARN_SEC_OO));
 {  
   
         return(1);  
 }  }
   
   
 static int  int
 roffout(void *arg, int tok)  mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
 {  {
           int              t;
   
         return(1);          switch (node->type) {
           case (MDOC_BODY):
                   t = node->data.body.tok;
                   break;
           case (MDOC_ELEM):
                   t = node->data.elem.tok;
                   break;
           case (MDOC_BLOCK):
                   t = node->data.block.tok;
                   break;
           case (MDOC_HEAD):
                   t = node->data.head.tok;
                   break;
           default:
                   return(1);
           }
   
           if (NULL == mdoc_valids[t].pre)
                   return(1);
           return((*mdoc_valids[t].pre)(mdoc, node));
 }  }
   
   
   int
 static void  mdoc_valid_post(struct mdoc *mdoc)
 roffmsg(void *arg, enum roffmsg lvl,  
                 const char *buf, const char *pos, char *msg)  
 {  {
         char            *level;          v_post          *p;
         struct md_valid *p;          int              t;
   
         assert(arg);          switch (mdoc->last->type) {
         p = (struct md_valid *)arg;          case (MDOC_BODY):
                   t = mdoc->last->data.body.tok;
         switch (lvl) {  
         case (ROFF_WARN):  
                 if ( ! (MD_WARN_ALL & p->args->warnings))  
                         return;  
                 level = "warning";  
                 break;                  break;
         case (ROFF_ERROR):          case (MDOC_ELEM):
                 level = "error";                  t = mdoc->last->data.elem.tok;
                 break;                  break;
           case (MDOC_BLOCK):
                   t = mdoc->last->data.block.tok;
                   break;
           case (MDOC_HEAD):
                   t = mdoc->last->data.head.tok;
                   break;
         default:          default:
                 abort();                  return(1);
         }          }
   
         if (pos)  
                 (void)fprintf(stderr, "%s:%zu: %s: %s\n",  
                                 p->rbuf->name, p->rbuf->line, level, msg);  
         else  
                 (void)fprintf(stderr, "%s: %s: %s\n",  
                                 p->rbuf->name, level, msg);  
   
 }          if (NULL == mdoc_valids[t].post)
                   return(1);
   
           for (p = mdoc_valids[t].post; *p; p++)
                   if ( ! (*p)(mdoc))
                           return(0);
   
 static int          return(1);
 roffdata(void *arg, char *buf)  
 {  
         struct md_valid *p;  
   
         assert(arg);  
         p = (struct md_valid *)arg;  
         return(mbuf_data(p, buf));  
 }  }
   
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.23
CVSweb