diff --git a/doc/changelog.md b/doc/changelog.md index bf6f0cae..fbb05c26 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -1,6 +1,13 @@ # Changelog +## Work In Progress + +For a *closed* `io_reader`, the standard library now returns `"#truncated +input"` instead of `"$short read"`. Importantly, this is an error, not a +suspension. + + ## 2023-01-26 version 0.3.0 The headline feature is that we have a production quality PNG decoder. It's diff --git a/release/c/wuffs-unsupported-snapshot.c b/release/c/wuffs-unsupported-snapshot.c index 27c69b59..547c368d 100644 --- a/release/c/wuffs-unsupported-snapshot.c +++ b/release/c/wuffs-unsupported-snapshot.c @@ -7843,6 +7843,7 @@ struct wuffs_deflate__decoder__struct { // ---------------- Status Codes extern const char wuffs_lzw__error__bad_code[]; +extern const char wuffs_lzw__error__truncated_input[]; // ---------------- Public Consts @@ -30680,6 +30681,7 @@ wuffs_deflate__decoder__decode_huffman_slow( // ---------------- Status Codes Implementations const char wuffs_lzw__error__bad_code[] = "#lzw: bad code"; +const char wuffs_lzw__error__truncated_input[] = "#lzw: truncated input"; const char wuffs_lzw__error__internal_error_inconsistent_i_o[] = "#lzw: internal error: inconsistent I/O"; // ---------------- Private Consts @@ -30902,6 +30904,9 @@ wuffs_lzw__decoder__transform_io( status = wuffs_base__make_status(wuffs_base__suspension__short_read); WUFFS_BASE__COROUTINE_SUSPENSION_POINT_MAYBE_SUSPEND(2); } else if (self->private_impl.f_read_from_return_value == 3) { + status = wuffs_base__make_status(wuffs_lzw__error__truncated_input); + goto exit; + } else if (self->private_impl.f_read_from_return_value == 4) { status = wuffs_base__make_status(wuffs_lzw__error__bad_code); goto exit; } else { @@ -30977,7 +30982,11 @@ wuffs_lzw__decoder__read_from( iop_a_src += ((31 - v_n_bits) >> 3); v_n_bits |= 24; } else if (((uint64_t)(io2_a_src - iop_a_src)) <= 0) { - self->private_impl.f_read_from_return_value = 2; + if (a_src && a_src->meta.closed) { + self->private_impl.f_read_from_return_value = 3; + } else { + self->private_impl.f_read_from_return_value = 2; + } goto label__0__break; } else { v_bits |= (((uint32_t)(wuffs_base__peek_u8be__no_bounds_check(iop_a_src))) << v_n_bits); @@ -30985,14 +30994,18 @@ wuffs_lzw__decoder__read_from( v_n_bits += 8; if (v_n_bits >= v_width) { } else if (((uint64_t)(io2_a_src - iop_a_src)) <= 0) { - self->private_impl.f_read_from_return_value = 2; + if (a_src && a_src->meta.closed) { + self->private_impl.f_read_from_return_value = 3; + } else { + self->private_impl.f_read_from_return_value = 2; + } goto label__0__break; } else { v_bits |= (((uint32_t)(wuffs_base__peek_u8be__no_bounds_check(iop_a_src))) << v_n_bits); iop_a_src += 1; v_n_bits += 8; if (v_n_bits < v_width) { - self->private_impl.f_read_from_return_value = 4; + self->private_impl.f_read_from_return_value = 5; goto label__0__break; } } @@ -31070,7 +31083,7 @@ wuffs_lzw__decoder__read_from( v_prev_code = v_code; } } else { - self->private_impl.f_read_from_return_value = 3; + self->private_impl.f_read_from_return_value = 4; goto label__0__break; } if (v_output_wi > 4095) { @@ -31085,7 +31098,7 @@ wuffs_lzw__decoder__read_from( if (iop_a_src > io1_a_src) { iop_a_src--; } else { - self->private_impl.f_read_from_return_value = 4; + self->private_impl.f_read_from_return_value = 5; goto label__2__break; } } diff --git a/std/lzw/decode_lzw.wuffs b/std/lzw/decode_lzw.wuffs index b653eb75..b193900f 100644 --- a/std/lzw/decode_lzw.wuffs +++ b/std/lzw/decode_lzw.wuffs @@ -13,6 +13,7 @@ // limitations under the License. pub status "#bad code" +pub status "#truncated input" pri status "#internal error: inconsistent I/O" @@ -119,6 +120,8 @@ pub func decoder.transform_io?(dst: base.io_writer, src: base.io_reader, workbuf } else if this.read_from_return_value == 2 { yield? base."$short read" } else if this.read_from_return_value == 3 { + return "#truncated input" + } else if this.read_from_return_value == 4 { return "#bad code" } else { return "#internal error: inconsistent I/O" @@ -167,7 +170,11 @@ pri func decoder.read_from!(src: base.io_reader) { assert width <= n_bits via "a <= b: a <= c; c <= b"(c: 12) assert n_bits >= width via "a >= b: b <= a"() } else if args.src.length() <= 0 { - this.read_from_return_value = 2 + if args.src.is_closed() { + this.read_from_return_value = 3 + } else { + this.read_from_return_value = 2 + } break } else { bits |= args.src.peek_u8_as_u32() << n_bits @@ -176,7 +183,11 @@ pri func decoder.read_from!(src: base.io_reader) { if n_bits >= width { // No-op. } else if args.src.length() <= 0 { - this.read_from_return_value = 2 + if args.src.is_closed() { + this.read_from_return_value = 3 + } else { + this.read_from_return_value = 2 + } break } else { bits |= args.src.peek_u8_as_u32() << n_bits @@ -188,7 +199,7 @@ pri func decoder.read_from!(src: base.io_reader) { // This if condition is always false, but for some unknown // reason, removing it worsens the benchmarks slightly. if n_bits < width { - this.read_from_return_value = 4 + this.read_from_return_value = 5 break } } @@ -297,7 +308,7 @@ pri func decoder.read_from!(src: base.io_reader) { } } else { - this.read_from_return_value = 3 + this.read_from_return_value = 4 break } @@ -319,7 +330,7 @@ pri func decoder.read_from!(src: base.io_reader) { if args.src.can_undo_byte() { args.src.undo_byte!() } else { - this.read_from_return_value = 4 + this.read_from_return_value = 5 break } } endwhile diff --git a/test/c/std/lzw.c b/test/c/std/lzw.c index 6cfcd31c..a18faaa5 100644 --- a/test/c/std/lzw.c +++ b/test/c/std/lzw.c @@ -79,6 +79,35 @@ test_wuffs_lzw_decode_interface() { "test/data/bricks-nodither.indexes.giflzw", 1, SIZE_MAX, 19200, 0x4F); } +const char* // +test_wuffs_lzw_decode_truncated_input() { + CHECK_FOCUS(__func__); + + wuffs_base__io_buffer have = wuffs_base__ptr_u8__writer(g_have_array_u8, 1); + wuffs_base__io_buffer src = + wuffs_base__ptr_u8__reader(g_src_array_u8, 0, false); + wuffs_lzw__decoder dec; + CHECK_STATUS("initialize", + wuffs_lzw__decoder__initialize( + &dec, sizeof dec, WUFFS_VERSION, + WUFFS_INITIALIZE__LEAVE_INTERNAL_BUFFERS_UNINITIALIZED)); + + wuffs_base__status status = + wuffs_lzw__decoder__transform_io(&dec, &have, &src, g_work_slice_u8); + if (status.repr != wuffs_base__suspension__short_read) { + RETURN_FAIL("closed=false: have \"%s\", want \"%s\"", status.repr, + wuffs_base__suspension__short_read); + } + + src.meta.closed = true; + status = wuffs_lzw__decoder__transform_io(&dec, &have, &src, g_work_slice_u8); + if (status.repr != wuffs_lzw__error__truncated_input) { + RETURN_FAIL("closed=true: have \"%s\", want \"%s\"", status.repr, + wuffs_lzw__error__truncated_input); + } + return NULL; +} + const char* // do_test_wuffs_lzw_decode(const char* src_filename, uint64_t src_size, @@ -444,6 +473,7 @@ proc g_tests[] = { test_wuffs_lzw_decode_output_bad, test_wuffs_lzw_decode_output_empty, test_wuffs_lzw_decode_pi, + test_wuffs_lzw_decode_truncated_input, test_wuffs_lzw_decode_width_0, test_wuffs_lzw_decode_width_1,