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

Diff for /mandoc/man.c between version 1.29 and 1.163

version 1.29, 2009/08/13 11:45:29 version 1.163, 2015/04/23 16:17:44
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * 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
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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.
  */   */
   #include "config.h"
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdarg.h>  #include <stdarg.h>
Line 21 
Line 27 
 #include <stdio.h>  #include <stdio.h>
 #include <string.h>  #include <string.h>
   
   #include "mandoc_aux.h"
   #include "mandoc.h"
   #include "roff.h"
   #include "man.h"
   #include "libmandoc.h"
   #include "roff_int.h"
 #include "libman.h"  #include "libman.h"
   
 const   char *const __man_merrnames[WERRMAX] = {  const   char *const __man_macronames[MAN_MAX] = {
         "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 */  
         "unknown macro", /* WMACRO */  
         "ill-formed macro", /* WMACROFORM */  
         "scope open on exit" /* WEXITSCOPE */  
 };  
   
 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",           "sp",           "nf",
         "nf",           "fi",           "r"          "fi",           "RE",           "RS",           "DT",
           "UC",           "PD",           "AT",           "in",
           "ft",           "OP",           "EX",           "EE",
           "UR",           "UE",           "ll"
         };          };
   
 const   char * const *man_macronames = __man_macronames;  const   char * const *man_macronames = __man_macronames;
   
 static  struct man_node *man_node_alloc(int, int,  static  void             man_descope(struct roff_man *, int, int);
                                 enum man_type, int);  static  int              man_ptext(struct roff_man *, int, char *, int);
 static  int              man_node_append(struct man *,  static  int              man_pmacro(struct roff_man *, int, char *, int);
                                 struct man_node *);  
 static  int              man_ptext(struct man *, int, char *);  
 static  int              man_pmacro(struct man *, int, char *);  
 static  void             man_free1(struct man *);  
 static  int              man_alloc1(struct man *);  
   
   
 const struct man_node *  int
 man_node(const struct man *m)  man_parseln(struct roff_man *man, int ln, char *buf, int offs)
 {  {
   
         return(MAN_HALT & m->flags ? NULL : m->first);          if (man->last->type != ROFFT_EQN || ln > man->last->line)
 }                  man->flags |= MAN_NEWLINE;
   
           return (roff_getcontrol(man->roff, buf, &offs) ?
 const struct man_meta *              man_pmacro(man, ln, buf, offs) :
 man_meta(const struct man *m)              man_ptext(man, ln, buf, offs));
 {  
   
         return(MAN_HALT & m->flags ? NULL : &m->meta);  
 }  }
   
   static void
 int  man_descope(struct roff_man *man, int line, int offs)
 man_reset(struct man *man)  
 {  {
           /*
            * 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).
            */
   
         man_free1(man);          if (man->flags & MAN_ELINE) {
         return(man_alloc1(man));                  man->flags &= ~MAN_ELINE;
                   man_unscope(man, man->last->parent);
           }
           if ( ! (man->flags & MAN_BLINE))
                   return;
           man->flags &= ~MAN_BLINE;
           man_unscope(man, man->last->parent);
           roff_body_alloc(man, line, offs, man->last->tok);
 }  }
   
   static int
 void  man_ptext(struct roff_man *man, int line, char *buf, int offs)
 man_free(struct man *man)  
 {  {
           int              i;
   
         man_free1(man);          /* Literal free-form text whitespace is preserved. */
   
         if (man->htab)          if (man->flags & MAN_LITERAL) {
                 man_hash_free(man->htab);                  roff_word_alloc(man, line, offs, buf + offs);
         free(man);                  man_descope(man, line, offs);
 }                  return(1);
           }
   
           for (i = offs; buf[i] == ' '; i++)
                   /* Skip leading whitespace. */ ;
   
 struct man *          /*
 man_alloc(void *data, int pflags, const struct man_cb *cb)           * Blank lines are ignored right after headings
 {           * but add a single vertical space elsewhere.
         struct man      *p;           */
   
         if (NULL == (p = calloc(1, sizeof(struct man))))          if (buf[i] == '\0') {
                 return(NULL);                  /* Allocate a blank entry. */
                   if (man->last->tok != MAN_SH &&
         if ( ! man_alloc1(p)) {                      man->last->tok != MAN_SS) {
                 free(p);                          roff_elem_alloc(man, line, offs, MAN_sp);
                 return(NULL);                          man->next = ROFF_NEXT_SIBLING;
                   }
                   return(1);
         }          }
   
         p->data = data;          /*
         p->pflags = pflags;           * Warn if the last un-escaped character is whitespace. Then
         (void)memcpy(&p->cb, cb, sizeof(struct man_cb));           * strip away the remaining spaces (tabs stay!).
            */
   
         if (NULL == (p->htab = man_hash_alloc())) {          i = (int)strlen(buf);
                 free(p);          assert(i);
                 return(NULL);  
         }  
         return(p);  
 }  
   
           if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                   if (i > 1 && '\\' != buf[i - 2])
                           mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                               line, i - 1, NULL);
   
 int                  for (--i; i && ' ' == buf[i]; i--)
 man_endparse(struct man *m)                          /* Spin back to non-space. */ ;
 {  
   
         if (MAN_HALT & m->flags)                  /* Jump ahead of escaped whitespace. */
                 return(0);                  i += '\\' == buf[i] ? 2 : 1;
         else if (man_macroend(m))  
                 return(1);  
         m->flags |= MAN_HALT;  
         return(0);  
 }  
   
                   buf[i] = '\0';
           }
           roff_word_alloc(man, line, offs, buf + offs);
   
 int          /*
 man_parseln(struct man *m, int ln, char *buf)           * 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.
            */
   
         return('.' == *buf ?          assert(i);
                         man_pmacro(m, ln, buf) :          if (mandoc_eos(buf, (size_t)i))
                         man_ptext(m, ln, buf));                  man->last->flags |= MAN_EOS;
 }  
   
           man_descope(man, line, offs);
 static void          return(1);
 man_free1(struct man *man)  
 {  
   
         if (man->first)  
                 man_node_freelist(man->first);  
         if (man->meta.title)  
                 free(man->meta.title);  
         if (man->meta.source)  
                 free(man->meta.source);  
         if (man->meta.vol)  
                 free(man->meta.vol);  
 }  }
   
   
 static int  static int
 man_alloc1(struct man *m)  man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
 {  {
           struct roff_node *n;
           const char      *cp;
           int              tok;
           int              i, ppos;
           int              bline;
           char             mac[5];
   
         bzero(&m->meta, sizeof(struct man_meta));          ppos = offs;
         m->flags = 0;  
         m->last = calloc(1, sizeof(struct man_node));  
         if (NULL == m->last)  
                 return(0);  
         m->first = m->last;  
         m->last->type = MAN_ROOT;  
         m->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
           /*
            * Copy the first word into a nil-terminated buffer.
            * Stop when a space, tab, escape, or eoln is encountered.
            */
   
 static int          i = 0;
 man_node_append(struct man *man, struct man_node *p)          while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
 {                  mac[i++] = buf[offs++];
   
         assert(man->last);          mac[i] = '\0';
         assert(man->first);  
         assert(MAN_ROOT != p->type);  
   
         switch (man->next) {          tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
         case (MAN_NEXT_SIBLING):  
                 man->last->next = p;          if (tok == TOKEN_NONE) {
                 p->prev = man->last;                  mandoc_msg(MANDOCERR_MACRO, man->parse,
                 p->parent = man->last->parent;                      ln, ppos, buf + ppos - 1);
                 break;                  return(1);
         case (MAN_NEXT_CHILD):  
                 man->last->child = p;  
                 p->parent = man->last;  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
         p->parent->nchild++;  
   
         if ( ! man_valid_pre(man, p))          /* Skip a leading escape sequence or tab. */
                 return(0);  
   
         switch (p->type) {          switch (buf[offs]) {
         case (MAN_HEAD):          case '\\':
                 assert(MAN_BLOCK == p->parent->type);                  cp = buf + offs + 1;
                 p->parent->head = p;                  mandoc_escape(&cp, NULL, NULL);
                   offs = cp - buf;
                 break;                  break;
         case (MAN_BODY):          case '\t':
                 assert(MAN_BLOCK == p->parent->type);                  offs++;
                 p->parent->body = p;  
                 break;                  break;
         default:          default:
                 break;                  break;
         }          }
   
         man->last = p;          /* Jump to the next non-whitespace word. */
   
         switch (p->type) {          while (buf[offs] && buf[offs] == ' ')
         case (MAN_TEXT):                  offs++;
                 if ( ! man_valid_post(man))  
                         return(0);  
                 if ( ! man_action_post(man))  
                         return(0);  
                 break;  
         default:  
                 break;  
         }  
   
         return(1);          /*
 }           * Trailing whitespace.  Note that tabs are allowed to be passed
            * into the parser as "text", so we only warn about spaces here.
            */
   
           if (buf[offs] == '\0' && buf[offs - 1] == ' ')
                   mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                       ln, offs - 1, NULL);
   
 static struct man_node *          /*
 man_node_alloc(int line, int pos, enum man_type type, int tok)           * Some macros break next-line scopes; otherwise, remember
 {           * whether we are in next-line scope for a block head.
         struct man_node *p;           */
   
         p = calloc(1, sizeof(struct man_node));          man_breakscope(man, tok);
         if (NULL == p)          bline = man->flags & MAN_BLINE;
                 return(NULL);  
   
         p->line = line;          /* Call to handler... */
         p->pos = pos;  
         p->type = type;  
         p->tok = tok;  
         return(p);  
 }  
   
           assert(man_macros[tok].fp);
           (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
   
 int          /* In quick mode (for mandocdb), abort after the NAME section. */
 man_elem_alloc(struct man *man, int line, int pos, int tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_ELEM, tok);          if (man->quick && tok == MAN_SH) {
         if (NULL == p)                  n = man->last;
                 return(0);                  if (n->type == ROFFT_BODY &&
         return(man_node_append(man, p));                      strcmp(n->prev->child->string, "NAME"))
 }                          return(2);
           }
   
           /*
            * If we are in a next-line scope for a block head,
            * close it out now and switch to the body,
            * unless the next-line scope is allowed to continue.
            */
   
 int          if ( ! bline || man->flags & MAN_ELINE ||
 man_head_alloc(struct man *m, int line, int pos, int tok)              man_macros[tok].flags & MAN_NSCOPED)
 {                  return(1);
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_HEAD, tok);          assert(man->flags & MAN_BLINE);
         if (NULL == p)          man->flags &= ~MAN_BLINE;
                 return(0);  
         if ( ! man_node_append(m, p))  
                 return(0);  
         m->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
           man_unscope(man, man->last->parent);
 int          roff_body_alloc(man, ln, ppos, man->last->tok);
 man_body_alloc(struct man *m, int line, int pos, int tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_BODY, tok);  
         if (NULL == p)  
                 return(0);  
         if ( ! man_node_append(m, p))  
                 return(0);  
         m->next = MAN_NEXT_CHILD;  
         return(1);          return(1);
 }  }
   
   
 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);  
 }  
   
   
 int  
 man_word_alloc(struct man *man,  
                 int line, int pos, const char *word)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_TEXT, -1);  
         if (NULL == p)  
                 return(0);  
         if (NULL == (p->string = strdup(word)))  
                 return(0);  
         return(man_node_append(man, p));  
 }  
   
   
 void  void
 man_node_free(struct man_node *p)  man_breakscope(struct roff_man *man, int tok)
 {  {
           struct roff_node *n;
   
         if (p->string)  
                 free(p->string);  
         if (p->parent)  
                 p->parent->nchild--;  
         free(p);  
 }  
   
   
 void  
 man_node_freelist(struct man_node *p)  
 {  
   
         if (p->child)  
                 man_node_freelist(p->child);  
         if (p->next)  
                 man_node_freelist(p->next);  
   
         assert(0 == p->nchild);  
         man_node_free(p);  
 }  
   
   
 static int  
 man_ptext(struct man *m, int line, char *buf)  
 {  
   
         /* First allocate word. */  
   
         if ( ! man_word_alloc(m, line, 0, buf))  
                 return(0);  
         m->next = MAN_NEXT_SIBLING;  
   
         /*          /*
          * Co-ordinate what happens with having a next-line scope open:           * An element next line scope is open,
          * first close out the element scope (if applicable), then close           * and the new macro is not allowed inside elements.
          * out the block scope (also if applicable).           * Delete the element that is being broken.
          */           */
   
         /* XXX - this should be in man_action.c. */          if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
               ! (man_macros[tok].flags & MAN_NSCOPED))) {
                   n = man->last;
                   assert(n->type != ROFFT_TEXT);
                   if (man_macros[n->tok].flags & MAN_NSCOPED)
                           n = n->parent;
   
         if (MAN_ELINE & m->flags) {                  mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                 m->flags &= ~MAN_ELINE;                      n->line, n->pos, "%s breaks %s",
                 if ( ! man_unscope(m, m->last->parent))                      tok == TOKEN_NONE ? "TS" : man_macronames[tok],
                         return(0);                      man_macronames[n->tok]);
         }  
   
         if ( ! (MAN_BLINE & m->flags))                  roff_node_delete(man, n);
                 return(1);                  man->flags &= ~MAN_ELINE;
         m->flags &= ~MAN_BLINE;  
   
         if ( ! man_unscope(m, m->last->parent))  
                 return(0);  
         return(man_body_alloc(m, line, 0, m->last->tok));  
 }  
   
   
 int  
 man_pmacro(struct man *m, int ln, char *buf)  
 {  
         int               i, j, c, ppos, fl;  
         char              mac[5];  
   
         /* Comments and empties are quickly ignored. */  
   
         fl = m->flags;  
   
         if (0 == buf[1])  
                 goto out;  
   
         i = 1;  
   
         if (' ' == buf[i]) {  
                 i++;  
                 while (buf[i] && ' ' == buf[i])  
                         i++;  
                 if (0 == buf[i])  
                         goto out;  
         }          }
   
         ppos = i;          /*
            * A block header next line scope is open,
         /* Copy the first word into a nil-terminated buffer. */           * and the new macro is not allowed inside block headers.
            * Delete the block that is being broken.
         for (j = 0; j < 4; j++, i++) {  
                 if (0 == (mac[j] = buf[i]))  
                         break;  
                 else if (' ' == buf[i])  
                         break;  
         }  
   
         mac[j] = 0;  
   
         if (j == 4 || j < 1) {  
                 if ( ! (MAN_IGN_MACRO & m->pflags)) {  
                         (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_IGN_MACRO & m->pflags)) {  
                         (void)man_perr(m, ln, ppos, WMACRO);  
                         goto err;  
                 }  
                 if ( ! man_pwarn(m, ln, ppos, WMACRO))  
                         goto err;  
                 return(1);  
         }  
   
         /* The macro is sane.  Jump to the next word. */  
   
         while (buf[i] && ' ' == buf[i])  
                 i++;  
   
         /* Begin recursive parse sequence. */  
   
         assert(man_macros[c].fp);  
   
         if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))  
                 goto err;  
   
 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)          if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
                 return(1);              man_macros[tok].flags & MAN_BSCOPE)) {
                   n = man->last;
                   if (n->type == ROFFT_TEXT)
                           n = n->parent;
                   if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
                           n = n->parent;
   
         /* Close out the block scope opened in the prior line.  */                  assert(n->type == ROFFT_HEAD);
                   n = n->parent;
                   assert(n->type == ROFFT_BLOCK);
                   assert(man_macros[n->tok].flags & MAN_SCOPED);
   
         /* XXX - this should be in man_action.c. */                  mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                       n->line, n->pos, "%s breaks %s",
                       tok == TOKEN_NONE ? "TS" : man_macronames[tok],
                       man_macronames[n->tok]);
   
         assert(MAN_BLINE & m->flags);                  roff_node_delete(man, n);
         m->flags &= ~MAN_BLINE;                  man->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. */  
   
         m->flags |= MAN_HALT;  
         return(0);  
 }  }
   
   const struct mparse *
 int  man_mparse(const struct roff_man *man)
 man_verr(struct man *man, int ln, int pos, const char *fmt, ...)  
 {  {
         char             buf[256];  
         va_list          ap;  
   
         if (NULL == man->cb.man_err)          assert(man && man->parse);
                 return(0);          return(man->parse);
   
         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.29  
changed lines
  Added in v.1.163
CVSweb