├── .clang-format ├── app ├── src │ ├── main │ │ ├── cpp │ │ │ ├── libapp.map.txt │ │ │ ├── app_test.cpp │ │ │ ├── app.cpp │ │ │ └── CMakeLists.txt │ │ ├── res │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ ├── colors.xml │ │ │ │ └── themes.xml │ │ │ ├── mipmap-hdpi │ │ │ │ ├── ic_launcher.webp │ │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-mdpi │ │ │ │ ├── ic_launcher.webp │ │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xhdpi │ │ │ │ ├── ic_launcher.webp │ │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xxhdpi │ │ │ │ ├── ic_launcher.webp │ │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-xxxhdpi │ │ │ │ ├── ic_launcher.webp │ │ │ │ └── ic_launcher_round.webp │ │ │ ├── mipmap-anydpi-v26 │ │ │ │ ├── ic_launcher.xml │ │ │ │ └── ic_launcher_round.xml │ │ │ ├── layout │ │ │ │ └── activity_main.xml │ │ │ ├── values-night │ │ │ │ └── themes.xml │ │ │ ├── drawable-v24 │ │ │ │ └── ic_launcher_foreground.xml │ │ │ └── drawable │ │ │ │ └── ic_launcher_background.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── myapplication │ │ │ └── MainActivity.kt │ ├── androidTest │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── myapplication │ │ │ ├── NativeTests.kt │ │ │ └── ExampleInstrumentedTest.kt │ └── test │ │ └── java │ │ └── com │ │ └── example │ │ └── myapplication │ │ └── ExampleUnitTest.kt └── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── settings.gradle ├── LICENSE ├── gradle.properties ├── .github └── workflows │ └── build.yml ├── gradlew.bat ├── README.md └── gradlew /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: Google -------------------------------------------------------------------------------- /app/src/main/cpp/libapp.map.txt: -------------------------------------------------------------------------------- 1 | LIBAPP { 2 | global: 3 | JNI_OnLoad; 4 | local: 5 | *; 6 | }; -------------------------------------------------------------------------------- /app/src/main/cpp/app_test.cpp: -------------------------------------------------------------------------------- 1 | #include "gtest/gtest.h" 2 | 3 | TEST(app, foo) { 4 | ASSERT_EQ(4, 2 + 2); 5 | } -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | NDK App Template 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DanAlbert/ndk-app-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri May 13 13:39:22 PDT 2022 2 | distributionBase=GRADLE_USER_HOME 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip 4 | distributionPath=wrapper/dists 5 | zipStorePath=wrapper/dists 6 | zipStoreBase=GRADLE_USER_HOME 7 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/example/myapplication/NativeTests.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import androidx.test.ext.junitgtest.GtestRunner 4 | import androidx.test.ext.junitgtest.TargetLibrary 5 | import org.junit.runner.RunWith 6 | 7 | @RunWith(GtestRunner::class) 8 | @TargetLibrary(libraryName = "app_tests") 9 | class NativeTests -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | gradlePluginPortal() 4 | google() 5 | mavenCentral() 6 | } 7 | } 8 | dependencyResolutionManagement { 9 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) 10 | repositories { 11 | google() 12 | mavenCentral() 13 | } 14 | } 15 | rootProject.name = "NDK App Template" 16 | include ':app' 17 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/test/java/com/example/myapplication/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import org.junit.Test 4 | 5 | import org.junit.Assert.* 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | class ExampleUnitTest { 13 | @Test 14 | fun addition_isCorrect() { 15 | assertEquals(4, 2 + 2) 16 | } 17 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2022 Dan Albert 2 | 3 | Permission to use, copy, modify, and/or distribute this software for any 4 | purpose with or without fee is hereby granted. 5 | 6 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH 7 | REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 8 | AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, 9 | INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 10 | LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR 11 | OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 12 | PERFORMANCE OF THIS SOFTWARE. -------------------------------------------------------------------------------- /app/src/androidTest/java/com/example/myapplication/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.example.myapplication", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 18 | 19 | -------------------------------------------------------------------------------- /app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/main/cpp/app.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include 4 | 5 | extern "C" JNIEXPORT jstring JNICALL string_from_jni(JNIEnv *env, jobject) { 6 | std::string hello = "Hello from C++"; 7 | return env->NewStringUTF(hello.c_str()); 8 | } 9 | 10 | JNIEXPORT jint JNI_OnLoad(JavaVM *vm, void *reserved __unused) { 11 | JNIEnv *env; 12 | if (vm->GetEnv(reinterpret_cast(&env), JNI_VERSION_1_6) != JNI_OK) { 13 | return JNI_ERR; 14 | } 15 | 16 | jclass c = env->FindClass("com/example/myapplication/MainActivity"); 17 | if (c == nullptr) return JNI_ERR; 18 | 19 | // Register your class' native methods. 20 | static const JNINativeMethod methods[] = { 21 | {"stringFromJNI", "()Ljava/lang/String;", 22 | reinterpret_cast(string_from_jni)}, 23 | }; 24 | int rc = env->RegisterNatives(c, methods, 25 | sizeof(methods) / sizeof(JNINativeMethod)); 26 | if (rc != JNI_OK) return rc; 27 | 28 | return JNI_VERSION_1_6; 29 | } -------------------------------------------------------------------------------- /app/src/main/java/com/example/myapplication/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.example.myapplication 2 | 3 | import android.os.Bundle 4 | import androidx.appcompat.app.AppCompatActivity 5 | import com.example.myapplication.databinding.ActivityMainBinding 6 | 7 | class MainActivity : AppCompatActivity() { 8 | 9 | private lateinit var binding: ActivityMainBinding 10 | 11 | override fun onCreate(savedInstanceState: Bundle?) { 12 | super.onCreate(savedInstanceState) 13 | 14 | binding = ActivityMainBinding.inflate(layoutInflater) 15 | setContentView(binding.root) 16 | 17 | // Example of a call to a native method 18 | binding.sampleText.text = stringFromJNI() 19 | } 20 | 21 | /** 22 | * A native method that is implemented by the 'myapplication' native library, 23 | * which is packaged with this application. 24 | */ 25 | external fun stringFromJNI(): String 26 | 27 | companion object { 28 | // Used to load the 'myapplication' library on application startup. 29 | init { 30 | System.loadLibrary("app") 31 | } 32 | } 33 | } -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Kotlin code style for this project: "official" or "obsolete": 19 | kotlin.code.style=official 20 | # Enables namespacing of each library's R class so that its R class includes only the 21 | # resources declared in the library itself and none from the library's dependencies, 22 | # thereby reducing the size of the R class for that library 23 | android.nonTransitiveRClass=true -------------------------------------------------------------------------------- /app/src/main/cpp/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.22.1) 2 | project("NDK App Template" VERSION 1.0.0 LANGUAGES C CXX) 3 | 4 | set(CLANG_TIDY_PATH 5 | "${ANDROID_TOOLCHAIN_ROOT}/bin/clang-tidy${ANDROID_TOOLCHAIN_SUFFIX}") 6 | set(CMAKE_CXX_CLANG_TIDY ${CLANG_TIDY_PATH} "-checks=android-*") 7 | 8 | find_package(googletest REQUIRED CONFIG) 9 | find_package(junit-gtest REQUIRED CONFIG) 10 | 11 | # The library sources are compiled as an OBJECT library rather than as a SHARED 12 | # library to avoid ODR issues with libc++_static when linking the tests. This is 13 | # similar to repackaging a static library as a shared library, but is the CMake 14 | # way of doing it, and doesn't waste time building the intermediate static 15 | # library. 16 | add_library(app_impl OBJECT app.cpp) 17 | target_include_directories(app_impl PUBLIC include) 18 | target_compile_features(app_impl PUBLIC cxx_std_20) 19 | target_compile_options(app_impl 20 | PRIVATE 21 | -Wall 22 | -Wextra 23 | -Werror 24 | ) 25 | 26 | # If you change the name of the library, remember to update the 27 | # System.loadLibrary call in MainActivity.kt. 28 | add_library(app SHARED $) 29 | target_link_options(app 30 | PRIVATE 31 | -flto 32 | -Wl,--version-script,${CMAKE_SOURCE_DIR}/libapp.map.txt 33 | ) 34 | set_target_properties(app 35 | PROPERTIES 36 | LINK_DEPENDS ${CMAKE_SOURCE_DIR}/libapp.map.txt 37 | ) 38 | 39 | add_library(app_tests SHARED app_test.cpp) 40 | target_link_libraries(app_tests 41 | PRIVATE 42 | $ 43 | googletest::gtest 44 | googletest::gmock 45 | junit-gtest::junit-gtest 46 | ) -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'org.jetbrains.kotlin.android' 4 | } 5 | 6 | android { 7 | namespace 'com.example.myapplication' 8 | compileSdk 33 9 | ndkVersion "25.1.8937393" 10 | 11 | defaultConfig { 12 | applicationId "com.example.myapplication" 13 | minSdk 21 14 | targetSdk 33 15 | versionCode 1 16 | versionName "1.0" 17 | 18 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 19 | } 20 | 21 | compileOptions { 22 | sourceCompatibility JavaVersion.VERSION_1_8 23 | targetCompatibility JavaVersion.VERSION_1_8 24 | } 25 | 26 | kotlinOptions { 27 | jvmTarget = '1.8' 28 | } 29 | 30 | externalNativeBuild { 31 | cmake { 32 | path file('src/main/cpp/CMakeLists.txt') 33 | version '3.22.1' 34 | } 35 | } 36 | 37 | buildFeatures { 38 | prefab true 39 | viewBinding true 40 | } 41 | packagingOptions { 42 | jniLibs { 43 | // Libraries that are wrongly included in the junit-gtest AAR that 44 | // will end up in our APK if we don't explicitly exclude them. 45 | excludes += [ 46 | "**/libadder.so", 47 | "**/libapptest.so", 48 | "**/libc++_shared.so", 49 | ] 50 | } 51 | } 52 | 53 | } 54 | 55 | dependencies { 56 | implementation 'androidx.core:core-ktx:1.9.0' 57 | implementation 'androidx.appcompat:appcompat:1.5.1' 58 | implementation 'com.google.android.material:material:1.6.1' 59 | implementation 'androidx.constraintlayout:constraintlayout:2.1.4' 60 | implementation 'androidx.test.ext:junit-gtest:1.0.0-alpha01' 61 | implementation 'com.android.ndk.thirdparty:googletest:1.11.0-beta-1' 62 | testImplementation 'junit:junit:4.13.2' 63 | androidTestImplementation 'androidx.test.ext:junit:1.1.3' 64 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0' 65 | } -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Android CI 2 | 3 | on: 4 | push: 5 | branches: ["main"] 6 | pull_request: 7 | branches: ["main"] 8 | 9 | jobs: 10 | build: 11 | name: Build debug APKs 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v3 16 | 17 | - name: set up JDK 11 18 | uses: actions/setup-java@v3 19 | with: 20 | java-version: "11" 21 | distribution: "temurin" 22 | cache: gradle 23 | 24 | - name: Grant execute permission for gradlew 25 | run: chmod +x gradlew 26 | 27 | - name: Build debug APKs 28 | run: ./gradlew --stacktrace assembleDebug assembleDebugAndroidTest 29 | 30 | - name: Upload debug APK 31 | uses: actions/upload-artifact@v3 32 | with: 33 | name: app-debug 34 | path: app/build/outputs/apk/debug/app-debug.apk 35 | 36 | - name: Upload debug test APK 37 | uses: actions/upload-artifact@v3 38 | with: 39 | name: app-debug-androidTest 40 | path: app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk 41 | 42 | unit-tests: 43 | name: Run unit tests 44 | runs-on: ubuntu-latest 45 | 46 | steps: 47 | - uses: actions/checkout@v3 48 | 49 | - name: set up JDK 11 50 | uses: actions/setup-java@v3 51 | with: 52 | java-version: "11" 53 | distribution: "temurin" 54 | cache: gradle 55 | 56 | - name: Grant execute permission for gradlew 57 | run: chmod +x gradlew 58 | 59 | - name: Build and run unit tests 60 | run: ./gradlew --stacktrace check 61 | 62 | device-tests: 63 | name: Run device tests 64 | needs: build 65 | runs-on: ubuntu-latest 66 | env: 67 | HAVE_FIREBASE_KEY: ${{ secrets.FIREBASE_KEY != '' }} 68 | 69 | steps: 70 | - uses: actions/checkout@v3 71 | 72 | - uses: actions/download-artifact@v3 73 | if: ${{ env.HAVE_FIREBASE_KEY == 'true' }} 74 | with: 75 | name: app-debug 76 | 77 | - uses: actions/download-artifact@v3 78 | if: ${{ env.HAVE_FIREBASE_KEY == 'true' }} 79 | with: 80 | name: app-debug-androidTest 81 | 82 | - id: auth 83 | uses: google-github-actions/auth@v0 84 | if: ${{ env.HAVE_FIREBASE_KEY == 'true' }} 85 | with: 86 | credentials_json: "${{ secrets.FIREBASE_KEY }}" 87 | 88 | - name: Set up Cloud SDK 89 | uses: google-github-actions/setup-gcloud@v0 90 | if: ${{ env.HAVE_FIREBASE_KEY == 'true' }} 91 | with: 92 | project_id: ndk-app-template 93 | 94 | - name: Run instrumentation tests in Firebase test lab 95 | if: ${{ env.HAVE_FIREBASE_KEY == 'true' }} 96 | run: 97 | gcloud firebase test android run --type instrumentation --app 98 | app-debug.apk --test app-debug-androidTest.apk --device 99 | model=oriole,version=33,locale=en,orientation=portrait 100 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NDK App Template 2 | 3 | This is a template application that configures a bit more than the new project 4 | wizard in Android Studio. The differences are: 5 | 6 | - Better default gitignore 7 | - A gitattributes file 8 | - Includes testing support 9 | - Removed empty proguard config 10 | - Updated out of date dependencies 11 | - A less cluttered CMakeLists.txt 12 | - Added a version script to protect the app's symbol visibility 13 | - Uses `RegisterNatives` via `JNI_OnLoad` instead of name-based lookups 14 | - Added C++ unit tests 15 | - Enable clang-tidy 16 | 17 | You should change the following after forking this template: 18 | 19 | 1. Change the project name using the `rootProject.name` property in 20 | `settings.gradle`. 21 | 2. Update the `groupId` and `applicationId`. `git grep com.example` and 22 | `git grep -i myapplication` to find places to update. You'll also need to 23 | rename and `com/example/myapplication` directories to match your new IDs, and 24 | update the argument to `env->FindClass` in `JNI_OnLoad`. 25 | 3. Update the CMake `project` name in `CMakeLists.txt`. 26 | 4. (Optional) Relicense the project if you don't want your code covered by Zero 27 | Clause BSD. 28 | 29 | ## How to use this template in Android Studio 30 | 31 | Open Android Studio and open this directory when selecting a project. 32 | 33 | ## How to use this template in Visual Studio Code 34 | 35 | Warning: I struggled a lot to get this to work, and wasn't happy with the 36 | result. The C++ features are annoying to keep working, and I didn't find any 37 | answers about how to work with Kotlin or even Java in Android projects. Please 38 | send a PR if you figure out better instructions. 39 | 40 | Open VSCode and open this directory to create the workspace. 41 | 42 | Install the 43 | [C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) 44 | extension. 45 | 46 | The C++ extension needs the `compile_commands.json` file that is generated by 47 | CMake during the build, so build the project once to prepare that for the 48 | editor: `./gradlew assemble`. 49 | 50 | Next you need to configure VSCode to use the generated `compile_commands.json` 51 | file. If you open a C++ file in the app project, VSCode may pop up a dialog in 52 | the bottom right of the window that will do that for you. If it doesn't, you can 53 | configure it manually: 54 | 55 | 1. Run `find app/.cxx -name compile_commands.json` to find the fils that were 56 | generated. 57 | 2. Open the C/C++: Edit Configurations (UI) window (ctrl+shift+P or cmd+shift+P 58 | on macOS, then search for that) 59 | 3. (Optional) Add a new configuration for this build type, such as 60 | `Android Debug arm64-v8a` (the name doesn't have any special meaning, it's 61 | just for your benefit). 62 | 4. Expand the "Advanced" settings 63 | 5. Set the "Compile commands" field to the path of the `compile_commands.json` 64 | file. 65 | 66 | In either case, you'll have multiple `compile_commands.json` files to choose 67 | from; one per CMake build type and ABI combo. For example, you'll have 68 | `RelWithDebInfo//arm64-v8a` and `Debug//x86`. Pick 69 | whichever is appropriate for the config you're testing. 70 | 71 | Warning: The output location of `compile_commands.json` is not stable because 72 | AGP uses a hash of the CMake commands as part of the output directory as a way 73 | to share objects between identical build variants. This means that you may need 74 | to repeat these steps if you change your build.gradle file. If the `find` 75 | command above is showing more than one hash for each CMake build type, you'll 76 | need to do a clean build and then rebuild to determine which path is the correct 77 | one. See https://issuetracker.google.com/232986281 for more information. 78 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> $.*$$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | --------------------------------------------------------------------------------