R/rd-section.R

In roxygen2: In-Line Documentation for R

#' @export
roxy_tag_parse.roxy_tag_section <- function(x) {
  tag_markdown(x)
}

#' @export
roxy_tag_rd.roxy_tag_section <- function(x, base_path, env) {
  pieces <- split_section_title(x$val)
  title <- strsplit(pieces[1], "\n", fixed = TRUE)[[1]]

  if (length(title) > 1) {
    warn_roxy_tag(
      x,
      c(
        "title spans multiple lines.",
        i = "Did you forget a colon (:) at the end of the title?"
      )
    )
    return()
  }

  rd_section_section(pieces[1], pieces[2])
}

# Split a section into title and content at the first `:`. Colons inside `{}`
# are ignored so that titles can contain code like `\code{base::split()}`
# (#1878).
split_section_title <- function(x) {
  chars <- strsplit(x, "", fixed = TRUE)[[1]]
  depth <- 0L
  escaped <- FALSE

  for (i in seq_along(chars)) {
    char <- chars[[i]]
    if (escaped) {
      escaped <- FALSE
    } else if (char == "\\") {
      escaped <- TRUE
    } else if (char == "{") {
      depth <- depth + 1L
    } else if (char == "}") {
      depth <- depth - 1L
    } else if (char == ":" && depth == 0L) {
      return(c(substr(x, 1, i - 1L), substr(x, i + 1L, nchar(x))))
    }
  }
  c(x, "")
}

rd_section_section <- function(title, content) {
  check_character(title)
  check_character(content)
  stopifnot(length(title) == length(content))

  rd_section("section", list(title = title, content = content))
}

#' @export
format.rd_section_section <- function(x, ...) {
  paste0(
    "\\section{",
    x$value$title,
    "}{\n",
    x$value$content,
    "\n}\n",
    collapse = "\n"
  )
}

#' @export
merge.rd_section_section <- function(x, y, ...) {
  stopifnot(identical(class(x), class(y)))

  dedup <- collapse(
    c(x$value$title, y$value$title),
    c(x$value$content, y$value$content),
    paste,
    collapse = "\n\n"
  )
  rd_section("section", list(title = dedup$key, content = unlist(dedup$value)))
}