AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
57ba6260c0
qt5base-lts/cmake/QtSyncQtHelpers.cmake
Laszlo Agocs 1dd8b5ceec rhi: Make it a QPA-style private but semi-public API 
qrhi.h, qshader.h, qshaderdescription.h (and qshaderbaker.h from
shadertools; done separately) become "RHI APIs", following the concept
of QPA APIs.

Mirror completely what is done for QPA headers, but using the "rhi"
prefix for the headers. This involves updating syncqt to handle the
new category of headers. (a note on the regex: matching everything
starting with "qrhi" is not acceptable due to incorrectly matching
existing and future headers, hence specifying the four header names
explicitly)

There is going to be one difference to QPA: the documentation for
everything RHI is going to be public and part of the regular docs, not
hidden with \internal.

In addition to the header renaming and adding the comments and
documentation notes and warnings, there is one significant change
here: there is no longer a need to do API-specific includes, such as
qrhid3d11[_p].h, qrhivulkan[_p].h, etc. These are simply merged into a
single header that is then included from qrhi.h. This means that users
within Qt, and any future applications can just do #include
<rhi/qrhi.h> (or rhi/qshader.h if the QRhi stuff is not relevant), no
other headers are needed.

There are no changes to functionality in this patch. Only the
documentation is expanded, quite a lot, to eliminate all qdoc warnings
and make the generated API docs complete. An example, with a quite
extensive doc page is added as well.

Task-number: QTBUG-113331
Change-Id: I91c749826348f14320cb335b1c83e9d1ea2b1d8b
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-05-21 15:42:58 +02:00

294 lines
12 KiB
CMake
Raw Blame History

# Copyright (C) 2022 The Qt Company Ltd.
# SPDX-License-Identifier: BSD-3-Clause
# The function generates the Qt module header structure in build directory and creates install
# rules. Apart the lists of header files the function takes into account
# QT_REPO_PUBLIC_NAMESPACE_REGEX cache variable, that can be set by repository in .cmake.conf file.
# The variable tells the syncqt program, what namespaces are treated as public. Symbols in public
# namespaces are considered when generating CaMeL case header files.
function(qt_internal_target_sync_headers target module_headers module_headers_generated)
if(NOT TARGET ${QT_CMAKE_EXPORT_NAMESPACE}::syncqt)
message(FATAL_ERROR "${QT_CMAKE_EXPORT_NAMESPACE}::syncqt is not a target.")
endif()
get_target_property(has_headers ${target} _qt_module_has_headers)
if(NOT has_headers)
return()
endif()
qt_internal_module_info(module "${target}")
get_target_property(sync_source_directory ${target} _qt_sync_source_directory)
set(syncqt_timestamp "${CMAKE_CURRENT_BINARY_DIR}/${target}_syncqt_timestamp")
set(syncqt_outputs "${syncqt_timestamp}")
set(is_interface_lib FALSE)
get_target_property(type ${target} TYPE)
if(type STREQUAL "INTERFACE_LIBRARY")
set(is_interface_lib TRUE)
endif()
set(version_script_private_content_file "")
if(NOT is_interface_lib)
list(APPEND syncqt_outputs
"${module_build_interface_include_dir}/${module}Version"
"${module_build_interface_include_dir}/qt${module_lower}version.h")
if(TEST_ld_version_script)
set(version_script_private_content_file
"${CMAKE_CURRENT_BINARY_DIR}/${target}.version.private_content")
set(version_script_args
"-versionScript" "${version_script_private_content_file}")
list(APPEND syncqt_outputs "${version_script_private_content_file}")
qt_internal_add_linker_version_script(${target}
PRIVATE_CONTENT_FILE "${version_script_private_content_file}")
endif()
endif()
# Check for _qt_module_is_3rdparty_header_library flag to detect non-Qt modules and
# indicate this to syncqt.
get_target_property(is_3rd_party_library ${target} _qt_module_is_3rdparty_header_library)
set(non_qt_module_argument "")
if(is_3rd_party_library)
set(non_qt_module_argument "-nonQt")
else()
list(APPEND syncqt_outputs "${module_build_interface_include_dir}/${module}")
get_target_property(no_headersclean_check ${target} _qt_no_headersclean_check)
if(NOT no_headersclean_check)
list(APPEND syncqt_outputs
"${CMAKE_CURRENT_BINARY_DIR}/${module}_header_check_exceptions")
endif()
endif()
set(is_framework FALSE)
if(NOT is_interface_lib)
get_target_property(is_framework ${target} FRAMEWORK)
if(is_framework)
qt_internal_get_framework_info(fw ${target})
get_target_property(fw_output_base_dir ${target} LIBRARY_OUTPUT_DIRECTORY)
set(framework_args "-framework"
"-frameworkIncludeDir" "${fw_output_base_dir}/${fw_versioned_header_dir}"
)
endif()
endif()
qt_internal_get_qt_all_known_modules(known_modules)
get_target_property(is_internal_module ${target} _qt_is_internal_module)
set(internal_module_argument "")
if(is_internal_module)
set(internal_module_argument "-internal")
endif()
get_target_property(qpa_filter_regex ${target} _qt_module_qpa_headers_filter_regex)
get_target_property(rhi_filter_regex ${target} _qt_module_rhi_headers_filter_regex)
get_target_property(private_filter_regex ${target} _qt_module_private_headers_filter_regex)
# We need to use the real paths since otherwise it may lead to the invalid work of the
# std::filesystem API
get_filename_component(source_dir_real "${sync_source_directory}" REALPATH)
get_filename_component(binary_dir_real "${CMAKE_CURRENT_BINARY_DIR}" REALPATH)
if(QT_REPO_PUBLIC_NAMESPACE_REGEX)
set(public_namespaces_filter -publicNamespaceFilter "${QT_REPO_PUBLIC_NAMESPACE_REGEX}")
endif()
if(qpa_filter_regex)
set(qpa_filter_argument
-qpaHeadersFilter "${qpa_filter_regex}"
)
endif()
if(rhi_filter_regex)
set(rhi_filter_argument
-rhiHeadersFilter "${rhi_filter_regex}"
)
endif()
set(common_syncqt_arguments
-module "${module}"
-sourceDir "${source_dir_real}"
-binaryDir "${binary_dir_real}"
-privateHeadersFilter "${private_filter_regex}"
-includeDir "${module_build_interface_include_dir}"
-privateIncludeDir "${module_build_interface_private_include_dir}"
-qpaIncludeDir "${module_build_interface_qpa_include_dir}"
-rhiIncludeDir "${module_build_interface_rhi_include_dir}"
-generatedHeaders ${module_headers_generated}
${qpa_filter_argument}
${rhi_filter_argument}
${public_namespaces_filter}
${non_qt_module_argument}
${internal_module_argument}
)
if(QT_INTERNAL_ENABLE_SYNCQT_DEBUG_OUTPUT)
list(APPEND common_syncqt_arguments -debug)
endif()
set(build_time_syncqt_arguments "")
if(WARNINGS_ARE_ERRORS)
if(is_interface_lib)
set(warnings_are_errors_enabled_genex 1)
else()
set(warnings_are_errors_enabled_genex
"$<NOT:$<BOOL:$<TARGET_PROPERTY:${target},QT_SKIP_WARNINGS_ARE_ERRORS>>>")
endif()
list(APPEND build_time_syncqt_arguments
"$<${warnings_are_errors_enabled_genex}:-warningsAreErrors>")
endif()
if(is_framework)
list(REMOVE_ITEM module_headers "${CMAKE_CURRENT_BINARY_DIR}/${target}_fake_header.h")
endif()
# Filter the generated ui_ header files and header files located in the 'doc/' subdirectory.
list(FILTER module_headers EXCLUDE REGEX
"(.+/(ui_)[^/]+\\.h|${CMAKE_CURRENT_SOURCE_DIR}(/.+)?/doc/+\\.h)")
set(syncqt_staging_dir "${module_build_interface_include_dir}/.syncqt_staging")
set(syncqt_args "${common_syncqt_arguments}")
list(APPEND syncqt_args
-headers ${module_headers}
-stagingDir "${syncqt_staging_dir}"
-knownModules ${known_modules}
${framework_args}
${version_script_args}
)
list(JOIN syncqt_args "\n" syncqt_args_string)
set(syncqt_args_rsp "${binary_dir_real}/${target}_syncqt_args")
qt_configure_file(OUTPUT "${syncqt_args_rsp}" CONTENT "${syncqt_args_string}")
add_custom_command(
OUTPUT
${syncqt_outputs}
COMMAND
${QT_CMAKE_EXPORT_NAMESPACE}::syncqt
"@${syncqt_args_rsp}"
${build_time_syncqt_arguments}
COMMAND
${CMAKE_COMMAND} -E touch "${syncqt_timestamp}"
DEPENDS
${syncqt_args_rsp}
${module_headers}
${QT_CMAKE_EXPORT_NAMESPACE}::syncqt
COMMENT
"Running syncqt.cpp for module: ${module}"
VERBATIM
)
add_custom_target(${target}_sync_headers
DEPENDS
${syncqt_outputs}
)
add_dependencies(sync_headers ${target}_sync_headers)
# This target is required when building docs, to make all header files and their aliases
# available for qdoc.
# ${target}_sync_headers is added as dependency to make sure that
# ${target}_sync_all_public_headers is running after ${target}_sync_headers, when building docs.
set(syncqt_all_args "${common_syncqt_arguments};-all")
list(JOIN syncqt_all_args "\n" syncqt_all_args_string)
set(syncqt_all_args_rsp "${binary_dir_real}/${target}_syncqt_all_args")
qt_configure_file(OUTPUT "${syncqt_all_args_rsp}" CONTENT "${syncqt_all_args_string}")
add_custom_target(${target}_sync_all_public_headers
COMMAND
${QT_CMAKE_EXPORT_NAMESPACE}::syncqt
"@${syncqt_all_args_rsp}"
DEPENDS
${module_headers}
${syncqt_all_args_rsp}
${QT_CMAKE_EXPORT_NAMESPACE}::syncqt
${target}_sync_headers
VERBATIM
)
if(NOT TARGET sync_all_public_headers)
add_custom_target(sync_all_public_headers)
endif()
add_dependencies(sync_all_public_headers ${target}_sync_all_public_headers)
if(NOT is_3rd_party_library AND NOT is_framework)
# Install all the CaMeL style aliases of header files from the staging directory in one rule
qt_install(DIRECTORY "${syncqt_staging_dir}/"
DESTINATION "${module_install_interface_include_dir}"
)
endif()
if(NOT is_interface_lib)
set_property(TARGET ${target}
APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "${target}_sync_headers")
endif()
add_dependencies(${target} "${target}_sync_headers")
get_target_property(private_module_target ${target} _qt_private_module_target_name)
if(private_module_target)
add_dependencies(${private_module_target} "${target}_sync_headers")
endif()
# Run sync Qt first time at configure step to make all header files available for the code model
# of IDEs.
get_property(synced_modules GLOBAL PROPERTY _qt_synced_modules)
if(NOT "${module}" IN_LIST synced_modules)
message(STATUS "Running syncqt.cpp for module: ${module}")
get_target_property(syncqt_location ${QT_CMAKE_EXPORT_NAMESPACE}::syncqt LOCATION)
execute_process(
COMMAND
${syncqt_location}
"@${syncqt_args_rsp}"
RESULT_VARIABLE syncqt_result
OUTPUT_VARIABLE syncqt_output
ERROR_VARIABLE syncqt_output
)
if(NOT syncqt_result EQUAL 0)
if(syncqt_output STREQUAL "")
string(JOIN "" syncqt_output "The syncqt process exited with code ${syncqt_result}"
" and without any useful output. This can happen if syncqt crashes due to the"
" incompatibilities with the standard C++ library located by either PATH or"
" LD_LIBRARY_PATH environment variables. Please make sure that PATH or"
" LD_LIBRARY_PATH don't point to the standard libraries different from the one you"
" use for building Qt.")
endif()
message(FATAL_ERROR
"syncqt.cpp failed for module ${module}:\n${syncqt_output}")
endif()
if(syncqt_output)
message(WARNING "${syncqt_output}")
endif()
set_property(GLOBAL APPEND PROPERTY _qt_synced_modules ${module})
endif()
endfunction()
function(qt_internal_collect_sync_header_dependencies out_var skip_non_existing)
list(LENGTH ARGN sync_headers_target_count)
if(sync_headers_target_count EQUAL 0)
message(FATAL_ERROR "Invalid use of qt_internal_collect_sync_header_dependencies,"
" dependencies are not specified")
endif()
set(${out_var} "")
foreach(sync_headers_target IN LISTS ARGN)
set(sync_headers_target "${sync_headers_target}_sync_headers")
if(NOT skip_non_existing OR TARGET ${sync_headers_target})
list(APPEND ${out_var} ${sync_headers_target})
endif()
endforeach()
list(REMOVE_DUPLICATES ${out_var})
set(${out_var} "${${out_var}}" PARENT_SCOPE)
endfunction()
function(qt_internal_add_sync_header_dependencies target)
qt_internal_collect_sync_header_dependencies(sync_headers_targets FALSE ${ARGN})
if(sync_headers_targets)
add_dependencies(${target} ${sync_headers_targets})
endif()
endfunction()
function(qt_internal_add_autogen_sync_header_dependencies target)
qt_internal_collect_sync_header_dependencies(sync_headers_targets TRUE ${ARGN})
foreach(sync_headers_target IN LISTS sync_headers_targets)
set_property(TARGET ${target} APPEND PROPERTY AUTOGEN_TARGET_DEPENDS
"${sync_headers_target}")
endforeach()
endfunction()
Reference in New Issue View Git Blame Copy Permalink