refactor: remove @deprecated methods (INRIA#3184)

* up

* up

* @monperrus at work 🗣

* @monperrus at work 🤜

* @monperrus at work 🤢

* @monperrus at work 💻

* @monperrus at work 🏇

doc/first_transformation.md

@@ -117,9 +117,10 @@ public class ClassProcessor extends AbstractProcessor<CtClass<?>> {
 
 ## Refactoring transformations
 
-Spoon can be used for automated refactoring such as renaming variables programmatically.
+Spoon provides some methods for automated refactoring:.
 
 * [Local Variable Refactoring](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/refactoring/CtRenameLocalVariableRefactoring.html)
 class, renames local variables and includes extra checking to ensure program correctness after renaming,
 * [Generic Variable Refactoring](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/refactoring/CtRenameGenericVariableRefactoring.html)
 class, renames any variable type (field, parameter, local), but does not do any extra checking to ensure program correctness.
+* `Refactoring` contains helper methods for refactoring, incl. one for automated removal of deprecated methods.

src/main/java/spoon/refactoring/Refactoring.java

@@ -5,7 +5,9 @@
  */
 package spoon.refactoring;
 
+import spoon.Launcher;
 import spoon.SpoonException;
+import spoon.processing.AbstractProcessor;
 import spoon.reflect.code.CtLocalVariable;
 import spoon.reflect.declaration.CtExecutable;
 import spoon.reflect.declaration.CtField;
@@ -17,6 +19,7 @@
 import spoon.reflect.visitor.CtScanner;
 import spoon.reflect.visitor.Query;
 import spoon.reflect.visitor.filter.TypeFilter;
+import spoon.support.sniper.SniperJavaPrettyPrinter;
 
 import java.util.List;
 
@@ -205,4 +208,35 @@ public <T> void visitCtFieldReference(CtFieldReference<T> reference) {
 	public static void changeLocalVariableName(CtLocalVariable<?> localVariable, String newName) throws RefactoringException {
 		new CtRenameLocalVariableRefactoring().setTarget(localVariable).setNewName(newName).refactor();
 	}
+
+	/** Deletes all deprecated methods in the given path */
+	public static void removeDeprecatedMethods(String path) {
+		Launcher spoon = new Launcher();
+		spoon.addInputResource(path);
+		spoon.setSourceOutputDirectory(path);
+		spoon.addProcessor(new AbstractProcessor<CtMethod>() {
+			@Override
+			public void process(CtMethod method) {
+				if (method.hasAnnotation(Deprecated.class)) {
+					method.delete();
+				}
+			}
+		});
+
+		// does not work, see https://github.com/INRIA/spoon/issues/3183
+//		spoon.addProcessor(new AbstractProcessor<CtType>() {
+//			@Override
+//			public void process(CtType type) {
+//				if (type.hasAnnotation(Deprecated.class)) {
+//					type.delete();
+//				}
+//			}
+//		});
+
+		spoon.getEnvironment().setPrettyPrinterCreator(() -> {
+					return new SniperJavaPrettyPrinter(spoon.getEnvironment());
+				}
+		);
+		spoon.run();
+	}
 }

src/main/java/spoon/reflect/cu/CompilationUnit.java

@@ -11,38 +11,6 @@
  * Defines a compilation unit. In Java, a compilation unit can contain only one
  * public type declaration and other secondary types declarations (not public).
  */
+@Deprecated
 public interface CompilationUnit extends CtCompilationUnit {
-
-
-	/**
-	 * Helper method to get the begin index of the line that corresponds to the
-	 * given index.
-	 *
-	 * @param index
-	 * 		an arbitrary index in the source code
-	 * @return the index where the line starts
-	 */
-	@Deprecated
-	int beginOfLineIndex(int index);
-
-	/**
-	 * Helper method to get the begin index of the line that corresponds to the
-	 * next line of the given index.
-	 *
-	 * @param index
-	 * 		an arbitrary index in the source code
-	 * @return the index where the next line starts
-	 */
-	@Deprecated
-	int nextLineIndex(int index);
-
-	/**
-	 * Gets the number of tabulations for a given line.
-	 *
-	 * @param index
-	 * 		the index where the line starts in the source code
-	 * @return the number of tabs for this line
-	 */
-	@Deprecated
-	int getTabCount(int index);
 }

src/main/java/spoon/reflect/visitor/DefaultJavaPrettyPrinter.java

@@ -113,7 +113,6 @@
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -1990,25 +1989,6 @@ public void reset() {
 		context = new PrintingContext();
 	}
 
-
-	/**
-	 * Write the compilation unit header.
-	 */
-	@Deprecated
-	public DefaultJavaPrettyPrinter writeHeader(List<CtType<?>> types, Collection<CtImport> imports) {
-		elementPrinterHelper.writeHeader(types, imports);
-		return this;
-	}
-
-	/**
-	 * Write the compilation unit footer.
-	 */
-	@Deprecated
-	public DefaultJavaPrettyPrinter writeFooter(List<CtType<?>> types) {
-		elementPrinterHelper.writeFooter(types);
-		return this;
-	}
-
 	@Override
 	public void calculate(CtCompilationUnit sourceCompilationUnit, List<CtType<?>> types) {
 		if (types.isEmpty()) {
@@ -2046,20 +2026,6 @@ private boolean hasSameTypes(CtCompilationUnit compilationUnit, List<CtType<?>>
 		return cuQnames.equals(qnames);
 	}
 
-	@Deprecated
-	protected void printTypes(List<CtType<?>> types) {
-		for (CtType<?> t : types) {
-			scan(t);
-			if (!env.isPreserveLineNumbers()) {
-				// saving lines and chars
-				printer.writeln().writeln();
-			} else {
-				getPrinterHelper().adjustEndPosition(t);
-			}
-		}
-		this.writeFooter(types);
-	}
-
 	@Override
 	public Map<Integer, Integer> getLineNumberMapping() {
 		return getPrinterHelper().getLineNumberMapping();

src/main/java/spoon/reflect/visitor/ElementPrinterHelper.java

@@ -346,37 +346,6 @@ public void writeImports(Collection<CtImport> imports) {
 		}
 	}
 
-	/**
-	 * Write the compilation unit header.
-	 */
-	@Deprecated
-	public void writeHeader(List<CtType<?>> types, Collection<CtImport> imports) {
-		if (!types.isEmpty()) {
-			for (CtType<?> ctType : types) {
-				writeComment(ctType, CommentOffset.TOP_FILE);
-			}
-			// writing the header package
-			if (!types.get(0).getPackage().isUnnamedPackage()) {
-				writePackageLine(types.get(0).getPackage().getQualifiedName());
-			}
-			this.writeImports(imports);
-			printer.writeln();
-			printer.writeln();
-		}
-	}
-
-	/**
-	 * Write the compilation unit footer.
-	 */
-	@Deprecated
-	public void writeFooter(List<CtType<?>> types) {
-		if (!types.isEmpty()) {
-			for (CtType<?> ctType : types) {
-				writeComment(ctType, CommentOffset.BOTTOM_FILE);
-			}
-		}
-	}
-
 	public void writePackageLine(String packageQualifiedName) {
 		printer.writeKeyword("package").writeSpace();
 		writeQualifiedName(packageQualifiedName).writeSeparator(";").writeln();