Completion.cs

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//

using System.Diagnostics;
using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;

namespace Microsoft.PowerShell.EditorServices.Protocol.LanguageServer
{
    public class CompletionRequest
    {
        public static readonly
            RequestType<TextDocumentPositionParams, CompletionItem[], object, CompletionRegistrationOptions> Type =
            RequestType<TextDocumentPositionParams, CompletionItem[], object, CompletionRegistrationOptions>.Create("textDocument/completion");
    }

    public class CompletionResolveRequest
    {
        public static readonly
            RequestType<CompletionItem, CompletionItem, object, object> Type =
            RequestType<CompletionItem, CompletionItem, object, object>.Create("completionItem/resolve");
    }

    /// <summary>
    /// Completion registration options.
    /// </summary>
    public class CompletionRegistrationOptions : TextDocumentRegistrationOptions
    {
        // We duplicate the properties of completionOptions class here because
        // we cannot derive from two classes. One way to get around this situation
        // is to use define CompletionOptions as an interface instead of a class.
        public bool? ResolveProvider { get; set; }

        public string[] TriggerCharacters { get; set; }
    }

    public enum CompletionItemKind
    {
        Text = 1,
        Method = 2,
        Function = 3,
        Constructor = 4,
        Field = 5,
        Variable = 6,
        Class = 7,
        Interface = 8,
        Module = 9,
        Property = 10,
        Unit = 11,
        Value = 12,
        Enum = 13,
        Keyword = 14,
        Snippet = 15,
        Color = 16,
        File = 17,
        Reference = 18,
        Folder = 19
    }

    public enum InsertTextFormat
    {
        PlainText = 1,
        Snippet = 2,
    }

    [DebuggerDisplay("NewText = {NewText}, Range = {Range.Start.Line}:{Range.Start.Character} - {Range.End.Line}:{Range.End.Character}")]
    public class TextEdit
    {
        public Range Range { get; set; }

        public string NewText { get; set; }
    }

    [DebuggerDisplay("Kind = {Kind.ToString()}, Label = {Label}, Detail = {Detail}")]
    public class CompletionItem
    {
        public string Label { get; set; }

        public CompletionItemKind? Kind { get; set; }

        public string Detail { get; set; }

        /// <summary>
        /// Gets or sets the documentation string for the completion item.
        /// </summary>
        public string Documentation { get; set; }

        public string SortText { get; set; }

        public string FilterText { get; set; }

        public string InsertText { get; set; }

        public InsertTextFormat InsertTextFormat { get; set; } = InsertTextFormat.PlainText;

        public Range Range { get; set; }

        public string[] CommitCharacters { get; set; }

        public TextEdit TextEdit { get; set; }

        public TextEdit[] AdditionalTextEdits { get; set; }

        public CommandType Command { get; set; }

        /// <summary>
        /// Gets or sets a custom data field that allows the server to mark
        /// each completion item with an identifier that will help correlate
        /// the item to the previous completion request during a completion
        /// resolve request.
        /// </summary>
        public object Data { get; set; }
    }

    /// <summary>
    /// Represents a reference to a command. Provides a title which will be used to
    /// represent a command in the UI and, optionally, an array of arguments which
    /// will be passed to the command handler function when invoked.
    ///
    /// The name of the corresponding type in vscode-languageserver-node is Command
    /// but since .net does not allow a property name (Command) and its enclosing
    /// type name to be the same we change its name to CommandType.
    /// </summary>
    public class CommandType
    {
        /// <summary>
        /// Title of the command.
        /// </summary>
        /// <returns></returns>
        public string Title { get; set; }

        /// <summary>
        /// The identifier of the actual command handler.
        /// </summary>
        public string Command { get; set; }

        /// <summary>
        /// Arguments that the command handler should be invoked with.
        /// </summary>
        public object[] Arguments { get; set; }
    }
}