feat: add documentation provider for opcodes

Author: xepozz

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

@@ -1,6 +1,5 @@
 package com.github.xepozz.php_opcodes_language.language
 
-import com.github.xepozz.php_opcodes_language.language.psi.PHPOpInstructionName
 import com.github.xepozz.php_opcodes_language.language.psi.PHPOpParameter
 import com.github.xepozz.php_opcodes_language.language.psi.PHPOpVarName
 import com.intellij.lang.annotation.AnnotationHolder
@@ -20,18 +19,9 @@ class PHPOpAnnotator : Annotator {
                     .create()
             }
             is PHPOpParameter -> {
-                if (element.text.matches(Regex("[TV]\\d+"))) {
-                    holder.newSilentAnnotation(HighlightSeverity.INFORMATION)
-                        .range(element)
-                        .textAttributes(PhpHighlightingData.VAR)
-                        .create()
-                }
-            }
-
-            is PHPOpInstructionName -> {
                 holder.newSilentAnnotation(HighlightSeverity.INFORMATION)
                     .range(element)
-                    .textAttributes(PhpHighlightingData.FUNCTION_CALL)
+                    .textAttributes(if (element.isVariable) PhpHighlightingData.VAR else PhpHighlightingData.FUNCTION_CALL)
                     .create()
             }
         }

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/OpcodesDictionary.kt

@@ -0,0 +1,39 @@
+package com.github.xepozz.php_opcodes_language.language.documentation
+
+/**
+ * @example https://phpdoctest.github.io/en/internals2.opcodes.list.html
+ */
+object OpcodesDictionary {
+    private val directives = listOf(
+        ParameterDoc(
+            name = "ADD",
+            number = 1,
+            description = """Adds "value1" to "value2" and stores the result into "result"""",
+            // language=injectablephp
+            example_php = $$"""
+                <?php
+
+                $a = 1;
+                $b = 2;
+                $c = $a + $b;
+            """.trimIndent(),
+            // language="PHP Opcodes"
+            example_opcode = $$"""
+                $_main:
+                
+                0000 EXT_STMT
+                0001 ASSIGN CV0($a) int(1)
+                0002 EXT_STMT
+                0003 ASSIGN CV1($b) int(2)
+                0004 EXT_STMT
+                0005 T5 = ADD CV0($a) CV1($b)
+                0006 ASSIGN CV2($c) T5
+                0007 RETURN int(1)
+            """.trimIndent(),
+        ),
+    ).associateBy { it.name }
+
+    fun getDocumentation(directiveName: String): ParameterDoc? {
+        return directives[directiveName]
+    }
+}

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpDocumentationProvider.kt

@@ -1,15 +1,49 @@
 package com.github.xepozz.php_opcodes_language.language.documentation
 
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpParameter
 import com.intellij.lang.documentation.AbstractDocumentationProvider
 import com.intellij.markdown.utils.lang.CodeBlockHtmlSyntaxHighlighter
 import com.intellij.psi.PsiElement
 
 class PHPOpDocumentationProvider : AbstractDocumentationProvider() {
     override fun getQuickNavigateInfo(element: PsiElement?, originalElement: PsiElement?): String? {
-        return null
+        if (element !is PHPOpParameter) return null
+
+        print("element doc $element, ${element.text}")
+        val directiveName = element.text!!
+        val doc = OpcodesDictionary.getDocumentation(directiveName) ?: return null
+
+        return doc.description
     }
 
     override fun generateDoc(element: PsiElement?, originalElement: PsiElement?): String? {
-        return null
+        if (element !is PHPOpParameter) return null
+
+        val directiveName = element.text!!
+        val doc = OpcodesDictionary.getDocumentation(directiveName) ?: return null
+        val highlighter = CodeBlockHtmlSyntaxHighlighter(element.project)
+
+        return buildString {
+            append("<div class='definition'><pre>")
+            append(doc.name)
+            append("</pre></div>")
+
+            append("<div class='content'>")
+            append("<p>${doc.description}}</p>")
+
+            if (doc.example_php != null) {
+                append("<h3>Example PHP</h3>")
+                append("<pre>${highlighter.color("InjectablePHP", doc.example_php)}</pre>")
+            }
+
+            if (doc.example_opcode != null) {
+                append("<h3>Example Opcodes</h3>")
+                append("<pre>")
+                append("<pre>${highlighter.color("PHP Opcodes", doc.example_opcode)}</pre>")
+                append("</pre>")
+            }
+
+            append("</div>")
+        }
     }
 }

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpcodeDoc.kt

@@ -1,8 +1,9 @@
 package com.github.xepozz.php_opcodes_language.language.documentation
 
-data class PHPOpcodeDoc(
+data class ParameterDoc(
     val name: String,
+    val number: Int,
     val description: String,
-    val syntax: String? = null,
-    val examples: String? = null
+    val example_php: String? = null,
+    val example_opcode: String? = null
 )

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

@@ -39,8 +39,7 @@ statements ::= (statement | COMMENT | EOL)+
 statement ::= NUMBER (assignment_instruction | instruction) | live_range
 
 assignment_instruction ::= parameter EQUALS_SIGN instruction
-instruction ::= instruction_name argument*
-instruction_name ::= IDENTIFIER
+instruction ::= parameter argument*
 
 argument ::= expr | paren_expr
 private expr ::= var_name | string_literal | NUMBER | paren_parameter | parameter | EQUALS_SIGN
@@ -55,6 +54,7 @@ parameter ::= IDENTIFIER
 {
     implements=["com.intellij.psi.NavigatablePsiElement" "com.intellij.psi.PsiNamedElement" "com.intellij.psi.PsiPolyVariantReference"]
     extends="com.github.xepozz.php_opcodes_language.language.psi.impl.PHPOpParameterBaseImpl"
+    methods=[isVariable]
 }
 
 string_literal ::= TEXT

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

@@ -42,10 +42,11 @@ abstract class PHPOpParameterBaseImpl : PHPOpParameter, PHPOpElementImpl {
         throw UnsupportedOperationException("Method bindToElement is not yet implemented in " + this.javaClass.getName())
     }
 
-    override fun isReferenceTo(psiElement: PsiElement): Boolean {
-        return when (psiElement) {
-            is PHPOpParameter -> this.text == psiElement.text
-            else -> false
+    override fun isReferenceTo(psiElement: PsiElement) = when (psiElement) {
+        !is PHPOpParameter -> false
+        else -> when (true) {
+            !psiElement.isVariable -> false
+            else -> this.text == psiElement.text
         }
     }
 

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

@@ -0,0 +1,10 @@
+package com.github.xepozz.php_opcodes_language.language.psi.impl
+
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpParameter
+
+class PHPOpPsiImplUtil {
+    companion object {
+        @JvmStatic
+        fun isVariable(element: PHPOpParameter): Boolean = element.text.startsWith("$")
+    }
+}