Class: TypeProf::LSP::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/typeprof/lsp/server.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(core_options, reader, writer, url_schema: nil) ⇒ Server

Returns a new instance of Server.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/typeprof/lsp/server.rb', line 59

def initialize(core_options, reader, writer, url_schema: nil)
  @core_options = core_options
  @cores = {}
  @reader = reader
  @writer = writer
  @request_id = 0
  @running_requests_from_client = {}
  @running_requests_from_server = {}
  @open_texts = {}
  @exit = false
  @signature_enabled = true
  @url_schema = url_schema || (File::ALT_SEPARATOR != "\\" ? "file://" : "file:///")
  @diagnostic_severity = :error
end

Instance Attribute Details

#open_texts ⇒ Object (readonly)

Returns the value of attribute open_texts.



74
75
76
 
# File 'lib/typeprof/lsp/server.rb', line 74

def open_texts
  @open_texts
end

#position_encoding ⇒ Object (readonly)

Returns the value of attribute position_encoding.



74
75
76
 
# File 'lib/typeprof/lsp/server.rb', line 74

def position_encoding
  @position_encoding
end

#signature_enabled ⇒ Object

Returns the value of attribute signature_enabled.



75
76
77
 
# File 'lib/typeprof/lsp/server.rb', line 75

def signature_enabled
  @signature_enabled
end

Class Method Details

.start_socket(core_options, port = 0) ⇒ Object 



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
 
# File 'lib/typeprof/lsp/server.rb', line 24

def self.start_socket(core_options, port = 0)
  Socket.tcp_server_sockets("localhost", port) do |servs|
    serv = servs[0].local_address
    $stdout << JSON.generate({
      host: serv.ip_address,
      port: serv.ip_port,
      pid: $$,
    })
    $stdout.flush

    $stdout = $stderr

    Socket.accept_loop(servs) do |sock|
      sock.set_encoding("UTF-8")
      begin
        reader = Reader.new(sock)
        writer = Writer.new(sock)
        new(core_options, reader, writer).run
      ensure
        sock.close
      end
      exit
    end
  end
end

.start_stdio(core_options) ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'lib/typeprof/lsp/server.rb', line 14

def self.start_stdio(core_options)
  $stdin.binmode
  $stdout.binmode
  reader = Reader.new($stdin)
  writer = Writer.new($stdout)
  # pipe all builtin print output to stderr to avoid conflicting with lsp
  $stdout = $stderr
  new(core_options, reader, writer).run
end

Instance Method Details

#add_workspaces(folders) ⇒ Object

: (Array) -> void



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/typeprof/lsp/server.rb', line 107

def add_workspaces(folders)
  folders.each do |path|
    conf_path = [".json", ".jsonc"].map do |ext|
      File.join(path, "typeprof.conf" + ext)
    end.find do |path|
      File.readable?(path)
    end
    unless conf_path
      puts "typeprof.conf.json is not found in #{ path }"
      next
    end
    conf = TypeProf::LSP.load_json_with_comments(conf_path, symbolize_names: true)
    if conf
      if conf[:rbs_dir]
        rbs_dir = File.expand_path(conf[:rbs_dir])
      else
        rbs_dir = File.expand_path(File.expand_path("sig", path))
      end
      @rbs_dir = rbs_dir
      if conf[:typeprof_version] == "experimental"
        if conf[:diagnostic_severity]
          severity = conf[:diagnostic_severity].to_sym
          case severity
          when :error, :warning, :info, :hint
            @diagnostic_severity = severity
          else
            puts "unknown severity: #{ severity }"
          end
        end
        @core_options[:exclude_patterns] = conf[:exclude] if conf[:exclude]
        service_options = @core_options.merge(position_encoding: @position_encoding)
        conf[:analysis_unit_dirs].each do |dir|
          dir = File.expand_path(dir, path)
          core = @cores[dir] = TypeProf::Core::Service.new(service_options)
          core.add_workspace(dir, @rbs_dir)
        end
      else
        puts "Unknown typeprof_version: #{ conf[:typeprof_version] }"
      end
    end
  end
end

#aggregate_each_core(path) ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'lib/typeprof/lsp/server.rb', line 167

def aggregate_each_core(path)
  ret = []
  each_core(path) do |core|
    r = yield(core)
    ret.concat(r) if r
  end
  ret
end

#cancel_request(id) ⇒ Object 



262
263
264
265
 
# File 'lib/typeprof/lsp/server.rb', line 262

def cancel_request(id)
  req = @running_requests_from_client[id]
  req.cancel if req.respond_to?(:cancel)
end

#code_lens(path, &blk) ⇒ Object 



208
209
210
211
212
 
# File 'lib/typeprof/lsp/server.rb', line 208

def code_lens(path, &blk)
  each_core(path) do |core|
    core.code_lens(path, &blk)
  end
end

#completion(path, trigger, pos, &blk) ⇒ Object 



214
215
216
217
218
 
# File 'lib/typeprof/lsp/server.rb', line 214

def completion(path, trigger, pos, &blk)
  each_core(path) do |core|
    core.completion(path, trigger, pos, &blk)
  end
end

#definitions(path, pos) ⇒ Object 



182
183
184
185
186
 
# File 'lib/typeprof/lsp/server.rb', line 182

def definitions(path, pos)
  aggregate_each_core(path) do |core|
    core.definitions(path, pos)
  end
end

#each_core(path) ⇒ Object 



159
160
161
162
163
164
165
 
# File 'lib/typeprof/lsp/server.rb', line 159

def each_core(path)
  @cores.each do |folder, core|
    if path.start_with?(folder) || @rbs_dir && path.start_with?(@rbs_dir)
      yield core
    end
  end
end

#exit ⇒ Object 



267
268
269
 
# File 'lib/typeprof/lsp/server.rb', line 267

def exit
  @exit = true
end

#hover(path, pos) ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/typeprof/lsp/server.rb', line 200

def hover(path, pos)
  ret = []
  each_core(path) do |core|
    ret << core.hover(path, pos)
  end
  ret.compact.first # TODO
end

#lsp_position_encoding ⇒ Object 



83
84
85
 
# File 'lib/typeprof/lsp/server.rb', line 83

def lsp_position_encoding
  LSP_POSITION_ENCODINGS.fetch(@position_encoding)
end

#negotiate_position_encoding(client_encodings) ⇒ Object

Pick the first mutually-supported encoding from the client’s preference-ordered list and store it. Falls back to UTF-16LE (mandatory per LSP 3.17 spec).



79
80
81
 
# File 'lib/typeprof/lsp/server.rb', line 79

def negotiate_position_encoding(client_encodings)
  @position_encoding = pick_position_encoding(client_encodings)
end

#path_to_uri(path) ⇒ Object

: (String) -> String



98
99
100
 
# File 'lib/typeprof/lsp/server.rb', line 98

def path_to_uri(path)
  @url_schema + File.expand_path(path).split("/").map {|s| CGI.escapeURIComponent(s) }.join("/")
end

#publish_updated_diagnostics ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/typeprof/lsp/server.rb', line 271

def publish_updated_diagnostics
  @cores.each do |_, core|
    diags = []
    core.process_diagnostic_paths do |path|
      uri = path_to_uri(path)
      next false unless @open_texts[uri]
      core.diagnostics(path) do |diag|
        diags << diag.to_lsp(severity: @diagnostic_severity)
      end
      send_notification(
        "textDocument/publishDiagnostics",
        uri: uri,
        diagnostics: diags
      )
      true
    end
  end
end

#references(path, pos) ⇒ Object 



194
195
196
197
198
 
# File 'lib/typeprof/lsp/server.rb', line 194

def references(path, pos)
  aggregate_each_core(path) do |core|
    core.references(path, pos)
  end
end

#rename(path, pos) ⇒ Object 



220
221
222
223
224
 
# File 'lib/typeprof/lsp/server.rb', line 220

def rename(path, pos)
  aggregate_each_core(path) do |core|
    core.rename(path, pos)
  end
end

#run ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/typeprof/lsp/server.rb', line 226

def run
  @reader.read do |json|
    if json[:method]
      # request or notification
      msg_class = Message.find(json[:method])
      if msg_class
        msg = msg_class.new(self, json)
        @running_requests_from_client[json[:id]] = msg if json[:id]
        msg.run
      else

      end
    else
      # response
      callback = @running_requests_from_server.delete(json[:id])
      callback&.call(json[:params], json[:error])
    end
    break if @exit
  end
end

#send_notification(method, **params) ⇒ Object 



252
253
254
 
# File 'lib/typeprof/lsp/server.rb', line 252

def send_notification(method, **params)
  @writer.write(method: method, params: params)
end

#send_request(method, **params, &blk) ⇒ Object 



256
257
258
259
260
 
# File 'lib/typeprof/lsp/server.rb', line 256

def send_request(method, **params, &blk)
  id = @request_id += 1
  @running_requests_from_server[id] = blk
  @writer.write(id: id, method: method, params: params)
end

#send_response(**msg) ⇒ Object 



247
248
249
250
 
# File 'lib/typeprof/lsp/server.rb', line 247

def send_response(**msg)
  @running_requests_from_client.delete(msg[:id])
  @writer.write(**msg)
end

#target_path?(path) ⇒ Boolean

: (String) -> bool

Returns:

  • (Boolean) 


151
152
153
154
155
156
157
 
# File 'lib/typeprof/lsp/server.rb', line 151

def target_path?(path)
  return true if @rbs_dir && path.start_with?(@rbs_dir)
  @cores.each do |folder, _|
    return true if path.start_with?(folder)
  end
  return false
end

#type_definitions(path, pos) ⇒ Object 



188
189
190
191
192
 
# File 'lib/typeprof/lsp/server.rb', line 188

def type_definitions(path, pos)
  aggregate_each_core(path) do |core|
    core.type_definitions(path, pos)
  end
end

#update_file(path, text) ⇒ Object 



176
177
178
179
180
 
# File 'lib/typeprof/lsp/server.rb', line 176

def update_file(path, text)
  each_core(path) do |core|
    core.update_file(path, text)
  end
end

#uri_to_path(uri) ⇒ Object 



102
103
104
 
# File 'lib/typeprof/lsp/server.rb', line 102

def uri_to_path(uri)
  uri.delete_prefix(@url_schema).split("/").map {|s| CGI.unescapeURIComponent(s) }.join("/")
end