aaru-dps/Aaru.Compression.Native
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Compression.Native.git synced 2026-11-04 11:15:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Unify external API signatures across all buffer transforms

Browse Source 
Every exported buffer transform now has the same shape:

    int32_t AARU_xxx(const uint8_t *src_buffer, size_t src_size,
                     uint8_t *dst_buffer, size_t *dst_size, ...extras);

On entry *dst_size is the capacity of dst_buffer; on success it holds the
number of bytes written. The return value is 0 (AARU_ERROR_NONE) on success
and non-zero on error, either an AARU_ERROR_* constant or the underlying
library's own error code when it is propagated.

Changes by category:

- Parameter reorder only: all AARU_zip_*, AARU_stuffit*, AARU_dd_*,
  AARU_cpt_*, AARU_lzo_*, AARU_xz_*, AARU_lzma2_*, AARU_kencode_*,
  AARU_apple_lzh_* and ace_decompress_*.
- Byte count return replaced by an out-parameter plus a status code:
  AARU_adc_*, AARU_apple_rle_*, AARU_lz4_*, AARU_lzip_*, AARU_lzfse_*,
  AARU_lzvn_*, AARU_zstd_* and AARU_flac_*. Their algorithm bodies are kept
  as static internals behind a thin exported wrapper.
- Type normalisation: bzip2 uint32_t* -> size_t*, zstd void* -> uint8_t*,
  ZIP PPMd size_t -> size_t*, and int/unsigned char -> int32_t/uint8_t
  throughout the header.
- AARU_lzma_decode_buffer no longer takes src_size as an in/out pointer; the
  consumed length is tracked internally.
- Already conforming decompressors (arc_*, pak_*, ha_*, lha_*, larc_*,
  pmarc_*, arj*, rar*, lh5_decompress) only had their declarations
  normalised.

The streaming LZD context API and AARU_get_acn_version are left alone, as
they are not buffer transforms.

Tests updated to the new call convention; all 78 pass.
This commit is contained in:
Natalia Portillo
2026-08-31 12:26:05 +01:00
parent bbae748612
commit adecbc7c7f
26 changed files with 859 additions and 515 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
tests/kencode.cpp
View File

@@ -87,7 +87,7 @@ TEST_F(KencodeBootFixture, kencode_boot)
auto *outBuf = (uint8_t *)malloc(KC_BOOT_DECOMP_SIZE);
size_t destLen = KC_BOOT_DECOMP_SIZE;
auto err = AARU_kencode_decode_buffer(outBuf, &destLen, kc_boot_buffer, KC_BOOT_COMP_SIZE);
auto err = AARU_kencode_decode_buffer(kc_boot_buffer, KC_BOOT_COMP_SIZE, outBuf, &destLen);
EXPECT_EQ(err, 0);
EXPECT_EQ(destLen, (size_t)KC_BOOT_DECOMP_SIZE);
@@ -115,7 +115,7 @@ TEST_F(KencodeZerosFixture, kencode_zeros)
auto *outBuf = (uint8_t *)malloc(KC_ZEROS_DECOMP_SIZE);
size_t destLen = KC_ZEROS_DECOMP_SIZE;
auto err = AARU_kencode_decode_buffer(outBuf, &destLen, kc_zeros_buffer, KC_ZEROS_COMP_SIZE);
auto err = AARU_kencode_decode_buffer(kc_zeros_buffer, KC_ZEROS_COMP_SIZE, outBuf, &destLen);
EXPECT_EQ(err, 0);
EXPECT_EQ(destLen, (size_t)KC_ZEROS_DECOMP_SIZE);
@@ -143,7 +143,7 @@ TEST_F(KencodeHfsFixture, kencode_hfs)
auto *outBuf = (uint8_t *)malloc(KC_HFS_DECOMP_SIZE);
size_t destLen = KC_HFS_DECOMP_SIZE;
auto err = AARU_kencode_decode_buffer(outBuf, &destLen, kc_hfs_buffer, KC_HFS_COMP_SIZE);
auto err = AARU_kencode_decode_buffer(kc_hfs_buffer, KC_HFS_COMP_SIZE, outBuf, &destLen);
EXPECT_EQ(err, 0);
EXPECT_EQ(destLen, (size_t)KC_HFS_DECOMP_SIZE);
@@ -171,7 +171,7 @@ TEST_F(KencodeLastFixture, kencode_last)
auto *outBuf = (uint8_t *)malloc(KC_LAST_DECOMP_SIZE);
size_t destLen = KC_LAST_DECOMP_SIZE;
auto err = AARU_kencode_decode_buffer(outBuf, &destLen, kc_last_buffer, KC_LAST_COMP_SIZE);
auto err = AARU_kencode_decode_buffer(kc_last_buffer, KC_LAST_COMP_SIZE, outBuf, &destLen);
EXPECT_EQ(err, 0);
EXPECT_EQ(destLen, (size_t)KC_LAST_DECOMP_SIZE);
@@ -199,7 +199,7 @@ TEST_F(KencodeLargeFixture, kencode_large)
auto *outBuf = (uint8_t *)malloc(KC_LARGE_DECOMP_SIZE);
size_t destLen = KC_LARGE_DECOMP_SIZE;
auto err = AARU_kencode_decode_buffer(outBuf, &destLen, kc_large_buffer, KC_LARGE_COMP_SIZE);
auto err = AARU_kencode_decode_buffer(kc_large_buffer, KC_LARGE_COMP_SIZE, outBuf, &destLen);
EXPECT_EQ(err, 0);
EXPECT_EQ(destLen, (size_t)KC_LARGE_DECOMP_SIZE);