summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuca Di Sera <luca.disera@qt.io>2023-05-10 16:29:48 +0200
committerLuca Di Sera <luca.disera@qt.io>2023-05-11 11:17:21 +0200
commit453fa4ca39c93f31d496d856babda17b919d6cec (patch)
tree460662fc03e25a23d401d65bb8e225e03c453289
parentd927a87b765681dc7fb1bf2ba81a113000141d7b (diff)
downloadqttools-453fa4ca39c93f31d496d856babda17b919d6cec.tar.gz
QDoc: Move catch_conversions under src
QDoc employs a very small support library, "catch_conversions", to provide better output for certain types when used with the Catch2 testing framework, which QDoc uses for some of its tests. "catch_conversions" was currently kept under "tests/auto/qdoc" and its headers were included and used directly by its sibling tests by relative paths. Due to a certain restructuring that is happening in QDoc, with one of the goals, among others, being to increase the locality of QDoc-related code under "src/qdoc", the "catch_conversions" support library is now moved under "src/qdoc". To allow code that depended on it to keep their usages without requiring the addition of some relative paths from the "tests" directory to the "src" directory, a library target, "Qt::QDocCatchConversionsPrivate" was created for the support library. The target can be linked-to to gain access to the previously-directly-used headers, with include path "catch_conversions/.*". To allow for this specific include path to work, the internal directory structure for "catch_conversions" was slightly modified with the addition of some intermediate directories in between its root and the library headers. Targets under "tests/auto/qdoc" that used the dependency now link to it instead. Hence, their "CMakeLists.txt" files were modified to avoid using the dependency as an include directory and instead use "Qt::QDocCatchConversionsPrivate" as a library. The inclusions of the of the "catch_conversions" headers in relevant sources was modified to respect the new "catch_conversions/.*" path. The root "CMakeLists.txt" file under "src/qdoc" was modified to add the relevant library as a subdirectory. Change-Id: Iec24ca3877a48a42a55ff406309813aa083ab23f Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--src/qdoc/CMakeLists.txt1
-rw-r--r--src/qdoc/catch_conversions/CMakeLists.txt10
-rw-r--r--src/qdoc/catch_conversions/src/catch_conversions/qdoc_catch_conversions.h (renamed from tests/auto/qdoc/catch_conversions/qdoc_catch_conversions.h)0
-rw-r--r--src/qdoc/catch_conversions/src/catch_conversions/qt_catch_conversions.h (renamed from tests/auto/qdoc/catch_conversions/qt_catch_conversions.h)0
-rw-r--r--src/qdoc/catch_conversions/src/catch_conversions/std_catch_conversions.h (renamed from tests/auto/qdoc/catch_conversions/std_catch_conversions.h)0
-rw-r--r--tests/auto/qdoc/catch_generators/tests/CMakeLists.txt2
-rw-r--r--tests/auto/qdoc/catch_generators/tests/generators/catch_path_generator.cpp2
-rw-r--r--tests/auto/qdoc/catch_generators/tests/generators/catch_qchar_generator.cpp2
-rw-r--r--tests/auto/qdoc/catch_generators/tests/generators/catch_qstring_generator.cpp2
-rw-r--r--tests/auto/qdoc/catch_generators/tests/generators/combinators/catch_oneof_generator.cpp2
-rw-r--r--tests/auto/qdoc/qdoc/CMakeLists.txt2
-rw-r--r--tests/auto/qdoc/qdoc/boundaries/filesystem/catch_directorypath.cpp2
-rw-r--r--tests/auto/qdoc/qdoc/boundaries/filesystem/catch_filepath.cpp2
-rw-r--r--tests/auto/qdoc/qdoc/filesystem/catch_fileresolver.cpp2
14 files changed, 20 insertions, 9 deletions
diff --git a/src/qdoc/CMakeLists.txt b/src/qdoc/CMakeLists.txt
index bcd7c46bb..11f947e01 100644
--- a/src/qdoc/CMakeLists.txt
+++ b/src/qdoc/CMakeLists.txt
@@ -2,6 +2,7 @@
# SPDX-License-Identifier: BSD-3-Clause
add_subdirectory(catch)
+add_subdirectory(catch_conversions)
if(QT_FEATURE_qdoc AND QT_FEATURE_clangcpp)
add_subdirectory(qdoc)
diff --git a/src/qdoc/catch_conversions/CMakeLists.txt b/src/qdoc/catch_conversions/CMakeLists.txt
new file mode 100644
index 000000000..e19514c01
--- /dev/null
+++ b/src/qdoc/catch_conversions/CMakeLists.txt
@@ -0,0 +1,10 @@
+qt_internal_add_module(QDocCatchConversionsPrivate
+ HEADER_MODULE
+ EXTERNAL_HEADERS_DIR src
+)
+
+qt_internal_extend_target(QDocCatchConversionsPrivate
+ PUBLIC_INCLUDE_DIRECTORIES
+ $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
+ $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/QtQDocCatchConversionsPrivate>
+)
diff --git a/tests/auto/qdoc/catch_conversions/qdoc_catch_conversions.h b/src/qdoc/catch_conversions/src/catch_conversions/qdoc_catch_conversions.h
index ef0cb2cef..ef0cb2cef 100644
--- a/tests/auto/qdoc/catch_conversions/qdoc_catch_conversions.h
+++ b/src/qdoc/catch_conversions/src/catch_conversions/qdoc_catch_conversions.h
diff --git a/tests/auto/qdoc/catch_conversions/qt_catch_conversions.h b/src/qdoc/catch_conversions/src/catch_conversions/qt_catch_conversions.h
index 68abf5fb0..68abf5fb0 100644
--- a/tests/auto/qdoc/catch_conversions/qt_catch_conversions.h
+++ b/src/qdoc/catch_conversions/src/catch_conversions/qt_catch_conversions.h
diff --git a/tests/auto/qdoc/catch_conversions/std_catch_conversions.h b/src/qdoc/catch_conversions/src/catch_conversions/std_catch_conversions.h
index be8fa65d7..be8fa65d7 100644
--- a/tests/auto/qdoc/catch_conversions/std_catch_conversions.h
+++ b/src/qdoc/catch_conversions/src/catch_conversions/std_catch_conversions.h
diff --git a/tests/auto/qdoc/catch_generators/tests/CMakeLists.txt b/tests/auto/qdoc/catch_generators/tests/CMakeLists.txt
index 240f5ac63..76c366331 100644
--- a/tests/auto/qdoc/catch_generators/tests/CMakeLists.txt
+++ b/tests/auto/qdoc/catch_generators/tests/CMakeLists.txt
@@ -15,7 +15,7 @@ qt_internal_add_test(tst_QDoc_Catch_Generators
utilities/semantics/catch_generator_handler.cpp
INCLUDE_DIRECTORIES
../src
- ../../catch_conversions
LIBRARIES
Qt::QDocCatchPrivate
+ Qt::QDocCatchConversionsPrivate
)
diff --git a/tests/auto/qdoc/catch_generators/tests/generators/catch_path_generator.cpp b/tests/auto/qdoc/catch_generators/tests/generators/catch_path_generator.cpp
index 71e9e50b4..968008a56 100644
--- a/tests/auto/qdoc/catch_generators/tests/generators/catch_path_generator.cpp
+++ b/tests/auto/qdoc/catch_generators/tests/generators/catch_path_generator.cpp
@@ -10,7 +10,7 @@
#include "utilities/statistics/distribution.h"
#include "utilities/semantics/copy_value.h"
-#include <qt_catch_conversions.h>
+#include <catch_conversions/qt_catch_conversions.h>
#include <catch/catch.hpp>
diff --git a/tests/auto/qdoc/catch_generators/tests/generators/catch_qchar_generator.cpp b/tests/auto/qdoc/catch_generators/tests/generators/catch_qchar_generator.cpp
index a072aff88..47ef23364 100644
--- a/tests/auto/qdoc/catch_generators/tests/generators/catch_qchar_generator.cpp
+++ b/tests/auto/qdoc/catch_generators/tests/generators/catch_qchar_generator.cpp
@@ -4,7 +4,7 @@
#include "namespaces.h"
#include "generators/qchar_generator.h"
-#include <qt_catch_conversions.h>
+#include <catch_conversions/qt_catch_conversions.h>
#include <catch/catch.hpp>
diff --git a/tests/auto/qdoc/catch_generators/tests/generators/catch_qstring_generator.cpp b/tests/auto/qdoc/catch_generators/tests/generators/catch_qstring_generator.cpp
index e99335dd0..75d7efcf1 100644
--- a/tests/auto/qdoc/catch_generators/tests/generators/catch_qstring_generator.cpp
+++ b/tests/auto/qdoc/catch_generators/tests/generators/catch_qstring_generator.cpp
@@ -5,7 +5,7 @@
#include "generators/qchar_generator.h"
#include "generators/qstring_generator.h"
-#include <qt_catch_conversions.h>
+#include <catch_conversions/qt_catch_conversions.h>
#include <catch/catch.hpp>
diff --git a/tests/auto/qdoc/catch_generators/tests/generators/combinators/catch_oneof_generator.cpp b/tests/auto/qdoc/catch_generators/tests/generators/combinators/catch_oneof_generator.cpp
index 191ac9dfe..68e990813 100644
--- a/tests/auto/qdoc/catch_generators/tests/generators/combinators/catch_oneof_generator.cpp
+++ b/tests/auto/qdoc/catch_generators/tests/generators/combinators/catch_oneof_generator.cpp
@@ -1,7 +1,7 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
-#include <std_catch_conversions.h>
+#include <catch_conversions/std_catch_conversions.h>
#include "namespaces.h"
#include "generators/k_partition_of_r_generator.h"
diff --git a/tests/auto/qdoc/qdoc/CMakeLists.txt b/tests/auto/qdoc/qdoc/CMakeLists.txt
index 616139712..925290ecd 100644
--- a/tests/auto/qdoc/qdoc/CMakeLists.txt
+++ b/tests/auto/qdoc/qdoc/CMakeLists.txt
@@ -16,7 +16,7 @@ qt_internal_add_test(tst_QDoc
INCLUDE_DIRECTORIES
${QDOC_INCLUDE_DIRECTORY}
../catch_generators/
- ../catch_conversions/
LIBRARIES
Qt::QDocCatchPrivate
+ Qt::QDocCatchConversionsPrivate
)
diff --git a/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_directorypath.cpp b/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_directorypath.cpp
index ed31a50ec..5321e2619 100644
--- a/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_directorypath.cpp
+++ b/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_directorypath.cpp
@@ -1,7 +1,7 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
-#include <qdoc_catch_conversions.h>
+#include <catch_conversions/qdoc_catch_conversions.h>
#include <catch/catch.hpp>
diff --git a/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_filepath.cpp b/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_filepath.cpp
index 167aafc85..46481e4d6 100644
--- a/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_filepath.cpp
+++ b/tests/auto/qdoc/qdoc/boundaries/filesystem/catch_filepath.cpp
@@ -1,7 +1,7 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
-#include <qdoc_catch_conversions.h>
+#include <catch_conversions/qdoc_catch_conversions.h>
#include <catch/catch.hpp>
diff --git a/tests/auto/qdoc/qdoc/filesystem/catch_fileresolver.cpp b/tests/auto/qdoc/qdoc/filesystem/catch_fileresolver.cpp
index 440de7bee..fca33debb 100644
--- a/tests/auto/qdoc/qdoc/filesystem/catch_fileresolver.cpp
+++ b/tests/auto/qdoc/qdoc/filesystem/catch_fileresolver.cpp
@@ -1,7 +1,7 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
-#include <qdoc_catch_conversions.h>
+#include <catch_conversions/qdoc_catch_conversions.h>
#include <catch/catch.hpp>