Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › compress › flate › Compress › Huffman › drain Private Function drain Doc Source Private Function std.compress.flate.Compress.Huffman.drain
fn drain (w : *Writer , data : []const []const u8 , splat : usize ) Writer .Error !usize Params w : *Writer data : []const []const u8 splat : usize File compress/flate/Compress.zig: 2126
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330 fn drain (w : *Writer , data : []const []const u8 , splat : usize ) Writer .Error !usize {
const h : *Huffman = @fieldParentPtr ("writer" , w );
const min_block = @min (w .buffer .len , max_tokens );
const pattern = data [data .len - 1 ];
const data_bytes = Writer .countSplat (data , splat );
const total_bytes = w .end + data_bytes ;
var rem_bytes = total_bytes ;
var rem_splat = splat ;
var rem_data = data ;
var rem_data_elem : []const u8 = w .buffered ();
assert (rem_bytes > min_block );
while (rem_bytes > min_block ) { // not >= to allow `min_block` blocks to be marked as final
// also, it handles the case of `min_block` being zero (no buffer)
const block_size : u16 = @min (rem_bytes , max_tokens );
rem_bytes -= block_size ;
// Count frequencies
comptime assert (max_tokens != 65535 );
var freqs : [257 ]u16 = @splat (0 );
freqs [256 ] = 1 ;
const start_splat = rem_splat ;
const start_data = rem_data ;
const start_data_elem = rem_data_elem ;
var block_limit : Io .Limit = .limited (block_size );
while (true ) {
const bytes = block_limit .sliceConst (rem_data_elem );
const is_pattern = rem_splat != splat and bytes .len == pattern .len ;
const mul = if (!is_pattern ) 1 else @backingInt (block_limit ) / pattern .len ;
assert (mul != 0 );
if (is_pattern ) assert (mul <= rem_splat + 1 ); // one more for `rem_data`
for (bytes ) |b | freqs [b ] += @intCast (mul );
rem_data_elem = rem_data_elem [bytes .len ..];
block_limit = block_limit .subtract (bytes .len * mul ).?;
if (rem_data_elem .len == 0 ) {
rem_data_elem = rem_data [0 ];
if (rem_data .len != 1 ) {
rem_data = rem_data [1 ..];
} else if (rem_splat >= mul ) {
// if the counter was not the pattern, `mul` is always one, otherwise,
// `mul` contains `rem_data`, however one more needs subtracted anyways
// since the next pattern is also being taken.
rem_splat -= mul ;
} else {
// All of `data` has been consumed.
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_data = undefined ;
rem_data_elem = undefined ;
rem_splat = undefined ;
}
}
if (block_limit == .nothing ) break ;
}
// Output block
rem_splat = start_splat ;
rem_data = start_data ;
rem_data_elem = start_data_elem ;
block_limit = .limited (block_size );
var codes_buf : CodesBuf = .init ;
if (try h .outputHeader (&freqs , &codes_buf , block_size , false )) |table | {
while (true ) {
const bytes = block_limit .sliceConst (rem_data_elem );
rem_data_elem = rem_data_elem [bytes .len ..];
block_limit = block_limit .subtract (bytes .len ).?;
h .hasher .update (bytes );
for (bytes ) |b | {
try h .bit_writer .write (table .codes [b ], table .bits [b ]);
}
if (rem_data_elem .len == 0 ) {
rem_data_elem = rem_data [0 ];
if (rem_data .len != 1 ) {
rem_data = rem_data [1 ..];
} else if (rem_splat != 0 ) {
rem_splat -= 1 ;
} else {
// All of `data` has been consumed.
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_data = undefined ;
rem_data_elem = undefined ;
rem_splat = undefined ;
}
}
if (block_limit == .nothing ) break ;
}
try h .bit_writer .write (table .codes [256 ], table .bits [256 ]);
} else while (true ) {
// Store block
// Write data that is not a full vector element
const in_pattern = rem_splat != splat ;
const vec_elem_i , const in_data =
@subWithOverflow (data .len - (rem_data .len - @intFromBool (in_pattern )), 1 );
const is_elem = in_data == 0 and data [vec_elem_i ].len == rem_data_elem .len ;
if (!is_elem or rem_data_elem .len > @backingInt (block_limit )) {
block_limit = block_limit .subtract (rem_data_elem .len ) orelse {
try h .bit_writer .output .writeAll (rem_data_elem [0 ..@backingInt (block_limit )]);
h .hasher .update (rem_data_elem [0 ..@backingInt (block_limit )]);
rem_data_elem = rem_data_elem [@backingInt (block_limit )..];
assert (rem_data_elem .len != 0 );
break ;
};
try h .bit_writer .output .writeAll (rem_data_elem );
h .hasher .update (rem_data_elem );
} else {
// Put `rem_data_elem` back in `rem_data`
if (!in_pattern ) {
rem_data = data [vec_elem_i ..];
} else {
rem_splat += 1 ;
}
}
rem_data_elem = undefined ; // it is always updated below
// Send through as much of the original vector as possible
var vec_n : usize = 0 ;
var vlimit = block_limit ;
const vec_splat = while (rem_data [vec_n ..].len != 1 ) {
vlimit = vlimit .subtract (rem_data [vec_n ].len ) orelse break 1 ;
vec_n += 1 ;
} else vec_splat : {
// For `pattern.len == 0`, the value of `vec_splat` does not matter.
const vec_splat = @backingInt (vlimit ) / @max (1 , pattern .len );
if (pattern .len != 0 ) assert (vec_splat <= rem_splat + 1 );
vlimit = vlimit .subtract (pattern .len * vec_splat ).?;
vec_n += 1 ;
break :vec_splat vec_splat ;
};
const n = if (vec_n != 0 ) n : {
assert (@backingInt (block_limit ) - @backingInt (vlimit ) ==
Writer .countSplat (rem_data [0 ..vec_n ], vec_splat ));
break :n try h .bit_writer .output .writeSplat (rem_data [0 ..vec_n ], vec_splat );
} else 0 ; // Still go into the case below to advance the vector
block_limit = block_limit .subtract (n ).?;
var consumed : Io .Limit = .limited (n );
while (rem_data .len != 1 ) {
const elem = rem_data [0 ];
rem_data = rem_data [1 ..];
consumed = consumed .subtract (elem .len ) orelse {
h .hasher .update (elem [0 ..@backingInt (consumed )]);
rem_data_elem = elem [@backingInt (consumed )..];
break ;
};
h .hasher .update (elem );
} else {
if (pattern .len == 0 ) {
// All of `data` has been consumed. However, the general
// case below does not work since it divides by zero.
assert (consumed == .nothing );
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_splat = undefined ;
rem_data = undefined ;
rem_data_elem = undefined ;
break ;
}
const splatted = @backingInt (consumed ) / pattern .len ;
const partial = @backingInt (consumed ) % pattern .len ;
for (0 ..splatted ) |_ | h .hasher .update (pattern );
h .hasher .update (pattern [0 ..partial ]);
const taken_splat = splatted + 1 ;
if (rem_splat >= taken_splat ) {
rem_splat -= taken_splat ;
rem_data_elem = pattern [partial ..];
} else {
// All of `data` has been consumed.
assert (partial == 0 );
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_data = undefined ;
rem_data_elem = undefined ;
rem_splat = undefined ;
}
}
if (block_limit == .nothing ) break ;
}
}
if (rem_bytes > data_bytes ) {
assert (rem_bytes - data_bytes == rem_data_elem .len );
assert (&rem_data_elem [0 ] == &w .buffer [total_bytes - rem_bytes ]);
}
return w .consume (total_bytes - rem_bytes );
}