initialize php lsp support

Author: xepozz

build.gradle.kts

@@ -43,10 +43,10 @@ dependencies {
         // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace.
         plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
 
-        instrumentationTools()
         pluginVerifier()
         zipSigner()
         testFramework(TestFrameworkType.Platform)
+//        intellijIdeaUltimate("2024.3.1.1")
     }
 }
 

gradle.properties

@@ -8,11 +8,11 @@ pluginVersion = 0.0.1
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 233
-pluginUntilBuild = 242.*
+pluginUntilBuild = 243.*
 
 # IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
-platformType = IC
-platformVersion = 2023.3.8
+platformType = IU
+platformVersion = 2024.3.1.1
 
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP

gradle/libs.versions.toml

@@ -4,10 +4,10 @@ junit = "4.13.2"
 
 # plugins
 changelog = "2.2.1"
-intelliJPlatform = "2.1.0"
-kotlin = "1.9.25"
-kover = "0.8.3"
-qodana = "2024.2.3"
+intelliJPlatform = "2.2.1"
+kotlin = "2.1.0"
+kover = "0.9.1"
+qodana = "2024.3.4"
 
 [libraries]
 junit = { group = "junit", name = "junit", version.ref = "junit" }

src/main/kotlin/com/github/xepozz/phplsp/LspServiceSettings.kt

@@ -0,0 +1,76 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package com.github.xepozz.phplsp
+
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.components.*
+import com.intellij.openapi.project.Project
+import com.intellij.platform.lsp.api.LspServerManager
+
+@Service(Service.Level.PROJECT)
+@State(name = "PrismaServiceSettings", storages = [Storage(StoragePathMacros.WORKSPACE_FILE)])
+class LspServiceSettings(val project: Project) :
+    SimplePersistentStateComponent<LspServiceState>(LspServiceState()) {
+    var serviceMode
+        get() = state.serviceMode
+        set(value) {
+            val changed = state.serviceMode != value
+            state.serviceMode = value
+            if (changed) {
+                restartPhpLspServerAsync(project)
+            }
+        }
+
+    var port
+        get() = state.port
+        set(value) {
+            val changed = state.port != value
+            state.port = value
+            if (changed) {
+                restartPhpLspServerAsync(project)
+            }
+        }
+
+    var command
+        get() = state.command ?: ""
+        set(value) {
+            val changed = state.command != value
+            state.command = value
+            if (changed) {
+                restartPhpLspServerAsync(project)
+            }
+        }
+
+    var binary
+        get() = state.binary ?: ""
+        set(value) {
+            val changed = state.binary != value
+            state.binary = value
+            if (changed) {
+                restartPhpLspServerAsync(project)
+            }
+        }
+
+    companion object {
+        fun getInstance(project: Project) = project.service<LspServiceSettings>()
+    }
+}
+
+class LspServiceState : BaseState() {
+    var serviceMode by enum(LspServiceMode.ENABLED)
+    var binary by string("/bin/lsp")
+    var command by string("serve App\\\\Application --port=%d")
+    var port by property(5007)
+}
+
+enum class LspServiceMode {
+    ENABLED,
+    DISABLED
+}
+
+fun restartPhpLspServerAsync(project: Project) {
+    ApplicationManager.getApplication().invokeLater({
+        val lspServerManager = LspServerManager.getInstance(project)
+
+        lspServerManager.stopAndRestartIfNeeded(PhpLspServerSupportProvider::class.java)
+    }, project.disposed)
+}

src/main/kotlin/com/github/xepozz/phplsp/PhpLspServerDescriptor.kt

@@ -0,0 +1,53 @@
+package com.github.xepozz.phplsp
+
+import com.intellij.execution.configurations.GeneralCommandLine
+import com.intellij.execution.process.OSProcessHandler
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.platform.lsp.api.LspCommunicationChannel
+import com.intellij.platform.lsp.api.ProjectWideLspServerDescriptor
+import com.intellij.util.io.BaseDataReader
+import com.intellij.util.io.BaseOutputReader
+import com.intellij.util.io.BaseOutputReader.Options.forMostlySilentProcess
+
+class PhpLspServerDescriptor(project: Project) : ProjectWideLspServerDescriptor(project, "PHP Language") {
+    val settings = LspServiceSettings.getInstance(project)
+
+    override fun isSupportedFile(file: VirtualFile) =
+        settings.serviceMode == LspServiceMode.ENABLED && file.extension == "php"
+
+    override val lspDocumentColorSupport = super.lspDocumentColorSupport
+    override val lspCodeActionsSupport = super.lspCodeActionsSupport
+    override val lspCommandsSupport = super.lspCommandsSupport
+    override val lspDiagnosticsSupport = super.lspDiagnosticsSupport
+    override val lspFindReferencesSupport = super.lspFindReferencesSupport
+    override val lspFormattingSupport = super.lspFormattingSupport
+
+    override val lspSemanticTokensSupport = super.lspSemanticTokensSupport
+    override val lspGoToDefinitionSupport = true
+    override val lspGoToTypeDefinitionSupport = true
+    override val lspCompletionSupport = super.lspCompletionSupport
+    override val lspHoverSupport = true
+
+    override val lspCommunicationChannel = LspCommunicationChannel.Socket(settings.port, false)
+
+    override fun startServerProcess(): OSProcessHandler {
+//        Thread.sleep(1)
+        val startingCommandLine = createCommandLine().withCharset(Charsets.UTF_8)
+//        LOG.info("$this: starting LSP server: $startingCommandLine")
+        return object : OSProcessHandler(startingCommandLine) {
+            override fun readerOptions(): BaseOutputReader.Options = object : BaseOutputReader.Options() {
+                override fun policy(): BaseDataReader.SleepingPolicy = BaseDataReader.SleepingPolicy.BLOCKING
+
+                // Must not loose '\r' in "\r\n" line endings. They affect char count, which must match `Content-Length`
+                override fun splitToLines(): Boolean = true
+            }
+        }
+    }
+    override fun createCommandLine() = GeneralCommandLine(
+        settings.binary,
+        "serve",
+        "App\\Application",
+        "--port=%d".format(settings.port),
+    )
+}

src/main/kotlin/com/github/xepozz/phplsp/PhpLspServerSupportProvider.kt

@@ -0,0 +1,32 @@
+package com.github.xepozz.phplsp
+
+import com.intellij.execution.configurations.GeneralCommandLine
+import com.intellij.execution.process.OSProcessHandler
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.platform.lsp.api.LspCommunicationChannel
+import com.intellij.platform.lsp.api.LspServer
+import com.intellij.platform.lsp.api.LspServerSupportProvider
+import com.intellij.platform.lsp.api.LspServerSupportProvider.LspServerStarter
+import com.intellij.platform.lsp.api.ProjectWideLspServerDescriptor
+import com.intellij.platform.lsp.api.lsWidget.LspServerWidgetItem
+
+internal class PhpLspServerSupportProvider : LspServerSupportProvider {
+    override fun fileOpened(project: Project, file: VirtualFile, serverStarter: LspServerStarter) {
+        if (file.extension == "php") {
+            serverStarter.ensureServerStarted(PhpLspServerDescriptor(project))
+        }
+    }
+
+    override fun createLspServerWidgetItem(
+        lspServer: LspServer,
+        currentFile: VirtualFile?
+    ) = LspServerWidgetItem(
+        lspServer,
+        currentFile,
+        AllIcons.Language.Php,
+        PhpLspSettingsConfigurable::class.java,
+    )
+}
+

src/main/kotlin/com/github/xepozz/phplsp/PhpLspSettingsConfigurable.kt

@@ -0,0 +1,50 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package com.github.xepozz.phplsp
+
+import com.intellij.openapi.options.Configurable
+import com.intellij.openapi.options.UiDslUnnamedConfigurable
+import com.intellij.openapi.project.Project
+import com.intellij.ui.dsl.builder.Panel
+import com.intellij.ui.dsl.builder.bind
+import com.intellij.ui.dsl.builder.bindIntText
+import com.intellij.ui.dsl.builder.bindText
+
+class PhpLspSettingsConfigurable(project: Project) : UiDslUnnamedConfigurable.Simple(), Configurable {
+    private val settings = LspServiceSettings.getInstance(project)
+
+    override fun Panel.createContent() {
+        group("Language Server Configuration") {
+            buttonsGroup {
+                row {
+                    radioButton("Enabled", LspServiceMode.ENABLED)
+                }
+                row {
+                    radioButton("Disabled", LspServiceMode.DISABLED)
+                }
+            }.apply {
+                bind(settings::serviceMode)
+            }
+
+            separator()
+
+            row {
+                textFieldWithBrowseButton()
+                    .label("Binary")
+                    .bindText(settings::binary)
+            }
+//            row {
+//                textField()
+//                    .label("Command")
+//                    .bindText(settings::command)
+//            }
+            row {
+                textField()
+                    .label("Port")
+                    .bindIntText(settings::port)
+            }
+
+        }
+    }
+
+    override fun getDisplayName() = MyBundle.message("settings.configurable.title")
+}