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

Diff for /mandoc/man.c between version 1.21 and 1.92

version 1.21, 2009/06/16 19:55:28 version 1.92, 2010/12/08 10:58:22
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 14 
Line 14 
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
   #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"
   
 const   char *const __man_macronames[MAN_MAX] = {  const   char *const __man_macronames[MAN_MAX] = {
         "br",           "TH",           "SH",           "SS",          "br",           "TH",           "SH",           "SS",
Line 29  const char *const __man_macronames[MAN_MAX] = {   
Line 36  const char *const __man_macronames[MAN_MAX] = {   
         "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"          "RI",           "na",           "sp",           "nf",
           "fi",           "RE",           "RS",           "DT",
           "UC",           "PD",           "AT",           "in",
           "ft"
         };          };
   
 const   char * const *man_macronames = __man_macronames;  const   char * const *man_macronames = __man_macronames;
   
 static  struct man_node *man_node_alloc(int, int,  static  struct man_node *man_node_alloc(int, int,
                                 enum man_type, int);                                  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_ptext(struct man *, int, char *);  static  void             man_node_free(struct man_node *);
 static  int              man_pmacro(struct man *, int, char *);  static  void             man_node_unlink(struct man *,
                                   struct man_node *);
   static  int              man_ptext(struct man *, int, char *, int);
   static  int              man_pmacro(struct man *, int, char *, int);
 static  void             man_free1(struct man *);  static  void             man_free1(struct man *);
 static  int              man_alloc1(struct man *);  static  void             man_alloc1(struct man *);
   
   
 const struct man_node *  const struct man_node *
Line 60  man_meta(const struct man *m)
Line 73  man_meta(const struct man *m)
 }  }
   
   
 int  void
 man_reset(struct man *man)  man_reset(struct man *man)
 {  {
   
         man_free1(man);          man_free1(man);
         return(man_alloc1(man));          man_alloc1(man);
 }  }
   
   
Line 74  man_free(struct man *man)
Line 87  man_free(struct man *man)
 {  {
   
         man_free1(man);          man_free1(man);
   
         if (man->htab)  
                 man_hash_free(man->htab);  
         free(man);          free(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;
   
         if (NULL == (p = calloc(1, sizeof(struct man))))          p = mandoc_calloc(1, sizeof(struct man));
                 return(NULL);  
   
         if ( ! man_alloc1(p)) {          man_hash_init();
                 free(p);  
                 return(NULL);  
         }  
   
         p->data = data;          p->data = data;
         p->pflags = pflags;          p->msg = msg;
         (void)memcpy(&p->cb, cb, sizeof(struct man_cb));          p->regs = regs;
   
         if (NULL == (p->htab = man_hash_alloc())) {          man_alloc1(p);
                 free(p);  
                 return(NULL);  
         }  
         return(p);          return(p);
 }  }
   
Line 120  man_endparse(struct man *m)
Line 122  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 ?          if (MAN_HALT & m->flags)
                         man_pmacro(m, ln, buf) :                  return(0);
                         man_ptext(m, ln, buf));  
           return(('.' == buf[offs] || '\'' == buf[offs]) ?
                           man_pmacro(m, ln, buf, offs) :
                           man_ptext(m, ln, buf, offs));
 }  }
   
   
Line 134  man_free1(struct man *man)
Line 139  man_free1(struct man *man)
 {  {
   
         if (man->first)          if (man->first)
                 man_node_freelist(man->first);                  man_node_delete(man, man->first);
         if (man->meta.title)          if (man->meta.title)
                 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);
 }  }
   
   
 static int  static void
 man_alloc1(struct man *m)  man_alloc1(struct man *m)
 {  {
   
         bzero(&m->meta, sizeof(struct man_meta));          memset(&m->meta, 0, sizeof(struct man_meta));
         m->flags = 0;          m->flags = 0;
         m->last = calloc(1, sizeof(struct man_node));          m->last = mandoc_calloc(1, sizeof(struct man_node));
         if (NULL == m->last)  
                 return(0);  
         m->first = m->last;          m->first = m->last;
         m->last->type = MAN_ROOT;          m->last->type = MAN_ROOT;
           m->last->tok = MAN_MAX;
         m->next = MAN_NEXT_CHILD;          m->next = MAN_NEXT_CHILD;
         return(1);  
 }  }
   
   
Line 182  man_node_append(struct man *man, struct man_node *p)
Line 189  man_node_append(struct man *man, struct man_node *p)
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
           assert(p->parent);
           p->parent->nchild++;
   
           if ( ! man_valid_pre(man, p))
                   return(0);
   
           switch (p->type) {
           case (MAN_HEAD):
                   assert(MAN_BLOCK == p->parent->type);
                   p->parent->head = p;
                   break;
           case (MAN_BODY):
                   assert(MAN_BLOCK == p->parent->type);
                   p->parent->body = p;
                   break;
           default:
                   break;
           }
   
         man->last = p;          man->last = p;
   
         switch (p->type) {          switch (p->type) {
         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 201  man_node_append(struct man *man, struct man_node *p)
Line 225  man_node_append(struct man *man, struct man_node *p)
   
   
 static struct man_node *  static struct man_node *
 man_node_alloc(int line, int pos, enum man_type type, int tok)  man_node_alloc(int line, int pos, enum man_type type, enum mant tok)
 {  {
         struct man_node *p;          struct man_node *p;
   
         p = calloc(1, sizeof(struct man_node));          p = mandoc_calloc(1, sizeof(struct man_node));
         if (NULL == p)  
                 return(NULL);  
   
         p->line = line;          p->line = line;
         p->pos = pos;          p->pos = pos;
         p->type = type;          p->type = type;
Line 218  man_node_alloc(int line, int pos, enum man_type type, 
Line 239  man_node_alloc(int line, int pos, enum man_type type, 
   
   
 int  int
 man_elem_alloc(struct man *man, int line, int pos, int tok)  man_elem_alloc(struct man *m, int line, int pos, enum mant tok)
 {  {
         struct man_node *p;          struct man_node *p;
   
         p = man_node_alloc(line, pos, MAN_ELEM, tok);          p = man_node_alloc(line, pos, MAN_ELEM, tok);
         if (NULL == p)          if ( ! man_node_append(m, p))
                 return(0);                  return(0);
         return(man_node_append(man, p));          m->next = MAN_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 man_word_alloc(struct man *man,  man_head_alloc(struct man *m, int line, int pos, enum mant tok)
                 int line, int pos, const char *word)  
 {  {
         struct man_node *p;          struct man_node *p;
   
         p = man_node_alloc(line, pos, MAN_TEXT, -1);          p = man_node_alloc(line, pos, MAN_HEAD, tok);
         if (NULL == p)          if ( ! man_node_append(m, p))
                 return(0);                  return(0);
         if (NULL == (p->string = strdup(word)))          m->next = MAN_NEXT_CHILD;
           return(1);
   }
   
   
   int
   man_body_alloc(struct man *m, int line, int pos, enum mant tok)
   {
           struct man_node *p;
   
           p = man_node_alloc(line, pos, MAN_BODY, tok);
           if ( ! man_node_append(m, p))
                 return(0);                  return(0);
         return(man_node_append(man, p));          m->next = MAN_NEXT_CHILD;
           return(1);
 }  }
   
   
 void  int
   man_block_alloc(struct man *m, int line, int pos, enum mant tok)
   {
           struct man_node *p;
   
           p = man_node_alloc(line, pos, MAN_BLOCK, tok);
           if ( ! man_node_append(m, p))
                   return(0);
           m->next = MAN_NEXT_CHILD;
           return(1);
   }
   
   
   int
   man_word_alloc(struct man *m, int line, int pos, const char *word)
   {
           struct man_node *n;
           size_t           sv, len;
   
           len = strlen(word);
   
           n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX);
           n->string = mandoc_malloc(len + 1);
           sv = strlcpy(n->string, word, len + 1);
   
           /* Prohibit truncation. */
           assert(sv < len + 1);
   
           if ( ! man_node_append(m, n))
                   return(0);
   
           m->next = MAN_NEXT_SIBLING;
           return(1);
   }
   
   
   /*
    * Free all of the resources held by a node.  This does NOT unlink a
    * node from its context; for that, see man_node_unlink().
    */
   static void
 man_node_free(struct man_node *p)  man_node_free(struct man_node *p)
 {  {
   
Line 255  man_node_free(struct man_node *p)
Line 328  man_node_free(struct man_node *p)
   
   
 void  void
 man_node_freelist(struct man_node *p)  man_node_delete(struct man *m, struct man_node *p)
 {  {
   
         if (p->child)          while (p->child)
                 man_node_freelist(p->child);                  man_node_delete(m, p->child);
         if (p->next)  
                 man_node_freelist(p->next);  
   
           man_node_unlink(m, p);
         man_node_free(p);          man_node_free(p);
 }  }
   
   
 static int  static int
 man_ptext(struct man *m, int line, char *buf)  man_ptext(struct man *m, int line, char *buf, int offs)
 {  {
           int              i;
   
         if ( ! man_word_alloc(m, line, 0, buf))          /* Ignore bogus comments. */
   
           if ('\\' == buf[offs] &&
                           '.' == buf[offs + 1] &&
                           '"' == buf[offs + 2])
                   return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
   
           /* Literal free-form text whitespace is preserved. */
   
           if (MAN_LITERAL & m->flags) {
                   if ( ! man_word_alloc(m, line, offs, buf + offs))
                           return(0);
                   goto descope;
           }
   
           /* Pump blank lines directly into the backend. */
   
           for (i = offs; ' ' == buf[i]; i++)
                   /* Skip leading whitespace. */ ;
   
           if ('\0' == buf[i]) {
                   /* Allocate a blank entry. */
                   if ( ! man_word_alloc(m, line, offs, ""))
                           return(0);
                   goto descope;
           }
   
           /*
            * Warn if the last un-escaped character is whitespace. Then
            * strip away the remaining spaces (tabs stay!).
            */
   
           i = (int)strlen(buf);
           assert(i);
   
           if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                   if (i > 1 && '\\' != buf[i - 2])
                           if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE))
                                   return(0);
   
                   for (--i; i && ' ' == buf[i]; i--)
                           /* Spin back to non-space. */ ;
   
                   /* Jump ahead of escaped whitespace. */
                   i += '\\' == buf[i] ? 2 : 1;
   
                   buf[i] = '\0';
           }
   
           if ( ! man_word_alloc(m, line, offs, buf + offs))
                 return(0);                  return(0);
         m->next = MAN_NEXT_SIBLING;  
   
         /*          /*
          * If this is one of the zany NLINE macros that consumes the           * End-of-sentence check.  If the last character is an unescaped
          * next line of input as being influenced, then close out the           * EOS character, then flag the node as being the end of a
          * existing macro "scope" and continue processing.           * sentence.  The front-end will know how to interpret this.
          */           */
   
         if ( ! (MAN_NLINE & m->flags))          assert(i);
                 return(1);          if (mandoc_eos(buf, (size_t)i, 0))
                   m->last->flags |= MAN_EOS;
   
         m->flags &= ~MAN_NLINE;  descope:
         m->last = m->last->parent;          /*
            * 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).
            */
   
         assert(MAN_ROOT != m->last->type);          if (MAN_ELINE & m->flags) {
         if ( ! man_valid_post(m))                  m->flags &= ~MAN_ELINE;
                 return(0);                  if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
         if ( ! man_action_post(m))                          return(0);
                 return(0);          }
   
         return(1);          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));
 }  }
   
   
 int  int
 man_pmacro(struct man *m, int ln, char *buf)  man_pmacro(struct man *m, int ln, char *buf, int offs)
 {  {
         int               i, j, c, ppos, fl;          int              i, j, ppos;
         char              mac[5];          enum mant        tok;
         struct man_node  *n;          char             mac[5];
           struct man_node *n;
   
         /* Comments and empties are quickly ignored. */          /* Comments and empties are quickly ignored. */
   
         n = m->last;          offs++;
         fl = MAN_NLINE & m->flags;  
   
         if (0 == buf[1])          if ('\0' == buf[offs])
                 goto out;                  return(1);
   
         i = 1;          i = offs;
   
         if (' ' == buf[i]) {          /*
            * Skip whitespace between the control character and initial
            * text.  "Whitespace" is both spaces and tabs.
            */
   
           if (' ' == buf[i] || '\t' == buf[i]) {
                 i++;                  i++;
                 while (buf[i] && ' ' == buf[i])                  while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
                         i++;                          i++;
                 if (0 == buf[i])                  if ('\0' == buf[i])
                         goto out;                          goto out;
         }          }
   
         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])          mac[j] = '\0';
                         break;  
         }  
   
         mac[j] = 0;          tok = (j > 0 && j < 4) ? man_hash_find(mac) : MAN_MAX;
           if (MAN_MAX == tok) {
         if (j == 4 || j < 1) {                  man_vmsg(m, MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
                 if ( ! (MAN_IGN_MACRO & m->pflags)) {  
                         (void)man_verr(m, ln, ppos,  
                                 "ill-formed macro: %s", mac);  
                         goto err;  
                 }  
                 if ( ! man_vwarn(m, ln, ppos,  
                                 "ill-formed macro: %s", mac))  
                         goto err;  
                 return(1);                  return(1);
         }          }
   
         if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {  
                 if ( ! (MAN_IGN_MACRO & m->pflags)) {  
                         (void)man_verr(m, ln, ppos,  
                                 "unknown macro: %s", mac);  
                         goto err;  
                 }  
                 if ( ! man_vwarn(m, ln, ppos,  
                                 "unknown macro: %s", mac))  
                         goto err;  
                 return(1);  
         }  
   
         /* The macro is sane.  Jump to the next word. */          /* The macro is sane.  Jump to the next word. */
   
         while (buf[i] && ' ' == buf[i])          while (buf[i] && ' ' == buf[i])
                 i++;                  i++;
   
         /* Begin recursive parse sequence. */          /*
            * Trailing whitespace.  Note that tabs are allowed to be passed
            * into the parser as "text", so we only warn about spaces here.
            */
   
         if ( ! man_macro(m, c, ln, ppos, &i, buf))          if ('\0' == buf[i] && ' ' == buf[i - 1])
                   if ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
                           goto err;
   
           /*
            * Remove prior ELINE macro, as it's being clobbered by a new
            * macro.  Note that NSCOPED macros do not close out ELINE
            * macros---they don't print text---so we let those slip by.
            */
   
           if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
                           m->flags & MAN_ELINE) {
                   n = m->last;
                   assert(MAN_TEXT != n->type);
   
                   /* Remove repeated NSCOPED macros causing ELINE. */
   
                   if (MAN_NSCOPED & man_macros[n->tok].flags)
                           n = n->parent;
   
                   man_vmsg(m, MANDOCERR_LINESCOPE, n->line, n->pos,
                                   "%s", man_macronames[n->tok]);
   
                   man_node_delete(m, n);
                   m->flags &= ~MAN_ELINE;
           }
   
           /*
            * Save the fact that we're in the next-line for a block.  In
            * this way, embedded roff instructions can "remember" state
            * when they exit.
            */
   
           if (MAN_BLINE & m->flags)
                   m->flags |= MAN_BPLINE;
   
           /* Call to handler... */
   
           assert(man_macros[tok].fp);
           if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))
                 goto err;                  goto err;
   
 out:  out:
         if (fl) {          /*
                 /*           * We weren't in a block-line scope when entering the
                  * A NLINE macro has been immediately followed with           * above-parsed macro, so return.
                  * another.  Close out the preceding macro's scope, and           */
                  * continue.  
                  */  
                 assert(MAN_ROOT != m->last->type);  
                 assert(m->last->parent);  
                 assert(MAN_ROOT != m->last->parent->type);  
   
                 if (n != m->last)          if ( ! (MAN_BPLINE & m->flags)) {
                         m->last = m->last->parent;                  m->flags &= ~MAN_ILINE;
                   return(1);
           }
           m->flags &= ~MAN_BPLINE;
   
                 if ( ! man_valid_post(m))          /*
                         return(0);           * If we're in a block scope, then allow this macro to slip by
                 if ( ! man_action_post(m))           * without closing scope around it.
                         return(0);           */
                 m->next = MAN_NEXT_SIBLING;  
                 m->flags &= ~MAN_NLINE;  
         }  
   
         return(1);          if (MAN_ILINE & m->flags) {
                   m->flags &= ~MAN_ILINE;
                   return(1);
           }
   
           /*
            * If we've opened a new next-line element scope, then return
            * now, as the next line will close out the block scope.
            */
   
           if (MAN_ELINE & m->flags)
                   return(1);
   
           /* Close out the block scope opened in the prior line.  */
   
           assert(MAN_BLINE & m->flags);
           m->flags &= ~MAN_BLINE;
   
           if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                   return(0);
           return(man_body_alloc(m, ln, offs, m->last->tok));
   
 err:    /* Error out. */  err:    /* Error out. */
   
         m->flags |= MAN_HALT;          m->flags |= MAN_HALT;
Line 401  err: /* Error out. */
Line 576  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, ...)   * Unlink a node from its context.  If "m" is provided, the last parse
    * point will also be adjusted accordingly.
    */
   static void
   man_node_unlink(struct man *m, struct man_node *n)
 {  {
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == man->cb.man_warn)          /* Adjust siblings. */
                 return(0);  
   
         va_start(ap, fmt);          if (n->prev)
         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);                  n->prev->next = n->next;
         va_end(ap);          if (n->next)
         return((*man->cb.man_warn)(man->data, ln, pos, buf));                  n->next->prev = n->prev;
 }  
   
           /* Adjust parent. */
   
           if (n->parent) {
                   n->parent->nchild--;
                   if (n->parent->child == n)
                           n->parent->child = n->prev ? n->prev : n->next;
           }
   
           /* Adjust parse point, if applicable. */
   
           if (m && m->last == n) {
                   /*XXX: this can occur when bailing from validation. */
                   /*assert(NULL == n->next);*/
                   if (n->prev) {
                           m->last = n->prev;
                           m->next = MAN_NEXT_SIBLING;
                   } else {
                           m->last = n->parent;
                           m->next = MAN_NEXT_CHILD;
                   }
           }
   
           if (m && m->first == n)
                   m->first = NULL;
   }
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.92
CVSweb