rxing 0.9.0

A rust port of the zxing barcode library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

/*
 * Copyright 2008 ZXing authors
 *
 * 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.
 */

use crate::common::cpp_essentials::ByteMatrix;
use crate::qrcode::encoder::mask_util;

/**
 * @author satorux@google.com (Satoru Takabayashi) - creator
 * @author mysen@google.com (Chris Mysen) - ported from C++
 */

#[test]
fn testApplyMaskPenaltyRule1() {
    let mut matrix = ByteMatrix::new(4, 1);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 0);
    matrix.set(3, 0, 0);
    assert_eq!(0, mask_util::applyMaskPenaltyRule1(&matrix));
    // Horizontal.
    let mut matrix = ByteMatrix::new(6, 1);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 0);
    matrix.set(3, 0, 0);
    matrix.set(4, 0, 0);
    matrix.set(5, 0, 1);
    assert_eq!(3, mask_util::applyMaskPenaltyRule1(&matrix));
    matrix.set(5, 0, 0);
    assert_eq!(4, mask_util::applyMaskPenaltyRule1(&matrix));
    // Vertical.
    let mut matrix = ByteMatrix::new(1, 6);
    matrix.set(0, 0, 0);
    matrix.set(0, 1, 0);
    matrix.set(0, 2, 0);
    matrix.set(0, 3, 0);
    matrix.set(0, 4, 0);
    matrix.set(0, 5, 1);
    assert_eq!(3, mask_util::applyMaskPenaltyRule1(&matrix));
    matrix.set(0, 5, 0);
    assert_eq!(4, mask_util::applyMaskPenaltyRule1(&matrix));
}

#[test]
fn testApplyMaskPenaltyRule2() {
    let mut matrix = ByteMatrix::new(1, 1);
    matrix.set(0, 0, 0);
    assert_eq!(0, mask_util::applyMaskPenaltyRule2(&matrix));
    let mut matrix = ByteMatrix::new(2, 2);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(0, 1, 0);
    matrix.set(1, 1, 1);
    assert_eq!(0, mask_util::applyMaskPenaltyRule2(&matrix));
    let mut matrix = ByteMatrix::new(2, 2);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(0, 1, 0);
    matrix.set(1, 1, 0);
    assert_eq!(3, mask_util::applyMaskPenaltyRule2(&matrix));
    let mut matrix = ByteMatrix::new(3, 3);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 0);
    matrix.set(0, 1, 0);
    matrix.set(1, 1, 0);
    matrix.set(2, 1, 0);
    matrix.set(0, 2, 0);
    matrix.set(1, 2, 0);
    matrix.set(2, 2, 0);
    // Four instances of 2x2 blocks.
    assert_eq!(3 * 4, mask_util::applyMaskPenaltyRule2(&matrix));
}

#[test]
fn testApplyMaskPenaltyRule3() {
    // Horizontal 00001011101.
    let mut matrix = ByteMatrix::new(11, 1);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 0);
    matrix.set(3, 0, 0);
    matrix.set(4, 0, 1);
    matrix.set(5, 0, 0);
    matrix.set(6, 0, 1);
    matrix.set(7, 0, 1);
    matrix.set(8, 0, 1);
    matrix.set(9, 0, 0);
    matrix.set(10, 0, 1);
    assert_eq!(40, mask_util::applyMaskPenaltyRule3(&matrix));
    // Horizontal 10111010000.
    let mut matrix = ByteMatrix::new(11, 1);
    matrix.set(0, 0, 1);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 1);
    matrix.set(3, 0, 1);
    matrix.set(4, 0, 1);
    matrix.set(5, 0, 0);
    matrix.set(6, 0, 1);
    matrix.set(7, 0, 0);
    matrix.set(8, 0, 0);
    matrix.set(9, 0, 0);
    matrix.set(10, 0, 0);
    assert_eq!(40, mask_util::applyMaskPenaltyRule3(&matrix));
    // Horizontal 1011101.
    let mut matrix = ByteMatrix::new(7, 1);
    matrix.set(0, 0, 1);
    matrix.set(1, 0, 0);
    matrix.set(2, 0, 1);
    matrix.set(3, 0, 1);
    matrix.set(4, 0, 1);
    matrix.set(5, 0, 0);
    matrix.set(6, 0, 1);
    assert_eq!(0, mask_util::applyMaskPenaltyRule3(&matrix));
    // Vertical 00001011101.
    let mut matrix = ByteMatrix::new(1, 11);
    matrix.set(0, 0, 0);
    matrix.set(0, 1, 0);
    matrix.set(0, 2, 0);
    matrix.set(0, 3, 0);
    matrix.set(0, 4, 1);
    matrix.set(0, 5, 0);
    matrix.set(0, 6, 1);
    matrix.set(0, 7, 1);
    matrix.set(0, 8, 1);
    matrix.set(0, 9, 0);
    matrix.set(0, 10, 1);
    assert_eq!(40, mask_util::applyMaskPenaltyRule3(&matrix));
    // Vertical 10111010000.
    let mut matrix = ByteMatrix::new(1, 11);
    matrix.set(0, 0, 1);
    matrix.set(0, 1, 0);
    matrix.set(0, 2, 1);
    matrix.set(0, 3, 1);
    matrix.set(0, 4, 1);
    matrix.set(0, 5, 0);
    matrix.set(0, 6, 1);
    matrix.set(0, 7, 0);
    matrix.set(0, 8, 0);
    matrix.set(0, 9, 0);
    matrix.set(0, 10, 0);
    // Vertical 1011101.
    let mut matrix = ByteMatrix::new(1, 7);
    matrix.set(0, 0, 1);
    matrix.set(0, 1, 0);
    matrix.set(0, 2, 1);
    matrix.set(0, 3, 1);
    matrix.set(0, 4, 1);
    matrix.set(0, 5, 0);
    matrix.set(0, 6, 1);
    assert_eq!(0, mask_util::applyMaskPenaltyRule3(&matrix));
}

#[test]
fn testApplyMaskPenaltyRule4() {
    // Dark cell ratio = 0%
    let mut matrix = ByteMatrix::new(1, 1);
    matrix.set(0, 0, 0);
    assert_eq!(100, mask_util::applyMaskPenaltyRule4(&matrix));
    // Dark cell ratio = 5%
    let mut matrix = ByteMatrix::new(2, 1);
    matrix.set(0, 0, 0);
    matrix.set(0, 0, 1);
    assert_eq!(0, mask_util::applyMaskPenaltyRule4(&matrix));
    // Dark cell ratio = 66.67%
    let mut matrix = ByteMatrix::new(6, 1);
    matrix.set(0, 0, 0);
    matrix.set(1, 0, 1);
    matrix.set(2, 0, 1);
    matrix.set(3, 0, 1);
    matrix.set(4, 0, 1);
    matrix.set(5, 0, 0);
    assert_eq!(30, mask_util::applyMaskPenaltyRule4(&matrix));
}

fn testGetDataMaskBitInternal(maskPattern: u32, expected: &[Vec<u32>]) -> bool {
    for x in 0..6 {
        // for (int x = 0; x < 6; ++x) {
        for (y, expectation) in expected.iter().enumerate().take(6) {
            // for (int y = 0; y < 6; ++y) {
            if (expectation[x] == 1)
                != mask_util::getDataMaskBit(maskPattern, x as u32, y as u32)
                    .expect("should never fail")
            {
                return false;
            }
        }
    }
    true
}

// See mask patterns on the page 43 of JISX0510:2004.
#[test]
fn testGetDataMaskBit() {
    let mask0 = vec![
        vec![1, 0, 1, 0, 1, 0],
        vec![0, 1, 0, 1, 0, 1],
        vec![1, 0, 1, 0, 1, 0],
        vec![0, 1, 0, 1, 0, 1],
        vec![1, 0, 1, 0, 1, 0],
        vec![0, 1, 0, 1, 0, 1],
    ];
    assert!(testGetDataMaskBitInternal(0, &mask0));
    let mask1 = vec![
        vec![1, 1, 1, 1, 1, 1],
        vec![0, 0, 0, 0, 0, 0],
        vec![1, 1, 1, 1, 1, 1],
        vec![0, 0, 0, 0, 0, 0],
        vec![1, 1, 1, 1, 1, 1],
        vec![0, 0, 0, 0, 0, 0],
    ];
    assert!(testGetDataMaskBitInternal(1, &mask1));
    let mask2 = vec![
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
    ];
    assert!(testGetDataMaskBitInternal(2, &mask2));
    let mask3 = vec![
        vec![1, 0, 0, 1, 0, 0],
        vec![0, 0, 1, 0, 0, 1],
        vec![0, 1, 0, 0, 1, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![0, 0, 1, 0, 0, 1],
        vec![0, 1, 0, 0, 1, 0],
    ];
    assert!(testGetDataMaskBitInternal(3, &mask3));
    let mask4 = vec![
        vec![1, 1, 1, 0, 0, 0],
        vec![1, 1, 1, 0, 0, 0],
        vec![0, 0, 0, 1, 1, 1],
        vec![0, 0, 0, 1, 1, 1],
        vec![1, 1, 1, 0, 0, 0],
        vec![1, 1, 1, 0, 0, 0],
    ];
    assert!(testGetDataMaskBitInternal(4, &mask4));
    let mask5 = vec![
        vec![1, 1, 1, 1, 1, 1],
        vec![1, 0, 0, 0, 0, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 1, 0, 1, 0],
        vec![1, 0, 0, 1, 0, 0],
        vec![1, 0, 0, 0, 0, 0],
    ];
    assert!(testGetDataMaskBitInternal(5, &mask5));
    let mask6 = vec![
        vec![1, 1, 1, 1, 1, 1],
        vec![1, 1, 1, 0, 0, 0],
        vec![1, 1, 0, 1, 1, 0],
        vec![1, 0, 1, 0, 1, 0],
        vec![1, 0, 1, 1, 0, 1],
        vec![1, 0, 0, 0, 1, 1],
    ];
    assert!(testGetDataMaskBitInternal(6, &mask6));
    let mask7 = vec![
        vec![1, 0, 1, 0, 1, 0],
        vec![0, 0, 0, 1, 1, 1],
        vec![1, 0, 0, 0, 1, 1],
        vec![0, 1, 0, 1, 0, 1],
        vec![1, 1, 1, 0, 0, 0],
        vec![0, 1, 1, 1, 0, 0],
    ];
    assert!(testGetDataMaskBitInternal(7, &mask7));
}