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    using System.Collections.Generic;
35    using Exception = System.Exception;
36    using SerializationInfo = System.Runtime.Serialization.SerializationInfo;
37    using StreamingContext = System.Runtime.Serialization.StreamingContext;
38
39    /** <summary>
40     *  We were expecting a token but it's not found.  The current token
41     *  is actually what we wanted next.  Used for tree node errors too.
42     *  </summary>
43     */
44    [System.Serializable]
45    public class MissingTokenException : MismatchedTokenException {
46        private readonly object _inserted;
47
48        public MissingTokenException() {
49        }
50
51        public MissingTokenException(string message)
52            : base(message) {
53        }
54
55        public MissingTokenException(string message, Exception innerException)
56            : base(message, innerException) {
57        }
58
59        public MissingTokenException(int expecting, IIntStream input, object inserted)
60            : this(expecting, input, inserted, null) {
61        }
62
63        public MissingTokenException(int expecting, IIntStream input, object inserted, IList<string> tokenNames)
64            : base(expecting, input, tokenNames) {
65            this._inserted = inserted;
66        }
67
68        public MissingTokenException(string message, int expecting, IIntStream input, object inserted, IList<string> tokenNames)
69            : base(message, expecting, input, tokenNames) {
70            this._inserted = inserted;
71        }
72
73        public MissingTokenException(string message, int expecting, IIntStream input, object inserted, IList<string> tokenNames, Exception innerException)
74            : base(message, expecting, input, tokenNames, innerException) {
75            this._inserted = inserted;
76        }
77
78        protected MissingTokenException(SerializationInfo info, StreamingContext context)
79            : base(info, context) {
80        }
81
82        public virtual int MissingType {
83            get {
84                return Expecting;
85            }
86        }
87
88        public override string ToString() {
89            if (_inserted != null && Token != null) {
90                return "MissingTokenException(inserted " + _inserted + " at " + Token.Text + ")";
91            }
92            if (Token != null) {
93                return "MissingTokenException(at " + Token.Text + ")";
94            }
95            return "MissingTokenException";
96        }
97    }
98}
99