Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(position): fix the position of catch variable #1969

Merged
merged 4 commits into from
Apr 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
import spoon.reflect.declaration.CtModule;
import spoon.reflect.declaration.CtParameter;
import spoon.reflect.declaration.CtTypeMember;
import spoon.reflect.declaration.CtVariable;
import spoon.reflect.declaration.ParentNotInitializedException;
import spoon.reflect.factory.Factory;
import spoon.reflect.visitor.CtInheritanceScanner;
Expand Down Expand Up @@ -364,7 +365,7 @@ public <T> void visitCtInterface(CtInterface<T> e) {
}

@Override
public <T> void visitCtField(CtField<T> e) {
public <T> void scanCtVariable(CtVariable<T> e) {
e.addComment(comment);
}

Expand Down Expand Up @@ -434,7 +435,7 @@ public void visitCtIf(CtIf e) {

@Override
public void scanCtStatement(CtStatement s) {
if (!(s instanceof CtStatementList || s instanceof CtSwitch)) {
if (!(s instanceof CtStatementList || s instanceof CtSwitch || s instanceof CtVariable)) {
s.addComment(comment);
}
}
Expand Down Expand Up @@ -463,7 +464,6 @@ public <T> void visitCtParameter(CtParameter<T> e) {
public void visitCtCatch(CtCatch e) {
if (comment.getPosition().getLine() <= e.getPosition().getLine()) {
e.addComment(comment);
return;
}
}

Expand Down
30 changes: 25 additions & 5 deletions src/main/java/spoon/support/compiler/jdt/PositionBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.eclipse.jdt.internal.compiler.ast.AbstractVariableDeclaration;
import org.eclipse.jdt.internal.compiler.ast.Annotation;
import org.eclipse.jdt.internal.compiler.ast.AnnotationMethodDeclaration;
import org.eclipse.jdt.internal.compiler.ast.Argument;
import org.eclipse.jdt.internal.compiler.ast.Expression;
import org.eclipse.jdt.internal.compiler.ast.Initializer;
import org.eclipse.jdt.internal.compiler.ast.Javadoc;
Expand All @@ -34,6 +35,7 @@
import spoon.reflect.code.CtStatementList;
import spoon.reflect.cu.CompilationUnit;
import spoon.reflect.cu.SourcePosition;
import spoon.reflect.cu.position.DeclarationSourcePosition;
import spoon.reflect.declaration.CtElement;
import spoon.reflect.declaration.CtModifiable;
import spoon.reflect.declaration.CtPackage;
Expand Down Expand Up @@ -236,11 +238,29 @@ SourcePosition buildPositionCtElement(CtElement e, ASTNode node) {
}
} else if (e instanceof CtCatchVariable) {
Iterator<ASTPair> iterator = this.jdtTreeBuilder.getContextBuilder().stack.iterator();
iterator.next();
ASTPair next = iterator.next();
buildPositionCtElement(e, next.node);
sourceEnd = getSourceEndOfTypeReference(contents, (TypeReference) node, sourceEnd);
return cf.createSourcePosition(cu, sourceStart, sourceEnd, lineSeparatorPositions);
ASTPair catchNode = iterator.next();
while (!(catchNode.node instanceof Argument)) {
catchNode = iterator.next();
}
DeclarationSourcePosition argumentPosition = (DeclarationSourcePosition) buildPositionCtElement(e, catchNode.node);

int variableNameStart = findNextNonWhitespace(contents, argumentPosition.getSourceEnd(), sourceEnd + 1);
int variableNameEnd = argumentPosition.getSourceEnd();

int modifierStart = sourceStart;
int modifierEnd = sourceStart - 1;
if (!getModifiers(((Argument) catchNode.node).modifiers, false, false).isEmpty()) {
modifierStart = argumentPosition.getModifierSourceStart();
modifierEnd = argumentPosition.getModifierSourceEnd();

sourceStart = modifierStart;
}
sourceEnd = argumentPosition.getSourceEnd();
return cf.createDeclarationSourcePosition(cu,
variableNameStart, variableNameEnd,
modifierStart, modifierEnd,
sourceStart, sourceEnd,
lineSeparatorPositions);
} else if (node instanceof TypeReference) {
sourceEnd = getSourceEndOfTypeReference(contents, (TypeReference) node, sourceEnd);
}
Expand Down
103 changes: 78 additions & 25 deletions src/test/java/spoon/test/position/PositionTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,7 @@
import org.apache.commons.io.FileUtils;
import org.junit.Test;
import spoon.Launcher;
import spoon.reflect.code.CtAssignment;
import spoon.reflect.code.CtBlock;
import spoon.reflect.code.CtExpression;
import spoon.reflect.code.CtFieldAccess;
import spoon.reflect.code.CtIf;
import spoon.reflect.code.CtLocalVariable;
import spoon.reflect.code.CtNewClass;
import spoon.reflect.code.CtStatement;
import spoon.reflect.code.*;
import spoon.reflect.cu.SourcePosition;
import spoon.reflect.cu.position.BodyHolderSourcePosition;
import spoon.reflect.cu.position.DeclarationSourcePosition;
Expand All @@ -23,26 +16,14 @@
import spoon.reflect.factory.Factory;
import spoon.reflect.reference.CtTypeReference;
import spoon.reflect.visitor.filter.TypeFilter;
import spoon.test.position.testclasses.AnnonymousClassNewIface;
import spoon.test.position.testclasses.Foo;
import spoon.test.position.testclasses.FooAbstractMethod;
import spoon.test.position.testclasses.FooAnnotation;
import spoon.test.position.testclasses.FooClazz;
import spoon.test.position.testclasses.FooClazz2;
import spoon.test.position.testclasses.FooClazzWithComments;
import spoon.test.position.testclasses.FooField;
import spoon.test.position.testclasses.FooGeneric;
import spoon.test.position.testclasses.FooInterface;
import spoon.test.position.testclasses.FooMethod;
import spoon.test.position.testclasses.FooStatement;
import spoon.test.position.testclasses.NoMethodModifiers;
import spoon.test.position.testclasses.PositionParameterTypeWithReference;
import spoon.test.position.testclasses.SomeEnum;
import spoon.test.position.testclasses.TypeParameter;
import spoon.test.comment.testclasses.Comment1;
import spoon.test.position.testclasses.*;
import spoon.test.query_function.testclasses.VariableReferencesModelTest;
import spoon.testing.utils.ModelUtils;

import java.io.File;
import java.io.IOException;
import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
Expand Down Expand Up @@ -680,5 +661,77 @@ public void testEmptyModifiersOfMethod() throws Exception {
assertEquals(end, bhsp.getBodyStart());
assertEquals(end - 1, bhsp.getBodyEnd());
}


@Test
public void testPositionTryCatch() throws Exception {
//contract: check that the variable in the catch has a correct position
CtType<?> foo = ModelUtils.buildClass(PositionTry.class);
String classContent = getClassContent(foo);

List<CtCatchVariable> elements = foo.getElements(new TypeFilter<>(CtCatchVariable.class));

CtCatchVariable withoutModifier = elements.get(0);
assertEquals("java.lang.Exception e", contentAtPosition(classContent, withoutModifier.getPosition().getSourceStart(), withoutModifier.getPosition().getSourceEnd()));
assertEquals("e", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameEnd()));
assertEquals("", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceEnd()));

CtCatchVariable withModifier = elements.get(1);
assertEquals("final java.lang.Exception e", contentAtPosition(classContent, withModifier.getPosition().getSourceStart(), withModifier.getPosition().getSourceEnd()));
assertEquals("e", contentAtPosition(classContent,
((DeclarationSourcePosition) withModifier.getPosition()).getNameStart(),
((DeclarationSourcePosition) withModifier.getPosition()).getNameEnd()));
assertEquals("final", contentAtPosition(classContent,
((DeclarationSourcePosition) withModifier.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withModifier.getPosition()).getModifierSourceEnd()));

CtCatchVariable withMultipleCatch = elements.get(2);
assertEquals("NullPointerException | java.lang.ArithmeticException e", contentAtPosition(classContent, withMultipleCatch.getPosition().getSourceStart(), withMultipleCatch.getPosition().getSourceEnd()));
assertEquals("e", contentAtPosition(classContent,
((DeclarationSourcePosition) withMultipleCatch.getPosition()).getNameStart(),
((DeclarationSourcePosition) withMultipleCatch.getPosition()).getNameEnd()));
assertEquals("", contentAtPosition(classContent,
((DeclarationSourcePosition) withMultipleCatch.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withMultipleCatch.getPosition()).getModifierSourceEnd()));

foo = buildClass(Comment1.class);
classContent = getClassContent(foo);
elements = foo.getElements(new TypeFilter<>(CtCatchVariable.class));
withoutModifier = elements.get(0);
assertEquals("Exception ex", contentAtPosition(classContent, withoutModifier.getPosition().getSourceStart(), withoutModifier.getPosition().getSourceEnd()));
assertEquals("ex", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameEnd()));
assertEquals("", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceEnd()));


foo = buildClass(VariableReferencesModelTest.class);
classContent = getClassContent(foo);
elements = foo.getElements(new TypeFilter<>(CtCatchVariable.class));
withoutModifier = elements.get(0);
assertEquals("IllegalArgumentException e", contentAtPosition(classContent, withoutModifier.getPosition().getSourceStart(), withoutModifier.getPosition().getSourceEnd()));
assertEquals("e", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameEnd()));
assertEquals("", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceEnd()));

withoutModifier = elements.get(1);
assertEquals("Exception /*7*/field", contentAtPosition(classContent, withoutModifier.getPosition().getSourceStart(), withoutModifier.getPosition().getSourceEnd()));
assertEquals("field", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getNameEnd()));
assertEquals("", contentAtPosition(classContent,
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceStart(),
((DeclarationSourcePosition) withoutModifier.getPosition()).getModifierSourceEnd()));



}
}
27 changes: 27 additions & 0 deletions src/test/java/spoon/test/position/testclasses/PositionTry.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package spoon.test.position.testclasses;

public class PositionTry {
public void withoutModifier() {
try {

} catch (java.lang.Exception e) {

}
}

public void withModifier() {
try {

} catch (final java.lang.Exception e) {

}
}

public void multipleCatch() {
try {

} catch (NullPointerException | java.lang.ArithmeticException e) {

}
}
}