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

Diff for /mandoc/man.c between version 1.64 and 1.96

version 1.64, 2010/05/08 10:25:27 version 1.96, 2011/01/03 11:31:26
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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 above   * purpose with or without fee is hereby granted, provided that the above
Line 21 
Line 21 
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  #include <stdio.h>
 #include <string.h>  #include <string.h>
   
   #include "mandoc.h"
 #include "libman.h"  #include "libman.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   
 const   char *const __man_merrnames[WERRMAX] = {  
         "invalid character", /* WNPRINT */  
         "invalid manual section", /* WMSEC */  
         "invalid date format", /* WDATE */  
         "scope of prior line violated", /* WLNSCOPE */  
         "over-zealous prior line scope violation", /* WLNSCOPE2 */  
         "trailing whitespace", /* WTSPACE */  
         "unterminated quoted parameter", /* WTQUOTE */  
         "document has no body", /* WNODATA */  
         "document has no title/section", /* WNOTITLE */  
         "invalid escape sequence", /* WESCAPE */  
         "invalid number format", /* WNUMFMT */  
         "expected block head arguments", /* WHEADARGS */  
         "expected block body arguments", /* WBODYARGS */  
         "expected empty block head", /* WNHEADARGS */  
         "ill-formed macro", /* WMACROFORM */  
         "scope open on exit", /* WEXITSCOPE */  
         "no scope context", /* WNOSCOPE */  
         "literal context already open", /* WOLITERAL */  
         "no literal context open", /* WNLITERAL */  
         "invalid nesting of roff declarations", /* WROFFNEST */  
         "scope in roff instructions broken", /* WROFFSCOPE */  
         "document title should be uppercase", /* WTITLECASE */  
         "deprecated comment style", /* WBADCOMMENT */  
 };  
   
 const   char *const __man_macronames[MAN_MAX] = {  const   char *const __man_macronames[MAN_MAX] = {
         "br",           "TH",           "SH",           "SS",          "br",           "TH",           "SH",           "SS",
         "TP",           "LP",           "PP",           "P",          "TP",           "LP",           "PP",           "P",
         "IP",           "HP",           "SM",           "SB",          "IP",           "HP",           "SM",           "SB",
         "BI",           "IB",           "BR",           "RB",          "BI",           "IB",           "BR",           "RB",
         "R",            "B",            "I",            "IR",          "R",            "B",            "I",            "IR",
         "RI",           "na",           "i",            "sp",          "RI",           "na",           "sp",           "nf",
         "nf",           "fi",           "r",            "RE",          "fi",           "RE",           "RS",           "DT",
         "RS",           "DT",           "UC",           "PD",          "UC",           "PD",           "AT",           "in",
         "Sp",           "Vb",           "Ve",           "de",          "ft"
         "dei",          "am",           "ami",          "ig",  
         ".",  
         };          };
   
 const   char * const *man_macronames = __man_macronames;  const   char * const *man_macronames = __man_macronames;
Line 76  static struct man_node *man_node_alloc(int, int, 
Line 48  static struct man_node *man_node_alloc(int, int, 
                                 enum man_type, enum mant);                                  enum man_type, enum mant);
 static  int              man_node_append(struct man *,  static  int              man_node_append(struct man *,
                                 struct man_node *);                                  struct man_node *);
   static  int              man_span_alloc(struct man *,
                                   const struct tbl_span *);
 static  void             man_node_free(struct man_node *);  static  void             man_node_free(struct man_node *);
 static  void             man_node_unlink(struct man *,  static  void             man_node_unlink(struct man *,
                                 struct man_node *);                                  struct man_node *);
 static  int              man_ptext(struct man *, int, char *);  static  int              man_ptext(struct man *, int, char *, int);
 static  int              man_pmacro(struct man *, int, char *);  static  int              man_pmacro(struct man *, int, char *, int);
 static  void             man_free1(struct man *);  static  void             man_free1(struct man *);
 static  void             man_alloc1(struct man *);  static  void             man_alloc1(struct man *);
 static  int              macrowarn(struct man *, int, const char *);  static  int              man_descope(struct man *, int, int);
   
   
 const struct man_node *  const struct man_node *
 man_node(const struct man *m)  man_node(const struct man *m)
 {  {
   
         return(MAN_HALT & m->flags ? NULL : m->first);          assert( ! (MAN_HALT & m->flags));
           return(m->first);
 }  }
   
   
Line 98  const struct man_meta *
Line 73  const struct man_meta *
 man_meta(const struct man *m)  man_meta(const struct man *m)
 {  {
   
         return(MAN_HALT & m->flags ? NULL : &m->meta);          assert( ! (MAN_HALT & m->flags));
           return(&m->meta);
 }  }
   
   
Line 121  man_free(struct man *man)
Line 97  man_free(struct man *man)
   
   
 struct man *  struct man *
 man_alloc(void *data, int pflags, const struct man_cb *cb)  man_alloc(struct regset *regs, void *data, mandocmsg msg)
 {  {
         struct man      *p;          struct man      *p;
   
         p = mandoc_calloc(1, sizeof(struct man));          p = mandoc_calloc(1, sizeof(struct man));
   
         if (cb)  
                 memcpy(&p->cb, cb, sizeof(struct man_cb));  
   
         man_hash_init();          man_hash_init();
         p->data = data;          p->data = data;
         p->pflags = pflags;          p->msg = msg;
           p->regs = regs;
   
         man_alloc1(p);          man_alloc1(p);
         return(p);          return(p);
Line 143  int
Line 117  int
 man_endparse(struct man *m)  man_endparse(struct man *m)
 {  {
   
         if (MAN_HALT & m->flags)          assert( ! (MAN_HALT & m->flags));
                 return(0);          if (man_macroend(m))
         else if (man_macroend(m))  
                 return(1);                  return(1);
         m->flags |= MAN_HALT;          m->flags |= MAN_HALT;
         return(0);          return(0);
Line 153  man_endparse(struct man *m)
Line 126  man_endparse(struct man *m)
   
   
 int  int
 man_parseln(struct man *m, int ln, char *buf)  man_parseln(struct man *m, int ln, char *buf, int offs)
 {  {
   
         return('.' == *buf || '\'' == *buf ?          assert( ! (MAN_HALT & m->flags));
                         man_pmacro(m, ln, buf) :          return(('.' == buf[offs] || '\'' == buf[offs]) ?
                         man_ptext(m, ln, buf));                          man_pmacro(m, ln, buf, offs) :
                           man_ptext(m, ln, buf, offs));
 }  }
   
   
Line 172  man_free1(struct man *man)
Line 146  man_free1(struct man *man)
                 free(man->meta.title);                  free(man->meta.title);
         if (man->meta.source)          if (man->meta.source)
                 free(man->meta.source);                  free(man->meta.source);
           if (man->meta.rawdate)
                   free(man->meta.rawdate);
         if (man->meta.vol)          if (man->meta.vol)
                 free(man->meta.vol);                  free(man->meta.vol);
           if (man->meta.msec)
                   free(man->meta.msec);
 }  }
   
   
Line 236  man_node_append(struct man *man, struct man_node *p)
Line 214  man_node_append(struct man *man, struct man_node *p)
         man->last = p;          man->last = p;
   
         switch (p->type) {          switch (p->type) {
           case (MAN_TBL):
                   /* FALLTHROUGH */
         case (MAN_TEXT):          case (MAN_TEXT):
                 if ( ! man_valid_post(man))                  if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_action_post(man))  
                         return(0);  
                 break;                  break;
         default:          default:
                 break;                  break;
Line 315  man_block_alloc(struct man *m, int line, int pos, enum
Line 293  man_block_alloc(struct man *m, int line, int pos, enum
         return(1);          return(1);
 }  }
   
   static int
   man_span_alloc(struct man *m, const struct tbl_span *span)
   {
           struct man_node *n;
   
           /* FIXME: grab from span */
           n = man_node_alloc(0, 0, MAN_TBL, MAN_MAX);
           n->span = span;
   
           if ( ! man_node_append(m, n))
                   return(0);
   
           m->next = MAN_NEXT_SIBLING;
           return(1);
   }
   
 int  int
 man_word_alloc(struct man *m, int line, int pos, const char *word)  man_word_alloc(struct man *m, int line, int pos, const char *word)
 {  {
Line 365  man_node_delete(struct man *m, struct man_node *p)
Line 358  man_node_delete(struct man *m, struct man_node *p)
 }  }
   
   
   int
   man_addspan(struct man *m, const struct tbl_span *sp)
   {
   
           assert( ! (MAN_HALT & m->flags));
           if ( ! man_span_alloc(m, sp))
                   return(0);
           return(man_descope(m, 0, 0));
   }
   
 static int  static int
 man_ptext(struct man *m, int line, char *buf)  man_descope(struct man *m, int line, int offs)
 {  {
           /*
            * Co-ordinate what happens with having a next-line scope open:
            * first close out the element scope (if applicable), then close
            * out the block scope (also if applicable).
            */
   
           if (MAN_ELINE & m->flags) {
                   m->flags &= ~MAN_ELINE;
                   if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                           return(0);
           }
   
           if ( ! (MAN_BLINE & m->flags))
                   return(1);
           m->flags &= ~MAN_BLINE;
   
           if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                   return(0);
           return(man_body_alloc(m, line, offs, m->last->tok));
   }
   
   
   static int
   man_ptext(struct man *m, int line, char *buf, int offs)
   {
         int              i;          int              i;
   
         /* Ignore bogus comments. */          /* Ignore bogus comments. */
   
         if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])          if ('\\' == buf[offs] &&
                 return(man_pwarn(m, line, 0, WBADCOMMENT));                          '.' == buf[offs + 1] &&
                           '"' == buf[offs + 2]) {
                   man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
                   return(1);
           }
   
         /* Literal free-form text whitespace is preserved. */          /* Literal free-form text whitespace is preserved. */
   
         if (MAN_LITERAL & m->flags) {          if (MAN_LITERAL & m->flags) {
                 if ( ! man_word_alloc(m, line, 0, buf))                  if ( ! man_word_alloc(m, line, offs, buf + offs))
                         return(0);                          return(0);
                 goto descope;                  return(man_descope(m, line, offs));
         }          }
   
         /* Pump blank lines directly into the backend. */          /* Pump blank lines directly into the backend. */
   
         for (i = 0; ' ' == buf[i]; i++)          for (i = offs; ' ' == buf[i]; i++)
                 /* Skip leading whitespace. */ ;                  /* Skip leading whitespace. */ ;
   
         if ('\0' == buf[i]) {          if ('\0' == buf[i]) {
                 /* Allocate a blank entry. */                  /* Allocate a blank entry. */
                 if ( ! man_word_alloc(m, line, 0, ""))                  if ( ! man_word_alloc(m, line, offs, ""))
                         return(0);                          return(0);
                 goto descope;                  return(man_descope(m, line, offs));
         }          }
   
         /*          /*
Line 405  man_ptext(struct man *m, int line, char *buf)
Line 437  man_ptext(struct man *m, int line, char *buf)
   
         if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {          if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                 if (i > 1 && '\\' != buf[i - 2])                  if (i > 1 && '\\' != buf[i - 2])
                         if ( ! man_pwarn(m, line, i - 1, WTSPACE))                          man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE);
                                 return(0);  
   
                 for (--i; i && ' ' == buf[i]; i--)                  for (--i; i && ' ' == buf[i]; i--)
                         /* Spin back to non-space. */ ;                          /* Spin back to non-space. */ ;
Line 417  man_ptext(struct man *m, int line, char *buf)
Line 448  man_ptext(struct man *m, int line, char *buf)
                 buf[i] = '\0';                  buf[i] = '\0';
         }          }
   
         if ( ! man_word_alloc(m, line, 0, buf))          if ( ! man_word_alloc(m, line, offs, buf + offs))
                 return(0);                  return(0);
   
 descope:  
         /*          /*
          * Co-ordinate what happens with having a next-line scope open:           * End-of-sentence check.  If the last character is an unescaped
          * first close out the element scope (if applicable), then close           * EOS character, then flag the node as being the end of a
          * out the block scope (also if applicable).           * sentence.  The front-end will know how to interpret this.
          */           */
   
         if (MAN_ELINE & m->flags) {          assert(i);
                 m->flags &= ~MAN_ELINE;          if (mandoc_eos(buf, (size_t)i, 0))
                 if ( ! man_unscope(m, m->last->parent, WERRMAX))                  m->last->flags |= MAN_EOS;
                         return(0);  
         }  
   
         if ( ! (MAN_BLINE & m->flags))          return(man_descope(m, line, offs));
                 return(1);  
         m->flags &= ~MAN_BLINE;  
   
         if ( ! man_unscope(m, m->last->parent, WERRMAX))  
                 return(0);  
         return(man_body_alloc(m, line, 0, m->last->tok));  
 }  }
   
   
 static int  static int
 macrowarn(struct man *m, int ln, const char *buf)  man_pmacro(struct man *m, int ln, char *buf, int offs)
 {  {
         if ( ! (MAN_IGN_MACRO & m->pflags))  
                 return(man_verr(m, ln, 0, "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
         return(man_vwarn(m, ln, 0, "unknown macro: %s%s",  
                                 buf, strlen(buf) > 3 ? "..." : ""));  
 }  
   
   
 int  
 man_pmacro(struct man *m, int ln, char *buf)  
 {  
         int              i, j, ppos;          int              i, j, ppos;
         enum mant        tok;          enum mant        tok;
         char             mac[5];          char             mac[5];
Line 464  man_pmacro(struct man *m, int ln, char *buf)
Line 475  man_pmacro(struct man *m, int ln, char *buf)
   
         /* Comments and empties are quickly ignored. */          /* Comments and empties are quickly ignored. */
   
         if ('\0' == buf[1])          offs++;
   
           if ('\0' == buf[offs])
                 return(1);                  return(1);
   
         i = 1;          i = offs;
   
         /*          /*
          * Skip whitespace between the control character and initial           * Skip whitespace between the control character and initial
Line 484  man_pmacro(struct man *m, int ln, char *buf)
Line 497  man_pmacro(struct man *m, int ln, char *buf)
   
         ppos = i;          ppos = i;
   
         /* Copy the first word into a nil-terminated buffer. */          /*
            * Copy the first word into a nil-terminated buffer.
            * Stop copying when a tab, space, or eoln is encountered.
            */
   
         for (j = 0; j < 4; j++, i++) {          j = 0;
                 if ('\0' == (mac[j] = buf[i]))          while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
                         break;                  mac[j++] = buf[i++];
                 else if (' ' == buf[i])  
                         break;  
   
                 /* Check for invalid characters. */  
   
                 if (isgraph((u_char)buf[i]))  
                         continue;  
                 return(man_perr(m, ln, i, WNPRINT));  
         }  
   
         mac[j] = '\0';          mac[j] = '\0';
   
         if (j == 4 || j < 1) {          tok = (j > 0 && j < 4) ? man_hash_find(mac) : MAN_MAX;
                 if ( ! (MAN_IGN_MACRO & m->pflags)) {          if (MAN_MAX == tok) {
                         (void)man_perr(m, ln, ppos, WMACROFORM);                  man_vmsg(m, MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
                         goto err;  
                 }  
                 if ( ! man_pwarn(m, ln, ppos, WMACROFORM))  
                         goto err;  
                 return(1);                  return(1);
         }          }
   
         if (MAN_MAX == (tok = man_hash_find(mac))) {  
                 if ( ! macrowarn(m, ln, mac))  
                         goto err;  
                 return(1);  
         }  
   
         /* The macro is sane.  Jump to the next word. */          /* The macro is sane.  Jump to the next word. */
   
Line 528  man_pmacro(struct man *m, int ln, char *buf)
Line 524  man_pmacro(struct man *m, int ln, char *buf)
          */           */
   
         if ('\0' == buf[i] && ' ' == buf[i - 1])          if ('\0' == buf[i] && ' ' == buf[i - 1])
                 if ( ! man_pwarn(m, ln, i - 1, WTSPACE))                  man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
                         goto err;  
   
         /*          /*
          * Remove prior ELINE macro, as it's being clobbering by a new           * Remove prior ELINE macro, as it's being clobbered by a new
          * macro.  Note that NSCOPED macros do not close out ELINE           * macro.  Note that NSCOPED macros do not close out ELINE
          * macros---they don't print text---so we let those slip by.           * macros---they don't print text---so we let those slip by.
          * NOTE: we don't allow roff blocks (NOCLOSE) to be embedded  
          * here because that would stipulate blocks as children of  
          * elements!  
          */           */
   
         if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&          if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
                         m->flags & MAN_ELINE) {                          m->flags & MAN_ELINE) {
                 assert(MAN_TEXT != m->last->type);  
   
                 /*  
                  * This occurs in the following construction:  
                  *   .B  
                  *   .br  
                  *   .B  
                  *   .br  
                  *   I hate man macros.  
                  * Flat-out disallow this madness.  
                  */  
                 if (MAN_NSCOPED & man_macros[m->last->tok].flags)  
                         return(man_perr(m, ln, ppos, WLNSCOPE));  
   
                 n = m->last;                  n = m->last;
                   assert(MAN_TEXT != n->type);
   
                 assert(n);                  /* Remove repeated NSCOPED macros causing ELINE. */
                 assert(NULL == n->child);  
                 assert(0 == n->nchild);  
   
                 if ( ! man_nwarn(m, n, WLNSCOPE))                  if (MAN_NSCOPED & man_macros[n->tok].flags)
                         return(0);                          n = n->parent;
   
                   man_vmsg(m, MANDOCERR_LINESCOPE, n->line, n->pos,
                                   "%s", man_macronames[n->tok]);
   
                 man_node_delete(m, n);                  man_node_delete(m, n);
                 m->flags &= ~MAN_ELINE;                  m->flags &= ~MAN_ELINE;
         }          }
Line 619  out:
Line 599  out:
         assert(MAN_BLINE & m->flags);          assert(MAN_BLINE & m->flags);
         m->flags &= ~MAN_BLINE;          m->flags &= ~MAN_BLINE;
   
         if ( ! man_unscope(m, m->last->parent, WERRMAX))          if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                 return(0);                  return(0);
         return(man_body_alloc(m, ln, 0, m->last->tok));          return(man_body_alloc(m, ln, offs, m->last->tok));
   
 err:    /* Error out. */  err:    /* Error out. */
   
Line 631  err: /* Error out. */
Line 611  err: /* Error out. */
   
   
 int  int
 man_verr(struct man *man, int ln, int pos, const char *fmt, ...)  man_vmsg(struct man *man, enum mandocerr t,
                   int ln, int pos, const char *fmt, ...)
 {  {
         char             buf[256];          char             buf[256];
         va_list          ap;          va_list          ap;
   
         if (NULL == man->cb.man_err)  
                 return(0);  
   
         va_start(ap, fmt);          va_start(ap, fmt);
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);          vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
         va_end(ap);          va_end(ap);
         return((*man->cb.man_err)(man->data, ln, pos, buf));          return((*man->msg)(t, man->data, ln, pos, buf));
 }  
   
   
 int  
 man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)  
 {  
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == man->cb.man_warn)  
                 return(0);  
   
         va_start(ap, fmt);  
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);  
         va_end(ap);  
         return((*man->cb.man_warn)(man->data, ln, pos, buf));  
 }  
   
   
 int  
 man_err(struct man *m, int line, int pos, int iserr, enum merr type)  
 {  
         const char       *p;  
   
         p = __man_merrnames[(int)type];  
         assert(p);  
   
         if (iserr)  
                 return(man_verr(m, line, pos, p));  
   
         return(man_vwarn(m, line, pos, p));  
 }  }
   
   
Legend:
Removed from v.1.64  
changed lines
  Added in v.1.96
CVSweb