Merge branch 'feature/v3_10_0'

Author: matarillo

LanguageServer/Infrastructure/JsonDotNet/EitherConverter.cs

@@ -27,11 +27,13 @@ public EitherConverter()
             table[typeof(LocationSingleOrArray)] = token => (object)ToLocationSingleOrArray(token);
             table[typeof(ChangeNotificationsOptions)] = token => (object)ToChangeNotificationsOptions(token);
             table[typeof(ColorProviderOptionsOrBoolean)] = token => (object)ToColorProviderOptionsOrBoolean(token);
+            table[typeof(FoldingRangeProviderOptionsOrBoolean)] = token => (object)ToFoldingRangeProviderOptionsOrBoolean(token);
             table[typeof(ProviderOptionsOrBoolean)] = token => (object)ToProviderOptionsOrBoolean(token);
             table[typeof(TextDocumentSync)] = token => (object)ToTextDocumentSync(token);
             table[typeof(CodeActionResult)] = token => (object)ToCodeActionResult(token);
             table[typeof(Documentation)] = token => (object)ToDocumentation(token);
             table[typeof(CompletionResult)] = token => (object)ToCompletionResult(token);
+            table[typeof(DocumentSymbolResult)] = token => (object)ToDocumentSymbolResult(token);
             table[typeof(HoverContents)] = token => (object)ToHoverContents(token);
         }
 
@@ -123,6 +125,21 @@ private ColorProviderOptionsOrBoolean ToColorProviderOptionsOrBoolean(JToken tok
             }
         }
 
+        private FoldingRangeProviderOptionsOrBoolean ToFoldingRangeProviderOptionsOrBoolean(JToken token)
+        {
+            switch (token.Type)
+            {
+                case JTokenType.Null:
+                    return null;
+                case JTokenType.Boolean:
+                    return new FoldingRangeProviderOptionsOrBoolean(token.ToObject<bool>());
+                case JTokenType.Object:
+                    return new FoldingRangeProviderOptionsOrBoolean(token.ToObject<FoldingRangeProviderOptions>());
+                default:
+                    throw new JsonSerializationException();
+            }
+        }
+
         private ProviderOptionsOrBoolean ToProviderOptionsOrBoolean(JToken token)
         {
             switch (token.Type)
@@ -220,6 +237,37 @@ private CompletionResult ToCompletionResult(JToken token)
             }
         }
 
+        private DocumentSymbolResult ToDocumentSymbolResult(JToken token)
+        {
+            switch (token.Type)
+            {
+                case JTokenType.Null:
+                    return null;
+                case JTokenType.Array:
+                    var array = (JArray) token;
+                    if (array.Count == 0)
+                    {
+                        return new DocumentSymbolResult(new DocumentSymbol[0]);
+                    }
+
+                    var element = (array[0] as JObject) ?? throw new JsonSerializationException();
+                    if (element.Property("range") != null)
+                    {
+                        return new DocumentSymbolResult(array.ToObject<DocumentSymbol[]>());
+                    }
+                    else if (element.Property("location") != null)
+                    {
+                        return new DocumentSymbolResult(array.ToObject<SymbolInformation[]>());
+                    }
+                    else
+                    {
+                        throw new JsonSerializationException();
+                    }
+                default:
+                    throw new JsonSerializationException();
+            }
+        }
+
         private HoverContents ToHoverContents(JToken token)
         {
             switch (token.Type)

LanguageServer/Json/Either.cs

@@ -12,7 +12,7 @@ namespace LanguageServer.Json
     /// <item><description><see cref="LanguageServer.Parameters.LocationSingleOrArray"/></description></item>
     /// <item><description><see cref="LanguageServer.Parameters.General.ChangeNotificationsOptions"/></description></item>
     /// <item><description><see cref="LanguageServer.Parameters.General.ColorProviderOptionsOrBoolean"/></description></item>
-    /// <item><description><see cref="LanguageServer.Parameters.General.FoldingRangeProviderCapabilities"/></description></item>
+    /// <item><description><see cref="LanguageServer.Parameters.General.FoldingRangeProviderOptionsOrBoolean"/></description></item>
     /// <item><description><see cref="LanguageServer.Parameters.General.ProviderOptionsOrBoolean"/></description></item>
     /// <item><description><see cref="LanguageServer.Parameters.General.TextDocumentSync"/></description></item>
     /// <item><description><see cref="LanguageServer.Parameters.TextDocument.CodeActionResult"/></description></item>

LanguageServer/Parameters/FoldingRangeKind.cs

@@ -0,0 +1,27 @@
+namespace LanguageServer.Parameters
+{
+    /// <summary>
+    /// Enum of known range kinds
+    /// </summary>
+    /// <seealso>Spec 3.10.0</seealso>
+    public static class FoldingRangeKind
+    {
+        /// <summary>
+        /// Folding range for a comment
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public const string Comment = "comment";
+
+        /// <summary>
+        /// Folding range for a imports or includes
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public const string Imports = "imports";
+
+        /// <summary>
+        /// Folding range for a region (e.g. <c>#region</c>)
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public const string Region = "region";
+    }
+}

LanguageServer/Parameters/General/FoldingRangeCapabilities.cs

@@ -0,0 +1,34 @@
+namespace LanguageServer.Parameters.General
+{
+    /// <summary>
+    /// For <c>initialize</c>
+    /// </summary>
+    /// <remarks>
+    /// <c>dynamicRegistration</c> property shows whether implementation supports dynamic registration.
+    /// If this is set to <c>true</c> the client supports the new
+    /// <c>(FoldingRangeProviderOptions &amp; TextDocumentRegistrationOptions &amp; StaticRegistrationOptions)</c>
+    /// return value for the corresponding server capability as well.
+    /// </remarks>
+    /// <seealso>Spec 3.10.0</seealso>
+    public class FoldingRangeCapabilities : RegistrationCapabilities
+    {
+        /// <summary>
+        /// The maximum number of folding ranges that the client prefers to receive per document.
+        /// </summary>
+        /// <remarks>
+        /// The value serves as a hint, servers are free to follow the limit.
+        /// </remarks>
+        /// <seealso>Spec 3.10.0</seealso>
+        public long? rangeLimit { get; set; }
+
+        /// <summary>
+        /// If set, the client signals that it only supports folding complete lines.
+        /// </summary>
+        /// <remarks>
+        /// If set, client will ignore specified <c>startCharacter</c>
+        /// and <c>endCharacter</c> properties in a FoldingRange.
+        /// </remarks>
+        /// <seealso>Spec 3.10.0</seealso>
+        public bool? lineFoldingOnly { get; set; }
+    }
+}

LanguageServer/Parameters/General/FoldingRangeProviderOptions.cs

@@ -0,0 +1,15 @@
+namespace LanguageServer.Parameters.General
+{
+    /// <summary>
+    /// For <c>initialize</c>
+    /// </summary>
+    /// <remarks>
+    /// The original spec describes the intersection type
+    /// <c>(FoldingRangeProviderOptions &amp; TextDocumentRegistrationOptions &amp; StaticRegistrationOptions)</c>.
+    /// This implementation merges their types into this class.
+    /// </remarks>
+    /// <seealso>Spec 3.10.0</seealso>
+    public class FoldingRangeProviderOptions : ProviderOptions
+    {
+    }
+}

LanguageServer/Parameters/General/FoldingRangeProviderOptionsOrBoolean.cs

@@ -0,0 +1,73 @@
+using LanguageServer.Json;
+
+namespace LanguageServer.Parameters.General
+{
+    /// <summary>
+    /// For <c>initialize</c>
+    /// </summary>
+    /// <remarks>
+    /// The original spec describes the union type of
+    /// <c>boolean</c>, <c>FoldingRangeProviderOptions</c>, or the intersection type
+    /// <c>(FoldingRangeProviderOptions &amp; TextDocumentRegistrationOptions &amp; StaticRegistrationOptions)</c>.
+    /// This implementation defines <see cref="FoldingRangeProviderOptions"/> class instead of the intersection type.
+    /// </remarks>
+    /// <seealso>Spec 3.10.0</seealso>
+    public class FoldingRangeProviderOptionsOrBoolean : Either
+    {
+        /// <summary>
+        /// Defines an implicit conversion of a <see cref="FoldingRangeProviderOptions"/> to a <see cref="FoldingRangeProviderOptionsOrBoolean"/>
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        public static implicit operator FoldingRangeProviderOptionsOrBoolean(FoldingRangeProviderOptions value)
+            => new FoldingRangeProviderOptionsOrBoolean(value);
+
+        /// <summary>
+        /// Defines an implicit conversion of a <see cref="bool"/> to a <see cref="FoldingRangeProviderOptionsOrBoolean"/>
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        public static implicit operator FoldingRangeProviderOptionsOrBoolean(bool value)
+            => new FoldingRangeProviderOptionsOrBoolean(value);
+
+        /// <summary>
+        /// Initializes a new instance of <c>FoldingRangeProviderOptionsOrBoolean</c> with the specified value.
+        /// </summary>
+        /// <param name="value"></param>
+        public FoldingRangeProviderOptionsOrBoolean(FoldingRangeProviderOptions value)
+        {
+            Type = typeof(FoldingRangeProviderOptions);
+            Value = value;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of <c>FoldingRangeProviderOptionsOrBoolean</c> with the specified value.
+        /// </summary>
+        /// <param name="value"></param>
+        public FoldingRangeProviderOptionsOrBoolean(bool value)
+        {
+            Type = typeof(bool);
+            Value = value;
+        }
+
+        /// <summary>
+        /// Returns true if its underlying value is a <see cref="FoldingRangeProviderOptions"/>.
+        /// </summary>
+        public bool IsFoldingRangeProviderOptions => Type == typeof(FoldingRangeProviderOptions);
+
+        /// <summary>
+        /// Returns true if its underlying value is a <see cref="bool"/>.
+        /// </summary>
+        public bool IsBoolean => Type == typeof(bool);
+
+        /// <summary>
+        /// Gets the value of the current object if its underlying value is a <see cref="FoldingRangeProviderOptions"/>.
+        /// </summary>
+        public FoldingRangeProviderOptions FoldingRangeProviderOptions => GetValue<FoldingRangeProviderOptions>();
+
+        /// <summary>
+        /// Gets the value of the current object if its underlying value is a <see cref="bool"/>.
+        /// </summary>
+        public bool Boolean => GetValue<bool>();
+    }
+}

LanguageServer/Parameters/General/ServerCapabilities.cs

@@ -5,7 +5,7 @@ namespace LanguageServer.Parameters.General
     /// <summary>
     /// For <c>initialize</c>
     /// </summary>
-    /// <seealso>Spec 3.8.0</seealso>
+    /// <seealso>Spec 3.10.0</seealso>
     public class ServerCapabilities
     {
         /// <summary>
@@ -124,6 +124,12 @@ public class ServerCapabilities
         /// <seealso>Spec 3.8.0</seealso>
         public ColorProviderOptionsOrBoolean colorProvider { get; set; }
 
+        /// <summary>
+        /// The server provides folding provider support.
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public FoldingRangeProviderOptionsOrBoolean foldingRangeProvider { get; set; }
+
         /// <summary>
         /// The server provides execute command support.
         /// </summary>

LanguageServer/Parameters/General/SymbolCapabilities.cs

@@ -6,13 +6,19 @@
     /// <remarks>
     /// Capabilities specific to the <c>workspace/symbol</c> request.
     /// </remarks>
-    /// <seealso>Spec 3.4.0</seealso>
+    /// <seealso>Spec 3.10.0</seealso>
     public class SymbolCapabilities : RegistrationCapabilities
     {
         /// <summary>
         /// Specific capabilities for the <c>SymbolKind</c> in the <c>workspace/symbol</c> request.
         /// </summary>
         /// <seealso>Spec 3.4.0</seealso>
         public SymbolKindCapabilities symbolKind { get; set; }
+
+        /// <summary>
+        /// The client support hierarchical document symbols.
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public bool? hierarchicalDocumentSymbolSupport { get; set; }
     }
 }

LanguageServer/Parameters/General/TextDocumentClientCapabilities.cs

@@ -3,7 +3,7 @@
     /// <summary>
     /// For <c>initialize</c>
     /// </summary>
-    /// <seealso>Spec 3.8.0</seealso>
+    /// <seealso>Spec 3.10.0</seealso>
     public class TextDocumentClientCapabilities
     {
         /// <summary>
@@ -119,5 +119,11 @@ public class TextDocumentClientCapabilities
         /// </summary>
         /// <seealso>Spec 3.7.0</seealso>
         public PublishDiagnosticsCapabilities publishDiagnostics { get; set; }
+
+        /// <summary>
+        /// Capabilities specific to <c>textDocument/foldingRange</c> requests.
+        /// </summary>
+        /// <seealso>Spec 3.10.0</seealso>
+        public FoldingRangeCapabilities foldingRange { get; set; }
     }
 }

LanguageServer/Parameters/TextDocument/DocumentSymbol.cs

@@ -0,0 +1,60 @@
+namespace LanguageServer.Parameters.TextDocument
+{
+    /// <summary>
+    /// For <c>textDocument/documentSymbol</c>
+    /// </summary>
+    /// <remarks>
+    /// Represents programming constructs like variables, classes, interfaces etc. that appear in a document.
+    /// Document symbols can be hierarchical and they have two ranges:
+    /// one that encloses its definition and one that points to its most interesting range,
+    /// e.g. the range of an identifier.
+    /// </remarks>
+    /// <seealso>Spec 3.10.0</seealso>
+    public class DocumentSymbol
+    {
+        /// <summery>
+        /// The name of this symbol.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public string name { get; set; }
+
+        /// <summery>
+        /// More detail for this symbol, e.g the signature of a function. If not provided the name is used.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public string detail { get; set; }
+
+        /// <summery>
+        /// The kind of this symbol.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public SymbolKind kind { get; set; }
+
+        /// <summery>
+        /// Indicates if this symbol is deprecated.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public bool? deprecated { get; set; }
+
+        /// <summery>
+        /// The range enclosing this symbol not including leading/trailing whitespace but everything else
+        /// like comments. This information is typically used to determine if the the clients cursor is
+        /// inside the symbol to reveal in the symbol in the UI.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public Range range { get; set; }
+
+        /// <summery>
+        /// The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
+        /// Must be contained by the the <c>range</c>.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public Range selectionRange { get; set; }
+
+        /// <summery>
+        /// Children of this symbol, e.g. properties of a class.
+        /// </summery>
+        /// <seealso>Spec 3.10.0</seealso>
+        public DocumentSymbol[] children { get; set; }
+    }
+}