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

Diff for /mandoc/Attic/macro.c between version 1.41 and 1.44

version 1.41, 2009/01/17 20:10:36 version 1.44, 2009/01/20 12:51:28
Line 25 
Line 25 
 #include <time.h>  #include <time.h>
 #endif  #endif
   
   /*
    * This has scanning/parsing routines, each of which extract a macro and
    * its arguments and parameters, then know how to progress to the next
    * macro.  Macros are parsed according as follows:
    *
    *   ELEMENT:     TEXT | epsilon
    *   BLOCK:       HEAD PUNCT BODY PUNCT BLOCK_TAIL PUNCT
    *   BLOCK_TAIL:  TAIL | epsilon
    *   HEAD:        ELEMENT | TEXT | BLOCK | epsilon
    *   BODY:        ELEMENT | TEXT | BLOCK | epsilon
    *   TAIL:        TEXT | epsilon
    *   PUNCT:       TEXT (delimiters) | epsilon
    *
    * These are arranged into a parse tree, an example of which follows:
    *
    *   ROOT
    *       BLOCK (.Sh)
    *           HEAD
    *               TEXT (`NAME')
    *           BODY
    *               ELEMENT (.Nm)
    *                   TEXT (`mdocml')
    *               ELEMENT (.Nd)
    *                   TEXT (`mdoc macro compiler')
    *               BLOCK (.Op)
    *                   HEAD
    *                       ELEMENT (.Fl)
    *                           TEXT (`v')
    *               BLOCK (.Op)
    *                   HEAD
    *                       ELEMENT (.Fl)
    *                           TEXT (`v')
    *                       ELEMENT (.Fl)
    *                           TEXT (`W')
    *                       ELEMENT (.Ns)
    *                       ELEMENT (.Ar)
    *                           TEXT (`err...')
    *
    * These types are always per-line except for block bodies, which may
    * span multiple lines.  Macros are assigned a parsing routine, which
    * corresponds to the type, in the mdoc_macros table.
    *
    * Note that types are general:  there can be several parsing routines
    * corresponding to a single type.  The macro_text function, for
    * example, parses an ELEMENT type (see the function definition for
    * details) that may be interrupted by further macros; the
    * macro_constant function, on the other hand, parses an ELEMENT type
    * spanning a single line.
    */
   
 #include "private.h"  #include "private.h"
   
 /* FIXME: maxlineargs should be per LINE, no per TOKEN. */  
   
 static  int       rewind_alt(int);  
 static  int       rewind_dohalt(int, enum mdoc_type,  
                         const struct mdoc_node *);  
 #define REWIND_REWIND   (1 << 0)  #define REWIND_REWIND   (1 << 0)
 #define REWIND_NOHALT   (1 << 1)  #define REWIND_NOHALT   (1 << 1)
 #define REWIND_HALT     (1 << 2)  #define REWIND_HALT     (1 << 2)
   static  int       rewind_dohalt(int, enum mdoc_type,
                           const struct mdoc_node *);
   static  int       rewind_alt(int);
 static  int       rewind_dobreak(int, const struct mdoc_node *);  static  int       rewind_dobreak(int, const struct mdoc_node *);
   
   
 static  int       rewind_elem(struct mdoc *, int);  static  int       rewind_elem(struct mdoc *, int);
 static  int       rewind_impblock(struct mdoc *, int, int, int);  static  int       rewind_impblock(struct mdoc *, int, int, int);
 static  int       rewind_expblock(struct mdoc *, int, int, int);  static  int       rewind_expblock(struct mdoc *, int, int, int);
Line 70  rewind_last(struct mdoc *mdoc, struct mdoc_node *to)
Line 116  rewind_last(struct mdoc *mdoc, struct mdoc_node *to)
   
         assert(to);          assert(to);
         mdoc->next = MDOC_NEXT_SIBLING;          mdoc->next = MDOC_NEXT_SIBLING;
         if (mdoc->last == to) {  
           while (mdoc->last != to) {
                 if ( ! mdoc_valid_post(mdoc))                  if ( ! mdoc_valid_post(mdoc))
                         return(0);                          return(0);
                 if ( ! mdoc_action_post(mdoc))                  if ( ! mdoc_action_post(mdoc))
                         return(0);                          return(0);
                 return(1);  
         }  
   
         do {  
                 mdoc->last = mdoc->last->parent;                  mdoc->last = mdoc->last->parent;
                 assert(mdoc->last);                  assert(mdoc->last);
                 if ( ! mdoc_valid_post(mdoc))          }
                         return(0);  
                 if ( ! mdoc_action_post(mdoc))  
                         return(0);  
         } while (mdoc->last != to);  
   
         return(1);          if ( ! mdoc_valid_post(mdoc))
                   return(0);
           return(mdoc_action_post(mdoc));
 }  }
   
   
Line 139  rewind_dohalt(int tok, enum mdoc_type type, const stru
Line 180  rewind_dohalt(int tok, enum mdoc_type type, const stru
   
         if (MDOC_ROOT == p->type)          if (MDOC_ROOT == p->type)
                 return(REWIND_HALT);                  return(REWIND_HALT);
         if (MDOC_TEXT == p->type)          if (MDOC_VALID & p->flags)
                 return(REWIND_NOHALT);                  return(REWIND_NOHALT);
         if (MDOC_ELEM == p->type)  
                 return(REWIND_NOHALT);  
   
         switch (tok) {          switch (tok) {
         /* One-liner implicit-scope. */          /* One-liner implicit-scope. */
Line 165  rewind_dohalt(int tok, enum mdoc_type type, const stru
Line 204  rewind_dohalt(int tok, enum mdoc_type type, const stru
         case (MDOC_Qq):          case (MDOC_Qq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Sq):          case (MDOC_Sq):
                 assert(MDOC_BODY != type);                  assert(MDOC_HEAD != type);
                 assert(MDOC_TAIL != type);                  assert(MDOC_TAIL != type);
                 if (type == p->type && tok == p->tok)                  if (type == p->type && tok == p->tok)
                         return(REWIND_REWIND);                          return(REWIND_REWIND);
Line 276  rewind_dobreak(int tok, const struct mdoc_node *p)
Line 315  rewind_dobreak(int tok, const struct mdoc_node *p)
                 return(1);                  return(1);
         if (MDOC_TEXT == p->type)          if (MDOC_TEXT == p->type)
                 return(1);                  return(1);
           if (MDOC_VALID & p->flags)
                   return(1);
   
         switch (tok) {          switch (tok) {
         /* Implicit rules. */          /* Implicit rules. */
Line 328  rewind_subblock(enum mdoc_type type, struct mdoc *mdoc
Line 369  rewind_subblock(enum mdoc_type type, struct mdoc *mdoc
         struct mdoc_node *n;          struct mdoc_node *n;
         int               c;          int               c;
   
         c = rewind_dohalt(tok, type, mdoc->last);  
         if (REWIND_HALT == c)  
                 return(1);  
         if (REWIND_REWIND == c)  
                 return(rewind_last(mdoc, mdoc->last));  
   
         /* LINTED */          /* LINTED */
         for (n = mdoc->last->parent; n; n = n->parent) {          for (n = mdoc->last; n; n = n->parent) {
                 c = rewind_dohalt(tok, type, n);                  c = rewind_dohalt(tok, type, n);
                 if (REWIND_HALT == c)                  if (REWIND_HALT == c)
                         return(1);                          return(1);
Line 357  rewind_expblock(struct mdoc *mdoc, int tok, int line, 
Line 392  rewind_expblock(struct mdoc *mdoc, int tok, int line, 
         struct mdoc_node *n;          struct mdoc_node *n;
         int               c;          int               c;
   
         c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);  
         if (REWIND_HALT == c)  
                 return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));  
         if (REWIND_REWIND == c)  
                 return(rewind_last(mdoc, mdoc->last));  
   
         /* LINTED */          /* LINTED */
         for (n = mdoc->last->parent; n; n = n->parent) {          for (n = mdoc->last; n; n = n->parent) {
                 c = rewind_dohalt(tok, MDOC_BLOCK, n);                  c = rewind_dohalt(tok, MDOC_BLOCK, n);
                 if (REWIND_HALT == c)                  if (REWIND_HALT == c)
                         return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));                          return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));
Line 386  rewind_impblock(struct mdoc *mdoc, int tok, int line, 
Line 415  rewind_impblock(struct mdoc *mdoc, int tok, int line, 
         struct mdoc_node *n;          struct mdoc_node *n;
         int               c;          int               c;
   
         c = rewind_dohalt(tok, MDOC_BLOCK, mdoc->last);  
         if (REWIND_HALT == c)  
                 return(1);  
         if (REWIND_REWIND == c)  
                 return(rewind_last(mdoc, mdoc->last));  
   
         /* LINTED */          /* LINTED */
         for (n = mdoc->last->parent; n; n = n->parent) {          for (n = mdoc->last; n; n = n->parent) {
                 c = rewind_dohalt(tok, MDOC_BLOCK, n);                  c = rewind_dohalt(tok, MDOC_BLOCK, n);
                 if (REWIND_HALT == c)                  if (REWIND_HALT == c)
                         return(1);                          return(1);
Line 435  append_delims(struct mdoc *mdoc, int line, int *pos, c
Line 458  append_delims(struct mdoc *mdoc, int line, int *pos, c
 }  }
   
   
 /* ARGSUSED */  /*
    * Close out an explicit scope.  This optionally parses a TAIL type with
    * a set number of TEXT children.
    */
 int  int
 macro_scoped_close(MACRO_PROT_ARGS)  macro_scoped_close(MACRO_PROT_ARGS)
 {  {
Line 522  macro_scoped_close(MACRO_PROT_ARGS)
Line 548  macro_scoped_close(MACRO_PROT_ARGS)
   
   
 /*  /*
  * A general text domain macro.  When invoked, this opens a scope that   * A general text macro.  This is a complex case because of punctuation.
  * accepts words until either end-of-line, only-punctuation, or a   * If a text macro is followed by words, then punctuation, the macro is
  * callable macro.  If the word is punctuation (not only-punctuation),   * "stopped" and "reopened" following the punctuation.  Thus, the
  * then the scope is closed out, the punctuation appended, then the   * following arises:
  * scope opened again.  If any terminating conditions are met, the scope   *
  * is closed out.  If this is the first macro in the line and   *    .Fl a ; b
  * only-punctuation remains, this punctuation is flushed.   *
    *    ELEMENT (.Fl)
    *        TEXT (`a')
    *    TEXT (`;')
    *    ELEMENT (.Fl)
    *        TEXT (`b')
    *
    * This must handle the following situations:
    *
    *    .Fl Ar b ; ;
    *
    *    ELEMENT (.Fl)
    *    ELEMENT (.Ar)
    *        TEXT (`b')
    *    TEXT (`;')
    *    TEXT (`;')
  */   */
 int  int
 macro_text(MACRO_PROT_ARGS)  macro_text(MACRO_PROT_ARGS)
Line 637  macro_text(MACRO_PROT_ARGS)
Line 678  macro_text(MACRO_PROT_ARGS)
   
   
 /*  /*
  * Implicit- or explicit-end multi-line scoped macro.   * Handle explicit-scope (having a different closure token) and implicit
    * scope (closing out prior scopes when re-invoked) macros.  These
    * constitute the BLOCK type and usually span multiple lines.  These
    * always have HEAD and sometimes have BODY types.  In the multi-line
    * case:
    *
    *     .Bd -ragged
    *     Text.
    *     .Fl macro
    *     Another.
    *     .Ed
    *
    *     BLOCK (.Bd)
    *         HEAD
    *         BODY
    *             TEXT (`Text.')
    *             ELEMENT (.Fl)
    *                 TEXT (`macro')
    *             TEXT (`Another.')
    *
    * Note that the `.It' macro, possibly the most difficult (as it has
    * embedded scope, etc.) is handled by this routine.
  */   */
 int  int
 macro_scoped(MACRO_PROT_ARGS)  macro_scoped(MACRO_PROT_ARGS)
Line 741  macro_scoped(MACRO_PROT_ARGS)
Line 803  macro_scoped(MACRO_PROT_ARGS)
   
   
 /*  /*
  * When scoped to a line, a macro encompasses all of the contents.  This   * This handles a case of implicitly-scoped macro (BLOCK) limited to a
  * differs from constants or text macros, where a new macro will   * single line.  Instead of being closed out by a subsequent call to
  * terminate the existing context.   * another macro, the scope is closed at the end of line.  These don't
    * have BODY or TAIL types.  Notice that the punctuation falls outside
    * of the HEAD type.
    *
    *     .Qq a Fl b Ar d ; ;
    *
    *     BLOCK (Qq)
    *         HEAD
    *             TEXT (`a')
    *             ELEMENT (.Fl)
    *                 TEXT (`b')
    *             ELEMENT (.Ar)
    *                 TEXT (`d')
    *         TEXT (`;')
    *         TEXT (`;')
  */   */
 int  int
 macro_scoped_line(MACRO_PROT_ARGS)  macro_scoped_line(MACRO_PROT_ARGS)
Line 757  macro_scoped_line(MACRO_PROT_ARGS)
Line 833  macro_scoped_line(MACRO_PROT_ARGS)
   
         if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))          if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                 return(0);                  return(0);
           mdoc->next = MDOC_NEXT_SIBLING;
           if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                   return(0);
         mdoc->next = MDOC_NEXT_CHILD;          mdoc->next = MDOC_NEXT_CHILD;
   
         /* XXX - no known argument macros. */          /* XXX - no known argument macros. */
Line 788  macro_scoped_line(MACRO_PROT_ARGS)
Line 867  macro_scoped_line(MACRO_PROT_ARGS)
         }          }
   
         if (1 == ppos) {          if (1 == ppos) {
                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))                  if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! append_delims(mdoc, line, pos, buf))                  if ( ! append_delims(mdoc, line, pos, buf))
                         return(0);                          return(0);
         } else if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))          } else if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                 return(0);                  return(0);
         return(rewind_impblock(mdoc, tok, line, ppos));          return(rewind_impblock(mdoc, tok, line, ppos));
 }  }
   
   
 /*  /*
  * Constant-scope macros accept a fixed number of arguments and behave   * A constant-scoped macro is like a simple-scoped macro (mdoc_scoped)
  * like constant macros except that they're scoped across lines.   * except that it doesn't handle implicit scopes and explicit ones have
    * a fixed number of TEXT children to the BODY.
    *
    *     .Fl a So b Sc ;
    *
    *     ELEMENT (.Fl)
    *         TEXT (`a')
    *     BLOCK (.So)
    *         HEAD
    *         BODY
    *             TEXT (`b')
    *     TEXT (';')
  */   */
 int  int
 macro_constant_scoped(MACRO_PROT_ARGS)  macro_constant_scoped(MACRO_PROT_ARGS)
Line 902  macro_constant_scoped(MACRO_PROT_ARGS)
Line 992  macro_constant_scoped(MACRO_PROT_ARGS)
   
   
 /*  /*
  * Delimited macros are like text macros except that, should punctuation   * A delimited constant is very similar to the macros parsed by
  * be encountered, the macro isn't re-started with remaining tokens   * macro_text except that, in the event of punctuation, the macro isn't
  * (it's only emitted once).  Delimited macros can have a maximum number   * "re-opened" as it is in macro_text.  Also, these macros have a fixed
  * of arguments.   * number of parameters.
    *
    *    .Fl a No b
    *
    *    ELEMENT (.Fl)
    *        TEXT (`a')
    *    ELEMENT (.No)
    *    TEXT (`b')
  */   */
 int  int
 macro_constant_delimited(MACRO_PROT_ARGS)  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1000  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1097  macro_constant_delimited(MACRO_PROT_ARGS)
                 mdoc->next = MDOC_NEXT_SIBLING;                  mdoc->next = MDOC_NEXT_SIBLING;
         }          }
   
         if ( ! flushed && rewind_elem(mdoc, tok))          if ( ! flushed && ! rewind_elem(mdoc, tok))
                 return(0);                  return(0);
   
         if (ppos > 1)          if (ppos > 1)
Line 1010  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1107  macro_constant_delimited(MACRO_PROT_ARGS)
   
   
 /*  /*
  * Constant macros span an entire line:  they constitute a macro and all   * A constant macro is the simplest classification.  It spans an entire
  * of its arguments and child data.   * line.
  */   */
 int  int
 macro_constant(MACRO_PROT_ARGS)  macro_constant(MACRO_PROT_ARGS)
 {  {
         int              c, lastarg, argc, fl;          int               c, lastarg, argc, fl;
         struct mdoc_arg  argv[MDOC_LINEARG_MAX];          struct mdoc_arg   argv[MDOC_LINEARG_MAX];
         char            *p;          char             *p;
   
           assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
   
         fl = 0;          fl = 0;
         if (MDOC_QUOTABLE & mdoc_macros[tok].flags)          if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                 fl = ARGS_QUOTED;                  fl = ARGS_QUOTED;
Line 1087  macro_obsolete(MACRO_PROT_ARGS)
Line 1186  macro_obsolete(MACRO_PROT_ARGS)
 }  }
   
   
   /*
    * This is called at the end of parsing.  It must traverse up the tree,
    * closing out open [implicit] scopes.  Obviously, open explicit scopes
    * are errors.
    */
 int  int
 macro_end(struct mdoc *mdoc)  macro_end(struct mdoc *mdoc)
 {  {
           struct mdoc_node *n;
   
         assert(mdoc->first);          assert(mdoc->first);
         assert(mdoc->last);          assert(mdoc->last);
   
           /* Scan for open explicit scopes. */
   
           n = MDOC_VALID & mdoc->last->flags ?
                   mdoc->last->parent : mdoc->last;
   
           for ( ; n; n = n->parent) {
                   if (MDOC_BLOCK != n->type)
                           continue;
                   if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))
                           continue;
                   mdoc_nerr(mdoc, n, "macro scope still open on exit");
                   return(0);
           }
   
         return(rewind_last(mdoc, mdoc->first));          return(rewind_last(mdoc, mdoc->first));
 }  }
Legend:
Removed from v.1.41  
changed lines
  Added in v.1.44
CVSweb