001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * If you wish your version of this file to be governed by only the CDDL
025: * or only the GPL Version 2, indicate your decision by adding
026: * "[Contributor] elects to include this software in this distribution
027: * under the [CDDL or GPL Version 2] license." If you do not indicate a
028: * single choice of license, a recipient has the option to distribute
029: * your version of this file under either the CDDL, the GPL Version 2 or
030: * to extend the choice of license to its licensees as provided above.
031: * However, if you add GPL Version 2 code and therefore, elected the GPL
032: * Version 2 license, then the option applies only if the new code is
033: * made subject to such option by the copyright holder.
034: *
035: * Contributor(s):
036: *
037: * Portions Copyrighted 2007 Sun Microsystems, Inc.
038: */
039:
040: package org.netbeans.modules.ruby;
041:
042: import java.util.List;
043: import org.jruby.ast.Node;
044:
045: /**
046: * A walker to iterate over a JRuby parse tree
047: *
048: * @author Tor Norbye
049: */
050: public class ParseTreeWalker {
051: protected final ParseTreeVisitor visitor;
052:
053: /**
054: * Construct a tree walker which will walk over the AST calling
055: * each node until it reaches the startNode (if null, it will walk
056: * over the whole tree), and visit until it reaches the endNode.
057: * The endpoints can be visited inclusively or exclusively.
058: *
059: * @param visitor The visitor to be called for each node
060: * @param startNode Null, or a node in the tree where visitation will begin
061: * @param includeBegin True if the startNode should be visited, otherwise visiting starts after the start node
062: * @param endNode Null, or a node in the tree where visition will terminate
063: * @param includeEnd True if the endNode should be visited before terminating
064: */
065: public ParseTreeWalker(ParseTreeVisitor visitor) {
066: this .visitor = visitor;
067: }
068:
069: /**
070: * Walk the given AST tree from the given root node.
071: *
072: * @param root The node to start recursive traversal.
073: * @return True if traversal was aborted, false otherwise.
074: */
075: public boolean walk(Node root) {
076: if (!visitor.visit(root)) {
077: @SuppressWarnings(value="unchecked")
078: List<Node> list = root.childNodes();
079:
080: //for (Node child : list) {
081: for (int i = 0, n = list.size(); i < n; i++) {
082: Node child = list.get(i);
083: if (walk(child)) {
084: return true;
085: }
086: }
087: }
088:
089: if (visitor.unvisit(root)) {
090: return true;
091: }
092:
093: return false;
094: }
095:
096: // /**
097: // * Walk a -part- of a parse tree
098: // */
099: // public static class ParseTreeRangeWalker extends ParseTreeWalker {
100: // private final Node startNode;
101: // private final Node endNode;
102: // private final boolean includeEnd;
103: // private final boolean includeBegin;
104: // private boolean visiting;
105: //
106: // /**
107: // * Construct a tree walker which will walk over the AST calling
108: // * each node until it reaches the startNode (if null, it will walk
109: // * over the whole tree), and visit until it reaches the endNode.
110: // * The endpoints can be visited inclusively or exclusively.
111: // *
112: // * @param visitor The visitor to be called for each node
113: // * @param startNode Null, or a node in the tree where visitation will begin
114: // * @param includeBegin True if the startNode should be visited, otherwise visiting starts after the start node
115: // * @param endNode Null, or a node in the tree where visition will terminate
116: // * @param includeEnd True if the endNode should be visited before terminating
117: // */
118: // public ParseTreeRangeWalker(ParseTreeVisitor visitor, Node startNode, boolean includeBegin, Node endNode, boolean includeEnd) {
119: // super(visitor);
120: // this.startNode = startNode;
121: // this.endNode = endNode;
122: // this.includeBegin = includeBegin;
123: // this.includeEnd = includeEnd;
124: // visiting = startNode == null;
125: // }
126: //
127: // /**
128: // * Walk the given AST tree from the given root node.
129: // *
130: // * @param root The node to start recursive traversal.
131: // * @return True if traversal was aborted, false otherwise.
132: // */
133: // public boolean walk(Node root) {
134: // if (visiting) {
135: // if (root == endNode) {
136: // if (includeEnd) {
137: // if (visitor.visit(root)) {
138: // return true;
139: // }
140: // }
141: // return true;
142: // }
143: // if (visitor.visit(root)) {
144: // return true;
145: // }
146: // } else {
147: // if (root == startNode) {
148: // visiting = true;
149: // if (includeBegin && visitor.visit(root)) {
150: // return true;
151: // }
152: // }
153: // }
154: //
155: // @SuppressWarnings(value = "unchecked")
156: // List<Node> list = root.childNodes();
157: //
158: // //for (Node child : list) {
159: // for (int i = 0, n = list.size(); i < n; i++) {
160: // Node child = list.get(i);
161: // if (walk(child)) {
162: // return true;
163: // }
164: // }
165: //
166: // if (visiting && visitor.unvisit(root)) {
167: // return true;
168: // }
169: //
170: // return false;
171: // }
172: // }
173: }
|