Rename the c zlib module (#58)

Motivation: The C module with zlib shims is called "CGRPCZlib", however it should really be named "CGRPCNIOTransportZlib". Modifications: - Rename module and symbols Result: Better naming
grpc · Jan 17, 2025 · efa4422 · efa4422
1 parent e4bf649
commit efa4422
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 26 deletions.
diff --git a/.licenseignore b/.licenseignore
@@ -38,5 +38,5 @@ dev/version-bump.commit.template
 IntegrationTests/grpc-performance-tests/Sources/Generated/*
 LICENSE
 **/*.swift
-Sources/CGRPCZlib/*
+Sources/CGRPCNIOTransportZlib/*
 dev/protos/**/*.proto
diff --git a/Package.swift b/Package.swift
@@ -73,7 +73,7 @@ let defaultSwiftSettings: [SwiftSetting] = [
 let targets: [Target] = [
   // C-module for z-lib shims
   .target(
-    name: "CGRPCZlib",
+    name: "CGRPCNIOTransportZlib",
     dependencies: [],
     linkerSettings: [
       .linkedLibrary("z")
@@ -88,7 +88,7 @@ let targets: [Target] = [
       .product(name: "NIOCore", package: "swift-nio"),
       .product(name: "NIOHTTP2", package: "swift-nio-http2"),
       .product(name: "NIOExtras", package: "swift-nio-extras"),
-      .target(name: "CGRPCZlib"),
+      .target(name: "CGRPCNIOTransportZlib"),
     ],
     swiftSettings: defaultSwiftSettings
   ),

diff --git a/Sources/CGRPCZlib/empty.c → Sources/CGRPCNIOTransportZlib/empty.c b/Sources/CGRPCZlib/empty.c → Sources/CGRPCNIOTransportZlib/empty.c
@@ -16,4 +16,4 @@
 
 // Xcode's Archive builds with Xcode's Package support struggle with empty .c files
 // (https://bugs.swift.org/browse/SR-12939).
-void CGRPCZlib_i_do_nothing_just_working_around_a_darwin_toolchain_bug(void) {}
+void CGRPCNIOTransportZlib_i_do_nothing_just_working_around_a_darwin_toolchain_bug(void) {}
diff --git a/Sources/CGRPCZlib/include/CGRPCZlib.h → ...CGRPCNIOTransportZlib/include/CGRPCZlib.h b/Sources/CGRPCZlib/include/CGRPCZlib.h → ...CGRPCNIOTransportZlib/include/CGRPCZlib.h
@@ -18,44 +18,44 @@
 
 #include <zlib.h>
 
-static inline int CGRPCZlib_deflateInit2(z_streamp stream, int level, int method, int windowBits,
+static inline int CGRPCNIOTransportZlib_deflateInit2(z_streamp stream, int level, int method, int windowBits,
                                          int memLevel, int strategy) {
   return deflateInit2(stream, level, method, windowBits, memLevel, strategy);
 }
 
-static inline unsigned long CGRPCZlib_deflateBound(z_streamp strm, unsigned long sourceLen) {
+static inline unsigned long CGRPCNIOTransportZlib_deflateBound(z_streamp strm, unsigned long sourceLen) {
   return deflateBound(strm, sourceLen);
 }
 
-static inline int CGRPCZlib_deflate(z_streamp strm, int flush) {
+static inline int CGRPCNIOTransportZlib_deflate(z_streamp strm, int flush) {
   return deflate(strm, flush);
 }
 
-static inline int CGRPCZlib_deflateReset(z_streamp strm) {
+static inline int CGRPCNIOTransportZlib_deflateReset(z_streamp strm) {
   return deflateReset(strm);
 }
 
-static inline int CGRPCZlib_deflateEnd(z_streamp strm) {
+static inline int CGRPCNIOTransportZlib_deflateEnd(z_streamp strm) {
   return deflateEnd(strm);
 }
 
-static inline int CGRPCZlib_inflateInit2(z_streamp stream, int windowBits) {
+static inline int CGRPCNIOTransportZlib_inflateInit2(z_streamp stream, int windowBits) {
   return inflateInit2(stream, windowBits);
 }
 
-static inline int CGRPCZlib_inflate(z_streamp strm, int flush) {
+static inline int CGRPCNIOTransportZlib_inflate(z_streamp strm, int flush) {
   return inflate(strm, flush);
 }
 
-static inline int CGRPCZlib_inflateReset(z_streamp strm) {
+static inline int CGRPCNIOTransportZlib_inflateReset(z_streamp strm) {
   return inflateReset(strm);
 }
 
-static inline int CGRPCZlib_inflateEnd(z_streamp strm) {
+static inline int CGRPCNIOTransportZlib_inflateEnd(z_streamp strm) {
   return inflateEnd(strm);
 }
 
-static inline Bytef *CGRPCZlib_castVoidToBytefPointer(void *in) {
+static inline Bytef *CGRPCNIOTransportZlib_castVoidToBytefPointer(void *in) {
   return (Bytef *) in;
 }
 

diff --git a/Sources/GRPCNIOTransportCore/Compression/Zlib.swift b/Sources/GRPCNIOTransportCore/Compression/Zlib.swift
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-internal import CGRPCZlib
+internal import CGRPCNIOTransportZlib
 internal import GRPCCore
 internal import NIOCore
 
@@ -152,7 +152,7 @@ extension UnsafeMutablePointer<z_stream> {
     self.pointee.zalloc = nil
     self.pointee.opaque = nil
 
-    let rc = CGRPCZlib_inflateInit2(self, windowBits)
+    let rc = CGRPCNIOTransportZlib_inflateInit2(self, windowBits)
     // Possible return codes:
     // - Z_OK
     // - Z_MEM_ERROR: not enough memory
@@ -163,7 +163,7 @@ extension UnsafeMutablePointer<z_stream> {
   }
 
   func inflateReset() throws {
-    let rc = CGRPCZlib_inflateReset(self)
+    let rc = CGRPCNIOTransportZlib_inflateReset(self)
 
     // Possible return codes:
     // - Z_OK
@@ -179,15 +179,15 @@ extension UnsafeMutablePointer<z_stream> {
   }
 
   func inflateEnd() {
-    _ = CGRPCZlib_inflateEnd(self)
+    _ = CGRPCNIOTransportZlib_inflateEnd(self)
   }
 
   func deflateInit(windowBits: Int32) {
     self.pointee.zfree = nil
     self.pointee.zalloc = nil
     self.pointee.opaque = nil
 
-    let rc = CGRPCZlib_deflateInit2(
+    let rc = CGRPCNIOTransportZlib_deflateInit2(
       self,
       Z_DEFAULT_COMPRESSION,  // compression level
       Z_DEFLATED,  // compression method (this must be Z_DEFLATED)
@@ -207,7 +207,7 @@ extension UnsafeMutablePointer<z_stream> {
   }
 
   func deflateReset() throws {
-    let rc = CGRPCZlib_deflateReset(self)
+    let rc = CGRPCNIOTransportZlib_deflateReset(self)
 
     // Possible return codes:
     // - Z_OK
@@ -223,11 +223,11 @@ extension UnsafeMutablePointer<z_stream> {
   }
 
   func deflateEnd() {
-    _ = CGRPCZlib_deflateEnd(self)
+    _ = CGRPCNIOTransportZlib_deflateEnd(self)
   }
 
   func deflateBound(inputBytes: Int) -> Int {
-    let bound = CGRPCZlib_deflateBound(self, UInt(inputBytes))
+    let bound = CGRPCNIOTransportZlib_deflateBound(self, UInt(inputBytes))
     return Int(bound)
   }
 
@@ -243,7 +243,7 @@ extension UnsafeMutablePointer<z_stream> {
 
   func setNextInputBuffer(_ buffer: UnsafeMutableRawBufferPointer?) {
     if let buffer = buffer, let baseAddress = buffer.baseAddress {
-      self.pointee.next_in = CGRPCZlib_castVoidToBytefPointer(baseAddress)
+      self.pointee.next_in = CGRPCNIOTransportZlib_castVoidToBytefPointer(baseAddress)
       self.pointee.avail_in = UInt32(buffer.count)
     } else {
       self.pointee.next_in = nil
@@ -263,7 +263,7 @@ extension UnsafeMutablePointer<z_stream> {
 
   func setNextOutputBuffer(_ buffer: UnsafeMutableRawBufferPointer?) {
     if let buffer = buffer, let baseAddress = buffer.baseAddress {
-      self.pointee.next_out = CGRPCZlib_castVoidToBytefPointer(baseAddress)
+      self.pointee.next_out = CGRPCNIOTransportZlib_castVoidToBytefPointer(baseAddress)
       self.pointee.avail_out = UInt32(buffer.count)
     } else {
       self.pointee.next_out = nil
@@ -339,7 +339,7 @@ extension UnsafeMutablePointer<z_stream> {
           //
           // Note that Z_OK is not okay here since we always flush with Z_FINISH and therefore
           // use Z_STREAM_END as our success criteria.
-          let rc = CGRPCZlib_inflate(self, Z_FINISH)
+          let rc = CGRPCNIOTransportZlib_inflate(self, Z_FINISH)
           switch rc {
           case Z_STREAM_END:
             finished = true
@@ -392,7 +392,7 @@ extension UnsafeMutablePointer<z_stream> {
         return try output.writeWithUnsafeMutableBytes(minimumWritableBytes: upperBound) { output in
           self.setNextOutputBuffer(output)
 
-          let rc = CGRPCZlib_deflate(self, Z_FINISH)
+          let rc = CGRPCNIOTransportZlib_deflate(self, Z_FINISH)
 
           // Possible return codes:
           // - Z_OK: some progress has been made