summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/barracuda/lib/lib-barcode/barcode.lua
blob: ed6204528a79b506133fbf3ca45576a7c787a045 (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
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

-- Barcode abstract class
-- Copyright (C) 2019 Roberto Giacomelli
-- Please see LICENSE.TXT for any legal information about present software

local Barcode = {
    _VERSION     = "Barcode v0.0.5",
    _NAME        = "Barcode",
    _DESCRIPTION = "Barcode abstract class",
}
Barcode.__index = Barcode

-- barcode_type/submodule name
Barcode._available_enc = {-- keys must be lowercase
    code39  = "lib-barcode.code39",
    code128 = "lib-barcode.code128",
    ean     = "lib-barcode.ean",
    i2of5   = "lib-barcode.i2of5", -- Interleaved 2 of 5
}
Barcode._builder_instances = {} -- encoder builder instances repository

-- common parameters to all the barcode objects
Barcode._super_par_def = {}
local pardef = Barcode._super_par_def

-- set an Anchor point (ax, ay) relatively to the barcode bounding box
-- without considering any text object
-- ax = 0, ay = 0 is the lower left corner of the symbol
-- ax = 1, ay = 1 is the upper right corner of the symbol
Barcode.ax = 0.0
pardef.ax = {
    default = 0.0,
    unit = "sp", -- scaled point
    isReserved = false,
    order = 1,
    fncheck = function (self, ax, _) --> boolean, err
        if ax >= 0.0 and ax <= 1.0 then return true, nil end
        return false, "[OutOfRange] 'ax' out of [0, 1] interval"
    end,
}
Barcode.ay = 0.0
pardef.ay = {
    default = 0.0,
    unit = "sp", -- scaled point
    isReserved = false,
    order = 2,
    fncheck = function (self, ay, _) --> boolean, err
        if ay >= 0.0 and ay <= 1.0 then return true, nil end
        return false, "[OutOfRange] 'ay' out of [0, 1] interval"
    end,
}

-- Barcode.bbox_to_quietzone -- under assessment

-- Barcode methods

-- stateless iterator troughtout the ordered parameters collection
local function p_iter(state, i)
    i = i + 1
    local t = state[i]
    if t then
        return i, t
    end
end

-- main iterator on parameter definitions
function Barcode:param_ord_iter()
    local state = {}
    -- append family parameter
    local p2_family  = self._par_def -- base family parameters
    local fam_len = 0
    if p2_family then
        for pname, pdef in pairs(p2_family) do
            state[pdef.order] = {
                pname   = pname,
                pdef    = pdef,
                isSuper = false,
            }
            fam_len = fam_len + 1
        end
        assert(fam_len == #state)
    end
    -- append the variant parameters
    local var_len = 0
    local var = self._variant
    if var then -- specific variant parameters
        local p2_variant = assert(self._par_def_variant[var])
        for pname, pdef in pairs(p2_variant) do
            if state[pname] then
                error("[InternalErr] overriding paramenter '"..pname.."'")
            end
            state[pdef.order + fam_len] = {
                pname   = pname,
                pdef    = pdef,
                isSuper = false,
            }
            var_len = var_len + 1
        end
        assert(fam_len + var_len == #state)
    end
    -- append the super class parameter to the iterator state
    local p1 = self._super_par_def
    local super_len = 0
    for pname, pdef in pairs(p1) do
        if state[pname] then
            error("[InternalError] overriding paramenter name '"..pname.."'")
        end
        state[fam_len + var_len + pdef.order] = {
            pname = pname,
            pdef  = pdef,
            isSuper = true,
        }
        super_len = super_len + 1
    end
    assert(super_len + fam_len + var_len == #state)
    return p_iter, state, 0
end

-- encoder costructor
-- Symbology can be a family with many variants. This is represented by the
-- first argument 'bc_type' formatted as <family>-<variant>.
--     in more details:
--     <family id><dash char><variant id> if there are variants
--     <encoder id> if not
-- i.e. when 'bc_type' is the string "ean-13", "ean" is the barcode family and
-- "13" is its variant name.
-- For whose barcodes that do not have variants, 'bc_type' is simply the endoder id
-- such as "code128".
-- 'id_enc' is an optional identifier useful to retrive an encoder reference later
-- 'opt'    is an optional table with the user-defined parameters setting up encoders
--
function Barcode:new_encoder(bc_type, id_enc, opt) --> object, err
    -- argument checking
    if type(bc_type) ~= "string" then
        return nil, "[ArgErr] 'bc_type' is not a string"
    end
    local pdash = string.find(bc_type, "-")
    local family, variant
    if pdash then
        family  = string.sub(bc_type, 1, pdash - 1)
        variant = string.sub(bc_type, pdash + 1)
    else
        family = bc_type
    end
    local av_enc = self._available_enc
    if not av_enc[family] then -- is the barcode type a real module?
        return nil, "[Err] barcode type '"..family.."' not found"
    end
    if id_enc == nil then
        id_enc = (variant or "") .. "_noname"
    elseif type(id_enc) ~= "string" then
        return nil, "[ArgErr] provided 'id_enc' is not a string"
    end
    if type(opt) == "table" or opt == nil then
        opt = opt or {}
    else
        return nil, "[ArgErr] provided 'opt' is wrong"
    end
    local tenc = self._builder_instances
    local builder;
    if tenc[family] then -- is the encoder builder already loaded?
        builder = tenc[family]
    else -- loading the encoder builder
        local mod_path = av_enc[family]
        builder = require(mod_path)
        tenc[family] = assert(builder, "[InternalErr] module not found!")
        builder._enc_instances = {}
    end
    if builder._enc_instances[id_enc] then
        return nil, "[Err] 'id_enc' already present"
    end
    local enc = {} -- the new encoder
    enc.__index = enc
    enc._variant = variant
    setmetatable(enc, {
        __index = function(_, k)
            if builder[k] ~= nil then
                return builder[k]
            end
            return self[k]
        end
    })
    builder._enc_instances[id_enc] = enc
    -- param defition
    for _, tpar in enc:param_ord_iter() do
        local pname   = tpar.pname
        local pdef    = tpar.pdef
        local isSuper = tpar.isSuper
        local val = opt[pname] -- param = val
        if val ~= nil then
            local ok, err = pdef:fncheck(val, enc)
            if ok then
                enc[pname] = val
            else -- error!
                return nil, err
            end
        else
            -- load the default value of <pname>
            local def_val; if pdef.fndefault then
                def_val = pdef:fndefault(enc)
            else
                def_val = pdef.default
            end
            if not isSuper then
                enc[pname] = def_val
            end
        end
    end
    if enc.config then -- this must be called after the parameter definition
        enc:config(variant)
    end
    return enc, nil
end

-- retrive encoder object already created
-- 'name' is optional in case you didn't assign one to the encoder
function Barcode:enc_by_name(bc_type, name) --> <encoder object>, <err>
    if type(bc_type) ~= "string" then
        return nil, "[ArgErr] 'bc_type' must be a string"
    end
    local pdash = string.find(bc_type, "-")
    local family, variant
    if pdash then
        family  = string.sub(bc_type, 1, pdash - 1)
        variant = string.sub(bc_type, pdash + 1)
    else
        family = bc_type
    end
    local av_enc = self._available_enc
    if not av_enc[family] then -- is the barcode type a real module?
        return nil, "[Err] barcode type '"..family.."' not found"
    end
    local builder = self._builder_instances[family]
    if builder == nil then
        return nil, "[Err] enc builder '"..family.."' not loaded, use 'new_encoder()' method"
    end
    if name == nil then
        name = (variant or "") .. "_noname"
    elseif type(name) ~= "string" then
        return nil, "[ArgErr] 'name' must be a string"
    end
    local repo = builder._enc_instances
    local enc = repo[name]
    if enc == nil then
        return nil, "[Err] encoder '"..name.."' not found"
    else
        return enc, nil
    end
end

-- base constructors common to all the encoders
-- for numeric only simbology
function Barcode:_check_char(c) --> elem, err
    if type(c) ~= "string" or #c ~= 1 then
        return nil, "[InternalErr] invalid char"
    end
    local n = string.byte(c) - 48
    if n < 0 or n > 9 then
        return nil, "[ArgErr] found a not digit char"
    end
    return n, nil
end
function Barcode:_check_digit(n) --> elem, err
    if type(n) ~= "number" then
        return nil, "[InternalErr] not a number"
    end
    if n < 0 or n > 9 then
        return nil, "[InternalErr] not a digit"
    end
    return n, nil
end

-- not empty string --> Barcode object
function Barcode:from_string(symb, opt) --> object, err
    assert(self._check_char, "[InternalErr] undefined _check_char() method")
    if type(symb) ~= "string" then
        return nil, "[ArgErr] 'symb' is not a string"
    end
    if #symb == 0 then
        return nil, "[ArgErr] 'symb' is an empty string"
    end
    local chars = {}
    local len = 0
    for c in string.gmatch(symb, ".") do
        local elem, err = self:_check_char(c)
        if err then
            return nil, err
        else
            chars[#chars+1] = elem
            len = len + 1
        end
    end
    -- build the barcode object
    local o = {
        _code_data = chars, -- array of chars
        _code_len = len, -- symbol lenght
    }
    setmetatable(o, self)
    if opt ~= nil then
        if type(opt) ~= "table" then
            return nil, "[ArgErr] 'opt' is not a table"
        else
            local ok, err = o:set_param(opt)
            if not ok then
                return nil, err
            end
        end
    end
    if o._finalize then
        local ok, e = o:_finalize()
        if not ok then return nil, e end
    end
    return o, nil
end

-- positive integer --> Barcode object
function Barcode:from_uint(n, opt) --> object, err
    assert(self._check_digit, "[InternalErr] undefined _check_digit() method")
    if type(n) ~= "number" then return nil, "[ArgErr] 'n' is not a number" end
    if n < 0 then return nil, "[ArgErr] 'n' must be a positive integer" end
    if n - math.floor(n) ~= 0 then
        return nil, "[ArgErr] 'n' is not an integer"
    end
    if opt ~= nil and type(opt) ~= "table" then
        return nil, "[ArgErr] 'opt' is not a table"
    end
    local digits = {}
    local i = 0
    if n == 0 then
        local elem, err = self:_check_digit(0)
        if err then
            return nil, err
        end
        digits[1] = elem
        i = 1
    else
        while n > 0 do
            local d = n % 10
            i = i + 1
            local elem, err = self:_check_digit(d)
            if err then
                return nil, err
            end
            digits[i] = elem
            n = (n - d) / 10
        end
        for k = 1, i/2  do -- reverse the array
            local d = digits[k]
            local h = i - k + 1
            digits[k] = digits[h]
            digits[h] = d
        end
    end
    -- build the barcode object
    local o = {
        _code_data = digits, -- array of digits
        _code_len = i, -- symbol lenght
    }
    setmetatable(o, self)
    if opt ~= nil then
        if type(opt) ~= "table" then
            return nil, "[ArgErr] 'opt' is not a table"
        else
            local ok, err = o:set_param(opt)
            if not ok then
                return nil, err
            end
        end
    end
    if o._finalize then
        local ok, e = o:_finalize()
        if not ok then return nil, e end
    end
    return o, nil
end

-- check a parameter set
-- this method check also reserved parameter
-- argments: {k=v, ...}, "default" | "current"
-- if ref is "default" parameters are checked with default values
-- if ref is "current" parameters are checked with current values
function Barcode:check_param(opt, ref) --> boolean, check report
    if type(opt) ~= "table" then
        return nil, "[ArgErr] opt is not a table"
    end
    if ref == nil then
        ref = "current"
    else
        if type(ref) ~= "string" then
            return nil, "[ArgErr] ref is not a string"
        end
        if (ref ~= "current") or (ref ~= "default") then
            return nil, "[ArgErr] ref can only be 'default' or 'current'"
        end
    end
    -- checking process
    local cktab  = {}
    local isOk   = true
    local err_rpt -- nil if no error
    for _, tpar in self:param_ord_iter() do
        local pname = tpar.pname
        local pdef  = tpar.pdef
        -- load the default value of <pname>
        local def_val; if pdef.fndefault then
            def_val = pdef:fndefault(cktab)
        else
            def_val = pdef.default
        end
        local val = opt[pname]
        if val ~= nil then
            local ok, err = pdef:fncheck(val, cktab)
            if ok then
                cktab[pname] = val
            else -- error!
                isOk = false
                if err_rpt == nil then err_rpt = {} end
                err_rpt[#err_rpt + 1] = {
                    param       = pname,
                    checked_val = val,
                    default_val = def_val,
                    isOk        = ok,
                    err         = err,
                }
            end
        end
        local v
        if ref == "current" then
            v = self[pname]
        else
            v = def_val
        end
        cktab[pname] = v
    end
    return isOk, err_rpt
end

-- restore to the default values all the parameter
-- (reserved parameters are unmodified so no need to restore it)
-- this need further investigation about the conseguence of a restore
-- that reset the parameter but "locally"
-- so this method must be considered experimental
function Barcode:restore_param() --> self :FIXME:
    for _, par in ipairs(self._par_id) do
        local pdef = self[par.."_def"]
        if not pdef.isReserved then
            self[par] = pdef.default
        end
    end
    return self
end

-- create a table with the information of the current barcode encoder
function Barcode:info() --> table
    local info = {
        name        = self._NAME,
        version     = self._VERSION,
        description = self._DESCRIPTION,
        param       = {},
    }
    local tpar   = info.param
    for _, pardef in self:param_ord_iter() do
        local id   = pardef.pname
        local pdef = pardef.pdef
        tpar[#tpar + 1] = {
            name       = id,
            descr      = nil, -- TODO:
            value      = self[id],
            isReserved = pdef.isReserved,
            unit       = pdef.unit,
        }
    end
    return info
end

-- make accessible by name parameter values
-- id: parameter identifier
function Barcode:get_param(id) --> value, err
    if type(id) ~= "string" then
        return nil, "[ArgErr] 'id' must be a string"
    end
    local pardef = self._par_def
    if not pardef[id] then
        return nil, "[Err] Parameter '"..id.."' doesn't exist"
    end
    local res = assert(self[id], "[InternalErr] parameter value unreachable")
    return res, nil
end

-- set a barcode parameter only if it is not reserved
-- arguments:
-- :set_param{key = value, key = value, ...}
-- :set_param(key, value)
function Barcode:set_param(arg1, arg2) --> boolean, err
    -- processing arguments
    local targ
    local isPair = true
    if type(arg1) == "table" then
        if arg2 ~= nil then
            return false, "[ArgErr] Further arguments not allowed"
        end
        targ = arg1
        isPair = false
    elseif type(arg1) == "string" then -- key/value
        if arg2 == nil then
            return false, "[ArgErr] 'value' as the second argument expected"
        end
        targ = {}
        targ[arg1] = arg2
    else
        return false, "[ArgErr] param name must be a string"
    end
    -- preparing to the checking process
    local cktab  = {}
    local ckparam = {}
    -- checking process
    for _, tpar in self:param_ord_iter() do
        local pname = tpar.pname
        local pdef  = tpar.pdef
        local val = targ[pname] -- par = val
        if val ~= nil then
            if pdef.isReserved then
                return false, "[Err] parameter '" .. pname ..
                    "' is reserved, create another encoder"
            end
            local ok, err = pdef:fncheck(val, cktab)
            if ok then
                cktab[pname] = val
                ckparam[pname] = val
            else -- error!
                return false, err
            end
        else -- no val in user option
            cktab[pname] = self[pname]
        end
    end
    for p, v in pairs(ckparam) do
        self[p] = v
    end
    return true, nil
end

return Barcode

--