File: Completion\Providers\Snippets\SnippetCompletionItem.cs
Web Access
Project: ..\..\..\src\Features\Core\Portable\Microsoft.CodeAnalysis.Features.csproj (Microsoft.CodeAnalysis.Features)
// 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.Immutable;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Utilities;
 
namespace Microsoft.CodeAnalysis.Completion.Providers.Snippets
{
    internal class SnippetCompletionItem
    {
        public static string LSPSnippetKey = "LSPSnippet";
        public static string SnippetIdentifierKey = "SnippetIdentifier";
 
        public static CompletionItem Create(
            string displayText,
            string displayTextSuffix,
            int position,
            string snippetIdentifier,
            Glyph glyph,
            ImmutableArray<SymbolDisplayPart> description,
            string inlineDescription,
            ImmutableArray<string> additionalFilterTexts)
        {
            var props = ImmutableDictionary<string, string>.Empty
                .Add("Position", position.ToString())
                .Add(SnippetIdentifierKey, snippetIdentifier);
 
            return CommonCompletionItem.Create(
                displayText: displayText,
                displayTextSuffix: displayTextSuffix,
                glyph: glyph,
                description: description,
                // Adding a space after the identifier string that way it will always be sorted after a keyword.
                sortText: snippetIdentifier + " ",
                filterText: snippetIdentifier,
                properties: props,
                isComplexTextEdit: true,
                inlineDescription: inlineDescription,
                rules: CompletionItemRules.Default)
                .WithAdditionalFilterTexts(additionalFilterTexts);
        }
 
        public static string GetSnippetIdentifier(CompletionItem item)
        {
            Contract.ThrowIfFalse(item.Properties.TryGetValue(SnippetIdentifierKey, out var text));
            return text;
        }
 
        public static int GetInvocationPosition(CompletionItem item)
        {
            Contract.ThrowIfFalse(item.Properties.TryGetValue("Position", out var text));
            Contract.ThrowIfFalse(int.TryParse(text, out var num));
            return num;
        }
 
        public static bool IsSnippet(CompletionItem item)
        {
            return item.Properties.TryGetValue(SnippetIdentifierKey, out var _);
        }
    }
}