diff --git a/KeepAnnotationsSample/.gitignore b/KeepAnnotationsSample/.gitignore new file mode 100644 index 00000000..aa724b77 --- /dev/null +++ b/KeepAnnotationsSample/.gitignore @@ -0,0 +1,15 @@ +*.iml +.gradle +/local.properties +/.idea/caches +/.idea/libraries +/.idea/modules.xml +/.idea/workspace.xml +/.idea/navEditor.xml +/.idea/assetWizardSettings.xml +.DS_Store +/build +/captures +.externalNativeBuild +.cxx +local.properties diff --git a/KeepAnnotationsSample/README.md b/KeepAnnotationsSample/README.md new file mode 100644 index 00000000..cf1daaa0 --- /dev/null +++ b/KeepAnnotationsSample/README.md @@ -0,0 +1,22 @@ +# KeepAnnotations Sample + +This examples shows the use of the `androidx.annotation.keep` Gradle plugin. + +- This programmatically generates `keep` rules when an `app` / `android library` / `java library` module uses `androidx.annotation:annotation-keep`. + + +## Testing + +```kotlin + +// For app modules + +./gradlew ExtractKeepRules + +// For android library modules + +./gradlew KeepRulesTransformAar + +``` + +The generated keep rules end up in `build/generated/variantName/androidx.annotation.keep.rules.pro`. diff --git a/KeepAnnotationsSample/app/.gitignore b/KeepAnnotationsSample/app/.gitignore new file mode 100644 index 00000000..42afabfd --- /dev/null +++ b/KeepAnnotationsSample/app/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/KeepAnnotationsSample/app/build.gradle.kts b/KeepAnnotationsSample/app/build.gradle.kts new file mode 100644 index 00000000..b04a94a6 --- /dev/null +++ b/KeepAnnotationsSample/app/build.gradle.kts @@ -0,0 +1,58 @@ +import kotlin.math.sign + +plugins { + alias(libs.plugins.android.application) + alias(libs.plugins.kotlin.compose) + alias(libs.plugins.androidx.annotation.keep) +} + +android { + namespace = "org.example" + compileSdk { + version = release(37) + } + + defaultConfig { + applicationId = "org.example" + minSdk = 24 + targetSdk = 37 + versionCode = 1 + versionName = "1.0" + + testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" + } + + buildTypes { + release { + optimization { + enable = true + } + signingConfig = signingConfigs.getByName("debug") + } + } + compileOptions { + sourceCompatibility = JavaVersion.VERSION_11 + targetCompatibility = JavaVersion.VERSION_11 + } + buildFeatures { + compose = true + } +} + +dependencies { + implementation(libs.androidx.annotation.keep) + implementation(platform(libs.androidx.compose.bom)) + implementation(libs.androidx.activity.compose) + implementation(libs.androidx.compose.material3) + implementation(libs.androidx.compose.ui) + implementation(libs.androidx.compose.ui.graphics) + implementation(libs.androidx.compose.ui.tooling.preview) + implementation(libs.androidx.core.ktx) + implementation(libs.androidx.lifecycle.runtime.ktx) + testImplementation(libs.junit) + androidTestImplementation(libs.androidx.compose.ui.test.junit4) + androidTestImplementation(libs.androidx.espresso.core) + androidTestImplementation(libs.androidx.junit) + debugImplementation(libs.androidx.compose.ui.test.manifest) + debugImplementation(libs.androidx.compose.ui.tooling) +} diff --git a/KeepAnnotationsSample/app/src/androidTest/java/org/example/ExampleInstrumentedTest.kt b/KeepAnnotationsSample/app/src/androidTest/java/org/example/ExampleInstrumentedTest.kt new file mode 100644 index 00000000..1e085ab6 --- /dev/null +++ b/KeepAnnotationsSample/app/src/androidTest/java/org/example/ExampleInstrumentedTest.kt @@ -0,0 +1,24 @@ +package org.example + +import androidx.test.platform.app.InstrumentationRegistry +import androidx.test.ext.junit.runners.AndroidJUnit4 + +import org.junit.Test +import org.junit.runner.RunWith + +import org.junit.Assert.* + +/** + * Instrumented test, which will execute on an Android device. + * + * See [testing documentation](http://d.android.com/tools/testing). + */ +@RunWith(AndroidJUnit4::class) +class ExampleInstrumentedTest { + @Test + fun useAppContext() { + // Context of the app under test. + val appContext = InstrumentationRegistry.getInstrumentation().targetContext + assertEquals("org.example", appContext.packageName) + } +} \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/AndroidManifest.xml b/KeepAnnotationsSample/app/src/main/AndroidManifest.xml new file mode 100644 index 00000000..170354c4 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/AndroidManifest.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/java/org/example/MainActivity.kt b/KeepAnnotationsSample/app/src/main/java/org/example/MainActivity.kt new file mode 100644 index 00000000..1948a814 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/java/org/example/MainActivity.kt @@ -0,0 +1,49 @@ +package org.example + +import android.os.Bundle +import androidx.activity.ComponentActivity +import androidx.activity.compose.setContent +import androidx.activity.enableEdgeToEdge +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.padding +import androidx.compose.material3.Scaffold +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Modifier +import androidx.compose.ui.tooling.preview.Preview +import org.example.ui.theme.ExampleTheme + +class MainActivity : ComponentActivity() { + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + enableEdgeToEdge() + setContent { + ExampleTheme { + Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding -> + Greeting( + name = "Android", + modifier = Modifier.padding(innerPadding) + ) + } + } + } + val locator = ResourceLocator.load() + println(locator) + } +} + +@Composable +fun Greeting(name: String, modifier: Modifier = Modifier) { + Text( + text = "Hello $name!", + modifier = modifier + ) +} + +@Preview(showBackground = true) +@Composable +fun GreetingPreview() { + ExampleTheme { + Greeting("Android") + } +} \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/java/org/example/ResourceLocator.kt b/KeepAnnotationsSample/app/src/main/java/org/example/ResourceLocator.kt new file mode 100644 index 00000000..feb9f8d2 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/java/org/example/ResourceLocator.kt @@ -0,0 +1,16 @@ +package org.example + +import androidx.annotation.keep.UsesReflectionToConstruct + +interface ResourceLocator { + companion object { + @UsesReflectionToConstruct(classConstant = ResourceLocatorImpl::class) + fun load(): ResourceLocator { + val klass = Class.forName(ResourceLocatorImpl::class.java.name) + @Suppress("DEPRECATION") + return klass.newInstance() as ResourceLocator + } + } +} + +private class ResourceLocatorImpl : ResourceLocator diff --git a/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Color.kt b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Color.kt new file mode 100644 index 00000000..0b7ccd3a --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Color.kt @@ -0,0 +1,11 @@ +package org.example.ui.theme + +import androidx.compose.ui.graphics.Color + +val Purple80 = Color(0xFFD0BCFF) +val PurpleGrey80 = Color(0xFFCCC2DC) +val Pink80 = Color(0xFFEFB8C8) + +val Purple40 = Color(0xFF6650a4) +val PurpleGrey40 = Color(0xFF625b71) +val Pink40 = Color(0xFF7D5260) \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Theme.kt b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Theme.kt new file mode 100644 index 00000000..d429f227 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Theme.kt @@ -0,0 +1,58 @@ +package org.example.ui.theme + +import android.app.Activity +import android.os.Build +import androidx.compose.foundation.isSystemInDarkTheme +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.darkColorScheme +import androidx.compose.material3.dynamicDarkColorScheme +import androidx.compose.material3.dynamicLightColorScheme +import androidx.compose.material3.lightColorScheme +import androidx.compose.runtime.Composable +import androidx.compose.ui.platform.LocalContext + +private val DarkColorScheme = darkColorScheme( + primary = Purple80, + secondary = PurpleGrey80, + tertiary = Pink80 +) + +private val LightColorScheme = lightColorScheme( + primary = Purple40, + secondary = PurpleGrey40, + tertiary = Pink40 + + /* Other default colors to override + background = Color(0xFFFFFBFE), + surface = Color(0xFFFFFBFE), + onPrimary = Color.White, + onSecondary = Color.White, + onTertiary = Color.White, + onBackground = Color(0xFF1C1B1F), + onSurface = Color(0xFF1C1B1F), + */ +) + +@Composable +fun ExampleTheme( + darkTheme: Boolean = isSystemInDarkTheme(), + // Dynamic color is available on Android 12+ + dynamicColor: Boolean = true, + content: @Composable () -> Unit +) { + val colorScheme = when { + dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { + val context = LocalContext.current + if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) + } + + darkTheme -> DarkColorScheme + else -> LightColorScheme + } + + MaterialTheme( + colorScheme = colorScheme, + typography = Typography, + content = content + ) +} \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Type.kt b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Type.kt new file mode 100644 index 00000000..7eee28d5 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/java/org/example/ui/theme/Type.kt @@ -0,0 +1,34 @@ +package org.example.ui.theme + +import androidx.compose.material3.Typography +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.font.FontFamily +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.sp + +// Set of Material typography styles to start with +val Typography = Typography( + bodyLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 16.sp, + lineHeight = 24.sp, + letterSpacing = 0.5.sp + ) + /* Other default text styles to override + titleLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 22.sp, + lineHeight = 28.sp, + letterSpacing = 0.sp + ), + labelSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 11.sp, + lineHeight = 16.sp, + letterSpacing = 0.5.sp + ) + */ +) \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/keepRules/rules.keep b/KeepAnnotationsSample/app/src/main/keepRules/rules.keep new file mode 100644 index 00000000..d7e081a5 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/keepRules/rules.keep @@ -0,0 +1,12 @@ +# Add project specific R8 rules here. +# AGP will combine all keep rule files in src/main/keepRules to pass to R8 +# +# For more details, see +# https://d.android.com/r/tools/r8/keep-rules + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_background.xml b/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 00000000..07d5da9c --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_foreground.xml b/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_foreground.xml new file mode 100644 index 00000000..2b068d11 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/drawable/ic_launcher_foreground.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 00000000..6f3b755b --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 00000000..6f3b755b --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher.webp new file mode 100644 index 00000000..c209e78e Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp new file mode 100644 index 00000000..b2dfe3d1 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher.webp new file mode 100644 index 00000000..4f0f1d64 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp new file mode 100644 index 00000000..62b611da Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher.webp new file mode 100644 index 00000000..948a3070 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp new file mode 100644 index 00000000..1b9a6956 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp new file mode 100644 index 00000000..28d4b77f Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp new file mode 100644 index 00000000..9287f508 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp new file mode 100644 index 00000000..aa7d6427 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp new file mode 100644 index 00000000..9126ae37 Binary files /dev/null and b/KeepAnnotationsSample/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp differ diff --git a/KeepAnnotationsSample/app/src/main/res/values/colors.xml b/KeepAnnotationsSample/app/src/main/res/values/colors.xml new file mode 100644 index 00000000..f8c6127d --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/values/colors.xml @@ -0,0 +1,10 @@ + + + #FFBB86FC + #FF6200EE + #FF3700B3 + #FF03DAC5 + #FF018786 + #FF000000 + #FFFFFFFF + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/values/strings.xml b/KeepAnnotationsSample/app/src/main/res/values/strings.xml new file mode 100644 index 00000000..60f36c8c --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + Example + \ No newline at end of file diff --git a/KeepAnnotationsSample/app/src/main/res/values/themes.xml b/KeepAnnotationsSample/app/src/main/res/values/themes.xml new file mode 100644 index 00000000..f01b8b69 --- /dev/null +++ b/KeepAnnotationsSample/app/src/main/res/values/themes.xml @@ -0,0 +1,5 @@ + + + +