Merge branch 'hotfix' into develop

Author: fukuchi

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.1.0)
 
-project(QRencode VERSION 4.1.0 LANGUAGES C)
+project(QRencode VERSION 4.1.1 LANGUAGES C)
 
 option(WITH_TOOLS "Build utility tools"  YES )
 option(WITH_TESTS "Build tests"  NO )

ChangeLog

@@ -1,4 +1,12 @@
 2020.09.28 Kentaro Fukuchi <[email protected]>
+	[hotfix]
+	* qrinput.c, tests/test_estimatebit.c:
+	  - Fixed a bug in the estimation of the Micro QR Code's data length
+	    in QRinput_estimateBitStreamSizeOfEntry() has been fixed.
+	  - Fixed a bug in the calculation of the Micro QR Code's data capacity in
+	    QRinput_encodeBitStream().
+	  - A test case to test the bugs above has been added.
+	* Bumped version to 4.1.1.
 	[develop]
 	* tests/release_check.sh:
 	  - Release checker script has been added. Currently it checks only the

NEWS

@@ -9,6 +9,12 @@ Version x.x.x (2020.xx.xx)
 * Some minor bug fixes. (Thanks to Darsey Litzenberger and Edward E.)
 * Some performance improvements.
 
+Version 4.1.1 (2020.9.28)
+-------------------------
+* Some minor bugs in Micro QR Code generation have been fixed.
+  * The data capacity calculations are now correct. These bugs probably did not
+    affect the Micro QR Code generation.
+
 Version 4.1.0 (2020.8.29)
 -------------------------
 * Command line tool "qrencode" has been improved:

README.md

@@ -1,7 +1,7 @@
 # libqrencode - a fast and compact QR Code encoding library
 [![build](https://github.com/fukuchi/libqrencode/workflows/build/badge.svg)](https://github.com/fukuchi/libqrencode/actions)
 
-**Attention:** This repository contains the development version of libqrencode. See <https://fukuchi.org/works/qrencode/> for the official stable releases. At this moment, the latest stable release is version 4.1.0.
+**Attention:** This repository contains the development version of libqrencode. See <https://fukuchi.org/works/qrencode/> for the official stable releases. At this moment, the latest stable release is version 4.1.1.
 
 GENERAL INFORMATION
 ===================

configure.ac

@@ -1,6 +1,6 @@
 m4_define([__MAJOR_VERSION], [4])dnl
 m4_define([__MINOR_VERSION], [1])dnl
-m4_define([__MICRO_VERSION], [0])dnl
+m4_define([__MICRO_VERSION], [1])dnl
 m4_define([__VERSION], [__MAJOR_VERSION.__MINOR_VERSION.__MICRO_VERSION])dnl
 AC_INIT(QRencode, __VERSION)
 

qrinput.c

@@ -890,7 +890,7 @@ static int QRinput_estimateBitStreamSizeOfEntry(QRinput_List *entry, int version
 	}
 
 	if(mqr) {
-		l = QRspec_lengthIndicator(entry->mode, version);
+		l = MQRspec_lengthIndicator(entry->mode, version);
 		m = version - 1;
 		bits += l + m;
 	} else {
@@ -1018,7 +1018,11 @@ static int QRinput_encodeBitStream(QRinput_List *entry, BitStream *bstream, int
 
 	prevsize = (int)BitStream_size(bstream);
 
-	words = QRspec_maximumWords(entry->mode, version);
+	if(mqr) {
+		words = MQRspec_maximumWords(entry->mode, version);
+	} else {
+		words = QRspec_maximumWords(entry->mode, version);
+	}
 	if(words != 0 && entry->size > words) {
 		st1 = QRinput_List_newEntry(entry->mode, words, entry->data);
 		if(st1 == NULL) goto ABORT;

tests/test_estimatebit.c

@@ -139,11 +139,34 @@ static void test_mix(void)
 	QRinput_free(gstream);
 }
 
+/* Taken from JISX 0510:2018, p.23 */
+static void test_numbit1_mqr(void)
+{
+	QRinput *stream;
+	char *str = "0123456789012345";
+	int bits;
+
+	testStart("Estimation of Numeric stream for Micro QR Code (16 digits)");
+	stream = QRinput_newMQR(3, QR_ECLEVEL_M);
+	QRinput_append(stream, QR_MODE_NUM, 16, (const unsigned char *)str);
+	bits = QRinput_estimateBitStreamSize(stream, QRinput_getVersion(stream));
+	assert_equal(bits, 61, "Estimated bit length is wrong: %d, expected: %d.\n", bits, 61);
+	QRinput_free(stream);
+
+	stream = QRinput_newMQR(4, QR_ECLEVEL_M);
+	QRinput_append(stream, QR_MODE_NUM, 16, (const unsigned char *)str);
+	bits = QRinput_estimateBitStreamSize(stream, QRinput_getVersion(stream));
+	assert_equal(bits, 63, "Estimated bit length is wrong: %d, expected: %d.\n", bits, 63);
+	QRinput_free(stream);
+
+	testFinish();
+}
+
 int main()
 {
 	gstream = QRinput_new();
 
-	int tests = 8;
+	int tests = 9;
 	testInit(tests);
 	test_numbit();
 	test_numbit2();
@@ -153,6 +176,7 @@ int main()
 	test_kanji();
 	test_structure();
 	test_mix();
+	test_numbit1_mqr();
 	testReport(tests);
 
 	return 0;

tests/test_qrinput.c

@@ -889,6 +889,38 @@ static void test_estimateVersionBoundaryCheck(void)
 	testFinish();
 }
 
+static void test_QRinput_new_invalid(void)
+{
+	testStart("Invalid input to QRinput_new2()");
+	QRinput *input;
+
+	input = QRinput_new2(-1, QR_ECLEVEL_H);
+	assert_null(input, "QRinput_new2() returns non-null for invalid version (-1).\n");
+	assert_equal(errno, EINVAL, "Error code is not EINVAL.\n");
+	input = QRinput_new2(41, QR_ECLEVEL_H);
+	assert_null(input, "QRinput_new2() returns non-null for invalid version (41).\n");
+	assert_equal(errno, EINVAL, "Error code is not EINVAL.\n");
+	input = QRinput_new2(1, -1);
+	assert_null(input, "QRinput_new2() returns non-null for invalid level (-1).\n");
+	assert_equal(errno, EINVAL, "Error code is not EINVAL.\n");
+	input = QRinput_new2(1, 5);
+	assert_null(input, "QRinput_new2() returns non-null for invalid level (5).\n");
+	assert_equal(errno, EINVAL, "Error code is not EINVAL.\n");
+	testFinish();
+}
+
+static void test_QRinput_getErrorCorrectionLevel(void)
+{
+	testStart("Invalid input to QRinput_getErrorCorrectionLevel()");
+	QRinput *input;
+	QRecLevel level;
+
+	input = QRinput_new2(1, QR_ECLEVEL_H);
+	level = QRinput_getErrorCorrectionLevel(input);
+	assert_equal(level, QR_ECLEVEL_H, "QRinput_getErrorCorrectionLevel() fails to return expected level.\n");
+	testFinish();
+}
+
 static void test_mqr_new(void)
 {
 	QRinput *input;
@@ -1044,7 +1076,7 @@ static void test_encodeECI(void)
 
 int main()
 {
-	int tests = 40;
+	int tests = 42;
 	testInit(tests);
 
 	test_encodeNumeric();
@@ -1078,6 +1110,8 @@ int main()
 	test_parity2();
 	test_null_free();
 	test_estimateVersionBoundaryCheck();
+	test_QRinput_new_invalid();
+	test_QRinput_getErrorCorrectionLevel();
 
 	test_mqr_new();
 	test_mqr_setversion();