diff --git a/CMakeLists.txt b/CMakeLists.txt index d971d3e..9ea3deb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.8) project(OsqpEigen - VERSION 0.6.3) + VERSION 0.6.4) # ouptut paths set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}") diff --git a/cmake/InstallBasicPackageFiles.cmake b/cmake/InstallBasicPackageFiles.cmake index 7368d02..077b95d 100644 --- a/cmake/InstallBasicPackageFiles.cmake +++ b/cmake/InstallBasicPackageFiles.cmake @@ -1,227 +1,216 @@ -#.rst: -# InstallBasicPackageFiles -# ------------------------ -# -# A helper module to make your package easier to be found by other -# projects. -# -# -# .. command:: install_basic_package_files -# -# Create and install a basic version of cmake config files for your -# project:: -# -# install_basic_package_files( -# VERSION -# COMPATIBILITY -# [EXPORT ] # (default = "") -# [FIRST_TARGET ] # (default = "") -# [TARGETS ...] -# [TARGETS_PROPERTY ] -# [TARGETS_PROPERTIES ...] -# [NO_SET_AND_CHECK_MACRO] -# [NO_CHECK_REQUIRED_COMPONENTS_MACRO] -# [VARS_PREFIX ] # (default = "") -# [EXPORT_DESTINATION ] -# [INSTALL_DESTINATION ] -# [NAMESPACE ] # (default = "::") -# [EXTRA_PATH_VARS_SUFFIX path1 [path2 ...]] -# [CONFIG_TEMPLATE ] -# [UPPERCASE_FILENAMES | LOWERCASE_FILENAMES] -# [DEPENDENCIES " [...]" ...] -# [PRIVATE_DEPENDENCIES " [...]" ...] -# [INCLUDE_FILE ] -# [COMPONENT ] # (default = "") -# [NO_COMPATIBILITY_VARS] -# ) -# -# Depending on UPPERCASE_FILENAMES and LOWERCASE_FILENAMES, this -# function generates 3 files: -# -# - ``ConfigVersion.cmake`` or ``-config-version.cmake`` -# - ``Config.cmake`` or ``-config.cmake`` -# - ``Targets.cmake`` or ``-targets.cmake`` -# -# If neither ``UPPERCASE_FILENAMES`` nor ``LOWERCASE_FILENAMES`` is -# set, a file ``ConfigVersion.cmake.in`` or -# ``-config-version.cmake.in`` is searched, and the convention -# is chosed according to the file found. If no file was found, the -# uppercase convention is used. -# -# The ``DEPENDENCIES`` argument can be used to set a list of dependencies -# that will be searched using the :command:`find_dependency` command -# from the :module:`CMakeFindDependencyMacro` module. -# Dependencies can be followed by any of the possible :command:`find_dependency` -# argument. -# In this case, all the arguments must be specified within double quotes (e.g. -# " 1.0.0 EXACT", " CONFIG"). -# The ``PRIVATE_DEPENDENCIES`` argument is similar to ``DEPENDENCIES``, but -# these dependencies are included only when libraries are built ``STATIC``, i.e. -# if ``BUILD_SHARED_LIBS`` is ``OFF`` or if the ``TYPE`` property for one or -# more of the targets is ``STATIC_LIBRARY``. -# When using a custom template file, the ``@PACKAGE_DEPENDENCIES@`` -# string is replaced with the code checking for the dependencies -# specified by these two argument. -# -# Each file is generated twice, one for the build directory and one for -# the installation directory. The ``INSTALL_DESTINATION`` argument can be -# passed to install the files in a location different from the default -# one (``CMake`` on Windows, ``${CMAKE_INSTALL_LIBDIR}/cmake/${Name}`` -# on other platforms. The ``EXPORT_DESTINATION`` argument can be passed to -# generate the files in the build tree in a location different from the default -# one (``CMAKE_BINARY_DIR``). If this is a relative path, it is considered -# relative to the ``CMAKE_BINARY_DIR`` directory. -# -# The ``ConfigVersion.cmake`` is generated using -# ``write_basic_package_version_file``. The ``VERSION``, -# ``COMPATIBILITY``, ``NO_SET_AND_CHECK_MACRO``, and -# ``NO_CHECK_REQUIRED_COMPONENTS_MACRO`` are passed to this function -# and are used internally by :module:`CMakePackageConfigHelpers` module. -# -# ``VERSION`` shall be in the form ``[.[.[.]]]]``. -# If no ``VERSION`` is given, the ``PROJECT_VERSION`` variable is used. -# If this hasn’t been set, it errors out. The ``VERSION`` argument is also used -# to replace the ``@PACKAGE_VERSION@`` string in the configuration file. -# -# ``COMPATIBILITY`` shall be any of ````. -# The ``COMPATIBILITY`` mode ``AnyNewerVersion`` means that the installed -# package version will be considered compatible if it is newer or exactly the -# same as the requested version. This mode should be used for packages which are -# fully backward compatible, also across major versions. -# If ``SameMajorVersion`` is used instead, then the behaviour differs from -# ``AnyNewerVersion`` in that the major version number must be the same as -# requested, e.g. version 2.0 will not be considered compatible if 1.0 is -# requested. This mode should be used for packages which guarantee backward -# compatibility within the same major version. If ``ExactVersion`` is used, then -# the package is only considered compatible if the requested version matches -# exactly its own version number (not considering the tweak version). For -# example, version 1.2.3 of a package is only considered compatible to requested -# version 1.2.3. This mode is for packages without compatibility guarantees. If -# your project has more elaborated version matching rules, you will need to -# write your own custom ConfigVersion.cmake file instead of using this macro. -# -# By default ``install_basic_package_files`` also generates the two helper -# macros ``set_and_check()`` and ``check_required_components()`` into the -# ``Config.cmake`` file. ``set_and_check()`` should be used instead of the -# normal set() command for setting directories and file locations. Additionally -# to setting the variable it also checks that the referenced file or directory -# actually exists and fails with a ``FATAL_ERROR`` otherwise. This makes sure -# that the created ``Config.cmake`` file does not contain wrong -# references. When using the ``NO_SET_AND_CHECK_MACRO, this macro is not -# generated into the ``Config.cmake`` file. -# -# By default, ``install_basic_package_files`` append a call to -# ``check_required_components()`` in Config.cmake file if the -# package supports components. This macro checks whether all requested, -# non-optional components have been found, and if this is not the case, sets the -# ``_FOUND`` variable to ``FALSE``, so that the package is considered to -# be not found. It does that by testing the ``__FOUND`` -# variables for all requested required components. When using the -# ``NO_CHECK_REQUIRED_COMPONENTS_MACRO`` option, this macro is not generated -# into the Config.cmake file. -# -# Finally, the files in the build and install directory are exactly the same. -# -# See the documentation of :module:`CMakePackageConfigHelpers` module for -# further information and references therein. -# -# -# The ``Config.cmake`` is generated using -# ``configure_package_config_file``. See the documentation for the -# :module:`CMakePackageConfigHelpers` module for further information. -# If the ``CONFIG_TEMPLATE`` argument is passed, the specified file -# is used as template for generating the configuration file, otherwise -# this module expects to find a ``Config.cmake.in`` or -# ``-config.cmake.in`` file either in the root directory of the -# project or in current source directory. -# If the file does not exist, a very basic file is created. -# -# A set of variables are checked and passed to -# ``configure_package_config_file`` as ``PATH_VARS``. For each of the -# ``SUFFIX`` considered, if one of the variables:: -# -# _(BUILD|INSTALL)_ -# (BUILD|INSTALL)__ -# -# is defined, the ``_`` variable will be defined -# before configuring the package. In order to use that variable in the -# config file, you have to add a line:: -# -# set_and_check(_ \"@PACKAGE__@\") -# -# if the path must exist or just:: -# -# set(_ \"@PACKAGE__@\") -# -# if the path could be missing. -# -# These variable will have different values whether you are using the -# package from the build tree or from the install directory. Also these -# files will contain only relative paths, meaning that you can move the -# whole installation and the CMake files will still work. -# -# Default ``PATH_VARS`` suffixes are:: -# -# BINDIR BIN_DIR -# SBINDIR SBIN_DIR -# LIBEXECDIR LIBEXEC_DIR -# SYSCONFDIR SYSCONF_DIR -# SHAREDSTATEDIR SHAREDSTATE_DIR -# LOCALSTATEDIR LOCALSTATE_DIR -# LIBDIR LIB_DIR -# INCLUDEDIR INCLUDE_DIR -# OLDINCLUDEDIR OLDINCLUDE_DIR -# DATAROOTDIR DATAROOT_DIR -# DATADIR DATA_DIR -# INFODIR INFO_DIR -# LOCALEDIR LOCALE_DIR -# MANDIR MAN_DIR -# DOCDIR DOC_DIR -# -# more suffixes can be added using the ``EXTRA_PATH_VARS_SUFFIX`` -# argument. -# -# -# The ``Targets.cmake`` is generated using -# :command:`export(TARGETS)` (if ``EXPORT`` or no options are used) or -# :command:`export(TARGETS)` (if `EXPORT` is not used and one between -# ``TARGETS``, ``TARGETS_PROPERTY``, or ``TARGETS_PROPERTIES`` is used) in the -# build tree and :command:`install(EXPORT)` in the installation directory. -# The targets are exported using the value for the ``NAMESPACE`` -# argument as namespace. -# The export can be passed using the `EXPORT` argument. -# The targets can be passed using the `TARGETS` argument or using one or more -# global properties, that can be passed to the function using the -# ``TARGETS_PROPERTY`` or ``TARGET_PROPERTIES`` arguments. -# -# If the ``NO_COMPATIBILITY_VARS`` argument is not set, the compatibility -# variables ``_LIBRARIES`` and ``_INCLUDE_DIRS`` -# are set, trying to guess their correct values from the variables set or -# from the arguments passed to this command. This argument is ignored if -# the template file is not generated by this command. -# -# If the ``INCLUDE_FILE`` argument is passed, the content of the specified file -# (which might be templated) is appended to the ``Config.cmake``. -# This allows to inject custom code to this file, useful e.g. to set additional -# variables which are loaded by downstream projects. -# -# If the ``COMPONENT`` argument is passed, it is forwarded to the -# :command:`install` commands, otherwise is used. - -#============================================================================= -# Copyright 2013 Istituto Italiano di Tecnologia (IIT) -# Authors: Daniele E. Domenichelli -# -# 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.) +# SPDX-FileCopyrightText: 2012-2021 Istituto Italiano di Tecnologia (IIT) +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +InstallBasicPackageFiles +------------------------ + +A helper module to make your package easier to be found by other +projects. + + +.. command:: install_basic_package_files + +Create and install a basic version of cmake config files for your +project:: + + install_basic_package_files( + COMPATIBILITY + [VERSION ] + [ARCH_INDEPENDENT] + [NO_EXPORT | EXPORT ] # (default = "EXPORT ") + [NO_SET_AND_CHECK_MACRO] + [NO_CHECK_REQUIRED_COMPONENTS_MACRO] + [VARS_PREFIX ] # (default = "") + [EXPORT_DESTINATION ] + [INSTALL_DESTINATION ] + [NAMESPACE ] # (default = "::") + [EXTRA_PATH_VARS_SUFFIX path1 [path2 ...]] + [CONFIG_TEMPLATE ] + [UPPERCASE_FILENAMES | LOWERCASE_FILENAMES] + [DEPENDENCIES " [...]" ...] + [PRIVATE_DEPENDENCIES " [...]" ...] + [INCLUDE_FILE | INCLUDE_CONTENT ] + [COMPONENT ] # (default = "") + ) + +Depending on ``UPPERCASE_FILENAMES`` and ``LOWERCASE_FILENAMES``, this +function generates 3 files: + + - ``ConfigVersion.cmake`` or ``-config-version.cmake`` + - ``Config.cmake`` or ``-config.cmake`` + - ``Targets.cmake`` or ``-targets.cmake`` + +If neither ``UPPERCASE_FILENAMES`` nor ``LOWERCASE_FILENAMES`` is +set, a file ``Config.cmake.in`` or +``-config.cmake.in`` is searched, and the convention +is chosed according to the file found. If no file was found, the +uppercase convention is used. + +The ``DEPENDENCIES`` argument can be used to set a list of dependencies +that will be searched using the :cmake:command:`find_dependency` command +from the :module:`CMakeFindDependencyMacro` module. +Dependencies can be followed by any of the possible +:cmake:command:`find_dependency` argument. +In this case, all the arguments must be specified within double quotes (e.g. +``" 1.0.0 EXACT"``, or ``" CONFIG"``). +The ``PRIVATE_DEPENDENCIES`` argument is similar to ``DEPENDENCIES``, but +these dependencies are included only when :variable:`BUILD_SHARED_LIBS` is +``OFF``. +If a libraries is declared ``STATIC``, ``OBJECT`` or ``INTERFACE``, and they +link to some dependency, these should be added using the ``DEPENDENCIES`` +argument, since the ``PRIVATE_DEPENDENCIES`` argument would work only when +:variable:`BUILD_SHARED_LIBS` is disabled. + +When using a custom template file, the ``@PACKAGE_DEPENDENCIES@`` +string is replaced with the code checking for the dependencies +specified by these two argument. + +If the ``ARCH_INDEPENDENT`` option is enabled, the installed package version +will be considered compatible even if it was built for a different +architecture than the requested architecture. + +Each file is generated twice, one for the build directory and one for +the installation directory. The ``INSTALL_DESTINATION`` argument can be +passed to install the files in a location different from the default +one (``${CMAKE_INSTALL_DATADIR}/cmake/${Name}`` if the ``ARCH_INDEPENDENT`` +option is enabled, ``${CMAKE_INSTALL_LIBDIR}/cmake/${Name}`` otherwise). +The ``EXPORT_DESTINATION`` argument can be passed to +generate the files in the build tree in a location different from the default +one (``CMAKE_BINARY_DIR``). If this is a relative path, it is +considered relative to the ``CMAKE_CURRENT_BINARY_DIR`` directory. + +The build directory is exported to the CMake user package registry if the +build option ``CMAKE_EXPORT_PACKAGE_REGISTRY`` is set. + +The ``ConfigVersion.cmake`` file is generated using +:cmake:command:`write_basic_package_version_file`. The ``VERSION``, +``COMPATIBILITY``, and ``ARCH_INDEPENDENT``arguments are passed to this +function. + +``VERSION`` shall be in the form ``[.[.[.]]]]``. +If no ``VERSION`` is given, the ``PROJECT_VERSION`` variable is used. +If this hasn’t been set, it errors out. The ``VERSION`` argument is also used +to replace the ``@PACKAGE_VERSION@`` string in the configuration file. + +``COMPATIBILITY`` shall be any of the options accepted by the +:cmake:command:`write_basic_package_version_file` command +(``AnyNewerVersion``, ``SameMajorVersion``, ``SameMinorVersion`` [CMake 3.11], +or ``ExactVersion``). +These options are explained in :cmake:command:`write_basic_package_version_file` +command documentation. +If your project has more elaborate version matching rules, you will need to +write your own custom ConfigVersion.cmake file instead of using this macro. + +The ``Config.cmake`` file is generated using +:cmake:command:`configure_package_config_file`. The +``NO_SET_AND_CHECK_MACRO``, ``NO_CHECK_REQUIRED_COMPONENTS_MACRO``, and +arguments are passed to this function. + +By default :command:`install_basic_package_files` also generates the two helper +macros ``set_and_check()`` and ``check_required_components()`` into the +``Config.cmake`` file. ``set_and_check()`` should be used instead of the +normal :cmake:command:`set()` command for setting directories and file locations. +Additionally to setting the variable it also checks that the referenced file +or directory actually exists and fails with a ``FATAL_ERROR`` otherwise. +This makes sure that the created ``Config.cmake`` file does not contain +wrong references. +When using the ``NO_SET_AND_CHECK_MACRO, this macro is not generated into the +``Config.cmake`` file. + +By default, :command:`install_basic_package_files` append a call to +``check_required_components()`` in ``Config.cmake`` file if the +package supports components. This macro checks whether all requested, +non-optional components have been found, and if this is not the case, sets the +``_FOUND`` variable to ``FALSE``, so that the package is considered to +be not found. It does that by testing the ``__FOUND`` +variables for all requested required components. When using the +``NO_CHECK_REQUIRED_COMPONENTS_MACRO`` option, this macro is not generated +into the ``Config.cmake`` file. + +Finally, the files in the build and install directory are exactly the same. + +See the documentation of :module:`CMakePackageConfigHelpers` module for +further information and references therein. + +If the ``CONFIG_TEMPLATE`` argument is passed, the specified file +is used as template for generating the configuration file, otherwise +this module expects to find a ``Config.cmake.in`` or +``-config.cmake.in`` file either in current source directory. +If the file does not exist, a very basic file is created. + +A set of variables are checked and passed to +:cmake:command:`configure_package_config_file` as ``PATH_VARS``. For each of the +``SUFFIX`` considered, if one of the variables:: + + _(BUILD|INSTALL)_ + (BUILD|INSTALL)__ + +is defined, the ``_`` variable will be defined +before configuring the package. In order to use that variable in the +config file, you have to add a line:: + + set_and_check(_ \"@PACKAGE__@\") + +if the path must exist or just:: + + set(_ \"@PACKAGE__@\") + +if the path could be missing. + +These variable will have different values whether you are using the +package from the build tree or from the install directory. Also these +files will contain only relative paths, meaning that you can move the +whole installation and the CMake files will still work. + +Default ``PATH_VARS`` suffixes are:: + + BINDIR BIN_DIR + SBINDIR SBIN_DIR + LIBEXECDIR LIBEXEC_DIR + SYSCONFDIR SYSCONF_DIR + SHAREDSTATEDIR SHAREDSTATE_DIR + LOCALSTATEDIR LOCALSTATE_DIR + LIBDIR LIB_DIR + INCLUDEDIR INCLUDE_DIR + OLDINCLUDEDIR OLDINCLUDE_DIR + DATAROOTDIR DATAROOT_DIR + DATADIR DATA_DIR + INFODIR INFO_DIR + LOCALEDIR LOCALE_DIR + MANDIR MAN_DIR + DOCDIR DOC_DIR + +more suffixes can be added using the ``EXTRA_PATH_VARS_SUFFIX`` +argument. + + +The ``Targets.cmake`` is generated using :cmake:command:`export(EXPORT)` +in the build tree and :cmake:command:`install(EXPORT)` in the installation +directory. The targets are exported using the value for the ``NAMESPACE`` +argument as namespace. +The export can be passed using the ``EXPORT`` argument. If no export is +used (e.g. for a CMake script library), pass ``NO_EXPORT``. + +If the ``INCLUDE_FILE`` argument is passed, the content of the specified file +(which might contain ``@variables@``) is appended to the generated +``Config.cmake`` file. +If the ``INCLUDE_CONTENT`` argument is passed, the specified content +(which might contain ``@variables@``) is appended to the generated +``Config.cmake`` file. +When a ``CONFIG_TEMPLATE`` is passed, or a ``ConfigVersion.cmake.in`` or +a ``-config-version.cmake.in file is available, these 2 arguments are +used to replace the ``@INCLUDED_CONTENT@`` string in this file. +This allows one to inject custom code to this file, useful e.g. to set +additional variables which are loaded by downstream projects. + +Note that content specified with ``INCLUDE_FILE`` or ``INCLUDE_CONTENT`` +cannot reference any of the ``PATH_VARS`` because this content is not +expanded by :cmake:command:`configure_package_config_file`. + +If the ``COMPONENT`` argument is passed, it is forwarded to the +:cmake:command:`install` commands, otherwise ```` is used. +#]=======================================================================] if(COMMAND install_basic_package_files) @@ -233,31 +222,34 @@ include(GNUInstallDirs) include(CMakePackageConfigHelpers) include(CMakeParseArguments) -function(INSTALL_BASIC_PACKAGE_FILES _Name) - # TODO check that _Name does not contain "-" characters +function(INSTALL_BASIC_PACKAGE_FILES _Name) - set(_options NO_SET_AND_CHECK_MACRO + set(_options ARCH_INDEPENDENT + NO_EXPORT + NO_SET_AND_CHECK_MACRO NO_CHECK_REQUIRED_COMPONENTS_MACRO UPPERCASE_FILENAMES LOWERCASE_FILENAMES - NO_COMPATIBILITY_VARS) + NO_COMPATIBILITY_VARS # Deprecated + ENABLE_COMPATIBILITY_VARS) # Deprecated set(_oneValueArgs VERSION COMPATIBILITY EXPORT - FIRST_TARGET - TARGETS_PROPERTY + FIRST_TARGET # Deprecated + TARGETS_PROPERTY # Deprecated VARS_PREFIX EXPORT_DESTINATION INSTALL_DESTINATION - DESTINATION + DESTINATION # Deprecated NAMESPACE CONFIG_TEMPLATE INCLUDE_FILE + INCLUDE_CONTENT COMPONENT) set(_multiValueArgs EXTRA_PATH_VARS_SUFFIX - TARGETS - TARGETS_PROPERTIES + TARGETS # Deprecated + TARGETS_PROPERTIES # Deprecated DEPENDENCIES PRIVATE_DEPENDENCIES) cmake_parse_arguments(_IBPF "${_options}" "${_oneValueArgs}" "${_multiValueArgs}" "${ARGN}") @@ -267,67 +259,76 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) endif() if(NOT DEFINED _IBPF_VERSION) - message(FATAL_ERROR "VERSION argument is required") + if(NOT DEFINED PROJECT_VERSION) + message(FATAL_ERROR "VERSION argument is required (PROJECT_VERSION is not defined)") + endif() + set(_IBPF_VERSION ${PROJECT_VERSION}) endif() if(NOT DEFINED _IBPF_COMPATIBILITY) message(FATAL_ERROR "COMPATIBILITY argument is required") endif() + unset(_arch_independent) + if(_IBPF_ARCH_INDEPENDENT) + set(_arch_independent ARCH_INDEPENDENT) + endif() + if(_IBPF_UPPERCASE_FILENAMES AND _IBPF_LOWERCASE_FILENAMES) message(FATAL_ERROR "UPPERCASE_FILENAMES and LOWERCASE_FILENAMES arguments cannot be used together") endif() + if(DEFINED _IBPF_INCLUDE_FILE AND DEFINED _IBPF_INCLUDE_CONTENT) + message(FATAL_ERROR "INCLUDE_FILE and INCLUDE_CONTENT arguments cannot be used together") + endif() + # Prepare install and export commands - set(_first_target ${_Name}) - set(_targets ${_Name}) + unset(_targets) set(_install_cmd EXPORT ${_Name}) set(_export_cmd EXPORT ${_Name}) - if(DEFINED _IBPF_FIRST_TARGET) - if(DEFINED _IBPF_TARGETS OR DEFINED _IBPF_TARGETS_PROPERTIES OR DEFINED _IBPF_TARGETS_PROPERTIES) - message(FATAL_ERROR "EXPORT cannot be used with TARGETS, TARGETS_PROPERTY or TARGETS_PROPERTIES") - endif() - - set(_first_target ${_IBPF_FIRST_TARGET}) - set(_targets ${_IBPF_FIRST_TARGET}) - endif() - if(DEFINED _IBPF_EXPORT) - if(DEFINED _IBPF_TARGETS OR DEFINED _IBPF_TARGETS_PROPERTIES OR DEFINED _IBPF_TARGETS_PROPERTIES) - message(FATAL_ERROR "EXPORT cannot be used with TARGETS, TARGETS_PROPERTY or TARGETS_PROPERTIES") + if(_IBPF_NO_EXPORT OR DEFINED _IBPF_TARGETS OR DEFINED _IBPF_TARGETS_PROPERTIES OR DEFINED _IBPF_TARGETS_PROPERTIES) + message(FATAL_ERROR "EXPORT cannot be used with NO_EXPORT, TARGETS, TARGETS_PROPERTY, or TARGETS_PROPERTIES") endif() set(_export_cmd EXPORT ${_IBPF_EXPORT}) set(_install_cmd EXPORT ${_IBPF_EXPORT}) + elseif(_IBPF_NO_EXPORT) + if(DEFINED _IBPF_TARGETS OR DEFINED _IBPF_TARGETS_PROPERTIES OR DEFINED _IBPF_TARGETS_PROPERTIES) + message(FATAL_ERROR "NO_EXPORT cannot be used with TARGETS, TARGETS_PROPERTY, or TARGETS_PROPERTIES") + endif() + elseif(DEFINED _IBPF_TARGETS) + message(DEPRECATION "TARGETS is deprecated. Use EXPORT instead") + if(DEFINED _IBPF_TARGETS_PROPERTY OR DEFINED _IBPF_TARGETS_PROPERTIES) message(FATAL_ERROR "TARGETS cannot be used with TARGETS_PROPERTY or TARGETS_PROPERTIES") endif() set(_targets ${_IBPF_TARGETS}) set(_export_cmd TARGETS ${_IBPF_TARGETS}) - list(GET _targets 0 _first_target) elseif(DEFINED _IBPF_TARGETS_PROPERTY) + message(DEPRECATION "TARGETS_PROPERTY is deprecated. Use EXPORT instead") + if(DEFINED _IBPF_TARGETS_PROPERTIES) message(FATAL_ERROR "TARGETS_PROPERTIES cannot be used with TARGETS_PROPERTIES") endif() get_property(_targets GLOBAL PROPERTY ${_IBPF_TARGETS_PROPERTY}) set(_export_cmd TARGETS ${_targets}) - list(GET _targets 0 _first_target) elseif(DEFINED _IBPF_TARGETS_PROPERTIES) + message(DEPRECATION "TARGETS_PROPERTIES is deprecated. Use EXPORT instead") - unset(_targets) + set(_targets "") # Defined but empty foreach(_prop ${_IBPF_TARGETS_PROPERTIES}) get_property(_prop_val GLOBAL PROPERTY ${_prop}) list(APPEND _targets ${_prop_val}) endforeach() set(_export_cmd TARGETS ${_targets}) - list(GET _targets 0 _first_target) endif() @@ -339,18 +340,45 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) endif() endif() + # If not set by the user, choose an adequate destination if(NOT DEFINED _IBPF_INSTALL_DESTINATION) - if(WIN32 AND NOT CYGWIN) - set(_IBPF_INSTALL_DESTINATION CMake) + if(_IBPF_ARCH_INDEPENDENT) + set(_IBPF_INSTALL_DESTINATION ${CMAKE_INSTALL_DATADIR}/cmake/${_Name}) else() set(_IBPF_INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${_Name}) endif() endif() + # FIRST_TARGET is no longer used + if(DEFINED _IBPF_FIRST_TARGET) + message(DEPRECATION "FIRST_TARGET is deprecated.") + endif() + + # NO_COMPATIBILITY_VARS and ENABLE_COMPATIBILITY_VARS cannot be used together + if(_IBPF_NO_COMPATIBILITY_VARS AND _ENABLE_COMPATIBILITY_VARS) + message(FATAL_ERROR "NO_COMPATIBILITY_VARS and ENABLE_COMPATIBILITY_VARS cannot be used together") + endif() + # NO_COMPATIBILITY_VARS is deprecated + if(_IBPF_NO_COMPATIBILITY_VARS) + message(DEPRECATION "NO_COMPATIBILITY_VARS is deprecated.") + endif() + # ENABLE_COMPATIBILITY_VARS is deprecated + if(_IBPF_ENABLE_COMPATIBILITY_VARS) + message(DEPRECATION "ENABLE_COMPATIBILITY_VARS is deprecated.") + endif() + # ENABLE_COMPATIBILITY_VARS does not work with EXPORT + if(NOT DEFINED _targets AND _IBPF_ENABLE_COMPATIBILITY_VARS) + message(FATAL_ERROR "ENABLE_COMPATIBILITY_VARS does not work with EXPORT") + endif() + # ENABLE_COMPATIBILITY_VARS can be enabled for projects still using targets + if(DEFINED _targets AND NOT _IBPF_NO_COMPATIBILITY_VARS AND NOT _IBPF_ENABLE_COMPATIBILITY_VARS) + message(DEPRECATION "Compatibility variables are no longer generated. Use ENABLE_COMPATIBILITY_VARS to re-enable them (deprecated) or define them using either INCLUDE_FILE or INCLUDE_CONTENT (recommended).") + endif() + if(NOT DEFINED _IBPF_EXPORT_DESTINATION) set(_IBPF_EXPORT_DESTINATION "${CMAKE_BINARY_DIR}") - elseif(NOT IS_ABSOLUTE _IBPF_EXPORT_DESTINATION) - set(_IBPF_EXPORT_DESTINATION "${CMAKE_BINARY_DIR}/${_IBPF_EXPORT_DESTINATION}") + elseif(NOT IS_ABSOLUTE "${_IBPF_EXPORT_DESTINATION}") + set(_IBPF_EXPORT_DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/${_IBPF_EXPORT_DESTINATION}") endif() if(NOT DEFINED _IBPF_NAMESPACE) @@ -391,17 +419,7 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) endif() else() string(TOLOWER "${_Name}" _name) - if(EXISTS "${CMAKE_SOURCE_DIR}/${_Name}Config.cmake.in") - set(_config_cmake_in "${CMAKE_SOURCE_DIR}/${_Name}Config.cmake.in") - if(NOT _IBPF_UPPERCASE_FILENAMES AND NOT _IBPF_LOWERCASE_FILENAMES) - set(_IBPF_UPPERCASE_FILENAMES 1) - endif() - elseif(EXISTS "${CMAKE_SOURCE_DIR}/${_name}-config.cmake.in") - set(_config_cmake_in "${CMAKE_SOURCE_DIR}/${_name}-config.cmake.in") - if(NOT _IBPF_UPPERCASE_FILENAMES AND NOT _IBPF_LOWERCASE_FILENAMES) - set(_IBPF_LOWERCASE_FILENAMES 1) - endif() - elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${_Name}Config.cmake.in") + if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${_Name}Config.cmake.in") set(_config_cmake_in "${CMAKE_CURRENT_SOURCE_DIR}/${_Name}Config.cmake.in") if(NOT _IBPF_UPPERCASE_FILENAMES AND NOT _IBPF_LOWERCASE_FILENAMES) set(_IBPF_UPPERCASE_FILENAMES 1) @@ -414,7 +432,7 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) else() set(_generate_file 1) if(_IBPF_LOWERCASE_FILENAMES) - set(_config_cmake_in "${CMAKE_CURRENT_BINARY_DIR}/${_name}-config.cmake") + set(_config_cmake_in "${CMAKE_CURRENT_BINARY_DIR}/${_name}-config.cmake.in") else() set(_config_cmake_in "${CMAKE_CURRENT_BINARY_DIR}/${_Name}Config.cmake.in") set(_IBPF_UPPERCASE_FILENAMES 1) @@ -430,16 +448,31 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) endif() endif() if(NOT EXISTS "${_IBPF_INCLUDE_FILE}") - message(FATAL_ERROR "File \"${_IBPF_INCLUDE_FILE}\" not found") + message(FATAL_ERROR "File \"${_IBPF_INCLUDE_FILE}\" not found") + endif() + file(READ ${_IBPF_INCLUDE_FILE} _IBPF_INCLUDE_CONTENT) + endif() + + if(DEFINED _IBPF_INCLUDE_CONTENT) + string(CONFIGURE ${_IBPF_INCLUDE_CONTENT} + _IBPF_INCLUDE_CONTENT + @ONLY) + set(INCLUDED_CONTENT +"#### Expanded from INCLUDE_FILE/INCLUDE_CONTENT by install_basic_package_files() #### + +${_IBPF_INCLUDE_CONTENT} + +##################################################################################### +") + endif() + + # Backwards compatibility + if(NOT _generate_file AND DEFINED _IBPF_INCLUDE_FILE) + file(READ ${_config_cmake_in} _config_cmake_in_content) + if("${_config_cmake_in_content}" MATCHES "@INCLUDED_FILE_CONTENT@") + message(DEPRECATION "The @INCLUDED_FILE_CONTENT@ variable is deprecated in favour of @INCLUDED_CONTENT@") + set(INCLUDED_FILE_CONTENT "${INCLUDED_CONTENT}") endif() - file(READ ${_IBPF_INCLUDE_FILE} _includedfile_user_content_in) - string(CONFIGURE ${_includedfile_user_content_in} _includedfile_user_content) - set(INCLUDED_FILE_CONTENT -"#### Expanded from INCLUDE_FILE by install_basic_package_files() ####") - set(INCLUDED_FILE_CONTENT "${INCLUDED_FILE_CONTENT}\n\n${_includedfile_user_content}") - set(INCLUDED_FILE_CONTENT -"${INCLUDED_FILE_CONTENT} -#####################################################################") endif() # Select output file names @@ -458,7 +491,7 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) if(_generate_file) # Generate the compatibility code unset(_compatibility_vars) - if(NOT _IBPF_NO_COMPATIBILITY_VARS) + if(_IBPF_ENABLE_COMPATIBILITY_VARS) unset(_get_include_dir_code) unset(_set_include_dir_code) unset(_target_list) @@ -469,25 +502,34 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) DEFINED BUILD_${_IBPF_VARS_PREFIX}_INCLUDEDIR OR DEFINED ${_IBPF_VARS_PREFIX}_INSTALL_INCLUDEDIR OR DEFINED INSTALL_${_IBPF_VARS_PREFIX}_INCLUDEDIR) - set(_get_include_dir "set(${_IBPF_VARS_PREFIX}_INCLUDEDIR \"\@PACKAGE_${_IBPF_VARS_PREFIX}_INCLUDEDIR\@\")\n") - set(_set_include_dir "set(${_Name}_INCLUDE_DIRS \"\${${_IBPF_VARS_PREFIX}_INCLUDEDIR}\")") + list(APPEND _include_dir_list "\"\@PACKAGE_${_IBPF_VARS_PREFIX}_INCLUDEDIR\@\"") elseif(DEFINED ${_IBPF_VARS_PREFIX}_BUILD_INCLUDE_DIR OR DEFINED BUILD_${_IBPF_VARS_PREFIX}_INCLUDE_DIR OR DEFINED ${_IBPF_VARS_PREFIX}_INSTALL_INCLUDE_DIR OR DEFINED INSTALL_${_IBPF_VARS_PREFIX}_INCLUDE_DIR) - set(_get_include_dir "set(${_IBPF_VARS_PREFIX}_INCLUDE_DIR \"\@PACKAGE_${_IBPF_VARS_PREFIX}_INCLUDE_DIR\@\")\n") - set(_set_include_dir "set(${_Name}_INCLUDE_DIRS \"\${${_IBPF_VARS_PREFIX}_INCLUDE_DIR}\")") + list(APPEND _include_dir_list "\"\@PACKAGE_${_IBPF_VARS_PREFIX}_INCLUDE_DIR\@\"") else() unset(_include_dir_list) foreach(_target ${_targets}) - set(_get_include_dir "${_get_include_dir}get_property(${_IBPF_VARS_PREFIX}_${_target}_INCLUDE_DIR TARGET ${_IBPF_NAMESPACE}${_target} PROPERTY INTERFACE_INCLUDE_DIRECTORIES)\n") - list(APPEND _include_dir_list "\"\${${_IBPF_VARS_PREFIX}_${_target}_INCLUDE_DIR}\"") + list(APPEND _include_dir_list "\$") endforeach() string(REPLACE ";" " " _include_dir_list "${_include_dir_list}") string(REPLACE ";" " " _target_list "${_target_list}") - set(_set_include_dir "set(${_Name}_INCLUDE_DIRS ${_include_dir_list})\nlist(REMOVE_DUPLICATES ${_Name}_INCLUDE_DIRS)") + set(_set_include_dir "") endif() - set(_compatibility_vars "# Compatibility\n${_get_include_dir}\nset(${_Name}_LIBRARIES ${_target_list})\n${_set_include_dir}") + set(_compatibility_vars +"# Compatibility\nset(${_Name}_LIBRARIES ${_target_list}) +set(${_Name}_INCLUDE_DIRS ${_include_dir_list}) +if(NOT \"\${${_Name}_INCLUDE_DIRS}\" STREQUAL \"\") + list(REMOVE_DUPLICATES ${_Name}_INCLUDE_DIRS) +endif() +") + endif() + + if(_IBPF_NO_EXPORT) + set(_include_targets_cmd "") + else() + set(_include_targets_cmd "include(\"\${CMAKE_CURRENT_LIST_DIR}/${_targets_filename}\")") endif() # Write the file @@ -498,13 +540,11 @@ function(INSTALL_BASIC_PACKAGE_FILES _Name) \@PACKAGE_DEPENDENCIES\@ -if(NOT TARGET ${_IBPF_NAMESPACE}${_first_target}) - include(\"\${CMAKE_CURRENT_LIST_DIR}/${_targets_filename}\") -endif() +${_include_targets_cmd} ${_compatibility_vars} -\@INCLUDED_FILE_CONTENT\@ +\@INCLUDED_CONTENT\@ ") endif() @@ -548,7 +588,8 @@ ${_compatibility_vars} # ConfigVersion.cmake file (same for build tree and intall) write_basic_package_version_file("${_IBPF_EXPORT_DESTINATION}/${_version_filename}" VERSION ${_IBPF_VERSION} - COMPATIBILITY ${_IBPF_COMPATIBILITY}) + COMPATIBILITY ${_IBPF_COMPATIBILITY} + ${_arch_independent}) install(FILES "${_IBPF_EXPORT_DESTINATION}/${_version_filename}" DESTINATION ${_IBPF_INSTALL_DESTINATION} COMPONENT ${_IBPF_COMPONENT}) @@ -558,71 +599,23 @@ ${_compatibility_vars} set(_need_private_deps 0) if(NOT BUILD_SHARED_LIBS) set(_need_private_deps 1) - else() - foreach(_target ${_targets}) - get_property(_type TARGET ${_target} PROPERTY TYPE) - if("${_type}" STREQUAL "STATIC_LIBRARY") - set(_need_private_deps 1) - break() - endif() - endforeach() endif() unset(PACKAGE_DEPENDENCIES) - if(DEFINED _IBPF_DEPENDENCIES) + if(DEFINED _IBPF_DEPENDENCIES OR (DEFINED _IBPF_PRIVATE_DEPENDENCIES AND _need_private_deps)) set(PACKAGE_DEPENDENCIES "#### Expanded from @PACKAGE_DEPENDENCIES@ by install_basic_package_files() ####\n\ninclude(CMakeFindDependencyMacro)\n") - # FIXME When CMake 3.9 or greater is required, remove this madness and just - # use find_dependency - if (CMAKE_VERSION VERSION_LESS 3.9) - string(APPEND PACKAGE_DEPENDENCIES " -set(_${_Name}_FIND_PARTS_REQUIRED) -if (${_Name}_FIND_REQUIRED) - set(_${_Name}_FIND_PARTS_REQUIRED REQUIRED) -endif() -set(_${_Name}_FIND_PARTS_QUIET) -if (${_Name}_FIND_QUIETLY) - set(_${_Name}_FIND_PARTS_QUIET QUIET) -endif() -") - - foreach(_dep ${_IBPF_DEPENDENCIES}) - if("${_dep}" MATCHES ".+ .+") - string(REPLACE " " ";" _dep_list "${_dep}") - list(INSERT _dep_list 1 \${_${_Name}_FIND_PARTS_QUIET} \${_${_Name}_FIND_PARTS_REQUIRED}) - string(REPLACE ";" " " _depx "${_dep_list}") - string(APPEND PACKAGE_DEPENDENCIES "find_package(${_depx})\n") - else() - string(APPEND PACKAGE_DEPENDENCIES "find_dependency(${_dep})\n") - endif() - endforeach() - if(_need_private_deps) - foreach(_dep ${_IBPF_PRIVATE_DEPENDENCIES}) - if("${_dep}" MATCHES ".+ .+") - string(REPLACE " " ";" _dep_list "${_dep}") - list(INSERT _dep_list 1 \${_${_Name}_FIND_PARTS_QUIET} \${_${_Name}_FIND_PARTS_REQUIRED}) - string(REPLACE ";" "\n " _depx "${_dep_list}") - string(APPEND PACKAGE_DEPENDENCIES "find_package(${_depx})\n") - else() - string(APPEND PACKAGE_DEPENDENCIES "find_dependency(${_dep})\n") - endif() - endforeach() - endif() - - else() + foreach(_dep ${_IBPF_DEPENDENCIES}) + string(APPEND PACKAGE_DEPENDENCIES "find_dependency(${_dep})\n") + endforeach() - foreach(_dep ${_IBPF_DEPENDENCIES}) + if(_need_private_deps) + foreach(_dep ${_IBPF_PRIVATE_DEPENDENCIES}) string(APPEND PACKAGE_DEPENDENCIES "find_dependency(${_dep})\n") endforeach() - if(_need_private_deps) - foreach(_dep ${_IBPF_PRIVATE_DEPENDENCIES}) - string(APPEND PACKAGE_DEPENDENCIES "find_dependency(${_dep})\n") - endforeach() - endif() - endif() - set(PACKAGE_DEPENDENCIES "${PACKAGE_DEPENDENCIES}\n###############################################################################\n") + string(APPEND PACKAGE_DEPENDENCIES "\n###############################################################################\n") endif() # Prepare PACKAGE_VERSION variable @@ -652,25 +645,40 @@ endif() endif() endforeach() configure_package_config_file("${_config_cmake_in}" - "${CMAKE_CURRENT_BINARY_DIR}/${_config_filename}.install" + "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_config_filename}.install" INSTALL_DESTINATION ${_IBPF_INSTALL_DESTINATION} PATH_VARS ${_install_path_vars} ${configure_package_config_file_extra_args}) - install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${_config_filename}.install" + install(FILES "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_config_filename}.install" DESTINATION ${_IBPF_INSTALL_DESTINATION} RENAME ${_config_filename} COMPONENT ${_IBPF_COMPONENT}) # Targets.cmake (build tree) - export(${_export_cmd} - NAMESPACE ${_IBPF_NAMESPACE} - FILE "${_IBPF_EXPORT_DESTINATION}/${_targets_filename}") + if(NOT _IBPF_NO_EXPORT) + export(${_export_cmd} + NAMESPACE ${_IBPF_NAMESPACE} + FILE "${_IBPF_EXPORT_DESTINATION}/${_targets_filename}") + endif() + + # Export build directory if CMAKE_EXPORT_PACKAGE_REGISTRY is set. + # CMake >= 3.15 already checks for CMAKE_EXPORT_PACKAGE_REGISTRY in `export(PACKAGE)` (cf. + # cf. https://cmake.org/cmake/help/latest/policy/CMP0090.html), and we effectively back-port + # this behavior to earlier versions. + # Note that even never CMake versions may apply old policy behaviors if the consuming project + # requires a lower version of CMake (e.g. `cmake_minimum_required(VERSION 3.14)`), so the + # check for `CMAKE_EXPORT_PACKAGE_REGISTRY` is necessary for CMake >= 3.15 as well. + if(CMAKE_EXPORT_PACKAGE_REGISTRY) + export(PACKAGE ${_Name}) + endif() # Targets.cmake (installed) - install(${_install_cmd} - NAMESPACE ${_IBPF_NAMESPACE} - DESTINATION ${_IBPF_INSTALL_DESTINATION} - FILE "${_targets_filename}" - COMPONENT ${_IBPF_COMPONENT}) + if(NOT _IBPF_NO_EXPORT) + install(${_install_cmd} + NAMESPACE ${_IBPF_NAMESPACE} + DESTINATION ${_IBPF_INSTALL_DESTINATION} + FILE "${_targets_filename}" + COMPONENT ${_IBPF_COMPONENT}) + endif() endfunction()