From 0a72d642d53807f4cda74b503868a0b65a16f07f Mon Sep 17 00:00:00 2001 From: tdurieux Date: Mon, 23 Nov 2015 10:32:55 +0100 Subject: [PATCH] Fix the position in the spoon model --- .../support/compiler/jdt/JDTTreeBuilder.java | 26 +- .../support/compiler/jdt/ParentExiter.java | 2 +- .../spoon/test/position/PositionTest.java | 225 ++++++++++++++++++ .../test/position/testclasses/FooClazz.java | 6 + .../test/position/testclasses/FooField.java | 9 + .../test/position/testclasses/FooMethod.java | 8 + .../position/testclasses/FooStatement.java | 28 +++ 7 files changed, 300 insertions(+), 4 deletions(-) create mode 100644 src/test/java/spoon/test/position/PositionTest.java create mode 100644 src/test/java/spoon/test/position/testclasses/FooClazz.java create mode 100644 src/test/java/spoon/test/position/testclasses/FooField.java create mode 100644 src/test/java/spoon/test/position/testclasses/FooMethod.java create mode 100644 src/test/java/spoon/test/position/testclasses/FooStatement.java diff --git a/src/main/java/spoon/support/compiler/jdt/JDTTreeBuilder.java b/src/main/java/spoon/support/compiler/jdt/JDTTreeBuilder.java index 8f662e0c8be..39a2c51766c 100644 --- a/src/main/java/spoon/support/compiler/jdt/JDTTreeBuilder.java +++ b/src/main/java/spoon/support/compiler/jdt/JDTTreeBuilder.java @@ -23,6 +23,7 @@ import org.eclipse.jdt.internal.compiler.ast.AND_AND_Expression; import org.eclipse.jdt.internal.compiler.ast.ASTNode; import org.eclipse.jdt.internal.compiler.ast.AbstractMethodDeclaration; +import org.eclipse.jdt.internal.compiler.ast.AbstractVariableDeclaration; import org.eclipse.jdt.internal.compiler.ast.AllocationExpression; import org.eclipse.jdt.internal.compiler.ast.Annotation; import org.eclipse.jdt.internal.compiler.ast.AnnotationMethodDeclaration; @@ -297,9 +298,28 @@ void enter(CtElement e, ASTNode node) { CoreFactory cf = factory.Core(); int sourceStart = node.sourceStart; int sourceEnd = node.sourceEnd; - if ((e instanceof CtBlock) && (node instanceof MethodDeclaration)) { - sourceStart = ((MethodDeclaration) node).bodyStart; - sourceEnd = ((MethodDeclaration) node).bodyEnd; + if (node instanceof AbstractVariableDeclaration) { + sourceStart = ((AbstractVariableDeclaration) node).declarationSourceStart; + sourceEnd = ((AbstractVariableDeclaration) node).declarationSourceEnd; + } else if (node instanceof TypeDeclaration) { + sourceStart = ((TypeDeclaration) node).declarationSourceStart; + sourceEnd = ((TypeDeclaration) node).declarationSourceEnd; + } else if ((e instanceof CtBlock) && (node instanceof AbstractMethodDeclaration)) { + sourceStart = ((AbstractMethodDeclaration) node).bodyStart - 1; + sourceEnd = ((AbstractMethodDeclaration) node).bodyEnd + 1; + } else if ((node instanceof AbstractMethodDeclaration)) { + if (((AbstractMethodDeclaration) node).bodyStart == 0) { + sourceStart = -1; + sourceEnd = -1; + } else { + sourceStart = ((AbstractMethodDeclaration) node).declarationSourceStart; + sourceEnd = ((AbstractMethodDeclaration) node).declarationSourceEnd; + } + } + if ((node instanceof Expression)) { + if (((Expression) node).statementEnd > 0) { + sourceEnd = ((Expression) node).statementEnd; + } } CompilationUnit cu = factory.CompilationUnit().create(new String(compilationunitdeclaration.getFileName())); e.setPosition(cf.createSourcePosition(cu, sourceStart, sourceEnd, compilationunitdeclaration.compilationResult.lineSeparatorPositions)); diff --git a/src/main/java/spoon/support/compiler/jdt/ParentExiter.java b/src/main/java/spoon/support/compiler/jdt/ParentExiter.java index fc007a8b9ed..9d9c885d494 100644 --- a/src/main/java/spoon/support/compiler/jdt/ParentExiter.java +++ b/src/main/java/spoon/support/compiler/jdt/ParentExiter.java @@ -270,7 +270,7 @@ public void visitCtClass(CtClass ctClass) { if (child instanceof CtConstructor) { CtConstructor c = (CtConstructor) child; ctClass.addConstructor(c); - if (c.getPosition() != null && c.getPosition().equals(ctClass.getPosition())) { + if (c.getPosition() != null && c.getPosition().getSourceStart() == -1) { c.setImplicit(true); } } diff --git a/src/test/java/spoon/test/position/PositionTest.java b/src/test/java/spoon/test/position/PositionTest.java new file mode 100644 index 00000000000..233bb40d09c --- /dev/null +++ b/src/test/java/spoon/test/position/PositionTest.java @@ -0,0 +1,225 @@ +package spoon.test.position; + +import org.junit.Test; +import spoon.reflect.code.CtBlock; +import spoon.reflect.code.CtIf; +import spoon.reflect.cu.SourcePosition; +import spoon.reflect.declaration.CtMethod; +import spoon.reflect.declaration.CtType; +import spoon.reflect.factory.Factory; +import spoon.test.TestUtils; +import spoon.test.position.testclasses.FooClazz; +import spoon.test.position.testclasses.FooField; +import spoon.test.position.testclasses.FooMethod; +import spoon.test.position.testclasses.FooStatement; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Paths; + +import static org.junit.Assert.assertEquals; + +public class PositionTest { + + @Test + public void testPositionClass() throws Exception { + final Factory build = TestUtils.build(FooClazz.class); + final CtType foo = build.Type().get(FooClazz.class); + String classContent = getClassContent(foo); + + SourcePosition position = foo.getPosition(); + + assertEquals(3, position.getLine()); + assertEquals(6, position.getEndLine()); + + assertEquals(42, position.getSourceStart()); + assertEquals(79, position.getSourceEnd()); + assertEquals("@Deprecated"+ System.lineSeparator() + + "public class FooClazz {"+ System.lineSeparator() + + System.lineSeparator() + + "}", contentAtPosition(classContent, position)); + } + + @Test + public void testPositionField() throws Exception { + final Factory build = TestUtils.build(FooField.class); + final CtType foo = build.Type().get(FooField.class); + String classContent = getClassContent(foo); + + SourcePosition position1 = foo.getField("field1").getPosition(); + + assertEquals(5, position1.getLine()); + assertEquals(5, position1.getEndLine()); + + assertEquals(68, position1.getSourceStart()); + assertEquals(95, position1.getSourceEnd()); + + assertEquals("public final int field1 = 0;", contentAtPosition(classContent, position1)); + + SourcePosition position2 = foo.getField("field2").getPosition(); + + assertEquals(7, position2.getLine()); + assertEquals(8, position2.getEndLine()); + + assertEquals(99, position2.getSourceStart()); + assertEquals(116, position2.getSourceEnd()); + + assertEquals("int field2 ="+ System.lineSeparator() + + "\t\t\t0;", contentAtPosition(classContent, position2)); + } + + @Test + public void testPositionMethod() throws Exception { + final Factory build = TestUtils.build(FooMethod.class); + final CtType foo = build.Type().get(FooMethod.class); + String classContent = getClassContent(foo); + + CtMethod method1 = foo.getMethodsByName("m").get(0); + SourcePosition position1 = method1.getPosition(); + + assertEquals(5, position1.getLine()); + assertEquals(7, position1.getEndLine()); + + assertEquals(69, position1.getSourceStart()); + assertEquals(114, position1.getSourceEnd()); + + assertEquals("public static void m(int parm1) {\n" + + "\t\treturn;\n" + + "\t}", contentAtPosition(classContent, position1)); + + SourcePosition positionParam1 = method1.getParameters().get(0).getPosition(); + + assertEquals(5, positionParam1.getLine()); + assertEquals(5, positionParam1.getEndLine()); + + assertEquals(90, positionParam1.getSourceStart()); + assertEquals(98, positionParam1.getSourceEnd()); + + assertEquals("int parm1", contentAtPosition(classContent, positionParam1)); + } + + @Test + public void testPositionStatement() throws Exception { + final Factory build = TestUtils.build(FooStatement.class); + final CtType foo = build.Type().get(FooStatement.class); + String classContent = getClassContent(foo); + + CtMethod method1 = foo.getMethodsByName("m").get(0); + CtBlock body = method1.getBody(); + SourcePosition positionBody = body.getPosition(); + + assertEquals(7, positionBody.getLine()); + assertEquals(23, positionBody.getEndLine()); + + assertEquals("{\n" + + "\t\tint field2 = m2(parm1);\n" + + "\t\tthis.field = m2(parm1);\n" + + "\t\tif(parm1 > 2 && true) {\n" + + "\t\t\tswitch (parm1) {\n" + + "\t\t\tcase 1:\n" + + "\t\t\t\treturn;\n" + + "\t\t\tdefault:\n" + + "\t\t\t\tparm1++;\n" + + "\t\t\t}\n" + + "\t\t\tint count = 0;\n" + + "\t\t\tfor (int i =0; i< parm1; i++) {\n" + + "\t\t\t\tcount ++;\n" + + "\t\t\t}\n" + + "\t\t}\n" + + "\t\treturn;\n" + + "\t}", contentAtPosition(classContent, positionBody)); + + SourcePosition positionLocalVariable = body.getStatement(0).getPosition(); + + assertEquals(8, positionLocalVariable.getLine()); + assertEquals(8, positionLocalVariable.getEndLine()); + + assertEquals("int field2 = m2(parm1);", contentAtPosition(classContent, positionLocalVariable)); + + SourcePosition positionFieldWrite = body.getStatement(1).getPosition(); + + assertEquals(9, positionFieldWrite.getLine()); + assertEquals(9, positionFieldWrite.getEndLine()); + + assertEquals("this.field = m2(parm1);", contentAtPosition(classContent, positionFieldWrite)); + + CtIf ctIf = body.getStatement(2); + SourcePosition positionIf = ctIf.getPosition(); + + assertEquals(10, positionIf.getLine()); + assertEquals(21, positionIf.getEndLine()); + + assertEquals("if(parm1 > 2 && true) {\n" + + "\t\t\tswitch (parm1) {\n" + + "\t\t\tcase 1:\n" + + "\t\t\t\treturn;\n" + + "\t\t\tdefault:\n" + + "\t\t\t\tparm1++;\n" + + "\t\t\t}\n" + + "\t\t\tint count = 0;\n" + + "\t\t\tfor (int i =0; i< parm1; i++) {\n" + + "\t\t\t\tcount ++;\n" + + "\t\t\t}\n" + + "\t\t}", contentAtPosition(classContent, positionIf)); + + SourcePosition positionSwitch = ((CtBlock)ctIf.getThenStatement()).getStatement(0).getPosition(); + + assertEquals(11, positionSwitch.getLine()); + assertEquals(16, positionSwitch.getEndLine()); + + assertEquals("switch (parm1) {\n" + + "\t\t\tcase 1:\n" + + "\t\t\t\treturn;\n" + + "\t\t\tdefault:\n" + + "\t\t\t\tparm1++;\n" + + "\t\t\t}", contentAtPosition(classContent, positionSwitch)); + + positionLocalVariable = ((CtBlock)ctIf.getThenStatement()).getStatement(1).getPosition(); + + assertEquals(17, positionLocalVariable.getLine()); + assertEquals(17, positionLocalVariable.getEndLine()); + + assertEquals("int count = 0;", contentAtPosition(classContent, positionLocalVariable)); + + SourcePosition positionFor = ((CtBlock)ctIf.getThenStatement()).getStatement(2).getPosition(); + + assertEquals(18, positionFor.getLine()); + assertEquals(20, positionFor.getEndLine()); + + assertEquals("for (int i =0; i< parm1; i++) {\n" + + "\t\t\t\tcount ++;\n" + + "\t\t\t}", contentAtPosition(classContent, positionFor)); + + SourcePosition positionReturn = method1.getBody().getStatement(3).getPosition(); + + assertEquals(22, positionReturn.getLine()); + assertEquals(22, positionReturn.getEndLine()); + + assertEquals("return;", contentAtPosition(classContent, positionReturn)); + } + + + private String getClassContent(CtType type) { + File file = type.getPosition().getFile(); + String content = ""; + Charset charset = Charset.forName("UTF-8"); + try (BufferedReader reader = Files.newBufferedReader( + Paths.get(file.getPath()), charset)) { + String line = null; + while ((line = reader.readLine()) != null) { + content+=line + "\n"; + } + } catch (IOException x) { + System.err.format("IOException: %s%n", x); + } + + return content; + } + + private String contentAtPosition(String content, SourcePosition position) { + return content.substring(position.getSourceStart(), position.getSourceEnd() + 1); + } +} diff --git a/src/test/java/spoon/test/position/testclasses/FooClazz.java b/src/test/java/spoon/test/position/testclasses/FooClazz.java new file mode 100644 index 00000000000..bccba988137 --- /dev/null +++ b/src/test/java/spoon/test/position/testclasses/FooClazz.java @@ -0,0 +1,6 @@ +package spoon.test.position.testclasses; + +@Deprecated +public class FooClazz { + +} \ No newline at end of file diff --git a/src/test/java/spoon/test/position/testclasses/FooField.java b/src/test/java/spoon/test/position/testclasses/FooField.java new file mode 100644 index 00000000000..9cc0eeb96af --- /dev/null +++ b/src/test/java/spoon/test/position/testclasses/FooField.java @@ -0,0 +1,9 @@ +package spoon.test.position.testclasses; + +public class FooField { + + public final int field1 = 0; + + int field2 = + 0; +} \ No newline at end of file diff --git a/src/test/java/spoon/test/position/testclasses/FooMethod.java b/src/test/java/spoon/test/position/testclasses/FooMethod.java new file mode 100644 index 00000000000..e068e58cc7a --- /dev/null +++ b/src/test/java/spoon/test/position/testclasses/FooMethod.java @@ -0,0 +1,8 @@ +package spoon.test.position.testclasses; + +public class FooMethod { + + public static void m(int parm1) { + return; + } +} \ No newline at end of file diff --git a/src/test/java/spoon/test/position/testclasses/FooStatement.java b/src/test/java/spoon/test/position/testclasses/FooStatement.java new file mode 100644 index 00000000000..2fcf33ea36a --- /dev/null +++ b/src/test/java/spoon/test/position/testclasses/FooStatement.java @@ -0,0 +1,28 @@ +package spoon.test.position.testclasses; + +public class FooStatement { + + private int field = 0; + + public void m(int parm1) { + int field2 = m2(parm1); + this.field = m2(parm1); + if(parm1 > 2 && true) { + switch (parm1) { + case 1: + return; + default: + parm1++; + } + int count = 0; + for (int i =0; i< parm1; i++) { + count ++; + } + } + return; + } + + public int m2(int parm1) { + return parm1; + } +} \ No newline at end of file