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

Diff for /mandoc/man.c between version 1.6 and 1.65

version 1.6, 2009/03/25 16:07:36 version 1.65, 2010/05/12 16:46:28
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.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
   #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>
 #include <string.h>  #include <string.h>
   
 #include "libman.h"  #include "libman.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] = {
         "\\\"",         "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",
           "Sp",           "Vb",           "Ve",           "de",
           "dei",          "am",           "ami",          "ig",
           ".",
         };          };
   
 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, enum mant);
 static  int              man_node_append(struct man *,  static  int              man_node_append(struct man *,
                                 struct man_node *);                                  struct man_node *);
   static  void             man_node_free(struct man_node *);
   static  void             man_node_unlink(struct man *,
                                   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  void             man_alloc1(struct man *);
   static  int              macrowarn(struct man *, int, const char *);
   
   
 const struct man_node *  const struct man_node *
Line 75  man_free(struct man *man)
Line 116  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, const struct man_cb *cb)  man_alloc(void *data, int pflags, const struct man_cb *cb)
 {  {
         struct man      *p;          struct man      *p;
   
         p = calloc(1, sizeof(struct man));          p = mandoc_calloc(1, sizeof(struct man));
         if (NULL == p)  
                 err(1, "calloc");  
   
         man_alloc1(p);  
   
         if (cb)          if (cb)
                 (void)memcpy(&p->cb, cb, sizeof(struct man_cb));                  memcpy(&p->cb, cb, sizeof(struct man_cb));
   
         p->htab = man_hash_alloc();          man_hash_init();
         p->data = data;          p->data = data;
           p->pflags = pflags;
   
           man_alloc1(p);
         return(p);          return(p);
 }  }
   
Line 119  int
Line 156  int
 man_parseln(struct man *m, int ln, char *buf)  man_parseln(struct man *m, int ln, char *buf)
 {  {
   
         return('.' == *buf ?          return('.' == *buf || '\'' == *buf ?
                         man_pmacro(m, ln, buf) :                          man_pmacro(m, ln, buf) :
                         man_ptext(m, ln, buf));                          man_ptext(m, ln, buf));
 }  }
Line 130  man_free1(struct man *man)
Line 167  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)
Line 144  static void
Line 181  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)  
                 err(1, "calloc");  
         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;
 }  }
   
Line 177  man_node_append(struct man *man, struct man_node *p)
Line 213  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) {
Line 196  man_node_append(struct man *man, struct man_node *p)
Line 251  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, enum mant tok)
 {  {
         struct man_node *p;          struct man_node *p;
   
         if (NULL == (p = calloc(1, sizeof(struct man_node))))          p = mandoc_calloc(1, sizeof(struct man_node));
                 err(1, "malloc");  
         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, enum mant 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 ( ! 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, enum mant tok)
   {
           struct man_node *p;
   
           p = man_node_alloc(line, pos, MAN_HEAD, tok);
           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, 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);          p = man_node_alloc(line, pos, MAN_BODY, tok);
         if (NULL == (p->string = strdup(word)))          if ( ! man_node_append(m, p))
                 err(1, "strdup");                  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, 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);
 }  }
   
   
 void  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 247  man_node_free(struct man_node *p)
Line 354  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);
 }  }
   
Line 262  man_node_freelist(struct man_node *p)
Line 368  man_node_freelist(struct man_node *p)
 static int  static int
 man_ptext(struct man *m, int line, char *buf)  man_ptext(struct man *m, int line, char *buf)
 {  {
           int              i;
   
           /* Ignore bogus comments. */
   
           if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])
                   return(man_pwarn(m, line, 0, WBADCOMMENT));
   
           /* Literal free-form text whitespace is preserved. */
   
           if (MAN_LITERAL & m->flags) {
                   if ( ! man_word_alloc(m, line, 0, buf))
                           return(0);
                   goto descope;
           }
   
           /* Pump blank lines directly into the backend. */
   
           for (i = 0; ' ' == buf[i]; i++)
                   /* Skip leading whitespace. */ ;
   
           if ('\0' == buf[i]) {
                   /* Allocate a blank entry. */
                   if ( ! man_word_alloc(m, line, 0, ""))
                           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_pwarn(m, line, i - 1, WTSPACE))
                                   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, 0, buf))          if ( ! man_word_alloc(m, line, 0, buf))
                 return(0);                  return(0);
         m->next = MAN_NEXT_SIBLING;  
         return(1);          /*
            * End-of-sentence check.  If the last character is an unescaped
            * EOS character, then flag the node as being the end of a
            * sentence.  The front-end will know how to interpret this.
            */
   
           assert(i);
   
           switch (buf[i - 1]) {
           case ('.'):
                   if (i > 1 && '\\' == buf[i - 2])
                           break;
                   /* FALLTHROUGH */
           case ('!'):
                   /* FALLTHROUGH */
           case ('?'):
                   m->last->flags |= MAN_EOS;
                   break;
           default:
                   break;
   
           }
   
   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, WERRMAX))
                           return(0);
           }
   
           if ( ! (MAN_BLINE & m->flags))
                   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
   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, ppos;
         char              mac[5];          enum mant        tok;
           char             mac[5];
           struct man_node *n;
   
         /* Comments and empties are quickly ignored. */          /* Comments and empties are quickly ignored. */
   
         if (0 == buf[1])          if ('\0' == buf[1])
                 return(1);                  return(1);
   
         if (' ' == buf[1]) {          i = 1;
                 i = 2;  
                 while (buf[i] && ' ' == buf[i])          /*
            * Skip whitespace between the control character and initial
            * text.  "Whitespace" is both spaces and tabs.
            */
   
           if (' ' == buf[i] || '\t' == buf[i]) {
                   i++;
                   while (buf[i] && (' ' == buf[i] || '\t' == 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 == (tok = 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 321  man_pmacro(struct man *m, int ln, char *buf)
Line 545  man_pmacro(struct man *m, int ln, char *buf)
         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, 1, &i, buf))          if ('\0' == buf[i] && ' ' == buf[i - 1])
                   if ( ! man_pwarn(m, ln, i - 1, WTSPACE))
                           goto err;
   
           /*
            * Remove prior ELINE macro, as it's being clobbering 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.
            * 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) &&
                           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;
   
                   assert(n);
                   assert(NULL == n->child);
                   assert(0 == n->nchild);
   
                   if ( ! man_nwarn(m, n, WLNSCOPE))
                           return(0);
   
                   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;
   
         return(1);  out:
           /*
            * We weren't in a block-line scope when entering the
            * above-parsed macro, so return.
            */
   
           if ( ! (MAN_BPLINE & m->flags)) {
                   m->flags &= ~MAN_ILINE;
                   return(1);
           }
           m->flags &= ~MAN_BPLINE;
   
           /*
            * If we're in a block scope, then allow this macro to slip by
            * without closing scope around it.
            */
   
           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, WERRMAX))
                   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;
Line 367  man_vwarn(struct man *man, int ln, int pos, const char
Line 685  man_vwarn(struct man *man, int ln, int pos, const char
 }  }
   
   
   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));
   }
   
   
   /*
    * 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)
   {
   
           /* Adjust siblings. */
   
           if (n->prev)
                   n->prev->next = n->next;
           if (n->next)
                   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.6  
changed lines
  Added in v.1.65
CVSweb