summaryrefslogtreecommitdiff
path: root/source/codes/Codes.mc
blob: 70c6c2d56ab0c90d20c2ae6c2b12b96cf080f449 (plain) (blame)
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
// Author:  cirakg & claude ai
// Summary: Barcode symbology IDs, option bits, result types and the dispatcher to the encoders (README 12).
//
// A code entry stores its symbology in Entry.type and its options in
// Entry.options (bits below). encode() turns the payload text into either a
// LinearCode (one row of modules) or, from M6b, a matrix; validation errors
// come back as a CodeError with a message for the user, never an exception.

import Toybox.Lang;

module Codes {

    // Symbology IDs (Entry.type of code entries). Stored: never renumber.
    const QR = 0;
    const CODE128 = 1;
    const CODE39 = 2;
    const EAN13 = 3;
    const EAN8 = 4;
    const UPCA = 5;
    const UPCE = 6;
    const ITF = 7;
    const CODABAR = 8;
    const DATAMATRIX = 9;
    const PDF417 = 10;
    const AZTEC = 11;

    const NAMES = ["QR", "Code 128", "Code 39", "EAN-13", "EAN-8", "UPC-A", "UPC-E", "ITF", "Codabar", "Data Matrix",
        "PDF417", "Aztec"];

    // Entry.options bits.
    const OPT_EC_MASK = 0x3;         // error correction: 0 low, 1 medium, 2 quartile, 3 high
    const OPT_CHECK_SHIFT = 2;       // check digit: 0 add or verify, 1 fix if wrong, 2 off
    const OPT_CHECK_MASK = 0xC;
    const OPT_SHOW_TEXT = 0x10;      // human-readable text under linear codes
    const DEFAULT_OPTIONS = 0x11;    // medium, add or verify, text on

    const CHECK_ADD_VERIFY = 0;
    const CHECK_FIX = 1;
    const CHECK_OFF = 2;

    // A row of modules: modules[i] is 1 for a bar, 0 for a space. The quiet
    // zone is not included (the renderer adds it).
    class LinearCode {
        var modules as ByteArray;
        // The human-readable text (digits as encoded, check digit included).
        var text as String;
        // A remark for the user (check digit added or fixed), or null.
        var note as String? = null;

        function initialize(rowModules as ByteArray, readable as String) {
            modules = rowModules;
            text = readable;
        }
    }

    // Why a payload can't be encoded, in words for the user.
    class CodeError {
        var message as String;

        function initialize(msg as String) {
            message = msg;
        }
    }

    function checkMode(options as Number) as Number {
        return (options & OPT_CHECK_MASK) >> OPT_CHECK_SHIFT;
    }

    function name(symbology as Number) as String {
        return symbology >= 0 && symbology < NAMES.size() ? NAMES[symbology] as String : "Code";
    }

    function isLinear(symbology as Number) as Boolean {
        return symbology >= CODE128 && symbology <= CODABAR;
    }

    // Encode a payload; unsupported symbologies give a CodeError until
    // their milestone (README 16, M6b-M6d).
    function encode(symbology as Number, payload as String, options as Number) as LinearCode or CodeError {
        var check = checkMode(options);
        if (symbology == EAN13) {
            return Ean.ean13(payload, check, "EAN-13", false);
        }
        if (symbology == UPCA) {
            return Ean.ean13(payload, check, "UPC-A", true);
        }
        if (symbology == EAN8) {
            return Ean.ean8(payload, check);
        }
        if (symbology == UPCE) {
            return Ean.upce(payload, check);
        }
        if (symbology == CODE128) {
            return Code128.encode(payload);
        }
        if (symbology == CODE39) {
            return Code39.encode(payload, check != CHECK_OFF);
        }
        if (symbology == ITF) {
            return Itf.encode(payload, check != CHECK_OFF);
        }
        if (symbology == CODABAR) {
            return Codabar.encode(payload);
        }
        return new CodeError(name(symbology) + " is not supported yet");
    }

    // Append bar/space runs to modules: widths alternate bar, space, ...,
    // starting with a bar when startWithBar.
    function addRuns(modules as ByteArray, widths as Array<Number>, startWithBar as Boolean) as Void {
        var bar = startWithBar;
        for (var i = 0; i < widths.size(); i++) {
            var w = widths[i];
            for (var k = 0; k < w; k++) {
                modules.add(bar ? 1 : 0);
            }
            bar = !bar;
        }
    }

    // Append a bit pattern of `count` modules, most significant bit first.
    function addBits(modules as ByteArray, bits as Number, count as Number) as Void {
        for (var i = count - 1; i >= 0; i--) {
            modules.add((bits >> i) & 1);
        }
    }

    // The digit values of text, or null when it holds anything else.
    function digits(text as String) as Array<Number>? {
        var chars = text.toCharArray();
        var out = [] as Array<Number>;
        for (var i = 0; i < chars.size(); i++) {
            var c = chars[i];
            if (c < '0' || c > '9') {
                return null;
            }
            out.add(c.toNumber() - 48);
        }
        return out;
    }

    function digitsText(values as Array<Number>) as String {
        var s = "";
        for (var i = 0; i < values.size(); i++) {
            s += values[i].toString();
        }
        return s;
    }
}