Add graphviz as submodule (#47)

* Add graphviz as submodule

* Create fwd_headers for submodule graphiz

* Fix exporting graphviz targets

* Fix submodule build/link

* Fix size_t warning

* Build with Windows/macOS

* [ci] Add macOS bison to PATH

* Try to build on Windows with 64bit

* Changes to static link graphviz

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update submodule with graphviz that has static build fixes

* Build graphviz in static mode

* Check if other OSes are still building and try to dump dlls from tests

* Disable msvc setup on !windows

* Try dumpbin

* run dumpbin on failure

* Try to fix linux and dumpbin

* fix typo test

* try to find test

* another try

* dumpbin

* Revert kdstatemachineeditor_core to SHARED

* Manually disable gvedit again

* try devenv

* try Dependency Walker

* update graphviz

* PIC revert was not merged yet

* fix macos

* Try to fix macos bison

* Fix macos on apple silicon

* fix variable name

* Fix variable

* make sure linux & macos pass all variants

* Add graphviz deps bin to path

* 2nd try

* Another path fix try

* inspecting github_path

* Test if dir needs to exist

* CMake copy depencencies to bin dir

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* cleanups

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: dantti

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         os:
           - ubuntu-latest
@@ -26,28 +26,26 @@ jobs:
           - Debug
           - Release
         config:
-          - qt_version: "5.15"
-            qt_arch: win64_mingw81
-          - qt_version: "6.4.*"
+          - qt_version: 5.15.2
+            qt_arch: win64_msvc2019_64
+            macos_architectures: "x86_64"
+          - qt_version: 6.6.2
             qt_modules: qtscxml
-            qt_arch: win64_mingw
+            qt_arch: win64_msvc2019_64
+            macos_architectures: "x86_64;arm64"
 
     steps:
       - name: Install Dependencies on Linux
         if: ${{ runner.os == 'Linux' }}
         run: |
           sudo apt update -qq
-          sudo apt install -y doxygen libgraphviz-dev
-
-      - name: Install Dependencies on Windows (graphviz was built with MinGW)
-        if: ${{ runner.os == 'Windows' }}
-        run: choco install winflexbison3 graphviz
+          sudo apt install -y doxygen libgtk2.0-dev
 
       - name: Install Dependencies on macOS
         if: ${{ runner.os == 'macOS' }}
-        run: brew install graphviz
+        run: brew install bison
 
-      - name: Install Qt with options and default aqtversion (Linux/macOS)
+      - name: Install Qt ${{ matrix.config.qt_version }} with options and default aqtversion (Linux/macOS)
         if: ${{ runner.os != 'Windows' }}
         uses: jurplel/install-qt-action@v3
         with:
@@ -63,33 +61,54 @@ jobs:
           aqtversion: null # use whatever the default is
           modules: ${{ matrix.config.qt_modules }}
           version: ${{ matrix.config.qt_version }}
-          arch: ${{ matrix.config.qt_arch }} # MinGW is required otherwise we get link errors with graphviz
+          arch: ${{ matrix.config.qt_arch }}
           cache: true
 
-      - name: Add Graphviz libraries to Windows PATH
-        if: ${{ runner.os == 'Windows' }}
-        shell: bash
-        run: echo "C:/Program Files/Graphviz/bin" >> $GITHUB_PATH
-
       - name: Install ninja-build tool (must be after Qt due PATH changes)
         uses: turtlesec-no/get-ninja@main
 
+      - name: Add Bison to PATH (must be after Qt due PATH changes)
+        if: ${{ runner.os == 'macOS' }}
+        run: echo "/opt/homebrew/opt/bison/bin" >> $GITHUB_PATH
+
+      - uses: TheMrMilchmann/setup-msvc-dev@v3
+        if: ${{ runner.os == 'Windows' }}
+        with:
+          arch: x64
+
       - name: Checkout sources
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
-      - name: Fetch Git submodule
-        run: git submodule update --init --recursive
-
-      - name: Configure project
+      - name: Configure project (Linux/macOS)
+        if: ${{ runner.os != 'Windows' }}
         run: >
           cmake -S . -B ./build -G Ninja
-          --warn-uninitialized -Werror=dev
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
-          -DCMAKE_PREFIX_PATH='C:\Program Files\Graphviz'
+          -DCMAKE_OSX_ARCHITECTURES="${{ matrix.config.macos_architectures }}"
           -DBUILD_QT6=${{ startsWith(matrix.config.qt_version, '6.') }}
           -DBUILD_TESTS=${{ matrix.build_type == 'Debug' }}
           -DBUILD_EXAMPLES=ON
           -DBUILD_DOCS=${{ matrix.build_type == 'Debug' && runner.os == 'Linux' }}
+          -DWITH_INTERNAL_GRAPHVIZ=ON
+          -Dwith_gvedit=OFF
+
+      - name: Configure project (Windows)
+        if: ${{ runner.os == 'Windows' }}
+        run: >
+            cmake -S . -B ./build -G Ninja
+            -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+            -DBUILD_QT6=${{ startsWith(matrix.config.qt_version, '6.') }}
+            -DBUILD_TESTS=${{ matrix.build_type == 'Debug' }}
+            -DBUILD_EXAMPLES=ON
+            -DBUILD_DOCS=${{ matrix.build_type == 'Debug' && runner.os == 'Linux' }}
+            -DWITH_INTERNAL_GRAPHVIZ=ON
+            -Dwith_gvedit=OFF
+            -DCMAKE_PREFIX_PATH="${{github.workspace}}/3rdparty/graphviz/windows/dependencies/libraries"
+            -DCMAKE_PROGRAM_PATH="${{github.workspace}}/3rdparty/graphviz/windows/dependencies/graphviz-build-utilities"
+            -DBISON_EXECUTABLE="${{github.workspace}}/3rdparty/graphviz/windows/dependencies/graphviz-build-utilities/winflexbison/win_bison.exe"
+            -DFLEX_EXECUTABLE="${{github.workspace}}/3rdparty/graphviz/windows/dependencies/graphviz-build-utilities/winflexbison/win_flex.exe"
 
       - name: Build Project
         run: cmake --build ./build

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "3rdparty/graphviz"]
+	path = 3rdparty/graphviz
+	url = https://gitlab.com/graphviz/graphviz.git

.reuse/dep5

@@ -14,7 +14,7 @@ Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
 License: LGPL-2.1-only OR LicenseRef-KDAB-KDStateMachineEditor
 
 #misc config files
-Files: .pre-commit-config.yaml .codespellrc .krazy .clang-tidy .gitignore appveyor.yml distro/* .clang-format .cmake-format.py .mdlrc .mdlrc.rb
+Files: .pre-commit-config.yaml .codespellrc .krazy .clang-tidy .gitignore .gitmodules appveyor.yml distro/* .clang-format .cmake-format.py .mdlrc .mdlrc.rb
 Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
 License: BSD-3-Clause
 

3rdparty/CMakeLists.txt

@@ -0,0 +1,42 @@
+#
+# This file is part of the KDAB State Machine Editor Library.
+#
+# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+# Author: Daniel Nicoletti <[email protected]>
+#
+# SPDX-License-Identifier: LGPL-2.1-only OR LicenseRef-KDAB-KDStateMachineEditor
+#
+# Licensees holding valid commercial KDAB State Machine Editor Library
+# licenses may use this file in accordance with the KDAB State Machine Editor
+# Library License Agreement provided with the Software.
+#
+# Contact [email protected] if any conditions of this licensing are not clear to you.
+#
+
+if(WITH_INTERNAL_GRAPHVIZ)
+    # Function creates extra scope to keep these variables local
+    function(add_graphviz_subdirectory)
+        #TODO check if there are unneeded features to disable
+
+        if(WITH_STATIC_GRAPHVIZ)
+            set(CMAKE_POSITION_INDEPENDENT_CODE ON
+            )#TODO remove after https://gitlab.com/graphviz/graphviz/-/merge_requests/3823 is merged
+            set(BUILD_SHARED_LIBS OFF)
+        endif()
+        if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/graphviz/CMakeLists.txt")
+            message(FATAL_ERROR "Please do git submodule update --init --recursive")
+        endif()
+
+        add_subdirectory(graphviz)
+
+        if(WIN32)
+            # On Windows we need some dependencies available for tests
+            file(GLOB GRAPHVIZ_DEPENDENCIES
+                 ${CMAKE_CURRENT_SOURCE_DIR}/graphviz/windows/dependencies/libraries/x64/bin/*
+            )
+            file(COPY ${GRAPHVIZ_DEPENDENCIES} DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
+        endif()
+    endfunction()
+
+    add_graphviz_subdirectory()
+endif()

3rdparty/graphviz

@@ -22,6 +22,11 @@
 #  In the case where a separate Graphviz installation is not practical or desired.
 #  Default=true if Graphviz is not located; false otherwise
 #
+# -WITH_STATIC_GRAPHVIZ=[true|false]
+#  Allow the internal Graphviz build to be statically.
+#  Currently shared graphviz builds on Windows have link issues.
+#  Default=true
+#
 # -DBUILD_QT6=[true|false]
 #  Build against Qt6 rather than Qt5
 #  Default=false (Qt5 will be used even if Qt6 is available)
@@ -50,16 +55,6 @@ project(
     VERSION 1.99.50
 )
 
-add_definitions(
-    -DQT_NO_CAST_TO_ASCII
-    -DQT_NO_CAST_FROM_ASCII
-    -DQT_STRICT_ITERATORS
-    -DQT_NO_URL_CAST_FROM_STRING
-    -DQT_NO_CAST_FROM_BYTEARRAY
-    -DQT_USE_QSTRINGBUILDER
-    -DQT_USE_FAST_OPERATOR_PLUS
-)
-
 set(KDSME_SOVERSION "2") #means the 2.x ABI is frozen. ABI changes will must go to version 3
 
 include(FeatureSummary)
@@ -217,7 +212,9 @@ set(INSTALL_TARGETS_DEFAULT_ARGS
 
 # search for Graphviz
 set(GRAPHVIZ_MIN_VERSION "2.30.1")
-find_package(Graphviz)
+if(NOT DEFINED WITH_INTERNAL_GRAPHVIZ)
+    find_package(Graphviz)
+endif()
 set_package_properties(
     Graphviz PROPERTIES
     TYPE RECOMMENDED
@@ -231,102 +228,28 @@ if(GRAPHVIZ_FOUND)
 elseif(NOT CMAKE_SYSTEM_NAME STREQUAL QNX)
     message(STATUS "Auto-enabling internal Graphviz build, since no installed version is available")
     set(WITH_INTERNAL_GRAPHVIZ_DEFAULT ON)
+    set(GRAPHVIZ_FOUND ON)
 endif()
 
 option(WITH_INTERNAL_GRAPHVIZ "Enable build of external project Graphviz" ${WITH_INTERNAL_GRAPHVIZ_DEFAULT})
 add_feature_info("Internal build of Graphviz" WITH_INTERNAL_GRAPHVIZ "enable with WITH_INTERNAL_GRAPHVIZ=ON")
 
-set(WITH_STATIC_GRAPHVIZ OFF) # Whether the Graphviz build we're using is static or not -- WIP
-
 if(WITH_INTERNAL_GRAPHVIZ)
-    # CMake is really awful here...
-    set(source_dir ${CMAKE_CURRENT_BINARY_DIR}/graphviz-src)
-    set(install_dir ${CMAKE_CURRENT_BINARY_DIR}/graphviz-install)
-
-    # work-around: https://cmake.org/Bug/view.php?id=15052
-    set(include_dir "${install_dir}/include")
-    file(MAKE_DIRECTORY ${include_dir})
-    set(GRAPHVIZ_INCLUDE_DIR ${include_dir})
-
-    if(UNIX OR WITH_STATIC_GRAPHVIZ)
-        set(libfolder "lib")
-    else()
-        set(libfolder "bin")
-    endif()
-
-    if(WITH_STATIC_GRAPHVIZ)
-        set(staticdotlayoutplugin_library
-            "${install_dir}/lib/${CMAKE_STATIC_LIBRARY_PREFIX}gvplugin_dot_layout${CMAKE_STATIC_LIBRARY_SUFFIX}"
-        )
-        set(link_libraries_absolute)
-        foreach(link_library "xdot;gvc;cgraph;pathplan")
-            list(APPEND link_libraries_absolute
-                 ${install_dir}/lib/${CMAKE_STATIC_LIBRARY_PREFIX}${link_library}${CMAKE_STATIC_LIBRARY_SUFFIX}
-            )
-        endforeach()
-    else()
-        set(GRAPHVIZ_CGRAPH_LIBRARY
-            "${install_dir}/${libfolder}/${CMAKE_SHARED_LIBRARY_PREFIX}cgraph${CMAKE_SHARED_LIBRARY_SUFFIX}"
-        )
-        set(GRAPHVIZ_GVC_LIBRARY
-            "${install_dir}/${libfolder}/${CMAKE_SHARED_LIBRARY_PREFIX}gvc${CMAKE_SHARED_LIBRARY_SUFFIX}"
-        )
-        set(link_libraries_absolute "${GRAPHVIZ_CGRAPH_LIBRARY};${GRAPHVIZ_GVC_LIBRARY}")
-    endif()
-
-    set(win_build_utilities ${source_dir}/windows/dependencies/graphviz-build-utilities)
-    string(TIMESTAMP graphvizDate)
-    set(GRAPHVIZ_MAJOR_VERSION 2)
-    set(GRAPHVIZ_MINOR_VERSION 48)
-    set(GRAPHVIZ_PATCH_VERSION 0)
-    set(graphvizVersion "${GRAPHVIZ_MAJOR_VERSION}.${GRAPHVIZ_MINOR_VERSION}.${GRAPHVIZ_PATCH_VERSION}")
-    # cmake-lint: disable=C0301
-    externalproject_add(
-        GraphvizExternalProject
-        GIT_REPOSITORY "https://gitlab.com/graphviz/graphviz.git"
-        GIT_TAG ${graphvizVersion}
-        GIT_PROGRESS 1
-        USES_TERMINAL_DOWNLOAD
-            TRUE # needed for Ninja so we can see the Git progress (cf. https://gitlab.kitware.com/cmake/cmake/-/issues/18238)
-        CMAKE_ARGS
-            -DVERSION=${graphvizVersion}
-            -DDATE=${graphvizDate}
-            -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-            -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-            -DCMAKE_C_COMPILER_AR=${CMAKE_C_COMPILER_AR}
-            -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-            -DCMAKE_CXX_COMPILER_AR=${CMAKE_CXX_COMPILER_AR}
-            -DCMAKE_INSTALL_PREFIX=${install_dir}
-            $<$<BOOL:${WIN32}>:-DCMAKE_IGNORE_PATH="C:/Strawberry/c/bin">
-            $<$<BOOL:${WIN32}>:-DCMAKE_SYSTEM_PREFIX_PATH=${win_build_utilities}$<SEMICOLON>${win_build_utilities}/winflexbison$<SEMICOLON>${win_build_utilities}/Perl64$<SEMICOLON>${win_build_utilities}/GnuWin/bin>
-        BUILD_COMMAND "" # skip, make install is enough
-        SOURCE_DIR ${source_dir}
-        INSTALL_DIR ${install_dir}
-        INSTALL_COMMAND ${CMAKE_COMMAND} --build . --target install
-        # Note: BUILD_BYPRODUCTS only available since CMake 3.2
-        # Needed to make ExternalProject_Add in combination with the Ninja generator work
-        # Also see: https://cmake.org/pipermail/cmake/2015-April/060234.html
-        BUILD_BYPRODUCTS ${staticdotlayoutplugin_library} ${link_libraries_absolute}
+    option(WITH_STATIC_GRAPHVIZ "Enable static build of Graphviz when internally building" ON)
+    add_feature_info(
+        "Statically build Graphviz for internal builds" WITH_INTERNAL_GRAPHVIZ "disable with WITH_STATIC_GRAPHVIZ=OFF"
     )
 
-    if(WITH_STATIC_GRAPHVIZ)
-        add_library(GraphvizStaticDotLayoutPlugin IMPORTED STATIC)
-        set_target_properties(
-            GraphvizStaticDotLayoutPlugin
-            PROPERTIES IMPORTED_LOCATION "${staticdotlayoutplugin_library}"
-                       INTERFACE_COMPILE_DEFINITIONS
-                       "CGRAPH_EXPORTS;GVC_EXPORTS;WITH_CGRAPH" # Fix export macro madness in Graphviz
-                       INTERFACE_INCLUDE_DIRECTORIES ${include_dir}
-                       INTERFACE_LINK_LIBRARIES "${link_libraries_absolute}"
-        )
-    else()
-        # in case of a Graphviz dynamic library build, we need to install
-        install(DIRECTORY ${install_dir}/ DESTINATION ".")
-    endif()
-
-    set(GRAPHVIZ_FOUND TRUE)
+    include_directories(${PROJECT_SOURCE_DIR}/src/fwd_headers)
+    include_directories(${PROJECT_SOURCE_DIR}/3rdparty/graphviz/lib/common)
+    include_directories(${PROJECT_SOURCE_DIR}/3rdparty/graphviz/lib/gvc)
+    include_directories(${PROJECT_SOURCE_DIR}/3rdparty/graphviz/lib/pathplan)
+    include_directories(${PROJECT_SOURCE_DIR}/3rdparty/graphviz/lib/cgraph)
+    include_directories(${PROJECT_SOURCE_DIR}/3rdparty/graphviz/lib/cdt)
 endif()
 
+add_subdirectory(3rdparty)
+
 #
 # Compiler & linker settings
 #

CMakeLists.txt

@@ -12,6 +12,16 @@
 # Contact [email protected] if any conditions of this licensing are not clear to you.
 #
 
+add_definitions(
+    -DQT_NO_CAST_TO_ASCII
+    -DQT_NO_CAST_FROM_ASCII
+    -DQT_STRICT_ITERATORS
+    -DQT_NO_URL_CAST_FROM_STRING
+    -DQT_NO_CAST_FROM_BYTEARRAY
+    -DQT_USE_QSTRINGBUILDER
+    -DQT_USE_FAST_OPERATOR_PLUS
+)
+
 include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config-examples.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-examples.h)

examples/CMakeLists.txt

@@ -12,6 +12,16 @@
 # Contact [email protected] if any conditions of this licensing are not clear to you.
 #
 
+add_definitions(
+    -DQT_NO_CAST_TO_ASCII
+    -DQT_NO_CAST_FROM_ASCII
+    -DQT_STRICT_ITERATORS
+    -DQT_NO_URL_CAST_FROM_STRING
+    -DQT_NO_CAST_FROM_BYTEARRAY
+    -DQT_USE_QSTRINGBUILDER
+    -DQT_USE_FAST_OPERATOR_PLUS
+)
+
 set(HAVE_GRAPHVIZ ${GRAPHVIZ_FOUND})
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config-kdsme.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-kdsme.h)
 

src/CMakeLists.txt

@@ -112,14 +112,7 @@ endif()
 generate_export_header(kdstatemachineeditor_core EXPORT_FILE_NAME kdsme_core_export.h BASE_NAME KDSME_CORE)
 
 if(GRAPHVIZ_FOUND)
-    if(WITH_STATIC_GRAPHVIZ)
-        target_link_libraries(kdstatemachineeditor_core PRIVATE GraphvizStaticDotLayoutPlugin)
-    endif()
-    target_link_libraries(kdstatemachineeditor_core PRIVATE ${GRAPHVIZ_GVC_LIBRARY} ${GRAPHVIZ_CGRAPH_LIBRARY})
-    if(WITH_INTERNAL_GRAPHVIZ)
-        add_dependencies(kdstatemachineeditor_core GraphvizExternalProject)
-    endif()
-    target_include_directories(kdstatemachineeditor_core PRIVATE ${GRAPHVIZ_INCLUDE_DIR})
+    target_link_libraries(kdstatemachineeditor_core PRIVATE cgraph gvc gvplugin_dot_layout)
 endif()
 
 set(build_iface_dirs
@@ -133,6 +126,20 @@ target_include_directories(
 
 set_target_properties(kdstatemachineeditor_core PROPERTIES OUTPUT_NAME "kdstatemachineeditor_core${KDSME_LIBRARY_QTID}")
 
+if(WITH_INTERNAL_GRAPHVIZ)
+    install(
+        TARGETS gvc cgraph cdt gvplugin_dot_layout dotgen
+        EXPORT KDSME_TARGETS
+        ${INSTALL_TARGETS_DEFAULT_ARGS}
+    )
+    if(WITH_STATIC_GRAPHVIZ)
+        install(
+            TARGETS common pack ortho pathplan label xdot
+            EXPORT KDSME_TARGETS
+            ${INSTALL_TARGETS_DEFAULT_ARGS}
+        )
+    endif()
+endif()
 install(
     TARGETS kdstatemachineeditor_core
     EXPORT KDSME_TARGETS