diff --git a/CHANGELOG.md b/CHANGELOG.md index d1b5538a..dd4bb190 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,22 @@ Changelog structure reference: ## [Unreleased] +## [25.0.0] + +### Fixed + +- Project + - Zig.iml file created in every project + +### Changed + +- Project + - BREAKING MAJOR UPDATE: Fully reworked toolchain and language server management + The configuration menu is now very similar to the intellij java toolchain management, + with proper toolchain selection, detection, downloading, etc. This change will require + you to re-configure your toolchains! + - Zig external library root is now no longer shown if zig is not configured + ## [24.0.1] ### Added diff --git a/LICENSE b/LICENSE index 2d0c7b3b..22ea4295 100644 --- a/LICENSE +++ b/LICENSE @@ -25,6 +25,11 @@ which are the property of the Zig Software Foundation. (https://github.com/ziglang/logo) These art assets are licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). -------------------------------- +The art assets inside src/art/zls, and all copies of them, are derived from the Zig Language Server, +which are the property of the zigtools organization. +(https://github.com/zigtools/zls) +These art assets are licensed under MIT license. +-------------------------------- Parts of the codebase are based on the intellij-zig plugin, developed by HTGAzureX1212 (https://github.com/HTGAzureX1212), licensed under the Apache 2.0 license. -------------------------------- @@ -37,4 +42,5 @@ All of the licenses listed here are available in the following files, bundled wi - licenses/CC_BY_SA_4.0.LICENSE - licenses/GPL3.LICENSE - licenses/INTELLIJ-RUST.LICENSE -- licenses/LGPL3.LICENSE \ No newline at end of file +- licenses/LGPL3.LICENSE +- licenses/ZLS.LICENSE \ No newline at end of file diff --git a/README.md b/README.md index 833018fb..289a7aa2 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,7 @@ excellent example on how to write debugger support that doesn't depend on CLion. Adds support for the Zig Language, utilizing the ZLS language server for advanced coding assistance. -## Quick setup guide for Zig and ZLS - -1. Download the latest version of Zig from https://ziglang.org/download -2. Download and compile the ZLS language server, available at https://github.com/zigtools/zls -3. Go to `Settings` -> `Languages & Frameworks` -> `Zig`, and point the `Toolchain Location` and `ZLS path` to the correct places +Before you can properly use the plugin, you need to select or download the Zig toolchain and language server in `Settings` -> `Languages & Frameworks` -> `Zig`. ## Debugging @@ -89,6 +85,7 @@ Debugging Zig code is supported in any native debugging capable IDE. The followi - RustRover (including the non-commercial free version too) - GoLand - PyCharm Professional +- Android Studio Additionally, in CLion, the plugin uses the C++ Toolchains for sourcing the debugger (this can be toggled off in the settings). diff --git a/build.gradle.kts b/build.gradle.kts index c19f1955..c16bf772 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -8,7 +8,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask plugins { kotlin("jvm") version "1.9.24" apply false kotlin("plugin.serialization") version "1.9.24" apply false - id("org.jetbrains.intellij.platform") version "2.2.1" + id("org.jetbrains.intellij.platform") version "2.5.0" id("org.jetbrains.changelog") version "2.2.1" id("org.jetbrains.grammarkit") version "2022.3.2.2" apply false idea @@ -60,7 +60,6 @@ tasks { allprojects { idea { module { - isDownloadJavadoc = false isDownloadSources = true } } diff --git a/cidr/build.gradle.kts b/cidr/build.gradle.kts index ebeabea3..7cef7e43 100644 --- a/cidr/build.gradle.kts +++ b/cidr/build.gradle.kts @@ -14,6 +14,8 @@ sourceSets["main"].resources.srcDir(genOutputDir) tasks { register("downloadProps") { + onlyIfModified(true) + useETag(true) src("https://falsepattern.com/zigbrains/msvc.properties") dest(genOutputDir.map { it.file("msvc.properties") }) } @@ -27,7 +29,9 @@ dependencies { create(IntelliJPlatformType.CLion, clionVersion, useInstaller = useInstaller) bundledPlugins("com.intellij.clion", "com.intellij.cidr.base", "com.intellij.nativeDebug") } - implementation(project(":core")) + implementation(project(":core")) { + isTransitive = false + } implementation("org.eclipse.lsp4j:org.eclipse.lsp4j.debug:$lsp4jVersion") { exclude("org.eclipse.lsp4j", "org.eclipse.lsp4j") exclude("org.eclipse.lsp4j", "org.eclipse.lsp4j.jsonrpc") diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/execution/binary/ZigProfileStateBinary.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/execution/binary/ZigProfileStateBinary.kt index 4f73207f..3da81d9c 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/execution/binary/ZigProfileStateBinary.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/execution/binary/ZigProfileStateBinary.kt @@ -24,14 +24,14 @@ package com.falsepattern.zigbrains.debugger.execution.binary import com.falsepattern.zigbrains.debugger.ZigDebugBundle import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.execution.ExecutionException import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.execution.runners.ExecutionEnvironment import kotlin.io.path.pathString class ZigProfileStateBinary(environment: ExecutionEnvironment, configuration: ZigExecConfigBinary) : ZigProfileState(environment, configuration) { - override suspend fun getCommandLine(toolchain: AbstractZigToolchain, debug: Boolean): GeneralCommandLine { + override suspend fun getCommandLine(toolchain: ZigToolchain, debug: Boolean): GeneralCommandLine { val cli = GeneralCommandLine() val cfg = configuration cfg.workingDirectory.path?.let { cli.withWorkingDirectory(it) } diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/PreLaunchProcessListener.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/PreLaunchProcessListener.kt index 92b64c96..6e53c045 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/PreLaunchProcessListener.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/PreLaunchProcessListener.kt @@ -22,10 +22,7 @@ package com.falsepattern.zigbrains.debugger.runner.base -import com.falsepattern.zigbrains.project.run.ZigProcessHandler import com.falsepattern.zigbrains.shared.cli.startIPCAwareProcess -import com.falsepattern.zigbrains.shared.ipc.IPCUtil -import com.falsepattern.zigbrains.shared.ipc.ipc import com.intellij.execution.ExecutionException import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.execution.process.ProcessEvent diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugEmitBinaryInstaller.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugEmitBinaryInstaller.kt index 1f34ca3c..c73c0243 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugEmitBinaryInstaller.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugEmitBinaryInstaller.kt @@ -23,7 +23,7 @@ package com.falsepattern.zigbrains.debugger.runner.base import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.execution.configurations.PtyCommandLine @@ -34,7 +34,7 @@ import java.io.File class ZigDebugEmitBinaryInstaller>( private val profileState: ProfileState, - private val toolchain: AbstractZigToolchain, + private val toolchain: ZigToolchain, private val executableFile: File, private val exeArgs: List ): Installer { diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersBase.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersBase.kt index 038c564a..567a2700 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersBase.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersBase.kt @@ -23,7 +23,7 @@ package com.falsepattern.zigbrains.debugger.runner.base import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.util.system.CpuArch import com.jetbrains.cidr.ArchitectureType import com.jetbrains.cidr.execution.RunParameters @@ -31,7 +31,7 @@ import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration abstract class ZigDebugParametersBase>( private val driverConfiguration: DebuggerDriverConfiguration, - protected val toolchain: AbstractZigToolchain, + protected val toolchain: ZigToolchain, protected val profileState: ProfileState ): RunParameters() { override fun getDebuggerDriverConfiguration(): DebuggerDriverConfiguration { diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersEmitBinaryBase.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersEmitBinaryBase.kt index 55bca424..b1e945a8 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersEmitBinaryBase.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugParametersEmitBinaryBase.kt @@ -24,7 +24,7 @@ package com.falsepattern.zigbrains.debugger.runner.base import com.falsepattern.zigbrains.debugger.ZigDebugBundle import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.execution.ExecutionException import com.intellij.openapi.util.io.FileUtil import com.intellij.platform.util.progress.withProgressText @@ -39,7 +39,7 @@ import kotlin.io.path.isExecutable abstract class ZigDebugParametersEmitBinaryBase>( driverConfiguration: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain, + toolchain: ZigToolchain, profileState: ProfileState, ) : ZigDebugParametersBase(driverConfiguration, toolchain, profileState), PreLaunchAware { @Volatile diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugRunnerBase.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugRunnerBase.kt index 7f176753..9e9cd863 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugRunnerBase.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/base/ZigDebugRunnerBase.kt @@ -26,7 +26,7 @@ import com.falsepattern.zigbrains.debugbridge.ZigDebuggerDriverConfigurationProv import com.falsepattern.zigbrains.debugger.ZigLocalDebugProcess import com.falsepattern.zigbrains.project.execution.base.ZigProfileState import com.falsepattern.zigbrains.project.run.ZigProgramRunner -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.falsepattern.zigbrains.shared.coroutine.runInterruptibleEDT import com.falsepattern.zigbrains.shared.coroutine.withEDTContext import com.intellij.execution.DefaultExecutionResult @@ -52,7 +52,7 @@ abstract class ZigDebugRunnerBase> : ZigProgra @Throws(ExecutionException::class) override suspend fun execute( state: ProfileState, - toolchain: AbstractZigToolchain, + toolchain: ZigToolchain, environment: ExecutionEnvironment ): RunContentDescriptor? { val project = environment.project @@ -67,7 +67,7 @@ abstract class ZigDebugRunnerBase> : ZigProgra @Throws(ExecutionException::class) private suspend fun executeWithDriver( state: ProfileState, - toolchain: AbstractZigToolchain, + toolchain: ZigToolchain, environment: ExecutionEnvironment, debuggerDriver: DebuggerDriverConfiguration ): RunContentDescriptor? { @@ -113,7 +113,7 @@ abstract class ZigDebugRunnerBase> : ZigProgra protected abstract fun getDebugParameters( state: ProfileState, debuggerDriver: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain + toolchain: ZigToolchain ): ZigDebugParametersBase private class SharedConsoleBuilder(private val console: ConsoleView) : TextConsoleBuilder() { diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugParametersBinary.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugParametersBinary.kt index 95620485..887b8cf6 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugParametersBinary.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugParametersBinary.kt @@ -26,13 +26,13 @@ import com.falsepattern.zigbrains.debugger.ZigDebugBundle import com.falsepattern.zigbrains.debugger.execution.binary.ZigProfileStateBinary import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugEmitBinaryInstaller import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugParametersBase -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.execution.ExecutionException import com.jetbrains.cidr.execution.Installer import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration -class ZigDebugParametersBinary @Throws(ExecutionException::class) constructor(driverConfiguration: DebuggerDriverConfiguration, toolchain: AbstractZigToolchain, profileState: ZigProfileStateBinary) : +class ZigDebugParametersBinary @Throws(ExecutionException::class) constructor(driverConfiguration: DebuggerDriverConfiguration, toolchain: ZigToolchain, profileState: ZigProfileStateBinary) : ZigDebugParametersBase(driverConfiguration, toolchain, profileState) { private val executableFile = profileState.configuration.exePath.path?.toFile() ?: throw ExecutionException(ZigDebugBundle.message("exception.missing-exe-path")) override fun getInstaller(): Installer { diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugRunnerBinary.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugRunnerBinary.kt index 6da574e4..34f7115a 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugRunnerBinary.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/binary/ZigDebugRunnerBinary.kt @@ -27,8 +27,8 @@ import com.falsepattern.zigbrains.debugger.execution.binary.ZigProfileStateBinar import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugParametersBase import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugRunnerBase import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.execution.configurations.RunProfile import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration @@ -36,7 +36,7 @@ class ZigDebugRunnerBinary: ZigDebugRunnerBase() { override fun getDebugParameters( state: ZigProfileStateBinary, debuggerDriver: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain + toolchain: ZigToolchain ): ZigDebugParametersBase { return ZigDebugParametersBinary(debuggerDriver, LocalZigToolchain.ensureLocal(toolchain), state) } diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugParametersBuild.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugParametersBuild.kt index aa9e2e38..6dcda7be 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugParametersBuild.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugParametersBuild.kt @@ -28,7 +28,7 @@ import com.falsepattern.zigbrains.debugger.runner.base.PreLaunchProcessListener import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugEmitBinaryInstaller import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugParametersBase import com.falsepattern.zigbrains.project.execution.build.ZigProfileStateBuild -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.execution.ExecutionException import com.intellij.openapi.util.SystemInfo import com.intellij.platform.util.progress.withProgressText @@ -46,7 +46,7 @@ import kotlin.io.path.isRegularFile class ZigDebugParametersBuild( driverConfiguration: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain, + toolchain: ZigToolchain, profileState: ZigProfileStateBuild ) : ZigDebugParametersBase(driverConfiguration, toolchain, profileState), PreLaunchAware { @Volatile diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugRunnerBuild.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugRunnerBuild.kt index 575ab657..97f99cff 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugRunnerBuild.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/build/ZigDebugRunnerBuild.kt @@ -27,8 +27,8 @@ import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugRunnerBase import com.falsepattern.zigbrains.project.execution.base.ZigProfileState import com.falsepattern.zigbrains.project.execution.build.ZigExecConfigBuild import com.falsepattern.zigbrains.project.execution.build.ZigProfileStateBuild -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.execution.configurations.RunProfile import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration @@ -36,7 +36,7 @@ class ZigDebugRunnerBuild: ZigDebugRunnerBase() { override fun getDebugParameters( state: ZigProfileStateBuild, debuggerDriver: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain + toolchain: ZigToolchain ): ZigDebugParametersBase { return ZigDebugParametersBuild(debuggerDriver, LocalZigToolchain.ensureLocal(toolchain), state) } diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugParametersRun.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugParametersRun.kt index 32558668..01f9809e 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugParametersRun.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugParametersRun.kt @@ -25,11 +25,11 @@ package com.falsepattern.zigbrains.debugger.runner.run import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugEmitBinaryInstaller import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugParametersEmitBinaryBase import com.falsepattern.zigbrains.project.execution.run.ZigProfileStateRun -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.jetbrains.cidr.execution.Installer import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration -class ZigDebugParametersRun(driverConfiguration: DebuggerDriverConfiguration, toolchain: AbstractZigToolchain, profileState: ZigProfileStateRun) : +class ZigDebugParametersRun(driverConfiguration: DebuggerDriverConfiguration, toolchain: ZigToolchain, profileState: ZigProfileStateRun) : ZigDebugParametersEmitBinaryBase(driverConfiguration, toolchain, profileState) { override fun getInstaller(): Installer { return ZigDebugEmitBinaryInstaller(profileState, toolchain, executableFile, profileState.configuration.exeArgs.argsSplit()) diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugRunnerRun.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugRunnerRun.kt index 9cc440d8..492492e0 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugRunnerRun.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/run/ZigDebugRunnerRun.kt @@ -27,8 +27,8 @@ import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugRunnerBase import com.falsepattern.zigbrains.project.execution.base.ZigProfileState import com.falsepattern.zigbrains.project.execution.run.ZigExecConfigRun import com.falsepattern.zigbrains.project.execution.run.ZigProfileStateRun -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.execution.configurations.RunProfile import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration @@ -36,7 +36,7 @@ class ZigDebugRunnerRun: ZigDebugRunnerBase() { override fun getDebugParameters( state: ZigProfileStateRun, debuggerDriver: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain + toolchain: ZigToolchain ): ZigDebugParametersBase { return ZigDebugParametersRun(debuggerDriver, LocalZigToolchain.ensureLocal(toolchain), state) } diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugParametersTest.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugParametersTest.kt index 7f45423c..9044196e 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugParametersTest.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugParametersTest.kt @@ -25,11 +25,11 @@ package com.falsepattern.zigbrains.debugger.runner.test import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugEmitBinaryInstaller import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugParametersEmitBinaryBase import com.falsepattern.zigbrains.project.execution.test.ZigProfileStateTest -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.jetbrains.cidr.execution.Installer import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration -class ZigDebugParametersTest(driverConfiguration: DebuggerDriverConfiguration, toolchain: AbstractZigToolchain, profileState: ZigProfileStateTest) : +class ZigDebugParametersTest(driverConfiguration: DebuggerDriverConfiguration, toolchain: ZigToolchain, profileState: ZigProfileStateTest) : ZigDebugParametersEmitBinaryBase(driverConfiguration, toolchain, profileState) { override fun getInstaller(): Installer { return ZigDebugEmitBinaryInstaller(profileState, toolchain, executableFile, listOf()) diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugRunnerTest.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugRunnerTest.kt index f4673d6d..f01a98c7 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugRunnerTest.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/runner/test/ZigDebugRunnerTest.kt @@ -27,8 +27,8 @@ import com.falsepattern.zigbrains.debugger.runner.base.ZigDebugRunnerBase import com.falsepattern.zigbrains.project.execution.base.ZigProfileState import com.falsepattern.zigbrains.project.execution.test.ZigExecConfigTest import com.falsepattern.zigbrains.project.execution.test.ZigProfileStateTest -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.execution.configurations.RunProfile import com.jetbrains.cidr.execution.debugger.backend.DebuggerDriverConfiguration @@ -36,7 +36,7 @@ class ZigDebugRunnerTest: ZigDebugRunnerBase() { override fun getDebugParameters( state: ZigProfileStateTest, debuggerDriver: DebuggerDriverConfiguration, - toolchain: AbstractZigToolchain + toolchain: ZigToolchain ): ZigDebugParametersBase { return ZigDebugParametersTest(debuggerDriver, LocalZigToolchain.ensureLocal(toolchain), state) } diff --git a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/toolchain/ZigDebuggerToolchainService.kt b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/toolchain/ZigDebuggerToolchainService.kt index c6f01bf7..a219eef4 100644 --- a/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/toolchain/ZigDebuggerToolchainService.kt +++ b/cidr/src/main/kotlin/com/falsepattern/zigbrains/debugger/toolchain/ZigDebuggerToolchainService.kt @@ -23,6 +23,7 @@ package com.falsepattern.zigbrains.debugger.toolchain import com.falsepattern.zigbrains.debugger.ZigDebugBundle +import com.falsepattern.zigbrains.shared.Unarchiver import com.intellij.notification.Notification import com.intellij.notification.NotificationType import com.intellij.openapi.application.PathManager @@ -34,20 +35,19 @@ import com.intellij.openapi.project.Project import com.intellij.openapi.ui.DialogBuilder import com.intellij.openapi.util.SystemInfo import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.platform.util.progress.reportSequentialProgress import com.intellij.ui.BrowserHyperlinkListener import com.intellij.ui.HyperlinkLabel import com.intellij.ui.components.JBPanel import com.intellij.util.application import com.intellij.util.concurrency.annotations.RequiresEdt import com.intellij.util.download.DownloadableFileService -import com.intellij.util.io.Decompressor import com.intellij.util.system.CpuArch import com.intellij.util.system.OS import com.jetbrains.cidr.execution.debugger.CidrDebuggerPathManager import com.jetbrains.cidr.execution.debugger.backend.bin.UrlProvider import com.jetbrains.cidr.execution.debugger.backend.lldb.LLDBDriverConfiguration import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.runInterruptible import kotlinx.coroutines.withContext import java.io.IOException import java.net.URL @@ -168,7 +168,9 @@ class ZigDebuggerToolchainService { } try { - downloadAndUnArchive(baseDir, downloadableBinaries) + withContext(Dispatchers.IO) { + downloadAndUnArchive(baseDir, downloadableBinaries) + } return DownloadResult.Ok(baseDir) } catch (e: IOException) { //TODO logging @@ -207,34 +209,40 @@ class ZigDebuggerToolchainService { @Throws(IOException::class) @RequiresEdt private suspend fun downloadAndUnArchive(baseDir: Path, binariesToDownload: List) { - val service = DownloadableFileService.getInstance() + reportSequentialProgress { reporter -> + val service = DownloadableFileService.getInstance() - val downloadDir = baseDir.toFile() - downloadDir.deleteRecursively() + val downloadDir = baseDir.toFile() + downloadDir.deleteRecursively() - val descriptions = binariesToDownload.map { - service.createFileDescription(it.url, fileName(it.url)) - } - - val downloader = service.createDownloader(descriptions, "Debugger downloading") - val downloadDirectory = downloadPath().toFile() - val downloadResults = withContext(Dispatchers.IO) { - coroutineToIndicator { - downloader.download(downloadDirectory) + val descriptions = binariesToDownload.map { + service.createFileDescription(it.url, fileName(it.url)) } - } - val versions = Properties() - for (result in downloadResults) { - val downloadUrl = result.second.downloadUrl - val binaryToDownload = binariesToDownload.first { it.url == downloadUrl } - val propertyName = binaryToDownload.propertyName - val archiveFile = result.first - Unarchiver.unarchive(archiveFile.toPath(), baseDir, binaryToDownload.prefix) - archiveFile.delete() - versions[propertyName] = binaryToDownload.version - } - saveVersionsFile(baseDir, versions) + val downloader = service.createDownloader(descriptions, "Debugger downloading") + val downloadDirectory = downloadPath().toFile() + val downloadResults = reporter.sizedStep(100) { + coroutineToIndicator { + downloader.download(downloadDirectory) + } + } + val versions = Properties() + for (result in downloadResults) { + val downloadUrl = result.second.downloadUrl + val binaryToDownload = binariesToDownload.first { it.url == downloadUrl } + val propertyName = binaryToDownload.propertyName + val archiveFile = result.first + reporter.indeterminateStep { + coroutineToIndicator { + Unarchiver.unarchive(archiveFile.toPath(), baseDir, binaryToDownload.prefix) + } + } + archiveFile.delete() + versions[propertyName] = binaryToDownload.version + } + + saveVersionsFile(baseDir, versions) + } } private fun lldbUrls(): Pair? { @@ -329,38 +337,6 @@ class ZigDebuggerToolchainService { } } - private enum class Unarchiver { - ZIP { - override val extension = "zip" - override fun createDecompressor(file: Path) = Decompressor.Zip(file) - }, - TAR { - override val extension = "tar.gz" - override fun createDecompressor(file: Path) = Decompressor.Tar(file) - }, - VSIX { - override val extension = "vsix" - override fun createDecompressor(file: Path) = Decompressor.Zip(file) - }; - - protected abstract val extension: String - protected abstract fun createDecompressor(file: Path): Decompressor - - companion object { - @Throws(IOException::class) - suspend fun unarchive(archivePath: Path, dst: Path, prefix: String? = null) { - runInterruptible { - val unarchiver = entries.find { archivePath.name.endsWith(it.extension) } ?: error("Unexpected archive type: $archivePath") - val dec = unarchiver.createDecompressor(archivePath) - if (prefix != null) { - dec.removePrefixPath(prefix) - } - dec.extract(dst) - } - } - } - } - sealed class DownloadResult { class Ok(val baseDir: Path): DownloadResult() data object NoUrls: DownloadResult() diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/ZBStartup.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/ZBStartup.kt index b51e5b7f..973e7b01 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/ZBStartup.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/ZBStartup.kt @@ -22,10 +22,6 @@ package com.falsepattern.zigbrains -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.project.settings.zigProjectSettings -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain -import com.falsepattern.zigbrains.project.toolchain.ZigToolchainProvider import com.intellij.ide.BrowserUtil import com.intellij.ide.plugins.PluginManager import com.intellij.notification.Notification @@ -37,10 +33,8 @@ import com.intellij.openapi.options.Configurable import com.intellij.openapi.options.ShowSettingsUtil import com.intellij.openapi.project.Project import com.intellij.openapi.startup.ProjectActivity -import com.intellij.openapi.util.UserDataHolderBase import java.lang.reflect.Constructor import java.lang.reflect.Method -import kotlin.io.path.pathString class ZBStartup: ProjectActivity { var firstInit = true @@ -73,19 +67,6 @@ class ZBStartup: ProjectActivity { notif.notify(null) } } - //Autodetection - val zigProjectState = project.zigProjectSettings.state - if (zigProjectState.toolchainPath.isNullOrBlank()) { - val data = UserDataHolderBase() - data.putUserData(LocalZigToolchain.DIRENV_KEY, - DirenvCmd.direnvInstalled() && !project.isDefault && zigProjectState.direnv - ) - val tc = ZigToolchainProvider.suggestToolchain(project, data) ?: return - if (tc is LocalZigToolchain) { - zigProjectState.toolchainPath = tc.location.pathString - project.zigProjectSettings.state = zigProjectState - } - } } } diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvCmd.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvService.kt similarity index 59% rename from core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvCmd.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvService.kt index 6c361bae..a56cfa2b 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvCmd.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvService.kt @@ -29,23 +29,53 @@ import com.intellij.ide.impl.isTrusted import com.intellij.notification.Notification import com.intellij.notification.NotificationType import com.intellij.notification.Notifications +import com.intellij.openapi.components.* import com.intellij.openapi.project.Project import com.intellij.openapi.project.guessProjectDir +import com.intellij.openapi.util.Key +import com.intellij.openapi.util.UserDataHolder +import com.intellij.openapi.vfs.toNioPathOrNull import com.intellij.platform.util.progress.withProgressText import com.intellij.util.io.awaitExit +import com.intellij.util.xmlb.annotations.Attribute import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.withContext import kotlinx.serialization.json.Json import java.nio.file.Path +import kotlin.io.path.isRegularFile -object DirenvCmd { - suspend fun importDirenv(project: Project): Env { - if (!direnvInstalled() || !project.isTrusted()) - return emptyEnv - val workDir = project.guessProjectDir()?.toNioPath() ?: return emptyEnv +@Service(Service.Level.PROJECT) +@State( + name = "Direnv", + storages = [Storage("zigbrains.xml")] +) +class DirenvService(val project: Project): SerializablePersistentStateComponent(State()), IDirenvService { + private val mutex = Mutex() - val runOutput = run(project, workDir, "export", "json") + override val isInstalled: Boolean by lazy { + // Using the builtin stuff here instead of Env because it should only scan for direnv on the process path + PathEnvironmentVariableUtil.findExecutableInPathOnAnyOS("direnv") != null + } + + var isEnabledRaw: DirenvState + get() = state.enabled + set(value) { + updateState { + it.copy(enabled = value) + } + } + + override val isEnabled: DirenvState + get() = isEnabledRaw + + override suspend fun import(): Env { + if (!isInstalled || !project.isTrusted() || project.isDefault) + return Env.empty + val workDir = project.guessProjectDir()?.toNioPath() ?: return Env.empty + + val runOutput = run(workDir, "export", "json") if (runOutput.error) { if (runOutput.output.contains("is blocked")) { Notifications.Bus.notify(Notification( @@ -54,7 +84,7 @@ object DirenvCmd { ZigBrainsBundle.message("notification.content.direnv-blocked"), NotificationType.ERROR )) - return emptyEnv + return Env.empty } else { Notifications.Bus.notify(Notification( GROUP_DISPLAY_ID, @@ -62,22 +92,22 @@ object DirenvCmd { ZigBrainsBundle.message("notification.content.direnv-error", runOutput.output), NotificationType.ERROR )) - return emptyEnv + return Env.empty } } return if (runOutput.output.isBlank()) { - emptyEnv + Env.empty } else { Env(Json.decodeFromString>(runOutput.output)) } } - private suspend fun run(project: Project, workDir: Path, vararg args: String): DirenvOutput { + private suspend fun run(workDir: Path, vararg args: String): DirenvOutput { val cli = GeneralCommandLine("direnv", *args).withWorkingDirectory(workDir) val (process, exitCode) = withProgressText("Running ${cli.commandLineString}") { withContext(Dispatchers.IO) { - project.direnvService.mutex.withLock { + mutex.withLock { val process = cli.createProcess() val exitCode = process.awaitExit() process to exitCode @@ -94,17 +124,39 @@ object DirenvCmd { return DirenvOutput(stdOut, false) } - private const val GROUP_DISPLAY_ID = "zigbrains-direnv" - - private val _direnvInstalled by lazy { - // Using the builtin stuff here instead of Env because it should only scan for direnv on the process path - PathEnvironmentVariableUtil.findExecutableInPathOnAnyOS("direnv") != null + fun hasDotEnv(): Boolean { + if (!isInstalled) + return false + val projectDir = project.guessProjectDir()?.toNioPathOrNull() ?: return false + return envFiles.any { projectDir.resolve(it).isRegularFile() } + } + + data class State( + @JvmField + @Attribute + var enabled: DirenvState = DirenvState.Auto + ) + + companion object { + private const val GROUP_DISPLAY_ID = "zigbrains-direnv" + fun getInstance(project: Project): IDirenvService = project.service() + + private val STATE_KEY = Key.create("DIRENV_STATE") + + fun getStateFor(data: UserDataHolder?, project: Project?): DirenvState { + return data?.getUserData(STATE_KEY) ?: project?.let { getInstance(project).isEnabled } ?: DirenvState.Disabled + } + + fun setStateFor(data: UserDataHolder, state: DirenvState) { + data.putUserData(STATE_KEY, state) + } } - fun direnvInstalled() = _direnvInstalled } -suspend fun Project?.getDirenv(): Env { - if (this == null) - return emptyEnv - return DirenvCmd.importDirenv(this) -} \ No newline at end of file +sealed interface IDirenvService { + val isInstalled: Boolean + val isEnabled: DirenvState + suspend fun import(): Env +} + +private val envFiles = listOf(".envrc", ".env") \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvProjectService.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvState.kt similarity index 77% rename from core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvProjectService.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvState.kt index fec31d4a..f4c96608 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvProjectService.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/DirenvState.kt @@ -22,14 +22,19 @@ package com.falsepattern.zigbrains.direnv -import com.intellij.openapi.components.Service import com.intellij.openapi.components.service import com.intellij.openapi.project.Project -import kotlinx.coroutines.sync.Mutex -@Service(Service.Level.PROJECT) -class DirenvProjectService { - val mutex = Mutex() -} +enum class DirenvState { + Auto, + Enabled, + Disabled; -val Project.direnvService get() = service() \ No newline at end of file + fun isEnabled(project: Project?): Boolean { + return when(this) { + Enabled -> true + Disabled -> false + Auto -> project?.service()?.hasDotEnv() == true + } + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/Env.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/Env.kt index 4d695819..e94c8194 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/Env.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/Env.kt @@ -25,8 +25,9 @@ package com.falsepattern.zigbrains.direnv import com.intellij.openapi.util.SystemInfo import com.intellij.openapi.util.io.toNioPathOrNull import com.intellij.util.EnvironmentUtil -import kotlinx.coroutines.flow.firstOrNull +import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.flow.flow +import kotlinx.coroutines.flow.flowOn import org.jetbrains.annotations.NonNls import java.io.File import kotlin.io.path.absolute @@ -34,14 +35,13 @@ import kotlin.io.path.isDirectory import kotlin.io.path.isExecutable import kotlin.io.path.isRegularFile +@JvmRecord data class Env(val env: Map) { private val path get() = getVariable("PATH")?.split(File.pathSeparatorChar) private fun getVariable(name: @NonNls String) = env.getOrElse(name) { EnvironmentUtil.getValue(name) } - suspend fun findExecutableOnPATH(exe: @NonNls String) = findAllExecutablesOnPATH(exe).firstOrNull() - fun findAllExecutablesOnPATH(exe: @NonNls String) = flow { val exeName = if (SystemInfo.isWindows) "$exe.exe" else exe val paths = path ?: return@flow @@ -54,7 +54,9 @@ data class Env(val env: Map) { continue emit(exePath) } + }.flowOn(Dispatchers.IO) + + companion object { + val empty = Env(emptyMap()) } } - -val emptyEnv = Env(emptyMap()) \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/ui/DirenvEditor.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/ui/DirenvEditor.kt new file mode 100644 index 00000000..dfe3ee1f --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/direnv/ui/DirenvEditor.kt @@ -0,0 +1,101 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.direnv.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.direnv.DirenvService +import com.falsepattern.zigbrains.direnv.DirenvState +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider.Companion.PROJECT_KEY +import com.falsepattern.zigbrains.shared.SubConfigurable +import com.intellij.openapi.components.service +import com.intellij.openapi.project.Project +import com.intellij.openapi.ui.ComboBox +import com.intellij.ui.dsl.builder.Panel +import java.awt.event.ItemEvent + +abstract class DirenvEditor(private val sharedState: ZigProjectConfigurationProvider.IUserDataBridge?): SubConfigurable { + private var cb: ComboBox? = null + override fun attach(panel: Panel): Unit = with(panel) { + row(ZigBrainsBundle.message("settings.direnv.enable.label")) { + comboBox(DirenvState.entries).component.let { + cb = it + if (sharedState != null) { + it.addItemListener { e -> + if (e.stateChange != ItemEvent.SELECTED) + return@addItemListener + val item = e.item + if (item !is DirenvState) + return@addItemListener + DirenvService.setStateFor(sharedState, item) + } + } + } + } + } + + override fun isModified(context: T): Boolean { + return isEnabled(context) != cb?.selectedItem as DirenvState + } + + override fun apply(context: T) { + setEnabled(context, cb?.selectedItem as DirenvState) + } + + override fun reset(context: T?) { + if (context == null) { + cb?.selectedItem = DirenvState.Auto + return + } + cb?.selectedItem = isEnabled(context) + } + + override fun dispose() { + } + + abstract fun isEnabled(context: T): DirenvState + abstract fun setEnabled(context: T, value: DirenvState) + + class ForProject(sharedState: ZigProjectConfigurationProvider.IUserDataBridge) : DirenvEditor(sharedState) { + override fun isEnabled(context: Project): DirenvState { + return DirenvService.getInstance(context).isEnabled + } + + override fun setEnabled(context: Project, value: DirenvState) { + context.service().isEnabledRaw = value + } + } + + class Provider: ZigProjectConfigurationProvider { + override fun create(sharedState: ZigProjectConfigurationProvider.IUserDataBridge): SubConfigurable? { + if (sharedState.getUserData(PROJECT_KEY)?.isDefault != false) { + return null + } + DirenvService.setStateFor(sharedState, DirenvState.Auto) + return ForProject(sharedState) + } + + override val index: Int + get() = 100 + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/ZigConsoleBuilder.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/ZigConsoleBuilder.kt index e46a415f..df3d0f31 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/ZigConsoleBuilder.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/ZigConsoleBuilder.kt @@ -26,7 +26,6 @@ import com.intellij.execution.filters.TextConsoleBuilderImpl import com.intellij.execution.ui.ConsoleView import com.intellij.openapi.project.Project import com.intellij.terminal.TerminalExecutionConsole -import java.nio.file.Path class ZigConsoleBuilder(private val project: Project, private val emulateTerminal: Boolean = false): TextConsoleBuilderImpl(project) { override fun createConsole(): ConsoleView { diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/Configuration.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/Configuration.kt index 15e177a0..0baf28ff 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/Configuration.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/Configuration.kt @@ -24,15 +24,12 @@ package com.falsepattern.zigbrains.project.execution.base import com.falsepattern.zigbrains.ZigBrainsBundle import com.falsepattern.zigbrains.project.execution.base.ZigConfigurable.ZigConfigModule -import com.falsepattern.zigbrains.project.settings.zigProjectSettings import com.falsepattern.zigbrains.shared.cli.translateCommandline import com.falsepattern.zigbrains.shared.element.* import com.intellij.openapi.Disposable import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory import com.intellij.openapi.options.SettingsEditor -import com.intellij.openapi.project.Project import com.intellij.openapi.ui.ComboBox -import com.intellij.openapi.ui.TextBrowseFolderListener import com.intellij.openapi.util.Disposer import com.intellij.openapi.util.io.toNioPathOrNull import com.intellij.ui.components.JBCheckBox diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigExecConfig.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigExecConfig.kt index ee148595..4fc2a466 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigExecConfig.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigExecConfig.kt @@ -22,9 +22,7 @@ package com.falsepattern.zigbrains.project.execution.base -import com.falsepattern.zigbrains.ZigBrainsBundle -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.direnv.DirenvService import com.intellij.execution.ExecutionException import com.intellij.execution.Executor import com.intellij.execution.configurations.ConfigurationFactory @@ -65,8 +63,9 @@ abstract class ZigExecConfig>(project: Project, factory: Con suspend fun patchCommandLine(commandLine: GeneralCommandLine): GeneralCommandLine { - if (project.zigProjectSettings.state.direnv) { - commandLine.withEnvironment(DirenvCmd.importDirenv(project).env) + val direnv = DirenvService.getInstance(project) + if (direnv.isEnabled.isEnabled(project)) { + commandLine.withEnvironment(direnv.import().env) } return commandLine } diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigProfileState.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigProfileState.kt index 251ca441..4e13a161 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigProfileState.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/execution/base/ZigProfileState.kt @@ -24,28 +24,17 @@ package com.falsepattern.zigbrains.project.execution.base import com.falsepattern.zigbrains.ZigBrainsBundle import com.falsepattern.zigbrains.project.execution.ZigConsoleBuilder -import com.falsepattern.zigbrains.project.run.ZigProcessHandler -import com.falsepattern.zigbrains.project.settings.zigProjectSettings -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.falsepattern.zigbrains.shared.cli.startIPCAwareProcess import com.falsepattern.zigbrains.shared.coroutine.runModalOrBlocking -import com.falsepattern.zigbrains.shared.ipc.IPCUtil -import com.falsepattern.zigbrains.shared.ipc.ipc -import com.intellij.build.BuildTextConsoleView -import com.intellij.execution.DefaultExecutionResult import com.intellij.execution.ExecutionException import com.intellij.execution.configurations.CommandLineState import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.execution.configurations.PtyCommandLine -import com.intellij.execution.filters.TextConsoleBuilder import com.intellij.execution.process.ProcessHandler -import com.intellij.execution.process.ProcessTerminatedListener import com.intellij.execution.runners.ExecutionEnvironment -import com.intellij.openapi.project.Project import com.intellij.platform.ide.progress.ModalTaskOwner -import com.intellij.terminal.TerminalExecutionConsole -import com.intellij.util.system.OS -import kotlin.collections.contains import kotlin.io.path.pathString abstract class ZigProfileState> ( @@ -66,12 +55,12 @@ abstract class ZigProfileState> ( @Throws(ExecutionException::class) suspend fun startProcessSuspend(): ProcessHandler { - val toolchain = environment.project.zigProjectSettings.state.toolchain ?: throw ExecutionException(ZigBrainsBundle.message("exception.zig-profile-state.start-process.no-toolchain")) + val toolchain = ZigToolchainService.getInstance(environment.project).toolchain ?: throw ExecutionException(ZigBrainsBundle.message("exception.zig-profile-state.start-process.no-toolchain")) return getCommandLine(toolchain, false).startIPCAwareProcess(environment.project, emulateTerminal = true) } @Throws(ExecutionException::class) - open suspend fun getCommandLine(toolchain: AbstractZigToolchain, debug: Boolean): GeneralCommandLine { + open suspend fun getCommandLine(toolchain: ZigToolchain, debug: Boolean): GeneralCommandLine { val workingDir = configuration.workingDirectory val zigExePath = toolchain.zig.path() diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/module/ZigModuleBuilder.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/module/ZigModuleBuilder.kt index 0cce0af7..3cd8a511 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/module/ZigModuleBuilder.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/module/ZigModuleBuilder.kt @@ -50,7 +50,7 @@ class ZigModuleBuilder: ModuleBuilder() { override fun getCustomOptionsStep(context: WizardContext?, parentDisposable: Disposable?): ModuleWizardStep? { val step = ZigModuleWizardStep(parentDisposable) - parentDisposable?.let { Disposer.register(it, step.peer) } + parentDisposable?.let { Disposer.register(it) { step.peer.dispose() } } return step } @@ -65,14 +65,14 @@ class ZigModuleBuilder: ModuleBuilder() { } inner class ZigModuleWizardStep(parent: Disposable?): ModuleWizardStep() { - internal val peer = ZigProjectGeneratorPeer(true).also { Disposer.register(parent ?: return@also, it) } + internal val peer = ZigProjectGeneratorPeer(true).also { Disposer.register(parent ?: return@also) {it.dispose()} } override fun getComponent(): JComponent { return peer.component.withBorder() } override fun disposeUIResources() { - Disposer.dispose(peer) + Disposer.dispose(peer.newProjectPanel) } override fun updateDataModel() { diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigNewProjectPanel.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigNewProjectPanel.kt index ac1abd24..2f0cc95e 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigNewProjectPanel.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigNewProjectPanel.kt @@ -39,9 +39,9 @@ import com.intellij.util.ui.JBUI import javax.swing.JList import javax.swing.ListSelectionModel -class ZigNewProjectPanel(private var handleGit: Boolean): Disposable, ZigProjectConfigurationProvider.SettingsPanelHolder { +class ZigNewProjectPanel(private var handleGit: Boolean): Disposable { private val git = JBCheckBox() - override val panels = ZigProjectConfigurationProvider.createNewProjectSettingsPanels(this).onEach { Disposer.register(this, it) } + val panels = ZigProjectConfigurationProvider.createPanels(null).onEach { Disposer.register(this, it) } private val templateList = JBList(JBList.createDefaultListModel(defaultTemplates)).apply { selectionMode = ListSelectionModel.SINGLE_SELECTION selectedIndex = 0 @@ -64,7 +64,7 @@ class ZigNewProjectPanel(private var handleGit: Boolean): Disposable, ZigProject fun getData(): ZigProjectConfigurationData { val selectedTemplate = templateList.selectedValue - return ZigProjectConfigurationData(handleGit && git.isSelected, panels.map { it.data }, selectedTemplate) + return ZigProjectConfigurationData(handleGit && git.isSelected, panels, selectedTemplate) } fun attach(p: Panel): Unit = with(p) { @@ -73,6 +73,7 @@ class ZigNewProjectPanel(private var handleGit: Boolean): Disposable, ZigProject cell(git) } } + panels.filter { it.newProjectBeforeInitSelector }.forEach { it.attach(p) } group("Zig Project Template") { row { resizableRow() @@ -81,7 +82,7 @@ class ZigNewProjectPanel(private var handleGit: Boolean): Disposable, ZigProject .align(AlignY.FILL) } } - panels.forEach { it.attach(p) } + panels.filter { !it.newProjectBeforeInitSelector }.forEach { it.attach(p) } } override fun dispose() { diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectConfigurationData.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectConfigurationData.kt index ab425caf..1658b801 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectConfigurationData.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectConfigurationData.kt @@ -22,9 +22,10 @@ package com.falsepattern.zigbrains.project.newproject -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider import com.falsepattern.zigbrains.project.template.ZigInitTemplate import com.falsepattern.zigbrains.project.template.ZigProjectTemplate +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.shared.SubConfigurable import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.notification.Notification import com.intellij.notification.NotificationType @@ -42,7 +43,7 @@ import kotlinx.coroutines.launch @JvmRecord data class ZigProjectConfigurationData( val git: Boolean, - val conf: List, + val conf: List>, val selectedTemplate: ZigProjectTemplate ) { @RequiresBackgroundThread @@ -54,9 +55,7 @@ data class ZigProjectConfigurationData( if (!reporter.indeterminateStep("Initializing project") { if (template is ZigInitTemplate) { - val toolchain = conf - .mapNotNull { it as? ZigProjectConfigurationProvider.ToolchainProvider } - .firstNotNullOfOrNull { it.toolchain } ?: run { + val toolchain = ZigToolchainService.getInstance(project).toolchain ?: run { Notification( "zigbrains", "Tried to generate project with zig init, but zig toolchain is invalid", diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectGeneratorPeer.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectGeneratorPeer.kt index 41db4c5f..209d7876 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectGeneratorPeer.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/newproject/ZigProjectGeneratorPeer.kt @@ -23,16 +23,14 @@ package com.falsepattern.zigbrains.project.newproject import com.intellij.ide.util.projectWizard.SettingsStep -import com.intellij.openapi.Disposable import com.intellij.openapi.ui.ValidationInfo -import com.intellij.openapi.util.Disposer import com.intellij.platform.ProjectGeneratorPeer import com.intellij.ui.dsl.builder.panel import javax.swing.JComponent -class ZigProjectGeneratorPeer(var handleGit: Boolean): ProjectGeneratorPeer, Disposable { - private val newProjectPanel by lazy { - ZigNewProjectPanel(handleGit).also { Disposer.register(this, it) } +class ZigProjectGeneratorPeer(var handleGit: Boolean): ProjectGeneratorPeer { + val newProjectPanel by lazy { + ZigNewProjectPanel(handleGit) } private val myComponent: JComponent by lazy { panel { @@ -59,6 +57,7 @@ class ZigProjectGeneratorPeer(var handleGit: Boolean): ProjectGeneratorPeer>(protected val val state = castProfileState(baseState) ?: return null - val toolchain = environment.project.zigProjectSettings.state.toolchain ?: run { + val toolchain = ZigToolchainService.getInstance(environment.project).toolchain ?: run { Notification( "zigbrains", "Zig project toolchain not set, cannot execute program! Please configure it in [Settings | Languages & Frameworks | Zig]", @@ -81,5 +81,5 @@ abstract class ZigProgramRunner>(protected val protected abstract fun castProfileState(state: ZigProfileState<*>): ProfileState? @Throws(ExecutionException::class) - abstract suspend fun execute(state: ProfileState, toolchain: AbstractZigToolchain, environment: ExecutionEnvironment): RunContentDescriptor? + abstract suspend fun execute(state: ProfileState, toolchain: ZigToolchain, environment: ExecutionEnvironment): RunContentDescriptor? } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/run/ZigRegularRunner.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/run/ZigRegularRunner.kt index 771e94d2..2601ad9b 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/run/ZigRegularRunner.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/run/ZigRegularRunner.kt @@ -24,7 +24,7 @@ package com.falsepattern.zigbrains.project.run import com.falsepattern.zigbrains.project.execution.base.ZigExecConfig import com.falsepattern.zigbrains.project.execution.base.ZigProfileState -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.falsepattern.zigbrains.shared.coroutine.withEDTContext import com.intellij.execution.configurations.RunProfile import com.intellij.execution.executors.DefaultRunExecutor @@ -32,10 +32,13 @@ import com.intellij.execution.runners.ExecutionEnvironment import com.intellij.execution.runners.RunContentBuilder import com.intellij.execution.ui.RunContentDescriptor import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.progress.blockingContext class ZigRegularRunner: ZigProgramRunner>(DefaultRunExecutor.EXECUTOR_ID) { - override suspend fun execute(state: ZigProfileState<*>, toolchain: AbstractZigToolchain, environment: ExecutionEnvironment): RunContentDescriptor? { - val exec = state.execute(environment.executor, this) + override suspend fun execute(state: ZigProfileState<*>, toolchain: ZigToolchain, environment: ExecutionEnvironment): RunContentDescriptor? { + val exec = blockingContext { + state.execute(environment.executor, this) + } return withEDTContext(ModalityState.any()) { val runContentBuilder = RunContentBuilder(exec, environment) runContentBuilder.showRunContent(null) diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigConfigurable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigConfigurable.kt index e16b058f..57b53003 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigConfigurable.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigConfigurable.kt @@ -22,11 +22,14 @@ package com.falsepattern.zigbrains.project.settings -import com.falsepattern.zigbrains.shared.MultiConfigurable +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.SubConfigurable import com.intellij.openapi.project.Project -class ZigConfigurable(project: Project): MultiConfigurable(ZigProjectConfigurationProvider.createConfigurables(project)) { - override fun getDisplayName(): String { - return "Zig" +class ZigConfigurable(override val context: Project) : SubConfigurable.Adapter() { + override fun instantiate(): List> { + return ZigProjectConfigurationProvider.createPanels(context) } + + override fun getDisplayName() = ZigBrainsBundle.message("settings.project.display-name") } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurable.kt deleted file mode 100644 index ff333f79..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurable.kt +++ /dev/null @@ -1,60 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.project.settings - -import com.falsepattern.zigbrains.shared.SubConfigurable -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.Disposer -import com.intellij.ui.dsl.builder.Panel - -class ZigProjectConfigurable(private val project: Project): SubConfigurable { - private var settingsPanel: ZigProjectSettingsPanel? = null - override fun createComponent(holder: ZigProjectConfigurationProvider.SettingsPanelHolder, panel: Panel): ZigProjectConfigurationProvider.SettingsPanel { - settingsPanel?.let { Disposer.dispose(it) } - val sp = ZigProjectSettingsPanel(holder, project).apply { attach(panel) }.also { Disposer.register(this, it) } - settingsPanel = sp - return sp - } - - override fun isModified(): Boolean { - return project.zigProjectSettings.isModified(settingsPanel?.data ?: return false) - } - - override fun apply() { - val service = project.zigProjectSettings - val data = settingsPanel?.data ?: return - val modified = service.isModified(data) - service.state = data - if (modified) { - ZigProjectConfigurationProvider.mainConfigChanged(project) - } - } - - override fun reset() { - settingsPanel?.data = project.zigProjectSettings.state - } - - override fun dispose() { - settingsPanel = null - } -} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurationProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurationProvider.kt index a609a3ee..c93d03f6 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurationProvider.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectConfigurationProvider.kt @@ -22,42 +22,56 @@ package com.falsepattern.zigbrains.project.settings -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain import com.falsepattern.zigbrains.shared.SubConfigurable -import com.intellij.openapi.Disposable import com.intellij.openapi.extensions.ExtensionPointName import com.intellij.openapi.project.Project -import com.intellij.ui.dsl.builder.Panel +import com.intellij.openapi.util.Key +import com.intellij.openapi.util.UserDataHolder +import com.intellij.openapi.util.UserDataHolderBase interface ZigProjectConfigurationProvider { - fun handleMainConfigChanged(project: Project) - fun createConfigurable(project: Project): SubConfigurable - fun createNewProjectSettingsPanel(holder: SettingsPanelHolder): SettingsPanel? - val priority: Int + fun create(sharedState: IUserDataBridge): SubConfigurable? + val index: Int companion object { private val EXTENSION_POINT_NAME = ExtensionPointName.create("com.falsepattern.zigbrains.projectConfigProvider") - fun mainConfigChanged(project: Project) { - EXTENSION_POINT_NAME.extensionList.forEach { it.handleMainConfigChanged(project) } - } - fun createConfigurables(project: Project): List { - return EXTENSION_POINT_NAME.extensionList.sortedBy { it.priority }.map { it.createConfigurable(project) } - } - fun createNewProjectSettingsPanels(holder: SettingsPanelHolder): List { - return EXTENSION_POINT_NAME.extensionList.sortedBy { it.priority }.mapNotNull { it.createNewProjectSettingsPanel(holder) } + val PROJECT_KEY: Key = Key.create("Project") + fun createPanels(project: Project?): List> { + val sharedState = UserDataBridge() + sharedState.putUserData(PROJECT_KEY, project) + return EXTENSION_POINT_NAME.extensionList.sortedBy { it.index }.mapNotNull { it.create(sharedState) } } } - interface SettingsPanel: Disposable { - val data: Settings - fun attach(p: Panel) - fun direnvChanged(state: Boolean) + + interface IUserDataBridge: UserDataHolder { + fun addUserDataChangeListener(listener: UserDataListener) + fun removeUserDataChangeListener(listener: UserDataListener) } - interface SettingsPanelHolder { - val panels: List + + interface UserDataListener { + fun onUserDataChanged(key: Key<*>) } - interface Settings { - fun apply(project: Project) + + class UserDataBridge: UserDataHolderBase(), IUserDataBridge { + private val listeners = ArrayList() + override fun putUserData(key: Key, value: T?) { + super.putUserData(key, value) + synchronized(listeners) { + listeners.forEach { listener -> + listener.onUserDataChanged(key) + } + } + } + + override fun addUserDataChangeListener(listener: UserDataListener) { + synchronized(listeners) { + listeners.add(listener) + } + } + + override fun removeUserDataChangeListener(listener: UserDataListener) { + synchronized(listeners) { + listeners.remove(listener) + } + } } - interface ToolchainProvider { - val toolchain: AbstractZigToolchain? - } -} \ No newline at end of file +} diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettings.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettings.kt deleted file mode 100644 index facf092c..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettings.kt +++ /dev/null @@ -1,55 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.project.settings - -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.io.toNioPathOrNull -import com.intellij.util.xmlb.annotations.Transient -import kotlin.io.path.isDirectory -import kotlin.io.path.pathString - -data class ZigProjectSettings( - var direnv: Boolean = false, - var overrideStdPath: Boolean = false, - var explicitPathToStd: String? = null, - var toolchainPath: String? = null -): ZigProjectConfigurationProvider.Settings, ZigProjectConfigurationProvider.ToolchainProvider { - override fun apply(project: Project) { - project.zigProjectSettings.loadState(this) - } - - @get:Transient - @set:Transient - override var toolchain: LocalZigToolchain? - get() { - val nioPath = toolchainPath?.toNioPathOrNull() ?: return null - if (!nioPath.isDirectory()) { - return null - } - return LocalZigToolchain(nioPath) - } - set(value) { - toolchainPath = value?.location?.pathString - } -} diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsService.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsService.kt deleted file mode 100644 index 6820c488..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsService.kt +++ /dev/null @@ -1,60 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.project.settings - -import com.falsepattern.zigbrains.project.toolchain.stdlib.ZigSyntheticLibrary -import com.falsepattern.zigbrains.shared.zigCoroutineScope -import com.intellij.openapi.components.* -import com.intellij.openapi.project.Project -import kotlinx.coroutines.launch - -@Service(Service.Level.PROJECT) -@State( - name = "ZigProjectSettings", - storages = [Storage("zigbrains.xml")] -) -class ZigProjectSettingsService(val project: Project): PersistentStateComponent { - @Volatile - private var state = ZigProjectSettings() - - override fun getState(): ZigProjectSettings { - return state.copy() - } - - fun setState(value: ZigProjectSettings) { - this.state = value - zigCoroutineScope.launch { - ZigSyntheticLibrary.reload(project, value) - } - } - - override fun loadState(state: ZigProjectSettings) { - setState(state) - } - - fun isModified(otherData: ZigProjectSettings): Boolean { - return state != otherData - } -} - -val Project.zigProjectSettings get() = service() \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigLibraryRootProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigLibraryRootProvider.kt similarity index 95% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigLibraryRootProvider.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigLibraryRootProvider.kt index e8ce9239..4cceeae4 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigLibraryRootProvider.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigLibraryRootProvider.kt @@ -20,7 +20,7 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain.stdlib +package com.falsepattern.zigbrains.project.stdlib import com.intellij.openapi.project.Project import com.intellij.openapi.roots.AdditionalLibraryRootsProvider diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigSyntheticLibrary.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigSyntheticLibrary.kt similarity index 56% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigSyntheticLibrary.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigSyntheticLibrary.kt index a915a8de..52094e45 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/stdlib/ZigSyntheticLibrary.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/stdlib/ZigSyntheticLibrary.kt @@ -20,41 +20,43 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain.stdlib +package com.falsepattern.zigbrains.project.stdlib import com.falsepattern.zigbrains.Icons -import com.falsepattern.zigbrains.project.settings.ZigProjectSettings -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.navigation.ItemPresentation import com.intellij.openapi.project.Project import com.intellij.openapi.project.guessProjectDir import com.intellij.openapi.roots.SyntheticLibrary -import com.intellij.openapi.util.io.toNioPathOrNull import com.intellij.openapi.vfs.VirtualFile import com.intellij.openapi.vfs.refreshAndFindVirtualDirectory import com.intellij.platform.backend.workspace.WorkspaceModel import com.intellij.platform.backend.workspace.toVirtualFileUrl import com.intellij.platform.workspace.jps.entities.* +import com.intellij.project.isDirectoryBased +import com.intellij.project.stateStore import com.intellij.workspaceModel.ide.impl.LegacyBridgeJpsEntitySourceFactory import kotlinx.coroutines.runBlocking import java.util.* import javax.swing.Icon class ZigSyntheticLibrary(val project: Project) : SyntheticLibrary(), ItemPresentation { - private var state: ZigProjectSettings = project.zigProjectSettings.state.copy() + private var toolchain: ZigToolchain? = ZigToolchainService.getInstance(project).toolchain private val roots by lazy { - runBlocking {getRoot(state, project)}?.let { setOf(it) } ?: emptySet() + runBlocking {getRoot(toolchain, project)}?.let { setOf(it) } ?: emptySet() } private val name by lazy { - getName(state, project) + getName(toolchain, project) } override fun equals(other: Any?): Boolean { if (other !is ZigSyntheticLibrary) return false - return state == other.state + return toolchain == other.toolchain } override fun hashCode(): Int { @@ -73,17 +75,49 @@ class ZigSyntheticLibrary(val project: Project) : SyntheticLibrary(), ItemPresen return roots } + override fun isShowInExternalLibrariesNode(): Boolean { + return !roots.isEmpty() + } + companion object { private const val ZIG_LIBRARY_ID = "Zig SDK" - private const val ZIG_MODULE_ID = "Zig" - suspend fun reload(project: Project, state: ZigProjectSettings) { - val moduleId = ModuleId(ZIG_MODULE_ID) + private const val ZIG_MODULE_ID = "ZigBrains" + private val libraryTableId = LibraryTableId.ProjectLibraryTableId + private val libraryId = LibraryId(ZIG_LIBRARY_ID, libraryTableId) + private val moduleId = ModuleId(ZIG_MODULE_ID) + suspend fun reload(project: Project, toolchain: ZigToolchain?) { + val root = getRoot(toolchain, project) + if (root != null) { + add(project, root) + } else { + remove(project) + } + } + + private suspend fun remove(project: Project) { + val workspaceModel = WorkspaceModel.getInstance(project) + workspaceModel.update("Update Zig std") { builder -> + builder.resolve(moduleId)?.let { moduleEntity -> + builder.removeEntity(moduleEntity) + } + builder.resolve(libraryId)?.let { libraryEntity -> + builder.removeEntity(libraryEntity) + } + } + } + + private suspend fun add(project: Project, root: VirtualFile) { val workspaceModel = WorkspaceModel.getInstance(project) - val root = getRoot(state, project) ?: return val libRoot = LibraryRoot(root.toVirtualFileUrl(workspaceModel.getVirtualFileUrlManager()), LibraryRootTypeId.SOURCES) - val libraryTableId = LibraryTableId.ProjectLibraryTableId - val libraryId = LibraryId(ZIG_LIBRARY_ID, libraryTableId) - val baseModuleDir = project.guessProjectDir()?.toVirtualFileUrl(workspaceModel.getVirtualFileUrlManager()) ?: return + + var baseModuleDirFile: VirtualFile? = null + if (project.isDirectoryBased) { + baseModuleDirFile = project.stateStore.directoryStorePath?.refreshAndFindVirtualDirectory() + } + if (baseModuleDirFile == null) { + baseModuleDirFile = project.guessProjectDir() + } + val baseModuleDir = baseModuleDirFile?.toVirtualFileUrl(workspaceModel.getVirtualFileUrlManager()) ?: return workspaceModel.update("Update Zig std") { builder -> builder.resolve(moduleId)?.let { moduleEntity -> builder.removeEntity(moduleEntity) @@ -117,37 +151,39 @@ class ZigSyntheticLibrary(val project: Project) : SyntheticLibrary(), ItemPresen } private fun getName( - state: ZigProjectSettings, + toolchain: ZigToolchain?, project: Project ): String { - val tc = state.toolchain ?: return "Zig" - val version = runBlocking { tc.zig.getEnv(project) }.mapCatching { it.version }.getOrElse { return "Zig" } - return "Zig $version" + val tc = toolchain ?: return "Zig" + toolchain.name?.let { return it } + runBlocking { tc.zig.getEnv(project) } + .mapCatching { it.version } + .getOrNull() + ?.let { return "Zig $it" } + return "Zig" } suspend fun getRoot( - state: ZigProjectSettings, + toolchain: ZigToolchain?, project: Project ): VirtualFile? { - val toolchain = state.toolchain - if (state.overrideStdPath) run { - val ePathStr = state.explicitPathToStd ?: return@run - val ePath = ePathStr.toNioPathOrNull() ?: return@run + //TODO universal + if (toolchain !is LocalZigToolchain) { + return null + } + if (toolchain.std != null) run { + val ePath = toolchain.std if (ePath.isAbsolute) { val roots = ePath.refreshAndFindVirtualDirectory() ?: return@run return roots - } else if (toolchain != null) { - val stdPath = toolchain.location.resolve(ePath) - if (stdPath.isAbsolute) { - val roots = stdPath.refreshAndFindVirtualDirectory() ?: return@run - return roots - } + } + val stdPath = toolchain.location.resolve(ePath) + if (stdPath.isAbsolute) { + val roots = stdPath.refreshAndFindVirtualDirectory() ?: return@run + return roots } } - if (toolchain != null) { - val stdPath = toolchain.zig.getEnv(project).mapCatching { it.stdPath(toolchain, project) }.getOrNull() ?: return null - val roots = stdPath.refreshAndFindVirtualDirectory() ?: return null - return roots - } - return null + val stdPath = toolchain.zig.getEnv(project).mapCatching { it.stdPath(toolchain, project) }.getOrNull() ?: return null + val roots = stdPath.refreshAndFindVirtualDirectory() ?: return null + return roots } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/steps/discovery/ZigStepDiscoveryService.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/steps/discovery/ZigStepDiscoveryService.kt index 320118ec..1bf0fd35 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/steps/discovery/ZigStepDiscoveryService.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/steps/discovery/ZigStepDiscoveryService.kt @@ -22,8 +22,8 @@ package com.falsepattern.zigbrains.project.steps.discovery -import com.falsepattern.zigbrains.project.settings.zigProjectSettings import com.falsepattern.zigbrains.project.steps.discovery.ZigStepDiscoveryListener.ErrorType +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService import com.falsepattern.zigbrains.shared.coroutine.withEDTContext import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.openapi.Disposable @@ -76,7 +76,7 @@ class ZigStepDiscoveryService(private val project: Project) { private tailrec suspend fun doReload() { preReload() - val toolchain = project.zigProjectSettings.state.toolchain ?: run { + val toolchain = ZigToolchainService.getInstance(project).toolchain ?: run { errorReload(ErrorType.MissingToolchain) return } diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchainProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchainProvider.kt deleted file mode 100644 index a7701ad6..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchainProvider.kt +++ /dev/null @@ -1,66 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.project.toolchain - -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.direnv.emptyEnv -import com.falsepattern.zigbrains.project.settings.zigProjectSettings -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.UserDataHolder -import com.intellij.openapi.util.io.toNioPathOrNull -import kotlinx.serialization.json.* -import kotlin.io.path.pathString - -class LocalZigToolchainProvider: ZigToolchainProvider { - override suspend fun suggestToolchain(project: Project?, extraData: UserDataHolder): LocalZigToolchain? { - val env = if (project != null && (extraData.getUserData(LocalZigToolchain.DIRENV_KEY) ?: project.zigProjectSettings.state.direnv)) { - DirenvCmd.importDirenv(project) - } else { - emptyEnv - } - val zigExePath = env.findExecutableOnPATH("zig") ?: return null - return LocalZigToolchain(zigExePath.parent) - } - - override val serialMarker: String - get() = "local" - - override fun deserialize(data: JsonElement): LocalZigToolchain? { - if (data !is JsonObject) - return null - - val loc = data["location"] as? JsonPrimitive ?: return null - val path = loc.content.toNioPathOrNull() ?: return null - return LocalZigToolchain(path) - } - - override fun canSerialize(toolchain: AbstractZigToolchain): Boolean { - return toolchain is LocalZigToolchain - } - - override fun serialize(toolchain: LocalZigToolchain): JsonElement { - return buildJsonObject { - put("location", toolchain.location.pathString) - } - } -} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainListService.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainListService.kt new file mode 100644 index 00000000..fc1c8733 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainListService.kt @@ -0,0 +1,57 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain + +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainListService.MyState +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.resolve +import com.falsepattern.zigbrains.project.toolchain.base.toRef +import com.falsepattern.zigbrains.shared.UUIDMapSerializable +import com.falsepattern.zigbrains.shared.UUIDStorage +import com.intellij.openapi.components.Service +import com.intellij.openapi.components.State +import com.intellij.openapi.components.Storage +import com.intellij.openapi.components.service + +@Service(Service.Level.APP) +@State( + name = "ZigToolchainList", + storages = [Storage("zigbrains.xml")] +) +class ZigToolchainListService: UUIDMapSerializable.Converting(MyState()) { + override fun serialize(value: ZigToolchain) = value.toRef() + override fun deserialize(value: ZigToolchain.Ref) = value.resolve() + override fun getStorage(state: MyState) = state.toolchains + override fun updateStorage(state: MyState, storage: ToolchainStorage) = state.copy(toolchains = storage) + + data class MyState(@JvmField val toolchains: ToolchainStorage = emptyMap()) + + companion object { + @JvmStatic + fun getInstance(): ZigToolchainListService = service() + } +} + +inline val zigToolchainList: ZigToolchainListService get() = ZigToolchainListService.getInstance() + +private typealias ToolchainStorage = UUIDStorage diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainProvider.kt deleted file mode 100644 index 57aeb51b..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainProvider.kt +++ /dev/null @@ -1,69 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.project.toolchain - -import com.falsepattern.zigbrains.project.toolchain.ZigToolchainProvider.Companion.EXTENSION_POINT_NAME -import com.intellij.openapi.extensions.ExtensionPointName -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.UserDataHolder -import com.intellij.util.xmlb.Converter -import kotlinx.serialization.json.* - -sealed interface ZigToolchainProvider { - suspend fun suggestToolchain(project: Project?, extraData: UserDataHolder): AbstractZigToolchain? - - val serialMarker: String - fun deserialize(data: JsonElement): AbstractZigToolchain? - fun canSerialize(toolchain: AbstractZigToolchain): Boolean - fun serialize(toolchain: T): JsonElement - - companion object { - val EXTENSION_POINT_NAME = ExtensionPointName.create>("com.falsepattern.zigbrains.toolchainProvider") - - suspend fun suggestToolchain(project: Project?, extraData: UserDataHolder): AbstractZigToolchain? { - return EXTENSION_POINT_NAME.extensionList.firstNotNullOfOrNull { it.suggestToolchain(project, extraData) } - } - } -} - -@Suppress("UNCHECKED_CAST") -private fun ZigToolchainProvider.serialize(toolchain: AbstractZigToolchain) = serialize(toolchain as T) - -class ZigToolchainConverter: Converter() { - override fun fromString(value: String): AbstractZigToolchain? { - val json = Json.parseToJsonElement(value) as? JsonObject ?: return null - val marker = (json["marker"] as? JsonPrimitive)?.contentOrNull ?: return null - val data = json["data"] ?: return null - val provider = EXTENSION_POINT_NAME.extensionList.find { it.serialMarker == marker } ?: return null - return provider.deserialize(data) - } - - override fun toString(value: AbstractZigToolchain): String? { - val provider = EXTENSION_POINT_NAME.extensionList.find { it.canSerialize(value) } ?: return null - return buildJsonObject { - put("marker", provider.serialMarker) - put("data", provider.serialize(value)) - }.toString() - } - -} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainService.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainService.kt new file mode 100644 index 00000000..3e708be5 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainService.kt @@ -0,0 +1,76 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain + +import com.falsepattern.zigbrains.project.stdlib.ZigSyntheticLibrary +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.shared.asUUID +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.application.EDT +import com.intellij.openapi.components.* +import com.intellij.openapi.project.Project +import com.intellij.util.xmlb.annotations.Attribute +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.launch +import java.util.* + +@Service(Service.Level.PROJECT) +@State( + name = "ZigToolchain", + storages = [Storage("zigbrains.xml")] +) +class ZigToolchainService(private val project: Project): SerializablePersistentStateComponent(State()) { + var toolchainUUID: UUID? + get() = state.toolchain.ifBlank { null }?.asUUID()?.takeIf { + if (it in zigToolchainList) { + true + } else { + updateState { + it.copy(toolchain = "") + } + false + } + } + set(value) { + updateState { + it.copy(toolchain = value?.toString() ?: "") + } + zigCoroutineScope.launch(Dispatchers.EDT) { + ZigSyntheticLibrary.reload(project, toolchain) + } + } + + val toolchain: ZigToolchain? + get() = toolchainUUID?.let { zigToolchainList[it] } + + data class State( + @JvmField + @Attribute + var toolchain: String = "" + ) + + companion object { + @JvmStatic + fun getInstance(project: Project): ZigToolchainService = project.service() + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchain.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchain.kt new file mode 100644 index 00000000..74c0b44d --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchain.kt @@ -0,0 +1,70 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.base + +import com.falsepattern.zigbrains.project.toolchain.tools.ZigCompilerTool +import com.falsepattern.zigbrains.shared.NamedObject +import com.intellij.execution.configurations.GeneralCommandLine +import com.intellij.openapi.project.Project +import com.intellij.util.xmlb.annotations.Attribute +import java.nio.file.Path + +/** + * These MUST be stateless and interchangeable! (e.g., immutable data class) + */ +interface ZigToolchain: NamedObject { + val zig: ZigCompilerTool get() = ZigCompilerTool(this) + + val extraData: Map + + /** + * Returned type must be the same class + */ + fun withExtraData(map: Map): ZigToolchain + + fun workingDirectory(project: Project? = null): Path? + + suspend fun patchCommandLine(commandLine: GeneralCommandLine, project: Project? = null): GeneralCommandLine + + fun pathToExecutable(toolName: String, project: Project? = null): Path + + data class Ref( + @JvmField + @Attribute + val marker: String? = null, + @JvmField + val data: Map? = null, + @JvmField + val extraData: Map? = null, + ) +} + +fun T.withExtraData(key: String, value: String?): T { + val newMap = HashMap() + newMap.putAll(extraData.filter { (theKey, _) -> theKey != key}) + if (value != null) { + newMap[key] = value + } + @Suppress("UNCHECKED_CAST") + return withExtraData(newMap) as T +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainConfigurable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainConfigurable.kt new file mode 100644 index 00000000..abbd34f7 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainConfigurable.kt @@ -0,0 +1,103 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.base + +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableElementPanel +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.intellij.openapi.ui.NamedConfigurable +import com.intellij.openapi.util.Key +import com.intellij.openapi.util.NlsContexts +import com.intellij.ui.dsl.builder.panel +import java.util.* +import java.util.function.Supplier +import javax.swing.JComponent + +abstract class ZigToolchainConfigurable( + val uuid: UUID, + tc: T, + val data: ZigProjectConfigurationProvider.IUserDataBridge?, + val modal: Boolean +): NamedConfigurable() { + var toolchain: T = tc + set(value) { + zigToolchainList[uuid] = value + field = value + } + + init { + data?.putUserData(TOOLCHAIN_KEY, Supplier{toolchain}) + } + private var myViews: List> = emptyList() + + abstract fun createPanel(): ImmutableElementPanel + + override fun createOptionsPanel(): JComponent? { + var views = myViews + if (views.isEmpty()) { + views = ArrayList>() + views.add(createPanel()) + views.addAll(createZigToolchainExtensionPanels(data, if (modal) PanelState.ModalEditor else PanelState.ListEditor)) + myViews = views + } + val p = panel { + views.forEach { it.attach(this@panel) } + }.withMinimumWidth(20) + views.forEach { it.reset(toolchain) } + return p + } + + override fun getEditableObject(): UUID? { + return uuid + } + + override fun getBannerSlogan(): @NlsContexts.DetailedDescription String? { + return displayName + } + + override fun getDisplayName(): @NlsContexts.ConfigurableName String? { + return toolchain.name + } + + override fun isModified(): Boolean { + return myViews.any { it.isModified(toolchain) } + } + + override fun apply() { + toolchain = myViews.fold(toolchain) { tc, view -> view.apply(tc) ?: tc } + } + + override fun reset() { + myViews.forEach { it.reset(toolchain) } + } + + override fun disposeUIResources() { + myViews.forEach { it.dispose() } + myViews = emptyList() + super.disposeUIResources() + } + + companion object { + val TOOLCHAIN_KEY: Key> = Key.create("TOOLCHAIN") + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainExtensionsProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainExtensionsProvider.kt new file mode 100644 index 00000000..b9114d00 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainExtensionsProvider.kt @@ -0,0 +1,46 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.base + +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableElementPanel +import com.intellij.openapi.extensions.ExtensionPointName + +private val EXTENSION_POINT_NAME = ExtensionPointName.create("com.falsepattern.zigbrains.toolchainExtensionsProvider") + +interface ZigToolchainExtensionsProvider { + fun createExtensionPanel(sharedState: ZigProjectConfigurationProvider.IUserDataBridge?, state: PanelState): ImmutableElementPanel? + val index: Int +} + +fun createZigToolchainExtensionPanels(sharedState: ZigProjectConfigurationProvider.IUserDataBridge?, state: PanelState): List> { + return EXTENSION_POINT_NAME.extensionList.sortedBy{ it.index }.mapNotNull { + it.createExtensionPanel(sharedState, state) + } +} + +enum class PanelState { + ProjectEditor, + ListEditor, + ModalEditor +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainProvider.kt new file mode 100644 index 00000000..01d66775 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/base/ZigToolchainProvider.kt @@ -0,0 +1,93 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.base + +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.intellij.openapi.extensions.ExtensionPointName +import com.intellij.openapi.project.Project +import com.intellij.openapi.util.Key +import com.intellij.openapi.util.UserDataHolder +import com.intellij.ui.SimpleColoredComponent +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.flow.* +import java.util.* + +private val EXTENSION_POINT_NAME = ExtensionPointName.create("com.falsepattern.zigbrains.toolchainProvider") + +internal interface ZigToolchainProvider { + val serialMarker: String + fun isCompatible(toolchain: ZigToolchain): Boolean + fun deserialize(data: Map): ZigToolchain? + fun serialize(toolchain: ZigToolchain): Map + fun matchesSuggestion(toolchain: ZigToolchain, suggestion: ZigToolchain): Boolean + fun createConfigurable(uuid: UUID, toolchain: ZigToolchain, data: ZigProjectConfigurationProvider.IUserDataBridge?, modal: Boolean): ZigToolchainConfigurable<*> + suspend fun suggestToolchains(project: Project?, data: UserDataHolder): Flow + fun render(toolchain: ZigToolchain, component: SimpleColoredComponent, isSuggestion: Boolean, isSelected: Boolean) +} + +fun ZigToolchain.Ref.resolve(): ZigToolchain? { + val marker = this.marker ?: return null + val data = this.data ?: return null + val provider = EXTENSION_POINT_NAME.extensionList.find { it.serialMarker == marker } ?: return null + return provider.deserialize(data)?.let { tc -> this.extraData?.let { extraData -> tc.withExtraData(extraData) }} +} + +fun ZigToolchain.toRef(): ZigToolchain.Ref { + val provider = EXTENSION_POINT_NAME.extensionList.find { it.isCompatible(this) } ?: throw IllegalStateException() + return ZigToolchain.Ref(provider.serialMarker, provider.serialize(this), this.extraData) +} + +fun ZigToolchain.createNamedConfigurable(uuid: UUID, data: ZigProjectConfigurationProvider.IUserDataBridge?, modal: Boolean): ZigToolchainConfigurable<*> { + val provider = EXTENSION_POINT_NAME.extensionList.find { it.isCompatible(this) } ?: throw IllegalStateException() + return provider.createConfigurable(uuid, this, data, modal) +} + +@OptIn(ExperimentalCoroutinesApi::class) +fun suggestZigToolchains(project: Project? = null, data: UserDataHolder = emptyData): Flow { + val existing = zigToolchainList.map { (_, tc) -> tc } + return EXTENSION_POINT_NAME.extensionList.asFlow().flatMapConcat { ext -> + val compatibleExisting = existing.filter { ext.isCompatible(it) } + val suggestions = ext.suggestToolchains(project, data) + suggestions.filter { suggestion -> + compatibleExisting.none { existing -> ext.matchesSuggestion(existing, suggestion) } + } + }.flowOn(Dispatchers.IO) +} + +fun ZigToolchain.render(component: SimpleColoredComponent, isSuggestion: Boolean, isSelected: Boolean) { + val provider = EXTENSION_POINT_NAME.extensionList.find { it.isCompatible(this) } ?: throw IllegalStateException() + return provider.render(this, component, isSuggestion, isSelected) +} + +private val emptyData = object: UserDataHolder { + override fun getUserData(key: Key): T? { + return null + } + + override fun putUserData(key: Key, value: T?) { + + } + +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainDownloader.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainDownloader.kt new file mode 100644 index 00000000..3cb24106 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainDownloader.kt @@ -0,0 +1,38 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.local.getSuggestedLocalToolchainPath +import com.falsepattern.zigbrains.shared.downloader.Downloader +import java.awt.Component + +class LocalToolchainDownloader(component: Component) : Downloader(component) { + override val windowTitle get() = ZigBrainsBundle.message("settings.toolchain.downloader.title") + override val versionInfoFetchTitle get() = ZigBrainsBundle.message("settings.toolchain.downloader.progress.fetch") + override fun downloadProgressTitle(version: ZigVersionInfo) = ZigBrainsBundle.message("settings.toolchain.downloader.progress.install", version.version.rawVersion) + override fun localSelector() = LocalToolchainSelector(component) + override suspend fun downloadVersionList() = ZigVersionInfo.downloadVersionList() + override fun getSuggestedPath() = getSuggestedLocalToolchainPath() +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainSelector.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainSelector.kt new file mode 100644 index 00000000..22802b66 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/LocalToolchainSelector.kt @@ -0,0 +1,88 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.falsepattern.zigbrains.shared.downloader.LocalSelector +import com.falsepattern.zigbrains.shared.withUniqueName +import com.intellij.icons.AllIcons +import com.intellij.openapi.fileChooser.FileChooserDescriptor +import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory +import com.intellij.platform.ide.progress.ModalTaskOwner +import com.intellij.platform.ide.progress.TaskCancellation +import com.intellij.platform.ide.progress.withModalProgress +import java.awt.Component +import java.nio.file.Path + +class LocalToolchainSelector(component: Component): LocalSelector(component) { + override val windowTitle: String + get() = ZigBrainsBundle.message("settings.toolchain.local-selector.title") + override val descriptor: FileChooserDescriptor + get() = FileChooserDescriptorFactory.createSingleFolderDescriptor() + .withTitle(ZigBrainsBundle.message("settings.toolchain.local-selector.chooser.title")) + + override suspend fun verify(path: Path): VerifyResult { + var tc = resolve(path, null) + var result: VerifyResult + if (tc == null) { + result = VerifyResult( + null, + false, + AllIcons.General.Error, + ZigBrainsBundle.message("settings.toolchain.local-selector.state.invalid"), + ) + } else { + val existingToolchain = zigToolchainList + .mapNotNull { it.second as? LocalZigToolchain } + .firstOrNull { it.location == tc!!.location } + if (existingToolchain != null) { + result = VerifyResult( + null, + true, + AllIcons.General.Warning, + existingToolchain.name?.let { ZigBrainsBundle.message("settings.toolchain.local-selector.state.already-exists-named", it) } + ?: ZigBrainsBundle.message("settings.toolchain.local-selector.state.already-exists-unnamed") + ) + } else { + result = VerifyResult( + null, + true, + AllIcons.General.Information, + ZigBrainsBundle.message("settings.toolchain.local-selector.state.ok") + ) + } + } + if (tc != null) { + tc = zigToolchainList.withUniqueName(tc) + } + return result.copy(name = tc?.name) + } + + override suspend fun resolve(path: Path, name: String?): LocalZigToolchain? { + return runCatching { withModalProgress(ModalTaskOwner.component(component), "Resolving toolchain", TaskCancellation.cancellable()) { + LocalZigToolchain.tryFromPath(path)?.let { it.withName(name ?: it.name) } + } }.getOrNull() + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/ZigVersionInfo.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/ZigVersionInfo.kt new file mode 100644 index 00000000..e3c6aaa5 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/downloader/ZigVersionInfo.kt @@ -0,0 +1,87 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.downloader.VersionInfo +import com.falsepattern.zigbrains.shared.downloader.VersionInfo.Tarball +import com.falsepattern.zigbrains.shared.downloader.getTarballIfCompatible +import com.falsepattern.zigbrains.shared.downloader.tempPluginDir +import com.intellij.openapi.progress.coroutineToIndicator +import com.intellij.openapi.util.io.FileUtil +import com.intellij.util.asSafely +import com.intellij.util.download.DownloadableFileService +import com.intellij.util.text.SemVer +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.withContext +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.json.* + +@JvmRecord +data class ZigVersionInfo( + override val version: SemVer, + override val date: String, + val docs: String, + val notes: String, + val src: Tarball?, + override val dist: Tarball +): VersionInfo { + companion object { + @OptIn(ExperimentalSerializationApi::class) + suspend fun downloadVersionList(): List { + return withContext(Dispatchers.IO) { + val service = DownloadableFileService.getInstance() + val tempFile = FileUtil.createTempFile(tempPluginDir, "index", ".json", false, false) + val desc = service.createFileDescription("https://ziglang.org/download/index.json", tempFile.name) + val downloader = service.createDownloader(listOf(desc), ZigBrainsBundle.message("settings.toolchain.downloader.service.index")) + val downloadResults = coroutineToIndicator { + downloader.download(tempPluginDir) + } + if (downloadResults.isEmpty()) + return@withContext emptyList() + val index = downloadResults[0].first + val info = index.inputStream().use { Json.decodeFromStream(it) } + index.delete() + return@withContext info.mapNotNull { (version, data) -> parseVersion(version, data) }.toList() + } + } + } +} + +private fun parseVersion(versionKey: String, data: JsonElement): ZigVersionInfo? { + if (data !is JsonObject) + return null + + val versionTag = data["version"]?.asSafely()?.content + + val version = SemVer.parseFromText(versionTag) ?: SemVer.parseFromText(versionKey) + ?: return null + val date = data["date"]?.asSafely()?.content ?: "" + val docs = data["docs"]?.asSafely()?.content ?: "" + val notes = data["notes"]?.asSafely()?.content ?: "" + val src = data["src"]?.asSafely()?.let { Json.decodeFromJsonElement(it) } + val dist = data.firstNotNullOfOrNull { (dist, tb) -> getTarballIfCompatible(dist, tb) } + ?: return null + + return ZigVersionInfo(version, date, docs, notes, src, dist) +} diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchain.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchain.kt similarity index 60% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchain.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchain.kt index b534ecb7..385235db 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/LocalZigToolchain.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchain.kt @@ -20,27 +20,27 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain +package com.falsepattern.zigbrains.project.toolchain.local -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.direnv.DirenvService +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.execution.ExecutionException import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.openapi.project.Project import com.intellij.openapi.project.guessProjectDir -import com.intellij.openapi.util.KeyWithDefaultValue import com.intellij.openapi.util.SystemInfo import com.intellij.openapi.vfs.toNioPathOrNull import java.nio.file.Path -class LocalZigToolchain(val location: Path): AbstractZigToolchain() { +@JvmRecord +data class LocalZigToolchain(val location: Path, val std: Path? = null, override val name: String? = null, override val extraData: Map = emptyMap()): ZigToolchain { override fun workingDirectory(project: Project?): Path? { return project?.guessProjectDir()?.toNioPathOrNull() } override suspend fun patchCommandLine(commandLine: GeneralCommandLine, project: Project?): GeneralCommandLine { - if (project != null && (commandLine.getUserData(DIRENV_KEY) ?: project.zigProjectSettings.state.direnv)) { - commandLine.withEnvironment(DirenvCmd.importDirenv(project).env) + if (project != null && DirenvService.getStateFor(commandLine, project).isEnabled(project)) { + commandLine.withEnvironment(DirenvService.getInstance(project).import().env) } return commandLine } @@ -50,11 +50,17 @@ class LocalZigToolchain(val location: Path): AbstractZigToolchain() { return location.resolve(exeName) } - companion object { - val DIRENV_KEY = KeyWithDefaultValue.create("ZIG_LOCAL_DIRENV") + override fun withExtraData(map: Map): ZigToolchain { + return this.copy(extraData = map) + } + override fun withName(newName: String?): LocalZigToolchain { + return this.copy(name = newName) + } + + companion object { @Throws(ExecutionException::class) - fun ensureLocal(toolchain: AbstractZigToolchain): LocalZigToolchain { + fun ensureLocal(toolchain: ZigToolchain): LocalZigToolchain { if (toolchain is LocalZigToolchain) { return toolchain } else { @@ -62,5 +68,20 @@ class LocalZigToolchain(val location: Path): AbstractZigToolchain() { throw ExecutionException("The debugger only supports local zig toolchain") } } + + suspend fun tryFromPath(path: Path): LocalZigToolchain? { + var tc = LocalZigToolchain(path) + if (!tc.zig.fileValid()) { + return null + } + val versionStr = tc.zig + .getEnv(null) + .getOrNull() + ?.version + if (versionStr != null) { + tc = tc.copy(name = "Zig $versionStr") + } + return tc + } } } \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSProjectConfigurationProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainConfigurable.kt similarity index 51% rename from lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSProjectConfigurationProvider.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainConfigurable.kt index 5a1b423a..46a161d6 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSProjectConfigurationProvider.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainConfigurable.kt @@ -20,28 +20,21 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.lsp +package com.falsepattern.zigbrains.project.toolchain.local -import com.falsepattern.zigbrains.lsp.settings.ZLSSettingsConfigurable -import com.falsepattern.zigbrains.lsp.settings.ZLSSettingsPanel import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.falsepattern.zigbrains.shared.SubConfigurable -import com.intellij.openapi.project.Project -import com.intellij.openapi.project.ProjectManager +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainConfigurable +import java.util.* -class ZLSProjectConfigurationProvider: ZigProjectConfigurationProvider { - override fun handleMainConfigChanged(project: Project) { - startLSP(project, true) +class LocalZigToolchainConfigurable( + uuid: UUID, + toolchain: LocalZigToolchain, + data: ZigProjectConfigurationProvider.IUserDataBridge?, + modal: Boolean +): ZigToolchainConfigurable(uuid, toolchain, data, modal) { + override fun createPanel() = LocalZigToolchainPanel() + + override fun setDisplayName(name: String?) { + toolchain = toolchain.copy(name = name) } - - override fun createConfigurable(project: Project): SubConfigurable { - return ZLSSettingsConfigurable(project) - } - - override fun createNewProjectSettingsPanel(holder: ZigProjectConfigurationProvider.SettingsPanelHolder): ZigProjectConfigurationProvider.SettingsPanel { - return ZLSSettingsPanel(ProjectManager.getInstance().defaultProject) - } - - override val priority: Int - get() = 1000 } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsPanel.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainPanel.kt similarity index 51% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsPanel.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainPanel.kt index df1d9115..d614d361 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigProjectSettingsPanel.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainPanel.kt @@ -20,24 +20,16 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.settings +package com.falsepattern.zigbrains.project.toolchain.local import com.falsepattern.zigbrains.ZigBrainsBundle -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.project.toolchain.LocalZigToolchain -import com.falsepattern.zigbrains.project.toolchain.ZigToolchainProvider -import com.falsepattern.zigbrains.shared.coroutine.launchWithEDT +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableNamedElementPanelBase import com.falsepattern.zigbrains.shared.coroutine.withEDTContext import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.openapi.application.ModalityState import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory -import com.intellij.openapi.project.Project import com.intellij.openapi.util.Disposer -import com.intellij.openapi.util.UserDataHolderBase import com.intellij.openapi.util.io.toNioPathOrNull -import com.intellij.platform.ide.progress.ModalTaskOwner -import com.intellij.platform.ide.progress.TaskCancellation -import com.intellij.platform.ide.progress.withModalProgress import com.intellij.ui.DocumentAdapter import com.intellij.ui.JBColor import com.intellij.ui.components.JBCheckBox @@ -52,12 +44,9 @@ import kotlinx.coroutines.launch import javax.swing.event.DocumentEvent import kotlin.io.path.pathString -class ZigProjectSettingsPanel(private val holder: ZigProjectConfigurationProvider.SettingsPanelHolder, private val project: Project) : ZigProjectConfigurationProvider.SettingsPanel { - private val direnv = JBCheckBox(ZigBrainsBundle.message("settings.project.label.direnv")).apply { addActionListener { - dispatchDirenvUpdate() - } } +class LocalZigToolchainPanel() : ImmutableNamedElementPanelBase() { private val pathToToolchain = textFieldWithBrowseButton( - project, + null, ZigBrainsBundle.message("dialog.title.zig-toolchain"), FileChooserDescriptorFactory.createSingleFolderDescriptor() ).also { @@ -69,7 +58,7 @@ class ZigProjectSettingsPanel(private val holder: ZigProjectConfigurationProvide Disposer.register(this, it) } private val toolchainVersion = JBTextArea().also { it.isEditable = false } - private val stdFieldOverride = JBCheckBox(ZigBrainsBundle.message("settings.project.label.override-std")).apply { + private val stdFieldOverride = JBCheckBox().apply { addChangeListener { if (isSelected) { pathToStd.isEnabled = true @@ -80,93 +69,58 @@ class ZigProjectSettingsPanel(private val holder: ZigProjectConfigurationProvide } } private val pathToStd = textFieldWithBrowseButton( - project, + null, ZigBrainsBundle.message("dialog.title.zig-std"), FileChooserDescriptorFactory.createSingleFolderDescriptor() ).also { Disposer.register(this, it) } private var debounce: Job? = null - private fun dispatchDirenvUpdate() { - holder.panels.forEach { - it.direnvChanged(direnv.isSelected) - } - } - - override fun direnvChanged(state: Boolean) { - dispatchAutodetect(true) - } - - private fun dispatchAutodetect(force: Boolean) { - project.zigCoroutineScope.launchWithEDT(ModalityState.defaultModalityState()) { - withModalProgress(ModalTaskOwner.component(pathToToolchain), "Detecting Zig...", TaskCancellation.cancellable()) { - autodetect(force) - } - } - } - - suspend fun autodetect(force: Boolean) { - if (!force && pathToToolchain.text.isNotBlank()) - return - val data = UserDataHolderBase() - data.putUserData(LocalZigToolchain.DIRENV_KEY, !project.isDefault && direnv.isSelected && DirenvCmd.direnvInstalled()) - val tc = ZigToolchainProvider.suggestToolchain(project, data) ?: return - if (tc !is LocalZigToolchain) { - TODO("Implement non-local zig toolchain in config") - } - if (force || pathToToolchain.text.isBlank()) { - pathToToolchain.text = tc.location.pathString - dispatchUpdateUI() - } - } - - override var data - get() = ZigProjectSettings( - direnv.isSelected, - stdFieldOverride.isSelected, - pathToStd.text.ifBlank { null }, - pathToToolchain.text.ifBlank { null } - ) - set(value) { - direnv.isSelected = value.direnv - pathToToolchain.text = value.toolchainPath ?: "" - stdFieldOverride.isSelected = value.overrideStdPath - pathToStd.text = value.explicitPathToStd ?: "" - pathToStd.isEnabled = value.overrideStdPath - dispatchUpdateUI() - } - override fun attach(p: Panel): Unit = with(p) { - data = project.zigProjectSettings.state - if (project.isDefault) { - row(ZigBrainsBundle.message("settings.project.label.toolchain")) { - cell(pathToToolchain).resizableColumn().align(AlignX.FILL) - } - row(ZigBrainsBundle.message("settings.project.label.toolchain-version")) { - cell(toolchainVersion) - } - } else { - group(ZigBrainsBundle.message("settings.project.group.title")) { - row(ZigBrainsBundle.message("settings.project.label.toolchain")) { - cell(pathToToolchain).resizableColumn().align(AlignX.FILL) - if (DirenvCmd.direnvInstalled()) { - cell(direnv) - } - } - row(ZigBrainsBundle.message("settings.project.label.toolchain-version")) { - cell(toolchainVersion) - } - row(ZigBrainsBundle.message("settings.project.label.std-location")) { - cell(pathToStd).resizableColumn().align(AlignX.FILL) - cell(stdFieldOverride) - } - } + super.attach(p) + row(ZigBrainsBundle.message("settings.toolchain.local.path.label")) { + cell(pathToToolchain).resizableColumn().align(AlignX.FILL) + } + row(ZigBrainsBundle.message("settings.toolchain.local.version.label")) { + cell(toolchainVersion) + } + row(ZigBrainsBundle.message("settings.toolchain.local.std.label")) { + cell(stdFieldOverride) + cell(pathToStd).resizableColumn().align(AlignX.FILL) + } + } + + override fun isModified(toolchain: LocalZigToolchain): Boolean { + val name = nameFieldValue ?: return false + val location = this.pathToToolchain.text.ifBlank { null }?.toNioPathOrNull() ?: return false + val std = if (stdFieldOverride.isSelected) pathToStd.text.ifBlank { null }?.toNioPathOrNull() else null + return name != toolchain.name || toolchain.location != location || toolchain.std != std + } + + override fun apply(toolchain: LocalZigToolchain): LocalZigToolchain? { + val location = this.pathToToolchain.text.ifBlank { null }?.toNioPathOrNull() ?: return null + val std = if (stdFieldOverride.isSelected) pathToStd.text.ifBlank { null }?.toNioPathOrNull() else null + return toolchain.copy(location = location, std = std, name = nameFieldValue ?: "") + } + + override fun reset(toolchain: LocalZigToolchain?) { + nameFieldValue = toolchain?.name ?: "" + this.pathToToolchain.text = toolchain?.location?.pathString ?: "" + val std = toolchain?.std + if (std != null) { + stdFieldOverride.isSelected = true + pathToStd.text = std.pathString + pathToStd.isEnabled = true + } else { + stdFieldOverride.isSelected = false + pathToStd.text = "" + pathToStd.isEnabled = false + dispatchUpdateUI() } - dispatchAutodetect(false) } private fun dispatchUpdateUI() { debounce?.cancel("New debounce") - debounce = project.zigCoroutineScope.launch { + debounce = zigCoroutineScope.launch { updateUI() } } @@ -185,7 +139,7 @@ class ZigProjectSettingsPanel(private val holder: ZigProjectConfigurationProvide } val toolchain = LocalZigToolchain(pathToToolchain) val zig = toolchain.zig - val env = zig.getEnv(project).getOrElse { throwable -> + val env = zig.getEnv(null).getOrElse { throwable -> throwable.printStackTrace() withEDTContext(ModalityState.any()) { toolchainVersion.text = "[failed to run \"zig env\"]\n${throwable.message}" @@ -196,7 +150,7 @@ class ZigProjectSettingsPanel(private val holder: ZigProjectConfigurationProvide return } val version = env.version - val stdPath = env.stdPath(toolchain, project) + val stdPath = env.stdPath(toolchain, null) withEDTContext(ModalityState.any()) { toolchainVersion.text = version diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainProvider.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainProvider.kt new file mode 100644 index 00000000..dee209ee --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/local/LocalZigToolchainProvider.kt @@ -0,0 +1,147 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.local + +import com.falsepattern.zigbrains.direnv.DirenvService +import com.falsepattern.zigbrains.direnv.Env +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainConfigurable +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainProvider +import com.falsepattern.zigbrains.shared.ui.renderPathNameComponent +import com.intellij.openapi.project.Project +import com.intellij.openapi.util.UserDataHolder +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.ui.SimpleColoredComponent +import com.intellij.util.system.OS +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.flow.* +import java.nio.file.Files +import java.nio.file.Path +import java.util.* +import kotlin.io.path.isDirectory +import kotlin.io.path.pathString + +class LocalZigToolchainProvider: ZigToolchainProvider { + override val serialMarker: String + get() = "local" + + override fun deserialize(data: Map): ZigToolchain? { + val location = data["location"]?.toNioPathOrNull() ?: return null + val std = data["std"]?.toNioPathOrNull() + val name = data["name"] + return LocalZigToolchain(location, std, name) + } + + override fun isCompatible(toolchain: ZigToolchain): Boolean { + return toolchain is LocalZigToolchain + } + + override fun serialize(toolchain: ZigToolchain): Map { + toolchain as LocalZigToolchain + val map = HashMap() + toolchain.location.pathString.let { map["location"] = it } + toolchain.std?.pathString?.let { map["std"] = it } + toolchain.name?.let { map["name"] = it } + return map + } + + override fun matchesSuggestion( + toolchain: ZigToolchain, + suggestion: ZigToolchain + ): Boolean { + toolchain as LocalZigToolchain + suggestion as LocalZigToolchain + return toolchain.location == suggestion.location + } + + override fun createConfigurable( + uuid: UUID, + toolchain: ZigToolchain, + data: ZigProjectConfigurationProvider.IUserDataBridge?, + modal: Boolean + ): ZigToolchainConfigurable<*> { + toolchain as LocalZigToolchain + return LocalZigToolchainConfigurable(uuid, toolchain, data, modal) + } + + @OptIn(ExperimentalCoroutinesApi::class) + override suspend fun suggestToolchains(project: Project?, data: UserDataHolder): Flow { + val env = if (project != null && DirenvService.getStateFor(data, project).isEnabled(project)) { + DirenvService.getInstance(project).import() + } else { + Env.empty + } + val pathToolchains = env.findAllExecutablesOnPATH("zig").mapNotNull { it.parent } + val wellKnown = getWellKnown().asFlow().flatMapConcat { dir -> + runCatching { + Files.newDirectoryStream(dir).use { stream -> + stream.toList().filterNotNull().asFlow() + } + }.getOrElse { emptyFlow() } + } + val joined = flowOf(pathToolchains, wellKnown).flattenConcat() + return joined.mapNotNull { LocalZigToolchain.tryFromPath(it) } + } + + override fun render(toolchain: ZigToolchain, component: SimpleColoredComponent, isSuggestion: Boolean, isSelected: Boolean) { + toolchain as LocalZigToolchain + val name = toolchain.name + val path = toolchain.location.pathString + renderPathNameComponent(path, name, "Zig", component, isSuggestion, isSelected) + } +} + +fun getSuggestedLocalToolchainPath(): Path? { + return getWellKnown().getOrNull(0) +} + +/** + * Returns the paths to the following list of folders: + * + * 1. DATA/zig + * 2. DATA/zigup + * 3. HOME/.zig + * + * Where DATA is: + * - ~/Library on macOS + * - %LOCALAPPDATA% on Windows + * - $XDG_DATA_HOME (or ~/.local/share if not set) on other OSes + * + * and HOME is the user home path + */ +private fun getWellKnown(): List { + val home = System.getProperty("user.home")?.toNioPathOrNull() ?: return emptyList() + val xdgDataHome = when(OS.CURRENT) { + OS.macOS -> home.resolve("Library") + OS.Windows -> System.getenv("LOCALAPPDATA")?.toNioPathOrNull() + else -> System.getenv("XDG_DATA_HOME")?.toNioPathOrNull() ?: home.resolve(Path.of(".local", "share")) + } + val res = ArrayList() + if (xdgDataHome != null && xdgDataHome.isDirectory()) { + res.add(xdgDataHome.resolve("zig")) + res.add(xdgDataHome.resolve("zigup")) + } + res.add(home.resolve(".zig")) + return res +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigCompilerTool.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigCompilerTool.kt index 85e2af65..50357a3f 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigCompilerTool.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigCompilerTool.kt @@ -22,14 +22,13 @@ package com.falsepattern.zigbrains.project.toolchain.tools -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain -import com.falsepattern.zigbrains.project.toolchain.ZigToolchainEnvironmentSerializable +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.intellij.openapi.project.Project import kotlinx.serialization.SerializationException import kotlinx.serialization.json.Json import java.nio.file.Path -class ZigCompilerTool(toolchain: AbstractZigToolchain) : ZigTool(toolchain) { +class ZigCompilerTool(toolchain: ZigToolchain) : ZigTool(toolchain) { override val toolName: String get() = "zig" diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigTool.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigTool.kt index 27b106bf..fa9c5d49 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigTool.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigTool.kt @@ -22,15 +22,16 @@ package com.falsepattern.zigbrains.project.toolchain.tools -import com.falsepattern.zigbrains.project.toolchain.AbstractZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain import com.falsepattern.zigbrains.shared.cli.call import com.falsepattern.zigbrains.shared.cli.createCommandLineSafe import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.execution.process.ProcessOutput import com.intellij.openapi.project.Project import java.nio.file.Path +import kotlin.io.path.isRegularFile -abstract class ZigTool(val toolchain: AbstractZigToolchain) { +abstract class ZigTool(val toolchain: ZigToolchain) { abstract val toolName: String suspend fun callWithArgs(workingDirectory: Path?, vararg parameters: String, timeoutMillis: Long = Long.MAX_VALUE, ipcProject: Project? = null): Result { @@ -38,6 +39,11 @@ abstract class ZigTool(val toolchain: AbstractZigToolchain) { return cli.call(timeoutMillis, ipcProject = ipcProject) } + fun fileValid(): Boolean { + val exe = toolchain.pathToExecutable(toolName) + return exe.isRegularFile() + } + private suspend fun createBaseCommandLine( workingDirectory: Path?, vararg parameters: String diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainEnvironmentSerializable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigToolchainEnvironmentSerializable.kt similarity index 93% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainEnvironmentSerializable.kt rename to core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigToolchainEnvironmentSerializable.kt index 8bda26d3..15e8a7ae 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ZigToolchainEnvironmentSerializable.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/tools/ZigToolchainEnvironmentSerializable.kt @@ -19,15 +19,16 @@ * You should have received a copy of the GNU Lesser General Public License * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain +package com.falsepattern.zigbrains.project.toolchain.tools + +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.openapi.project.Project import com.intellij.openapi.util.io.toNioPathOrNull import kotlinx.serialization.SerialName import kotlinx.serialization.Serializable import java.nio.file.Path - @JvmRecord @Serializable data class ZigToolchainEnvironmentSerializable( @@ -49,4 +50,4 @@ data class ZigToolchainEnvironmentSerializable( return null } -} +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableElementPanel.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableElementPanel.kt new file mode 100644 index 00000000..40e62f63 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableElementPanel.kt @@ -0,0 +1,36 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.intellij.openapi.Disposable +import com.intellij.ui.dsl.builder.Panel + +interface ImmutableElementPanel: Disposable { + fun attach(p: Panel) + fun isModified(elem: T): Boolean + /** + * Returned object must be the exact same class as the provided one. + */ + fun apply(elem: T): T? + fun reset(elem: T?) +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableNamedElementPanelBase.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableNamedElementPanelBase.kt new file mode 100644 index 00000000..5f3906c4 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ImmutableNamedElementPanelBase.kt @@ -0,0 +1,43 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.intellij.ui.components.JBTextField +import com.intellij.ui.dsl.builder.AlignX +import com.intellij.ui.dsl.builder.Panel + +abstract class ImmutableNamedElementPanelBase: ImmutableElementPanel { + private val nameField = JBTextField(25) + + protected var nameFieldValue: String? + get() = nameField.text.ifBlank { null } + set(value) {nameField.text = value ?: ""} + + override fun attach(p: Panel): Unit = with(p) { + row(ZigBrainsBundle.message("settings.toolchain.base.name.label")) { + cell(nameField).resizableColumn().align(AlignX.FILL) + } + separator() + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainComboBoxHandler.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainComboBoxHandler.kt new file mode 100644 index 00000000..2f323184 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainComboBoxHandler.kt @@ -0,0 +1,42 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.downloader.LocalToolchainDownloader +import com.falsepattern.zigbrains.project.toolchain.downloader.LocalToolchainSelector +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.falsepattern.zigbrains.shared.ui.ListElem +import com.falsepattern.zigbrains.shared.withUniqueName +import com.intellij.util.concurrency.annotations.RequiresBackgroundThread +import java.awt.Component +import java.util.* + +internal object ZigToolchainComboBoxHandler { + @RequiresBackgroundThread + suspend fun onItemSelected(context: Component, elem: ListElem.Pseudo): UUID? = when(elem) { + is ListElem.One.Suggested -> zigToolchainList.withUniqueName(elem.instance) + is ListElem.Download -> LocalToolchainDownloader(context).download() + is ListElem.FromDisk -> LocalToolchainSelector(context).browse() + }?.let { zigToolchainList.registerNew(it) } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainDriver.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainDriver.kt new file mode 100644 index 00000000..6e02494f --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainDriver.kt @@ -0,0 +1,91 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider.Companion.PROJECT_KEY +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.createNamedConfigurable +import com.falsepattern.zigbrains.project.toolchain.base.suggestZigToolchains +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.falsepattern.zigbrains.shared.ui.* +import com.intellij.openapi.ui.NamedConfigurable +import java.awt.Component +import java.util.* + +sealed interface ZigToolchainDriver: UUIDComboBoxDriver { + override val theMap get() = zigToolchainList + + override fun createContext(model: ZBModel): ZBContext { + return TCContext(null, model) + } + + override fun createComboBox(model: ZBModel): ZBComboBox { + return TCComboBox(model) + } + + override suspend fun resolvePseudo( + context: Component, + elem: ListElem.Pseudo + ): UUID? { + return ZigToolchainComboBoxHandler.onItemSelected(context, elem) + } + + object ForList: ZigToolchainDriver { + override suspend fun constructModelList(): List> { + val modelList = ArrayList>() + modelList.addAll(ListElem.fetchGroup()) + modelList.add(Separator(ZigBrainsBundle.message("settings.toolchain.model.detected.separator"), true)) + modelList.add(suggestZigToolchains().asPending()) + return modelList + } + + override fun createNamedConfigurable( + uuid: UUID, + elem: ZigToolchain + ): NamedConfigurable { + return elem.createNamedConfigurable(uuid, ZigProjectConfigurationProvider.UserDataBridge(), false) + } + } + + class ForSelector(val data: ZigProjectConfigurationProvider.IUserDataBridge): ZigToolchainDriver { + override suspend fun constructModelList(): List> { + val modelList = ArrayList>() + modelList.add(ListElem.None()) + modelList.addAll(zigToolchainList.map { it.asActual() }.sortedBy { it.instance.name }) + modelList.add(Separator("", true)) + modelList.addAll(ListElem.fetchGroup()) + modelList.add(Separator(ZigBrainsBundle.message("settings.toolchain.model.detected.separator"), true)) + modelList.add(suggestZigToolchains(data.getUserData(PROJECT_KEY), data).asPending()) + return modelList + } + + override fun createNamedConfigurable( + uuid: UUID, + elem: ZigToolchain + ): NamedConfigurable { + return elem.createNamedConfigurable(uuid, data, true) + } + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainEditor.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainEditor.kt new file mode 100644 index 00000000..30ec0ae6 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainEditor.kt @@ -0,0 +1,141 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider.Companion.PROJECT_KEY +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.project.toolchain.base.PanelState +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainConfigurable +import com.falsepattern.zigbrains.project.toolchain.base.createZigToolchainExtensionPanels +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.falsepattern.zigbrains.shared.SubConfigurable +import com.falsepattern.zigbrains.shared.ui.UUIDMapSelector +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.project.Project +import com.intellij.openapi.project.ProjectManager +import com.intellij.openapi.util.Key +import com.intellij.ui.dsl.builder.Panel +import kotlinx.coroutines.launch +import java.util.* +import java.util.function.Supplier + +class ZigToolchainEditor(private val sharedState: ZigProjectConfigurationProvider.IUserDataBridge): + UUIDMapSelector(ZigToolchainDriver.ForSelector(sharedState)), + SubConfigurable, + ZigProjectConfigurationProvider.UserDataListener +{ + private var myViews: List> = emptyList() + init { + sharedState.putUserData(ZigToolchainConfigurable.TOOLCHAIN_KEY, Supplier{selectedUUID?.let { zigToolchainList[it] }}) + sharedState.addUserDataChangeListener(this) + } + + override fun onUserDataChanged(key: Key<*>) { + if (key == ZigToolchainConfigurable.TOOLCHAIN_KEY) + return + zigCoroutineScope.launch { listChanged() } + } + + + override fun attach(p: Panel): Unit = with(p) { + row(ZigBrainsBundle.message( + if (sharedState.getUserData(PROJECT_KEY)?.isDefault == true) + "settings.toolchain.editor.toolchain-default.label" + else + "settings.toolchain.editor.toolchain.label") + ) { + attachComboBoxRow(this) + } + var views = myViews + if (views.isEmpty()) { + views = ArrayList>() + views.addAll(createZigToolchainExtensionPanels(sharedState, PanelState.ProjectEditor)) + myViews = views + } + views.forEach { it.attach(p) } + } + + override fun onSelection(uuid: UUID?) { + sharedState.putUserData(ZigToolchainConfigurable.TOOLCHAIN_KEY, Supplier{selectedUUID?.let { zigToolchainList[it] }}) + refreshViews(uuid) + } + + private fun refreshViews(uuid: UUID?) { + val toolchain = uuid?.let { zigToolchainList[it] } + myViews.forEach { it.reset(toolchain) } + } + + override fun isModified(context: Project): Boolean { + if (isEmpty) + return false + val uuid = selectedUUID + if (ZigToolchainService.getInstance(context).toolchainUUID != selectedUUID) { + return true + } + if (uuid == null) + return false + val tc = zigToolchainList[uuid] + if (tc == null) + return false + return myViews.any { it.isModified(tc) } + } + + override fun apply(context: Project) { + val uuid = selectedUUID + ZigToolchainService.getInstance(context).toolchainUUID = uuid + if (uuid == null) + return + val tc = zigToolchainList[uuid] + if (tc == null) + return + val finalTc = myViews.fold(tc) { acc, view -> view.apply(acc) ?: acc } + zigToolchainList[uuid] = finalTc + } + + override fun reset(context: Project?) { + val project = context ?: ProjectManager.getInstance().defaultProject + val svc = ZigToolchainService.getInstance(project) + val uuid = svc.toolchainUUID + selectedUUID = uuid + refreshViews(uuid) + } + + override fun dispose() { + super.dispose() + sharedState.removeUserDataChangeListener(this) + myViews.forEach { it.dispose() } + myViews = emptyList() + } + + override val newProjectBeforeInitSelector get() = true + class Provider: ZigProjectConfigurationProvider { + override fun create(sharedState: ZigProjectConfigurationProvider.IUserDataBridge): SubConfigurable? { + return ZigToolchainEditor(sharedState).also { it.reset(sharedState.getUserData(PROJECT_KEY)) } + } + + override val index: Int get() = 0 + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainListEditor.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainListEditor.kt new file mode 100644 index 00000000..7dd9131d --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/ZigToolchainListEditor.kt @@ -0,0 +1,31 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.shared.ui.UUIDMapEditor + +class ZigToolchainListEditor : UUIDMapEditor(ZigToolchainDriver.ForList) { + override fun getDisplayName() = ZigBrainsBundle.message("settings.toolchain.list.title") +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/model.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/model.kt new file mode 100644 index 00000000..f157649d --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ui/model.kt @@ -0,0 +1,80 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.project.toolchain.ui + +import com.falsepattern.zigbrains.Icons +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.render +import com.falsepattern.zigbrains.shared.ui.* +import com.intellij.icons.AllIcons +import com.intellij.openapi.project.Project +import com.intellij.ui.SimpleTextAttributes +import com.intellij.ui.icons.EMPTY_ICON +import javax.swing.JList + +class TCComboBox(model: ZBModel): ZBComboBox(model, ::TCCellRenderer) + +class TCContext(project: Project?, model: ZBModel): ZBContext(project, model, ::TCCellRenderer) + +class TCCellRenderer(getModel: () -> ZBModel): ZBCellRenderer(getModel) { + override fun customizeCellRenderer( + list: JList?>, + value: ListElem?, + index: Int, + selected: Boolean, + hasFocus: Boolean + ) { + icon = EMPTY_ICON + when (value) { + is ListElem.One -> { + val (icon, isSuggestion) = when(value) { + is ListElem.One.Suggested -> AllIcons.General.Information to true + is ListElem.One.Actual -> Icons.Zig to false + } + this.icon = icon + val item = value.instance + item.render(this, isSuggestion, index == -1) + } + + is ListElem.Download -> { + icon = AllIcons.Actions.Download + append(ZigBrainsBundle.message("settings.toolchain.model.download.text")) + } + + is ListElem.FromDisk -> { + icon = AllIcons.General.OpenDisk + append(ZigBrainsBundle.message("settings.toolchain.model.from-disk.text")) + } + is ListElem.Pending -> { + icon = AllIcons.Empty + append(ZigBrainsBundle.message("settings.toolchain.model.loading.text"), SimpleTextAttributes.GRAYED_ATTRIBUTES) + } + is ListElem.None, null -> { + icon = AllIcons.General.BalloonError + append(ZigBrainsBundle.message("settings.toolchain.model.none.text"), SimpleTextAttributes.ERROR_ATTRIBUTES) + } + } + } + +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/MultiConfigurable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/MultiConfigurable.kt deleted file mode 100644 index 36c30c13..00000000 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/MultiConfigurable.kt +++ /dev/null @@ -1,57 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.shared - -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.intellij.openapi.options.Configurable -import com.intellij.openapi.util.Disposer -import com.intellij.ui.dsl.builder.panel -import javax.swing.JComponent - -abstract class MultiConfigurable(val configurables: List): Configurable, ZigProjectConfigurationProvider.SettingsPanelHolder { - final override var panels: List = emptyList() - private set - - override fun createComponent(): JComponent? { - return panel { - panels = configurables.map { it.createComponent(this@MultiConfigurable, this@panel) } - } - } - - override fun isModified(): Boolean { - return configurables.any { it.isModified() } - } - - override fun apply() { - configurables.forEach { it.apply() } - } - - override fun reset() { - configurables.forEach { it.reset() } - } - - override fun disposeUIResources() { - configurables.forEach { Disposer.dispose(it) } - panels = emptyList() - } -} diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/NamedObject.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/NamedObject.kt new file mode 100644 index 00000000..3bb35b82 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/NamedObject.kt @@ -0,0 +1,32 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared + +interface NamedObject> { + val name: String? + + /** + * Returned object must be the exact same class as the called one. + */ + fun withName(newName: String?): T +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/SubConfigurable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/SubConfigurable.kt index 5e7c52e5..eafca678 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/SubConfigurable.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/SubConfigurable.kt @@ -22,16 +22,72 @@ package com.falsepattern.zigbrains.shared -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider.SettingsPanelHolder import com.intellij.openapi.Disposable -import com.intellij.openapi.options.ConfigurationException +import com.intellij.openapi.options.Configurable +import com.intellij.openapi.util.Disposer import com.intellij.ui.dsl.builder.Panel +import com.intellij.ui.dsl.builder.panel +import javax.swing.JComponent -interface SubConfigurable: Disposable { - fun createComponent(holder: SettingsPanelHolder, panel: Panel): ZigProjectConfigurationProvider.SettingsPanel - fun isModified(): Boolean - @Throws(ConfigurationException::class) - fun apply() - fun reset() +interface SubConfigurable: Disposable { + fun attach(panel: Panel) + fun isModified(context: T): Boolean + fun apply(context: T) + fun reset(context: T?) + + val newProjectBeforeInitSelector: Boolean get() = false + + abstract class Adapter: Configurable { + private val myConfigurables: MutableList> = ArrayList() + + abstract fun instantiate(): List> + protected abstract val context: T + + override fun createComponent(): JComponent? { + val configurables: List> + synchronized(myConfigurables) { + if (myConfigurables.isEmpty()) { + disposeConfigurables() + } + configurables = instantiate() + configurables.forEach { it.reset(context) } + myConfigurables.clear() + myConfigurables.addAll(configurables) + } + return panel { + configurables.forEach { it.attach(this) } + } + } + + override fun isModified(): Boolean { + synchronized(myConfigurables) { + return myConfigurables.any { it.isModified(context) } + } + } + + override fun apply() { + synchronized(myConfigurables) { + myConfigurables.forEach { it.apply(context) } + } + } + + override fun reset() { + synchronized(myConfigurables) { + myConfigurables.forEach { it.reset(context) } + } + } + + override fun disposeUIResources() { + synchronized(myConfigurables) { + disposeConfigurables() + } + super.disposeUIResources() + } + + private fun disposeConfigurables() { + val configurables = ArrayList(myConfigurables) + myConfigurables.clear() + configurables.forEach { Disposer.dispose(it) } + } + } } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUID.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUID.kt new file mode 100644 index 00000000..214fcd58 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUID.kt @@ -0,0 +1,28 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared + +import java.util.* + +fun String.asUUID(): UUID? = UUID.fromString(this) +fun UUID.asString(): String = toString() \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUIDMapSerializable.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUIDMapSerializable.kt new file mode 100644 index 00000000..2590d2b6 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/UUIDMapSerializable.kt @@ -0,0 +1,191 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared + +import com.intellij.openapi.components.SerializablePersistentStateComponent +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.launch +import java.lang.ref.WeakReference +import java.util.* + +typealias UUIDStorage = Map + +abstract class UUIDMapSerializable(init: S): SerializablePersistentStateComponent(init), ChangeTrackingStorage { + private val changeListeners = ArrayList>() + + protected abstract fun getStorage(state: S): UUIDStorage + + protected abstract fun updateStorage(state: S, storage: UUIDStorage): S + + override fun addChangeListener(listener: StorageChangeListener) { + synchronized(changeListeners) { + changeListeners.add(WeakReference(listener)) + } + } + + override fun removeChangeListener(listener: StorageChangeListener) { + synchronized(changeListeners) { + changeListeners.removeIf { + val v = it.get() + v == null || v === listener + } + } + } + + protected fun registerNewUUID(value: T): UUID { + var uuid = UUID.randomUUID() + updateState { + val newMap = HashMap() + newMap.putAll(getStorage(it)) + var uuidStr = uuid.asString() + while (newMap.containsKey(uuidStr)) { + uuid = UUID.randomUUID() + uuidStr = uuid.asString() + } + newMap[uuidStr] = value + updateStorage(it, newMap) + } + notifyChanged() + return uuid + } + + protected fun setStateUUID(uuid: UUID, value: T) { + val str = uuid.asString() + updateState { + val newMap = HashMap() + newMap.putAll(getStorage(it)) + newMap[str] = value + updateStorage(it, newMap) + } + notifyChanged() + } + + protected fun getStateUUID(uuid: UUID): T? { + return getStorage(state)[uuid.asString()] + } + + protected fun hasStateUUID(uuid: UUID): Boolean { + return getStorage(state).containsKey(uuid.asString()) + } + + protected fun removeStateUUID(uuid: UUID) { + val str = uuid.asString() + updateState { + updateStorage(state, getStorage(state).filter { it.key != str }) + } + notifyChanged() + } + + private fun notifyChanged() { + synchronized(changeListeners) { + var i = 0 + while (i < changeListeners.size) { + val v = changeListeners[i].get() + if (v == null) { + changeListeners.removeAt(i) + continue + } + zigCoroutineScope.launch { + v() + } + i++ + } + } + } + + abstract class Converting(init: S): + UUIDMapSerializable(init), + AccessibleStorage, + IterableStorage + { + protected abstract fun serialize(value: R): T + protected abstract fun deserialize(value: T): R? + override fun registerNew(value: R): UUID { + val ser = serialize(value) + return registerNewUUID(ser) + } + override operator fun set(uuid: UUID, value: R) { + val ser = serialize(value) + setStateUUID(uuid, ser) + } + override operator fun get(uuid: UUID): R? { + return getStateUUID(uuid)?.let { deserialize(it) } + } + override operator fun contains(uuid: UUID): Boolean { + return hasStateUUID(uuid) + } + override fun remove(uuid: UUID) { + removeStateUUID(uuid) + } + + override fun iterator(): Iterator> { + return getStorage(state) + .asSequence() + .mapNotNull { + val uuid = it.key.asUUID() ?: return@mapNotNull null + val tc = deserialize(it.value) ?: return@mapNotNull null + uuid to tc + }.iterator() + } + } + + abstract class Direct(init: S): Converting(init) { + override fun serialize(value: T): T { + return value + } + + override fun deserialize(value: T): T? { + return value + } + } +} + +typealias StorageChangeListener = suspend CoroutineScope.() -> Unit + +interface ChangeTrackingStorage { + fun addChangeListener(listener: StorageChangeListener) + fun removeChangeListener(listener: StorageChangeListener) +} + +interface AccessibleStorage { + fun registerNew(value: R): UUID + operator fun set(uuid: UUID, value: R) + operator fun get(uuid: UUID): R? + operator fun contains(uuid: UUID): Boolean + fun remove(uuid: UUID) +} + +interface IterableStorage: Iterable> + +fun , T: R> IterableStorage.withUniqueName(value: T): T { + val baseName = value.name ?: "" + var index = 0 + var currentName = baseName + val names = this.map { (_, existing) -> existing.name } + while (names.any { it == currentName }) { + index++ + currentName = "$baseName ($index)" + } + @Suppress("UNCHECKED_CAST") + return value.withName(currentName) as T +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/Unarchiver.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/Unarchiver.kt new file mode 100644 index 00000000..acc89145 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/Unarchiver.kt @@ -0,0 +1,73 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared + +import com.intellij.openapi.progress.EmptyProgressIndicator +import com.intellij.openapi.progress.ProgressManager +import com.intellij.util.io.Decompressor +import java.io.IOException +import java.nio.file.Path +import kotlin.io.path.name + +enum class Unarchiver { + ZIP { + override val extension = "zip" + override fun createDecompressor(file: Path) = Decompressor.Zip(file) + }, + TAR_GZ { + override val extension = "tar.gz" + override fun createDecompressor(file: Path) = Decompressor.Tar(file) + }, + TAR_XZ { + override val extension = "tar.xz" + override fun createDecompressor(file: Path) = Decompressor.Tar(file) + }, + VSIX { + override val extension = "vsix" + override fun createDecompressor(file: Path) = Decompressor.Zip(file) + }; + + protected abstract val extension: String + protected abstract fun createDecompressor(file: Path): Decompressor + + companion object { + @Throws(IOException::class) + fun unarchive(archivePath: Path, dst: Path, prefix: String? = null) { + val unarchiver = entries.find { archivePath.name.endsWith(it.extension) } + ?: error("Unexpected archive type: $archivePath") + val dec = unarchiver.createDecompressor(archivePath) + val indicator = ProgressManager.getInstance().progressIndicator ?: EmptyProgressIndicator() + indicator.isIndeterminate = true + indicator.text = "Extracting archive" + dec.filter { + indicator.text2 = it + indicator.checkCanceled() + true + } + if (prefix != null) { + dec.removePrefixPath(prefix) + } + dec.extract(dst) + } + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/cli/CLIUtil.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/cli/CLIUtil.kt index e1c48c16..d8042fae 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/cli/CLIUtil.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/cli/CLIUtil.kt @@ -28,7 +28,6 @@ import com.falsepattern.zigbrains.shared.ipc.IPCUtil import com.falsepattern.zigbrains.shared.ipc.ipc import com.intellij.execution.ExecutionException import com.intellij.execution.configurations.GeneralCommandLine -import com.intellij.execution.process.ProcessHandler import com.intellij.execution.process.ProcessOutput import com.intellij.execution.process.ProcessTerminatedListener import com.intellij.openapi.options.ConfigurationException diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/coroutine/CoroutinesUtil.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/coroutine/CoroutinesUtil.kt index b41f0f25..8d3d47ad 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/coroutine/CoroutinesUtil.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/coroutine/CoroutinesUtil.kt @@ -30,6 +30,8 @@ import com.intellij.platform.ide.progress.TaskCancellation import com.intellij.platform.ide.progress.runWithModalProgressBlocking import com.intellij.util.application import kotlinx.coroutines.* +import java.awt.Component +import kotlin.coroutines.CoroutineContext inline fun runModalOrBlocking(taskOwnerFactory: () -> ModalTaskOwner, titleFactory: () -> String, cancellationFactory: () -> TaskCancellation = TaskCancellation::cancellable, noinline action: suspend CoroutineScope.() -> T): T { return if (application.isDispatchThread) { @@ -40,7 +42,11 @@ inline fun runModalOrBlocking(taskOwnerFactory: () -> ModalTaskOwner, titleF } suspend inline fun withEDTContext(state: ModalityState, noinline block: suspend CoroutineScope.() -> T): T { - return withContext(Dispatchers.EDT + state.asContextElement(), block = block) + return withEDTContext(state.asContextElement(), block = block) +} + +suspend inline fun withEDTContext(context: CoroutineContext, noinline block: suspend CoroutineScope.() -> T): T { + return withContext(Dispatchers.EDT + context, block = block) } suspend inline fun withCurrentEDTModalityContext(noinline block: suspend CoroutineScope.() -> T): T { @@ -50,9 +56,19 @@ suspend inline fun withCurrentEDTModalityContext(noinline block: suspend Cor } suspend inline fun runInterruptibleEDT(state: ModalityState, noinline targetAction: () -> T): T { - return runInterruptible(Dispatchers.EDT + state.asContextElement(), block = targetAction) + return runInterruptibleEDT(state.asContextElement(), targetAction = targetAction) +} +suspend inline fun runInterruptibleEDT(context: CoroutineContext, noinline targetAction: () -> T): T { + return runInterruptible(Dispatchers.EDT + context, block = targetAction) } fun CoroutineScope.launchWithEDT(state: ModalityState, block: suspend CoroutineScope.() -> Unit): Job { - return launch(Dispatchers.EDT + state.asContextElement(), block = block) + return launchWithEDT(state.asContextElement(), block = block) +} +fun CoroutineScope.launchWithEDT(context: CoroutineContext, block: suspend CoroutineScope.() -> Unit): Job { + return launch(Dispatchers.EDT + context, block = block) +} + +fun Component.asContextElement(): CoroutineContext { + return ModalityState.stateForComponent(this).asContextElement() } \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/DirectoryState.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/DirectoryState.kt new file mode 100644 index 00000000..ac6110e7 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/DirectoryState.kt @@ -0,0 +1,78 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.downloader + +import java.nio.file.Files +import java.nio.file.Path +import kotlin.io.path.exists +import kotlin.io.path.isDirectory + +enum class DirectoryState { + Invalid, + NotAbsolute, + NotDirectory, + NotEmpty, + CreateNew, + Ok; + + fun isValid(): Boolean { + return when(this) { + Invalid, NotAbsolute, NotDirectory, NotEmpty -> false + CreateNew, Ok -> true + } + } + + companion object { + @JvmStatic + fun determine(path: Path?): DirectoryState { + if (path == null) { + return Invalid + } + if (!path.isAbsolute) { + return NotAbsolute + } + if (!path.exists()) { + var parent: Path? = path.parent + while(parent != null) { + if (!parent.exists()) { + parent = parent.parent + continue + } + if (!parent.isDirectory()) { + return NotDirectory + } + return CreateNew + } + return Invalid + } + if (!path.isDirectory()) { + return NotDirectory + } + val isEmpty = Files.newDirectoryStream(path).use { !it.iterator().hasNext() } + if (!isEmpty) { + return NotEmpty + } + return Ok + } + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/Downloader.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/Downloader.kt new file mode 100644 index 00000000..fb81e7a2 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/Downloader.kt @@ -0,0 +1,172 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.coroutine.asContextElement +import com.falsepattern.zigbrains.shared.coroutine.runInterruptibleEDT +import com.intellij.icons.AllIcons +import com.intellij.openapi.observable.util.whenFocusGained +import com.intellij.openapi.ui.ComboBox +import com.intellij.openapi.ui.DialogBuilder +import com.intellij.openapi.util.Disposer +import com.intellij.openapi.util.NlsContexts +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.platform.ide.progress.ModalTaskOwner +import com.intellij.platform.ide.progress.TaskCancellation +import com.intellij.platform.ide.progress.withModalProgress +import com.intellij.ui.ColoredListCellRenderer +import com.intellij.ui.DocumentAdapter +import com.intellij.ui.components.JBLabel +import com.intellij.ui.components.textFieldWithBrowseButton +import com.intellij.ui.dsl.builder.AlignX +import com.intellij.ui.dsl.builder.Cell +import com.intellij.ui.dsl.builder.panel +import com.intellij.util.concurrency.annotations.RequiresEdt +import java.awt.Component +import java.nio.file.Path +import java.util.* +import javax.swing.DefaultComboBoxModel +import javax.swing.JList +import javax.swing.event.DocumentEvent +import kotlin.io.path.pathString + +abstract class Downloader(val component: Component) { + suspend fun download(): T? { + val info = withModalProgress( + ModalTaskOwner.component(component), + versionInfoFetchTitle, + TaskCancellation.cancellable() + ) { + downloadVersionList() + } + val selector = localSelector() + val (downloadPath, version) = runInterruptibleEDT(component.asContextElement()) { + selectVersion(info, selector) + } ?: return null + withModalProgress( + ModalTaskOwner.component(component), + downloadProgressTitle(version), + TaskCancellation.cancellable() + ) { + version.downloadAndUnpack(downloadPath) + } + return selector.browse(downloadPath) + } + + protected abstract val windowTitle: String + protected abstract val versionInfoFetchTitle: @NlsContexts.ProgressTitle String + protected abstract fun downloadProgressTitle(version: V): @NlsContexts.ProgressTitle String + protected abstract fun localSelector(): LocalSelector + protected abstract suspend fun downloadVersionList(): List + protected abstract fun getSuggestedPath(): Path? + + @RequiresEdt + private fun selectVersion(info: List, selector: LocalSelector): Pair? { + val dialog = DialogBuilder() + val theList = ComboBox(DefaultComboBoxModel(Vector(info))) + theList.renderer = object: ColoredListCellRenderer() { + override fun customizeCellRenderer( + list: JList, + value: V?, + index: Int, + selected: Boolean, + hasFocus: Boolean + ) { + value?.let { append(it.version.rawVersion) } + } + } + val outputPath = textFieldWithBrowseButton(null, selector.descriptor.title, selector.descriptor) + Disposer.register(dialog, outputPath) + outputPath.textField.columns = 50 + + lateinit var errorMessageBox: JBLabel + fun onChanged() { + val path = outputPath.text.ifBlank { null }?.toNioPathOrNull() + val state = DirectoryState.Companion.determine(path) + if (state.isValid()) { + errorMessageBox.icon = AllIcons.General.Information + dialog.setOkActionEnabled(true) + } else { + errorMessageBox.icon = AllIcons.General.Error + dialog.setOkActionEnabled(false) + } + errorMessageBox.text = ZigBrainsBundle.message(when(state) { + DirectoryState.Invalid -> "settings.shared.downloader.state.invalid" + DirectoryState.NotAbsolute -> "settings.shared.downloader.state.not-absolute" + DirectoryState.NotDirectory -> "settings.shared.downloader.state.not-directory" + DirectoryState.NotEmpty -> "settings.shared.downloader.state.not-empty" + DirectoryState.CreateNew -> "settings.shared.downloader.state.create-new" + DirectoryState.Ok -> "settings.shared.downloader.state.ok" + }) + dialog.window.repaint() + } + outputPath.whenFocusGained { + onChanged() + } + outputPath.addDocumentListener(object: DocumentAdapter() { + override fun textChanged(e: DocumentEvent) { + onChanged() + } + }) + var archiveSizeCell: Cell<*>? = null + fun detect(item: V) { + outputPath.text = getSuggestedPath()?.resolve(item.version.rawVersion)?.pathString ?: "" + val size = item.dist.size + val sizeMb = size / (1024f * 1024f) + archiveSizeCell?.comment?.text = ZigBrainsBundle.message("settings.shared.downloader.archive-size.text", "%.2fMB".format(sizeMb)) + } + theList.addItemListener { + @Suppress("UNCHECKED_CAST") + detect(it.item as V) + } + val center = panel { + row(ZigBrainsBundle.message("settings.shared.downloader.version.label")) { + cell(theList).resizableColumn().align(AlignX.FILL) + } + row(ZigBrainsBundle.message("settings.shared.downloader.location.label")) { + cell(outputPath).resizableColumn().align(AlignX.FILL).apply { archiveSizeCell = comment("") } + } + row { + errorMessageBox = JBLabel() + cell(errorMessageBox) + } + } + detect(info[0]) + dialog.centerPanel(center) + dialog.setTitle(windowTitle) + dialog.addCancelAction() + dialog.addOkAction().also { it.setText(ZigBrainsBundle.message("settings.shared.downloader.ok-action")) } + if (!dialog.showAndGet()) { + return null + } + val path = outputPath.text.ifBlank { null }?.toNioPathOrNull() + ?: return null + if (!DirectoryState.Companion.determine(path).isValid()) { + return null + } + val version = theList.item ?: return null + + return path to version + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/LocalSelector.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/LocalSelector.kt new file mode 100644 index 00000000..b35130b5 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/LocalSelector.kt @@ -0,0 +1,138 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.coroutine.asContextElement +import com.falsepattern.zigbrains.shared.coroutine.launchWithEDT +import com.falsepattern.zigbrains.shared.coroutine.withEDTContext +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.icons.AllIcons +import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.fileChooser.FileChooser +import com.intellij.openapi.fileChooser.FileChooserDescriptor +import com.intellij.openapi.ui.DialogBuilder +import com.intellij.openapi.util.Disposer +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.ui.DocumentAdapter +import com.intellij.ui.components.JBLabel +import com.intellij.ui.components.JBTextField +import com.intellij.ui.components.textFieldWithBrowseButton +import com.intellij.ui.dsl.builder.AlignX +import com.intellij.ui.dsl.builder.panel +import com.intellij.util.concurrency.annotations.RequiresEdt +import java.awt.Component +import java.nio.file.Path +import java.util.concurrent.atomic.AtomicBoolean +import javax.swing.Icon +import javax.swing.event.DocumentEvent +import kotlin.io.path.pathString + +abstract class LocalSelector(val component: Component) { + suspend open fun browse(preSelected: Path? = null): T? { + return withEDTContext(component.asContextElement()) { + doBrowseFromDisk(preSelected) + } + } + + abstract val windowTitle: String + abstract val descriptor: FileChooserDescriptor + protected abstract suspend fun verify(path: Path): VerifyResult + protected abstract suspend fun resolve(path: Path, name: String?): T? + + @RequiresEdt + private suspend fun doBrowseFromDisk(preSelected: Path?): T? { + val dialog = DialogBuilder() + val name = JBTextField().also { it.columns = 25 } + val path = textFieldWithBrowseButton(null, descriptor.title, descriptor) + Disposer.register(dialog, path) + lateinit var errorMessageBox: JBLabel + suspend fun verifyAndUpdate(path: Path?) { + val result = path?.let { verify(it) } ?: VerifyResult( + "", + false, + AllIcons.General.Error, + ZigBrainsBundle.message("settings.shared.local-selector.state.invalid") + ) + val prevNameDefault = name.emptyText.text.trim() == name.text.trim() || name.text.isBlank() + name.emptyText.text = result.name ?: "" + if (prevNameDefault) { + name.text = name.emptyText.text + } + errorMessageBox.icon = result.errorIcon + errorMessageBox.text = result.errorText + dialog.setOkActionEnabled(result.allowed) + } + val active = AtomicBoolean(false) + path.addDocumentListener(object: DocumentAdapter() { + override fun textChanged(e: DocumentEvent) { + if (!active.get()) + return + zigCoroutineScope.launchWithEDT(ModalityState.current()) { + verifyAndUpdate(path.text.ifBlank { null }?.toNioPathOrNull()) + } + } + }) + val center = panel { + row(ZigBrainsBundle.message("settings.shared.local-selector.name.label")) { + cell(name).resizableColumn().align(AlignX.FILL) + } + row(ZigBrainsBundle.message("settings.shared.local-selector.path.label")) { + cell(path).resizableColumn().align(AlignX.FILL) + } + row { + errorMessageBox = JBLabel() + cell(errorMessageBox) + } + } + dialog.centerPanel(center) + dialog.setTitle(windowTitle) + dialog.addCancelAction() + dialog.addOkAction().also { it.setText(ZigBrainsBundle.message("settings.shared.local-selector.ok-action")) } + if (preSelected == null) { + val chosenFile = FileChooser.chooseFile(descriptor, null, null) + if (chosenFile != null) { + verifyAndUpdate(chosenFile.toNioPath()) + path.text = chosenFile.path + } + } else { + verifyAndUpdate(preSelected) + path.text = preSelected.pathString + } + active.set(true) + if (!dialog.showAndGet()) { + active.set(false) + return null + } + active.set(false) + return path.text.ifBlank { null }?.toNioPathOrNull()?.let { resolve(it, name.text.ifBlank { null }) } + } + + @JvmRecord + data class VerifyResult( + val name: String?, + val allowed: Boolean, + val errorIcon: Icon, + val errorText: String, + ) +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/VersionInfo.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/VersionInfo.kt new file mode 100644 index 00000000..68208436 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/downloader/VersionInfo.kt @@ -0,0 +1,163 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.downloader + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.Unarchiver +import com.falsepattern.zigbrains.shared.downloader.VersionInfo.Tarball +import com.intellij.openapi.application.PathManager +import com.intellij.openapi.progress.EmptyProgressIndicator +import com.intellij.openapi.progress.ProgressManager +import com.intellij.openapi.progress.coroutineToIndicator +import com.intellij.openapi.util.io.FileUtil +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.platform.util.progress.ProgressReporter +import com.intellij.platform.util.progress.reportProgress +import com.intellij.util.download.DownloadableFileService +import com.intellij.util.io.createDirectories +import com.intellij.util.io.delete +import com.intellij.util.io.move +import com.intellij.util.system.CpuArch +import com.intellij.util.system.OS +import com.intellij.util.text.SemVer +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.withContext +import kotlinx.serialization.Serializable +import kotlinx.serialization.json.Json +import kotlinx.serialization.json.JsonElement +import kotlinx.serialization.json.decodeFromJsonElement +import java.io.File +import java.nio.file.Files +import java.nio.file.Path +import kotlin.io.path.ExperimentalPathApi +import kotlin.io.path.deleteRecursively +import kotlin.io.path.isDirectory +import kotlin.io.path.name + +interface VersionInfo { + val version: SemVer + val date: String + val dist: Tarball + + @Throws(Exception::class) + suspend fun downloadAndUnpack(into: Path) { + reportProgress { reporter -> + into.createDirectories() + val tarball = downloadTarball(dist, into, reporter) + unpackTarball(tarball, into, reporter) + tarball.delete() + flattenDownloadDir(into, reporter) + } + } + + @JvmRecord + @Serializable + data class Tarball(val tarball: String, val shasum: String, val size: Int) +} + +suspend fun downloadTarball(dist: Tarball, into: Path, reporter: ProgressReporter): Path { + return withContext(Dispatchers.IO) { + val service = DownloadableFileService.getInstance() + val fileName = dist.tarball.substringAfterLast('/') + val tempFile = FileUtil.createTempFile(into.toFile(), "tarball", fileName, false, false) + val desc = service.createFileDescription(dist.tarball, tempFile.name) + val downloader = service.createDownloader(listOf(desc), ZigBrainsBundle.message("settings.toolchain.downloader.service.tarball")) + val downloadResults = reporter.sizedStep(100) { + coroutineToIndicator { + downloader.download(into.toFile()) + } + } + if (downloadResults.isEmpty()) + throw IllegalStateException("No file downloaded") + return@withContext downloadResults[0].first.toPath() + } +} + +suspend fun flattenDownloadDir(dir: Path, reporter: ProgressReporter) { + withContext(Dispatchers.IO) { + val contents = Files.newDirectoryStream(dir).use { it.toList() } + if (contents.size == 1 && contents[0].isDirectory()) { + val src = contents[0] + reporter.indeterminateStep { + coroutineToIndicator { + val indicator = ProgressManager.getInstance().progressIndicator ?: EmptyProgressIndicator() + indicator.isIndeterminate = true + indicator.text = ZigBrainsBundle.message("settings.toolchain.downloader.progress.flatten") + Files.newDirectoryStream(src).use { stream -> + stream.forEach { + indicator.text2 = it.name + it.move(dir.resolve(src.relativize(it))) + } + } + } + } + src.delete() + } + } +} + +@OptIn(ExperimentalPathApi::class) +suspend fun unpackTarball(tarball: Path, into: Path, reporter: ProgressReporter) { + withContext(Dispatchers.IO) { + try { + reporter.indeterminateStep { + coroutineToIndicator { + Unarchiver.unarchive(tarball, into) + } + } + } catch (e: Throwable) { + tarball.delete() + val contents = Files.newDirectoryStream(into).use { it.toList() } + if (contents.size == 1 && contents[0].isDirectory()) { + contents[0].deleteRecursively() + } + throw e + } + } +} + +fun getTarballIfCompatible(dist: String, tb: JsonElement): Tarball? { + if (!dist.contains('-')) + return null + val (arch, os) = dist.split('-', limit = 2) + val theArch = when (arch) { + "x86_64" -> CpuArch.X86_64 + "i386", "x86" -> CpuArch.X86 + "armv7a" -> CpuArch.ARM32 + "aarch64" -> CpuArch.ARM64 + else -> return null + } + val theOS = when (os) { + "linux" -> OS.Linux + "windows" -> OS.Windows + "macos" -> OS.macOS + "freebsd" -> OS.FreeBSD + else -> return null + } + if (theArch != CpuArch.CURRENT || theOS != OS.CURRENT) { + return null + } + return Json.decodeFromJsonElement(tb) +} + +val tempPluginDir get(): File = PathManager.getTempPath().toNioPathOrNull()!!.resolve("zigbrains").toFile() diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ipc/IPCUtil.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ipc/IPCUtil.kt index f826bf3e..680cc1ef 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ipc/IPCUtil.kt +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ipc/IPCUtil.kt @@ -22,7 +22,7 @@ package com.falsepattern.zigbrains.shared.ipc -import com.falsepattern.zigbrains.direnv.emptyEnv +import com.falsepattern.zigbrains.direnv.Env import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.openapi.util.SystemInfo import com.intellij.openapi.util.io.FileUtil @@ -56,7 +56,7 @@ object IPCUtil { if (SystemInfo.isWindows) { return null } - val mkfifo = emptyEnv + val mkfifo = Env.empty .findAllExecutablesOnPATH("mkfifo") .map { it.pathString } .map(::MKFifo) @@ -67,7 +67,7 @@ object IPCUtil { true } ?: return null - val selectedBash = emptyEnv + val selectedBash = Env.empty .findAllExecutablesOnPATH("bash") .map { it.pathString } .filter { diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDComboBoxDriver.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDComboBoxDriver.kt new file mode 100644 index 00000000..aa7fa261 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDComboBoxDriver.kt @@ -0,0 +1,37 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.ui + +import com.falsepattern.zigbrains.shared.UUIDMapSerializable +import com.intellij.openapi.ui.NamedConfigurable +import java.awt.Component +import java.util.* + +interface UUIDComboBoxDriver { + val theMap: UUIDMapSerializable.Converting + suspend fun constructModelList(): List> + fun createContext(model: ZBModel): ZBContext + fun createComboBox(model: ZBModel): ZBComboBox + suspend fun resolvePseudo(context: Component, elem: ListElem.Pseudo): UUID? + fun createNamedConfigurable(uuid: UUID, elem: T): NamedConfigurable +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapEditor.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapEditor.kt new file mode 100644 index 00000000..12e21cc4 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapEditor.kt @@ -0,0 +1,169 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.shared.StorageChangeListener +import com.falsepattern.zigbrains.shared.coroutine.asContextElement +import com.falsepattern.zigbrains.shared.coroutine.launchWithEDT +import com.falsepattern.zigbrains.shared.coroutine.withEDTContext +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.actionSystem.AnAction +import com.intellij.openapi.actionSystem.AnActionEvent +import com.intellij.openapi.actionSystem.Presentation +import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.observable.util.whenListChanged +import com.intellij.openapi.project.DumbAwareAction +import com.intellij.openapi.ui.MasterDetailsComponent +import com.intellij.util.IconUtil +import com.intellij.util.asSafely +import com.intellij.util.concurrency.annotations.RequiresEdt +import kotlinx.coroutines.launch +import java.util.* +import javax.swing.JComponent +import javax.swing.tree.DefaultTreeModel + +abstract class UUIDMapEditor(val driver: UUIDComboBoxDriver): MasterDetailsComponent() { + private var isTreeInitialized = false + private var registered: Boolean = false + private var selectOnNextReload: UUID? = null + private var disposed: Boolean = false + private val changeListener: StorageChangeListener = { this@UUIDMapEditor.listChanged() } + + override fun createComponent(): JComponent { + if (!isTreeInitialized) { + initTree() + isTreeInitialized = true + } + if (!registered) { + driver.theMap.addChangeListener(changeListener) + registered = true + } + return super.createComponent() + } + + override fun createActions(fromPopup: Boolean): List { + val add = object : DumbAwareAction({ ZigBrainsBundle.message("settings.shared.list.add-action.name") }, Presentation.NULL_STRING, IconUtil.addIcon) { + override fun actionPerformed(e: AnActionEvent) { + zigCoroutineScope.launchWithEDT(ModalityState.current()) { + if (disposed) + return@launchWithEDT + val modelList = driver.constructModelList() + val model = ZBModel(modelList) + val context = driver.createContext(model) + val popup = ZBComboBoxPopup(context, null, ::onItemSelected) + model.whenListChanged { + popup.syncWithModelChange() + } + popup.showInBestPositionFor(e.dataContext) + } + } + } + return listOf(add, MyDeleteAction()) + } + + override fun onItemDeleted(item: Any?) { + if (item is UUID) { + driver.theMap.remove(item) + } + super.onItemDeleted(item) + } + + private fun onItemSelected(elem: ListElem) { + if (elem !is ListElem.Pseudo) + return + zigCoroutineScope.launch(myWholePanel.asContextElement()) { + if (disposed) + return@launch + val uuid = driver.resolvePseudo(myWholePanel, elem) + if (uuid != null) { + withEDTContext(myWholePanel.asContextElement()) { + applyUUIDNowOrOnReload(uuid) + } + } + } + } + + override fun reset() { + reloadTree() + super.reset() + } + + override fun getEmptySelectionString() = ZigBrainsBundle.message("settings.shared.list.empty") + + override fun disposeUIResources() { + disposed = true + super.disposeUIResources() + if (registered) { + driver.theMap.removeChangeListener(changeListener) + } + } + + private fun addElem(uuid: UUID, elem: T) { + val node = MyNode(driver.createNamedConfigurable(uuid, elem)) + addNode(node, myRoot) + } + + private fun reloadTree() { + if (disposed) + return + val currentSelection = selectedObject?.asSafely() + selectedNode = null + myRoot.removeAllChildren() + (myTree.model as DefaultTreeModel).reload() + val onReload = selectOnNextReload + selectOnNextReload = null + var hasOnReload = false + driver.theMap.forEach { (uuid, elem) -> + addElem(uuid, elem) + if (uuid == onReload) { + hasOnReload = true + } + } + (myTree.model as DefaultTreeModel).reload() + if (hasOnReload) { + selectedNode = findNodeByObject(myRoot, onReload) + return + } + selectedNode = currentSelection?.let { findNodeByObject(myRoot, it) } + } + + @RequiresEdt + private fun applyUUIDNowOrOnReload(uuid: UUID?) { + selectNodeInTree(uuid) + val currentSelection = selectedObject?.asSafely() + if (uuid != null && uuid != currentSelection) { + selectOnNextReload = uuid + } else { + selectOnNextReload = null + } + } + + private suspend fun listChanged() { + if (disposed) + return + withEDTContext(myWholePanel.asContextElement()) { + reloadTree() + } + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapSelector.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapSelector.kt new file mode 100644 index 00000000..92f13728 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/UUIDMapSelector.kt @@ -0,0 +1,192 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.ui + +import com.falsepattern.zigbrains.ZigBrainsBundle +import com.falsepattern.zigbrains.project.toolchain.zigToolchainList +import com.falsepattern.zigbrains.shared.StorageChangeListener +import com.falsepattern.zigbrains.shared.coroutine.asContextElement +import com.falsepattern.zigbrains.shared.coroutine.launchWithEDT +import com.falsepattern.zigbrains.shared.coroutine.withEDTContext +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.Disposable +import com.intellij.openapi.application.EDT +import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.observable.util.whenListChanged +import com.intellij.openapi.options.ShowSettingsUtil +import com.intellij.openapi.ui.DialogWrapper +import com.intellij.ui.dsl.builder.AlignX +import com.intellij.ui.dsl.builder.Row +import com.intellij.util.concurrency.annotations.RequiresEdt +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.delay +import kotlinx.coroutines.launch +import kotlinx.coroutines.withContext +import java.awt.event.ItemEvent +import java.util.* +import javax.swing.JButton + +abstract class UUIDMapSelector(val driver: UUIDComboBoxDriver): Disposable { + private val comboBox: ZBComboBox + private var selectOnNextReload: UUID? = null + private val model: ZBModel + private var editButton: JButton? = null + private val changeListener: StorageChangeListener = { this@UUIDMapSelector.listChanged() } + init { + model = ZBModel(emptyList()) + comboBox = driver.createComboBox(model) + comboBox.addItemListener(::itemStateChanged) + driver.theMap.addChangeListener(changeListener) + model.whenListChanged { + zigCoroutineScope.launchWithEDT(comboBox.asContextElement()) { + tryReloadSelection() + } + if (comboBox.isPopupVisible) { + comboBox.isPopupVisible = false + comboBox.isPopupVisible = true + } + } + zigCoroutineScope.launchWithEDT(ModalityState.any()) { + model.updateContents(driver.constructModelList()) + } + } + + protected var selectedUUID: UUID? + get() = comboBox.selectedUUID + set(value) { + zigCoroutineScope.launchWithEDT(ModalityState.any()) { + applyUUIDNowOrOnReload(value) + } + } + + protected val isEmpty: Boolean get() = model.isEmpty + + protected open fun onSelection(uuid: UUID?) {} + + private fun refreshButtonState(item: ListElem<*>) { + val actual = item is ListElem.One.Actual<*> + editButton?.isEnabled = actual + editButton?.repaint() + onSelection(if (actual) (item as ListElem.One.Actual<*>).uuid else null) + } + + private fun itemStateChanged(event: ItemEvent) { + if (event.stateChange != ItemEvent.SELECTED) { + return + } + val item = event.item + if (item !is ListElem<*>) + return + refreshButtonState(item) + if (item !is ListElem.Pseudo<*>) + return + @Suppress("UNCHECKED_CAST") + item as ListElem.Pseudo + zigCoroutineScope.launch(comboBox.asContextElement()) { + val uuid = runCatching { driver.resolvePseudo(comboBox, item) }.getOrNull() + delay(100) + withEDTContext(comboBox.asContextElement()) { + applyUUIDNowOrOnReload(uuid) + } + } + } + + @RequiresEdt + private fun tryReloadSelection() { + val list = model.toList() + if (list.size == 1) { + comboBox.selectedItem = list[0] + comboBox.isEnabled = false + return + } + comboBox.isEnabled = true + val onReload = selectOnNextReload + selectOnNextReload = null + if (onReload != null) { + val element = list.firstOrNull { when(it) { + is ListElem.One.Actual<*> -> it.uuid == onReload + else -> false + } } + if (element == null) { + selectOnNextReload = onReload + } else { + comboBox.selectedItem = element + return + } + } + val selected = model.selected + if (selected != null && list.contains(selected)) { + comboBox.selectedItem = selected + return + } + if (selected is ListElem.One.Actual<*>) { + val uuid = selected.uuid + val element = list.firstOrNull { when(it) { + is ListElem.One.Actual -> it.uuid == uuid + else -> false + } } + comboBox.selectedItem = element + return + } + comboBox.selectedItem = ListElem.None() + } + + protected suspend fun listChanged() { + withContext(Dispatchers.EDT + comboBox.asContextElement()) { + val list = driver.constructModelList() + model.updateContents(list) + tryReloadSelection() + } + } + + protected fun attachComboBoxRow(row: Row): Unit = with(row) { + cell(comboBox).resizableColumn().align(AlignX.FILL) + button(ZigBrainsBundle.message("settings.toolchain.editor.toolchain.edit-button.name")) { e -> + zigCoroutineScope.launchWithEDT(comboBox.asContextElement()) { + var selectedUUID = comboBox.selectedUUID ?: return@launchWithEDT + val elem = driver.theMap[selectedUUID] ?: return@launchWithEDT + val config = driver.createNamedConfigurable(selectedUUID, elem) + val apply = ShowSettingsUtil.getInstance().editConfigurable(DialogWrapper.findInstance(comboBox)?.contentPane, config) + if (apply) { + applyUUIDNowOrOnReload(selectedUUID) + } + } + }.component.let { + editButton = it + } + } + + @RequiresEdt + private fun applyUUIDNowOrOnReload(uuid: UUID?) { + comboBox.selectedUUID = uuid + if (uuid != null && comboBox.selectedUUID == null) { + selectOnNextReload = uuid + } else { + selectOnNextReload = null + } + } + + override fun dispose() { + zigToolchainList.removeChangeListener(changeListener) + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/elements.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/elements.kt new file mode 100644 index 00000000..3148d936 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/elements.kt @@ -0,0 +1,86 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.ui + +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.map +import java.util.* + + +sealed interface ListElemIn +@Suppress("UNCHECKED_CAST") +sealed interface ListElem : ListElemIn { + sealed interface Pseudo: ListElem + sealed interface One : ListElem { + val instance: T + + @JvmRecord + data class Suggested(override val instance: T): One, Pseudo + + @JvmRecord + data class Actual(val uuid: UUID, override val instance: T): One + } + class None private constructor(): ListElem { + companion object { + private val INSTANCE = None() + operator fun invoke(): None { + return INSTANCE as None + } + } + } + class Download private constructor(): ListElem, Pseudo { + companion object { + private val INSTANCE = Download() + operator fun invoke(): Download { + return INSTANCE as Download + } + } + } + class FromDisk private constructor(): ListElem, Pseudo { + companion object { + private val INSTANCE = FromDisk() + operator fun invoke(): FromDisk { + return INSTANCE as FromDisk + } + } + } + data class Pending(val elems: Flow>): ListElem + + companion object { + private val fetchGroup: List> = listOf(Download(), FromDisk()) + fun fetchGroup() = fetchGroup as List> + } +} + +@JvmRecord +data class Separator(val text: String, val line: Boolean) : ListElemIn + +fun Pair.asActual() = ListElem.One.Actual(first, second) + +fun T.asSuggested() = ListElem.One.Suggested(this) + +@JvmName("listElemFlowAsPending") +fun Flow>.asPending() = ListElem.Pending(this) + +fun Flow.asPending() = map { it.asSuggested() }.asPending() + diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/model.kt b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/model.kt new file mode 100644 index 00000000..717a16d1 --- /dev/null +++ b/core/src/main/kotlin/com/falsepattern/zigbrains/shared/ui/model.kt @@ -0,0 +1,288 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.shared.ui + +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.application.EDT +import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.application.asContextElement +import com.intellij.openapi.application.runInEdt +import com.intellij.openapi.project.Project +import com.intellij.openapi.ui.ComboBox +import com.intellij.openapi.util.io.FileUtil +import com.intellij.openapi.util.text.StringUtil +import com.intellij.ui.* +import com.intellij.ui.components.panels.OpaquePanel +import com.intellij.ui.popup.list.ComboBoxPopup +import com.intellij.util.concurrency.annotations.RequiresEdt +import com.intellij.util.ui.EmptyIcon +import com.intellij.util.ui.JBUI +import com.intellij.util.ui.UIUtil +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.launch +import java.awt.BorderLayout +import java.awt.Component +import java.util.* +import java.util.function.Consumer +import javax.accessibility.AccessibleContext +import javax.swing.JList +import javax.swing.border.Border + +class ZBComboBoxPopup( + context: ZBContext, + selected: ListElem?, + onItemSelected: Consumer>, +) : ComboBoxPopup>(context, selected, onItemSelected) + +open class ZBComboBox(model: ZBModel, renderer: (() -> ZBModel)-> ZBCellRenderer): ComboBox>(model) { + init { + setRenderer(renderer { model }) + } + + var selectedUUID: UUID? + set(value) { + if (value == null) { + selectedItem = ListElem.None() + return + } + for (i in 0..() + } + get() { + val item = selectedItem + return when(item) { + is ListElem.One.Actual<*> -> item.uuid + else -> null + } + } +} + +class ZBModel private constructor(elements: List>, private var separators: MutableMap, Separator>) : CollectionComboBoxModel>(elements) { + private var counter: Int = 0 + companion object { + operator fun invoke(input: List>): ZBModel { + val (elements, separators) = convert(input) + val model = ZBModel(elements, separators) + model.launchPendingResolve() + return model + } + + private fun convert(input: List>): Pair>, MutableMap, Separator>> { + val separators = IdentityHashMap, Separator>() + var lastSeparator: Separator? = null + val elements = ArrayList>() + input.forEach { + when (it) { + is ListElem -> { + if (lastSeparator != null) { + separators[it] = lastSeparator + lastSeparator = null + } + elements.add(it) + } + + is Separator -> lastSeparator = it + } + } + return elements to separators + } + } + + fun separatorAbove(elem: ListElem) = separators[elem] + + private fun launchPendingResolve() { + runInEdt(ModalityState.any()) { + val counter = this.counter + val size = this.size + for (i in 0.. + insertBefore(elem, newElem, counter) + } + remove(elem, counter) + } + } + } + } + + @RequiresEdt + private fun remove(old: ListElem, oldCounter: Int) { + val newCounter = this@ZBModel.counter + if (oldCounter != newCounter) { + return + } + val index = this@ZBModel.getElementIndex(old) + this@ZBModel.remove(index) + val sep = separators.remove(old) + if (sep != null && this@ZBModel.size > index) { + this@ZBModel.getElementAt(index)?.let { separators[it] = sep } + } + } + + @RequiresEdt + private fun insertBefore(old: ListElem, new: ListElem?, oldCounter: Int) { + val newCounter = this@ZBModel.counter + if (oldCounter != newCounter) { + return + } + if (new == null) { + return + } + val currentIndex = this@ZBModel.getElementIndex(old) + separators.remove(old)?.let { + separators.put(new, it) + } + this@ZBModel.add(currentIndex, new) + } + + @RequiresEdt + fun updateContents(input: List>) { + counter++ + val (elements, separators) = convert(input) + this.separators = separators + replaceAll(elements) + launchPendingResolve() + } +} + +open class ZBContext(private val project: Project?, private val model: ZBModel, private val getRenderer: (() -> ZBModel) -> ZBCellRenderer) : ComboBoxPopup.Context> { + override fun getProject(): Project? { + return project + } + + override fun getModel(): ZBModel { + return model + } + + override fun getRenderer(): ZBCellRenderer { + return getRenderer(::getModel) + } +} + +abstract class ZBCellRenderer(val getModel: () -> ZBModel) : ColoredListCellRenderer>() { + final override fun getListCellRendererComponent( + list: JList?>?, + value: ListElem?, + index: Int, + selected: Boolean, + hasFocus: Boolean + ): Component? { + val component = super.getListCellRendererComponent(list, value, index, selected, hasFocus) as SimpleColoredComponent + val panel = object : CellRendererPanel(BorderLayout()) { + val myContext = component.accessibleContext + + override fun getAccessibleContext(): AccessibleContext? { + return myContext + } + + override fun setBorder(border: Border?) { + component.border = border + } + } + panel.add(component, BorderLayout.CENTER) + + component.isOpaque = true + list?.let { background = if (selected) it.selectionBackground else it.background } + + val model = getModel() + + if (index == -1) { + component.isOpaque = false + panel.isOpaque = false + return panel + } + + val separator = value?.let { model.separatorAbove(it) } + + if (separator != null) { + val vGap = if (UIUtil.isUnderNativeMacLookAndFeel()) 1 else 3 + val separatorComponent = GroupHeaderSeparator(JBUI.insets(vGap, 10, vGap, 0)) + separatorComponent.isHideLine = !separator.line + separatorComponent.caption = separator.text.ifBlank { null } + val wrapper = OpaquePanel(BorderLayout()) + wrapper.add(separatorComponent, BorderLayout.CENTER) + list?.let { wrapper.background = it.background } + panel.add(wrapper, BorderLayout.NORTH) + } + + return panel + } + + abstract override fun customizeCellRenderer( + list: JList?>, + value: ListElem?, + index: Int, + selected: Boolean, + hasFocus: Boolean + ) +} + +fun renderPathNameComponent(path: String, name: String?, nameFallback: String, component: SimpleColoredComponent, isSuggestion: Boolean, isSelected: Boolean) { + val path = presentDetectedPath(path) + val primary: String + var secondary: String? + val tooltip: String? + if (isSuggestion) { + primary = path + secondary = name + } else { + primary = name ?: nameFallback + secondary = path + } + if (isSelected) { + tooltip = secondary + secondary = null + } else { + tooltip = null + } + component.append(primary) + if (secondary != null) { + component.append(" ") + component.append(secondary, SimpleTextAttributes.GRAYED_ATTRIBUTES) + } + component.toolTipText = tooltip +} + +fun presentDetectedPath(home: String, maxLength: Int = 50, suffixLength: Int = 30): String { + //for macOS, let's try removing Bundle internals + var home = home + home = StringUtil.trimEnd(home, "/Contents/Home") //NON-NLS + home = StringUtil.trimEnd(home, "/Contents/MacOS") //NON-NLS + home = FileUtil.getLocationRelativeToUserHome(home, false) + home = StringUtil.shortenTextWithEllipsis(home, maxLength, suffixLength) + return home +} + +private val EMPTY_ICON = EmptyIcon.create(1, 16) \ No newline at end of file diff --git a/core/src/main/resources/META-INF/zigbrains-core.xml b/core/src/main/resources/META-INF/zigbrains-core.xml index 45220600..b3eb4bc2 100644 --- a/core/src/main/resources/META-INF/zigbrains-core.xml +++ b/core/src/main/resources/META-INF/zigbrains-core.xml @@ -142,7 +142,15 @@ parentId="language" instance="com.falsepattern.zigbrains.project.settings.ZigConfigurable" id="ZigConfigurable" - displayName="Zig" + bundle="zigbrains.Bundle" + key="settings.project.display-name" + /> + @@ -177,10 +185,13 @@ + diff --git a/core/src/main/resources/zigbrains/Bundle.properties b/core/src/main/resources/zigbrains/Bundle.properties index 48b56bf6..1b05b9f3 100644 --- a/core/src/main/resources/zigbrains/Bundle.properties +++ b/core/src/main/resources/zigbrains/Bundle.properties @@ -110,3 +110,47 @@ build.tool.window.status.error.general=Error while running zig build -l build.tool.window.status.no-builds=No builds currently in progress build.tool.window.status.timeout=zig build -l timed out after {0} seconds. zig=Zig +settings.shared.list.add-action.name=Add New +settings.shared.list.empty=Select an entry to view or edit its details here +settings.shared.downloader.version.label=Version: +settings.shared.downloader.location.label=Location: +settings.shared.downloader.ok-action=Download +settings.shared.downloader.state.invalid=Invalid path +settings.shared.downloader.state.not-absolute=Must be an absolute path +settings.shared.downloader.state.not-directory=Path is not a directory +settings.shared.downloader.state.not-empty=Directory is not empty +settings.shared.downloader.state.create-new=Directory will be created +settings.shared.downloader.state.ok=Directory OK +settings.shared.downloader.archive-size.text=Archive size: {0} +settings.shared.local-selector.name.label=Name: +settings.shared.local-selector.path.label=Path: +settings.shared.local-selector.ok-action=Add +settings.shared.local-selector.state.invalid=Invalid path +settings.project.display-name=Zig +settings.toolchain.base.name.label=Name +settings.toolchain.local.path.label=Toolchain location +settings.toolchain.local.version.label=Detected zig version +settings.toolchain.local.std.label=Override standard library +settings.toolchain.editor.toolchain.label=Toolchain +settings.toolchain.editor.toolchain-default.label=Default toolchain +settings.toolchain.editor.toolchain.edit-button.name=Edit +settings.toolchain.model.detected.separator=Detected toolchains +settings.toolchain.model.none.text= +settings.toolchain.model.loading.text=Loading\u2026 +settings.toolchain.model.from-disk.text=Add Zig from disk\u2026 +settings.toolchain.model.download.text=Download Zig\u2026 +settings.toolchain.list.title=Toolchains +settings.toolchain.downloader.title=Install Zig +settings.toolchain.downloader.progress.fetch=Fetching zig version information +settings.toolchain.downloader.progress.install=Installing Zig {0} +settings.toolchain.downloader.progress.flatten=Flattening unpacked archive +settings.toolchain.downloader.chooser.title=Zig Install Directory +settings.toolchain.downloader.service.index=Zig version information +settings.toolchain.downloader.service.tarball=Zig archive +settings.toolchain.local-selector.title=Select Zig From Disk +settings.toolchain.local-selector.chooser.title=Zig Installation Directory +settings.toolchain.local-selector.state.invalid=Invalid toolchain path +settings.toolchain.local-selector.state.already-exists-unnamed=Toolchain already exists +settings.toolchain.local-selector.state.already-exists-named=Toolchain already exists as "{0}" +settings.toolchain.local-selector.state.ok=Toolchain path OK +settings.direnv.enable.label=Direnv diff --git a/gradle.properties b/gradle.properties index e6e7efbd..90952bdf 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,7 +1,7 @@ pluginName=ZigBrains pluginRepositoryUrl=https://github.com/FalsePattern/ZigBrains -pluginVersion=24.0.1 +pluginVersion=25.0.0 pluginSinceBuild=242 pluginUntilBuild=242.* @@ -14,7 +14,7 @@ javaVersion=21 runIdeTarget=clion lsp4jVersion=0.21.1 -lsp4ijVersion=0.11.0 +lsp4ijVersion=0.12.0 lsp4ijNightly=false kotlin.stdlib.default.dependency=false diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index a4b76b95..9bbc975c 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index cea7a793..37f853b1 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip networkTimeout=10000 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew index f3b75f3b..faf93008 100755 --- a/gradlew +++ b/gradlew @@ -205,7 +205,7 @@ fi DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Collect all arguments for the java command: -# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, # and any embedded shellness will be escaped. # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be # treated as '${Hostname}' itself on the command line. diff --git a/licenses/ZLS.LICENSE b/licenses/ZLS.LICENSE new file mode 100644 index 00000000..2bf33e97 --- /dev/null +++ b/licenses/ZLS.LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) ZLS contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/lsp/build.gradle.kts b/lsp/build.gradle.kts index b65ab2c8..6e62a7a7 100644 --- a/lsp/build.gradle.kts +++ b/lsp/build.gradle.kts @@ -16,5 +16,7 @@ dependencies { compileOnly("org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.3") compileOnly("com.redhat.devtools.intellij:lsp4ij:$lsp4ijVersion") compileOnly("org.eclipse.lsp4j:org.eclipse.lsp4j:$lsp4jVersion") - implementation(project(":core")) + implementation(project(":core")) { + isTransitive = false + } } \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/LSPIcons.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/LSPIcons.kt new file mode 100644 index 00000000..d8647e61 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/LSPIcons.kt @@ -0,0 +1,32 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp + +import com.intellij.openapi.util.IconLoader +import org.jetbrains.annotations.NonNls + +@NonNls +object LSPIcons { + @JvmField + val ZLS = IconLoader.getIcon("/icons/zls.svg", LSPIcons::class.java) +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ToolchainZLSConfigProvider.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ToolchainZLSConfigProvider.kt similarity index 77% rename from lsp/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ToolchainZLSConfigProvider.kt rename to lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ToolchainZLSConfigProvider.kt index 0b24a3d0..300dd6cd 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/ToolchainZLSConfigProvider.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ToolchainZLSConfigProvider.kt @@ -20,24 +20,22 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain +package com.falsepattern.zigbrains.lsp import com.falsepattern.zigbrains.lsp.config.SuspendingZLSConfigProvider import com.falsepattern.zigbrains.lsp.config.ZLSConfig -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.project.toolchain.local.LocalZigToolchain import com.intellij.notification.Notification import com.intellij.notification.NotificationType import com.intellij.openapi.project.Project -import com.intellij.openapi.util.UserDataHolderBase import com.intellij.openapi.util.io.toNioPathOrNull import kotlin.io.path.pathString - class ToolchainZLSConfigProvider: SuspendingZLSConfigProvider { override suspend fun getEnvironment(project: Project, previous: ZLSConfig): ZLSConfig { - val svc = project.zigProjectSettings - var state = svc.state - val toolchain = state.toolchain ?: ZigToolchainProvider.suggestToolchain(project, UserDataHolderBase()) ?: return previous + val svc = ZigToolchainService.getInstance(project) + val toolchain = svc.toolchain ?: return previous val env = toolchain.zig.getEnv(project).getOrElse { throwable -> throwable.printStackTrace() @@ -65,16 +63,10 @@ class ToolchainZLSConfigProvider: SuspendingZLSConfigProvider { ).notify(project) return previous } - var lib = if (state.overrideStdPath && state.explicitPathToStd != null) { - state.explicitPathToStd?.toNioPathOrNull() ?: run { - Notification( - "zigbrains-lsp", - "Invalid zig standard library path override: ${state.explicitPathToStd}", - NotificationType.ERROR - ).notify(project) - null - } - } else null + var lib = if (toolchain is LocalZigToolchain) + toolchain.std + else + null if (lib == null) { lib = env.libDirectory.toNioPathOrNull() ?: run { diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStartup.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStartup.kt index d197dd30..05c6aec3 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStartup.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStartup.kt @@ -22,36 +22,26 @@ package com.falsepattern.zigbrains.lsp -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.direnv.emptyEnv -import com.falsepattern.zigbrains.direnv.getDirenv -import com.falsepattern.zigbrains.lsp.settings.zlsSettings -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.lsp.zls.zls import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.openapi.project.Project import com.intellij.openapi.startup.ProjectActivity import com.intellij.ui.EditorNotifications import kotlinx.coroutines.delay import kotlinx.coroutines.launch -import kotlin.io.path.pathString class ZLSStartup: ProjectActivity { override suspend fun execute(project: Project) { - val zlsState = project.zlsSettings.state - if (zlsState.zlsPath.isBlank()) { - val env = if (DirenvCmd.direnvInstalled() && !project.isDefault && project.zigProjectSettings.state.direnv) - project.getDirenv() - else - emptyEnv - env.findExecutableOnPATH("zls")?.let { - zlsState.zlsPath = it.pathString - project.zlsSettings.state = zlsState - } - } project.zigCoroutineScope.launch { - var currentState = project.zlsRunningAsync() + var currentState = project.zlsRunning() + var currentZLS = project.zls while (!project.isDisposed) { - val running = project.zlsRunningAsync() + val zls = project.zls + if (currentZLS != zls) { + startLSP(project, true) + } + currentZLS = zls + val running = project.zlsRunning() if (currentState != running) { EditorNotifications.getInstance(project).updateAllNotifications() } diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStreamConnectionProvider.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStreamConnectionProvider.kt index 6470d863..326102ed 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStreamConnectionProvider.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZLSStreamConnectionProvider.kt @@ -22,11 +22,8 @@ package com.falsepattern.zigbrains.lsp -import com.falsepattern.zigbrains.direnv.emptyEnv -import com.falsepattern.zigbrains.direnv.getDirenv import com.falsepattern.zigbrains.lsp.config.ZLSConfigProviderBase -import com.falsepattern.zigbrains.lsp.settings.zlsSettings -import com.falsepattern.zigbrains.project.settings.zigProjectSettings +import com.falsepattern.zigbrains.lsp.zls.zls import com.intellij.execution.configurations.GeneralCommandLine import com.intellij.notification.Notification import com.intellij.notification.NotificationType @@ -55,30 +52,8 @@ class ZLSStreamConnectionProvider private constructor(private val project: Proje @OptIn(ExperimentalSerializationApi::class) suspend fun getCommand(project: Project): List? { - val svc = project.zlsSettings - val state = svc.state - val zlsPath: Path = state.zlsPath.let { zlsPath -> - if (zlsPath.isEmpty()) { - val env = if (project.zigProjectSettings.state.direnv) project.getDirenv() else emptyEnv - env.findExecutableOnPATH("zls") ?: run { - Notification( - "zigbrains-lsp", - ZLSBundle.message("notification.message.could-not-detect.content"), - NotificationType.ERROR - ).notify(project) - return null - } - } else { - zlsPath.toNioPathOrNull() ?: run { - Notification( - "zigbrains-lsp", - ZLSBundle.message("notification.message.zls-exe-path-invalid.content", zlsPath), - NotificationType.ERROR - ).notify(project) - return null - } - } - } + val zls = project.zls ?: return null + val zlsPath: Path = zls.path if (!zlsPath.toFile().exists()) { Notification( "zigbrains-lsp", @@ -95,7 +70,7 @@ class ZLSStreamConnectionProvider private constructor(private val project: Proje ).notify(project) return null } - val configPath: Path? = state.zlsConfigPath.let { configPath -> + val configPath: Path? = "".let { configPath -> if (configPath.isNotBlank()) { configPath.toNioPathOrNull()?.let { nioPath -> if (!nioPath.toFile().exists()) { diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZigLanguageServerFactory.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZigLanguageServerFactory.kt index c46e9ac7..8cc3b328 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZigLanguageServerFactory.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/ZigLanguageServerFactory.kt @@ -22,7 +22,7 @@ package com.falsepattern.zigbrains.lsp -import com.falsepattern.zigbrains.lsp.settings.zlsSettings +import com.falsepattern.zigbrains.lsp.zls.zls import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.intellij.openapi.components.service import com.intellij.openapi.project.Project @@ -68,39 +68,29 @@ class ZigLanguageServerFactory: LanguageServerFactory, LanguageServerEnablementS } features.inlayHintFeature = object: LSPInlayHintFeature() { override fun isEnabled(file: PsiFile): Boolean { - return features.project.zlsSettings.state.inlayHints + return project.zls?.settings?.inlayHints == true } } return features } - override fun isEnabled(project: Project) = project.zlsEnabledSync() + override fun isEnabled(project: Project) = project.zlsEnabled() override fun setEnabled(enabled: Boolean, project: Project) { project.zlsEnabled(enabled) } } -suspend fun Project.zlsEnabledAsync(): Boolean { - return (getUserData(ENABLED_KEY) != false) && zlsSettings.validateAsync() -} - -fun Project.zlsEnabledSync(): Boolean { - return (getUserData(ENABLED_KEY) != false) && zlsSettings.validateSync() +fun Project.zlsEnabled(): Boolean { + return (getUserData(ENABLED_KEY) != false) && zls?.isValid() == true } fun Project.zlsEnabled(value: Boolean) { putUserData(ENABLED_KEY, value) } -suspend fun Project.zlsRunningAsync(): Boolean { - if (!zlsEnabledAsync()) - return false - return lsm.isRunning -} - -fun Project.zlsRunningSync(): Boolean { - if (!zlsEnabledSync()) +fun Project.zlsRunning(): Boolean { + if (!zlsEnabled()) return false return lsm.isRunning } @@ -135,7 +125,7 @@ private suspend fun doStart(project: Project, restart: Boolean) { project.lsm.stop("ZigBrains") delay(250) } - if (project.zlsSettings.validateAsync()) { + if (project.zls?.isValid() == true) { delay(250) project.lsm.start("ZigBrains") } diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/notification/ZigEditorNotificationProvider.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/notification/ZigEditorNotificationProvider.kt index a812b8b8..599ecacb 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/notification/ZigEditorNotificationProvider.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/notification/ZigEditorNotificationProvider.kt @@ -23,8 +23,8 @@ package com.falsepattern.zigbrains.lsp.notification import com.falsepattern.zigbrains.lsp.ZLSBundle -import com.falsepattern.zigbrains.lsp.settings.zlsSettings -import com.falsepattern.zigbrains.lsp.zlsRunningAsync +import com.falsepattern.zigbrains.lsp.zls.zls +import com.falsepattern.zigbrains.lsp.zlsRunning import com.falsepattern.zigbrains.shared.zigCoroutineScope import com.falsepattern.zigbrains.zig.ZigFileType import com.falsepattern.zigbrains.zon.ZonFileType @@ -49,10 +49,10 @@ class ZigEditorNotificationProvider: EditorNotificationProvider, DumbAware { else -> return null } val task = project.zigCoroutineScope.async { - if (project.zlsRunningAsync()) { + if (project.zlsRunning()) { return@async null } else { - return@async project.zlsSettings.validateAsync() + return@async project.zls?.isValid() == true } } return Function { editor -> diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSProjectSettingsService.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSProjectSettingsService.kt deleted file mode 100644 index 819a0bc2..00000000 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSProjectSettingsService.kt +++ /dev/null @@ -1,158 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.lsp.settings - -import com.falsepattern.zigbrains.direnv.emptyEnv -import com.falsepattern.zigbrains.direnv.getDirenv -import com.falsepattern.zigbrains.lsp.ZLSBundle -import com.falsepattern.zigbrains.lsp.startLSP -import com.falsepattern.zigbrains.project.settings.zigProjectSettings -import com.intellij.ide.IdeEventQueue -import com.intellij.openapi.components.* -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.io.toNioPathOrNull -import com.intellij.platform.ide.progress.ModalTaskOwner -import com.intellij.platform.ide.progress.runWithModalProgressBlocking -import com.intellij.util.application -import kotlinx.coroutines.runBlocking -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock -import java.nio.file.Path -import kotlin.io.path.isExecutable -import kotlin.io.path.isRegularFile - -@Service(Service.Level.PROJECT) -@State( - name = "ZLSSettings", - storages = [Storage(value = "zigbrains.xml")] -) -class ZLSProjectSettingsService(val project: Project): PersistentStateComponent { - @Volatile - private var state = ZLSSettings() - @Volatile - private var dirty = true - @Volatile - private var valid = false - - private val mutex = Mutex() - override fun getState(): ZLSSettings { - return state.copy() - } - - fun setState(value: ZLSSettings) { - runBlocking { - mutex.withLock { - this@ZLSProjectSettingsService.state = value - dirty = true - } - } - startLSP(project, true) - } - - override fun loadState(state: ZLSSettings) { - setState(state) - } - - suspend fun validateAsync(): Boolean { - mutex.withLock { - if (dirty) { - val state = this.state - valid = doValidate(project, state) - dirty = false - } - return valid - } - } - - fun validateSync(): Boolean { - val isValid: Boolean? = runBlocking { - mutex.withLock { - if (dirty) - null - else - valid - } - } - if (isValid != null) { - return isValid - } - return if (useModalProgress()) { - runWithModalProgressBlocking(ModalTaskOwner.project(project), ZLSBundle.message("progress.title.validate")) { - validateAsync() - } - } else { - runBlocking { - validateAsync() - } - } - } -} - -private val prohibitClass: Class<*>? = runCatching { - Class.forName("com_intellij_ide_ProhibitAWTEvents".replace('_', '.')) -}.getOrNull() - -private val postProcessors: List<*>? = runCatching { - if (prohibitClass == null) - return@runCatching null - val postProcessorsField = IdeEventQueue::class.java.getDeclaredField("postProcessors") - postProcessorsField.isAccessible = true - postProcessorsField.get(IdeEventQueue.getInstance()) as? List<*> -}.getOrNull() - -private fun useModalProgress(): Boolean { - if (!application.isDispatchThread) - return false - - if (application.isWriteAccessAllowed) - return false - - if (postProcessors == null) - return true - - return postProcessors.none { prohibitClass!!.isInstance(it) } -} - -private suspend fun doValidate(project: Project, state: ZLSSettings): Boolean { - val zlsPath: Path = state.zlsPath.let { zlsPath -> - if (zlsPath.isEmpty()) { - val env = if (project.zigProjectSettings.state.direnv) project.getDirenv() else emptyEnv - env.findExecutableOnPATH("zls") ?: run { - return false - } - } else { - zlsPath.toNioPathOrNull() ?: run { - return false - } - } - } - if (!zlsPath.toFile().exists()) { - return false - } - if (!zlsPath.isRegularFile() || !zlsPath.isExecutable()) { - return false - } - return true -} - -val Project.zlsSettings get() = service() \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettings.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettings.kt index d7f2f26e..1c462864 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettings.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettings.kt @@ -23,37 +23,31 @@ package com.falsepattern.zigbrains.lsp.settings import com.falsepattern.zigbrains.lsp.config.SemanticTokens -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.intellij.openapi.project.Project +import com.intellij.util.xmlb.annotations.Attribute import org.jetbrains.annotations.NonNls @Suppress("PropertyName") data class ZLSSettings( - var zlsPath: @NonNls String = "", - var zlsConfigPath: @NonNls String = "", - val inlayHints: Boolean = true, - val enable_snippets: Boolean = true, - val enable_argument_placeholders: Boolean = true, - val completion_label_details: Boolean = true, - val enable_build_on_save: Boolean = false, - val build_on_save_args: String = "", - val semantic_tokens: SemanticTokens = SemanticTokens.full, - val inlay_hints_show_variable_type_hints: Boolean = true, - val inlay_hints_show_struct_literal_field_type: Boolean = true, - val inlay_hints_show_parameter_name: Boolean = true, - val inlay_hints_show_builtin: Boolean = true, - val inlay_hints_exclude_single_argument: Boolean = true, - val inlay_hints_hide_redundant_param_names: Boolean = false, - val inlay_hints_hide_redundant_param_names_last_token: Boolean = false, - val warn_style: Boolean = false, - val highlight_global_var_declarations: Boolean = false, - val skip_std_references: Boolean = false, - val prefer_ast_check_as_child_process: Boolean = true, - val builtin_path: String? = null, - val build_runner_path: @NonNls String? = null, - val global_cache_path: @NonNls String? = null, -): ZigProjectConfigurationProvider.Settings { - override fun apply(project: Project) { - project.zlsSettings.loadState(this) - } -} + @JvmField @Attribute val zlsConfigPath: @NonNls String = "", + @JvmField @Attribute val inlayHints: Boolean = true, + @JvmField @Attribute val enable_snippets: Boolean = true, + @JvmField @Attribute val enable_argument_placeholders: Boolean = true, + @JvmField @Attribute val completion_label_details: Boolean = true, + @JvmField @Attribute val enable_build_on_save: Boolean = false, + @JvmField @Attribute val build_on_save_args: String = "", + @JvmField @Attribute val semantic_tokens: SemanticTokens = SemanticTokens.full, + @JvmField @Attribute val inlay_hints_show_variable_type_hints: Boolean = true, + @JvmField @Attribute val inlay_hints_show_struct_literal_field_type: Boolean = true, + @JvmField @Attribute val inlay_hints_show_parameter_name: Boolean = true, + @JvmField @Attribute val inlay_hints_show_builtin: Boolean = true, + @JvmField @Attribute val inlay_hints_exclude_single_argument: Boolean = true, + @JvmField @Attribute val inlay_hints_hide_redundant_param_names: Boolean = false, + @JvmField @Attribute val inlay_hints_hide_redundant_param_names_last_token: Boolean = false, + @JvmField @Attribute val warn_style: Boolean = false, + @JvmField @Attribute val highlight_global_var_declarations: Boolean = false, + @JvmField @Attribute val skip_std_references: Boolean = false, + @JvmField @Attribute val prefer_ast_check_as_child_process: Boolean = true, + @JvmField @Attribute val builtin_path: String? = null, + @JvmField @Attribute val build_runner_path: @NonNls String? = null, + @JvmField @Attribute val global_cache_path: @NonNls String? = null, +) \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigProvider.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigProvider.kt index b11e3ab4..aa1aaabb 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigProvider.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigProvider.kt @@ -24,12 +24,13 @@ package com.falsepattern.zigbrains.lsp.settings import com.falsepattern.zigbrains.lsp.config.ZLSConfig import com.falsepattern.zigbrains.lsp.config.ZLSConfigProvider +import com.falsepattern.zigbrains.lsp.zls.zls import com.falsepattern.zigbrains.shared.cli.translateCommandline import com.intellij.openapi.project.Project class ZLSSettingsConfigProvider: ZLSConfigProvider { override fun getEnvironment(project: Project, previous: ZLSConfig): ZLSConfig { - val state = project.zlsSettings.state + val state = project.zls?.settings ?: return previous return previous.copy( enable_snippets = state.enable_snippets, enable_argument_placeholders = state.enable_argument_placeholders, diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigurable.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigurable.kt deleted file mode 100644 index fad06b27..00000000 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsConfigurable.kt +++ /dev/null @@ -1,57 +0,0 @@ -/* - * This file is part of ZigBrains. - * - * Copyright (C) 2023-2025 FalsePattern - * All Rights Reserved - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * ZigBrains is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, only version 3 of the License. - * - * ZigBrains is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with ZigBrains. If not, see . - */ - -package com.falsepattern.zigbrains.lsp.settings - -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.falsepattern.zigbrains.shared.SubConfigurable -import com.intellij.openapi.project.Project -import com.intellij.openapi.util.Disposer -import com.intellij.ui.dsl.builder.Panel - -class ZLSSettingsConfigurable(private val project: Project): SubConfigurable { - private var appSettingsComponent: ZLSSettingsPanel? = null - override fun createComponent(holder: ZigProjectConfigurationProvider.SettingsPanelHolder, panel: Panel): ZigProjectConfigurationProvider.SettingsPanel { - val settingsPanel = ZLSSettingsPanel(project).apply { attach(panel) }.also { Disposer.register(this, it) } - appSettingsComponent = settingsPanel - return settingsPanel - } - - override fun isModified(): Boolean { - val data = appSettingsComponent?.data ?: return false - return project.zlsSettings.state != data - } - - override fun apply() { - val data = appSettingsComponent?.data ?: return - val settings = project.zlsSettings - settings.state = data - } - - override fun reset() { - appSettingsComponent?.data = project.zlsSettings.state - } - - override fun dispose() { - appSettingsComponent = null - } -} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsPanel.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsPanel.kt index 2806228c..08daa015 100644 --- a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsPanel.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/settings/ZLSSettingsPanel.kt @@ -22,74 +22,27 @@ package com.falsepattern.zigbrains.lsp.settings -import com.falsepattern.zigbrains.direnv.DirenvCmd -import com.falsepattern.zigbrains.direnv.Env -import com.falsepattern.zigbrains.direnv.emptyEnv -import com.falsepattern.zigbrains.direnv.getDirenv import com.falsepattern.zigbrains.lsp.ZLSBundle import com.falsepattern.zigbrains.lsp.config.SemanticTokens -import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider -import com.falsepattern.zigbrains.project.settings.zigProjectSettings -import com.falsepattern.zigbrains.shared.cli.call -import com.falsepattern.zigbrains.shared.cli.createCommandLineSafe -import com.falsepattern.zigbrains.shared.coroutine.launchWithEDT -import com.falsepattern.zigbrains.shared.coroutine.withEDTContext -import com.falsepattern.zigbrains.shared.zigCoroutineScope -import com.intellij.execution.processTools.mapFlat -import com.intellij.openapi.application.ModalityState +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableElementPanel import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory -import com.intellij.openapi.project.Project -import com.intellij.openapi.project.guessProjectDir import com.intellij.openapi.ui.ComboBox import com.intellij.openapi.util.Disposer -import com.intellij.openapi.util.io.toNioPathOrNull -import com.intellij.openapi.vfs.toNioPathOrNull -import com.intellij.platform.ide.progress.ModalTaskOwner -import com.intellij.platform.ide.progress.TaskCancellation -import com.intellij.platform.ide.progress.withModalProgress -import com.intellij.ui.DocumentAdapter -import com.intellij.ui.JBColor import com.intellij.ui.components.JBCheckBox -import com.intellij.ui.components.JBTextArea import com.intellij.ui.components.fields.ExtendableTextField import com.intellij.ui.components.textFieldWithBrowseButton import com.intellij.ui.dsl.builder.AlignX import com.intellij.ui.dsl.builder.Panel import com.intellij.ui.dsl.builder.Row -import kotlinx.coroutines.Job -import kotlinx.coroutines.cancel -import kotlinx.coroutines.delay -import kotlinx.coroutines.launch import org.jetbrains.annotations.PropertyKey -import javax.swing.event.DocumentEvent -import kotlin.io.path.pathString @Suppress("PrivatePropertyName") -class ZLSSettingsPanel(private val project: Project) : ZigProjectConfigurationProvider.SettingsPanel { - private val zlsPath = textFieldWithBrowseButton( - project, - ZLSBundle.message("settings.zls-path.browse.title"), - FileChooserDescriptorFactory.createSingleFileDescriptor(), - ).also { - it.textField.document.addDocumentListener(object: DocumentAdapter() { - override fun textChanged(p0: DocumentEvent) { - dispatchUpdateUI() - } - }) - Disposer.register(this, it) - } +class ZLSSettingsPanel() : ImmutableElementPanel { private val zlsConfigPath = textFieldWithBrowseButton( - project, + null, ZLSBundle.message("settings.zls-config-path.browse.title"), - FileChooserDescriptorFactory.createSingleFileDescriptor() + FileChooserDescriptorFactory.createSingleFileNoJarsDescriptor() ).also { Disposer.register(this, it) } - - private val zlsVersion = JBTextArea().also { it.isEditable = false } - - private var debounce: Job? = null - - private var direnv: Boolean = project.zigProjectSettings.state.direnv - private val inlayHints = JBCheckBox() private val enable_snippets = JBCheckBox() private val enable_argument_placeholders = JBCheckBox() @@ -112,121 +65,113 @@ class ZLSSettingsPanel(private val project: Project) : ZigProjectConfigurationPr private val build_runner_path = ExtendableTextField() private val global_cache_path = ExtendableTextField() - override fun attach(p: Panel) = with(p) { - if (!project.isDefault) { - group(ZLSBundle.message("settings.group.title")) { - fancyRow( - "settings.zls-path.label", - "settings.zls-path.tooltip" - ) { - cell(zlsPath).resizableColumn().align(AlignX.FILL) - } - row(ZLSBundle.message("settings.zls-version.label")) { - cell(zlsVersion) - } - fancyRow( - "settings.zls-config-path.label", - "settings.zls-config-path.tooltip" - ) { cell(zlsConfigPath).align(AlignX.FILL) } - fancyRow( - "settings.enable_snippets.label", - "settings.enable_snippets.tooltip" - ) { cell(enable_snippets) } - fancyRow( - "settings.enable_argument_placeholders.label", - "settings.enable_argument_placeholders.tooltip" - ) { cell(enable_argument_placeholders) } - fancyRow( - "settings.completion_label_details.label", - "settings.completion_label_details.tooltip" - ) { cell(completion_label_details) } - fancyRow( - "settings.enable_build_on_save.label", - "settings.enable_build_on_save.tooltip" - ) { cell(enable_build_on_save) } - fancyRow( - "settings.build_on_save_args.label", - "settings.build_on_save_args.tooltip" - ) { cell(build_on_save_args).resizableColumn().align(AlignX.FILL) } - fancyRow( - "settings.semantic_tokens.label", - "settings.semantic_tokens.tooltip" - ) { cell(semantic_tokens) } - group(ZLSBundle.message("settings.inlay-hints-group.label")) { - fancyRow( - "settings.inlay-hints-enable.label", - "settings.inlay-hints-enable.tooltip" - ) { cell(inlayHints) } - fancyRow( - "settings.inlay_hints_show_variable_type_hints.label", - "settings.inlay_hints_show_variable_type_hints.tooltip" - ) { cell(inlay_hints_show_variable_type_hints) } - fancyRow( - "settings.inlay_hints_show_struct_literal_field_type.label", - "settings.inlay_hints_show_struct_literal_field_type.tooltip" - ) { cell(inlay_hints_show_struct_literal_field_type) } - fancyRow( - "settings.inlay_hints_show_parameter_name.label", - "settings.inlay_hints_show_parameter_name.tooltip" - ) { cell(inlay_hints_show_parameter_name) } - fancyRow( - "settings.inlay_hints_show_builtin.label", - "settings.inlay_hints_show_builtin.tooltip" - ) { cell(inlay_hints_show_builtin) } - fancyRow( - "settings.inlay_hints_exclude_single_argument.label", - "settings.inlay_hints_exclude_single_argument.tooltip" - ) { cell(inlay_hints_exclude_single_argument) } - fancyRow( - "settings.inlay_hints_hide_redundant_param_names.label", - "settings.inlay_hints_hide_redundant_param_names.tooltip" - ) { cell(inlay_hints_hide_redundant_param_names) } - fancyRow( - "settings.inlay_hints_hide_redundant_param_names_last_token.label", - "settings.inlay_hints_hide_redundant_param_names_last_token.tooltip" - ) { cell(inlay_hints_hide_redundant_param_names_last_token) } - } - fancyRow( - "settings.warn_style.label", - "settings.warn_style.tooltip" - ) { cell(warn_style) } - fancyRow( - "settings.highlight_global_var_declarations.label", - "settings.highlight_global_var_declarations.tooltip" - ) { cell(highlight_global_var_declarations) } - fancyRow( - "settings.skip_std_references.label", - "settings.skip_std_references.tooltip" - ) { cell(skip_std_references) } - fancyRow( - "settings.prefer_ast_check_as_child_process.label", - "settings.prefer_ast_check_as_child_process.tooltip" - ) { cell(prefer_ast_check_as_child_process) } - fancyRow( - "settings.builtin_path.label", - "settings.builtin_path.tooltip" - ) { cell(builtin_path).resizableColumn().align(AlignX.FILL) } - fancyRow( - "settings.build_runner_path.label", - "settings.build_runner_path.tooltip" - ) { cell(build_runner_path).resizableColumn().align(AlignX.FILL) } - fancyRow( - "settings.global_cache_path.label", - "settings.global_cache_path.tooltip" - ) { cell(global_cache_path).resizableColumn().align(AlignX.FILL) } - } + override fun attach(p: Panel): Unit = with(p) { + fancyRow( + "settings.zls-config-path.label", + "settings.zls-config-path.tooltip" + ) { cell(zlsConfigPath).align(AlignX.FILL) } + fancyRow( + "settings.enable_snippets.label", + "settings.enable_snippets.tooltip" + ) { cell(enable_snippets) } + fancyRow( + "settings.enable_argument_placeholders.label", + "settings.enable_argument_placeholders.tooltip" + ) { cell(enable_argument_placeholders) } + fancyRow( + "settings.completion_label_details.label", + "settings.completion_label_details.tooltip" + ) { cell(completion_label_details) } + fancyRow( + "settings.enable_build_on_save.label", + "settings.enable_build_on_save.tooltip" + ) { cell(enable_build_on_save) } + fancyRow( + "settings.build_on_save_args.label", + "settings.build_on_save_args.tooltip" + ) { cell(build_on_save_args).resizableColumn().align(AlignX.FILL) } + fancyRow( + "settings.semantic_tokens.label", + "settings.semantic_tokens.tooltip" + ) { cell(semantic_tokens) } + collapsibleGroup(ZLSBundle.message("settings.inlay-hints-group.label"), indent = false) { + fancyRow( + "settings.inlay-hints-enable.label", + "settings.inlay-hints-enable.tooltip" + ) { cell(inlayHints) } + fancyRow( + "settings.inlay_hints_show_variable_type_hints.label", + "settings.inlay_hints_show_variable_type_hints.tooltip" + ) { cell(inlay_hints_show_variable_type_hints) } + fancyRow( + "settings.inlay_hints_show_struct_literal_field_type.label", + "settings.inlay_hints_show_struct_literal_field_type.tooltip" + ) { cell(inlay_hints_show_struct_literal_field_type) } + fancyRow( + "settings.inlay_hints_show_parameter_name.label", + "settings.inlay_hints_show_parameter_name.tooltip" + ) { cell(inlay_hints_show_parameter_name) } + fancyRow( + "settings.inlay_hints_show_builtin.label", + "settings.inlay_hints_show_builtin.tooltip" + ) { cell(inlay_hints_show_builtin) } + fancyRow( + "settings.inlay_hints_exclude_single_argument.label", + "settings.inlay_hints_exclude_single_argument.tooltip" + ) { cell(inlay_hints_exclude_single_argument) } + fancyRow( + "settings.inlay_hints_hide_redundant_param_names.label", + "settings.inlay_hints_hide_redundant_param_names.tooltip" + ) { cell(inlay_hints_hide_redundant_param_names) } + fancyRow( + "settings.inlay_hints_hide_redundant_param_names_last_token.label", + "settings.inlay_hints_hide_redundant_param_names_last_token.tooltip" + ) { cell(inlay_hints_hide_redundant_param_names_last_token) } } - dispatchAutodetect(false) + fancyRow( + "settings.warn_style.label", + "settings.warn_style.tooltip" + ) { cell(warn_style) } + fancyRow( + "settings.highlight_global_var_declarations.label", + "settings.highlight_global_var_declarations.tooltip" + ) { cell(highlight_global_var_declarations) } + fancyRow( + "settings.skip_std_references.label", + "settings.skip_std_references.tooltip" + ) { cell(skip_std_references) } + fancyRow( + "settings.prefer_ast_check_as_child_process.label", + "settings.prefer_ast_check_as_child_process.tooltip" + ) { cell(prefer_ast_check_as_child_process) } + fancyRow( + "settings.builtin_path.label", + "settings.builtin_path.tooltip" + ) { cell(builtin_path).resizableColumn().align(AlignX.FILL) } + fancyRow( + "settings.build_runner_path.label", + "settings.build_runner_path.tooltip" + ) { cell(build_runner_path).resizableColumn().align(AlignX.FILL) } + fancyRow( + "settings.global_cache_path.label", + "settings.global_cache_path.tooltip" + ) { cell(global_cache_path).resizableColumn().align(AlignX.FILL) } } - override fun direnvChanged(state: Boolean) { - direnv = state - dispatchAutodetect(true) + override fun isModified(elem: ZLSSettings): Boolean { + return elem != data } - override var data - get() = if (project.isDefault) ZLSSettings() else ZLSSettings( - zlsPath.text, + override fun apply(elem: ZLSSettings): ZLSSettings? { + return data + } + + override fun reset(elem: ZLSSettings?) { + data = elem ?: ZLSSettings() + } + + private var data + get() = ZLSSettings( zlsConfigPath.text, inlayHints.isSelected, enable_snippets.isSelected, @@ -251,7 +196,6 @@ class ZLSSettingsPanel(private val project: Project) : ZigProjectConfigurationPr global_cache_path.text?.ifBlank { null }, ) set(value) { - zlsPath.text = value.zlsPath zlsConfigPath.text = value.zlsConfigPath inlayHints.isSelected = value.inlayHints enable_snippets.isSelected = value.enable_snippets @@ -275,72 +219,10 @@ class ZLSSettingsPanel(private val project: Project) : ZigProjectConfigurationPr builtin_path.text = value.builtin_path ?: "" build_runner_path.text = value.build_runner_path ?: "" global_cache_path.text = value.global_cache_path ?: "" - dispatchUpdateUI() } - private fun dispatchAutodetect(force: Boolean) { - project.zigCoroutineScope.launchWithEDT(ModalityState.defaultModalityState()) { - withModalProgress(ModalTaskOwner.component(zlsPath), "Detecting ZLS...", TaskCancellation.cancellable()) { - autodetect(force) - } - } - } - - suspend fun autodetect(force: Boolean) { - if (force || zlsPath.text.isBlank()) { - getDirenv().findExecutableOnPATH("zls")?.let { - if (force || zlsPath.text.isBlank()) { - zlsPath.text = it.pathString - dispatchUpdateUI() - } - } - } - } - override fun dispose() { - debounce?.cancel("Disposed") - } - - private suspend fun getDirenv(): Env { - if (!project.isDefault && DirenvCmd.direnvInstalled() && direnv) - return project.getDirenv() - return emptyEnv - } - - private fun dispatchUpdateUI() { - debounce?.cancel("New debounce") - debounce = project.zigCoroutineScope.launch { - updateUI() - } - } - - private suspend fun updateUI() { - if (project.isDefault) - return - delay(200) - val zlsPath = this.zlsPath.text.ifBlank { null }?.toNioPathOrNull() - if (zlsPath == null) { - withEDTContext(ModalityState.any()) { - zlsVersion.text = "[zls path empty or invalid]" - } - return - } - val workingDir = project.guessProjectDir()?.toNioPathOrNull() - val result = createCommandLineSafe(workingDir, zlsPath, "version") - .map { it.withEnvironment(getDirenv().env) } - .mapFlat { it.call() } - .getOrElse { throwable -> - throwable.printStackTrace() - withEDTContext(ModalityState.any()) { - zlsVersion.text = "[failed to run \"zls version\"]\n${throwable.message}" - } - return - } - val version = result.stdout.trim() - withEDTContext(ModalityState.any()) { - zlsVersion.text = version - zlsVersion.foreground = JBColor.foreground() - } + zlsConfigPath.dispose() } } diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSConfigurable.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSConfigurable.kt new file mode 100644 index 00000000..87c5fb76 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSConfigurable.kt @@ -0,0 +1,87 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls + +import com.intellij.openapi.ui.NamedConfigurable +import com.intellij.openapi.util.NlsContexts +import com.intellij.ui.dsl.builder.panel +import java.awt.Dimension +import java.util.* +import javax.swing.JComponent + +class ZLSConfigurable(val uuid: UUID, zls: ZLSVersion): NamedConfigurable() { + var zls: ZLSVersion = zls + set(value) { + zlsInstallations[uuid] = value + field = value + } + private var myView: ZLSPanel? = null + + override fun setDisplayName(name: String?) { + zls = zls.copy(name = name) + } + + override fun getEditableObject(): UUID? { + return uuid + } + + override fun getBannerSlogan(): @NlsContexts.DetailedDescription String? { + return displayName + } + + override fun createOptionsPanel(): JComponent? { + var view = myView + if (view == null) { + view = ZLSPanel() + view.reset(zls) + myView = view + } + val p = panel { + view.attach(this@panel) + } + p.preferredSize = Dimension(640, 480) + return p + } + + override fun getDisplayName(): @NlsContexts.ConfigurableName String? { + return zls.name + } + + override fun isModified(): Boolean { + return myView?.isModified(zls) == true + } + + override fun apply() { + myView?.apply(zls)?.let { zls = it } + } + + override fun reset() { + myView?.reset(zls) + } + + override fun disposeUIResources() { + myView?.dispose() + myView = null + super.disposeUIResources() + } +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSInstallationsService.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSInstallationsService.kt new file mode 100644 index 00000000..52e1b3f8 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSInstallationsService.kt @@ -0,0 +1,54 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls + +import com.falsepattern.zigbrains.lsp.zls.ZLSInstallationsService.MyState +import com.falsepattern.zigbrains.shared.UUIDMapSerializable +import com.falsepattern.zigbrains.shared.UUIDStorage +import com.intellij.openapi.components.Service +import com.intellij.openapi.components.State +import com.intellij.openapi.components.Storage +import com.intellij.openapi.components.service + +@Service(Service.Level.APP) +@State( + name = "ZLSInstallations", + storages = [Storage("zigbrains.xml")] +) +class ZLSInstallationsService: UUIDMapSerializable.Converting(MyState()) { + override fun serialize(value: ZLSVersion) = value.toRef() + override fun deserialize(value: ZLSVersion.Ref) = value.resolve() + override fun getStorage(state: MyState) = state.zlsInstallations + override fun updateStorage(state: MyState, storage: ZLSStorage) = state.copy(zlsInstallations = storage) + + data class MyState(@JvmField val zlsInstallations: ZLSStorage = emptyMap()) + + companion object { + @JvmStatic + fun getInstance(): ZLSInstallationsService = service() + } +} + +inline val zlsInstallations: ZLSInstallationsService get() = ZLSInstallationsService.getInstance() + +private typealias ZLSStorage = UUIDStorage \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSPanel.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSPanel.kt new file mode 100644 index 00000000..ba52933f --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSPanel.kt @@ -0,0 +1,142 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls + +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.settings.ZLSSettingsPanel +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableNamedElementPanelBase +import com.falsepattern.zigbrains.shared.cli.call +import com.falsepattern.zigbrains.shared.cli.createCommandLineSafe +import com.falsepattern.zigbrains.shared.coroutine.withEDTContext +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.application.ModalityState +import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory +import com.intellij.openapi.util.Disposer +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.ui.DocumentAdapter +import com.intellij.ui.JBColor +import com.intellij.ui.components.JBTextArea +import com.intellij.ui.components.textFieldWithBrowseButton +import com.intellij.ui.dsl.builder.AlignX +import com.intellij.ui.dsl.builder.Panel +import kotlinx.coroutines.Job +import kotlinx.coroutines.cancel +import kotlinx.coroutines.delay +import kotlinx.coroutines.launch +import javax.swing.event.DocumentEvent +import kotlin.io.path.pathString + +class ZLSPanel() : ImmutableNamedElementPanelBase() { + private val pathToZLS = textFieldWithBrowseButton( + null, + ZLSBundle.message("dialog.title.zls"), + FileChooserDescriptorFactory.createSingleFileNoJarsDescriptor() + ).also { + it.textField.document.addDocumentListener(object : DocumentAdapter() { + override fun textChanged(e: DocumentEvent) { + dispatchUpdateUI() + } + }) + Disposer.register(this, it) + } + private val zlsVersion = JBTextArea().also { it.isEditable = false } + private var settingsPanel: ZLSSettingsPanel? = null + private var debounce: Job? = null + + override fun attach(p: Panel): Unit = with(p) { + super.attach(p) + row(ZLSBundle.message("settings.panel.path.label")) { + cell(pathToZLS).resizableColumn().align(AlignX.FILL) + } + row(ZLSBundle.message("settings.panel.version.label")) { + cell(zlsVersion) + } + val sp = ZLSSettingsPanel() + p.collapsibleGroup(ZLSBundle.message("settings.panel.settings.group.label"), indent = false) { + sp.attach(this@collapsibleGroup) + } + settingsPanel = sp + } + + override fun isModified(version: ZLSVersion): Boolean { + val name = nameFieldValue ?: return false + val path = this.pathToZLS.text.ifBlank { null }?.toNioPathOrNull() ?: return false + return name != version.name || version.path != path || settingsPanel?.isModified(version.settings) == true + } + + override fun apply(version: ZLSVersion): ZLSVersion? { + val path = this.pathToZLS.text.ifBlank { null }?.toNioPathOrNull() ?: return null + return version.copy(path = path, name = nameFieldValue ?: "", settings = settingsPanel?.apply(version.settings) ?: version.settings) + } + + override fun reset(version: ZLSVersion?) { + nameFieldValue = version?.name ?: "" + this.pathToZLS.text = version?.path?.pathString ?: "" + settingsPanel?.reset(version?.settings) + dispatchUpdateUI() + } + + private fun dispatchUpdateUI() { + debounce?.cancel("New debounce") + debounce = zigCoroutineScope.launch { + updateUI() + } + } + + private suspend fun updateUI() { + delay(200) + val pathToZLS = this.pathToZLS.text.ifBlank { null }?.toNioPathOrNull() + if (pathToZLS == null) { + withEDTContext(ModalityState.any()) { + zlsVersion.text = "[zls path empty or invalid]" + } + return + } + val versionCommand = createCommandLineSafe(null, pathToZLS, "--version").getOrElse { + it.printStackTrace() + withEDTContext(ModalityState.any()) { + zlsVersion.text = "[could not create \"zls --version\" command]\n${it.message}" + } + return + } + val result = versionCommand.call().getOrElse { + it.printStackTrace() + withEDTContext(ModalityState.any()) { + zlsVersion.text = "[failed to run \"zls --version\"]\n${it.message}" + } + return + } + val version = result.stdout.trim() + + withEDTContext(ModalityState.any()) { + zlsVersion.text = version + zlsVersion.foreground = JBColor.foreground() + } + } + + override fun dispose() { + debounce?.cancel("Disposed") + settingsPanel?.dispose() + settingsPanel = null + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigCoreProjectConfigurationProvider.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSService.kt similarity index 54% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigCoreProjectConfigurationProvider.kt rename to lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSService.kt index 207da863..cdadebf7 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/settings/ZigCoreProjectConfigurationProvider.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSService.kt @@ -20,24 +20,26 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.settings +package com.falsepattern.zigbrains.lsp.zls -import com.falsepattern.zigbrains.shared.SubConfigurable +import com.falsepattern.zigbrains.project.toolchain.ZigToolchainService +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.withExtraData +import com.falsepattern.zigbrains.shared.asString +import com.falsepattern.zigbrains.shared.asUUID import com.intellij.openapi.project.Project -import com.intellij.openapi.project.ProjectManager +import java.util.* -class ZigCoreProjectConfigurationProvider: ZigProjectConfigurationProvider { - override fun handleMainConfigChanged(project: Project) { - } +fun T.withZLS(uuid: UUID?): T { + return withExtraData("zls_uuid", uuid?.asString()) +} - override fun createConfigurable(project: Project): SubConfigurable { - return ZigProjectConfigurable(project) - } +val ZigToolchain.zlsUUID: UUID? get() { + return extraData["zls_uuid"]?.asUUID() +} - override fun createNewProjectSettingsPanel(holder: ZigProjectConfigurationProvider.SettingsPanelHolder): ZigProjectConfigurationProvider.SettingsPanel { - return ZigProjectSettingsPanel(holder, ProjectManager.getInstance().defaultProject) - } +val ZigToolchain.zls: ZLSVersion? get() { + return zlsUUID?.let { zlsInstallations[it] } +} - override val priority: Int - get() = 0 -} \ No newline at end of file +val Project.zls: ZLSVersion? get() = ZigToolchainService.getInstance(this).toolchain?.zls diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSVersion.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSVersion.kt new file mode 100644 index 00000000..8386baea --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ZLSVersion.kt @@ -0,0 +1,91 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls + +import com.falsepattern.zigbrains.lsp.settings.ZLSSettings +import com.falsepattern.zigbrains.shared.NamedObject +import com.falsepattern.zigbrains.shared.cli.call +import com.falsepattern.zigbrains.shared.cli.createCommandLineSafe +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.util.text.SemVer +import com.intellij.util.xmlb.annotations.Attribute +import com.intellij.util.xmlb.annotations.Tag +import java.nio.file.Path +import kotlin.io.path.isExecutable +import kotlin.io.path.isRegularFile +import kotlin.io.path.pathString + +data class ZLSVersion(val path: Path, override val name: String? = null, val settings: ZLSSettings = ZLSSettings()): NamedObject { + override fun withName(newName: String?): ZLSVersion { + return copy(name = newName) + } + + fun toRef(): Ref { + return Ref(path.pathString, name, settings) + } + + fun isValid(): Boolean { + if (!path.toFile().exists()) + return false + if (!path.isRegularFile() || !path.isExecutable()) + return false + return true + } + + suspend fun version(): SemVer? { + if (!isValid()) + return null + val cli = createCommandLineSafe(null, path, "--version").getOrElse { return null } + val info = cli.call(5000).getOrElse { return null } + return SemVer.parseFromText(info.stdout.trim()) + } + + companion object { + suspend fun tryFromPath(path: Path): ZLSVersion? { + var zls = ZLSVersion(path) + if (!zls.isValid()) + return null + val version = zls.version()?.rawVersion + if (version != null) { + zls = zls.copy(name = "ZLS $version") + } + return zls + } + } + + data class Ref( + @JvmField + @Attribute + val path: String? = "", + @JvmField + @Attribute + val name: String? = "", + @JvmField + @Tag + val settings: ZLSSettings = ZLSSettings() + ) { + fun resolve(): ZLSVersion? { + return path?.ifBlank { null }?.toNioPathOrNull()?.let { ZLSVersion(it, name, settings) } + } + } +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSDownloader.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSDownloader.kt new file mode 100644 index 00000000..b03fed30 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSDownloader.kt @@ -0,0 +1,45 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.downloader + +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.lsp.zls.ui.getSuggestedZLSPath +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider.IUserDataBridge +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainConfigurable +import com.falsepattern.zigbrains.shared.downloader.Downloader +import java.awt.Component + +class ZLSDownloader(component: Component, private val data: IUserDataBridge?) : Downloader(component) { + override val windowTitle get() = ZLSBundle.message("settings.downloader.title") + override val versionInfoFetchTitle get() = ZLSBundle.message("settings.downloader.progress.fetch") + override fun downloadProgressTitle(version: ZLSVersionInfo) = ZLSBundle.message("settings.downloader.progress.install", version.version.rawVersion) + override fun localSelector() = ZLSLocalSelector(component) + override suspend fun downloadVersionList(): List { + val toolchain = data?.getUserData(ZigToolchainConfigurable.TOOLCHAIN_KEY)?.get() + val project = data?.getUserData(ZigProjectConfigurationProvider.PROJECT_KEY) + return ZLSVersionInfo.downloadVersionInfoFor(toolchain, project) + } + override fun getSuggestedPath() = getSuggestedZLSPath() +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSLocalSelector.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSLocalSelector.kt new file mode 100644 index 00000000..a3126e21 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSLocalSelector.kt @@ -0,0 +1,74 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.downloader + +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.lsp.zls.zlsInstallations +import com.falsepattern.zigbrains.shared.downloader.LocalSelector +import com.falsepattern.zigbrains.shared.withUniqueName +import com.intellij.icons.AllIcons +import com.intellij.openapi.fileChooser.FileChooserDescriptor +import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory +import com.intellij.openapi.util.SystemInfo +import java.awt.Component +import java.nio.file.Path +import kotlin.io.path.isDirectory + +class ZLSLocalSelector(component: Component) : LocalSelector(component) { + override val windowTitle: String + get() = ZLSBundle.message("settings.local-selector.title") + override val descriptor: FileChooserDescriptor + get() = FileChooserDescriptorFactory.createSingleFileNoJarsDescriptor().withTitle(ZLSBundle.message("settings.local-selector.chooser.title")) + + override suspend fun browse(preSelected: Path?): ZLSVersion? { + if (preSelected?.isDirectory() == true) { + return super.browse(preSelected.resolve(if (SystemInfo.isWindows) "zls.exe" else "zls")) + } + return super.browse(preSelected) + } + + override suspend fun verify(path: Path): VerifyResult { + var zls = resolve(path, null) + var result: VerifyResult + result = if (zls == null) VerifyResult( + null, + false, + AllIcons.General.Error, + ZLSBundle.message("settings.local-selector.state.invalid"), + ) else VerifyResult( + null, + true, + AllIcons.General.Information, + ZLSBundle.message("settings.local-selector.state.ok") + ) + if (zls != null) { + zls = zlsInstallations.withUniqueName(zls) + } + return result.copy(name = zls?.name) + } + + override suspend fun resolve(path: Path, name: String?): ZLSVersion? { + return ZLSVersion.tryFromPath(path)?.let { zls -> name?.let { zls.copy(name = it) } ?: zls } + } +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSVersionInfo.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSVersionInfo.kt new file mode 100644 index 00000000..d6c7f0a0 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/downloader/ZLSVersionInfo.kt @@ -0,0 +1,99 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.downloader + +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.shared.downloader.VersionInfo +import com.falsepattern.zigbrains.shared.downloader.VersionInfo.Tarball +import com.falsepattern.zigbrains.shared.downloader.getTarballIfCompatible +import com.falsepattern.zigbrains.shared.downloader.tempPluginDir +import com.intellij.openapi.progress.coroutineToIndicator +import com.intellij.openapi.project.Project +import com.intellij.openapi.util.io.FileUtil +import com.intellij.util.asSafely +import com.intellij.util.download.DownloadableFileService +import com.intellij.util.text.SemVer +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.withContext +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.json.* +import java.net.URLEncoder + +@JvmRecord +data class ZLSVersionInfo( + override val version: SemVer, + override val date: String, + override val dist: Tarball +): VersionInfo { + companion object { + @OptIn(ExperimentalSerializationApi::class) + suspend fun downloadVersionInfoFor(toolchain: ZigToolchain?, project: Project?): List { + return withContext(Dispatchers.IO) { + val single = toolchain != null + val url = if (single) { + getToolchainURL(toolchain!!, project) ?: return@withContext emptyList() + } else { + multiURL + } + val service = DownloadableFileService.getInstance() + val tempFile = FileUtil.createTempFile(tempPluginDir, "zls_version_info", ".json", false, false) + val desc = service.createFileDescription(url, tempFile.name) + val downloader = service.createDownloader(listOf(desc), ZLSBundle.message("settings.downloader.service.index")) + val downloadResults = coroutineToIndicator { + downloader.download(tempPluginDir) + } + if (downloadResults.isEmpty()) + return@withContext emptyList() + val index = downloadResults[0].first + val info = index.inputStream().use { Json.decodeFromStream(it) } + index.delete() + return@withContext if (single) { + listOfNotNull(parseVersion(null, info)) + } else { + info.mapNotNull { (key, value) -> parseVersion(key, value) } + } + } + } + } +} + +private suspend fun getToolchainURL(toolchain: ZigToolchain, project: Project?): String? { + val zigVersion = toolchain.zig.getEnv(project).getOrNull()?.version ?: return null + return "https://releases.zigtools.org/v1/zls/select-version?zig_version=${URLEncoder.encode(zigVersion, Charsets.UTF_8)}&compatibility=only-runtime" +} +private const val multiURL: String = "https://builds.zigtools.org/index.json" +private fun parseVersion(versionKey: String?, data: JsonElement): ZLSVersionInfo? { + if (data !is JsonObject) { + return null + } + + val versionTag = data["version"]?.asSafely()?.content ?: versionKey + + val version = SemVer.parseFromText(versionTag) ?: return null + val date = data["date"]?.asSafely()?.content ?: "" + val dist = data.firstNotNullOfOrNull { (dist, tb) -> getTarballIfCompatible(dist, tb) } + ?: return null + + return ZLSVersionInfo(version, date, dist) +} diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSDriver.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSDriver.kt new file mode 100644 index 00000000..01f76706 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSDriver.kt @@ -0,0 +1,221 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.ui + +import com.falsepattern.zigbrains.direnv.DirenvService +import com.falsepattern.zigbrains.direnv.Env +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.zls.ZLSConfigurable +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.lsp.zls.downloader.ZLSDownloader +import com.falsepattern.zigbrains.lsp.zls.downloader.ZLSLocalSelector +import com.falsepattern.zigbrains.lsp.zls.zlsInstallations +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainConfigurable.Companion.TOOLCHAIN_KEY +import com.falsepattern.zigbrains.shared.UUIDMapSerializable +import com.falsepattern.zigbrains.shared.ui.* +import com.falsepattern.zigbrains.shared.ui.ListElem.One.Actual +import com.falsepattern.zigbrains.shared.withUniqueName +import com.intellij.openapi.project.Project +import com.intellij.openapi.ui.NamedConfigurable +import com.intellij.openapi.util.SystemInfo +import com.intellij.openapi.util.io.toNioPathOrNull +import com.intellij.util.system.OS +import com.intellij.util.text.SemVer +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.FlowCollector +import kotlinx.coroutines.flow.flow +import kotlinx.coroutines.flow.flowOn +import java.awt.Component +import java.nio.file.Files +import java.nio.file.Path +import java.util.* +import kotlin.io.path.isDirectory +import kotlin.io.path.isExecutable +import kotlin.io.path.isRegularFile + +sealed interface ZLSDriver: UUIDComboBoxDriver { + override val theMap: UUIDMapSerializable.Converting + get() = zlsInstallations + + override fun createContext(model: ZBModel): ZBContext { + return ZLSContext(null, model) + } + + override fun createComboBox(model: ZBModel): ZBComboBox { + return ZLSComboBox(model) + } + + override fun createNamedConfigurable(uuid: UUID, elem: ZLSVersion): NamedConfigurable { + return ZLSConfigurable(uuid, elem) + } + + override suspend fun resolvePseudo( + context: Component, + elem: ListElem.Pseudo + ): UUID? { + return when(elem) { + is ListElem.One.Suggested -> zlsInstallations.withUniqueName(elem.instance) + is ListElem.FromDisk -> ZLSLocalSelector(context).browse() + is ListElem.Download -> ZLSDownloader(context, data).download() + }?.let { zlsInstallations.registerNew(it) } + } + + val data: ZigProjectConfigurationProvider.IUserDataBridge? + + object ForList: ZLSDriver { + override suspend fun constructModelList(): List> { + val res = ArrayList>() + res.addAll(ListElem.fetchGroup()) + res.add(Separator(ZLSBundle.message("settings.model.detected.separator"), true)) + res.add(suggestZLSVersions().asPending()) + return res + } + + override val data: ZigProjectConfigurationProvider.IUserDataBridge? + get() = null + } + + @JvmRecord + data class ForSelector(override val data: ZigProjectConfigurationProvider.IUserDataBridge?): ZLSDriver { + override suspend fun constructModelList(): List> { + val (project, toolchainVersion) = unpack(data) + if (toolchainVersion == null) { + return listOf(ListElem.None()) + } + val res = ArrayList>() + res.add(ListElem.None()) + res.addAll(compatibleInstallations(toolchainVersion)) + res.add(Separator("", true)) + res.addAll(ListElem.fetchGroup()) + res.add(Separator(ZLSBundle.message("settings.model.detected.separator"), true)) + res.add(suggestZLSVersions(project, data, toolchainVersion).asPending()) + return res + } + } +} + +private suspend fun unpack(data: ZigProjectConfigurationProvider.IUserDataBridge?): Pair { + val toolchain = data?.getUserData(TOOLCHAIN_KEY)?.get() + val project = data?.getUserData(ZigProjectConfigurationProvider.PROJECT_KEY) + val toolchainVersion = toolchain + ?.zig + ?.getEnv(project) + ?.getOrNull() + ?.version + ?.let { SemVer.parseFromText(it) } + return project to toolchainVersion +} + +private fun suggestZLSVersions(project: Project? = null, data: ZigProjectConfigurationProvider.IUserDataBridge? = null, toolchainVersion: SemVer? = null): Flow = flow { + val env = if (project != null && DirenvService.getStateFor(data, project).isEnabled(project)) { + DirenvService.getInstance(project).import() + } else { + Env.empty + } + val existing = zlsInstallations.map { (_, zls) -> zls } + env.findAllExecutablesOnPATH("zls").collect { path -> + if (existing.any { it.path == path }) { + return@collect + } + emitIfCompatible(path, toolchainVersion) + } + val exe = if (SystemInfo.isWindows) "zls.exe" else "zls" + getWellKnownZLS().forEach { wellKnown -> + runCatching { + Files.newDirectoryStream(wellKnown).use { stream -> + stream.asSequence().filterNotNull().forEach { dir -> + val path = dir.resolve(exe) + if (!path.isRegularFile() || !path.isExecutable()) { + return@forEach + } + if (existing.any { it.path == path }) { + return@forEach + } + emitIfCompatible(path, toolchainVersion) + } + } + } + } +}.flowOn(Dispatchers.IO) + +private suspend fun FlowCollector.emitIfCompatible(path: Path, toolchainVersion: SemVer?) { + val ver = ZLSVersion.tryFromPath(path) ?: return + if (isCompatible(ver, toolchainVersion)) { + emit(ver) + } +} + +private suspend fun compatibleInstallations(toolchainVersion: SemVer): List> { + return zlsInstallations.mapNotNull { (uuid, version) -> + if (!isCompatible(version, toolchainVersion)) { + return@mapNotNull null + } + Actual(uuid, version) + } +} + +private suspend fun isCompatible(version: ZLSVersion, toolchainVersion: SemVer?): Boolean { + if (toolchainVersion == null) + return true + val zlsVersion = version.version() ?: return false + return numericVersionEquals(zlsVersion, toolchainVersion) +} + +private fun numericVersionEquals(a: SemVer, b: SemVer): Boolean { + return a.major == b.major && a.minor == b.minor && a.patch == b.patch +} + + +fun getSuggestedZLSPath(): Path? { + return getWellKnownZLS().getOrNull(0) +} + +/** + * Returns the paths to the following list of folders: + * + * 1. DATA/zls + * 2. HOME/.zig + * + * Where DATA is: + * - ~/Library on macOS + * - %LOCALAPPDATA% on Windows + * - $XDG_DATA_HOME (or ~/.local/share if not set) on other OSes + * + * and HOME is the user home path + */ +private fun getWellKnownZLS(): List { + val home = System.getProperty("user.home")?.toNioPathOrNull() ?: return emptyList() + val xdgDataHome = when(OS.CURRENT) { + OS.macOS -> home.resolve("Library") + OS.Windows -> System.getenv("LOCALAPPDATA")?.toNioPathOrNull() + else -> System.getenv("XDG_DATA_HOME")?.toNioPathOrNull() ?: home.resolve(Path.of(".local", "share")) + } + val res = ArrayList() + if (xdgDataHome != null && xdgDataHome.isDirectory()) { + res.add(xdgDataHome.resolve("zls")) + } + res.add(home.resolve(".zls")) + return res +} \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSEditor.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSEditor.kt new file mode 100644 index 00000000..e5355722 --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSEditor.kt @@ -0,0 +1,93 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.ui + +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.lsp.zls.withZLS +import com.falsepattern.zigbrains.lsp.zls.zlsUUID +import com.falsepattern.zigbrains.project.settings.ZigProjectConfigurationProvider +import com.falsepattern.zigbrains.project.toolchain.base.PanelState +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchain +import com.falsepattern.zigbrains.project.toolchain.base.ZigToolchainExtensionsProvider +import com.falsepattern.zigbrains.project.toolchain.ui.ImmutableElementPanel +import com.falsepattern.zigbrains.shared.ui.UUIDMapSelector +import com.falsepattern.zigbrains.shared.zigCoroutineScope +import com.intellij.openapi.util.Key +import com.intellij.ui.dsl.builder.Panel +import kotlinx.coroutines.launch + +class ZLSEditor(private val sharedState: ZigProjectConfigurationProvider.IUserDataBridge?): + UUIDMapSelector(ZLSDriver.ForSelector(sharedState)), + ImmutableElementPanel, + ZigProjectConfigurationProvider.UserDataListener +{ + init { + sharedState?.addUserDataChangeListener(this) + } + + override fun onUserDataChanged(key: Key<*>) { + zigCoroutineScope.launch { listChanged() } + } + + override fun attach(panel: Panel): Unit = with(panel) { + row("Language Server") { + attachComboBoxRow(this) + } + } + + override fun isModified(toolchain: T): Boolean { + if (isEmpty) + return false + return toolchain.zlsUUID != selectedUUID + } + + override fun apply(toolchain: T): T { + return toolchain.withZLS(selectedUUID) + } + + override fun reset(toolchain: T?) { + selectedUUID = toolchain?.zlsUUID + zigCoroutineScope.launch { + listChanged() + selectedUUID = toolchain?.zlsUUID + } + } + + override fun dispose() { + super.dispose() + sharedState?.removeUserDataChangeListener(this) + } + + class Provider: ZigToolchainExtensionsProvider { + override fun createExtensionPanel(sharedState: ZigProjectConfigurationProvider.IUserDataBridge?, state: PanelState): ImmutableElementPanel? { + if (state == PanelState.ModalEditor) { + return null + } + return ZLSEditor(sharedState) + } + + override val index: Int + get() = 100 + + } +} \ No newline at end of file diff --git a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/AbstractZigToolchain.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSListEditor.kt similarity index 57% rename from core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/AbstractZigToolchain.kt rename to lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSListEditor.kt index ec3e3b94..8b67cff0 100644 --- a/core/src/main/kotlin/com/falsepattern/zigbrains/project/toolchain/AbstractZigToolchain.kt +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/ZLSListEditor.kt @@ -20,19 +20,19 @@ * along with ZigBrains. If not, see . */ -package com.falsepattern.zigbrains.project.toolchain +package com.falsepattern.zigbrains.lsp.zls.ui -import com.falsepattern.zigbrains.project.toolchain.tools.ZigCompilerTool -import com.intellij.execution.configurations.GeneralCommandLine -import com.intellij.openapi.project.Project -import java.nio.file.Path +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.shared.ui.UUIDMapEditor +import com.intellij.openapi.util.NlsContexts -abstract class AbstractZigToolchain { - val zig: ZigCompilerTool by lazy { ZigCompilerTool(this) } +class ZLSListEditor : UUIDMapEditor(ZLSDriver.ForList) { + override fun getEmptySelectionString(): String { + return ZLSBundle.message("settings.list.empty") + } - abstract fun workingDirectory(project: Project? = null): Path? - - abstract suspend fun patchCommandLine(commandLine: GeneralCommandLine, project: Project? = null): GeneralCommandLine - - abstract fun pathToExecutable(toolName: String, project: Project? = null): Path + override fun getDisplayName(): @NlsContexts.ConfigurableName String? { + return ZLSBundle.message("settings.list.title") + } } \ No newline at end of file diff --git a/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/model.kt b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/model.kt new file mode 100644 index 00000000..bdfd879e --- /dev/null +++ b/lsp/src/main/kotlin/com/falsepattern/zigbrains/lsp/zls/ui/model.kt @@ -0,0 +1,83 @@ +/* + * This file is part of ZigBrains. + * + * Copyright (C) 2023-2025 FalsePattern + * All Rights Reserved + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * ZigBrains is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, only version 3 of the License. + * + * ZigBrains is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with ZigBrains. If not, see . + */ + +package com.falsepattern.zigbrains.lsp.zls.ui + +import com.falsepattern.zigbrains.lsp.LSPIcons +import com.falsepattern.zigbrains.lsp.ZLSBundle +import com.falsepattern.zigbrains.lsp.zls.ZLSVersion +import com.falsepattern.zigbrains.shared.ui.* +import com.intellij.icons.AllIcons +import com.intellij.openapi.project.Project +import com.intellij.ui.SimpleTextAttributes +import com.intellij.ui.icons.EMPTY_ICON +import javax.swing.JList +import kotlin.io.path.pathString + + +class ZLSComboBox(model: ZBModel): ZBComboBox(model, ::ZLSCellRenderer) + +class ZLSContext(project: Project?, model: ZBModel): ZBContext(project, model, ::ZLSCellRenderer) + +class ZLSCellRenderer(getModel: () -> ZBModel): ZBCellRenderer(getModel) { + override fun customizeCellRenderer( + list: JList?>, + value: ListElem?, + index: Int, + selected: Boolean, + hasFocus: Boolean + ) { + icon = EMPTY_ICON + when (value) { + is ListElem.One -> { + val (icon, isSuggestion) = when(value) { + is ListElem.One.Suggested -> AllIcons.General.Information to true + is ListElem.One.Actual -> LSPIcons.ZLS to false + } + this.icon = icon + val item = value.instance + val name = item.name + val path = item.path.pathString + renderPathNameComponent(path, name, "ZLS", this, isSuggestion, index == -1) + } + + is ListElem.Download -> { + icon = AllIcons.Actions.Download + append(ZLSBundle.message("settings.model.download.text")) + } + + is ListElem.FromDisk -> { + icon = AllIcons.General.OpenDisk + append(ZLSBundle.message("settings.model.from-disk.text")) + } + is ListElem.Pending -> { + icon = AllIcons.Empty + append(ZLSBundle.message("settings.model.loading.text"), SimpleTextAttributes.GRAYED_ATTRIBUTES) + } + is ListElem.None, null -> { + icon = AllIcons.General.BalloonError + append(ZLSBundle.message("settings.model.none.text"), SimpleTextAttributes.ERROR_ATTRIBUTES) + } + } + } + +} \ No newline at end of file diff --git a/lsp/src/main/resources/META-INF/zigbrains-lsp.xml b/lsp/src/main/resources/META-INF/zigbrains-lsp.xml index d07aaa59..888ca03b 100644 --- a/lsp/src/main/resources/META-INF/zigbrains-lsp.xml +++ b/lsp/src/main/resources/META-INF/zigbrains-lsp.xml @@ -49,6 +49,13 @@ + @@ -56,10 +63,10 @@ implementation="com.falsepattern.zigbrains.lsp.settings.ZLSSettingsConfigProvider" /> - diff --git a/lsp/src/main/resources/icons/zls.svg b/lsp/src/main/resources/icons/zls.svg new file mode 100644 index 00000000..5fbf01fb --- /dev/null +++ b/lsp/src/main/resources/icons/zls.svg @@ -0,0 +1,19 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/lsp/src/main/resources/zigbrains/lsp/Bundle.properties b/lsp/src/main/resources/zigbrains/lsp/Bundle.properties index 3b76263f..8a680305 100644 --- a/lsp/src/main/resources/zigbrains/lsp/Bundle.properties +++ b/lsp/src/main/resources/zigbrains/lsp/Bundle.properties @@ -1,8 +1,3 @@ -settings.group.title=ZLS Settings -settings.zls-path.label=Executable path -settings.zls-path.tooltip=Path to the ZLS Binary -settings.zls-path.browse.title=Path to the ZLS Binary -settings.zls-version.label=Detected ZLS version settings.zls-config-path.label=Config path settings.zls-config-path.tooltip=Leave empty to use built-in config generated from the settings below settings.zls-config-path.browse.title=Path to the Custom ZLS Config File (Optional) @@ -50,8 +45,6 @@ settings.build_runner_path.tooltip=Specify a custom build runner to resolve buil settings.global_cache_path.label=Global cache path settings.global_cache_path.tooltip=Path to a directory that will be used as zig's cache. Will default to `${KnownFolders.Cache}/zls`. notification.group.zigbrains-lsp=ZigBrains LSP Integration -notification.message.could-not-detect.content=Could not detect ZLS binary, please configure it -notification.message.zls-exe-path-invalid.content=ZLS executable path could not be parsed: {0} notification.message.zls-exe-not-exists.content=ZLS executable does not exist: {0} notification.message.zls-exe-not-executable.content=ZLS executable is not an executable file: {0} notification.message.zls-config-not-exists.content=ZLS config file does not exist: {0} @@ -61,8 +54,26 @@ notification.message.zls-config-autogen-failed.content=Failed to autogenerate ZL notification.banner.zls-not-running=Zig Language Server is not running. Check the [Language Servers] tool menu! notification.banner.zls-bad-config=Zig Language Server is misconfigured. Check [Settings | Languages \\& Frameworks | Zig]! progress.title.create-connection-provider=Creating ZLS connection provider -progress.title.validate=Validating ZLS # suppress inspection "UnusedProperty" lsp.zls.name=Zig Language Server # suppress inspection "UnusedProperty" lsp.zls.description=The Zig Language Server, via ZigBrains +settings.list.title=ZLS Instances +settings.list.empty=Select a ZLS version to view or edit its details here +settings.model.detected.separator=Detected ZLS versions +settings.model.none.text= +settings.model.loading.text=Loading\u2026 +settings.model.from-disk.text=Add ZLS from disk\u2026 +settings.model.download.text=Download ZLS\u2026 +settings.downloader.title=Install ZLS +settings.downloader.progress.fetch=Fetching ZLS version information +settings.downloader.progress.install=Installing ZLS {} +settings.downloader.service.index=ZLS version information +settings.local-selector.title=Select ZLS from disk +settings.local-selector.chooser.title=ZLS Binary +settings.local-selector.state.invalid=Invalid ZLS path +settings.local-selector.state.ok=ZLS path OK +dialog.title.zls=Path to the ZLS Executable +settings.panel.path.label=Path: +settings.panel.version.label=Version: +settings.panel.settings.group.label=Settings: \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index 0c52557a..7eb587d0 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,5 +1,5 @@ plugins { - id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" + id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0" } rootProject.name = "ZigBrains" diff --git a/src/art/zls/zls.svg b/src/art/zls/zls.svg new file mode 100644 index 00000000..893dff1f --- /dev/null +++ b/src/art/zls/zls.svg @@ -0,0 +1,19 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml index b25173d7..1656a8e0 100644 --- a/src/main/resources/META-INF/plugin.xml +++ b/src/main/resources/META-INF/plugin.xml @@ -4,7 +4,7 @@ FalsePattern com.intellij.modules.platform - com.redhat.devtools.lsp4ij + com.redhat.devtools.lsp4ij com.intellij.modules.cidr.debugger com.intellij.cidr.base com.intellij.clion @@ -17,13 +17,18 @@ dynamic="true" name="zlsConfigProvider" /> +