WIP: added support for generics

build.gradle

@@ -1,8 +1,8 @@
 plugins {
     id 'java'
     id 'idea'
-    id 'org.jetbrains.intellij' version '1.5.3'     // https://github.com/JetBrains/gradle-intellij-plugin
-    id 'org.jetbrains.kotlin.jvm' version '1.6.10'   // https://plugins.gradle.org/plugin/org.jetbrains.kotlin.jvm
+    id 'org.jetbrains.intellij' version '1.6.0'     // https://github.com/JetBrains/gradle-intellij-plugin
+    id 'org.jetbrains.kotlin.jvm' version "1.7.0-RC"   // https://plugins.gradle.org/plugin/org.jetbrains.kotlin.jvm
 }
 
 group 'com.vk'
@@ -15,8 +15,12 @@ repositories {
         url 'https://www.jetbrains.com/intellij-repository/snapshots'
     }
 }
+
 dependencies {
-    testImplementation group: 'junit', name: 'junit', version: '4.13.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
+    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.8.2'
+    testCompileOnly 'junit:junit:4.13.2'
 }
 
 idea {
@@ -30,26 +34,45 @@ idea {
     }
 }
 
+compileKotlin {
+    sourceCompatibility = 11
+    targetCompatibility = 11
+}
+
+tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
+    kotlinOptions {
+        freeCompilerArgs += '-Xjvm-default=all'
+        jvmTarget = '11'
+    }
+}
+
+wrapper {
+    gradleVersion = "7.4"
+}
+
 intellij {
     type = 'IU'
     // for release versions: https://www.jetbrains.com/intellij-repository/releases (com.jetbrains.intellij.idea)
     // for EAPs: https://www.jetbrains.com/intellij-repository/snapshots
-    version = '2022.1'
+    version = '222.2964-EAP-CANDIDATE-SNAPSHOT'
+//    version = '2022.1.1'
+//    version = '2021.3.1'
     plugins = [
-        'com.jetbrains.php:221.5080.224', // https://plugins.jetbrains.com/plugin/6610-php/versions
+            'com.jetbrains.php:222.2964.55', // https://plugins.jetbrains.com/plugin/6610-php/versions
+//        'com.jetbrains.php:221.5591.58',
+//        'com.jetbrains.php:213.5744.223'
     ]
 }
 runIde {
-    ideDir.set(file("/Users/alexandr.kirsanov/Library/Application Support/JetBrains/Toolbox/apps/PhpStorm/ch-0/213.5744.279/PhpStorm.app/Contents"))
+//    ideDir.set(file("/Users/alexandr.kirsanov/Library/Application Support/JetBrains/Toolbox/apps/PhpStorm/ch-0/213.5744.279/PhpStorm.app/Contents"))
 }
 
 patchPluginXml {
     // see https://github.com/JetBrains/gradle-intellij-plugin#patching-dsl
     // <change-notes> is only for LATEST version and should be updated on every version bump
     changeNotes = """
 <ul>
-  <li>support ffi_scope and ffi_cdata in phpdoc</li>
-  <li>track calls to 'end()' and 'reset()', suggesting replacing them</li>
+  <li>adapt code for 2022.2</li>
 </ul>
 """
 }
@@ -65,6 +88,8 @@ sourceSets {
     }
 }
 test {
+    useJUnitPlatform()
+
     exclude 'com/vk/kphpstorm/testing/infrastructure/**'
     include "**/*Test.class"
     scanForTestClasses false

src/main/kotlin/com/vk/kphpstorm/KphpStormASTFactory.kt

@@ -0,0 +1,16 @@
+package com.vk.kphpstorm
+
+import com.intellij.lang.DefaultASTFactoryImpl
+import com.intellij.psi.impl.source.tree.LeafElement
+import com.intellij.psi.tree.IElementType
+import com.vk.kphpstorm.generics.psi.GenericInstantiationPsiCommentImpl
+
+class KphpStormASTFactory : DefaultASTFactoryImpl() {
+    override fun createComment(type: IElementType, text: CharSequence): LeafElement {
+        if (text.startsWith("/*<") && text.endsWith(">*/")) {
+            return GenericInstantiationPsiCommentImpl(type, text)
+        }
+
+        return super.createComment(type, text)
+    }
+}

src/main/kotlin/com/vk/kphpstorm/KphpStormParserDefinition.kt

@@ -1,11 +1,23 @@
 package com.vk.kphpstorm
 
 import com.intellij.lang.ASTNode
+import com.intellij.lang.injection.MultiHostInjector
+import com.intellij.lang.injection.MultiHostRegistrar
+import com.intellij.openapi.util.TextRange
 import com.intellij.psi.PsiElement
+import com.intellij.psi.impl.source.tree.PsiCommentImpl
+import com.intellij.psi.util.parentOfType
+import com.jetbrains.php.lang.PhpLanguage
 import com.jetbrains.php.lang.documentation.phpdoc.parser.tags.PhpDocTagParserRegistry
 import com.jetbrains.php.lang.parser.PhpParserDefinition
 import com.jetbrains.php.lang.parser.PhpPsiElementCreator
+import com.jetbrains.php.lang.psi.PhpFile
+import com.jetbrains.php.lang.psi.elements.Function
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import com.jetbrains.php.lang.psi.elements.PhpUse
 import com.vk.kphpstorm.exphptype.psi.*
+import com.vk.kphpstorm.generics.GenericUtil.genericNames
+import com.vk.kphpstorm.generics.psi.GenericInstantiationPsiCommentImpl
 import com.vk.kphpstorm.kphptags.ALL_KPHPDOC_TAGS
 import com.vk.kphpstorm.kphptags.psi.*
 
@@ -30,25 +42,28 @@ class KphpStormParserDefinition() : PhpParserDefinition() {
      */
     override fun createElement(node: ASTNode): PsiElement {
         return when (node.elementType) {
-            KphpDocElementTypes.kphpDocTagSimple          -> KphpDocTagSimplePsiImpl(node)
-            KphpDocElementTypes.kphpDocTagTemplateClass   -> KphpDocTagTemplateClassPsiImpl(node)
-            KphpDocTplParameterDeclPsiImpl.elementType    -> KphpDocTplParameterDeclPsiImpl(node)
-            KphpDocElementTypes.kphpDocTagWarnPerformance -> KphpDocTagWarnPerformancePsiImpl(node)
-            KphpDocWarnPerformanceItemPsiImpl.elementType -> KphpDocWarnPerformanceItemPsiImpl(node)
-
-            ExPhpTypePrimitivePsiImpl.elementType        -> ExPhpTypePrimitivePsiImpl(node)
-            ExPhpTypeInstancePsiImpl.elementType         -> ExPhpTypeInstancePsiImpl(node)
-            ExPhpTypePipePsiImpl.elementType             -> ExPhpTypePipePsiImpl(node)
-            ExPhpTypeAnyPsiImpl.elementType              -> ExPhpTypeAnyPsiImpl(node)
-            ExPhpTypeArrayPsiImpl.elementType            -> ExPhpTypeArrayPsiImpl(node)
-            ExPhpTypeTuplePsiImpl.elementType            -> ExPhpTypeTuplePsiImpl(node)
-            ExPhpTypeShapePsiImpl.elementType            -> ExPhpTypeShapePsiImpl(node)
-            ExPhpTypeNullablePsiImpl.elementType         -> ExPhpTypeNullablePsiImpl(node)
-            ExPhpTypeTplInstantiationPsiImpl.elementType -> ExPhpTypeTplInstantiationPsiImpl(node)
-            ExPhpTypeCallablePsiImpl.elementType         -> ExPhpTypeCallablePsiImpl(node)
-            ExPhpTypeForcingPsiImpl.elementType          -> ExPhpTypeForcingPsiImpl(node)
-
-            else                                         -> PhpPsiElementCreator.create(node)
+            KphpDocElementTypes.kphpDocTagSimple           -> KphpDocTagSimplePsiImpl(node)
+            KphpDocElementTypes.kphpDocTagGeneric          -> KphpDocTagGenericPsiImpl(node)
+            KphpDocGenericParameterDeclPsiImpl.elementType -> KphpDocGenericParameterDeclPsiImpl(node)
+            KphpDocInheritParameterDeclPsiImpl.elementType -> KphpDocInheritParameterDeclPsiImpl(node)
+            KphpDocElementTypes.kphpDocTagInherit          -> KphpDocTagInheritPsiImpl(node)
+            KphpDocElementTypes.kphpDocTagWarnPerformance  -> KphpDocTagWarnPerformancePsiImpl(node)
+            KphpDocWarnPerformanceItemPsiImpl.elementType  -> KphpDocWarnPerformanceItemPsiImpl(node)
+
+            ExPhpTypePrimitivePsiImpl.elementType          -> ExPhpTypePrimitivePsiImpl(node)
+            ExPhpTypeInstancePsiImpl.elementType           -> ExPhpTypeInstancePsiImpl(node)
+            ExPhpTypePipePsiImpl.elementType               -> ExPhpTypePipePsiImpl(node)
+            ExPhpTypeAnyPsiImpl.elementType                -> ExPhpTypeAnyPsiImpl(node)
+            ExPhpTypeArrayPsiImpl.elementType              -> ExPhpTypeArrayPsiImpl(node)
+            ExPhpTypeTuplePsiImpl.elementType              -> ExPhpTypeTuplePsiImpl(node)
+            ExPhpTypeShapePsiImpl.elementType              -> ExPhpTypeShapePsiImpl(node)
+            ExPhpTypeNullablePsiImpl.elementType           -> ExPhpTypeNullablePsiImpl(node)
+            ExPhpTypeTplInstantiationPsiImpl.elementType   -> ExPhpTypeTplInstantiationPsiImpl(node)
+            ExPhpTypeCallablePsiImpl.elementType           -> ExPhpTypeCallablePsiImpl(node)
+            ExPhpTypeClassStringPsiImpl.elementType        -> ExPhpTypeClassStringPsiImpl(node)
+            ExPhpTypeForcingPsiImpl.elementType            -> ExPhpTypeForcingPsiImpl(node)
+
+            else -> PhpPsiElementCreator.create(node)
         }
     }
 }
@@ -58,3 +73,35 @@ class KphpStormParserDefinition() : PhpParserDefinition() {
  * This has no sense but correct plugin.xml validity while development
  */
 class FakePhpLanguage : com.intellij.lang.Language("PHP")
+
+class GenericsInstantiationInjector : MultiHostInjector {
+    override fun getLanguagesToInject(registrar: MultiHostRegistrar, context: PsiElement) {
+        if (context is GenericInstantiationPsiCommentImpl) {
+            val file = context.containingFile as? PhpFile ?: return
+
+            val namespace = file.mainNamespaceName?.trim('\\') ?: ""
+            val usesText = file.topLevelDefs.values().filterIsInstance<PhpUse>().joinToString("\n") { it.parent.text }
+
+            val parentFunctionGenericT = context.parentOfType<Function>()?.genericNames() ?: emptyList()
+            val parentClassGenericT = context.parentOfType<PhpClass>()?.genericNames() ?: emptyList()
+            val genericT = (parentFunctionGenericT + parentClassGenericT).joinToString(", ") { it.name }
+
+            val start = context.startOffset - context.textOffset
+            val range = TextRange(start + 3, start + context.textLength - 3)
+            registrar.startInjecting(PhpLanguage.INSTANCE)
+                .addPlace(
+                    """<?php
+namespace $namespace;
+
+$usesText
+
+/**
+ * @kphp-generic $genericT
+ * @var tuple(""", ") \$_*/\$_;", context, range
+                )
+                .doneInjecting()
+        }
+    }
+
+    override fun elementsToInjectIn() = listOf(PsiCommentImpl::class.java)
+}

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpType.kt

@@ -48,7 +48,7 @@ interface ExPhpType {
     fun toPhpType(): PhpType
     fun toHumanReadable(expr: PhpPsiElement): String
     fun getSubkeyByIndex(indexKey: String): ExPhpType?
-    fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType
+    fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType
     fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean
 
     companion object {

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeAny.kt

@@ -31,7 +31,7 @@ class ExPhpTypeAny : ExPhpType {
         return this
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
         return this
     }
 

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeArray.kt

@@ -23,8 +23,8 @@ class ExPhpTypeArray(val inner: ExPhpType) : ExPhpType {
         return inner
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
-        return ExPhpTypeArray(inner.instantiateTemplate(nameMap))
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return ExPhpTypeArray(inner.instantiateGeneric(nameMap))
     }
 
     override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean {

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeCallable.kt

@@ -21,13 +21,15 @@ class ExPhpTypeCallable(val argTypes: List<ExPhpType>, val returnType: ExPhpType
         return null
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
-        return ExPhpTypeCallable(argTypes.map { it.instantiateTemplate(nameMap) }, returnType?.instantiateTemplate(nameMap))
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return ExPhpTypeCallable(argTypes.map { it.instantiateGeneric(nameMap) }, returnType?.instantiateGeneric(nameMap))
     }
 
     override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean = when (rhs) {
         is ExPhpTypeAny      -> true
+        // TODO: добавить полноценную проверку?
         is ExPhpTypeCallable -> true
+        is ExPhpTypePrimitive -> rhs == ExPhpType.CALLABLE || rhs == ExPhpType.STRING
         is ExPhpTypeNullable -> isAssignableFrom(rhs.inner, project)
         else                 -> false
     }

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeClassString.kt

@@ -0,0 +1,45 @@
+package com.vk.kphpstorm.exphptype
+
+import com.intellij.openapi.project.Project
+import com.jetbrains.php.lang.psi.elements.PhpPsiElement
+import com.jetbrains.php.lang.psi.resolve.types.PhpType
+
+/**
+ * Type of special class constant (e.g. `Foo::class`).
+ */
+class ExPhpTypeClassString(val inner: ExPhpType) : ExPhpType {
+    override fun toString() = "class-string($inner)"
+
+    override fun toHumanReadable(expr: PhpPsiElement) = "class-string($inner)"
+
+    override fun equals(other: Any?) = other is ExPhpTypeClassString && inner == other.inner
+
+    override fun hashCode() = 35
+
+    override fun toPhpType() = PhpType().add("class-string(${inner.toPhpType()})")
+
+    override fun getSubkeyByIndex(indexKey: String) = this
+
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        // TODO: подумать тут
+        val fqn = when (inner) {
+            is ExPhpTypeInstance -> inner.fqn
+            is ExPhpTypeGenericsT -> inner.nameT
+            else -> ""
+        }
+
+        val name = nameMap[fqn] ?: return this
+        if (name is ExPhpTypeGenericsT) {
+            return ExPhpTypeClassString(ExPhpTypeGenericsT(name.toString()))
+        }
+
+        return ExPhpTypeClassString(ExPhpTypeInstance(name.toString()))
+    }
+
+    override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean = when (rhs) {
+        // class-string<T> is only compatible with class-string<E>
+        // if class E is compatible with class T.
+        is ExPhpTypeClassString -> inner.isAssignableFrom(rhs.inner, project)
+        else                    -> false
+    }
+}

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeForcing.kt

@@ -27,8 +27,8 @@ class ExPhpTypeForcing(val inner: ExPhpType) : ExPhpType {
         return ExPhpTypeForcing(inner.getSubkeyByIndex(indexKey) ?: return null)
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
-        return ExPhpTypeForcing(inner.instantiateTemplate(nameMap))
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return ExPhpTypeForcing(inner.instantiateGeneric(nameMap))
     }
 
     override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean {

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeGenericsT.kt

@@ -0,0 +1,29 @@
+package com.vk.kphpstorm.exphptype
+
+import com.intellij.openapi.project.Project
+import com.jetbrains.php.lang.psi.elements.PhpPsiElement
+import com.jetbrains.php.lang.psi.resolve.types.PhpType
+
+/**
+ * 'T' — is genericsT when it's defined in @kphp-generic, then it's genericsT on resolve, not class T
+ * @see com.vk.kphpstorm.exphptype.psi.ExPhpTypeInstancePsiImpl.getType
+ */
+class ExPhpTypeGenericsT(val nameT: String) : ExPhpType {
+    override fun toString() = "%$nameT"
+
+    override fun toHumanReadable(expr: PhpPsiElement) = "%$nameT"
+
+    override fun toPhpType(): PhpType = PhpType.EMPTY
+
+    override fun getSubkeyByIndex(indexKey: String) = null
+
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return nameMap[nameT] ?: this
+    }
+
+    override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean = when (rhs) {
+        is ExPhpTypeAny -> true
+        // todo shall we add any strict rules here?
+        else            -> true
+    }
+}

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeInstance.kt

@@ -25,7 +25,7 @@ class ExPhpTypeInstance(val fqn: String) : ExPhpType {
         return null
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
         return nameMap[fqn] ?: this
     }
 
@@ -50,6 +50,20 @@ class ExPhpTypeInstance(val fqn: String) : ExPhpType {
             rhsIsChild
         }
 
+        is ExPhpTypeTplInstantiation -> rhs.classFqn == fqn || run {
+            val phpIndex = PhpIndex.getInstance(project)
+            val lhsClass = phpIndex.getAnyByFQN(fqn).firstOrNull() ?: return false
+            var rhsIsChild = false
+            phpIndex.getAnyByFQN(rhs.classFqn).forEach { rhsClass ->
+                PhpClassHierarchyUtils.processSuperWithoutMixins(rhsClass, true, true) { clazz ->
+                    if (PhpClassHierarchyUtils.classesEqual(lhsClass, clazz))
+                        rhsIsChild = true
+                    !rhsIsChild
+                }
+            }
+            rhsIsChild
+        }
+
         else                  -> false
     }
 }

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypeNullable.kt

@@ -20,8 +20,8 @@ class ExPhpTypeNullable(val inner: ExPhpType) : ExPhpType {
         return inner.getSubkeyByIndex(indexKey)
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
-        return ExPhpTypeNullable(inner.instantiateTemplate(nameMap))
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return ExPhpTypeNullable(inner.instantiateGeneric(nameMap))
     }
 
     override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean = when (rhs) {

src/main/kotlin/com/vk/kphpstorm/exphptype/ExPhpTypePipe.kt

@@ -81,8 +81,8 @@ class ExPhpTypePipe(val items: List<ExPhpType>) : ExPhpType {
         }
     }
 
-    override fun instantiateTemplate(nameMap: Map<String, ExPhpType>): ExPhpType {
-        return ExPhpTypePipe(items.map { it.instantiateTemplate(nameMap) })
+    override fun instantiateGeneric(nameMap: Map<String, ExPhpType>): ExPhpType {
+        return ExPhpTypePipe(items.map { it.instantiateGeneric(nameMap) })
     }
 
     override fun isAssignableFrom(rhs: ExPhpType, project: Project): Boolean {