Add option to disable QTextCodec (#235)

* Remove dependency on QTextCodec for qt6
* Add CI for qt6 with qt5compat and no QTextCodec
* Rework the patch with a typedef, fix russian tests
* Documentation

---------

Co-authored-by: geustache <[email protected]>

Author: cen1

.clang-tidy

@@ -0,0 +1,23 @@
+Checks: >
+  # Enable core static analysis checks
+  clang-analyzer-*,
+
+  # Best practices and maintainability
+  cppcoreguidelines-*,
+  modernize-*,
+  performance-*,
+  readability-*,
+
+  # Catch potential bugs
+  bugprone-*,
+  misc-*,
+
+  # Ensure safer memory management
+  cert-*,
+
+  # Security checks
+  security-*,
+
+  # Avoid shadowing issues
+  clang-analyzer-core.Shadowing,
+  cppcoreguidelines-avoid-variable-shadowing

.github/workflows/ci.yml

@@ -41,6 +41,23 @@ jobs:
       shared: "ON"
       zlib_const: "ON"
 
+  # Qt6 with Qt5Compat but explicitly disabled QTextCodec support
+  ubuntu-no-qtextcodec:
+    if: true
+    name: Ubuntu-${{ matrix.os_version }}-Qt-${{ matrix.qt_version }}-shared-no-qtextcodec
+    strategy:
+      fail-fast: true
+      matrix:
+        os_version: [ 24.04 ]
+        qt_version: [ 6.8.2 ]
+    uses: ./.github/workflows/reusable.yml
+    with:
+      runs_on: ubuntu-${{ matrix.os_version }}
+      os_version: ${{ matrix.os_version }}
+      qt_version: ${{ matrix.qt_version }}
+      shared: "ON"
+      qtextcodec: 'OFF'
+
   macos:
     if: true
     name: macos-${{ matrix.os_version }}-Qt-${{ matrix.qt_version }}-shared-${{ matrix.shared }}

.github/workflows/reusable.yml

@@ -19,6 +19,10 @@ on:
         required: false
         default: "OFF"
         type: string
+      qtextcodec:
+        required: false
+        default: "ON"
+        type: string
       runs_on:
         required: true
         type: string
@@ -74,7 +78,7 @@ jobs:
           zlib1g-dev libbz2-dev
 
       - name: Configure CMake
-        run: cmake -DCMAKE_BUILD_TYPE="${{env.BUILD_TYPE}}" -DBUILD_SHARED_LIBS=${{ inputs.shared }} -DQUAZIP_ENABLE_TESTS=ON -DZLIB_CONST=${{ inputs.zlib_const }} -B "${{github.workspace}}/build"
+        run: cmake -DCMAKE_BUILD_TYPE="${{env.BUILD_TYPE}}" -DBUILD_SHARED_LIBS=${{ inputs.shared }} -DQUAZIP_ENABLE_TESTS=ON -DZLIB_CONST=${{ inputs.zlib_const }} -DQUAZIP_ENABLE_QTEXTCODEC=${{ inputs.qtextcodec }} -B "${{github.workspace}}/build"
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}

.gitignore

@@ -12,3 +12,5 @@ CMakeUserPresets.json
 vcpkg_installed/
 Testing/
 minizip/
+CMakeFiles/
+CMakeCache.txt

CMakeLists.txt

@@ -23,6 +23,7 @@ else()
 endif()
 
 OPTION(ZLIB_CONST "Sets ZLIB_CONST preprocessor definition" OFF)
+option(QUAZIP_ENABLE_QTEXTCODEC "Enable use of QTextCodec (requires Qt5 or Qt6 Core5Compat)" ON)
 
 # Make BZIP2 optional
 option(QUAZIP_BZIP2 "Enables BZIP2 compression" ON)
@@ -74,13 +75,13 @@ message(STATUS "QUAZIP_QT_MAJOR_VERSION set to ${QUAZIP_QT_MAJOR_VERSION}")
 message(STATUS "CMAKE_CXX_STANDARD set to ${CMAKE_CXX_STANDARD}")
 
 if(QUAZIP_QT_MAJOR_VERSION EQUAL 6)
-    find_package(Qt6 REQUIRED COMPONENTS Core Core5Compat
+    find_package(Qt6 REQUIRED COMPONENTS Core 
             OPTIONAL_COMPONENTS Network Test)
     message(STATUS "Found Qt version ${Qt6_VERSION} at ${Qt6_DIR}")
     set(QUAZIP_QT_ZLIB_COMPONENT BundledZLIB)
     set(QUAZIP_QT_ZLIB_HEADER_COMPONENT ZlibPrivate)
-    set(QUAZIP_LIB_LIBRARIES Qt6::Core Qt6::Core5Compat)
-    set(QUAZIP_TEST_QT_LIBRARIES Qt6::Core Qt6::Core5Compat Qt6::Network Qt6::Test)
+    set(QUAZIP_LIB_LIBRARIES Qt6::Core )
+    set(QUAZIP_TEST_QT_LIBRARIES Qt6::Core Qt6::Network Qt6::Test)
     set(QUAZIP_PKGCONFIG_REQUIRES "zlib, Qt6Core")
 elseif(QUAZIP_QT_MAJOR_VERSION EQUAL 5)
     find_package(Qt5 REQUIRED COMPONENTS Core
@@ -214,6 +215,26 @@ if(QUAZIP_BZIP2)
     endif()
 endif()
 
+if(QUAZIP_ENABLE_QTEXTCODEC)
+    if(${QT_VERSION} VERSION_GREATER_EQUAL 6.0.0)
+        find_package(Qt6 OPTIONAL_COMPONENTS Core5Compat)
+        if(Qt6Core5Compat_FOUND)
+            set(QUAZIP_LIB_LIBRARIES ${QUAZIP_LIB_LIBRARIES} Qt6::Core5Compat)
+            set(QUAZIP_TEST_QT_LIBRARIES ${QUAZIP_TEST_QT_LIBRARIES} Qt6::Core5Compat)
+
+            add_compile_definitions(QUAZIP_CAN_USE_QTEXTCODEC)
+            message("-- Quazip can use QTextCodec")
+        else()
+            message("-- Core5Compat not found, QTextCodec support disabled")
+        endif()
+    else()
+        add_compile_definitions(QUAZIP_CAN_USE_QTEXTCODEC)
+        message("-- Quazip can use QTextCodec")
+    endif()
+else()
+    message("-- QTextCodec explicitly disabled by QUAZIP_ENABLE_QTEXTCODEC=OFF")
+endif()
+
 add_subdirectory(quazip)
 
 if(QUAZIP_ENABLE_TESTS)

README.md

@@ -103,14 +103,15 @@ cmake --build . --target clean
 
 CMake options
 
-| Option                   | Description                                                                                                                                                   | Default                                    |
-|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
-| `QUAZIP_QT_MAJOR_VERSION`| Specifies which major Qt version should be searched for (6 or 5). By default it tries to find the most recent.                                                |                                            |
-| `BUILD_SHARED_LIBS`      | Build QuaZip as a shared library                                                                                                                              | `ON`                                       |
-| `QUAZIP_LIB_FILE_NAME`   | Specifies output libname.                                                                                                                                     | `quazip<quazip-version>-qt<qt-version>`    |
-| `QUAZIP_INSTALL`         | Enable installation                                                                                                                                           | `ON`                                       |
-| `QUAZIP_ENABLE_TESTS`    | Build QuaZip tests                                                                                                                                            | `OFF`                                      |
-| `QUAZIP_USE_QT_ZLIB`     | Use Qt's bundled zlib instead of system zlib (**not recommended**). Qt must be built with `-qt-zlib` and `-static`. Incompatible with `BUILD_SHARED_LIBS=ON`. | `OFF`                                      |
-| `QUAZIP_BZIP2`           | Enable BZIP2 compression                                                                                                                                      | `ON`                                       |
-| `QUAZIP_BZIP2_STDIO`     | Output BZIP2 errors to stdio when BZIP2 compression is enabled                                                                                                | `ON`                                       |
+| Option                      | Description                                                                                                                                                   | Default |
+|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| `QUAZIP_QT_MAJOR_VERSION`   | Specifies which major Qt version should be searched for (6 or 5). By default it tries to find the most recent.                                                |         |
+| `BUILD_SHARED_LIBS`         | Build QuaZip as a shared library                                                                                                                              | `ON`    |
+| `QUAZIP_LIB_FILE_NAME`      | Specifies output libname.                                                                                                                                     | `quazip<quazip-version>-qt<qt-version>` |
+| `QUAZIP_INSTALL`            | Enable installation                                                                                                                                           | `ON`    |
+| `QUAZIP_USE_QT_ZLIB`        | Use Qt's bundled zlib instead of system zlib (**not recommended**). Qt must be built with `-qt-zlib` and `-static`. Incompatible with `BUILD_SHARED_LIBS=ON`. | `OFF`   |
+| `QUAZIP_ENABLE_TESTS`       | Build QuaZip tests                                                                                                                                            | `OFF`   |
+| `QUAZIP_BZIP2`              | Enable BZIP2 compression                                                                                                                                      | `ON`    |
+| `QUAZIP_BZIP2_STDIO`        | Output BZIP2 errors to stdio when BZIP2 compression is enabled                                                                                                | `ON`    |
+| `QUAZIP_ENABLE_QTEXTCODEC`  | Set to OFF to explicitely disable the use of QTextCodec on Qt6 even if Core5Compat is available. This uses [QStringConverter](https://doc.qt.io/qt-6/qstringconverter.html) in the background with less supported encodings. | `ON`    |
 

quazip/CMakeLists.txt

@@ -16,6 +16,7 @@ set(QUAZIP_HEADERS
         quazip.h
         quazip_global.h
         quazip_qt_compat.h
+        quazip_textcodec.h
         quazipdir.h
         quazipfile.h
         quazipfileinfo.h
@@ -36,6 +37,7 @@ set(QUAZIP_SOURCES
         quagzipfile.cpp
         quaziodevice.cpp
         quazip.cpp
+        quazip_textcodec.cpp
         quazipdir.cpp
         quazipfile.cpp
         quazipfileinfo.cpp

quazip/JlCompress.cpp

@@ -384,7 +384,7 @@ QStringList JlCompress::extractFiles(QuaZip &zip, const QStringList &files, cons
     return extracted;
 }
 
-QStringList JlCompress::extractDir(QString fileCompressed, QTextCodec* fileNameCodec, QString dir) {
+QStringList JlCompress::extractDir(QString fileCompressed, QuazipTextCodec* fileNameCodec, QString dir) {
     // Open zip
     QuaZip zip(fileCompressed);
     if (fileNameCodec)
@@ -468,7 +468,7 @@ QStringList JlCompress::getFileList(QuaZip *zip)
     return lst;
 }
 
-QStringList JlCompress::extractDir(QIODevice* ioDevice, QTextCodec* fileNameCodec, QString dir)
+QStringList JlCompress::extractDir(QIODevice* ioDevice, QuazipTextCodec* fileNameCodec, QString dir)
 {
     QuaZip zip(ioDevice);
     if (fileNameCodec)

quazip/JlCompress.h

@@ -291,7 +291,7 @@ class QUAZIP_EXPORT JlCompress {
       left empty.
       \return The list of the full paths of the files extracted, empty on failure.
       */
-    static QStringList extractDir(QString fileCompressed, QTextCodec* fileNameCodec, QString dir = QString());
+    static QStringList extractDir(QString fileCompressed, QuazipTextCodec* fileNameCodec, QString dir = QString());
     /// Get the file list.
     /**
       \return The list of the files in the archive, or, more precisely, the
@@ -333,7 +333,7 @@ class QUAZIP_EXPORT JlCompress {
       left empty.
       \return The list of the full paths of the files extracted, empty on failure.
       */
-    static QStringList extractDir(QIODevice* ioDevice, QTextCodec* fileNameCodec, QString dir = QString());
+    static QStringList extractDir(QIODevice* ioDevice, QuazipTextCodec* fileNameCodec, QString dir = QString());
     /// Get the file list.
     /**
       \return The list of the files in the archive, or, more precisely, the

quazip/quazip.cpp

@@ -45,9 +45,9 @@ class QuaZipPrivate {
     /// The pointer to the corresponding QuaZip instance.
     QuaZip *q;
     /// The codec for file names (used when UTF-8 is not enabled).
-    QTextCodec *fileNameCodec;
+    QuazipTextCodec *fileNameCodec;
     /// The codec for comments (used when UTF-8 is not enabled).
-    QTextCodec *commentCodec;
+    QuazipTextCodec *commentCodec;
     /// The archive file name.
     QString zipName;
     /// The device to access the archive.
@@ -76,18 +76,18 @@ class QuaZipPrivate {
     bool utf8;
     /// The OS code.
     uint osCode;
-    inline QTextCodec *getDefaultFileNameCodec()
+    inline QuazipTextCodec *getDefaultFileNameCodec()
     {
         if (defaultFileNameCodec == nullptr) {
-          return QTextCodec::codecForLocale();
+          return QuazipTextCodec::codecForLocale();
         }
         return defaultFileNameCodec;
     }
     /// The constructor for the corresponding QuaZip constructor.
     inline QuaZipPrivate(QuaZip *_q):
       q(_q),
       fileNameCodec(getDefaultFileNameCodec()),
-      commentCodec(QTextCodec::codecForLocale()),
+      commentCodec(QuazipTextCodec::codecForLocale()),
       ioDevice(nullptr),
       mode(QuaZip::mdNotOpen),
       hasCurrentFile_f(false),
@@ -107,7 +107,7 @@ class QuaZipPrivate {
     inline QuaZipPrivate(QuaZip *_q, const QString &_zipName):
       q(_q),
       fileNameCodec(getDefaultFileNameCodec()),
-      commentCodec(QTextCodec::codecForLocale()),
+      commentCodec(QuazipTextCodec::codecForLocale()),
       zipName(_zipName),
       ioDevice(nullptr),
       mode(QuaZip::mdNotOpen),
@@ -128,7 +128,7 @@ class QuaZipPrivate {
     inline QuaZipPrivate(QuaZip *_q, QIODevice *_ioDevice):
       q(_q),
       fileNameCodec(getDefaultFileNameCodec()),
-      commentCodec(QTextCodec::codecForLocale()),
+      commentCodec(QuazipTextCodec::codecForLocale()),
       ioDevice(_ioDevice),
       mode(QuaZip::mdNotOpen),
       hasCurrentFile_f(false),
@@ -155,11 +155,11 @@ class QuaZipPrivate {
       QHash<QString, unz64_file_pos> directoryCaseSensitive;
       QHash<QString, unz64_file_pos> directoryCaseInsensitive;
       unz64_file_pos lastMappedDirectoryEntry;
-      static QTextCodec *defaultFileNameCodec;
+      static QuazipTextCodec *defaultFileNameCodec;
       static uint defaultOsCode;
 };
 
-QTextCodec *QuaZipPrivate::defaultFileNameCodec = nullptr;
+QuazipTextCodec *QuaZipPrivate::defaultFileNameCodec = nullptr;
 uint QuaZipPrivate::defaultOsCode = QUAZIP_OS_UNIX;
 
 void QuaZipPrivate::clearDirectoryMap()
@@ -588,14 +588,14 @@ QString QuaZip::getCurrentFileName()const
   return result;
 }
 
-void QuaZip::setFileNameCodec(QTextCodec *fileNameCodec)
+void QuaZip::setFileNameCodec(QuazipTextCodec *fileNameCodec)
 {
   p->fileNameCodec=fileNameCodec;
 }
 
 void QuaZip::setFileNameCodec(const char *fileNameCodecName)
 {
-    p->fileNameCodec=QTextCodec::codecForName(fileNameCodecName);
+    p->fileNameCodec=QuazipTextCodec::codecForName(fileNameCodecName);
 }
 
 void QuaZip::setOsCode(uint osCode)
@@ -608,22 +608,22 @@ uint QuaZip::getOsCode() const
     return p->osCode;
 }
 
-QTextCodec *QuaZip::getFileNameCodec()const
+QuazipTextCodec *QuaZip::getFileNameCodec()const
 {
   return p->fileNameCodec;
 }
 
-void QuaZip::setCommentCodec(QTextCodec *commentCodec)
+void QuaZip::setCommentCodec(QuazipTextCodec *commentCodec)
 {
   p->commentCodec=commentCodec;
 }
 
 void QuaZip::setCommentCodec(const char *commentCodecName)
 {
-  p->commentCodec=QTextCodec::codecForName(commentCodecName);
+  p->commentCodec=QuazipTextCodec::codecForName(commentCodecName);
 }
 
-QTextCodec *QuaZip::getCommentCodec()const
+QuazipTextCodec *QuaZip::getCommentCodec()const
 {
   return p->commentCodec;
 }
@@ -783,14 +783,14 @@ Qt::CaseSensitivity QuaZip::convertCaseSensitivity(QuaZip::CaseSensitivity cs)
   }
 }
 
-void QuaZip::setDefaultFileNameCodec(QTextCodec *codec)
+void QuaZip::setDefaultFileNameCodec(QuazipTextCodec *codec)
 {
     QuaZipPrivate::defaultFileNameCodec = codec;
 }
 
 void QuaZip::setDefaultFileNameCodec(const char *codecName)
 {
-    setDefaultFileNameCodec(QTextCodec::codecForName(codecName));
+    setDefaultFileNameCodec(QuazipTextCodec::codecForName(codecName));
 }
 
 void QuaZip::setDefaultOsCode(uint osCode)