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

Diff for /mandoc/man_macro.c between version 1.85 and 1.97

version 1.85, 2014/07/09 11:28:26 version 1.97, 2015/02/06 09:38:43
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) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>   * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
Line 16 
Line 16 
  * 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 <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdlib.h>  #include <stdlib.h>
Line 36  enum rew {
Line 36  enum rew {
         REW_HALT          REW_HALT
 };  };
   
 static  int              blk_close(MACRO_PROT_ARGS);  static  void             blk_close(MACRO_PROT_ARGS);
 static  int              blk_exp(MACRO_PROT_ARGS);  static  void             blk_exp(MACRO_PROT_ARGS);
 static  int              blk_imp(MACRO_PROT_ARGS);  static  void             blk_imp(MACRO_PROT_ARGS);
 static  int              in_line_eoln(MACRO_PROT_ARGS);  static  void             in_line_eoln(MACRO_PROT_ARGS);
 static  int              man_args(struct man *, int,  static  int              man_args(struct man *, int,
                                 int *, char *, char **);                                  int *, char *, char **);
   
 static  int              rew_scope(enum man_type,  static  void             rew_scope(enum man_type,
                                 struct man *, enum mant);                                  struct man *, enum mant);
 static  enum rew         rew_dohalt(enum mant, enum man_type,  static  enum rew         rew_dohalt(enum mant, enum man_type,
                                 const struct man_node *);                                  const struct man_node *);
Line 61  const struct man_macro __man_macros[MAN_MAX] = {
Line 61  const struct man_macro __man_macros[MAN_MAX] = {
         { blk_imp, MAN_BSCOPE }, /* P */          { blk_imp, MAN_BSCOPE }, /* P */
         { blk_imp, MAN_BSCOPE }, /* IP */          { blk_imp, MAN_BSCOPE }, /* IP */
         { blk_imp, MAN_BSCOPE }, /* HP */          { blk_imp, MAN_BSCOPE }, /* HP */
         { in_line_eoln, MAN_SCOPED }, /* SM */          { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
         { in_line_eoln, MAN_SCOPED }, /* SB */          { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
         { in_line_eoln, 0 }, /* BI */          { in_line_eoln, 0 }, /* BI */
         { in_line_eoln, 0 }, /* IB */          { in_line_eoln, 0 }, /* IB */
         { in_line_eoln, 0 }, /* BR */          { in_line_eoln, 0 }, /* BR */
         { in_line_eoln, 0 }, /* RB */          { in_line_eoln, 0 }, /* RB */
         { in_line_eoln, MAN_SCOPED }, /* R */          { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
         { in_line_eoln, MAN_SCOPED }, /* B */          { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
         { in_line_eoln, MAN_SCOPED }, /* I */          { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
         { in_line_eoln, 0 }, /* IR */          { in_line_eoln, 0 }, /* IR */
         { in_line_eoln, 0 }, /* RI */          { in_line_eoln, 0 }, /* RI */
         { in_line_eoln, MAN_NSCOPED }, /* na */  
         { in_line_eoln, MAN_NSCOPED }, /* sp */          { in_line_eoln, MAN_NSCOPED }, /* sp */
         { in_line_eoln, MAN_BSCOPE }, /* nf */          { in_line_eoln, MAN_BSCOPE }, /* nf */
         { in_line_eoln, MAN_BSCOPE }, /* fi */          { in_line_eoln, MAN_BSCOPE }, /* fi */
         { blk_close, 0 }, /* RE */          { blk_close, MAN_BSCOPE }, /* RE */
         { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */          { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
         { in_line_eoln, 0 }, /* DT */          { in_line_eoln, 0 }, /* DT */
         { in_line_eoln, 0 }, /* UC */          { in_line_eoln, 0 }, /* UC */
Line 88  const struct man_macro __man_macros[MAN_MAX] = {
Line 87  const struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, MAN_BSCOPE }, /* EX */          { in_line_eoln, MAN_BSCOPE }, /* EX */
         { in_line_eoln, MAN_BSCOPE }, /* EE */          { in_line_eoln, MAN_BSCOPE }, /* EE */
         { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */          { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
         { blk_close, 0 }, /* UE */          { blk_close, MAN_BSCOPE }, /* UE */
         { in_line_eoln, 0 }, /* ll */          { in_line_eoln, 0 }, /* ll */
 };  };
   
 const   struct man_macro * const man_macros = __man_macros;  const   struct man_macro * const man_macros = __man_macros;
   
   
 int  void
 man_unscope(struct man *man, const struct man_node *to)  man_unscope(struct man *man, const struct man_node *to)
 {  {
         struct man_node *n;          struct man_node *n;
   
         man->next = MAN_NEXT_SIBLING;  
         to = to->parent;          to = to->parent;
         n = man->last;          n = man->last;
         while (n != to) {          while (n != to) {
                 if (NULL == to &&  
                     MAN_BLOCK == n->type &&                  /* Reached the end of the document? */
                     0 == (MAN_VALID & n->flags) &&  
                     MAN_EXPLICIT & man_macros[n->tok].flags)                  if (to == NULL && ! (n->flags & MAN_VALID)) {
                         mandoc_msg(MANDOCERR_BLK_NOEND,                          if (man->flags & (MAN_BLINE | MAN_ELINE) &&
                             man->parse, n->line, n->pos,                              man_macros[n->tok].flags & MAN_SCOPED) {
                             man_macronames[n->tok]);                                  mandoc_vmsg(MANDOCERR_BLK_LINE,
                                       man->parse, n->line, n->pos,
                                       "EOF breaks %s",
                                       man_macronames[n->tok]);
                                   if (man->flags & MAN_ELINE)
                                           man->flags &= ~MAN_ELINE;
                                   else {
                                           assert(n->type == MAN_HEAD);
                                           n = n->parent;
                                           man->flags &= ~MAN_BLINE;
                                   }
                                   man->last = n;
                                   n = n->parent;
                                   man_node_delete(man, man->last);
                                   continue;
                           }
                           if (n->type == MAN_BLOCK &&
                               man_macros[n->tok].flags & MAN_EXPLICIT)
                                   mandoc_msg(MANDOCERR_BLK_NOEND,
                                       man->parse, n->line, n->pos,
                                       man_macronames[n->tok]);
                   }
   
                 /*                  /*
                  * We might delete the man->last node                   * We might delete the man->last node
                  * in the post-validation phase.                   * in the post-validation phase.
                  * Save a pointer to the parent such that                   * Save a pointer to the parent such that
                  * we know where to continue the iteration.                   * we know where to continue the iteration.
                  */                   */
   
                 man->last = n;                  man->last = n;
                 n = n->parent;                  n = n->parent;
                 if ( ! man_valid_post(man))                  man_valid_post(man);
                         return(0);  
         }          }
         return(1);  
           /*
            * If we ended up at the parent of the node we were
            * supposed to rewind to, that means the target node
            * got deleted, so add the next node we parse as a child
            * of the parent instead of as a sibling of the target.
            */
   
           man->next = (man->last == to) ?
               MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 }  }
   
 static enum rew  static enum rew
 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)  rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
 {  {
   
         if (MAN_BLOCK == type && ntok == n->parent->tok &&          if (type == MAN_BLOCK && ntok == n->parent->tok &&
             MAN_BODY == n->parent->type)              n->parent->type == MAN_BODY)
                 return(REW_REWIND);                  return(REW_REWIND);
         return(ntok == n->tok ? REW_HALT : REW_NOHALT);          return(ntok == n->tok ? REW_HALT : REW_NOHALT);
 }  }
Line 213  rew_dohalt(enum mant tok, enum man_type type, const st
Line 242  rew_dohalt(enum mant tok, enum man_type type, const st
  * for example, the `SH' macro will close out any intervening `SS'   * for example, the `SH' macro will close out any intervening `SS'
  * scopes.  When a scope is closed, it must be validated and actioned.   * scopes.  When a scope is closed, it must be validated and actioned.
  */   */
 static int  static void
 rew_scope(enum man_type type, struct man *man, enum mant tok)  rew_scope(enum man_type type, struct man *man, enum mant tok)
 {  {
         struct man_node *n;          struct man_node *n;
Line 227  rew_scope(enum man_type type, struct man *man, enum ma
Line 256  rew_scope(enum man_type type, struct man *man, enum ma
                  */                   */
                 c = rew_dohalt(tok, type, n);                  c = rew_dohalt(tok, type, n);
                 if (REW_HALT == c)                  if (REW_HALT == c)
                         return(1);                          return;
                 if (REW_REWIND == c)                  if (REW_REWIND == c)
                         break;                          break;
         }          }
Line 236  rew_scope(enum man_type type, struct man *man, enum ma
Line 265  rew_scope(enum man_type type, struct man *man, enum ma
          * Rewind until the current point.  Warn if we're a roff           * Rewind until the current point.  Warn if we're a roff
          * instruction that's mowing over explicit scopes.           * instruction that's mowing over explicit scopes.
          */           */
         assert(n);  
   
         return(man_unscope(man, n));          man_unscope(man, n);
 }  }
   
   
 /*  /*
  * Close out a generic explicit macro.   * Close out a generic explicit macro.
  */   */
 int  void
 blk_close(MACRO_PROT_ARGS)  blk_close(MACRO_PROT_ARGS)
 {  {
         enum mant                ntok;          enum mant                ntok;
         const struct man_node   *nn;          const struct man_node   *nn;
           char                    *p;
           int                      nrew, target;
   
           nrew = 1;
         switch (tok) {          switch (tok) {
         case MAN_RE:          case MAN_RE:
                 ntok = MAN_RS;                  ntok = MAN_RS;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   for (nn = man->last->parent; nn; nn = nn->parent)
                           if (nn->tok == ntok && nn->type == MAN_BLOCK)
                                   nrew++;
                   target = strtol(p, &p, 10);
                   if (*p != '\0')
                           mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                               line, p - buf, "RE ... %s", p);
                   if (target == 0)
                           target = 1;
                   nrew -= target;
                   if (nrew < 1) {
                           mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
                               line, ppos, "RE %d", target);
                           return;
                   }
                 break;                  break;
         case MAN_UE:          case MAN_UE:
                 ntok = MAN_UR;                  ntok = MAN_UR;
Line 264  blk_close(MACRO_PROT_ARGS)
Line 312  blk_close(MACRO_PROT_ARGS)
         }          }
   
         for (nn = man->last->parent; nn; nn = nn->parent)          for (nn = man->last->parent; nn; nn = nn->parent)
                 if (ntok == nn->tok && MAN_BLOCK == nn->type)                  if (nn->tok == ntok && nn->type == MAN_BLOCK && ! --nrew)
                         break;                          break;
   
         if (NULL == nn) {          if (nn == NULL) {
                 mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,                  mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
                     line, ppos, man_macronames[tok]);                      line, ppos, man_macronames[tok]);
                 if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))                  rew_scope(MAN_BLOCK, man, MAN_PP);
                         return(0);          } else {
         } else                  line = man->last->line;
                   ppos = man->last->pos;
                   ntok = man->last->tok;
                 man_unscope(man, nn);                  man_unscope(man, nn);
   
         return(1);                  /* Move a trailing paragraph behind the block. */
   
                   if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
                           *pos = strlen(buf);
                           blk_imp(man, ntok, line, ppos, pos, buf);
                   }
           }
 }  }
   
 int  void
 blk_exp(MACRO_PROT_ARGS)  blk_exp(MACRO_PROT_ARGS)
 {  {
         struct man_node *n;          struct man_node *n;
         int              la;          int              la;
         char            *p;          char            *p;
   
         /* Close out prior implicit scopes. */          rew_scope(MAN_BLOCK, man, tok);
           man_block_alloc(man, line, ppos, tok);
           man_head_alloc(man, line, ppos, tok);
   
         if ( ! rew_scope(MAN_BLOCK, man, tok))  
                 return(0);  
   
         if ( ! man_block_alloc(man, line, ppos, tok))  
                 return(0);  
         if ( ! man_head_alloc(man, line, ppos, tok))  
                 return(0);  
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 if ( ! man_args(man, line, pos, buf, &p))                  if ( ! man_args(man, line, pos, buf, &p))
                         break;                          break;
                 if ( ! man_word_alloc(man, line, la, p))                  man_word_alloc(man, line, la, p);
                         return(0);  
         }          }
   
         assert(man);          assert(man);
         assert(tok != MAN_MAX);          assert(tok != MAN_MAX);
   
         for (n = man->last; n; n = n->parent) {          for (n = man->last; n; n = n->parent)
                 if (n->tok != tok)                  if (n->tok == tok) {
                         continue;                          assert(n->type == MAN_HEAD);
                 assert(MAN_HEAD == n->type);                          man_unscope(man, n);
                 man_unscope(man, n);                          break;
                 break;                  }
         }  
   
         return(man_body_alloc(man, line, ppos, tok));          man_body_alloc(man, line, ppos, tok);
 }  }
   
 /*  /*
Line 323  blk_exp(MACRO_PROT_ARGS)
Line 371  blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew   * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.   * routines.
  */   */
 int  void
 blk_imp(MACRO_PROT_ARGS)  blk_imp(MACRO_PROT_ARGS)
 {  {
         int              la;          int              la;
         char            *p;          char            *p;
         struct man_node *n;          struct man_node *n;
   
         /* Close out prior scopes. */          rew_scope(MAN_BODY, man, tok);
           rew_scope(MAN_BLOCK, man, tok);
         if ( ! rew_scope(MAN_BODY, man, tok))          man_block_alloc(man, line, ppos, tok);
                 return(0);          man_head_alloc(man, line, ppos, tok);
         if ( ! rew_scope(MAN_BLOCK, man, tok))  
                 return(0);  
   
         /* Allocate new block & head scope. */  
   
         if ( ! man_block_alloc(man, line, ppos, tok))  
                 return(0);  
         if ( ! man_head_alloc(man, line, ppos, tok))  
                 return(0);  
   
         n = man->last;          n = man->last;
   
         /* Add line arguments. */          /* Add line arguments. */
Line 352  blk_imp(MACRO_PROT_ARGS)
Line 390  blk_imp(MACRO_PROT_ARGS)
                 la = *pos;                  la = *pos;
                 if ( ! man_args(man, line, pos, buf, &p))                  if ( ! man_args(man, line, pos, buf, &p))
                         break;                          break;
                 if ( ! man_word_alloc(man, line, la, p))                  man_word_alloc(man, line, la, p);
                         return(0);  
         }          }
   
         /* Close out head and open body (unless MAN_SCOPE). */          /* Close out head and open body (unless MAN_SCOPE). */
   
         if (MAN_SCOPED & man_macros[tok].flags) {          if (man_macros[tok].flags & MAN_SCOPED) {
                 /* If we're forcing scope (`TP'), keep it open. */                  /* If we're forcing scope (`TP'), keep it open. */
                 if (MAN_FSCOPED & man_macros[tok].flags) {                  if (man_macros[tok].flags & MAN_FSCOPED) {
                         man->flags |= MAN_BLINE;                          man->flags |= MAN_BLINE;
                         return(1);                          return;
                 } else if (n == man->last) {                  } else if (n == man->last) {
                         man->flags |= MAN_BLINE;                          man->flags |= MAN_BLINE;
                         return(1);                          return;
                 }                  }
         }          }
           rew_scope(MAN_HEAD, man, tok);
         if ( ! rew_scope(MAN_HEAD, man, tok))          man_body_alloc(man, line, ppos, tok);
                 return(0);  
         return(man_body_alloc(man, line, ppos, tok));  
 }  }
   
 int  void
 in_line_eoln(MACRO_PROT_ARGS)  in_line_eoln(MACRO_PROT_ARGS)
 {  {
         int              la;          int              la;
         char            *p;          char            *p;
         struct man_node *n;          struct man_node *n;
   
         if ( ! man_elem_alloc(man, line, ppos, tok))          man_elem_alloc(man, line, ppos, tok);
                 return(0);  
   
         n = man->last;          n = man->last;
   
         for (;;) {          for (;;) {
                   if (buf[*pos] != '\0' && (tok == MAN_br ||
                       tok == MAN_fi || tok == MAN_nf)) {
                           mandoc_vmsg(MANDOCERR_ARG_SKIP,
                               man->parse, line, *pos, "%s %s",
                               man_macronames[tok], buf + *pos);
                           break;
                   }
                   if (buf[*pos] != '\0' && man->last != n &&
                       (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
                           mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                               man->parse, line, *pos, "%s ... %s",
                               man_macronames[tok], buf + *pos);
                           break;
                   }
                 la = *pos;                  la = *pos;
                 if ( ! man_args(man, line, pos, buf, &p))                  if ( ! man_args(man, line, pos, buf, &p))
                         break;                          break;
                 if ( ! man_word_alloc(man, line, la, p))                  if (man_macros[tok].flags & MAN_JOIN &&
                         return(0);                      man->last->type == MAN_TEXT)
                           man_word_append(man, p);
                   else
                           man_word_alloc(man, line, la, p);
         }          }
   
         /*          /*
Line 409  in_line_eoln(MACRO_PROT_ARGS)
Line 459  in_line_eoln(MACRO_PROT_ARGS)
          * waiting for terms to load into our context.           * waiting for terms to load into our context.
          */           */
   
         if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {          if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
                 assert( ! (MAN_NSCOPED & man_macros[tok].flags));                  assert( ! (man_macros[tok].flags & MAN_NSCOPED));
                 man->flags |= MAN_ELINE;                  man->flags |= MAN_ELINE;
                 return(1);                  return;
         }          }
   
         /* Set ignorable context, if applicable. */          assert(man->last->type != MAN_ROOT);
   
         if (MAN_NSCOPED & man_macros[tok].flags) {  
                 assert( ! (MAN_SCOPED & man_macros[tok].flags));  
                 man->flags |= MAN_ILINE;  
         }  
   
         assert(MAN_ROOT != man->last->type);  
         man->next = MAN_NEXT_SIBLING;          man->next = MAN_NEXT_SIBLING;
   
         /*          /*
Line 436  in_line_eoln(MACRO_PROT_ARGS)
Line 479  in_line_eoln(MACRO_PROT_ARGS)
                         break;                          break;
                 if (man->last->type == MAN_ROOT)                  if (man->last->type == MAN_ROOT)
                         break;                          break;
                 if ( ! man_valid_post(man))                  man_valid_post(man);
                         return(0);  
         }          }
   
         assert(man->last);          assert(man->last);
Line 446  in_line_eoln(MACRO_PROT_ARGS)
Line 488  in_line_eoln(MACRO_PROT_ARGS)
          * Same here regarding whether we're back at the root.           * Same here regarding whether we're back at the root.
          */           */
   
         if (man->last->type != MAN_ROOT && ! man_valid_post(man))          if (man->last->type != MAN_ROOT)
                 return(0);                  man_valid_post(man);
   
         return(1);  
 }  }
   
   
 int  void
 man_macroend(struct man *man)  man_macroend(struct man *man)
 {  {
   
         return(man_unscope(man, man->first));          man_unscope(man, man->first);
 }  }
   
 static int  static int
Legend:
Removed from v.1.85  
changed lines
  Added in v.1.97
CVSweb