Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2717 from maxkoshevoi/2527-compiler-warnings-with…
…-unobvious-assignment 2527 Warning for unobvious assignment
- Loading branch information
Showing
16 changed files
with
624 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
100 changes: 100 additions & 0 deletions
100
...odeQuality.Analyzers/Core/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Immutable; | ||
| using Analyzer.Utilities; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using Microsoft.CodeAnalysis.Operations; | ||
|
|
||
| namespace Microsoft.CodeQuality.Analyzers.QualityGuidelines | ||
| { | ||
| /// <summary> | ||
| /// CA2246: Prevent objects from being referenced in statements where they are reassigned | ||
| /// </summary> | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| public sealed class AssigningSymbolAndItsMemberInSameStatement : DiagnosticAnalyzer | ||
| { | ||
| internal const string RuleId = "CA2246"; | ||
|
|
||
| private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AssigningSymbolAndItsMemberInSameStatementTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources)); | ||
| private static readonly LocalizableString s_localizableMessage = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AssigningSymbolAndItsMemberInSameStatementMessage), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources)); | ||
| private static readonly LocalizableString s_localizableDescription = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AssigningSymbolAndItsMemberInSameStatementDescription), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources)); | ||
|
|
||
| internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(RuleId, | ||
| s_localizableTitle, | ||
| s_localizableMessage, | ||
| DiagnosticCategory.Usage, | ||
| DiagnosticHelpers.DefaultDiagnosticSeverity, | ||
| DiagnosticHelpers.EnabledByDefaultIfNotBuildingVSIX, | ||
| s_localizableDescription); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule); | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.EnableConcurrentExecution(); | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); | ||
|
|
||
| context.RegisterOperationAction(AnalyzeAssignment, OperationKind.SimpleAssignment); | ||
| } | ||
|
|
||
| private void AnalyzeAssignment(OperationAnalysisContext context) | ||
| { | ||
| var assignmentOperation = (ISimpleAssignmentOperation)context.Operation; | ||
|
|
||
| // Check if there are more then one assignment in a statement | ||
| if (!(assignmentOperation.Target is IMemberReferenceOperation operationTarget)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| // This analyzer makes sense only for reference type objects | ||
| if (operationTarget.Instance?.Type.IsValueType == true) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| // Search for object equal to operationTarget.Instance further in assignment chain | ||
| bool isViolationFound = false; | ||
| if (operationTarget.Instance is ILocalReferenceOperation localInstance) | ||
| { | ||
| isViolationFound = AnalyzeAssignmentToMember(assignmentOperation, localInstance, (a, b) => a.Local.Equals(b.Local)); | ||
| } | ||
| else if (operationTarget.Instance is IMemberReferenceOperation memberInstance) | ||
| { | ||
| isViolationFound = AnalyzeAssignmentToMember(assignmentOperation, memberInstance, (a, b) => a.Member.Equals(b.Member) && a.Instance?.Syntax.ToString() == b.Instance?.Syntax.ToString()); | ||
| } | ||
| else if (operationTarget.Instance is IParameterReferenceOperation parameterInstance) | ||
| { | ||
| isViolationFound = AnalyzeAssignmentToMember(assignmentOperation, parameterInstance, (a, b) => a.Parameter.Equals(b.Parameter)); | ||
| } | ||
| else | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| if (isViolationFound) | ||
| { | ||
| var diagnostic = Diagnostic.Create(Rule, operationTarget.Syntax.GetLocation(), operationTarget.Instance.Syntax, operationTarget.Member.Name); | ||
| context.ReportDiagnostic(diagnostic); | ||
| } | ||
| } | ||
|
|
||
| private static bool AnalyzeAssignmentToMember<T>(ISimpleAssignmentOperation assignmentOperation, T instance, Func<T, T, bool> equalityComparer) where T : class, IOperation | ||
| { | ||
| // Check every simple assignments target in a statement for equality to `instance` | ||
| while (assignmentOperation.Value.Kind == OperationKind.SimpleAssignment) | ||
| { | ||
| assignmentOperation = (ISimpleAssignmentOperation)assignmentOperation.Value; | ||
|
|
||
| var operationValue = assignmentOperation.Target as T; | ||
| if (equalityComparer(instance, operationValue)) | ||
| { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.