Feature/refactory install module #211
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,226 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| cmake_minimum_required(VERSION 3.30) | ||
|
|
||
| include_guard(GLOBAL) | ||
|
|
||
| include(CMakePackageConfigHelpers) | ||
| include(GNUInstallDirs) | ||
|
|
||
| # beman_install_library | ||
| # ===================== | ||
| # | ||
| # Installs a library (or set of targets) along with headers, C++ modules, | ||
| # and optional CMake package configuration files. | ||
| # | ||
| # Usage: | ||
| # ------ | ||
| # beman_install_library(<name> | ||
| # TARGETS target1 [target2 ...] | ||
| # [NAMESPACE <namespace>] | ||
| # [EXPORT_NAME <export-name>] | ||
| # [DESTINATION <install-prefix>] | ||
| # ) | ||
| # | ||
| # Arguments: | ||
| # ---------- | ||
| # name | ||
| # Logical package name (e.g. "beman.utility"). | ||
| # Used to derive config file names and cache variable prefixes. | ||
| # | ||
| # TARGETS (required) | ||
| # List of CMake targets to install. | ||
| # | ||
| # NAMESPACE (optional) | ||
| # Namespace for exported targets. | ||
| # Defaults to "beman::". | ||
| # | ||
| # EXPORT_NAME (optional) | ||
| # Name of the CMake export set. | ||
| # Defaults to "<name>-targets". | ||
| # | ||
| # DESTINATION (optional) | ||
| # The install destination for CXX_MODULES. | ||
| # Defaults to CMAKE_INSTALL_INCLUDEDIR/beman/modules. | ||
| # | ||
| # Brief | ||
| # ----- | ||
| # | ||
| # This function installs the specified project TARGETS and its FILE_SET | ||
| # HEADERS to the default CMAKE install Destination. | ||
| # | ||
| # It also handles the installation of the CMake config package files if | ||
| # needed. If the given targets has FILE_SET CXX_MODULE, it will also | ||
| # installed to the given DESTINATION | ||
| # | ||
| # Cache variables: | ||
| # ---------------- | ||
| # BEMAN_INSTALL_CONFIG_FILE_PACKAGES | ||
| # List of package names for which config files should be installed. | ||
| # | ||
| # <PREFIX>_INSTALL_CONFIG_FILE_PACKAGE | ||
| # Per-package override to enable/disable config file installation. | ||
| # <PREFIX> is the uppercased package name with dots replaced by underscores. | ||
| # | ||
| function(beman_install_library name) | ||
| # ---------------------------- | ||
| # Argument parsing | ||
| # ---------------------------- | ||
| set(options) | ||
| set(oneValueArgs NAMESPACE EXPORT_NAME DESTINATION) | ||
| set(multiValueArgs TARGETS) | ||
|
|
||
| cmake_parse_arguments( | ||
| BEMAN | ||
| "${options}" | ||
| "${oneValueArgs}" | ||
| "${multiValueArgs}" | ||
| ${ARGN} | ||
| ) | ||
|
|
||
| if(NOT BEMAN_TARGETS) | ||
| message( | ||
| FATAL_ERROR | ||
| "beman_install_library(${name}): TARGETS must be specified" | ||
| ) | ||
| endif() | ||
|
|
||
| # ---------------------------- | ||
| # Defaults | ||
| # ---------------------------- | ||
| if(NOT BEMAN_NAMESPACE) | ||
| set(BEMAN_NAMESPACE "beman::") | ||
| endif() | ||
|
|
||
| if(NOT BEMAN_EXPORT_NAME) | ||
| set(BEMAN_EXPORT_NAME "${name}-targets") | ||
| endif() | ||
|
|
||
| if(NOT BEMAN_DESTINATION) | ||
| set(BEMAN_DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/beman/modules") | ||
| endif() | ||
|
|
||
| if(CMAKE_SKIP_INSTALL_RULES) | ||
| message( | ||
| WARNING | ||
| "beman_install_library(${name}): not installing targets '${BEMAN_TARGETS}' due to CMAKE_SKIP_INSTALL_RULES" | ||
| ) | ||
| return() | ||
| endif() | ||
|
|
||
| string(REPLACE "beman." "" install_component_name "${name}") | ||
|
|
||
| # ---------------------------------------- | ||
| # Install targets and headers (always) | ||
| # ---------------------------------------- | ||
| install( | ||
| TARGETS ${BEMAN_TARGETS} | ||
| EXPORT ${BEMAN_EXPORT_NAME} | ||
| ARCHIVE # DESTINATION ${CMAKE_INSTALL_LIBDIR} | ||
| LIBRARY # DESTINATION ${CMAKE_INSTALL_LIBDIR} | ||
| RUNTIME # DESTINATION ${CMAKE_INSTALL_BINDIR} | ||
| FILE_SET | ||
| HEADERS # DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} | ||
| ) | ||
|
|
||
| # ---------------------------------------- | ||
| # Conditionally install C++ modules | ||
| # ---------------------------------------- | ||
| foreach(_tgt IN LISTS BEMAN_TARGETS) | ||
| if(NOT TARGET "${_tgt}") | ||
| message( | ||
| FATAL_ERROR | ||
| "beman_install_library(${name}): '${_tgt}' is not a target" | ||
| ) | ||
| endif() | ||
|
|
||
| # Detect presence of C++ module file sets, exact one expected! | ||
| get_target_property(_module_sets "${_tgt}" CXX_MODULE_SETS) | ||
|
|
||
| if(_module_sets) | ||
| install( | ||
| TARGETS "${_tgt}" | ||
| FILE_SET CXX_MODULES DESTINATION "${BEMAN_DESTINATION}" | ||
| ) | ||
| endif() | ||
| endforeach() | ||
|
|
||
| # -------------------------------------------------- | ||
| # Export targets | ||
| # -------------------------------------------------- | ||
| install( | ||
| EXPORT ${BEMAN_EXPORT_NAME} | ||
| NAMESPACE ${BEMAN_NAMESPACE} | ||
| CXX_MODULES_DIRECTORY | ||
| cxx-modules | ||
| DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${name} | ||
| COMPONENT "${install_component_name}" | ||
| ) | ||
|
Comment on lines
150
to
157
Collaborator
Author
There was a problem hiding this comment. This does not work! File will be deleted later |
||
|
|
||
| # ---------------------------------------- | ||
| # Config file installation logic | ||
| # ---------------------------------------- | ||
| string(TOUPPER "${name}" _pkg_upper) | ||
| string(REPLACE "." "_" _pkg_prefix "${_pkg_upper}") | ||
|
|
||
| option( | ||
| ${_pkg_prefix}_INSTALL_CONFIG_FILE_PACKAGE | ||
| "Enable creating and installing a CMake config-file package. Default: ON. Values: { ON, OFF }." | ||
| ON | ||
| ) | ||
|
|
||
| set(_pkg_var "${_pkg_prefix}_INSTALL_CONFIG_FILE_PACKAGE") | ||
|
|
||
| if(NOT DEFINED ${_pkg_var}) | ||
| set(${_pkg_var} | ||
| OFF | ||
| CACHE BOOL | ||
| "Install CMake package config files for ${name}" | ||
| ) | ||
| endif() | ||
|
|
||
| set(_install_config OFF) | ||
|
|
||
| if(${_pkg_var}) | ||
| set(_install_config ON) | ||
| elseif(BEMAN_INSTALL_CONFIG_FILE_PACKAGES) | ||
| list(FIND BEMAN_INSTALL_CONFIG_FILE_PACKAGES "${name}" _idx) | ||
| if(NOT _idx EQUAL -1) | ||
| set(_install_config ON) | ||
| endif() | ||
| endif() | ||
|
|
||
| # ---------------------------------------- | ||
| # Generate + install config files | ||
| # ---------------------------------------- | ||
| if(_install_config) | ||
| set(_config_install_dir "${CMAKE_INSTALL_LIBDIR}/cmake/${name}") | ||
|
|
||
| configure_package_config_file( | ||
| "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/${name}-config.cmake.in" | ||
| "${CMAKE_CURRENT_BINARY_DIR}/${name}-config.cmake" | ||
| INSTALL_DESTINATION ${_config_install_dir} | ||
| ) | ||
|
|
||
| write_basic_package_version_file( | ||
| "${CMAKE_CURRENT_BINARY_DIR}/${name}-config-version.cmake" | ||
| VERSION ${PROJECT_VERSION} | ||
| COMPATIBILITY SameMajorVersion | ||
| ) | ||
|
|
||
| install( | ||
| FILES | ||
| "${CMAKE_CURRENT_BINARY_DIR}/${name}-config.cmake" | ||
| "${CMAKE_CURRENT_BINARY_DIR}/${name}-config-version.cmake" | ||
| DESTINATION ${_config_install_dir} | ||
| COMPONENT "${install_component_name}" | ||
| ) | ||
| else() | ||
| message( | ||
| WARNING | ||
| "beman-install-library(${name}): Not installing a config package for '${name}'" | ||
| ) | ||
| endif() | ||
| endfunction() | ||
|
|
||
| set(CPACK_GENERATOR TGZ) | ||
| include(CPack) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only
Debugmust be used withsanitizerorcoverage!