Merge pull request #614 from soot-oss/fix/emptybodyinterceptors

kadirayk · web-flow · commit df30acfba472 · 2023-06-01T10:28:08.000+02:00
apply Bodyinterceptors II (zwei)
diff --git a/sootup.core/src/main/java/sootup/core/inputlocation/ClassLoadingOptions.java b/sootup.core/src/main/java/sootup/core/inputlocation/ClassLoadingOptions.java
@@ -36,11 +36,6 @@
  */
 public interface ClassLoadingOptions {
 
-  /** To get the stored Value */
-  default <T> T getValue(ClassLoadingOptionKey key) {
-    return null;
-  }
-
   /**
    * The interceptors are executed in order on each loaded method body, allowing it to be inspected
    * and manipulated.
diff --git a/sootup.core/src/main/java/sootup/core/views/View.java b/sootup.core/src/main/java/sootup/core/views/View.java
@@ -54,10 +54,7 @@ public interface View<T extends SootClass> {
   Project getProject();
 
   @Nonnull
-  List<BodyInterceptor> getBodyInterceptors(AnalysisInputLocation<T> inputLocation);
-
-  @Nonnull
-  List<BodyInterceptor> getBodyInterceptors();
+  List<BodyInterceptor> getBodyInterceptors(AnalysisInputLocation inputLocation);
 
   /** Return all classes in the view. */
   @Nonnull
diff --git a/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmClassSource.java b/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmClassSource.java
@@ -116,8 +116,8 @@ public Collection<? extends SootMethod> resolveMethods() throws ResolveException
               AsmMethodSource asmClassClassSourceContent = (AsmMethodSource) methodSource;
               asmClassClassSourceContent.setDeclaringClass(classSignature);
 
-              List<ClassType> exceptions = new ArrayList<>();
-              exceptions.addAll(AsmUtil.asmIdToSignature(methodSource.exceptions));
+              List<ClassType> exceptions =
+                  new ArrayList<>(AsmUtil.asmIdToSignature(methodSource.exceptions));
 
               String methodName = methodSource.name;
               EnumSet<Modifier> modifiers = AsmUtil.getModifiers(methodSource.access);
diff --git a/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmJavaClassProvider.java b/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmJavaClassProvider.java
@@ -51,10 +51,10 @@ public AsmJavaClassProvider(@Nonnull View<?> view) {
 
   @Override
   public AbstractClassSource<JavaSootClass> createClassSource(
-      AnalysisInputLocation<? extends SootClass<?>> srcNamespace,
+      AnalysisInputLocation<? extends SootClass<?>> analysisInputLocation,
       Path sourcePath,
       ClassType classType) {
-    SootClassNode classNode = new SootClassNode();
+    SootClassNode classNode = new SootClassNode(analysisInputLocation);
 
     try {
       AsmUtil.initAsmClassSource(sourcePath, classNode);
@@ -70,10 +70,11 @@ public AbstractClassSource<JavaSootClass> createClassSource(
           "Can not create ClassSource from a module info descriptor!", sourcePath);
     } else {
       if (klassType instanceof AnnotationType) {
-        return new AsmAnnotationClassSource(srcNamespace, sourcePath, klassType, classNode);
+        return new AsmAnnotationClassSource(
+            analysisInputLocation, sourcePath, klassType, classNode);
       }
 
-      return new AsmClassSource(srcNamespace, sourcePath, klassType, classNode);
+      return new AsmClassSource(analysisInputLocation, sourcePath, klassType, classNode);
     }
   }
 
@@ -85,8 +86,11 @@ public FileType getHandledFileType() {
 
   class SootClassNode extends ClassNode {
 
-    SootClassNode() {
+    private final AnalysisInputLocation<? extends SootClass<?>> analysisInputLocation;
+
+    SootClassNode(AnalysisInputLocation<? extends SootClass<?>> analysisInputLocation) {
       super(AsmUtil.SUPPORTED_ASM_OPCODE);
+      this.analysisInputLocation = analysisInputLocation;
     }
 
     @Override
@@ -98,7 +102,15 @@ public MethodVisitor visitMethod(
         @Nonnull String signature,
         @Nonnull String[] exceptions) {
 
-      AsmMethodSource mn = new AsmMethodSource(access, name, desc, signature, exceptions, view);
+      AsmMethodSource mn =
+          new AsmMethodSource(
+              access,
+              name,
+              desc,
+              signature,
+              exceptions,
+              view,
+              view.getBodyInterceptors(analysisInputLocation));
       methods.add(mn);
       return mn;
     }
diff --git a/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmMethodSource.java b/sootup.java.bytecode/src/main/java/sootup/java/bytecode/frontend/AsmMethodSource.java
@@ -129,6 +129,7 @@ public class AsmMethodSource extends JSRInlinerAdapter implements BodySource {
   @Nullable private JavaClassType declaringClass;
 
   private final View<?> view;
+  private final List<BodyInterceptor> bodyInterceptors;
 
   @Nonnull private final Set<LabelNode> inlineExceptionLabels = new HashSet<>();
 
@@ -156,8 +157,10 @@ public class AsmMethodSource extends JSRInlinerAdapter implements BodySource {
       @Nonnull String desc,
       @Nonnull String signature,
       @Nonnull String[] exceptions,
-      @Nonnull View<?> view) {
+      View<?> view,
+      @Nonnull List<BodyInterceptor> bodyInterceptors) {
     super(AsmUtil.SUPPORTED_ASM_OPCODE, null, access, name, desc, signature, exceptions);
+    this.bodyInterceptors = bodyInterceptors;
     this.view = view;
   }
 
@@ -244,7 +247,7 @@ public Body resolveBody(@Nonnull Iterable<Modifier> modifierIt) {
 
     bodyBuilder.setMethodSignature(lazyMethodSignature.get());
 
-    for (BodyInterceptor bodyInterceptor : view.getBodyInterceptors()) {
+    for (BodyInterceptor bodyInterceptor : bodyInterceptors) {
       try {
         bodyInterceptor.interceptBody(bodyBuilder, view);
       } catch (Exception e) {
diff --git a/sootup.java.bytecode/src/main/java/sootup/java/bytecode/interceptors/BytecodeBodyInterceptors.java b/sootup.java.bytecode/src/main/java/sootup/java/bytecode/interceptors/BytecodeBodyInterceptors.java
@@ -29,19 +29,20 @@
 /** Built-in sets of {@link BodyInterceptor}s for the bytecode frontend */
 public enum BytecodeBodyInterceptors {
   Default(
-  //      new CastAndReturnInliner(),
-  //      new DuplicateCatchAllTrapRemover(),
-  //      new UnreachableCodeEliminator(),
-  //      // new LocalSplitter(),
-  //      new Aggregator(),
-  //      //new UnusedLocalEliminator(),
-  //      new TypeAssigner(),
-  //      new LocalNameStandardizer(),
-  //      new CopyPropagator(),
-  //      new DeadAssignmentEliminator(),
-  //      new NopEliminator(),
-  //      new ConditionalBranchFolder(),
-  //      new EmptySwitchEliminator());
+  /*
+          new CastAndReturnInliner(),
+          new UnreachableCodeEliminator(),
+    //      // new LocalSplitter(),
+    //      new Aggregator(),
+          new TypeAssigner(),
+    //      new LocalNameStandardizer(),
+          new CopyPropagator(),
+          new DeadAssignmentEliminator(),
+          new ConditionalBranchFolder(),
+          new EmptySwitchEliminator(),
+            new NopEliminator(),
+            new UnusedLocalEliminator()
+  */
   );
 
   @Nonnull private final List<BodyInterceptor> bodyInterceptors;
diff --git a/sootup.java.core/src/main/java/sootup/java/core/views/JavaView.java b/sootup.java.core/src/main/java/sootup/java/core/views/JavaView.java
@@ -23,7 +23,6 @@
  */
 
 import java.util.Collection;
-import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Function;
@@ -102,18 +101,8 @@ public JavaView(
 
   @Nonnull
   @Override
-  public List<BodyInterceptor> getBodyInterceptors(AnalysisInputLocation<JavaSootClass> clazz) {
-    return this.classLoadingOptionsSpecifier.apply(clazz) != null
-        ? this.classLoadingOptionsSpecifier.apply(clazz).getBodyInterceptors()
-        : getBodyInterceptors();
-  }
-
-  @Nonnull
-  @Override
-  public List<BodyInterceptor> getBodyInterceptors() {
-    // TODO add default interceptors from
-    // sootup.java.bytecode.interceptors.BytecodeBodyInterceptors;
-    return Collections.emptyList();
+  public List<BodyInterceptor> getBodyInterceptors(AnalysisInputLocation clazz) {
+    return this.classLoadingOptionsSpecifier.apply(clazz).getBodyInterceptors();
   }
 
   public void configBodyInterceptors(
diff --git a/sootup.jimple.parser/src/main/java/sootup/jimple/parser/JimpleAnalysisInputLocation.java b/sootup.jimple.parser/src/main/java/sootup/jimple/parser/JimpleAnalysisInputLocation.java
@@ -98,15 +98,15 @@ List<AbstractClassSource<? extends AbstractClass<?>>> walkDirectory(
   @Nonnull
   public Collection<? extends SootClassSource<T>> getClassSources(@Nonnull View<?> view) {
     return walkDirectory(
-        path, view.getIdentifierFactory(), new JimpleClassProvider(view.getBodyInterceptors()));
+        path, view.getIdentifierFactory(), new JimpleClassProvider(view.getBodyInterceptors(this)));
   }
 
   @Override
   @Nonnull
   public Optional<? extends SootClassSource<T>> getClassSource(
       @Nonnull ClassType type, @Nonnull View<?> view) {
     final JimpleClassProvider<T> classProvider =
-        new JimpleClassProvider<>(view.getBodyInterceptors());
+        new JimpleClassProvider<>(view.getBodyInterceptors(this));
 
     final String ext = classProvider.getHandledFileType().toString().toLowerCase();
 
diff --git a/sootup.jimple.parser/src/main/java/sootup/jimple/parser/JimpleView.java b/sootup.jimple.parser/src/main/java/sootup/jimple/parser/JimpleView.java
@@ -42,7 +42,10 @@ public class JimpleView extends AbstractView<SootClass<?>> {
 
   /** Creates a new instance of the {@link JavaView} class. */
   public JimpleView(@Nonnull JimpleProject project) {
-    this(project, new FullCacheProvider<>(), analysisInputLocation -> null);
+    this(
+        project,
+        new FullCacheProvider<>(),
+        analysisInputLocation -> EmptyClassLoadingOptions.Default);
   }
 
   public JimpleView(
@@ -78,15 +81,12 @@ public JimpleView(
 
   @Nonnull
   @Override
-  public List<BodyInterceptor> getBodyInterceptors(
-      AnalysisInputLocation<SootClass<?>> inputLocation) {
-    return classLoadingOptionsSpecifier.apply(inputLocation) != null
-        ? classLoadingOptionsSpecifier.apply(inputLocation).getBodyInterceptors()
-        : getBodyInterceptors();
+  public List<BodyInterceptor> getBodyInterceptors(AnalysisInputLocation inputLocation) {
+    return classLoadingOptionsSpecifier.apply(inputLocation).getBodyInterceptors();
   }
 
   @Nonnull
-  public List<BodyInterceptor> getBodyInterceptors() {
+  private List<BodyInterceptor> getBodyInterceptors() {
     return Collections.emptyList();
   }
 
