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

Diff for /mandoc/man.c between version 1.125 and 1.172

version 1.125, 2014/03/23 11:25:26 version 1.172, 2017/05/05 15:17:32
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.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.
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.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 "man.h"  
 #include "mandoc.h"  
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
 #include "libman.h"  #include "mandoc.h"
   #include "roff.h"
   #include "man.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   #include "roff_int.h"
   #include "libman.h"
   
 const   char *const __man_macronames[MAN_MAX] = {  static  void             man_descope(struct roff_man *, int, int);
         "br",           "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",            "IR",  
         "RI",           "na",           "sp",           "nf",  
         "fi",           "RE",           "RS",           "DT",  
         "UC",           "PD",           "AT",           "in",  
         "ft",           "OP",           "EX",           "EE",  
         "UR",           "UE"  
         };  
   
 const   char * const *man_macronames = __man_macronames;  
   
 static  struct man_node *man_node_alloc(struct man *, int, int,  
                                 enum man_type, enum mant);  
 static  int              man_node_append(struct man *,  
                                 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 *, int);  
 static  int              man_pmacro(struct man *, int, char *, int);  
 static  void             man_free1(struct man *);  
 static  void             man_alloc1(struct man *);  
 static  int              man_descope(struct man *, int, int);  
   
   
 const struct man_node *  
 man_node(const struct man *man)  
 {  
   
         assert( ! (MAN_HALT & man->flags));  
         return(man->first);  
 }  
   
   
 const struct man_meta *  
 man_meta(const struct man *man)  
 {  
   
         assert( ! (MAN_HALT & man->flags));  
         return(&man->meta);  
 }  
   
   
 void  
 man_reset(struct man *man)  
 {  
   
         man_free1(man);  
         man_alloc1(man);  
 }  
   
   
 void  
 man_free(struct man *man)  
 {  
   
         man_free1(man);  
         free(man);  
 }  
   
   
 struct man *  
 man_alloc(struct roff *roff, struct mparse *parse, int quick)  
 {  
         struct man      *p;  
   
         p = mandoc_calloc(1, sizeof(struct man));  
   
         man_hash_init();  
         p->parse = parse;  
         p->quick = quick;  
         p->roff = roff;  
   
         man_alloc1(p);  
         return(p);  
 }  
   
   
 int  int
 man_endparse(struct man *man)  man_parseln(struct roff_man *man, int ln, char *buf, int offs)
 {  {
   
         assert( ! (MAN_HALT & man->flags));          if (man->last->type != ROFFT_EQN || ln > man->last->line)
         if (man_macroend(man))                  man->flags |= MAN_NEWLINE;
                 return(1);  
         man->flags |= MAN_HALT;  
         return(0);  
 }  
   
           return roff_getcontrol(man->roff, buf, &offs) ?
 int              man_pmacro(man, ln, buf, offs) :
 man_parseln(struct man *man, int ln, char *buf, int offs)              man_ptext(man, ln, buf, offs);
 {  
   
         man->flags |= MAN_NEWLINE;  
   
         assert( ! (MAN_HALT & man->flags));  
   
         return (roff_getcontrol(man->roff, buf, &offs) ?  
                         man_pmacro(man, ln, buf, offs) :  
                         man_ptext(man, ln, buf, offs));  
 }  }
   
   
 static void  static void
 man_free1(struct man *man)  man_descope(struct roff_man *man, int line, int offs)
 {  {
   
         if (man->first)  
                 man_node_delete(man, man->first);  
         if (man->meta.title)  
                 free(man->meta.title);  
         if (man->meta.source)  
                 free(man->meta.source);  
         if (man->meta.date)  
                 free(man->meta.date);  
         if (man->meta.vol)  
                 free(man->meta.vol);  
         if (man->meta.msec)  
                 free(man->meta.msec);  
 }  
   
   
 static void  
 man_alloc1(struct man *man)  
 {  
   
         memset(&man->meta, 0, sizeof(struct man_meta));  
         man->flags = 0;  
         man->last = mandoc_calloc(1, sizeof(struct man_node));  
         man->first = man->last;  
         man->last->type = MAN_ROOT;  
         man->last->tok = MAN_MAX;  
         man->next = MAN_NEXT_CHILD;  
 }  
   
   
 static int  
 man_node_append(struct man *man, struct man_node *p)  
 {  
   
         assert(man->last);  
         assert(man->first);  
         assert(MAN_ROOT != p->type);  
   
         switch (man->next) {  
         case (MAN_NEXT_SIBLING):  
                 man->last->next = p;  
                 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 */  
         }  
   
         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_TAIL):  
                 assert(MAN_BLOCK == p->parent->type);  
                 p->parent->tail = p;  
                 break;  
         case (MAN_BODY):  
                 assert(MAN_BLOCK == p->parent->type);  
                 p->parent->body = p;  
                 break;  
         default:  
                 break;  
         }  
   
         man->last = p;  
   
         switch (p->type) {  
         case (MAN_TBL):  
                 /* FALLTHROUGH */  
         case (MAN_TEXT):  
                 if ( ! man_valid_post(man))  
                         return(0);  
                 break;  
         default:  
                 break;  
         }  
   
         return(1);  
 }  
   
   
 static struct man_node *  
 man_node_alloc(struct man *man, int line, int pos,  
                 enum man_type type, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = mandoc_calloc(1, sizeof(struct man_node));  
         p->line = line;  
         p->pos = pos;  
         p->type = type;  
         p->tok = tok;  
   
         if (MAN_NEWLINE & man->flags)  
                 p->flags |= MAN_LINE;  
         man->flags &= ~MAN_NEWLINE;  
         return(p);  
 }  
   
   
 int  
 man_elem_alloc(struct man *man, int line, int pos, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(man, line, pos, MAN_ELEM, tok);  
         if ( ! man_node_append(man, p))  
                 return(0);  
         man->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 man_tail_alloc(struct man *man, int line, int pos, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(man, line, pos, MAN_TAIL, tok);  
         if ( ! man_node_append(man, p))  
                 return(0);  
         man->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 man_head_alloc(struct man *man, int line, int pos, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(man, line, pos, MAN_HEAD, tok);  
         if ( ! man_node_append(man, p))  
                 return(0);  
         man->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 man_body_alloc(struct man *man, int line, int pos, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(man, line, pos, MAN_BODY, tok);  
         if ( ! man_node_append(man, p))  
                 return(0);  
         man->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
   
 int  
 man_block_alloc(struct man *man, int line, int pos, enum mant tok)  
 {  
         struct man_node *p;  
   
         p = man_node_alloc(man, line, pos, MAN_BLOCK, tok);  
         if ( ! man_node_append(man, p))  
                 return(0);  
         man->next = MAN_NEXT_CHILD;  
         return(1);  
 }  
   
 int  
 man_word_alloc(struct man *man, int line, int pos, const char *word)  
 {  
         struct man_node *n;  
   
         n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX);  
         n->string = roff_strdup(man->roff, word);  
   
         if ( ! man_node_append(man, n))  
                 return(0);  
   
         man->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)  
 {  
   
         if (p->string)  
                 free(p->string);  
         free(p);  
 }  
   
   
 void  
 man_node_delete(struct man *man, struct man_node *p)  
 {  
   
         while (p->child)  
                 man_node_delete(man, p->child);  
   
         man_node_unlink(man, p);  
         man_node_free(p);  
 }  
   
 int  
 man_addeqn(struct man *man, const struct eqn *ep)  
 {  
         struct man_node *n;  
   
         assert( ! (MAN_HALT & man->flags));  
   
         n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX);  
         n->eqn = ep;  
   
         if ( ! man_node_append(man, n))  
                 return(0);  
   
         man->next = MAN_NEXT_SIBLING;  
         return(man_descope(man, ep->ln, ep->pos));  
 }  
   
 int  
 man_addspan(struct man *man, const struct tbl_span *sp)  
 {  
         struct man_node *n;  
   
         assert( ! (MAN_HALT & man->flags));  
   
         n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX);  
         n->span = sp;  
   
         if ( ! man_node_append(man, n))  
                 return(0);  
   
         man->next = MAN_NEXT_SIBLING;  
         return(man_descope(man, sp->line, 0));  
 }  
   
 static int  
 man_descope(struct man *man, int line, int offs)  
 {  
         /*          /*
          * Co-ordinate what happens with having a next-line scope open:           * Co-ordinate what happens with having a next-line scope open:
          * first close out the element scope (if applicable), then close           * first close out the element scope (if applicable), then close
          * out the block scope (also if applicable).           * out the block scope (also if applicable).
          */           */
   
         if (MAN_ELINE & man->flags) {          if (man->flags & MAN_ELINE) {
                 man->flags &= ~MAN_ELINE;                  man->flags &= ~MAN_ELINE;
                 if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))                  man_unscope(man, man->last->parent);
                         return(0);  
         }          }
           if ( ! (man->flags & MAN_BLINE))
         if ( ! (MAN_BLINE & man->flags))                  return;
                 return(1);  
         man->flags &= ~MAN_BLINE;          man->flags &= ~MAN_BLINE;
           man_unscope(man, man->last->parent);
         if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))          roff_body_alloc(man, line, offs, man->last->tok);
                 return(0);  
         return(man_body_alloc(man, line, offs, man->last->tok));  
 }  }
   
 static int  static int
 man_ptext(struct man *man, int line, char *buf, int offs)  man_ptext(struct roff_man *man, int line, char *buf, int offs)
 {  {
         int              i;          int              i;
   
         /* Literal free-form text whitespace is preserved. */          /* Literal free-form text whitespace is preserved. */
   
         if (MAN_LITERAL & man->flags) {          if (man->flags & MAN_LITERAL) {
                 if ( ! man_word_alloc(man, line, offs, buf + offs))                  roff_word_alloc(man, line, offs, buf + offs);
                         return(0);                  man_descope(man, line, offs);
                 return(man_descope(man, line, offs));                  return 1;
         }          }
   
         for (i = offs; ' ' == buf[i]; i++)          for (i = offs; buf[i] == ' '; i++)
                 /* Skip leading whitespace. */ ;                  /* Skip leading whitespace. */ ;
   
         /*          /*
Line 441  man_ptext(struct man *man, int line, char *buf, int of
Line 93  man_ptext(struct man *man, int line, char *buf, int of
          * but add a single vertical space elsewhere.           * but add a single vertical space elsewhere.
          */           */
   
         if ('\0' == buf[i]) {          if (buf[i] == '\0') {
                 /* Allocate a blank entry. */                  /* Allocate a blank entry. */
                 if (MAN_SH != man->last->tok &&                  if (man->last->tok != MAN_SH &&
                     MAN_SS != man->last->tok) {                      man->last->tok != MAN_SS) {
                         if ( ! man_elem_alloc(man, line, offs, MAN_sp))                          roff_elem_alloc(man, line, offs, ROFF_sp);
                                 return(0);                          man->next = ROFF_NEXT_SIBLING;
                         man->next = MAN_NEXT_SIBLING;  
                 }                  }
                 return(1);                  return 1;
         }          }
   
         /*          /*
          * Warn if the last un-escaped character is whitespace. Then           * Warn if the last un-escaped character is whitespace. Then
          * strip away the remaining spaces (tabs stay!).           * strip away the remaining spaces (tabs stay!).
          */           */
   
         i = (int)strlen(buf);          i = (int)strlen(buf);
Line 462  man_ptext(struct man *man, int line, char *buf, int of
Line 113  man_ptext(struct man *man, int line, char *buf, int of
   
         if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {          if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                 if (i > 1 && '\\' != buf[i - 2])                  if (i > 1 && '\\' != buf[i - 2])
                         man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE);                          mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                               line, i - 1, NULL);
   
                 for (--i; i && ' ' == buf[i]; i--)                  for (--i; i && ' ' == buf[i]; i--)
                         /* Spin back to non-space. */ ;                          /* Spin back to non-space. */ ;
Line 472  man_ptext(struct man *man, int line, char *buf, int of
Line 124  man_ptext(struct man *man, int line, char *buf, int of
   
                 buf[i] = '\0';                  buf[i] = '\0';
         }          }
           roff_word_alloc(man, line, offs, buf + offs);
   
         if ( ! man_word_alloc(man, line, offs, buf + offs))  
                 return(0);  
   
         /*          /*
          * End-of-sentence check.  If the last character is an unescaped           * End-of-sentence check.  If the last character is an unescaped
          * EOS character, then flag the node as being the end of a           * EOS character, then flag the node as being the end of a
Line 484  man_ptext(struct man *man, int line, char *buf, int of
Line 134  man_ptext(struct man *man, int line, char *buf, int of
   
         assert(i);          assert(i);
         if (mandoc_eos(buf, (size_t)i))          if (mandoc_eos(buf, (size_t)i))
                 man->last->flags |= MAN_EOS;                  man->last->flags |= NODE_EOS;
   
         return(man_descope(man, line, offs));          man_descope(man, line, offs);
           return 1;
 }  }
   
 static int  static int
 man_pmacro(struct man *man, int ln, char *buf, int offs)  man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
 {  {
         int              i, ppos;          struct roff_node *n;
         enum mant        tok;          const char      *cp;
         char             mac[5];          size_t           sz;
         struct man_node *n;          enum roff_tok    tok;
           int              ppos;
           int              bline;
   
         if ('"' == buf[offs]) {          /* Determine the line macro. */
                 man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT);  
                 return(1);  
         } else if ('\0' == buf[offs])  
                 return(1);  
   
         ppos = offs;          ppos = offs;
           tok = TOKEN_NONE;
           for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
                   offs++;
           if (sz > 0 && sz < 4)
                   tok = roffhash_find(man->manmac, buf + ppos, sz);
           if (tok == TOKEN_NONE) {
                   mandoc_msg(MANDOCERR_MACRO, man->parse,
                       ln, ppos, buf + ppos - 1);
                   return 1;
           }
   
         /*          /* Skip a leading escape sequence or tab. */
          * Copy the first word into a nil-terminated buffer.  
          * Stop copying when a tab, space, or eoln is encountered.  
          */  
   
         i = 0;          switch (buf[offs]) {
         while (i < 4 && '\0' != buf[offs] &&          case '\\':
                         ' ' != buf[offs] && '\t' != buf[offs])                  cp = buf + offs + 1;
                 mac[i++] = buf[offs++];                  mandoc_escape(&cp, NULL, NULL);
                   offs = cp - buf;
         mac[i] = '\0';                  break;
           case '\t':
         tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;                  offs++;
                   break;
         if (MAN_MAX == tok) {          default:
                 mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln,                  break;
                                 ppos, "%s", buf + ppos - 1);  
                 return(1);  
         }          }
   
         /* The macro is sane.  Jump to the next word. */          /* Jump to the next non-whitespace word. */
   
         while (buf[offs] && ' ' == buf[offs])          while (buf[offs] == ' ')
                 offs++;                  offs++;
   
         /*          /*
          * Trailing whitespace.  Note that tabs are allowed to be passed           * Trailing whitespace.  Note that tabs are allowed to be passed
          * into the parser as "text", so we only warn about spaces here.           * into the parser as "text", so we only warn about spaces here.
          */           */
   
         if ('\0' == buf[offs] && ' ' == buf[offs - 1])          if (buf[offs] == '\0' && buf[offs - 1] == ' ')
                 man_pmsg(man, ln, offs - 1, MANDOCERR_EOLNSPACE);                  mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                       ln, offs - 1, NULL);
   
         /*          /*
          * Remove prior ELINE macro, as it's being clobbered by a new           * Some macros break next-line scopes; otherwise, remember
          * macro.  Note that NSCOPED macros do not close out ELINE           * whether we are in next-line scope for a block head.
          * macros---they don't print text---so we let those slip by.  
          */           */
   
         if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&          man_breakscope(man, tok);
                         man->flags & MAN_ELINE) {          bline = man->flags & MAN_BLINE;
                 n = man->last;  
                 assert(MAN_TEXT != n->type);  
   
                 /* Remove repeated NSCOPED macros causing ELINE. */  
   
                 if (MAN_NSCOPED & man_macros[n->tok].flags)  
                         n = n->parent;  
   
                 mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,  
                     n->pos, "%s breaks %s", man_macronames[tok],  
                     man_macronames[n->tok]);  
   
                 man_node_delete(man, n);  
                 man->flags &= ~MAN_ELINE;  
         }  
   
         /*          /*
          * Remove prior BLINE macro that is being clobbered.           * If the line in next-line scope ends with \c, keep the
            * next-line scope open for the subsequent input line.
            * 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.
          */           */
         if ((man->flags & MAN_BLINE) &&  
             (MAN_BSCOPE & man_macros[tok].flags)) {  
                 n = man->last;  
   
                 /* Might be a text node like 8 in          if (bline) {
                  * .TP 8                  cp = strchr(buf + offs, '\0') - 2;
                  * .SH foo                  if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
                  */                          bline = 0;
                 if (MAN_TEXT == n->type)          }
                         n = n->parent;  
   
                 /* Remove element that didn't end BLINE, if any. */          /* Call to handler... */
                 if ( ! (MAN_BSCOPE & man_macros[n->tok].flags))  
                         n = n->parent;  
   
                 assert(MAN_HEAD == n->type);          assert(man_macros[tok].fp);
                 n = n->parent;          (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
                 assert(MAN_BLOCK == n->type);  
                 assert(MAN_SCOPED & man_macros[n->tok].flags);  
   
                 mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,          /* In quick mode (for mandocdb), abort after the NAME section. */
                     n->pos, "%s breaks %s", man_macronames[tok],  
                     man_macronames[n->tok]);  
   
                 man_node_delete(man, n);          if (man->quick && tok == MAN_SH) {
                 man->flags &= ~MAN_BLINE;                  n = man->last;
                   if (n->type == ROFFT_BODY &&
                       strcmp(n->prev->child->string, "NAME"))
                           return 2;
         }          }
   
         /*          /*
          * Save the fact that we're in the next-line for a block.  In           * If we are in a next-line scope for a block head,
          * this way, embedded roff instructions can "remember" state           * close it out now and switch to the body,
          * when they exit.           * unless the next-line scope is allowed to continue.
          */           */
   
         if (MAN_BLINE & man->flags)          if ( ! bline || man->flags & MAN_ELINE ||
                 man->flags |= MAN_BPLINE;              man_macros[tok].flags & MAN_NSCOPED)
                   return 1;
   
         /* Call to handler... */          assert(man->flags & MAN_BLINE);
           man->flags &= ~MAN_BLINE;
   
         assert(man_macros[tok].fp);          man_unscope(man, man->last->parent);
         if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf))          roff_body_alloc(man, ln, ppos, man->last->tok);
                 goto err;          return 1;
   }
   
         /* In quick mode (for mandocdb), abort after the NAME section. */  void
   man_breakscope(struct roff_man *man, int tok)
   {
           struct roff_node *n;
   
         if (man->quick && MAN_SH == tok &&          /*
             strcmp(man->last->prev->child->string, "NAME"))           * An element next line scope is open,
                 return(2);           * and the new macro is not allowed inside elements.
            * Delete the element that is being broken.
         /*  
          * We weren't in a block-line scope when entering the  
          * above-parsed macro, so return.  
          */           */
   
         if ( ! (MAN_BPLINE & man->flags)) {          if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
                 man->flags &= ~MAN_ILINE;              ! (man_macros[tok].flags & MAN_NSCOPED))) {
                 return(1);                  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",
                       tok == TOKEN_NONE ? "TS" : roff_name[tok],
                       roff_name[n->tok]);
   
                   roff_node_delete(man, n);
                   man->flags &= ~MAN_ELINE;
         }          }
         man->flags &= ~MAN_BPLINE;  
   
         /*          /*
          * If we're in a block scope, then allow this macro to slip by           * Weird special case:
          * without closing scope around it.           * Switching fill mode closes section headers.
          */           */
   
         if (MAN_ILINE & man->flags) {          if (man->flags & MAN_BLINE &&
                 man->flags &= ~MAN_ILINE;              (tok == MAN_nf || tok == MAN_fi) &&
                 return(1);              (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;
         }          }
   
         /*          /*
          * If we've opened a new next-line element scope, then return           * A block header next line scope is open,
          * now, as the next line will close out the block scope.           * and the new macro is not allowed inside block headers.
            * Delete the block that is being broken.
          */           */
   
         if (MAN_ELINE & man->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);
   
         assert(MAN_BLINE & man->flags);                  mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
         man->flags &= ~MAN_BLINE;                      n->line, n->pos, "%s breaks %s",
                       tok == TOKEN_NONE ? "TS" : roff_name[tok],
                       roff_name[n->tok]);
   
         if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))                  roff_node_delete(man, n);
                 return(0);                  man->flags &= ~MAN_BLINE;
         return(man_body_alloc(man, ln, ppos, man->last->tok));          }
   }
   
 err:    /* Error out. */  const struct mparse *
   man_mparse(const struct roff_man *man)
   {
   
         man->flags |= MAN_HALT;          assert(man && man->parse);
         return(0);          return man->parse;
 }  }
   
 /*  void
  * Unlink a node from its context.  If "man" is provided, the last parse  man_state(struct roff_man *man, struct roff_node *n)
  * point will also be adjusted accordingly.  
  */  
 static void  
 man_node_unlink(struct man *man, struct man_node *n)  
 {  {
   
         /* Adjust siblings. */          switch(n->tok) {
           case MAN_nf:
         if (n->prev)          case MAN_EX:
                 n->prev->next = n->next;                  if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
         if (n->next)                          mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                 n->next->prev = n->prev;                              n->line, n->pos, "nf");
                   man->flags |= MAN_LITERAL;
         /* Adjust parent. */                  break;
           case MAN_fi:
         if (n->parent) {          case MAN_EE:
                 n->parent->nchild--;                  if ( ! (man->flags & MAN_LITERAL) &&
                 if (n->parent->child == n)                       ! (n->flags & NODE_VALID))
                         n->parent->child = n->prev ? n->prev : n->next;                          mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                               n->line, n->pos, "fi");
                   man->flags &= ~MAN_LITERAL;
                   break;
           default:
                   break;
         }          }
           man->last->flags |= NODE_VALID;
         /* Adjust parse point, if applicable. */  
   
         if (man && man->last == n) {  
                 /*XXX: this can occur when bailing from validation. */  
                 /*assert(NULL == n->next);*/  
                 if (n->prev) {  
                         man->last = n->prev;  
                         man->next = MAN_NEXT_SIBLING;  
                 } else {  
                         man->last = n->parent;  
                         man->next = MAN_NEXT_CHILD;  
                 }  
         }  
   
         if (man && man->first == n)  
                 man->first = NULL;  
 }  }
   
 const struct mparse *  void
 man_mparse(const struct man *man)  man_validate(struct roff_man *man)
 {  {
   
         assert(man && man->parse);          man->last = man->first;
         return(man->parse);          man_node_validate(man);
           man->flags &= ~MAN_LITERAL;
 }  }
Legend:
Removed from v.1.125  
changed lines
  Added in v.1.172
CVSweb