-
Notifications
You must be signed in to change notification settings - Fork 222
/
SillyBitwiseOperationBase.cs
89 lines (78 loc) · 3.94 KB
/
SillyBitwiseOperationBase.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* SonarAnalyzer for .NET
* Copyright (C) 2015-2023 SonarSource SA
* mailto: contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
namespace SonarAnalyzer.Rules
{
// FIXME: Rename this to something like SillyNumericalOperatorUsage
public abstract class SillyBitwiseOperationBase : SonarDiagnosticAnalyzer
{
internal const string BitwiseDiagnosticId = "S2437";
internal const string IsReportingOnLeftKey = "IsReportingOnLeft";
private const string BitwiseMessageFormat = "Remove this silly bit operation.";
protected abstract ILanguageFacade Language { get; }
protected DiagnosticDescriptor BitwiseRule { get; }
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(BitwiseRule);
protected SillyBitwiseOperationBase()
{
BitwiseRule = Language.CreateDescriptor(BitwiseDiagnosticId, BitwiseMessageFormat, fadeOutCode: true);
}
protected void CheckBinary(SonarSyntaxNodeReportingContext context, SyntaxNode left, SyntaxToken @operator, SyntaxNode right, int constValueToLookFor)
{
Location location;
bool isReportingOnLeftKey;
if (FindIntConstant(context.SemanticModel, left) is { } valueLeft && valueLeft == constValueToLookFor)
{
location = left.CreateLocation(@operator);
isReportingOnLeftKey = true;
}
else if (FindIntConstant(context.SemanticModel, right) is { } valueRight && valueRight == constValueToLookFor)
{
location = @operator.CreateLocation(right);
isReportingOnLeftKey = false;
}
else
{
return;
}
context.ReportIssue(Diagnostic.Create(BitwiseRule, location, ImmutableDictionary<string, string>.Empty.Add(IsReportingOnLeftKey, isReportingOnLeftKey.ToString())));
}
protected int? FindIntConstant(SemanticModel semanticModel, SyntaxNode node) =>
semanticModel.GetSymbolInfo(node).Symbol is var symbol
&& !IsFieldOrPropertyOutsideSystemNamespace(symbol)
&& !IsEnum(symbol)
&& Language.FindConstantValue(semanticModel, node) is { } value
? ConversionHelper.TryConvertToInt(value)
: null;
protected T? FindConstant<T>(SemanticModel semanticModel, SyntaxNode node, Func<object, T> converter) where T : struct
{
return semanticModel.GetSymbolInfo(node).Symbol is var symbol
&& !IsFieldOrPropertyOutsideSystemNamespace(symbol)
&& !IsEnum(symbol)
&& Language.FindConstantValue(semanticModel, node) is { } value
&& ConversionHelper.TryConvertWith(value, converter, out T typedValue)
? typedValue
: null;
}
private static bool IsEnum(ISymbol symbol) =>
symbol.GetSymbolType() is INamedTypeSymbol { EnumUnderlyingType: { } };
private static bool IsFieldOrPropertyOutsideSystemNamespace(ISymbol symbol) =>
symbol is { Kind: SymbolKind.Field or SymbolKind.Property }
&& symbol.ContainingNamespace.Name != nameof(System);
}
}