Decompress one or more text files from zip with minizip

.gitattributes

@@ -0,0 +1,18 @@
+# https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings
+
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Declare files that will always have CRLF line endings on checkout.
+# This is needed for the unit tests to pass when unzipping files.
+Benchmark/Files/SmallBasicTextFileZip/SmallBasicTextFile.txt text eol=crlf
+
+Benchmark/Files/MultiTextFileZip/TextFileOne.txt text eol=crlf
+Benchmark/Files/MultiTextFileZip/TextFileTwo.txt text eol=crlf
+Benchmark/Files/MultiTextFileZip/ThirdTextFile.txt text eol=crlf
+
+Benchmark/Files/MultiTextFileAndSubDirZip/DirFileOne/TextFileOne.txt text eol=crlf
+Benchmark/Files/MultiTextFileAndSubDirZip/TextFile.txt text eol=crlf
+Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/OtherDir/DummyFile.txt text eol=crlf
+Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/OtherDir/FilleInDirectory.txt text eol=crlf
+Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/SubDirWithCopyOfTopLevelFile/TextFile.txt text eol=crlf

.gitignore

@@ -10,6 +10,8 @@ main.exe
 Benchmark*.txt*
 Benchmark/Files/*.compressed.*
 Benchmark/Files/*.decompressed.*
+Benchmark/Files/*.zipped.*
+Benchmark/Files/*.unzipped.*
 
 # Test generated files
 Test*.txt*

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "External/zlib"]
 	path = External/zlib
 	url = https://github.com/madler/zlib.git
+[submodule "External/minizip-ng"]
+	path = External/minizip-ng
+	url = https://github.com/zlib-ng/minizip-ng

.vscode/settings.json

@@ -29,5 +29,31 @@
         "unistd.h": "c",
         "bitset": "c",
         "ftw.h": "c"
+        "zip_minizip.h": "c",
+        "unzip.h": "c",
+        "unzip_minizip.h": "c",
+        "testzipunzipminizip.h": "c",
+        "unity_fixture.h": "c",
+        "testdeflateinflatezlib.h": "c",
+        "cstdlib": "c",
+        "rope": "c",
+        "*.def": "c",
+        "testunzipminizip.h": "c",
+        "unity_fixture_internals.h": "c",
+        "unity_memory.h": "c",
+        "string_view": "c",
+        "regex": "c",
+        "*.inc": "c",
+        "zipcontentinfo.h": "c",
+        "iunzip.h": "c",
+        "typeindex": "c",
+        "chrono": "c",
+        "typeinfo": "c",
+        "ioapi.h": "c",
+        "stdlib.h": "c",
+        "stat.h": "c",
+        "types.h": "c",
+        "unistd.h": "c",
+        "dirent.h": "c"
     },
 }

Benchmark/Files/MultiTextFileAndSubDirZip/DirFileOne/TextFileOne.txt

@@ -0,0 +1,2 @@
+This is
+the first text file.

Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/OtherDir/DummyFile.txt

@@ -0,0 +1 @@
+Some dummy file with empty second line

Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/OtherDir/FilleInDirectory.txt

@@ -0,0 +1 @@
+This file is in a directory

Benchmark/Files/MultiTextFileAndSubDirZip/DirOfDirs/SubDirWithCopyOfTopLevelFile/TextFile.txt

@@ -0,0 +1,3 @@
+The 3rd file contains
+
+an empty line on line 2.

Benchmark/Files/MultiTextFileAndSubDirZip/Readme.md

@@ -0,0 +1,15 @@
+The zip file has been created with the build in compressions option from the Windows 11 Pro 23H2 file explorer.
+
+1. Select the files to zip.
+2. Right-click > "Compress to..." > "Additional options"
+3. For the `*_store.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Store`
+    - Retain symbolic links: `checked` (this is the default)
+4. For the `*_deflate.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Deflate`
+    - Compression level: `6` (this is the default)
+    - Retain symbolic links: `checked` (this is the default)
+
+

Benchmark/Files/MultiTextFileAndSubDirZip/TextFile.txt

@@ -0,0 +1,3 @@
+The 3rd file contains
+
+an empty line on line 2.

Benchmark/Files/MultiTextFileZip/Readme.md

@@ -0,0 +1,15 @@
+The zip file has been created with the build in compressions option from the Windows 11 Pro 23H2 file explorer.
+
+1. Select the files to zip.
+2. Right-click > "Compress to..." > "Additional options"
+3. For the `*_store.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Store`
+    - Retain symbolic links: `checked` (this is the default)
+4. For the `*_deflate.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Deflate`
+    - Compression level: `6` (this is the default)
+    - Retain symbolic links: `checked` (this is the default)
+
+

Benchmark/Files/MultiTextFileZip/TextFileOne.txt

@@ -0,0 +1,2 @@
+This is
+the first text file.

Benchmark/Files/MultiTextFileZip/TextFileTwo.txt

@@ -0,0 +1,2 @@
+Second file is this
+.

Benchmark/Files/MultiTextFileZip/ThirdTextFile.txt

@@ -0,0 +1,3 @@
+The 3rd file contains
+
+an empty line on line 2.

Benchmark/Files/README.md

@@ -0,0 +1 @@
+All these files are created on windows. Meaning that by default they end in `\r\n` rather than `\n`. This is important when testing that unzipped files are identical as the original.

Benchmark/Files/SmallBasicTextFileZip/Readme.md

@@ -0,0 +1,15 @@
+The zip file has been created with the build in compressions option from the Windows 11 Pro 23H2 file explorer.
+
+1. Select the files to zip.
+2. Right-click > "Compress to..." > "Additional options"
+3. For the `*_store.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Store`
+    - Retain symbolic links: `checked` (this is the default)
+4. For the `*_deflate.zip` file:
+    - Archive format: `ZIP`
+    - Compression method: `Deflate`
+    - Compression level: `6` (this is the default)
+    - Retain symbolic links: `checked` (this is the default)
+
+

Benchmark/Files/SmallBasicTextFileZip/SmallBasicTextFile.txt

@@ -0,0 +1,4 @@
+This is a test file.
+On the second line there are eight words
+    The third line has a tab.
+And the last line is a longer piece. Consising of two sentences.

CoDeLib/CMakeLists.txt

@@ -19,17 +19,20 @@ set(CoDeLib_PUBLIC_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/include/CoDeLib)
 set(COMMON_HEADERS
     ${CoDeLib_PUBLIC_INCLUDE_PATH}/IDeflate.h
     ${CoDeLib_PUBLIC_INCLUDE_PATH}/IInflate.h
+    ${CoDeLib_PUBLIC_INCLUDE_PATH}/IUnZip.h
 )
 install(FILES ${COMMON_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/CoDeLib)
 
 add_subdirectory(Deflate_zlib)
 add_subdirectory(Inflate_zlib)
 add_subdirectory(FileUtils)
+add_subdirectory(UnZip_minizip)
 add_subdirectory(RaiiString)
+add_subdirectory(ZipContentInfo)
 add_subdirectory(Test)
 
 install(
-    TARGETS CoDeLib Deflate_zlib Inflate_zlib RaiiString FileUtils
+    TARGETS CoDeLib Deflate_zlib Inflate_zlib UnZip_minizip RaiiString ZipContentInfo FileUtils
     EXPORT CoDeLibTargets
     INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}

CoDeLib/Config.cmake.in

@@ -7,4 +7,6 @@ check_required_components(CoDeLib)
 include(CMakeFindDependencyMacro)
 
 set(ZLIB_USE_STATIC_LIBS "ON")
-find_dependency(ZLIB REQUIRED)
+find_dependency(ZLIB REQUIRED)
+
+find_dependency(minizip REQUIRED)

CoDeLib/CustomDeflate.md

@@ -4,4 +4,5 @@
 
 # refs
 
-- https://pnrsolution.org/Datacenter/Vol4/Issue1/58.pdf
+- https://pnrsolution.org/Datacenter/Vol4/Issue1/58.pdf
+- https://nachtimwald.com/2019/09/08/making-minizip-easier-to-use/

CoDeLib/Deflate_zlib/CMakeLists.txt

@@ -10,7 +10,6 @@ set(ZLIB_USE_STATIC_LIBS "ON")
 find_package(ZLIB REQUIRED)
 target_link_libraries(Deflate_zlib PRIVATE ZLIB::ZLIB)
 
-message(STATUS "CoDeLib_PUBLIC_INCLUDE_PATH: ${CoDeLib_PUBLIC_INCLUDE_PATH}")
 set(Deflate_zlib_PUBLIC_INCLUDE_PATH ${CoDeLib_PUBLIC_INCLUDE_PATH}/Deflate_zlib)
 set(Deflate_zlib_PUBLIC_HEADERS
     ${Deflate_zlib_PUBLIC_INCLUDE_PATH}/Deflate_zlib.h

CoDeLib/FileUtils/src/FileUtils.c

@@ -291,6 +291,9 @@ bool FilesAreEqual(FILE *pFile1, FILE *pFile2) {
     const size_t fileSize2 = GetFileSizeInBytes(pFile2);
 
     if (fileSize1 != fileSize2) {
+        printf("File sizes not equal:\n");
+        printf("    fileSize1: %lu\n", (unsigned long)fileSize1);
+        printf("    fileSize2: %lu\n", (unsigned long)fileSize2);
         return false;
     }
 
@@ -306,6 +309,9 @@ bool FilesAreEqual(FILE *pFile1, FILE *pFile2) {
         bytesRead2 = fread(buffer2, 1, bufferSize, pFile2);
 
         if (bytesRead1 != bytesRead2) {
+            printf("Bytes read not equal:\n");
+            printf("    bytesRead1: %lu\n", (unsigned long)bytesRead1);
+            printf("    bytesRead2: %lu\n", (unsigned long)bytesRead2);
             return false;
         }
 
@@ -315,12 +321,16 @@ bool FilesAreEqual(FILE *pFile1, FILE *pFile2) {
         const int errorFile2 = ferror(pFile2);
         if ((eofFile1 && !eofFile2) || (!eofFile1 && eofFile2)) {
             printf("EOF indicator set only by one file\n");
+            return false;
         } else if ((!eofFile1 && errorFile1) || (!eofFile2 && errorFile2)) {
             printf("Error indicator set");
             return false;
         }
 
         if (memcmp(buffer1, buffer2, bytesRead1) != 0) {
+            printf("Buffers not equal\n");
+            printf("    buffer1: %s\n", buffer1);
+            printf("    buffer2: %s\n", buffer2);
             return false;
         }
     } while (bytesRead1 > 0);

CoDeLib/Test/CMakeLists.txt

@@ -2,17 +2,16 @@ add_executable(CoDeLib_Test
     src/main.c
     src/TestRaiiString.c
     src/TestDeflateInflateZlib.c
-    src/TestFileUtils.c)
+    src/TestFileUtils.c
+    src/TestUnZipMinizip.c
+    src/TestUnZipMinizipInflateZlib.c
+    src/TestZipContentInfo.c
+)
 
 target_include_directories(CoDeLib_Test PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
 )
 
-target_link_libraries(CoDeLib_Test PRIVATE Deflate_zlib)
-target_link_libraries(CoDeLib_Test PRIVATE Inflate_zlib)
-target_link_libraries(CoDeLib_Test PRIVATE RaiiString)
-target_link_libraries(CoDeLib_Test PRIVATE FileUtils)
-
 FetchContent_Declare(
     Unity
     GIT_REPOSITORY https://github.com/ThrowTheSwitch/Unity.git
@@ -23,4 +22,14 @@ FetchContent_Declare(
 # If cache is not used, you will get `Policy CMP0077 is not set: option() honors normal variables.` 
 set(UNITY_EXTENSION_FIXTURE ON CACHE INTERNAL "")
 FetchContent_MakeAvailable(Unity)
+
+target_link_libraries(CoDeLib_Test PRIVATE Deflate_zlib)
+target_link_libraries(CoDeLib_Test PRIVATE Inflate_zlib)
+target_link_libraries(CoDeLib_Test PRIVATE FileUtils)
+target_link_libraries(CoDeLib_Test PRIVATE UnZip_minizip)
+target_link_libraries(CoDeLib_Test PRIVATE RaiiString)
+target_link_libraries(CoDeLib_Test PRIVATE ZipContentInfo)
+
 target_link_libraries(CoDeLib_Test PRIVATE unity)
+
+