Add warning when property has a backing field but a manually implemented accessor does not use it #75325
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,12 +31,13 @@ private enum Flags : ushort | |
| IsExpressionBodied = 1 << 0, | ||
| HasAutoPropertyGet = 1 << 1, | ||
| HasAutoPropertySet = 1 << 2, | ||
| GetterUsesFieldKeyword = 1 << 4, | ||
RikkiGibson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| SetterUsesFieldKeyword = 1 << 5, | ||
| IsExplicitInterfaceImplementation = 1 << 6, | ||
| HasInitializer = 1 << 7, | ||
| AccessorsHaveImplementation = 1 << 8, | ||
| HasExplicitAccessModifier = 1 << 9, | ||
| RequiresBackingField = 1 << 10, | ||
| } | ||
|
|
||
| // TODO (tomat): consider splitting into multiple subclasses/rare data. | ||
|
|
@@ -90,7 +91,8 @@ protected SourcePropertySymbolBase( | |
| bool hasAutoPropertySet, | ||
| bool isExpressionBodied, | ||
| bool accessorsHaveImplementation, | ||
| bool getterUsesFieldKeyword, | ||
| bool setterUsesFieldKeyword, | ||
| RefKind refKind, | ||
| string memberName, | ||
| SyntaxList<AttributeListSyntax> indexerNameAttributeLists, | ||
|
|
@@ -133,9 +135,14 @@ protected SourcePropertySymbolBase( | |
| _propertyFlags |= Flags.HasAutoPropertySet; | ||
| } | ||
|
|
||
| if (getterUsesFieldKeyword) | ||
| { | ||
| _propertyFlags |= Flags.GetterUsesFieldKeyword; | ||
| } | ||
|
|
||
| if (setterUsesFieldKeyword) | ||
| { | ||
| _propertyFlags |= Flags.SetterUsesFieldKeyword; | ||
| } | ||
|
|
||
| if (hasInitializer) | ||
|
|
@@ -171,7 +178,7 @@ protected SourcePropertySymbolBase( | |
| _name = _lazySourceName = memberName; | ||
| } | ||
|
|
||
| if (getterUsesFieldKeyword || setterUsesFieldKeyword || hasAutoPropertyGet || hasAutoPropertySet || hasInitializer) | ||
| { | ||
| Debug.Assert(!IsIndexer); | ||
| _propertyFlags |= Flags.RequiresBackingField; | ||
|
|
@@ -305,6 +312,47 @@ protected void CheckInitializerIfNeeded(BindingDiagnosticBag diagnostics) | |
| } | ||
| } | ||
|
|
||
| #nullable enable | ||
| private void CheckFieldKeywordUsage(BindingDiagnosticBag diagnostics) | ||
| { | ||
| if (!this.DeclaringCompilation.IsFeatureEnabled(MessageID.IDS_FeatureFieldKeyword)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| check((SourcePropertySymbolBase?)PartialImplementationPart ?? this, diagnostics); | ||
|
There was a problem hiding this comment. Consider inlining this local function. |
||
|
|
||
| static void check(SourcePropertySymbolBase @this, BindingDiagnosticBag diagnostics) | ||
| { | ||
| SourcePropertyAccessorSymbol? accessorToBlame = null; | ||
| var propertyFlags = @this._propertyFlags; | ||
| var getterUsesFieldKeyword = (propertyFlags & Flags.GetterUsesFieldKeyword) != 0; | ||
| var setterUsesFieldKeyword = (propertyFlags & Flags.SetterUsesFieldKeyword) != 0; | ||
| if (@this._setMethod is { IsAutoPropertyAccessor: false } setMethod && !setterUsesFieldKeyword && [email protected](Flags.HasInitializer) && (@this.HasAutoPropertyGet || getterUsesFieldKeyword)) | ||
| { | ||
| accessorToBlame = setMethod; | ||
| } | ||
| else if (@this._getMethod is { IsAutoPropertyAccessor: false } getMethod && !getterUsesFieldKeyword && (@this.HasAutoPropertySet || setterUsesFieldKeyword)) | ||
| { | ||
| accessorToBlame = getMethod; | ||
| } | ||
|
|
||
| if (accessorToBlame is not null) | ||
| { | ||
| var accessorName = accessorToBlame switch | ||
| { | ||
| { MethodKind: MethodKind.PropertyGet, IsInitOnly: false } => SyntaxFacts.GetText(SyntaxKind.GetKeyword), | ||
| { MethodKind: MethodKind.PropertySet, IsInitOnly: false } => SyntaxFacts.GetText(SyntaxKind.SetKeyword), | ||
| { MethodKind: MethodKind.PropertySet, IsInitOnly: true } => SyntaxFacts.GetText(SyntaxKind.InitKeyword), | ||
| _ => throw ExceptionUtilities.UnexpectedValue(accessorToBlame) | ||
| }; | ||
|
|
||
| diagnostics.Add(ErrorCode.WRN_AccessorDoesNotUseBackingField, accessorToBlame.GetFirstLocation(), accessorName, @this); | ||
| } | ||
| } | ||
| } | ||
| #nullable disable | ||
|
|
||
| public sealed override RefKind RefKind | ||
| { | ||
| get | ||
|
|
@@ -648,10 +696,10 @@ public bool HasSkipLocalsInitAttribute | |
| } | ||
|
|
||
| internal bool IsAutoPropertyOrUsesFieldKeyword | ||
| => IsSetOnEitherPart(Flags.HasAutoPropertyGet | Flags.HasAutoPropertySet | Flags.GetterUsesFieldKeyword | Flags.SetterUsesFieldKeyword); | ||
|
|
||
| internal bool UsesFieldKeyword | ||
| => IsSetOnEitherPart(Flags.GetterUsesFieldKeyword | Flags.SetterUsesFieldKeyword); | ||
|
|
||
| protected bool HasExplicitAccessModifier | ||
| => (_propertyFlags & Flags.HasExplicitAccessModifier) != 0; | ||
|
|
@@ -811,6 +859,7 @@ internal override void AfterAddingTypeMembersChecks(ConversionsBase conversions, | |
| this.CheckModifiers(isExplicitInterfaceImplementation, Location, IsIndexer, diagnostics); | ||
|
|
||
| CheckInitializerIfNeeded(diagnostics); | ||
| CheckFieldKeywordUsage(diagnostics); | ||
|
|
||
| if (RefKind != RefKind.None && IsRequired) | ||
| { | ||
|
|
||
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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly,
the backing 'field'reads very awkwardly. Maybe justshould use 'field'?