[build] Gradle Cleanup (#1021)

Cleanup project-wide gradle configuration. removes native dependencies from java only projects increases readability Pass generated headers in setup instead of modifying model
2026-07-03 03:01:40 +00:00 · 2023-11-22 20:08:23 -05:00
parent 5d93515429
commit 773c6352d0
14 changed files with 95 additions and 295 deletions
--- a/photon-lib/build.gradle
+++ b/photon-lib/build.gradle
@@ -9,54 +9,14 @@ import java.nio.file.Path
 ext {
    nativeName = "photonlib"
    includePhotonTargeting = true
+    // Include the generated Version file
+    generatedHeaders = "src/generate/native/include"
 }

-apply from: "${rootDir}/shared/setupBuild.gradle"
+apply from: "${rootDir}/shared/javacpp/setupBuild.gradle"
 apply from: "${rootDir}/versioningHelper.gradle"

-
-wpilibTools.deps.wpilibVersion = wpi.versions.wpilibVersion.get()
-
-def nativeConfigName = 'wpilibNatives'
-def nativeConfig = configurations.create(nativeConfigName)
-
-def nativeTasks = wpilibTools.createExtractionTasks {
-    configurationName = nativeConfigName
-}
-
-nativeTasks.addToSourceSetResources(sourceSets.main)
-
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("wpimath")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("wpinet")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("wpiutil")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("ntcore")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("cscore")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("apriltag")
-nativeConfig.dependencies.add wpilibTools.deps.wpilib("hal")
-nativeConfig.dependencies.add wpilibTools.deps.wpilibOpenCv("frc" + wpi.frcYear.get(), wpi.versions.opencvVersion.get())
-
-dependencies {
-    implementation project(":photon-targeting")
-
-    implementation wpilibTools.deps.wpilibJava("wpiutil")
-    implementation wpilibTools.deps.wpilibJava("cameraserver")
-    implementation wpilibTools.deps.wpilibJava("cscore")
-    implementation wpilibTools.deps.wpilibJava("wpinet")
-    implementation wpilibTools.deps.wpilibJava("wpimath")
-    implementation wpilibTools.deps.wpilibJava("ntcore")
-    implementation wpilibTools.deps.wpilibJava("hal")
-    implementation wpilibTools.deps.wpilibJava("wpilibj")
-    implementation wpilibTools.deps.wpilibJava("apriltag")
-    implementation wpilibTools.deps.wpilibOpenCvJava("frc" + wpi.frcYear.get(), wpi.versions.opencvVersion.get())
-
-    implementation group: "com.fasterxml.jackson.core", name: "jackson-annotations", version: wpi.versions.jacksonVersion.get()
-    implementation group: "com.fasterxml.jackson.core", name: "jackson-core", version: wpi.versions.jacksonVersion.get()
-    implementation group: "com.fasterxml.jackson.core", name: "jackson-databind", version: wpi.versions.jacksonVersion.get()
-
-    implementation group: "org.ejml", name: "ejml-simple", version: wpi.versions.ejmlVersion.get()
-    implementation group: "us.hebi.quickbuf", name: "quickbuf-runtime", version: wpi.versions.quickbufVersion.get();
-}
-
+// Include the version file in the distributed sources
 cppHeadersZip {
    from('src/generate/native/include') {
        into '/'
@@ -66,8 +26,6 @@ cppHeadersZip {
 def photonlibFileInput = file("src/generate/photonlib.json.in")
 ext.photonlibFileOutput = file("$buildDir/generated/vendordeps/photonlib.json")

-def vendorJson = artifacts.add('archives', file("$photonlibFileOutput"))
-
 task generateVendorJson() {
    description = "Generates the vendor JSON file"
    group = "PhotonVision"
@@ -103,18 +61,9 @@ task writeCurrentVersion {

 build.mustRunAfter writeCurrentVersion

-model {
-    components {
-        all {
-            it.sources.each {
-                it.exportedHeaders {
-                    srcDirs "src/main/native/include"
-                    srcDirs "src/generate/native/include"
-                }
-            }
-        }
-    }
+def vendorJson = artifacts.add('archives', file("$photonlibFileOutput"))

+model {
    // Publish the vendordep json
    publishing {
        publications {
--- a/photon-lib/src/main/driver/cpp/VendorJNI.cpp
+++ b/photon-lib/src/main/driver/cpp/VendorJNI.cpp
@@ -1,53 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) PhotonVision
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-#include "com_vendor_jni_VendorJNI.h"
-#include "jni.h"
-
-JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) {
-  // Check to ensure the JNI version is valid
-
-  JNIEnv* env;
-  if (vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6) != JNI_OK)
-    return JNI_ERR;
-
-  // In here is also where you store things like class references
-  // if they are ever needed
-
-  return JNI_VERSION_1_6;
-}
-
-JNIEXPORT void JNICALL JNI_OnUnload(JavaVM* vm, void* reserved) {}
-
-/*
- * Class:     com_vendor_jni_VendorJNI
- * Method:    initialize
- * Signature: ()I
- */
-JNIEXPORT jint JNICALL
-Java_com_vendor_jni_VendorJNI_initialize
-  (JNIEnv*, jclass)
-{
-  return 0;
-}
--- a/photon-lib/src/main/driver/cpp/driversource.cpp
+++ b/photon-lib/src/main/driver/cpp/driversource.cpp
@@ -1,29 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) PhotonVision
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-#include "driverheader.h"
-
-extern "C" {
-void c_doThing(void) {}
-}  // extern "C"
--- a/photon-lib/src/main/driver/include/driverheader.h
+++ b/photon-lib/src/main/driver/include/driverheader.h
@@ -1,29 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) PhotonVision
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-#pragma once
-
-extern "C" {
-void c_doThing(void);
-}  // extern "C"
--- a/photon-lib/src/main/driver/symbols.txt
+++ b/photon-lib/src/main/driver/symbols.txt
@@ -1,4 +0,0 @@
-JNI_OnLoad
-JNI_OnUnload
-Java_com_vendor_jni_VendorJNI_initialize
-c_doThing