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.stringtemplate.v4.ST; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** The ANTLR code calls methods on ErrorManager to report errors etc... 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Rather than simply pass these arguments to the ANTLRErrorListener directly, 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * create an object that encapsulates everything. In this way, the error 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * listener interface does not have to change when I add a new kind of 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * error message. I don't want to break a GUI for example every time 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I update the error system in ANTLR itself. 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * To get a printable error/warning message, call toString(). 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic abstract class Message { 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // msgST is the actual text of the message 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST msgST; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // these are for supporting different output formats 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST locationST; 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST reportST; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST messageFormatST; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int msgID; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Object arg; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Object arg2; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Throwable e; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // used for location template 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String file; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int line = -1; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int column = -1; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Message() { 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Message(int msgID) { 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this(msgID, null, null); 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Message(int msgID, Object arg, Object arg2) { 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver setMessageID(msgID); 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.arg = arg; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.arg2 = arg2; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setLine(int line) { 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.line = line; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setColumn(int column) { 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.column = column; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setMessageID(int msgID) { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.msgID = msgID; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver msgST = ErrorManager.getMessage(msgID); 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return a new template instance every time someone tries to print 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a Message. 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST getMessageTemplate() { return new ST(msgST); } 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return a new template instance for the location part of a Message. 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * TODO: Is this really necessary? -Kay 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ST getLocationTemplate() { return new ST(locationST); } 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String toString(ST messageST) { 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // setup the location 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationST = ErrorManager.getLocationFormat(); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportST = ErrorManager.getReportFormat(); 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver messageFormatST = ErrorManager.getMessageFormat(); 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver boolean locationValid = false; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (line != -1) { 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationST.add("line", line); 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationValid = true; 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (column != -1) { 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationST.add("column", column+1); 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationValid = true; 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (file != null) { 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationST.add("file", file); 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver locationValid = true; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver messageFormatST.add("id", msgID); 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver messageFormatST.add("text", messageST); 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (locationValid) { 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportST.add("location", locationST); 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportST.add("message", messageFormatST); 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver reportST.add("type", ErrorManager.getMessageType(msgID)); 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return reportST.render(); 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 125