6.1.3 compile against 6.2.4 assistant webengine

.cmake.conf

@@ -0,0 +1 @@
+set(QT_REPO_MODULE_VERSION "6.1.3")

.gitignore

@@ -64,7 +64,6 @@ bin/lrelease*
 bin/lupdate*
 bin/lconvert*
 bin/moc*
-bin/makeqpf*
 bin/pixeltool*
 bin/qmake*
 bin/qdoc3*
@@ -113,10 +112,6 @@ translations/*.qm
 translations/*_untranslated.ts
 qrc_*.cpp
 
-src/assistant/lib/fulltextsearch/qtcluceneversion.h
-src/assistant/lib/qthelpversion.h
-src/designer/src/lib/qtdesignerversion.h
-
 # Test generated files
 QObject.log
 tst_*

.prev_configure.cmake

@@ -0,0 +1,118 @@
+
+
+#### Inputs
+
+
+
+#### Libraries
+
+
+
+#### Tests
+
+# libclang
+qt_find_package(WrapLibClang PROVIDED_TARGETS WrapLibClang::WrapLibClang)
+
+if(TARGET WrapLibClang::WrapLibClang)
+    set(TEST_libclang "ON" CACHE BOOL "Required libclang version found." FORCE)
+endif()
+
+
+
+#### Features
+
+qt_feature("assistant" PRIVATE
+    LABEL "Qt Assistant"
+    PURPOSE "Qt Assistant is a tool for viewing on-line documentation in Qt help file format."
+)
+qt_feature("clang" PRIVATE
+    LABEL "QDoc"
+    CONDITION TEST_libclang
+)
+qt_feature("clangcpp" PRIVATE
+    LABEL "Clang-based lupdate parser"
+    CONDITION QT_FEATURE_clang AND TEST_libclang
+)
+qt_feature("designer" PRIVATE
+    LABEL "Qt Designer"
+    PURPOSE "Qt Designer is the Qt tool for designing and building graphical user interfaces (GUIs) with Qt Widgets. You can compose and customize your windows or dialogs in a what-you-see-is-what-you-get (WYSIWYG) manner, and test them using different styles and resolutions."
+)
+qt_feature("distancefieldgenerator" PRIVATE
+    LABEL "Qt Distance Field Generator"
+    PURPOSE "The Qt Distance Field Generator tool can be used to pregenerate the font cache in order to optimize startup performance."
+)
+qt_feature("kmap2qmap" PRIVATE
+    LABEL "kmap2qmap"
+    PURPOSE "kmap2qmap is a tool to generate keymaps for use on Embedded Linux. The source files have to be in standard Linux kmap format that is e.g. understood by the kernel's loadkeys command."
+)
+qt_feature("linguist" PRIVATE
+    LABEL "Qt Linguist"
+    PURPOSE "Qt Linguist can be used by translator to translate text in Qt applications."
+)
+qt_feature("macdeployqt" PRIVATE
+    LABEL "Mac Deployment Tool"
+    PURPOSE "The Mac deployment tool automates the process of creating a deployable application bundle that contains the Qt libraries as private frameworks."
+    CONDITION APPLE
+)
+qt_feature("pixeltool" PRIVATE
+    LABEL "pixeltool"
+    PURPOSE "The Qt Pixel Zooming Tool is a graphical application that magnifies the screen around the mouse pointer so you can look more closely at individual pixels."
+)
+qt_feature("qdbus" PRIVATE
+    LABEL "qdbus"
+    PURPOSE "qdbus is a communication interface for Qt-based applications."
+)
+qt_feature("qev" PRIVATE
+    LABEL "qev"
+    PURPOSE "qev allows introspection of incoming events for a QWidget, similar to the X11 xev tool."
+)
+qt_feature("qtattributionsscanner" PRIVATE
+    LABEL "Qt Attributions Scanner"
+    PURPOSE "Qt Attributions Scanner generates attribution documents for third-party code in Qt."
+)
+qt_feature("qtdiag" PRIVATE
+    LABEL "qtdiag"
+    PURPOSE "qtdiag outputs information about the Qt installation it was built with."
+)
+qt_feature("qtpaths" PRIVATE
+    LABEL "qtpaths"
+    PURPOSE "qtpaths is a command line client to QStandardPaths."
+)
+qt_feature("qtplugininfo" PRIVATE
+    LABEL "qtplugininfo"
+    PURPOSE "qtplugininfo dumps metadata about Qt plugins in JSON format."
+)
+qt_feature("windeployqt" PRIVATE
+    LABEL "Windows deployment tool"
+    PURPOSE "The Windows deployment tool is designed to automate the process of creating a deployable folder containing the Qt-related dependencies (libraries, QML imports, plugins, and translations) required to run the application from that folder. It creates a sandbox for Universal Windows Platform (UWP) or an installation tree for Windows desktop applications, which can be easily bundled into an installation package."
+    CONDITION WIN32
+)
+qt_configure_add_summary_section(NAME "Qt Tools")
+qt_configure_add_summary_entry(ARGS "assistant")
+qt_configure_add_summary_entry(ARGS "clang")
+qt_configure_add_summary_entry(ARGS "clangcpp")
+qt_configure_add_summary_entry(ARGS "designer")
+qt_configure_add_summary_entry(ARGS "distancefieldgenerator")
+qt_configure_add_summary_entry(ARGS "kmap2qmap")
+qt_configure_add_summary_entry(ARGS "linguist")
+qt_configure_add_summary_entry(ARGS "macdeployqt")
+qt_configure_add_summary_entry(ARGS "pixeltool")
+qt_configure_add_summary_entry(ARGS "qdbus")
+qt_configure_add_summary_entry(ARGS "qev")
+qt_configure_add_summary_entry(ARGS "qtattributionsscanner")
+qt_configure_add_summary_entry(ARGS "qtdiag")
+qt_configure_add_summary_entry(ARGS "qtpaths")
+qt_configure_add_summary_entry(ARGS "qtplugininfo")
+qt_configure_add_summary_entry(ARGS "windeployqt")
+qt_configure_end_summary_section() # end of "Qt Tools" section
+qt_configure_add_report_entry(
+    TYPE WARNING
+    MESSAGE "QDoc will not be compiled, probably because libclang could not be located. This means that you cannot build the Qt documentation.
+ Either set CMAKE_PREFIX_PATH or LLVM_INSTALL_DIR to the location of your llvm installation. On Linux systems, you may be able to install libclang by installing the libclang-dev or libclang-devel package, depending on your distribution. On macOS, you can use Homebrew's llvm package."
+    CONDITION NOT QT_FEATURE_clang
+)
+qt_configure_add_report_entry(
+    TYPE WARNING
+    MESSAGE "Clang-based lupdate parser will not be available. LLVM and Clang C++ libraries have not been found."
+    CONDITION NOT QT_FEATURE_clangcpp
+)

.qmake.conf

@@ -1,3 +1,5 @@
 load(qt_build_config)
 
-MODULE_VERSION = 5.14.0
+DEFINES += QT_NO_JAVA_STYLE_ITERATORS
+
+MODULE_VERSION = 6.1.3

CMakeLists.txt

@@ -0,0 +1,41 @@
+# Generated from qttools.pro.
+
+cmake_minimum_required(VERSION 3.15.0)
+
+include(.cmake.conf)
+project(QtTools # special case
+    VERSION "${QT_REPO_MODULE_VERSION}"
+    DESCRIPTION "Qt Tools" # special case
+    HOMEPAGE_URL "https://qt.io/"
+    LANGUAGES CXX C
+)
+
+# special case begin
+set(QT_REPO_NOT_WARNINGS_CLEAN TRUE)
+
+# Make sure we only use latest private CMake API, aka no compatibility wrappers.
+set(QT_NO_INTERNAL_COMPATIBILITY_FUNCTIONS TRUE)
+
+# Make sure we use the fixed BASE argument of qt_add_resource.
+set(QT_USE_FIXED_QT_ADD_RESOURCE_BASE TRUE)
+
+# add platform specific compontents
+set(optional_components "")
+if(WIN32)
+    list(APPEND optional_components AxContainer)
+endif()
+
+find_package(Qt6 ${PROJECT_VERSION} CONFIG REQUIRED COMPONENTS BuildInternals Core Network)
+find_package(Qt6 ${PROJECT_VERSION} QUIET CONFIG OPTIONAL_COMPONENTS
+             DBus Xml Widgets Quick QuickWidgets QmlDevToolsPrivate
+             Sql PrintSupport OpenGL OpenGLWidgets ${optional_components})
+# special case end
+
+qt_build_repo()
+
+# special case begin
+
+# Add tool dependencies that were deferred by qt_internal_add_docs.
+qt_internal_add_deferred_dependencies()
+
+# special case end

README.md

@@ -0,0 +1,40 @@
+# qttools: Assistant/WebEngine
+
+This is a fork of the official qttools repository for the sole purpose of compiling Qt Assistant against a stock binary distribution of Qt, without needing to build Qt itself. Assistant is patched to work with Qt WebEngine to give it full HTML browsing capability. The changes in this repository are additive in nature, but due to changes upstream it may be difficult to maintain in the future.
+
+## Compilation using Qt Creator
+
+<ol>
+<li> Switch to the <code>6.1.3_compile_against_6.2.4_assistant_webengine</code> branch.
+  <li> Using a stock distribution of the Qt SDK <i>with WebEngine support</i> (6.2.4 is known to work) open the file <code>CMakeLists.txt</code> in Qt Creator.
+<li> In Projects, select the appropriate Qt Kit if you have multiple installed.
+<li> In Build Settings, for Debug and Release individually, Build Steps, add this Custom Process Step (shown for Windows):<br><br>
+
+Field              | Content
+------------------ | -------------
+Command:           | windeployqt
+Arguments:         | assistant.exe
+Working directory: | %{buildDir}\bin
+
+This will copy the necessary shared libraries so that Assistant will run from the <code>bin</code> subdirectory inside the build directory.
+</ol>
+
+## Compilation using cmake
+<ol>
+<li> Switch to the <code>6.1.3_compile_against_6.2.4_assistant_webengine</code> branch.
+<li> Ensure you have appropriate cmake version (3.15+).
+<li> Ensure you have the correct version of Qt configured, or pass in on cmake command line.
+<li> Set up to use appropriate compiler (e.g. scl enable, or vcvars64.bat).
+<li> Create build directory and change to it. (E.g. as a subdirectory of qttools)
+<li> For Windows: 
+<ol>
+  <li> Run cmake: cmake .. -DCMAKE_PREFIX_PATH=p:\qt\qt-opensource-6.2.4\win64_vc142 -DCMAKE_GENERATOR=Ninja -DCMAKE_BUILD_TYPE=Release
+  <li> ninja.exe assistant
+</ol>
+<li> For Linux: 
+<ol>
+  <li> Run cmake: cmake ..
+  <li> make assistant
+</ol>
+
+</ol>

cmake/FindWrapLibClang.cmake

@@ -0,0 +1,81 @@
+if(TARGET WrapLibClang::WrapLibClang)
+    set(WrapLibClang_FOUND TRUE)
+    return()
+endif()
+
+if(DEFINED ENV{LLVM_INSTALL_DIR})
+    set(__qt_wrap_clang_backup_prefix "${CMAKE_PREFIX_PATH}")
+    list(PREPEND CMAKE_PREFIX_PATH "$ENV{LLVM_INSTALL_DIR}")
+elseif(DEFINED CACHE{LLVM_INSTALL_DIR})
+    set(__qt_wrap_clang_backup_prefix "${CMAKE_PREFIX_PATH}")
+    list(PREPEND CMAKE_PREFIX_PATH "${LLVM_INSTALL_DIR}")
+endif()
+
+find_package(Clang CONFIG)
+
+if(__qt_wrap_clang_backup_prefix)
+    set(CMAKE_PREFIX_PATH "${__qt_wrap_clang_backup_prefix}")
+    unset(__qt_wrap_clang_backup_prefix)
+endif()
+
+set(WrapLibClang_FOUND FALSE)
+set(__wrap_lib_clang_requested_version_found FALSE)
+
+# Need to explicitly handle the version check, because the Clang package doesn't.
+if(WrapLibClang_FIND_VERSION AND LLVM_PACKAGE_VERSION
+        AND LLVM_PACKAGE_VERSION VERSION_GREATER_EQUAL "${WrapLibClang_FIND_VERSION}")
+    set(__wrap_lib_clang_requested_version_found TRUE)
+endif()
+
+if(TARGET libclang AND ((TARGET clang-cpp AND TARGET LLVM) OR TARGET clangHandleCXX) AND __wrap_lib_clang_requested_version_found)
+    set(WrapLibClang_FOUND TRUE)
+
+    get_target_property(type libclang TYPE)
+    if (MSVC AND type STREQUAL "STATIC_LIBRARY")
+        get_property(__wrap_lib_clang_multi_config
+            GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+        if(__wrap_lib_clang_multi_config)
+            set(__wrap_lib_clang_configs ${CMAKE_CONFIGURATION_TYPES})
+        else()
+            set(__wrap_lib_clang_configs ${CMAKE_BUILD_TYPE})
+        endif()
+        set(__wrap_lib_clang_non_release_configs ${configs})
+        list(REMOVE_ITEM __wrap_lib_clang_non_release_configs
+            Release MinSizeRel RelWithDebInfo)
+        if(__wrap_lib_clang_non_release_configs STREQUAL __wrap_lib_clang_configs)
+            message(STATUS "Static linkage against libclang with MSVC was requested, but the build is not a release build, therefore libclang cannot be used.")
+            set(WrapLibClang_FOUND FALSE)
+        endif()
+    endif()
+
+    if(WrapLibClang_FOUND)
+        add_library(WrapLibClang::WrapLibClang IMPORTED INTERFACE)
+
+        target_include_directories(WrapLibClang::WrapLibClang INTERFACE ${CLANG_INCLUDE_DIRS})
+        if (NOT TARGET Threads::Threads)
+            find_package(Threads)
+        endif()
+        qt_internal_disable_find_package_global_promotion(Threads::Threads)
+        # lupdate must also link to LLVM when using clang-cpp
+        set(__qt_clang_genex_condition "$<AND:$<TARGET_EXISTS:clang-cpp>,$<TARGET_EXISTS:LLVM>>")
+        set(__qt_clang_genex "$<IF:${__qt_clang_genex_condition},clang-cpp;LLVM,clangHandleCXX>")
+        target_link_libraries(WrapLibClang::WrapLibClang
+            INTERFACE libclang
+            ${__qt_clang_genex}
+            Threads::Threads
+            )
+
+        foreach(version MAJOR MINOR PATCH)
+            set(QT_LIB_CLANG_VERSION_${version} ${LLVM_VERSION_${version}} CACHE STRING "" FORCE)
+        endforeach()
+        set(QT_LIB_CLANG_VERSION ${LLVM_PACKAGE_VERSION} CACHE STRING "" FORCE)
+        set(QT_LIB_CLANG_LIBDIR "${LLVM_LIBRARY_DIRS}" CACHE STRING "" FORCE)
+        set(QT_LIBCLANG_RESOURCE_DIR
+            "\"${QT_LIB_CLANG_LIBDIR}/clang/${QT_LIB_CLANG_VERSION}/include\"" CACHE STRING "" FORCE)
+    endif()
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(WrapLibClang
+    REQUIRED_VARS WrapLibClang_FOUND
+    VERSION_VAR LLVM_PACKAGE_VERSION)

coin/module_config.yaml

@@ -0,0 +1,38 @@
+version: 2
+accept_configuration:
+  condition: property
+  property: features
+  not_contains_value: Disable
+
+instructions:
+  Build:
+    - !include "{{qt/qtbase}}/coin_module_build_template_v2.yaml"
+
+  Test:
+    - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml"
+    - type: Group
+      instructions:
+        - !include "{{qt/qtbase}}/prepare_building_env.yaml"
+        - type: EnvironmentVariable
+          variableName: QDOC_NOLINKERRORS
+          variableValue: 1
+        - type: EnvironmentVariable
+          variableName: QDOC_ENABLE_WARNINGLIMIT
+          variableValue: 1
+        - type: SetBuildDirectory
+          directory: "{{.SourceDir}}"
+        - type: ChangeDirectory
+          directory: "{{.BuildDir}}"
+        - type: EnvironmentVariable
+          variableName: COIN_CMAKE_ARGS
+          variableValue: "-DBUILD_TESTING=OFF {{.SourceDir}}"
+        - !include "{{qt/qtbase}}/call_cmake.yaml"
+        - type: ExecuteCommand
+          command: "cmake --build . --target generate_docs"
+          maxTimeInSeconds: 1800
+          maxTimeBetweenOutput: 900
+          userMessageOnFailure: "Documentation check failed, see the log for details."
+      enable_if:
+        condition: property
+        property: features
+        contains_value: "TestDocs"