GS1 Barcode Syntax Tests reference
A reference to the AI component "linter" routines referred to by the GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2024 GS1 AISBL.
lint_hh.c File Reference

Purpose

The hh linter ensures that the given data is a meaningful hour number in a day.

Functional Description

◆ gs1_lint_hh()

GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_hh ( 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 HH format for hours within a day.

Parameters
[in]dataPointer to the data to be linted. Must not be NULL.
[in]data_lenLength of the data to be linted.
[out]err_posTo facilitate error highlighting, the start position of the bad data is written to this pointer, if not NULL.
[out]err_lenThe length of the bad data is written to this pointer, if not NULL.
Returns
GS1_LINTER_OK if okay.
GS1_LINTER_HOUR_TOO_SHORT if the data is too short for HH format.
GS1_LINTER_HOUR_TOO_LONG if the data is too long for HH format.
GS1_LINTER_NON_DIGIT_CHARACTER if the data contains a non-digit character.
GS1_LINTER_ILLEGAL_HOUR if the data contains an invalid hour.
54{
55
56 int pos;
57
58 assert(data);
59
60 /*
61 * Data must be exactly two characters.
62 *
63 */
64 if (GS1_LINTER_UNLIKELY(data_len != 2))
67 0,
68 data_len
69 );
70
71 /*
72 * Data must consist of all digits.
73 */
74 for (pos = 0; pos < 2; pos++)
75 if (GS1_LINTER_UNLIKELY(data[pos] < '0' || data[pos] > '9'))
78 (size_t)pos,
79 1
80 );
81
82 /*
83 * Validate the hour (00-23).
84 */
85 if (GS1_LINTER_UNLIKELY((data[0] - '0') * 10 + (data[1] - '0') > 23))
88 0,
89 2
90 );
91
93
94}
#define GS1_LINTER_UNLIKELY(x)
Implementation may provide hint to the compiler that the expression is likely to be false.
Definition gs1syntaxdictionary-utils.h:76
#define GS1_LINTER_RETURN_ERROR(error, position, length)
Return from a linter indicating that a problem was detected with the given data.
Definition gs1syntaxdictionary-utils.h:103
#define GS1_LINTER_RETURN_OK
Return from a linter indicating that no problem was detected with the given data.
Definition gs1syntaxdictionary-utils.h:88
@ GS1_LINTER_HOUR_TOO_SHORT
The hour is too short for HH format.
Definition gs1syntaxdictionary.h:192
@ GS1_LINTER_HOUR_TOO_LONG
The hour is too long for HH format.
Definition gs1syntaxdictionary.h:193
@ GS1_LINTER_ILLEGAL_HOUR
The time contains an illegal hour.
Definition gs1syntaxdictionary.h:115
@ GS1_LINTER_NON_DIGIT_CHARACTER
A non-digit character was found where a digit is expected.
Definition gs1syntaxdictionary.h:78