lint_packagetype.c File Reference

Purpose

The packagetype linter ensures that the data represents a valid UN/ECE Recommendation 21 alphanumeric code, extended with additional GS1 code values.

Remarks

The set of valid codes is maintained by GS1 in the PackageTypeCode code list.

Functional Description

gs1_lint_packagetype()

GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_packagetype	(	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 a valid package type as defined by the PackageTypeCode code list.

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 PackageTypeCode lookup function (provided by the user) the GS1_LINTER_CUSTOM_PACKAGE_TYPE_LOOKUP_H macro may be set to the name of a header file to be included that defines a custom GS1_LINTER_CUSTOM_PACKAGE_TYPE_LOOKUP macro.

If provided, the GS1_LINTER_CUSTOM_PACKAGE_TYPE_LOOKUP macro shall invoke whatever functionality is available in the user-provided lookup function using the first and second arguments, 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_INVALID_PACKAGE_TYPE if the data is not a valid PackageTypeCode.

{
 
        /*
         * Allow for a custom replacement of the lookup code to be provided.
         *
         */
#ifdef GS1_LINTER_CUSTOM_PACKAGE_TYPE_LOOKUP
#define GS1_LINTER_PACKAGE_TYPE_LOOKUP(cc, cc_len, valid) GS1_LINTER_CUSTOM_PACKAGE_TYPE_LOOKUP(cc, cc_len, valid)
#else
 
        /*
         *  Set of valid PackageTypeCode value, in lexicographic order
         *
         *  MAINTENANCE NOTE:
         *
         *  Updates must be aligned with the PackageTypeCode code list
         *
         */
        static const char packagetypes[][4] = {
                "1A", "1B", "1D", "1F", "1G", "1W",
                "200", "201", "202", "203", "204", "205", "206", "210", "211", "212", "2C",
                "3A", "3H",
                "43", "44", "4A", "4B", "4C", "4D", "4F", "4G", "4H",
                "5H", "5L", "5M",
                "6H", "6P",
                "7A", "7B",
                "8", "8A", "8B", "8C",
                "9",
                "AA", "AB", "AC", "AD", "AF", "AG", "AH", "AI", "AJ", "AL", "AM", "AP", "APE","AT", "AV",
                "B4", "BB", "BC", "BD", "BE", "BF", "BG", "BGE", "BH", "BI", "BJ", "BK", "BL", "BM", "BME", "BN", "BO", "BP", "BQ", "BR", "BRI", "BS", "BT", "BU", "BV", "BW", "BX", "BY", "BZ",
                "CA", "CB", "CBL", "CC", "CCE", "CD", "CE", "CF", "CG", "CH", "CI", "CJ", "CK", "CL", "CM", "CN", "CO", "CP", "CQ", "CR", "CS", "CT", "CU", "CV", "CW", "CX", "CY", "CZ",
                "DA", "DB", "DC", "DG", "DH", "DI", "DJ", "DK", "DL", "DM", "DN", "DP", "DPE", "DR", "DS", "DT", "DU", "DV", "DW", "DX", "DY",
                "E1", "E2", "E3", "EC", "ED", "EE", "EF", "EG", "EH", "EI", "EN",
                "FB", "FC", "FD", "FE", "FI", "FL", "FO", "FOB", "FP", "FPE", "FR", "FT", "FW", "FX",
                "GB", "GI", "GL", "GR", "GU", "GY", "GZ",
                "HA", "HB", "HC", "HG", "HN", "HR",
                "IA", "IB", "IC", "ID", "IE", "IF", "IG", "IH", "IK", "IL", "IN", "IZ",
                "JB", "JC", "JG", "JR", "JT", "JY",
                "KG", "KI",
                "LAB", "LE", "LG", "LT", "LU", "LV", "LZ",
                "MA", "MB", "MC", "ME", "MPE", "MR", "MS", "MT", "MW", "MX",
                "NA", "NE", "NF", "NG", "NS", "NT", "NU", "NV",
                "OA", "OB", "OC", "OD", "OE", "OF", "OK", "OPE", "OT", "OU",
                "P2", "PA", "PAE", "PB", "PC", "PD", "PE", "PF", "PG", "PH", "PI", "PJ", "PK", "PL", "PLP", "PN", "PO", "POP", "PP", "PPE", "PR", "PT", "PU", "PUE", "PV", "PX", "PY", "PZ",
                "QA", "QB", "QC", "QD", "QF", "QG", "QH", "QJ", "QK", "QL", "QM", "QN", "QP", "QQ", "QR", "QS",
                "RB1", "RB2", "RB3", "RCB", "RD", "RG", "RJ", "RK", "RL", "RO", "RT", "RZ",
                "S1", "SA", "SB", "SC", "SD", "SE", "SEC", "SH", "SI", "SK", "SL", "SM", "SO", "SP", "SS", "ST", "STL", "SU", "SV", "SW", "SX", "SY", "SZ",
                "T1", "TB", "TC", "TD", "TE", "TEV", "TG", "THE", "TI", "TK", "TL", "TN", "TO", "TR", "TRE", "TS", "TT", "TTE", "TU", "TV", "TW", "TWE", "TY", "TZ",
                "UC", "UN", "UUE",
                "VA", "VG", "VI", "VK", "VL", "VN", "VO", "VP", "VQ", "VR", "VS", "VY",
                "WA", "WB", "WC", "WD", "WF", "WG", "WH", "WJ", "WK", "WL", "WM", "WN", "WP", "WQ", "WR", "WRP", "WS", "WT", "WU", "WV", "WW", "WX", "WY", "WZ",
                "X11", "X12", "X15", "X16", "X17", "X18", "X19", "X20", "X3", "XA", "XB", "XC", "XD", "XF", "XG", "XH", "XJ", "XK",
                "YA", "YB", "YC", "YD", "YF", "YG", "YH", "YJ", "YK", "YL", "YM", "YN", "YP", "YQ", "YR", "YS", "YT", "YV", "YW", "YX", "YY", "YZ",
                "ZA", "ZB", "ZC", "ZD", "ZF", "ZG", "ZH", "ZJ", "ZK", "ZL", "ZM", "ZN", "ZP", "ZQ", "ZR", "ZS", "ZT", "ZU", "ZV", "ZW", "ZX", "ZY", "ZZ",
        };
 
/// \cond
#define GS1_LINTER_PACKAGE_TYPE_LOOKUP(cc, cc_len, valid) GS1_LINTER_BINARY_SEARCH(cc, cc_len, packagetypes, valid)
/// \endcond
 
#endif
 
        int valid;
 
        assert(data);
 
 
        /*
         * Ensure that the data is in the list.
         *
         */
        GS1_LINTER_PACKAGE_TYPE_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_INVALID_PACKAGE_TYPE,
                0,
                data_len
        );
 
}