src/share/classes/com/sun/source/util/TreePath.java

Wed, 23 Jan 2013 13:27:24 -0800

author
jjg
date
Wed, 23 Jan 2013 13:27:24 -0800
changeset 1521
71f35e4b93a5
parent 1455
75ab654b5cd5
child 1590
011cf7e0a148
permissions
-rw-r--r--

8006775: JSR 308: Compiler changes in JDK8
Reviewed-by: jjg
Contributed-by: mernst@cs.washington.edu, wmdietl@cs.washington.edu, mpapi@csail.mit.edu, mahmood@notnoop.com

duke@1 1 /*
jjg@1357 2 * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.source.util;
duke@1 27
jjg@1357 28 import java.util.Iterator;
jjg@1357 29
duke@1 30 import com.sun.source.tree.*;
duke@1 31
duke@1 32 /**
duke@1 33 * A path of tree nodes, typically used to represent the sequence of ancestor
duke@1 34 * nodes of a tree node up to the top level CompilationUnitTree node.
duke@1 35 *
duke@1 36 * @author Jonathan Gibbons
duke@1 37 * @since 1.6
duke@1 38 */
duke@1 39 public class TreePath implements Iterable<Tree> {
duke@1 40 /**
duke@1 41 * Gets a tree path for a tree node within a compilation unit.
duke@1 42 * @return null if the node is not found
duke@1 43 */
duke@1 44 public static TreePath getPath(CompilationUnitTree unit, Tree target) {
duke@1 45 return getPath(new TreePath(unit), target);
duke@1 46 }
duke@1 47
duke@1 48 /**
duke@1 49 * Gets a tree path for a tree node within a subtree identified by a TreePath object.
duke@1 50 * @return null if the node is not found
duke@1 51 */
duke@1 52 public static TreePath getPath(TreePath path, Tree target) {
duke@1 53 path.getClass();
duke@1 54 target.getClass();
duke@1 55
duke@1 56 class Result extends Error {
duke@1 57 static final long serialVersionUID = -5942088234594905625L;
duke@1 58 TreePath path;
duke@1 59 Result(TreePath path) {
duke@1 60 this.path = path;
duke@1 61 }
duke@1 62 }
jjg@1455 63
duke@1 64 class PathFinder extends TreePathScanner<TreePath,Tree> {
duke@1 65 public TreePath scan(Tree tree, Tree target) {
jjg@1455 66 if (tree == target) {
duke@1 67 throw new Result(new TreePath(getCurrentPath(), target));
jjg@1455 68 }
duke@1 69 return super.scan(tree, target);
duke@1 70 }
duke@1 71 }
duke@1 72
jjg@1455 73 if (path.getLeaf() == target) {
jjg@1455 74 return path;
jjg@1455 75 }
jjg@1455 76
duke@1 77 try {
duke@1 78 new PathFinder().scan(path, target);
duke@1 79 } catch (Result result) {
duke@1 80 return result.path;
duke@1 81 }
duke@1 82 return null;
duke@1 83 }
duke@1 84
duke@1 85 /**
duke@1 86 * Creates a TreePath for a root node.
duke@1 87 */
duke@1 88 public TreePath(CompilationUnitTree t) {
duke@1 89 this(null, t);
duke@1 90 }
duke@1 91
duke@1 92 /**
duke@1 93 * Creates a TreePath for a child node.
duke@1 94 */
duke@1 95 public TreePath(TreePath p, Tree t) {
duke@1 96 if (t.getKind() == Tree.Kind.COMPILATION_UNIT) {
duke@1 97 compilationUnit = (CompilationUnitTree) t;
duke@1 98 parent = null;
duke@1 99 }
duke@1 100 else {
duke@1 101 compilationUnit = p.compilationUnit;
duke@1 102 parent = p;
duke@1 103 }
duke@1 104 leaf = t;
duke@1 105 }
duke@1 106 /**
duke@1 107 * Get the compilation unit associated with this path.
duke@1 108 */
duke@1 109 public CompilationUnitTree getCompilationUnit() {
duke@1 110 return compilationUnit;
duke@1 111 }
duke@1 112
duke@1 113 /**
duke@1 114 * Get the leaf node for this path.
duke@1 115 */
duke@1 116 public Tree getLeaf() {
duke@1 117 return leaf;
duke@1 118 }
duke@1 119
duke@1 120 /**
duke@1 121 * Get the path for the enclosing node, or null if there is no enclosing node.
duke@1 122 */
duke@1 123 public TreePath getParentPath() {
duke@1 124 return parent;
duke@1 125 }
duke@1 126
duke@1 127 public Iterator<Tree> iterator() {
duke@1 128 return new Iterator<Tree>() {
duke@1 129 public boolean hasNext() {
jjg@308 130 return next != null;
duke@1 131 }
duke@1 132
duke@1 133 public Tree next() {
jjg@308 134 Tree t = next.leaf;
jjg@308 135 next = next.parent;
jjg@308 136 return t;
duke@1 137 }
duke@1 138
duke@1 139 public void remove() {
duke@1 140 throw new UnsupportedOperationException();
duke@1 141 }
duke@1 142
jjg@308 143 private TreePath next = TreePath.this;
duke@1 144 };
duke@1 145 }
duke@1 146
duke@1 147 private CompilationUnitTree compilationUnit;
duke@1 148 private Tree leaf;
duke@1 149 private TreePath parent;
duke@1 150 }

mercurial