Work in Positron

[tjmahr]

The selection

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum a
`r max(iris$Sepal.Length)`, viverra nisl at, luctus ante =
`r length(letters) * 2 + 100`.

becomes

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum a
`r max(iris$Sepal.Length)`, viverra nisl at, luctus ante =
`r length(letters) * 2 + 100`.iverra nisl at, luctus ante =
`r length(letters) * 2 + 100`.

when WrapRmd::wrap_rmd_addin() is called from the Session pane.

[tjmahr]

When the source editor cursor is on line 6, running rstudioapi::insertText("hello"):

• in Positron, puts hello on line 5. The code was run by running the code in the R Session console.
• in RStudio, puts hello on line 6. The code was run by invoking the command palette on a test RStudio addin

[tjmahr]

rstudio/rstudioapi#315 is about something different. rstudioapi::insertText(text = "hello") doesn't work in Positron but rstudioapi::insertText("hello") does work in Positron.

This is how insertText() is implemented in RStudio: https://github.com/rstudio/rstudio/blob/04518eff505cc50f88a648ddfc913c6c43ed2608/src/cpp/r/R/Api.R#L345-L404

.rs.addApiFunction("insertText", function(location, text, id = "")
{
   invalidTextMsg <- "'text' should be a character vector"
   invalidLengthMsg <- "'text' should either be length 1, or same length as 'ranges'"

   if (is.null(id))
      id <- ""

   if (!is.character(id))
      stop("'id' must be NULL or a character vector of length one")

   # allow calls of the form:
   #
   #    insertText("foo")
   #    insertText(text = "foo")
   #
   # in such cases, we replace the current selection. we pass an empty range
   # and let upstream interpret this as a request to replace the current
   # selection.
   if (missing(location))
      location <- NULL
   
   if (missing(text))
      text <- NULL
   
   if (is.null(text) && is.character(location))
   {
      return(.rs.api.selectionSet(value = location, id = id))
   }
   else if (is.null(location) && is.character(text))
   {
      return(.rs.api.selectionSet(value = text, id = id))
   }
   else if (length(location) == 0)
   {
      return()
   }

   ranges <- .rs.validateAndTransformLocation(location)
   if (!is.character(text))
      stop(invalidTextMsg, call. = FALSE)

   if (length(text) != 1 && length(ranges) != length(text))
      stop(invalidLengthMsg, call. = FALSE)

   # sort the ranges in decreasing order -- this way, we can
   # ensure the replacements occur correctly (except in the
   # case of overlaps)
   if (length(ranges)) {
      idx <- order(unlist(lapply(ranges, `[[`, 1)))

      ranges <- ranges[idx]
      if (length(text) != 1)
         text <- text[idx]
   }

   data <- list(ranges = ranges, text = text, id = .rs.scalar(id))
   .rs.enqueEditorClientEvent("replace_ranges", data)
   invisible(data)
})

This is how insertText() is implemented in Ark: https://github.com/posit-dev/ark/blob/8a51524c98fd5410573ffe287970dad41b249e31/crates/ark/src/modules/rstudio/document-api.R#L7C1-L30C2

.rs.api.insertText <- function(location = NULL, text = NULL, id = NULL) {
    # TODO: Support document IDs
    stopifnot(is.null(id))

    # For compatibility with calls like `rstudioapi::insertText("foo")`
    if (is.null(text)) {
        text <- location
        context <- .ps.ui.LastActiveEditorContext()
        location <- lapply(context$selections, selection_as_range)
    }

    ranges <- asRangeList(location)
    if (length(text) == 1L) {
        text <- rep(text, length(ranges))
    }
    stopifnot(length(text) == length(ranges))

    .ps.ui.modifyEditorSelections(ranges, text)
    invisible(list(
        ranges = ranges,
        text = text,
        id = id
    ))
}

(Looks like letting ark handle location = NULL would solve rstudio/rstudioapi#315)

Drilling down a bit... create the following function in Positron

get_selection_line_range <- function() {
  env_rs_api <- environment(.rs.api.askForPassword) 
  .ps.ui.LastActiveEditorContext() |> 
    _$selections |> 
    lapply(env_rs_api$selection_as_range)
}

Put the cursor on line 6 and run the get_selection_line_range() in the R Session.

get_selection_line_range()
#> [[1]]
#> [1] 5 0 5 0

Okay, let's experiment some more. In Positron, create these two lines of text with cursor sitting where | is. Run rstudioapi::insertText("Hello").

123456
1|23456

becomes

Hello123456
123456

But in RStudio, we have:

123456
1|23456

becomes

123456
1hello23456