Skip to content

Commit efa4422

Browse files
authored
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
1 parent e4bf649 commit efa4422

File tree

5 files changed

+26
-26
lines changed

5 files changed

+26
-26
lines changed

.licenseignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ dev/version-bump.commit.template
3838
IntegrationTests/grpc-performance-tests/Sources/Generated/*
3939
LICENSE
4040
**/*.swift
41-
Sources/CGRPCZlib/*
41+
Sources/CGRPCNIOTransportZlib/*
4242
dev/protos/**/*.proto

Package.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ let defaultSwiftSettings: [SwiftSetting] = [
7373
let targets: [Target] = [
7474
// C-module for z-lib shims
7575
.target(
76-
name: "CGRPCZlib",
76+
name: "CGRPCNIOTransportZlib",
7777
dependencies: [],
7878
linkerSettings: [
7979
.linkedLibrary("z")
@@ -88,7 +88,7 @@ let targets: [Target] = [
8888
.product(name: "NIOCore", package: "swift-nio"),
8989
.product(name: "NIOHTTP2", package: "swift-nio-http2"),
9090
.product(name: "NIOExtras", package: "swift-nio-extras"),
91-
.target(name: "CGRPCZlib"),
91+
.target(name: "CGRPCNIOTransportZlib"),
9292
],
9393
swiftSettings: defaultSwiftSettings
9494
),

Sources/CGRPCZlib/empty.c renamed to Sources/CGRPCNIOTransportZlib/empty.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
// Xcode's Archive builds with Xcode's Package support struggle with empty .c files
1818
// (https://bugs.swift.org/browse/SR-12939).
19-
void CGRPCZlib_i_do_nothing_just_working_around_a_darwin_toolchain_bug(void) {}
19+
void CGRPCNIOTransportZlib_i_do_nothing_just_working_around_a_darwin_toolchain_bug(void) {}

Sources/CGRPCZlib/include/CGRPCZlib.h renamed to Sources/CGRPCNIOTransportZlib/include/CGRPCZlib.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,44 +18,44 @@
1818

1919
#include <zlib.h>
2020

21-
static inline int CGRPCZlib_deflateInit2(z_streamp stream, int level, int method, int windowBits,
21+
static inline int CGRPCNIOTransportZlib_deflateInit2(z_streamp stream, int level, int method, int windowBits,
2222
int memLevel, int strategy) {
2323
return deflateInit2(stream, level, method, windowBits, memLevel, strategy);
2424
}
2525

26-
static inline unsigned long CGRPCZlib_deflateBound(z_streamp strm, unsigned long sourceLen) {
26+
static inline unsigned long CGRPCNIOTransportZlib_deflateBound(z_streamp strm, unsigned long sourceLen) {
2727
return deflateBound(strm, sourceLen);
2828
}
2929

30-
static inline int CGRPCZlib_deflate(z_streamp strm, int flush) {
30+
static inline int CGRPCNIOTransportZlib_deflate(z_streamp strm, int flush) {
3131
return deflate(strm, flush);
3232
}
3333

34-
static inline int CGRPCZlib_deflateReset(z_streamp strm) {
34+
static inline int CGRPCNIOTransportZlib_deflateReset(z_streamp strm) {
3535
return deflateReset(strm);
3636
}
3737

38-
static inline int CGRPCZlib_deflateEnd(z_streamp strm) {
38+
static inline int CGRPCNIOTransportZlib_deflateEnd(z_streamp strm) {
3939
return deflateEnd(strm);
4040
}
4141

42-
static inline int CGRPCZlib_inflateInit2(z_streamp stream, int windowBits) {
42+
static inline int CGRPCNIOTransportZlib_inflateInit2(z_streamp stream, int windowBits) {
4343
return inflateInit2(stream, windowBits);
4444
}
4545

46-
static inline int CGRPCZlib_inflate(z_streamp strm, int flush) {
46+
static inline int CGRPCNIOTransportZlib_inflate(z_streamp strm, int flush) {
4747
return inflate(strm, flush);
4848
}
4949

50-
static inline int CGRPCZlib_inflateReset(z_streamp strm) {
50+
static inline int CGRPCNIOTransportZlib_inflateReset(z_streamp strm) {
5151
return inflateReset(strm);
5252
}
5353

54-
static inline int CGRPCZlib_inflateEnd(z_streamp strm) {
54+
static inline int CGRPCNIOTransportZlib_inflateEnd(z_streamp strm) {
5555
return inflateEnd(strm);
5656
}
5757

58-
static inline Bytef *CGRPCZlib_castVoidToBytefPointer(void *in) {
58+
static inline Bytef *CGRPCNIOTransportZlib_castVoidToBytefPointer(void *in) {
5959
return (Bytef *) in;
6060
}
6161

Sources/GRPCNIOTransportCore/Compression/Zlib.swift

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
internal import CGRPCZlib
17+
internal import CGRPCNIOTransportZlib
1818
internal import GRPCCore
1919
internal import NIOCore
2020

@@ -152,7 +152,7 @@ extension UnsafeMutablePointer<z_stream> {
152152
self.pointee.zalloc = nil
153153
self.pointee.opaque = nil
154154

155-
let rc = CGRPCZlib_inflateInit2(self, windowBits)
155+
let rc = CGRPCNIOTransportZlib_inflateInit2(self, windowBits)
156156
// Possible return codes:
157157
// - Z_OK
158158
// - Z_MEM_ERROR: not enough memory
@@ -163,7 +163,7 @@ extension UnsafeMutablePointer<z_stream> {
163163
}
164164

165165
func inflateReset() throws {
166-
let rc = CGRPCZlib_inflateReset(self)
166+
let rc = CGRPCNIOTransportZlib_inflateReset(self)
167167

168168
// Possible return codes:
169169
// - Z_OK
@@ -179,15 +179,15 @@ extension UnsafeMutablePointer<z_stream> {
179179
}
180180

181181
func inflateEnd() {
182-
_ = CGRPCZlib_inflateEnd(self)
182+
_ = CGRPCNIOTransportZlib_inflateEnd(self)
183183
}
184184

185185
func deflateInit(windowBits: Int32) {
186186
self.pointee.zfree = nil
187187
self.pointee.zalloc = nil
188188
self.pointee.opaque = nil
189189

190-
let rc = CGRPCZlib_deflateInit2(
190+
let rc = CGRPCNIOTransportZlib_deflateInit2(
191191
self,
192192
Z_DEFAULT_COMPRESSION, // compression level
193193
Z_DEFLATED, // compression method (this must be Z_DEFLATED)
@@ -207,7 +207,7 @@ extension UnsafeMutablePointer<z_stream> {
207207
}
208208

209209
func deflateReset() throws {
210-
let rc = CGRPCZlib_deflateReset(self)
210+
let rc = CGRPCNIOTransportZlib_deflateReset(self)
211211

212212
// Possible return codes:
213213
// - Z_OK
@@ -223,11 +223,11 @@ extension UnsafeMutablePointer<z_stream> {
223223
}
224224

225225
func deflateEnd() {
226-
_ = CGRPCZlib_deflateEnd(self)
226+
_ = CGRPCNIOTransportZlib_deflateEnd(self)
227227
}
228228

229229
func deflateBound(inputBytes: Int) -> Int {
230-
let bound = CGRPCZlib_deflateBound(self, UInt(inputBytes))
230+
let bound = CGRPCNIOTransportZlib_deflateBound(self, UInt(inputBytes))
231231
return Int(bound)
232232
}
233233

@@ -243,7 +243,7 @@ extension UnsafeMutablePointer<z_stream> {
243243

244244
func setNextInputBuffer(_ buffer: UnsafeMutableRawBufferPointer?) {
245245
if let buffer = buffer, let baseAddress = buffer.baseAddress {
246-
self.pointee.next_in = CGRPCZlib_castVoidToBytefPointer(baseAddress)
246+
self.pointee.next_in = CGRPCNIOTransportZlib_castVoidToBytefPointer(baseAddress)
247247
self.pointee.avail_in = UInt32(buffer.count)
248248
} else {
249249
self.pointee.next_in = nil
@@ -263,7 +263,7 @@ extension UnsafeMutablePointer<z_stream> {
263263

264264
func setNextOutputBuffer(_ buffer: UnsafeMutableRawBufferPointer?) {
265265
if let buffer = buffer, let baseAddress = buffer.baseAddress {
266-
self.pointee.next_out = CGRPCZlib_castVoidToBytefPointer(baseAddress)
266+
self.pointee.next_out = CGRPCNIOTransportZlib_castVoidToBytefPointer(baseAddress)
267267
self.pointee.avail_out = UInt32(buffer.count)
268268
} else {
269269
self.pointee.next_out = nil
@@ -339,7 +339,7 @@ extension UnsafeMutablePointer<z_stream> {
339339
//
340340
// Note that Z_OK is not okay here since we always flush with Z_FINISH and therefore
341341
// use Z_STREAM_END as our success criteria.
342-
let rc = CGRPCZlib_inflate(self, Z_FINISH)
342+
let rc = CGRPCNIOTransportZlib_inflate(self, Z_FINISH)
343343
switch rc {
344344
case Z_STREAM_END:
345345
finished = true
@@ -392,7 +392,7 @@ extension UnsafeMutablePointer<z_stream> {
392392
return try output.writeWithUnsafeMutableBytes(minimumWritableBytes: upperBound) { output in
393393
self.setNextOutputBuffer(output)
394394

395-
let rc = CGRPCZlib_deflate(self, Z_FINISH)
395+
let rc = CGRPCNIOTransportZlib_deflate(self, Z_FINISH)
396396

397397
// Possible return codes:
398398
// - Z_OK: some progress has been made

0 commit comments

Comments
 (0)