package org.apache.velocity.runtime.visitor;
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed 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.runtime.parser.Token;
import org.apache.velocity.runtime.parser.node.ASTAddNode;
import org.apache.velocity.runtime.parser.node.ASTAndNode;
import org.apache.velocity.runtime.parser.node.ASTAssignment;
import org.apache.velocity.runtime.parser.node.ASTBlock;
import org.apache.velocity.runtime.parser.node.ASTDirective;
import org.apache.velocity.runtime.parser.node.ASTDivNode;
import org.apache.velocity.runtime.parser.node.ASTEQNode;
import org.apache.velocity.runtime.parser.node.ASTElseIfStatement;
import org.apache.velocity.runtime.parser.node.ASTElseStatement;
import org.apache.velocity.runtime.parser.node.ASTEscape;
import org.apache.velocity.runtime.parser.node.ASTEscapedDirective;
import org.apache.velocity.runtime.parser.node.ASTExpression;
import org.apache.velocity.runtime.parser.node.ASTFalse;
import org.apache.velocity.runtime.parser.node.ASTFloatingPointLiteral;
import org.apache.velocity.runtime.parser.node.ASTGENode;
import org.apache.velocity.runtime.parser.node.ASTGTNode;
import org.apache.velocity.runtime.parser.node.ASTIdentifier;
import org.apache.velocity.runtime.parser.node.ASTIfStatement;
import org.apache.velocity.runtime.parser.node.ASTIntegerLiteral;
import org.apache.velocity.runtime.parser.node.ASTIntegerRange;
import org.apache.velocity.runtime.parser.node.ASTLENode;
import org.apache.velocity.runtime.parser.node.ASTLTNode;
import org.apache.velocity.runtime.parser.node.ASTMap;
import org.apache.velocity.runtime.parser.node.ASTMethod;
import org.apache.velocity.runtime.parser.node.ASTModNode;
import org.apache.velocity.runtime.parser.node.ASTMulNode;
import org.apache.velocity.runtime.parser.node.ASTNENode;
import org.apache.velocity.runtime.parser.node.ASTNotNode;
import org.apache.velocity.runtime.parser.node.ASTObjectArray;
import org.apache.velocity.runtime.parser.node.ASTOrNode;
import org.apache.velocity.runtime.parser.node.ASTReference;
import org.apache.velocity.runtime.parser.node.ASTSetDirective;
import org.apache.velocity.runtime.parser.node.ASTStop;
import org.apache.velocity.runtime.parser.node.ASTStringLiteral;
import org.apache.velocity.runtime.parser.node.ASTSubtractNode;
import org.apache.velocity.runtime.parser.node.ASTText;
import org.apache.velocity.runtime.parser.node.ASTTrue;
import org.apache.velocity.runtime.parser.node.ASTWord;
import org.apache.velocity.runtime.parser.node.ASTprocess;
import org.apache.velocity.runtime.parser.node.Node;
import org.apache.velocity.runtime.parser.node.SimpleNode;
/**
* This class is simply a visitor implementation
* that traverses the AST, produced by the Velocity
* parsing process, and creates a visual structure
* of the AST. This is primarily used for
* debugging, but it useful for documentation
* as well.
*
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
* @version $Id: NodeViewMode.java 329434 2005-10-29 16:26:32Z henning $
*/
public class NodeViewMode extends BaseVisitor
{
private int indent = 0;
private boolean showTokens = true;
/** Indent child nodes to help visually identify
* the structure of the AST.
*/
private String indentString()
{
StringBuffer sb = new StringBuffer();
for (int i = 0; i < indent; ++i)
{
sb.append(" ");
}
return sb.toString();
}
/**
* Display the type of nodes and optionally the
* first token.
*/
private Object showNode(Node node, Object data)
{
String tokens = "";
String special = "";
Token t;
if (showTokens)
{
t = node.getFirstToken();
if (t.specialToken != null && ! t.specialToken.image.startsWith("##"))
special = t.specialToken.image;
tokens = " -> " + special + t.image;
}
System.out.println(indentString() + node + tokens);
++indent;
data = node.childrenAccept(this, data);
--indent;
return data;
}
/** Display a SimpleNode */
public Object visit(SimpleNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTprocess node */
public Object visit(ASTprocess node, Object data)
{
return showNode(node,data);
}
/** Display an ASTExpression node */
public Object visit(ASTExpression node, Object data)
{
return showNode(node,data);
}
/** Display an ASTAssignment node ( = ) */
public Object visit(ASTAssignment node, Object data)
{
return showNode(node,data);
}
/** Display an ASTOrNode ( || ) */
public Object visit(ASTOrNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTAndNode ( && ) */
public Object visit(ASTAndNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTEQNode ( == ) */
public Object visit(ASTEQNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTNENode ( != ) */
public Object visit(ASTNENode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTLTNode ( < ) */
public Object visit(ASTLTNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTGTNode ( > ) */
public Object visit(ASTGTNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTLENode ( <= ) */
public Object visit(ASTLENode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTGENode ( >= ) */
public Object visit(ASTGENode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTAddNode ( + ) */
public Object visit(ASTAddNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTSubtractNode ( - ) */
public Object visit(ASTSubtractNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTMulNode ( * ) */
public Object visit(ASTMulNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTDivNode ( / ) */
public Object visit(ASTDivNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTModNode ( % ) */
public Object visit(ASTModNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTNotNode ( ! ) */
public Object visit(ASTNotNode node, Object data)
{
return showNode(node,data);
}
/** Display an ASTFloatingPointLiteral node */
public Object visit(ASTFloatingPointLiteral node, Object data)
{
return showNode(node,data);
}
/** Display an ASTIntegerLiteral node */
public Object visit(ASTIntegerLiteral node, Object data)
{
return showNode(node,data);
}
/** Display an ASTStringLiteral node */
public Object visit(ASTStringLiteral node, Object data)
{
return showNode(node,data);
}
/** Display an ASTIdentifier node */
public Object visit(ASTIdentifier node, Object data)
{
return showNode(node,data);
}
/** Display an ASTMethod node */
public Object visit(ASTMethod node, Object data)
{
return showNode(node,data);
}
/** Display an ASTReference node */
public Object visit(ASTReference node, Object data)
{
return showNode(node,data);
}
/** Display an ASTTrue node */
public Object visit(ASTTrue node, Object data)
{
return showNode(node,data);
}
/** Display an ASTFalse node */
public Object visit(ASTFalse node, Object data)
{
return showNode(node,data);
}
/** Display an ASTBlock node */
public Object visit(ASTBlock node, Object data)
{
return showNode(node,data);
}
/** Display an ASTText node */
public Object visit(ASTText node, Object data)
{
return showNode(node,data);
}
/** Display an ASTIfStatement node */
public Object visit(ASTIfStatement node, Object data)
{
return showNode(node,data);
}
/** Display an ASTElseStatement node */
public Object visit(ASTElseStatement node, Object data)
{
return showNode(node,data);
}
/** Display an ASTElseIfStatement node */
public Object visit(ASTElseIfStatement node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTObjectArray node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTDirective node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTWord node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTSetDirective node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTEscapedDirective node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTEscape node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTMap node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTIntegerRange node, Object data)
{
return showNode(node,data);
}
public Object visit(ASTStop node, Object data)
{
return showNode(node,data);
}
}