From dfc4049932e373ec0754c0d6933c8a1e316a0061 Mon Sep 17 00:00:00 2001 From: gitlost Date: Fri, 24 Nov 2023 18:04:33 +0000 Subject: [PATCH] API: add `ZBarcode_Reset()` to clear and restore `zint_symbol` to its default state library: fix dealing with ZINT_WARN_HRT_TRUNCATED in `error_tag()` when `WARN_FAIL_ALL` set --- ChangeLog | 1 + backend/library.c | 41 ++++++-- backend/tests/test_library.c | 178 +++++++++++++++++++++++++++++++++-- backend/zint.h | 3 + backend_qt/qzint.cpp | 2 +- docs/manual.html | 4 +- docs/manual.pmd | 3 +- docs/manual.txt | 3 +- 8 files changed, 215 insertions(+), 20 deletions(-) diff --git a/ChangeLog b/ChangeLog index c3a3015e..9de508ad 100644 --- a/ChangeLog +++ b/ChangeLog @@ -88,6 +88,7 @@ Changes - man page: list size detail for matrix symbols (`--vers`) - CODE11/C25XXX/CODE39/EXCODE39/HIBC_39/CODE93/CODABAR/PLESSEY/MSI_PLESSEY/FLAT/ DAFT/TELEPEN/TELEPEN_NUM: increase allowed lengths +- API: add `ZBarcode_Reset()` to fully restore `zint_symbol` to default state Bugs ---- diff --git a/backend/library.c b/backend/library.c index e8cfddf6..15eef0b7 100644 --- a/backend/library.c +++ b/backend/library.c @@ -50,12 +50,8 @@ typedef char static_assert_int32_is_32bits[sizeof(int32_t) * CHAR_BIT != 32 ? -1 typedef char static_assert_uint32_is_32bits[sizeof(uint32_t) * CHAR_BIT != 32 ? -1 : 1]; typedef char static_assert_uint64_at_least_64bits[sizeof(uint64_t) * CHAR_BIT < 64 ? -1 : 1]; -/* Create and initialize a symbol structure */ -struct zint_symbol *ZBarcode_Create(void) { - struct zint_symbol *symbol; - - symbol = (struct zint_symbol *) calloc(1, sizeof(*symbol)); - if (!symbol) return NULL; +/* Set `symbol` to defaults (does not zeroize) */ +static void set_symbol_defaults(struct zint_symbol *symbol) { symbol->symbology = BARCODE_CODE128; symbol->scale = 1.0f; @@ -79,6 +75,16 @@ struct zint_symbol *ZBarcode_Create(void) { symbol->bitmap = NULL; symbol->alphamap = NULL; symbol->vector = NULL; +} + +/* Create and initialize a symbol structure */ +struct zint_symbol *ZBarcode_Create(void) { + struct zint_symbol *symbol; + + symbol = (struct zint_symbol *) calloc(1, sizeof(*symbol)); + if (!symbol) return NULL; + + set_symbol_defaults(symbol); return symbol; } @@ -114,6 +120,22 @@ void ZBarcode_Clear(struct zint_symbol *symbol) { vector_free(symbol); } +/* Free any output buffers that may have been created and reset all fields to defaults */ +void ZBarcode_Reset(struct zint_symbol *symbol) { + if (!symbol) return; + + if (symbol->bitmap != NULL) { + free(symbol->bitmap); + } + if (symbol->alphamap != NULL) { + free(symbol->alphamap); + } + vector_free(symbol); + + memset(symbol, 0, sizeof(*symbol)); + set_symbol_defaults(symbol); +} + /* Free a symbol structure, including any output buffers */ void ZBarcode_Delete(struct zint_symbol *symbol) { if (!symbol) return; @@ -225,8 +247,13 @@ static int error_tag(struct zint_symbol *symbol, int error_number, const char *e error_number = ZINT_ERROR_NONCOMPLIANT; } else if (error_number == ZINT_WARN_USES_ECI) { error_number = ZINT_ERROR_USES_ECI; - } else { /* ZINT_WARN_INVALID_OPTION */ + } else if (error_number == ZINT_WARN_INVALID_OPTION) { error_number = ZINT_ERROR_INVALID_OPTION; + } else if (error_number == ZINT_WARN_HRT_TRUNCATED) { + error_number = ZINT_ERROR_HRT_TRUNCATED; + } else { /* Shouldn't happen */ + assert(0); /* Not reached */ + error_number = ZINT_ERROR_ENCODING_PROBLEM; } } if (error_number >= ZINT_ERROR) { diff --git a/backend/tests/test_library.c b/backend/tests/test_library.c index b1446117..112407d1 100644 --- a/backend/tests/test_library.c +++ b/backend/tests/test_library.c @@ -1081,6 +1081,7 @@ static void test_bad_args(const testCtx *const p_ctx) { /* These just return, no error */ ZBarcode_Clear(NULL); + ZBarcode_Reset(NULL); ZBarcode_Delete(NULL); ret = ZBarcode_Version(); @@ -1252,15 +1253,17 @@ static void test_error_tag(const testCtx *const p_ctx) { /* 3*/ { ZINT_WARN_USES_ECI, WARN_FAIL_ALL, "", ZINT_ERROR_USES_ECI, "Error " }, /* 4*/ { ZINT_WARN_NONCOMPLIANT, -1, "", ZINT_WARN_NONCOMPLIANT, "Warning " }, /* 5*/ { ZINT_WARN_NONCOMPLIANT, WARN_FAIL_ALL, "", ZINT_ERROR_NONCOMPLIANT, "Error " }, - /* 6*/ { ZINT_ERROR_TOO_LONG, WARN_DEFAULT, "", ZINT_ERROR_TOO_LONG, "Error " }, - /* 7*/ { ZINT_ERROR_TOO_LONG, WARN_FAIL_ALL, "", ZINT_ERROR_TOO_LONG, "Error " }, - /* 8*/ { ZINT_WARN_USES_ECI, -1, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_WARN_USES_ECI, "Warning 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901" }, - /* 9*/ { ZINT_WARN_USES_ECI, WARN_FAIL_ALL, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_USES_ECI, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, - /* 10*/ { ZINT_ERROR_INVALID_DATA, -1, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, - /* 11*/ { ZINT_ERROR_INVALID_DATA, WARN_FAIL_ALL, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, - /* 12*/ { ZINT_WARN_USES_ECI, -1, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_WARN_USES_ECI, "Warning 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901" }, - /* 13*/ { ZINT_WARN_USES_ECI, WARN_FAIL_ALL, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_ERROR_USES_ECI, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, - /* 14*/ { ZINT_ERROR_INVALID_DATA, -1, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, + /* 6*/ { ZINT_WARN_HRT_TRUNCATED, -1, "", ZINT_WARN_HRT_TRUNCATED, "Warning " }, + /* 7*/ { ZINT_WARN_HRT_TRUNCATED, WARN_FAIL_ALL, "", ZINT_ERROR_HRT_TRUNCATED, "Error " }, + /* 8*/ { ZINT_ERROR_TOO_LONG, WARN_DEFAULT, "", ZINT_ERROR_TOO_LONG, "Error " }, + /* 9*/ { ZINT_ERROR_TOO_LONG, WARN_FAIL_ALL, "", ZINT_ERROR_TOO_LONG, "Error " }, + /* 10*/ { ZINT_WARN_USES_ECI, -1, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_WARN_USES_ECI, "Warning 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901" }, + /* 11*/ { ZINT_WARN_USES_ECI, WARN_FAIL_ALL, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_USES_ECI, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, + /* 12*/ { ZINT_ERROR_INVALID_DATA, -1, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, + /* 13*/ { ZINT_ERROR_INVALID_DATA, WARN_FAIL_ALL, "123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, + /* 14*/ { ZINT_WARN_USES_ECI, -1, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_WARN_USES_ECI, "Warning 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901" }, + /* 15*/ { ZINT_WARN_USES_ECI, WARN_FAIL_ALL, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_ERROR_USES_ECI, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, + /* 16*/ { ZINT_ERROR_INVALID_DATA, -1, "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890", ZINT_ERROR_INVALID_DATA, "Error 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123" }, }; int data_size = ARRAY_SIZE(data); int i, ret; @@ -1443,6 +1446,162 @@ static void test_clear(const testCtx *const p_ctx) { testFinish(); } +/* Helper to set various `zint_symbol` fields */ +static void set_symbol_fields(struct zint_symbol *symbol) { + symbol->symbology = BARCODE_MAXICODE; + symbol->height = 2.3f; + symbol->scale = 1.1f; + symbol->whitespace_width = 5; + symbol->whitespace_height = 5; + symbol->border_width = 2; + symbol->output_options = BARCODE_BOX; + strcpy(symbol->fgcolour, "000000AA"); + strcpy(symbol->bgcolour, "FFFFFFAA"); + strcpy(symbol->outfile, "gosh.png"); + strcpy(symbol->primary, "1234567"); + symbol->option_1 = 2; + symbol->option_2 = 3; + symbol->option_3 = 4; + symbol->show_hrt = 0; + symbol->input_mode = UNICODE_MODE | ESCAPE_MODE; + symbol->eci = 3; + symbol->dpmm = 24.0f; + symbol->dot_size = 1.6f; + symbol->text_gap = 0.5f; + symbol->guard_descent = 4.5f; + symbol->structapp.index = 1; + symbol->structapp.count = 2; + /*strcpy(symbol->structapp.id, "ID1");*/ /* Not available for MAXICODE */ + symbol->warn_level = WARN_FAIL_ALL; +} + +static void test_reset(const testCtx *const p_ctx) { + + int ret; + struct zint_symbol *symbol; + struct zint_symbol *symbol_def; + char *data = "1234"; + + (void)p_ctx; + + testStart("test_reset"); + + symbol_def = ZBarcode_Create(); + assert_nonnull(symbol_def, "Default symbol not created\n"); + + symbol = ZBarcode_Create(); + assert_nonnull(symbol, "Symbol not created\n"); + + set_symbol_fields(symbol); + + /* Raster */ + + ret = ZBarcode_Encode(symbol, TU(data), 0); + assert_zero(ret, "ZBarcode_Encode() ret %d != 0 (%s)\n", ret, symbol->errtxt); + + assert_nonzero(symbol->rows, "ZBarcode_Encode() rows 0\n"); + assert_nonzero(symbol->width, "ZBarcode_Encode() width 0\n"); + + ret = ZBarcode_Buffer(symbol, 0); + assert_zero(ret, "ZBarcode_Buffer() ret %d != 0 (%s)\n", ret, symbol->errtxt); + + assert_nonnull(symbol->bitmap, "ZBarcode_Buffer() bitmap NULL\n"); + assert_nonnull(symbol->alphamap, "ZBarcode_Buffer() alphamap NULL\n"); + assert_nonzero(symbol->bitmap_width, "ZBarcode_Buffer() bitmap_width 0\n"); + assert_nonzero(symbol->bitmap_height, "ZBarcode_Buffer() bitmap_height 0\n"); + + assert_nonzero(symbol->rows, "ZBarcode_Buffer() rows 0\n"); + assert_nonzero(symbol->width, "ZBarcode_Buffer() width 0\n"); + assert_null(symbol->vector, "ZBarcode_Buffer() vector != NULL\n"); + + ZBarcode_Reset(symbol); + + assert_nonzero(symbol->symbology == symbol_def->symbology, "ZBarcodeBuffer symbology != symbol_def\n"); + assert_nonzero(symbol->height == symbol_def->height, "ZBarcodeBuffer height != symbol_def\n"); + assert_nonzero(symbol->scale == symbol_def->scale, "ZBarcodeBuffer scale != symbol_def\n"); + assert_nonzero(symbol->whitespace_width == symbol_def->whitespace_width, "ZBarcodeBuffer whitespace_width != symbol_def\n"); + assert_nonzero(symbol->whitespace_height == symbol_def->whitespace_height, "ZBarcodeBuffer whitespace_height != symbol_def\n"); + assert_nonzero(symbol->border_width == symbol_def->border_width, "ZBarcodeBuffer border_width != symbol_def\n"); + assert_nonzero(symbol->output_options == symbol_def->output_options, "ZBarcodeBuffer output_options != symbol_def\n"); + assert_zero(strcmp(symbol->fgcolour, symbol_def->fgcolour), "ZBarcodeBuffer fgcolour != symbol_def\n"); + assert_zero(strcmp(symbol->bgcolour, symbol_def->bgcolour), "ZBarcodeBuffer bgcolour != symbol_def\n"); + assert_zero(strcmp(symbol->fgcolor, symbol_def->fgcolor), "ZBarcodeBuffer fgcolor != symbol_def\n"); + assert_zero(strcmp(symbol->bgcolor, symbol_def->bgcolor), "ZBarcodeBuffer bgcolor != symbol_def\n"); + assert_zero(strcmp(symbol->outfile, symbol_def->outfile), "ZBarcodeBuffer outfile != symbol_def\n"); + assert_zero(strcmp(symbol->primary, symbol_def->primary), "ZBarcodeBuffer primary != symbol_def\n"); + assert_nonzero(symbol->option_1 == symbol_def->option_1, "ZBarcodeBuffer option_1 != symbol_def\n"); + assert_nonzero(symbol->option_2 == symbol_def->option_2, "ZBarcodeBuffer option_2 != symbol_def\n"); + assert_nonzero(symbol->option_3 == symbol_def->option_3, "ZBarcodeBuffer option_3 != symbol_def\n"); + assert_nonzero(symbol->show_hrt == symbol_def->show_hrt, "ZBarcodeBuffer show_hrt != symbol_def\n"); + assert_nonzero(symbol->input_mode == symbol_def->input_mode, "ZBarcodeBuffer input_mode != symbol_def\n"); + assert_nonzero(symbol->eci == symbol_def->eci, "ZBarcodeBuffer eci != symbol_def\n"); + assert_nonzero(symbol->dpmm == symbol_def->dpmm, "ZBarcodeBuffer dpmm != symbol_def\n"); + assert_nonzero(symbol->dot_size == symbol_def->dot_size, "ZBarcodeBuffer dot_size != symbol_def\n"); + assert_nonzero(symbol->text_gap == symbol_def->text_gap, "ZBarcodeBuffer text_gap != symbol_def\n"); + assert_nonzero(symbol->guard_descent == symbol_def->guard_descent, "ZBarcodeBuffer guard_descent != symbol_def\n"); + assert_nonzero(symbol->structapp.index == symbol_def->structapp.index, "ZBarcodeBuffer structapp.index != symbol_def\n"); + assert_nonzero(symbol->structapp.count == symbol_def->structapp.count, "ZBarcodeBuffer structapp.count != symbol_def\n"); + assert_nonzero(symbol->warn_level == symbol_def->warn_level, "ZBarcodeBuffer warn_level != symbol_def\n"); + + /* Vector */ + + set_symbol_fields(symbol); + + ret = ZBarcode_Encode(symbol, TU(data), 0); + assert_zero(ret, "ZBarcode_Encode() ret %d != 0 (%s)\n", ret, symbol->errtxt); + + assert_nonzero(symbol->rows, "ZBarcode_Encode() rows 0\n"); + assert_nonzero(symbol->width, "ZBarcode_Encode() width 0\n"); + + ret = ZBarcode_Buffer_Vector(symbol, 0); + assert_zero(ret, "ZBarcode_Buffer_Vector() ret %d != 0 (%s)\n", ret, symbol->errtxt); + + assert_nonnull(symbol->vector, "ZBarcode_Buffer_Vector() vector NULL\n"); + assert_nonnull(symbol->vector->rectangles, "ZBarcode_Buffer_Vector() vector->rectangles NULL\n"); + assert_nonnull(symbol->vector->hexagons, "ZBarcode_Buffer_Vector() vector->hexagons NULL\n"); + assert_null(symbol->vector->strings, "ZBarcode_Buffer_Vector() vector->strings != NULL\n"); /* MAXICODE no text */ + assert_nonnull(symbol->vector->circles, "ZBarcode_Buffer_Vector() vector->circles NULL\n"); + + assert_nonzero(symbol->rows, "ZBarcode_Buffer_Vector() rows 0\n"); + assert_nonzero(symbol->width, "ZBarcode_Buffer_Vector() width 0\n"); + assert_null(symbol->bitmap, "ZBarcode_Buffer_Vector() bitmap != NULL\n"); + assert_null(symbol->alphamap, "ZBarcode_Buffer_Vector() alphamap != NULL\n"); + + ZBarcode_Reset(symbol); + + assert_nonzero(symbol->symbology == symbol_def->symbology, "ZBarcodeBuffer symbology != symbol_def\n"); + assert_nonzero(symbol->height == symbol_def->height, "ZBarcodeBuffer height != symbol_def\n"); + assert_nonzero(symbol->scale == symbol_def->scale, "ZBarcodeBuffer scale != symbol_def\n"); + assert_nonzero(symbol->whitespace_width == symbol_def->whitespace_width, "ZBarcodeBuffer whitespace_width != symbol_def\n"); + assert_nonzero(symbol->whitespace_height == symbol_def->whitespace_height, "ZBarcodeBuffer whitespace_height != symbol_def\n"); + assert_nonzero(symbol->border_width == symbol_def->border_width, "ZBarcodeBuffer border_width != symbol_def\n"); + assert_nonzero(symbol->output_options == symbol_def->output_options, "ZBarcodeBuffer output_options != symbol_def\n"); + assert_zero(strcmp(symbol->fgcolour, symbol_def->fgcolour), "ZBarcodeBuffer fgcolour != symbol_def\n"); + assert_zero(strcmp(symbol->bgcolour, symbol_def->bgcolour), "ZBarcodeBuffer bgcolour != symbol_def\n"); + assert_zero(strcmp(symbol->fgcolor, symbol_def->fgcolor), "ZBarcodeBuffer fgcolor != symbol_def\n"); + assert_zero(strcmp(symbol->bgcolor, symbol_def->bgcolor), "ZBarcodeBuffer bgcolor != symbol_def\n"); + assert_zero(strcmp(symbol->outfile, symbol_def->outfile), "ZBarcodeBuffer outfile != symbol_def\n"); + assert_zero(strcmp(symbol->primary, symbol_def->primary), "ZBarcodeBuffer primary != symbol_def\n"); + assert_nonzero(symbol->option_1 == symbol_def->option_1, "ZBarcodeBuffer option_1 != symbol_def\n"); + assert_nonzero(symbol->option_2 == symbol_def->option_2, "ZBarcodeBuffer option_2 != symbol_def\n"); + assert_nonzero(symbol->option_3 == symbol_def->option_3, "ZBarcodeBuffer option_3 != symbol_def\n"); + assert_nonzero(symbol->show_hrt == symbol_def->show_hrt, "ZBarcodeBuffer show_hrt != symbol_def\n"); + assert_nonzero(symbol->input_mode == symbol_def->input_mode, "ZBarcodeBuffer input_mode != symbol_def\n"); + assert_nonzero(symbol->eci == symbol_def->eci, "ZBarcodeBuffer eci != symbol_def\n"); + assert_nonzero(symbol->dpmm == symbol_def->dpmm, "ZBarcodeBuffer dpmm != symbol_def\n"); + assert_nonzero(symbol->dot_size == symbol_def->dot_size, "ZBarcodeBuffer dot_size != symbol_def\n"); + assert_nonzero(symbol->text_gap == symbol_def->text_gap, "ZBarcodeBuffer text_gap != symbol_def\n"); + assert_nonzero(symbol->guard_descent == symbol_def->guard_descent, "ZBarcodeBuffer guard_descent != symbol_def\n"); + assert_nonzero(symbol->structapp.index == symbol_def->structapp.index, "ZBarcodeBuffer structapp.index != symbol_def\n"); + assert_nonzero(symbol->structapp.count == symbol_def->structapp.count, "ZBarcodeBuffer structapp.count != symbol_def\n"); + assert_nonzero(symbol->warn_level == symbol_def->warn_level, "ZBarcodeBuffer warn_level != symbol_def\n"); + + ZBarcode_Delete(symbol); + ZBarcode_Delete(symbol_def); + + testFinish(); +} + static void test_scale_from_xdimdp(const testCtx *const p_ctx) { struct item { @@ -1665,6 +1824,7 @@ int main(int argc, char *argv[]) { { "test_strip_bom", test_strip_bom }, { "test_zero_outfile", test_zero_outfile }, { "test_clear", test_clear }, + { "test_reset", test_reset }, { "test_scale_from_xdimdp", test_scale_from_xdimdp }, { "test_xdimdp_from_scale", test_xdimdp_from_scale }, }; diff --git a/backend/zint.h b/backend/zint.h index 6b61fabe..a564fe59 100644 --- a/backend/zint.h +++ b/backend/zint.h @@ -386,6 +386,9 @@ extern "C" { /* Free any output buffers that may have been created and initialize output fields */ ZINT_EXTERN void ZBarcode_Clear(struct zint_symbol *symbol); + /* Free any output buffers that may have been created and reset all fields to defaults */ + ZINT_EXTERN void ZBarcode_Reset(struct zint_symbol *symbol); + /* Free a symbol structure, including any output buffers */ ZINT_EXTERN void ZBarcode_Delete(struct zint_symbol *symbol); diff --git a/backend_qt/qzint.cpp b/backend_qt/qzint.cpp index 7c4d79fe..6728802d 100644 --- a/backend_qt/qzint.cpp +++ b/backend_qt/qzint.cpp @@ -209,7 +209,7 @@ namespace Zint { m_lastError.clear(); if (m_zintSymbol) { - ZBarcode_Clear(m_zintSymbol); + ZBarcode_Reset(m_zintSymbol); } else if (!(m_zintSymbol = ZBarcode_Create())) { m_error = ZINT_ERROR_MEMORY; m_lastError = QSL("Insufficient memory for Zint structure"); diff --git a/docs/manual.html b/docs/manual.html index a71a6d95..dff59311 100644 --- a/docs/manual.html +++ b/docs/manual.html @@ -3171,7 +3171,9 @@ encoded.

If printing more than one barcode, the zint_symbol structure may be re-used by calling the ZBarcode_Clear() function after each barcode to free any output buffers allocated. The -zint_symbol input members must be reset.

+zint_symbol input members must be reset. To fully restore +zint_symbol to its default state, call +ZBarcode_Reset() instead.

5.4 Buffering Symbols in Memory (raster)

In addition to saving barcode images to file Zint allows you to diff --git a/docs/manual.pmd b/docs/manual.pmd index 175d1fb2..9975f46e 100644 --- a/docs/manual.pmd +++ b/docs/manual.pmd @@ -1747,7 +1747,8 @@ are assumed to be UTF-8 encoded. If printing more than one barcode, the `zint_symbol` structure may be re-used by calling the `ZBarcode_Clear()` function after each barcode to free any output -buffers allocated. The `zint_symbol` input members must be reset. +buffers allocated. The `zint_symbol` input members must be reset. To fully +restore `zint_symbol` to its default state, call `ZBarcode_Reset()` instead. ## 5.4 Buffering Symbols in Memory (raster) diff --git a/docs/manual.txt b/docs/manual.txt index 44b695fc..535fb484 100644 --- a/docs/manual.txt +++ b/docs/manual.txt @@ -1780,7 +1780,8 @@ be UTF-8 encoded. If printing more than one barcode, the zint_symbol structure may be re-used by calling the ZBarcode_Clear() function after each barcode to free any output -buffers allocated. The zint_symbol input members must be reset. +buffers allocated. The zint_symbol input members must be reset. To fully restore +zint_symbol to its default state, call ZBarcode_Reset() instead. 5.4 Buffering Symbols in Memory (raster)