annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/kj/compat/gzip.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 // Copyright (c) 2017 Cloudflare, Inc. and contributors
jpayne@69 2 // Licensed under the MIT License:
jpayne@69 3 //
jpayne@69 4 // Permission is hereby granted, free of charge, to any person obtaining a copy
jpayne@69 5 // of this software and associated documentation files (the "Software"), to deal
jpayne@69 6 // in the Software without restriction, including without limitation the rights
jpayne@69 7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
jpayne@69 8 // copies of the Software, and to permit persons to whom the Software is
jpayne@69 9 // furnished to do so, subject to the following conditions:
jpayne@69 10 //
jpayne@69 11 // The above copyright notice and this permission notice shall be included in
jpayne@69 12 // all copies or substantial portions of the Software.
jpayne@69 13 //
jpayne@69 14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jpayne@69 15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jpayne@69 16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jpayne@69 17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
jpayne@69 18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jpayne@69 19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
jpayne@69 20 // THE SOFTWARE.
jpayne@69 21
jpayne@69 22 #pragma once
jpayne@69 23
jpayne@69 24 #include <kj/io.h>
jpayne@69 25 #include <kj/async-io.h>
jpayne@69 26 #include <zlib.h>
jpayne@69 27
jpayne@69 28 KJ_BEGIN_HEADER
jpayne@69 29
jpayne@69 30 namespace kj {
jpayne@69 31
jpayne@69 32 namespace _ { // private
jpayne@69 33
jpayne@69 34 constexpr size_t KJ_GZ_BUF_SIZE = 4096;
jpayne@69 35
jpayne@69 36 class GzipOutputContext final {
jpayne@69 37 public:
jpayne@69 38 GzipOutputContext(kj::Maybe<int> compressionLevel);
jpayne@69 39 ~GzipOutputContext() noexcept(false);
jpayne@69 40 KJ_DISALLOW_COPY_AND_MOVE(GzipOutputContext);
jpayne@69 41
jpayne@69 42 void setInput(const void* in, size_t size);
jpayne@69 43 kj::Tuple<bool, kj::ArrayPtr<const byte>> pumpOnce(int flush);
jpayne@69 44
jpayne@69 45 private:
jpayne@69 46 bool compressing;
jpayne@69 47 z_stream ctx = {};
jpayne@69 48 byte buffer[_::KJ_GZ_BUF_SIZE];
jpayne@69 49
jpayne@69 50 [[noreturn]] void fail(int result);
jpayne@69 51 };
jpayne@69 52
jpayne@69 53 } // namespace _ (private)
jpayne@69 54
jpayne@69 55 class GzipInputStream final: public InputStream {
jpayne@69 56 public:
jpayne@69 57 GzipInputStream(InputStream& inner);
jpayne@69 58 ~GzipInputStream() noexcept(false);
jpayne@69 59 KJ_DISALLOW_COPY_AND_MOVE(GzipInputStream);
jpayne@69 60
jpayne@69 61 size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) override;
jpayne@69 62
jpayne@69 63 private:
jpayne@69 64 InputStream& inner;
jpayne@69 65 z_stream ctx = {};
jpayne@69 66 bool atValidEndpoint = false;
jpayne@69 67
jpayne@69 68 byte buffer[_::KJ_GZ_BUF_SIZE];
jpayne@69 69
jpayne@69 70 size_t readImpl(byte* buffer, size_t minBytes, size_t maxBytes, size_t alreadyRead);
jpayne@69 71 };
jpayne@69 72
jpayne@69 73 class GzipOutputStream final: public OutputStream {
jpayne@69 74 public:
jpayne@69 75 enum { DECOMPRESS };
jpayne@69 76
jpayne@69 77 GzipOutputStream(OutputStream& inner, int compressionLevel = Z_DEFAULT_COMPRESSION);
jpayne@69 78 GzipOutputStream(OutputStream& inner, decltype(DECOMPRESS));
jpayne@69 79 ~GzipOutputStream() noexcept(false);
jpayne@69 80 KJ_DISALLOW_COPY_AND_MOVE(GzipOutputStream);
jpayne@69 81
jpayne@69 82 void write(const void* buffer, size_t size) override;
jpayne@69 83 using OutputStream::write;
jpayne@69 84
jpayne@69 85 inline void flush() {
jpayne@69 86 pump(Z_SYNC_FLUSH);
jpayne@69 87 }
jpayne@69 88
jpayne@69 89 private:
jpayne@69 90 OutputStream& inner;
jpayne@69 91 _::GzipOutputContext ctx;
jpayne@69 92
jpayne@69 93 void pump(int flush);
jpayne@69 94 };
jpayne@69 95
jpayne@69 96 class GzipAsyncInputStream final: public AsyncInputStream {
jpayne@69 97 public:
jpayne@69 98 GzipAsyncInputStream(AsyncInputStream& inner);
jpayne@69 99 ~GzipAsyncInputStream() noexcept(false);
jpayne@69 100 KJ_DISALLOW_COPY_AND_MOVE(GzipAsyncInputStream);
jpayne@69 101
jpayne@69 102 Promise<size_t> tryRead(void* buffer, size_t minBytes, size_t maxBytes) override;
jpayne@69 103
jpayne@69 104 private:
jpayne@69 105 AsyncInputStream& inner;
jpayne@69 106 z_stream ctx = {};
jpayne@69 107 bool atValidEndpoint = false;
jpayne@69 108
jpayne@69 109 byte buffer[_::KJ_GZ_BUF_SIZE];
jpayne@69 110
jpayne@69 111 Promise<size_t> readImpl(byte* buffer, size_t minBytes, size_t maxBytes, size_t alreadyRead);
jpayne@69 112 };
jpayne@69 113
jpayne@69 114 class GzipAsyncOutputStream final: public AsyncOutputStream {
jpayne@69 115 public:
jpayne@69 116 enum { DECOMPRESS };
jpayne@69 117
jpayne@69 118 GzipAsyncOutputStream(AsyncOutputStream& inner, int compressionLevel = Z_DEFAULT_COMPRESSION);
jpayne@69 119 GzipAsyncOutputStream(AsyncOutputStream& inner, decltype(DECOMPRESS));
jpayne@69 120 KJ_DISALLOW_COPY_AND_MOVE(GzipAsyncOutputStream);
jpayne@69 121
jpayne@69 122 Promise<void> write(const void* buffer, size_t size) override;
jpayne@69 123 Promise<void> write(ArrayPtr<const ArrayPtr<const byte>> pieces) override;
jpayne@69 124
jpayne@69 125 Promise<void> whenWriteDisconnected() override { return inner.whenWriteDisconnected(); }
jpayne@69 126
jpayne@69 127 inline Promise<void> flush() {
jpayne@69 128 return pump(Z_SYNC_FLUSH);
jpayne@69 129 }
jpayne@69 130 // Call if you need to flush a stream at an arbitrary data point.
jpayne@69 131
jpayne@69 132 Promise<void> end() {
jpayne@69 133 return pump(Z_FINISH);
jpayne@69 134 }
jpayne@69 135 // Must call to flush and finish the stream, since some data may be buffered.
jpayne@69 136 //
jpayne@69 137 // TODO(cleanup): This should be a virtual method on AsyncOutputStream.
jpayne@69 138
jpayne@69 139 private:
jpayne@69 140 AsyncOutputStream& inner;
jpayne@69 141 _::GzipOutputContext ctx;
jpayne@69 142
jpayne@69 143 kj::Promise<void> pump(int flush);
jpayne@69 144 };
jpayne@69 145
jpayne@69 146 } // namespace kj
jpayne@69 147
jpayne@69 148 KJ_END_HEADER