Merge branch 'fix/xz_error_callback_arg_type' into 'master'

fix(xz): Fix incorrect argument type of XZ's error callback function

See merge request ae_group/esp-iot-solution!1223

Author: leeebo

components/utilities/xz/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.0.1 - 2025-2-20
+
+### bugfix:
+
+- Fix incorrect prototype of the `error` callback of `xz_decompress`
+
 ## v1.0.0 - 2023-2-10
 
 First release version.

components/utilities/xz/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.0"
+version: "1.0.1"
 description: xz decompression utility
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/utilities/xz
 dependencies:

components/utilities/xz/include/xz_decompress.h

@@ -17,7 +17,7 @@ extern "C" {
  * of the native XZ decoder API. The single-call mode can be used only when
  * both input and output buffers are available as a single chunk, i.e. when
  * fill() and flush() won't be used.
- * 
+ *
  * @param[in]  in pointer to the input buffer to be decompressed
  * @param[in]  in_size size of the input buffer
  * @param[in]  fill pointer to the function used to read compressed data
@@ -34,7 +34,7 @@ int xz_decompress(unsigned char *in, int in_size,
 	int (*fill)(void *dest, unsigned int size),
 	int (*flush)(void *src, unsigned int size),
 	unsigned char *out, int *in_used,
-	void (*error)(char *x));
+	void (*error)(const char *x));
 
 #ifdef __cplusplus
 }

components/utilities/xz/src/xz_decompress.c

@@ -125,7 +125,7 @@ int xz_decompress(unsigned char *in, int in_size,
 	int (*fill)(void *dest, unsigned int size),
 	int (*flush)(void *src, unsigned int size),
 	unsigned char *out, int *in_used,
-	void (*error)(char *x))
+	void (*error)(const char *x))
 {
 	struct xz_buf b;
 	struct xz_dec *s;

examples/utilities/xz_decompress_file/main/xz_decompress_file_example_main.c

@@ -24,7 +24,7 @@ static size_t filled_length;
 
 static const char *TAG = "xz decompress";
 
-static void error(char *msg)
+static void error(const char *msg)
 {
     ESP_LOGE("xz_test", "%s", msg);
 }
@@ -53,7 +53,7 @@ static void test_buf_to_buf(void)
      * Read compressed data from in_buf, and write decompressed data to out_buf.
      * When you can estimate how much data will be extracted, you can use this API like this.
      */
-    int ret = xz_decompress((unsigned char *)xz_compressed_file_start, compressed_file_length, NULL, NULL, (unsigned char *)out_buf, &decompressed_count, error);
+    int ret = xz_decompress((unsigned char *)xz_compressed_file_start, compressed_file_length, NULL, NULL, (unsigned char *)out_buf, &decompressed_count, &error);
     // Display the read contents from the decompressed buf
     ESP_LOGI(TAG, "decompress data:\n%s", out_buf);
     ESP_LOGI(TAG, "ret = %d, decompressed count is %d", ret, decompressed_count);