rqr 0.1.1

A small QR code generation project I made to dip my toes into rust again after several years of absence.
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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
//! QR code builder.
//!
//! Separated from the Qr struct to keep a simple and safe API.
//! But it's still possible to interface with the builder directly.
use crate::data;
use crate::ec::ECLevel;
use crate::ec;
use crate::info;
use crate::mask::Mask;
use crate::mask;
use crate::matrix::{Matrix, Module};
use crate::mode::Mode;
use crate::qr::Qr;
use crate::render;
use crate::version::Version;

use bitvec::*;

/// Builder for a QR code.
pub struct QrBuilder {
    /// Version to use.
    /// If not set a minimal version will be calculated.
    pub version: Option<Version>,
    /// Mask to use.
    /// If not set the optimal mask will be chosen per the QR specification.
    pub mask: Option<Mask>,
    /// Error correction level to use.
    /// If not set ECLevel::Q, which recovers 25% of data, will be used.
    pub ecl: ECLevel,
    /// Encoding mode to use.
    /// If not set will be inferred from input data.
    pub mode: Option<Mode>,

    /// Resulting matrix.
    ///
    /// Note that even though the matrix is not an Option it might still be invalid.
    /// This to simplify the implementation.
    pub matrix: Matrix,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum Error {
    /// Mode doesn't support encoding the supplied message.
    UnsupportedMode,
    /// Message is too long for the supplied version, or larger than the max len.
    MessageTooLong,
    /// The builder was in an incomplete state when trying to create a QR.
    IncompleteBuilder,
}

impl QrBuilder {
    /// Create a new builder.
    pub fn new() -> QrBuilder {
        QrBuilder {
            version: None,
            mask: None,
            ecl: ECLevel::Q,
            mode: None,

            matrix: Matrix::new(0),
        }
    }

    /// Set version. If not set the smallest applicable version will be used.
    pub fn version(mut self, v: Version) -> Self {
        // Override old tmp matrix.
        self.matrix = Matrix::new(v.size());
        self.version = Some(v);
        self
    }

    /// Set mask to use. If not set the best mask will be chosen according to the QR spec.
    pub fn mask(mut self, mask: Mask) -> Self {
        self.mask = Some(mask);
        self
    }

    /// Set error correction. Will default to ECLevel::Q.
    pub fn ecl(mut self, ecl: ECLevel) -> Self {
        self.ecl = ecl;
        self
    }

    /// Set the mode to use, will otherwise be calculated from input.
    pub fn mode(mut self, mode: Mode) -> Self {
        self.mode = Some(mode);
        self
    }

    /// Build all elements and generate a QR code.
    pub fn into(mut self, s: &str) -> Result<Qr, Error> {
        self.add_all(s)?;
        self.into_qr()
    }

    /// Convert the builder into a QR code.
    pub fn into_qr(self) -> Result<Qr, Error> {
        if !self.complete() {
            return Err(Error::IncompleteBuilder);
        }

        Ok(Qr {
            matrix: self.matrix,

            version: self.version.unwrap(),
            ecl: self.ecl,
            mode: self.mode.unwrap(),
            mask: self.mask.unwrap(),
        })
    }

    /// Add all elements of a QR code.
    pub fn add_all(&mut self, s: &str) -> Result<(), Error> {
        self.ensure_settings(s)?;
        self.add_fun_patterns();
        self.add_data(s)?;
        self.mask_data();
        self.add_info();

        Ok(())
    }

    /// Add function patterns.
    pub fn add_fun_patterns(&mut self) {
        self.add_finders();
        self.add_alignments();
        self.add_timing_patterns();
        self.add_dark_module();
        self.add_reserved_areas();
    }

    /// Add data.
    pub fn add_data(&mut self, s: &str) -> Result<(), Error> {
        self.ensure_settings(s)?;

        let version = self.version.unwrap();
        let mode = self.mode.unwrap();
        let ecl = self.ecl;

        let v = data::encode_with_mode(
            s,
            mode,
            version,
            ecl
        );
        let v = ec::add(v, self.version.unwrap(), self.ecl);
        self.add_raw_data(&v);

        Ok(())
    }

    /// Add raw data.
    pub fn add_raw_data(&mut self, v: &BitVec) {
        let mut vi = 0;
        for (x, y) in ZigZagIt::new(self.matrix.size) {
            if self.matrix.is_fun(x, y) { continue; }
            self.matrix.set_data(x, y, v[vi]);
            vi += 1;
        }
        assert_eq!(vi, v.len());
    }

    /// Mask data.
    pub fn mask_data(&mut self) {
        if let Some(mask) = self.mask {
            self.mask_with(mask);
        } else {
            self.mask_best();
        }
    }

    /// Mask by evaluating available masks and choose the best one.
    pub fn mask_best(&mut self) {
        let (mask, masked) = mask::mask(&self.matrix);
        self.mask = Some(mask);
        self.matrix = masked;
    }

    /// Mask using a specific mask.
    pub fn mask_with(&mut self, mask: Mask) {
        self.mask = Some(mask);
        self.matrix = mask::apply_mask(mask, &self.matrix);
    }

    /// Add info.
    pub fn add_info(&mut self) {
        self.add_format_info();
        self.add_version_info();
    }

    /// Add format info.
    pub fn add_format_info(&mut self) {
        // Hard assumption that we have necessary data.
        let format = info::format_info(self.ecl, self.mask.unwrap());
        self.add_format(&format);
    }

    /// Add version info.
    pub fn add_version_info(&mut self) {
        if let Some(v) = info::version_info(self.version.unwrap()) {
            self.add_version(&v);
        }
    }

    /// Return true if the build is complete.
    fn complete(&self) -> bool {
        if self.version.is_none() || self.mode.is_none() || self.mask.is_none() {
            return false;
        }
        if self.matrix.size == 0 {
            return false;
        }
        self.matrix.complete()
    }

    // Ensure we have required settings, otherwise decide from string.
    fn ensure_settings(&mut self, s: &str) -> Result<(), Error> {
        match self.mode {
            Some(m) if !m.matches(s) => return Err(Error::UnsupportedMode),
            Some(_) => (),
            None => self.mode = Some(Mode::from_str(s)),
        }

        // Try to calculate a minimal version if nothing is provided.
        if self.version.is_none() {
            self.version = Version::minimal(s, self.mode.unwrap(), self.ecl);
        }
        // We can either fail to find a minimum or a faulty version was provided before.
        if self.version.is_none() {
            return Err(Error::MessageTooLong);
        }

        // Ensure the matrix is intialized.
        if self.matrix.size == 0 {
            self.matrix = Matrix::new(self.version.unwrap().size());
        }

        Ok(())
    }

    fn add_finders(&mut self) {
        let size = self.matrix.size;

        self.add_finder(0, 0);
        self.add_separator(0, 7, 7, 7);
        self.add_separator(7, 0, 7, 7);

        self.add_finder(size - 7, 0);
        self.add_separator(size - 8, 7, size - 1, 7);
        self.add_separator(size - 8, 0, size - 8, 7);

        self.add_finder(0, size - 7);
        self.add_separator(0, size - 8, 7, size - 8);
        self.add_separator(7, size - 8, 7, size - 1);
    }

    // x and y specifies the top left corner
    fn add_finder(&mut self, x: usize, y: usize) {
        self.matrix.set_square(x, y, 7, Module::Function(true));
        self.matrix.set_square_outline(x + 1, y + 1, 5, Module::Function(false));
    }

    fn add_separator(&mut self, x0: usize, y0: usize, x1: usize, y1: usize) {
        for a in x0..x1 + 1 {
            for b in y0..y1 + 1 {
                self.matrix.set(a, b, Module::Function(false));
            }
        }
    }

    fn add_alignments(&mut self) {
        let locations = ALIGNMENT_LOCATIONS[self.version.unwrap().index()];
        for x in locations.iter() {
            for y in locations.iter() {
                self.try_add_alignment(*x, *y);
            }
        }
    }

    // x and y specifies the center point
    fn try_add_alignment(&mut self, cx: usize, cy: usize) {
        let x = cx - 2;
        let y = cy - 2;
        if !self.matrix.any_in_square(x, y, 4) {
            self.matrix.set_square(x, y, 5, Module::Function(true));
            self.matrix.set_square_outline(x + 1, y + 1, 3, Module::Function(false));
        }
    }

    fn add_timing_patterns(&mut self) {
        let offset = 6;
        for i in offset..self.matrix.size - offset {
            let v = i % 2 == 0;
            self.set_timing(i, offset, v);
            self.set_timing(offset, i, v);
        }
    }

    fn set_timing(&mut self, x: usize, y: usize, v: bool) {
        // Timing patterns should always overlap with finders and alignment modules.
        if self.matrix.is_fun(x, y) {
            assert_eq!(self.matrix.is_dark(x, y), v, "timing overlap {},{}", x, y);
        }

        self.matrix.set(x, y, Module::Function(v));
    }

    fn add_dark_module(&mut self) {
        let (x, y) = self.version.unwrap().dark_module_pos();
        self.matrix.set(x, y, Module::Function(true));
    }

    fn add_reserved_areas(&mut self) {
        let size = self.matrix.size;

        // Around top left finder.
        // Avoid timing pattern.
        self.reserve_rect(0, 8, 5, 8);
        self.reserve_rect(7, 8, 8, 8);
        self.reserve_rect(8, 0, 8, 5);
        self.reserve_rect(8, 7, 8, 7);

        // Top right.
        self.reserve_rect(size - 8, 8, size - 1, 8);

        // Bottom left.
        self.reserve_rect(8, size - 7, 8, size - 1);

        //// Larger versions needs two areas for version information.
        if self.version.unwrap().extra_version_areas() {
            self.reserve_rect(0, size - 11, 5, size - 9);
            self.reserve_rect(size - 11, 0, size - 9, 5);
        }
    }

    fn reserve_rect(&mut self, x0: usize, y0: usize, x1: usize, y1: usize) {
        assert!(!self.matrix.any_in_rect(x0, y0, x1, y1));
        self.matrix.set_rect(x0, y0, x1, y1, Module::Reserved);
    }

    fn add_format(&mut self, bv: &BitVec) {
        assert_eq!(bv.len(), 15);
        let size = self.matrix.size;

        // Info surrounding the top left finder.
        let mut iter = bv.iter();
        for x in 0..8 {
            // Avoid timing pattern.
            if x == 6 { continue; }
            self.matrix.set_fun(x, 8, iter.next().unwrap());
        }
        for y in (0..9).rev() {
            // Avoid timing pattern.
            if y == 6 { continue; }
            self.matrix.set_fun(8, y, iter.next().unwrap());
        }
        assert_eq!(iter.next(), None);

        // Half to the right of the bottom left finder.
        iter = bv.iter();
        for y in (size - 7..size).rev() {
            self.matrix.set_fun(8, y, iter.next().unwrap());
        }
        // Rest bottom of the top left finder.
        for x in (size - 8)..size {
            self.matrix.set_fun(x, 8, iter.next().unwrap());
        }
        assert_eq!(iter.next(), None);
    }

    fn add_version(&mut self, bv: &BitVec) {
        assert_eq!(bv.len(), 18);
        let size = self.matrix.size;

        // Bottom left version block.
        let mut iter = bv.iter();
        for x in 0..6 {
            for y in (size - 11)..(size - 8) {
                self.matrix.set_fun(x, y, iter.next().unwrap());
            }
        }
        assert_eq!(iter.next(), None);

        // Top right version block.
        iter = bv.iter();
        for y in 0..6 {
            for x in (size - 11)..(size - 8) {
                self.matrix.set_fun(x, y, iter.next().unwrap());
            }
        }
        assert_eq!(iter.next(), None);
    }

    /// Convert to debug string.
    pub fn to_dbg_string(&self) -> String {
        render::to_dbg_string(&self.matrix)
    }
}

// A zig-zagging iterator which moves according to the QR data specification.
// It starts in the bottom right corner and moves flows in fields 2 bits wide
// up and down.
// Inside the 2 bit flow it alternates between the right and left field.
// It also avoids the vertical timing pattern column completely,
// but it does not automatically skip function patterns.
struct ZigZagIt {
    size: usize,
    // Should we move horizontal next step?
    horizontal_next: bool,
    // Are we moving upwards?
    upwards: bool,
    // xy coordinates into the matrix.
    x: usize,
    y: usize,
    // Valid? Used as a stop criteria.
    valid: bool,
}

impl ZigZagIt {
    fn new(size: usize) -> Self {
        Self {
            size: size,
            horizontal_next: true,
            upwards: true,
            x: size - 1,
            y: size - 1,
            valid: true,
        }
    }

    fn advance(&mut self) {
        if self.horizontal_next {
            self.move_horizontally();
        } else {
            self.move_vertically();
        }
    }

    fn move_horizontally(&mut self) {
        match self.x {
            0 => self.valid = false,
            6 => self.x -= 2,
            _ => self.x -= 1,
        }
        self.horizontal_next = false;
    }

    fn move_vertically(&mut self) {
        if (self.upwards && self.y == 0) || (!self.upwards && self.y == self.size - 1) {
            // When we've reached the edge move in the other direction instead of zagging.
            self.upwards = !self.upwards;
            self.move_horizontally();
        } else {
            // Zag motion, y is inverted
            if self.upwards {
                self.y -= 1;
            } else {
                self.y += 1;
            }
            self.x += 1;
        }
        self.horizontal_next = true;
    }
}

impl Iterator for ZigZagIt {
    type Item = (usize, usize);

    fn next(&mut self) -> Option<Self::Item> {
        if !self.valid { return None; }

        let res = Some((self.x, self.y));
        self.advance();
        res
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn finders() {
        let mut builder = QrBuilder::new().version(Version::new(1));
        builder.add_finders();
        let expected = "
#######.?????.#######
#.....#.?????.#.....#
#.###.#.?????.#.###.#
#.###.#.?????.#.###.#
#.###.#.?????.#.###.#
#.....#.?????.#.....#
#######.?????.#######
........?????........
?????????????????????
?????????????????????
?????????????????????
?????????????????????
?????????????????????
........?????????????
#######.?????????????
#.....#.?????????????
#.###.#.?????????????
#.###.#.?????????????
#.###.#.?????????????
#.....#.?????????????
#######.?????????????
";
        //println!("{}", builder.to_dbg_string());
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn fun_patterns() {
        let mut builder = QrBuilder::new().version(Version::new(3));
        builder.add_fun_patterns();
        //println!("{}", builder.to_dbg_string());
        let expected = "
#######.*????????????.#######
#.....#.*????????????.#.....#
#.###.#.*????????????.#.###.#
#.###.#.*????????????.#.###.#
#.###.#.*????????????.#.###.#
#.....#.*????????????.#.....#
#######.#.#.#.#.#.#.#.#######
........*????????????........
******#**????????????********
??????.??????????????????????
??????#??????????????????????
??????.??????????????????????
??????#??????????????????????
??????.??????????????????????
??????#??????????????????????
??????.??????????????????????
??????#??????????????????????
??????.??????????????????????
??????#??????????????????????
??????.??????????????????????
??????#?????????????#####????
........#???????????#...#????
#######.*???????????#.#.#????
#.....#.*???????????#...#????
#.###.#.*???????????#####????
#.###.#.*????????????????????
#.###.#.*????????????????????
#.....#.*????????????????????
#######.*????????????????????
";
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn fun_patterns_large() {
        let mut builder = QrBuilder::new().version(Version::new(9));
        builder.add_fun_patterns();
        //println!("{}", builder.to_dbg_string());
        let expected = "
#######.*?????????????????????????????????***.#######
#.....#.*?????????????????????????????????***.#.....#
#.###.#.*?????????????????????????????????***.#.###.#
#.###.#.*?????????????????????????????????***.#.###.#
#.###.#.*???????????????#####?????????????***.#.###.#
#.....#.*???????????????#...#?????????????***.#.....#
#######.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#.#######
........*???????????????#...#????????????????........
******#**???????????????#####????????????????********
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
????#####???????????????#####???????????????#####????
????#...#???????????????#...#???????????????#...#????
????#.#.#???????????????#.#.#???????????????#.#.#????
????#...#???????????????#...#???????????????#...#????
????#####???????????????#####???????????????#####????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
??????#??????????????????????????????????????????????
??????.??????????????????????????????????????????????
******#??????????????????????????????????????????????
******.??????????????????????????????????????????????
******#?????????????????#####???????????????#####????
........#???????????????#...#???????????????#...#????
#######.*???????????????#.#.#???????????????#.#.#????
#.....#.*???????????????#...#???????????????#...#????
#.###.#.*???????????????#####???????????????#####????
#.###.#.*????????????????????????????????????????????
#.###.#.*????????????????????????????????????????????
#.....#.*????????????????????????????????????????????
#######.*????????????????????????????????????????????
";
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn add_raw_data() {
        let mut builder = QrBuilder::new().version(Version::new(2));
        builder.add_fun_patterns();
        let mut bv: BitVec = BitVec::new();
        for i in 0..359 {
            bv.push(i % 2 == 0);
        }
        builder.add_raw_data(&bv);

        let expected = "
#######.*X-X-X-X-.#######
#.....#.*X-X-X-X-.#.....#
#.###.#.*X-X-X-X-.#.###.#
#.###.#.*X-X-X-X-.#.###.#
#.###.#.*X-X-X-X-.#.###.#
#.....#.*X-X-X-X-.#.....#
#######.#.#.#.#.#.#######
........*X-X-X-X-........
******#**X-X-X-X-********
X-X-X-.X-X-X-X-X--X-X-X-X
X-X-X-#X-X-X-X-X--X-X-X-X
X-X-X-.X-X-X-X-X--X-X-X-X
X-X-X-#X-X-X-X-X--X-X-X-X
X-X-X-.X-X-X-X-X--X-X-X-X
X-X-X-#X-X-X-X-X--X-X-X-X
X-X-X-.X-X-X-X-X--X-X-X-X
X-X-X-#X-X-X-X-X#####-X-X
........#X-X-X--#...#-X-X
#######.*X-X-X-X#.#.#-X-X
#.....#.*X-X-X--#...#-X-X
#.###.#.*X-X-X-X#####-X-X
#.###.#.*X-X-X--X-X-X-X-X
#.###.#.*X-X-X--X-X-X-X-X
#.....#.*X-X-X--X-X-X-X-X
#######.*X-X-X--X-X-X-X-X
";
        //println!("{}", builder.to_dbg_string());
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn add_data() {
        let mut builder = QrBuilder::new()
            .version(Version::new(1))
            .ecl(ECLevel::Q);
        builder.add_fun_patterns();
        builder.add_data("HELLO WORLD").unwrap();
        //println!("{}", builder.to_dbg_string());
        let expected = "
#######.*XX-X.#######
#.....#.*X---.#.....#
#.###.#.*-XX-.#.###.#
#.###.#.*X-X-.#.###.#
#.###.#.*---X.#.###.#
#.....#.*XXX-.#.....#
#######.#.#.#.#######
........*X-X-........
******#**-X--********
---X-X.XX-X--X-XXX-XX
X--XXX#XXX--X----XX-X
--XXX-.--XX-------X--
--X---#----X---X-----
........#----XXX-XXXX
#######.*---X-XXXX--X
#.....#.*---XXX----X-
#.###.#.*---X--X-X-X-
#.###.#.*--------X---
#.###.#.*-XXXX-XXXX--
#.....#.*XX-X--X----X
#######.*-XXXX-XX-X--
";
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn format_info() {
        let mut builder = QrBuilder::new().version(Version::new(1));
        // Mask 6, ECLevel Q
        builder.add_format(&bitvec![0, 1, 0, 1, 1, 1, 0, 1, 1, 0, 1, 1, 0, 1, 0]);
        let expected = "
????????.????????????
????????#????????????
????????.????????????
????????#????????????
????????#????????????
????????.????????????
?????????????????????
????????#????????????
.#.###?.#????##.##.#.
?????????????????????
?????????????????????
?????????????????????
?????????????????????
?????????????????????
????????.????????????
????????#????????????
????????#????????????
????????#????????????
????????.????????????
????????#????????????
????????.????????????
";
        //println!("{}", builder.to_dbg_string());
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn hello_world() {
        // Builds a final QR code which should be scannable.
        let mut builder = QrBuilder::new()
            .version(Version::new(1))
            .ecl(ECLevel::Q);
        builder.add_all("HELLO WORLD").unwrap();
        let expected = "
#######..--X-.#######
#.....#.#X--X.#.....#
#.###.#..X-XX.#.###.#
#.###.#.#XXXX.#.###.#
#.###.#.#X-X-.#.###.#
#.....#..X--X.#.....#
#######.#.#.#.#######
........#X-XX........
.#.####.#X--X##.##.#.
X-XXXX.X----XXXX-XXX-
--X-X-#X---X--XX-----
X-XX-X.--X-XX---XX---
XX-XXX#XXXX-XXX-XXXXX
........#---X--X-X---
#######..XX--XX--XXXX
#.....#.#-X--X--X-XXX
#.###.#.#X-X--X---XXX
#.###.#.#-XXX---X-X--
#.###.#..X----X----XX
#.....#.#XX--XXX--XX-
#######..X-X-------X-
";
        //println!("{}", builder.to_dbg_string());
        assert_eq!(builder.to_dbg_string(), expected);
    }

    #[test]
    fn config() {
        let mut builder = QrBuilder::new()
            .ecl(ECLevel::L)
            .mask(Mask::new(7))
            .mode(Mode::Byte);
        builder.add_all("HELLO WORLD").unwrap();
        //println!("{}", builder.to_dbg_string());
        assert_eq!(builder.version, Some(Version::new(1)));
        assert_eq!(builder.mask, Some(Mask::new(7)));
        assert_eq!(builder.mode, Some(Mode::Byte));
        assert_eq!(builder.ecl, ECLevel::L);
    }

    #[test]
    fn into_qr() {
        // Regular API.
        assert!(QrBuilder::new().into("HELLO WORLD").is_ok());

        // We can encode a zero string although it doesn't make much sense.
        assert!(QrBuilder::new().into("").is_ok());

        // Test over capacity.
        let mut long = String::new();
        for _ in 0..3000 {
            long.push('X');
        }
        assert_eq!(QrBuilder::new().mode(Mode::Byte).ecl(ECLevel::L).into(&long),
                   Err(Error::MessageTooLong));

        // Unsupported mode for string content.
        assert_eq!(QrBuilder::new().mode(Mode::Numeric).into("HELLO"),
                   Err(Error::UnsupportedMode));
    }
}

static ALIGNMENT_LOCATIONS: [&[usize]; 40] = [
    &[],
    &[6, 18],
    &[6, 22],
    &[6, 26],
    &[6, 30],
    &[6, 34],
    &[6, 22, 38],
    &[6, 24, 42],
    &[6, 26, 46],
    &[6, 28, 50],
    &[6, 30, 54],
    &[6, 32, 58],
    &[6, 34, 62],
    &[6, 26, 46, 66],
    &[6, 26, 48, 70],
    &[6, 26, 50, 74],
    &[6, 30, 54, 78],
    &[6, 30, 56, 82],
    &[6, 30, 58, 86],
    &[6, 34, 62, 90],
    &[6, 28, 50, 72, 94],
    &[6, 26, 50, 74, 98],
    &[6, 30, 54, 78, 102],
    &[6, 28, 54, 80, 106],
    &[6, 32, 58, 84, 110],
    &[6, 30, 58, 86, 114],
    &[6, 34, 62, 90, 118],
    &[6, 26, 50, 74, 98, 122],
    &[6, 30, 54, 78, 102, 126],
    &[6, 26, 52, 78, 104, 130],
    &[6, 30, 56, 82, 108, 134],
    &[6, 34, 60, 86, 112, 138],
    &[6, 30, 58, 86, 114, 142],
    &[6, 34, 62, 90, 118, 146],
    &[6, 30, 54, 78, 102, 126, 150],
    &[6, 24, 50, 76, 102, 128, 154],
    &[6, 28, 54, 80, 106, 132, 158],
    &[6, 32, 58, 84, 110, 136, 162],
    &[6, 26, 54, 82, 110, 138, 166],
    &[6, 30, 58, 86, 114, 142, 170]];