R/options.R

In curl: A Modern and Flexible Web Client for R

#' List curl version and options.
#'
#' `curl_version()` shows the versions of libcurl, libssl and zlib and
#' supported protocols. `curl_options()` lists all options available in
#' the current version of libcurl.  The dataset `curl_symbols` lists all
#' symbols (including options) provides more information about the symbols,
#' including when support was added/removed from libcurl.
#'
#' @export
#' @rdname curl_options
#' @param filter string: only return options with string in name
#' @examples # Available options
#' curl_options()
#'
#' # List proxy options
#' curl_options("proxy")
#'
#' # Symbol table
#' curl_symbols("proxy")
curl_options <- function(filter = ""){
  option_type_table <- make_option_type_table()
  opts <- structure(option_type_table$value, names = option_type_table$name)
  m <- grep(filter, names(opts), ignore.case = TRUE)
  opts[m]
}

#' @export
#' @rdname curl_options
curl_options_table <- function(filter = ""){
  option_type_table <- make_option_type_table()
  m <- grep(filter, option_type_table$name, ignore.case = TRUE)
  option_type_table[m,]
}

#' @useDynLib curl R_option_types
make_option_type_table <- local({
  cache <- NULL
  function(){
    if(is.null(cache)){
      out <- .Call(R_option_types)
      if(!length(out)) return(out)
      out$name <- tolower(out$name)
      out$type <- factor(out$type, levels = 0:8, labels = c("long", "values", "off_t",
        "object", "string", "slist", "cbptr", "blob", "function"))
      cache <<- structure(out, class = 'data.frame', row.names = seq_along(out$name))
    }
    return(cache)
  }
})