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.directive.RuntimeMacro;
import org.apache.velocity.runtime.parser.ParseException;
import org.apache.velocity.runtime.parser.Parser;
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 724825 2008-12-09 18:56:06Z nbubna $
*/
public class ASTDirective extends SimpleNode
{
private static my.Debug DEBUG=new my.Debug(my.Debug.Velocity);//我加上的
private Directive directive = null;
private String directiveName = "";
private boolean isDirective;
private boolean isInitialized;
/**
* @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.node.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 synchronized Object init( InternalContextAdapter context, Object data)
throws TemplateInitException
{
try {//我加上的
DEBUG.P(this,"init(2)");
/** method is synchronized to avoid concurrent directive initialization **/
DEBUG.P("isInitialized="+isInitialized);
if (!isInitialized)
{
super.init( context, data );
/*
* only do things that are not context dependent
*/
//在Parser中会事无调用setDirectiveName
DEBUG.P("directiveName="+directiveName);
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.setLocation(getLine(), getColumn(), getTemplateName());
directive.init(rsvc, context,this);
}
else
{
/**
* Create a new RuntimeMacro
*/
directive = new RuntimeMacro(directiveName, getTemplateName());
directive.setLocation(getLine(), getColumn(), getTemplateName());
DEBUG.P("directive="+directive);
/**
* Initialize it
*/
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());
}
isDirective = true;
}
isInitialized = true;
}
return data;
}finally{//我加上的
DEBUG.P(0,this,"init(2)");
}
}
/**
* @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
{
try {//我加上的
DEBUG.P(this,"render(2)");
DEBUG.P("isDirective="+isDirective);
DEBUG.P("directiveName="+directiveName);
DEBUG.P("directive="+directive);
/*
* normal processing
*/
if (isDirective)
{
directive.render(context, writer, this);
}
else
{
DEBUG.P("context.getAllowRendering()="+context.getAllowRendering());
if (context.getAllowRendering())
{
writer.write( "#");
writer.write( directiveName );
}
}
return true;
}finally{//我加上的
DEBUG.P(0,this,"render(2)");
}
}
/**
* 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 )
{
try {//我加上的
DEBUG.P(this,"setDirectiveName(1)");
DEBUG.P("str="+str);
//DEBUG.e(); //在org.apache.velocity.runtime.parser.Parser.Directive中执行
directiveName = str;
}finally{//我加上的
DEBUG.P(0,this,"setDirectiveName(1)");
}
}
/**
* Gets the name of this directive.
* @return The name of this directive.
*/
public String getDirectiveName()
{
return directiveName;
}
/**
* @since 1.5
*/
public String toString()
{
return new ToStringBuilder(this)
.appendSuper(super.toString())
.append("directiveName", getDirectiveName())
.toString();
}
}