d51d7d4d5c
Properties specified in EXPORT_PROPERTIES have their values exported verbatim, without evaluating generator expression they might contain. This limitation is removed by the introduced functions. They collect properties that needs to be exported and evaluate generator expressions inside the properties using file(GENERATE) before exporting them. The functions generate the ExtraProperties.cmake file that contains set_property calls with exported properties and corresponding values. Change-Id: If32c30a82a62e8bd48bb91f3df21ff2ad8d07243 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
1269 lines
54 KiB
CMake
1269 lines
54 KiB
CMake
# Copyright (C) 2022 The Qt Company Ltd.
|
|
# SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
macro(qt_internal_get_internal_add_module_keywords option_args single_args multi_args)
|
|
set(${option_args}
|
|
STATIC
|
|
EXCEPTIONS
|
|
INTERNAL_MODULE
|
|
HEADER_MODULE
|
|
DISABLE_TOOLS_EXPORT
|
|
SKIP_DEPENDS_INCLUDE
|
|
NO_MODULE_HEADERS
|
|
NO_SYNC_QT
|
|
NO_PRIVATE_MODULE
|
|
NO_CONFIG_HEADER_FILE
|
|
NO_ADDITIONAL_TARGET_INFO
|
|
NO_GENERATE_METATYPES
|
|
NO_HEADERSCLEAN_CHECK
|
|
GENERATE_CPP_EXPORTS
|
|
GENERATE_PRIVATE_CPP_EXPORTS
|
|
NO_UNITY_BUILD
|
|
)
|
|
set(${single_args}
|
|
MODULE_INCLUDE_NAME
|
|
MODULE_INTERFACE_NAME
|
|
CONFIG_MODULE_NAME
|
|
PRECOMPILED_HEADER
|
|
CONFIGURE_FILE_PATH
|
|
CPP_EXPORT_HEADER_BASE_NAME
|
|
EXTERNAL_HEADERS_DIR
|
|
PRIVATE_HEADER_FILTERS
|
|
QPA_HEADER_FILTERS
|
|
HEADER_SYNC_SOURCE_DIRECTORY
|
|
${__default_target_info_args}
|
|
)
|
|
set(${multi_args}
|
|
QMAKE_MODULE_CONFIG
|
|
EXTRA_CMAKE_FILES
|
|
EXTRA_CMAKE_INCLUDES
|
|
NO_PCH_SOURCES
|
|
EXTERNAL_HEADERS
|
|
POLICIES
|
|
${__default_private_args}
|
|
${__default_public_args}
|
|
${__default_private_module_args}
|
|
)
|
|
endmacro()
|
|
|
|
# The function helps to wrap module include paths with the header existence check.
|
|
function(qt_internal_append_include_directories_with_headers_check target list_to_append type)
|
|
string(TOLOWER "${type}" type)
|
|
string(JOIN "" has_headers_check
|
|
"$<BOOL:"
|
|
"$<TARGET_PROPERTY:"
|
|
"$<TARGET_NAME:${target}>,"
|
|
"_qt_module_has_${type}_headers"
|
|
">"
|
|
">"
|
|
)
|
|
foreach(directory IN LISTS ARGN)
|
|
list(APPEND ${list_to_append}
|
|
"$<${has_headers_check}:${directory}>")
|
|
endforeach()
|
|
set(${list_to_append} "${${list_to_append}}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
# This is the main entry function for creating a Qt module, that typically
|
|
# consists of a library, public header files, private header files and configurable
|
|
# features.
|
|
#
|
|
# A CMake target with the specified target parameter is created. If the current source
|
|
# directory has a configure.cmake file, then that is also processed for feature definition
|
|
# and testing. Any features defined as well as any features coming from dependencies to
|
|
# this module are imported into the scope of the calling feature.
|
|
#
|
|
# Target is without leading "Qt". So e.g. the "QtCore" module has the target "Core".
|
|
#
|
|
# Options:
|
|
# NO_ADDITIONAL_TARGET_INFO
|
|
# Don't generate a Qt6*AdditionalTargetInfo.cmake file.
|
|
# The caller is responsible for creating one.
|
|
#
|
|
# MODULE_INTERFACE_NAME
|
|
# The custom name of the module interface. This name is used as a part of the include paths
|
|
# associated with the module and other interface names. The default value is the target name.
|
|
# If the INTERNAL_MODULE option is specified, MODULE_INTERFACE_NAME is not specified and the
|
|
# target name ends with the suffix 'Private', the MODULE_INTERFACE_NAME value defaults to the
|
|
# non-suffixed target name, e.g.:
|
|
# For the SomeInternalModulePrivate target, the MODULE_INTERFACE_NAME will be
|
|
# SomeInternalModule
|
|
#
|
|
# HEADER_MODULE
|
|
# Creates an interface library instead of following the Qt configuration default. Mutually
|
|
# exclusive with STATIC.
|
|
#
|
|
# STATIC
|
|
# Creates a static library instead of following the Qt configuration default. Mutually
|
|
# exclusive with HEADER_MODULE.
|
|
#
|
|
# EXTERNAL_HEADERS
|
|
# A explicit list of non qt headers (like 3rdparty) to be installed.
|
|
# Note this option overrides install headers used as PUBLIC_HEADER by cmake install(TARGET)
|
|
# otherwise set by syncqt.
|
|
#
|
|
# EXTERNAL_HEADERS_DIR
|
|
# A module directory with non qt headers (like 3rdparty) to be installed.
|
|
# Note this option overrides install headers used as PUBLIC_HEADER by cmake install(TARGET)
|
|
# otherwise set by syncqt.
|
|
#
|
|
# PRIVATE_HEADER_FILTERS
|
|
# The regular expressions that filter private header files out of target sources.
|
|
# The value must use the following format 'regex1|regex2|regex3'.
|
|
#
|
|
# QPA_HEADER_FILTERS
|
|
# The regular expressions that filter QPA header files out of target sources.
|
|
# The value must use the following format 'regex1|regex2|regex3'.
|
|
#
|
|
# HEADER_SYNC_SOURCE_DIRECTORY
|
|
# The source directory for header sync procedure. Header files outside this directory will be
|
|
# ignored by syncqt. The specifying this directory allows to skip the parsing of the whole
|
|
# CMAKE_CURRENT_SOURCE_DIR for the header files that needs to be synced and only parse the
|
|
# single subdirectory, that meanwhile can be outside the CMAKE_CURRENT_SOURCE_DIR tree.
|
|
function(qt_internal_add_module target)
|
|
qt_internal_get_internal_add_module_keywords(
|
|
module_option_args
|
|
module_single_args
|
|
module_multi_args
|
|
)
|
|
|
|
cmake_parse_arguments(PARSE_ARGV 1 arg
|
|
"${module_option_args}"
|
|
"${module_single_args}"
|
|
"${module_multi_args}"
|
|
)
|
|
_qt_internal_validate_all_args_are_parsed(arg)
|
|
|
|
set(is_internal_module FALSE)
|
|
if(arg_INTERNAL_MODULE)
|
|
set(is_internal_module TRUE)
|
|
set(arg_INTERNAL_MODULE "INTERNAL_MODULE")
|
|
set(arg_NO_PRIVATE_MODULE TRUE)
|
|
# Assume the interface name of the internal module should be the module name without the
|
|
# 'Private' suffix.
|
|
if(NOT arg_MODULE_INTERFACE_NAME)
|
|
if(target MATCHES "(.*)Private$")
|
|
set(arg_MODULE_INTERFACE_NAME "${CMAKE_MATCH_1}")
|
|
else()
|
|
message(WARNING "The internal module target should end with the 'Private' suffix.")
|
|
endif()
|
|
endif()
|
|
else()
|
|
unset(arg_INTERNAL_MODULE)
|
|
endif()
|
|
|
|
if(NOT arg_MODULE_INTERFACE_NAME)
|
|
set(arg_MODULE_INTERFACE_NAME "${target}")
|
|
endif()
|
|
|
|
### Define Targets:
|
|
if(arg_HEADER_MODULE)
|
|
set(type_to_create INTERFACE)
|
|
elseif(arg_STATIC)
|
|
set(type_to_create STATIC)
|
|
else()
|
|
# Use default depending on Qt configuration.
|
|
set(type_to_create "")
|
|
endif()
|
|
|
|
_qt_internal_add_library("${target}" ${type_to_create})
|
|
qt_internal_mark_as_internal_library("${target}")
|
|
|
|
get_target_property(target_type ${target} TYPE)
|
|
|
|
set(is_interface_lib 0)
|
|
set(is_shared_lib 0)
|
|
set(is_static_lib 0)
|
|
if(target_type STREQUAL "INTERFACE_LIBRARY")
|
|
set(is_interface_lib 1)
|
|
elseif(target_type STREQUAL "STATIC_LIBRARY")
|
|
set(is_static_lib 1)
|
|
elseif(target_type STREQUAL "SHARED_LIBRARY")
|
|
set(is_shared_lib 1)
|
|
else()
|
|
message(FATAL_ERROR "Invalid target type '${target_type}' for Qt module '${target}'")
|
|
endif()
|
|
|
|
if(NOT arg_NO_SYNC_QT AND NOT arg_NO_MODULE_HEADERS AND arg_MODULE_INCLUDE_NAME)
|
|
# qt_internal_module_info uses this property if it's set, so it must be
|
|
# specified before the qt_internal_module_info call.
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_module_include_name ${arg_MODULE_INCLUDE_NAME}
|
|
)
|
|
endif()
|
|
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_module_interface_name "${arg_MODULE_INTERFACE_NAME}"
|
|
_qt_package_version "${PROJECT_VERSION}"
|
|
_qt_package_name "${INSTALL_CMAKE_NAMESPACE}${target}"
|
|
)
|
|
set(export_properties
|
|
"_qt_module_interface_name"
|
|
"_qt_package_version"
|
|
"_qt_package_name"
|
|
)
|
|
if(NOT is_internal_module)
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_is_public_module TRUE
|
|
)
|
|
list(APPEND export_properties
|
|
"_qt_is_public_module"
|
|
)
|
|
if(NOT ${arg_NO_PRIVATE_MODULE})
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_private_module_target_name "${target}Private"
|
|
)
|
|
list(APPEND export_properties
|
|
"_qt_private_module_target_name"
|
|
)
|
|
endif()
|
|
endif()
|
|
|
|
set_property(TARGET ${target} APPEND PROPERTY EXPORT_PROPERTIES "${export_properties}")
|
|
|
|
qt_internal_module_info(module "${target}")
|
|
qt_internal_add_qt_repo_known_module("${target}")
|
|
if(arg_INTERNAL_MODULE)
|
|
set_target_properties(${target} PROPERTIES _qt_is_internal_module TRUE)
|
|
set_property(TARGET ${target} APPEND PROPERTY EXPORT_PROPERTIES _qt_is_internal_module)
|
|
endif()
|
|
|
|
if(NOT arg_CONFIG_MODULE_NAME)
|
|
set(arg_CONFIG_MODULE_NAME "${module_lower}")
|
|
endif()
|
|
|
|
set(module_config_header "qt${arg_CONFIG_MODULE_NAME}-config.h")
|
|
set(module_config_private_header "qt${arg_CONFIG_MODULE_NAME}-config_p.h")
|
|
# qt<module>-config.h/-config_p.h header files are not marked as GENERATED automatically
|
|
# for old CMake versions. Set the property explicitly here.
|
|
set_source_files_properties("${module_config_header}" "${module_config_private_header}"
|
|
PROPERTIES
|
|
GENERATED TRUE
|
|
SKIP_AUTOGEN TRUE
|
|
)
|
|
|
|
# Module define needs to take into account the config module name.
|
|
string(TOUPPER "${arg_CONFIG_MODULE_NAME}" module_define_infix)
|
|
string(REPLACE "-" "_" module_define_infix "${module_define_infix}")
|
|
string(REPLACE "." "_" module_define_infix "${module_define_infix}")
|
|
|
|
set(property_prefix "INTERFACE_")
|
|
if(NOT arg_HEADER_MODULE)
|
|
set(property_prefix "")
|
|
endif()
|
|
|
|
if(arg_INTERNAL_MODULE)
|
|
string(APPEND arg_CONFIG_MODULE_NAME "_private")
|
|
endif()
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_config_module_name "${arg_CONFIG_MODULE_NAME}"
|
|
${property_prefix}QT_QMAKE_MODULE_CONFIG "${arg_QMAKE_MODULE_CONFIG}")
|
|
set_property(TARGET "${target}" APPEND PROPERTY EXPORT_PROPERTIES _qt_config_module_name)
|
|
|
|
set(is_framework 0)
|
|
if(QT_FEATURE_framework AND NOT ${arg_HEADER_MODULE} AND NOT ${arg_STATIC})
|
|
set(is_framework 1)
|
|
set_target_properties(${target} PROPERTIES
|
|
FRAMEWORK TRUE
|
|
FRAMEWORK_VERSION "A" # Not based on Qt major version
|
|
MACOSX_FRAMEWORK_IDENTIFIER org.qt-project.${module}
|
|
MACOSX_FRAMEWORK_BUNDLE_VERSION ${PROJECT_VERSION}
|
|
MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}
|
|
)
|
|
qt_internal_get_framework_info(fw ${target})
|
|
endif()
|
|
|
|
if(NOT QT_FEATURE_no_direct_extern_access AND QT_FEATURE_reduce_relocations AND
|
|
UNIX AND NOT is_interface_lib)
|
|
# On x86 and x86-64 systems with ELF binaries (especially Linux), due to
|
|
# a new optimization in GCC 5.x in combination with a recent version of
|
|
# GNU binutils, compiling Qt applications with -fPIE is no longer
|
|
# enough.
|
|
# Applications now need to be compiled with the -fPIC option if the Qt option
|
|
# \"reduce relocations\" is active.
|
|
target_compile_options(${target} INTERFACE -fPIC)
|
|
if(GCC AND is_shared_lib)
|
|
target_link_options(${target} PRIVATE LINKER:-Bsymbolic-functions)
|
|
endif()
|
|
endif()
|
|
|
|
if((FEATURE_ltcg OR CMAKE_INTERPROCEDURAL_OPTIMIZATION) AND GCC AND is_static_lib)
|
|
# CMake <= 3.19 appends -fno-fat-lto-objects for all library types if
|
|
# CMAKE_INTERPROCEDURAL_OPTIMIZATION is enabled. Static libraries need
|
|
# the opposite compiler option.
|
|
# (https://gitlab.kitware.com/cmake/cmake/-/issues/21696)
|
|
target_compile_options(${target} PRIVATE -ffat-lto-objects)
|
|
endif()
|
|
|
|
qt_internal_add_target_aliases("${target}")
|
|
qt_skip_warnings_are_errors_when_repo_unclean("${target}")
|
|
_qt_internal_apply_strict_cpp("${target}")
|
|
|
|
# No need to compile Q_IMPORT_PLUGIN-containing files for non-executables.
|
|
if(is_static_lib)
|
|
_qt_internal_disable_static_default_plugins("${target}")
|
|
endif()
|
|
|
|
# Add _private target to link against the private headers:
|
|
set(target_private "${target}Private")
|
|
if(NOT ${arg_NO_PRIVATE_MODULE})
|
|
add_library("${target_private}" INTERFACE)
|
|
qt_internal_add_target_aliases("${target_private}")
|
|
set_target_properties(${target_private} PROPERTIES
|
|
_qt_config_module_name ${arg_CONFIG_MODULE_NAME}_private
|
|
_qt_package_version "${PROJECT_VERSION}"
|
|
_qt_package_name "${INSTALL_CMAKE_NAMESPACE}${target}"
|
|
_qt_is_private_module TRUE
|
|
_qt_public_module_target_name "${target}"
|
|
)
|
|
set(export_properties
|
|
"_qt_config_module_name"
|
|
"_qt_package_version"
|
|
"_qt_package_name"
|
|
"_qt_is_private_module"
|
|
"_qt_public_module_target_name"
|
|
)
|
|
set_property(TARGET "${target_private}" APPEND PROPERTY
|
|
EXPORT_PROPERTIES "${export_properties}")
|
|
endif()
|
|
|
|
# FIXME: This workaround is needed because the deployment logic
|
|
# for iOS and WASM just copies/embeds the directly linked library,
|
|
# which will just be a versioned symlink to the actual library.
|
|
if((UIKIT OR WASM) AND BUILD_SHARED_LIBS)
|
|
set(version_args "")
|
|
else()
|
|
set(version_args
|
|
VERSION ${PROJECT_VERSION}
|
|
SOVERSION ${PROJECT_VERSION_MAJOR})
|
|
endif()
|
|
|
|
if(NOT arg_HEADER_MODULE)
|
|
set_target_properties(${target} PROPERTIES
|
|
LIBRARY_OUTPUT_DIRECTORY "${QT_BUILD_DIR}/${INSTALL_LIBDIR}"
|
|
RUNTIME_OUTPUT_DIRECTORY "${QT_BUILD_DIR}/${INSTALL_BINDIR}"
|
|
ARCHIVE_OUTPUT_DIRECTORY "${QT_BUILD_DIR}/${INSTALL_LIBDIR}"
|
|
${version_args}
|
|
)
|
|
qt_set_target_info_properties(${target} ${ARGN})
|
|
qt_handle_multi_config_output_dirs("${target}")
|
|
|
|
if(NOT BUILD_SHARED_LIBS AND LINUX)
|
|
# Horrible workaround for static build failures due to incorrect static library link
|
|
# order. By increasing the multiplicity to 3, each library cycle will be repeated
|
|
# 3 times on the link line, reducing the probability of undefined symbols at
|
|
# link time.
|
|
# These failures are only observed on Linux with the ld linker (not sure about
|
|
# ld.gold).
|
|
# Allow opting out and modifying the value via cache value, in case if we urgently
|
|
# need to increase it without waiting for the qtbase change to propagate to
|
|
# other dependent repos.
|
|
# The proper fix will be to get rid of the cycles in the future.
|
|
# See QTBUG-83498 for details.
|
|
set(default_link_cycle_multiplicity "3")
|
|
if(DEFINED QT_LINK_CYCLE_MULTIPLICITY)
|
|
set(default_link_cycle_multiplicity "${QT_LINK_CYCLE_MULTIPLICITY}")
|
|
endif()
|
|
if(default_link_cycle_multiplicity)
|
|
set_property(TARGET "${target}"
|
|
PROPERTY
|
|
LINK_INTERFACE_MULTIPLICITY "${default_link_cycle_multiplicity}")
|
|
endif()
|
|
endif()
|
|
|
|
if (arg_SKIP_DEPENDS_INCLUDE)
|
|
set_target_properties(${target} PROPERTIES _qt_module_skip_depends_include TRUE)
|
|
set_property(TARGET "${target}" APPEND PROPERTY
|
|
EXPORT_PROPERTIES _qt_module_skip_depends_include)
|
|
endif()
|
|
if(is_framework)
|
|
set_target_properties(${target} PROPERTIES
|
|
OUTPUT_NAME ${fw_name}
|
|
)
|
|
else()
|
|
set_target_properties(${target} PROPERTIES
|
|
OUTPUT_NAME "${INSTALL_CMAKE_NAMESPACE}${module_interface_name}${QT_LIBINFIX}"
|
|
)
|
|
endif()
|
|
|
|
qt_set_common_target_properties(${target})
|
|
|
|
if (WIN32 AND BUILD_SHARED_LIBS)
|
|
_qt_internal_generate_win32_rc_file(${target})
|
|
endif()
|
|
endif()
|
|
|
|
# Module headers:
|
|
set_property(TARGET "${target}" APPEND PROPERTY EXPORT_PROPERTIES _qt_module_has_headers)
|
|
if(${arg_NO_MODULE_HEADERS} OR ${arg_NO_SYNC_QT})
|
|
set_target_properties("${target}" PROPERTIES
|
|
_qt_module_has_headers OFF)
|
|
else()
|
|
set_property(TARGET ${target} APPEND PROPERTY EXPORT_PROPERTIES _qt_module_include_name)
|
|
set_target_properties("${target}" PROPERTIES
|
|
_qt_module_include_name "${module_include_name}"
|
|
_qt_module_has_headers ON
|
|
)
|
|
|
|
set(sync_source_directory "${CMAKE_CURRENT_SOURCE_DIR}")
|
|
if(arg_HEADER_SYNC_SOURCE_DIRECTORY)
|
|
set(sync_source_directory "${arg_HEADER_SYNC_SOURCE_DIRECTORY}")
|
|
endif()
|
|
set_target_properties(${target} PROPERTIES
|
|
_qt_sync_source_directory "${sync_source_directory}")
|
|
# We should not generate export headers if module is defined as pure STATIC.
|
|
# Static libraries don't need to export their symbols, and corner cases when sources are
|
|
# also used in shared libraries, should be handled manually.
|
|
if(arg_GENERATE_CPP_EXPORTS AND NOT arg_STATIC)
|
|
if(arg_CPP_EXPORT_HEADER_BASE_NAME)
|
|
set(cpp_export_header_base_name
|
|
"CPP_EXPORT_HEADER_BASE_NAME;${arg_CPP_EXPORT_HEADER_BASE_NAME}"
|
|
)
|
|
endif()
|
|
if(arg_GENERATE_PRIVATE_CPP_EXPORTS)
|
|
set(generate_private_cpp_export "GENERATE_PRIVATE_CPP_EXPORTS")
|
|
endif()
|
|
qt_internal_generate_cpp_global_exports(${target} ${module_define_infix}
|
|
"${cpp_export_header_base_name}"
|
|
"${generate_private_cpp_export}"
|
|
)
|
|
endif()
|
|
|
|
set(module_depends_header
|
|
"${module_build_interface_include_dir}/${module_include_name}Depends")
|
|
set_source_files_properties("${module_depends_header}" PROPERTIES GENERATED TRUE)
|
|
set_target_properties(${target} PROPERTIES _qt_module_depends_header
|
|
"${module_depends_header}")
|
|
if(NOT ${arg_HEADER_MODULE})
|
|
set(module_header "${module_build_interface_include_dir}/${module_include_name}")
|
|
set_property(TARGET "${target}" PROPERTY MODULE_HEADER
|
|
"${module_header}")
|
|
endif()
|
|
|
|
set(qpa_filter_regex "")
|
|
if(arg_QPA_HEADER_FILTERS)
|
|
set(qpa_filter_regex "${arg_QPA_HEADER_FILTERS}")
|
|
endif()
|
|
set_target_properties(${target}
|
|
PROPERTIES _qt_module_qpa_headers_filter_regex "${qpa_filter_regex}")
|
|
|
|
set(private_filter_regex ".+_p(ch)?\\.h")
|
|
if(arg_PRIVATE_HEADER_FILTERS)
|
|
set(private_filter_regex "${private_filter_regex}|${arg_PRIVATE_HEADER_FILTERS}")
|
|
endif()
|
|
set_target_properties(${target}
|
|
PROPERTIES _qt_module_private_headers_filter_regex "${private_filter_regex}")
|
|
|
|
# If EXTERNAL_HEADERS_DIR is set we install the specified directory and keep the structure
|
|
# without taking into the account the CMake source tree and syncqt outputs.
|
|
if(arg_EXTERNAL_HEADERS_DIR)
|
|
qt_install(DIRECTORY "${arg_EXTERNAL_HEADERS_DIR}/"
|
|
DESTINATION "${module_install_interface_include_dir}"
|
|
)
|
|
endif()
|
|
endif()
|
|
|
|
if(arg_NO_HEADERSCLEAN_CHECK OR arg_NO_MODULE_HEADERS OR arg_NO_SYNC_QT
|
|
OR NOT QT_FEATURE_headersclean)
|
|
set_target_properties("${target}" PROPERTIES _qt_no_headersclean_check ON)
|
|
endif()
|
|
|
|
if(NOT arg_HEADER_MODULE)
|
|
# Plugin types associated to a module
|
|
if(NOT "x${arg_PLUGIN_TYPES}" STREQUAL "x")
|
|
qt_internal_add_plugin_types("${target}" "${arg_PLUGIN_TYPES}")
|
|
endif()
|
|
endif()
|
|
|
|
qt_internal_library_deprecation_level(deprecation_define)
|
|
|
|
if(NOT arg_HEADER_MODULE)
|
|
qt_autogen_tools_initial_setup(${target})
|
|
endif()
|
|
|
|
set(private_includes
|
|
"$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>"
|
|
"$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>"
|
|
${arg_INCLUDE_DIRECTORIES}
|
|
)
|
|
|
|
set(public_includes "")
|
|
set(public_headers_list "public_includes")
|
|
if(is_framework)
|
|
set(public_headers_list "private_includes")
|
|
endif()
|
|
|
|
# Make sure the BUILD_INTERFACE include paths come before the framework headers, so that the
|
|
# the compiler prefers the build dir includes.
|
|
#
|
|
# Make sure to add non-framework "build_dir/include" as an include path for moc to find the
|
|
# currently built module headers. qmake does this too.
|
|
# Framework-style include paths are found by moc when cmQtAutoMocUic.cxx detects frameworks by
|
|
# looking at an include path and detecting a "QtFoo.framework/Headers" path.
|
|
# Make sure to create such paths for both the the BUILD_INTERFACE and the INSTALL_INTERFACE.
|
|
#
|
|
# Only add syncqt headers if they exist.
|
|
# This handles cases like QmlDevToolsPrivate which do not have their own headers, but borrow
|
|
# them from another module.
|
|
if(NOT arg_NO_SYNC_QT AND NOT arg_NO_MODULE_HEADERS)
|
|
# Don't include private headers unless they exist, aka syncqt created them.
|
|
qt_internal_append_include_directories_with_headers_check(${target}
|
|
private_includes PRIVATE
|
|
"$<BUILD_INTERFACE:${module_build_interface_versioned_include_dir}>"
|
|
"$<BUILD_INTERFACE:${module_build_interface_versioned_inner_include_dir}>"
|
|
)
|
|
|
|
list(APPEND public_includes
|
|
# For the syncqt headers
|
|
"$<BUILD_INTERFACE:${repo_build_interface_include_dir}>"
|
|
"$<BUILD_INTERFACE:${module_build_interface_include_dir}>")
|
|
endif()
|
|
|
|
if(is_framework)
|
|
set(fw_install_dir "${INSTALL_LIBDIR}/${fw_dir}")
|
|
set(fw_install_header_dir "${INSTALL_LIBDIR}/${fw_header_dir}")
|
|
set(fw_output_header_dir "${QT_BUILD_DIR}/${fw_install_header_dir}")
|
|
list(APPEND public_includes
|
|
# Add the framework Headers subdir, so that non-framework-style includes work. The
|
|
# BUILD_INTERFACE Headers symlink was previously claimed not to exist at the relevant
|
|
# time, and a fully specified Header path was used instead. This doesn't seem to be a
|
|
# problem anymore.
|
|
"$<BUILD_INTERFACE:${fw_output_header_dir}>"
|
|
"$<INSTALL_INTERFACE:${fw_install_header_dir}>"
|
|
|
|
# Add the lib/Foo.framework dir as an include path to let CMake generate
|
|
# the -F compiler flag for framework-style includes to work.
|
|
# Make sure it is added AFTER the lib/Foo.framework/Headers include path,
|
|
# to mitigate issues like QTBUG-101718 and QTBUG-101775 where an include like
|
|
# #include <QtCore> might cause moc to include the QtCore framework shared library
|
|
# instead of the actual header.
|
|
"$<INSTALL_INTERFACE:${fw_install_dir}>"
|
|
)
|
|
endif()
|
|
|
|
if(NOT arg_NO_MODULE_HEADERS AND NOT arg_NO_SYNC_QT)
|
|
# For the syncqt headers
|
|
list(APPEND ${public_headers_list}
|
|
"$<INSTALL_INTERFACE:${module_install_interface_include_dir}>")
|
|
|
|
# To support finding Qt module includes that are not installed into the main Qt prefix.
|
|
# Use case: A Qt module built by Conan installed into a prefix other than the main prefix.
|
|
# This does duplicate the include path set on Qt6::Platform target, but CMake is smart
|
|
# enough to deduplicate the include paths on the command line.
|
|
# Frameworks are automatically handled by CMake in cmLocalGenerator::GetIncludeFlags()
|
|
# by additionally passing the 'QtFoo.framework/..' dir with an -iframework argument.
|
|
list(APPEND ${public_headers_list} "$<INSTALL_INTERFACE:${INSTALL_INCLUDEDIR}>")
|
|
endif()
|
|
list(APPEND ${public_headers_list} ${arg_PUBLIC_INCLUDE_DIRECTORIES})
|
|
|
|
set(defines_for_extend_target "")
|
|
|
|
if(NOT arg_HEADER_MODULE)
|
|
list(APPEND defines_for_extend_target
|
|
QT_NO_CAST_TO_ASCII QT_ASCII_CAST_WARNINGS
|
|
QT_MOC_COMPAT #we don't need warnings from calling moc code in our generated code
|
|
QT_USE_QSTRINGBUILDER
|
|
QT_DEPRECATED_WARNINGS
|
|
QT_BUILDING_QT
|
|
QT_BUILD_${module_define_infix}_LIB ### FIXME: use QT_BUILD_ADDON for Add-ons or remove if we don't have add-ons anymore
|
|
${deprecation_define}
|
|
)
|
|
list(APPEND arg_LIBRARIES Qt::PlatformModuleInternal)
|
|
endif()
|
|
|
|
qt_internal_add_repo_local_defines("${target}")
|
|
|
|
if(arg_NO_UNITY_BUILD)
|
|
set(arg_NO_UNITY_BUILD NO_UNITY_BUILD)
|
|
else()
|
|
set(arg_NO_UNITY_BUILD "")
|
|
endif()
|
|
|
|
if(NOT arg_EXTERNAL_HEADERS)
|
|
set(arg_EXTERNAL_HEADERS "")
|
|
endif()
|
|
qt_internal_extend_target("${target}"
|
|
SOURCES
|
|
${arg_SOURCES}
|
|
${arg_EXTERNAL_HEADERS}
|
|
INCLUDE_DIRECTORIES
|
|
${private_includes}
|
|
SYSTEM_INCLUDE_DIRECTORIES
|
|
${arg_SYSTEM_INCLUDE_DIRECTORIES}
|
|
PUBLIC_INCLUDE_DIRECTORIES
|
|
${public_includes}
|
|
PUBLIC_DEFINES
|
|
${arg_PUBLIC_DEFINES}
|
|
DEFINES
|
|
${arg_DEFINES}
|
|
${defines_for_extend_target}
|
|
PUBLIC_LIBRARIES ${arg_PUBLIC_LIBRARIES}
|
|
LIBRARIES ${arg_LIBRARIES}
|
|
PRIVATE_MODULE_INTERFACE ${arg_PRIVATE_MODULE_INTERFACE}
|
|
FEATURE_DEPENDENCIES ${arg_FEATURE_DEPENDENCIES}
|
|
DBUS_ADAPTOR_SOURCES ${arg_DBUS_ADAPTOR_SOURCES}
|
|
DBUS_ADAPTOR_FLAGS ${arg_DBUS_ADAPTOR_FLAGS}
|
|
DBUS_INTERFACE_SOURCES ${arg_DBUS_INTERFACE_SOURCES}
|
|
DBUS_INTERFACE_FLAGS ${arg_DBUS_INTERFACE_FLAGS}
|
|
COMPILE_OPTIONS ${arg_COMPILE_OPTIONS}
|
|
PUBLIC_COMPILE_OPTIONS ${arg_PUBLIC_COMPILE_OPTIONS}
|
|
LINK_OPTIONS ${arg_LINK_OPTIONS}
|
|
PUBLIC_LINK_OPTIONS ${arg_PUBLIC_LINK_OPTIONS}
|
|
MOC_OPTIONS ${arg_MOC_OPTIONS}
|
|
ENABLE_AUTOGEN_TOOLS ${arg_ENABLE_AUTOGEN_TOOLS}
|
|
DISABLE_AUTOGEN_TOOLS ${arg_DISABLE_AUTOGEN_TOOLS}
|
|
PRECOMPILED_HEADER ${arg_PRECOMPILED_HEADER}
|
|
NO_PCH_SOURCES ${arg_NO_PCH_SOURCES}
|
|
NO_UNITY_BUILD_SOURCES ${arg_NO_UNITY_BUILD_SOURCES}
|
|
${arg_NO_UNITY_BUILD}
|
|
)
|
|
|
|
# The public module define is not meant to be used when building the module itself,
|
|
# it's only meant to be used for consumers of the module,
|
|
# thus we can't use qt_internal_extend_target()'s PUBLIC_DEFINES option.
|
|
target_compile_definitions(${target} INTERFACE QT_${module_define_infix}_LIB)
|
|
|
|
if(NOT arg_EXCEPTIONS AND NOT ${arg_HEADER_MODULE})
|
|
qt_internal_set_exceptions_flags("${target}" FALSE)
|
|
elseif(arg_EXCEPTIONS)
|
|
qt_internal_set_exceptions_flags("${target}" TRUE)
|
|
endif()
|
|
|
|
set(configureFile "${CMAKE_CURRENT_SOURCE_DIR}/configure.cmake")
|
|
if(arg_CONFIGURE_FILE_PATH)
|
|
set(configureFile "${arg_CONFIGURE_FILE_PATH}")
|
|
endif()
|
|
if(EXISTS "${configureFile}" AND NOT arg_NO_CONFIG_HEADER_FILE)
|
|
qt_feature_module_begin(
|
|
LIBRARY "${target}"
|
|
PUBLIC_FILE "${module_config_header}"
|
|
PRIVATE_FILE "${module_config_private_header}"
|
|
PUBLIC_DEPENDENCIES ${arg_FEATURE_DEPENDENCIES}
|
|
PRIVATE_DEPENDENCIES ${arg_FEATURE_DEPENDENCIES}
|
|
)
|
|
include(${configureFile})
|
|
qt_feature_module_end("${target}")
|
|
|
|
qt_internal_extend_target("${target}"
|
|
SOURCES
|
|
"${CMAKE_CURRENT_BINARY_DIR}/${module_config_header}"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/${module_config_private_header}"
|
|
)
|
|
endif()
|
|
|
|
# Handle creation of cmake files for consumers of find_package().
|
|
set(path_suffix "${INSTALL_CMAKE_NAMESPACE}${target}")
|
|
qt_path_join(config_build_dir ${QT_CONFIG_BUILD_DIR} ${path_suffix})
|
|
qt_path_join(config_install_dir ${QT_CONFIG_INSTALL_DIR} ${path_suffix})
|
|
|
|
set(extra_cmake_files)
|
|
set(extra_cmake_includes)
|
|
if (EXISTS "${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}Macros.cmake")
|
|
list(APPEND extra_cmake_files "${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}Macros.cmake")
|
|
list(APPEND extra_cmake_includes "${INSTALL_CMAKE_NAMESPACE}${target}Macros.cmake")
|
|
endif()
|
|
if (EXISTS "${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigExtras.cmake.in")
|
|
if(target STREQUAL Core)
|
|
set(extra_cmake_code "")
|
|
# Add some variables for compatibility with Qt5 config files.
|
|
if(QT_FEATURE_reduce_exports)
|
|
string(APPEND qtcore_extra_cmake_code "
|
|
set(QT_VISIBILITY_AVAILABLE TRUE)")
|
|
endif()
|
|
if(QT_LIBINFIX)
|
|
string(APPEND qtcore_extra_cmake_code "
|
|
set(QT_LIBINFIX \"${QT_LIBINFIX}\")")
|
|
endif()
|
|
|
|
# Store whether find_package(Qt6Foo) should succeed if Qt6FooTools is missing.
|
|
if(QT_ALLOW_MISSING_TOOLS_PACKAGES)
|
|
string(APPEND qtcore_extra_cmake_code "
|
|
set(QT_ALLOW_MISSING_TOOLS_PACKAGES TRUE)")
|
|
endif()
|
|
endif()
|
|
|
|
configure_file("${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigExtras.cmake.in"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigExtras.cmake"
|
|
@ONLY)
|
|
list(APPEND extra_cmake_files "${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigExtras.cmake")
|
|
list(APPEND extra_cmake_includes "${INSTALL_CMAKE_NAMESPACE}${target}ConfigExtras.cmake")
|
|
endif()
|
|
|
|
foreach(cmake_file IN LISTS arg_EXTRA_CMAKE_FILES)
|
|
get_filename_component(basename ${cmake_file} NAME)
|
|
file(COPY ${cmake_file} DESTINATION ${config_build_dir})
|
|
list(APPEND extra_cmake_files "${config_build_dir}/${basename}")
|
|
endforeach()
|
|
list(APPEND extra_cmake_includes ${arg_EXTRA_CMAKE_INCLUDES})
|
|
|
|
set(extra_cmake_code "")
|
|
|
|
if(arg_POLICIES)
|
|
set(policies "")
|
|
foreach(policy IN LISTS arg_POLICIES)
|
|
list(APPEND policies "set(QT_KNOWN_POLICY_${policy} TRUE)")
|
|
|
|
# When building Qt, tests and examples might expect a policy to be known, but they
|
|
# won't be known depending on which scope or when a find_package(Module) with the
|
|
# respective policy is called. Check the global list of known policies to accommodate
|
|
# that.
|
|
set_property(GLOBAL APPEND PROPERTY _qt_global_known_policies "${policy}")
|
|
endforeach()
|
|
list(JOIN policies "\n" policies_str)
|
|
string(APPEND extra_cmake_code "${policies_str}\n")
|
|
endif()
|
|
|
|
# Generate metatypes
|
|
if (NOT ${arg_NO_GENERATE_METATYPES} AND NOT target_type STREQUAL "INTERFACE_LIBRARY")
|
|
set(args "")
|
|
if(QT_WILL_INSTALL)
|
|
set(metatypes_install_dir "${INSTALL_ARCHDATADIR}/metatypes")
|
|
list(APPEND args
|
|
__QT_INTERNAL_INSTALL __QT_INTERNAL_INSTALL_DIR "${metatypes_install_dir}")
|
|
endif()
|
|
qt6_extract_metatypes(${target} ${args})
|
|
endif()
|
|
|
|
qt_internal_get_min_new_policy_cmake_version(min_new_policy_version)
|
|
qt_internal_get_max_new_policy_cmake_version(max_new_policy_version)
|
|
configure_package_config_file(
|
|
"${QT_CMAKE_DIR}/QtModuleConfig.cmake.in"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}Config.cmake"
|
|
INSTALL_DESTINATION "${config_install_dir}"
|
|
)
|
|
|
|
if (EXISTS "${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}BuildInternals.cmake")
|
|
configure_file("${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}${target}BuildInternals.cmake"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}BuildInternals.cmake"
|
|
@ONLY)
|
|
list(APPEND extra_cmake_files "${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}BuildInternals.cmake")
|
|
endif()
|
|
|
|
write_basic_package_version_file(
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigVersionImpl.cmake"
|
|
VERSION ${PROJECT_VERSION}
|
|
COMPATIBILITY AnyNewerVersion
|
|
)
|
|
qt_internal_write_qt_package_version_file(
|
|
"${INSTALL_CMAKE_NAMESPACE}${target}"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigVersion.cmake"
|
|
)
|
|
qt_install(FILES
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}Config.cmake"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigVersion.cmake"
|
|
"${config_build_dir}/${INSTALL_CMAKE_NAMESPACE}${target}ConfigVersionImpl.cmake"
|
|
${extra_cmake_files}
|
|
DESTINATION "${config_install_dir}"
|
|
COMPONENT Devel
|
|
)
|
|
|
|
file(COPY ${extra_cmake_files} DESTINATION "${config_build_dir}")
|
|
set(exported_targets ${target})
|
|
if(NOT ${arg_NO_PRIVATE_MODULE})
|
|
list(APPEND exported_targets ${target_private})
|
|
endif()
|
|
set(export_name "${INSTALL_CMAKE_NAMESPACE}${target}Targets")
|
|
|
|
qt_install(TARGETS ${exported_targets}
|
|
EXPORT ${export_name}
|
|
RUNTIME DESTINATION ${INSTALL_BINDIR}
|
|
LIBRARY DESTINATION ${INSTALL_LIBDIR}
|
|
ARCHIVE DESTINATION ${INSTALL_LIBDIR}
|
|
FRAMEWORK DESTINATION ${INSTALL_LIBDIR}
|
|
)
|
|
|
|
if(BUILD_SHARED_LIBS)
|
|
qt_apply_rpaths(TARGET "${target}" INSTALL_PATH "${INSTALL_LIBDIR}" RELATIVE_RPATH)
|
|
qt_internal_apply_staging_prefix_build_rpath_workaround()
|
|
endif()
|
|
|
|
if (ANDROID AND NOT arg_HEADER_MODULE)
|
|
# Record install library location so it can be accessed by
|
|
# qt_internal_android_dependencies without having to specify it again.
|
|
set_target_properties(${target} PROPERTIES
|
|
QT_ANDROID_MODULE_INSTALL_DIR ${INSTALL_LIBDIR})
|
|
endif()
|
|
|
|
qt_install(EXPORT ${export_name}
|
|
NAMESPACE ${QT_CMAKE_EXPORT_NAMESPACE}::
|
|
DESTINATION ${config_install_dir})
|
|
|
|
if(NOT arg_NO_ADDITIONAL_TARGET_INFO)
|
|
qt_internal_export_additional_targets_file(
|
|
TARGETS ${exported_targets}
|
|
EXPORT_NAME_PREFIX ${INSTALL_CMAKE_NAMESPACE}${target}
|
|
CONFIG_INSTALL_DIR "${config_install_dir}")
|
|
endif()
|
|
|
|
qt_internal_export_modern_cmake_config_targets_file(
|
|
TARGETS ${exported_targets}
|
|
EXPORT_NAME_PREFIX ${INSTALL_CMAKE_NAMESPACE}${target}
|
|
CONFIG_INSTALL_DIR "${config_install_dir}")
|
|
|
|
qt_internal_export_genex_properties(TARGETS ${target}
|
|
EXPORT_NAME_PREFIX ${INSTALL_CMAKE_NAMESPACE}${target}
|
|
CONFIG_INSTALL_DIR "${config_install_dir}"
|
|
)
|
|
|
|
### fixme: cmake is missing a built-in variable for this. We want to apply it only to modules and plugins
|
|
# that belong to Qt.
|
|
if(NOT arg_HEADER_MODULE)
|
|
qt_internal_add_link_flags_no_undefined("${target}")
|
|
endif()
|
|
|
|
set(interface_includes "")
|
|
|
|
# Handle cases like QmlDevToolsPrivate which do not have their own headers, but rather borrow them
|
|
# from another module.
|
|
if(NOT arg_NO_SYNC_QT AND NOT arg_NO_MODULE_HEADERS)
|
|
list(APPEND interface_includes "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>")
|
|
|
|
# syncqt.pl does not create a private header directory like 'include/6.0/QtFoo' unless
|
|
# the module has foo_p.h header files. For QtZlib, there are no such private headers, so we
|
|
# need to make sure not to add such include paths unless the directory exists, otherwise
|
|
# consumers of the module will fail at CMake generation time stating that
|
|
# INTERFACE_INCLUDE_DIRECTORIES contains a non-existent path.
|
|
qt_internal_append_include_directories_with_headers_check(${target}
|
|
interface_includes PRIVATE
|
|
"$<BUILD_INTERFACE:${module_build_interface_versioned_include_dir}>"
|
|
"$<BUILD_INTERFACE:${module_build_interface_versioned_inner_include_dir}>"
|
|
)
|
|
|
|
if(is_framework)
|
|
set(fw_install_private_header_dir "${INSTALL_LIBDIR}/${fw_private_header_dir}")
|
|
set(fw_install_private_module_header_dir
|
|
"${INSTALL_LIBDIR}/${fw_private_module_header_dir}")
|
|
qt_internal_append_include_directories_with_headers_check(${target}
|
|
interface_includes PRIVATE
|
|
"$<INSTALL_INTERFACE:${fw_install_private_header_dir}>"
|
|
"$<INSTALL_INTERFACE:${fw_install_private_module_header_dir}>"
|
|
)
|
|
else()
|
|
qt_internal_append_include_directories_with_headers_check(${target}
|
|
interface_includes PRIVATE
|
|
"$<INSTALL_INTERFACE:${module_install_interface_versioned_include_dir}>"
|
|
"$<INSTALL_INTERFACE:${module_install_interface_versioned_inner_include_dir}>"
|
|
)
|
|
endif()
|
|
endif()
|
|
|
|
if(arg_INTERNAL_MODULE)
|
|
target_include_directories("${target}" INTERFACE ${interface_includes})
|
|
elseif(NOT ${arg_NO_PRIVATE_MODULE})
|
|
target_include_directories("${target_private}" INTERFACE ${interface_includes})
|
|
target_link_libraries("${target_private}" INTERFACE "${target}")
|
|
endif()
|
|
|
|
set(debug_install_dir "${INSTALL_LIBDIR}")
|
|
if (MINGW)
|
|
set(debug_install_dir "${INSTALL_BINDIR}")
|
|
endif()
|
|
qt_enable_separate_debug_info(${target} "${debug_install_dir}")
|
|
set(pdb_install_dir "${INSTALL_BINDIR}")
|
|
if(NOT is_shared_lib)
|
|
set(pdb_install_dir "${INSTALL_LIBDIR}")
|
|
endif()
|
|
qt_internal_install_pdb_files(${target} "${pdb_install_dir}")
|
|
|
|
if (arg_NO_PRIVATE_MODULE)
|
|
set(arg_NO_PRIVATE_MODULE "NO_PRIVATE_MODULE")
|
|
else()
|
|
unset(arg_NO_PRIVATE_MODULE)
|
|
endif()
|
|
|
|
qt_describe_module(${target})
|
|
qt_add_list_file_finalizer(qt_finalize_module ${target} ${arg_INTERNAL_MODULE} ${arg_NO_PRIVATE_MODULE})
|
|
endfunction()
|
|
|
|
function(qt_finalize_module target)
|
|
qt_internal_collect_module_headers(module_headers ${target})
|
|
|
|
# qt_internal_install_module_headers needs to be called before
|
|
# qt_finalize_framework_headers_copy, because the last uses the QT_COPIED_FRAMEWORK_HEADERS
|
|
# property which supposed to be updated inside every qt_internal_install_module_headers
|
|
# call.
|
|
qt_internal_add_headersclean_target(${target} "${module_headers_public}")
|
|
qt_internal_target_sync_headers(${target} "${module_headers_all}"
|
|
"${module_headers_generated}")
|
|
get_target_property(module_depends_header ${target} _qt_module_depends_header)
|
|
qt_internal_install_module_headers(${target}
|
|
PUBLIC ${module_headers_public} "${module_depends_header}"
|
|
PRIVATE ${module_headers_private}
|
|
QPA ${module_headers_qpa}
|
|
)
|
|
|
|
qt_finalize_framework_headers_copy(${target})
|
|
qt_generate_prl_file(${target} "${INSTALL_LIBDIR}")
|
|
qt_generate_module_pri_file("${target}" ${ARGN})
|
|
qt_internal_generate_pkg_config_file(${target})
|
|
endfunction()
|
|
|
|
# Get a set of Qt module related values based on the target.
|
|
#
|
|
# The function uses the _qt_module_interface_name and _qt_module_include_name target properties to
|
|
# preform values for the output variables. _qt_module_interface_name it's the basic name of module
|
|
# without "Qtfication" and the "Private" suffix if we speak about INTERNAL_MODULEs. Typical value of
|
|
# the _qt_module_interface_name is the provided to qt_internal_add_module ${target} name, e.g. Core.
|
|
# _qt_module_interface_name is used to preform all the include paths unless the
|
|
# _qt_module_include_name property is specified. _qt_module_include_name is legacy property that
|
|
# replaces the module name in include paths and has a higher priority than the
|
|
# _qt_module_interface_name property.
|
|
#
|
|
# When doing qt_internal_module_info(foo Core) this method will set the following variables in
|
|
# the caller's scope:
|
|
# * foo with the value "QtCore"
|
|
# * foo_versioned with the value "Qt6Core" (based on major Qt version)
|
|
# * foo_upper with the value "CORE"
|
|
# * foo_lower with the value "core"
|
|
# * foo_include_name with the value"QtCore"
|
|
# Usually the module name from ${foo} is used, but the name might be different if the
|
|
# MODULE_INCLUDE_NAME argument is set when creating the module.
|
|
# * foo_versioned_include_dir with the value "QtCore/6.2.0"
|
|
# * foo_versioned_inner_include_dir with the value "QtCore/6.2.0/QtCore"
|
|
# * foo_private_include_dir with the value "QtCore/6.2.0/QtCore/private"
|
|
# * foo_qpa_include_dir with the value "QtCore/6.2.0/QtCore/qpa"
|
|
# * foo_interface_name the interface name of the module stored in _qt_module_interface_name
|
|
# property, e.g. Core.
|
|
#
|
|
# The function also sets a bunch of module include paths for the build and install interface.
|
|
# Variables that contains these paths start with foo_build_interface_ and foo_install_interface_
|
|
# accordingly.
|
|
# The following variables are set in the caller's scope:
|
|
# * foo_<build|install>_interface_include_dir with
|
|
# qtbase_build_dir/include/QtCore for build interface and
|
|
# include/QtCore for install interface.
|
|
# * foo_<build|install>_interface_versioned_include_dir with
|
|
# qtbase_build_dir/include/QtCore/6.2.0 for build interface and
|
|
# include/QtCore/6.2.0 for install interface.
|
|
# * foo_<build|install>_versioned_inner_include_dir with
|
|
# qtbase_build_dir/include/QtCore/6.2.0/QtCore for build interface and
|
|
# include/QtCore/6.2.0/QtCore for install interface.
|
|
# * foo_<build|install>_private_include_dir with
|
|
# qtbase_build_dir/include/QtCore/6.2.0/QtCore/private for build interface and
|
|
# include/QtCore/6.2.0/QtCore/private for install interface.
|
|
# * foo_<build|install>_qpa_include_dir with
|
|
# qtbase_build_dir/include/QtCore/6.2.0/QtCore/qpa for build interface and
|
|
# include/QtCore/6.2.0/QtCore/qpa for install interface.
|
|
# The following values are set by the function and might be useful in caller's scope:
|
|
# * repo_install_interface_include_dir contains path to the top-level repository include directory,
|
|
# e.g. qtbase_build_dir/include
|
|
# * repo_install_interface_include_dir contains path to the non-prefixed top-level include
|
|
# directory is used for the installation, e.g. include
|
|
# Note: that for non-prefixed Qt configurations the build interface paths will start with
|
|
# <build_directory>/qtbase/include, e.g foo_build_interface_include_dir of the Qml module looks
|
|
# like qt_toplevel_build_dir/qtbase/include/QtQml
|
|
function(qt_internal_module_info result target)
|
|
if(result STREQUAL "repo")
|
|
message(FATAL_ERROR "'repo' keyword is reserved for internal use, please specify \
|
|
the different base name for the module info variables.")
|
|
endif()
|
|
|
|
get_target_property(module_interface_name ${target} _qt_module_interface_name)
|
|
if(NOT module_interface_name)
|
|
message(FATAL_ERROR "${target} is not a module.")
|
|
endif()
|
|
|
|
qt_internal_qtfy_target(module ${module_interface_name})
|
|
|
|
get_target_property("${result}_include_name" ${target} _qt_module_include_name)
|
|
if(NOT ${result}_include_name)
|
|
set("${result}_include_name" "${module}")
|
|
endif()
|
|
|
|
set("${result}_versioned_include_dir"
|
|
"${${result}_include_name}/${PROJECT_VERSION}")
|
|
set("${result}_versioned_inner_include_dir"
|
|
"${${result}_versioned_include_dir}/${${result}_include_name}")
|
|
set("${result}_private_include_dir"
|
|
"${${result}_versioned_inner_include_dir}/private")
|
|
set("${result}_qpa_include_dir"
|
|
"${${result}_versioned_inner_include_dir}/qpa")
|
|
|
|
# Module build interface directories
|
|
set(repo_build_interface_include_dir "${QT_BUILD_DIR}/include")
|
|
set("${result}_build_interface_include_dir"
|
|
"${repo_build_interface_include_dir}/${${result}_include_name}")
|
|
set("${result}_build_interface_versioned_include_dir"
|
|
"${repo_build_interface_include_dir}/${${result}_versioned_include_dir}")
|
|
set("${result}_build_interface_versioned_inner_include_dir"
|
|
"${repo_build_interface_include_dir}/${${result}_versioned_inner_include_dir}")
|
|
set("${result}_build_interface_private_include_dir"
|
|
"${repo_build_interface_include_dir}/${${result}_private_include_dir}")
|
|
set("${result}_build_interface_qpa_include_dir"
|
|
"${repo_build_interface_include_dir}/${${result}_qpa_include_dir}")
|
|
|
|
# Module install interface directories
|
|
set(repo_install_interface_include_dir "${INSTALL_INCLUDEDIR}")
|
|
set("${result}_install_interface_include_dir"
|
|
"${repo_install_interface_include_dir}/${${result}_include_name}")
|
|
set("${result}_install_interface_versioned_include_dir"
|
|
"${repo_install_interface_include_dir}/${${result}_versioned_include_dir}")
|
|
set("${result}_install_interface_versioned_inner_include_dir"
|
|
"${repo_install_interface_include_dir}/${${result}_versioned_inner_include_dir}")
|
|
set("${result}_install_interface_private_include_dir"
|
|
"${repo_install_interface_include_dir}/${${result}_private_include_dir}")
|
|
set("${result}_install_interface_qpa_include_dir"
|
|
"${repo_install_interface_include_dir}/${${result}_qpa_include_dir}")
|
|
|
|
set("${result}" "${module}" PARENT_SCOPE)
|
|
set("${result}_versioned" "${module_versioned}" PARENT_SCOPE)
|
|
string(TOUPPER "${module_interface_name}" upper)
|
|
string(TOLOWER "${module_interface_name}" lower)
|
|
set("${result}_upper" "${upper}" PARENT_SCOPE)
|
|
set("${result}_lower" "${lower}" PARENT_SCOPE)
|
|
set("${result}_include_name" "${${result}_include_name}" PARENT_SCOPE)
|
|
set("${result}_versioned_include_dir" "${${result}_versioned_include_dir}" PARENT_SCOPE)
|
|
set("${result}_versioned_inner_include_dir"
|
|
"${${result}_versioned_inner_include_dir}" PARENT_SCOPE)
|
|
set("${result}_private_include_dir" "${${result}_private_include_dir}" PARENT_SCOPE)
|
|
set("${result}_qpa_include_dir" "${${result}_qpa_include_dir}" PARENT_SCOPE)
|
|
set("${result}_interface_name" "${module_interface_name}" PARENT_SCOPE)
|
|
|
|
# Setting module build interface directories in parent scope
|
|
set(repo_build_interface_include_dir "${repo_build_interface_include_dir}" PARENT_SCOPE)
|
|
set("${result}_build_interface_include_dir"
|
|
"${${result}_build_interface_include_dir}" PARENT_SCOPE)
|
|
set("${result}_build_interface_versioned_include_dir"
|
|
"${${result}_build_interface_versioned_include_dir}" PARENT_SCOPE)
|
|
set("${result}_build_interface_versioned_inner_include_dir"
|
|
"${${result}_build_interface_versioned_inner_include_dir}" PARENT_SCOPE)
|
|
set("${result}_build_interface_private_include_dir"
|
|
"${${result}_build_interface_private_include_dir}" PARENT_SCOPE)
|
|
set("${result}_build_interface_qpa_include_dir"
|
|
"${${result}_build_interface_qpa_include_dir}" PARENT_SCOPE)
|
|
|
|
# Setting module install interface directories in parent scope
|
|
set(repo_install_interface_include_dir "${repo_install_interface_include_dir}" PARENT_SCOPE)
|
|
set("${result}_install_interface_include_dir"
|
|
"${${result}_install_interface_include_dir}" PARENT_SCOPE)
|
|
set("${result}_install_interface_versioned_include_dir"
|
|
"${${result}_install_interface_versioned_include_dir}" PARENT_SCOPE)
|
|
set("${result}_install_interface_versioned_inner_include_dir"
|
|
"${${result}_install_interface_versioned_inner_include_dir}" PARENT_SCOPE)
|
|
set("${result}_install_interface_private_include_dir"
|
|
"${${result}_install_interface_private_include_dir}" PARENT_SCOPE)
|
|
set("${result}_install_interface_qpa_include_dir"
|
|
"${${result}_install_interface_qpa_include_dir}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
function(qt_internal_list_to_json_array out_var list_var)
|
|
set(result "")
|
|
foreach(item IN LISTS ${list_var})
|
|
if(NOT "${result}" STREQUAL "")
|
|
string(APPEND result ", ")
|
|
endif()
|
|
string(APPEND result "\"${item}\"")
|
|
endforeach()
|
|
set("${out_var}" "[${result}]" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
# Generate a module description file based on the template in ModuleDescription.json.in
|
|
function(qt_describe_module target)
|
|
set(path_suffix "${INSTALL_DESCRIPTIONSDIR}")
|
|
qt_path_join(build_dir ${QT_BUILD_DIR} ${path_suffix})
|
|
qt_path_join(install_dir ${QT_INSTALL_DIR} ${path_suffix})
|
|
|
|
set(descfile_in "${QT_CMAKE_DIR}/ModuleDescription.json.in")
|
|
set(descfile_out "${build_dir}/${target}.json")
|
|
string(TOLOWER "${PROJECT_NAME}" lower_case_project_name)
|
|
set(cross_compilation "false")
|
|
if(CMAKE_CROSSCOMPILING)
|
|
set(cross_compilation "true")
|
|
endif()
|
|
set(extra_module_information "")
|
|
|
|
get_target_property(target_type ${target} TYPE)
|
|
if(NOT target_type STREQUAL "INTERFACE_LIBRARY")
|
|
get_target_property(plugin_types ${target} MODULE_PLUGIN_TYPES)
|
|
if(plugin_types)
|
|
qt_internal_list_to_json_array(plugin_types plugin_types)
|
|
string(APPEND extra_module_information "\n \"plugin_types\": ${plugin_types},")
|
|
endif()
|
|
endif()
|
|
|
|
get_target_property(is_internal ${target} _qt_is_internal_module)
|
|
if(is_internal)
|
|
string(APPEND extra_module_information "\n \"internal\": true,")
|
|
endif()
|
|
|
|
set(extra_build_information "")
|
|
if(ANDROID)
|
|
string(APPEND extra_build_information "
|
|
\"android\": {
|
|
\"api_version\": \"${QT_ANDROID_API_VERSION}\",
|
|
\"ndk\": {
|
|
\"version\": \"${ANDROID_NDK_REVISION}\"
|
|
}
|
|
},")
|
|
endif()
|
|
configure_file("${descfile_in}" "${descfile_out}")
|
|
|
|
qt_install(FILES "${descfile_out}" DESTINATION "${install_dir}")
|
|
endfunction()
|
|
|
|
function(qt_internal_generate_cpp_global_exports target module_define_infix)
|
|
cmake_parse_arguments(arg
|
|
"GENERATE_PRIVATE_CPP_EXPORTS"
|
|
"CPP_EXPORT_HEADER_BASE_NAME"
|
|
"" ${ARGN}
|
|
)
|
|
|
|
qt_internal_module_info(module "${target}")
|
|
|
|
set(header_base_name "qt${module_lower}exports")
|
|
if(arg_CPP_EXPORT_HEADER_BASE_NAME)
|
|
set(header_base_name "${arg_CPP_EXPORT_HEADER_BASE_NAME}")
|
|
endif()
|
|
# Is used as a part of the header guard define.
|
|
string(TOUPPER "${header_base_name}" header_base_name_upper)
|
|
|
|
set(generated_header_path
|
|
"${module_build_interface_include_dir}/${header_base_name}.h"
|
|
)
|
|
|
|
configure_file("${QT_CMAKE_DIR}/modulecppexports.h.in"
|
|
"${generated_header_path}" @ONLY
|
|
)
|
|
|
|
set(${out_public_header} "${generated_header_path}" PARENT_SCOPE)
|
|
target_sources(${target} PRIVATE "${generated_header_path}")
|
|
set_source_files_properties("${generated_header_path}" PROPERTIES GENERATED TRUE)
|
|
|
|
if(arg_GENERATE_PRIVATE_CPP_EXPORTS)
|
|
set(generated_private_header_path
|
|
"${module_build_interface_private_include_dir}/${header_base_name}_p.h"
|
|
)
|
|
|
|
configure_file("${QT_CMAKE_DIR}/modulecppexports_p.h.in"
|
|
"${generated_private_header_path}" @ONLY
|
|
)
|
|
|
|
set(${out_private_header} "${generated_private_header_path}" PARENT_SCOPE)
|
|
target_sources(${target} PRIVATE "${generated_private_header_path}")
|
|
set_source_files_properties("${generated_private_header_path}" PROPERTIES GENERATED TRUE)
|
|
endif()
|
|
endfunction()
|
|
|
|
function(qt_internal_install_module_headers target)
|
|
set(options)
|
|
set(one_value_args)
|
|
set(multi_value_args PUBLIC PRIVATE QPA)
|
|
cmake_parse_arguments(arg "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
|
|
|
|
qt_internal_module_info(module ${target})
|
|
|
|
get_target_property(target_type ${target} TYPE)
|
|
set(is_interface_lib FALSE)
|
|
if(target_type STREQUAL "INTERFACE_LIBRARY")
|
|
set(is_interface_lib TRUE)
|
|
else()
|
|
get_target_property(is_framework ${target} FRAMEWORK)
|
|
endif()
|
|
|
|
|
|
foreach(header_type IN LISTS multi_value_args)
|
|
if(NOT arg_${header_type})
|
|
set(arg_${header_type} "")
|
|
endif()
|
|
endforeach()
|
|
|
|
if(is_framework)
|
|
qt_copy_framework_headers(${target}
|
|
PUBLIC ${arg_PUBLIC}
|
|
PRIVATE ${arg_PRIVATE}
|
|
QPA ${arg_QPA}
|
|
)
|
|
else()
|
|
if(arg_PUBLIC)
|
|
qt_install(FILES ${arg_PUBLIC}
|
|
DESTINATION "${module_install_interface_include_dir}")
|
|
endif()
|
|
if(arg_PRIVATE)
|
|
qt_install(FILES ${arg_PRIVATE}
|
|
DESTINATION "${module_install_interface_private_include_dir}")
|
|
endif()
|
|
if(arg_QPA)
|
|
qt_install(FILES ${arg_QPA} DESTINATION "${module_install_interface_qpa_include_dir}")
|
|
endif()
|
|
endif()
|
|
endfunction()
|
|
|
|
function(qt_internal_collect_module_headers out_var target)
|
|
set(${out_var}_public "")
|
|
set(${out_var}_private "")
|
|
set(${out_var}_qpa "")
|
|
set(${out_var}_all "")
|
|
|
|
qt_internal_get_target_sources(sources ${target})
|
|
|
|
get_target_property(public_filter ${target} _qt_module_public_headers_filter_regex)
|
|
get_target_property(private_filter ${target} _qt_module_private_headers_filter_regex)
|
|
get_target_property(qpa_filter ${target} _qt_module_qpa_headers_filter_regex)
|
|
|
|
set(condition_independent_headers_warning "")
|
|
foreach(file_path IN LISTS sources)
|
|
get_filename_component(file_name "${file_path}" NAME)
|
|
if(NOT file_name MATCHES ".+\\.h$")
|
|
continue()
|
|
endif()
|
|
get_source_file_property(condition ${file_path} _qt_extend_target_condition)
|
|
if(NOT condition STREQUAL "" AND NOT condition STREQUAL "NOTFOUND")
|
|
list(JOIN condition " " condition_string)
|
|
string(APPEND condition_independent_headers_warning
|
|
"\nFile:\n ${file_path}"
|
|
"\nCondition:\n ${condition_string}")
|
|
endif()
|
|
|
|
get_source_file_property(is_generated "${file_path}" GENERATED)
|
|
get_filename_component(file_path "${file_path}" ABSOLUTE)
|
|
get_filename_component(file_path "${file_path}" REALPATH)
|
|
list(APPEND ${out_var}_all "${file_path}")
|
|
if(qpa_filter AND file_name MATCHES "${qpa_filter}")
|
|
list(APPEND ${out_var}_qpa "${file_path}")
|
|
elseif(private_filter AND file_name MATCHES "${private_filter}")
|
|
list(APPEND ${out_var}_private "${file_path}")
|
|
elseif(NOT public_filter OR file_name MATCHES "${public_filter}")
|
|
list(APPEND ${out_var}_public "${file_path}")
|
|
endif()
|
|
if(is_generated)
|
|
list(APPEND ${out_var}_generated "${file_path}")
|
|
endif()
|
|
endforeach()
|
|
|
|
if(NOT condition_independent_headers_warning STREQUAL "" AND QT_FEATURE_developer_build)
|
|
message(AUTHOR_WARNING "Condition is ignored when adding the following header file(s) to"
|
|
" the ${target} module:"
|
|
"${condition_independent_headers_warning}"
|
|
"\nThe usage of the file(s) is not properly isolated in this or other modules according"
|
|
" to the condition. This warning is for the Qt maintainers. Please make sure that file"
|
|
" include(s) are guarded with the appropriate macros in the Qt code. If files should be"
|
|
" added to the module unconditionally, please move them to the common SOURCES section"
|
|
" in the qt_internal_add_module call.")
|
|
endif()
|
|
|
|
|
|
set(header_types public private qpa)
|
|
set(has_header_types_properties "")
|
|
foreach(header_type IN LISTS header_types)
|
|
get_target_property(current_propety_value ${target} _qt_module_has_${header_type}_headers)
|
|
if(${out_var}_${header_type})
|
|
list(APPEND has_header_types_properties
|
|
_qt_module_has_${header_type}_headers TRUE)
|
|
endif()
|
|
|
|
set(${out_var}_${header_type} "${${out_var}_${header_type}}" PARENT_SCOPE)
|
|
endforeach()
|
|
set(${out_var}_all "${${out_var}_all}" PARENT_SCOPE)
|
|
set(${out_var}_generated "${${out_var}_generated}" PARENT_SCOPE)
|
|
|
|
if(has_header_types_properties)
|
|
set_target_properties(${target} PROPERTIES ${has_header_types_properties})
|
|
endif()
|
|
set_property(TARGET ${target} APPEND PROPERTY
|
|
EXPORT_PROPERTIES
|
|
_qt_module_has_public_headers
|
|
_qt_module_has_private_headers
|
|
_qt_module_has_qpa_headers
|
|
)
|
|
endfunction()
|