R/attrs.R

In cheapr: Simple Functions to Save Time and Memory

#' Add and remove attributes
#'
#' @description
#' Simple tools to add and remove attributes, both normally and in-place.
#' To remove specific attributes, set those attributes to `NULL`.
#'
#'
#' @param x Object to add/remove attributes.
#' @param ... Named attributes, e.g 'key = value'.
#' @param .set Should attributes be added in-place without shallow-copying `x`?
#' Default is `FALSE`.
#' @param .args An alternative to `...` for easier programming with lists.
#'
#' @seealso [shallow_copy]
#'
#' @name attrs
#'
#' @returns
#' The object `x` with attributes removed or added.
#'
#' @rdname attrs
#' @export
attrs_modify <- function(x, ..., .set = FALSE, .args = NULL){
  if (.set){
    .Call( `_cheapr_cpp_set_add_attributes`, x, .Call(`_cheapr_cpp_list_args`, list(...), .args), TRUE)
  } else {
    `attributes<-`(
      x, list_assign(
        attributes(x) %||% list(),
        .Call(`_cheapr_cpp_list_args`, list(...), .args)
      )
    )
  }
}
#' @rdname attrs
#' @export
attrs_add <- attrs_modify
#' @rdname attrs
#' @export
attrs_clear <- function(x, .set = FALSE){
  if (.set){
    .Call(`_cheapr_cpp_set_rm_attributes`, x)
  } else {
    `attributes<-`(x, NULL)
  }
}
#' @rdname attrs
#' @export
attrs_rm <- attrs_clear