/*
   XBN Java:  Generically useful, non-GUI Java code.
   http://sourceforge.net/projects/xbnjava

   Copyright (C) 1997-2003, Jeff Epstein
   All rights reserved.

   Modifications: No

   Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:

      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
      * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
      * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   [NOTE:  This license contains NO advertising clause.]
 */
package xbn.config;
   import xbn.XBNObject;
   import xbn.string.escape.USCIgnore;

/**
   <P>Configuration related to unescaping configuration variable names and values.  Provided to <A HREF="~JD~cr~EJD~">ConfigReader</A> via <A HREF="~JD~crc~EJD~">CRConfig</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/config/CRCVUnescape.java">CRCVUnescape.java</A></I></CODE></P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public class CRCVUnescape extends XBNObject  {
   private USCIgnore usci = null;
   private char cEscape = ' ';

   /**
      <P>Create a CRCVUnescape with default values.</P>

      <P>Equal to <CODE><A HREF="~JD~crcvu(c)~EJD~">CRCVUnescape</A>('\\\\')</CODE></P>
    **/
   public CRCVUnescape()  {
      this('\\');
   }

   /**
      <P>Create a CRCVUnescape.</P>

      <P>Equal to <CODE><A HREF="~JD~crcvu(usci,c)~EJD~">CRCVUnescape</A>(usc_ignore, '\\\\')</CODE></P>
    **/
   public CRCVUnescape(USCIgnore usc_ignore)  {
      this(usc_ignore, '\\');
   }

   /**
      <P>Create a CRCVUnescape.</P>

      <P>Equal to <CODE><A HREF="~JD~crcvu(usci,c)~EJD~">CRCVUnescape</A>((new <A HREF="~JD~usci#usci()~EJD~">USCIgnore</A>()), '\\\\')</CODE></P>
    **/
   public CRCVUnescape(char c_escape)  {
      this((new USCIgnore()), c_escape);
   }

   /**
      <P>Create a CRCVUnescape.</P>

      <P>The restrictions on these parameters are verified in the <A HREF="~JD~crc~EJD~">CRConfig</A> <A HREF="~JD~crc#crc(crcd,crcv)~EJD~">constructor</A> and <A HREF="~JD~crlao~EJD~">CRLAObjects</A> <A HREF="~JD~crlao#crlao(crc)~EJD~">constructor</A>.</P>

      @param  usc_ignore  Defines how to deal with escaped characters <I>other</I> than...<UL>
         <LI>...delimiters defined in <A HREF="~JD~crcd~EJD~">CRCVDelimiters</A></LI>
         <LI>...<A HREF="~JD~crcvt~EJD~">CRCVTrim</A>'s <A HREF="~JD~crcvt~EJD~#getESChar()">special empty-space character</A></LI>
         <LI>...c_escape</LI>
      </UL>.  May not be null and no character in <CODE>usc_ignore.<A HREF="~JD~usci~EJD~#getAPCIgnore()">getAPCIgnore</A>()</CODE> may equal to any in CRCVDelimiters, CRCVTrim, or c_escape.  See <A HREF="#getUSCIgnore()">getUSCIgnore</A>.
      @param  c_escape  The escape character.  May not equal any character in usc_ignore getAPCIgnore, nor any characters in crc_variable or crc_comment.
    **/
   public CRCVUnescape(USCIgnore usc_ignore, char c_escape)  {
      throwAXIfNull(usc_ignore, "usc_ignore", sCNSTR);
      usci = usc_ignore;
      cEscape = c_escape;
   }


   /**
      <P>Get the USCIgnore for direct manipulation.</P>

      @return <B>usc_ignore</B>  Exactly as provided to the <A HREF="~JD~crcvu(usci,c)~EJD~">constructor</A>.
    **/
   public final USCIgnore getUSCIgnore()  {
      return usci;
   }

   /**
      <P>What is the character used to escape other characters?</P>

      <P>When this procedes another character, it is said to be "escaped".  The escape character is traditionally the 'up-left' slash ('\\').</P>

      @return <B>c_escape</B>  Exactly as provided to the <A HREF="~JD~crcvu(usci,c)~EJD~">constructor</A>.
    **/
   public final char getEscapeChar()  {
      return cEscape;
   }

   /**
      <P>Get some information about this CRCVUnescape.</P>
    **/
   public String toString()  {
      return this.getClass().getName() + ":  [" + getUSCIgnore().toString() + "], getEscapeChar()='" + getEscapeChar() + "'";
   }
}