Merge pull request github#9801 from igfoo/igfoo/psi

igfoo · web-flow · commit 2edeeaac0ec5 · 2022-07-12T11:01:30.000+01:00
Kotlin: We can't extract comments for &lt; 1.5.20
diff --git a/java/kotlin-extractor/src/main/kotlin/comments/CommentExtractor.kt b/java/kotlin-extractor/src/main/kotlin/comments/CommentExtractor.kt
@@ -16,7 +16,8 @@ import org.jetbrains.kotlin.psi.psiUtil.startOffset
 class CommentExtractor(private val fileExtractor: KotlinFileExtractor, private val file: IrFile, private val fileLabel: Label<out DbFile>) {
     private val tw = fileExtractor.tw
     private val logger = fileExtractor.logger
-    private val ktFile = Psi2Ir().getKtFile(file)
+    private val psi2Ir = Psi2Ir(logger)
+    private val ktFile = psi2Ir.getKtFile(file)
 
     fun extract() {
         if (ktFile == null) {
@@ -85,7 +86,7 @@ class CommentExtractor(private val fileExtractor: KotlinFileExtractor, private v
                 val ownerPsi = getKDocOwner(comment) ?: return
 
                 val owners = mutableListOf<IrElement>()
-                file.accept(IrVisitorLookup(ownerPsi, file), owners)
+                file.accept(IrVisitorLookup(psi2Ir, ownerPsi, file), owners)
 
                 for (ownerIr in owners) {
                     val ownerLabel =
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/IrVisitorLookup.kt b/java/kotlin-extractor/src/main/kotlin/utils/IrVisitorLookup.kt
@@ -8,7 +8,7 @@ import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.ir.util.isFakeOverride
 import org.jetbrains.kotlin.ir.visitors.IrElementVisitor
 
-class IrVisitorLookup(private val psi: PsiElement, private val file: IrFile) :
+class IrVisitorLookup(private val psi2Ir: Psi2Ir, private val psi: PsiElement, private val file: IrFile) :
     IrElementVisitor<Unit, MutableCollection<IrElement>> {
     private val location = psi.getLocation()
 
@@ -27,12 +27,12 @@ class IrVisitorLookup(private val psi: PsiElement, private val file: IrFile) :
         }
 
         if (location.contains(elementLocation)) {
-            val psiElement = Psi2Ir().findPsiElement(element, file)
+            val psiElement = psi2Ir.findPsiElement(element, file)
             if (psiElement == psi) {
                 // There can be multiple IrElements that match the same PSI element.
                 data.add(element)
             }
         }
         element.acceptChildren(this, data)
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_4_32/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_4_32/Psi2Ir.kt
@@ -1,21 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.psi2ir.PsiSourceManager
-
-class Psi2Ir : Psi2IrFacade {
-    companion object {
-        val psiManager = PsiSourceManager()
-    }
 
+class Psi2Ir(private val logger: FileLogger) : Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
-        return psiManager.getKtFile(irFile)
+        logger.warn("Comment extraction is not supported for Kotlin < 1.5.20")
+        return null
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
-        return psiManager.findPsiElement(irElement, irFile)
+        logger.error("Attempted comment extraction for Kotlin < 1.5.20")
+        return null
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_0/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_0/Psi2Ir.kt
@@ -1,21 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.psi2ir.PsiSourceManager
-
-class Psi2Ir : Psi2IrFacade {
-    companion object {
-        val psiManager = PsiSourceManager()
-    }
 
+class Psi2Ir(private val logger: FileLogger) : Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
-        return psiManager.getKtFile(irFile)
+        logger.warn("Comment extraction is not supported for Kotlin < 1.5.20")
+        return null
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
-        return psiManager.findPsiElement(irElement, irFile)
+        logger.error("Attempted comment extraction for Kotlin < 1.5.20")
+        return null
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_10/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_10/Psi2Ir.kt
@@ -1,21 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
-import org.jetbrains.kotlin.psi2ir.PsiSourceManager
-
-class Psi2Ir : Psi2IrFacade {
-    companion object {
-        val psiManager = PsiSourceManager()
-    }
 
+class Psi2Ir(private val logger: FileLogger) : Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
-        return psiManager.getKtFile(irFile)
+        logger.warn("Comment extraction is not supported for Kotlin < 1.5.20")
+        return null
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
-        return psiManager.findPsiElement(irElement, irFile)
+        logger.error("Attempted comment extraction for Kotlin < 1.5.20")
+        return null
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_21/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_21/Psi2Ir.kt
@@ -1,18 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.backend.common.psi.PsiSourceManager
 import org.jetbrains.kotlin.backend.jvm.ir.getKtFile
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
 
-class Psi2Ir: Psi2IrFacade {
+class Psi2Ir(private val logger: FileLogger): Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
         return irFile.getKtFile()
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
         return PsiSourceManager.findPsiElement(irElement, irFile)
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_31/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_5_31/Psi2Ir.kt
@@ -1,18 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.backend.common.psi.PsiSourceManager
 import org.jetbrains.kotlin.backend.jvm.ir.getKtFile
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
 
-class Psi2Ir: Psi2IrFacade {
+class Psi2Ir(private val logger: FileLogger): Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
         return irFile.getKtFile()
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
         return PsiSourceManager.findPsiElement(irElement, irFile)
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_6_10/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_6_10/Psi2Ir.kt
@@ -1,18 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.backend.common.psi.PsiSourceManager
 import org.jetbrains.kotlin.backend.jvm.ir.getKtFile
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
 
-class Psi2Ir: Psi2IrFacade {
+class Psi2Ir(private val logger: FileLogger): Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
         return irFile.getKtFile()
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
         return PsiSourceManager.findPsiElement(irElement, irFile)
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_6_20/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_6_20/Psi2Ir.kt
@@ -1,18 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.backend.common.psi.PsiSourceManager
 import org.jetbrains.kotlin.backend.jvm.ir.getKtFile
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
 
-class Psi2Ir: Psi2IrFacade {
+class Psi2Ir(private val logger: FileLogger): Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
         return irFile.getKtFile()
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
         return PsiSourceManager.findPsiElement(irElement, irFile)
     }
-}
+}
diff --git a/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_7_0/Psi2Ir.kt b/java/kotlin-extractor/src/main/kotlin/utils/versions/v_1_7_0/Psi2Ir.kt
@@ -1,18 +1,19 @@
 package com.github.codeql.utils.versions
 
+import com.github.codeql.FileLogger
 import com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.backend.common.psi.PsiSourceManager
 import org.jetbrains.kotlin.backend.jvm.ir.getKtFile
 import org.jetbrains.kotlin.ir.IrElement
 import org.jetbrains.kotlin.ir.declarations.IrFile
 import org.jetbrains.kotlin.psi.KtFile
 
-class Psi2Ir: Psi2IrFacade {
+class Psi2Ir(private val logger: FileLogger): Psi2IrFacade {
     override fun getKtFile(irFile: IrFile): KtFile? {
         return irFile.getKtFile()
     }
 
     override fun findPsiElement(irElement: IrElement, irFile: IrFile): PsiElement? {
         return PsiSourceManager.findPsiElement(irElement, irFile)
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import org.jetbrains.kotlin.ir.declarations.IrFile`
`8`	`8`	`import org.jetbrains.kotlin.ir.util.isFakeOverride`
`9`	`9`	`import org.jetbrains.kotlin.ir.visitors.IrElementVisitor`
`10`	`10`
`11`		`-class IrVisitorLookup(private val psi: PsiElement, private val file: IrFile) :`
	`11`	`+class IrVisitorLookup(private val psi2Ir: Psi2Ir, private val psi: PsiElement, private val file: IrFile) :`
`12`	`12`	`IrElementVisitor<Unit, MutableCollection<IrElement>> {`
`13`	`13`	`private val location = psi.getLocation()`
`14`	`14`
`@@ -27,12 +27,12 @@ class IrVisitorLookup(private val psi: PsiElement, private val file: IrFile) :`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`if (location.contains(elementLocation)) {`
`30`		`- val psiElement = Psi2Ir().findPsiElement(element, file)`
	`30`	`+ val psiElement = psi2Ir.findPsiElement(element, file)`
`31`	`31`	`if (psiElement == psi) {`
`32`	`32`	`// There can be multiple IrElements that match the same PSI element.`
`33`	`33`	`data.add(element)`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`element.acceptChildren(this, data)`
`37`	`37`	`}`
`38`		`-}`
	`38`	`+}`