Add more StringSyntaxAttribute syntaxes (#67621)

* Add DateFormat and TimeFormat to StringSyntaxAttribute * Add NumericFormat to StringSyntaxAttribute * Add TimeSpanFormat to StringSyntaxAttribute * Add EnumFormat to StringSyntaxAttribute * Add GuidFormat to StringSyntaxAttribute * Add CompositeFormat to StringSyntaxAttribute * Add Xml to StringSyntaxAttribute * Add Uri to StringSyntaxAttribute * Update ref usage to strings * Address API review renames * Fix netstandard build * Address PR feedback
dotnet · Apr 7, 2022 · b2b2f6d · b2b2f6d
1 parent 431f8b6
commit b2b2f6d
Show file tree

Hide file tree

Showing 90 changed files with 636 additions and 572 deletions.
diff --git a/...ibraries/Microsoft.Extensions.Logging.Console/ref/Microsoft.Extensions.Logging.Console.cs b/...ibraries/Microsoft.Extensions.Logging.Console/ref/Microsoft.Extensions.Logging.Console.cs
@@ -41,7 +41,7 @@ public partial class ConsoleFormatterOptions
     {
         public ConsoleFormatterOptions() { }
         public bool IncludeScopes { get { throw null; } set { } }
-        [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute(System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat)]
+        [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("DateTimeFormat")]
         public string TimestampFormat { get { throw null; } set { } }
         public bool UseUtcTimestamp { get { throw null; } set { } }
     }

diff --git a/src/libraries/System.ComponentModel.Annotations/ref/System.ComponentModel.Annotations.cs b/src/libraries/System.ComponentModel.Annotations/ref/System.ComponentModel.Annotations.cs
@@ -235,7 +235,7 @@ public RangeAttribute([System.Diagnostics.CodeAnalysis.DynamicallyAccessedMember
     [System.AttributeUsageAttribute(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
     public partial class RegularExpressionAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute
     {
-        public RegularExpressionAttribute([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute(System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex)] string pattern) { }
+        public RegularExpressionAttribute([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("Regex")] string pattern) { }
         public int MatchTimeoutInMilliseconds { get { throw null; } set { } }
         public System.TimeSpan MatchTimeout { get { throw null; } }
         public string Pattern { get { throw null; } }

diff --git a/src/libraries/System.Console/ref/System.Console.cs b/src/libraries/System.Console/ref/System.Console.cs
@@ -160,10 +160,10 @@ public static void Write(long value) { }
         public static void Write(object? value) { }
         public static void Write(float value) { }
         public static void Write(string? value) { }
-        public static void Write(string format, object? arg0) { }
-        public static void Write(string format, object? arg0, object? arg1) { }
-        public static void Write(string format, object? arg0, object? arg1, object? arg2) { }
-        public static void Write(string format, params object?[]? arg) { }
+        public static void Write([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0) { }
+        public static void Write([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0, object? arg1) { }
+        public static void Write([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0, object? arg1, object? arg2) { }
+        public static void Write([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, params object?[]? arg) { }
         [System.CLSCompliantAttribute(false)]
         public static void Write(uint value) { }
         [System.CLSCompliantAttribute(false)]
@@ -180,10 +180,10 @@ public static void WriteLine(long value) { }
         public static void WriteLine(object? value) { }
         public static void WriteLine(float value) { }
         public static void WriteLine(string? value) { }
-        public static void WriteLine(string format, object? arg0) { }
-        public static void WriteLine(string format, object? arg0, object? arg1) { }
-        public static void WriteLine(string format, object? arg0, object? arg1, object? arg2) { }
-        public static void WriteLine(string format, params object?[]? arg) { }
+        public static void WriteLine([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0) { }
+        public static void WriteLine([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0, object? arg1) { }
+        public static void WriteLine([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, object? arg0, object? arg1, object? arg2) { }
+        public static void WriteLine([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, params object?[]? arg) { }
         [System.CLSCompliantAttribute(false)]
         public static void WriteLine(uint value) { }
         [System.CLSCompliantAttribute(false)]

diff --git a/src/libraries/System.Console/src/System/Console.cs b/src/libraries/System.Console/src/System/Console.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
@@ -808,25 +809,25 @@ public static void WriteLine(string? value)
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void WriteLine(string format, object? arg0)
+        public static void WriteLine([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0)
         {
             Out.WriteLine(format, arg0);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void WriteLine(string format, object? arg0, object? arg1)
+        public static void WriteLine([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0, object? arg1)
         {
             Out.WriteLine(format, arg0, arg1);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void WriteLine(string format, object? arg0, object? arg1, object? arg2)
+        public static void WriteLine([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0, object? arg1, object? arg2)
         {
             Out.WriteLine(format, arg0, arg1, arg2);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void WriteLine(string format, params object?[]? arg)
+        public static void WriteLine([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, params object?[]? arg)
         {
             if (arg == null)                       // avoid ArgumentNullException from String.Format
                 Out.WriteLine(format, null, null); // faster than Out.WriteLine(format, (Object)arg);
@@ -835,25 +836,25 @@ public static void WriteLine(string format, params object?[]? arg)
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void Write(string format, object? arg0)
+        public static void Write([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0)
         {
             Out.Write(format, arg0);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void Write(string format, object? arg0, object? arg1)
+        public static void Write([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0, object? arg1)
         {
             Out.Write(format, arg0, arg1);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void Write(string format, object? arg0, object? arg1, object? arg2)
+        public static void Write([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, object? arg0, object? arg1, object? arg2)
         {
             Out.Write(format, arg0, arg1, arg2);
         }
 
         [MethodImplAttribute(MethodImplOptions.NoInlining)]
-        public static void Write(string format, params object?[]? arg)
+        public static void Write([StringSyntax(StringSyntaxAttribute.CompositeFormat)] string format, params object?[]? arg)
         {
             if (arg == null)                   // avoid ArgumentNullException from String.Format
                 Out.Write(format, null, null); // faster than Out.Write(format, (Object)arg);

diff --git a/...tem.Diagnostics.TextWriterTraceListener/ref/System.Diagnostics.TextWriterTraceListener.cs b/...tem.Diagnostics.TextWriterTraceListener/ref/System.Diagnostics.TextWriterTraceListener.cs
@@ -25,7 +25,7 @@ public DelimitedListTraceListener(string? fileName, string? name) { }
         public override void TraceData(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, object? data) { }
         public override void TraceData(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, params object?[]? data) { }
         public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? message) { }
-        public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? format, params object?[]? args) { }
+        public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? format, params object?[]? args) { }
     }
     public partial class TextWriterTraceListener : System.Diagnostics.TraceListener
     {
@@ -56,7 +56,7 @@ public override void Fail(string? message, string? detailMessage) { }
         public override void TraceData(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, object? data) { }
         public override void TraceData(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, params object?[]? data) { }
         public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? message) { }
-        public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? format, params object?[]? args) { }
+        public override void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? format, params object?[]? args) { }
         public override void TraceTransfer(System.Diagnostics.TraceEventCache? eventCache, string source, int id, string? message, System.Guid relatedActivityId) { }
         public override void Write(string? message) { }
         public override void WriteLine(string? message) { }

diff --git a/....Diagnostics.TextWriterTraceListener/src/System/Diagnostics/DelimitedListTraceListener.cs b/....Diagnostics.TextWriterTraceListener/src/System/Diagnostics/DelimitedListTraceListener.cs
@@ -1,10 +1,11 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Text;
-using System.Globalization;
-using System.IO;
 using System.Collections;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Globalization;
+using System.Text;
 
 namespace System.Diagnostics
 {
@@ -82,7 +83,7 @@ public string Delimiter
         // warning would be hitted.
         protected override string[] GetSupportedAttributes() => new string[] { DelimiterKey };
 
-        public override void TraceEvent(TraceEventCache? eventCache, string source, TraceEventType eventType, int id, string? format, params object?[]? args)
+        public override void TraceEvent(TraceEventCache? eventCache, string source, TraceEventType eventType, int id, [StringSyntax(StringSyntaxAttribute.CompositeFormat)] string? format, params object?[]? args)
         {
             if (Filter != null && !Filter.ShouldTrace(eventCache, source, eventType, id, format, args, null, null))
                 return;

diff --git a/...stem.Diagnostics.TextWriterTraceListener/src/System/Diagnostics/XmlWriterTraceListener.cs b/...stem.Diagnostics.TextWriterTraceListener/src/System/Diagnostics/XmlWriterTraceListener.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Runtime.Versioning;
@@ -84,7 +85,7 @@ public override void Fail(string? message, string? detailMessage)
             }));
         }
 
-        public override void TraceEvent(TraceEventCache? eventCache, string source, TraceEventType eventType, int id, string? format, params object?[]? args)
+        public override void TraceEvent(TraceEventCache? eventCache, string source, TraceEventType eventType, int id, [StringSyntax(StringSyntaxAttribute.CompositeFormat)] string? format, params object?[]? args)
         {
             if (Filter != null && !Filter.ShouldTrace(eventCache, source, eventType, id, format, args, null, null))
                 return;

diff --git a/src/libraries/System.Diagnostics.TraceSource/ref/System.Diagnostics.TraceSource.cs b/src/libraries/System.Diagnostics.TraceSource/ref/System.Diagnostics.TraceSource.cs
@@ -37,13 +37,13 @@ public partial class EventTypeFilter : System.Diagnostics.TraceFilter
     {
         public EventTypeFilter(System.Diagnostics.SourceLevels level) { }
         public System.Diagnostics.SourceLevels EventType { get { throw null; } set { } }
-        public override bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, string? formatOrMessage, object?[]? args, object? data1, object?[]? data) { throw null; }
+        public override bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? formatOrMessage, object?[]? args, object? data1, object?[]? data) { throw null; }
     }
     public partial class SourceFilter : System.Diagnostics.TraceFilter
     {
         public SourceFilter(string source) { }
         public string Source { get { throw null; } set { } }
-        public override bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, string? formatOrMessage, object?[]? args, object? data1, object?[]? data) { throw null; }
+        public override bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? formatOrMessage, object?[]? args, object? data1, object?[]? data) { throw null; }
     }
     [System.FlagsAttribute]
     public enum SourceLevels
@@ -124,15 +124,15 @@ public static void Refresh() { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public static void TraceError(string? message) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
-        public static void TraceError(string format, params object?[]? args) { }
+        public static void TraceError([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, params object?[]? args) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public static void TraceInformation(string? message) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
-        public static void TraceInformation(string format, params object?[]? args) { }
+        public static void TraceInformation([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, params object?[]? args) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public static void TraceWarning(string? message) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
-        public static void TraceWarning(string format, params object?[]? args) { }
+        public static void TraceWarning([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string format, params object?[]? args) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public static void Unindent() { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
@@ -194,7 +194,7 @@ public enum TraceEventType
     public abstract partial class TraceFilter
     {
         protected TraceFilter() { }
-        public abstract bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, string? formatOrMessage, object?[]? args, object? data1, object?[]? data);
+        public abstract bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? formatOrMessage, object?[]? args, object? data1, object?[]? data);
     }
     public enum TraceLevel
     {
@@ -228,7 +228,7 @@ public virtual void TraceData(System.Diagnostics.TraceEventCache? eventCache, st
         public virtual void TraceData(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, params object?[]? data) { }
         public virtual void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id) { }
         public virtual void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? message) { }
-        public virtual void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, string? format, params object?[]? args) { }
+        public virtual void TraceEvent(System.Diagnostics.TraceEventCache? eventCache, string source, System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? format, params object?[]? args) { }
         public virtual void TraceTransfer(System.Diagnostics.TraceEventCache? eventCache, string source, int id, string? message, System.Guid relatedActivityId) { }
         public virtual void Write(object? o) { }
         public virtual void Write(object? o, string? category) { }
@@ -301,11 +301,11 @@ public void TraceEvent(System.Diagnostics.TraceEventType eventType, int id) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public void TraceEvent(System.Diagnostics.TraceEventType eventType, int id, string? message) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
-        public void TraceEvent(System.Diagnostics.TraceEventType eventType, int id, string? format, params object?[]? args) { }
+        public void TraceEvent(System.Diagnostics.TraceEventType eventType, int id, [System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? format, params object?[]? args) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public void TraceInformation(string? message) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
-        public void TraceInformation(string? format, params object?[]? args) { }
+        public void TraceInformation([System.Diagnostics.CodeAnalysis.StringSyntaxAttribute("CompositeFormat")] string? format, params object?[]? args) { }
         [System.Diagnostics.ConditionalAttribute("TRACE")]
         public void TraceTransfer(int id, string? message, System.Guid relatedActivityId) { }
     }

diff --git a/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/SeverityFilter.cs b/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/SeverityFilter.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace System.Diagnostics
 {
@@ -14,7 +15,7 @@ public EventTypeFilter(SourceLevels level)
             _level = level;
         }
 
-        public override bool ShouldTrace(TraceEventCache? cache, string source, TraceEventType eventType, int id, string? formatOrMessage,
+        public override bool ShouldTrace(TraceEventCache? cache, string source, TraceEventType eventType, int id, [StringSyntax(StringSyntaxAttribute.CompositeFormat)] string? formatOrMessage,
                                          object?[]? args, object? data1, object?[]? data)
         {
             return ((int)eventType & (int)_level) != 0;

diff --git a/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/SourceFilter.cs b/src/libraries/System.Diagnostics.TraceSource/src/System/Diagnostics/SourceFilter.cs
@@ -16,7 +16,7 @@ public SourceFilter(string source)
             Source = source;
         }
 
-        public override bool ShouldTrace(TraceEventCache? cache, string source!!, TraceEventType eventType, int id, string? formatOrMessage,
+        public override bool ShouldTrace(TraceEventCache? cache, string source!!, TraceEventType eventType, int id, [StringSyntax(StringSyntaxAttribute.CompositeFormat)] string? formatOrMessage,
                                          object?[]? args, object? data1, object?[]? data)
         {
             return string.Equals(_src, source);