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

Diff for /mandoc/man.c between version 1.3 and 1.43

version 1.3, 2009/03/23 15:41:09 version 1.43, 2009/10/26 07:11:06
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *   *
  * 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 above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * 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 <ctype.h>
 #include <err.h>  
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  #include <stdio.h>
Line 26 
Line 25 
   
 #include "libman.h"  #include "libman.h"
   
   const   char *const __man_merrnames[WERRMAX] = {
           "invalid character", /* WNPRINT */
           "system: malloc error", /* WNMEM */
           "invalid manual section", /* WMSEC */
           "invalid date format", /* WDATE */
           "scope of prior line violated", /* WLNSCOPE */
           "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 */
   };
   
 const   char *const __man_macronames[MAN_MAX] = {  const   char *const __man_macronames[MAN_MAX] = {
         "\\\"",         "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",
           "nf",           "fi",           "r",            "RE",
           "RS",           "DT",           "UC",           "PD"
         };          };
   
 const   char * const *man_macronames = __man_macronames;  const   char * const *man_macronames = __man_macronames;
   
 static  struct man_node *man_node_alloc(int, int, enum man_type);  static  struct man_node *man_node_alloc(int, int,
                                   enum man_type, int);
 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  int              man_ptext(struct man *, int, char *);
 static  int              man_pmacro(struct man *, int, char *);  static  int              man_pmacro(struct man *, int, char *);
 static  void             man_free1(struct man *);  static  void             man_free1(struct man *);
 static  void             man_alloc1(struct man *);  static  int              man_alloc1(struct man *);
   static  int              pstring(struct man *, int, int,
                                   const char *, size_t);
   static  int              macrowarn(struct man *, int, const char *);
   
   #ifdef __linux__
   extern  size_t            strlcpy(char *, const char *, size_t);
   #endif
   
   
 const struct man_node *  const struct man_node *
 man_node(const struct man *m)  man_node(const struct man *m)
 {  {
Line 61  man_meta(const struct man *m)
Line 93  man_meta(const struct man *m)
 }  }
   
   
 void  int
 man_reset(struct man *man)  man_reset(struct man *man)
 {  {
   
         man_free1(man);          man_free1(man);
         man_alloc1(man);          return(man_alloc1(man));
 }  }
   
   
Line 75  man_free(struct man *man)
Line 107  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)  man_alloc(void *data, int pflags, const struct man_cb *cb)
 {  {
         struct man      *p;          struct man      *p;
   
         p = calloc(1, sizeof(struct man));          if (NULL == (p = calloc(1, sizeof(struct man))))
         if (NULL == p)                  return(NULL);
                 err(1, "calloc");  
   
         man_alloc1(p);          if ( ! man_alloc1(p)) {
                   free(p);
                   return(NULL);
           }
   
         p->htab = man_hash_alloc();          man_hash_init();
   
           p->data = data;
           p->pflags = pflags;
           (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
         return(p);          return(p);
 }  }
   
Line 129  man_free1(struct man *man)
Line 164  man_free1(struct man *man)
                 man_node_freelist(man->first);                  man_node_freelist(man->first);
         if (man->meta.title)          if (man->meta.title)
                 free(man->meta.title);                  free(man->meta.title);
         if (man->meta.os)          if (man->meta.source)
                 free(man->meta.os);                  free(man->meta.source);
         if (man->meta.vol)          if (man->meta.vol)
                 free(man->meta.vol);                  free(man->meta.vol);
 }  }
   
   
 static void  static int
 man_alloc1(struct man *m)  man_alloc1(struct man *m)
 {  {
   
Line 144  man_alloc1(struct man *m)
Line 179  man_alloc1(struct man *m)
         m->flags = 0;          m->flags = 0;
         m->last = calloc(1, sizeof(struct man_node));          m->last = calloc(1, sizeof(struct man_node));
         if (NULL == m->last)          if (NULL == m->last)
                 err(1, "calloc");                  return(0);
         m->first = m->last;          m->first = m->last;
         m->last->type = MAN_ROOT;          m->last->type = MAN_ROOT;
         m->next = MAN_NEXT_CHILD;          m->next = MAN_NEXT_CHILD;
           return(1);
 }  }
   
   
Line 173  man_node_append(struct man *man, struct man_node *p)
Line 209  man_node_append(struct man *man, struct man_node *p)
                 abort();                  abort();
                 /* NOTREACHED */                  /* NOTREACHED */
         }          }
   
           p->parent->nchild++;
   
 #if 0  
         if ( ! man_valid_pre(man, p))          if ( ! man_valid_pre(man, p))
                 return(0);                  return(0);
         if ( ! man_action_pre(man, p))  
                 return(0);  
 #endif  
   
           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 0  
                 if ( ! man_valid_post(man))                  if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_action_post(man))                  if ( ! man_action_post(man))
                         return(0);                          return(0);
 #endif  
                 break;                  break;
         default:          default:
                 break;                  break;
Line 201  man_node_append(struct man *man, struct man_node *p)
Line 246  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)  man_node_alloc(int line, int pos, enum man_type type, int tok)
 {  {
         struct man_node *p;          struct man_node *p;
   
         if (NULL == (p = calloc(1, sizeof(struct man_node))))          p = calloc(1, sizeof(struct man_node));
                 err(1, "malloc");          if (NULL == p)
                   return(NULL);
   
         p->line = line;          p->line = line;
         p->pos = pos;          p->pos = pos;
         p->type = type;          p->type = type;
           p->tok = tok;
         return(p);          return(p);
 }  }
   
   
 int  int
 man_elem_alloc(struct man *man, int line, int pos, int tok)  man_elem_alloc(struct man *m, int line, int pos, int tok)
 {  {
         struct man_node *p;          struct man_node *p;
   
         p = man_node_alloc(line, pos, MAN_ELEM);          p = man_node_alloc(line, pos, MAN_ELEM, tok);
         p->tok = tok;          if (NULL == p)
                   return(0);
           if ( ! man_node_append(m, p))
                   return(0);
           m->next = MAN_NEXT_CHILD;
           return(1);
   }
   
         return(man_node_append(man, p));  
   int
   man_head_alloc(struct man *m, int line, int pos, int tok)
   {
           struct man_node *p;
   
           p = man_node_alloc(line, pos, MAN_HEAD, tok);
           if (NULL == p)
                   return(0);
           if ( ! man_node_append(m, p))
                   return(0);
           m->next = MAN_NEXT_CHILD;
           return(1);
 }  }
   
   
 int  int
 man_word_alloc(struct man *man,  man_body_alloc(struct man *m, int line, int pos, int tok)
                 int line, int pos, const char *word)  
 {  {
         struct man_node *p;          struct man_node *p;
   
         p = man_node_alloc(line, pos, MAN_TEXT);          p = man_node_alloc(line, pos, MAN_BODY, tok);
         if (NULL == (p->string = strdup(word)))          if (NULL == p)
                 err(1, "strdup");                  return(0);
           if ( ! man_node_append(m, p))
                   return(0);
           m->next = MAN_NEXT_CHILD;
           return(1);
   }
   
         return(man_node_append(man, p));  
   int
   man_block_alloc(struct man *m, int line, int pos, int tok)
   {
           struct man_node *p;
   
           p = man_node_alloc(line, pos, MAN_BLOCK, tok);
           if (NULL == p)
                   return(0);
           if ( ! man_node_append(m, p))
                   return(0);
           m->next = MAN_NEXT_CHILD;
           return(1);
 }  }
   
   
   static int
   pstring(struct man *m, int line, int pos,
                   const char *p, size_t len)
   {
           struct man_node *n;
           size_t           sv;
   
           n = man_node_alloc(line, pos, MAN_TEXT, -1);
           if (NULL == n)
                   return(0);
   
           n->string = malloc(len + 1);
           if (NULL == n->string) {
                   free(n);
                   return(0);
           }
   
           sv = strlcpy(n->string, p, len + 1);
   
           /* Prohibit truncation. */
           assert(sv < len + 1);
   
           if ( ! man_node_append(m, n))
                   return(0);
           m->next = MAN_NEXT_SIBLING;
           return(1);
   }
   
   
   int
   man_word_alloc(struct man *m, int line, int pos, const char *word)
   {
   
           return(pstring(m, line, pos, word, strlen(word)));
   }
   
   
 void  void
 man_node_free(struct man_node *p)  man_node_free(struct man_node *p)
 {  {
   
         if (p->string)          if (p->string)
                 free(p->string);                  free(p->string);
           if (p->parent)
                   p->parent->nchild--;
         free(p);          free(p);
 }  }
   
Line 254  man_node_free(struct man_node *p)
Line 374  man_node_free(struct man_node *p)
 void  void
 man_node_freelist(struct man_node *p)  man_node_freelist(struct man_node *p)
 {  {
           struct man_node *n;
   
         if (p->child)          if (p->child)
                 man_node_freelist(p->child);                  man_node_freelist(p->child);
         if (p->next)          assert(0 == p->nchild);
                 man_node_freelist(p->next);          n = p->next;
   
         man_node_free(p);          man_node_free(p);
           if (n)
                   man_node_freelist(n);
 }  }
   
   
 static int  static int
 man_ptext(struct man *m, int line, char *buf)  man_ptext(struct man *m, int line, char *buf)
 {  {
           int              i, j;
   
         if ( ! man_word_alloc(m, line, 0, buf))          /* Literal free-form text whitespace is preserved. */
   
           if (MAN_LITERAL & m->flags) {
                   if ( ! man_word_alloc(m, line, 0, buf))
                           return(0);
                   goto descope;
           }
   
           /* First de-chunk and allocate words. */
   
           for (i = 0; ' ' == buf[i]; i++)
                   /* Skip leading whitespace. */ ;
           if (0 == buf[i]) {
                   if ( ! pstring(m, line, 0, &buf[i], 0))
                           return(0);
                   goto descope;
           }
   
           for (j = i; buf[i]; i++) {
                   if (' ' != buf[i])
                           continue;
   
                   /* Escaped whitespace. */
                   if (i && ' ' == buf[i] && '\\' == buf[i - 1])
                           continue;
   
                   buf[i++] = 0;
                   if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
                           return(0);
   
                   for ( ; ' ' == buf[i]; i++)
                           /* Skip trailing whitespace. */ ;
   
                   j = i;
                   if (0 == buf[i])
                           break;
           }
   
           if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
                 return(0);                  return(0);
         m->next = MAN_NEXT_SIBLING;  
         return(1);  descope:
   
           /*
            * 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))
                           return(0);
           }
   
           if ( ! (MAN_BLINE & m->flags))
                   return(1);
           m->flags &= ~MAN_BLINE;
   
           if ( ! man_unscope(m, m->last->parent))
                   return(0);
           return(man_body_alloc(m, line, 0, m->last->tok));
 }  }
   
   
   static int
   macrowarn(struct man *m, int ln, const char *buf)
   {
           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  int
 man_pmacro(struct man *m, int ln, char *buf)  man_pmacro(struct man *m, int ln, char *buf)
 {  {
         int               i, c;          int              i, j, c, ppos, fl;
         char              mac[5];          char             mac[5];
           struct man_node *n;
   
         /* Comments and empties are quickly ignored. */          /* Comments and empties are quickly ignored. */
   
           fl = m->flags;
   
         if (0 == buf[1])          if (0 == buf[1])
                 return(1);                  goto out;
   
         if (' ' == buf[1]) {          i = 1;
                 i = 2;  
           if (' ' == buf[i]) {
                   i++;
                 while (buf[i] && ' ' == buf[i])                  while (buf[i] && ' ' == buf[i])
                         i++;                          i++;
                 if (0 == buf[i])                  if (0 == buf[i])
                         return(1);                          goto out;
                 warnx("invalid syntax");  
                 return(0);  
         }          }
   
         if (buf[1] && '\\' == buf[1])          ppos = i;
                 if (buf[2] && '\"' == buf[2])  
                         return(1);  
   
         /* Copy the first word into a nil-terminated buffer. */          /* Copy the first word into a nil-terminated buffer. */
   
         for (i = 1; i < 5; i++) {          for (j = 0; j < 4; j++, i++) {
                 if (0 == (mac[i - 1] = buf[i]))                  if (0 == (mac[j] = buf[i]))
                         break;                          break;
                 else if (' ' == buf[i])                  else if (' ' == buf[i])
                         break;                          break;
   
                   /* Check for invalid characters. */
   
                   if (isgraph((u_char)buf[i]))
                           continue;
                   return(man_perr(m, ln, i, WNPRINT));
         }          }
   
         mac[i - 1] = 0;          mac[j] = 0;
   
         if (i == 5 || i <= 1) {          if (j == 4 || j < 1) {
                 warnx("unknown macro: %s", mac);                  if ( ! (MAN_IGN_MACRO & m->pflags)) {
                 goto err;                          (void)man_perr(m, ln, ppos, WMACROFORM);
         }                          goto err;
                   }
                   if ( ! man_pwarn(m, ln, ppos, WMACROFORM))
                           goto err;
                   return(1);
           }
   
         if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {          if (MAN_MAX == (c = man_hash_find(mac))) {
                 warnx("unknown macro: %s", mac);                  if ( ! macrowarn(m, ln, mac))
                 goto err;                          goto err;
                   return(1);
         }          }
   
         /* The macro is sane.  Jump to the next word. */          /* The macro is sane.  Jump to the next word. */
Line 326  man_pmacro(struct man *m, int ln, char *buf)
Line 532  man_pmacro(struct man *m, int ln, char *buf)
         while (buf[i] && ' ' == buf[i])          while (buf[i] && ' ' == buf[i])
                 i++;                  i++;
   
           /* Remove prior ELINE macro, if applicable. */
   
           if (m->flags & MAN_ELINE) {
                   n = m->last;
                   assert(NULL == n->child);
                   assert(0 == n->nchild);
                   if ( ! man_nwarn(m, n, WLNSCOPE))
                           return(0);
   
                   if (n->prev) {
                           assert(n != n->parent->child);
                           assert(n == n->prev->next);
                           n->prev->next = NULL;
                           m->last = n->prev;
                           m->next = MAN_NEXT_SIBLING;
                   } else {
                           assert(n == n->parent->child);
                           n->parent->child = NULL;
                           m->last = n->parent;
                           m->next = MAN_NEXT_CHILD;
                   }
   
                   man_node_free(n);
                   m->flags &= ~MAN_ELINE;
           }
   
         /* Begin recursive parse sequence. */          /* Begin recursive parse sequence. */
   
         if ( ! man_macro(m, c, ln, 1, &i, buf))          assert(man_macros[c].fp);
   
           if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))
                 goto err;                  goto err;
   
         return(1);  out:
           if ( ! (MAN_BLINE & fl))
                   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))
                   return(0);
           return(man_body_alloc(m, ln, 0, m->last->tok));
   
 err:    /* Error out. */  err:    /* Error out. */
   
         m->flags |= MAN_HALT;          m->flags |= MAN_HALT;
         return(0);          return(0);
 }  }
   
   
   int
   man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
   {
           char             buf[256];
           va_list          ap;
   
           if (NULL == man->cb.man_err)
                   return(0);
   
           va_start(ap, fmt);
           (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
           va_end(ap);
           return((*man->cb.man_err)(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.3  
changed lines
  Added in v.1.43
CVSweb