antlr.v4.runtime.atn.LookaheadEventInfo source code

1 /*
2  * [The "BSD license"]
3  *  Copyright (c) 2014 Terence Parr
4  *  Copyright (c) 2014 Sam Harwell
5  *  All rights reserved.
6  *
7  *  Redistribution and use in source and binary forms, with or without
8  *  modification, are permitted provided that the following conditions
9  *  are met:
10  *
11  *  1. Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  *  2. Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  *  3. The name of the author may not be used to endorse or promote products
17  *     derived from this software without specific prior written permission.
18  *
19  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 module antlr.v4.runtime.atn.LookaheadEventInfo;
32 
33 import antlr.v4.runtime.TokenStream;
34 import antlr.v4.runtime.atn.ATNConfigSet;
35 import antlr.v4.runtime.atn.DecisionEventInfo;
36 
37 /**
38  * This class represents profiling event information for tracking the lookahead
39  * depth required in order to make a prediction.
40  */
41 class LookaheadEventInfo : DecisionEventInfo
42 {
43 
44     /**
45      *  the outermost alt shown for a rule; left-recursive rules have
46      *  user-level alts that differ from the rewritten rule with a (...) block
47      *  and a (..)* loop.
48      */
49     public int predictedAlt;
50 
51     /**
52      * Constructs a new instance of the {@link LookaheadEventInfo} class with
53      * the specified detailed lookahead information.
54      *
55      * @param decision The decision number
56      * @param configs The final configuration set containing the necessary
57      * information to determine the result of a prediction, or {@code null} if
58      * the final configuration set is not available
59      * @param input The input token stream
60      * @param startIndex The start index for the current prediction
61      * @param stopIndex The index at which the prediction was finally made
62      * @param fullCtx {@code true} if the current lookahead is part of an LL
63      * prediction; otherwise, {@code false} if the current lookahead is part of
64      * an SLL prediction
65      */
66     public this(int decision, ATNConfigSet configs, int predictedAlt, TokenStream input, size_t startIndex,
67                 size_t stopIndex, bool fullCtx)
68     {
69 	super(decision, configs, input, startIndex, stopIndex, fullCtx);
70         this.predictedAlt = predictedAlt;
71     }
72 
73 }