FetchContent.cmake 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file Copyright.txt or https://cmake.org/licensing for details.
  3. #[=======================================================================[.rst:
  4. FetchContent
  5. ------------------
  6. .. versionadded:: 3.11
  7. .. only:: html
  8. .. contents::
  9. .. note:: The :guide:`Using Dependencies Guide` provides a high-level
  10. introduction to this general topic. It provides a broader overview of
  11. where the ``FetchContent`` module fits into the bigger picture,
  12. including its relationship to the :command:`find_package` command.
  13. The guide is recommended pre-reading before moving on to the details below.
  14. Overview
  15. ^^^^^^^^
  16. This module enables populating content at configure time via any method
  17. supported by the :module:`ExternalProject` module. Whereas
  18. :command:`ExternalProject_Add` downloads at build time, the
  19. ``FetchContent`` module makes content available immediately, allowing the
  20. configure step to use the content in commands like :command:`add_subdirectory`,
  21. :command:`include` or :command:`file` operations.
  22. Content population details should be defined separately from the command that
  23. performs the actual population. This separation ensures that all the
  24. dependency details are defined before anything might try to use them to
  25. populate content. This is particularly important in more complex project
  26. hierarchies where dependencies may be shared between multiple projects.
  27. The following shows a typical example of declaring content details for some
  28. dependencies and then ensuring they are populated with a separate call:
  29. .. code-block:: cmake
  30. FetchContent_Declare(
  31. googletest
  32. GIT_REPOSITORY https://github.com/google/googletest.git
  33. GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  34. )
  35. FetchContent_Declare(
  36. myCompanyIcons
  37. URL https://intranet.mycompany.com/assets/iconset_1.12.tar.gz
  38. URL_HASH MD5=5588a7b18261c20068beabfb4f530b87
  39. )
  40. FetchContent_MakeAvailable(googletest myCompanyIcons)
  41. The :command:`FetchContent_MakeAvailable` command ensures the named
  42. dependencies have been populated, either by an earlier call or by populating
  43. them itself. When performing the population, it will also add them to the
  44. main build, if possible, so that the main build can use the populated
  45. projects' targets, etc. See the command's documentation for how these steps
  46. are performed.
  47. When using a hierarchical project arrangement, projects at higher levels in
  48. the hierarchy are able to override the declared details of content specified
  49. anywhere lower in the project hierarchy. The first details to be declared
  50. for a given dependency take precedence, regardless of where in the project
  51. hierarchy that occurs. Similarly, the first call that tries to populate a
  52. dependency "wins", with subsequent populations reusing the result of the
  53. first instead of repeating the population again.
  54. See the :ref:`Examples <fetch-content-examples>` which demonstrate
  55. this scenario.
  56. In some cases, the main project may need to have more precise control over
  57. the population, or it may be required to explicitly define the population
  58. steps in a way that cannot be captured by the declared details alone.
  59. For such situations, the lower level :command:`FetchContent_GetProperties` and
  60. :command:`FetchContent_Populate` commands can be used. These lack the richer
  61. features provided by :command:`FetchContent_MakeAvailable` though, so their
  62. direct use should be considered a last resort. The typical pattern of such
  63. custom steps looks like this:
  64. .. code-block:: cmake
  65. # NOTE: Where possible, prefer to use FetchContent_MakeAvailable()
  66. # instead of custom logic like this
  67. # Check if population has already been performed
  68. FetchContent_GetProperties(depname)
  69. if(NOT depname_POPULATED)
  70. # Fetch the content using previously declared details
  71. FetchContent_Populate(depname)
  72. # Set custom variables, policies, etc.
  73. # ...
  74. # Bring the populated content into the build
  75. add_subdirectory(${depname_SOURCE_DIR} ${depname_BINARY_DIR})
  76. endif()
  77. The ``FetchContent`` module also supports defining and populating
  78. content in a single call, with no check for whether the content has been
  79. populated elsewhere already. This should not be done in projects, but may
  80. be appropriate for populating content in CMake's script mode.
  81. See :command:`FetchContent_Populate` for details.
  82. Commands
  83. ^^^^^^^^
  84. .. command:: FetchContent_Declare
  85. .. code-block:: cmake
  86. FetchContent_Declare(
  87. <name>
  88. <contentOptions>...
  89. [OVERRIDE_FIND_PACKAGE |
  90. FIND_PACKAGE_ARGS args...]
  91. )
  92. The ``FetchContent_Declare()`` function records the options that describe
  93. how to populate the specified content. If such details have already
  94. been recorded earlier in this project (regardless of where in the project
  95. hierarchy), this and all later calls for the same content ``<name>`` are
  96. ignored. This "first to record, wins" approach is what allows hierarchical
  97. projects to have parent projects override content details of child projects.
  98. The content ``<name>`` can be any string without spaces, but good practice
  99. would be to use only letters, numbers and underscores. The name will be
  100. treated case-insensitively and it should be obvious for the content it
  101. represents, often being the name of the child project or the value given
  102. to its top level :command:`project` command (if it is a CMake project).
  103. For well-known public projects, the name should generally be the official
  104. name of the project. Choosing an unusual name makes it unlikely that other
  105. projects needing that same content will use the same name, leading to
  106. the content being populated multiple times.
  107. The ``<contentOptions>`` can be any of the download, update or patch options
  108. that the :command:`ExternalProject_Add` command understands. The configure,
  109. build, install and test steps are explicitly disabled and therefore options
  110. related to them will be ignored. The ``SOURCE_SUBDIR`` option is an
  111. exception, see :command:`FetchContent_MakeAvailable` for details on how that
  112. affects behavior.
  113. In most cases, ``<contentOptions>`` will just be a couple of options defining
  114. the download method and method-specific details like a commit tag or archive
  115. hash. For example:
  116. .. code-block:: cmake
  117. FetchContent_Declare(
  118. googletest
  119. GIT_REPOSITORY https://github.com/google/googletest.git
  120. GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  121. )
  122. FetchContent_Declare(
  123. myCompanyIcons
  124. URL https://intranet.mycompany.com/assets/iconset_1.12.tar.gz
  125. URL_HASH MD5=5588a7b18261c20068beabfb4f530b87
  126. )
  127. FetchContent_Declare(
  128. myCompanyCertificates
  129. SVN_REPOSITORY svn+ssh://svn.mycompany.com/srv/svn/trunk/certs
  130. SVN_REVISION -r12345
  131. )
  132. Where contents are being fetched from a remote location and you do not
  133. control that server, it is advisable to use a hash for ``GIT_TAG`` rather
  134. than a branch or tag name. A commit hash is more secure and helps to
  135. confirm that the downloaded contents are what you expected.
  136. .. versionchanged:: 3.14
  137. Commands for the download, update or patch steps can access the terminal.
  138. This may be needed for things like password prompts or real-time display
  139. of command progress.
  140. .. versionadded:: 3.22
  141. The :variable:`CMAKE_TLS_VERIFY`, :variable:`CMAKE_TLS_CAINFO`,
  142. :variable:`CMAKE_NETRC` and :variable:`CMAKE_NETRC_FILE` variables now
  143. provide the defaults for their corresponding content options, just like
  144. they do for :command:`ExternalProject_Add`. Previously, these variables
  145. were ignored by the ``FetchContent`` module.
  146. .. versionadded:: 3.24
  147. ``FIND_PACKAGE_ARGS``
  148. This option is for scenarios where the
  149. :command:`FetchContent_MakeAvailable` command may first try a call to
  150. :command:`find_package` to satisfy the dependency for ``<name>``.
  151. By default, such a call would be simply ``find_package(<name>)``, but
  152. ``FIND_PACKAGE_ARGS`` can be used to provide additional arguments to be
  153. appended after the ``<name>``. ``FIND_PACKAGE_ARGS`` can also be given
  154. with nothing after it, which indicates that :command:`find_package` can
  155. still be called if :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` is
  156. set to ``OPT_IN`` or is not set.
  157. Everything after the ``FIND_PACKAGE_ARGS`` keyword is appended to the
  158. :command:`find_package` call, so all other ``<contentOptions>`` must
  159. come before the ``FIND_PACKAGE_ARGS`` keyword.
  160. ``OVERRIDE_FIND_PACKAGE`` cannot be used when ``FIND_PACKAGE_ARGS`` is
  161. given.
  162. :ref:`dependency_providers` discusses another way that
  163. :command:`FetchContent_MakeAvailable` calls can be redirected.
  164. ``FIND_PACKAGE_ARGS`` is intended for project control, whereas
  165. dependency providers allow users to override project behavior.
  166. ``OVERRIDE_FIND_PACKAGE``
  167. When a ``FetchContent_Declare(<name> ...)`` call includes this option,
  168. subsequent calls to ``find_package(<name> ...)`` will ensure that
  169. ``FetchContent_MakeAvailable(<name>)`` has been called, then use the
  170. config package files in the :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR`
  171. directory (which are usually created by ``FetchContent_MakeAvailable()``).
  172. This effectively makes :command:`FetchContent_MakeAvailable` override
  173. :command:`find_package` for the named dependency, allowing the former to
  174. satisfy the package requirements of the latter. ``FIND_PACKAGE_ARGS``
  175. cannot be used when ``OVERRIDE_FIND_PACKAGE`` is given.
  176. If a :ref:`dependency provider <dependency_providers>` has been set
  177. and the project calls :command:`find_package` for the ``<name>``
  178. dependency, ``OVERRIDE_FIND_PACKAGE`` will not prevent the provider
  179. from seeing that call. Dependency providers always have the opportunity
  180. to intercept any direct call to :command:`find_package`, except if that
  181. call contains the ``BYPASS_PROVIDER`` option.
  182. .. command:: FetchContent_MakeAvailable
  183. .. versionadded:: 3.14
  184. .. code-block:: cmake
  185. FetchContent_MakeAvailable(<name1> [<name2>...])
  186. This command ensures that each of the named dependencies are made available
  187. to the project by the time it returns. There must have been a call to
  188. :command:`FetchContent_Declare` for each dependency, and the first such call
  189. will control how that dependency will be made available, as described below.
  190. If ``<lowercaseName>_SOURCE_DIR`` is not set:
  191. * .. versionadded:: 3.24
  192. If a :ref:`dependency provider <dependency_providers>` is set, call the
  193. provider's command with ``FETCHCONTENT_MAKEAVAILABLE_SERIAL`` as the
  194. first argument, followed by the arguments of the first call to
  195. :command:`FetchContent_Declare` for ``<name>``. If ``SOURCE_DIR`` or
  196. ``BINARY_DIR`` were not part of the original declared arguments, they
  197. will be added with their default values.
  198. If :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` was set to ``NEVER``
  199. when the details were declared, any ``FIND_PACKAGE_ARGS`` will be
  200. omitted. The ``OVERRIDE_FIND_PACKAGE`` keyword is also always omitted.
  201. If the provider fulfilled the request, ``FetchContent_MakeAvailable()``
  202. will consider that dependency handled, skip the remaining steps below
  203. and move on to the next dependency in the list.
  204. * .. versionadded:: 3.24
  205. If permitted, :command:`find_package(<name> [<args>...]) <find_package>`
  206. will be called, where ``<args>...`` may be provided by the
  207. ``FIND_PACKAGE_ARGS`` option in :command:`FetchContent_Declare`.
  208. The value of the :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` variable
  209. at the time :command:`FetchContent_Declare` was called determines whether
  210. ``FetchContent_MakeAvailable()`` can call :command:`find_package`.
  211. If the dependency was not satisfied by a provider or a
  212. :command:`find_package` call, ``FetchContent_MakeAvailable()`` then uses
  213. the following logic to make the dependency available:
  214. * If the dependency has already been populated earlier in this run, set
  215. the ``<lowercaseName>_POPULATED``, ``<lowercaseName>_SOURCE_DIR`` and
  216. ``<lowercaseName>_BINARY_DIR`` variables in the same way as a call to
  217. :command:`FetchContent_GetProperties`, then skip the remaining steps
  218. below and move on to the next dependency in the list.
  219. * Call :command:`FetchContent_Populate` to populate the dependency using
  220. the details recorded by an earlier call to :command:`FetchContent_Declare`.
  221. Halt with a fatal error if no such details have been recorded.
  222. :variable:`FETCHCONTENT_SOURCE_DIR_<uppercaseName>` can be used to override
  223. the declared details and use content provided at the specified location
  224. instead.
  225. * .. versionadded:: 3.24
  226. Ensure the :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR` directory
  227. contains a ``<lowercaseName>-config.cmake`` and a
  228. ``<lowercaseName>-config-version.cmake`` file (or equivalently
  229. ``<name>Config.cmake`` and ``<name>ConfigVersion.cmake``).
  230. The directory that the :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR`
  231. variable points to is cleared at the start of every CMake run.
  232. If no config file exists when :command:`FetchContent_Populate` returns,
  233. a minimal one will be written which :command:`includes <include>` any
  234. ``<lowercaseName>-extra.cmake`` or ``<name>Extra.cmake`` file with the
  235. ``OPTIONAL`` flag (so the files can be missing and won't generate a
  236. warning). Similarly, if no config version file exists, a very simple
  237. one will be written which sets ``PACKAGE_VERSION_COMPATIBLE`` to true.
  238. CMake cannot automatically determine an arbitrary dependency's version,
  239. so it cannot set ``PACKAGE_VERSION`` or ``PACKAGE_VERSION_EXACT``.
  240. When a dependency is pulled in via :command:`add_subdirectory` in the
  241. next step, it may choose to overwrite the generated config version file
  242. in :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR` with one that also sets
  243. ``PACKAGE_VERSION``, and if appropriate, ``PACKAGE_VERSION_EXACT``.
  244. The dependency may also write a ``<lowercaseName>-extra.cmake`` or
  245. ``<name>Extra.cmake`` file to perform custom processing or define any
  246. variables that their normal (installed) package config file would
  247. otherwise usually define (many projects don't do any custom processing
  248. or set any variables and therefore have no need to do this).
  249. If required, the main project can write these files instead if the
  250. dependency project doesn't do so. This allows the main project to
  251. add missing details from older dependencies that haven't or can't be
  252. updated to support this functionality.
  253. See `Integrating With find_package()`_ for examples.
  254. * If the top directory of the populated content contains a ``CMakeLists.txt``
  255. file, call :command:`add_subdirectory` to add it to the main build.
  256. It is not an error for there to be no ``CMakeLists.txt`` file, which
  257. allows the command to be used for dependencies that make downloaded
  258. content available at a known location, but which do not need or support
  259. being added directly to the build.
  260. .. versionadded:: 3.18
  261. The ``SOURCE_SUBDIR`` option can be given in the declared details to
  262. look somewhere below the top directory instead (i.e. the same way that
  263. ``SOURCE_SUBDIR`` is used by the :command:`ExternalProject_Add`
  264. command). The path provided with ``SOURCE_SUBDIR`` must be relative
  265. and will be treated as relative to the top directory. It can also
  266. point to a directory that does not contain a ``CMakeLists.txt`` file
  267. or even to a directory that doesn't exist. This can be used to avoid
  268. adding a project that contains a ``CMakeLists.txt`` file in its top
  269. directory.
  270. Projects should aim to declare the details of all dependencies they might
  271. use before they call ``FetchContent_MakeAvailable()`` for any of them.
  272. This ensures that if any of the dependencies are also sub-dependencies of
  273. one or more of the others, the main project still controls the details
  274. that will be used (because it will declare them first before the
  275. dependencies get a chance to). In the following code samples, assume that
  276. the ``uses_other`` dependency also uses ``FetchContent`` to add the ``other``
  277. dependency internally:
  278. .. code-block:: cmake
  279. # WRONG: Should declare all details first
  280. FetchContent_Declare(uses_other ...)
  281. FetchContent_MakeAvailable(uses_other)
  282. FetchContent_Declare(other ...) # Will be ignored, uses_other beat us to it
  283. FetchContent_MakeAvailable(other) # Would use details declared by uses_other
  284. .. code-block:: cmake
  285. # CORRECT: All details declared first, so they will take priority
  286. FetchContent_Declare(uses_other ...)
  287. FetchContent_Declare(other ...)
  288. FetchContent_MakeAvailable(uses_other other)
  289. .. command:: FetchContent_Populate
  290. .. note::
  291. Where possible, prefer to use :command:`FetchContent_MakeAvailable`
  292. instead of implementing population manually with this command.
  293. .. code-block:: cmake
  294. FetchContent_Populate(<name>)
  295. In most cases, the only argument given to ``FetchContent_Populate()`` is the
  296. ``<name>``. When used this way, the command assumes the content details have
  297. been recorded by an earlier call to :command:`FetchContent_Declare`. The
  298. details are stored in a global property, so they are unaffected by things
  299. like variable or directory scope. Therefore, it doesn't matter where in the
  300. project the details were previously declared, as long as they have been
  301. declared before the call to ``FetchContent_Populate()``. Those saved details
  302. are then used to construct a call to :command:`ExternalProject_Add` in a
  303. private sub-build to perform the content population immediately. The
  304. implementation of ``ExternalProject_Add()`` ensures that if the content has
  305. already been populated in a previous CMake run, that content will be reused
  306. rather than repopulating them again. For the common case where population
  307. involves downloading content, the cost of the download is only paid once.
  308. An internal global property records when a particular content population
  309. request has been processed. If ``FetchContent_Populate()`` is called more
  310. than once for the same content name within a configure run, the second call
  311. will halt with an error. Projects can and should check whether content
  312. population has already been processed with the
  313. :command:`FetchContent_GetProperties` command before calling
  314. ``FetchContent_Populate()``.
  315. ``FetchContent_Populate()`` will set three variables in the scope of the
  316. caller:
  317. ``<lowercaseName>_POPULATED``
  318. This will always be set to ``TRUE`` by the call.
  319. ``<lowercaseName>_SOURCE_DIR``
  320. The location where the populated content can be found upon return.
  321. ``<lowercaseName>_BINARY_DIR``
  322. A directory intended for use as a corresponding build directory.
  323. The main use case for the ``<lowercaseName>_SOURCE_DIR`` and
  324. ``<lowercaseName>_BINARY_DIR`` variables is to call
  325. :command:`add_subdirectory` immediately after population:
  326. .. code-block:: cmake
  327. FetchContent_Populate(FooBar)
  328. add_subdirectory(${foobar_SOURCE_DIR} ${foobar_BINARY_DIR})
  329. The values of the three variables can also be retrieved from anywhere in the
  330. project hierarchy using the :command:`FetchContent_GetProperties` command.
  331. The ``FetchContent_Populate()`` command also supports a syntax allowing the
  332. content details to be specified directly rather than using any saved
  333. details. This is more low-level and use of this form is generally to be
  334. avoided in favor of using saved content details as outlined above.
  335. Nevertheless, in certain situations it can be useful to invoke the content
  336. population as an isolated operation (typically as part of implementing some
  337. other higher level feature or when using CMake in script mode):
  338. .. code-block:: cmake
  339. FetchContent_Populate(
  340. <name>
  341. [QUIET]
  342. [SUBBUILD_DIR <subBuildDir>]
  343. [SOURCE_DIR <srcDir>]
  344. [BINARY_DIR <binDir>]
  345. ...
  346. )
  347. This form has a number of key differences to that where only ``<name>`` is
  348. provided:
  349. - All required population details are assumed to have been provided directly
  350. in the call to ``FetchContent_Populate()``. Any saved details for
  351. ``<name>`` are ignored.
  352. - No check is made for whether content for ``<name>`` has already been
  353. populated.
  354. - No global property is set to record that the population has occurred.
  355. - No global properties record the source or binary directories used for the
  356. populated content.
  357. - The ``FETCHCONTENT_FULLY_DISCONNECTED`` and
  358. ``FETCHCONTENT_UPDATES_DISCONNECTED`` cache variables are ignored.
  359. The ``<lowercaseName>_SOURCE_DIR`` and ``<lowercaseName>_BINARY_DIR``
  360. variables are still returned to the caller, but since these locations are
  361. not stored as global properties when this form is used, they are only
  362. available to the calling scope and below rather than the entire project
  363. hierarchy. No ``<lowercaseName>_POPULATED`` variable is set in the caller's
  364. scope with this form.
  365. The supported options for ``FetchContent_Populate()`` are the same as those
  366. for :command:`FetchContent_Declare()`. Those few options shown just
  367. above are either specific to ``FetchContent_Populate()`` or their behavior is
  368. slightly modified from how :command:`ExternalProject_Add` treats them:
  369. ``QUIET``
  370. The ``QUIET`` option can be given to hide the output associated with
  371. populating the specified content. If the population fails, the output will
  372. be shown regardless of whether this option was given or not so that the
  373. cause of the failure can be diagnosed. The global ``FETCHCONTENT_QUIET``
  374. cache variable has no effect on ``FetchContent_Populate()`` calls where the
  375. content details are provided directly.
  376. ``SUBBUILD_DIR``
  377. The ``SUBBUILD_DIR`` argument can be provided to change the location of the
  378. sub-build created to perform the population. The default value is
  379. ``${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-subbuild`` and it would be
  380. unusual to need to override this default. If a relative path is specified,
  381. it will be interpreted as relative to :variable:`CMAKE_CURRENT_BINARY_DIR`.
  382. This option should not be confused with the ``SOURCE_SUBDIR`` option which
  383. only affects the :command:`FetchContent_MakeAvailable` command.
  384. ``SOURCE_DIR``, ``BINARY_DIR``
  385. The ``SOURCE_DIR`` and ``BINARY_DIR`` arguments are supported by
  386. :command:`ExternalProject_Add`, but different default values are used by
  387. ``FetchContent_Populate()``. ``SOURCE_DIR`` defaults to
  388. ``${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-src`` and ``BINARY_DIR``
  389. defaults to ``${CMAKE_CURRENT_BINARY_DIR}/<lowercaseName>-build``.
  390. If a relative path is specified, it will be interpreted as relative to
  391. :variable:`CMAKE_CURRENT_BINARY_DIR`.
  392. In addition to the above explicit options, any other unrecognized options are
  393. passed through unmodified to :command:`ExternalProject_Add` to perform the
  394. download, patch and update steps. The following options are explicitly
  395. prohibited (they are disabled by the ``FetchContent_Populate()`` command):
  396. - ``CONFIGURE_COMMAND``
  397. - ``BUILD_COMMAND``
  398. - ``INSTALL_COMMAND``
  399. - ``TEST_COMMAND``
  400. If using ``FetchContent_Populate()`` within CMake's script mode, be aware
  401. that the implementation sets up a sub-build which therefore requires a CMake
  402. generator and build tool to be available. If these cannot be found by
  403. default, then the :variable:`CMAKE_GENERATOR` and/or
  404. :variable:`CMAKE_MAKE_PROGRAM` variables will need to be set appropriately
  405. on the command line invoking the script.
  406. .. versionadded:: 3.18
  407. Added support for the ``DOWNLOAD_NO_EXTRACT`` option.
  408. .. command:: FetchContent_GetProperties
  409. When using saved content details, a call to
  410. :command:`FetchContent_MakeAvailable` or :command:`FetchContent_Populate`
  411. records information in global properties which can be queried at any time.
  412. This information may include the source and binary directories associated with
  413. the content and also whether or not the content population has been processed
  414. during the current configure run.
  415. .. code-block:: cmake
  416. FetchContent_GetProperties(
  417. <name>
  418. [SOURCE_DIR <srcDirVar>]
  419. [BINARY_DIR <binDirVar>]
  420. [POPULATED <doneVar>]
  421. )
  422. The ``SOURCE_DIR``, ``BINARY_DIR`` and ``POPULATED`` options can be used to
  423. specify which properties should be retrieved. Each option accepts a value
  424. which is the name of the variable in which to store that property. Most of
  425. the time though, only ``<name>`` is given, in which case the call will then
  426. set the same variables as a call to
  427. :command:`FetchContent_MakeAvailable(name) <FetchContent_MakeAvailable>` or
  428. :command:`FetchContent_Populate(name) <FetchContent_Populate>`.
  429. Note that the ``SOURCE_DIR`` and ``BINARY_DIR`` values can be empty if the
  430. call is fulfilled by a :ref:`dependency provider <dependency_providers>`.
  431. This command is rarely needed when using
  432. :command:`FetchContent_MakeAvailable`. It is more commonly used as part of
  433. implementing the following pattern with :command:`FetchContent_Populate`,
  434. which ensures that the relevant variables will always be defined regardless
  435. of whether or not the population has been performed elsewhere in the project
  436. already:
  437. .. code-block:: cmake
  438. # Check if population has already been performed
  439. FetchContent_GetProperties(depname)
  440. if(NOT depname_POPULATED)
  441. # Fetch the content using previously declared details
  442. FetchContent_Populate(depname)
  443. # Set custom variables, policies, etc.
  444. # ...
  445. # Bring the populated content into the build
  446. add_subdirectory(${depname_SOURCE_DIR} ${depname_BINARY_DIR})
  447. endif()
  448. .. command:: FetchContent_SetPopulated
  449. .. versionadded:: 3.24
  450. .. note::
  451. This command should only be called by
  452. :ref:`dependency providers <dependency_providers>`. Calling it in any
  453. other context is unsupported and future CMake versions may halt with a
  454. fatal error in such cases.
  455. .. code-block:: cmake
  456. FetchContent_SetPopulated(
  457. <name>
  458. [SOURCE_DIR <srcDir>]
  459. [BINARY_DIR <binDir>]
  460. )
  461. If a provider command fulfills a ``FETCHCONTENT_MAKEAVAILABLE_SERIAL``
  462. request, it must call this function before returning. The ``SOURCE_DIR``
  463. and ``BINARY_DIR`` arguments can be used to specify the values that
  464. :command:`FetchContent_GetProperties` should return for its corresponding
  465. arguments. Only provide ``SOURCE_DIR`` and ``BINARY_DIR`` if they have
  466. the same meaning as if they had been populated by the built-in
  467. :command:`FetchContent_MakeAvailable` implementation.
  468. Variables
  469. ^^^^^^^^^
  470. A number of cache variables can influence the behavior where details from a
  471. :command:`FetchContent_Declare` call are used to populate content.
  472. .. note::
  473. All of these variables are intended for the developer to customize behavior.
  474. They should not normally be set by the project.
  475. .. variable:: FETCHCONTENT_BASE_DIR
  476. In most cases, the saved details do not specify any options relating to the
  477. directories to use for the internal sub-build, final source and build areas.
  478. It is generally best to leave these decisions up to the ``FetchContent``
  479. module to handle on the project's behalf. The ``FETCHCONTENT_BASE_DIR``
  480. cache variable controls the point under which all content population
  481. directories are collected, but in most cases, developers would not need to
  482. change this. The default location is ``${CMAKE_BINARY_DIR}/_deps``, but if
  483. developers change this value, they should aim to keep the path short and
  484. just below the top level of the build tree to avoid running into path
  485. length problems on Windows.
  486. .. variable:: FETCHCONTENT_QUIET
  487. The logging output during population can be quite verbose, making the
  488. configure stage quite noisy. This cache option (``ON`` by default) hides
  489. all population output unless an error is encountered. If experiencing
  490. problems with hung downloads, temporarily switching this option off may
  491. help diagnose which content population is causing the issue.
  492. .. variable:: FETCHCONTENT_FULLY_DISCONNECTED
  493. When this option is enabled, no attempt is made to download or update
  494. any content. It is assumed that all content has already been populated in
  495. a previous run or the source directories have been pointed at existing
  496. contents the developer has provided manually (using options described
  497. further below). When the developer knows that no changes have been made to
  498. any content details, turning this option ``ON`` can significantly speed up
  499. the configure stage. It is ``OFF`` by default.
  500. .. variable:: FETCHCONTENT_UPDATES_DISCONNECTED
  501. This is a less severe download/update control compared to
  502. :variable:`FETCHCONTENT_FULLY_DISCONNECTED`. Instead of bypassing all
  503. download and update logic, ``FETCHCONTENT_UPDATES_DISCONNECTED`` only
  504. disables the update stage. Therefore, if content has not been downloaded
  505. previously, it will still be downloaded when this option is enabled.
  506. This can speed up the configure stage, but not as much as
  507. :variable:`FETCHCONTENT_FULLY_DISCONNECTED`. It is ``OFF`` by default.
  508. .. variable:: FETCHCONTENT_TRY_FIND_PACKAGE_MODE
  509. .. versionadded:: 3.24
  510. This variable modifies the details that :command:`FetchContent_Declare`
  511. records for a given dependency. While it ultimately controls the behavior
  512. of :command:`FetchContent_MakeAvailable`, it is the variable's value when
  513. :command:`FetchContent_Declare` is called that gets used. It makes no
  514. difference what the variable is set to when
  515. :command:`FetchContent_MakeAvailable` is called. Since the variable should
  516. only be set by the user and not by projects directly, it will typically have
  517. the same value throughout anyway, so this distinction is not usually
  518. noticeable.
  519. ``FETCHCONTENT_TRY_FIND_PACKAGE_MODE`` ultimately controls whether
  520. :command:`FetchContent_MakeAvailable` is allowed to call
  521. :command:`find_package` to satisfy a dependency. The variable can be set
  522. to one of the following values:
  523. ``OPT_IN``
  524. :command:`FetchContent_MakeAvailable` will only call
  525. :command:`find_package` if the :command:`FetchContent_Declare` call
  526. included a ``FIND_PACKAGE_ARGS`` keyword. This is also the default
  527. behavior if ``FETCHCONTENT_TRY_FIND_PACKAGE_MODE`` is not set.
  528. ``ALWAYS``
  529. :command:`find_package` can be called by
  530. :command:`FetchContent_MakeAvailable` regardless of whether the
  531. :command:`FetchContent_Declare` call included a ``FIND_PACKAGE_ARGS``
  532. keyword or not. If no ``FIND_PACKAGE_ARGS`` keyword was given, the
  533. behavior will be as though ``FIND_PACKAGE_ARGS`` had been provided,
  534. with no additional arguments after it.
  535. ``NEVER``
  536. :command:`FetchContent_MakeAvailable` will not call
  537. :command:`find_package`. Any ``FIND_PACKAGE_ARGS`` given to the
  538. :command:`FetchContent_Declare` call will be ignored.
  539. As a special case, if the :variable:`FETCHCONTENT_SOURCE_DIR_<uppercaseName>`
  540. variable has a non-empty value for a dependency, it is assumed that the
  541. user is overriding all other methods of making that dependency available.
  542. ``FETCHCONTENT_TRY_FIND_PACKAGE_MODE`` will have no effect on that
  543. dependency and :command:`FetchContent_MakeAvailable` will not try to call
  544. :command:`find_package` for it.
  545. In addition to the above, the following variables are also defined for each
  546. content name:
  547. .. variable:: FETCHCONTENT_SOURCE_DIR_<uppercaseName>
  548. If this is set, no download or update steps are performed for the specified
  549. content and the ``<lowercaseName>_SOURCE_DIR`` variable returned to the
  550. caller is pointed at this location. This gives developers a way to have a
  551. separate checkout of the content that they can modify freely without
  552. interference from the build. The build simply uses that existing source,
  553. but it still defines ``<lowercaseName>_BINARY_DIR`` to point inside its own
  554. build area. Developers are strongly encouraged to use this mechanism rather
  555. than editing the sources populated in the default location, as changes to
  556. sources in the default location can be lost when content population details
  557. are changed by the project.
  558. .. variable:: FETCHCONTENT_UPDATES_DISCONNECTED_<uppercaseName>
  559. This is the per-content equivalent of
  560. :variable:`FETCHCONTENT_UPDATES_DISCONNECTED`. If the global option or
  561. this option is ``ON``, then updates will be disabled for the named content.
  562. Disabling updates for individual content can be useful for content whose
  563. details rarely change, while still leaving other frequently changing content
  564. with updates enabled.
  565. .. _`fetch-content-examples`:
  566. Examples
  567. ^^^^^^^^
  568. Typical Case
  569. """"""""""""
  570. This first fairly straightforward example ensures that some popular testing
  571. frameworks are available to the main build:
  572. .. code-block:: cmake
  573. include(FetchContent)
  574. FetchContent_Declare(
  575. googletest
  576. GIT_REPOSITORY https://github.com/google/googletest.git
  577. GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  578. )
  579. FetchContent_Declare(
  580. Catch2
  581. GIT_REPOSITORY https://github.com/catchorg/Catch2.git
  582. GIT_TAG de6fe184a9ac1a06895cdd1c9b437f0a0bdf14ad # v2.13.4
  583. )
  584. # After the following call, the CMake targets defined by googletest and
  585. # Catch2 will be available to the rest of the build
  586. FetchContent_MakeAvailable(googletest Catch2)
  587. .. _FetchContent-find_package-integration-examples:
  588. Integrating With find_package()
  589. """""""""""""""""""""""""""""""
  590. For the previous example, if the user wanted to try to find ``googletest``
  591. and ``Catch2`` via :command:`find_package` first before trying to download
  592. and build them from source, they could set the
  593. :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` variable to ``ALWAYS``.
  594. This would also affect any other calls to :command:`FetchContent_Declare`
  595. throughout the project, which might not be acceptable. The behavior can be
  596. enabled for just these two dependencies instead by adding ``FIND_PACKAGE_ARGS``
  597. to the declared details and leaving
  598. :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` unset, or set to ``OPT_IN``:
  599. .. code-block:: cmake
  600. include(FetchContent)
  601. FetchContent_Declare(
  602. googletest
  603. GIT_REPOSITORY https://github.com/google/googletest.git
  604. GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  605. FIND_PACKAGE_ARGS NAMES gtest
  606. )
  607. FetchContent_Declare(
  608. Catch2
  609. GIT_REPOSITORY https://github.com/catchorg/Catch2.git
  610. GIT_TAG de6fe184a9ac1a06895cdd1c9b437f0a0bdf14ad # v2.13.4
  611. FIND_PACKAGE_ARGS
  612. )
  613. # This will try calling find_package() first for both dependencies
  614. FetchContent_MakeAvailable(googletest Catch2)
  615. For ``Catch2``, no additional arguments to :command:`find_package` are needed,
  616. so no additional arguments are provided after the ``FIND_PACKAGE_ARGS``
  617. keyword. For ``googletest``, its package is more commonly called ``gtest``,
  618. so arguments are added to support it being found by that name.
  619. If the user wanted to disable :command:`FetchContent_MakeAvailable` from
  620. calling :command:`find_package` for any dependency, even if it provided
  621. ``FIND_PACKAGE_ARGS`` in its declared details, they could set
  622. :variable:`FETCHCONTENT_TRY_FIND_PACKAGE_MODE` to ``NEVER``.
  623. If the project wanted to indicate that these two dependencies should be
  624. downloaded and built from source and that :command:`find_package` calls
  625. should be redirected to use the built dependencies, the
  626. ``OVERRIDE_FIND_PACKAGE`` option should be used when declaring the content
  627. details:
  628. .. code-block:: cmake
  629. include(FetchContent)
  630. FetchContent_Declare(
  631. googletest
  632. GIT_REPOSITORY https://github.com/google/googletest.git
  633. GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  634. OVERRIDE_FIND_PACKAGE
  635. )
  636. FetchContent_Declare(
  637. Catch2
  638. GIT_REPOSITORY https://github.com/catchorg/Catch2.git
  639. GIT_TAG de6fe184a9ac1a06895cdd1c9b437f0a0bdf14ad # v2.13.4
  640. OVERRIDE_FIND_PACKAGE
  641. )
  642. # The following will automatically forward through to FetchContent_MakeAvailable()
  643. find_package(googletest)
  644. find_package(Catch2)
  645. CMake provides a FindGTest module which defines some variables that older
  646. projects may use instead of linking to the imported targets. To support
  647. those cases, we can provide an extras file. In keeping with the
  648. "first to define, wins" philosophy of ``FetchContent``, we only write out
  649. that file if something else hasn't already done so.
  650. .. code-block:: cmake
  651. FetchContent_MakeAvailable(googletest)
  652. if(NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/googletest-extras.cmake AND
  653. NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/googletestExtras.cmake)
  654. file(WRITE ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/googletest-extras.cmake
  655. [=[
  656. if("${GTEST_LIBRARIES}" STREQUAL "" AND TARGET GTest::gtest)
  657. set(GTEST_LIBRARIES GTest::gtest)
  658. endif()
  659. if("${GTEST_MAIN_LIBRARIES}" STREQUAL "" AND TARGET GTest::gtest_main)
  660. set(GTEST_MAIN_LIBRARIES GTest::gtest_main)
  661. endif()
  662. if("${GTEST_BOTH_LIBRARIES}" STREQUAL "")
  663. set(GTEST_BOTH_LIBRARIES ${GTEST_LIBRARIES} ${GTEST_MAIN_LIBRARIES})
  664. endif()
  665. ]=]
  666. endif()
  667. Projects will also likely be using ``find_package(GTest)`` rather than
  668. ``find_package(googletest)``, but it is possible to make use of the
  669. :variable:`CMAKE_FIND_PACKAGE_REDIRECTS_DIR` area to pull in the latter as
  670. a dependency of the former. This is likely to be sufficient to satisfy
  671. a typical ``find_package(GTest)`` call.
  672. .. code-block:: cmake
  673. FetchContent_MakeAvailable(googletest)
  674. if(NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/gtest-config.cmake AND
  675. NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/GTestConfig.cmake)
  676. file(WRITE ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/gtest-config.cmake
  677. [=[
  678. include(CMakeFindDependencyMacro)
  679. find_dependency(googletest)
  680. ]=]
  681. endif()
  682. if(NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/gtest-config-version.cmake AND
  683. NOT EXISTS ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/GTestConfigVersion.cmake)
  684. file(WRITE ${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/gtest-config-version.cmake
  685. [=[
  686. include(${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/googletest-config-version.cmake OPTIONAL)
  687. if(NOT PACKAGE_VERSION_COMPATIBLE)
  688. include(${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/googletestConfigVersion.cmake OPTIONAL)
  689. endif()
  690. ]=]
  691. endif()
  692. Overriding Where To Find CMakeLists.txt
  693. """""""""""""""""""""""""""""""""""""""
  694. If the sub-project's ``CMakeLists.txt`` file is not at the top level of its
  695. source tree, the ``SOURCE_SUBDIR`` option can be used to tell ``FetchContent``
  696. where to find it. The following example shows how to use that option and
  697. it also sets a variable which is meaningful to the subproject before pulling
  698. it into the main build:
  699. .. code-block:: cmake
  700. include(FetchContent)
  701. FetchContent_Declare(
  702. protobuf
  703. GIT_REPOSITORY https://github.com/protocolbuffers/protobuf.git
  704. GIT_TAG ae50d9b9902526efd6c7a1907d09739f959c6297 # v3.15.0
  705. SOURCE_SUBDIR cmake
  706. )
  707. set(protobuf_BUILD_TESTS OFF)
  708. FetchContent_MakeAvailable(protobuf)
  709. Complex Dependency Hierarchies
  710. """"""""""""""""""""""""""""""
  711. In more complex project hierarchies, the dependency relationships can be more
  712. complicated. Consider a hierarchy where ``projA`` is the top level project and
  713. it depends directly on projects ``projB`` and ``projC``. Both ``projB`` and
  714. ``projC`` can be built standalone and they also both depend on another project
  715. ``projD``. ``projB`` additionally depends on ``projE``. This example assumes
  716. that all five projects are available on a company git server. The
  717. ``CMakeLists.txt`` of each project might have sections like the following:
  718. *projA*:
  719. .. code-block:: cmake
  720. include(FetchContent)
  721. FetchContent_Declare(
  722. projB
  723. GIT_REPOSITORY [email protected]:git/projB.git
  724. GIT_TAG 4a89dc7e24ff212a7b5167bef7ab079d
  725. )
  726. FetchContent_Declare(
  727. projC
  728. GIT_REPOSITORY [email protected]:git/projC.git
  729. GIT_TAG 4ad4016bd1d8d5412d135cf8ceea1bb9
  730. )
  731. FetchContent_Declare(
  732. projD
  733. GIT_REPOSITORY [email protected]:git/projD.git
  734. GIT_TAG origin/integrationBranch
  735. )
  736. FetchContent_Declare(
  737. projE
  738. GIT_REPOSITORY [email protected]:git/projE.git
  739. GIT_TAG v2.3-rc1
  740. )
  741. # Order is important, see notes in the discussion further below
  742. FetchContent_MakeAvailable(projD projB projC)
  743. *projB*:
  744. .. code-block:: cmake
  745. include(FetchContent)
  746. FetchContent_Declare(
  747. projD
  748. GIT_REPOSITORY [email protected]:git/projD.git
  749. GIT_TAG 20b415f9034bbd2a2e8216e9a5c9e632
  750. )
  751. FetchContent_Declare(
  752. projE
  753. GIT_REPOSITORY [email protected]:git/projE.git
  754. GIT_TAG 68e20f674a48be38d60e129f600faf7d
  755. )
  756. FetchContent_MakeAvailable(projD projE)
  757. *projC*:
  758. .. code-block:: cmake
  759. include(FetchContent)
  760. FetchContent_Declare(
  761. projD
  762. GIT_REPOSITORY [email protected]:git/projD.git
  763. GIT_TAG 7d9a17ad2c962aa13e2fbb8043fb6b8a
  764. )
  765. # This particular version of projD requires workarounds
  766. FetchContent_GetProperties(projD)
  767. if(NOT projd_POPULATED)
  768. FetchContent_Populate(projD)
  769. # Copy an additional/replacement file into the populated source
  770. file(COPY someFile.c DESTINATION ${projd_SOURCE_DIR}/src)
  771. add_subdirectory(${projd_SOURCE_DIR} ${projd_BINARY_DIR})
  772. endif()
  773. A few key points should be noted in the above:
  774. - ``projB`` and ``projC`` define different content details for ``projD``,
  775. but ``projA`` also defines a set of content details for ``projD``.
  776. Because ``projA`` will define them first, the details from ``projB`` and
  777. ``projC`` will not be used. The override details defined by ``projA``
  778. are not required to match either of those from ``projB`` or ``projC``, but
  779. it is up to the higher level project to ensure that the details it does
  780. define still make sense for the child projects.
  781. - In the ``projA`` call to :command:`FetchContent_MakeAvailable`, ``projD``
  782. is listed ahead of ``projB`` and ``projC`` to ensure that ``projA`` is in
  783. control of how ``projD`` is populated.
  784. - While ``projA`` defines content details for ``projE``, it does not need
  785. to explicitly call ``FetchContent_MakeAvailable(projE)`` or
  786. ``FetchContent_Populate(projD)`` itself. Instead, it leaves that to the
  787. child ``projB``. For higher level projects, it is often enough to just
  788. define the override content details and leave the actual population to the
  789. child projects. This saves repeating the same thing at each level of the
  790. project hierarchy unnecessarily.
  791. Populating Content Without Adding It To The Build
  792. """""""""""""""""""""""""""""""""""""""""""""""""
  793. Projects don't always need to add the populated content to the build.
  794. Sometimes the project just wants to make the downloaded content available at
  795. a predictable location. The next example ensures that a set of standard
  796. company toolchain files (and potentially even the toolchain binaries
  797. themselves) is available early enough to be used for that same build.
  798. .. code-block:: cmake
  799. cmake_minimum_required(VERSION 3.14)
  800. include(FetchContent)
  801. FetchContent_Declare(
  802. mycom_toolchains
  803. URL https://intranet.mycompany.com//toolchains_1.3.2.tar.gz
  804. )
  805. FetchContent_MakeAvailable(mycom_toolchains)
  806. project(CrossCompileExample)
  807. The project could be configured to use one of the downloaded toolchains like
  808. so:
  809. .. code-block:: shell
  810. cmake -DCMAKE_TOOLCHAIN_FILE=_deps/mycom_toolchains-src/toolchain_arm.cmake /path/to/src
  811. When CMake processes the ``CMakeLists.txt`` file, it will download and unpack
  812. the tarball into ``_deps/mycompany_toolchains-src`` relative to the build
  813. directory. The :variable:`CMAKE_TOOLCHAIN_FILE` variable is not used until
  814. the :command:`project` command is reached, at which point CMake looks for the
  815. named toolchain file relative to the build directory. Because the tarball has
  816. already been downloaded and unpacked by then, the toolchain file will be in
  817. place, even the very first time that ``cmake`` is run in the build directory.
  818. Populating Content In CMake Script Mode
  819. """""""""""""""""""""""""""""""""""""""
  820. This last example demonstrates how one might download and unpack a
  821. firmware tarball using CMake's :manual:`script mode <cmake(1)>`. The call to
  822. :command:`FetchContent_Populate` specifies all the content details and the
  823. unpacked firmware will be placed in a ``firmware`` directory below the
  824. current working directory.
  825. *getFirmware.cmake*:
  826. .. code-block:: cmake
  827. # NOTE: Intended to be run in script mode with cmake -P
  828. include(FetchContent)
  829. FetchContent_Populate(
  830. firmware
  831. URL https://mycompany.com/assets/firmware-1.23-arm.tar.gz
  832. URL_HASH MD5=68247684da89b608d466253762b0ff11
  833. SOURCE_DIR firmware
  834. )
  835. #]=======================================================================]
  836. #=======================================================================
  837. # Recording and retrieving content details for later population
  838. #=======================================================================
  839. # Internal use, projects must not call this directly. It is
  840. # intended for use by FetchContent_Declare() only.
  841. #
  842. # Sets a content-specific global property (not meant for use
  843. # outside of functions defined here in this file) which can later
  844. # be retrieved using __FetchContent_getSavedDetails() with just the
  845. # same content name. If there is already a value stored in the
  846. # property, it is left unchanged and this call has no effect.
  847. # This allows parent projects to define the content details,
  848. # overriding anything a child project may try to set (properties
  849. # are not cached between runs, so the first thing to set it in a
  850. # build will be in control).
  851. function(__FetchContent_declareDetails contentName)
  852. string(TOLOWER ${contentName} contentNameLower)
  853. set(savedDetailsPropertyName "_FetchContent_${contentNameLower}_savedDetails")
  854. get_property(alreadyDefined GLOBAL PROPERTY ${savedDetailsPropertyName} DEFINED)
  855. if(alreadyDefined)
  856. return()
  857. endif()
  858. if("${FETCHCONTENT_TRY_FIND_PACKAGE_MODE}" STREQUAL "ALWAYS")
  859. set(__tryFindPackage TRUE)
  860. set(__tryFindPackageAllowed TRUE)
  861. elseif("${FETCHCONTENT_TRY_FIND_PACKAGE_MODE}" STREQUAL "NEVER")
  862. set(__tryFindPackage FALSE)
  863. set(__tryFindPackageAllowed FALSE)
  864. elseif("${FETCHCONTENT_TRY_FIND_PACKAGE_MODE}" STREQUAL "OPT_IN" OR
  865. NOT DEFINED FETCHCONTENT_TRY_FIND_PACKAGE_MODE)
  866. set(__tryFindPackage FALSE)
  867. set(__tryFindPackageAllowed TRUE)
  868. else()
  869. message(FATAL_ERROR
  870. "Unsupported value for FETCHCONTENT_TRY_FIND_PACKAGE_MODE: "
  871. "${FETCHCONTENT_TRY_FIND_PACKAGE_MODE}"
  872. )
  873. endif()
  874. set(__cmdArgs)
  875. set(__findPackageArgs)
  876. foreach(__item IN LISTS ARGN)
  877. if(DEFINED __findPackageArgs)
  878. # All remaining args are for find_package()
  879. string(APPEND __findPackageArgs " [==[${__item}]==]")
  880. continue()
  881. endif()
  882. # Still processing non-find_package() args
  883. if(__item STREQUAL "FIND_PACKAGE_ARGS")
  884. if(__tryFindPackageAllowed)
  885. set(__tryFindPackage TRUE)
  886. endif()
  887. # All arguments after this keyword are for find_package(). Define the
  888. # variable but with an empty value initially. This allows us to check
  889. # at the start of the loop whether to store remaining items in this
  890. # variable or not. Note that there could be no more args, which is still
  891. # a valid case because we automatically provide ${contentName} as the
  892. # package name and there may not need to be any further arguments.
  893. set(__findPackageArgs "")
  894. continue() # Don't store this item
  895. elseif(__item STREQUAL "OVERRIDE_FIND_PACKAGE")
  896. set(__tryFindPackageAllowed FALSE)
  897. # Define a separate dedicated property for find_package() to check
  898. # in its implementation. This will be a placeholder until FetchContent
  899. # actually does the population. After that, we will have created a
  900. # stand-in config file that find_package() will pick up instead.
  901. set(propertyName "_FetchContent_${contentNameLower}_override_find_package")
  902. define_property(GLOBAL PROPERTY ${propertyName})
  903. set_property(GLOBAL PROPERTY ${propertyName} TRUE)
  904. endif()
  905. string(APPEND __cmdArgs " [==[${__item}]==]")
  906. endforeach()
  907. define_property(GLOBAL PROPERTY ${savedDetailsPropertyName})
  908. cmake_language(EVAL CODE
  909. "set_property(GLOBAL PROPERTY ${savedDetailsPropertyName} ${__cmdArgs})"
  910. )
  911. if(__tryFindPackage AND __tryFindPackageAllowed)
  912. set(propertyName "_FetchContent_${contentNameLower}_find_package_args")
  913. define_property(GLOBAL PROPERTY ${propertyName})
  914. if(NOT QUIET IN_LIST __findPackageArgs)
  915. list(INSERT __findPackageArgs 0 QUIET)
  916. endif()
  917. cmake_language(EVAL CODE
  918. "set_property(GLOBAL PROPERTY ${propertyName} ${__findPackageArgs})"
  919. )
  920. endif()
  921. endfunction()
  922. # Internal use, projects must not call this directly. It is
  923. # intended for use by the FetchContent_Declare() function.
  924. #
  925. # Retrieves details saved for the specified content in an
  926. # earlier call to __FetchContent_declareDetails().
  927. function(__FetchContent_getSavedDetails contentName outVar)
  928. string(TOLOWER ${contentName} contentNameLower)
  929. set(propertyName "_FetchContent_${contentNameLower}_savedDetails")
  930. get_property(alreadyDefined GLOBAL PROPERTY ${propertyName} DEFINED)
  931. if(NOT alreadyDefined)
  932. message(FATAL_ERROR "No content details recorded for ${contentName}")
  933. endif()
  934. get_property(propertyValue GLOBAL PROPERTY ${propertyName})
  935. set(${outVar} "${propertyValue}" PARENT_SCOPE)
  936. endfunction()
  937. # Saves population details of the content, sets defaults for the
  938. # SOURCE_DIR and BUILD_DIR.
  939. function(FetchContent_Declare contentName)
  940. # Always check this even if we won't save these details.
  941. # This helps projects catch errors earlier.
  942. if("OVERRIDE_FIND_PACKAGE" IN_LIST ARGN AND "FIND_PACKAGE_ARGS" IN_LIST ARGN)
  943. message(FATAL_ERROR
  944. "Cannot specify both OVERRIDE_FIND_PACKAGE and FIND_PACKAGE_ARGS "
  945. "when declaring details for ${contentName}"
  946. )
  947. endif()
  948. set(options "")
  949. set(oneValueArgs
  950. SVN_REPOSITORY
  951. DOWNLOAD_NO_EXTRACT
  952. DOWNLOAD_EXTRACT_TIMESTAMP
  953. URL
  954. BINARY_DIR
  955. SOURCE_DIR
  956. )
  957. set(multiValueArgs "")
  958. cmake_parse_arguments(PARSE_ARGV 1 ARG
  959. "${options}" "${oneValueArgs}" "${multiValueArgs}")
  960. string(TOLOWER ${contentName} contentNameLower)
  961. if(NOT ARG_BINARY_DIR)
  962. set(ARG_BINARY_DIR "${FETCHCONTENT_BASE_DIR}/${contentNameLower}-build")
  963. endif()
  964. if(NOT ARG_SOURCE_DIR)
  965. set(ARG_SOURCE_DIR "${FETCHCONTENT_BASE_DIR}/${contentNameLower}-src")
  966. endif()
  967. if(ARG_SVN_REPOSITORY)
  968. # Add a hash of the svn repository URL to the source dir. This works
  969. # around the problem where if the URL changes, the download would
  970. # fail because it tries to checkout/update rather than switch the
  971. # old URL to the new one. We limit the hash to the first 7 characters
  972. # so that the source path doesn't get overly long (which can be a
  973. # problem on windows due to path length limits).
  974. string(SHA1 urlSHA ${ARG_SVN_REPOSITORY})
  975. string(SUBSTRING ${urlSHA} 0 7 urlSHA)
  976. string(APPEND ARG_SOURCE_DIR "-${urlSHA}")
  977. endif()
  978. # The ExternalProject_Add() call in the sub-build won't see the CMP0135
  979. # policy setting of our caller. Work out if that policy will be needed and
  980. # explicitly set the relevant option if not already provided. The condition
  981. # here is essentially an abbreviated version of the logic in
  982. # ExternalProject's _ep_add_download_command() function.
  983. if(ARG_URL AND
  984. NOT IS_DIRECTORY "${ARG_URL}" AND
  985. NOT ARG_DOWNLOAD_NO_EXTRACT AND
  986. NOT DEFINED ARG_DOWNLOAD_EXTRACT_TIMESTAMP)
  987. cmake_policy(GET CMP0135 _FETCHCONTENT_CMP0135
  988. PARENT_SCOPE # undocumented, do not use outside of CMake
  989. )
  990. if(_FETCHCONTENT_CMP0135 STREQUAL "")
  991. message(AUTHOR_WARNING
  992. "The DOWNLOAD_EXTRACT_TIMESTAMP option was not given and policy "
  993. "CMP0135 is not set. The policy's OLD behavior will be used. "
  994. "When using a URL download, the timestamps of extracted files "
  995. "should preferably be that of the time of extraction, otherwise "
  996. "code that depends on the extracted contents might not be "
  997. "rebuilt if the URL changes. The OLD behavior preserves the "
  998. "timestamps from the archive instead, but this is usually not "
  999. "what you want. Update your project to the NEW behavior or "
  1000. "specify the DOWNLOAD_EXTRACT_TIMESTAMP option with a value of "
  1001. "true to avoid this robustness issue."
  1002. )
  1003. set(ARG_DOWNLOAD_EXTRACT_TIMESTAMP TRUE)
  1004. elseif(_FETCHCONTENT_CMP0135 STREQUAL "NEW")
  1005. set(ARG_DOWNLOAD_EXTRACT_TIMESTAMP FALSE)
  1006. else()
  1007. set(ARG_DOWNLOAD_EXTRACT_TIMESTAMP TRUE)
  1008. endif()
  1009. endif()
  1010. # Add back in the keyword args we pulled out and potentially tweaked/added
  1011. foreach(key IN LISTS oneValueArgs)
  1012. if(DEFINED ARG_${key})
  1013. list(PREPEND ARG_UNPARSED_ARGUMENTS ${key} "${ARG_${key}}")
  1014. endif()
  1015. endforeach()
  1016. set(__argsQuoted)
  1017. foreach(__item IN LISTS ARG_UNPARSED_ARGUMENTS)
  1018. string(APPEND __argsQuoted " [==[${__item}]==]")
  1019. endforeach()
  1020. cmake_language(EVAL CODE
  1021. "__FetchContent_declareDetails(${contentNameLower} ${__argsQuoted})"
  1022. )
  1023. endfunction()
  1024. #=======================================================================
  1025. # Set/get whether the specified content has been populated yet.
  1026. # The setter also records the source and binary dirs used.
  1027. #=======================================================================
  1028. # Semi-internal use. Projects must not call this directly. Dependency
  1029. # providers must call it if they satisfy a request made with the
  1030. # FETCHCONTENT_MAKEAVAILABLE_SERIAL method (that is the only permitted
  1031. # place to call it outside of the FetchContent module).
  1032. function(FetchContent_SetPopulated contentName)
  1033. cmake_parse_arguments(PARSE_ARGV 1 arg
  1034. ""
  1035. "SOURCE_DIR;BINARY_DIR"
  1036. ""
  1037. )
  1038. if(NOT "${arg_UNPARSED_ARGUMENTS}" STREQUAL "")
  1039. message(FATAL_ERROR "Unsupported arguments: ${arg_UNPARSED_ARGUMENTS}")
  1040. endif()
  1041. string(TOLOWER ${contentName} contentNameLower)
  1042. set(prefix "_FetchContent_${contentNameLower}")
  1043. set(propertyName "${prefix}_sourceDir")
  1044. define_property(GLOBAL PROPERTY ${propertyName})
  1045. if("${arg_SOURCE_DIR}" STREQUAL "")
  1046. # Don't discard a previously provided SOURCE_DIR
  1047. get_property(arg_SOURCE_DIR GLOBAL PROPERTY ${propertyName})
  1048. endif()
  1049. set_property(GLOBAL PROPERTY ${propertyName} "${arg_SOURCE_DIR}")
  1050. set(propertyName "${prefix}_binaryDir")
  1051. define_property(GLOBAL PROPERTY ${propertyName})
  1052. if("${arg_BINARY_DIR}" STREQUAL "")
  1053. # Don't discard a previously provided BINARY_DIR
  1054. get_property(arg_BINARY_DIR GLOBAL PROPERTY ${propertyName})
  1055. endif()
  1056. set_property(GLOBAL PROPERTY ${propertyName} "${arg_BINARY_DIR}")
  1057. set(propertyName "${prefix}_populated")
  1058. define_property(GLOBAL PROPERTY ${propertyName})
  1059. set_property(GLOBAL PROPERTY ${propertyName} TRUE)
  1060. endfunction()
  1061. # Set variables in the calling scope for any of the retrievable
  1062. # properties. If no specific properties are requested, variables
  1063. # will be set for all retrievable properties.
  1064. #
  1065. # This function is intended to also be used by projects as the canonical
  1066. # way to detect whether they should call FetchContent_Populate()
  1067. # and pull the populated source into the build with add_subdirectory(),
  1068. # if they are using the populated content in that way.
  1069. function(FetchContent_GetProperties contentName)
  1070. string(TOLOWER ${contentName} contentNameLower)
  1071. set(options "")
  1072. set(oneValueArgs SOURCE_DIR BINARY_DIR POPULATED)
  1073. set(multiValueArgs "")
  1074. cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  1075. if(NOT ARG_SOURCE_DIR AND
  1076. NOT ARG_BINARY_DIR AND
  1077. NOT ARG_POPULATED)
  1078. # No specific properties requested, provide them all
  1079. set(ARG_SOURCE_DIR ${contentNameLower}_SOURCE_DIR)
  1080. set(ARG_BINARY_DIR ${contentNameLower}_BINARY_DIR)
  1081. set(ARG_POPULATED ${contentNameLower}_POPULATED)
  1082. endif()
  1083. set(prefix "_FetchContent_${contentNameLower}")
  1084. if(ARG_SOURCE_DIR)
  1085. set(propertyName "${prefix}_sourceDir")
  1086. get_property(value GLOBAL PROPERTY ${propertyName})
  1087. if(value)
  1088. set(${ARG_SOURCE_DIR} ${value} PARENT_SCOPE)
  1089. endif()
  1090. endif()
  1091. if(ARG_BINARY_DIR)
  1092. set(propertyName "${prefix}_binaryDir")
  1093. get_property(value GLOBAL PROPERTY ${propertyName})
  1094. if(value)
  1095. set(${ARG_BINARY_DIR} ${value} PARENT_SCOPE)
  1096. endif()
  1097. endif()
  1098. if(ARG_POPULATED)
  1099. set(propertyName "${prefix}_populated")
  1100. get_property(value GLOBAL PROPERTY ${propertyName} DEFINED)
  1101. set(${ARG_POPULATED} ${value} PARENT_SCOPE)
  1102. endif()
  1103. endfunction()
  1104. #=======================================================================
  1105. # Performing the population
  1106. #=======================================================================
  1107. # The value of contentName will always have been lowercased by the caller.
  1108. # All other arguments are assumed to be options that are understood by
  1109. # ExternalProject_Add(), except for QUIET and SUBBUILD_DIR.
  1110. function(__FetchContent_directPopulate contentName)
  1111. set(options
  1112. QUIET
  1113. )
  1114. set(oneValueArgs
  1115. SUBBUILD_DIR
  1116. SOURCE_DIR
  1117. BINARY_DIR
  1118. # We need special processing if DOWNLOAD_NO_EXTRACT is true
  1119. DOWNLOAD_NO_EXTRACT
  1120. # Prevent the following from being passed through
  1121. CONFIGURE_COMMAND
  1122. BUILD_COMMAND
  1123. INSTALL_COMMAND
  1124. TEST_COMMAND
  1125. # We force these to be ON since we are always executing serially
  1126. # and we want all steps to have access to the terminal in case they
  1127. # need input from the command line (e.g. ask for a private key password)
  1128. # or they want to provide timely progress. We silently absorb and
  1129. # discard these if they are set by the caller.
  1130. USES_TERMINAL_DOWNLOAD
  1131. USES_TERMINAL_UPDATE
  1132. USES_TERMINAL_PATCH
  1133. )
  1134. set(multiValueArgs "")
  1135. cmake_parse_arguments(PARSE_ARGV 1 ARG
  1136. "${options}" "${oneValueArgs}" "${multiValueArgs}")
  1137. if(NOT ARG_SUBBUILD_DIR)
  1138. message(FATAL_ERROR "Internal error: SUBBUILD_DIR not set")
  1139. elseif(NOT IS_ABSOLUTE "${ARG_SUBBUILD_DIR}")
  1140. set(ARG_SUBBUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/${ARG_SUBBUILD_DIR}")
  1141. endif()
  1142. if(NOT ARG_SOURCE_DIR)
  1143. message(FATAL_ERROR "Internal error: SOURCE_DIR not set")
  1144. elseif(NOT IS_ABSOLUTE "${ARG_SOURCE_DIR}")
  1145. set(ARG_SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/${ARG_SOURCE_DIR}")
  1146. endif()
  1147. if(NOT ARG_BINARY_DIR)
  1148. message(FATAL_ERROR "Internal error: BINARY_DIR not set")
  1149. elseif(NOT IS_ABSOLUTE "${ARG_BINARY_DIR}")
  1150. set(ARG_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/${ARG_BINARY_DIR}")
  1151. endif()
  1152. # Ensure the caller can know where to find the source and build directories
  1153. # with some convenient variables. Doing this here ensures the caller sees
  1154. # the correct result in the case where the default values are overridden by
  1155. # the content details set by the project.
  1156. set(${contentName}_SOURCE_DIR "${ARG_SOURCE_DIR}" PARENT_SCOPE)
  1157. set(${contentName}_BINARY_DIR "${ARG_BINARY_DIR}" PARENT_SCOPE)
  1158. # The unparsed arguments may contain spaces, so build up ARG_EXTRA
  1159. # in such a way that it correctly substitutes into the generated
  1160. # CMakeLists.txt file with each argument quoted.
  1161. unset(ARG_EXTRA)
  1162. foreach(arg IN LISTS ARG_UNPARSED_ARGUMENTS)
  1163. set(ARG_EXTRA "${ARG_EXTRA} \"${arg}\"")
  1164. endforeach()
  1165. if(ARG_DOWNLOAD_NO_EXTRACT)
  1166. set(ARG_EXTRA "${ARG_EXTRA} DOWNLOAD_NO_EXTRACT YES")
  1167. set(__FETCHCONTENT_COPY_FILE
  1168. "
  1169. ExternalProject_Get_Property(${contentName}-populate DOWNLOADED_FILE)
  1170. get_filename_component(dlFileName \"\${DOWNLOADED_FILE}\" NAME)
  1171. ExternalProject_Add_Step(${contentName}-populate copyfile
  1172. COMMAND \"${CMAKE_COMMAND}\" -E copy_if_different
  1173. \"<DOWNLOADED_FILE>\" \"${ARG_SOURCE_DIR}\"
  1174. DEPENDEES patch
  1175. DEPENDERS configure
  1176. BYPRODUCTS \"${ARG_SOURCE_DIR}/\${dlFileName}\"
  1177. COMMENT \"Copying file to SOURCE_DIR\"
  1178. )
  1179. ")
  1180. else()
  1181. unset(__FETCHCONTENT_COPY_FILE)
  1182. endif()
  1183. # Hide output if requested, but save it to a variable in case there's an
  1184. # error so we can show the output upon failure. When not quiet, don't
  1185. # capture the output to a variable because the user may want to see the
  1186. # output as it happens (e.g. progress during long downloads). Combine both
  1187. # stdout and stderr in the one capture variable so the output stays in order.
  1188. if (ARG_QUIET)
  1189. set(outputOptions
  1190. OUTPUT_VARIABLE capturedOutput
  1191. ERROR_VARIABLE capturedOutput
  1192. )
  1193. else()
  1194. set(capturedOutput)
  1195. set(outputOptions)
  1196. message(STATUS "Populating ${contentName}")
  1197. endif()
  1198. if(CMAKE_GENERATOR)
  1199. set(subCMakeOpts "-G${CMAKE_GENERATOR}")
  1200. if(CMAKE_GENERATOR_PLATFORM)
  1201. list(APPEND subCMakeOpts "-A${CMAKE_GENERATOR_PLATFORM}")
  1202. endif()
  1203. if(CMAKE_GENERATOR_TOOLSET)
  1204. list(APPEND subCMakeOpts "-T${CMAKE_GENERATOR_TOOLSET}")
  1205. endif()
  1206. if(CMAKE_MAKE_PROGRAM)
  1207. list(APPEND subCMakeOpts "-DCMAKE_MAKE_PROGRAM:FILEPATH=${CMAKE_MAKE_PROGRAM}")
  1208. endif()
  1209. # Override the sub-build's configuration types for multi-config generators.
  1210. # This ensures we are not affected by any custom setting from the project
  1211. # and can always request a known configuration further below.
  1212. get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
  1213. if(is_multi_config)
  1214. list(APPEND subCMakeOpts "-DCMAKE_CONFIGURATION_TYPES:STRING=Debug")
  1215. endif()
  1216. else()
  1217. # Likely we've been invoked via CMake's script mode where no
  1218. # generator is set (and hence CMAKE_MAKE_PROGRAM could not be
  1219. # trusted even if provided). We will have to rely on being
  1220. # able to find the default generator and build tool.
  1221. unset(subCMakeOpts)
  1222. endif()
  1223. set(__FETCHCONTENT_CACHED_INFO "")
  1224. set(__passthrough_vars
  1225. CMAKE_EP_GIT_REMOTE_UPDATE_STRATEGY
  1226. CMAKE_TLS_VERIFY
  1227. CMAKE_TLS_CAINFO
  1228. CMAKE_NETRC
  1229. CMAKE_NETRC_FILE
  1230. )
  1231. foreach(var IN LISTS __passthrough_vars)
  1232. if(DEFINED ${var})
  1233. # Embed directly in the generated CMakeLists.txt file to avoid making
  1234. # the cmake command line excessively long. It also makes debugging and
  1235. # testing easier.
  1236. string(APPEND __FETCHCONTENT_CACHED_INFO "set(${var} [==[${${var}}]==])\n")
  1237. endif()
  1238. endforeach()
  1239. # Avoid using if(... IN_LIST ...) so we don't have to alter policy settings
  1240. list(FIND ARG_UNPARSED_ARGUMENTS GIT_REPOSITORY indexResult)
  1241. if(indexResult GREATER_EQUAL 0)
  1242. find_package(Git QUIET)
  1243. string(APPEND __FETCHCONTENT_CACHED_INFO "
  1244. # Pass through things we've already detected in the main project to avoid
  1245. # paying the cost of redetecting them again in ExternalProject_Add()
  1246. set(GIT_EXECUTABLE [==[${GIT_EXECUTABLE}]==])
  1247. set(GIT_VERSION_STRING [==[${GIT_VERSION_STRING}]==])
  1248. set_property(GLOBAL PROPERTY _CMAKE_FindGit_GIT_EXECUTABLE_VERSION
  1249. [==[${GIT_EXECUTABLE};${GIT_VERSION_STRING}]==]
  1250. )
  1251. ")
  1252. endif()
  1253. # Create and build a separate CMake project to carry out the population.
  1254. # If we've already previously done these steps, they will not cause
  1255. # anything to be updated, so extra rebuilds of the project won't occur.
  1256. # Make sure to pass through CMAKE_MAKE_PROGRAM in case the main project
  1257. # has this set to something not findable on the PATH. We also ensured above
  1258. # that the Debug config will be defined for multi-config generators.
  1259. configure_file("${CMAKE_CURRENT_FUNCTION_LIST_DIR}/FetchContent/CMakeLists.cmake.in"
  1260. "${ARG_SUBBUILD_DIR}/CMakeLists.txt")
  1261. execute_process(
  1262. COMMAND ${CMAKE_COMMAND} ${subCMakeOpts} .
  1263. RESULT_VARIABLE result
  1264. ${outputOptions}
  1265. WORKING_DIRECTORY "${ARG_SUBBUILD_DIR}"
  1266. )
  1267. if(result)
  1268. if(capturedOutput)
  1269. message("${capturedOutput}")
  1270. endif()
  1271. message(FATAL_ERROR "CMake step for ${contentName} failed: ${result}")
  1272. endif()
  1273. execute_process(
  1274. COMMAND ${CMAKE_COMMAND} --build . --config Debug
  1275. RESULT_VARIABLE result
  1276. ${outputOptions}
  1277. WORKING_DIRECTORY "${ARG_SUBBUILD_DIR}"
  1278. )
  1279. if(result)
  1280. if(capturedOutput)
  1281. message("${capturedOutput}")
  1282. endif()
  1283. message(FATAL_ERROR "Build step for ${contentName} failed: ${result}")
  1284. endif()
  1285. endfunction()
  1286. option(FETCHCONTENT_FULLY_DISCONNECTED "Disables all attempts to download or update content and assumes source dirs already exist")
  1287. option(FETCHCONTENT_UPDATES_DISCONNECTED "Enables UPDATE_DISCONNECTED behavior for all content population")
  1288. option(FETCHCONTENT_QUIET "Enables QUIET option for all content population" ON)
  1289. set(FETCHCONTENT_BASE_DIR "${CMAKE_BINARY_DIR}/_deps" CACHE PATH "Directory under which to collect all populated content")
  1290. # Populate the specified content using details stored from
  1291. # an earlier call to FetchContent_Declare().
  1292. function(FetchContent_Populate contentName)
  1293. if(NOT contentName)
  1294. message(FATAL_ERROR "Empty contentName not allowed for FetchContent_Populate()")
  1295. endif()
  1296. string(TOLOWER ${contentName} contentNameLower)
  1297. if(ARGN)
  1298. # This is the direct population form with details fully specified
  1299. # as part of the call, so we already have everything we need
  1300. __FetchContent_directPopulate(
  1301. ${contentNameLower}
  1302. SUBBUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/${contentNameLower}-subbuild"
  1303. SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/${contentNameLower}-src"
  1304. BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/${contentNameLower}-build"
  1305. ${ARGN} # Could override any of the above ..._DIR variables
  1306. )
  1307. # Pass source and binary dir variables back to the caller
  1308. set(${contentNameLower}_SOURCE_DIR "${${contentNameLower}_SOURCE_DIR}" PARENT_SCOPE)
  1309. set(${contentNameLower}_BINARY_DIR "${${contentNameLower}_BINARY_DIR}" PARENT_SCOPE)
  1310. # Don't set global properties, or record that we did this population, since
  1311. # this was a direct call outside of the normal declared details form.
  1312. # We only want to save values in the global properties for content that
  1313. # honors the hierarchical details mechanism so that projects are not
  1314. # robbed of the ability to override details set in nested projects.
  1315. return()
  1316. endif()
  1317. # No details provided, so assume they were saved from an earlier call
  1318. # to FetchContent_Declare(). Do a check that we haven't already
  1319. # populated this content before in case the caller forgot to check.
  1320. FetchContent_GetProperties(${contentName})
  1321. if(${contentNameLower}_POPULATED)
  1322. if("${${contentNameLower}_SOURCE_DIR}" STREQUAL "")
  1323. message(FATAL_ERROR
  1324. "Content ${contentName} already populated by find_package() or a "
  1325. "dependency provider"
  1326. )
  1327. else()
  1328. message(FATAL_ERROR
  1329. "Content ${contentName} already populated in ${${contentNameLower}_SOURCE_DIR}"
  1330. )
  1331. endif()
  1332. endif()
  1333. __FetchContent_getSavedDetails(${contentName} contentDetails)
  1334. if("${contentDetails}" STREQUAL "")
  1335. message(FATAL_ERROR "No details have been set for content: ${contentName}")
  1336. endif()
  1337. string(TOUPPER ${contentName} contentNameUpper)
  1338. set(FETCHCONTENT_SOURCE_DIR_${contentNameUpper}
  1339. "${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}"
  1340. CACHE PATH "When not empty, overrides where to find pre-populated content for ${contentName}")
  1341. if(FETCHCONTENT_SOURCE_DIR_${contentNameUpper})
  1342. # The source directory has been explicitly provided in the cache,
  1343. # so no population is required. The build directory may still be specified
  1344. # by the declared details though.
  1345. if(NOT IS_ABSOLUTE "${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}")
  1346. # Don't check this directory because we don't know what location it is
  1347. # expected to be relative to. We can't make this a hard error for backward
  1348. # compatibility reasons.
  1349. message(WARNING "Relative source directory specified. This is not safe, "
  1350. "as it depends on the calling directory scope.\n"
  1351. " FETCHCONTENT_SOURCE_DIR_${contentNameUpper} --> ${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}")
  1352. elseif(NOT EXISTS "${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}")
  1353. message(FATAL_ERROR "Manually specified source directory is missing:\n"
  1354. " FETCHCONTENT_SOURCE_DIR_${contentNameUpper} --> ${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}")
  1355. endif()
  1356. set(${contentNameLower}_SOURCE_DIR "${FETCHCONTENT_SOURCE_DIR_${contentNameUpper}}")
  1357. cmake_parse_arguments(savedDetails "" "BINARY_DIR" "" ${contentDetails})
  1358. if(savedDetails_BINARY_DIR)
  1359. set(${contentNameLower}_BINARY_DIR ${savedDetails_BINARY_DIR})
  1360. else()
  1361. set(${contentNameLower}_BINARY_DIR "${FETCHCONTENT_BASE_DIR}/${contentNameLower}-build")
  1362. endif()
  1363. elseif(FETCHCONTENT_FULLY_DISCONNECTED)
  1364. # Bypass population and assume source is already there from a previous run.
  1365. # Declared details may override the default source or build directories.
  1366. cmake_parse_arguments(savedDetails "" "SOURCE_DIR;BINARY_DIR" "" ${contentDetails})
  1367. if(savedDetails_SOURCE_DIR)
  1368. set(${contentNameLower}_SOURCE_DIR ${savedDetails_SOURCE_DIR})
  1369. else()
  1370. set(${contentNameLower}_SOURCE_DIR "${FETCHCONTENT_BASE_DIR}/${contentNameLower}-src")
  1371. endif()
  1372. if(savedDetails_BINARY_DIR)
  1373. set(${contentNameLower}_BINARY_DIR ${savedDetails_BINARY_DIR})
  1374. else()
  1375. set(${contentNameLower}_BINARY_DIR "${FETCHCONTENT_BASE_DIR}/${contentNameLower}-build")
  1376. endif()
  1377. else()
  1378. # Support both a global "disconnect all updates" and a per-content
  1379. # update test (either one being set disables updates for this content).
  1380. option(FETCHCONTENT_UPDATES_DISCONNECTED_${contentNameUpper}
  1381. "Enables UPDATE_DISCONNECTED behavior just for population of ${contentName}")
  1382. if(FETCHCONTENT_UPDATES_DISCONNECTED OR
  1383. FETCHCONTENT_UPDATES_DISCONNECTED_${contentNameUpper})
  1384. set(disconnectUpdates True)
  1385. else()
  1386. set(disconnectUpdates False)
  1387. endif()
  1388. if(FETCHCONTENT_QUIET)
  1389. set(quietFlag QUIET)
  1390. else()
  1391. unset(quietFlag)
  1392. endif()
  1393. set(__detailsQuoted)
  1394. foreach(__item IN LISTS contentDetails)
  1395. if(NOT __item STREQUAL "OVERRIDE_FIND_PACKAGE")
  1396. string(APPEND __detailsQuoted " [==[${__item}]==]")
  1397. endif()
  1398. endforeach()
  1399. cmake_language(EVAL CODE "
  1400. __FetchContent_directPopulate(
  1401. ${contentNameLower}
  1402. ${quietFlag}
  1403. UPDATE_DISCONNECTED ${disconnectUpdates}
  1404. SUBBUILD_DIR \"${FETCHCONTENT_BASE_DIR}/${contentNameLower}-subbuild\"
  1405. SOURCE_DIR \"${FETCHCONTENT_BASE_DIR}/${contentNameLower}-src\"
  1406. BINARY_DIR \"${FETCHCONTENT_BASE_DIR}/${contentNameLower}-build\"
  1407. # Put the saved details last so they can override any of the
  1408. # the options we set above (this can include SOURCE_DIR or
  1409. # BUILD_DIR)
  1410. ${__detailsQuoted}
  1411. )"
  1412. )
  1413. endif()
  1414. FetchContent_SetPopulated(
  1415. ${contentName}
  1416. SOURCE_DIR "${${contentNameLower}_SOURCE_DIR}"
  1417. BINARY_DIR "${${contentNameLower}_BINARY_DIR}"
  1418. )
  1419. # Pass variables back to the caller. The variables passed back here
  1420. # must match what FetchContent_GetProperties() sets when it is called
  1421. # with just the content name.
  1422. set(${contentNameLower}_SOURCE_DIR "${${contentNameLower}_SOURCE_DIR}" PARENT_SCOPE)
  1423. set(${contentNameLower}_BINARY_DIR "${${contentNameLower}_BINARY_DIR}" PARENT_SCOPE)
  1424. set(${contentNameLower}_POPULATED True PARENT_SCOPE)
  1425. endfunction()
  1426. function(__FetchContent_setupFindPackageRedirection contentName)
  1427. __FetchContent_getSavedDetails(${contentName} contentDetails)
  1428. string(TOLOWER ${contentName} contentNameLower)
  1429. get_property(wantFindPackage GLOBAL PROPERTY
  1430. _FetchContent_${contentNameLower}_find_package_args
  1431. DEFINED
  1432. )
  1433. if(NOT wantFindPackage AND NOT OVERRIDE_FIND_PACKAGE IN_LIST contentDetails)
  1434. # No find_package() redirection allowed
  1435. return()
  1436. endif()
  1437. # We write out dep-config.cmake and dep-config-version.cmake file name
  1438. # forms here because they are forced to lowercase. FetchContent
  1439. # dependency names are case-insensitive, but find_package() config files
  1440. # are only case-insensitive for the -config and -config-version forms,
  1441. # not the Config and ConfigVersion forms.
  1442. set(inFileDir ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/FetchContent)
  1443. set(configFilePrefix1 "${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/${contentName}Config")
  1444. set(configFilePrefix2 "${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}/${contentNameLower}-config")
  1445. if(NOT EXISTS "${configFilePrefix1}.cmake" AND
  1446. NOT EXISTS "${configFilePrefix2}.cmake")
  1447. configure_file(${inFileDir}/package-config.cmake.in
  1448. "${configFilePrefix2}.cmake" @ONLY
  1449. )
  1450. endif()
  1451. if(NOT EXISTS "${configFilePrefix1}Version.cmake" AND
  1452. NOT EXISTS "${configFilePrefix2}-version.cmake")
  1453. configure_file(${inFileDir}/package-config-version.cmake.in
  1454. "${configFilePrefix2}-version.cmake" @ONLY
  1455. )
  1456. endif()
  1457. # Now that we've created the redirected package config files, prevent
  1458. # find_package() from delegating to FetchContent and let it find these
  1459. # config files through its normal processing.
  1460. set(propertyName "${prefix}_override_find_package")
  1461. set(GLOBAL PROPERTY ${propertyName} FALSE)
  1462. set(${contentName}_DIR "${CMAKE_FIND_PACKAGE_REDIRECTS_DIR}"
  1463. CACHE INTERNAL "Redirected by FetchContent"
  1464. )
  1465. endfunction()
  1466. # Arguments are assumed to be the names of dependencies that have been
  1467. # declared previously and should be populated. It is not an error if
  1468. # any of them have already been populated (they will just be skipped in
  1469. # that case). The command is implemented as a macro so that the variables
  1470. # defined by the FetchContent_GetProperties() and FetchContent_Populate()
  1471. # calls will be available to the caller.
  1472. macro(FetchContent_MakeAvailable)
  1473. get_property(__cmake_providerCommand GLOBAL PROPERTY
  1474. __FETCHCONTENT_MAKEAVAILABLE_SERIAL_PROVIDER
  1475. )
  1476. foreach(__cmake_contentName IN ITEMS ${ARGV})
  1477. string(TOLOWER ${__cmake_contentName} __cmake_contentNameLower)
  1478. # If user specified FETCHCONTENT_SOURCE_DIR_... for this dependency, that
  1479. # overrides everything else and we shouldn't try to use find_package() or
  1480. # a dependency provider.
  1481. string(TOUPPER ${__cmake_contentName} __cmake_contentNameUpper)
  1482. if("${FETCHCONTENT_SOURCE_DIR_${__cmake_contentNameUpper}}" STREQUAL "")
  1483. # Dependency provider gets first opportunity, but prevent infinite
  1484. # recursion if we are called again for the same thing
  1485. if(NOT "${__cmake_providerCommand}" STREQUAL "" AND
  1486. NOT DEFINED __cmake_fcProvider_${__cmake_contentNameLower})
  1487. message(VERBOSE
  1488. "Trying FETCHCONTENT_MAKEAVAILABLE_SERIAL dependency provider for "
  1489. "${__cmake_contentName}"
  1490. )
  1491. # It's still valid if there are no saved details. The project may have
  1492. # been written to assume a dependency provider is always set and will
  1493. # provide dependencies without having any declared details for them.
  1494. __FetchContent_getSavedDetails(${__cmake_contentName} __cmake_contentDetails)
  1495. set(__cmake_providerArgs
  1496. "FETCHCONTENT_MAKEAVAILABLE_SERIAL"
  1497. "${__cmake_contentName}"
  1498. )
  1499. # Empty arguments must be preserved because of things like
  1500. # GIT_SUBMODULES (see CMP0097)
  1501. foreach(__cmake_item IN LISTS __cmake_contentDetails)
  1502. string(APPEND __cmake_providerArgs " [==[${__cmake_item}]==]")
  1503. endforeach()
  1504. # This property might be defined but empty. As long as it is defined,
  1505. # find_package() can be called.
  1506. get_property(__cmake_addfpargs GLOBAL PROPERTY
  1507. _FetchContent_${contentNameLower}_find_package_args
  1508. DEFINED
  1509. )
  1510. if(__cmake_addfpargs)
  1511. get_property(__cmake_fpargs GLOBAL PROPERTY
  1512. _FetchContent_${contentNameLower}_find_package_args
  1513. )
  1514. string(APPEND __cmake_providerArgs " FIND_PACKAGE_ARGS")
  1515. foreach(__cmake_item IN LISTS __cmake_fpargs)
  1516. string(APPEND __cmake_providerArgs " [==[${__cmake_item}]==]")
  1517. endforeach()
  1518. endif()
  1519. # Calling the provider could lead to FetchContent_MakeAvailable() being
  1520. # called for a nested dependency. That nested call may occur in the
  1521. # current variable scope. We have to save and restore the variables we
  1522. # need preserved.
  1523. list(APPEND __cmake_fcCurrentVarsStack
  1524. ${__cmake_contentName}
  1525. ${__cmake_contentNameLower}
  1526. )
  1527. set(__cmake_fcProvider_${__cmake_contentNameLower} YES)
  1528. cmake_language(EVAL CODE "${__cmake_providerCommand}(${__cmake_providerArgs})")
  1529. unset(__cmake_fcProvider_${__cmake_contentNameLower})
  1530. list(POP_BACK __cmake_fcCurrentVarsStack
  1531. __cmake_contentNameLower
  1532. __cmake_contentName
  1533. )
  1534. unset(__cmake_providerArgs)
  1535. unset(__cmake_addfpargs)
  1536. unset(__cmake_fpargs)
  1537. unset(__cmake_item)
  1538. unset(__cmake_contentDetails)
  1539. FetchContent_GetProperties(${__cmake_contentName})
  1540. if(${__cmake_contentNameLower}_POPULATED)
  1541. continue()
  1542. endif()
  1543. endif()
  1544. # Check if we've been asked to try find_package() first, even if we
  1545. # have already populated this dependency. If we previously tried to
  1546. # use find_package() for this and it succeeded, those things might
  1547. # no longer be in scope, so we have to do it again.
  1548. get_property(__cmake_haveFpArgs GLOBAL PROPERTY
  1549. _FetchContent_${__cmake_contentNameLower}_find_package_args DEFINED
  1550. )
  1551. if(__cmake_haveFpArgs)
  1552. unset(__cmake_haveFpArgs)
  1553. message(VERBOSE "Trying find_package(${__cmake_contentName} ...) before FetchContent")
  1554. get_property(__cmake_fpArgs GLOBAL PROPERTY
  1555. _FetchContent_${__cmake_contentNameLower}_find_package_args
  1556. )
  1557. # This call could lead to FetchContent_MakeAvailable() being called for
  1558. # a nested dependency and it may occur in the current variable scope.
  1559. # We have to save/restore the variables we need to preserve.
  1560. list(APPEND __cmake_fcCurrentNameStack
  1561. ${__cmake_contentName}
  1562. ${__cmake_contentNameLower}
  1563. )
  1564. find_package(${__cmake_contentName} ${__cmake_fpArgs})
  1565. list(POP_BACK __cmake_fcCurrentNameStack
  1566. __cmake_contentNameLower
  1567. __cmake_contentName
  1568. )
  1569. unset(__cmake_fpArgs)
  1570. if(${__cmake_contentName}_FOUND)
  1571. FetchContent_SetPopulated(${__cmake_contentName})
  1572. FetchContent_GetProperties(${__cmake_contentName})
  1573. continue()
  1574. endif()
  1575. endif()
  1576. else()
  1577. unset(__cmake_haveFpArgs)
  1578. endif()
  1579. FetchContent_GetProperties(${__cmake_contentName})
  1580. if(NOT ${__cmake_contentNameLower}_POPULATED)
  1581. FetchContent_Populate(${__cmake_contentName})
  1582. __FetchContent_setupFindPackageRedirection(${__cmake_contentName})
  1583. # Only try to call add_subdirectory() if the populated content
  1584. # can be treated that way. Protecting the call with the check
  1585. # allows this function to be used for projects that just want
  1586. # to ensure the content exists, such as to provide content at
  1587. # a known location. We check the saved details for an optional
  1588. # SOURCE_SUBDIR which can be used in the same way as its meaning
  1589. # for ExternalProject. It won't matter if it was passed through
  1590. # to the ExternalProject sub-build, since it would have been
  1591. # ignored there.
  1592. set(__cmake_srcdir "${${__cmake_contentNameLower}_SOURCE_DIR}")
  1593. __FetchContent_getSavedDetails(${__cmake_contentName} __cmake_contentDetails)
  1594. if("${__cmake_contentDetails}" STREQUAL "")
  1595. message(FATAL_ERROR "No details have been set for content: ${__cmake_contentName}")
  1596. endif()
  1597. cmake_parse_arguments(__cmake_arg "" "SOURCE_SUBDIR" "" ${__cmake_contentDetails})
  1598. if(NOT "${__cmake_arg_SOURCE_SUBDIR}" STREQUAL "")
  1599. string(APPEND __cmake_srcdir "/${__cmake_arg_SOURCE_SUBDIR}")
  1600. endif()
  1601. if(EXISTS ${__cmake_srcdir}/CMakeLists.txt)
  1602. add_subdirectory(${__cmake_srcdir} ${${__cmake_contentNameLower}_BINARY_DIR})
  1603. endif()
  1604. unset(__cmake_srcdir)
  1605. unset(__cmake_contentDetails)
  1606. unset(__cmake_arg_SOURCE_SUBDIR)
  1607. endif()
  1608. endforeach()
  1609. # clear local variables to prevent leaking into the caller's scope
  1610. unset(__cmake_contentName)
  1611. unset(__cmake_contentNameLower)
  1612. unset(__cmake_contentNameUpper)
  1613. unset(__cmake_providerCommand)
  1614. endmacro()