feat: support container::invoke method, closing #26

Author: xepozz

src/main/kotlin/com/github/tempest/framework/TempestFrameworkClasses.kt

@@ -2,7 +2,10 @@ package com.github.tempest.framework
 
 object TempestFrameworkClasses {
     const val ConsoleCommand = "\\Tempest\\Console\\ConsoleCommand"
-    const val FUNCTION_URI = "\\Tempest\\uri"
+    const val CONTAINER = "\\Tempest\\Container\\Container"
+    const val CONTAINER_INVOKE = "\\Tempest\\Container\\Container::invoke"
+
+    const val FUNCTION_URI = "\\Tempest\\Router\\uri"
 
     const val ROUTER_GET = "\\Tempest\\Router\\Get"
     const val ROUTER_POST = "\\Tempest\\Router\\Post"

src/main/kotlin/com/github/tempest/framework/container/completion/ContainerCompletionContributor.kt

@@ -0,0 +1,63 @@
+package com.github.tempest.framework.container.completion
+
+import com.github.tempest.framework.container.references.ContainerParameterLookupElementBuilder
+import com.github.tempest.framework.container.references.ContainerPsiUtils
+import com.intellij.codeInsight.completion.CompletionContributor
+import com.intellij.codeInsight.completion.CompletionParameters
+import com.intellij.codeInsight.completion.CompletionProvider
+import com.intellij.codeInsight.completion.CompletionResultSet
+import com.intellij.codeInsight.completion.CompletionType
+import com.intellij.patterns.PlatformPatterns
+import com.intellij.util.ProcessingContext
+import com.jetbrains.php.lang.psi.elements.ConstantReference
+import com.jetbrains.php.lang.psi.elements.MethodReference
+import com.jetbrains.php.lang.psi.elements.ParameterList
+
+class ContainerCompletionContributor : CompletionContributor() {
+    init {
+        extend(
+            CompletionType.BASIC,
+            PlatformPatterns.psiElement()
+                .withParent(
+                    PlatformPatterns.or(
+                        PlatformPatterns.psiElement(ConstantReference::class.java)
+                            .withParent(PlatformPatterns.psiElement(ParameterList::class.java))
+                            .withSuperParent(
+                                2,
+                                PlatformPatterns.psiElement(MethodReference::class.java),
+                            ),
+                        PlatformPatterns.psiElement(ParameterList::class.java)
+                            .withParent(PlatformPatterns.psiElement(MethodReference::class.java)),
+                    )
+                ),
+            object : CompletionProvider<CompletionParameters>() {
+                override fun addCompletions(
+                    parameters: CompletionParameters,
+                    context: ProcessingContext,
+                    result: CompletionResultSet
+                ) {
+//                    println("container completion: ${parameters.position}")
+                    val element = when (parameters.position.parent) {
+                        is ConstantReference -> parameters.position.parent
+                        is ParameterList -> parameters.position
+                        else -> return
+                    }
+                    val parameterList = element.parent as? ParameterList ?: return
+                    val function = parameterList.parent as? MethodReference ?: return
+                    if (!ContainerPsiUtils.isInvokeMethod(function)) return
+                    if (parameterList.parameters.isEmpty()) return
+
+                    val firstParameter = function.parameters[0]
+                    if (firstParameter == element) return
+
+                    com.github.tempest.framework.container.references.ContainerResolveUtils
+                        .resolveCached(firstParameter)
+                        .flatMap { ContainerParameterLookupElementBuilder.create(it) }
+                        .apply { result.addAllElements(this) }
+                        .apply { if (isNotEmpty()) result.stopHere() }
+                }
+
+            }
+        )
+    }
+}

src/main/kotlin/com/github/tempest/framework/container/references/ContainerParameterLookupElementBuilder.kt

@@ -0,0 +1,32 @@
+package com.github.tempest.framework.container.references
+
+import com.github.tempest.framework.common.completion.TopPriorityLookupElement
+import com.github.tempest.framework.common.insertHandler.InsertTextInsertHandler
+import com.intellij.codeInsight.completion.DeclarativeInsertHandler
+import com.intellij.codeInsight.completion.PrioritizedLookupElement
+import com.intellij.codeInsight.lookup.LookupElementBuilder
+import com.jetbrains.php.PhpIcons
+import com.jetbrains.php.lang.PhpLangUtil
+import com.jetbrains.php.lang.psi.elements.Function
+
+object ContainerParameterLookupElementBuilder {
+    fun create(target: Function) = target
+        .parameters
+        .map { parameter ->
+            val methodFqn = PhpLangUtil.toPresentableFQN(target.fqn.replace('.', ':'))
+            LookupElementBuilder.create(parameter.name)
+                .withIcon(PhpIcons.PARAMETER)
+                .withTailText(" [$methodFqn]")
+                .withTypeText(parameter.text)
+                .withInsertHandler { context, element ->
+                    InsertTextInsertHandler(
+                        ": ",
+                        DeclarativeInsertHandler.PopupOptions.MemberLookup
+                    )
+                        .handleInsert(context, element)
+                }
+                .let { PrioritizedLookupElement.withPriority(it, 10000.0) }
+                .let { PrioritizedLookupElement.withExplicitProximity(it, 10000) }
+                .let { TopPriorityLookupElement(it) }
+        }
+}

src/main/kotlin/com/github/tempest/framework/container/references/ContainerParameterReference.kt

@@ -0,0 +1,33 @@
+package com.github.tempest.framework.container.references
+
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReferenceBase
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory
+
+class ContainerParameterReference(
+    val hostElement: PsiElement,
+    val routeReferenceElement: PsiElement,
+    val parameterName: String,
+    textRange: TextRange,
+) : PsiReferenceBase<PsiElement>(hostElement, textRange) {
+    override fun resolve() = ContainerResolveUtils
+        .resolveCached(routeReferenceElement)
+        .firstOrNull()
+        ?.getParameter(parameterName)
+
+    override fun getVariants() = ContainerResolveUtils
+        .resolveCached(routeReferenceElement)
+        .flatMap { ContainerParameterLookupElementBuilder.create(it) }
+        .toTypedArray()
+
+    override fun handleElementRename(newElementName: String): PsiElement? {
+        return hostElement.findElementAt(rangeInElement.startOffset)
+            ?.replace(
+                PhpPsiElementFactory.createNamedArgumentNameIdentifier(
+                    hostElement.project,
+                    newElementName,
+                )
+            )
+    }
+}

src/main/kotlin/com/github/tempest/framework/container/references/ContainerPsiUtils.kt

@@ -0,0 +1,12 @@
+package com.github.tempest.framework.container.references
+
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.intellij.psi.PsiElement
+import com.jetbrains.php.lang.psi.elements.MethodReference
+
+object ContainerPsiUtils {
+    fun isInvokeMethod(element: PsiElement): Boolean {
+        val element = element as? MethodReference ?: return false
+        return element.name == "invoke" && element.signature == "#M#C${TempestFrameworkClasses.CONTAINER}.invoke"
+    }
+}

src/main/kotlin/com/github/tempest/framework/container/references/ContainerReferenceContributor.kt

@@ -0,0 +1,55 @@
+package com.github.tempest.framework.container.references
+
+import com.intellij.patterns.PlatformPatterns
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceContributor
+import com.intellij.psi.PsiReferenceProvider
+import com.intellij.psi.PsiReferenceRegistrar
+import com.intellij.psi.tree.TokenSet
+import com.intellij.psi.util.startOffset
+import com.intellij.util.ProcessingContext
+import com.jetbrains.php.lang.lexer.PhpTokenTypes
+import com.jetbrains.php.lang.psi.elements.MethodReference
+import com.jetbrains.php.lang.psi.elements.ParameterList
+
+class ContainerReferenceContributor : PsiReferenceContributor() {
+    override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
+        registrar.registerReferenceProvider(
+            PlatformPatterns.psiElement(ParameterList::class.java)
+                .withParent(MethodReference::class.java),
+            object : PsiReferenceProvider() {
+                override fun getReferencesByElement(
+                    element: PsiElement,
+                    context: ProcessingContext
+                ): Array<out PsiReference> {
+                    val parameterList = element as? ParameterList ?: return emptyArray()
+                    val function = parameterList.parent as? MethodReference ?: return emptyArray()
+                    if (!ContainerPsiUtils.isInvokeMethod(function)) return emptyArray()
+                    if (parameterList.parameters.isEmpty()) return emptyArray()
+
+                    val firstParameter = function.parameters[0]
+                    if (firstParameter == element) return emptyArray()
+
+                    return parameterList
+                        .node
+                        .getChildren(IDENTIFIER_TOKENS)
+                        .map {
+                            ContainerParameterReference(
+                                element,
+                                firstParameter,
+                                it.text,
+                                it.textRange.shiftLeft(element.startOffset),
+                            )
+                        }
+                        .toTypedArray()
+//                        .apply { println("found references for ${function.name} ${this.joinToString { it.toString() }}") }
+                }
+            }
+        )
+    }
+
+    companion object {
+        val IDENTIFIER_TOKENS = TokenSet.create(PhpTokenTypes.IDENTIFIER)
+    }
+}

src/main/kotlin/com/github/tempest/framework/container/references/ContainerResolveUtils.kt

@@ -0,0 +1,32 @@
+package com.github.tempest.framework.container.references
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.util.CachedValueProvider
+import com.intellij.psi.util.CachedValuesManager
+import com.jetbrains.php.lang.PhpReferenceContributor
+import com.jetbrains.php.lang.psi.elements.ArrayCreationExpression
+import com.jetbrains.php.lang.psi.elements.Function
+
+object ContainerResolveUtils {
+    fun resolveCached(firstParameter: PsiElement): Collection<Function> =
+        CachedValuesManager.getCachedValue(firstParameter) {
+            CachedValueProvider.Result.create(
+                resolve(firstParameter),
+                firstParameter.containingFile,
+            )
+        }
+
+    fun resolve(firstParameter: PsiElement): Collection<Function> =
+        when (firstParameter) {
+            is ArrayCreationExpression -> fromArrayCreation(firstParameter)
+            else -> emptyList()
+        }
+
+
+    fun fromArrayCreation(firstParameter: ArrayCreationExpression) =
+        PhpReferenceContributor
+            .getCallbackRefFromArray(firstParameter)
+            ?.multiResolve(true)
+            ?.mapNotNull { it.element as? Function }
+            ?: emptyList()
+}

…/router/references/RouteElementLookup.kt …/references/RouteLookupElementBuilder.ktsrc/main/kotlin/com/github/tempest/framework/router/references/RouteElementLookup.kt renamed to src/main/kotlin/com/github/tempest/framework/router/references/RouteLookupElementBuilder.kt src/main/kotlin/com/github/tempest/framework/router/references/RouteElementLookup.kt renamed to src/main/kotlin/com/github/tempest/framework/router/references/RouteLookupElementBuilder.kt

@@ -44,6 +44,12 @@
         <completion.contributor
                 language="PHP"
                 implementationClass="com.github.tempest.framework.router.completion.RouteParameterCompletionContributor"/>
+        <completion.contributor
+                language="PHP"
+                implementationClass="com.github.tempest.framework.container.completion.ContainerCompletionContributor"/>
+        <psi.referenceContributor
+                language="PHP"
+                implementation="com.github.tempest.framework.container.references.ContainerReferenceContributor"/>
         <weigher
                 order="first"
                 implementationClass="com.github.tempest.framework.common.completion.CompletionWeighter"