Skip to content

Code section support for R Markdown #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
randy3k merged 3 commits into from
Feb 5, 2020
Merged

Code section support for R Markdown #186

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd68f9d
Extract get_r_document_section_symbols
renkun-ken Feb 5, 2020
afd8076
Implement get_rmd_document_section_symbols
renkun-ken Feb 5, 2020
9a500f0
Rename variables
renkun-ken Feb 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 125 additions & 50 deletions R/symbol.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,129 @@ SymbolKind <- list(
TypeParameter = 26
)

get_r_document_section_symbols <- function(uri, document) {
section_symbols <- NULL
section_lines <- seq_len(document$nline)
section_lines <- section_lines[
grep("^\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
document$content[section_lines])]
logger$info("document sections found: ", length(section_lines))
if (length(section_lines)) {
section_names <- trimws(gsub("^\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
"\\1", document$content[section_lines]))
section_end_lines <- c(section_lines[-1] - 1, document$nline)
section_symbols <- .mapply(function(name, start_line, end_line) {
symbol_information(
name = name,
kind = SymbolKind$String,
location = list(
uri = uri,
range = range(
start = document$to_lsp_position(row = start_line - 1, col = 0),
end = document$to_lsp_position(row = end_line - 1, col = nchar(document$line(end_line)))
)
)
)
}, list(section_names, section_lines, section_end_lines), NULL)
}

subsection_symbols <- NULL
subsection_lines <- seq_len(document$nline)
subsection_lines <- subsection_lines[
grep("^\\s+\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
document$content[subsection_lines])]
logger$info("document subsections found: ", length(subsection_lines))
if (length(subsection_lines)) {
subsection_names <- trimws(gsub("^\\s+\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
"\\1", document$content[subsection_lines]))
subsection_symbols <- .mapply(function(name, line) {
symbol_information(
name = name,
kind = SymbolKind$String,
location = list(
uri = uri,
range = range(
start = document$to_lsp_position(row = line - 1, col = 0),
end = document$to_lsp_position(row = line - 1, col = nchar(document$line(line)))
)
)
)
}, list(subsection_names, subsection_lines), NULL)
}

c(section_symbols, subsection_symbols)
}

get_rmd_document_section_symbols <- function(uri, document) {
content <- document$content
if (length(content) == 0) {
return(NULL)
}

block_lines <- grep("^\\s*```", content)
if (length(block_lines) %% 2 != 0) {
return(NULL)
}

if (grepl("^---\\s*$", content[[1]])) {
front_start <- 1L
front_end <- 2L
while (front_end <= document$nline) {
if (grepl("^---\\s*$", content[[front_end]])) {
block_lines <- c(front_start, front_end, block_lines)
break
}
front_end <- front_end + 1L
}
}

section_lines <- grepl("^#+\\s+\\S+", content)
for (i in seq_len(length(block_lines) / 2)) {
section_lines[seq.int(block_lines[[2 * i - 1]], block_lines[[2 * i]])] <- FALSE
}

section_lines <- which(section_lines)
section_num <- length(section_lines)
section_texts <- content[section_lines]
section_hashes <- gsub("^(#+)\\s+.+$", "\\1", section_texts)
section_levels <- nchar(section_hashes)
section_names <- gsub("^#+\\s+(.+)$", "\\1", section_texts)

section_symbols <- lapply(seq_len(section_num), function(i) {
start_line <- section_lines[[i]]
end_line <- document$nline
level <- section_levels[[i]]
j <- i + 1
while (j <= section_num) {
if (section_levels[[j]] <= level) {
end_line <- section_lines[[j]] - 1
break
}
j <- j + 1
}
symbol_information(
name = section_names[[i]],
kind = SymbolKind$String,
location = list(
uri = uri,
range = range(
start = document$to_lsp_position(row = start_line - 1, col = 0),
end = document$to_lsp_position(row = end_line - 1, col = nchar(document$line(end_line)))
)
)
)
})

section_symbols
}

get_document_section_symbols <- function(uri, document) {
if (document$is_rmarkdown) {
get_rmd_document_section_symbols(uri, document)
} else {
get_r_document_section_symbols(uri, document)
}
}

#' Get all the symbols in the document
#' @keywords internal
Expand All @@ -50,56 +173,8 @@ document_symbol_reply <- function(id, uri, workspace, document, capabilities) {
result <- definition_symbols

if (isTRUE(capabilities$hierarchicalDocumentSymbolSupport)) {
section_symbols <- NULL
section_lines <- seq_len(document$nline)
section_lines <- section_lines[
grep("^\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
document$content[section_lines])]
logger$info("document sections found: ", length(section_lines))
if (length(section_lines)) {
section_names <- trimws(gsub("^\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
"\\1", document$content[section_lines]))
section_end_lines <- c(section_lines[-1] - 1, document$nline)
section_symbols <- .mapply(function(name, start_line, end_line) {
symbol_information(
name = name,
kind = SymbolKind$String,
location = list(
uri = uri,
range = range(
start = document$to_lsp_position(row = start_line - 1, col = 0),
end = document$to_lsp_position(row = end_line - 1, col = nchar(document$line(end_line)))
)
)
)
}, list(section_names, section_lines, section_end_lines), NULL)
result <- c(result, section_symbols)
}

subsection_symbols <- NULL
subsection_lines <- seq_len(document$nline)
subsection_lines <- subsection_lines[
grep("^\\s+\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
document$content[subsection_lines])]
logger$info("document subsections found: ", length(subsection_lines))
if (length(subsection_lines)) {
subsection_names <- trimws(gsub("^\\s+\\#+\\s*(.+)\\s*(\\#{4,}|\\+{4,}|\\-{4,}|\\={4,})\\s*$",
"\\1", document$content[subsection_lines]))
subsection_symbols <- .mapply(function(name, line) {
symbol_information(
name = name,
kind = SymbolKind$String,
location = list(
uri = uri,
range = range(
start = document$to_lsp_position(row = line - 1, col = 0),
end = document$to_lsp_position(row = line - 1, col = nchar(document$line(line)))
)
)
)
}, list(subsection_names, subsection_lines), NULL)
result <- c(result, subsection_symbols)
}
section_symbols <- get_document_section_symbols(uri, document)
result <- c(result, section_symbols)
}

if (length(result) == 0) {
Expand Down