freemarker.core.TemplateObject Maven / Gradle / Ivy
Go to download
Google App Engine compliant variation of FreeMarker.
FreeMarker is a "template engine"; a generic tool to generate text output based on templates.
/*
* Copyright (c) 2003 The Visigoth Software Society. 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 end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.core;
import freemarker.template.*;
import freemarker.template.utility.StringUtil;
/**
* Objects that represent instructions or expressions
* in the compiled tree representation of the template
* all descend from this abstract base class.
*/
public abstract class TemplateObject {
private Template template;
int beginColumn, beginLine, endColumn, endLine;
final void setLocation(Template template, Token begin, Token end)
throws
ParseException
{
setLocation(template, begin.beginColumn, begin.beginLine, end.endColumn, end.endLine);
}
final void setLocation(Template template, Token begin, TemplateObject end)
throws
ParseException
{
setLocation(template, begin.beginColumn, begin.beginLine, end.endColumn, end.endLine);
}
final void setLocation(Template template, TemplateObject begin, Token end)
throws
ParseException
{
setLocation(template, begin.beginColumn, begin.beginLine, end.endColumn, end.endLine);
}
final void setLocation(Template template, TemplateObject begin, TemplateObject end)
throws
ParseException
{
setLocation(template, begin.beginColumn, begin.beginLine, end.endColumn, end.endLine);
}
public final int getBeginColumn() {
return beginColumn;
}
public final int getBeginLine() {
return beginLine;
}
public final int getEndColumn() {
return endColumn;
}
public final int getEndLine() {
return endLine;
}
void setLocation(Template template, int beginColumn, int beginLine, int endColumn, int endLine)
throws
ParseException
{
this.template = template;
this.beginColumn = beginColumn;
this.beginLine = beginLine;
this.endColumn = endColumn;
this.endLine = endLine;
}
static void assertNonNull(TemplateModel model, Expression exp, Environment env) throws InvalidReferenceException {
if (model == null) {
throw new InvalidReferenceException(
"Expression " + exp + " is undefined " +
exp.getStartLocation() + ".", env);
}
}
static TemplateException invalidTypeException(TemplateModel model, Expression exp, Environment env, String expected)
throws
TemplateException
{
assertNonNull(model, exp, env);
return new TemplateException(
"Expected " + expected + ". " +
exp + " evaluated instead to " +
model.getClass().getName() + " " +
exp.getStartLocation() + ".", env);
}
/**
* Returns a string that indicates
* where in the template source, this object is.
*/
public String getStartLocation() {
String templateName = template != null ? template.getName() : "input";
return "on line "
+ beginLine
+ ", column "
+ beginColumn
+ " in "
+ templateName;
}
/**
* Same as {@link #getStartLocation}, but quotes the template name with
* {@link StringUtil#jQuoteNoXSS(String)}. If the template name is unknown,
* it uses "input" as the template name without quotation
* marks.
*/
public String getStartLocationQuoted() {
String templateName = template != null ? StringUtil.jQuoteNoXSS(template.getName()) : "input";
return "on line "
+ beginLine
+ ", column "
+ beginColumn
+ " in "
+ templateName;
}
public String getEndLocation() {
String templateName = template != null ? template.getName() : "input";
return "on line "
+ endLine
+ ", column "
+ endColumn
+ " in "
+ templateName;
}
/**
* Same as {@link #getStartLocation}, but quotes the template name with
* {@link StringUtil#jQuoteNoXSS(String)}. If the template name is unknown,
* it uses "input" as the template name without quotation
* marks.
*/
public String getEndLocationQuoted() {
String templateName = template != null ? StringUtil.jQuoteNoXSS(template.getName()) : "input";
return "on line "
+ endLine
+ ", column "
+ endColumn
+ " in "
+ templateName;
}
public final String getSource() {
if (template != null) {
return template.getSource(beginColumn, beginLine, endColumn, endLine);
} else {
return getCanonicalForm();
}
}
public String toString() {
try {
return getSource();
} catch (Exception e) { // REVISIT: A bit of a hack? (JR)
return getCanonicalForm();
}
}
/**
* @return whether the point in the template file specified by the
* column and line numbers is contained within this template object.
*/
public boolean contains(int column, int line) {
if (line < beginLine || line > endLine) {
return false;
}
if (line == beginLine) {
if (column < beginColumn) {
return false;
}
}
if (line == endLine) {
if (column > endColumn) {
return false;
}
}
return true;
}
public Template getTemplate()
{
return template;
}
TemplateObject copyLocationFrom(TemplateObject from)
{
template = from.template;
beginColumn = from.beginColumn;
beginLine = from.beginLine;
endColumn = from.endColumn;
endLine = from.endLine;
return this;
}
abstract public String getCanonicalForm();
}