rename

Author: kevinushey

NAMESPACE

@@ -6,4 +6,4 @@ export(RcppParallel.package.skeleton)
 export(RcppParallelLibs)
 export(defaultNumThreads)
 export(setThreadOptions)
-export(tbbLibPath)
+export(tbbLibraryPath)

NEWS.md

@@ -1,6 +1,6 @@
 ## RcppParallel 5.1.2 (UNRELEASED)
 
-* `RcppParallel` gains the `tbbLibPath()` function, to be used when attempting
+* `RcppParallel` gains the `tbbLibraryPath()` function, to be used when attempting
   to query the location of the TBB libraries that `RcppParallel` has been
   configured to use. This may be useful for R packages which wish to explicitly
   use, or link to, these libraries.

R/hooks.R

@@ -5,7 +5,7 @@ mallocDllInfo <- NULL
 .onLoad <- function(libname, pkgname) {
 
    # load tbb and tbbmalloc on supported platforms   
-   tbb <- tbbLibPath()
+   tbb <- tbbLibraryPath("tbb")
    if (!is.null(tbb)) {
       if (!file.exists(tbb)) {
          warning(paste("TBB library", tbb, "not found."))
@@ -14,7 +14,7 @@ mallocDllInfo <- NULL
       }
    }
 
-   tbbMalloc <- tbbLibPath("tbbmalloc")
+   tbbMalloc <- tbbLibraryPath("tbbmalloc")
    if (!is.null(tbbMalloc)) {
       if (!file.exists(tbbMalloc)) {
          warning(paste("TBB malloc library", tbbMalloc, "not found."))

R/tbb.R

@@ -5,15 +5,23 @@
 #' using RcppParallel that wish to use, or re-use, the version of TBB that
 #' RcppParallel has been configured to use.
 #' 
-#' @param name The name of the library. Normally, this is one of
-#'   `tbb`, `tbbmalloc`, or `tbbmalloc_proxy`.
+#' @param name
+#'   The name of the TBB library to be resolved. Normally, this is one of
+#'   `tbb`, `tbbmalloc`, or `tbbmalloc_proxy`. When `NULL`, the library
+#'   path containing the TBB libraries is returned instead.
 #' 
 #' @export
-tbbLibPath <- function(name = "tbb") {
+tbbLibraryPath <- function(name = NULL) {
 
    # library paths for different OSes
    sysname <- Sys.info()[["sysname"]]
 
+   # find root for TBB install
+   tbbRoot <- Sys.getenv("TBB_LIB", unset = tbbRoot())
+   if (is.null(name))
+      return(tbbRoot)
+   
+   # form library names
    tbbLibNames <- list(
       "Darwin"  = paste0("lib", name, ".dylib"),
       "Windows" = paste0(       name, ".dll"),
@@ -29,8 +37,7 @@ tbbLibPath <- function(name = "tbb") {
    if (!isCompatible)
       return(NULL)
 
-   # find root for TBB install
-   tbbRoot <- Sys.getenv("TBB_LIB", unset = tbbRoot())
+   # find the request library (if any)
    libNames <- tbbLibNames[[sysname]]
    for (libName in libNames) {
       tbbName <- file.path(tbbRoot, libName)
@@ -80,7 +87,7 @@ tbbLdFlags <- function() {
    # on Windows and Solaris, we need to explicitly link
    needsExplicitFlags <- is_windows() || (is_solaris() && !is_sparc())
    if (needsExplicitFlags) {
-      libPath <- asBuildPath(dirname(tbbLibPath()))
+      libPath <- asBuildPath(tbbLibraryPath())
       libFlag <- paste0("-L", shQuote(libPath))
       return(paste(libFlag, "-ltbb", "-ltbbmalloc"))
    }