/*
 *  gnu/regexp/REException.java
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

package gnu.regexp;

/**
 * This is the regular expression exception class.  An exception of this type
 * defines the three attributes:
 * <OL>
 * <LI> A descriptive message of the error.
 * <LI> An integral type code equivalent to one of the statically
 *      defined symbols listed below.
 * <LI> The approximate position in the input string where the error
 *      occurred.
 * </OL>
 *
 * @author	Wes Biggs
 * @version	1.00
**/

public class REException extends Exception implements java.io.Serializable
{
  private int m_type;
  private int m_pos;

  // Error conditions from GNU regcomp(3) manual

  /**
   * Error flag.
   * Invalid use of repetition operators such  as  using
   * `*' as the first character.
   **/

  public static final int REG_BADRPT  =  1;
  /**
   * Error flag.
   * Invalid use of back reference operator.
   **/

  public static final int REG_BADBR   =  2;
  /**
   * Error flag.
   * Un-matched brace interval operators.
   **/

  public static final int REG_EBRACE  =  3;
  /**
   * Error flag.
   * Un-matched bracket list operators.
   **/

  public static final int REG_EBRACK  =  4;
  /**
   * Error flag.
   * Invalid  use  of the range operator, eg. the ending
   * point of the range occurs  prior  to  the  starting
   * point.
   **/

  public static final int REG_ERANGE  =  5;
  /**
   * Error flag.
   * Unknown character class name. <B>Not implemented</B>.
   **/

  public static final int REG_ECTYPE  =  6;
  /**
   * Error flag.
   * Un-matched parenthesis group operators.
   **/

  public static final int REG_EPAREN  =  7;
  /**
   * Error flag.
   * Invalid back reference to a subexpression.
   **/

  public static final int REG_ESUBREG =  8;
  /**
   * Error flag.
   * Non specific error. <B>Not implemented</B>.
   **/

  public static final int REG_EEND    =  9;
  /**
   * Error flag.
   * Invalid escape sequence. <B>Not implemented</B>.
   **/

  public static final int REG_ESCAPE  = 10;
  /**
   * Error flag.
   * Invalid  use  of pattern operators such as group or list.
   **/

  public static final int REG_BADPAT  = 11;
  /**
   * Error flag.
   * Compiled  regular  expression  requires  a  pattern
   * buffer larger than 64Kb. <B>Not implemented</B>.
   **/

  public static final int REG_ESIZE   = 12;
  /**
   * Error flag.
   * The regex routines ran out of memory. <B>Not implemented</B>.
   **/

  public static final int REG_ESPACE  = 13;

  REException(String msg, int type, int position)
  { 
    super(msg); 
    m_type = type;
    m_pos = position;
  }

  /**
   * Returns the type of the exception, one of the constants listed above.
   **/

  public int getType()
  {
    return m_type;
  }

  /**
   * Returns the position, relative to the string or character array being
   * compiled, where the error occurred.  This position is generally the point
   * where the error was detected, not necessarily the starting index of
   * a bad subexpression.
   **/

  public int getPosition()
  {
    return m_pos;
  }

  /**
   * Reports the descriptive message associated with this exception
   * as well as its index position in the string or character array
   * being compiled.
   **/

  public String getMessage()
  {
    StringBuffer sb = new StringBuffer();
    sb.append("At position "+m_pos+" in regular expression pattern: ");
    sb.append('\n');
    sb.append(super.getMessage());
    return sb.toString();
  }
}
