BASIS  r3148
CommonTools.cmake File Reference

Definition of common CMake functions. More...

#include "CMakeParseArguments.cmake"
+ Include dependency graph for CommonTools.cmake:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

function basis_add_glob_target (in TARGET_UID, out SOURCES, in ARGN)
 Glob source files.
function basis_check_target_name (in TARGET_NAME)
 Checks whether a given name is a valid target name.
function basis_check_test_name (in TEST_NAME)
 Checks whether a given name is a valid test name.
macro basis_compare_lists (out RESULT, in LIST1, in LIST2)
 Compare two lists.
macro basis_compile_python_modules_for_jython (out FLAG)
 Whether to compile Python modules for Jython interpreter.
function basis_configure_script (in INPUT, in OUTPUT, in ARGN)
 Configure and optionally compile script file.
function basis_configure_sources (out LIST_NAME, in ARGN)
 Configure .in source files.
function basis_dump_variables (in RESULT_FILE)
 Output current CMake variables to file.
macro basis_exists_target (out RESULT_VARIABLE, in TARGET_NAME)
 Whether a given target exists.
macro basis_find_package (in PACKAGE, in ARGN)
 Find external software package or other project module.
function basis_get_compiled_file (out CFILE, in SOURCE, in ARGV2)
 Get file name of compiled script.
macro basis_get_compiled_jython_file_of_python_module (out CFILE, in MODULE)
 Get file path of Jython file compiled from the given Python module.
macro basis_get_filename_component ()
 Alias for the overwritten get_filename_component() function.
function basis_get_fully_qualified_target_uid (out TARGET_UID, in TARGET_NAME)
 Get fully-qualified target name.
function basis_get_fully_qualified_test_uid (out TEST_UID, in TEST_NAME)
 Get "global" test name, i.e., actual CTest test name.
function basis_get_project_property (out VARIABLE, in ARGN)
 Get project-global property value.
function basis_get_property (out VAR, in SCOPE, in ELEMENT, in ARGN)
 Get a property.
function basis_get_relative_path (out REL, in BASE, in PATH)
 Get path relative to a given base directory.
function basis_get_source_language (out LANGUAGE, in ARGN)
 Detect programming language of given source code files.
function basis_get_source_target_name (out TARGET_NAME, in SOURCE_FILE, in ARGN)
 Derive target name from source file name.
function basis_get_target_link_libraries (out LINK_DEPENDS, in TARGET_NAME)
 Get link libraries/dependencies of (imported) target.
function basis_get_target_location (out VAR, in TARGET_NAME, in PART)
 Get location of build target output file(s).
function basis_get_target_name (out TARGET_NAME, in TARGET_UID)
 Get "local" target name, i.e., BASIS target name.
function basis_get_target_namespace (out TARGET_NS, in TARGET_UID)
 Get namespace of build target.
function basis_get_target_type (out TYPE, in TARGET_NAME)
 Get type name of target.
function basis_get_target_uid (out TARGET_UID, in TARGET_NAME)
 Get "global" target name, i.e., actual CMake target name.
macro basis_get_test_name (out TEST_NAME, in TEST_UID)
 Get "local" test name, i.e., BASIS test name.
macro basis_get_test_namespace (out TEST_NS, in TEST_UID)
 Get namespace of test.
function basis_get_test_uid (out TEST_UID, in TEST_NAME)
 Get "global" test name, i.e., actual CTest test name.
macro basis_is_cached (out VAR, in ENTRY)
 Determine if cache entry exists.
macro basis_library_prefix (out PREFIX, in LANGUAGE)
 Get default subdirectory prefix of scripted library modules.
function basis_list_to_delimited_string (out STR, in DELIM, in ARGN)
 Concatenates all list elements into a single delimited string.
macro basis_list_to_regex (out REGEX, in ARGN)
 Convert list into regular expression.
function basis_list_to_string (out STR, in ARGN)
 Concatenates all list elements into a single string.
macro basis_make_target_uid (out TARGET_UID, in TARGET_NAME)
 Make target UID from given target name.
macro basis_make_test_uid (out TEST_UID, in TEST_NAME)
 Make test UID from given test name.
function basis_normalize_name (out OUT, in STR)
 Convert string to lowercase only or mixed case.
function basis_process_generator_expressions (out ARGS, in ARGN)
 Process generator expressions in arguments.
macro basis_sanitize_for_regex (out OUT, in STR)
 Sanitize string variable for use in regular expression.
macro basis_set_flag (in PREFIX, out FLAG, in DEFAULT)
 Set flag given mutually exclusive ARGN_<FLAG> and ARGN_NO<FLAG> function arguments.
macro basis_set_if_empty (out VAR, in ARGN)
 Set value of variable only if variable is not set already.
macro basis_set_if_not_set (out VAR, in ARGN)
 Set value of variable only if variable is not defined yet.
macro basis_set_or_update_type (in VAR, in TYPE, in ARGN)
 Set type of variable.
macro basis_set_or_update_value (in VAR)
 Set variable value.
function basis_set_project_property ()
 Set project-global property.
function basis_set_property (in SCOPE, in ARGN)
 Set a named property in a given scope.
function basis_set_script_path (out VAR, in PATH, in ARGV3)
 Set path relative to script file.
function basis_string_to_list (out LST, in STR)
 Splits a string at space characters into a list.
function basis_tokenize_dependency (in DEP, out PKG, out VER, out CMP)
 Tokenize dependency specification.
macro basis_update_type_of_variable (in VAR, in TYPE)
 Change type of cached variable.
macro basis_update_value (in VAR)
 Update cache variable.
macro basis_use_package (in PACKAGE)
 Use found package.
function basis_version_numbers (in VERSION, out MAJOR, out MINOR, out PATCH)
 Extract version numbers from version string.
function basis_write_list (in FILENAME, in VARIABLE)
 Write CMake script file which sets the named variable to the specified (list of) values.
macro find_package ()
 Overloaded find_package() command.
function get_filename_component (inout ARGN)
 Fixes CMake's get_filename_component() command.

Variables

cmake __BASIS_COMMONTOOLS_INCLUDED

Detailed Description

Definition of common CMake functions.

Copyright (c) 2011, 2012, 2013 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

Definition in file CommonTools.cmake.


Variable Documentation

Definition at line 16 of file CommonTools.cmake.