1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD license"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2010 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.tool; 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.antlr.runtime.RecognitionException; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.antlr.runtime.Token; 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport org.stringtemplate.v4.ST; 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A problem with the syntax of your antlr grammar such as 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * "The '{' came as a complete surprise to me at this point in your program" 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic class GrammarSyntaxMessage extends Message { 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Grammar g; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Most of the time, we'll have a token and so this will be set. */ 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Token offendingToken; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public RecognitionException exception; 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public GrammarSyntaxMessage(int msgID, 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Grammar grammar, 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Token offendingToken, 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver RecognitionException exception) 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this(msgID,grammar,offendingToken,null,exception); 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public GrammarSyntaxMessage(int msgID, 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Grammar grammar, 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Token offendingToken, 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Object arg, 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver RecognitionException exception) 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super(msgID, arg, null); 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.offendingToken = offendingToken; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.exception = exception; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.g = grammar; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String toString() { 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver line = 0; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver column = 0; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( offendingToken!=null ) { 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver line = offendingToken.getLine(); 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver column = offendingToken.getCharPositionInLine(); 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // TODO: actually set the right Grammar instance to get the filename 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // TODO: have to update all v2 grammar files for this. or use errormanager and tool to get the current grammar 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (g != null) { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver file = g.getFileName(); 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ST st = getMessageTemplate(); 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( arg!=null ) { 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver st.add("arg", arg); 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return super.toString(st); 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 82