/*
 * [The "BSD licence"]
 * Copyright (c) 2005-2008 Terence Parr
 * All rights reserved.
 *
 * Conversion to C#:
 * Copyright (c) 2008 Sam Harwell, Pixel Mine, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

namespace Antlr.Runtime
{
    using ArgumentNullException = System.ArgumentNullException;
    using Exception = System.Exception;
    using SerializationInfo = System.Runtime.Serialization.SerializationInfo;
    using StreamingContext = System.Runtime.Serialization.StreamingContext;

    /** <summary>
     *  A semantic predicate failed during validation.  Validation of predicates
     *  occurs when normally parsing the alternative just like matching a token.
     *  Disambiguating predicate evaluation occurs when we hoist a predicate into
     *  a prediction decision.
     *  </summary>
     */
    [System.Serializable]
    public class FailedPredicateException : RecognitionException
    {
        private readonly string _ruleName;
        private readonly string _predicateText;

        public FailedPredicateException()
        {
        }

        public FailedPredicateException(string message)
            : base(message)
        {
        }

        public FailedPredicateException(string message, Exception innerException)
            : base(message, innerException)
        {
        }

        public FailedPredicateException(IIntStream input, string ruleName, string predicateText)
            : base(input)
        {
            this._ruleName = ruleName;
            this._predicateText = predicateText;
        }

        public FailedPredicateException(string message, IIntStream input, string ruleName, string predicateText)
            : base(message, input)
        {
            this._ruleName = ruleName;
            this._predicateText = predicateText;
        }

        public FailedPredicateException(string message, IIntStream input, string ruleName, string predicateText, Exception innerException)
            : base(message, input, innerException)
        {
            this._ruleName = ruleName;
            this._predicateText = predicateText;
        }

        protected FailedPredicateException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
            if (info == null)
                throw new ArgumentNullException("info");

            this._ruleName = info.GetString("RuleName");
            this._predicateText = info.GetString("PredicateText");
        }

        public string RuleName
        {
            get
            {
                return _ruleName;
            }
        }

        public string PredicateText
        {
            get
            {
                return _predicateText;
            }
        }

        public override void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            if (info == null)
                throw new ArgumentNullException("info");

            base.GetObjectData(info, context);
            info.AddValue("RuleName", _ruleName);
            info.AddValue("PredicateText", _predicateText);
        }

        public override string ToString()
        {
            return "FailedPredicateException(" + RuleName + ",{" + PredicateText + "}?)";
        }
    }
}