Create scaffolding of editor's CLI interface

This commit is contained in:
2025-07-11 00:19:18 +02:00
parent 3faf677925
commit ca04c2531f
10 changed files with 100 additions and 191 deletions

View File

@@ -37,6 +37,9 @@ dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib"
// CLI arg parser
implementation "com.xenomachina:kotlin-argparser:${kotlinArgParserVersion}"
// JSON Proto
implementation "com.google.protobuf:protobuf-java-util:${protobufVersion}"

View File

@@ -1,8 +1,15 @@
package com.bartlomiejpluta.base.editor
import com.bartlomiejpluta.base.editor.cli.model.CLIArgs
import com.bartlomiejpluta.base.editor.code.build.exception.BuildException
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildPipelineService
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildService
import com.bartlomiejpluta.base.editor.main.controller.MainController
import com.bartlomiejpluta.base.editor.main.view.MainView
import com.bartlomiejpluta.base.editor.project.context.ProjectContext
import com.xenomachina.argparser.ArgParser
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.CommandLineRunner
import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.context.ConfigurableApplicationContext
@@ -14,28 +21,63 @@ import kotlin.reflect.KClass
@SpringBootApplication
open class EditorApp : App(MainView::class) {
private lateinit var context: ConfigurableApplicationContext
private lateinit var context: ConfigurableApplicationContext
@Autowired
private lateinit var mainController: MainController
@Autowired
private lateinit var mainController: MainController
override fun init() {
this.context = SpringApplication.run(this.javaClass)
context.autowireCapableBeanFactory.autowireBean(this)
override fun init() {
this.context = SpringApplication.run(this.javaClass)
context.autowireCapableBeanFactory.autowireBean(this)
FX.dicontainer = object : DIContainer {
override fun <T : Any> getInstance(type: KClass<T>): T = context.getBean(type.java)
override fun <T : Any> getInstance(type: KClass<T>, name: String): T = context.getBean(name, type.java)
}
}
FX.dicontainer = object : DIContainer {
override fun <T : Any> getInstance(type: KClass<T>): T = context.getBean(type.java)
override fun <T : Any> getInstance(type: KClass<T>, name: String): T = context.getBean(name, type.java)
}
}
override fun stop() {
super.stop()
context.close()
mainController.clearResources()
}
override fun stop() {
super.stop()
context.close()
mainController.clearResources()
}
}
@SpringBootApplication
open class CLIApp(
@Autowired private val context: ProjectContext,
@Autowired private val pipelineService: BuildPipelineService
) : CommandLineRunner {
override fun run(vararg args: String) {
ArgParser(args).parseInto(::CLIArgs).run {
project.takeIf { it != null }.let {
context.open(it!!)
}
build.takeIf { it }.let {
pipelineService.initStreams(System.out, System.err)
val startTime = System.currentTimeMillis()
try {
context.project?.let { pipelineService.runPipeline(it) }
println("Build completed")
} catch (e: BuildException) {
System.err.println("Build failed")
} finally {
val buildingTime = (System.currentTimeMillis() - startTime) / 1000.0
println("Finished in [${buildingTime}s]")
}
}
}
}
}
fun main(args: Array<String>) {
launch<EditorApp>(args)
ArgParser(args).parseInto(::CLIArgs).run {
if (headless) {
SpringApplication.run(CLIApp::class.java, *args)
} else {
launch<EditorApp>(args)
}
}
}

View File

@@ -0,0 +1,11 @@
package com.bartlomiejpluta.base.editor.cli.model
import com.xenomachina.argparser.ArgParser
import com.xenomachina.argparser.default
import java.io.File
class CLIArgs(parser: ArgParser) {
val headless by parser.flagging("-H", "--headless", help = "run editor in headless mode (without GUI)").default(false)
val project by parser.storing("-p", "--project", help = "project file") { File(this) }.default(null)
val build by parser.flagging("-b", "--build", help = "build project").default(false)
}

View File

@@ -1,12 +0,0 @@
package com.bartlomiejpluta.base.editor.code.build.pipeline
import javafx.beans.property.BooleanProperty
import javafx.concurrent.Task
import java.io.OutputStream
interface BuildPipelineService {
fun initStreams(stdout: OutputStream, stderr: OutputStream)
val isRunningProperty: BooleanProperty
fun build(): Task<Boolean>
fun clean()
}

View File

@@ -1,156 +0,0 @@
package com.bartlomiejpluta.base.editor.code.build.pipeline
import com.bartlomiejpluta.base.editor.code.build.asset.AssetSerializer
import com.bartlomiejpluta.base.editor.code.build.compiler.Compiler
import com.bartlomiejpluta.base.editor.code.build.database.DatabaseAssembler
import com.bartlomiejpluta.base.editor.code.build.exception.BuildException
import com.bartlomiejpluta.base.editor.code.build.game.GameEngineProvider
import com.bartlomiejpluta.base.editor.code.build.generator.CodeGenerator
import com.bartlomiejpluta.base.editor.code.build.packager.JarPackager
import com.bartlomiejpluta.base.editor.code.build.project.ProjectAssembler
import com.bartlomiejpluta.base.editor.code.dependency.DependenciesProvider
import com.bartlomiejpluta.base.editor.event.ClearBuildLogsEvent
import com.bartlomiejpluta.base.editor.file.model.FileSystemNode
import com.bartlomiejpluta.base.editor.project.context.ProjectContext
import com.bartlomiejpluta.base.editor.project.model.Project
import javafx.beans.property.SimpleObjectProperty
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.stereotype.Component
import tornadofx.*
import tornadofx.FX.Companion.eventbus
import java.io.OutputStream
import java.io.PrintStream
@Component
class DefaultBuildPipelineService : BuildPipelineService {
@Autowired
private lateinit var dependenciesProvider: DependenciesProvider
@Autowired
private lateinit var generators: List<CodeGenerator>
@Autowired
private lateinit var compiler: Compiler
@Autowired
private lateinit var packager: JarPackager
@Autowired
private lateinit var engineProvider: GameEngineProvider
@Autowired
private lateinit var assetSerializer: AssetSerializer
@Autowired
private lateinit var projectAssembler: ProjectAssembler
@Autowired
private lateinit var databaseAssembler: DatabaseAssembler
@Autowired
private lateinit var projectContext: ProjectContext
private val latchProperty = SimpleObjectProperty<Latch?>()
private var latch by latchProperty
private lateinit var stdout: OutputStream
private lateinit var stderr: OutputStream
private lateinit var out: PrintStream
private lateinit var err: PrintStream
override fun initStreams(stdout: OutputStream, stderr: OutputStream) {
this.stdout = stdout
this.stderr = stderr
this.out = PrintStream(stdout)
this.err = PrintStream(stderr)
}
override val isRunningProperty = false.toProperty()
private var isRunning by isRunningProperty
init {
latchProperty.addListener { _, _, latch ->
when (latch) {
null -> isRunning = false
else -> isRunningProperty.bind(latch.lockedProperty())
}
}
}
override fun build() = runAsync {
latch?.locked?.takeIf { it }?.let {
cancel()
return@runAsync false
}
latch = Latch()
val startTime = System.currentTimeMillis()
try {
projectContext.project?.let(this@DefaultBuildPipelineService::runPipeline)
out.println("Build completed")
return@runAsync true
} catch (e: BuildException) {
err.println("Build failed")
} finally {
latch?.release()
val buildingTime = (System.currentTimeMillis() - startTime) / 1000.0
out.println("Finished in [${buildingTime}s]")
}
false
}
private fun runPipeline(project: Project) {
eventbus.fire(ClearBuildLogsEvent)
prepareBuildDirectory(project)
val outputFile = project.buildOutputJarFile
out.println("Providing compile-time dependencies...")
val dependencies = dependenciesProvider.provideDependenciesTo(project.buildDependenciesDirectory)
out.println("Generating sources...")
generators.forEach(CodeGenerator::generate)
out.println("Compiling sources...")
compiler.compile(
arrayOf(project.codeFSNode, FileSystemNode(project.buildGeneratedCodeDirectory)),
project.buildClassesDirectory,
dependencies.toTypedArray(),
out,
err
)
out.println("Assembling game engine...")
engineProvider.provideBaseGameEngine(outputFile, out, err)
out.println("Linking compilation units...")
packager.pack(project.buildClassesDirectory, outputFile, "BOOT-INF/classes")
out.println("Serializing project assets...")
assetSerializer.serializeAssets(project)
out.println("Assembling project assets...")
projectAssembler.assembly(project, outputFile, out, err)
out.println("Assembling database...")
databaseAssembler.assembly(project, outputFile, out, err)
}
private fun prepareBuildDirectory(project: Project) {
project.buildDirectory.deleteRecursively()
project.buildClassesDirectory.mkdirs()
project.buildOutDirectory.mkdirs()
project.buildDependenciesDirectory.mkdirs()
project.buildGeneratedCodeDirectory.mkdirs()
}
override fun clean() {
projectContext.project?.apply { buildDirectory.deleteRecursively() }
out.println("Cleaning done")
}
}

View File

@@ -1,13 +1,13 @@
package com.bartlomiejpluta.base.editor.code.view.build
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildPipelineService
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildService
import com.bartlomiejpluta.base.editor.common.logs.component.LogsPane
import com.bartlomiejpluta.base.editor.event.ClearBuildLogsEvent
import org.kordamp.ikonli.javafx.FontIcon
import tornadofx.*
class BuildLogsView : View() {
private val pipelineService: BuildPipelineService by di()
private val pipelineService: BuildService by di()
private val logsPane = LogsPane()

View File

@@ -1,6 +1,6 @@
package com.bartlomiejpluta.base.editor.main.view
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildPipelineService
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildService
import com.bartlomiejpluta.base.editor.main.controller.MainController
import com.bartlomiejpluta.base.editor.process.runner.app.ApplicationRunner
import com.bartlomiejpluta.base.editor.project.context.ProjectContext
@@ -10,7 +10,7 @@ import tornadofx.*
class MainMenuView : View() {
private val mainController: MainController by di()
private val projectContext: ProjectContext by di()
private val buildPipelineService: BuildPipelineService by di()
private val buildPipelineService: BuildService by di()
private val applicationRunner: ApplicationRunner by di()
override val root = menubar {

View File

@@ -1,6 +1,6 @@
package com.bartlomiejpluta.base.editor.process.runner.app
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildPipelineService
import com.bartlomiejpluta.base.editor.code.build.pipeline.BuildService
import com.bartlomiejpluta.base.editor.event.ClearProcessLogsEvent
import com.bartlomiejpluta.base.editor.process.runner.jar.JarRunner
import com.bartlomiejpluta.base.editor.project.context.ProjectContext
@@ -24,7 +24,7 @@ class DefaultApplicationRunner : ApplicationRunner {
private lateinit var projectContext: ProjectContext
@Autowired
private lateinit var pipelineService: BuildPipelineService
private lateinit var pipelineService: BuildService
@Autowired
private lateinit var jarRunner: JarRunner

View File

@@ -457,6 +457,26 @@
"hash": "sha256-VKNPqFAqRryQ79tJJiYAWR+oC/mjT1pMeYMRrsFsqXc="
}
},
"com.xenomachina:kotlin-argparser:2.0.7": {
"kotlin-argparser-2.0.7.jar": {
"url": "https://repo.maven.apache.org/maven2/com/xenomachina/kotlin-argparser/2.0.7/kotlin-argparser-2.0.7.jar",
"hash": "sha256-/wMS6nwU/l7OjE5hf6hVpAj5NvtFPDxb49fVfnoUN1M="
},
"kotlin-argparser-2.0.7.pom": {
"url": "https://repo.maven.apache.org/maven2/com/xenomachina/kotlin-argparser/2.0.7/kotlin-argparser-2.0.7.pom",
"hash": "sha256-Oi3hHJvOk2WolEAvp3fmbPgolrHpB86tWShPAjrfhvI="
}
},
"com.xenomachina:xenocom:0.0.7": {
"xenocom-0.0.7.jar": {
"url": "https://repo.maven.apache.org/maven2/com/xenomachina/xenocom/0.0.7/xenocom-0.0.7.jar",
"hash": "sha256-xiQmUrnoLXzk6BHDz3YCWC+46NyRk7PLfzR14CCqaNE="
},
"xenocom-0.0.7.pom": {
"url": "https://repo.maven.apache.org/maven2/com/xenomachina/xenocom/0.0.7/xenocom-0.0.7.pom",
"hash": "sha256-tN/7gDFK2W32lbNKB6orVLVoGNLziKKoE/h1ExDqF2s="
}
},
"com.zaxxer:HikariCP:5.0.0": {
"HikariCP-5.0.0.jar": {
"url": "https://repo.maven.apache.org/maven2/com/zaxxer/HikariCP/5.0.0/HikariCP-5.0.0.jar",

View File

@@ -18,3 +18,4 @@ apacheCommonsVersion=3.6.1
h2Version=1.4.200
hikariVersion=5.0.0
javaPoetVersion=1.13.0
kotlinArgParserVersion=2.0.7