diff options
Diffstat (limited to 'velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/MacroParseException.java')
-rw-r--r-- | velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/MacroParseException.java | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/MacroParseException.java b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/MacroParseException.java new file mode 100644 index 00000000..0ce9a5f8 --- /dev/null +++ b/velocity-engine-core/src/main/java/org/apache/velocity/runtime/directive/MacroParseException.java @@ -0,0 +1,206 @@ +package org.apache.velocity.runtime.directive; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.velocity.exception.ExtendedParseException; +import org.apache.velocity.runtime.parser.ParseException; +import org.apache.velocity.runtime.parser.Token; +import org.apache.velocity.util.StringUtils; + +/** + * Exception to indicate problem happened while constructing #macro() + * + * For internal use in parser - not to be passed to app level + * + * @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a> + * @author <a href="hps@intermeta.de">Henning P. Schmiedehausen</a> + * @version $Id$ + */ +public class MacroParseException + extends ParseException + implements ExtendedParseException +{ + private final String templateName; + + /** + * Version Id for serializable + */ + private static final long serialVersionUID = -4985224672336070689L; + + /** + * @param msg + * @param templateName + * @param currentToken + */ + public MacroParseException(final String msg, final String templateName, final Token currentToken) + { + super(msg + " at "); + this.currentToken = currentToken; + this.templateName = templateName; + } + + /** + * returns the Template name where this exception occured. + * @return The Template name where this exception occured. + * @since 1.5 + */ + @Override + public String getTemplateName() + { + return templateName; + } + + /** + * returns the line number where this exception occured. + * @return The line number where this exception occured. + * @since 1.5 + */ + @Override + public int getLineNumber() + { + if ((currentToken != null) && (currentToken.next != null)) + { + return currentToken.next.beginLine; + } + else if (currentToken != null) + { + return currentToken.beginLine; + } + else + { + return -1; + } + } + + /** + * returns the column number where this exception occured. + * @return The column number where this exception occured. + * @since 1.5 + */ + @Override + public int getColumnNumber() + { + if ((currentToken != null) && (currentToken.next != null)) + { + return currentToken.next.beginColumn; + } + else if (currentToken != null) + { + return currentToken.beginColumn; + } + else + { + return -1; + } + } + + /** + * This method has the standard behavior when this object has been + * created using the standard constructors. Otherwise, it uses + * "currentToken" and "expectedTokenSequences" to generate a parse + * error message and returns it. If this object has been created + * due to a parse error, and you do not catch it (it gets thrown + * from the parser), then this method is called during the printing + * of the final stack trace, and hence the correct error message + * gets displayed. + * @return the current message. + * @since 1.5 + */ + @Override + public String getMessage() + { + if (!specialConstructor) + { + StringBuilder sb = new StringBuilder(super.getMessage()); + appendTemplateInfo(sb); + return sb.toString(); + } + + int maxSize = 0; + + StringBuilder expected = new StringBuilder(); + + for (int[] expectedTokenSequence : expectedTokenSequences) + { + if (maxSize < expectedTokenSequence.length) + { + maxSize = expectedTokenSequence.length; + } + + for (int i : expectedTokenSequence) + { + expected.append(tokenImage[i]).append(" "); + } + + if (expectedTokenSequence[expectedTokenSequence.length - 1] != 0) + { + expected.append("..."); + } + + expected.append(eol).append(" "); + } + + StringBuilder retval = new StringBuilder("Encountered \""); + Token tok = currentToken.next; + + for (int i = 0; i < maxSize; i++) + { + if (i != 0) + { + retval.append(" "); + } + + if (tok.kind == 0) + { + retval.append(tokenImage[0]); + break; + } + + retval.append(add_escapes(tok.image)); + tok = tok.next; + } + + retval.append("\""); + appendTemplateInfo(retval); + + if (expectedTokenSequences.length == 1) + { + retval.append("Was expecting:").append(eol).append(" "); + } + else + { + retval.append("Was expecting one of:").append(eol).append(" "); + } + + // avoid JDK 1.3 StringBuffer.append(Object o) vs 1.4 StringBuffer.append(StringBuffer sb) gotcha. + retval.append(expected.toString()); + return retval.toString(); + } + + /** + * @param sb + * @since 1.5 + */ + protected void appendTemplateInfo(final StringBuilder sb) + { + sb.append(StringUtils.formatFileString(getTemplateName(), getLineNumber(), getColumnNumber())); + sb.append(eol); + } +} |