BasisScriptConfig.cmake

Go to the documentation of this file.

##############################################################################
# @file  BasisScriptConfig.cmake
# @brief BASIS script configuration.
#
# @note The file BasisScriptConfig.cmake is automatically generated
#       by BASIS from the template file ScriptConfig.cmake.in which is part
#       of the BASIS installation.
#
# This script configuration file is included before the default script
# configuration file which is part of the package itself (ScriptConfig.cmake),
# if such file exists in the @c PROJECT_CONFIG_DIR.
# Therefore, the BASIS script configuration can be overwritten by the
# default script configuration of the project, which in turn can be
# overwritten specifically for each script target by specifying a
# script target-specific script configuration using the @c CONFIG and/or
# @c CONFIG_FILE option of the basis_add_executable() or basis_add_library()
# command, respectively.
#
# See @ref BuildOfScriptTargets for more details.
#
# Copyright (c) 2011, 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 BasisScriptConfig
##############################################################################

## @addtogroup BasisScriptConfig
# @{


# ============================================================================
# script attributes
# ============================================================================

# Note: The following set() commands are required for the API documentatoin.

## @brief Detected scripting language or UNKNOWN.
set (LANGUAGE "${LANGUAGE}")

## @brief Directory of script file.
#
# @note Mainly used in script configuration itself to make relative paths
#       absolute. In particular, basis_set_script_path() uses this variable.
set (DIR "${DIR}")

## @brief Absolute path of script file.
#
# @note As this path is fixed after the build, it should be used only if
#       it is not otherwise possible to determine the path of the current
#       script file. It prohibits the relocation of the installation.
set (FILE "${FILE}")

## @brief Name of script file.
set (NAME "${NAME}")
## @brief Name of script file in uppercase only.
set (NAME_UPPER "${NAME_UPPER}")
## @brief Name of script file in lowercase only.
set (NAME_LOWER "${NAME_LOWER}")

## @brief Namespace string for use in global script variable names.
set (NAMESPACE "${NAMESPACE}")
## @brief Namespace string for use in global script constant names.
set (NAMESPACE_UPPER "${NAMESPACE_UPPER}")
## @brief Namespace string for use in global script variable and function names.
set (NAMESPACE_LOWER "${NAMESPACE_LOWER}")

# ============================================================================
# directories
# ============================================================================

# ----------------------------------------------------------------------------
# relative to script file

# Example:
# @code
# #! /usr/bin/env bash
# get_executable_directory exec_dir
# libexec_dir=${exec_dir}/__LIBEXEC_DIR__
# @endcode

## @brief Installation prefix relative to script location.
basis_set_script_path (PREFIX_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3" "/sbia/sbiasfw/lab/basis/1.2.3/centos5")

## @brief Directory of main executables relative to script location.
basis_set_script_path (RUNTIME_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/bin" "bin")
## @brief Directory of auxiliary executables relative to script location.
basis_set_script_path (LIBEXEC_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib" "lib")
## @brief Directory of shared and module libraries relative to script location.
basis_set_script_path (LIBRARY_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib" "lib")
## @brief Directory of static and import libraries relative to script location.
basis_set_script_path (ARCHIVE_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib" "lib")
## @brief Directory of Python modules relative to script location.
basis_set_script_path (PYTHON_LIBRARY_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib/python" "lib/python")
## @brief Directory of Perl modules relative to script location.
basis_set_script_path (PERL_LIBRARY_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib/perl5" "lib/perl5")
## @brief Directory of auxiliary data files relative to script location.
basis_set_script_path (DATA_DIR "/sbia/home/schuha/projects/basis-1.2.3/data" "share/data")

# ----------------------------------------------------------------------------
# relative to installation prefix

# Example:
# @code
# #! /usr/bin/env bash
# get_executable_directory exec_dir
# libexec_dir=${exec_dir}/__PREFIX_DIR__/__LIBEXEC_DIR_SUFFIX__
# @endcode

basis_get_relative_path (RUNTIME_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${RUNTIME_DIR}")
basis_get_relative_path (LIBEXEC_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${LIBEXEC_DIR}")
basis_get_relative_path (LIBRARY_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${LIBRARY_DIR}")
basis_get_relative_path (ARCHIVE_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${ARCHIVE_DIR}")
basis_get_relative_path (PYTHON_LIBRARY_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${PYTHON_LIBRARY_DIR}")
basis_get_relative_path (PERL_LIBRARY_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${PERL_LIBRARY_DIR}")
basis_get_relative_path (DATA_DIR_SUFFIX "${DIR}/${PREFIX_DIR}" "${DIR}/${DATA_DIR}")

# Note: The following set() commands are needed for the API documentation.

## @brief Directory of main executables relative to installation prefix.
set (RUNTIME_DIR_SUFFIX "${RUNTIME_DIR_SUFFIX}")
## @brief Directory of auxiliary executables relative to installation prefix.
set (LIBEXEC_DIR_SUFFIX "${LIBEXEC_DIR_SUFFIX}")
## @brief Directory of shared and module libraries relative to installation prefix.
set (LIBRARY_DIR_SUFFIX "${LIBRARY_DIR_SUFFIX}")
## @brief Directory of static and import libraries relative to installation prefix.
set (ARCHIVE_DIR_SUFFIX "${ARCHIVE_DIR_SUFFIX}")
## @brief Directory of Python modules relative to installation prefix.
set (PYTHON_LIBRARY_DIR_SUFFIX "${PYTHON_LIBRARY_DIR_SUFFIX}")
## @brief Directory of Perl modules relative to installation prefix.
set (PERL_LIBRARY_DIR_SUFFIX "${PERL_LIBRARY_DIR_SUFFIX}")
## @brief Directory of auxiliary data files relative to installation prefix.
set (DATA_DIR_SUFFIX "${DATA_DIR_SUFFIX}")

# ============================================================================
# CMake variables required by BASIS_*_UTILITIES code
# ============================================================================

if ("BASIS" STREQUAL "BASIS")
  basis_set_script_path (BASIS_LIBRARY_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib" "lib")
else ()
  basis_set_script_path (BASIS_LIBRARY_DIR "/sbia/home/schuha/sandbox/build/basis-1.2.3/lib")
endif ()

if ("BASIS" STREQUAL "BASIS")
  basis_set_script_path (BASIS_PYTHON_LIBRARY_DIR "/python" "lib/python")
else ()
  basis_set_script_path (BASIS_PYTHON_LIBRARY_DIR "/python")
endif ()

if ("BASIS" STREQUAL "BASIS")
  basis_set_script_path (BASIS_PERL_LIBRARY_DIR "/perl5" "lib/perl5")
else ()
  basis_set_script_path (BASIS_PERL_LIBRARY_DIR "/perl5")
endif ()


## @}
# end of Doxygen group