Merge pull request github#12264 from michaelnebel/csharp/nugetnet7

C#: Stub generator improvements.

Author: michaelnebel

csharp/ql/src/Stubs/Stubs.qll

@@ -120,15 +120,6 @@ abstract private class GeneratedType extends Type, GeneratedElement {
     else result = ""
   }
 
-  private string stubComment() {
-    exists(string qualifier, string name |
-      this.hasQualifiedName(qualifier, name) and
-      result =
-        "// Generated from `" + getQualifiedName(qualifier, name) + "` in `" +
-          concat(this.getALocation().toString(), "; ") + "`\n"
-    )
-  }
-
   /** Gets the entire C# stub code for this type. */
   pragma[nomagic]
   final string getStub(Assembly assembly) {
@@ -141,17 +132,16 @@ abstract private class GeneratedType extends Type, GeneratedElement {
     else (
       not this instanceof DelegateType and
       result =
-        this.stubComment() + this.stubAttributes() + stubAccessibility(this) +
-          this.stubAbstractModifier() + this.stubStaticModifier() + this.stubPartialModifier() +
-          this.stubKeyword() + " " + this.getUndecoratedName() + stubGenericArguments(this) +
-          this.stubBaseTypesString() + stubTypeParametersConstraints(this) + "\n{\n" +
-          this.stubPrivateConstructor() + this.stubMembers(assembly) + "}\n\n"
+        this.stubAttributes() + stubAccessibility(this) + this.stubAbstractModifier() +
+          this.stubStaticModifier() + this.stubPartialModifier() + this.stubKeyword() + " " +
+          this.getUndecoratedName() + stubGenericArguments(this) + this.stubBaseTypesString() +
+          stubTypeParametersConstraints(this) + "\n{\n" + this.stubPrivateConstructor() +
+          this.stubMembers(assembly) + "}\n\n"
       or
       result =
-        this.stubComment() + this.stubAttributes() + stubUnsafe(this) + stubAccessibility(this) +
-          this.stubKeyword() + " " + stubClassName(this.(DelegateType).getReturnType()) + " " +
-          this.getUndecoratedName() + stubGenericArguments(this) + "(" + stubParameters(this) +
-          ");\n\n"
+        this.stubAttributes() + stubUnsafe(this) + stubAccessibility(this) + this.stubKeyword() +
+          " " + stubClassName(this.(DelegateType).getReturnType()) + " " + this.getUndecoratedName()
+          + stubGenericArguments(this) + "(" + stubParameters(this) + ");\n\n"
     )
   }
 
@@ -400,7 +390,7 @@ private string stubAccessibility(Member m) {
   if
     m.getDeclaringType() instanceof Interface
     or
-    exists(m.(Virtualizable).getExplicitlyImplementedInterface())
+    exists(getExplicitImplementedInterface(m))
     or
     m instanceof Constructor and m.isStatic()
   then result = ""
@@ -443,7 +433,7 @@ private string stubStaticOrConst(Member m) {
 }
 
 private string stubOverride(Member m) {
-  if m.getDeclaringType() instanceof Interface
+  if m.getDeclaringType() instanceof Interface and not m.isStatic()
   then result = ""
   else
     if m.(Virtualizable).isVirtual()
@@ -713,9 +703,49 @@ private string stubEventAccessors(Event e) {
   else result = ";"
 }
 
+/**
+ * Returns an interface that `c` explicitly implements, if either of the
+ * following also holds.
+ * (1) `c` is not static.
+ * (2) `c` is static and an implementation of a generic with type constraints.
+ * (3) `c` is static and there is another member with the same name
+ * but different return type.
+ *
+ * We use these rules as explicit interfaces are needed in some cases
+ * for compilation purposes (both to distinguish members but also to ensure
+ * type constraints are satisfied). We can't always use explicit interface
+ * implementation due to the generic math support, because then in some cases
+ * we will only be able to access a static via a type variable with type
+ * constraints (C# 11 language feature).
+ */
+private Interface getExplicitImplementedInterface(Virtualizable c) {
+  result = unique(Interface i | i = c.getExplicitlyImplementedInterface()) and
+  (
+    not c.isStatic()
+    or
+    c.isStatic() and
+    (
+      not c instanceof Method
+      or
+      c instanceof Method and
+      (
+        exists(TypeParameter t | t = c.getImplementee().(UnboundGeneric).getATypeParameter() |
+          exists(t.getConstraints().getATypeConstraint())
+        )
+        or
+        exists(Member m |
+          (not m.isStatic() or m.(Method).getReturnType() != c.(Method).getReturnType()) and
+          m.getName() = c.getName() and
+          m.getDeclaringType() = c.getDeclaringType()
+        )
+      )
+    )
+  )
+}
+
 private string stubExplicitImplementation(Member c) {
-  if exists(c.(Virtualizable).getExplicitlyImplementedInterface())
-  then result = stubClassName(c.(Virtualizable).getExplicitlyImplementedInterface()) + "."
+  if exists(getExplicitImplementedInterface(c))
+  then result = stubClassName(getExplicitImplementedInterface(c)) + "."
   else result = ""
 }
 
@@ -740,14 +770,16 @@ private string stubOperator(Operator o, Assembly assembly) {
   if o instanceof ConversionOperator
   then
     result =
-      "    " + stubModifiers(o) + stubExplicit(o) + "operator " + stubClassName(o.getReturnType()) +
-        "(" + stubParameters(o) + ") => throw null;\n"
+      "    " + stubModifiers(o) + stubExplicit(o) + stubExplicitImplementation(o) + "operator " +
+        stubChecked(o) + stubClassName(o.getReturnType()) + "(" + stubParameters(o) + ")" +
+        stubImplementation(o) + ";\n"
   else
     if not o.getDeclaringType() instanceof Enum
     then
       result =
-        "    " + stubModifiers(o) + stubClassName(o.getReturnType()) + " operator " + o.getName() +
-          "(" + stubParameters(o) + ") => throw null;\n"
+        "    " + stubModifiers(o) + stubClassName(o.getReturnType()) + " " +
+          stubExplicitImplementation(o) + "operator " + o.getName() + "(" + stubParameters(o) + ")" +
+          stubImplementation(o) + ";\n"
     else result = "    // Stub generator skipped operator: " + o.getName() + "\n"
 }
 
@@ -888,7 +920,16 @@ private string stubConstructorInitializer(Constructor c) {
 private string stubExplicit(ConversionOperator op) {
   op instanceof ImplicitConversionOperator and result = "implicit "
   or
-  op instanceof ExplicitConversionOperator and result = "explicit "
+  (
+    op instanceof ExplicitConversionOperator
+    or
+    op instanceof CheckedExplicitConversionOperator
+  ) and
+  result = "explicit "
+}
+
+private string stubChecked(Operator o) {
+  if o instanceof CheckedExplicitConversionOperator then result = "checked " else result = ""
 }
 
 private string stubGetter(DeclarationWithGetSetAccessors p) {
@@ -917,6 +958,8 @@ private string stubSemmleExtractorOptions() {
 /** Gets the generated C# code. */
 string generatedCode(Assembly assembly) {
   result =
-    "// This file contains auto-generated code.\n" + stubSemmleExtractorOptions() + "\n" +
-      any(GeneratedNamespace ns | ns.isGlobalNamespace()).getStubs(assembly)
+    "// This file contains auto-generated code.\n" //
+      + "// Generated from `" + assembly.getFullName() + "`.\n" //
+      + stubSemmleExtractorOptions() + "\n" //
+      + any(GeneratedNamespace ns | ns.isGlobalNamespace()).getStubs(assembly)
 }

csharp/ql/src/Stubs/make_stubs_nuget.py

@@ -109,7 +109,7 @@ def run_cmd(cmd, msg="Failed to run command"):
 print("\n --> Generated stub files: " + rawSrcOutputDir)
 
 print("\n* Formatting files")
-run_cmd(['dotnet', 'format', rawSrcOutputDir])
+run_cmd(['dotnet', 'format', 'whitespace', rawSrcOutputDir])
 
 print("\n --> Generated (formatted) stub files: " + rawSrcOutputDir)
 

csharp/ql/test/query-tests/Stubs/All/AllStubs.expected

@@ -1 +1 @@
-| // This file contains auto-generated code.\n\nnamespace A1\n{\n// Generated from `A1.C1` in `Test.cs:185:18:185:19; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class C1\n{\n}\n\n}\nnamespace A2\n{\nnamespace B2\n{\n// Generated from `A2.B2.C2` in `Test.cs:192:22:192:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class C2\n{\n}\n\n}\n}\nnamespace A3\n{\n// Generated from `A3.C3` in `Test.cs:198:18:198:19; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class C3\n{\n}\n\n}\nnamespace A4\n{\n// Generated from `A4.C4` in `Test.cs:208:18:208:19; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class C4\n{\n}\n\nnamespace B4\n{\n// Generated from `A4.B4.D4` in `Test.cs:205:22:205:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class D4\n{\n}\n\n}\n}\nnamespace Test\n{\n// Generated from `Test.Class1` in `Test.cs:5:18:5:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class1\n{\n// Generated from `Test.Class1+Class11` in `Test.cs:34:22:34:28; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class11 : Test.Class1.Interface1, Test.Class1.Interface2\n{\n    int Test.Class1.Interface2.this[int i] { get => throw null; }\n    public void Method1() => throw null;\n    void Test.Class1.Interface2.Method2() => throw null;\n}\n\n\n// Generated from `Test.Class1+Class12` in `Test.cs:51:22:51:28; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class12 : Test.Class1.Class11\n{\n}\n\n\n// Generated from `Test.Class1+Class13` in `Test.cs:63:31:63:37; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic abstract class Class13\n{\n    protected internal virtual void M() => throw null;\n    public virtual void M1<T>() where T: Test.Class1.Class13 => throw null;\n    public abstract void M2();\n}\n\n\n// Generated from `Test.Class1+Class14` in `Test.cs:70:31:70:37; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic abstract class Class14 : Test.Class1.Class13\n{\n    protected internal override void M() => throw null;\n    public override void M1<T>() => throw null;\n    public abstract override void M2();\n}\n\n\n// Generated from `Test.Class1+Delegate1<>` in `Test.cs:47:30:47:41; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic delegate void Delegate1<T>(T i, int j);\n\n\n// Generated from `Test.Class1+GenericType<>` in `Test.cs:56:22:56:35; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class GenericType<T>\n{\n// Generated from `Test.Class1+GenericType<>+X` in `Test.cs:58:26:58:26; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class X\n{\n}\n\n\n}\n\n\n// Generated from `Test.Class1+Interface1` in `Test.cs:18:26:18:35; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic interface Interface1\n{\n    void Method1();\n}\n\n\n// Generated from `Test.Class1+Interface2` in `Test.cs:23:38:23:47; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\nprotected internal interface Interface2\n{\n    int this[int i] { get; }\n    void Method2();\n}\n\n\n// Generated from `Test.Class1+Struct1` in `Test.cs:7:23:7:29; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic struct Struct1\n{\n    public void Method(Test.Class1.Struct1 s = default(Test.Class1.Struct1)) => throw null;\n    public int i;\n    public static int j = default;\n    public System.ValueTuple<int> t1;\n    public (int,int) t2;\n}\n\n\n    public event Test.Class1.Delegate1<int> Event1;\n    public Test.Class1.GenericType<int>.X Prop { get => throw null; }\n}\n\n// Generated from `Test.Class10` in `Test.cs:138:18:138:24; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class10\n{\n    unsafe public void M1(delegate* unmanaged<System.IntPtr,void> f) => throw null;\n}\n\n// Generated from `Test.Class3` in `Test.cs:84:18:84:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class3\n{\n    public object Item { get => throw null; set => throw null; }\n    [System.Runtime.CompilerServices.IndexerName("MyItem")]\n    public object this[string index] { get => throw null; set => throw null; }\n}\n\n// Generated from `Test.Class4` in `Test.cs:91:18:91:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class4\n{\n    unsafe public void M(int* p) => throw null;\n}\n\n// Generated from `Test.Class5` in `Test.cs:102:18:102:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class5 : Test.IInterface1\n{\n    public void M2() => throw null;\n}\n\n// Generated from `Test.Class6<>` in `Test.cs:107:18:107:26; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class6<T> where T: class, Test.IInterface1\n{\n    public virtual void M1<T>() where T: class, Test.IInterface1, new() => throw null;\n}\n\n// Generated from `Test.Class7` in `Test.cs:114:18:114:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class7 : Test.Class6<Test.Class5>\n{\n    public override void M1<T>() where T: class => throw null;\n}\n\n// Generated from `Test.Class8` in `Test.cs:121:18:121:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class8\n{\n    public static int @this = default;\n}\n\n// Generated from `Test.Class9` in `Test.cs:126:18:126:23; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Class9\n{\n// Generated from `Test.Class9+Nested` in `Test.cs:130:22:130:27; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic class Nested : Test.Class9\n{\n}\n\n\n    public Test.Class9.Nested NestedInstance { get => throw null; }\n}\n\n// Generated from `Test.Enum1` in `Test.cs:143:17:143:21; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic enum Enum1 : int\n{\n    None1 = 0,\n    Some11 = 1,\n    Some12 = 2,\n}\n\n// Generated from `Test.Enum2` in `Test.cs:150:17:150:21; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic enum Enum2 : int\n{\n    None2 = 2,\n    Some21 = 1,\n    Some22 = 3,\n}\n\n// Generated from `Test.Enum3` in `Test.cs:157:17:157:21; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic enum Enum3 : int\n{\n    None3 = 2,\n    Some31 = 1,\n    Some32 = 0,\n}\n\n// Generated from `Test.Enum4` in `Test.cs:164:17:164:21; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic enum Enum4 : int\n{\n    None4 = 2,\n    Some41 = 7,\n    Some42 = 6,\n}\n\n// Generated from `Test.EnumLong` in `Test.cs:171:17:171:24; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic enum EnumLong : long\n{\n    None = 10,\n    Some = 223372036854775807,\n}\n\n// Generated from `Test.IInterface1` in `Test.cs:96:22:96:32; Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`\npublic interface IInterface1\n{\n    void M1() => throw null;\n    void M2();\n}\n\n}\n\n\n |
+| // This file contains auto-generated code.\n// Generated from `Test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null`.\n\nnamespace A1\n{\npublic class C1\n{\n}\n\n}\nnamespace A2\n{\nnamespace B2\n{\npublic class C2\n{\n}\n\n}\n}\nnamespace A3\n{\npublic class C3\n{\n}\n\n}\nnamespace A4\n{\npublic class C4\n{\n}\n\nnamespace B4\n{\npublic class D4\n{\n}\n\n}\n}\nnamespace Test\n{\npublic class Class1\n{\npublic class Class11 : Test.Class1.Interface1, Test.Class1.Interface2\n{\n    int Test.Class1.Interface2.this[int i] { get => throw null; }\n    public void Method1() => throw null;\n    void Test.Class1.Interface2.Method2() => throw null;\n}\n\n\npublic class Class12 : Test.Class1.Class11\n{\n}\n\n\npublic abstract class Class13\n{\n    protected internal virtual void M() => throw null;\n    public virtual void M1<T>() where T: Test.Class1.Class13 => throw null;\n    public abstract void M2();\n}\n\n\npublic abstract class Class14 : Test.Class1.Class13\n{\n    protected internal override void M() => throw null;\n    public override void M1<T>() => throw null;\n    public abstract override void M2();\n}\n\n\npublic delegate void Delegate1<T>(T i, int j);\n\n\npublic class GenericType<T>\n{\npublic class X\n{\n}\n\n\n}\n\n\npublic interface Interface1\n{\n    void Method1();\n}\n\n\nprotected internal interface Interface2\n{\n    int this[int i] { get; }\n    void Method2();\n}\n\n\npublic struct Struct1\n{\n    public void Method(Test.Class1.Struct1 s = default(Test.Class1.Struct1)) => throw null;\n    public int i;\n    public static int j = default;\n    public System.ValueTuple<int> t1;\n    public (int,int) t2;\n}\n\n\n    public event Test.Class1.Delegate1<int> Event1;\n    public Test.Class1.GenericType<int>.X Prop { get => throw null; }\n}\n\npublic class Class10\n{\n    unsafe public void M1(delegate* unmanaged<System.IntPtr,void> f) => throw null;\n}\n\npublic class Class11 : Test.IInterface2<Test.Class11>, Test.IInterface3<Test.Class11>\n{\n    static Test.Class11 Test.IInterface2<Test.Class11>.operator *(Test.Class11 left, Test.Class11 right) => throw null;\n    public static Test.Class11 operator +(Test.Class11 left, Test.Class11 right) => throw null;\n    public static Test.Class11 operator -(Test.Class11 left, Test.Class11 right) => throw null;\n    static Test.Class11 Test.IInterface2<Test.Class11>.operator /(Test.Class11 left, Test.Class11 right) => throw null;\n    public void M1() => throw null;\n    void Test.IInterface2<Test.Class11>.M2() => throw null;\n    public static explicit operator System.Int16(Test.Class11 n) => throw null;\n    static explicit Test.IInterface2<Test.Class11>.operator int(Test.Class11 n) => throw null;\n}\n\npublic class Class3\n{\n    public object Item { get => throw null; set => throw null; }\n    [System.Runtime.CompilerServices.IndexerName("MyItem")]\n    public object this[string index] { get => throw null; set => throw null; }\n}\n\npublic class Class4\n{\n    unsafe public void M(int* p) => throw null;\n}\n\npublic class Class5 : Test.IInterface1\n{\n    public void M2() => throw null;\n}\n\npublic class Class6<T> where T: class, Test.IInterface1\n{\n    public virtual void M1<T>() where T: class, Test.IInterface1, new() => throw null;\n}\n\npublic class Class7 : Test.Class6<Test.Class5>\n{\n    public override void M1<T>() where T: class => throw null;\n}\n\npublic class Class8\n{\n    public static int @this = default;\n}\n\npublic class Class9\n{\npublic class Nested : Test.Class9\n{\n}\n\n\n    public Test.Class9.Nested NestedInstance { get => throw null; }\n}\n\npublic enum Enum1 : int\n{\n    None1 = 0,\n    Some11 = 1,\n    Some12 = 2,\n}\n\npublic enum Enum2 : int\n{\n    None2 = 2,\n    Some21 = 1,\n    Some22 = 3,\n}\n\npublic enum Enum3 : int\n{\n    None3 = 2,\n    Some31 = 1,\n    Some32 = 0,\n}\n\npublic enum Enum4 : int\n{\n    None4 = 2,\n    Some41 = 7,\n    Some42 = 6,\n}\n\npublic enum EnumLong : long\n{\n    None = 10,\n    Some = 223372036854775807,\n}\n\npublic interface IInterface1\n{\n    void M1() => throw null;\n    void M2();\n}\n\npublic interface IInterface2<T> where T: Test.IInterface2<T>\n{\n    static abstract T operator *(T left, T right);\n    static abstract T operator +(T left, T right);\n    static virtual T operator -(T left, T right) => throw null;\n    static virtual T operator /(T left, T right) => throw null;\n    void M1();\n    void M2();\n    static abstract explicit operator System.Int16(T n);\n    static abstract explicit operator int(T n);\n}\n\npublic interface IInterface3<T> where T: Test.IInterface3<T>\n{\n    static abstract T operator +(T left, T right);\n    static virtual T operator -(T left, T right) => throw null;\n    void M1();\n    static abstract explicit operator System.Int16(T n);\n}\n\n}\n\n\n |