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

The default lookup function provided by this linter is a binary search over a static list this is maintained in this file.

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 char mediatypes[][3] = {
                /* 00           Not used */
                "01", "02", "03", "04", "05", "06", "07", "08", "09", "10",     /* ICCBBA assignments */
                /* 11-29        Reserved for future assignment by ICCBBA */
                /* 30-59        Reserved for future assignment by GS1 */
                /* 60-79        Reserved for future assignment by ICCBBA or GS1 */
                "80", "81", "82", "83", "84", "85", "86", "87", "88", "89",     /* ICCBBA local / national use */
                "90", "91", "92", "93", "94", "95", "96", "97", "98", "99",     /* ICCBBA local / national use */
        };
 
        /*
         *  Binary search over the above list.
         *
         */
/// \cond
#define GS1_LINTER_MEDIA_TYPE_LOOKUP(cc) do {                           \
        size_t s = 0;                                                   \
        size_t e = sizeof(mediatypes) / sizeof(mediatypes[0]);          \
        while (s < e) {                                                 \
                const size_t m = s + (e - s) / 2;                       \
                const int cmp = strcmp(mediatypes[m], cc);              \
                if (cmp < 0)                                            \
                        s = m + 1;                                      \
                else if (cmp > 0)                                       \
                        e = m;                                          \
                else {                                                  \
                        valid = 1;                                      \
                        break;                                          \
                }                                                       \
        }                                                               \
} 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)
                return GS1_LINTER_OK;
 
        /*
         * If not valid then indicate an error.
         *
         */
        if (err_pos) *err_pos = 0;
        if (err_len) *err_len = strlen(data);
        return GS1_LINTER_INVALID_MEDIA_TYPE;
 
}