Skip to content

Commit

Permalink
Merge pull request #321 from njit-jerse/refactoring-visitors
Browse files Browse the repository at this point in the history 
Refactor visitors to share state and simplify constructing one visitor from the previous one
  • Loading branch information
@kelloggm
kelloggm authored Jul 16, 2024
2 parents 38f9589 + 0fbff77 commit 16b331e
Show file tree
Hide file tree
Showing 6 changed files with 183 additions and 277 deletions.
47 changes: 6 additions & 41 deletions src/main/java/org/checkerframework/specimin/MustImplementMethodsVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,13 @@
import com.github.javaparser.ast.expr.SuperExpr;
import com.github.javaparser.ast.stmt.BlockStmt;
import com.github.javaparser.ast.type.ClassOrInterfaceType;
import com.github.javaparser.ast.visitor.ModifierVisitor;
import com.github.javaparser.ast.visitor.Visitable;
import com.github.javaparser.resolution.UnsolvedSymbolException;
import com.github.javaparser.resolution.declarations.ResolvedMethodDeclaration;
import com.github.javaparser.resolution.declarations.ResolvedParameterDeclaration;
import com.github.javaparser.resolution.types.ResolvedReferenceType;
import com.github.javaparser.resolution.types.parametrization.ResolvedTypeParametersMap;
import java.nio.file.Path;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.checkerframework.checker.nullness.qual.Nullable;

Expand All @@ -28,55 +25,23 @@
* or implements an interface that requires them), this visitor marks them for preservation. Should
* run after the list of used classes is finalized.
*/
public class MustImplementMethodsVisitor extends ModifierVisitor<Void> {

/** Set containing the signatures of used member (fields and methods). */
private Set<String> usedMembers;

/** Set containing the signatures of used classes. */
private Set<String> usedClass;

/** for checking if class files are in the original codebase. */
private Map<String, Path> existingClassesToFilePath;
public class MustImplementMethodsVisitor extends SpeciminStateVisitor {

/**
* Constructs a new SolveMethodOverridingVisitor with the provided sets of target methods, used
* members, and used classes.
*
* @param usedMembers Set containing the signatures of used members.
* @param usedClass Set containing the signatures of used classes.
* @param existingClassesToFilePath map from existing classes to file paths
*/
public MustImplementMethodsVisitor(
Set<String> usedMembers, Set<String> usedClass, Map<String, Path> existingClassesToFilePath) {
this.usedMembers = usedMembers;
this.usedClass = usedClass;
this.existingClassesToFilePath = existingClassesToFilePath;
}

/**
* Get the set containing the signatures of used members.
*
* @return The set containing the signatures of used members.
*/
public Set<String> getUsedMembers() {
return usedMembers;
}

/**
* Get the set containing the signatures of used classes.
*
* @return The set containing the signatures of used classes.
* @param previousVisitor the last visitor to run
*/
public Set<String> getUsedClass() {
return usedClass;
public MustImplementMethodsVisitor(SpeciminStateVisitor previousVisitor) {
super(previousVisitor);
}

@Override
@SuppressWarnings("nullness:return") // ok to return null, because this is a void visitor
public Visitable visit(ClassOrInterfaceDeclaration type, Void p) {
if (type.getFullyQualifiedName().isPresent()
&& usedClass.contains(type.getFullyQualifiedName().get())) {
&& usedTypeElements.contains(type.getFullyQualifiedName().get())) {
return super.visit(type, p);
} else {
// the effect of not calling super here is that only used classes
Expand Down Expand Up @@ -122,7 +87,7 @@ public Visitable visit(MethodDeclaration method, Void p) {
if (type.contains("[]")) {
type = type.replace("[]", "");
}
usedClass.add(type);
usedTypeElements.add(type);
}
}
return super.visit(method, p);
Expand Down
106 changes: 32 additions & 74 deletions src/main/java/org/checkerframework/specimin/PrunerVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import com.github.javaparser.ast.type.PrimitiveType;
import com.github.javaparser.ast.type.Type;
import com.github.javaparser.ast.type.TypeParameter;
import com.github.javaparser.ast.visitor.ModifierVisitor;
import com.github.javaparser.ast.visitor.Visitable;
import com.github.javaparser.resolution.UnsolvedSymbolException;
import com.github.javaparser.resolution.declarations.ResolvedConstructorDeclaration;
Expand All @@ -37,45 +36,18 @@
import com.github.javaparser.resolution.types.ResolvedType;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
* This visitor removes every member in the compilation unit that is not a member of its {@link
* #methodsToLeaveUnchanged} set or {@link #membersToEmpty} set. It also deletes the bodies of all
* methods and replaces them with "throw new Error();" or remove the initializers of fields
* (minimized if the field is final) within the {@link #membersToEmpty} set.
* #targetMethods} set or {@link #usedMembers} set. It also deletes the bodies of all methods and
* replaces them with "throw new Error();" or remove the initializers of fields (minimized if the
* field is final) within the {@link #usedMembers} set.
*/
public class PrunerVisitor extends ModifierVisitor<Void> {

/**
* The methods that should NOT be touched by this pruner. The strings representing the method are
* those returned by ResolvedMethodDeclaration#getQualifiedSignature.
*/
private Set<String> methodsToLeaveUnchanged;

/**
* The fields that should NOT be touched by this pruner. The strings representing the field are
* obtained by combining the qualified name of the current class and the name of the field.
*/
private Set<String> fieldsToLeaveUnchanged;

/**
* The members, fields and methods, to be pruned. For methods, the bodies are removed. For fields,
* the initializers are removed, or minimized in case the field is final. The strings representing
* the method are those returned by ResolvedMethodDeclaration#getQualifiedSignature. The strings
* representing the field are returned by ResolvedTypeDeclaration#getQualifiedName.
*/
private Set<String> membersToEmpty;

/**
* This is the set of classes used by the target methods. We use this set to determine if we
* should keep or delete an import statement. The strings representing the classes are in
* the @FullyQualifiedName form.
*/
private Set<String> classesUsedByTargetMethods;
public class PrunerVisitor extends SpeciminStateVisitor {

/**
* This boolean tracks whether the element currently being visited is inside a target method. It
Expand All @@ -97,47 +69,33 @@ public class PrunerVisitor extends ModifierVisitor<Void> {
private final Set<String> resolvedYetStuckMethodCall;

/** This map connects a class and its unresolved interface. */
private java.util.Map<String, String> classAndUnresolvedInterface;
private final Map<String, String> classAndUnresolvedInterface;

/**
* Creates the pruner. All members this pruner encounters other than those in its input sets will
* be removed entirely. For methods in both arguments, the Strings should be in the format
* produced by ResolvedMethodDeclaration#getQualifiedSignature. For fields in {@link
* #membersToEmpty}, the Strings should be in the format produced by
* ResolvedTypeDeclaration#getQualifiedName.
* be removed entirely.
*
* @param methodsToKeep the set of methods whose bodies should be kept intact (usually the target
* methods for specimin)
* @param fieldsToKeep the set of fields whose initializers should be kept intact
* @param membersToEmpty the set of members that this pruner will empty
* @param classesUsedByTargetMethods the classes used by target methods
* @param previousVisitor the previous visitor to run, from whence state should be copied
* @param resolvedYetStuckMethodCall set of methods that are resolved yet can not be solved by
* JavaParser
* @param classAndUnresolvedInterface connects a class to its corresponding unresolved interface
*/
public PrunerVisitor(
Set<String> methodsToKeep,
List<String> fieldsToKeep,
Set<String> membersToEmpty,
Set<String> classesUsedByTargetMethods,
SpeciminStateVisitor previousVisitor,
Set<String> resolvedYetStuckMethodCall,
java.util.Map<String, String> classAndUnresolvedInterface) {
this.methodsToLeaveUnchanged = methodsToKeep;
this.membersToEmpty = membersToEmpty;
this.classesUsedByTargetMethods = classesUsedByTargetMethods;
Map<String, String> classAndUnresolvedInterface) {
super(previousVisitor);
this.classAndUnresolvedInterface = classAndUnresolvedInterface;
this.fieldsToLeaveUnchanged = new HashSet<>();
fieldsToLeaveUnchanged.addAll(fieldsToKeep);
Set<String> toRemove = new HashSet<>();
for (String classUsedByTargetMethods : classesUsedByTargetMethods) {
for (String classUsedByTargetMethods : usedTypeElements) {
if (classUsedByTargetMethods.contains("<")) {
toRemove.add(classUsedByTargetMethods);
}
}
for (String s : toRemove) {
classesUsedByTargetMethods.remove(s);
usedTypeElements.remove(s);
String withoutAngleBrackets = s.substring(0, s.indexOf("<"));
classesUsedByTargetMethods.add(withoutAngleBrackets);
usedTypeElements.add(withoutAngleBrackets);
}
this.resolvedYetStuckMethodCall = resolvedYetStuckMethodCall;
}
Expand All @@ -151,7 +109,7 @@ public Node visit(ImportDeclaration decl, Void p) {
// make the code less confusing.
String importedPackage = classFullName;
boolean isUsedAtLeastOnce = false;
for (String usedClassFQN : classesUsedByTargetMethods) {
for (String usedClassFQN : usedTypeElements) {
if (usedClassFQN.startsWith(importedPackage)) {
isUsedAtLeastOnce = true;
}
Expand All @@ -166,7 +124,7 @@ public Node visit(ImportDeclaration decl, Void p) {
// if it's a static import, classFullName will actually be a method name
return super.visit(decl, p);
}
if (classesUsedByTargetMethods.contains(classFullName)) {
if (usedTypeElements.contains(classFullName)) {
return super.visit(decl, p);
}

Expand All @@ -181,13 +139,13 @@ public Node visit(ImportDeclaration decl, Void p) {

/**
* Helper method to check if the given fully-qualified class name is used as a parameter type by
* any of the methods in methodsToEmpty.
* any of the methods in {@link #usedMembers}.
*
* @param classFullName a fully-qualified class name
* @return true if this type name is a parameter of a used method
*/
public boolean isUsedMethodParameterType(String classFullName) {
for (String member : membersToEmpty) {
for (String member : usedMembers) {
int openParen = member.indexOf('(');
int closeParen = member.lastIndexOf(')');

Expand Down Expand Up @@ -228,7 +186,7 @@ else if (index > 1 && parameters.substring(index - 2, index).equals(", ")) {
* @return true if a method with this name will be preserved
*/
private boolean isUsedMethod(String staticImport) {
for (String methodSignature : methodsToLeaveUnchanged) {
for (String methodSignature : targetMethods) {
if (methodSignature.startsWith(staticImport)) {
return true;
}
Expand All @@ -237,7 +195,7 @@ private boolean isUsedMethod(String staticImport) {
StringBuilder asFieldNameBuilder = new StringBuilder(staticImport);
asFieldNameBuilder.setCharAt(lastDotIndex, '#');
String asFieldName = asFieldNameBuilder.toString();
for (String member : membersToEmpty) {
for (String member : usedMembers) {
if (member.startsWith(staticImport)) {
return true;
}
Expand Down Expand Up @@ -270,7 +228,7 @@ private void removeUnusedInterfacesHelper(
String typeFullName =
JavaParserUtil.classOrInterfaceTypeToResolvedReferenceType(interfaceType)
.getQualifiedName();
if (!classesUsedByTargetMethods.contains(typeFullName)) {
if (!usedTypeElements.contains(typeFullName)) {
iterator.remove();
}
// all unresolvable interfaces that need to be removed belong to the Java package.
Expand Down Expand Up @@ -298,7 +256,7 @@ private void removeUnusedInterfacesHelper(
@Override
public Visitable visit(EnumDeclaration decl, Void p) {
String qualifiedName = decl.resolve().getQualifiedName();
if (!classesUsedByTargetMethods.contains(qualifiedName)) {
if (!usedTypeElements.contains(qualifiedName)) {
decl.remove();
return decl;
}
Expand Down Expand Up @@ -326,7 +284,7 @@ public Visitable visit(ClassOrInterfaceDeclaration decl, Void p) {
}
decl = minimizeTypeParameters(decl);
String classQualifiedName = decl.resolve().getQualifiedName();
if (!classesUsedByTargetMethods.contains(classQualifiedName)
if (!usedTypeElements.contains(classQualifiedName)
&& !isUsedMethodParameterType(classQualifiedName)) {
decl.remove();
return decl;
Expand Down Expand Up @@ -356,7 +314,7 @@ public Visitable visit(EnumConstantDeclaration enumConstantDeclaration, Void p)
JavaParserUtil.removeNode(enumConstantDeclaration);
return enumConstantDeclaration;
}
if (!membersToEmpty.contains(
if (!usedMembers.contains(
resolved.getType().describe() + "." + enumConstantDeclaration.getNameAsString())) {
JavaParserUtil.removeNode(enumConstantDeclaration);
}
Expand All @@ -377,15 +335,15 @@ public Visitable visit(MethodDeclaration methodDecl, Void p) {
}

ResolvedMethodDeclaration resolved = methodDecl.resolve();
if (methodsToLeaveUnchanged.contains(resolved.getQualifiedSignature())) {
if (targetMethods.contains(resolved.getQualifiedSignature())) {
boolean oldInsideTargetMethod = insideTargetMethod;
insideTargetMethod = true;
Visitable result = super.visit(methodDecl, p);
insideTargetMethod = oldInsideTargetMethod;
return result;
}

if (membersToEmpty.contains(resolved.getQualifiedSignature())
if (usedMembers.contains(resolved.getQualifiedSignature())
|| isAResolvedYetStuckMethod(methodDecl)) {
boolean isMethodInsideInterface = isInsideInterface(methodDecl);
// do nothing if methodDecl is just a method signature in a class.
Expand Down Expand Up @@ -431,14 +389,14 @@ public Visitable visit(ConstructorDeclaration constructorDecl, Void p) {
return constructorDecl;
}

if (methodsToLeaveUnchanged.contains(qualifiedSignature)) {
if (targetMethods.contains(qualifiedSignature)) {
return super.visit(constructorDecl, p);
}

// TODO: we should be cleverer about whether to preserve the constructors of
// enums, but right now we don't remove any enum constants in related classes, so
// we need to preserve all constructors to retain compilability.
if (membersToEmpty.contains(qualifiedSignature) || JavaParserUtil.isInEnum(constructorDecl)) {
if (usedMembers.contains(qualifiedSignature) || JavaParserUtil.isInEnum(constructorDecl)) {
if (!needToPreserveSuperOrThisCall(constructorDecl.resolve())) {
constructorDecl.setBody(StaticJavaParser.parseBlock("{ throw new Error(); }"));
return constructorDecl;
Expand Down Expand Up @@ -486,9 +444,9 @@ public Visitable visit(FieldDeclaration fieldDecl, Void p) {
}
String varFullName = classFullName + "#" + declarator.getNameAsString();

if (fieldsToLeaveUnchanged.contains(varFullName)) {
if (targetFields.contains(varFullName)) {
continue;
} else if (membersToEmpty.contains(varFullName)) {
} else if (usedMembers.contains(varFullName)) {
declarator.removeInitializer();
if (isFinal) {
declarator.setInitializer(getBasicInitializer(declarator.getType()));
Expand Down Expand Up @@ -605,7 +563,7 @@ private NodeList<ClassOrInterfaceType> getUsedTypesOnly(
} catch (UnsolvedSymbolException | IllegalStateException e) {
continue;
}
if (classesUsedByTargetMethods.contains(resolvedType.asReferenceType().getQualifiedName())) {
if (usedTypeElements.contains(resolvedType.asReferenceType().getQualifiedName())) {
usedTypeOnly.add(type);
}
}
Expand Down Expand Up @@ -646,7 +604,7 @@ private boolean needToPreserveSuperOrThisCall(
try {
for (ResolvedConstructorDeclaration constructorOfExtendedClass :
extendedClass.getTypeDeclaration().get().getConstructors()) {
if (membersToEmpty.contains(constructorOfExtendedClass.getQualifiedSignature())) {
if (usedMembers.contains(constructorOfExtendedClass.getQualifiedSignature())) {
return true;
}
}
Expand Down
Loading

0 comments on commit 16b331e

Please sign in to comment.