language_server 0.1.0

data/lib/language_server/protocol/interfaces/execute_command_params.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class ExecuteCommandParams
+        def initialize(command:, arguments: nil)
+          @attributes = {}
+
+          @attributes[:command] = command
+          @attributes[:arguments] = arguments if arguments
+
+          @attributes.freeze
+        end
+
+        #
+        # The identifier of the actual command handler.
+        #
+        # @return [string]
+        def command
+          attributes.fetch(:command)
+        end
+
+        #
+        # Arguments that the command should be invoked with.
+        #
+        # @return [any[]]
+        def arguments
+          attributes.fetch(:arguments)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/execute_command_registration_options.rb

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # Execute command registration options.
+      #
+      class ExecuteCommandRegistrationOptions
+        def initialize(commands:)
+          @attributes = {}
+
+          @attributes[:commands] = commands
+
+          @attributes.freeze
+        end
+
+        #
+        # The commands to be executed on the server
+        #
+        # @return [string[]]
+        def commands
+          attributes.fetch(:commands)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/file_event.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # An event describing a file change.
+      #
+      class FileEvent
+        def initialize(uri:, type:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:type] = type
+
+          @attributes.freeze
+        end
+
+        #
+        # The file's URI.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # The change type.
+        #
+        # @return [number]
+        def type
+          attributes.fetch(:type)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/formatting_options.rb

@@ -0,0 +1,41 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # Value-object describing what options formatting should use.
+      #
+      class FormattingOptions
+        def initialize(tab_size:, insert_spaces:)
+          @attributes = {}
+
+          @attributes[:tabSize] = tab_size
+          @attributes[:insertSpaces] = insert_spaces
+
+          @attributes.freeze
+        end
+
+        #
+        # Size of a tab in spaces.
+        #
+        # @return [number]
+        def tab_size
+          attributes.fetch(:tabSize)
+        end
+
+        #
+        # Prefer spaces over tabs.
+        #
+        # @return [boolean]
+        def insert_spaces
+          attributes.fetch(:insertSpaces)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/hover.rb

@@ -0,0 +1,42 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # The result of a hover request.
+      #
+      class Hover
+        def initialize(contents:, range: nil)
+          @attributes = {}
+
+          @attributes[:contents] = contents
+          @attributes[:range] = range if range
+
+          @attributes.freeze
+        end
+
+        #
+        # The hover's content
+        #
+        # @return [string | { language: string; value: string; } | MarkedString[]]
+        def contents
+          attributes.fetch(:contents)
+        end
+
+        #
+        # An optional range is a range inside a text document
+        # that is used to visualize a hover, e.g. by changing the background color.
+        #
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/initialize_error.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # Known error codes for an `InitializeError`;
+      #
+      class InitializeError
+        def initialize(retry:)
+          @attributes = {}
+
+          @attributes[:retry] = binding.local_variable_get(:retry)
+
+          @attributes.freeze
+        end
+
+        #
+        # Indicates whether the client execute the following retry logic:
+        # (1) show the message provided by the ResponseError to the user
+        # (2) user selects retry or cancel
+        # (3) if user selected retry the initialize method is sent again.
+        #
+        # @return [boolean]
+        def retry
+          attributes.fetch(:retry)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/initialize_params.rb

@@ -0,0 +1,79 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class InitializeParams
+        def initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil)
+          @attributes = {}
+
+          @attributes[:processId] = process_id
+          @attributes[:rootPath] = root_path if root_path
+          @attributes[:rootUri] = root_uri
+          @attributes[:initializationOptions] = initialization_options if initialization_options
+          @attributes[:capabilities] = capabilities
+          @attributes[:trace] = trace if trace
+
+          @attributes.freeze
+        end
+
+        #
+        # The process Id of the parent process that started
+        # the server. Is null if the process has not been started by another process.
+        # If the parent process is not alive then the server should exit (see exit notification) its process.
+        #
+        # @return [number]
+        def process_id
+          attributes.fetch(:processId)
+        end
+
+        #
+        # The rootPath of the workspace. Is null
+        # if no folder is open.
+        #
+        # @return [string]
+        def root_path
+          attributes.fetch(:rootPath)
+        end
+
+        #
+        # The rootUri of the workspace. Is null if no
+        # folder is open. If both `rootPath` and `rootUri` are set
+        # `rootUri` wins.
+        #
+        # @return [string]
+        def root_uri
+          attributes.fetch(:rootUri)
+        end
+
+        #
+        # User provided initialization options.
+        #
+        # @return [any]
+        def initialization_options
+          attributes.fetch(:initializationOptions)
+        end
+
+        #
+        # The capabilities provided by the client (editor or tool)
+        #
+        # @return [ClientCapabilities]
+        def capabilities
+          attributes.fetch(:capabilities)
+        end
+
+        #
+        # The initial trace setting. If omitted trace is disabled ('off').
+        #
+        # @return ["off" | "messages" | "verbose"]
+        def trace
+          attributes.fetch(:trace)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/initialize_result.rb

@@ -0,0 +1,29 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class InitializeResult
+        def initialize(capabilities:)
+          @attributes = {}
+
+          @attributes[:capabilities] = capabilities
+
+          @attributes.freeze
+        end
+
+        #
+        # The capabilities the language server provides.
+        #
+        # @return [ServerCapabilities]
+        def capabilities
+          attributes.fetch(:capabilities)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/location.rb

@@ -0,0 +1,32 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class Location
+        def initialize(uri:, range:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:range] = range
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        # @return [Range]
+        def range
+          attributes.fetch(:range)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/log_message_params.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class LogMessageParams
+        def initialize(type:, message:)
+          @attributes = {}
+
+          @attributes[:type] = type
+          @attributes[:message] = message
+
+          @attributes.freeze
+        end
+
+        #
+        # The message type. See {@link MessageType}
+        #
+        # @return [number]
+        def type
+          attributes.fetch(:type)
+        end
+
+        #
+        # The actual message
+        #
+        # @return [string]
+        def message
+          attributes.fetch(:message)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/message.rb

@@ -0,0 +1,26 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class Message
+        def initialize(jsonrpc:)
+          @attributes = {}
+
+          @attributes[:jsonrpc] = jsonrpc
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def jsonrpc
+          attributes.fetch(:jsonrpc)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/message_action_item.rb

@@ -0,0 +1,29 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class MessageActionItem
+        def initialize(title:)
+          @attributes = {}
+
+          @attributes[:title] = title
+
+          @attributes.freeze
+        end
+
+        #
+        # A short title like 'Retry', 'Open Log' etc.
+        #
+        # @return [string]
+        def title
+          attributes.fetch(:title)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/notification_message.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class NotificationMessage
+        def initialize(method:, params: nil)
+          @attributes = {}
+
+          @attributes[:method] = method
+          @attributes[:params] = params if params
+
+          @attributes.freeze
+        end
+
+        #
+        # The method to be invoked.
+        #
+        # @return [string]
+        def method
+          attributes.fetch(:method)
+        end
+
+        #
+        # The notification's params.
+        #
+        # @return [any]
+        def params
+          attributes.fetch(:params)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/parameter_information.rb

@@ -0,0 +1,44 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      #
+      # Represents a parameter of a callable-signature. A parameter can
+      # have a label and a doc-comment.
+      #
+      class ParameterInformation
+        def initialize(label:, documentation: nil)
+          @attributes = {}
+
+          @attributes[:label] = label
+          @attributes[:documentation] = documentation if documentation
+
+          @attributes.freeze
+        end
+
+        #
+        # The label of this parameter. Will be shown in
+        # the UI.
+        #
+        # @return [string]
+        def label
+          attributes.fetch(:label)
+        end
+
+        #
+        # The human-readable doc-comment of this parameter. Will be shown
+        # in the UI but can be omitted.
+        #
+        # @return [string]
+        def documentation
+          attributes.fetch(:documentation)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/position.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class Position
+        def initialize(line:, character:)
+          @attributes = {}
+
+          @attributes[:line] = line
+          @attributes[:character] = character
+
+          @attributes.freeze
+        end
+
+        #
+        # Line position in a document (zero-based).
+        #
+        # @return [number]
+        def line
+          attributes.fetch(:line)
+        end
+
+        #
+        # Character offset on a line in a document (zero-based).
+        #
+        # @return [number]
+        def character
+          attributes.fetch(:character)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/publish_diagnostics_params.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class PublishDiagnosticsParams
+        def initialize(uri:, diagnostics:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+          @attributes[:diagnostics] = diagnostics
+
+          @attributes.freeze
+        end
+
+        #
+        # The URI for which diagnostic information is reported.
+        #
+        # @return [string]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        #
+        # An array of diagnostic information items.
+        #
+        # @return [Diagnostic[]]
+        def diagnostics
+          attributes.fetch(:diagnostics)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/range.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class Range
+        def initialize(start:, end:)
+          @attributes = {}
+
+          @attributes[:start] = start
+          @attributes[:end] = binding.local_variable_get(:end)
+
+          @attributes.freeze
+        end
+
+        #
+        # The range's start position.
+        #
+        # @return [Position]
+        def start
+          attributes.fetch(:start)
+        end
+
+        #
+        # The range's end position.
+        #
+        # @return [Position]
+        def end
+          attributes.fetch(:end)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interfaces/reference_context.rb

@@ -0,0 +1,29 @@
+module LanguageServer
+  module Protocol
+    module Interfaces
+      class ReferenceContext
+        def initialize(include_declaration:)
+          @attributes = {}
+
+          @attributes[:includeDeclaration] = include_declaration
+
+          @attributes.freeze
+        end
+
+        #
+        # Include the declaration of the current symbol.
+        #
+        # @return [boolean]
+        def include_declaration
+          attributes.fetch(:includeDeclaration)
+        end
+
+        attr_reader :attributes
+
+        def to_json(*args)
+          attributes.to_json(*args)
+        end
+      end
+    end
+  end
+end