Make analyzer stateless

Author: RussKie

src/WindowsForms.Analyzers/ControlTabOrderAnalyzer.cs

@@ -35,12 +35,6 @@ public static readonly DiagnosticDescriptor InconsistentTabIndexRuleIdDescriptor
                   isEnabledByDefault: true,
                   "Remove TabIndex assignments and re-order controls in the parent's control collection.");
 
-        // Contains the list of fields and local controls that explicitly set TabIndex properties.
-        private readonly Dictionary<string, int> _controlsTabIndex = new();
-        // Contains the list of fields and local controls in order those are added to parent controls.
-        private readonly Dictionary<string, List<string>> _controlsAddIndex = new();
-        private readonly Dictionary<string, Location> _controlsAddIndexLocations = new();
-
 
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
             => ImmutableArray.Create(InconsistentTabIndexRuleIdDescriptor, NonNumericTabIndexValueRuleIdDescriptor);
@@ -68,6 +62,7 @@ private void CodeBlockAction(OperationBlockAnalysisContext context)
                     continue;
                 }
 
+                CalculatedAnalysisContext calculatedContext = new();
                 foreach (IOperation operation in blockOperation.Operations)
                 {
                     switch (operation.Kind)
@@ -80,14 +75,14 @@ private void CodeBlockAction(OperationBlockAnalysisContext context)
                                 if (expressionStatementOperation.Operation is IOperation invocationOperation &&
                                     invocationOperation.Syntax is InvocationExpressionSyntax expressionSyntax)
                                 {
-                                    ParseControlAddStatements(expressionSyntax);
+                                    ParseControlAddStatements(expressionSyntax, calculatedContext);
                                     continue;
                                 }
 
                                 // Look for ".TabIndex = <x>"
                                 if (expressionStatementOperation.Operation is IAssignmentOperation assignmentOperation)
                                 {
-                                    ParseTabIndexAssignments((AssignmentExpressionSyntax)assignmentOperation.Syntax, context);
+                                    ParseTabIndexAssignments((AssignmentExpressionSyntax)assignmentOperation.Syntax, context, calculatedContext);
                                     continue;
                                 }
 
@@ -99,7 +94,7 @@ private void CodeBlockAction(OperationBlockAnalysisContext context)
                     }
                 }
 
-                if (_controlsTabIndex.Count < 1)
+                if (calculatedContext.ControlsTabIndex.Count < 1)
                 {
                     // No controls explicitly set TabIndex - all good
                     return;
@@ -116,25 +111,25 @@ private void CodeBlockAction(OperationBlockAnalysisContext context)
                 //      [this.button1:1]
                 //      [label2:0]
                 Dictionary<string, int> flatControlsAddIndex = new();
-                foreach (string key in _controlsAddIndex.Keys)
+                foreach (string key in calculatedContext.ControlsAddIndex.Keys)
                 {
-                    for (int i = 0; i < _controlsAddIndex[key].Count; i++)
+                    for (int i = 0; i < calculatedContext.ControlsAddIndex[key].Count; i++)
                     {
-                        string controlName = _controlsAddIndex[key][i];
+                        string controlName = calculatedContext.ControlsAddIndex[key][i];
                         flatControlsAddIndex[controlName] = i;
                     }
                 }
 
                 // Verify explicit TabIndex is the same as the "add order"
-                foreach (string key in _controlsTabIndex.Keys)
+                foreach (string key in calculatedContext.ControlsTabIndex.Keys)
                 {
                     if (!flatControlsAddIndex.ContainsKey(key))
                     {
                         // TODO: assert, diagnostics, etc.
                         continue;
                     }
 
-                    int tabIndex = _controlsTabIndex[key];
+                    int tabIndex = calculatedContext.ControlsTabIndex[key];
                     int addIndex = flatControlsAddIndex[key];
 
                     if (tabIndex == addIndex)
@@ -144,16 +139,15 @@ private void CodeBlockAction(OperationBlockAnalysisContext context)
 
                     var diagnostic = Diagnostic.Create(
                         descriptor: InconsistentTabIndexRuleIdDescriptor,
-                        location: _controlsAddIndexLocations[key],
+                        location: calculatedContext.ControlsAddIndexLocations[key],
                         properties: new Dictionary<string, string?> { { "ZOrder", addIndex.ToString() }, { "TabIndex", tabIndex.ToString() } }.ToImmutableDictionary(),
                         key, addIndex, tabIndex);
                     context.ReportDiagnostic(diagnostic);
                 }
-
             }
         }
 
-        private void ParseControlAddStatements(InvocationExpressionSyntax expressionSyntax)
+        private void ParseControlAddStatements(InvocationExpressionSyntax expressionSyntax, CalculatedAnalysisContext calculatedContext)
         {
             if (!expressionSyntax.Expression.ToString().EndsWith(".Controls.Add"))
             {
@@ -188,16 +182,16 @@ private void ParseControlAddStatements(InvocationExpressionSyntax expressionSynt
             //      [this.Controls.Add]   : new List { button3, this.button1 }
             //      [panel1.Controls.Add] : new List { label2 }
 
-            if (!_controlsAddIndex.ContainsKey(container))
+            if (!calculatedContext.ControlsAddIndex.ContainsKey(container))
             {
-                _controlsAddIndex[container] = new List<string>();
+                calculatedContext.ControlsAddIndex[container] = new List<string>();
             }
 
-            _controlsAddIndex[container].Add(controlName);
-            _controlsAddIndexLocations[controlName] = syntax.Parent!.Parent!.GetLocation();
+            calculatedContext.ControlsAddIndex[container].Add(controlName);
+            calculatedContext.ControlsAddIndexLocations[controlName] = syntax.Parent!.Parent!.GetLocation();
         }
 
-        private void ParseTabIndexAssignments(AssignmentExpressionSyntax expressionSyntax, OperationBlockAnalysisContext context)
+        private void ParseTabIndexAssignments(AssignmentExpressionSyntax expressionSyntax, OperationBlockAnalysisContext context, CalculatedAnalysisContext calculatedContext)
         {
             var propertyNameExpressionSyntax = (MemberAccessExpressionSyntax)expressionSyntax.Left;
             SimpleNameSyntax propertyNameSyntax = propertyNameExpressionSyntax.Name;
@@ -230,7 +224,7 @@ private void ParseTabIndexAssignments(AssignmentExpressionSyntax expressionSynta
 #pragma warning restore CS8605 // Unboxing a possibly null value.
 
             // "button3:0"
-            _controlsTabIndex[controlName] = tabIndexValue;
+            calculatedContext.ControlsTabIndex[controlName] = tabIndexValue;
         }
 
         private static string? GetControlName(ExpressionSyntax expressionSyntax)
@@ -244,5 +238,14 @@ private void ParseTabIndexAssignments(AssignmentExpressionSyntax expressionSynta
 
                 _ => null,
             };
+
+        private sealed class CalculatedAnalysisContext
+        {
+            // Contains the list of fields and local controls that explicitly set TabIndex properties.
+            public Dictionary<string, int> ControlsTabIndex { get; } = new();
+            // Contains the list of fields and local controls in order those are added to parent controls.
+            public Dictionary<string, List<string>> ControlsAddIndex { get; } = new();
+            public Dictionary<string, Location> ControlsAddIndexLocations { get; } = new();
+        }
     }
 }

src/WindowsForms.CodeFixes/ControlTabOrderAnalyzerCodeFixProvider.cs

@@ -4,15 +4,11 @@
 using System.Collections.Immutable;
 using System.Composition;
 using System.Linq;
-using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CodeActions;
 using Microsoft.CodeAnalysis.CodeFixes;
-using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
-using Microsoft.CodeAnalysis.Options;
-using Microsoft.CodeAnalysis.Rename;
 using Microsoft.CodeAnalysis.Text;
 using WindowsForms.Analyzers;
 
@@ -47,40 +43,9 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
             context.RegisterCodeFix(
                 CodeAction.Create(
                     title: CodeFixResources.CodeFixTitle,
-                    createChangedSolution: c => MakeUppercaseAsync(context.Document, declaration, c),
+                    createChangedSolution: c => null,
                     equivalenceKey: nameof(CodeFixResources.CodeFixTitle)),
                 diagnostic);
         }
-
-        private async Task<Solution> MakeUppercaseAsync(Document document, TypeDeclarationSyntax typeDecl, CancellationToken cancellationToken)
-        {
-            // Compute new uppercase name.
-            SyntaxToken identifierToken = typeDecl.Identifier;
-            var newName = identifierToken.Text.ToUpperInvariant();
-
-            // Get the symbol representing the type to be renamed.
-            SemanticModel semanticModel = await document.GetSemanticModelAsync(cancellationToken);
-            INamedTypeSymbol typeSymbol = semanticModel.GetDeclaredSymbol(typeDecl, cancellationToken);
-
-            // Produce a new solution that has all references to that type renamed, including the declaration.
-            Solution originalSolution = document.Project.Solution;
-            OptionSet optionSet = originalSolution.Workspace.Options;
-            Solution newSolution = await Renamer.RenameSymbolAsync(document.Project.Solution, typeSymbol, newName, optionSet, cancellationToken).ConfigureAwait(false);
-
-            // Return the new solution with the now-uppercase type name.
-            return newSolution;
-        }
     }
-
-    //[ExportCodeRefactoringProvider(LanguageNames.CSharp, Name = nameof(ControlTabOrderAnalyzerCodeRefactoringProvider)), Shared]
-
-    //public class ControlTabOrderAnalyzerCodeRefactoringProvider : CodeRefactoringProvider
-    //{
-    //    public override async Task ComputeRefactoringsAsync(CodeRefactoringContext context)
-    //    {
-    //        var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
-
-    //        throw new System.NotImplementedException();
-    //    }
-    //}
 }