Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add UseStringMethodCharOverloadWithSingleCharacters analyzer and fixer #6799

Merged
merged 25 commits into from Jul 26, 2023
Merged

Add UseStringMethodCharOverloadWithSingleCharacters analyzer and fixer #6799

Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
d6d35b7
Implement UseStringMethodCharOverloadWithSingleCharacters analyzer wi…
mrahhal Jul 25, 2023
97e67d4
Use StringComparison's InvariantCulture
mrahhal Jul 25, 2023
33dbe22
Use NotNullWhen instead
mrahhal Jul 25, 2023
e6c8be6
Verify diagnostic message
mrahhal Jul 25, 2023
516a488
Pack
mrahhal Jul 25, 2023
ae7e73d
Merge branch 'main' into use-string-method-char-overload
mrahhal Jul 25, 2023
8a1edef
Rename
mrahhal Jul 25, 2023
e193931
Add more tests
mrahhal Jul 25, 2023
4604ec5
Rename
mrahhal Jul 25, 2023
4173280
Refactor a bit
mrahhal Jul 25, 2023
3373731
Use ImmutableArray instead of set
mrahhal Jul 25, 2023
ffaab47
Remove unneeded check
mrahhal Jul 25, 2023
1e2dc74
Add link comment for IsASCII
mrahhal Jul 25, 2023
2643212
Move resolving StringComparison related symbols to compilation start
mrahhal Jul 25, 2023
f21c124
Use IsPrintableAscii
mrahhal Jul 25, 2023
dd16e03
Detect CultureInfo argument too and set the relevant comparison
mrahhal Jul 25, 2023
303cbae
Pass symbols used in AnalyzeOperation instead of storing in fields
mrahhal Jul 25, 2023
8d87397
Rename
mrahhal Jul 25, 2023
1551f86
Preserve certain args (IndexOf/LastIndexOf)
mrahhal Jul 25, 2023
f9a32ba
Remove unneeded
mrahhal Jul 26, 2023
b287c19
Update description
mrahhal Jul 26, 2023
8d23672
Pack
mrahhal Jul 26, 2023
ef06ce5
Use else if
mrahhal Jul 26, 2023
cfec118
Use WellKnownTypeNames
mrahhal Jul 26, 2023
f159d4c
Update message to use just one arg for the method
mrahhal Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 14 additions & 13 deletions ...icrosoft.NetCore.Analyzers/Performance/UseStringMethodCharOverloadWithSingleCharacters.cs
View file
Open in desktop
Expand Up @@ -56,6 +56,10 @@ public abstract class UseStringMethodCharOverloadWithSingleCharacters : Diagnost
nameof(string.IndexOf),
nameof(string.LastIndexOf));

private INamedTypeSymbol? _stringComparisonType;
private ISymbol? _ordinalStringComparisonSymbol;
private ISymbol? _invariantCultureStringComparisonSymbol;
mrahhal marked this conversation as resolved.
Show resolved Hide resolved

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; }
= ImmutableArray.Create(SafeTransformationRule, NoSpecifiedComparisonRule, AnyOtherSpecifiedComparisonRule);

Expand All @@ -82,9 +86,15 @@ private void CheckIfRuleIsApplicableAndRegister(CompilationStartAnalysisContext
m.Parameters[0].Type.SpecialType == SpecialType.System_Char;
});

if (!stringTypeHasCharOverload)
var typeProvider = WellKnownTypeProvider.GetOrCreate(context.Compilation);
_stringComparisonType = typeProvider.GetOrCreateTypeByMetadataName("System.StringComparison");

if (!stringTypeHasCharOverload || _stringComparisonType == null)
return;

_ordinalStringComparisonSymbol = _stringComparisonType.GetMembers(nameof(StringComparison.Ordinal)).First();
_invariantCultureStringComparisonSymbol = _stringComparisonType.GetMembers(nameof(StringComparison.InvariantCulture)).First();

context.RegisterOperationAction(AnalyzeOperation, OperationKind.Invocation);
}

Expand Down Expand Up @@ -131,12 +141,6 @@ private void AnalyzeOperation(OperationAnalysisContext context)
method = null;
comparison = null;

var typeProvider = WellKnownTypeProvider.GetOrCreate(context.Compilation);
var stringComparisonType = typeProvider.GetOrCreateTypeByMetadataName("System.StringComparison");

if (stringComparisonType == null)
return false;

if (invocationOperation.TargetMethod is IMethodSymbol invokedMethod &&
invokedMethod.ContainingType.SpecialType == SpecialType.System_String &&
TargetMethods.Contains(invokedMethod.Name) &&
Expand All @@ -148,17 +152,14 @@ private void AnalyzeOperation(OperationAnalysisContext context)
foreach (var argument in invocationOperation.Arguments)
{
if (argument.Value.Type != null &&
argument.Value.Type.Equals(stringComparisonType) &&
argument.Value.Type.Equals(_stringComparisonType) &&
argument.Value is IFieldReferenceOperation fieldReferenceOperation)
{
var ordinalStringComparisonSymbol = stringComparisonType.GetMembers(nameof(StringComparison.Ordinal)).First();
var invariantCultureStringComparisonSymbol = stringComparisonType.GetMembers(nameof(StringComparison.InvariantCulture)).First();

if (fieldReferenceOperation.Field.Equals(ordinalStringComparisonSymbol))
if (fieldReferenceOperation.Field.Equals(_ordinalStringComparisonSymbol))
{
comparison = StringComparisonUsed.Ordinal;
}
else if (fieldReferenceOperation.Field.Equals(invariantCultureStringComparisonSymbol))
else if (fieldReferenceOperation.Field.Equals(_invariantCultureStringComparisonSymbol))
{
comparison = StringComparisonUsed.InvariantCulture;
}
Expand Down