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.RecognitionException; 31import org.antlr.runtime.Token; 32import org.stringtemplate.v4.ST; 33 34/** A problem with the syntax of your antlr grammar such as 35 * "The '{' came as a complete surprise to me at this point in your program" 36 */ 37public class GrammarSyntaxMessage extends Message { 38 public Grammar g; 39 /** Most of the time, we'll have a token and so this will be set. */ 40 public Token offendingToken; 41 public RecognitionException exception; 42 43 public GrammarSyntaxMessage(int msgID, 44 Grammar grammar, 45 Token offendingToken, 46 RecognitionException exception) 47 { 48 this(msgID,grammar,offendingToken,null,exception); 49 } 50 51 public GrammarSyntaxMessage(int msgID, 52 Grammar grammar, 53 Token offendingToken, 54 Object arg, 55 RecognitionException exception) 56 { 57 super(msgID, arg, null); 58 this.offendingToken = offendingToken; 59 this.exception = exception; 60 this.g = grammar; 61 } 62 63 public String toString() { 64 line = 0; 65 column = 0; 66 if ( offendingToken!=null ) { 67 line = offendingToken.getLine(); 68 column = offendingToken.getCharPositionInLine(); 69 } 70 // TODO: actually set the right Grammar instance to get the filename 71 // TODO: have to update all v2 grammar files for this. or use errormanager and tool to get the current grammar 72 if (g != null) { 73 file = g.getFileName(); 74 } 75 ST st = getMessageTemplate(); 76 if ( arg!=null ) { 77 st.add("arg", arg); 78 } 79 return super.toString(st); 80 } 81} 82