Added [GeneratedCode] attribute to some generators, refactoring

Author: Sergio0694

Microsoft.Toolkit.Mvvm.SourceGenerators/ComponentModel/TransitiveMembersGenerator.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using System.CodeDom.Compiler;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Diagnostics.Contracts;
@@ -107,15 +108,19 @@ private void OnExecute(
         {
             ClassDeclarationSyntax sourceDeclaration = sourceSyntaxTree.GetRoot().DescendantNodes().OfType<ClassDeclarationSyntax>().First();
             UsingDirectiveSyntax[] usingDirectives = sourceSyntaxTree.GetRoot().DescendantNodes().OfType<UsingDirectiveSyntax>().ToArray();
+            BaseListSyntax? baseListSyntax = BaseList(SeparatedList(
+                sourceDeclaration.BaseList?.Types
+                .OfType<SimpleBaseTypeSyntax>()
+                .Select(static t => t.Type)
+                .OfType<IdentifierNameSyntax>()
+                .Where(static t => t.Identifier.ValueText.StartsWith("I"))
+                .Select(static t => SimpleBaseType(t))
+                .ToArray()
+                ?? Array.Empty<BaseTypeSyntax>()));
 
-            IEnumerable<MemberDeclarationSyntax> generatedMembers = FilterDeclaredMembers(context, attributeData, classDeclaration, classDeclarationSymbol, sourceDeclaration);
-
-            // If the target class is sealed, make protected members private and remove the virtual modifier
-            if (classDeclarationSymbol.IsSealed)
+            if (baseListSyntax.Types.Count == 0)
             {
-                generatedMembers = generatedMembers.Select(static member => member
-                    .ReplaceModifier(SyntaxKind.ProtectedKeyword, SyntaxKind.PrivateKeyword)
-                    .RemoveModifier(SyntaxKind.VirtualKeyword));
+                baseListSyntax = null;
             }
 
             // Create the class declaration for the user type. This will produce a tree as follows:
@@ -127,8 +132,8 @@ private void OnExecute(
             var classDeclarationSyntax =
                 ClassDeclaration(classDeclaration.Identifier.Text)
                 .WithModifiers(classDeclaration.Modifiers)
-                .WithBaseList(sourceDeclaration.BaseList)
-                .AddMembers(generatedMembers.ToArray());
+                .WithBaseList(baseListSyntax)
+                .AddMembers(OnLoadDeclaredMembers(context, attributeData, classDeclaration, classDeclarationSymbol, sourceDeclaration).ToArray());
 
             TypeDeclarationSyntax typeDeclarationSyntax = classDeclarationSyntax;
 
@@ -152,14 +157,69 @@ private void OnExecute(
                 CompilationUnit()
                 .AddMembers(NamespaceDeclaration(IdentifierName(namespaceName))
                 .AddMembers(typeDeclarationSyntax))
-                .AddUsings(usingDirectives)
+                .AddUsings(usingDirectives.ToArray())
                 .NormalizeWhitespace()
                 .ToFullString();
 
             // Add the partial type
             context.AddSource($"[{typeof(TAttribute).Name}]_[{classDeclarationSymbol.GetFullMetadataNameForFileName()}].cs", SourceText.From(source, Encoding.UTF8));
         }
 
+        /// <summary>
+        /// Loads the <see cref="MemberDeclarationSyntax"/> nodes to generate from the input parsed tree.
+        /// </summary>
+        /// <param name="context">The input <see cref="GeneratorExecutionContext"/> instance to use.</param>
+        /// <param name="attributeData">The <see cref="AttributeData"/> for the current attribute being processed.</param>
+        /// <param name="classDeclaration">The <see cref="ClassDeclarationSyntax"/> node to process.</param>
+        /// <param name="classDeclarationSymbol">The <see cref="INamedTypeSymbol"/> for <paramref name="classDeclaration"/>.</param>
+        /// <param name="sourceDeclaration">The parsed <see cref="ClassDeclarationSyntax"/> instance with the source nodes.</param>
+        /// <returns>A sequence of <see cref="MemberDeclarationSyntax"/> nodes to emit in the generated file.</returns>
+        private IEnumerable<MemberDeclarationSyntax> OnLoadDeclaredMembers(
+            GeneratorExecutionContext context,
+            AttributeData attributeData,
+            ClassDeclarationSyntax classDeclaration,
+            INamedTypeSymbol classDeclarationSymbol,
+            ClassDeclarationSyntax sourceDeclaration)
+        {
+            IEnumerable<MemberDeclarationSyntax> generatedMembers = FilterDeclaredMembers(context, attributeData, classDeclaration, classDeclarationSymbol, sourceDeclaration);
+
+            // Add the attributes on each member
+            return generatedMembers.Select(member =>
+            {
+                // [GeneratedCode] is always present
+                member = member
+                    .WithoutLeadingTrivia()
+                    .AddAttributeLists(AttributeList(SingletonSeparatedList(
+                        Attribute(IdentifierName($"global::System.CodeDom.Compiler.GeneratedCode"))
+                        .AddArgumentListArguments(
+                            AttributeArgument(LiteralExpression(SyntaxKind.StringLiteralExpression, Literal(GetType().FullName))),
+                            AttributeArgument(LiteralExpression(SyntaxKind.StringLiteralExpression, Literal(GetType().Assembly.GetName().Version.ToString())))))))
+                    .WithLeadingTrivia(member.GetLeadingTrivia());
+
+                // [DebuggerNonUserCode] is not supported over interfaces, events or fields
+                if (member.Kind() is not SyntaxKind.InterfaceDeclaration and not SyntaxKind.EventFieldDeclaration and not SyntaxKind.FieldDeclaration)
+                {
+                    member = member.AddAttributeLists(AttributeList(SingletonSeparatedList(Attribute(IdentifierName("global::System.Diagnostics.DebuggerNonUserCode")))));
+                }
+
+                // [ExcludeFromCodeCoverage] is not supported on interfaces and fields
+                if (member.Kind() is not SyntaxKind.InterfaceDeclaration and not SyntaxKind.FieldDeclaration)
+                {
+                    member = member.AddAttributeLists(AttributeList(SingletonSeparatedList(Attribute(IdentifierName("global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage")))));
+                }
+
+                // If the target class is sealed, make protected members private and remove the virtual modifier
+                if (classDeclarationSymbol.IsSealed)
+                {
+                    return member
+                        .ReplaceModifier(SyntaxKind.ProtectedKeyword, SyntaxKind.PrivateKeyword)
+                        .RemoveModifier(SyntaxKind.VirtualKeyword);
+                }
+
+                return member;
+            });
+        }
+
         /// <summary>
         /// Validates a target type being processed.
         /// </summary>

Microsoft.Toolkit.Mvvm.SourceGenerators/EmbeddedResources/INotifyPropertyChanged.cs

@@ -7,8 +7,6 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 
@@ -20,15 +18,12 @@ namespace Microsoft.Toolkit.Mvvm.ComponentModel
     public abstract class NotifyPropertyChanged : INotifyPropertyChanged
     {
         /// <inheritdoc cref="INotifyPropertyChanged.PropertyChanged"/>
-        [ExcludeFromCodeCoverage]
         public event PropertyChangedEventHandler? PropertyChanged;
 
         /// <summary>
         /// Raises the <see cref="PropertyChanged"/> event.
         /// </summary>
         /// <param name="e">The input <see cref="PropertyChangedEventArgs"/> instance.</param>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
         {
             PropertyChanged?.Invoke(this, e);
@@ -38,8 +33,6 @@ protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
         /// Raises the <see cref="PropertyChanged"/> event.
         /// </summary>
         /// <param name="propertyName">(optional) The name of the property that changed.</param>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected void OnPropertyChanged([CallerMemberName] string? propertyName = null)
         {
             OnPropertyChanged(new PropertyChangedEventArgs(propertyName));
@@ -57,8 +50,6 @@ protected void OnPropertyChanged([CallerMemberName] string? propertyName = null)
         /// <remarks>
         /// The <see cref="PropertyChanged"/> event is not raised if the current and new value for the target property are the same.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<T>(ref T field, T newValue, [CallerMemberName] string? propertyName = null)
         {
             if (EqualityComparer<T>.Default.Equals(field, newValue))
@@ -84,8 +75,6 @@ protected bool SetProperty<T>(ref T field, T newValue, [CallerMemberName] string
         /// <param name="comparer">The <see cref="IEqualityComparer{T}"/> instance to use to compare the input values.</param>
         /// <param name="propertyName">(optional) The name of the property that changed.</param>
         /// <returns><see langword="true"/> if the property was changed, <see langword="false"/> otherwise.</returns>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<T>(ref T field, T newValue, IEqualityComparer<T> comparer, [CallerMemberName] string? propertyName = null)
         {
             if (comparer.Equals(field, newValue))
@@ -121,8 +110,6 @@ protected bool SetProperty<T>(ref T field, T newValue, IEqualityComparer<T> comp
         /// <remarks>
         /// The <see cref="PropertyChanged"/> event is not raised if the current and new value for the target property are the same.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<T>(T oldValue, T newValue, Action<T> callback, [CallerMemberName] string? propertyName = null)
         {
             if (EqualityComparer<T>.Default.Equals(oldValue, newValue))
@@ -149,8 +136,6 @@ protected bool SetProperty<T>(T oldValue, T newValue, Action<T> callback, [Calle
         /// <param name="callback">A callback to invoke to update the property value.</param>
         /// <param name="propertyName">(optional) The name of the property that changed.</param>
         /// <returns><see langword="true"/> if the property was changed, <see langword="false"/> otherwise.</returns>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<T>(T oldValue, T newValue, IEqualityComparer<T> comparer, Action<T> callback, [CallerMemberName] string? propertyName = null)
         {
             if (comparer.Equals(oldValue, newValue))
@@ -217,8 +202,6 @@ protected bool SetProperty<T>(T oldValue, T newValue, IEqualityComparer<T> compa
         /// <remarks>
         /// The <see cref="PropertyChanged"/> event is not raised if the current and new value for the target property are the same.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<TModel, T>(T oldValue, T newValue, TModel model, Action<TModel, T> callback, [CallerMemberName] string? propertyName = null)
             where TModel : class
         {
@@ -250,8 +233,6 @@ protected bool SetProperty<TModel, T>(T oldValue, T newValue, TModel model, Acti
         /// <param name="callback">The callback to invoke to set the target property value, if a change has occurred.</param>
         /// <param name="propertyName">(optional) The name of the property that changed.</param>
         /// <returns><see langword="true"/> if the property was changed, <see langword="false"/> otherwise.</returns>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetProperty<TModel, T>(T oldValue, T newValue, IEqualityComparer<T> comparer, TModel model, Action<TModel, T> callback, [CallerMemberName] string? propertyName = null)
             where TModel : class
         {
@@ -299,8 +280,6 @@ protected bool SetProperty<TModel, T>(T oldValue, T newValue, IEqualityComparer<
         /// <paramref name="taskNotifier"/> is different than the previous one, and it does not mean the new
         /// <see cref="Task"/> instance passed as argument is in any particular state.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetPropertyAndNotifyOnCompletion(ref TaskNotifier? taskNotifier, Task? newValue, [CallerMemberName] string? propertyName = null)
         {
             return SetPropertyAndNotifyOnCompletion(taskNotifier ??= new(), newValue, static _ => { }, propertyName);
@@ -321,8 +300,6 @@ protected bool SetPropertyAndNotifyOnCompletion(ref TaskNotifier? taskNotifier,
         /// <remarks>
         /// The <see cref="PropertyChanged"/> event is not raised if the current and new value for the target property are the same.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetPropertyAndNotifyOnCompletion(ref TaskNotifier? taskNotifier, Task? newValue, Action<Task?> callback, [CallerMemberName] string? propertyName = null)
         {
             return SetPropertyAndNotifyOnCompletion(taskNotifier ??= new(), newValue, callback, propertyName);
@@ -361,8 +338,6 @@ protected bool SetPropertyAndNotifyOnCompletion(ref TaskNotifier? taskNotifier,
         /// <paramref name="taskNotifier"/> is different than the previous one, and it does not mean the new
         /// <see cref="Task{TResult}"/> instance passed as argument is in any particular state.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetPropertyAndNotifyOnCompletion<T>(ref TaskNotifier<T>? taskNotifier, Task<T>? newValue, [CallerMemberName] string? propertyName = null)
         {
             return SetPropertyAndNotifyOnCompletion(taskNotifier ??= new(), newValue, static _ => { }, propertyName);
@@ -384,8 +359,6 @@ protected bool SetPropertyAndNotifyOnCompletion<T>(ref TaskNotifier<T>? taskNoti
         /// <remarks>
         /// The <see cref="PropertyChanged"/> event is not raised if the current and new value for the target property are the same.
         /// </remarks>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected bool SetPropertyAndNotifyOnCompletion<T>(ref TaskNotifier<T>? taskNotifier, Task<T>? newValue, Action<Task<T>?> callback, [CallerMemberName] string? propertyName = null)
         {
             return SetPropertyAndNotifyOnCompletion(taskNotifier ??= new(), newValue, callback, propertyName);
@@ -400,8 +373,6 @@ protected bool SetPropertyAndNotifyOnCompletion<T>(ref TaskNotifier<T>? taskNoti
         /// <param name="callback">A callback to invoke to update the property value.</param>
         /// <param name="propertyName">(optional) The name of the property that changed.</param>
         /// <returns><see langword="true"/> if the property was changed, <see langword="false"/> otherwise.</returns>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         private bool SetPropertyAndNotifyOnCompletion<TTask>(ITaskNotifier<TTask> taskNotifier, TTask? newValue, Action<TTask?> callback, [CallerMemberName] string? propertyName = null)
             where TTask : Task
         {
@@ -456,16 +427,12 @@ private interface ITaskNotifier<TTask>
             /// <summary>
             /// Gets or sets the wrapped <typeparamref name="TTask"/> value.
             /// </summary>
-            [DebuggerNonUserCode]
-            [ExcludeFromCodeCoverage]
             TTask? Task { get; set; }
         }
 
         /// <summary>
         /// A wrapping class that can hold a <see cref="Task"/> value.
         /// </summary>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected sealed class TaskNotifier : ITaskNotifier<Task>
         {
             /// <summary>
@@ -498,8 +465,6 @@ internal TaskNotifier()
         /// A wrapping class that can hold a <see cref="Task{T}"/> value.
         /// </summary>
         /// <typeparam name="T">The type of value for the wrapped <see cref="Task{T}"/> instance.</typeparam>
-        [DebuggerNonUserCode]
-        [ExcludeFromCodeCoverage]
         protected sealed class TaskNotifier<T> : ITaskNotifier<Task<T>>
         {
             /// <summary>