-
Notifications
You must be signed in to change notification settings - Fork 468
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New constant expected analyzer (#5766)
* Add ConstantExpectedAnalyzer Co-authored-by: Robin Lindner <robin.lindner1@t-online.de> Co-authored-by: Robin Lindner <robin@deeprobin.de>
- Loading branch information
3 people
authored
Nov 16, 2022
1 parent
0ba720f
commit ebaa318
Showing
26 changed files
with
3,310 additions
and
4 deletions.
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
...nalyzers/CSharp/Microsoft.NetCore.Analyzers/Performance/CSharpConstantExpectedAnalyzer.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,64 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. Licensed under the MIT license. See License.txt in the project root for license information. | ||
|
|
||
| using System.Linq; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using Microsoft.NetCore.Analyzers.Performance; | ||
|
|
||
| namespace Microsoft.NetCore.CSharp.Analyzers.Performance | ||
| { | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| public sealed class CSharpConstantExpectedAnalyzer : ConstantExpectedAnalyzer | ||
| { | ||
| private static readonly CSharpDiagnosticHelper s_diagnosticHelper = new(); | ||
| private static readonly IdentifierNameSyntax s_constantExpectedIdentifier = (IdentifierNameSyntax)SyntaxFactory.ParseName(ConstantExpected); | ||
| private static readonly IdentifierNameSyntax s_constantExpectedAttributeIdentifier = (IdentifierNameSyntax)SyntaxFactory.ParseName(ConstantExpectedAttribute); | ||
|
|
||
| protected override DiagnosticHelper Helper => s_diagnosticHelper; | ||
|
|
||
| protected override void RegisterAttributeSyntax(CompilationStartAnalysisContext context, ConstantExpectedContext constantExpectedContext) | ||
| { | ||
| context.RegisterSyntaxNodeAction(context => OnAttributeNode(context, constantExpectedContext), SyntaxKind.Attribute); | ||
| } | ||
|
|
||
| private void OnAttributeNode(SyntaxNodeAnalysisContext context, ConstantExpectedContext constantExpectedContext) | ||
| { | ||
| var attributeSyntax = (AttributeSyntax)context.Node; | ||
| var attributeName = attributeSyntax.Name; | ||
| if (!attributeName.IsEquivalentTo(s_constantExpectedIdentifier) && !attributeName.IsEquivalentTo(s_constantExpectedAttributeIdentifier)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| if (attributeSyntax.Parent.Parent is ParameterSyntax parameter) | ||
| { | ||
| var parameterSymbol = context.SemanticModel.GetDeclaredSymbol(parameter); | ||
| OnParameterWithConstantExpectedAttribute(parameterSymbol, constantExpectedContext, context.ReportDiagnostic); | ||
| } | ||
| } | ||
|
|
||
| private sealed class CSharpDiagnosticHelper : DiagnosticHelper | ||
| { | ||
| private readonly IdentifierNameSyntax _constantExpectedMinIdentifier = (IdentifierNameSyntax)SyntaxFactory.ParseName(ConstantExpectedMin); | ||
| private readonly IdentifierNameSyntax _constantExpectedMaxIdentifier = (IdentifierNameSyntax)SyntaxFactory.ParseName(ConstantExpectedMax); | ||
|
|
||
| public override Location? GetMaxLocation(SyntaxNode attributeNode) => GetArgumentLocation(attributeNode, _constantExpectedMaxIdentifier); | ||
|
|
||
| public override Location? GetMinLocation(SyntaxNode attributeNode) => GetArgumentLocation(attributeNode, _constantExpectedMinIdentifier); | ||
|
|
||
| private static Location? GetArgumentLocation(SyntaxNode attributeNode, IdentifierNameSyntax targetNameSyntax) | ||
| { | ||
| var attributeSyntax = (AttributeSyntax)attributeNode; | ||
| if (attributeSyntax.ArgumentList is null) | ||
| { | ||
| return null; | ||
| } | ||
| var targetArg = attributeSyntax.ArgumentList.Arguments.FirstOrDefault(arg => arg.NameEquals.Name.IsEquivalentTo(targetNameSyntax, true)); | ||
| return targetArg?.GetLocation(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ; |
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 |
|---|---|---|
| @@ -1 +1,8 @@ | ||
| ; Please do not edit this file manually, it should only be updated through code fix application. | ||
|
|
||
| ### New Rules | ||
|
|
||
| Rule ID | Category | Severity | Notes | ||
| --------|----------|----------|------- | ||
| CA1856 | Performance | Error | ConstantExpectedAnalyzer, [Documentation](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1856) | ||
| CA1857 | Performance | Warning | ConstantExpectedAnalyzer, [Documentation](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1857) |
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.