diff options
Diffstat (limited to 'share/cmake-3.2/Modules/ExternalData.cmake')
| -rwxr-xr-x | share/cmake-3.2/Modules/ExternalData.cmake | 999 |
1 files changed, 0 insertions, 999 deletions
diff --git a/share/cmake-3.2/Modules/ExternalData.cmake b/share/cmake-3.2/Modules/ExternalData.cmake deleted file mode 100755 index 741db81..0000000 --- a/share/cmake-3.2/Modules/ExternalData.cmake +++ /dev/null @@ -1,999 +0,0 @@ -#[=======================================================================[.rst: -ExternalData ------------- - -.. only:: html - - .. contents:: - -Manage data files stored outside source tree - -Introduction -^^^^^^^^^^^^ - -Use this module to unambiguously reference data files stored outside -the source tree and fetch them at build time from arbitrary local and -remote content-addressed locations. Functions provided by this module -recognize arguments with the syntax ``DATA{<name>}`` as references to -external data, replace them with full paths to local copies of those -data, and create build rules to fetch and update the local copies. - -For example: - -.. code-block:: cmake - - include(ExternalData) - set(ExternalData_URL_TEMPLATES "file:///local/%(algo)/%(hash)" - "file:////host/share/%(algo)/%(hash)" - "http://data.org/%(algo)/%(hash)") - ExternalData_Add_Test(MyData - NAME MyTest - COMMAND MyExe DATA{MyInput.png} - ) - ExternalData_Add_Target(MyData) - -When test ``MyTest`` runs the ``DATA{MyInput.png}`` argument will be -replaced by the full path to a real instance of the data file -``MyInput.png`` on disk. If the source tree contains a content link -such as ``MyInput.png.md5`` then the ``MyData`` target creates a real -``MyInput.png`` in the build tree. - -Module Functions -^^^^^^^^^^^^^^^^ - -.. command:: ExternalData_Expand_Arguments - - The ``ExternalData_Expand_Arguments`` function evaluates ``DATA{}`` - references in its arguments and constructs a new list of arguments:: - - ExternalData_Expand_Arguments( - <target> # Name of data management target - <outVar> # Output variable - [args...] # Input arguments, DATA{} allowed - ) - - It replaces each ``DATA{}`` reference in an argument with the full path of - a real data file on disk that will exist after the ``<target>`` builds. - -.. command:: ExternalData_Add_Test - - The ``ExternalData_Add_Test`` function wraps around the CMake - :command:`add_test` command but supports ``DATA{}`` references in - its arguments:: - - ExternalData_Add_Test( - <target> # Name of data management target - ... # Arguments of add_test(), DATA{} allowed - ) - - It passes its arguments through ``ExternalData_Expand_Arguments`` and then - invokes the :command:`add_test` command using the results. - -.. command:: ExternalData_Add_Target - - The ``ExternalData_Add_Target`` function creates a custom target to - manage local instances of data files stored externally:: - - ExternalData_Add_Target( - <target> # Name of data management target - ) - - It creates custom commands in the target as necessary to make data - files available for each ``DATA{}`` reference previously evaluated by - other functions provided by this module. - Data files may be fetched from one of the URL templates specified in - the ``ExternalData_URL_TEMPLATES`` variable, or may be found locally - in one of the paths specified in the ``ExternalData_OBJECT_STORES`` - variable. - -Module Variables -^^^^^^^^^^^^^^^^ - -The following variables configure behavior. They should be set before -calling any of the functions provided by this module. - -.. variable:: ExternalData_BINARY_ROOT - - The ``ExternalData_BINARY_ROOT`` variable may be set to the directory to - hold the real data files named by expanded ``DATA{}`` references. The - default is ``CMAKE_BINARY_DIR``. The directory layout will mirror that of - content links under ``ExternalData_SOURCE_ROOT``. - -.. variable:: ExternalData_CUSTOM_SCRIPT_<key> - - Specify a full path to a ``.cmake`` custom fetch script identified by - ``<key>`` in entries of the ``ExternalData_URL_TEMPLATES`` list. - See `Custom Fetch Scripts`_. - -.. variable:: ExternalData_LINK_CONTENT - - The ``ExternalData_LINK_CONTENT`` variable may be set to the name of a - supported hash algorithm to enable automatic conversion of real data - files referenced by the ``DATA{}`` syntax into content links. For each - such ``<file>`` a content link named ``<file><ext>`` is created. The - original file is renamed to the form ``.ExternalData_<algo>_<hash>`` to - stage it for future transmission to one of the locations in the list - of URL templates (by means outside the scope of this module). The - data fetch rule created for the content link will use the staged - object if it cannot be found using any URL template. - -.. variable:: ExternalData_OBJECT_STORES - - The ``ExternalData_OBJECT_STORES`` variable may be set to a list of local - directories that store objects using the layout ``<dir>/%(algo)/%(hash)``. - These directories will be searched first for a needed object. If the - object is not available in any store then it will be fetched remotely - using the URL templates and added to the first local store listed. If - no stores are specified the default is a location inside the build - tree. - -.. variable:: ExternalData_SERIES_PARSE - ExternalData_SERIES_PARSE_PREFIX - ExternalData_SERIES_PARSE_NUMBER - ExternalData_SERIES_PARSE_SUFFIX - ExternalData_SERIES_MATCH - - See `Referencing File Series`_. - -.. variable:: ExternalData_SOURCE_ROOT - - The ``ExternalData_SOURCE_ROOT`` variable may be set to the highest source - directory containing any path named by a ``DATA{}`` reference. The - default is ``CMAKE_SOURCE_DIR``. ``ExternalData_SOURCE_ROOT`` and - ``CMAKE_SOURCE_DIR`` must refer to directories within a single source - distribution (e.g. they come together in one tarball). - -.. variable:: ExternalData_TIMEOUT_ABSOLUTE - - The ``ExternalData_TIMEOUT_ABSOLUTE`` variable sets the download - absolute timeout, in seconds, with a default of ``300`` seconds. - Set to ``0`` to disable enforcement. - -.. variable:: ExternalData_TIMEOUT_INACTIVITY - - The ``ExternalData_TIMEOUT_INACTIVITY`` variable sets the download - inactivity timeout, in seconds, with a default of ``60`` seconds. - Set to ``0`` to disable enforcement. - -.. variable:: ExternalData_URL_TEMPLATES - - The ``ExternalData_URL_TEMPLATES`` may be set to provide a list of - of URL templates using the placeholders ``%(algo)`` and ``%(hash)`` - in each template. Data fetch rules try each URL template in order - by substituting the hash algorithm name for ``%(algo)`` and the hash - value for ``%(hash)``. - -Referencing Files -^^^^^^^^^^^^^^^^^ - -Referencing Single Files -"""""""""""""""""""""""" - -The ``DATA{}`` syntax is literal and the ``<name>`` is a full or relative path -within the source tree. The source tree must contain either a real -data file at ``<name>`` or a "content link" at ``<name><ext>`` containing a -hash of the real file using a hash algorithm corresponding to ``<ext>``. -For example, the argument ``DATA{img.png}`` may be satisfied by either a -real ``img.png`` file in the current source directory or a ``img.png.md5`` -file containing its MD5 sum. - -Referencing File Series -""""""""""""""""""""""" - -The ``DATA{}`` syntax can be told to fetch a file series using the form -``DATA{<name>,:}``, where the ``:`` is literal. If the source tree -contains a group of files or content links named like a series then a -reference to one member adds rules to fetch all of them. Although all -members of a series are fetched, only the file originally named by the -``DATA{}`` argument is substituted for it. The default configuration -recognizes file series names ending with ``#.ext``, ``_#.ext``, ``.#.ext``, -or ``-#.ext`` where ``#`` is a sequence of decimal digits and ``.ext`` is -any single extension. Configure it with a regex that parses ``<number>`` -and ``<suffix>`` parts from the end of ``<name>``:: - - ExternalData_SERIES_PARSE = regex of the form (<number>)(<suffix>)$ - -For more complicated cases set:: - - ExternalData_SERIES_PARSE = regex with at least two () groups - ExternalData_SERIES_PARSE_PREFIX = <prefix> regex group number, if any - ExternalData_SERIES_PARSE_NUMBER = <number> regex group number - ExternalData_SERIES_PARSE_SUFFIX = <suffix> regex group number - -Configure series number matching with a regex that matches the -``<number>`` part of series members named ``<prefix><number><suffix>``:: - - ExternalData_SERIES_MATCH = regex matching <number> in all series members - -Note that the ``<suffix>`` of a series does not include a hash-algorithm -extension. - -Referencing Associated Files -"""""""""""""""""""""""""""" - -The ``DATA{}`` syntax can alternatively match files associated with the -named file and contained in the same directory. Associated files may -be specified by options using the syntax -``DATA{<name>,<opt1>,<opt2>,...}``. Each option may specify one file by -name or specify a regular expression to match file names using the -syntax ``REGEX:<regex>``. For example, the arguments:: - - DATA{MyData/MyInput.mhd,MyInput.img} # File pair - DATA{MyData/MyFrames00.png,REGEX:MyFrames[0-9]+\\.png} # Series - -will pass ``MyInput.mha`` and ``MyFrames00.png`` on the command line but -ensure that the associated files are present next to them. - -Referencing Directories -""""""""""""""""""""""" - -The ``DATA{}`` syntax may reference a directory using a trailing slash and -a list of associated files. The form ``DATA{<name>/,<opt1>,<opt2>,...}`` -adds rules to fetch any files in the directory that match one of the -associated file options. For example, the argument -``DATA{MyDataDir/,REGEX:.*}`` will pass the full path to a ``MyDataDir`` -directory on the command line and ensure that the directory contains -files corresponding to every file or content link in the ``MyDataDir`` -source directory. - -Hash Algorithms -^^^^^^^^^^^^^^^ - -The following hash algorithms are supported:: - - %(algo) <ext> Description - ------- ----- ----------- - MD5 .md5 Message-Digest Algorithm 5, RFC 1321 - SHA1 .sha1 US Secure Hash Algorithm 1, RFC 3174 - SHA224 .sha224 US Secure Hash Algorithms, RFC 4634 - SHA256 .sha256 US Secure Hash Algorithms, RFC 4634 - SHA384 .sha384 US Secure Hash Algorithms, RFC 4634 - SHA512 .sha512 US Secure Hash Algorithms, RFC 4634 - -Note that the hashes are used only for unique data identification and -download verification. - -.. _`ExternalData Custom Fetch Scripts`: - -Custom Fetch Scripts -^^^^^^^^^^^^^^^^^^^^ - -When a data file must be fetched from one of the URL templates -specified in the ``ExternalData_URL_TEMPLATES`` variable, it is -normally downloaded using the :command:`file(DOWNLOAD)` command. -One may specify usage of a custom fetch script by using a URL -template of the form ``ExternalDataCustomScript://<key>/<loc>``. -The ``<key>`` must be a C identifier, and the ``<loc>`` must -contain the ``%(algo)`` and ``%(hash)`` placeholders. -A variable corresponding to the key, ``ExternalData_CUSTOM_SCRIPT_<key>``, -must be set to the full path to a ``.cmake`` script file. The script -will be included to perform the actual fetch, and provided with -the following variables: - -.. variable:: ExternalData_CUSTOM_LOCATION - - When a custom fetch script is loaded, this variable is set to the - location part of the URL, which will contain the substituted hash - algorithm name and content hash value. - -.. variable:: ExternalData_CUSTOM_FILE - - When a custom fetch script is loaded, this variable is set to the - full path to a file in which the script must store the fetched - content. The name of the file is unspecified and should not be - interpreted in any way. - -The custom fetch script is expected to store fetched content in the -file or set a variable: - -.. variable:: ExternalData_CUSTOM_ERROR - - When a custom fetch script fails to fetch the requested content, - it must set this variable to a short one-line message describing - the reason for failure. - -#]=======================================================================] - -#============================================================================= -# Copyright 2010-2015 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 distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -function(ExternalData_add_test target) - # Expand all arguments as a single string to preserve escaped semicolons. - ExternalData_expand_arguments("${target}" testArgs "${ARGN}") - add_test(${testArgs}) -endfunction() - -function(ExternalData_add_target target) - if(NOT ExternalData_URL_TEMPLATES AND NOT ExternalData_OBJECT_STORES) - message(FATAL_ERROR - "Neither ExternalData_URL_TEMPLATES nor ExternalData_OBJECT_STORES is set!") - endif() - if(NOT ExternalData_OBJECT_STORES) - set(ExternalData_OBJECT_STORES ${CMAKE_BINARY_DIR}/ExternalData/Objects) - endif() - set(_ExternalData_CONFIG_CODE "") - - # Store custom script configuration. - foreach(url_template IN LISTS ExternalData_URL_TEMPLATES) - if("${url_template}" MATCHES "^ExternalDataCustomScript://([^/]*)/(.*)$") - set(key "${CMAKE_MATCH_1}") - if(key MATCHES "^[A-Za-z_][A-Za-z0-9_]*$") - if(ExternalData_CUSTOM_SCRIPT_${key}) - if(IS_ABSOLUTE "${ExternalData_CUSTOM_SCRIPT_${key}}") - string(CONCAT _ExternalData_CONFIG_CODE "${_ExternalData_CONFIG_CODE}\n" - "set(ExternalData_CUSTOM_SCRIPT_${key} \"${ExternalData_CUSTOM_SCRIPT_${key}}\")") - else() - message(FATAL_ERROR - "No ExternalData_CUSTOM_SCRIPT_${key} is not set to a full path:\n" - " ${ExternalData_CUSTOM_SCRIPT_${key}}") - endif() - else() - message(FATAL_ERROR - "No ExternalData_CUSTOM_SCRIPT_${key} is set for URL template:\n" - " ${url_template}") - endif() - else() - message(FATAL_ERROR - "Bad ExternalDataCustomScript key '${key}' in URL template:\n" - " ${url_template}\n" - "The key must be a valid C identifier.") - endif() - endif() - endforeach() - - # Store configuration for use by build-time script. - set(config ${CMAKE_CURRENT_BINARY_DIR}/${target}_config.cmake) - configure_file(${_ExternalData_SELF_DIR}/ExternalData_config.cmake.in ${config} @ONLY) - - set(files "") - - # Set "_ExternalData_FILE_${file}" for each output file to avoid duplicate - # rules. Use local data first to prefer real files over content links. - - # Custom commands to copy or link local data. - get_property(data_local GLOBAL PROPERTY _ExternalData_${target}_LOCAL) - foreach(entry IN LISTS data_local) - string(REPLACE "|" ";" tuple "${entry}") - list(GET tuple 0 file) - list(GET tuple 1 name) - if(NOT DEFINED "_ExternalData_FILE_${file}") - set("_ExternalData_FILE_${file}" 1) - add_custom_command( - COMMENT "Generating ${file}" - OUTPUT "${file}" - COMMAND ${CMAKE_COMMAND} -Drelative_top=${CMAKE_BINARY_DIR} - -Dfile=${file} -Dname=${name} - -DExternalData_ACTION=local - -DExternalData_CONFIG=${config} - -P ${_ExternalData_SELF} - MAIN_DEPENDENCY "${name}" - ) - list(APPEND files "${file}") - endif() - endforeach() - - # Custom commands to fetch remote data. - get_property(data_fetch GLOBAL PROPERTY _ExternalData_${target}_FETCH) - foreach(entry IN LISTS data_fetch) - string(REPLACE "|" ";" tuple "${entry}") - list(GET tuple 0 file) - list(GET tuple 1 name) - list(GET tuple 2 ext) - set(stamp "${ext}-stamp") - if(NOT DEFINED "_ExternalData_FILE_${file}") - set("_ExternalData_FILE_${file}" 1) - add_custom_command( - # Users care about the data file, so hide the hash/timestamp file. - COMMENT "Generating ${file}" - # The hash/timestamp file is the output from the build perspective. - # List the real file as a second output in case it is a broken link. - # The files must be listed in this order so CMake can hide from the - # make tool that a symlink target may not be newer than the input. - OUTPUT "${file}${stamp}" "${file}" - # Run the data fetch/update script. - COMMAND ${CMAKE_COMMAND} -Drelative_top=${CMAKE_BINARY_DIR} - -Dfile=${file} -Dname=${name} -Dext=${ext} - -DExternalData_ACTION=fetch - -DExternalData_CONFIG=${config} - -P ${_ExternalData_SELF} - # Update whenever the object hash changes. - MAIN_DEPENDENCY "${name}${ext}" - ) - list(APPEND files "${file}${stamp}") - endif() - endforeach() - - # Custom target to drive all update commands. - add_custom_target(${target} ALL DEPENDS ${files}) -endfunction() - -function(ExternalData_expand_arguments target outArgsVar) - # Replace DATA{} references with real arguments. - set(data_regex "DATA{([^;{}\r\n]*)}") - set(other_regex "([^D]|D[^A]|DA[^T]|DAT[^A]|DATA[^{])+|.") - set(outArgs "") - # This list expansion un-escapes semicolons in list element values so we - # must re-escape them below anywhere a new list expansion will occur. - foreach(arg IN LISTS ARGN) - if("x${arg}" MATCHES "${data_regex}") - # Re-escape in-value semicolons before expansion in foreach below. - string(REPLACE ";" "\\;" tmp "${arg}") - # Split argument into DATA{}-pieces and other pieces. - string(REGEX MATCHALL "${data_regex}|${other_regex}" pieces "${tmp}") - # Compose output argument with DATA{}-pieces replaced. - set(outArg "") - foreach(piece IN LISTS pieces) - if("x${piece}" MATCHES "^x${data_regex}$") - # Replace this DATA{}-piece with a file path. - _ExternalData_arg("${target}" "${piece}" "${CMAKE_MATCH_1}" file) - set(outArg "${outArg}${file}") - else() - # No replacement needed for this piece. - set(outArg "${outArg}${piece}") - endif() - endforeach() - else() - # No replacements needed in this argument. - set(outArg "${arg}") - endif() - # Re-escape in-value semicolons in resulting list. - string(REPLACE ";" "\\;" outArg "${outArg}") - list(APPEND outArgs "${outArg}") - endforeach() - set("${outArgsVar}" "${outArgs}" PARENT_SCOPE) -endfunction() - -#----------------------------------------------------------------------------- -# Private helper interface - -set(_ExternalData_REGEX_ALGO "MD5|SHA1|SHA224|SHA256|SHA384|SHA512") -set(_ExternalData_REGEX_EXT "md5|sha1|sha224|sha256|sha384|sha512") -set(_ExternalData_SELF "${CMAKE_CURRENT_LIST_FILE}") -get_filename_component(_ExternalData_SELF_DIR "${_ExternalData_SELF}" PATH) - -function(_ExternalData_compute_hash var_hash algo file) - if("${algo}" MATCHES "^${_ExternalData_REGEX_ALGO}$") - file("${algo}" "${file}" hash) - set("${var_hash}" "${hash}" PARENT_SCOPE) - else() - message(FATAL_ERROR "Hash algorithm ${algo} unimplemented.") - endif() -endfunction() - -function(_ExternalData_random var) - string(RANDOM LENGTH 6 random) - set("${var}" "${random}" PARENT_SCOPE) -endfunction() - -function(_ExternalData_exact_regex regex_var string) - string(REGEX REPLACE "([][+.*()^])" "\\\\\\1" regex "${string}") - set("${regex_var}" "${regex}" PARENT_SCOPE) -endfunction() - -function(_ExternalData_atomic_write file content) - _ExternalData_random(random) - set(tmp "${file}.tmp${random}") - file(WRITE "${tmp}" "${content}") - file(RENAME "${tmp}" "${file}") -endfunction() - -function(_ExternalData_link_content name var_ext) - if("${ExternalData_LINK_CONTENT}" MATCHES "^(${_ExternalData_REGEX_ALGO})$") - set(algo "${ExternalData_LINK_CONTENT}") - else() - message(FATAL_ERROR - "Unknown hash algorithm specified by ExternalData_LINK_CONTENT:\n" - " ${ExternalData_LINK_CONTENT}") - endif() - _ExternalData_compute_hash(hash "${algo}" "${name}") - get_filename_component(dir "${name}" PATH) - set(staged "${dir}/.ExternalData_${algo}_${hash}") - string(TOLOWER ".${algo}" ext) - _ExternalData_atomic_write("${name}${ext}" "${hash}\n") - file(RENAME "${name}" "${staged}") - set("${var_ext}" "${ext}" PARENT_SCOPE) - - file(RELATIVE_PATH relname "${ExternalData_SOURCE_ROOT}" "${name}${ext}") - message(STATUS "Linked ${relname} to ExternalData ${algo}/${hash}") -endfunction() - -function(_ExternalData_arg target arg options var_file) - # Separate data path from the options. - string(REPLACE "," ";" options "${options}") - list(GET options 0 data) - list(REMOVE_AT options 0) - - # Interpret trailing slashes as directories. - set(data_is_directory 0) - if("x${data}" MATCHES "^x(.*)([/\\])$") - set(data_is_directory 1) - set(data "${CMAKE_MATCH_1}") - endif() - - # Convert to full path. - if(IS_ABSOLUTE "${data}") - set(absdata "${data}") - else() - set(absdata "${CMAKE_CURRENT_SOURCE_DIR}/${data}") - endif() - get_filename_component(absdata "${absdata}" ABSOLUTE) - - # Convert to relative path under the source tree. - if(NOT ExternalData_SOURCE_ROOT) - set(ExternalData_SOURCE_ROOT "${CMAKE_SOURCE_DIR}") - endif() - set(top_src "${ExternalData_SOURCE_ROOT}") - file(RELATIVE_PATH reldata "${top_src}" "${absdata}") - if(IS_ABSOLUTE "${reldata}" OR "${reldata}" MATCHES "^\\.\\./") - message(FATAL_ERROR "Data file referenced by argument\n" - " ${arg}\n" - "does not lie under the top-level source directory\n" - " ${top_src}\n") - endif() - if(data_is_directory AND NOT IS_DIRECTORY "${top_src}/${reldata}") - message(FATAL_ERROR "Data directory referenced by argument\n" - " ${arg}\n" - "corresponds to source tree path\n" - " ${reldata}\n" - "that does not exist as a directory!") - endif() - if(NOT ExternalData_BINARY_ROOT) - set(ExternalData_BINARY_ROOT "${CMAKE_BINARY_DIR}") - endif() - set(top_bin "${ExternalData_BINARY_ROOT}") - - # Handle in-source builds gracefully. - if("${top_src}" STREQUAL "${top_bin}") - if(ExternalData_LINK_CONTENT) - message(WARNING "ExternalData_LINK_CONTENT cannot be used in-source") - set(ExternalData_LINK_CONTENT 0) - endif() - set(top_same 1) - endif() - - set(external "") # Entries external to the source tree. - set(internal "") # Entries internal to the source tree. - set(have_original ${data_is_directory}) - set(have_original_as_dir 0) - - # Process options. - set(series_option "") - set(associated_files "") - set(associated_regex "") - foreach(opt ${options}) - # Regular expression to match associated files. - if("x${opt}" MATCHES "^xREGEX:([^:/]+)$") - list(APPEND associated_regex "${CMAKE_MATCH_1}") - elseif(opt STREQUAL ":") - # Activate series matching. - set(series_option "${opt}") - elseif("x${opt}" MATCHES "^[^][:/*?]+$") - # Specific associated file. - list(APPEND associated_files "${opt}") - else() - message(FATAL_ERROR "Unknown option \"${opt}\" in argument\n" - " ${arg}\n") - endif() - endforeach() - - if(series_option) - if(data_is_directory) - message(FATAL_ERROR "Series option \"${series_option}\" not allowed with directories.") - endif() - if(associated_files OR associated_regex) - message(FATAL_ERROR "Series option \"${series_option}\" not allowed with associated files.") - endif() - # Load a whole file series. - _ExternalData_arg_series() - elseif(data_is_directory) - if(associated_files OR associated_regex) - # Load listed/matching associated files in the directory. - _ExternalData_arg_associated() - else() - message(FATAL_ERROR "Data directory referenced by argument\n" - " ${arg}\n" - "must list associated files.") - endif() - else() - # Load the named data file. - _ExternalData_arg_single() - if(associated_files OR associated_regex) - # Load listed/matching associated files. - _ExternalData_arg_associated() - endif() - endif() - - if(NOT have_original) - if(have_original_as_dir) - set(msg_kind FATAL_ERROR) - set(msg "that is directory instead of a file!") - else() - set(msg_kind AUTHOR_WARNING) - set(msg "that does not exist as a file (with or without an extension)!") - endif() - message(${msg_kind} "Data file referenced by argument\n" - " ${arg}\n" - "corresponds to source tree path\n" - " ${reldata}\n" - "${msg}") - endif() - - if(external) - # Make the series available in the build tree. - set_property(GLOBAL APPEND PROPERTY - _ExternalData_${target}_FETCH "${external}") - set_property(GLOBAL APPEND PROPERTY - _ExternalData_${target}_LOCAL "${internal}") - set("${var_file}" "${top_bin}/${reldata}" PARENT_SCOPE) - else() - # The whole series is in the source tree. - set("${var_file}" "${top_src}/${reldata}" PARENT_SCOPE) - endif() -endfunction() - -macro(_ExternalData_arg_associated) - # Associated files lie in the same directory. - if(data_is_directory) - set(reldir "${reldata}") - else() - get_filename_component(reldir "${reldata}" PATH) - endif() - if(reldir) - set(reldir "${reldir}/") - endif() - _ExternalData_exact_regex(reldir_regex "${reldir}") - - # Find files named explicitly. - foreach(file ${associated_files}) - _ExternalData_exact_regex(file_regex "${file}") - _ExternalData_arg_find_files("${reldir}${file}" "${reldir_regex}${file_regex}") - endforeach() - - # Find files matching the given regular expressions. - set(all "") - set(sep "") - foreach(regex ${associated_regex}) - set(all "${all}${sep}${reldir_regex}${regex}") - set(sep "|") - endforeach() - _ExternalData_arg_find_files("${reldir}" "${all}") -endmacro() - -macro(_ExternalData_arg_single) - # Match only the named data by itself. - _ExternalData_exact_regex(data_regex "${reldata}") - _ExternalData_arg_find_files("${reldata}" "${data_regex}") -endmacro() - -macro(_ExternalData_arg_series) - # Configure series parsing and matching. - set(series_parse_prefix "") - set(series_parse_number "\\1") - set(series_parse_suffix "\\2") - if(ExternalData_SERIES_PARSE) - if(ExternalData_SERIES_PARSE_NUMBER AND ExternalData_SERIES_PARSE_SUFFIX) - if(ExternalData_SERIES_PARSE_PREFIX) - set(series_parse_prefix "\\${ExternalData_SERIES_PARSE_PREFIX}") - endif() - set(series_parse_number "\\${ExternalData_SERIES_PARSE_NUMBER}") - set(series_parse_suffix "\\${ExternalData_SERIES_PARSE_SUFFIX}") - elseif(NOT "x${ExternalData_SERIES_PARSE}" MATCHES "^x\\([^()]*\\)\\([^()]*\\)\\$$") - message(FATAL_ERROR - "ExternalData_SERIES_PARSE is set to\n" - " ${ExternalData_SERIES_PARSE}\n" - "which is not of the form\n" - " (<number>)(<suffix>)$\n" - "Fix the regular expression or set variables\n" - " ExternalData_SERIES_PARSE_PREFIX = <prefix> regex group number, if any\n" - " ExternalData_SERIES_PARSE_NUMBER = <number> regex group number\n" - " ExternalData_SERIES_PARSE_SUFFIX = <suffix> regex group number\n" - ) - endif() - set(series_parse "${ExternalData_SERIES_PARSE}") - else() - set(series_parse "([0-9]*)(\\.[^./]*)$") - endif() - if(ExternalData_SERIES_MATCH) - set(series_match "${ExternalData_SERIES_MATCH}") - else() - set(series_match "[_.-]?[0-9]*") - endif() - - # Parse the base, number, and extension components of the series. - string(REGEX REPLACE "${series_parse}" "${series_parse_prefix};${series_parse_number};${series_parse_suffix}" tuple "${reldata}") - list(LENGTH tuple len) - if(NOT "${len}" EQUAL 3) - message(FATAL_ERROR "Data file referenced by argument\n" - " ${arg}\n" - "corresponds to path\n" - " ${reldata}\n" - "that does not match regular expression\n" - " ${series_parse}") - endif() - list(GET tuple 0 relbase) - list(GET tuple 2 ext) - - # Glob files that might match the series. - # Then match base, number, and extension. - _ExternalData_exact_regex(series_base "${relbase}") - _ExternalData_exact_regex(series_ext "${ext}") - _ExternalData_arg_find_files("${relbase}*${ext}" - "${series_base}${series_match}${series_ext}") -endmacro() - -function(_ExternalData_arg_find_files pattern regex) - file(GLOB globbed RELATIVE "${top_src}" "${top_src}/${pattern}*") - foreach(entry IN LISTS globbed) - if("x${entry}" MATCHES "^x(.*)(\\.(${_ExternalData_REGEX_EXT}))$") - set(relname "${CMAKE_MATCH_1}") - set(alg "${CMAKE_MATCH_2}") - else() - set(relname "${entry}") - set(alg "") - endif() - if("x${relname}" MATCHES "^x${regex}$" # matches - AND NOT "x${relname}" MATCHES "(^x|/)\\.ExternalData_" # not staged obj - ) - if(IS_DIRECTORY "${top_src}/${entry}") - if("${relname}" STREQUAL "${reldata}") - set(have_original_as_dir 1) - endif() - else() - set(name "${top_src}/${relname}") - set(file "${top_bin}/${relname}") - if(alg) - list(APPEND external "${file}|${name}|${alg}") - elseif(ExternalData_LINK_CONTENT) - _ExternalData_link_content("${name}" alg) - list(APPEND external "${file}|${name}|${alg}") - elseif(NOT top_same) - list(APPEND internal "${file}|${name}") - endif() - if("${relname}" STREQUAL "${reldata}") - set(have_original 1) - endif() - endif() - endif() - endforeach() - set(external "${external}" PARENT_SCOPE) - set(internal "${internal}" PARENT_SCOPE) - set(have_original "${have_original}" PARENT_SCOPE) - set(have_original_as_dir "${have_original_as_dir}" PARENT_SCOPE) -endfunction() - -#----------------------------------------------------------------------------- -# Private script mode interface - -if(CMAKE_GENERATOR OR NOT ExternalData_ACTION) - return() -endif() - -if(ExternalData_CONFIG) - include(${ExternalData_CONFIG}) -endif() -if(NOT ExternalData_URL_TEMPLATES AND NOT ExternalData_OBJECT_STORES) - message(FATAL_ERROR - "Neither ExternalData_URL_TEMPLATES nor ExternalData_OBJECT_STORES is set!") -endif() - -function(_ExternalData_link_or_copy src dst) - # Create a temporary file first. - get_filename_component(dst_dir "${dst}" PATH) - file(MAKE_DIRECTORY "${dst_dir}") - _ExternalData_random(random) - set(tmp "${dst}.tmp${random}") - if(UNIX) - # Create a symbolic link. - set(tgt "${src}") - if(relative_top) - # Use relative path if files are close enough. - file(RELATIVE_PATH relsrc "${relative_top}" "${src}") - file(RELATIVE_PATH relfile "${relative_top}" "${dst}") - if(NOT IS_ABSOLUTE "${relsrc}" AND NOT "${relsrc}" MATCHES "^\\.\\./" AND - NOT IS_ABSOLUTE "${reldst}" AND NOT "${reldst}" MATCHES "^\\.\\./") - file(RELATIVE_PATH tgt "${dst_dir}" "${src}") - endif() - endif() - execute_process(COMMAND "${CMAKE_COMMAND}" -E create_symlink "${tgt}" "${tmp}" RESULT_VARIABLE result) - else() - # Create a copy. - execute_process(COMMAND "${CMAKE_COMMAND}" -E copy "${src}" "${tmp}" RESULT_VARIABLE result) - endif() - if(result) - file(REMOVE "${tmp}") - message(FATAL_ERROR "Failed to create\n ${tmp}\nfrom\n ${obj}") - endif() - - # Atomically create/replace the real destination. - file(RENAME "${tmp}" "${dst}") -endfunction() - -function(_ExternalData_download_file url file err_var msg_var) - set(retry 3) - while(retry) - math(EXPR retry "${retry} - 1") - if(ExternalData_TIMEOUT_INACTIVITY) - set(inactivity_timeout INACTIVITY_TIMEOUT ${ExternalData_TIMEOUT_INACTIVITY}) - elseif(NOT "${ExternalData_TIMEOUT_INACTIVITY}" EQUAL 0) - set(inactivity_timeout INACTIVITY_TIMEOUT 60) - else() - set(inactivity_timeout "") - endif() - if(ExternalData_TIMEOUT_ABSOLUTE) - set(absolute_timeout TIMEOUT ${ExternalData_TIMEOUT_ABSOLUTE}) - elseif(NOT "${ExternalData_TIMEOUT_ABSOLUTE}" EQUAL 0) - set(absolute_timeout TIMEOUT 300) - else() - set(absolute_timeout "") - endif() - file(DOWNLOAD "${url}" "${file}" STATUS status LOG log ${inactivity_timeout} ${absolute_timeout} SHOW_PROGRESS) - list(GET status 0 err) - list(GET status 1 msg) - if(err) - if("${msg}" MATCHES "HTTP response code said error" AND - "${log}" MATCHES "error: 503") - set(msg "temporarily unavailable") - endif() - elseif("${log}" MATCHES "\nHTTP[^\n]* 503") - set(err TRUE) - set(msg "temporarily unavailable") - endif() - if(NOT err OR NOT "${msg}" MATCHES "partial|timeout|temporarily") - break() - elseif(retry) - message(STATUS "[download terminated: ${msg}, retries left: ${retry}]") - endif() - endwhile() - set("${err_var}" "${err}" PARENT_SCOPE) - set("${msg_var}" "${msg}" PARENT_SCOPE) -endfunction() - -function(_ExternalData_custom_fetch key loc file err_var msg_var) - if(NOT ExternalData_CUSTOM_SCRIPT_${key}) - set(err 1) - set(msg "No ExternalData_CUSTOM_SCRIPT_${key} set!") - elseif(NOT EXISTS "${ExternalData_CUSTOM_SCRIPT_${key}}") - set(err 1) - set(msg "No '${ExternalData_CUSTOM_SCRIPT_${key}}' exists!") - else() - set(ExternalData_CUSTOM_LOCATION "${loc}") - set(ExternalData_CUSTOM_FILE "${file}") - unset(ExternalData_CUSTOM_ERROR) - include("${ExternalData_CUSTOM_SCRIPT_${key}}") - if(DEFINED ExternalData_CUSTOM_ERROR) - set(err 1) - set(msg "${ExternalData_CUSTOM_ERROR}") - else() - set(err 0) - set(msg "no error") - endif() - endif() - set("${err_var}" "${err}" PARENT_SCOPE) - set("${msg_var}" "${msg}" PARENT_SCOPE) -endfunction() - -function(_ExternalData_download_object name hash algo var_obj) - # Search all object stores for an existing object. - foreach(dir ${ExternalData_OBJECT_STORES}) - set(obj "${dir}/${algo}/${hash}") - if(EXISTS "${obj}") - message(STATUS "Found object: \"${obj}\"") - set("${var_obj}" "${obj}" PARENT_SCOPE) - return() - endif() - endforeach() - - # Download object to the first store. - list(GET ExternalData_OBJECT_STORES 0 store) - set(obj "${store}/${algo}/${hash}") - - _ExternalData_random(random) - set(tmp "${obj}.tmp${random}") - set(found 0) - set(tried "") - foreach(url_template IN LISTS ExternalData_URL_TEMPLATES) - string(REPLACE "%(hash)" "${hash}" url_tmp "${url_template}") - string(REPLACE "%(algo)" "${algo}" url "${url_tmp}") - message(STATUS "Fetching \"${url}\"") - if(url MATCHES "^ExternalDataCustomScript://([A-Za-z_][A-Za-z0-9_]*)/(.*)$") - _ExternalData_custom_fetch("${CMAKE_MATCH_1}" "${CMAKE_MATCH_2}" "${tmp}" err errMsg) - else() - _ExternalData_download_file("${url}" "${tmp}" err errMsg) - endif() - set(tried "${tried}\n ${url}") - if(err) - set(tried "${tried} (${errMsg})") - else() - # Verify downloaded object. - _ExternalData_compute_hash(dl_hash "${algo}" "${tmp}") - if("${dl_hash}" STREQUAL "${hash}") - set(found 1) - break() - else() - set(tried "${tried} (wrong hash ${algo}=${dl_hash})") - if("$ENV{ExternalData_DEBUG_DOWNLOAD}" MATCHES ".") - file(RENAME "${tmp}" "${store}/${algo}/${dl_hash}") - endif() - endif() - endif() - file(REMOVE "${tmp}") - endforeach() - - get_filename_component(dir "${name}" PATH) - set(staged "${dir}/.ExternalData_${algo}_${hash}") - - if(found) - file(RENAME "${tmp}" "${obj}") - message(STATUS "Downloaded object: \"${obj}\"") - elseif(EXISTS "${staged}") - set(obj "${staged}") - message(STATUS "Staged object: \"${obj}\"") - else() - if(NOT tried) - set(tried "\n (No ExternalData_URL_TEMPLATES given)") - endif() - message(FATAL_ERROR "Object ${algo}=${hash} not found at:${tried}") - endif() - - set("${var_obj}" "${obj}" PARENT_SCOPE) -endfunction() - -if("${ExternalData_ACTION}" STREQUAL "fetch") - foreach(v ExternalData_OBJECT_STORES file name ext) - if(NOT DEFINED "${v}") - message(FATAL_ERROR "No \"-D${v}=\" value provided!") - endif() - endforeach() - - file(READ "${name}${ext}" hash) - string(STRIP "${hash}" hash) - - if("${ext}" MATCHES "^\\.(${_ExternalData_REGEX_EXT})$") - string(TOUPPER "${CMAKE_MATCH_1}" algo) - else() - message(FATAL_ERROR "Unknown hash algorithm extension \"${ext}\"") - endif() - - _ExternalData_download_object("${name}" "${hash}" "${algo}" obj) - - # Check if file already corresponds to the object. - set(stamp "${ext}-stamp") - set(file_up_to_date 0) - if(EXISTS "${file}" AND EXISTS "${file}${stamp}") - file(READ "${file}${stamp}" f_hash) - string(STRIP "${f_hash}" f_hash) - if("${f_hash}" STREQUAL "${hash}") - #message(STATUS "File already corresponds to object") - set(file_up_to_date 1) - endif() - endif() - - if(file_up_to_date) - # Touch the file to convince the build system it is up to date. - execute_process(COMMAND "${CMAKE_COMMAND}" -E touch "${file}") - else() - _ExternalData_link_or_copy("${obj}" "${file}") - endif() - - # Atomically update the hash/timestamp file to record the object referenced. - _ExternalData_atomic_write("${file}${stamp}" "${hash}\n") -elseif("${ExternalData_ACTION}" STREQUAL "local") - foreach(v file name) - if(NOT DEFINED "${v}") - message(FATAL_ERROR "No \"-D${v}=\" value provided!") - endif() - endforeach() - _ExternalData_link_or_copy("${name}" "${file}") -else() - message(FATAL_ERROR "Unknown ExternalData_ACTION=[${ExternalData_ACTION}]") -endif() |