package org.apache.velocity.runtime.parser.node;
/*
* 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 java.io.IOException;
import java.io.Writer;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.velocity.context.InternalContextAdapter;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.exception.TemplateInitException;
import org.apache.velocity.runtime.directive.Directive;
import org.apache.velocity.runtime.parser.ParseException;
import org.apache.velocity.runtime.parser.Parser;
import org.apache.velocity.runtime.parser.ParserVisitor;
import org.apache.velocity.util.ExceptionUtils;
/**
* This class is responsible for handling the pluggable
* directives in VTL.
*
* For example : #foreach()
*
* Please look at the Parser.jjt file which is
* what controls the generation of this class.
*
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
* @author <a href="mailto:kav@kav.dk">Kasper Nielsen</a>
* @version $Id: ASTDirective.java 471381 2006-11-05 08:56:58Z wglass $
*/
public class ASTDirective extends SimpleNode
{
private Directive directive = null;
private String directiveName = "";
private boolean isDirective;
/**
* @param id
*/
public ASTDirective(int id)
{
super(id);
}
/**
* @param p
* @param id
*/
public ASTDirective(Parser p, int id)
{
super(p, id);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
*/
public Object jjtAccept(ParserVisitor visitor, Object data)
{
return visitor.visit(this, data);
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object)
*/
public Object init( InternalContextAdapter context, Object data)
throws TemplateInitException
{
super.init( context, data );
/*
* only do things that are not context dependant
*/
if (parser.isDirective( directiveName ))
{
isDirective = true;
try
{
directive = (Directive) parser.getDirective( directiveName )
.getClass().newInstance();
}
catch (InstantiationException e)
{
throw ExceptionUtils.createRuntimeException("Couldn't initialize " +
"directive of class " +
parser.getDirective(directiveName).getClass().getName(),
e);
}
catch (IllegalAccessException e)
{
throw ExceptionUtils.createRuntimeException("Couldn't initialize " +
"directive of class " +
parser.getDirective(directiveName).getClass().getName(),
e);
}
directive.init(rsvc, context,this);
directive.setLocation( getLine(), getColumn() );
}
else if (rsvc.isVelocimacro( directiveName, context.getCurrentTemplateName() ))
{
/*
* we seem to be a Velocimacro.
*/
isDirective = true;
directive = rsvc.getVelocimacro( directiveName, context.getCurrentTemplateName());
try
{
directive.init( rsvc, context, this );
}
/**
* correct the line/column number if an exception is caught
*/
catch (TemplateInitException die)
{
throw new TemplateInitException(die.getMessage(),
(ParseException) die.getWrappedThrowable(),
die.getTemplateName(),
die.getColumnNumber() + getColumn(),
die.getLineNumber() + getLine());
}
directive.setLocation( getLine(), getColumn() );
}
else
{
isDirective = false;
}
return data;
}
/**
* @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
*/
public boolean render( InternalContextAdapter context, Writer writer)
throws IOException,MethodInvocationException, ResourceNotFoundException, ParseErrorException
{
/*
* normal processing
*/
if (isDirective)
{
directive.render(context, writer, this);
}
else
{
if (context.getAllowRendering())
{
writer.write( "#");
writer.write( directiveName );
}
}
return true;
}
/**
* Sets the directive name. Used by the parser. This keeps us from having to
* dig it out of the token stream and gives the parse the change to override.
* @param str
*/
public void setDirectiveName( String str )
{
directiveName = str;
}
/**
* Gets the name of this directive.
* @return The name of this directive.
*/
public String getDirectiveName()
{
return directiveName;
}
public String toString()
{
return new ToStringBuilder(this)
.appendSuper(super.toString())
.append("directiveName", getDirectiveName())
.toString();
}
}