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

Diff for /mandoc/man_macro.c between version 1.10 and 1.80

version 1.10, 2009/03/27 14:56:15 version 1.80, 2013/12/31 23:23:10
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *   *
  * 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <stdio.h>  
 #include <string.h>  #include <string.h>
   
   #include "man.h"
   #include "mandoc.h"
   #include "libmandoc.h"
 #include "libman.h"  #include "libman.h"
   
 #define FL_NLINE        (1 << 0)  enum    rew {
 #define FL_TLINE        (1 << 1)          REW_REWIND,
           REW_NOHALT,
           REW_HALT
   };
   
   static  int              blk_close(MACRO_PROT_ARGS);
   static  int              blk_exp(MACRO_PROT_ARGS);
   static  int              blk_imp(MACRO_PROT_ARGS);
   static  int              in_line_eoln(MACRO_PROT_ARGS);
 static  int              man_args(struct man *, int,  static  int              man_args(struct man *, int,
                                 int *, char *, char **);                                  int *, char *, char **);
   
 static  int man_flags[MAN_MAX] = {  static  int              rew_scope(enum man_type,
         0, /* __ */                                  struct man *, enum mant);
         0, /* TH */  static  enum rew         rew_dohalt(enum mant, enum man_type,
         0, /* SH */                                  const struct man_node *);
         0, /* SS */  static  enum rew         rew_block(enum mant, enum man_type,
         FL_TLINE, /* TP */                                  const struct man_node *);
         0, /* LP */  static  void             rew_warn(struct man *,
         0, /* PP */                                  struct man_node *, enum mandocerr);
         0, /* P */  
         0, /* IP */  const   struct man_macro __man_macros[MAN_MAX] = {
         0, /* HP */          { in_line_eoln, MAN_NSCOPED }, /* br */
         FL_NLINE, /* SM */          { in_line_eoln, MAN_BSCOPE }, /* TH */
         FL_NLINE, /* SB */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
         FL_NLINE, /* BI */          { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
         FL_NLINE, /* IB */          { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
         FL_NLINE, /* BR */          { blk_imp, MAN_BSCOPE }, /* LP */
         FL_NLINE, /* RB */          { blk_imp, MAN_BSCOPE }, /* PP */
         FL_NLINE, /* R */          { blk_imp, MAN_BSCOPE }, /* P */
         FL_NLINE, /* B */          { blk_imp, MAN_BSCOPE }, /* IP */
         FL_NLINE, /* I */          { blk_imp, MAN_BSCOPE }, /* HP */
         FL_NLINE, /* IR */          { in_line_eoln, MAN_SCOPED }, /* SM */
         FL_NLINE, /* RI */          { in_line_eoln, MAN_SCOPED }, /* SB */
         0, /* br */          { in_line_eoln, 0 }, /* BI */
           { in_line_eoln, 0 }, /* IB */
           { in_line_eoln, 0 }, /* BR */
           { in_line_eoln, 0 }, /* RB */
           { in_line_eoln, MAN_SCOPED }, /* R */
           { in_line_eoln, MAN_SCOPED }, /* B */
           { in_line_eoln, MAN_SCOPED }, /* I */
           { in_line_eoln, 0 }, /* IR */
           { in_line_eoln, 0 }, /* RI */
           { in_line_eoln, MAN_NSCOPED }, /* na */
           { in_line_eoln, MAN_NSCOPED }, /* sp */
           { in_line_eoln, MAN_BSCOPE }, /* nf */
           { in_line_eoln, MAN_BSCOPE }, /* fi */
           { blk_close, 0 }, /* RE */
           { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
           { in_line_eoln, 0 }, /* DT */
           { in_line_eoln, 0 }, /* UC */
           { in_line_eoln, 0 }, /* PD */
           { in_line_eoln, 0 }, /* AT */
           { in_line_eoln, 0 }, /* in */
           { in_line_eoln, 0 }, /* ft */
           { in_line_eoln, 0 }, /* OP */
           { in_line_eoln, MAN_BSCOPE }, /* EX */
           { in_line_eoln, MAN_BSCOPE }, /* EE */
           { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
           { blk_close, 0 }, /* UE */
 };  };
   
   const   struct man_macro * const man_macros = __man_macros;
   
   
   /*
    * Warn when "n" is an explicit non-roff macro.
    */
   static void
   rew_warn(struct man *man, struct man_node *n, enum mandocerr er)
   {
   
           if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
                   return;
           if (MAN_VALID & n->flags)
                   return;
           if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
                   return;
   
           assert(er < MANDOCERR_FATAL);
           man_nmsg(man, n, er);
   }
   
   
   /*
    * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
    * will be used if an explicit block scope is being closed out.
    */
 int  int
 man_macro(struct man *man, int tok, int line,  man_unscope(struct man *man, const struct man_node *to,
                 int ppos, int *pos, char *buf)                  enum mandocerr er)
 {  {
         int              w, la;  
         char            *p;  
         struct man_node *n;          struct man_node *n;
   
         if ( ! man_elem_alloc(man, line, ppos, tok))          assert(to);
                 return(0);  
         n = man->last;  
         man->next = MAN_NEXT_CHILD;  
   
         for (;;) {          man->next = MAN_NEXT_SIBLING;
                 la = *pos;  
                 w = man_args(man, line, pos, buf, &p);  
   
                 if (-1 == w)          /* LINTED */
           while (man->last != to) {
                   /*
                    * Save the parent here, because we may delete the
                    * man->last node in the post-validation phase and reset
                    * it to man->last->parent, causing a step in the closing
                    * out to be lost.
                    */
                   n = man->last->parent;
                   rew_warn(man, man->last, er);
                   if ( ! man_valid_post(man))
                         return(0);                          return(0);
                 if (0 == w)                  man->last = n;
                         break;                  assert(man->last);
   
                 if ( ! man_word_alloc(man, line, la, p))  
                         return(0);  
                 man->next = MAN_NEXT_SIBLING;  
         }          }
   
         if (n == man->last && (FL_NLINE & man_flags[tok])) {          rew_warn(man, man->last, er);
                 if (MAN_NLINE & man->flags)          if ( ! man_valid_post(man))
                         return(man_verr(man, line, ppos,                  return(0);
                                 "next-line scope already open"));  
                 man->flags |= MAN_NLINE;  
                 return(1);  
         }  
   
         if (FL_TLINE & man_flags[tok]) {          return(1);
                 if (MAN_NLINE & man->flags)  }
                         return(man_verr(man, line, ppos,  
                                 "next-line scope already open"));  
                 man->flags |= MAN_NLINE;  static enum rew
                 return(1);  rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
   {
   
           if (MAN_BLOCK == type && ntok == n->parent->tok &&
                           MAN_BODY == n->parent->type)
                   return(REW_REWIND);
           return(ntok == n->tok ? REW_HALT : REW_NOHALT);
   }
   
   
   /*
    * There are three scope levels: scoped to the root (all), scoped to the
    * section (all less sections), and scoped to subsections (all less
    * sections and subsections).
    */
   static enum rew
   rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
   {
           enum rew         c;
   
           /* We cannot progress beyond the root ever. */
           if (MAN_ROOT == n->type)
                   return(REW_HALT);
   
           assert(n->parent);
   
           /* Normal nodes shouldn't go to the level of the root. */
           if (MAN_ROOT == n->parent->type)
                   return(REW_REWIND);
   
           /* Already-validated nodes should be closed out. */
           if (MAN_VALID & n->flags)
                   return(REW_NOHALT);
   
           /* First: rewind to ourselves. */
           if (type == n->type && tok == n->tok) {
                   if (MAN_EXPLICIT & man_macros[n->tok].flags)
                           return(REW_HALT);
                   else
                           return(REW_REWIND);
         }          }
   
         /*          /*
          * Note that when TH is pruned, we'll be back at the root, so           * Next follow the implicit scope-smashings as defined by man.7:
          * make sure that we don't clobber as its sibling.           * section, sub-section, etc.
          */           */
   
         for ( ; man->last; man->last = man->last->parent) {          switch (tok) {
                 if (man->last == n)          case (MAN_SH):
                         break;                  break;
                 if (man->last->type == MAN_ROOT)          case (MAN_SS):
                         break;                  /* Rewind to a section, if a block. */
                 if ( ! man_valid_post(man))                  if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                         return(0);                          return(c);
                 if ( ! man_action_post(man))                  break;
                         return(0);          case (MAN_RS):
                   /* Preserve empty paragraphs before RS. */
                   if (0 == n->nchild && (MAN_P == n->tok ||
                       MAN_PP == n->tok || MAN_LP == n->tok))
                           return(REW_HALT);
                   /* Rewind to a subsection, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                           return(c);
                   /* Rewind to a section, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                           return(c);
                   break;
           default:
                   /* Rewind to an offsetter, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
                           return(c);
                   /* Rewind to a subsection, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                           return(c);
                   /* Rewind to a section, if a block. */
                   if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                           return(c);
                   break;
         }          }
   
         assert(man->last);          return(REW_NOHALT);
   }
   
         /*  
          * Same here regarding whether we're back at the root.  /*
    * Rewinding entails ascending the parse tree until a coherent point,
    * for example, the `SH' macro will close out any intervening `SS'
    * scopes.  When a scope is closed, it must be validated and actioned.
    */
   static int
   rew_scope(enum man_type type, struct man *man, enum mant tok)
   {
           struct man_node *n;
           enum rew         c;
   
           /* LINTED */
           for (n = man->last; n; n = n->parent) {
                   /*
                    * Whether we should stop immediately (REW_HALT), stop
                    * and rewind until this point (REW_REWIND), or keep
                    * rewinding (REW_NOHALT).
                    */
                   c = rew_dohalt(tok, type, n);
                   if (REW_HALT == c)
                           return(1);
                   if (REW_REWIND == c)
                           break;
           }
   
           /*
            * Rewind until the current point.  Warn if we're a roff
            * instruction that's mowing over explicit scopes.
          */           */
           assert(n);
   
         if (man->last->type != MAN_ROOT && ! man_valid_post(man))          return(man_unscope(man, n, MANDOCERR_MAX));
                 return(0);  }
         if (man->last->type != MAN_ROOT && ! man_action_post(man))  
                 return(0);  
         if (man->last->type != MAN_ROOT)  
                 man->next = MAN_NEXT_SIBLING;  
   
   
   /*
    * Close out a generic explicit macro.
    */
   /* ARGSUSED */
   int
   blk_close(MACRO_PROT_ARGS)
   {
           enum mant                ntok;
           const struct man_node   *nn;
   
           switch (tok) {
           case (MAN_RE):
                   ntok = MAN_RS;
                   break;
           case (MAN_UE):
                   ntok = MAN_UR;
                   break;
           default:
                   abort();
                   /* NOTREACHED */
           }
   
           for (nn = man->last->parent; nn; nn = nn->parent)
                   if (ntok == nn->tok && MAN_BLOCK == nn->type)
                           break;
   
           if (NULL == nn) {
                   man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
                   if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
                           return(0);
           } else
                   man_unscope(man, nn, MANDOCERR_MAX);
   
         return(1);          return(1);
 }  }
   
   
   /* ARGSUSED */
 int  int
 man_macroend(struct man *m)  blk_exp(MACRO_PROT_ARGS)
 {  {
           struct man_node *n;
           int              la;
           char            *p;
   
         for ( ; m->last && m->last != m->first;          /* Close out prior implicit scopes. */
                         m->last = m->last->parent) {  
                 if ( ! man_valid_post(m))  
                         return(0);  
                 if ( ! man_action_post(m))  
                         return(0);  
         }  
         assert(m->last == m->first);  
   
         if ( ! man_valid_post(m))          if ( ! rew_scope(MAN_BLOCK, man, tok))
                 return(0);                  return(0);
         if ( ! man_action_post(m))  
           if ( ! man_block_alloc(man, line, ppos, tok))
                 return(0);                  return(0);
           if ( ! man_head_alloc(man, line, ppos, tok))
                   return(0);
   
         return(1);          for (;;) {
                   la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   if ( ! man_word_alloc(man, line, la, p))
                           return(0);
           }
   
           assert(man);
           assert(tok != MAN_MAX);
   
           for (n = man->last; n; n = n->parent) {
                   if (n->tok != tok)
                           continue;
                   assert(MAN_HEAD == n->type);
                   man_unscope(man, n, MANDOCERR_MAX);
                   break;
           }
   
           return(man_body_alloc(man, line, ppos, tok));
 }  }
   
   
   
   /*
    * Parse an implicit-block macro.  These contain a MAN_HEAD and a
    * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
    * scopes, such as `SH' closing out an `SS', are defined in the rew
    * routines.
    */
 /* ARGSUSED */  /* ARGSUSED */
 static int  int
 man_args(struct man *m, int line,  blk_imp(MACRO_PROT_ARGS)
                 int *pos, char *buf, char **v)  
 {  {
           int              la;
           char            *p;
           struct man_node *n;
   
         if (0 == buf[*pos])          /* Close out prior scopes. */
   
           if ( ! rew_scope(MAN_BODY, man, tok))
                 return(0);                  return(0);
           if ( ! rew_scope(MAN_BLOCK, man, tok))
                   return(0);
   
         /* First parse non-quoted strings. */          /* Allocate new block & head scope. */
   
         if ('\"' != buf[*pos]) {          if ( ! man_block_alloc(man, line, ppos, tok))
                 *v = &buf[*pos];                  return(0);
           if ( ! man_head_alloc(man, line, ppos, tok))
                   return(0);
   
                 while (buf[*pos]) {          n = man->last;
                         if (' ' == buf[*pos])  
                                 if ('\\' != buf[*pos - 1])  
                                         break;  
                         (*pos)++;  
                 }  
   
                 if (0 == buf[*pos])          /* Add line arguments. */
                         return(1);  
   
                 buf[(*pos)++] = 0;          for (;;) {
                   la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   if ( ! man_word_alloc(man, line, la, p))
                           return(0);
           }
   
                 if (0 == buf[*pos])          /* Close out head and open body (unless MAN_SCOPE). */
   
           if (MAN_SCOPED & man_macros[tok].flags) {
                   /* If we're forcing scope (`TP'), keep it open. */
                   if (MAN_FSCOPED & man_macros[tok].flags) {
                           man->flags |= MAN_BLINE;
                         return(1);                          return(1);
                   } else if (n == man->last) {
                           man->flags |= MAN_BLINE;
                           return(1);
                   }
           }
   
                 while (buf[*pos] && ' ' == buf[*pos])          if ( ! rew_scope(MAN_HEAD, man, tok))
                         (*pos)++;                  return(0);
           return(man_body_alloc(man, line, ppos, tok));
   }
   
                 if (buf[*pos])  
                         return(1);  
   
                 if ( ! man_vwarn(m, line, *pos, "trailing spaces"))  /* ARGSUSED */
                         return(-1);  int
   in_line_eoln(MACRO_PROT_ARGS)
   {
           int              la;
           char            *p;
           struct man_node *n;
   
                 return(1);          if ( ! man_elem_alloc(man, line, ppos, tok))
                   return(0);
   
           n = man->last;
   
           for (;;) {
                   la = *pos;
                   if ( ! man_args(man, line, pos, buf, &p))
                           break;
                   if ( ! man_word_alloc(man, line, la, p))
                           return(0);
         }          }
   
         /*          /*
          * If we're a quoted string (and quoted strings are allowed),           * Append MAN_EOS in case the last snipped argument
          * then parse ahead to the next quote.  If none's found, it's an           * ends with a dot, e.g. `.IR syslog (3).'
          * error.  After, parse to the next word.  
          */           */
   
         *v = &buf[++(*pos)];          if (n != man->last &&
               mandoc_eos(man->last->string, strlen(man->last->string)))
                   man->last->flags |= MAN_EOS;
   
         while (buf[*pos] && '\"' != buf[*pos])          /*
                 (*pos)++;           * If no arguments are specified and this is MAN_SCOPED (i.e.,
            * next-line scoped), then set our mode to indicate that we're
            * waiting for terms to load into our context.
            */
   
         if (0 == buf[*pos]) {          if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
                 if ( ! man_vwarn(m, line, *pos, "unterminated quote"))                  assert( ! (MAN_NSCOPED & man_macros[tok].flags));
                         return(-1);                  man->flags |= MAN_ELINE;
                 return(1);                  return(1);
           }
   
           /* Set ignorable context, if applicable. */
   
           if (MAN_NSCOPED & man_macros[tok].flags) {
                   assert( ! (MAN_SCOPED & man_macros[tok].flags));
                   man->flags |= MAN_ILINE;
         }          }
   
         buf[(*pos)++] = 0;          assert(MAN_ROOT != man->last->type);
         if (0 == buf[*pos])          man->next = MAN_NEXT_SIBLING;
                 return(1);  
           /*
            * Rewind our element scope.  Note that when TH is pruned, we'll
            * be back at the root, so make sure that we don't clobber as
            * its sibling.
            */
   
         while (buf[*pos] && ' ' == buf[*pos])          for ( ; man->last; man->last = man->last->parent) {
                 (*pos)++;                  if (man->last == n)
                           break;
                   if (man->last->type == MAN_ROOT)
                           break;
                   if ( ! man_valid_post(man))
                           return(0);
           }
   
         if (buf[*pos])          assert(man->last);
                 return(1);  
   
         if ( ! man_vwarn(m, line, *pos, "trailing spaces"))          /*
                 return(-1);           * Same here regarding whether we're back at the root.
            */
   
           if (man->last->type != MAN_ROOT && ! man_valid_post(man))
                   return(0);
   
           return(1);
   }
   
   
   int
   man_macroend(struct man *man)
   {
   
           return(man_unscope(man, man->first, MANDOCERR_SCOPEEXIT));
   }
   
   static int
   man_args(struct man *man, int line, int *pos, char *buf, char **v)
   {
           char     *start;
   
           assert(*pos);
           *v = start = buf + *pos;
           assert(' ' != *start);
   
           if ('\0' == *start)
                   return(0);
   
           *v = mandoc_getarg(man->parse, v, line, pos);
         return(1);          return(1);
 }  }
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.80
CVSweb