123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020 |
- # - Create custom targets to build projects in external trees
- # The 'ExternalProject_Add' function creates a custom target to drive
- # download, update/patch, configure, build, install and test steps of an
- # external project:
- # ExternalProject_Add(<name> # Name for custom target
- # [DEPENDS projects...] # Targets on which the project depends
- # [PREFIX dir] # Root dir for entire project
- # [LIST_SEPARATOR sep] # Sep to be replaced by ; in cmd lines
- # [TMP_DIR dir] # Directory to store temporary files
- # [STAMP_DIR dir] # Directory to store step timestamps
- # #--Download step--------------
- # [DOWNLOAD_DIR dir] # Directory to store downloaded files
- # [DOWNLOAD_COMMAND cmd...] # Command to download source tree
- # [CVS_REPOSITORY cvsroot] # CVSROOT of CVS repository
- # [CVS_MODULE mod] # Module to checkout from CVS repo
- # [CVS_TAG tag] # Tag to checkout from CVS repo
- # [SVN_REPOSITORY url] # URL of Subversion repo
- # [SVN_REVISION rev] # Revision to checkout from Subversion repo
- # [SVN_USERNAME john ] # Username to use for Subversion checkout and update
- # [SVN_PASSWORD doe ] # Password to use for Subversion checkout and update
- # [URL /.../src.tgz] # Full path or URL of source
- # [TIMEOUT seconds] # Time allowed for file download operations
- # [GIT_REPOSITORY url] # URL of GIT repo
- # #--Update/Patch step----------
- # [UPDATE_COMMAND cmd...] # Source work-tree update command
- # [PATCH_COMMAND cmd...] # Command to patch downloaded source
- # #--Configure step-------------
- # [SOURCE_DIR dir] # Source dir to be used for build
- # [CONFIGURE_COMMAND cmd...] # Build tree configuration command
- # [CMAKE_COMMAND /.../cmake] # Specify alternative cmake executable
- # [CMAKE_GENERATOR gen] # Specify generator for native build
- # [CMAKE_ARGS args...] # Arguments to CMake command line
- # #--Build step-----------------
- # [BINARY_DIR dir] # Specify build dir location
- # [BUILD_COMMAND cmd...] # Command to drive the native build
- # [BUILD_IN_SOURCE 1] # Use source dir for build dir
- # #--Install step---------------
- # [INSTALL_DIR dir] # Installation prefix
- # [INSTALL_COMMAND cmd...] # Command to drive install after build
- # #--Test step---------------
- # [TEST_BEFORE_INSTALL 1] # Add test step executed before install step
- # [TEST_AFTER_INSTALL 1] # Add test step executed after install step
- # [TEST_COMMAND cmd...] # Command to drive test
- # )
- # The *_DIR options specify directories for the project, with default
- # directories computed as follows.
- # If the PREFIX option is given to ExternalProject_Add() or the EP_PREFIX
- # directory property is set, then an external project is built and installed
- # under the specified prefix:
- # TMP_DIR = <prefix>/tmp
- # STAMP_DIR = <prefix>/src/<name>-stamp
- # DOWNLOAD_DIR = <prefix>/src
- # SOURCE_DIR = <prefix>/src/<name>
- # BINARY_DIR = <prefix>/src/<name>-build
- # INSTALL_DIR = <prefix>
- # Otherwise, if the EP_BASE directory property is set then components
- # of an external project are stored under the specified base:
- # TMP_DIR = <base>/tmp/<name>
- # STAMP_DIR = <base>/Stamp/<name>
- # DOWNLOAD_DIR = <base>/Download/<name>
- # SOURCE_DIR = <base>/Source/<name>
- # BINARY_DIR = <base>/Build/<name>
- # INSTALL_DIR = <base>/Install/<name>
- # If no PREFIX, EP_PREFIX, or EP_BASE is specified then the default
- # is to set PREFIX to "<name>-prefix".
- # Relative paths are interpreted with respect to the build directory
- # corresponding to the source directory in which ExternalProject_Add is
- # invoked.
- #
- # If SOURCE_DIR is explicitly set to an existing directory the project
- # will be built from it.
- # Otherwise a download step must be specified using one of the
- # DOWNLOAD_COMMAND, CVS_*, SVN_*, or URL options.
- # The URL option may refer locally to a directory or source tarball,
- # or refer to a remote tarball (e.g. http://.../src.tgz).
- #
- # The 'ExternalProject_Add_Step' function adds a custom step to an external
- # project:
- # ExternalProject_Add_Step(<name> <step> # Names of project and custom step
- # [COMMAND cmd...] # Command line invoked by this step
- # [COMMENT "text..."] # Text printed when step executes
- # [DEPENDEES steps...] # Steps on which this step depends
- # [DEPENDERS steps...] # Steps that depend on this step
- # [DEPENDS files...] # Files on which this step depends
- # [ALWAYS 1] # No stamp file, step always runs
- # [WORKING_DIRECTORY dir] # Working directory for command
- # )
- # The command line, comment, and working directory of every standard
- # and custom step is processed to replace tokens
- # <SOURCE_DIR>,
- # <BINARY_DIR>,
- # <INSTALL_DIR>,
- # and <TMP_DIR>
- # with corresponding property values.
- #
- # The 'ExternalProject_Get_Property' function retrieves external project
- # target properties:
- # ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])
- # It stores property values in variables of the same name.
- # Property names correspond to the keyword argument names of
- # 'ExternalProject_Add'.
- #=============================================================================
- # Copyright 2008-2009 Kitware, Inc.
- #
- # Distributed under the OSI-approved BSD License (the "License");
- # see accompanying file Copyright.txt for details.
- #
- # This software is distributed WITHOUT ANY WARRANTY; without even the
- # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- # See the License for more information.
- #=============================================================================
- # (To distributed this file outside of CMake, substitute the full
- # License text for the above reference.)
- # Pre-compute a regex to match documented keywords for each command.
- file(STRINGS "${CMAKE_CURRENT_LIST_FILE}" lines LIMIT_COUNT 103
- REGEX "^# ( \\[[A-Z_]+ [^]]*\\] +#.*$|[A-Za-z_]+\\()")
- foreach(line IN LISTS lines)
- if("${line}" MATCHES "^# [A-Za-z_]+\\(")
- if(_ep_func)
- set(_ep_keywords_${_ep_func} "${_ep_keywords_${_ep_func}})$")
- endif()
- string(REGEX REPLACE "^# ([A-Za-z_]+)\\(.*" "\\1" _ep_func "${line}")
- #message("function [${_ep_func}]")
- set(_ep_keywords_${_ep_func} "^(")
- set(_ep_keyword_sep)
- else()
- string(REGEX REPLACE "^# \\[([A-Z_]+) .*" "\\1" _ep_key "${line}")
- #message(" keyword [${_ep_key}]")
- set(_ep_keywords_${_ep_func}
- "${_ep_keywords_${_ep_func}}${_ep_keyword_sep}${_ep_key}")
- set(_ep_keyword_sep "|")
- endif()
- endforeach()
- if(_ep_func)
- set(_ep_keywords_${_ep_func} "${_ep_keywords_${_ep_func}})$")
- endif()
- function(_ep_parse_arguments f name ns args)
- # Transfer the arguments to this function into target properties for the
- # new custom target we just added so that we can set up all the build steps
- # correctly based on target properties.
- #
- # We loop through ARGN and consider the namespace starting with an
- # upper-case letter followed by at least two more upper-case letters
- # or underscores to be keywords.
- set(key)
- foreach(arg IN LISTS args)
- set(is_value 1)
- if(arg MATCHES "^[A-Z][A-Z_][A-Z_]+$" AND
- NOT ((arg STREQUAL "${key}") AND (key STREQUAL "COMMAND")) AND
- NOT arg MATCHES "^(TRUE|FALSE)$")
- if(_ep_keywords_${f} AND arg MATCHES "${_ep_keywords_${f}}")
- set(is_value 0)
- else()
- if(NOT (key STREQUAL "COMMAND")
- AND NOT (key STREQUAL "CVS_MODULE")
- AND NOT (key STREQUAL "DEPENDS")
- )
- message(AUTHOR_WARNING "unknown ${f} keyword: ${arg}")
- endif()
- endif()
- endif()
- if(is_value)
- if(key)
- # Value
- if(NOT arg STREQUAL "")
- set_property(TARGET ${name} APPEND PROPERTY ${ns}${key} "${arg}")
- else()
- get_property(have_key TARGET ${name} PROPERTY ${ns}${key} SET)
- if(have_key)
- get_property(value TARGET ${name} PROPERTY ${ns}${key})
- set_property(TARGET ${name} PROPERTY ${ns}${key} "${value};${arg}")
- else()
- set_property(TARGET ${name} PROPERTY ${ns}${key} "${arg}")
- endif()
- endif()
- else()
- # Missing Keyword
- message(AUTHOR_WARNING "value '${arg}' with no previous keyword in ${f}")
- endif()
- else()
- set(key "${arg}")
- endif()
- endforeach()
- endfunction(_ep_parse_arguments)
- define_property(DIRECTORY PROPERTY "EP_BASE" INHERITED
- BRIEF_DOCS "Base directory for External Project storage."
- FULL_DOCS
- "See documentation of the ExternalProject_Add() function in the "
- "ExternalProject module."
- )
- define_property(DIRECTORY PROPERTY "EP_PREFIX" INHERITED
- BRIEF_DOCS "Top prefix for External Project storage."
- FULL_DOCS
- "See documentation of the ExternalProject_Add() function in the "
- "ExternalProject module."
- )
- function(_ep_write_downloadfile_script script_filename remote local timeout)
- if(timeout)
- set(timeout_args TIMEOUT ${timeout})
- set(timeout_msg "${timeout} seconds")
- else()
- set(timeout_args "# no TIMEOUT")
- set(timeout_msg "none")
- endif()
- file(WRITE ${script_filename}
- "message(STATUS \"downloading...
- src='${remote}'
- dst='${local}'
- timeout='${timeout_msg}'\")
- file(DOWNLOAD
- \"${remote}\"
- \"${local}\"
- ${timeout_args}
- STATUS status
- LOG log)
- list(GET status 0 status_code)
- list(GET status 1 status_string)
- if(NOT status_code EQUAL 0)
- message(FATAL_ERROR \"error: downloading '${remote}' failed
- status_code: \${status_code}
- status_string: \${status_string}
- log: \${log}
- \")
- endif()
- message(STATUS \"downloading... done\")
- "
- )
- endfunction(_ep_write_downloadfile_script)
- function(_ep_write_extractfile_script script_filename filename tmp directory)
- set(args "")
- if(filename MATCHES ".tar$")
- set(args xf)
- endif()
- if(filename MATCHES ".tgz$")
- set(args xfz)
- endif()
- if(filename MATCHES ".tar.gz$")
- set(args xfz)
- endif()
- if(args STREQUAL "")
- message(SEND_ERROR "error: do not know how to extract '${filename}' -- known types are .tar, .tgz and .tar.gz")
- return()
- endif()
- file(WRITE ${script_filename}
- "# Make file names absolute:
- #
- get_filename_component(filename \"${filename}\" ABSOLUTE)
- get_filename_component(tmp \"${tmp}\" ABSOLUTE)
- get_filename_component(directory \"${directory}\" ABSOLUTE)
- message(STATUS \"extracting...
- src='\${filename}'
- dst='\${directory}'\")
- # Prepare a space for extracting:
- #
- set(i 1)
- while(EXISTS \"\${tmp}/extract\${i}\")
- math(EXPR i \"\${i} + 1\")
- endwhile()
- set(ut_dir \"\${tmp}/extract\${i}\")
- file(MAKE_DIRECTORY \"\${ut_dir}\")
- # Extract it:
- #
- message(STATUS \"extracting... [tar ${args}]\")
- execute_process(COMMAND \${CMAKE_COMMAND} -E tar ${args} \${filename}
- WORKING_DIRECTORY \${ut_dir}
- RESULT_VARIABLE rv)
- if(NOT rv EQUAL 0)
- message(STATUS \"extracting... [error clean up]\")
- file(REMOVE_RECURSE \"\${ut_dir}\")
- message(FATAL_ERROR \"error: extract of '\${filename}' failed\")
- endif()
- # Analyze what came out of the tar file:
- #
- message(STATUS \"extracting... [analysis]\")
- file(GLOB contents \"\${ut_dir}/*\")
- list(LENGTH contents n)
- if(NOT n EQUAL 1 OR NOT IS_DIRECTORY \"\${contents}\")
- set(contents \"\${ut_dir}\")
- endif()
- # Copy \"the one\" directory to the final directory:
- #
- message(STATUS \"extracting... [copy]\")
- file(COPY \"\${contents}/\" DESTINATION \${directory})
- # Clean up:
- #
- message(STATUS \"extracting... [clean up]\")
- file(REMOVE_RECURSE \"\${ut_dir}\")
- message(STATUS \"extracting... done\")
- "
- )
- endfunction(_ep_write_extractfile_script)
- function(_ep_set_directories name)
- get_property(prefix TARGET ${name} PROPERTY _EP_PREFIX)
- if(NOT prefix)
- get_property(prefix DIRECTORY PROPERTY EP_PREFIX)
- if(NOT prefix)
- get_property(base DIRECTORY PROPERTY EP_BASE)
- if(NOT base)
- set(prefix "${name}-prefix")
- endif()
- endif()
- endif()
- if(prefix)
- set(tmp_default "${prefix}/tmp")
- set(download_default "${prefix}/src")
- set(source_default "${prefix}/src/${name}")
- set(binary_default "${prefix}/src/${name}-build")
- set(stamp_default "${prefix}/src/${name}-stamp")
- set(install_default "${prefix}")
- else() # assert(base)
- set(tmp_default "${base}/tmp/${name}")
- set(download_default "${base}/Download/${name}")
- set(source_default "${base}/Source/${name}")
- set(binary_default "${base}/Build/${name}")
- set(stamp_default "${base}/Stamp/${name}")
- set(install_default "${base}/Install/${name}")
- endif()
- get_property(build_in_source TARGET ${name} PROPERTY _EP_BUILD_IN_SOURCE)
- if(build_in_source)
- get_property(have_binary_dir TARGET ${name} PROPERTY _EP_BINARY_DIR SET)
- if(have_binary_dir)
- message(FATAL_ERROR
- "External project ${name} has both BINARY_DIR and BUILD_IN_SOURCE!")
- endif()
- endif()
- set(top "${CMAKE_CURRENT_BINARY_DIR}")
- set(places stamp download source binary install tmp)
- foreach(var ${places})
- string(TOUPPER "${var}" VAR)
- get_property(${var}_dir TARGET ${name} PROPERTY _EP_${VAR}_DIR)
- if(NOT ${var}_dir)
- set(${var}_dir "${${var}_default}")
- endif()
- if(NOT IS_ABSOLUTE "${${var}_dir}")
- get_filename_component(${var}_dir "${top}/${${var}_dir}" ABSOLUTE)
- endif()
- set_property(TARGET ${name} PROPERTY _EP_${VAR}_DIR "${${var}_dir}")
- endforeach()
- if(build_in_source)
- get_property(source_dir TARGET ${name} PROPERTY _EP_SOURCE_DIR)
- set_property(TARGET ${name} PROPERTY _EP_BINARY_DIR "${source_dir}")
- endif()
- # Make the directories at CMake configure time *and* add a custom command
- # to make them at build time. They need to exist at makefile generation
- # time for Borland make and wmake so that CMake may generate makefiles
- # with "cd C:\short\paths\with\no\spaces" commands in them.
- #
- # Additionally, the add_custom_command is still used in case somebody
- # removes one of the necessary directories and tries to rebuild without
- # re-running cmake.
- foreach(var ${places})
- string(TOUPPER "${var}" VAR)
- get_property(dir TARGET ${name} PROPERTY _EP_${VAR}_DIR)
- file(MAKE_DIRECTORY "${dir}")
- if(NOT EXISTS "${dir}")
- message(FATAL_ERROR "dir '${dir}' does not exist after file(MAKE_DIRECTORY)")
- endif()
- endforeach()
- endfunction(_ep_set_directories)
- function(ExternalProject_Get_Property name)
- foreach(var ${ARGN})
- string(TOUPPER "${var}" VAR)
- get_property(${var} TARGET ${name} PROPERTY _EP_${VAR})
- if(NOT ${var})
- message(FATAL_ERROR "External project \"${name}\" has no ${var}")
- endif()
- set(${var} "${${var}}" PARENT_SCOPE)
- endforeach()
- endfunction(ExternalProject_Get_Property)
- function(_ep_get_configure_command_id name cfg_cmd_id_var)
- get_target_property(cmd ${name} _EP_CONFIGURE_COMMAND)
- if(cmd STREQUAL "")
- # Explicit empty string means no configure step for this project
- set(${cfg_cmd_id_var} "none" PARENT_SCOPE)
- else()
- if(NOT cmd)
- # Default is "use cmake":
- set(${cfg_cmd_id_var} "cmake" PARENT_SCOPE)
- else()
- # Otherwise we have to analyze the value:
- if(cmd MATCHES "^[^;]*/configure")
- set(${cfg_cmd_id_var} "configure" PARENT_SCOPE)
- elseif(cmd MATCHES "^[^;]*/cmake" AND NOT cmd MATCHES ";-[PE];")
- set(${cfg_cmd_id_var} "cmake" PARENT_SCOPE)
- elseif(cmd MATCHES "config")
- set(${cfg_cmd_id_var} "configure" PARENT_SCOPE)
- else()
- set(${cfg_cmd_id_var} "unknown:${cmd}" PARENT_SCOPE)
- endif()
- endif()
- endif()
- endfunction(_ep_get_configure_command_id)
- function(_ep_get_build_command name step cmd_var)
- set(cmd "${${cmd_var}}")
- if(NOT cmd)
- set(args)
- _ep_get_configure_command_id(${name} cfg_cmd_id)
- if(cfg_cmd_id STREQUAL "cmake")
- # CMake project. Select build command based on generator.
- get_target_property(cmake_generator ${name} _EP_CMAKE_GENERATOR)
- if("${cmake_generator}" MATCHES "Make" AND
- "${cmake_generator}" STREQUAL "${CMAKE_GENERATOR}")
- # The project uses the same Makefile generator. Use recursive make.
- set(cmd "$(MAKE)")
- if(step STREQUAL "INSTALL")
- set(args install)
- endif()
- if(step STREQUAL "TEST")
- set(args test)
- endif()
- else()
- # Drive the project with "cmake --build".
- get_target_property(cmake_command ${name} _EP_CMAKE_COMMAND)
- if(cmake_command)
- set(cmd "${cmake_command}")
- else()
- set(cmd "${CMAKE_COMMAND}")
- endif()
- set(args --build ${binary_dir} --config ${CMAKE_CFG_INTDIR})
- if(step STREQUAL "INSTALL")
- list(APPEND args --target install)
- endif()
- # But for "TEST" drive the project with corresponding "ctest".
- if(step STREQUAL "TEST")
- string(REGEX REPLACE "^(.*/)cmake([^/]*)$" "\\1ctest\\2" cmd "${cmd}")
- set(args "")
- endif()
- endif()
- else() # if(cfg_cmd_id STREQUAL "configure")
- # Non-CMake project. Guess "make" and "make install" and "make test".
- set(cmd "make")
- if(step STREQUAL "INSTALL")
- set(args install)
- endif()
- if(step STREQUAL "TEST")
- set(args test)
- endif()
- endif()
- # Use user-specified arguments instead of default arguments, if any.
- get_property(have_args TARGET ${name} PROPERTY _EP_${step}_ARGS SET)
- if(have_args)
- get_target_property(args ${name} _EP_${step}_ARGS)
- endif()
- list(APPEND cmd ${args})
- endif()
- set(${cmd_var} "${cmd}" PARENT_SCOPE)
- endfunction(_ep_get_build_command)
- # This module used to use "/${CMAKE_CFG_INTDIR}" directly and produced
- # makefiles with "/./" in paths for custom command dependencies. Which
- # resulted in problems with parallel make -j invocations.
- #
- # This function was added so that the suffix (search below for ${cfgdir}) is
- # only set to "/${CMAKE_CFG_INTDIR}" when ${CMAKE_CFG_INTDIR} is not going to
- # be "." (multi-configuration build systems like Visual Studio and Xcode...)
- #
- function(_ep_get_configuration_subdir_suffix suffix_var)
- set(suffix "")
- if(CMAKE_CONFIGURATION_TYPES)
- set(suffix "/${CMAKE_CFG_INTDIR}")
- endif()
- set(${suffix_var} "${suffix}" PARENT_SCOPE)
- endfunction(_ep_get_configuration_subdir_suffix)
- function(ExternalProject_Add_Step name step)
- set(cmf_dir ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles)
- ExternalProject_Get_Property(${name} stamp_dir)
- _ep_get_configuration_subdir_suffix(cfgdir)
- add_custom_command(APPEND
- OUTPUT ${cmf_dir}${cfgdir}/${name}-complete
- DEPENDS ${stamp_dir}${cfgdir}/${name}-${step}
- )
- _ep_parse_arguments(ExternalProject_Add_Step
- ${name} _EP_${step}_ "${ARGN}")
- # Steps depending on this step.
- get_property(dependers TARGET ${name} PROPERTY _EP_${step}_DEPENDERS)
- foreach(depender IN LISTS dependers)
- add_custom_command(APPEND
- OUTPUT ${stamp_dir}${cfgdir}/${name}-${depender}
- DEPENDS ${stamp_dir}${cfgdir}/${name}-${step}
- )
- endforeach()
- # Dependencies on files.
- get_property(depends TARGET ${name} PROPERTY _EP_${step}_DEPENDS)
- # Dependencies on steps.
- get_property(dependees TARGET ${name} PROPERTY _EP_${step}_DEPENDEES)
- foreach(dependee IN LISTS dependees)
- list(APPEND depends ${stamp_dir}${cfgdir}/${name}-${dependee})
- endforeach()
- # The command to run.
- get_property(command TARGET ${name} PROPERTY _EP_${step}_COMMAND)
- if(command)
- set(comment "Performing ${step} step for '${name}'")
- else()
- set(comment "No ${step} step for '${name}'")
- endif()
- get_property(work_dir TARGET ${name} PROPERTY _EP_${step}_WORKING_DIRECTORY)
- # Replace list separators.
- get_property(sep TARGET ${name} PROPERTY _EP_LIST_SEPARATOR)
- if(sep AND command)
- string(REPLACE "${sep}" "\\;" command "${command}")
- endif()
- # Replace location tags.
- foreach(var comment command work_dir)
- if(${var})
- foreach(dir SOURCE_DIR BINARY_DIR INSTALL_DIR TMP_DIR)
- get_property(val TARGET ${name} PROPERTY _EP_${dir})
- string(REPLACE "<${dir}>" "${val}" ${var} "${${var}}")
- endforeach()
- endif()
- endforeach()
- # Custom comment?
- get_property(comment_set TARGET ${name} PROPERTY _EP_${step}_COMMENT SET)
- if(comment_set)
- get_property(comment TARGET ${name} PROPERTY _EP_${step}_COMMENT)
- endif()
- # Run every time?
- get_property(always TARGET ${name} PROPERTY _EP_${step}_ALWAYS)
- if(always)
- set_property(SOURCE ${stamp_dir}${cfgdir}/${name}-${step} PROPERTY SYMBOLIC 1)
- set(touch)
- else()
- set(touch ${CMAKE_COMMAND} -E touch ${stamp_dir}${cfgdir}/${name}-${step})
- endif()
- add_custom_command(
- OUTPUT ${stamp_dir}${cfgdir}/${name}-${step}
- COMMENT ${comment}
- COMMAND ${command}
- COMMAND ${touch}
- DEPENDS ${depends}
- WORKING_DIRECTORY ${work_dir}
- VERBATIM
- )
- endfunction(ExternalProject_Add_Step)
- function(_ep_add_mkdir_command name)
- ExternalProject_Get_Property(${name}
- source_dir binary_dir install_dir stamp_dir download_dir tmp_dir)
- _ep_get_configuration_subdir_suffix(cfgdir)
- ExternalProject_Add_Step(${name} mkdir
- COMMENT "Creating directories for '${name}'"
- COMMAND ${CMAKE_COMMAND} -E make_directory ${source_dir}
- COMMAND ${CMAKE_COMMAND} -E make_directory ${binary_dir}
- COMMAND ${CMAKE_COMMAND} -E make_directory ${install_dir}
- COMMAND ${CMAKE_COMMAND} -E make_directory ${tmp_dir}
- COMMAND ${CMAKE_COMMAND} -E make_directory ${stamp_dir}${cfgdir}
- COMMAND ${CMAKE_COMMAND} -E make_directory ${download_dir}
- )
- endfunction(_ep_add_mkdir_command)
- function(_ep_add_download_command name)
- ExternalProject_Get_Property(${name} source_dir stamp_dir download_dir tmp_dir)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_DOWNLOAD_COMMAND SET)
- get_property(cmd TARGET ${name} PROPERTY _EP_DOWNLOAD_COMMAND)
- get_property(cvs_repository TARGET ${name} PROPERTY _EP_CVS_REPOSITORY)
- get_property(svn_repository TARGET ${name} PROPERTY _EP_SVN_REPOSITORY)
- get_property(git_repository TARGET ${name} PROPERTY _EP_GIT_REPOSITORY)
- get_property(url TARGET ${name} PROPERTY _EP_URL)
- # TODO: Perhaps file:// should be copied to download dir before extraction.
- string(REGEX REPLACE "^file://" "" url "${url}")
- set(depends)
- set(comment)
- set(work_dir)
- if(cmd_set)
- set(work_dir ${download_dir})
- elseif(cvs_repository)
- find_package(CVS)
- if(NOT CVS_EXECUTABLE)
- message(FATAL_ERROR "error: could not find cvs for checkout of ${name}")
- endif()
- get_target_property(cvs_module ${name} _EP_CVS_MODULE)
- if(NOT cvs_module)
- message(FATAL_ERROR "error: no CVS_MODULE")
- endif()
- get_property(cvs_tag TARGET ${name} PROPERTY _EP_CVS_TAG)
- set(repository ${cvs_repository})
- set(module ${cvs_module})
- set(tag ${cvs_tag})
- configure_file(
- "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
- "${stamp_dir}/${name}-cvsinfo.txt"
- @ONLY
- )
- get_filename_component(src_name "${source_dir}" NAME)
- get_filename_component(work_dir "${source_dir}" PATH)
- set(comment "Performing download step (CVS checkout) for '${name}'")
- set(cmd ${CVS_EXECUTABLE} -d ${cvs_repository} -q co ${cvs_tag} -d ${src_name} ${cvs_module})
- list(APPEND depends ${stamp_dir}/${name}-cvsinfo.txt)
- elseif(svn_repository)
- find_package(Subversion)
- if(NOT Subversion_SVN_EXECUTABLE)
- message(FATAL_ERROR "error: could not find svn for checkout of ${name}")
- endif()
- get_property(svn_revision TARGET ${name} PROPERTY _EP_SVN_REVISION)
- get_property(svn_username TARGET ${name} PROPERTY _EP_SVN_USERNAME)
- get_property(svn_password TARGET ${name} PROPERTY _EP_SVN_PASSWORD)
- set(repository ${svn_repository})
- set(module)
- set(tag ${svn_revision})
- configure_file(
- "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
- "${stamp_dir}/${name}-svninfo.txt"
- @ONLY
- )
- get_filename_component(src_name "${source_dir}" NAME)
- get_filename_component(work_dir "${source_dir}" PATH)
- set(comment "Performing download step (SVN checkout) for '${name}'")
- set(cmd ${Subversion_SVN_EXECUTABLE} co ${svn_repository} ${svn_revision} --username=${svn_username} --password=${svn_password} ${src_name})
- list(APPEND depends ${stamp_dir}/${name}-svninfo.txt)
- elseif(git_repository)
- #find_package(Git)
- find_program(Git_EXECUTABLE git DOC "git command line client")
- mark_as_advanced(Git_EXECUTABLE)
- if(NOT Git_EXECUTABLE)
- message(FATAL_ERROR "error: could not git svn for clone of ${name}")
- endif()
- # TODO [GIT_REVISION revision] # Revision to checkout from GIT repo
- #get_property(git_revision TARGET ${name} PROPERTY _EP_GIT_REVISION)
- set(repository ${git_repository})
- set(module)
- set(tag ${git_revision})
- configure_file(
- "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
- "${stamp_dir}/${name}-gitinfo.txt"
- @ONLY
- )
- get_filename_component(src_name "${source_dir}" NAME)
- get_filename_component(work_dir "${source_dir}/../" REALPATH)
- # Since Git doesn't allow to clone if the repository exists,
- # let's create a cmake script that will be invoked as a download command.
- # That script will delete the source directory and call the appropriate git clone command
- file(WRITE ${tmp_dir}/${name}-gitclone.cmake "
- execute_process(
- COMMAND ${CMAKE_COMMAND} -E remove_directory ${source_dir}
- RESULT_VARIABLE error_code
- )
- execute_process(
- COMMAND ${Git_EXECUTABLE} clone ${git_repository} ${src_name}
- WORKING_DIRECTORY ${work_dir}
- RESULT_VARIABLE error_code
- )
- if(error_code)
- message(FATAL_ERROR \"Failed to clone repository: ${git_repository}\")
- endif()
- ")
- set(comment "Performing download step (GIT clone) for '${name}'")
- set(cmd ${CMAKE_COMMAND} -P ${tmp_dir}/${name}-gitclone.cmake)
- list(APPEND depends ${stamp_dir}/${name}-gitinfo.txt)
- elseif(url)
- get_filename_component(work_dir "${source_dir}" PATH)
- set(repository "external project URL")
- set(module "${url}")
- set(tag "")
- configure_file(
- "${CMAKE_ROOT}/Modules/RepositoryInfo.txt.in"
- "${stamp_dir}/${name}-urlinfo.txt"
- @ONLY
- )
- list(APPEND depends ${stamp_dir}/${name}-urlinfo.txt)
- if(IS_DIRECTORY "${url}")
- get_filename_component(abs_dir "${url}" ABSOLUTE)
- set(comment "Performing download step (DIR copy) for '${name}'")
- set(cmd ${CMAKE_COMMAND} -E remove_directory ${source_dir}
- COMMAND ${CMAKE_COMMAND} -E copy_directory ${abs_dir} ${source_dir})
- else()
- if("${url}" MATCHES "^[a-z]+://")
- # TODO: Should download and extraction be different steps?
- string(REGEX MATCH "[^/]*$" fname "${url}")
- if(NOT "${fname}" MATCHES "\\.(tar|tgz|tar\\.gz)$")
- message(FATAL_ERROR "Could not extract tarball filename from url:\n ${url}")
- endif()
- set(file ${download_dir}/${fname})
- get_property(timeout TARGET ${name} PROPERTY _EP_TIMEOUT)
- _ep_write_downloadfile_script("${stamp_dir}/download-${name}.cmake" "${url}" "${file}" "${timeout}")
- set(cmd ${CMAKE_COMMAND} -P ${stamp_dir}/download-${name}.cmake
- COMMAND)
- set(comment "Performing download step (download and extract) for '${name}'")
- else()
- set(file "${url}")
- set(comment "Performing download step (extract) for '${name}'")
- endif()
- # TODO: Support other archive formats.
- _ep_write_extractfile_script("${stamp_dir}/extract-${name}.cmake" "${file}" "${tmp_dir}" "${source_dir}")
- list(APPEND cmd ${CMAKE_COMMAND} -P ${stamp_dir}/extract-${name}.cmake)
- endif()
- else()
- message(SEND_ERROR "error: no download info for '${name}' -- please specify existing SOURCE_DIR or one of URL, CVS_REPOSITORY and CVS_MODULE, SVN_REPOSITORY or DOWNLOAD_COMMAND")
- endif()
- ExternalProject_Add_Step(${name} download
- COMMENT ${comment}
- COMMAND ${cmd}
- WORKING_DIRECTORY ${work_dir}
- DEPENDS ${depends}
- DEPENDEES mkdir
- )
- endfunction(_ep_add_download_command)
- function(_ep_add_update_command name)
- ExternalProject_Get_Property(${name} source_dir)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_UPDATE_COMMAND SET)
- get_property(cmd TARGET ${name} PROPERTY _EP_UPDATE_COMMAND)
- get_property(cvs_repository TARGET ${name} PROPERTY _EP_CVS_REPOSITORY)
- get_property(svn_repository TARGET ${name} PROPERTY _EP_SVN_REPOSITORY)
- get_property(git_repository TARGET ${name} PROPERTY _EP_GIT_REPOSITORY)
- set(work_dir)
- set(comment)
- set(always)
- if(cmd_set)
- set(work_dir ${source_dir})
- elseif(cvs_repository)
- if(NOT CVS_EXECUTABLE)
- message(FATAL_ERROR "error: could not find cvs for update of ${name}")
- endif()
- set(work_dir ${source_dir})
- set(comment "Performing update step (CVS update) for '${name}'")
- get_property(cvs_tag TARGET ${name} PROPERTY _EP_CVS_TAG)
- set(cmd ${CVS_EXECUTABLE} -d ${cvs_repository} -q up -dP ${cvs_tag})
- set(always 1)
- elseif(svn_repository)
- if(NOT Subversion_SVN_EXECUTABLE)
- message(FATAL_ERROR "error: could not find svn for update of ${name}")
- endif()
- set(work_dir ${source_dir})
- set(comment "Performing update step (SVN update) for '${name}'")
- get_property(svn_revision TARGET ${name} PROPERTY _EP_SVN_REVISION)
- get_property(svn_username TARGET ${name} PROPERTY _EP_SVN_USERNAME)
- get_property(svn_password TARGET ${name} PROPERTY _EP_SVN_PASSWORD)
- set(cmd ${Subversion_SVN_EXECUTABLE} up ${svn_revision} --username=${svn_username} --password=${svn_password})
- set(always 1)
- elseif(git_repository)
- if(NOT Git_EXECUTABLE)
- message(FATAL_ERROR "error: could not find git for pull of ${name}")
- endif()
- set(work_dir ${source_dir})
- set(comment "Performing update step (GIT pull) for '${name}'")
- #get_property(git_revision TARGET ${name} PROPERTY _EP_GIT_REVISION)
- set(cmd ${Git_EXECUTABLE} pull)
- set(always 1)
- endif()
- ExternalProject_Add_Step(${name} update
- COMMENT ${comment}
- COMMAND ${cmd}
- ALWAYS ${always}
- WORKING_DIRECTORY ${work_dir}
- DEPENDEES download
- )
- endfunction(_ep_add_update_command)
- function(_ep_add_patch_command name)
- ExternalProject_Get_Property(${name} source_dir)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_PATCH_COMMAND SET)
- get_property(cmd TARGET ${name} PROPERTY _EP_PATCH_COMMAND)
- set(work_dir)
- if(cmd_set)
- set(work_dir ${source_dir})
- endif()
- ExternalProject_Add_Step(${name} patch
- COMMAND ${cmd}
- WORKING_DIRECTORY ${work_dir}
- DEPENDEES download
- )
- endfunction(_ep_add_patch_command)
- # TODO: Make sure external projects use the proper compiler
- function(_ep_add_configure_command name)
- ExternalProject_Get_Property(${name} source_dir binary_dir)
- _ep_get_configuration_subdir_suffix(cfgdir)
- # Depend on other external projects (file-level).
- set(file_deps)
- get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
- foreach(dep IN LISTS deps)
- get_property(dep_stamp_dir TARGET ${dep} PROPERTY _EP_STAMP_DIR)
- list(APPEND file_deps ${dep_stamp_dir}${cfgdir}/${dep}-done)
- endforeach()
- get_property(cmd_set TARGET ${name} PROPERTY _EP_CONFIGURE_COMMAND SET)
- if(cmd_set)
- get_property(cmd TARGET ${name} PROPERTY _EP_CONFIGURE_COMMAND)
- else()
- get_target_property(cmake_command ${name} _EP_CMAKE_COMMAND)
- if(cmake_command)
- set(cmd "${cmake_command}")
- else()
- set(cmd "${CMAKE_COMMAND}")
- endif()
- get_property(cmake_args TARGET ${name} PROPERTY _EP_CMAKE_ARGS)
- list(APPEND cmd ${cmake_args})
- get_target_property(cmake_generator ${name} _EP_CMAKE_GENERATOR)
- if(cmake_generator)
- list(APPEND cmd "-G${cmake_generator}" "${source_dir}")
- else()
- list(APPEND cmd "-G${CMAKE_GENERATOR}" "${source_dir}")
- endif()
- endif()
- ExternalProject_Add_Step(${name} configure
- COMMAND ${cmd}
- WORKING_DIRECTORY ${binary_dir}
- DEPENDEES update patch
- DEPENDS ${file_deps}
- )
- endfunction(_ep_add_configure_command)
- function(_ep_add_build_command name)
- ExternalProject_Get_Property(${name} binary_dir)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_BUILD_COMMAND SET)
- if(cmd_set)
- get_property(cmd TARGET ${name} PROPERTY _EP_BUILD_COMMAND)
- else()
- _ep_get_build_command(${name} BUILD cmd)
- endif()
- ExternalProject_Add_Step(${name} build
- COMMAND ${cmd}
- WORKING_DIRECTORY ${binary_dir}
- DEPENDEES configure
- )
- endfunction(_ep_add_build_command)
- function(_ep_add_install_command name)
- ExternalProject_Get_Property(${name} binary_dir)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_INSTALL_COMMAND SET)
- if(cmd_set)
- get_property(cmd TARGET ${name} PROPERTY _EP_INSTALL_COMMAND)
- else()
- _ep_get_build_command(${name} INSTALL cmd)
- endif()
- ExternalProject_Add_Step(${name} install
- COMMAND ${cmd}
- WORKING_DIRECTORY ${binary_dir}
- DEPENDEES build
- )
- endfunction(_ep_add_install_command)
- function(_ep_add_test_command name)
- ExternalProject_Get_Property(${name} binary_dir)
- get_property(before TARGET ${name} PROPERTY _EP_TEST_BEFORE_INSTALL)
- get_property(after TARGET ${name} PROPERTY _EP_TEST_AFTER_INSTALL)
- get_property(cmd_set TARGET ${name} PROPERTY _EP_TEST_COMMAND SET)
- # Only actually add the test step if one of the test related properties is
- # explicitly set. (i.e. the test step is omitted unless requested...)
- #
- if(cmd_set OR before OR after)
- if(cmd_set)
- get_property(cmd TARGET ${name} PROPERTY _EP_TEST_COMMAND)
- else()
- _ep_get_build_command(${name} TEST cmd)
- endif()
- if(before)
- set(dep_args DEPENDEES build DEPENDERS install)
- else()
- set(dep_args DEPENDEES install)
- endif()
- ExternalProject_Add_Step(${name} test
- COMMAND ${cmd}
- WORKING_DIRECTORY ${binary_dir}
- ${dep_args}
- )
- endif()
- endfunction(_ep_add_test_command)
- function(ExternalProject_Add name)
- _ep_get_configuration_subdir_suffix(cfgdir)
- # Add a custom target for the external project.
- set(cmf_dir ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles)
- add_custom_target(${name} ALL DEPENDS ${cmf_dir}${cfgdir}/${name}-complete)
- set_property(TARGET ${name} PROPERTY _EP_IS_EXTERNAL_PROJECT 1)
- _ep_parse_arguments(ExternalProject_Add ${name} _EP_ "${ARGN}")
- _ep_set_directories(${name})
- ExternalProject_Get_Property(${name} stamp_dir)
- # The 'complete' step depends on all other steps and creates a
- # 'done' mark. A dependent external project's 'configure' step
- # depends on the 'done' mark so that it rebuilds when this project
- # rebuilds. It is important that 'done' is not the output of any
- # custom command so that CMake does not propagate build rules to
- # other external project targets.
- add_custom_command(
- OUTPUT ${cmf_dir}${cfgdir}/${name}-complete
- COMMENT "Completed '${name}'"
- COMMAND ${CMAKE_COMMAND} -E make_directory ${cmf_dir}${cfgdir}
- COMMAND ${CMAKE_COMMAND} -E touch ${cmf_dir}${cfgdir}/${name}-complete
- COMMAND ${CMAKE_COMMAND} -E touch ${stamp_dir}${cfgdir}/${name}-done
- DEPENDS ${stamp_dir}${cfgdir}/${name}-install
- VERBATIM
- )
- # Depend on other external projects (target-level).
- get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
- foreach(arg IN LISTS deps)
- add_dependencies(${name} ${arg})
- endforeach()
- # Set up custom build steps based on the target properties.
- # Each step depends on the previous one.
- #
- # The target depends on the output of the final step.
- # (Already set up above in the DEPENDS of the add_custom_target command.)
- #
- _ep_add_mkdir_command(${name})
- _ep_add_download_command(${name})
- _ep_add_update_command(${name})
- _ep_add_patch_command(${name})
- _ep_add_configure_command(${name})
- _ep_add_build_command(${name})
- _ep_add_install_command(${name})
- # Test is special in that it might depend on build, or it might depend
- # on install.
- #
- _ep_add_test_command(${name})
- endfunction(ExternalProject_Add)
|