Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes.
See raw diff
- mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmliblzma/COPYING +65 -0
- mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmlibrhash/COPYING +15 -0
- mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmlibuv/LICENSE +66 -0
- mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmnghttp2/COPYING +23 -0
- mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmzstd/LICENSE +30 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/aclocal/cmake.m4 +44 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX.txt +253 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX_ORDER.txt +12 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX_REGISTRY_VIEW.txt +41 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/GENEX_NOTE.txt +6 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/LINK_OPTIONS_LINKER.txt +25 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_executable.rst +123 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_library.rst +302 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_file_api.rst +78 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_language.rst +536 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_minimum_required.rst +88 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_path.rst +798 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_policy.rst +159 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/create_test_sourcelist.rst +62 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_run_script.rst +15 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_submit.rst +131 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/define_property.rst +117 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/else.rst +10 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/enable_language.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endforeach.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endif.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/export_library_dependencies.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_library.rst +96 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_package.rst +776 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/foreach.rst +138 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_directory_property.rst +41 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_filename_component.rst +76 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_source_file_property.rst +50 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_test_property.rst +35 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/if.rst +505 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/include_directories.rst +44 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/install_files.rst +41 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/load_command.rst +23 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/macro.rst +157 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/make_directory.rst +14 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/mark_as_advanced.rst +28 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/message.rst +250 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/option.rst +18 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/qt_wrap_cpp.rst +23 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/qt_wrap_ui.rst +26 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/separate_arguments.rst +80 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set.rst +129 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_target_properties.rst +26 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/site_name.rst +12 -0
- mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/source_group.rst +71 -0
mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmliblzma/COPYING
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
XZ Utils Licensing
|
| 3 |
+
==================
|
| 4 |
+
|
| 5 |
+
Different licenses apply to different files in this package. Here
|
| 6 |
+
is a rough summary of which licenses apply to which parts of this
|
| 7 |
+
package (but check the individual files to be sure!):
|
| 8 |
+
|
| 9 |
+
- liblzma is in the public domain.
|
| 10 |
+
|
| 11 |
+
- xz, xzdec, and lzmadec command line tools are in the public
|
| 12 |
+
domain unless GNU getopt_long had to be compiled and linked
|
| 13 |
+
in from the lib directory. The getopt_long code is under
|
| 14 |
+
GNU LGPLv2.1+.
|
| 15 |
+
|
| 16 |
+
- The scripts to grep, diff, and view compressed files have been
|
| 17 |
+
adapted from gzip. These scripts and their documentation are
|
| 18 |
+
under GNU GPLv2+.
|
| 19 |
+
|
| 20 |
+
- All the documentation in the doc directory and most of the
|
| 21 |
+
XZ Utils specific documentation files in other directories
|
| 22 |
+
are in the public domain.
|
| 23 |
+
|
| 24 |
+
- Translated messages are in the public domain.
|
| 25 |
+
|
| 26 |
+
- The build system contains public domain files, and files that
|
| 27 |
+
are under GNU GPLv2+ or GNU GPLv3+. None of these files end up
|
| 28 |
+
in the binaries being built.
|
| 29 |
+
|
| 30 |
+
- Test files and test code in the tests directory, and debugging
|
| 31 |
+
utilities in the debug directory are in the public domain.
|
| 32 |
+
|
| 33 |
+
- The extra directory may contain public domain files, and files
|
| 34 |
+
that are under various free software licenses.
|
| 35 |
+
|
| 36 |
+
You can do whatever you want with the files that have been put into
|
| 37 |
+
the public domain. If you find public domain legally problematic,
|
| 38 |
+
take the previous sentence as a license grant. If you still find
|
| 39 |
+
the lack of copyright legally problematic, you have too many
|
| 40 |
+
lawyers.
|
| 41 |
+
|
| 42 |
+
As usual, this software is provided "as is", without any warranty.
|
| 43 |
+
|
| 44 |
+
If you copy significant amounts of public domain code from XZ Utils
|
| 45 |
+
into your project, acknowledging this somewhere in your software is
|
| 46 |
+
polite (especially if it is proprietary, non-free software), but
|
| 47 |
+
naturally it is not legally required. Here is an example of a good
|
| 48 |
+
notice to put into "about box" or into documentation:
|
| 49 |
+
|
| 50 |
+
This software includes code from XZ Utils <https://tukaani.org/xz/>.
|
| 51 |
+
|
| 52 |
+
The following license texts are included in the following files:
|
| 53 |
+
- COPYING.LGPLv2.1: GNU Lesser General Public License version 2.1
|
| 54 |
+
- COPYING.GPLv2: GNU General Public License version 2
|
| 55 |
+
- COPYING.GPLv3: GNU General Public License version 3
|
| 56 |
+
|
| 57 |
+
Note that the toolchain (compiler, linker etc.) may add some code
|
| 58 |
+
pieces that are copyrighted. Thus, it is possible that e.g. liblzma
|
| 59 |
+
binary wouldn't actually be in the public domain in its entirety
|
| 60 |
+
even though it contains no copyrighted code from the XZ Utils source
|
| 61 |
+
package.
|
| 62 |
+
|
| 63 |
+
If you have questions, don't hesitate to ask the author(s) for more
|
| 64 |
+
information.
|
| 65 |
+
|
mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmlibrhash/COPYING
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
BSD Zero Clause License
|
| 3 |
+
|
| 4 |
+
Copyright (c) 2005, Aleksey Kravchenko <rhash.admin@gmail.com>
|
| 5 |
+
|
| 6 |
+
Permission to use, copy, modify, and/or distribute this software for any
|
| 7 |
+
purpose with or without fee is hereby granted.
|
| 8 |
+
|
| 9 |
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
| 10 |
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
| 11 |
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
| 12 |
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
| 13 |
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
| 14 |
+
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
| 15 |
+
PERFORMANCE OF THIS SOFTWARE.
|
mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmlibuv/LICENSE
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
libuv is licensed for use as follows:
|
| 2 |
+
|
| 3 |
+
====
|
| 4 |
+
Copyright (c) 2015-present libuv project contributors.
|
| 5 |
+
|
| 6 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 7 |
+
of this software and associated documentation files (the "Software"), to
|
| 8 |
+
deal in the Software without restriction, including without limitation the
|
| 9 |
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
| 10 |
+
sell copies of the Software, and to permit persons to whom the Software is
|
| 11 |
+
furnished to do so, subject to the following conditions:
|
| 12 |
+
|
| 13 |
+
The above copyright notice and this permission notice shall be included in
|
| 14 |
+
all copies or substantial portions of the Software.
|
| 15 |
+
|
| 16 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 17 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 18 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 19 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 20 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
| 21 |
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
| 22 |
+
IN THE SOFTWARE.
|
| 23 |
+
====
|
| 24 |
+
|
| 25 |
+
This license applies to parts of libuv originating from the
|
| 26 |
+
https://github.com/joyent/libuv repository:
|
| 27 |
+
|
| 28 |
+
====
|
| 29 |
+
|
| 30 |
+
Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
| 31 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 32 |
+
of this software and associated documentation files (the "Software"), to
|
| 33 |
+
deal in the Software without restriction, including without limitation the
|
| 34 |
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
| 35 |
+
sell copies of the Software, and to permit persons to whom the Software is
|
| 36 |
+
furnished to do so, subject to the following conditions:
|
| 37 |
+
|
| 38 |
+
The above copyright notice and this permission notice shall be included in
|
| 39 |
+
all copies or substantial portions of the Software.
|
| 40 |
+
|
| 41 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 42 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 43 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 44 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 45 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
| 46 |
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
| 47 |
+
IN THE SOFTWARE.
|
| 48 |
+
|
| 49 |
+
====
|
| 50 |
+
|
| 51 |
+
This license applies to all parts of libuv that are not externally
|
| 52 |
+
maintained libraries.
|
| 53 |
+
|
| 54 |
+
The externally maintained libraries used by libuv are:
|
| 55 |
+
|
| 56 |
+
- tree.h (from FreeBSD), copyright Niels Provos. Two clause BSD license.
|
| 57 |
+
|
| 58 |
+
- inet_pton and inet_ntop implementations, contained in src/inet.c, are
|
| 59 |
+
copyright the Internet Systems Consortium, Inc., and licensed under the ISC
|
| 60 |
+
license.
|
| 61 |
+
|
| 62 |
+
- stdint-msvc2008.h (from msinttypes), copyright Alexander Chemeris. Three
|
| 63 |
+
clause BSD license.
|
| 64 |
+
|
| 65 |
+
- pthread-fixes.c, copyright Google Inc. and Sony Mobile Communications AB.
|
| 66 |
+
Three clause BSD license.
|
mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmnghttp2/COPYING
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
The MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2012, 2014, 2015, 2016 Tatsuhiro Tsujikawa
|
| 4 |
+
Copyright (c) 2012, 2014, 2015, 2016 nghttp2 contributors
|
| 5 |
+
|
| 6 |
+
Permission is hereby granted, free of charge, to any person obtaining
|
| 7 |
+
a copy of this software and associated documentation files (the
|
| 8 |
+
"Software"), to deal in the Software without restriction, including
|
| 9 |
+
without limitation the rights to use, copy, modify, merge, publish,
|
| 10 |
+
distribute, sublicense, and/or sell copies of the Software, and to
|
| 11 |
+
permit persons to whom the Software is furnished to do so, subject to
|
| 12 |
+
the following conditions:
|
| 13 |
+
|
| 14 |
+
The above copyright notice and this permission notice shall be
|
| 15 |
+
included in all copies or substantial portions of the Software.
|
| 16 |
+
|
| 17 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
| 18 |
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
| 19 |
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
| 20 |
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
| 21 |
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
| 22 |
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
| 23 |
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
mgm/lib/python3.10/site-packages/cmake/data/doc/cmake-3.31/cmzstd/LICENSE
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
BSD License
|
| 2 |
+
|
| 3 |
+
For Zstandard software
|
| 4 |
+
|
| 5 |
+
Copyright (c) Meta Platforms, Inc. and affiliates. All rights reserved.
|
| 6 |
+
|
| 7 |
+
Redistribution and use in source and binary forms, with or without modification,
|
| 8 |
+
are permitted provided that the following conditions are met:
|
| 9 |
+
|
| 10 |
+
* Redistributions of source code must retain the above copyright notice, this
|
| 11 |
+
list of conditions and the following disclaimer.
|
| 12 |
+
|
| 13 |
+
* Redistributions in binary form must reproduce the above copyright notice,
|
| 14 |
+
this list of conditions and the following disclaimer in the documentation
|
| 15 |
+
and/or other materials provided with the distribution.
|
| 16 |
+
|
| 17 |
+
* Neither the name Facebook, nor Meta, nor the names of its contributors may
|
| 18 |
+
be used to endorse or promote products derived from this software without
|
| 19 |
+
specific prior written permission.
|
| 20 |
+
|
| 21 |
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
| 22 |
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
| 23 |
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
| 24 |
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
| 25 |
+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
| 26 |
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
| 27 |
+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
| 28 |
+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
| 29 |
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
| 30 |
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
mgm/lib/python3.10/site-packages/cmake/data/share/aclocal/cmake.m4
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
dnl Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
| 2 |
+
dnl file Copyright.txt or https://cmake.org/licensing for details.
|
| 3 |
+
|
| 4 |
+
AC_DEFUN([CMAKE_FIND_BINARY],
|
| 5 |
+
[AC_ARG_VAR([CMAKE_BINARY], [path to the cmake binary])dnl
|
| 6 |
+
|
| 7 |
+
if test "x$ac_cv_env_CMAKE_BINARY_set" != "xset"; then
|
| 8 |
+
AC_PATH_TOOL([CMAKE_BINARY], [cmake])dnl
|
| 9 |
+
fi
|
| 10 |
+
])dnl
|
| 11 |
+
|
| 12 |
+
# $1: package name
|
| 13 |
+
# $2: language (e.g. C/CXX/Fortran)
|
| 14 |
+
# $3: The compiler ID, defaults to GNU.
|
| 15 |
+
# Possible values are: GNU, Intel, Clang, SunPro, HP, XL, VisualAge, PGI,
|
| 16 |
+
# PathScale, Cray, SCO, MSVC, LCC
|
| 17 |
+
# $4: optional extra arguments to cmake, e.g. "-DCMAKE_SIZEOF_VOID_P=8"
|
| 18 |
+
# $5: optional path to cmake binary
|
| 19 |
+
AC_DEFUN([CMAKE_FIND_PACKAGE], [
|
| 20 |
+
AC_REQUIRE([CMAKE_FIND_BINARY])dnl
|
| 21 |
+
|
| 22 |
+
AC_ARG_VAR([$1][_][$2][FLAGS], [$2 compiler flags for $1. This overrides the cmake output])dnl
|
| 23 |
+
AC_ARG_VAR([$1][_LIBS], [linker flags for $1. This overrides the cmake output])dnl
|
| 24 |
+
|
| 25 |
+
failed=false
|
| 26 |
+
AC_MSG_CHECKING([for $1])
|
| 27 |
+
if test -z "${$1[]_$2[]FLAGS}"; then
|
| 28 |
+
$1[]_$2[]FLAGS=`$CMAKE_BINARY --find-package "-DNAME=$1" "-DCOMPILER_ID=m4_default([$3], [GNU])" "-DLANGUAGE=$2" -DMODE=COMPILE $4` || failed=true
|
| 29 |
+
fi
|
| 30 |
+
if test -z "${$1[]_LIBS}"; then
|
| 31 |
+
$1[]_LIBS=`$CMAKE_BINARY --find-package "-DNAME=$1" "-DCOMPILER_ID=m4_default([$3], [GNU])" "-DLANGUAGE=$2" -DMODE=LINK $4` || failed=true
|
| 32 |
+
fi
|
| 33 |
+
|
| 34 |
+
if $failed; then
|
| 35 |
+
unset $1[]_$2[]FLAGS
|
| 36 |
+
unset $1[]_LIBS
|
| 37 |
+
|
| 38 |
+
AC_MSG_RESULT([no])
|
| 39 |
+
$6
|
| 40 |
+
else
|
| 41 |
+
AC_MSG_RESULT([yes])
|
| 42 |
+
$5
|
| 43 |
+
fi[]dnl
|
| 44 |
+
])
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX.txt
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
A short-hand signature is:
|
| 2 |
+
|
| 3 |
+
.. parsed-literal::
|
| 4 |
+
|
| 5 |
+
|FIND_XXX| (<VAR> name1 [path1 path2 ...])
|
| 6 |
+
|
| 7 |
+
The general signature is:
|
| 8 |
+
|
| 9 |
+
.. parsed-literal::
|
| 10 |
+
|
| 11 |
+
|FIND_XXX| (
|
| 12 |
+
<VAR>
|
| 13 |
+
name | |NAMES|
|
| 14 |
+
[HINTS [path | ENV var]... ]
|
| 15 |
+
[PATHS [path | ENV var]... ]
|
| 16 |
+
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
| 17 |
+
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
| 18 |
+
[VALIDATOR function]
|
| 19 |
+
[DOC "cache documentation string"]
|
| 20 |
+
[NO_CACHE]
|
| 21 |
+
[REQUIRED]
|
| 22 |
+
[NO_DEFAULT_PATH]
|
| 23 |
+
[NO_PACKAGE_ROOT_PATH]
|
| 24 |
+
[NO_CMAKE_PATH]
|
| 25 |
+
[NO_CMAKE_ENVIRONMENT_PATH]
|
| 26 |
+
[NO_SYSTEM_ENVIRONMENT_PATH]
|
| 27 |
+
[NO_CMAKE_SYSTEM_PATH]
|
| 28 |
+
[NO_CMAKE_INSTALL_PREFIX]
|
| 29 |
+
[CMAKE_FIND_ROOT_PATH_BOTH |
|
| 30 |
+
ONLY_CMAKE_FIND_ROOT_PATH |
|
| 31 |
+
NO_CMAKE_FIND_ROOT_PATH]
|
| 32 |
+
)
|
| 33 |
+
|
| 34 |
+
This command is used to find a |SEARCH_XXX_DESC|.
|
| 35 |
+
A cache entry, or a normal variable if ``NO_CACHE`` is specified,
|
| 36 |
+
named by ``<VAR>`` is created to store the result of this command.
|
| 37 |
+
If the |SEARCH_XXX| is found the result is stored in the variable
|
| 38 |
+
and the search will not be repeated unless the variable is cleared.
|
| 39 |
+
If nothing is found, the result will be ``<VAR>-NOTFOUND``.
|
| 40 |
+
|
| 41 |
+
Options include:
|
| 42 |
+
|
| 43 |
+
``NAMES``
|
| 44 |
+
Specify one or more possible names for the |SEARCH_XXX|.
|
| 45 |
+
|
| 46 |
+
When using this to specify names with and without a version
|
| 47 |
+
suffix, we recommend specifying the unversioned name first
|
| 48 |
+
so that locally-built packages can be found before those
|
| 49 |
+
provided by distributions.
|
| 50 |
+
|
| 51 |
+
``HINTS``, ``PATHS``
|
| 52 |
+
Specify directories to search in addition to the default locations.
|
| 53 |
+
The ``ENV var`` sub-option reads paths from a system environment
|
| 54 |
+
variable.
|
| 55 |
+
|
| 56 |
+
.. versionchanged:: 3.24
|
| 57 |
+
On ``Windows`` platform, it is possible to include registry queries as part
|
| 58 |
+
of the directories, using a :ref:`dedicated syntax <Find Using Windows Registry>`.
|
| 59 |
+
Such specifications will be ignored on all other platforms.
|
| 60 |
+
|
| 61 |
+
``REGISTRY_VIEW``
|
| 62 |
+
.. versionadded:: 3.24
|
| 63 |
+
|
| 64 |
+
.. include:: FIND_XXX_REGISTRY_VIEW.txt
|
| 65 |
+
|
| 66 |
+
``PATH_SUFFIXES``
|
| 67 |
+
Specify additional subdirectories to check below each directory
|
| 68 |
+
location otherwise considered.
|
| 69 |
+
|
| 70 |
+
``VALIDATOR``
|
| 71 |
+
.. versionadded:: 3.25
|
| 72 |
+
|
| 73 |
+
Specify a :command:`function` to be called for each candidate item found
|
| 74 |
+
(a :command:`macro` cannot be provided, that will result in an error).
|
| 75 |
+
Two arguments will be passed to the validator function: the name of a
|
| 76 |
+
result variable, and the absolute path to the candidate item. The item
|
| 77 |
+
will be accepted and the search will end unless the function sets the
|
| 78 |
+
value in the result variable to false in the calling scope. The result
|
| 79 |
+
variable will hold a true value when the validator function is entered.
|
| 80 |
+
|
| 81 |
+
.. parsed-literal::
|
| 82 |
+
|
| 83 |
+
function(my_check validator_result_var item)
|
| 84 |
+
if(NOT item MATCHES ...)
|
| 85 |
+
set(${validator_result_var} FALSE PARENT_SCOPE)
|
| 86 |
+
endif()
|
| 87 |
+
endfunction()
|
| 88 |
+
|
| 89 |
+
|FIND_XXX| (result NAMES ... VALIDATOR my_check)
|
| 90 |
+
|
| 91 |
+
Note that if a cached result is used, the search is skipped and any
|
| 92 |
+
``VALIDATOR`` is ignored. The cached result is not required to pass the
|
| 93 |
+
validation function.
|
| 94 |
+
|
| 95 |
+
``DOC``
|
| 96 |
+
Specify the documentation string for the ``<VAR>`` cache entry.
|
| 97 |
+
|
| 98 |
+
``NO_CACHE``
|
| 99 |
+
.. versionadded:: 3.21
|
| 100 |
+
|
| 101 |
+
The result of the search will be stored in a normal variable rather than
|
| 102 |
+
a cache entry.
|
| 103 |
+
|
| 104 |
+
.. note::
|
| 105 |
+
|
| 106 |
+
If the variable is already set before the call (as a normal or cache
|
| 107 |
+
variable) then the search will not occur.
|
| 108 |
+
|
| 109 |
+
.. warning::
|
| 110 |
+
|
| 111 |
+
This option should be used with caution because it can greatly increase
|
| 112 |
+
the cost of repeated configure steps.
|
| 113 |
+
|
| 114 |
+
``REQUIRED``
|
| 115 |
+
.. versionadded:: 3.18
|
| 116 |
+
|
| 117 |
+
Stop processing with an error message if nothing is found, otherwise
|
| 118 |
+
the search will be attempted again the next time |FIND_XXX| is invoked
|
| 119 |
+
with the same variable.
|
| 120 |
+
|
| 121 |
+
If ``NO_DEFAULT_PATH`` is specified, then no additional paths are
|
| 122 |
+
added to the search.
|
| 123 |
+
If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows:
|
| 124 |
+
|
| 125 |
+
.. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR| replace::
|
| 126 |
+
|prefix_XXX_SUBDIR| for each ``<prefix>`` in the
|
| 127 |
+
:variable:`<PackageName>_ROOT` CMake variable and the
|
| 128 |
+
:envvar:`<PackageName>_ROOT` environment variable if
|
| 129 |
+
called from within a find module loaded by
|
| 130 |
+
:command:`find_package(<PackageName>)`
|
| 131 |
+
|
| 132 |
+
.. |CMAKE_PREFIX_PATH_XXX_SUBDIR| replace::
|
| 133 |
+
|prefix_XXX_SUBDIR| for each ``<prefix>`` in :variable:`CMAKE_PREFIX_PATH`
|
| 134 |
+
|
| 135 |
+
.. |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| replace::
|
| 136 |
+
|prefix_XXX_SUBDIR| for each ``<prefix>`` in :envvar:`CMAKE_PREFIX_PATH`
|
| 137 |
+
|
| 138 |
+
.. |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR| replace::
|
| 139 |
+
|prefix_XXX_SUBDIR| for each ``<prefix>/[s]bin`` in ``PATH``, and
|
| 140 |
+
|entry_XXX_SUBDIR| for other entries in ``PATH``
|
| 141 |
+
|
| 142 |
+
.. |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| replace::
|
| 143 |
+
|prefix_XXX_SUBDIR| for each ``<prefix>`` in
|
| 144 |
+
:variable:`CMAKE_SYSTEM_PREFIX_PATH`
|
| 145 |
+
|
| 146 |
+
1. If called from within a find module or any other script loaded by a call to
|
| 147 |
+
:command:`find_package(<PackageName>)`, search prefixes unique to the
|
| 148 |
+
current package being found. See policy :policy:`CMP0074`.
|
| 149 |
+
|
| 150 |
+
.. versionadded:: 3.12
|
| 151 |
+
|
| 152 |
+
Specifically, search paths specified by the following variables, in order:
|
| 153 |
+
|
| 154 |
+
a. :variable:`<PackageName>_ROOT` CMake variable,
|
| 155 |
+
where ``<PackageName>`` is the case-preserved package name.
|
| 156 |
+
|
| 157 |
+
b. :variable:`<PACKAGENAME>_ROOT` CMake variable,
|
| 158 |
+
where ``<PACKAGENAME>`` is the upper-cased package name.
|
| 159 |
+
See policy :policy:`CMP0144`.
|
| 160 |
+
|
| 161 |
+
.. versionadded:: 3.27
|
| 162 |
+
|
| 163 |
+
c. :envvar:`<PackageName>_ROOT` environment variable,
|
| 164 |
+
where ``<PackageName>`` is the case-preserved package name.
|
| 165 |
+
|
| 166 |
+
d. :envvar:`<PACKAGENAME>_ROOT` environment variable,
|
| 167 |
+
where ``<PACKAGENAME>`` is the upper-cased package name.
|
| 168 |
+
See policy :policy:`CMP0144`.
|
| 169 |
+
|
| 170 |
+
.. versionadded:: 3.27
|
| 171 |
+
|
| 172 |
+
The package root variables are maintained as a stack, so if called from
|
| 173 |
+
nested find modules or config packages, root paths from the parent's find
|
| 174 |
+
module or config package will be searched after paths from the current
|
| 175 |
+
module or package. In other words, the search order would be
|
| 176 |
+
``<CurrentPackage>_ROOT``, ``ENV{<CurrentPackage>_ROOT}``,
|
| 177 |
+
``<ParentPackage>_ROOT``, ``ENV{<ParentPackage>_ROOT}``, etc.
|
| 178 |
+
This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting
|
| 179 |
+
the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``.
|
| 180 |
+
|
| 181 |
+
* |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX|
|
| 182 |
+
|
| 183 |
+
2. Search paths specified in cmake-specific cache variables.
|
| 184 |
+
These are intended to be used on the command line with a ``-DVAR=value``.
|
| 185 |
+
The values are interpreted as :ref:`semicolon-separated lists <CMake Language Lists>`.
|
| 186 |
+
This can be skipped if ``NO_CMAKE_PATH`` is passed or by setting the
|
| 187 |
+
:variable:`CMAKE_FIND_USE_CMAKE_PATH` to ``FALSE``.
|
| 188 |
+
|
| 189 |
+
* |CMAKE_PREFIX_PATH_XXX|
|
| 190 |
+
* |CMAKE_XXX_PATH|
|
| 191 |
+
* |CMAKE_XXX_MAC_PATH|
|
| 192 |
+
|
| 193 |
+
3. Search paths specified in cmake-specific environment variables.
|
| 194 |
+
These are intended to be set in the user's shell configuration,
|
| 195 |
+
and therefore use the host's native path separator
|
| 196 |
+
(``;`` on Windows and ``:`` on UNIX).
|
| 197 |
+
This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed or
|
| 198 |
+
by setting the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` to ``FALSE``.
|
| 199 |
+
|
| 200 |
+
* |ENV_CMAKE_PREFIX_PATH_XXX|
|
| 201 |
+
* |ENV_CMAKE_XXX_PATH|
|
| 202 |
+
* |ENV_CMAKE_XXX_MAC_PATH|
|
| 203 |
+
|
| 204 |
+
4. Search the paths specified by the ``HINTS`` option.
|
| 205 |
+
These should be paths computed by system introspection, such as a
|
| 206 |
+
hint provided by the location of another item already found.
|
| 207 |
+
Hard-coded guesses should be specified with the ``PATHS`` option.
|
| 208 |
+
|
| 209 |
+
5. Search the standard system environment variables.
|
| 210 |
+
This can be skipped if ``NO_SYSTEM_ENVIRONMENT_PATH`` is passed or by
|
| 211 |
+
setting the :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` to ``FALSE``.
|
| 212 |
+
|
| 213 |
+
* |SYSTEM_ENVIRONMENT_PATH_XXX|
|
| 214 |
+
|
| 215 |
+
|SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX|
|
| 216 |
+
|
| 217 |
+
6. Search cmake variables defined in the Platform files
|
| 218 |
+
for the current system. The searching of ``CMAKE_INSTALL_PREFIX`` and
|
| 219 |
+
``CMAKE_STAGING_PREFIX`` can be
|
| 220 |
+
skipped if ``NO_CMAKE_INSTALL_PREFIX`` is passed or by setting the
|
| 221 |
+
:variable:`CMAKE_FIND_USE_INSTALL_PREFIX` to ``FALSE``. All these locations
|
| 222 |
+
can be skipped if ``NO_CMAKE_SYSTEM_PATH`` is passed or by setting the
|
| 223 |
+
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` to ``FALSE``.
|
| 224 |
+
|
| 225 |
+
* |CMAKE_SYSTEM_PREFIX_PATH_XXX|
|
| 226 |
+
* |CMAKE_SYSTEM_XXX_PATH|
|
| 227 |
+
* |CMAKE_SYSTEM_XXX_MAC_PATH|
|
| 228 |
+
|
| 229 |
+
The platform paths that these variables contain are locations that
|
| 230 |
+
typically include installed software. An example being ``/usr/local`` for
|
| 231 |
+
UNIX based platforms.
|
| 232 |
+
|
| 233 |
+
7. Search the paths specified by the PATHS option
|
| 234 |
+
or in the short-hand version of the command.
|
| 235 |
+
These are typically hard-coded guesses.
|
| 236 |
+
|
| 237 |
+
The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`,
|
| 238 |
+
:variable:`CMAKE_SYSTEM_IGNORE_PATH` and
|
| 239 |
+
:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some
|
| 240 |
+
of the above locations to be ignored.
|
| 241 |
+
|
| 242 |
+
.. versionadded:: 3.16
|
| 243 |
+
Added ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
|
| 244 |
+
various search locations.
|
| 245 |
+
|
| 246 |
+
.. |FIND_ARGS_XXX| replace:: <VAR> NAMES name
|
| 247 |
+
|
| 248 |
+
On macOS the :variable:`CMAKE_FIND_FRAMEWORK` and
|
| 249 |
+
:variable:`CMAKE_FIND_APPBUNDLE` variables determine the order of
|
| 250 |
+
preference between Apple-style and unix-style package components.
|
| 251 |
+
|
| 252 |
+
.. include:: FIND_XXX_ROOT.txt
|
| 253 |
+
.. include:: FIND_XXX_ORDER.txt
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX_ORDER.txt
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
The default search order is designed to be most-specific to
|
| 2 |
+
least-specific for common use cases.
|
| 3 |
+
Projects may override the order by simply calling the command
|
| 4 |
+
multiple times and using the ``NO_*`` options:
|
| 5 |
+
|
| 6 |
+
.. parsed-literal::
|
| 7 |
+
|
| 8 |
+
|FIND_XXX| (|FIND_ARGS_XXX| PATHS paths... NO_DEFAULT_PATH)
|
| 9 |
+
|FIND_XXX| (|FIND_ARGS_XXX|)
|
| 10 |
+
|
| 11 |
+
Once one of the calls succeeds the result variable will be set
|
| 12 |
+
and stored in the cache so that no call will search again.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/FIND_XXX_REGISTRY_VIEW.txt
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Specify which registry views must be queried. This option is only meaningful
|
| 2 |
+
on ``Windows`` platforms and will be ignored on other ones. When not
|
| 3 |
+
specified, the |FIND_XXX_REGISTRY_VIEW_DEFAULT| view is used when the
|
| 4 |
+
:policy:`CMP0134` policy is ``NEW``. Refer to :policy:`CMP0134` for the
|
| 5 |
+
default view when the policy is ``OLD``.
|
| 6 |
+
|
| 7 |
+
``64``
|
| 8 |
+
Query the 64-bit registry. On 32-bit Windows, it always returns the string
|
| 9 |
+
``/REGISTRY-NOTFOUND``.
|
| 10 |
+
|
| 11 |
+
``32``
|
| 12 |
+
Query the 32-bit registry.
|
| 13 |
+
|
| 14 |
+
``64_32``
|
| 15 |
+
Query both views (``64`` and ``32``) and generate a path for each.
|
| 16 |
+
|
| 17 |
+
``32_64``
|
| 18 |
+
Query both views (``32`` and ``64``) and generate a path for each.
|
| 19 |
+
|
| 20 |
+
``HOST``
|
| 21 |
+
Query the registry matching the architecture of the host: ``64`` on 64-bit
|
| 22 |
+
Windows and ``32`` on 32-bit Windows.
|
| 23 |
+
|
| 24 |
+
``TARGET``
|
| 25 |
+
Query the registry matching the architecture specified by the
|
| 26 |
+
:variable:`CMAKE_SIZEOF_VOID_P` variable. If not defined, fall back to
|
| 27 |
+
``HOST`` view.
|
| 28 |
+
|
| 29 |
+
``BOTH``
|
| 30 |
+
Query both views (``32`` and ``64``). The order depends on the following
|
| 31 |
+
rules: If the :variable:`CMAKE_SIZEOF_VOID_P` variable is defined, use the
|
| 32 |
+
following view depending on the content of this variable:
|
| 33 |
+
|
| 34 |
+
* ``8``: ``64_32``
|
| 35 |
+
* ``4``: ``32_64``
|
| 36 |
+
|
| 37 |
+
If the :variable:`CMAKE_SIZEOF_VOID_P` variable is not defined, rely on the
|
| 38 |
+
architecture of the host:
|
| 39 |
+
|
| 40 |
+
* 64-bit: ``64_32``
|
| 41 |
+
* 32-bit: ``32``
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/GENEX_NOTE.txt
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. |more_see_also| replace:: See the :manual:`cmake-buildsystem(7)` manual
|
| 2 |
+
for more on defining buildsystem properties.
|
| 3 |
+
|
| 4 |
+
Arguments to |command_name| may use generator expressions
|
| 5 |
+
with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
| 6 |
+
manual for available expressions. |more_see_also|
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/LINK_OPTIONS_LINKER.txt
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Handling Compiler Driver Differences
|
| 2 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3 |
+
|
| 4 |
+
To pass options to the linker tool, each compiler driver has its own syntax.
|
| 5 |
+
The ``LINKER:`` prefix and ``,`` separator can be used to specify, in a portable
|
| 6 |
+
way, options to pass to the linker tool. ``LINKER:`` is replaced by the
|
| 7 |
+
appropriate driver option and ``,`` by the appropriate driver separator.
|
| 8 |
+
The driver prefix and driver separator are given by the values of the
|
| 9 |
+
:variable:`CMAKE_<LANG>_LINKER_WRAPPER_FLAG` and
|
| 10 |
+
:variable:`CMAKE_<LANG>_LINKER_WRAPPER_FLAG_SEP` variables.
|
| 11 |
+
|
| 12 |
+
For example, ``"LINKER:-z,defs"`` becomes ``-Xlinker -z -Xlinker defs`` for
|
| 13 |
+
``Clang`` and ``-Wl,-z,defs`` for ``GNU GCC``.
|
| 14 |
+
|
| 15 |
+
The ``LINKER:`` prefix can be specified as part of a ``SHELL:`` prefix
|
| 16 |
+
expression.
|
| 17 |
+
|
| 18 |
+
The ``LINKER:`` prefix supports, as an alternative syntax, specification of
|
| 19 |
+
arguments using the ``SHELL:`` prefix and space as separator. The previous
|
| 20 |
+
example then becomes ``"LINKER:SHELL:-z defs"``.
|
| 21 |
+
|
| 22 |
+
.. note::
|
| 23 |
+
|
| 24 |
+
Specifying the ``SHELL:`` prefix anywhere other than at the beginning of the
|
| 25 |
+
``LINKER:`` prefix is not supported.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_executable.rst
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_executable
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Add an executable to the project using the specified source files.
|
| 9 |
+
|
| 10 |
+
Normal Executables
|
| 11 |
+
^^^^^^^^^^^^^^^^^^
|
| 12 |
+
|
| 13 |
+
.. signature::
|
| 14 |
+
add_executable(<name> <options>... <sources>...)
|
| 15 |
+
:target: normal
|
| 16 |
+
|
| 17 |
+
Add an executable target called ``<name>`` to be built from the source
|
| 18 |
+
files listed in the command invocation.
|
| 19 |
+
|
| 20 |
+
The options are:
|
| 21 |
+
|
| 22 |
+
``WIN32``
|
| 23 |
+
Set the :prop_tgt:`WIN32_EXECUTABLE` target property automatically.
|
| 24 |
+
See documentation of that target property for details.
|
| 25 |
+
|
| 26 |
+
``MACOSX_BUNDLE``
|
| 27 |
+
Set the :prop_tgt:`MACOSX_BUNDLE` target property automatically.
|
| 28 |
+
See documentation of that target property for details.
|
| 29 |
+
|
| 30 |
+
``EXCLUDE_FROM_ALL``
|
| 31 |
+
Set the :prop_tgt:`EXCLUDE_FROM_ALL` target property automatically.
|
| 32 |
+
See documentation of that target property for details.
|
| 33 |
+
|
| 34 |
+
The ``<name>`` corresponds to the logical target name and must be globally
|
| 35 |
+
unique within a project. The actual file name of the executable built is
|
| 36 |
+
constructed based on conventions of the native platform (such as
|
| 37 |
+
``<name>.exe`` or just ``<name>``).
|
| 38 |
+
|
| 39 |
+
.. versionadded:: 3.1
|
| 40 |
+
Source arguments to ``add_executable`` may use "generator expressions" with
|
| 41 |
+
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
| 42 |
+
manual for available expressions.
|
| 43 |
+
|
| 44 |
+
.. versionadded:: 3.11
|
| 45 |
+
The source files can be omitted if they are added later using
|
| 46 |
+
:command:`target_sources`.
|
| 47 |
+
|
| 48 |
+
By default the executable file will be created in the build tree
|
| 49 |
+
directory corresponding to the source tree directory in which the
|
| 50 |
+
command was invoked. See documentation of the
|
| 51 |
+
:prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` target property to change this
|
| 52 |
+
location. See documentation of the :prop_tgt:`OUTPUT_NAME` target property
|
| 53 |
+
to change the ``<name>`` part of the final file name.
|
| 54 |
+
|
| 55 |
+
See the :manual:`cmake-buildsystem(7)` manual for more on defining
|
| 56 |
+
buildsystem properties.
|
| 57 |
+
|
| 58 |
+
See also :prop_sf:`HEADER_FILE_ONLY` on what to do if some sources are
|
| 59 |
+
pre-processed, and you want to have the original sources reachable from
|
| 60 |
+
within IDE.
|
| 61 |
+
|
| 62 |
+
Imported Executables
|
| 63 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 64 |
+
|
| 65 |
+
.. signature::
|
| 66 |
+
add_executable(<name> IMPORTED [GLOBAL])
|
| 67 |
+
:target: IMPORTED
|
| 68 |
+
|
| 69 |
+
Add an :ref:`IMPORTED executable target <Imported Targets>` to reference
|
| 70 |
+
an executable file located outside the project. The target name may be
|
| 71 |
+
referenced like any target built within the project, except that by
|
| 72 |
+
default it is visible only in the directory in which it is created,
|
| 73 |
+
and below.
|
| 74 |
+
|
| 75 |
+
The options are:
|
| 76 |
+
|
| 77 |
+
``GLOBAL``
|
| 78 |
+
Make the target name globally visible.
|
| 79 |
+
|
| 80 |
+
No rules are generated to build imported targets, and the :prop_tgt:`IMPORTED`
|
| 81 |
+
target property is ``True``. Imported executables are useful for convenient
|
| 82 |
+
reference from commands like :command:`add_custom_command`.
|
| 83 |
+
|
| 84 |
+
Details about the imported executable are specified by setting properties
|
| 85 |
+
whose names begin in ``IMPORTED_``. The most important such property is
|
| 86 |
+
:prop_tgt:`IMPORTED_LOCATION` (and its per-configuration version
|
| 87 |
+
:prop_tgt:`IMPORTED_LOCATION_<CONFIG>`) which specifies the location of
|
| 88 |
+
the main executable file on disk. See documentation of the ``IMPORTED_*``
|
| 89 |
+
properties for more information.
|
| 90 |
+
|
| 91 |
+
Alias Executables
|
| 92 |
+
^^^^^^^^^^^^^^^^^
|
| 93 |
+
|
| 94 |
+
.. signature::
|
| 95 |
+
add_executable(<name> ALIAS <target>)
|
| 96 |
+
:target: ALIAS
|
| 97 |
+
|
| 98 |
+
Creates an :ref:`Alias Target <Alias Targets>`, such that ``<name>`` can
|
| 99 |
+
be used to refer to ``<target>`` in subsequent commands. The ``<name>``
|
| 100 |
+
does not appear in the generated buildsystem as a make target. The
|
| 101 |
+
``<target>`` may not be an ``ALIAS``.
|
| 102 |
+
|
| 103 |
+
.. versionadded:: 3.11
|
| 104 |
+
An ``ALIAS`` can target a ``GLOBAL`` :ref:`Imported Target <Imported Targets>`
|
| 105 |
+
|
| 106 |
+
.. versionadded:: 3.18
|
| 107 |
+
An ``ALIAS`` can target a non-``GLOBAL`` Imported Target. Such alias is
|
| 108 |
+
scoped to the directory in which it is created and subdirectories.
|
| 109 |
+
The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the
|
| 110 |
+
alias is global or not.
|
| 111 |
+
|
| 112 |
+
``ALIAS`` targets can be used as targets to read properties
|
| 113 |
+
from, executables for custom commands and custom targets. They can also be
|
| 114 |
+
tested for existence with the regular :command:`if(TARGET)` subcommand.
|
| 115 |
+
The ``<name>`` may not be used to modify properties of ``<target>``, that
|
| 116 |
+
is, it may not be used as the operand of :command:`set_property`,
|
| 117 |
+
:command:`set_target_properties`, :command:`target_link_libraries` etc.
|
| 118 |
+
An ``ALIAS`` target may not be installed or exported.
|
| 119 |
+
|
| 120 |
+
See Also
|
| 121 |
+
^^^^^^^^
|
| 122 |
+
|
| 123 |
+
* :command:`add_library`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/add_library.rst
ADDED
|
@@ -0,0 +1,302 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
add_library
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
.. only:: html
|
| 5 |
+
|
| 6 |
+
.. contents::
|
| 7 |
+
|
| 8 |
+
Add a library to the project using the specified source files.
|
| 9 |
+
|
| 10 |
+
Normal Libraries
|
| 11 |
+
^^^^^^^^^^^^^^^^
|
| 12 |
+
|
| 13 |
+
.. signature::
|
| 14 |
+
add_library(<name> [<type>] [EXCLUDE_FROM_ALL] <sources>...)
|
| 15 |
+
:target: normal
|
| 16 |
+
|
| 17 |
+
Add a library target called ``<name>`` to be built from the source files
|
| 18 |
+
listed in the command invocation.
|
| 19 |
+
|
| 20 |
+
The optional ``<type>`` specifies the type of library to be created:
|
| 21 |
+
|
| 22 |
+
``STATIC``
|
| 23 |
+
An archive of object files for use when linking other targets.
|
| 24 |
+
|
| 25 |
+
``SHARED``
|
| 26 |
+
A dynamic library that may be linked by other targets and loaded
|
| 27 |
+
at runtime.
|
| 28 |
+
|
| 29 |
+
``MODULE``
|
| 30 |
+
A plugin that may not be linked by other targets, but may be
|
| 31 |
+
dynamically loaded at runtime using dlopen-like functionality.
|
| 32 |
+
|
| 33 |
+
If no ``<type>`` is given the default is ``STATIC`` or ``SHARED``
|
| 34 |
+
based on the value of the :variable:`BUILD_SHARED_LIBS` variable.
|
| 35 |
+
|
| 36 |
+
The options are:
|
| 37 |
+
|
| 38 |
+
``EXCLUDE_FROM_ALL``
|
| 39 |
+
Set the :prop_tgt:`EXCLUDE_FROM_ALL` target property automatically.
|
| 40 |
+
See documentation of that target property for details.
|
| 41 |
+
|
| 42 |
+
The ``<name>`` corresponds to the logical target name and must be globally
|
| 43 |
+
unique within a project. The actual file name of the library built is
|
| 44 |
+
constructed based on conventions of the native platform (such as
|
| 45 |
+
``lib<name>.a`` or ``<name>.lib``).
|
| 46 |
+
|
| 47 |
+
.. versionadded:: 3.1
|
| 48 |
+
Source arguments to ``add_library`` may use "generator expressions" with
|
| 49 |
+
the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
|
| 50 |
+
manual for available expressions.
|
| 51 |
+
|
| 52 |
+
.. versionadded:: 3.11
|
| 53 |
+
The source files can be omitted if they are added later using
|
| 54 |
+
:command:`target_sources`.
|
| 55 |
+
|
| 56 |
+
For ``SHARED`` and ``MODULE`` libraries the
|
| 57 |
+
:prop_tgt:`POSITION_INDEPENDENT_CODE` target
|
| 58 |
+
property is set to ``ON`` automatically.
|
| 59 |
+
A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK`
|
| 60 |
+
target property to create an macOS Framework.
|
| 61 |
+
|
| 62 |
+
.. versionadded:: 3.8
|
| 63 |
+
A ``STATIC`` library may be marked with the :prop_tgt:`FRAMEWORK`
|
| 64 |
+
target property to create a static Framework.
|
| 65 |
+
|
| 66 |
+
If a library does not export any symbols, it must not be declared as a
|
| 67 |
+
``SHARED`` library. For example, a Windows resource DLL or a managed C++/CLI
|
| 68 |
+
DLL that exports no unmanaged symbols would need to be a ``MODULE`` library.
|
| 69 |
+
This is because CMake expects a ``SHARED`` library to always have an
|
| 70 |
+
associated import library on Windows.
|
| 71 |
+
|
| 72 |
+
By default the library file will be created in the build tree directory
|
| 73 |
+
corresponding to the source tree directory in which the command was
|
| 74 |
+
invoked. See documentation of the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY`,
|
| 75 |
+
:prop_tgt:`LIBRARY_OUTPUT_DIRECTORY`, and
|
| 76 |
+
:prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` target properties to change this
|
| 77 |
+
location. See documentation of the :prop_tgt:`OUTPUT_NAME` target
|
| 78 |
+
property to change the ``<name>`` part of the final file name.
|
| 79 |
+
|
| 80 |
+
See the :manual:`cmake-buildsystem(7)` manual for more on defining
|
| 81 |
+
buildsystem properties.
|
| 82 |
+
|
| 83 |
+
See also :prop_sf:`HEADER_FILE_ONLY` on what to do if some sources are
|
| 84 |
+
pre-processed, and you want to have the original sources reachable from
|
| 85 |
+
within IDE.
|
| 86 |
+
|
| 87 |
+
.. versionchanged:: 3.30
|
| 88 |
+
|
| 89 |
+
On platforms that do not support shared libraries, ``add_library``
|
| 90 |
+
now fails on calls creating ``SHARED`` libraries instead of
|
| 91 |
+
automatically converting them to ``STATIC`` libraries as before.
|
| 92 |
+
See policy :policy:`CMP0164`.
|
| 93 |
+
|
| 94 |
+
Object Libraries
|
| 95 |
+
^^^^^^^^^^^^^^^^
|
| 96 |
+
|
| 97 |
+
.. signature::
|
| 98 |
+
add_library(<name> OBJECT <sources>...)
|
| 99 |
+
:target: OBJECT
|
| 100 |
+
|
| 101 |
+
Add an :ref:`Object Library <Object Libraries>` to compile source files
|
| 102 |
+
without archiving or linking their object files into a library.
|
| 103 |
+
|
| 104 |
+
Other targets created by ``add_library`` or :command:`add_executable`
|
| 105 |
+
may reference the objects using an expression of the
|
| 106 |
+
form :genex:`$\<TARGET_OBJECTS:objlib\> <TARGET_OBJECTS>` as a source, where
|
| 107 |
+
``objlib`` is the object library name. For example:
|
| 108 |
+
|
| 109 |
+
.. code-block:: cmake
|
| 110 |
+
|
| 111 |
+
add_library(... $<TARGET_OBJECTS:objlib> ...)
|
| 112 |
+
add_executable(... $<TARGET_OBJECTS:objlib> ...)
|
| 113 |
+
|
| 114 |
+
will include objlib's object files in a library and an executable
|
| 115 |
+
along with those compiled from their own sources. Object libraries
|
| 116 |
+
may contain only sources that compile, header files, and other files
|
| 117 |
+
that would not affect linking of a normal library (e.g. ``.txt``).
|
| 118 |
+
They may contain custom commands generating such sources, but not
|
| 119 |
+
``PRE_BUILD``, ``PRE_LINK``, or ``POST_BUILD`` commands. Some native build
|
| 120 |
+
systems (such as Xcode) may not like targets that have only object files, so
|
| 121 |
+
consider adding at least one real source file to any target that references
|
| 122 |
+
:genex:`$\<TARGET_OBJECTS:objlib\> <TARGET_OBJECTS>`.
|
| 123 |
+
|
| 124 |
+
.. versionadded:: 3.12
|
| 125 |
+
Object libraries can be linked to with :command:`target_link_libraries`.
|
| 126 |
+
|
| 127 |
+
Interface Libraries
|
| 128 |
+
^^^^^^^^^^^^^^^^^^^
|
| 129 |
+
|
| 130 |
+
.. signature::
|
| 131 |
+
add_library(<name> INTERFACE)
|
| 132 |
+
:target: INTERFACE
|
| 133 |
+
|
| 134 |
+
Add an :ref:`Interface Library <Interface Libraries>` target that may
|
| 135 |
+
specify usage requirements for dependents but does not compile sources
|
| 136 |
+
and does not produce a library artifact on disk.
|
| 137 |
+
|
| 138 |
+
An interface library with no source files is not included as a target
|
| 139 |
+
in the generated buildsystem. However, it may have
|
| 140 |
+
properties set on it and it may be installed and exported.
|
| 141 |
+
Typically, ``INTERFACE_*`` properties are populated on an interface
|
| 142 |
+
target using the commands:
|
| 143 |
+
|
| 144 |
+
* :command:`set_property`,
|
| 145 |
+
* :command:`target_link_libraries(INTERFACE)`,
|
| 146 |
+
* :command:`target_link_options(INTERFACE)`,
|
| 147 |
+
* :command:`target_include_directories(INTERFACE)`,
|
| 148 |
+
* :command:`target_compile_options(INTERFACE)`,
|
| 149 |
+
* :command:`target_compile_definitions(INTERFACE)`, and
|
| 150 |
+
* :command:`target_sources(INTERFACE)`,
|
| 151 |
+
|
| 152 |
+
and then it is used as an argument to :command:`target_link_libraries`
|
| 153 |
+
like any other target.
|
| 154 |
+
|
| 155 |
+
.. versionadded:: 3.15
|
| 156 |
+
An interface library can have :prop_tgt:`PUBLIC_HEADER` and
|
| 157 |
+
:prop_tgt:`PRIVATE_HEADER` properties. The headers specified by those
|
| 158 |
+
properties can be installed using the :command:`install(TARGETS)` command.
|
| 159 |
+
|
| 160 |
+
.. signature::
|
| 161 |
+
add_library(<name> INTERFACE [EXCLUDE_FROM_ALL] <sources>...)
|
| 162 |
+
:target: INTERFACE-with-sources
|
| 163 |
+
|
| 164 |
+
.. versionadded:: 3.19
|
| 165 |
+
|
| 166 |
+
Add an :ref:`Interface Library <Interface Libraries>` target with
|
| 167 |
+
source files (in addition to usage requirements and properties as
|
| 168 |
+
documented by the :command:`above signature <add_library(INTERFACE)>`).
|
| 169 |
+
Source files may be listed directly in the ``add_library`` call
|
| 170 |
+
or added later by calls to :command:`target_sources` with the
|
| 171 |
+
``PRIVATE`` or ``PUBLIC`` keywords.
|
| 172 |
+
|
| 173 |
+
If an interface library has source files (i.e. the :prop_tgt:`SOURCES`
|
| 174 |
+
target property is set), or header sets (i.e. the :prop_tgt:`HEADER_SETS`
|
| 175 |
+
target property is set), it will appear in the generated buildsystem
|
| 176 |
+
as a build target much like a target defined by the
|
| 177 |
+
:command:`add_custom_target` command. It does not compile any sources,
|
| 178 |
+
but does contain build rules for custom commands created by the
|
| 179 |
+
:command:`add_custom_command` command.
|
| 180 |
+
|
| 181 |
+
The options are:
|
| 182 |
+
|
| 183 |
+
``EXCLUDE_FROM_ALL``
|
| 184 |
+
Set the :prop_tgt:`EXCLUDE_FROM_ALL` target property automatically.
|
| 185 |
+
See documentation of that target property for details.
|
| 186 |
+
|
| 187 |
+
.. note::
|
| 188 |
+
In most command signatures where the ``INTERFACE`` keyword appears,
|
| 189 |
+
the items listed after it only become part of that target's usage
|
| 190 |
+
requirements and are not part of the target's own settings. However,
|
| 191 |
+
in this signature of ``add_library``, the ``INTERFACE`` keyword refers
|
| 192 |
+
to the library type only. Sources listed after it in the ``add_library``
|
| 193 |
+
call are ``PRIVATE`` to the interface library and do not appear in its
|
| 194 |
+
:prop_tgt:`INTERFACE_SOURCES` target property.
|
| 195 |
+
|
| 196 |
+
.. _`add_library imported libraries`:
|
| 197 |
+
|
| 198 |
+
Imported Libraries
|
| 199 |
+
^^^^^^^^^^^^^^^^^^
|
| 200 |
+
|
| 201 |
+
.. signature::
|
| 202 |
+
add_library(<name> <type> IMPORTED [GLOBAL])
|
| 203 |
+
:target: IMPORTED
|
| 204 |
+
|
| 205 |
+
Add an :ref:`IMPORTED library target <Imported Targets>` called ``<name>``.
|
| 206 |
+
The target name may be referenced like any target built within the project,
|
| 207 |
+
except that by default it is visible only in the directory in which it is
|
| 208 |
+
created, and below.
|
| 209 |
+
|
| 210 |
+
The ``<type>`` must be one of:
|
| 211 |
+
|
| 212 |
+
``STATIC``, ``SHARED``, ``MODULE``, ``UNKNOWN``
|
| 213 |
+
References a library file located outside the project. The
|
| 214 |
+
:prop_tgt:`IMPORTED_LOCATION` target property (or its per-configuration
|
| 215 |
+
variant :prop_tgt:`IMPORTED_LOCATION_<CONFIG>`) specifies the
|
| 216 |
+
location of the main library file on disk:
|
| 217 |
+
|
| 218 |
+
* For a ``SHARED`` library on most non-Windows platforms, the main library
|
| 219 |
+
file is the ``.so`` or ``.dylib`` file used by both linkers and dynamic
|
| 220 |
+
loaders. If the referenced library file has a ``SONAME`` (or on macOS,
|
| 221 |
+
has a ``LC_ID_DYLIB`` starting in ``@rpath/``), the value of that field
|
| 222 |
+
should be set in the :prop_tgt:`IMPORTED_SONAME` target property.
|
| 223 |
+
If the referenced library file does not have a ``SONAME``, but the
|
| 224 |
+
platform supports it, then the :prop_tgt:`IMPORTED_NO_SONAME` target
|
| 225 |
+
property should be set.
|
| 226 |
+
|
| 227 |
+
* For a ``SHARED`` library on Windows, the :prop_tgt:`IMPORTED_IMPLIB`
|
| 228 |
+
target property (or its per-configuration variant
|
| 229 |
+
:prop_tgt:`IMPORTED_IMPLIB_<CONFIG>`) specifies the location of the
|
| 230 |
+
DLL import library file (``.lib`` or ``.dll.a``) on disk, and the
|
| 231 |
+
``IMPORTED_LOCATION`` is the location of the ``.dll`` runtime
|
| 232 |
+
library (and is optional, but needed by the :genex:`TARGET_RUNTIME_DLLS`
|
| 233 |
+
generator expression).
|
| 234 |
+
|
| 235 |
+
Additional usage requirements may be specified in ``INTERFACE_*``
|
| 236 |
+
properties.
|
| 237 |
+
|
| 238 |
+
An ``UNKNOWN`` library type is typically only used in the implementation
|
| 239 |
+
of :ref:`Find Modules`. It allows the path to an imported library
|
| 240 |
+
(often found using the :command:`find_library` command) to be used
|
| 241 |
+
without having to know what type of library it is. This is especially
|
| 242 |
+
useful on Windows where a static library and a DLL's import library
|
| 243 |
+
both have the same file extension.
|
| 244 |
+
|
| 245 |
+
``OBJECT``
|
| 246 |
+
References a set of object files located outside the project.
|
| 247 |
+
The :prop_tgt:`IMPORTED_OBJECTS` target property (or its per-configuration
|
| 248 |
+
variant :prop_tgt:`IMPORTED_OBJECTS_<CONFIG>`) specifies the locations of
|
| 249 |
+
object files on disk.
|
| 250 |
+
Additional usage requirements may be specified in ``INTERFACE_*``
|
| 251 |
+
properties.
|
| 252 |
+
|
| 253 |
+
``INTERFACE``
|
| 254 |
+
Does not reference any library or object files on disk, but may
|
| 255 |
+
specify usage requirements in ``INTERFACE_*`` properties.
|
| 256 |
+
|
| 257 |
+
The options are:
|
| 258 |
+
|
| 259 |
+
``GLOBAL``
|
| 260 |
+
Make the target name globally visible.
|
| 261 |
+
|
| 262 |
+
No rules are generated to build imported targets, and the :prop_tgt:`IMPORTED`
|
| 263 |
+
target property is ``True``. Imported libraries are useful for convenient
|
| 264 |
+
reference from commands like :command:`target_link_libraries`.
|
| 265 |
+
|
| 266 |
+
Details about the imported library are specified by setting properties whose
|
| 267 |
+
names begin in ``IMPORTED_`` and ``INTERFACE_``. See documentation of
|
| 268 |
+
such properties for more information.
|
| 269 |
+
|
| 270 |
+
Alias Libraries
|
| 271 |
+
^^^^^^^^^^^^^^^
|
| 272 |
+
|
| 273 |
+
.. signature::
|
| 274 |
+
add_library(<name> ALIAS <target>)
|
| 275 |
+
:target: ALIAS
|
| 276 |
+
|
| 277 |
+
Creates an :ref:`Alias Target <Alias Targets>`, such that ``<name>`` can be
|
| 278 |
+
used to refer to ``<target>`` in subsequent commands. The ``<name>`` does
|
| 279 |
+
not appear in the generated buildsystem as a make target. The ``<target>``
|
| 280 |
+
may not be an ``ALIAS``.
|
| 281 |
+
|
| 282 |
+
.. versionadded:: 3.11
|
| 283 |
+
An ``ALIAS`` can target a ``GLOBAL`` :ref:`Imported Target <Imported Targets>`
|
| 284 |
+
|
| 285 |
+
.. versionadded:: 3.18
|
| 286 |
+
An ``ALIAS`` can target a non-``GLOBAL`` Imported Target. Such alias is
|
| 287 |
+
scoped to the directory in which it is created and below.
|
| 288 |
+
The :prop_tgt:`ALIAS_GLOBAL` target property can be used to check if the
|
| 289 |
+
alias is global or not.
|
| 290 |
+
|
| 291 |
+
``ALIAS`` targets can be used as linkable targets and as targets to
|
| 292 |
+
read properties from. They can also be tested for existence with the
|
| 293 |
+
regular :command:`if(TARGET)` subcommand. The ``<name>`` may not be used
|
| 294 |
+
to modify properties of ``<target>``, that is, it may not be used as the
|
| 295 |
+
operand of :command:`set_property`, :command:`set_target_properties`,
|
| 296 |
+
:command:`target_link_libraries` etc. An ``ALIAS`` target may not be
|
| 297 |
+
installed or exported.
|
| 298 |
+
|
| 299 |
+
See Also
|
| 300 |
+
^^^^^^^^
|
| 301 |
+
|
| 302 |
+
* :command:`add_executable`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_file_api.rst
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_file_api
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.27
|
| 5 |
+
|
| 6 |
+
Enables interacting with the :manual:`CMake file API <cmake-file-api(7)>`.
|
| 7 |
+
|
| 8 |
+
.. signature::
|
| 9 |
+
cmake_file_api(QUERY ...)
|
| 10 |
+
|
| 11 |
+
The ``QUERY`` subcommand adds a file API query for the current CMake
|
| 12 |
+
invocation.
|
| 13 |
+
|
| 14 |
+
.. code-block:: cmake
|
| 15 |
+
|
| 16 |
+
cmake_file_api(
|
| 17 |
+
QUERY
|
| 18 |
+
API_VERSION <version>
|
| 19 |
+
[CODEMODEL <versions>...]
|
| 20 |
+
[CACHE <versions>...]
|
| 21 |
+
[CMAKEFILES <versions>...]
|
| 22 |
+
[TOOLCHAINS <versions>...]
|
| 23 |
+
)
|
| 24 |
+
|
| 25 |
+
The ``API_VERSION`` must always be given. Currently, the only supported
|
| 26 |
+
value for ``<version>`` is 1. See :ref:`file-api v1` for details of the
|
| 27 |
+
reply content and location.
|
| 28 |
+
|
| 29 |
+
Each of the optional keywords ``CODEMODEL``, ``CACHE``, ``CMAKEFILES`` and
|
| 30 |
+
``TOOLCHAINS`` correspond to one of the object kinds that can be requested
|
| 31 |
+
by the project. The ``configureLog`` object kind cannot be set with this
|
| 32 |
+
command, since it must be set before CMake starts reading the top level
|
| 33 |
+
``CMakeLists.txt`` file.
|
| 34 |
+
|
| 35 |
+
For each of the optional keywords, the ``<versions>`` list must contain one
|
| 36 |
+
or more version values of the form ``major`` or ``major.minor``, where
|
| 37 |
+
``major`` and ``minor`` are integers. Projects should list the versions they
|
| 38 |
+
accept in their preferred order, as only the first supported value from the
|
| 39 |
+
list will be selected. The command will ignore versions with a ``major``
|
| 40 |
+
version higher than any major version it supports for that object kind.
|
| 41 |
+
It will raise an error if it encounters an invalid version number, or if none
|
| 42 |
+
of the requested versions is supported.
|
| 43 |
+
|
| 44 |
+
For each type of object kind requested, a query equivalent to a shared,
|
| 45 |
+
stateless query will be added internally. No query file will be created in
|
| 46 |
+
the file system. The reply *will* be written to the file system at
|
| 47 |
+
generation time.
|
| 48 |
+
|
| 49 |
+
It is not an error to add a query for the same thing more than once, whether
|
| 50 |
+
from query files or from multiple calls to ``cmake_file_api(QUERY)``.
|
| 51 |
+
The final set of queries will be a merged combination of all queries
|
| 52 |
+
specified on disk and queries submitted by the project.
|
| 53 |
+
|
| 54 |
+
Example
|
| 55 |
+
^^^^^^^
|
| 56 |
+
|
| 57 |
+
A project may want to use replies from the file API at build time to implement
|
| 58 |
+
some form of verification task. Instead of relying on something outside of
|
| 59 |
+
CMake to create a query file, the project can use ``cmake_file_api(QUERY)``
|
| 60 |
+
to request the required information for the current run. It can then create
|
| 61 |
+
a custom command to run at build time, knowing that the requested information
|
| 62 |
+
should always be available.
|
| 63 |
+
|
| 64 |
+
.. code-block:: cmake
|
| 65 |
+
|
| 66 |
+
cmake_file_api(
|
| 67 |
+
QUERY
|
| 68 |
+
API_VERSION 1
|
| 69 |
+
CODEMODEL 2.3
|
| 70 |
+
TOOLCHAINS 1
|
| 71 |
+
)
|
| 72 |
+
|
| 73 |
+
add_custom_target(verify_project
|
| 74 |
+
COMMAND ${CMAKE_COMMAND}
|
| 75 |
+
-D BUILD_DIR=${CMAKE_BINARY_DIR}
|
| 76 |
+
-D CONFIG=$<CONFIG>
|
| 77 |
+
-P ${CMAKE_CURRENT_SOURCE_DIR}/verify_project.cmake
|
| 78 |
+
)
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_language.rst
ADDED
|
@@ -0,0 +1,536 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_language
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.18
|
| 5 |
+
|
| 6 |
+
Call meta-operations on CMake commands.
|
| 7 |
+
|
| 8 |
+
Synopsis
|
| 9 |
+
^^^^^^^^
|
| 10 |
+
|
| 11 |
+
.. parsed-literal::
|
| 12 |
+
|
| 13 |
+
cmake_language(`CALL`_ <command> [<arg>...])
|
| 14 |
+
cmake_language(`EVAL`_ CODE <code>...)
|
| 15 |
+
cmake_language(`DEFER`_ <options>... CALL <command> [<arg>...])
|
| 16 |
+
cmake_language(`SET_DEPENDENCY_PROVIDER`_ <command> SUPPORTED_METHODS <methods>...)
|
| 17 |
+
cmake_language(`GET_MESSAGE_LOG_LEVEL`_ <out-var>)
|
| 18 |
+
cmake_language(`EXIT`_ <exit-code>)
|
| 19 |
+
|
| 20 |
+
Introduction
|
| 21 |
+
^^^^^^^^^^^^
|
| 22 |
+
|
| 23 |
+
This command will call meta-operations on built-in CMake commands or
|
| 24 |
+
those created via the :command:`macro` or :command:`function` commands.
|
| 25 |
+
|
| 26 |
+
``cmake_language`` does not introduce a new variable or policy scope.
|
| 27 |
+
|
| 28 |
+
Calling Commands
|
| 29 |
+
^^^^^^^^^^^^^^^^
|
| 30 |
+
|
| 31 |
+
.. signature::
|
| 32 |
+
cmake_language(CALL <command> [<arg>...])
|
| 33 |
+
|
| 34 |
+
Calls the named ``<command>`` with the given arguments (if any).
|
| 35 |
+
For example, the code:
|
| 36 |
+
|
| 37 |
+
.. code-block:: cmake
|
| 38 |
+
|
| 39 |
+
set(message_command "message")
|
| 40 |
+
cmake_language(CALL ${message_command} STATUS "Hello World!")
|
| 41 |
+
|
| 42 |
+
is equivalent to
|
| 43 |
+
|
| 44 |
+
.. code-block:: cmake
|
| 45 |
+
|
| 46 |
+
message(STATUS "Hello World!")
|
| 47 |
+
|
| 48 |
+
.. note::
|
| 49 |
+
To ensure consistency of the code, the following commands are not allowed:
|
| 50 |
+
|
| 51 |
+
* ``if`` / ``elseif`` / ``else`` / ``endif``
|
| 52 |
+
* ``block`` / ``endblock``
|
| 53 |
+
* ``while`` / ``endwhile``
|
| 54 |
+
* ``foreach`` / ``endforeach``
|
| 55 |
+
* ``function`` / ``endfunction``
|
| 56 |
+
* ``macro`` / ``endmacro``
|
| 57 |
+
|
| 58 |
+
Evaluating Code
|
| 59 |
+
^^^^^^^^^^^^^^^
|
| 60 |
+
|
| 61 |
+
.. signature::
|
| 62 |
+
cmake_language(EVAL CODE <code>...)
|
| 63 |
+
:target: EVAL
|
| 64 |
+
|
| 65 |
+
Evaluates the ``<code>...`` as CMake code.
|
| 66 |
+
|
| 67 |
+
For example, the code:
|
| 68 |
+
|
| 69 |
+
.. code-block:: cmake
|
| 70 |
+
|
| 71 |
+
set(A TRUE)
|
| 72 |
+
set(B TRUE)
|
| 73 |
+
set(C TRUE)
|
| 74 |
+
set(condition "(A AND B) OR C")
|
| 75 |
+
|
| 76 |
+
cmake_language(EVAL CODE "
|
| 77 |
+
if (${condition})
|
| 78 |
+
message(STATUS TRUE)
|
| 79 |
+
else()
|
| 80 |
+
message(STATUS FALSE)
|
| 81 |
+
endif()"
|
| 82 |
+
)
|
| 83 |
+
|
| 84 |
+
is equivalent to
|
| 85 |
+
|
| 86 |
+
.. code-block:: cmake
|
| 87 |
+
|
| 88 |
+
set(A TRUE)
|
| 89 |
+
set(B TRUE)
|
| 90 |
+
set(C TRUE)
|
| 91 |
+
set(condition "(A AND B) OR C")
|
| 92 |
+
|
| 93 |
+
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/eval.cmake "
|
| 94 |
+
if (${condition})
|
| 95 |
+
message(STATUS TRUE)
|
| 96 |
+
else()
|
| 97 |
+
message(STATUS FALSE)
|
| 98 |
+
endif()"
|
| 99 |
+
)
|
| 100 |
+
|
| 101 |
+
include(${CMAKE_CURRENT_BINARY_DIR}/eval.cmake)
|
| 102 |
+
|
| 103 |
+
Deferring Calls
|
| 104 |
+
^^^^^^^^^^^^^^^
|
| 105 |
+
|
| 106 |
+
.. versionadded:: 3.19
|
| 107 |
+
|
| 108 |
+
.. signature::
|
| 109 |
+
cmake_language(DEFER <options>... CALL <command> [<arg>...])
|
| 110 |
+
|
| 111 |
+
Schedules a call to the named ``<command>`` with the given arguments (if any)
|
| 112 |
+
to occur at a later time. By default, deferred calls are executed as if
|
| 113 |
+
written at the end of the current directory's ``CMakeLists.txt`` file,
|
| 114 |
+
except that they run even after a :command:`return` call. Variable
|
| 115 |
+
references in arguments are evaluated at the time the deferred call is
|
| 116 |
+
executed.
|
| 117 |
+
|
| 118 |
+
The options are:
|
| 119 |
+
|
| 120 |
+
``DIRECTORY <dir>``
|
| 121 |
+
Schedule the call for the end of the given directory instead of the
|
| 122 |
+
current directory. The ``<dir>`` may reference either a source
|
| 123 |
+
directory or its corresponding binary directory. Relative paths are
|
| 124 |
+
treated as relative to the current source directory.
|
| 125 |
+
|
| 126 |
+
The given directory must be known to CMake, being either the top-level
|
| 127 |
+
directory or one added by :command:`add_subdirectory`. Furthermore,
|
| 128 |
+
the given directory must not yet be finished processing. This means
|
| 129 |
+
it can be the current directory or one of its ancestors.
|
| 130 |
+
|
| 131 |
+
``ID <id>``
|
| 132 |
+
Specify an identification for the deferred call.
|
| 133 |
+
The ``<id>`` may not be empty and may not begin with a capital letter ``A-Z``.
|
| 134 |
+
The ``<id>`` may begin with an underscore (``_``) only if it was generated
|
| 135 |
+
automatically by an earlier call that used ``ID_VAR`` to get the id.
|
| 136 |
+
|
| 137 |
+
``ID_VAR <var>``
|
| 138 |
+
Specify a variable in which to store the identification for the
|
| 139 |
+
deferred call. If ``ID <id>`` is not given, a new identification
|
| 140 |
+
will be generated and the generated id will start with an underscore (``_``).
|
| 141 |
+
|
| 142 |
+
The currently scheduled list of deferred calls may be retrieved:
|
| 143 |
+
|
| 144 |
+
.. code-block:: cmake
|
| 145 |
+
|
| 146 |
+
cmake_language(DEFER [DIRECTORY <dir>] GET_CALL_IDS <var>)
|
| 147 |
+
|
| 148 |
+
This will store in ``<var>`` a :ref:`semicolon-separated list <CMake Language
|
| 149 |
+
Lists>` of deferred call ids. The ids are for the directory scope in which
|
| 150 |
+
the calls have been deferred to (i.e. where they will be executed), which can
|
| 151 |
+
be different to the scope in which they were created. The ``DIRECTORY``
|
| 152 |
+
option can be used to specify the scope for which to retrieve the call ids.
|
| 153 |
+
If that option is not given, the call ids for the current directory scope
|
| 154 |
+
will be returned.
|
| 155 |
+
|
| 156 |
+
Details of a specific call may be retrieved from its id:
|
| 157 |
+
|
| 158 |
+
.. code-block:: cmake
|
| 159 |
+
|
| 160 |
+
cmake_language(DEFER [DIRECTORY <dir>] GET_CALL <id> <var>)
|
| 161 |
+
|
| 162 |
+
This will store in ``<var>`` a :ref:`semicolon-separated list <CMake Language
|
| 163 |
+
Lists>` in which the first element is the name of the command to be
|
| 164 |
+
called, and the remaining elements are its unevaluated arguments (any
|
| 165 |
+
contained ``;`` characters are included literally and cannot be distinguished
|
| 166 |
+
from multiple arguments). If multiple calls are scheduled with the same id,
|
| 167 |
+
this retrieves the first one. If no call is scheduled with the given id in
|
| 168 |
+
the specified ``DIRECTORY`` scope (or the current directory scope if no
|
| 169 |
+
``DIRECTORY`` option is given), this stores an empty string in the variable.
|
| 170 |
+
|
| 171 |
+
Deferred calls may be canceled by their id:
|
| 172 |
+
|
| 173 |
+
.. code-block:: cmake
|
| 174 |
+
|
| 175 |
+
cmake_language(DEFER [DIRECTORY <dir>] CANCEL_CALL <id>...)
|
| 176 |
+
|
| 177 |
+
This cancels all deferred calls matching any of the given ids in the specified
|
| 178 |
+
``DIRECTORY`` scope (or the current directory scope if no ``DIRECTORY`` option
|
| 179 |
+
is given). Unknown ids are silently ignored.
|
| 180 |
+
|
| 181 |
+
Deferred Call Examples
|
| 182 |
+
""""""""""""""""""""""
|
| 183 |
+
|
| 184 |
+
For example, the code:
|
| 185 |
+
|
| 186 |
+
.. code-block:: cmake
|
| 187 |
+
|
| 188 |
+
cmake_language(DEFER CALL message "${deferred_message}")
|
| 189 |
+
cmake_language(DEFER ID_VAR id CALL message "Canceled Message")
|
| 190 |
+
cmake_language(DEFER CANCEL_CALL ${id})
|
| 191 |
+
message("Immediate Message")
|
| 192 |
+
set(deferred_message "Deferred Message")
|
| 193 |
+
|
| 194 |
+
prints::
|
| 195 |
+
|
| 196 |
+
Immediate Message
|
| 197 |
+
Deferred Message
|
| 198 |
+
|
| 199 |
+
The ``Canceled Message`` is never printed because its command is
|
| 200 |
+
canceled. The ``deferred_message`` variable reference is not evaluated
|
| 201 |
+
until the call site, so it can be set after the deferred call is scheduled.
|
| 202 |
+
|
| 203 |
+
In order to evaluate variable references immediately when scheduling a
|
| 204 |
+
deferred call, wrap it using ``cmake_language(EVAL)``. However, note that
|
| 205 |
+
arguments will be re-evaluated in the deferred call, though that can be
|
| 206 |
+
avoided by using bracket arguments. For example:
|
| 207 |
+
|
| 208 |
+
.. code-block:: cmake
|
| 209 |
+
|
| 210 |
+
set(deferred_message "Deferred Message 1")
|
| 211 |
+
set(re_evaluated [[${deferred_message}]])
|
| 212 |
+
cmake_language(EVAL CODE "
|
| 213 |
+
cmake_language(DEFER CALL message [[${deferred_message}]])
|
| 214 |
+
cmake_language(DEFER CALL message \"${re_evaluated}\")
|
| 215 |
+
")
|
| 216 |
+
message("Immediate Message")
|
| 217 |
+
set(deferred_message "Deferred Message 2")
|
| 218 |
+
|
| 219 |
+
also prints::
|
| 220 |
+
|
| 221 |
+
Immediate Message
|
| 222 |
+
Deferred Message 1
|
| 223 |
+
Deferred Message 2
|
| 224 |
+
|
| 225 |
+
.. _dependency_providers:
|
| 226 |
+
|
| 227 |
+
Dependency Providers
|
| 228 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 229 |
+
|
| 230 |
+
.. versionadded:: 3.24
|
| 231 |
+
|
| 232 |
+
.. note:: A high-level introduction to this feature can be found in the
|
| 233 |
+
:ref:`Using Dependencies Guide <dependency_providers_overview>`.
|
| 234 |
+
|
| 235 |
+
.. signature::
|
| 236 |
+
cmake_language(SET_DEPENDENCY_PROVIDER <command>
|
| 237 |
+
SUPPORTED_METHODS <methods>...)
|
| 238 |
+
|
| 239 |
+
When a call is made to :command:`find_package` or
|
| 240 |
+
:command:`FetchContent_MakeAvailable`, the call may be forwarded to a
|
| 241 |
+
dependency provider which then has the opportunity to fulfill the request.
|
| 242 |
+
If the request is for one of the ``<methods>`` specified when the provider
|
| 243 |
+
was set, CMake calls the provider's ``<command>`` with a set of
|
| 244 |
+
method-specific arguments. If the provider does not fulfill the request,
|
| 245 |
+
or if the provider doesn't support the request's method, or no provider
|
| 246 |
+
is set, the built-in :command:`find_package` or
|
| 247 |
+
:command:`FetchContent_MakeAvailable` implementation is used to fulfill
|
| 248 |
+
the request in the usual way.
|
| 249 |
+
|
| 250 |
+
One or more of the following values can be specified for the ``<methods>``
|
| 251 |
+
when setting the provider:
|
| 252 |
+
|
| 253 |
+
``FIND_PACKAGE``
|
| 254 |
+
The provider command accepts :command:`find_package` requests.
|
| 255 |
+
|
| 256 |
+
``FETCHCONTENT_MAKEAVAILABLE_SERIAL``
|
| 257 |
+
The provider command accepts :command:`FetchContent_MakeAvailable`
|
| 258 |
+
requests. It expects each dependency to be fed to the provider command
|
| 259 |
+
one at a time, not the whole list in one go.
|
| 260 |
+
|
| 261 |
+
Only one provider can be set at any point in time. If a provider is already
|
| 262 |
+
set when ``cmake_language(SET_DEPENDENCY_PROVIDER)`` is called, the new
|
| 263 |
+
provider replaces the previously set one. The specified ``<command>`` must
|
| 264 |
+
already exist when ``cmake_language(SET_DEPENDENCY_PROVIDER)`` is called.
|
| 265 |
+
As a special case, providing an empty string for the ``<command>`` and no
|
| 266 |
+
``<methods>`` will discard any previously set provider.
|
| 267 |
+
|
| 268 |
+
The dependency provider can only be set while processing one of the files
|
| 269 |
+
specified by the :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` variable.
|
| 270 |
+
Thus, dependency providers can only be set as part of the first call to
|
| 271 |
+
:command:`project`. Calling ``cmake_language(SET_DEPENDENCY_PROVIDER)``
|
| 272 |
+
outside of that context will result in an error.
|
| 273 |
+
|
| 274 |
+
.. versionadded:: 3.30
|
| 275 |
+
The :prop_gbl:`PROPAGATE_TOP_LEVEL_INCLUDES_TO_TRY_COMPILE` global
|
| 276 |
+
property can be set if the dependency provider also wants to be enabled
|
| 277 |
+
in whole-project calls to :command:`try_compile`.
|
| 278 |
+
|
| 279 |
+
.. note::
|
| 280 |
+
The choice of dependency provider should always be under the user's control.
|
| 281 |
+
As a convenience, a project may choose to provide a file that users can
|
| 282 |
+
list in their :variable:`CMAKE_PROJECT_TOP_LEVEL_INCLUDES` variable, but
|
| 283 |
+
the use of such a file should always be the user's choice.
|
| 284 |
+
|
| 285 |
+
Provider commands
|
| 286 |
+
"""""""""""""""""
|
| 287 |
+
|
| 288 |
+
Providers define a single ``<command>`` to accept requests. The name of
|
| 289 |
+
the command should be specific to that provider, not something overly
|
| 290 |
+
generic that another provider might also use. This enables users to compose
|
| 291 |
+
different providers in their own custom provider. The recommended form is
|
| 292 |
+
``xxx_provide_dependency()``, where ``xxx`` is the provider-specific part
|
| 293 |
+
(e.g. ``vcpkg_provide_dependency()``, ``conan_provide_dependency()``,
|
| 294 |
+
``ourcompany_provide_dependency()``, and so on).
|
| 295 |
+
|
| 296 |
+
.. code-block:: cmake
|
| 297 |
+
|
| 298 |
+
xxx_provide_dependency(<method> [<method-specific-args>...])
|
| 299 |
+
|
| 300 |
+
Because some methods expect certain variables to be set in the calling scope,
|
| 301 |
+
the provider command should typically be implemented as a macro rather than a
|
| 302 |
+
function. This ensures it does not introduce a new variable scope.
|
| 303 |
+
|
| 304 |
+
The arguments CMake passes to the dependency provider depend on the type of
|
| 305 |
+
request. The first argument is always the method, and it will only ever
|
| 306 |
+
be one of the ``<methods>`` that was specified when setting the provider.
|
| 307 |
+
|
| 308 |
+
``FIND_PACKAGE``
|
| 309 |
+
The ``<method-specific-args>`` will be everything passed to the
|
| 310 |
+
:command:`find_package` call that requested the dependency. The first of
|
| 311 |
+
these ``<method-specific-args>`` will therefore always be the name of the
|
| 312 |
+
dependency. Dependency names are case-sensitive for this method because
|
| 313 |
+
:command:`find_package` treats them case-sensitively too.
|
| 314 |
+
|
| 315 |
+
If the provider command fulfills the request, it must set the same variable
|
| 316 |
+
that :command:`find_package` expects to be set. For a dependency named
|
| 317 |
+
``depName``, the provider must set ``depName_FOUND`` to true if it fulfilled
|
| 318 |
+
the request. If the provider returns without setting this variable, CMake
|
| 319 |
+
will assume the request was not fulfilled and will fall back to the
|
| 320 |
+
built-in implementation.
|
| 321 |
+
|
| 322 |
+
If the provider needs to call the built-in :command:`find_package`
|
| 323 |
+
implementation as part of its processing, it can do so by including the
|
| 324 |
+
``BYPASS_PROVIDER`` keyword as one of the arguments.
|
| 325 |
+
|
| 326 |
+
``FETCHCONTENT_MAKEAVAILABLE_SERIAL``
|
| 327 |
+
The ``<method-specific-args>`` will be everything passed to the
|
| 328 |
+
:command:`FetchContent_Declare` call that corresponds to the requested
|
| 329 |
+
dependency, with the following exceptions:
|
| 330 |
+
|
| 331 |
+
* If ``SOURCE_DIR`` or ``BINARY_DIR`` were not part of the original
|
| 332 |
+
declared arguments, they will be added with their default values.
|
| 333 |
+
* If :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` is set to ``NEVER``,
|
| 334 |
+
any ``FIND_PACKAGE_ARGS`` will be omitted.
|
| 335 |
+
* The ``OVERRIDE_FIND_PACKAGE`` keyword is always omitted.
|
| 336 |
+
|
| 337 |
+
The first of the ``<method-specific-args>`` will always be the name of the
|
| 338 |
+
dependency. Dependency names are case-insensitive for this method because
|
| 339 |
+
:module:`FetchContent` also treats them case-insensitively.
|
| 340 |
+
|
| 341 |
+
If the provider fulfills the request, it should call
|
| 342 |
+
:command:`FetchContent_SetPopulated`, passing the name of the dependency as
|
| 343 |
+
the first argument. The ``SOURCE_DIR`` and ``BINARY_DIR`` arguments to that
|
| 344 |
+
command should only be given if the provider makes the dependency's source
|
| 345 |
+
and build directories available in exactly the same way as the built-in
|
| 346 |
+
:command:`FetchContent_MakeAvailable` command.
|
| 347 |
+
|
| 348 |
+
If the provider returns without calling :command:`FetchContent_SetPopulated`
|
| 349 |
+
for the named dependency, CMake will assume the request was not fulfilled
|
| 350 |
+
and will fall back to the built-in implementation.
|
| 351 |
+
|
| 352 |
+
Note that empty arguments may be significant for this method (e.g. an empty
|
| 353 |
+
string following a ``GIT_SUBMODULES`` keyword). Therefore, if forwarding
|
| 354 |
+
these arguments on to another command, extra care must be taken to avoid such
|
| 355 |
+
arguments being silently dropped.
|
| 356 |
+
|
| 357 |
+
If ``FETCHCONTENT_SOURCE_DIR_<uppercaseDepName>`` is set, then the
|
| 358 |
+
dependency provider will never see requests for the ``<depName>`` dependency
|
| 359 |
+
for this method. When the user sets such a variable, they are explicitly
|
| 360 |
+
overriding where to get that dependency from and are taking on the
|
| 361 |
+
responsibility that their overriding version meets any requirements for that
|
| 362 |
+
dependency and is compatible with whatever else in the project uses it.
|
| 363 |
+
Depending on the value of :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE`
|
| 364 |
+
and whether the ``OVERRIDE_FIND_PACKAGE`` option was given to
|
| 365 |
+
:command:`FetchContent_Declare`, having
|
| 366 |
+
``FETCHCONTENT_SOURCE_DIR_<uppercaseDepName>`` set may also prevent the
|
| 367 |
+
dependency provider from seeing requests for a ``find_package(depName)``
|
| 368 |
+
call too.
|
| 369 |
+
|
| 370 |
+
Provider Examples
|
| 371 |
+
"""""""""""""""""
|
| 372 |
+
|
| 373 |
+
This first example only intercepts :command:`find_package` calls. The
|
| 374 |
+
provider command runs an external tool which copies the relevant artifacts
|
| 375 |
+
into a provider-specific directory, if that tool knows about the dependency.
|
| 376 |
+
It then relies on the built-in implementation to then find those artifacts.
|
| 377 |
+
:command:`FetchContent_MakeAvailable` calls would not go through the provider.
|
| 378 |
+
|
| 379 |
+
.. code-block:: cmake
|
| 380 |
+
:caption: mycomp_provider.cmake
|
| 381 |
+
|
| 382 |
+
# Always ensure we have the policy settings this provider expects
|
| 383 |
+
cmake_minimum_required(VERSION 3.24)
|
| 384 |
+
|
| 385 |
+
set(MYCOMP_PROVIDER_INSTALL_DIR ${CMAKE_BINARY_DIR}/mycomp_packages
|
| 386 |
+
CACHE PATH "The directory this provider installs packages to"
|
| 387 |
+
)
|
| 388 |
+
# Tell the built-in implementation to look in our area first, unless
|
| 389 |
+
# the find_package() call uses NO_..._PATH options to exclude it
|
| 390 |
+
list(APPEND CMAKE_MODULE_PATH ${MYCOMP_PROVIDER_INSTALL_DIR}/cmake)
|
| 391 |
+
list(APPEND CMAKE_PREFIX_PATH ${MYCOMP_PROVIDER_INSTALL_DIR})
|
| 392 |
+
|
| 393 |
+
macro(mycomp_provide_dependency method package_name)
|
| 394 |
+
execute_process(
|
| 395 |
+
COMMAND some_tool ${package_name} --installdir ${MYCOMP_PROVIDER_INSTALL_DIR}
|
| 396 |
+
COMMAND_ERROR_IS_FATAL ANY
|
| 397 |
+
)
|
| 398 |
+
endmacro()
|
| 399 |
+
|
| 400 |
+
cmake_language(
|
| 401 |
+
SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
|
| 402 |
+
SUPPORTED_METHODS FIND_PACKAGE
|
| 403 |
+
)
|
| 404 |
+
|
| 405 |
+
The user would then typically use the above file like so::
|
| 406 |
+
|
| 407 |
+
cmake -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/path/to/mycomp_provider.cmake ...
|
| 408 |
+
|
| 409 |
+
The next example demonstrates a provider that accepts both methods, but
|
| 410 |
+
only handles one specific dependency. It enforces providing Google Test
|
| 411 |
+
using :module:`FetchContent`, but leaves all other dependencies to be
|
| 412 |
+
fulfilled by CMake's built-in implementation. It accepts a few different
|
| 413 |
+
names, which demonstrates one way of working around projects that hard-code
|
| 414 |
+
an unusual or undesirable way of adding this particular dependency to the
|
| 415 |
+
build. The example also demonstrates how to use the :command:`list` command
|
| 416 |
+
to preserve variables that may be overwritten by a call to
|
| 417 |
+
:command:`FetchContent_MakeAvailable`.
|
| 418 |
+
|
| 419 |
+
.. code-block:: cmake
|
| 420 |
+
:caption: mycomp_provider.cmake
|
| 421 |
+
|
| 422 |
+
cmake_minimum_required(VERSION 3.24)
|
| 423 |
+
|
| 424 |
+
# Because we declare this very early, it will take precedence over any
|
| 425 |
+
# details the project might declare later for the same thing
|
| 426 |
+
include(FetchContent)
|
| 427 |
+
FetchContent_Declare(
|
| 428 |
+
googletest
|
| 429 |
+
GIT_REPOSITORY https://github.com/google/googletest.git
|
| 430 |
+
GIT_TAG e2239ee6043f73722e7aa812a459f54a28552929 # release-1.11.0
|
| 431 |
+
)
|
| 432 |
+
|
| 433 |
+
# Both FIND_PACKAGE and FETCHCONTENT_MAKEAVAILABLE_SERIAL methods provide
|
| 434 |
+
# the package or dependency name as the first method-specific argument.
|
| 435 |
+
macro(mycomp_provide_dependency method dep_name)
|
| 436 |
+
if("${dep_name}" MATCHES "^(gtest|googletest)$")
|
| 437 |
+
# Save our current command arguments in case we are called recursively
|
| 438 |
+
list(APPEND mycomp_provider_args ${method} ${dep_name})
|
| 439 |
+
|
| 440 |
+
# This will forward to the built-in FetchContent implementation,
|
| 441 |
+
# which detects a recursive call for the same thing and avoids calling
|
| 442 |
+
# the provider again if dep_name is the same as the current call.
|
| 443 |
+
FetchContent_MakeAvailable(googletest)
|
| 444 |
+
|
| 445 |
+
# Restore our command arguments
|
| 446 |
+
list(POP_BACK mycomp_provider_args dep_name method)
|
| 447 |
+
|
| 448 |
+
# Tell the caller we fulfilled the request
|
| 449 |
+
if("${method}" STREQUAL "FIND_PACKAGE")
|
| 450 |
+
# We need to set this if we got here from a find_package() call
|
| 451 |
+
# since we used a different method to fulfill the request.
|
| 452 |
+
# This example assumes projects only use the gtest targets,
|
| 453 |
+
# not any of the variables the FindGTest module may define.
|
| 454 |
+
set(${dep_name}_FOUND TRUE)
|
| 455 |
+
elseif(NOT "${dep_name}" STREQUAL "googletest")
|
| 456 |
+
# We used the same method, but were given a different name to the
|
| 457 |
+
# one we populated with. Tell the caller about the name it used.
|
| 458 |
+
FetchContent_SetPopulated(${dep_name}
|
| 459 |
+
SOURCE_DIR "${googletest_SOURCE_DIR}"
|
| 460 |
+
BINARY_DIR "${googletest_BINARY_DIR}"
|
| 461 |
+
)
|
| 462 |
+
endif()
|
| 463 |
+
endif()
|
| 464 |
+
endmacro()
|
| 465 |
+
|
| 466 |
+
cmake_language(
|
| 467 |
+
SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
|
| 468 |
+
SUPPORTED_METHODS
|
| 469 |
+
FIND_PACKAGE
|
| 470 |
+
FETCHCONTENT_MAKEAVAILABLE_SERIAL
|
| 471 |
+
)
|
| 472 |
+
|
| 473 |
+
The final example demonstrates how to modify arguments to a
|
| 474 |
+
:command:`find_package` call. It forces all such calls to have the
|
| 475 |
+
``QUIET`` keyword. It uses the ``BYPASS_PROVIDER`` keyword to prevent
|
| 476 |
+
calling the provider command recursively for the same dependency.
|
| 477 |
+
|
| 478 |
+
.. code-block:: cmake
|
| 479 |
+
:caption: mycomp_provider.cmake
|
| 480 |
+
|
| 481 |
+
cmake_minimum_required(VERSION 3.24)
|
| 482 |
+
|
| 483 |
+
macro(mycomp_provide_dependency method)
|
| 484 |
+
find_package(${ARGN} BYPASS_PROVIDER QUIET)
|
| 485 |
+
endmacro()
|
| 486 |
+
|
| 487 |
+
cmake_language(
|
| 488 |
+
SET_DEPENDENCY_PROVIDER mycomp_provide_dependency
|
| 489 |
+
SUPPORTED_METHODS FIND_PACKAGE
|
| 490 |
+
)
|
| 491 |
+
|
| 492 |
+
Getting current message log level
|
| 493 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 494 |
+
|
| 495 |
+
.. versionadded:: 3.25
|
| 496 |
+
|
| 497 |
+
.. _query_message_log_level:
|
| 498 |
+
|
| 499 |
+
.. signature::
|
| 500 |
+
cmake_language(GET_MESSAGE_LOG_LEVEL <output_variable>)
|
| 501 |
+
|
| 502 |
+
Writes the current :command:`message` logging level
|
| 503 |
+
into the given ``<output_variable>``.
|
| 504 |
+
|
| 505 |
+
See :command:`message` for the possible logging levels.
|
| 506 |
+
|
| 507 |
+
The current message logging level can be set either using the
|
| 508 |
+
:option:`--log-level <cmake --log-level>`
|
| 509 |
+
command line option of the :manual:`cmake(1)` program or using
|
| 510 |
+
the :variable:`CMAKE_MESSAGE_LOG_LEVEL` variable.
|
| 511 |
+
|
| 512 |
+
If both the command line option and the variable are set, the command line
|
| 513 |
+
option takes precedence. If neither are set, the default logging level
|
| 514 |
+
is returned.
|
| 515 |
+
|
| 516 |
+
Terminating Scripts
|
| 517 |
+
^^^^^^^^^^^^^^^^^^^
|
| 518 |
+
|
| 519 |
+
.. versionadded:: 3.29
|
| 520 |
+
|
| 521 |
+
.. signature::
|
| 522 |
+
cmake_language(EXIT <exit-code>)
|
| 523 |
+
|
| 524 |
+
Terminate the current :option:`cmake -P` script and exit with ``<exit-code>``.
|
| 525 |
+
|
| 526 |
+
This command works only in :ref:`script mode <Script Processing Mode>`.
|
| 527 |
+
If used outside of that context, it will cause a fatal error.
|
| 528 |
+
|
| 529 |
+
The ``<exit-code>`` should be non-negative.
|
| 530 |
+
If ``<exit-code>`` is negative, then the behavior
|
| 531 |
+
is unspecified (e.g., on Windows the error code -1
|
| 532 |
+
becomes ``0xffffffff``, and on Linux it becomes 255).
|
| 533 |
+
Exit codes above 255 may not be supported by the underlying
|
| 534 |
+
shell or platform, and some shells may interpret values
|
| 535 |
+
above 125 specially. Therefore, it is advisable to only
|
| 536 |
+
specify an ``<exit-code>`` in the range 0 to 125.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_minimum_required.rst
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_minimum_required
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
Require a minimum version of cmake.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])
|
| 9 |
+
|
| 10 |
+
.. versionadded:: 3.12
|
| 11 |
+
The optional ``<policy_max>`` version.
|
| 12 |
+
|
| 13 |
+
Sets the minimum required version of cmake for a project.
|
| 14 |
+
Also updates the policy settings as explained below.
|
| 15 |
+
|
| 16 |
+
``<min>`` and the optional ``<policy_max>`` are each CMake versions of the
|
| 17 |
+
form ``major.minor[.patch[.tweak]]``, and the ``...`` is literal.
|
| 18 |
+
|
| 19 |
+
If the running version of CMake is lower than the ``<min>`` required
|
| 20 |
+
version it will stop processing the project and report an error.
|
| 21 |
+
The optional ``<policy_max>`` version, if specified, must be at least the
|
| 22 |
+
``<min>`` version and affects policy settings as described in `Policy Settings`_.
|
| 23 |
+
If the running version of CMake is older than 3.12, the extra ``...``
|
| 24 |
+
dots will be seen as version component separators, resulting in the
|
| 25 |
+
``...<max>`` part being ignored and preserving the pre-3.12 behavior
|
| 26 |
+
of basing policies on ``<min>``.
|
| 27 |
+
|
| 28 |
+
This command will set the value of the
|
| 29 |
+
:variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable to ``<min>``.
|
| 30 |
+
|
| 31 |
+
The ``FATAL_ERROR`` option is accepted but ignored by CMake 2.6 and
|
| 32 |
+
higher. It should be specified so CMake versions 2.4 and lower fail
|
| 33 |
+
with an error instead of just a warning.
|
| 34 |
+
|
| 35 |
+
.. note::
|
| 36 |
+
Call the ``cmake_minimum_required()`` command at the beginning of
|
| 37 |
+
the top-level ``CMakeLists.txt`` file even before calling the
|
| 38 |
+
:command:`project` command. It is important to establish version
|
| 39 |
+
and policy settings before invoking other commands whose behavior
|
| 40 |
+
they may affect. See also policy :policy:`CMP0000`.
|
| 41 |
+
|
| 42 |
+
Calling ``cmake_minimum_required()`` inside a :command:`function`
|
| 43 |
+
limits some effects to the function scope when invoked. For example,
|
| 44 |
+
the :variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable won't be set
|
| 45 |
+
in the calling scope. Functions do not introduce their own policy
|
| 46 |
+
scope though, so policy settings of the caller *will* be affected
|
| 47 |
+
(see below). Due to this mix of things that do and do not affect the
|
| 48 |
+
calling scope, calling ``cmake_minimum_required()`` inside a function
|
| 49 |
+
is generally discouraged.
|
| 50 |
+
|
| 51 |
+
.. _`Policy Settings`:
|
| 52 |
+
|
| 53 |
+
Policy Settings
|
| 54 |
+
^^^^^^^^^^^^^^^
|
| 55 |
+
|
| 56 |
+
The ``cmake_minimum_required(VERSION)`` command implicitly invokes the
|
| 57 |
+
:command:`cmake_policy(VERSION)` command to specify that the current
|
| 58 |
+
project code is written for the given range of CMake versions.
|
| 59 |
+
All policies known to the running version of CMake and introduced
|
| 60 |
+
in the ``<min>`` (or ``<max>``, if specified) version or earlier will
|
| 61 |
+
be set to use ``NEW`` behavior. All policies introduced in later
|
| 62 |
+
versions will be unset. This effectively requests behavior preferred
|
| 63 |
+
as of a given CMake version and tells newer CMake versions to warn
|
| 64 |
+
about their new policies.
|
| 65 |
+
|
| 66 |
+
When a ``<min>`` version higher than 2.4 is specified the command
|
| 67 |
+
implicitly invokes
|
| 68 |
+
|
| 69 |
+
.. code-block:: cmake
|
| 70 |
+
|
| 71 |
+
cmake_policy(VERSION <min>[...<max>])
|
| 72 |
+
|
| 73 |
+
which sets CMake policies based on the range of versions specified.
|
| 74 |
+
When a ``<min>`` version 2.4 or lower is given the command implicitly
|
| 75 |
+
invokes
|
| 76 |
+
|
| 77 |
+
.. code-block:: cmake
|
| 78 |
+
|
| 79 |
+
cmake_policy(VERSION 2.4[...<max>])
|
| 80 |
+
|
| 81 |
+
which enables compatibility features for CMake 2.4 and lower.
|
| 82 |
+
|
| 83 |
+
.. include:: DEPRECATED_POLICY_VERSIONS.txt
|
| 84 |
+
|
| 85 |
+
See Also
|
| 86 |
+
^^^^^^^^
|
| 87 |
+
|
| 88 |
+
* :command:`cmake_policy`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_path.rst
ADDED
|
@@ -0,0 +1,798 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_path
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. versionadded:: 3.20
|
| 5 |
+
|
| 6 |
+
This command is for the manipulation of paths. Only syntactic aspects of
|
| 7 |
+
paths are handled, there is no interaction of any kind with any underlying
|
| 8 |
+
file system. The path may represent a non-existing path or even one that
|
| 9 |
+
is not allowed to exist on the current file system or platform.
|
| 10 |
+
For operations that do interact with the filesystem, see the :command:`file`
|
| 11 |
+
command.
|
| 12 |
+
|
| 13 |
+
.. note::
|
| 14 |
+
|
| 15 |
+
The ``cmake_path`` command handles paths in the format of the build system
|
| 16 |
+
(i.e. the host platform), not the target system. When cross-compiling,
|
| 17 |
+
if the path contains elements that are not representable on the host
|
| 18 |
+
platform (e.g. a drive letter when the host is not Windows), the results
|
| 19 |
+
will be unpredictable.
|
| 20 |
+
|
| 21 |
+
Synopsis
|
| 22 |
+
^^^^^^^^
|
| 23 |
+
|
| 24 |
+
.. parsed-literal::
|
| 25 |
+
|
| 26 |
+
`Conventions`_
|
| 27 |
+
|
| 28 |
+
`Path Structure And Terminology`_
|
| 29 |
+
|
| 30 |
+
`Normalization`_
|
| 31 |
+
|
| 32 |
+
`Decomposition`_
|
| 33 |
+
cmake_path(`GET`_ <path-var> :ref:`ROOT_NAME <GET_ROOT_NAME>` <out-var>)
|
| 34 |
+
cmake_path(`GET`_ <path-var> :ref:`ROOT_DIRECTORY <GET_ROOT_DIRECTORY>` <out-var>)
|
| 35 |
+
cmake_path(`GET`_ <path-var> :ref:`ROOT_PATH <GET_ROOT_PATH>` <out-var>)
|
| 36 |
+
cmake_path(`GET`_ <path-var> :ref:`FILENAME <GET_FILENAME>` <out-var>)
|
| 37 |
+
cmake_path(`GET`_ <path-var> :ref:`EXTENSION <GET_EXTENSION>` [LAST_ONLY] <out-var>)
|
| 38 |
+
cmake_path(`GET`_ <path-var> :ref:`STEM <GET_STEM>` [LAST_ONLY] <out-var>)
|
| 39 |
+
cmake_path(`GET`_ <path-var> :ref:`RELATIVE_PART <GET_RELATIVE_PART>` <out-var>)
|
| 40 |
+
cmake_path(`GET`_ <path-var> :ref:`PARENT_PATH <GET_PARENT_PATH>` <out-var>)
|
| 41 |
+
|
| 42 |
+
`Query`_
|
| 43 |
+
cmake_path(`HAS_ROOT_NAME`_ <path-var> <out-var>)
|
| 44 |
+
cmake_path(`HAS_ROOT_DIRECTORY`_ <path-var> <out-var>)
|
| 45 |
+
cmake_path(`HAS_ROOT_PATH`_ <path-var> <out-var>)
|
| 46 |
+
cmake_path(`HAS_FILENAME`_ <path-var> <out-var>)
|
| 47 |
+
cmake_path(`HAS_EXTENSION`_ <path-var> <out-var>)
|
| 48 |
+
cmake_path(`HAS_STEM`_ <path-var> <out-var>)
|
| 49 |
+
cmake_path(`HAS_RELATIVE_PART`_ <path-var> <out-var>)
|
| 50 |
+
cmake_path(`HAS_PARENT_PATH`_ <path-var> <out-var>)
|
| 51 |
+
cmake_path(`IS_ABSOLUTE`_ <path-var> <out-var>)
|
| 52 |
+
cmake_path(`IS_RELATIVE`_ <path-var> <out-var>)
|
| 53 |
+
cmake_path(`IS_PREFIX`_ <path-var> <input> [NORMALIZE] <out-var>)
|
| 54 |
+
cmake_path(`COMPARE`_ <input1> <OP> <input2> <out-var>)
|
| 55 |
+
|
| 56 |
+
`Modification`_
|
| 57 |
+
cmake_path(:ref:`SET <cmake_path-SET>` <path-var> [NORMALIZE] <input>)
|
| 58 |
+
cmake_path(`APPEND`_ <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])
|
| 59 |
+
cmake_path(`APPEND_STRING`_ <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])
|
| 60 |
+
cmake_path(`REMOVE_FILENAME`_ <path-var> [OUTPUT_VARIABLE <out-var>])
|
| 61 |
+
cmake_path(`REPLACE_FILENAME`_ <path-var> <input> [OUTPUT_VARIABLE <out-var>])
|
| 62 |
+
cmake_path(`REMOVE_EXTENSION`_ <path-var> [LAST_ONLY] [OUTPUT_VARIABLE <out-var>])
|
| 63 |
+
cmake_path(`REPLACE_EXTENSION`_ <path-var> [LAST_ONLY] <input> [OUTPUT_VARIABLE <out-var>])
|
| 64 |
+
|
| 65 |
+
`Generation`_
|
| 66 |
+
cmake_path(`NORMAL_PATH`_ <path-var> [OUTPUT_VARIABLE <out-var>])
|
| 67 |
+
cmake_path(`RELATIVE_PATH`_ <path-var> [BASE_DIRECTORY <input>] [OUTPUT_VARIABLE <out-var>])
|
| 68 |
+
cmake_path(`ABSOLUTE_PATH`_ <path-var> [BASE_DIRECTORY <input>] [NORMALIZE] [OUTPUT_VARIABLE <out-var>])
|
| 69 |
+
|
| 70 |
+
`Native Conversion`_
|
| 71 |
+
cmake_path(`NATIVE_PATH`_ <path-var> [NORMALIZE] <out-var>)
|
| 72 |
+
cmake_path(`CONVERT`_ <input> `TO_CMAKE_PATH_LIST`_ <out-var> [NORMALIZE])
|
| 73 |
+
cmake_path(`CONVERT`_ <input> `TO_NATIVE_PATH_LIST`_ <out-var> [NORMALIZE])
|
| 74 |
+
|
| 75 |
+
`Hashing`_
|
| 76 |
+
cmake_path(`HASH`_ <path-var> <out-var>)
|
| 77 |
+
|
| 78 |
+
Conventions
|
| 79 |
+
^^^^^^^^^^^
|
| 80 |
+
|
| 81 |
+
The following conventions are used in this command's documentation:
|
| 82 |
+
|
| 83 |
+
``<path-var>``
|
| 84 |
+
Always the name of a variable. For commands that expect a ``<path-var>``
|
| 85 |
+
as input, the variable must exist and it is expected to hold a single path.
|
| 86 |
+
|
| 87 |
+
``<input>``
|
| 88 |
+
A string literal which may contain a path, path fragment, or multiple paths
|
| 89 |
+
with a special separator depending on the command. See the description of
|
| 90 |
+
each command to see how this is interpreted.
|
| 91 |
+
|
| 92 |
+
``<input>...``
|
| 93 |
+
Zero or more string literal arguments.
|
| 94 |
+
|
| 95 |
+
``<out-var>``
|
| 96 |
+
The name of a variable into which the result of a command will be written.
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
.. _Path Structure And Terminology:
|
| 100 |
+
|
| 101 |
+
Path Structure And Terminology
|
| 102 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 103 |
+
|
| 104 |
+
A path has the following structure (all components are optional, with some
|
| 105 |
+
constraints):
|
| 106 |
+
|
| 107 |
+
::
|
| 108 |
+
|
| 109 |
+
root-name root-directory-separator (item-name directory-separator)* filename
|
| 110 |
+
|
| 111 |
+
``root-name``
|
| 112 |
+
Identifies the root on a filesystem with multiple roots (such as ``"C:"``
|
| 113 |
+
or ``"//myserver"``). It is optional.
|
| 114 |
+
|
| 115 |
+
``root-directory-separator``
|
| 116 |
+
A directory separator that, if present, indicates that this path is
|
| 117 |
+
absolute. If it is missing and the first element other than the
|
| 118 |
+
``root-name`` is an ``item-name``, then the path is relative.
|
| 119 |
+
|
| 120 |
+
``item-name``
|
| 121 |
+
A sequence of characters that aren't directory separators. This name may
|
| 122 |
+
identify a file, a hard link, a symbolic link, or a directory. Two special
|
| 123 |
+
cases are recognized:
|
| 124 |
+
|
| 125 |
+
* The item name consisting of a single dot character ``.`` is a
|
| 126 |
+
directory name that refers to the current directory.
|
| 127 |
+
|
| 128 |
+
* The item name consisting of two dot characters ``..`` is a
|
| 129 |
+
directory name that refers to the parent directory.
|
| 130 |
+
|
| 131 |
+
The ``(...)*`` pattern shown above is to indicate that there can be zero
|
| 132 |
+
or more item names, with multiple items separated by a
|
| 133 |
+
``directory-separator``. The ``()*`` characters are not part of the path.
|
| 134 |
+
|
| 135 |
+
``directory-separator``
|
| 136 |
+
The only recognized directory separator is a forward slash character ``/``.
|
| 137 |
+
If this character is repeated, it is treated as a single directory
|
| 138 |
+
separator. In other words, ``/usr///////lib`` is the same as ``/usr/lib``.
|
| 139 |
+
|
| 140 |
+
.. _FILENAME_DEF:
|
| 141 |
+
.. _EXTENSION_DEF:
|
| 142 |
+
.. _STEM_DEF:
|
| 143 |
+
|
| 144 |
+
``filename``
|
| 145 |
+
A path has a ``filename`` if it does not end with a ``directory-separator``.
|
| 146 |
+
The ``filename`` is effectively the last ``item-name`` of the path, so it
|
| 147 |
+
can also be a hard link, symbolic link or a directory.
|
| 148 |
+
|
| 149 |
+
A ``filename`` can have an *extension*. By default, the extension is
|
| 150 |
+
defined as the sub-string beginning at the left-most period (including
|
| 151 |
+
the period) and until the end of the ``filename``. In commands that
|
| 152 |
+
accept a ``LAST_ONLY`` keyword, ``LAST_ONLY`` changes the interpretation
|
| 153 |
+
to the sub-string beginning at the right-most period.
|
| 154 |
+
|
| 155 |
+
The following exceptions apply to the above interpretation:
|
| 156 |
+
|
| 157 |
+
* If the first character in the ``filename`` is a period, that period is
|
| 158 |
+
ignored (i.e. a ``filename`` like ``".profile"`` is treated as having
|
| 159 |
+
no extension).
|
| 160 |
+
|
| 161 |
+
* If the ``filename`` is either ``.`` or ``..``, it has no extension.
|
| 162 |
+
|
| 163 |
+
The *stem* is the part of the ``filename`` before the extension.
|
| 164 |
+
|
| 165 |
+
Some commands refer to a ``root-path``. This is the concatenation of
|
| 166 |
+
``root-name`` and ``root-directory-separator``, either or both of which can
|
| 167 |
+
be empty. A ``relative-part`` refers to the full path with any ``root-path``
|
| 168 |
+
removed.
|
| 169 |
+
|
| 170 |
+
|
| 171 |
+
Creating A Path Variable
|
| 172 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 173 |
+
|
| 174 |
+
While a path can be created with care using an ordinary :command:`set`
|
| 175 |
+
command, it is recommended to use :ref:`cmake_path(SET) <cmake_path-SET>`
|
| 176 |
+
instead, as it automatically converts the path to the required form where
|
| 177 |
+
required. The :ref:`cmake_path(APPEND) <APPEND>` subcommand may
|
| 178 |
+
be another suitable alternative where a path needs to be constructed by
|
| 179 |
+
joining fragments. The following example compares the three methods for
|
| 180 |
+
constructing the same path:
|
| 181 |
+
|
| 182 |
+
.. code-block:: cmake
|
| 183 |
+
|
| 184 |
+
set(path1 "${CMAKE_CURRENT_SOURCE_DIR}/data")
|
| 185 |
+
|
| 186 |
+
cmake_path(SET path2 "${CMAKE_CURRENT_SOURCE_DIR}/data")
|
| 187 |
+
|
| 188 |
+
cmake_path(APPEND path3 "${CMAKE_CURRENT_SOURCE_DIR}" "data")
|
| 189 |
+
|
| 190 |
+
`Modification`_ and `Generation`_ sub-commands can either store the result
|
| 191 |
+
in-place, or in a separate variable named after an ``OUTPUT_VARIABLE``
|
| 192 |
+
keyword. All other sub-commands store the result in a mandatory ``<out-var>``
|
| 193 |
+
variable.
|
| 194 |
+
|
| 195 |
+
.. _Normalization:
|
| 196 |
+
|
| 197 |
+
Normalization
|
| 198 |
+
^^^^^^^^^^^^^
|
| 199 |
+
|
| 200 |
+
Some sub-commands support *normalizing* a path. The algorithm used to
|
| 201 |
+
normalize a path is as follows:
|
| 202 |
+
|
| 203 |
+
1. If the path is empty, stop (the normalized form of an empty path is
|
| 204 |
+
also an empty path).
|
| 205 |
+
2. Replace each ``directory-separator``, which may consist of multiple
|
| 206 |
+
separators, with a single ``/`` (``/a///b --> /a/b``).
|
| 207 |
+
3. Remove each solitary period (``.``) and any immediately following
|
| 208 |
+
``directory-separator`` (``/a/./b/. --> /a/b``).
|
| 209 |
+
4. Remove each ``item-name`` (other than ``..``) that is immediately
|
| 210 |
+
followed by a ``directory-separator`` and a ``..``, along with any
|
| 211 |
+
immediately following ``directory-separator`` (``/a/b/../c --> a/c``).
|
| 212 |
+
5. If there is a ``root-directory``, remove any ``..`` and any
|
| 213 |
+
``directory-separators`` immediately following them. The parent of the
|
| 214 |
+
root directory is treated as still the root directory (``/../a --> /a``).
|
| 215 |
+
6. If the last ``item-name`` is ``..``, remove any trailing
|
| 216 |
+
``directory-separator`` (``../ --> ..``).
|
| 217 |
+
7. If the path is empty by this stage, add a ``dot`` (normal form of ``./``
|
| 218 |
+
is ``.``).
|
| 219 |
+
|
| 220 |
+
|
| 221 |
+
.. _Path Decomposition:
|
| 222 |
+
|
| 223 |
+
Decomposition
|
| 224 |
+
^^^^^^^^^^^^^
|
| 225 |
+
|
| 226 |
+
.. _GET:
|
| 227 |
+
.. _GET_ROOT_NAME:
|
| 228 |
+
.. _GET_ROOT_DIRECTORY:
|
| 229 |
+
.. _GET_ROOT_PATH:
|
| 230 |
+
.. _GET_FILENAME:
|
| 231 |
+
.. _GET_EXTENSION:
|
| 232 |
+
.. _GET_STEM:
|
| 233 |
+
.. _GET_RELATIVE_PART:
|
| 234 |
+
.. _GET_PARENT_PATH:
|
| 235 |
+
|
| 236 |
+
The following forms of the ``GET`` subcommand each retrieve a different
|
| 237 |
+
component or group of components from a path. See
|
| 238 |
+
`Path Structure And Terminology`_ for the meaning of each path component.
|
| 239 |
+
|
| 240 |
+
.. code-block:: cmake
|
| 241 |
+
|
| 242 |
+
cmake_path(GET <path-var> ROOT_NAME <out-var>)
|
| 243 |
+
cmake_path(GET <path-var> ROOT_DIRECTORY <out-var>)
|
| 244 |
+
cmake_path(GET <path-var> ROOT_PATH <out-var>)
|
| 245 |
+
cmake_path(GET <path-var> FILENAME <out-var>)
|
| 246 |
+
cmake_path(GET <path-var> EXTENSION [LAST_ONLY] <out-var>)
|
| 247 |
+
cmake_path(GET <path-var> STEM [LAST_ONLY] <out-var>)
|
| 248 |
+
cmake_path(GET <path-var> RELATIVE_PART <out-var>)
|
| 249 |
+
cmake_path(GET <path-var> PARENT_PATH <out-var>)
|
| 250 |
+
|
| 251 |
+
If a requested component is not present in the path, an empty string will be
|
| 252 |
+
stored in ``<out-var>``. For example, only Windows systems have the concept
|
| 253 |
+
of a ``root-name``, so when the host machine is non-Windows, the ``ROOT_NAME``
|
| 254 |
+
subcommand will always return an empty string.
|
| 255 |
+
|
| 256 |
+
For ``PARENT_PATH``, if the `HAS_RELATIVE_PART`_ subcommand returns false,
|
| 257 |
+
the result is a copy of ``<path-var>``. Note that this implies that a root
|
| 258 |
+
directory is considered to have a parent, with that parent being itself.
|
| 259 |
+
Where `HAS_RELATIVE_PART`_ returns true, the result will essentially be
|
| 260 |
+
``<path-var>`` with one less element.
|
| 261 |
+
|
| 262 |
+
Root examples
|
| 263 |
+
"""""""""""""
|
| 264 |
+
|
| 265 |
+
.. code-block:: cmake
|
| 266 |
+
|
| 267 |
+
set(path "c:/a")
|
| 268 |
+
|
| 269 |
+
cmake_path(GET path ROOT_NAME rootName)
|
| 270 |
+
cmake_path(GET path ROOT_DIRECTORY rootDir)
|
| 271 |
+
cmake_path(GET path ROOT_PATH rootPath)
|
| 272 |
+
|
| 273 |
+
message("Root name is \"${rootName}\"")
|
| 274 |
+
message("Root directory is \"${rootDir}\"")
|
| 275 |
+
message("Root path is \"${rootPath}\"")
|
| 276 |
+
|
| 277 |
+
::
|
| 278 |
+
|
| 279 |
+
Root name is "c:"
|
| 280 |
+
Root directory is "/"
|
| 281 |
+
Root path is "c:/"
|
| 282 |
+
|
| 283 |
+
Filename examples
|
| 284 |
+
"""""""""""""""""
|
| 285 |
+
|
| 286 |
+
.. code-block:: cmake
|
| 287 |
+
|
| 288 |
+
set(path "/a/b")
|
| 289 |
+
cmake_path(GET path FILENAME filename)
|
| 290 |
+
message("First filename is \"${filename}\"")
|
| 291 |
+
|
| 292 |
+
# Trailing slash means filename is empty
|
| 293 |
+
set(path "/a/b/")
|
| 294 |
+
cmake_path(GET path FILENAME filename)
|
| 295 |
+
message("Second filename is \"${filename}\"")
|
| 296 |
+
|
| 297 |
+
::
|
| 298 |
+
|
| 299 |
+
First filename is "b"
|
| 300 |
+
Second filename is ""
|
| 301 |
+
|
| 302 |
+
Extension and stem examples
|
| 303 |
+
"""""""""""""""""""""""""""
|
| 304 |
+
|
| 305 |
+
.. code-block:: cmake
|
| 306 |
+
|
| 307 |
+
set(path "name.ext1.ext2")
|
| 308 |
+
|
| 309 |
+
cmake_path(GET path EXTENSION fullExt)
|
| 310 |
+
cmake_path(GET path STEM fullStem)
|
| 311 |
+
message("Full extension is \"${fullExt}\"")
|
| 312 |
+
message("Full stem is \"${fullStem}\"")
|
| 313 |
+
|
| 314 |
+
# Effect of LAST_ONLY
|
| 315 |
+
cmake_path(GET path EXTENSION LAST_ONLY lastExt)
|
| 316 |
+
cmake_path(GET path STEM LAST_ONLY lastStem)
|
| 317 |
+
message("Last extension is \"${lastExt}\"")
|
| 318 |
+
message("Last stem is \"${lastStem}\"")
|
| 319 |
+
|
| 320 |
+
# Special cases
|
| 321 |
+
set(dotPath "/a/.")
|
| 322 |
+
set(dotDotPath "/a/..")
|
| 323 |
+
set(someMorePath "/a/.some.more")
|
| 324 |
+
cmake_path(GET dotPath EXTENSION dotExt)
|
| 325 |
+
cmake_path(GET dotPath STEM dotStem)
|
| 326 |
+
cmake_path(GET dotDotPath EXTENSION dotDotExt)
|
| 327 |
+
cmake_path(GET dotDotPath STEM dotDotStem)
|
| 328 |
+
cmake_path(GET dotMorePath EXTENSION someMoreExt)
|
| 329 |
+
cmake_path(GET dotMorePath STEM someMoreStem)
|
| 330 |
+
message("Dot extension is \"${dotExt}\"")
|
| 331 |
+
message("Dot stem is \"${dotStem}\"")
|
| 332 |
+
message("Dot-dot extension is \"${dotDotExt}\"")
|
| 333 |
+
message("Dot-dot stem is \"${dotDotStem}\"")
|
| 334 |
+
message(".some.more extension is \"${someMoreExt}\"")
|
| 335 |
+
message(".some.more stem is \"${someMoreStem}\"")
|
| 336 |
+
|
| 337 |
+
::
|
| 338 |
+
|
| 339 |
+
Full extension is ".ext1.ext2"
|
| 340 |
+
Full stem is "name"
|
| 341 |
+
Last extension is ".ext2"
|
| 342 |
+
Last stem is "name.ext1"
|
| 343 |
+
Dot extension is ""
|
| 344 |
+
Dot stem is "."
|
| 345 |
+
Dot-dot extension is ""
|
| 346 |
+
Dot-dot stem is ".."
|
| 347 |
+
.some.more extension is ".more"
|
| 348 |
+
.some.more stem is ".some"
|
| 349 |
+
|
| 350 |
+
Relative part examples
|
| 351 |
+
""""""""""""""""""""""
|
| 352 |
+
|
| 353 |
+
.. code-block:: cmake
|
| 354 |
+
|
| 355 |
+
set(path "c:/a/b")
|
| 356 |
+
cmake_path(GET path RELATIVE_PART result)
|
| 357 |
+
message("Relative part is \"${result}\"")
|
| 358 |
+
|
| 359 |
+
set(path "c/d")
|
| 360 |
+
cmake_path(GET path RELATIVE_PART result)
|
| 361 |
+
message("Relative part is \"${result}\"")
|
| 362 |
+
|
| 363 |
+
set(path "/")
|
| 364 |
+
cmake_path(GET path RELATIVE_PART result)
|
| 365 |
+
message("Relative part is \"${result}\"")
|
| 366 |
+
|
| 367 |
+
::
|
| 368 |
+
|
| 369 |
+
Relative part is "a/b"
|
| 370 |
+
Relative part is "c/d"
|
| 371 |
+
Relative part is ""
|
| 372 |
+
|
| 373 |
+
Path traversal examples
|
| 374 |
+
"""""""""""""""""""""""
|
| 375 |
+
|
| 376 |
+
.. code-block:: cmake
|
| 377 |
+
|
| 378 |
+
set(path "c:/a/b")
|
| 379 |
+
cmake_path(GET path PARENT_PATH result)
|
| 380 |
+
message("Parent path is \"${result}\"")
|
| 381 |
+
|
| 382 |
+
set(path "c:/")
|
| 383 |
+
cmake_path(GET path PARENT_PATH result)
|
| 384 |
+
message("Parent path is \"${result}\"")
|
| 385 |
+
|
| 386 |
+
::
|
| 387 |
+
|
| 388 |
+
Parent path is "c:/a"
|
| 389 |
+
Parent path is "c:/"
|
| 390 |
+
|
| 391 |
+
|
| 392 |
+
.. _Path Query:
|
| 393 |
+
|
| 394 |
+
Query
|
| 395 |
+
^^^^^
|
| 396 |
+
|
| 397 |
+
Each of the ``GET`` subcommands has a corresponding ``HAS_...``
|
| 398 |
+
subcommand which can be used to discover whether a particular path
|
| 399 |
+
component is present. See `Path Structure And Terminology`_ for the
|
| 400 |
+
meaning of each path component.
|
| 401 |
+
|
| 402 |
+
.. _HAS_ROOT_NAME:
|
| 403 |
+
.. _HAS_ROOT_DIRECTORY:
|
| 404 |
+
.. _HAS_ROOT_PATH:
|
| 405 |
+
.. _HAS_FILENAME:
|
| 406 |
+
.. _HAS_EXTENSION:
|
| 407 |
+
.. _HAS_STEM:
|
| 408 |
+
.. _HAS_RELATIVE_PART:
|
| 409 |
+
.. _HAS_PARENT_PATH:
|
| 410 |
+
|
| 411 |
+
.. code-block:: cmake
|
| 412 |
+
|
| 413 |
+
cmake_path(HAS_ROOT_NAME <path-var> <out-var>)
|
| 414 |
+
cmake_path(HAS_ROOT_DIRECTORY <path-var> <out-var>)
|
| 415 |
+
cmake_path(HAS_ROOT_PATH <path-var> <out-var>)
|
| 416 |
+
cmake_path(HAS_FILENAME <path-var> <out-var>)
|
| 417 |
+
cmake_path(HAS_EXTENSION <path-var> <out-var>)
|
| 418 |
+
cmake_path(HAS_STEM <path-var> <out-var>)
|
| 419 |
+
cmake_path(HAS_RELATIVE_PART <path-var> <out-var>)
|
| 420 |
+
cmake_path(HAS_PARENT_PATH <path-var> <out-var>)
|
| 421 |
+
|
| 422 |
+
Each of the above follows the predictable pattern of setting ``<out-var>``
|
| 423 |
+
to true if the path has the associated component, or false otherwise.
|
| 424 |
+
Note the following special cases:
|
| 425 |
+
|
| 426 |
+
* For ``HAS_ROOT_PATH``, a true result will only be returned if at least one
|
| 427 |
+
of ``root-name`` or ``root-directory`` is non-empty.
|
| 428 |
+
|
| 429 |
+
* For ``HAS_PARENT_PATH``, the root directory is also considered to have a
|
| 430 |
+
parent, which will be itself. The result is true except if the path
|
| 431 |
+
consists of just a :ref:`filename <FILENAME_DEF>`.
|
| 432 |
+
|
| 433 |
+
.. _IS_ABSOLUTE:
|
| 434 |
+
|
| 435 |
+
.. code-block:: cmake
|
| 436 |
+
|
| 437 |
+
cmake_path(IS_ABSOLUTE <path-var> <out-var>)
|
| 438 |
+
|
| 439 |
+
Sets ``<out-var>`` to true if ``<path-var>`` is absolute. An absolute path
|
| 440 |
+
is a path that unambiguously identifies the location of a file without
|
| 441 |
+
reference to an additional starting location. On Windows, this means the
|
| 442 |
+
path must have both a ``root-name`` and a ``root-directory-separator`` to be
|
| 443 |
+
considered absolute. On other platforms, just a ``root-directory-separator``
|
| 444 |
+
is sufficient. Note that this means on Windows, ``IS_ABSOLUTE`` can be
|
| 445 |
+
false while ``HAS_ROOT_DIRECTORY`` can be true.
|
| 446 |
+
|
| 447 |
+
.. _IS_RELATIVE:
|
| 448 |
+
|
| 449 |
+
.. code-block:: cmake
|
| 450 |
+
|
| 451 |
+
cmake_path(IS_RELATIVE <path-var> <out-var>)
|
| 452 |
+
|
| 453 |
+
This will store the opposite of ``IS_ABSOLUTE`` in ``<out-var>``.
|
| 454 |
+
|
| 455 |
+
.. _IS_PREFIX:
|
| 456 |
+
|
| 457 |
+
.. code-block:: cmake
|
| 458 |
+
|
| 459 |
+
cmake_path(IS_PREFIX <path-var> <input> [NORMALIZE] <out-var>)
|
| 460 |
+
|
| 461 |
+
Checks if ``<path-var>`` is the prefix of ``<input>``.
|
| 462 |
+
|
| 463 |
+
When the ``NORMALIZE`` option is specified, ``<path-var>`` and ``<input>``
|
| 464 |
+
are :ref:`normalized <Normalization>` before the check.
|
| 465 |
+
|
| 466 |
+
.. code-block:: cmake
|
| 467 |
+
|
| 468 |
+
set(path "/a/b/c")
|
| 469 |
+
cmake_path(IS_PREFIX path "/a/b/c/d" result) # result = true
|
| 470 |
+
cmake_path(IS_PREFIX path "/a/b" result) # result = false
|
| 471 |
+
cmake_path(IS_PREFIX path "/x/y/z" result) # result = false
|
| 472 |
+
|
| 473 |
+
set(path "/a/b")
|
| 474 |
+
cmake_path(IS_PREFIX path "/a/c/../b" NORMALIZE result) # result = true
|
| 475 |
+
|
| 476 |
+
.. _Path COMPARE:
|
| 477 |
+
.. _COMPARE:
|
| 478 |
+
|
| 479 |
+
.. code-block:: cmake
|
| 480 |
+
|
| 481 |
+
cmake_path(COMPARE <input1> EQUAL <input2> <out-var>)
|
| 482 |
+
cmake_path(COMPARE <input1> NOT_EQUAL <input2> <out-var>)
|
| 483 |
+
|
| 484 |
+
Compares the lexical representations of two paths provided as string literals.
|
| 485 |
+
No normalization is performed on either path, except multiple consecutive
|
| 486 |
+
directory separators are effectively collapsed into a single separator.
|
| 487 |
+
Equality is determined according to the following pseudo-code logic:
|
| 488 |
+
|
| 489 |
+
::
|
| 490 |
+
|
| 491 |
+
if(NOT <input1>.root_name() STREQUAL <input2>.root_name())
|
| 492 |
+
return FALSE
|
| 493 |
+
|
| 494 |
+
if(<input1>.has_root_directory() XOR <input2>.has_root_directory())
|
| 495 |
+
return FALSE
|
| 496 |
+
|
| 497 |
+
Return FALSE if a relative portion of <input1> is not lexicographically
|
| 498 |
+
equal to the relative portion of <input2>. This comparison is performed path
|
| 499 |
+
component-wise. If all of the components compare equal, then return TRUE.
|
| 500 |
+
|
| 501 |
+
.. note::
|
| 502 |
+
Unlike most other ``cmake_path()`` subcommands, the ``COMPARE`` subcommand
|
| 503 |
+
takes literal strings as input, not the names of variables.
|
| 504 |
+
|
| 505 |
+
|
| 506 |
+
.. _Path Modification:
|
| 507 |
+
|
| 508 |
+
Modification
|
| 509 |
+
^^^^^^^^^^^^
|
| 510 |
+
|
| 511 |
+
.. _cmake_path-SET:
|
| 512 |
+
|
| 513 |
+
.. code-block:: cmake
|
| 514 |
+
|
| 515 |
+
cmake_path(SET <path-var> [NORMALIZE] <input>)
|
| 516 |
+
|
| 517 |
+
Assign the ``<input>`` path to ``<path-var>``. If ``<input>`` is a native
|
| 518 |
+
path, it is converted into a cmake-style path with forward-slashes
|
| 519 |
+
(``/``). On Windows, the long filename marker is taken into account.
|
| 520 |
+
|
| 521 |
+
When the ``NORMALIZE`` option is specified, the path is :ref:`normalized
|
| 522 |
+
<Normalization>` after the conversion.
|
| 523 |
+
|
| 524 |
+
For example:
|
| 525 |
+
|
| 526 |
+
.. code-block:: cmake
|
| 527 |
+
|
| 528 |
+
set(native_path "c:\\a\\b/..\\c")
|
| 529 |
+
cmake_path(SET path "${native_path}")
|
| 530 |
+
message("CMake path is \"${path}\"")
|
| 531 |
+
|
| 532 |
+
cmake_path(SET path NORMALIZE "${native_path}")
|
| 533 |
+
message("Normalized CMake path is \"${path}\"")
|
| 534 |
+
|
| 535 |
+
Output::
|
| 536 |
+
|
| 537 |
+
CMake path is "c:/a/b/../c"
|
| 538 |
+
Normalized CMake path is "c:/a/c"
|
| 539 |
+
|
| 540 |
+
.. _APPEND:
|
| 541 |
+
|
| 542 |
+
.. code-block:: cmake
|
| 543 |
+
|
| 544 |
+
cmake_path(APPEND <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])
|
| 545 |
+
|
| 546 |
+
Append all the ``<input>`` arguments to the ``<path-var>`` using ``/`` as
|
| 547 |
+
the ``directory-separator``. Depending on the ``<input>``, the previous
|
| 548 |
+
contents of ``<path-var>`` may be discarded. For each ``<input>`` argument,
|
| 549 |
+
the following algorithm (pseudo-code) applies:
|
| 550 |
+
|
| 551 |
+
::
|
| 552 |
+
|
| 553 |
+
# <path> is the contents of <path-var>
|
| 554 |
+
|
| 555 |
+
if(<input>.is_absolute() OR
|
| 556 |
+
(<input>.has_root_name() AND
|
| 557 |
+
NOT <input>.root_name() STREQUAL <path>.root_name()))
|
| 558 |
+
replace <path> with <input>
|
| 559 |
+
return()
|
| 560 |
+
endif()
|
| 561 |
+
|
| 562 |
+
if(<input>.has_root_directory())
|
| 563 |
+
remove any root-directory and the entire relative path from <path>
|
| 564 |
+
elseif(<path>.has_filename() OR
|
| 565 |
+
(NOT <path-var>.has_root_directory() OR <path>.is_absolute()))
|
| 566 |
+
append directory-separator to <path>
|
| 567 |
+
endif()
|
| 568 |
+
|
| 569 |
+
append <input> omitting any root-name to <path>
|
| 570 |
+
|
| 571 |
+
.. _APPEND_STRING:
|
| 572 |
+
|
| 573 |
+
.. code-block:: cmake
|
| 574 |
+
|
| 575 |
+
cmake_path(APPEND_STRING <path-var> [<input>...] [OUTPUT_VARIABLE <out-var>])
|
| 576 |
+
|
| 577 |
+
Append all the ``<input>`` arguments to the ``<path-var>`` without adding any
|
| 578 |
+
``directory-separator``.
|
| 579 |
+
|
| 580 |
+
.. _REMOVE_FILENAME:
|
| 581 |
+
|
| 582 |
+
.. code-block:: cmake
|
| 583 |
+
|
| 584 |
+
cmake_path(REMOVE_FILENAME <path-var> [OUTPUT_VARIABLE <out-var>])
|
| 585 |
+
|
| 586 |
+
Removes the :ref:`filename <FILENAME_DEF>` component (as returned by
|
| 587 |
+
:ref:`GET ... FILENAME <GET_FILENAME>`) from ``<path-var>``. After removal,
|
| 588 |
+
any trailing ``directory-separator`` is left alone, if present.
|
| 589 |
+
|
| 590 |
+
If ``OUTPUT_VARIABLE`` is not given, then after this function returns,
|
| 591 |
+
`HAS_FILENAME`_ returns false for ``<path-var>``.
|
| 592 |
+
|
| 593 |
+
For example:
|
| 594 |
+
|
| 595 |
+
.. code-block:: cmake
|
| 596 |
+
|
| 597 |
+
set(path "/a/b")
|
| 598 |
+
cmake_path(REMOVE_FILENAME path)
|
| 599 |
+
message("First path is \"${path}\"")
|
| 600 |
+
|
| 601 |
+
# filename is now already empty, the following removes nothing
|
| 602 |
+
cmake_path(REMOVE_FILENAME path)
|
| 603 |
+
message("Second path is \"${path}\"")
|
| 604 |
+
|
| 605 |
+
Output::
|
| 606 |
+
|
| 607 |
+
First path is "/a/"
|
| 608 |
+
Second path is "/a/"
|
| 609 |
+
|
| 610 |
+
.. _REPLACE_FILENAME:
|
| 611 |
+
|
| 612 |
+
.. code-block:: cmake
|
| 613 |
+
|
| 614 |
+
cmake_path(REPLACE_FILENAME <path-var> <input> [OUTPUT_VARIABLE <out-var>])
|
| 615 |
+
|
| 616 |
+
Replaces the :ref:`filename <FILENAME_DEF>` component from ``<path-var>``
|
| 617 |
+
with ``<input>``. If ``<path-var>`` has no filename component (i.e.
|
| 618 |
+
`HAS_FILENAME`_ returns false), the path is unchanged. The operation is
|
| 619 |
+
equivalent to the following:
|
| 620 |
+
|
| 621 |
+
.. code-block:: cmake
|
| 622 |
+
|
| 623 |
+
cmake_path(HAS_FILENAME path has_filename)
|
| 624 |
+
if(has_filename)
|
| 625 |
+
cmake_path(REMOVE_FILENAME path)
|
| 626 |
+
cmake_path(APPEND path input);
|
| 627 |
+
endif()
|
| 628 |
+
|
| 629 |
+
.. _REMOVE_EXTENSION:
|
| 630 |
+
|
| 631 |
+
.. code-block:: cmake
|
| 632 |
+
|
| 633 |
+
cmake_path(REMOVE_EXTENSION <path-var> [LAST_ONLY]
|
| 634 |
+
[OUTPUT_VARIABLE <out-var>])
|
| 635 |
+
|
| 636 |
+
Removes the :ref:`extension <EXTENSION_DEF>`, if any, from ``<path-var>``.
|
| 637 |
+
|
| 638 |
+
.. _REPLACE_EXTENSION:
|
| 639 |
+
|
| 640 |
+
.. code-block:: cmake
|
| 641 |
+
|
| 642 |
+
cmake_path(REPLACE_EXTENSION <path-var> [LAST_ONLY] <input>
|
| 643 |
+
[OUTPUT_VARIABLE <out-var>])
|
| 644 |
+
|
| 645 |
+
Replaces the :ref:`extension <EXTENSION_DEF>` with ``<input>``. Its effect
|
| 646 |
+
is equivalent to the following:
|
| 647 |
+
|
| 648 |
+
.. code-block:: cmake
|
| 649 |
+
|
| 650 |
+
cmake_path(REMOVE_EXTENSION path)
|
| 651 |
+
if(NOT "input" MATCHES "^\\.")
|
| 652 |
+
cmake_path(APPEND_STRING path ".")
|
| 653 |
+
endif()
|
| 654 |
+
cmake_path(APPEND_STRING path "input")
|
| 655 |
+
|
| 656 |
+
|
| 657 |
+
.. _Path Generation:
|
| 658 |
+
|
| 659 |
+
Generation
|
| 660 |
+
^^^^^^^^^^
|
| 661 |
+
|
| 662 |
+
.. _NORMAL_PATH:
|
| 663 |
+
|
| 664 |
+
.. code-block:: cmake
|
| 665 |
+
|
| 666 |
+
cmake_path(NORMAL_PATH <path-var> [OUTPUT_VARIABLE <out-var>])
|
| 667 |
+
|
| 668 |
+
Normalize ``<path-var>`` according the steps described in :ref:`Normalization`.
|
| 669 |
+
|
| 670 |
+
.. _cmake_path-RELATIVE_PATH:
|
| 671 |
+
.. _RELATIVE_PATH:
|
| 672 |
+
|
| 673 |
+
.. code-block:: cmake
|
| 674 |
+
|
| 675 |
+
cmake_path(RELATIVE_PATH <path-var> [BASE_DIRECTORY <input>]
|
| 676 |
+
[OUTPUT_VARIABLE <out-var>])
|
| 677 |
+
|
| 678 |
+
Modifies ``<path-var>`` to make it relative to the ``BASE_DIRECTORY`` argument.
|
| 679 |
+
If ``BASE_DIRECTORY`` is not specified, the default base directory will be
|
| 680 |
+
:variable:`CMAKE_CURRENT_SOURCE_DIR`.
|
| 681 |
+
|
| 682 |
+
For reference, the algorithm used to compute the relative path is the same
|
| 683 |
+
as that used by C++
|
| 684 |
+
`std::filesystem::path::lexically_relative
|
| 685 |
+
<https://en.cppreference.com/w/cpp/filesystem/path/lexically_normal>`_.
|
| 686 |
+
|
| 687 |
+
.. _ABSOLUTE_PATH:
|
| 688 |
+
|
| 689 |
+
.. code-block:: cmake
|
| 690 |
+
|
| 691 |
+
cmake_path(ABSOLUTE_PATH <path-var> [BASE_DIRECTORY <input>] [NORMALIZE]
|
| 692 |
+
[OUTPUT_VARIABLE <out-var>])
|
| 693 |
+
|
| 694 |
+
If ``<path-var>`` is a relative path (`IS_RELATIVE`_ is true), it is evaluated
|
| 695 |
+
relative to the given base directory specified by ``BASE_DIRECTORY`` option.
|
| 696 |
+
If ``BASE_DIRECTORY`` is not specified, the default base directory will be
|
| 697 |
+
:variable:`CMAKE_CURRENT_SOURCE_DIR`.
|
| 698 |
+
|
| 699 |
+
When the ``NORMALIZE`` option is specified, the path is :ref:`normalized
|
| 700 |
+
<Normalization>` after the path computation.
|
| 701 |
+
|
| 702 |
+
Because ``cmake_path()`` does not access the filesystem, symbolic links are
|
| 703 |
+
not resolved and any leading tilde is not expanded. To compute a real path
|
| 704 |
+
with symbolic links resolved and leading tildes expanded, use the
|
| 705 |
+
:command:`file(REAL_PATH)` command instead.
|
| 706 |
+
|
| 707 |
+
Native Conversion
|
| 708 |
+
^^^^^^^^^^^^^^^^^
|
| 709 |
+
|
| 710 |
+
For commands in this section, *native* refers to the host platform, not the
|
| 711 |
+
target platform when cross-compiling.
|
| 712 |
+
|
| 713 |
+
.. _cmake_path-NATIVE_PATH:
|
| 714 |
+
.. _NATIVE_PATH:
|
| 715 |
+
|
| 716 |
+
.. code-block:: cmake
|
| 717 |
+
|
| 718 |
+
cmake_path(NATIVE_PATH <path-var> [NORMALIZE] <out-var>)
|
| 719 |
+
|
| 720 |
+
Converts a cmake-style ``<path-var>`` into a native path with
|
| 721 |
+
platform-specific slashes (``\`` on Windows hosts and ``/`` elsewhere).
|
| 722 |
+
|
| 723 |
+
When the ``NORMALIZE`` option is specified, the path is :ref:`normalized
|
| 724 |
+
<Normalization>` before the conversion.
|
| 725 |
+
|
| 726 |
+
.. _CONVERT:
|
| 727 |
+
.. _cmake_path-TO_CMAKE_PATH_LIST:
|
| 728 |
+
.. _TO_CMAKE_PATH_LIST:
|
| 729 |
+
|
| 730 |
+
.. code-block:: cmake
|
| 731 |
+
|
| 732 |
+
cmake_path(CONVERT <input> TO_CMAKE_PATH_LIST <out-var> [NORMALIZE])
|
| 733 |
+
|
| 734 |
+
Converts a native ``<input>`` path into a cmake-style path with forward
|
| 735 |
+
slashes (``/``). On Windows hosts, the long filename marker is taken into
|
| 736 |
+
account. The input can be a single path or a system search path like
|
| 737 |
+
``$ENV{PATH}``. A search path will be converted to a cmake-style list
|
| 738 |
+
separated by ``;`` characters (on non-Windows platforms, this essentially
|
| 739 |
+
means ``:`` separators are replaced with ``;``). The result of the
|
| 740 |
+
conversion is stored in the ``<out-var>`` variable.
|
| 741 |
+
|
| 742 |
+
When the ``NORMALIZE`` option is specified, the path is :ref:`normalized
|
| 743 |
+
<Normalization>` before the conversion.
|
| 744 |
+
|
| 745 |
+
.. note::
|
| 746 |
+
Unlike most other ``cmake_path()`` subcommands, the ``CONVERT`` subcommand
|
| 747 |
+
takes a literal string as input, not the name of a variable.
|
| 748 |
+
|
| 749 |
+
.. _cmake_path-TO_NATIVE_PATH_LIST:
|
| 750 |
+
.. _TO_NATIVE_PATH_LIST:
|
| 751 |
+
|
| 752 |
+
.. code-block:: cmake
|
| 753 |
+
|
| 754 |
+
cmake_path(CONVERT <input> TO_NATIVE_PATH_LIST <out-var> [NORMALIZE])
|
| 755 |
+
|
| 756 |
+
Converts a cmake-style ``<input>`` path into a native path with
|
| 757 |
+
platform-specific slashes (``\`` on Windows hosts and ``/`` elsewhere).
|
| 758 |
+
The input can be a single path or a cmake-style list. A list will be
|
| 759 |
+
converted into a native search path (``;``-separated on Windows,
|
| 760 |
+
``:``-separated on other platforms). The result of the conversion is
|
| 761 |
+
stored in the ``<out-var>`` variable.
|
| 762 |
+
|
| 763 |
+
When the ``NORMALIZE`` option is specified, the path is :ref:`normalized
|
| 764 |
+
<Normalization>` before the conversion.
|
| 765 |
+
|
| 766 |
+
.. note::
|
| 767 |
+
Unlike most other ``cmake_path()`` subcommands, the ``CONVERT`` subcommand
|
| 768 |
+
takes a literal string as input, not the name of a variable.
|
| 769 |
+
|
| 770 |
+
For example:
|
| 771 |
+
|
| 772 |
+
.. code-block:: cmake
|
| 773 |
+
|
| 774 |
+
set(paths "/a/b/c" "/x/y/z")
|
| 775 |
+
cmake_path(CONVERT "${paths}" TO_NATIVE_PATH_LIST native_paths)
|
| 776 |
+
message("Native path list is \"${native_paths}\"")
|
| 777 |
+
|
| 778 |
+
Output on Windows::
|
| 779 |
+
|
| 780 |
+
Native path list is "\a\b\c;\x\y\z"
|
| 781 |
+
|
| 782 |
+
Output on all other platforms::
|
| 783 |
+
|
| 784 |
+
Native path list is "/a/b/c:/x/y/z"
|
| 785 |
+
|
| 786 |
+
Hashing
|
| 787 |
+
^^^^^^^
|
| 788 |
+
|
| 789 |
+
.. _HASH:
|
| 790 |
+
|
| 791 |
+
.. code-block:: cmake
|
| 792 |
+
|
| 793 |
+
cmake_path(HASH <path-var> <out-var>)
|
| 794 |
+
|
| 795 |
+
Compute a hash value of ``<path-var>`` such that for two paths ``p1`` and
|
| 796 |
+
``p2`` that compare equal (:ref:`COMPARE ... EQUAL <COMPARE>`), the hash
|
| 797 |
+
value of ``p1`` is equal to the hash value of ``p2``. The path is always
|
| 798 |
+
:ref:`normalized <Normalization>` before the hash is computed.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/cmake_policy.rst
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
cmake_policy
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Manage CMake Policy settings. See the :manual:`cmake-policies(7)`
|
| 5 |
+
manual for defined policies.
|
| 6 |
+
|
| 7 |
+
As CMake evolves it is sometimes necessary to change existing behavior
|
| 8 |
+
in order to fix bugs or improve implementations of existing features.
|
| 9 |
+
The CMake Policy mechanism is designed to help keep existing projects
|
| 10 |
+
building as new versions of CMake introduce changes in behavior. Each
|
| 11 |
+
new policy (behavioral change) is given an identifier of the form
|
| 12 |
+
``CMP<NNNN>`` where ``<NNNN>`` is an integer index. Documentation
|
| 13 |
+
associated with each policy describes the ``OLD`` and ``NEW`` behavior
|
| 14 |
+
and the reason the policy was introduced. Projects may set each policy
|
| 15 |
+
to select the desired behavior. When CMake needs to know which behavior
|
| 16 |
+
to use it checks for a setting specified by the project. If no
|
| 17 |
+
setting is available the ``OLD`` behavior is assumed and a warning is
|
| 18 |
+
produced requesting that the policy be set.
|
| 19 |
+
|
| 20 |
+
Setting Policies by CMake Version
|
| 21 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 22 |
+
|
| 23 |
+
The ``cmake_policy`` command is used to set policies to ``OLD`` or ``NEW``
|
| 24 |
+
behavior. While setting policies individually is supported, we
|
| 25 |
+
encourage projects to set policies based on CMake versions:
|
| 26 |
+
|
| 27 |
+
.. signature:: cmake_policy(VERSION <min>[...<max>])
|
| 28 |
+
:target: VERSION
|
| 29 |
+
|
| 30 |
+
.. versionadded:: 3.12
|
| 31 |
+
The optional ``<max>`` version.
|
| 32 |
+
|
| 33 |
+
``<min>`` and the optional ``<max>`` are each CMake versions of the form
|
| 34 |
+
``major.minor[.patch[.tweak]]``, and the ``...`` is literal. The ``<min>``
|
| 35 |
+
version must be at least ``2.4`` and at most the running version of CMake.
|
| 36 |
+
The ``<max>`` version, if specified, must be at least the ``<min>`` version
|
| 37 |
+
but may exceed the running version of CMake. If the running version of
|
| 38 |
+
CMake is older than 3.12, the extra ``...`` dots will be seen as version
|
| 39 |
+
component separators, resulting in the ``...<max>`` part being ignored and
|
| 40 |
+
preserving the pre-3.12 behavior of basing policies on ``<min>``.
|
| 41 |
+
|
| 42 |
+
This specifies that the current CMake code is written for the given
|
| 43 |
+
range of CMake versions. All policies known to the running version of CMake
|
| 44 |
+
and introduced in the ``<min>`` (or ``<max>``, if specified) version
|
| 45 |
+
or earlier will be set to use ``NEW`` behavior. All policies
|
| 46 |
+
introduced in later versions will be unset (unless the
|
| 47 |
+
:variable:`CMAKE_POLICY_DEFAULT_CMP<NNNN>` variable sets a default).
|
| 48 |
+
This effectively requests behavior preferred as of a given CMake
|
| 49 |
+
version and tells newer CMake versions to warn about their new policies.
|
| 50 |
+
|
| 51 |
+
Note that the :command:`cmake_minimum_required(VERSION)`
|
| 52 |
+
command implicitly calls ``cmake_policy(VERSION)`` too.
|
| 53 |
+
|
| 54 |
+
.. include:: DEPRECATED_POLICY_VERSIONS.txt
|
| 55 |
+
|
| 56 |
+
Setting Policies Explicitly
|
| 57 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 58 |
+
|
| 59 |
+
.. signature:: cmake_policy(SET CMP<NNNN> NEW|OLD)
|
| 60 |
+
:target: SET
|
| 61 |
+
|
| 62 |
+
Tell CMake to use the ``OLD`` or ``NEW`` behavior for a given policy.
|
| 63 |
+
Projects depending on the old behavior of a given policy may silence a
|
| 64 |
+
policy warning by setting the policy state to ``OLD``. Alternatively
|
| 65 |
+
one may fix the project to work with the new behavior and set the
|
| 66 |
+
policy state to ``NEW``.
|
| 67 |
+
|
| 68 |
+
.. include:: ../policy/DEPRECATED.txt
|
| 69 |
+
|
| 70 |
+
Checking Policy Settings
|
| 71 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 72 |
+
|
| 73 |
+
.. signature:: cmake_policy(GET CMP<NNNN> <variable>)
|
| 74 |
+
:target: GET
|
| 75 |
+
|
| 76 |
+
Check whether a given policy is set to ``OLD`` or ``NEW`` behavior.
|
| 77 |
+
The output ``<variable>`` value will be ``OLD`` or ``NEW`` if the
|
| 78 |
+
policy is set, and empty otherwise.
|
| 79 |
+
|
| 80 |
+
CMake Policy Stack
|
| 81 |
+
^^^^^^^^^^^^^^^^^^
|
| 82 |
+
|
| 83 |
+
CMake keeps policy settings on a stack, so changes made by the
|
| 84 |
+
``cmake_policy`` command affect only the top of the stack. A new entry on
|
| 85 |
+
the policy stack is managed automatically for each subdirectory to
|
| 86 |
+
protect its parents and siblings. CMake also manages a new entry for
|
| 87 |
+
scripts loaded by :command:`include` and :command:`find_package` commands
|
| 88 |
+
except when invoked with the ``NO_POLICY_SCOPE`` option
|
| 89 |
+
(see also policy :policy:`CMP0011`).
|
| 90 |
+
The ``cmake_policy`` command provides an interface to manage custom
|
| 91 |
+
entries on the policy stack:
|
| 92 |
+
|
| 93 |
+
.. signature:: cmake_policy(PUSH)
|
| 94 |
+
:target: PUSH
|
| 95 |
+
|
| 96 |
+
Create a new entry on the policy stack.
|
| 97 |
+
|
| 98 |
+
.. signature:: cmake_policy(POP)
|
| 99 |
+
:target: POP
|
| 100 |
+
|
| 101 |
+
Remove the last policy stack entry created with ``cmake_policy(PUSH)``.
|
| 102 |
+
|
| 103 |
+
Each ``PUSH`` must have a matching ``POP`` to erase any changes.
|
| 104 |
+
This is useful to make temporary changes to policy settings.
|
| 105 |
+
Calls to the :command:`cmake_minimum_required(VERSION)`,
|
| 106 |
+
:command:`cmake_policy(VERSION)`, or :command:`cmake_policy(SET)` commands
|
| 107 |
+
influence only the current top of the policy stack.
|
| 108 |
+
|
| 109 |
+
.. versionadded:: 3.25
|
| 110 |
+
The :command:`block(SCOPE_FOR POLICIES)` command offers a more flexible
|
| 111 |
+
and more secure way to manage the policy stack. The pop action is done
|
| 112 |
+
automatically when leaving the block scope, so there is no need to
|
| 113 |
+
precede each :command:`return` with a call to :command:`cmake_policy(POP)`.
|
| 114 |
+
|
| 115 |
+
.. code-block:: cmake
|
| 116 |
+
|
| 117 |
+
# stack management with cmake_policy()
|
| 118 |
+
function(my_func)
|
| 119 |
+
cmake_policy(PUSH)
|
| 120 |
+
cmake_policy(SET ...)
|
| 121 |
+
if (<cond1>)
|
| 122 |
+
...
|
| 123 |
+
cmake_policy(POP)
|
| 124 |
+
return()
|
| 125 |
+
elseif(<cond2>)
|
| 126 |
+
...
|
| 127 |
+
cmake_policy(POP)
|
| 128 |
+
return()
|
| 129 |
+
endif()
|
| 130 |
+
...
|
| 131 |
+
cmake_policy(POP)
|
| 132 |
+
endfunction()
|
| 133 |
+
|
| 134 |
+
# stack management with block()/endblock()
|
| 135 |
+
function(my_func)
|
| 136 |
+
block(SCOPE_FOR POLICIES)
|
| 137 |
+
cmake_policy(SET ...)
|
| 138 |
+
if (<cond1>)
|
| 139 |
+
...
|
| 140 |
+
return()
|
| 141 |
+
elseif(<cond2>)
|
| 142 |
+
...
|
| 143 |
+
return()
|
| 144 |
+
endif()
|
| 145 |
+
...
|
| 146 |
+
endblock()
|
| 147 |
+
endfunction()
|
| 148 |
+
|
| 149 |
+
Commands created by the :command:`function` and :command:`macro`
|
| 150 |
+
commands record policy settings when they are created and
|
| 151 |
+
use the pre-record policies when they are invoked. If the function or
|
| 152 |
+
macro implementation sets policies, the changes automatically
|
| 153 |
+
propagate up through callers until they reach the closest nested
|
| 154 |
+
policy stack entry.
|
| 155 |
+
|
| 156 |
+
See Also
|
| 157 |
+
^^^^^^^^
|
| 158 |
+
|
| 159 |
+
* :command:`cmake_minimum_required`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/create_test_sourcelist.rst
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
create_test_sourcelist
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
Create a test driver program that links together many small tests into a
|
| 5 |
+
single executable. This is useful when building static executables with
|
| 6 |
+
large libraries to shrink the total required size.
|
| 7 |
+
|
| 8 |
+
.. signature::
|
| 9 |
+
create_test_sourcelist(<sourceListName> <driverName> <test>... <options>...)
|
| 10 |
+
:target: original
|
| 11 |
+
|
| 12 |
+
Generate a test driver source file from a list of individual test sources
|
| 13 |
+
and provide a combined list of sources that can be built as an executable.
|
| 14 |
+
|
| 15 |
+
The options are:
|
| 16 |
+
|
| 17 |
+
``<sourceListName>``
|
| 18 |
+
The name of a variable in which to store the list of source files needed
|
| 19 |
+
to build the test driver. The list will contain the ``<test>...`` sources
|
| 20 |
+
and the generated ``<driverName>`` source.
|
| 21 |
+
|
| 22 |
+
.. versionchanged:: 3.29
|
| 23 |
+
|
| 24 |
+
The test driver source is listed by absolute path in the build tree.
|
| 25 |
+
Previously it was listed only as ``<driverName>``.
|
| 26 |
+
|
| 27 |
+
``<driverName>``
|
| 28 |
+
Name of the test driver source file to be generated into the build tree.
|
| 29 |
+
The source file will contain a ``main()`` program entry point that
|
| 30 |
+
dispatches to whatever test is named on the command line.
|
| 31 |
+
|
| 32 |
+
``<test>...``
|
| 33 |
+
Test source files to be added to the driver binary. Each test source
|
| 34 |
+
file must have a function in it that is the same name as the file with the
|
| 35 |
+
extension removed. For example, a ``foo.cxx`` test source might contain:
|
| 36 |
+
|
| 37 |
+
.. code-block:: c++
|
| 38 |
+
|
| 39 |
+
int foo(int argc, char** argv)
|
| 40 |
+
|
| 41 |
+
``EXTRA_INCLUDE <header>``
|
| 42 |
+
Specify a header file to ``#include`` in the generated test driver source.
|
| 43 |
+
|
| 44 |
+
``FUNCTION <function>``
|
| 45 |
+
Specify a function to be called with pointers to ``argc`` and ``argv``.
|
| 46 |
+
The function may be provided in the ``EXTRA_INCLUDE`` header:
|
| 47 |
+
|
| 48 |
+
.. code-block:: c++
|
| 49 |
+
|
| 50 |
+
void function(int* pargc, char*** pargv)
|
| 51 |
+
|
| 52 |
+
This can be used to add extra command line processing to each test.
|
| 53 |
+
|
| 54 |
+
Additionally, some CMake variables affect test driver generation:
|
| 55 |
+
|
| 56 |
+
.. variable:: CMAKE_TESTDRIVER_BEFORE_TESTMAIN
|
| 57 |
+
|
| 58 |
+
Code to be placed directly before calling each test's function.
|
| 59 |
+
|
| 60 |
+
.. variable:: CMAKE_TESTDRIVER_AFTER_TESTMAIN
|
| 61 |
+
|
| 62 |
+
Code to be placed directly after the call to each test's function.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_run_script.rst
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_run_script
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
runs a :option:`ctest -S` script
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_run_script([NEW_PROCESS] script_file_name script_file_name1
|
| 9 |
+
script_file_name2 ... [RETURN_VALUE var])
|
| 10 |
+
|
| 11 |
+
Runs a script or scripts much like if it was run from :option:`ctest -S`.
|
| 12 |
+
If no argument is provided then the current script is run using the current
|
| 13 |
+
settings of the variables. If ``NEW_PROCESS`` is specified then each
|
| 14 |
+
script will be run in a separate process.If ``RETURN_VALUE`` is specified
|
| 15 |
+
the return value of the last script run will be put into ``var``.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/ctest_submit.rst
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
ctest_submit
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
ctest_submit([PARTS <part>...] [FILES <file>...]
|
| 9 |
+
[SUBMIT_URL <url>]
|
| 10 |
+
[BUILD_ID <result-var>]
|
| 11 |
+
[HTTPHEADER <header>]
|
| 12 |
+
[RETRY_COUNT <count>]
|
| 13 |
+
[RETRY_DELAY <delay>]
|
| 14 |
+
[RETURN_VALUE <result-var>]
|
| 15 |
+
[CAPTURE_CMAKE_ERROR <result-var>]
|
| 16 |
+
[QUIET]
|
| 17 |
+
)
|
| 18 |
+
|
| 19 |
+
Submit results to a dashboard server.
|
| 20 |
+
By default all available parts are submitted.
|
| 21 |
+
|
| 22 |
+
The options are:
|
| 23 |
+
|
| 24 |
+
``PARTS <part>...``
|
| 25 |
+
Specify a subset of parts to submit. Valid part names are::
|
| 26 |
+
|
| 27 |
+
Start = nothing
|
| 28 |
+
Update = ctest_update results, in Update.xml
|
| 29 |
+
Configure = ctest_configure results, in Configure.xml
|
| 30 |
+
Build = ctest_build results, in Build.xml
|
| 31 |
+
Test = ctest_test results, in Test.xml
|
| 32 |
+
Coverage = ctest_coverage results, in Coverage.xml
|
| 33 |
+
MemCheck = ctest_memcheck results, in DynamicAnalysis.xml and
|
| 34 |
+
DynamicAnalysis-Test.xml
|
| 35 |
+
Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml
|
| 36 |
+
ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES
|
| 37 |
+
Upload = Files prepared for upload by ctest_upload(), in Upload.xml
|
| 38 |
+
Submit = nothing
|
| 39 |
+
Done = Build is complete, in Done.xml
|
| 40 |
+
|
| 41 |
+
``FILES <file>...``
|
| 42 |
+
Specify an explicit list of specific files to be submitted.
|
| 43 |
+
Each individual file must exist at the time of the call.
|
| 44 |
+
|
| 45 |
+
``SUBMIT_URL <url>``
|
| 46 |
+
.. versionadded:: 3.14
|
| 47 |
+
|
| 48 |
+
The ``http`` or ``https`` URL of the dashboard server to send the submission
|
| 49 |
+
to. If not given, the :variable:`CTEST_SUBMIT_URL` variable is used.
|
| 50 |
+
|
| 51 |
+
``BUILD_ID <result-var>``
|
| 52 |
+
.. versionadded:: 3.15
|
| 53 |
+
|
| 54 |
+
Store in the ``<result-var>`` variable the ID assigned to this build by
|
| 55 |
+
CDash.
|
| 56 |
+
|
| 57 |
+
``HTTPHEADER <HTTP-header>``
|
| 58 |
+
.. versionadded:: 3.9
|
| 59 |
+
|
| 60 |
+
Specify HTTP header to be included in the request to CDash during submission.
|
| 61 |
+
For example, CDash can be configured to only accept submissions from
|
| 62 |
+
authenticated clients. In this case, you should provide a bearer token in your
|
| 63 |
+
header:
|
| 64 |
+
|
| 65 |
+
.. code-block:: cmake
|
| 66 |
+
|
| 67 |
+
ctest_submit(HTTPHEADER "Authorization: Bearer <auth-token>")
|
| 68 |
+
|
| 69 |
+
This suboption can be repeated several times for multiple headers.
|
| 70 |
+
|
| 71 |
+
``RETRY_COUNT <count>``
|
| 72 |
+
Specify how many times to retry a timed-out submission.
|
| 73 |
+
|
| 74 |
+
``RETRY_DELAY <delay>``
|
| 75 |
+
Specify how long (in seconds) to wait after a timed-out submission
|
| 76 |
+
before attempting to re-submit.
|
| 77 |
+
|
| 78 |
+
``RETURN_VALUE <result-var>``
|
| 79 |
+
Store in the ``<result-var>`` variable ``0`` for success and
|
| 80 |
+
non-zero on failure.
|
| 81 |
+
|
| 82 |
+
``CAPTURE_CMAKE_ERROR <result-var>``
|
| 83 |
+
.. versionadded:: 3.13
|
| 84 |
+
|
| 85 |
+
Store in the ``<result-var>`` variable -1 if there are any errors running
|
| 86 |
+
the command and prevent ctest from returning non-zero if an error occurs.
|
| 87 |
+
|
| 88 |
+
``QUIET``
|
| 89 |
+
.. versionadded:: 3.3
|
| 90 |
+
|
| 91 |
+
Suppress all non-error messages that would have otherwise been
|
| 92 |
+
printed to the console.
|
| 93 |
+
|
| 94 |
+
Submit to CDash Upload API
|
| 95 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 96 |
+
|
| 97 |
+
.. versionadded:: 3.2
|
| 98 |
+
|
| 99 |
+
.. code-block:: cmake
|
| 100 |
+
|
| 101 |
+
ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>]
|
| 102 |
+
[SUBMIT_URL <url>]
|
| 103 |
+
[BUILD_ID <result-var>]
|
| 104 |
+
[HTTPHEADER <header>]
|
| 105 |
+
[RETRY_COUNT <count>]
|
| 106 |
+
[RETRY_DELAY <delay>]
|
| 107 |
+
[RETURN_VALUE <result-var>]
|
| 108 |
+
[QUIET])
|
| 109 |
+
|
| 110 |
+
This second signature is used to upload files to CDash via the CDash
|
| 111 |
+
file upload API. The API first sends a request to upload to CDash along
|
| 112 |
+
with a content hash of the file. If CDash does not already have the file,
|
| 113 |
+
then it is uploaded. Along with the file, a CDash type string is specified
|
| 114 |
+
to tell CDash which handler to use to process the data.
|
| 115 |
+
|
| 116 |
+
This signature interprets options in the same way as the first one.
|
| 117 |
+
|
| 118 |
+
.. versionadded:: 3.8
|
| 119 |
+
Added the ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
|
| 120 |
+
|
| 121 |
+
.. versionadded:: 3.9
|
| 122 |
+
Added the ``HTTPHEADER`` option.
|
| 123 |
+
|
| 124 |
+
.. versionadded:: 3.13
|
| 125 |
+
Added the ``RETURN_VALUE`` option.
|
| 126 |
+
|
| 127 |
+
.. versionadded:: 3.14
|
| 128 |
+
Added the ``SUBMIT_URL`` option.
|
| 129 |
+
|
| 130 |
+
.. versionadded:: 3.15
|
| 131 |
+
Added the ``BUILD_ID`` option.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/define_property.rst
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
define_property
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
Define and document custom properties.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |
|
| 9 |
+
TEST | VARIABLE | CACHED_VARIABLE>
|
| 10 |
+
PROPERTY <name> [INHERITED]
|
| 11 |
+
[BRIEF_DOCS <brief-doc> [docs...]]
|
| 12 |
+
[FULL_DOCS <full-doc> [docs...]]
|
| 13 |
+
[INITIALIZE_FROM_VARIABLE <variable>])
|
| 14 |
+
|
| 15 |
+
Defines one property in a scope for use with the :command:`set_property` and
|
| 16 |
+
:command:`get_property` commands. It is mainly useful for defining the way
|
| 17 |
+
a property is initialized or inherited. Historically, the command also
|
| 18 |
+
associated documentation with a property, but that is no longer considered a
|
| 19 |
+
primary use case.
|
| 20 |
+
|
| 21 |
+
The first argument determines the kind of scope in which the property should
|
| 22 |
+
be used. It must be one of the following:
|
| 23 |
+
|
| 24 |
+
::
|
| 25 |
+
|
| 26 |
+
GLOBAL = associated with the global namespace
|
| 27 |
+
DIRECTORY = associated with one directory
|
| 28 |
+
TARGET = associated with one target
|
| 29 |
+
SOURCE = associated with one source file
|
| 30 |
+
TEST = associated with a test named with add_test
|
| 31 |
+
VARIABLE = documents a CMake language variable
|
| 32 |
+
CACHED_VARIABLE = documents a CMake cache variable
|
| 33 |
+
|
| 34 |
+
Note that unlike :command:`set_property` and :command:`get_property` no
|
| 35 |
+
actual scope needs to be given; only the kind of scope is important.
|
| 36 |
+
|
| 37 |
+
The required ``PROPERTY`` option is immediately followed by the name of
|
| 38 |
+
the property being defined.
|
| 39 |
+
|
| 40 |
+
If the ``INHERITED`` option is given, then the :command:`get_property` command
|
| 41 |
+
will chain up to the next higher scope when the requested property is not set
|
| 42 |
+
in the scope given to the command.
|
| 43 |
+
|
| 44 |
+
* ``DIRECTORY`` scope chains to its parent directory's scope, continuing the
|
| 45 |
+
walk up parent directories until a directory has the property set or there
|
| 46 |
+
are no more parents. If still not found at the top level directory, it
|
| 47 |
+
chains to the ``GLOBAL`` scope.
|
| 48 |
+
* ``TARGET``, ``SOURCE`` and ``TEST`` properties chain to ``DIRECTORY`` scope,
|
| 49 |
+
including further chaining up the directories, etc. as needed.
|
| 50 |
+
|
| 51 |
+
Note that this scope chaining behavior only applies to calls to
|
| 52 |
+
:command:`get_property`, :command:`get_directory_property`,
|
| 53 |
+
:command:`get_target_property`, :command:`get_source_file_property` and
|
| 54 |
+
:command:`get_test_property`. There is no inheriting behavior when *setting*
|
| 55 |
+
properties, so using ``APPEND`` or ``APPEND_STRING`` with the
|
| 56 |
+
:command:`set_property` command will not consider inherited values when working
|
| 57 |
+
out the contents to append to.
|
| 58 |
+
|
| 59 |
+
The ``BRIEF_DOCS`` and ``FULL_DOCS`` options are followed by strings to be
|
| 60 |
+
associated with the property as its brief and full documentation.
|
| 61 |
+
CMake does not use this documentation other than making it available to the
|
| 62 |
+
project via corresponding options to the :command:`get_property` command.
|
| 63 |
+
|
| 64 |
+
.. versionchanged:: 3.23
|
| 65 |
+
|
| 66 |
+
The ``BRIEF_DOCS`` and ``FULL_DOCS`` options are optional.
|
| 67 |
+
|
| 68 |
+
.. versionadded:: 3.23
|
| 69 |
+
|
| 70 |
+
The ``INITIALIZE_FROM_VARIABLE`` option specifies a variable from which the
|
| 71 |
+
property should be initialized. It can only be used with target properties.
|
| 72 |
+
The ``<variable>`` name must end with the property name and must not begin
|
| 73 |
+
with ``CMAKE_`` or ``_CMAKE_``. The property name must contain at least one
|
| 74 |
+
underscore. It is recommended that the property name have a prefix specific
|
| 75 |
+
to the project.
|
| 76 |
+
|
| 77 |
+
Property Redefinition
|
| 78 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 79 |
+
|
| 80 |
+
Once a property is defined for a particular type of scope, it cannot be
|
| 81 |
+
redefined. Attempts to redefine an existing property by calling
|
| 82 |
+
:command:`define_property` with the same scope type and property name
|
| 83 |
+
will be silently ignored. Defining the same property name for two different
|
| 84 |
+
kinds of scope is valid.
|
| 85 |
+
|
| 86 |
+
:command:`get_property` can be used to determine whether a property is
|
| 87 |
+
already defined for a particular kind of scope, and if so, to examine its
|
| 88 |
+
definition. For example:
|
| 89 |
+
|
| 90 |
+
.. code-block:: cmake
|
| 91 |
+
|
| 92 |
+
# Initial definition
|
| 93 |
+
define_property(TARGET PROPERTY MY_NEW_PROP
|
| 94 |
+
BRIEF_DOCS "My new custom property"
|
| 95 |
+
)
|
| 96 |
+
|
| 97 |
+
# Later examination
|
| 98 |
+
get_property(my_new_prop_exists
|
| 99 |
+
TARGET NONE
|
| 100 |
+
PROPERTY MY_NEW_PROP
|
| 101 |
+
DEFINED
|
| 102 |
+
)
|
| 103 |
+
|
| 104 |
+
if(my_new_prop_exists)
|
| 105 |
+
get_property(my_new_prop_docs
|
| 106 |
+
TARGET NONE
|
| 107 |
+
PROPERTY MY_NEW_PROP
|
| 108 |
+
BRIEF_DOCS
|
| 109 |
+
)
|
| 110 |
+
# ${my_new_prop_docs} is now set to "My new custom property"
|
| 111 |
+
endif()
|
| 112 |
+
|
| 113 |
+
See Also
|
| 114 |
+
^^^^^^^^
|
| 115 |
+
|
| 116 |
+
* :command:`get_property`
|
| 117 |
+
* :command:`set_property`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/else.rst
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
else
|
| 2 |
+
----
|
| 3 |
+
|
| 4 |
+
Starts the else portion of an if block.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
else([<condition>])
|
| 9 |
+
|
| 10 |
+
See the :command:`if` command.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/enable_language.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
enable_language
|
| 2 |
+
---------------
|
| 3 |
+
|
| 4 |
+
Enable languages (CXX/C/OBJC/OBJCXX/Fortran/etc)
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
enable_language(<lang>... [OPTIONAL])
|
| 9 |
+
|
| 10 |
+
Enables support for the named languages in CMake. This is the same as
|
| 11 |
+
the :command:`project` command but does not create any of the extra
|
| 12 |
+
variables that are created by the :command:`project` command.
|
| 13 |
+
|
| 14 |
+
.. include:: SUPPORTED_LANGUAGES.txt
|
| 15 |
+
|
| 16 |
+
The following restrictions apply to where ``enable_language()`` may be called:
|
| 17 |
+
|
| 18 |
+
* It must be called in file scope, not in a function call.
|
| 19 |
+
* It must not be called before the first call to :command:`project`.
|
| 20 |
+
See policy :policy:`CMP0165`.
|
| 21 |
+
* It must be called in the highest directory common to all targets
|
| 22 |
+
using the named language directly for compiling sources or
|
| 23 |
+
indirectly through link dependencies. It is simplest to enable all
|
| 24 |
+
needed languages in the top-level directory of a project.
|
| 25 |
+
|
| 26 |
+
The ``OPTIONAL`` keyword is a placeholder for future implementation and
|
| 27 |
+
does not currently work. Instead you can use the :module:`CheckLanguage`
|
| 28 |
+
module to verify support before enabling.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endforeach.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
endforeach
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
Ends a list of commands in a foreach block.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
endforeach([<loop_var>])
|
| 9 |
+
|
| 10 |
+
See the :command:`foreach` command.
|
| 11 |
+
|
| 12 |
+
The optional ``<loop_var>`` argument is supported for backward compatibility
|
| 13 |
+
only. If used it must be a verbatim repeat of the ``<loop_var>`` argument of
|
| 14 |
+
the opening ``foreach`` clause.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/endif.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
endif
|
| 2 |
+
-----
|
| 3 |
+
|
| 4 |
+
Ends a list of commands in an if block.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
endif([<condition>])
|
| 9 |
+
|
| 10 |
+
See the :command:`if` command.
|
| 11 |
+
|
| 12 |
+
The optional ``<condition>`` argument is supported for backward compatibility
|
| 13 |
+
only. If used it must be a verbatim repeat of the argument of the opening
|
| 14 |
+
``if`` clause.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/export_library_dependencies.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
export_library_dependencies
|
| 2 |
+
---------------------------
|
| 3 |
+
|
| 4 |
+
Disallowed since version 3.0. See CMake Policy :policy:`CMP0033`.
|
| 5 |
+
|
| 6 |
+
Use :command:`install(EXPORT)` or :command:`export` command.
|
| 7 |
+
|
| 8 |
+
This command generates an old-style library dependencies file.
|
| 9 |
+
Projects requiring CMake 2.6 or later should not use the command. Use
|
| 10 |
+
instead the :command:`install(EXPORT)` command to help export targets from an
|
| 11 |
+
installation tree and the :command:`export` command to export targets from a
|
| 12 |
+
build tree.
|
| 13 |
+
|
| 14 |
+
The old-style library dependencies file does not take into account
|
| 15 |
+
per-configuration names of libraries or the
|
| 16 |
+
:prop_tgt:`LINK_INTERFACE_LIBRARIES` target property.
|
| 17 |
+
|
| 18 |
+
.. code-block:: cmake
|
| 19 |
+
|
| 20 |
+
export_library_dependencies(<file> [APPEND])
|
| 21 |
+
|
| 22 |
+
Create a file named ``<file>`` that can be included into a CMake listfile
|
| 23 |
+
with the INCLUDE command. The file will contain a number of SET
|
| 24 |
+
commands that will set all the variables needed for library dependency
|
| 25 |
+
information. This should be the last command in the top level
|
| 26 |
+
CMakeLists.txt file of the project. If the ``APPEND`` option is
|
| 27 |
+
specified, the SET commands will be appended to the given file instead
|
| 28 |
+
of replacing it.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_library.rst
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
find_library
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
.. |FIND_XXX| replace:: find_library
|
| 5 |
+
.. |NAMES| replace:: NAMES name1 [name2 ...] [NAMES_PER_DIR]
|
| 6 |
+
.. |SEARCH_XXX| replace:: library
|
| 7 |
+
.. |SEARCH_XXX_DESC| replace:: library
|
| 8 |
+
.. |prefix_XXX_SUBDIR| replace:: ``<prefix>/lib``
|
| 9 |
+
.. |entry_XXX_SUBDIR| replace:: ``<entry>/lib``
|
| 10 |
+
|
| 11 |
+
.. |FIND_XXX_REGISTRY_VIEW_DEFAULT| replace:: ``TARGET``
|
| 12 |
+
|
| 13 |
+
.. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| replace::
|
| 14 |
+
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
|
| 15 |
+
and |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR|
|
| 16 |
+
.. |CMAKE_PREFIX_PATH_XXX| replace::
|
| 17 |
+
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
|
| 18 |
+
and |CMAKE_PREFIX_PATH_XXX_SUBDIR|
|
| 19 |
+
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_LIBRARY_PATH`
|
| 20 |
+
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
|
| 21 |
+
|
| 22 |
+
.. |ENV_CMAKE_PREFIX_PATH_XXX| replace::
|
| 23 |
+
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
|
| 24 |
+
and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR|
|
| 25 |
+
.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_LIBRARY_PATH`
|
| 26 |
+
.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH`
|
| 27 |
+
|
| 28 |
+
.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``LIB``
|
| 29 |
+
and ``PATH``.
|
| 30 |
+
.. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace::
|
| 31 |
+
On Windows hosts, CMake 3.3 through 3.27 searched additional paths:
|
| 32 |
+
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
|
| 33 |
+
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.
|
| 34 |
+
This behavior was removed by CMake 3.28.
|
| 35 |
+
|
| 36 |
+
.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace::
|
| 37 |
+
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
|
| 38 |
+
and |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR|
|
| 39 |
+
.. |CMAKE_SYSTEM_XXX_PATH| replace::
|
| 40 |
+
:variable:`CMAKE_SYSTEM_LIBRARY_PATH`
|
| 41 |
+
.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace::
|
| 42 |
+
:variable:`CMAKE_SYSTEM_FRAMEWORK_PATH`
|
| 43 |
+
|
| 44 |
+
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
| 45 |
+
:variable:`CMAKE_FIND_ROOT_PATH_MODE_LIBRARY`
|
| 46 |
+
|
| 47 |
+
.. include:: FIND_XXX.txt
|
| 48 |
+
|
| 49 |
+
When more than one value is given to the ``NAMES`` option this command by
|
| 50 |
+
default will consider one name at a time and search every directory
|
| 51 |
+
for it. The ``NAMES_PER_DIR`` option tells this command to consider one
|
| 52 |
+
directory at a time and search for all names in it.
|
| 53 |
+
|
| 54 |
+
Each library name given to the ``NAMES`` option is first considered
|
| 55 |
+
as a library file name and then considered with platform-specific
|
| 56 |
+
prefixes (e.g. ``lib``) and suffixes (e.g. ``.so``). Therefore one
|
| 57 |
+
may specify library file names such as ``libfoo.a`` directly.
|
| 58 |
+
This can be used to locate static libraries on UNIX-like systems.
|
| 59 |
+
|
| 60 |
+
If the library found is a framework, then ``<VAR>`` will be set to the full
|
| 61 |
+
path to the framework ``<fullPath>/A.framework``. When a full path to a
|
| 62 |
+
framework is used as a library, CMake will use a ``-framework A``, and a
|
| 63 |
+
``-F<fullPath>`` to link the framework to the target.
|
| 64 |
+
|
| 65 |
+
.. versionadded:: 3.28
|
| 66 |
+
|
| 67 |
+
The library found can now be a ``.xcframework`` folder.
|
| 68 |
+
|
| 69 |
+
If the :variable:`CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX` variable is set all
|
| 70 |
+
search paths will be tested as normal, with the suffix appended, and with
|
| 71 |
+
all matches of ``lib/`` replaced with
|
| 72 |
+
``lib${CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX}/``. This variable overrides
|
| 73 |
+
the :prop_gbl:`FIND_LIBRARY_USE_LIB32_PATHS`,
|
| 74 |
+
:prop_gbl:`FIND_LIBRARY_USE_LIBX32_PATHS`,
|
| 75 |
+
and :prop_gbl:`FIND_LIBRARY_USE_LIB64_PATHS` global properties.
|
| 76 |
+
|
| 77 |
+
If the :prop_gbl:`FIND_LIBRARY_USE_LIB32_PATHS` global property is set
|
| 78 |
+
all search paths will be tested as normal, with ``32/`` appended, and
|
| 79 |
+
with all matches of ``lib/`` replaced with ``lib32/``. This property is
|
| 80 |
+
automatically set for the platforms that are known to need it if at
|
| 81 |
+
least one of the languages supported by the :command:`project` command
|
| 82 |
+
is enabled.
|
| 83 |
+
|
| 84 |
+
If the :prop_gbl:`FIND_LIBRARY_USE_LIBX32_PATHS` global property is set
|
| 85 |
+
all search paths will be tested as normal, with ``x32/`` appended, and
|
| 86 |
+
with all matches of ``lib/`` replaced with ``libx32/``. This property is
|
| 87 |
+
automatically set for the platforms that are known to need it if at
|
| 88 |
+
least one of the languages supported by the :command:`project` command
|
| 89 |
+
is enabled.
|
| 90 |
+
|
| 91 |
+
If the :prop_gbl:`FIND_LIBRARY_USE_LIB64_PATHS` global property is set
|
| 92 |
+
all search paths will be tested as normal, with ``64/`` appended, and
|
| 93 |
+
with all matches of ``lib/`` replaced with ``lib64/``. This property is
|
| 94 |
+
automatically set for the platforms that are known to need it if at
|
| 95 |
+
least one of the languages supported by the :command:`project` command
|
| 96 |
+
is enabled.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/find_package.rst
ADDED
|
@@ -0,0 +1,776 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
find_package
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
.. |FIND_XXX| replace:: find_package
|
| 5 |
+
.. |FIND_ARGS_XXX| replace:: <PackageName>
|
| 6 |
+
.. |FIND_XXX_REGISTRY_VIEW_DEFAULT| replace:: ``TARGET``
|
| 7 |
+
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
|
| 8 |
+
:variable:`CMAKE_FIND_ROOT_PATH_MODE_PACKAGE`
|
| 9 |
+
|
| 10 |
+
.. only:: html
|
| 11 |
+
|
| 12 |
+
.. contents::
|
| 13 |
+
|
| 14 |
+
.. note:: The :guide:`Using Dependencies Guide` provides a high-level
|
| 15 |
+
introduction to this general topic. It provides a broader overview of
|
| 16 |
+
where the ``find_package()`` command fits into the bigger picture,
|
| 17 |
+
including its relationship to the :module:`FetchContent` module.
|
| 18 |
+
The guide is recommended pre-reading before moving on to the details below.
|
| 19 |
+
|
| 20 |
+
Find a package (usually provided by something external to the project),
|
| 21 |
+
and load its package-specific details. Calls to this command can also
|
| 22 |
+
be intercepted by :ref:`dependency providers <dependency_providers>`.
|
| 23 |
+
|
| 24 |
+
Typical Usage
|
| 25 |
+
^^^^^^^^^^^^^
|
| 26 |
+
|
| 27 |
+
Most calls to ``find_package()`` typically have the following form:
|
| 28 |
+
|
| 29 |
+
.. parsed-literal::
|
| 30 |
+
|
| 31 |
+
find_package(<PackageName> [<version>] [REQUIRED] [COMPONENTS <components>...])
|
| 32 |
+
|
| 33 |
+
The ``<PackageName>`` is the only mandatory argument. The ``<version>`` is
|
| 34 |
+
often omitted, and ``REQUIRED`` should be given if the project cannot be
|
| 35 |
+
configured successfully without the package. Some more complicated packages
|
| 36 |
+
support components which can be selected with the ``COMPONENTS`` keyword, but
|
| 37 |
+
most packages don't have that level of complexity.
|
| 38 |
+
|
| 39 |
+
The above is a reduced form of the `basic signature`_. Where possible,
|
| 40 |
+
projects should find packages using this form. This reduces complexity and
|
| 41 |
+
maximizes the ways in which the package can be found or provided.
|
| 42 |
+
|
| 43 |
+
Understanding the `basic signature`_ should be enough for general usage of
|
| 44 |
+
``find_package()``. Project maintainers who intend to provide a config
|
| 45 |
+
package should understand the bigger picture, as explained in
|
| 46 |
+
:ref:`Full Signature` and all subsequent sections on this page.
|
| 47 |
+
|
| 48 |
+
Search Modes
|
| 49 |
+
^^^^^^^^^^^^
|
| 50 |
+
|
| 51 |
+
The command has a few modes by which it searches for packages:
|
| 52 |
+
|
| 53 |
+
**Module mode**
|
| 54 |
+
In this mode, CMake searches for a file called ``Find<PackageName>.cmake``,
|
| 55 |
+
looking first in the locations listed in the :variable:`CMAKE_MODULE_PATH`,
|
| 56 |
+
then among the :ref:`Find Modules` provided by the CMake installation.
|
| 57 |
+
If the file is found, it is read and processed by CMake. It is responsible
|
| 58 |
+
for finding the package, checking the version, and producing any needed
|
| 59 |
+
messages. Some Find modules provide limited or no support for versioning;
|
| 60 |
+
check the Find module's documentation.
|
| 61 |
+
|
| 62 |
+
The ``Find<PackageName>.cmake`` file is not typically provided by the
|
| 63 |
+
package itself. Rather, it is normally provided by something external to
|
| 64 |
+
the package, such as the operating system, CMake itself, or even the project
|
| 65 |
+
from which the ``find_package()`` command was called. Being externally
|
| 66 |
+
provided, :ref:`Find Modules` tend to be heuristic in nature and are
|
| 67 |
+
susceptible to becoming out-of-date. They typically search for certain
|
| 68 |
+
libraries, files and other package artifacts.
|
| 69 |
+
|
| 70 |
+
Module mode is only supported by the
|
| 71 |
+
:ref:`basic command signature <Basic Signature>`.
|
| 72 |
+
|
| 73 |
+
**Config mode**
|
| 74 |
+
In this mode, CMake searches for a file called
|
| 75 |
+
``<lowercasePackageName>-config.cmake`` or ``<PackageName>Config.cmake``.
|
| 76 |
+
It will also look for ``<lowercasePackageName>-config-version.cmake`` or
|
| 77 |
+
``<PackageName>ConfigVersion.cmake`` if version details were specified
|
| 78 |
+
(see :ref:`version selection` for an explanation of how these separate
|
| 79 |
+
version files are used).
|
| 80 |
+
|
| 81 |
+
In config mode, the command can be given a list of names to search for
|
| 82 |
+
as package names. The locations where CMake searches for the config and
|
| 83 |
+
version files is considerably more complicated than for Module mode
|
| 84 |
+
(see :ref:`search procedure`).
|
| 85 |
+
|
| 86 |
+
The config and version files are typically installed as part of the
|
| 87 |
+
package, so they tend to be more reliable than Find modules. They usually
|
| 88 |
+
contain direct knowledge of the package contents, so no searching or
|
| 89 |
+
heuristics are needed within the config or version files themselves.
|
| 90 |
+
|
| 91 |
+
Config mode is supported by both the :ref:`basic <Basic Signature>` and
|
| 92 |
+
:ref:`full <Full Signature>` command signatures.
|
| 93 |
+
|
| 94 |
+
**FetchContent redirection mode**
|
| 95 |
+
.. versionadded:: 3.24
|
| 96 |
+
A call to ``find_package()`` can be redirected internally to a package
|
| 97 |
+
provided by the :module:`FetchContent` module. To the caller, the behavior
|
| 98 |
+
will appear similar to Config mode, except that the search logic is
|
| 99 |
+
by-passed and the component information is not used. See
|
| 100 |
+
:command:`FetchContent_Declare` and :command:`FetchContent_MakeAvailable`
|
| 101 |
+
for further details.
|
| 102 |
+
|
| 103 |
+
When not redirected to a package provided by :module:`FetchContent`, the
|
| 104 |
+
command arguments determine whether Module or Config mode is used. When the
|
| 105 |
+
`basic signature`_ is used, the command searches in Module mode first.
|
| 106 |
+
If the package is not found, the search falls back to Config mode.
|
| 107 |
+
A user may set the :variable:`CMAKE_FIND_PACKAGE_PREFER_CONFIG` variable
|
| 108 |
+
to true to reverse the priority and direct CMake to search using Config mode
|
| 109 |
+
first before falling back to Module mode. The basic signature can also be
|
| 110 |
+
forced to use only Module mode with a ``MODULE`` keyword. If the
|
| 111 |
+
`full signature`_ is used, the command only searches in Config mode.
|
| 112 |
+
|
| 113 |
+
.. _`basic signature`:
|
| 114 |
+
|
| 115 |
+
Basic Signature
|
| 116 |
+
^^^^^^^^^^^^^^^
|
| 117 |
+
|
| 118 |
+
.. parsed-literal::
|
| 119 |
+
|
| 120 |
+
find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]
|
| 121 |
+
[REQUIRED] [[COMPONENTS] [components...]]
|
| 122 |
+
[OPTIONAL_COMPONENTS components...]
|
| 123 |
+
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
| 124 |
+
[GLOBAL]
|
| 125 |
+
[NO_POLICY_SCOPE]
|
| 126 |
+
[BYPASS_PROVIDER])
|
| 127 |
+
|
| 128 |
+
The basic signature is supported by both Module and Config modes.
|
| 129 |
+
The ``MODULE`` keyword implies that only Module mode can be used to find
|
| 130 |
+
the package, with no fallback to Config mode.
|
| 131 |
+
|
| 132 |
+
Regardless of the mode used, a ``<PackageName>_FOUND`` variable will be
|
| 133 |
+
set to indicate whether the package was found. When the package is found,
|
| 134 |
+
package-specific information may be provided through other variables and
|
| 135 |
+
:ref:`Imported Targets` documented by the package itself. The
|
| 136 |
+
``QUIET`` option disables informational messages, including those indicating
|
| 137 |
+
that the package cannot be found if it is not ``REQUIRED``. The ``REQUIRED``
|
| 138 |
+
option stops processing with an error message if the package cannot be found.
|
| 139 |
+
|
| 140 |
+
A package-specific list of required components may be listed after the
|
| 141 |
+
``COMPONENTS`` keyword. If any of these components are not able to be
|
| 142 |
+
satisfied, the package overall is considered to be not found. If the
|
| 143 |
+
``REQUIRED`` option is also present, this is treated as a fatal error,
|
| 144 |
+
otherwise execution still continues. As a form of shorthand, if the
|
| 145 |
+
``REQUIRED`` option is present, the ``COMPONENTS`` keyword can be omitted
|
| 146 |
+
and the required components can be listed directly after ``REQUIRED``.
|
| 147 |
+
|
| 148 |
+
Additional optional components may be listed after
|
| 149 |
+
``OPTIONAL_COMPONENTS``. If these cannot be satisfied, the package overall
|
| 150 |
+
can still be considered found, as long as all required components are
|
| 151 |
+
satisfied.
|
| 152 |
+
|
| 153 |
+
The set of available components and their meaning are defined by the
|
| 154 |
+
target package. Formally, it is up to the target package how to
|
| 155 |
+
interpret the component information given to it, but it should follow
|
| 156 |
+
the expectations stated above. For calls where no components are specified,
|
| 157 |
+
there is no single expected behavior and target packages should clearly
|
| 158 |
+
define what occurs in such cases. Common arrangements include assuming it
|
| 159 |
+
should find all components, no components or some well-defined subset of the
|
| 160 |
+
available components.
|
| 161 |
+
|
| 162 |
+
.. versionadded:: 3.24
|
| 163 |
+
The ``REGISTRY_VIEW`` keyword specifies which registry views should be
|
| 164 |
+
queried. This keyword is only meaningful on ``Windows`` platforms and will
|
| 165 |
+
be ignored on all others. Formally, it is up to the target package how to
|
| 166 |
+
interpret the registry view information given to it.
|
| 167 |
+
|
| 168 |
+
.. versionadded:: 3.24
|
| 169 |
+
Specifying the ``GLOBAL`` keyword will promote all imported targets to
|
| 170 |
+
a global scope in the importing project. Alternatively, this functionality
|
| 171 |
+
can be enabled by setting the :variable:`CMAKE_FIND_PACKAGE_TARGETS_GLOBAL`
|
| 172 |
+
variable.
|
| 173 |
+
|
| 174 |
+
.. _FIND_PACKAGE_VERSION_FORMAT:
|
| 175 |
+
|
| 176 |
+
The ``[version]`` argument requests a version with which the package found
|
| 177 |
+
should be compatible. There are two possible forms in which it may be
|
| 178 |
+
specified:
|
| 179 |
+
|
| 180 |
+
* A single version with the format ``major[.minor[.patch[.tweak]]]``, where
|
| 181 |
+
each component is a numeric value.
|
| 182 |
+
* A version range with the format ``versionMin...[<]versionMax`` where
|
| 183 |
+
``versionMin`` and ``versionMax`` have the same format and constraints
|
| 184 |
+
on components being integers as the single version. By default, both end
|
| 185 |
+
points are included. By specifying ``<``, the upper end point will be
|
| 186 |
+
excluded. Version ranges are only supported with CMake 3.19 or later.
|
| 187 |
+
|
| 188 |
+
The ``EXACT`` option requests that the version be matched exactly. This option
|
| 189 |
+
is incompatible with the specification of a version range.
|
| 190 |
+
|
| 191 |
+
If no ``[version]`` and/or component list is given to a recursive invocation
|
| 192 |
+
inside a find-module, the corresponding arguments are forwarded
|
| 193 |
+
automatically from the outer call (including the ``EXACT`` flag for
|
| 194 |
+
``[version]``). Version support is currently provided only on a
|
| 195 |
+
package-by-package basis (see the `Version Selection`_ section below).
|
| 196 |
+
When a version range is specified but the package is only designed to expect
|
| 197 |
+
a single version, the package will ignore the upper end point of the range and
|
| 198 |
+
only take the single version at the lower end of the range into account.
|
| 199 |
+
|
| 200 |
+
See the :command:`cmake_policy` command documentation for discussion
|
| 201 |
+
of the ``NO_POLICY_SCOPE`` option.
|
| 202 |
+
|
| 203 |
+
.. versionadded:: 3.24
|
| 204 |
+
The ``BYPASS_PROVIDER`` keyword is only allowed when ``find_package()`` is
|
| 205 |
+
being called by a :ref:`dependency provider <dependency_providers>`.
|
| 206 |
+
It can be used by providers to call the built-in ``find_package()``
|
| 207 |
+
implementation directly and prevent that call from being re-routed back to
|
| 208 |
+
itself. Future versions of CMake may detect attempts to use this keyword
|
| 209 |
+
from places other than a dependency provider and halt with a fatal error.
|
| 210 |
+
|
| 211 |
+
.. _`full signature`:
|
| 212 |
+
|
| 213 |
+
Full Signature
|
| 214 |
+
^^^^^^^^^^^^^^
|
| 215 |
+
|
| 216 |
+
.. parsed-literal::
|
| 217 |
+
|
| 218 |
+
find_package(<PackageName> [version] [EXACT] [QUIET]
|
| 219 |
+
[REQUIRED] [[COMPONENTS] [components...]]
|
| 220 |
+
[OPTIONAL_COMPONENTS components...]
|
| 221 |
+
[CONFIG|NO_MODULE]
|
| 222 |
+
[GLOBAL]
|
| 223 |
+
[NO_POLICY_SCOPE]
|
| 224 |
+
[BYPASS_PROVIDER]
|
| 225 |
+
[NAMES name1 [name2 ...]]
|
| 226 |
+
[CONFIGS config1 [config2 ...]]
|
| 227 |
+
[HINTS path1 [path2 ... ]]
|
| 228 |
+
[PATHS path1 [path2 ... ]]
|
| 229 |
+
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
| 230 |
+
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
| 231 |
+
[NO_DEFAULT_PATH]
|
| 232 |
+
[NO_PACKAGE_ROOT_PATH]
|
| 233 |
+
[NO_CMAKE_PATH]
|
| 234 |
+
[NO_CMAKE_ENVIRONMENT_PATH]
|
| 235 |
+
[NO_SYSTEM_ENVIRONMENT_PATH]
|
| 236 |
+
[NO_CMAKE_PACKAGE_REGISTRY]
|
| 237 |
+
[NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing.
|
| 238 |
+
[NO_CMAKE_SYSTEM_PATH]
|
| 239 |
+
[NO_CMAKE_INSTALL_PREFIX]
|
| 240 |
+
[NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
|
| 241 |
+
[CMAKE_FIND_ROOT_PATH_BOTH |
|
| 242 |
+
ONLY_CMAKE_FIND_ROOT_PATH |
|
| 243 |
+
NO_CMAKE_FIND_ROOT_PATH])
|
| 244 |
+
|
| 245 |
+
The ``CONFIG`` option, the synonymous ``NO_MODULE`` option, or the use
|
| 246 |
+
of options not specified in the `basic signature`_ all enforce pure Config
|
| 247 |
+
mode. In pure Config mode, the command skips Module mode search and
|
| 248 |
+
proceeds at once with Config mode search.
|
| 249 |
+
|
| 250 |
+
Config mode search attempts to locate a configuration file provided by the
|
| 251 |
+
package to be found. A cache entry called ``<PackageName>_DIR`` is created to
|
| 252 |
+
hold the directory containing the file. By default, the command searches for
|
| 253 |
+
a package with the name ``<PackageName>``. If the ``NAMES`` option is given,
|
| 254 |
+
the names following it are used instead of ``<PackageName>``. The names are
|
| 255 |
+
also considered when determining whether to redirect the call to a package
|
| 256 |
+
provided by :module:`FetchContent`.
|
| 257 |
+
|
| 258 |
+
The command searches for a file called ``<PackageName>Config.cmake`` or
|
| 259 |
+
``<lowercasePackageName>-config.cmake`` for each name specified.
|
| 260 |
+
A replacement set of possible configuration file names may be given
|
| 261 |
+
using the ``CONFIGS`` option. The :ref:`search procedure` is specified below.
|
| 262 |
+
Once found, any :ref:`version constraint <version selection>` is checked,
|
| 263 |
+
and if satisfied, the configuration file is read and processed by CMake.
|
| 264 |
+
Since the file is provided by the package it already knows the
|
| 265 |
+
location of package contents. The full path to the configuration file
|
| 266 |
+
is stored in the cmake variable ``<PackageName>_CONFIG``.
|
| 267 |
+
|
| 268 |
+
All configuration files which have been considered by CMake while
|
| 269 |
+
searching for the package with an appropriate version are stored in the
|
| 270 |
+
``<PackageName>_CONSIDERED_CONFIGS`` variable, and the associated versions
|
| 271 |
+
in the ``<PackageName>_CONSIDERED_VERSIONS`` variable.
|
| 272 |
+
|
| 273 |
+
If the package configuration file cannot be found CMake will generate
|
| 274 |
+
an error describing the problem unless the ``QUIET`` argument is
|
| 275 |
+
specified. If ``REQUIRED`` is specified and the package is not found a
|
| 276 |
+
fatal error is generated and the configure step stops executing. If
|
| 277 |
+
``<PackageName>_DIR`` has been set to a directory not containing a
|
| 278 |
+
configuration file CMake will ignore it and search from scratch.
|
| 279 |
+
|
| 280 |
+
Package maintainers providing CMake package configuration files are
|
| 281 |
+
encouraged to name and install them such that the :ref:`search procedure`
|
| 282 |
+
outlined below will find them without requiring use of additional options.
|
| 283 |
+
|
| 284 |
+
.. _`search procedure`:
|
| 285 |
+
|
| 286 |
+
Config Mode Search Procedure
|
| 287 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 288 |
+
|
| 289 |
+
.. note::
|
| 290 |
+
When Config mode is used, this search procedure is applied regardless of
|
| 291 |
+
whether the :ref:`full <full signature>` or :ref:`basic <basic signature>`
|
| 292 |
+
signature was given.
|
| 293 |
+
|
| 294 |
+
.. versionadded:: 3.24
|
| 295 |
+
All calls to ``find_package()`` (even in Module mode) first look for a config
|
| 296 |
+
package file in the :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR` directory.
|
| 297 |
+
The :module:`FetchContent` module, or even the project itself, may write files
|
| 298 |
+
to that location to redirect ``find_package()`` calls to content already
|
| 299 |
+
provided by the project. If no config package file is found in that location,
|
| 300 |
+
the search proceeds with the logic described below.
|
| 301 |
+
|
| 302 |
+
CMake constructs a set of possible installation prefixes for the
|
| 303 |
+
package. Under each prefix several directories are searched for a
|
| 304 |
+
configuration file. The tables below show the directories searched.
|
| 305 |
+
Each entry is meant for installation trees following Windows (``W``), UNIX
|
| 306 |
+
(``U``), or Apple (``A``) conventions:
|
| 307 |
+
|
| 308 |
+
==================================================================== ==========
|
| 309 |
+
Entry Convention
|
| 310 |
+
==================================================================== ==========
|
| 311 |
+
``<prefix>/`` W
|
| 312 |
+
``<prefix>/(cmake|CMake)/`` W
|
| 313 |
+
``<prefix>/<name>*/`` W
|
| 314 |
+
``<prefix>/<name>*/(cmake|CMake)/`` W
|
| 315 |
+
``<prefix>/<name>*/(cmake|CMake)/<name>*/`` [#]_ W
|
| 316 |
+
``<prefix>/(lib/<arch>|lib*|share)/cmake/<name>*/`` U
|
| 317 |
+
``<prefix>/(lib/<arch>|lib*|share)/<name>*/`` U
|
| 318 |
+
``<prefix>/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/`` U
|
| 319 |
+
``<prefix>/<name>*/(lib/<arch>|lib*|share)/cmake/<name>*/`` W/U
|
| 320 |
+
``<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/`` W/U
|
| 321 |
+
``<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/`` W/U
|
| 322 |
+
==================================================================== ==========
|
| 323 |
+
|
| 324 |
+
.. [#] .. versionadded:: 3.25
|
| 325 |
+
|
| 326 |
+
On systems supporting macOS :prop_tgt:`FRAMEWORK` and :prop_tgt:`BUNDLE`, the
|
| 327 |
+
following directories are searched for Frameworks or Application Bundles
|
| 328 |
+
containing a configuration file:
|
| 329 |
+
|
| 330 |
+
=========================================================== ==========
|
| 331 |
+
Entry Convention
|
| 332 |
+
=========================================================== ==========
|
| 333 |
+
``<prefix>/<name>.framework/Resources/`` A
|
| 334 |
+
``<prefix>/<name>.framework/Resources/CMake/`` A
|
| 335 |
+
``<prefix>/<name>.framework/Versions/*/Resources/`` A
|
| 336 |
+
``<prefix>/<name>.framework/Versions/*/Resources/CMake/`` A
|
| 337 |
+
``<prefix>/<name>.app/Contents/Resources/`` A
|
| 338 |
+
``<prefix>/<name>.app/Contents/Resources/CMake/`` A
|
| 339 |
+
=========================================================== ==========
|
| 340 |
+
|
| 341 |
+
In all cases the ``<name>`` is treated as case-insensitive and corresponds
|
| 342 |
+
to any of the names specified (``<PackageName>`` or names given by ``NAMES``).
|
| 343 |
+
|
| 344 |
+
If at least one compiled language has been enabled, the architecture-specific
|
| 345 |
+
``lib/<arch>`` and ``lib*`` directories may be searched based on the compiler's
|
| 346 |
+
target architecture, in the following order:
|
| 347 |
+
|
| 348 |
+
``lib/<arch>``
|
| 349 |
+
Searched if the :variable:`CMAKE_LIBRARY_ARCHITECTURE` variable is set.
|
| 350 |
+
|
| 351 |
+
``lib64``
|
| 352 |
+
Searched on 64 bit platforms (:variable:`CMAKE_SIZEOF_VOID_P` is 8) and the
|
| 353 |
+
:prop_gbl:`FIND_LIBRARY_USE_LIB64_PATHS` property is set to ``TRUE``.
|
| 354 |
+
|
| 355 |
+
``lib32``
|
| 356 |
+
Searched on 32 bit platforms (:variable:`CMAKE_SIZEOF_VOID_P` is 4) and the
|
| 357 |
+
:prop_gbl:`FIND_LIBRARY_USE_LIB32_PATHS` property is set to ``TRUE``.
|
| 358 |
+
|
| 359 |
+
``libx32``
|
| 360 |
+
Searched on platforms using the x32 ABI
|
| 361 |
+
if the :prop_gbl:`FIND_LIBRARY_USE_LIBX32_PATHS` property is set to ``TRUE``.
|
| 362 |
+
|
| 363 |
+
``lib``
|
| 364 |
+
Always searched.
|
| 365 |
+
|
| 366 |
+
.. versionchanged:: 3.24
|
| 367 |
+
On ``Windows`` platform, it is possible to include registry queries as part
|
| 368 |
+
of the directories specified through ``HINTS`` and ``PATHS`` keywords, using
|
| 369 |
+
a :ref:`dedicated syntax <Find Using Windows Registry>`. Such specifications
|
| 370 |
+
will be ignored on all other platforms.
|
| 371 |
+
|
| 372 |
+
.. versionadded:: 3.24
|
| 373 |
+
``REGISTRY_VIEW`` can be specified to manage ``Windows`` registry queries
|
| 374 |
+
specified as part of ``PATHS`` and ``HINTS``.
|
| 375 |
+
|
| 376 |
+
.. include:: FIND_XXX_REGISTRY_VIEW.txt
|
| 377 |
+
|
| 378 |
+
If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each
|
| 379 |
+
(``W``) or (``U``) directory entry one-by-one.
|
| 380 |
+
|
| 381 |
+
This set of directories is intended to work in cooperation with
|
| 382 |
+
projects that provide configuration files in their installation trees.
|
| 383 |
+
Directories above marked with (``W``) are intended for installations on
|
| 384 |
+
Windows where the prefix may point at the top of an application's
|
| 385 |
+
installation directory. Those marked with (``U``) are intended for
|
| 386 |
+
installations on UNIX platforms where the prefix is shared by multiple
|
| 387 |
+
packages. This is merely a convention, so all (``W``) and (``U``) directories
|
| 388 |
+
are still searched on all platforms. Directories marked with (``A``) are
|
| 389 |
+
intended for installations on Apple platforms. The
|
| 390 |
+
:variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
|
| 391 |
+
variables determine the order of preference.
|
| 392 |
+
|
| 393 |
+
The set of installation prefixes is constructed using the following
|
| 394 |
+
steps. If ``NO_DEFAULT_PATH`` is specified all ``NO_*`` options are
|
| 395 |
+
enabled.
|
| 396 |
+
|
| 397 |
+
1. Search prefixes unique to the current ``<PackageName>`` being found.
|
| 398 |
+
See policy :policy:`CMP0074`.
|
| 399 |
+
|
| 400 |
+
.. versionadded:: 3.12
|
| 401 |
+
|
| 402 |
+
Specifically, search prefixes specified by the following variables,
|
| 403 |
+
in order:
|
| 404 |
+
|
| 405 |
+
a. :variable:`<PackageName>_ROOT` CMake variable,
|
| 406 |
+
where ``<PackageName>`` is the case-preserved package name.
|
| 407 |
+
|
| 408 |
+
b. :variable:`<PACKAGENAME>_ROOT` CMake variable,
|
| 409 |
+
where ``<PACKAGENAME>`` is the upper-cased package name.
|
| 410 |
+
See policy :policy:`CMP0144`.
|
| 411 |
+
|
| 412 |
+
.. versionadded:: 3.27
|
| 413 |
+
|
| 414 |
+
c. :envvar:`<PackageName>_ROOT` environment variable,
|
| 415 |
+
where ``<PackageName>`` is the case-preserved package name.
|
| 416 |
+
|
| 417 |
+
d. :envvar:`<PACKAGENAME>_ROOT` environment variable,
|
| 418 |
+
where ``<PACKAGENAME>`` is the upper-cased package name.
|
| 419 |
+
See policy :policy:`CMP0144`.
|
| 420 |
+
|
| 421 |
+
.. versionadded:: 3.27
|
| 422 |
+
|
| 423 |
+
The package root variables are maintained as a stack so if
|
| 424 |
+
called from within a find module, root paths from the parent's find
|
| 425 |
+
module will also be searched after paths for the current package.
|
| 426 |
+
This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting
|
| 427 |
+
the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``.
|
| 428 |
+
|
| 429 |
+
2. Search paths specified in cmake-specific cache variables. These
|
| 430 |
+
are intended to be used on the command line with a :option:`-DVAR=VALUE <cmake -D>`.
|
| 431 |
+
The values are interpreted as :ref:`semicolon-separated lists <CMake Language Lists>`.
|
| 432 |
+
This can be skipped if ``NO_CMAKE_PATH`` is passed or by setting the
|
| 433 |
+
:variable:`CMAKE_FIND_USE_CMAKE_PATH` to ``FALSE``:
|
| 434 |
+
|
| 435 |
+
* :variable:`CMAKE_PREFIX_PATH`
|
| 436 |
+
* :variable:`CMAKE_FRAMEWORK_PATH`
|
| 437 |
+
* :variable:`CMAKE_APPBUNDLE_PATH`
|
| 438 |
+
|
| 439 |
+
3. Search paths specified in cmake-specific environment variables.
|
| 440 |
+
These are intended to be set in the user's shell configuration,
|
| 441 |
+
and therefore use the host's native path separator
|
| 442 |
+
(``;`` on Windows and ``:`` on UNIX).
|
| 443 |
+
This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed or by setting
|
| 444 |
+
the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` to ``FALSE``:
|
| 445 |
+
|
| 446 |
+
* ``<PackageName>_DIR``
|
| 447 |
+
* :envvar:`CMAKE_PREFIX_PATH`
|
| 448 |
+
* :envvar:`CMAKE_FRAMEWORK_PATH`
|
| 449 |
+
* :envvar:`CMAKE_APPBUNDLE_PATH`
|
| 450 |
+
|
| 451 |
+
4. Search paths specified by the ``HINTS`` option. These should be paths
|
| 452 |
+
computed by system introspection, such as a hint provided by the
|
| 453 |
+
location of another item already found. Hard-coded guesses should
|
| 454 |
+
be specified with the ``PATHS`` option.
|
| 455 |
+
|
| 456 |
+
5. Search the standard system environment variables. This can be
|
| 457 |
+
skipped if ``NO_SYSTEM_ENVIRONMENT_PATH`` is passed or by setting the
|
| 458 |
+
:variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` to ``FALSE``. Path entries
|
| 459 |
+
ending in ``/bin`` or ``/sbin`` are automatically converted to their
|
| 460 |
+
parent directories:
|
| 461 |
+
|
| 462 |
+
* ``PATH``
|
| 463 |
+
|
| 464 |
+
6. Search paths stored in the CMake :ref:`User Package Registry`.
|
| 465 |
+
This can be skipped if ``NO_CMAKE_PACKAGE_REGISTRY`` is passed or by
|
| 466 |
+
setting the variable :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY`
|
| 467 |
+
to ``FALSE`` or the deprecated variable
|
| 468 |
+
:variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` to ``TRUE``.
|
| 469 |
+
|
| 470 |
+
See the :manual:`cmake-packages(7)` manual for details on the user
|
| 471 |
+
package registry.
|
| 472 |
+
|
| 473 |
+
7. Search cmake variables defined in the Platform files for the
|
| 474 |
+
current system. The searching of :variable:`CMAKE_INSTALL_PREFIX` and
|
| 475 |
+
:variable:`CMAKE_STAGING_PREFIX` can be
|
| 476 |
+
skipped if ``NO_CMAKE_INSTALL_PREFIX`` is passed or by setting the
|
| 477 |
+
:variable:`CMAKE_FIND_USE_INSTALL_PREFIX` to ``FALSE``. All these locations
|
| 478 |
+
can be skipped if ``NO_CMAKE_SYSTEM_PATH`` is passed or by setting the
|
| 479 |
+
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` to ``FALSE``:
|
| 480 |
+
|
| 481 |
+
* :variable:`CMAKE_SYSTEM_PREFIX_PATH`
|
| 482 |
+
* :variable:`CMAKE_SYSTEM_FRAMEWORK_PATH`
|
| 483 |
+
* :variable:`CMAKE_SYSTEM_APPBUNDLE_PATH`
|
| 484 |
+
|
| 485 |
+
The platform paths that these variables contain are locations that
|
| 486 |
+
typically include installed software. An example being ``/usr/local`` for
|
| 487 |
+
UNIX based platforms.
|
| 488 |
+
|
| 489 |
+
8. Search paths stored in the CMake :ref:`System Package Registry`.
|
| 490 |
+
This can be skipped if ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` is passed
|
| 491 |
+
or by setting the :variable:`CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY`
|
| 492 |
+
variable to ``FALSE`` or the deprecated variable
|
| 493 |
+
:variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` to ``TRUE``.
|
| 494 |
+
|
| 495 |
+
See the :manual:`cmake-packages(7)` manual for details on the system
|
| 496 |
+
package registry.
|
| 497 |
+
|
| 498 |
+
9. Search paths specified by the ``PATHS`` option. These are typically
|
| 499 |
+
hard-coded guesses.
|
| 500 |
+
|
| 501 |
+
The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`,
|
| 502 |
+
:variable:`CMAKE_SYSTEM_IGNORE_PATH` and
|
| 503 |
+
:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some
|
| 504 |
+
of the above locations to be ignored.
|
| 505 |
+
|
| 506 |
+
Paths are searched in the order described above. The first viable package
|
| 507 |
+
configuration file found is used, even if a newer version of the package
|
| 508 |
+
resides later in the list of search paths.
|
| 509 |
+
|
| 510 |
+
For search paths which contain ``<name>*``, the order among matching paths
|
| 511 |
+
is unspecified unless the :variable:`CMAKE_FIND_PACKAGE_SORT_ORDER` variable
|
| 512 |
+
is set. This variable, along with the
|
| 513 |
+
:variable:`CMAKE_FIND_PACKAGE_SORT_DIRECTION` variable, determines the order
|
| 514 |
+
in which CMake considers paths that match a single search path containing
|
| 515 |
+
``<name>*``. For example, if the file system contains the package
|
| 516 |
+
configuration files
|
| 517 |
+
|
| 518 |
+
::
|
| 519 |
+
|
| 520 |
+
<prefix>/example-1.2/example-config.cmake
|
| 521 |
+
<prefix>/example-1.10/example-config.cmake
|
| 522 |
+
<prefix>/share/example-2.0/example-config.cmake
|
| 523 |
+
|
| 524 |
+
it is unspecified (when the aforementioned variables are unset) whether
|
| 525 |
+
``find_package(example)`` will find ``example-1.2`` or ``example-1.10``
|
| 526 |
+
(assuming that both are viable), but ``find_package`` will *not* find
|
| 527 |
+
``example-2.0``, because one of the other two will be found first.
|
| 528 |
+
|
| 529 |
+
To control the order in which ``find_package`` searches directories that match
|
| 530 |
+
a glob expression, use :variable:`CMAKE_FIND_PACKAGE_SORT_ORDER` and
|
| 531 |
+
:variable:`CMAKE_FIND_PACKAGE_SORT_DIRECTION`.
|
| 532 |
+
For instance, to cause the above example to select ``example-1.10``,
|
| 533 |
+
one can set
|
| 534 |
+
|
| 535 |
+
.. code-block:: cmake
|
| 536 |
+
|
| 537 |
+
SET(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
|
| 538 |
+
SET(CMAKE_FIND_PACKAGE_SORT_DIRECTION DEC)
|
| 539 |
+
|
| 540 |
+
before calling ``find_package``.
|
| 541 |
+
|
| 542 |
+
.. versionadded:: 3.16
|
| 543 |
+
Added the ``CMAKE_FIND_USE_<CATEGORY>`` variables to globally disable
|
| 544 |
+
various search locations.
|
| 545 |
+
|
| 546 |
+
.. include:: FIND_XXX_ROOT.txt
|
| 547 |
+
.. include:: FIND_XXX_ORDER.txt
|
| 548 |
+
|
| 549 |
+
By default the value stored in the result variable will be the path at
|
| 550 |
+
which the file is found. The :variable:`CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS`
|
| 551 |
+
variable may be set to ``TRUE`` before calling ``find_package`` in order
|
| 552 |
+
to resolve symbolic links and store the real path to the file.
|
| 553 |
+
|
| 554 |
+
Every non-REQUIRED ``find_package`` call can be disabled or made REQUIRED:
|
| 555 |
+
|
| 556 |
+
* Setting the :variable:`CMAKE_DISABLE_FIND_PACKAGE_<PackageName>` variable
|
| 557 |
+
to ``TRUE`` disables the package. This also disables redirection to a
|
| 558 |
+
package provided by :module:`FetchContent`.
|
| 559 |
+
|
| 560 |
+
* Setting the :variable:`CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>` variable
|
| 561 |
+
to ``TRUE`` makes the package REQUIRED.
|
| 562 |
+
|
| 563 |
+
Setting both variables to ``TRUE`` simultaneously is an error.
|
| 564 |
+
|
| 565 |
+
.. _`version selection`:
|
| 566 |
+
|
| 567 |
+
Config Mode Version Selection
|
| 568 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 569 |
+
|
| 570 |
+
.. note::
|
| 571 |
+
When Config mode is used, this version selection process is applied
|
| 572 |
+
regardless of whether the :ref:`full <full signature>` or
|
| 573 |
+
:ref:`basic <basic signature>` signature was given.
|
| 574 |
+
|
| 575 |
+
When the ``[version]`` argument is given, Config mode will only find a
|
| 576 |
+
version of the package that claims compatibility with the requested
|
| 577 |
+
version (see :ref:`format specification <FIND_PACKAGE_VERSION_FORMAT>`). If the
|
| 578 |
+
``EXACT`` option is given, only a version of the package claiming an exact match
|
| 579 |
+
of the requested version may be found. CMake does not establish any
|
| 580 |
+
convention for the meaning of version numbers. Package version
|
| 581 |
+
numbers are checked by "version" files provided by the packages themselves
|
| 582 |
+
or by :module:`FetchContent`. For a candidate package configuration file
|
| 583 |
+
``<config-file>.cmake`` the corresponding version file is located next
|
| 584 |
+
to it and named either ``<config-file>-version.cmake`` or
|
| 585 |
+
``<config-file>Version.cmake``. If no such version file is available
|
| 586 |
+
then the configuration file is assumed to not be compatible with any
|
| 587 |
+
requested version. A basic version file containing generic version
|
| 588 |
+
matching code can be created using the
|
| 589 |
+
:module:`CMakePackageConfigHelpers` module. When a version file
|
| 590 |
+
is found it is loaded to check the requested version number. The
|
| 591 |
+
version file is loaded in a nested scope in which the following
|
| 592 |
+
variables have been defined:
|
| 593 |
+
|
| 594 |
+
``PACKAGE_FIND_NAME``
|
| 595 |
+
The ``<PackageName>``
|
| 596 |
+
``PACKAGE_FIND_VERSION``
|
| 597 |
+
Full requested version string
|
| 598 |
+
``PACKAGE_FIND_VERSION_MAJOR``
|
| 599 |
+
Major version if requested, else 0
|
| 600 |
+
``PACKAGE_FIND_VERSION_MINOR``
|
| 601 |
+
Minor version if requested, else 0
|
| 602 |
+
``PACKAGE_FIND_VERSION_PATCH``
|
| 603 |
+
Patch version if requested, else 0
|
| 604 |
+
``PACKAGE_FIND_VERSION_TWEAK``
|
| 605 |
+
Tweak version if requested, else 0
|
| 606 |
+
``PACKAGE_FIND_VERSION_COUNT``
|
| 607 |
+
Number of version components, 0 to 4
|
| 608 |
+
|
| 609 |
+
When a version range is specified, the above version variables will hold
|
| 610 |
+
values based on the lower end of the version range. This is to preserve
|
| 611 |
+
compatibility with packages that have not been implemented to expect version
|
| 612 |
+
ranges. In addition, the version range will be described by the following
|
| 613 |
+
variables:
|
| 614 |
+
|
| 615 |
+
``PACKAGE_FIND_VERSION_RANGE``
|
| 616 |
+
Full requested version range string
|
| 617 |
+
``PACKAGE_FIND_VERSION_RANGE_MIN``
|
| 618 |
+
This specifies whether the lower end point of the version range should be
|
| 619 |
+
included or excluded. Currently, the only supported value for this variable
|
| 620 |
+
is ``INCLUDE``.
|
| 621 |
+
``PACKAGE_FIND_VERSION_RANGE_MAX``
|
| 622 |
+
This specifies whether the upper end point of the version range should be
|
| 623 |
+
included or excluded. The supported values for this variable are
|
| 624 |
+
``INCLUDE`` and ``EXCLUDE``.
|
| 625 |
+
|
| 626 |
+
``PACKAGE_FIND_VERSION_MIN``
|
| 627 |
+
Full requested version string of the lower end point of the range
|
| 628 |
+
``PACKAGE_FIND_VERSION_MIN_MAJOR``
|
| 629 |
+
Major version of the lower end point if requested, else 0
|
| 630 |
+
``PACKAGE_FIND_VERSION_MIN_MINOR``
|
| 631 |
+
Minor version of the lower end point if requested, else 0
|
| 632 |
+
``PACKAGE_FIND_VERSION_MIN_PATCH``
|
| 633 |
+
Patch version of the lower end point if requested, else 0
|
| 634 |
+
``PACKAGE_FIND_VERSION_MIN_TWEAK``
|
| 635 |
+
Tweak version of the lower end point if requested, else 0
|
| 636 |
+
``PACKAGE_FIND_VERSION_MIN_COUNT``
|
| 637 |
+
Number of version components of the lower end point, 0 to 4
|
| 638 |
+
|
| 639 |
+
``PACKAGE_FIND_VERSION_MAX``
|
| 640 |
+
Full requested version string of the upper end point of the range
|
| 641 |
+
``PACKAGE_FIND_VERSION_MAX_MAJOR``
|
| 642 |
+
Major version of the upper end point if requested, else 0
|
| 643 |
+
``PACKAGE_FIND_VERSION_MAX_MINOR``
|
| 644 |
+
Minor version of the upper end point if requested, else 0
|
| 645 |
+
``PACKAGE_FIND_VERSION_MAX_PATCH``
|
| 646 |
+
Patch version of the upper end point if requested, else 0
|
| 647 |
+
``PACKAGE_FIND_VERSION_MAX_TWEAK``
|
| 648 |
+
Tweak version of the upper end point if requested, else 0
|
| 649 |
+
``PACKAGE_FIND_VERSION_MAX_COUNT``
|
| 650 |
+
Number of version components of the upper end point, 0 to 4
|
| 651 |
+
|
| 652 |
+
Regardless of whether a single version or a version range is specified, the
|
| 653 |
+
variable ``PACKAGE_FIND_VERSION_COMPLETE`` will be defined and will hold
|
| 654 |
+
the full requested version string as specified.
|
| 655 |
+
|
| 656 |
+
The version file checks whether it satisfies the requested version and
|
| 657 |
+
sets these variables:
|
| 658 |
+
|
| 659 |
+
``PACKAGE_VERSION``
|
| 660 |
+
Full provided version string
|
| 661 |
+
``PACKAGE_VERSION_EXACT``
|
| 662 |
+
True if version is exact match
|
| 663 |
+
``PACKAGE_VERSION_COMPATIBLE``
|
| 664 |
+
True if version is compatible
|
| 665 |
+
``PACKAGE_VERSION_UNSUITABLE``
|
| 666 |
+
True if unsuitable as any version
|
| 667 |
+
|
| 668 |
+
These variables are checked by the ``find_package`` command to determine
|
| 669 |
+
whether the configuration file provides an acceptable version. They
|
| 670 |
+
are not available after the ``find_package`` call returns. If the version
|
| 671 |
+
is acceptable the following variables are set:
|
| 672 |
+
|
| 673 |
+
``<PackageName>_VERSION``
|
| 674 |
+
Full provided version string
|
| 675 |
+
``<PackageName>_VERSION_MAJOR``
|
| 676 |
+
Major version if provided, else 0
|
| 677 |
+
``<PackageName>_VERSION_MINOR``
|
| 678 |
+
Minor version if provided, else 0
|
| 679 |
+
``<PackageName>_VERSION_PATCH``
|
| 680 |
+
Patch version if provided, else 0
|
| 681 |
+
``<PackageName>_VERSION_TWEAK``
|
| 682 |
+
Tweak version if provided, else 0
|
| 683 |
+
``<PackageName>_VERSION_COUNT``
|
| 684 |
+
Number of version components, 0 to 4
|
| 685 |
+
|
| 686 |
+
and the corresponding package configuration file is loaded.
|
| 687 |
+
|
| 688 |
+
Package File Interface Variables
|
| 689 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 690 |
+
|
| 691 |
+
When loading a find module or package configuration file ``find_package``
|
| 692 |
+
defines variables to provide information about the call arguments (and
|
| 693 |
+
restores their original state before returning):
|
| 694 |
+
|
| 695 |
+
``CMAKE_FIND_PACKAGE_NAME``
|
| 696 |
+
The ``<PackageName>`` which is searched for
|
| 697 |
+
``<PackageName>_FIND_REQUIRED``
|
| 698 |
+
True if ``REQUIRED`` option was given
|
| 699 |
+
``<PackageName>_FIND_QUIETLY``
|
| 700 |
+
True if ``QUIET`` option was given
|
| 701 |
+
``<PackageName>_FIND_REGISTRY_VIEW``
|
| 702 |
+
The requested view if ``REGISTRY_VIEW`` option was given
|
| 703 |
+
``<PackageName>_FIND_VERSION``
|
| 704 |
+
Full requested version string
|
| 705 |
+
``<PackageName>_FIND_VERSION_MAJOR``
|
| 706 |
+
Major version if requested, else 0
|
| 707 |
+
``<PackageName>_FIND_VERSION_MINOR``
|
| 708 |
+
Minor version if requested, else 0
|
| 709 |
+
``<PackageName>_FIND_VERSION_PATCH``
|
| 710 |
+
Patch version if requested, else 0
|
| 711 |
+
``<PackageName>_FIND_VERSION_TWEAK``
|
| 712 |
+
Tweak version if requested, else 0
|
| 713 |
+
``<PackageName>_FIND_VERSION_COUNT``
|
| 714 |
+
Number of version components, 0 to 4
|
| 715 |
+
``<PackageName>_FIND_VERSION_EXACT``
|
| 716 |
+
True if ``EXACT`` option was given
|
| 717 |
+
``<PackageName>_FIND_COMPONENTS``
|
| 718 |
+
List of specified components (required and optional)
|
| 719 |
+
``<PackageName>_FIND_REQUIRED_<c>``
|
| 720 |
+
True if component ``<c>`` is required,
|
| 721 |
+
false if component ``<c>`` is optional
|
| 722 |
+
|
| 723 |
+
When a version range is specified, the above version variables will hold
|
| 724 |
+
values based on the lower end of the version range. This is to preserve
|
| 725 |
+
compatibility with packages that have not been implemented to expect version
|
| 726 |
+
ranges. In addition, the version range will be described by the following
|
| 727 |
+
variables:
|
| 728 |
+
|
| 729 |
+
``<PackageName>_FIND_VERSION_RANGE``
|
| 730 |
+
Full requested version range string
|
| 731 |
+
``<PackageName>_FIND_VERSION_RANGE_MIN``
|
| 732 |
+
This specifies whether the lower end point of the version range is
|
| 733 |
+
included or excluded. Currently, ``INCLUDE`` is the only supported value.
|
| 734 |
+
``<PackageName>_FIND_VERSION_RANGE_MAX``
|
| 735 |
+
This specifies whether the upper end point of the version range is
|
| 736 |
+
included or excluded. The possible values for this variable are
|
| 737 |
+
``INCLUDE`` or ``EXCLUDE``.
|
| 738 |
+
|
| 739 |
+
``<PackageName>_FIND_VERSION_MIN``
|
| 740 |
+
Full requested version string of the lower end point of the range
|
| 741 |
+
``<PackageName>_FIND_VERSION_MIN_MAJOR``
|
| 742 |
+
Major version of the lower end point if requested, else 0
|
| 743 |
+
``<PackageName>_FIND_VERSION_MIN_MINOR``
|
| 744 |
+
Minor version of the lower end point if requested, else 0
|
| 745 |
+
``<PackageName>_FIND_VERSION_MIN_PATCH``
|
| 746 |
+
Patch version of the lower end point if requested, else 0
|
| 747 |
+
``<PackageName>_FIND_VERSION_MIN_TWEAK``
|
| 748 |
+
Tweak version of the lower end point if requested, else 0
|
| 749 |
+
``<PackageName>_FIND_VERSION_MIN_COUNT``
|
| 750 |
+
Number of version components of the lower end point, 0 to 4
|
| 751 |
+
|
| 752 |
+
``<PackageName>_FIND_VERSION_MAX``
|
| 753 |
+
Full requested version string of the upper end point of the range
|
| 754 |
+
``<PackageName>_FIND_VERSION_MAX_MAJOR``
|
| 755 |
+
Major version of the upper end point if requested, else 0
|
| 756 |
+
``<PackageName>_FIND_VERSION_MAX_MINOR``
|
| 757 |
+
Minor version of the upper end point if requested, else 0
|
| 758 |
+
``<PackageName>_FIND_VERSION_MAX_PATCH``
|
| 759 |
+
Patch version of the upper end point if requested, else 0
|
| 760 |
+
``<PackageName>_FIND_VERSION_MAX_TWEAK``
|
| 761 |
+
Tweak version of the upper end point if requested, else 0
|
| 762 |
+
``<PackageName>_FIND_VERSION_MAX_COUNT``
|
| 763 |
+
Number of version components of the upper end point, 0 to 4
|
| 764 |
+
|
| 765 |
+
Regardless of whether a single version or a version range is specified, the
|
| 766 |
+
variable ``<PackageName>_FIND_VERSION_COMPLETE`` will be defined and will hold
|
| 767 |
+
the full requested version string as specified.
|
| 768 |
+
|
| 769 |
+
In Module mode the loaded find module is responsible to honor the
|
| 770 |
+
request detailed by these variables; see the find module for details.
|
| 771 |
+
In Config mode ``find_package`` handles ``REQUIRED``, ``QUIET``, and
|
| 772 |
+
``[version]`` options automatically but leaves it to the package
|
| 773 |
+
configuration file to handle components in a way that makes sense
|
| 774 |
+
for the package. The package configuration file may set
|
| 775 |
+
``<PackageName>_FOUND`` to false to tell ``find_package`` that component
|
| 776 |
+
requirements are not satisfied.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/foreach.rst
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
foreach
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Evaluate a group of commands for each value in a list.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
foreach(<loop_var> <items>)
|
| 9 |
+
<commands>
|
| 10 |
+
endforeach()
|
| 11 |
+
|
| 12 |
+
where ``<items>`` is a list of items that are separated by
|
| 13 |
+
semicolon or whitespace.
|
| 14 |
+
All commands between ``foreach`` and the matching ``endforeach`` are recorded
|
| 15 |
+
without being invoked. Once the ``endforeach`` is evaluated, the recorded
|
| 16 |
+
list of commands is invoked once for each item in ``<items>``.
|
| 17 |
+
At the beginning of each iteration the variable ``<loop_var>`` will be set
|
| 18 |
+
to the value of the current item.
|
| 19 |
+
|
| 20 |
+
The scope of ``<loop_var>`` is restricted to the loop scope. See policy
|
| 21 |
+
:policy:`CMP0124` for details.
|
| 22 |
+
|
| 23 |
+
The commands :command:`break` and :command:`continue` provide means to
|
| 24 |
+
escape from the normal control flow.
|
| 25 |
+
|
| 26 |
+
Per legacy, the :command:`endforeach` command admits
|
| 27 |
+
an optional ``<loop_var>`` argument.
|
| 28 |
+
If used, it must be a verbatim
|
| 29 |
+
repeat of the argument of the opening
|
| 30 |
+
``foreach`` command.
|
| 31 |
+
|
| 32 |
+
.. code-block:: cmake
|
| 33 |
+
|
| 34 |
+
foreach(<loop_var> RANGE <stop>)
|
| 35 |
+
|
| 36 |
+
In this variant, ``foreach`` iterates over the numbers
|
| 37 |
+
0, 1, ... up to (and including) the nonnegative integer ``<stop>``.
|
| 38 |
+
|
| 39 |
+
.. code-block:: cmake
|
| 40 |
+
|
| 41 |
+
foreach(<loop_var> RANGE <start> <stop> [<step>])
|
| 42 |
+
|
| 43 |
+
In this variant, ``foreach`` iterates over the numbers from
|
| 44 |
+
``<start>`` up to at most ``<stop>`` in steps of ``<step>``.
|
| 45 |
+
If ``<step>`` is not specified, then the step size is 1.
|
| 46 |
+
The three arguments ``<start>`` ``<stop>`` ``<step>`` must
|
| 47 |
+
all be nonnegative integers, and ``<stop>`` must not be
|
| 48 |
+
smaller than ``<start>``; otherwise you enter the danger zone
|
| 49 |
+
of undocumented behavior that may change in future releases.
|
| 50 |
+
|
| 51 |
+
.. code-block:: cmake
|
| 52 |
+
|
| 53 |
+
foreach(<loop_var> IN [LISTS [<lists>]] [ITEMS [<items>]])
|
| 54 |
+
|
| 55 |
+
In this variant, ``<lists>`` is a whitespace or semicolon
|
| 56 |
+
separated list of list-valued variables. The ``foreach``
|
| 57 |
+
command iterates over each item in each given list.
|
| 58 |
+
The ``<items>`` following the ``ITEMS`` keyword are processed
|
| 59 |
+
as in the first variant of the ``foreach`` command.
|
| 60 |
+
The forms ``LISTS A`` and ``ITEMS ${A}`` are
|
| 61 |
+
equivalent.
|
| 62 |
+
|
| 63 |
+
The following example shows how the ``LISTS`` option is
|
| 64 |
+
processed:
|
| 65 |
+
|
| 66 |
+
.. code-block:: cmake
|
| 67 |
+
|
| 68 |
+
set(A 0;1)
|
| 69 |
+
set(B 2 3)
|
| 70 |
+
set(C "4 5")
|
| 71 |
+
set(D 6;7 8)
|
| 72 |
+
set(E "")
|
| 73 |
+
foreach(X IN LISTS A B C D E)
|
| 74 |
+
message(STATUS "X=${X}")
|
| 75 |
+
endforeach()
|
| 76 |
+
|
| 77 |
+
yields::
|
| 78 |
+
|
| 79 |
+
-- X=0
|
| 80 |
+
-- X=1
|
| 81 |
+
-- X=2
|
| 82 |
+
-- X=3
|
| 83 |
+
-- X=4 5
|
| 84 |
+
-- X=6
|
| 85 |
+
-- X=7
|
| 86 |
+
-- X=8
|
| 87 |
+
|
| 88 |
+
|
| 89 |
+
.. code-block:: cmake
|
| 90 |
+
|
| 91 |
+
foreach(<loop_var>... IN ZIP_LISTS <lists>)
|
| 92 |
+
|
| 93 |
+
.. versionadded:: 3.17
|
| 94 |
+
|
| 95 |
+
In this variant, ``<lists>`` is a whitespace or semicolon
|
| 96 |
+
separated list of list-valued variables. The ``foreach``
|
| 97 |
+
command iterates over each list simultaneously setting the
|
| 98 |
+
iteration variables as follows:
|
| 99 |
+
|
| 100 |
+
- if the only ``loop_var`` given, then it sets a series of
|
| 101 |
+
``loop_var_N`` variables to the current item from the
|
| 102 |
+
corresponding list;
|
| 103 |
+
- if multiple variable names passed, their count should match
|
| 104 |
+
the lists variables count;
|
| 105 |
+
- if any of the lists are shorter, the corresponding iteration
|
| 106 |
+
variable is not defined for the current iteration.
|
| 107 |
+
|
| 108 |
+
.. code-block:: cmake
|
| 109 |
+
|
| 110 |
+
list(APPEND English one two three four)
|
| 111 |
+
list(APPEND Bahasa satu dua tiga)
|
| 112 |
+
|
| 113 |
+
foreach(num IN ZIP_LISTS English Bahasa)
|
| 114 |
+
message(STATUS "num_0=${num_0}, num_1=${num_1}")
|
| 115 |
+
endforeach()
|
| 116 |
+
|
| 117 |
+
foreach(en ba IN ZIP_LISTS English Bahasa)
|
| 118 |
+
message(STATUS "en=${en}, ba=${ba}")
|
| 119 |
+
endforeach()
|
| 120 |
+
|
| 121 |
+
yields::
|
| 122 |
+
|
| 123 |
+
-- num_0=one, num_1=satu
|
| 124 |
+
-- num_0=two, num_1=dua
|
| 125 |
+
-- num_0=three, num_1=tiga
|
| 126 |
+
-- num_0=four, num_1=
|
| 127 |
+
-- en=one, ba=satu
|
| 128 |
+
-- en=two, ba=dua
|
| 129 |
+
-- en=three, ba=tiga
|
| 130 |
+
-- en=four, ba=
|
| 131 |
+
|
| 132 |
+
See Also
|
| 133 |
+
^^^^^^^^
|
| 134 |
+
|
| 135 |
+
* :command:`break`
|
| 136 |
+
* :command:`continue`
|
| 137 |
+
* :command:`endforeach`
|
| 138 |
+
* :command:`while`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_directory_property.rst
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
get_directory_property
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
Get a property of ``DIRECTORY`` scope.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)
|
| 9 |
+
|
| 10 |
+
Stores a property of directory scope in the named ``<variable>``.
|
| 11 |
+
|
| 12 |
+
The ``DIRECTORY`` argument specifies another directory from which
|
| 13 |
+
to retrieve the property value instead of the current directory.
|
| 14 |
+
Relative paths are treated as relative to the
|
| 15 |
+
current source directory. CMake must already know about the directory,
|
| 16 |
+
either by having added it through a call to :command:`add_subdirectory`
|
| 17 |
+
or being the top level directory.
|
| 18 |
+
|
| 19 |
+
.. versionadded:: 3.19
|
| 20 |
+
``<dir>`` may reference a binary directory.
|
| 21 |
+
|
| 22 |
+
If the property is not defined for the nominated directory scope,
|
| 23 |
+
an empty string is returned. In the case of ``INHERITED`` properties,
|
| 24 |
+
if the property is not found for the nominated directory scope,
|
| 25 |
+
the search will chain to a parent scope as described for the
|
| 26 |
+
:command:`define_property` command.
|
| 27 |
+
|
| 28 |
+
.. code-block:: cmake
|
| 29 |
+
|
| 30 |
+
get_directory_property(<variable> [DIRECTORY <dir>]
|
| 31 |
+
DEFINITION <var-name>)
|
| 32 |
+
|
| 33 |
+
Get a variable definition from a directory. This form is useful to
|
| 34 |
+
get a variable definition from another directory.
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
See Also
|
| 38 |
+
^^^^^^^^
|
| 39 |
+
|
| 40 |
+
* :command:`define_property`
|
| 41 |
+
* the more general :command:`get_property` command
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_filename_component.rst
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
get_filename_component
|
| 2 |
+
----------------------
|
| 3 |
+
|
| 4 |
+
Get a specific component of a full filename.
|
| 5 |
+
|
| 6 |
+
.. versionchanged:: 3.20
|
| 7 |
+
This command has been superseded by the :command:`cmake_path` command, except
|
| 8 |
+
for ``REALPATH``, which is now offered by :command:`file(REAL_PATH)`, and
|
| 9 |
+
``PROGRAM``, now available in :command:`separate_arguments(PROGRAM)`.
|
| 10 |
+
|
| 11 |
+
.. versionchanged:: 3.24
|
| 12 |
+
The undocumented feature offering the capability to query the ``Windows``
|
| 13 |
+
registry is superseded by
|
| 14 |
+
:ref:`cmake_host_system_information(QUERY WINDOWS_REGISTRY)<Query Windows registry>`
|
| 15 |
+
command.
|
| 16 |
+
|
| 17 |
+
.. code-block:: cmake
|
| 18 |
+
|
| 19 |
+
get_filename_component(<var> <FileName> <mode> [CACHE])
|
| 20 |
+
|
| 21 |
+
Sets ``<var>`` to a component of ``<FileName>``, where ``<mode>`` is one of:
|
| 22 |
+
|
| 23 |
+
::
|
| 24 |
+
|
| 25 |
+
DIRECTORY = Directory without file name
|
| 26 |
+
NAME = File name without directory
|
| 27 |
+
EXT = File name longest extension (.b.c from d/a.b.c)
|
| 28 |
+
NAME_WE = File name with neither the directory nor the longest extension
|
| 29 |
+
LAST_EXT = File name last extension (.c from d/a.b.c)
|
| 30 |
+
NAME_WLE = File name with neither the directory nor the last extension
|
| 31 |
+
PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)
|
| 32 |
+
|
| 33 |
+
.. versionadded:: 3.14
|
| 34 |
+
Added the ``LAST_EXT`` and ``NAME_WLE`` modes.
|
| 35 |
+
|
| 36 |
+
Paths are returned with forward slashes and have no trailing slashes.
|
| 37 |
+
If the optional ``CACHE`` argument is specified, the result variable is
|
| 38 |
+
added to the cache.
|
| 39 |
+
|
| 40 |
+
.. code-block:: cmake
|
| 41 |
+
|
| 42 |
+
get_filename_component(<var> <FileName> <mode> [BASE_DIR <dir>] [CACHE])
|
| 43 |
+
|
| 44 |
+
.. versionadded:: 3.4
|
| 45 |
+
|
| 46 |
+
Sets ``<var>`` to the absolute path of ``<FileName>``, where ``<mode>`` is one
|
| 47 |
+
of:
|
| 48 |
+
|
| 49 |
+
::
|
| 50 |
+
|
| 51 |
+
ABSOLUTE = Full path to file
|
| 52 |
+
REALPATH = Full path to existing file with symlinks resolved
|
| 53 |
+
|
| 54 |
+
If the provided ``<FileName>`` is a relative path, it is evaluated relative
|
| 55 |
+
to the given base directory ``<dir>``. If no base directory is
|
| 56 |
+
provided, the default base directory will be
|
| 57 |
+
:variable:`CMAKE_CURRENT_SOURCE_DIR`.
|
| 58 |
+
|
| 59 |
+
Paths are returned with forward slashes and have no trailing slashes. If the
|
| 60 |
+
optional ``CACHE`` argument is specified, the result variable is added to the
|
| 61 |
+
cache.
|
| 62 |
+
|
| 63 |
+
.. code-block:: cmake
|
| 64 |
+
|
| 65 |
+
get_filename_component(<var> <FileName> PROGRAM [PROGRAM_ARGS <arg_var>] [CACHE])
|
| 66 |
+
|
| 67 |
+
The program in ``<FileName>`` will be found in the system search path or
|
| 68 |
+
left as a full path. If ``PROGRAM_ARGS`` is present with ``PROGRAM``, then
|
| 69 |
+
any command-line arguments present in the ``<FileName>`` string are split
|
| 70 |
+
from the program name and stored in ``<arg_var>``. This is used to
|
| 71 |
+
separate a program name from its arguments in a command line string.
|
| 72 |
+
|
| 73 |
+
See Also
|
| 74 |
+
^^^^^^^^
|
| 75 |
+
|
| 76 |
+
* :command:`cmake_path`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_source_file_property.rst
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
get_source_file_property
|
| 2 |
+
------------------------
|
| 3 |
+
|
| 4 |
+
Get a property for a source file.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
get_source_file_property(<variable> <file>
|
| 9 |
+
[DIRECTORY <dir> | TARGET_DIRECTORY <target>]
|
| 10 |
+
<property>)
|
| 11 |
+
|
| 12 |
+
Gets a property from a source file. The value of the property is stored in
|
| 13 |
+
the specified ``<variable>``. If the ``<file>`` is not a source file, or the
|
| 14 |
+
source property is not found, ``<variable>`` will be set to ``NOTFOUND``.
|
| 15 |
+
If the source property was defined to be an ``INHERITED`` property (see
|
| 16 |
+
:command:`define_property`), the search will include the relevant parent
|
| 17 |
+
scopes, as described for the :command:`define_property` command.
|
| 18 |
+
|
| 19 |
+
By default, the source file's property will be read from the current source
|
| 20 |
+
directory's scope.
|
| 21 |
+
|
| 22 |
+
.. versionadded:: 3.18
|
| 23 |
+
Directory scope can be overridden with one of the following sub-options:
|
| 24 |
+
|
| 25 |
+
``DIRECTORY <dir>``
|
| 26 |
+
The source file property will be read from the ``<dir>`` directory's
|
| 27 |
+
scope. CMake must already know about that source directory, either by
|
| 28 |
+
having added it through a call to :command:`add_subdirectory` or ``<dir>``
|
| 29 |
+
being the top level source directory. Relative paths are treated as
|
| 30 |
+
relative to the current source directory.
|
| 31 |
+
|
| 32 |
+
``TARGET_DIRECTORY <target>``
|
| 33 |
+
The source file property will be read from the directory scope in which
|
| 34 |
+
``<target>`` was created (``<target>`` must therefore already exist).
|
| 35 |
+
|
| 36 |
+
Use :command:`set_source_files_properties` to set property values. Source
|
| 37 |
+
file properties usually control how the file is built. One property that is
|
| 38 |
+
always there is :prop_sf:`LOCATION`.
|
| 39 |
+
|
| 40 |
+
.. note::
|
| 41 |
+
|
| 42 |
+
The :prop_sf:`GENERATED` source file property may be globally visible.
|
| 43 |
+
See its documentation for details.
|
| 44 |
+
|
| 45 |
+
See Also
|
| 46 |
+
^^^^^^^^
|
| 47 |
+
|
| 48 |
+
* :command:`define_property`
|
| 49 |
+
* the more general :command:`get_property` command
|
| 50 |
+
* :command:`set_source_files_properties`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/get_test_property.rst
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
get_test_property
|
| 2 |
+
-----------------
|
| 3 |
+
|
| 4 |
+
Get a property of the test.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
get_test_property(<test> <property> [DIRECTORY <dir>] <variable>)
|
| 9 |
+
|
| 10 |
+
Get a property from the test. The value of the property is stored in
|
| 11 |
+
the specified ``<variable>``. If the ``<test>`` is not defined, or the
|
| 12 |
+
test property is not found, ``<variable>`` will be set to ``NOTFOUND``.
|
| 13 |
+
If the test property was defined to be an ``INHERITED`` property (see
|
| 14 |
+
:command:`define_property`), the search will include the relevant parent
|
| 15 |
+
scopes, as described for the :command:`define_property` command.
|
| 16 |
+
|
| 17 |
+
For a list of standard properties you can type
|
| 18 |
+
:option:`cmake --help-property-list`.
|
| 19 |
+
|
| 20 |
+
.. versionadded:: 3.28
|
| 21 |
+
Directory scope can be overridden with the following sub-option:
|
| 22 |
+
|
| 23 |
+
``DIRECTORY <dir>``
|
| 24 |
+
The test property will be read from the ``<dir>`` directory's
|
| 25 |
+
scope. CMake must already know about that source directory, either by
|
| 26 |
+
having added it through a call to :command:`add_subdirectory` or ``<dir>``
|
| 27 |
+
being the top level source directory. Relative paths are treated as
|
| 28 |
+
relative to the current source directory. ``<dir>`` may reference a binary
|
| 29 |
+
directory.
|
| 30 |
+
|
| 31 |
+
See Also
|
| 32 |
+
^^^^^^^^
|
| 33 |
+
|
| 34 |
+
* :command:`define_property`
|
| 35 |
+
* the more general :command:`get_property` command
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/if.rst
ADDED
|
@@ -0,0 +1,505 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
if
|
| 2 |
+
--
|
| 3 |
+
|
| 4 |
+
Conditionally execute a group of commands.
|
| 5 |
+
|
| 6 |
+
Synopsis
|
| 7 |
+
^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. code-block:: cmake
|
| 10 |
+
|
| 11 |
+
if(<condition>)
|
| 12 |
+
<commands>
|
| 13 |
+
elseif(<condition>) # optional block, can be repeated
|
| 14 |
+
<commands>
|
| 15 |
+
else() # optional block
|
| 16 |
+
<commands>
|
| 17 |
+
endif()
|
| 18 |
+
|
| 19 |
+
Evaluates the ``condition`` argument of the ``if`` clause according to the
|
| 20 |
+
`Condition syntax`_ described below. If the result is true, then the
|
| 21 |
+
``commands`` in the ``if`` block are executed.
|
| 22 |
+
Otherwise, optional ``elseif`` blocks are processed in the same way.
|
| 23 |
+
Finally, if no ``condition`` is true, ``commands`` in the optional ``else``
|
| 24 |
+
block are executed.
|
| 25 |
+
|
| 26 |
+
Per legacy, the :command:`else` and :command:`endif` commands admit
|
| 27 |
+
an optional ``<condition>`` argument.
|
| 28 |
+
If used, it must be a verbatim
|
| 29 |
+
repeat of the argument of the opening
|
| 30 |
+
``if`` command.
|
| 31 |
+
|
| 32 |
+
.. _`Condition Syntax`:
|
| 33 |
+
|
| 34 |
+
Condition Syntax
|
| 35 |
+
^^^^^^^^^^^^^^^^
|
| 36 |
+
|
| 37 |
+
The following syntax applies to the ``condition`` argument of
|
| 38 |
+
the ``if``, ``elseif`` and :command:`while` clauses.
|
| 39 |
+
|
| 40 |
+
Compound conditions are evaluated in the following order of precedence:
|
| 41 |
+
|
| 42 |
+
1. `Parentheses`_.
|
| 43 |
+
|
| 44 |
+
2. Unary tests such as `COMMAND`_, `POLICY`_, `TARGET`_, `TEST`_,
|
| 45 |
+
`EXISTS`_, `IS_READABLE`_, `IS_WRITABLE`_, `IS_EXECUTABLE`_,
|
| 46 |
+
`IS_DIRECTORY`_, `IS_SYMLINK`_, `IS_ABSOLUTE`_, and `DEFINED`_.
|
| 47 |
+
|
| 48 |
+
3. Binary tests such as `EQUAL`_, `LESS`_, `LESS_EQUAL`_, `GREATER`_,
|
| 49 |
+
`GREATER_EQUAL`_, `STREQUAL`_, `STRLESS`_, `STRLESS_EQUAL`_,
|
| 50 |
+
`STRGREATER`_, `STRGREATER_EQUAL`_, `VERSION_EQUAL`_, `VERSION_LESS`_,
|
| 51 |
+
`VERSION_LESS_EQUAL`_, `VERSION_GREATER`_, `VERSION_GREATER_EQUAL`_,
|
| 52 |
+
`PATH_EQUAL`_, `IN_LIST`_, `IS_NEWER_THAN`_, and `MATCHES`_.
|
| 53 |
+
|
| 54 |
+
4. Unary logical operator `NOT`_.
|
| 55 |
+
|
| 56 |
+
5. Binary logical operators `AND`_ and `OR`_, from left to right,
|
| 57 |
+
without any short-circuit.
|
| 58 |
+
|
| 59 |
+
Basic Expressions
|
| 60 |
+
"""""""""""""""""
|
| 61 |
+
|
| 62 |
+
.. signature:: if(<constant>)
|
| 63 |
+
:target: constant
|
| 64 |
+
|
| 65 |
+
True if the constant is ``1``, ``ON``, ``YES``, ``TRUE``, ``Y``,
|
| 66 |
+
or a non-zero number (including floating point numbers).
|
| 67 |
+
False if the constant is ``0``, ``OFF``,
|
| 68 |
+
``NO``, ``FALSE``, ``N``, ``IGNORE``, ``NOTFOUND``, the empty string,
|
| 69 |
+
or ends in the suffix ``-NOTFOUND``. Named boolean constants are
|
| 70 |
+
case-insensitive. If the argument is not one of these specific
|
| 71 |
+
constants, it is treated as a variable or string (see `Variable Expansion`_
|
| 72 |
+
further below) and one of the following two forms applies.
|
| 73 |
+
|
| 74 |
+
.. signature:: if(<variable>)
|
| 75 |
+
:target: variable
|
| 76 |
+
|
| 77 |
+
True if given a variable that is defined to a value that is not a false
|
| 78 |
+
constant. False otherwise, including if the variable is undefined.
|
| 79 |
+
Note that macro arguments are not variables.
|
| 80 |
+
:ref:`Environment Variables <CMake Language Environment Variables>` also
|
| 81 |
+
cannot be tested this way, e.g. ``if(ENV{some_var})`` will always evaluate
|
| 82 |
+
to false.
|
| 83 |
+
|
| 84 |
+
.. signature:: if(<string>)
|
| 85 |
+
:target: string
|
| 86 |
+
|
| 87 |
+
A quoted string always evaluates to false unless:
|
| 88 |
+
|
| 89 |
+
* The string's value is one of the true constants, or
|
| 90 |
+
* Policy :policy:`CMP0054` is not set to ``NEW`` and the string's value
|
| 91 |
+
happens to be a variable name that is affected by :policy:`CMP0054`'s
|
| 92 |
+
behavior.
|
| 93 |
+
|
| 94 |
+
Logic Operators
|
| 95 |
+
"""""""""""""""
|
| 96 |
+
|
| 97 |
+
.. signature:: if(NOT <condition>)
|
| 98 |
+
|
| 99 |
+
True if the condition is not true.
|
| 100 |
+
|
| 101 |
+
.. signature:: if(<cond1> AND <cond2>)
|
| 102 |
+
:target: AND
|
| 103 |
+
|
| 104 |
+
True if both conditions would be considered true individually.
|
| 105 |
+
|
| 106 |
+
.. signature:: if(<cond1> OR <cond2>)
|
| 107 |
+
:target: OR
|
| 108 |
+
|
| 109 |
+
True if either condition would be considered true individually.
|
| 110 |
+
|
| 111 |
+
.. signature:: if((condition) AND (condition OR (condition)))
|
| 112 |
+
:target: parentheses
|
| 113 |
+
|
| 114 |
+
The conditions inside the parenthesis are evaluated first and then
|
| 115 |
+
the remaining condition is evaluated as in the other examples.
|
| 116 |
+
Where there are nested parenthesis the innermost are evaluated as part
|
| 117 |
+
of evaluating the condition that contains them.
|
| 118 |
+
|
| 119 |
+
Existence Checks
|
| 120 |
+
""""""""""""""""
|
| 121 |
+
|
| 122 |
+
.. signature:: if(COMMAND <command-name>)
|
| 123 |
+
|
| 124 |
+
True if the given name is a command, macro or function that can be
|
| 125 |
+
invoked.
|
| 126 |
+
|
| 127 |
+
.. signature:: if(POLICY <policy-id>)
|
| 128 |
+
|
| 129 |
+
True if the given name is an existing policy (of the form ``CMP<NNNN>``).
|
| 130 |
+
|
| 131 |
+
.. signature:: if(TARGET <target-name>)
|
| 132 |
+
|
| 133 |
+
True if the given name is an existing logical target name created
|
| 134 |
+
by a call to the :command:`add_executable`, :command:`add_library`,
|
| 135 |
+
or :command:`add_custom_target` command that has already been invoked
|
| 136 |
+
(in any directory).
|
| 137 |
+
|
| 138 |
+
.. signature:: if(TEST <test-name>)
|
| 139 |
+
|
| 140 |
+
.. versionadded:: 3.3
|
| 141 |
+
|
| 142 |
+
True if the given name is an existing test name created by the
|
| 143 |
+
:command:`add_test` command.
|
| 144 |
+
|
| 145 |
+
.. signature:: if(DEFINED <name>|CACHE{<name>}|ENV{<name>})
|
| 146 |
+
|
| 147 |
+
True if a variable, cache variable or environment variable
|
| 148 |
+
with given ``<name>`` is defined. The value of the variable
|
| 149 |
+
does not matter. Note the following caveats:
|
| 150 |
+
|
| 151 |
+
* Macro arguments are not variables.
|
| 152 |
+
* It is not possible to test directly whether a `<name>` is a non-cache
|
| 153 |
+
variable. The expression ``if(DEFINED someName)`` will evaluate to true
|
| 154 |
+
if either a cache or non-cache variable ``someName`` exists. In
|
| 155 |
+
comparison, the expression ``if(DEFINED CACHE{someName})`` will only
|
| 156 |
+
evaluate to true if a cache variable ``someName`` exists. Both expressions
|
| 157 |
+
need to be tested if you need to know whether a non-cache variable exists:
|
| 158 |
+
``if(DEFINED someName AND NOT DEFINED CACHE{someName})``.
|
| 159 |
+
|
| 160 |
+
.. versionadded:: 3.14
|
| 161 |
+
Added support for ``CACHE{<name>}`` variables.
|
| 162 |
+
|
| 163 |
+
.. signature:: if(<variable|string> IN_LIST <variable>)
|
| 164 |
+
:target: IN_LIST
|
| 165 |
+
|
| 166 |
+
.. versionadded:: 3.3
|
| 167 |
+
|
| 168 |
+
True if the given element is contained in the named list variable.
|
| 169 |
+
|
| 170 |
+
File Operations
|
| 171 |
+
"""""""""""""""
|
| 172 |
+
|
| 173 |
+
.. signature:: if(EXISTS <path-to-file-or-directory>)
|
| 174 |
+
|
| 175 |
+
True if the named file or directory exists and is readable. Behavior
|
| 176 |
+
is well-defined only for explicit full paths (a leading ``~/`` is not
|
| 177 |
+
expanded as a home directory and is considered a relative path).
|
| 178 |
+
Resolves symbolic links, i.e. if the named file or directory is a
|
| 179 |
+
symbolic link, returns true if the target of the symbolic link exists.
|
| 180 |
+
|
| 181 |
+
False if the given path is an empty string.
|
| 182 |
+
|
| 183 |
+
.. note::
|
| 184 |
+
Prefer ``if(IS_READABLE)`` to check file readability. ``if(EXISTS)``
|
| 185 |
+
may be changed in the future to only check file existence.
|
| 186 |
+
|
| 187 |
+
.. signature:: if(IS_READABLE <path-to-file-or-directory>)
|
| 188 |
+
|
| 189 |
+
.. versionadded:: 3.29
|
| 190 |
+
|
| 191 |
+
True if the named file or directory is readable. Behavior
|
| 192 |
+
is well-defined only for explicit full paths (a leading ``~/`` is not
|
| 193 |
+
expanded as a home directory and is considered a relative path).
|
| 194 |
+
Resolves symbolic links, i.e. if the named file or directory is a
|
| 195 |
+
symbolic link, returns true if the target of the symbolic link is readable.
|
| 196 |
+
|
| 197 |
+
False if the given path is an empty string.
|
| 198 |
+
|
| 199 |
+
.. signature:: if(IS_WRITABLE <path-to-file-or-directory>)
|
| 200 |
+
|
| 201 |
+
.. versionadded:: 3.29
|
| 202 |
+
|
| 203 |
+
True if the named file or directory is writable. Behavior
|
| 204 |
+
is well-defined only for explicit full paths (a leading ``~/`` is not
|
| 205 |
+
expanded as a home directory and is considered a relative path).
|
| 206 |
+
Resolves symbolic links, i.e. if the named file or directory is a
|
| 207 |
+
symbolic link, returns true if the target of the symbolic link is writable.
|
| 208 |
+
|
| 209 |
+
False if the given path is an empty string.
|
| 210 |
+
|
| 211 |
+
.. signature:: if(IS_EXECUTABLE <path-to-file-or-directory>)
|
| 212 |
+
|
| 213 |
+
.. versionadded:: 3.29
|
| 214 |
+
|
| 215 |
+
True if the named file or directory is executable. Behavior
|
| 216 |
+
is well-defined only for explicit full paths (a leading ``~/`` is not
|
| 217 |
+
expanded as a home directory and is considered a relative path).
|
| 218 |
+
Resolves symbolic links, i.e. if the named file or directory is a
|
| 219 |
+
symbolic link, returns true if the target of the symbolic link is executable.
|
| 220 |
+
|
| 221 |
+
False if the given path is an empty string.
|
| 222 |
+
|
| 223 |
+
.. signature:: if(<file1> IS_NEWER_THAN <file2>)
|
| 224 |
+
:target: IS_NEWER_THAN
|
| 225 |
+
|
| 226 |
+
True if ``file1`` is newer than ``file2`` or if one of the two files doesn't
|
| 227 |
+
exist. Behavior is well-defined only for full paths. If the file
|
| 228 |
+
time stamps are exactly the same, an ``IS_NEWER_THAN`` comparison returns
|
| 229 |
+
true, so that any dependent build operations will occur in the event
|
| 230 |
+
of a tie. This includes the case of passing the same file name for
|
| 231 |
+
both file1 and file2.
|
| 232 |
+
|
| 233 |
+
.. signature:: if(IS_DIRECTORY <path>)
|
| 234 |
+
|
| 235 |
+
True if ``path`` is a directory. Behavior is well-defined only
|
| 236 |
+
for full paths.
|
| 237 |
+
|
| 238 |
+
False if the given path is an empty string.
|
| 239 |
+
|
| 240 |
+
.. signature:: if(IS_SYMLINK <path>)
|
| 241 |
+
|
| 242 |
+
True if the given path is a symbolic link. Behavior is well-defined
|
| 243 |
+
only for full paths.
|
| 244 |
+
|
| 245 |
+
.. signature:: if(IS_ABSOLUTE <path>)
|
| 246 |
+
|
| 247 |
+
True if the given path is an absolute path. Note the following special
|
| 248 |
+
cases:
|
| 249 |
+
|
| 250 |
+
* An empty ``path`` evaluates to false.
|
| 251 |
+
* On Windows hosts, any ``path`` that begins with a drive letter and colon
|
| 252 |
+
(e.g. ``C:``), a forward slash or a backslash will evaluate to true.
|
| 253 |
+
This means a path like ``C:no\base\dir`` will evaluate to true, even
|
| 254 |
+
though the non-drive part of the path is relative.
|
| 255 |
+
* On non-Windows hosts, any ``path`` that begins with a tilde (``~``)
|
| 256 |
+
evaluates to true.
|
| 257 |
+
|
| 258 |
+
Comparisons
|
| 259 |
+
"""""""""""
|
| 260 |
+
|
| 261 |
+
.. signature:: if(<variable|string> MATCHES <regex>)
|
| 262 |
+
:target: MATCHES
|
| 263 |
+
|
| 264 |
+
True if the given string or variable's value matches the given regular
|
| 265 |
+
expression. See :ref:`Regex Specification` for regex format.
|
| 266 |
+
|
| 267 |
+
.. versionadded:: 3.9
|
| 268 |
+
``()`` groups are captured in :variable:`CMAKE_MATCH_<n>` variables.
|
| 269 |
+
|
| 270 |
+
.. signature:: if(<variable|string> LESS <variable|string>)
|
| 271 |
+
:target: LESS
|
| 272 |
+
|
| 273 |
+
True if the given string or variable's value parses as a real number
|
| 274 |
+
(like a C ``double``) and less than that on the right.
|
| 275 |
+
|
| 276 |
+
.. signature:: if(<variable|string> GREATER <variable|string>)
|
| 277 |
+
:target: GREATER
|
| 278 |
+
|
| 279 |
+
True if the given string or variable's value parses as a real number
|
| 280 |
+
(like a C ``double``) and greater than that on the right.
|
| 281 |
+
|
| 282 |
+
.. signature:: if(<variable|string> EQUAL <variable|string>)
|
| 283 |
+
:target: EQUAL
|
| 284 |
+
|
| 285 |
+
True if the given string or variable's value parses as a real number
|
| 286 |
+
(like a C ``double``) and equal to that on the right.
|
| 287 |
+
|
| 288 |
+
.. signature:: if(<variable|string> LESS_EQUAL <variable|string>)
|
| 289 |
+
:target: LESS_EQUAL
|
| 290 |
+
|
| 291 |
+
.. versionadded:: 3.7
|
| 292 |
+
|
| 293 |
+
True if the given string or variable's value parses as a real number
|
| 294 |
+
(like a C ``double``) and less than or equal to that on the right.
|
| 295 |
+
|
| 296 |
+
.. signature:: if(<variable|string> GREATER_EQUAL <variable|string>)
|
| 297 |
+
:target: GREATER_EQUAL
|
| 298 |
+
|
| 299 |
+
.. versionadded:: 3.7
|
| 300 |
+
|
| 301 |
+
True if the given string or variable's value parses as a real number
|
| 302 |
+
(like a C ``double``) and greater than or equal to that on the right.
|
| 303 |
+
|
| 304 |
+
.. signature:: if(<variable|string> STRLESS <variable|string>)
|
| 305 |
+
:target: STRLESS
|
| 306 |
+
|
| 307 |
+
True if the given string or variable's value is lexicographically less
|
| 308 |
+
than the string or variable on the right.
|
| 309 |
+
|
| 310 |
+
.. signature:: if(<variable|string> STRGREATER <variable|string>)
|
| 311 |
+
:target: STRGREATER
|
| 312 |
+
|
| 313 |
+
True if the given string or variable's value is lexicographically greater
|
| 314 |
+
than the string or variable on the right.
|
| 315 |
+
|
| 316 |
+
.. signature:: if(<variable|string> STREQUAL <variable|string>)
|
| 317 |
+
:target: STREQUAL
|
| 318 |
+
|
| 319 |
+
True if the given string or variable's value is lexicographically equal
|
| 320 |
+
to the string or variable on the right.
|
| 321 |
+
|
| 322 |
+
.. signature:: if(<variable|string> STRLESS_EQUAL <variable|string>)
|
| 323 |
+
:target: STRLESS_EQUAL
|
| 324 |
+
|
| 325 |
+
.. versionadded:: 3.7
|
| 326 |
+
|
| 327 |
+
True if the given string or variable's value is lexicographically less
|
| 328 |
+
than or equal to the string or variable on the right.
|
| 329 |
+
|
| 330 |
+
.. signature:: if(<variable|string> STRGREATER_EQUAL <variable|string>)
|
| 331 |
+
:target: STRGREATER_EQUAL
|
| 332 |
+
|
| 333 |
+
.. versionadded:: 3.7
|
| 334 |
+
|
| 335 |
+
True if the given string or variable's value is lexicographically greater
|
| 336 |
+
than or equal to the string or variable on the right.
|
| 337 |
+
|
| 338 |
+
Version Comparisons
|
| 339 |
+
"""""""""""""""""""
|
| 340 |
+
|
| 341 |
+
.. signature:: if(<variable|string> VERSION_LESS <variable|string>)
|
| 342 |
+
:target: VERSION_LESS
|
| 343 |
+
|
| 344 |
+
Component-wise integer version number comparison (version format is
|
| 345 |
+
``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero).
|
| 346 |
+
Any non-integer version component or non-integer trailing part of a version
|
| 347 |
+
component effectively truncates the string at that point.
|
| 348 |
+
|
| 349 |
+
.. signature:: if(<variable|string> VERSION_GREATER <variable|string>)
|
| 350 |
+
:target: VERSION_GREATER
|
| 351 |
+
|
| 352 |
+
Component-wise integer version number comparison (version format is
|
| 353 |
+
``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero).
|
| 354 |
+
Any non-integer version component or non-integer trailing part of a version
|
| 355 |
+
component effectively truncates the string at that point.
|
| 356 |
+
|
| 357 |
+
.. signature:: if(<variable|string> VERSION_EQUAL <variable|string>)
|
| 358 |
+
:target: VERSION_EQUAL
|
| 359 |
+
|
| 360 |
+
Component-wise integer version number comparison (version format is
|
| 361 |
+
``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero).
|
| 362 |
+
Any non-integer version component or non-integer trailing part of a version
|
| 363 |
+
component effectively truncates the string at that point.
|
| 364 |
+
|
| 365 |
+
.. signature:: if(<variable|string> VERSION_LESS_EQUAL <variable|string>)
|
| 366 |
+
:target: VERSION_LESS_EQUAL
|
| 367 |
+
|
| 368 |
+
.. versionadded:: 3.7
|
| 369 |
+
|
| 370 |
+
Component-wise integer version number comparison (version format is
|
| 371 |
+
``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero).
|
| 372 |
+
Any non-integer version component or non-integer trailing part of a version
|
| 373 |
+
component effectively truncates the string at that point.
|
| 374 |
+
|
| 375 |
+
.. signature:: if(<variable|string> VERSION_GREATER_EQUAL <variable|string>)
|
| 376 |
+
:target: VERSION_GREATER_EQUAL
|
| 377 |
+
|
| 378 |
+
.. versionadded:: 3.7
|
| 379 |
+
|
| 380 |
+
Component-wise integer version number comparison (version format is
|
| 381 |
+
``major[.minor[.patch[.tweak]]]``, omitted components are treated as zero).
|
| 382 |
+
Any non-integer version component or non-integer trailing part of a version
|
| 383 |
+
component effectively truncates the string at that point.
|
| 384 |
+
|
| 385 |
+
Path Comparisons
|
| 386 |
+
""""""""""""""""
|
| 387 |
+
|
| 388 |
+
.. signature:: if(<variable|string> PATH_EQUAL <variable|string>)
|
| 389 |
+
:target: PATH_EQUAL
|
| 390 |
+
|
| 391 |
+
.. versionadded:: 3.24
|
| 392 |
+
|
| 393 |
+
Compares the two paths component-by-component. Only if every component of
|
| 394 |
+
both paths match will the two paths compare equal. Multiple path separators
|
| 395 |
+
are effectively collapsed into a single separator, but note that backslashes
|
| 396 |
+
are not converted to forward slashes. No other
|
| 397 |
+
:ref:`path normalization <Normalization>` is performed.
|
| 398 |
+
|
| 399 |
+
Component-wise comparison is superior to string-based comparison due to the
|
| 400 |
+
handling of multiple path separators. In the following example, the
|
| 401 |
+
expression evaluates to true using ``PATH_EQUAL``, but false with
|
| 402 |
+
``STREQUAL``:
|
| 403 |
+
|
| 404 |
+
.. code-block:: cmake
|
| 405 |
+
|
| 406 |
+
# comparison is TRUE
|
| 407 |
+
if ("/a//b/c" PATH_EQUAL "/a/b/c")
|
| 408 |
+
...
|
| 409 |
+
endif()
|
| 410 |
+
|
| 411 |
+
# comparison is FALSE
|
| 412 |
+
if ("/a//b/c" STREQUAL "/a/b/c")
|
| 413 |
+
...
|
| 414 |
+
endif()
|
| 415 |
+
|
| 416 |
+
See :ref:`cmake_path(COMPARE) <Path COMPARE>` for more details.
|
| 417 |
+
|
| 418 |
+
Variable Expansion
|
| 419 |
+
^^^^^^^^^^^^^^^^^^
|
| 420 |
+
|
| 421 |
+
The if command was written very early in CMake's history, predating
|
| 422 |
+
the ``${}`` variable evaluation syntax, and for convenience evaluates
|
| 423 |
+
variables named by its arguments as shown in the above signatures.
|
| 424 |
+
Note that normal variable evaluation with ``${}`` applies before the if
|
| 425 |
+
command even receives the arguments. Therefore code like
|
| 426 |
+
|
| 427 |
+
.. code-block:: cmake
|
| 428 |
+
|
| 429 |
+
set(var1 OFF)
|
| 430 |
+
set(var2 "var1")
|
| 431 |
+
if(${var2})
|
| 432 |
+
|
| 433 |
+
appears to the if command as
|
| 434 |
+
|
| 435 |
+
.. code-block:: cmake
|
| 436 |
+
|
| 437 |
+
if(var1)
|
| 438 |
+
|
| 439 |
+
and is evaluated according to the ``if(<variable>)`` case documented
|
| 440 |
+
above. The result is ``OFF`` which is false. However, if we remove the
|
| 441 |
+
``${}`` from the example then the command sees
|
| 442 |
+
|
| 443 |
+
.. code-block:: cmake
|
| 444 |
+
|
| 445 |
+
if(var2)
|
| 446 |
+
|
| 447 |
+
which is true because ``var2`` is defined to ``var1`` which is not a false
|
| 448 |
+
constant.
|
| 449 |
+
|
| 450 |
+
Automatic evaluation applies in the other cases whenever the
|
| 451 |
+
above-documented condition syntax accepts ``<variable|string>``:
|
| 452 |
+
|
| 453 |
+
* The left hand argument to `MATCHES`_ is first checked to see if it is
|
| 454 |
+
a defined variable. If so, the variable's value is used, otherwise the
|
| 455 |
+
original value is used.
|
| 456 |
+
|
| 457 |
+
* If the left hand argument to `MATCHES`_ is missing it returns false
|
| 458 |
+
without error
|
| 459 |
+
|
| 460 |
+
* Both left and right hand arguments to `LESS`_, `GREATER`_, `EQUAL`_,
|
| 461 |
+
`LESS_EQUAL`_, and `GREATER_EQUAL`_, are independently tested to see if
|
| 462 |
+
they are defined variables. If so, their defined values are used otherwise
|
| 463 |
+
the original value is used.
|
| 464 |
+
|
| 465 |
+
* Both left and right hand arguments to `STRLESS`_, `STRGREATER`_,
|
| 466 |
+
`STREQUAL`_, `STRLESS_EQUAL`_, and `STRGREATER_EQUAL`_ are independently
|
| 467 |
+
tested to see if they are defined variables. If so, their defined values are
|
| 468 |
+
used otherwise the original value is used.
|
| 469 |
+
|
| 470 |
+
* Both left and right hand arguments to `VERSION_LESS`_,
|
| 471 |
+
`VERSION_GREATER`_, `VERSION_EQUAL`_, `VERSION_LESS_EQUAL`_, and
|
| 472 |
+
`VERSION_GREATER_EQUAL`_ are independently tested to see if they are defined
|
| 473 |
+
variables. If so, their defined values are used otherwise the original value
|
| 474 |
+
is used.
|
| 475 |
+
|
| 476 |
+
* The left hand argument to `IN_LIST`_ is tested to see if it is a defined
|
| 477 |
+
variable. If so, the variable's value is used, otherwise the original
|
| 478 |
+
value is used.
|
| 479 |
+
|
| 480 |
+
* The right hand argument to `NOT`_ is tested to see if it is a boolean
|
| 481 |
+
constant. If so, the value is used, otherwise it is assumed to be a
|
| 482 |
+
variable and it is dereferenced.
|
| 483 |
+
|
| 484 |
+
* The left and right hand arguments to `AND`_ and `OR`_ are independently
|
| 485 |
+
tested to see if they are boolean constants. If so, they are used as
|
| 486 |
+
such, otherwise they are assumed to be variables and are dereferenced.
|
| 487 |
+
|
| 488 |
+
.. versionchanged:: 3.1
|
| 489 |
+
To prevent ambiguity, potential variable or keyword names can be
|
| 490 |
+
specified in a :ref:`Quoted Argument` or a :ref:`Bracket Argument`.
|
| 491 |
+
A quoted or bracketed variable or keyword will be interpreted as a
|
| 492 |
+
string and not dereferenced or interpreted.
|
| 493 |
+
See policy :policy:`CMP0054`.
|
| 494 |
+
|
| 495 |
+
There is no automatic evaluation for environment or cache
|
| 496 |
+
:ref:`Variable References`. Their values must be referenced as
|
| 497 |
+
``$ENV{<name>}`` or ``$CACHE{<name>}`` wherever the above-documented
|
| 498 |
+
condition syntax accepts ``<variable|string>``.
|
| 499 |
+
|
| 500 |
+
See also
|
| 501 |
+
^^^^^^^^
|
| 502 |
+
|
| 503 |
+
* :command:`else`
|
| 504 |
+
* :command:`elseif`
|
| 505 |
+
* :command:`endif`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/include_directories.rst
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
include_directories
|
| 2 |
+
-------------------
|
| 3 |
+
|
| 4 |
+
Add include directories to the build.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
|
| 9 |
+
|
| 10 |
+
Add the given directories to those the compiler uses to search for
|
| 11 |
+
include files. Relative paths are interpreted as relative to the
|
| 12 |
+
current source directory.
|
| 13 |
+
|
| 14 |
+
The include directories are added to the :prop_dir:`INCLUDE_DIRECTORIES`
|
| 15 |
+
directory property for the current ``CMakeLists`` file. They are also
|
| 16 |
+
added to the :prop_tgt:`INCLUDE_DIRECTORIES` target property for each
|
| 17 |
+
target in the current ``CMakeLists`` file. The target property values
|
| 18 |
+
are the ones used by the generators.
|
| 19 |
+
|
| 20 |
+
By default the directories specified are appended onto the current list of
|
| 21 |
+
directories. This default behavior can be changed by setting
|
| 22 |
+
:variable:`CMAKE_INCLUDE_DIRECTORIES_BEFORE` to ``ON``. By using
|
| 23 |
+
``AFTER`` or ``BEFORE`` explicitly, you can select between appending and
|
| 24 |
+
prepending, independent of the default.
|
| 25 |
+
|
| 26 |
+
If the ``SYSTEM`` option is given, the compiler will be told the
|
| 27 |
+
directories are meant as system include directories on some platforms.
|
| 28 |
+
Signaling this setting might achieve effects such as the compiler
|
| 29 |
+
skipping warnings, or these fixed-install system files not being
|
| 30 |
+
considered in dependency calculations - see compiler docs.
|
| 31 |
+
|
| 32 |
+
.. |command_name| replace:: ``include_directories``
|
| 33 |
+
.. include:: GENEX_NOTE.txt
|
| 34 |
+
|
| 35 |
+
.. note::
|
| 36 |
+
|
| 37 |
+
Prefer the :command:`target_include_directories` command to add include
|
| 38 |
+
directories to individual targets and optionally propagate/export them
|
| 39 |
+
to dependents.
|
| 40 |
+
|
| 41 |
+
See Also
|
| 42 |
+
^^^^^^^^
|
| 43 |
+
|
| 44 |
+
* :command:`target_include_directories`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/install_files.rst
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
install_files
|
| 2 |
+
-------------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.0
|
| 5 |
+
|
| 6 |
+
Use the :command:`install(FILES)` command instead.
|
| 7 |
+
|
| 8 |
+
This command has been superseded by the :command:`install` command. It is
|
| 9 |
+
provided for compatibility with older CMake code. The ``FILES`` form is
|
| 10 |
+
directly replaced by the ``FILES`` form of the :command:`install`
|
| 11 |
+
command. The regexp form can be expressed more clearly using the ``GLOB``
|
| 12 |
+
form of the :command:`file` command.
|
| 13 |
+
|
| 14 |
+
.. code-block:: cmake
|
| 15 |
+
|
| 16 |
+
install_files(<dir> extension file file ...)
|
| 17 |
+
|
| 18 |
+
Create rules to install the listed files with the given extension into
|
| 19 |
+
the given directory. Only files existing in the current source tree
|
| 20 |
+
or its corresponding location in the binary tree may be listed. If a
|
| 21 |
+
file specified already has an extension, that extension will be
|
| 22 |
+
removed first. This is useful for providing lists of source files
|
| 23 |
+
such as foo.cxx when you want the corresponding foo.h to be installed.
|
| 24 |
+
A typical extension is ``.h``.
|
| 25 |
+
|
| 26 |
+
.. code-block:: cmake
|
| 27 |
+
|
| 28 |
+
install_files(<dir> regexp)
|
| 29 |
+
|
| 30 |
+
Any files in the current source directory that match the regular
|
| 31 |
+
expression will be installed.
|
| 32 |
+
|
| 33 |
+
.. code-block:: cmake
|
| 34 |
+
|
| 35 |
+
install_files(<dir> FILES file file ...)
|
| 36 |
+
|
| 37 |
+
Any files listed after the ``FILES`` keyword will be installed explicitly
|
| 38 |
+
from the names given. Full paths are allowed in this form.
|
| 39 |
+
|
| 40 |
+
The directory ``<dir>`` is relative to the installation prefix, which is
|
| 41 |
+
stored in the variable :variable:`CMAKE_INSTALL_PREFIX`.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/load_command.rst
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
load_command
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Disallowed since version 3.0. See CMake Policy :policy:`CMP0031`.
|
| 5 |
+
|
| 6 |
+
Load a command into a running CMake.
|
| 7 |
+
|
| 8 |
+
.. code-block:: cmake
|
| 9 |
+
|
| 10 |
+
load_command(COMMAND_NAME <loc1> [loc2 ...])
|
| 11 |
+
|
| 12 |
+
The given locations are searched for a library whose name is
|
| 13 |
+
cmCOMMAND_NAME. If found, it is loaded as a module and the command is
|
| 14 |
+
added to the set of available CMake commands. Usually,
|
| 15 |
+
:command:`try_compile` is used before this command to compile the
|
| 16 |
+
module. If the command is successfully loaded a variable named
|
| 17 |
+
|
| 18 |
+
.. code-block:: cmake
|
| 19 |
+
|
| 20 |
+
CMAKE_LOADED_COMMAND_<COMMAND_NAME>
|
| 21 |
+
|
| 22 |
+
will be set to the full path of the module that was loaded. Otherwise
|
| 23 |
+
the variable will not be set.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/macro.rst
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
macro
|
| 2 |
+
-----
|
| 3 |
+
|
| 4 |
+
Start recording a macro for later invocation as a command
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
macro(<name> [<arg1> ...])
|
| 9 |
+
<commands>
|
| 10 |
+
endmacro()
|
| 11 |
+
|
| 12 |
+
Defines a macro named ``<name>`` that takes arguments named
|
| 13 |
+
``<arg1>``, ... Commands listed after macro, but before the
|
| 14 |
+
matching :command:`endmacro()`, are not executed until the macro
|
| 15 |
+
is invoked.
|
| 16 |
+
|
| 17 |
+
Per legacy, the :command:`endmacro` command admits an optional
|
| 18 |
+
``<name>`` argument. If used, it must be a verbatim repeat of the
|
| 19 |
+
argument of the opening ``macro`` command.
|
| 20 |
+
|
| 21 |
+
See the :command:`cmake_policy()` command documentation for the behavior
|
| 22 |
+
of policies inside macros.
|
| 23 |
+
|
| 24 |
+
See the :ref:`Macro vs Function` section below for differences
|
| 25 |
+
between CMake macros and :command:`functions <function>`.
|
| 26 |
+
|
| 27 |
+
Invocation
|
| 28 |
+
^^^^^^^^^^
|
| 29 |
+
|
| 30 |
+
The macro invocation is case-insensitive. A macro defined as
|
| 31 |
+
|
| 32 |
+
.. code-block:: cmake
|
| 33 |
+
|
| 34 |
+
macro(foo)
|
| 35 |
+
<commands>
|
| 36 |
+
endmacro()
|
| 37 |
+
|
| 38 |
+
can be invoked through any of
|
| 39 |
+
|
| 40 |
+
.. code-block:: cmake
|
| 41 |
+
|
| 42 |
+
foo()
|
| 43 |
+
Foo()
|
| 44 |
+
FOO()
|
| 45 |
+
cmake_language(CALL foo)
|
| 46 |
+
|
| 47 |
+
and so on. However, it is strongly recommended to stay with the
|
| 48 |
+
case chosen in the macro definition. Typically macros use
|
| 49 |
+
all-lowercase names.
|
| 50 |
+
|
| 51 |
+
.. versionadded:: 3.18
|
| 52 |
+
The :command:`cmake_language(CALL ...)` command can also be used to
|
| 53 |
+
invoke the macro.
|
| 54 |
+
|
| 55 |
+
Arguments
|
| 56 |
+
^^^^^^^^^
|
| 57 |
+
|
| 58 |
+
When a macro is invoked, the commands recorded in the macro are
|
| 59 |
+
first modified by replacing formal parameters (``${arg1}``, ...)
|
| 60 |
+
with the arguments passed, and then invoked as normal commands.
|
| 61 |
+
|
| 62 |
+
In addition to referencing the formal parameters you can reference the
|
| 63 |
+
values ``${ARGC}`` which will be set to the number of arguments passed
|
| 64 |
+
into the macro as well as ``${ARGV0}``, ``${ARGV1}``, ``${ARGV2}``,
|
| 65 |
+
... which will have the actual values of the arguments passed in.
|
| 66 |
+
This facilitates creating macros with optional arguments.
|
| 67 |
+
|
| 68 |
+
Furthermore, ``${ARGV}`` holds the list of all arguments given to the
|
| 69 |
+
macro and ``${ARGN}`` holds the list of arguments past the last expected
|
| 70 |
+
argument.
|
| 71 |
+
Referencing to ``${ARGV#}`` arguments beyond ``${ARGC}`` have undefined
|
| 72 |
+
behavior. Checking that ``${ARGC}`` is greater than ``#`` is the only
|
| 73 |
+
way to ensure that ``${ARGV#}`` was passed to the function as an extra
|
| 74 |
+
argument.
|
| 75 |
+
|
| 76 |
+
.. _`Macro vs Function`:
|
| 77 |
+
|
| 78 |
+
Macro vs Function
|
| 79 |
+
^^^^^^^^^^^^^^^^^
|
| 80 |
+
|
| 81 |
+
The ``macro`` command is very similar to the :command:`function` command.
|
| 82 |
+
Nonetheless, there are a few important differences.
|
| 83 |
+
|
| 84 |
+
In a function, ``ARGN``, ``ARGC``, ``ARGV`` and ``ARGV0``, ``ARGV1``, ...
|
| 85 |
+
are true variables in the usual CMake sense. In a macro, they are not,
|
| 86 |
+
they are string replacements much like the C preprocessor would do
|
| 87 |
+
with a macro. This has a number of consequences, as explained in
|
| 88 |
+
the :ref:`Argument Caveats` section below.
|
| 89 |
+
|
| 90 |
+
Another difference between macros and functions is the control flow.
|
| 91 |
+
A function is executed by transferring control from the calling
|
| 92 |
+
statement to the function body. A macro is executed as if the macro
|
| 93 |
+
body were pasted in place of the calling statement. This has the
|
| 94 |
+
consequence that a :command:`return()` in a macro body does not
|
| 95 |
+
just terminate execution of the macro; rather, control is returned
|
| 96 |
+
from the scope of the macro call. To avoid confusion, it is recommended
|
| 97 |
+
to avoid :command:`return()` in macros altogether.
|
| 98 |
+
|
| 99 |
+
Unlike a function, the :variable:`CMAKE_CURRENT_FUNCTION`,
|
| 100 |
+
:variable:`CMAKE_CURRENT_FUNCTION_LIST_DIR`,
|
| 101 |
+
:variable:`CMAKE_CURRENT_FUNCTION_LIST_FILE`,
|
| 102 |
+
:variable:`CMAKE_CURRENT_FUNCTION_LIST_LINE` variables are not
|
| 103 |
+
set for a macro.
|
| 104 |
+
|
| 105 |
+
.. _`Argument Caveats`:
|
| 106 |
+
|
| 107 |
+
Argument Caveats
|
| 108 |
+
^^^^^^^^^^^^^^^^
|
| 109 |
+
|
| 110 |
+
Since ``ARGN``, ``ARGC``, ``ARGV``, ``ARGV0`` etc. are not variables,
|
| 111 |
+
you will NOT be able to use commands like
|
| 112 |
+
|
| 113 |
+
.. code-block:: cmake
|
| 114 |
+
|
| 115 |
+
if(ARGV1) # ARGV1 is not a variable
|
| 116 |
+
if(DEFINED ARGV2) # ARGV2 is not a variable
|
| 117 |
+
if(ARGC GREATER 2) # ARGC is not a variable
|
| 118 |
+
foreach(loop_var IN LISTS ARGN) # ARGN is not a variable
|
| 119 |
+
|
| 120 |
+
In the first case, you can use ``if(${ARGV1})``. In the second and
|
| 121 |
+
third case, the proper way to check if an optional variable was
|
| 122 |
+
passed to the macro is to use ``if(${ARGC} GREATER 2)``. In the
|
| 123 |
+
last case, you can use ``foreach(loop_var ${ARGN})`` but this will
|
| 124 |
+
skip empty arguments. If you need to include them, you can use
|
| 125 |
+
|
| 126 |
+
.. code-block:: cmake
|
| 127 |
+
|
| 128 |
+
set(list_var "${ARGN}")
|
| 129 |
+
foreach(loop_var IN LISTS list_var)
|
| 130 |
+
|
| 131 |
+
Note that if you have a variable with the same name in the scope from
|
| 132 |
+
which the macro is called, using unreferenced names will use the
|
| 133 |
+
existing variable instead of the arguments. For example:
|
| 134 |
+
|
| 135 |
+
.. code-block:: cmake
|
| 136 |
+
|
| 137 |
+
macro(bar)
|
| 138 |
+
foreach(arg IN LISTS ARGN)
|
| 139 |
+
<commands>
|
| 140 |
+
endforeach()
|
| 141 |
+
endmacro()
|
| 142 |
+
|
| 143 |
+
function(foo)
|
| 144 |
+
bar(x y z)
|
| 145 |
+
endfunction()
|
| 146 |
+
|
| 147 |
+
foo(a b c)
|
| 148 |
+
|
| 149 |
+
Will loop over ``a;b;c`` and not over ``x;y;z`` as one might have expected.
|
| 150 |
+
If you want true CMake variables and/or better CMake scope control you
|
| 151 |
+
should look at the function command.
|
| 152 |
+
|
| 153 |
+
See Also
|
| 154 |
+
^^^^^^^^
|
| 155 |
+
|
| 156 |
+
* :command:`cmake_parse_arguments`
|
| 157 |
+
* :command:`endmacro`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/make_directory.rst
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
make_directory
|
| 2 |
+
--------------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.0
|
| 5 |
+
|
| 6 |
+
Use the :command:`file(MAKE_DIRECTORY)` command instead.
|
| 7 |
+
|
| 8 |
+
.. code-block:: cmake
|
| 9 |
+
|
| 10 |
+
make_directory(directory)
|
| 11 |
+
|
| 12 |
+
Creates the specified directory. Full paths should be given. Any
|
| 13 |
+
parent directories that do not exist will also be created. Use with
|
| 14 |
+
care.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/mark_as_advanced.rst
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
mark_as_advanced
|
| 2 |
+
----------------
|
| 3 |
+
|
| 4 |
+
Mark cmake cached variables as advanced.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
mark_as_advanced([CLEAR|FORCE] <var1> ...)
|
| 9 |
+
|
| 10 |
+
Sets the advanced/non-advanced state of the named
|
| 11 |
+
cached variables.
|
| 12 |
+
|
| 13 |
+
An advanced variable will not be displayed in any
|
| 14 |
+
of the cmake GUIs unless the ``show advanced`` option is on.
|
| 15 |
+
In script mode, the advanced/non-advanced state has no effect.
|
| 16 |
+
|
| 17 |
+
If the keyword ``CLEAR`` is given
|
| 18 |
+
then advanced variables are changed back to unadvanced.
|
| 19 |
+
If the keyword ``FORCE`` is given
|
| 20 |
+
then the variables are made advanced.
|
| 21 |
+
If neither ``FORCE`` nor ``CLEAR`` is specified,
|
| 22 |
+
new values will be marked as advanced, but if a
|
| 23 |
+
variable already has an advanced/non-advanced state,
|
| 24 |
+
it will not be changed.
|
| 25 |
+
|
| 26 |
+
.. versionchanged:: 3.17
|
| 27 |
+
Variables passed to this command which are not already in the cache
|
| 28 |
+
are ignored. See policy :policy:`CMP0102`.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/message.rst
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
message
|
| 2 |
+
-------
|
| 3 |
+
|
| 4 |
+
Log a message.
|
| 5 |
+
|
| 6 |
+
Synopsis
|
| 7 |
+
^^^^^^^^
|
| 8 |
+
|
| 9 |
+
.. parsed-literal::
|
| 10 |
+
|
| 11 |
+
`General messages`_
|
| 12 |
+
message([<mode>] "message text" ...)
|
| 13 |
+
|
| 14 |
+
`Reporting checks`_
|
| 15 |
+
message(<checkState> "message text" ...)
|
| 16 |
+
|
| 17 |
+
`Configure Log`_
|
| 18 |
+
message(CONFIGURE_LOG <text>...)
|
| 19 |
+
|
| 20 |
+
General messages
|
| 21 |
+
^^^^^^^^^^^^^^^^
|
| 22 |
+
|
| 23 |
+
.. code-block:: cmake
|
| 24 |
+
|
| 25 |
+
message([<mode>] "message text" ...)
|
| 26 |
+
|
| 27 |
+
Record the specified message text in the log. If more than one message
|
| 28 |
+
string is given, they are concatenated into a single message with no
|
| 29 |
+
separator between the strings.
|
| 30 |
+
|
| 31 |
+
The optional ``<mode>`` keyword determines the type of message, which
|
| 32 |
+
influences the way the message is handled:
|
| 33 |
+
|
| 34 |
+
``FATAL_ERROR``
|
| 35 |
+
CMake Error, stop processing and generation.
|
| 36 |
+
|
| 37 |
+
The :manual:`cmake(1)` executable will return a non-zero
|
| 38 |
+
:ref:`exit code <CMake Exit Code>`.
|
| 39 |
+
|
| 40 |
+
``SEND_ERROR``
|
| 41 |
+
CMake Error, continue processing, but skip generation.
|
| 42 |
+
|
| 43 |
+
``WARNING``
|
| 44 |
+
CMake Warning, continue processing.
|
| 45 |
+
|
| 46 |
+
``AUTHOR_WARNING``
|
| 47 |
+
CMake Warning (dev), continue processing.
|
| 48 |
+
|
| 49 |
+
``DEPRECATION``
|
| 50 |
+
CMake Deprecation Error or Warning if variable
|
| 51 |
+
:variable:`CMAKE_ERROR_DEPRECATED` or :variable:`CMAKE_WARN_DEPRECATED`
|
| 52 |
+
is enabled, respectively, else no message.
|
| 53 |
+
|
| 54 |
+
(none) or ``NOTICE``
|
| 55 |
+
Important message printed to stderr to attract user's attention.
|
| 56 |
+
|
| 57 |
+
``STATUS``
|
| 58 |
+
The main interesting messages that project users might be interested in.
|
| 59 |
+
Ideally these should be concise, no more than a single line, but still
|
| 60 |
+
informative.
|
| 61 |
+
|
| 62 |
+
``VERBOSE``
|
| 63 |
+
Detailed informational messages intended for project users. These messages
|
| 64 |
+
should provide additional details that won't be of interest in most cases,
|
| 65 |
+
but which may be useful to those building the project when they want deeper
|
| 66 |
+
insight into what's happening.
|
| 67 |
+
|
| 68 |
+
``DEBUG``
|
| 69 |
+
Detailed informational messages intended for developers working on the
|
| 70 |
+
project itself as opposed to users who just want to build it. These messages
|
| 71 |
+
will not typically be of interest to other users building the project and
|
| 72 |
+
will often be closely related to internal implementation details.
|
| 73 |
+
|
| 74 |
+
``TRACE``
|
| 75 |
+
Fine-grained messages with very low-level implementation details. Messages
|
| 76 |
+
using this log level would normally only be temporary and would expect to be
|
| 77 |
+
removed before releasing the project, packaging up the files, etc.
|
| 78 |
+
|
| 79 |
+
.. versionadded:: 3.15
|
| 80 |
+
Added the ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels.
|
| 81 |
+
|
| 82 |
+
The CMake command-line tool displays ``STATUS`` to ``TRACE`` messages on stdout
|
| 83 |
+
with the message preceded by two hyphens and a space. All other message types
|
| 84 |
+
are sent to stderr and are not prefixed with hyphens. The
|
| 85 |
+
:manual:`CMake GUI <cmake-gui(1)>` displays all messages in its log area.
|
| 86 |
+
The :manual:`curses interface <ccmake(1)>` shows ``STATUS`` to ``TRACE``
|
| 87 |
+
messages one at a time on a status line and other messages in an
|
| 88 |
+
interactive pop-up box. The :option:`--log-level <cmake --log-level>`
|
| 89 |
+
command-line option to each of these tools can be used to control which
|
| 90 |
+
messages will be shown.
|
| 91 |
+
|
| 92 |
+
.. versionadded:: 3.17
|
| 93 |
+
To make a log level persist between CMake runs, the
|
| 94 |
+
:variable:`CMAKE_MESSAGE_LOG_LEVEL` variable can be set instead.
|
| 95 |
+
Note that the command line option takes precedence over the cache variable.
|
| 96 |
+
|
| 97 |
+
.. versionadded:: 3.16
|
| 98 |
+
Messages of log levels ``NOTICE`` and below will have each line preceded
|
| 99 |
+
by the content of the :variable:`CMAKE_MESSAGE_INDENT` variable (converted to
|
| 100 |
+
a single string by concatenating its list items). For ``STATUS`` to ``TRACE``
|
| 101 |
+
messages, this indenting content will be inserted after the hyphens.
|
| 102 |
+
|
| 103 |
+
.. versionadded:: 3.17
|
| 104 |
+
Messages of log levels ``NOTICE`` and below can also have each line preceded
|
| 105 |
+
with context of the form ``[some.context.example]``. The content between the
|
| 106 |
+
square brackets is obtained by converting the :variable:`CMAKE_MESSAGE_CONTEXT`
|
| 107 |
+
list variable to a dot-separated string. The message context will always
|
| 108 |
+
appear before any indenting content but after any automatically added leading
|
| 109 |
+
hyphens. By default, message context is not shown, it has to be explicitly
|
| 110 |
+
enabled by giving the :option:`cmake --log-context`
|
| 111 |
+
command-line option or by setting the :variable:`CMAKE_MESSAGE_CONTEXT_SHOW`
|
| 112 |
+
variable to true. See the :variable:`CMAKE_MESSAGE_CONTEXT` documentation for
|
| 113 |
+
usage examples.
|
| 114 |
+
|
| 115 |
+
CMake Warning and Error message text displays using a simple markup
|
| 116 |
+
language. Non-indented text is formatted in line-wrapped paragraphs
|
| 117 |
+
delimited by newlines. Indented text is considered pre-formatted.
|
| 118 |
+
|
| 119 |
+
|
| 120 |
+
Reporting checks
|
| 121 |
+
^^^^^^^^^^^^^^^^
|
| 122 |
+
|
| 123 |
+
.. versionadded:: 3.17
|
| 124 |
+
|
| 125 |
+
A common pattern in CMake output is a message indicating the start of some
|
| 126 |
+
sort of check, followed by another message reporting the result of that check.
|
| 127 |
+
For example:
|
| 128 |
+
|
| 129 |
+
.. code-block:: cmake
|
| 130 |
+
|
| 131 |
+
message(STATUS "Looking for someheader.h")
|
| 132 |
+
#... do the checks, set checkSuccess with the result
|
| 133 |
+
if(checkSuccess)
|
| 134 |
+
message(STATUS "Looking for someheader.h - found")
|
| 135 |
+
else()
|
| 136 |
+
message(STATUS "Looking for someheader.h - not found")
|
| 137 |
+
endif()
|
| 138 |
+
|
| 139 |
+
This can be more robustly and conveniently expressed using the ``CHECK_...``
|
| 140 |
+
keyword form of the ``message()`` command:
|
| 141 |
+
|
| 142 |
+
.. code-block:: cmake
|
| 143 |
+
|
| 144 |
+
message(<checkState> "message" ...)
|
| 145 |
+
|
| 146 |
+
where ``<checkState>`` must be one of the following:
|
| 147 |
+
|
| 148 |
+
``CHECK_START``
|
| 149 |
+
Record a concise message about the check about to be performed.
|
| 150 |
+
|
| 151 |
+
``CHECK_PASS``
|
| 152 |
+
Record a successful result for a check.
|
| 153 |
+
|
| 154 |
+
``CHECK_FAIL``
|
| 155 |
+
Record an unsuccessful result for a check.
|
| 156 |
+
|
| 157 |
+
When recording a check result, the command repeats the message from the most
|
| 158 |
+
recently started check for which no result has yet been reported, then some
|
| 159 |
+
separator characters and then the message text provided after the
|
| 160 |
+
``CHECK_PASS`` or ``CHECK_FAIL`` keyword. Check messages are always reported
|
| 161 |
+
at ``STATUS`` log level.
|
| 162 |
+
|
| 163 |
+
Checks may be nested and every ``CHECK_START`` should have exactly one
|
| 164 |
+
matching ``CHECK_PASS`` or ``CHECK_FAIL``.
|
| 165 |
+
The :variable:`CMAKE_MESSAGE_INDENT` variable can also be used to add
|
| 166 |
+
indenting to nested checks if desired. For example:
|
| 167 |
+
|
| 168 |
+
.. code-block:: cmake
|
| 169 |
+
|
| 170 |
+
message(CHECK_START "Finding my things")
|
| 171 |
+
list(APPEND CMAKE_MESSAGE_INDENT " ")
|
| 172 |
+
unset(missingComponents)
|
| 173 |
+
|
| 174 |
+
message(CHECK_START "Finding partA")
|
| 175 |
+
# ... do check, assume we find A
|
| 176 |
+
message(CHECK_PASS "found")
|
| 177 |
+
|
| 178 |
+
message(CHECK_START "Finding partB")
|
| 179 |
+
# ... do check, assume we don't find B
|
| 180 |
+
list(APPEND missingComponents B)
|
| 181 |
+
message(CHECK_FAIL "not found")
|
| 182 |
+
|
| 183 |
+
list(POP_BACK CMAKE_MESSAGE_INDENT)
|
| 184 |
+
if(missingComponents)
|
| 185 |
+
message(CHECK_FAIL "missing components: ${missingComponents}")
|
| 186 |
+
else()
|
| 187 |
+
message(CHECK_PASS "all components found")
|
| 188 |
+
endif()
|
| 189 |
+
|
| 190 |
+
Output from the above would appear something like the following::
|
| 191 |
+
|
| 192 |
+
-- Finding my things
|
| 193 |
+
-- Finding partA
|
| 194 |
+
-- Finding partA - found
|
| 195 |
+
-- Finding partB
|
| 196 |
+
-- Finding partB - not found
|
| 197 |
+
-- Finding my things - missing components: B
|
| 198 |
+
|
| 199 |
+
Configure Log
|
| 200 |
+
^^^^^^^^^^^^^
|
| 201 |
+
|
| 202 |
+
.. versionadded:: 3.26
|
| 203 |
+
|
| 204 |
+
.. code-block:: cmake
|
| 205 |
+
|
| 206 |
+
message(CONFIGURE_LOG <text>...)
|
| 207 |
+
|
| 208 |
+
Record a :ref:`configure-log message event <message configure-log event>`
|
| 209 |
+
with the specified ``<text>``. By convention, if the text contains more
|
| 210 |
+
than one line, the first line should be a summary of the event.
|
| 211 |
+
|
| 212 |
+
This mode is intended to record the details of a system inspection check
|
| 213 |
+
or other one-time operation guarded by a cache entry, but that is not
|
| 214 |
+
performed using :command:`try_compile` or :command:`try_run`, which
|
| 215 |
+
automatically log their details. Projects should avoid calling it every
|
| 216 |
+
time CMake runs. For example:
|
| 217 |
+
|
| 218 |
+
.. code-block:: cmake
|
| 219 |
+
|
| 220 |
+
if (NOT DEFINED MY_CHECK_RESULT)
|
| 221 |
+
# Print check summary in configure output.
|
| 222 |
+
message(CHECK_START "My Check")
|
| 223 |
+
|
| 224 |
+
# ... perform system inspection, e.g., with execute_process ...
|
| 225 |
+
|
| 226 |
+
# Cache the result so we do not run the check again.
|
| 227 |
+
set(MY_CHECK_RESULT "${MY_CHECK_RESULT}" CACHE INTERNAL "My Check")
|
| 228 |
+
|
| 229 |
+
# Record the check details in the cmake-configure-log.
|
| 230 |
+
message(CONFIGURE_LOG
|
| 231 |
+
"My Check Result: ${MY_CHECK_RESULT}\n"
|
| 232 |
+
"${details}"
|
| 233 |
+
)
|
| 234 |
+
|
| 235 |
+
# Print check result in configure output.
|
| 236 |
+
if(MY_CHECK_RESULT)
|
| 237 |
+
message(CHECK_PASS "passed")
|
| 238 |
+
else()
|
| 239 |
+
message(CHECK_FAIL "failed")
|
| 240 |
+
endif()
|
| 241 |
+
endif()
|
| 242 |
+
|
| 243 |
+
If no project is currently being configured, such as in
|
| 244 |
+
:ref:`cmake -P <Script Processing Mode>` script mode,
|
| 245 |
+
this command does nothing.
|
| 246 |
+
|
| 247 |
+
See Also
|
| 248 |
+
^^^^^^^^
|
| 249 |
+
|
| 250 |
+
* :command:`cmake_language(GET_MESSAGE_LOG_LEVEL)`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/option.rst
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
option
|
| 2 |
+
------
|
| 3 |
+
|
| 4 |
+
Provide a boolean option that the user can optionally select.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
option(<variable> "<help_text>" [value])
|
| 9 |
+
|
| 10 |
+
If no initial ``<value>`` is provided, boolean ``OFF`` is the default value.
|
| 11 |
+
If ``<variable>`` is already set as a normal or cache variable,
|
| 12 |
+
then the command does nothing (see policy :policy:`CMP0077`).
|
| 13 |
+
|
| 14 |
+
For options that depend on the values of other options, see
|
| 15 |
+
the module help for :module:`CMakeDependentOption`.
|
| 16 |
+
|
| 17 |
+
In CMake project mode, a boolean cache variable is created with the option
|
| 18 |
+
value. In CMake script mode, a boolean variable is set with the option value.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/qt_wrap_cpp.rst
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
qt_wrap_cpp
|
| 2 |
+
-----------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.14
|
| 5 |
+
|
| 6 |
+
This command was originally added to support Qt 3 before the
|
| 7 |
+
:command:`add_custom_command()` command was sufficiently mature. The
|
| 8 |
+
:module:`FindQt4` module provides the ``qt4_wrap_cpp()`` macro, which
|
| 9 |
+
should be used instead for Qt 4 projects. For projects using Qt 5 or
|
| 10 |
+
later, use the equivalent macro provided by Qt itself (e.g. Qt 5 provides
|
| 11 |
+
`qt5_wrap_cpp() <https://doc.qt.io/qt-5/qtcore-cmake-qt5-wrap-cpp.html>`_).
|
| 12 |
+
|
| 13 |
+
Manually create Qt Wrappers.
|
| 14 |
+
|
| 15 |
+
.. code-block:: cmake
|
| 16 |
+
|
| 17 |
+
qt_wrap_cpp(resultingLibraryName DestName SourceLists ...)
|
| 18 |
+
|
| 19 |
+
Produces moc files for all the .h files listed in the SourceLists. The
|
| 20 |
+
moc files will be added to the library using the ``DestName`` source list.
|
| 21 |
+
|
| 22 |
+
Consider updating the project to use the :prop_tgt:`AUTOMOC` target property
|
| 23 |
+
instead for a more automated way of invoking the ``moc`` tool.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/qt_wrap_ui.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
qt_wrap_ui
|
| 2 |
+
----------
|
| 3 |
+
|
| 4 |
+
.. deprecated:: 3.14
|
| 5 |
+
|
| 6 |
+
This command was originally added to support Qt 3 before the
|
| 7 |
+
:command:`add_custom_command()` command was sufficiently mature. The
|
| 8 |
+
:module:`FindQt4` module provides the ``qt4_wrap_ui()`` macro, which
|
| 9 |
+
should be used instead for Qt 4 projects. For projects using Qt 5 or
|
| 10 |
+
later, use the equivalent macro provided by Qt itself (e.g. Qt 5 provides
|
| 11 |
+
``qt5_wrap_ui()``).
|
| 12 |
+
|
| 13 |
+
Manually create Qt user interfaces Wrappers.
|
| 14 |
+
|
| 15 |
+
.. code-block:: cmake
|
| 16 |
+
|
| 17 |
+
qt_wrap_ui(resultingLibraryName HeadersDestName
|
| 18 |
+
SourcesDestName SourceLists ...)
|
| 19 |
+
|
| 20 |
+
Produces .h and .cxx files for all the .ui files listed in the
|
| 21 |
+
``SourceLists``. The .h files will be added to the library using the
|
| 22 |
+
``HeadersDestNamesource`` list. The .cxx files will be added to the
|
| 23 |
+
library using the ``SourcesDestNamesource`` list.
|
| 24 |
+
|
| 25 |
+
Consider updating the project to use the :prop_tgt:`AUTOUIC` target property
|
| 26 |
+
instead for a more automated way of invoking the ``uic`` tool.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/separate_arguments.rst
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
separate_arguments
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
Parse command-line arguments into a semicolon-separated list.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
separate_arguments(<variable> <mode> [PROGRAM [SEPARATE_ARGS]] <args>)
|
| 9 |
+
|
| 10 |
+
Parses a space-separated string ``<args>`` into a list of items,
|
| 11 |
+
and stores this list in semicolon-separated standard form in ``<variable>``.
|
| 12 |
+
|
| 13 |
+
This function is intended for parsing command-line arguments.
|
| 14 |
+
The entire command line must be passed as one string in the
|
| 15 |
+
argument ``<args>``.
|
| 16 |
+
|
| 17 |
+
The exact parsing rules depend on the operating system.
|
| 18 |
+
They are specified by the ``<mode>`` argument which must
|
| 19 |
+
be one of the following keywords:
|
| 20 |
+
|
| 21 |
+
``UNIX_COMMAND``
|
| 22 |
+
Arguments are separated by unquoted whitespace.
|
| 23 |
+
Both single-quote and double-quote pairs are respected.
|
| 24 |
+
A backslash escapes the next literal character (``\"`` is ``"``);
|
| 25 |
+
there are no special escapes (``\n`` is just ``n``).
|
| 26 |
+
|
| 27 |
+
``WINDOWS_COMMAND``
|
| 28 |
+
A Windows command-line is parsed using the same
|
| 29 |
+
syntax the runtime library uses to construct argv at startup. It
|
| 30 |
+
separates arguments by whitespace that is not double-quoted.
|
| 31 |
+
Backslashes are literal unless they precede double-quotes. See the
|
| 32 |
+
MSDN article `Parsing C Command-Line Arguments`_ for details.
|
| 33 |
+
|
| 34 |
+
``NATIVE_COMMAND``
|
| 35 |
+
.. versionadded:: 3.9
|
| 36 |
+
|
| 37 |
+
Proceeds as in ``WINDOWS_COMMAND`` mode if the host system is Windows.
|
| 38 |
+
Otherwise proceeds as in ``UNIX_COMMAND`` mode.
|
| 39 |
+
|
| 40 |
+
``PROGRAM``
|
| 41 |
+
.. versionadded:: 3.19
|
| 42 |
+
|
| 43 |
+
The first item in ``<args>`` is assumed to be an executable and will be
|
| 44 |
+
searched in the system search path or left as a full path. If not found,
|
| 45 |
+
``<variable>`` will be empty. Otherwise, ``<variable>`` is a list of 2
|
| 46 |
+
elements:
|
| 47 |
+
|
| 48 |
+
0. Absolute path of the program
|
| 49 |
+
1. Any command-line arguments present in ``<args>`` as a string
|
| 50 |
+
|
| 51 |
+
For example:
|
| 52 |
+
|
| 53 |
+
.. code-block:: cmake
|
| 54 |
+
|
| 55 |
+
separate_arguments (out UNIX_COMMAND PROGRAM "cc -c main.c")
|
| 56 |
+
|
| 57 |
+
* First element of the list: ``/path/to/cc``
|
| 58 |
+
* Second element of the list: ``" -c main.c"``
|
| 59 |
+
|
| 60 |
+
``SEPARATE_ARGS``
|
| 61 |
+
When this sub-option of ``PROGRAM`` option is specified, command-line
|
| 62 |
+
arguments will be split as well and stored in ``<variable>``.
|
| 63 |
+
|
| 64 |
+
For example:
|
| 65 |
+
|
| 66 |
+
.. code-block:: cmake
|
| 67 |
+
|
| 68 |
+
separate_arguments (out UNIX_COMMAND PROGRAM SEPARATE_ARGS "cc -c main.c")
|
| 69 |
+
|
| 70 |
+
The contents of ``out`` will be: ``/path/to/cc;-c;main.c``
|
| 71 |
+
|
| 72 |
+
.. _`Parsing C Command-Line Arguments`: https://learn.microsoft.com/en-us/cpp/c-language/parsing-c-command-line-arguments
|
| 73 |
+
|
| 74 |
+
.. code-block:: cmake
|
| 75 |
+
|
| 76 |
+
separate_arguments(<var>)
|
| 77 |
+
|
| 78 |
+
Convert the value of ``<var>`` to a semi-colon separated list. All
|
| 79 |
+
spaces are replaced with ';'. This helps with generating command
|
| 80 |
+
lines.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set.rst
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
set
|
| 2 |
+
---
|
| 3 |
+
|
| 4 |
+
Set a normal, cache, or environment variable to a given value.
|
| 5 |
+
See the :ref:`cmake-language(7) variables <CMake Language Variables>`
|
| 6 |
+
documentation for the scopes and interaction of normal variables
|
| 7 |
+
and cache entries.
|
| 8 |
+
|
| 9 |
+
Signatures of this command that specify a ``<value>...`` placeholder
|
| 10 |
+
expect zero or more arguments. Multiple arguments will be joined as
|
| 11 |
+
a :ref:`semicolon-separated list <CMake Language Lists>` to form the
|
| 12 |
+
actual variable value to be set.
|
| 13 |
+
|
| 14 |
+
Set Normal Variable
|
| 15 |
+
^^^^^^^^^^^^^^^^^^^
|
| 16 |
+
|
| 17 |
+
.. signature::
|
| 18 |
+
set(<variable> <value>... [PARENT_SCOPE])
|
| 19 |
+
:target: normal
|
| 20 |
+
|
| 21 |
+
Set or unset ``<variable>`` in the current function or directory scope:
|
| 22 |
+
|
| 23 |
+
* If at least one ``<value>...`` is given, set the variable to that value.
|
| 24 |
+
* If no value is given, unset the variable. This is equivalent to
|
| 25 |
+
:command:`unset(<variable>) <unset>`.
|
| 26 |
+
|
| 27 |
+
If the ``PARENT_SCOPE`` option is given the variable will be set in
|
| 28 |
+
the scope above the current scope. Each new directory or :command:`function`
|
| 29 |
+
command creates a new scope. A scope can also be created with the
|
| 30 |
+
:command:`block` command. ``set(PARENT_SCOPE)`` will set the value
|
| 31 |
+
of a variable into the parent directory, calling function, or
|
| 32 |
+
encompassing scope (whichever is applicable to the case at hand).
|
| 33 |
+
The previous state of the variable's value stays the same in the
|
| 34 |
+
current scope (e.g., if it was undefined before, it is still undefined
|
| 35 |
+
and if it had a value, it is still that value).
|
| 36 |
+
|
| 37 |
+
The :command:`block(PROPAGATE)` and :command:`return(PROPAGATE)` commands
|
| 38 |
+
can be used as an alternate method to the :command:`set(PARENT_SCOPE)`
|
| 39 |
+
and :command:`unset(PARENT_SCOPE)` commands to update the parent scope.
|
| 40 |
+
|
| 41 |
+
.. include:: UNSET_NOTE.txt
|
| 42 |
+
|
| 43 |
+
Set Cache Entry
|
| 44 |
+
^^^^^^^^^^^^^^^
|
| 45 |
+
|
| 46 |
+
.. signature::
|
| 47 |
+
set(<variable> <value>... CACHE <type> <docstring> [FORCE])
|
| 48 |
+
:target: CACHE
|
| 49 |
+
|
| 50 |
+
Sets the given cache ``<variable>`` (cache entry). Since cache entries
|
| 51 |
+
are meant to provide user-settable values this does not overwrite
|
| 52 |
+
existing cache entries by default. Use the ``FORCE`` option to
|
| 53 |
+
overwrite existing entries.
|
| 54 |
+
|
| 55 |
+
The ``<type>`` must be specified as one of:
|
| 56 |
+
|
| 57 |
+
``BOOL``
|
| 58 |
+
Boolean ``ON/OFF`` value.
|
| 59 |
+
:manual:`cmake-gui(1)` offers a checkbox.
|
| 60 |
+
|
| 61 |
+
``FILEPATH``
|
| 62 |
+
Path to a file on disk.
|
| 63 |
+
:manual:`cmake-gui(1)` offers a file dialog.
|
| 64 |
+
|
| 65 |
+
``PATH``
|
| 66 |
+
Path to a directory on disk.
|
| 67 |
+
:manual:`cmake-gui(1)` offers a file dialog.
|
| 68 |
+
|
| 69 |
+
``STRING``
|
| 70 |
+
A line of text.
|
| 71 |
+
:manual:`cmake-gui(1)` offers a text field or a drop-down selection
|
| 72 |
+
if the :prop_cache:`STRINGS` cache entry property is set.
|
| 73 |
+
|
| 74 |
+
``INTERNAL``
|
| 75 |
+
A line of text.
|
| 76 |
+
:manual:`cmake-gui(1)` does not show internal entries.
|
| 77 |
+
They may be used to store variables persistently across runs.
|
| 78 |
+
Use of this type implies ``FORCE``.
|
| 79 |
+
|
| 80 |
+
The ``<docstring>`` must be specified as a line of text
|
| 81 |
+
providing a quick summary of the option
|
| 82 |
+
for presentation to :manual:`cmake-gui(1)` users.
|
| 83 |
+
|
| 84 |
+
If the cache entry does not exist prior to the call or the ``FORCE``
|
| 85 |
+
option is given then the cache entry will be set to the given value.
|
| 86 |
+
|
| 87 |
+
.. note::
|
| 88 |
+
|
| 89 |
+
The content of the cache variable will not be directly accessible
|
| 90 |
+
if a normal variable of the same name already exists
|
| 91 |
+
(see :ref:`rules of variable evaluation <CMake Language Variables>`).
|
| 92 |
+
If policy :policy:`CMP0126` is set to ``OLD``, any normal variable
|
| 93 |
+
binding in the current scope will be removed.
|
| 94 |
+
|
| 95 |
+
It is possible for the cache entry to exist prior to the call but
|
| 96 |
+
have no type set if it was created on the :manual:`cmake(1)` command
|
| 97 |
+
line by a user through the :option:`-D\<var\>=\<value\> <cmake -D>` option
|
| 98 |
+
without specifying a type. In this case the ``set`` command will add the
|
| 99 |
+
type. Furthermore, if the ``<type>`` is ``PATH`` or ``FILEPATH``
|
| 100 |
+
and the ``<value>`` provided on the command line is a relative path,
|
| 101 |
+
then the ``set`` command will treat the path as relative to the
|
| 102 |
+
current working directory and convert it to an absolute path.
|
| 103 |
+
|
| 104 |
+
Set Environment Variable
|
| 105 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 106 |
+
|
| 107 |
+
.. signature::
|
| 108 |
+
set(ENV{<variable>} [<value>])
|
| 109 |
+
:target: ENV
|
| 110 |
+
|
| 111 |
+
Sets an :manual:`Environment Variable <cmake-env-variables(7)>`
|
| 112 |
+
to the given value.
|
| 113 |
+
Subsequent calls of ``$ENV{<variable>}`` will return this new value.
|
| 114 |
+
|
| 115 |
+
This command affects only the current CMake process, not the process
|
| 116 |
+
from which CMake was called, nor the system environment at large,
|
| 117 |
+
nor the environment of subsequent build or test processes.
|
| 118 |
+
|
| 119 |
+
If no argument is given after ``ENV{<variable>}`` or if ``<value>`` is
|
| 120 |
+
an empty string, then this command will clear any existing value of the
|
| 121 |
+
environment variable.
|
| 122 |
+
|
| 123 |
+
Arguments after ``<value>`` are ignored. If extra arguments are found,
|
| 124 |
+
then an author warning is issued.
|
| 125 |
+
|
| 126 |
+
See Also
|
| 127 |
+
^^^^^^^^
|
| 128 |
+
|
| 129 |
+
* :command:`unset`
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/set_target_properties.rst
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
set_target_properties
|
| 2 |
+
---------------------
|
| 3 |
+
|
| 4 |
+
Targets can have properties that affect how they are built.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
set_target_properties(<targets> ...
|
| 9 |
+
PROPERTIES <prop1> <value1>
|
| 10 |
+
[<prop2> <value2>] ...)
|
| 11 |
+
|
| 12 |
+
Sets properties on targets. The syntax for the command is to list all
|
| 13 |
+
the targets you want to change, and then provide the values you want to
|
| 14 |
+
set next. You can use any prop value pair you want and extract it
|
| 15 |
+
later with the :command:`get_property` or :command:`get_target_property`
|
| 16 |
+
command.
|
| 17 |
+
|
| 18 |
+
:ref:`Alias Targets` do not support setting target properties.
|
| 19 |
+
|
| 20 |
+
See Also
|
| 21 |
+
^^^^^^^^
|
| 22 |
+
|
| 23 |
+
* :command:`define_property`
|
| 24 |
+
* :command:`get_target_property`
|
| 25 |
+
* the more general :command:`set_property` command
|
| 26 |
+
* :ref:`Target Properties` for the list of properties known to CMake
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/site_name.rst
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
site_name
|
| 2 |
+
---------
|
| 3 |
+
|
| 4 |
+
Set the given variable to the name of the computer.
|
| 5 |
+
|
| 6 |
+
.. code-block:: cmake
|
| 7 |
+
|
| 8 |
+
site_name(variable)
|
| 9 |
+
|
| 10 |
+
On UNIX-like platforms, if the variable ``HOSTNAME`` is set, its value
|
| 11 |
+
will be executed as a command expected to print out the host name,
|
| 12 |
+
much like the ``hostname`` command-line tool.
|
mgm/lib/python3.10/site-packages/cmake/data/share/cmake-3.31/Help/command/source_group.rst
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
source_group
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
Define a grouping for source files in IDE project generation.
|
| 5 |
+
There are two different signatures to create source groups.
|
| 6 |
+
|
| 7 |
+
.. code-block:: cmake
|
| 8 |
+
|
| 9 |
+
source_group(<name> [FILES <src>...] [REGULAR_EXPRESSION <regex>])
|
| 10 |
+
source_group(TREE <root> [PREFIX <prefix>] [FILES <src>...])
|
| 11 |
+
|
| 12 |
+
Defines a group into which sources will be placed in project files.
|
| 13 |
+
This is intended to set up file tabs in Visual Studio.
|
| 14 |
+
The group is scoped in the directory where the command is called,
|
| 15 |
+
and applies to sources in targets created in that directory.
|
| 16 |
+
|
| 17 |
+
The options are:
|
| 18 |
+
|
| 19 |
+
``TREE``
|
| 20 |
+
.. versionadded:: 3.8
|
| 21 |
+
|
| 22 |
+
CMake will automatically detect, from ``<src>`` files paths, source groups
|
| 23 |
+
it needs to create, to keep structure of source groups analogically to the
|
| 24 |
+
actual files and directories structure in the project. Paths of ``<src>``
|
| 25 |
+
files will be cut to be relative to ``<root>``. The command fails if the
|
| 26 |
+
paths within ``src`` do not start with ``root``.
|
| 27 |
+
|
| 28 |
+
``PREFIX``
|
| 29 |
+
.. versionadded:: 3.8
|
| 30 |
+
|
| 31 |
+
Source group and files located directly in ``<root>`` path, will be placed
|
| 32 |
+
in ``<prefix>`` source groups.
|
| 33 |
+
|
| 34 |
+
``FILES``
|
| 35 |
+
Any source file specified explicitly will be placed in group
|
| 36 |
+
``<name>``. Relative paths are interpreted with respect to the
|
| 37 |
+
current source directory.
|
| 38 |
+
|
| 39 |
+
``REGULAR_EXPRESSION``
|
| 40 |
+
Any source file whose name matches the regular expression will
|
| 41 |
+
be placed in group ``<name>``.
|
| 42 |
+
|
| 43 |
+
If a source file matches multiple groups, the *last* group that
|
| 44 |
+
explicitly lists the file with ``FILES`` will be favored, if any.
|
| 45 |
+
If no group explicitly lists the file, the *last* group whose
|
| 46 |
+
regular expression matches the file will be favored.
|
| 47 |
+
|
| 48 |
+
The ``<name>`` of the group and ``<prefix>`` argument may contain forward
|
| 49 |
+
slashes or backslashes to specify subgroups. Backslashes need to be escaped
|
| 50 |
+
appropriately:
|
| 51 |
+
|
| 52 |
+
.. code-block:: cmake
|
| 53 |
+
|
| 54 |
+
source_group(base/subdir ...)
|
| 55 |
+
source_group(outer\\inner ...)
|
| 56 |
+
source_group(TREE <root> PREFIX sources\\inc ...)
|
| 57 |
+
|
| 58 |
+
.. versionadded:: 3.18
|
| 59 |
+
Allow using forward slashes (``/``) to specify subgroups.
|
| 60 |
+
|
| 61 |
+
For backwards compatibility, the short-hand signature
|
| 62 |
+
|
| 63 |
+
.. code-block:: cmake
|
| 64 |
+
|
| 65 |
+
source_group(<name> <regex>)
|
| 66 |
+
|
| 67 |
+
is equivalent to
|
| 68 |
+
|
| 69 |
+
.. code-block:: cmake
|
| 70 |
+
|
| 71 |
+
source_group(<name> REGULAR_EXPRESSION <regex>)
|