summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/barracuda/lib/lib-barcode/code39.lua
blob: a639619c639ffc8551cf25b8ca389e89836eea8b (plain)
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
-- Code39 barcode encoder implementation
-- Copyright (C) 2019 Roberto Giacomelli
--
-- All dimensions must be in scaled point (sp)
-- every fields that starts with an undercore sign are intended as private

local Code39 = {
    _VERSION     = "code39 v0.0.5",
    _NAME        = "Code39",
    _DESCRIPTION = "Code39 barcode encoder",
}

Code39._symb_def = {-- symbol definition
    ["0"] = 112122111, ["1"] = 211112112, ["2"] = 211112211,
    ["3"] = 111112212, ["4"] = 211122111, ["5"] = 111122112,
    ["6"] = 111122211, ["7"] = 212112111, ["8"] = 112112112,
    ["9"] = 112112211, ["A"] = 211211112, ["B"] = 211211211,
    ["C"] = 111211212, ["D"] = 211221111, ["E"] = 111221112,
    ["F"] = 111221211, ["G"] = 212211111, ["H"] = 112211112,
    ["I"] = 112211211, ["J"] = 112221111, ["K"] = 221111112,
    ["L"] = 221111211, ["M"] = 121111212, ["N"] = 221121111,
    ["O"] = 121121112, ["P"] = 121121211, ["Q"] = 222111111,
    ["R"] = 122111112, ["S"] = 122111211, ["T"] = 122121111,
    ["U"] = 211111122, ["V"] = 211111221, ["W"] = 111111222,
    ["X"] = 211121121, ["Y"] = 111121122, ["Z"] = 111121221,
    ["-"] = 212111121, ["."] = 112111122, [" "] = 112111221,
    ["$"] = 111212121, ["/"] = 121112121, ["+"] = 121211121,
    ["%"] = 121212111,
}
Code39._star_def  = 112121121 -- '*' start/stop character

-- parameters definition
Code39._par_def = {}
local pardef = Code39._par_def

-- module main parameter
pardef.module = {
    -- Narrow element X-dimension is the width of the smallest element in a
    -- barcode symbol.
    -- The X-dimension impacts scan-ability. Within the allowed range, it is
    -- recommended to use the largest possible X-dimension that is consistent
    -- with label or form design.
    -- The module width (width of narrow element) should be at least 7.5 mils
    -- or 0.1905mm (a mil is 1/1000 inch).
    default    = 7.5 * 0.0254 * 186467, -- 7.5 mils (sp) unit misure,
    unit       = "sp", -- scaled point
    isReserved = true,
    order      = 1, -- the one first to be modified
    fncheck    = function (self, mod, _) --> boolean, err
        if mod >= self.default then return true, nil end
        return false, "[OutOfRange] too small value for module"
    end,
}

pardef.ratio = {
    -- The "wide" element is a multiple of the "narrow" element and this
    -- multiple must remain the same throughout the symbol. This multiple can
    -- range between 2.0 and 3.0. Preferred value is 3.0.
    -- The multiple for the wide element should be between 2.0 and 3.0 if the
    -- narrow element is greater than 20 mils. If the narrow element is less
    -- than 20 mils (0.508mm), the multiple can only range between 2.0 and 2.2.
    default    = 2.0, -- the minimum
    unit       = "absolute-number",
    isReserved = true,
    order      = 2,
    fncheck    = function (self, ratio, tparcheck) --> boolean, err
        local mils = 0.0254 * 186467
        local mod = tparcheck.module
        local maxr; if mod < 20*mils then maxr = 2.2 else maxr = 3.0 end
        if ratio < 2.0 then
            return false, "[OutOfRange] too small ratio (min 2.0)"
        end
        if ratio > maxr then
            return false, "[OutOfRange] too big ratio (max "..maxr..")"
        end
        return true, nil
    end,
}

pardef.quietzone = {
    -- It is recommended to use the largest possible quiet zone, that is
    -- consistent with label or form design.
    -- Quiet zones must be at least 10 times the module width or 0.10 inches,
    -- whichever is larger. Default value (100 mils)
    default    = 2.54 * 186467, -- 0.1 inches equal to 100*mils
    unit       = "sp", -- scaled point
    isReserved = false,
    order      = 3,
    fncheck    = function (self, qz, tparcheck) --> boolean, err
        local mils = 0.0254 * 186467
        local mod = tparcheck.module
        local min = math.max(10*mod, 100*mils)
        if qz >= min then
            return true, nil
        end
        return false, "[OutOfRange] quietzone too small"
    end,
    fndefault = function(self, tck) --> default value respect to a set of param
        local mod = tck.module
        return math.max(10*mod, self.default)
    end,
}

pardef.interspace = { -- Intercharacter gap
    -- The intercharacter gap width (igw) is 5.3 times the module width (mw) if
    -- mw is less than 10 mils. If mw is 10 mils or greater, the value for igw
    -- is 3mw or 53 mils, whichever is greater. However, for quality printers,
    -- igw often equals mw.
    default    = 7.5 * 0.0254 * 186467, -- 1 module, for quality printer
    unit       = "sp", -- scaled point
    isReserved = false,
    order      = 4,
    fncheck    = function (self, igw, tparcheck) --> boolean, err
        local mod = tparcheck.module
        if igw >= mod then return true, nil end
        return false, "[OutOfRange] interspace too small"
    end,
    fndefault = function(self, tck) --> default value respect to a set of param
        return tck.module
    end,
}

pardef.height = {
    -- To enhance readability, it is recommended that the barcode be designed
    -- to be as tall as possible, taking into consideration the aspects of label
    -- and forms design.
    -- The height should be at least 0.15 times the barcode's length or 0.25 inch.
    default    = 8 * 186467, -- 8 mm -- TODO: better assessment for symbol length
    unit       = "sp", -- scaled point
    isReserved = false,
    order      = 5,
    fncheck = function (self, h, _) --> boolean, err
        local mils = 0.0254 * 186467
        if h >= 250*mils then return true, nil end
        return false, "[OutOfRange] height too small"
    end,
}

-- text yes or not
pardef.text_enabled = { -- boolean type
    -- enable/disable a text label upon the barcode symbol
    default    = true,
    isReserved = false,
    order      = 6,
    fncheck    = function (self, flag, _) --> boolean, err
        if type(flag) == "boolean" then
            return true, nil
        else
            return false, "[TypeErr] not a boolean value"
        end
    end,
}

-- define the text label vertical position
pardef.text_vpos = { -- enumeration
    default    = "bottom",
    isReserved = false,
    order      = 7,
    policy_enum = {
        top    = true, -- place text at the top of symbol
        bottom = true, -- place text under the symbol
    },
    fncheck    = function (self, e, _) --> boolean, err
        if type(e) ~= "string" then return false, "[TypeError] not a string" end
        local keys = self.policy_enum
        if keys[e] == true then
            return true, nil
        else
            return false, "[Err] enumeration value '"..e.."' not found"
        end
    end,
}

-- define the text label horizontal position
pardef.text_hpos = { -- enumeration
    default    = "left",
    isReserved = false,
    order      = 8,
    policy_enum = {
        left = true,
        center = true,
        right = true,
        spaced = true,
    },
    fncheck    = function (self, e, _) --> boolean, err
        if type(e) ~= "string" then return false, "[TypeError] not a string" end
        local keys = self.policy_enum
        if keys[e] == true then
            return true, nil
        else
            return false, "[Err] enumeration value '"..e.."' not found"
        end
    end,
}

-- vertical dimension between symbol and text
pardef.text_gap = {
    default    = 2.2 * 65536, -- 2.2 pt
    isReserved = false,
    order      = 9,
    unit       = "em", --> TODO: please put this under further analisys asap
    fncheck    = function(self, g, _) --> boolean, err
        if type(g) == "number" then
            if g > 0 then
                return true, nil
            else
                return false, "[OptErr] negative number"
            end
        else
            return false, "[TypeErr] not valid type for gap opt"
        end
    end,
}

-- star character appearing
pardef.text_star = {
    default    = false,
    isReserved = false,
    order      = 10,
    fncheck    = function(self, flag, _) --> boolean, err
        if type(flag) == "boolean" then
            return true, nil
        else
            return false, "[TypeErr] not a boolean value"
        end
    end,
}

-- configuration function
function Code39:config() --> ok, err
    -- build Vbar object for the start/stop symbol
    local mod, ratio = self.module, self.ratio
    local n_star = self._star_def
    local Vbar = self._libgeo.Vbar -- Vbar class
    self._vbar = {['*'] = Vbar:from_int_revpair(n_star, mod, mod*ratio)}
    return true, nil
end

-- overriding Barcode method
function Code39:_check_char(c) --> elem, err
    if type(c) ~= "string" or #c ~= 1 then
        return nil, "[InternalErr] invalid char"
    end
    local symb_def = self._symb_def
    local n = symb_def[c]
    if not n then
        local fmt = "[ArgErr] '%s' is not a valid Code 39 symbol"
        return nil, string.format(fmt, c)
    end
    return c, nil
end

-- overriding Barcode method
function Code39:_check_digit(n) --> elem, err
    if type(n) ~= "number" then
        return nil, "[InteranlErr] not a number"
    end
    if n < 0 or n > 9 then
        return nil, "[InternalErr] not a digit"
    end
    return tostring(n), nil
end

function Code39:_finalize() --> ok, err
    local v = assert(self._code_data, "[InternalErr] '_code_data' field is nil")
    local vbar = self._vbar
    local g_Vbar = self._libgeo.Vbar
    local mod, ratio = self.module, self.ratio
    local symb_def = self._symb_def
    for _, c in ipairs(v) do
        if not vbar[c] then
            local n1 = symb_def[c]
            vbar[c] = g_Vbar:from_int_revpair(n1, mod, mod*ratio)
        end
    end
    return true, nil
end

-- tx, ty is an optional translator vector
function Code39:append_ga(canvas, tx, ty) --> canvas
    local code       = self._code_data
    local ns         = self._code_len -- number of chars inside the symbol
    local mod        = self.module
    local ratio      = self.ratio
    local interspace = self.interspace
    local h          = self.height
    local xs         = mod*(6 + 3*ratio)
    local xgap       = xs + interspace
    local w          = xgap*(ns + 1) + xs -- (ns + 2)*xgap - interspace
    local ax, ay     = self.ax, self.ay
    local x0         = (tx or 0) - ax * w
    local y0         = (ty or 0) - ay * h
    local x1         = x0 + w
    local y1         = y0 + h
    local xpos       = x0
    local err
    err = canvas:start_bbox_group()
    assert(not err, err)
    local vbar = self._vbar
    -- start/stop symbol
    local term_vbar = vbar['*']
    -- draw start symbol
    err = canvas:encode_Vbar(term_vbar, xpos, y0, y1)
    assert(not err, err)
    for _, c in ipairs(code) do -- draw code symbols
        xpos = xpos + xgap
        local vb = vbar[c]
        err = canvas:encode_Vbar(vb, xpos, y0, y1)
        assert(not err, err)
    end
    -- draw stop symbol
    err = canvas:encode_Vbar(term_vbar, xpos + xgap, y0, y1)
    assert(not err, err)
    -- bounding box setting
    local qz = self.quietzone
    err = canvas:stop_bbox_group(x0 - qz, y0, x1 + qz, y1)
    assert(not err, err)
    -- check height as the minimum of 15% of length
    -- TODO: message could warn the user
    -- if 0.15 * w > h then
        -- message("The height of the barcode is to small")
    -- end
    if self.text_enabled then -- human readable text
        local chars; if self.text_star then
            chars = {"*"}
            for _, c in ipairs(code) do
                chars[#chars + 1] = c
            end
            chars[#chars + 1] = "*"
        else
            chars = {}
            for _, c in ipairs(code) do
                chars[#chars + 1] = c
            end
        end
        local Text = self._libgeo.Text
        local txt  = Text:from_chars(chars)
        -- setup text position
        local txt_vpos = self.text_vpos
        local txt_gap = self.text_gap
        local ypos, tay; if txt_vpos == "top" then  -- vertical setup
            ypos = y1 + txt_gap
            tay = 0.0
        elseif txt_vpos == "bottom" then
            ypos = y0 - txt_gap
            tay = 1.0
        else
            error("[IntenalErr] text vertical placement option is wrong")
        end
        local txt_hpos = self.text_hpos
        if txt_hpos == "spaced" then -- horizontal setup
            local xaxis = x0
            if not self.text_star then
                xaxis = xaxis + xgap
            end
            xaxis = xaxis + xs/2
            err = canvas:encode_Text_xspaced(txt, xaxis, xgap, ypos, tay)
            assert(not err, err)
        else
            local xpos, tax
            if txt_hpos == "left" then
                xpos = x0
                tax = 0.0
            elseif txt_hpos == "center" then
                xpos = (x1 + x0)/2
                tax = 0.5
            elseif txt_hpos == "right" then
                xpos = x1
                tax = 1.0
            else
                error("[InternalErr] wrong option for text_pos")
            end
            err = canvas:encode_Text(txt, xpos, ypos, tax, tay)
            assert(not err, err)
        end
    end
    return canvas
end

return Code39
--