cmake-properties man page

cmake-properties — CMake Properties Reference

Properties of Global Scope

Allow_duplicate_custom_targets

Allow duplicate custom targets to be created.

Normally CMake requires that all targets built in a project have globally unique logical names (see policy CMP0002). This is necessary to generate meaningful project file names in Xcode and Visual Studio Generators IDE generators.  It also allows the target names to be referenced unambiguously.

Makefile generators are capable of supporting duplicate add_custom_target() names.  For projects that care only about Makefile Generators and do not wish to support Xcode or Visual Studio Generators IDE generators, one may set this property to True to allow duplicate custom targets.  The property allows multiple add_custom_target() command calls in different directories to specify the same target name.  However, setting this property will cause non-Makefile generators to produce an error and refuse to generate the project.

Autogen_source_group

Name of the  source_group() for Automoc and Autorcc generated files.

Files generated by Automoc and Autorcc are not always known at configure time and therefore can’t be passed to source_group(). AUTOGEN_SOURCE_GROUP an be used instead to generate or select a source group for Automoc and Autorcc generated files.

For Automoc and Autorcc specific overrides see Automoc_source_group and Autorcc_source_group respectively.

Autogen_targets_folder

Name of Folder for *_autogen targets that are added automatically by CMake for targets for which Automoc is enabled.

If not set, CMake uses the Folder property of the parent target as a default value for this property.  See also the documentation for the Folder target property and the Automoc target property.

Automoc_source_group

Name of the  source_group() for Automoc generated files.

When set this is used instead of Autogen_source_group for files generated by Automoc.

Automoc_targets_folder

Name of Folder for *_autogen targets that are added automatically by CMake for targets for which Automoc is enabled.

This property is obsolete.  Use Autogen_targets_folder instead.

If not set, CMake uses the Folder property of the parent target as a default value for this property.  See also the documentation for the Folder target property and the Automoc target property.

Autorcc_source_group

Name of the  source_group() for Autorcc generated files.

When set this is used instead of Autogen_source_group for files generated by Autorcc.

Cmake_c_known_features

List of C features known to this version of CMake.

The features listed in this global property may be known to be available to the C compiler.  If the feature is available with the C compiler, it will be listed in the CMAKE_C_COMPILE_FEATURES variable.

The features listed here may be used with the target_compile_features() command.  See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

The features known to this version of CMake are:

c_std_90

Compiler mode is at least C 90.

c_std_99

Compiler mode is at least C 99.

c_std_11

Compiler mode is at least C 11.

c_function_prototypes

Function prototypes, as defined in ISO/IEC 9899:1990.

c_restrict

restrict keyword, as defined in ISO/IEC 9899:1999.

c_static_assert

Static assert, as defined in ISO/IEC 9899:2011.

c_variadic_macros

Variadic macros, as defined in ISO/IEC 9899:1999.

Cmake_cxx_known_features

List of C++ features known to this version of CMake.

The features listed in this global property may be known to be available to the C++ compiler.  If the feature is available with the C++ compiler, it will be listed in the CMAKE_CXX_COMPILE_FEATURES variable.

The features listed here may be used with the target_compile_features() command.  See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

The features known to this version of CMake are:

cxx_std_98

Compiler mode is at least C++ 98.

cxx_std_11

Compiler mode is at least C++ 11.

cxx_std_14

Compiler mode is at least C++ 14.

cxx_std_17

Compiler mode is at least C++ 17.

cxx_std_20

Compiler mode is at least C++ 20.

cxx_aggregate_default_initializers

Aggregate default initializers, as defined in N3605.

cxx_alias_templates

Template aliases, as defined in N2258.

cxx_alignas

Alignment control alignas, as defined in N2341.

cxx_alignof

Alignment control alignof, as defined in N2341.

cxx_attributes

Generic attributes, as defined in N2761.

cxx_attribute_deprecated

[[deprecated]] attribute, as defined in N3760.

cxx_auto_type

Automatic type deduction, as defined in N1984.

cxx_binary_literals

Binary literals, as defined in N3472.

cxx_constexpr

Constant expressions, as defined in N2235.

cxx_contextual_conversions

Contextual conversions, as defined in N3323.

cxx_decltype_incomplete_return_types

Decltype on incomplete return types, as defined in N3276.

cxx_decltype

Decltype, as defined in N2343.

cxx_decltype_auto

decltype(auto) semantics, as defined in N3638.

cxx_default_function_template_args

Default template arguments for function templates, as defined in DR226

cxx_defaulted_functions

Defaulted functions, as defined in N2346.

cxx_defaulted_move_initializers

Defaulted move initializers, as defined in N3053.

cxx_delegating_constructors

Delegating constructors, as defined in N1986.

cxx_deleted_functions

Deleted functions, as defined in N2346.

cxx_digit_separators

Digit separators, as defined in N3781.

cxx_enum_forward_declarations

Enum forward declarations, as defined in N2764.

cxx_explicit_conversions

Explicit conversion operators, as defined in N2437.

cxx_extended_friend_declarations

Extended friend declarations, as defined in N1791.

cxx_extern_templates

Extern templates, as defined in N1987.

cxx_final

Override control final keyword, as defined in N2928, N3206 and N3272.

cxx_func_identifier

Predefined __func__ identifier, as defined in N2340.

cxx_generalized_initializers

Initializer lists, as defined in N2672.

cxx_generic_lambdas

Generic lambdas, as defined in N3649.

cxx_inheriting_constructors

Inheriting constructors, as defined in N2540.

cxx_inline_namespaces

Inline namespaces, as defined in N2535.

cxx_lambdas

Lambda functions, as defined in N2927.

cxx_lambda_init_captures

Initialized lambda captures, as defined in N3648.

cxx_local_type_template_args

Local and unnamed types as template arguments, as defined in N2657.

cxx_long_long_type

long long type, as defined in N1811.

cxx_noexcept

Exception specifications, as defined in N3050.

cxx_nonstatic_member_init

Non-static data member initialization, as defined in N2756.

cxx_nullptr

Null pointer, as defined in N2431.

cxx_override

Override control override keyword, as defined in N2928, N3206 and N3272.

cxx_range_for

Range-based for, as defined in N2930.

cxx_raw_string_literals

Raw string literals, as defined in N2442.

cxx_reference_qualified_functions

Reference qualified functions, as defined in N2439.

cxx_relaxed_constexpr

Relaxed constexpr, as defined in N3652.

cxx_return_type_deduction

Return type deduction on normal functions, as defined in N3386.

cxx_right_angle_brackets

Right angle bracket parsing, as defined in N1757.

cxx_rvalue_references

R-value references, as defined in N2118.

cxx_sizeof_member

Size of non-static data members, as defined in N2253.

cxx_static_assert

Static assert, as defined in N1720.

cxx_strong_enums

Strongly typed enums, as defined in N2347.

cxx_thread_local

Thread-local variables, as defined in N2659.

cxx_trailing_return_types

Automatic function return type, as defined in N2541.

cxx_unicode_literals

Unicode string literals, as defined in N2442.

cxx_uniform_initialization

Uniform initialization, as defined in N2640.

cxx_unrestricted_unions

Unrestricted unions, as defined in N2544.

cxx_user_literals

User-defined literals, as defined in N2765.

cxx_variable_templates

Variable templates, as defined in N3651.

cxx_variadic_macros

Variadic macros, as defined in N1653.

cxx_variadic_templates

Variadic templates, as defined in N2242.

cxx_template_template_parameters

Template template parameters, as defined in ISO/IEC 14882:1998.

Cmake_role

Tells what mode the current running script is in. Could be one of several values:

PROJECT

Running in project mode (processing a CMakeLists.txt file).

SCRIPT

Running in -P script mode.

FIND_PACKAGE

Running in --find-package mode.

CTEST

Running in CTest script mode.

CPACK

Running in CPack.

Debug_configurations

Specify which configurations are for debugging.

The value must be a semi-colon separated list of configuration names. Currently this property is used only by the target_link_libraries() command.  Additional uses may be defined in the future.

This property must be set at the top level of the project and before the first target_link_libraries() command invocation.  If any entry in the list does not match a valid configuration for the project the behavior is undefined.

Disabled_features

List of features which are disabled during the CMake run.

List of features which are disabled during the CMake run.  By default it contains the names of all packages which were not found.  This is determined using the <Name>_FOUND variables.  Packages which are searched QUIET are not listed.  A project can add its own features to this list.  This property is used by the macros in FeatureSummary.cmake.

Enabled_features

List of features which are enabled during the CMake run.

List of features which are enabled during the CMake run.  By default it contains the names of all packages which were found.  This is determined using the <Name>_FOUND variables.  Packages which are searched QUIET are not listed.  A project can add its own features to this list.  This property is used by the macros in FeatureSummary.cmake.

Enabled_languages

Read-only property that contains the list of currently enabled languages

Set to list of currently enabled languages.

Find_library_use_lib32_paths

Whether the find_library() command should automatically search lib32 directories.

FIND_LIBRARY_USE_LIB32_PATHS is a boolean specifying whether the find_library() command should automatically search the lib32 variant of directories called lib in the search path when building 32-bit binaries.

See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.

Find_library_use_lib64_paths

Whether find_library() should automatically search lib64 directories.

FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the find_library() command should automatically search the lib64 variant of directories called lib in the search path when building 64-bit binaries.

See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.

Find_library_use_libx32_paths

Whether the find_library() command should automatically search libx32 directories.

FIND_LIBRARY_USE_LIBX32_PATHS is a boolean specifying whether the find_library() command should automatically search the libx32 variant of directories called lib in the search path when building x32-abi binaries.

See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.

Find_library_use_openbsd_versioning

Whether find_library() should find OpenBSD-style shared libraries.

This property is a boolean specifying whether the find_library() command should find shared libraries with OpenBSD-style versioned extension: “.so.<major>.<minor>”.  The property is set to true on OpenBSD and false on other platforms.

Generator_is_multi_config

Read-only property that is true on multi-configuration generators.

True when using a multi-configuration generator (such as Visual Studio Generators or Xcode). Multi-config generators use CMAKE_CONFIGURATION_TYPES as the set of configurations and ignore CMAKE_BUILD_TYPE.

Global_depends_debug_mode

Enable global target dependency graph debug mode.

CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation.  This property causes it to display details of its analysis to stderr.

Global_depends_no_cycles

Disallow global target dependency graph cycles.

CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation.  It reports an error if the dependency graph contains a cycle that does not consist of all STATIC library targets.  This property tells CMake to disallow all cycles completely, even among static libraries.

In_try_compile

Read-only property that is true during a try-compile configuration.

True when building a project inside a try_compile() or try_run() command.

Packages_found

List of packages which were found during the CMake run.

List of packages which were found during the CMake run.  Whether a package has been found is determined using the <Name>_FOUND variables.

Packages_not_found

List of packages which were not found during the CMake run.

List of packages which were not found during the CMake run.  Whether a package has been found is determined using the <Name>_FOUND variables.

Job_pools

Ninja only: List of available pools.

A pool is a named integer property and defines the maximum number of concurrent jobs which can be started by a rule assigned to the pool. The JOB_POOLS property is a semicolon-separated list of pairs using the syntax Name=integer (without a space after the equality sign).

For instance:

set_property(GLOBAL PROPERTY JOB_POOLS two_jobs=2 ten_jobs=10)

Defined pools could be used globally by setting CMAKE_JOB_POOL_COMPILE and CMAKE_JOB_POOL_LINK or per target by setting the target properties Job_pool_compile and Job_pool_link. Custom commands and custom targets can specify pools using the option JOB_POOL. Using a pool that is not defined by JOB_POOLS causes an error by ninja at build time.

If not set, this property uses the value of the CMAKE_JOB_POOLS variable.

Build targets provided by CMake that are meant for individual interactive use, such as install, are placed in the console pool automatically.

Predefined_targets_folder

Name of Folder for targets that are added automatically by CMake.

If not set, CMake uses “CMakePredefinedTargets” as a default value for this property.  Targets such as INSTALL, PACKAGE and RUN_TESTS will be organized into this Folder.  See also the documentation for the Folder target property.

Eclipse_extra_natures

List of natures to add to the generated Eclipse project file.

Eclipse projects specify language plugins by using natures. This property should be set to the unique identifier for a nature (which looks like a Java package name).

Also see the Eclipse_extra_cproject_contents property.

Eclipse_extra_cproject_contents

Additional contents to be inserted into the generated Eclipse cproject file.

The cproject file defines the CDT specific information. Some third party IDE’s are based on Eclipse with the addition of other information specific to that IDE. Through this property, it is possible to add this additional contents to the generated project. It is expected to contain valid XML.

Also see the Eclipse_extra_natures property.

Report_undefined_properties

If set, report any undefined properties to this file.

If this property is set to a filename then when CMake runs it will report any properties or variables that were accessed but not defined into the filename specified in this property.

Rule_launch_compile

Specify a launcher for compile rules.

Makefile Generators and the Ninja generator prefix compiler commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity.  Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.

Rule_launch_custom

Specify a launcher for custom rules.

Makefile Generators and the Ninja generator prefix custom commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity.  Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.

Rule_messages

Specify whether to report a message for each make rule.

This property specifies whether Makefile generators should add a progress message describing what each build rule does.  If the property is not set the default is ON.  Set the property to OFF to disable granular messages and report only as each target completes. This is intended to allow scripted builds to avoid the build time cost of detailed reports.  If a CMAKE_RULE_MESSAGES cache entry exists its value initializes the value of this property.  Non-Makefile generators currently ignore this property.

Target_archives_may_be_shared_libs

Set if shared libraries may be named like archives.

On AIX shared libraries may be named “lib<name>.a”.  This property is set to true on such platforms.

Target_messages

Specify whether to report the completion of each target.

This property specifies whether Makefile Generators should add a progress message describing that each target has been completed. If the property is not set the default is ON.  Set the property to OFF to disable target completion messages.

This option is intended to reduce build output when little or no work needs to be done to bring the build tree up to date.

If a CMAKE_TARGET_MESSAGES cache entry exists its value initializes the value of this property.

Non-Makefile generators currently ignore this property.

See the counterpart property Rule_messages to disable everything except for target completion messages.

Target_supports_shared_libs

Does the target platform support shared libraries.

TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target platform supports shared libraries.  Basically all current general general purpose OS do so, the exception are usually embedded systems with no or special OSs.

Use_folders

Use the Folder target property to organize targets into folders.

If not set, CMake treats this property as OFF by default.  CMake generators that are capable of organizing into a hierarchy of folders use the values of the Folder target property to name those folders. See also the documentation for the Folder target property.

Xcode_emit_effective_platform_name

Control emission of EFFECTIVE_PLATFORM_NAME by the Xcode generator.

It is required for building the same target with multiple SDKs. A common use case is the parallel use of iphoneos and iphonesimulator SDKs.

Three different states possible that control when the Xcode generator emits the EFFECTIVE_PLATFORM_NAME variable:

  • If set to ON it will always be emitted
  • If set to OFF it will never be emitted
  • If unset (the default) it will only be emitted when the project was configured for an embedded Xcode SDK like iOS, tvOS, watchOS or any of the simulators.
NOTE:

When this behavior is enable for generated Xcode projects, the EFFECTIVE_PLATFORM_NAME variable will leak into Generator expressions like TARGET_FILE and will render those mostly unusable.

Properties on Directories

Additional_clean_files

A ;-list of files or directories that will be removed as a part of the global clean target.  It is useful for specifying generated files or directories that are used by multiple targets or by CMake itself, or that are generated in ways which cannot be captured as outputs or byproducts of custom commands.

If an additional clean file is specific to a single target only, then the ADDITIONAL_CLEAN_FILES target property would usually be a better choice than this directory property.

Relative paths are allowed and are interpreted relative to the current binary directory.

Contents of ADDITIONAL_CLEAN_FILES may use generator expressions.

This property only works for the Ninja and the Makefile generators.  It is ignored by other generators.

Binary_dir

This read-only directory property reports absolute path to the binary directory corresponding to the source on which it is read.

Buildsystem_targets

This read-only directory property contains a semicolon-separated list of buildsystem targets added in the directory by calls to the add_library(), add_executable(), and add_custom_target() commands.  The list does not include any Imported Targets or Alias Targets, but does include Interface Libraries.  Each entry in the list is the logical name of a target, suitable to pass to the get_property() command TARGET option.

Cache_variables

List of cache variables available in the current directory.

This read-only property specifies the list of CMake cache variables currently defined.  It is intended for debugging purposes.

Clean_no_custom

Set to true to tell Makefile Generators not to remove the outputs of custom commands for this directory during the make clean operation. This is ignored on other generators because it is not possible to implement.

Cmake_configure_depends

Tell CMake about additional input files to the configuration process. If any named file is modified the build system will re-run CMake to re-configure the file and generate the build system again.

Specify files as a semicolon-separated list of paths.  Relative paths are interpreted as relative to the current source directory.

Compile_definitions

Preprocessor definitions for compiling a directory’s sources.

This property specifies the list of options given so far to the add_compile_definitions() (or add_definitions()) command.

The COMPILE_DEFINITIONS property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported.  CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values).

This property will be initialized in each directory by its value in the directory’s parent.

CMake will automatically drop some definitions that are not supported by the native build tool.

Disclaimer: Most native build tools have poor support for escaping certain values.  CMake has work-arounds for many cases but some values may just not be possible to pass correctly.  If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value.  Your work-around may break in a future version of CMake that has improved escape support.  Instead consider defining the macro in a (configured) header file.  Then report the limitation.  Known limitations include:

#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows

CMake does not reject these values outright because they do work in some cases.  Use with caution.

Contents of COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions.  Generator expressions should be preferred instead of setting the alternative property.

Compile_options

List of options to pass to the compiler.

This property holds a semicolon-separated list of options given so far to the add_compile_options() command.

This property is used to initialize the COMPILE_OPTIONS target property when a target is created, which is used by the generators to set the options for the compiler.

Contents of COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Definitions

For CMake 2.4 compatibility only.  Use Compile_definitions instead.

This read-only property specifies the list of flags given so far to the add_definitions() command.  It is intended for debugging purposes.  Use the Compile_definitions directory property instead.

This built-in read-only property does not exist if policy CMP0059 is set to NEW.

Exclude_from_all

Set this directory property to a true value on a subdirectory to exclude its targets from the “all” target of its ancestors.  If excluded, running e.g. make in the parent directory will not build targets the subdirectory by default.  This does not affect the “all” target of the subdirectory itself.  Running e.g. make inside the subdirectory will still build its targets.

If the EXCLUDE_FROM_ALL target property is set on a target then its value determines whether the target is included in the “all” target of this directory and its ancestors.

Implicit_depends_include_transform

Specify #include line transforms for dependencies in a directory.

This property specifies rules to transform macro-like #include lines during implicit dependency scanning of C and C++ source files.  The list of rules must be semicolon-separated with each entry of the form A_MACRO(%)=value-with-% (the % must be literal).  During dependency scanning occurrences of A_MACRO(...) on #include lines will be replaced by the value given with the macro argument substituted for %.  For example, the entry

MYDIR(%)=<mydir/%>

will convert lines of the form

#include MYDIR(myheader.h)

to

#include <mydir/myheader.h>

allowing the dependency to be followed.

This property applies to sources in all targets within a directory. The property value is initialized in each directory by its value in the directory’s parent.

Include_directories

List of preprocessor include file search directories.

This property specifies the list of directories given so far to the include_directories() command.

This property is used to populate the INCLUDE_DIRECTORIES target property, which is used by the generators to set the include directories for the compiler.

In addition to accepting values from that command, values may be set directly on any directory using the set_property() command, and can be set on the current directory using the set_directory_properties() command.  A directory gets its initial value from its parent directory if it has one.  The initial value of the INCLUDE_DIRECTORIES target property comes from the value of this property.  Both directory and target property values are adjusted by calls to the include_directories() command. Calls to set_property() or set_directory_properties(), however, will update the directory property value without updating target property values.  Therefore direct property updates must be made before calls to add_executable() or add_library() for targets they are meant to affect.

The target property values are used by the generators to set the include paths for the compiler.

Contents of INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Include_regular_expression

Include file scanning regular expression.

This property specifies the regular expression used during dependency scanning to match include files that should be followed. See the include_regular_expression() command for a high-level interface to set this property.

Interprocedural_optimization_<Config>

Per-configuration interprocedural optimization for a directory.

This is a per-configuration version of Interprocedural_optimization. If set, this property overrides the generic property for the named configuration.

Interprocedural_optimization

Enable interprocedural optimization for targets in a directory.

If set to true, enables interprocedural optimizations if they are known to be supported by the compiler.

Labels

Specify a list of text labels associated with a directory and all of its subdirectories. This is equivalent to setting the LABELS target property and the LABELS test property on all targets and tests in the current directory and subdirectories. Note: Launchers must enabled to propagate labels to targets.

The CMAKE_DIRECTORY_LABELS variable can be used to initialize this property.

The list is reported in dashboard submissions.

Listfile_stack

The current stack of listfiles being processed.

This property is mainly useful when trying to debug errors in your CMake scripts.  It returns a list of what list files are currently being processed, in order.  So if one listfile does an include() command then that is effectively pushing the included listfile onto the stack.

Macros

List of macro commands available in the current directory.

This read-only property specifies the list of CMake macros currently defined.  It is intended for debugging purposes.  See the macro() command.

Parent_directory

Source directory that added current subdirectory.

This read-only property specifies the source directory that added the current source directory as a subdirectory of the build.  In the top-level directory the value is the empty-string.

Rule_launch_compile

Specify a launcher for compile rules.

See the global property of the same name for details.  This overrides the global property for a directory.

Rule_launch_custom

Specify a launcher for custom rules.

See the global property of the same name for details.  This overrides the global property for a directory.

Source_dir

This read-only directory property reports absolute path to the source directory on which it is read.

Subdirectories

This read-only directory property contains a semicolon-separated list of subdirectories processed so far by the add_subdirectory() or subdirs() commands.  Each entry is the absolute path to the source directory (containing the CMakeLists.txt file).  This is suitable to pass to the get_property() command DIRECTORY option.

Note:

The subdirs() command does not process its arguments until after the calling directory is fully processed.  Therefore looking up this property in the current directory will not see them.

Tests

List of tests.

This read-only property holds a semicolon-separated list of tests defined so far, in the current directory, by the add_test() command.

Test_include_files

A list of cmake files that will be included when ctest is run.

If you specify TEST_INCLUDE_FILES, those files will be included and processed when ctest is run on the directory.

Variables

List of variables defined in the current directory.

This read-only property specifies the list of CMake variables currently defined.  It is intended for debugging purposes.

VS_GLOBAL_SECTION_POST_<section>

Specify a postSolution global section in Visual Studio.

Setting a property like this generates an entry of the following form in the solution file:

GlobalSection(<section>) = postSolution
  <contents based on property value>
EndGlobalSection

The property must be set to a semicolon-separated list of key=value pairs.  Each such pair will be transformed into an entry in the solution global section.  Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.

This property only works for Visual Studio 9 and above; it is ignored on other generators.  The property only applies when set on a directory whose CMakeLists.txt contains a project() command.

Note that CMake generates postSolution sections ExtensibilityGlobals and ExtensibilityAddIns by default.  If you set the corresponding property, it will override the default section.  For example, setting VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default contents of the ExtensibilityGlobals section, while keeping ExtensibilityAddIns on its default.  However, CMake will always add a SolutionGuid to the ExtensibilityGlobals section if it is not specified explicitly.

VS_GLOBAL_SECTION_PRE_<section>

Specify a preSolution global section in Visual Studio.

Setting a property like this generates an entry of the following form in the solution file:

GlobalSection(<section>) = preSolution
  <contents based on property value>
EndGlobalSection

The property must be set to a semicolon-separated list of key=value pairs.  Each such pair will be transformed into an entry in the solution global section.  Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.

This property only works for Visual Studio 9 and above; it is ignored on other generators.  The property only applies when set on a directory whose CMakeLists.txt contains a project() command.

Vs_startup_project

Specify the default startup project in a Visual Studio solution.

The Visual Studio Generators create a .sln file for each directory whose CMakeLists.txt file calls the project() command.  Set this property in the same directory as a project() command call (e.g. in the top-level CMakeLists.txt file) to specify the default startup project for the corresponding solution file.

The property must be set to the name of an existing target.  This will cause that project to be listed first in the generated solution file causing Visual Studio to make it the startup project if the solution has never been opened before.

If this property is not specified, then the ALL_BUILD project will be the default.

Properties on Targets

Additional_clean_files

A ;-list of files or directories that will be removed as a part of the global clean target.  It can be used to specify files and directories that are generated as part of building the target or that are directly associated with the target in some way (e.g. created as a result of running the target).

For custom targets, if such files can be captured as outputs or byproducts instead, then that should be preferred over adding them to this property. If an additional clean file is used by multiple targets or isn’t target-specific, then the Additional_clean_files directory property may be the more appropriate property to use.

Relative paths are allowed and are interpreted relative to the current binary directory.

Contents of Additional_clean_files may use generator expressions.

This property only works for the Ninja and the Makefile generators.  It is ignored by other generators.

Aliased_target

Name of target aliased by this target.

If this is an Alias Target, this property contains the name of the target aliased.

Android_ant_additional_options

Set the additional options for Android Ant build system. This is a string value containing all command line options for the Ant build. This property is initialized by the value of the CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS variable if it is set when a target is created.

Android_api

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target API version (e.g. 15). The version number must be a positive decimal integer.  This property is initialized by the value of the CMAKE_ANDROID_API variable if it is set when a target is created.

Android_api_min

Set the Android MIN API version (e.g. 9).  The version number must be a positive decimal integer.  This property is initialized by the value of the CMAKE_ANDROID_API_MIN variable if it is set when a target is created.  Native code builds using this API version.

Android_arch

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target architecture.

This is a string property that could be set to the one of the following values:

  • armv7-a: “ARMv7-A (armv7-a)”
  • armv7-a-hard: “ARMv7-A, hard-float ABI (armv7-a)”
  • arm64-v8a: “ARMv8-A, 64bit (arm64-v8a)”
  • x86: “x86 (x86)”
  • x86_64: “x86_64 (x86_64)”

This property is initialized by the value of the CMAKE_ANDROID_ARCH variable if it is set when a target is created.

Android_assets_directories

Set the Android assets directories to copy into the main assets folder before build. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_ASSETS_DIRECTORIES variable if it is set when a target is created.

Android_gui

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies whether to build an executable as an application package on Android.

When this property is set to true the executable when built for Android will be created as an application package.  This property is initialized by the value of the CMAKE_ANDROID_GUI variable if it is set when a target is created.

Add the AndroidManifest.xml source file explicitly to the target add_executable() command invocation to specify the root directory of the application package source.

Android_jar_dependencies

Set the Android property that specifies JAR dependencies. This is a string value property. This property is initialized by the value of the CMAKE_ANDROID_JAR_DEPENDENCIES variable if it is set when a target is created.

Android_jar_directories

Set the Android property that specifies directories to search for the JAR libraries.

This a string property that contains the directory paths separated by semicolons. This property is initialized by the value of the CMAKE_ANDROID_JAR_DIRECTORIES variable if it is set when a target is created.

Contents of ANDROID_JAR_DIRECTORIES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.

Android_java_source_dir

Set the Android property that defines the Java source code root directories. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_JAVA_SOURCE_DIR variable if it is set when a target is created.

Android_native_lib_dependencies

Set the Android property that specifies the .so dependencies. This is a string property.

This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES variable if it is set when a target is created.

Contents of ANDROID_NATIVE_LIB_DEPENDENCIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

Android_native_lib_directories

Set the Android property that specifies directories to search for the .so libraries.

This a string property that contains the directory paths separated by semicolons.

This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES variable if it is set when a target is created.

Contents of ANDROID_NATIVE_LIB_DIRECTORIES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.

Android_process_max

Set the Android property that defines the maximum number of a parallel Android NDK compiler processes (e.g. 4). This property is initialized by the value of the CMAKE_ANDROID_PROCESS_MAX variable if it is set when a target is created.

Android_proguard

When this property is set to true that enables the ProGuard tool to shrink, optimize, and obfuscate the code by removing unused code and renaming classes, fields, and methods with semantically obscure names. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD variable if it is set when a target is created.

Android_proguard_config_path

Set the Android property that specifies the location of the ProGuard config file. Leave empty to use the default one. This a string property that contains the path to ProGuard config file. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD_CONFIG_PATH variable if it is set when a target is created.

Android_secure_props_path

Set the Android property that states the location of the secure properties file. This is a string property that contains the file path. This property is initialized by the value of the CMAKE_ANDROID_SECURE_PROPS_PATH variable if it is set when a target is created.

Android_skip_ant_step

Set the Android property that defines whether or not to skip the Ant build step. This is a boolean property initialized by the value of the CMAKE_ANDROID_SKIP_ANT_STEP variable if it is set when a target is created.

Android_stl_type

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies the type of STL support for the project. This is a string property that could set to the one of the following values:

none

No C++ Support

system

Minimal C++ without STL

gabi++_static

GAbi++ Static

gabi++_shared

GAbi++ Shared

gnustl_static

GNU libstdc++ Static

gnustl_shared

GNU libstdc++ Shared

stlport_static

STLport Static

stlport_shared

STLport Shared

This property is initialized by the value of the CMAKE_ANDROID_STL_TYPE variable if it is set when a target is created.

Archive_output_directory_<Config>

Per-configuration output directory for ARCHIVE target files.

This is a per-configuration version of the Archive_output_directory target property, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory.  This property is initialized by the value of the CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

Archive_output_directory

Output directory in which to build ARCHIVE target files.

This property specifies the directory into which archive target files should be built.  The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created.

See also the ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> target property.

Archive_output_name_<Config>

Per-configuration output name for ARCHIVE target files.

This is the configuration-specific version of the Archive_output_name target property.

Archive_output_name

Output name for ARCHIVE target files.

This property specifies the base name for archive target files.  It overrides Output_name and OUTPUT_NAME_<CONFIG> properties.

See also the ARCHIVE_OUTPUT_NAME_<CONFIG> target property.

Autogen_build_dir

Directory where Automoc, Autouic and Autorcc generate files for the target.

The directory is created on demand and automatically added to the Additional_clean_files target property.

When unset or empty the directory <dir>/<target-name>_autogen is used where <dir> is CMAKE_CURRENT_BINARY_DIR and <target-name> is Name.

By default AUTOGEN_BUILD_DIR is unset.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autogen_origin_depends

Switch for forwarding origin target dependencies to the corresponding _autogen target.

Targets which have their Automoc or Autouic property ON have a corresponding _autogen target which generates moc and uic files.  As this _autogen target is created at generate-time, it is not possible to define dependencies of it using e.g.  add_dependencies().  Instead the AUTOGEN_ORIGIN_DEPENDS target property decides whether the origin target dependencies should be forwarded to the _autogen target or not.

By default AUTOGEN_ORIGIN_DEPENDS is initialized from CMAKE_AUTOGEN_ORIGIN_DEPENDS which is ON by default.

In total the dependencies of the _autogen target are composed from

  • forwarded origin target dependencies (enabled by default via AUTOGEN_ORIGIN_DEPENDS)
  • additional user defined dependencies from Autogen_target_depends

See the cmake-qt(7) manual for more information on using CMake with Qt.

Note

Disabling Autogen_origin_depends is useful to avoid building of origin target dependencies when building the _autogen target only. This is especially interesting when a global autogen target is enabled.

When the _autogen target doesn’t require all the origin target’s dependencies, and Autogen_origin_depends is disabled, it might be necessary to extend Autogen_target_depends to add missing dependencies.

Autogen_parallel

Number of parallel moc or uic processes to start when using Automoc and Autouic.

The custom <origin>_autogen target starts a number of threads of which each one parses a source file and on demand starts a moc or uic process.  AUTOGEN_PARALLEL controls how many parallel threads (and therefore moc or uic processes) are started.

  • An empty (or unset) value or the string AUTO sets the number of threads/processes to the number of physical CPUs on the host system.
  • A positive non zero integer value sets the exact thread/process count.
  • Otherwise a single thread/process is started.

By default AUTOGEN_PARALLEL is initialized from CMAKE_AUTOGEN_PARALLEL.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autogen_target_depends

Additional target dependencies of the corresponding _autogen target.

Targets which have their Automoc or Autouic property ON have a corresponding _autogen target which generates moc and uic files.  As this _autogen target is created at generate-time, it is not possible to define dependencies of it using e.g.  add_dependencies().  Instead the AUTOGEN_TARGET_DEPENDS target property can be set to a ;-list of additional dependencies for the _autogen target.  Dependencies can be target names or file names.

In total the dependencies of the _autogen target are composed from

  • forwarded origin target dependencies (enabled by default via Autogen_origin_depends)
  • additional user defined dependencies from AUTOGEN_TARGET_DEPENDS

See the cmake-qt(7) manual for more information on using CMake with Qt.

Use cases

If Automoc or Autouic depends on a file that is either

it must added to Autogen_target_depends.

Automoc_compiler_predefines

Boolean value used by Automoc to determine if the compiler pre definitions file moc_predefs.h should be generated.

CMake generates a moc_predefs.h file with compiler pre definitions from the output of the command defined in CMAKE_CXX_COMPILER_PREDEFINES_COMMAND when

  • Automoc is enabled,
  • AUTOMOC_COMPILER_PREDEFINES is enabled,
  • CMAKE_CXX_COMPILER_PREDEFINES_COMMAND isn’t empty and
  • the Qt version is greater or equal 5.8.

The moc_predefs.h file, which is generated in Autogen_build_dir, is passed to moc as the argument to the --include option.

By default AUTOMOC_COMPILER_PREDEFINES is initialized from CMAKE_AUTOMOC_COMPILER_PREDEFINES, which is ON by default.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Automoc_depend_filters

Filter definitions used by Automoc to extract file names from a source file that are registered as additional dependencies for the moc file of the source file.

Filters are defined as KEYWORD;REGULAR_EXPRESSION pairs. First the file content is searched for KEYWORD. If it is found at least once, then file names are extracted by successively searching for REGULAR_EXPRESSION and taking the first match group.

The file name found in the first match group is searched for

If any of the extracted files changes, then the moc file for the source file gets rebuilt even when the source file itself doesn’t change.

If any of the extracted files is Generated or if it is not in the target’s sources, then it might be necessary to add it to the _autogen target  dependencies. See Autogen_target_depends for reference.

By default AUTOMOC_DEPEND_FILTERS is initialized from CMAKE_AUTOMOC_DEPEND_FILTERS, which is empty by default.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Example 1

A header file my_class.hpp uses a custom macro JSON_FILE_MACRO which is defined in an other header macros.hpp. We want the moc file of my_class.hpp to depend on the file name argument of JSON_FILE_MACRO:

// my_class.hpp
class My_Class : public QObject
{
  Q_OBJECT
  JSON_FILE_MACRO ( "info.json" )
...
};

In CMakeLists.txt we add a filter to CMAKE_AUTOMOC_DEPEND_FILTERS like this:

list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
  "JSON_FILE_MACRO"
  "[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\""
)

We assume info.json is a plain (not Generated) file that is listed in the target’s source.  Therefore we do not need to add it to Autogen_target_depends.

Example 2

In the target my_target a header file complex_class.hpp uses a custom macro JSON_BASED_CLASS which is defined in an other header macros.hpp:

// macros.hpp
...
#define JSON_BASED_CLASS(name, json) \
class name : public QObject \
{ \
  Q_OBJECT \
  Q_PLUGIN_METADATA(IID "demo" FILE json) \
  name() {} \
};
...
// complex_class.hpp
#pragma once
JSON_BASED_CLASS(Complex_Class, "meta.json")
// end of file

Since complex_class.hpp doesn’t contain a Q_OBJECT macro it would be ignored by Automoc.  We change this by adding JSON_BASED_CLASS to CMAKE_AUTOMOC_MACRO_NAMES:

list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "JSON_BASED_CLASS")

We want the moc file of complex_class.hpp to depend on meta.json.  So we add a filter to CMAKE_AUTOMOC_DEPEND_FILTERS:

list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
  "JSON_BASED_CLASS"
  "[\n^][ \t]*JSON_BASED_CLASS[ \t]*\\([^,]*,[ \t]*\"([^\"]+)\""
)

Additionally we assume meta.json is Generated which is why we have to add it to Autogen_target_depends:

set_property(TARGET my_target APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "meta.json")

Automoc_executable

AUTOMOC_EXECUTABLE is file path pointing to the moc executable to use for Automoc enabled files. Setting this property will make CMake skip the automatic detection of the moc binary as well as the sanity-tests normally run to ensure that the binary is available and working as expected.

Usually this property does not need to be set. Only consider this property if auto-detection of moc can not work – e.g. because you are building the moc binary as part of your project.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Automoc_macro_names

A semicolon-separated list list of macro names used by Automoc to determine if a C++ file needs to be processed by moc.

This property is only used if the Automoc property is ON for this target.

When running Automoc, CMake searches for the strings listed in AUTOMOC_MACRO_NAMES in C++ source and header files. If any of the strings is found

  • as the first non space string on a new line or
  • as the first non space string after a { on a new line,

then the file will be processed by moc.

By default AUTOMOC_MACRO_NAMES is initialized from CMAKE_AUTOMOC_MACRO_NAMES.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Example

In this case the Q_OBJECT macro is hidden inside another macro called CUSTOM_MACRO.  To let CMake know that source files that contain CUSTOM_MACRO need to be moc processed, we call:

set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")

Automoc_moc_options

Additional options for moc when using Automoc

This property is only used if the Automoc property is ON for this target.  In this case, it holds additional command line options which will be used when moc is executed during the build, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() macro.

By default it is empty.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Automoc_path_prefix

When this property is ON, CMake will generate the -p path prefix option for moc on Automoc enabled Qt targets.

To generate the path prefix, CMake tests if the header compiled by moc is in any of the target include directories.  If so, CMake will compute the relative path accordingly.  If the header is not in the include directories, CMake will omit the -p path prefix option.  moc usually generates a relative include path in that case.

AUTOMOC_PATH_PREFIX is initialized from the variable CMAKE_AUTOMOC_PATH_PREFIX, which is ON by default.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Reproducible builds

For reproducible builds is is recommended to keep headers that are moc compiled in one of the target include directories and set Automoc_path_prefix to ON (which is the default).  This ensures that

  • moc output files are identical on different build setups,
  • moc output files will compile correctly when the source and/or build directory is a symbolic link.

Automoc

Should the target be processed with auto-moc (for Qt projects).

AUTOMOC is a boolean specifying whether CMake will handle the Qt moc preprocessor automatically, i.e.  without having to use the QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are supported.

This property is initialized by the value of the CMAKE_AUTOMOC variable if it is set when a target is created.

When this property is set ON, CMake will scan the header and source files at build time and invoke moc accordingly.

Header file processing

At configuration time, a list of header files that should be scanned by Automoc is computed from the target’s sources.

  • All header files in the target’s sources are added to the scan list.
  • For all C++ source files <source_base>.<source_extension> in the target’s sources, CMake searches for

    • a regular header with the same base name (<source_base>.<header_extention>) and
    • a private header with the same base name and a _p suffix (<source_base>_p.<header_extention>)

    and adds these to the scan list.

At build time, CMake scans each unknown or modified header file from the list and searches for

If a Qt macro is found, then the header will be compiled by the moc to the output file moc_<base_name>.cpp.  The complete output file path is described in the section Output file location.

The header will be moc compiled again if a file from the additional file dependencies changes.

Header moc output files moc_<base_name>.cpp can be included in source files.  In the section Including header moc files in sources there is more information on that topic.

Source file processing

At build time, CMake scans each unknown or modified C++ source file from the target’s sources for

  • a Qt macro from Automoc_macro_names,
  • includes of header moc files (see Including header moc files in sources),
  • additional file dependencies from the FILE argument of a Q_PLUGIN_METADATA macro and
  • additional file dependencies detected by filters defined in Automoc_depend_filters.

If a Qt macro is found, then the C++ source file <base>.<source_extension> is expected to as well contain an include statement

#include <<base>.moc> // or
#include "<base>.moc"

The source file then will be compiled by the moc to the output file <base>.moc.  A description of the complete output file path is in section Output file location.

The source will be moc compiled again if a file from the additional file dependencies changes.

Including header moc files in sources

A source file can include the moc output file of a header <header_base>.<header_extension> by using an include statement of the form

#include <moc_<header_base>.cpp> // or
#include "moc_<header_base>.cpp"

If the moc output file of a header is included by a source, it will be generated in a different location than if it was not included.  This is described in the section Output file location.

Output file location

Included moc output files

moc output files that are included by a source file will be generated in

Where <Autogen_build_dir> is the value of the target property Autogen_build_dir.

The include directory is automatically added to the target’s Include_directories.

Not included moc output files

moc output files that are not included in a source file will be generated in

  • <Autogen_build_dir>/<SOURCE_DIR_CHECKSUM> for single configuration generators or in,
  • <Autogen_build_dir>/include_<CONFIG>/<SOURCE_DIR_CHECKSUM> for multi configuration generators.

Where <SOURCE_DIR_CHECKSUM> is a checksum computed from the relative parent directory path of the moc input file.  This scheme allows to have moc input files with the same name in different directories.

All not included moc output files will be included automatically by the CMake generated file

which is added to the target’s sources.

Qt version detection

Automoc enabled targets need to know the Qt major and minor version they’re working with.  The major version usually is provided by the INTERFACE_QT_MAJOR_VERSION property of the Qt[45]Core library, that the target links to.  To find the minor version, CMake builds a list of available Qt versions from

  • Qt5Core_VERSION_MAJOR and Qt5Core_VERSION_MINOR variables (usually set by find_package(Qt5...))
  • Qt5Core_VERSION_MAJOR and Qt5Core_VERSION_MINOR directory properties
  • QT_VERSION_MAJOR and QT_VERSION_MINOR  variables (usually set by find_package(Qt4...))
  • QT_VERSION_MAJOR and QT_VERSION_MINOR  directory properties

in the context of the add_executable() or add_library() call.

Assumed  INTERFACE_QT_MAJOR_VERSION is a valid number, the first entry in the list with a matching major version is taken.  If no matching major version was found, an error is generated. If  INTERFACE_QT_MAJOR_VERSION is not a valid number, the first entry in the list is taken.

A find_package(Qt[45]...) call sets the QT/Qt5Core_VERSION_MAJOR/MINOR variables.  If the call is in a different context than the add_executable() or add_library() call, e.g. in a function, then the version variables might not be available to the Automoc enabled target. In that case the version variables can be forwarded from the find_package(Qt[45]…) calling context to the add_executable() or add_library() calling context as directory properties. The following Qt5 example demonstrates the procedure.

function (add_qt5_client)
  find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets)
  ...
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}")
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}")
  ...
endfunction ()
...
add_qt5_client()
add_executable(myTarget main.cpp)
target_link_libraries(myTarget Qt5::QtWidgets)
set_property(TARGET myTarget PROPERTY AUTOMOC ON)

Modifiers

Automoc_executable: The moc executable will be detected automatically, but can be forced to a certain binary using this target property.

Automoc_moc_options: Additional command line options for moc can be set in this target property.

Automoc_macro_names: This list of Qt macro names can be extended to search for additional macros in headers and sources.

Automoc_depend_filters: moc dependency file names can be extracted from headers or sources by defining file name filters in this target property.

Automoc_compiler_predefines: Compiler pre definitions for moc are written to the moc_predefs.h file. The generation of this file can be enabled or disabled in this target property.

Skip_automoc: Sources and headers can be excluded from Automoc processing by setting this source file property.

Skip_autogen: Source files can be excluded from Automoc, Autouic and Autorcc processing by setting this source file property.

Autogen_source_group: This global property can be used to group files generated by Automoc or Autorcc together in an IDE, e.g.  in MSVS.

Autogen_targets_folder: This global property can be used to group Automoc, Autouic and Autorcc targets together in an IDE, e.g.  in MSVS.

CMAKE_GLOBAL_AUTOGEN_TARGET: A global autogen target, that depends on all Automoc or Autouic generated <ORIGIN>_autogen targets in the project, will be generated when this variable is ON.

Autogen_parallel: This target property controls the number of moc or uic processes to start in parallel during builds.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autouic

Should the target be processed with auto-uic (for Qt projects).

AUTOUIC is a boolean specifying whether CMake will handle the Qt uic code generator automatically, i.e. without having to use the QT4_WRAP_UI() or QT5_WRAP_UI() macro. Currently Qt4 and Qt5 are supported.

This property is initialized by the value of the CMAKE_AUTOUIC variable if it is set when a target is created.

When this property is ON, CMake will scan the header and source files at build time and invoke uic accordingly.

Header and source file processing

At build time, CMake scans each header and source file from the target’s sources for include statements of the form

#include "ui_<ui_base>.h"

Once such an include statement is found in a file, CMake searches for the uic input file <ui_base>.ui

If the <ui_base>.ui file was found, uic is called on it to generate ui_<ui_base>.h in the directory

Where <Autogen_build_dir> is the value of the target property Autogen_build_dir.

The include directory is automatically added to the target’s Include_directories.

Modifiers

Autouic_executable: The uic executable will be detected automatically, but can be forced to a certain binary using this target property.

Autouic_options: Additional command line options for uic can be set via this source file property on a <base_name>.ui file.

Skip_autouic: Source files can be excluded from Autouic processing by setting this source file property.

Skip_autogen: Source files can be excluded from Automoc, Autouic and Autorcc processing by setting this source file property.

Autogen_targets_folder: This global property can be used to group Automoc, Autouic and Autorcc targets together in an IDE, e.g.  in MSVS.

CMAKE_GLOBAL_AUTOGEN_TARGET: A global autogen target, that depends on all Automoc or Autouic generated <ORIGIN>_autogen targets in the project, will be generated when this variable is ON.

Autogen_parallel: This target property controls the number of moc or uic processes to start in parallel during builds.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autouic_executable

AUTOUIC_EXECUTABLE is file path pointing to the uic executable to use for Autouic enabled files. Setting this property will make CMake skip the automatic detection of the uic binary as well as the sanity-tests normally run to ensure that the binary is available and working as expected.

Usually this property does not need to be set. Only consider this property if auto-detection of uic can not work – e.g. because you are building the uic binary as part of your project.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autouic_options

Additional options for uic when using Autouic

This property holds additional command line options which will be used when uic is executed during the build via Autouic, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.

By default it is empty.

This property is initialized by the value of the CMAKE_AUTOUIC_OPTIONS variable if it is set when a target is created.

The options set on the target may be overridden by AUTOUIC_OPTIONS set on the .ui source file.

This property may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Example

# ...
set_property(TARGET tgt PROPERTY AUTOUIC_OPTIONS "--no-protection")
# ...

Autouic_search_paths

Search path list used by Autouic to find included .ui files.

This property is initialized by the value of the CMAKE_AUTOUIC_SEARCH_PATHS variable if it is set when a target is created. Otherwise it is empty.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autorcc

Should the target be processed with auto-rcc (for Qt projects).

AUTORCC is a boolean specifying whether CMake will handle the Qt rcc code generator automatically, i.e. without having to use the QT4_ADD_RESOURCES() or QT5_ADD_RESOURCES() macro.  Currently Qt4 and Qt5 are supported.

When this property is ON, CMake will handle .qrc files added as target sources at build time and invoke rcc accordingly. This property is initialized by the value of the CMAKE_AUTORCC variable if it is set when a target is created.

By default AUTORCC is processed by a custom command. If the .qrc file is Generated, a custom target is used instead.

When there are multiple .qrc files with the same name, CMake will generate unspecified unique output file names for rcc.  Therefore, if Q_INIT_RESOURCE() or Q_CLEANUP_RESOURCE() need to be used, the .qrc file name must be unique.

Modifiers

Autorcc_executable: The rcc executable will be detected automatically, but can be forced to a certain binary by setting this target property.

Autorcc_options: Additional command line options for rcc can be set via this .qrc source file property.

Skip_autorcc: .qrc files can be excluded from Autorcc processing by setting this source file property.

Skip_autogen: Source files can be excluded from Automoc, Autouic and Autorcc processing by setting this source file property.

Autogen_source_group: This global property can be used to group files generated by Automoc or Autorcc together in an IDE, e.g.  in MSVS.

Autogen_targets_folder: This global property can be used to group Automoc, Autouic and Autorcc targets together in an IDE, e.g.  in MSVS.

CMAKE_GLOBAL_AUTORCC_TARGET: A global autorcc target that depends on all Autorcc targets in the project will be generated when this variable is ON.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autorcc_executable

AUTORCC_EXECUTABLE is file path pointing to the rcc executable to use for Autorcc enabled files. Setting this property will make CMake skip the automatic detection of the rcc binary as well as the sanity-tests normally run to ensure that the binary is available and working as expected.

Usually this property does not need to be set. Only consider this property if auto-detection of rcc can not work – e.g. because you are building the rcc binary as part of your project.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Autorcc_options

Additional options for rcc when using Autorcc

This property holds additional command line options which will be used when rcc is executed during the build via Autorcc, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.

By default it is empty.

This property is initialized by the value of the CMAKE_AUTORCC_OPTIONS variable if it is set when a target is created.

The options set on the target may be overridden by AUTORCC_OPTIONS set on the .qrc source file.

See the cmake-qt(7) manual for more information on using CMake with Qt.

Example

# ...
set_property(TARGET tgt PROPERTY AUTORCC_OPTIONS "--compress;9")
# ...

Binary_dir

This read-only property reports the value of the CMAKE_CURRENT_BINARY_DIR variable in the directory in which the target was defined.

Build_rpath

A semicolon-separated list specifying runtime path (RPATH) entries to add to binaries linked in the build tree (for platforms that support it).  The entries will not be used for binaries in the install tree.  See also the Install_rpath target property.

This property is initialized by the value of the variable CMAKE_BUILD_RPATH if it is set when a target is created.

This property supports generator expressions.

Build_rpath_use_origin

Whether to use relative paths for the build RPATH.

This property is initialized by the value of the variable CMAKE_BUILD_RPATH_USE_ORIGIN.

On platforms that support runtime paths (RPATH) with the $ORIGIN token, setting this property to TRUE enables relative paths in the build RPATH for executables and shared libraries that point to shared libraries in the same build tree.

Normally the build RPATH of a binary contains absolute paths to the directory of each shared library it links to.  The RPATH entries for directories contained within the build tree can be made relative to enable relocatable builds and to help achieve reproducible builds by omitting the build directory from the build environment.

This property has no effect on platforms that do not support the $ORIGIN token in RPATH, or when the CMAKE_SKIP_RPATH variable is set. The runtime path set through the Build_rpath target property is also unaffected by this property.

Build_with_install_name_dir

BUILD_WITH_INSTALL_NAME_DIR is a boolean specifying whether the macOS install_name of a target in the build tree uses the directory given by Install_name_dir.  This setting only applies to targets on macOS.

This property is initialized by the value of the variable CMAKE_BUILD_WITH_INSTALL_NAME_DIR if it is set when a target is created.

If this property is not set and policy CMP0068 is not NEW, the value of Build_with_install_rpath is used in its place.

Build_with_install_rpath

BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the target in the build tree with the Install_rpath.  This takes precedence over Skip_build_rpath and avoids the need for relinking before installation.

This property is initialized by the value of the CMAKE_BUILD_WITH_INSTALL_RPATH variable if it is set when a target is created.

If policy CMP0068 is not NEW, this property also controls use of Install_name_dir in the build tree on macOS.  Either way, the Build_with_install_name_dir target property takes precedence.

Bundle_extension

The file extension used to name a Bundle, a Framework, or a Macosx_bundle target on the macOS and iOS.

The default value is bundle, framework, or app for the respective target types.

Bundle

This target is a CFBundle on the macOS.

If a module library target has this property set to true it will be built as a CFBundle when built on the mac.  It will have the directory structure required for a CFBundle and will be suitable to be used for creating Browser Plugins or other application resources.

C_extensions

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used.  For some compilers, this results in adding a flag such as -std=gnu11 instead of -std=c11 to the compile line.  This property is ON by default. The basic C standard level is controlled by the C_standard target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_EXTENSIONS variable if it is set when a target is created.

C_standard

The C standard whose features are requested to build this target.

This property specifies the C standard whose features are requested to build this target.  For some compilers, this results in adding a flag such as -std=gnu11 to the compile line.  For compilers that have no notion of a standard level, such as Microsoft Visual C++ before 2015 Update 3, this has no effect.

Supported values are 90, 99 and 11.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead.  This means that using:

set_property(TARGET tgt PROPERTY C_STANDARD 11)

with a compiler which does not support -std=gnu11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu99 or -std=gnu90 flag if supported.  This “decay” behavior may be controlled with the C_standard_required target property. Additionally, the C_extensions target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_STANDARD variable if it is set when a target is created.

C_standard_required

Boolean describing whether the value of C_standard is a requirement.

If this property is set to ON, then the value of the C_standard target property is treated as a requirement.  If this property is OFF or unset, the C_standard target property is treated as optional and may “decay” to a previous standard if the requested is not available.  For compilers that have no notion of a standard level, such as MSVC, this has no effect.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_STANDARD_REQUIRED variable if it is set when a target is created.

Common_language_runtime

By setting this target property, the target is configured to build with C++/CLI support.

The Visual Studio generator defines the clr parameter depending on the value of COMMON_LANGUAGE_RUNTIME:

  • property not set: native C++ (i.e. default)
  • property set but empty: mixed unmanaged/managed C++
  • property set to any non empty value: managed C++

Supported values: "", "pure", "safe"

This property is only evaluated Visual Studio Generators for VS 2010 and above.

To be able to build managed C++ targets with VS 2017 and above the component C++/CLI support must be installed, which may not be done by default.

See also Imported_common_language_runtime

Compatible_interface_bool

Properties which must be compatible with their link interface

The COMPATIBLE_INTERFACE_BOOL property may contain a list of properties for this target which must be consistent when evaluated as a boolean with the INTERFACE variant of the property in all linked dependees.  For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies must be consistent with each other, and with the FOO property in the depender.

Consistency in this sense has the meaning that if the property is set, then it must have the same boolean value as all others, and if the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

Compatible_interface_number_max

Properties whose maximum value from the link interface will be used.

The COMPATIBLE_INTERFACE_NUMBER_MAX property may contain a list of properties for this target whose maximum value may be read at generate time when evaluated in the INTERFACE variant of the property in all linked dependees.  For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies will be compared with each other and with the FOO property in the depender.  When reading the FOO property at generate time, the maximum value will be returned. If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

Compatible_interface_number_min

Properties whose maximum value from the link interface will be used.

The COMPATIBLE_INTERFACE_NUMBER_MIN property may contain a list of properties for this target whose minimum value may be read at generate time when evaluated in the INTERFACE variant of the property of all linked dependees.  For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies will be compared with each other and with the FOO property in the depender. When reading the FOO property at generate time, the minimum value will be returned.  If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

Compatible_interface_string

Properties which must be string-compatible with their link interface

The COMPATIBLE_INTERFACE_STRING property may contain a list of properties for this target which must be the same when evaluated as a string in the INTERFACE variant of the property all linked dependees. For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies must be equal with each other, and with the FOO property in the depender.  If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

Compile_definitions

Preprocessor definitions for compiling a target’s sources.

The Compile_definitions property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported.  CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values).

CMake will automatically drop some definitions that are not supported by the native build tool.

Disclaimer: Most native build tools have poor support for escaping certain values.  CMake has work-arounds for many cases but some values may just not be possible to pass correctly.  If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value.  Your work-around may break in a future version of CMake that has improved escape support.  Instead consider defining the macro in a (configured) header file.  Then report the limitation.  Known limitations include:

#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows

CMake does not reject these values outright because they do work in some cases.  Use with caution.

Contents of Compile_definitions may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions.  Generator expressions should be preferred instead of setting the alternative property.

Compile_features

Compiler features enabled for this target.

The list of features in this property are a subset of the features listed in the CMAKE_CXX_COMPILE_FEATURES variable.

Contents of COMPILE_FEATURES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

Compile_flags

Additional flags to use when compiling this target’s sources.

The COMPILE_FLAGS property sets additional compiler flags used to build sources within the target.  Use Compile_definitions to pass additional preprocessor definitions.

This property is deprecated.  Use the Compile_options property or the target_compile_options() command instead.

Compile_options

List of options to pass to the compiler.

This property holds a semicolon-separated list of options specified so far for its target.  Use the target_compile_options() command to append more options.

This property is initialized by the Compile_options directory property when a target is created, and is used by the generators to set the options for the compiler.

Contents of Compile_options may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Compile_pdb_name

Output name for the MS debug symbol .pdb file generated by the compiler while building source files.

This property specifies the base name for the debug symbols file. If not set, the default is unspecified.

Note:

The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the Pdb_name property to specify the latter.

Compile_pdb_name_<Config>

Per-configuration output name for the MS debug symbol .pdb file generated by the compiler while building source files.

This is the configuration-specific version of Compile_pdb_name.

Note:

The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_NAME_<CONFIG> property to specify the latter.

Compile_pdb_output_directory

Output directory for the MS debug symbol .pdb file generated by the compiler while building source files.

This property specifies the directory into which the MS debug symbols will be placed by the compiler.  This property is initialized by the value of the CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.

Note:

The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the Pdb_output_directory property to specify the latter.

Compile_pdb_output_directory_<Config>

Per-configuration output directory for the MS debug symbol .pdb file generated by the compiler while building source files.

This is a per-configuration version of Compile_pdb_output_directory, but multi-configuration generators (Visual Studio, Xcode) do NOT append a per-configuration subdirectory to the specified directory.  This property is initialized by the value of the CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Note:

The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_OUTPUT_DIRECTORY_<CONFIG> property to specify the latter.

<Config>_output_name

Old per-configuration target file base name. Use OUTPUT_NAME_<CONFIG> instead.

This is a configuration-specific version of the Output_name target property.

<Config>_postfix

Postfix to append to the target file name for configuration <CONFIG>.

When building with configuration <CONFIG> the value of this property is appended to the target file name built on disk.  For non-executable targets, this property is initialized by the value of the variable CMAKE_<CONFIG>_POSTFIX if it is set when a target is created.  This property is ignored on the Mac for Frameworks and App Bundles.

Crosscompiling_emulator

Use the given emulator to run executables created when crosscompiling. This command will be added as a prefix to add_test(), add_custom_command(), and add_custom_target() commands for built target system executables.

If this property contains a semicolon-separated list, then the first value is the command and remaining values are its arguments.

This property is initialized by the value of the CMAKE_CROSSCOMPILING_EMULATOR variable if it is set when a target is created.

Cuda_ptx_compilation

Compile CUDA sources to .ptx files instead of .obj files within Object Libraries.

For example:

add_library(myptx OBJECT a.cu b.cu)
set_property(TARGET myptx PROPERTY CUDA_PTX_COMPILATION ON)

Cuda_separable_compilation

CUDA only: Enables separate compilation of device code

If set this will enable separable compilation for all CUDA files for the given target.

For instance:

set_property(TARGET myexe PROPERTY CUDA_SEPARABLE_COMPILATION ON)

This property is initialized by the value of the CMAKE_CUDA_SEPARABLE_COMPILATION variable if it is set when a target is created.

Cuda_resolve_device_symbols

CUDA only: Enables device linking for the specific library target where required.

If set, this will tell the required compilers to enable device linking on the library target. Device linking is an additional link step required by some CUDA compilers when Cuda_separable_compilation is enabled. Normally device linking is deferred until a shared library or executable is generated, allowing for multiple static libraries to resolve device symbols at the same time when they are used by a shared library or executable.

By default static library targets have this property is disabled, while shared, module, and executable targets have this property enabled.

Note that device linking is not supported for Object Libraries.

For instance:

set_property(TARGET mystaticlib PROPERTY CUDA_RESOLVE_DEVICE_SYMBOLS ON)

Cuda_extensions

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used.  For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line.  This property is ON by default. The basic CUDA/C++ standard level is controlled by the Cuda_standard target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CUDA_EXTENSIONS variable if it is set when a target is created.

Cuda_standard

The CUDA/C++ standard whose features are requested to build this target.

This property specifies the CUDA/C++ standard whose features are requested to build this target.  For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line.

Supported values are 98, 11, 14.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead.  This means that using:

set_property(TARGET tgt PROPERTY CUDA_STANDARD 11)

with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported.  This “decay” behavior may be controlled with the Cuda_standard_required target property. Additionally, the Cuda_extensions target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CUDA_STANDARD variable if it is set when a target is created.

Cuda_standard_required

Boolean describing whether the value of Cuda_standard is a requirement.

If this property is set to ON, then the value of the Cuda_standard target property is treated as a requirement.  If this property is OFF or unset, the Cuda_standard target property is treated as optional and may “decay” to a previous standard if the requested is not available.  For compilers that have no notion of a standard level, such as MSVC, this has no effect.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CUDA_STANDARD_REQUIRED variable if it is set when a target is created.

Cxx_extensions

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used.  For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line.  This property is ON by default. The basic C++ standard level is controlled by the Cxx_standard target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_EXTENSIONS variable if it is set when a target is created.

Cxx_standard

The C++ standard whose features are requested to build this target.

This property specifies the C++ standard whose features are requested to build this target.  For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line.  For compilers that have no notion of a standard level, such as Microsoft Visual C++ before 2015 Update 3, this has no effect.

Supported values are 98, 11, 14, 17, and 20.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead.  This means that using:

set_property(TARGET tgt PROPERTY CXX_STANDARD 11)

with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported.  This “decay” behavior may be controlled with the Cxx_standard_required target property. Additionally, the Cxx_extensions target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_STANDARD variable if it is set when a target is created.

Cxx_standard_required

Boolean describing whether the value of Cxx_standard is a requirement.

If this property is set to ON, then the value of the Cxx_standard target property is treated as a requirement.  If this property is OFF or unset, the Cxx_standard target property is treated as optional and may “decay” to a previous standard if the requested is not available.  For compilers that have no notion of a standard level, such as MSVC, this has no effect.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_STANDARD_REQUIRED variable if it is set when a target is created.

Debug_postfix

See target property <CONFIG>_POSTFIX.

This property is a special case of the more-general <CONFIG>_POSTFIX property for the DEBUG configuration.

Define_symbol

Define a symbol when compiling this target’s sources.

DEFINE_SYMBOL sets the name of the preprocessor symbol defined when compiling sources in a shared library.  If not set here then it is set to target_EXPORTS by default (with some substitutions if the target is not a valid C identifier).  This is useful for headers to know whether they are being included from inside their library or outside to properly setup dllexport/dllimport decorations.

Deployment_remote_directory

Set the WinCE project RemoteDirectory in DeploymentTool and RemoteExecutable in DebuggerTool in .vcproj files generated by the Visual Studio 9 2008 generator. This is useful when you want to debug on remote WinCE device. For example:

set_property(TARGET ${TARGET} PROPERTY
  DEPLOYMENT_REMOTE_DIRECTORY "\\FlashStorage")

produces:

<DeploymentTool RemoteDirectory="\FlashStorage" ... />
<DebuggerTool RemoteExecutable="\FlashStorage\target_file" ... />

Deployment_additional_files

Set the WinCE project AdditionalFiles in DeploymentTool in .vcproj files generated by the Visual Studio 9 2008 generator. This is useful when you want to debug on remote WinCE device. Specify additional files that will be copied to the device. For example:

set_property(TARGET ${TARGET} PROPERTY
  DEPLOYMENT_ADDITIONAL_FILES "english.lng|local_folder|remote_folder|0"
  "german.lng|local_folder|remote_folder|0")

produces:

<DeploymentTool AdditionalFiles="english.lng|local_folder|remote_folder|0;german.lng|local_folder|remote_folder|0" ... />

Disable_precompile_headers

Disables the precompilation of header files specified by Precompile_headers property.

If the property is not set, CMake will use the value provided by CMAKE_DISABLE_PRECOMPILE_HEADERS.

Dotnet_target_framework_version

Specify the .NET target framework version.

Used to specify the .NET target framework version for C++/CLI.  For example: v4.5.

This property is only evaluated for Visual Studio Generators VS 2010 and above.

Can be initialized for all targets using the variable CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.

EchoString

A message to be displayed when the target is built.

A message to display on some generators (such as Makefile Generators) when the target is built.

Enable_exports

Specify whether an executable exports symbols for loadable modules.

Normally an executable does not export any symbols because it is the final program.  It is possible for an executable to export symbols to be used by loadable modules.  When this property is set to true CMake will allow other targets to “link” to the executable with the target_link_libraries() command.  On all platforms a target-level dependency on the executable is created for targets that link to it. Handling of the executable on the link lines of the loadable modules varies by platform:

  • On Windows-based systems (including Cygwin) an “import library” is created along with the executable to list the exported symbols. Loadable modules link to the import library to get the symbols.
  • On macOS, loadable modules link to the executable itself using the -bundle_loader flag.
  • On AIX, a linker “import file” is created along with the executable to list the exported symbols for import when linking other targets. Loadable modules link to the import file to get the symbols.
  • On other platforms, loadable modules are simply linked without referencing the executable since the dynamic loader will automatically bind symbols when the module is loaded.

This property is initialized by the value of the variable CMAKE_ENABLE_EXPORTS if it is set when a target is created.

Exclude_from_all

Set this target property to a true (or false) value to exclude (or include) the target from the “all” target of the containing directory and its ancestors.  If excluded, running e.g. make in the containing directory or its ancestors will not build the target by default.

If this target property is not set then the target will be included in the “all” target of the containing directory.  Furthermore, it will be included in the “all” target of its ancestor directories unless the Exclude_from_all directory property is set.

With Exclude_from_all set to false or not set at all, the target will be brought up to date as part of doing a make install or its equivalent for the CMake generator being used.  If a target has Exclude_from_all set to true, then any attempt to install that target has undefined behavior.  Note that such a target can still safely be listed in an install(TARGETS) command as long as the install components the target belongs to are not part of the set of components that anything tries to install.

Exclude_from_default_build_<Config>

Per-configuration version of target exclusion from Build Solution.

This is the configuration-specific version of Exclude_from_default_build.  If the generic Exclude_from_default_build is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes precedence in configurations for which it has a value.

Exclude_from_default_build

Exclude target from Build Solution.

This property is only used by Visual Studio generators. When set to TRUE, the target will not be built when you press Build Solution.

Export_name

Exported name for target files.

This sets the name for the Imported target generated by the install(EXPORT) and export() commands. If not set, the logical target name is used by default.

Export_properties

List additional properties to export for a target.

This property contains a list of property names that should be exported by the install(EXPORT) and export() commands.  By default only a limited number of properties are exported. This property can be used to additionally export other properties as well.

Properties starting with INTERFACE_ or IMPORTED_ are not allowed as they are reserved for internal CMake use.

Properties containing generator expressions are also not allowed.

Folder

Set the folder name. Use to organize targets in an IDE.

Targets with no FOLDER property will appear as top level entities in IDEs like Visual Studio.  Targets with the same FOLDER property value will appear next to each other in a folder of that name.  To nest folders, use FOLDER values such as ‘GUI/Dialogs’ with ‘/’ characters separating folder levels.

This property is initialized by the value of the variable CMAKE_FOLDER if it is set when a target is created.

Fortran_FORMAT

Set to FIXED or FREE to indicate the Fortran source layout.

This property tells CMake whether the Fortran source files in a target use fixed-format or free-format.  CMake will pass the corresponding format flag to the compiler.  Use the source-specific Fortran_FORMAT property to change the format of a specific source file.  If the variable CMAKE_Fortran_FORMAT is set when a target is created its value is used to initialize this property.

Fortran_MODULE_DIRECTORY

Specify output directory for Fortran modules provided by the target.

If the target contains Fortran source files that provide modules and the compiler supports a module output directory this specifies the directory in which the modules will be placed.  When this property is not set the modules will be placed in the build directory corresponding to the target’s source directory.  If the variable CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its value is used to initialize this property.

Note that some compilers will automatically search the module output directory for modules USEd during compilation but others will not.  If your sources USE modules their location must be specified by Include_directories regardless of this property.

Framework

Build SHARED or STATIC library as Framework Bundle on the macOS and iOS.

If such a library target has this property set to TRUE it will be built as a framework when built on the macOS and iOS.  It will have the directory structure required for a framework and will be suitable to be used with the -framework option.  This property is initialized by the value of the CMAKE_FRAMEWORK variable if it is set when a target is created.

To customize Info.plist file in the framework, use Macosx_framework_info_plist target property.

For macOS see also the Framework_version target property.

Example of creation dynamicFramework:

add_library(dynamicFramework SHARED
            dynamicFramework.c
            dynamicFramework.h
)
set_target_properties(dynamicFramework PROPERTIES
  FRAMEWORK TRUE
  FRAMEWORK_VERSION C
  MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework
  MACOSX_FRAMEWORK_INFO_PLIST Info.plist
  # "current version" in semantic format in Mach-O binary file
  VERSION 16.4.0
  # "compatibility version" in semantic format in Mach-O binary file
  SOVERSION 1.0.0
  PUBLIC_HEADER dynamicFramework.h
  XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer"
)

Framework_version

Version of a framework created using the Framework target property (e.g. A).

This property only affects macOS, as iOS doesn’t have versioned directory structure.

Generator_file_name

Generator’s file for this target.

An internal property used by some generators to record the name of the project or dsp file associated with this target.  Note that at configure time, this property is only set for targets created by include_external_msproject().

Ghs_integrity_app

ON / OFF boolean to determine if an executable target should be treated as an Integrity Application.

If no value is set and if a .int file is added as a source file to the executable target it will be treated as an Integrity Application.

Supported on Green Hills MULTI.

Ghs_no_source_group_file

ON / OFF boolean to control if the project file for a target should be one single file or multiple files.

The default behavior or when the property is OFF is to generate a project file for the target and then a sub-project file for each source group.

When this property is ON or if CMAKE_GHS_NO_SOURCE_GROUP_FILE is ON then only a single project file is generated for the target.

Supported on Green Hills MULTI.

GNUtoMS

Convert GNU import library (.dll.a) to MS format (.lib).

When linking a shared library or executable that exports symbols using GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert the import library (.dll.a) from GNU to MS format (.lib).  Both import libraries will be installed by install(TARGETS) and exported by install(EXPORT) and  export() to be linked by applications with either GNU- or MS-compatible tools.

If the variable CMAKE_GNUtoMS is set when a target is created its value is used to initialize this property.  The variable must be set prior to the first command that enables a language such as project() or enable_language().  CMake provides the variable as an option to the user automatically when configuring on Windows with GNU tools.

Has_cxx

Link the target using the C++ linker tool (obsolete).

This is equivalent to setting the Linker_language property to CXX.

Implicit_depends_include_transform

Specify #include line transforms for dependencies in a target.

This property specifies rules to transform macro-like #include lines during implicit dependency scanning of C and C++ source files.  The list of rules must be semicolon-separated with each entry of the form “A_MACRO(%)=value-with-%” (the % must be literal).  During dependency scanning occurrences of A_MACRO(…) on #include lines will be replaced by the value given with the macro argument substituted for ‘%’.  For example, the entry

MYDIR(%)=<mydir/%>

will convert lines of the form

#include MYDIR(myheader.h)

to

#include <mydir/myheader.h>

allowing the dependency to be followed.

This property applies to sources in the target on which it is set.

Imported_common_language_runtime

Property to define if the target uses C++/CLI.

Ignored for non-imported targets.

See also the Common_language_runtime target property.

Imported_configurations

Configurations provided for an Imported target.

Set this to the list of configuration names available for an Imported target.  The names correspond to configurations defined in the project from which the target is imported.  If the importing project uses a different set of configurations the names may be mapped using the MAP_IMPORTED_CONFIG_<CONFIG> property.  Ignored for non-imported targets.

Imported_global

Indication of whether an Imported target is globally visible.

The boolean value of this property is True for targets created with the Imported GLOBAL options to add_executable() or add_library(). It is always False for targets built within the project.

For targets created with the Imported option to add_executable() or add_library() but without the additional option GLOBAL this is False, too. However, setting this property for such a locally Imported target to True promotes that target to global scope. This promotion can only be done in the same directory where that Imported target was created in the first place.

Once an imported target has been made global, it cannot be changed back to non-global. Therefore, if a project sets this property, it may only provide a value of True. CMake will issue an error if the project tries to set the property to a non-True value, even if the value was already False.

Imported_implib_<Config>

<CONFIG>-specific version of Imported_implib property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_implib

Full path to the import library for an Imported target.

Set this to the location of the .lib part of a Windows DLL, or on AIX set it to an import file created for executables that export symbols (see the Enable_exports target property). Ignored for non-imported targets.

Imported_libname_<Config>

<CONFIG>-specific version of Imported_libname property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_libname

Specify the link library name for an imported Interface Library.

An interface library builds no library file itself but does specify usage requirements for its consumers.  The IMPORTED_LIBNAME property may be set to specify a single library name to be placed on the link line in place of the interface library target name as a requirement for using the interface.

This property is intended for use in naming libraries provided by a platform SDK for which the full path to a library file may not be known.  The value may be a plain library name such as foo but may not be a path (e.g. /usr/lib/libfoo.so) or a flag (e.g. -Wl,...).  The name is never treated as a library target name even if it happens to name one.

The IMPORTED_LIBNAME property is allowed only on imported Interface Libraries and is rejected on targets of other types (for which the Imported_location target property may be used).

Imported_location_<Config>

<CONFIG>-specific version of Imported_location property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_location

Full path to the main file on disk for an Imported target.

Set this to the location of an Imported target file on disk.  For executables this is the location of the executable file.  For bundles on macOS this is the location of the executable file inside Contents/MacOS under the application bundle folder.  For STATIC libraries and modules this is the location of the library or module. For SHARED libraries on non-DLL platforms this is the location of the shared library.  For frameworks on macOS this is the location of the library file symlink just inside the framework folder.  For DLLs this is the location of the .dll part of the library.  For UNKNOWN libraries this is the location of the file to be linked.  Ignored for non-imported targets.

The IMPORTED_LOCATION target property may be overridden for a given configuration <CONFIG> by the configuration-specific IMPORTED_LOCATION_<CONFIG> target property.  Furthermore, the MAP_IMPORTED_CONFIG_<CONFIG> target property may be used to map between a project’s configurations and those of an imported target.  If none of these is set then the name of any other configuration listed in the Imported_configurations target property may be selected and its IMPORTED_LOCATION_<CONFIG> value used.

To get the location of an imported target read one of the Location or LOCATION_<CONFIG> properties.

For platforms with import libraries (e.g. Windows) see also Imported_implib.

Imported_no_soname_<Config>

<CONFIG>-specific version of Imported_no_soname property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_no_soname

Specifies that an Imported shared library target has no soname.

Set this property to true for an imported shared library file that has no soname field.  CMake may adjust generated link commands for some platforms to prevent the linker from using the path to the library in place of its missing soname.  Ignored for non-imported targets.

Imported_objects_<Config>

<CONFIG>-specific version of Imported_objects property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_objects

A semicolon-separated list of absolute paths to the object files on disk for an imported object library.

Ignored for non-imported targets.

Projects may skip IMPORTED_OBJECTS if the configuration-specific property IMPORTED_OBJECTS_<CONFIG> is set instead.

Imported

Read-only indication of whether a target is IMPORTED.

The boolean value of this property is True for targets created with the IMPORTED option to add_executable() or add_library(). It is False for targets built within the project.

Imported_soname_<Config>

<CONFIG>-specific version of Imported_soname property.

Configuration names correspond to those provided by the project from which the target is imported.

Imported_soname

The soname of an Imported target of shared library type.

Set this to the soname embedded in an imported shared library.  This is meaningful only on platforms supporting the feature.  Ignored for non-imported targets.

Import_prefix

What comes before the import library name.

Similar to the target property Prefix, but used for import libraries (typically corresponding to a DLL) instead of regular libraries.  A target property that can be set to override the prefix (such as lib) on an import library name.

Import_suffix

What comes after the import library name.

Similar to the target property Suffix, but used for import libraries (typically corresponding to a DLL) instead of regular libraries.  A target property that can be set to override the suffix (such as .lib) on an import library name.

Include_directories

List of preprocessor include file search directories.

This property specifies the list of directories given so far to the target_include_directories() command.  In addition to accepting values from that command, values may be set directly on any target using the set_property() command.  A target gets its initial value for this property from the value of the Include_directories directory property.  Both directory and target property values are adjusted by calls to the include_directories() command.

The value of this property is used by the generators to set the include paths for the compiler.

Relative paths should not be added to this property directly. Use one of the commands above instead to handle relative paths.

Contents of Include_directories may use cmake-generator-expressions(7) with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Install_name_dir

macOS directory name for installed targets.

INSTALL_NAME_DIR is a string specifying the directory portion of the “install_name” field of shared libraries on macOS to use in the installed targets.

This property is initialized by the value of the variable CMAKE_INSTALL_NAME_DIR if it is set when a target is created.

Install_remove_environment_rpath

Controls whether toolchain-defined rpaths should be removed during installation.

When a target is being installed, CMake may need to rewrite its rpath information.  This occurs when the install rpath (as specified by the Install_rpath target property) has different contents to the rpath that the target was built with.  Some toolchains insert their own rpath contents into the binary as part of the build.  By default, CMake will preserve those extra inserted contents in the install rpath.  For those scenarios where such toolchain-inserted entries need to be discarded during install, set the INSTALL_REMOVE_ENVIRONMENT_RPATH target property to true.

This property is initialized by the value of CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH when the target is created.

Install_rpath

The rpath to use for installed targets.

A semicolon-separated list specifying the rpath to use in installed targets (for platforms that support it).  This property is initialized by the value of the variable CMAKE_INSTALL_RPATH if it is set when a target is created.

This property supports generator expressions.

Interface_autouic_options

List of interface options to pass to uic.

Targets may populate this property to publish the options required to use when invoking uic.  Consuming targets can add entries to their own Autouic_options property such as $<TARGET_PROPERTY:foo,INTERFACE_AUTOUIC_OPTIONS> to use the uic options specified in the interface of foo. This is done automatically by the target_link_libraries() command.

This property supports generator expressions.  See the cmake-generator-expressions(7) manual for available expressions.

Interface_compile_definitions

List of public compile definitions requirements for a library.

Targets may populate this property to publish the compile definitions required to compile against the headers for the target.  The target_compile_definitions() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

Interface_compile_features

List of public compile features requirements for a library.

Targets may populate this property to publish the compile features required to compile against the headers for the target.  The target_compile_features() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_FEATURES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

Interface_compile_options

List of public compile options requirements for a library.

Targets may populate this property to publish the compile options required to compile against the headers for the target.  The target_compile_options() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

Interface_include_directories

List of public include directories requirements for a library.

Targets may populate this property to publish the include directories required to compile against the headers for the target.  The target_include_directories() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

Include directories usage requirements commonly differ between the build-tree and the install-tree.  The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions can be used to describe separate usage requirements based on the usage location.  Relative paths are allowed within the INSTALL_INTERFACE expression and are interpreted relative to the installation prefix.  For example:

target_include_directories(mylib INTERFACE
  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>
  $<INSTALL_INTERFACE:include/mylib>  # <prefix>/include/mylib
)

Creating Relocatable Packages

Note that it is not advisable to populate the INSTALL_INTERFACE of the Interface_include_directories of a target with absolute paths to the include directories of dependencies.  That would hard-code into installed packages the include directory paths for dependencies as found on the machine the package was made on.

The INSTALL_INTERFACE of the Interface_include_directories is only suitable for specifying the required include directories for headers provided with the target itself, not those provided by the transitive dependencies listed in its Interface_link_libraries target property.  Those dependencies should themselves be targets that specify their own header locations in Interface_include_directories.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

Creating Relocatable Packages

Note that it is not advisable to populate the Interface_link_libraries of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

Interface_precompile_headers

List of interface header files to precompile into consuming targets.

Targets may populate this property to publish the header files for consuming targets to precompile.  The target_precompile_headers() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly. See the discussion in target_precompile_headers() for guidance on appropriate use of this property for installed or exported targets.

Contents of INTERFACE_PRECOMPILE_HEADERS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Interface_position_independent_code

Whether consumers need to create a position-independent target

The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of this target whether they must set their Position_independent_code property to ON.  If this property is set to ON, then the Position_independent_code property on  all consumers will be set to ON. Similarly, if this property is set to OFF, then the Position_independent_code property on all consumers will be set to OFF.  If this property is undefined, then consumers will determine their Position_independent_code property by other means.  Consumers must ensure that the targets that they link to have a consistent requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property.

Contents of INTERFACE_POSITION_INDEPENDENT_CODE may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Interface_sources

List of interface sources to compile into consuming targets.

Targets may populate this property to publish the sources for consuming targets to compile.  The target_sources() command populates this property with values given to the PUBLIC and INTERFACE keywords.  Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the sources of the consumer.

Contents of INTERFACE_SOURCES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Interface_system_include_directories

List of public system include directories for a library.

Targets may populate this property to publish the include directories which contain system headers, and therefore should not result in compiler warnings.  The target_include_directories(SYSTEM) command signature populates this property with values given to the PUBLIC and INTERFACE keywords.

Projects may also get and set the property directly, but must be aware that adding directories to this property does not make those directories used during compilation.  Adding directories to this property marks directories as SYSTEM which otherwise would be used in a non-SYSTEM manner.  This can appear similar to ‘duplication’, so prefer the high-level target_include_directories(SYSTEM) command and avoid setting the property by low-level means.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to mark the same include directories as containing system headers.

Contents of INTERFACE_SYSTEM_INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Interprocedural_optimization_<Config>

Per-configuration interprocedural optimization for a target.

This is a per-configuration version of Interprocedural_optimization. If set, this property overrides the generic property for the named configuration.

This property is initialized by the CMAKE_INTERPROCEDURAL_OPTIMIZATION_<CONFIG> variable if it is set when a target is created.

Interprocedural_optimization

Enable interprocedural optimization for a target.

If set to true, enables interprocedural optimizations if they are known to be supported by the compiler. Depending on value of policy CMP0069, the error will be reported or ignored, if interprocedural optimization is enabled but not supported.

This property is initialized by the CMAKE_INTERPROCEDURAL_OPTIMIZATION variable if it is set when a target is created.

Ios_install_combined

Build a combined (device and simulator) target when installing.

When this property is set to set to false (which is the default) then it will either be built with the device SDK or the simulator SDK depending on the SDK set. But if this property is set to true then the target will at install time also be built for the corresponding SDK and combined into one library.

This feature requires at least Xcode version 6.

Job_pool_compile

Ninja only: Pool used for compiling.

The number of parallel compile processes could be limited by defining pools with the global Job_pools property and then specifying here the pool name.

For instance:

set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs)

This property is initialized by the value of CMAKE_JOB_POOL_COMPILE.

Labels

Specify a list of text labels associated with a target.

Target label semantics are currently unspecified.

<Lang>_clang_tidy

This property is implemented only when <LANG> is C or CXX.

Specify a semicolon-separated list containing a command line for the clang-tidy tool.  The Makefile Generators and the Ninja generator will run this tool along with the compiler and report a warning if the tool reports any problems.

This property is initialized by the value of the CMAKE_<LANG>_CLANG_TIDY variable if it is set when a target is created.

<Lang>_compiler_launcher

This property is implemented only when <LANG> is C, CXX, Fortran, or CUDA.

Specify a semicolon-separated list containing a command line for a compiler launching tool. The Makefile Generators and the Ninja generator will run this tool and pass the compiler and its arguments to the tool. Some example tools are distcc and ccache.

This property is initialized by the value of the CMAKE_<LANG>_COMPILER_LAUNCHER variable if it is set when a target is created.

<Lang>_cppcheck

This property is supported only when <LANG> is C or CXX.

Specify a semicolon-separated list containing a command line for the cppcheck static analysis tool.  The Makefile Generators and the Ninja generator will run cppcheck along with the compiler and report any problems.  If the command-line specifies the exit code options to cppcheck then the build  will fail if the tool returns non-zero.

This property is initialized by the value of the CMAKE_<LANG>_CPPCHECK variable if it is set when a target is created.

<Lang>_cpplint

This property is supported only when <LANG> is C or CXX.

Specify a semicolon-separated list containing a command line for the cpplint style checker.  The Makefile Generators and the Ninja generator will run cpplint along with the compiler and report any problems.

This property is initialized by the value of the CMAKE_<LANG>_CPPLINT variable if it is set when a target is created.

<Lang>_include_what_you_use

This property is implemented only when <LANG> is C or CXX.

Specify a semicolon-separated list containing a command line for the include-what-you-use tool.  The Makefile Generators and the Ninja generator will run this tool along with the compiler and report a warning if the tool reports any problems.

This property is initialized by the value of the CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE variable if it is set when a target is created.

<Lang>_visibility_preset

Value for symbol visibility compile flags

The <LANG>_VISIBILITY_PRESET property determines the value passed in a visibility related compile option, such as -fvisibility= for <LANG>. This property affects compilation in sources of all types of targets (subject to policy CMP0063).

This property is initialized by the value of the CMAKE_<LANG>_VISIBILITY_PRESET variable if it is set when a target is created.

Library_output_directory_<Config>

Per-configuration output directory for LIBRARY target files.

This is a per-configuration version of the Library_output_directory target property, but multi-configuration generators (Visual Studio Generators, Xcode) do NOT append a per-configuration subdirectory to the specified directory.  This property is initialized by the value of the CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of LIBRARY_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

Library_output_directory

Output directory in which to build LIBRARY target files.

This property specifies the directory into which library target files should be built.  The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created.

See also the LIBRARY_OUTPUT_DIRECTORY_<CONFIG> target property.

Library_output_name_<Config>

Per-configuration output name for LIBRARY target files.

This is the configuration-specific version of the Library_output_name target property.

Library_output_name

Output name for LIBRARY target files.

This property specifies the base name for library target files.  It overrides Output_name and OUTPUT_NAME_<CONFIG> properties.

See also the LIBRARY_OUTPUT_NAME_<CONFIG> target property.

Linker_language

Specifies language whose compiler will invoke the linker.

For executables, shared libraries, and modules, this sets the language whose compiler is used to link the target (such as “C” or “CXX”).  A typical value for an executable is the language of the source file providing the program entry point (main).  If not set, the language with the highest linker preference value is the default.  See documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables.

If this property is not set by the user, it will be calculated at generate-time by CMake.

Creating Relocatable Packages

Note that it is not advisable to populate the LINK_INTERFACE_LIBRARIES_<CONFIG> of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

Creating Relocatable Packages

Note that it is not advisable to populate the Link_interface_libraries of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

Location_<Config>

Read-only property providing a target location on disk.

A read-only property that indicates where a target’s main file is located on disk for the configuration <CONFIG>.  The property is defined only for library and executable targets.  An imported target may provide a set of configurations different from that of the importing project.  By default CMake looks for an exact-match but otherwise uses an arbitrary available configuration.  Use the MAP_IMPORTED_CONFIG_<CONFIG> property to map imported configurations explicitly.

Do not set properties that affect the location of a target after reading this property.  These include properties whose names match (RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(Name|DIRECTORY)(_<CONFIG>)?, (IMPLIB_)?(Prefix|Suffix), or  Linker_language. Failure to follow this rule is not diagnosed and leaves the location of the target undefined.

Location

Read-only location of a target on disk.

For an imported target, this read-only property returns the value of the LOCATION_<CONFIG> property for an unspecified configuration <CONFIG> provided by the target.

For a non-imported target, this property is provided for compatibility with CMake 2.4 and below.  It was meant to get the location of an executable target’s output file for use in add_custom_command().  The path may contain a build-system-specific portion that is replaced at build time with the configuration getting built (such as $(ConfigurationName) in VS).  In CMake 2.6 and above add_custom_command() automatically recognizes a target name in its COMMAND and Depends options and computes the target location.  In CMake 2.8.4 and above add_custom_command() recognizes generator expressions to refer to target locations anywhere in the command. Therefore this property is not needed for creating custom commands.

Do not set properties that affect the location of a target after reading this property.  These include properties whose names match (RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(Name|DIRECTORY)(_<CONFIG>)?, (IMPLIB_)?(Prefix|Suffix), or “Linker_language”.  Failure to follow this rule is not diagnosed and leaves the location of the target undefined.

Macosx_bundle_info_plist

Specify a custom Info.plist template for a macOS and iOS Application Bundle.

An executable target with Macosx_bundle enabled will be built as an application bundle on macOS.  By default its Info.plist file is created by configuring a template called MacOSXBundleInfo.plist.in located in the CMAKE_MODULE_PATH.  This property specifies an alternative template file name which may be a full path.

The following target properties may be set to specify content to be configured into the file:

MACOSX_BUNDLE_BUNDLE_NAME

Sets CFBundleName.

MACOSX_BUNDLE_BUNDLE_VERSION

Sets CFBundleVersion.

MACOSX_BUNDLE_COPYRIGHT

Sets NSHumanReadableCopyright.

MACOSX_BUNDLE_GUI_IDENTIFIER

Sets CFBundleIdentifier.

MACOSX_BUNDLE_ICON_FILE

Sets CFBundleIconFile.

MACOSX_BUNDLE_INFO_STRING

Sets CFBundleGetInfoString.

MACOSX_BUNDLE_LONG_VERSION_STRING

Sets CFBundleLongVersionString.

MACOSX_BUNDLE_SHORT_VERSION_STRING

Sets CFBundleShortVersionString.

CMake variables of the same name may be set to affect all targets in a directory that do not have each specific property set.  If a custom Info.plist is specified by this property it may of course hard-code all the settings instead of using the target properties.

Macosx_bundle

Build an executable as an Application Bundle on macOS or iOS.

When this property is set to TRUE the executable when built on macOS or iOS will be created as an application bundle.  This makes it a GUI executable that can be launched from the Finder.  See the Macosx_bundle_info_plist target property for information about creation of the Info.plist file for the application bundle. This property is initialized by the value of the variable CMAKE_MACOSX_BUNDLE if it is set when a target is created.

Macosx_framework_info_plist

Specify a custom Info.plist template for a macOS and iOS Framework.

A library target with Framework enabled will be built as a framework on macOS.  By default its Info.plist file is created by configuring a template called MacOSXFrameworkInfo.plist.in located in the CMAKE_MODULE_PATH.  This property specifies an alternative template file name which may be a full path.

The following target properties may be set to specify content to be configured into the file:

MACOSX_FRAMEWORK_BUNDLE_VERSION

Sets CFBundleVersion.

MACOSX_FRAMEWORK_ICON_FILE

Sets CFBundleIconFile.

MACOSX_FRAMEWORK_IDENTIFIER

Sets CFBundleIdentifier.

MACOSX_FRAMEWORK_SHORT_VERSION_STRING

Sets CFBundleShortVersionString.

CMake variables of the same name may be set to affect all targets in a directory that do not have each specific property set.  If a custom Info.plist is specified by this property it may of course hard-code all the settings instead of using the target properties.

Macosx_rpath

Whether this target on macOS or iOS is located at runtime using rpaths.

When this property is set to TRUE, the directory portion of the install_name field of this shared library will be @rpath unless overridden by Install_name_dir.  This indicates the shared library is to be found at runtime using runtime paths (rpaths).

This property is initialized by the value of the variable CMAKE_MACOSX_RPATH if it is set when a target is created.

Runtime paths will also be embedded in binaries using this target and can be controlled by the Install_rpath target property on the target linking to this target.

Policy CMP0042 was introduced to change the default value of MACOSX_RPATH to TRUE.  This is because use of @rpath is a more flexible and powerful alternative to @executable_path and @loader_path.

Manually_added_dependencies

Get manually added dependencies to other top-level targets.

This read-only property can be used to query all dependencies that were added for this target with the add_dependencies() command.

Map_imported_config_<Config>

Map from project configuration to imported target’s configuration.

Set this to the list of configurations of an imported target that may be used for the current project’s <CONFIG> configuration.  Targets imported from another project may not provide the same set of configuration names available in the current project.  Setting this property tells CMake what imported configurations are suitable for use when building the <CONFIG> configuration.  The first configuration in the list found to be provided by the imported target (i.e. via IMPORTED_LOCATION_<CONFIG> for the mapped-to <CONFIG>) is selected.  As a special case, an empty list element refers to the configuration-less imported target location (i.e. Imported_location).

If this property is set and no matching configurations are available, then the imported target is considered to be not found.  This property is ignored for non-imported targets.

This property is initialized by the value of the CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> variable if it is set when a target is created.

Example

For example creating imported C++ library foo:

add_library(foo STATIC IMPORTED)

Use foo_debug path for Debug build type:

set_property(
  TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG
  )

set_target_properties(foo PROPERTIES
  IMPORTED_LINK_INTERFACE_LANGUAGES_DEBUG "CXX"
  IMPORTED_LOCATION_DEBUG "${foo_debug}"
  )

Use foo_release path for Release build type:

set_property(
  TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS RELEASE
  )

set_target_properties(foo PROPERTIES
  IMPORTED_LINK_INTERFACE_LANGUAGES_RELEASE "CXX"
  IMPORTED_LOCATION_RELEASE "${foo_release}"
  )

Use Release version of library for MinSizeRel and RelWithDebInfo build types:

set_target_properties(foo PROPERTIES
  MAP_IMPORTED_CONFIG_MINSIZEREL Release
  MAP_IMPORTED_CONFIG_RELWITHDEBINFO Release
  )

Msvc_runtime_library

Select the MSVC runtime library for use by compilers targeting the MSVC ABI.

The allowed values are:

MultiThreaded

Compile with -MT or equivalent flag(s) to use a multi-threaded statically-linked runtime library.

MultiThreadedDLL

Compile with -MD or equivalent flag(s) to use a multi-threaded dynamically-linked runtime library.

MultiThreadedDebug

Compile with -MTd or equivalent flag(s) to use a multi-threaded statically-linked runtime library.

MultiThreadedDebugDLL

Compile with -MDd or equivalent flag(s) to use a multi-threaded dynamically-linked runtime library.

The value is ignored on non-MSVC compilers but an unsupported value will be rejected as an error when using a compiler targeting the MSVC ABI.

The value may also be the empty string ("") in which case no runtime library selection flag will be added explicitly by CMake.  Note that with Visual Studio Generators the native build system may choose to add its own default runtime library selection flag.

Use generator expressions to support per-configuration specification.  For example, the code:

add_executable(foo foo.c)
set_property(TARGET foo PROPERTY
  MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")

selects for the target foo a multi-threaded statically-linked runtime library with or without debug information depending on the configuration.

If this property is not set then CMake uses the default value MultiThreaded$<$<CONFIG:Debug>:Debug>DLL to select a MSVC runtime library.

Note:

This property has effect only when policy CMP0091 is set to NEW prior to the first project() or enable_language() command that enables a language using a compiler targeting the MSVC ABI.

Name

Logical name for the target.

Read-only logical name for the target as used by CMake.

No_soname

Whether to set soname when linking a shared library.

Enable this boolean property if a generated SHARED library should not have soname set.  Default is to set soname on all shared libraries as long as the platform supports it. Generally, use this property only for leaf private libraries or plugins.  If you use it on normal shared libraries which other targets link against, on some platforms a linker will insert a full path to the library (as specified at link time) into the dynamic section of the dependent binary.  Therefore, once installed, dynamic loader may eventually fail to locate the library for the binary.

No_system_from_imported

Do not treat include directories from the interfaces of consumed imported targets as SYSTEM.

The contents of the Interface_include_directories target property of imported targets are treated as SYSTEM includes by default.  If this property is enabled on a target, compilation of sources in that target will not treat the contents of the Interface_include_directories of consumed imported targets as system includes.

This property is initialized by the value of the CMAKE_NO_SYSTEM_FROM_IMPORTED variable if it is set when a target is created.

Objc_extensions

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used.  For some compilers, this results in adding a flag such as -std=gnu11 instead of -std=c11 to the compile line.  This property is ON by default. The basic OBJC standard level is controlled by the Objc_standard target property.

If the property is not set, and the project has set the C_extensions, the value of C_extensions is set for OBJC_EXTENSIONS.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_OBJC_EXTENSIONS variable if it is set when a target is created.

Objc_standard

The OBJC standard whose features are requested to build this target.

This property specifies the OBJC standard whose features are requested to build this target.  For some compilers, this results in adding a flag such as -std=gnu11 to the compile line.

Supported values are 90, 99 and 11.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead.  This means that using:

set_property(TARGET tgt PROPERTY OBJC_STANDARD 11)

with a compiler which does not support -std=gnu11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu99 or -std=gnu90 flag if supported.  This “decay” behavior may be controlled with the Objc_standard_required target property. Additionally, the Objc_extensions target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.

If the property is not set, and the project has set the C_standard, the value of C_standard is set for OBJC_STANDARD.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_OBJC_STANDARD variable if it is set when a target is created.

Objc_standard_required

Boolean describing whether the value of Objc_standard is a requirement.

If this property is set to ON, then the value of the Objc_standard target property is treated as a requirement.  If this property is OFF or unset, the Objc_standard target property is treated as optional and may “decay” to a previous standard if the requested is not available.

If the property is not set, and the project has set the C_standard_required, the value of C_standard_required is set for OBJC_STANDARD_REQUIRED.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_OBJC_STANDARD_REQUIRED variable if it is set when a target is created.

Objcxx_extensions

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used.  For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line.  This property is ON by default. The basic ObjC++ standard level is controlled by the Objcxx_standard target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

If the property is not set, and the project has set the Cxx_extensions, the value of Cxx_extensions is set for OBJCXX_EXTENSIONS.

This property is initialized by the value of the CMAKE_OBJCXX_EXTENSIONS variable if it is set when a target is created.

Objcxx_standard

The ObjC++ standard whose features are requested to build this target.

This property specifies the ObjC++ standard whose features are requested to build this target.  For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line.

Supported values are 98, 11, 14, 17, and 20.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead.  This means that using:

set_property(TARGET tgt PROPERTY OBJCXX_STANDARD 11)

with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported.  This “decay” behavior may be controlled with the Objcxx_standard_required target property. Additionally, the Objcxx_extensions target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.

If the property is not set, and the project has set the Cxx_standard, the value of Cxx_standard is set for OBJCXX_STANDARD.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_OBJCXX_STANDARD variable if it is set when a target is created.

Objcxx_standard_required

Boolean describing whether the value of Objcxx_standard is a requirement.

If this property is set to ON, then the value of the Objcxx_standard target property is treated as a requirement.  If this property is OFF or unset, the Objcxx_standard target property is treated as optional and may “decay” to a previous standard if the requested is not available.

If the property is not set, and the project has set the Cxx_standard_required, the value of Cxx_standard_required is set for OBJCXX_STANDARD_REQUIRED.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_OBJCXX_STANDARD_REQUIRED variable if it is set when a target is created.

Osx_architectures_<Config>

Per-configuration macOS and iOS binary architectures for a target.

This property is the configuration-specific version of Osx_architectures.

Osx_architectures

Target specific architectures for macOS.

The OSX_ARCHITECTURES property sets the target binary architecture for targets on macOS (-arch).  This property is initialized by the value of the variable CMAKE_OSX_ARCHITECTURES if it is set when a target is created.  Use OSX_ARCHITECTURES_<CONFIG> to set the binary architectures on a per-configuration basis, where <CONFIG> is an upper-case name (e.g. OSX_ARCHITECTURES_DEBUG).

Output_name_<Config>

Per-configuration target file base name.

This is the configuration-specific version of the Output_name target property.

Output_name

Output name for target files.

This sets the base name for output files created for an executable or library target.  If not set, the logical target name is used by default during generation. The value is not set by default during configuration.

Contents of OUTPUT_NAME and the variants listed below may use generator expressions.

See also the variants:

Pdb_name_<Config>

Per-configuration output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This is the configuration-specific version of Pdb_name.

Note:

This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_NAME_<CONFIG> property to specify the latter.

Pdb_name

Output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This property specifies the base name for the debug symbols file. If not set, the Output_name target property value or logical target name is used by default.

Note:

This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the Compile_pdb_name property to specify the latter.

Pdb_output_directory_<Config>

Per-configuration output directory for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This is a per-configuration version of Pdb_output_directory, but multi-configuration generators (Visual Studio Generators, Xcode) do NOT append a per-configuration subdirectory to the specified directory.  This property is initialized by the value of the CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of PDB_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

Note:

This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> property to specify the latter.

Pdb_output_directory

Output directory for the MS debug symbols .pdb file generated by the linker for an executable or shared library target.

This property specifies the directory into which the MS debug symbols will be placed by the linker. The property value may use generator expressions. Multi-configuration generators append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the CMAKE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.

Note:

This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the Compile_pdb_output_directory property to specify the latter.

Position_independent_code

Whether to create a position-independent target

The POSITION_INDEPENDENT_CODE property determines whether position independent executables or shared libraries will be created.  This property is True by default for SHARED and MODULE library targets and False otherwise.  This property is initialized by the value of the CMAKE_POSITION_INDEPENDENT_CODE variable  if it is set when a target is created.

Note:

For executable targets, the link step is controlled by the CMP0083 policy and the CheckPIESupported module.

Precompile_headers

List of header files to precompile.

This property holds a semicolon-separated list of header files to precompile specified so far for its target. Use the target_precompile_headers() command to append more header files.

This property supports generator expressions.

Precompile_headers_reuse_from

Target from which to reuse the precompiled headers build artifact.

See the second signature of target_precompile_headers() command for more detailed information.

Prefix

What comes before the library name.

A target property that can be set to override the prefix (such as lib) on a library name.

Private_header

Specify private header files in a Framework shared library target.

Shared library targets marked with the Framework property generate frameworks on macOS, iOS and normal shared libraries on other platforms. This property may be set to a list of header files to be placed in the PrivateHeaders directory inside the framework folder.  On non-Apple platforms these headers may be installed using the PRIVATE_HEADER option to the install(TARGETS) command.

Project_label

Change the name of a target in an IDE.

Can be used to change the name of the target in an IDE like Visual Studio.

Public_header

Specify public header files in a Framework shared library target.

Shared library targets marked with the Framework property generate frameworks on macOS, iOS and normal shared libraries on other platforms. This property may be set to a list of header files to be placed in the Headers directory inside the framework folder.  On non-Apple platforms these headers may be installed using the PUBLIC_HEADER option to the install(TARGETS) command.

Resource

Specify resource files in a Framework or Bundle.

Target marked with the Framework or Bundle property generate framework or application bundle (both macOS and iOS is supported) or normal shared libraries on other platforms. This property may be set to a list of files to be placed in the corresponding directory (eg. Resources directory for macOS) inside the bundle. On non-Apple platforms these files may be installed using the RESOURCE option to the install(TARGETS) command.

Following example of Application Bundle:

add_executable(ExecutableTarget
  addDemo.c
  resourcefile.txt
  appresourcedir/appres.txt)

target_link_libraries(ExecutableTarget heymath mul)

set(RESOURCE_FILES
  resourcefile.txt
  appresourcedir/appres.txt)

set_target_properties(ExecutableTarget PROPERTIES
  MACOSX_BUNDLE TRUE
  MACOSX_FRAMEWORK_IDENTIFIER org.cmake.ExecutableTarget
  RESOURCE "${RESOURCE_FILES}")

will produce flat structure for iOS systems:

ExecutableTarget.app
  appres.txt
  ExecutableTarget
  Info.plist
  resourcefile.txt

For macOS systems it will produce following directory structure:

ExecutableTarget.app/
  Contents
    Info.plist
    MacOS
      ExecutableTarget
    Resources
      appres.txt
      resourcefile.txt

For Linux, such CMake script produce following files:

ExecutableTarget
Resources
  appres.txt
  resourcefile.txt

Rule_launch_compile

Specify a launcher for compile rules.

See the global property of the same name for details.  This overrides the global and directory property for a target.

Rule_launch_custom

Specify a launcher for custom rules.

See the global property of the same name for details.  This overrides the global and directory property for a target.

Runtime_output_directory_<Config>

Per-configuration output directory for RUNTIME target files.

This is a per-configuration version of the Runtime_output_directory target property, but multi-configuration generators (Visual Studio Generators, Xcode) do NOT append a per-configuration subdirectory to the specified directory.  This property is initialized by the value of the CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of RUNTIME_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

Runtime_output_directory

Output directory in which to build RUNTIME target files.

This property specifies the directory into which runtime target files should be built.  The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created.

See also the RUNTIME_OUTPUT_DIRECTORY_<CONFIG> target property.

Runtime_output_name_<Config>

Per-configuration output name for RUNTIME target files.

This is the configuration-specific version of the Runtime_output_name target property.

Runtime_output_name

Output name for RUNTIME target files.

This property specifies the base name for runtime target files.  It overrides Output_name and OUTPUT_NAME_<CONFIG> properties.

See also the RUNTIME_OUTPUT_NAME_<CONFIG> target property.

Skip_build_rpath

Should rpaths be used for the build tree.

SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic generation of an rpath allowing the target to run from the build tree. This property is initialized by the value of the variable CMAKE_SKIP_BUILD_RPATH if it is set when a target is created.

Source_dir

This read-only property reports the value of the CMAKE_CURRENT_SOURCE_DIR variable in the directory in which the target was defined.

Sources

Source names specified for a target.

List of sources specified for a target.

Soversion

What version number is this target.

For shared libraries Version and SOVERSION can be used to specify the build version and API version respectively.  When building or installing appropriate symlinks are created if the platform supports symlinks and the linker supports so-names.  If only one of both is specified the missing is assumed to have the same version number. SOVERSION is ignored if No_soname property is set.

Windows Versions

For shared libraries and executables on Windows the Version attribute is parsed to extract a <major>.<minor> version number. These numbers are used as the image version of the binary.

Mach-O Versions

For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), the Soversion property corresponds to compatibility version and Version to current version.  See the Framework target property for an example.  Versions of Mach-O binaries may be checked with the otool -L <binary> command.

Static_library_flags_<Config>

Per-configuration archiver (or MSVC librarian) flags for a static library target.

This is the configuration-specific version of Static_library_flags.

Note:

This property has been superseded by Static_library_options property.

Static_library_flags

Archiver (or MSVC librarian) flags for a static library target. Targets that are shared libraries, modules, or executables need to use the Link_options or Link_flags target properties.

The STATIC_LIBRARY_FLAGS property, managed as a string, can be used to add extra flags to the link step of a static library target. STATIC_LIBRARY_FLAGS_<CONFIG> will add to the configuration <CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO, …

Note:

This property has been superseded by Static_library_options property.

Static_library_options

Archiver (or MSVC librarian) flags for a static library target. Targets that are shared libraries, modules, or executables need to use the Link_options target property.

This property holds a semicolon-separated list of options specified so far for its target.  Use set_target_properties() or set_property() commands to set its content.

Contents of STATIC_LIBRARY_OPTIONS may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Note:

This property must be used in preference to Static_library_flags property.

Suffix

What comes after the target name.

A target property that can be set to override the suffix (such as .so or .exe) on the name of a library, module or executable.

Swift_DEPENDENCIES_FILE

This property sets the path for the Swift dependency file (swiftdep) for the target.  If one is not specified, it will default to <TARGET>.swiftdeps.

Swift_LANGUAGE_VERSION

This property sets the language version for the Swift sources in the target.  If one is not specified, it will default to <CMAKE_Swift_LANGUAGE_VERSION> if specified, otherwise it is the latest version supported by the compiler.

Swift_MODULE_DIRECTORY

Specify output directory for Swift modules provided by the target.

If the target contains Swift source files, this specifies the directory in which the modules will be placed.  When this property is not set, the modules will be placed in the build directory corresponding to the target’s source directory. If the variable CMAKE_Swift_MODULE_DIRECTORY is set when a target is created its value is used to initialise this property.

Swift_MODULE_NAME

This property specifies the name of the Swift module.  It is defaulted to the name of the target.

Type

The type of the target.

This read-only property can be used to test the type of the given target.  It will be one of STATIC_LIBRARY, MODULE_LIBRARY, SHARED_LIBRARY, OBJECT_LIBRARY, INTERFACE_LIBRARY, EXECUTABLE or one of the internal target types.

Unity_build

When this property is set to true, the target source files will be combined into batches for faster compilation.  This is done by creating a (set of) unity sources which #include the original sources, then compiling these unity sources instead of the originals.  This is known as a Unity or Jumbo build.  The Unity_build_batch_size property controls the upper limit on how many sources can be combined per unity source file.

Unity builds are not currently supported for all languages.  CMake version 3.16.0 supports combining C and CXX source files.  For targets that mix source files from more than one language, CMake will separate the languages such that each generated unity source file only contains sources for a single language.

This property is initialized by the value of the CMAKE_UNITY_BUILD variable when a target is created.

Note:

Projects should not directly set the UNITY_BUILD property or its associated CMAKE_UNITY_BUILD variable to true.  Depending on the capabilities of the build machine and compiler used, it might or might not be appropriate to enable unity builds.  Therefore, this feature should be under developer control, which would normally be through the developer choosing whether or not to set the CMAKE_UNITY_BUILD variable on the cmake(1) command line or some other equivalent method.  However, it IS recommended to set the UNITY_BUILD target property to false if it is known that enabling unity builds for the target can lead to problems.

ODR (One definition rule) errors

When multiple source files are included into one source file, as is done for unity builds, it can potentially lead to ODR errors.  CMake provides a number of measures to help address such problems:

  • Any source file that has a non-empty Compile_options, Compile_definitions, Compile_flags, or Include_directories source property will not be combined into a unity source.
  • Projects can prevent an individual source file from being combined into a unity source by setting its Skip_unity_build_inclusion source property to true.  This can be a more effective way to prevent problems with specific files than disabling unity builds for an entire target.
  • The Unity_build_code_before_include and Unity_build_code_after_include target properties can be used to inject code into the unity source files before and after every #include statement.
  • The order of source files added to the target via commands like add_library(), add_executable() or target_sources() will be preserved in the generated unity source files.  This can be used to manually enforce a specific grouping based on the Unity_build_batch_size target property.

Unity_build_batch_size

Specifies the maximum number of source files that can be combined into any one unity source file when unity builds are enabled by the Unity_build target property.  The original source files will be distributed across as many unity source files as necessary to honor this limit.

The initial value for this property is taken from the CMAKE_UNITY_BUILD_BATCH_SIZE variable when the target is created. If that variable has not been set, the initial value will be 8.

The batch size needs to be selected carefully.  If set too high, the size of the combined source files could result in the compiler using excessive memory or hitting other similar limits.  In extreme cases, this can even result in build failure.  On the other hand, if the batch size is too low, there will be little gain in build performance.

Although strongly discouraged, the batch size may be set to a value of 0 to combine all the sources for the target into a single unity file, regardless of how many sources are involved.  This runs the risk of creating an excessively large unity source file and negatively impacting the build performance, so a value of 0 is not generally recommended.

Unity_build_code_after_include

Code snippet which is included verbatim by the Unity_build feature just after every #include statement in the generated unity source files.  For example:

set(after [[
#if defined(NOMINMAX)
#undef NOMINMAX
#endif
]])
set_target_properties(myTarget PROPERTIES
  UNITY_BUILD_CODE_AFTER_INCLUDE "${after}"
)

See also Unity_build_code_before_include.

Unity_build_code_before_include

Code snippet which is included verbatim by the Unity_build feature just before every #include statement in the generated unity source files.  For example:

set(before [[
#if !defined(NOMINMAX)
#define NOMINMAX
#endif
]])
set_target_properties(myTarget PROPERTIES
  UNITY_BUILD_CODE_BEFORE_INCLUDE "${before}"
)

See also Unity_build_code_after_include.

Version

What version number is this target.

For shared libraries VERSION and Soversion can be used to specify the build version and API version respectively.  When building or installing appropriate symlinks are created if the platform supports symlinks and the linker supports so-names.  If only one of both is specified the missing is assumed to have the same version number.  For executables VERSION can be used to specify the build version.  When building or installing appropriate symlinks are created if the platform supports symlinks.

Windows Versions

For shared libraries and executables on Windows the Version attribute is parsed to extract a <major>.<minor> version number. These numbers are used as the image version of the binary.

Mach-O Versions

For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), the Soversion property correspond to compatibility version and Version to current version.  See the Framework target property for an example.  Versions of Mach-O binaries may be checked with the otool -L <binary> command.

Visibility_inlines_hidden

Whether to add a compile flag to hide symbols of inline functions

The VISIBILITY_INLINES_HIDDEN property determines whether a flag for hiding symbols for inline functions, such as -fvisibility-inlines-hidden, should be used when invoking the compiler.  This property affects compilation in sources of all types of targets (subject to policy CMP0063).

This property is initialized by the value of the CMAKE_VISIBILITY_INLINES_HIDDEN variable if it is set when a target is created.

Vs_configuration_type

Visual Studio project configuration type.

Sets the ConfigurationType attribute for a generated Visual Studio project. The property value may use generator expressions. If this property is set, it overrides the default setting that is based on the target type (e.g. StaticLibrary, Application, …).

Supported on Visual Studio Generators for VS 2010 and higher.

Vs_debugger_command

Sets the local debugger command for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerCommand> in the Visual Studio project file.

This property only works for Visual Studio 2010 and above; it is ignored on other generators.

Vs_debugger_command_arguments

Sets the local debugger command line arguments for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerCommandArguments> in the Visual Studio project file.

This property only works for Visual Studio 2010 and above; it is ignored on other generators.

Vs_debugger_environment

Sets the local debugger environment for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerEnvironment> in the Visual Studio project file.

This property only works for Visual Studio 2010 and above; it is ignored on other generators.

Vs_debugger_working_directory

Sets the local debugger working directory for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerWorkingDirectory> in the Visual Studio project file.

This property only works for Visual Studio 2010 and above; it is ignored on other generators.

Vs_desktop_extensions_version

Visual Studio Windows 10 Desktop Extensions Version

Specifies the version of the Desktop Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Desktop Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

VS_DOTNET_REFERENCE_<refname>

Visual Studio managed project .NET reference with name <refname> and hint path.

Adds one .NET reference to generated Visual Studio project. The reference will have the name <refname> and will point to the assembly given as value of the property.

See also Vs_dotnet_references and Vs_dotnet_references_copy_local

VS_DOTNET_REFERENCEPROP_<refname>_TAG_<tagname>

Defines an XML property <tagname> for a .NET reference <refname>.

Reference properties can be set for .NET references which are defined by the target properties Vs_dotnet_references, VS_DOTNET_REFERENCE_<refname> and also for project references to other C# targets which are established by target_link_libraries().

This property is only applicable to C# targets and Visual Studio generators 2010 and later.

Vs_dotnet_references

Visual Studio managed project .NET references

Adds one or more semicolon-delimited .NET references to a generated Visual Studio project.  For example, “System;System.Windows.Forms”.

Vs_dotnet_references_copy_local

Sets the Copy Local property for all .NET hint references in the target

Boolean property to enable/disable copying of .NET hint references to output directory. The default is ON.

Vs_dotnet_target_framework_version

Specify the .NET target framework version.

Used to specify the .NET target framework version for C++/CLI.  For example, “v4.5”.

This property is deprecated and should not be used anymore. Use Dotnet_target_framework_version instead.

Vs_dpi_aware

Set the Manifest Tool -> Input and Output -> DPI Awareness in the Visual Studio target project properties.

Valid values are PerMonitor, ON, or OFF.

For example:

add_executable(myproject myproject.cpp)
set_property(TARGET myproject PROPERTY VS_DPI_AWARE "PerMonitor")

Vs_global_keyword

Visual Studio project keyword for VS 10 (2010) and newer.

Sets the “keyword” attribute for a generated Visual Studio project. Defaults to “Win32Proj”.  You may wish to override this value with “ManagedCProj”, for example, in a Visual Studio managed C++ unit test project.

Use the Vs_keyword target property to set the keyword for Visual Studio 9 (2008) and older.

Vs_global_project_types

Visual Studio project type(s).

Can be set to one or more UUIDs recognized by Visual Studio to indicate the type of project.  This value is copied verbatim into the generated project file.  Example for a managed C++ unit testing project:

{3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}

UUIDs are semicolon-delimited.

Vs_global_rootnamespace

Visual Studio project root namespace.

Sets the “RootNamespace” attribute for a generated Visual Studio project.  The attribute will be generated only if this is set.

VS_GLOBAL_<variable>

Visual Studio project-specific global variable.

Tell the Visual Studio generator to set the global variable ‘<variable>’ to a given value in the generated Visual Studio project. Ignored on other generators.  Qt integration works better if VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found.  For example, “4.7.3”

Vs_iot_extensions_version

Visual Studio Windows 10 IoT Extensions Version

Specifies the version of the IoT Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the IoT Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

Vs_iot_startup_task

Visual Studio Windows 10 IoT Continuous Background Task

Specifies that the target should be compiled as a Continuous Background Task library.

Vs_just_my_code_debugging

Enable Just My Code with Visual Studio debugger.

Supported on Visual Studio Generators for VS 2010 and higher, Makefile Generators and the Ninja generators.

This property is initialized by the CMAKE_VS_JUST_MY_CODE_DEBUGGING variable if it is set when a target is created.

Vs_keyword

Visual Studio project keyword for VS 9 (2008) and older.

Can be set to change the visual studio keyword, for example Qt integration works better if this is set to Qt4VSv1.0.

Use the Vs_global_keyword target property to set the keyword for Visual Studio 10 (2010) and newer.

Vs_mobile_extensions_version

Visual Studio Windows 10 Mobile Extensions Version

Specifies the version of the Mobile Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Mobile Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

Vs_no_solution_deploy

Specify that the target should not be marked for deployment to a Windows CE or Windows Phone device in the generated Visual Studio solution.

Be default, all EXE and shared library (DLL) targets are marked to deploy to the target device in the generated Visual Studio solution.

Generator expressions are supported.

There are reasons one might want to exclude a target / generated project from deployment:

  • The library or executable may not be necessary in the primary deploy/debug scenario, and excluding from deployment saves time in the develop/download/debug cycle.
  • There may be insufficient space on the target device to accommodate all of the build products.
  • Visual Studio 2013 requires a target device IP address be entered for each target marked for deployment.  For large numbers of targets, this can be tedious. Note: Visual Studio will deploy all project dependencies of a project tagged for deployment to the IP address configured for that project even if those dependencies are not tagged for deployment.

Example 1

This shows setting the variable for the target foo.

add_library(foo SHARED foo.cpp)
set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY ON)

Example 2

This shows setting the variable for the Release configuration only.

add_library(foo SHARED foo.cpp)
set_property(TARGET foo PROPERTY VS_NO_SOLUTION_DEPLOY "$<CONFIG:Release>")

Vs_package_references

Visual Studio package references for nuget.

Adds one or more semicolon-delimited package references to a generated Visual Studio project. The version of the package will be underscore delimited. For example, boost_1.7.0;nunit_3.12.*.

set_property(TARGET ${TARGET_NAME} PROPERTY
  VS_PACKAGE_REFERENCES "boost_1.7.0")

Vs_project_import

Visual Studio managed project imports

Adds to a generated Visual Studio project one or more semicolon-delimited paths to .props files needed when building projects from some NuGet packages. For example, my_packages_path/MyPackage.1.0.0/build/MyPackage.props.

Vs_scc_auxpath

Visual Studio Source Code Control Aux Path.

Can be set to change the visual studio source code control auxpath property.

Vs_scc_localpath

Visual Studio Source Code Control Local Path.

Can be set to change the visual studio source code control local path property.

Vs_scc_projectname

Visual Studio Source Code Control Project.

Can be set to change the visual studio source code control project name property.

Vs_scc_provider

Visual Studio Source Code Control Provider.

Can be set to change the visual studio source code control provider property.

Vs_sdk_references

Visual Studio project SDK references. Specify a semicolon-separated list of SDK references to be added to a generated Visual Studio project, e.g. Microsoft.AdMediatorWindows81, Version=1.0.

Vs_user_props

Sets the user props file to be included in the visual studio C++ project file. The standard path is $(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props, which is in most cases the same as %LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.Win32.user.props or %LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.x64.user.props.

The *.user.props files can be used for Visual Studio wide configuration which is independent from cmake.

Vs_windows_target_platform_min_version

Visual Studio Windows Target Platform Minimum Version

For Windows 10. Specifies the minimum version of the OS that is being targeted. For example 10.0.10240.0. If the value is not specified, the value of CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION will be used on WindowsStore projects otherwise the target platform minimum version will not be specified for the project.

Vs_winrt_component

Mark a target as a Windows Runtime component for the Visual Studio generator. Compile the target with C++/CX language extensions for Windows Runtime. For SHARED and MODULE libraries, this also defines the _WINRT_DLL preprocessor macro.

Note:

Currently this is implemented only by Visual Studio generators. Support may be added to other generators in the future.

Vs_winrt_extensions

Deprecated.  Use Vs_winrt_component instead. This property was an experimental partial implementation of that one.

Vs_winrt_references

Visual Studio project Windows Runtime Metadata references

Adds one or more semicolon-delimited WinRT references to a generated Visual Studio project.  For example, “Windows;Windows.UI.Core”.

Win32_executable

Build an executable with a WinMain entry point on windows.

When this property is set to true the executable when linked on Windows will be created with a WinMain() entry point instead of just main().  This makes it a GUI executable instead of a console application. See the CMAKE_MFC_FLAG variable documentation to configure use of the Microsoft Foundation Classes (MFC) for WinMain executables.  This property is initialized by the value of the CMAKE_WIN32_EXECUTABLE variable if it is set when a target is created.

Windows_export_all_symbols

This property is implemented only for MS-compatible tools on Windows.

Enable this boolean property to automatically create a module definition (.def) file with all global symbols found in the input .obj files for a SHARED library (or executable with Enable_exports) on Windows.  The module definition file will be passed to the linker causing all symbols to be exported from the .dll. For global data symbols, __declspec(dllimport) must still be used when compiling against the code in the .dll.  All other function symbols will be automatically exported and imported by callers.  This simplifies porting projects to Windows by reducing the need for explicit dllexport markup, even in C++ classes.

When this property is enabled, zero or more .def files may also be specified as source files of the target.  The exports named by these files will be merged with those detected from the object files to generate a single module definition file to be passed to the linker.  This can be used to export symbols from a .dll that are not in any of its object files but are added by the linker from dependencies (e.g. msvcrt.lib).

This property is initialized by the value of the CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS variable if it is set when a target is created.

XCODE_ATTRIBUTE_<an-attribute>

Set Xcode target attributes directly.

Tell the Xcode generator to set ‘<an-attribute>’ to a given value in the generated Xcode project.  Ignored on other generators.

See the CMAKE_XCODE_ATTRIBUTE_<an-attribute> variable to set attributes on all targets in a directory tree.

Contents of XCODE_ATTRIBUTE_<an-attribute> may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Xcode_explicit_file_type

Set the Xcode explicitFileType attribute on its reference to a target.  CMake computes a default based on target type but can be told explicitly with this property.

See also Xcode_product_type.

Xcode_generate_scheme

If enabled, the Xcode generator will generate schema files.  These are useful to invoke analyze, archive, build-for-testing and test actions from the command line.

This property is initialized by the value of the variable CMAKE_XCODE_GENERATE_SCHEME if it is set when a target is created.

The following target properties overwrite the default of the corresponding settings on the “Diagnostic” tab for each schema file. Each of those is initialized by the respective CMAKE_ variable at target creation time.

The following target properties will be applied on the “Info”, “Arguments”, and “Options” tab:

Xcode_product_type

Set the Xcode productType attribute on its reference to a target.  CMake computes a default based on target type but can be told explicitly with this property.

See also Xcode_explicit_file_type.

Xcode_scheme_address_sanitizer

Whether to enable Address Sanitizer in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_address_sanitizer_use_after_return

Whether to enable Detect use of stack after return in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_arguments

Specify command line arguments that should be added to the Arguments section of the generated Xcode scheme.

If set to a list of arguments those will be added to the scheme.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_debug_as_root

Whether to debug the target as ‘root’.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_debug_document_versioning

Whether to enable Allow debugging when using document Versions Browser in the Options section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_disable_main_thread_checker

Whether to disable the Main Thread Checker in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_dynamic_library_loads

Whether to enable Dynamic Library Loads in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_dynamic_linker_api_usage

Whether to enable Dynamic Linker API usage in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_environment

Specify environment variables that should be added to the Arguments section of the generated Xcode scheme.

If set to a list of environment variables and values of the form MYVAR=value those environment variables will be added to the scheme.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_executable

Specify path to executable in the Info section of the generated Xcode scheme. If not set the schema generator will select the current target if it is actually executable.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_guard_malloc

Whether to enable Guard Malloc in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_GUARD_MALLOC if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_main_thread_checker_stop

Whether to enable the Main Thread Checker option Pause on issues in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_malloc_guard_edges

Whether to enable Malloc Guard Edges in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_malloc_scribble

Whether to enable Malloc Scribble in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_malloc_stack

Whether to enable Malloc Stack in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_STACK if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_thread_sanitizer

Whether to enable Thread Sanitizer in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_THREAD_SANITIZER if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_thread_sanitizer_stop

Whether to enable Thread Sanitizer - Pause on issues in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_undefined_behaviour_sanitizer

Whether to enable Undefined Behavior Sanitizer in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_undefined_behaviour_sanitizer_stop

Whether to enable Undefined Behavior Sanitizer option Pause on issues in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xcode_scheme_zombie_objects

Whether to enable Zombie Objects in the Diagnostics section of the generated Xcode scheme.

This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS if it is set when a target is created.

Please refer to the Xcode_generate_scheme target property documentation to see all Xcode schema related properties.

Xctest

This target is a XCTest CFBundle on the Mac.

This property will usually get set via the xctest_add_bundle() macro in FindXCTest module.

If a module library target has this property set to true it will be built as a CFBundle when built on the Mac.  It will have the directory structure required for a CFBundle.

This property depends on Bundle to be effective.

Properties on Tests

Attached_files_on_fail

Attach a list of files to a dashboard submission if the test fails.

Same as Attached_files, but these files will only be included if the test does not pass.

Attached_files

Attach a list of files to a dashboard submission.

Set this property to a list of files that will be encoded and submitted to the dashboard as an addition to the test result.

Cost

This property describes the cost of a test.  When parallel testing is enabled, tests in the test set will be run in descending order of cost. Projects can explicitly define the cost of a test by setting this property to a floating point value.

When the cost of a test is not defined by the project, ctest will initially use a default cost of 0. It computes a weighted average of the cost each time a test is run and uses that as an improved estimate of the cost for the next run.  The more a test is re-run in the same build directory, the more representative the cost should become.

Depends

Specifies that this test should only be run after the specified list of tests.

Set this to a list of tests that must finish before this test is run. The results of those tests are not considered, the dependency relationship is purely for order of execution (i.e. it is really just a run after relationship). Consider using test fixtures with setup tests if a dependency with successful completion is required (see Fixtures_required).

Disabled

If set to True, the test will be skipped and its status will be ‘Not Run’. A DISABLED test will not be counted in the total number of tests and its completion status will be reported to CDash as Disabled.

A DISABLED test does not participate in test fixture dependency resolution. If a DISABLED test has fixture requirements defined in its Fixtures_required property, it will not cause setup or cleanup tests for those fixtures to be added to the test set.

If a test with the Fixtures_setup property set is DISABLED, the fixture behavior will be as though that setup test was passing and any test case requiring that fixture will still run.

Environment

Specify environment variables that should be defined for running a test.

If set to a list of environment variables and values of the form MYVAR=value those environment variables will be defined while running the test.  The environment is restored to its previous state after the test is done.

Fail_regular_expression

If the output matches this regular expression the test will fail.

If set, if the output matches one of specified regular expressions, the test will fail.  Example:

set_tests_properties(mytest PROPERTIES
  FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
)

FAIL_REGULAR_EXPRESSION expects a list of regular expressions.

Fixtures_cleanup

Specifies a list of fixtures for which the test is to be treated as a cleanup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them.

Fixture cleanup tests are ordinary tests with all of the usual test functionality. Setting the FIXTURES_CLEANUP property for a test has two primary effects:

  • CTest will ensure the test executes after all other tests which list any of the fixtures in its Fixtures_required property.
  • If CTest is asked to run only a subset of tests (e.g. using regular expressions or the --rerun-failed option) and the cleanup test is not in the set of tests to run, it will automatically be added if any tests in the set require any fixture listed in FIXTURES_CLEANUP.

A cleanup test can have multiple fixtures listed in its FIXTURES_CLEANUP property. It will execute only once for the whole CTest run, not once for each fixture. A fixture can also have more than one cleanup test defined. If there are multiple cleanup tests for a fixture, projects can control their order with the usual Depends test property if necessary.

A cleanup test is allowed to require other fixtures, but not any fixture listed in its FIXTURES_CLEANUP property. For example:

# Ok: Dependent fixture is different to cleanup
set_tests_properties(cleanupFoo PROPERTIES
  FIXTURES_CLEANUP  Foo
  FIXTURES_REQUIRED Bar
)

# Error: cannot require same fixture as cleanup
set_tests_properties(cleanupFoo PROPERTIES
  FIXTURES_CLEANUP  Foo
  FIXTURES_REQUIRED Foo
)

Cleanup tests will execute even if setup or regular tests for that fixture fail or are skipped.

See Fixtures_required for a more complete discussion of how to use test fixtures.

Fixtures_required

Specifies a list of fixtures the test requires. Fixture names are case sensitive and they are not required to have any similarity to test names.

Fixtures are a way to attach setup and cleanup tasks to a set of tests. If a test requires a given fixture, then all tests marked as setup tasks for that fixture will be executed first (once for the whole set of tests, not once per test requiring the fixture). After all tests requiring a particular fixture have completed, CTest will ensure all tests marked as cleanup tasks for that fixture are then executed. Tests are marked as setup tasks with the Fixtures_setup property and as cleanup tasks with the Fixtures_cleanup property. If any of a fixture’s setup tests fail, all tests listing that fixture in their FIXTURES_REQUIRED property will not be executed. The cleanup tests for the fixture will always be executed, even if some setup tests fail.

When CTest is asked to execute only a subset of tests (e.g. by the use of regular expressions or when run with the --rerun-failed command line option), it will automatically add any setup or cleanup tests for fixtures required by any of the tests that are in the execution set. This behavior can be overridden with the -FS, -FC and -FA command line options to ctest(1) if desired.

Since setup and cleanup tasks are also tests, they can have an ordering specified by the Depends test property just like any other tests. This can be exploited to implement setup or cleanup using multiple tests for a single fixture to modularise setup or cleanup logic.

The concept of a fixture is different to that of a resource specified by Resource_lock, but they may be used together. A fixture defines a set of tests which share setup and cleanup requirements, whereas a resource lock has the effect of ensuring a particular set of tests do not run in parallel. Some situations may need both, such as setting up a database, serialising test access to that database and deleting the database again at the end. For such cases, tests would populate both FIXTURES_REQUIRED and Resource_lock to combine the two behaviours. Names used for Resource_lock have no relationship with names of fixtures, so note that a resource lock does not imply a fixture and vice versa.

Consider the following example which represents a database test scenario similar to that mentioned above:

add_test(NAME testsDone   COMMAND emailResults)
add_test(NAME fooOnly     COMMAND testFoo)
add_test(NAME dbOnly      COMMAND testDb)
add_test(NAME dbWithFoo   COMMAND testDbWithFoo)
add_test(NAME createDB    COMMAND initDB)
add_test(NAME setupUsers  COMMAND userCreation)
add_test(NAME cleanupDB   COMMAND deleteDB)
add_test(NAME cleanupFoo  COMMAND removeFoos)

set_tests_properties(setupUsers PROPERTIES DEPENDS createDB)

set_tests_properties(createDB   PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(setupUsers PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(cleanupDB  PROPERTIES FIXTURES_CLEANUP  DB)
set_tests_properties(cleanupFoo PROPERTIES FIXTURES_CLEANUP  Foo)
set_tests_properties(testsDone  PROPERTIES FIXTURES_CLEANUP  "DB;Foo")

set_tests_properties(fooOnly    PROPERTIES FIXTURES_REQUIRED Foo)
set_tests_properties(dbOnly     PROPERTIES FIXTURES_REQUIRED DB)
set_tests_properties(dbWithFoo  PROPERTIES FIXTURES_REQUIRED "DB;Foo")

set_tests_properties(dbOnly dbWithFoo createDB setupUsers cleanupDB
                     PROPERTIES RESOURCE_LOCK DbAccess)

Key points from this example:

  • Two fixtures are defined: DB and Foo. Tests can require a single fixture as fooOnly and dbOnly do, or they can depend on multiple fixtures like dbWithFoo does.
  • A Depends relationship is set up to ensure setupUsers happens after createDB, both of which are setup tests for the DB fixture and will therefore be executed before the dbOnly and dbWithFoo tests automatically.
  • No explicit Depends relationships were needed to make the setup tests run before or the cleanup tests run after the regular tests.
  • The Foo fixture has no setup tests defined, only a single cleanup test.
  • testsDone is a cleanup test for both the DB and Foo fixtures. Therefore, it will only execute once regular tests for both fixtures have finished (i.e. after fooOnly, dbOnly and dbWithFoo). No Depends relationship was specified for testsDone, so it is free to run before, after or concurrently with other cleanup tests for either fixture.
  • The setup and cleanup tests never list the fixtures they are for in their own FIXTURES_REQUIRED property, as that would result in a dependency on themselves and be considered an error.

Fixtures_setup

Specifies a list of fixtures for which the test is to be treated as a setup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them.

Fixture setup tests are ordinary tests with all of the usual test functionality. Setting the FIXTURES_SETUP property for a test has two primary effects:

  • CTest will ensure the test executes before any other test which lists the fixture name(s) in its Fixtures_required property.
  • If CTest is asked to run only a subset of tests (e.g. using regular expressions or the --rerun-failed option) and the setup test is not in the set of tests to run, it will automatically be added if any tests in the set require any fixture listed in FIXTURES_SETUP.

A setup test can have multiple fixtures listed in its FIXTURES_SETUP property. It will execute only once for the whole CTest run, not once for each fixture. A fixture can also have more than one setup test defined. If there are multiple setup tests for a fixture, projects can control their order with the usual Depends test property if necessary.

A setup test is allowed to require other fixtures, but not any fixture listed in its FIXTURES_SETUP property. For example:

# Ok: dependent fixture is different to setup
set_tests_properties(setupFoo PROPERTIES
  FIXTURES_SETUP    Foo
  FIXTURES_REQUIRED Bar
)

# Error: cannot require same fixture as setup
set_tests_properties(setupFoo PROPERTIES
  FIXTURES_SETUP    Foo
  FIXTURES_REQUIRED Foo
)

If any of a fixture’s setup tests fail, none of the tests listing that fixture in its Fixtures_required property will be run. Cleanup tests will, however, still be executed.

See Fixtures_required for a more complete discussion of how to use test fixtures.

Labels

Specify a list of text labels associated with a test.

The list is reported in dashboard submissions.

Measurement

Specify a CDASH measurement and value to be reported for a test.

If set to a name then that name will be reported to CDASH as a named measurement with a value of 1.  You may also specify a value by setting MEASUREMENT to measurement=value.

Pass_regular_expression

The output must match this regular expression for the test to pass.

If set, the test output will be checked against the specified regular expressions and at least one of the regular expressions has to match, otherwise the test will fail.  Example:

set_tests_properties(mytest PROPERTIES
  PASS_REGULAR_EXPRESSION "TestPassed;All ok"
)

PASS_REGULAR_EXPRESSION expects a list of regular expressions.

Processor_affinity

Set to a true value to ask CTest to launch the test process with CPU affinity for a fixed set of processors.  If enabled and supported for the current platform, CTest will choose a set of processors to place in the CPU affinity mask when launching the test process.  The number of processors in the set is determined by the Processors test property or the number of processors available to CTest, whichever is smaller.  The set of processors chosen will be disjoint from the processors assigned to other concurrently running tests that also have the PROCESSOR_AFFINITY property enabled.

Processors

Set to specify how many process slots this test requires. If not set, the default is 1 processor.

Denotes the number of processors that this test will require.  This is typically used for MPI tests, and should be used in conjunction with the ctest_test() PARALLEL_LEVEL option.

This will also be used to display a weighted test timing result in label and subproject summaries in the command line output of ctest(1). The wall clock time for the test run will be multiplied by this property to give a better idea of how much cpu resource CTest allocated for the test.

See also the Processor_affinity test property.

Required_files

List of files required to run the test.

If set to a list of files, the test will not be run unless all of the files exist.

Resource_groups

Specify resources required by a test, grouped in a way that is meaningful to the test.  See resource allocation for more information on how this property integrates into the CTest resource allocation feature.

The RESOURCE_GROUPS property is a semicolon-separated list of group descriptions. Each entry consists of an optional number of groups using the description followed by a series of resource requirements for those groups. These requirements (and the number of groups) are separated by commas. The resource requirements consist of the name of a resource type, followed by a colon, followed by an unsigned integer specifying the number of slots required on one resource of the given type.

The RESOURCE_GROUPS property tells CTest what resources a test expects to use grouped in a way meaningful to the test.  The test itself must read the environment variables to determine which resources have been allocated to each group.  For example, each group may correspond to a process the test will spawn when executed.

Consider the following example:

add_test(NAME MyTest COMMAND MyExe)
set_property(TEST MyTest PROPERTY RESOURCE_GROUPS
  "2,gpus:2"
  "gpus:4,crypto_chips:2")

In this example, there are two group descriptions (implicitly separated by a semicolon.) The content of the first description is 2,gpus:2. This description specifies 2 groups, each of which requires 2 slots from a single GPU. The content of the second description is gpus:4,crypto_chips:2. This description does not specify a group count, so a default of 1 is assumed. This single group requires 4 slots from a single GPU and 2 slots from a single cryptography chip. In total, 3 resource groups are specified for this test, each with its own unique requirements.

Note that the number of slots following the resource type specifies slots from a single instance of the resource. If the resource group can tolerate receiving slots from different instances of the same resource, it can indicate this by splitting the specification into multiple requirements of one slot. For example:

add_test(NAME MyTest COMMAND MyExe)
set_property(TEST MyTest PROPERTY RESOURCE_GROUPS
  "gpus:1,gpus:1,gpus:1,gpus:1")

In this case, the single resource group indicates that it needs four GPU slots, all of which may come from separate GPUs (though they don’t have to; CTest may still assign slots from the same GPU.)

When CTest sets the environment variables for a test, it assigns a group number based on the group description, starting at 0 on the left and the number of groups minus 1 on the right. For example, in the example above, the two groups in the first description would have IDs of 0 and 1, and the single group in the second description would have an ID of 2.

Both the RESOURCE_GROUPS and Resource_lock properties serve similar purposes, but they are distinct and orthogonal. Resources specified by RESOURCE_GROUPS do not affect Resource_lock, and vice versa. Whereas Resource_lock is a simpler property that is used for locking one global resource, RESOURCE_GROUPS is a more advanced property that allows multiple tests to simultaneously use multiple resources of the same type, specifying their requirements in a fine-grained manner.

Resource_lock

Specify a list of resources that are locked by this test.

If multiple tests specify the same resource lock, they are guaranteed not to run concurrently.

See also Fixtures_required if the resource requires any setup or cleanup steps.

Both the Resource_groups and RESOURCE_LOCK properties serve similar purposes, but they are distinct and orthogonal. Resources specified by Resource_groups do not affect RESOURCE_LOCK, and vice versa. Whereas RESOURCE_LOCK is a simpler property that is used for locking one global resource, Resource_groups is a more advanced property that allows multiple tests to simultaneously use multiple resources of the same type, specifying their requirements in a fine-grained manner.

Run_serial

Do not run this test in parallel with any other test.

Use this option in conjunction with the ctest_test PARALLEL_LEVEL option to specify that this test should not be run in parallel with any other tests.

Skip_regular_expression

If the output matches this regular expression the test will be marked as skipped.

If set, if the output matches one of specified regular expressions, the test will be marked as skipped.  Example:

set_property(TEST mytest PROPERTY
  SKIP_REGULAR_EXPRESSION "[^a-z]Skip" "SKIP" "Skipped"
)

SKIP_REGULAR_EXPRESSION expects a list of regular expressions.

See also the Skip_return_code property.

Skip_return_code

Return code to mark a test as skipped.

Sometimes only a test itself can determine if all requirements for the test are met. If such a situation should not be considered a hard failure a return code of the process can be specified that will mark the test as Not Run if it is encountered. Valid values are in the range of 0 to 255, inclusive.

See also the Skip_regular_expression property.

Timeout

How many seconds to allow for this test.

This property if set will limit a test to not take more than the specified number of seconds to run.  If it exceeds that the test process will be killed and ctest will move to the next test.  This setting takes precedence over CTEST_TEST_TIMEOUT.

Timeout_after_match

Change a test’s timeout duration after a matching line is encountered in its output.

Usage

add_test(mytest ...)
set_property(TEST mytest PROPERTY TIMEOUT_AFTER_MATCH "${seconds}" "${regex}")

Description

Allow a test seconds to complete after regex is encountered in its output.

When the test outputs a line that matches regex its start time is reset to the current time and its timeout duration is changed to seconds.  Prior to this, the timeout duration is determined by the Timeout property or the CTEST_TEST_TIMEOUT variable if either of these are set.  Because the test’s start time is reset, its execution time will not include any time that was spent waiting for the matching output.

Timeout_after_match is useful for avoiding spurious timeouts when your test must wait for some system resource to become available before it can execute.  Set Timeout to a longer duration that accounts for resource acquisition and use Timeout_after_match to control how long the actual test is allowed to run.

If the required resource can be controlled by CTest you should use Resource_lock instead of Timeout_after_match. This property should be used when only the test itself can determine when its required resources are available.

Will_fail

If set to true, this will invert the pass/fail flag of the test.

This property can be used for tests that are expected to fail and return a non zero return code.

Working_directory

The directory from which the test executable will be called.

If this is not set, the test will be run with the working directory set to the binary directory associated with where the test was created (i.e. the CMAKE_CURRENT_BINARY_DIR for where add_test() was called).

Properties on Source Files

Abstract

Is this source file an abstract class.

A property on a source file that indicates if the source file represents a class that is abstract.  This only makes sense for languages that have a notion of an abstract class and it is only used by some tools that wrap classes into other languages.

Autouic_options

Additional options for uic when using Autouic

This property holds additional command line options which will be used when uic is executed during the build via Autouic, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.

By default it is empty.

The options set on the .ui source file may override Autouic_options set on the target.

Example

# ...
set_property(SOURCE widget.ui PROPERTY AUTOUIC_OPTIONS "--no-protection")
# ...

Autorcc_options

Additional options for rcc when using Autorcc

This property holds additional command line options which will be used when rcc is executed during the build via Autorcc, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.

By default it is empty.

The options set on the .qrc source file may override Autorcc_options set on the target.

Example

# ...
set_property(SOURCE resources.qrc PROPERTY AUTORCC_OPTIONS "--compress;9")
# ...

Compile_definitions

Preprocessor definitions for compiling a source file.

The Compile_definitions property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported.  CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values).  This property may be set on a per-configuration basis using the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name (ex.  COMPILE_DEFINITIONS_DEBUG).

CMake will automatically drop some definitions that are not supported by the native build tool.  Xcode does not support per-configuration definitions on source files.

Disclaimer: Most native build tools have poor support for escaping certain values.  CMake has work-arounds for many cases but some values may just not be possible to pass correctly.  If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value.  Your work-around may break in a future version of CMake that has improved escape support.  Instead consider defining the macro in a (configured) header file.  Then report the limitation.  Known limitations include:

#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows

CMake does not reject these values outright because they do work in some cases.  Use with caution.

Contents of Compile_definitions may use cmake-generator-expressions(7) with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.

Generator expressions should be preferred instead of setting the alternative per-configuration property.

Compile_flags

Additional flags to be added when compiling this source file.

The Compile_flags property, managed as a string, sets additional compiler flags used to build source files.  Use Compile_definitions to pass additional preprocessor definitions.

Contents of Compile_flags may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.

Note:

This property has been superseded by the Compile_options property.

Compile_options

List of additional options to pass to the compiler.

This property holds a semicolon-separated list of options and will be added to the list of compile flags when this source file builds.  Use Compile_definitions to pass additional preprocessor definitions and Include_directories to pass additional include directories.

Contents of Compile_options may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.

Note:

This property should be preferred over the Compile_flags property.

External_object

If set to true then this is an object file.

If this property is set to True then the source file is really an object file and should not be compiled.  It will still be linked into the target though.

Fortran_FORMAT

Set to FIXED or FREE to indicate the Fortran source layout.

This property tells CMake whether a given Fortran source file uses fixed-format or free-format.  CMake will pass the corresponding format flag to the compiler.  Consider using the target-wide Fortran_FORMAT property if all source files in a target share the same format.

Generated

Is this source file generated as part of the build or CMake process.

Tells the internal CMake engine that a source file is generated by an outside process such as another build step, or the execution of CMake itself. This information is then used to exempt the file from any existence or validity checks. Generated files are created by the execution of commands such as add_custom_command() and file(GENERATE).

When a generated file created by an add_custom_command() command is explicitly listed as a source file for any target in the same directory scope (which usually means the same CMakeLists.txt file), CMake will automatically create a dependency to make sure the file is generated before building that target.

Generated sources may be hidden in some IDE tools, while in others they might be shown. For the special case of sources generated by CMake’s Automoc or Autorcc functionality, the Autogen_source_group, Automoc_source_group and Autorcc_source_group target properties may influence where the generated sources are grouped in the project’s file lists.

Header_file_only

Is this source file only a header file.

A property on a source file that indicates if the source file is a header file with no associated implementation.  This is set automatically based on the file extension and is used by CMake to determine if certain dependency information should be computed.

By setting this property to ON, you can disable compilation of the given source file, even if it should be compiled because it is part of the library’s/executable’s sources.

This is useful if you have some source files which you somehow pre-process, and then add these pre-processed sources via add_library() or add_executable(). Normally, in IDE, there would be no reference of the original sources, only of these pre-processed sources. So by setting this property for all the original source files to ON, and then either calling add_library() or add_executable() while passing both the pre-processed sources and the original sources, or by using target_sources() to add original source files will do exactly what would one expect, i.e. the original source files would be visible in IDE, and will not be built.

Include_directories

List of preprocessor include file search directories.

This property holds a semicolon-separated list of paths and will be added to the list of include directories when this source file builds. These directories will take precedence over directories defined at target level except for Xcode generator due to technical limitations.

Relative paths should not be added to this property directly.

Contents of Include_directories may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.

Keep_extension

Make the output file have the same extension as the source file.

If this property is set then the file extension of the output file will be the same as that of the source file.  Normally the output file extension is computed based on the language of the source file, for example .cxx will go to a .o extension.

Labels

Specify a list of text labels associated with a source file.

This property has meaning only when the source file is listed in a target whose Labels property is also set.  No other semantics are currently specified.

Language

What programming language is the file.

A property that can be set to indicate what programming language the source file is.  If it is not set the language is determined based on the file extension.  Typical values are CXX (i.e.  C++), C, CSharp, CUDA, Fortran, and ASM.  Setting this property for a file means this file will be compiled.  Do not set this for headers or files that should not be compiled.

Location

The full path to a source file.

A read only property on a SOURCE FILE that contains the full path to the source file.

Macosx_package_location

Place a source file inside a Application Bundle (Macosx_bundle), Core Foundation Bundle (Bundle), or Framework Bundle (Framework).  It is applicable for macOS and iOS.

Executable targets with the Macosx_bundle property set are built as macOS or iOS application bundles on Apple platforms.  Shared library targets with the Framework property set are built as macOS or iOS frameworks on Apple platforms.  Module library targets with the Bundle property set are built as macOS CFBundle bundles on Apple platforms.  Source files listed in the target with this property set will be copied to a directory inside the bundle or framework content folder specified by the property value.  For macOS Application Bundles the content folder is <name>.app/Contents.  For macOS Frameworks the content folder is <name>.framework/Versions/<version>.  For macOS CFBundles the content folder is <name>.bundle/Contents (unless the extension is changed).  See the Public_header, Private_header, and Resource target properties for specifying files meant for Headers, PrivateHeaders, or Resources directories.

If the specified location is equal to Resources, the resulting location will be the same as if the Resource property had been used. If the specified location is a sub-folder of Resources, it will be placed into the respective sub-folder. Note: For iOS Apple uses a flat bundle layout where no Resources folder exist. Therefore CMake strips the Resources folder name from the specified location.

Object_depends

Additional files on which a compiled object file depends.

Specifies a semicolon-separated list of full-paths to files on which any object files compiled from this source file depend. On Makefile Generators and the Ninja generator an object file will be recompiled if any of the named files is newer than it. Visual Studio Generators and the Xcode generator cannot implement such compilation dependencies.

This property need not be used to specify the dependency of a source file on a generated header file that it includes.  Although the property was originally introduced for this purpose, it is no longer necessary.  If the generated header file is created by a custom command in the same target as the source file, the automatic dependency scanning process will recognize the dependency.  If the generated header file is created by another target, an inter-target dependency should be created with the add_dependencies() command (if one does not already exist due to linking relationships).

Object_outputs

Additional outputs for a Ninja or Makefile Generators rule.

Additional outputs created by compilation of this source file.  If any of these outputs is missing the object will be recompiled.  This is supported only on the Ninja and Makefile Generators and will be ignored on other generators.

Skip_autogen

Exclude the source file from Automoc, Autouic and Autorcc processing (for Qt projects).

For finer exclusion control see Skip_automoc, Skip_autouic and Skip_autorcc.

Example

# ...
set_property(SOURCE file.h PROPERTY SKIP_AUTOGEN ON)
# ...

Skip_automoc

Exclude the source file from Automoc processing (for Qt projects).

For broader exclusion control see Skip_autogen.

Example

# ...
set_property(SOURCE file.h PROPERTY SKIP_AUTOMOC ON)
# ...

Skip_autorcc

Exclude the source file from Autorcc processing (for Qt projects).

For broader exclusion control see Skip_autogen.

Example

# ...
set_property(SOURCE file.qrc PROPERTY SKIP_AUTORCC ON)
# ...

Skip_autouic

Exclude the source file from Autouic processing (for Qt projects).

SKIP_AUTOUIC can be set on C++ header and source files and on .ui files.

For broader exclusion control see Skip_autogen.

Example

# ...
set_property(SOURCE file.h PROPERTY SKIP_AUTOUIC ON)
set_property(SOURCE file.cpp PROPERTY SKIP_AUTOUIC ON)
set_property(SOURCE widget.ui PROPERTY SKIP_AUTOUIC ON)
# ...

Skip_precompile_headers

Is this source file skipped by Precompile_headers feature.

This property helps with build problems that one would run into when using the Precompile_headers feature.

One example would be the usage of Objective-C (.m) files, and Objective-C++ (.mm) files, which lead to compilation failure because they are treated (in case of Ninja / Makefile generator) as C, and CXX respectively. The precompile headers are not compatible between languages.

Skip_unity_build_inclusion

Setting this property to true ensures the source file will be skipped by unity builds when its associated target has its Unity_build property set to true.  The source file will instead be compiled on its own in the same way as it would with unity builds disabled.

This property helps with “ODR (One definition rule)” problems where combining a particular source file with others might lead to build errors or other unintended side effects.

Swift_DEPENDENCIES_FILE

This property sets the path for the Swift dependency file (swiftdeps) for the source.  If one is not specified, it will default to <OBJECT>.swiftdeps.

Swift_DIAGNOSTICS_FILE

This property controls where the Swift diagnostics are serialized.

Symbolic

Is this just a name for a rule.

If SYMBOLIC (boolean) is set to True the build system will be informed that the source file is not actually created on disk but instead used as a symbolic name for a build rule.

Vs_copy_to_out_dir

Sets the <CopyToOutputDirectory> tag for a source file in a Visual Studio project file. Valid values are Never, Always and PreserveNewest.

VS_CSHARP_<tagname>

Visual Studio and CSharp source-file-specific configuration.

Tell the Visual Studio generators to set the source file tag <tagname> to a given value in the generated Visual Studio CSharp project. Ignored on other generators and languages. This property can be used to define dependencies between source files or set any other Visual Studio specific parameters.

Example usage:

set_source_files_property(<filename>
         PROPERTIES
         VS_CSHARP_DependentUpon <other file>
         VS_CSHARP_SubType "Form")

Vs_deployment_content

Mark a source file as content for deployment with a Windows Phone or Windows Store application when built with a Visual Studio generators. The value must evaluate to either 1 or 0 and may use generator expressions to make the choice based on the build configuration. The .vcxproj file entry for the source file will be marked either DeploymentContent or ExcludedFromBuild for values 1 and 0, respectively.

Vs_deployment_location

Specifies the deployment location for a content source file with a Windows Phone or Windows Store application when built with a Visual Studio generators. This property is only applicable when using Vs_deployment_content. The value represent the path relative to the app package and applies to all configurations.

Vs_include_in_vsix

Boolean property to specify if the file should be included within a VSIX (Visual Studio Integration Extension) extension package. This is needed for development of Visual Studio extensions.

Vs_resource_generator

This property allows to specify the resource generator to be used on this file. It defaults to PublicResXFileCodeGenerator if not set.

This property only applies to C# projects.

Vs_shader_disable_optimizations

Disable compiler optimizations for an .hlsl source file.  This adds the -Od flag to the command line for the FxCompiler tool.  Specify the value true for this property to disable compiler optimizations.

Vs_shader_enable_debug

Enable debugging information for an .hlsl source file.  This adds the -Zi flag to the command line for the FxCompiler tool.  Specify the value true to generate debugging information for the compiled shader.

Vs_shader_entrypoint

Specifies the name of the entry point for the shader of a .hlsl source file.

Vs_shader_flags

Set additional Visual Studio shader flags of a .hlsl source file.

Vs_shader_model

Specifies the shader model of a .hlsl source file. Some shader types can only be used with recent shader models

Vs_shader_object_file_name

Specifies a file name for the compiled shader object file for an .hlsl source file.  This adds the -Fo flag to the command line for the FxCompiler tool.

Vs_shader_output_header_file

Set filename for output header file containing object code of a .hlsl source file.

Vs_shader_type

Set the Visual Studio shader type of a .hlsl source file.

Vs_shader_variable_name

Set name of variable in header file containing object code of a .hlsl source file.

Vs_tool_override

Override the default Visual Studio tool that will be applied to the source file with a new tool not based on the extension of the file.

Vs_xaml_type

Mark a Extensible Application Markup Language (XAML) source file as a different type than the default Page. The most common usage would be to set the default App.xaml file as ApplicationDefinition.

Wrap_exclude

Exclude this source file from any code wrapping techniques.

Some packages can wrap source files into alternate languages to provide additional functionality.

For example, C++ code can be wrapped into Java or Python, using SWIG. If WRAP_EXCLUDE is set to True, that indicates that this source file should not be wrapped.

Xcode_explicit_file_type

Set the Xcode explicitFileType attribute on its reference to a source file.  CMake computes a default based on file extension but can be told explicitly with this property.

See also Xcode_last_known_file_type.

Xcode_file_attributes

Add values to the Xcode ATTRIBUTES setting on its reference to a source file.  Among other things, this can be used to set the role on a .mig file:

set_source_files_properties(defs.mig
    PROPERTIES
        XCODE_FILE_ATTRIBUTES "Client;Server"
)

Xcode_last_known_file_type

Set the Xcode lastKnownFileType attribute on its reference to a source file.  CMake computes a default based on file extension but can be told explicitly with this property.

See also Xcode_explicit_file_type, which is preferred over this property if set.

Properties on Cache Entries

Advanced

True if entry should be hidden by default in GUIs.

This is a boolean value indicating whether the entry is considered interesting only for advanced configuration.  The mark_as_advanced() command modifies this property.

Helpstring

Help associated with entry in GUIs.

This string summarizes the purpose of an entry to help users set it through a CMake GUI.

Modified

Internal management property.  Do not set or get.

This is an internal cache entry property managed by CMake to track interactive user modification of entries.  Ignore it.

Strings

Enumerate possible STRING entry values for GUI selection.

For cache entries with type STRING, this enumerates a set of values. CMake GUIs may use this to provide a selection widget instead of a generic string entry field.  This is for convenience only.  CMake does not enforce that the value matches one of those listed.

Type

Widget type for entry in GUIs.

Cache entry values are always strings, but CMake GUIs present widgets to help users set values.  The GUIs use this property as a hint to determine the widget type.  Valid Type values are:

BOOL          = Boolean ON/OFF value.
PATH          = Path to a directory.
FILEPATH      = Path to a file.
STRING        = Generic string value.
INTERNAL      = Do not present in GUI at all.
STATIC        = Value managed by CMake, do not change.
UNINITIALIZED = Type not yet specified.

Generally the Type of a cache entry should be set by the command which creates it ( set(), option(), find_library(), etc.).

Value

Value of a cache entry.

This property maps to the actual value of a cache entry.  Setting this property always sets the value without checking, so use with care.

Properties on Installed Files

Cpack_desktop_shortcuts

Species a list of shortcut names that should be created on the Desktop for this file.

The property is currently only supported by the CPack WIX Generator.

Cpack_never_overwrite

Request that this file not be overwritten on install or reinstall.

The property is currently only supported by the CPack WIX Generator.

Cpack_permanent

Request that this file not be removed on uninstall.

The property is currently only supported by the CPack WIX Generator.

Cpack_start_menu_shortcuts

Species a list of shortcut names that should be created in the Start Menu for this file.

The property is currently only supported by the CPack WIX Generator.

Cpack_startup_shortcuts

Species a list of shortcut names that should be created in the Startup folder for this file.

The property is currently only supported by the CPack WIX Generator.

Cpack_wix_acl

Specifies access permissions for files or directories installed by a WiX installer.

The property can contain multiple list entries, each of which has to match the following format.

<user>[@<domain>]=<permission>[,<permission>]

<user> and <domain> specify the windows user and domain for which the <Permission> element should be generated.

<permission> is any of the YesNoType attributes listed here:

http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html

The property is currently only supported by the CPack WIX Generator.

Deprecated Properties on Directories

Additional_make_clean_files

Deprecated since version 3.15: Use Additional_clean_files instead.

Additional files to remove during the clean stage.

A ;-list of files that will be removed as a part of the make clean target.

Arguments to ADDITIONAL_MAKE_CLEAN_FILES may use generator expressions.

This property only works for the Makefile generators. It is ignored on other generators.

Compile_definitions_<Config>

Ignored.  See CMake Policy CMP0043.

Per-configuration preprocessor definitions in a directory.

This is the configuration-specific version of Compile_definitions where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).

This property will be initialized in each directory by its value in the directory’s parent.

Contents of COMPILE_DEFINITIONS_<CONFIG> may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Generator expressions should be preferred instead of setting this property.

Test_include_file

Deprecated.  Use Test_include_files instead.

A cmake file that will be included when ctest is run.

If you specify TEST_INCLUDE_FILE, that file will be included and processed when ctest is run on the directory.

Deprecated Properties on Targets

Compile_definitions_<Config>

Ignored.  See CMake Policy CMP0043.

Per-configuration preprocessor definitions on a target.

This is the configuration-specific version of Compile_definitions where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).

Contents of COMPILE_DEFINITIONS_<CONFIG> may use “generator expressions” with the syntax $<...>.  See the cmake-generator-expressions(7) manual for available expressions.  See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Generator expressions should be preferred instead of setting this property.

Post_install_script

Deprecated install support.

The Pre_install_script and POST_INSTALL_SCRIPT properties are the old way to specify CMake scripts to run before and after installing a target.  They are used only when the old INSTALL_TARGETS command is used to install the target.  Use the install() command instead.

Pre_install_script

Deprecated install support.

The PRE_INSTALL_SCRIPT and Post_install_script properties are the old way to specify CMake scripts to run before and after installing a target.  They are used only when the old INSTALL_TARGETS command is used to install the target.  Use the install() command instead.

Deprecated Properties on Source Files

Compile_definitions_<Config>

Ignored.  See CMake Policy CMP0043.

Per-configuration preprocessor definitions on a source file.

This is the configuration-specific version of Compile_definitions. Note that Xcode does not support per-configuration source file flags so this property will be ignored by the Xcode generator.

Referenced By

ccmake(1), cmake(1), cmake-commands(7), cmake-gui(1), cpack(1), ctest(1).

Nov 26, 2019 3.16.0 CMake