be7e20213c
In static per-repo builds, we have a mix of targets provided by packages and targets provided by the main build. For the builds that create the packages, we must avoid adding a dependency for the main module library target on its associated plugin targets or else the package config files end up with a cyclic dependency that cannot be resolved when something tries to consume them. This only happens for static builds because we have been attaching a linking relationship to the main module library that isn't really a true dependency, we attached it only for convenience of things linking to that module library. To preserve that convenience linking without breaking the config packages, we use the QT_NO_CREATE_TARGETS condition to prevent CMake seeing that relationship when generating the *Config.cmake files. Creating these relationships will be delayed until the plugin's *Config.cmake file is loaded, at which point it will add itself to the main module library's imported target INTERFACE (this was already done before, we just now rely solely on that). Task-number: QTBUG-90819 Pick-to: 6.1 Change-Id: Id725742182bcda64841be84fe1650bafb9151bb1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
162 lines
7.1 KiB
CMake
162 lines
7.1 KiB
CMake
include_guard(DIRECTORY)
|
|
@QT_MODULE_PLUGIN_INCLUDES@
|
|
|
|
# Use a function to hide all the temporary variables we use so they don't leak
|
|
# out into the consuming scope
|
|
function(__qt_internal_add_static_plugins_once)
|
|
set(_module_target "@INSTALL_CMAKE_NAMESPACE@::@QT_MODULE@")
|
|
set(_qt_plugins "")
|
|
|
|
# Properties can't be set on aliased targets, so make sure to unalias the target. This is needed
|
|
# when Qt examples are built as part of the Qt build itself.
|
|
get_target_property(_aliased_target ${_module_target} ALIASED_TARGET)
|
|
if(_aliased_target)
|
|
set(_module_target ${_aliased_target})
|
|
endif()
|
|
|
|
# Include all PluginConfig.cmake files and update the QT_PLUGINS property of the module.
|
|
file(GLOB _qt_plugin_config_files "${CMAKE_CURRENT_LIST_DIR}/@INSTALL_CMAKE_NAMESPACE@*PluginConfig.cmake")
|
|
foreach(_config_file ${_qt_plugin_config_files})
|
|
string(REGEX REPLACE "^.*/@INSTALL_CMAKE_NAMESPACE@(.*Plugin)Config.cmake$" "\\1" _qt_plugin "${_config_file}")
|
|
include("${_config_file}")
|
|
list(APPEND _qt_plugins ${_qt_plugin})
|
|
endforeach()
|
|
set_property(TARGET ${_module_target} PROPERTY QT_PLUGINS ${_qt_plugins})
|
|
|
|
get_target_property(_have_added_plugins_already ${_module_target} __qt_internal_plugins_added)
|
|
if(_have_added_plugins_already)
|
|
return()
|
|
endif()
|
|
|
|
set(_default_plugins_are_enabled "$<NOT:$<STREQUAL:$<GENEX_EVAL:$<TARGET_PROPERTY:QT_DEFAULT_PLUGINS>>,0>>")
|
|
# Make sure to boolify the result of the expression, in case if the returned property value
|
|
# is empty.
|
|
set(_default_plugins_are_enabled_wrapped "$<BOOL:${_default_plugins_are_enabled}>")
|
|
set(_manual_plugins_genex "$<GENEX_EVAL:$<TARGET_PROPERTY:QT_PLUGINS>>")
|
|
set(_no_plugins_genex "$<GENEX_EVAL:$<TARGET_PROPERTY:QT_NO_PLUGINS>>")
|
|
|
|
# Plugin genex marker for prl processing.
|
|
set(_is_plugin_marker_genex "$<BOOL:QT_IS_PLUGIN_GENEX>")
|
|
|
|
# In super builds the rules below pollute the dependency rule for the
|
|
# plugin target when it's being build, causing cyclic dependencies.
|
|
# to overcome this, we check if the current target where this rule evaluates
|
|
# has a QT_BUILD_PROJECT_NAME equal to the current PROJECT_NAME.
|
|
# If so we disable the injection of plugin link rules to avoid cyclic
|
|
# dependencies.
|
|
if (@QT_SUPERBUILD@)
|
|
set(_build_allow_plugin_link_rules_genex "$<NOT:$<STREQUAL:$<TARGET_PROPERTY:QT_BUILD_PROJECT_NAME>,@PROJECT_NAME@>>")
|
|
else()
|
|
set(_build_allow_plugin_link_rules_genex 1)
|
|
endif()
|
|
|
|
# The code in here uses the properties defined in qt_import_plugins (Qt6CoreMacros.cmake)
|
|
foreach(target ${_qt_plugins})
|
|
set(_plugin_target "@INSTALL_CMAKE_NAMESPACE@::${target}")
|
|
set(_plugin_target_versionless "Qt::${target}")
|
|
get_target_property(_classname "${_plugin_target}" QT_PLUGIN_CLASS_NAME)
|
|
if(NOT _classname)
|
|
message("Warning: plugin ${_plugin_target} has no class name, skipping.")
|
|
continue()
|
|
endif()
|
|
|
|
get_target_property(_plugin_type "${_plugin_target}" QT_PLUGIN_TYPE)
|
|
if(NOT _plugin_type)
|
|
message("Warning: plugin ${_plugin_target} has no type ('${_plugin_type}'), skipping.")
|
|
continue()
|
|
endif()
|
|
|
|
list(APPEND "QT_ALL_PLUGINS_FOUND_BY_FIND_PACKAGE_${_plugin_type}" "${target}")
|
|
set("QT_ALL_PLUGINS_FOUND_BY_FIND_PACKAGE_${_plugin_type}"
|
|
"${QT_ALL_PLUGINS_FOUND_BY_FIND_PACKAGE_${_plugin_type}}"
|
|
PARENT_SCOPE
|
|
)
|
|
|
|
set(_plugin_is_default "$<TARGET_PROPERTY:${_plugin_target},QT_DEFAULT_PLUGIN>")
|
|
|
|
# INCLUDE
|
|
set(_plugin_is_whitelisted "$<IN_LIST:${_plugin_target},${_manual_plugins_genex}>")
|
|
set(_plugin_versionless_is_whitelisted
|
|
"$<IN_LIST:${_plugin_target_versionless},${_manual_plugins_genex}>")
|
|
|
|
# Note: qt_import_plugins sets the QT_PLUGINS_${_plugin_type} to "-"
|
|
# when excluding it with EXCLUDE_BY_TYPE,
|
|
# which ensures that no plug-in will be supported unless explicitly re-added afterwards.
|
|
string(CONCAT _plugin_is_not_blacklisted
|
|
"$<AND:"
|
|
"$<NOT:" # EXCLUDE
|
|
"$<IN_LIST:${_plugin_target},${_no_plugins_genex}>"
|
|
">,"
|
|
"$<NOT:"
|
|
"$<IN_LIST:${_plugin_target_versionless},${_no_plugins_genex}>"
|
|
">,"
|
|
# Excludes both plugins targeted by EXCLUDE_BY_TYPE and not included in
|
|
# INCLUDE_BY_TYPE.
|
|
"$<STREQUAL:,$<GENEX_EVAL:$<TARGET_PROPERTY:QT_PLUGINS_${_plugin_type}>>>"
|
|
">"
|
|
)
|
|
|
|
# Support INCLUDE_BY_TYPE
|
|
string(CONCAT _plugin_is_in_type_whitelist
|
|
"$<IN_LIST:"
|
|
"${_plugin_target},"
|
|
"$<GENEX_EVAL:"
|
|
"$<TARGET_PROPERTY:QT_PLUGINS_${_plugin_type}>"
|
|
">"
|
|
">"
|
|
)
|
|
string(CONCAT _plugin_versionless_is_in_type_whitelist
|
|
"$<IN_LIST:"
|
|
"${_plugin_target_versionless},"
|
|
"$<GENEX_EVAL:"
|
|
"$<TARGET_PROPERTY:QT_PLUGINS_${_plugin_type}>"
|
|
">"
|
|
">"
|
|
)
|
|
|
|
# Complete condition that defines whether a static plugin is linked
|
|
string(CONCAT _plugin_condition
|
|
"$<BOOL:$<AND:"
|
|
"${_is_plugin_marker_genex},"
|
|
"${_build_allow_plugin_link_rules_genex},"
|
|
"$<OR:"
|
|
"${_plugin_is_whitelisted},"
|
|
"${_plugin_versionless_is_whitelisted},"
|
|
"${_plugin_is_in_type_whitelist},"
|
|
"${_plugin_versionless_is_in_type_whitelist},"
|
|
"$<AND:"
|
|
"${_default_plugins_are_enabled_wrapped},"
|
|
"${_plugin_is_default},"
|
|
"${_plugin_is_not_blacklisted}"
|
|
">"
|
|
">"
|
|
">>"
|
|
)
|
|
|
|
# If this condition is true, we link against the plug-in
|
|
set(_plugin_genex "$<${_plugin_condition}:${_plugin_target}>")
|
|
target_link_libraries(${_module_target} INTERFACE "${_plugin_genex}")
|
|
|
|
set(_generated_qt_plugin_file_name
|
|
"${CMAKE_CURRENT_BINARY_DIR}/qt_@QT_MODULE@_${target}.cpp")
|
|
set(_generated_qt_plugin_file_name_template "${_generated_qt_plugin_file_name}.in")
|
|
set(_generated_qt_plugin_file_content "#include <QtPlugin>\nQ_IMPORT_PLUGIN(${_classname})")
|
|
|
|
# Generate a source file to import that plug-in. Has to be done with configure_file,
|
|
# because file(GENERATE) and target_sources has issues with scopes.
|
|
file(WRITE "${_generated_qt_plugin_file_name_template}"
|
|
"${_generated_qt_plugin_file_content}")
|
|
configure_file("${_generated_qt_plugin_file_name_template}"
|
|
"${_generated_qt_plugin_file_name}")
|
|
|
|
target_sources(${_module_target} INTERFACE
|
|
"$<${_plugin_condition}:${_generated_qt_plugin_file_name}>")
|
|
endforeach()
|
|
|
|
set_target_properties(${_module_target} PROPERTIES __qt_internal_plugins_added TRUE)
|
|
endfunction()
|
|
|
|
if(NOT @BUILD_SHARED_LIBS@ AND NOT QT_NO_CREATE_TARGETS)
|
|
__qt_internal_add_static_plugins_once()
|
|
endif()
|