BASISUse.cmake

Go to the documentation of this file.

# ============================================================================
# Copyright (c) 2011-2012 University of Pennsylvania
# Copyright (c) 2013-2016 Andreas Schuh
# All rights reserved.
#
# See COPYING file for license information or visit
# https://cmake-basis.github.io/download.html#license
# ============================================================================

##############################################################################
# @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
#       the BASIS 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.
#
# @ingroup BasisConfig
##############################################################################

# ============================================================================
# additional BASIS modules
# ============================================================================

# The basic tools are included by BASISConfig.cmake already.
# Additional modules required by this project are included here.
# The include of the ImportTools must occur **before** the include of
# the exported CMake BASIS targets itself below.

if (BASIS_IMPORT_TARGETS)
  include (${BASIS_MODULE_PATH}/ImportTools.cmake)
endif ()
if (BASIS_SUPER_BUILD_MODULES)
  include (${BASIS_MODULE_PATH}/SuperBuildTools.cmake)
endif ()

# ============================================================================
# Basic configuration
# ============================================================================

# ============================================================================
# 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_${NS}IMPORTS "${NO_${NS}IMPORTS}")

if (NOT NO_${NS}IMPORTS)
  include ("${${NS}EXPORTS_FILE}"        OPTIONAL)
  include ("${${NS}CUSTOM_EXPORTS_FILE}" OPTIONAL)
endif ()

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

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 ()

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

# ----------------------------------------------------------------------------
# Add CMake BASIS Find Modules path to CMAKE_MODULE_PATH
list (INSERT CMAKE_MODULE_PATH 0 "${BASIS_FIND_MODULE_PATH}")
list (REMOVE_DUPLICATES CMAKE_MODULE_PATH)

# ----------------------------------------------------------------------------
# Import configured script executables

# The following statements ensure that all scripts and modules are
# configured/compiled using the same version of the interpreters.
# Yet, the user can modify these variables, though this is not recommended.

# Note: The PERL_EXECUTABLE, and BASH_EXECUTABLE variables have to be cached
#       such that the FindPerl.cmake, and FindBASH.cmake modules find the
#       respective executable.
#
# Attention: DO NOT set PYTHON_EXECUTABLE here. In case of a Slicer Extension,
#            the UseSlicer.cmake file requires us not to set PYTHON_EXECUTABLE
#            before including this file. As the BASISUse.cmake file is included
#            before any other dependency, the PYTHON_EXECUTABLE variable is
#            set by the basis_project_impl() macro.

## @brief Jython interpreter configured when building BASIS.
if (BASIS_JYTHON_EXECUTABLE)
  set (
    JYTHON_EXECUTABLE
      "${BASIS_JYTHON_EXECUTABLE}"
    CACHE PATH
      "The Jython interpreter."
  )
  mark_as_advanced (JYTHON_EXECUTABLE)
endif ()

## @brief Perl interpreter configured when building BASIS.
if (BASIS_PERL_EXECUTABLE)
  set (
    PERL_EXECUTABLE
      "${BASIS_PERL_EXECUTABLE}"
    CACHE PATH
      "The Perl interpreter."
  )
  mark_as_advanced (PERL_EXECUTABLE)
endif ()

## @brief Bash executable configured when building BASIS.
if (BASIS_BASH_EXECUTABLE)
  set (
    BASH_EXECUTABLE
      "${BASIS_BASH_EXECUTABLE}"
    CACHE PATH
      "The BASH executable."
  )
  mark_as_advanced (BASH_EXECUTABLE)
endif ()