Add zlib compression plugin

.github/workflows/macos.yml

@@ -80,6 +80,10 @@ jobs:
         working-directory: ./build/debug
         run: ./tactile-core-test
 
+      - name: Run Zlib compression tests
+        working-directory: ./build/debug
+        run: ./tactile-zlib-compression-test
+
       - name: Run Zstd compression tests
         working-directory: ./build/debug
         run: ./tactile-zstd-compression-test

.github/workflows/ubuntu.yml

@@ -114,6 +114,10 @@ jobs:
         working-directory: ./build/debug
         run: ./tactile-core-test
 
+      - name: Run Zlib compression tests
+        working-directory: ./build/debug
+        run: ./tactile-zlib-compression-test
+
       - name: Run Zstd compression tests
         working-directory: ./build/debug
         run: ./tactile-zstd-compression-test

.github/workflows/windows.yml

@@ -79,6 +79,11 @@ jobs:
         shell: cmd
         run: tactile-core-test.exe
 
+      - name: Run Zlib compression tests
+        working-directory: ./build/debug
+        shell: cmd
+        run: tactile-zlib-compression-test.exe
+
       - name: Run Zstd compression tests
         working-directory: ./build/debug
         shell: cmd

CMakeLists.txt

@@ -72,6 +72,7 @@ add_subdirectory("source/proto")
 add_subdirectory("source/base")
 add_subdirectory("source/core")
 add_subdirectory("source/runtime")
+add_subdirectory("source/zlib_compression")
 add_subdirectory("source/zstd_compression")
 add_subdirectory("source/main")
 

source/core/CMakeLists.txt

@@ -73,8 +73,6 @@ target_sources(tactile-core
                "${PROJECT_SOURCE_DIR}/inc/tactile/core/event/viewport_events.hpp"
                "${PROJECT_SOURCE_DIR}/inc/tactile/core/io/compress/compression_error.hpp"
                "${PROJECT_SOURCE_DIR}/src/tactile/core/io/compress/compression_error.cpp"
-               "${PROJECT_SOURCE_DIR}/inc/tactile/core/io/compress/zlib_compression_provider.hpp"
-               "${PROJECT_SOURCE_DIR}/src/tactile/core/io/compress/zlib_compression_provider.cpp"
                "${PROJECT_SOURCE_DIR}/inc/tactile/core/io/save/ir.hpp"
                "${PROJECT_SOURCE_DIR}/inc/tactile/core/io/save/save_format.hpp"
                "${PROJECT_SOURCE_DIR}/inc/tactile/core/io/save/save_format_id.hpp"
@@ -285,5 +283,4 @@ target_link_libraries(tactile-core
                       SDL2::SDL2
                       protobuf::libprotobuf
                       tinyfiledialogs::tinyfiledialogs
-                      ZLIB::ZLIB
                       )

source/core/test/CMakeLists.txt

@@ -13,7 +13,6 @@ target_sources(tactile-core-test
                "${PROJECT_SOURCE_DIR}/src/debug/validation_test.cpp"
                "${PROJECT_SOURCE_DIR}/src/entity/registry_test.cpp"
                "${PROJECT_SOURCE_DIR}/src/event/event_dispatcher_test.cpp"
-               "${PROJECT_SOURCE_DIR}/src/io/compress/compression_provider_test.cpp"
                "${PROJECT_SOURCE_DIR}/src/io/save/save_format_id_test.cpp"
                "${PROJECT_SOURCE_DIR}/src/io/ini_test.cpp"
                "${PROJECT_SOURCE_DIR}/src/layer/group_layer_test.cpp"

source/runtime/CMakeLists.txt

@@ -31,6 +31,7 @@ target_include_directories(tactile-runtime
 target_compile_definitions(tactile-runtime
                            PRIVATE
                            "TACTILE_BUILDING_RUNTIME"
+                           "TACTILE_ENABLE_ZLIB_COMPRESSION"
                            "TACTILE_ENABLE_ZSTD_COMPRESSION"
                            "TACTILE_ENABLE_OPENGL_RENDERER"
                            )

source/zlib_compression/CMakeLists.txt

@@ -0,0 +1,32 @@
+project(tactile-zlib-compression CXX)
+
+add_library(tactile-zlib-compression SHARED EXCLUDE_FROM_ALL)
+add_library(tactile::zlib_compression ALIAS tactile-zlib-compression)
+
+target_sources(tactile-zlib-compression
+               PRIVATE
+               "${PROJECT_SOURCE_DIR}/inc/tactile/zlib_compression/api.hpp"
+               "${PROJECT_SOURCE_DIR}/inc/tactile/zlib_compression/zlib_compression_plugin.hpp"
+               "${PROJECT_SOURCE_DIR}/src/tactile/zlib_compression/zlib_compression_plugin.cpp"
+               "${PROJECT_SOURCE_DIR}/inc/tactile/zlib_compression/zlib_compressor.hpp"
+               "${PROJECT_SOURCE_DIR}/src/tactile/zlib_compression/zlib_compressor.cpp"
+               )
+
+tactile_prepare_target(tactile-zlib-compression)
+
+target_include_directories(tactile-zlib-compression PUBLIC "${PROJECT_SOURCE_DIR}/inc")
+
+target_compile_definitions(tactile-zlib-compression PRIVATE "TACTILE_BUILDING_ZLIB_COMPRESSION")
+
+target_link_libraries(tactile-zlib-compression
+                      PUBLIC
+                      tactile::base
+                      tactile::runtime
+
+                      PRIVATE
+                      ZLIB::ZLIB
+                      )
+
+if (TACTILE_BUILD_TESTS MATCHES "ON")
+  add_subdirectory(test)
+endif ()

source/zlib_compression/inc/tactile/zlib_compression/api.hpp

@@ -0,0 +1,11 @@
+// Copyright (C) 2024 Albin Johansson (GNU General Public License v3.0)
+
+#pragma once
+
+#include "tactile/base/prelude.hpp"
+
+#ifdef TACTILE_BUILDING_ZLIB_COMPRESSION
+  #define TACTILE_ZLIB_API TACTILE_DLL_EXPORT
+#else
+  #define TACTILE_ZLIB_API TACTILE_DLL_IMPORT
+#endif

source/zlib_compression/inc/tactile/zlib_compression/zlib_compression_plugin.hpp

@@ -0,0 +1,33 @@
+// Copyright (C) 2024 Albin Johansson (GNU General Public License v3.0)
+
+#pragma once
+
+#include "tactile/base/container/smart_ptr.hpp"
+#include "tactile/base/prelude.hpp"
+#include "tactile/runtime/plugin.hpp"
+#include "tactile/zlib_compression/api.hpp"
+#include "tactile/zlib_compression/zlib_compressor.hpp"
+
+namespace tactile {
+
+/**
+ * Manages the Zlib compression plugin.
+ */
+class TACTILE_ZLIB_API ZlibCompressionPlugin final : public IPlugin
+{
+ public:
+  void load(Runtime& runtime) override;
+
+  void unload(Runtime& runtime) override;
+
+ private:
+  Unique<ZlibCompressor> mCompressor {};
+};
+
+extern "C"
+{
+  TACTILE_ZLIB_API auto tactile_make_plugin() -> IPlugin*;
+  TACTILE_ZLIB_API void tactile_free_plugin(IPlugin* plugin);
+}
+
+}  // namespace tactile

source/core/inc/tactile/core/io/compress/zlib_compression_provider.hpp → source/zlib_compression/inc/tactile/zlib_compression/zlib_compressor.hpp

@@ -3,6 +3,8 @@
 #pragma once
 
 #include "tactile/base/io/compress/compression_provider.hpp"
+#include "tactile/base/prelude.hpp"
+#include "tactile/zlib_compression/api.hpp"
 
 namespace tactile {
 
@@ -11,7 +13,8 @@ namespace tactile {
  *
  * \see https://github.com/madler/zlib
  */
-class ZlibCompressionProvider final : public ICompressionProvider {
+class TACTILE_ZLIB_API ZlibCompressor final : public ICompressionProvider
+{
  public:
   [[nodiscard]]
   auto compress(ByteSpan input_data) const -> Result<ByteStream> override;

source/zlib_compression/src/tactile/zlib_compression/zlib_compression_plugin.cpp

@@ -0,0 +1,33 @@
+// Copyright (C) 2024 Albin Johansson (GNU General Public License v3.0)
+
+#include "tactile/zlib_compression/zlib_compression_plugin.hpp"
+
+#include <new>  // nothrow
+
+#include "tactile/runtime/runtime.hpp"
+
+namespace tactile {
+
+void ZlibCompressionPlugin::load(Runtime& runtime)
+{
+  mCompressor = std::make_unique<ZlibCompressor>();
+  runtime.set_compression_provider(CompressionType::kZlib, mCompressor.get());
+}
+
+void ZlibCompressionPlugin::unload(Runtime& runtime)
+{
+  runtime.set_compression_provider(CompressionType::kZlib, nullptr);
+  mCompressor.reset();
+}
+
+auto tactile_make_plugin() -> IPlugin*
+{
+  return new (std::nothrow) ZlibCompressionPlugin {};
+}
+
+void tactile_free_plugin(IPlugin* plugin)
+{
+  delete plugin;
+}
+
+}  // namespace tactile