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

Diff for /mandoc/man.c between version 1.4 and 1.160

version 1.4, 2009/03/25 15:17:49 version 1.160, 2015/04/19 14:25:41
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * 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   * 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 AUTHORS DISCLAIM 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 AUTHORS 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 "config.h"
   
   #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 "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_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",           "sp",           "nf",
           "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, enum man_type);  static  void             man_descope(struct roff_man *, int, int);
 static  int              man_node_append(struct man *,  static  int              man_ptext(struct roff_man *, int, char *, int);
                                 struct man_node *);  static  int              man_pmacro(struct roff_man *, int, char *, int);
 static  int              man_ptext(struct man *, int, char *);  
 static  int              man_pmacro(struct man *, int, char *);  
 static  void             man_free1(struct man *);  
 static  void             man_alloc1(struct man *);  
   
   
 const struct man_node *  void
 man_node(const struct man *m)  man_endparse(struct roff_man *man)
 {  {
   
         return(MAN_HALT & m->flags ? NULL : m->first);          man_macroend(man);
 }  }
   
   int
 const struct man_meta *  man_parseln(struct roff_man *man, int ln, char *buf, int offs)
 man_meta(const struct man *m)  
 {  {
   
         return(MAN_HALT & m->flags ? NULL : &m->meta);          if (man->last->type != ROFFT_EQN || ln > man->last->line)
                   man->flags |= MAN_NEWLINE;
   
           return (roff_getcontrol(man->roff, buf, &offs) ?
               man_pmacro(man, ln, buf, offs) :
               man_ptext(man, ln, buf, offs));
 }  }
   
   
 void  void
 man_reset(struct man *man)  man_elem_alloc(struct roff_man *man, int line, int pos, int tok)
 {  {
           struct roff_node *p;
   
         man_free1(man);          p = roff_node_alloc(man, line, pos, ROFFT_ELEM, tok);
         man_alloc1(man);          roff_node_append(man, p);
           man->next = ROFF_NEXT_CHILD;
 }  }
   
   
 void  void
 man_free(struct man *man)  man_block_alloc(struct roff_man *man, int line, int pos, int tok)
 {  {
           struct roff_node *p;
   
         man_free1(man);          p = roff_node_alloc(man, line, pos, ROFFT_BLOCK, tok);
           roff_node_append(man, p);
         if (man->htab)          man->next = ROFF_NEXT_CHILD;
                 man_hash_free(man->htab);  
         free(man);  
 }  }
   
   static void
 struct man *  man_descope(struct roff_man *man, int line, int offs)
 man_alloc(void *data, const struct man_cb *cb)  
 {  {
         struct man      *p;          /*
            * 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).
            */
   
         p = calloc(1, sizeof(struct man));          if (man->flags & MAN_ELINE) {
         if (NULL == p)                  man->flags &= ~MAN_ELINE;
                 err(1, "calloc");                  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);
   }
   
         man_alloc1(p);  static int
   man_ptext(struct roff_man *man, int line, char *buf, int offs)
   {
           int              i;
   
         if (cb)          /* Literal free-form text whitespace is preserved. */
                 (void)memcpy(&p->cb, cb, sizeof(struct man_cb));  
   
         p->htab = man_hash_alloc();          if (man->flags & MAN_LITERAL) {
         p->data = data;                  roff_word_alloc(man, line, offs, buf + offs);
         return(p);                  man_descope(man, line, offs);
 }                  return(1);
           }
   
           for (i = offs; buf[i] == ' '; i++)
                   /* Skip leading whitespace. */ ;
   
 int          /*
 man_endparse(struct man *m)           * Blank lines are ignored right after headings
 {           * but add a single vertical space elsewhere.
            */
   
         if (MAN_HALT & m->flags)          if (buf[i] == '\0') {
                 return(0);                  /* Allocate a blank entry. */
         else if (man_macroend(m))                  if (man->last->tok != MAN_SH &&
                       man->last->tok != MAN_SS) {
                           man_elem_alloc(man, line, offs, MAN_sp);
                           man->next = ROFF_NEXT_SIBLING;
                   }
                 return(1);                  return(1);
         m->flags |= MAN_HALT;          }
         return(0);  
 }  
   
           /*
            * Warn if the last un-escaped character is whitespace. Then
            * strip away the remaining spaces (tabs stay!).
            */
   
 int          i = (int)strlen(buf);
 man_parseln(struct man *m, int ln, char *buf)          assert(i);
 {  
   
         return('.' == *buf ?          if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                         man_pmacro(m, ln, buf) :                  if (i > 1 && '\\' != buf[i - 2])
                         man_ptext(m, ln, buf));                          mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
 }                              line, i - 1, NULL);
   
                   for (--i; i && ' ' == buf[i]; i--)
                           /* Spin back to non-space. */ ;
   
 static void                  /* Jump ahead of escaped whitespace. */
 man_free1(struct man *man)                  i += '\\' == buf[i] ? 2 : 1;
 {  
   
         if (man->first)                  buf[i] = '\0';
                 man_node_freelist(man->first);          }
         if (man->meta.title)          roff_word_alloc(man, line, offs, buf + offs);
                 free(man->meta.title);  
         if (man->meta.os)  
                 free(man->meta.os);  
         if (man->meta.vol)  
                 free(man->meta.vol);  
 }  
   
           /*
            * 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.
            */
   
 static void          assert(i);
 man_alloc1(struct man *m)          if (mandoc_eos(buf, (size_t)i))
 {                  man->last->flags |= MAN_EOS;
   
         bzero(&m->meta, sizeof(struct man_meta));          man_descope(man, line, offs);
         m->flags = 0;          return(1);
         m->last = calloc(1, sizeof(struct man_node));  
         if (NULL == m->last)  
                 err(1, "calloc");  
         m->first = m->last;  
         m->last->type = MAN_ROOT;  
         m->next = MAN_NEXT_CHILD;  
 }  }
   
   
 static int  static int
 man_node_append(struct man *man, struct man_node *p)  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];
   
         assert(man->last);          ppos = offs;
         assert(man->first);  
         assert(MAN_ROOT != p->type);  
   
         switch (man->next) {          /*
         case (MAN_NEXT_SIBLING):           * Copy the first word into a nil-terminated buffer.
                 man->last->next = p;           * Stop when a space, tab, escape, or eoln is encountered.
                 p->prev = man->last;           */
                 p->parent = man->last->parent;  
                 break;  
         case (MAN_NEXT_CHILD):  
                 man->last->child = p;  
                 p->parent = man->last;  
                 break;  
         default:  
                 abort();  
                 /* NOTREACHED */  
         }  
   
 #if 0          i = 0;
         if ( ! man_action_pre(man, p))          while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
                 return(0);                  mac[i++] = buf[offs++];
 #endif  
   
         man->last = p;          mac[i] = '\0';
   
         switch (p->type) {          tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
         case (MAN_TEXT):  
                 if ( ! man_valid_post(man))          if (tok == TOKEN_NONE) {
                         return(0);                  mandoc_msg(MANDOCERR_MACRO, man->parse,
 #if 0                      ln, ppos, buf + ppos - 1);
                 if ( ! man_action_post(man))                  return(1);
                         return(0);          }
 #endif  
           /* Skip a leading escape sequence or tab. */
   
           switch (buf[offs]) {
           case '\\':
                   cp = buf + offs + 1;
                   mandoc_escape(&cp, NULL, NULL);
                   offs = cp - buf;
                 break;                  break;
           case '\t':
                   offs++;
                   break;
         default:          default:
                 break;                  break;
         }          }
   
         return(1);          /* Jump to the next non-whitespace word. */
 }  
   
           while (buf[offs] && buf[offs] == ' ')
                   offs++;
   
 static struct man_node *          /*
 man_node_alloc(int line, int pos, enum man_type type)           * Trailing whitespace.  Note that tabs are allowed to be passed
 {           * into the parser as "text", so we only warn about spaces here.
         struct man_node *p;           */
   
         if (NULL == (p = calloc(1, sizeof(struct man_node))))          if (buf[offs] == '\0' && buf[offs - 1] == ' ')
                 err(1, "malloc");                  mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
         p->line = line;                      ln, offs - 1, NULL);
         p->pos = pos;  
         p->type = type;  
   
         return(p);          /*
 }           * Some macros break next-line scopes; otherwise, remember
            * whether we are in next-line scope for a block head.
            */
   
           man_breakscope(man, tok);
           bline = man->flags & MAN_BLINE;
   
 int          /* Call to handler... */
 man_elem_alloc(struct man *man, int line, int pos, int tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_ELEM);          assert(man_macros[tok].fp);
         p->tok = tok;          (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
   
         return(man_node_append(man, p));          /* In quick mode (for mandocdb), abort after the NAME section. */
 }  
   
           if (man->quick && tok == MAN_SH) {
                   n = man->last;
                   if (n->type == ROFFT_BODY &&
                       strcmp(n->prev->child->string, "NAME"))
                           return(2);
           }
   
 int          /*
 man_word_alloc(struct man *man,           * If we are in a next-line scope for a block head,
                 int line, int pos, const char *word)           * close it out now and switch to the body,
 {           * unless the next-line scope is allowed to continue.
         struct man_node *p;           */
   
         p = man_node_alloc(line, pos, MAN_TEXT);          if ( ! bline || man->flags & MAN_ELINE ||
         if (NULL == (p->string = strdup(word)))              man_macros[tok].flags & MAN_NSCOPED)
                 err(1, "strdup");                  return(1);
   
         return(man_node_append(man, p));          assert(man->flags & MAN_BLINE);
           man->flags &= ~MAN_BLINE;
   
           man_unscope(man, man->last->parent);
           roff_body_alloc(man, ln, ppos, man->last->tok);
           return(1);
 }  }
   
   
 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);           * An element next line scope is open,
         free(p);           * and the new macro is not allowed inside elements.
 }           * Delete the element that is being broken.
            */
   
           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;
   
 void                  mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
 man_node_freelist(struct man_node *p)                      n->line, n->pos, "%s breaks %s",
 {                      tok == TOKEN_NONE ? "TS" : man_macronames[tok],
                       man_macronames[n->tok]);
   
         if (p->child)                  roff_node_delete(man, n);
                 man_node_freelist(p->child);                  man->flags &= ~MAN_ELINE;
         if (p->next)          }
                 man_node_freelist(p->next);  
   
         man_node_free(p);          /*
 }           * A block header next line scope is open,
            * and the new macro is not allowed inside block headers.
            * Delete the block that is being broken.
            */
   
           if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
               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;
   
 static int                  assert(n->type == ROFFT_HEAD);
 man_ptext(struct man *m, int line, char *buf)                  n = n->parent;
 {                  assert(n->type == ROFFT_BLOCK);
                   assert(man_macros[n->tok].flags & MAN_SCOPED);
   
         if ( ! man_word_alloc(m, line, 0, buf))                  mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                 return(0);                      n->line, n->pos, "%s breaks %s",
         m->next = MAN_NEXT_SIBLING;                      tok == TOKEN_NONE ? "TS" : man_macronames[tok],
         return(1);                      man_macronames[n->tok]);
   
                   roff_node_delete(man, n);
                   man->flags &= ~MAN_BLINE;
           }
 }  }
   
   const struct mparse *
 int  man_mparse(const struct roff_man *man)
 man_pmacro(struct man *m, int ln, char *buf)  
 {  {
         int               i, c;  
         char              mac[5];  
   
         /* Comments and empties are quickly ignored. */          assert(man && man->parse);
           return(man->parse);
   }
   
         if (0 == buf[1])  void
                 return(1);  man_deroff(char **dest, const struct roff_node *n)
   {
           char    *cp;
           size_t   sz;
   
         if (' ' == buf[1]) {          if (n->type != ROFFT_TEXT) {
                 i = 2;                  for (n = n->child; n; n = n->next)
                 while (buf[i] && ' ' == buf[i])                          man_deroff(dest, n);
                         i++;                  return;
                 if (0 == buf[i])  
                         return(1);  
                 warnx("invalid syntax");  
                 return(0);  
         }          }
   
         if (buf[1] && '\\' == buf[1])          /* Skip leading whitespace and escape sequences. */
                 if (buf[2] && '\"' == buf[2])  
                         return(1);  
   
         /* Copy the first word into a nil-terminated buffer. */          cp = n->string;
           while ('\0' != *cp) {
         for (i = 1; i < 5; i++) {                  if ('\\' == *cp) {
                 if (0 == (mac[i - 1] = buf[i]))                          cp++;
                           mandoc_escape((const char **)&cp, NULL, NULL);
                   } else if (isspace((unsigned char)*cp))
                           cp++;
                   else
                         break;                          break;
                 else if (' ' == buf[i])  
                         break;  
         }          }
   
         mac[i - 1] = 0;          /* Skip trailing whitespace. */
   
         if (i == 5 || i <= 1) {          for (sz = strlen(cp); sz; sz--)
                 warnx("unknown macro: %s", mac);                  if (0 == isspace((unsigned char)cp[sz-1]))
                 goto err;                          break;
         }  
   
         if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {  
                 warnx("unknown macro: %s", mac);  
                 goto err;  
         }  
   
         /* The macro is sane.  Jump to the next word. */          /* Skip empty strings. */
   
         while (buf[i] && ' ' == buf[i])          if (0 == sz)
                 i++;                  return;
   
         /* Begin recursive parse sequence. */          if (NULL == *dest) {
                   *dest = mandoc_strndup(cp, sz);
                   return;
           }
   
         if ( ! man_macro(m, c, ln, 1, &i, buf))          mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
                 goto err;          free(*dest);
           *dest = cp;
         return(1);  
   
 err:    /* Error out. */  
   
         m->flags |= MAN_HALT;  
         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));  
 }  
   
   
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.160
CVSweb