lazily load frames, some renaming

EpicPlayerA10 · EpicPlayerA10 · commit e0f52143d5c0 · 2025-03-19T00:55:44.000+01:00
diff --git a/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/asm/MethodContext.java b/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/asm/MethodContext.java
@@ -1,6 +1,5 @@
 package uwu.narumi.deobfuscator.api.asm;
 
-import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 import org.objectweb.asm.tree.AbstractInsnNode;
 import org.objectweb.asm.tree.MethodNode;
@@ -17,17 +16,20 @@
 public class MethodContext {
   private final ClassWrapper classWrapper;
   private final MethodNode methodNode;
-  private final @Nullable @Unmodifiable Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames;
+  private final FramesProvider framesProvider;
+  // Lazily initialized
+  private Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames = null;
+  // Lazily initialized
   private Map<AbstractInsnNode, Set<AbstractInsnNode>> consumersMap = null;
 
   private MethodContext(
       ClassWrapper classWrapper,
       MethodNode methodNode,
-      @Nullable @Unmodifiable Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames
+      FramesProvider framesProvider
   ) {
     this.classWrapper = classWrapper;
     this.methodNode = methodNode;
-    this.frames = frames;
+    this.framesProvider = framesProvider;
   }
 
   /**
@@ -47,38 +49,41 @@ public MethodNode methodNode() {
   /**
    * Frames of the method
    */
-  public @Nullable @Unmodifiable Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames() {
+  @Unmodifiable
+  public synchronized Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames() {
+    if (this.frames == null) {
+      // Lazy initialization
+      this.frames = this.framesProvider.compute(this.classWrapper.classNode(), this.methodNode);
+    }
     return frames;
   }
 
   public synchronized Map<AbstractInsnNode, Set<AbstractInsnNode>> getConsumersMap() {
-    if (this.frames == null) {
-      throw new IllegalStateException("Got frameless method context");
-    }
     if (consumersMap == null) {
       // Lazy initialization
       this.consumersMap = MethodHelper.computeConsumersMap(this.frames);
     }
     return consumersMap;
   }
 
-  public InsnContext newInsnContext(AbstractInsnNode insn) {
+  /**
+   * Creates new {@link InsnContext} instance at specified instruction
+   *
+   * @param insn instruction
+   * @return new {@link InsnContext} instance
+   */
+  public InsnContext at(AbstractInsnNode insn) {
     return new InsnContext(insn, this);
   }
 
-  public static MethodContext framed(ClassWrapper classWrapper, MethodNode methodNode) {
-    return framed(classWrapper, methodNode, MethodHelper::analyzeSource);
+  public static MethodContext of(ClassWrapper classWrapper, MethodNode methodNode) {
+    return of(classWrapper, methodNode, MethodHelper::analyzeSource);
   }
 
   /**
-   * Creates new {@link MethodContext} and computes its frames
+   * Creates new {@link MethodContext} instance
    */
-  public static MethodContext framed(ClassWrapper classWrapper, MethodNode methodNode, FramesProvider framesProvider) {
-    Map<AbstractInsnNode, Frame<OriginalSourceValue>> frames = framesProvider.compute(classWrapper.classNode(), methodNode);
-    return new MethodContext(classWrapper, methodNode, frames);
-  }
-
-  public static MethodContext frameless(ClassWrapper classWrapper, MethodNode methodNode) {
-    return new MethodContext(classWrapper, methodNode, null);
+  public static MethodContext of(ClassWrapper classWrapper, MethodNode methodNode, FramesProvider framesProvider) {
+    return new MethodContext(classWrapper, methodNode, framesProvider);
   }
 }
diff --git a/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/asm/matcher/Match.java b/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/asm/matcher/Match.java
@@ -57,7 +57,7 @@ public List<MatchContext> findAllMatches(MethodContext methodContext) {
     List<MatchContext> allMatches = new ArrayList<>();
 
     for (AbstractInsnNode insn : methodContext.methodNode().instructions) {
-      InsnContext insnContext = methodContext.newInsnContext(insn);
+      InsnContext insnContext = methodContext.at(insn);
       MatchContext match = this.matchResult(insnContext);
       if (match != null) {
         allMatches.add(match);
diff --git a/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/helper/FramedInstructionsStream.java b/deobfuscator-api/src/main/java/uwu/narumi/deobfuscator/api/helper/FramedInstructionsStream.java
@@ -82,12 +82,12 @@ public void forEach(Consumer<InsnContext> consumer) {
               if (instructionsStreamModifier.apply(Arrays.stream(methodNode.instructions.toArray())).findAny().isEmpty()) return;
 
               // Get frames of the method
-              MethodContext methodContext = MethodContext.framed(classWrapper, methodNode, this.framesProvider);
+              MethodContext methodContext = MethodContext.of(classWrapper, methodNode, this.framesProvider);
 
               // Iterate over instructions SYNC
               instructionsStreamModifier.apply(Arrays.stream(methodNode.instructions.toArray()))
                   .forEach(insn -> {
-                    InsnContext insnContext = methodContext.newInsnContext(insn);
+                    InsnContext insnContext = methodContext.at(insn);
                     // Check if frame exists
                     if (insnContext.frame() == null) return;
 
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/clean/peephole/PopUnUsedLocalVariablesTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/clean/peephole/PopUnUsedLocalVariablesTransformer.java
@@ -17,14 +17,14 @@ public class PopUnUsedLocalVariablesTransformer extends Transformer {
   @Override
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> classWrapper.methods().forEach(methodNode -> {
-      MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+      MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
       Set<VarInsnNode> varStoresInUse = new HashSet<>();
 
       // Find all local variables in use
       for (AbstractInsnNode insn : methodNode.instructions.toArray()) {
         if ((insn instanceof VarInsnNode && !insn.isVarStore()) || insn instanceof IincInsnNode) {
-          InsnContext insnContext = methodContext.newInsnContext(insn);
+          InsnContext insnContext = methodContext.at(insn);
 
           Frame<OriginalSourceValue> frame = insnContext.frame();
           if (frame == null) return;
@@ -50,7 +50,7 @@ protected void transform() throws Exception {
       for (AbstractInsnNode insn : methodNode.instructions.toArray()) {
         if (insn instanceof VarInsnNode varInsnNode && insn.isVarStore()) {
           if (!varStoresInUse.contains(varInsnNode)) {
-            InsnContext insnContext = methodContext.newInsnContext(insn);
+            InsnContext insnContext = methodContext.at(insn);
 
             // Pop the value from the stack
             insnContext.placePops();
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/hp888/HP888StringTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/hp888/HP888StringTransformer.java
@@ -43,7 +43,7 @@ protected void transform() throws Exception {
 
       // Find all encrypted strings
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
         // Find encrypted strings
         ENCRYPTED_STRING.findAllMatches(methodContext).forEach(matchContext -> {
@@ -55,7 +55,7 @@ protected void transform() throws Exception {
           findMethod(classWrapper.classNode(), methodRef).ifPresent(decryptMethod -> {
             String key = keyInsn.asString();
 
-            MethodContext decryptMethodContext = MethodContext.framed(classWrapper, decryptMethod);
+            MethodContext decryptMethodContext = MethodContext.of(classWrapper, decryptMethod);
 
             // Find class for constant pool
             LdcInsnNode constantPoolClassLdc = (LdcInsnNode) CLASS_FOR_CONSTANT_POOL.findAllMatches(decryptMethodContext)
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectFieldFlowTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectFieldFlowTransformer.java
@@ -25,7 +25,7 @@ public class qProtectFieldFlowTransformer extends Transformer {
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> {
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext methodContext = MethodContext.frameless(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
         FIELD_FLOW_PATTERN.findAllMatches(methodContext).forEach(match -> {
           FieldInsnNode fieldInsn = (FieldInsnNode) match.captures().get("field").insn();
 
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectNumberPoolTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectNumberPoolTransformer.java
@@ -35,7 +35,7 @@ public class qProtectNumberPoolTransformer extends Transformer {
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> {
       MatchContext numberPoolMatchCtx = classWrapper.methods().stream()
-          .map(methodNode -> NUMBER_POOL_METHOD_MATCH.findFirstMatch(MethodContext.framed(classWrapper, methodNode)))
+          .map(methodNode -> NUMBER_POOL_METHOD_MATCH.findFirstMatch(MethodContext.of(classWrapper, methodNode)))
           .filter(Objects::nonNull)
           .findFirst()
           .orElse(null);
@@ -75,7 +75,7 @@ protected void transform() throws Exception {
 
       // Replace number pool references with actual values
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
         numberPoolReferenceMatch.findAllMatches(methodContext).forEach(numberPoolReferenceCtx -> {
           int index = numberPoolReferenceCtx.captures().get("index").insn().asInteger();
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectStringPoolTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectStringPoolTransformer.java
@@ -34,7 +34,7 @@ public class qProtectStringPoolTransformer extends Transformer {
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> {
       MatchContext stringPoolMatchCtx = classWrapper.methods().stream()
-          .map(methodNode -> STRING_POOL_METHOD_MATCH.findFirstMatch(MethodContext.framed(classWrapper, methodNode)))
+          .map(methodNode -> STRING_POOL_METHOD_MATCH.findFirstMatch(MethodContext.of(classWrapper, methodNode)))
           .filter(Objects::nonNull)
           .findFirst()
           .orElse(null);
@@ -72,7 +72,7 @@ protected void transform() throws Exception {
 
       // Replace number pool references with actual values
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
         stringPoolReferenceMatch.findAllMatches(methodContext).forEach(numberPoolReferenceCtx -> {
           int index = numberPoolReferenceCtx.captures().get("index").insn().asInteger();
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectStringTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectStringTransformer.java
@@ -32,7 +32,7 @@ protected void transform() throws Exception {
       AtomicReference<MethodRef> decryptionMethodRef = new AtomicReference<>();
 
       classWrapper.methods().forEach(methodNode -> {
-        DECRYPT_STRING_MATCH.findAllMatches(MethodContext.framed(classWrapper, methodNode)).forEach(matchContext -> {
+        DECRYPT_STRING_MATCH.findAllMatches(MethodContext.of(classWrapper, methodNode)).forEach(matchContext -> {
           String encryptedText = matchContext.captures().get("encryptedText").insn().asString();
           String xorKey = matchContext.captures().get("xorKey").insn().asString();
           String encryptedData = matchContext.captures().get("encryptedData").insn().asString();
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectTryCatchTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/qprotect/qProtectTryCatchTransformer.java
@@ -46,7 +46,7 @@ public class qProtectTryCatchTransformer extends Transformer {
   @Override
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> classWrapper.methods().forEach(methodNode -> {
-      MethodContext methodContext = MethodContext.frameless(classWrapper, methodNode);
+      MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
       // Remove infinite loop try catch blocks
       methodNode.tryCatchBlocks.removeIf(tryCatch -> {
@@ -69,7 +69,7 @@ protected void transform() throws Exception {
         LabelNode handlerLabel = tryCatch.handler;
         AbstractInsnNode nextInsn = handlerLabel.getNext();
 
-        MatchContext matchContext = SELF_THROW_TRY_CATCH_MATCH.matchResult(methodContext.newInsnContext(nextInsn));
+        MatchContext matchContext = SELF_THROW_TRY_CATCH_MATCH.matchResult(methodContext.at(nextInsn));
         if (matchContext != null) {
           matchContext.removeAll();
           markChange();
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/universal/number/InlineConstantValuesTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/universal/number/InlineConstantValuesTransformer.java
@@ -41,7 +41,7 @@ protected void transform() throws Exception {
               }
 
               // Place pops before replacing
-              insnContext.methodContext().newInsnContext(toReplace).placePops();
+              insnContext.methodContext().at(toReplace).placePops();
 
               // Replace instruction with constant value
               AbstractInsnNode newInsn = AsmHelper.toConstantInsn(sourceValue.getConstantValue().value());
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/unknown/obf1/UnknownObf1_StringByteArrayTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/unknown/obf1/UnknownObf1_StringByteArrayTransformer.java
@@ -71,7 +71,7 @@ public class UnknownObf1_StringByteArrayTransformer extends Transformer {
   @Override
   protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> classWrapper.methods().forEach(methodNode -> {
-      MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+      MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
       STRING_BYTE_ARRAY_CONSTRUCTOR.findAllMatches(methodContext).forEach(matchContext -> {
         Set<AbstractInsnNode> collectedInsns = new HashSet<>(matchContext.collectedInsns());
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixLongEncryptionMPCTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixLongEncryptionMPCTransformer.java
@@ -142,7 +142,7 @@ private void decryptEncryptedLongs(Context context, ClassWrapper classWrapper) {
       }
     }
 
-    MethodContext methodContext = MethodContext.framed(classWrapper, clinit);
+    MethodContext methodContext = MethodContext.of(classWrapper, clinit);
 
     // Find all encrypted longs
     DECRYPT_LONG_MATCHER.findAllMatches(methodContext).forEach(matchContext -> {
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixParametersTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixParametersTransformer.java
@@ -86,7 +86,7 @@ protected void transform() throws Exception {
     scopedClasses().forEach(classWrapper -> classWrapper.methods().stream()
         .filter(methodNode -> methodNode.desc.startsWith("([Ljava/lang/Object;)"))
         .forEach(methodNode -> {
-          MethodContext methodContext = MethodContext.framed(classWrapper, methodNode);
+          MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
           Map<Integer, Integer> newVarIndexes = new HashMap<>(); // old var index -> new var index
 
diff --git a/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixUselessTryCatchRemoverTransformer.java b/deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other/impl/zkm/ZelixUselessTryCatchRemoverTransformer.java
@@ -57,10 +57,10 @@ protected void transform() throws Exception {
 
       // Find methods that instantly returns an exception
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext framelessContext = MethodContext.frameless(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
         // Check instructions
-        if (methodNode.instructions.size() == 2 && INSTANT_RETURN_EXCEPTION.matches(framelessContext.newInsnContext(methodNode.instructions.getFirst()))) {
+        if (methodNode.instructions.size() == 2 && INSTANT_RETURN_EXCEPTION.matches(methodContext.at(methodNode.instructions.getFirst()))) {
           // Add it to list
           instantReturnExceptionMethods.add(MethodRef.of(classWrapper.classNode(), methodNode));
         }
@@ -70,10 +70,10 @@ protected void transform() throws Exception {
 
       // Remove try-catches with these instant return exception methods
       classWrapper.methods().forEach(methodNode -> {
-        MethodContext framelessContext = MethodContext.frameless(classWrapper, methodNode);
+        MethodContext methodContext = MethodContext.of(classWrapper, methodNode);
 
         methodNode.tryCatchBlocks.removeIf(tryBlock -> {
-          InsnContext start = framelessContext.newInsnContext(tryBlock.handler.getNext());
+          InsnContext start = methodContext.at(tryBlock.handler.getNext());
           MatchContext result = INVOKE_AND_RETURN.matchResult(start);
           if (result != null) {
             MethodRef methodRef = MethodRef.of((MethodInsnNode) result.insn());
