ctkMacroCheckExternalProjectDependency.cmake 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  1. ###########################################################################
  2. #
  3. # Library: CTK
  4. #
  5. # Copyright (c) Kitware Inc.
  6. #
  7. # Licensed under the Apache License, Version 2.0 (the "License");
  8. # you may not use this file except in compliance with the License.
  9. # You may obtain a copy of the License at
  10. #
  11. # http://www.apache.org/licenses/LICENSE-2.0.txt
  12. #
  13. # Unless required by applicable law or agreed to in writing, software
  14. # distributed under the License is distributed on an "AS IS" BASIS,
  15. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16. # See the License for the specific language governing permissions and
  17. # limitations under the License.
  18. #
  19. ###########################################################################
  20. include(CMakeParseArguments)
  21. if(NOT DEFINED EP_LIST_SEPARATOR)
  22. set(EP_LIST_SEPARATOR "^^")
  23. endif()
  24. if(NOT EXISTS "${EXTERNAL_PROJECT_DIR}")
  25. set(EXTERNAL_PROJECT_DIR ${CMAKE_SOURCE_DIR}/SuperBuild)
  26. endif()
  27. if(NOT DEFINED EXTERNAL_PROJECT_FILE_PREFIX)
  28. set(EXTERNAL_PROJECT_FILE_PREFIX "External_")
  29. endif()
  30. # Compute -G arg for configuring external projects with the same CMake generator:
  31. if(CMAKE_EXTRA_GENERATOR)
  32. set(EP_CMAKE_GENERATOR "${CMAKE_EXTRA_GENERATOR} - ${CMAKE_GENERATOR}")
  33. else()
  34. set(EP_CMAKE_GENERATOR "${CMAKE_GENERATOR}")
  35. endif()
  36. #!
  37. #! mark_as_superbuild(<varname1>[:<vartype1>] [<varname2>[:<vartype2>] [...]])
  38. #!
  39. #! mark_as_superbuild(
  40. #! VARS <varname1>[:<vartype1>] [<varname2>[:<vartype2>] [...]]
  41. #! [PROJECTS <projectname> [<projectname> [...]] | ALL_PROJECTS]
  42. #! [LABELS <label1> [<label2> [...]]]
  43. #! )
  44. #!
  45. #! PROJECTS corresponds to a list of <projectname> that will be added using 'ExternalProject_Add' function.
  46. #! If not specified and called within a project file, it defaults to the value of 'SUPERBUILD_TOPLEVEL_PROJECT'
  47. #! Otherwise, it defaults to 'CMAKE_PROJECT_NAME'.
  48. #! If instead 'ALL_PROJECTS' is specified, the variables and labels will be passed to all projects.
  49. #!
  50. #! VARS is an expected list of variables specified as <varname>:<vartype> to pass to <projectname>
  51. #!
  52. #!
  53. #! LABELS is an optional list of label to associate with the variable names specified using 'VARS' and passed to
  54. #! the <projectname> as CMake CACHE args of the form:
  55. #! -D<projectname>_EP_LABEL_<label1>=<varname1>;<varname2>[...]
  56. #! -D<projectname>_EP_LABEL_<label2>=<varname1>;<varname2>[...]
  57. #!
  58. function(mark_as_superbuild)
  59. set(options ALL_PROJECTS CMAKE_CMD)
  60. set(oneValueArgs)
  61. set(multiValueArgs VARS PROJECTS LABELS)
  62. cmake_parse_arguments(_sb "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  63. set(_vars ${_sb_UNPARSED_ARGUMENTS})
  64. set(_named_parameters_expected 0)
  65. if(_sb_PROJECTS OR _sb_ALL_PROJECTS OR _sb_LABELS OR _sb_VARS)
  66. set(_named_parameters_expected 1)
  67. set(_vars ${_sb_VARS})
  68. endif()
  69. if(_named_parameters_expected AND _sb_UNPARSED_ARGUMENTS)
  70. message(FATAL_ERROR "Arguments '${_sb_UNPARSED_ARGUMENTS}' should be associated with VARS parameter !")
  71. endif()
  72. if(_sb_PROJECTS AND _sb_ALL_PROJECTS)
  73. message(FATAL_ERROR "Arguments 'PROJECTS' and 'ALL_PROJECTS' are mutually exclusive !")
  74. endif()
  75. foreach(var ${_vars})
  76. set(_type_specified 0)
  77. if(var MATCHES ":")
  78. set(_type_specified 1)
  79. endif()
  80. # XXX Display warning with variable type is also specified for cache variable.
  81. set(_var ${var})
  82. if(NOT _type_specified)
  83. get_property(_type_set_in_cache CACHE ${_var} PROPERTY TYPE SET)
  84. set(_var_name ${_var})
  85. set(_var_type "STRING")
  86. if(_type_set_in_cache)
  87. get_property(_var_type CACHE ${_var_name} PROPERTY TYPE)
  88. endif()
  89. set(_var ${_var_name}:${_var_type})
  90. endif()
  91. list(APPEND _vars_with_type ${_var})
  92. endforeach()
  93. if(_sb_ALL_PROJECTS)
  94. set(optional_arg_ALL_PROJECTS "ALL_PROJECTS")
  95. else()
  96. set(optional_arg_ALL_PROJECTS PROJECTS ${_sb_PROJECTS})
  97. endif()
  98. _sb_append_to_cmake_args(
  99. VARS ${_vars_with_type} LABELS ${_sb_LABELS} ${optional_arg_ALL_PROJECTS})
  100. endfunction()
  101. #!
  102. #! _sb_extract_varname_and_vartype(<cmake_varname_and_type> <varname_var> [<vartype_var>])
  103. #!
  104. #! <cmake_varname_and_type> corresponds to variable name and variable type passed as "<varname>:<vartype>"
  105. #!
  106. #! <varname_var> will be set to "<varname>"
  107. #!
  108. #! <vartype_var> is an optional variable name that will be set to "<vartype>"
  109. function(_sb_extract_varname_and_vartype cmake_varname_and_type varname_var)
  110. set(_vartype_var "${ARGV2}")
  111. string(REPLACE ":" ";" varname_and_vartype ${cmake_varname_and_type})
  112. list(GET varname_and_vartype 0 _varname)
  113. list(GET varname_and_vartype 1 _vartype)
  114. set(${varname_var} ${_varname} PARENT_SCOPE)
  115. if(_vartype_var MATCHES ".+")
  116. set(${_vartype_var} ${_vartype} PARENT_SCOPE)
  117. endif()
  118. endfunction()
  119. function(_sb_list_to_string separator input_list output_string_var)
  120. set(_string "")
  121. cmake_policy(PUSH)
  122. cmake_policy(SET CMP0007 OLD)
  123. # Get list length
  124. list(LENGTH input_list list_length)
  125. # If the list has 0 or 1 element, there is no need to loop over.
  126. if(list_length LESS 2)
  127. set(_string "${input_list}")
  128. else()
  129. math(EXPR last_element_index "${list_length} - 1")
  130. foreach(index RANGE ${last_element_index})
  131. # Get current item_value
  132. list(GET input_list ${index} item_value)
  133. # .. and append to output string
  134. set(_string "${_string}${item_value}")
  135. # Append separator if current element is NOT the last one.
  136. if(NOT index EQUAL last_element_index)
  137. set(_string "${_string}${separator}")
  138. endif()
  139. endforeach()
  140. endif()
  141. set(${output_string_var} ${_string} PARENT_SCOPE)
  142. cmake_policy(POP)
  143. endfunction()
  144. #!
  145. #! _sb_cmakevar_to_cmakearg(<cmake_varname_and_type> <cmake_arg_var> <has_cfg_intdir_var> [<varname_var> [<vartype_var>]])
  146. #!
  147. #! <cmake_varname_and_type> corresponds to variable name and variable type passed as "<varname>:<vartype>"
  148. #!
  149. #! <cmake_arg_var> is a variable name that will be set to "-D<varname>:<vartype>=${<varname>}"
  150. #!
  151. #! <has_int_dir_var> is set to either TRUE or FALSE.
  152. #! FALSE means that the value does NOT reference ${CMAKE_CFG_INTDIR} and
  153. #! the generated cmake argument should be passed to ExternalProject_Add as CMAKE_CACHE_ARGS.
  154. #! TRUEmeans that the value does reference ${CMAKE_CFG_INTDIR} and
  155. #! the generated cmake argument should be passed to ExternalProject_Add as CMAKE_ARGS.
  156. #!
  157. #! <varname_var> is an optional variable name that will be set to "<varname>"
  158. #!
  159. #! <vartype_var> is an optional variable name that will be set to "<vartype>"
  160. function(_sb_cmakevar_to_cmakearg cmake_varname_and_type cmake_arg_var has_cfg_intdir_var)
  161. set(_varname_var "${ARGV3}")
  162. set(_vartype_var "${ARGV4}")
  163. _sb_extract_varname_and_vartype(${cmake_varname_and_type} _varname _vartype)
  164. set(_var_value "${${_varname}}")
  165. set(_consider_cache_value 1)
  166. if(DEFINED ${_varname}_SKIPCACHEVALUE AND ${_varname}_SKIPCACHEVALUE)
  167. set(_consider_cache_value 0)
  168. endif()
  169. if(_consider_cache_value)
  170. get_property(_value_set_in_cache CACHE ${_varname} PROPERTY VALUE SET)
  171. if(_value_set_in_cache)
  172. get_property(_var_value CACHE ${_varname} PROPERTY VALUE)
  173. endif()
  174. endif()
  175. set(_has_cfg_intdir FALSE)
  176. if(CMAKE_CONFIGURATION_TYPES)
  177. string(FIND "${_var_value}" ${CMAKE_CFG_INTDIR} _index)
  178. if(NOT _index EQUAL -1)
  179. # Separate list item with <EP_LIST_SEPARATOR>
  180. _sb_list_to_string(${EP_LIST_SEPARATOR} "${_var_value}" _var_value)
  181. set(_has_cfg_intdir TRUE)
  182. endif()
  183. endif()
  184. set(${cmake_arg_var} -D${_varname}:${_vartype}=${_var_value} PARENT_SCOPE)
  185. set(${has_cfg_intdir_var} ${_has_cfg_intdir} PARENT_SCOPE)
  186. if(_varname_var MATCHES ".+")
  187. set(${_varname_var} ${_varname} PARENT_SCOPE)
  188. endif()
  189. if(_vartype_var MATCHES ".+")
  190. set(${_vartype_var} ${_vartype} PARENT_SCOPE)
  191. endif()
  192. endfunction()
  193. set(_ALL_PROJECT_IDENTIFIER "ALLALLALL")
  194. #!
  195. #! _sb_append_to_cmake_args(
  196. #! VARS <varname1>:<vartype1> [<varname2>:<vartype2> [...]]
  197. #! [PROJECTS <projectname> [<projectname> [...]] | ALL_PROJECTS]
  198. #! [LABELS <label1> [<label2> [...]]]
  199. #! )
  200. #!
  201. #! PROJECTS corresponds to a list of <projectname> that will be added using 'ExternalProject_Add' function.
  202. #! If not specified and called within a project file, it defaults to the value of 'SUPERBUILD_TOPLEVEL_PROJECT'
  203. #! Otherwise, it defaults to 'CMAKE_PROJECT_NAME'.
  204. #! If instead 'ALL_PROJECTS' is specified, the variables and labels will be passed to all projects.
  205. #!
  206. #! VARS is an expected list of variables specified as <varname>:<vartype> to pass to <projectname>
  207. #!
  208. #!
  209. #! LABELS is an optional list of label to associate with the variable names specified using 'VARS' and passed to
  210. #! the <projectname> as CMake CACHE args of the form:
  211. #! -D<projectname>_EP_LABEL_<label1>=<varname1>;<varname2>[...]
  212. #! -D<projectname>_EP_LABEL_<label2>=<varname1>;<varname2>[...]
  213. #!
  214. function(_sb_append_to_cmake_args)
  215. set(options ALL_PROJECTS)
  216. set(oneValueArgs)
  217. set(multiValueArgs VARS PROJECTS LABELS)
  218. cmake_parse_arguments(_sb "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  219. if(NOT _sb_PROJECTS AND NOT _sb_ALL_PROJECTS)
  220. if(SUPERBUILD_TOPLEVEL_PROJECT)
  221. set(_sb_PROJECTS ${SUPERBUILD_TOPLEVEL_PROJECT})
  222. else()
  223. set(_sb_PROJECTS ${CMAKE_PROJECT_NAME})
  224. endif()
  225. endif()
  226. if(_sb_ALL_PROJECTS)
  227. set(_sb_PROJECTS ${_ALL_PROJECT_IDENTIFIER})
  228. endif()
  229. foreach(_sb_PROJECT ${_sb_PROJECTS})
  230. set(_ep_varnames "")
  231. foreach(varname_and_vartype ${_sb_VARS})
  232. if(NOT TARGET ${_sb_PROJECT})
  233. set_property(GLOBAL APPEND PROPERTY ${_sb_PROJECT}_EP_CMAKE_ARGS ${varname_and_vartype})
  234. _sb_extract_varname_and_vartype(${varname_and_vartype} _varname)
  235. else()
  236. message(FATAL_ERROR "Function _sb_append_to_cmake_args not allowed because project '${_sb_PROJECT}' already added !")
  237. endif()
  238. list(APPEND _ep_varnames ${_varname})
  239. endforeach()
  240. if(_sb_LABELS)
  241. set_property(GLOBAL APPEND PROPERTY ${_sb_PROJECT}_EP_LABELS ${_sb_LABELS})
  242. foreach(label ${_sb_LABELS})
  243. set_property(GLOBAL APPEND PROPERTY ${_sb_PROJECT}_EP_LABEL_${label} ${_ep_varnames})
  244. endforeach()
  245. endif()
  246. endforeach()
  247. endfunction()
  248. function(_sb_get_external_project_arguments proj varname)
  249. mark_as_superbuild(${SUPERBUILD_TOPLEVEL_PROJECT}_USE_SYSTEM_${proj}:BOOL)
  250. function(_sb_collect_args proj)
  251. # Set list of CMake args associated with each label
  252. get_property(_labels GLOBAL PROPERTY ${proj}_EP_LABELS)
  253. if(_labels)
  254. list(REMOVE_DUPLICATES _labels)
  255. foreach(label ${_labels})
  256. get_property(${proj}_EP_LABEL_${label} GLOBAL PROPERTY ${proj}_EP_LABEL_${label})
  257. list(REMOVE_DUPLICATES ${proj}_EP_LABEL_${label})
  258. _sb_append_to_cmake_args(PROJECTS ${proj}
  259. VARS ${proj}_EP_LABEL_${label}:STRING)
  260. endforeach()
  261. endif()
  262. get_property(_args GLOBAL PROPERTY ${proj}_EP_CMAKE_ARGS)
  263. foreach(var ${_args})
  264. _sb_cmakevar_to_cmakearg(${var} cmake_arg _has_cfg_intdir)
  265. set(_ep_property "CMAKE_CACHE_ARGS")
  266. if(_has_cfg_intdir)
  267. set(_ep_property "CMAKE_ARGS")
  268. endif()
  269. set_property(GLOBAL APPEND PROPERTY ${proj}_EP_PROPERTY_${_ep_property} ${cmake_arg})
  270. endforeach()
  271. endfunction()
  272. _sb_collect_args(${proj})
  273. _sb_collect_args(${_ALL_PROJECT_IDENTIFIER})
  274. set(_ep_arguments "")
  275. foreach(property CMAKE_ARGS CMAKE_CACHE_ARGS)
  276. get_property(${proj}_EP_PROPERTY_${property} GLOBAL PROPERTY ${proj}_EP_PROPERTY_${property})
  277. get_property(${_ALL_PROJECT_IDENTIFIER}_EP_PROPERTY_${property} GLOBAL PROPERTY ${_ALL_PROJECT_IDENTIFIER}_EP_PROPERTY_${property})
  278. set(_all ${${proj}_EP_PROPERTY_${property}} ${${_ALL_PROJECT_IDENTIFIER}_EP_PROPERTY_${property}})
  279. if(_all)
  280. list(APPEND _ep_arguments ${property} ${_all})
  281. endif()
  282. endforeach()
  283. list(APPEND _ep_arguments LIST_SEPARATOR ${EP_LIST_SEPARATOR})
  284. list(APPEND _ep_arguments CMAKE_GENERATOR ${EP_CMAKE_GENERATOR})
  285. set(${varname} ${_ep_arguments} PARENT_SCOPE)
  286. endfunction()
  287. function(_sb_update_indent proj)
  288. superbuild_stack_size(SB_PROJECT_STACK _stack_size)
  289. set(_indent "")
  290. if(_stack_size GREATER 0)
  291. foreach(not_used RANGE 1 ${_stack_size})
  292. set(_indent " ${_indent}")
  293. endforeach()
  294. endif()
  295. set_property(GLOBAL PROPERTY SUPERBUILD_${proj}_INDENT ${_indent})
  296. endfunction()
  297. #!
  298. #! ExternalProject_Message(<project_name> <msg> [condition])
  299. #!
  300. function(ExternalProject_Message proj msg)
  301. set(_display 1)
  302. if(NOT "x${ARGV2}" STREQUAL "x")
  303. set(_display ${ARGN})
  304. endif()
  305. if(${_display})
  306. get_property(_indent GLOBAL PROPERTY SUPERBUILD_${proj}_INDENT)
  307. message(STATUS "SuperBuild - ${_indent}${msg}")
  308. endif()
  309. endfunction()
  310. #!
  311. #! superbuild_stack_content(<stack_name> <output_var>)
  312. #!
  313. #! <stack_name> corresponds to the name of stack.
  314. #!
  315. #! <output_var> is the name of CMake variable that will be set with the content
  316. #! of the stack identified by <stack_name>.
  317. function(superbuild_stack_content stack_name output_var)
  318. get_property(_stack GLOBAL PROPERTY ${stack_name})
  319. set(${output_var} ${_stack} PARENT_SCOPE)
  320. endfunction()
  321. #!
  322. #! superbuild_stack_size(<stack_name> <output_var>)
  323. #!
  324. #! <stack_name> corresponds to the name of stack.
  325. #!
  326. #! <output_var> is the name of CMake variable that will be set with the size
  327. #! of the stack identified by <stack_name>.
  328. function(superbuild_stack_size stack_name output_var)
  329. get_property(_stack GLOBAL PROPERTY ${stack_name})
  330. list(LENGTH _stack _stack_size)
  331. set(${output_var} ${_stack_size} PARENT_SCOPE)
  332. endfunction()
  333. #!
  334. #! superbuild_stack_push(<stack_name> <value>)
  335. #!
  336. #! <stack_name> corresponds to the name of stack.
  337. #!
  338. #! <value> is appended to the stack identified by <stack_name>.
  339. function(superbuild_stack_push stack_name value)
  340. set_property(GLOBAL APPEND PROPERTY ${stack_name} ${value})
  341. endfunction()
  342. #!
  343. #! superbuild_stack_pop(<stack_name> <item_var>)
  344. #!
  345. #! <stack_name> corresponds to the name of stack.
  346. #!
  347. #! <item_var> names a CMake variable that will be set with the item
  348. #! removed from the stack identified by <stack_name>.
  349. function(superbuild_stack_pop stack_name item_var)
  350. get_property(_stack GLOBAL PROPERTY ${stack_name})
  351. list(LENGTH _stack _stack_size)
  352. if(_stack_size GREATER 0)
  353. math(EXPR _index_to_remove "${_stack_size} - 1")
  354. list(GET _stack ${_index_to_remove} _item)
  355. list(REMOVE_AT _stack ${_index_to_remove})
  356. set_property(GLOBAL PROPERTY ${stack_name} ${_stack})
  357. set(${item_var} ${_item} PARENT_SCOPE)
  358. endif()
  359. endfunction()
  360. function(_sb_is_optional proj output_var)
  361. set(_include_project 1)
  362. if(COMMAND superbuild_is_external_project_includable)
  363. superbuild_is_external_project_includable("${proj}" _include_project)
  364. endif()
  365. set(optional 1)
  366. if(_include_project)
  367. set(optional 0)
  368. endif()
  369. set(${output_var} ${optional} PARENT_SCOPE)
  370. endfunction()
  371. #!
  372. #! ExternalProject_Include_Dependencies(<project_name>
  373. #! [PROJECT_VAR <project_var>]
  374. #! [EP_ARGS_VAR <external_project_args_var>]
  375. #! [DEPENDS_VAR <depends_var>]
  376. #! [USE_SYSTEM_VAR <use_system_var>]
  377. #! [SUPERBUILD_VAR <superbuild_var>]
  378. #! )
  379. #!
  380. macro(ExternalProject_Include_Dependencies project_name)
  381. set(options)
  382. set(oneValueArgs PROJECT_VAR DEPENDS_VAR EP_ARGS_VAR USE_SYSTEM_VAR SUPERBUILD_VAR)
  383. set(multiValueArgs)
  384. cmake_parse_arguments(_sb "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  385. # Sanity checks
  386. if(x${project_name} STREQUAL xPROJECT_VAR
  387. OR x${project_name} STREQUAL xEP_ARGS_VAR
  388. OR x${project_name} STREQUAL xDEPENDS_VAR
  389. OR x${project_name} STREQUAL xUSE_SYSTEM_VAR
  390. OR x${project_name} STREQUAL xSUPERBUILD_VAR
  391. )
  392. message(FATAL_ERROR "Argument <project_name> is missing !")
  393. endif()
  394. if(_sb_UNPARSED_ARGUMENTS)
  395. message(FATAL_ERROR "Invalid arguments: ${_sb_UNPARSED_ARGUMENTS}")
  396. endif()
  397. # Set default for optional PROJECT_VAR parameter
  398. if(NOT _sb_PROJECT_VAR)
  399. set(_sb_PROJECT_VAR proj)
  400. set(${_sb_PROJECT_VAR} ${project_name})
  401. #message("[${project_name}] Setting _sb_PROJECT_VAR with default value '${_sb_PROJECT_VAR}'")
  402. endif()
  403. if(_sb_PROJECT_VAR AND NOT x${project_name} STREQUAL x${${_sb_PROJECT_VAR}})
  404. message(FATAL_ERROR
  405. "Argument <project_name>:${project_name} and PROJECT_VAR:${_sb_PROJECT_VAR}:${${_sb_PROJECT_VAR}} are different !")
  406. endif()
  407. set(_sb_proj ${project_name})
  408. # Skip if project already included
  409. get_property(_is_included GLOBAL PROPERTY SB_${_sb_proj}_FILE_INCLUDED)
  410. if(_is_included)
  411. return()
  412. endif()
  413. # Set default for optional DEPENDS_VAR and EP_ARGS parameters
  414. foreach(param DEPENDS EP_ARGS)
  415. if(NOT _sb_${param}_VAR)
  416. set(_sb_${param}_VAR ${_sb_proj}_${param})
  417. #message("[${project_name}] Setting _sb_${param}_VAR with default value '${_sb_${param}_VAR}'")
  418. endif()
  419. endforeach()
  420. # Set top level project
  421. superbuild_stack_size(SB_PROJECT_STACK _stack_size)
  422. if(_stack_size EQUAL 0)
  423. set(SUPERBUILD_TOPLEVEL_PROJECT ${_sb_proj})
  424. endif()
  425. # Set default for optional USE_SYSTEM_VAR parameter
  426. if(NOT _sb_USE_SYSTEM_VAR)
  427. set(_sb_USE_SYSTEM_VAR ${SUPERBUILD_TOPLEVEL_PROJECT}_USE_SYSTEM_${_sb_proj})
  428. #message("[${project_name}] Setting _sb_USE_SYSTEM_VAR with default value '${_sb_USE_SYSTEM_VAR}'")
  429. endif()
  430. # Set default for optional SUPERBUILD_VAR parameter
  431. if(NOT _sb_SUPERBUILD_VAR)
  432. set(_sb_SUPERBUILD_VAR ${SUPERBUILD_TOPLEVEL_PROJECT}_SUPERBUILD)
  433. #message("[${project_name}] Setting _sb_SUPERBUILD_VAR with default value '${_sb_SUPERBUILD_VAR}'")
  434. endif()
  435. # Keeping track of variable name independently of the recursion
  436. if(NOT DEFINED _sb_SB_VAR)
  437. set(_sb_SB_VAR ${_sb_SUPERBUILD_VAR})
  438. #message("[${project_name}] Setting _sb_SB_VAR with default value '${_sb_SB_VAR}'")
  439. endif()
  440. # Set local variables
  441. set(_sb_DEPENDS ${${_sb_DEPENDS_VAR}})
  442. set(_sb_USE_SYSTEM ${${_sb_USE_SYSTEM_VAR}})
  443. _sb_update_indent(${_sb_proj})
  444. # Keep track of the projects
  445. list(APPEND SB_${SUPERBUILD_TOPLEVEL_PROJECT}_POSSIBLE_DEPENDS ${_sb_proj})
  446. # Use system ?
  447. get_property(_use_system_set GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM SET)
  448. if(_use_system_set)
  449. get_property(_sb_USE_SYSTEM GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM)
  450. endif()
  451. # Is this the first run ?
  452. if(${_sb_proj} STREQUAL ${SUPERBUILD_TOPLEVEL_PROJECT} AND NOT DEFINED SB_FIRST_PASS)
  453. message(STATUS "SuperBuild - First pass")
  454. set(SB_FIRST_PASS TRUE)
  455. endif()
  456. set(_sb_REQUIRED_DEPENDS)
  457. foreach(dep ${_sb_DEPENDS})
  458. if(NOT ${_sb_proj} STREQUAL ${SUPERBUILD_TOPLEVEL_PROJECT})
  459. if(_sb_USE_SYSTEM)
  460. set_property(GLOBAL PROPERTY SB_${dep}_USE_SYSTEM ${_sb_USE_SYSTEM})
  461. #message(${_sb_proj} "Property SB_${dep}_USE_SYSTEM set to [${_sb_USE_SYSTEM_VAR}:${_sb_USE_SYSTEM}]")
  462. endif()
  463. endif()
  464. _sb_is_optional(${dep} _optional)
  465. set_property(GLOBAL PROPERTY SB_${dep}_OPTIONAL ${_optional})
  466. #message(${_sb_proj} "[${_sb_proj}] Property SB_${dep}_OPTIONAL set to ${_optional}")
  467. if(NOT _optional)
  468. list(APPEND _sb_REQUIRED_DEPENDS ${dep})
  469. endif()
  470. endforeach()
  471. # Display dependency of project being processed
  472. if(_sb_REQUIRED_DEPENDS AND SB_SECOND_PASS AND ${_sb_SB_VAR})
  473. set(dependency_str "")
  474. foreach(dep ${_sb_REQUIRED_DEPENDS})
  475. get_property(_is_included GLOBAL PROPERTY SB_${dep}_FILE_INCLUDED)
  476. set(_include_status "")
  477. if(_is_included)
  478. set(_include_status "[INCLUDED]")
  479. endif()
  480. set(dependency_str "${dependency_str}${dep}${_include_status}, ")
  481. endforeach()
  482. ExternalProject_Message(${_sb_proj} "${_sb_proj} => Requires ${dependency_str}")
  483. endif()
  484. # Save variables
  485. set_property(GLOBAL PROPERTY SB_${_sb_proj}_REQUIRED_DEPENDS ${_sb_REQUIRED_DEPENDS})
  486. set_property(GLOBAL PROPERTY SB_${_sb_proj}_DEPENDS ${_sb_DEPENDS})
  487. set_property(GLOBAL PROPERTY SB_${_sb_proj}_DEPENDS_VAR ${_sb_DEPENDS_VAR})
  488. set_property(GLOBAL PROPERTY SB_${_sb_proj}_EP_ARGS_VAR ${_sb_EP_ARGS_VAR})
  489. set_property(GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM ${_sb_USE_SYSTEM})
  490. set_property(GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM_VAR ${_sb_USE_SYSTEM_VAR})
  491. set_property(GLOBAL PROPERTY SB_${_sb_proj}_PROJECT_VAR ${_sb_PROJECT_VAR})
  492. superbuild_stack_push(SB_PROJECT_STACK ${_sb_proj})
  493. # Include dependencies
  494. foreach(dep ${_sb_DEPENDS})
  495. get_property(_included GLOBAL PROPERTY SB_${dep}_FILE_INCLUDED)
  496. if(NOT _included)
  497. # XXX - Refactor - Add a single variable named 'EXTERNAL_PROJECT_DIRS'
  498. if(EXISTS "${EXTERNAL_PROJECT_DIR}/${EXTERNAL_PROJECT_FILE_PREFIX}${dep}.cmake")
  499. include(${EXTERNAL_PROJECT_DIR}/${EXTERNAL_PROJECT_FILE_PREFIX}${dep}.cmake)
  500. elseif(EXISTS "${${dep}_FILEPATH}")
  501. include(${${dep}_FILEPATH})
  502. elseif(EXISTS "${EXTERNAL_PROJECT_ADDITIONAL_DIR}/${EXTERNAL_PROJECT_FILE_PREFIX}${dep}.cmake")
  503. include(${EXTERNAL_PROJECT_ADDITIONAL_DIR}/${EXTERNAL_PROJECT_FILE_PREFIX}${dep}.cmake)
  504. else()
  505. message(FATAL_ERROR "Can't find ${EXTERNAL_PROJECT_FILE_PREFIX}${dep}.cmake")
  506. endif()
  507. set_property(GLOBAL PROPERTY SB_${dep}_FILE_INCLUDED 1)
  508. endif()
  509. endforeach()
  510. # Restore variables
  511. superbuild_stack_pop(SB_PROJECT_STACK _sb_proj)
  512. get_property(_sb_PROJECT_VAR GLOBAL PROPERTY SB_${_sb_proj}_PROJECT_VAR)
  513. get_property(_sb_USE_SYSTEM_VAR GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM_VAR)
  514. get_property(_sb_USE_SYSTEM GLOBAL PROPERTY SB_${_sb_proj}_USE_SYSTEM)
  515. get_property(_sb_EP_ARGS_VAR GLOBAL PROPERTY SB_${_sb_proj}_EP_ARGS_VAR)
  516. get_property(_sb_DEPENDS_VAR GLOBAL PROPERTY SB_${_sb_proj}_DEPENDS_VAR)
  517. get_property(_sb_DEPENDS GLOBAL PROPERTY SB_${_sb_proj}_DEPENDS)
  518. get_property(_sb_REQUIRED_DEPENDS GLOBAL PROPERTY SB_${_sb_proj}_REQUIRED_DEPENDS)
  519. # Use system ?
  520. set(_include_type "")
  521. if(_sb_USE_SYSTEM)
  522. set(_include_type " (SYSTEM)")
  523. endif()
  524. get_property(_optional GLOBAL PROPERTY SB_${_sb_proj}_OPTIONAL)
  525. ExternalProject_Message(${_sb_proj} "${_sb_proj}[OK]${_include_type}" SB_SECOND_PASS AND ${_sb_SB_VAR} AND NOT _optional)
  526. if(${_sb_proj} STREQUAL ${SUPERBUILD_TOPLEVEL_PROJECT} AND SB_FIRST_PASS)
  527. set(SB_FIRST_PASS FALSE)
  528. ExternalProject_Message(${_sb_proj} "First pass - done")
  529. if(${_sb_SB_VAR})
  530. foreach(possible_proj ${SB_${SUPERBUILD_TOPLEVEL_PROJECT}_POSSIBLE_DEPENDS})
  531. get_property(_optional GLOBAL PROPERTY SB_${possible_proj}_OPTIONAL)
  532. if(_optional)
  533. ExternalProject_Message(${_sb_proj} "${possible_proj}[OPTIONAL]")
  534. endif()
  535. set_property(GLOBAL PROPERTY SB_${possible_proj}_FILE_INCLUDED 0)
  536. endforeach()
  537. set(${_sb_PROJECT_VAR} ${_sb_proj})
  538. set(SB_SECOND_PASS TRUE)
  539. ExternalProject_Include_Dependencies(${_sb_proj}
  540. PROJECT_VAR ${_sb_PROJECT_VAR}
  541. DEPENDS_VAR ${_sb_DEPENDS_VAR}
  542. EP_ARGS_VAR ${_sb_EP_ARGS_VAR}
  543. USE_SYSTEM_VAR _sb_USE_SYSTEM
  544. SUPERBUILD_VAR ${_sb_SB_VAR}
  545. )
  546. set(SB_SECOND_PASS FALSE)
  547. endif()
  548. endif()
  549. if(SB_FIRST_PASS OR _optional)
  550. if(NOT ${_sb_proj} STREQUAL ${SUPERBUILD_TOPLEVEL_PROJECT})
  551. return()
  552. endif()
  553. endif()
  554. if(SB_SECOND_PASS)
  555. _sb_get_external_project_arguments(${_sb_proj} ${_sb_EP_ARGS_VAR})
  556. endif()
  557. if(NOT SB_FIRST_PASS AND NOT SB_SECOND_PASS
  558. AND ${_sb_proj} STREQUAL ${SUPERBUILD_TOPLEVEL_PROJECT})
  559. #ExternalProject_Message(${_sb_proj} "Clean up")
  560. unset(_sb_SB_VAR)
  561. unset(SB_FIRST_PASS)
  562. unset(SB_SECOND_PASS)
  563. endif()
  564. # Set public variables
  565. set(${_sb_PROJECT_VAR} ${_sb_proj})
  566. set(${_sb_DEPENDS_VAR} ${_sb_REQUIRED_DEPENDS})
  567. set(${_sb_USE_SYSTEM_VAR} ${_sb_USE_SYSTEM})
  568. #message("[${_sb_proj}] #################################")
  569. #message("[${_sb_proj}] Setting ${_sb_PROJECT_VAR}:${_sb_proj}")
  570. #message("[${_sb_proj}] Setting ${_sb_EP_ARGS_VAR}:${${_sb_EP_ARGS_VAR}}")
  571. #message("[${_sb_proj}] Setting ${_sb_DEPENDS_VAR}:${${_sb_DEPENDS_VAR}}")
  572. #message("[${_sb_proj}] Setting ${_sb_USE_SYSTEM_VAR}:${_sb_USE_SYSTEM}")
  573. endmacro()
  574. #!
  575. #! ExternalProject_Add_Empty(<project_name>
  576. #! DEPENDS <depends>
  577. #! )
  578. #!
  579. macro(ExternalProject_Add_Empty project_name)
  580. set(options)
  581. set(oneValueArgs)
  582. set(multiValueArgs DEPENDS)
  583. cmake_parse_arguments(_sb "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  584. # Sanity checks
  585. if(x${project_name} STREQUAL xDEPENDS)
  586. message(FATAL_ERROR "Argument <project_name> is missing !")
  587. endif()
  588. if(_sb_UNPARSED_ARGUMENTS)
  589. message(FATAL_ERROR "Invalid arguments: ${_sb_UNPARSED_ARGUMENTS}")
  590. endif()
  591. ExternalProject_Add(${project_name}
  592. SOURCE_DIR ${CMAKE_BINARY_DIR}/${project_name}
  593. BINARY_DIR ${project_name}-build
  594. DOWNLOAD_COMMAND ""
  595. CONFIGURE_COMMAND ""
  596. BUILD_COMMAND ""
  597. INSTALL_COMMAND ""
  598. DEPENDS ${_sb_DEPENDS}
  599. )
  600. endmacro()