|
// 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;
using System.Collections.Immutable;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.CSharp.Extensions;
using Microsoft.CodeAnalysis.CSharp.Extensions.ContextQuery;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.CSharp.Utilities;
using Microsoft.CodeAnalysis.Editing;
using Microsoft.CodeAnalysis.LanguageService;
using Microsoft.CodeAnalysis.PooledObjects;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Microsoft.CodeAnalysis.Shared.Utilities;
using Microsoft.CodeAnalysis.Snippets;
using Microsoft.CodeAnalysis.Snippets.SnippetProviders;
using Microsoft.CodeAnalysis.Text;
namespace Microsoft.CodeAnalysis.CSharp.Snippets
{
internal abstract class AbstractCSharpAutoPropertySnippetProvider : AbstractPropertySnippetProvider
{
protected virtual AccessorDeclarationSyntax? GenerateGetAccessorDeclaration(CSharpSyntaxContext syntaxContext, SyntaxGenerator generator)
=> (AccessorDeclarationSyntax)generator.GetAccessorDeclaration();
protected virtual AccessorDeclarationSyntax? GenerateSetAccessorDeclaration(CSharpSyntaxContext syntaxContext, SyntaxGenerator generator)
=> (AccessorDeclarationSyntax)generator.SetAccessorDeclaration();
protected override async Task<bool> IsValidSnippetLocationAsync(Document document, int position, CancellationToken cancellationToken)
{
var syntaxTree = await document.GetRequiredSyntaxTreeAsync(cancellationToken).ConfigureAwait(false);
return syntaxTree.IsMemberDeclarationContext(position, context: null,
SyntaxKindSet.AllMemberModifiers, SyntaxKindSet.ClassInterfaceStructRecordTypeDeclarations, canBePartial: true, cancellationToken);
}
protected override async Task<SyntaxNode> GenerateSnippetSyntaxAsync(Document document, int position, CancellationToken cancellationToken)
{
var compilation = await document.Project.GetRequiredCompilationAsync(cancellationToken).ConfigureAwait(false);
var semanticModel = await document.GetRequiredSemanticModelAsync(cancellationToken).ConfigureAwait(false);
var generator = SyntaxGenerator.GetGenerator(document);
var identifierName = NameGenerator.GenerateUniqueName("MyProperty",
n => semanticModel.LookupSymbols(position, name: n).IsEmpty);
var syntaxContext = CSharpSyntaxContext.CreateContext(document, semanticModel, position, cancellationToken);
var accessors = new AccessorDeclarationSyntax?[]
{
GenerateGetAccessorDeclaration(syntaxContext, generator),
GenerateSetAccessorDeclaration(syntaxContext, generator),
};
SyntaxTokenList modifiers = default;
// If there are no preceding accessibility modifiers create default `public` one
if (!syntaxContext.PrecedingModifiers.Any(SyntaxFacts.IsAccessibilityModifier))
{
modifiers = SyntaxTokenList.Create(SyntaxFactory.Token(SyntaxKind.PublicKeyword));
}
return SyntaxFactory.PropertyDeclaration(
attributeLists: default,
modifiers: modifiers,
type: compilation.GetSpecialType(SpecialType.System_Int32).GenerateTypeSyntax(allowVar: false),
explicitInterfaceSpecifier: null,
identifier: identifierName.ToIdentifierToken(),
accessorList: SyntaxFactory.AccessorList(new SyntaxList<AccessorDeclarationSyntax>(accessors.Where(a => a is not null)!)));
}
protected override int GetTargetCaretPosition(ISyntaxFactsService syntaxFacts, SyntaxNode caretTarget, SourceText sourceText)
{
var propertyDeclaration = (PropertyDeclarationSyntax)caretTarget;
return propertyDeclaration.AccessorList!.CloseBraceToken.Span.End;
}
protected override ImmutableArray<SnippetPlaceholder> GetPlaceHolderLocationsList(SyntaxNode node, ISyntaxFacts syntaxFacts, CancellationToken cancellationToken)
{
using var _ = ArrayBuilder<SnippetPlaceholder>.GetInstance(out var arrayBuilder);
var propertyDeclaration = (PropertyDeclarationSyntax)node;
var identifier = propertyDeclaration.Identifier;
var type = propertyDeclaration.Type;
arrayBuilder.Add(new SnippetPlaceholder(identifier: type.ToString(), placeholderPositions: ImmutableArray.Create(type.SpanStart)));
arrayBuilder.Add(new SnippetPlaceholder(identifier: identifier.ValueText, placeholderPositions: ImmutableArray.Create(identifier.SpanStart)));
return arrayBuilder.ToImmutableArray();
}
protected override SyntaxNode? FindAddedSnippetSyntaxNode(SyntaxNode root, int position, Func<SyntaxNode?, bool> isCorrectContainer)
{
var node = root.FindNode(TextSpan.FromBounds(position, position));
return node.GetAncestorOrThis<PropertyDeclarationSyntax>();
}
}
}
|