The first iteration of lin-bus NBT editor

Author: octylFractal

gradle/libs.versions.toml

@@ -1,7 +1,40 @@
+[versions]
+javafx = "22.0.2"
+tinylog = "2.7.0"
+
 [libraries]
 jspecify-annotations = "org.jspecify:jspecify:0.3.0"
 guava = "com.google.guava:guava:31.0.1-jre"
-junit-bom = "org.junit:junit-bom:5.10.2"
+
+ikonli-bom = "org.kordamp.ikonli:ikonli-bom:12.3.1"
+ikonli-javafx.module = "org.kordamp.ikonli:ikonli-javafx"
+ikonli-fontawesome5.module = "org.kordamp.ikonli:ikonli-fontawesome5-pack"
+
+junit-bom = "org.junit:junit-bom:5.10.3"
 junit-jupiter-api.module = "org.junit.jupiter:junit-jupiter-api"
 junit-jupiter-engine.module = "org.junit.jupiter:junit-jupiter-engine"
-truth = "com.google.truth:truth:1.4.2"
+truth = "com.google.truth:truth:1.4.4"
+
+[libraries.tinylog-api]
+module = "org.tinylog:tinylog-api"
+version.ref = "tinylog"
+
+[libraries.tinylog-impl]
+module = "org.tinylog:tinylog-impl"
+version.ref = "tinylog"
+
+[libraries.tinylog-slf4j-impl]
+module = "org.tinylog:slf4j-tinylog"
+version.ref = "tinylog"
+
+[libraries.javafx-base]
+module = "org.openjfx:javafx-base"
+version.ref = "javafx"
+
+[libraries.javafx-controls]
+module = "org.openjfx:javafx-controls"
+version.ref = "javafx"
+
+[libraries.javafx-graphics]
+module = "org.openjfx:javafx-graphics"
+version.ref = "javafx"

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,12 @@
+lin-bus NBT editor
+==================
+
+This is a JavaFX-based editor for NBT files. It serves as an example of what you can do with this API, as well as a 
+modern editor for NBT files. It is not yet feature-complete on the editing side, but it works great to view files.
+
+## TODO
+
+- Add/remove entries
+- Undo/redo changes
+- Refine editing UX/design
+- Right-click menus for easier access to common actions

gradlew

@@ -2,53 +2,60 @@ plugins {
     java
     application
     id("com.google.osdetector") version "1.7.0"
+    id("org.enginehub.lin-bus.jvm")
+    id("org.enginehub.lin-bus.publishing")
 }
 
 java {
-     toolchain.languageVersion.set(JavaLanguageVersion.of(21))
+    toolchain.languageVersion.set(JavaLanguageVersion.of(21))
 }
 
 application {
-    mainClass.set("org.enginehub.linbus.gui.LinBusGui")
     mainModule.set("org.enginehub.linbus.gui")
 }
 
 repositories {
     maven {
         name = "Sonatype Snapshots"
         url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
-    }
-}
-
-configurations.all {
-    resolutionStrategy.dependencySubstitution {
-        val injectApi = libs.jakarta.injectApi.get()
-        substitute(module("javax.inject:javax.inject:1"))
-            .using(module(
-                "${injectApi.module.group}:${injectApi.module.name}:${injectApi.versionConstraint.requiredVersion}"
-            ))
+        mavenContent {
+            snapshotsOnly()
+        }
     }
 }
 
 dependencies {
-    compileOnly(libs.jetbrains.annotations)
-    compileOnly(libs.polymerization.annotations)
+    compileOnly(libs.jspecify.annotations)
 
-    annotationProcessor(libs.dagger.compiler)
-    annotationProcessor(libs.polymerization.processor)
-
-    implementation(project(":core"))
-    implementation(libs.dagger.core)
+    implementation(project(":tree"))
     implementation(libs.guava)
+    implementation(libs.tinylog.api)
+    runtimeOnly(libs.tinylog.impl)
+    runtimeOnly(libs.tinylog.slf4j.impl)
 
     for (lib in listOf(libs.javafx.base, libs.javafx.controls, libs.javafx.graphics)) {
         implementation(lib)
         implementation(variantOf(lib) {
             classifier(
                 when (osdetector.os) {
-                    "osx" -> "mac"
-                    "windows" -> "win"
-                    else -> "linux"
+                    "osx" -> when (osdetector.arch) {
+                        "x86_64" -> "mac"
+                        "aarch_64" -> "mac-aarch64"
+                        else -> error("Unsupported architecture: ${osdetector.arch}")
+                    }
+
+                    "windows" -> when (osdetector.arch) {
+                        "x86_64" -> "win"
+                        else -> error("Unsupported architecture: ${osdetector.arch}")
+                    }
+
+                    "linux" -> when (osdetector.arch) {
+                        "x86_64" -> "linux"
+                        "aarch_64" -> "linux-aarch64"
+                        else -> error("Unsupported architecture: ${osdetector.arch}")
+                    }
+
+                    else -> error("Unsupported OS: ${osdetector.os}")
                 }
             )
         })
@@ -67,15 +74,19 @@ dependencies {
     }
 }
 
-tasks.withType<JavaCompile>().configureEach {
-    options.compilerArgs.add("--enable-preview")
+tasks.compileJava {
+    options.javaModuleMainClass = "org.enginehub.linbus.gui.LinBusGui"
+}
+
+tasks.javadoc {
+    (options as CoreJavadocOptions).addBooleanOption("Xdoclint:-missing").value = true
 }
 
 tasks.test {
     useJUnitPlatform()
-    jvmArgs("-Dglass.disableThreadChecks=true", "--enable-preview")
 }
 
-tasks.named<JavaExec>("run").configure {
-    jvmArgs("-Dglass.disableThreadChecks=true", "--enable-preview")
+tasks.named<JavaExec>("run") {
+    // Allow scenic-view hooking
+    jvmArgs("-XX:+EnableDynamicAgentLoading")
 }

gradlew.bat

@@ -1,3 +1,5 @@
+import org.jspecify.annotations.NullMarked;
+
 /*
  * Copyright (c) EngineHub <https://enginehub.org>
  * Copyright (c) contributors
@@ -15,17 +17,17 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-
+@NullMarked
 module org.enginehub.linbus.gui {
-    exports org.enginehub.linbus.gui;
-    requires static java.inject;
-    requires static net.octyl.polymer.annotations;
-    requires dagger;
+    exports org.enginehub.linbus.gui to javafx.graphics;
+
     requires com.google.common;
     requires java.base;
     requires javafx.controls;
-    requires org.enginehub.linbus.core;
+    requires org.enginehub.linbus.stream;
+    requires org.enginehub.linbus.tree;
     requires org.kordamp.ikonli.core;
     requires org.kordamp.ikonli.javafx;
     requires org.kordamp.ikonli.fontawesome5;
+    requires org.tinylog.api;
 }

gui/README.md

@@ -19,26 +19,58 @@
 package org.enginehub.linbus.gui;
 
 import javafx.application.Application;
+import javafx.beans.binding.Bindings;
 import javafx.stage.Stage;
-import org.enginehub.linbus.gui.inject.ApplicationComponent;
-import org.enginehub.linbus.gui.inject.DaggerApplicationComponent;
+import org.enginehub.linbus.gui.javafx.MainSceneSetup;
+import org.tinylog.Logger;
+
+import java.nio.file.Path;
+import java.util.Objects;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
 
 public class LinBusGui extends Application {
+    public static final String TITLE_BASE = "lin-bus NBT Editor";
+
+    private final ExecutorService backgroundExecutor = Executors.newCachedThreadPool();
+
     public static void main(String[] args) {
         launch(args);
     }
 
-    private final ApplicationComponent component = DaggerApplicationComponent.create();
 
     @Override
     public void start(Stage stage) {
-        stage.setTitle("LIN Bus NBT Editor");
-        stage.setScene(
-            component.fxDef()
-                .primaryStage(stage)
-                .build()
-                .mainScene()
+        MainSceneSetup factory = new MainSceneSetup(stage, backgroundExecutor);
+        factory.mainScene.getStylesheets().add(
+            Objects.requireNonNull(
+                getClass().getResource("/org/enginehub/linbus/gui/css/all.css"),
+                "Could not find CSS file"
+            ).toExternalForm()
         );
+
+        stage.setOnCloseRequest(event -> {
+            if (!factory.checkExitOkay()) {
+                event.consume();
+            }
+        });
+        stage.titleProperty().bind(Bindings.createStringBinding(() -> {
+            Path path = factory.openPath.get();
+            if (path == null) {
+                return TITLE_BASE;
+            }
+            boolean modified = factory.isModified.get();
+            return TITLE_BASE + " - " + path.getFileName() + (modified ? " (modified)" : "");
+        }, factory.openPath, factory.isModified));
+        stage.setScene(factory.mainScene);
         stage.show();
     }
+
+    @Override public void stop() throws Exception {
+        backgroundExecutor.shutdownNow();
+        if (!backgroundExecutor.awaitTermination(1, TimeUnit.MINUTES)) {
+            Logger.error("Background executor did not shut down in time");
+        }
+    }
 }