This is a low-level API that most users should not use directly. A mid-level * API is the {@link #encodeSegments(List,Ecc,int,int,int,boolean)} function.
- * @param ver the version number to use, which must be in the range 1 to 40 (inclusive) - * @param ecl the error correction level to use + * @param version the version number to use, which must be in the range 1 to 40 (inclusive) + * @param errorCorrectionLevel the error correction level to use * @param dataCodewords the bytes representing segments to encode (without ECC) - * @param msk the mask pattern to use, which is either −1 for automatic choice or from 0 to 7 for fixed choice + * @param mask the mask pattern to use, which is either −1 for automatic choice or from 0 to 7 for fixed choice * @throws NullPointerException if the byte array or error correction level is {@code null} * @throws IllegalArgumentException if the version or mask value is out of range, * or if the data is the wrong length for the specified version and error correction level */ - public QrCode(int ver, Ecc ecl, byte[] dataCodewords, int msk) { + public QrCode(int version, Ecc errorCorrectionLevel, byte[] dataCodewords, int mask) { // Check arguments and initialize fields - if (ver < MIN_VERSION || ver > MAX_VERSION) + if (version < MIN_VERSION || version > MAX_VERSION) throw new IllegalArgumentException("Version value out of range"); - if (msk < -1 || msk > 7) + if (mask < -1 || mask > 7) throw new IllegalArgumentException("Mask value out of range"); - version = ver; - size = ver * 4 + 17; - errorCorrectionLevel = Objects.requireNonNull(ecl); + this.version = version; + this.size = version * 4 + 17; + this.errorCorrectionLevel = Objects.requireNonNull(errorCorrectionLevel); Objects.requireNonNull(dataCodewords); - modules = new boolean[size][size]; // Initially all white - isFunction = new boolean[size][size]; + this.modules = new boolean[size][size]; // Initially all white + this.isFunction = new boolean[size][size]; // Compute ECC, draw modules, do masking drawFunctionPatterns(); byte[] allCodewords = addEccAndInterleave(dataCodewords); drawCodewords(allCodewords); - this.mask = handleConstructorMasking(msk); + this.mask = handleConstructorMasking(mask); isFunction = null; } @@ -543,7 +543,7 @@ public final class QrCode { // before masking. Due to the arithmetic of XOR, calling applyMask() with // the same mask value a second time will undo the mask. A final well-formed // QR Code needs exactly one (not zero, two, etc.) mask applied. - private void applyMask(int msk) { + private void applyMask(int msk) { if (msk < 0 || msk > 7) throw new IllegalArgumentException("Mask value out of range"); for (int y = 0; y < size; y++) { @@ -592,7 +592,7 @@ public final class QrCode { // Calculates and returns the penalty score based on state of this QR Code's current modules. // This is used by the automatic mask choice algorithm to find the mask pattern that yields the lowest score. - private int getPenaltyScore() { + private int getPenaltyScore() { int result = 0; // Adjacent modules in row having same color, and finder-like patterns @@ -695,7 +695,7 @@ public final class QrCode { // Returns the number of data bits that can be stored in a QR Code of the given version number, after // all function modules are excluded. This includes remainder bits, so it might not be a multiple of 8. // The result is in the range [208, 29648]. This could be implemented as a 40-entry lookup table. - private static int getNumRawDataModules(int ver) { + private static int getNumRawDataModules(int ver) { if (ver < MIN_VERSION || ver > MAX_VERSION) throw new IllegalArgumentException("Version number out of range"); From c8c3b46c75fa775672fb2f746349f1cbee66b4e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EA=B2=BD=EC=A7=84?= <김경진@DESKTOP-6URC5U8> Date: Wed, 27 May 2020 10:40:22 +0900 Subject: [PATCH 2/5] Refactoring Replace Magic Number with Symbolic Constant drawFunctionPatterns() Not to use magic number --- java/src/main/java/io/nayuki/qrcodegen/QrCode.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java index fe05d48..512e314 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java @@ -354,8 +354,9 @@ public final class QrCode { private void drawFunctionPatterns() { // Draw horizontal and vertical timing patterns for (int i = 0; i < size; i++) { - setFunctionModule(6, i, i % 2 == 0); - setFunctionModule(i, 6, i % 2 == 0); + final boolean isBlack = i % 2 == 0; + setFunctionModule(6, i, isBlack); + setFunctionModule(i, 6, isBlack); } // Draw 3 finder patterns (all corners except bottom right; overwrites some timing modules) From bd9e5f3882fe6b56e71633e37529fbc95dc762ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EA=B2=BD=EC=A7=84?= <김경진@DESKTOP-6URC5U8> Date: Wed, 27 May 2020 10:45:15 +0900 Subject: [PATCH 3/5] Refactoring Replace Magic Number with Symbolic Constant drawFunctionPatterns() Not to use magic number --- .../main/java/io/nayuki/qrcodegen/QrCode.java | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java index 512e314..7013ed7 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java @@ -52,6 +52,12 @@ import java.util.Objects; */ public final class QrCode { + private static final int FINDER_SIZE = 3; + + private static final int TIMING_COORDINATE = 6; + + + /*---- Static factory functions (high level) ----*/ /** @@ -354,15 +360,14 @@ public final class QrCode { private void drawFunctionPatterns() { // Draw horizontal and vertical timing patterns for (int i = 0; i < size; i++) { - final boolean isBlack = i % 2 == 0; - setFunctionModule(6, i, isBlack); - setFunctionModule(i, 6, isBlack); + setFunctionModule(TIMING_COORDINATE, i, i % 2 == 0); + setFunctionModule(i, TIMING_COORDINATE, i % 2 == 0); } // Draw 3 finder patterns (all corners except bottom right; overwrites some timing modules) - drawFinderPattern(3, 3); - drawFinderPattern(size - 4, 3); - drawFinderPattern(3, size - 4); + drawFinderPattern(FINDER_SIZE, FINDER_SIZE); + drawFinderPattern(size - 1 - FINDER_SIZE, FINDER_SIZE); + drawFinderPattern(FINDER_SIZE, size - 1 - FINDER_SIZE); // Draw numerous alignment patterns int[] alignPatPos = getAlignmentPatternPositions(); From e82e40f30ca3c09a630a1424a0e2475f867d5b4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=EA=B2=BD=EC=A7=84?= <김경진@DESKTOP-6URC5U8> Date: Sun, 31 May 2020 21:25:14 +0900 Subject: [PATCH 4/5] 1. Extract Variable 2. drawFunctionPatterns() in QrCode 3. To improve readability of conditional expression --- java/src/main/java/io/nayuki/qrcodegen/QrCode.java | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java index 7013ed7..6920c32 100644 --- a/java/src/main/java/io/nayuki/qrcodegen/QrCode.java +++ b/java/src/main/java/io/nayuki/qrcodegen/QrCode.java @@ -374,8 +374,11 @@ public final class QrCode { int numAlign = alignPatPos.length; for (int i = 0; i < numAlign; i++) { for (int j = 0; j < numAlign; j++) { - // Don't draw on the three finder corners - if (!(i == 0 && j == 0 || i == 0 && j == numAlign - 1 || i == numAlign - 1 && j == 0)) + final boolean isLeftTop = i == 0 && j == 0; + final boolean isLeftBottom = i == 0 && j == numAlign - 1; + final boolean isRightTop = i == numAlign - 1 && j == 0; + final boolean onThreeFinderCorners = isLeftTop || isLeftBottom || isRightTop; + if (!onThreeFinderCorners) drawAlignmentPattern(alignPatPos[i], alignPatPos[j]); } } From 580485c189e35b8a6ef3b5cee2a42d6d13f2d35b Mon Sep 17 00:00:00 2001 From: gerzees