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

Diff for /mandoc/mdoc_macro.c between version 1.85 and 1.100

version 1.85, 2010/06/29 19:45:06 version 1.100, 2011/01/12 17:00:07
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 33  enum rew { /* see rew_dohalt() */
Line 34  enum rew { /* see rew_dohalt() */
         REWIND_NONE,          REWIND_NONE,
         REWIND_THIS,          REWIND_THIS,
         REWIND_MORE,          REWIND_MORE,
           REWIND_FORCE,
         REWIND_LATER,          REWIND_LATER,
         REWIND_ERROR,          REWIND_ERROR
 };  };
   
 static  int             blk_full(MACRO_PROT_ARGS);  static  int             blk_full(MACRO_PROT_ARGS);
Line 97  const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
Line 99  const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
         { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */          { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
         { blk_full, 0 }, /* Nd */          { blk_full, 0 }, /* Nd */
         { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */          { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
         { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */          { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
         { obsolete, 0 }, /* Ot */          { obsolete, 0 }, /* Ot */
         { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */          { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
Line 137  const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
Line 139  const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
         { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */          { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
         { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */          { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* No */
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Ns */
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
         { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */          { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
         { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */          { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
Line 206  mdoc_macroend(struct mdoc *m)
Line 208  mdoc_macroend(struct mdoc *m)
   
         n = MDOC_VALID & m->last->flags ?  m->last->parent : m->last;          n = MDOC_VALID & m->last->flags ?  m->last->parent : m->last;
   
         for ( ; n; n = n->parent) {          for ( ; n; n = n->parent)
                 if (MDOC_BLOCK != n->type)                  if (MDOC_BLOCK == n->type &&
                         continue;                      MDOC_EXPLICIT & mdoc_macros[n->tok].flags)
                 if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))                          mdoc_nmsg(m, n, MANDOCERR_SCOPEEXIT);
                         continue;  
                 mdoc_nmsg(m, n, MANDOCERR_SYNTSCOPE);  
                 return(0);  
         }  
   
         /* Rewind to the first. */          /* Rewind to the first. */
   
Line 254  lookup_raw(const char *p)
Line 252  lookup_raw(const char *p)
 static int  static int
 rew_last(struct mdoc *mdoc, const struct mdoc_node *to)  rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
 {  {
           struct mdoc_node *n, *np;
   
         assert(to);          assert(to);
         mdoc->next = MDOC_NEXT_SIBLING;          mdoc->next = MDOC_NEXT_SIBLING;
   
         /* LINTED */          /* LINTED */
         while (mdoc->last != to) {          while (mdoc->last != to) {
                   /*
                    * Save the parent here, because we may delete the
                    * m->last node in the post-validation phase and reset
                    * it to m->last->parent, causing a step in the closing
                    * out to be lost.
                    */
                   np = mdoc->last->parent;
                 if ( ! mdoc_valid_post(mdoc))                  if ( ! mdoc_valid_post(mdoc))
                         return(0);                          return(0);
                 if ( ! mdoc_action_post(mdoc))                  n = mdoc->last;
                         return(0);                  mdoc->last = np;
                 mdoc->last = mdoc->last->parent;  
                 assert(mdoc->last);                  assert(mdoc->last);
                   mdoc->last->last = n;
         }          }
   
         if ( ! mdoc_valid_post(mdoc))          return(mdoc_valid_post(mdoc));
                 return(0);  
         return(mdoc_action_post(mdoc));  
 }  }
   
   
Line 327  rew_alt(enum mdoct tok)
Line 331  rew_alt(enum mdoct tok)
  *   inside *p, so there is no need to rewind anything at all.   *   inside *p, so there is no need to rewind anything at all.
  * REWIND_THIS: *p matches tok, so rewind *p and nothing else.   * REWIND_THIS: *p matches tok, so rewind *p and nothing else.
  * REWIND_MORE: *p is implicit, rewind it and keep searching for tok.   * REWIND_MORE: *p is implicit, rewind it and keep searching for tok.
    * REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p.
  * REWIND_LATER: *p is explicit and still open, postpone rewinding.   * REWIND_LATER: *p is explicit and still open, postpone rewinding.
  * REWIND_ERROR: No tok block is open at all.   * REWIND_ERROR: No tok block is open at all.
  */   */
Line 335  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
Line 340  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
                 const struct mdoc_node *p)                  const struct mdoc_node *p)
 {  {
   
           /*
            * No matching token, no delimiting block, no broken block.
            * This can happen when full implicit macros are called for
            * the first time but try to rewind their previous
            * instance anyway.
            */
         if (MDOC_ROOT == p->type)          if (MDOC_ROOT == p->type)
                 return(MDOC_BLOCK == type &&                  return(MDOC_BLOCK == type &&
                     MDOC_EXPLICIT & mdoc_macros[tok].flags ?                      MDOC_EXPLICIT & mdoc_macros[tok].flags ?
                     REWIND_ERROR : REWIND_NONE);                      REWIND_ERROR : REWIND_NONE);
   
           /*
            * When starting to rewind, skip plain text
            * and nodes that have already been rewound.
            */
         if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)          if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)
                 return(REWIND_MORE);                  return(REWIND_MORE);
   
           /*
            * The easiest case:  Found a matching token.
            * This applies to both blocks and elements.
            */
         tok = rew_alt(tok);          tok = rew_alt(tok);
         if (tok == p->tok)          if (tok == p->tok)
                 return(p->end ? REWIND_NONE :                  return(p->end ? REWIND_NONE :
                     type == p->type ? REWIND_THIS : REWIND_MORE);                      type == p->type ? REWIND_THIS : REWIND_MORE);
   
           /*
            * While elements do require rewinding for themselves,
            * they never affect rewinding of other nodes.
            */
         if (MDOC_ELEM == p->type)          if (MDOC_ELEM == p->type)
                 return(REWIND_MORE);                  return(REWIND_MORE);
   
           /*
            * Blocks delimited by our target token get REWIND_MORE.
            * Blocks delimiting our target token get REWIND_NONE.
            */
         switch (tok) {          switch (tok) {
         case (MDOC_Bl):          case (MDOC_Bl):
                 if (MDOC_It == p->tok)                  if (MDOC_It == p->tok)
Line 369  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
Line 397  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
                 if (MDOC_Op == p->tok)                  if (MDOC_Op == p->tok)
                         return(REWIND_MORE);                          return(REWIND_MORE);
                 break;                  break;
           case (MDOC_Nm):
                   return(REWIND_NONE);
         case (MDOC_Nd):          case (MDOC_Nd):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Ss):          case (MDOC_Ss):
Line 384  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
Line 414  rew_dohalt(enum mdoct tok, enum mdoc_type type, 
                 break;                  break;
         }          }
   
         return(p->end || (MDOC_BLOCK == p->type &&          /*
             ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) ?           * Default block rewinding rules.
             REWIND_MORE : REWIND_LATER);           * In particular, always skip block end markers,
            * and let all blocks rewind Nm children.
            */
           if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
               (MDOC_BLOCK == p->type &&
               ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
                   return(REWIND_MORE);
   
           /*
            * By default, closing out full blocks
            * forces closing of broken explicit blocks,
            * while closing out partial blocks
            * allows delayed rewinding by default.
            */
           return (&blk_full == mdoc_macros[tok].fp ?
               REWIND_FORCE : REWIND_LATER);
 }  }
   
   
Line 468  make_pending(struct mdoc_node *broken, enum mdoct tok,
Line 513  make_pending(struct mdoc_node *broken, enum mdoct tok,
                         taker->pending = broken->pending;                          taker->pending = broken->pending;
                 }                  }
                 broken->pending = breaker;                  broken->pending = breaker;
                 mdoc_vmsg(m, MANDOCERR_SCOPE, line, ppos, "%s breaks %s",                  mdoc_vmsg(m, MANDOCERR_SCOPENEST, line, ppos,
                     mdoc_macronames[tok], mdoc_macronames[broken->tok]);                      "%s breaks %s", mdoc_macronames[tok],
                       mdoc_macronames[broken->tok]);
                 return(1);                  return(1);
         }          }
   
         /*          /*
          * Found no matching block for tok.           * Found no matching block for tok.
          * Are you trying to close a block that is not open?           * Are you trying to close a block that is not open?
          * XXX Make this non-fatal.  
          */           */
         mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);  
         return(0);          return(0);
 }  }
   
Line 496  rew_sub(enum mdoc_type t, struct mdoc *m, 
Line 540  rew_sub(enum mdoc_type t, struct mdoc *m, 
                         return(1);                          return(1);
                 case (REWIND_THIS):                  case (REWIND_THIS):
                         break;                          break;
                   case (REWIND_FORCE):
                           mdoc_vmsg(m, MANDOCERR_SCOPEBROKEN, line, ppos,
                               "%s breaks %s", mdoc_macronames[tok],
                               mdoc_macronames[n->tok]);
                           /* FALLTHROUGH */
                 case (REWIND_MORE):                  case (REWIND_MORE):
                         n = n->parent;                          n = n->parent;
                         continue;                          continue;
                 case (REWIND_LATER):                  case (REWIND_LATER):
                         return(make_pending(n, tok, m, line, ppos));                          if (make_pending(n, tok, m, line, ppos) ||
                               MDOC_BLOCK != t)
                                   return(1);
                           /* FALLTHROUGH */
                 case (REWIND_ERROR):                  case (REWIND_ERROR):
                         /* XXX Make this non-fatal. */                          mdoc_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
                         mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);                          return(1);
                         return 0;  
                 }                  }
                 break;                  break;
         }          }
Line 563  append_delims(struct mdoc *m, int line, int *pos, char
Line 614  append_delims(struct mdoc *m, int line, int *pos, char
                  * knowing which symbols break this behaviour, for                   * knowing which symbols break this behaviour, for
                  * example, `.  ;' shouldn't propogate the double-space.                   * example, `.  ;' shouldn't propogate the double-space.
                  */                   */
                 if (mandoc_eos(p, strlen(p)))                  if (mandoc_eos(p, strlen(p), 0))
                         m->last->flags |= MDOC_EOS;                          m->last->flags |= MDOC_EOS;
         }          }
   
Line 609  blk_exp_close(MACRO_PROT_ARGS)
Line 660  blk_exp_close(MACRO_PROT_ARGS)
   
                 /* Remember the start of our own body. */                  /* Remember the start of our own body. */
                 if (MDOC_BODY == n->type && atok == n->tok) {                  if (MDOC_BODY == n->type && atok == n->tok) {
                         if ( ! n->end)                          if (ENDBODY_NOT == n->end)
                                 body = n;                                  body = n;
                         continue;                          continue;
                 }                  }
   
                 if (MDOC_BLOCK != n->type)                  if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
                         continue;                          continue;
                 if (atok == n->tok) {                  if (atok == n->tok) {
                         assert(body);                          assert(body);
Line 632  blk_exp_close(MACRO_PROT_ARGS)
Line 683  blk_exp_close(MACRO_PROT_ARGS)
                          * postpone closing out the current block                           * postpone closing out the current block
                          * until the rew_sub() closing out the sub-block.                           * until the rew_sub() closing out the sub-block.
                          */                           */
                         if ( ! make_pending(later, tok, m, line, ppos))                          make_pending(later, tok, m, line, ppos);
                                 return(0);  
   
                         /*                          /*
                          * Mark the place where the formatting - but not                           * Mark the place where the formatting - but not
Line 653  blk_exp_close(MACRO_PROT_ARGS)
Line 703  blk_exp_close(MACRO_PROT_ARGS)
                 if (later &&                  if (later &&
                     MDOC_EXPLICIT & mdoc_macros[later->tok].flags)                      MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
                         continue;                          continue;
                 if (MDOC_CALLABLE & mdoc_macros[n->tok].flags) {                  if (MDOC_CALLABLE & mdoc_macros[n->tok].flags)
                         assert( ! (MDOC_ACTED & n->flags));  
                         later = n;                          later = n;
                 }  
         }          }
   
         if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {          if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
Line 747  in_line(MACRO_PROT_ARGS)
Line 795  in_line(MACRO_PROT_ARGS)
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Fl):          case (MDOC_Fl):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Lk):          case (MDOC_Mt):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case (MDOC_Nm):          case (MDOC_Nm):
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
Line 979  blk_full(MACRO_PROT_ARGS)
Line 1027  blk_full(MACRO_PROT_ARGS)
                 lac = ARGS_ERROR == ac ? ARGS_PEND : ac;                  lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
                 ac = mdoc_args(m, line, pos, buf, tok, &p);                  ac = mdoc_args(m, line, pos, buf, tok, &p);
   
                   if (ARGS_PUNCT == ac)
                           break;
   
                 if (ARGS_ERROR == ac)                  if (ARGS_ERROR == ac)
                         return(0);                          return(0);
   
Line 1097  blk_full(MACRO_PROT_ARGS)
Line 1148  blk_full(MACRO_PROT_ARGS)
                 if (MDOC_BLOCK == n->type &&                  if (MDOC_BLOCK == n->type &&
                                 MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&                                  MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
                                 ! (MDOC_VALID & n->flags)) {                                  ! (MDOC_VALID & n->flags)) {
                         assert( ! (MDOC_ACTED & n->flags));  
                         n->pending = head;                          n->pending = head;
                         return(1);                          return(1);
                 }                  }
Line 1216  blk_part_imp(MACRO_PROT_ARGS)
Line 1266  blk_part_imp(MACRO_PROT_ARGS)
          */           */
   
         if (n && MDOC_TEXT == n->type && n->string)          if (n && MDOC_TEXT == n->type && n->string)
                 if (mandoc_eos(n->string, strlen(n->string)))                  if (mandoc_eos(n->string, strlen(n->string), 1))
                         n->flags |= MDOC_EOS;                          n->flags |= MDOC_EOS;
   
         /* Up-propogate the end-of-space flag. */          /* Up-propogate the end-of-space flag. */
Line 1235  blk_part_imp(MACRO_PROT_ARGS)
Line 1285  blk_part_imp(MACRO_PROT_ARGS)
                 if (MDOC_BLOCK == n->type &&                  if (MDOC_BLOCK == n->type &&
                     MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&                      MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
                     ! (MDOC_VALID & n->flags)) {                      ! (MDOC_VALID & n->flags)) {
                         assert( ! (MDOC_ACTED & n->flags));                          make_pending(n, tok, m, line, ppos);
                         if ( ! make_pending(n, tok, m, line, ppos))  
                                 return(0);  
                         if ( ! mdoc_endbody_alloc(m, line, ppos,                          if ( ! mdoc_endbody_alloc(m, line, ppos,
                             tok, body, ENDBODY_NOSPACE))                              tok, body, ENDBODY_NOSPACE))
                                 return(0);                                  return(0);
Line 1251  blk_part_imp(MACRO_PROT_ARGS)
Line 1299  blk_part_imp(MACRO_PROT_ARGS)
          * is ugly behaviour nodding its head to OpenBSD's overwhelming           * is ugly behaviour nodding its head to OpenBSD's overwhelming
          * crufty use of `Op' breakage.           * crufty use of `Op' breakage.
          */           */
         if (n != body && ! mdoc_vmsg(m, MANDOCERR_SCOPE, line, ppos,          if (n != body && ! mdoc_vmsg(m, MANDOCERR_SCOPENEST,
             "%s broken", mdoc_macronames[tok]))              line, ppos, "%s broken", mdoc_macronames[tok]))
                 return(0);                  return(0);
   
         if (n && ! rew_sub(MDOC_BODY, m, tok, line, ppos))          if (n && ! rew_sub(MDOC_BODY, m, tok, line, ppos))
Line 1533  in_line_eoln(MACRO_PROT_ARGS)
Line 1581  in_line_eoln(MACRO_PROT_ARGS)
   
         assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));          assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
   
           if (tok == MDOC_Pp)
                   rew_sub(MDOC_BLOCK, m, MDOC_Nm, line, ppos);
   
         /* Parse macro arguments. */          /* Parse macro arguments. */
   
         for (arg = NULL; ; ) {          for (arg = NULL; ; ) {
Line 1596  ctx_synopsis(MACRO_PROT_ARGS)
Line 1647  ctx_synopsis(MACRO_PROT_ARGS)
         nl = MDOC_NEWLINE & m->flags;          nl = MDOC_NEWLINE & m->flags;
   
         /* If we're not in the SYNOPSIS, go straight to in-line. */          /* If we're not in the SYNOPSIS, go straight to in-line. */
         if (SEC_SYNOPSIS != m->lastsec)          if ( ! (MDOC_SYNOPSIS & m->flags))
                 return(in_line(m, tok, line, ppos, pos, buf));                  return(in_line(m, tok, line, ppos, pos, buf));
   
         /* If we're a nested call, same place. */          /* If we're a nested call, same place. */
Line 1608  ctx_synopsis(MACRO_PROT_ARGS)
Line 1659  ctx_synopsis(MACRO_PROT_ARGS)
          * up formatting the block scope, then child nodes will inherit           * up formatting the block scope, then child nodes will inherit
          * the formatting.  Be careful.           * the formatting.  Be careful.
          */           */
           if (MDOC_Nm == tok)
                   return(blk_full(m, tok, line, ppos, pos, buf));
           assert(MDOC_Vt == tok);
         return(blk_part_imp(m, tok, line, ppos, pos, buf));          return(blk_part_imp(m, tok, line, ppos, pos, buf));
 }  }
   
Legend:
Removed from v.1.85  
changed lines
  Added in v.1.100
CVSweb