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

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

version 1.2, 2008/12/15 01:54:58 version 1.45, 2009/01/20 13:05:28
Line 20 
Line 20 
 #include <ctype.h>  #include <ctype.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  #include <stdio.h>
   #include <string.h>
   #ifdef  __linux__
   #include <time.h>
   #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"
   
 #define _C(p)   ((const char **)p)  #define REWIND_REWIND   (1 << 0)
   #define REWIND_NOHALT   (1 << 1)
   #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_elem(struct mdoc *, int);
   static  int       rewind_impblock(struct mdoc *, int, int, int);
   static  int       rewind_expblock(struct mdoc *, int, int, int);
   static  int       rewind_subblock(enum mdoc_type,
                           struct mdoc *, int, int, int);
   static  int       rewind_last(struct mdoc *, struct mdoc_node *);
   static  int       append_delims(struct mdoc *, int, int *, char *);
   static  int       lookup(struct mdoc *, int, int, int, const char *);
   
 static  int       isdelim(const char *);  
 static  int       args_next(struct mdoc *, int, int *, char *, char **);  
 static  int       append_text(struct mdoc *, int, int, int, char *[]);  
 static  int       append_scoped(struct mdoc *, int, int, int, char *[]);  
   
   static int
   lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p)
   {
           int              res;
   
           res = mdoc_find(mdoc, p);
           if (MDOC_PARSED & mdoc_macros[from].flags)
                   return(res);
           if (MDOC_MAX == res)
                   return(res);
           if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter"))
                   return(-1);
           return(MDOC_MAX);
   }
   
   
 static int  static int
 isdelim(const char *p)  rewind_last(struct mdoc *mdoc, struct mdoc_node *to)
 {  {
   
         if (0 == *p)          assert(to);
           mdoc->next = MDOC_NEXT_SIBLING;
   
           while (mdoc->last != to) {
                   if ( ! mdoc_valid_post(mdoc))
                           return(0);
                   if ( ! mdoc_action_post(mdoc))
                           return(0);
                   mdoc->last = mdoc->last->parent;
                   assert(mdoc->last);
           }
   
           if ( ! mdoc_valid_post(mdoc))
                 return(0);                  return(0);
         if (0 != *(p + 1))          return(mdoc_action_post(mdoc));
                 return(0);  }
   
         switch (*p) {  
         case('{'):  static int
   rewind_alt(int tok)
   {
           switch (tok) {
           case (MDOC_Ac):
                   return(MDOC_Ao);
           case (MDOC_Bc):
                   return(MDOC_Bo);
           case (MDOC_Dc):
                   return(MDOC_Do);
           case (MDOC_Ec):
                   return(MDOC_Eo);
           case (MDOC_Ed):
                   return(MDOC_Bd);
           case (MDOC_Ef):
                   return(MDOC_Bf);
           case (MDOC_Ek):
                   return(MDOC_Bk);
           case (MDOC_El):
                   return(MDOC_Bl);
           case (MDOC_Fc):
                   return(MDOC_Fo);
           case (MDOC_Oc):
                   return(MDOC_Oo);
           case (MDOC_Pc):
                   return(MDOC_Po);
           case (MDOC_Qc):
                   return(MDOC_Qo);
           case (MDOC_Re):
                   return(MDOC_Rs);
           case (MDOC_Sc):
                   return(MDOC_So);
           case (MDOC_Xc):
                   return(MDOC_Xo);
           default:
                   break;
           }
           abort();
           /* NOTREACHED */
   }
   
   
   static int
   rewind_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p)
   {
   
           if (MDOC_ROOT == p->type)
                   return(REWIND_HALT);
           if (MDOC_VALID & p->flags)
                   return(REWIND_NOHALT);
   
           switch (tok) {
           /* One-liner implicit-scope. */
           case (MDOC_Aq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('.'):          case (MDOC_Bq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(','):          case (MDOC_D1):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(';'):          case (MDOC_Dl):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(':'):          case (MDOC_Dq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('?'):          case (MDOC_Op):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('!'):          case (MDOC_Pq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('('):          case (MDOC_Ql):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(')'):          case (MDOC_Qq):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('['):          case (MDOC_Sq):
                   assert(MDOC_HEAD != type);
                   assert(MDOC_TAIL != type);
                   if (type == p->type && tok == p->tok)
                           return(REWIND_REWIND);
                   break;
   
           /* Multi-line implicit-scope. */
           case (MDOC_It):
                   assert(MDOC_TAIL != type);
                   if (type == p->type && tok == p->tok)
                           return(REWIND_REWIND);
                   if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
                           return(REWIND_HALT);
                   break;
           case (MDOC_Sh):
                   if (type == p->type && tok == p->tok)
                           return(REWIND_REWIND);
                   break;
           case (MDOC_Ss):
                   assert(MDOC_TAIL != type);
                   if (type == p->type && tok == p->tok)
                           return(REWIND_REWIND);
                   if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
                           return(REWIND_HALT);
                   break;
   
           /* Multi-line explicit scope start. */
           case (MDOC_Ao):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case(']'):          case (MDOC_Bd):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case('}'):          case (MDOC_Bf):
                   /* FALLTHROUGH */
           case (MDOC_Bk):
                   /* FALLTHROUGH */
           case (MDOC_Bl):
                   /* FALLTHROUGH */
           case (MDOC_Bo):
                   /* FALLTHROUGH */
           case (MDOC_Do):
                   /* FALLTHROUGH */
           case (MDOC_Eo):
                   /* FALLTHROUGH */
           case (MDOC_Fo):
                   /* FALLTHROUGH */
           case (MDOC_Oo):
                   /* FALLTHROUGH */
           case (MDOC_Po):
                   /* FALLTHROUGH */
           case (MDOC_Qo):
                   /* FALLTHROUGH */
           case (MDOC_Rs):
                   /* FALLTHROUGH */
           case (MDOC_So):
                   /* FALLTHROUGH */
           case (MDOC_Xo):
                   if (type == p->type && tok == p->tok)
                           return(REWIND_REWIND);
                   break;
   
           /* Multi-line explicit scope close. */
           case (MDOC_Ac):
                   /* FALLTHROUGH */
           case (MDOC_Bc):
                   /* FALLTHROUGH */
           case (MDOC_Dc):
                   /* FALLTHROUGH */
           case (MDOC_Ec):
                   /* FALLTHROUGH */
           case (MDOC_Ed):
                   /* FALLTHROUGH */
           case (MDOC_Ek):
                   /* FALLTHROUGH */
           case (MDOC_El):
                   /* FALLTHROUGH */
           case (MDOC_Fc):
                   /* FALLTHROUGH */
           case (MDOC_Ef):
                   /* FALLTHROUGH */
           case (MDOC_Oc):
                   /* FALLTHROUGH */
           case (MDOC_Pc):
                   /* FALLTHROUGH */
           case (MDOC_Qc):
                   /* FALLTHROUGH */
           case (MDOC_Re):
                   /* FALLTHROUGH */
           case (MDOC_Sc):
                   /* FALLTHROUGH */
           case (MDOC_Xc):
                   if (type == p->type && rewind_alt(tok) == p->tok)
                           return(REWIND_REWIND);
                   break;
           default:
                   abort();
                   /* NOTREACHED */
           }
   
           return(REWIND_NOHALT);
   }
   
   
   static int
   rewind_dobreak(int tok, const struct mdoc_node *p)
   {
   
           assert(MDOC_ROOT != p->type);
           if (MDOC_ELEM == p->type)
                 return(1);                  return(1);
           if (MDOC_TEXT == p->type)
                   return(1);
           if (MDOC_VALID & p->flags)
                   return(1);
   
           switch (tok) {
           /* Implicit rules. */
           case (MDOC_It):
                   return(MDOC_It == p->tok);
           case (MDOC_Ss):
                   return(MDOC_Ss == p->tok);
           case (MDOC_Sh):
                   if (MDOC_Ss == p->tok)
                           return(1);
                   return(MDOC_Sh == p->tok);
   
           /* Extra scope rules. */
           case (MDOC_El):
                   if (MDOC_It == p->tok)
                           return(1);
                   break;
         default:          default:
                 break;                  break;
         }          }
   
         return(0);          if (MDOC_EXPLICIT & mdoc_macros[tok].flags)
                   return(p->tok == rewind_alt(tok));
           else if (MDOC_BLOCK == p->type)
                   return(1);
   
           return(tok == p->tok);
 }  }
   
   
 static int  static int
 args_next(struct mdoc *mdoc, int tok,  rewind_elem(struct mdoc *mdoc, int tok)
                 int *pos, char *buf, char **v)  
 {  {
           struct mdoc_node *n;
   
         if (0 == buf[*pos])          n = mdoc->last;
                 return(0);          if (MDOC_ELEM != n->type)
                   n = n->parent;
           assert(MDOC_ELEM == n->type);
           assert(tok == n->tok);
   
         assert( ! isspace(buf[*pos]));          return(rewind_last(mdoc, n));
   }
   
         if ('\"' == buf[*pos]) {  
                 (void)mdoc_err(mdoc, tok, *pos, ERR_SYNTAX_QUOTE);  static int
                 return(-1);  rewind_subblock(enum mdoc_type type, struct mdoc *mdoc,
                   int tok, int line, int ppos)
   {
           struct mdoc_node *n;
           int               c;
   
           /* LINTED */
           for (n = mdoc->last; n; n = n->parent) {
                   c = rewind_dohalt(tok, type, n);
                   if (REWIND_HALT == c)
                           return(1);
                   if (REWIND_REWIND == c)
                           break;
                   else if (rewind_dobreak(tok, n))
                           continue;
                   return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
         }          }
   
         *v = &buf[*pos];          assert(n);
           return(rewind_last(mdoc, n));
   }
   
         /* Scan ahead to end of token. */  
   
         while (buf[*pos] && ! isspace(buf[*pos]))  static int
                 (*pos)++;  rewind_expblock(struct mdoc *mdoc, int tok, int line, int ppos)
   {
           struct mdoc_node *n;
           int               c;
   
         if (buf[*pos] && buf[*pos + 1] && '\\' == buf[*pos]) {          /* LINTED */
                 (void)mdoc_err(mdoc, tok, *pos, ERR_SYNTAX_WS);          for (n = mdoc->last; n; n = n->parent) {
                 return(-1);                  c = rewind_dohalt(tok, MDOC_BLOCK, n);
                   if (REWIND_HALT == c)
                           return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));
                   if (REWIND_REWIND == c)
                           break;
                   else if (rewind_dobreak(tok, n))
                           continue;
                   return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
         }          }
   
         if (0 == buf[*pos])          assert(n);
                 return(1);          return(rewind_last(mdoc, n));
   }
   
         /* Scan ahead over trailing whitespace. */  
   
         buf[(*pos)++] = 0;  static int
         while (buf[*pos] && isspace(buf[*pos]))  rewind_impblock(struct mdoc *mdoc, int tok, int line, int ppos)
                 (*pos)++;  {
           struct mdoc_node *n;
           int               c;
   
         if (0 == buf[*pos])          /* LINTED */
                 if ( ! mdoc_warn(mdoc, tok, *pos, WARN_SYNTAX_WS_EOLN))          for (n = mdoc->last; n; n = n->parent) {
                         return(-1);                  c = rewind_dohalt(tok, MDOC_BLOCK, n);
                   if (REWIND_HALT == c)
                           return(1);
                   else if (REWIND_REWIND == c)
                           break;
                   else if (rewind_dobreak(tok, n))
                           continue;
                   return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
           }
   
         return(1);          assert(n);
           return(rewind_last(mdoc, n));
 }  }
   
   
 static int  static int
 append_scoped(struct mdoc *mdoc, int tok, int pos, int sz, char *args[])  append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
 {  {
           int              c, lastarg;
           char            *p;
   
         args[sz] = NULL;          if (0 == buf[*pos])
         mdoc_block_alloc(mdoc, pos, tok, 0, NULL);                  return(1);
         mdoc_head_alloc(mdoc, pos, tok, sz, _C(args));  
         mdoc_body_alloc(mdoc, pos, tok);          for (;;) {
                   lastarg = *pos;
                   c = mdoc_args(mdoc, line, pos, buf, 0, &p);
                   if (ARGS_ERROR == c)
                           return(0);
                   else if (ARGS_EOLN == c)
                           break;
                   assert(mdoc_isdelim(p));
                   if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
         return(1);          return(1);
 }  }
   
   
 static int  /*
 append_text(struct mdoc *mdoc, int tok, int pos, int sz, char *args[])   * Close out an explicit scope.  This optionally parses a TAIL type with
    * a set number of TEXT children.
    */
   int
   macro_scoped_close(MACRO_PROT_ARGS)
 {  {
           int              tt, j, c, lastarg, maxargs, flushed;
           char            *p;
   
         args[sz] = NULL;  
   
         switch (tok) {          switch (tok) {
          /* ======= ADD MORE MACRO ARGUMENT-LIMITS BELOW. ======= */          case (MDOC_Ec):
                   maxargs = 1;
                   break;
           default:
                   maxargs = 0;
                   break;
           }
   
         case (MDOC_Ft):          tt = rewind_alt(tok);
                 /* FALLTHROUGH */  
         case (MDOC_Li):          mdoc_msg(mdoc, "parse: %s closing %s",
                 /* FALLTHROUGH */                          mdoc_macronames[tok], mdoc_macronames[tt]);
         case (MDOC_Ms):  
                 /* FALLTHROUGH */          if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
         case (MDOC_Pa):                  if (0 == buf[*pos]) {
                 /* FALLTHROUGH */                          if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
         case (MDOC_Tn):                                  return(0);
                 if (0 == sz && ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1))                          return(rewind_expblock(mdoc, tok, line, ppos));
                   }
                   return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters"));
           }
   
           if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                   return(0);
   
           lastarg = ppos;
           flushed = 0;
   
           if (maxargs > 0) {
                   if ( ! mdoc_tail_alloc(mdoc, line, ppos, tt))
                         return(0);                          return(0);
                 mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, sz, _C(args));                  mdoc->next = MDOC_NEXT_CHILD;
           }
   
           for (j = 0; /* No sentinel. */; j++) {
                   lastarg = *pos;
   
                   if (j == maxargs && ! flushed) {
                           if ( ! rewind_expblock(mdoc, tok, line, ppos))
                                   return(0);
                           flushed = 1;
                   }
   
                   c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
                   if (ARGS_ERROR == c)
                           return(0);
                   if (ARGS_PUNCT == c)
                           break;
                   if (ARGS_EOLN == c)
                           break;
   
                   if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
                           return(0);
                   else if (MDOC_MAX != c) {
                           if ( ! flushed) {
                                   if ( ! rewind_expblock(mdoc, tok, line, ppos))
                                           return(0);
                                   flushed = 1;
                           }
                           if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
                                   return(0);
                           break;
                   }
   
                   if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
           if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos))
                   return(0);
   
           if (ppos > 1)
                 return(1);                  return(1);
           return(append_delims(mdoc, line, pos, buf));
   }
   
         case (MDOC_Ar):  
                 /* FALLTHROUGH */  /*
         case (MDOC_Cm):   * A general text macro.  This is a complex case because of punctuation.
                 /* FALLTHROUGH */   * If a text macro is followed by words, then punctuation, the macro is
         case (MDOC_Fl):   * "stopped" and "reopened" following the punctuation.  Thus, the
                 mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, sz, _C(args));   * following arises:
    *
    *    .Fl a ; b
    *
    *    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
   macro_text(MACRO_PROT_ARGS)
   {
           int               la, lastpunct, c, w, fl, argc;
           struct mdoc_arg   argv[MDOC_LINEARG_MAX];
           char             *p;
   
           la = ppos;
           lastpunct = 0;
   
           for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                   la = *pos;
                   c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                   if (ARGV_EOLN == c)
                           break;
                   if (ARGV_WORD == c) {
                           *pos = la;
                           break;
                   } else if (ARGV_ARG == c)
                           continue;
   
                   mdoc_argv_free(argc, argv);
                   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);
   
           if (0 == c) {
                   mdoc_argv_free(argc, argv);
                   return(0);
           }
   
           mdoc->next = MDOC_NEXT_CHILD;
   
           fl = ARGS_DELIM;
           if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                   fl |= ARGS_QUOTED;
   
           lastpunct = 0;
           for (;;) {
                   la = *pos;
                   w = mdoc_args(mdoc, line, pos, buf, fl, &p);
                   if (ARGS_ERROR == w) {
                           mdoc_argv_free(argc, argv);
                           return(0);
                   }
   
                   if (ARGS_EOLN == w)
                           break;
                   if (ARGS_PUNCT == w)
                           break;
   
                   c = ARGS_QWORD == w ? MDOC_MAX :
                           lookup(mdoc, line, la, tok, p);
   
                   if (MDOC_MAX != c && -1 != c) {
                           if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
                                   mdoc_argv_free(argc, argv);
                                   return(0);
                           }
                           mdoc_argv_free(argc, argv);
                           c = mdoc_macro(mdoc, c, line, la, pos, buf);
                           if (0 == c)
                                   return(0);
                           if (ppos > 1)
                                   return(1);
                           return(append_delims(mdoc, line, pos, buf));
                   } else if (-1 == c) {
                           mdoc_argv_free(argc, argv);
                           return(0);
                   }
   
                   if (ARGS_QWORD != w && mdoc_isdelim(p)) {
                           if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
                                   mdoc_argv_free(argc, argv);
                                   return(0);
                           }
                           lastpunct = 1;
                   } else if (lastpunct) {
                           c = mdoc_elem_alloc(mdoc, line,
                                           ppos, tok, argc, argv);
                           if (0 == c) {
                                   mdoc_argv_free(argc, argv);
                                   return(0);
                           }
                           mdoc->next = MDOC_NEXT_CHILD;
                           lastpunct = 0;
                   }
   
                   if ( ! mdoc_word_alloc(mdoc, line, la, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
           mdoc_argv_free(argc, argv);
   
           if (0 == lastpunct && ! rewind_elem(mdoc, tok))
                   return(0);
           if (ppos > 1)
                 return(1);                  return(1);
           return(append_delims(mdoc, line, pos, buf));
   }
   
         case (MDOC_Ad):  
                 /* FALLTHROUGH */  /*
         case (MDOC_Em):   * Handle explicit-scope (having a different closure token) and implicit
                 /* FALLTHROUGH */   * scope (closing out prior scopes when re-invoked) macros.  These
         case (MDOC_Er):   * constitute the BLOCK type and usually span multiple lines.  These
                 /* FALLTHROUGH */   * always have HEAD and sometimes have BODY types.  In the multi-line
         case (MDOC_Ev):   * case:
                 /* FALLTHROUGH */   *
         case (MDOC_Fa):   *     .Bd -ragged
                 /* FALLTHROUGH */   *     Text.
         case (MDOC_Dv):   *     .Fl macro
                 /* FALLTHROUGH */   *     Another.
         case (MDOC_Ic):   *     .Ed
                 /* FALLTHROUGH */   *
         case (MDOC_Va):   *     BLOCK (.Bd)
                 /* FALLTHROUGH */   *         HEAD
         case (MDOC_Vt):   *         BODY
                 if (0 == sz)   *             TEXT (`Text.')
                         return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));   *             ELEMENT (.Fl)
                 mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, sz, _C(args));   *                 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
   macro_scoped(MACRO_PROT_ARGS)
   {
           int               c, lastarg, argc, fl;
           struct mdoc_arg   argv[MDOC_LINEARG_MAX];
           char             *p;
   
           assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
   
           if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
                   if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                           return(0);
                   if ( ! rewind_impblock(mdoc, tok, line, ppos))
                           return(0);
           }
   
           for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                   lastarg = *pos;
                   c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                   if (ARGV_EOLN == c)
                           break;
                   if (ARGV_WORD == c) {
                           *pos = lastarg;
                           break;
                   } else if (ARGV_ARG == c)
                           continue;
                   mdoc_argv_free(argc, argv);
                   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_block_alloc(mdoc, line, ppos,
                           tok, (size_t)argc, argv);
           mdoc_argv_free(argc, argv);
   
           if (0 == c)
                   return(0);
   
           mdoc->next = MDOC_NEXT_CHILD;
   
           if (0 == buf[*pos]) {
                   if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                           return(0);
                   if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                           return(0);
                   if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                           return(0);
                   mdoc->next = MDOC_NEXT_CHILD;
                 return(1);                  return(1);
           }
   
          /* ======= ADD MORE MACRO ARGUMENT-LIMITS ABOVE. ======= */          if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
         default:                  return(0);
           mdoc->next = MDOC_NEXT_CHILD;
   
           fl = ARGS_DELIM;
           if (MDOC_TABSEP & mdoc_macros[tok].flags)
                   fl |= ARGS_TABSEP;
   
           for (;;) {
                   lastarg = *pos;
                   c = mdoc_args(mdoc, line, pos, buf, fl, &p);
   
                   if (ARGS_ERROR == c)
                           return(0);
                   if (ARGS_PUNCT == c)
                           break;
                   if (ARGS_EOLN == c)
                           break;
   
                   if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
                           return(0);
                   else if (MDOC_MAX == c) {
                           if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                                   return(0);
                           mdoc->next = MDOC_NEXT_SIBLING;
                           continue;
                   }
   
                   if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
                           return(0);
                 break;                  break;
         }          }
   
         abort();          if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
         /* NOTREACHED */                  return(0);
           if (1 == ppos && ! append_delims(mdoc, line, pos, buf))
                   return(0);
   
           if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
   
           return(1);
 }  }
   
   
   /*
    * This handles a case of implicitly-scoped macro (BLOCK) limited to a
    * single line.  Instead of being closed out by a subsequent call to
    * 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_text(struct mdoc *mdoc, int tok, int ppos, int *pos, char *buf)  macro_scoped_line(MACRO_PROT_ARGS)
 {  {
         int               lastarg, j, c, lasttok, lastpunct;          int               lastarg, c;
         char             *args[MDOC_LINEARG_MAX], *p;          char              *p;
   
         lasttok = ppos;          if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL))
         lastpunct = 0;                  return(0);
         j = 0;          mdoc->next = MDOC_NEXT_CHILD;
   
 again:          if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
   
         lastarg = *pos;  
         c = args_next(mdoc, tok, pos, buf, &args[j]);  
   
         if (-1 == c)  
                 return(0);                  return(0);
         if (0 == c && ! lastpunct)          mdoc->next = MDOC_NEXT_SIBLING;
                 return(append_text(mdoc, tok, lasttok, j, args));          if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
         else if (0 == c)                  return(0);
                 return(1);          mdoc->next = MDOC_NEXT_CHILD;
   
         /* Command found. */          /* XXX - no known argument macros. */
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, args[j]))) {          lastarg = ppos;
                 if ( ! lastpunct)          for (;;) {
                         if ( ! append_text(mdoc, tok, lasttok, j, args))                  lastarg = *pos;
                   c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
   
                   if (ARGS_ERROR == c)
                           return(0);
                   if (ARGS_PUNCT == c)
                           break;
                   if (ARGS_EOLN == c)
                           break;
   
                   if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
                           return(0);
                   else if (MDOC_MAX == c) {
                           if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                                 return(0);                                  return(0);
                 return(mdoc_macro(mdoc, c, lastarg, pos, buf));                          mdoc->next = MDOC_NEXT_SIBLING;
                           continue;
                   }
   
                   if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
                           return(0);
                   break;
         }          }
   
         /* Word found. */          if (1 == ppos) {
                   if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                           return(0);
                   if ( ! append_delims(mdoc, line, pos, buf))
                           return(0);
           } else if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
                   return(0);
           return(rewind_impblock(mdoc, tok, line, ppos));
   }
   
         if ( ! isdelim(args[j])) {  
                 j++;  /*
                 goto again;   * A constant-scoped macro is like a simple-scoped macro (mdoc_scoped)
    * 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
   macro_constant_scoped(MACRO_PROT_ARGS)
   {
           int               lastarg, flushed, j, c, maxargs;
           char             *p;
   
           lastarg = ppos;
           flushed = 0;
   
           switch (tok) {
           case (MDOC_Eo):
                   maxargs = 1;
                   break;
           default:
                   maxargs = 0;
                   break;
         }          }
   
         /* Punctuation found.  */          if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL))
                   return(0);
           mdoc->next = MDOC_NEXT_CHILD;
   
         p = args[j]; /* Save argument (NULL-ified in append). */          if (0 == maxargs) {
                   if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                           return(0);
                   if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                           return(0);
                   if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                           return(0);
                   flushed = 1;
           } else if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
                   return(0);
   
         if ( ! lastpunct)          mdoc->next = MDOC_NEXT_CHILD;
                 if ( ! append_text(mdoc, tok, lasttok, j, args))  
           for (j = 0; /* No sentinel. */; j++) {
                   lastarg = *pos;
   
                   if (j == maxargs && ! flushed) {
                           if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                                   return(0);
                           flushed = 1;
                           if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                                   return(0);
                           mdoc->next = MDOC_NEXT_CHILD;
                   }
   
                   c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
                   if (ARGS_ERROR == c)
                         return(0);                          return(0);
                   if (ARGS_PUNCT == c)
                           break;
                   if (ARGS_EOLN == c)
                           break;
   
         args[j] = p;                  if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
                           return(0);
                   else if (MDOC_MAX != c) {
                           if ( ! flushed) {
                                   if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                                           return(0);
                                   flushed = 1;
                                   if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                                           return(0);
                                   mdoc->next = MDOC_NEXT_CHILD;
                           }
                           if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
                                   return(0);
                           break;
                   }
   
         mdoc_word_alloc(mdoc, lastarg, args[j]);                  if ( ! flushed && mdoc_isdelim(p)) {
         lastpunct = 1;                          if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
         j = 0;                                  return(0);
                           flushed = 1;
                           if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                                   return(0);
                           mdoc->next = MDOC_NEXT_CHILD;
                   }
   
                   if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
         goto again;          if ( ! flushed) {
                   if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
                           return(0);
                   if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
                           return(0);
                   mdoc->next = MDOC_NEXT_CHILD;
           }
   
         /* NOTREACHED */          if (ppos > 1)
                   return(1);
           return(append_delims(mdoc, line, pos, buf));
 }  }
   
   
   /*
    * A delimited constant is very similar to the macros parsed by
    * macro_text except that, in the event of punctuation, the macro isn't
    * "re-opened" as it is in macro_text.  Also, these macros have a fixed
    * number of parameters.
    *
    *    .Fl a No b
    *
    *    ELEMENT (.Fl)
    *        TEXT (`a')
    *    ELEMENT (.No)
    *    TEXT (`b')
    */
 int  int
 macro_scoped_implicit(struct mdoc *mdoc,  macro_constant_delimited(MACRO_PROT_ARGS)
                 int tok, int ppos, int *pos, char *buf)  
 {  {
         int               j, c, lastarg, t;          int               lastarg, flushed, j, c, maxargs, argc;
         char             *args[MDOC_LINEARG_MAX];          struct mdoc_arg   argv[MDOC_LINEARG_MAX];
         struct mdoc_node *n;          char             *p;
   
         /*          lastarg = ppos;
          * Look for an implicit parent.          flushed = 0;
          */  
   
         assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));          switch (tok) {
           case (MDOC_No):
                   /* FALLTHROUGH */
           case (MDOC_Ns):
                   /* FALLTHROUGH */
           case (MDOC_Pf):
                   /* FALLTHROUGH */
           case (MDOC_Ux):
                   /* FALLTHROUGH */
           case (MDOC_St):
                   maxargs = 0;
                   break;
           default:
                   maxargs = 1;
                   break;
           }
   
         for (n = mdoc->last; n; n = n->parent) {          for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                 if (MDOC_BLOCK != n->type)                  lastarg = *pos;
                         continue;                  c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                 if (tok == (t = n->data.block.tok))                  if (ARGV_EOLN == c)
                         break;                          break;
                 if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags))                  if (ARGV_WORD == c) {
                           *pos = lastarg;
                           break;
                   } else if (ARGV_ARG == c)
                         continue;                          continue;
                 return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK));                  mdoc_argv_free(argc, argv);
                   return(0);
         }          }
   
         if (n) {          if (MDOC_LINEARG_MAX == argc) {
                 mdoc->last = n;                  mdoc_argv_free(argc - 1, argv);
                 mdoc_msg(mdoc, ppos, "scope: rewound `%s'",                  return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
                                 mdoc_macronames[tok]);          }
         } else  
                 mdoc_msg(mdoc, ppos, "scope: new `%s'",  
                                 mdoc_macronames[tok]);  
   
         j = 0;          c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
           mdoc_argv_free(argc, argv);
   
 again:          if (0 == c)
                   return(0);
   
         lastarg = *pos;          mdoc->next = MDOC_NEXT_CHILD;
         c = args_next(mdoc, tok, pos, buf, &args[j]);  
           for (j = 0; /* No sentinel. */; j++) {
                   lastarg = *pos;
   
                   if (j == maxargs && ! flushed) {
                           if ( ! rewind_elem(mdoc, tok))
                                   return(0);
                           flushed = 1;
                   }
   
                   c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
                   if (ARGS_ERROR == c)
                           return(0);
                   if (ARGS_PUNCT == c)
                           break;
                   if (ARGS_EOLN == c)
                           break;
   
                   if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
                           return(0);
                   else if (MDOC_MAX != c) {
                           if ( ! flushed && ! rewind_elem(mdoc, tok))
                                   return(0);
                           flushed = 1;
                           if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
                                   return(0);
                           break;
                   }
   
                   if ( ! flushed && mdoc_isdelim(p)) {
                           if ( ! rewind_elem(mdoc, tok))
                                   return(0);
                           flushed = 1;
                   }
   
         if (-1 == c)                  if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
           if ( ! flushed && ! rewind_elem(mdoc, tok))
                 return(0);                  return(0);
   
           if (ppos > 1)
                   return(1);
           return(append_delims(mdoc, line, pos, buf));
   }
   
   
   /*
    * A constant macro is the simplest classification.  It spans an entire
    * line.
    */
   int
   macro_constant(MACRO_PROT_ARGS)
   {
           int               c, w, la, argc, fl;
           struct mdoc_arg   argv[MDOC_LINEARG_MAX];
           char             *p;
   
           assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
   
           for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
                   la = *pos;
                   c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
                   if (ARGV_EOLN == c)
                           break;
                   if (ARGV_WORD == c) {
                           *pos = la;
                           break;
                   } else if (ARGV_ARG == c)
                           continue;
   
                   mdoc_argv_free(argc, argv);
                   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);
           mdoc_argv_free(argc, argv);
   
         if (0 == c)          if (0 == c)
                 return(append_scoped(mdoc, tok, ppos, j, args));                  return(0);
   
         /* Command found. */          mdoc->next = MDOC_NEXT_CHILD;
   
         if (MDOC_MAX != (c = mdoc_find(mdoc, args[j])))          fl = 0;
                 if ( ! mdoc_warn(mdoc, tok, *pos, WARN_SYNTAX_MACLIKE))          if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
                   fl = ARGS_QUOTED;
   
           for (;;) {
                   la = *pos;
                   w = mdoc_args(mdoc, line, pos, buf, fl, &p);
                   if (ARGS_ERROR == w)
                         return(0);                          return(0);
                   if (ARGS_EOLN == w)
                           break;
   
         /* Word found. */                  c = ARGS_QWORD == w ? MDOC_MAX :
                           lookup(mdoc, line, la, tok, p);
   
         j++;                  if (MDOC_MAX != c && -1 != c) {
         goto again;                          if ( ! rewind_elem(mdoc, tok))
                                   return(0);
                           return(mdoc_macro(mdoc, c, line, la, pos, buf));
                   } else if (-1 == c)
                           return(0);
   
         /* NOTREACHED */                  if ( ! mdoc_word_alloc(mdoc, line, la, p))
                           return(0);
                   mdoc->next = MDOC_NEXT_SIBLING;
           }
   
           return(rewind_elem(mdoc, tok));
   }
   
   
   /* ARGSUSED */
   int
   macro_obsolete(MACRO_PROT_ARGS)
   {
   
           return(mdoc_pwarn(mdoc, line, ppos, WARN_SYNTAX, "macro is obsolete"));
   }
   
   
   /*
    * 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
   macro_end(struct mdoc *mdoc)
   {
           struct mdoc_node *n;
   
           assert(mdoc->first);
           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));
 }  }
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.45
CVSweb