2022-07-05 11:26:52 +00:00
|
|
|
# Copyright (C) 2022 The Qt Company Ltd.
|
2022-08-19 13:21:34 +00:00
|
|
|
# SPDX-License-Identifier: BSD-3-Clause
|
2022-07-05 11:26:52 +00:00
|
|
|
|
2020-11-30 07:46:49 +00:00
|
|
|
# These values should be kept in sync with those in qtbase/.cmake.conf
|
2022-10-24 09:13:46 +00:00
|
|
|
cmake_minimum_required(VERSION 3.16...3.21)
|
2019-05-15 11:57:15 +00:00
|
|
|
|
2021-03-22 19:43:25 +00:00
|
|
|
###############################################
|
2019-05-15 11:57:15 +00:00
|
|
|
#
|
2021-03-22 19:43:25 +00:00
|
|
|
# Macros and functions for building Qt modules
|
2019-05-15 11:57:15 +00:00
|
|
|
#
|
2021-03-22 19:43:25 +00:00
|
|
|
###############################################
|
|
|
|
|
|
|
|
# Recursively reads the dependencies section from dependencies.yaml in ${repo_dir} and returns the
|
|
|
|
# list of dependencies, including transitive ones, in out_var.
|
|
|
|
#
|
|
|
|
# The returned dependencies are topologically sorted.
|
|
|
|
#
|
2022-11-22 10:06:20 +00:00
|
|
|
# Example output for qtdeclarative:
|
|
|
|
# qtbase;qtimageformats;qtlanguageserver;qtshadertools;qtsvg
|
2021-03-22 19:43:25 +00:00
|
|
|
#
|
|
|
|
function(qt_internal_read_repo_dependencies out_var repo_dir)
|
|
|
|
set(seen ${ARGN})
|
|
|
|
set(dependencies "")
|
|
|
|
set(in_dependencies_section FALSE)
|
|
|
|
set(dependencies_file "${repo_dir}/dependencies.yaml")
|
|
|
|
if(EXISTS "${dependencies_file}")
|
|
|
|
file(STRINGS "${dependencies_file}" lines)
|
|
|
|
foreach(line IN LISTS lines)
|
|
|
|
if(line MATCHES "^([^ ]+):")
|
|
|
|
if(CMAKE_MATCH_1 STREQUAL "dependencies")
|
|
|
|
set(in_dependencies_section TRUE)
|
|
|
|
else()
|
|
|
|
set(in_dependencies_section FALSE)
|
|
|
|
endif()
|
|
|
|
elseif(in_dependencies_section AND line MATCHES "^ (.+):$")
|
|
|
|
set(dependency "${CMAKE_MATCH_1}")
|
|
|
|
set(dependency_repo_dir "${repo_dir}/${dependency}")
|
|
|
|
string(REGEX MATCH "[^/]+$" dependency "${dependency}")
|
|
|
|
if(NOT dependency IN_LIST seen)
|
|
|
|
qt_internal_read_repo_dependencies(subdeps "${dependency_repo_dir}"
|
|
|
|
${seen} ${dependency})
|
|
|
|
list(APPEND dependencies ${subdeps} ${dependency})
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
list(REMOVE_DUPLICATES dependencies)
|
|
|
|
endif()
|
|
|
|
set(${out_var} "${dependencies}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
2019-05-15 11:57:15 +00:00
|
|
|
|
2020-04-16 18:30:03 +00:00
|
|
|
set(QT_BACKUP_CMAKE_INSTALL_PREFIX_BEFORE_EXTRA_INCLUDE "${CMAKE_INSTALL_PREFIX}")
|
|
|
|
|
2019-05-15 11:57:15 +00:00
|
|
|
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/QtBuildInternalsExtra.cmake")
|
|
|
|
include(${CMAKE_CURRENT_LIST_DIR}/QtBuildInternalsExtra.cmake)
|
|
|
|
endif()
|
|
|
|
|
2021-01-25 18:29:52 +00:00
|
|
|
# The variables might have already been set in QtBuildInternalsExtra.cmake if the file is included
|
|
|
|
# while building a new module and not QtBase. In that case, stop overriding the value.
|
|
|
|
if(NOT INSTALL_CMAKE_NAMESPACE)
|
|
|
|
set(INSTALL_CMAKE_NAMESPACE "Qt${PROJECT_VERSION_MAJOR}"
|
|
|
|
CACHE STRING "CMake namespace [Qt${PROJECT_VERSION_MAJOR}]")
|
|
|
|
endif()
|
|
|
|
if(NOT QT_CMAKE_EXPORT_NAMESPACE)
|
|
|
|
set(QT_CMAKE_EXPORT_NAMESPACE "Qt${PROJECT_VERSION_MAJOR}"
|
|
|
|
CACHE STRING "CMake namespace used when exporting targets [Qt${PROJECT_VERSION_MAJOR}]")
|
|
|
|
endif()
|
|
|
|
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
macro(qt_set_up_build_internals_paths)
|
2019-09-26 15:58:53 +00:00
|
|
|
# Set up the paths for the cmake modules located in the prefix dir. Prepend, so the paths are
|
2019-09-05 16:17:00 +00:00
|
|
|
# least important compared to the source dir ones, but more important than command line
|
|
|
|
# provided ones.
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
set(QT_CMAKE_MODULE_PATH "${QT_BUILD_INTERNALS_PATH}/../${QT_CMAKE_EXPORT_NAMESPACE}")
|
2019-09-05 16:17:00 +00:00
|
|
|
list(PREPEND CMAKE_MODULE_PATH "${QT_CMAKE_MODULE_PATH}")
|
|
|
|
|
2019-11-21 12:33:28 +00:00
|
|
|
# Prepend the qtbase source cmake directory to CMAKE_MODULE_PATH,
|
2019-09-05 16:17:00 +00:00
|
|
|
# so that if a change is done in cmake/QtBuild.cmake, it gets automatically picked up when
|
|
|
|
# building qtdeclarative, rather than having to build qtbase first (which will copy
|
|
|
|
# QtBuild.cmake to the build dir). This is similar to qmake non-prefix builds, where the
|
|
|
|
# source qtbase/mkspecs directory is used.
|
2022-03-28 14:59:20 +00:00
|
|
|
# TODO: Clean this up, together with qt_internal_try_compile_binary_for_strip to only use the
|
|
|
|
# the qtbase sources when building qtbase. And perhaps also when doing a non-prefix
|
|
|
|
# developer-build.
|
2019-11-21 12:33:28 +00:00
|
|
|
if(EXISTS "${QT_SOURCE_TREE}/cmake")
|
2019-09-05 16:17:00 +00:00
|
|
|
list(PREPEND CMAKE_MODULE_PATH "${QT_SOURCE_TREE}/cmake")
|
|
|
|
endif()
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
|
|
|
|
# If the repo has its own cmake modules, include those in the module path.
|
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
|
2019-09-05 16:17:00 +00:00
|
|
|
list(PREPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
endif()
|
2019-09-20 13:20:57 +00:00
|
|
|
|
|
|
|
# Find the cmake files when doing a standalone tests build.
|
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../cmake")
|
|
|
|
list(PREPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake")
|
|
|
|
endif()
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
endmacro()
|
|
|
|
|
2019-09-26 15:58:53 +00:00
|
|
|
# Set up the build internal paths unless explicitly requested not to.
|
|
|
|
if(NOT QT_BUILD_INTERNALS_SKIP_CMAKE_MODULE_PATH_ADDITION)
|
|
|
|
qt_set_up_build_internals_paths()
|
|
|
|
endif()
|
2019-05-15 11:57:15 +00:00
|
|
|
|
2019-09-26 15:58:53 +00:00
|
|
|
# Define some constants to check for certain platforms, etc.
|
|
|
|
# Needs to be loaded before qt_repo_build() to handle require() clauses before even starting a repo
|
|
|
|
# build.
|
|
|
|
include(QtPlatformSupport)
|
|
|
|
|
2023-08-25 16:20:01 +00:00
|
|
|
# Set FEATURE_${feature} if INPUT_${feature} is set in certain circumstances.
|
CMake: Fix reconfiguration when -no-opengl is specified
In a previous change, we ensured that all INPUT_foo cache variables are
unset at the end of configuration, so they don't influence feature
re-evaluation in case if a command line flag like -no-gui is not
specified upon second reconfiguration and a FEATURE_foo is manually
toggled in the CMakeCache.txt, effectively getting rid of
stale INPUT_foo values.
Unfortunately that causes an issue when configuring with -no-opengl
and then trying to reconfigure with 'cmake .'
Specifically various feature options like ENABLE / DISABLE use
INPUT_foo variables in their expressions.
qt_configure_add_report_entry CONDITIONs also use them.
These expect the INPUT_foo variables to be persisted, and if they are
removed, the expressions might be re-evaluated to a different value,
and cause re-configuration to fail or unexpectedly toggle features.
To support both cases described above, instead of removing all INPUT
variables when configuration ends, only unset those INPUT variables
whose corresponding FEATURE_foo variable has been manually toggled in
CMakeCache.txt or via an IDE.
Toggling a FEATURE_foo manually is intentional, which means the
INPUT_foo value should be discarded. Whereas pre-existing INPUT_bar
variables will persist, thus not breaking cases like the -no-opengl
report CONDITION.
Amends 2799391703e44a34b6557e234462e425a61785f2
Pick-to: 6.6
Fixes: QTBUG-116973
Task-number: QTBUG-112957
Change-Id: I5851255bfa41a9a1d116630a5d9f7b9a74aa93ed
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-09-12 14:57:56 +00:00
|
|
|
# Set FEATURE_${feature}_computed_from_input to TRUE or FALSE depending on whether the
|
|
|
|
# INPUT_${feature} value has overridden the FEATURE_${feature} variable.
|
2023-08-25 16:20:01 +00:00
|
|
|
#
|
|
|
|
# Needs to be in QtBuildInternalsConfig.cmake instead of QtFeature.cmake because it's used in
|
|
|
|
# qt_build_internals_disable_pkg_config_if_needed.
|
|
|
|
function(qt_internal_compute_feature_value_from_possible_input feature)
|
|
|
|
# If FEATURE_ is not defined try to use the INPUT_ variable to enable/disable feature.
|
|
|
|
# If FEATURE_ is defined and the configure script is being used (so
|
|
|
|
# QT_INTERNAL_CALLED_FROM_CONFIGURE is TRUE), ignore the FEATURE_ variable, and take into
|
|
|
|
# account the INPUT_ variable instead, because a command line argument takes priority over
|
|
|
|
# a pre-cached FEATURE_ variable.
|
|
|
|
if((NOT DEFINED FEATURE_${feature} OR QT_INTERNAL_CALLED_FROM_CONFIGURE)
|
|
|
|
AND DEFINED INPUT_${feature}
|
|
|
|
AND NOT "${INPUT_${feature}}" STREQUAL "undefined"
|
|
|
|
AND NOT "${INPUT_${feature}}" STREQUAL "")
|
|
|
|
if(INPUT_${feature})
|
|
|
|
set(FEATURE_${feature} ON)
|
|
|
|
else()
|
|
|
|
set(FEATURE_${feature} OFF)
|
|
|
|
endif()
|
|
|
|
|
|
|
|
set(FEATURE_${feature} "${FEATURE_${feature}}" PARENT_SCOPE)
|
CMake: Fix reconfiguration when -no-opengl is specified
In a previous change, we ensured that all INPUT_foo cache variables are
unset at the end of configuration, so they don't influence feature
re-evaluation in case if a command line flag like -no-gui is not
specified upon second reconfiguration and a FEATURE_foo is manually
toggled in the CMakeCache.txt, effectively getting rid of
stale INPUT_foo values.
Unfortunately that causes an issue when configuring with -no-opengl
and then trying to reconfigure with 'cmake .'
Specifically various feature options like ENABLE / DISABLE use
INPUT_foo variables in their expressions.
qt_configure_add_report_entry CONDITIONs also use them.
These expect the INPUT_foo variables to be persisted, and if they are
removed, the expressions might be re-evaluated to a different value,
and cause re-configuration to fail or unexpectedly toggle features.
To support both cases described above, instead of removing all INPUT
variables when configuration ends, only unset those INPUT variables
whose corresponding FEATURE_foo variable has been manually toggled in
CMakeCache.txt or via an IDE.
Toggling a FEATURE_foo manually is intentional, which means the
INPUT_foo value should be discarded. Whereas pre-existing INPUT_bar
variables will persist, thus not breaking cases like the -no-opengl
report CONDITION.
Amends 2799391703e44a34b6557e234462e425a61785f2
Pick-to: 6.6
Fixes: QTBUG-116973
Task-number: QTBUG-112957
Change-Id: I5851255bfa41a9a1d116630a5d9f7b9a74aa93ed
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-09-12 14:57:56 +00:00
|
|
|
set(FEATURE_${feature}_computed_from_input TRUE PARENT_SCOPE)
|
|
|
|
else()
|
|
|
|
set(FEATURE_${feature}_computed_from_input FALSE PARENT_SCOPE)
|
2023-08-25 16:20:01 +00:00
|
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
function(qt_build_internals_disable_pkg_config_if_needed)
|
2020-08-26 16:48:01 +00:00
|
|
|
# pkg-config should not be used by default on Darwin and Windows platforms (and QNX), as defined
|
|
|
|
# in the qtbase/configure.json. Unfortunately by the time the feature is evaluated there are
|
|
|
|
# already a few find_package() calls that try to use the FindPkgConfig module.
|
|
|
|
# Thus, we have to duplicate the condition logic here and disable pkg-config for those platforms
|
|
|
|
# by default.
|
|
|
|
# We also need to check if the pkg-config executable exists, to mirror the condition test in
|
|
|
|
# configure.json. We do that by trying to find the executable ourselves, and not delegating to
|
|
|
|
# the FindPkgConfig module because that has more unwanted side-effects.
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
#
|
|
|
|
# Note that on macOS, if the pkg-config feature is enabled by the user explicitly, we will also
|
|
|
|
# tell CMake to consider paths like /usr/local (Homebrew) as system paths when looking for
|
|
|
|
# packages.
|
|
|
|
# We have to do that because disabling these paths but keeping pkg-config
|
|
|
|
# enabled won't enable finding all system libraries via pkg-config alone, many libraries can
|
|
|
|
# only be found via FooConfig.cmake files which means /usr/local should be in the system prefix
|
|
|
|
# path.
|
2020-08-26 16:48:01 +00:00
|
|
|
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
set(pkg_config_enabled ON)
|
2020-08-26 16:48:01 +00:00
|
|
|
qt_build_internals_find_pkg_config_executable()
|
|
|
|
|
2020-09-03 08:29:41 +00:00
|
|
|
if(APPLE OR WIN32 OR QNX OR ANDROID OR WASM OR (NOT PKG_CONFIG_EXECUTABLE))
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
set(pkg_config_enabled OFF)
|
|
|
|
endif()
|
2020-08-26 16:48:01 +00:00
|
|
|
|
2021-01-14 04:12:06 +00:00
|
|
|
# Features won't have been evaluated yet if this is the first run, have to evaluate this here
|
2023-08-25 16:20:01 +00:00
|
|
|
qt_internal_compute_feature_value_from_possible_input(pkg_config)
|
2021-01-14 04:12:06 +00:00
|
|
|
|
2020-08-26 16:48:01 +00:00
|
|
|
# If user explicitly specified a value for the feature, honor it, even if it might break
|
|
|
|
# the build.
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
if(DEFINED FEATURE_pkg_config)
|
|
|
|
if(FEATURE_pkg_config)
|
|
|
|
set(pkg_config_enabled ON)
|
|
|
|
else()
|
|
|
|
set(pkg_config_enabled OFF)
|
|
|
|
endif()
|
|
|
|
endif()
|
2020-08-26 16:48:01 +00:00
|
|
|
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
set(FEATURE_pkg_config "${pkg_config_enabled}" CACHE STRING "Using pkg-config")
|
|
|
|
if(NOT pkg_config_enabled)
|
|
|
|
qt_build_internals_disable_pkg_config()
|
|
|
|
else()
|
|
|
|
unset(PKG_CONFIG_EXECUTABLE CACHE)
|
|
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
2020-08-26 16:48:01 +00:00
|
|
|
# This is a copy of the first few lines in FindPkgConfig.cmake.
|
|
|
|
function(qt_build_internals_find_pkg_config_executable)
|
|
|
|
# find pkg-config, use PKG_CONFIG if set
|
|
|
|
if((NOT PKG_CONFIG_EXECUTABLE) AND (NOT "$ENV{PKG_CONFIG}" STREQUAL ""))
|
|
|
|
set(PKG_CONFIG_EXECUTABLE "$ENV{PKG_CONFIG}" CACHE FILEPATH "pkg-config executable")
|
|
|
|
endif()
|
|
|
|
find_program(PKG_CONFIG_EXECUTABLE NAMES pkg-config DOC "pkg-config executable")
|
|
|
|
mark_as_advanced(PKG_CONFIG_EXECUTABLE)
|
|
|
|
endfunction()
|
|
|
|
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
function(qt_build_internals_disable_pkg_config)
|
|
|
|
# Disable pkg-config by setting an empty executable path. There's no documented way to
|
2020-08-26 16:48:01 +00:00
|
|
|
# mark the package as not found, but we can force all pkg_check_modules calls to do nothing
|
|
|
|
# by setting the variable to an empty value.
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
set(PKG_CONFIG_EXECUTABLE "" CACHE STRING "Disabled pkg-config usage." FORCE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
if(NOT QT_BUILD_INTERNALS_SKIP_PKG_CONFIG_ADJUSTMENT)
|
|
|
|
qt_build_internals_disable_pkg_config_if_needed()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
macro(qt_build_internals_find_pkg_config)
|
|
|
|
# Find package config once before any system prefix modifications.
|
|
|
|
find_package(PkgConfig QUIET)
|
|
|
|
endmacro()
|
|
|
|
|
|
|
|
if(NOT QT_BUILD_INTERNALS_SKIP_FIND_PKG_CONFIG)
|
|
|
|
qt_build_internals_find_pkg_config()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
function(qt_build_internals_set_up_system_prefixes)
|
|
|
|
if(APPLE AND NOT FEATURE_pkg_config)
|
|
|
|
# Remove /usr/local and other paths like that which CMake considers as system prefixes on
|
|
|
|
# darwin platforms. CMake considers them as system prefixes, but in qmake / Qt land we only
|
|
|
|
# consider the SDK path as a system prefix.
|
|
|
|
# 3rd party libraries in these locations should not be picked up when building Qt,
|
|
|
|
# unless opted-in via the pkg-config feature, which in turn will disable this behavior.
|
|
|
|
#
|
|
|
|
# Note that we can't remove /usr as a system prefix path, because many programs won't be
|
|
|
|
# found then (e.g. perl).
|
|
|
|
set(QT_CMAKE_SYSTEM_PREFIX_PATH_BACKUP "${CMAKE_SYSTEM_PREFIX_PATH}" PARENT_SCOPE)
|
|
|
|
set(QT_CMAKE_SYSTEM_FRAMEWORK_PATH_BACKUP "${CMAKE_SYSTEM_FRAMEWORK_PATH}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
list(REMOVE_ITEM CMAKE_SYSTEM_PREFIX_PATH
|
|
|
|
"/usr/local" # Homebrew
|
2021-04-15 11:11:00 +00:00
|
|
|
"/opt/homebrew" # Apple Silicon Homebrew
|
CMake: Don't use libraries in /usr/local by default on macOS
qmake builds of Qt don't use libraries in /usr/local because the
path is not considered a system path. Only the SDK path should be
used as a source of system libraries.
We should do the same for the CMake builds, which involves a couple of
things.
Tell CMake not to consider /usr/local (and a bunch of other
paths) as system prefix paths.
Disable pkg-config usage which by default is not used in qmake
Windows and macOS builds.
If a user wishes to use libraries located in /usr/local on macOS, they
can explicitly enable the behavior via -DFEATURE_pkg_config=ON.
In addition to enabling pkg-config, that will also disable the system
prefix modification described above.
Implementation notes
To disable pkg-config usage, we set an empty path for
PKG_CONFIG_EXECUTABLE, because there is no other good way. The
downside to this is that a lot of warning messages will be printed
that the pkg-config package can not be found.
The pkg-config feature needs to be computed in QtBuildInternals before
qtbase/src/configure.cmake, because it's too late to do it in that
file where a few qt_find_package calls already exist.
The feature value is also saved to QtBuildInternalsExtra, to make sure
that pkg-config is disabled whenever building another repo.
System prefix adjustment is done by removing paths from
CMAKE_SYSTEM_PREFIX_PATH.
Ideally we would remove also /usr as a path, to match what qmake does,
but that breaks find_program() calls for perl, python, etc.
We have to make sure that qt_find_package does not look in
PATH when looking for packages, which is the default behavior, because
PATH on macOS most likely contains /usr/local.
One last curiosity for future generations is that CMake 3.18+ has
merged a change to prioritise SDK locations over regular /usr/lib.
Fixes: QTBUG-85261
Change-Id: I28fe5bae7997507a83b37b4eb1e0188e64062c57
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2020-06-25 16:02:52 +00:00
|
|
|
"/usr/X11R6"
|
|
|
|
"/usr/pkg"
|
|
|
|
"/opt"
|
|
|
|
"/sw" # Fink
|
|
|
|
"/opt/local" # MacPorts
|
|
|
|
)
|
|
|
|
if(_CMAKE_INSTALL_DIR)
|
|
|
|
list(REMOVE_ITEM CMAKE_SYSTEM_PREFIX_PATH "${_CMAKE_INSTALL_DIR}")
|
|
|
|
endif()
|
|
|
|
list(REMOVE_ITEM CMAKE_SYSTEM_FRAMEWORK_PATH "~/Library/Frameworks")
|
|
|
|
set(CMAKE_SYSTEM_PREFIX_PATH "${CMAKE_SYSTEM_PREFIX_PATH}" PARENT_SCOPE)
|
|
|
|
set(CMAKE_SYSTEM_FRAMEWORK_PATH "${CMAKE_SYSTEM_FRAMEWORK_PATH}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
# Also tell qt_find_package() not to use PATH when looking for packages.
|
|
|
|
# We can't simply set CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH to OFF because that will break
|
|
|
|
# find_program(), and for instance ccache won't be found.
|
|
|
|
# That's why we set a different variable which is used by qt_find_package.
|
|
|
|
set(QT_NO_USE_FIND_PACKAGE_SYSTEM_ENVIRONMENT_PATH "ON" PARENT_SCOPE)
|
|
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
if(NOT QT_BUILD_INTERNALS_SKIP_SYSTEM_PREFIX_ADJUSTMENT)
|
|
|
|
qt_build_internals_set_up_system_prefixes()
|
|
|
|
endif()
|
|
|
|
|
2023-04-12 13:04:14 +00:00
|
|
|
# The macro sets all the necessary pre-conditions and setup consistent environment for building
|
|
|
|
# the Qt repository. It has to be called right after the find_package(Qt6 COMPONENTS BuildInternals)
|
|
|
|
# call. Otherwise we cannot make sure that all the required policies will be applied to the Qt
|
|
|
|
# components that are involved in build procedure.
|
|
|
|
macro(qt_internal_project_setup)
|
2020-10-30 16:42:34 +00:00
|
|
|
# Check for the minimum CMake version.
|
|
|
|
include(QtCMakeVersionHelpers)
|
|
|
|
qt_internal_require_suitable_cmake_version()
|
2020-11-30 07:46:49 +00:00
|
|
|
qt_internal_upgrade_cmake_policies()
|
2023-04-12 13:04:14 +00:00
|
|
|
endmacro()
|
|
|
|
|
|
|
|
macro(qt_build_internals_set_up_private_api)
|
|
|
|
# TODO: this call needs to be removed once all repositories got the qtbase update
|
|
|
|
qt_internal_project_setup()
|
2020-10-30 16:42:34 +00:00
|
|
|
|
2019-05-15 11:57:15 +00:00
|
|
|
# Qt specific setup common for all modules:
|
|
|
|
include(QtSetup)
|
|
|
|
include(FeatureSummary)
|
2019-05-28 11:33:42 +00:00
|
|
|
|
|
|
|
# Optionally include a repo specific Setup module.
|
|
|
|
include(${PROJECT_NAME}Setup OPTIONAL)
|
2019-09-20 13:20:57 +00:00
|
|
|
include(QtRepoSetup OPTIONAL)
|
2019-06-13 13:55:38 +00:00
|
|
|
|
|
|
|
# Find Apple frameworks if needed.
|
|
|
|
qt_find_apple_system_frameworks()
|
2019-11-01 10:48:23 +00:00
|
|
|
|
|
|
|
# Decide whether tools will be built.
|
|
|
|
qt_check_if_tools_will_be_built()
|
2020-03-18 18:09:00 +00:00
|
|
|
endmacro()
|
|
|
|
|
2020-11-17 23:36:44 +00:00
|
|
|
# find all targets defined in $subdir by recursing through all added subdirectories
|
|
|
|
# populates $qt_repo_targets with a ;-list of non-UTILITY targets
|
|
|
|
macro(qt_build_internals_get_repo_targets subdir)
|
2021-04-16 14:31:25 +00:00
|
|
|
get_directory_property(_targets DIRECTORY "${subdir}" BUILDSYSTEM_TARGETS)
|
|
|
|
if(_targets)
|
|
|
|
foreach(_target IN LISTS _targets)
|
|
|
|
get_target_property(_type ${_target} TYPE)
|
2022-11-24 11:28:34 +00:00
|
|
|
if(NOT ${_type} STREQUAL "UTILITY")
|
2021-04-16 14:31:25 +00:00
|
|
|
list(APPEND qt_repo_targets "${_target}")
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
endif()
|
|
|
|
|
2020-11-17 23:36:44 +00:00
|
|
|
get_directory_property(_directories DIRECTORY "${subdir}" SUBDIRECTORIES)
|
|
|
|
if (_directories)
|
|
|
|
foreach(_directory IN LISTS _directories)
|
|
|
|
qt_build_internals_get_repo_targets("${_directory}")
|
|
|
|
endforeach()
|
|
|
|
endif()
|
|
|
|
endmacro()
|
|
|
|
|
|
|
|
# add toplevel targets for each subdirectory, e.g. qtbase_src
|
|
|
|
function(qt_build_internals_add_toplevel_targets)
|
|
|
|
set(qt_repo_target_all "")
|
|
|
|
get_directory_property(directories DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" SUBDIRECTORIES)
|
|
|
|
foreach(directory IN LISTS directories)
|
|
|
|
set(qt_repo_targets "")
|
|
|
|
get_filename_component(qt_repo_target_basename ${directory} NAME)
|
|
|
|
qt_build_internals_get_repo_targets("${directory}")
|
|
|
|
if (qt_repo_targets)
|
|
|
|
set(qt_repo_target_name "${qt_repo_targets_name}_${qt_repo_target_basename}")
|
|
|
|
message(DEBUG "${qt_repo_target_name} depends on ${qt_repo_targets}")
|
|
|
|
add_custom_target("${qt_repo_target_name}"
|
CMake: Fix Ninja Multi-Config dependency issues for top-level targets
When building qtsvg examples as external projects on Windows
with Ninja Multi-Config in a prefix build on the CI, the build would
fail with an error message like:
ninja: error:
'C:/Users/qt/work/qt/qtsvg/lib/Qt6SvgWidgets.lib', needed by
'RelWithDebInfo/svgviewer.exe', missing and no known rule to make it
This can be reproduced locally on Windows if one calls
'ninja svgviewer' instead of just 'ninja'. I wasn't able to reproduce
it on macOS, although I have seen some peculiarities in the
dependencies there as well.
External project examples depend on the ${repo_name}_src custom
target to ensure all Qt modules are built, so one would expect that
dependency to be sufficient.
While trying to figure out what's going wrong, I noticed that running
'ninja -t query qtsvg_src:Debug' showed dependencies on Release
libraries, which should not happen. The :Release target looked fine
though.
I'm still not quite sure why the Release libraries are not built
on the first ninja run, despite the example having a proper dependency
on qtsvg:Release.
Running 'ninja svgviewer' a few more times ends up succeeding at one
point, because the SvgWidgets Release library does get built in
parallel with the failing example, and the next rebuild would
succeed.
While trying to fix the :Debug target to have proper dependencies, I
noticed that we add dependencies to the ${repo_name}_src custom target
via the DEPENDS option of add_custom_target(). That is incorrect,
that option should only be used for file level dependencies.
For target dependencies, add_dependencies should be used.
Doing that fixed both the :Debug dependencies as well as the Windows
issue, which is good enough for me.
Amends 08f46bb40075778e89ba9aed3cef53d990852022
Pick-to: 6.2 6.3 6.4
Task-number: QTBUG-90820
Task-number: QTBUG-96232
Change-Id: I1888681e2e9362d3237acbdacc83222d6a60b48e
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-08-03 13:22:50 +00:00
|
|
|
COMMENT "Building everything in ${qt_repo_targets_name}/${qt_repo_target_basename}")
|
|
|
|
add_dependencies("${qt_repo_target_name}" ${qt_repo_targets})
|
2020-11-17 23:36:44 +00:00
|
|
|
list(APPEND qt_repo_target_all "${qt_repo_target_name}")
|
2023-01-19 17:55:58 +00:00
|
|
|
|
|
|
|
# Create special dependency target for External Project examples excluding targets
|
|
|
|
# marked as skipped.
|
2023-08-18 11:53:44 +00:00
|
|
|
if(qt_repo_target_basename STREQUAL "src")
|
|
|
|
set(qt_repo_target_name
|
|
|
|
"${qt_repo_targets_name}_${qt_repo_target_basename}_for_examples")
|
|
|
|
add_custom_target("${qt_repo_target_name}")
|
|
|
|
|
|
|
|
set(unskipped_targets "")
|
|
|
|
foreach(target IN LISTS qt_repo_targets)
|
|
|
|
if(TARGET "${target}")
|
|
|
|
qt_internal_is_target_skipped_for_examples("${target}" is_skipped)
|
|
|
|
if(NOT is_skipped)
|
|
|
|
list(APPEND unskipped_targets "${target}")
|
|
|
|
endif()
|
2023-01-19 17:55:58 +00:00
|
|
|
endif()
|
2023-08-18 11:53:44 +00:00
|
|
|
endforeach()
|
|
|
|
if(unskipped_targets)
|
|
|
|
add_dependencies("${qt_repo_target_name}" ${unskipped_targets})
|
2023-01-19 17:55:58 +00:00
|
|
|
endif()
|
|
|
|
endif()
|
2020-11-17 23:36:44 +00:00
|
|
|
endif()
|
2023-01-19 17:55:58 +00:00
|
|
|
|
2020-11-17 23:36:44 +00:00
|
|
|
endforeach()
|
|
|
|
if (qt_repo_target_all)
|
CMake: Fix Ninja Multi-Config dependency issues for top-level targets
When building qtsvg examples as external projects on Windows
with Ninja Multi-Config in a prefix build on the CI, the build would
fail with an error message like:
ninja: error:
'C:/Users/qt/work/qt/qtsvg/lib/Qt6SvgWidgets.lib', needed by
'RelWithDebInfo/svgviewer.exe', missing and no known rule to make it
This can be reproduced locally on Windows if one calls
'ninja svgviewer' instead of just 'ninja'. I wasn't able to reproduce
it on macOS, although I have seen some peculiarities in the
dependencies there as well.
External project examples depend on the ${repo_name}_src custom
target to ensure all Qt modules are built, so one would expect that
dependency to be sufficient.
While trying to figure out what's going wrong, I noticed that running
'ninja -t query qtsvg_src:Debug' showed dependencies on Release
libraries, which should not happen. The :Release target looked fine
though.
I'm still not quite sure why the Release libraries are not built
on the first ninja run, despite the example having a proper dependency
on qtsvg:Release.
Running 'ninja svgviewer' a few more times ends up succeeding at one
point, because the SvgWidgets Release library does get built in
parallel with the failing example, and the next rebuild would
succeed.
While trying to fix the :Debug target to have proper dependencies, I
noticed that we add dependencies to the ${repo_name}_src custom target
via the DEPENDS option of add_custom_target(). That is incorrect,
that option should only be used for file level dependencies.
For target dependencies, add_dependencies should be used.
Doing that fixed both the :Debug dependencies as well as the Windows
issue, which is good enough for me.
Amends 08f46bb40075778e89ba9aed3cef53d990852022
Pick-to: 6.2 6.3 6.4
Task-number: QTBUG-90820
Task-number: QTBUG-96232
Change-Id: I1888681e2e9362d3237acbdacc83222d6a60b48e
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-08-03 13:22:50 +00:00
|
|
|
# Note qt_repo_targets_name is different from qt_repo_target_name that is used above.
|
2020-11-17 23:36:44 +00:00
|
|
|
add_custom_target("${qt_repo_targets_name}"
|
|
|
|
COMMENT "Building everything in ${qt_repo_targets_name}")
|
CMake: Fix Ninja Multi-Config dependency issues for top-level targets
When building qtsvg examples as external projects on Windows
with Ninja Multi-Config in a prefix build on the CI, the build would
fail with an error message like:
ninja: error:
'C:/Users/qt/work/qt/qtsvg/lib/Qt6SvgWidgets.lib', needed by
'RelWithDebInfo/svgviewer.exe', missing and no known rule to make it
This can be reproduced locally on Windows if one calls
'ninja svgviewer' instead of just 'ninja'. I wasn't able to reproduce
it on macOS, although I have seen some peculiarities in the
dependencies there as well.
External project examples depend on the ${repo_name}_src custom
target to ensure all Qt modules are built, so one would expect that
dependency to be sufficient.
While trying to figure out what's going wrong, I noticed that running
'ninja -t query qtsvg_src:Debug' showed dependencies on Release
libraries, which should not happen. The :Release target looked fine
though.
I'm still not quite sure why the Release libraries are not built
on the first ninja run, despite the example having a proper dependency
on qtsvg:Release.
Running 'ninja svgviewer' a few more times ends up succeeding at one
point, because the SvgWidgets Release library does get built in
parallel with the failing example, and the next rebuild would
succeed.
While trying to fix the :Debug target to have proper dependencies, I
noticed that we add dependencies to the ${repo_name}_src custom target
via the DEPENDS option of add_custom_target(). That is incorrect,
that option should only be used for file level dependencies.
For target dependencies, add_dependencies should be used.
Doing that fixed both the :Debug dependencies as well as the Windows
issue, which is good enough for me.
Amends 08f46bb40075778e89ba9aed3cef53d990852022
Pick-to: 6.2 6.3 6.4
Task-number: QTBUG-90820
Task-number: QTBUG-96232
Change-Id: I1888681e2e9362d3237acbdacc83222d6a60b48e
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-08-03 13:22:50 +00:00
|
|
|
add_dependencies("${qt_repo_targets_name}" ${qt_repo_target_all})
|
|
|
|
message(DEBUG "${qt_repo_targets_name} depends on ${qt_repo_target_all}")
|
2020-11-17 23:36:44 +00:00
|
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
2020-04-03 12:23:18 +00:00
|
|
|
macro(qt_enable_cmake_languages)
|
|
|
|
set(__qt_required_language_list C CXX)
|
2023-06-27 13:25:50 +00:00
|
|
|
set(__qt_platform_required_language_list )
|
2020-04-06 13:52:48 +00:00
|
|
|
|
|
|
|
if(APPLE)
|
2023-06-27 13:25:50 +00:00
|
|
|
list(APPEND __qt_platform_required_language_list OBJC OBJCXX)
|
2020-04-06 13:52:48 +00:00
|
|
|
endif()
|
2020-04-03 12:23:18 +00:00
|
|
|
|
|
|
|
foreach(__qt_lang ${__qt_required_language_list})
|
|
|
|
enable_language(${__qt_lang})
|
|
|
|
endforeach()
|
|
|
|
|
2023-06-27 13:25:50 +00:00
|
|
|
foreach(__qt_lang ${__qt_platform_required_language_list})
|
|
|
|
enable_language(${__qt_lang})
|
2020-04-03 12:23:18 +00:00
|
|
|
endforeach()
|
CMake: Adjust compiler flag optimizations to qmake mkspec ones
There are inconsistencies in the default optimization flags added by
CMake across configurations like Release and RelWithDebInfo.
In particular Release uses -O3, whereas RelWithDebInfo uses -O2,
as well as usage of /INCREMENTAL in release configs with MSVC, etc.
To make sure that the Qt 6 binaries built with CMake are consistent
across configs, as well as consistent with the flags we used when
building Qt 5 with qmake, add a horrible search and replace mechanism
to replaces the CMake flags with what our mkspecs indicate to use.
Ideally this would be done by providing custom CMake toolchain files
for each platform we support, and we might revisit that later if the
need really arises.
To implement the replacing, we first need the flags that should be
added. Port the QMAKE_CFLAGS_OPTIMIZE variables to CMake, which is
done in QtCompilerOptimization.cmake.
Then a new function called
qt_internal_set_up_config_optimizations_like_in_qmake will look for
any kind of optimization flags set in the
CMAKE_<LANG>_FLAGS_<CONFIG> style variables, remove them, and add
the appropriate flags that qmake mkspecs provide.
On some platforms (like Windows MSVC) the function also alters the
linker CMAKE_${TYPE}_LINKER_FLAGS_<CONFIG> style variables.
The mechanism allows opting out of this replacing by
setting the QT_USE_DEFAULT_CMAKE_OPTIMIZATION_FLAGS value.
It also allows opting into removal of flags for custom configs by
providing QT_ADDITIONAL_OPTIMIZATION_FLAG_CONFIGS. It's only removal,
because we wouldn't know what kind of config it is, and thus what
flags to add.
The currently modified configs are: Release, RelWithDebInfo,
MinSizeRel, Debug aka the usual default CMake provided ones.
The mechanism is only applied to C-like languages.
ASM is not handled to be on the safe side due to not knowing what kind
of compiler flags the platform assembler might take.
It's also important to skip RC on MSVC platforms.
Task-number: QTBUG-85992
Change-Id: I3712d5cd5a34fceab54f56a6fa46b4e678952362
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-08-17 15:32:28 +00:00
|
|
|
|
2020-10-02 13:38:47 +00:00
|
|
|
# The qtbase call is handled in qtbase/CMakeLists.txt.
|
|
|
|
# This call is used for projects other than qtbase, including for other project's standalone
|
|
|
|
# tests.
|
|
|
|
# Because the function uses QT_FEATURE_foo values, it's important that find_package(Qt6Core) is
|
|
|
|
# called before this function. but that's usually the case for Qt repos.
|
2020-08-20 08:19:32 +00:00
|
|
|
if(NOT PROJECT_NAME STREQUAL "QtBase")
|
|
|
|
qt_internal_set_up_config_optimizations_like_in_qmake()
|
|
|
|
endif()
|
2020-04-03 12:23:18 +00:00
|
|
|
endmacro()
|
|
|
|
|
2020-04-23 09:24:48 +00:00
|
|
|
# Minimum setup required to have any CMakeList.txt build as as a standalone
|
|
|
|
# project after importing BuildInternals
|
|
|
|
macro(qt_prepare_standalone_project)
|
|
|
|
qt_set_up_build_internals_paths()
|
|
|
|
qt_build_internals_set_up_private_api()
|
|
|
|
qt_enable_cmake_languages()
|
|
|
|
endmacro()
|
|
|
|
|
2021-05-06 14:27:48 +00:00
|
|
|
# Define a repo target set, and store accompanying information.
|
|
|
|
#
|
|
|
|
# A repo target set is a subset of targets in a Qt module repository. To build a repo target set,
|
|
|
|
# set QT_BUILD_SINGLE_REPO_TARGET_SET to the name of the repo target set.
|
|
|
|
#
|
|
|
|
# This function is to be called in the top-level project file of a repository,
|
|
|
|
# before qt_internal_prepare_single_repo_target_set_build()
|
|
|
|
#
|
|
|
|
# This function stores information in variables of the parent scope.
|
|
|
|
#
|
|
|
|
# Positional Arguments:
|
|
|
|
# name - The name of this repo target set.
|
|
|
|
#
|
|
|
|
# Named Arguments:
|
|
|
|
# DEPENDS - List of Qt6 COMPONENTS that are build dependencies of this repo target set.
|
|
|
|
function(qt_internal_define_repo_target_set name)
|
|
|
|
set(oneValueArgs DEPENDS)
|
|
|
|
set(prefix QT_REPO_TARGET_SET_)
|
|
|
|
cmake_parse_arguments(${prefix}${name} "" ${oneValueArgs} "" ${ARGN})
|
|
|
|
foreach(arg IN LISTS oneValueArgs)
|
|
|
|
set(${prefix}${name}_${arg} ${${prefix}${name}_${arg}} PARENT_SCOPE)
|
|
|
|
endforeach()
|
|
|
|
set(QT_REPO_KNOWN_TARGET_SETS "${QT_REPO_KNOWN_TARGET_SETS};${name}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Setup a single repo target set build if QT_BUILD_SINGLE_REPO_TARGET_SET is defined.
|
|
|
|
#
|
|
|
|
# This macro must be called in the top-level project file of the repository after all repo target
|
|
|
|
# sets have been defined.
|
|
|
|
macro(qt_internal_prepare_single_repo_target_set_build)
|
|
|
|
if(DEFINED QT_BUILD_SINGLE_REPO_TARGET_SET)
|
|
|
|
if(NOT QT_BUILD_SINGLE_REPO_TARGET_SET IN_LIST QT_REPO_KNOWN_TARGET_SETS)
|
|
|
|
message(FATAL_ERROR
|
|
|
|
"Repo target set '${QT_BUILD_SINGLE_REPO_TARGET_SET}' is undefined.")
|
|
|
|
endif()
|
|
|
|
message(STATUS
|
|
|
|
"Preparing single repo target set build of ${QT_BUILD_SINGLE_REPO_TARGET_SET}")
|
|
|
|
if (NOT "${QT_REPO_TARGET_SET_${QT_BUILD_SINGLE_REPO_TARGET_SET}_DEPENDS}" STREQUAL "")
|
|
|
|
find_package(${INSTALL_CMAKE_NAMESPACE} ${PROJECT_VERSION} CONFIG REQUIRED
|
|
|
|
COMPONENTS ${QT_REPO_TARGET_SET_${QT_BUILD_SINGLE_REPO_TARGET_SET}_DEPENDS})
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
endmacro()
|
|
|
|
|
2020-03-18 18:09:00 +00:00
|
|
|
macro(qt_build_repo_begin)
|
2023-08-18 13:48:21 +00:00
|
|
|
set(QT_INTERNAL_REPO_POST_PROCESS_CALLED FALSE)
|
2022-10-25 14:48:21 +00:00
|
|
|
list(APPEND CMAKE_MESSAGE_CONTEXT "${PROJECT_NAME}")
|
|
|
|
|
2020-03-18 18:09:00 +00:00
|
|
|
qt_build_internals_set_up_private_api()
|
2021-09-08 07:30:11 +00:00
|
|
|
|
|
|
|
# Prevent installation in non-prefix builds.
|
|
|
|
# We need to associate targets with export names, and that is only possible to do with the
|
|
|
|
# install(TARGETS) command. But in a non-prefix build, we don't want to install anything.
|
|
|
|
# To make sure that developers don't accidentally run make install, add bail out code to
|
|
|
|
# cmake_install.cmake.
|
|
|
|
if(NOT QT_WILL_INSTALL)
|
|
|
|
# In a top-level build, print a message only in qtbase, which is the first repository.
|
|
|
|
if(NOT QT_SUPERBUILD OR (PROJECT_NAME STREQUAL "QtBase"))
|
|
|
|
install(CODE [[message(FATAL_ERROR
|
|
|
|
"Qt was configured as non-prefix build. "
|
|
|
|
"Installation is not supported for this arrangement.")]])
|
|
|
|
endif()
|
|
|
|
|
|
|
|
install(CODE [[return()]])
|
|
|
|
endif()
|
|
|
|
|
2020-04-03 12:23:18 +00:00
|
|
|
qt_enable_cmake_languages()
|
2019-09-19 07:38:09 +00:00
|
|
|
|
2022-03-21 15:33:56 +00:00
|
|
|
qt_internal_generate_binary_strip_wrapper()
|
|
|
|
|
2020-03-18 15:07:44 +00:00
|
|
|
# Add global docs targets that will work both for per-repo builds, and super builds.
|
|
|
|
if(NOT TARGET docs)
|
|
|
|
add_custom_target(docs)
|
|
|
|
add_custom_target(prepare_docs)
|
|
|
|
add_custom_target(generate_docs)
|
|
|
|
add_custom_target(html_docs)
|
|
|
|
add_custom_target(qch_docs)
|
2020-10-27 09:35:07 +00:00
|
|
|
add_custom_target(install_html_docs)
|
|
|
|
add_custom_target(install_qch_docs)
|
|
|
|
add_custom_target(install_docs)
|
|
|
|
add_dependencies(html_docs generate_docs)
|
|
|
|
add_dependencies(docs html_docs qch_docs)
|
|
|
|
add_dependencies(install_docs install_html_docs install_qch_docs)
|
2020-03-18 15:07:44 +00:00
|
|
|
endif()
|
2019-09-19 07:38:09 +00:00
|
|
|
|
2022-08-15 16:29:41 +00:00
|
|
|
if(NOT TARGET sync_headers)
|
|
|
|
add_custom_target(sync_headers)
|
|
|
|
endif()
|
|
|
|
|
2023-06-08 14:20:47 +00:00
|
|
|
# The special target that we use to sync 3rd-party headers before the gn run when building
|
|
|
|
# qtwebengine in top-level builds.
|
|
|
|
if(NOT TARGET thirdparty_sync_headers)
|
|
|
|
add_custom_target(thirdparty_sync_headers)
|
|
|
|
endif()
|
|
|
|
|
2020-10-19 17:34:53 +00:00
|
|
|
# Add global qt_plugins, qpa_plugins and qpa_default_plugins convenience custom targets.
|
|
|
|
# Internal executables will add a dependency on the qpa_default_plugins target,
|
|
|
|
# so that building and running a test ensures it won't fail at runtime due to a missing qpa
|
|
|
|
# plugin.
|
|
|
|
if(NOT TARGET qt_plugins)
|
|
|
|
add_custom_target(qt_plugins)
|
|
|
|
add_custom_target(qpa_plugins)
|
|
|
|
add_custom_target(qpa_default_plugins)
|
|
|
|
endif()
|
|
|
|
|
2019-09-19 07:38:09 +00:00
|
|
|
string(TOLOWER ${PROJECT_NAME} project_name_lower)
|
|
|
|
|
2023-02-06 15:51:40 +00:00
|
|
|
# Target to build all plugins that are part of the current repo.
|
|
|
|
set(qt_repo_plugins "qt_plugins_${project_name_lower}")
|
|
|
|
if(NOT TARGET ${qt_repo_plugins})
|
|
|
|
add_custom_target(${qt_repo_plugins})
|
|
|
|
endif()
|
|
|
|
|
|
|
|
# Target to build all plugins that are part of the current repo and the current repo's
|
|
|
|
# dependencies plugins. Used for external project example dependencies.
|
|
|
|
set(qt_repo_plugins_recursive "${qt_repo_plugins}_recursive")
|
|
|
|
if(NOT TARGET ${qt_repo_plugins_recursive})
|
|
|
|
add_custom_target(${qt_repo_plugins_recursive})
|
|
|
|
add_dependencies(${qt_repo_plugins_recursive} "${qt_repo_plugins}")
|
|
|
|
endif()
|
|
|
|
|
|
|
|
qt_internal_read_repo_dependencies(qt_repo_deps "${PROJECT_SOURCE_DIR}")
|
|
|
|
if(qt_repo_deps)
|
|
|
|
foreach(qt_repo_dep IN LISTS qt_repo_deps)
|
|
|
|
if(TARGET qt_plugins_${qt_repo_dep})
|
|
|
|
message(DEBUG
|
|
|
|
"${qt_repo_plugins_recursive} depends on qt_plugins_${qt_repo_dep}")
|
|
|
|
add_dependencies(${qt_repo_plugins_recursive} "qt_plugins_${qt_repo_dep}")
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
endif()
|
|
|
|
|
2020-11-17 23:36:44 +00:00
|
|
|
set(qt_repo_targets_name ${project_name_lower})
|
2019-09-19 07:38:09 +00:00
|
|
|
set(qt_docs_target_name docs_${project_name_lower})
|
|
|
|
set(qt_docs_prepare_target_name prepare_docs_${project_name_lower})
|
|
|
|
set(qt_docs_generate_target_name generate_docs_${project_name_lower})
|
|
|
|
set(qt_docs_html_target_name html_docs_${project_name_lower})
|
|
|
|
set(qt_docs_qch_target_name qch_docs_${project_name_lower})
|
|
|
|
set(qt_docs_install_html_target_name install_html_docs_${project_name_lower})
|
|
|
|
set(qt_docs_install_qch_target_name install_qch_docs_${project_name_lower})
|
|
|
|
set(qt_docs_install_target_name install_docs_${project_name_lower})
|
|
|
|
|
|
|
|
add_custom_target(${qt_docs_target_name})
|
|
|
|
add_custom_target(${qt_docs_prepare_target_name})
|
|
|
|
add_custom_target(${qt_docs_generate_target_name})
|
|
|
|
add_custom_target(${qt_docs_qch_target_name})
|
|
|
|
add_custom_target(${qt_docs_html_target_name})
|
|
|
|
add_custom_target(${qt_docs_install_html_target_name})
|
|
|
|
add_custom_target(${qt_docs_install_qch_target_name})
|
|
|
|
add_custom_target(${qt_docs_install_target_name})
|
|
|
|
|
|
|
|
add_dependencies(${qt_docs_generate_target_name} ${qt_docs_prepare_target_name})
|
|
|
|
add_dependencies(${qt_docs_html_target_name} ${qt_docs_generate_target_name})
|
2020-10-27 09:35:07 +00:00
|
|
|
add_dependencies(${qt_docs_target_name} ${qt_docs_html_target_name} ${qt_docs_qch_target_name})
|
2019-09-19 07:38:09 +00:00
|
|
|
add_dependencies(${qt_docs_install_target_name} ${qt_docs_install_html_target_name} ${qt_docs_install_qch_target_name})
|
2020-03-18 15:07:44 +00:00
|
|
|
|
2020-10-27 09:35:07 +00:00
|
|
|
# Make top-level prepare_docs target depend on the repository-level prepare_docs_<repo> target.
|
2020-03-18 15:07:44 +00:00
|
|
|
add_dependencies(prepare_docs ${qt_docs_prepare_target_name})
|
2020-06-26 13:06:00 +00:00
|
|
|
|
2020-11-05 09:32:30 +00:00
|
|
|
# Make top-level install_*_docs targets depend on the repository-level install_*_docs targets.
|
|
|
|
add_dependencies(install_html_docs ${qt_docs_install_html_target_name})
|
|
|
|
add_dependencies(install_qch_docs ${qt_docs_install_qch_target_name})
|
|
|
|
|
2020-06-26 13:06:00 +00:00
|
|
|
# Add host_tools meta target, so that developrs can easily build only tools and their
|
|
|
|
# dependencies when working in qtbase.
|
|
|
|
if(NOT TARGET host_tools)
|
|
|
|
add_custom_target(host_tools)
|
|
|
|
add_custom_target(bootstrap_tools)
|
|
|
|
endif()
|
2020-12-03 18:13:08 +00:00
|
|
|
|
|
|
|
# Add benchmark meta target. It's collection of all benchmarks added/registered by
|
|
|
|
# 'qt_internal_add_benchmark' helper.
|
|
|
|
if(NOT TARGET benchmark)
|
|
|
|
add_custom_target(benchmark)
|
|
|
|
endif()
|
2022-08-15 16:29:41 +00:00
|
|
|
|
|
|
|
if(QT_INTERNAL_SYNCED_MODULES)
|
|
|
|
set_property(GLOBAL PROPERTY _qt_synced_modules ${QT_INTERNAL_SYNCED_MODULES})
|
|
|
|
endif()
|
2019-05-15 11:57:15 +00:00
|
|
|
endmacro()
|
|
|
|
|
2023-08-18 13:48:21 +00:00
|
|
|
# Runs delayed actions on some of the Qt targets.
|
|
|
|
# Can be called either explicitly or as part of qt_build_repo_end().
|
|
|
|
macro(qt_build_repo_post_process)
|
2023-08-24 09:32:53 +00:00
|
|
|
if(NOT QT_INTERNAL_REPO_POST_PROCESS_CALLED)
|
|
|
|
set(QT_INTERNAL_REPO_POST_PROCESS_CALLED TRUE)
|
|
|
|
if(NOT QT_BUILD_STANDALONE_TESTS)
|
|
|
|
include(QtPostProcess)
|
|
|
|
endif()
|
2023-08-18 13:48:21 +00:00
|
|
|
endif()
|
|
|
|
endmacro()
|
|
|
|
|
|
|
|
macro(qt_build_repo_end)
|
|
|
|
if(NOT QT_BUILD_STANDALONE_TESTS)
|
|
|
|
qt_build_repo_post_process()
|
2019-11-01 10:48:23 +00:00
|
|
|
|
|
|
|
# Install the repo-specific cmake find modules.
|
|
|
|
qt_path_join(__qt_repo_install_dir ${QT_CONFIG_INSTALL_DIR} ${INSTALL_CMAKE_NAMESPACE})
|
2021-08-10 13:19:53 +00:00
|
|
|
qt_path_join(__qt_repo_build_dir ${QT_CONFIG_BUILD_DIR} ${INSTALL_CMAKE_NAMESPACE})
|
2019-11-01 10:48:23 +00:00
|
|
|
|
|
|
|
if(NOT PROJECT_NAME STREQUAL "QtBase")
|
2021-03-16 14:13:15 +00:00
|
|
|
if(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
|
2019-11-01 10:48:23 +00:00
|
|
|
qt_copy_or_install(DIRECTORY cmake/
|
|
|
|
DESTINATION "${__qt_repo_install_dir}"
|
|
|
|
FILES_MATCHING PATTERN "Find*.cmake"
|
|
|
|
)
|
2021-08-10 13:19:53 +00:00
|
|
|
if(QT_SUPERBUILD AND QT_WILL_INSTALL)
|
|
|
|
file(COPY cmake/
|
|
|
|
DESTINATION "${__qt_repo_build_dir}"
|
|
|
|
FILES_MATCHING PATTERN "Find*.cmake"
|
|
|
|
)
|
|
|
|
endif()
|
2019-11-01 10:48:23 +00:00
|
|
|
endif()
|
2019-06-05 14:26:42 +00:00
|
|
|
endif()
|
2019-05-20 07:46:38 +00:00
|
|
|
|
2019-11-21 12:33:28 +00:00
|
|
|
if(NOT QT_SUPERBUILD)
|
|
|
|
qt_print_feature_summary()
|
|
|
|
endif()
|
2019-09-17 14:05:50 +00:00
|
|
|
endif()
|
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
qt_build_internals_add_toplevel_targets()
|
|
|
|
|
2019-11-21 12:33:28 +00:00
|
|
|
if(NOT QT_SUPERBUILD)
|
|
|
|
qt_print_build_instructions()
|
2019-09-17 14:05:50 +00:00
|
|
|
endif()
|
2022-08-15 16:29:41 +00:00
|
|
|
|
|
|
|
get_property(synced_modules GLOBAL PROPERTY _qt_synced_modules)
|
|
|
|
if(synced_modules)
|
|
|
|
set(QT_INTERNAL_SYNCED_MODULES ${synced_modules} CACHE INTERNAL
|
|
|
|
"List of the synced modules. Prevents running syncqt.cpp after the first configuring.")
|
|
|
|
endif()
|
2022-10-25 14:48:21 +00:00
|
|
|
|
2022-09-27 16:20:49 +00:00
|
|
|
if(NOT QT_SUPERBUILD)
|
2023-04-28 15:27:48 +00:00
|
|
|
qt_internal_save_previously_visited_packages()
|
2022-09-27 16:20:49 +00:00
|
|
|
endif()
|
|
|
|
|
2022-11-11 13:48:57 +00:00
|
|
|
if(QT_INTERNAL_FRESH_REQUESTED)
|
|
|
|
set(QT_INTERNAL_FRESH_REQUESTED "FALSE" CACHE INTERNAL "")
|
|
|
|
endif()
|
|
|
|
|
CMake: Rework INPUT_foo vars handling when reconfiguring
To be able to reconfigure Qt with modified feature values using the
configure script, and take into account INPUT_foo values, we need to
ignore FEATURE_foo values. But we can't always ignore FEATURE_foo
values, because users might want to toggle them by editing
CMakeCache.txt or using an IDE.
What we can do is tell CMake we are configuring via the configure
script, in which case we can mostly be sure that any passed
INPUT_foo values should have higher priority than pre-cached
FEATURE_foo values.
We also need to remove all the cached INPUT_foo variables after they
have been used for feature computation, so that subsequent
reconfigurations where an INPUT_foo is not passed anymore, doesn't
cause a feature to accidentally reuse the previous (stale) value.
Pass -DQT_INTERNAL_CALLED_FROM_CONFIGURE=TRUE to CMake when configuring
via the configure script, and use that as a marker to make INPUT_foo
values have a higher priority.
This needs to be done centrally in qt_evaluate_feature and also in a
few more locations where we check INPUT_ values, like the developer
build and pkgconfig features.
Because QT_INTERNAL_CALLED_FROM_CONFIGURE would become a cached
variable, we want to remove it at the end of the configuration phase,
so that future 'cmake .' reconfigurations are not considered to be done
via configure.
To do that, we unset it right at the end of
qt_build_repo_end in a per-repo build, and in the final
qt_print_build_instructions call in a top-level build.
The latter needs a cleaner fix in follow up commits in qt5.git and
qtbase.
Pick-to: 6.6
Task-number: QTBUG-112957
Change-Id: I3fd338092041ef09e3f5a4dfbaf61da5deea0514
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-25 15:32:19 +00:00
|
|
|
if(NOT QT_SUPERBUILD)
|
|
|
|
qt_internal_qt_configure_end()
|
|
|
|
endif()
|
|
|
|
|
2022-10-25 14:48:21 +00:00
|
|
|
list(POP_BACK CMAKE_MESSAGE_CONTEXT)
|
2019-11-21 12:33:28 +00:00
|
|
|
endmacro()
|
2019-09-17 14:05:50 +00:00
|
|
|
|
CMake: Rework INPUT_foo vars handling when reconfiguring
To be able to reconfigure Qt with modified feature values using the
configure script, and take into account INPUT_foo values, we need to
ignore FEATURE_foo values. But we can't always ignore FEATURE_foo
values, because users might want to toggle them by editing
CMakeCache.txt or using an IDE.
What we can do is tell CMake we are configuring via the configure
script, in which case we can mostly be sure that any passed
INPUT_foo values should have higher priority than pre-cached
FEATURE_foo values.
We also need to remove all the cached INPUT_foo variables after they
have been used for feature computation, so that subsequent
reconfigurations where an INPUT_foo is not passed anymore, doesn't
cause a feature to accidentally reuse the previous (stale) value.
Pass -DQT_INTERNAL_CALLED_FROM_CONFIGURE=TRUE to CMake when configuring
via the configure script, and use that as a marker to make INPUT_foo
values have a higher priority.
This needs to be done centrally in qt_evaluate_feature and also in a
few more locations where we check INPUT_ values, like the developer
build and pkgconfig features.
Because QT_INTERNAL_CALLED_FROM_CONFIGURE would become a cached
variable, we want to remove it at the end of the configuration phase,
so that future 'cmake .' reconfigurations are not considered to be done
via configure.
To do that, we unset it right at the end of
qt_build_repo_end in a per-repo build, and in the final
qt_print_build_instructions call in a top-level build.
The latter needs a cleaner fix in follow up commits in qt5.git and
qtbase.
Pick-to: 6.6
Task-number: QTBUG-112957
Change-Id: I3fd338092041ef09e3f5a4dfbaf61da5deea0514
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-25 15:32:19 +00:00
|
|
|
# Function called either at the end of per-repo configuration, or at the end of configuration of
|
|
|
|
# a super build.
|
|
|
|
# At the moment it is called before examples are configured in a per-repo build. We might want
|
|
|
|
# to change that at some point if needed.
|
|
|
|
function(qt_internal_qt_configure_end)
|
|
|
|
# If Qt is configued via the configure script, remove the marker variable, so that any future
|
|
|
|
# reconfigurations that are done by calling cmake directly don't trigger configure specific
|
|
|
|
# logic.
|
|
|
|
unset(QT_INTERNAL_CALLED_FROM_CONFIGURE CACHE)
|
|
|
|
endfunction()
|
|
|
|
|
2019-05-21 07:04:27 +00:00
|
|
|
macro(qt_build_repo)
|
|
|
|
qt_build_repo_begin(${ARGN})
|
|
|
|
|
2021-05-06 13:21:44 +00:00
|
|
|
qt_build_repo_impl_find_package_tests()
|
|
|
|
qt_build_repo_impl_src()
|
|
|
|
qt_build_repo_impl_tools()
|
2023-08-18 13:48:21 +00:00
|
|
|
|
|
|
|
qt_build_repo_post_process()
|
2021-05-06 13:21:44 +00:00
|
|
|
qt_build_repo_impl_tests()
|
|
|
|
|
|
|
|
qt_build_repo_end()
|
|
|
|
|
|
|
|
qt_build_repo_impl_examples()
|
|
|
|
endmacro()
|
|
|
|
|
|
|
|
macro(qt_build_repo_impl_find_package_tests)
|
2019-06-13 13:35:26 +00:00
|
|
|
# If testing is enabled, try to find the qtbase Test package.
|
|
|
|
# Do this before adding src, because there might be test related conditions
|
|
|
|
# in source.
|
2020-10-19 11:35:15 +00:00
|
|
|
if (QT_BUILD_TESTS AND NOT QT_BUILD_STANDALONE_TESTS)
|
CMake: Record used package version for each target dependency
When recording which package version to look for in
QtFooModuleDependencies.cmake and other files like it,
instead of using PROJECT_VERSION, use the version of the
package that contains the dependency.
For example if we're hypothetically building the qtdeclarative repo
from the 6.4 branch, against an installed 6.2 qtbase, then
the Qt6QmlModuleDependencies.cmake file will have a
find_package(Qt6Core 6.2) call because qtdeclarative's
find_package(Qt6Core) call found a 6.2 Core when it was configured.
This allows switching the versioning scheme of specific Qt modules
that might not want to follow the general Qt versioning scheme.
The first candidate would be QtWebEngine which might want to
follow the Chromium versioning scheme, something like
Qt 6.94.0 where 94 is the Chromium major version.
Implementation notes.
We now record the package version of a target in a property
called _qt_package_version. We do it for qt modules, plugins,
3rd party libraries, tools and the Platform target.
When we try to look up which version to write into the
QtFooModuleDependencies.cmake file (or the equivalent Plugins and
Tools file), we try to find the version
from a few sources: the property mentioned above, then the
Qt6{target}_VERSION variable, and finally PROJECT_VERSION.
In the latter case, we issue a warning because technically that should
never have to happen, and it's a bug or an unforeseen case if it does.
A few more places also need adjustments:
- package versions to look for when configuring standalone
tests and generating standalone tests Config files
- handling of tools packages
- The main Qt6 package lookup in each Dependencies.cmake files
Note that there are some requirements and consequences in case a
module wants to use a different versioning scheme like 6.94.0.
Requirements.
- The root CMakeLists.txt file needs to call find_package with a
version different from the usual PROJECT_VERSION. Ideally it
should look for a few different Qt versions which are known to be
compatible, for example the last stable and LTS versions, or just
the lowest supported Qt version, e.g. 6.2.6 or whenever this change
would land in the 6.2 branch.
- If the repository has multiple modules, some of which need to
follow the Qt versioning scheme and some not,
project(VERSION x.y.z) calls need to be carefully placed in
subdirectory scopes with appropriate version numbers, so that
qt_internal_add_module / _tool / _plugin pick up the correct
version.
Consequences.
- The .so / .dylib names will contain the new version, e.g. .so.6.94
- Linux ELF symbols will contain the new versions
- syncqt private headers will now exist under a
include/QtFoo/6.94.0/QtFoo/private folder
- pri and prl files will also contain the new version numbers
- pkg-config .pc files contain the new version numbers
- It won't be possible to write
find_package(Qt6 6.94 COMPONENTS WebEngineWidgets) in user code.
One would have to write find_package(Qt6WebEngineWidgets 6.94)
otherwise CMake will try to look for Qt6Config 6.94 which won't
exist.
- Similarly, a
find_package(Qt6 6.4 COMPONENTS Widgets WebEngineWidgets) call
would always find any kind of WebEngine package that is higher than
6.4, which might be 6.94, 6.95, etc.
- In the future, if we fix Qt6Config to pass EXACT to its
subcomponent find_package calls,
a find_package(Qt6 6.5.0 EXACT COMPONENTS Widgets WebEngineWidgets)
would fail to find WebEngineWidgets, because its 6.94.0 version
will not be equal to 6.5.0. Currently we don't pass through EXACT,
so it's not an issue.
Augments 5ffc744b791a114a3180a425dd26e298f7399955
Task-number: QTBUG-103500
Change-Id: I8bdb56bfcbc7f7f6484d1e56651ffc993fd30bab
Reviewed-by: Michal Klocek <michal.klocek@qt.io>
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-05-17 06:44:43 +00:00
|
|
|
# When looking for the Test package, do it using the Qt6 package version, in case if
|
|
|
|
# PROJECT_VERSION is following a different versioning scheme.
|
|
|
|
if(Qt6_VERSION)
|
|
|
|
set(_qt_build_repo_impl_find_package_tests_version "${Qt6_VERSION}")
|
|
|
|
else()
|
|
|
|
set(_qt_build_repo_impl_find_package_tests_version "${PROJECT_VERSION}")
|
|
|
|
endif()
|
|
|
|
|
|
|
|
find_package(Qt6
|
|
|
|
"${_qt_build_repo_impl_find_package_tests_version}"
|
|
|
|
CONFIG REQUIRED COMPONENTS Test)
|
|
|
|
unset(_qt_build_repo_impl_find_package_tests_version)
|
2019-06-13 13:35:26 +00:00
|
|
|
endif()
|
2021-05-06 13:21:44 +00:00
|
|
|
endmacro()
|
2019-06-13 13:35:26 +00:00
|
|
|
|
2021-05-06 13:21:44 +00:00
|
|
|
macro(qt_build_repo_impl_src)
|
2019-11-01 10:48:23 +00:00
|
|
|
if(NOT QT_BUILD_STANDALONE_TESTS)
|
|
|
|
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/src/CMakeLists.txt")
|
|
|
|
add_subdirectory(src)
|
|
|
|
endif()
|
2021-05-06 13:21:44 +00:00
|
|
|
endif()
|
2022-11-17 07:06:45 +00:00
|
|
|
if(QT_FEATURE_lttng AND NOT TARGET LTTng::UST)
|
|
|
|
qt_find_package(LTTngUST PROVIDED_TARGETS LTTng::UST
|
|
|
|
MODULE_NAME global QMAKE_LIB lttng-ust)
|
|
|
|
endif()
|
2021-05-06 13:21:44 +00:00
|
|
|
endmacro()
|
2019-05-21 07:04:27 +00:00
|
|
|
|
2021-05-06 13:21:44 +00:00
|
|
|
macro(qt_build_repo_impl_tools)
|
|
|
|
if(NOT QT_BUILD_STANDALONE_TESTS)
|
2019-11-01 10:48:23 +00:00
|
|
|
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/tools/CMakeLists.txt")
|
|
|
|
add_subdirectory(tools)
|
|
|
|
endif()
|
2019-06-05 14:10:59 +00:00
|
|
|
endif()
|
2021-05-06 13:21:44 +00:00
|
|
|
endmacro()
|
2019-06-05 14:10:59 +00:00
|
|
|
|
2021-05-06 13:21:44 +00:00
|
|
|
macro(qt_build_repo_impl_tests)
|
2020-10-19 11:35:15 +00:00
|
|
|
if (QT_BUILD_TESTS AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/tests/CMakeLists.txt")
|
2019-05-21 07:04:27 +00:00
|
|
|
add_subdirectory(tests)
|
2020-10-19 11:35:15 +00:00
|
|
|
if(NOT QT_BUILD_TESTS_BY_DEFAULT)
|
2019-11-04 13:43:39 +00:00
|
|
|
set_property(DIRECTORY tests PROPERTY EXCLUDE_FROM_ALL TRUE)
|
|
|
|
endif()
|
2019-05-21 07:04:27 +00:00
|
|
|
endif()
|
2021-05-06 13:21:44 +00:00
|
|
|
endmacro()
|
2019-05-21 07:04:27 +00:00
|
|
|
|
2021-05-06 13:21:44 +00:00
|
|
|
macro(qt_build_repo_impl_examples)
|
2021-05-24 06:35:39 +00:00
|
|
|
if(QT_BUILD_EXAMPLES
|
2019-11-01 10:48:23 +00:00
|
|
|
AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/examples/CMakeLists.txt"
|
|
|
|
AND NOT QT_BUILD_STANDALONE_TESTS)
|
2023-02-06 16:02:13 +00:00
|
|
|
message(STATUS "Configuring examples.")
|
2019-05-24 17:18:21 +00:00
|
|
|
add_subdirectory(examples)
|
2019-05-21 07:04:27 +00:00
|
|
|
endif()
|
|
|
|
endmacro()
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
|
|
|
|
macro(qt_set_up_standalone_tests_build)
|
2019-11-01 10:48:23 +00:00
|
|
|
# Remove this macro once all usages of it have been removed.
|
|
|
|
# Standalone tests are not handled via the main repo project and qt_build_tests.
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
endmacro()
|
|
|
|
|
2021-07-07 04:20:32 +00:00
|
|
|
function(qt_get_standalone_tests_config_files_path out_var)
|
2020-03-18 18:09:00 +00:00
|
|
|
set(path "${QT_CONFIG_INSTALL_DIR}/${INSTALL_CMAKE_NAMESPACE}BuildInternals/StandaloneTests")
|
2020-06-04 16:21:13 +00:00
|
|
|
|
|
|
|
# QT_CONFIG_INSTALL_DIR is relative in prefix builds.
|
|
|
|
if(QT_WILL_INSTALL)
|
2020-12-08 15:24:15 +00:00
|
|
|
if(DEFINED CMAKE_STAGING_PREFIX)
|
|
|
|
qt_path_join(path "${CMAKE_STAGING_PREFIX}" "${path}")
|
|
|
|
else()
|
|
|
|
qt_path_join(path "${CMAKE_INSTALL_PREFIX}" "${path}")
|
|
|
|
endif()
|
2020-06-04 16:21:13 +00:00
|
|
|
endif()
|
|
|
|
|
2020-03-18 18:09:00 +00:00
|
|
|
set("${out_var}" "${path}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
2021-09-07 16:43:20 +00:00
|
|
|
function(qt_internal_get_standalone_tests_config_file_name out_var)
|
|
|
|
# When doing a "single repo target set" build (like in qtscxqml) ensure we use a unique tests
|
|
|
|
# config file for each repo target set. Using the PROJECT_NAME only is not enough because
|
|
|
|
# the same file will be overridden with different content on each repo set install.
|
|
|
|
set(tests_config_file_name "${PROJECT_NAME}")
|
|
|
|
|
|
|
|
if(QT_BUILD_SINGLE_REPO_TARGET_SET)
|
|
|
|
string(APPEND tests_config_file_name "RepoSet${QT_BUILD_SINGLE_REPO_TARGET_SET}")
|
|
|
|
endif()
|
|
|
|
string(APPEND tests_config_file_name "TestsConfig.cmake")
|
|
|
|
|
|
|
|
set(${out_var} "${tests_config_file_name}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
macro(qt_build_tests)
|
2023-03-09 13:53:14 +00:00
|
|
|
set(CMAKE_UNITY_BUILD OFF)
|
|
|
|
|
2023-08-23 08:11:15 +00:00
|
|
|
# Prepending to QT_BUILD_CMAKE_PREFIX_PATH helps find components of Qt6, because those
|
2023-08-18 15:33:21 +00:00
|
|
|
# find_package calls use NO_DEFAULT_PATH, and thus CMAKE_PREFIX_PATH is ignored.
|
2023-08-22 17:11:30 +00:00
|
|
|
list(PREPEND CMAKE_FIND_ROOT_PATH "${QT_BUILD_DIR}")
|
2023-08-23 08:11:15 +00:00
|
|
|
list(PREPEND QT_BUILD_CMAKE_PREFIX_PATH "${QT_BUILD_DIR}/${INSTALL_LIBDIR}/cmake")
|
2023-08-18 15:33:21 +00:00
|
|
|
|
2019-11-01 10:48:23 +00:00
|
|
|
if(QT_BUILD_STANDALONE_TESTS)
|
|
|
|
# Find location of TestsConfig.cmake. These contain the modules that need to be
|
|
|
|
# find_package'd when testing.
|
2021-07-07 04:20:32 +00:00
|
|
|
qt_get_standalone_tests_config_files_path(_qt_build_tests_install_prefix)
|
2021-09-07 16:43:20 +00:00
|
|
|
|
|
|
|
qt_internal_get_standalone_tests_config_file_name(_qt_tests_config_file_name)
|
|
|
|
set(_qt_standalone_tests_config_file_path
|
|
|
|
"${_qt_build_tests_install_prefix}/${_qt_tests_config_file_name}")
|
|
|
|
include("${_qt_standalone_tests_config_file_path}"
|
|
|
|
OPTIONAL
|
|
|
|
RESULT_VARIABLE _qt_standalone_tests_included)
|
|
|
|
if(NOT _qt_standalone_tests_included)
|
|
|
|
message(DEBUG
|
|
|
|
"Standalone tests config file not included because it does not exist: "
|
|
|
|
"${_qt_standalone_tests_config_file_path}"
|
|
|
|
)
|
|
|
|
else()
|
|
|
|
message(DEBUG
|
|
|
|
"Standalone tests config file included successfully: "
|
|
|
|
"${_qt_standalone_tests_config_file_path}"
|
|
|
|
)
|
|
|
|
endif()
|
|
|
|
|
|
|
|
unset(_qt_standalone_tests_config_file_path)
|
|
|
|
unset(_qt_standalone_tests_included)
|
|
|
|
unset(_qt_tests_config_file_name)
|
2019-11-01 10:48:23 +00:00
|
|
|
|
|
|
|
# Of course we always need the test module as well.
|
CMake: Record used package version for each target dependency
When recording which package version to look for in
QtFooModuleDependencies.cmake and other files like it,
instead of using PROJECT_VERSION, use the version of the
package that contains the dependency.
For example if we're hypothetically building the qtdeclarative repo
from the 6.4 branch, against an installed 6.2 qtbase, then
the Qt6QmlModuleDependencies.cmake file will have a
find_package(Qt6Core 6.2) call because qtdeclarative's
find_package(Qt6Core) call found a 6.2 Core when it was configured.
This allows switching the versioning scheme of specific Qt modules
that might not want to follow the general Qt versioning scheme.
The first candidate would be QtWebEngine which might want to
follow the Chromium versioning scheme, something like
Qt 6.94.0 where 94 is the Chromium major version.
Implementation notes.
We now record the package version of a target in a property
called _qt_package_version. We do it for qt modules, plugins,
3rd party libraries, tools and the Platform target.
When we try to look up which version to write into the
QtFooModuleDependencies.cmake file (or the equivalent Plugins and
Tools file), we try to find the version
from a few sources: the property mentioned above, then the
Qt6{target}_VERSION variable, and finally PROJECT_VERSION.
In the latter case, we issue a warning because technically that should
never have to happen, and it's a bug or an unforeseen case if it does.
A few more places also need adjustments:
- package versions to look for when configuring standalone
tests and generating standalone tests Config files
- handling of tools packages
- The main Qt6 package lookup in each Dependencies.cmake files
Note that there are some requirements and consequences in case a
module wants to use a different versioning scheme like 6.94.0.
Requirements.
- The root CMakeLists.txt file needs to call find_package with a
version different from the usual PROJECT_VERSION. Ideally it
should look for a few different Qt versions which are known to be
compatible, for example the last stable and LTS versions, or just
the lowest supported Qt version, e.g. 6.2.6 or whenever this change
would land in the 6.2 branch.
- If the repository has multiple modules, some of which need to
follow the Qt versioning scheme and some not,
project(VERSION x.y.z) calls need to be carefully placed in
subdirectory scopes with appropriate version numbers, so that
qt_internal_add_module / _tool / _plugin pick up the correct
version.
Consequences.
- The .so / .dylib names will contain the new version, e.g. .so.6.94
- Linux ELF symbols will contain the new versions
- syncqt private headers will now exist under a
include/QtFoo/6.94.0/QtFoo/private folder
- pri and prl files will also contain the new version numbers
- pkg-config .pc files contain the new version numbers
- It won't be possible to write
find_package(Qt6 6.94 COMPONENTS WebEngineWidgets) in user code.
One would have to write find_package(Qt6WebEngineWidgets 6.94)
otherwise CMake will try to look for Qt6Config 6.94 which won't
exist.
- Similarly, a
find_package(Qt6 6.4 COMPONENTS Widgets WebEngineWidgets) call
would always find any kind of WebEngine package that is higher than
6.4, which might be 6.94, 6.95, etc.
- In the future, if we fix Qt6Config to pass EXACT to its
subcomponent find_package calls,
a find_package(Qt6 6.5.0 EXACT COMPONENTS Widgets WebEngineWidgets)
would fail to find WebEngineWidgets, because its 6.94.0 version
will not be equal to 6.5.0. Currently we don't pass through EXACT,
so it's not an issue.
Augments 5ffc744b791a114a3180a425dd26e298f7399955
Task-number: QTBUG-103500
Change-Id: I8bdb56bfcbc7f7f6484d1e56651ffc993fd30bab
Reviewed-by: Michal Klocek <michal.klocek@qt.io>
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-05-17 06:44:43 +00:00
|
|
|
# When looking for the Test package, do it using the Qt6 package version, in case if
|
|
|
|
# PROJECT_VERSION is following a different versioning scheme.
|
|
|
|
if(Qt6_VERSION)
|
|
|
|
set(_qt_build_tests_package_version "${Qt6_VERSION}")
|
|
|
|
else()
|
|
|
|
set(_qt_build_tests_package_version "${PROJECT_VERSION}")
|
|
|
|
endif()
|
|
|
|
find_package(Qt6 "${_qt_build_tests_package_version}" CONFIG REQUIRED COMPONENTS Test)
|
|
|
|
unset(_qt_build_tests_package_version)
|
2020-02-18 09:59:11 +00:00
|
|
|
|
|
|
|
# Set language standards after finding Core, because that's when the relevant
|
|
|
|
# feature variables are available, and the call in QtSetup is too early when building
|
|
|
|
# standalone tests, because Core was not find_package()'d yet.
|
|
|
|
qt_set_language_standards()
|
2020-04-16 18:30:03 +00:00
|
|
|
|
|
|
|
if(NOT QT_SUPERBUILD)
|
2020-06-04 16:21:13 +00:00
|
|
|
# Set up fake standalone tests install prefix, so we don't pollute the Qt install
|
|
|
|
# prefix. For super builds it needs to be done in qt5/CMakeLists.txt.
|
|
|
|
qt_set_up_fake_standalone_tests_install_prefix()
|
2020-04-16 18:30:03 +00:00
|
|
|
endif()
|
2021-10-13 12:03:53 +00:00
|
|
|
else()
|
|
|
|
if(ANDROID)
|
|
|
|
# When building in-tree tests we need to specify the QT_ANDROID_ABIS list. Since we
|
|
|
|
# build Qt for the single ABI, build tests for this ABI only.
|
|
|
|
set(QT_ANDROID_ABIS "${CMAKE_ANDROID_ARCH_ABI}")
|
|
|
|
endif()
|
2019-11-01 10:48:23 +00:00
|
|
|
endif()
|
|
|
|
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/auto/CMakeLists.txt")
|
|
|
|
add_subdirectory(auto)
|
|
|
|
endif()
|
2022-06-21 13:32:00 +00:00
|
|
|
if(NOT QT_BUILD_MINIMAL_STATIC_TESTS AND NOT QT_BUILD_MINIMAL_ANDROID_MULTI_ABI_TESTS)
|
2021-11-15 12:36:48 +00:00
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/baseline/CMakeLists.txt")
|
|
|
|
add_subdirectory(baseline)
|
|
|
|
endif()
|
2021-03-15 16:03:38 +00:00
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/benchmarks/CMakeLists.txt" AND QT_BUILD_BENCHMARKS)
|
|
|
|
add_subdirectory(benchmarks)
|
|
|
|
endif()
|
|
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/manual/CMakeLists.txt" AND QT_BUILD_MANUAL_TESTS)
|
|
|
|
add_subdirectory(manual)
|
|
|
|
endif()
|
2019-11-08 10:23:04 +00:00
|
|
|
endif()
|
2023-03-09 13:53:14 +00:00
|
|
|
|
|
|
|
set(CMAKE_UNITY_BUILD ${QT_UNITY_BUILD})
|
Allow building the tests directory as a standalone CMake project
At the moment, Coin builds tests as a separate qmake invocation
against an installed Qt. We need to support the same with CMake.
Change the tests subdirectory to be a standalone CMake project when
CMake does not detect an existing QtTest target while processing the
subdirectory. If the target exists, it means we are building the whole
repo, if the target does not exist, we need to call find_package
to find the installed Qt.
Refactor and move around a few things to make standalone tests build
successfully:
- add a new macro to set up paths to find QtSetup
- add a new macro to find all macOS frameworks
- add a new macro to set up building tests
- add a new macro that actually builds the tests
- export the INSTALL_CMAKE_NAMESPACE value into the BuildInternals
Config file
- export the CMAKE_BUILD_TYPE value, because a test project doesn't
have a .git subdir and thus defaults to be built in Release
mode, even though qtbase might have been built in Debug, so to
avoid the mixing, the propagate the build type
- stop overriding INSTALL_CMAKE_NAMESPACE and
QT_CMAKE_EXPORT_NAMESPACE inside QtSetup if they are set, because
the tests project doesn't specify a major version, and if we
override the values, the moc / uic targets don't get the correct
major version prefix and configuration fails
Change-Id: Ibdb03687302567fe325a15f6d1cb922c76240675
Fixes: QTBUG-75090
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2019-05-22 08:22:08 +00:00
|
|
|
endmacro()
|
2019-06-06 11:08:41 +00:00
|
|
|
|
CMake: Make build system of installed Qt more relocatable
Aka handle CMAKE_INSTALL_PREFIX in a more relocatable way.
The following story inspired this change.
If a user wants to build a Qt repo into a different install prefix
than the usual Qt one, this will fail configuration because we
look for various things like syncqt, qdoc, etc relative to
CMAKE_INSTALL_PREFIX, which will now point to a different location
where none of the above tools are located.
The intent for such a use case is to support building Qt packages with
Conan, which sets a random install prefix when configuring a repo.
The idea is to derive the qt prefix dynamically from the
QtBuildInternals package location. Essentially it's a reverse relative
path from the QtBuildInternalsConfig.cmake file to the install prefix
that was specified when initially configuring qtbase.
Once the dynamic prefix is computed (so we know where the possibly
relocated Qt is), we can find tools like syncqt and qdoc.
This is an initial attempt to support a use case like that.
More design work will probably needed in case if tools / libs need to
be found in a location different than the Qt install prefix (so
support for multiple install prefixes / search paths).
An example of such a case would be when building qtdeclarative and
qtquickcontrols2 as Conan packages in one go. Most likely the
qmltyperegistrar tool will be located in the random install prefix
set by Conan, so building qtquickcontrols2 might fail due to not
finding the tool in the original Qt install prefix.
As to the implementation details, the change does the following:
- Dynamically computes and sets the
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX variable when
find_package()'ing QtBuildInternals. It's an absolute path
pointing to where the relocated Qt is.
- When building qtbase this variable is not yet available (due
to QtBuildInternalsExtra not existing), in that case we set
the variable to the absolute path of CMAKE_INSTALL_PREFIX
(but only for the initial qtbase configuration).
- Remove QT_BUILD_INTERNALS_ORIGINAL_INSTALL_PREFIX which was used
for standalone tests purposes. It's not needed now that we compute
the location of the Qt prefix dynamically.
- The Unixy qt-cmake and qt-cmake-private shell scripts now
use a relative path to find the toolchain file we created.
- The toolchain file also dynamically computes the location of the Qt
packages, and adds them to CMAKE_PREFIX_PATH.
- A lot of existing CMAKE_INSTALL_PREFIX uses are replaced with
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX. This includes finding
tool locations, mkspecs dir, path environment setup for tools, etc.
- Some places still use CMAKE_PREFIX_PATH in the following cases
- When determining paths while configuring qtbase (valid cases)
- When I wasn't sure what the behavior should be, so I left them
as-is (an example is documentation generation, do we want to
install it into the random Conan prefix, or into the main prefix?
Currently it installs in the random prefix).
Note that relocating a Qt installation does not work for non-prefix /
non-installed builds, due to hardcoded paths to include directories
and libraries in generated FooTargets.cmake files.
Task-number: QTBUG-83999
Change-Id: I87d6558729db93121b1715771034b03ce3295923
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-05-05 08:30:35 +00:00
|
|
|
function(qt_compute_relative_path_from_cmake_config_dir_to_prefix)
|
|
|
|
# Compute the reverse relative path from the CMake config dir to the install prefix.
|
|
|
|
# This is used in QtBuildInternalsExtras to create a relocatable relative install prefix path.
|
|
|
|
# This path is used for finding syncqt and other things, regardless of initial install prefix
|
|
|
|
# (e.g installed Qt was archived and unpacked to a different path on a different machine).
|
|
|
|
#
|
|
|
|
# This is meant to be called only once when configuring qtbase.
|
|
|
|
#
|
|
|
|
# Similar code exists in Qt6CoreConfigExtras.cmake.in and src/corelib/CMakeLists.txt which
|
|
|
|
# might not be needed anymore.
|
2022-04-13 12:57:34 +00:00
|
|
|
if(CMAKE_STAGING_PREFIX)
|
|
|
|
set(__qt_prefix "${CMAKE_STAGING_PREFIX}")
|
|
|
|
else()
|
|
|
|
set(__qt_prefix "${CMAKE_INSTALL_PREFIX}")
|
|
|
|
endif()
|
|
|
|
|
CMake: Make build system of installed Qt more relocatable
Aka handle CMAKE_INSTALL_PREFIX in a more relocatable way.
The following story inspired this change.
If a user wants to build a Qt repo into a different install prefix
than the usual Qt one, this will fail configuration because we
look for various things like syncqt, qdoc, etc relative to
CMAKE_INSTALL_PREFIX, which will now point to a different location
where none of the above tools are located.
The intent for such a use case is to support building Qt packages with
Conan, which sets a random install prefix when configuring a repo.
The idea is to derive the qt prefix dynamically from the
QtBuildInternals package location. Essentially it's a reverse relative
path from the QtBuildInternalsConfig.cmake file to the install prefix
that was specified when initially configuring qtbase.
Once the dynamic prefix is computed (so we know where the possibly
relocated Qt is), we can find tools like syncqt and qdoc.
This is an initial attempt to support a use case like that.
More design work will probably needed in case if tools / libs need to
be found in a location different than the Qt install prefix (so
support for multiple install prefixes / search paths).
An example of such a case would be when building qtdeclarative and
qtquickcontrols2 as Conan packages in one go. Most likely the
qmltyperegistrar tool will be located in the random install prefix
set by Conan, so building qtquickcontrols2 might fail due to not
finding the tool in the original Qt install prefix.
As to the implementation details, the change does the following:
- Dynamically computes and sets the
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX variable when
find_package()'ing QtBuildInternals. It's an absolute path
pointing to where the relocated Qt is.
- When building qtbase this variable is not yet available (due
to QtBuildInternalsExtra not existing), in that case we set
the variable to the absolute path of CMAKE_INSTALL_PREFIX
(but only for the initial qtbase configuration).
- Remove QT_BUILD_INTERNALS_ORIGINAL_INSTALL_PREFIX which was used
for standalone tests purposes. It's not needed now that we compute
the location of the Qt prefix dynamically.
- The Unixy qt-cmake and qt-cmake-private shell scripts now
use a relative path to find the toolchain file we created.
- The toolchain file also dynamically computes the location of the Qt
packages, and adds them to CMAKE_PREFIX_PATH.
- A lot of existing CMAKE_INSTALL_PREFIX uses are replaced with
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX. This includes finding
tool locations, mkspecs dir, path environment setup for tools, etc.
- Some places still use CMAKE_PREFIX_PATH in the following cases
- When determining paths while configuring qtbase (valid cases)
- When I wasn't sure what the behavior should be, so I left them
as-is (an example is documentation generation, do we want to
install it into the random Conan prefix, or into the main prefix?
Currently it installs in the random prefix).
Note that relocating a Qt installation does not work for non-prefix /
non-installed builds, due to hardcoded paths to include directories
and libraries in generated FooTargets.cmake files.
Task-number: QTBUG-83999
Change-Id: I87d6558729db93121b1715771034b03ce3295923
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-05-05 08:30:35 +00:00
|
|
|
if(QT_WILL_INSTALL)
|
|
|
|
get_filename_component(clean_config_prefix
|
2022-04-13 12:57:34 +00:00
|
|
|
"${__qt_prefix}/${QT_CONFIG_INSTALL_DIR}" ABSOLUTE)
|
CMake: Make build system of installed Qt more relocatable
Aka handle CMAKE_INSTALL_PREFIX in a more relocatable way.
The following story inspired this change.
If a user wants to build a Qt repo into a different install prefix
than the usual Qt one, this will fail configuration because we
look for various things like syncqt, qdoc, etc relative to
CMAKE_INSTALL_PREFIX, which will now point to a different location
where none of the above tools are located.
The intent for such a use case is to support building Qt packages with
Conan, which sets a random install prefix when configuring a repo.
The idea is to derive the qt prefix dynamically from the
QtBuildInternals package location. Essentially it's a reverse relative
path from the QtBuildInternalsConfig.cmake file to the install prefix
that was specified when initially configuring qtbase.
Once the dynamic prefix is computed (so we know where the possibly
relocated Qt is), we can find tools like syncqt and qdoc.
This is an initial attempt to support a use case like that.
More design work will probably needed in case if tools / libs need to
be found in a location different than the Qt install prefix (so
support for multiple install prefixes / search paths).
An example of such a case would be when building qtdeclarative and
qtquickcontrols2 as Conan packages in one go. Most likely the
qmltyperegistrar tool will be located in the random install prefix
set by Conan, so building qtquickcontrols2 might fail due to not
finding the tool in the original Qt install prefix.
As to the implementation details, the change does the following:
- Dynamically computes and sets the
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX variable when
find_package()'ing QtBuildInternals. It's an absolute path
pointing to where the relocated Qt is.
- When building qtbase this variable is not yet available (due
to QtBuildInternalsExtra not existing), in that case we set
the variable to the absolute path of CMAKE_INSTALL_PREFIX
(but only for the initial qtbase configuration).
- Remove QT_BUILD_INTERNALS_ORIGINAL_INSTALL_PREFIX which was used
for standalone tests purposes. It's not needed now that we compute
the location of the Qt prefix dynamically.
- The Unixy qt-cmake and qt-cmake-private shell scripts now
use a relative path to find the toolchain file we created.
- The toolchain file also dynamically computes the location of the Qt
packages, and adds them to CMAKE_PREFIX_PATH.
- A lot of existing CMAKE_INSTALL_PREFIX uses are replaced with
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX. This includes finding
tool locations, mkspecs dir, path environment setup for tools, etc.
- Some places still use CMAKE_PREFIX_PATH in the following cases
- When determining paths while configuring qtbase (valid cases)
- When I wasn't sure what the behavior should be, so I left them
as-is (an example is documentation generation, do we want to
install it into the random Conan prefix, or into the main prefix?
Currently it installs in the random prefix).
Note that relocating a Qt installation does not work for non-prefix /
non-installed builds, due to hardcoded paths to include directories
and libraries in generated FooTargets.cmake files.
Task-number: QTBUG-83999
Change-Id: I87d6558729db93121b1715771034b03ce3295923
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-05-05 08:30:35 +00:00
|
|
|
else()
|
|
|
|
get_filename_component(clean_config_prefix "${QT_CONFIG_BUILD_DIR}" ABSOLUTE)
|
|
|
|
endif()
|
|
|
|
file(RELATIVE_PATH
|
|
|
|
qt_path_from_cmake_config_dir_to_prefix
|
2022-04-13 12:57:34 +00:00
|
|
|
"${clean_config_prefix}" "${__qt_prefix}")
|
CMake: Make build system of installed Qt more relocatable
Aka handle CMAKE_INSTALL_PREFIX in a more relocatable way.
The following story inspired this change.
If a user wants to build a Qt repo into a different install prefix
than the usual Qt one, this will fail configuration because we
look for various things like syncqt, qdoc, etc relative to
CMAKE_INSTALL_PREFIX, which will now point to a different location
where none of the above tools are located.
The intent for such a use case is to support building Qt packages with
Conan, which sets a random install prefix when configuring a repo.
The idea is to derive the qt prefix dynamically from the
QtBuildInternals package location. Essentially it's a reverse relative
path from the QtBuildInternalsConfig.cmake file to the install prefix
that was specified when initially configuring qtbase.
Once the dynamic prefix is computed (so we know where the possibly
relocated Qt is), we can find tools like syncqt and qdoc.
This is an initial attempt to support a use case like that.
More design work will probably needed in case if tools / libs need to
be found in a location different than the Qt install prefix (so
support for multiple install prefixes / search paths).
An example of such a case would be when building qtdeclarative and
qtquickcontrols2 as Conan packages in one go. Most likely the
qmltyperegistrar tool will be located in the random install prefix
set by Conan, so building qtquickcontrols2 might fail due to not
finding the tool in the original Qt install prefix.
As to the implementation details, the change does the following:
- Dynamically computes and sets the
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX variable when
find_package()'ing QtBuildInternals. It's an absolute path
pointing to where the relocated Qt is.
- When building qtbase this variable is not yet available (due
to QtBuildInternalsExtra not existing), in that case we set
the variable to the absolute path of CMAKE_INSTALL_PREFIX
(but only for the initial qtbase configuration).
- Remove QT_BUILD_INTERNALS_ORIGINAL_INSTALL_PREFIX which was used
for standalone tests purposes. It's not needed now that we compute
the location of the Qt prefix dynamically.
- The Unixy qt-cmake and qt-cmake-private shell scripts now
use a relative path to find the toolchain file we created.
- The toolchain file also dynamically computes the location of the Qt
packages, and adds them to CMAKE_PREFIX_PATH.
- A lot of existing CMAKE_INSTALL_PREFIX uses are replaced with
QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX. This includes finding
tool locations, mkspecs dir, path environment setup for tools, etc.
- Some places still use CMAKE_PREFIX_PATH in the following cases
- When determining paths while configuring qtbase (valid cases)
- When I wasn't sure what the behavior should be, so I left them
as-is (an example is documentation generation, do we want to
install it into the random Conan prefix, or into the main prefix?
Currently it installs in the random prefix).
Note that relocating a Qt installation does not work for non-prefix /
non-installed builds, due to hardcoded paths to include directories
and libraries in generated FooTargets.cmake files.
Task-number: QTBUG-83999
Change-Id: I87d6558729db93121b1715771034b03ce3295923
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-05-05 08:30:35 +00:00
|
|
|
set(qt_path_from_cmake_config_dir_to_prefix "${qt_path_from_cmake_config_dir_to_prefix}"
|
|
|
|
PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
function(qt_get_relocatable_install_prefix out_var)
|
|
|
|
# We need to compute it only once while building qtbase. Afterwards it's loaded from
|
|
|
|
# QtBuildInternalsExtras.cmake.
|
|
|
|
if(QT_BUILD_INTERNALS_RELOCATABLE_INSTALL_PREFIX)
|
|
|
|
return()
|
|
|
|
endif()
|
|
|
|
# The QtBuildInternalsExtras value is dynamically computed, whereas the initial qtbase
|
|
|
|
# configuration uses an absolute path.
|
|
|
|
set(${out_var} "${CMAKE_INSTALL_PREFIX}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
2020-06-04 16:21:13 +00:00
|
|
|
function(qt_set_up_fake_standalone_tests_install_prefix)
|
|
|
|
# Set a fake local (non-cache) CMAKE_INSTALL_PREFIX.
|
|
|
|
# Needed for standalone tests, we don't want to accidentally install a test into the Qt prefix.
|
2020-06-05 11:46:48 +00:00
|
|
|
# Allow opt-out, if a user knows what they're doing.
|
|
|
|
if(QT_NO_FAKE_STANDALONE_TESTS_INSTALL_PREFIX)
|
|
|
|
return()
|
2020-04-28 09:45:44 +00:00
|
|
|
endif()
|
2020-06-05 11:46:48 +00:00
|
|
|
set(new_install_prefix "${CMAKE_BINARY_DIR}/fake_prefix")
|
2020-04-28 09:45:44 +00:00
|
|
|
|
2020-06-04 16:21:13 +00:00
|
|
|
# It's IMPORTANT that this is not a cache variable. Otherwise
|
|
|
|
# qt_get_standalone_tests_confg_files_path() will not work on re-configuration.
|
|
|
|
message(STATUS
|
|
|
|
"Setting local standalone test install prefix (non-cached) to '${new_install_prefix}'.")
|
|
|
|
set(CMAKE_INSTALL_PREFIX "${new_install_prefix}" PARENT_SCOPE)
|
2020-10-23 10:45:10 +00:00
|
|
|
|
|
|
|
# We also need to clear the staging prefix if it's set, otherwise CMake will modify any computed
|
|
|
|
# rpaths containing the staging prefix to point to the new fake prefix, which is not what we
|
|
|
|
# want. This replacement is done in cmComputeLinkInformation::GetRPath().
|
|
|
|
#
|
|
|
|
# By clearing the staging prefix for the standalone tests, any detected link time
|
|
|
|
# rpaths will be embedded as-is, which will point to the place where Qt was installed (aka
|
|
|
|
# the staging prefix).
|
|
|
|
if(DEFINED CMAKE_STAGING_PREFIX)
|
|
|
|
message(STATUS "Clearing local standalone test staging prefix (non-cached).")
|
|
|
|
set(CMAKE_STAGING_PREFIX "" PARENT_SCOPE)
|
|
|
|
endif()
|
2020-04-16 18:30:03 +00:00
|
|
|
endfunction()
|
|
|
|
|
2020-07-20 15:12:45 +00:00
|
|
|
# Mean to be called when configuring examples as part of the main build tree, as well as for CMake
|
|
|
|
# tests (tests that call CMake to try and build CMake applications).
|
|
|
|
macro(qt_internal_set_up_build_dir_package_paths)
|
2022-07-06 13:00:14 +00:00
|
|
|
list(PREPEND CMAKE_PREFIX_PATH "${QT_BUILD_DIR}/${INSTALL_LIBDIR}/cmake")
|
2020-07-20 15:12:45 +00:00
|
|
|
# Make sure the CMake config files do not recreate the already-existing targets
|
|
|
|
set(QT_NO_CREATE_TARGETS TRUE)
|
|
|
|
endmacro()
|
|
|
|
|
2019-06-06 11:08:41 +00:00
|
|
|
macro(qt_examples_build_begin)
|
2021-05-24 06:35:39 +00:00
|
|
|
set(options EXTERNAL_BUILD)
|
|
|
|
set(singleOpts "")
|
|
|
|
set(multiOpts DEPENDS)
|
|
|
|
|
|
|
|
cmake_parse_arguments(arg "${options}" "${singleOpts}" "${multiOpts}" ${ARGN})
|
|
|
|
|
2023-03-22 14:35:24 +00:00
|
|
|
set(CMAKE_UNITY_BUILD OFF)
|
|
|
|
|
2021-12-14 15:27:58 +00:00
|
|
|
# Use by qt_internal_add_example.
|
|
|
|
set(QT_EXAMPLE_BASE_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
|
|
|
|
|
2021-09-03 15:08:50 +00:00
|
|
|
if(arg_EXTERNAL_BUILD AND QT_BUILD_EXAMPLES_AS_EXTERNAL)
|
2021-05-24 06:35:39 +00:00
|
|
|
# Examples will be built using ExternalProject.
|
2023-02-06 15:51:40 +00:00
|
|
|
# We depend on all plugins built as part of the current repo as well as current repo's
|
|
|
|
# dependencies plugins, to prevent opportunities for
|
2021-05-24 06:35:39 +00:00
|
|
|
# weird errors associated with loading out-of-date plugins from
|
2021-06-16 12:56:13 +00:00
|
|
|
# unrelated Qt modules.
|
|
|
|
# We also depend on all targets from this repo's src and tools subdirectories
|
2021-05-24 06:35:39 +00:00
|
|
|
# to ensure that we've built anything that a find_package() call within
|
|
|
|
# an example might use. Projects can add further dependencies if needed,
|
|
|
|
# but that should rarely be necessary.
|
2023-02-06 15:51:40 +00:00
|
|
|
set(QT_EXAMPLE_DEPENDENCIES ${qt_repo_plugins_recursive} ${arg_DEPENDS})
|
2021-06-16 12:56:13 +00:00
|
|
|
|
|
|
|
if(TARGET ${qt_repo_targets_name}_src)
|
2023-01-19 17:55:58 +00:00
|
|
|
list(APPEND QT_EXAMPLE_DEPENDENCIES ${qt_repo_targets_name}_src_for_examples)
|
2021-06-16 12:56:13 +00:00
|
|
|
endif()
|
|
|
|
|
|
|
|
if(TARGET ${qt_repo_targets_name}_tools)
|
|
|
|
list(APPEND QT_EXAMPLE_DEPENDENCIES ${qt_repo_targets_name}_tools)
|
|
|
|
endif()
|
|
|
|
|
2021-05-31 11:52:19 +00:00
|
|
|
set(QT_IS_EXTERNAL_EXAMPLES_BUILD TRUE)
|
2021-05-24 06:35:39 +00:00
|
|
|
|
|
|
|
string(TOLOWER ${PROJECT_NAME} project_name_lower)
|
|
|
|
if(NOT TARGET examples)
|
|
|
|
if(QT_BUILD_EXAMPLES_BY_DEFAULT)
|
|
|
|
add_custom_target(examples ALL)
|
|
|
|
else()
|
|
|
|
add_custom_target(examples)
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
if(NOT TARGET examples_${project_name_lower})
|
|
|
|
add_custom_target(examples_${project_name_lower})
|
|
|
|
add_dependencies(examples examples_${project_name_lower})
|
|
|
|
endif()
|
|
|
|
|
|
|
|
include(ExternalProject)
|
|
|
|
else()
|
|
|
|
# This repo has not yet been updated to build examples in a separate
|
|
|
|
# build from this main build, or we can't use that arrangement yet.
|
|
|
|
# Build them directly as part of the main build instead for backward
|
|
|
|
# compatibility.
|
|
|
|
if(NOT BUILD_SHARED_LIBS)
|
|
|
|
# Ordinarily, it would be an error to call return() from within a
|
|
|
|
# macro(), but in this case we specifically want to return from the
|
|
|
|
# caller's scope if we are doing a static build and the project
|
|
|
|
# isn't building examples in a separate build from the main build.
|
|
|
|
# Configuring static builds requires tools that are not available
|
|
|
|
# until build time.
|
|
|
|
return()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
if(NOT QT_BUILD_EXAMPLES_BY_DEFAULT)
|
|
|
|
set_directory_properties(PROPERTIES EXCLUDE_FROM_ALL TRUE)
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
2021-12-14 15:56:39 +00:00
|
|
|
# TODO: Change this to TRUE when all examples in all repos are ported to use
|
|
|
|
# qt_internal_add_example.
|
|
|
|
# We shouldn't need to call qt_internal_set_up_build_dir_package_paths when
|
|
|
|
# QT_IS_EXTERNAL_EXAMPLES_BUILD is TRUE.
|
|
|
|
# Due to not all examples being ported, if we don't
|
|
|
|
# call qt_internal_set_up_build_dir_package_paths -> set(QT_NO_CREATE_TARGETS TRUE) we'll get
|
|
|
|
# CMake configuration errors saying we redefine Qt targets because we both build them and find
|
|
|
|
# them as part of find_package.
|
|
|
|
set(__qt_all_examples_ported_to_external_projects FALSE)
|
|
|
|
|
2019-09-19 11:46:37 +00:00
|
|
|
# Examples that are built as part of the Qt build need to use the CMake config files from the
|
|
|
|
# build dir, because they are not installed yet in a prefix build.
|
2022-07-06 13:00:14 +00:00
|
|
|
# Prepending to CMAKE_PREFIX_PATH helps find the initial Qt6Config.cmake.
|
2023-08-23 08:11:15 +00:00
|
|
|
# Prepending to QT_BUILD_CMAKE_PREFIX_PATH helps find components of Qt6, because those
|
2019-09-19 11:46:37 +00:00
|
|
|
# find_package calls use NO_DEFAULT_PATH, and thus CMAKE_PREFIX_PATH is ignored.
|
2022-07-06 13:00:14 +00:00
|
|
|
# Prepending to CMAKE_FIND_ROOT_PATH ensures the components are found while cross-compiling
|
2022-02-03 13:13:25 +00:00
|
|
|
# without setting CMAKE_FIND_ROOT_PATH_MODE_PACKAGE to BOTH.
|
2021-12-14 15:56:39 +00:00
|
|
|
if(NOT QT_IS_EXTERNAL_EXAMPLES_BUILD OR NOT __qt_all_examples_ported_to_external_projects)
|
|
|
|
qt_internal_set_up_build_dir_package_paths()
|
2022-07-06 13:00:14 +00:00
|
|
|
list(PREPEND CMAKE_FIND_ROOT_PATH "${QT_BUILD_DIR}")
|
2023-08-23 08:11:15 +00:00
|
|
|
list(PREPEND QT_BUILD_CMAKE_PREFIX_PATH "${QT_BUILD_DIR}/${INSTALL_LIBDIR}/cmake")
|
2021-12-14 15:56:39 +00:00
|
|
|
endif()
|
CMake: Handle automatic rpath embedding correctly
Instead of using CMAKE_INSTALL_RPATH to embed an absolute path
to prefix/libdir into all targets, use the more sophisticated aproach
that qmake does.
For certain targets (modules, plugins, tools) use relative rpaths.
Otherwise embed absolute paths (examples, regular binaries).
Installed tests currently have no rpaths.
On certain platforms rpaths are not used (Windows, Android,
iOS / uikit).
Frameworks, app bundles and shallow bundles should also be handled
correctly.
Additional rpaths can be provided via QT_EXTRA_RPATHS variable
(similar to the -R option that configure takes).
Automatic embedding can be disabled either via QT_FEATURE_rpath=OFF
or QT_DISABLE_RPATH=ON.
Note that installed examples are not relocatable at the moment (due
to always having an absolute path rpath), so this is a missing feature
compared to qmake. This is due to missing information on where
examples will be installed, so a relative rpath can not be computed.
By default a Qt installation is relocatable, so there is no need to
pass -DQT_EXTRA_RPATHS=. like Coin used to do with qmake e.g. -R .
Relative rpaths will have the appropriate 'relative base' prefixed
to them (e.g $ORIGIN on linux and @loader_path on darwin platforms).
There is currently no support for other platforms that might have a
different 'relative base' than the ones mentioned above.
Any extra rpaths are saved to BuildInternalsExtra which are re-used
when building other repositories.
configurejson2cmake modified to include correct conditions for the
rpath feature.
It's very likely that we will need a new qt_add_internal_app()
function for gui apps that are to be installed to prefix/bin.
For example for Assistant from qttools. Currently such apps
use qt_add_executable().
The distinction is necessary to make sure that relative rpaths are
embedded into apps, but not executables (which tests are part of).
Amends e835a6853b9c0fb7af32798ed8965de3adf0e15b
Task-number: QTBUG-83497
Change-Id: I3510f63c0a59489741116cc8ec3ef6a0a7704f25
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-04-15 16:48:26 +00:00
|
|
|
|
|
|
|
# Because CMAKE_INSTALL_RPATH is empty by default in the repo project, examples need to have
|
|
|
|
# it set here, so they can run when installed.
|
|
|
|
# This means that installed examples are not relocatable at the moment. We would need to
|
|
|
|
# annotate where each example is installed to, to be able to derive a relative rpath, and it
|
|
|
|
# seems there's no way to query such information from CMake itself.
|
|
|
|
set(CMAKE_INSTALL_RPATH "${_default_install_rpath}")
|
2021-12-14 15:27:58 +00:00
|
|
|
|
|
|
|
install(CODE "
|
|
|
|
# Backup CMAKE_INSTALL_PREFIX because we're going to change it in each example subdirectory
|
|
|
|
# and restore it after all examples are processed so that QtFooToolsAdditionalTargetInfo.cmake
|
|
|
|
# files are installed into the original install prefix.
|
|
|
|
set(_qt_internal_examples_cmake_install_prefix_backup \"\${CMAKE_INSTALL_PREFIX}\")
|
|
|
|
")
|
2019-06-06 11:08:41 +00:00
|
|
|
endmacro()
|
|
|
|
|
|
|
|
macro(qt_examples_build_end)
|
2021-05-24 06:35:39 +00:00
|
|
|
# We use AUTOMOC/UIC/RCC in the examples. When the examples are part of the
|
|
|
|
# main build rather than being built in their own separate project, make
|
|
|
|
# sure we do not fail on a fresh Qt build (e.g. the moc binary won't exist
|
|
|
|
# yet because it is created at build time).
|
2019-06-06 11:08:41 +00:00
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
# This function gets all targets below this directory (excluding custom targets and aliases)
|
2019-06-06 11:08:41 +00:00
|
|
|
function(get_all_targets _result _dir)
|
|
|
|
get_property(_subdirs DIRECTORY "${_dir}" PROPERTY SUBDIRECTORIES)
|
|
|
|
foreach(_subdir IN LISTS _subdirs)
|
|
|
|
get_all_targets(${_result} "${_subdir}")
|
|
|
|
endforeach()
|
|
|
|
get_property(_sub_targets DIRECTORY "${_dir}" PROPERTY BUILDSYSTEM_TARGETS)
|
2021-05-24 06:35:39 +00:00
|
|
|
set(_real_targets "")
|
|
|
|
if(_sub_targets)
|
|
|
|
foreach(__target IN LISTS _sub_targets)
|
|
|
|
get_target_property(target_type ${__target} TYPE)
|
|
|
|
if(NOT target_type STREQUAL "UTILITY" AND NOT target_type STREQUAL "ALIAS")
|
|
|
|
list(APPEND _real_targets ${__target})
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
endif()
|
|
|
|
set(${_result} ${${_result}} ${_real_targets} PARENT_SCOPE)
|
2019-06-06 11:08:41 +00:00
|
|
|
endfunction()
|
|
|
|
|
|
|
|
get_all_targets(targets "${CMAKE_CURRENT_SOURCE_DIR}")
|
|
|
|
|
|
|
|
foreach(target ${targets})
|
2019-09-20 12:18:17 +00:00
|
|
|
qt_autogen_tools(${target} ENABLE_AUTOGEN_TOOLS "moc" "rcc")
|
|
|
|
if(TARGET Qt::Widgets)
|
|
|
|
qt_autogen_tools(${target} ENABLE_AUTOGEN_TOOLS "uic")
|
|
|
|
endif()
|
2023-03-09 13:53:14 +00:00
|
|
|
set_target_properties(${target} PROPERTIES UNITY_BUILD OFF)
|
2019-06-06 11:08:41 +00:00
|
|
|
endforeach()
|
|
|
|
|
2021-12-14 15:27:58 +00:00
|
|
|
install(CODE "
|
|
|
|
# Restore backed up CMAKE_INSTALL_PREFIX.
|
|
|
|
set(CMAKE_INSTALL_PREFIX \"\${_qt_internal_examples_cmake_install_prefix_backup}\")
|
|
|
|
")
|
2023-03-22 14:35:24 +00:00
|
|
|
|
|
|
|
set(CMAKE_UNITY_BUILD ${QT_UNITY_BUILD})
|
2019-06-06 11:08:41 +00:00
|
|
|
endmacro()
|
2021-04-21 17:48:37 +00:00
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
# Allows building an example either as an ExternalProject or in-tree with the Qt build.
|
|
|
|
# Also allows installing the example sources.
|
2021-05-24 06:35:39 +00:00
|
|
|
function(qt_internal_add_example subdir)
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
# Pre-compute unique example name based on the subdir, in case of target name clashes.
|
|
|
|
qt_internal_get_example_unique_name(unique_example_name "${subdir}")
|
|
|
|
|
|
|
|
# QT_INTERNAL_NO_CONFIGURE_EXAMPLES is not meant to be used by Qt builders, it's here for faster
|
|
|
|
# testing of the source installation code path for build system engineers.
|
|
|
|
if(NOT QT_INTERNAL_NO_CONFIGURE_EXAMPLES)
|
|
|
|
if(NOT QT_IS_EXTERNAL_EXAMPLES_BUILD)
|
|
|
|
qt_internal_add_example_in_tree("${subdir}")
|
|
|
|
else()
|
|
|
|
qt_internal_add_example_external_project("${subdir}"
|
|
|
|
NAME "${unique_example_name}")
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
if(QT_INSTALL_EXAMPLES_SOURCES)
|
|
|
|
string(TOLOWER ${PROJECT_NAME} project_name_lower)
|
|
|
|
|
|
|
|
qt_internal_install_example_sources("${subdir}"
|
|
|
|
NAME "${unique_example_name}"
|
|
|
|
REPO_NAME "${project_name_lower}")
|
|
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Gets the install prefix where an example should be installed.
|
|
|
|
# Used for computing the final installation path.
|
|
|
|
function(qt_internal_get_example_install_prefix out_var)
|
|
|
|
# Allow customizing the installation path of the examples. Will be used in CI.
|
|
|
|
if(QT_INTERNAL_EXAMPLES_INSTALL_PREFIX)
|
|
|
|
set(qt_example_install_prefix "${QT_INTERNAL_EXAMPLES_INSTALL_PREFIX}")
|
2021-12-14 14:48:34 +00:00
|
|
|
else()
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
set(qt_example_install_prefix "${CMAKE_INSTALL_PREFIX}/${INSTALL_EXAMPLESDIR}")
|
2021-05-24 06:35:39 +00:00
|
|
|
endif()
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
file(TO_CMAKE_PATH "${qt_example_install_prefix}" qt_example_install_prefix)
|
|
|
|
set(${out_var} "${qt_example_install_prefix}" PARENT_SCOPE)
|
2021-12-14 14:48:34 +00:00
|
|
|
endfunction()
|
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
# Gets the install prefix where an example's sources should be installed.
|
|
|
|
# Used for computing the final installation path.
|
|
|
|
function(qt_internal_get_examples_sources_install_prefix out_var)
|
|
|
|
# Allow customizing the installation path of the examples source specifically.
|
|
|
|
if(QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX)
|
|
|
|
set(qt_example_install_prefix "${QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX}")
|
|
|
|
else()
|
|
|
|
qt_internal_get_example_install_prefix(qt_example_install_prefix)
|
|
|
|
endif()
|
|
|
|
file(TO_CMAKE_PATH "${qt_example_install_prefix}" qt_example_install_prefix)
|
|
|
|
set(${out_var} "${qt_example_install_prefix}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Gets the relative path of an example, relative to the current repo's examples source dir.
|
|
|
|
# QT_EXAMPLE_BASE_DIR is meant to be already set in a parent scope.
|
|
|
|
function(qt_internal_get_example_rel_path out_var subdir)
|
2021-12-14 15:27:58 +00:00
|
|
|
file(RELATIVE_PATH example_rel_path
|
|
|
|
"${QT_EXAMPLE_BASE_DIR}" "${CMAKE_CURRENT_SOURCE_DIR}/${subdir}")
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
set(${out_var} "${example_rel_path}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Gets the install path where an example should be installed.
|
|
|
|
function(qt_internal_get_example_install_path out_var subdir)
|
|
|
|
qt_internal_get_example_install_prefix(qt_example_install_prefix)
|
|
|
|
qt_internal_get_example_rel_path(example_rel_path "${subdir}")
|
|
|
|
set(example_install_path "${qt_example_install_prefix}/${example_rel_path}")
|
|
|
|
|
|
|
|
set(${out_var} "${example_install_path}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Gets the install path where an example's sources should be installed.
|
|
|
|
function(qt_internal_get_examples_sources_install_path out_var subdir)
|
|
|
|
qt_internal_get_examples_sources_install_prefix(qt_example_install_prefix)
|
|
|
|
qt_internal_get_example_rel_path(example_rel_path "${subdir}")
|
|
|
|
set(example_install_path "${qt_example_install_prefix}/${example_rel_path}")
|
|
|
|
|
|
|
|
set(${out_var} "${example_install_path}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Get the unique name of an example project based on its subdir or explicitly given name.
|
|
|
|
# Makes the name unique by appending a short sha1 hash of the relative path of the example
|
|
|
|
# if a target of the same name already exist.
|
|
|
|
function(qt_internal_get_example_unique_name out_var subdir)
|
|
|
|
qt_internal_get_example_rel_path(example_rel_path "${subdir}")
|
|
|
|
|
|
|
|
set(name "${subdir}")
|
|
|
|
|
|
|
|
# qtdeclarative has calls like qt_internal_add_example(imagine/automotive)
|
|
|
|
# so passing a nested subdirectory. Custom targets (and thus ExternalProjects) can't contain
|
|
|
|
# slashes, so extract the last part of the path to be used as a name.
|
|
|
|
if(name MATCHES "/")
|
|
|
|
string(REPLACE "/" ";" exploded_path "${name}")
|
|
|
|
list(POP_BACK exploded_path last_dir)
|
|
|
|
if(NOT last_dir)
|
|
|
|
message(FATAL_ERROR "Example subdirectory must have a name.")
|
|
|
|
else()
|
|
|
|
set(name "${last_dir}")
|
|
|
|
endif()
|
|
|
|
endif()
|
2021-12-14 15:27:58 +00:00
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
# Likely a clash with an example subdir ExternalProject custom target of the same name in a
|
|
|
|
# top-level build.
|
|
|
|
if(TARGET "${name}")
|
|
|
|
string(SHA1 rel_path_hash "${example_rel_path}")
|
|
|
|
string(SUBSTRING "${rel_path_hash}" 0 4 short_hash)
|
|
|
|
set(name "${name}-${short_hash}")
|
|
|
|
endif()
|
|
|
|
|
|
|
|
set(${out_var} "${name}" PARENT_SCOPE)
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
# Use old non-ExternalProject approach, aka build in-tree with the Qt build.
|
|
|
|
function(qt_internal_add_example_in_tree subdir)
|
2021-12-14 15:27:58 +00:00
|
|
|
# Unset the default CMAKE_INSTALL_PREFIX that's generated in
|
|
|
|
# ${CMAKE_CURRENT_BINARY_DIR}/cmake_install.cmake
|
|
|
|
# so we can override it with a different value in
|
|
|
|
# ${CMAKE_CURRENT_BINARY_DIR}/${subdir}/cmake_install.cmake
|
|
|
|
#
|
|
|
|
install(CODE "
|
|
|
|
# Unset the CMAKE_INSTALL_PREFIX in the current cmake_install.cmake file so that it can be
|
|
|
|
# overridden in the included add_subdirectory-specific cmake_install.cmake files instead.
|
|
|
|
unset(CMAKE_INSTALL_PREFIX)
|
|
|
|
")
|
|
|
|
|
|
|
|
# Override the install prefix in the subdir cmake_install.cmake, so that
|
|
|
|
# relative install(TARGETS DESTINATION) calls in example projects install where we tell them to.
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
qt_internal_get_example_install_path(example_install_path "${subdir}")
|
|
|
|
set(CMAKE_INSTALL_PREFIX "${example_install_path}")
|
2021-12-14 15:27:58 +00:00
|
|
|
|
|
|
|
# Make sure unclean example projects have their INSTALL_EXAMPLEDIR set to "."
|
|
|
|
# Won't have any effect on example projects that don't use INSTALL_EXAMPLEDIR.
|
|
|
|
# This plus the install prefix above takes care of installing examples where we want them to
|
|
|
|
# be installed, while allowing us to remove INSTALL_EXAMPLEDIR code in each example
|
|
|
|
# incrementally.
|
|
|
|
# TODO: Remove once all repositories use qt_internal_add_example instead of add_subdirectory.
|
|
|
|
set(QT_INTERNAL_SET_EXAMPLE_INSTALL_DIR_TO_DOT ON)
|
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
add_subdirectory(${subdir})
|
2021-12-14 14:48:34 +00:00
|
|
|
endfunction()
|
|
|
|
|
|
|
|
function(qt_internal_add_example_external_project subdir)
|
2021-05-24 06:35:39 +00:00
|
|
|
set(options "")
|
|
|
|
set(singleOpts NAME)
|
|
|
|
set(multiOpts "")
|
|
|
|
|
|
|
|
cmake_parse_arguments(PARSE_ARGV 1 arg "${options}" "${singleOpts}" "${multiOpts}")
|
|
|
|
|
2023-08-17 15:14:09 +00:00
|
|
|
_qt_internal_get_build_vars_for_external_projects(
|
|
|
|
CMAKE_DIR_VAR qt_cmake_dir
|
|
|
|
PREFIXES_VAR qt_prefixes
|
|
|
|
ADDITIONAL_PACKAGES_PREFIXES_VAR qt_additional_packages_prefixes
|
|
|
|
)
|
|
|
|
|
|
|
|
list(APPEND QT_ADDITIONAL_PACKAGES_PREFIX_PATH "${qt_additional_packages_prefixes}")
|
2021-05-24 06:35:39 +00:00
|
|
|
|
|
|
|
set(vars_to_pass_if_defined)
|
|
|
|
set(var_defs)
|
|
|
|
if(QT_HOST_PATH OR CMAKE_CROSSCOMPILING)
|
|
|
|
list(APPEND var_defs
|
|
|
|
-DCMAKE_TOOLCHAIN_FILE:FILEPATH=${qt_cmake_dir}/qt.toolchain.cmake
|
|
|
|
)
|
|
|
|
else()
|
2021-12-14 15:56:39 +00:00
|
|
|
list(PREPEND CMAKE_PREFIX_PATH ${qt_prefixes})
|
2021-05-24 06:35:39 +00:00
|
|
|
|
|
|
|
# Setting CMAKE_SYSTEM_NAME affects CMAKE_CROSSCOMPILING, even if it is
|
|
|
|
# set to the same as the host, so it should only be set if it is different.
|
|
|
|
# See https://gitlab.kitware.com/cmake/cmake/-/issues/21744
|
|
|
|
if(NOT DEFINED CMAKE_TOOLCHAIN_FILE AND
|
|
|
|
NOT CMAKE_SYSTEM_NAME STREQUAL CMAKE_HOST_SYSTEM_NAME)
|
|
|
|
list(APPEND vars_to_pass_if_defined CMAKE_SYSTEM_NAME:STRING)
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
2021-12-14 15:56:39 +00:00
|
|
|
# In multi-config mode by default we exclude building tools for configs other than the main one.
|
|
|
|
# Trying to build an example in a non-default config using the non-installed
|
|
|
|
# QtFooConfig.cmake files would error out saying moc is not found.
|
|
|
|
# Make sure to build examples only with the main config.
|
|
|
|
# When users build an example against an installed Qt they won't have this problem because
|
|
|
|
# the generated non-main QtFooTargets-$<CONFIG>.cmake file is empty and doesn't advertise
|
|
|
|
# a tool that is not there.
|
|
|
|
if(QT_GENERATOR_IS_MULTI_CONFIG)
|
|
|
|
set(CMAKE_CONFIGURATION_TYPES "${QT_MULTI_CONFIG_FIRST_CONFIG}")
|
|
|
|
endif()
|
|
|
|
|
|
|
|
# We need to pass the modified CXX flags of the parent project so that using sccache works
|
|
|
|
# properly and doesn't error out due to concurrent access to the pdb files.
|
|
|
|
# See qt_internal_set_up_config_optimizations_like_in_qmake, "/Zi" "/Z7".
|
|
|
|
if(MSVC AND QT_FEATURE_msvc_obj_debug_info)
|
|
|
|
qt_internal_get_enabled_languages_for_flag_manipulation(enabled_languages)
|
|
|
|
set(configs RELWITHDEBINFO DEBUG)
|
|
|
|
foreach(lang ${enabled_languages})
|
|
|
|
foreach(config ${configs})
|
|
|
|
set(flag_var_name "CMAKE_${lang}_FLAGS_${config}")
|
|
|
|
list(APPEND vars_to_pass_if_defined "${flag_var_name}:STRING")
|
|
|
|
endforeach()
|
|
|
|
endforeach()
|
|
|
|
endif()
|
|
|
|
|
2022-08-03 16:37:03 +00:00
|
|
|
# When cross-compiling for a qemu target in our CI, we source an environment script
|
|
|
|
# that sets environment variables like CC and CXX. These are parsed by CMake on initial
|
|
|
|
# configuration to populate the cache vars CMAKE_${lang}_COMPILER.
|
|
|
|
# If the environment variable specified not only the compiler path, but also a list of flags
|
|
|
|
# to pass to the compiler, CMake parses those out into a separate CMAKE_${lang}_COMPILER_ARG1
|
|
|
|
# cache variable. In such a case, we want to ensure that the external project also sees those
|
|
|
|
# flags.
|
|
|
|
# Unfortunately we can't do that by simply forwarding CMAKE_${lang}_COMPILER_ARG1 to the EP
|
|
|
|
# because it breaks the compiler identification try_compile call, it simply doesn't consider
|
|
|
|
# the cache var. From what I could gather, it's a limitation of try_compile and the list
|
|
|
|
# of variables it considers for forwarding.
|
|
|
|
# To fix this case, we ensure not to pass either cache variable, and let the external project
|
|
|
|
# and its compiler identification try_compile project pick up the compiler and the flags
|
|
|
|
# from the environment variables instead.
|
|
|
|
foreach(lang_as_env_var CC CXX OBJC OBJCXX)
|
|
|
|
if(lang_as_env_var STREQUAL "CC")
|
|
|
|
set(lang_as_cache_var "C")
|
|
|
|
else()
|
|
|
|
set(lang_as_cache_var "${lang_as_env_var}")
|
|
|
|
endif()
|
|
|
|
set(lang_env_value "$ENV{${lang_as_env_var}}")
|
|
|
|
if(lang_env_value
|
|
|
|
AND CMAKE_${lang_as_cache_var}_COMPILER
|
|
|
|
AND CMAKE_${lang_as_cache_var}_COMPILER_ARG1)
|
|
|
|
# The compiler environment variable is set and specifies a list of extra flags, don't
|
|
|
|
# forward the compiler cache vars and rely on the environment variable to be picked up
|
|
|
|
# instead.
|
|
|
|
else()
|
|
|
|
list(APPEND vars_to_pass_if_defined "CMAKE_${lang_as_cache_var}_COMPILER:STRING")
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
unset(lang_as_env_var)
|
|
|
|
unset(lang_as_cache_var)
|
|
|
|
unset(lang_env_value)
|
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
list(APPEND vars_to_pass_if_defined
|
|
|
|
CMAKE_BUILD_TYPE:STRING
|
2021-12-14 15:56:39 +00:00
|
|
|
CMAKE_CONFIGURATION_TYPES:STRING
|
2021-05-24 06:35:39 +00:00
|
|
|
CMAKE_PREFIX_PATH:STRING
|
2023-08-23 08:11:15 +00:00
|
|
|
QT_BUILD_CMAKE_PREFIX_PATH:STRING
|
2022-02-03 13:03:42 +00:00
|
|
|
QT_ADDITIONAL_PACKAGES_PREFIX_PATH:STRING
|
2021-05-24 06:35:39 +00:00
|
|
|
CMAKE_FIND_ROOT_PATH:STRING
|
|
|
|
BUILD_SHARED_LIBS:BOOL
|
|
|
|
CMAKE_OSX_ARCHITECTURES:STRING
|
|
|
|
CMAKE_OSX_DEPLOYMENT_TARGET:STRING
|
|
|
|
CMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_ALLOWED:BOOL
|
|
|
|
CMAKE_XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH:BOOL
|
|
|
|
CMAKE_C_COMPILER_LAUNCHER:STRING
|
|
|
|
CMAKE_CXX_COMPILER_LAUNCHER:STRING
|
|
|
|
CMAKE_OBJC_COMPILER_LAUNCHER:STRING
|
|
|
|
CMAKE_OBJCXX_COMPILER_LAUNCHER:STRING
|
|
|
|
)
|
|
|
|
|
|
|
|
foreach(var_with_type IN LISTS vars_to_pass_if_defined)
|
|
|
|
string(REPLACE ":" ";" key_as_list "${var_with_type}")
|
|
|
|
list(GET key_as_list 0 var)
|
|
|
|
if(NOT DEFINED ${var})
|
|
|
|
continue()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
# Preserve lists
|
|
|
|
string(REPLACE ";" "$<SEMICOLON>" varForGenex "${${var}}")
|
|
|
|
|
|
|
|
list(APPEND var_defs -D${var_with_type}=${varForGenex})
|
|
|
|
endforeach()
|
|
|
|
|
2022-03-23 13:43:23 +00:00
|
|
|
if(QT_INTERNAL_VERBOSE_EXAMPLES)
|
|
|
|
list(APPEND var_defs -DCMAKE_MESSAGE_LOG_LEVEL:STRING=DEBUG)
|
2022-03-23 15:24:16 +00:00
|
|
|
list(APPEND var_defs -DCMAKE_AUTOGEN_VERBOSE:BOOL=TRUE)
|
2022-03-23 13:43:23 +00:00
|
|
|
endif()
|
2021-05-24 06:35:39 +00:00
|
|
|
|
|
|
|
set(deps "")
|
|
|
|
list(REMOVE_DUPLICATES QT_EXAMPLE_DEPENDENCIES)
|
|
|
|
foreach(dep IN LISTS QT_EXAMPLE_DEPENDENCIES)
|
|
|
|
if(TARGET ${dep})
|
|
|
|
list(APPEND deps ${dep})
|
|
|
|
endif()
|
|
|
|
endforeach()
|
|
|
|
|
|
|
|
set(independent_args)
|
|
|
|
cmake_policy(PUSH)
|
|
|
|
if(POLICY CMP0114)
|
|
|
|
set(independent_args INDEPENDENT TRUE)
|
|
|
|
cmake_policy(SET CMP0114 NEW)
|
|
|
|
endif()
|
|
|
|
|
|
|
|
# The USES_TERMINAL_BUILD setting forces the build step to the console pool
|
|
|
|
# when using Ninja. This has two benefits:
|
|
|
|
#
|
|
|
|
# - You see build output as it is generated instead of at the end of the
|
|
|
|
# build step.
|
|
|
|
# - Only one task can use the console pool at a time, so it effectively
|
|
|
|
# serializes all example build steps, thereby preventing CPU
|
|
|
|
# over-commitment.
|
|
|
|
#
|
|
|
|
# If the loss of interactivity is not so important, one can allow CPU
|
|
|
|
# over-commitment for Ninja builds. This may result in better throughput,
|
|
|
|
# but is not allowed by default because it can make a machine almost
|
|
|
|
# unusable while a compilation is running.
|
|
|
|
set(terminal_args USES_TERMINAL_BUILD TRUE)
|
|
|
|
if(CMAKE_GENERATOR MATCHES "Ninja")
|
|
|
|
option(QT_BUILD_EXAMPLES_WITH_CPU_OVERCOMMIT
|
|
|
|
"Allow CPU over-commitment when building examples (Ninja only)"
|
|
|
|
)
|
|
|
|
if(QT_BUILD_EXAMPLES_WITH_CPU_OVERCOMMIT)
|
|
|
|
set(terminal_args)
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
2021-12-14 15:56:39 +00:00
|
|
|
# QT_EXAMPLE_INSTALL_MARKER
|
|
|
|
# The goal is to install each example project into a directory that keeps the example source dir
|
|
|
|
# hierarchy, without polluting the example projects with dirty INSTALL_EXAMPLEDIR and
|
|
|
|
# INSTALL_EXAMPLESDIR usage.
|
|
|
|
# E.g. ensure qtbase/examples/widgets/widgets/wiggly is installed to
|
|
|
|
# $qt_example_install_prefix/examples/widgets/widgets/wiggly/wiggly.exe
|
|
|
|
# $qt_example_install_prefix defaults to ${CMAKE_INSTALL_PREFIX}/${INSTALL_EXAMPLEDIR}
|
2021-12-16 11:55:07 +00:00
|
|
|
# but can also be set to a custom location.
|
2021-12-14 15:56:39 +00:00
|
|
|
# This needs to work both:
|
|
|
|
# - when using ExternalProject to build examples
|
|
|
|
# - when examples are built in-tree as part of Qt (no ExternalProject).
|
|
|
|
# The reason we want to support the latter is for nicer IDE integration: a can developer can
|
|
|
|
# work with a Qt repo and its examples using the same build dir.
|
|
|
|
#
|
|
|
|
# In both case we have to ensure examples are not accidentally installed to $qt_prefix/bin or
|
|
|
|
# similar.
|
|
|
|
#
|
|
|
|
# Example projects installation matrix.
|
|
|
|
# 1) ExternalProject + unclean example install rules (INSTALL_EXAMPLEDIR is set) =>
|
|
|
|
# use _qt_internal_override_example_install_dir_to_dot + ExternalProject_Add's INSTALL_DIR
|
|
|
|
# using relative_dir from QT_EXAMPLE_BASE_DIR to example_source_dir
|
|
|
|
#
|
|
|
|
# 2) ExternalProject + clean example install rules =>
|
|
|
|
# use ExternalProject_Add's INSTALL_DIR using relative_dir from QT_EXAMPLE_BASE_DIR to
|
|
|
|
# example_source_dir, _qt_internal_override_example_install_dir_to_dot would be a no-op
|
|
|
|
#
|
|
|
|
# 3) in-tree + unclean example install rules (INSTALL_EXAMPLEDIR is set)
|
|
|
|
# +
|
|
|
|
# 4) in-tree + clean example install rules =>
|
|
|
|
# ensure CMAKE_INSTALL_PREFIX is unset in parent cmake_install.cmake file, set non-cache
|
|
|
|
# CMAKE_INSTALL_PREFIX using relative_dir from QT_EXAMPLE_BASE_DIR to
|
|
|
|
# example_source_dir, use _qt_internal_override_example_install_dir_to_dot to ensure
|
|
|
|
# INSTALL_EXAMPLEDIR does not interfere.
|
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
qt_internal_get_example_install_path(example_install_path "${subdir}")
|
2021-12-14 15:56:39 +00:00
|
|
|
|
|
|
|
set(ep_binary_dir "${CMAKE_CURRENT_BINARY_DIR}/${subdir}")
|
2022-03-23 16:33:13 +00:00
|
|
|
|
|
|
|
set(build_command "")
|
|
|
|
if(QT_INTERNAL_VERBOSE_EXAMPLES AND CMAKE_GENERATOR MATCHES "Ninja")
|
|
|
|
set(build_command BUILD_COMMAND "${CMAKE_COMMAND}" --build "." -- -v)
|
|
|
|
endif()
|
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
ExternalProject_Add(${arg_NAME}
|
|
|
|
EXCLUDE_FROM_ALL TRUE
|
2021-12-14 14:53:15 +00:00
|
|
|
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${subdir}"
|
|
|
|
PREFIX "${CMAKE_CURRENT_BINARY_DIR}/${subdir}-ep"
|
|
|
|
STAMP_DIR "${CMAKE_CURRENT_BINARY_DIR}/${subdir}-ep/stamp"
|
2021-12-14 15:56:39 +00:00
|
|
|
BINARY_DIR "${ep_binary_dir}"
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
INSTALL_DIR "${example_install_path}"
|
2021-05-24 06:35:39 +00:00
|
|
|
INSTALL_COMMAND ""
|
2022-03-23 16:33:13 +00:00
|
|
|
${build_command}
|
2021-05-24 06:35:39 +00:00
|
|
|
TEST_COMMAND ""
|
|
|
|
DEPENDS ${deps}
|
|
|
|
CMAKE_CACHE_ARGS ${var_defs}
|
2021-12-14 15:56:39 +00:00
|
|
|
-DCMAKE_INSTALL_PREFIX:STRING=<INSTALL_DIR>
|
|
|
|
-DQT_INTERNAL_SET_EXAMPLE_INSTALL_DIR_TO_DOT:BOOL=TRUE
|
2021-05-24 06:35:39 +00:00
|
|
|
${terminal_args}
|
|
|
|
)
|
|
|
|
|
2021-12-14 15:56:39 +00:00
|
|
|
# Install the examples when the the user runs 'make install', and not at build time (which is
|
|
|
|
# the default for ExternalProjects).
|
|
|
|
install(CODE "\
|
|
|
|
# Install example from inside ExternalProject into the main build's install prefix.
|
|
|
|
execute_process(
|
|
|
|
COMMAND
|
|
|
|
\"${CMAKE_COMMAND}\" --build \"${ep_binary_dir}\" --target install
|
|
|
|
)
|
|
|
|
")
|
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
# Force configure step to re-run after we configure the main project
|
|
|
|
set(reconfigure_check_file ${CMAKE_CURRENT_BINARY_DIR}/reconfigure_${arg_NAME}.txt)
|
|
|
|
file(TOUCH ${reconfigure_check_file})
|
|
|
|
ExternalProject_Add_Step(${arg_NAME} reconfigure-check
|
|
|
|
DEPENDERS configure
|
|
|
|
DEPENDS ${reconfigure_check_file}
|
|
|
|
${independent_args}
|
|
|
|
)
|
|
|
|
|
2021-06-07 15:14:39 +00:00
|
|
|
# Create an apk external project step and custom target that invokes the apk target
|
|
|
|
# within the external project.
|
|
|
|
# Make the global apk target depend on that custom target.
|
|
|
|
if(ANDROID)
|
|
|
|
ExternalProject_Add_Step(${arg_NAME} apk
|
|
|
|
COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --target apk
|
|
|
|
DEPENDEES configure
|
|
|
|
EXCLUDE_FROM_MAIN YES
|
|
|
|
${terminal_args}
|
|
|
|
)
|
|
|
|
ExternalProject_Add_StepTargets(${arg_NAME} apk)
|
|
|
|
|
|
|
|
if(TARGET apk)
|
|
|
|
add_dependencies(apk ${arg_NAME}-apk)
|
|
|
|
endif()
|
|
|
|
endif()
|
|
|
|
|
2021-05-24 06:35:39 +00:00
|
|
|
cmake_policy(POP)
|
|
|
|
|
|
|
|
string(TOLOWER ${PROJECT_NAME} project_name_lower)
|
|
|
|
add_dependencies(examples_${project_name_lower} ${arg_NAME})
|
|
|
|
|
|
|
|
endfunction()
|
|
|
|
|
CMake: Allow installation of example sources into the Qt prefix
In Qt 5 times, if Qt was configured with -make examples, running
make install would not only build and install the example binaries,
but would also install the example sources into the prefix.
Installation of example sources was not implemented when the Qt 6
build system has switched to using CMake.
There is still a use case for it though, mainly for Qt Creator, which
only shows the examples of a Qt kit if the sources are available.
In contrast to Qt 5, in Qt 6 we will not install example sources
by default. It will be opt in.
To enable installation of examples sources, configure with
configure -make examples -install-examples-sources
or
cmake -DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
The -make examples part is required, otherwise
-install-examples-sources has no effect.
All example sources can be installed by calling
cmake --install . --component examples_sources
in the qt repo build directory.
In a top-level build, per-repo installation can be done using
cmake --install . --component examples_sources_<repo_name>
where repo_name could be 'qtbase'.
A single example's source can be installed by calling
cmake --install . --component examples_sources_<subdir_name>
where subdir_name is the subdirectory name of the example, e.g.
'gallery'.
Implement installation of example sources by hooking into the
qt_internal_add_example command.
This means that all examples in all repos need to be added via
qt_internal_add_example instead of add_subdirectory, to ensure the
sources are installed. The majority of repos already use it.
For testing purposes one can configure with
-DQT_BUILD_EXAMPLES=ON -DQT_INSTALL_EXAMPLES_SOURCES=ON
-DQT_INTERNAL_NO_CONFIGURE_EXAMPLES=ON to allow testing installation
of examples sources without building them.
Take into account an additional variable called
QT_INTERNAL_EXAMPLES_SOURCES_INSTALL_PREFIX to allow installation of
example sources into a location different from the example binaries.
As a cleanup, the NAME option that could previously be passed to
qt_internal_add_example_external_project has been removed.
That's because it's never used anywhere and could not have worked
anyway because qt_internal_add_example_in_tree never handled it.
Pick-to: 6.6
Fixes: QTBUG-112135
Change-Id: I52aa5ec643ff7e212276c88d8dd2dfecdbdbeb0d
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2023-08-07 10:15:35 +00:00
|
|
|
function(qt_internal_install_example_sources subdir)
|
|
|
|
set(options "")
|
|
|
|
set(single_args NAME REPO_NAME)
|
|
|
|
set(multi_args "")
|
|
|
|
|
|
|
|
cmake_parse_arguments(PARSE_ARGV 1 arg "${options}" "${single_args}" "${multi_args}")
|
|
|
|
|
|
|
|
qt_internal_get_examples_sources_install_path(example_install_path "${subdir}")
|
|
|
|
|
|
|
|
# The trailing slash is important to avoid duplicate nested directory names.
|
|
|
|
set(example_source_dir "${subdir}/")
|
|
|
|
|
|
|
|
# Allow controlling whether sources should be part of the default install target.
|
|
|
|
if(QT_INSTALL_EXAMPLES_SOURCES_BY_DEFAULT)
|
|
|
|
set(exclude_from_all "")
|
|
|
|
else()
|
|
|
|
set(exclude_from_all "EXCLUDE_FROM_ALL")
|
|
|
|
endif()
|
|
|
|
|
|
|
|
# Create an install component for all example sources. Can also be part of the default
|
|
|
|
# install target if EXCLUDE_FROM_ALL is not passed.
|
|
|
|
install(
|
|
|
|
DIRECTORY "${example_source_dir}"
|
|
|
|
DESTINATION "${example_install_path}"
|
|
|
|
COMPONENT "examples_sources"
|
|
|
|
USE_SOURCE_PERMISSIONS
|
|
|
|
${exclude_from_all}
|
|
|
|
)
|
|
|
|
|
|
|
|
# Also create a specific install component just for this repo's examples.
|
|
|
|
install(
|
|
|
|
DIRECTORY "${example_source_dir}"
|
|
|
|
DESTINATION "${example_install_path}"
|
|
|
|
COMPONENT "examples_sources_${arg_REPO_NAME}"
|
|
|
|
USE_SOURCE_PERMISSIONS
|
|
|
|
EXCLUDE_FROM_ALL
|
|
|
|
)
|
|
|
|
|
|
|
|
# Also create a specific install component just for the current example's sources.
|
|
|
|
install(
|
|
|
|
DIRECTORY "${example_source_dir}"
|
|
|
|
DESTINATION "${example_install_path}"
|
|
|
|
COMPONENT "examples_sources_${arg_NAME}"
|
|
|
|
USE_SOURCE_PERMISSIONS
|
|
|
|
EXCLUDE_FROM_ALL
|
|
|
|
)
|
|
|
|
endfunction()
|
|
|
|
|
2021-04-21 17:48:37 +00:00
|
|
|
if ("STANDALONE_TEST" IN_LIST Qt6BuildInternals_FIND_COMPONENTS)
|
|
|
|
include(${CMAKE_CURRENT_LIST_DIR}/QtStandaloneTestTemplateProject/Main.cmake)
|
|
|
|
if (NOT PROJECT_VERSION_MAJOR)
|
|
|
|
get_property(_qt_major_version TARGET ${QT_CMAKE_EXPORT_NAMESPACE}::Core PROPERTY INTERFACE_QT_MAJOR_VERSION)
|
|
|
|
set(PROJECT_VERSION ${Qt${_qt_major_version}Core_VERSION})
|
|
|
|
|
|
|
|
string(REPLACE "." ";" _qt_core_version_list ${PROJECT_VERSION})
|
|
|
|
list(GET _qt_core_version_list 0 PROJECT_VERSION_MAJOR)
|
|
|
|
list(GET _qt_core_version_list 1 PROJECT_VERSION_MINOR)
|
|
|
|
list(GET _qt_core_version_list 2 PROJECT_VERSION_PATCH)
|
|
|
|
endif()
|
|
|
|
endif()
|
2021-06-03 11:51:48 +00:00
|
|
|
|
|
|
|
function(qt_internal_static_link_order_test)
|
2021-06-10 17:01:35 +00:00
|
|
|
# The CMake versions greater than 3.21 take care about the resource object files order in a
|
|
|
|
# linker line, it's expected that all object files are located at the beginning of the linker
|
|
|
|
# line.
|
|
|
|
# No need to run the test.
|
|
|
|
if(CMAKE_VERSION VERSION_LESS 3.21)
|
2021-06-16 17:24:59 +00:00
|
|
|
__qt_internal_check_link_order_matters(link_order_matters)
|
2021-06-10 17:01:35 +00:00
|
|
|
if(link_order_matters)
|
|
|
|
set(summary_message "no")
|
|
|
|
else()
|
|
|
|
set(summary_message "yes")
|
|
|
|
endif()
|
2021-06-03 11:51:48 +00:00
|
|
|
else()
|
|
|
|
set(summary_message "yes")
|
|
|
|
endif()
|
|
|
|
qt_configure_add_summary_entry(TYPE "message"
|
|
|
|
ARGS "Linker can resolve circular dependencies"
|
|
|
|
MESSAGE "${summary_message}"
|
|
|
|
)
|
|
|
|
endfunction()
|
|
|
|
|
2021-06-29 16:00:39 +00:00
|
|
|
function(qt_internal_check_cmp0099_available)
|
|
|
|
# Don't care about CMP0099 in CMake versions greater than or equal to 3.21
|
|
|
|
if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.21)
|
|
|
|
return()
|
|
|
|
endif()
|
|
|
|
|
|
|
|
__qt_internal_check_cmp0099_available(result)
|
|
|
|
if(result)
|
|
|
|
set(summary_message "yes")
|
|
|
|
else()
|
|
|
|
set(summary_message "no")
|
|
|
|
endif()
|
|
|
|
qt_configure_add_summary_entry(TYPE "message"
|
|
|
|
ARGS "CMake policy CMP0099 is supported"
|
|
|
|
MESSAGE "${summary_message}"
|
|
|
|
)
|
|
|
|
endfunction()
|
|
|
|
|
2021-06-03 11:51:48 +00:00
|
|
|
function(qt_internal_run_common_config_tests)
|
|
|
|
qt_configure_add_summary_section(NAME "Common build options")
|
|
|
|
qt_internal_static_link_order_test()
|
2021-06-29 16:00:39 +00:00
|
|
|
qt_internal_check_cmp0099_available()
|
2021-06-03 11:51:48 +00:00
|
|
|
qt_configure_end_summary_section()
|
|
|
|
endfunction()
|
2023-05-09 12:37:33 +00:00
|
|
|
|
|
|
|
# It is used in QtWebEngine to replace the REALPATH with ABSOLUTE path, which is
|
|
|
|
# useful for building Qt in Homebrew.
|
|
|
|
function(qt_internal_get_filename_path_mode out_var)
|
|
|
|
set(mode REALPATH)
|
|
|
|
if(APPLE AND QT_ALLOW_SYMLINK_IN_PATHS)
|
|
|
|
set(mode ABSOLUTE)
|
|
|
|
endif()
|
|
|
|
set(${out_var} ${mode} PARENT_SCOPE)
|
|
|
|
endfunction()
|