language_server-protocol 3.16.0.2 → 3.17.0.1

data/lib/language_server/protocol/interface/inline_value_registration_options.rb

@@ -0,0 +1,53 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline value options used during static or dynamic registration.
+      #
+      class InlineValueRegistrationOptions
+        def initialize(work_done_progress: nil, document_selector:, id: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:documentSelector] = document_selector
+          @attributes[:id] = id if id
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # A document selector to identify the scope of the registration. If set to
+        # null the document selector provided on the client side will be used.
+        #
+        # @return [DocumentSelector]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        def id
+          attributes.fetch(:id)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_value_text.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide inline value as text.
+      #
+      class InlineValueText
+        def initialize(range:, text:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:text] = text
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # The text of the inline value.
+        #
+        # @return [string]
+        def text
+          attributes.fetch(:text)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_value_variable_lookup.rb

@@ -0,0 +1,61 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Provide inline value through a variable lookup.
+      #
+      # If only a range is specified, the variable name will be extracted from
+      # the underlying document.
+      #
+      # An optional variable name can be used to override the extracted name.
+      #
+      class InlineValueVariableLookup
+        def initialize(range:, variable_name: nil, case_sensitive_lookup:)
+          @attributes = {}
+
+          @attributes[:range] = range
+          @attributes[:variableName] = variable_name if variable_name
+          @attributes[:caseSensitiveLookup] = case_sensitive_lookup
+
+          @attributes.freeze
+        end
+
+        #
+        # The document range for which the inline value applies.
+        # The range is used to extract the variable name from the underlying
+        # document.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        #
+        # If specified the name of the variable to look up.
+        #
+        # @return [string]
+        def variable_name
+          attributes.fetch(:variableName)
+        end
+
+        #
+        # How to perform the lookup.
+        #
+        # @return [boolean]
+        def case_sensitive_lookup
+          attributes.fetch(:caseSensitiveLookup)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_value_workspace_client_capabilities.rb

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Client workspace capabilities specific to inline values.
+      #
+      class InlineValueWorkspaceClientCapabilities
+        def initialize(refresh_support: nil)
+          @attributes = {}
+
+          @attributes[:refreshSupport] = refresh_support if refresh_support
+
+          @attributes.freeze
+        end
+
+        #
+        # Whether the client implementation supports a refresh request sent from
+        # the server to the client.
+        #
+        # Note that this event is global and will force the client to refresh all
+        # inline values currently shown. It should be used with absolute care and
+        # is useful for situation where a server for example detect a project wide
+        # change that requires such a calculation.
+        #
+        # @return [boolean]
+        def refresh_support
+          attributes.fetch(:refreshSupport)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/linked_editing_ranges.rb

@@ -13,7 +13,8 @@ module LanguageServer
 
         #
         # A list of ranges that can be renamed together. The ranges must have
-        # identical length and contain identical text content. The ranges cannot overlap.
+        # identical length and contain identical text content. The ranges cannot
+        # overlap.
         #
         # @return [Range[]]
         def ranges
@@ -21,9 +22,9 @@ module LanguageServer
         end
 
         #
-        # An optional word pattern (regular expression) that describes valid contents for
-        # the given ranges. If no pattern is provided, the client configuration's word
-        # pattern will be used.
+        # An optional word pattern (regular expression) that describes valid
+        # contents for the given ranges. If no pattern is provided, the client
+        # configuration's word pattern will be used.
         #
         # @return [string]
         def word_pattern

data/lib/language_server/protocol/interface/location_link.rb

@@ -45,7 +45,7 @@ module LanguageServer
 
         #
         # The range that should be selected and revealed when this link is being
-        # followed, e.g the name of a function. Must be contained by the the
+        # followed, e.g the name of a function. Must be contained by the
         # `targetRange`. See also `DocumentSymbol#range`
         #
         # @return [Range]

data/lib/language_server/protocol/interface/notebook_cell.rb

@@ -0,0 +1,69 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell.
+      #
+      # A cell's document URI must be unique across ALL notebook
+      # cells and can therefore be used to uniquely identify a
+      # notebook cell or the cell's text document.
+      #
+      class NotebookCell
+        def initialize(kind:, document:, metadata: nil, execution_summary: nil)
+          @attributes = {}
+
+          @attributes[:kind] = kind
+          @attributes[:document] = document
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:executionSummary] = execution_summary if execution_summary
+
+          @attributes.freeze
+        end
+
+        #
+        # The cell's kind
+        #
+        # @return [any]
+        def kind
+          attributes.fetch(:kind)
+        end
+
+        #
+        # The URI of the cell's text document
+        # content.
+        #
+        # @return [string]
+        def document
+          attributes.fetch(:document)
+        end
+
+        #
+        # Additional metadata stored with the cell.
+        #
+        # @return [LSPObject]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # Additional execution summary information
+        # if supported by the client.
+        #
+        # @return [ExecutionSummary]
+        def execution_summary
+          attributes.fetch(:executionSummary)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_cell_array_change.rb

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change describing how to move a `NotebookCell`
+      # array from state S to S'.
+      #
+      class NotebookCellArrayChange
+        def initialize(start:, delete_count:, cells: nil)
+          @attributes = {}
+
+          @attributes[:start] = start
+          @attributes[:deleteCount] = delete_count
+          @attributes[:cells] = cells if cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The start offset of the cell that changed.
+        #
+        # @return [number]
+        def start
+          attributes.fetch(:start)
+        end
+
+        #
+        # The deleted cells
+        #
+        # @return [number]
+        def delete_count
+          attributes.fetch(:deleteCount)
+        end
+
+        #
+        # The new cells, if any
+        #
+        # @return [NotebookCell[]]
+        def cells
+          attributes.fetch(:cells)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_cell_text_document_filter.rb

@@ -0,0 +1,52 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook cell text document filter denotes a cell text
+      # document by different properties.
+      #
+      class NotebookCellTextDocumentFilter
+        def initialize(notebook:, language: nil)
+          @attributes = {}
+
+          @attributes[:notebook] = notebook
+          @attributes[:language] = language if language
+
+          @attributes.freeze
+        end
+
+        #
+        # A filter that matches against the notebook
+        # containing the notebook cell. If a string
+        # value is provided it matches against the
+        # notebook type. '*' matches every notebook.
+        #
+        # @return [string | NotebookDocumentFilter]
+        def notebook
+          attributes.fetch(:notebook)
+        end
+
+        #
+        # A language id like `python`.
+        #
+        # Will be matched against the language id of the
+        # notebook cell document. '*' matches every language.
+        #
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_document.rb

@@ -0,0 +1,74 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document.
+      #
+      class NotebookDocument
+        def initialize(uri:, notebook_type:, version:, metadata: nil, cells:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:notebookType] = notebook_type
+          @attributes[:version] = version
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:cells] = cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document's URI.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The type of the notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # The version number of this document (it will increase after each
+        # change, including undo/redo).
+        #
+        # @return [number]
+        def version
+          attributes.fetch(:version)
+        end
+
+        #
+        # Additional metadata stored with the notebook
+        # document.
+        #
+        # @return [LSPObject]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # The cells of a notebook.
+        #
+        # @return [NotebookCell[]]
+        def cells
+          attributes.fetch(:cells)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_document_change_event.rb

@@ -0,0 +1,45 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A change event for a notebook document.
+      #
+      class NotebookDocumentChangeEvent
+        def initialize(metadata: nil, cells: nil)
+          @attributes = {}
+
+          @attributes[:metadata] = metadata if metadata
+          @attributes[:cells] = cells if cells
+
+          @attributes.freeze
+        end
+
+        #
+        # The changed meta data if any.
+        #
+        # @return [LSPObject]
+        def metadata
+          attributes.fetch(:metadata)
+        end
+
+        #
+        # Changes to cells
+        #
+        # @return [{ structure?: { array: NotebookCellArrayChange; didOpen?: TextDocumentItem[]; didClose?: TextDocumentIdentifier[]; }; data?: NotebookCell[]; textContent?: { ...; }[]; }]
+        def cells
+          attributes.fetch(:cells)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_document_client_capabilities.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Capabilities specific to the notebook document support.
+      #
+      class NotebookDocumentClientCapabilities
+        def initialize(synchronization:)
+          @attributes = {}
+
+          @attributes[:synchronization] = synchronization
+
+          @attributes.freeze
+        end
+
+        #
+        # Capabilities specific to notebook document synchronization
+        #
+        # @return [NotebookDocumentSyncClientCapabilities]
+        def synchronization
+          attributes.fetch(:synchronization)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_document_filter.rb

@@ -0,0 +1,79 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A notebook document filter denotes a notebook document by
+      # different properties.
+      #
+      class NotebookDocumentFilter
+        def initialize(notebook_type: nil, scheme: nil, pattern: nil)
+          @attributes = {}
+
+          @attributes[:notebookType] = notebook_type if notebook_type
+          @attributes[:scheme] = scheme if scheme
+          @attributes[:pattern] = pattern if pattern
+
+          @attributes.freeze
+        end
+
+        #
+        # The type of the enclosing notebook.
+        #
+        # --- OR ---
+        #
+        # The type of the enclosing notebook.
+        #
+        # --- OR ---
+        #
+        # The type of the enclosing notebook.
+        #
+        # @return [string]
+        def notebook_type
+          attributes.fetch(:notebookType)
+        end
+
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # --- OR ---
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # --- OR ---
+        #
+        # A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+        #
+        # @return [string]
+        def scheme
+          attributes.fetch(:scheme)
+        end
+
+        #
+        # A glob pattern.
+        #
+        # --- OR ---
+        #
+        # A glob pattern.
+        #
+        # --- OR ---
+        #
+        # A glob pattern.
+        #
+        # @return [string]
+        def pattern
+          attributes.fetch(:pattern)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/notebook_document_identifier.rb

@@ -0,0 +1,36 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A literal to identify a notebook document in the client.
+      #
+      class NotebookDocumentIdentifier
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        #
+        # The notebook document's URI.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end