Merge pull request #15024 from tamasvajk/fix/interpolated-strings-stubs

C#: Add interpolated string handler attributes to generated stubs

Author: tamasvajk

csharp/extractor/Semmle.Extraction.CSharp.StubGenerator/StubVisitor.cs

@@ -203,10 +203,12 @@ private void StubTypedConstant(TypedConstant c)
 
     private static readonly HashSet<string> attributeAllowList = new() {
         "System.FlagsAttribute",
-        "System.AttributeUsageAttribute"
+        "System.AttributeUsageAttribute",
+        "System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute",
+        "System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute",
     };
 
-    private void StubAttribute(AttributeData a, string prefix)
+    private void StubAttribute(AttributeData a, string prefix, bool addNewLine)
     {
         if (a.AttributeClass is not INamedTypeSymbol @class)
             return;
@@ -232,14 +234,18 @@ private void StubAttribute(AttributeData a, string prefix)
             });
             stubWriter.Write(")");
         }
-        stubWriter.WriteLine("]");
+        stubWriter.Write("]");
+        if (addNewLine)
+        {
+            stubWriter.WriteLine();
+        }
     }
 
-    public void StubAttributes(IEnumerable<AttributeData> a, string prefix = "")
+    public void StubAttributes(IEnumerable<AttributeData> a, string prefix = "", bool addNewLine = true)
     {
         foreach (var attribute in a)
         {
-            StubAttribute(attribute, prefix);
+            StubAttribute(attribute, prefix, addNewLine);
         }
     }
 
@@ -513,6 +519,8 @@ private void StubParameters(ICollection<IParameterSymbol> parameters)
     {
         WriteCommaSep(parameters, parameter =>
         {
+            StubAttributes(parameter.GetAttributes(), addNewLine: false);
+
             switch (parameter.RefKind)
             {
                 case RefKind.None:

csharp/ql/test/resources/stubs/_frameworks/Microsoft.NETCore.App/System.Memory.cs

@@ -436,8 +436,9 @@ public static partial class MemoryExtensions
         public static System.ReadOnlySpan<T> TrimStart<T>(this System.ReadOnlySpan<T> span, T trimElement) where T : System.IEquatable<T> => throw null;
         public static System.Span<T> TrimStart<T>(this System.Span<T> span, System.ReadOnlySpan<T> trimElements) where T : System.IEquatable<T> => throw null;
         public static System.Span<T> TrimStart<T>(this System.Span<T> span, T trimElement) where T : System.IEquatable<T> => throw null;
-        public static bool TryWrite(this System.Span<char> destination, ref System.MemoryExtensions.TryWriteInterpolatedStringHandler handler, out int charsWritten) => throw null;
-        public static bool TryWrite(this System.Span<char> destination, System.IFormatProvider provider, ref System.MemoryExtensions.TryWriteInterpolatedStringHandler handler, out int charsWritten) => throw null;
+        public static bool TryWrite(this System.Span<char> destination, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("destination")] ref System.MemoryExtensions.TryWriteInterpolatedStringHandler handler, out int charsWritten) => throw null;
+        public static bool TryWrite(this System.Span<char> destination, System.IFormatProvider provider, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument(new[] { "destination", "provider" })] ref System.MemoryExtensions.TryWriteInterpolatedStringHandler handler, out int charsWritten) => throw null;
+        [System.Runtime.CompilerServices.InterpolatedStringHandler]
         public struct TryWriteInterpolatedStringHandler
         {
             public bool AppendFormatted(System.ReadOnlySpan<char> value) => throw null;

csharp/ql/test/resources/stubs/_frameworks/Microsoft.NETCore.App/System.Runtime.cs

@@ -2697,11 +2697,12 @@ public sealed class ConditionalAttribute : System.Attribute
         public static class Debug
         {
             public static void Assert(bool condition) => throw null;
-            public static void Assert(bool condition, ref System.Diagnostics.Debug.AssertInterpolatedStringHandler message) => throw null;
-            public static void Assert(bool condition, ref System.Diagnostics.Debug.AssertInterpolatedStringHandler message, ref System.Diagnostics.Debug.AssertInterpolatedStringHandler detailMessage) => throw null;
+            public static void Assert(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.AssertInterpolatedStringHandler message) => throw null;
+            public static void Assert(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.AssertInterpolatedStringHandler message, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.AssertInterpolatedStringHandler detailMessage) => throw null;
             public static void Assert(bool condition, string message) => throw null;
             public static void Assert(bool condition, string message, string detailMessage) => throw null;
             public static void Assert(bool condition, string message, string detailMessageFormat, params object[] args) => throw null;
+            [System.Runtime.CompilerServices.InterpolatedStringHandler]
             public struct AssertInterpolatedStringHandler
             {
                 public void AppendFormatted(object value, int alignment = default(int), string format = default(string)) => throw null;
@@ -2731,12 +2732,13 @@ public struct AssertInterpolatedStringHandler
             public static void Write(object value, string category) => throw null;
             public static void Write(string message) => throw null;
             public static void Write(string message, string category) => throw null;
-            public static void WriteIf(bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message) => throw null;
-            public static void WriteIf(bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string category) => throw null;
+            public static void WriteIf(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message) => throw null;
+            public static void WriteIf(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string category) => throw null;
             public static void WriteIf(bool condition, object value) => throw null;
             public static void WriteIf(bool condition, object value, string category) => throw null;
             public static void WriteIf(bool condition, string message) => throw null;
             public static void WriteIf(bool condition, string message, string category) => throw null;
+            [System.Runtime.CompilerServices.InterpolatedStringHandler]
             public struct WriteIfInterpolatedStringHandler
             {
                 public void AppendFormatted(object value, int alignment = default(int), string format = default(string)) => throw null;
@@ -2756,8 +2758,8 @@ public struct WriteIfInterpolatedStringHandler
             public static void WriteLine(string message) => throw null;
             public static void WriteLine(string format, params object[] args) => throw null;
             public static void WriteLine(string message, string category) => throw null;
-            public static void WriteLineIf(bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message) => throw null;
-            public static void WriteLineIf(bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string category) => throw null;
+            public static void WriteLineIf(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message) => throw null;
+            public static void WriteLineIf(bool condition, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("condition")] ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string category) => throw null;
             public static void WriteLineIf(bool condition, object value) => throw null;
             public static void WriteLineIf(bool condition, object value, string category) => throw null;
             public static void WriteLineIf(bool condition, string message) => throw null;
@@ -9036,6 +9038,7 @@ public sealed class DefaultDependencyAttribute : System.Attribute
                 public DefaultDependencyAttribute(System.Runtime.CompilerServices.LoadHint loadHintArgument) => throw null;
                 public System.Runtime.CompilerServices.LoadHint LoadHint { get => throw null; }
             }
+            [System.Runtime.CompilerServices.InterpolatedStringHandler]
             public struct DefaultInterpolatedStringHandler
             {
                 public void AppendFormatted(object value, int alignment = default(int), string format = default(string)) => throw null;
@@ -10876,8 +10879,8 @@ public sealed class String : System.ICloneable, System.IComparable, System.IComp
         public static string Copy(string str) => throw null;
         public void CopyTo(int sourceIndex, char[] destination, int destinationIndex, int count) => throw null;
         public void CopyTo(System.Span<char> destination) => throw null;
-        public static string Create(System.IFormatProvider provider, ref System.Runtime.CompilerServices.DefaultInterpolatedStringHandler handler) => throw null;
-        public static string Create(System.IFormatProvider provider, System.Span<char> initialBuffer, ref System.Runtime.CompilerServices.DefaultInterpolatedStringHandler handler) => throw null;
+        public static string Create(System.IFormatProvider provider, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("provider")] ref System.Runtime.CompilerServices.DefaultInterpolatedStringHandler handler) => throw null;
+        public static string Create(System.IFormatProvider provider, System.Span<char> initialBuffer, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument(new[] { "provider", "initialBuffer" })] ref System.Runtime.CompilerServices.DefaultInterpolatedStringHandler handler) => throw null;
         public static string Create<TState>(int length, TState state, System.Buffers.SpanAction<char, TState> action) => throw null;
         public unsafe String(char* value) => throw null;
         public unsafe String(char* value, int startIndex, int length) => throw null;
@@ -11419,7 +11422,7 @@ public sealed class StringBuilder : System.Runtime.Serialization.ISerializable
             public System.Text.StringBuilder Append(char[] value, int startIndex, int charCount) => throw null;
             public System.Text.StringBuilder Append(decimal value) => throw null;
             public System.Text.StringBuilder Append(double value) => throw null;
-            public System.Text.StringBuilder Append(System.IFormatProvider provider, ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
+            public System.Text.StringBuilder Append(System.IFormatProvider provider, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument(new[] { "", "provider" })] ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
             public System.Text.StringBuilder Append(short value) => throw null;
             public System.Text.StringBuilder Append(int value) => throw null;
             public System.Text.StringBuilder Append(long value) => throw null;
@@ -11432,7 +11435,7 @@ public sealed class StringBuilder : System.Runtime.Serialization.ISerializable
             public System.Text.StringBuilder Append(string value, int startIndex, int count) => throw null;
             public System.Text.StringBuilder Append(System.Text.StringBuilder value) => throw null;
             public System.Text.StringBuilder Append(System.Text.StringBuilder value, int startIndex, int count) => throw null;
-            public System.Text.StringBuilder Append(ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
+            public System.Text.StringBuilder Append([System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("")] ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
             public System.Text.StringBuilder Append(ushort value) => throw null;
             public System.Text.StringBuilder Append(uint value) => throw null;
             public System.Text.StringBuilder Append(ulong value) => throw null;
@@ -11444,6 +11447,7 @@ public sealed class StringBuilder : System.Runtime.Serialization.ISerializable
             public System.Text.StringBuilder AppendFormat(string format, object arg0, object arg1) => throw null;
             public System.Text.StringBuilder AppendFormat(string format, object arg0, object arg1, object arg2) => throw null;
             public System.Text.StringBuilder AppendFormat(string format, params object[] args) => throw null;
+            [System.Runtime.CompilerServices.InterpolatedStringHandler]
             public struct AppendInterpolatedStringHandler
             {
                 public void AppendFormatted(object value, int alignment = default(int), string format = default(string)) => throw null;
@@ -11466,9 +11470,9 @@ public struct AppendInterpolatedStringHandler
             public System.Text.StringBuilder AppendJoin<T>(char separator, System.Collections.Generic.IEnumerable<T> values) => throw null;
             public System.Text.StringBuilder AppendJoin<T>(string separator, System.Collections.Generic.IEnumerable<T> values) => throw null;
             public System.Text.StringBuilder AppendLine() => throw null;
-            public System.Text.StringBuilder AppendLine(System.IFormatProvider provider, ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
+            public System.Text.StringBuilder AppendLine(System.IFormatProvider provider, [System.Runtime.CompilerServices.InterpolatedStringHandlerArgument(new[] { "", "provider" })] ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
             public System.Text.StringBuilder AppendLine(string value) => throw null;
-            public System.Text.StringBuilder AppendLine(ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
+            public System.Text.StringBuilder AppendLine([System.Runtime.CompilerServices.InterpolatedStringHandlerArgument("")] ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler) => throw null;
             public int Capacity { get => throw null; set { } }
             public struct ChunkEnumerator
             {