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

Diff for /mandoc/man.c between version 1.1 and 1.173

version 1.1, 2009/03/23 14:22:11 version 1.173, 2017/05/08 20:33:53
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, 2017 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] = {  static  void             man_descope(struct roff_man *, int, int);
         "\\\"",         "TH",           "SH",           "SS",  static  int              man_ptext(struct roff_man *, int, char *, int);
         "TP",           "LP",           "PP",           "P",  static  int              man_pmacro(struct roff_man *, int, char *, int);
         "IP",           "HP",           "SM",           "SB",  
         "BI",           "IB",           "BR",           "RB",  
         "R",            "B",            "I"  
         };  
   
 const   char * const *man_macronames = __man_macronames;  
   
 static  struct man_node *man_node_alloc(int, int, enum man_type);  int
 static  int              man_node_append(struct man *,  man_parseln(struct roff_man *man, int ln, char *buf, int offs)
                                 struct man_node *);  
 static  int              man_ptext(struct man *, int, char *);  
 static  int              man_pmacro(struct man *, int, char *);  
   
   
 const struct man_node *  
 man_node(const struct man *man)  
 {  {
   
         return(man->first);          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);
 }  }
   
   static void
 const struct man_meta *  man_descope(struct roff_man *man, int line, int offs)
 man_meta(const 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).
            */
   
         return(&man->meta);          if (man->flags & MAN_ELINE) {
                   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_reset(struct man *man)  
 {  {
           int              i;
   
         if (man->first)          /* Literal free-form text whitespace is preserved. */
                 man_node_freelist(man->first);  
         if (man->meta.title)  
                 free(man->meta.title);  
         if (man->meta.os)  
                 free(man->meta.os);  
         if (man->meta.vol)  
                 free(man->meta.vol);  
   
         bzero(&man->meta, sizeof(struct man_meta));          if (man->flags & MAN_LITERAL) {
         man->flags = 0;                  roff_word_alloc(man, line, offs, buf + offs);
         if (NULL == (man->last = calloc(1, sizeof(struct man_node))))                  man_descope(man, line, offs);
                 err(1, "malloc");                  return 1;
         man->first = man->last;          }
         man->last->type = MAN_ROOT;  
         man->next = MAN_NEXT_CHILD;  
 }  
   
           for (i = offs; buf[i] == ' '; i++)
                   /* Skip leading whitespace. */ ;
   
 void          /*
 man_free(struct man *man)           * Blank lines are ignored right after headings
 {           * but add a single vertical space elsewhere.
            */
   
         if (man->first)          if (buf[i] == '\0') {
                 man_node_freelist(man->first);                  man_breakscope(man, ROFF_sp);
         if (man->meta.title)                  /* Allocate a blank entry. */
                 free(man->meta.title);                  if (man->last->tok != MAN_SH &&
         if (man->meta.os)                      man->last->tok != MAN_SS) {
                 free(man->meta.os);                          roff_elem_alloc(man, line, offs, ROFF_sp);
         if (man->meta.vol)                          man->next = ROFF_NEXT_SIBLING;
                 free(man->meta.vol);                  }
         if (man->htab)                  return 1;
                 man_hash_free(man->htab);          }
         free(man);  
 }  
   
           /*
            * Warn if the last un-escaped character is whitespace. Then
            * strip away the remaining spaces (tabs stay!).
            */
   
 struct man *          i = (int)strlen(buf);
 man_alloc(void)          assert(i);
 {  
         struct man      *p;  
   
         if (NULL == (p = calloc(1, sizeof(struct man))))          if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                 err(1, "malloc");                  if (i > 1 && '\\' != buf[i - 2])
         if (NULL == (p->last = calloc(1, sizeof(struct man_node))))                          mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                 err(1, "malloc");                              line, i - 1, NULL);
   
         p->first = p->last;                  for (--i; i && ' ' == buf[i]; i--)
         p->last->type = MAN_ROOT;                          /* Spin back to non-space. */ ;
         p->next = MAN_NEXT_CHILD;  
         p->htab = man_hash_alloc();  
         return(p);  
 }  
   
                   /* Jump ahead of escaped whitespace. */
                   i += '\\' == buf[i] ? 2 : 1;
   
 int                  buf[i] = '\0';
 man_endparse(struct man *m)          }
 {          roff_word_alloc(man, line, offs, buf + offs);
   
         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);
           if (mandoc_eos(buf, (size_t)i))
                   man->last->flags |= NODE_EOS;
   
 int          man_descope(man, line, offs);
 man_parseln(struct man *m, int ln, char *buf)          return 1;
 {  
   
         return('.' == *buf ?  
                         man_pmacro(m, ln, buf) :  
                         man_ptext(m, ln, buf));  
 }  }
   
   
 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;
           size_t           sz;
           enum roff_tok    tok;
           int              ppos;
           int              bline;
   
         assert(man->last);          /* Determine the line macro. */
         assert(man->first);  
         assert(MAN_ROOT != p->type);  
   
         switch (man->next) {          ppos = offs;
         case (MAN_NEXT_SIBLING):          tok = TOKEN_NONE;
                 man->last->next = p;          for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
                 p->prev = man->last;                  offs++;
                 p->parent = man->last->parent;          if (sz > 0 && sz < 4)
                 break;                  tok = roffhash_find(man->manmac, buf + ppos, sz);
         case (MAN_NEXT_CHILD):          if (tok == TOKEN_NONE) {
                 man->last->child = p;                  mandoc_msg(MANDOCERR_MACRO, man->parse,
                 p->parent = man->last;                      ln, ppos, buf + ppos - 1);
                 break;                  return 1;
         default:  
                 abort();  
                 /* NOTREACHED */  
         }          }
   
 #if 0          /* Skip a leading escape sequence or tab. */
         if ( ! man_valid_pre(man, p))  
                 return(0);  
         if ( ! man_action_pre(man, p))  
                 return(0);  
 #endif  
   
         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. */
         return(1);  
 }  
   
           while (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          /*
 man_head_alloc(struct man *man, int line, int pos, int tok)           * If the line in next-line scope ends with \c, keep the
 {           * next-line scope open for the subsequent input line.
         struct man_node *p;           * That is not at all portable, only groff >= 1.22.4
            * does it, but *if* this weird idiom occurs in a manual
            * page, that's very likely what the author intended.
            */
   
         p = man_node_alloc(line, pos, MAN_HEAD);          if (bline) {
         p->tok = tok;                  cp = strchr(buf + offs, '\0') - 2;
                   if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
                           bline = 0;
           }
   
         return(man_node_append(man, p));          /* Call to handler... */
 }  
   
           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_body_alloc(struct man *man, int line, int pos, int tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_BODY);          if (man->quick && tok == MAN_SH) {
         p->tok = tok;                  n = man->last;
                   if (n->type == ROFFT_BODY &&
                       strcmp(n->prev->child->string, "NAME"))
                           return 2;
           }
   
         return(man_node_append(man, p));          /*
 }           * 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.
            */
   
           if ( ! bline || man->flags & MAN_ELINE ||
               man_macros[tok].flags & MAN_NSCOPED)
                   return 1;
   
 int          assert(man->flags & MAN_BLINE);
 man_block_alloc(struct man *man, int line, int pos, int tok)          man->flags &= ~MAN_BLINE;
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_BLOCK);          man_unscope(man, man->last->parent);
         p->tok = tok;          roff_body_alloc(man, ln, ppos, man->last->tok);
           return 1;
         return(man_node_append(man, p));  
 }  }
   
   void
 int  man_breakscope(struct roff_man *man, int tok)
 man_elem_alloc(struct man *man, int line, int pos, int tok)  
 {  {
         struct man_node *p;          struct roff_node *n;
   
         p = man_node_alloc(line, pos, MAN_ELEM);          /*
         p->tok = tok;           * An element next line scope is open,
            * and the new macro is not allowed inside elements.
            * Delete the element that is being broken.
            */
   
         return(man_node_append(man, p));          if (man->flags & MAN_ELINE && (tok < MAN_TH ||
 }              ! (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;
   
                   mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                       n->line, n->pos, "%s breaks %s",
                       roff_name[tok], roff_name[n->tok]);
   
 int                  roff_node_delete(man, n);
 man_word_alloc(struct man *man,                  man->flags &= ~MAN_ELINE;
                 int line, int pos, const char *word)          }
 {  
         struct man_node *p;  
   
         p = man_node_alloc(line, pos, MAN_TEXT);          /*
         if (NULL == (p->string = strdup(word)))           * Weird special case:
                 err(1, "strdup");           * Switching fill mode closes section headers.
            */
   
         return(man_node_append(man, p));          if (man->flags & MAN_BLINE &&
 }              (tok == MAN_nf || tok == MAN_fi) &&
               (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
                   n = man->last;
                   man_unscope(man, n);
                   roff_body_alloc(man, n->line, n->pos, n->tok);
                   man->flags &= ~MAN_BLINE;
           }
   
           /*
            * 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.
            */
   
 void          if (man->flags & MAN_BLINE && (tok < MAN_TH ||
 man_node_free(struct man_node *p)              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;
   
         if (p->string)                  assert(n->type == ROFFT_HEAD);
                 free(p->string);                  n = n->parent;
         free(p);                  assert(n->type == ROFFT_BLOCK);
 }                  assert(man_macros[n->tok].flags & MAN_SCOPED);
   
                   mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                       n->line, n->pos, "%s breaks %s",
                       roff_name[tok], roff_name[n->tok]);
   
 void                  roff_node_delete(man, n);
 man_node_freelist(struct man_node *p)                  man->flags &= ~MAN_BLINE;
           }
   }
   
   const struct mparse *
   man_mparse(const struct roff_man *man)
 {  {
   
         if (p->child)          assert(man && man->parse);
                 man_node_freelist(p->child);          return man->parse;
         if (p->next)  
                 man_node_freelist(p->next);  
   
         man_node_free(p);  
 }  }
   
   void
 static int  man_state(struct roff_man *man, struct roff_node *n)
 man_ptext(struct man *m, int line, char *buf)  
 {  {
   
         if (0 == buf[0]) {          switch(n->tok) {
                 warnx("blank line!");          case MAN_nf:
                 return(1);          case MAN_EX:
                   if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
                           mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                               n->line, n->pos, "nf");
                   man->flags |= MAN_LITERAL;
                   break;
           case MAN_fi:
           case MAN_EE:
                   if ( ! (man->flags & MAN_LITERAL) &&
                        ! (n->flags & NODE_VALID))
                           mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                               n->line, n->pos, "fi");
                   man->flags &= ~MAN_LITERAL;
                   break;
           default:
                   break;
         }          }
           man->last->flags |= NODE_VALID;
         if ( ! man_word_alloc(m, line, 0, buf))  
                 return(0);  
   
         m->next = MAN_NEXT_SIBLING;  
         return(1);  
 }  }
   
   void
 int  man_validate(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. */          man->last = man->first;
           man_node_validate(man);
         if (0 == buf[1])          man->flags &= ~MAN_LITERAL;
                 return(1);  
   
         if (' ' == buf[1]) {  
                 i = 2;  
                 while (buf[i] && ' ' == buf[i])  
                         i++;  
                 if (0 == buf[i])  
                         return(1);  
                 warnx("invalid syntax");  
                 return(0);  
         }  
   
         if (buf[1] && '\\' == buf[1])  
                 if (buf[2] && '\"' == buf[2])  
                         return(1);  
   
         /* Copy the first word into a nil-terminated buffer. */  
   
         for (i = 1; i < 5; i++) {  
                 if (0 == (mac[i - 1] = buf[i]))  
                         break;  
                 else if (' ' == buf[i])  
                         break;  
         }  
   
         mac[i - 1] = 0;  
   
         if (i == 5 || i <= 1) {  
                 warnx("unknown macro: %s", mac);  
                 goto err;  
         }  
   
         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. */  
   
         while (buf[i] && ' ' == buf[i])  
                 i++;  
   
         /* Begin recursive parse sequence. */  
   
         if ( ! (*man_macros[c].fp)(m, c, ln, 1, &i, buf))  
                 goto err;  
   
         return(1);  
   
 err:    /* Error out. */  
   
 #if 0  
         m->flags |= MDOC_HALT;  
 #endif  
         return(0);  
 }  }
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.173
CVSweb