Generating Kernel APIs from a Gradle Task / SDK6

Guides
,
1

The Kernel API Generator is a tool that helps to generate a kernel.api file based on a Java classpath:

image
image1894×366 51.5 KB

The following guide explains how to run the Kernel API Generator from a custom Gradle task, using MICROEJ SDK6 ExecTool task.

In this example, the APIs present in the metrology package of the kernel-services library will be exposed as Kernel APIs:

image
image1610×800 292 KB

  1. In the Gradle tasks view, run the classes task of your project to compile all its Java sources.

  2. In the Project explorer view, locate the folder containing the classes to be exposed as Kernel APIs.

  3. Open the build.gradle.kts file of the kernel project and add the following lines at the beginning of the file:

    import com.microej.gradle.tasks.ExecToolTask
import com.microej.gradle.tasks.LoadVeeTask

  4. Copy / paste the following code at the end of the build.gradle.kts file of the kernel:

    val loadVee = tasks.withType(LoadVeeTask::class).named("loadVee")
val mainSourceSet = project.extensions.getByType(SourceSetContainer::class).getByName(SourceSet.MAIN_SOURCE_SET_NAME)
tasks.register<ExecToolTask>("kernelAPIGenerator") {
    group = "microej"
    veeDir.set(loadVee.flatMap { it.loadedVeeDir })
    resourcesDirectories.from(mainSourceSet.output.resourcesDir, layout.buildDirectory.dir("generated/microej-app-wrapper/resources"))
    classesDirectories.from(mainSourceSet.output.classesDirs, layout.buildDirectory.dir("generated/microej-app-wrapper/classes"))
    classpathFromConfiguration.from(project.configurations.getByName("runtimeClasspath"))

    toolName = "kernelAPIGenerator"
    toolProperties.putAll(mapOf(
        "kernel.api.generator.classpath" to "C:\\PATH\\TO\MY\BUILT\\CLASSES\\FOLDER",
        "toolProperty=kernel.api.generator.includes.patterns" to "**/*.class",
        "kernel.api.generator.excludes.patterns" to ""
    ))
}

    Set the property kernel.api.generator.classpath to the absolute path obtained during step 2).

  5. Run the Kernel API Generator task using the Play button.

  6. The Kernel APIs are printed in the console. Add them to your kernel.api file.

Alex for MicroEJ