631 lines
19 KiB
VimL
631 lines
19 KiB
VimL
" Author: w0rp <devw0rp@gmail.com>
|
|
" Description: Language Server Protocol client code
|
|
|
|
" A Dictionary for tracking connections.
|
|
let s:connections = get(s:, 'connections', {})
|
|
let g:ale_lsp_next_message_id = 1
|
|
|
|
" Given an id, which can be an executable or address, and a project path,
|
|
" create a new connection if needed. Return a unique ID for the connection.
|
|
function! ale#lsp#Register(executable_or_address, project, init_options) abort
|
|
let l:conn_id = a:executable_or_address . ':' . a:project
|
|
|
|
if !has_key(s:connections, l:conn_id)
|
|
" is_tsserver: 1 if the connection is for tsserver.
|
|
" data: The message data received so far.
|
|
" root: The project root.
|
|
" open_documents: A Dictionary mapping buffers to b:changedtick, keeping
|
|
" track of when documents were opened, and when we last changed them.
|
|
" initialized: 0 if the connection is ready, 1 otherwise.
|
|
" init_request_id: The ID for the init request.
|
|
" init_options: Options to send to the server.
|
|
" config: Configuration settings to send to the server.
|
|
" callback_list: A list of callbacks for handling LSP responses.
|
|
" capabilities_queue: The list of callbacks to call with capabilities.
|
|
" capabilities: Features the server supports.
|
|
let s:connections[l:conn_id] = {
|
|
\ 'id': l:conn_id,
|
|
\ 'is_tsserver': 0,
|
|
\ 'data': '',
|
|
\ 'root': a:project,
|
|
\ 'open_documents': {},
|
|
\ 'initialized': 0,
|
|
\ 'init_request_id': 0,
|
|
\ 'init_options': a:init_options,
|
|
\ 'config': {},
|
|
\ 'callback_list': [],
|
|
\ 'init_queue': [],
|
|
\ 'capabilities': {
|
|
\ 'hover': 0,
|
|
\ 'references': 0,
|
|
\ 'completion': 0,
|
|
\ 'completion_trigger_characters': [],
|
|
\ 'definition': 0,
|
|
\ 'typeDefinition': 0,
|
|
\ 'symbol_search': 0,
|
|
\ },
|
|
\}
|
|
endif
|
|
|
|
return l:conn_id
|
|
endfunction
|
|
|
|
" Remove an LSP connection with a given ID. This is only for tests.
|
|
function! ale#lsp#RemoveConnectionWithID(id) abort
|
|
if has_key(s:connections, a:id)
|
|
call remove(s:connections, a:id)
|
|
endif
|
|
endfunction
|
|
|
|
function! ale#lsp#ResetConnections() abort
|
|
let s:connections = {}
|
|
endfunction
|
|
|
|
" Used only in tests.
|
|
function! ale#lsp#GetConnections() abort
|
|
return s:connections
|
|
endfunction
|
|
|
|
" This is only needed for tests
|
|
function! ale#lsp#MarkDocumentAsOpen(id, buffer) abort
|
|
let l:conn = get(s:connections, a:id, {})
|
|
|
|
if !empty(l:conn)
|
|
let l:conn.open_documents[a:buffer] = -1
|
|
endif
|
|
endfunction
|
|
|
|
function! ale#lsp#GetNextMessageID() abort
|
|
" Use the current ID
|
|
let l:id = g:ale_lsp_next_message_id
|
|
|
|
" Increment the ID variable.
|
|
let g:ale_lsp_next_message_id += 1
|
|
|
|
" When the ID overflows, reset it to 1. By the time we hit the initial ID
|
|
" again, the messages will be long gone.
|
|
if g:ale_lsp_next_message_id < 1
|
|
let g:ale_lsp_next_message_id = 1
|
|
endif
|
|
|
|
return l:id
|
|
endfunction
|
|
|
|
" TypeScript messages use a different format.
|
|
function! s:CreateTSServerMessageData(message) abort
|
|
let l:is_notification = a:message[0]
|
|
|
|
let l:obj = {
|
|
\ 'seq': v:null,
|
|
\ 'type': 'request',
|
|
\ 'command': a:message[1][3:],
|
|
\}
|
|
|
|
if !l:is_notification
|
|
let l:obj.seq = ale#lsp#GetNextMessageID()
|
|
endif
|
|
|
|
if len(a:message) > 2
|
|
let l:obj.arguments = a:message[2]
|
|
endif
|
|
|
|
let l:data = json_encode(l:obj) . "\n"
|
|
|
|
return [l:is_notification ? 0 : l:obj.seq, l:data]
|
|
endfunction
|
|
|
|
" Given a List of one or two items, [method_name] or [method_name, params],
|
|
" return a List containing [message_id, message_data]
|
|
function! ale#lsp#CreateMessageData(message) abort
|
|
if a:message[1][:2] is# 'ts@'
|
|
return s:CreateTSServerMessageData(a:message)
|
|
endif
|
|
|
|
let l:is_notification = a:message[0]
|
|
|
|
let l:obj = {
|
|
\ 'method': a:message[1],
|
|
\ 'jsonrpc': '2.0',
|
|
\}
|
|
|
|
if !l:is_notification
|
|
let l:obj.id = ale#lsp#GetNextMessageID()
|
|
endif
|
|
|
|
if len(a:message) > 2
|
|
let l:obj.params = a:message[2]
|
|
endif
|
|
|
|
let l:body = json_encode(l:obj)
|
|
let l:data = 'Content-Length: ' . strlen(l:body) . "\r\n\r\n" . l:body
|
|
|
|
return [l:is_notification ? 0 : l:obj.id, l:data]
|
|
endfunction
|
|
|
|
function! ale#lsp#ReadMessageData(data) abort
|
|
let l:response_list = []
|
|
let l:remainder = a:data
|
|
|
|
while 1
|
|
" Look for the end of the HTTP headers
|
|
let l:body_start_index = matchend(l:remainder, "\r\n\r\n")
|
|
|
|
if l:body_start_index < 0
|
|
" No header end was found yet.
|
|
break
|
|
endif
|
|
|
|
" Parse the Content-Length header.
|
|
let l:header_data = l:remainder[:l:body_start_index - 4]
|
|
let l:length_match = matchlist(
|
|
\ l:header_data,
|
|
\ '\vContent-Length: *(\d+)'
|
|
\)
|
|
|
|
if empty(l:length_match)
|
|
throw "Invalid JSON-RPC header:\n" . l:header_data
|
|
endif
|
|
|
|
" Split the body and the remainder of the text.
|
|
let l:remainder_start_index = l:body_start_index + str2nr(l:length_match[1])
|
|
|
|
if len(l:remainder) < l:remainder_start_index
|
|
" We don't have enough data yet.
|
|
break
|
|
endif
|
|
|
|
let l:body = l:remainder[l:body_start_index : l:remainder_start_index - 1]
|
|
let l:remainder = l:remainder[l:remainder_start_index :]
|
|
|
|
" Parse the JSON object and add it to the list.
|
|
call add(l:response_list, json_decode(l:body))
|
|
endwhile
|
|
|
|
return [l:remainder, l:response_list]
|
|
endfunction
|
|
|
|
" Update capabilities from the server, so we know which features the server
|
|
" supports.
|
|
function! s:UpdateCapabilities(conn, capabilities) abort
|
|
if type(a:capabilities) isnot v:t_dict
|
|
return
|
|
endif
|
|
|
|
if get(a:capabilities, 'hoverProvider') is v:true
|
|
let a:conn.capabilities.hover = 1
|
|
endif
|
|
|
|
if get(a:capabilities, 'referencesProvider') is v:true
|
|
let a:conn.capabilities.references = 1
|
|
endif
|
|
|
|
if !empty(get(a:capabilities, 'completionProvider'))
|
|
let a:conn.capabilities.completion = 1
|
|
endif
|
|
|
|
if type(get(a:capabilities, 'completionProvider')) is v:t_dict
|
|
let l:chars = get(a:capabilities.completionProvider, 'triggerCharacters')
|
|
|
|
if type(l:chars) is v:t_list
|
|
let a:conn.capabilities.completion_trigger_characters = l:chars
|
|
endif
|
|
endif
|
|
|
|
if get(a:capabilities, 'definitionProvider') is v:true
|
|
let a:conn.capabilities.definition = 1
|
|
endif
|
|
|
|
if get(a:capabilities, 'typeDefinitionProvider') is v:true
|
|
let a:conn.capabilities.typeDefinition = 1
|
|
endif
|
|
|
|
if get(a:capabilities, 'workspaceSymbolProvider') is v:true
|
|
let a:conn.capabilities.symbol_search = 1
|
|
endif
|
|
endfunction
|
|
|
|
" Update a connection's configuration dictionary and notify LSP servers
|
|
" of any changes since the last update. Returns 1 if a configuration
|
|
" update was sent; otherwise 0 will be returned.
|
|
function! ale#lsp#UpdateConfig(conn_id, buffer, config) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if empty(l:conn) || a:config ==# l:conn.config " no-custom-checks
|
|
return 0
|
|
endif
|
|
|
|
let l:conn.config = a:config
|
|
let l:message = ale#lsp#message#DidChangeConfiguration(a:buffer, a:config)
|
|
|
|
call ale#lsp#Send(a:conn_id, l:message)
|
|
|
|
return 1
|
|
endfunction
|
|
|
|
|
|
function! ale#lsp#HandleInitResponse(conn, response) abort
|
|
if get(a:response, 'method', '') is# 'initialize'
|
|
let a:conn.initialized = 1
|
|
elseif type(get(a:response, 'result')) is v:t_dict
|
|
\&& has_key(a:response.result, 'capabilities')
|
|
call s:UpdateCapabilities(a:conn, a:response.result.capabilities)
|
|
|
|
let a:conn.initialized = 1
|
|
endif
|
|
|
|
if !a:conn.initialized
|
|
return
|
|
endif
|
|
|
|
" The initialized message must be sent before everything else.
|
|
call ale#lsp#Send(a:conn.id, ale#lsp#message#Initialized())
|
|
|
|
" Call capabilities callbacks queued for the project.
|
|
for l:Callback in a:conn.init_queue
|
|
call l:Callback()
|
|
endfor
|
|
|
|
let a:conn.init_queue = []
|
|
endfunction
|
|
|
|
function! ale#lsp#HandleMessage(conn_id, message) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if empty(l:conn)
|
|
return
|
|
endif
|
|
|
|
if type(a:message) isnot v:t_string
|
|
" Ignore messages that aren't strings.
|
|
return
|
|
endif
|
|
|
|
let l:conn.data .= a:message
|
|
|
|
" Parse the objects now if we can, and keep the remaining text.
|
|
let [l:conn.data, l:response_list] = ale#lsp#ReadMessageData(l:conn.data)
|
|
|
|
" Look for initialize responses first.
|
|
if !l:conn.initialized
|
|
for l:response in l:response_list
|
|
call ale#lsp#HandleInitResponse(l:conn, l:response)
|
|
endfor
|
|
endif
|
|
|
|
" If the connection is marked as initialized, call the callbacks with the
|
|
" responses.
|
|
if l:conn.initialized
|
|
for l:response in l:response_list
|
|
" Call all of the registered handlers with the response.
|
|
for l:Callback in l:conn.callback_list
|
|
call ale#util#GetFunction(l:Callback)(a:conn_id, l:response)
|
|
endfor
|
|
endfor
|
|
endif
|
|
endfunction
|
|
|
|
" Given a connection ID, mark it as a tsserver connection, so it will be
|
|
" handled that way.
|
|
function! ale#lsp#MarkConnectionAsTsserver(conn_id) abort
|
|
let l:conn = s:connections[a:conn_id]
|
|
let l:conn.is_tsserver = 1
|
|
let l:conn.initialized = 1
|
|
" Set capabilities which are supported by tsserver.
|
|
let l:conn.capabilities.hover = 1
|
|
let l:conn.capabilities.references = 1
|
|
let l:conn.capabilities.completion = 1
|
|
let l:conn.capabilities.completion_trigger_characters = ['.']
|
|
let l:conn.capabilities.definition = 1
|
|
let l:conn.capabilities.symbol_search = 1
|
|
endfunction
|
|
|
|
function! s:SendInitMessage(conn) abort
|
|
let [l:init_id, l:init_data] = ale#lsp#CreateMessageData(
|
|
\ ale#lsp#message#Initialize(
|
|
\ a:conn.root,
|
|
\ a:conn.init_options,
|
|
\ {
|
|
\ 'workspace': {
|
|
\ 'applyEdit': v:false,
|
|
\ 'didChangeConfiguration': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ 'symbol': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ 'workspaceFolders': v:false,
|
|
\ 'configuration': v:false,
|
|
\ },
|
|
\ 'textDocument': {
|
|
\ 'synchronization': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ 'willSave': v:false,
|
|
\ 'willSaveWaitUntil': v:false,
|
|
\ 'didSave': v:true,
|
|
\ },
|
|
\ 'completion': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ 'completionItem': {
|
|
\ 'snippetSupport': v:false,
|
|
\ 'commitCharactersSupport': v:false,
|
|
\ 'documentationFormat': ['plaintext'],
|
|
\ 'deprecatedSupport': v:false,
|
|
\ 'preselectSupport': v:false,
|
|
\ },
|
|
\ 'contextSupport': v:false,
|
|
\ },
|
|
\ 'hover': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ 'contentFormat': ['plaintext'],
|
|
\ },
|
|
\ 'references': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ 'documentSymbol': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ 'hierarchicalDocumentSymbolSupport': v:false,
|
|
\ },
|
|
\ 'definition': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ 'linkSupport': v:false,
|
|
\ },
|
|
\ 'typeDefinition': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ 'publishDiagnostics': {
|
|
\ 'relatedInformation': v:true,
|
|
\ },
|
|
\ 'codeAction': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ 'rename': {
|
|
\ 'dynamicRegistration': v:false,
|
|
\ },
|
|
\ },
|
|
\ },
|
|
\ ),
|
|
\)
|
|
let a:conn.init_request_id = l:init_id
|
|
call s:SendMessageData(a:conn, l:init_data)
|
|
endfunction
|
|
|
|
" Start a program for LSP servers.
|
|
"
|
|
" 1 will be returned if the program is running, or 0 if the program could
|
|
" not be started.
|
|
function! ale#lsp#StartProgram(conn_id, executable, command) abort
|
|
let l:conn = s:connections[a:conn_id]
|
|
let l:started = 0
|
|
|
|
if !has_key(l:conn, 'job_id') || !ale#job#HasOpenChannel(l:conn.job_id)
|
|
let l:options = {
|
|
\ 'mode': 'raw',
|
|
\ 'out_cb': {_, message -> ale#lsp#HandleMessage(a:conn_id, message)},
|
|
\}
|
|
|
|
if has('win32')
|
|
let l:job_id = ale#job#StartWithCmd(a:command, l:options)
|
|
else
|
|
let l:job_id = ale#job#Start(a:command, l:options)
|
|
endif
|
|
|
|
let l:started = 1
|
|
else
|
|
let l:job_id = l:conn.job_id
|
|
endif
|
|
|
|
if l:job_id > 0
|
|
let l:conn.job_id = l:job_id
|
|
endif
|
|
|
|
if l:started && !l:conn.is_tsserver
|
|
call s:SendInitMessage(l:conn)
|
|
endif
|
|
|
|
return l:job_id > 0
|
|
endfunction
|
|
|
|
" Connect to an LSP server via TCP.
|
|
"
|
|
" 1 will be returned if the connection is running, or 0 if the connection could
|
|
" not be opened.
|
|
function! ale#lsp#ConnectToAddress(conn_id, address) abort
|
|
let l:conn = s:connections[a:conn_id]
|
|
let l:started = 0
|
|
|
|
if !has_key(l:conn, 'channel_id') || !ale#socket#IsOpen(l:conn.channel_id)
|
|
let l:channel_id = ale#socket#Open(a:address, {
|
|
\ 'callback': {_, mess -> ale#lsp#HandleMessage(a:conn_id, mess)},
|
|
\})
|
|
|
|
let l:started = 1
|
|
else
|
|
let l:channel_id = l:conn.channel_id
|
|
endif
|
|
|
|
if l:channel_id >= 0
|
|
let l:conn.channel_id = l:channel_id
|
|
endif
|
|
|
|
if l:started
|
|
call s:SendInitMessage(l:conn)
|
|
endif
|
|
|
|
return l:channel_id >= 0
|
|
endfunction
|
|
|
|
" Given a connection ID and a callback, register that callback for handling
|
|
" messages if the connection exists.
|
|
function! ale#lsp#RegisterCallback(conn_id, callback) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if !empty(l:conn)
|
|
" Add the callback to the List if it's not there already.
|
|
call uniq(sort(add(l:conn.callback_list, a:callback)))
|
|
endif
|
|
endfunction
|
|
|
|
" Stop a single LSP connection.
|
|
function! ale#lsp#Stop(conn_id) abort
|
|
if has_key(s:connections, a:conn_id)
|
|
let l:conn = remove(s:connections, a:conn_id)
|
|
|
|
if has_key(l:conn, 'channel_id')
|
|
call ale#socket#Close(l:conn.channel_id)
|
|
elseif has_key(l:conn, 'job_id')
|
|
call ale#job#Stop(l:conn.job_id)
|
|
endif
|
|
endif
|
|
endfunction
|
|
|
|
function! ale#lsp#CloseDocument(conn_id) abort
|
|
endfunction
|
|
|
|
" Stop all LSP connections, closing all jobs and channels, and removing any
|
|
" queued messages.
|
|
function! ale#lsp#StopAll() abort
|
|
for l:conn_id in keys(s:connections)
|
|
call ale#lsp#Stop(l:conn_id)
|
|
endfor
|
|
endfunction
|
|
|
|
function! s:SendMessageData(conn, data) abort
|
|
if has_key(a:conn, 'job_id')
|
|
call ale#job#SendRaw(a:conn.job_id, a:data)
|
|
elseif has_key(a:conn, 'channel_id') && ale#socket#IsOpen(a:conn.channel_id)
|
|
" Send the message to the server
|
|
call ale#socket#Send(a:conn.channel_id, a:data)
|
|
else
|
|
return 0
|
|
endif
|
|
|
|
return 1
|
|
endfunction
|
|
|
|
" Send a message to an LSP server.
|
|
" Notifications do not need to be handled.
|
|
"
|
|
" Returns -1 when a message is sent, but no response is expected
|
|
" 0 when the message is not sent and
|
|
" >= 1 with the message ID when a response is expected.
|
|
function! ale#lsp#Send(conn_id, message) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if empty(l:conn)
|
|
return 0
|
|
endif
|
|
|
|
if !l:conn.initialized
|
|
throw 'LSP server not initialized yet!'
|
|
endif
|
|
|
|
let [l:id, l:data] = ale#lsp#CreateMessageData(a:message)
|
|
call s:SendMessageData(l:conn, l:data)
|
|
|
|
return l:id == 0 ? -1 : l:id
|
|
endfunction
|
|
|
|
" Notify LSP servers or tsserver if a document is opened, if needed.
|
|
" If a document is opened, 1 will be returned, otherwise 0 will be returned.
|
|
function! ale#lsp#OpenDocument(conn_id, buffer, language_id) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
let l:opened = 0
|
|
|
|
if !empty(l:conn) && !has_key(l:conn.open_documents, a:buffer)
|
|
if l:conn.is_tsserver
|
|
let l:message = ale#lsp#tsserver_message#Open(a:buffer)
|
|
else
|
|
let l:message = ale#lsp#message#DidOpen(a:buffer, a:language_id)
|
|
endif
|
|
|
|
call ale#lsp#Send(a:conn_id, l:message)
|
|
let l:conn.open_documents[a:buffer] = getbufvar(a:buffer, 'changedtick')
|
|
let l:opened = 1
|
|
endif
|
|
|
|
return l:opened
|
|
endfunction
|
|
|
|
" Notify LSP servers or tsserver that a document is closed, if opened before.
|
|
" If a document is closed, 1 will be returned, otherwise 0 will be returned.
|
|
"
|
|
" Only the buffer number is required here. A message will be sent to every
|
|
" language server that was notified previously of the document being opened.
|
|
function! ale#lsp#CloseDocument(buffer) abort
|
|
let l:closed = 0
|
|
|
|
" The connection keys are sorted so the messages are easier to test, and
|
|
" so messages are sent in a consistent order.
|
|
for l:conn_id in sort(keys(s:connections))
|
|
let l:conn = s:connections[l:conn_id]
|
|
|
|
if l:conn.initialized && has_key(l:conn.open_documents, a:buffer)
|
|
if l:conn.is_tsserver
|
|
let l:message = ale#lsp#tsserver_message#Close(a:buffer)
|
|
else
|
|
let l:message = ale#lsp#message#DidClose(a:buffer)
|
|
endif
|
|
|
|
call ale#lsp#Send(l:conn_id, l:message)
|
|
call remove(l:conn.open_documents, a:buffer)
|
|
let l:closed = 1
|
|
endif
|
|
endfor
|
|
|
|
return l:closed
|
|
endfunction
|
|
|
|
" Notify LSP servers or tsserver that a document has changed, if needed.
|
|
" If a notification is sent, 1 will be returned, otherwise 0 will be returned.
|
|
function! ale#lsp#NotifyForChanges(conn_id, buffer) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
let l:notified = 0
|
|
|
|
if !empty(l:conn) && has_key(l:conn.open_documents, a:buffer)
|
|
let l:new_tick = getbufvar(a:buffer, 'changedtick')
|
|
|
|
if l:conn.open_documents[a:buffer] < l:new_tick
|
|
if l:conn.is_tsserver
|
|
let l:message = ale#lsp#tsserver_message#Change(a:buffer)
|
|
else
|
|
let l:message = ale#lsp#message#DidChange(a:buffer)
|
|
endif
|
|
|
|
call ale#lsp#Send(a:conn_id, l:message)
|
|
let l:conn.open_documents[a:buffer] = l:new_tick
|
|
let l:notified = 1
|
|
endif
|
|
endif
|
|
|
|
return l:notified
|
|
endfunction
|
|
|
|
" Wait for an LSP server to be initialized.
|
|
function! ale#lsp#OnInit(conn_id, Callback) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if empty(l:conn)
|
|
return
|
|
endif
|
|
|
|
if l:conn.initialized
|
|
call a:Callback()
|
|
else
|
|
call add(l:conn.init_queue, a:Callback)
|
|
endif
|
|
endfunction
|
|
|
|
" Check if an LSP has a given capability.
|
|
function! ale#lsp#HasCapability(conn_id, capability) abort
|
|
let l:conn = get(s:connections, a:conn_id, {})
|
|
|
|
if empty(l:conn)
|
|
return 0
|
|
endif
|
|
|
|
if type(get(l:conn.capabilities, a:capability, v:null)) isnot v:t_number
|
|
throw 'Invalid capability ' . a:capability
|
|
endif
|
|
|
|
return l:conn.capabilities[a:capability]
|
|
endfunction
|