1 files changed, 130 insertions, 0 deletions
diff --git a/tool/src/org/antlr/v4/tool/ANTLRMessage.java b/tool/src/org/antlr/v4/tool/ANTLRMessage.java
new file mode 100644
index 0000000..36d9ab9
--- /dev/null
+++ b/tool/src/org/antlr/v4/tool/ANTLRMessage.java
@@ -0,0 +1,130 @@
+/*
+ * [The "BSD license"]
+ *  Copyright (c) 2012 Terence Parr
+ *  Copyright (c) 2012 Sam Harwell
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. The name of the author may not be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.antlr.v4.tool;
+
+import org.antlr.runtime.Token;
+import org.stringtemplate.v4.ST;
+
+import java.util.Arrays;
+
+public class ANTLRMessage {
+	private static final Object[] EMPTY_ARGS = new Object[0];
+
+
+    private final ErrorType errorType;
+
+    private final Object[] args;
+
+    private final Throwable e;
+
+    // used for location template
+    public String fileName;
+    public int line = -1;
+    public int charPosition = -1;
+
+	public Grammar g;
+	/** Most of the time, we'll have a token such as an undefined rule ref
+     *  and so this will be set.
+     */
+    public Token offendingToken;
+
+	public ANTLRMessage(ErrorType errorType) {
+        this(errorType, (Throwable)null, Token.INVALID_TOKEN);
+    }
+
+    public ANTLRMessage(ErrorType errorType, Token offendingToken, Object... args) {
+        this(errorType, null, offendingToken, args);
+	}
+
+    public ANTLRMessage(ErrorType errorType, Throwable e, Token offendingToken, Object... args) {
+        this.errorType = errorType;
+        this.e = e;
+        this.args = args;
+		this.offendingToken = offendingToken;
+    }
+
+
+    public ErrorType getErrorType() {
+        return errorType;
+    }
+
+
+    public Object[] getArgs() {
+		if (args == null) {
+			return EMPTY_ARGS;
+		}
+
+		return args;
+    }
+
+	public ST getMessageTemplate(boolean verbose) {
+		ST messageST = new ST(getErrorType().msg);
+		messageST.impl.name = errorType.name();
+
+		messageST.add("verbose", verbose);
+		Object[] args = getArgs();
+		for (int i=0; i<args.length; i++) {
+			String attr = "arg";
+			if ( i>0 ) attr += i + 1;
+			messageST.add(attr, args[i]);
+		}
+		if ( args.length<2 ) messageST.add("arg2", null); // some messages ref arg2
+
+		Throwable cause = getCause();
+		if ( cause!=null ) {
+			messageST.add("exception", cause);
+			messageST.add("stackTrace", cause.getStackTrace());
+		}
+		else {
+			messageST.add("exception", null); // avoid ST error msg
+			messageST.add("stackTrace", null);
+		}
+
+		return messageST;
+	}
+
+
+    public Throwable getCause() {
+        return e;
+    }
+
+	@Override
+	public String toString() {
+		return "Message{" +
+			   "errorType=" + getErrorType() +
+			   ", args=" + Arrays.asList(getArgs()) +
+			   ", e=" + getCause() +
+			   ", fileName='" + fileName + '\'' +
+			   ", line=" + line +
+			   ", charPosition=" + charPosition +
+			   '}';
+	}
+}