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.runtime.Token;
31import org.stringtemplate.v4.ST;
32
33/** A problem with the symbols and/or meaning of a grammar such as rule
34 *  redefinition.
35 */
36public class GrammarSemanticsMessage extends Message {
37	public Grammar g;
38	/** Most of the time, we'll have a token such as an undefined rule ref
39	 *  and so this will be set.
40	 */
41	public Token offendingToken;
42
43	public GrammarSemanticsMessage(int msgID,
44						  Grammar g,
45						  Token offendingToken)
46	{
47		this(msgID,g,offendingToken,null,null);
48	}
49
50	public GrammarSemanticsMessage(int msgID,
51						  Grammar g,
52						  Token offendingToken,
53						  Object arg)
54	{
55		this(msgID,g,offendingToken,arg,null);
56	}
57
58	public GrammarSemanticsMessage(int msgID,
59						  Grammar g,
60						  Token offendingToken,
61						  Object arg,
62						  Object arg2)
63	{
64		super(msgID,arg,arg2);
65		this.g = g;
66		this.offendingToken = offendingToken;
67	}
68
69	public String toString() {
70		line = 0;
71		column = 0;
72		if ( offendingToken!=null ) {
73			line = offendingToken.getLine();
74			column = offendingToken.getCharPositionInLine();
75		}
76		if ( g!=null ) {
77			file = g.getFileName();
78		}
79		ST st = getMessageTemplate();
80		if ( arg!=null ) {
81			st.add("arg", arg);
82		}
83		if ( arg2!=null ) {
84			st.add("arg2", arg2);
85		}
86		return super.toString(st);
87	}
88}
89