antlr.v4.runtime.atn.ErrorInfo source code

1 /*
2  * [The "BSD license"]
3  *  Copyright (c) 2014 Terence Parr
4  *  Copyright (c) 2014 Sam Harwell
5  *  Copyright (c) 2017 Egbert Voigt
6  *  All rights reserved.
7  *
8  *  Redistribution and use in source and binary forms, with or without
9  *  modification, are permitted provided that the following conditions
10  *  are met:
11  *
12  *  1. Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  *  2. Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution.
17  *  3. The name of the author may not be used to endorse or promote products
18  *     derived from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 module antlr.v4.runtime.atn.ErrorInfo;
33 
34 import antlr.v4.runtime.TokenStream;
35 import antlr.v4.runtime.atn.DecisionEventInfo;
36 import antlr.v4.runtime.atn.ATNConfigSet;
37 
38 // Class ErrorInfo
39 /**
40  * @uml
41  * This class represents profiling event information for a syntax error
42  * identified during prediction. Syntax errors occur when the prediction
43  * algorithm is unable to identify an alternative which would lead to a
44  * successful parse.
45  *
46  *  @see Parser#notifyErrorListeners(Token, String, RecognitionException)
47  *  @see ANTLRErrorListener#syntaxError
48  */
49 class ErrorInfo : DecisionEventInfo
50 {
51 
52     /**
53      * @uml
54      * Constructs a new instance of the {@link ErrorInfo} class with the
55      *  specified detailed syntax error information.
56      *
57      *  @param decision The decision number
58      *  @param configs The final configuration set reached during prediction
59      *  prior to reaching the {@link ATNSimulator#ERROR} state
60      *  @param input The input token stream
61      *  @param startIndex The start index for the current prediction
62      *  @param stopIndex The index at which the syntax error was identified
63      *  @param fullCtx {@code true} if the syntax error was identified during LL
64      *  prediction; otherwise, {@code false} if the syntax error was identified
65      *  during SLL prediction
66      */
67     public this(int decision, ATNConfigSet configs, TokenStream input, int startIndex, int stopIndex,
68         bool fullCtx)
69     {
70         super(decision, configs, input, startIndex, stopIndex, fullCtx);
71     }
72 
73 }