1/*
2 * [The "BSD licence"]
3 * Copyright (c) 2005-2008 Terence Parr
4 * All rights reserved.
5 *
6 * Conversion to C#:
7 * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc.
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 *    derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33namespace Antlr.Runtime
34{
35    using System.Collections.Generic;
36    using Exception = System.Exception;
37    using SerializationInfo = System.Runtime.Serialization.SerializationInfo;
38    using StreamingContext = System.Runtime.Serialization.StreamingContext;
39
40    /** <summary>An extra token while parsing a TokenStream</summary> */
41    [System.Serializable]
42    public class UnwantedTokenException : MismatchedTokenException
43    {
44        public UnwantedTokenException()
45        {
46        }
47
48        public UnwantedTokenException(string message)
49            : base(message)
50        {
51        }
52
53        public UnwantedTokenException(string message, Exception innerException)
54            : base(message, innerException)
55        {
56        }
57
58        public UnwantedTokenException(int expecting, IIntStream input)
59            : base(expecting, input)
60        {
61        }
62
63        public UnwantedTokenException(int expecting, IIntStream input, IList<string> tokenNames)
64            : base(expecting, input, tokenNames)
65        {
66        }
67
68        public UnwantedTokenException(string message, int expecting, IIntStream input, IList<string> tokenNames)
69            : base(message, expecting, input, tokenNames)
70        {
71        }
72
73        public UnwantedTokenException(string message, int expecting, IIntStream input, IList<string> tokenNames, Exception innerException)
74            : base(message, expecting, input, tokenNames, innerException)
75        {
76        }
77
78        protected UnwantedTokenException(SerializationInfo info, StreamingContext context)
79            : base(info, context)
80        {
81        }
82
83        public virtual IToken UnexpectedToken
84        {
85            get
86            {
87                return Token;
88            }
89        }
90
91        public override string ToString()
92        {
93            //int unexpectedType = getUnexpectedType();
94            //string unexpected = ( tokenNames != null && unexpectedType >= 0 && unexpectedType < tokenNames.Length ) ? tokenNames[unexpectedType] : unexpectedType.ToString();
95            string expected = (TokenNames != null && Expecting >= 0 && Expecting < TokenNames.Count) ? TokenNames[Expecting] : Expecting.ToString();
96
97            string exp = ", expected " + expected;
98            if (Expecting == TokenTypes.Invalid)
99            {
100                exp = "";
101            }
102            if (Token == null)
103            {
104                return "UnwantedTokenException(found=" + null + exp + ")";
105            }
106            return "UnwantedTokenException(found=" + Token.Text + exp + ")";
107        }
108    }
109}
110