BASISUse.cmake

Go to the documentation of this file.

##############################################################################
# @file  BASISUse.cmake
# @brief CMake package configuration use file.
#
# @note The BASISUse.cmake file is automatically generated
#       by BASIS from the template file ConfigUse.cmake.in which is part of
#       this package.
#
# In the default package use file of BASIS, which can be included here using
# the \@BASIS_USE\@ variable, the prefix used by the package configuration
# file is defined as @c NS variable. Thus, to use any variable set by the
# corresponding package configuration file, use code similar to:
#
# @code
# include_directories (${${NS}INCLUDE_DIRS})
# @endcode
#
# See the ConfigUse.cmake.in file of BASIS for details.
#
# @note The CMake code which is substituted for the \@BASIS_USE\@ variable
#       contains an include guard.
#
# Copyright (c) 2012 University of Pennsylvania. All rights reserved.<br />
# See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
#
# Contact: SBIA Group <sbia-software at uphs.upenn.edu>
#
# @ingroup BasisConfig
##############################################################################

# ============================================================================
# namespace
# ============================================================================

# prefix used for variable names
set (NS "BASIS_")

# allow caller to change namespace - used by projects with modules
if (${NS}CONFIG_PREFIX)
  set (NS "${${NS}CONFIG_PREFIX}")
endif ()

# ============================================================================
# include guard
# ============================================================================

if (__${NS}USE_FILE_INCLUDED)
  return ()
else ()
  set (__${NS}USE_FILE_INCLUDED 1)
endif ()

# ============================================================================
# use project settings
# ============================================================================

# include directories
if (${NS}INCLUDE_DIRS)
  include_directories (${${NS}INCLUDE_DIRS})
elseif (${NS}INCLUDE_DIR)
  include_directories (${${NS}INCLUDE_DIR})
endif ()

# library directories
if (${NS}LIBRARY_DIRS)
  link_directories (${${NS}LIBRARY_DIRS})
elseif (${NS}LIBRARY_DIR)
  link_directories (${${NS}LIBRARY_DIR})
endif ()

# ============================================================================
# import build targets
# ============================================================================

## @brief Whether to import the exported targets.
set (NO_BASIS_IMPORTS "${NO_BASIS_IMPORTS}")

if (NOT NO_BASIS_IMPORTS)
  include ("${CMAKE_CURRENT_LIST_DIR}/BASISExports.cmake" OPTIONAL)
  include ("${CMAKE_CURRENT_LIST_DIR}/BASISCustomExports.cmake" OPTIONAL)
endif ()

# ============================================================================
# use modules
# ============================================================================

# following statements only valid for top-level projects, not modules
if (NOT FALSE)
  foreach (M IN LISTS ${NS}MODULES_REQUESTED)
    if (${NS}${M}_USE_FILE)
      set (${M}_CONFIG_PREFIX "${NS}${M}_")
      include ("${${NS}${M}_USE_FILE}")
      unset (${M}_CONFIG_PREFIX)
    endif ()
  endforeach ()
endif ()

# ============================================================================
# BASIS configuration
# ============================================================================

# The following statements ensure that all Perl/Python scripts and modules
# are configured/compiled using the same version of the interpreter to
# avoid incompatibilities.

# Note: The PYTHON_EXECUTABLE, PERL_EXECUTABLE, and BASH_EXECUTABLE variables
#       have to be cached such that the FindPythonInterpr.cmake, FindPerl.cmake,
#       and FindBASH.cmake modules find the respective executable.

## @brief Python interpreter configured when building BASIS.
set (
  PYTHON_EXECUTABLE
    "${BASIS_PYTHON_EXECUTABLE}"
  CACHE INTERNAL
    "The Python interpreter."
  FORCE
)

## @brief Perl interpreter configured when building BASIS.
set (
  PERL_EXECUTABLE
    "${BASIS_PERL_EXECUTABLE}"
  CACHE INTERNAL
    "The Perl interpreter."
  FORCE
)

## @brief BASH executable configured when building BASIS.
set (
  BASH_EXECUTABLE
    "${BASIS_BASH_EXECUTABLE}"
  CACHE INTERNAL
    "The BASH executable."
  FORCE
)