BasisScriptConfig.cmake
Go to the documentation of this file.
1 ##############################################################################
2 # @file BasisScriptConfig.cmake
3 # @brief BASIS script configuration.
4 #
5 # @note The file BasisScriptConfig.cmake is automatically generated by BASIS
6 # from the template file ScriptConfig.cmake.in which is part of BASIS.
7 #
8 # This script configuration file is included before the default script
9 # configuration file which is part of the package itself (ScriptConfig.cmake),
10 # if such file exists in the @c PROJECT_CONFIG_DIR.
11 # Therefore, the BASIS script configuration can be overwritten by the
12 # default script configuration of the project, which in turn can be
13 # overwritten specifically for each script target by specifying a
14 # script target-specific script configuration using the @c CONFIG and/or
15 # @c CONFIG_FILE option of the basis_add_executable() or basis_add_library()
16 # command, respectively.
17 #
18 # @sa https://cmake-basis.github.io/standard/scripttargets.html#script-configuration
19 #
20 # @ingroup BasisScriptConfig
21 ##############################################################################
22 
23 ## @addtogroup BasisScriptConfig
24 # @{
25 
26 
27 # ============================================================================
28 # script attributes
29 # ============================================================================
30 
31 # Note: The following set() commands are required for the API documentation.
32 
33 ## @brief Detected scripting language or UNKNOWN.
34 set (LANGUAGE "${LANGUAGE}")
35 
36 ## @brief Directory of script file.
37 #
38 # @note Mainly used in script configuration itself to make relative paths
39 # absolute. In particular, basis_set_script_path() uses this variable.
40 set (__DIR__ "${__DIR__}")
41 
42 ## @brief Absolute path of script file.
43 #
44 # @note As this path is fixed after the build, it should be used only if
45 # it is not otherwise possible to determine the path of the current
46 # script file. It prohibits the relocation of the installation.
47 set (__FILE__ "${__FILE__}")
48 
49 ## @brief Name of script file.
50 set (__NAME__ "${__NAME__}")
51 
52 ## @brief Name of script file in uppercase only.
53 string (TOUPPER "${__NAME__}" __NAME_U__)
54 ## @brief Name of script file in lowercase only.
55 string (TOLOWER "${__NAME__}" __NAME_L__)
56 
57 # ============================================================================
58 # aliases of script attributes for backward compatibility
59 # ============================================================================
60 
61 set (DIR ${__DIR__})
62 set (FILE ${__FILE__})
63 set (NAME ${__NAME__})
64 set (NAME_U ${__NAME_U__})
65 set (NAME_L ${__NAME_L__})
66 
67 # ============================================================================
68 # directories
69 # ============================================================================
70 
71 # ----------------------------------------------------------------------------
72 # relative to script file
73 
74 # Example:
75 # @code
76 # #! /usr/bin/env bash
77 # get_executable_directory exec_dir
78 # libexec_dir=${exec_dir}/__LIBEXEC_DIR__
79 # @endcode
80 
81 ## @brief Installation prefix relative to script location.
82 basis_set_script_path (PREFIX_DIR "/Users/as12312/Software/BASIS/Xcode" "/opt/basis")
83 
84 ## @brief Directory of main executables relative to script location.
85 basis_set_script_path (RUNTIME_DIR "/Users/as12312/Software/BASIS/Xcode/bin" "bin")
86 ## @brief Directory of auxiliary executables relative to script location.
87 basis_set_script_path (LIBEXEC_DIR "/Users/as12312/Software/BASIS/Xcode/lib" "lib")
88 ## @brief Directory of shared and module libraries relative to script location.
89 basis_set_script_path (LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib" "lib")
90 ## @brief Directory of static and import libraries relative to script location.
91 basis_set_script_path (ARCHIVE_DIR "/Users/as12312/Software/BASIS/Xcode/lib" "lib")
92 ## @brief Directory of auxiliary data files relative to script location.
93 basis_set_script_path (DATA_DIR "/Users/as12312/Software/BASIS/Workspace/data" "share/data")
94 
95 ## @brief Directory of Python modules relative to script location.
96 basis_set_script_path (PYTHON_LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib/python" "lib/python")
97 ## @brief Directory of Jython modules relative to script location.
98 basis_set_script_path (JYTHON_LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib/jython" "lib/jython")
99 ## @brief Directory of Perl modules relative to script location.
100 basis_set_script_path (PERL_LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib/perl" "lib/perl")
101 ## @brief Directory of MATLAB modules relative to script location.
102 basis_set_script_path (MATLAB_LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib/matlab" "lib/matlab")
103 ## @brief Directory of Bash modules relative to script location.
104 basis_set_script_path (BASH_LIBRARY_DIR "/Users/as12312/Software/BASIS/Xcode/lib/bash" "lib/bash")
105 
106 # ----------------------------------------------------------------------------
107 # relative to installation prefix
108 
109 # Example:
110 # @code
111 # #! /usr/bin/env bash
112 # get_executable_directory exec_dir
113 # libexec_dir=${exec_dir}/__PREFIX_DIR__/__LIBEXEC_DIR_SUFFIX__
114 # @endcode
115 
116 basis_get_relative_path (RUNTIME_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${RUNTIME_DIR}")
117 basis_get_relative_path (LIBEXEC_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${LIBEXEC_DIR}")
118 basis_get_relative_path (LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${LIBRARY_DIR}")
119 basis_get_relative_path (ARCHIVE_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${ARCHIVE_DIR}")
120 basis_get_relative_path (DATA_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${DATA_DIR}")
121 
122 basis_get_relative_path (PYTHON_LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${PYTHON_LIBRARY_DIR}")
123 basis_get_relative_path (JYTHON_LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${JYTHON_LIBRARY_DIR}")
124 basis_get_relative_path (PERL_LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${PERL_LIBRARY_DIR}")
125 basis_get_relative_path (MATLAB_LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${MATLAB_LIBRARY_DIR}")
126 basis_get_relative_path (BASH_LIBRARY_DIR_SUFFIX "${__DIR__}/${PREFIX_DIR}" "${__DIR__}/${BASH_LIBRARY_DIR}")
127 
128 # Note: The following set() commands are needed for the API documentation.
129 
130 ## @brief Directory of main executables relative to installation prefix.
131 set (RUNTIME_DIR_SUFFIX "${RUNTIME_DIR_SUFFIX}")
132 ## @brief Directory of auxiliary executables relative to installation prefix.
133 set (LIBEXEC_DIR_SUFFIX "${LIBEXEC_DIR_SUFFIX}")
134 ## @brief Directory of shared and module libraries relative to installation prefix.
135 set (LIBRARY_DIR_SUFFIX "${LIBRARY_DIR_SUFFIX}")
136 ## @brief Directory of static and import libraries relative to installation prefix.
137 set (ARCHIVE_DIR_SUFFIX "${ARCHIVE_DIR_SUFFIX}")
138 ## @brief Directory of auxiliary data files relative to installation prefix.
139 set (DATA_DIR_SUFFIX "${DATA_DIR_SUFFIX}")
140 
141 ## @brief Directory of Python modules relative to installation prefix.
142 set (PYTHON_LIBRARY_DIR_SUFFIX "${PYTHON_LIBRARY_DIR_SUFFIX}")
143 ## @brief Directory of Jython modules relative to installation prefix.
144 set (JYTHON_LIBRARY_DIR_SUFFIX "${JYTHON_LIBRARY_DIR_SUFFIX}")
145 ## @brief Directory of Perl modules relative to installation prefix.
146 set (PERL_LIBRARY_DIR_SUFFIX "${PERL_LIBRARY_DIR_SUFFIX}")
147 ## @brief Directory of MATLAB modules relative to installation prefix.
148 set (MATLAB_LIBRARY_DIR_SUFFIX "${MATLAB_LIBRARY_DIR_SUFFIX}")
149 ## @brief Directory of Bash modules relative to installation prefix.
150 set (BASH_LIBRARY_DIR_SUFFIX "${BASH_LIBRARY_DIR_SUFFIX}")
151 
152 
153 ## @}
154 # end of Doxygen group
PERL_LIBRARY_DIR_SUFFIX
cmake PERL_LIBRARY_DIR_SUFFIX
Directory of Perl modules relative to installation prefix.
Definition: BasisScriptConfig.cmake:146
RUNTIME_DIR
cmake RUNTIME_DIR
Directory of main executables relative to script location.
Definition: BasisScriptConfig.cmake:85
basis_set_script_path
function basis_set_script_path(out VAR, in PATH, in ARGV3)
Set path relative to script file.
LIBRARY_DIR
cmake LIBRARY_DIR
Directory of shared and module libraries relative to script location.
Definition: BasisScriptConfig.cmake:89
ARCHIVE_DIR_SUFFIX
cmake ARCHIVE_DIR_SUFFIX
Directory of static and import libraries relative to installation prefix.
Definition: BasisScriptConfig.cmake:137
__FILE__
cmake __FILE__
Absolute path of script file.
Definition: BasisScriptConfig.cmake:47
basis_get_relative_path
function basis_get_relative_path(out REL, in BASE, in PATH)
Get path relative to a given base directory.
LIBRARY_DIR_SUFFIX
cmake LIBRARY_DIR_SUFFIX
Directory of shared and module libraries relative to installation prefix.
Definition: BasisScriptConfig.cmake:135
LIBEXEC_DIR
cmake LIBEXEC_DIR
Directory of auxiliary executables relative to script location.
Definition: BasisScriptConfig.cmake:87
PYTHON_LIBRARY_DIR_SUFFIX
cmake PYTHON_LIBRARY_DIR_SUFFIX
Directory of Python modules relative to installation prefix.
Definition: BasisScriptConfig.cmake:142
BASH_LIBRARY_DIR
cmake BASH_LIBRARY_DIR
Directory of Bash modules relative to script location.
Definition: BasisScriptConfig.cmake:104
MATLAB_LIBRARY_DIR
cmake MATLAB_LIBRARY_DIR
Directory of MATLAB modules relative to script location.
Definition: BasisScriptConfig.cmake:102
LIBEXEC_DIR_SUFFIX
cmake LIBEXEC_DIR_SUFFIX
Directory of auxiliary executables relative to installation prefix.
Definition: BasisScriptConfig.cmake:133
BASH_LIBRARY_DIR_SUFFIX
cmake BASH_LIBRARY_DIR_SUFFIX
Directory of Bash modules relative to installation prefix.
Definition: BasisScriptConfig.cmake:150
PREFIX_DIR
cmake PREFIX_DIR
Installation prefix relative to script location.
Definition: BasisScriptConfig.cmake:82
RUNTIME_DIR_SUFFIX
cmake RUNTIME_DIR_SUFFIX
Directory of main executables relative to installation prefix.
Definition: BasisScriptConfig.cmake:131
NAME
cmake NAME
Definition: BasisScriptConfig.cmake:63
PYTHON_LIBRARY_DIR
cmake PYTHON_LIBRARY_DIR
Directory of Python modules relative to script location.
Definition: BasisScriptConfig.cmake:96
__NAME__
cmake __NAME__
Name of script file.
Definition: BasisScriptConfig.cmake:50
PERL_LIBRARY_DIR
cmake PERL_LIBRARY_DIR
Directory of Perl modules relative to script location.
Definition: BasisScriptConfig.cmake:100
JYTHON_LIBRARY_DIR
cmake JYTHON_LIBRARY_DIR
Directory of Jython modules relative to script location.
Definition: BasisScriptConfig.cmake:98
DATA_DIR_SUFFIX
cmake DATA_DIR_SUFFIX
Directory of auxiliary data files relative to installation prefix.
Definition: BasisScriptConfig.cmake:139
FILE
cmake FILE
Definition: BasisScriptConfig.cmake:62
DIR
cmake DIR
Definition: BasisScriptConfig.cmake:55
DATA_DIR
cmake DATA_DIR
Directory of auxiliary data files relative to script location.
Definition: BasisScriptConfig.cmake:93
JYTHON_LIBRARY_DIR_SUFFIX
cmake JYTHON_LIBRARY_DIR_SUFFIX
Directory of Jython modules relative to installation prefix.
Definition: BasisScriptConfig.cmake:144
NAME_L
cmake NAME_L
Definition: BasisScriptConfig.cmake:65
ARCHIVE_DIR
cmake ARCHIVE_DIR
Directory of static and import libraries relative to script location.
Definition: BasisScriptConfig.cmake:91
LANGUAGE
cmake LANGUAGE
Detected scripting language or UNKNOWN.
Definition: BasisScriptConfig.cmake:27
MATLAB_LIBRARY_DIR_SUFFIX
cmake MATLAB_LIBRARY_DIR_SUFFIX
Directory of MATLAB modules relative to installation prefix.
Definition: BasisScriptConfig.cmake:148
NAME_U
cmake NAME_U
Definition: BasisScriptConfig.cmake:64
__DIR__
cmake __DIR__
Directory of script file.
Definition: BasisScriptConfig.cmake:40
© 2011-12 University of Pennsylvania, 2013-14 Carnegie Mellon University, 2013-16 Andreas Schuh. Last updated on Thu Feb 2 2017 11:37:15. Created using Doxygen 1.8.12.