Merge pull request #1064 from julia-vscode/sp/document-link-include

Use DocumentLinkProvider for include

Author: pfitzseb

src/languageserverinstance.jl

@@ -363,6 +363,7 @@ function Base.run(server::LanguageServerInstance)
     msg_dispatcher[julia_refreshLanguageServer_notification_type] = request_wrapper(julia_refreshLanguageServer_notification, server)
     msg_dispatcher[julia_getDocFromWord_request_type] = request_wrapper(julia_getDocFromWord_request, server)
     msg_dispatcher[textDocument_selectionRange_request_type] = request_wrapper(textDocument_selectionRange_request, server)
+    msg_dispatcher[textDocument_documentLink_request_type] = request_wrapper(textDocument_documentLink_request, server)
 
     # The exit notification message should not be wrapped in request_wrapper (which checks
     # if the server have been requested to be shut down). Instead, this message needs to be

src/protocol/features.jl

@@ -114,6 +114,8 @@ end
 
 @dict_readable struct DocumentLinkParams
     textDocument::TextDocumentIdentifier
+    workDoneToken::Union{Int,String,Missing}
+    partialResultToken::Union{Int,String,Missing}
 end
 
 struct DocumentLink <: Outbound

src/protocol/messagedefs.jl

@@ -18,6 +18,7 @@ const textDocument_willSave_notification_type = JSONRPC.NotificationType("textDo
 const textDocument_willSaveWaitUntil_request_type = JSONRPC.RequestType("textDocument/willSaveWaitUntil", WillSaveTextDocumentParams, Union{Vector{TextEdit}, Nothing})
 const textDocument_publishDiagnostics_notification_type = JSONRPC.NotificationType("textDocument/publishDiagnostics", PublishDiagnosticsParams)
 const textDocument_selectionRange_request_type = JSONRPC.RequestType("textDocument/selectionRange", SelectionRangeParams, Union{Vector{SelectionRange}, Nothing})
+const textDocument_documentLink_request_type = JSONRPC.RequestType("textDocument/documentLink", DocumentLinkParams, Union{Vector{DocumentLink}, Nothing})
 
 const workspace_executeCommand_request_type = JSONRPC.RequestType("workspace/executeCommand", ExecuteCommandParams, Any)
 const workspace_symbol_request_type = JSONRPC.RequestType("workspace/symbol", WorkspaceSymbolParams, Union{Vector{SymbolInformation}, Nothing})

src/requests/features.jl

@@ -77,22 +77,6 @@ function textDocument_definition_request(params::TextDocumentPositionParams, ser
         b = resolve_shadow_binding(b)
         (tls = StaticLint.retrieve_toplevel_scope(x)) === nothing && return locations
         get_definitions(b, tls, getenv(doc, server), locations)
-    elseif x isa EXPR && CSTParser.isstringliteral(x)
-        # TODO: move to its own function
-        if valof(x) isa String && sizeof(valof(x)) < 256 # AUDIT: OK
-            try
-                if isabspath(valof(x)) && safe_isfile(valof(x))
-                    push!(locations, Location(filepath2uri(valof(x)), Range(0, 0, 0, 0)))
-                elseif !isempty(getpath(doc)) && safe_isfile(joinpath(_dirname(getpath(doc)), valof(x)))
-                    push!(locations, Location(filepath2uri(joinpath(_dirname(getpath(doc)), valof(x))), Range(0, 0, 0, 0)))
-                end
-            catch err
-                isa(err, Base.IOError) ||
-                    isa(err, Base.SystemError) ||
-                    (VERSION == v"1.2.0" && isa(err, ErrorException) && err.msg == "type Nothing has no field captures ") ||
-                    rethrow()
-            end
-        end
     end
 
     return locations

src/requests/init.jl

@@ -2,35 +2,37 @@ function ServerCapabilities(client::ClientCapabilities)
     prepareSupport = !ismissing(client.textDocument) && !ismissing(client.textDocument.rename) && client.textDocument.rename.prepareSupport === true
 
     ServerCapabilities(
-    TextDocumentSyncOptions(true,
-    TextDocumentSyncKinds.Full,
-    false,
-    false,
-    SaveOptions(true)),
-    CompletionOptions(false, [".", "@", "\"", "^"], missing),
-    true,
-    SignatureHelpOptions(["(", ","], missing),
-    false,
-    true,
-    false,
-    false,
-    true,
-    true,
-    true,
-    true,
-    missing,
-    missing,
-    false,
-    true,
-    true,
-    missing,
-    RenameOptions(missing, prepareSupport),
-    false,
-    ExecuteCommandOptions(missing, collect(keys(LSActions))),
-    true,
-    true,
-    WorkspaceOptions(WorkspaceFoldersOptions(true, true)),
-    missing)
+        TextDocumentSyncOptions(true,
+            TextDocumentSyncKinds.Full,
+            false,
+            false,
+            SaveOptions(true)
+        ),
+        CompletionOptions(false, [".", "@", "\"", "^"], missing),
+        true,
+        SignatureHelpOptions(["(", ","], missing),
+        false,
+        true,
+        false,
+        false,
+        true,
+        true,
+        true,
+        true,
+        missing,
+        DocumentLinkOptions(false, missing),
+        false,
+        true,
+        true,
+        missing,
+        RenameOptions(missing, prepareSupport),
+        false,
+        ExecuteCommandOptions(missing, collect(keys(LSActions))),
+        true,
+        true,
+        WorkspaceOptions(WorkspaceFoldersOptions(true, true)),
+        missing
+    )
 
 end
 

src/requests/misc.jl

@@ -84,3 +84,34 @@ end
 
 julia_refreshLanguageServer_notification(_, server::LanguageServerInstance, conn) =
     trigger_symbolstore_reload(server)
+
+function textDocument_documentLink_request(params::DocumentLinkParams, server::LanguageServerInstance, conn)
+    doc = getdocument(server, URI2(params.textDocument.uri))
+    links = DocumentLink[]
+    find_document_links(getcst(doc), doc, 0, links)
+    return links
+end
+
+function find_document_links(x, doc, offset, links)
+    if x isa EXPR && CSTParser.isstringliteral(x)
+        if valof(x) isa String && sizeof(valof(x)) < 256 # AUDIT: OK
+            try
+                if isabspath(valof(x)) && safe_isfile(valof(x))
+                    path = valof(x)
+                    push!(links, DocumentLink(Range(doc, offset .+ (0:x.span)), filepath2uri(path), missing, missing))
+                elseif !isempty(getpath(doc)) && safe_isfile(joinpath(_dirname(getpath(doc)), valof(x)))
+                    path = joinpath(_dirname(getpath(doc)), valof(x))
+                    push!(links, DocumentLink(Range(doc, offset .+ (0:x.span)), filepath2uri(path), missing, missing))
+                end
+            catch err
+                isa(err, Base.IOError) || isa(err, Base.SystemError) || rethrow()
+            end
+        end
+    end
+    if x.args !== nothing
+        for arg in x
+            find_document_links(arg, doc, offset, links)
+            offset += arg.fullspan
+        end
+    end
+end

test/test_document.jl

@@ -124,3 +124,15 @@ end
     @test LanguageServer.get_offset(doc, 0, 6) == 9
     @test LanguageServer.get_position_at(doc, 9) == (0, 6)
 end
+
+@testset "document link provider" begin
+    doc = LS.Document(LS.filepath2uri(@__FILE__), """
+    include("test_document.jl")
+    include("runtests_does_not_exist.jl")
+    """, false)
+    links = LS.DocumentLink[]
+    LS.find_document_links(LS.getcst(doc), doc, 0, links)
+    @test length(links) == 1
+    # lowercase because windows drives can apparently be inconsistently capitalized
+    @test lowercase(links[1].target) == lowercase(LS.filepath2uri(@__FILE__))
+end