Align with Syntax Dictionary release 2025-01-30

terryburton · terryburton · commit 9e5af96d07ad · 2025-01-31T03:34:51.000Z
diff --git a/src/c-lib/gs1-syntax-dictionary.txt b/src/c-lib/gs1-syntax-dictionary.txt
@@ -1,7 +1,7 @@
 # GS1 Barcode Syntax Dictionary
 # -----------------------------
 #
-# Release: UNSET
+# Release: 2025-01-30
 #
 # This is the GS1 Barcode Syntax Dictionary.
 #
@@ -100,7 +100,7 @@
 #
 # Copyright (c) 2020-2021 BWIPP project. https://bwipp.terryburton.co.uk/
 # Copyright (c) 2020-2021 Zint Project. https://zint.org.uk/
-# Copyright (c) 2021-2024 GS1 AISBL
+# Copyright (c) 2021-2025 GS1 AISBL
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -118,10 +118,10 @@
 
 # AI     Flags Specification                    Attributes                                         Title
 
-00         *?  N18,csum,key                     dlpkey                                           # SSCC
-01         *?  N14,csum,key                     ex=255,37 dlpkey=22,10,21|235                    # GTIN
-02         *?  N14,csum,key                     ex=01,03 req=37                                  # CONTENT
-03         *   N14,csum,key                     ex=01,02,37                                      # MTO GTIN
+00         *?  N18,csum,keyoff1                 dlpkey                                           # SSCC
+01         *?  N14,csum,keyoff1                 ex=255,37 dlpkey=22,10,21|235                    # GTIN
+02         *?  N14,csum,keyoff1                 ex=01,03 req=37                                  # CONTENT
+03         *   N14,csum,keyoff1                 ex=01,02,37                                      # MTO GTIN
 10          ?  X..20                            req=01,02,03,8006,8026                           # BATCH/LOT
 11         *?  N6,yymmd0                        req=01,02,8006,8026                              # PROD DATE
 12         *?  N6,yymmd0                        req=8020                                         # DUE DATE
@@ -301,16 +301,16 @@
 7240        ?  X..20                            req=01,8006                                      # PROTOCOL
 7241        ?  N2,mediatype                     req=8017,8018                                    # AIDC MEDIA TYPE
 7242        ?  X..25                            req=8017,8018                                    # VCN
-7250           N8,yyyymmdd                      req=8018 ex=7251                                 # DOB
-7251           N8,yyyymmdd N4,hhmi              req=8018 ex=7250                                 # DOB TIME
-7252           N1,iso5218                       req=8018                                         # BIO SEX
-7253           X..40,pcenc                      req=8017,8018 ex=7256,7259                       # FAMILY NAME
-7254           X..40,pcenc                      req=8017,8018 ex=7256,7259                       # GIVEN NAME
-7255           X..10                            req=8017,8018 ex=7256,7259                       # SUFFIX
-7256           X..90,pcenc                      req=8017,8018                                    # FULL NAME
-7257           X..70,pcenc                      req=8018                                         # PERSON ADDR
-7258           X3,posinseqslash                 req=8018+7259                                    # BIRTH SEQUENCE
-7259           X..40,pcenc                      req=8018 ex=7256                                 # BABY
+7250        ?  N8,yyyymmdd                      req=8018 ex=7251                                 # DOB
+7251        ?  N8,yyyymmdd N4,hhmi              req=8018 ex=7250                                 # DOB TIME
+7252        ?  N1,iso5218                       req=8018                                         # BIO SEX
+7253        ?  X..40,pcenc                      req=8017,8018 ex=7256,7259                       # FAMILY NAME
+7254        ?  X..40,pcenc                      req=8017,8018 ex=7256,7259                       # GIVEN NAME
+7255        ?  X..10                            req=8017,8018 ex=7256,7259                       # SUFFIX
+7256        ?  X..90,pcenc                      req=8017,8018                                    # FULL NAME
+7257        ?  X..70,pcenc                      req=8018                                         # PERSON ADDR
+7258        ?  X3,posinseqslash                 req=8018+7259                                    # BIRTH SEQUENCE
+7259        ?  X..40,pcenc                      req=8018 ex=7256                                 # BABY
 8001        ?  N4,nonzero N5,nonzero N3,nonzero N1,winding N1  req=01                            # DIMENSIONS
 8002        ?  X..20                                                                             # CMT No.
 8003        ?  N1,zero N13,csum,key [X..16]     dlpkey                                           # GRAI
diff --git a/src/c-lib/gs1encoders-test.vcxproj b/src/c-lib/gs1encoders-test.vcxproj
@@ -195,6 +195,7 @@
     <ClCompile Include="syntax\lint_iso4217.c" />
     <ClCompile Include="syntax\lint_iso5218.c" />
     <ClCompile Include="syntax\lint_key.c" />
+    <ClCompile Include="syntax\lint_keyoff1.c" />
     <ClCompile Include="syntax\lint_latitude.c" />
     <ClCompile Include="syntax\lint_longitude.c" />
     <ClCompile Include="syntax\lint_mediatype.c" />
diff --git a/src/c-lib/gs1encoders-test.vcxproj.filters b/src/c-lib/gs1encoders-test.vcxproj.filters
@@ -140,6 +140,9 @@
     <ClCompile Include="syntax\lint_key.c">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="syntax\lint_keyoff1.c">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="syntax\lint_latitude.c">
       <Filter>Source Files</Filter>
     </ClCompile>
diff --git a/src/c-lib/gs1encoders.vcxproj b/src/c-lib/gs1encoders.vcxproj
@@ -162,6 +162,7 @@
     <ClCompile Include="syntax\lint_iso4217.c" />
     <ClCompile Include="syntax\lint_iso5218.c" />
     <ClCompile Include="syntax\lint_key.c" />
+    <ClCompile Include="syntax\lint_keyoff1.c" />
     <ClCompile Include="syntax\lint_latitude.c" />
     <ClCompile Include="syntax\lint_longitude.c" />
     <ClCompile Include="syntax\lint_mediatype.c" />
diff --git a/src/c-lib/gs1encoders.vcxproj.filters b/src/c-lib/gs1encoders.vcxproj.filters
@@ -93,6 +93,9 @@
     <ClCompile Include="syntax\lint_key.c">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="syntax\lint_keyoff1.c">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="syntax\lint_latitude.c">
       <Filter>Source Files</Filter>
     </ClCompile>
diff --git a/src/c-lib/syntax/gs1syntaxdictionary.c b/src/c-lib/syntax/gs1syntaxdictionary.c
@@ -1,5 +1,5 @@
 /*
- * GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2024 GS1 AISBL.
+ * GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2025 GS1 AISBL.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -66,6 +66,7 @@ const struct name_function_s name_function_map[] = {
 	ENT(iso4217),
 	ENT(iso5218),
 	ENT(key),
+	ENT(keyoff1),
 	ENT(latitude),
 	ENT(longitude),
 	ENT(mediatype),
diff --git a/src/c-lib/syntax/gs1syntaxdictionary.h b/src/c-lib/syntax/gs1syntaxdictionary.h
@@ -1,5 +1,5 @@
 /*
- * GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2024 GS1 AISBL.
+ * GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2025 GS1 AISBL.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -243,6 +243,7 @@ GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_iso3166alpha2(const char *data
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_iso4217(const char *data, size_t *err_pos, size_t *err_len);
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_iso5218(const char *data, size_t *err_pos, size_t *err_len);
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_key(const char *data, size_t *err_pos, size_t *err_len);
+GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_keyoff1(const char *data, size_t *err_pos, size_t *err_len);
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_latitude(const char *data, size_t *err_pos, size_t *err_len);
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_longitude(const char *data, size_t *err_pos, size_t *err_len);
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_mediatype(const char *data, size_t *err_pos, size_t *err_len);
diff --git a/src/c-lib/syntax/lint_key.c b/src/c-lib/syntax/lint_key.c
@@ -82,15 +82,20 @@
  *         source is unavailable and this should result in the linting failing.
  *         [IMPLEMENTATION SPECIFIC]
  *
+ * @note When GCP lookup service is provided by the user, it will be called
+ *       with strings whose prefix may be one of (1) a regular GCP, (2) a UPC
+ *       Company Code normalised to a regular GCP (by prefixing "0"), or (3) a
+ *       GS1-8 Prefix normalised to a regular GCP by prefixing "00000".
  * @note The choice of whether or not to assign `offline = 1` in order to
- * return #GS1_LINTER_GCP_DATASOURCE_OFFLINE when a user-provided GCP lookup
- * service is unavailable is implementation specific. It depends on whether the
- * desired behaviour is to fail open (return #GS1_LINTER_OK) or to fail closed
- * (return #GS1_LINTER_GCP_DATASOURCE_OFFLINE). In the case that it is
- * desirable to fail open then in addition to assigning `offline = 0` it is
- * necessary to assign `valid = 1` to avoid returning
- * #GS1_LINTER_INVALID_GCP_PREFIX, which would be misleading in the event of
- * service outage.
+ *       return #GS1_LINTER_GCP_DATASOURCE_OFFLINE when a user-provided GCP
+ *       lookup service is unavailable is implementation specific. It depends
+ *       on whether the desired behaviour is to fail open (return
+ *       #GS1_LINTER_OK) or to fail closed (return
+ *       #GS1_LINTER_GCP_DATASOURCE_OFFLINE). In the case that it is desirable
+ *       to fail open then in addition to assigning `offline = 0` it is
+ *       necessary to assign `valid = 1` to avoid returning
+ *       #GS1_LINTER_INVALID_GCP_PREFIX, which would be misleading in the event
+ *       of service outage.
  *
  */
 GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_key(const char* const data, size_t* const err_pos, size_t* const err_len)
diff --git a/src/c-lib/syntax/lint_keyoff1.c b/src/c-lib/syntax/lint_keyoff1.c
@@ -0,0 +1,183 @@
+/*
+ * GS1 Barcode Syntax Dictionary. Copyright (c) 2022-2025 GS1 AISBL
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+/**
+ * @file lint_keyoff1.c
+ *
+ * @brief The `keyoff` linter checks whether an input starts with a GS1 Company
+ * Prefix ("GCP") from its second character position.
+ *
+ * @remark The GCP is defined in the [GS1 General
+ * Specifications](https://www.gs1.org/genspecs) section "GS1 Company Prefix".
+ *
+ */
+
+#include <assert.h>
+#include <string.h>
+
+#include "gs1syntaxdictionary.h"
+#include "gs1syntaxdictionary-utils.h"
+
+
+/**
+ * Used to ensure that an AI component starts with a GCP from its second
+ * position.
+ *
+ * @param [in] data Pointer to the null-terminated data to be linted. Must not
+ *                  be `NULL`.
+ * @param [out] err_pos To facilitate error highlighting, the start position of
+ *                      the bad data is written to this pointer, if not `NULL`.
+ * @param [out] err_len The length of the bad data is written to this pointer, if
+ *                      not `NULL`.
+ *
+ * @return #GS1_LINTER_OK if okay.
+ * @return #GS1_LINTER_INVALID_GCP_PREFIX if the data does not start with a GCP.
+ * @return #GS1_LINTER_TOO_SHORT_FOR_KEY if the data is too short to start
+ *         with a GCP.
+ * @return #GS1_LINTER_GCP_DATASOURCE_OFFLINE if the user-provided GCP lookup
+ *         source is unavailable and this should result in the linting failing.
+ *         [IMPLEMENTATION SPECIFIC]
+ *
+ */
+GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_keyoff1(const char* const data, size_t* const err_pos, size_t* const err_len)
+{
+
+	size_t len;
+	gs1_lint_err_t ret;
+
+	assert(data);
+
+	len = strlen(data);
+
+	if (len < 2)
+		GS1_LINTER_RETURN_ERROR(
+			GS1_LINTER_TOO_SHORT_FOR_KEY,
+			0,
+			len
+		);
+
+	ret = gs1_lint_key(data + 1, err_pos, err_len);
+
+	assert(ret == GS1_LINTER_OK ||
+	       ret == GS1_LINTER_TOO_SHORT_FOR_KEY ||
+	       ret == GS1_LINTER_INVALID_GCP_PREFIX ||
+	       ret == GS1_LINTER_GCP_DATASOURCE_OFFLINE);
+
+	if (ret != GS1_LINTER_OK)
+		GS1_LINTER_RETURN_ERROR(
+			ret,
+			*err_pos + 1,
+			*err_len
+		);
+
+	GS1_LINTER_RETURN_OK;
+
+}
+
+
+#ifdef UNIT_TESTS
+
+#include "unittest.h"
+
+#ifndef GCP_MIN_LENGTH
+#define GCP_MIN_LENGTH 4  // Keep aligned with instance in lint_key.c
+#endif
+
+void test_lint_keyoff1(void)
+{
+
+	char data[GCP_MIN_LENGTH + 3], expect[GCP_MIN_LENGTH + 5];
+	int i;
+
+	/*
+	 *        |----- Indicates end of minimum-length GCP
+	 *        v
+	 *  I0...45|6 => Good
+	 *  I0...45|  => Good
+	 */
+	data[0] = 'I';
+	for (i = 1; i < GCP_MIN_LENGTH + 2; i++)
+		data[i] = (char)('0' + (i-1)%10);
+	data[i--] = '\0';
+	UNIT_TEST_PASS(gs1_lint_keyoff1, data);	// One more than minimum length
+	data[i--] = '\0';
+	UNIT_TEST_PASS(gs1_lint_keyoff1, data);	// Minimum length
+
+	/*
+	 *        |----- Indicates end of minimum-length GCP
+	 *        v
+	 *  I01234 |  => Short; I*01234*
+	 *  I0123  |  => Short; I*0123*
+	 *  I012   |  => Short; I*012*
+	 *  I01    |  => Short; I*01*
+	 *  I0     |  => Short; I*0*
+	 */
+	while (i >= 2) {
+		data[i--] = '\0';
+		strcpy(expect, "I*");
+		strcat(expect, data+1);
+		strcat(expect, "*");
+		UNIT_TEST_FAIL(gs1_lint_keyoff1, data, GS1_LINTER_TOO_SHORT_FOR_KEY, expect);
+	}
+
+	/*
+	 *        |----- Indicates end of minimum-length GCP
+	 *        v
+	 *  I      |  => Short; *I*
+	 *  ""     |  => Short; **
+	 */
+	while (i >= 0) {
+		data[i--] = '\0';
+		strcpy(expect, "*");
+		strcat(expect, data);
+		strcat(expect, "*");
+		UNIT_TEST_FAIL(gs1_lint_keyoff1, data, GS1_LINTER_TOO_SHORT_FOR_KEY, expect);
+	}
+
+	/*
+	 *  I012345|A => Good
+	 */
+	data[0] = 'I';
+	for (i = 1; i < GCP_MIN_LENGTH + 1; i++)
+		data[i] = (char)('0' + (i-1)%10);
+	data[i++] = 'A';
+	data[i] = '\0';
+	UNIT_TEST_PASS(gs1_lint_keyoff1, data);	// Minimum-length GCP is all numeric
+
+	/*
+	 *        |----- Indicates end of minimum-length GCP
+	 *        v
+	 *  I01234A|A => Bad; I01234*A*A
+	 *  I0123AA|A => Bad; I0123*A*AA
+	 *  I012AAA|A => Bad; I012*A*AAA
+	 *  I01AAAA|A => Bad; I01*A*AAAA
+	 *  I0AAAAA|A => Bad; I0*A*AAAAA
+	 *  IAAAAAA|A => Bad; I*A*AAAAAA
+	 */
+	strcpy(expect, data);
+	expect[i+2] = '\0';
+	i -= 2;
+	while (i >= 1) {
+		data[i] = 'A';
+		memcpy(&expect[i--], "*A*A", 4);
+		UNIT_TEST_FAIL(gs1_lint_keyoff1, data, GS1_LINTER_INVALID_GCP_PREFIX, expect);
+	}
+
+}
+
+#endif  /* UNIT_TESTS */
diff --git a/src/ios/GS1 Encoders App.xcodeproj/project.pbxproj b/src/ios/GS1 Encoders App.xcodeproj/project.pbxproj
@@ -55,6 +55,7 @@
 		F79827902909D35500F00DDA /* syn.c in Sources */ = {isa = PBXBuildFile; fileRef = F798275B2909D35400F00DDA /* syn.c */; };
 		F79827912909D35500F00DDA /* gs1-syntax-dictionary.txt in Resources */ = {isa = PBXBuildFile; fileRef = F798275C2909D35400F00DDA /* gs1-syntax-dictionary.txt */; };
 		F79827DD2909E3AE00F00DDA /* GS1Encoder.swift in Sources */ = {isa = PBXBuildFile; fileRef = F79827DC2909E3AE00F00DDA /* GS1Encoder.swift */; };
+		F7A4673F2D4C7B5400A72510 /* lint_keyoff1.c in Sources */ = {isa = PBXBuildFile; fileRef = F7A4673E2D4C7B5400A72510 /* lint_keyoff1.c */; };
 		F7A662AC2A50A95200638051 /* lint_longitude.c in Sources */ = {isa = PBXBuildFile; fileRef = F7A662A92A50A95200638051 /* lint_longitude.c */; };
 		F7A662AD2A50A95200638051 /* lint_latitude.c in Sources */ = {isa = PBXBuildFile; fileRef = F7A662AA2A50A95200638051 /* lint_latitude.c */; };
 		F7A662AE2A50A95200638051 /* lint_cset64.c in Sources */ = {isa = PBXBuildFile; fileRef = F7A662AB2A50A95200638051 /* lint_cset64.c */; };
@@ -128,6 +129,7 @@
 		F798275C2909D35400F00DDA /* gs1-syntax-dictionary.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = "gs1-syntax-dictionary.txt"; sourceTree = "<group>"; };
 		F79827DB2909DC2600F00DDA /* GS1 Encoders App-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "GS1 Encoders App-Bridging-Header.h"; sourceTree = "<group>"; };
 		F79827DC2909E3AE00F00DDA /* GS1Encoder.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GS1Encoder.swift; sourceTree = "<group>"; };
+		F7A4673E2D4C7B5400A72510 /* lint_keyoff1.c */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.c; path = lint_keyoff1.c; sourceTree = "<group>"; };
 		F7A662A92A50A95200638051 /* lint_longitude.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = lint_longitude.c; sourceTree = "<group>"; };
 		F7A662AA2A50A95200638051 /* lint_latitude.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = lint_latitude.c; sourceTree = "<group>"; };
 		F7A662AB2A50A95200638051 /* lint_cset64.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; path = lint_cset64.c; sourceTree = "<group>"; };
@@ -237,6 +239,7 @@
 		F79827392909D35400F00DDA /* syntax */ = {
 			isa = PBXGroup;
 			children = (
+				F7A4673E2D4C7B5400A72510 /* lint_keyoff1.c */,
 				F7CAA00A2CBC58E00066147A /* lint__stubs.c */,
 				F754C8492CB6A7FA00ACC93D /* lint_hhmi.c */,
 				F754C8472CB6A7EB00ACC93D /* lint_mi.c */,
@@ -441,6 +444,7 @@
 				F79827812909D35500F00DDA /* lint_iso3166alpha2.c in Sources */,
 				F79827612909D35500F00DDA /* ai.c in Sources */,
 				F798278C2909D35500F00DDA /* lint_iso3166999.c in Sources */,
+				F7A4673F2D4C7B5400A72510 /* lint_keyoff1.c in Sources */,
 				F798278D2909D35500F00DDA /* gs1syntaxdictionary.c in Sources */,
 				F798277F2909D35500F00DDA /* lint_cset82.c in Sources */,
 				F798278E2909D35500F00DDA /* lint_yymmd0.c in Sources */,
