feature(API): add CtTypeMember.getTopLevelType() (#1004)

src/main/java/spoon/reflect/declaration/CtTypeMember.java

@@ -32,4 +32,10 @@ public interface CtTypeMember extends CtModifiable {
  @DerivedProperty
  CtType<?> getDeclaringType();
 
+ /**
+ * Returns the top level type declaring this type if an inner type or type member.
+ * If this is already a top-level type, then returns itself.
+ */
+ @DerivedProperty
+ <T> CtType<T> getTopLevelType();
 }

src/main/java/spoon/support/reflect/declaration/CtAnonymousExecutableImpl.java

@@ -17,7 +17,6 @@
 package spoon.support.reflect.declaration;
 
 import spoon.reflect.declaration.CtAnonymousExecutable;
-import spoon.reflect.declaration.CtClass;
 import spoon.reflect.declaration.CtExecutable;
 import spoon.reflect.declaration.CtModifiable;
 import spoon.reflect.declaration.CtNamedElement;
@@ -61,11 +60,6 @@ public Set<ModifierKind> getModifiers() {
  return modifiers;
  }
 
- @Override
- public CtClass<?> getDeclaringType() {
- return (CtClass<?>) parent;
- }
-
  @Override
  public ModifierKind getVisibility() {
  if (getModifiers().contains(ModifierKind.PUBLIC)) {

src/main/java/spoon/support/reflect/declaration/CtExecutableImpl.java

@@ -27,6 +27,7 @@
 import spoon.reflect.code.CtStatement;
 import spoon.reflect.declaration.CtExecutable;
 import spoon.reflect.declaration.CtParameter;
+import spoon.reflect.declaration.CtType;
 import spoon.reflect.reference.CtExecutableReference;
 import spoon.reflect.reference.CtTypeReference;
 import spoon.support.util.QualifiedNameBasedSortedSet;
@@ -50,6 +51,14 @@ public CtExecutableImpl() {
  super();
  }
 
+ public CtType<?> getDeclaringType() {
+ return (CtType<?>) parent;
+ }
+
+ public <T> CtType<T> getTopLevelType() {
+ return getDeclaringType().getTopLevelType();
+ }
+
  @Override
  @SuppressWarnings("unchecked")
  public CtBlock<R> getBody() {

src/main/java/spoon/support/reflect/declaration/CtFieldImpl.java

@@ -61,6 +61,11 @@ public CtType<?> getDeclaringType() {
  return (CtType<?>) parent;
  }
 
+ @Override
+ public <T> CtType<T> getTopLevelType() {
+ return getDeclaringType().getTopLevelType();
+ }
+
  @Override
  public CtExpression<T> getDefaultExpression() {
  return defaultExpression;

src/main/java/spoon/support/reflect/declaration/CtMethodImpl.java

@@ -21,7 +21,6 @@
 import spoon.reflect.declaration.CtMethod;
 import spoon.reflect.declaration.CtModifiable;
 import spoon.reflect.declaration.CtShadowable;
-import spoon.reflect.declaration.CtType;
 import spoon.reflect.declaration.CtTypeParameter;
 import spoon.reflect.declaration.CtTypedElement;
 import spoon.reflect.declaration.ModifierKind;
@@ -77,11 +76,6 @@ public <C extends CtTypedElement> C setType(CtTypeReference<T> type) {
  return (C) this;
  }
 
- @Override
- public CtType<?> getDeclaringType() {
- return (CtType<?>) parent;
- }
-
  @Override
  public boolean isDefaultMethod() {
  return defaultMethod;

src/main/java/spoon/support/reflect/declaration/CtTypeImpl.java

@@ -298,6 +298,20 @@ public CtType<?> getDeclaringType() {
  }
  }
 
+ @SuppressWarnings("unchecked")
+ @Override
+ public <T> CtType<T> getTopLevelType() {
+ CtType<?> top = this;
+
+ while (true) {
+ CtType<?> nextTop = top.getDeclaringType();
+ if (nextTop == null) {
+ return (CtType<T>) top;
+ }
+ top = nextTop;
+ }
+ }
+
  @Override
  @SuppressWarnings("unchecked")
  public <N extends CtType<?>> N getNestedType(final String name) {

src/test/java/spoon/test/parent/TopLevelTypeTest.java

@@ -0,0 +1,46 @@
+package spoon.test.parent;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import spoon.Launcher;
+import spoon.compiler.SpoonResourceHelper;
+import spoon.reflect.declaration.CtClass;
+import spoon.reflect.declaration.CtMethod;
+import spoon.reflect.factory.Factory;
+
+public class TopLevelTypeTest
+{
+ Factory factory;
+
+ @Before
+ public void setup() throws Exception {
+ Launcher spoon = new Launcher();
+ spoon.setArgs(new String[] {"--output-type", "nooutput" });
+ factory = spoon.createFactory();
+ spoon.createCompiler(
+ factory,
+ SpoonResourceHelper
+ .resources("./src/test/java/spoon/test/parent/Foo.java"))
+ .build();
+ }
+
+
+ @Test
+ public void testTopLevelType() throws Exception {
+ CtClass<?> foo = factory.Class().get(Foo.class);
+ assertEquals(foo, foo.getTopLevelType());
+ CtMethod<?> internalClassMethod = foo.getMethod("internalClass");
+ assertEquals(foo, internalClassMethod.getDeclaringType());
+ assertEquals(foo, internalClassMethod.getTopLevelType());
+ CtClass<?> internalClass = (CtClass<?>)internalClassMethod.getBody().getStatement(0);
+ assertEquals(foo, internalClassMethod.getDeclaringType());
+ assertEquals(foo, internalClassMethod.getTopLevelType());
+ CtMethod<?> mm = internalClass.getMethod("m");
+ assertEquals(internalClass, mm.getDeclaringType());
+ assertEquals(foo, mm.getTopLevelType());
+ }
+
+}