feat: add variable self reference

Author: xepozz

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpBraceMatcher.kt

@@ -1,12 +1,15 @@
 package com.github.xepozz.php_opcodes_language.language
 
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpTypes
 import com.intellij.lang.BracePair
 import com.intellij.lang.PairedBraceMatcher
 import com.intellij.psi.PsiFile
 import com.intellij.psi.tree.IElementType
 
 class PHPOpBraceMatcher : PairedBraceMatcher {
-    private val bracePairs = emptyArray<BracePair>()
+    private val bracePairs = arrayOf(
+        BracePair(PHPOpTypes.LPAREN, PHPOpTypes.RPAREN, true)
+    )
 
     override fun getPairs() = bracePairs
 

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.bnf

@@ -53,8 +53,18 @@ instruction_name ::= IDENTIFIER
 
 argument ::= expr
 
-expr ::= var_name | TEXT | NUMBER | IDENTIFIER paren_expr | IDENTIFIER
+expr ::= var_name | string_literal | NUMBER | IDENTIFIER paren_expr | IDENTIFIER
+
+string_literal ::= TEXT
+{
+    implements=["com.intellij.psi.PsiLanguageInjectionHost"]
+    extends="com.github.xepozz.php_opcodes_language.language.psi.impl.PHPOpStringLiteralBaseImpl"
+}
 
 paren_expr ::= LPAREN expr RPAREN
 
 var_name ::= DOLLAR_SIGN IDENTIFIER
+{
+  implements=["com.intellij.psi.NavigatablePsiElement" "com.intellij.psi.PsiNamedElement" "com.intellij.psi.PsiPolyVariantReference"]
+  extends="com.github.xepozz.php_opcodes_language.language.psi.impl.PHPOpVarNameBaseImpl"
+}

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/impl/PHPOpStringLiteralBaseImpl.kt

@@ -0,0 +1,25 @@
+package com.github.xepozz.php_opcodes_language.language.psi.impl
+
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpStringLiteral
+import com.intellij.icons.AllIcons
+import com.intellij.ide.projectView.PresentationData
+import com.intellij.lang.ASTNode
+import com.intellij.psi.LiteralTextEscaper
+import com.intellij.psi.PsiLanguageInjectionHost
+
+abstract class PHPOpStringLiteralBaseImpl : PHPOpStringLiteral, PHPOpElementImpl, PsiLanguageInjectionHost {
+    constructor(node: ASTNode) : super(node)
+
+    override fun getPresentation() = PresentationData(text, null, getIcon(0), null)
+
+    override fun getIcon(flags: Int) = AllIcons.Nodes.Property
+
+    override fun isValidHost() = true
+
+    override fun updateText(newText: String): PsiLanguageInjectionHost? {
+//        this.replace(PHPOpElementFactory.createStringLiteral(project, newText))
+        return this
+    }
+
+    override fun createLiteralTextEscaper() = LiteralTextEscaper.createSimple(this)
+}

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/impl/PHPOpVarNameBaseImpl.kt

@@ -0,0 +1,65 @@
+package com.github.xepozz.php_opcodes_language.language.psi.impl
+
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpBlock
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpTypes
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpVarName
+import com.intellij.icons.AllIcons
+import com.intellij.ide.projectView.PresentationData
+import com.intellij.lang.ASTNode
+import com.intellij.openapi.util.NlsSafe
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiElementResolveResult
+import com.intellij.psi.PsiNamedElement
+import com.intellij.psi.PsiPolyVariantReference
+import com.intellij.psi.search.LocalSearchScope
+import com.intellij.psi.search.SearchScope
+import com.jetbrains.php.lang.psi.PhpPsiUtil
+
+abstract class PHPOpVarNameBaseImpl : PHPOpVarName, PHPOpElementImpl, PsiNamedElement, PsiPolyVariantReference {
+    constructor(node: ASTNode) : super(node)
+
+    override fun getName(): String {
+        val keyNode = this.node.findChildByType(PHPOpTypes.IDENTIFIER)
+
+        return keyNode?.text ?: ""
+    }
+
+    override fun setName(name: @NlsSafe String): PsiElement? {
+        TODO("Not yet implemented")
+    }
+
+    override fun getPresentation() = PresentationData(text, null, getIcon(0), null)
+
+    override fun getIcon(flags: Int) = AllIcons.Nodes.Property
+
+    override fun getElement() = this
+
+    override fun getRangeInElement() = TextRange(0, textLength)
+
+    override fun resolve() = multiResolve(false).firstOrNull()?.element
+
+    override fun multiResolve(incompleteCode: Boolean) = PsiElementResolveResult.createResults(this)
+
+    override fun getCanonicalText(): String = text
+
+    override fun handleElementRename(newName: String) = this.setName(newName)
+
+    override fun bindToElement(element: PsiElement): PsiElement? {
+        throw UnsupportedOperationException("Method bindToElement is not yet implemented in " + this.javaClass.getName())
+    }
+
+    override fun isReferenceTo(psiElement: PsiElement): Boolean {
+        return when (psiElement) {
+            is PHPOpVarName -> this.text == psiElement.text
+            else -> false
+        }
+    }
+
+    override fun isSoft() = false
+
+    override fun getUseScope(): SearchScope {
+        val block = PhpPsiUtil.getParentOfClass(this, PHPOpBlock::class.java) ?: return super.getUseScope()
+        return LocalSearchScope(block)
+    }
+}

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/reference/PHPOpReferenceContributor.kt

@@ -0,0 +1,28 @@
+package com.github.xepozz.php_opcodes_language.language.reference
+
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpVarName
+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.util.ProcessingContext
+
+class PHPOpReferenceContributor : PsiReferenceContributor() {
+    override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
+        registrar.registerReferenceProvider(
+            PlatformPatterns.psiElement(PHPOpVarName::class.java),
+            object : PsiReferenceProvider() {
+                override fun getReferencesByElement(
+                    element: PsiElement,
+                    context: ProcessingContext
+                ): Array<out PsiReference?> {
+                    if (element !is PHPOpVarName) return PsiReference.EMPTY_ARRAY
+
+                    return arrayOf(element)
+                }
+            }
+        )
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -43,5 +43,9 @@
         <lang.foldingBuilder
                 language="PHP Opcodes"
                 implementationClass="com.github.xepozz.php_opcodes_language.language.PHPOpFoldingBuilder"/>
+
+        <psi.referenceContributor
+                language="PHP Opcodes"
+                implementation="com.github.xepozz.php_opcodes_language.language.reference.PHPOpReferenceContributor"/>
     </extensions>
 </idea-plugin>