lint_iso3166alpha2.c File Reference

Purpose

The iso3166alpha2 linter ensures that the data represents an ISO 3166 "alpha-2" country code.

Remarks

The two-character country codes are defined by ISO 3166-1: Codes for the representation of names of countries and their subdivisions - Part 1: Country code as the "alpha-2" codes.

Functional Description

gs1_lint_iso3166alpha2()

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

Used to validate that an AI component is an ISO 3166 "alpha-2" country code.

Note

To enable this linter to hook into an alternative ISO 3166 "alpha-2" lookup function (provided by the user) the GS1_LINTER_CUSTOM_ISO3166ALPHA2_LOOKUP_H macro may be set to the name of a header file to be included that defines a custom GS1_LINTER_CUSTOM_ISO3166ALPHA2_LOOKUP macro.

If provided, the GS1_LINTER_CUSTOM_ISO3166ALPHA2_LOOKUP macro shall invoke whatever functionality is available in the user-provided lookup function using the first argument (data) and second argument (data length), then using the result must assign to third (output) argument as follows:

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

Parameters

[in]	data	Pointer to the data to be linted. Must not be NULL.
[in]	data_len	Length of the data to be linted.
[in]	data_len	Length of the data parameter.
[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_NOT_ISO3166_ALPHA2 if the data is not a alpha-2 country code.

{
 
        /*
         * Allow for a custom replacement of the lookup code to be provided.
         *
         */
#ifdef GS1_LINTER_CUSTOM_ISO3166ALPHA2_LOOKUP
#define GS1_LINTER_ISO3166ALPHA2_LOOKUP(cc, cc_len, valid) GS1_LINTER_CUSTOM_ISO3166ALPHA2_LOOKUP(cc, cc_len, valid)
#else
 
        /*
         *  Set of ISO 3166 alpha-2 country codes
         *
         *  MAINTENANCE NOTE:
         *
         *  Updates to the ISO 3166 alpha-2 country code list are provided here:
         *
         *  https://isotc.iso.org/livelink/livelink?func=ll&objId=16944257&objAction=browse&viewType=1
         *
         */
        static const uint64_t iso3166alpha2[] = {
#if __STDC_VERSION__ >= 202311L
                0b0001111010011010111110110111011111110111101111011011101101111011,  // AA-CL: AD-AG AI AL-AM AO AQ-AU AW-AX AZ-BB BD-BJ BL-BO BQ-BT BV-BW BY-CA CC-CD CF-CH CI CK-CL
                0b1110010011111100001000011010100000000001001010110000000001110000,  // CM-EX: CM-CO CR CU-CZ DE DJ DK DM DO DZ EC EE EG-EH ER-ET
                0b0000000000111010100100000000110111111001110111111010100000000000,  // EY-HJ: FI-FJ FK FM FO FR GA-GB GD-GI GL-GN GP-GU GW GY
                0b1011000101100000000110000001111011110000000000100000001011000000,  // HK-JV: HK HM-HN HR HT-HU ID-IE IL-IO IQ-IT JE JM JO-JP
                0b0000000010111000110101000010111110000010100000011111001010111111,  // JW-MH: KE KG-KI KM-KN KP KR KW KY-KZ LA-LC LI LK LR-LV LY MA MC-MH
                0b0011111111111111111010111010010011010010000100000000000010000000,  // MI-OT: MK-NA NC NE-NG NI NL NO-NP NR NU NZ OM
                0b0000001000111100111100011100101010000000000000000000000000000010,  // OU-RF: PA PE-PH PK-PN PR-PT PW PY QA RE
                0b0000000010001010100011111011111111100111010111001101110111111001,  // RG-TR: RO RS RU RW SA-SE SG-SO SR-ST SV SX-SZ TC-TD TF-TH TJ-TO TR
                0b0101100110000010000010000010000011101010101000010000001000000000,  // TS-WD: TT TV-TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU
                0b0100000000000010000000000000000000000000000000000000100000000000,  // WE-YP: WF WS YE
                0b0001000000100000000000100000000010000000000000000000000000000000,  // YQ-ZZ: YT ZA ZM ZW
#else
                /*
                 *  Fallback for compilers lacking binary literal support.
                 *
                 *  Generated from the above data with:
                 *
                 *     for (size_t i = 0; i < sizeof(iso3166alpha2) / sizeof(iso3166alpha2[0]); i++) { printf("0x%016lx, ", iso3166alpha2[i]); };
                 *
                 */
                0x1e9afb77f7bdbb7b, 0xe4fc21a8012b0070, 0x003a900df9dfa800, 0xb160181ef00202c0,
                0x00b8d42f8281f2bf, 0x3fffeba4d2100080, 0x023cf1ca80000002, 0x008a8fbfe75cddf9,
                0x59820820eaa10200, 0x4002000000000800, 0x1020020080000000
#endif
        };
 
/// \cond
#define GS1_LINTER_ISO3166ALPHA2_LOOKUP(cc, cc_len, valid) do {                                 \
        valid = 0;                                                                              \
        if (cc_len == 2 && cc[0] >= 'A' && cc[0] <= 'Z' && cc[1] >= 'A' && cc[1] <= 'Z') {      \
                int v = (cc[0] - 'A') * 26 + cc[1] - 'A';                                       \
                GS1_LINTER_BITFIELD_LOOKUP(v, iso3166alpha2, valid);                            \
        }                                                                                       \
} while (0)
/// \endcond
 
#endif
 
        int valid;
 
        assert(data);
 
        /*
         * Ensure that the data is in the list.
         *
         */
        GS1_LINTER_ISO3166ALPHA2_LOOKUP(data, data_len, valid);
        if (GS1_LINTER_LIKELY(valid))
                GS1_LINTER_RETURN_OK;
 
        /*
         * If not valid then indicate an error.
         *
         */
        GS1_LINTER_RETURN_ERROR(
                GS1_LINTER_NOT_ISO3166_ALPHA2,
                0,
                data_len
        );
 
}