[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.19 and 1.85

version 1.19, 2009/08/13 11:45:29 version 1.85, 2014/07/09 11:28:26
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
    * 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
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 14 
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"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   
   #include "man.h"
   #include "mandoc.h"
   #include "libmandoc.h"
 #include "libman.h"  #include "libman.h"
   
 #define REW_REWIND      (0)             /* See rew_scope(). */  enum    rew {
 #define REW_NOHALT      (1)             /* See rew_scope(). */          REW_REWIND,
 #define REW_HALT        (2)             /* See rew_scope(). */          REW_NOHALT,
           REW_HALT
   };
   
 static  int              in_line_eoln(MACRO_PROT_ARGS);  static  int              blk_close(MACRO_PROT_ARGS);
   static  int              blk_exp(MACRO_PROT_ARGS);
 static  int              blk_imp(MACRO_PROT_ARGS);  static  int              blk_imp(MACRO_PROT_ARGS);
   static  int              in_line_eoln(MACRO_PROT_ARGS);
   static  int              man_args(struct man *, int,
                                   int *, char *, char **);
   
 static  int              rew_scope(enum man_type, struct man *, int);  static  int              rew_scope(enum man_type,
 static  int              rew_dohalt(int, enum man_type,                                  struct man *, enum mant);
   static  enum rew         rew_dohalt(enum mant, enum man_type,
                                 const struct man_node *);                                  const struct man_node *);
   static  enum rew         rew_block(enum mant, enum man_type,
                                   const struct man_node *);
   
 const   struct man_macro __man_macros[MAN_MAX] = {  const   struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, 0 }, /* br */          { in_line_eoln, MAN_NSCOPED }, /* br */
         { in_line_eoln, 0 }, /* TH */          { in_line_eoln, MAN_BSCOPE }, /* TH */
         { blk_imp, 0 }, /* SH */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
         { blk_imp, 0 }, /* SS */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
         { blk_imp, MAN_SCOPED }, /* TP */          { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
         { blk_imp, 0 }, /* LP */          { blk_imp, MAN_BSCOPE }, /* LP */
         { blk_imp, 0 }, /* PP */          { blk_imp, MAN_BSCOPE }, /* PP */
         { blk_imp, 0 }, /* P */          { blk_imp, MAN_BSCOPE }, /* P */
         { blk_imp, 0 }, /* IP */          { blk_imp, MAN_BSCOPE }, /* IP */
         { blk_imp, 0 }, /* HP */          { blk_imp, MAN_BSCOPE }, /* HP */
         { in_line_eoln, MAN_SCOPED }, /* SM */          { in_line_eoln, MAN_SCOPED }, /* SM */
         { in_line_eoln, MAN_SCOPED }, /* SB */          { in_line_eoln, MAN_SCOPED }, /* SB */
         { in_line_eoln, 0 }, /* BI */          { in_line_eoln, 0 }, /* BI */
Line 54  const struct man_macro __man_macros[MAN_MAX] = {
Line 72  const struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, MAN_SCOPED }, /* I */          { in_line_eoln, MAN_SCOPED }, /* I */
         { in_line_eoln, 0 }, /* IR */          { in_line_eoln, 0 }, /* IR */
         { in_line_eoln, 0 }, /* RI */          { in_line_eoln, 0 }, /* RI */
         { in_line_eoln, 0 }, /* na */          { in_line_eoln, MAN_NSCOPED }, /* na */
         { in_line_eoln, 0 }, /* i */          { in_line_eoln, MAN_NSCOPED }, /* sp */
         { in_line_eoln, 0 }, /* sp */          { in_line_eoln, MAN_BSCOPE }, /* nf */
         { in_line_eoln, 0 }, /* nf */          { in_line_eoln, MAN_BSCOPE }, /* fi */
         { in_line_eoln, 0 }, /* fi */          { blk_close, 0 }, /* RE */
         { in_line_eoln, 0 }, /* r */          { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
           { in_line_eoln, 0 }, /* DT */
           { in_line_eoln, 0 }, /* UC */
           { in_line_eoln, 0 }, /* PD */
           { in_line_eoln, 0 }, /* AT */
           { in_line_eoln, 0 }, /* in */
           { in_line_eoln, 0 }, /* ft */
           { in_line_eoln, 0 }, /* OP */
           { in_line_eoln, MAN_BSCOPE }, /* EX */
           { in_line_eoln, MAN_BSCOPE }, /* EE */
           { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
           { blk_close, 0 }, /* UE */
           { in_line_eoln, 0 }, /* ll */
 };  };
   
 const   struct man_macro * const man_macros = __man_macros;  const   struct man_macro * const man_macros = __man_macros;
   
   
 int  int
 man_unscope(struct man *m, const struct man_node *n)  man_unscope(struct man *man, const struct man_node *to)
 {  {
           struct man_node *n;
   
         assert(n);          man->next = MAN_NEXT_SIBLING;
         m->next = MAN_NEXT_SIBLING;          to = to->parent;
           n = man->last;
         /* LINTED */          while (n != to) {
         while (m->last != n) {                  if (NULL == to &&
                 if ( ! man_valid_post(m))                      MAN_BLOCK == n->type &&
                       0 == (MAN_VALID & n->flags) &&
                       MAN_EXPLICIT & man_macros[n->tok].flags)
                           mandoc_msg(MANDOCERR_BLK_NOEND,
                               man->parse, n->line, n->pos,
                               man_macronames[n->tok]);
                   /*
                    * We might delete the man->last node
                    * in the post-validation phase.
                    * Save a pointer to the parent such that
                    * we know where to continue the iteration.
                    */
                   man->last = n;
                   n = n->parent;
                   if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_action_post(m))  
                         return(0);  
                 m->last = m->last->parent;  
                 assert(m->last);  
         }          }
           return(1);
         if ( ! man_valid_post(m))  
                 return(0);  
         return(man_action_post(m));  
 }  }
   
   static enum rew
   rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
   {
   
           if (MAN_BLOCK == type && ntok == n->parent->tok &&
               MAN_BODY == n->parent->type)
                   return(REW_REWIND);
           return(ntok == n->tok ? REW_HALT : REW_NOHALT);
   }
   
 /*  /*
  * There are three scope levels: scoped to the root (all), scoped to the   * There are three scope levels: scoped to the root (all), scoped to the
  * section (all less sections), and scoped to subsections (all less   * section (all less sections), and scoped to subsections (all less
  * sections and subsections).   * sections and subsections).
  */   */
 static int  static enum rew
 rew_dohalt(int tok, enum man_type type, const struct man_node *n)  rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
 {  {
           enum rew         c;
   
           /* We cannot progress beyond the root ever. */
         if (MAN_ROOT == n->type)          if (MAN_ROOT == n->type)
                 return(REW_HALT);                  return(REW_HALT);
   
         assert(n->parent);          assert(n->parent);
   
           /* Normal nodes shouldn't go to the level of the root. */
         if (MAN_ROOT == n->parent->type)          if (MAN_ROOT == n->parent->type)
                 return(REW_REWIND);                  return(REW_REWIND);
   
           /* Already-validated nodes should be closed out. */
         if (MAN_VALID & n->flags)          if (MAN_VALID & n->flags)
                 return(REW_NOHALT);                  return(REW_NOHALT);
   
         switch (tok) {          /* First: rewind to ourselves. */
         case (MAN_SH):          if (type == n->type && tok == n->tok) {
                 /* Break at root. */                  if (MAN_EXPLICIT & man_macros[n->tok].flags)
                 if (type == n->type && tok == n->tok)                          return(REW_HALT);
                   else
                         return(REW_REWIND);                          return(REW_REWIND);
           }
   
           /*
            * Next follow the implicit scope-smashings as defined by man.7:
            * section, sub-section, etc.
            */
   
           switch (tok) {
           case MAN_SH:
                 break;                  break;
         case (MAN_SS):          case MAN_SS:
                 /* Break at section. */                  /* Rewind to a section, if a block. */
                 if (type == n->type && tok == n->tok)                  if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                         return(REW_REWIND);                          return(c);
                 if (MAN_BODY == n->type && MAN_SH == n->tok)                  break;
           case MAN_RS:
                   /* Preserve empty paragraphs before RS. */
                   if (0 == n->nchild && (MAN_P == n->tok ||
                       MAN_PP == n->tok || MAN_LP == n->tok))
                         return(REW_HALT);                          return(REW_HALT);
                   /* Rewind to a subsection, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                           return(c);
                   /* Rewind to a section, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                           return(c);
                 break;                  break;
         default:          default:
                 /* Break at subsection. */                  /* Rewind to an offsetter, if a block. */
                 if (type == n->type && tok == n->tok)                  if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
                         return(REW_REWIND);                          return(c);
                 if (MAN_BODY == n->type && MAN_SS == n->tok)                  /* Rewind to a subsection, if a block. */
                         return(REW_HALT);                  if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                 if (MAN_BODY == n->type && MAN_SH == n->tok)                          return(c);
                         return(REW_HALT);                  /* Rewind to a section, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                           return(c);
                 break;                  break;
         }          }
   
         return(REW_NOHALT);          return(REW_NOHALT);
 }  }
   
   
 /*  /*
  * Rewinding entails ascending the parse tree until a coherent point,   * Rewinding entails ascending the parse tree until a coherent point,
  * 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 int
 rew_scope(enum man_type type, struct man *m, int tok)  rew_scope(enum man_type type, struct man *man, enum mant tok)
 {  {
         struct man_node *n;          struct man_node *n;
         int              c;          enum rew         c;
   
         /* LINTED */          for (n = man->last; n; n = n->parent) {
         for (n = m->last; n; n = n->parent) {                  /*
                 /*  
                  * Whether we should stop immediately (REW_HALT), stop                   * Whether we should stop immediately (REW_HALT), stop
                  * and rewind until this point (REW_REWIND), or keep                   * and rewind until this point (REW_REWIND), or keep
                  * rewinding (REW_NOHALT).                   * rewinding (REW_NOHALT).
Line 158  rew_scope(enum man_type type, struct man *m, int tok)
Line 232  rew_scope(enum man_type type, struct man *m, int tok)
                         break;                          break;
         }          }
   
         /* Rewind until the current point. */          /*
            * Rewind until the current point.  Warn if we're a roff
            * instruction that's mowing over explicit scopes.
            */
         assert(n);          assert(n);
         return(man_unscope(m, n));  
           return(man_unscope(man, n));
 }  }
   
   
 /*  /*
    * Close out a generic explicit macro.
    */
   int
   blk_close(MACRO_PROT_ARGS)
   {
           enum mant                ntok;
           const struct man_node   *nn;
   
           switch (tok) {
           case MAN_RE:
                   ntok = MAN_RS;
                   break;
           case MAN_UE:
                   ntok = MAN_UR;
                   break;
           default:
                   abort();
                   /* NOTREACHED */
           }
   
           for (nn = man->last->parent; nn; nn = nn->parent)
                   if (ntok == nn->tok && MAN_BLOCK == nn->type)
                           break;
   
           if (NULL == nn) {
                   mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
                       line, ppos, man_macronames[tok]);
                   if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
                           return(0);
           } else
                   man_unscope(man, nn);
   
           return(1);
   }
   
   int
   blk_exp(MACRO_PROT_ARGS)
   {
           struct man_node *n;
           int              la;
           char            *p;
   
           /* Close out prior implicit scopes. */
   
           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 (;;) {
                   la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   if ( ! man_word_alloc(man, line, la, p))
                           return(0);
           }
   
           assert(man);
           assert(tok != MAN_MAX);
   
           for (n = man->last; n; n = n->parent) {
                   if (n->tok != tok)
                           continue;
                   assert(MAN_HEAD == n->type);
                   man_unscope(man, n);
                   break;
           }
   
           return(man_body_alloc(man, line, ppos, tok));
   }
   
   /*
  * Parse an implicit-block macro.  These contain a MAN_HEAD and a   * Parse an implicit-block macro.  These contain a MAN_HEAD and a
  * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other   * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
  * 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
Line 174  rew_scope(enum man_type type, struct man *m, int tok)
Line 326  rew_scope(enum man_type type, struct man *m, int tok)
 int  int
 blk_imp(MACRO_PROT_ARGS)  blk_imp(MACRO_PROT_ARGS)
 {  {
         int              w, la;          int              la;
         char            *p;          char            *p;
           struct man_node *n;
   
         /* Close out prior scopes. */          /* Close out prior scopes. */
   
         if ( ! rew_scope(MAN_BODY, m, tok))          if ( ! rew_scope(MAN_BODY, man, tok))
                 return(0);                  return(0);
         if ( ! rew_scope(MAN_BLOCK, m, tok))          if ( ! rew_scope(MAN_BLOCK, man, tok))
                 return(0);                  return(0);
   
         /* Allocate new block & head scope. */          /* Allocate new block & head scope. */
   
         if ( ! man_block_alloc(m, line, ppos, tok))          if ( ! man_block_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
         if ( ! man_head_alloc(m, line, ppos, tok))          if ( ! man_head_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
   
           n = man->last;
   
         /* Add line arguments. */          /* Add line arguments. */
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 w = man_args(m, line, pos, buf, &p);                  if ( ! man_args(man, line, pos, buf, &p))
   
                 if (-1 == w)  
                         return(0);  
                 if (0 == w)  
                         break;                          break;
                   if ( ! man_word_alloc(man, line, la, p))
                 if ( ! man_word_alloc(m, line, la, p))  
                         return(0);                          return(0);
                 m->next = MAN_NEXT_SIBLING;  
         }          }
   
         /* 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_SCOPED & man_macros[tok].flags) {
                 m->flags |= MAN_BLINE;                  /* If we're forcing scope (`TP'), keep it open. */
                 return(1);                  if (MAN_FSCOPED & man_macros[tok].flags) {
         } else if ( ! rew_scope(MAN_HEAD, m, tok))                          man->flags |= MAN_BLINE;
                 return(0);                          return(1);
                   } else if (n == man->last) {
                           man->flags |= MAN_BLINE;
                           return(1);
                   }
           }
   
         return(man_body_alloc(m, line, ppos, tok));          if ( ! rew_scope(MAN_HEAD, man, tok))
                   return(0);
           return(man_body_alloc(man, line, ppos, tok));
 }  }
   
   
 int  int
 in_line_eoln(MACRO_PROT_ARGS)  in_line_eoln(MACRO_PROT_ARGS)
 {  {
         int              w, la;          int              la;
         char            *p;          char            *p;
         struct man_node *n;          struct man_node *n;
   
         if ( ! man_elem_alloc(m, line, ppos, tok))          if ( ! man_elem_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
   
         n = m->last;          n = man->last;
         m->next = MAN_NEXT_CHILD;  
   
         for (;;) {          for (;;) {
                 la = *pos;                  la = *pos;
                 w = man_args(m, line, pos, buf, &p);                  if ( ! man_args(man, line, pos, buf, &p))
   
                 if (-1 == w)  
                         return(0);  
                 if (0 == w)  
                         break;                          break;
                   if ( ! man_word_alloc(man, line, la, p))
                 if ( ! man_word_alloc(m, line, la, p))  
                         return(0);                          return(0);
                 m->next = MAN_NEXT_SIBLING;  
         }          }
   
         if (n == m->last && (MAN_SCOPED & man_macros[tok].flags)) {          /*
                 m->flags |= MAN_ELINE;           * Append MAN_EOS in case the last snipped argument
                 return(1);           * ends with a dot, e.g. `.IR syslog (3).'
         }           */
   
           if (n != man->last &&
               mandoc_eos(man->last->string, strlen(man->last->string)))
                   man->last->flags |= MAN_EOS;
   
         /*          /*
          * Note that when TH is pruned, we'll be back at the root, so           * If no arguments are specified and this is MAN_SCOPED (i.e.,
          * make sure that we don't clobber as its sibling.           * next-line scoped), then set our mode to indicate that we're
            * waiting for terms to load into our context.
          */           */
   
         /* FIXME: clean this to use man_unscope(). */          if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
                   assert( ! (MAN_NSCOPED & man_macros[tok].flags));
                   man->flags |= MAN_ELINE;
                   return(1);
           }
   
         for ( ; m->last; m->last = m->last->parent) {          /* Set ignorable context, if applicable. */
                 if (m->last == n)  
           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;
   
           /*
            * Rewind our element scope.  Note that when TH is pruned, we'll
            * be back at the root, so make sure that we don't clobber as
            * its sibling.
            */
   
           for ( ; man->last; man->last = man->last->parent) {
                   if (man->last == n)
                         break;                          break;
                 if (m->last->type == MAN_ROOT)                  if (man->last->type == MAN_ROOT)
                         break;                          break;
                 if ( ! man_valid_post(m))                  if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if ( ! man_action_post(m))  
                         return(0);  
         }          }
   
         assert(m->last);          assert(man->last);
   
         /*          /*
          * Same here regarding whether we're back at the root.           * Same here regarding whether we're back at the root.
          */           */
   
         if (m->last->type != MAN_ROOT && ! man_valid_post(m))          if (man->last->type != MAN_ROOT && ! man_valid_post(man))
                 return(0);                  return(0);
         if (m->last->type != MAN_ROOT && ! man_action_post(m))  
                 return(0);  
         if (m->last->type != MAN_ROOT)  
                 m->next = MAN_NEXT_SIBLING;  
   
         return(1);          return(1);
 }  }
   
   
 int  int
 man_macroend(struct man *m)  man_macroend(struct man *man)
 {  {
   
         return(man_unscope(m, m->first));          return(man_unscope(man, man->first));
 }  }
   
   static int
   man_args(struct man *man, int line, int *pos, char *buf, char **v)
   {
           char     *start;
   
           assert(*pos);
           *v = start = buf + *pos;
           assert(' ' != *start);
   
           if ('\0' == *start)
                   return(0);
   
           *v = mandoc_getarg(man->parse, v, line, pos);
           return(1);
   }
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.85
CVSweb