lint_couponposoffer.c File Reference

Purpose

The couponposoffer linter ensures that the data conforms to the modernised North American positive offer file coupon code standard, as carried in AI (8112).

Remarks

Refer to the document "GS1 AI (8112) Coupon Data Specification" for a description of the positive offer file coupon code data contents.

Functional Description

gs1_lint_couponposoffer()

GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_couponposoffer	(	const char *const	data,
		size_t	data_len,
		size_t *const	err_pos,
		size_t *const	err_len
	)

Used to ensure that an AI component conforms to the modernised North American positive offer file coupon code standard, as carried in AI (8112).

Parameters

[in]	data	Pointer to the data to be linted. Must not be NULL.
[in]	data_len	Length of the data to be linted.
[out]	err_pos	To facilitate error highlighting, the start position of the bad data is written to this pointer, if not NULL.
[out]	err_len	The length of the bad data is written to this pointer, if not NULL.

Returns

GS1_LINTER_OK if okay.

GS1_LINTER_COUPON_MISSING_FORMAT_CODE if the data is missing a Format Code.

GS1_LINTER_COUPON_INVALID_FORMAT_CODE if the data contains an invalid Format Code, neither "0" or "1".

GS1_LINTER_COUPON_MISSING_FUNDER_VLI if the data is missing a Funder ID length indicator.

GS1_LINTER_COUPON_INVALID_FUNDER_LENGTH if the data contains a Funder ID length indicator that is not within the range "0" to "6".

GS1_LINTER_COUPON_TRUNCATED_FUNDER if the data contains a Funder ID is that is shorter than specified by its length indicator.

GS1_LINTER_COUPON_TRUNCATED_OFFER_CODE if the data contains an Offer Code that is shorter than six digits.

GS1_LINTER_COUPON_MISSING_SERIAL_NUMBER_VLI if the data is missing a Serial Number length indicator.

GS1_LINTER_COUPON_TRUNCATED_SERIAL_NUMBER if the data contains a Serial Number that is shorter than specified by its length indicator.

GS1_LINTER_COUPON_EXCESS_DATA if the data contains excess data following the Serial Number.

{
 
        size_t pos;
        int vli;
        const char *p, *q;
 
        assert(data);
 
 
        /*
         * Data must consist of all digits.
         *
         */
        for (pos = 0; pos < data_len; pos++) {
                if (GS1_LINTER_UNLIKELY(data[pos] < '0' || data[pos] > '9'))
                        GS1_LINTER_RETURN_ERROR(
                                GS1_LINTER_NON_DIGIT_CHARACTER,
                                pos,
                                1
                        );
        }
 
        p = data;
        q = data + data_len;
 
 
        /*
         * Validate the Format ID.
         *
         * Valid Format IDs are "0" and "1".
         *
         */
        if (GS1_LINTER_UNLIKELY(p == q))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_MISSING_FORMAT_CODE,
                        0,
                        (size_t)(q - data)
                );
 
        if (GS1_LINTER_UNLIKELY(*p != '0' && *p != '1'))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_INVALID_FORMAT_CODE,
                        (size_t)(p - data),
                        1
                );
 
 
        /*
         * Validate the Funder VLI is in the range "0" to "6" and that the
         * following Funder ID has the corresponding length (plus 6).
         *
         */
        if (GS1_LINTER_UNLIKELY(++p == q))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_MISSING_FUNDER_VLI,
                        0,
                        (size_t)(q - data)
                );
        if (GS1_LINTER_UNLIKELY(*p > '6'))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_INVALID_FUNDER_LENGTH,
                        (size_t)(p - data),
                        1
                );
        vli = *p - '0' + 6;
 
        if (GS1_LINTER_UNLIKELY(q - ++p < vli))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_TRUNCATED_FUNDER,
                        (p == q) ? 0                  : (size_t)(p - data),
                        (p == q) ? (size_t)(q - data) : (size_t)(q - p)
                );
 
        p += vli;
 
 
        /*
         * Validate the existence of the six digit Offer Code.
         *
         */
        if (GS1_LINTER_UNLIKELY(q - p < 6))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_TRUNCATED_OFFER_CODE,
                        (p == q) ? 0                  : (size_t)(p - data),
                        (p == q) ? (size_t)(q - data) : (size_t)(q - p)
                );
 
        p += 6;
 
 
        /*
         * Validate that the Serial Number follows its VLI and has the
         * corresponding length (plus 6).
         *
         */
        if (GS1_LINTER_UNLIKELY(p == q))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_MISSING_SERIAL_NUMBER_VLI,
                        0,
                        (size_t)(q - data)
                );
        vli = *p - '0' + 6;
 
        if (GS1_LINTER_UNLIKELY(q - ++p < vli))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_TRUNCATED_SERIAL_NUMBER,
                        (p == q) ? 0                  : (size_t)(p - data),
                        (p == q) ? (size_t)(q - data) : (size_t)(q - p)
                );
 
        p += vli;
 
 
        /*
         * Report any excess data that follows the Serial Number.
         *
         */
        if (GS1_LINTER_UNLIKELY(p != q))
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_COUPON_EXCESS_DATA,
                        (size_t)(p - data),
                        (size_t)(q - p)
                );
 
        GS1_LINTER_RETURN_OK;
 
}