Enhance PDE source set and preprocessing in ProcessingPlugin

Added comments and structure for improved clarity. Also added a placeholder test for internal libraries in ProcessingPluginTest.

Author: Stefterv

java/gradle/src/main/kotlin/LibrariesTask.kt

@@ -55,7 +55,7 @@ abstract class LibrariesTask : DefaultTask() {
                     .listFiles{ file -> file.extension == "jar" }
                     ?.map{ file ->
 
-                        // Inside of each jar, look for the defined classes
+                        // Inside each jar, look for the defined classes
                         val jar = JarFile(file)
                         val classes = jar.entries().asSequence()
                             .filter { entry -> entry.name.endsWith(".class") }

java/gradle/src/main/kotlin/ProcessingPlugin.kt

@@ -154,29 +154,38 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
 
         }
 
+        // For every Java Source Set (main, test, etc) add a PDE source set that includes .pde files
+        // and a task to process them before compilation
         project.extensions.getByType(JavaPluginExtension::class.java).sourceSets.first().let{ sourceSet ->
             val pdeSourceSet = objectFactory.newInstance(
                 DefaultPDESourceDirectorySet::class.java,
                 objectFactory.sourceDirectorySet("${sourceSet.name}.pde", "${sourceSet.name} Processing Source")
-            ).apply {
-                filter.include("**/*.pde")
-                filter.exclude("${project.layout.buildDirectory.asFile.get().name}/**")
+            )
 
+            // Configure the PDE source set to include all .pde files in the sketch folder except those in the build directory
+            pdeSourceSet.apply {
                 srcDir("./")
                 srcDir("$workingDir/unsaved")
+
+                filter.include("**/*.pde")
+                filter.exclude("${project.layout.buildDirectory.asFile.get().name}/**")
             }
             sourceSet.allSource.source(pdeSourceSet)
+
+            // Add top level java source files
             sourceSet.java.srcDir(project.layout.projectDirectory).apply {
                 include("/*.java")
             }
 
+            // Scan the libraries before compiling the sketches
             val librariesTaskName = sourceSet.getTaskName("scanLibraries", "PDE")
             val librariesScan = project.tasks.register(librariesTaskName, LibrariesTask::class.java) { task ->
                 task.description = "Scans the libraries in the sketchbook"
                 task.librariesDirectory.set(sketchbook?.let { File(it, "libraries") })
                 // TODO: Save the libraries metadata to settings folder to share between sketches
             }
 
+            // Create a task to process the .pde files before compiling the java sources
             val pdeTaskName = sourceSet.getTaskName("preprocess", "PDE")
             val pdeTask = project.tasks.register(pdeTaskName, PDETask::class.java) { task ->
                 task.description = "Processes the ${sourceSet.name} PDE"
@@ -194,7 +203,7 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
                 // TODO: Save the libraries metadata to settings folder to share between sketches
             }
 
-            // Make sure that the PDE task runs before the java compilation task
+            // Make sure that the PDE tasks runs before the java compilation task
             project.tasks.named(sourceSet.compileJavaTaskName) { task ->
                 task.dependsOn(pdeTaskName, depsTaskName)
             }

java/gradle/src/test/kotlin/ProcessingPluginTest.kt

@@ -270,6 +270,11 @@ class ProcessingPluginTest{
         }
     }
 
+    @Test
+    fun testUseInternalLibraries(){
+
+    }
+
     @Test
     fun testUseCodeJar(){
         // TODO: test if adding jars to the code folder works