Merge pull request #416 from renkun-ken/def-path

Definition provider works with file path

Author: renkun-ken

.github/workflows/coverage.yml

@@ -3,32 +3,36 @@ name: coverage
 on: [push, pull_request]
 
 jobs:
-  macos:
+  linux:
     if: contains(github.event.head_commit.message, '[ci skip]') == false
     strategy:
       matrix:
         r: [latest]
         # r: [3.5, 3.6, devel]
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
+    container: rocker/tidyverse:${{ matrix.r }}
     env:
       NOT_CRAN: true
       R_LANGSVR_LOG: /tmp/languageserver/coverage-log
       R_LANGSVR_POOL_SIZE: 1
       R_LANGSVR_TEST_FAST: NO
     steps:
     - uses: actions/checkout@v1
-    - uses: r-lib/actions/setup-r@v1
-      with:
-        r-version: ${{ matrix.r }}
-    - name: Install languagesever
+    - name: Install apt-get dependencies
+      run: |
+        apt-get update
+        apt-get install git ssh curl bzip2 libffi-dev -y
+    - name: Install packages
       run: |
-        Rscript -e "install.packages(c('remotes'), repos = 'https://cloud.r-project.org')"
+        Rscript -e "install.packages(c('remotes','covr'), repos = 'https://cloud.r-project.org')"
         Rscript -e "remotes::install_deps(dependencies = TRUE)"
         Rscript -e "remotes::install_local()"
     - name: Codecov
       run: |
         mkdir -p /tmp/languageserver
         Rscript -e "covr::codecov(quiet = FALSE, clean = FALSE)"
+      shell:
+        bash
       env:
         CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
     - uses: actions/upload-artifact@v1

R/definition.R

@@ -12,7 +12,7 @@ definition_xpath <- paste(
 #' writes the function definition to a temporary file and returns that
 #' as the location.
 #' @keywords internal
-definition_reply <- function(id, uri, workspace, document, point) {
+definition_reply <- function(id, uri, workspace, document, point, rootPath) {
 
     token_result <- document$detect_token(point)
     resolved <- FALSE
@@ -56,6 +56,29 @@ definition_reply <- function(id, uri, workspace, document, point) {
                         resolved <- TRUE
                     }
                 }
+            } else if (token_name == "STR_CONST") {
+                str_line1 <- as.integer(xml_attr(token, "line1"))
+                str_line2 <- as.integer(xml_attr(token, "line2"))
+                if (str_line1 == str_line2) {
+                    str_col1 <- as.integer(xml_attr(token, "col1"))
+                    str_col2 <- as.integer(xml_attr(token, "col2"))
+                    str_expr <- substr(document$content[str_line1], str_col1, str_col2)
+                    str_text <- tryCatch(as.character(parse(text = str_expr, keep.source = FALSE)),
+                        error = function(e) NULL)
+                    if (is.character(str_text)) {
+                        path <- fs::path_abs(str_text, rootPath)
+                        if (file.exists(path) && !dir.exists(path) && is_text_file(path)) {
+                            result <- list(
+                                uri = path_to_uri(path),
+                                range = range(
+                                    start = position(0, 0),
+                                    end = position(0, 0)
+                                )
+                            )
+                        }
+                    }
+                }
+                resolved <- TRUE
             } else {
                 resolved <- TRUE
             }

R/handlers-langfeatures.R

@@ -55,7 +55,8 @@ text_document_definition  <- function(self, id, params) {
     uri <- uri_escape_unicode(textDocument$uri)
     document <- self$workspace$documents$get(uri)
     point <- document$from_lsp_position(params$position)
-    self$deliver(definition_reply(id, uri, self$workspace, document, point))
+    rootPath <- if (length(self$rootPath)) self$rootPath else dirname(path_from_uri(uri))
+    self$deliver(definition_reply(id, uri, self$workspace, document, point, rootPath))
 }
 
 #' `textDocument/typeDefinition` request handler

R/link.R

@@ -1,5 +1,5 @@
 #' The response to a textDocument/documentLink Request
-#'
+#' @param rootPath Path of workspace folder
 #' @keywords internal
 document_link_reply <- function(id, uri, workspace, document, rootPath) {
     result <- NULL

R/utils.R

@@ -688,3 +688,18 @@ format_file_size <- function(bytes) {
     obj_size <- structure(bytes, class = "object_size")
     format(obj_size, units = "auto")
 }
+
+is_text_file <- function(path, n = 1000) {
+    bin <- readBin(path, "raw", n = n)
+    is_utf8 <- stringi::stri_enc_isutf8(bin)
+    if (is_utf8) {
+        return(TRUE)
+    } else {
+        result <- stringi::stri_enc_detect(bin)[[1]]
+        conf <- result$Confidence[1]
+        if (identical(conf, 1)) {
+            return(TRUE)
+        }
+    }
+    return(FALSE)
+}

man/definition_reply.Rd

@@ -261,3 +261,31 @@ test_that("Go to Definition in Rmarkdown works", {
 
     expect_equal(length(result), 0)
 })
+
+test_that("Go to Definition works for file paths", {
+    skip_on_cran()
+
+    dir <- tempdir()
+    client <- language_client(dir)
+
+    defn_file <- withr::local_tempfile(tmpdir = dir, fileext = ".R")
+    query_file <- withr::local_tempfile(tmpdir = dir, fileext = ".R")
+
+    defn_file <- format(fs::path(defn_file))
+    query_file <- format(fs::path(query_file))
+
+    writeLines(c("my_fn <- function(x) {", "  x + 1", "}"), defn_file)
+    writeLines(c(
+        sprintf("source('%s')", defn_file),
+        sprintf("source('%s')", basename(defn_file))
+    ), query_file)
+
+    client %>% did_save(defn_file)
+    client %>% did_save(query_file)
+
+    result <- client %>% respond_definition(query_file, c(0, 9))
+    expect_equal(result$uri, path_to_uri(defn_file))
+
+    result <- client %>% respond_definition(query_file, c(1, 9))
+    expect_equal(result$uri, path_to_uri(defn_file))
+})