Merge branch 'main' into nickrolfe/pathname

Author: nickrolfe

java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt

@@ -595,6 +595,8 @@ open class KotlinFileExtractor(
                 tw.writeMethods(clinitId, "<clinit>", "<clinit>()", returnType.javaResult.id, parentId, clinitId)
                 tw.writeMethodsKotlinType(clinitId, returnType.kotlinResult.id)
 
+                tw.writeCompiler_generated(clinitId, CompilerGeneratedKinds.CLASS_INITIALISATION_METHOD.kind)
+
                 val locId = tw.getWholeFileLocation()
                 tw.writeHasLocation(clinitId, locId)
 
@@ -732,12 +734,9 @@ open class KotlinFileExtractor(
 
                 val id =
                     idOverride
-                        ?: if (f.isLocalFunction())
-                            getLocallyVisibleFunctionLabels(f).function
-                        else
-                            // If this is a class that would ordinarily be replaced by a Java equivalent (e.g. kotlin.Map -> java.util.Map),
-                            // don't replace here, really extract the Kotlin version:
-                            useFunction<DbCallable>(f, parentId, classTypeArgsIncludingOuterClasses, noReplace = true)
+                        ?: // If this is a class that would ordinarily be replaced by a Java equivalent (e.g. kotlin.Map -> java.util.Map),
+                           // don't replace here, really extract the Kotlin version:
+                           useFunction<DbCallable>(f, parentId, classTypeArgsIncludingOuterClasses, noReplace = true)
 
                 val sourceDeclaration =
                     if (typeSubstitution != null && idOverride == null)
@@ -783,6 +782,14 @@ open class KotlinFileExtractor(
                     val methodId = id.cast<DbMethod>()
                     tw.writeMethods(methodId, shortName.nameInDB, "${shortName.nameInDB}$paramsSignature", returnType.javaResult.id, parentId, sourceDeclaration.cast<DbMethod>())
                     tw.writeMethodsKotlinType(methodId, returnType.kotlinResult.id)
+                    when (f.origin) {
+                        IrDeclarationOrigin.GENERATED_DATA_CLASS_MEMBER ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.GENERATED_DATA_CLASS_MEMBER.kind)
+                        IrDeclarationOrigin.DEFAULT_PROPERTY_ACCESSOR ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.DEFAULT_PROPERTY_ACCESSOR.kind)
+                        IrDeclarationOrigin.ENUM_CLASS_SPECIAL_MEMBER ->
+                            tw.writeCompiler_generated(methodId, CompilerGeneratedKinds.ENUM_CLASS_SPECIAL_MEMBER.kind)
+                    }
 
                     if (extractMethodAndParameterTypeAccesses) {
                         extractTypeAccessRecursive(substReturnType, locId, id, -1)
@@ -1073,7 +1080,7 @@ open class KotlinFileExtractor(
                         tw.writeKtLocalFunction(ids.function)
 
                         if (s.origin == IrDeclarationOrigin.ADAPTER_FOR_CALLABLE_REFERENCE) {
-                            tw.writeCompiler_generated(classId, 1)
+                            tw.writeCompiler_generated(classId, CompilerGeneratedKinds.DECLARING_CLASSES_OF_ADAPTER_FUNCTIONS.kind)
                         }
                     } else {
                         logger.errorElement("Expected to find local function", s)
@@ -4370,4 +4377,12 @@ open class KotlinFileExtractor(
             declarationStack.pop()
         }
     }
+
+    private enum class CompilerGeneratedKinds(val kind: Int) {
+        DECLARING_CLASSES_OF_ADAPTER_FUNCTIONS(1),
+        GENERATED_DATA_CLASS_MEMBER(2),
+        DEFAULT_PROPERTY_ACCESSOR(3),
+        CLASS_INITIALISATION_METHOD(4),
+        ENUM_CLASS_SPECIAL_MEMBER(5)
+    }
 }

java/kotlin-extractor/src/main/kotlin/KotlinUsesExtractor.kt

@@ -1201,15 +1201,14 @@ open class KotlinUsesExtractor(
             } as IrFunction? ?: f
 
     fun <T: DbCallable> useFunction(f: IrFunction, classTypeArgsIncludingOuterClasses: List<IrTypeArgument>? = null, noReplace: Boolean = false): Label<out T> {
+        return useFunction(f, null, classTypeArgsIncludingOuterClasses, noReplace)
+    }
+
+    fun <T: DbCallable> useFunction(f: IrFunction, parentId: Label<out DbElement>?, classTypeArgsIncludingOuterClasses: List<IrTypeArgument>?, noReplace: Boolean = false): Label<out T> {
         if (f.isLocalFunction()) {
             val ids = getLocallyVisibleFunctionLabels(f)
             return ids.function.cast<T>()
-        } else {
-            return useFunction(f, null, classTypeArgsIncludingOuterClasses, noReplace)
         }
-    }
-
-    fun <T: DbCallable> useFunction(f: IrFunction, parentId: Label<out DbElement>?, classTypeArgsIncludingOuterClasses: List<IrTypeArgument>?, noReplace: Boolean = false): Label<out T> {
         val javaFun = kotlinFunctionToJavaEquivalent(f, noReplace)
         val label = getFunctionLabel(javaFun, parentId, classTypeArgsIncludingOuterClasses)
         val id: Label<T> = tw.getLabelFor(label)

java/ql/integration-tests/linux-only/kotlin/custom_plugin/PrintAst.expected

@@ -0,0 +1,83 @@
+a.kt:
+#    0| [CompilationUnit] a
+#    1|   1: [Class] A
+#    0|     1: [Method] <fn>
+#    0|       3: [TypeAccess] int
+#    0|       5: [BlockStmt] { ... }
+#    0|         0: [ReturnStmt] return ...
+#    0|           0: [IntegerLiteral] 42
+#    1|     2: [Constructor] A
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }
+#    2|     3: [Method] f1
+#    2|       3: [TypeAccess] int
+#    2|       5: [BlockStmt] { ... }
+#    2|         0: [ReturnStmt] return ...
+#    2|           0: [IntegerLiteral] 1
+b.kt:
+#    0| [CompilationUnit] b
+#    1|   1: [Class] B
+#    0|     1: [Method] <fn>
+#    0|       3: [TypeAccess] int
+#    0|       5: [BlockStmt] { ... }
+#    0|         0: [ReturnStmt] return ...
+#    0|           0: [UnsafeCoerceExpr] <unsafe coerce>
+#    0|             0: [TypeAccess] int
+#    0|             1: [IntegerLiteral] 1
+#    1|     2: [Constructor] B
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }
+c.kt:
+#    0| [CompilationUnit] c
+#    1|   1: [Class] C
+#    0|     1: [Method] <fn>
+#    0|       3: [TypeAccess] Unit
+#-----|       4: (Parameters)
+#    0|         0: [Parameter] param
+#    0|           0: [TypeAccess] ProcessBuilder
+#    0|       5: [BlockStmt] { ... }
+#    0|         0: [ReturnStmt] return ...
+#    0|           0: [MethodAccess] start(...)
+#    0|             -1: [VarAccess] param
+#    1|     2: [Constructor] C
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }
+d.kt:
+#    0| [CompilationUnit] d
+#    1|   1: [Class] D
+#    0|     1: [FieldDeclaration] String bar;
+#    0|       -1: [TypeAccess] String
+#    0|       0: [StringLiteral] Foobar
+#    1|     3: [Constructor] D
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }
+e.kt:
+#    0| [CompilationUnit] e
+#    1|   1: [Class] E
+#    0|     1: [Method] <fn_ArrayListAdd>
+#    0|       3: [TypeAccess] boolean
+#    0|       5: [BlockStmt] { ... }
+#    0|         0: [ReturnStmt] return ...
+#    0|           0: [MethodAccess] add(...)
+#    0|             -1: [ClassInstanceExpr] new ArrayList<Object>(...)
+#    0|               -3: [TypeAccess] ArrayList<Object>
+#    0|               0: [IntegerLiteral] 1
+#    0|             0: [NullLiteral] null
+#    0|     1: [Method] <fn_LinkedHashMap>
+#    0|       3: [TypeAccess] Object
+#    0|       5: [BlockStmt] { ... }
+#    0|         0: [ReturnStmt] return ...
+#    0|           0: [MethodAccess] put(...)
+#    0|             -1: [ClassInstanceExpr] new LinkedHashMap<Object,Object>(...)
+#    0|               -3: [TypeAccess] LinkedHashMap<Object,Object>
+#    0|               0: [IntegerLiteral] 1
+#    0|             0: [NullLiteral] null
+#    0|             1: [NullLiteral] null
+#    1|     3: [Constructor] E
+#    1|       5: [BlockStmt] { ... }
+#    1|         0: [SuperConstructorInvocationStmt] super(...)
+#    1|         1: [BlockStmt] { ... }

java/ql/integration-tests/linux-only/kotlin/custom_plugin/PrintAst.qlref

@@ -0,0 +1 @@
+semmle/code/java/PrintAst.ql

java/ql/integration-tests/linux-only/kotlin/custom_plugin/a.kt

@@ -0,0 +1,3 @@
+class A {
+    fun f1() = 1
+}

java/ql/integration-tests/linux-only/kotlin/custom_plugin/b.kt

@@ -0,0 +1,2 @@
+class B {
+}

java/ql/integration-tests/linux-only/kotlin/custom_plugin/build_plugin

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+import subprocess
+import shutil
+import os
+import os.path
+import sys
+import shlex
+
+
+def run_process(cmd):
+    try:
+        print("Running command: " + shlex.join(cmd))
+        return subprocess.run(cmd, check=True, capture_output=True)
+    except subprocess.CalledProcessError as e:
+        print("In: " + os.getcwd(), file=sys.stderr)
+        print("Command failed: " + shlex.join(cmd), file=sys.stderr)
+        print("stdout output:\n" + e.stdout.decode(encoding='UTF-8',
+              errors='strict'), file=sys.stderr)
+        print("stderr output:\n" + e.stderr.decode(encoding='UTF-8',
+              errors='strict'), file=sys.stderr)
+        raise e
+
+root = '../../../../../../../../..'
+
+sys.path.append(root + '/ql/java/kotlin-extractor')
+import kotlin_plugin_versions
+defaultKotlinDependencyVersion = kotlin_plugin_versions.get_single_version()
+
+builddir = 'build'
+dependency_dir = root + '/resources/kotlin-dependencies/'
+dependencies = ['kotlin-stdlib-' + defaultKotlinDependencyVersion +
+                '.jar', 'kotlin-compiler-' + defaultKotlinDependencyVersion + '.jar']
+classpath = ':'.join([dependency_dir + dep for dep in dependencies])
+srcs = ['plugin/Plugin.kt']
+output = 'plugin.jar'
+
+if os.path.exists(builddir):
+    shutil.rmtree(builddir)
+os.makedirs(builddir)
+
+run_process(['kotlinc',
+            '-J-Xmx2G',
+             '-d', builddir,
+             '-module-name', 'test',
+             '-no-reflect', '-no-stdlib',
+             '-jvm-target', '1.8',
+             '-classpath', classpath] + srcs)
+
+run_process(['jar', '-c', '-f', output,
+            '-C', builddir, '.',
+             '-C', 'plugin/resources', 'META-INF'])
+shutil.rmtree(builddir)

java/ql/integration-tests/linux-only/kotlin/custom_plugin/c.kt

@@ -0,0 +1 @@
+class C { }

java/ql/integration-tests/linux-only/kotlin/custom_plugin/d.kt

@@ -0,0 +1 @@
+class D { }

java/ql/integration-tests/linux-only/kotlin/custom_plugin/diagnostics.expected

@@ -0,0 +1,2 @@
+| CodeQL Kotlin extractor | 2 |  | IrProperty without a getter | d.kt:0:0:0:0 | d.kt:0:0:0:0 |
+| CodeQL Kotlin extractor | 2 |  | Not rewriting trap file for: Boolean -1.0-0- -1.0-0-null test-db/trap/java/classes/kotlin/Boolean.members.trap.gz | file://:0:0:0:0 | file://:0:0:0:0 |