-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #493 from bartlettroscoe/299-find-tpl-module-find-…
…package Add, use, and document new function tribits_external_package_create_imported_all_libs_target_and_config_file() (#299)
- Loading branch information
Showing
14 changed files
with
913 additions
and
423 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
tribits/core/package_arch/TribitsExternalPackageFindTplHelpers.cmake
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # @HEADER | ||
| # ************************************************************************ | ||
| # | ||
| # TriBITS: Tribal Build, Integrate, and Test System | ||
| # Copyright 2013 Sandia Corporation | ||
| # | ||
| # Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, | ||
| # the U.S. Government retains certain rights in this software. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are | ||
| # met: | ||
| # | ||
| # 1. Redistributions of source code must retain the above copyright | ||
| # notice, this list of conditions and the following disclaimer. | ||
| # | ||
| # 2. Redistributions in binary form must reproduce the above copyright | ||
| # notice, this list of conditions and the following disclaimer in the | ||
| # documentation and/or other materials provided with the distribution. | ||
| # | ||
| # 3. Neither the name of the Corporation nor the names of the | ||
| # contributors may be used to endorse or promote products derived from | ||
| # this software without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY | ||
| # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE | ||
| # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | ||
| # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | ||
| # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| # | ||
| # ************************************************************************ | ||
| # @HEADER | ||
|
|
||
|
|
||
| # @FUNCTION: tribits_external_package_create_imported_all_libs_target_and_config_file() | ||
| # | ||
| # Call from a ``FindTPL<tplName>.cmake`` module that calls inner | ||
| # ``find_package(<externalPkg>)`` for external package that uses modern CMake | ||
| # IMPORTED targets. | ||
| # | ||
| # Usage:: | ||
| # | ||
| # tribits_external_package_create_imported_all_libs_target_and_config_file( | ||
| # <tplName> | ||
| # INNER_FIND_PACKAGE_NAME <externalPkg> | ||
| # IMPORTED_TARGETS_FOR_ALL_LIBS <importedTarget0> <importedTarget1> ... ) | ||
| # | ||
| # This function is called in a TriBITS ``FindTPL<tplName>.cmake`` wrapper | ||
| # module after it calls ``find_package(<externalPkg>)`` and then creates the | ||
| # IMPORTED target ``<tplName>::all_libs`` from the list of IMPORTED targets | ||
| # ``<importedTarget0> <importedTarget1> ...`` which are defined from the call | ||
| # ``find_package(<externalPkg>)``. This function also takes care of | ||
| # generating the correct ``<tplName>Config.cmake`` file under the directory:: | ||
| # | ||
| # ${${PROJECT_NAME}_BINARY_DIR}/${${PROJECT_NAME}_BUILD_DIR_EXTERNAL_PKGS_DIR} | ||
| # | ||
| # The generated ``<tplName>Config.cmake`` file calls | ||
| # ``find_dependency(<externalPkg>)`` (with no other argument) and then, again, | ||
| # defines the correct imported library dependency. | ||
| # | ||
| # For more details, see `Creating FindTPL*.cmake using find_package() with | ||
| # IMPORTED targets`_. | ||
| # | ||
| function(tribits_external_package_create_imported_all_libs_target_and_config_file | ||
| tplName | ||
| ) | ||
|
|
||
| # Parse arguments | ||
| cmake_parse_arguments( | ||
| PARSE_ARGV 1 | ||
| PARSE "" "" # prefix, options, one_value_keywords | ||
| "INNER_FIND_PACKAGE_NAME;IMPORTED_TARGETS_FOR_ALL_LIBS" #multi_value_keywords | ||
| ) | ||
| tribits_check_for_unparsed_arguments(PARSE) | ||
| tribits_assert_parse_arg_one_value(PARSE INNER_FIND_PACKAGE_NAME) | ||
| tribits_assert_parse_arg_one_or_more_values(PARSE IMPORTED_TARGETS_FOR_ALL_LIBS) | ||
|
|
||
| # Create imported target <tplName>::all_libs | ||
| add_library(${tplName}::all_libs INTERFACE IMPORTED GLOBAL) | ||
| foreach (importedTarget IN LISTS PARSE_IMPORTED_TARGETS_FOR_ALL_LIBS) | ||
| target_link_libraries(${tplName}::all_libs INTERFACE ${importedTarget}) | ||
| endforeach() | ||
|
|
||
| # Create <tplName>Config.cmake file | ||
| tribits_external_package_create_package_config_file_with_imported_targets( | ||
| ${tplName} | ||
| INNER_FIND_PACKAGE_NAME ${PARSE_INNER_FIND_PACKAGE_NAME} | ||
| IMPORTED_TARGETS_FOR_ALL_LIBS ${PARSE_IMPORTED_TARGETS_FOR_ALL_LIBS} ) | ||
|
|
||
| endfunction() | ||
|
|
||
|
|
||
| function(tribits_external_package_create_package_config_file_with_imported_targets | ||
| tplName | ||
| ) | ||
|
|
||
| # Parse arguments | ||
| cmake_parse_arguments( | ||
| PARSE_ARGV 1 | ||
| PARSE "" "" # prefix, options, one_value_keywords | ||
| "INNER_FIND_PACKAGE_NAME;IMPORTED_TARGETS_FOR_ALL_LIBS" #multi_value_keywords | ||
| ) | ||
| tribits_check_for_unparsed_arguments(PARSE) | ||
| tribits_assert_parse_arg_one_value(PARSE INNER_FIND_PACKAGE_NAME) | ||
| tribits_assert_parse_arg_one_or_more_values(PARSE IMPORTED_TARGETS_FOR_ALL_LIBS) | ||
| set(externalPkg ${PARSE_INNER_FIND_PACKAGE_NAME}) | ||
|
|
||
| # Create <tplName>Config.cmake file | ||
| set(configFileStr "") | ||
| string(APPEND configFileStr | ||
| "include(CMakeFindDependencyMacro)\n" | ||
| "set(${externalPkg}_DIR \"${${externalPkg}_DIR}\")\n" | ||
| "find_dependency(${externalPkg})\n" | ||
| "add_library(${tplName}::all_libs INTERFACE IMPORTED GLOBAL)\n" | ||
| ) | ||
| foreach (importedTarget IN LISTS PARSE_IMPORTED_TARGETS_FOR_ALL_LIBS) | ||
| string(APPEND configFileStr | ||
| "target_link_libraries(${tplName}::all_libs INTERFACE ${importedTarget})\n") | ||
| endforeach() | ||
| set(buildDirExternalPkgsDir | ||
| "${${PROJECT_NAME}_BINARY_DIR}/${${PROJECT_NAME}_BUILD_DIR_EXTERNAL_PKGS_DIR}") | ||
| set(tplConfigFile | ||
| "${buildDirExternalPkgsDir}/${tplName}/${tplName}Config.cmake") | ||
| file(WRITE "${tplConfigFile}" "${configFileStr}") | ||
|
|
||
| endfunction() |
Oops, something went wrong.