ExternalProject.cmake 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489
  1. # - Create custom targets to build projects in external trees
  2. # The 'ExternalProject_Add' function creates a custom target to drive
  3. # download, update/patch, configure, build, install and test steps of an
  4. # external project:
  5. # ExternalProject_Add(<name> # Name for custom target
  6. # [DEPENDS projects...] # Targets on which the project depends
  7. # [PREFIX dir] # Root dir for entire project
  8. # [LIST_SEPARATOR sep] # Sep to be replaced by ; in cmd lines
  9. # [TMP_DIR dir] # Directory to store temporary files
  10. # [STAMP_DIR dir] # Directory to store step timestamps
  11. # #--Download step--------------
  12. # [DOWNLOAD_DIR dir] # Directory to store downloaded files
  13. # [DOWNLOAD_COMMAND cmd...] # Command to download source tree
  14. # [CVS_REPOSITORY cvsroot] # CVSROOT of CVS repository
  15. # [CVS_MODULE mod] # Module to checkout from CVS repo
  16. # [CVS_TAG tag] # Tag to checkout from CVS repo
  17. # [SVN_REPOSITORY url] # URL of Subversion repo
  18. # [SVN_REVISION rev] # Revision to checkout from Subversion repo
  19. # [SVN_USERNAME john ] # Username for Subversion checkout and update
  20. # [SVN_PASSWORD doe ] # Password for Subversion checkout and update
  21. # [SVN_TRUST_CERT 1 ] # Trust the Subversion server site certificate
  22. # [GIT_REPOSITORY url] # URL of git repo
  23. # [GIT_TAG tag] # Git branch name, commit id or tag
  24. # [URL /.../src.tgz] # Full path or URL of source
  25. # [URL_MD5 md5] # MD5 checksum of file at URL
  26. # [TIMEOUT seconds] # Time allowed for file download operations
  27. # #--Update/Patch step----------
  28. # [UPDATE_COMMAND cmd...] # Source work-tree update command
  29. # [PATCH_COMMAND cmd...] # Command to patch downloaded source
  30. # #--Configure step-------------
  31. # [SOURCE_DIR dir] # Source dir to be used for build
  32. # [CONFIGURE_COMMAND cmd...] # Build tree configuration command
  33. # [CMAKE_COMMAND /.../cmake] # Specify alternative cmake executable
  34. # [CMAKE_GENERATOR gen] # Specify generator for native build
  35. # [CMAKE_ARGS args...] # Arguments to CMake command line
  36. # [CMAKE_CACHE_ARGS args...] # Initial cache arguments, of the form -Dvar:string=on
  37. # #--Build step-----------------
  38. # [BINARY_DIR dir] # Specify build dir location
  39. # [BUILD_COMMAND cmd...] # Command to drive the native build
  40. # [BUILD_IN_SOURCE 1] # Use source dir for build dir
  41. # #--Install step---------------
  42. # [INSTALL_DIR dir] # Installation prefix
  43. # [INSTALL_COMMAND cmd...] # Command to drive install after build
  44. # #--Test step------------------
  45. # [TEST_BEFORE_INSTALL 1] # Add test step executed before install step
  46. # [TEST_AFTER_INSTALL 1] # Add test step executed after install step
  47. # [TEST_COMMAND cmd...] # Command to drive test
  48. # #--Output logging-------------
  49. # [LOG_DOWNLOAD 1] # Wrap download in script to log output
  50. # [LOG_UPDATE 1] # Wrap update in script to log output
  51. # [LOG_CONFIGURE 1] # Wrap configure in script to log output
  52. # [LOG_BUILD 1] # Wrap build in script to log output
  53. # [LOG_TEST 1] # Wrap test in script to log output
  54. # [LOG_INSTALL 1] # Wrap install in script to log output
  55. # #--Custom targets-------------
  56. # [STEP_TARGETS st1 st2 ...] # Generate custom targets for these steps
  57. # )
  58. # The *_DIR options specify directories for the project, with default
  59. # directories computed as follows.
  60. # If the PREFIX option is given to ExternalProject_Add() or the EP_PREFIX
  61. # directory property is set, then an external project is built and installed
  62. # under the specified prefix:
  63. # TMP_DIR = <prefix>/tmp
  64. # STAMP_DIR = <prefix>/src/<name>-stamp
  65. # DOWNLOAD_DIR = <prefix>/src
  66. # SOURCE_DIR = <prefix>/src/<name>
  67. # BINARY_DIR = <prefix>/src/<name>-build
  68. # INSTALL_DIR = <prefix>
  69. # Otherwise, if the EP_BASE directory property is set then components
  70. # of an external project are stored under the specified base:
  71. # TMP_DIR = <base>/tmp/<name>
  72. # STAMP_DIR = <base>/Stamp/<name>
  73. # DOWNLOAD_DIR = <base>/Download/<name>
  74. # SOURCE_DIR = <base>/Source/<name>
  75. # BINARY_DIR = <base>/Build/<name>
  76. # INSTALL_DIR = <base>/Install/<name>
  77. # If no PREFIX, EP_PREFIX, or EP_BASE is specified then the default
  78. # is to set PREFIX to "<name>-prefix".
  79. # Relative paths are interpreted with respect to the build directory
  80. # corresponding to the source directory in which ExternalProject_Add is
  81. # invoked.
  82. #
  83. # If SOURCE_DIR is explicitly set to an existing directory the project
  84. # will be built from it.
  85. # Otherwise a download step must be specified using one of the
  86. # DOWNLOAD_COMMAND, CVS_*, SVN_*, or URL options.
  87. # The URL option may refer locally to a directory or source tarball,
  88. # or refer to a remote tarball (e.g. http://.../src.tgz).
  89. #
  90. # The 'ExternalProject_Add_Step' function adds a custom step to an external
  91. # project:
  92. # ExternalProject_Add_Step(<name> <step> # Names of project and custom step
  93. # [COMMAND cmd...] # Command line invoked by this step
  94. # [COMMENT "text..."] # Text printed when step executes
  95. # [DEPENDEES steps...] # Steps on which this step depends
  96. # [DEPENDERS steps...] # Steps that depend on this step
  97. # [DEPENDS files...] # Files on which this step depends
  98. # [ALWAYS 1] # No stamp file, step always runs
  99. # [WORKING_DIRECTORY dir] # Working directory for command
  100. # [LOG 1] # Wrap step in script to log output
  101. # )
  102. # The command line, comment, and working directory of every standard
  103. # and custom step is processed to replace tokens
  104. # <SOURCE_DIR>,
  105. # <BINARY_DIR>,
  106. # <INSTALL_DIR>,
  107. # and <TMP_DIR>
  108. # with corresponding property values.
  109. #
  110. # The 'ExternalProject_Get_Property' function retrieves external project
  111. # target properties:
  112. # ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])
  113. # It stores property values in variables of the same name.
  114. # Property names correspond to the keyword argument names of
  115. # 'ExternalProject_Add'.
  116. #
  117. # The 'ExternalProject_Add_StepTargets' function generates custom targets for
  118. # the steps listed:
  119. # ExternalProject_Add_StepTargets(<name> [step1 [step2 [...]]])
  120. #
  121. # If STEP_TARGETS is set then ExternalProject_Add_StepTargets is automatically
  122. # called at the end of matching calls to ExternalProject_Add_Step. Pass
  123. # STEP_TARGETS explicitly to individual ExternalProject_Add calls, or
  124. # implicitly to all ExternalProject_Add calls by setting the directory property
  125. # EP_STEP_TARGETS.
  126. #
  127. # If STEP_TARGETS is not set, clients may still manually call
  128. # ExternalProject_Add_StepTargets after calling ExternalProject_Add or
  129. # ExternalProject_Add_Step.
  130. #
  131. # This functionality is provided to make it easy to drive the steps
  132. # independently of each other by specifying targets on build command lines.
  133. # For example, you may be submitting to a sub-project based dashboard, where
  134. # you want to drive the configure portion of the build, then submit to the
  135. # dashboard, followed by the build portion, followed by tests. If you invoke
  136. # a custom target that depends on a step halfway through the step dependency
  137. # chain, then all the previous steps will also run to ensure everything is
  138. # up to date.
  139. #
  140. # For example, to drive configure, build and test steps independently for each
  141. # ExternalProject_Add call in your project, write the following line prior to
  142. # any ExternalProject_Add calls in your CMakeLists file:
  143. #
  144. # set_property(DIRECTORY PROPERTY EP_STEP_TARGETS configure build test)
  145. #=============================================================================
  146. # Copyright 2008-2009 Kitware, Inc.
  147. #
  148. # Distributed under the OSI-approved BSD License (the "License");
  149. # see accompanying file Copyright.txt for details.
  150. #
  151. # This software is distributed WITHOUT ANY WARRANTY; without even the
  152. # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  153. # See the License for more information.
  154. #=============================================================================
  155. # (To distribute this file outside of CMake, substitute the full
  156. # License text for the above reference.)
  157. # Pre-compute a regex to match documented keywords for each command.
  158. math(EXPR _ep_documentation_line_count "${CMAKE_CURRENT_LIST_LINE} - 16")
  159. file(STRINGS "${CMAKE_CURRENT_LIST_FILE}" lines
  160. LIMIT_COUNT ${_ep_documentation_line_count}
  161. REGEX "^# ( \\[[A-Z0-9_]+ [^]]*\\] +#.*$|[A-Za-z0-9_]+\\()")
  162. foreach(line IN LISTS lines)
  163. if("${line}" MATCHES "^# [A-Za-z0-9_]+\\(")
  164. if(_ep_func)
  165. set(_ep_keywords_${_ep_func} "${_ep_keywords_${_ep_func}})$")
  166. endif()
  167. string(REGEX REPLACE "^# ([A-Za-z0-9_]+)\\(.*" "\\1" _ep_func "${line}")
  168. #message("function [${_ep_func}]")
  169. set(_ep_keywords_${_ep_func} "^(")
  170. set(_ep_keyword_sep)
  171. else()
  172. string(REGEX REPLACE "^# \\[([A-Z0-9_]+) .*" "\\1" _ep_key "${line}")
  173. #message(" keyword [${_ep_key}]")
  174. set(_ep_keywords_${_ep_func}
  175. "${_ep_keywords_${_ep_func}}${_ep_keyword_sep}${_ep_key}")
  176. set(_ep_keyword_sep "|")
  177. endif()
  178. endforeach()
  179. if(_ep_func)
  180. set(_ep_keywords_${_ep_func} "${_ep_keywords_${_ep_func}})$")
  181. endif()
  182. function(_ep_parse_arguments f name ns args)
  183. # Transfer the arguments to this function into target properties for the
  184. # new custom target we just added so that we can set up all the build steps
  185. # correctly based on target properties.
  186. #
  187. # We loop through ARGN and consider the namespace starting with an
  188. # upper-case letter followed by at least two more upper-case letters,
  189. # numbers or underscores to be keywords.
  190. set(key)
  191. foreach(arg IN LISTS args)
  192. set(is_value 1)
  193. if(arg MATCHES "^[A-Z][A-Z0-9_][A-Z0-9_]+$" AND
  194. NOT ((arg STREQUAL "${key}") AND (key STREQUAL "COMMAND")) AND
  195. NOT arg MATCHES "^(TRUE|FALSE)$")
  196. if(_ep_keywords_${f} AND arg MATCHES "${_ep_keywords_${f}}")
  197. set(is_value 0)
  198. endif()
  199. endif()
  200. if(is_value)
  201. if(key)
  202. # Value
  203. if(NOT arg STREQUAL "")
  204. set_property(TARGET ${name} APPEND PROPERTY ${ns}${key} "${arg}")
  205. else()
  206. get_property(have_key TARGET ${name} PROPERTY ${ns}${key} SET)
  207. if(have_key)
  208. get_property(value TARGET ${name} PROPERTY ${ns}${key})
  209. set_property(TARGET ${name} PROPERTY ${ns}${key} "${value};${arg}")
  210. else()
  211. set_property(TARGET ${name} PROPERTY ${ns}${key} "${arg}")
  212. endif()
  213. endif()
  214. else()
  215. # Missing Keyword
  216. message(AUTHOR_WARNING "value '${arg}' with no previous keyword in ${f}")
  217. endif()
  218. else()
  219. set(key "${arg}")
  220. endif()
  221. endforeach()
  222. endfunction(_ep_parse_arguments)
  223. define_property(DIRECTORY PROPERTY "EP_BASE" INHERITED
  224. BRIEF_DOCS "Base directory for External Project storage."
  225. FULL_DOCS
  226. "See documentation of the ExternalProject_Add() function in the "
  227. "ExternalProject module."
  228. )
  229. define_property(DIRECTORY PROPERTY "EP_PREFIX" INHERITED
  230. BRIEF_DOCS "Top prefix for External Project storage."
  231. FULL_DOCS
  232. "See documentation of the ExternalProject_Add() function in the "
  233. "ExternalProject module."
  234. )
  235. define_property(DIRECTORY PROPERTY "EP_STEP_TARGETS" INHERITED
  236. BRIEF_DOCS
  237. "List of ExternalProject steps that automatically get corresponding targets"
  238. FULL_DOCS
  239. "See documentation of the ExternalProject_Add_StepTargets() function in the "
  240. "ExternalProject module."
  241. )
  242. function(_ep_write_gitclone_script script_filename source_dir git_EXECUTABLE git_repository git_tag src_name work_dir)
  243. file(WRITE ${script_filename}
  244. "if(\"${git_tag}\" STREQUAL \"\")
  245. message(FATAL_ERROR \"Tag for git checkout should not be empty.\")
  246. endif()
  247. execute_process(
  248. COMMAND \${CMAKE_COMMAND} -E remove_directory \"${source_dir}\"
  249. RESULT_VARIABLE error_code
  250. )
  251. if(error_code)
  252. message(FATAL_ERROR \"Failed to remove directory: '${source_dir}'\")
  253. endif()
  254. execute_process(
  255. COMMAND \"${git_EXECUTABLE}\" clone \"${git_repository}\" \"${src_name}\"
  256. WORKING_DIRECTORY \"${work_dir}\"
  257. RESULT_VARIABLE error_code
  258. )
  259. if(error_code)
  260. message(FATAL_ERROR \"Failed to clone repository: '${git_repository}'\")
  261. endif()
  262. execute_process(
  263. COMMAND \"${git_EXECUTABLE}\" checkout ${git_tag}
  264. WORKING_DIRECTORY \"${work_dir}/${src_name}\"
  265. RESULT_VARIABLE error_code
  266. )
  267. if(error_code)
  268. message(FATAL_ERROR \"Failed to checkout tag: '${git_tag}'\")
  269. endif()
  270. execute_process(
  271. COMMAND \"${git_EXECUTABLE}\" submodule init
  272. WORKING_DIRECTORY \"${work_dir}/${src_name}\"
  273. RESULT_VARIABLE error_code
  274. )
  275. if(error_code)
  276. message(FATAL_ERROR \"Failed to init submodules in: '${work_dir}/${src_name}'\")
  277. endif()
  278. execute_process(
  279. COMMAND \"${git_EXECUTABLE}\" submodule update --recursive
  280. WORKING_DIRECTORY \"${work_dir}/${src_name}\"
  281. RESULT_VARIABLE error_code
  282. )
  283. if(error_code)
  284. message(FATAL_ERROR \"Failed to update submodules in: '${work_dir}/${src_name}'\")
  285. endif()
  286. "
  287. )
  288. endfunction(_ep_write_gitclone_script)
  289. function(_ep_write_downloadfile_script script_filename remote local timeout md5)
  290. if(timeout)
  291. set(timeout_args TIMEOUT ${timeout})
  292. set(timeout_msg "${timeout} seconds")
  293. else()
  294. set(timeout_args "# no TIMEOUT")
  295. set(timeout_msg "none")
  296. endif()
  297. if(md5)
  298. set(md5_args EXPECTED_MD5 ${md5})
  299. else()
  300. set(md5_args "# no EXPECTED_MD5")
  301. endif()
  302. file(WRITE ${script_filename}
  303. "message(STATUS \"downloading...
  304. src='${remote}'
  305. dst='${local}'
  306. timeout='${timeout_msg}'\")
  307. file(DOWNLOAD
  308. \"${remote}\"
  309. \"${local}\"
  310. SHOW_PROGRESS
  311. ${md5_args}
  312. ${timeout_args}
  313. STATUS status
  314. LOG log)
  315. list(GET status 0 status_code)
  316. list(GET status 1 status_string)
  317. if(NOT status_code EQUAL 0)
  318. message(FATAL_ERROR \"error: downloading '${remote}' failed
  319. status_code: \${status_code}
  320. status_string: \${status_string}
  321. log: \${log}
  322. \")
  323. endif()
  324. message(STATUS \"downloading... done\")
  325. "
  326. )
  327. endfunction(_ep_write_downloadfile_script)
  328. function(_ep_write_verifyfile_script script_filename local md5)
  329. file(WRITE ${script_filename}
  330. "message(STATUS \"verifying file...
  331. file='${local}'\")
  332. set(verified 0)
  333. # If an expected md5 checksum exists, compare against it:
  334. #
  335. if(NOT \"${md5}\" STREQUAL \"\")
  336. execute_process(COMMAND \${CMAKE_COMMAND} -E md5sum \"${local}\"
  337. OUTPUT_VARIABLE ov
  338. OUTPUT_STRIP_TRAILING_WHITESPACE
  339. RESULT_VARIABLE rv)
  340. if(NOT rv EQUAL 0)
  341. message(FATAL_ERROR \"error: computing md5sum of '${local}' failed\")
  342. endif()
  343. string(REGEX MATCH \"^([0-9A-Fa-f]+)\" md5_actual \"\${ov}\")
  344. string(TOLOWER \"\${md5_actual}\" md5_actual)
  345. string(TOLOWER \"${md5}\" md5)
  346. if(NOT \"\${md5}\" STREQUAL \"\${md5_actual}\")
  347. message(FATAL_ERROR \"error: md5sum of '${local}' does not match expected value
  348. md5_expected: \${md5}
  349. md5_actual: \${md5_actual}
  350. \")
  351. endif()
  352. set(verified 1)
  353. endif()
  354. if(verified)
  355. message(STATUS \"verifying file... done\")
  356. else()
  357. message(STATUS \"verifying file... warning: did not verify file - no URL_MD5 checksum argument? corrupt file?\")
  358. endif()
  359. "
  360. )
  361. endfunction(_ep_write_verifyfile_script)
  362. function(_ep_write_extractfile_script script_filename name filename directory)
  363. set(args "")
  364. if(filename MATCHES "(\\.|=)(bz2|tar\\.gz|tgz|zip)$")
  365. set(args xfz)
  366. endif()
  367. if(filename MATCHES "(\\.|=)tar$")
  368. set(args xf)
  369. endif()
  370. if(args STREQUAL "")
  371. message(SEND_ERROR "error: do not know how to extract '${filename}' -- known types are .bz2, .tar, .tar.gz, .tgz and .zip")
  372. return()
  373. endif()
  374. file(WRITE ${script_filename}
  375. "# Make file names absolute:
  376. #
  377. get_filename_component(filename \"${filename}\" ABSOLUTE)
  378. get_filename_component(directory \"${directory}\" ABSOLUTE)
  379. message(STATUS \"extracting...
  380. src='\${filename}'
  381. dst='\${directory}'\")
  382. if(NOT EXISTS \"\${filename}\")
  383. message(FATAL_ERROR \"error: file to extract does not exist: '\${filename}'\")
  384. endif()
  385. # Prepare a space for extracting:
  386. #
  387. set(i 1234)
  388. while(EXISTS \"\${directory}/../ex-${name}\${i}\")
  389. math(EXPR i \"\${i} + 1\")
  390. endwhile()
  391. set(ut_dir \"\${directory}/../ex-${name}\${i}\")
  392. file(MAKE_DIRECTORY \"\${ut_dir}\")
  393. # Extract it:
  394. #
  395. message(STATUS \"extracting... [tar ${args}]\")
  396. execute_process(COMMAND \${CMAKE_COMMAND} -E tar ${args} \${filename}
  397. WORKING_DIRECTORY \${ut_dir}
  398. RESULT_VARIABLE rv)
  399. if(NOT rv EQUAL 0)
  400. message(STATUS \"extracting... [error clean up]\")
  401. file(REMOVE_RECURSE \"\${ut_dir}\")
  402. message(FATAL_ERROR \"error: extract of '\${filename}' failed\")
  403. endif()
  404. # Analyze what came out of the tar file:
  405. #
  406. message(STATUS \"extracting... [analysis]\")
  407. file(GLOB contents \"\${ut_dir}/*\")
  408. list(LENGTH contents n)
  409. if(NOT n EQUAL 1 OR NOT IS_DIRECTORY \"\${contents}\")
  410. set(contents \"\${ut_dir}\")
  411. endif()
  412. # Move \"the one\" directory to the final directory:
  413. #
  414. message(STATUS \"extracting... [rename]\")
  415. file(REMOVE_RECURSE \${directory})
  416. get_filename_component(contents \${contents} ABSOLUTE)
  417. file(RENAME \${contents} \${directory})
  418. # Clean up:
  419. #
  420. message(STATUS \"extracting... [clean up]\")
  421. file(REMOVE_RECURSE \"\${ut_dir}\")
  422. message(STATUS \"extracting... done\")
  423. "
  424. )
  425. endfunction(_ep_write_extractfile_script)
  426. function(_ep_set_directories name)
  427. get_property(prefix TARGET ${name} PROPERTY _EP_PREFIX)
  428. if(NOT prefix)
  429. get_property(prefix DIRECTORY PROPERTY EP_PREFIX)
  430. if(NOT prefix)
  431. get_property(base DIRECTORY PROPERTY EP_BASE)
  432. if(NOT base)
  433. set(prefix "${name}-prefix")
  434. endif()
  435. endif()
  436. endif()
  437. if(prefix)
  438. set(tmp_default "${prefix}/tmp")
  439. set(download_default "${prefix}/src")
  440. set(source_default "${prefix}/src/${name}")
  441. set(binary_default "${prefix}/src/${name}-build")
  442. set(stamp_default "${prefix}/src/${name}-stamp")
  443. set(install_default "${prefix}")
  444. else() # assert(base)
  445. set(tmp_default "${base}/tmp/${name}")
  446. set(download_default "${base}/Download/${name}")
  447. set(source_default "${base}/Source/${name}")
  448. set(binary_default "${base}/Build/${name}")
  449. set(stamp_default "${base}/Stamp/${name}")
  450. set(install_default "${base}/Install/${name}")
  451. endif()
  452. get_property(build_in_source TARGET ${name} PROPERTY _EP_BUILD_IN_SOURCE)
  453. if(build_in_source)
  454. get_property(have_binary_dir TARGET ${name} PROPERTY _EP_BINARY_DIR SET)
  455. if(have_binary_dir)
  456. message(FATAL_ERROR
  457. "External project ${name} has both BINARY_DIR and BUILD_IN_SOURCE!")
  458. endif()
  459. endif()
  460. set(top "${CMAKE_CURRENT_BINARY_DIR}")
  461. set(places stamp download source binary install tmp)
  462. foreach(var ${places})
  463. string(TOUPPER "${var}" VAR)
  464. get_property(${var}_dir TARGET ${name} PROPERTY _EP_${VAR}_DIR)
  465. if(NOT ${var}_dir)
  466. set(${var}_dir "${${var}_default}")
  467. endif()
  468. if(NOT IS_ABSOLUTE "${${var}_dir}")
  469. get_filename_component(${var}_dir "${top}/${${var}_dir}" ABSOLUTE)
  470. endif()
  471. set_property(TARGET ${name} PROPERTY _EP_${VAR}_DIR "${${var}_dir}")
  472. endforeach()
  473. if(build_in_source)
  474. get_property(source_dir TARGET ${name} PROPERTY _EP_SOURCE_DIR)
  475. set_property(TARGET ${name} PROPERTY _EP_BINARY_DIR "${source_dir}")
  476. endif()
  477. # Make the directories at CMake configure time *and* add a custom command
  478. # to make them at build time. They need to exist at makefile generation
  479. # time for Borland make and wmake so that CMake may generate makefiles
  480. # with "cd C:\short\paths\with\no\spaces" commands in them.
  481. #
  482. # Additionally, the add_custom_command is still used in case somebody
  483. # removes one of the necessary directories and tries to rebuild without
  484. # re-running cmake.
  485. foreach(var ${places})
  486. string(TOUPPER "${var}" VAR)
  487. get_property(dir TARGET ${name} PROPERTY _EP_${VAR}_DIR)
  488. file(MAKE_DIRECTORY "${dir}")
  489. if(NOT EXISTS "${dir}")
  490. message(FATAL_ERROR "dir '${dir}' does not exist after file(MAKE_DIRECTORY)")
  491. endif()
  492. endforeach()
  493. endfunction(_ep_set_directories)
  494. # IMPORTANT: this MUST be a macro and not a function because of the
  495. # in-place replacements that occur in each ${var}
  496. #
  497. macro(_ep_replace_location_tags target_name)
  498. set(vars ${ARGN})
  499. foreach(var ${vars})
  500. if(${var})
  501. foreach(dir SOURCE_DIR BINARY_DIR INSTALL_DIR TMP_DIR)
  502. get_property(val TARGET ${target_name} PROPERTY _EP_${dir})
  503. string(REPLACE "<${dir}>" "${val}" ${var} "${${var}}")
  504. endforeach()
  505. endif()
  506. endforeach()
  507. endmacro()
  508. function(_ep_write_initial_cache target_name script_filename args)
  509. # Write out values into an initial cache, that will be passed to CMake with -C
  510. set(script_initial_cache "")
  511. set(regex "^([^:]+):([^=]+)=(.*)$")
  512. set(setArg "")
  513. foreach(line ${args})
  514. if("${line}" MATCHES "^-D")
  515. if(setArg)
  516. # This is required to build up lists in variables, or complete an entry
  517. set(setArg "${setArg}${accumulator}\" CACHE ${type} \"Initial cache\" FORCE)")
  518. set(script_initial_cache "${script_initial_cache}\n${setArg}")
  519. set(accumulator "")
  520. set(setArg "")
  521. endif()
  522. string(REGEX REPLACE "^-D" "" line ${line})
  523. if("${line}" MATCHES "${regex}")
  524. string(REGEX MATCH "${regex}" match "${line}")
  525. set(name "${CMAKE_MATCH_1}")
  526. set(type "${CMAKE_MATCH_2}")
  527. set(value "${CMAKE_MATCH_3}")
  528. set(setArg "set(${name} \"${value}")
  529. else()
  530. message(WARNING "Line '${line}' does not match regex. Ignoring.")
  531. endif()
  532. else()
  533. # Assume this is a list to append to the last var
  534. set(accumulator "${accumulator};${line}")
  535. endif()
  536. endforeach()
  537. # Catch the final line of the args
  538. if(setArg)
  539. set(setArg "${setArg}${accumulator}\" CACHE ${type} \"Initial cache\" FORCE)")
  540. set(script_initial_cache "${script_initial_cache}\n${setArg}")
  541. endif()
  542. # Replace location tags.
  543. _ep_replace_location_tags(${target_name} script_initial_cache)
  544. # Write out the initial cache file to the location specified.
  545. if(NOT EXISTS "${script_filename}.in")
  546. file(WRITE "${script_filename}.in" "\@script_initial_cache\@\n")
  547. endif()
  548. configure_file("${script_filename}.in" "${script_filename}")
  549. endfunction(_ep_write_initial_cache)
  550. function(ExternalProject_Get_Property name)
  551. foreach(var ${ARGN})
  552. string(TOUPPER "${var}" VAR)
  553. get_property(${var} TARGET ${name} PROPERTY _EP_${VAR})
  554. if(NOT ${var})
  555. message(FATAL_ERROR "External project \"${name}\" has no ${var}")
  556. endif()
  557. set(${var} "${${var}}" PARENT_SCOPE)
  558. endforeach()
  559. endfunction(ExternalProject_Get_Property)
  560. function(_ep_get_configure_command_id name cfg_cmd_id_var)
  561. get_target_property(cmd ${name} _EP_CONFIGURE_COMMAND)
  562. if(cmd STREQUAL "")
  563. # Explicit empty string means no configure step for this project
  564. set(${cfg_cmd_id_var} "none" PARENT_SCOPE)
  565. else()
  566. if(NOT cmd)
  567. # Default is "use cmake":
  568. set(${cfg_cmd_id_var} "cmake" PARENT_SCOPE)
  569. else()
  570. # Otherwise we have to analyze the value:
  571. if(cmd MATCHES "^[^;]*/configure")
  572. set(${cfg_cmd_id_var} "configure" PARENT_SCOPE)
  573. elseif(cmd MATCHES "^[^;]*/cmake" AND NOT cmd MATCHES ";-[PE];")
  574. set(${cfg_cmd_id_var} "cmake" PARENT_SCOPE)
  575. elseif(cmd MATCHES "config")
  576. set(${cfg_cmd_id_var} "configure" PARENT_SCOPE)
  577. else()
  578. set(${cfg_cmd_id_var} "unknown:${cmd}" PARENT_SCOPE)
  579. endif()
  580. endif()
  581. endif()
  582. endfunction(_ep_get_configure_command_id)
  583. function(_ep_get_build_command name step cmd_var)
  584. set(cmd "${${cmd_var}}")
  585. if(NOT cmd)
  586. set(args)
  587. _ep_get_configure_command_id(${name} cfg_cmd_id)
  588. if(cfg_cmd_id STREQUAL "cmake")
  589. # CMake project. Select build command based on generator.
  590. get_target_property(cmake_generator ${name} _EP_CMAKE_GENERATOR)
  591. if("${CMAKE_GENERATOR}" MATCHES "Make" AND
  592. ("${cmake_generator}" MATCHES "Make" OR NOT cmake_generator))
  593. # The project uses the same Makefile generator. Use recursive make.
  594. set(cmd "$(MAKE)")
  595. if(step STREQUAL "INSTALL")
  596. set(args install)
  597. endif()
  598. if(step STREQUAL "TEST")
  599. set(args test)
  600. endif()
  601. else()
  602. # Drive the project with "cmake --build".
  603. get_target_property(cmake_command ${name} _EP_CMAKE_COMMAND)
  604. if(cmake_command)
  605. set(cmd "${cmake_command}")
  606. else()
  607. set(cmd "${CMAKE_COMMAND}")
  608. endif()
  609. set(args --build ${binary_dir} --config ${CMAKE_CFG_INTDIR})
  610. if(step STREQUAL "INSTALL")
  611. list(APPEND args --target install)
  612. endif()
  613. # But for "TEST" drive the project with corresponding "ctest".
  614. if(step STREQUAL "TEST")
  615. string(REGEX REPLACE "^(.*/)cmake([^/]*)$" "\\1ctest\\2" cmd "${cmd}")
  616. set(args "")
  617. endif()
  618. endif()
  619. else() # if(cfg_cmd_id STREQUAL "configure")
  620. # Non-CMake project. Guess "make" and "make install" and "make test".
  621. # But use "$(MAKE)" to get recursive parallel make.
  622. set(cmd "$(MAKE)")
  623. if(step STREQUAL "INSTALL")
  624. set(args install)
  625. endif()
  626. if(step STREQUAL "TEST")
  627. set(args test)
  628. endif()
  629. endif()
  630. # Use user-specified arguments instead of default arguments, if any.
  631. get_property(have_args TARGET ${name} PROPERTY _EP_${step}_ARGS SET)
  632. if(have_args)
  633. get_target_property(args ${name} _EP_${step}_ARGS)
  634. endif()
  635. list(APPEND cmd ${args})
  636. endif()
  637. set(${cmd_var} "${cmd}" PARENT_SCOPE)
  638. endfunction(_ep_get_build_command)
  639. function(_ep_write_log_script name step cmd_var)
  640. ExternalProject_Get_Property(${name} stamp_dir)
  641. set(command "${${cmd_var}}")
  642. set(make "")
  643. set(code_cygpath_make "")
  644. if("${command}" MATCHES "^\\$\\(MAKE\\)")
  645. # GNU make recognizes the string "$(MAKE)" as recursive make, so
  646. # ensure that it appears directly in the makefile.
  647. string(REGEX REPLACE "^\\$\\(MAKE\\)" "\${make}" command "${command}")
  648. set(make "-Dmake=$(MAKE)")
  649. if(WIN32 AND NOT CYGWIN)
  650. set(code_cygpath_make "
  651. if(\${make} MATCHES \"^/\")
  652. execute_process(
  653. COMMAND cygpath -w \${make}
  654. OUTPUT_VARIABLE cygpath_make
  655. ERROR_VARIABLE cygpath_make
  656. RESULT_VARIABLE cygpath_error
  657. OUTPUT_STRIP_TRAILING_WHITESPACE
  658. )
  659. if(NOT cygpath_error)
  660. set(make \${cygpath_make})
  661. endif()
  662. endif()
  663. ")
  664. endif()
  665. endif()
  666. set(config "")
  667. if("${CMAKE_CFG_INTDIR}" MATCHES "^\\$")
  668. string(REPLACE "${CMAKE_CFG_INTDIR}" "\${config}" command "${command}")
  669. set(config "-Dconfig=${CMAKE_CFG_INTDIR}")
  670. endif()
  671. # Wrap multiple 'COMMAND' lines up into a second-level wrapper
  672. # script so all output can be sent to one log file.
  673. if("${command}" MATCHES ";COMMAND;")
  674. set(code_execute_process "
  675. ${code_cygpath_make}
  676. execute_process(COMMAND \${command} RESULT_VARIABLE result)
  677. if(result)
  678. set(msg \"Command failed (\${result}):\\n\")
  679. foreach(arg IN LISTS command)
  680. set(msg \"\${msg} '\${arg}'\")
  681. endforeach(arg)
  682. message(FATAL_ERROR \"\${msg}\")
  683. endif()
  684. ")
  685. set(code "")
  686. set(cmd "")
  687. set(sep "")
  688. foreach(arg IN LISTS command)
  689. if("x${arg}" STREQUAL "xCOMMAND")
  690. set(code "${code}set(command \"${cmd}\")${code_execute_process}")
  691. set(cmd "")
  692. set(sep "")
  693. else()
  694. set(cmd "${cmd}${sep}${arg}")
  695. set(sep ";")
  696. endif()
  697. endforeach()
  698. set(code "set(ENV{VS_UNICODE_OUTPUT} \"\")\n${code}set(command \"${cmd}\")${code_execute_process}")
  699. file(WRITE ${stamp_dir}/${name}-${step}-impl.cmake "${code}")
  700. set(command ${CMAKE_COMMAND} "-Dmake=\${make}" "-Dconfig=\${config}" -P ${stamp_dir}/${name}-${step}-impl.cmake)
  701. endif()
  702. # Wrap the command in a script to log output to files.
  703. set(script ${stamp_dir}/${name}-${step}.cmake)
  704. set(logbase ${stamp_dir}/${name}-${step})
  705. file(WRITE ${script} "
  706. ${code_cygpath_make}
  707. set(ENV{VS_UNICODE_OUTPUT} \"\")
  708. set(command \"${command}\")
  709. execute_process(
  710. COMMAND \${command}
  711. RESULT_VARIABLE result
  712. OUTPUT_FILE \"${logbase}-out.log\"
  713. ERROR_FILE \"${logbase}-err.log\"
  714. )
  715. if(result)
  716. set(msg \"Command failed: \${result}\\n\")
  717. foreach(arg IN LISTS command)
  718. set(msg \"\${msg} '\${arg}'\")
  719. endforeach(arg)
  720. set(msg \"\${msg}\\nSee also\\n ${logbase}-*.log\\n\")
  721. message(FATAL_ERROR \"\${msg}\")
  722. else()
  723. set(msg \"${name} ${step} command succeeded. See also ${logbase}-*.log\\n\")
  724. message(STATUS \"\${msg}\")
  725. endif()
  726. ")
  727. set(command ${CMAKE_COMMAND} ${make} ${config} -P ${script})
  728. set(${cmd_var} "${command}" PARENT_SCOPE)
  729. endfunction(_ep_write_log_script)
  730. # This module used to use "/${CMAKE_CFG_INTDIR}" directly and produced
  731. # makefiles with "/./" in paths for custom command dependencies. Which
  732. # resulted in problems with parallel make -j invocations.
  733. #
  734. # This function was added so that the suffix (search below for ${cfgdir}) is
  735. # only set to "/${CMAKE_CFG_INTDIR}" when ${CMAKE_CFG_INTDIR} is not going to
  736. # be "." (multi-configuration build systems like Visual Studio and Xcode...)
  737. #
  738. function(_ep_get_configuration_subdir_suffix suffix_var)
  739. set(suffix "")
  740. if(CMAKE_CONFIGURATION_TYPES)
  741. set(suffix "/${CMAKE_CFG_INTDIR}")
  742. endif()
  743. set(${suffix_var} "${suffix}" PARENT_SCOPE)
  744. endfunction(_ep_get_configuration_subdir_suffix)
  745. function(ExternalProject_Add_StepTargets name)
  746. set(steps ${ARGN})
  747. _ep_get_configuration_subdir_suffix(cfgdir)
  748. ExternalProject_Get_Property(${name} stamp_dir)
  749. foreach(step ${steps})
  750. add_custom_target(${name}-${step}
  751. DEPENDS ${stamp_dir}${cfgdir}/${name}-${step})
  752. endforeach()
  753. endfunction(ExternalProject_Add_StepTargets)
  754. function(ExternalProject_Add_Step name step)
  755. set(cmf_dir ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles)
  756. ExternalProject_Get_Property(${name} stamp_dir)
  757. _ep_get_configuration_subdir_suffix(cfgdir)
  758. add_custom_command(APPEND
  759. OUTPUT ${cmf_dir}${cfgdir}/${name}-complete
  760. DEPENDS ${stamp_dir}${cfgdir}/${name}-${step}
  761. )
  762. _ep_parse_arguments(ExternalProject_Add_Step
  763. ${name} _EP_${step}_ "${ARGN}")
  764. # Steps depending on this step.
  765. get_property(dependers TARGET ${name} PROPERTY _EP_${step}_DEPENDERS)
  766. foreach(depender IN LISTS dependers)
  767. add_custom_command(APPEND
  768. OUTPUT ${stamp_dir}${cfgdir}/${name}-${depender}
  769. DEPENDS ${stamp_dir}${cfgdir}/${name}-${step}
  770. )
  771. endforeach()
  772. # Dependencies on files.
  773. get_property(depends TARGET ${name} PROPERTY _EP_${step}_DEPENDS)
  774. # Dependencies on steps.
  775. get_property(dependees TARGET ${name} PROPERTY _EP_${step}_DEPENDEES)
  776. foreach(dependee IN LISTS dependees)
  777. list(APPEND depends ${stamp_dir}${cfgdir}/${name}-${dependee})
  778. endforeach()
  779. # The command to run.
  780. get_property(command TARGET ${name} PROPERTY _EP_${step}_COMMAND)
  781. if(command)
  782. set(comment "Performing ${step} step for '${name}'")
  783. else()
  784. set(comment "No ${step} step for '${name}'")
  785. endif()
  786. get_property(work_dir TARGET ${name} PROPERTY _EP_${step}_WORKING_DIRECTORY)
  787. # Replace list separators.
  788. get_property(sep TARGET ${name} PROPERTY _EP_LIST_SEPARATOR)
  789. if(sep AND command)
  790. string(REPLACE "${sep}" "\\;" command "${command}")
  791. endif()
  792. # Replace location tags.
  793. _ep_replace_location_tags(${name} comment command work_dir)
  794. # Custom comment?
  795. get_property(comment_set TARGET ${name} PROPERTY _EP_${step}_COMMENT SET)
  796. if(comment_set)
  797. get_property(comment TARGET ${name} PROPERTY _EP_${step}_COMMENT)
  798. endif()
  799. # Run every time?
  800. get_property(always TARGET ${name} PROPERTY _EP_${step}_ALWAYS)
  801. if(always)
  802. set_property(SOURCE ${stamp_dir}${cfgdir}/${name}-${step} PROPERTY SYMBOLIC 1)
  803. set(touch)
  804. else()
  805. set(touch ${CMAKE_COMMAND} -E touch ${stamp_dir}${cfgdir}/${name}-${step})
  806. endif()
  807. # Wrap with log script?
  808. get_property(log TARGET ${name} PROPERTY _EP_${step}_LOG)
  809. if(command AND log)
  810. _ep_write_log_script(${name} ${step} command)
  811. endif()
  812. add_custom_command(
  813. OUTPUT ${stamp_dir}${cfgdir}/${name}-${step}
  814. COMMENT ${comment}
  815. COMMAND ${command}
  816. COMMAND ${touch}
  817. DEPENDS ${depends}
  818. WORKING_DIRECTORY ${work_dir}
  819. VERBATIM
  820. )
  821. # Add custom "step target"?
  822. get_property(step_targets TARGET ${name} PROPERTY _EP_STEP_TARGETS)
  823. if(NOT step_targets)
  824. get_property(step_targets DIRECTORY PROPERTY EP_STEP_TARGETS)
  825. endif()
  826. foreach(st ${step_targets})
  827. if("${st}" STREQUAL "${step}")
  828. ExternalProject_Add_StepTargets(${name} ${step})
  829. break()
  830. endif()
  831. endforeach()
  832. endfunction(ExternalProject_Add_Step)
  833. function(_ep_add_mkdir_command name)
  834. ExternalProject_Get_Property(${name}
  835. source_dir binary_dir install_dir stamp_dir download_dir tmp_dir)
  836. _ep_get_configuration_subdir_suffix(cfgdir)
  837. ExternalProject_Add_Step(${name} mkdir
  838. COMMENT "Creating directories for '${name}'"
  839. COMMAND ${CMAKE_COMMAND} -E make_directory ${source_dir}
  840. COMMAND ${CMAKE_COMMAND} -E make_directory ${binary_dir}
  841. COMMAND ${CMAKE_COMMAND} -E make_directory ${install_dir}
  842. COMMAND ${CMAKE_COMMAND} -E make_directory ${tmp_dir}
  843. COMMAND ${CMAKE_COMMAND} -E make_directory ${stamp_dir}${cfgdir}
  844. COMMAND ${CMAKE_COMMAND} -E make_directory ${download_dir}
  845. )
  846. endfunction(_ep_add_mkdir_command)
  847. function(_ep_get_git_version git_EXECUTABLE git_version_var)
  848. if(git_EXECUTABLE)
  849. execute_process(
  850. COMMAND "${git_EXECUTABLE}" --version
  851. OUTPUT_VARIABLE ov
  852. OUTPUT_STRIP_TRAILING_WHITESPACE
  853. )
  854. string(REGEX REPLACE "^git version (.+)$" "\\1" version "${ov}")
  855. set(${git_version_var} "${version}" PARENT_SCOPE)
  856. endif()
  857. endfunction()
  858. function(_ep_is_dir_empty dir empty_var)
  859. file(GLOB gr "${dir}/*")
  860. if("${gr}" STREQUAL "")
  861. set(${empty_var} 1 PARENT_SCOPE)
  862. else()
  863. set(${empty_var} 0 PARENT_SCOPE)
  864. endif()
  865. endfunction()
  866. function(_ep_add_download_command name)
  867. ExternalProject_Get_Property(${name} source_dir stamp_dir download_dir tmp_dir)
  868. get_property(cmd_set TARGET ${name} PROPERTY _EP_DOWNLOAD_COMMAND SET)
  869. get_property(cmd TARGET ${name} PROPERTY _EP_DOWNLOAD_COMMAND)
  870. get_property(cvs_repository TARGET ${name} PROPERTY _EP_CVS_REPOSITORY)
  871. get_property(svn_repository TARGET ${name} PROPERTY _EP_SVN_REPOSITORY)
  872. get_property(git_repository TARGET ${name} PROPERTY _EP_GIT_REPOSITORY)
  873. get_property(url TARGET ${name} PROPERTY _EP_URL)
  874. # TODO: Perhaps file:// should be copied to download dir before extraction.
  875. string(REGEX REPLACE "^file://" "" url "${url}")
  876. set(depends)
  877. set(comment)
  878. set(work_dir)
  879. if(cmd_set)
  880. set(work_dir ${download_dir})
  881. elseif(cvs_repository)
  882. find_package(CVS)
  883. if(NOT CVS_EXECUTABLE)
  884. message(FATAL_ERROR "error: could not find cvs for checkout of ${name}")
  885. endif()
  886. get_target_property(cvs_module ${name} _EP_CVS_MODULE)
  887. if(NOT cvs_module)
  888. message(FATAL_ERROR "error: no CVS_MODULE")
  889. endif()
  890. get_property(cvs_tag TARGET ${name} PROPERTY _EP_CVS_TAG)
  891. set(repository ${cvs_repository})
  892. set(module ${cvs_module})
  893. set(tag ${cvs_tag})
  894. configure_file(
  895. "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
  896. "${stamp_dir}/${name}-cvsinfo.txt"
  897. @ONLY
  898. )
  899. get_filename_component(src_name "${source_dir}" NAME)
  900. get_filename_component(work_dir "${source_dir}" PATH)
  901. set(comment "Performing download step (CVS checkout) for '${name}'")
  902. set(cmd ${CVS_EXECUTABLE} -d ${cvs_repository} -q co ${cvs_tag} -d ${src_name} ${cvs_module})
  903. list(APPEND depends ${stamp_dir}/${name}-cvsinfo.txt)
  904. elseif(svn_repository)
  905. find_package(Subversion)
  906. if(NOT Subversion_SVN_EXECUTABLE)
  907. message(FATAL_ERROR "error: could not find svn for checkout of ${name}")
  908. endif()
  909. get_property(svn_revision TARGET ${name} PROPERTY _EP_SVN_REVISION)
  910. get_property(svn_username TARGET ${name} PROPERTY _EP_SVN_USERNAME)
  911. get_property(svn_password TARGET ${name} PROPERTY _EP_SVN_PASSWORD)
  912. get_property(svn_trust_cert TARGET ${name} PROPERTY _EP_SVN_TRUST_CERT)
  913. set(repository "${svn_repository} user=${svn_username} password=${svn_password}")
  914. set(module)
  915. set(tag ${svn_revision})
  916. configure_file(
  917. "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
  918. "${stamp_dir}/${name}-svninfo.txt"
  919. @ONLY
  920. )
  921. get_filename_component(src_name "${source_dir}" NAME)
  922. get_filename_component(work_dir "${source_dir}" PATH)
  923. set(comment "Performing download step (SVN checkout) for '${name}'")
  924. set(svn_user_pw_args "")
  925. if(svn_username)
  926. set(svn_user_pw_args ${svn_user_pw_args} "--username=${svn_username}")
  927. endif()
  928. if(svn_password)
  929. set(svn_user_pw_args ${svn_user_pw_args} "--password=${svn_password}")
  930. endif()
  931. if(svn_trust_cert)
  932. set(svn_trust_cert_args --trust-server-cert)
  933. endif()
  934. set(cmd ${Subversion_SVN_EXECUTABLE} co ${svn_repository} ${svn_revision}
  935. --non-interactive ${svn_trust_cert_args} ${svn_user_pw_args} ${src_name})
  936. list(APPEND depends ${stamp_dir}/${name}-svninfo.txt)
  937. elseif(git_repository)
  938. find_package(Git)
  939. if(NOT GIT_EXECUTABLE)
  940. message(FATAL_ERROR "error: could not find git for clone of ${name}")
  941. endif()
  942. # The git submodule update '--recursive' flag requires git >= v1.6.5
  943. #
  944. _ep_get_git_version("${GIT_EXECUTABLE}" git_version)
  945. if(git_version VERSION_LESS 1.6.5)
  946. message(FATAL_ERROR "error: git version 1.6.5 or later required for 'git submodule update --recursive': git_version='${git_version}'")
  947. endif()
  948. get_property(git_tag TARGET ${name} PROPERTY _EP_GIT_TAG)
  949. if(NOT git_tag)
  950. set(git_tag "master")
  951. endif()
  952. set(repository ${git_repository})
  953. set(module)
  954. set(tag ${git_tag})
  955. configure_file(
  956. "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
  957. "${stamp_dir}/${name}-gitinfo.txt"
  958. @ONLY
  959. )
  960. get_filename_component(src_name "${source_dir}" NAME)
  961. get_filename_component(work_dir "${source_dir}" PATH)
  962. # Since git clone doesn't succeed if the non-empty source_dir exists,
  963. # create a cmake script to invoke as download command.
  964. # The script will delete the source directory and then call git clone.
  965. #
  966. _ep_write_gitclone_script(${tmp_dir}/${name}-gitclone.cmake ${source_dir}
  967. ${GIT_EXECUTABLE} ${git_repository} ${git_tag} ${src_name} ${work_dir}
  968. )
  969. set(comment "Performing download step (git clone) for '${name}'")
  970. set(cmd ${CMAKE_COMMAND} -P ${tmp_dir}/${name}-gitclone.cmake)
  971. list(APPEND depends ${stamp_dir}/${name}-gitinfo.txt)
  972. elseif(url)
  973. get_filename_component(work_dir "${source_dir}" PATH)
  974. get_property(md5 TARGET ${name} PROPERTY _EP_URL_MD5)
  975. set(repository "external project URL")
  976. set(module "${url}")
  977. set(tag "${md5}")
  978. configure_file(
  979. "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
  980. "${stamp_dir}/${name}-urlinfo.txt"
  981. @ONLY
  982. )
  983. list(APPEND depends ${stamp_dir}/${name}-urlinfo.txt)
  984. if(IS_DIRECTORY "${url}")
  985. get_filename_component(abs_dir "${url}" ABSOLUTE)
  986. set(comment "Performing download step (DIR copy) for '${name}'")
  987. set(cmd ${CMAKE_COMMAND} -E remove_directory ${source_dir}
  988. COMMAND ${CMAKE_COMMAND} -E copy_directory ${abs_dir} ${source_dir})
  989. else()
  990. if("${url}" MATCHES "^[a-z]+://")
  991. # TODO: Should download and extraction be different steps?
  992. string(REGEX MATCH "[^/\\?]*$" fname "${url}")
  993. if(NOT "${fname}" MATCHES "(\\.|=)(bz2|tar|tgz|tar\\.gz|zip)$")
  994. string(REGEX MATCH "([^/\\?]+(\\.|=)(bz2|tar|tgz|tar\\.gz|zip))/.*$" match_result "${url}")
  995. set(fname "${CMAKE_MATCH_1}")
  996. endif()
  997. if(NOT "${fname}" MATCHES "(\\.|=)(bz2|tar|tgz|tar\\.gz|zip)$")
  998. message(FATAL_ERROR "Could not extract tarball filename from url:\n ${url}")
  999. endif()
  1000. string(REPLACE ";" "-" fname "${fname}")
  1001. set(file ${download_dir}/${fname})
  1002. get_property(timeout TARGET ${name} PROPERTY _EP_TIMEOUT)
  1003. _ep_write_downloadfile_script("${stamp_dir}/download-${name}.cmake" "${url}" "${file}" "${timeout}" "${md5}")
  1004. set(cmd ${CMAKE_COMMAND} -P ${stamp_dir}/download-${name}.cmake
  1005. COMMAND)
  1006. set(comment "Performing download step (download, verify and extract) for '${name}'")
  1007. else()
  1008. set(file "${url}")
  1009. set(comment "Performing download step (verify and extract) for '${name}'")
  1010. endif()
  1011. _ep_write_verifyfile_script("${stamp_dir}/verify-${name}.cmake" "${file}" "${md5}")
  1012. list(APPEND cmd ${CMAKE_COMMAND} -P ${stamp_dir}/verify-${name}.cmake)
  1013. _ep_write_extractfile_script("${stamp_dir}/extract-${name}.cmake" "${name}" "${file}" "${source_dir}")
  1014. list(APPEND cmd ${CMAKE_COMMAND} -P ${stamp_dir}/extract-${name}.cmake)
  1015. endif()
  1016. else()
  1017. _ep_is_dir_empty("${source_dir}" empty)
  1018. if(${empty})
  1019. message(SEND_ERROR "error: no download info for '${name}' -- please specify existing/non-empty SOURCE_DIR or one of URL, CVS_REPOSITORY and CVS_MODULE, SVN_REPOSITORY, GIT_REPOSITORY or DOWNLOAD_COMMAND")
  1020. endif()
  1021. endif()
  1022. get_property(log TARGET ${name} PROPERTY _EP_LOG_DOWNLOAD)
  1023. if(log)
  1024. set(log LOG 1)
  1025. else()
  1026. set(log "")
  1027. endif()
  1028. ExternalProject_Add_Step(${name} download
  1029. COMMENT ${comment}
  1030. COMMAND ${cmd}
  1031. WORKING_DIRECTORY ${work_dir}
  1032. DEPENDS ${depends}
  1033. DEPENDEES mkdir
  1034. ${log}
  1035. )
  1036. endfunction(_ep_add_download_command)
  1037. function(_ep_add_update_command name)
  1038. ExternalProject_Get_Property(${name} source_dir)
  1039. get_property(cmd_set TARGET ${name} PROPERTY _EP_UPDATE_COMMAND SET)
  1040. get_property(cmd TARGET ${name} PROPERTY _EP_UPDATE_COMMAND)
  1041. get_property(cvs_repository TARGET ${name} PROPERTY _EP_CVS_REPOSITORY)
  1042. get_property(svn_repository TARGET ${name} PROPERTY _EP_SVN_REPOSITORY)
  1043. get_property(git_repository TARGET ${name} PROPERTY _EP_GIT_REPOSITORY)
  1044. set(work_dir)
  1045. set(comment)
  1046. set(always)
  1047. if(cmd_set)
  1048. set(work_dir ${source_dir})
  1049. elseif(cvs_repository)
  1050. if(NOT CVS_EXECUTABLE)
  1051. message(FATAL_ERROR "error: could not find cvs for update of ${name}")
  1052. endif()
  1053. set(work_dir ${source_dir})
  1054. set(comment "Performing update step (CVS update) for '${name}'")
  1055. get_property(cvs_tag TARGET ${name} PROPERTY _EP_CVS_TAG)
  1056. set(cmd ${CVS_EXECUTABLE} -d ${cvs_repository} -q up -dP ${cvs_tag})
  1057. set(always 1)
  1058. elseif(svn_repository)
  1059. if(NOT Subversion_SVN_EXECUTABLE)
  1060. message(FATAL_ERROR "error: could not find svn for update of ${name}")
  1061. endif()
  1062. set(work_dir ${source_dir})
  1063. set(comment "Performing update step (SVN update) for '${name}'")
  1064. get_property(svn_revision TARGET ${name} PROPERTY _EP_SVN_REVISION)
  1065. get_property(svn_username TARGET ${name} PROPERTY _EP_SVN_USERNAME)
  1066. get_property(svn_password TARGET ${name} PROPERTY _EP_SVN_PASSWORD)
  1067. get_property(svn_trust_cert TARGET ${name} PROPERTY _EP_SVN_TRUST_CERT)
  1068. set(svn_user_pw_args "")
  1069. if(svn_username)
  1070. set(svn_user_pw_args ${svn_user_pw_args} "--username=${svn_username}")
  1071. endif()
  1072. if(svn_password)
  1073. set(svn_user_pw_args ${svn_user_pw_args} "--password=${svn_password}")
  1074. endif()
  1075. if(svn_trust_cert)
  1076. set(svn_trust_cert_args --trust-server-cert)
  1077. endif()
  1078. set(cmd ${Subversion_SVN_EXECUTABLE} up ${svn_revision}
  1079. --non-interactive ${svn_trust_cert_args} ${svn_user_pw_args})
  1080. set(always 1)
  1081. elseif(git_repository)
  1082. if(NOT GIT_EXECUTABLE)
  1083. message(FATAL_ERROR "error: could not find git for fetch of ${name}")
  1084. endif()
  1085. set(work_dir ${source_dir})
  1086. set(comment "Performing update step (git fetch) for '${name}'")
  1087. get_property(git_tag TARGET ${name} PROPERTY _EP_GIT_TAG)
  1088. if(NOT git_tag)
  1089. set(git_tag "master")
  1090. endif()
  1091. set(cmd ${GIT_EXECUTABLE} fetch
  1092. COMMAND ${GIT_EXECUTABLE} checkout ${git_tag}
  1093. COMMAND ${GIT_EXECUTABLE} submodule update --recursive
  1094. )
  1095. set(always 1)
  1096. endif()
  1097. get_property(log TARGET ${name} PROPERTY _EP_LOG_UPDATE)
  1098. if(log)
  1099. set(log LOG 1)
  1100. else()
  1101. set(log "")
  1102. endif()
  1103. ExternalProject_Add_Step(${name} update
  1104. COMMENT ${comment}
  1105. COMMAND ${cmd}
  1106. ALWAYS ${always}
  1107. WORKING_DIRECTORY ${work_dir}
  1108. DEPENDEES download
  1109. ${log}
  1110. )
  1111. endfunction(_ep_add_update_command)
  1112. function(_ep_add_patch_command name)
  1113. ExternalProject_Get_Property(${name} source_dir)
  1114. get_property(cmd_set TARGET ${name} PROPERTY _EP_PATCH_COMMAND SET)
  1115. get_property(cmd TARGET ${name} PROPERTY _EP_PATCH_COMMAND)
  1116. set(work_dir)
  1117. if(cmd_set)
  1118. set(work_dir ${source_dir})
  1119. endif()
  1120. ExternalProject_Add_Step(${name} patch
  1121. COMMAND ${cmd}
  1122. WORKING_DIRECTORY ${work_dir}
  1123. DEPENDEES download
  1124. )
  1125. endfunction(_ep_add_patch_command)
  1126. # TODO: Make sure external projects use the proper compiler
  1127. function(_ep_add_configure_command name)
  1128. ExternalProject_Get_Property(${name} source_dir binary_dir tmp_dir)
  1129. _ep_get_configuration_subdir_suffix(cfgdir)
  1130. # Depend on other external projects (file-level).
  1131. set(file_deps)
  1132. get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
  1133. foreach(dep IN LISTS deps)
  1134. get_property(dep_stamp_dir TARGET ${dep} PROPERTY _EP_STAMP_DIR)
  1135. list(APPEND file_deps ${dep_stamp_dir}${cfgdir}/${dep}-done)
  1136. endforeach()
  1137. get_property(cmd_set TARGET ${name} PROPERTY _EP_CONFIGURE_COMMAND SET)
  1138. if(cmd_set)
  1139. get_property(cmd TARGET ${name} PROPERTY _EP_CONFIGURE_COMMAND)
  1140. else()
  1141. get_target_property(cmake_command ${name} _EP_CMAKE_COMMAND)
  1142. if(cmake_command)
  1143. set(cmd "${cmake_command}")
  1144. else()
  1145. set(cmd "${CMAKE_COMMAND}")
  1146. endif()
  1147. get_property(cmake_args TARGET ${name} PROPERTY _EP_CMAKE_ARGS)
  1148. list(APPEND cmd ${cmake_args})
  1149. # If there are any CMAKE_CACHE_ARGS, write an initial cache and use it
  1150. get_property(cmake_cache_args TARGET ${name} PROPERTY _EP_CMAKE_CACHE_ARGS)
  1151. if(cmake_cache_args)
  1152. set(_ep_cache_args_script "${tmp_dir}/${name}-cache.cmake")
  1153. _ep_write_initial_cache(${name} "${_ep_cache_args_script}" "${cmake_cache_args}")
  1154. list(APPEND cmd "-C${_ep_cache_args_script}")
  1155. endif()
  1156. get_target_property(cmake_generator ${name} _EP_CMAKE_GENERATOR)
  1157. if(cmake_generator)
  1158. list(APPEND cmd "-G${cmake_generator}" "${source_dir}")
  1159. else()
  1160. if(CMAKE_EXTRA_GENERATOR)
  1161. list(APPEND cmd "-G${CMAKE_EXTRA_GENERATOR} - ${CMAKE_GENERATOR}"
  1162. "${source_dir}")
  1163. else()
  1164. list(APPEND cmd "-G${CMAKE_GENERATOR}" "${source_dir}")
  1165. endif()
  1166. endif()
  1167. endif()
  1168. # If anything about the configure command changes, (command itself, cmake
  1169. # used, cmake args or cmake generator) then re-run the configure step.
  1170. # Fixes issue http://public.kitware.com/Bug/view.php?id=10258
  1171. #
  1172. if(NOT EXISTS ${tmp_dir}/${name}-cfgcmd.txt.in)
  1173. file(WRITE ${tmp_dir}/${name}-cfgcmd.txt.in "cmd='\@cmd\@'\n")
  1174. endif()
  1175. configure_file(${tmp_dir}/${name}-cfgcmd.txt.in ${tmp_dir}/${name}-cfgcmd.txt)
  1176. list(APPEND file_deps ${tmp_dir}/${name}-cfgcmd.txt)
  1177. list(APPEND file_deps ${_ep_cache_args_script})
  1178. get_property(log TARGET ${name} PROPERTY _EP_LOG_CONFIGURE)
  1179. if(log)
  1180. set(log LOG 1)
  1181. else()
  1182. set(log "")
  1183. endif()
  1184. ExternalProject_Add_Step(${name} configure
  1185. COMMAND ${cmd}
  1186. WORKING_DIRECTORY ${binary_dir}
  1187. DEPENDEES update patch
  1188. DEPENDS ${file_deps}
  1189. ${log}
  1190. )
  1191. endfunction(_ep_add_configure_command)
  1192. function(_ep_add_build_command name)
  1193. ExternalProject_Get_Property(${name} binary_dir)
  1194. get_property(cmd_set TARGET ${name} PROPERTY _EP_BUILD_COMMAND SET)
  1195. if(cmd_set)
  1196. get_property(cmd TARGET ${name} PROPERTY _EP_BUILD_COMMAND)
  1197. else()
  1198. _ep_get_build_command(${name} BUILD cmd)
  1199. endif()
  1200. get_property(log TARGET ${name} PROPERTY _EP_LOG_BUILD)
  1201. if(log)
  1202. set(log LOG 1)
  1203. else()
  1204. set(log "")
  1205. endif()
  1206. ExternalProject_Add_Step(${name} build
  1207. COMMAND ${cmd}
  1208. WORKING_DIRECTORY ${binary_dir}
  1209. DEPENDEES configure
  1210. ${log}
  1211. )
  1212. endfunction(_ep_add_build_command)
  1213. function(_ep_add_install_command name)
  1214. ExternalProject_Get_Property(${name} binary_dir)
  1215. get_property(cmd_set TARGET ${name} PROPERTY _EP_INSTALL_COMMAND SET)
  1216. if(cmd_set)
  1217. get_property(cmd TARGET ${name} PROPERTY _EP_INSTALL_COMMAND)
  1218. else()
  1219. _ep_get_build_command(${name} INSTALL cmd)
  1220. endif()
  1221. get_property(log TARGET ${name} PROPERTY _EP_LOG_INSTALL)
  1222. if(log)
  1223. set(log LOG 1)
  1224. else()
  1225. set(log "")
  1226. endif()
  1227. ExternalProject_Add_Step(${name} install
  1228. COMMAND ${cmd}
  1229. WORKING_DIRECTORY ${binary_dir}
  1230. DEPENDEES build
  1231. ${log}
  1232. )
  1233. endfunction(_ep_add_install_command)
  1234. function(_ep_add_test_command name)
  1235. ExternalProject_Get_Property(${name} binary_dir)
  1236. get_property(before TARGET ${name} PROPERTY _EP_TEST_BEFORE_INSTALL)
  1237. get_property(after TARGET ${name} PROPERTY _EP_TEST_AFTER_INSTALL)
  1238. get_property(cmd_set TARGET ${name} PROPERTY _EP_TEST_COMMAND SET)
  1239. # Only actually add the test step if one of the test related properties is
  1240. # explicitly set. (i.e. the test step is omitted unless requested...)
  1241. #
  1242. if(cmd_set OR before OR after)
  1243. if(cmd_set)
  1244. get_property(cmd TARGET ${name} PROPERTY _EP_TEST_COMMAND)
  1245. else()
  1246. _ep_get_build_command(${name} TEST cmd)
  1247. endif()
  1248. if(before)
  1249. set(dep_args DEPENDEES build DEPENDERS install)
  1250. else()
  1251. set(dep_args DEPENDEES install)
  1252. endif()
  1253. get_property(log TARGET ${name} PROPERTY _EP_LOG_TEST)
  1254. if(log)
  1255. set(log LOG 1)
  1256. else()
  1257. set(log "")
  1258. endif()
  1259. ExternalProject_Add_Step(${name} test
  1260. COMMAND ${cmd}
  1261. WORKING_DIRECTORY ${binary_dir}
  1262. ${dep_args}
  1263. ${log}
  1264. )
  1265. endif()
  1266. endfunction(_ep_add_test_command)
  1267. function(ExternalProject_Add name)
  1268. _ep_get_configuration_subdir_suffix(cfgdir)
  1269. # Add a custom target for the external project.
  1270. set(cmf_dir ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles)
  1271. add_custom_target(${name} ALL DEPENDS ${cmf_dir}${cfgdir}/${name}-complete)
  1272. set_property(TARGET ${name} PROPERTY _EP_IS_EXTERNAL_PROJECT 1)
  1273. _ep_parse_arguments(ExternalProject_Add ${name} _EP_ "${ARGN}")
  1274. _ep_set_directories(${name})
  1275. ExternalProject_Get_Property(${name} stamp_dir)
  1276. # The 'complete' step depends on all other steps and creates a
  1277. # 'done' mark. A dependent external project's 'configure' step
  1278. # depends on the 'done' mark so that it rebuilds when this project
  1279. # rebuilds. It is important that 'done' is not the output of any
  1280. # custom command so that CMake does not propagate build rules to
  1281. # other external project targets.
  1282. add_custom_command(
  1283. OUTPUT ${cmf_dir}${cfgdir}/${name}-complete
  1284. COMMENT "Completed '${name}'"
  1285. COMMAND ${CMAKE_COMMAND} -E make_directory ${cmf_dir}${cfgdir}
  1286. COMMAND ${CMAKE_COMMAND} -E touch ${cmf_dir}${cfgdir}/${name}-complete
  1287. COMMAND ${CMAKE_COMMAND} -E touch ${stamp_dir}${cfgdir}/${name}-done
  1288. DEPENDS ${stamp_dir}${cfgdir}/${name}-install
  1289. VERBATIM
  1290. )
  1291. # Depend on other external projects (target-level).
  1292. get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
  1293. foreach(arg IN LISTS deps)
  1294. add_dependencies(${name} ${arg})
  1295. endforeach()
  1296. # Set up custom build steps based on the target properties.
  1297. # Each step depends on the previous one.
  1298. #
  1299. # The target depends on the output of the final step.
  1300. # (Already set up above in the DEPENDS of the add_custom_target command.)
  1301. #
  1302. _ep_add_mkdir_command(${name})
  1303. _ep_add_download_command(${name})
  1304. _ep_add_update_command(${name})
  1305. _ep_add_patch_command(${name})
  1306. _ep_add_configure_command(${name})
  1307. _ep_add_build_command(${name})
  1308. _ep_add_install_command(${name})
  1309. # Test is special in that it might depend on build, or it might depend
  1310. # on install.
  1311. #
  1312. _ep_add_test_command(${name})
  1313. endfunction(ExternalProject_Add)