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

Diff for /mandoc/Attic/macro.c between version 1.38 and 1.45

version 1.38, 2009/01/16 11:50:54 version 1.45, 2009/01/20 13:05: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_dobreak(int, enum mdoc_type,  static  int       rewind_dohalt(int, enum mdoc_type,
                         const struct mdoc_node *);                          const struct mdoc_node *);
   static  int       rewind_alt(int);
   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);
 static  int       rewind_subblock(enum mdoc_type, struct mdoc *, int);  static  int       rewind_subblock(enum mdoc_type,
 static  int       rewind_last(int, int,                          struct mdoc *, int, int, int);
                         struct mdoc *, struct mdoc_node *);  static  int       rewind_last(struct mdoc *, struct mdoc_node *);
 static  int       append_delims(struct mdoc *,  static  int       append_delims(struct mdoc *, int, int *, char *);
                         int, int, int *, char *);  
 static  int       lookup(struct mdoc *, int, int, int, const char *);  static  int       lookup(struct mdoc *, int, int, int, const char *);
   
   
Line 60  lookup(struct mdoc *mdoc, int line, int pos, int from,
Line 104  lookup(struct mdoc *mdoc, int line, int pos, int from,
                 return(res);                  return(res);
         if (MDOC_MAX == res)          if (MDOC_MAX == res)
                 return(res);                  return(res);
   
         if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter"))          if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter"))
                 return(-1);                  return(-1);
         return(MDOC_MAX);          return(MDOC_MAX);
Line 68  lookup(struct mdoc *mdoc, int line, int pos, int from,
Line 111  lookup(struct mdoc *mdoc, int line, int pos, int from,
   
   
 static int  static int
 rewind_last(int tok, int type, struct mdoc *mdoc, struct mdoc_node *to)  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);
                 mdoc_msg(mdoc, "rewound %s %s to %s %s",  
                                 mdoc_type2a(type),  
                                 mdoc_macronames[tok],  
                                 mdoc_type2a(mdoc->last->type),  
                                 mdoc_macronames[mdoc->last->tok]);  
                 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);  
                 mdoc_msg(mdoc, "rewound %s %s to %s %s",  
                                 mdoc_type2a(type),  
                                 mdoc_macronames[tok],  
                                 mdoc_type2a(mdoc->last->type),  
                                 mdoc_macronames[mdoc->last->tok]);  
         } while (mdoc->last != to);  
   
         return(1);          if ( ! mdoc_valid_post(mdoc))
                   return(0);
           return(mdoc_action_post(mdoc));
 }  }
   
   
Line 152  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 178  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 281  rewind_dohalt(int tok, enum mdoc_type type, const stru
Line 307  rewind_dohalt(int tok, enum mdoc_type type, const stru
   
   
 static int  static int
 rewind_dobreak(int tok, enum mdoc_type type, const struct mdoc_node *p)  rewind_dobreak(int tok, const struct mdoc_node *p)
 {  {
   
         assert(MDOC_ROOT != p->type);          assert(MDOC_ROOT != p->type);
Line 289  rewind_dobreak(int tok, enum mdoc_type type, const str
Line 315  rewind_dobreak(int tok, enum mdoc_type type, const str
                 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 330  rewind_elem(struct mdoc *mdoc, int tok)
Line 358  rewind_elem(struct mdoc *mdoc, int tok)
         assert(MDOC_ELEM == n->type);          assert(MDOC_ELEM == n->type);
         assert(tok == n->tok);          assert(tok == n->tok);
   
         return(rewind_last(tok, MDOC_ELEM, mdoc, n));          return(rewind_last(mdoc, n));
 }  }
   
   
 static int  static int
 rewind_subblock(enum mdoc_type type, struct mdoc *mdoc, int tok)  rewind_subblock(enum mdoc_type type, struct mdoc *mdoc,
                   int tok, int line, int ppos)
 {  {
         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(tok, type, 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);
                 if (REWIND_REWIND == c)                  if (REWIND_REWIND == c)
                         break;                          break;
                 else if (rewind_dobreak(tok, type, n))                  else if (rewind_dobreak(tok, n))
                         continue;                          continue;
                 return(mdoc_nerr(mdoc, n, "body scope broken"));                  return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
         }          }
   
         assert(n);          assert(n);
         return(rewind_last(tok, type, mdoc, n));          return(rewind_last(mdoc, n));
 }  }
   
   
Line 369  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(tok, MDOC_BLOCK, 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"));
                 if (REWIND_REWIND == c)                  if (REWIND_REWIND == c)
                         break;                          break;
                 else if (rewind_dobreak(tok, MDOC_BLOCK, n))                  else if (rewind_dobreak(tok, n))
                         continue;                          continue;
                 return(mdoc_nerr(mdoc, n, "block scope broken"));                  return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
         }          }
   
         assert(n);          assert(n);
         return(rewind_last(tok, MDOC_BLOCK, mdoc, n));          return(rewind_last(mdoc, n));
 }  }
   
   
Line 398  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(tok, MDOC_BLOCK, 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);
                 else if (REWIND_REWIND == c)                  else if (REWIND_REWIND == c)
                         break;                          break;
                 else if (rewind_dobreak(tok, MDOC_BLOCK, n))                  else if (rewind_dobreak(tok, n))
                         continue;                          continue;
                 return(mdoc_nerr(mdoc, n, "block scope broken"));                  return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
         }          }
   
         assert(n);          assert(n);
         return(rewind_last(tok, MDOC_BLOCK, mdoc, n));          return(rewind_last(mdoc, n));
 }  }
   
   
 static int  static int
 append_delims(struct mdoc *mdoc, int tok,  append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
                 int line, int *pos, char *buf)  
 {  {
         int              c, lastarg;          int              c, lastarg;
         char            *p;          char            *p;
Line 448  append_delims(struct mdoc *mdoc, int tok, 
Line 458  append_delims(struct mdoc *mdoc, int tok, 
 }  }
   
   
 /* 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 466  macro_scoped_close(MACRO_PROT_ARGS)
Line 479  macro_scoped_close(MACRO_PROT_ARGS)
   
         tt = rewind_alt(tok);          tt = rewind_alt(tok);
   
         mdoc_msg(mdoc, "parse-quiet: %s closing %s",          mdoc_msg(mdoc, "parse: %s closing %s",
                         mdoc_macronames[tok], mdoc_macronames[tt]);                          mdoc_macronames[tok], mdoc_macronames[tt]);
   
         if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {          if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
                 if (0 == buf[*pos]) {                  if (0 == buf[*pos]) {
                         if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))                          if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                                 return(0);                                  return(0);
                         return(rewind_expblock(mdoc, tok, line, ppos));                          return(rewind_expblock(mdoc, tok, line, ppos));
                 }                  }
                 return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters"));                  return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters"));
         }          }
   
         if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))          if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                 return(0);                  return(0);
   
         lastarg = ppos;          lastarg = ppos;
Line 490  macro_scoped_close(MACRO_PROT_ARGS)
Line 503  macro_scoped_close(MACRO_PROT_ARGS)
                 mdoc->next = MDOC_NEXT_CHILD;                  mdoc->next = MDOC_NEXT_CHILD;
         }          }
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          for (j = 0; /* No sentinel. */; j++) {
                 lastarg = *pos;                  lastarg = *pos;
   
                 if (j == maxargs && ! flushed) {                  if (j == maxargs && ! flushed) {
Line 525  macro_scoped_close(MACRO_PROT_ARGS)
Line 538  macro_scoped_close(MACRO_PROT_ARGS)
                 mdoc->next = MDOC_NEXT_SIBLING;                  mdoc->next = MDOC_NEXT_SIBLING;
         }          }
   
         if (MDOC_LINEARG_MAX == j)  
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos))          if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos))
                 return(0);                  return(0);
   
         if (ppos > 1)          if (ppos > 1)
                 return(1);                  return(1);
         return(append_delims(mdoc, tok, line, pos, buf));          return(append_delims(mdoc, line, pos, buf));
 }  }
   
   
 /*  /*
  * 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)
 {  {
         int               la, lastpunct, c, sz, fl, argc;          int               la, lastpunct, c, w, fl, argc;
         struct mdoc_arg   argv[MDOC_LINEARG_MAX];          struct mdoc_arg   argv[MDOC_LINEARG_MAX];
         char             *p;          char             *p;
   
Line 558  macro_text(MACRO_PROT_ARGS)
Line 583  macro_text(MACRO_PROT_ARGS)
   
         for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {          for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                 la = *pos;                  la = *pos;
   
                 c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);                  c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                 if (ARGV_EOLN == c)                  if (ARGV_EOLN == c)
                         break;                          break;
Line 573  macro_text(MACRO_PROT_ARGS)
Line 597  macro_text(MACRO_PROT_ARGS)
         }          }
   
         if (MDOC_LINEARG_MAX == argc) {          if (MDOC_LINEARG_MAX == argc) {
                 mdoc_argv_free(argc, argv);                  mdoc_argv_free(argc - 1, argv);
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));                  return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
         }          }
   
         c = mdoc_elem_alloc(mdoc, line, la, tok, argc, argv);          c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
   
         if (0 == c) {          if (0 == c) {
                 mdoc_argv_free(argc, argv);                  mdoc_argv_free(argc, argv);
Line 590  macro_text(MACRO_PROT_ARGS)
Line 614  macro_text(MACRO_PROT_ARGS)
         if (MDOC_QUOTABLE & mdoc_macros[tok].flags)          if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                 fl |= ARGS_QUOTED;                  fl |= ARGS_QUOTED;
   
         for (lastpunct = sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) {          lastpunct = 0;
           for (;;) {
                 la = *pos;                  la = *pos;
                   w = mdoc_args(mdoc, line, pos, buf, fl, &p);
                 c = mdoc_args(mdoc, line, pos, buf, fl, &p);                  if (ARGS_ERROR == w) {
                 if (ARGS_ERROR == c) {  
                         mdoc_argv_free(argc, argv);                          mdoc_argv_free(argc, argv);
                         return(0);                          return(0);
                 }                  }
   
                 if (ARGS_EOLN == c)                  if (ARGS_EOLN == w)
                         break;                          break;
                 if (ARGS_PUNCT == c)                  if (ARGS_PUNCT == w)
                         break;                          break;
   
                 if (-1 == (c = lookup(mdoc, line, la, tok, p)))                  c = ARGS_QWORD == w ? MDOC_MAX :
                         return(0);                          lookup(mdoc, line, la, tok, p);
                 else if (MDOC_MAX != c) {  
                   if (MDOC_MAX != c && -1 != c) {
                         if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {                          if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
                                 mdoc_argv_free(argc, argv);                                  mdoc_argv_free(argc, argv);
                                 return(0);                                  return(0);
                         }                          }
                         mdoc_argv_free(argc, argv);                          mdoc_argv_free(argc, argv);
   
                         c = mdoc_macro(mdoc, c, line, la, pos, buf);                          c = mdoc_macro(mdoc, c, line, la, pos, buf);
                         if (0 == c)                          if (0 == c)
                                 return(0);                                  return(0);
                         if (ppos > 1)                          if (ppos > 1)
                                 return(1);                                  return(1);
                         return(append_delims(mdoc, tok, line, pos, buf));                          return(append_delims(mdoc, line, pos, buf));
                   } else if (-1 == c) {
                           mdoc_argv_free(argc, argv);
                           return(0);
                 }                  }
   
                 if (mdoc_isdelim(p)) {                  if (ARGS_QWORD != w && mdoc_isdelim(p)) {
                         if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {                          if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
                                 mdoc_argv_free(argc, argv);                                  mdoc_argv_free(argc, argv);
                                 return(0);                                  return(0);
Line 629  macro_text(MACRO_PROT_ARGS)
Line 656  macro_text(MACRO_PROT_ARGS)
                         lastpunct = 1;                          lastpunct = 1;
                 } else if (lastpunct) {                  } else if (lastpunct) {
                         c = mdoc_elem_alloc(mdoc, line,                          c = mdoc_elem_alloc(mdoc, line,
                                         la, tok, argc, argv);                                          ppos, tok, argc, argv);
                         if (0 == c) {                          if (0 == c) {
                                 mdoc_argv_free(argc, argv);                                  mdoc_argv_free(argc, argv);
                                 return(0);                                  return(0);
Line 645  macro_text(MACRO_PROT_ARGS)
Line 672  macro_text(MACRO_PROT_ARGS)
   
         mdoc_argv_free(argc, argv);          mdoc_argv_free(argc, argv);
   
         if (sz == MDOC_LINEARG_MAX)  
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if (0 == lastpunct && ! rewind_elem(mdoc, tok))          if (0 == lastpunct && ! rewind_elem(mdoc, tok))
                 return(0);                  return(0);
         if (ppos > 1)          if (ppos > 1)
                 return(1);                  return(1);
         return(append_delims(mdoc, tok, line, pos, buf));          return(append_delims(mdoc, line, pos, buf));
 }  }
   
   
 /*  /*
  * 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)
 {  {
         int               c, lastarg, argc, j, 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));          assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
   
         if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {          if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
                 if ( ! rewind_subblock(MDOC_BODY, mdoc, tok))                  if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! rewind_impblock(mdoc, tok, line, ppos))                  if ( ! rewind_impblock(mdoc, tok, line, ppos))
                         return(0);                          return(0);
Line 690  macro_scoped(MACRO_PROT_ARGS)
Line 735  macro_scoped(MACRO_PROT_ARGS)
         }          }
   
         if (MDOC_LINEARG_MAX == argc) {          if (MDOC_LINEARG_MAX == argc) {
                 mdoc_argv_free(argc, argv);                  mdoc_argv_free(argc - 1, argv);
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));                  return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
         }          }
   
         c = mdoc_block_alloc(mdoc, line, ppos,          c = mdoc_block_alloc(mdoc, line, ppos,
Line 706  macro_scoped(MACRO_PROT_ARGS)
Line 751  macro_scoped(MACRO_PROT_ARGS)
         if (0 == buf[*pos]) {          if (0 == buf[*pos]) {
                 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))                  if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                         return(0);                          return(0);
                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                  if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                  if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                         return(0);                          return(0);
Line 722  macro_scoped(MACRO_PROT_ARGS)
Line 767  macro_scoped(MACRO_PROT_ARGS)
         if (MDOC_TABSEP & mdoc_macros[tok].flags)          if (MDOC_TABSEP & mdoc_macros[tok].flags)
                 fl |= ARGS_TABSEP;                  fl |= ARGS_TABSEP;
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          for (;;) {
                 lastarg = *pos;                  lastarg = *pos;
                 c = mdoc_args(mdoc, line, pos, buf, fl, &p);                  c = mdoc_args(mdoc, line, pos, buf, fl, &p);
   
Line 747  macro_scoped(MACRO_PROT_ARGS)
Line 792  macro_scoped(MACRO_PROT_ARGS)
                 break;                  break;
         }          }
   
         if (j == MDOC_LINEARG_MAX)          if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))  
                 return(0);                  return(0);
         if (1 == ppos && ! append_delims(mdoc, tok, line, pos, buf))          if (1 == ppos && ! append_delims(mdoc, line, pos, buf))
                 return(0);                  return(0);
   
         if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))          if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
Line 764  macro_scoped(MACRO_PROT_ARGS)
Line 806  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)
 {  {
         int               lastarg, c, j;          int               lastarg, c;
         char              *p;          char              *p;
   
         if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL))          if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL))
Line 780  macro_scoped_line(MACRO_PROT_ARGS)
Line 836  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. */
   
         for (lastarg = ppos, j = 0; j < MDOC_LINEARG_MAX; j++) {          lastarg = ppos;
           for (;;) {
                 lastarg = *pos;                  lastarg = *pos;
                 c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);                  c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
   
Line 809  macro_scoped_line(MACRO_PROT_ARGS)
Line 869  macro_scoped_line(MACRO_PROT_ARGS)
                 break;                  break;
         }          }
   
         if (j == MDOC_LINEARG_MAX)  
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if (1 == ppos) {          if (1 == ppos) {
                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                  if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! append_delims(mdoc, tok, line, pos, buf))                  if ( ! append_delims(mdoc, line, pos, buf))
                         return(0);                          return(0);
         } else if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))          } 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 852  macro_constant_scoped(MACRO_PROT_ARGS)
Line 920  macro_constant_scoped(MACRO_PROT_ARGS)
         if (0 == maxargs) {          if (0 == maxargs) {
                 if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))                  if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                         return(0);                          return(0);
                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                  if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                  if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                         return(0);                          return(0);
Line 862  macro_constant_scoped(MACRO_PROT_ARGS)
Line 930  macro_constant_scoped(MACRO_PROT_ARGS)
   
         mdoc->next = MDOC_NEXT_CHILD;          mdoc->next = MDOC_NEXT_CHILD;
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          for (j = 0; /* No sentinel. */; j++) {
                 lastarg = *pos;                  lastarg = *pos;
   
                 if (j == maxargs && ! flushed) {                  if (j == maxargs && ! flushed) {
                         if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                          if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                                 return(0);                                  return(0);
                         flushed = 1;                          flushed = 1;
                         if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                          if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
Line 886  macro_constant_scoped(MACRO_PROT_ARGS)
Line 954  macro_constant_scoped(MACRO_PROT_ARGS)
                         return(0);                          return(0);
                 else if (MDOC_MAX != c) {                  else if (MDOC_MAX != c) {
                         if ( ! flushed) {                          if ( ! flushed) {
                                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                                  if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                                         return(0);                                          return(0);
                                 flushed = 1;                                  flushed = 1;
                                 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                                  if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
Line 899  macro_constant_scoped(MACRO_PROT_ARGS)
Line 967  macro_constant_scoped(MACRO_PROT_ARGS)
                 }                  }
   
                 if ( ! flushed && mdoc_isdelim(p)) {                  if ( ! flushed && mdoc_isdelim(p)) {
                         if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                          if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                                 return(0);                                  return(0);
                         flushed = 1;                          flushed = 1;
                         if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                          if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
Line 912  macro_constant_scoped(MACRO_PROT_ARGS)
Line 980  macro_constant_scoped(MACRO_PROT_ARGS)
                 mdoc->next = MDOC_NEXT_SIBLING;                  mdoc->next = MDOC_NEXT_SIBLING;
         }          }
   
         if (MDOC_LINEARG_MAX == j)  
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if ( ! flushed) {          if ( ! flushed) {
                 if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok))                  if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                         return(0);                          return(0);
                 if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))                  if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                         return(0);                          return(0);
Line 925  macro_constant_scoped(MACRO_PROT_ARGS)
Line 990  macro_constant_scoped(MACRO_PROT_ARGS)
   
         if (ppos > 1)          if (ppos > 1)
                 return(1);                  return(1);
         return(append_delims(mdoc, tok, line, pos, buf));          return(append_delims(mdoc, line, pos, buf));
 }  }
   
   
 /*  /*
  * 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 950  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1022  macro_constant_delimited(MACRO_PROT_ARGS)
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Ns):          case (MDOC_Ns):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
           case (MDOC_Pf):
                   /* FALLTHROUGH */
         case (MDOC_Ux):          case (MDOC_Ux):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_St):          case (MDOC_St):
Line 974  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1048  macro_constant_delimited(MACRO_PROT_ARGS)
                 return(0);                  return(0);
         }          }
   
         c = mdoc_elem_alloc(mdoc, line, lastarg, tok, argc, argv);          if (MDOC_LINEARG_MAX == argc) {
                   mdoc_argv_free(argc - 1, argv);
                   return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
           }
   
           c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
         mdoc_argv_free(argc, argv);          mdoc_argv_free(argc, argv);
   
         if (0 == c)          if (0 == c)
Line 982  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1061  macro_constant_delimited(MACRO_PROT_ARGS)
   
         mdoc->next = MDOC_NEXT_CHILD;          mdoc->next = MDOC_NEXT_CHILD;
   
         for (j = 0; j < MDOC_LINEARG_MAX; j++) {          for (j = 0; /* No sentinel. */; j++) {
                 lastarg = *pos;                  lastarg = *pos;
   
                 if (j == maxargs && ! flushed) {                  if (j == maxargs && ! flushed) {
Line 1021  macro_constant_delimited(MACRO_PROT_ARGS)
Line 1100  macro_constant_delimited(MACRO_PROT_ARGS)
                 mdoc->next = MDOC_NEXT_SIBLING;                  mdoc->next = MDOC_NEXT_SIBLING;
         }          }
   
         if (MDOC_LINEARG_MAX == j)          if ( ! flushed && ! rewind_elem(mdoc, tok))
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         if ( ! flushed && rewind_elem(mdoc, tok))  
                 return(0);                  return(0);
   
         if (ppos > 1)          if (ppos > 1)
                 return(1);                  return(1);
         return(append_delims(mdoc, tok, line, pos, buf));          return(append_delims(mdoc, line, pos, buf));
 }  }
   
   
 /*  /*
  * 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, sz, fl;          int               c, w, la, argc, fl;
         struct mdoc_arg  argv[MDOC_LINEARG_MAX];          struct mdoc_arg   argv[MDOC_LINEARG_MAX];
         char            *p;          char             *p;
   
         /* FIXME: parsing macros! */          assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
   
         fl = 0;  
         if (MDOC_QUOTABLE & mdoc_macros[tok].flags)  
                 fl = ARGS_QUOTED;  
   
         for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {          for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                 lastarg = *pos;                  la = *pos;
                 c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);                  c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                 if (ARGV_EOLN == c)                  if (ARGV_EOLN == c)
                         break;                          break;
                 if (ARGV_WORD == c) {                  if (ARGV_WORD == c) {
                         *pos = lastarg;                          *pos = la;
                         break;                          break;
                 } else if (ARGV_ARG == c)                  } else if (ARGV_ARG == c)
                         continue;                          continue;
Line 1065  macro_constant(MACRO_PROT_ARGS)
Line 1137  macro_constant(MACRO_PROT_ARGS)
                 return(0);                  return(0);
         }          }
   
           if (MDOC_LINEARG_MAX == argc) {
                   mdoc_argv_free(argc - 1, argv);
                   return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
           }
   
         c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);          c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
         mdoc_argv_free(argc, argv);          mdoc_argv_free(argc, argv);
   
Line 1073  macro_constant(MACRO_PROT_ARGS)
Line 1150  macro_constant(MACRO_PROT_ARGS)
   
         mdoc->next = MDOC_NEXT_CHILD;          mdoc->next = MDOC_NEXT_CHILD;
   
         if (MDOC_LINEARG_MAX == argc)          fl = 0;
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));          if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                   fl = ARGS_QUOTED;
   
         for (sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) {          for (;;) {
                 lastarg = *pos;                  la = *pos;
                 c = mdoc_args(mdoc, line, pos, buf, fl, &p);                  w = mdoc_args(mdoc, line, pos, buf, fl, &p);
                 if (ARGS_ERROR == c)                  if (ARGS_ERROR == w)
                         return(0);                          return(0);
                 if (ARGS_EOLN == c)                  if (ARGS_EOLN == w)
                         break;                          break;
   
                 if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))                  c = ARGS_QWORD == w ? MDOC_MAX :
                           lookup(mdoc, line, la, tok, p);
   
                   if (MDOC_MAX != c && -1 != c) {
                           if ( ! rewind_elem(mdoc, tok))
                                   return(0);
                           return(mdoc_macro(mdoc, c, line, la, pos, buf));
                   } else if (-1 == c)
                         return(0);                          return(0);
   
                   if ( ! mdoc_word_alloc(mdoc, line, la, p))
                           return(0);
                 mdoc->next = MDOC_NEXT_SIBLING;                  mdoc->next = MDOC_NEXT_SIBLING;
         }          }
   
         if (MDOC_LINEARG_MAX == sz + argc)  
                 return(mdoc_perr(mdoc, line, ppos, "too many arguments"));  
   
         return(rewind_elem(mdoc, tok));          return(rewind_elem(mdoc, tok));
 }  }
   
Line 1105  macro_obsolete(MACRO_PROT_ARGS)
Line 1190  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);
         return(rewind_last(mdoc->last->tok, mdoc->last->type,  
                                 mdoc, mdoc->first));          /* 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));
 }  }
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.45
CVSweb