ADFA-2179 ndk template

[jomen-adfa]

ndk template for use with ndk installation

[coderabbitai]

📝 Walkthrough

NDK Template Implementation Release Notes

New Features

• NDK Activity Template: Added new project template for NDK (Native Development Kit) development with pre-configured native build support
  • Includes Kotlin and Java MainActivity implementations with JNI integration
  • Provides C++ source template (native-lib.cpp) with sample JNI function
  • Includes CMakeLists.txt for native build configuration
  • Pre-configured with ABI filters (arm64-v8a) and C++17 standard flag
  • NDK version pinned to 29.0.14206865

Infrastructure Updates

• Extended AndroidModuleTemplateBuilder with NDK-specific build Gradle generators for both Kotlin DSL and Groovy DSL
• Added NdkModuleTemplateBuilder class to handle NDK-specific module configuration
• Added helper utilities for managing native C++ sources and CMake files
• Added tooltip and string resources for NDK template UI presentation

Feature Gating

• NDK template is only available when experiments are enabled (FeatureFlags.isExperimentsEnabled)
• NDK installation also gated behind experiments flag
• Template returns null if NDK directory does not exist on the system

Risk & Best Practices Considerations

• ⚠️No unit tests found for new NDK template functionality - recommend adding tests for template generation and NDK module builder
• ⚠️Breaking change: Made AndroidModuleTemplateBuilder open (was previously final) - verify no code relied on final behavior
• ✅ Proper experimental feature flag gating follows existing patterns (consistent with plugin template gating)
• ✅ Safe fallback with null return if NDK directory missing
• ✅ Comprehensive implementation with KTS and Groovy DSL support for flexibility

Walkthrough

This PR introduces comprehensive NDK (Native Development Kit) template support to Android IDE. Changes include a new NdkModuleTemplateBuilder class, Gradle script generators for NDK configurations (KTS and Groovy variants), template implementations for NDK activities with C++/CMake integration, and feature flag gating for NDK installation.

Changes

Cohort / File(s)	Summary
Template Constants & Resources idetooltips/src/main/java/com/itsaky/androidide/idetooltips/TooltipTag.kt, resources/src/main/res/values/strings.xml	Added tooltip constant TEMPLATE_NDK_ACTIVITY and string resource template_ndk for NDK activity template labeling.
NDK Module Builder Infrastructure templates-api/src/main/java/com/itsaky/androidide/templates/base/AndroidModuleTemplateBuilder.kt	Changed AndroidModuleTemplateBuilder from final to open class to enable inheritance for NDK-specific builder.
NDK Gradle Generation templates-api/src/main/java/com/itsaky/androidide/templates/base/modules/android/buildGradle.kt	Added two public extension functions ndkBuildGradleSrcKts() and ndkBuildGradleSrcGroovy() generating NDK-configured Gradle scripts with ABI filters, CMake, and native build settings (221 new lines).
NDK Template Builder templates-api/src/main/java/com/itsaky/androidide/templates/base/ndkExtensions.kt	Introduced NdkModuleTemplateBuilder class with native source/CMake file writing helpers and overridden buildGradle() method; added top-level defaultAppModuleWithNdk() builder function for convenient NDK module creation.
NDK Template Implementation templates-impl/src/main/java/com/itsaky/androidide/templates/impl/ndkActivity/ndkActivityTemplate.kt	Added public ndkActivityProject() function that conditionally creates NDK-enabled project templates with activity layout and resource wiring, gated by feature flags and NDK directory existence.
NDK Source Templates templates-impl/src/main/java/com/itsaky/androidide/templates/impl/ndkActivity/ndkSources.kt	Implemented internal template functions for Kotlin/Java NDK activities with JNI integration, C++ implementation, and CMakeLists.txt generation (125 new lines).
Template Provider Integration templates-impl/src/main/java/com/itsaky/androidide/templates/impl/TemplateProviderImpl.kt	Registered ndkActivityProject in the templates provider to expose NDK templates.
Feature Flag Gating app/src/main/java/com/itsaky/androidide/assets/BaseAssetsInstaller.kt	Added early return in installNdk() when FeatureFlags.isExperimentsEnabled is false, preventing NDK installation without enabled experiments.

Sequence Diagram(s)

sequenceDiagram
participant User
participant TemplateProvider
participant ProjectBuilder
participant NdkModuleBuilder
participant GradleGenerator
participant SourceGenerator
participant FileWriter
User->>TemplateProvider: request ndkActivityProject()
alt Experiments disabled or NDK_DIR missing
TemplateProvider-->>User: return null
else Proceed with creation
TemplateProvider->>ProjectBuilder: create project template
ProjectBuilder->>NdkModuleBuilder: build NDK app module
NdkModuleBuilder->>GradleGenerator: generate build.gradle (KTS/Groovy)
GradleGenerator->>FileWriter: write gradle config with ABI filters & CMake
NdkModuleBuilder->>SourceGenerator: generate MainActivity & JNI bindings
SourceGenerator->>FileWriter: write Kotlin/Java activity sources
NdkModuleBuilder->>SourceGenerator: generate C++ & CMakeLists.txt
SourceGenerator->>FileWriter: write native sources & build config
NdkModuleBuilder->>FileWriter: write layout resources
ProjectBuilder-->>TemplateProvider: return configured ProjectTemplate
TemplateProvider-->>User: return ndkActivityProject template
end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• PR #880: Introduces NDK directory installation and Environment.NDK_DIR setup, which is queried by ndkActivityProject() to gate template availability.

Suggested reviewers

• itsaky-adfa
• davidschachterADFA
• alome007

Poem

🐰 Hops with glee ✨
Native code now blooms with grace,
NDK templates find their place!
C++ threads and CMake files unite,
Android SDK shines ever bright. 🚀

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 4.76% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'ADFA-2179 ndk template' directly refers to the main change: adding an NDK template feature with supporting infrastructure across multiple files.
Description check	✅ Passed	The description 'ndk template for use with ndk installation' is directly related to the changeset, which adds NDK template functionality and support.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 4

🤖 Fix all issues with AI agents

In
`@templates-api/src/main/java/com/itsaky/androidide/templates/base/modules/android/buildGradle.kt`:
- Around line 460-462: The NDk abiFilters generation produces invalid Kotlin
like abiFilters += "a","b"; update the template in buildGradle.kt inside the ndk
block so the RHS is wrapped in listOf(...). Concretely, change the generated
expression for abiFilters (the line using ${abiFilters.joinToString(...)}) to
produce listOf("arm64-v8a", "x86") style output (e.g.,
listOf(${abiFilters.joinToString(",") { "\"$it\"" }})) so the ndk { abiFilters
+= ... } line is valid KTS.
In
`@templates-api/src/main/java/com/itsaky/androidide/templates/base/ndkExtensions.kt`:
- Around line 28-48: The functions writeCpp and writeCMakeList declare an unused
parameter writer: SourceWriter; remove this parameter from both function
signatures and from all call sites to simplify the API, leaving the bodies
unchanged (they still call executor.save with src and
srcNativeFilePath(SrcSet.Main, fileName)); search for usages of writeCpp and
writeCMakeList and update calls to drop the SourceWriter argument, and run a
build to resolve any resulting compilation errors due to changed signatures.
- Around line 50-67: The buildGradle override currently passes ndkVersion as an
empty string which generates an invalid ndkVersion = "" in the Gradle file;
update RecipeExecutor.buildGradle so it forwards ndkVersion as a nullable (or
only when non-blank) to ndkBuildGradleSrcKts / ndkBuildGradleSrcGroovy and
ensure those builder functions emit the ndkVersion property only if a non-empty,
valid version string (major.minor.build) is provided — otherwise omit the
property so the default NDK is used; alternatively validate ndkVersion and fail
early with a clear error if an invalid format is supplied.
In
`@templates-impl/src/main/java/com/itsaky/androidide/templates/impl/ndkActivity/ndkActivityTemplate.kt`:
- Around line 28-32: The call to defaultAppModuleWithNdk currently pins
ndkVersion ("29.0.14206865") which prevents Gradle from discovering the
installed NDK; remove the ndkVersion argument so the call becomes
defaultAppModuleWithNdk(abiFilters = listOf("arm64-v8a"), cppFlags =
"-std=c++17") and leave the existing Environment.NDK_DIR.exists() check intact
so Gradle will select the installed NDK automatically.

🧹 Nitpick comments (5)

templates-api/src/main/java/com/itsaky/androidide/templates/base/modules/android/buildGradle.kt (3)

494-499: composeConfig is always included regardless of isComposeModule.

The composeConfigKts() block (and similarly composeConfigGroovy() at line 608) is included unconditionally, adding compose-specific options, packaging rules, and resolution strategies even for non-compose NDK modules. Consider making this conditional:

♻️ Suggested change

 buildFeatures {
${if (!isComposeModule) "viewBinding = true" else ""}
${if (isComposeModule) "compose = true" else ""}
}
- ${composeConfigKts()}+ ${if (isComposeModule) composeConfigKts() else ""}
}

---

464-468: Consider conditional inclusion of cppFlags when non-empty.

When cppFlags is empty, the generated output includes cppFlags += "" which is unnecessary. Similar issue exists in the Groovy variant at line 576.

♻️ Suggested approach

externalNativeBuild {
cmake {
${if (cppFlags.isNotEmpty()) "cppFlags += \"$cppFlags\""else""}
}
}

---

396-507: Significant code duplication with existing buildGradleSrcKts.

The NDK variants share ~90% of their content with the non-NDK versions (buildGradleSrcKts/buildGradleSrcGroovy). This creates a maintenance burden where changes to the base template logic must be mirrored in both places. Consider extracting common sections or using a composition approach in a future refactor.

templates-api/src/main/java/com/itsaky/androidide/templates/base/ndkExtensions.kt (2)

19-26: Path calculation method has directory creation side effect.

srcNativeFilePath calculates a path but also creates directories (lines 22-24). This mixes concerns and can cause unexpected behavior when just querying a path. Consider moving directory creation to the caller or to a separate method.

---

71-78: Consider validating abiFilters against supported ABIs.

Based on learnings, x86_64 ABI is not supported in NDK templates for this project. Consider adding validation to ensure only supported ABIs like "arm64-v8a" are passed, or at minimum document this constraint in the function's KDoc.

♻️ Suggested validation approach

inlinefun ProjectTemplateBuilder.defaultAppModuleWithNdk(
name:String = ":app",
ndkVersion:String? = null,
abiFilters:List<String>? = null,
cppFlags:String? = null,
addAndroidX:Boolean = true,
copyDefAssets:Boolean = true,
crossinline block:NdkModuleTemplateBuilder.() ->Unit
) {
val supportedAbis =setOf("arm64-v8a", "armeabi-v7a")
abiFilters?.forEach { abi ->
require(abi in supportedAbis) { "Unsupported ABI: $abi. Supported: $supportedAbis" }
}
// ... rest of function
}