Make engine multiplatform (incomplete)

I've only performed basic steps to allow the engine to be multiplatform.
Major classes such as FileAccess, various Stream implementations and so on need to be updated accordingly.

ansi/build.gradle.kts

@@ -17,8 +17,12 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-// Dependencies
+kotlin {
-dependencies {
+    // Dependencies
-    // sos!engine
+    sourceSets {
-    implementation(project(":base"))
+        commonMain.dependencies {
+            // sos!engine
+            implementation(project(":base"))
+        }
+    }
 }

ansi/src/commonMain/kotlin/de/staropensource/engine/ansi/AnsiFormatter.kt

@@ -21,6 +21,7 @@ package de.staropensource.engine.ansi
 
 import de.staropensource.engine.ansi.AnsiSubsystem.Companion.logger
 import de.staropensource.engine.base.implementable.formatter.TwoCycleFormatterImpl
+import kotlin.jvm.JvmStatic
 
 /**
  * Formats a string using ANSI

ansi/src/commonMain/kotlin/de/staropensource/engine/ansi/AnsiSubsystem.kt

@@ -24,6 +24,7 @@ import de.staropensource.engine.base.implementable.Subsystem
 import de.staropensource.engine.base.logging.Logger
 import de.staropensource.engine.base.type.logging.ChannelSettings
 import de.staropensource.engine.base.utility.dnihbd.BuildInformation
+import kotlin.jvm.JvmStatic
 
 /**
  * The ANSI subsystem.

base/build.gradle.kts

@@ -17,8 +17,12 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-// Dependencies
+kotlin {
-dependencies {
+    // Dependencies
-    // OSHI
+    sourceSets {
-    implementation("${property("dependencyOshiIdentifier") as String}:${property("dependencyOshiVersion") as String}")
+        jvmMain.dependencies {
+            // OSHI
+            implementation("${property("dependencyOshiIdentifier") as String}:${property("dependencyOshiVersion") as String}")
+        }
+    }
 }

base/src/commonMain/kotlin/de/staropensource/engine/base/Engine.kt

@@ -27,6 +27,7 @@ import de.staropensource.engine.base.utility.FileAccess
 import de.staropensource.engine.base.utility.dnihbd.BuildInformation
 import java.nio.charset.Charset
 import java.nio.charset.StandardCharsets
+import kotlin.jvm.JvmStatic
 import kotlin.reflect.KClass
 
 /**
@@ -50,6 +51,7 @@ class Engine private constructor() {
          *
          * @since v1-alpha10
          */
+        @JvmStatic
         internal val logger: Logger = Logger(channel = "engine-core")
 
         /**
@@ -57,6 +59,7 @@ class Engine private constructor() {
          *
          * @since v1-alpha10
          */
+        @JvmStatic
         var state: State = State.UNINITIALIZED
             internal set
 
@@ -73,6 +76,7 @@ class Engine private constructor() {
          * @see bootstrap
          * @since v1-alpha10
          */
+        @JvmStatic
         var bootstrapping: Boolean? = null
 
         /**
@@ -81,6 +85,7 @@ class Engine private constructor() {
          * @see Subsystem
          * @since v1-alpha10
          */
+        @JvmStatic
         private val subsystems: MutableSet<Subsystem> = mutableSetOf()
 
         /**
@@ -91,6 +96,7 @@ class Engine private constructor() {
          * @see BuildInformation
          * @since v1-alpha10
          */
+        @JvmStatic
         var info: BuildInformation? = null
 
 
@@ -102,6 +108,7 @@ class Engine private constructor() {
          * @return array of registered [Subsystem]s
          * @since v1-alpha10
          */
+        @JvmStatic
         fun getSubsystems(): Array<Subsystem> = subsystems.toTypedArray()
 
         /**
@@ -110,11 +117,14 @@ class Engine private constructor() {
          *
          * @since v1-alpha10
          */
-        fun getSubsystem(subsystemClass: KClass<out Subsystem>): Subsystem? = getSubsystems().find { subsystem -> try {
+        @JvmStatic
-            subsystem::class.qualifiedName!! == subsystemClass.qualifiedName!!
+        fun getSubsystem(subsystemClass: KClass<out Subsystem>): Subsystem? {
-        } catch (_: NullPointerException) {
+            return getSubsystems().find { subsystem -> try {
-            false
+                subsystem::class.qualifiedName!! == subsystemClass.qualifiedName!!
-        } }
+            } catch (_: NullPointerException) {
+                false
+            } }
+        }
 
         /**
          * Registers the specified subsystem.
@@ -128,6 +138,7 @@ class Engine private constructor() {
          * @see Subsystem
          * @since v1-alpha10
          */
+        @JvmStatic
         fun registerSubsystem(subsystem: Subsystem) {
             // Check for state
             if (bootstrapping == true)

base/src/commonMain/kotlin/de/staropensource/engine/base/EngineConfiguration.kt

@@ -35,6 +35,7 @@ import de.staropensource.engine.base.type.logging.Feature
 import de.staropensource.engine.base.type.logging.Level
 import de.staropensource.engine.base.type.logging.OperationMode
 import kotlinx.datetime.TimeZone
+import kotlin.jvm.JvmStatic
 import kotlin.reflect.KClass
 
 /**

base/src/commonMain/kotlin/de/staropensource/engine/base/annotation/NonKotlinContact.kt

@@ -25,10 +25,9 @@ package de.staropensource.engine.base.annotation
  * the public API.
  *
  * Using anything non-Kotlin in conjunction with
- * the StarOpenSource Engine is highly discouraged,
+ * the StarOpenSource Engine is highly
- * as the engine may be multiplatform in future
+ * discouraged, as the engine is optimized for
- * releases and will not support using other
+ * multiplatform usage.
- * languages.
  *
  * Using anything in contact with non-Kotlin code
  * is therefore deemed unsafe and should be

base/src/commonMain/kotlin/de/staropensource/engine/base/implementable/formatter/TwoCycleFormatterImpl.kt

@@ -44,7 +44,7 @@ import kotlin.text.iterator
  * @since v1-alpha10
  */
 abstract class TwoCycleFormatterImpl: TwoCycleFormatter() {
-    @Suppress("NestedBlockDepth")
+    @Suppress("NestedBlockDepth", "CyclomaticComplexMethod")
     override fun parse(message: String): Array<String> {
         val components: MutableList<String> = mutableListOf()
         var currentComponent: StringBuilder = StringBuilder()

base/src/commonMain/kotlin/de/staropensource/engine/base/implementable/logging/LoggerThreadingHandler.kt

@@ -19,7 +19,6 @@
 
 package de.staropensource.engine.base.implementable.logging
 
-import de.staropensource.engine.base.logging.Processor
 import de.staropensource.engine.base.type.logging.Call
 
 /**

base/src/commonMain/kotlin/de/staropensource/engine/base/implementable/package-info.kt

@@ -22,4 +22,4 @@
  *
  * @since v1-alpha10
  */
-package de.staropensource.engine.base.implementable;
+package de.staropensource.engine.base.implementable

base/src/commonMain/kotlin/de/staropensource/engine/base/implementable/stream/package-info.kt

@@ -18,7 +18,7 @@
  */
 
 /**
- * [Streams].
+ * [Stream]s.
  *
  * @since v1-alpha10
  */

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/KotlinShutdownHandler.kt

@@ -20,6 +20,7 @@
 package de.staropensource.engine.base.implementation.logging
 
 import de.staropensource.engine.base.implementable.ShutdownHandler
+import kotlin.jvm.JvmStatic
 import kotlin.system.exitProcess
 
 /**

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/NoOperationFormatter.kt

@@ -21,6 +21,7 @@ package de.staropensource.engine.base.implementation.logging
 
 import de.staropensource.engine.base.implementable.formatter.Formatter
 import de.staropensource.engine.base.implementable.formatter.OneCycleFormatter
+import kotlin.jvm.JvmStatic
 import kotlin.text.iterator
 
 /**

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/adapter/PrintlnAdapter.kt

@@ -21,6 +21,7 @@ package de.staropensource.engine.base.implementation.logging.adapter
 
 import de.staropensource.engine.base.implementable.logging.Adapter
 import de.staropensource.engine.base.type.logging.Call
+import kotlin.jvm.JvmStatic
 
 /**
  * [Adapter] for printing messages

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EngineCrashCategory.kt

@@ -21,6 +21,7 @@ package de.staropensource.engine.base.implementation.logging.crashcategory
 
 import de.staropensource.engine.base.implementable.logging.CrashCategory
 import de.staropensource.engine.base.utility.dnihbd.BuildInformation
+import kotlin.jvm.JvmStatic
 
 /**
  * [CrashCategory] implementation

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/EnvironmentCrashCategory.kt

@@ -23,9 +23,7 @@ import de.staropensource.engine.base.implementable.logging.CrashCategory
 import de.staropensource.engine.base.type.logging.Call
 import de.staropensource.engine.base.type.logging.ChannelSettings
 import de.staropensource.engine.base.utility.Environment
-import kotlinx.datetime.LocalDateTime
+import kotlin.jvm.JvmStatic
-import kotlinx.datetime.TimeZone
-import kotlinx.datetime.toLocalDateTime
 
 /**
  * [CrashCategory] implementation

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/logging/crashcategory/InfoCrashCategory.kt

@@ -23,6 +23,7 @@ import de.staropensource.engine.base.implementable.logging.CrashCategory
 import de.staropensource.engine.base.type.logging.Call
 import de.staropensource.engine.base.type.logging.ChannelSettings
 import de.staropensource.engine.base.utility.misc.StackTraceUtils
+import kotlin.jvm.JvmStatic
 
 /**
  * [CrashCategory] implementation

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/stream/NullStream.kt

@@ -20,6 +20,7 @@
 package de.staropensource.engine.base.implementation.stream
 
 import de.staropensource.engine.base.implementable.stream.Stream
+import kotlin.jvm.JvmStatic
 
 /**
  * A [Stream] which does nothing

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/stream/StringReadStream.kt

@@ -29,4 +29,4 @@ import de.staropensource.engine.base.implementable.stream.Stream
  * @param stringRead string to provide for reading
  * @since v1-alpha10
  */
-open class StringReadStream(val stringRead: String) : ByteReadStream(bytesRead = stringRead.toByteArray())
+open class StringReadStream(val stringRead: String) : ByteReadStream(bytesRead = stringRead.encodeToByteArray())

base/src/commonMain/kotlin/de/staropensource/engine/base/implementation/stream/StringStream.kt

@@ -29,7 +29,7 @@ import de.staropensource.engine.base.implementable.stream.Stream
  * @param stringRead string to provide for reading
  * @since v1-alpha10
  */
-open class StringStream(val stringRead: String) : ByteStream(bytesRead = stringRead.toByteArray()) {
+open class StringStream(val stringRead: String) : ByteStream(bytesRead = stringRead.encodeToByteArray()) {
     /**
      * Returns the written string.
      *

base/src/commonMain/kotlin/de/staropensource/engine/base/logging/Filterer.kt

@@ -21,6 +21,7 @@ package de.staropensource.engine.base.logging
 
 import de.staropensource.engine.base.implementable.logging.Filter
 import de.staropensource.engine.base.type.logging.Call
+import kotlin.jvm.JvmStatic
 
 /**
  * Handles call filtering.

base/src/commonMain/kotlin/de/staropensource/engine/base/logging/Logger.kt

@@ -30,6 +30,8 @@ import de.staropensource.engine.base.type.logging.Level
 import de.staropensource.engine.base.utility.misc.StackTraceUtils
 import kotlinx.datetime.Clock
 import kotlinx.datetime.Instant
+import kotlin.jvm.JvmName
+import kotlin.jvm.JvmStatic
 
 /**
  * Frontend for sos!engine's logging system.
@@ -119,7 +121,7 @@ class Logger {
      * @param callerDepth determines the depth at which to discover the method caller
      * @since v1-alpha10
      */
-    fun log(level: Level, message: String, levelData: Map<String, Object?> = emptyMap(), callerDepth: UInt = 0u) {
+    fun log(level: Level, message: String, levelData: Map<String, Any?> = emptyMap(), callerDepth: UInt = 0u) {
         // Create 'Call' instance
         var call: Call = Call(
             StackTraceUtils.methodCaller(depth = callerDepth.plus(1u)),
@@ -130,7 +132,7 @@ class Logger {
 
         // Run processing
         if (level == Level.CRASH)
-            CrashHandler.handle(call, levelData["throwable"] as Throwable?, levelData.getOrDefault("fatal", true) as Boolean)
+            CrashHandler.handle(call, levelData["throwable"] as Throwable?, levelData.getOrElse("fatal") { true } as Boolean)
         else {
             if (Processor.check(call))
                 return
@@ -210,8 +212,8 @@ class Logger {
      */
     fun crash(error: String, throwable: Throwable? = null, fatal: Boolean = true) {
         log(Level.CRASH, error, levelData = mapOf(
-            Pair("throwable", throwable as Object?),
+            Pair("throwable", throwable as Any?),
-            Pair("fatal", fatal as Object?)
+            Pair("fatal", fatal as Any?)
         ), callerDepth = 1u)
     }
 
@@ -242,5 +244,5 @@ class Logger {
      * @return [FileAccessStream] instance
      * @since v1-alpha10
      */
-    fun toStream(level: Level): LoggerStream = stream.computeIfAbsent(level) { level -> LoggerStream(this, level) }
+    fun toStream(level: Level): LoggerStream = stream[level] ?: LoggerStream(this, level)
 }

base/src/commonMain/kotlin/de/staropensource/engine/base/logging/Processor.kt

@@ -29,6 +29,7 @@ import de.staropensource.engine.base.type.logging.ChannelSettings
 import de.staropensource.engine.base.type.logging.Feature
 import de.staropensource.engine.base.type.logging.OperationMode
 import de.staropensource.engine.base.utility.misc.StackTraceUtils
+import kotlin.jvm.JvmStatic
 import kotlin.reflect.full.primaryConstructor
 
 /**
@@ -87,7 +88,7 @@ class Processor private constructor() {
          * @param call [Call] metadata
          * @see EngineConfiguration.logThreadingHandler
          * @see ChannelSettings.formatter
-         * @see ChannelSettings.adapter
+         * @see ChannelSettings.adapters
          * @since v1-alpha10
          */
         @JvmStatic

base/src/commonMain/kotlin/de/staropensource/engine/base/type/Tristate.kt

@@ -20,6 +20,7 @@
 package de.staropensource.engine.base.type
 
 import de.staropensource.engine.base.EngineConfiguration
+import kotlin.jvm.JvmStatic
 
 /**
  * Defines a data type which can have

base/src/commonMain/kotlin/de/staropensource/engine/base/type/logging/ChannelSettings.kt

@@ -24,6 +24,7 @@ import de.staropensource.engine.base.implementable.logging.Adapter
 import de.staropensource.engine.base.implementable.formatter.Formatter
 import de.staropensource.engine.base.implementation.logging.NoOperationFormatter
 import de.staropensource.engine.base.implementation.logging.adapter.PrintlnAdapter
+import kotlin.jvm.JvmStatic
 
 /**
  * Holds the configuration of one

base/src/commonMain/kotlin/de/staropensource/engine/base/type/package-info.kt

@@ -22,4 +22,4 @@
  *
  * @since v1-alpha10
  */
-package de.staropensource.engine.base.type;
+package de.staropensource.engine.base.type

base/src/commonMain/kotlin/de/staropensource/engine/base/type/versioning/package-info.kt

@@ -23,4 +23,4 @@
  *
  * @since v1-alpha10
  */
-package de.staropensource.engine.base.type.versioning;
+package de.staropensource.engine.base.type.versioning

base/src/commonMain/kotlin/de/staropensource/engine/base/utility/DataSize.kt

@@ -23,6 +23,7 @@ import java.math.RoundingMode
 import java.text.DecimalFormat
 import java.text.DecimalFormatSymbols
 import java.util.Locale
+import kotlin.jvm.JvmStatic
 
 /**
  * Converts between various data size units.

base/src/commonMain/kotlin/de/staropensource/engine/base/utility/Environment.kt

@@ -26,6 +26,7 @@ import kotlinx.datetime.Instant
 import oshi.PlatformEnum
 import oshi.SystemInfo
 import oshi.hardware.HardwareAbstractionLayer
+import kotlin.jvm.JvmStatic
 
 /**
  * Provides information about the

base/src/commonMain/kotlin/de/staropensource/engine/base/utility/FileAccess.kt

@@ -36,6 +36,7 @@ import java.io.IOException
 import java.nio.file.*
 import java.nio.file.attribute.BasicFileAttributes
 import java.nio.file.attribute.PosixFilePermissions
+import kotlin.jvm.JvmStatic
 
 /**
  * Provides a simplified way of

base/src/commonMain/kotlin/de/staropensource/engine/base/utility/package-info.kt

@@ -22,4 +22,4 @@
  *
  * @since v1-alpha10
  */
-package de.staropensource.engine.base.utility;
+package de.staropensource.engine.base.utility

base/src/commonMain/kotlin/de/staropensource/engine/package-info.kt

@@ -25,4 +25,4 @@
  *
  * @since v1-alpha10
  */
-package de.staropensource.engine;
+package de.staropensource.engine

build.gradle.kts

@@ -48,7 +48,7 @@ plugins {
     id("maven-publish")
 
     // Kotlin support
-    id("org.jetbrains.kotlin.jvm") version("2.0.0")
+    id("org.jetbrains.kotlin.multiplatform") version("2.0.0")
 
     // Dokka
     id("org.jetbrains.dokka") version("1.9.20")
@@ -67,7 +67,7 @@ allprojects {
     // Plugins
     apply(plugin = "java-library")
     apply(plugin = "maven-publish")
-    apply(plugin = "org.jetbrains.kotlin.jvm")
+    apply(plugin = "org.jetbrains.kotlin.multiplatform")
     apply(plugin = "org.jetbrains.dokka")
     apply(plugin = "com.gorylenko.gradle-git-properties")
     apply(plugin = "ca.solo-studios.nyx")
@@ -125,12 +125,7 @@ allprojects {
             withDistributeLicense()
             encoding = "UTF-8"
             withZip64()
-            withBuildDependsOnJar()
             withSuppressWarnings()
-            jvmToolchain = (property("languageJava") as String).toInt()
-            jvmTarget = (property("languageJava") as String).toInt()
-            withSourcesJar()
-            withJavadocJar()
             withReproducibleBuilds()
 
             // Kotlin-specific settings
@@ -141,6 +136,14 @@ allprojects {
                     "-progressive"
                 )
             }
+
+            // JVM-specific settings
+            java {
+                jvmToolchain = (property("languageJava") as String).toInt()
+                jvmTarget = (property("languageJava") as String).toInt()
+                //withSourcesJar()
+                withJavadocJar()
+            }
         }
     }
 
@@ -150,22 +153,31 @@ allprojects {
         mavenCentral()
     }
 
-    // Dependencies
+    // Kotlin
-    dependencies {
+    kotlin {
-        // Kotlin support
+        // Targets
-        implementation("${property("dependencyKotlin_ReflectIdentifier") as String}:${property("dependencyKotlinVersion") as String}")
+        // -> JVM
-        implementation("${property("dependencyKotlin_CoroutinesIdentifier") as String}:${property("dependencyKotlin_CoroutinesVersion") as String}")
+        jvm()
-        implementation("${property("dependencyKotlin_DateTimeIdentifier") as String}:${property("dependencyKotlin_DateTimeVersion") as String}")
+        // -> Native
+        linuxX64()
+        linuxArm64()
+        mingwX64()
 
-        // Unit testing
+        // Dependencies
-        // -> Kotlin
+        sourceSets {
-        testImplementation(kotlin("test"))
+            commonMain.dependencies {
-        // -> JUnit
+                // Kotlin support
-        testImplementation(platform("${property("testDependencyJUnit_BOMIdentifier")}:${property("testDependencyJUnitVersion")}"))
+                implementation("${property("dependencyKotlin_ReflectIdentifier") as String}:${property("dependencyKotlinVersion") as String}")
-        testImplementation("${property("testDependencyJUnit_JupiterIdentifier")}")
+                implementation("${property("dependencyKotlin_CoroutinesIdentifier") as String}:${property("dependencyKotlin_CoroutinesVersion") as String}")
-        testRuntimeOnly("${property("testDependencyJUnit_PlatformIdentifier")}")
+                implementation("${property("dependencyKotlin_DateTimeIdentifier") as String}:${property("dependencyKotlin_DateTimeVersion") as String}")
-        // -> sos!engine
+            }
-        testImplementation(project(":testing"))
+            commonTest.dependencies {
+                // -> Kotlin
+                implementation(kotlin("test"))
+                // -> sos!engine
+                implementation(project(":testing"))
+            }
+        }
     }
 
     // Unit testing

dist/detekt.yml

@@ -28,6 +28,8 @@ complexity:
 naming:
   MemberNameEqualsClassName:
     active: false
+  MatchingDeclarationName:
+    active: false
 
 exceptions:
   SwallowedException:

settings.gradle.kts

@@ -1,5 +1,3 @@
-import java.net.URI
-
 /*
  * STAROPENSOURCE ENGINE SOURCE FILE
  * Copyright (c) 2024 The StarOpenSource Engine Authors

testapp/build.gradle.kts

@@ -24,11 +24,15 @@ plugins {
     id("com.gradleup.shadow") version ("8.3.5")
 }
 
-// Dependencies
+kotlin {
-dependencies {
+    // Dependencies
-    // sos!engine
+    sourceSets {
-    implementation(project(":base"))
+        commonMain.dependencies {
-    implementation(project(":ansi"))
+            // sos!engine
+            implementation(project(":base"))
+            implementation(project(":ansi"))
+        }
+    }
 }
 
 // Configure JAR

testapp/src/commonMain/kotlin/de/staropensource/engine/testapp/Main.kt

@@ -24,6 +24,7 @@ import de.staropensource.engine.base.Engine
 import de.staropensource.engine.base.EngineConfiguration
 import de.staropensource.engine.base.logging.Logger
 import de.staropensource.engine.base.type.logging.Level
+import kotlin.jvm.JvmStatic
 
 /**
  * Testing program for the StarOpenSource Engine.