FetchContent.cmake 87 KB

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