fix: consolidate a consistent behavior for CtElement#getParent (#3793)

Co-authored-by: Simon Larsén <[email protected]>
INRIA · Feb 24, 2021 · d18ed7f · d18ed7f
1 parent 2b17524
commit d18ed7f
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 137 deletions.
diff --git a/src/main/java/spoon/pattern/PatternBuilder.java b/src/main/java/spoon/pattern/PatternBuilder.java
@@ -126,6 +126,7 @@ private CtTypeReference<?> getDeclaringTypeRef(List<? extends CtElement> templat
 				t = (CtType) ctElement;
 				type = mergeType(type, t);
 			}
+
 			t = ctElement.getParent(CtType.class);
 			if (t != null) {
 				type = mergeType(type, t);

diff --git a/src/main/java/spoon/reflect/declaration/CtElement.java b/src/main/java/spoon/reflect/declaration/CtElement.java
@@ -249,14 +249,17 @@ <E extends CtElement> List<E> getAnnotatedChildren(
 
 	/**
 	 * Gets the first parent that matches the given type.
+	 *
+	 * @return the nearest matching parent; null if no match is found or this element has no parent
 	 */
-	<P extends CtElement> P getParent(Class<P> parentType) throws ParentNotInitializedException;
+	<P extends CtElement> P getParent(Class<P> parentType);
 
 	/**
 	 * Gets the first parent that matches the filter.
-	 * If the receiver (this) matches the filter, it is also returned
+	 *
+	 * @return the nearest matching parent; null if no match is found or this element has no parent
 	 */
-	<E extends CtElement> E getParent(Filter<E> filter) throws ParentNotInitializedException;
+	<E extends CtElement> E getParent(Filter<E> filter);
 
 	/**
 	 * Manually sets the parent element of the current element.

diff --git a/src/main/java/spoon/reflect/visitor/DefaultJavaPrettyPrinter.java b/src/main/java/spoon/reflect/visitor/DefaultJavaPrettyPrinter.java
@@ -1301,12 +1301,7 @@ public <T> void visitCtInvocation(CtInvocation<T> invocation) {
 		if (invocation.getExecutable().isConstructor()) {
 			// It's a constructor (super or this)
 			elementPrinterHelper.writeActualTypeArguments(invocation.getExecutable());
-			CtType<?> parentType;
-			try {
-				parentType = invocation.getParent(CtType.class);
-			} catch (ParentNotInitializedException e) {
-				parentType = null;
-			}
+			CtType<?> parentType = invocation.getParent(CtType.class);
 			if (parentType == null || parentType.getQualifiedName() != null && parentType.getQualifiedName().equals(invocation.getExecutable().getDeclaringType().getQualifiedName())) {
 				printer.writeKeyword("this");
 			} else {
@@ -1460,13 +1455,8 @@ public <T> void visitCtAnnotationMethod(CtAnnotationMethod<T> annotationMethod)
 	@SuppressWarnings("rawtypes")
 	public <T> void visitCtNewArray(CtNewArray<T> newArray) {
 		enterCtExpression(newArray);
-		boolean isNotInAnnotation;
-		try {
-			isNotInAnnotation = (newArray.getParent(CtAnnotationType.class) == null) && (newArray.getParent(CtAnnotation.class) == null);
-		} catch (ParentNotInitializedException e) {
-			isNotInAnnotation = true;
-		}
 
+		boolean isNotInAnnotation = (newArray.getParent(CtAnnotationType.class) == null) && (newArray.getParent(CtAnnotation.class) == null);
 		if (isNotInAnnotation) {
 			CtTypeReference<?> ref = newArray.getType();
 

diff --git a/src/main/java/spoon/support/StandardEnvironment.java b/src/main/java/spoon/support/StandardEnvironment.java
@@ -25,7 +25,6 @@
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtExecutable;
 import spoon.reflect.declaration.CtType;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.visitor.DefaultImportComparator;
 import spoon.reflect.visitor.DefaultJavaPrettyPrinter;
 import spoon.reflect.visitor.ForceFullyQualifiedProcessor;
@@ -246,22 +245,19 @@ public void report(Processor<?> processor, Level level, CtElement element, Strin
 		buffer.append(message);
 
 		// Add sourceposition (javac format)
-		try {
-			CtType<?> type = (element instanceof CtType) ? (CtType<?>) element : element.getParent(CtType.class);
-			SourcePosition sp = element.getPosition();
-
-			if (sp == null) {
-				buffer.append(" (Unknown Source)");
-			} else {
-				buffer.append(" at " + type.getQualifiedName() + ".");
-				CtExecutable<?> exe = (element instanceof CtExecutable) ? (CtExecutable<?>) element : element.getParent(CtExecutable.class);
-				if (exe != null) {
-					buffer.append(exe.getSimpleName());
-				}
-				buffer.append("(" + sp.getFile().getName() + ":" + sp.getLine() + ")");
+		CtType<?> type = (element instanceof CtType) ? (CtType<?>) element : element.getParent(CtType.class);
+		SourcePosition sp = element.getPosition();
+
+		if (sp == null) {
+			buffer.append(" (Unknown Source)");
+		} else {
+			// TODO: will explode if type == null
+			buffer.append(" at " + type.getQualifiedName() + ".");
+			CtExecutable<?> exe = (element instanceof CtExecutable) ? (CtExecutable<?>) element : element.getParent(CtExecutable.class);
+			if (exe != null) {
+				buffer.append(exe.getSimpleName());
 			}
-		} catch (ParentNotInitializedException e) {
-			buffer.append(" (invalid parent)");
+			buffer.append("(" + sp.getFile().getName() + ":" + sp.getLine() + ")");
 		}
 
 		print(buffer.toString(), level);

diff --git a/src/main/java/spoon/support/reflect/code/CtStatementImpl.java b/src/main/java/spoon/support/reflect/code/CtStatementImpl.java
@@ -64,14 +64,10 @@ public static void insertBefore(CtStatement target, CtStatementList statementsTo
 		if (targetParent instanceof CtExecutable) {
 			throw new SpoonException("cannot insert in this context (use insertEnd?)");
 		}
-		try {
-			if (target.getParent(CtConstructor.class) != null) {
-				if (target instanceof CtInvocation && ((CtInvocation<?>) target).getExecutable().getSimpleName().startsWith(CtExecutableReference.CONSTRUCTOR_NAME)) {
-					throw new SpoonException("cannot insert a statement before a super or this invocation.");
-				}
+		if (target.getParent(CtConstructor.class) != null) {
+			if (target instanceof CtInvocation && ((CtInvocation<?>) target).getExecutable().getSimpleName().startsWith(CtExecutableReference.CONSTRUCTOR_NAME)) {
+				throw new SpoonException("cannot insert a statement before a super or this invocation.");
 			}
-		} catch (ParentNotInitializedException ignore) {
-			// no parent set somewhere
 		}
 		new InsertVisitor(target, statementsToBeInserted, InsertType.BEFORE).scan(targetParent);
 	}

diff --git a/src/main/java/spoon/support/reflect/declaration/CtElementImpl.java b/src/main/java/spoon/support/reflect/declaration/CtElementImpl.java
@@ -382,35 +382,33 @@ public boolean isParentInitialized() {
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public <P extends CtElement> P getParent(Class<P> parentType) throws ParentNotInitializedException {
-		if (parent == null) {
-			return null;
-		}
-		if (parentType.isAssignableFrom(getParent().getClass())) {
-			return (P) getParent();
+	public <P extends CtElement> P getParent(Class<P> parentType) {
+		CtElement current = this;
+		while (current.isParentInitialized()) {
+			current = current.getParent();
+			if (parentType.isAssignableFrom(current.getClass())) {
+				return (P) current;
+			}
 		}
-		return getParent().getParent(parentType);
+
+		return null;
 	}
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public <E extends CtElement> E getParent(Filter<E> filter) throws ParentNotInitializedException {
-		E current = (E) getParent();
-		while (true) {
+	public <E extends CtElement> E getParent(Filter<E> filter) {
+		CtElement current = this;
+		while (current.isParentInitialized()) {
+			current = current.getParent();
 			try {
-				while (current != null && !filter.matches(current)) {
-					current = (E) current.getParent();
+				if (filter.matches((E) current)) {
+					return (E) current;
 				}
-				break;
-			} catch (ClassCastException e) {
+			} catch (ClassCastException ignored) {
 				// expected, some elements are not of type
-				current = (E) current.getParent();
 			}
 		}
 
-		if (current != null && filter.matches(current)) {
-			return current;
-		}
 		return null;
 	}
 

diff --git a/src/main/java/spoon/support/reflect/declaration/CtPackageImpl.java b/src/main/java/spoon/support/reflect/declaration/CtPackageImpl.java
@@ -14,7 +14,6 @@
 import spoon.reflect.declaration.CtPackage;
 import spoon.reflect.declaration.CtShadowable;
 import spoon.reflect.declaration.CtType;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.path.CtRole;
 import spoon.reflect.reference.CtPackageReference;
 import spoon.reflect.visitor.CtVisitor;
@@ -121,20 +120,12 @@ public boolean removePackage(CtPackage pack) {
 
 	@Override
 	public CtModule getDeclaringModule() {
-		try {
-			return getParent(CtModule.class);
-		} catch (ParentNotInitializedException e) {
-			return null;
-		}
+		return getParent(CtModule.class);
 	}
 
 	@Override
 	public CtPackage getDeclaringPackage() {
-		try {
-			return getParent(CtPackage.class);
-		} catch (ParentNotInitializedException e) {
-			return null;
-		}
+		return getParent(CtPackage.class);
 	}
 
 	@Override

diff --git a/src/main/java/spoon/support/reflect/declaration/CtTypeImpl.java b/src/main/java/spoon/support/reflect/declaration/CtTypeImpl.java
@@ -27,7 +27,6 @@
 import spoon.reflect.declaration.CtTypeMember;
 import spoon.reflect.declaration.CtTypeParameter;
 import spoon.reflect.declaration.ModifierKind;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.path.CtRole;
 import spoon.reflect.reference.CtArrayTypeReference;
 import spoon.reflect.reference.CtExecutableReference;
@@ -325,11 +324,7 @@ public Class<T> getActualClass() {
 
 	@Override
 	public CtType<?> getDeclaringType() {
-		try {
-			return getParent(CtType.class);
-		} catch (ParentNotInitializedException ex) {
-			return null;
-		}
+		return getParent(CtType.class);
 	}
 
 	@SuppressWarnings("unchecked")

diff --git a/src/main/java/spoon/support/reflect/declaration/CtTypeParameterImpl.java b/src/main/java/spoon/support/reflect/declaration/CtTypeParameterImpl.java
@@ -17,7 +17,6 @@
 import spoon.reflect.declaration.CtTypeMember;
 import spoon.reflect.declaration.CtTypeParameter;
 import spoon.reflect.declaration.ModifierKind;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.reference.CtExecutableReference;
 import spoon.reflect.reference.CtFieldReference;
 import spoon.reflect.reference.CtTypeParameterReference;
@@ -80,11 +79,7 @@ public CtTypeParameter clone() {
 
 	@Override
 	public CtFormalTypeDeclarer getTypeParameterDeclarer() {
-		try {
-			return getParent(CtFormalTypeDeclarer.class);
-		} catch (ParentNotInitializedException e) {
-			return null;
-		}
+		return getParent(CtFormalTypeDeclarer.class);
 	}
 
 	@Override

diff --git a/src/main/java/spoon/support/reflect/reference/CtCatchVariableReferenceImpl.java b/src/main/java/spoon/support/reflect/reference/CtCatchVariableReferenceImpl.java
@@ -10,7 +10,6 @@
 import spoon.reflect.code.CtCatch;
 import spoon.reflect.code.CtCatchVariable;
 import spoon.reflect.declaration.CtElement;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.reference.CtCatchVariableReference;
 import spoon.reflect.visitor.CtVisitor;
 
@@ -30,18 +29,15 @@ public CtCatchVariable<T> getDeclaration() {
 		CtElement element = this;
 		String name = getSimpleName();
 		CtCatchVariable var;
-		try {
-			do {
-				CtCatch catchBlock = element.getParent(CtCatch.class);
-				if (catchBlock == null) {
-					return null;
-				}
-				var = catchBlock.getParameter();
-				element = catchBlock;
-			} while (!name.equals(var.getSimpleName()));
-		} catch (ParentNotInitializedException e) {
-			return null;
-		}
+		do {
+			CtCatch catchBlock = element.getParent(CtCatch.class);
+			if (catchBlock == null) {
+				return null;
+			}
+			var = catchBlock.getParameter();
+			element = catchBlock;
+		} while (!name.equals(var.getSimpleName()));
+
 		return var;
 	}
 

diff --git a/src/main/java/spoon/support/reflect/reference/CtParameterReferenceImpl.java b/src/main/java/spoon/support/reflect/reference/CtParameterReferenceImpl.java
@@ -10,7 +10,6 @@
 import spoon.reflect.declaration.CtElement;
 import spoon.reflect.declaration.CtExecutable;
 import spoon.reflect.declaration.CtParameter;
-import spoon.reflect.declaration.ParentNotInitializedException;
 import spoon.reflect.reference.CtExecutableReference;
 import spoon.reflect.reference.CtParameterReference;
 import spoon.reflect.visitor.CtVisitor;
@@ -51,22 +50,19 @@ private CtParameter<T> lookupDynamically() {
 		CtElement element = this;
 		CtParameter optional = null;
 		String name = getSimpleName();
-		try {
-			do {
-				CtExecutable executable = element.getParent(CtExecutable.class);
-				if (executable == null) {
-					return null;
+		do {
+			CtExecutable executable = element.getParent(CtExecutable.class);
+			if (executable == null) {
+				return null;
+			}
+			for (CtParameter parameter : (List<CtParameter>) executable.getParameters()) {
+				if (name.equals(parameter.getSimpleName())) {
+					optional = parameter;
 				}
-				for (CtParameter parameter : (List<CtParameter>) executable.getParameters()) {
-					if (name.equals(parameter.getSimpleName())) {
-						optional = parameter;
-					}
-				}
-				element = executable;
-			} while (optional == null);
-		} catch (ParentNotInitializedException e) {
-			return null;
-		}
+			}
+			element = executable;
+		} while (optional == null);
+
 		return optional;
 	}
 

diff --git a/src/main/java/spoon/support/reflect/reference/CtTypeParameterReferenceImpl.java b/src/main/java/spoon/support/reflect/reference/CtTypeParameterReferenceImpl.java
@@ -102,7 +102,7 @@ public CtTypeParameter getDeclaration() {
 			return null;
 		}
 
-		CtElement e = this;
+		CtElement typeDeclarer = this;
 		CtElement parent = getParent();
 
 		if (parent instanceof CtTypeParameter && Objects.equals(getSimpleName(), ((CtTypeParameter) parent).getSimpleName())) {
@@ -119,8 +119,8 @@ public CtTypeParameter getDeclaration() {
 				// we might enter in that case because of a call
 				// of getSuperInterfaces() for example
 				CtTypeReference typeReference = (CtTypeReference) parent;
-				e = typeReference.getTypeDeclaration();
-				if (e == null) {
+				typeDeclarer = typeReference.getTypeDeclaration();
+				if (typeDeclarer == null) {
 					return null;
 				}
 			} else {
@@ -130,31 +130,27 @@ public CtTypeParameter getDeclaration() {
 
 		if (parent instanceof CtExecutableReference) {
 			CtExecutableReference parentExec = (CtExecutableReference) parent;
-			if (Objects.nonNull(parentExec.getDeclaringType()) && !parentExec.getDeclaringType().equals(e)) {
+			if (Objects.nonNull(parentExec.getDeclaringType()) && !parentExec.getDeclaringType().equals(typeDeclarer)) {
 				CtElement parent2 = parentExec.getExecutableDeclaration();
 				if (parent2 instanceof CtMethod) {
-					e = parent2;
-				} else {
-					e = e.getParent(CtFormalTypeDeclarer.class);
+					typeDeclarer = parent2;
 				}
-			} else {
-				e = e.getParent(CtFormalTypeDeclarer.class);
-			}
-		} else {
-			if (!(e instanceof CtFormalTypeDeclarer)) {
-				e = e.getParent(CtFormalTypeDeclarer.class);
 			}
 		}
 
+		if (!(typeDeclarer instanceof CtFormalTypeDeclarer)) {
+			typeDeclarer = typeDeclarer.getParent(CtFormalTypeDeclarer.class);
+		}
+
 		// case #1: we're a type of a method parameter, a local variable, ...
 		// the strategy is to look in the parents
 		// collecting all formal type declarers of the hierarchy
-		while (e != null) {
-			CtTypeParameter result = findTypeParamDeclaration((CtFormalTypeDeclarer) e, this.getSimpleName());
+		while (typeDeclarer != null) {
+			CtTypeParameter result = findTypeParamDeclaration((CtFormalTypeDeclarer) typeDeclarer, this.getSimpleName());
 			if (result != null) {
 				return result;
 			}
-			e = e.getParent(CtFormalTypeDeclarer.class);
+			typeDeclarer = typeDeclarer.getParent(CtFormalTypeDeclarer.class);
 		}
 		return null;
 	}