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

Inline Hints - Checks if names are equivalent in member access expression #76254

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Inline Hints - Checks if names are equivalent in member access expression #76254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions src/Features/CSharp/Portable/InlineHints/CSharpInlineParameterNameHintsService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,22 @@ protected override void AddAllParameterNameHintLocations(
SemanticModel semanticModel,
ISyntaxFactsService syntaxFacts,
SyntaxNode node,
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> buffer,
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> buffer,
CancellationToken cancellationToken)
{
if (node is BaseArgumentListSyntax argumentList)
{
AddArguments(semanticModel, syntaxFacts, buffer, argumentList, cancellationToken);
AddArguments(semanticModel, buffer, argumentList, cancellationToken);
}
else if (node is AttributeArgumentListSyntax attributeArgumentList)
{
AddArguments(semanticModel, syntaxFacts, buffer, attributeArgumentList, cancellationToken);
AddArguments(semanticModel, buffer, attributeArgumentList, cancellationToken);
}
}

private static void AddArguments(
SemanticModel semanticModel,
ISyntaxFactsService syntaxFacts,
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> buffer,
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> buffer,
AttributeArgumentListSyntax argumentList,
CancellationToken cancellationToken)
{
Expand All @@ -57,15 +56,13 @@ private static void AddArguments(
continue;

var parameter = argument.DetermineParameter(semanticModel, cancellationToken: cancellationToken);
var identifierArgument = GetIdentifierNameFromArgument(argument, syntaxFacts);
buffer.Add((argument.Span.Start, identifierArgument, parameter, GetKind(argument.Expression)));
buffer.Add((argument.Span.Start, argument, parameter, GetKind(argument.Expression)));
}
}

private static void AddArguments(
SemanticModel semanticModel,
ISyntaxFactsService syntaxFacts,
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> buffer,
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> buffer,
BaseArgumentListSyntax argumentList,
CancellationToken cancellationToken)
{
Expand All @@ -75,8 +72,7 @@ private static void AddArguments(
continue;

var parameter = argument.DetermineParameter(semanticModel, cancellationToken: cancellationToken);
var identifierArgument = GetIdentifierNameFromArgument(argument, syntaxFacts);
buffer.Add((argument.Span.Start, identifierArgument, parameter, GetKind(argument.Expression)));
buffer.Add((argument.Span.Start, argument, parameter, GetKind(argument.Expression)));
}
}

Expand Down
27 changes: 18 additions & 9 deletions src/Features/Core/Portable/InlineHints/AbstractInlineParameterNameHintsService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ protected abstract void AddAllParameterNameHintLocations(
SemanticModel semanticModel,
ISyntaxFactsService syntaxFacts,
SyntaxNode node,
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> buffer,
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> buffer,
CancellationToken cancellationToken);

protected abstract bool IsIndexer(SyntaxNode node, IParameterSymbol parameter);
Expand Down Expand Up @@ -61,7 +61,7 @@ public async Task<ImmutableArray<InlineHint>> GetInlineHintsAsync(
var syntaxFacts = document.GetRequiredLanguageService<ISyntaxFactsService>();

using var _1 = ArrayBuilder<InlineHint>.GetInstance(out var result);
using var _2 = ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)>.GetInstance(out var buffer);
using var _2 = ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)>.GetInstance(out var buffer);

foreach (var node in root.DescendantNodes(textSpan, n => n.Span.IntersectsWith(textSpan)))
{
Expand All @@ -82,15 +82,15 @@ void AddHintsIfAppropriate(SyntaxNode node)
if (suppressForParametersThatDifferOnlyBySuffix && ParametersDifferOnlyBySuffix(buffer))
return;

foreach (var (position, identifierArgument, parameter, kind) in buffer)
foreach (var (position, argument, parameter, kind) in buffer)
{
if (string.IsNullOrEmpty(parameter?.Name))
continue;

if (suppressForParametersThatMatchMethodIntent && MatchesMethodIntent(parameter))
continue;

if (suppressForParametersThatMatchArgumentName && ParameterMatchesArgumentName(identifierArgument, parameter, syntaxFacts))
if (suppressForParametersThatMatchArgumentName && ParameterMatchesArgumentName(argument, parameter, syntaxFacts))
continue;

if (!indexerParameters && IsIndexer(node, parameter))
Expand Down Expand Up @@ -119,7 +119,7 @@ [new TaggedText(TextTags.Text, parameter.Name + ": ")],
}

private static bool ParametersDifferOnlyBySuffix(
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
{
// Only relevant if we have two or more parameters.
if (parameterHints.Count <= 1)
Expand All @@ -129,7 +129,7 @@ private static bool ParametersDifferOnlyBySuffix(
ParametersDifferOnlyByNumericSuffix(parameterHints);

static bool ParametersDifferOnlyByAlphaSuffix(
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
{
if (!HasAlphaSuffix(parameterHints[0].parameter, out var firstPrefix))
return false;
Expand All @@ -147,7 +147,7 @@ static bool ParametersDifferOnlyByAlphaSuffix(
}

static bool ParametersDifferOnlyByNumericSuffix(
ArrayBuilder<(int position, string? identifierArgument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
ArrayBuilder<(int position, SyntaxNode argument, IParameterSymbol? parameter, HintKind kind)> parameterHints)
{
if (!HasNumericSuffix(parameterHints[0].parameter, out var firstPrefix))
return false;
Expand Down Expand Up @@ -273,19 +273,28 @@ static bool SuffixMatchesParameterName(ReadOnlyMemory<char> suffix, string param
}
}

private static bool ParameterMatchesArgumentName(string? identifierArgument, IParameterSymbol parameter, ISyntaxFactsService syntaxFacts)
=> syntaxFacts.StringComparer.Compare(parameter.Name, identifierArgument) == 0;
private static bool ParameterMatchesArgumentName(SyntaxNode argument, IParameterSymbol parameter, ISyntaxFactsService syntaxFacts)
{
var argumentName = GetIdentifierNameFromArgument(argument, syntaxFacts);
return syntaxFacts.StringComparer.Compare(parameter.Name, argumentName) == 0;
}

protected static string GetIdentifierNameFromArgument(SyntaxNode argument, ISyntaxFactsService syntaxFacts)
{
var identifierNameSyntax =
syntaxFacts.IsArgument(argument) ? syntaxFacts.GetExpressionOfArgument(argument) :
syntaxFacts.IsAttributeArgument(argument) ? syntaxFacts.GetExpressionOfAttributeArgument(argument) : null;

if (syntaxFacts.IsMemberAccessExpression(identifierNameSyntax))
{
identifierNameSyntax = syntaxFacts.GetNameOfMemberAccessExpression(identifierNameSyntax);
}

if (!syntaxFacts.IsIdentifierName(identifierNameSyntax))
return string.Empty;

var identifier = syntaxFacts.GetIdentifierOfIdentifierName(identifierNameSyntax);
Comment on lines 284 to 296
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there is a TrGetInferredMemberName you could potentially use. Up to you.


return identifier.ValueText;
}
}
4 changes: 2 additions & 2 deletions src/Features/VisualBasic/Portable/InlineHints/VisualBasicInlineParameterNameHintsService.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.InlineHints
semanticModel As SemanticModel,
syntaxFacts As ISyntaxFactsService,
node As SyntaxNode,
buffer As ArrayBuilder(Of (position As Integer, identifierArgument As String, parameter As IParameterSymbol, kind As HintKind)),
buffer As ArrayBuilder(Of (position As Integer, argument As SyntaxNode, parameter As IParameterSymbol, kind As HintKind)),
cancellationToken As CancellationToken)

Dim argumentList = TryCast(node, ArgumentListSyntax)
Expand Down Expand Up @@ -53,7 +53,7 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.InlineHints
End If

Dim argumentIdentifier = GetIdentifierNameFromArgument(argument, syntaxFacts)
buffer.Add((argument.Span.Start, argumentIdentifier, parameter, GetKind(argument.Expression)))
buffer.Add((argument.Span.Start, argument, parameter, GetKind(argument.Expression)))
Next
End Sub

Expand Down
Loading