Cmake message fatal error

block([SCOPE_FOR [POLICIES] [VARIABLES] ] [PROPAGATE <var-name>...])


  <commands>
endblock()

SCOPE_FOR

Specify which scopes must be created.

If SCOPE_FOR is not specified, this is equivalent to:

block(SCOPE_FOR VARIABLES POLICIES)

PROPAGATE

When a variable scope is created by the block() command, this
option sets or unsets the specified variables in the parent scope. This is
equivalent to set(PARENT_SCOPE) or unset(PARENT_SCOPE)
commands.

set(var1 "INIT1")
set(var2 "INIT2")
block(PROPAGATE var1 var2)


  set(var1 "VALUE1")


  unset(var2)
endblock()
# Now var1 holds VALUE1, and var2 is unset

This option is only allowed when a variable scope is created. An
error will be raised in the other cases.

while(TRUE)


  block()


     ...


     # the break() command will terminate the while() command


     break()


  endblock()
endwhile()

• endblock()
• return()
• cmake_policy()

Query host system specific information


  cmake_host_system_information(RESULT <variable> QUERY <key> ...)
Query Windows registry


  cmake_host_system_information(RESULT <variable> QUERY WINDOWS_REGISTRY <key> ...)

cmake_host_system_information(RESULT <variable> QUERY <key> ...)

NUMBER_OF_LOGICAL_CORES

Number of logical cores

NUMBER_OF_PHYSICAL_CORES

Number of physical cores

HOSTNAME

Hostname

FQDN

Fully qualified domain name

TOTAL_VIRTUAL_MEMORY

Total virtual memory in MiB [1]

AVAILABLE_VIRTUAL_MEMORY

Available virtual memory in MiB [1]

TOTAL_PHYSICAL_MEMORY

Total physical memory in MiB [1]

AVAILABLE_PHYSICAL_MEMORY

Available physical memory in MiB [1]

IS_64BIT

New in version 3.10.

One if processor is 64Bit

HAS_FPU

New in version 3.10.

One if processor has floating point unit

HAS_MMX

New in version 3.10.

One if processor supports MMX instructions

HAS_MMX_PLUS

New in version 3.10.

One if processor supports Ext. MMX instructions

HAS_SSE

New in version 3.10.

One if processor supports SSE instructions

HAS_SSE2

New in version 3.10.

One if processor supports SSE2 instructions

HAS_SSE_FP

New in version 3.10.

One if processor supports SSE FP instructions

HAS_SSE_MMX

New in version 3.10.

One if processor supports SSE MMX instructions

HAS_AMD_3DNOW

New in version 3.10.

One if processor supports 3DNow instructions

HAS_AMD_3DNOW_PLUS

New in version 3.10.

One if processor supports 3DNow+ instructions

HAS_IA64

New in version 3.10.

One if IA64 processor emulating x86

HAS_SERIAL_NUMBER

New in version 3.10.

One if processor has serial number

PROCESSOR_SERIAL_NUMBER

New in version 3.10.

Processor serial number

PROCESSOR_NAME

New in version 3.10.

Human readable processor name

PROCESSOR_DESCRIPTION

New in version 3.10.

Human readable full processor description

OS_NAME

New in version 3.10.

See CMAKE_HOST_SYSTEM_NAME

OS_RELEASE

New in version 3.10.

The OS sub-type e.g. on Windows Professional

OS_VERSION

New in version 3.10.

The OS build ID

OS_PLATFORM

New in version 3.10.

See CMAKE_HOST_SYSTEM_PROCESSOR

DISTRIB_INFO

New in version 3.22.

Read /etc/os-release file and define the given
<variable> into a list of read variables

DISTRIB_<name>

New in version 3.22.

Get the <name> variable (see man 5
os-release) if it exists in the /etc/os-release file

Example:

cmake_host_system_information(RESULT PRETTY_NAME QUERY DISTRIB_PRETTY_NAME)
message(STATUS "${PRETTY_NAME}")
cmake_host_system_information(RESULT DISTRO QUERY DISTRIB_INFO)
foreach(VAR IN LISTS DISTRO)


  message(STATUS "${VAR}=`${${VAR}}`")
endforeach()

Output:

-- Ubuntu 20.04.2 LTS
-- DISTRO_BUG_REPORT_URL=`https://bugs.launchpad.net/ubuntu/`
-- DISTRO_HOME_URL=`https://www.ubuntu.com/`
-- DISTRO_ID=`ubuntu`
-- DISTRO_ID_LIKE=`debian`
-- DISTRO_NAME=`Ubuntu`
-- DISTRO_PRETTY_NAME=`Ubuntu 20.04.2 LTS`
-- DISTRO_PRIVACY_POLICY_URL=`https://www.ubuntu.com/legal/terms-and-policies/privacy-policy`
-- DISTRO_SUPPORT_URL=`https://help.ubuntu.com/`
-- DISTRO_UBUNTU_CODENAME=`focal`
-- DISTRO_VERSION=`20.04.2 LTS (Focal Fossa)`
-- DISTRO_VERSION_CODENAME=`focal`
-- DISTRO_VERSION_ID=`20.04`

CMAKE_GET_OS_RELEASE_FALLBACK_SCRIPTS

In addition to the scripts shipped with CMake, a user may append full
paths to his script(s) to the this list. The script filename has the
following format: NNN-<name>.cmake, where NNN is three
digits used to apply collected scripts in a specific order.

CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_<varname>

Variables collected by the user provided fallback script ought to be
assigned to CMake variables using this naming convention. Example, the
ID variable from the manual becomes
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID.

CMAKE_GET_OS_RELEASE_FALLBACK_RESULT

The fallback script ought to store names of all assigned
CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_<varname> variables in
this list.

# Try to detect some old distribution
# See also
# - http://linuxmafia.com/faq/Admin/release-files.html
#
if(NOT EXISTS "${CMAKE_SYSROOT}/etc/foobar-release")


  return()
endif()
# Get the first string only
file(


    STRINGS "${CMAKE_SYSROOT}/etc/foobar-release" CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT


    LIMIT_COUNT 1


  )
#
# Example:
#
#   Foobar distribution release 1.2.3 (server)
#
if(CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT MATCHES "Foobar distribution release ([0-9.]+) .*")


  set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_NAME Foobar)


  set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_PRETTY_NAME "${CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT}")


  set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID foobar)


  set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION ${CMAKE_MATCH_1})


  set(CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION_ID ${CMAKE_MATCH_1})


  list(


      APPEND CMAKE_GET_OS_RELEASE_FALLBACK_RESULT


      CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_NAME


      CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_PRETTY_NAME


      CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_ID


      CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION


      CMAKE_GET_OS_RELEASE_FALLBACK_RESULT_VERSION_ID


    )
endif()
unset(CMAKE_GET_OS_RELEASE_FALLBACK_CONTENT)

cmake_host_system_information(RESULT <variable>


                              QUERY WINDOWS_REGISTRY <key> [VALUE_NAMES|SUBKEYS|VALUE <name>]


                              [VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]


                              [SEPARATOR <separator>]


                              [ERROR_VARIABLE <result>])

Querying registry for any other platforms than
Windows, including CYGWIN, will always returns an empty string
and sets an error message in the variable specified with sub-option
ERROR_VARIABLE.

• HKLM or HKEY_LOCAL_MACHINE
• HKCU or HKEY_CURRENT_USER
• HKCR or HKEY_CLASSES_ROOT
• HKU or HKEY_USERS
• HKCC or HKEY_CURRENT_CONFIG

cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKLM")
cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware")
cmake_host_system_information(RESULT result QUERY WINDOWS_REGISTRY "HKCU\SOFTWARE\Kitware")

VALUE_NAMES

Request the list of value names defined under <key>. If a
default value is defined, it will be identified with the special name
(default).

SUBKEYS

Request the list of subkeys defined under <key>.

VALUE
<name>

Request the data stored in value named <name>. If
VALUE is not specified or argument is the special name
(default), the content of the default value, if any, will be
returned.

# query default value for HKLM/SOFTWARE/Kitware key
cmake_host_system_information(RESULT result


                              QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware")
# query default value for HKLM/SOFTWARE/Kitware key using special value name
cmake_host_system_information(RESULT result


                              QUERY WINDOWS_REGISTRY "HKLM/SOFTWARE/Kitware"


                              VALUE "(default)")

Supported types are:

For all other types, an empty string is returned.

VIEW

Specify which registry views must be queried. When not specified,
BOTH view is used.

SEPARATOR

Specify the separator character for REG_MULTI_SZ type. When not
specified, the character is used.

ERROR_VARIABLE
<result>

Returns any error raised during query operation. In case of success, the
variable holds an empty string.

cmake_language(CALL <command> [<arg>...])
cmake_language(EVAL CODE <code>...)
cmake_language(DEFER <options>... CALL <command> [<arg>...])
cmake_language(SET_DEPENDENCY_PROVIDER <command> SUPPORTED_METHODS <methods>...)
cmake_language(GET_MESSAGE_LOG_LEVEL <out-var>)

cmake_language(CALL <command> [<arg>...])

set(message_command "message")
cmake_language(CALL ${message_command} STATUS "Hello World!")

message(STATUS "Hello World!")

To ensure consistency of the code, the following commands
are not allowed:

cmake_language(EVAL CODE <code>...)

set(A TRUE)
set(B TRUE)
set(C TRUE)
set(condition "(A AND B) OR C")
cmake_language(EVAL CODE "


  if (${condition})


    message(STATUS TRUE)


  else()


    message(STATUS FALSE)


  endif()"
)

set(A TRUE)
set(B TRUE)
set(C TRUE)
set(condition "(A AND B) OR C")
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/eval.cmake "


  if (${condition})


    message(STATUS TRUE)


  else()


    message(STATUS FALSE)


  endif()"
)
include(${CMAKE_CURRENT_BINARY_DIR}/eval.cmake)

cmake_language(DEFER <options>... CALL <command> [<arg>...])

DIRECTORY
<dir>

Schedule the call for the end of the given directory instead of the
current directory. The <dir> may reference either a source
directory or its corresponding binary directory. Relative paths are
treated as relative to the current source directory.

The given directory must be known to CMake, being either the
top-level directory or one added by add_subdirectory().
Furthermore, the given directory must not yet be finished processing.
This means it can be the current directory or one of its ancestors.

ID
<id>

Specify an identification for the deferred call. The <id> may
not be empty and may not begin with a capital letter A-Z. The
<id> may begin with an underscore (_) only if it was
generated automatically by an earlier call that used ID_VAR to get
the id.

ID_VAR
<var>

Specify a variable in which to store the identification for the deferred
call. If ID <id> is not given, a new identification will be
generated and the generated id will start with an underscore
(_).

cmake_language(DEFER [DIRECTORY <dir>] GET_CALL_IDS <var>)

cmake_language(DEFER [DIRECTORY <dir>] GET_CALL <id> <var>)

cmake_language(DEFER [DIRECTORY <dir>] CANCEL_CALL <id>...)

cmake_language(DEFER CALL message "${deferred_message}")
cmake_language(DEFER ID_VAR id CALL message "Canceled Message")
cmake_language(DEFER CANCEL_CALL ${id})
message("Immediate Message")
set(deferred_message "Deferred Message")

Immediate Message
Deferred Message

set(deferred_message "Deferred Message 1")
set(re_evaluated [[${deferred_message}]])
cmake_language(EVAL CODE "


  cmake_language(DEFER CALL message [[${deferred_message}]])


  cmake_language(DEFER CALL message "${re_evaluated}")
")
message("Immediate Message")
set(deferred_message "Deferred Message 2")

Immediate Message
Deferred Message 1
Deferred Message 2

A high-level introduction to this feature can be found in
the Using Dependencies Guide.

cmake_language(SET_DEPENDENCY_PROVIDER <command>


               SUPPORTED_METHODS <methods>...)

FIND_PACKAGE

The provider command accepts find_package() requests.

FETCHCONTENT_MAKEAVAILABLE_SERIAL

The provider command accepts FetchContent_MakeAvailable() requests.
It expects each dependency to be fed to the provider command one at a
time, not the whole list in one go.

The choice of dependency provider should always be under
the user’s control. As a convenience, a project may choose to provide a file
that users can list in their CMAKE_PROJECT_TOP_LEVEL_INCLUDES variable,
but the use of such a file should always be the user’s choice.

xxx_provide_dependency(<method> [<method-specific-args>...])

FIND_PACKAGE

The <method-specific-args> will be everything passed to the
find_package() call that requested the dependency. The first of
these <method-specific-args> will therefore always be the
name of the dependency. Dependency names are case-sensitive for this
method because find_package() treats them case-sensitively too.

If the provider command fulfills the request, it must set the
same variable that find_package() expects to be set. For a
dependency named depName, the provider must set
depName_FOUND to true if it fulfilled the request. If the
provider returns without setting this variable, CMake will assume the
request was not fulfilled and will fall back to the built-in
implementation.

If the provider needs to call the built-in
find_package() implementation as part of its processing, it can
do so by including the BYPASS_PROVIDER keyword as one of the
arguments.

FETCHCONTENT_MAKEAVAILABE_SERIAL

The <method-specific-args> will be everything passed to the
FetchContent_Declare() call that corresponds to the requested
dependency, with the following exceptions:

The first of the <method-specific-args> will always
be the name of the dependency. Dependency names are case-insensitive for
this method because FetchContent also treats them
case-insensitively.

If the provider fulfills the request, it should call
FetchContent_SetPopulated(), passing the name of the dependency as
the first argument. The SOURCE_DIR and BINARY_DIR arguments to
that command should only be given if the provider makes the dependency’s
source and build directories available in exactly the same way as the
built-in FetchContent_MakeAvailable() command.

If the provider returns without calling
FetchContent_SetPopulated() for the named dependency, CMake will
assume the request was not fulfilled and will fall back to the built-in
implementation.

Note that empty arguments may be significant for this method (e.g.
an empty string following a GIT_SUBMODULES keyword). Therefore, if
forwarding these arguments on to another command, extra care must be taken
to avoid such arguments being silently dropped.

If FETCHCONTENT_SOURCE_DIR_<uppercaseDepName> is set,
then the dependency provider will never see requests for the
<depName> dependency for this method. When the user sets such a
variable, they are explicitly overriding where to get that dependency from
and are taking on the responsibility that their overriding version meets any
requirements for that dependency and is compatible with whatever else in the
project uses it. Depending on the value of
FETCHCONTENT_TRY_FIND_PACKAGE_MODE and whether the
OVERRIDE_FIND_PACKAGE option was given to
FetchContent_Declare(), having
FETCHCONTENT_SOURCE_DIR_<uppercaseDepName> set may also prevent
the dependency provider from seeing requests for a
find_package(depName) call too.

# Always ensure we have the policy settings this provider expects
cmake_minimum_required(VERSION 3.24)
set(MYCOMP_PROVIDER_INSTALL_DIR ${CMAKE_BINARY_DIR}/mycomp_packages


  CACHE PATH "The directory this provider installs packages to"
)
# Tell the built-in implementation to look in our area first, unless
# the find_package() call uses NO_..._PATH options to exclude it
list(APPEND CMAKE_MODULE_PATH ${MYCOMP_PROVIDER_INSTALL_DIR}/cmake)
list(APPEND CMAKE_PREFIX_PATH ${MYCOMP_PROVIDER_INSTALL_DIR})
macro(mycomp_provide_dependency method package_name)


  execute_process(


    COMMAND some_tool ${package_name} --installdir ${MYCOMP_PROVIDER_INSTALL_DIR}


    COMMAND_ERROR_IS_FATAL ANY


  )
endmacro()
cmake_language(


  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency


  SUPPORTED_METHODS FIND_PACKAGE
)

cmake -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/path/to/mycomp_provider.cmake ...

cmake_minimum_required(VERSION 3.24)
# Because we declare this very early, it will take precedence over any
# details the project might declare later for the same thing
include(FetchContent)
FetchContent_Declare(


  googletest


  GIT_REPOSITORY https://github.com/google/googletest.git


  GIT_TAG        e2239ee6043f73722e7aa812a459f54a28552929 # release-1.11.0
)
# Both FIND_PACKAGE and FETCHCONTENT_MAKEAVAILABLE_SERIAL methods provide
# the package or dependency name as the first method-specific argument.
macro(mycomp_provide_dependency method dep_name)


  if("${dep_name}" MATCHES "^(gtest|googletest)$")


    # Save our current command arguments in case we are called recursively


    list(APPEND mycomp_provider_args ${method} ${dep_name})


    # This will forward to the built-in FetchContent implementation,


    # which detects a recursive call for the same thing and avoids calling


    # the provider again if dep_name is the same as the current call.


    FetchContent_MakeAvailable(googletest)


    # Restore our command arguments


    list(POP_BACK mycomp_provider_args dep_name method)


    # Tell the caller we fulfilled the request


    if("${method}" STREQUAL "FIND_PACKAGE")


      # We need to set this if we got here from a find_package() call


      # since we used a different method to fulfill the request.


      # This example assumes projects only use the gtest targets,


      # not any of the variables the FindGTest module may define.


      set(${dep_name}_FOUND TRUE)


    elseif(NOT "${dep_name}" STREQUAL "googletest")


      # We used the same method, but were given a different name to the


      # one we populated with. Tell the caller about the name it used.


      FetchContent_SetPopulated(${dep_name}


        SOURCE_DIR "${googletest_SOURCE_DIR}"


        BINARY_DIR "${googletest_BINARY_DIR}"


      )


    endif()


  endif()
endmacro()
cmake_language(


  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency


  SUPPORTED_METHODS


    FIND_PACKAGE


    FETCHCONTENT_MAKEAVAILABLE_SERIAL
)

cmake_minimum_required(VERSION 3.24)
macro(mycomp_provide_dependency method)


  find_package(${ARGN} BYPASS_PROVIDER QUIET)
endmacro()
cmake_language(


  SET_DEPENDENCY_PROVIDER mycomp_provide_dependency


  SUPPORTED_METHODS FIND_PACKAGE
)

cmake_language(GET_MESSAGE_LOG_LEVEL <output_variable>)

cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])

Call the cmake_minimum_required() command at the
beginning of the top-level CMakeLists.txt file even before calling the
project() command. It is important to establish version and policy
settings before invoking other commands whose behavior they may affect. See
also policy CMP0000.

Calling cmake_minimum_required() inside a function()
limits some effects to the function scope when invoked. For example, the
CMAKE_MINIMUM_REQUIRED_VERSION variable won’t be set in the calling
scope. Functions do not introduce their own policy scope though, so policy
settings of the caller will be affected (see below). Due to this mix
of things that do and do not affect the calling scope, calling
cmake_minimum_required() inside a function is generally
discouraged.

cmake_policy(VERSION <min>[...<max>])

cmake_policy(VERSION 2.4[...<max>])

cmake_parse_arguments(<prefix> <options> <one_value_keywords>


                      <multi_value_keywords> <args>...)
cmake_parse_arguments(PARSE_ARGV <N> <prefix> <options>


                      <one_value_keywords> <multi_value_keywords>)

macro(my_install)


    set(options OPTIONAL FAST)


    set(oneValueArgs DESTINATION RENAME)


    set(multiValueArgs TARGETS CONFIGURATIONS)


    cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}"


                          "${multiValueArgs}" ${ARGN} )


    # ...

my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub CONFIGURATIONS)

MY_INSTALL_OPTIONAL = TRUE
MY_INSTALL_FAST = FALSE # was not used in call to my_install
MY_INSTALL_DESTINATION = "bin"
MY_INSTALL_RENAME <UNDEFINED> # was not used
MY_INSTALL_TARGETS = "foo;bar"
MY_INSTALL_CONFIGURATIONS <UNDEFINED> # was not used
MY_INSTALL_UNPARSED_ARGUMENTS = "blub" # nothing expected after "OPTIONAL"
MY_INSTALL_KEYWORDS_MISSING_VALUES = "CONFIGURATIONS"


         # No value for "CONFIGURATIONS" given

The cmake_path command handles paths in the format
of the build system (i.e. the host platform), not the target system. When
cross-compiling, if the path contains elements that are not representable on
the host platform (e.g. a drive letter when the host is not Windows), the
results will be unpredictable.

Conventions
Path Structure And Terminology
Normalization
Decomposition


  cmake_path(GET <path-var> ROOT_NAME <out-var>)


  cmake_path(GET <path-var> ROOT_DIRECTORY <out-var>)


  cmake_path(GET <path-var> ROOT_PATH <out-var>)


  cmake_path(GET <path-var> FILENAME <out-var>)


  cmake_path(GET <path-var> EXTENSION [LAST_ONLY] <out-var>)


  cmake_path(GET <path-var> STEM [LAST_ONLY] <out-var>)


  cmake_path(GET <path-var> RELATIVE_PART <out-var>)


  cmake_path(GET <path-var> PARENT_PATH <out-var>)
Query


  cmake_path(HAS_ROOT_NAME <path-var> <out-var>)


  cmake_path(HAS_ROOT_DIRECTORY <path-var> <out-var>)


  cmake_path(HAS_ROOT_PATH <path-var> <out-var>)


  cmake_path(HAS_FILENAME <path-var> <out-var>)


  cmake_path(HAS_EXTENSION <path-var> <out-var>)


  cmake_path(HAS_STEM <path-var> <out-var>)


  cmake_path(HAS_RELATIVE_PART <path-var> <out-var>)


  cmake_path(HAS_PARENT_PATH <path-var> <out-var>)


  cmake_path(IS_ABSOLUTE <path-var> <out-var>)


  cmake_path(IS_RELATIVE <path-var> <out-var>)


  cmake_path(IS_PREFIX <path-var> <input> [NORMALIZE] <out-var>)


  cmake_path(COMPARE <input1> <OP> <input2> <out-var>)
Modification


  cmake_path(SET <path-var> [NORMALIZE] <input>)


  cmake_path(APPEND <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])


  cmake_path(APPEND_STRING <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])


  cmake_path(REMOVE_FILENAME <path-var> [OUTPUT_VARIABLE <out-var>])


  cmake_path(REPLACE_FILENAME <path-var> <input> [OUTPUT_VARIABLE <out-var>])


  cmake_path(REMOVE_EXTENSION <path-var> [LAST_ONLY] [OUTPUT_VARIABLE <out-var>])


  cmake_path(REPLACE_EXTENSION <path-var> [LAST_ONLY] <input> [OUTPUT_VARIABLE <out-var>])
Generation


  cmake_path(NORMAL_PATH <path-var> [OUTPUT_VARIABLE <out-var>])


  cmake_path(RELATIVE_PATH <path-var> [BASE_DIRECTORY <input>] [OUTPUT_VARIABLE <out-var>])


  cmake_path(ABSOLUTE_PATH <path-var> [BASE_DIRECTORY <input>] [NORMALIZE] [OUTPUT_VARIABLE <out-var>])
Native Conversion


  cmake_path(NATIVE_PATH <path-var> [NORMALIZE] <out-var>)


  cmake_path(CONVERT <input> TO_CMAKE_PATH_LIST <out-var> [NORMALIZE])


  cmake_path(CONVERT <input> TO_NATIVE_PATH_LIST <out-var> [NORMALIZE])
Hashing


  cmake_path(HASH <path-var> <out-var>)

<path-var>

Always the name of a variable. For commands that expect a
<path-var> as input, the variable must exist and it is
expected to hold a single path.

<input>

A string literal which may contain a path, path fragment, or multiple
paths with a special separator depending on the command. See the
description of each command to see how this is interpreted.

<input>…

Zero or more string literal arguments.

<out-var>

The name of a variable into which the result of a command will be
written.

root-name root-directory-separator (item-name directory-separator)* filename

root-name

Identifies the root on a filesystem with multiple roots (such as
«C:» or «//myserver»). It is
optional.

root-directory-separator

A directory separator that, if present, indicates that this path is
absolute. If it is missing and the first element other than the
root-name is an item-name, then the path is relative.

item-name

A sequence of characters that aren’t directory separators. This name may
identify a file, a hard link, a symbolic link, or a directory. Two special
cases are recognized:

The (…)* pattern shown above is to indicate that there
can be zero or more item names, with multiple items separated by a
directory-separator. The ()* characters are not part of the
path.

directory-separator

The only recognized directory separator is a forward slash character
/. If this character is repeated, it is treated as a single
directory separator. In other words, /usr///////lib is the same as
/usr/lib.

filename

A path has a filename if it does not end with a
directory-separator. The filename is effectively the last
item-name of the path, so it can also be a hard link, symbolic link
or a directory.

A filename can have an extension. By default,
the extension is defined as the sub-string beginning at the left-most
period (including the period) and until the end of the filename.
In commands that accept a LAST_ONLY keyword, LAST_ONLY
changes the interpretation to the sub-string beginning at the right-most
period.

The following exceptions apply to the above
interpretation:

The stem is the part of the filename before the
extension.

set(path1 "${CMAKE_CURRENT_SOURCE_DIR}/data")
cmake_path(SET path2 "${CMAKE_CURRENT_SOURCE_DIR}/data")
cmake_path(APPEND path3 "${CMAKE_CURRENT_SOURCE_DIR}" "data")

1.

If the path is empty, stop (the normalized form of an empty path is also
an empty path).

2.

Replace each directory-separator, which may consist of multiple
separators, with a single / (/a///b —> /a/b).

3.

Remove each solitary period (.) and any immediately following
directory-separator (/a/./b/. —> /a/b).

4.

Remove each item-name (other than ..) that is immediately
followed by a directory-separator and a .., along with any
immediately following directory-separator (/a/b/../c —>
a/c).

5.

If there is a root-directory, remove any .. and any
directory-separators immediately following them. The parent of the
root directory is treated as still the root directory (/../a —>
/a).

6.

If the last item-name is .., remove any trailing
directory-separator (../ —> ..).

7.

If the path is empty by this stage, add a dot (normal form of
./ is .).

cmake_path(GET <path-var> ROOT_NAME <out-var>)
cmake_path(GET <path-var> ROOT_DIRECTORY <out-var>)
cmake_path(GET <path-var> ROOT_PATH <out-var>)
cmake_path(GET <path-var> FILENAME <out-var>)
cmake_path(GET <path-var> EXTENSION [LAST_ONLY] <out-var>)
cmake_path(GET <path-var> STEM [LAST_ONLY] <out-var>)
cmake_path(GET <path-var> RELATIVE_PART <out-var>)
cmake_path(GET <path-var> PARENT_PATH <out-var>)

set(path "c:/a")
cmake_path(GET path ROOT_NAME rootName)
cmake_path(GET path ROOT_DIRECTORY rootDir)
cmake_path(GET path ROOT_PATH rootPath)
message("Root name is "${rootName}"")
message("Root directory is "${rootDir}"")
message("Root path is "${rootPath}"")

Root name is "c:"
Root directory is "/"
Root path is "c:/"

set(path "/a/b")
cmake_path(GET path FILENAME filename)
message("First filename is "${filename}"")
# Trailing slash means filename is empty
set(path "/a/b/")
cmake_path(GET path FILENAME filename)
message("Second filename is "${filename}"")

First filename is "b"
Second filename is ""

set(path "name.ext1.ext2")
cmake_path(GET path EXTENSION fullExt)
cmake_path(GET path STEM fullStem)
message("Full extension is "${fullExt}"")
message("Full stem is "${fullStem}"")
# Effect of LAST_ONLY
cmake_path(GET path EXTENSION LAST_ONLY lastExt)
cmake_path(GET path STEM LAST_ONLY lastStem)
message("Last extension is "${lastExt}"")
message("Last stem is "${lastStem}"")
# Special cases
set(dotPath "/a/.")
set(dotDotPath "/a/..")
set(someMorePath "/a/.some.more")
cmake_path(GET dotPath EXTENSION dotExt)
cmake_path(GET dotPath STEM dotStem)
cmake_path(GET dotDotPath EXTENSION dotDotExt)
cmake_path(GET dotDotPath STEM dotDotStem)
cmake_path(GET dotMorePath EXTENSION someMoreExt)
cmake_path(GET dotMorePath STEM someMoreStem)
message("Dot extension is "${dotExt}"")
message("Dot stem is "${dotStem}"")
message("Dot-dot extension is "${dotDotExt}"")
message("Dot-dot stem is "${dotDotStem}"")
message(".some.more extension is "${someMoreExt}"")
message(".some.more stem is "${someMoreStem}"")

Full extension is ".ext1.ext2"
Full stem is "name"
Last extension is ".ext2"
Last stem is "name.ext1"
Dot extension is ""
Dot stem is "."
Dot-dot extension is ""
Dot-dot stem is ".."
.some.more extension is ".more"
.some.more stem is ".some"

set(path "c:/a/b")
cmake_path(GET path RELATIVE_PART result)
message("Relative part is "${result}"")
set(path "c/d")
cmake_path(GET path RELATIVE_PART result)
message("Relative part is "${result}"")
set(path "/")
cmake_path(GET path RELATIVE_PART result)
message("Relative part is "${result}"")

Relative part is "a/b"
Relative part is "c/d"
Relative part is ""

set(path "c:/a/b")
cmake_path(GET path PARENT_PATH result)
message("Parent path is "${result}"")
set(path "c:/")
cmake_path(GET path PARENT_PATH result)
message("Parent path is "${result}"")

Parent path is "c:/a"
Parent path is "c:/"

cmake_path(HAS_ROOT_NAME <path-var> <out-var>)
cmake_path(HAS_ROOT_DIRECTORY <path-var> <out-var>)
cmake_path(HAS_ROOT_PATH <path-var> <out-var>)
cmake_path(HAS_FILENAME <path-var> <out-var>)
cmake_path(HAS_EXTENSION <path-var> <out-var>)
cmake_path(HAS_STEM <path-var> <out-var>)
cmake_path(HAS_RELATIVE_PART <path-var> <out-var>)
cmake_path(HAS_PARENT_PATH <path-var> <out-var>)

• For HAS_ROOT_PATH, a true result will only be returned if at least
  one of root-name or root-directory is non-empty.
• For HAS_PARENT_PATH, the root directory is also considered to have
  a parent, which will be itself. The result is true except if the path
  consists of just a filename.

cmake_path(IS_ABSOLUTE <path-var> <out-var>)

cmake_path(IS_RELATIVE <path-var> <out-var>)

cmake_path(IS_PREFIX <path-var> <input> [NORMALIZE] <out-var>)

set(path "/a/b/c")
cmake_path(IS_PREFIX path "/a/b/c/d" result) # result = true
cmake_path(IS_PREFIX path "/a/b" result)     # result = false
cmake_path(IS_PREFIX path "/x/y/z" result)   # result = false
set(path "/a/b")
cmake_path(IS_PREFIX path "/a/c/../b" NORMALIZE result)   # result = true

cmake_path(COMPARE <input1> EQUAL <input2> <out-var>)
cmake_path(COMPARE <input1> NOT_EQUAL <input2> <out-var>)

if(NOT <input1>.root_name() STREQUAL <input2>.root_name())


  return FALSE
if(<input1>.has_root_directory() XOR <input2>.has_root_directory())


  return FALSE
Return FALSE if a relative portion of <input1> is not lexicographically
equal to the relative portion of <input2>. This comparison is performed path
component-wise. If all of the components compare equal, then return TRUE.

Unlike most other cmake_path() subcommands, the
COMPARE subcommand takes literal strings as input, not the names of
variables.

cmake_path(SET <path-var> [NORMALIZE] <input>)

set(native_path "c:\a\b/..\c")
cmake_path(SET path "${native_path}")
message("CMake path is "${path}"")
cmake_path(SET path NORMALIZE "${native_path}")
message("Normalized CMake path is "${path}"")

CMake path is "c:/a/b/../c"
Normalized CMake path is "c:/a/c"

cmake_path(APPEND <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])

# <path> is the contents of <path-var>
if(<input>.is_absolute() OR


   (<input>.has_root_name() AND


    NOT <input>.root_name() STREQUAL <path>.root_name()))


  replace <path> with <input>


  return()
endif()
if(<input>.has_root_directory())


  remove any root-directory and the entire relative path from <path>
elseif(<path>.has_filename() OR


       (NOT <path-var>.has_root_directory() OR <path>.is_absolute()))


  append directory-separator to <path>
endif()
append <input> omitting any root-name to <path>

cmake_path(APPEND_STRING <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])

cmake_path(REMOVE_FILENAME <path-var> [OUTPUT_VARIABLE <out-var>])

set(path "/a/b")
cmake_path(REMOVE_FILENAME path)
message("First path is "${path}"")
# filename is now already empty, the following removes nothing
cmake_path(REMOVE_FILENAME path)
message("Second path is "${result}"")

First path is "/a/"
Second path is "/a/"

cmake_path(REPLACE_FILENAME <path-var> <input> [OUTPUT_VARIABLE <out-var>])

cmake_path(HAS_FILENAME path has_filename)
if(has_filename)


  cmake_path(REMOVE_FILENAME path)


  cmake_path(APPEND path input);
endif()

cmake_path(REMOVE_EXTENSION <path-var> [LAST_ONLY]


                                       [OUTPUT_VARIABLE <out-var>])

cmake_path(REPLACE_EXTENSION <path-var> [LAST_ONLY] <input>


                             [OUTPUT_VARIABLE <out-var>])

cmake_path(REMOVE_EXTENSION path)
if(NOT "input" MATCHES "^\.")


  cmake_path(APPEND_STRING path ".")
endif()
cmake_path(APPEND_STRING path "input")

cmake_path(NORMAL_PATH <path-var> [OUTPUT_VARIABLE <out-var>])

cmake_path(RELATIVE_PATH <path-var> [BASE_DIRECTORY <input>]


                                    [OUTPUT_VARIABLE <out-var>])

cmake_path(ABSOLUTE_PATH <path-var> [BASE_DIRECTORY <input>] [NORMALIZE]


                                    [OUTPUT_VARIABLE <out-var>])

cmake_path(NATIVE_PATH <path-var> [NORMALIZE] <out-var>)

cmake_path(CONVERT <input> TO_CMAKE_PATH_LIST <out-var> [NORMALIZE])

Unlike most other cmake_path() subcommands, the
CONVERT subcommand takes a literal string as input, not the name of a
variable.

cmake_path(CONVERT <input> TO_NATIVE_PATH_LIST <out-var> [NORMALIZE])

Unlike most other cmake_path() subcommands, the
CONVERT subcommand takes a literal string as input, not the name of a
variable.

set(paths "/a/b/c" "/x/y/z")
cmake_path(CONVERT "${paths}" TO_NATIVE_PATH_LIST native_paths)
message("Native path list is "${native_paths}"")

Native path list is "abc;xyz"

Native path list is "/a/b/c:/x/y/z"

cmake_path(HASH <path-var> <out-var>)

cmake_policy(VERSION <min>[...<max>])

cmake_policy(SET CMP<NNNN> NEW)
cmake_policy(SET CMP<NNNN> OLD)

The OLD behavior of a policy is deprecated by
definition and may be removed in a future version of CMake.

cmake_policy(GET CMP<NNNN> <variable>)

cmake_policy(PUSH)
cmake_policy(POP)

# stack management with cmake_policy()
function(my_func)


  cmake_policy(PUSH)


  cmake_policy(SET ...)


  if (<cond1>)


    ...


    cmake_policy(POP)


    return()


  elseif(<cond2>)


    ...


    cmake_policy(POP)


    return()


  endif()


  ...


  cmake_policy(POP)
endfunction()
# stack management with block()/endblock()
function(my_func)


  block(SCOPE_FOR POLICIES)


    cmake_policy(SET ...)


    if (<cond1>)


      ...


      return()


    elseif(<cond2>)


      ...


      return()


    endif()


    ...


  endblock()
endfunction()

configure_file(<input> <output>


               [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |


                FILE_PERMISSIONS <permissions>...]


               [COPYONLY] [ESCAPE_QUOTES] [@ONLY]


               [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

#  cmakedefine VAR
#  cmakedefine01 VAR

#  define VAR
#  define VAR 1

<input>

Path to the input file. A relative path is treated with respect to the
value of CMAKE_CURRENT_SOURCE_DIR. The input path must be a file,
not a directory.

<output>

Path to the output file or directory. A relative path is treated with
respect to the value of CMAKE_CURRENT_BINARY_DIR. If the path names
an existing directory the output file is placed in that directory with the
same file name as the input file. If the path contains non-existent
directories, they are created.

NO_SOURCE_PERMISSIONS

New in version 3.19.

Do not transfer the permissions of the input file to the
output file. The copied file permissions default to the standard 644
value (-rw-r—r—).

USE_SOURCE_PERMISSIONS

New in version 3.20.

Transfer the permissions of the input file to the output file.
This is already the default behavior if none of the three
permissions-related keywords are given (NO_SOURCE_PERMISSIONS,
USE_SOURCE_PERMISSIONS or FILE_PERMISSIONS). The
USE_SOURCE_PERMISSIONS keyword mostly serves as a way of making
the intended behavior clearer at the call site.

FILE_PERMISSIONS
<permissions>…

New in version 3.20.

Ignore the input file’s permissions and use the specified
<permissions> for the output file instead.

COPYONLY

Copy the file without replacing any variable references or other content.
This option may not be used with NEWLINE_STYLE.

ESCAPE_QUOTES

Escape any substituted quotes with backslashes (C-style).

@ONLY

Restrict variable replacement to references of the form @VAR@. This
is useful for configuring scripts that use ${VAR} syntax.

NEWLINE_STYLE
<style>

Specify the newline style for the output file. Specify UNIX or
LF for n newlines, or specify DOS, WIN32, or
CRLF for rn newlines. This option may not be used with
COPYONLY.

#cmakedefine FOO_ENABLE
#cmakedefine FOO_STRING "@FOO_STRING@"

option(FOO_ENABLE "Enable Foo" ON)
if(FOO_ENABLE)


  set(FOO_STRING "foo")
endif()
configure_file(foo.h.in foo.h @ONLY)

#define FOO_ENABLE
#define FOO_STRING "foo"

/* #undef FOO_ENABLE */
/* #undef FOO_STRING */

include_directories(${CMAKE_CURRENT_BINARY_DIR})

execute_process(COMMAND <cmd1> [<arguments>]


                [COMMAND <cmd2> [<arguments>]]...


                [WORKING_DIRECTORY <directory>]


                [TIMEOUT <seconds>]


                [RESULT_VARIABLE <variable>]


                [RESULTS_VARIABLE <variable>]


                [OUTPUT_VARIABLE <variable>]


                [ERROR_VARIABLE <variable>]


                [INPUT_FILE <file>]


                [OUTPUT_FILE <file>]


                [ERROR_FILE <file>]


                [OUTPUT_QUIET]


                [ERROR_QUIET]


                [COMMAND_ECHO <where>]


                [OUTPUT_STRIP_TRAILING_WHITESPACE]


                [ERROR_STRIP_TRAILING_WHITESPACE]


                [ENCODING <name>]


                [ECHO_OUTPUT_VARIABLE]


                [ECHO_ERROR_VARIABLE]


                [COMMAND_ERROR_IS_FATAL <ANY|LAST>])

COMMAND

A child process command line.

CMake executes the child process using operating system APIs
directly:

No intermediate shell is used, so shell operators such as
> are treated as normal arguments. (Use the INPUT_*,
OUTPUT_*, and ERROR_* options to redirect stdin, stdout, and
stderr.)

If a sequential execution of multiple commands is required, use
multiple execute_process() calls with a single COMMAND
argument.

WORKING_DIRECTORY

The named directory will be set as the current working directory of the
child processes.

TIMEOUT

After the specified number of seconds (fractions allowed), all unfinished
child processes will be terminated, and the RESULT_VARIABLE will be
set to a string mentioning the «timeout».

RESULT_VARIABLE

The variable will be set to contain the result of last child process. This
will be an integer return code from the last child or a string describing
an error condition.

RESULTS_VARIABLE
<variable>

New in version 3.10.

The variable will be set to contain the result of all
processes as a semicolon-separated list, in order of the given
COMMAND arguments. Each entry will be an integer return code from
the corresponding child or a string describing an error condition.

OUTPUT_VARIABLE,
ERROR_VARIABLE

The variable named will be set with the contents of the standard output
and standard error pipes, respectively. If the same variable is named for
both pipes their output will be merged in the order produced.

INPUT_FILE,
OUTPUT_FILE, ERROR_FILE

The file named will be attached to the standard input of the first
process, standard output of the last process, or standard error of all
processes, respectively.

New in version 3.3: If the same file is named for both output
and error then it will be used for both.

OUTPUT_QUIET,
ERROR_QUIET

The standard output or standard error results will be quietly
ignored.

COMMAND_ECHO
<where>

New in version 3.15.

The command being run will be echo’ed to <where>
with <where> being set to one of STDERR,
STDOUT or NONE. See the
CMAKE_EXECUTE_PROCESS_COMMAND_ECHO variable for a way to control
the default behavior when this option is not present.

ENCODING
<name>

New in version 3.8.

On Windows, the encoding that is used to decode output from
the process. Ignored on other platforms. Valid encoding names are:

ECHO_OUTPUT_VARIABLE,
ECHO_ERROR_VARIABLE

New in version 3.18.

The standard output or standard error will not be exclusively
redirected to the configured variables.

The output will be duplicated, it will be sent into the
configured variables and also on standard output or standard error.

This is analogous to the tee Unix command.

COMMAND_ERROR_IS_FATAL
<ANY|LAST>

New in version 3.19.

The option following COMMAND_ERROR_IS_FATAL determines
the behavior when an error is encountered:

The sub-commands RELATIVE_PATH,
TO_CMAKE_PATH and TO_NATIVE_PATH has been superseded,
respectively, by sub-commands RELATIVE_PATH, CONVERT …
TO_CMAKE_PATH_LIST and CONVERT … TO_NATIVE_PATH_LIST of
cmake_path() command.

Reading


  file(READ <filename> <out-var> [...])


  file(STRINGS <filename> <out-var> [...])


  file(<HASH> <filename> <out-var>)


  file(TIMESTAMP <filename> <out-var> [...])


  file(GET_RUNTIME_DEPENDENCIES [...])
Writing


  file({WRITE | APPEND} <filename> <content>...)


  file({TOUCH | TOUCH_NOCREATE} [<file>...])


  file(GENERATE OUTPUT <output-file> [...])


  file(CONFIGURE OUTPUT <output-file> CONTENT <content> [...])
Filesystem


  file({GLOB | GLOB_RECURSE} <out-var> [...] [<globbing-expr>...])


  file(MAKE_DIRECTORY [<dir>...])


  file({REMOVE | REMOVE_RECURSE } [<files>...])


  file(RENAME <oldname> <newname> [...])


  file(COPY_FILE <oldname> <newname> [...])


  file({COPY | INSTALL} <file>... DESTINATION <dir> [...])


  file(SIZE <filename> <out-var>)


  file(READ_SYMLINK <linkname> <out-var>)


  file(CREATE_LINK <original> <linkname> [...])


  file(CHMOD <files>... <directories>... PERMISSIONS <permissions>... [...])


  file(CHMOD_RECURSE <files>... <directories>... PERMISSIONS <permissions>... [...])
Path Conversion


  file(REAL_PATH <path> <out-var> [BASE_DIRECTORY <dir>] [EXPAND_TILDE])


  file(RELATIVE_PATH <out-var> <directory> <file>)


  file({TO_CMAKE_PATH | TO_NATIVE_PATH} <path> <out-var>)
Transfer


  file(DOWNLOAD <url> [<file>] [...])


  file(UPLOAD <file> <url> [...])
Locking


  file(LOCK <path> [...])
Archiving


  file(ARCHIVE_CREATE OUTPUT <archive> PATHS <paths>... [...])


  file(ARCHIVE_EXTRACT INPUT <archive> [...])

file(READ <filename> <variable>


     [OFFSET <offset>] [LIMIT <max-in>] [HEX])

file(STRINGS <filename> <variable> [<options>...])

LENGTH_MAXIMUM
<max-len>

Consider only strings of at most a given length.

LENGTH_MINIMUM
<min-len>

Consider only strings of at least a given length.

LIMIT_COUNT
<max-num>

Limit the number of distinct strings to be extracted.

LIMIT_INPUT
<max-in>

Limit the number of input bytes to read from the file.

LIMIT_OUTPUT
<max-out>

Limit the number of total bytes to store in the
<variable>.

NEWLINE_CONSUME

Treat newline characters (n, LF) as part of string content instead
of terminating at them.

NO_HEX_CONVERSION

Intel Hex and Motorola S-record files are automatically converted to
binary while reading unless this option is given.

REGEX
<regex>

Consider only strings that match the given regular expression, as
described under string(REGEX).

ENCODING
<encoding-type>

New in version 3.1.

Consider strings of a given encoding. Currently supported
encodings are: UTF-8, UTF-16LE, UTF-16BE,
UTF-32LE, UTF-32BE. If the ENCODING option is not
provided and the file has a Byte Order Mark, the ENCODING option
will be defaulted to respect the Byte Order Mark.

New in version 3.2: Added the UTF-16LE,
UTF-16BE, UTF-32LE, UTF-32BE encodings.

file(STRINGS myfile.txt myfile)

file(<HASH> <filename> <variable>)

file(TIMESTAMP <filename> <variable> [<format>] [UTC])

file(GET_RUNTIME_DEPENDENCIES


  [RESOLVED_DEPENDENCIES_VAR <deps_var>]


  [UNRESOLVED_DEPENDENCIES_VAR <unresolved_deps_var>]


  [CONFLICTING_DEPENDENCIES_PREFIX <conflicting_deps_prefix>]


  [EXECUTABLES [<executable_files>...]]


  [LIBRARIES [<library_files>...]]


  [MODULES [<module_files>...]]


  [DIRECTORIES [<directories>...]]


  [BUNDLE_EXECUTABLE <bundle_executable_file>]


  [PRE_INCLUDE_REGEXES [<regexes>...]]


  [PRE_EXCLUDE_REGEXES [<regexes>...]]


  [POST_INCLUDE_REGEXES [<regexes>...]]


  [POST_EXCLUDE_REGEXES [<regexes>...]]


  [POST_INCLUDE_FILES [<files>...]]


  [POST_EXCLUDE_FILES [<files>...]]


  )

install(CODE [[


  file(GET_RUNTIME_DEPENDENCIES


    # ...


    )


  ]])

RESOLVED_DEPENDENCIES_VAR
<deps_var>

Name of the variable in which to store the list of resolved
dependencies.

UNRESOLVED_DEPENDENCIES_VAR
<unresolved_deps_var>

Name of the variable in which to store the list of unresolved
dependencies. If this variable is not specified, and there are any
unresolved dependencies, an error is issued.

CONFLICTING_DEPENDENCIES_PREFIX
<conflicting_deps_prefix>

Variable prefix in which to store conflicting dependency information.
Dependencies are conflicting if two files with the same name are found in
two different directories. The list of filenames that conflict are stored
in <conflicting_deps_prefix>_FILENAMES. For each filename,
the list of paths that were found for that filename are stored in
<conflicting_deps_prefix>_<filename>.

EXECUTABLES
<executable_files>

List of executable files to read for dependencies. These are executables
that are typically created with add_executable(), but they do not
have to be created by CMake. On Apple platforms, the paths to these files
determine the value of @executable_path when recursively resolving
the libraries. Specifying any kind of library (STATIC,
MODULE, or SHARED) here will result in undefined
behavior.

LIBRARIES
<library_files>

List of library files to read for dependencies. These are libraries that
are typically created with add_library(SHARED), but they do not
have to be created by CMake. Specifying STATIC libraries,
MODULE libraries, or executables here will result in undefined
behavior.

MODULES
<module_files>

List of loadable module files to read for dependencies. These are modules
that are typically created with add_library(MODULE), but they do
not have to be created by CMake. They are typically used by calling
dlopen() at runtime rather than linked at link time with ld
-l. Specifying STATIC libraries, SHARED libraries, or
executables here will result in undefined behavior.

DIRECTORIES
<directories>

List of additional directories to search for dependencies. On Linux
platforms, these directories are searched if the dependency is not found
in any of the other usual paths. If it is found in such a directory, a
warning is issued, because it means that the file is incomplete (it does
not list all of the directories that contain its dependencies). On Windows
platforms, these directories are searched if the dependency is not found
in any of the other search paths, but no warning is issued, because
searching other paths is a normal part of Windows dependency resolution.
On Apple platforms, this argument has no effect.

BUNDLE_EXECUTABLE
<bundle_executable_file>

Executable to treat as the «bundle executable» when resolving
libraries. On Apple platforms, this argument determines the value of
@executable_path when recursively resolving libraries for
LIBRARIES and MODULES files. It has no effect on
EXECUTABLES files. On other platforms, it has no effect. This is
typically (but not always) one of the executables in the
EXECUTABLES argument which designates the «main»
executable of the package.

PRE_INCLUDE_REGEXES
<regexes>

List of pre-include regexes through which to filter the names of
not-yet-resolved dependencies.

PRE_EXCLUDE_REGEXES
<regexes>

List of pre-exclude regexes through which to filter the names of
not-yet-resolved dependencies.

POST_INCLUDE_REGEXES
<regexes>

List of post-include regexes through which to filter the names of resolved
dependencies.

POST_EXCLUDE_REGEXES
<regexes>

List of post-exclude regexes through which to filter the names of resolved
dependencies.

POST_INCLUDE_FILES
<files>

New in version 3.21.

List of post-include filenames through which to filter the
names of resolved dependencies. Symlinks are resolved when attempting to
match these filenames.

POST_EXCLUDE_FILES
<files>

New in version 3.21.

List of post-exclude filenames through which to filter the
names of resolved dependencies. Symlinks are resolved when attempting to
match these filenames.

1.

If the not-yet-resolved dependency matches any of the
PRE_INCLUDE_REGEXES, steps 2 and 3 are skipped, and the dependency
resolution proceeds to step 4.

2.

If the not-yet-resolved dependency matches any of the
PRE_EXCLUDE_REGEXES, dependency resolution stops for that
dependency.

3.

Otherwise, dependency resolution proceeds.

4.

file(GET_RUNTIME_DEPENDENCIES) searches for the dependency
according to the linking rules of the platform (see below).

5.

If the dependency is found, and its full path matches one of the
POST_INCLUDE_REGEXES or POST_INCLUDE_FILES, the full path is
added to the resolved dependencies, and
file(GET_RUNTIME_DEPENDENCIES) recursively resolves that library’s
own dependencies. Otherwise, resolution proceeds to step 6.

6.

If the dependency is found, but its full path matches one of the
POST_EXCLUDE_REGEXES or POST_EXCLUDE_FILES, it is not added
to the resolved dependencies, and dependency resolution stops for that
dependency.

7.

If the dependency is found, and its full path does not match either
POST_INCLUDE_REGEXES, POST_INCLUDE_FILES,
POST_EXCLUDE_REGEXES, or POST_EXCLUDE_FILES, the full path
is added to the resolved dependencies, and
file(GET_RUNTIME_DEPENDENCIES) recursively resolves that library’s
own dependencies.

1.

If the depending file does not have any RUNPATH entries, and the
library exists in one of the depending file’s RPATH entries, or its
parents’, in that order, the dependency is resolved to that file.

2.

Otherwise, if the depending file has any RUNPATH entries, and the
library exists in one of those entries, the dependency is resolved to that
file.

3.

Otherwise, if the library exists in one of the directories listed by
ldconfig, the dependency is resolved to that file.

4.

Otherwise, if the library exists in one of the DIRECTORIES entries,
the dependency is resolved to that file. In this case, a warning is
issued, because finding a file in one of the DIRECTORIES means that
the depending file is not complete (it does not list all the directories
from which it pulls dependencies).

5.

Otherwise, the dependency is unresolved.

1.

The dependent DLL name is converted to lowercase. Windows DLL names are
case-insensitive, and some linkers mangle the case of the DLL dependency
names. However, this makes it more difficult for
PRE_INCLUDE_REGEXES, PRE_EXCLUDE_REGEXES,
POST_INCLUDE_REGEXES, and POST_EXCLUDE_REGEXES to properly
filter DLL names — every regex would have to check for both uppercase and
lowercase letters. For example:

file(GET_RUNTIME_DEPENDENCIES


  # ...


  PRE_INCLUDE_REGEXES "^[Mm][Yy][Ll][Ii][Bb][Rr][Aa][Rr][Yy]\.[Dd][Ll][Ll]$"


  )

Converting the DLL name to lowercase allows the regexes to only
match lowercase names, thus simplifying the regex. For example:

file(GET_RUNTIME_DEPENDENCIES


  # ...


  PRE_INCLUDE_REGEXES "^mylibrary\.dll$"


  )

This regex will match mylibrary.dll regardless of how it is
cased, either on disk or in the depending file. (For example, it will match
mylibrary.dll, MyLibrary.dll, and MYLIBRARY.DLL.)

Please note that the directory portion of any resolved DLLs
retains its casing and is not converted to lowercase. Only the filename
portion is converted.

2.

(Not yet implemented) If the depending file is a Windows Store app,
and the dependency is listed as a dependency in the application’s package
manifest, the dependency is resolved to that file.

3.

Otherwise, if the library exists in the same directory as the depending
file, the dependency is resolved to that file.

4.

Otherwise, if the library exists in either the operating system’s
system32 directory or the Windows directory, in that order,
the dependency is resolved to that file.

5.

Otherwise, if the library exists in one of the directories specified by
DIRECTORIES, in the order they are listed, the dependency is
resolved to that file. In this case, a warning is not issued, because
searching other directories is a normal part of Windows library
resolution.

6.

Otherwise, the dependency is unresolved.

1.

If the dependency starts with @executable_path/, and an
EXECUTABLES argument is in the process of being resolved, and
replacing @executable_path/ with the directory of the executable
yields an existing file, the dependency is resolved to that file.

2.

Otherwise, if the dependency starts with @executable_path/, and
there is a BUNDLE_EXECUTABLE argument, and replacing
@executable_path/ with the directory of the bundle executable
yields an existing file, the dependency is resolved to that file.

3.

Otherwise, if the dependency starts with @loader_path/, and
replacing @loader_path/ with the directory of the depending file
yields an existing file, the dependency is resolved to that file.

4.

Otherwise, if the dependency starts with @rpath/, and replacing
@rpath/ with one of the RPATH entries of the depending file
yields an existing file, the dependency is resolved to that file. Note
that RPATH entries that start with @executable_path/ or
@loader_path/ also have these items replaced with the appropriate
path.

5.

Otherwise, if the dependency is an absolute file that exists, the
dependency is resolved to that file.

6.

Otherwise, the dependency is unresolved.

CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM

Determines which operating system and executable format the files are
built for. This could be one of several values:

If this variable is not specified, it is determined automatically
by system introspection.

CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL

Determines the tool to use for dependency resolution. It could be one of
several values, depending on the value of
CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM:

CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM	CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL
linux+elf	objdump
windows+pe	dumpbin
windows+pe	objdump
macos+macho	otool

If this variable is not specified, it is determined
automatically by system introspection.

CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND

Determines the path to the tool to use for dependency resolution. This is
the actual path to objdump, dumpbin, or otool.

If this variable is not specified, it is determined by the
value of CMAKE_OBJDUMP if set, else by system introspection.

New in version 3.18: Use CMAKE_OBJDUMP if set.

file(WRITE <filename> <content>...)
file(APPEND <filename> <content>...)

file(TOUCH [<files>...])
file(TOUCH_NOCREATE [<files>...])

file(GENERATE OUTPUT output-file


     <INPUT input-file|CONTENT content>


     [CONDITION expression] [TARGET target]


     [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |


      FILE_PERMISSIONS <permissions>...]


     [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

CONDITION
<condition>

Generate the output file for a particular configuration only if the
condition is true. The condition must be either 0 or 1 after
evaluating generator expressions.

CONTENT
<content>

Use the content given explicitly as input.

INPUT
<input-file>

Use the content from a given file as input.

Changed in version 3.10: A relative path is treated with
respect to the value of CMAKE_CURRENT_SOURCE_DIR. See policy
CMP0070.

OUTPUT
<output-file>

Specify the output file name to generate. Use generator expressions such
as $<CONFIG> to specify a configuration-specific output file
name. Multiple configurations may generate the same output file only if
the generated content is identical. Otherwise, the
<output-file> must evaluate to an unique name for each
configuration.

Changed in version 3.10: A relative path (after evaluating
generator expressions) is treated with respect to the value of
CMAKE_CURRENT_BINARY_DIR. See policy CMP0070.

TARGET
<target>

New in version 3.19.

Specify which target to use when evaluating generator
expressions that require a target for evaluation (e.g.
$<COMPILE_FEATURES:…>,
$<TARGET_PROPERTY:prop>).

NO_SOURCE_PERMISSIONS

New in version 3.20.

The generated file permissions default to the standard 644
value (-rw-r—r—).

USE_SOURCE_PERMISSIONS

New in version 3.20.

Transfer the file permissions of the INPUT file to the
generated file. This is already the default behavior if none of the
three permissions-related keywords are given
(NO_SOURCE_PERMISSIONS, USE_SOURCE_PERMISSIONS or
FILE_PERMISSIONS). The USE_SOURCE_PERMISSIONS keyword
mostly serves as a way of making the intended behavior clearer at the
call site. It is an error to specify this option without
INPUT.

FILE_PERMISSIONS
<permissions>…

New in version 3.20.

Use the specified permissions for the generated file.

NEWLINE_STYLE
<style>

New in version 3.20.

Specify the newline style for the generated file. Specify
UNIX or LF for n newlines, or specify DOS,
WIN32, or CRLF for rn newlines.

file(CONFIGURE OUTPUT output-file


     CONTENT content


     [ESCAPE_QUOTES] [@ONLY]


     [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

OUTPUT
<output-file>

Specify the output file name to generate. A relative path is treated with
respect to the value of CMAKE_CURRENT_BINARY_DIR.
<output-file> does not support generator expressions.

CONTENT
<content>

Use the content given explicitly as input. <content> does not
support generator expressions.

ESCAPE_QUOTES

Escape any substituted quotes with backslashes (C-style).

@ONLY

Restrict variable replacement to references of the form @VAR@. This
is useful for configuring scripts that use ${VAR} syntax.

NEWLINE_STYLE
<style>

Specify the newline style for the output file. Specify UNIX or
LF for n newlines, or specify DOS, WIN32, or
CRLF for rn newlines.

file(GLOB <variable>


     [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS]


     [<globbing-expressions>...])
file(GLOB_RECURSE <variable> [FOLLOW_SYMLINKS]


     [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS]


     [<globbing-expressions>...])

We do not recommend using GLOB to collect a list of
source files from your source tree. If no CMakeLists.txt file changes when a
source is added or removed then the generated build system cannot know when to
ask CMake to regenerate. The CONFIGURE_DEPENDS flag may not work
reliably on all generators, or if a new generator is added in the future that
cannot support it, projects using it will be stuck. Even if
CONFIGURE_DEPENDS works reliably, there is still a cost to perform the
check on every rebuild.

*.cxx      - match all files with extension cxx
*.vt?      - match all files with extension vta,...,vtz
f[3-5].txt - match files f3.txt, f4.txt, f5.txt

/dir/*.py  - match all python files in /dir and subdirectories

file(MAKE_DIRECTORY [<directories>...])

file(REMOVE [<files>...])
file(REMOVE_RECURSE [<files>...])

file(RENAME <oldname> <newname>


     [RESULT <result>]


     [NO_REPLACE])

RESULT
<result>

New in version 3.21.

Set <result> variable to 0 on success or
an error message otherwise. If RESULT is not specified and the
operation fails, an error is emitted.

NO_REPLACE

New in version 3.21.

If the <newname> path already exists, do not
replace it. If RESULT <result> is used, the result variable
will be set to NO_REPLACE. Otherwise, an error is emitted.

file(COPY_FILE <oldname> <newname>


     [RESULT <result>]


     [ONLY_IF_DIFFERENT])

RESULT
<result>

Set <result> variable to 0 on success or an error
message otherwise. If RESULT is not specified and the operation
fails, an error is emitted.

ONLY_IF_DIFFERENT

If the <newname> path already exists, do not replace it if
the file’s contents are already the same as <oldname> (this
avoids updating <newname>‘s timestamp).

file(<COPY|INSTALL> <files>... DESTINATION <dir>


     [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS]


     [FILE_PERMISSIONS <permissions>...]


     [DIRECTORY_PERMISSIONS <permissions>...]


     [FOLLOW_SYMLINK_CHAIN]


     [FILES_MATCHING]


     [[PATTERN <pattern> | REGEX <regex>]


      [EXCLUDE] [PERMISSIONS <permissions>...]] [...])

For a simple file copying operation, the
file(COPY_FILE) sub-command just above may be easier to use.

• /opt/foo/lib/libfoo.so.1.2.3
• /opt/foo/lib/libfoo.so.1.2 -> libfoo.so.1.2.3
• /opt/foo/lib/libfoo.so.1 -> libfoo.so.1.2
• /opt/foo/lib/libfoo.so -> libfoo.so.1

file(COPY /opt/foo/lib/libfoo.so DESTINATION lib FOLLOW_SYMLINK_CHAIN)

file(SIZE <filename> <variable>)

file(READ_SYMLINK <linkname> <variable>)

set(linkname "/path/to/foo.sym")
file(READ_SYMLINK "${linkname}" result)
if(NOT IS_ABSOLUTE "${result}")


  get_filename_component(dir "${linkname}" DIRECTORY)


  set(result "${dir}/${result}")
endif()

file(CREATE_LINK <original> <linkname>


     [RESULT <result>] [COPY_ON_ERROR] [SYMBOLIC])

file(CHMOD <files>... <directories>...


    [PERMISSIONS <permissions>...]


    [FILE_PERMISSIONS <permissions>...]


    [DIRECTORY_PERMISSIONS <permissions>...])

PERMISSIONS

All items are changed.

FILE_PERMISSIONS

Only files are changed.

DIRECTORY_PERMISSIONS

Only directories are changed.

PERMISSIONS
and FILE_PERMISSIONS

FILE_PERMISSIONS overrides PERMISSIONS for files.

PERMISSIONS
and DIRECTORY_PERMISSIONS

DIRECTORY_PERMISSIONS overrides PERMISSIONS for
directories.

FILE_PERMISSIONS
and DIRECTORY_PERMISSIONS

Use FILE_PERMISSIONS for files and DIRECTORY_PERMISSIONS for
directories.

file(CHMOD_RECURSE <files>... <directories>...


     [PERMISSIONS <permissions>...]


     [FILE_PERMISSIONS <permissions>...]


     [DIRECTORY_PERMISSIONS <permissions>...])

file(REAL_PATH <path> <out-var> [BASE_DIRECTORY <dir>] [EXPAND_TILDE])

BASE_DIRECTORY
<dir>

If the provided <path> is a relative path, it is evaluated
relative to the given base directory <dir>. If no base
directory is provided, the default base directory will be
CMAKE_CURRENT_SOURCE_DIR.

EXPAND_TILDE

New in version 3.21.

If the <path> is ~ or starts with
~/, the ~ is replaced by the user’s home directory. The
path to the home directory is obtained from environment variables. On
Windows, the USERPROFILE environment variable is used, falling
back to the HOME environment variable if USERPROFILE is
not defined. On all other platforms, only HOME is used.

file(RELATIVE_PATH <variable> <directory> <file>)

file(TO_CMAKE_PATH "<path>" <variable>)
file(TO_NATIVE_PATH "<path>" <variable>)

file(DOWNLOAD <url> [<file>] [<options>...])
file(UPLOAD   <file> <url> [<options>...])

INACTIVITY_TIMEOUT
<seconds>

Terminate the operation after a period of inactivity.

LOG
<variable>

Store a human-readable log of the operation in a variable.

SHOW_PROGRESS

Print progress information as status messages until the operation is
complete.

STATUS
<variable>

Store the resulting status of the operation in a variable. The status is a
; separated list of length 2. The first element is the numeric
return value for the operation, and the second element is a string value
for the error. A 0 numeric error means no error in the
operation.

TIMEOUT
<seconds>

Terminate the operation after a given total time has elapsed.

USERPWD
<username>:<password>

New in version 3.7.

Set username and password for operation.

New in version 3.7.

HTTP header for operation. Suboption can be repeated several
times.

NETRC
<level>

New in version 3.11.

Specify whether the .netrc file is to be used for operation.
If this option is not specified, the value of the CMAKE_NETRC
variable will be used instead. Valid levels are:

NETRC_FILE
<file>

New in version 3.11.

Specify an alternative .netrc file to the one in your home
directory, if the NETRC level is OPTIONAL or
REQUIRED. If this option is not specified, the value of the
CMAKE_NETRC_FILE variable will be used instead.

TLS_VERIFY
<ON|OFF>

Specify whether to verify the server certificate for https:// URLs.
The default is to not verify. If this option is not specified, the
value of the CMAKE_TLS_VERIFY variable will be used instead.

New in version 3.18: Added support to file(UPLOAD).

TLS_CAINFO
<file>

Specify a custom Certificate Authority file for https:// URLs. If
this option is not specified, the value of the CMAKE_TLS_CAINFO
variable will be used instead.

New in version 3.18: Added support to file(UPLOAD).

Verify that the downloaded content hash matches the
expected value, where ALGO is one of the algorithms supported by
file(<HASH>). If the file already exists and matches the hash,
the download is skipped. If the file already exists and does not match the
hash, the file is downloaded again. If after download the file does not match
the hash, the operation fails with an error. It is an error to specify this
option if DOWNLOAD is not given a <file>.

EXPECTED_MD5
<value>

Historical short-hand for EXPECTED_HASH MD5=<value>. It is an
error to specify this if DOWNLOAD is not given a
<file>.

RANGE_START
<value>

New in version 3.24.

Offset of the start of the range in file in bytes. Could be
omitted to download up to the specified RANGE_END.

RANGE_END
<value>

New in version 3.24.

Offset of the end of the range in file in bytes. Could be
omitted to download everything from the specified RANGE_START to
the end of file.

file(LOCK <path> [DIRECTORY] [RELEASE]


     [GUARD <FUNCTION|FILE|PROCESS>]


     [RESULT_VARIABLE <variable>]


     [TIMEOUT <seconds>])

file(ARCHIVE_CREATE OUTPUT <archive>


  PATHS <paths>...


  [FORMAT <format>]


  [COMPRESSION <compression> [COMPRESSION_LEVEL <compression-level>]]


  [MTIME <mtime>]


  [VERBOSE])

With FORMAT set to raw only one file will
be compressed with the compression type specified by COMPRESSION.

file(ARCHIVE_EXTRACT INPUT <archive>


  [DESTINATION <dir>]


  [PATTERNS <patterns>...]


  [LIST_ONLY]


  [VERBOSE]


  [TOUCH])

find_file (<VAR> name1 [path1 path2 ...])

find_file (


          <VAR>


          name | NAMES name1 [name2 ...]


          [HINTS [path | ENV var]... ]


          [PATHS [path | ENV var]... ]


          [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]


          [PATH_SUFFIXES suffix1 [suffix2 ...]]


          [VALIDATOR function]


          [DOC "cache documentation string"]


          [NO_CACHE]


          [REQUIRED]


          [NO_DEFAULT_PATH]


          [NO_PACKAGE_ROOT_PATH]


          [NO_CMAKE_PATH]


          [NO_CMAKE_ENVIRONMENT_PATH]


          [NO_SYSTEM_ENVIRONMENT_PATH]


          [NO_CMAKE_SYSTEM_PATH]


          [NO_CMAKE_INSTALL_PREFIX]


          [CMAKE_FIND_ROOT_PATH_BOTH |


           ONLY_CMAKE_FIND_ROOT_PATH |


           NO_CMAKE_FIND_ROOT_PATH]


         )

NAMES

Specify one or more possible names for the full path to a file.

When using this to specify names with and without a version
suffix, we recommend specifying the unversioned name first so that
locally-built packages can be found before those provided by
distributions.

HINTS,
PATHS

Specify directories to search in addition to the default locations. The
ENV var sub-option reads paths from a system environment variable.

Changed in version 3.24: On Windows platform, it is
possible to include registry queries as part of the directories, using a
dedicated syntax. Such specifications will be ignored on all
other platforms.

REGISTRY_VIEW

New in version 3.24.

Specify which registry views must be queried. This option is
only meaningful on Windows platforms and will be ignored on other
ones. When not specified, the TARGET view is used when the
CMP0134 policy is NEW. Refer to CMP0134 for the
default view when the policy is OLD.

PATH_SUFFIXES

Specify additional subdirectories to check below each directory location
otherwise considered.

VALIDATOR

New in version 3.25.

Specify a function() to be called for each candidate
item found (a macro() cannot be provided, that will result in an
error). Two arguments will be passed to the validator function: the name
of a result variable, and the absolute path to the candidate item. The
item will be accepted and the search will end unless the function sets
the value in the result variable to false in the calling scope. The
result variable will hold a true value when the validator function is
entered.

function(my_check validator_result_var item)


  if(NOT item MATCHES ...)


    set(${validator_result_var} FALSE PARENT_SCOPE)


  endif()
endfunction()
find_file (result NAMES ... VALIDATOR my_check)

Note that if a cached result is used, the search is skipped and
any VALIDATOR is ignored. The cached result is not required to pass
the validation function.

DOC

Specify the documentation string for the <VAR> cache
entry.

NO_CACHE

New in version 3.21.

The result of the search will be stored in a normal variable
rather than a cache entry.

NOTE:

WARNING:

REQUIRED

New in version 3.18.

Stop processing with an error message if nothing is found,
otherwise the search will be attempted again the next time find_file is
invoked with the same variable.

1.

New in version 3.12: If called from within a find module or any other
script loaded by a call to find_package(<PackageName>),
search prefixes unique to the current package being found. Specifically,
look in the <PackageName>_ROOT CMake variable and the
<PackageName>_ROOT environment variable. The package root
variables are maintained as a stack, so if called from nested find modules
or config packages, root paths from the parent’s find module or config
package will be searched after paths from the current module or package.
In other words, the search order would be
<CurrentPackage>_ROOT,
ENV{<CurrentPackage>_ROOT},
<ParentPackage>_ROOT, ENV{<ParentPackage>_ROOT},
etc. This can be skipped if NO_PACKAGE_ROOT_PATH is passed or by
setting the CMAKE_FIND_USE_PACKAGE_ROOT_PATH to FALSE. See
policy CMP0074.

2.

Search paths specified in cmake-specific cache variables. These are
intended to be used on the command line with a -DVAR=value. The
values are interpreted as semicolon-separated lists. This can be
skipped if NO_CMAKE_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_PATH to FALSE.

3.

Search paths specified in cmake-specific environment variables. These are
intended to be set in the user’s shell configuration, and therefore use
the host’s native path separator (; on Windows and : on
UNIX). This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed
or by setting the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH to
FALSE.

4.

Search the paths specified by the HINTS option. These should be
paths computed by system introspection, such as a hint provided by the
location of another item already found. Hard-coded guesses should be
specified with the PATHS option.

5.

Search the standard system environment variables. This can be skipped if
NO_SYSTEM_ENVIRONMENT_PATH is passed or by setting the
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to FALSE.

6.

Search cmake variables defined in the Platform files for the current
system. The searching of CMAKE_INSTALL_PREFIX and
CMAKE_STAGING_PREFIX can be skipped if
NO_CMAKE_INSTALL_PREFIX is passed or by setting the
CMAKE_FIND_USE_INSTALL_PREFIX to FALSE. All these locations
can be skipped if NO_CMAKE_SYSTEM_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH to FALSE.

The platform paths that these variables contain are locations that
typically include installed software. An example being /usr/local for
UNIX based platforms.

7.

Search the paths specified by the PATHS option or in the short-hand
version of the command. These are typically hard-coded guesses.

CMAKE_FIND_ROOT_PATH_BOTH

Search in the order described above.

NO_CMAKE_FIND_ROOT_PATH

Do not use the CMAKE_FIND_ROOT_PATH variable.

ONLY_CMAKE_FIND_ROOT_PATH

Search only the re-rooted directories and directories below
CMAKE_STAGING_PREFIX.

find_file (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_file (<VAR> NAMES name)

find_library (<VAR> name1 [path1 path2 ...])

find_library (


          <VAR>


          name | NAMES name1 [name2 ...] [NAMES_PER_DIR]


          [HINTS [path | ENV var]... ]


          [PATHS [path | ENV var]... ]


          [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]


          [PATH_SUFFIXES suffix1 [suffix2 ...]]


          [VALIDATOR function]


          [DOC "cache documentation string"]


          [NO_CACHE]


          [REQUIRED]


          [NO_DEFAULT_PATH]


          [NO_PACKAGE_ROOT_PATH]


          [NO_CMAKE_PATH]


          [NO_CMAKE_ENVIRONMENT_PATH]


          [NO_SYSTEM_ENVIRONMENT_PATH]


          [NO_CMAKE_SYSTEM_PATH]


          [NO_CMAKE_INSTALL_PREFIX]


          [CMAKE_FIND_ROOT_PATH_BOTH |


           ONLY_CMAKE_FIND_ROOT_PATH |


           NO_CMAKE_FIND_ROOT_PATH]


         )

NAMES

Specify one or more possible names for the library.

When using this to specify names with and without a version
suffix, we recommend specifying the unversioned name first so that
locally-built packages can be found before those provided by
distributions.

HINTS,
PATHS

Specify directories to search in addition to the default locations. The
ENV var sub-option reads paths from a system environment variable.

Changed in version 3.24: On Windows platform, it is
possible to include registry queries as part of the directories, using a
dedicated syntax. Such specifications will be ignored on all
other platforms.

REGISTRY_VIEW

New in version 3.24.

Specify which registry views must be queried. This option is
only meaningful on Windows platforms and will be ignored on other
ones. When not specified, the TARGET view is used when the
CMP0134 policy is NEW. Refer to CMP0134 for the
default view when the policy is OLD.

PATH_SUFFIXES

Specify additional subdirectories to check below each directory location
otherwise considered.

VALIDATOR

New in version 3.25.

Specify a function() to be called for each candidate
item found (a macro() cannot be provided, that will result in an
error). Two arguments will be passed to the validator function: the name
of a result variable, and the absolute path to the candidate item. The
item will be accepted and the search will end unless the function sets
the value in the result variable to false in the calling scope. The
result variable will hold a true value when the validator function is
entered.

function(my_check validator_result_var item)


  if(NOT item MATCHES ...)


    set(${validator_result_var} FALSE PARENT_SCOPE)


  endif()
endfunction()
find_library (result NAMES ... VALIDATOR my_check)

Note that if a cached result is used, the search is skipped and
any VALIDATOR is ignored. The cached result is not required to pass
the validation function.

DOC

Specify the documentation string for the <VAR> cache
entry.

NO_CACHE

New in version 3.21.

The result of the search will be stored in a normal variable
rather than a cache entry.

NOTE:

WARNING:

REQUIRED

New in version 3.18.

Stop processing with an error message if nothing is found,
otherwise the search will be attempted again the next time find_library
is invoked with the same variable.

1.

New in version 3.12: If called from within a find module or any other
script loaded by a call to find_package(<PackageName>),
search prefixes unique to the current package being found. Specifically,
look in the <PackageName>_ROOT CMake variable and the
<PackageName>_ROOT environment variable. The package root
variables are maintained as a stack, so if called from nested find modules
or config packages, root paths from the parent’s find module or config
package will be searched after paths from the current module or package.
In other words, the search order would be
<CurrentPackage>_ROOT,
ENV{<CurrentPackage>_ROOT},
<ParentPackage>_ROOT, ENV{<ParentPackage>_ROOT},
etc. This can be skipped if NO_PACKAGE_ROOT_PATH is passed or by
setting the CMAKE_FIND_USE_PACKAGE_ROOT_PATH to FALSE. See
policy CMP0074.

2.

Search paths specified in cmake-specific cache variables. These are
intended to be used on the command line with a -DVAR=value. The
values are interpreted as semicolon-separated lists. This can be
skipped if NO_CMAKE_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_PATH to FALSE.

3.

Search paths specified in cmake-specific environment variables. These are
intended to be set in the user’s shell configuration, and therefore use
the host’s native path separator (; on Windows and : on
UNIX). This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed
or by setting the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH to
FALSE.

4.

Search the paths specified by the HINTS option. These should be
paths computed by system introspection, such as a hint provided by the
location of another item already found. Hard-coded guesses should be
specified with the PATHS option.

5.

Search the standard system environment variables. This can be skipped if
NO_SYSTEM_ENVIRONMENT_PATH is passed or by setting the
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to FALSE.

6.

Search cmake variables defined in the Platform files for the current
system. The searching of CMAKE_INSTALL_PREFIX and
CMAKE_STAGING_PREFIX can be skipped if
NO_CMAKE_INSTALL_PREFIX is passed or by setting the
CMAKE_FIND_USE_INSTALL_PREFIX to FALSE. All these locations
can be skipped if NO_CMAKE_SYSTEM_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH to FALSE.

The platform paths that these variables contain are locations that
typically include installed software. An example being /usr/local for
UNIX based platforms.

7.

Search the paths specified by the PATHS option or in the short-hand
version of the command. These are typically hard-coded guesses.

CMAKE_FIND_ROOT_PATH_BOTH

Search in the order described above.

NO_CMAKE_FIND_ROOT_PATH

Do not use the CMAKE_FIND_ROOT_PATH variable.

ONLY_CMAKE_FIND_ROOT_PATH

Search only the re-rooted directories and directories below
CMAKE_STAGING_PREFIX.

find_library (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_library (<VAR> NAMES name)

The Using Dependencies Guide provides a high-level
introduction to this general topic. It provides a broader overview of where
the find_package() command fits into the bigger picture, including its
relationship to the FetchContent module. The guide is recommended
pre-reading before moving on to the details below.

Module
mode

In this mode, CMake searches for a file called
Find<PackageName>.cmake, looking first in the locations
listed in the CMAKE_MODULE_PATH, then among the Find Modules
provided by the CMake installation. If the file is found, it is read and
processed by CMake. It is responsible for finding the package, checking
the version, and producing any needed messages. Some Find modules provide
limited or no support for versioning; check the Find module’s
documentation.

The Find<PackageName>.cmake file is not typically
provided by the package itself. Rather, it is normally provided by
something external to the package, such as the operating system, CMake
itself, or even the project from which the find_package() command
was called. Being externally provided, Find Modules tend to be
heuristic in nature and are susceptible to becoming out-of-date. They
typically search for certain libraries, files and other package
artifacts.

Module mode is only supported by the basic command
signature.

Config
mode

In this mode, CMake searches for a file called
<lowercasePackageName>-config.cmake or
<PackageName>Config.cmake. It will also look for
<lowercasePackageName>-config-version.cmake or
<PackageName>ConfigVersion.cmake if version details were
specified (see Config Mode Version Selection for an explanation of
how these separate version files are used).

In config mode, the command can be given a list of names to
search for as package names. The locations where CMake searches for the
config and version files is considerably more complicated than for
Module mode (see Config Mode Search Procedure).

The config and version files are typically installed as part
of the package, so they tend to be more reliable than Find modules. They
usually contain direct knowledge of the package contents, so no
searching or heuristics are needed within the config or version files
themselves.

Config mode is supported by both the basic and
full command signatures.

FetchContent
redirection mode

New in version 3.24: A call to find_package() can be redirected
internally to a package provided by the FetchContent module. To the
caller, the behavior will appear similar to Config mode, except that the
search logic is by-passed and the component information is not used. See
FetchContent_Declare() and FetchContent_MakeAvailable() for
further details.

find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]


             [REQUIRED] [[COMPONENTS] [components...]]


             [OPTIONAL_COMPONENTS components...]


             [REGISTRY_VIEW  (64|32|64_32|32_64|HOST|TARGET|BOTH)]


             [GLOBAL]


             [NO_POLICY_SCOPE]


             [BYPASS_PROVIDER])

• A single version with the format major[.minor[.patch[.tweak]]],
  where each component is a numeric value.
• A version range with the format versionMin…[<]versionMax where
  versionMin and versionMax have the same format and
  constraints on components being integers as the single version. By
  default, both end points are included. By specifying <, the
  upper end point will be excluded. Version ranges are only supported with
  CMake 3.19 or later.

find_package(<PackageName> [version] [EXACT] [QUIET]


             [REQUIRED] [[COMPONENTS] [components...]]


             [OPTIONAL_COMPONENTS components...]


             [CONFIG|NO_MODULE]


             [GLOBAL]


             [NO_POLICY_SCOPE]


             [BYPASS_PROVIDER]


             [NAMES name1 [name2 ...]]


             [CONFIGS config1 [config2 ...]]


             [HINTS path1 [path2 ... ]]


             [PATHS path1 [path2 ... ]]


             [REGISTRY_VIEW  (64|32|64_32|32_64|HOST|TARGET|BOTH)]


             [PATH_SUFFIXES suffix1 [suffix2 ...]]


             [NO_DEFAULT_PATH]


             [NO_PACKAGE_ROOT_PATH]


             [NO_CMAKE_PATH]


             [NO_CMAKE_ENVIRONMENT_PATH]


             [NO_SYSTEM_ENVIRONMENT_PATH]


             [NO_CMAKE_PACKAGE_REGISTRY]


             [NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing.


             [NO_CMAKE_SYSTEM_PATH]


             [NO_CMAKE_INSTALL_PREFIX]


             [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]


             [CMAKE_FIND_ROOT_PATH_BOTH |


              ONLY_CMAKE_FIND_ROOT_PATH |


              NO_CMAKE_FIND_ROOT_PATH])

When Config mode is used, this search procedure is
applied regardless of whether the full or basic signature was
given.

• Paths with lib64 are searched on 64 bit platforms if the
  FIND_LIBRARY_USE_LIB64_PATHS property is set to TRUE.
• Paths with lib32 are searched on 32 bit platforms if the
  FIND_LIBRARY_USE_LIB32_PATHS property is set to TRUE.
• Paths with libx32 are searched on platforms using the x32 ABI if
  the FIND_LIBRARY_USE_LIBX32_PATHS property is set to
  TRUE.
• The lib path is always searched.

64

Query the 64-bit registry. On 32-bit Windows, it always returns the string
/REGISTRY-NOTFOUND.

32

Query the 32-bit registry.

64_32

Query both views (64 and 32) and generate a path for
each.

32_64

Query both views (32 and 64) and generate a path for
each.

HOST

Query the registry matching the architecture of the host: 64 on
64-bit Windows and 32 on 32-bit Windows.

TARGET

Query the registry matching the architecture specified by the
CMAKE_SIZEOF_VOID_P variable. If not defined, fall back to
HOST view.

BOTH

Query both views (32 and 64). The order depends on the
following rules: If the CMAKE_SIZEOF_VOID_P variable is defined,
use the following view depending on the content of this variable:

If the CMAKE_SIZEOF_VOID_P variable is not defined, rely on
the architecture of the host:

1.

New in version 3.12: Search paths specified in the
<PackageName>_ROOT CMake variable and the
<PackageName>_ROOT environment variable, where
<PackageName> is the package to be found. The package root
variables are maintained as a stack so if called from within a find
module, root paths from the parent’s find module will also be searched
after paths for the current package. This can be skipped if
NO_PACKAGE_ROOT_PATH is passed or by setting the
CMAKE_FIND_USE_PACKAGE_ROOT_PATH to FALSE. See policy
CMP0074.

2.

Search paths specified in cmake-specific cache variables. These are
intended to be used on the command line with a -DVAR=VALUE. The
values are interpreted as semicolon-separated lists. This can be
skipped if NO_CMAKE_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_PATH to FALSE:

3.

Search paths specified in cmake-specific environment variables. These are
intended to be set in the user’s shell configuration, and therefore use
the host’s native path separator (; on Windows and : on
UNIX). This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed
or by setting the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH to
FALSE:

4.

Search paths specified by the HINTS option. These should be paths
computed by system introspection, such as a hint provided by the location
of another item already found. Hard-coded guesses should be specified with
the PATHS option.

5.

Search the standard system environment variables. This can be skipped if
NO_SYSTEM_ENVIRONMENT_PATH is passed or by setting the
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to FALSE. Path
entries ending in /bin or /sbin are automatically converted
to their parent directories:

6.

Search paths stored in the CMake User Package Registry. This can be
skipped if NO_CMAKE_PACKAGE_REGISTRY is passed or by setting the
variable CMAKE_FIND_USE_PACKAGE_REGISTRY to FALSE or the
deprecated variable CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY to
TRUE.

See the cmake-packages(7) manual for details on the
user package registry.

7.

Search cmake variables defined in the Platform files for the current
system. The searching of CMAKE_INSTALL_PREFIX and
CMAKE_STAGING_PREFIX can be skipped if
NO_CMAKE_INSTALL_PREFIX is passed or by setting the
CMAKE_FIND_USE_INSTALL_PREFIX to FALSE. All these locations
can be skipped if NO_CMAKE_SYSTEM_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH to FALSE:

The platform paths that these variables contain are locations that
typically include installed software. An example being /usr/local for
UNIX based platforms.

8.

Search paths stored in the CMake System Package Registry. This can
be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed or by
setting the CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY variable to
FALSE or the deprecated variable
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY to TRUE.

See the cmake-packages(7) manual for details on the
system package registry.

9.

Search paths specified by the PATHS option. These are typically
hard-coded guesses.

CMAKE_FIND_ROOT_PATH_BOTH

Search in the order described above.

NO_CMAKE_FIND_ROOT_PATH

Do not use the CMAKE_FIND_ROOT_PATH variable.

ONLY_CMAKE_FIND_ROOT_PATH

Search only the re-rooted directories and directories below
CMAKE_STAGING_PREFIX.

find_package (<PackageName> PATHS paths... NO_DEFAULT_PATH)
find_package (<PackageName>)

• Setting the CMAKE_DISABLE_FIND_PACKAGE_<PackageName> variable
  to TRUE disables the package. This also disables redirection to a
  package provided by FetchContent.
• Setting the CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> variable
  to TRUE makes the package REQUIRED.

When Config mode is used, this version selection process
is applied regardless of whether the full or basic signature was
given.

PACKAGE_FIND_NAME

The <PackageName>

PACKAGE_FIND_VERSION

Full requested version string

PACKAGE_FIND_VERSION_MAJOR

Major version if requested, else 0

PACKAGE_FIND_VERSION_MINOR

Minor version if requested, else 0

PACKAGE_FIND_VERSION_PATCH

Patch version if requested, else 0

PACKAGE_FIND_VERSION_TWEAK

Tweak version if requested, else 0

PACKAGE_FIND_VERSION_COUNT

Number of version components, 0 to 4

PACKAGE_FIND_VERSION_RANGE

Full requested version range string

PACKAGE_FIND_VERSION_RANGE_MIN

This specifies whether the lower end point of the version range should be
included or excluded. Currently, the only supported value for this
variable is INCLUDE.

PACKAGE_FIND_VERSION_RANGE_MAX

This specifies whether the upper end point of the version range should be
included or excluded. The supported values for this variable are
INCLUDE and EXCLUDE.

PACKAGE_FIND_VERSION_MIN

Full requested version string of the lower end point of the range

PACKAGE_FIND_VERSION_MIN_MAJOR

Major version of the lower end point if requested, else 0

PACKAGE_FIND_VERSION_MIN_MINOR

Minor version of the lower end point if requested, else 0

PACKAGE_FIND_VERSION_MIN_PATCH

Patch version of the lower end point if requested, else 0

PACKAGE_FIND_VERSION_MIN_TWEAK

Tweak version of the lower end point if requested, else 0

PACKAGE_FIND_VERSION_MIN_COUNT

Number of version components of the lower end point, 0 to 4

PACKAGE_FIND_VERSION_MAX

Full requested version string of the upper end point of the range

PACKAGE_FIND_VERSION_MAX_MAJOR

Major version of the upper end point if requested, else 0

PACKAGE_FIND_VERSION_MAX_MINOR

Minor version of the upper end point if requested, else 0

PACKAGE_FIND_VERSION_MAX_PATCH

Patch version of the upper end point if requested, else 0

PACKAGE_FIND_VERSION_MAX_TWEAK

Tweak version of the upper end point if requested, else 0

PACKAGE_FIND_VERSION_MAX_COUNT

Number of version components of the upper end point, 0 to 4

PACKAGE_VERSION

Full provided version string

PACKAGE_VERSION_EXACT

True if version is exact match

PACKAGE_VERSION_COMPATIBLE

True if version is compatible

PACKAGE_VERSION_UNSUITABLE

True if unsuitable as any version

<PackageName>_VERSION

Full provided version string

<PackageName>_VERSION_MAJOR

Major version if provided, else 0

<PackageName>_VERSION_MINOR

Minor version if provided, else 0

<PackageName>_VERSION_PATCH

Patch version if provided, else 0

<PackageName>_VERSION_TWEAK

Tweak version if provided, else 0

<PackageName>_VERSION_COUNT

Number of version components, 0 to 4

SET(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
SET(CMAKE_FIND_PACKAGE_SORT_DIRECTION DEC)

CMAKE_FIND_PACKAGE_NAME

The <PackageName> which is searched for

<PackageName>_FIND_REQUIRED

True if REQUIRED option was given

<PackageName>_FIND_QUIETLY

True if QUIET option was given

<PackageName>_FIND_REGISTRY_VIEW

The requested view if REGISTRY_VIEW option was given

<PackageName>_FIND_VERSION

Full requested version string

<PackageName>_FIND_VERSION_MAJOR

Major version if requested, else 0

<PackageName>_FIND_VERSION_MINOR

Minor version if requested, else 0

<PackageName>_FIND_VERSION_PATCH

Patch version if requested, else 0

<PackageName>_FIND_VERSION_TWEAK

Tweak version if requested, else 0

<PackageName>_FIND_VERSION_COUNT

Number of version components, 0 to 4

<PackageName>_FIND_VERSION_EXACT

True if EXACT option was given

<PackageName>_FIND_COMPONENTS

List of specified components (required and optional)

<PackageName>_FIND_REQUIRED_<c>

True if component <c> is required, false if component
<c> is optional

<PackageName>_FIND_VERSION_RANGE

Full requested version range string

<PackageName>_FIND_VERSION_RANGE_MIN

This specifies whether the lower end point of the version range is
included or excluded. Currently, INCLUDE is the only supported
value.

<PackageName>_FIND_VERSION_RANGE_MAX

This specifies whether the upper end point of the version range is
included or excluded. The possible values for this variable are
INCLUDE or EXCLUDE.

<PackageName>_FIND_VERSION_MIN

Full requested version string of the lower end point of the range

<PackageName>_FIND_VERSION_MIN_MAJOR

Major version of the lower end point if requested, else 0

<PackageName>_FIND_VERSION_MIN_MINOR

Minor version of the lower end point if requested, else 0

<PackageName>_FIND_VERSION_MIN_PATCH

Patch version of the lower end point if requested, else 0

<PackageName>_FIND_VERSION_MIN_TWEAK

Tweak version of the lower end point if requested, else 0

<PackageName>_FIND_VERSION_MIN_COUNT

Number of version components of the lower end point, 0 to 4

<PackageName>_FIND_VERSION_MAX

Full requested version string of the upper end point of the range

<PackageName>_FIND_VERSION_MAX_MAJOR

Major version of the upper end point if requested, else 0

<PackageName>_FIND_VERSION_MAX_MINOR

Minor version of the upper end point if requested, else 0

<PackageName>_FIND_VERSION_MAX_PATCH

Patch version of the upper end point if requested, else 0

<PackageName>_FIND_VERSION_MAX_TWEAK

Tweak version of the upper end point if requested, else 0

<PackageName>_FIND_VERSION_MAX_COUNT

Number of version components of the upper end point, 0 to 4

find_path (<VAR> name1 [path1 path2 ...])

find_path (


          <VAR>


          name | NAMES name1 [name2 ...]


          [HINTS [path | ENV var]... ]


          [PATHS [path | ENV var]... ]


          [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]


          [PATH_SUFFIXES suffix1 [suffix2 ...]]


          [VALIDATOR function]


          [DOC "cache documentation string"]


          [NO_CACHE]


          [REQUIRED]


          [NO_DEFAULT_PATH]


          [NO_PACKAGE_ROOT_PATH]


          [NO_CMAKE_PATH]


          [NO_CMAKE_ENVIRONMENT_PATH]


          [NO_SYSTEM_ENVIRONMENT_PATH]


          [NO_CMAKE_SYSTEM_PATH]


          [NO_CMAKE_INSTALL_PREFIX]


          [CMAKE_FIND_ROOT_PATH_BOTH |


           ONLY_CMAKE_FIND_ROOT_PATH |


           NO_CMAKE_FIND_ROOT_PATH]


         )

NAMES

Specify one or more possible names for the file in a directory.

When using this to specify names with and without a version
suffix, we recommend specifying the unversioned name first so that
locally-built packages can be found before those provided by
distributions.

HINTS,
PATHS

Specify directories to search in addition to the default locations. The
ENV var sub-option reads paths from a system environment variable.

Changed in version 3.24: On Windows platform, it is
possible to include registry queries as part of the directories, using a
dedicated syntax. Such specifications will be ignored on all
other platforms.

REGISTRY_VIEW

New in version 3.24.

Specify which registry views must be queried. This option is
only meaningful on Windows platforms and will be ignored on other
ones. When not specified, the TARGET view is used when the
CMP0134 policy is NEW. Refer to CMP0134 for the
default view when the policy is OLD.

PATH_SUFFIXES

Specify additional subdirectories to check below each directory location
otherwise considered.

VALIDATOR

New in version 3.25.

Specify a function() to be called for each candidate
item found (a macro() cannot be provided, that will result in an
error). Two arguments will be passed to the validator function: the name
of a result variable, and the absolute path to the candidate item. The
item will be accepted and the search will end unless the function sets
the value in the result variable to false in the calling scope. The
result variable will hold a true value when the validator function is
entered.

function(my_check validator_result_var item)


  if(NOT item MATCHES ...)


    set(${validator_result_var} FALSE PARENT_SCOPE)


  endif()
endfunction()
find_path (result NAMES ... VALIDATOR my_check)

Note that if a cached result is used, the search is skipped and
any VALIDATOR is ignored. The cached result is not required to pass
the validation function.

DOC

Specify the documentation string for the <VAR> cache
entry.

NO_CACHE

New in version 3.21.

The result of the search will be stored in a normal variable
rather than a cache entry.

NOTE:

WARNING:

REQUIRED

New in version 3.18.

Stop processing with an error message if nothing is found,
otherwise the search will be attempted again the next time find_path is
invoked with the same variable.

1.

New in version 3.12: If called from within a find module or any other
script loaded by a call to find_package(<PackageName>),
search prefixes unique to the current package being found. Specifically,
look in the <PackageName>_ROOT CMake variable and the
<PackageName>_ROOT environment variable. The package root
variables are maintained as a stack, so if called from nested find modules
or config packages, root paths from the parent’s find module or config
package will be searched after paths from the current module or package.
In other words, the search order would be
<CurrentPackage>_ROOT,
ENV{<CurrentPackage>_ROOT},
<ParentPackage>_ROOT, ENV{<ParentPackage>_ROOT},
etc. This can be skipped if NO_PACKAGE_ROOT_PATH is passed or by
setting the CMAKE_FIND_USE_PACKAGE_ROOT_PATH to FALSE. See
policy CMP0074.

2.

Search paths specified in cmake-specific cache variables. These are
intended to be used on the command line with a -DVAR=value. The
values are interpreted as semicolon-separated lists. This can be
skipped if NO_CMAKE_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_PATH to FALSE.

3.

Search paths specified in cmake-specific environment variables. These are
intended to be set in the user’s shell configuration, and therefore use
the host’s native path separator (; on Windows and : on
UNIX). This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed
or by setting the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH to
FALSE.

4.

Search the paths specified by the HINTS option. These should be
paths computed by system introspection, such as a hint provided by the
location of another item already found. Hard-coded guesses should be
specified with the PATHS option.

5.

Search the standard system environment variables. This can be skipped if
NO_SYSTEM_ENVIRONMENT_PATH is passed or by setting the
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to FALSE.

6.

Search cmake variables defined in the Platform files for the current
system. The searching of CMAKE_INSTALL_PREFIX and
CMAKE_STAGING_PREFIX can be skipped if
NO_CMAKE_INSTALL_PREFIX is passed or by setting the
CMAKE_FIND_USE_INSTALL_PREFIX to FALSE. All these locations
can be skipped if NO_CMAKE_SYSTEM_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH to FALSE.

The platform paths that these variables contain are locations that
typically include installed software. An example being /usr/local for
UNIX based platforms.

7.

Search the paths specified by the PATHS option or in the short-hand
version of the command. These are typically hard-coded guesses.

CMAKE_FIND_ROOT_PATH_BOTH

Search in the order described above.

NO_CMAKE_FIND_ROOT_PATH

Do not use the CMAKE_FIND_ROOT_PATH variable.

ONLY_CMAKE_FIND_ROOT_PATH

Search only the re-rooted directories and directories below
CMAKE_STAGING_PREFIX.

find_path (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_path (<VAR> NAMES name)

find_program (<VAR> name1 [path1 path2 ...])

find_program (


          <VAR>


          name | NAMES name1 [name2 ...] [NAMES_PER_DIR]


          [HINTS [path | ENV var]... ]


          [PATHS [path | ENV var]... ]


          [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]


          [PATH_SUFFIXES suffix1 [suffix2 ...]]


          [VALIDATOR function]


          [DOC "cache documentation string"]


          [NO_CACHE]


          [REQUIRED]


          [NO_DEFAULT_PATH]


          [NO_PACKAGE_ROOT_PATH]


          [NO_CMAKE_PATH]


          [NO_CMAKE_ENVIRONMENT_PATH]


          [NO_SYSTEM_ENVIRONMENT_PATH]


          [NO_CMAKE_SYSTEM_PATH]


          [NO_CMAKE_INSTALL_PREFIX]


          [CMAKE_FIND_ROOT_PATH_BOTH |


           ONLY_CMAKE_FIND_ROOT_PATH |


           NO_CMAKE_FIND_ROOT_PATH]


         )

NAMES

Specify one or more possible names for the program.

When using this to specify names with and without a version
suffix, we recommend specifying the unversioned name first so that
locally-built packages can be found before those provided by
distributions.

HINTS,
PATHS

Specify directories to search in addition to the default locations. The
ENV var sub-option reads paths from a system environment variable.

Changed in version 3.24: On Windows platform, it is
possible to include registry queries as part of the directories, using a
dedicated syntax. Such specifications will be ignored on all
other platforms.

REGISTRY_VIEW

New in version 3.24.

Specify which registry views must be queried. This option is
only meaningful on Windows platforms and will be ignored on other
ones. When not specified, the BOTH view is used when the
CMP0134 policy is NEW. Refer to CMP0134 for the
default view when the policy is OLD.

PATH_SUFFIXES

Specify additional subdirectories to check below each directory location
otherwise considered.

VALIDATOR

New in version 3.25.

Specify a function() to be called for each candidate
item found (a macro() cannot be provided, that will result in an
error). Two arguments will be passed to the validator function: the name
of a result variable, and the absolute path to the candidate item. The
item will be accepted and the search will end unless the function sets
the value in the result variable to false in the calling scope. The
result variable will hold a true value when the validator function is
entered.

function(my_check validator_result_var item)


  if(NOT item MATCHES ...)


    set(${validator_result_var} FALSE PARENT_SCOPE)


  endif()
endfunction()
find_program (result NAMES ... VALIDATOR my_check)

Note that if a cached result is used, the search is skipped and
any VALIDATOR is ignored. The cached result is not required to pass
the validation function.

DOC

Specify the documentation string for the <VAR> cache
entry.

NO_CACHE

New in version 3.21.

The result of the search will be stored in a normal variable
rather than a cache entry.

NOTE:

WARNING:

REQUIRED

New in version 3.18.

Stop processing with an error message if nothing is found,
otherwise the search will be attempted again the next time find_program
is invoked with the same variable.

1.

New in version 3.12: If called from within a find module or any other
script loaded by a call to find_package(<PackageName>),
search prefixes unique to the current package being found. Specifically,
look in the <PackageName>_ROOT CMake variable and the
<PackageName>_ROOT environment variable. The package root
variables are maintained as a stack, so if called from nested find modules
or config packages, root paths from the parent’s find module or config
package will be searched after paths from the current module or package.
In other words, the search order would be
<CurrentPackage>_ROOT,
ENV{<CurrentPackage>_ROOT},
<ParentPackage>_ROOT, ENV{<ParentPackage>_ROOT},
etc. This can be skipped if NO_PACKAGE_ROOT_PATH is passed or by
setting the CMAKE_FIND_USE_PACKAGE_ROOT_PATH to FALSE. See
policy CMP0074.

2.

Search paths specified in cmake-specific cache variables. These are
intended to be used on the command line with a -DVAR=value. The
values are interpreted as semicolon-separated lists. This can be
skipped if NO_CMAKE_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_PATH to FALSE.

3.

Search paths specified in cmake-specific environment variables. These are
intended to be set in the user’s shell configuration, and therefore use
the host’s native path separator (; on Windows and : on
UNIX). This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed
or by setting the CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH to
FALSE.

4.

Search the paths specified by the HINTS option. These should be
paths computed by system introspection, such as a hint provided by the
location of another item already found. Hard-coded guesses should be
specified with the PATHS option.

5.

Search the standard system environment variables. This can be skipped if
NO_SYSTEM_ENVIRONMENT_PATH is passed or by setting the
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to FALSE.

6.

Search cmake variables defined in the Platform files for the current
system. The searching of CMAKE_INSTALL_PREFIX and
CMAKE_STAGING_PREFIX can be skipped if
NO_CMAKE_INSTALL_PREFIX is passed or by setting the
CMAKE_FIND_USE_INSTALL_PREFIX to FALSE. All these locations
can be skipped if NO_CMAKE_SYSTEM_PATH is passed or by setting the
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH to FALSE.

The platform paths that these variables contain are locations that
typically include installed software. An example being /usr/local for
UNIX based platforms.

7.

Search the paths specified by the PATHS option or in the short-hand
version of the command. These are typically hard-coded guesses.

CMAKE_FIND_ROOT_PATH_BOTH

Search in the order described above.

NO_CMAKE_FIND_ROOT_PATH

Do not use the CMAKE_FIND_ROOT_PATH variable.

ONLY_CMAKE_FIND_ROOT_PATH

Search only the re-rooted directories and directories below
CMAKE_STAGING_PREFIX.

find_program (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_program (<VAR> NAMES name)

foreach(<loop_var> <items>)


  <commands>
endforeach()

foreach(<loop_var> RANGE <stop>)

foreach(<loop_var> RANGE <start> <stop> [<step>])

foreach(<loop_var> IN [LISTS [<lists>]] [ITEMS [<items>]])

set(A 0;1)
set(B 2 3)
set(C "4 5")
set(D 6;7 8)
set(E "")
foreach(X IN LISTS A B C D E)


    message(STATUS "X=${X}")
endforeach()

-- X=0
-- X=1
-- X=2
-- X=3
-- X=4 5
-- X=6
-- X=7
-- X=8

foreach(<loop_var>... IN ZIP_LISTS <lists>)

• if the only loop_var given, then it sets a series of
  loop_var_N variables to the current item from the corresponding
  list;
• if multiple variable names passed, their count should match the lists
  variables count;
• if any of the lists are shorter, the corresponding iteration variable is
  not defined for the current iteration.

list(APPEND English one two three four)
list(APPEND Bahasa satu dua tiga)
foreach(num IN ZIP_LISTS English Bahasa)


    message(STATUS "num_0=${num_0}, num_1=${num_1}")
endforeach()
foreach(en ba IN ZIP_LISTS English Bahasa)


    message(STATUS "en=${en}, ba=${ba}")
endforeach()

-- num_0=one, num_1=satu
-- num_0=two, num_1=dua
-- num_0=three, num_1=tiga
-- num_0=four, num_1=
-- en=one, ba=satu
-- en=two, ba=dua
-- en=three, ba=tiga
-- en=four, ba=

• break()
• continue()
• endforeach()
• while()

function(<name> [<arg1> ...])


  <commands>
endfunction()

function(foo)


  <commands>
endfunction()