feat: setup base classes for language support

xepozz · xepozz · commit 8d85260f9762 · 2025-07-04T20:13:23.000+03:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -133,6 +133,26 @@ kover {
 }
 
 tasks {
+    withType<KotlinCompile> {
+        dependsOn(generateParser)
+    }
+
+    generateLexer {
+        sourceFile.set(file("src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.flex"))
+        targetOutputDir.set(file("src/main/gen/com/github/xepozz/php_opcodes_language/language/parser"))
+        purgeOldFiles.set(true)
+    }
+
+    generateParser {
+        dependsOn(generateLexer)
+
+        sourceFile.set(file("src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.bnf"))
+        targetRootOutputDir.set(file("src/main/gen"))
+        pathToParser.set("/com/github/xepozz/php_opcodes_language/language/parser/PHPOpParser")
+        pathToPsiRoot.set("/com/github/xepozz/php_opcodes_language/language/psi")
+        purgeOldFiles.set(true)
+    }
+
     wrapper {
         gradleVersion = providers.gradleProperty("gradleVersion").get()
     }
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/PHPOpIcons.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/PHPOpIcons.kt
@@ -0,0 +1,9 @@
+package com.github.xepozz.php_opcodes_language
+
+import com.intellij.openapi.util.IconLoader
+import kotlin.jvm.java
+
+object PHPOpIcons {
+    @JvmStatic
+    val FILE = IconLoader.getIcon("/icons/php-op.svg", PHPOpIcons::class.java)
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpAnnotator.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpAnnotator.kt
@@ -0,0 +1,35 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.lang.annotation.AnnotationHolder
+import com.intellij.lang.annotation.Annotator
+import com.intellij.openapi.editor.DefaultLanguageHighlighterColors
+import com.intellij.openapi.editor.colors.TextAttributesKey
+import com.intellij.psi.PsiElement
+
+class PHPOpAnnotator : Annotator {
+    override fun annotate(element: PsiElement, holder: AnnotationHolder) {
+    }
+
+    companion object {
+        val PATTERN_HIGHLIGHT = TextAttributesKey.createTextAttributesKey(
+            "PHP_OPCODES_LANGUAGE_PATTERN",
+            DefaultLanguageHighlighterColors.STRING,
+        )
+        val REFERENCE_DECLARATION_HIGHLIGHT = TextAttributesKey.createTextAttributesKey(
+            "PHP_OPCODES_LANGUAGE_DIRECTIVE",
+            DefaultLanguageHighlighterColors.FUNCTION_DECLARATION,
+        )
+        val REFERENCE_USAGE_HIGHLIGHT = TextAttributesKey.createTextAttributesKey(
+            "PHP_OPCODES_LANGUAGE_ARGUMENT",
+            DefaultLanguageHighlighterColors.FUNCTION_CALL,
+        )
+        val BLOCK_NAME_HIGHLIGHT = TextAttributesKey.createTextAttributesKey(
+            "PHP_OPCODES_LANGUAGE_BLOCK_NAME",
+            DefaultLanguageHighlighterColors.CLASS_NAME,
+        )
+        private val IDENTIFIER_HIGHLIGHT = TextAttributesKey.createTextAttributesKey(
+            "PHP_OPCODES_LANGUAGE_IDENTIFIER",
+            DefaultLanguageHighlighterColors.KEYWORD,
+        )
+    }
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpBraceMatcher.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpBraceMatcher.kt
@@ -0,0 +1,23 @@
+package com.github.xepozz.php_opcodes_language.language
+
+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>()
+
+    override fun getPairs() = bracePairs
+
+    override fun isPairedBracesAllowedBeforeType(
+        p0: IElementType,
+        p1: IElementType?
+    ) = true
+
+    override fun getCodeConstructStart(
+        file: PsiFile,
+        openingBraceOffset: Int
+    ): Int = openingBraceOffset
+
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpCommenter.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpCommenter.kt
@@ -0,0 +1,15 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.lang.Commenter
+
+class PHPOpCommenter : Commenter {
+    override fun getLineCommentPrefix(): String = ";"
+
+    override fun getBlockCommentPrefix(): String? = null
+
+    override fun getBlockCommentSuffix(): String? = null
+
+    override fun getCommentedBlockCommentPrefix(): String? = null
+
+    override fun getCommentedBlockCommentSuffix(): String? = null
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFile.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFile.kt
@@ -0,0 +1,10 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.extapi.psi.PsiFileBase
+import com.intellij.psi.FileViewProvider
+
+class PHPOpFile(viewProvider: FileViewProvider) : PsiFileBase(viewProvider, PHPOpLanguage.INSTANCE) {
+    override fun getFileType() = PHPOpFileType.INSTANCE
+
+    override fun toString() = "PHP Opcodes File"
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFileType.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFileType.kt
@@ -0,0 +1,20 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.github.xepozz.php_opcodes_language.PHPOpIcons
+import com.intellij.openapi.fileTypes.LanguageFileType
+import java.io.Serializable
+
+class PHPOpFileType private constructor() : LanguageFileType(PHPOpLanguage.INSTANCE), Serializable {
+    override fun getName() = "PHP Opcodes"
+
+    override fun getDescription() = "PHP Opcodes language"
+
+    override fun getDefaultExtension() = ""
+
+    override fun getIcon() = PHPOpIcons.FILE
+
+    companion object {
+        @JvmStatic
+        val INSTANCE = PHPOpFileType()
+    }
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFoldingBuilder.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpFoldingBuilder.kt
@@ -0,0 +1,16 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.lang.ASTNode
+import com.intellij.lang.folding.FoldingBuilderEx
+import com.intellij.lang.folding.FoldingDescriptor
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.project.DumbAware
+import com.intellij.psi.PsiElement
+
+class PHPOpFoldingBuilder : FoldingBuilderEx(), DumbAware {
+    override fun buildFoldRegions(root: PsiElement, document: Document, quick: Boolean) = emptyArray<FoldingDescriptor>()
+
+    override fun getPlaceholderText(node: ASTNode) = "{ ... }"
+
+    override fun isCollapsedByDefault(node: ASTNode) = false
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpLanguage.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpLanguage.kt
@@ -0,0 +1,10 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.lang.Language
+
+class PHPOpLanguage : Language("PHP Opcodes") {
+    companion object {
+        @JvmStatic
+        val INSTANCE = PHPOpLanguage();
+    }
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpSyntaxHighlighter.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpSyntaxHighlighter.kt
@@ -0,0 +1,45 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.github.xepozz.php_opcodes_language.language.parser.PHPOpLexerAdapter
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpTypes
+import com.intellij.openapi.editor.DefaultLanguageHighlighterColors
+import com.intellij.openapi.editor.HighlighterColors
+import com.intellij.openapi.editor.colors.TextAttributesKey
+import com.intellij.openapi.fileTypes.SyntaxHighlighterBase
+import com.intellij.psi.TokenType
+import com.intellij.psi.tree.IElementType
+
+class PHPOpSyntaxHighlighter : SyntaxHighlighterBase() {
+    override fun getHighlightingLexer() = PHPOpLexerAdapter()
+
+    override fun getTokenHighlights(tokenType: IElementType) = when (tokenType) {
+        PHPOpTypes.NUMBER -> NUMBER_KEYS
+//        PHPOpTypes.TEXT -> TEXT_KEYS
+        PHPOpTypes.COMMENT -> COMMENT_KEYS
+        TokenType.BAD_CHARACTER -> BAD_CHAR_KEYS
+        else -> EMPTY_KEYS
+    }
+
+    companion object {
+        private val BAD_CHAR_KEYS = arrayOf(
+            HighlighterColors.BAD_CHARACTER,
+        )
+
+        private val COMMENT_KEYS = arrayOf(
+            DefaultLanguageHighlighterColors.DOC_COMMENT
+        )
+        private val TEXT_KEYS = arrayOf(
+            DefaultLanguageHighlighterColors.STRING
+        )
+        private val NUMBER_KEYS = arrayOf(
+            DefaultLanguageHighlighterColors.NUMBER
+        )
+        private val HEREDOC_MARKER_KEYS = arrayOf(
+            DefaultLanguageHighlighterColors.KEYWORD
+        )
+        private val HEREDOC_CONTENT_KEYS = arrayOf(
+            DefaultLanguageHighlighterColors.STRING
+        )
+        private val EMPTY_KEYS = emptyArray<TextAttributesKey>()
+    }
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpSyntaxHighlighterFactory.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpSyntaxHighlighterFactory.kt
@@ -0,0 +1,9 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.intellij.openapi.fileTypes.SyntaxHighlighterFactory
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+
+internal class PHPOpSyntaxHighlighterFactory : SyntaxHighlighterFactory() {
+    override fun getSyntaxHighlighter(project: Project?, virtualFile: VirtualFile?) = PHPOpSyntaxHighlighter()
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpDocumentationProvider.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpDocumentationProvider.kt
@@ -0,0 +1,15 @@
+package com.github.xepozz.php_opcodes_language.language.documentation
+
+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
+    }
+
+    override fun generateDoc(element: PsiElement?, originalElement: PsiElement?): String? {
+        return null
+    }
+}
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpcodeDoc.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/documentation/PHPOpcodeDoc.kt
@@ -0,0 +1,8 @@
+package com.github.xepozz.php_opcodes_language.language.documentation
+
+data class PHPOpcodeDoc(
+    val name: String,
+    val description: String,
+    val syntax: String? = null,
+    val examples: String? = null
+)
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.bnf b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.bnf
@@ -0,0 +1,36 @@
+{
+  parserClass="com.github.xepozz.php_opcodes_language.language.parser.PHPOpParser"
+  extends="com.intellij.extapi.psi.ASTWrapperPsiElement"
+
+  psiClassPrefix="PHPOp"
+  psiImplClassSuffix="Impl"
+  psiPackage="com.github.xepozz.php_opcodes_language.language.psi"
+  psiImplPackage="com.github.xepozz.php_opcodes_language.language.psi.impl"
+  psiImplUtilClass="com.github.xepozz.php_opcodes_language.language.psi.impl.PHPOpPsiImplUtil"
+
+  elementTypeHolderClass="com.github.xepozz.php_opcodes_language.language.psi.PHPOpTypes"
+  elementTypeClass="com.github.xepozz.php_opcodes_language.language.psi.PHPOpElementType"
+  tokenTypeClass="com.github.xepozz.php_opcodes_language.language.psi.PHPOpTokenType"
+
+  tokens = [
+    LBRACE = "LBRACE {"
+    RBRACE = "RBRACE }"
+    LPAREN = "LPAREN ("
+    RPAREN = "RPAREN )"
+    LBRACKET = "LBRACKET ["
+    RBRACKET = "RBRACKET ]"
+    COMMENT = "COMMENT"
+    EOL = "EOL"
+    SYMBOL = "SYMBOL"
+    IDENTIFIER = "IDENTIFIER"
+    NUMBER = "NUMBER"
+    TEXT = "TEXT"
+  ]
+}
+
+// Top level structure
+phpOpFile ::= item_*
+
+private item_ ::= internal
+
+internal ::= COMMENT | EOL
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.flex b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.flex
@@ -0,0 +1,84 @@
+/* PHPOp JFlex Lexer for Pattern-Based Parsing */
+
+package com.github.xepozz.php_opcodes_language.language.parser;
+
+import com.intellij.lexer.FlexLexer;
+import com.intellij.psi.tree.IElementType;
+import com.intellij.psi.TokenType;
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpTypes;
+import java.util.Stack;
+
+%%
+
+%class PHPOpLexer
+%implements FlexLexer
+%unicode
+%function advance
+%type IElementType
+%eof{  return;
+%eof}
+
+%state YYINITIAL
+%state IN_BLOCK
+
+// Common macros
+WHITESPACE = [ \t\f]
+NEWLINE = \r\n|\r|\n
+COMMENT = "#"[^\n]*
+
+// Identifier patterns
+IDENTIFIER = [a-zA-Z][a-zA-Z0-9_\-]*
+NUMBER = [0-9]+
+TEXT = [^\s{\}(\)\[\]<\>\|\#\'\`\-\+\?\@][^\s{\}(\)\[\]<\>]*
+SYMBOL = [\-\+\~\?\<\>\@]
+
+QUOTTED_STRING = "\""(\\\"|[^\"])*"\""
+BACKTICK_STRING = "`"(\\\`|[^\`])*"`"
+
+// Special symbols
+LBRACE = "{"
+RBRACE = "}"
+LPAREN = "("
+RPAREN = ")"
+LBRACKET = "["
+RBRACKET = "]"
+
+%{
+private Stack<Integer> stack = new Stack<>();
+
+public void yypushState(int newState) {
+  stack.push(yystate());
+  yybegin(newState);
+}
+
+public void yypopState() {
+  yybegin(stack.pop());
+}
+%}
+
+%%
+
+<YYINITIAL, IN_BLOCK> {
+{LBRACE}                                     { yypushState(IN_BLOCK); return PHPOpTypes.LBRACE; }
+{RBRACE}                                     { yypopState(); return PHPOpTypes.RBRACE; }
+
+// Special symbols
+{LPAREN}                                     { return PHPOpTypes.LPAREN; }
+{RPAREN}                                     { return PHPOpTypes.RPAREN; }
+{LBRACKET}                                   { return PHPOpTypes.LBRACKET; }
+{RBRACKET}                                   { return PHPOpTypes.RBRACKET; }
+
+// Common elements
+{IDENTIFIER}                                 { return PHPOpTypes.IDENTIFIER; }
+{NUMBER}                                     { return PHPOpTypes.NUMBER; }
+{SYMBOL}                                     { return PHPOpTypes.SYMBOL; }
+{TEXT}|{QUOTTED_STRING}|{BACKTICK_STRING}    { return PHPOpTypes.TEXT; }
+
+// Whitespace and comments
+{WHITESPACE}                                 { return TokenType.WHITE_SPACE; }
+{NEWLINE}                                    { return PHPOpTypes.EOL; }
+{COMMENT}                                    { return PHPOpTypes.COMMENT; }
+}
+
+// Catch any other character
+[^]                                            { return TokenType.BAD_CHARACTER; }
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOpLexerAdapter.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOpLexerAdapter.kt
@@ -0,0 +1,5 @@
+package com.github.xepozz.php_opcodes_language.language.parser
+
+import com.intellij.lexer.FlexAdapter
+
+class PHPOpLexerAdapter : FlexAdapter(PHPOpLexer(null))
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOpParserDefinition.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOpParserDefinition.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementFactory.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementFactory.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementManipulator.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementManipulator.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementType.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpElementType.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpTokenSets.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpTokenSets.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpTokenType.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpTokenType.kt
diff --git a/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/impl/PHPOpElementImpl.kt b/src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/impl/PHPOpElementImpl.kt
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
