[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.32 and 1.39

version 1.32, 2010/03/23 11:30:48 version 1.39, 2010/03/27 10:13:16
Line 25 
Line 25 
   
 #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_imp(MACRO_PROT_ARGS);  
 static  int              blk_close(MACRO_PROT_ARGS);  static  int              blk_close(MACRO_PROT_ARGS);
   static  int              blk_dotted(MACRO_PROT_ARGS);
   static  int              blk_exp(MACRO_PROT_ARGS);
   static  int              blk_imp(MACRO_PROT_ARGS);
   static  int              in_line_eoln(MACRO_PROT_ARGS);
   
 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  int              rew_block(int, enum man_type,  static  enum rew         rew_block(enum mant, enum man_type,
                                 const struct man_node *);                                  const struct man_node *);
   static  int              rew_warn(struct man *,
                                   struct man_node *, enum merr);
   
 const   struct man_macro __man_macros[MAN_MAX] = {  const   struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, MAN_NSCOPED }, /* br */          { in_line_eoln, MAN_NSCOPED }, /* br */
Line 68  const struct man_macro __man_macros[MAN_MAX] = {
Line 75  const struct man_macro __man_macros[MAN_MAX] = {
         { in_line_eoln, 0 }, /* fi */          { in_line_eoln, 0 }, /* fi */
         { in_line_eoln, 0 }, /* r */          { in_line_eoln, 0 }, /* r */
         { blk_close, 0 }, /* RE */          { blk_close, 0 }, /* RE */
         { blk_imp, MAN_EXPLICIT }, /* RS */          { blk_exp, MAN_EXPLICIT }, /* RS */
         { in_line_eoln, 0 }, /* DT */          { in_line_eoln, 0 }, /* DT */
         { in_line_eoln, 0 }, /* UC */          { in_line_eoln, 0 }, /* UC */
         { in_line_eoln, 0 }, /* PD */          { in_line_eoln, 0 }, /* PD */
         { in_line_eoln, MAN_NSCOPED }, /* Sp */          { in_line_eoln, MAN_NSCOPED }, /* Sp */
         { in_line_eoln, 0 }, /* Vb */          { in_line_eoln, 0 }, /* Vb */
         { in_line_eoln, 0 }, /* Ve */          { in_line_eoln, 0 }, /* Ve */
           { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
           { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
           { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
           { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
           { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
           { blk_dotted, 0 }, /* . */
 };  };
   
 const   struct man_macro * const man_macros = __man_macros;  const   struct man_macro * const man_macros = __man_macros;
   
   
   /*
    * Warn when "n" is an explicit non-roff macro.
    */
   static int
   rew_warn(struct man *m, struct man_node *n, enum merr er)
   {
   
           if (er == WERRMAX || MAN_BLOCK != n->type)
                   return(1);
           if (MAN_VALID & n->flags)
                   return(1);
           if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
                   return(1);
           if (MAN_NOCLOSE & man_macros[n->tok].flags)
                   return(1);
           return(man_nwarn(m, n, er));
   }
   
   
   /*
    * Rewind scope.  If a code "er" != WERRMAX has been provided, it will
    * be used if an explicit block scope is being closed out.
    */
 int  int
 man_unscope(struct man *m, const struct man_node *n)  man_unscope(struct man *m, const struct man_node *n, enum merr er)
 {  {
   
         assert(n);          assert(n);
         m->next = MAN_NEXT_SIBLING;  
   
         /* LINTED */          /* LINTED */
         while (m->last != n) {          while (m->last != n) {
                   if ( ! rew_warn(m, m->last, er))
                           return(0);
                 if ( ! man_valid_post(m))                  if ( ! man_valid_post(m))
                         return(0);                          return(0);
                 if ( ! man_action_post(m))                  if ( ! man_action_post(m))
Line 97  man_unscope(struct man *m, const struct man_node *n)
Line 134  man_unscope(struct man *m, const struct man_node *n)
                 assert(m->last);                  assert(m->last);
         }          }
   
           if ( ! rew_warn(m, m->last, er))
                   return(0);
         if ( ! man_valid_post(m))          if ( ! man_valid_post(m))
                 return(0);                  return(0);
         return(man_action_post(m));          if ( ! man_action_post(m))
                   return(0);
   
           m->next = MAN_ROOT == m->last->type ?
                   MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
   
           return(1);
 }  }
   
   
 static int  static enum rew
 rew_block(int 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 (MAN_BLOCK == type && ntok == n->parent->tok &&
Line 119  rew_block(int ntok, enum man_type type, const struct m
Line 164  rew_block(int ntok, enum man_type type, const struct m
  * 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)
 {  {
         int              c;          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);
   
         /* Rewind to ourselves, first. */          /* First: rewind to ourselves. */
         if (type == n->type && tok == n->tok)          if (type == n->type && tok == n->tok)
                 return(REW_REWIND);                  return(REW_REWIND);
   
           /*
            * If we're a roff macro, then we can close out anything that
            * stands between us and our parent context.
            */
           if (MAN_NOCLOSE & man_macros[tok].flags)
                   return(REW_NOHALT);
   
           /*
            * Don't clobber roff macros: this is a bit complicated.  If the
            * current macro is a roff macro, halt immediately and don't
            * rewind.  If it's not, and the parent is, then close out the
            * current scope and halt at the parent.
            */
           if (MAN_NOCLOSE & man_macros[n->tok].flags)
                   return(REW_HALT);
           if (MAN_NOCLOSE & man_macros[n->parent->tok].flags)
                   return(REW_REWIND);
   
           /*
            * Next follow the implicit scope-smashings as defined by man.7:
            * section, sub-section, etc.
            */
   
         switch (tok) {          switch (tok) {
         case (MAN_SH):          case (MAN_SH):
                 break;                  break;
Line 175  rew_dohalt(int tok, enum man_type type, const struct m
Line 249  rew_dohalt(int tok, enum man_type type, const struct m
  * 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 *m, enum mant tok)
 {  {
         struct man_node *n;          struct man_node *n;
         int              c;          enum rew         c;
   
         /* LINTED */          /* LINTED */
         for (n = m->last; n; n = n->parent) {          for (n = m->last; n; n = n->parent) {
Line 194  rew_scope(enum man_type type, struct man *m, int tok)
Line 268  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));          if (MAN_NOCLOSE & man_macros[tok].flags)
                   return(man_unscope(m, n, WROFFSCOPE));
   
           return(man_unscope(m, n, WERRMAX));
 }  }
   
   
   /*
    * Closure for dotted macros (de, dei, am, ami, ign).  This must handle
    * any of these as the parent node, so it needs special handling.
    * Beyond this, it's the same as blk_close().
    */
 /* ARGSUSED */  /* ARGSUSED */
 int  int
   blk_dotted(MACRO_PROT_ARGS)
   {
           enum mant        ntok;
           struct man_node *nn;
   
           /* Check for any of the following parents... */
   
           for (nn = m->last->parent; nn; nn = nn->parent)
                   if (nn->tok == MAN_de || nn->tok == MAN_dei ||
                                   nn->tok == MAN_am ||
                                   nn->tok == MAN_ami ||
                                   nn->tok == MAN_ig) {
                           ntok = nn->tok;
                           break;
                   }
   
           if (NULL == nn) {
                   if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
                           return(0);
                   return(1);
           }
   
           if ( ! rew_scope(MAN_BODY, m, ntok))
                   return(0);
           if ( ! rew_scope(MAN_BLOCK, m, ntok))
                   return(0);
   
           /*
            * XXX: manually adjust our next-line status.  roff macros are,
            * for the moment, ignored, so we don't want to close out bodies
            * and so on.
            */
   
           switch (m->last->type) {
           case (MAN_BODY):
                   m->next = MAN_NEXT_CHILD;
                   break;
           default:
                   break;
           }
   
           return(1);
   }
   
   
   /*
    * Close out a generic explicit macro.
    */
   /* ARGSUSED */
   int
 blk_close(MACRO_PROT_ARGS)  blk_close(MACRO_PROT_ARGS)
 {  {
         int                      ntok;          enum mant                ntok;
         const struct man_node   *nn;          const struct man_node   *nn;
   
         switch (tok) {          switch (tok) {
Line 229  blk_close(MACRO_PROT_ARGS)
Line 363  blk_close(MACRO_PROT_ARGS)
                 return(0);                  return(0);
         if ( ! rew_scope(MAN_BLOCK, m, ntok))          if ( ! rew_scope(MAN_BLOCK, m, ntok))
                 return(0);                  return(0);
         m->next = MAN_NEXT_SIBLING;  
         return(1);          return(1);
 }  }
   
   
   int
   blk_exp(MACRO_PROT_ARGS)
   {
           int              w, la;
           char            *p;
   
           /*
            * Close out prior scopes.  "Regular" explicit macros cannot be
            * nested, but we allow roff macros to be placed just about
            * anywhere.
            */
   
           if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
                   if ( ! rew_scope(MAN_BODY, m, tok))
                           return(0);
                   if ( ! rew_scope(MAN_BLOCK, m, tok))
                           return(0);
           }
   
           if ( ! man_block_alloc(m, line, ppos, tok))
                   return(0);
           if ( ! man_head_alloc(m, line, ppos, tok))
                   return(0);
   
           for (;;) {
                   la = *pos;
                   w = man_args(m, line, pos, buf, &p);
   
                   if (-1 == w)
                           return(0);
                   if (0 == w)
                           break;
   
                   if ( ! man_word_alloc(m, line, la, p))
                           return(0);
           }
   
           assert(m);
           assert(tok != MAN_MAX);
   
           if ( ! rew_scope(MAN_HEAD, m, tok))
                   return(0);
           return(man_body_alloc(m, 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
Line 293  blk_imp(MACRO_PROT_ARGS)
Line 474  blk_imp(MACRO_PROT_ARGS)
   
         if ( ! rew_scope(MAN_HEAD, m, tok))          if ( ! rew_scope(MAN_HEAD, m, tok))
                 return(0);                  return(0);
   
         return(man_body_alloc(m, line, ppos, tok));          return(man_body_alloc(m, line, ppos, tok));
 }  }
   
Line 318  in_line_eoln(MACRO_PROT_ARGS)
Line 498  in_line_eoln(MACRO_PROT_ARGS)
                         return(0);                          return(0);
                 if (0 == w)                  if (0 == w)
                         break;                          break;
   
                 /* XXX ignore Vb arguments for now */  
                 if (MAN_Vb == tok)  
                         continue;  
   
                 if ( ! man_word_alloc(m, line, la, p))                  if ( ! man_word_alloc(m, line, la, p))
                         return(0);                          return(0);
         }          }
Line 373  in_line_eoln(MACRO_PROT_ARGS)
Line 548  in_line_eoln(MACRO_PROT_ARGS)
                 return(0);                  return(0);
         if (m->last->type != MAN_ROOT && ! man_action_post(m))          if (m->last->type != MAN_ROOT && ! man_action_post(m))
                 return(0);                  return(0);
         if (m->last->type != MAN_ROOT)  
                 m->next = MAN_NEXT_SIBLING;  
   
           m->next = MAN_ROOT == m->last->type ?
                   MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
   
         return(1);          return(1);
 }  }
   
Line 383  in_line_eoln(MACRO_PROT_ARGS)
Line 559  in_line_eoln(MACRO_PROT_ARGS)
 int  int
 man_macroend(struct man *m)  man_macroend(struct man *m)
 {  {
         struct man_node *n;  
   
         n = MAN_VALID & m->last->flags ?          return(man_unscope(m, m->first, WEXITSCOPE));
                 m->last->parent : m->last;  
   
         for ( ; n; n = n->parent) {  
                 if (MAN_BLOCK != n->type)  
                         continue;  
                 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))  
                         continue;  
                 if ( ! man_nwarn(m, n, WEXITSCOPE))  
                         return(0);  
         }  
   
         return(man_unscope(m, m->first));  
 }  }
   
Legend:
Removed from v.1.32  
changed lines
  Added in v.1.39
CVSweb