Merge pull request #460 from CommunityToolkit/dev/generator-improvements

More MVVM Toolkit generator improvements

CommunityToolkit.Mvvm.SourceGenerators/CommunityToolkit.Mvvm.SourceGenerators.projitems

@@ -54,10 +54,10 @@
  <Compile Include="$(MSBuildThisFileDirectory)Diagnostics\Analyzers\UnsupportedCSharpLanguageVersionAnalyzer.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Diagnostics\Suppressors\ObservablePropertyAttributeWithPropertyTargetDiagnosticSuppressor.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Diagnostics\DiagnosticDescriptors.cs" />
- <Compile Include="$(MSBuildThisFileDirectory)Diagnostics\DiagnosticExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Diagnostics\SuppressionDescriptors.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\AttributeDataExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\CompilationExtensions.cs" />
+ <Compile Include="$(MSBuildThisFileDirectory)Extensions\DiagnosticsExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\HashCodeExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\IEqualityComparerExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\INamedTypeSymbolExtensions.cs" />
@@ -70,13 +70,16 @@
  <Compile Include="$(MSBuildThisFileDirectory)Extensions\TypeDeclarationSyntaxExtensions.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Helpers\Comparer{T,TSelf}.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Helpers\HashCode.cs" />
+ <Compile Include="$(MSBuildThisFileDirectory)Helpers\ImmutableArrayBuilder{T}.cs" />
+ <Compile Include="$(MSBuildThisFileDirectory)Helpers\ObjectPool{T}.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Input\Models\CanExecuteExpressionType.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Input\Models\CommandInfo.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Input\RelayCommandGenerator.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Input\RelayCommandGenerator.Execute.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Messaging\IMessengerRegisterAllGenerator.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Messaging\IMessengerRegisterAllGenerator.Execute.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Messaging\Models\RecipientInfo.cs" />
+ <Compile Include="$(MSBuildThisFileDirectory)Models\DiagnosticInfo.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Models\HierarchyInfo.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Models\HierarchyInfo.Syntax.cs" />
  <Compile Include="$(MSBuildThisFileDirectory)Models\Result.cs" />

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/INotifyPropertyChangedGenerator.cs

@@ -4,9 +4,10 @@
 
 using System.Collections.Immutable;
 using System.Linq;
-using CommunityToolkit.Mvvm.SourceGenerators.Diagnostics;
 using CommunityToolkit.Mvvm.SourceGenerators.Extensions;
+using CommunityToolkit.Mvvm.SourceGenerators.Helpers;
 using CommunityToolkit.Mvvm.SourceGenerators.Input.Models;
+using CommunityToolkit.Mvvm.SourceGenerators.Models;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using static CommunityToolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
@@ -28,16 +29,16 @@ public INotifyPropertyChangedGenerator()
  }
 
  /// <inheritdoc/>
- protected override INotifyPropertyChangedInfo? ValidateTargetTypeAndGetInfo(INamedTypeSymbol typeSymbol, AttributeData attributeData, Compilation compilation, out ImmutableArray<Diagnostic> diagnostics)
+ private protected override INotifyPropertyChangedInfo? ValidateTargetTypeAndGetInfo(INamedTypeSymbol typeSymbol, AttributeData attributeData, Compilation compilation, out ImmutableArray<DiagnosticInfo> diagnostics)
  {
- ImmutableArray<Diagnostic>.Builder builder = ImmutableArray.CreateBuilder<Diagnostic>();
+ diagnostics = ImmutableArray<DiagnosticInfo>.Empty;
 
  INotifyPropertyChangedInfo? info = null;
 
  // Check if the type already implements INotifyPropertyChanged
  if (typeSymbol.AllInterfaces.Any(i => i.HasFullyQualifiedName("global::System.ComponentModel.INotifyPropertyChanged")))
  {
- builder.Add(DuplicateINotifyPropertyChangedInterfaceForINotifyPropertyChangedAttributeError, typeSymbol, typeSymbol);
+ diagnostics = ImmutableArray.Create(DiagnosticInfo.Create(DuplicateINotifyPropertyChangedInterfaceForINotifyPropertyChangedAttributeError, typeSymbol, typeSymbol));
 
  goto End;
  }
@@ -46,7 +47,7 @@ public INotifyPropertyChangedGenerator()
  if (typeSymbol.HasOrInheritsAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.ObservableObjectAttribute") ||
  typeSymbol.InheritsAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.INotifyPropertyChangedAttribute"))
  {
- builder.Add(InvalidAttributeCombinationForINotifyPropertyChangedAttributeError, typeSymbol, typeSymbol);
+ diagnostics = ImmutableArray.Create(DiagnosticInfo.Create(InvalidAttributeCombinationForINotifyPropertyChangedAttributeError, typeSymbol, typeSymbol));
 
  goto End;
  }
@@ -56,8 +57,6 @@ public INotifyPropertyChangedGenerator()
  info = new INotifyPropertyChangedInfo(includeAdditionalHelperMethods);
 
  End:
- diagnostics = builder.ToImmutable();
-
  return info;
  }
 
@@ -67,9 +66,17 @@ protected override ImmutableArray<MemberDeclarationSyntax> FilterDeclaredMembers
  // If requested, only include the event and the basic methods to raise it, but not the additional helpers
  if (!info.IncludeAdditionalHelperMethods)
  {
- return memberDeclarations.Where(static member => member
- is EventFieldDeclarationSyntax
- or MethodDeclarationSyntax { Identifier.ValueText: "OnPropertyChanged" }).ToImmutableArray();
+ using ImmutableArrayBuilder<MemberDeclarationSyntax> selectedMembers = ImmutableArrayBuilder<MemberDeclarationSyntax>.Rent();
+
+ foreach (MemberDeclarationSyntax memberDeclaration in memberDeclarations)
+ {
+ if (memberDeclaration is EventFieldDeclarationSyntax or MethodDeclarationSyntax { Identifier.ValueText: "OnPropertyChanged" })
+ {
+ selectedMembers.Add(memberDeclaration);
+ }
+ }
+
+ return selectedMembers.ToImmutable();
  }
 
  return memberDeclarations;

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/Models/AttributeInfo.cs

@@ -32,23 +32,24 @@ public static AttributeInfo From(AttributeData attributeData)
  {
  string typeName = attributeData.AttributeClass!.GetFullyQualifiedName();
 
+ using ImmutableArrayBuilder<TypedConstantInfo> constructorArguments = ImmutableArrayBuilder<TypedConstantInfo>.Rent();
+ using ImmutableArrayBuilder<(string, TypedConstantInfo)> namedArguments = ImmutableArrayBuilder<(string, TypedConstantInfo)>.Rent();
+
  // Get the constructor arguments
- ImmutableArray<TypedConstantInfo> constructorArguments =
-  attributeData.ConstructorArguments
- .Select(TypedConstantInfo.From)
-  .ToImmutableArray();
+ foreach (TypedConstant typedConstant in attributeData.ConstructorArguments)
+ {
+ constructorArguments.Add(TypedConstantInfo.From(typedConstant));
+ }
 
  // Get the named arguments
- ImmutableArray<(string, TypedConstantInfo)>.Builder namedArguments = ImmutableArray.CreateBuilder<(string, TypedConstantInfo)>();
-
- foreach (KeyValuePair<string, TypedConstant> arg in attributeData.NamedArguments)
+ foreach (KeyValuePair<string, TypedConstant> namedConstant in attributeData.NamedArguments)
  {
- namedArguments.Add((arg.Key, TypedConstantInfo.From(arg.Value)));
+ namedArguments.Add((namedConstant.Key, TypedConstantInfo.From(namedConstant.Value)));
  }
 
  return new(
  typeName,
- constructorArguments,
+ constructorArguments.ToImmutable(),
  namedArguments.ToImmutable());
  }
 
@@ -64,8 +65,8 @@ public static AttributeInfo From(INamedTypeSymbol typeSymbol, SemanticModel sema
  {
  string typeName = typeSymbol.GetFullyQualifiedName();
 
- ImmutableArray<TypedConstantInfo>.Builder constructorArguments = ImmutableArray.CreateBuilder<TypedConstantInfo>();
- ImmutableArray<(string, TypedConstantInfo)>.Builder namedArguments = ImmutableArray.CreateBuilder<(string, TypedConstantInfo)>();
+ using ImmutableArrayBuilder<TypedConstantInfo> constructorArguments = ImmutableArrayBuilder<TypedConstantInfo>.Rent();
+ using ImmutableArrayBuilder<(string, TypedConstantInfo)> namedArguments = ImmutableArrayBuilder<(string, TypedConstantInfo)>.Rent();
 
  foreach (AttributeArgumentSyntax argument in arguments)
  {

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/Models/TypedConstantInfo.Factory.cs

@@ -6,6 +6,7 @@
 using System.Collections.Immutable;
 using System.Linq;
 using System.Threading;
+using CommunityToolkit.Mvvm.SourceGenerators.Helpers;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Operations;
@@ -127,7 +128,7 @@ public static TypedConstantInfo From(
  return new Array(elementTypeName, ImmutableArray<TypedConstantInfo>.Empty);
  }
 
- ImmutableArray<TypedConstantInfo>.Builder items = ImmutableArray.CreateBuilder<TypedConstantInfo>(initializerExpression.Expressions.Count);
+ using ImmutableArrayBuilder<TypedConstantInfo> items = ImmutableArrayBuilder<TypedConstantInfo>.Rent();
 
  // Enumerate all array elements and extract serialized info for them
  foreach (ExpressionSyntax initializationExpression in initializerExpression.Expressions)
@@ -140,7 +141,7 @@ public static TypedConstantInfo From(
  items.Add(From(initializationOperation, semanticModel, initializationExpression, token));
  }
 
- return new Array(elementTypeName, items.MoveToImmutable());
+ return new Array(elementTypeName, items.ToImmutable());
  }
 
  throw new ArgumentException("Invalid attribute argument value");

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/Models/ValidationInfo.cs

@@ -22,10 +22,16 @@ internal sealed record ValidationInfo(
  string TypeName,
  ImmutableArray<string> PropertyNames)
 {
+ /// <inheritdoc/>
+ public bool Equals(ValidationInfo? obj) => Comparer.Default.Equals(this, obj);
+
+ /// <inheritdoc/>
+ public override int GetHashCode() => Comparer.Default.GetHashCode(this);
+
  /// <summary>
  /// An <see cref="IEqualityComparer{T}"/> implementation for <see cref="ValidationInfo"/>.
  /// </summary>
- public sealed class Comparer : Comparer<ValidationInfo, Comparer>
+ private sealed class Comparer : Comparer<ValidationInfo, Comparer>
  {
  /// <inheritdoc/>
  protected override void AddToHashCode(ref HashCode hashCode, ValidationInfo obj)

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/ObservableObjectGenerator.cs

@@ -4,8 +4,8 @@
 
 using System.Collections.Immutable;
 using System.Linq;
-using CommunityToolkit.Mvvm.SourceGenerators.Diagnostics;
 using CommunityToolkit.Mvvm.SourceGenerators.Extensions;
+using CommunityToolkit.Mvvm.SourceGenerators.Models;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using static CommunityToolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
@@ -27,22 +27,22 @@ public ObservableObjectGenerator()
  }
 
  /// <inheritdoc/>
- protected override object? ValidateTargetTypeAndGetInfo(INamedTypeSymbol typeSymbol, AttributeData attributeData, Compilation compilation, out ImmutableArray<Diagnostic> diagnostics)
+ private protected override object? ValidateTargetTypeAndGetInfo(INamedTypeSymbol typeSymbol, AttributeData attributeData, Compilation compilation, out ImmutableArray<DiagnosticInfo> diagnostics)
  {
- ImmutableArray<Diagnostic>.Builder builder = ImmutableArray.CreateBuilder<Diagnostic>();
+ diagnostics = ImmutableArray<DiagnosticInfo>.Empty;
 
  // Check if the type already implements INotifyPropertyChanged...
  if (typeSymbol.AllInterfaces.Any(i => i.HasFullyQualifiedName("global::System.ComponentModel.INotifyPropertyChanged")))
  {
- builder.Add(DuplicateINotifyPropertyChangedInterfaceForObservableObjectAttributeError, typeSymbol, typeSymbol);
+ diagnostics = ImmutableArray.Create(DiagnosticInfo.Create(DuplicateINotifyPropertyChangedInterfaceForObservableObjectAttributeError, typeSymbol, typeSymbol));
 
  goto End;
  }
 
  // ...or INotifyPropertyChanging
  if (typeSymbol.AllInterfaces.Any(i => i.HasFullyQualifiedName("global::System.ComponentModel.INotifyPropertyChanging")))
  {
- builder.Add(DuplicateINotifyPropertyChangingInterfaceForObservableObjectAttributeError, typeSymbol, typeSymbol);
+ diagnostics = ImmutableArray.Create(DiagnosticInfo.Create(DuplicateINotifyPropertyChangingInterfaceForObservableObjectAttributeError, typeSymbol, typeSymbol));
 
  goto End;
  }
@@ -51,14 +51,12 @@ public ObservableObjectGenerator()
  if (typeSymbol.InheritsAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.ObservableObjectAttribute") ||
  typeSymbol.HasOrInheritsAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.INotifyPropertyChangedAttribute"))
  {
- builder.Add(InvalidAttributeCombinationForObservableObjectAttributeError, typeSymbol, typeSymbol);
+ diagnostics = ImmutableArray.Create(DiagnosticInfo.Create(InvalidAttributeCombinationForObservableObjectAttributeError, typeSymbol, typeSymbol));
 
  goto End;
  }
 
  End:
- diagnostics = builder.ToImmutable();
-
  return null;
  }