R/is_blank_line_needed_below.R

In GegznaV/addin.tools: Helper Functions to Create RStudio Add-ins

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' ' Check if a blank line is needed below.
#'
#' Checks if a blank line should be added below either all selected rows or
#' the first selected row.
#' @param where (string)
#'      If `"first"` - checks for a blank line below the first selected row.
#'      If `"last"` - checks for a blank line below the last selected row.
#' @rdname heplers
#'
#' @inheritParams rs_get_index
#'
#' @export
is_blank_line_needed_below <- function(where = c("last row", "first row"),
                                       context = rs_get_context()) {
  where <- match.arg(where)
  row <- switch(where,
    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    "first" = rs_get_index_first_selected_row(context = context),
    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    "last"  = rs_get_index_last_selected_row(context = context),
    # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    stop("Incorrect choice of `where`")
  )

  # Contents of row below the selection:
  txt <- context$contents[row + 1]

  # If the last line is selected, a blank line should be added:
  if (is.na(txt)) {
    return(TRUE)
  }
  # Remove spaces and check if string is empty:
  cond <- is_empty_or_spaces(txt)
  # If not empty (result: FALSE), then an empty row needs to be added:
  isTRUE(!cond)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~