R/common-get_cmake.R

In rkeops: Kernel Operations on GPU or CPU, with Autodiff, without Memory Overflows

#' Return path to cmake executable
#' @keywords internal
#' @description
#' This function returns the path to the cmake executable.
#' @details
#' If no path is supplied, the function searches for the 
#' `cmake` command in the standard PATH (on Unix system).
#' If a path is supplied (e.g. `/path/to/dir` on Unix 
#' system), the function search for the `cmake` command 
#' in this path.
#' 
#' **Note**: for the moment, this does not work on 
#' Windows OS.
#' @param path text string (optional), path where to search 
#' `cmake` (e.g. `/path/to/dir` on Unix system). Default value 
#' is NULL and the function searches for `cmake` in the 
#' standard PATH (on unix system).
#' @return path to cmake executable.
#' @author Ghislain Durif
#' @importFrom stringr str_detect
#' @export
get_cmake <- function(path = NULL) {
    # TODO: use <https://github.com/stnava/cmaker> to 
    # install cmake if not available on the system .
    
    # check input
    if(!is.null(path)) {
        if(!is.character(path))
            stop("`path` input parameter should be a text string.")
        if(!dir.exists(path))
            stop("`path` input parameter should be a path to an existing directory.")
    }
    
    # OS
    os_name <- get_os()
    os_type <- .Platform$OS.type
    
    # find executable
    cmake_executable <- switch(
        os_type,
        "unix" = {
            if(!is.null(path)) {
                if(any(str_detect(string = list.files(path), 
                                  pattern = "cmake")))
                    file.path(path, "cmake")
                else {
                    warning(paste0("`cmake` not found in path ", path))
                    NULL
                }
            } else {
                # find default cmake (search in PATH)
                tmp <- tryCatch(
                    suppressWarnings(system("which cmake", intern = TRUE)),
                    error = function(e) return(e)
                )
                
                # different behavior on linux and macosX
                #   linux: just a warning if `which` failed
                #   macos: error if `which` failed
                if(!"error" %in% class(tmp) && length(tmp) == 1 && 
                   file.exists(tmp)) {
                    tmp
                } else {
                    # cmake not found in PATH
                    # specific path to cmake on OsX for CRAN
                    tmp <- "/Applications/CMake.app/Contents/bin/cmake"
                    if(os_name == "macos" && file.exists(tmp)) {
                        tmp
                    } else {
                        warning("`cmake` not found in PATH")
                        NULL
                    }
                }
            }
        },
        "windows" = {
            warning("Windows not supported at the moment")
            NULL
        }
    )
    # out
    return(cmake_executable)
}