rxing 0.4.11

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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

/*
 * Copyright 2013 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.
 */

// package com.google.zxing.aztec.detector;

// import com.google.zxing.NotFoundException;
// import com.google.zxing.aztec.AztecDetectorRXingResult;
// import com.google.zxing.aztec.decoder.Decoder;
// import com.google.zxing.aztec.detector.Detector.Point;
// import com.google.zxing.aztec.encoder.AztecCode;
// import com.google.zxing.aztec.encoder.Encoder;
// import com.google.zxing.common.BitMatrix;
// import com.google.zxing.common.DecoderRXingResult;
// import org.junit.Assert;
// import org.junit.Test;

// import java.util.ArrayList;
// import java.util.Arrays;
// import java.util.Collection;
// import java.util.List;
// import java.util.Random;
// import java.util.TreeSet;

use rand::Rng;

use crate::{aztec::decoder, common::BitMatrix, exceptions::Exceptions, Point};

use super::{
    detector::{self, Detector},
    encoder::{self, AztecCode},
};

/**
 * Tests for the Detector
 *
 * @author Frank Yellin
 */

#[test]
fn test_error_in_parameter_locator_zero_zero() {
    // Layers=1, CodeWords=1.  So the parameter info and its Reed-Solomon info
    // will be completely zero!
    test_error_in_parameter_locator("X");
}

#[test]
fn test_error_in_parameter_locator_compact() {
    test_error_in_parameter_locator("This is an example Aztec symbol for Wikipedia.");
}

#[test]
fn test_error_in_parameter_locator_not_compact() {
    let alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYabcdefghijklmnopqrstuvwxyz";
    test_error_in_parameter_locator(&format!("{alphabet}{alphabet}{alphabet}"));
}

#[test]
fn test_aztec_rxing_result_sample() {
    let matrix = BitMatrix::parse_strings(TEST_BARCODE, "X ", "  ").expect("string parse success");
    let r = Detector::new(&matrix).detect(false);
    assert!(r.is_ok());
    let r = r.expect("result already tested as ok");
    let res = decoder::decode(&r).expect("decode success");
    assert_eq!("Histórico", res.getText());
}

// Test that we can tolerate errors in the parameter locator bits
fn test_error_in_parameter_locator(data: &str) {
    let aztec =
        encoder::aztec_encoder::encode(data, 25, encoder::aztec_encoder::DEFAULT_AZTEC_LAYERS)
            .expect("encode should create");
    // dbg!(aztec.getMatrix().to_string());
    let mut random = rand::thread_rng(); //Random(aztec.getMatrix().hashCode());   // pseudo-random, but deterministic
    let layers = aztec.getLayers();
    let compact = aztec.isCompact();
    let orientation_points = get_orientation_points(&aztec);
    for isMirror in [false, true] {
        // for (boolean isMirror : new boolean[] { false, true }) {
        for matrix in get_rotations(aztec.getMatrix()) {
            // for (BitMatrix matrix : getRotations(aztec.getMatrix())) {
            // Systematically try every possible 1- and 2-bit error.
            for error1 in 0..orientation_points.len() {
                // for (int error1 = 0; error1 < orientationPoints.size(); error1++) {
                for error2 in error1..orientation_points.len() {
                    // for (int error2 = error1; error2 < orientationPoints.size(); error2++) {
                    let mut copy = if isMirror {
                        transpose(&matrix)
                    } else {
                        clone(&matrix)
                    };
                    copy.flip_coords(
                        (orientation_points.get(error1).unwrap().x as i32).unsigned_abs(),
                        (orientation_points.get(error1).unwrap().y as i32).unsigned_abs(),
                    );
                    if error2 > error1 {
                        // if error2 == error1, we only test a single error
                        copy.flip_coords(
                            (orientation_points.get(error2).unwrap().x as i32).unsigned_abs(),
                            (orientation_points.get(error2).unwrap().y as i32).unsigned_abs(),
                        );
                    }
                    // dbg!(copy.to_string());
                    // dbg!(make_larger(&copy, 3).to_string());
                    // The detector doesn't seem to work when matrix bits are only 1x1.  So magnify.
                    // dbg!(isMirror, error1, error2);
                    let r = Detector::new(&make_larger(&copy, 3)).detect(isMirror);
                    assert!(
                        r.is_ok(),
                        "decode should be ok: {isMirror:?}, {error1}, {error2}"
                    );
                    let r = r.expect("result already tested as ok");
                    assert_eq!(r.getNbLayers(), layers);
                    assert_eq!(r.isCompact(), compact);
                    let res = decoder::decode(&r).unwrap_or_else(|_| {
                        panic!("decode should be ok: {isMirror}, {error1}, {error2}")
                    });
                    assert_eq!(data, res.getText());
                }
            }
            // Try a few random three-bit errors;
            for _i in 0..5 {
                // for (int i = 0; i < 5; i++) {
                let mut copy = clone(&matrix);
                let mut errors = Vec::new();
                while errors.len() < 3 {
                    // Quick and dirty way of getting three distinct integers between 1 and n.
                    errors.push(random.gen_range(0..orientation_points.len()));
                }
                for error in errors {
                    // for (int error : errors) {
                    copy.flip_coords(
                        orientation_points.get(error).unwrap().x as u32,
                        orientation_points.get(error).unwrap().y as u32,
                    );
                    // copy.flip_coords(
                    //     orientation_points.get(error).unwrap().get_x().abs() as u32,
                    //     orientation_points.get(error).unwrap().get_y().abs() as u32,
                    // );
                }
                // try {
                if let Err(res) = detector::Detector::new(&make_larger(&copy, 3)).detect(false) {
                    if let Exceptions::NotFoundException(_msg) = res {
                        // all ok
                    } else {
                        panic!("Only Exceptions::NotFoundException allowed, got {res}");
                    }
                } else {
                    let r = Detector::new(&make_larger(&copy, 3)).detect(false);
                    assert!(r.is_ok());
                    let r = r.expect("result already tested as ok");
                    assert_eq!(r.getNbLayers(), layers);
                    assert_eq!(r.isCompact(), compact);
                    let res = decoder::decode(&r).expect("decode should be ok");
                    assert_eq!(data, res.getText());
                    //panic!("Should be unable to detect given value.");
                }
            }
        }
    }
}

// Zooms a bit matrix so that each bit is factor x factor
fn make_larger(input: &BitMatrix, factor: u32) -> BitMatrix {
    let width = input.getWidth();
    let mut output = BitMatrix::with_single_dimension(width * factor).expect("new");
    for inputY in 0..width {
        // for (int inputY = 0; inputY < width; inputY++) {
        for inputX in 0..width {
            // for (int inputX = 0; inputX < width; inputX++) {
            if input.get(inputX, inputY) {
                output
                    .setRegion(inputX * factor, inputY * factor, factor, factor)
                    .expect("region set should be ok");
            }
        }
    }
    output
}

// Returns a list of the four rotations of the BitMatrix.
fn get_rotations(matrix0: &BitMatrix) -> Vec<BitMatrix> {
    let matrix90 = rotate_right(matrix0);
    let matrix180 = rotate_right(&matrix90);
    let matrix270 = rotate_right(&matrix180);
    vec![matrix0.clone(), matrix90, matrix180, matrix270]
    // vec![matrix0.clone()]
    // vec![matrix90]
    // vec![matrix180]
    // vec![matrix270]
    // vec![matrix0.clone(), matrix90, matrix270, matrix180 ]
}

// Rotates a square BitMatrix to the right by 90 degrees
fn rotate_right(input: &BitMatrix) -> BitMatrix {
    let width = input.getWidth();
    let mut result = BitMatrix::with_single_dimension(width).expect("new");
    for x in 0..width {
        // for (int x = 0; x < width; x++) {
        for y in 0..width {
            // for (int y = 0; y < width; y++) {
            if input.get(x, y) {
                result.set(y, width - x - 1);
            }
        }
    }
    result
}

// Returns the transpose of a bit matrix, which is equivalent to rotating the
// matrix to the right, and then flipping it left-to-right
fn transpose(input: &BitMatrix) -> BitMatrix {
    let width = input.getWidth();
    let mut result = BitMatrix::with_single_dimension(width).expect("new");
    for x in 0..width {
        // for (int x = 0; x < width; x++) {
        for y in 0..width {
            // for (int y = 0; y < width; y++) {
            if input.get(x, y) {
                result.set(y, x);
            }
        }
    }
    result
}

fn clone(input: &BitMatrix) -> BitMatrix {
    let width = input.getWidth();
    let mut result = BitMatrix::with_single_dimension(width).expect("new");
    for x in 0..width {
        // for (int x = 0; x < width; x++) {
        for y in 0..width {
            // for (int y = 0; y < width; y++) {
            if input.get(x, y) {
                result.set(x, y);
            }
        }
    }
    result
}

fn get_orientation_points(code: &AztecCode) -> Vec<Point> {
    let center = code.getMatrix().getWidth() as i32 / 2;
    let offset = if code.isCompact() { 5 } else { 7 };
    let mut result = Vec::new();
    let mut xSign: i32 = -1;
    while xSign <= 1 {
        // for (int xSign = -1; xSign <= 1; xSign += 2) {
        let mut ySign: i32 = -1;
        while ySign <= 1 {
            // for (int ySign = -1; ySign <= 1; ySign += 2) {
            result.push(Point::from((
                center + xSign * offset,
                center + ySign * offset,
            )));
            result.push(Point::from((
                center + xSign * (offset - 1),
                center + ySign * offset,
            )));
            result.push(Point::from((
                center + xSign * offset,
                center + ySign * (offset - 1),
            )));

            ySign += 2;
        }
        xSign += 2;
    }
    result
}

const TEST_BARCODE: &str = r"                    X X X X X                     X X X X X           X X X X X X X X X X                                         X X X X X           
                    X X X X X                     X X X X X           X X X X X X X X X X                                         X X X X X           
                    X X X X X                     X X X X X           X X X X X X X X X X                                         X X X X X           
                    X X X X X                     X X X X X           X X X X X X X X X X                                         X X X X X           
                    X X X X X                     X X X X X           X X X X X X X X X X                                         X X X X X           
          X X X X X X X X X X X X X X X                     X X X X X           X X X X X X X X X X X X X X X                               X X X X X 
          X X X X X X X X X X X X X X X                     X X X X X           X X X X X X X X X X X X X X X                               X X X X X 
          X X X X X X X X X X X X X X X                     X X X X X           X X X X X X X X X X X X X X X                               X X X X X 
          X X X X X X X X X X X X X X X                     X X X X X           X X X X X X X X X X X X X X X                               X X X X X 
          X X X X X X X X X X X X X X X                     X X X X X           X X X X X X X X X X X X X X X                               X X X X X 
                    X X X X X X X X X X                                         X X X X X           X X X X X           X X X X X                     
                    X X X X X X X X X X                                         X X X X X           X X X X X           X X X X X                     
                    X X X X X X X X X X                                         X X X X X           X X X X X           X X X X X                     
                    X X X X X X X X X X                                         X X X X X           X X X X X           X X X X X                     
                    X X X X X X X X X X                                         X X X X X           X X X X X           X X X X X                     
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X                     
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X                     
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X                     
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X                     
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X                     
X X X X X X X X X X           X X X X X                                                                       X X X X X                               
X X X X X X X X X X           X X X X X                                                                       X X X X X                               
X X X X X X X X X X           X X X X X                                                                       X X X X X                               
X X X X X X X X X X           X X X X X                                                                       X X X X X                               
X X X X X X X X X X           X X X X X                                                                       X X X X X                               
                    X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X           X X X X X           
                    X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X           X X X X X           
                    X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X           X X X X X           
                    X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X           X X X X X           
                    X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X           X X X X X           
          X X X X X           X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X           X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X           X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X           X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X           X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X           X X X X X           X X X X X           X X X X X X X X X X X X X X X X X X X X 
          X X X X X X X X X X X X X X X           X X X X X           X X X X X           X X X X X           X X X X X X X X X X X X X X X X X X X X 
          X X X X X X X X X X X X X X X           X X X X X           X X X X X           X X X X X           X X X X X X X X X X X X X X X X X X X X 
          X X X X X X X X X X X X X X X           X X X X X           X X X X X           X X X X X           X X X X X X X X X X X X X X X X X X X X 
          X X X X X X X X X X X X X X X           X X X X X           X X X X X           X X X X X           X X X X X X X X X X X X X X X X X X X X 
          X X X X X X X X X X X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X                               X X X X X           X X X X X                               
          X X X X X X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X X X X X X                     
          X X X X X X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X X X X X X                     
          X X X X X X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X X X X X X                     
          X X X X X X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X X X X X X                     
          X X X X X X X X X X X X X X X           X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X X X X X X                     
                    X X X X X X X X X X                                                                       X X X X X X X X X X X X X X X           
                    X X X X X X X X X X                                                                       X X X X X X X X X X X X X X X           
                    X X X X X X X X X X                                                                       X X X X X X X X X X X X X X X           
                    X X X X X X X X X X                                                                       X X X X X X X X X X X X X X X           
                    X X X X X X X X X X                                                                       X X X X X X X X X X X X X X X           
X X X X X                     X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X 
X X X X X                     X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X 
X X X X X                     X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X 
X X X X X                     X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X 
X X X X X                     X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X           X X X X X 
X X X X X                                         X X X X X                     X X X X X           X X X X X                                         
X X X X X                                         X X X X X                     X X X X X           X X X X X                                         
X X X X X                                         X X X X X                     X X X X X           X X X X X                                         
X X X X X                                         X X X X X                     X X X X X           X X X X X                                         
X X X X X                                         X X X X X                     X X X X X           X X X X X                                         
X X X X X X X X X X                               X X X X X X X X X X X X X X X           X X X X X           X X X X X                     X X X X X 
X X X X X X X X X X                               X X X X X X X X X X X X X X X           X X X X X           X X X X X                     X X X X X 
X X X X X X X X X X                               X X X X X X X X X X X X X X X           X X X X X           X X X X X                     X X X X X 
X X X X X X X X X X                               X X X X X X X X X X X X X X X           X X X X X           X X X X X                     X X X X X 
X X X X X X X X X X                               X X X X X X X X X X X X X X X           X X X X X           X X X X X                     X X X X X 
X X X X X X X X X X X X X X X X X X X X                     X X X X X X X X X X           X X X X X X X X X X           X X X X X           X X X X X 
X X X X X X X X X X X X X X X X X X X X                     X X X X X X X X X X           X X X X X X X X X X           X X X X X           X X X X X 
X X X X X X X X X X X X X X X X X X X X                     X X X X X X X X X X           X X X X X X X X X X           X X X X X           X X X X X 
X X X X X X X X X X X X X X X X X X X X                     X X X X X X X X X X           X X X X X X X X X X           X X X X X           X X X X X 
X X X X X X X X X X X X X X X X X X X X                     X X X X X X X X X X           X X X X X X X X X X           X X X X X           X X X X X 
";