FetchContent.cmake 83 KB

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