-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/main' into RemoveFallbacks4
- Loading branch information
Showing
16 changed files
with
513 additions
and
663 deletions.
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
209 changes: 209 additions & 0 deletions
209
src/Features/Core/Portable/ImplementInterface/AbstractImplementInterfaceCodeFixProvider.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,209 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using System.Linq; | ||
| using System.Runtime.CompilerServices; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CodeAnalysis.CodeActions; | ||
| using Microsoft.CodeAnalysis.CodeFixes; | ||
| using Microsoft.CodeAnalysis.PooledObjects; | ||
| using Microsoft.CodeAnalysis.Shared.Extensions; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.ImplementInterface; | ||
|
|
||
| using static ImplementHelpers; | ||
|
|
||
| internal abstract class AbstractImplementInterfaceCodeFixProvider<TTypeSyntax> : CodeFixProvider | ||
| where TTypeSyntax : SyntaxNode | ||
| { | ||
| protected abstract bool IsTypeInInterfaceBaseList(TTypeSyntax type); | ||
|
|
||
| public sealed override FixAllProvider GetFixAllProvider() | ||
| => WellKnownFixAllProviders.BatchFixer; | ||
|
|
||
| public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context) | ||
| { | ||
| var document = context.Document; | ||
| var span = context.Span; | ||
| var cancellationToken = context.CancellationToken; | ||
|
|
||
| var root = await document.GetRequiredSyntaxRootAsync(cancellationToken).ConfigureAwait(false); | ||
|
|
||
| var token = root.FindToken(span.Start); | ||
| if (!token.Span.IntersectsWith(span)) | ||
| return; | ||
|
|
||
| foreach (var type in token.Parent.GetAncestorsOrThis<TTypeSyntax>()) | ||
| { | ||
| if (this.IsTypeInInterfaceBaseList(type)) | ||
| { | ||
| var service = document.GetRequiredLanguageService<IImplementInterfaceService>(); | ||
| var options = context.Options.GetOptions(document.Project.Services).ImplementTypeOptions; | ||
|
|
||
| var info = await service.AnalyzeAsync( | ||
| document, type, cancellationToken).ConfigureAwait(false); | ||
| if (info is not null) | ||
| { | ||
| using var _ = ArrayBuilder<CodeAction>.GetInstance(out var codeActions); | ||
| await foreach (var implementOptions in GetImplementOptionsAsync(document, info, cancellationToken)) | ||
| { | ||
| var title = GetTitle(implementOptions); | ||
| var equivalenceKey = GetEquivalenceKey(info, implementOptions); | ||
| codeActions.Add(CodeAction.Create( | ||
| title, | ||
| cancellationToken => service.ImplementInterfaceAsync( | ||
| document, info, options, implementOptions, cancellationToken), | ||
| equivalenceKey)); | ||
| } | ||
|
|
||
| context.RegisterFixes(codeActions, context.Diagnostics); | ||
| } | ||
|
|
||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static string GetTitle(ImplementInterfaceConfiguration options) | ||
| { | ||
| if (options.ImplementDisposePattern) | ||
| { | ||
| return options.Explicitly | ||
| ? FeaturesResources.Implement_interface_explicitly_with_Dispose_pattern | ||
| : FeaturesResources.Implement_interface_with_Dispose_pattern; | ||
| } | ||
| else if (options.Explicitly) | ||
| { | ||
| return options.OnlyRemaining | ||
| ? FeaturesResources.Implement_remaining_members_explicitly | ||
| : FeaturesResources.Implement_all_members_explicitly; | ||
| } | ||
| else if (options.Abstractly) | ||
| { | ||
| return FeaturesResources.Implement_interface_abstractly; | ||
| } | ||
| else if (options.ThroughMember != null) | ||
| { | ||
| return string.Format(FeaturesResources.Implement_interface_through_0, options.ThroughMember.Name); | ||
| } | ||
| else | ||
| { | ||
| return FeaturesResources.Implement_interface; | ||
| } | ||
| } | ||
|
|
||
| private static string GetEquivalenceKey( | ||
| IImplementInterfaceInfo state, | ||
| ImplementInterfaceConfiguration options) | ||
| { | ||
| var interfaceType = state.InterfaceTypes.First(); | ||
| var typeName = interfaceType.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat); | ||
| var assemblyName = interfaceType.ContainingAssembly.Name; | ||
|
|
||
| // Legacy part of the equivalence key. Kept the same to avoid test churn. | ||
| var codeActionTypeName = options.ImplementDisposePattern | ||
| ? "Microsoft.CodeAnalysis.ImplementInterface.AbstractImplementInterfaceService+ImplementInterfaceWithDisposePatternCodeAction" | ||
| : "Microsoft.CodeAnalysis.ImplementInterface.AbstractImplementInterfaceService+ImplementInterfaceCodeAction"; | ||
|
|
||
| // Consider code actions equivalent if they correspond to the same interface being implemented elsewhere | ||
| // in the same manner. Note: 'implement through member' means implementing the same interface through | ||
| // an applicable member with the same name in the destination. | ||
| return options.Explicitly.ToString() + ";" + | ||
| options.Abstractly.ToString() + ";" + | ||
| options.OnlyRemaining.ToString() + ":" + | ||
| typeName + ";" + | ||
| assemblyName + ";" + | ||
| codeActionTypeName + ";" + | ||
| options.ThroughMember?.Name; | ||
| } | ||
|
|
||
| private static async IAsyncEnumerable<ImplementInterfaceConfiguration> GetImplementOptionsAsync( | ||
| Document document, IImplementInterfaceInfo state, [EnumeratorCancellation] CancellationToken cancellationToken) | ||
| { | ||
| var compilation = await document.Project.GetRequiredCompilationAsync(cancellationToken).ConfigureAwait(false); | ||
|
|
||
| if (state.MembersWithoutExplicitOrImplicitImplementationWhichCanBeImplicitlyImplemented.Length > 0) | ||
| { | ||
| var totalMemberCount = 0; | ||
| var inaccessibleMemberCount = 0; | ||
|
|
||
| foreach (var (_, members) in state.MembersWithoutExplicitOrImplicitImplementationWhichCanBeImplicitlyImplemented) | ||
| { | ||
| foreach (var member in members) | ||
| { | ||
| totalMemberCount++; | ||
|
|
||
| if (IsLessAccessibleThan(member, state.ClassOrStructType)) | ||
| inaccessibleMemberCount++; | ||
| } | ||
| } | ||
|
|
||
| // If all members to implement are inaccessible, then "Implement interface" codeaction | ||
| // will be the same as "Implement interface explicitly", so there is no point in having both of them | ||
| if (totalMemberCount != inaccessibleMemberCount) | ||
| yield return new() { OnlyRemaining = true }; | ||
|
|
||
| if (ShouldImplementDisposePattern(compilation, state, explicitly: false)) | ||
| yield return new() { OnlyRemaining = true, ImplementDisposePattern = true, }; | ||
|
|
||
| var delegatableMembers = GetDelegatableMembers(document, state, cancellationToken); | ||
| foreach (var member in delegatableMembers) | ||
| yield return new() { ThroughMember = member }; | ||
|
|
||
| if (state.ClassOrStructType.IsAbstract) | ||
| yield return new() { OnlyRemaining = true, Abstractly = true }; | ||
| } | ||
|
|
||
| if (state.MembersWithoutExplicitImplementation.Length > 0) | ||
| { | ||
| yield return new() { Explicitly = true }; | ||
|
|
||
| if (ShouldImplementDisposePattern(compilation, state, explicitly: true)) | ||
| yield return new() { ImplementDisposePattern = true, Explicitly = true }; | ||
| } | ||
|
|
||
| if (AnyImplementedImplicitly(state)) | ||
| yield return new() { OnlyRemaining = true, Explicitly = true }; | ||
| } | ||
|
|
||
| private static bool AnyImplementedImplicitly(IImplementInterfaceInfo state) | ||
| { | ||
| if (state.MembersWithoutExplicitOrImplicitImplementation.Length != state.MembersWithoutExplicitImplementation.Length) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| for (var i = 0; i < state.MembersWithoutExplicitOrImplicitImplementation.Length; i++) | ||
| { | ||
| var (typeA, membersA) = state.MembersWithoutExplicitOrImplicitImplementation[i]; | ||
| var (typeB, membersB) = state.MembersWithoutExplicitImplementation[i]; | ||
| if (!typeA.Equals(typeB)) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| if (!membersA.SequenceEqual(membersB)) | ||
| { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| private static ImmutableArray<ISymbol> GetDelegatableMembers( | ||
| Document document, IImplementInterfaceInfo state, CancellationToken cancellationToken) | ||
| { | ||
| var firstInterfaceType = state.InterfaceTypes.First(); | ||
|
|
||
| return ImplementHelpers.GetDelegatableMembers( | ||
| document, | ||
| state.ClassOrStructType, | ||
| t => t.GetAllInterfacesIncludingThis().Contains(firstInterfaceType), | ||
| cancellationToken); | ||
| } | ||
| } |
Oops, something went wrong.