2009-06-24 23:03:26 +04:00
# - Create custom targets to build projects in external trees
2009-09-08 23:37:15 +04:00
# 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
2009-06-24 23:03:26 +04:00
# [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
2009-09-03 20:11:14 +04:00
# [SVN_REVISION rev] # Revision to checkout from Subversion repo
2009-06-24 23:03:26 +04:00
# [URL /.../src.tgz] # Full path or URL of source
# #--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
2009-09-03 20:11:14 +04:00
# #--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
2009-06-24 23:03:26 +04:00
# )
# The *_DIR options specify directories for the project, with default
# directories computed as follows.
2009-09-08 23:37:15 +04:00
# 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
2009-06-24 23:03:26 +04:00
# 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
2009-08-19 20:19:12 +04:00
# is to set PREFIX to "<name>-prefix".
2009-06-24 23:03:26 +04:00
# Relative paths are interpreted with respect to the build directory
2009-09-08 23:37:15 +04:00
# corresponding to the source directory in which ExternalProject_Add is
# invoked.
2009-06-24 23:03:26 +04:00
#
# 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).
#
2009-09-08 23:37:15 +04:00
# The 'ExternalProject_Add_Step' function adds a custom step to an external
# project:
# ExternalProject_Add_Step(<name> <step> # Names of project and custom step
2009-06-24 23:03:26 +04:00
# [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.
#
2009-09-08 23:37:15 +04:00
# The 'ExternalProject_Get_Property' function retrieves external project
# target properties:
# ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])
2009-06-24 23:03:26 +04:00
# It stores property values in variables of the same name.
2009-09-08 23:37:15 +04:00
# Property names correspond to the keyword argument names of
# 'ExternalProject_Add'.
2009-06-24 23:03:26 +04:00
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
# Pre-compute a regex to match documented keywords for each command.
file ( STRINGS "${CMAKE_CURRENT_LIST_FILE}" lines LIMIT_COUNT 100
2009-09-08 23:37:15 +04:00
R E G E X " ^ # ( \\[[A-Z_]+ [^]]*\\] +#.*$|[A-Za-z_]+\\()")
2009-06-24 23:03:26 +04:00
foreach ( line IN LISTS lines )
2009-09-08 23:37:15 +04:00
if ( "${line}" MATCHES "^# [A-Za-z_]+\\(" )
2009-06-24 23:03:26 +04:00
if ( _ep_func )
set ( _ep_keywords_ ${ _ep_func } "${_ep_keywords_${_ep_func}})$" )
endif ( )
2009-09-08 23:37:15 +04:00
string ( REGEX REPLACE "^# ([A-Za-z_]+)\\(.*" "\\1" _ep_func "${line}" )
2009-06-24 23:03:26 +04:00
#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 }
" $ { _ e p _ k e y w o r d s _ $ { _ e p _ f u n c } } $ { _ e p _ k e y w o r d _ s e p } $ { _ e p _ k e y } " )
set ( _ep_keyword_sep "|" )
endif ( )
endforeach ( )
if ( _ep_func )
set ( _ep_keywords_ ${ _ep_func } "${_ep_keywords_${_ep_func}})$" )
endif ( )
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
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 )
2009-07-03 01:38:30 +04:00
2009-06-24 23:03:26 +04:00
foreach ( arg IN LISTS args )
2009-07-03 01:38:30 +04:00
set ( is_value 1 )
2009-06-24 23:03:26 +04:00
if ( arg MATCHES "^[A-Z][A-Z_][A-Z_]+$" AND
NOT ( ( arg STREQUAL "${key}" ) AND ( key STREQUAL "COMMAND" ) ) A N D
N O T a r g M A T C H E S " ^ ( T R U E | F A L S E ) $ " )
2009-07-03 01:38:30 +04:00
if ( _ep_keywords_ ${ f } AND arg MATCHES "${_ep_keywords_${f}}" )
set ( is_value 0 )
2009-06-24 23:03:26 +04:00
else ( )
2009-07-03 01:38:30 +04:00
if ( NOT ( key STREQUAL "COMMAND" )
A N D NOT ( key STREQUAL "CVS_MODULE" )
A N D 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}" )
2009-06-24 23:03:26 +04:00
else ( )
2009-07-03 01:38:30 +04:00
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 ( )
2009-06-24 23:03:26 +04:00
endif ( )
2009-07-03 01:38:30 +04:00
else ( )
# Missing Keyword
message ( AUTHOR_WARNING "value '${arg}' with no previous keyword in ${f}" )
2009-06-24 23:03:26 +04:00
endif ( )
else ( )
2009-07-03 01:38:30 +04:00
set ( key "${arg}" )
2009-06-24 23:03:26 +04:00
endif ( )
endforeach ( )
endfunction ( _ep_parse_arguments )
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
define_property ( DIRECTORY PROPERTY "EP_BASE" INHERITED
B R I E F _ D O C S " B a s e d i r e c t o r y f o r E x t e r n a l P r o j e c t s t o r a g e . "
F U L L _ D O C S
2009-09-08 23:37:15 +04:00
" S e e d o c u m e n t a t i o n o f t h e ExternalProject_Add ( ) f u n c t i o n i n t h e "
2009-06-24 23:03:26 +04:00
" E x t e r n a l P r o j e c t m o d u l e . "
)
define_property ( DIRECTORY PROPERTY "EP_PREFIX" INHERITED
B R I E F _ D O C S " T o p p r e f i x f o r E x t e r n a l P r o j e c t s t o r a g e . "
F U L L _ D O C S
2009-09-08 23:37:15 +04:00
" S e e d o c u m e n t a t i o n o f t h e ExternalProject_Add ( ) f u n c t i o n i n t h e "
2009-06-24 23:03:26 +04:00
" E x t e r n a l P r o j e c t m o d u l e . "
)
2009-08-19 20:19:12 +04:00
function ( _ep_write_downloadfile_script script_filename remote local timeout )
if ( NOT timeout )
set ( timeout 30 )
endif ( )
file ( WRITE ${ script_filename }
" message ( STATUS \"downloading...
s r c = ' $ { r e m o t e } '
d s t = ' $ { l o c a l } ' \ " )
file ( DOWNLOAD
\ " $ { r e m o t e } \ "
\ " $ { l o c a l } \ "
T I M E O U T $ { t i m e o u t }
S T A T U S s t a t u s
L O G l o g )
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
s t a t u s _ c o d e : \ $ { s t a t u s _ c o d e }
s t a t u s _ s t r i n g : \ $ { s t a t u s _ s t r i n g }
l o g : \ $ { l o g }
\ " )
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...
s r c = ' \ $ { f i l e n a m e } '
d s t = ' \ $ { d i r e c t o r y } ' \ " )
# 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}
W O R K I N G _ D I R E C T O R Y \ $ { u t _ d i r }
R E S U L T _ V A R I A B L E r v )
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 )
2009-06-24 23:03:26 +04:00
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
" E x t e r n a l p r o j e c t $ { n a m e } h a s b o t h B I N A R Y _ D I R a n d B U I L D _ I N _ S O U R C E ! " )
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 )
2009-08-19 20:19:12 +04:00
2009-09-08 23:37:15 +04:00
function ( ExternalProject_Get_Property name )
2009-06-24 23:03:26 +04:00
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 ( )
2009-09-08 23:37:15 +04:00
endfunction ( ExternalProject_Get_Property )
2009-06-24 23:03:26 +04:00
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
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 )
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
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
" $ { c m a k e _ g e n e r a t o r } " S T R E Q U A L " $ { C M A K E _ G E N E R A T O R } " )
# The project uses the same Makefile generator. Use recursive make.
set ( cmd "$(MAKE)" )
if ( step STREQUAL "INSTALL" )
set ( args install )
endif ( )
2009-09-03 20:11:14 +04:00
if ( step STREQUAL "TEST" )
set ( args test )
endif ( )
2009-06-24 23:03:26 +04:00
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 ( )
2009-09-03 20:11:14 +04:00
# But for "TEST" drive the project with corresponding "ctest".
if ( step STREQUAL "TEST" )
string ( REGEX REPLACE "^(.*/)cmake([^/]*)$" "\\1ctest\\2" cmd "${cmd}" )
set ( args "" )
endif ( )
2009-06-24 23:03:26 +04:00
endif ( )
else ( ) # if(cfg_cmd_id STREQUAL "configure")
2009-09-03 20:11:14 +04:00
# Non-CMake project. Guess "make" and "make install" and "make test".
2009-06-24 23:03:26 +04:00
set ( cmd "make" )
if ( step STREQUAL "INSTALL" )
set ( args install )
endif ( )
2009-09-03 20:11:14 +04:00
if ( step STREQUAL "TEST" )
set ( args test )
endif ( )
2009-06-24 23:03:26 +04:00
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 )
2009-08-19 20:19:12 +04:00
2009-09-08 23:37:15 +04:00
function ( ExternalProject_Add_Step name step )
2009-06-24 23:03:26 +04:00
set ( cmf_dir ${ CMAKE_CURRENT_BINARY_DIR } /CMakeFiles )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } stamp_dir )
2009-06-24 23:03:26 +04:00
add_custom_command ( APPEND
2009-09-08 23:37:15 +04:00
O U T P U T $ { c m f _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - c o m p l e t e
D E P E N D S $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - $ { s t e p }
2009-06-24 23:03:26 +04:00
)
2009-09-08 23:37:15 +04:00
_ep_parse_arguments ( ExternalProject_Add_Step
2009-06-24 23:03:26 +04:00
$ { n a m e } _ E P _ $ { s t e p } _ " $ { A R G N } " )
# Steps depending on this step.
get_property ( dependers TARGET ${ name } PROPERTY _EP_ ${ step } _DEPENDERS )
foreach ( depender IN LISTS dependers )
add_custom_command ( APPEND
2009-09-08 23:37:15 +04:00
O U T P U T $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - $ { d e p e n d e r }
D E P E N D S $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - $ { s t e p }
2009-06-24 23:03:26 +04:00
)
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 )
2009-09-08 23:37:15 +04:00
list ( APPEND depends ${ stamp_dir } / ${ CMAKE_CFG_INTDIR } / ${ name } - ${ dependee } )
2009-06-24 23:03:26 +04:00
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 )
2009-09-08 23:37:15 +04:00
set_property ( SOURCE ${ stamp_dir } / ${ CMAKE_CFG_INTDIR } / ${ name } - ${ step } PROPERTY SYMBOLIC 1 )
2009-06-24 23:03:26 +04:00
set ( touch )
else ( )
2009-09-08 23:37:15 +04:00
set ( touch ${ CMAKE_COMMAND } -E touch ${ stamp_dir } / ${ CMAKE_CFG_INTDIR } / ${ name } - ${ step } )
2009-06-24 23:03:26 +04:00
endif ( )
add_custom_command (
2009-09-08 23:37:15 +04:00
O U T P U T $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - $ { s t e p }
2009-06-24 23:03:26 +04:00
C O M M E N T $ { c o m m e n t }
C O M M A N D $ { c o m m a n d }
C O M M A N D $ { t o u c h }
D E P E N D S $ { d e p e n d s }
W O R K I N G _ D I R E C T O R Y $ { w o r k _ d i r }
V E R B A T I M
)
2009-09-08 23:37:15 +04:00
endfunction ( ExternalProject_Add_Step )
2009-06-24 23:03:26 +04:00
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
function ( _ep_add_mkdir_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name }
2009-06-24 23:03:26 +04:00
s o u r c e _ d i r b i n a r y _ d i r i n s t a l l _ d i r s t a m p _ d i r d o w n l o a d _ d i r t m p _ d i r )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } mkdir
2009-06-24 23:03:26 +04:00
C O M M E N T " C r e a t i n g d i r e c t o r i e s f o r ' $ { n a m e } ' "
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { s o u r c e _ d i r }
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { b i n a r y _ d i r }
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { i n s t a l l _ d i r }
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { t m p _ d i r }
2009-09-09 00:11:19 +04:00
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R }
2009-06-24 23:03:26 +04:00
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { d o w n l o a d _ d i r }
)
endfunction ( _ep_add_mkdir_command )
2009-08-19 20:19:12 +04:00
2009-06-24 23:03:26 +04:00
function ( _ep_add_download_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } source_dir stamp_dir download_dir tmp_dir )
2009-06-24 23:03:26 +04:00
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 ( 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 (
" $ { C M A K E _ R O O T } / M o d u l e s / R e p o s i t o r y I n f o . t x t . i n "
" $ { s t a m p _ d i r } / $ { n a m e } - c v s i n f o . t x t "
@ O N L Y
)
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 ( )
2009-09-03 20:11:14 +04:00
get_property ( svn_revision TARGET ${ name } PROPERTY _EP_SVN_REVISION )
2009-06-24 23:03:26 +04:00
set ( repository ${ svn_repository } )
set ( module )
2009-09-03 20:11:14 +04:00
set ( tag ${ svn_revision } )
2009-06-24 23:03:26 +04:00
configure_file (
" $ { C M A K E _ R O O T } / M o d u l e s / R e p o s i t o r y I n f o . t x t . i n "
" $ { s t a m p _ d i r } / $ { n a m e } - s v n i n f o . t x t "
@ O N L Y
)
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}'" )
2009-09-03 20:11:14 +04:00
set ( cmd ${ Subversion_SVN_EXECUTABLE } co ${ svn_repository } ${ svn_revision } ${ src_name } )
2009-06-24 23:03:26 +04:00
list ( APPEND depends ${ stamp_dir } / ${ name } -svninfo.txt )
elseif ( url )
get_filename_component ( work_dir "${source_dir}" PATH )
set ( repository "external project URL" )
set ( module "${url}" )
set ( tag "" )
configure_file (
" $ { C M A K E _ R O O T } / M o d u l e s / R e p o s i t o r y I n f o . t x t . i n "
" $ { s t a m p _ d i r } / $ { n a m e } - u r l i n f o . t x t "
@ O N L Y
)
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 }
C O M M A N D $ { C M A K E _ C O M M A N D } - E c o p y _ d i r e c t o r y $ { a b s _ d i r } $ { s o u r c e _ d i r } )
else ( )
if ( "${url}" MATCHES "^[a-z]+://" )
# TODO: Should download and extraction be different steps?
2009-07-13 18:46:32 +04:00
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 } )
2009-08-26 14:52:43 +04:00
_ep_write_downloadfile_script ( "${stamp_dir}/download-${name}.cmake" "${url}" "${file}" "" )
2009-08-19 20:19:12 +04:00
set ( cmd ${ CMAKE_COMMAND } -P ${ stamp_dir } /download- ${ name } .cmake
2009-06-24 23:03:26 +04:00
C O M M A N D )
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.
2009-08-19 20:19:12 +04:00
_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 )
2009-06-24 23:03:26 +04:00
endif ( )
else ( )
2009-09-18 20:56:49 +04:00
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" )
2009-06-24 23:03:26 +04:00
endif ( )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } download
2009-06-24 23:03:26 +04:00
C O M M E N T $ { c o m m e n t }
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { w o r k _ d i r }
D E P E N D S $ { d e p e n d s }
D E P E N D E E S m k d i r
)
endfunction ( _ep_add_download_command )
function ( _ep_add_update_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } source_dir )
2009-06-24 23:03:26 +04:00
2009-07-02 21:17:55 +04:00
get_property ( cmd_set TARGET ${ name } PROPERTY _EP_UPDATE_COMMAND SET )
2009-06-24 23:03:26 +04:00
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 )
set ( work_dir )
set ( comment )
set ( always )
2009-07-02 21:17:55 +04:00
if ( cmd_set )
2009-06-24 23:03:26 +04:00
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}'" )
2009-09-03 20:11:14 +04:00
get_property ( svn_revision TARGET ${ name } PROPERTY _EP_SVN_REVISION )
set ( cmd ${ Subversion_SVN_EXECUTABLE } up ${ svn_revision } )
2009-06-24 23:03:26 +04:00
set ( always 1 )
endif ( )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } update
2009-06-24 23:03:26 +04:00
C O M M E N T $ { c o m m e n t }
C O M M A N D $ { c m d }
A L W A Y S $ { a l w a y s }
W O R K I N G _ D I R E C T O R Y $ { w o r k _ d i r }
D E P E N D E E S d o w n l o a d
)
endfunction ( _ep_add_update_command )
function ( _ep_add_patch_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } source_dir )
2009-06-24 23:03:26 +04:00
2009-07-02 21:17:55 +04:00
get_property ( cmd_set TARGET ${ name } PROPERTY _EP_PATCH_COMMAND SET )
2009-06-24 23:03:26 +04:00
get_property ( cmd TARGET ${ name } PROPERTY _EP_PATCH_COMMAND )
2009-07-02 21:17:55 +04:00
set ( work_dir )
if ( cmd_set )
2009-06-24 23:03:26 +04:00
set ( work_dir ${ source_dir } )
endif ( )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } patch
2009-06-24 23:03:26 +04:00
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { w o r k _ d i r }
D E P E N D E E S d o w n l o a d
)
endfunction ( _ep_add_patch_command )
# TODO: Make sure external projects use the proper compiler
function ( _ep_add_configure_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } source_dir binary_dir )
2009-06-24 23:03:26 +04:00
# 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 )
2009-09-08 23:37:15 +04:00
list ( APPEND file_deps ${ dep_stamp_dir } / ${ CMAKE_CFG_INTDIR } / ${ dep } -done )
2009-06-24 23:03:26 +04:00
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}" )
2009-09-08 23:37:15 +04:00
else ( )
list ( APPEND cmd "-G${CMAKE_GENERATOR}" "${source_dir}" )
2009-06-24 23:03:26 +04:00
endif ( )
endif ( )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } configure
2009-06-24 23:03:26 +04:00
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { b i n a r y _ d i r }
D E P E N D E E S u p d a t e p a t c h
D E P E N D S $ { f i l e _ d e p s }
)
endfunction ( _ep_add_configure_command )
function ( _ep_add_build_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } binary_dir )
2009-06-24 23:03:26 +04:00
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 ( )
2009-09-03 20:11:14 +04:00
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } build
2009-06-24 23:03:26 +04:00
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { b i n a r y _ d i r }
D E P E N D E E S c o n f i g u r e
)
endfunction ( _ep_add_build_command )
function ( _ep_add_install_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } binary_dir )
2009-06-24 23:03:26 +04:00
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 ( )
2009-09-03 20:11:14 +04:00
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } install
2009-06-24 23:03:26 +04:00
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { b i n a r y _ d i r }
D E P E N D E E S b u i l d
)
endfunction ( _ep_add_install_command )
2009-08-19 20:19:12 +04:00
2009-09-03 20:11:14 +04:00
function ( _ep_add_test_command name )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } binary_dir )
2009-09-03 20:11:14 +04:00
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 ( )
2009-09-08 23:37:15 +04:00
ExternalProject_Add_Step ( ${ name } test
2009-09-03 20:11:14 +04:00
C O M M A N D $ { c m d }
W O R K I N G _ D I R E C T O R Y $ { b i n a r y _ d i r }
$ { d e p _ a r g s }
)
endif ( )
endfunction ( _ep_add_test_command )
2009-09-08 23:37:15 +04:00
function ( ExternalProject_Add name )
2009-06-24 23:03:26 +04:00
# Add a custom target for the external project.
set ( cmf_dir ${ CMAKE_CURRENT_BINARY_DIR } /CMakeFiles )
2009-09-08 23:37:15 +04:00
add_custom_target ( ${ name } ALL DEPENDS ${ cmf_dir } / ${ CMAKE_CFG_INTDIR } / ${ name } -complete )
2009-06-24 23:03:26 +04:00
set_property ( TARGET ${ name } PROPERTY _EP_IS_EXTERNAL_PROJECT 1 )
2009-09-08 23:37:15 +04:00
_ep_parse_arguments ( ExternalProject_Add ${ name } _EP_ "${ARGN}" )
2009-06-24 23:03:26 +04:00
_ep_set_directories ( ${ name } )
2009-09-08 23:37:15 +04:00
ExternalProject_Get_Property ( ${ name } stamp_dir )
2009-06-24 23:03:26 +04:00
# 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 (
2009-09-08 23:37:15 +04:00
O U T P U T $ { c m f _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - c o m p l e t e
2009-06-24 23:03:26 +04:00
C O M M E N T " C o m p l e t e d ' $ { n a m e } ' "
2009-09-09 01:28:49 +04:00
C O M M A N D $ { C M A K E _ C O M M A N D } - E m a k e _ d i r e c t o r y $ { c m f _ d i r } / $ { C M A K E _ C F G _ I N T D I R }
2009-09-08 23:37:15 +04:00
C O M M A N D $ { C M A K E _ C O M M A N D } - E t o u c h $ { c m f _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - c o m p l e t e
C O M M A N D $ { C M A K E _ C O M M A N D } - E t o u c h $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - d o n e
D E P E N D S $ { s t a m p _ d i r } / $ { C M A K E _ C F G _ I N T D I R } / $ { n a m e } - i n s t a l l
2009-06-24 23:03:26 +04:00
V E R B A T I M
)
# 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 } )
2009-09-03 20:11:14 +04:00
# Test is special in that it might depend on build, or it might depend
# on install.
#
_ep_add_test_command ( ${ name } )
2009-09-08 23:37:15 +04:00
endfunction ( ExternalProject_Add )