Merge branch 'main' into user/arcadiog/clearReferenceInfo

Author: michael-hawker

.github/PULL_REQUEST_TEMPLATE.md

@@ -38,7 +38,10 @@ What kind of change does this PR introduce?
 Please check if your PR fulfills the following requirements: <!-- and remove the ones that are not applicable to the current PR -->
 
 - [ ] Tested code with current [supported SDKs](../#supported)
-- [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
+- [ ] New component
+  - [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
+  - [ ] Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
+  - [ ] If control, added to Visual Studio Design project
 - [ ] Sample in sample app has been added / updated (for bug fixes / features)
   - [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
 - [ ] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
@@ -51,4 +54,4 @@ Please note that breaking changes are likely to be rejected within minor release
 
 ## Other information
 
-<!-- Please add any other information that might be helpful to reviewers. -->
+<!-- Please add any other information that might be helpful to reviewers. -->

Microsoft.Toolkit.Mvvm.SourceGenerators/AnalyzerReleases.Unshipped.md

@@ -17,3 +17,4 @@ MVVMTK0009 | Microsoft.Toolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator
 MVVMTK0010 | Microsoft.Toolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator | Error | See https://aka.ms/mvvmtoolkit/error
 MVVMTK0011 | Microsoft.Toolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator | Error | See https://aka.ms/mvvmtoolkit/error
 MVVMTK0012 | Microsoft.Toolkit.Mvvm.SourceGenerators.ICommandGenerator | Error | See https://aka.ms/mvvmtoolkit/error
+MVVMTK0013 | Microsoft.CodeAnalysis.CSharp.CSharpParseOptions | Error | See https://aka.ms/mvvmtoolkit/error

Microsoft.Toolkit.Mvvm.SourceGenerators/Attributes/NullabilityAttributesGenerator.cs

@@ -34,7 +34,11 @@ public void Execute(GeneratorExecutionContext context)
         /// </summary>
         private void AddSourceCodeIfTypeIsNotPresent(GeneratorExecutionContext context, string typeFullName)
         {
-            if (context.Compilation.GetTypeByMetadataName(typeFullName) is not null)
+            // Check that the target attributes are not available in the consuming project. To ensure that
+            // this works fine both in .NET (Core) and .NET Standard implementations, we also need to check
+            // that the target types are declared as public (we assume that in this case those types are from the BCL).
+            // This avoids issues on .NET Standard with Roslyn also seeing internal types from referenced assemblies.
+            if (context.Compilation.GetTypeByMetadataName(typeFullName) is { DeclaredAccessibility: Accessibility.Public })
             {
                 return;
             }

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

@@ -41,6 +41,15 @@ public void Execute(GeneratorExecutionContext context)
                 return;
             }
 
+            // Validate the language version. Note that we're emitting this diagnostic in each generator (excluding the one
+            // only emitting the nullability annotation attributes if missing) so that the diagnostic is emitted only when
+            // users are using one of these generators, and not by default as soon as they add a reference to the MVVM Toolkit.
+            // This ensures that users not using any of the source generators won't be broken when upgrading to this new version.
+            if (context.ParseOptions is not CSharpParseOptions { LanguageVersion: >= LanguageVersion.CSharp9 })
+            {
+                context.ReportDiagnostic(Diagnostic.Create(UnsupportedCSharpLanguageVersionError, null));
+            }
+
             // Sets of discovered property names
             HashSet<string>
                 propertyChangedNames = new(),
@@ -240,6 +249,14 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
                 }
             }
 
+            // In case the backing field is exactly named "value", we need to add the "this." prefix to ensure that comparisons and assignments
+            // with it in the generated setter body are executed correctly and without conflicts with the implicit value parameter.
+            ExpressionSyntax fieldExpression = fieldSymbol.Name switch
+            {
+                "value" => MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, ThisExpression(), IdentifierName("value")),
+                string name => IdentifierName(name)
+            };
+
             BlockSyntax setterBlock;
 
             if (validationAttributes.Count > 0)
@@ -263,10 +280,10 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
 
                     // Generate the inner setter block as follows:
                     //
-                    // if (!global::System.Collections.Generic.EqualityComparer<<FIELD_TYPE>>.Default.Equals(<FIELD_NAME>, value))
+                    // if (!global::System.Collections.Generic.EqualityComparer<<FIELD_TYPE>>.Default.Equals(this.<FIELD_NAME>, value))
                     // {
                     //     OnPropertyChanging(global::Microsoft.Toolkit.Mvvm.ComponentModel.__Internals.__KnownINotifyPropertyChangedOrChangingArgs.PropertyNamePropertyChangingEventArgs); // Optional
-                    //     <FIELD_NAME> = value;
+                    //     this.<FIELD_NAME> = value;
                     //     OnPropertyChanged(global::Microsoft.Toolkit.Mvvm.ComponentModel.__Internals.__KnownINotifyPropertyChangedOrChangingArgs.PropertyNamePropertyChangedEventArgs);
                     //     ValidateProperty(value, <PROPERTY_NAME>);
                     //     OnPropertyChanged(global::Microsoft.Toolkit.Mvvm.ComponentModel.__Internals.__KnownINotifyPropertyChangedOrChangingArgs.Property1PropertyChangedEventArgs); // Optional
@@ -291,7 +308,7 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
                                             IdentifierName("Default")),
                                         IdentifierName("Equals")))
                                 .AddArgumentListArguments(
-                                    Argument(IdentifierName(fieldSymbol.Name)),
+                                    Argument(fieldExpression),
                                     Argument(IdentifierName("value")))),
                             Block(
                                 ExpressionStatement(
@@ -303,7 +320,7 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
                                 ExpressionStatement(
                                     AssignmentExpression(
                                         SyntaxKind.SimpleAssignmentExpression,
-                                        IdentifierName(fieldSymbol.Name),
+                                        fieldExpression,
                                         IdentifierName("value"))),
                                 ExpressionStatement(
                                     InvocationExpression(IdentifierName("OnPropertyChanged"))
@@ -346,7 +363,7 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
                     ExpressionStatement(
                         AssignmentExpression(
                             SyntaxKind.SimpleAssignmentExpression,
-                            IdentifierName(fieldSymbol.Name),
+                            fieldExpression,
                             IdentifierName("value"))),
                     ExpressionStatement(
                         InvocationExpression(IdentifierName("OnPropertyChanged"))
@@ -384,7 +401,7 @@ private static PropertyDeclarationSyntax CreatePropertyDeclaration(
                                         IdentifierName("Default")),
                                     IdentifierName("Equals")))
                             .AddArgumentListArguments(
-                                    Argument(IdentifierName(fieldSymbol.Name)),
+                                    Argument(fieldExpression),
                                     Argument(IdentifierName("value")))),
                         updateAndNotificationBlock));
             }

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

@@ -14,6 +14,7 @@
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.Toolkit.Mvvm.SourceGenerators.Extensions;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
+using static Microsoft.Toolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
 
 namespace Microsoft.Toolkit.Mvvm.SourceGenerators
 {
@@ -39,6 +40,12 @@ public void Execute(GeneratorExecutionContext context)
                 return;
             }
 
+            // Validate the language version
+            if (context.ParseOptions is not CSharpParseOptions { LanguageVersion: >= LanguageVersion.CSharp9 })
+            {
+                context.ReportDiagnostic(Diagnostic.Create(UnsupportedCSharpLanguageVersionError, null));
+            }
+
             // Get the symbol for the ValidationAttribute type
             INamedTypeSymbol validationSymbol = context.Compilation.GetTypeByMetadataName("System.ComponentModel.DataAnnotations.ValidationAttribute")!;
 

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

@@ -18,6 +18,7 @@
 using Microsoft.Toolkit.Mvvm.SourceGenerators.Extensions;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
 using static Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle;
+using static Microsoft.Toolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
 
 namespace Microsoft.Toolkit.Mvvm.SourceGenerators
 {
@@ -67,6 +68,12 @@ public void Execute(GeneratorExecutionContext context)
                 return;
             }
 
+            // Validate the language version
+            if (context.ParseOptions is not CSharpParseOptions { LanguageVersion: >= LanguageVersion.CSharp9 })
+            {
+                context.ReportDiagnostic(Diagnostic.Create(UnsupportedCSharpLanguageVersionError, null));
+            }
+
             // Load the syntax tree with the members to generate
             SyntaxTree sourceSyntaxTree = LoadSourceSyntaxTree();
 

Microsoft.Toolkit.Mvvm.SourceGenerators/Diagnostics/DiagnosticDescriptors.cs

@@ -4,6 +4,7 @@
 
 using System.ComponentModel;
 using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
 
 namespace Microsoft.Toolkit.Mvvm.SourceGenerators.Diagnostics
 {
@@ -201,7 +202,23 @@ internal static class DiagnosticDescriptors
             category: typeof(ICommandGenerator).FullName,
             defaultSeverity: DiagnosticSeverity.Error,
             isEnabledByDefault: true,
-            description: $"Cannot apply [ICommand] to methods with a signature that doesn't match any of the existing relay command types.",
+            description: "Cannot apply [ICommand] to methods with a signature that doesn't match any of the existing relay command types.",
+            helpLinkUri: "https://aka.ms/mvvmtoolkit");
+
+        /// <summary>
+        /// Gets a <see cref="DiagnosticDescriptor"/> indicating when an unsupported C# language version is being used.
+        /// <para>
+        /// Format: <c>"The method {0}.{1} cannot be used to generate a command property, as its signature isn't compatible with any of the existing relay command types"</c>.
+        /// </para>
+        /// </summary>
+        public static readonly DiagnosticDescriptor UnsupportedCSharpLanguageVersionError = new(
+            id: "MVVMTK0013",
+            title: "Unsupported C# language version",
+            messageFormat: "The source generator features from the MVVM Toolkit require consuming projects to set the C# language version to at least C# 9.0",
+            category: typeof(CSharpParseOptions).FullName,
+            defaultSeverity: DiagnosticSeverity.Error,
+            isEnabledByDefault: true,
+            description: "The source generator features from the MVVM Toolkit require consuming projects to set the C# language version to at least C# 9.0. Make sure to add <LangVersion>9.0</LangVersion> (or above) to your .csproj file.",
             helpLinkUri: "https://aka.ms/mvvmtoolkit");
     }
 }

Microsoft.Toolkit.Mvvm.SourceGenerators/Input/ICommandGenerator.cs

@@ -43,6 +43,12 @@ public void Execute(GeneratorExecutionContext context)
                 return;
             }
 
+            // Validate the language version
+            if (context.ParseOptions is not CSharpParseOptions { LanguageVersion: >= LanguageVersion.CSharp9 })
+            {
+                context.ReportDiagnostic(Diagnostic.Create(UnsupportedCSharpLanguageVersionError, null));
+            }
+
             foreach (var items in syntaxReceiver.GatheredInfo.GroupBy<SyntaxReceiver.Item, INamedTypeSymbol>(static item => item.MethodSymbol.ContainingType, SymbolEqualityComparer.Default))
             {
                 if (items.Key.DeclaringSyntaxReferences.Length > 0 &&

Microsoft.Toolkit.Mvvm.SourceGenerators/Messaging/IMessengerRegisterAllGenerator.cs

@@ -13,6 +13,7 @@
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.Toolkit.Mvvm.SourceGenerators.Extensions;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
+using static Microsoft.Toolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors;
 
 namespace Microsoft.Toolkit.Mvvm.SourceGenerators
 {
@@ -38,6 +39,12 @@ public void Execute(GeneratorExecutionContext context)
                 return;
             }
 
+            // Validate the language version
+            if (context.ParseOptions is not CSharpParseOptions { LanguageVersion: >= LanguageVersion.CSharp9 })
+            {
+                context.ReportDiagnostic(Diagnostic.Create(UnsupportedCSharpLanguageVersionError, null));
+            }
+
             // Get the symbol for the IRecipient<T> interface type
             INamedTypeSymbol iRecipientSymbol = context.Compilation.GetTypeByMetadataName("Microsoft.Toolkit.Mvvm.Messaging.IRecipient`1")!;
 

Microsoft.Toolkit.Uwp.DeveloperTools/VisualStudioToolsManifest.xml

@@ -1,6 +1,8 @@
 <FileList>
   <File Reference="Microsoft.Toolkit.Uwp.DeveloperTools.dll">
-    <ToolboxItems VSCategory="Windows Community Toolkit" BlendCategory="Windows Community Toolkit">
+    <ToolboxItems UIFramework="UAP"
+        VSCategory="Windows Community Toolkit"
+        BlendCategory="Windows Community Toolkit">
       <Item Type="Microsoft.Toolkit.Uwp.DeveloperTools.AlignmentGrid" />
       <Item Type="Microsoft.Toolkit.Uwp.DeveloperTools.FocusTracker" />
     </ToolboxItems>