lint_mediatype.c File Reference

Purpose

The mediatype linter ensures that the data represents a valid AIDC media type.

Remarks

The two-digit AIDC media type codes are defined in the GS1 General Specifications table "AIDC media type values".

Functional Description

gs1_lint_mediatype()

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

Used to validate that an AI component is a valid AIDC media type.

Note

To enable this linter to hook into an alternative AIDC media type lookup function (provided by the user) the GS1_LINTER_CUSTOM_MEDIA_TYPE_LOOKUP_H macro may be set to the name of a header file to be included that defines a custom GS1_LINTER_CUSTOM_MEDIA_TYPE_LOOKUP macro.

If provided, the GS1_LINTER_CUSTOM_MEDIA_TYPE_LOOKUP macro shall invoke whatever functionality is available in the user-provided lookup function, then using the result must assign to a locally-scoped variable as follows:

• valid: Set to 1 if the lookup was successful. Otherwise 0.

Parameters

[in]	data	Pointer to the null-terminated data to be linted. Must not be NULL.
[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_INVALID_MEDIA_TYPE if the data is not a num-3 country code.

{
 
        /*
         * Allow for a custom replacement of the lookup code to be provided.
         *
         */
#ifdef GS1_LINTER_CUSTOM_MEDIA_TYPE_LOOKUP
#define GS1_LINTER_MEDIA_TYPE_LOOKUP(cc) GS1_LINTER_CUSTOM_MEDIA_TYPE_LOOKUP(cc)
#else
 
        /*
         *  Set of valid AIDC media type values
         *
         *  MAINTENANCE NOTE:
         *
         *  Updates to the AIDC media type list shall be announced by GSCN
         *
         */
        static const uint8_t mediatypes[] = {
#if __STDC_VERSION__ >= 202311L
                0b01111111, 0b11100000,         // 00:    Not used
                                                // 01-10: ICCBBA assignments
                                                // 11-15: Reserved for future assignment by ICCBBA
                0b00000000, 0b00000000,         // 16-29: Reserved for future assignment by ICCBBA
                                                // 30-31: Reserved for future assignment by GS1
                0b00000000, 0b00000000,         // 32-47: Reserved for future assignment by GS1
                0b00000000, 0b00000000,         // 48-59: Reserved for future assignment by GS1
                                                // 60-63: Reserved for future assignment by ICCBBA or GS1
                0b00000000, 0b00000000,         // 64-79: Reserved for future assignment by ICCBBA or GS1
                0b11111111, 0b11111111,         // 80-95: ICCBBA local / national use
                0b11110000,                     // 96-99: ICCBBA local / national use
#else
                /*
                 *  Fallback for compilers lacking binary literal support.
                 *
                 *  Generated from the above data with:
                 *
                 *     for (size_t i = 0; i < sizeof(mediatypes) / sizeof(mediatypes[0]); i++) { printf("0x%02x, ", mediatypes[i]); };
                 *
                 */
                0x7f, 0xe0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xf0,
#endif
        };
 
/// \cond
#define GS1_LINTER_MEDIA_TYPE_LOOKUP(cc) do {                                   \
        if (strlen(cc) == 2 && isdigit(cc[0]) && isdigit(cc[1])) {              \
                int v = (cc[0] - '0') * 10 + (cc[1] - '0');                     \
                GS1_LINTER_BITFIELD_LOOKUP(v, mediatypes);                      \
        }                                                                       \
} while (0)
/// \endcond
 
#endif
 
        int valid = 0;
 
        assert(data);
 
        /*
         * Ensure that the data is in the list.
         *
         */
        GS1_LINTER_MEDIA_TYPE_LOOKUP(data);
        if (valid)
                GS1_LINTER_RETURN_OK;
 
        /*
         * If not valid then indicate an error.
         *
         */
        GS1_LINTER_RETURN_ERROR(
                GS1_LINTER_INVALID_MEDIA_TYPE,
                0,
                strlen(data)
        );
 
}