chore(release): 2.0.0 [skip ci]

# [2.0.0](https://github.com/revanced/revanced-patcher/compare/v1.11.0...v2.0.0) (2022-06-26)

### Code Refactoring

* migrate from `Signature` to `Fingerprint` ([efa8ea1](efa8ea1445))

### BREAKING CHANGES

* Not backwards compatible, since a lot of classes where renamed.

.github/workflows/release.yml

@@ -28,8 +28,6 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
-      - name: Make gradlew executable
-        run: chmod +x gradlew
       - name: Build with Gradle
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,167 @@
+# [2.0.0](https://github.com/revanced/revanced-patcher/compare/v1.11.0...v2.0.0) (2022-06-26)
+
+
+### Code Refactoring
+
+* migrate from `Signature` to `Fingerprint` ([efa8ea1](https://github.com/revanced/revanced-patcher/commit/efa8ea144528fcff588e782468845c315a7d6abd))
+
+
+### BREAKING CHANGES
+
+* Not backwards compatible, since a lot of classes where renamed.
+
+# [1.11.0](https://github.com/revanced/revanced-patcher/compare/v1.10.2...v1.11.0) (2022-06-24)
+
+
+### Features
+
+* add replace and remove extensions ([#50](https://github.com/revanced/revanced-patcher/issues/50)) ([92ac5e4](https://github.com/revanced/revanced-patcher/commit/92ac5e4dc25f612856e2b5e528cf5fd48a5f20af))
+
+## [1.10.2](https://github.com/revanced/revanced-patcher/compare/v1.10.1...v1.10.2) (2022-06-23)
+
+
+### Bug Fixes
+
+* dexlib must be propagated ([b738dcd](https://github.com/revanced/revanced-patcher/commit/b738dcd7ea04f5fe56e66af46fb11541fe54f6af))
+
+## [1.10.1](https://github.com/revanced/revanced-patcher/compare/v1.10.0...v1.10.1) (2022-06-23)
+
+
+### Bug Fixes
+
+* callback only when inteded ([e3bf367](https://github.com/revanced/revanced-patcher/commit/e3bf367ad6615b30b06027d65f906b2588567a7f))
+* mutability of local variable `modified` ([0e87ef5](https://github.com/revanced/revanced-patcher/commit/0e87ef56c418d5c37d58abb9b27f85e25fd44f81))
+
+# [1.10.0](https://github.com/revanced/revanced-patcher/compare/v1.9.0...v1.10.0) (2022-06-23)
+
+
+### Features
+
+* improve logging ([c20dfe1](https://github.com/revanced/revanced-patcher/commit/c20dfe12d5c737264b844e6634de11bf1e1629f0))
+
+# [1.9.0](https://github.com/revanced/revanced-patcher/compare/v1.8.0...v1.9.0) (2022-06-22)
+
+
+### Bug Fixes
+
+* callback for each file instead of class ([930768d](https://github.com/revanced/revanced-patcher/commit/930768dfb31dc5fa6c248050b08ac117c40ee0a3))
+
+
+### Features
+
+* yield the patch result ([dde5385](https://github.com/revanced/revanced-patcher/commit/dde5385232abddc8a85d6e9a939549b71dd9130e))
+
+# [1.8.0](https://github.com/revanced/revanced-patcher/compare/v1.7.2...v1.8.0) (2022-06-22)
+
+
+### Features
+
+* logging class ([caf2745](https://github.com/revanced/revanced-patcher/commit/caf2745805ffd4b59fa81e79cc489b1a1a5c5d89))
+
+## [1.7.2](https://github.com/revanced/revanced-patcher/compare/v1.7.1...v1.7.2) (2022-06-22)
+
+
+### Bug Fixes
+
+* add execute permission to `./gradlew` file ([#46](https://github.com/revanced/revanced-patcher/issues/46)) ([34f607a](https://github.com/revanced/revanced-patcher/commit/34f607aa24d89a777d906cc887203f343ce3fd07))
+
+## [1.7.1](https://github.com/revanced/revanced-patcher/compare/v1.7.0...v1.7.1) (2022-06-22)
+
+
+### Reverts
+
+* revert "feat: use of `java.util.logging.Logger`" ([e8488b3](https://github.com/revanced/revanced-patcher/commit/e8488b3e86e0132011824f8ecba29e64f8db0573))
+
+# [1.7.0](https://github.com/revanced/revanced-patcher/compare/v1.6.0...v1.7.0) (2022-06-22)
+
+
+### Features
+
+* migrate logger to `slf4j` ([8f66f9f](https://github.com/revanced/revanced-patcher/commit/8f66f9f606a785ac947b0e553822877f211d82df))
+
+# [1.6.0](https://github.com/revanced/revanced-patcher/compare/v1.5.0...v1.6.0) (2022-06-22)
+
+
+### Features
+
+* use of `java.util.logging.Logger` ([9c39c9e](https://github.com/revanced/revanced-patcher/commit/9c39c9efdb5d48ddaffce7f711c275e732b0b2d9))
+
+# [1.5.0](https://github.com/revanced/revanced-patcher/compare/v1.4.0...v1.5.0) (2022-06-22)
+
+
+### Features
+
+* use streams to write the dex files ([64bae88](https://github.com/revanced/revanced-patcher/commit/64bae884dcb72550a3218e149f3ca0fd0ca03aaf))
+
+# [1.4.0](https://github.com/revanced/revanced-patcher/compare/v1.3.4...v1.4.0) (2022-06-22)
+
+
+### Features
+
+* return a `File` instance instead of `ExtFile` ([68174bb](https://github.com/revanced/revanced-patcher/commit/68174bbd6b4df47a91b610c2b97dbae55b594163))
+
+## [1.3.4](https://github.com/revanced/revanced-patcher/compare/v1.3.3...v1.3.4) (2022-06-21)
+
+
+### Bug Fixes
+
+* `String.toInstructions` defaulting `forStaticMethod` to `false` ([5a2f02b](https://github.com/revanced/revanced-patcher/commit/5a2f02b97dcde95dbe901fa68cca6c6c0219cb82)), closes [revanced/revanced-patches#46](https://github.com/revanced/revanced-patches/issues/46)
+
+## [1.3.3](https://github.com/revanced/revanced-patcher/compare/v1.3.2...v1.3.3) (2022-06-21)
+
+
+### Bug Fixes
+
+* add docs (trigger release) ([6628b78](https://github.com/revanced/revanced-patcher/commit/6628b7870fc052da40be0d50a7e2b0b6c57743cc))
+
+
+### Reverts
+
+* propagate dependencies ([365e1d7](https://github.com/revanced/revanced-patcher/commit/365e1d7a4507b918a4c8170ce2c88f6c8ff1d474))
+
+## [1.3.2](https://github.com/revanced/revanced-patcher/compare/v1.3.1...v1.3.2) (2022-06-21)
+
+
+### Bug Fixes
+
+* return resourceFile to caller ([1f75777](https://github.com/revanced/revanced-patcher/commit/1f75777cf985bf08483033ec541937d3e733347b))
+
+## [1.3.1](https://github.com/revanced/revanced-patcher/compare/v1.3.0...v1.3.1) (2022-06-21)
+
+
+### Bug Fixes
+
+* `InlineSmaliCompiler.compile` using 0 registers instead of 1 by default ([835a421](https://github.com/revanced/revanced-patcher/commit/835a421cc0588b92c2995e9d74727069d14b1750))
+
+# [1.3.0](https://github.com/revanced/revanced-patcher/compare/v1.2.9...v1.3.0) (2022-06-20)
+
+
+### Features
+
+* `parametersCount` for `InlineSmaliCompiler` instead of `parameters` ([ad6c5c8](https://github.com/revanced/revanced-patcher/commit/ad6c5c827389d10eae473dc66557a699df8c3280))
+* simplify adding instructions ([e47b67d](https://github.com/revanced/revanced-patcher/commit/e47b67d7ec521f288644afb89baf4146dc9bc87d))
+
+## [1.2.9](https://github.com/revanced/revanced-patcher/compare/v1.2.8...v1.2.9) (2022-06-20)
+
+
+### Bug Fixes
+
+* update apktool ([ab866bb](https://github.com/revanced/revanced-patcher/commit/ab866bb8ef4792d8f2a51edc79e687b5b636c621))
+
+## [1.2.8](https://github.com/revanced/revanced-patcher/compare/v1.2.7...v1.2.8) (2022-06-18)
+
+
+### Bug Fixes
+
+* update apktool ([051afd9](https://github.com/revanced/revanced-patcher/commit/051afd98d065f71556392139d77c20b4c2dc7dd1))
+
+## [1.2.7](https://github.com/revanced/revanced-patcher/compare/v1.2.6...v1.2.7) (2022-06-18)
+
+
+### Bug Fixes
+
+* version not working with apktool due to cache ([03f5ee0](https://github.com/revanced/revanced-patcher/commit/03f5ee088b1b96b88cb7aeb323443b6209a13950))
+
 ## [1.2.6](https://github.com/revanced/revanced-patcher/compare/v1.2.5...v1.2.6) (2022-06-18)
 
 

build.gradle.kts

@@ -21,15 +21,14 @@ repositories {
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
+    implementation("app.revanced:multidexlib2:2.5.2.r2")
 
-    api("xpp3:xpp3:1.1.4c")
-    api("org.apktool:apktool-lib:2.6.2-SNAPSHOT")
-    api("app.revanced:multidexlib2:2.5.2.r2")
-    api("org.smali:smali:2.5.2")
+    implementation("xpp3:xpp3:1.1.4c")
+    implementation("org.smali:smali:2.5.2")
+    implementation("org.apktool:apktool-lib:2.6.5-SNAPSHOT")
 
     testImplementation(kotlin("test"))
-    implementation(kotlin("reflect"))}
+}
 
 tasks {
     test {
@@ -46,6 +45,7 @@ java {
 
 publishing {
     repositories {
+        if (System.getenv("GITHUB_ACTOR") != null)
             maven {
                 name = "GitHubPackages"
                 url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
@@ -54,6 +54,8 @@ publishing {
                     password = System.getenv("GITHUB_TOKEN")
                 }
             }
+        else
+            mavenLocal()
     }
     publications {
         register<MavenPublication>("gpr") {

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.2.6
+version = 2.0.0

src/main/kotlin/app/revanced/patcher/PatcherData.kt

@@ -1,9 +1,10 @@
-package app.revanced.patcher.data
+package app.revanced.patcher
 
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.data.implementation.ResourceData
-import app.revanced.patcher.patch.base.Patch
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.data.PackageMetadata
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.ResourceData
+import app.revanced.patcher.patch.Patch
 import org.jf.dexlib2.iface.ClassDef
 import java.io.File
 

src/main/kotlin/app/revanced/patcher/PatcherOptions.kt

@@ -1,19 +1,23 @@
 package app.revanced.patcher
 
+import app.revanced.patcher.logging.Logger
+import app.revanced.patcher.logging.impl.NopLogger
 import java.io.File
 
 /**
- * Options for a patcher.
+ * Options for the [Patcher].
  * @param inputFile The input file (usually an apk file).
  * @param resourceCacheDirectory Directory to cache resources.
  * @param patchResources Weather to use the resource patcher. Resources will still need to be decoded.
  * @param aaptPath Optional path to a custom aapt binary.
  * @param frameworkFolderLocation Optional path to a custom framework folder.
+ * @param logger Custom logger implementation for the [Patcher].
  */
 data class PatcherOptions(
     internal val inputFile: File,
     internal val resourceCacheDirectory: String,
     internal val patchResources: Boolean = false,
     internal val aaptPath: String = "",
-    internal val frameworkFolderLocation: String? = null
+    internal val frameworkFolderLocation: String? = null,
+    internal val logger: Logger = NopLogger
 )

src/main/kotlin/app/revanced/patcher/PatcherResult.kt

@@ -1,13 +1,16 @@
 package app.revanced.patcher
 
 import app.revanced.patcher.util.dex.DexFile
+import java.io.File
 
 /**
  * The result of a patcher.
  * @param dexFiles The patched dex files.
  * @param doNotCompress List of relative paths to files to exclude from compressing.
+ * @param resourceFile File containing resources that need to be extracted into the APK.
  */
 data class PatcherResult(
     val dexFiles: List<DexFile>,
-    val doNotCompress: List<String>? = null
+    val doNotCompress: List<String>? = null,
+    val resourceFile: File?
 )

src/main/kotlin/app/revanced/patcher/annotation/CompatibilityAnnotation.kt

@@ -1,11 +1,11 @@
 package app.revanced.patcher.annotation
 
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 
 /**
- * Annotation to constrain a [Patch] or [MethodSignature] to compatible packages.
- * @param compatiblePackages A list of packages a [Patch] or [MethodSignature] is compatible with.
+ * Annotation to constrain a [Patch] or [MethodFingerprint] to compatible packages.
+ * @param compatiblePackages A list of packages a [Patch] or [MethodFingerprint] is compatible with.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -17,7 +17,7 @@ annotation class Compatibility(
 /**
  * Annotation to represent packages a patch can be compatible with.
  * @param name The package identifier name.
- * @param versions The versions of the package the [Patch] or [MethodSignature]is compatible with.
+ * @param versions The versions of the package the [Patch] or [MethodFingerprint]is compatible with.
  */
 @Target()
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/annotation/MetadataAnnotation.kt

@@ -1,11 +1,11 @@
 package app.revanced.patcher.annotation
 
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 
 /**
- * Annotation to name a [Patch] or [MethodSignature].
- * @param name A suggestive name for the [Patch] or [MethodSignature].
+ * Annotation to name a [Patch] or [MethodFingerprint].
+ * @param name A suggestive name for the [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -15,8 +15,8 @@ annotation class Name(
 )
 
 /**
- * Annotation to describe a [Patch] or [MethodSignature].
- * @param description A description for the [Patch] or [MethodSignature].
+ * Annotation to describe a [Patch] or [MethodFingerprint].
+ * @param description A description for the [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -27,8 +27,8 @@ annotation class Description(
 
 
 /**
- * Annotation to version a [Patch] or [MethodSignature].
- * @param version The version of a [Patch] or [MethodSignature].
+ * Annotation to version a [Patch] or [MethodFingerprint].
+ * @param version The version of a [Patch] or [MethodFingerprint].
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/data/Data.kt

@@ -0,0 +1,9 @@
+package app.revanced.patcher.data
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.ResourceData
+
+/**
+ * Constraint interface for [BytecodeData] and [ResourceData]
+ */
+interface Data

src/main/kotlin/app/revanced/patcher/data/base/Data.kt

@@ -1,9 +0,0 @@
-package app.revanced.patcher.data.base
-
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.data.implementation.ResourceData
-
-/**
- * Constraint interface for [BytecodeData] and [ResourceData]
- */
-interface Data

src/main/kotlin/app/revanced/patcher/data/impl/BytecodeData.kt

@@ -1,6 +1,6 @@
-package app.revanced.patcher.data.implementation
+package app.revanced.patcher.data.impl
 
-import app.revanced.patcher.data.base.Data
+import app.revanced.patcher.data.Data
 import app.revanced.patcher.util.ProxyBackedClassList
 import app.revanced.patcher.util.method.MethodWalker
 import org.jf.dexlib2.iface.ClassDef

src/main/kotlin/app/revanced/patcher/data/impl/ResourceData.kt

@@ -1,10 +1,9 @@
-package app.revanced.patcher.data.implementation
+package app.revanced.patcher.data.impl
 
-import app.revanced.patcher.data.base.Data
+import app.revanced.patcher.data.Data
 import org.w3c.dom.Document
 import java.io.Closeable
 import java.io.File
-import javax.xml.XMLConstants
 import javax.xml.parsers.DocumentBuilderFactory
 import javax.xml.transform.TransformerFactory
 import javax.xml.transform.dom.DOMSource

src/main/kotlin/app/revanced/patcher/extensions/AnnotationExtensions.kt

@@ -4,11 +4,9 @@ import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-import app.revanced.patcher.signature.implementation.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.signature.implementation.method.annotation.MatchingMethod
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
 import kotlin.reflect.KClass
 
 /**
@@ -47,13 +45,13 @@ object PatchExtensions {
     val Class<out Patch<Data>>.compatiblePackages get() = recursiveAnnotation(Compatibility::class)?.compatiblePackages
 }
 
-object MethodSignatureExtensions {
-    val MethodSignature.name: String
+object MethodFingerprintExtensions {
+    val MethodFingerprint.name: String
         get() = javaClass.recursiveAnnotation(Name::class)?.name ?: this.javaClass.simpleName
-    val MethodSignature.version get() = javaClass.recursiveAnnotation(Version::class)?.version ?: "0.0.1"
-    val MethodSignature.description get() = javaClass.recursiveAnnotation(Description::class)?.description
-    val MethodSignature.compatiblePackages get() = javaClass.recursiveAnnotation(Compatibility::class)?.compatiblePackages
-    val MethodSignature.matchingMethod get() = javaClass.recursiveAnnotation(MatchingMethod::class)
-    val MethodSignature.fuzzyPatternScanMethod get() = javaClass.recursiveAnnotation(FuzzyPatternScanMethod::class)
-    val MethodSignature.fuzzyThreshold get() = fuzzyPatternScanMethod?.threshold ?: 0
+    val MethodFingerprint.version get() = javaClass.recursiveAnnotation(Version::class)?.version ?: "0.0.1"
+    val MethodFingerprint.description get() = javaClass.recursiveAnnotation(Description::class)?.description
+    val MethodFingerprint.compatiblePackages get() = javaClass.recursiveAnnotation(Compatibility::class)?.compatiblePackages
+    val MethodFingerprint.matchingMethod get() = javaClass.recursiveAnnotation(app.revanced.patcher.fingerprint.method.annotation.MatchingMethod::class)
+    val MethodFingerprint.fuzzyPatternScanMethod get() = javaClass.recursiveAnnotation(app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod::class)
+    val MethodFingerprint.fuzzyScanThreshold get() = fuzzyPatternScanMethod?.threshold ?: 0
 }

src/main/kotlin/app/revanced/patcher/extensions/Extensions.kt

@@ -1,6 +1,9 @@
 package app.revanced.patcher.extensions
 
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
 import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patcher.util.smali.toInstruction
+import app.revanced.patcher.util.smali.toInstructions
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.builder.BuilderInstruction
 import org.jf.dexlib2.builder.MutableMethodImplementation
@@ -20,6 +23,18 @@ fun MutableMethodImplementation.addInstructions(index: Int, instructions: List<B
     }
 }
 
+fun MutableMethodImplementation.replaceInstructions(index: Int, instructions: List<BuilderInstruction>) {
+    for (i in instructions.lastIndex downTo 0) {
+        this.replaceInstruction(index + i, instructions[i])
+    }
+}
+
+fun MutableMethodImplementation.removeInstructions(index: Int, count: Int) {
+    for (i in count downTo 0) {
+        this.removeInstruction(index + i)
+    }
+}
+
 /**
  * Compare a method to another, considering constructors and parameters.
  * @param otherMethod The method to compare against.
@@ -62,6 +77,60 @@ internal fun Method.clone(
     )
 }
 
+/**
+ * Add a smali instruction to the method.
+ * @param instruction The smali instruction to add.
+ */
+fun MutableMethod.addInstruction(instruction: String) =
+    this.implementation!!.addInstruction(instruction.toInstruction(this))
+
+/**
+ * Add a smali instruction to the method.
+ * @param index The index to insert the instruction at.
+ * @param instruction The smali instruction to add.
+ */
+fun MutableMethod.addInstruction(index: Int, instruction: String) =
+    this.implementation!!.addInstruction(index, instruction.toInstruction(this))
+
+/**
+ * Replace a smali instruction within the method.
+ * @param index The index to replace the instruction at.
+ * @param instruction The smali instruction to place.
+ */
+fun MutableMethod.replaceInstruction(index: Int, instruction: String) =
+    this.implementation!!.replaceInstruction(index, instruction.toInstruction(this))
+
+/**
+ * Remove a smali instruction within the method.
+ * @param index The index to delete the instruction at.
+ */
+fun MutableMethod.removeInstruction(index: Int) =
+    this.implementation!!.removeInstruction(index)
+
+/**
+ * Add smali instructions to the method.
+ * @param index The index to insert the instructions at.
+ * @param instructions The smali instructions to add.
+ */
+fun MutableMethod.addInstructions(index: Int, instructions: String) =
+    this.implementation!!.addInstructions(index, instructions.toInstructions(this))
+
+/**
+ * Replace smali instructions within the method.
+ * @param index The index to replace the instructions at.
+ * @param instructions The smali instructions to place.
+ */
+fun MutableMethod.replaceInstructions(index: Int, instructions: String) =
+    this.implementation!!.replaceInstructions(index, instructions.toInstructions(this))
+
+/**
+ * Remove smali instructions from the method.
+ * @param index The index to remove the instructions at.
+ * @param count The amount of instructions to remove.
+ */
+fun MutableMethod.removeInstructions(index: Int, count: Int) =
+    this.implementation!!.removeInstructions(index, count)
+
 /**
  * Clones the method.
  * @param registerCount This parameter allows you to change the register count of the method.
@@ -89,4 +158,21 @@ internal fun parametersEqual(
 internal val nullOutputStream: OutputStream =
     object : OutputStream() {
         override fun write(b: Int) {}
-    }
+    }
+
+/**
+ * Should be used to parse a list of parameters represented by their first letter,
+ * or in the case of arrays prefixed with an unspecified amount of '[' character.
+ */
+internal fun String.parseParameters(): List<String> {
+    val parameters = mutableListOf<String>()
+    var parameter = ""
+    for (char in this.toCharArray()) {
+        parameter += char
+        if (char == '[') continue
+
+        parameters.add(parameter)
+        parameter = ""
+    }
+    return parameters
+}

src/main/kotlin/app/revanced/patcher/fingerprint/Fingerprint.kt

@@ -0,0 +1,9 @@
+package app.revanced.patcher.fingerprint
+
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+/**
+ * A ReVanced fingerprint.
+ * Can be a [MethodFingerprint].
+ */
+interface Fingerprint

src/main/kotlin/app/revanced/patcher/fingerprint/method/annotation/MethodFingerprintMetadata.kt

@@ -1,11 +1,11 @@
-package app.revanced.patcher.signature.implementation.method.annotation
+package app.revanced.patcher.fingerprint.method.annotation
 
-import app.revanced.patcher.signature.implementation.method.MethodSignature
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
 
 /**
- * Annotations for a method which matches to a [MethodSignature].
+ * Annotations for a method which matches to a [MethodFingerprint].
  * @param definingClass The defining class name of the method.
- * @param name A suggestive name for the method which the [MethodSignature] was created for.
+ * @param name A suggestive name for the method which the [MethodFingerprint] was created for.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
@@ -15,7 +15,7 @@ annotation class MatchingMethod(
 )
 
 /**
- * Annotations to scan a pattern [MethodSignature] with fuzzy algorithm.
+ * Annotations to scan a pattern [MethodFingerprint] with fuzzy algorithm.
  * @param threshold if [threshold] or more of the opcodes do not match, skip.
  */
 @Target(AnnotationTarget.CLASS)
@@ -25,7 +25,7 @@ annotation class FuzzyPatternScanMethod(
 )
 
 /**
- * Annotations to scan a pattern [MethodSignature] directly.
+ * Annotations to scan a pattern [MethodFingerprint] directly.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)

src/main/kotlin/app/revanced/patcher/fingerprint/method/impl/MethodFingerprint.kt

@@ -0,0 +1,99 @@
+package app.revanced.patcher.fingerprint.method.impl
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.MethodNotFoundException
+import app.revanced.patcher.data.impl.proxy
+import app.revanced.patcher.extensions.MethodFingerprintExtensions.name
+import app.revanced.patcher.extensions.softCompareTo
+import app.revanced.patcher.fingerprint.Fingerprint
+import app.revanced.patcher.fingerprint.method.utils.MethodFingerprintUtils
+import app.revanced.patcher.util.proxy.ClassProxy
+import org.jf.dexlib2.Opcode
+import org.jf.dexlib2.iface.ClassDef
+import org.jf.dexlib2.iface.Method
+
+/**
+ * Represents the [MethodFingerprint] for a method.
+ * @param returnType The return type of the method.
+ * @param access The access flags of the method.
+ * @param parameters The parameters of the method.
+ * @param opcodes The list of opcodes of the method.
+ * @param strings A list of strings which a method contains.
+ * @param customFingerprint A custom condition for this fingerprint.
+ * A `null` opcode is equals to an unknown opcode.
+ */
+abstract class MethodFingerprint(
+    internal val returnType: String?,
+    internal val access: Int?,
+    internal val parameters: Iterable<String>?,
+    internal val opcodes: Iterable<Opcode?>?,
+    internal val strings: Iterable<String>? = null,
+    internal val customFingerprint: ((methodDef: Method) -> Boolean)? = null
+) : Fingerprint {
+    /**
+     * The result of the [MethodFingerprint] the [Method].
+     * @throws MethodNotFoundException If the resolution of the [Method] has not happened.
+     */
+    var result: MethodFingerprintResult? = null
+        get() = field ?: throw MethodNotFoundException("${this.name} has not been resolved yet.")
+}
+
+/**
+ * Represents the result of a [MethodFingerprintUtils].
+ * @param method The matching method.
+ * @param classDef The [ClassDef] that contains the matching [method].
+ * @param patternScanResult Opcodes pattern scan result.
+ * @param data The [BytecodeData] this [MethodFingerprintResult] is attached to, to create proxies.
+ */
+data class MethodFingerprintResult(
+    val method: Method,
+    val classDef: ClassDef,
+    val patternScanResult: PatternScanResult?,
+    val data: BytecodeData
+) {
+    /**
+     * Returns a mutable clone of [classDef]
+     *
+     * Please note, this method allocates a [ClassProxy].
+     * Use [classDef] where possible.
+     */
+    val mutableClass by lazy { data.proxy(classDef).resolve() }
+
+    /**
+     * Returns a mutable clone of [method]
+     *
+     * Please note, this method allocates a [ClassProxy].
+     * Use [method] where possible.
+     */
+    val mutableMethod by lazy {
+        mutableClass.methods.first {
+            it.softCompareTo(this.method)
+        }
+    }
+}
+
+/**
+ * The result of a pattern scan.
+ * @param startIndex The start index of the instructions where to which this pattern matches.
+ * @param endIndex The end index of the instructions where to which this pattern matches.
+ * @param warnings A list of warnings considering this [PatternScanResult].
+ */
+data class PatternScanResult(
+    val startIndex: Int,
+    val endIndex: Int,
+    var warnings: List<Warning>? = null
+) {
+    /**
+     * Represents warnings of the pattern scan.
+     * @param correctOpcode The opcode the instruction list has.
+     * @param wrongOpcode The opcode the pattern list of the signature currently has.
+     * @param instructionIndex The index of the opcode relative to the instruction list.
+     * @param patternIndex The index of the opcode relative to the pattern list from the signature.
+     */
+    data class Warning(
+        val correctOpcode: Opcode,
+        val wrongOpcode: Opcode,
+        val instructionIndex: Int,
+        val patternIndex: Int,
+    )
+}

src/main/kotlin/app/revanced/patcher/fingerprint/method/utils/MethodFingerprintUtils.kt

@@ -0,0 +1,158 @@
+package app.revanced.patcher.fingerprint.method.utils
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.extensions.MethodFingerprintExtensions.fuzzyPatternScanMethod
+import app.revanced.patcher.extensions.MethodFingerprintExtensions.fuzzyScanThreshold
+import app.revanced.patcher.extensions.parametersEqual
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
+import app.revanced.patcher.fingerprint.method.impl.PatternScanResult
+import org.jf.dexlib2.Opcode
+import org.jf.dexlib2.iface.ClassDef
+import org.jf.dexlib2.iface.Method
+import org.jf.dexlib2.iface.instruction.Instruction
+import org.jf.dexlib2.iface.instruction.ReferenceInstruction
+import org.jf.dexlib2.iface.reference.StringReference
+
+/**
+ * Utility class for [MethodFingerprint]
+ */
+object MethodFingerprintUtils {
+    /**
+     * Resolve a list of [MethodFingerprint] against a list of [ClassDef].
+     * @param context The classes on which to resolve the [MethodFingerprint].
+     * @param forData The [BytecodeData] to host proxies.
+     * @return True if the resolution was successful, false otherwise.
+     */
+    fun Iterable<MethodFingerprint>.resolve(forData: BytecodeData, context: Iterable<ClassDef>) {
+        for (fingerprint in this) // For each fingerprint
+            classes@ for (classDef in context) // search through all classes for the fingerprint
+                if (fingerprint.resolve(forData, classDef))
+                    break@classes // if the resolution succeeded, continue with the next fingerprint
+    }
+
+    /**
+     * Resolve a [MethodFingerprint] against a [ClassDef].
+     * @param context The class on which to resolve the [MethodFingerprint].
+     * @param forData The [BytecodeData] to host proxies.
+     * @return True if the resolution was successful, false otherwise.
+     */
+    fun MethodFingerprint.resolve(forData: BytecodeData, context: ClassDef): Boolean {
+        for (method in context.methods)
+            if (this.resolve(forData, method, context))
+                return true
+        return false
+    }
+
+    /**
+     * Resolve a [MethodFingerprint] against a [Method].
+     * @param context The context on which to resolve the [MethodFingerprint].
+     * @param classDef The class of the matching [Method].
+     * @param forData The [BytecodeData] to host proxies.
+     * @return True if the resolution was successful, false otherwise.
+     */
+    fun MethodFingerprint.resolve(forData: BytecodeData, context: Method, classDef: ClassDef): Boolean {
+        val methodFingerprint = this
+
+        if (methodFingerprint.returnType != null && !context.returnType.startsWith(methodFingerprint.returnType))
+            return false
+
+        if (methodFingerprint.access != null && methodFingerprint.access != context.accessFlags)
+            return false
+
+
+        if (methodFingerprint.parameters != null && !parametersEqual(
+                methodFingerprint.parameters, // TODO: parseParameters()
+                context.parameterTypes
+            )
+        ) return false
+
+        if (methodFingerprint.customFingerprint != null && methodFingerprint.customFingerprint!!(context))
+            return false
+
+        if (methodFingerprint.strings != null) {
+            val implementation = context.implementation ?: return false
+
+            val stringsList = methodFingerprint.strings.toMutableList()
+
+            implementation.instructions.forEach { instruction ->
+                if (instruction.opcode.ordinal != Opcode.CONST_STRING.ordinal) return@forEach
+
+                val string = ((instruction as ReferenceInstruction).reference as StringReference).string
+                val index = stringsList.indexOfFirst { it == string }
+                if (index != -1) stringsList.removeAt(index)
+            }
+
+            if (stringsList.isNotEmpty()) return false
+        }
+
+        val patternScanResult = if (methodFingerprint.opcodes != null) {
+            context.implementation?.instructions ?: return false
+
+            context.patternScan(methodFingerprint) ?: return false
+        } else null
+
+        methodFingerprint.result = MethodFingerprintResult(context, classDef, patternScanResult, forData)
+
+        return true
+    }
+
+    private fun Method.patternScan(
+        fingerprint: MethodFingerprint
+    ): PatternScanResult? {
+        val instructions = this.implementation!!.instructions
+        val fingerprintFuzzyPatternScanThreshold = fingerprint.fuzzyScanThreshold
+
+        val pattern = fingerprint.opcodes!!
+        val instructionLength = instructions.count()
+        val patternLength = pattern.count()
+
+        for (index in 0 until instructionLength) {
+            var patternIndex = 0
+            var threshold = fingerprintFuzzyPatternScanThreshold
+
+            while (index + patternIndex < instructionLength) {
+                val originalOpcode = instructions.elementAt(index + patternIndex).opcode
+                val patternOpcode = pattern.elementAt(patternIndex)
+
+                if (patternOpcode != null && patternOpcode.ordinal != originalOpcode.ordinal) {
+                    // reaching maximum threshold (0) means,
+                    // the pattern does not match to the current instructions
+                    if (threshold-- == 0) break
+                }
+
+                if (patternIndex < patternLength - 1) {
+                    // if the entire pattern has not been scanned yet
+                    // continue the scan
+                    patternIndex++
+                    continue
+                }
+                // the pattern is valid, generate warnings if fuzzyPatternScanMethod is FuzzyPatternScanMethod
+                val result = PatternScanResult(index, index + patternIndex)
+                if (fingerprint.fuzzyPatternScanMethod !is FuzzyPatternScanMethod) return result
+                result.warnings = result.createWarnings(pattern, instructions)
+
+                return result
+            }
+        }
+
+        return null
+    }
+}
+
+private fun PatternScanResult.createWarnings(
+    pattern: Iterable<Opcode?>, instructions: Iterable<Instruction>
+) = buildList {
+    for ((patternIndex, instructionIndex) in (this@createWarnings.startIndex until this@createWarnings.endIndex).withIndex()) {
+        val originalOpcode = instructions.elementAt(instructionIndex).opcode
+        val patternOpcode = pattern.elementAt(patternIndex)
+
+        if (patternOpcode == null || patternOpcode.ordinal == originalOpcode.ordinal) continue
+
+        this.add(PatternScanResult.Warning(originalOpcode, patternOpcode, instructionIndex, patternIndex))
+    }
+}
+
+private operator fun ClassDef.component1() = this
+private operator fun ClassDef.component2() = this.methods

src/main/kotlin/app/revanced/patcher/logging/Logger.kt

@@ -0,0 +1,8 @@
+package app.revanced.patcher.logging
+
+interface Logger {
+    fun error(msg: String) {}
+    fun warn(msg: String) {}
+    fun info(msg: String) {}
+    fun trace(msg: String) {}
+}

src/main/kotlin/app/revanced/patcher/logging/impl/NopLogger.kt

@@ -0,0 +1,5 @@
+package app.revanced.patcher.logging.impl
+
+import app.revanced.patcher.logging.Logger
+
+object NopLogger : Logger

src/main/kotlin/app/revanced/patcher/patch/Patch.kt

@@ -0,0 +1,18 @@
+package app.revanced.patcher.patch
+
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patcher.patch.impl.ResourcePatch
+
+
+/**
+ * A ReVanced patch.
+ * Can either be a [ResourcePatch] or a [BytecodePatch].
+ */
+abstract class Patch<out T : Data> {
+
+    /**
+     * The main function of the [Patch] which the patcher will call.
+     */
+    abstract fun execute(data: @UnsafeVariance T): PatchResult
+}

src/main/kotlin/app/revanced/patcher/patch/PatchResult.kt

@@ -1,4 +1,4 @@
-package app.revanced.patcher.patch.implementation.misc
+package app.revanced.patcher.patch
 
 interface PatchResult {
     fun error(): PatchResultError? {

src/main/kotlin/app/revanced/patcher/patch/annotations/PatchAnnotation.kt

@@ -1,7 +1,7 @@
 package app.revanced.patcher.patch.annotations
 
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.patch.base.Patch
+import app.revanced.patcher.data.Data
+import app.revanced.patcher.patch.Patch
 import kotlin.reflect.KClass
 
 /**

src/main/kotlin/app/revanced/patcher/patch/base/Patch.kt

@@ -1,19 +0,0 @@
-package app.revanced.patcher.patch.base
-
-import app.revanced.patcher.data.base.Data
-import app.revanced.patcher.patch.implementation.BytecodePatch
-import app.revanced.patcher.patch.implementation.ResourcePatch
-import app.revanced.patcher.patch.implementation.misc.PatchResult
-
-
-/**
- * A ReVanced patch.
- * Can either be a [ResourcePatch] or a [BytecodePatch].
- */
-abstract class Patch<out T : Data> {
-
-    /**
-     * The main function of the [Patch] which the patcher will call.
-     */
-    abstract fun execute(data: @UnsafeVariance T): PatchResult
-}

src/main/kotlin/app/revanced/patcher/patch/impl/BytecodePatch.kt

@@ -0,0 +1,13 @@
+package app.revanced.patcher.patch.impl
+
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.Patch
+
+/**
+ * Bytecode patch for the Patcher.
+ * @param fingerprints A list of [MethodFingerprint] this patch relies on.
+ */
+abstract class BytecodePatch(
+    internal val fingerprints: Iterable<MethodFingerprint>
+) : Patch<BytecodeData>()

src/main/kotlin/app/revanced/patcher/patch/impl/ResourcePatch.kt

@@ -0,0 +1,9 @@
+package app.revanced.patcher.patch.impl
+
+import app.revanced.patcher.data.impl.ResourceData
+import app.revanced.patcher.patch.Patch
+
+/**
+ * Resource patch for the Patcher.
+ */
+abstract class ResourcePatch : Patch<ResourceData>()

src/main/kotlin/app/revanced/patcher/patch/implementation/BytecodePatch.kt

@@ -1,13 +0,0 @@
-package app.revanced.patcher.patch.implementation
-
-import app.revanced.patcher.data.implementation.BytecodeData
-import app.revanced.patcher.patch.base.Patch
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-
-/**
- * Bytecode patch for the Patcher.
- * @param signatures A list of [MethodSignature] this patch relies on.
- */
-abstract class BytecodePatch(
-    val signatures: Iterable<MethodSignature>
-) : Patch<BytecodeData>()

src/main/kotlin/app/revanced/patcher/patch/implementation/ResourcePatch.kt

@@ -1,9 +0,0 @@
-package app.revanced.patcher.patch.implementation
-
-import app.revanced.patcher.data.implementation.ResourceData
-import app.revanced.patcher.patch.base.Patch
-
-/**
- * Resource patch for the Patcher.
- */
-abstract class ResourcePatch : Patch<ResourceData>()

src/main/kotlin/app/revanced/patcher/signature/base/Signature.kt

@@ -1,9 +0,0 @@
-package app.revanced.patcher.signature.base
-
-import app.revanced.patcher.signature.implementation.method.MethodSignature
-
-/**
- * A ReVanced signature.
- * Can be a [MethodSignature].
- */
-interface Signature