Update to Qt6

- New baseline minimum platform is Ubuntu 22.04
    - Qt6 requires at least 6.2
        - some deprecations may be flagged on later versions (e.g. 6.8)
    - CMake requires at least 3.22
- Include build-tests.yml github action to validate builds on mulitple platforms
- QtTest is no longer optional since it easily comes along for the ride with Qt
- Replaced QStringRef in model::SubstitutionField with simple ParserState class
- Removed deprecations up to Qt 6.2

Author: j-evins

.github/workflows/build-tests.yml

@@ -0,0 +1,110 @@
+# This workflow performs test builds across a diversity of supported platforms
+#
+#     - ubuntu-latest  - gcc
+#     - ubuntu-latest  - clang
+#     - ubuntu-24.04   - gcc   (For backwards compatablity)
+#     - windows-latest - cl
+#
+# TODO:
+#     - macos
+#     - install optional dependencies for windows-latest test build
+      
+
+name: Multi-Platform Build Tests
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        os: [ubuntu-latest, ubuntu-22.04, windows-latest]
+        build_type: [Release]
+        c_compiler: [gcc, clang, cl]
+        include:
+          - os: ubuntu-latest
+            c_compiler: gcc
+            cpp_compiler: g++
+          - os: ubuntu-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+          - os: ubuntu-22.04
+            c_compiler: gcc
+            cpp_compiler: g++
+          - os: windows-latest
+            c_compiler: cl
+            cpp_compiler: cl
+        exclude:
+          - os: ubuntu-latest
+            c_compiler: cl
+          - os: ubuntu-22.04
+            c_compiler: clang
+          - os: ubuntu-22.04
+            c_compiler: cl
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        # Checkout full-depth to facilitate auto versioning
+        fetch-depth: 0
+
+    - name: Install optional dependencies (Ubuntu)
+      shell: bash
+      if: startsWith( matrix.os, 'ubuntu-' )
+      run: |
+        # install packages
+        sudo apt-get update
+        sudo apt-get -y install xvfb
+        sudo apt-get -y install pkgconf libqrencode-dev
+        sudo apt-get -y install barcode
+        # install zint-2.6.5 from source
+        #  - 2.6.5 is last version that works with glabels-qt
+        #  - currently must be done before qt installed, because of errors
+        #    trying to build qzint
+        wget https://downloads.sourceforge.net/project/zint/zint/2.6.5/zint-2.6.5.tar.gz && tar xzf zint-2.6.5.tar.gz && ( cd zint-2.6.5 && mkdir build && cd build && cmake .. && make && sudo make install )
+
+    - name: Install Qt
+      uses: jurplel/install-qt-action@v4
+      with:
+        version: '6.2.*'
+        install-deps: 'true'
+        archives: 'qtbase qtsvg qttools icu'
+
+    - name: Set reusable strings
+      id: strings
+      shell: bash
+      run: |
+        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
+
+    - name: Configure CMake
+      run: >
+        cmake -B ${{ steps.strings.outputs.build-output-dir }}
+        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+        -S ${{ github.workspace }}
+
+    - name: Build
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
+
+    - name: Test (Ubuntu)
+      if: startsWith( matrix.os, 'ubuntu-' )
+      working-directory: ${{ steps.strings.outputs.build-output-dir }}
+      run: xvfb-run ctest --build-config ${{ matrix.build_type }}
+
+    - name: Test (Windows)
+      if: startsWith( matrix.os, 'windows-' )
+      working-directory: ${{ steps.strings.outputs.build-output-dir }}
+      run: ctest --build-config ${{ matrix.build_type }}

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.22)
 
 ###############################################################################
 # gLabels Label Designer Project
@@ -111,12 +111,7 @@ if (MINGW)
    set (CMAKE_PREFIX_PATH ${MINGW_BASE_DIR} )
 endif ()
 
-find_package (Qt5Core 5.15 REQUIRED)
-find_package (Qt5Widgets 5.15 REQUIRED)
-find_package (Qt5PrintSupport 5.15 REQUIRED)
-find_package (Qt5Xml 5.15 REQUIRED)
-find_package (Qt5Svg 5.15 REQUIRED)
-find_package (Qt5LinguistTools)
+find_package (Qt6 6.2 REQUIRED COMPONENTS Core Gui Widgets PrintSupport Xml Svg LinguistTools Test)
 
 if (WIN32)
    # Locate Qt directories
@@ -131,8 +126,6 @@ find_package (ZLIB 1.2 QUIET)
 find_package (GnuBarcode 0.98 QUIET)
 find_package (LibQrencode 3.4 QUIET)
 find_package (LibZint 2.6 EXACT QUIET)
-# Unit testing support
-find_package (Qt5Test 5.6 QUIET)
 
 
 #=======================================
@@ -143,7 +136,7 @@ if (${CMAKE_CXX_COMPILER_ID} STREQUAL "GNU")
    # Uncomment to compile everything with aggressively pedantic options
    # (not recommended -- only for testing -- also not portable)
    #
-   #add_compile_options("-Wall" "-Werror" "-Wpedantic")
+   #add_compile_options("-Wall" "-Wextra" "-Wpedantic" "-Wno-unused-parameter" "-Werror")
 
    # Uncomment to always compile with debug symbols
    add_compile_options("-g")
@@ -153,7 +146,7 @@ endif ()
 #=======================================
 # Unit Testing
 #=======================================
-if (Qt5Test_FOUND)
+if (Qt6Test_FOUND)
   enable_testing ()
 endif ()
 
@@ -177,11 +170,13 @@ add_subdirectory (data)
 message (STATUS "")
 message (STATUS "Project name ............ " ${CMAKE_PROJECT_NAME})
 message (STATUS "Project version ......... " ${LONG_VERSION_STRING})
+message (STATUS "Host system ............. " ${CMAKE_HOST_SYSTEM} " " ${CMAKE_HOST_SYSTEM_PROCESSOR})
+message (STATUS "Target system ........... " ${CMAKE_SYSTEM} " " ${CMAKE_SYSTEM_PROCESSOR})
 message (STATUS "Installation prefix ..... " ${CMAKE_INSTALL_PREFIX})
 message (STATUS "Source code location .... " ${glabels_SOURCE_DIR})
 message (STATUS "CMake version ........... " ${CMAKE_VERSION})
 message (STATUS "C++ Compiler ............ " ${CMAKE_CXX_COMPILER_ID} " " ${CMAKE_CXX_COMPILER} " " ${CMAKE_CXX_COMPILER_VERSION})
-message (STATUS "Qt version .............. " ${Qt5Core_VERSION})
+message (STATUS "Qt version .............. " ${Qt6Core_VERSION})
 
 if (ZLIB_FOUND)
   message (STATUS "zlib (optional).......... " ${ZLIB_VERSION_STRING})
@@ -207,12 +202,6 @@ else (LIBZINT_FOUND)
   message (STATUS "libzint (optional)....... No.")
 endif (LIBZINT_FOUND)
 
-if (Qt5Test_FOUND)
-  message (STATUS "QtTest (optional)........ " ${Qt5Test_VERSION})
-else (Qt5Test_FOUND)
-  message (STATUS "QtTest (optional)........ No.")
-endif (Qt5Test_FOUND)
-
 if (MSVC)
    message (STATUS "MSVC Qt location ........ " ${QT_BASE_DIR})
 endif (MSVC)

README.md

@@ -2,8 +2,7 @@
 
 ![Cover Image](docs/images/cover-image.png)
 
-[![Travis Build Status](https://travis-ci.org/j-evins/glabels-qt.svg?branch=master)](https://travis-ci.org/j-evins/glabels-qt)
-[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/j-evins/glabels-qt?branch=master&svg=true)](https://ci.appveyor.com/project/j-evins/glabels-qt)
+[![Multi-Platform Build Tests](https://github.com/j-evins/glabels-qt/actions/workflows/build-tests.yml/badge.svg?branch=master&event=push)](https://github.com/j-evins/glabels-qt/actions/workflows/build-tests.yml)
 
 *******************************************************************************
 
@@ -89,3 +88,4 @@ restrictive licensing:
    label database.  No copyright is claimed on the facts contained within
    the database and can be used for any purpose.  The files themselves are
    licensed using the MIT/X license.  See [templates/LICENSE](templates/LICENSE).
+

backends/barcode/CMakeLists.txt

@@ -39,7 +39,7 @@ set (barcode_qobject_headers
   Backends.h
 )
 
-qt5_wrap_cpp (barcode_moc_sources ${barcode_qobject_headers})
+qt6_wrap_cpp (barcode_moc_sources ${barcode_qobject_headers})
 
 #=====================================
 # Target
@@ -60,7 +60,7 @@ target_include_directories (Barcode
 
 target_link_libraries (Barcode
   glbarcode
-  Qt5::Core
+  Qt6::Core
   ${OPTIONAL_GNUBARCODE}
   ${OPTIONAL_ZINT}
   ${OPTIONAL_QRENCODE}

backends/merge/CMakeLists.txt

@@ -23,7 +23,7 @@ set (merge_qobject_headers
   Merge.h
 )
 
-qt5_wrap_cpp (merge_moc_sources ${merge_qobject_headers})
+qt6_wrap_cpp (merge_moc_sources ${merge_qobject_headers})
 
 #=====================================
 # Target
@@ -43,5 +43,5 @@ target_include_directories (Merge
 )
 
 target_link_libraries (Merge
-  Qt5::Core
+  Qt6::Core
 )

cmake/Modules/FindGnuBarcode.cmake

@@ -36,6 +36,9 @@ endif ()
 if (GNUBARCODE_INCLUDE_DIR AND EXISTS "${GNUBARCODE_INCLUDE_DIR}/barcode.h")
   file (STRINGS "${GNUBARCODE_INCLUDE_DIR}/barcode.h" BARCODE_H REGEX "^#define BARCODE_VERSION *\"[^\"]*\"")
   string (REGEX REPLACE "^.*VERSION *\"([^\"]*)\"" "\\1" GNUBARCODE_VERSION_STRING "${BARCODE_H}")
+  if (NOT "${BARCODE_H}")
+    set(GNUBARCODE_VERSION_STRING "0.99")  # ubuntu v0.99 may have barcode.h, but no version string
+  endif()
 endif()
 
 # handle the QUIETLY and REQUIRED arguments and set GNUBARCODE_FOUND to TRUE if

docs/BUILD-INSTRUCTIONS-LINUX.md

@@ -5,8 +5,8 @@ gLabels Linux Build Instructions
 ### Prerequisites
 
 - g++
-- CMake 2.8.12+
-- Qt5 5.15+ Development Packages ( Qt5Core, Qt5Widgets, Qt5PrintSupport, Qt5Xml, Qt5Svg )
+- CMake 3.22+
+- Qt6 6.2+ Development Packages ( Qt6Core, Qt6Widgets, Qt6PrintSupport, Qt6Xml, Qt6Svg, Qt6Test )
 - zlib 1.2+ Development Package
 
 > Even if the above library packages are installed, their corresponding development packages
@@ -26,36 +26,32 @@ $ make
 $ sudo make install
 </pre>
 
-## Example: Ubuntu 19.04
+
+## Example: Ubuntu 24.04
 
 ### Installing Prerequisites
 ```
-sudo apt install cmake
-sudo apt install qtbase5-dev libqt5svg5-dev qttools5-dev zlib1g-dev
+$ sudo apt install cmake
+$ sudo apt install qt6-base-dev qt6-svg-dev qt6-tools-dev zlib1g-dev
 ```
 _QREncode (Optional)_
 ```
-sudo apt install pkgconf libqrencode-dev
+$ sudo apt install pkgconf libqrencode-dev
 ```
 _Zint (Optional)_
 
 Install zint from source:
 ```
-wget https://downloads.sourceforge.net/project/zint/zint/2.6.3/zint-2.6.3_final.tar.gz
-tar xzf zint-2.6.3_final.tar.gz
-cd zint-2.6.3.src/
-mkdir build && cd build && cmake .. && make
-sudo make install
+$ wget https://downloads.sourceforge.net/project/zint/zint/2.6.3/zint-2.6.3_final.tar.gz
+$ tar xzf zint-2.6.3_final.tar.gz
+$ cd zint-2.6.3.src/
+$ mkdir build && cd build && cmake .. && make
+$ sudo make install
 ```
 _GNU Barcode (Optional)_
 
-As of version 0.99, GNU Barcode no longer installs its library.  So install 0.98 from source:
 ```
-wget https://ftp.gnu.org/gnu/barcode/barcode-0.98.tar.gz
-tar xzf barcode-0.98.tar.gz
-cd barcode-0.98/
-./configure && make
-sudo make install
+$ sudo apt install barcode
 ```
 ### Compile and Install gLabels
 
@@ -67,6 +63,8 @@ $ cmake ..
 $ make
 $ sudo make install
 ```
+
+
 ## Example: Fedora 35
 
 ### Installing Prerequisites
@@ -76,12 +74,12 @@ We assume the build system already has things like cmake and the GNU C++ suite i
 $ sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel qt5-linguist qt5-qttools
 ```
 These installs will pull in additional packages to fill out their prerequisites.
-Fedora has a different package naming scheme that Ubuntu. This is to distinguish the QT5
+Fedora has a different package naming scheme that Ubuntu. This is to distinguish the QT6
 packages from the QT3 and QT4 packages that they still support for compatibility.
 If the Cmake pass or build has missing package errors or warnings, you can search for the needed
 package with:
 ```
-$ sudo dnf search qt5 |grep <package name substring>
+$ sudo dnf search qt6 |grep <package name substring>
 ```
 
 ### Compile and Install gLabels into /usr/local

docs/BUILD-INSTRUCTIONS-WINDOWS.md

@@ -13,8 +13,8 @@ Visual Studio
 ### Prerequisites
 
 - Visual Studio (these instructions are for _Visual Studio 15 2017 Win64_)
-- CMake 3.2+
-- Qt5 5.9+ for your version of Visual Studio
+- CMake 3.22+
+- Qt6 6.2+ for your version of Visual Studio
 - NSIS 3.03+ (optional -- for creating an installer)
 
 Make sure that CMake and the Qt tools are in your executable search path.  For example, you may need to add something like the following to your PATH environment variable:
@@ -67,8 +67,8 @@ MSYS/MINGW
 - MSYS/MINGW, including the following packages
   + mingw32-gcc-g++
   + mingw32-libz
-- CMake 3.2+
-- Qt5 5.9+ for MINGW
+- CMake 3.22+
+- Qt6 6.2+ for MINGW
 
 Make sure that Qt tools and CMake are in your executable search path.  For example, add something like this to your .profile file:
 

glabels-batch/main.cpp

@@ -69,7 +69,7 @@ int main( int argc, char **argv )
 	// Setup translators
 	//
 	QLocale locale = QLocale::system();
-	QString qtTranslationsDir = QLibraryInfo::location( QLibraryInfo::TranslationsPath );
+	QString qtTranslationsDir = QLibraryInfo::path( QLibraryInfo::TranslationsPath );
 	QString myTranslationsDir = glabels::model::FileUtil::translationsDir().canonicalPath();
 
 	QTranslator qtTranslator;

glabels/CMakeLists.txt

@@ -107,9 +107,9 @@ set (glabels_resource_files
   images.qrc
 )
 
-qt5_wrap_cpp (glabels_moc_sources ${glabels_qobject_headers})
-qt5_wrap_ui (glabels_forms_headers ${glabels_forms})
-qt5_add_resources (glabels_qrc_sources ${glabels_resource_files})
+qt6_wrap_cpp (glabels_moc_sources ${glabels_qobject_headers})
+qt6_wrap_ui (glabels_forms_headers ${glabels_forms})
+qt6_add_resources (glabels_qrc_sources ${glabels_resource_files})
 
 if (WIN32)
   # Windows resource file
@@ -137,7 +137,7 @@ target_include_directories (glabels-qt
 
 target_link_libraries (glabels-qt
   Model
-  Qt5::Widgets
+  Qt6::Widgets
 )
 
 #=======================================
@@ -173,7 +173,6 @@ if (WIN32)
                 env PATH="${QT_BIN_DIR}" "${WINDEPLOYQT_EXECUTABLE}"
                     --verbose 0
                     --no-compiler-runtime
-                    --no-angle
                     --no-opengl-sw
                     \"$<TARGET_FILE:glabels-qt>\"
         )
@@ -198,7 +197,6 @@ if (WIN32)
                     --verbose 0
                     --release
                     --no-compiler-runtime
-                    --no-angle
                     --no-opengl-sw
                     \"$<TARGET_FILE:glabels-qt>\"
         )