1/*
2 * [The "BSD license"]
3 *  Copyright (c) 2010 Terence Parr
4 *  All rights reserved.
5 *
6 *  Redistribution and use in source and binary forms, with or without
7 *  modification, are permitted provided that the following conditions
8 *  are met:
9 *  1. Redistributions of source code must retain the above copyright
10 *      notice, this list of conditions and the following disclaimer.
11 *  2. Redistributions in binary form must reproduce the above copyright
12 *      notice, this list of conditions and the following disclaimer in the
13 *      documentation and/or other materials provided with the distribution.
14 *  3. The name of the author may not be used to endorse or promote products
15 *      derived from this software without specific prior written permission.
16 *
17 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28package org.antlr.tool;
29
30import org.antlr.analysis.DFAState;
31import org.antlr.analysis.DecisionProbe;
32import org.stringtemplate.v4.ST;
33
34import java.util.Collection;
35import java.util.List;
36
37/** Indicates recursion overflow.  A DFA state tried add an NFA configuration
38 *  with NFA state p that was mentioned in its stack context too many times.
39 */
40public class RecursionOverflowMessage extends Message {
41	public DecisionProbe probe;
42	public DFAState sampleBadState;
43	public int alt;
44	public Collection targetRules;
45	public Collection callSiteStates;
46
47	public RecursionOverflowMessage(DecisionProbe probe,
48									DFAState sampleBadState,
49									int alt,
50									Collection targetRules,
51									Collection callSiteStates)
52	{
53		super(ErrorManager.MSG_RECURSION_OVERLOW);
54		this.probe = probe;
55		this.sampleBadState = sampleBadState;
56		this.alt = alt;
57		this.targetRules = targetRules;
58		this.callSiteStates = callSiteStates;
59	}
60
61	public String toString() {
62		GrammarAST decisionASTNode = probe.dfa.getDecisionASTNode();
63		line = decisionASTNode.getLine();
64		column = decisionASTNode.getCharPositionInLine();
65		String fileName = probe.dfa.nfa.grammar.getFileName();
66		if ( fileName!=null ) {
67			file = fileName;
68		}
69
70		ST st = getMessageTemplate();
71		st.add("targetRules", targetRules);
72		st.add("alt", alt);
73		st.add("callSiteStates", callSiteStates);
74
75		List labels =
76			probe.getSampleNonDeterministicInputSequence(sampleBadState);
77		String input = probe.getInputSequenceDisplay(labels);
78		st.add("input", input);
79
80		return super.toString(st);
81	}
82
83}
84