From c74dd00491f2a751c22aa35cd825ad107e869505 Mon Sep 17 00:00:00 2001
From: EpicPlayerA10 <adasko.lesiak@gmail.com>
Date: Sun, 22 Sep 2024 15:08:28 +0200
Subject: [PATCH] add a note regarding snapshot version

---
 deobfuscator-api/pom.xml                                 | 3 ++-
 .../objectweb/asm/tree/analysis/OriginalSourceValue.java | 9 +++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/deobfuscator-api/pom.xml b/deobfuscator-api/pom.xml
index 495a216..11adcdd 100644
--- a/deobfuscator-api/pom.xml
+++ b/deobfuscator-api/pom.xml
@@ -18,11 +18,12 @@
 
         <!--
         We need to use a snapshot version of asm lib as there are some recent important changes to it
-         that are not in release version yet:
+         that are not in a release version yet:
           - https://gitlab.ow2.org/asm/asm/-/merge_requests/414
           - https://gitlab.ow2.org/asm/asm/-/merge_requests/415
           - https://gitlab.ow2.org/asm/asm/-/merge_requests/416
         -->
+        <!-- TODO: As we use snapshot version, we need to keep it up to date, because snapshot versions are deleted over time -->
         <asm.version>9.8-20240921.152704-25</asm.version>
 
         <log4j.version>2.23.1</log4j.version>
diff --git a/deobfuscator-api/src/main/java/org/objectweb/asm/tree/analysis/OriginalSourceValue.java b/deobfuscator-api/src/main/java/org/objectweb/asm/tree/analysis/OriginalSourceValue.java
index 44c773d..b8fbb70 100644
--- a/deobfuscator-api/src/main/java/org/objectweb/asm/tree/analysis/OriginalSourceValue.java
+++ b/deobfuscator-api/src/main/java/org/objectweb/asm/tree/analysis/OriginalSourceValue.java
@@ -1,5 +1,6 @@
 package org.objectweb.asm.tree.analysis;
 
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.objectweb.asm.Type;
 import org.objectweb.asm.tree.AbstractInsnNode;
@@ -49,6 +50,7 @@ public class OriginalSourceValue extends SourceValue {
    * instructions (DUP, ILOAD) and jumps to get the original source value of this instruction at line 6.
    * In this example, it will return source value of instruction at line 2.
    */
+  @NotNull
   public final OriginalSourceValue originalSource;
 
   /**
@@ -81,11 +83,16 @@ public class OriginalSourceValue extends SourceValue {
   @Nullable
   private ConstantValue constantValue = null;
 
+  /**
+   * If a source value is a method parameter.
+   */
   private final boolean isMethodParameter;
 
   public OriginalSourceValue(int size, boolean isMethodParameter) {
     super(size, new SmallSet<>());
     this.isMethodParameter = isMethodParameter;
+
+    // Fill single-producer-only fields with empty
     this.copiedFrom = null;
     this.originalSource = this;
   }
@@ -103,6 +110,8 @@ public OriginalSourceValue(int size, AbstractInsnNode insnNode) {
   public OriginalSourceValue(int size, Set<AbstractInsnNode> insnSet) {
     super(size, insnSet);
     this.isMethodParameter = false;
+
+    // Fill single-producer-only fields with empty
     this.copiedFrom = null;
     this.originalSource = this;
   }