cosmicgraph 0.49.0

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The CompletionItemKind constants for the language server protocol.
+    #
+    module CompletionItemKinds
+      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
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+  end
+end

data/lib/solargraph/language_server/error_codes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The ErrorCode constants for the language server protocol.
+    #
+    module ErrorCodes
+      PARSE_ERROR =            -32700
+      INVALID_REQUEST =        -32600
+      METHOD_NOT_FOUND =       -32601
+      INVALID_PARAMS =         -32602
+      INTERNAL_ERROR =         -32603
+      SERVER_ERROR_START =     -32099
+      SERVER_ERROR_END =       -32000
+      SERVER_NOT_INITIALIZED = -32002
+      UNKNOWN_ERROR_CODE =     -32001
+      REQUEST_CANCELLED =      -32800
+    end
+  end
+end

data/lib/solargraph/language_server/host/cataloger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # An asynchronous library cataloging handler.
+      #
+      class Cataloger
+        def initialize host
+          @host = host
+          @stopped = true
+        end
+
+        # Stop the catalog thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True if the cataloger is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the catalog thread.
+        #
+        # @return [void]
+        def start
+          return unless stopped?
+          @stopped = false
+          Thread.new do
+            until stopped?
+              tick
+              sleep 0.01
+            end
+          end
+        end
+
+        # Perform cataloging.
+        #
+        # @return [void]
+        def tick
+          host.catalog
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/diagnoser.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # An asynchronous diagnosis reporter.
+      #
+      class Diagnoser
+        # @param host [Host]
+        def initialize host
+          @host = host
+          @mutex = Mutex.new
+          @queue = []
+          @stopped = true
+        end
+
+        # Schedule a file to be diagnosed.
+        #
+        # @param uri [String]
+        # @return [void]
+        def schedule uri
+          mutex.synchronize { queue.push uri }
+        end
+
+        # Stop the diagnosis thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True is the diagnoser is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the diagnosis thread.
+        #
+        # @return [self]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            until stopped?
+              tick
+              sleep 0.1
+            end
+          end
+          self
+        end
+
+        # Perform diagnoses.
+        #
+        # @return [void]
+        def tick
+          return if queue.empty? || host.synchronizing?
+          if !host.options['diagnostics']
+            mutex.synchronize { queue.clear }
+            return
+          end
+          current = mutex.synchronize { queue.shift }
+          return if queue.include?(current)
+          begin
+            host.diagnose current
+          rescue InvalidOffsetError
+            # @todo This error can occur when the Source is out of sync with
+            #   with the ApiMap. It's probably not the best way to handle it,
+            #   but it's quick and easy.
+            Logging.logger.warn "Deferring diagnosis due to invalid offset: #{current}"
+            mutex.synchronize { queue.push current }
+          end
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # @return [Array]
+        attr_reader :queue
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/dispatch.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # Methods for associating sources with libraries via URIs.
+      #
+      module Dispatch
+        # @return [Sources]
+        def sources
+          @sources ||= begin
+            src = Sources.new
+            src.add_observer self, :update_libraries
+            src
+          end
+        end
+
+        # @return [Array<Library>]
+        def libraries
+          @libraries ||= []
+        end
+
+        # The Sources observer callback that merges a source into the host's
+        # libraries when it gets updated.
+        #
+        # @param uri [String]
+        # @return [void]
+        def update_libraries uri
+          src = sources.find(uri)
+          libraries.each do |lib|
+            lib.merge src if lib.contain?(src.filename)
+          end
+          diagnoser.schedule uri
+        end
+
+        # Find the best libary match for the given URI.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def library_for uri
+          result = explicit_library_for(uri) ||
+            implicit_library_for(uri) ||
+            generic_library_for(uri)
+          # previous library for already call attach. avoid call twice
+          # result.attach sources.find(uri) if sources.include?(uri)
+          result
+        end
+
+        # Find an explicit library match for the given URI. An explicit match
+        # means the libary's workspace includes the file.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def explicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if lib.contain?(filename)
+              lib.attach sources.find(uri) if sources.include?(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Find an implicit library match for the given URI. An implicit match
+        # means the file is located inside the library's workspace directory,
+        # regardless of whether the workspace is configured to include it.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def implicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if filename.start_with?(lib.workspace.directory)
+              lib.attach sources.find(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Get a generic library for the given URI and attach the corresponding
+        # source.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def generic_library_for uri
+          generic_library.attach sources.find(uri)
+          generic_library
+        end
+
+        # @return [Library]
+        def generic_library
+          @generic_library ||= Solargraph::Library.new
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/message_worker.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # A serial worker Thread to handle message.
+      #
+      # this make check pending message possible, and maybe cancelled to speedup process
+      class MessageWorker
+        # @param host [Host]
+        def initialize(host)
+          @host = host
+          @mutex = Mutex.new
+          @resource = ConditionVariable.new
+          @stopped = true
+        end
+
+        # pending handle messages
+        def messages
+          @messages ||= []
+        end
+
+        def stopped?
+          @stopped
+        end
+
+        def stop
+          @stopped = true
+        end
+
+        # @param message [Hash] The message should be handle. will pass back to Host#receive
+        # @return [void]
+        def queue(message)
+          @mutex.synchronize do
+            messages.push(message)
+            @resource.signal
+          end
+        end
+
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            tick until stopped?
+          end
+        end
+
+        def tick
+          message = @mutex.synchronize do
+            @resource.wait(@mutex) if messages.empty?
+            messages.shift
+          end
+          handler = @host.receive(message)
+          handler && handler.send_response
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/sources.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'observer'
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # A Host class for managing sources.
+      #
+      class Sources
+        include Observable
+        include UriHelpers
+
+        def initialize
+          @mutex = Mutex.new
+          @stopped = true
+          @has_uri = ConditionVariable.new
+        end
+
+        def stopped?
+          @stopped
+        end
+
+        # @return [void]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            tick until stopped?
+          end
+        end
+
+        # @return [void]
+        def tick
+          uri = mutex.synchronize { next_uri }
+
+          return if queue.include?(uri)
+          mutex.synchronize do
+            nxt = open_source_hash[uri].finish_synchronize
+            open_source_hash[uri] = nxt
+            changed
+            notify_observers uri
+          end
+        end
+
+        # @return [void]
+        def add_uri(uri)
+          queue.push(uri)
+          @has_uri.signal
+        end
+
+        # @return [String]
+        def next_uri
+          @has_uri.wait(mutex) if queue.empty?
+          queue.shift
+        end
+
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # Open a source.
+        #
+        # @param uri [String]
+        # @param text [String]
+        # @param version [Integer]
+        # @return [Source]
+        def open uri, text, version
+          filename = uri_to_file(uri)
+          source = Solargraph::Source.new(text, filename, version)
+          open_source_hash[uri] = source
+        end
+
+        def open_from_disk uri
+          source = Solargraph::Source.load(UriHelpers.uri_to_file(uri))
+          open_source_hash[uri] = source
+        end
+
+        # Update an existing source.
+        #
+        # @raise [FileNotFoundError] if the URI does not match an open source.
+        #
+        # @param uri [String]
+        # @param updater [Source::Updater]
+        # @return [Source]
+        def update uri, updater
+          src = find(uri)
+          mutex.synchronize { open_source_hash[uri] = src.synchronize(updater) }
+          changed
+          notify_observers uri
+        end
+
+        # @param uri [String]
+        # @param updater [Source::Updater]
+        # @return [void]
+        def async_update uri, updater
+          src = find(uri)
+          mutex.synchronize do
+            open_source_hash[uri] = src.start_synchronize(updater)
+            add_uri(uri)
+          end
+          changed
+          notify_observers uri
+        end
+
+        # Find the source with the given URI.
+        #
+        # @raise [FileNotFoundError] if the URI does not match an open source.
+        #
+        # @param uri [String]
+        # @return [Source]
+        def find uri
+          open_source_hash[uri] || raise(Solargraph::FileNotFoundError, "Host could not find #{uri}")
+        end
+
+        # Close the source with the given URI.
+        #
+        # @param uri [String]
+        # @return [void]
+        def close uri
+          open_source_hash.delete uri
+        end
+
+        # True if a source with given URI is currently open.
+        # @param uri [String]
+        # @return [Boolean]
+        def include? uri
+          open_source_hash.key? uri
+        end
+
+        # @return [void]
+        def clear
+          open_source_hash.clear
+        end
+
+        private
+
+        # @return [Hash]
+        def open_source_hash
+          @open_source_hash ||= {}
+        end
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # An array of source URIs that are waiting to finish synchronizing.
+        #
+        # @return [Array<String>]
+        def queue
+          @queue ||= []
+        end
+      end
+    end
+  end
+end