chore(release): 14.2.1-dev.1 [skip ci]

## [14.2.1-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.2.0...v14.2.1-dev.1) (2023-08-27)

### Bug Fixes

* do not flag resource table as sparse when main package is not loaded ([b832812](b832812767))

CHANGELOG.md

@@ -1,3 +1,159 @@
+## [14.2.1-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.2.0...v14.2.1-dev.1) (2023-08-27)
+
+
+### Bug Fixes
+
+* do not flag resource table as sparse when main package is not loaded ([b832812](https://github.com/ReVanced/revanced-patcher/commit/b832812767a06ec6ec232291e6d14c8c2f14118c))
+
+# [14.2.0](https://github.com/ReVanced/revanced-patcher/compare/v14.1.0...v14.2.0) (2023-08-27)
+
+
+### Features
+
+* load patches in lexicographical order ([e8f2087](https://github.com/ReVanced/revanced-patcher/commit/e8f2087a6ffa6077fb3a6a69e29f3aec72e2fc1b))
+* log when merging integrations ([983563e](https://github.com/ReVanced/revanced-patcher/commit/983563efb6d7c8d289464b8bf71a016b8a735630))
+
+
+### Performance Improvements
+
+* compare types of classes ([55d6945](https://github.com/ReVanced/revanced-patcher/commit/55d694579ac2718b9e2c61ca5f38419c3775ef87))
+
+# [14.2.0-dev.3](https://github.com/ReVanced/revanced-patcher/compare/v14.2.0-dev.2...v14.2.0-dev.3) (2023-08-26)
+
+
+### Performance Improvements
+
+* compare types of classes ([55d6945](https://github.com/ReVanced/revanced-patcher/commit/55d694579ac2718b9e2c61ca5f38419c3775ef87))
+
+# [14.2.0-dev.2](https://github.com/ReVanced/revanced-patcher/compare/v14.2.0-dev.1...v14.2.0-dev.2) (2023-08-26)
+
+
+### Features
+
+* log when merging integrations ([983563e](https://github.com/ReVanced/revanced-patcher/commit/983563efb6d7c8d289464b8bf71a016b8a735630))
+
+# [14.2.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.1.0...v14.2.0-dev.1) (2023-08-25)
+
+
+### Features
+
+* load patches in lexicographical order ([e8f2087](https://github.com/ReVanced/revanced-patcher/commit/e8f2087a6ffa6077fb3a6a69e29f3aec72e2fc1b))
+
+# [14.1.0](https://github.com/ReVanced/revanced-patcher/compare/v14.0.0...v14.1.0) (2023-08-24)
+
+
+### Bug Fixes
+
+* move version properties file to correct package ([e985676](https://github.com/ReVanced/revanced-patcher/commit/e985676c2d8e5d6cb907d371de30428caaa6da43))
+
+
+### Features
+
+* properly make use of logging facade ([ba56a6a](https://github.com/ReVanced/revanced-patcher/commit/ba56a6a2eef503c0d6cdd846ddce2e1474d8ed1a))
+
+# [14.1.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.0.1-dev.1...v14.1.0-dev.1) (2023-08-24)
+
+
+### Features
+
+* properly make use of logging facade ([ba56a6a](https://github.com/ReVanced/revanced-patcher/commit/ba56a6a2eef503c0d6cdd846ddce2e1474d8ed1a))
+
+## [14.0.1-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.0.0...v14.0.1-dev.1) (2023-08-23)
+
+
+### Bug Fixes
+
+* move version properties file to correct package ([e985676](https://github.com/ReVanced/revanced-patcher/commit/e985676c2d8e5d6cb907d371de30428caaa6da43))
+
+# [14.0.0](https://github.com/ReVanced/revanced-patcher/compare/v13.0.0...v14.0.0) (2023-08-22)
+
+
+### Bug Fixes
+
+* log decoding resources after logging deleting resource cache directory ([db62a16](https://github.com/ReVanced/revanced-patcher/commit/db62a1607b4a9d6256b5f5153decb088d9680553))
+* only emit closed patches that did not throw an exception with the `@Patch` annotation ([5938f6b](https://github.com/ReVanced/revanced-patcher/commit/5938f6b7ea25103a0a1b56ceebe49139bc80c6f5))
+* supply the parent classloader to `DexClassLoader` ([0f15077](https://github.com/ReVanced/revanced-patcher/commit/0f15077225600b65200022c1a318e504deb472b9))
+
+
+### Code Refactoring
+
+* improve structure and public API ([6b8977f](https://github.com/ReVanced/revanced-patcher/commit/6b8977f17854ef0344d868e6391cb18134eceadc))
+
+
+### Features
+
+* do not log instantiation of ReVanced Patcher ([273dd8d](https://github.com/ReVanced/revanced-patcher/commit/273dd8d388f8e9b7436c6d6145a94c12c1fabe55))
+
+
+### BREAKING CHANGES
+
+* Various public APIs have been changed. The `Version` annotation has been removed. Patches do not return anything anymore and instead throw `PatchException`. Multiple patch bundles can now be loaded in a single ClassLoader to bypass class loader isolation.
+
+# [14.0.0-dev.4](https://github.com/ReVanced/revanced-patcher/compare/v14.0.0-dev.3...v14.0.0-dev.4) (2023-08-22)
+
+
+### Bug Fixes
+
+* only emit closed patches that did not throw an exception with the `@Patch` annotation ([5938f6b](https://github.com/ReVanced/revanced-patcher/commit/5938f6b7ea25103a0a1b56ceebe49139bc80c6f5))
+
+# [14.0.0-dev.3](https://github.com/ReVanced/revanced-patcher/compare/v14.0.0-dev.2...v14.0.0-dev.3) (2023-08-20)
+
+
+### Bug Fixes
+
+* supply the parent classloader to `DexClassLoader` ([0f15077](https://github.com/ReVanced/revanced-patcher/commit/0f15077225600b65200022c1a318e504deb472b9))
+
+
+### Features
+
+* do not log instantiation of ReVanced Patcher ([273dd8d](https://github.com/ReVanced/revanced-patcher/commit/273dd8d388f8e9b7436c6d6145a94c12c1fabe55))
+
+# [14.0.0-dev.2](https://github.com/ReVanced/revanced-patcher/compare/v14.0.0-dev.1...v14.0.0-dev.2) (2023-08-19)
+
+# [14.0.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v13.0.0...v14.0.0-dev.1) (2023-08-18)
+
+
+### Bug Fixes
+
+* log decoding resources after logging deleting resource cache directory ([db62a16](https://github.com/ReVanced/revanced-patcher/commit/db62a1607b4a9d6256b5f5153decb088d9680553))
+
+
+### Code Refactoring
+
+* improve structure and public API ([6b8977f](https://github.com/ReVanced/revanced-patcher/commit/6b8977f17854ef0344d868e6391cb18134eceadc))
+
+
+### BREAKING CHANGES
+
+* Various public APIs have been changed. The `Version` annotation has been removed. Patches do not return anything anymore and instead throw `PatchException`. Multiple patch bundles can now be loaded in a single ClassLoader to bypass class loader isolation.
+
+# [13.0.0](https://github.com/ReVanced/revanced-patcher/compare/v12.1.1...v13.0.0) (2023-08-14)
+
+
+### Bug Fixes
+
+* decode in correct order ([8fb2f2d](https://github.com/ReVanced/revanced-patcher/commit/8fb2f2dc1d3b9b1e9fd13b39485985d2886d52ae))
+* disable correct loggers ([c2d89c6](https://github.com/ReVanced/revanced-patcher/commit/c2d89c622e06e58e5042e1a00ef67cee8a246e53))
+* get framework ids to compile resources ([f2cb7ee](https://github.com/ReVanced/revanced-patcher/commit/f2cb7ee7dffa573c31df497cf235a3f5d120f91f))
+* only enable logging for ReVanced ([783ccf8](https://github.com/ReVanced/revanced-patcher/commit/783ccf8529f5d16aa463982da6977328306232bb))
+* set package metadata correctly ([02d6ff1](https://github.com/ReVanced/revanced-patcher/commit/02d6ff15fe87c2352de29749610e9d72db8ba418))
+
+
+* build(Needs bump)!: Bump dependencies ([d5f89a9](https://github.com/ReVanced/revanced-patcher/commit/d5f89a903f019c199bdb27a50287124fc4b4978e))
+
+
+### BREAKING CHANGES
+
+* This bump updates smali, a crucial dependency
+
+# [13.0.0-dev.3](https://github.com/ReVanced/revanced-patcher/compare/v13.0.0-dev.2...v13.0.0-dev.3) (2023-08-14)
+
+
+### Bug Fixes
+
+* decode in correct order ([8fb2f2d](https://github.com/ReVanced/revanced-patcher/commit/8fb2f2dc1d3b9b1e9fd13b39485985d2886d52ae))
+* only enable logging for ReVanced ([783ccf8](https://github.com/ReVanced/revanced-patcher/commit/783ccf8529f5d16aa463982da6977328306232bb))
+
 # [13.0.0-dev.2](https://github.com/ReVanced/revanced-patcher/compare/v13.0.0-dev.1...v13.0.0-dev.2) (2023-08-12)
 
 

build.gradle.kts

@@ -5,31 +5,17 @@ plugins {
 
 group = "app.revanced"
 
-val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
-val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN")
-
-repositories {
-    mavenCentral()
-    google()
-    listOf("multidexlib2", "apktool").forEach { repo ->
-        maven {
-            url = uri("https://maven.pkg.github.com/revanced/$repo")
-            credentials {
-                username = githubUsername
-                password = githubPassword
-            }
-        }
-    }
-}
-
 dependencies {
-    implementation("xpp3:xpp3:1.1.4c")
-    implementation("com.android.tools.smali:smali:3.0.3")
-    implementation("app.revanced:multidexlib2:3.0.3.r2")
-    implementation("app.revanced:apktool-lib:2.8.2-3")
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.xpp3)
+    implementation(libs.smali)
+    implementation(libs.multidexlib2)
+    implementation(libs.apktool.lib)
+    implementation(libs.kotlin.reflect)
 
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.22")
-    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
+    compileOnly(libs.android)
+
+    testImplementation(libs.kotlin.test)
 }
 
 tasks {
@@ -39,35 +25,32 @@ tasks {
             events("PASSED", "SKIPPED", "FAILED")
         }
     }
+
     processResources {
         expand("projectVersion" to project.version)
     }
 }
 
+kotlin { jvmToolchain(11) }
+
 java {
     withSourcesJar()
 }
 
-kotlin {
-    jvmToolchain(11)
-}
-
 publishing {
     repositories {
-        if (System.getenv("GITHUB_ACTOR") != null)
-            maven {
-                name = "GitHubPackages"
-                url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
-                credentials {
-                    username = System.getenv("GITHUB_ACTOR")
-                    password = System.getenv("GITHUB_TOKEN")
-                }
+        mavenLocal()
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
+            credentials {
+                username = System.getenv("GITHUB_ACTOR")
+                password = System.getenv("GITHUB_TOKEN")
             }
-        else
-            mavenLocal()
+        }
     }
     publications {
-        register<MavenPublication>("gpr") {
+        create<MavenPublication>("gpr") {
             from(components["java"])
         }
     }

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 13.0.0-dev.2
+version = 14.2.1-dev.1

gradle/libs.versions.toml

@@ -0,0 +1,21 @@
+[versions]
+android = "4.1.1.4"
+kotlin-reflect = "1.9.0"
+apktool-lib = "2.8.2-6"
+kotlin-test = "1.8.20-RC"
+kotlinx-coroutines-core = "1.7.1"
+multidexlib2 = "3.0.3.r2"
+shadow = "8.1.1"
+smali = "3.0.3"
+xpp3 = "1.1.4c"
+
+
+[libraries]
+android = { module = "com.google.android:android", version.ref = "android" }
+kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin-reflect" }
+apktool-lib = { module = "app.revanced:apktool-lib", version.ref = "apktool-lib" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-test" }
+kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" }
+multidexlib2 = { module = "app.revanced:multidexlib2", version.ref = "multidexlib2" }
+smali = { module = "com.android.tools.smali:smali", version.ref = "smali" }
+xpp3 = { module = "xpp3:xpp3", version.ref = "xpp3" }

settings.gradle.kts

@@ -1 +1,22 @@
+val githubUsername: String = providers.gradleProperty("gpr.user").orNull ?: System.getenv("GITHUB_ACTOR")
+val githubPassword: String = providers.gradleProperty("gpr.key").orNull ?: System.getenv("GITHUB_TOKEN")
+
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        mavenCentral()
+        google()
+        mavenLocal()
+        listOf("multidexlib2", "apktool").forEach { repo ->
+            maven {
+                url = uri("https://maven.pkg.github.com/revanced/$repo")
+                credentials {
+                    username = githubUsername
+                    password = githubPassword
+                }
+            }
+        }
+    }
+}
+
 rootProject.name = "revanced-patcher"

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

@@ -0,0 +1,8 @@
+package app.revanced.patcher
+
+import java.io.File
+
+@FunctionalInterface
+interface IntegrationsConsumer {
+    fun acceptIntegrations(integrations: List<File>)
+}

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

@@ -1,15 +1,14 @@
-package app.revanced.patcher.data
+package app.revanced.patcher
 
 import brut.androlib.apk.ApkInfo
 
 /**
  * Metadata about a package.
  */
-class PackageMetadata {
+class PackageMetadata internal constructor(internal val apkInfo: ApkInfo) {
     lateinit var packageName: String
         internal set
+
     lateinit var packageVersion: String
         internal set
-
-    internal lateinit var apkInfo: ApkInfo
 }

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

@@ -0,0 +1,74 @@
+@file:Suppress("unused")
+
+package app.revanced.patcher
+
+import app.revanced.patcher.extensions.AnnotationExtensions.findAnnotationRecursively
+import app.revanced.patcher.extensions.PatchExtensions.patchName
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.PatchClass
+import dalvik.system.DexClassLoader
+import lanchon.multidexlib2.BasicDexFileNamer
+import lanchon.multidexlib2.MultiDexIO
+import java.io.File
+import java.net.URLClassLoader
+import java.util.jar.JarFile
+
+/**
+ * A patch bundle.
+ *
+ * @param fromClasses The classes to get [Patch]es from.
+ */
+sealed class PatchBundleLoader private constructor(
+    fromClasses: Iterable<Class<*>>
+) : MutableList<PatchClass> by mutableListOf() {
+    init {
+        fromClasses.filter {
+            if (it.isAnnotation) return@filter false
+
+            it.findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class) != null
+        }.map {
+            @Suppress("UNCHECKED_CAST")
+            it as PatchClass
+        }.sortedBy {
+            it.patchName
+        }.let { addAll(it) }
+    }
+
+    /**
+     * A [PatchBundleLoader] for JAR files.
+     *
+     * @param patchBundles The path to patch bundles of JAR format.
+     */
+    class Jar(vararg patchBundles: File) :
+        PatchBundleLoader(with(URLClassLoader(patchBundles.map { it.toURI().toURL() }.toTypedArray())) {
+            patchBundles.flatMap { patchBundle ->
+                // Get the names of all classes in the DEX file.
+
+                JarFile(patchBundle).entries().asSequence()
+                    .filter { it.name.endsWith(".class") }
+                    .map { it.name.replace('/', '.').replace(".class", "") }
+                    .map { loadClass(it) }
+            }
+        })
+
+    /**
+     * A [PatchBundleLoader] for [Dex] files.
+     *
+     * @param patchBundles The path to patch bundles of DEX format.
+     */
+    class Dex(vararg patchBundles: File) : PatchBundleLoader(with(
+        DexClassLoader(
+            patchBundles.joinToString(File.pathSeparator) { it.absolutePath },
+            null,
+            null,
+            PatchBundleLoader::class.java.classLoader
+        )
+    ) {
+        patchBundles
+            .flatMap {
+                MultiDexIO.readDexFile(true, it, BasicDexFileNamer(), null, null).classes
+            }
+            .map { classDef -> classDef.type.substring(1, classDef.length - 1) }
+            .map { loadClass(it) }
+    })
+}

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

@@ -0,0 +1,8 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.patch.PatchResult
+import kotlinx.coroutines.flow.Flow
+import java.util.function.Function
+
+@FunctionalInterface
+interface PatchExecutorFunction : Function<Boolean, Flow<PatchResult>>

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

@@ -1,64 +1,37 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.data.*
-import app.revanced.patcher.logging.Logger
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.Patch
-import app.revanced.patcher.util.ClassMerger.merge
-import com.android.tools.smali.dexlib2.iface.ClassDef
-import java.io.File
+import app.revanced.patcher.patch.PatchClass
+import brut.androlib.apk.ApkInfo
+import brut.directory.ExtFile
 
-data class PatcherContext(
-    val classes: MutableList<ClassDef>,
-    val resourceCacheDirectory: File,
-) {
-    val packageMetadata = PackageMetadata()
-    internal val patches = mutableListOf<Class<out Patch<Context>>>()
-    internal val integrations = Integrations(this)
-    internal val bytecodeContext = BytecodeContext(classes)
-    internal val resourceContext = ResourceContext(resourceCacheDirectory)
+/**
+ * A context for ReVanced [Patcher].
+ *
+ * @param options The [PatcherOptions] used to create this context.
+ */
+class PatcherContext internal constructor(options: PatcherOptions) {
+    /**
+     * [PackageMetadata] of the supplied [PatcherOptions.inputFile].
+     */
+    val packageMetadata = PackageMetadata(ApkInfo(ExtFile(options.inputFile)))
 
-    internal class Integrations(val context: PatcherContext) {
-        var callback: ((File) -> Unit)? = null
-        private val integrations: MutableList<File> = mutableListOf()
+    /**
+     * The list of [Patch]es to execute.
+     */
+    internal val patches = mutableListOf<PatchClass>()
 
-        fun add(integrations: List<File>) = this@Integrations.integrations.addAll(integrations)
+    /**
+     * The [ResourceContext] of this [PatcherContext].
+     * This holds the current state of the resources.
+     */
+    internal val resourceContext = ResourceContext(this, options)
 
-        /**
-         * Merge integrations.
-         * @param logger A logger.
-         */
-        fun merge(logger: Logger) {
-            with(context.bytecodeContext.classes) {
-                for (integrations in integrations) {
-                    callback?.let { it(integrations) }
-
-                    for (classDef in lanchon.multidexlib2.MultiDexIO.readDexFile(
-                        true,
-                        integrations,
-                        NAMER,
-                        null,
-                        null
-                    ).classes) {
-                        val type = classDef.type
-
-                        val result = classes.findIndexed { it.type == type }
-                        if (result == null) {
-                            logger.trace("Merging type $type")
-                            classes.add(classDef)
-                            continue
-                        }
-
-                        val (existingClass, existingClassIndex) = result
-
-                        logger.trace("Type $type exists. Adding missing methods and fields.")
-
-                        existingClass.merge(classDef, context, logger).let { mergedClass ->
-                            if (mergedClass !== existingClass) // referential equality check
-                                classes[existingClassIndex] = mergedClass
-                        }
-                    }
-                }
-            }
-        }
-    }
+    /**
+     * The [BytecodeContext] of this [PatcherContext].
+     * This holds the current state of the bytecode.
+     */
+    internal val bytecodeContext = BytecodeContext(options)
 }

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

@@ -1,30 +1,71 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.logging.Logger
+import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.logging.impl.NopLogger
+import brut.androlib.Config
 import java.io.File
+import java.util.logging.Logger
 
 /**
- * Options for the [Patcher].
- * @param inputFile The input file (usually an apk file).
- * @param resourceCacheDirectory Directory to cache resources.
- * @param aaptPath Optional path to a custom aapt binary.
- * @param frameworkDirectory Optional path to a custom framework directory.
- * @param logger Custom logger implementation for the [Patcher].
+ * Options for ReVanced [Patcher].
+ * @param inputFile The input file to patch.
+ * @param resourceCachePath The path to the directory to use for caching resources.
+ * @param aaptBinaryPath The path to a custom aapt binary.
+ * @param frameworkFileDirectory The path to the directory to cache the framework file in.
+ * @param unusedLogger The logger to use for logging.
  */
-data class PatcherOptions(
+data class PatcherOptions
+@Deprecated("Use the constructor without the logger parameter instead")
+constructor(
     internal val inputFile: File,
-    internal val resourceCacheDirectory: String,
-    internal val aaptPath: String? = null,
-    internal val frameworkDirectory: String? = null,
-    internal val logger: Logger = NopLogger
+    internal val resourceCachePath: File = File("revanced-resource-cache"),
+    internal val aaptBinaryPath: String? = null,
+    internal val frameworkFileDirectory: String? = null,
+    internal val unusedLogger: app.revanced.patcher.logging.Logger = NopLogger
 ) {
-    fun recreateResourceCacheDirectory() = File(resourceCacheDirectory).also {
+    private val logger = Logger.getLogger(PatcherOptions::class.java.name)
+
+    /**
+     * The mode to use for resource decoding.
+     * @see ResourceContext.ResourceDecodingMode
+     */
+    internal var resourceDecodingMode = ResourceContext.ResourceDecodingMode.MANIFEST_ONLY
+
+    /**
+     * The configuration to use for resource decoding and compiling.
+     */
+    internal val resourceConfig = Config.getDefaultConfig().apply {
+        useAapt2 = true
+        aaptPath = aaptBinaryPath ?: ""
+        frameworkDirectory = frameworkFileDirectory
+    }
+
+    /**
+     * Options for ReVanced [Patcher].
+     * @param inputFile The input file to patch.
+     * @param resourceCachePath The path to the directory to use for caching resources.
+     * @param aaptBinaryPath The path to a custom aapt binary.
+     * @param frameworkFileDirectory The path to the directory to cache the framework file in.
+     */
+    constructor(
+        inputFile: File,
+        resourceCachePath: File = File("revanced-resource-cache"),
+        aaptBinaryPath: String? = null,
+        frameworkFileDirectory: String? = null,
+    ) : this(
+        inputFile,
+        resourceCachePath,
+        aaptBinaryPath,
+        frameworkFileDirectory,
+        NopLogger
+    )
+
+    fun recreateResourceCacheDirectory() = resourceCachePath.also {
         if (it.exists()) {
             logger.info("Deleting existing resource cache directory")
 
             if (!it.deleteRecursively())
-                logger.error("Failed to delete existing resource cache directory")
+                logger.severe("Failed to delete existing resource cache directory")
         }
 
         it.mkdirs()

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

@@ -1,16 +1,23 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.util.dex.DexFile
 import java.io.File
+import java.io.InputStream
 
 /**
  * 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.
+ * @param doNotCompress List of relative paths of files to exclude from compressing.
  */
 data class PatcherResult(
-    val dexFiles: List<DexFile>,
-    val doNotCompress: List<String>? = null,
-    val resourceFile: File?
-)
+    val dexFiles: List<PatchedDexFile>,
+    val resourceFile: File?,
+    val doNotCompress: List<String>? = null
+) {
+    /**
+     * Wrapper for dex files.
+     * @param name The original name of the dex file.
+     * @param stream The dex file as [InputStream].
+     */
+    class PatchedDexFile(val name: String, val stream: InputStream)
+}

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

@@ -0,0 +1,8 @@
+package app.revanced.patcher
+
+import app.revanced.patcher.patch.PatchClass
+
+@FunctionalInterface
+interface PatchesConsumer {
+    fun acceptPatches(patches: List<PatchClass>)
+}

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

@@ -18,15 +18,4 @@ annotation class Name(
 @Target(AnnotationTarget.CLASS)
 annotation class Description(
     val description: String,
-)
-
-
-/**
- * Annotation to version a [Patch].
- * @param version The version of a [Patch].
- */
-@Target(AnnotationTarget.CLASS)
-@Deprecated("This annotation is deprecated and will be removed in a future release.")
-annotation class Version(
-    val version: String,
-)
+)

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

@@ -0,0 +1,158 @@
+package app.revanced.patcher.data
+
+import app.revanced.patcher.PatcherContext
+import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.PatcherResult
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.annotations.RequiresIntegrations
+import app.revanced.patcher.util.ClassMerger.merge
+import app.revanced.patcher.util.ProxyClassList
+import app.revanced.patcher.util.method.MethodWalker
+import app.revanced.patcher.util.proxy.ClassProxy
+import com.android.tools.smali.dexlib2.Opcodes
+import com.android.tools.smali.dexlib2.iface.ClassDef
+import com.android.tools.smali.dexlib2.iface.DexFile
+import com.android.tools.smali.dexlib2.iface.Method
+import com.android.tools.smali.dexlib2.writer.io.MemoryDataStore
+import lanchon.multidexlib2.BasicDexFileNamer
+import lanchon.multidexlib2.DexIO
+import lanchon.multidexlib2.MultiDexIO
+import java.io.File
+import java.io.Flushable
+import java.util.logging.Logger
+
+/**
+ * A context for bytecode.
+ * This holds the current state of the bytecode.
+ *
+ * @param options The [PatcherOptions] used to create this context.
+ */
+class BytecodeContext internal constructor(private val options: PatcherOptions) :
+    Context<List<PatcherResult.PatchedDexFile>> {
+    private val logger = Logger.getLogger(BytecodeContext::class.java.name)
+
+    /**
+     * [Opcodes] of the supplied [PatcherOptions.inputFile].
+     */
+    internal lateinit var opcodes: Opcodes
+
+    /**
+     * The list of classes.
+     */
+    val classes by lazy {
+        ProxyClassList(
+            MultiDexIO.readDexFile(
+                true, options.inputFile, BasicDexFileNamer(), null, null
+            ).also { opcodes = it.opcodes }.classes.toMutableSet()
+        )
+    }
+
+    /**
+     * The [Integrations] of this [PatcherContext].
+     */
+    internal val integrations = Integrations()
+
+    /**
+     * Find a class by a given class name.
+     *
+     * @param className The name of the class.
+     * @return A proxy for the first class that matches the class name.
+     */
+    fun findClass(className: String) = findClass { it.type.contains(className) }
+
+    /**
+     * Find a class by a given predicate.
+     *
+     * @param predicate A predicate to match the class.
+     * @return A proxy for the first class that matches the predicate.
+     */
+    fun findClass(predicate: (ClassDef) -> Boolean) =
+        // if we already proxied the class matching the predicate...
+        classes.proxies.firstOrNull { predicate(it.immutableClass) } ?:
+        // else resolve the class to a proxy and return it, if the predicate is matching a class
+        classes.find(predicate)?.let { proxy(it) }
+
+    /**
+     * Proxy a class.
+     * This will allow the class to be modified.
+     *
+     * @param classDef The class to proxy.
+     * @return A proxy for the class.
+     */
+    fun proxy(classDef: ClassDef) = this.classes.proxies.find { it.immutableClass.type == classDef.type } ?: let {
+        ClassProxy(classDef).also { this.classes.add(it) }
+    }
+
+    /**
+     * Create a [MethodWalker] instance for the current [BytecodeContext].
+     *
+     * @param startMethod The method to start at.
+     * @return A [MethodWalker] instance.
+     */
+    fun toMethodWalker(startMethod: Method) = MethodWalker(this, startMethod)
+
+    /**
+     * The integrations of a [PatcherContext].
+     */
+    internal inner class Integrations : MutableList<File> by mutableListOf(), Flushable {
+        /**
+         * Whether to merge integrations.
+         * True when any supplied [Patch] is annotated with [RequiresIntegrations].
+         */
+        var merge = false
+
+        /**
+         * Merge integrations into the [BytecodeContext] and flush all [Integrations].
+         */
+        override fun flush() {
+            if (!merge) return
+
+            logger.info("Merging integrations")
+
+            // TODO: Multi-thread this.
+            this@Integrations.forEach { integrations ->
+                MultiDexIO.readDexFile(
+                    true,
+                    integrations, BasicDexFileNamer(),
+                    null,
+                    null
+                ).classes.forEach classDef@{ classDef ->
+                    val existingClass = classes.find { it.type == classDef.type } ?: run {
+                        logger.fine("Merging $classDef")
+                        classes.add(classDef)
+                        return@classDef
+                    }
+
+                    logger.fine("$classDef exists. Adding missing methods and fields.")
+
+                    existingClass.merge(classDef, this@BytecodeContext).let { mergedClass ->
+                        // If the class was merged, replace the original class with the merged class.
+                        if (mergedClass === existingClass) return@let
+                        classes.apply { remove(existingClass); add(mergedClass) }
+                    }
+                }
+            }
+
+            clear()
+        }
+    }
+
+    /**
+     * Compile bytecode from the [BytecodeContext].
+     *
+     * @return The compiled bytecode.
+     */
+    override fun get(): List<PatcherResult.PatchedDexFile> {
+        logger.info("Compiling modified dex files")
+
+        return mutableMapOf<String, MemoryDataStore>().apply {
+            MultiDexIO.writeDexFile(
+                true, -1, // Defaults to amount of available cores.
+                this, BasicDexFileNamer(), object : DexFile {
+                    override fun getClasses() = this@BytecodeContext.classes.also(ProxyClassList::replaceClasses)
+                    override fun getOpcodes() = this@BytecodeContext.opcodes
+                }, DexIO.DEFAULT_MAX_DEX_POOL_SIZE, null
+            )
+        }.map { PatcherResult.PatchedDexFile(it.key, it.value.readAt(0)) }
+    }
+}

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

@@ -1,170 +1,9 @@
 package app.revanced.patcher.data
 
-import app.revanced.patcher.util.ProxyBackedClassList
-import app.revanced.patcher.util.method.MethodWalker
-import com.android.tools.smali.dexlib2.iface.ClassDef
-import com.android.tools.smali.dexlib2.iface.Method
-import org.w3c.dom.Document
-import java.io.Closeable
-import java.io.File
-import java.io.InputStream
-import java.io.OutputStream
-import javax.xml.parsers.DocumentBuilderFactory
-import javax.xml.transform.TransformerFactory
-import javax.xml.transform.dom.DOMSource
-import javax.xml.transform.stream.StreamResult
+import java.util.function.Supplier
 
 /**
- * A common interface to constrain [Context] to [BytecodeContext] and [ResourceContext].
+ * A common interface for contexts such as [ResourceContext] and [BytecodeContext].
  */
 
-sealed interface Context
-
-class BytecodeContext internal constructor(classes: MutableList<ClassDef>) : Context {
-    /**
-     * The list of classes.
-     */
-    val classes = ProxyBackedClassList(classes)
-
-    /**
-     * Find a class by a given class name.
-     *
-     * @param className The name of the class.
-     * @return A proxy for the first class that matches the class name.
-     */
-    fun findClass(className: String) = findClass { it.type.contains(className) }
-
-    /**
-     * Find a class by a given predicate.
-     *
-     * @param predicate A predicate to match the class.
-     * @return A proxy for the first class that matches the predicate.
-     */
-    fun findClass(predicate: (ClassDef) -> Boolean) =
-        // if we already proxied the class matching the predicate...
-        classes.proxies.firstOrNull { predicate(it.immutableClass) } ?:
-        // else resolve the class to a proxy and return it, if the predicate is matching a class
-        classes.find(predicate)?.let { proxy(it) }
-
-    fun proxy(classDef: ClassDef): app.revanced.patcher.util.proxy.ClassProxy {
-        var proxy = this.classes.proxies.find { it.immutableClass.type == classDef.type }
-        if (proxy == null) {
-            proxy = app.revanced.patcher.util.proxy.ClassProxy(classDef)
-            this.classes.add(proxy)
-        }
-        return proxy
-    }
-}
-
-/**
- * Create a [MethodWalker] instance for the current [BytecodeContext].
- *
- * @param startMethod The method to start at.
- * @return A [MethodWalker] instance.
- */
-fun BytecodeContext.toMethodWalker(startMethod: Method): MethodWalker {
-    return MethodWalker(this, startMethod)
-}
-
-internal inline fun <T> Iterable<T>.findIndexed(predicate: (T) -> Boolean): Pair<T, Int>? {
-    for ((index, element) in this.withIndex()) {
-        if (predicate(element)) {
-            return element to index
-        }
-    }
-    return null
-}
-
-class ResourceContext internal constructor(private val resourceCacheDirectory: File) : Context, Iterable<File> {
-    val xmlEditor = XmlFileHolder()
-
-    operator fun get(path: String) = resourceCacheDirectory.resolve(path)
-
-    override fun iterator() = resourceCacheDirectory.walkTopDown().iterator()
-
-    inner class XmlFileHolder {
-        operator fun get(inputStream: InputStream) =
-            DomFileEditor(inputStream)
-
-        operator fun get(path: String): DomFileEditor {
-            return DomFileEditor(this@ResourceContext[path])
-        }
-
-    }
-}
-
-/**
- * Wrapper for a file that can be edited as a dom document.
- *
- * This constructor does not check for locks to the file when writing.
- * Use the secondary constructor.
- *
- * @param inputStream the input stream to read the xml file from.
- * @param outputStream the output stream to write the xml file to. If null, the file will be read only.
- *
- */
-class DomFileEditor internal constructor(
-    private val inputStream: InputStream,
-    private val outputStream: Lazy<OutputStream>? = null,
-) : Closeable {
-    // path to the xml file to unlock the resource when closing the editor
-    private var filePath: String? = null
-    private var closed: Boolean = false
-
-    /**
-     * The document of the xml file
-     */
-    val file: Document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(inputStream)
-        .also(Document::normalize)
-
-
-    // lazily open an output stream
-    // this is required because when constructing a DomFileEditor the output stream is created along with the input stream, which is not allowed
-    // the workaround is to lazily create the output stream. This way it would be used after the input stream is closed, which happens in the constructor
-    constructor(file: File) : this(file.inputStream(), lazy { file.outputStream() }) {
-        // increase the lock
-        locks.merge(file.path, 1, Integer::sum)
-        filePath = file.path
-    }
-
-    /**
-     * Closes the editor. Write backs and decreases the lock count.
-     *
-     * Will not write back to the file if the file is still locked.
-     */
-    override fun close() {
-        if (closed) return
-
-        inputStream.close()
-
-        // if the output stream is not null, do not close it
-        outputStream?.let {
-            // prevent writing to same file, if it is being locked
-            // isLocked will be false if the editor was created through a stream
-            val isLocked = filePath?.let { path ->
-                val isLocked = locks[path]!! > 1
-                // decrease the lock count if the editor was opened for a file
-                locks.merge(path, -1, Integer::sum)
-                isLocked
-            } ?: false
-
-            // if unlocked, write back to the file
-            if (!isLocked) {
-                it.value.use { stream ->
-                    val result = StreamResult(stream)
-                    TransformerFactory.newInstance().newTransformer().transform(DOMSource(file), result)
-                }
-
-                it.value.close()
-                return
-            }
-        }
-
-        closed = true
-    }
-
-    private companion object {
-        // map of concurrent open files
-        val locks = mutableMapOf<String, Int>()
-    }
-}
+sealed interface Context<T> : Supplier<T>

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

@@ -0,0 +1,170 @@
+package app.revanced.patcher.data
+
+import app.revanced.patcher.PatcherContext
+import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.util.DomFileEditor
+import brut.androlib.AaptInvoker
+import brut.androlib.ApkDecoder
+import brut.androlib.apk.UsesFramework
+import brut.androlib.res.Framework
+import brut.androlib.res.ResourcesDecoder
+import brut.androlib.res.decoder.AndroidManifestResourceParser
+import brut.androlib.res.decoder.XmlPullStreamDecoder
+import brut.androlib.res.xml.ResXmlPatcher
+import brut.directory.ExtFile
+import java.io.File
+import java.io.InputStream
+import java.io.OutputStream
+import java.nio.file.Files
+import java.util.logging.Logger
+
+/**
+ * A context for resources.
+ * This holds the current state of the resources.
+ *
+ * @param context The [PatcherContext] to create the context for.
+ */
+class ResourceContext internal constructor(
+    private val context: PatcherContext,
+    private val options: PatcherOptions
+) : Context<File?>, Iterable<File> {
+    private val logger = Logger.getLogger(ResourceContext::class.java.name)
+
+    val xmlEditor = XmlFileHolder()
+
+    /**
+     * Decode resources for the patcher.
+     *
+     * @param mode The [ResourceDecodingMode] to use when decoding.
+     */
+    internal fun decodeResources(mode: ResourceDecodingMode) = with(context.packageMetadata.apkInfo) {
+        // Needed to decode resources.
+        val resourcesDecoder = ResourcesDecoder(options.resourceConfig, this)
+
+        when (mode) {
+            ResourceDecodingMode.FULL -> {
+                val outDir = options.recreateResourceCacheDirectory()
+
+                logger.info("Decoding resources")
+
+                resourcesDecoder.decodeResources(outDir)
+                resourcesDecoder.decodeManifest(outDir)
+
+                // Needed to record uncompressed files.
+                val apkDecoder = ApkDecoder(options.resourceConfig, this)
+                apkDecoder.recordUncompressedFiles(resourcesDecoder.resFileMapping)
+
+                usesFramework = UsesFramework().apply {
+                    ids = resourcesDecoder.resTable.listFramePackages().map { it.id }
+                }
+            }
+
+            ResourceDecodingMode.MANIFEST_ONLY -> {
+                logger.info("Decoding app manifest")
+
+                // Decode manually instead of using resourceDecoder.decodeManifest
+                // because it does not support decoding to an OutputStream.
+                XmlPullStreamDecoder(
+                    AndroidManifestResourceParser(resourcesDecoder.resTable),
+                    resourcesDecoder.resXmlSerializer
+                ).decodeManifest(
+                    apkFile.directory.getFileInput("AndroidManifest.xml"),
+                    // Older Android versions do not support OutputStream.nullOutputStream()
+                    object : OutputStream() {
+                        override fun write(b: Int) { /* do nothing */
+                        }
+                    }
+                )
+
+                // Get the package name and version from the manifest using the XmlPullStreamDecoder.
+                // XmlPullStreamDecoder.decodeManifest() sets metadata.apkInfo.
+                context.packageMetadata.let { metadata ->
+                    metadata.packageName = resourcesDecoder.resTable.packageRenamed
+                    versionInfo.let {
+                        metadata.packageVersion = it.versionName ?: it.versionCode
+                    }
+
+                    /*
+                     The ResTable if flagged as sparse if the main package is not loaded, which is the case here,
+                     because ResourcesDecoder.decodeResources loads the main package
+                     and not XmlPullStreamDecoder.decodeManifest.
+                     See ARSCDecoder.readTableType for more info.
+
+                     Set this to false again to prevent the ResTable from being flagged as sparse falsely.
+                     */
+                    metadata.apkInfo.sparseResources = false
+                }
+            }
+        }
+
+    }
+
+    operator fun get(path: String) = options.resourceCachePath.resolve(path)
+
+    override fun iterator() = options.resourceCachePath.walkTopDown().iterator()
+
+
+    /**
+     * Compile resources from the [ResourceContext].
+     *
+     * @return The compiled resources.
+     */
+    override fun get(): File? {
+        var resourceFile: File? = null
+
+        if (options.resourceDecodingMode == ResourceDecodingMode.FULL) {
+            logger.info("Compiling modified resources")
+
+            val cacheDirectory = ExtFile(options.resourceCachePath)
+            val aaptFile = cacheDirectory.resolve("aapt_temp_file").also {
+                Files.deleteIfExists(it.toPath())
+            }.also { resourceFile = it }
+
+            try {
+                AaptInvoker(
+                    options.resourceConfig, context.packageMetadata.apkInfo
+                ).invokeAapt(aaptFile,
+                    cacheDirectory.resolve("AndroidManifest.xml").also {
+                        ResXmlPatcher.fixingPublicAttrsInProviderAttributes(it)
+                    },
+                    cacheDirectory.resolve("res"),
+                    null,
+                    null,
+                    context.packageMetadata.apkInfo.usesFramework.let { usesFramework ->
+                        usesFramework.ids.map { id ->
+                            Framework(options.resourceConfig).getFrameworkApk(id, usesFramework.tag)
+                        }.toTypedArray()
+                    })
+            } finally {
+                cacheDirectory.close()
+            }
+        }
+
+        return resourceFile
+    }
+
+    /**
+     * The type of decoding the resources.
+     */
+    internal enum class ResourceDecodingMode {
+        /**
+         * Decode all resources.
+         */
+        FULL,
+
+        /**
+         * Decode the manifest file only.
+         */
+        MANIFEST_ONLY,
+    }
+
+    inner class XmlFileHolder {
+        operator fun get(inputStream: InputStream) =
+            DomFileEditor(inputStream)
+
+        operator fun get(path: String): DomFileEditor {
+            return DomFileEditor(this@ResourceContext[path])
+        }
+
+    }
+}

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

@@ -22,8 +22,7 @@ object InstructionExtensions {
     fun MutableMethodImplementation.addInstructions(
         index: Int,
         instructions: List<BuilderInstruction>
-    ) =
-        instructions.asReversed().forEach { addInstruction(index, it) }
+    ) = instructions.asReversed().forEach { addInstruction(index, it) }
 
     /**
      * Add instructions to a method.

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

@@ -3,11 +3,10 @@ package app.revanced.patcher.extensions
 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.Context
 import app.revanced.patcher.extensions.AnnotationExtensions.findAnnotationRecursively
 import app.revanced.patcher.patch.OptionsContainer
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.PatchClass
 import app.revanced.patcher.patch.PatchOptions
 import app.revanced.patcher.patch.annotations.DependsOn
 import app.revanced.patcher.patch.annotations.RequiresIntegrations
@@ -19,50 +18,43 @@ object PatchExtensions {
     /**
      * The name of a [Patch].
      */
-    val Class<out Patch<Context>>.patchName: String
+    val PatchClass.patchName: String
         get() = findAnnotationRecursively(Name::class)?.name ?: this.simpleName
 
-    /**
-     * The version of a [Patch].
-     */
-    @Deprecated("This property is deprecated and will be removed in a future release.")
-    val Class<out Patch<Context>>.version
-        get() = findAnnotationRecursively(Version::class)?.version
-
     /**
      * Weather or not a [Patch] should be included.
      */
-    val Class<out Patch<Context>>.include
+    val PatchClass.include
         get() = findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class)!!.include
 
     /**
      * The description of a [Patch].
      */
-    val Class<out Patch<Context>>.description
+    val PatchClass.description
         get() = findAnnotationRecursively(Description::class)?.description
 
     /**
      * The dependencies of a [Patch].
      */
-    val Class<out Patch<Context>>.dependencies
+    val PatchClass.dependencies
         get() = findAnnotationRecursively(DependsOn::class)?.dependencies
 
     /**
      * The packages a [Patch] is compatible with.
      */
-    val Class<out Patch<Context>>.compatiblePackages
+    val PatchClass.compatiblePackages
         get() = findAnnotationRecursively(Compatibility::class)?.compatiblePackages
 
     /**
      * Weather or not a [Patch] requires integrations.
      */
-    internal val Class<out Patch<Context>>.requiresIntegrations
+    internal val PatchClass.requiresIntegrations
         get() = findAnnotationRecursively(RequiresIntegrations::class) != null
 
     /**
      * The options of a [Patch].
      */
-    val Class<out Patch<Context>>.options: PatchOptions?
+    val PatchClass.options: PatchOptions?
         get() = kotlin.companionObject?.let { cl ->
             if (cl.visibility != KVisibility.PUBLIC) return null
             kotlin.companionObjectInstance?.let {

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

@@ -4,7 +4,7 @@ import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.extensions.MethodFingerprintExtensions.fuzzyPatternScanMethod
 import app.revanced.patcher.fingerprint.Fingerprint
 import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.patch.PatchResultError
+import app.revanced.patcher.patch.PatchException
 import app.revanced.patcher.util.proxy.ClassProxy
 import com.android.tools.smali.dexlib2.AccessFlags
 import com.android.tools.smali.dexlib2.Opcode
@@ -99,9 +99,9 @@ abstract class MethodFingerprint(
                 methodClassPairs!!.add(methodClassPair)
             }
 
-            if (methods.isNotEmpty()) MethodFingerprint.clearFingerprintResolutionLookupMaps()
+            if (methods.isNotEmpty()) clearFingerprintResolutionLookupMaps()
 
-            context.classes.classes.forEach { classDef ->
+            context.classes.forEach { classDef ->
                 classDef.methods.forEach { method ->
                     val methodClassPair = method to classDef
 
@@ -160,7 +160,7 @@ abstract class MethodFingerprint(
          * - Fastest: Specify [strings], with at least one string being an exact (non-partial) match.
          */
         internal fun Iterable<MethodFingerprint>.resolveUsingLookupMap(context: BytecodeContext) {
-            if (methods.isEmpty()) throw PatchResultError("lookup map not initialized")
+            if (methods.isEmpty()) throw PatchException("lookup map not initialized")
 
             for (fingerprint in this) {
                 fingerprint.resolveUsingLookupMap(context)

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

@@ -1,5 +1,6 @@
 package app.revanced.patcher.logging
 
+@Deprecated("This will be removed in a future release")
 interface Logger {
     fun error(msg: String) {}
     fun warn(msg: String) {}

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

@@ -2,4 +2,5 @@ package app.revanced.patcher.logging.impl
 
 import app.revanced.patcher.logging.Logger
 
+@Deprecated("This will be removed in a future release")
 object NopLogger : Logger

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

@@ -6,20 +6,22 @@ import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
 import java.io.Closeable
 
+typealias PatchClass = Class<out Patch<Context<*>>>
+
 /**
  * A ReVanced patch.
  *
  * If it implements [Closeable], it will be closed after all patches have been executed.
  * Closing will be done in reverse execution order.
  */
-sealed interface Patch<out T : Context> {
+sealed interface Patch<out T : Context<*>> {
     /**
      * The main function of the [Patch] which the patcher will call.
      *
      * @param context The [Context] the patch will work on.
      * @return The result of executing the patch.
      */
-    fun execute(context: @UnsafeVariance T): PatchResult
+    fun execute(context: @UnsafeVariance T)
 }
 
 /**

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

@@ -0,0 +1,12 @@
+package app.revanced.patcher.patch
+
+/**
+ * An exception thrown when patching.
+ *
+ * @param errorMessage The exception message.
+ * @param cause The corresponding [Throwable].
+ */
+class PatchException(errorMessage: String?, cause: Throwable?) : Exception(errorMessage, cause) {
+    constructor(errorMessage: String) : this(errorMessage, null)
+    constructor(cause: Throwable) : this(cause.message, cause)
+}

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

@@ -1,35 +1,10 @@
 package app.revanced.patcher.patch
 
-interface PatchResult {
-    fun error(): PatchResultError? {
-        if (this is PatchResultError) {
-            return this
-        }
-        return null
-    }
-
-    fun success(): PatchResultSuccess? {
-        if (this is PatchResultSuccess) {
-            return this
-        }
-        return null
-    }
-
-    fun isError(): Boolean {
-        return this is PatchResultError
-    }
-
-    fun isSuccess(): Boolean {
-        return this is PatchResultSuccess
-    }
-}
-
-class PatchResultError(
-    errorMessage: String?, cause: Exception?
-) : Exception(errorMessage, cause), PatchResult {
-    constructor(errorMessage: String) : this(errorMessage, null)
-    constructor(cause: Exception) : this(cause.message, cause)
-
-}
-
-class PatchResultSuccess : PatchResult
+/**
+ * A result of executing a [Patch].
+ *
+ * @param patchName The name of the [Patch].
+ * @param exception The [PatchException] thrown, if any.
+ */
+@Suppress("MemberVisibilityCanBePrivate")
+class PatchResult internal constructor(val patchName: String, val exception: PatchException? = null)

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

@@ -16,12 +16,12 @@ annotation class Patch(val include: Boolean = true)
  */
 @Target(AnnotationTarget.CLASS)
 annotation class DependsOn(
-    val dependencies: Array<KClass<out Patch<Context>>> = []
+    val dependencies: Array<KClass<out Patch<Context<*>>>> = []
 )
 
-
+// TODO: Remove this annotation, once integrations are coupled with patches.
 /**
  * Annotation to mark [Patch]es which depend on integrations.
  */
 @Target(AnnotationTarget.CLASS)
-annotation class RequiresIntegrations // required because integrations are decoupled from patches
+annotation class RequiresIntegrations

src/main/kotlin/app/revanced/patcher/util/ClassMerger.kt

@@ -1,14 +1,13 @@
 package app.revanced.patcher.util
 
-import app.revanced.patcher.PatcherContext
+import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.extensions.or
-import app.revanced.patcher.logging.Logger
 import app.revanced.patcher.util.ClassMerger.Utils.asMutableClass
 import app.revanced.patcher.util.ClassMerger.Utils.filterAny
 import app.revanced.patcher.util.ClassMerger.Utils.filterNotAny
 import app.revanced.patcher.util.ClassMerger.Utils.isPublic
 import app.revanced.patcher.util.ClassMerger.Utils.toPublic
-import app.revanced.patcher.util.TypeUtil.traverseClassHierarchy
+import app.revanced.patcher.util.ClassMerger.Utils.traverseClassHierarchy
 import app.revanced.patcher.util.proxy.mutableTypes.MutableClass
 import app.revanced.patcher.util.proxy.mutableTypes.MutableClass.Companion.toMutable
 import app.revanced.patcher.util.proxy.mutableTypes.MutableField
@@ -18,6 +17,7 @@ import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMu
 import com.android.tools.smali.dexlib2.AccessFlags
 import com.android.tools.smali.dexlib2.iface.ClassDef
 import com.android.tools.smali.dexlib2.util.MethodUtil
+import java.util.logging.Logger
 import kotlin.reflect.KFunction2
 
 /**
@@ -25,27 +25,28 @@ import kotlin.reflect.KFunction2
  * Note: This will not consider method implementations or if the class is missing a superclass or interfaces.
  */
 internal object ClassMerger {
+    private val logger = Logger.getLogger(ClassMerger::class.java.name)
+
     /**
      * Merge a class with [otherClass].
      *
      * @param otherClass The class to merge with
      * @param context The context to traverse the class hierarchy in.
-     * @param logger A logger.
+     * @return The merged class or the original class if no merge was needed.
      */
-    fun ClassDef.merge(otherClass: ClassDef, context: PatcherContext, logger: Logger? = null) = this
-        //.fixFieldAccess(otherClass, logger)
-        //.fixMethodAccess(otherClass, logger)
-        .addMissingFields(otherClass, logger)
-        .addMissingMethods(otherClass, logger)
-        .publicize(otherClass, context, logger)
+    fun ClassDef.merge(otherClass: ClassDef, context: BytecodeContext) = this
+        //.fixFieldAccess(otherClass)
+        //.fixMethodAccess(otherClass)
+        .addMissingFields(otherClass)
+        .addMissingMethods(otherClass)
+        .publicize(otherClass, context)
 
     /**
      * Add methods which are missing but existing in [fromClass].
      *
      * @param fromClass The class to add missing methods from.
-     * @param logger A logger.
      */
-    private fun ClassDef.addMissingMethods(fromClass: ClassDef, logger: Logger? = null): ClassDef {
+    private fun ClassDef.addMissingMethods(fromClass: ClassDef): ClassDef {
         val missingMethods = fromClass.methods.let { fromMethods ->
             methods.filterNot { method ->
                 fromMethods.any { fromMethod ->
@@ -56,7 +57,7 @@ internal object ClassMerger {
 
         if (missingMethods.isEmpty()) return this
 
-        logger?.trace("Found ${missingMethods.size} missing methods")
+        logger.fine("Found ${missingMethods.size} missing methods")
 
         return asMutableClass().apply {
             methods.addAll(missingMethods.map { it.toMutable() })
@@ -67,16 +68,15 @@ internal object ClassMerger {
      * Add fields which are missing but existing in [fromClass].
      *
      * @param fromClass The class to add missing fields from.
-     * @param logger A logger.
      */
-    private fun ClassDef.addMissingFields(fromClass: ClassDef, logger: Logger? = null): ClassDef {
+    private fun ClassDef.addMissingFields(fromClass: ClassDef): ClassDef {
         val missingFields = fields.filterNotAny(fromClass.fields) { field, fromField ->
             fromField.name == field.name
         }
 
         if (missingFields.isEmpty()) return this
 
-        logger?.trace("Found ${missingFields.size} missing fields")
+        logger.fine("Found ${missingFields.size} missing fields")
 
         return asMutableClass().apply {
             fields.addAll(missingFields.map { it.toMutable() })
@@ -87,15 +87,14 @@ internal object ClassMerger {
      * Make a class and its super class public recursively.
      * @param reference The class to check the [AccessFlags] of.
      * @param context The context to traverse the class hierarchy in.
-     * @param logger A logger.
      */
-    private fun ClassDef.publicize(reference: ClassDef, context: PatcherContext, logger: Logger? = null) =
+    private fun ClassDef.publicize(reference: ClassDef, context: BytecodeContext) =
         if (reference.accessFlags.isPublic() && !accessFlags.isPublic())
             this.asMutableClass().apply {
-                context.bytecodeContext.traverseClassHierarchy(this) {
+                context.traverseClassHierarchy(this) {
                     if (accessFlags.isPublic()) return@traverseClassHierarchy
 
-                    logger?.trace("Publicizing ${this.type}")
+                    logger.fine("Publicizing ${this.type}")
 
                     accessFlags = accessFlags.toPublic()
                 }
@@ -106,9 +105,8 @@ internal object ClassMerger {
      * Publicize fields if they are public in [reference].
      *
      * @param reference The class to check the [AccessFlags] of the fields in.
-     * @param logger A logger.
      */
-    private fun ClassDef.fixFieldAccess(reference: ClassDef, logger: Logger? = null): ClassDef {
+    private fun ClassDef.fixFieldAccess(reference: ClassDef): ClassDef {
         val brokenFields = fields.filterAny(reference.fields) { field, referenceField ->
             if (field.name != referenceField.name) return@filterAny false
 
@@ -117,7 +115,7 @@ internal object ClassMerger {
 
         if (brokenFields.isEmpty()) return this
 
-        logger?.trace("Found ${brokenFields.size} broken fields")
+        logger.fine("Found ${brokenFields.size} broken fields")
 
         /**
          * Make a field public.
@@ -135,9 +133,8 @@ internal object ClassMerger {
      * Publicize methods if they are public in [reference].
      *
      * @param reference The class to check the [AccessFlags] of the methods in.
-     * @param logger A logger.
      */
-    private fun ClassDef.fixMethodAccess(reference: ClassDef, logger: Logger? = null): ClassDef {
+    private fun ClassDef.fixMethodAccess(reference: ClassDef): ClassDef {
         val brokenMethods = methods.filterAny(reference.methods) { method, referenceMethod ->
             if (!MethodUtil.methodSignaturesMatch(method, referenceMethod)) return@filterAny false
 
@@ -146,7 +143,7 @@ internal object ClassMerger {
 
         if (brokenMethods.isEmpty()) return this
 
-        logger?.trace("Found ${brokenMethods.size} methods")
+        logger.fine("Found ${brokenMethods.size} methods")
 
         /**
          * Make a method public.
@@ -161,6 +158,19 @@ internal object ClassMerger {
     }
 
     private object Utils {
+        /**
+         * traverse the class hierarchy starting from the given root class
+         *
+         * @param targetClass the class to start traversing the class hierarchy from
+         * @param callback function that is called for every class in the hierarchy
+         */
+        fun BytecodeContext.traverseClassHierarchy(targetClass: MutableClass, callback: MutableClass.() -> Unit) {
+            callback(targetClass)
+            this.findClass(targetClass.superclass ?: return)?.mutableClass?.let {
+                traverseClassHierarchy(it, callback)
+            }
+        }
+
         fun ClassDef.asMutableClass() = if (this is MutableClass) this else this.toMutable()
 
         /**
@@ -180,7 +190,6 @@ internal object ClassMerger {
         /**
          * Filter [this] on [needles] matching the given [predicate].
          *
-         * @param this The hay to filter for [needles].
          * @param needles The needles to filter [this] with.
          * @param predicate The filter.
          * @return The [this] filtered on [needles] matching the given [predicate].
@@ -192,7 +201,6 @@ internal object ClassMerger {
         /**
          * Filter [this] on [needles] not matching the given [predicate].
          *
-         * @param this The hay to filter for [needles].
          * @param needles The needles to filter [this] with.
          * @param predicate The filter.
          * @return The [this] filtered on [needles] not matching the given [predicate].

src/main/kotlin/app/revanced/patcher/util/DomFileEditor.kt

@@ -0,0 +1,87 @@
+package app.revanced.patcher.util
+
+import org.w3c.dom.Document
+import java.io.Closeable
+import java.io.File
+import java.io.InputStream
+import java.io.OutputStream
+import javax.xml.parsers.DocumentBuilderFactory
+import javax.xml.transform.TransformerFactory
+import javax.xml.transform.dom.DOMSource
+import javax.xml.transform.stream.StreamResult
+
+/**
+ * Wrapper for a file that can be edited as a dom document.
+ *
+ * This constructor does not check for locks to the file when writing.
+ * Use the secondary constructor.
+ *
+ * @param inputStream the input stream to read the xml file from.
+ * @param outputStream the output stream to write the xml file to. If null, the file will be read only.
+ *
+ */
+class DomFileEditor internal constructor(
+    private val inputStream: InputStream,
+    private val outputStream: Lazy<OutputStream>? = null,
+) : Closeable {
+    // path to the xml file to unlock the resource when closing the editor
+    private var filePath: String? = null
+    private var closed: Boolean = false
+
+    /**
+     * The document of the xml file
+     */
+    val file: Document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(inputStream)
+        .also(Document::normalize)
+
+
+    // lazily open an output stream
+    // this is required because when constructing a DomFileEditor the output stream is created along with the input stream, which is not allowed
+    // the workaround is to lazily create the output stream. This way it would be used after the input stream is closed, which happens in the constructor
+    constructor(file: File) : this(file.inputStream(), lazy { file.outputStream() }) {
+        // increase the lock
+        locks.merge(file.path, 1, Integer::sum)
+        filePath = file.path
+    }
+
+    /**
+     * Closes the editor. Write backs and decreases the lock count.
+     *
+     * Will not write back to the file if the file is still locked.
+     */
+    override fun close() {
+        if (closed) return
+
+        inputStream.close()
+
+        // if the output stream is not null, do not close it
+        outputStream?.let {
+            // prevent writing to same file, if it is being locked
+            // isLocked will be false if the editor was created through a stream
+            val isLocked = filePath?.let { path ->
+                val isLocked = locks[path]!! > 1
+                // decrease the lock count if the editor was opened for a file
+                locks.merge(path, -1, Integer::sum)
+                isLocked
+            } ?: false
+
+            // if unlocked, write back to the file
+            if (!isLocked) {
+                it.value.use { stream ->
+                    val result = StreamResult(stream)
+                    TransformerFactory.newInstance().newTransformer().transform(DOMSource(file), result)
+                }
+
+                it.value.close()
+                return
+            }
+        }
+
+        closed = true
+    }
+
+    private companion object {
+        // map of concurrent open files
+        val locks = mutableMapOf<String, Int>()
+    }
+}

src/main/kotlin/app/revanced/patcher/util/ListBackedSet.kt

@@ -1,15 +0,0 @@
-package app.revanced.patcher.util
-
-internal class ListBackedSet<E>(private val list: MutableList<E>) : MutableSet<E> {
-    override val size get() = list.size
-    override fun add(element: E) = list.add(element)
-    override fun addAll(elements: Collection<E>) = list.addAll(elements)
-    override fun clear() = list.clear()
-    override fun iterator() = list.listIterator()
-    override fun remove(element: E) = list.remove(element)
-    override fun removeAll(elements: Collection<E>) = list.removeAll(elements)
-    override fun retainAll(elements: Collection<E>) = list.retainAll(elements)
-    override fun contains(element: E) = list.contains(element)
-    override fun containsAll(elements: Collection<E>) = list.containsAll(elements)
-    override fun isEmpty() = list.isEmpty()
-}

src/main/kotlin/app/revanced/patcher/util/ProxyBackedClassList.kt

@@ -1,46 +0,0 @@
-package app.revanced.patcher.util
-
-import app.revanced.patcher.util.proxy.ClassProxy
-import com.android.tools.smali.dexlib2.iface.ClassDef
-
-/**
- * A class that represents a set of classes and proxies.
- *
- * @param classes The classes to be backed by proxies.
- */
-class ProxyBackedClassList(internal val classes: MutableList<ClassDef>) : Set<ClassDef> {
-    internal val proxies = mutableListOf<ClassProxy>()
-
-    /**
-     * Add a [ClassDef].
-     */
-    fun add(classDef: ClassDef) = classes.add(classDef)
-
-    /**
-     * Add a [ClassProxy].
-     */
-    fun add(classProxy: ClassProxy) = proxies.add(classProxy)
-
-    /**
-     * Replace all classes with their mutated versions.
-     */
-    internal fun replaceClasses() =
-        proxies.removeIf { proxy ->
-            // if the proxy is unused, keep it in the list
-            if (!proxy.resolved) return@removeIf false
-
-            // if it has been used, replace the original class with the new class
-            val index = classes.indexOfFirst { it.type == proxy.immutableClass.type }
-            classes[index] = proxy.mutableClass
-
-            // return true to remove it from the proxies list
-            return@removeIf true
-        }
-
-
-    override val size get() = classes.size
-    override fun contains(element: ClassDef) = classes.contains(element)
-    override fun containsAll(elements: Collection<ClassDef>) = classes.containsAll(elements)
-    override fun isEmpty() = classes.isEmpty()
-    override fun iterator() = classes.iterator()
-}

src/main/kotlin/app/revanced/patcher/util/ProxyClassList.kt

@@ -0,0 +1,33 @@
+package app.revanced.patcher.util
+
+import app.revanced.patcher.util.proxy.ClassProxy
+import com.android.tools.smali.dexlib2.iface.ClassDef
+
+/**
+ * A class that represents a set of classes and proxies.
+ *
+ * @param classes The classes to be backed by proxies.
+ */
+class ProxyClassList internal constructor(classes: MutableSet<ClassDef>) : MutableSet<ClassDef> by classes {
+    internal val proxies = mutableListOf<ClassProxy>()
+
+    /**
+     * Add a [ClassProxy].
+     */
+    fun add(classProxy: ClassProxy) = proxies.add(classProxy)
+
+    /**
+     * Replace all classes with their mutated versions.
+     */
+    internal fun replaceClasses() = proxies.removeIf { proxy ->
+        // If the proxy is unused, return false to keep it in the proxies list.
+            if (!proxy.resolved) return@removeIf false
+
+        // If it has been used, replace the original class with the mutable class.
+        remove(proxy.immutableClass)
+        add(proxy.mutableClass)
+
+        // Return true to remove the proxy from the proxies list.
+            return@removeIf true
+        }
+}