File: session.rb

package info (click to toggle)
ruby-neovim 0.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 548 kB
  • sloc: ruby: 4,178; sh: 23; makefile: 4
file content (121 lines) | stat: -rw-r--r-- 2,942 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
require "neovim/logging"
require "fiber"
require "thread"

module Neovim
  # Wraps an event loop in a synchronous API using +Fiber+s.
  #
  # @api private
  class Session
    include Logging

    attr_writer :request_id

    # @api private
    class Disconnected < RuntimeError
      def initialize
        super("Disconnected from nvim process")
      end
    end

    def initialize(event_loop)
      @event_loop = event_loop
      @main_thread = Thread.current
      @main_fiber = Fiber.current
      @response_handlers = Hash.new(-> {})
      @pending_messages = []
      @request_id = 0
    end

    def run(&block)
      block ||= ->(msg) { @pending_messages << msg }

      @running = true

      @event_loop.run do |message|
        Fiber.new { message.received(@response_handlers, &block) }.resume
      end
    end

    def next
      return @pending_messages.shift if @pending_messages.any?

      run { |msg| stop; msg }
    end

    # Make an RPC request and return its response.
    #
    # If this method is called inside a callback, we are already inside a
    # +Fiber+ handler. In that case, we write to the stream and yield the
    # +Fiber+. Once the response is received, resume the +Fiber+ and
    # return the result.
    #
    # If this method is called outside a callback, write to the stream and
    # run the event loop until a response is received. Messages received
    # in the meantime are enqueued to be handled later.
    def request(method, *args)
      main_thread_only do
        @request_id += 1
        blocking = Fiber.current == @main_fiber

        log(:debug) do
          {
            method_name: method,
            request_id: @request_id,
            blocking: blocking,
            arguments: args
          }
        end

        @event_loop.request(@request_id, method, *args)
        response = blocking ? blocking_response : yielding_response

        raise(Disconnected) if response.nil?
        raise(response.error) if response.error
        response.value
      end
    end

    def respond(request_id, value, error=nil)
      @event_loop.respond(request_id, value, error)
    end

    def notify(method, *args)
      @event_loop.notify(method, *args)
    end

    def shutdown
      @running = false
      @event_loop.shutdown
    end

    def stop
      @running = false
      @event_loop.stop
    end

    private

    def blocking_response
      @response_handlers[@request_id] = ->(res) { stop; res }
      run
    end

    def yielding_response
      fiber = Fiber.current
      @response_handlers[@request_id] = ->(response) { fiber.resume(response) }
      Fiber.yield
    end

    def main_thread_only
      if Thread.current == @main_thread
        yield if block_given?
      else
        raise(
          "A Ruby plugin attempted to call neovim outside of the main thread, " \
          "which is not yet supported by the neovim gem."
        )
      end
    end
  end
end