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
|
if not modules then modules = { } end modules ['font-def'] = {
version = 1.001,
comment = "companion to font-ini.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
local concat = table.concat
local format, gmatch, match, find, lower, gsub = string.format, string.gmatch, string.match, string.find, string.lower, string.gsub
local tostring, next = tostring, next
local lpegmatch = lpeg.match
local allocate = utilities.storage.allocate
local trace_defining = false trackers .register("fonts.defining", function(v) trace_defining = v end)
local directive_embedall = false directives.register("fonts.embedall", function(v) directive_embedall = v end)
trackers.register("fonts.loading", "fonts.defining", "otf.loading", "afm.loading", "tfm.loading")
trackers.register("fonts.all", "fonts.*", "otf.*", "afm.*", "tfm.*")
local report_define = logs.new("define fonts")
local report_afm = logs.new("load afm")
--[[ldx--
<p>Here we deal with defining fonts. We do so by intercepting the
default loader that only handles <l n='tfm'/>.</p>
--ldx]]--
local fonts = fonts
local tfm = fonts.tfm
local vf = fonts.vf
fonts.used = allocate()
tfm.readers = tfm.readers or { }
tfm.fonts = allocate()
local readers = tfm.readers
local sequence = allocate { 'otf', 'ttf', 'afm', 'tfm' }
readers.sequence = sequence
tfm.version = 1.01
tfm.cache = containers.define("fonts", "tfm", tfm.version, false) -- better in font-tfm
tfm.autoprefixedafm = true -- this will become false some day (catches texnansi-blabla.*)
fonts.definers = fonts.definers or { }
local definers = fonts.definers
definers.specifiers = definers.specifiers or { }
local specifiers = definers.specifiers
specifiers.variants = allocate()
local variants = specifiers.variants
definers.method = "afm or tfm" -- afm, tfm, afm or tfm, tfm or afm
definers.methods = definers.methods or { }
local findbinfile = resolvers.findbinfile
--[[ldx--
<p>We hardly gain anything when we cache the final (pre scaled)
<l n='tfm'/> table. But it can be handy for debugging.</p>
--ldx]]--
fonts.version = 1.05
fonts.cache = containers.define("fonts", "def", fonts.version, false)
--[[ldx--
<p>We can prefix a font specification by <type>name:</type> or
<type>file:</type>. The first case will result in a lookup in the
synonym table.</p>
<typing>
[ name: | file: ] identifier [ separator [ specification ] ]
</typing>
<p>The following function split the font specification into components
and prepares a table that will move along as we proceed.</p>
--ldx]]--
-- beware, we discard additional specs
--
-- method:name method:name(sub) method:name(sub)*spec method:name*spec
-- name name(sub) name(sub)*spec name*spec
-- name@spec*oeps
local splitter, splitspecifiers = nil, ""
local P, C, S, Cc = lpeg.P, lpeg.C, lpeg.S, lpeg.Cc
local left = P("(")
local right = P(")")
local colon = P(":")
local space = P(" ")
definers.defaultlookup = "file"
local prefixpattern = P(false)
local function addspecifier(symbol)
splitspecifiers = splitspecifiers .. symbol
local method = S(splitspecifiers)
local lookup = C(prefixpattern) * colon
local sub = left * C(P(1-left-right-method)^1) * right
local specification = C(method) * C(P(1)^1)
local name = C((1-sub-specification)^1)
splitter = P((lookup + Cc("")) * name * (sub + Cc("")) * (specification + Cc("")))
end
local function addlookup(str,default)
prefixpattern = prefixpattern + P(str)
end
definers.addlookup = addlookup
addlookup("file")
addlookup("name")
addlookup("spec")
local function getspecification(str)
return lpegmatch(splitter,str)
end
definers.getspecification = getspecification
function definers.registersplit(symbol,action,verbosename)
addspecifier(symbol)
variants[symbol] = action
if verbosename then
variants[verbosename] = action
end
end
function definers.makespecification(specification, lookup, name, sub, method, detail, size)
size = size or 655360
if trace_defining then
report_define("%s -> lookup: %s, name: %s, sub: %s, method: %s, detail: %s",
specification, (lookup ~= "" and lookup) or "[file]", (name ~= "" and name) or "-",
(sub ~= "" and sub) or "-", (method ~= "" and method) or "-", (detail ~= "" and detail) or "-")
end
if not lookup or lookup == "" then
lookup = definers.defaultlookup
end
local t = {
lookup = lookup, -- forced type
specification = specification, -- full specification
size = size, -- size in scaled points or -1000*n
name = name, -- font or filename
sub = sub, -- subfont (eg in ttc)
method = method, -- specification method
detail = detail, -- specification
resolved = "", -- resolved font name
forced = "", -- forced loader
features = { }, -- preprocessed features
}
return t
end
function definers.analyze(specification, size)
-- can be optimized with locals
local lookup, name, sub, method, detail = getspecification(specification or "")
return definers.makespecification(specification, lookup, name, sub, method, detail, size)
end
--[[ldx--
<p>A unique hash value is generated by:</p>
--ldx]]--
local sortedhashkeys = table.sortedhashkeys
function tfm.hashfeatures(specification)
local features = specification.features
if features then
local t, tn = { }, 0
local normal = features.normal
if normal and next(normal) then
local f = sortedhashkeys(normal)
for i=1,#f do
local v = f[i]
if v ~= "number" and v ~= "features" then -- i need to figure this out, features
tn = tn + 1
t[tn] = v .. '=' .. tostring(normal[v])
end
end
end
local vtf = features.vtf
if vtf and next(vtf) then
local f = sortedhashkeys(vtf)
for i=1,#f do
local v = f[i]
tn = tn + 1
t[tn] = v .. '=' .. tostring(vtf[v])
end
end
--~ if specification.mathsize then
--~ tn = tn + 1
--~ t[tn] = "mathsize=" .. specification.mathsize
--~ end
if tn > 0 then
return concat(t,"+")
end
end
return "unknown"
end
fonts.designsizes = allocate()
--[[ldx--
<p>In principle we can share tfm tables when we are in node for a font, but then
we need to define a font switch as an id/attr switch which is no fun, so in that
case users can best use dynamic features ... so, we will not use that speedup. Okay,
when we get rid of base mode we can optimize even further by sharing, but then we
loose our testcases for <l n='luatex'/>.</p>
--ldx]]--
function tfm.hashinstance(specification,force)
local hash, size, fallbacks = specification.hash, specification.size, specification.fallbacks
if force or not hash then
hash = tfm.hashfeatures(specification)
specification.hash = hash
end
if size < 1000 and fonts.designsizes[hash] then
size = math.round(tfm.scaled(size,fonts.designsizes[hash]))
specification.size = size
end
--~ local mathsize = specification.mathsize or 0
--~ if mathsize > 0 then
--~ local textsize = specification.textsize
--~ if fallbacks then
--~ return hash .. ' @ ' .. tostring(size) .. ' [ ' .. tostring(mathsize) .. ' : ' .. tostring(textsize) .. ' ] @ ' .. fallbacks
--~ else
--~ return hash .. ' @ ' .. tostring(size) .. ' [ ' .. tostring(mathsize) .. ' : ' .. tostring(textsize) .. ' ]'
--~ end
--~ else
if fallbacks then
return hash .. ' @ ' .. tostring(size) .. ' @ ' .. fallbacks
else
return hash .. ' @ ' .. tostring(size)
end
--~ end
end
--[[ldx--
<p>We can resolve the filename using the next function:</p>
--ldx]]--
definers.resolvers = definers.resolvers or { }
local resolvers = definers.resolvers
-- todo: reporter
function resolvers.file(specification)
local suffix = file.suffix(specification.name)
if fonts.formats[suffix] then
specification.forced = suffix
specification.name = file.removesuffix(specification.name)
end
end
function resolvers.name(specification)
local resolve = fonts.names.resolve
if resolve then
local resolved, sub = fonts.names.resolve(specification.name,specification.sub)
specification.resolved, specification.sub = resolved, sub
if resolved then
local suffix = file.suffix(resolved)
if fonts.formats[suffix] then
specification.forced = suffix
specification.name = file.removesuffix(resolved)
else
specification.name = resolved
end
end
else
resolvers.file(specification)
end
end
function resolvers.spec(specification)
local resolvespec = fonts.names.resolvespec
if resolvespec then
specification.resolved, specification.sub = fonts.names.resolvespec(specification.name,specification.sub)
if specification.resolved then
specification.forced = file.extname(specification.resolved)
specification.name = file.removesuffix(specification.resolved)
end
else
resolvers.name(specification)
end
end
function definers.resolve(specification)
if not specification.resolved or specification.resolved == "" then -- resolved itself not per se in mapping hash
local r = resolvers[specification.lookup]
if r then
r(specification)
end
end
if specification.forced == "" then
specification.forced = nil
else
specification.forced = specification.forced
end
-- for the moment here (goodies set outside features)
local goodies = specification.goodies
if goodies and goodies ~= "" then
local normalgoodies = specification.features.normal.goodies
if not normalgoodies or normalgoodies == "" then
specification.features.normal.goodies = goodies
end
end
--
specification.hash = lower(specification.name .. ' @ ' .. tfm.hashfeatures(specification))
if specification.sub and specification.sub ~= "" then
specification.hash = specification.sub .. ' @ ' .. specification.hash
end
return specification
end
--[[ldx--
<p>The main read function either uses a forced reader (as determined by
a lookup) or tries to resolve the name using the list of readers.</p>
<p>We need to cache when possible. We do cache raw tfm data (from <l
n='tfm'/>, <l n='afm'/> or <l n='otf'/>). After that we can cache based
on specificstion (name) and size, that is, <l n='tex'/> only needs a number
for an already loaded fonts. However, it may make sense to cache fonts
before they're scaled as well (store <l n='tfm'/>'s with applied methods
and features). However, there may be a relation between the size and
features (esp in virtual fonts) so let's not do that now.</p>
<p>Watch out, here we do load a font, but we don't prepare the
specification yet.</p>
--ldx]]--
function tfm.read(specification)
local hash = tfm.hashinstance(specification)
local tfmtable = tfm.fonts[hash] -- hashes by size !
if not tfmtable then
local forced = specification.forced or ""
if forced ~= "" then
local reader = readers[lower(forced)]
tfmtable = reader and reader(specification)
if not tfmtable then
report_define("forced type %s of %s not found",forced,specification.name)
end
else
for s=1,#sequence do -- reader sequence
local reader = sequence[s]
if readers[reader] then -- not really needed
if trace_defining then
report_define("trying (reader sequence driven) type %s for %s with file %s",reader,specification.name,specification.filename or "unknown")
end
tfmtable = readers[reader](specification)
if tfmtable then
break
else
specification.filename = nil
end
end
end
end
if tfmtable then
if directive_embedall then
tfmtable.embedding = "full"
elseif tfmtable.filename and fonts.dontembed[tfmtable.filename] then
tfmtable.embedding = "no"
else
tfmtable.embedding = "subset"
end
tfm.fonts[hash] = tfmtable
fonts.designsizes[specification.hash] = tfmtable.designsize -- we only know this for sure after loading once
--~ tfmtable.mode = specification.features.normal.mode or "base"
end
end
if not tfmtable then
report_define("font with asked name '%s' is not found using lookup '%s'",specification.name,specification.lookup)
end
return tfmtable
end
--[[ldx--
<p>For virtual fonts we need a slightly different approach:</p>
--ldx]]--
function tfm.readanddefine(name,size) -- no id
local specification = definers.analyze(name,size)
local method = specification.method
if method and variants[method] then
specification = variants[method](specification)
end
specification = definers.resolve(specification)
local hash = tfm.hashinstance(specification)
local id = definers.registered(hash)
if not id then
local tfmdata = tfm.read(specification)
if tfmdata then
tfmdata.hash = hash
id = font.define(tfmdata)
definers.register(tfmdata,id)
tfm.cleanuptable(tfmdata)
else
id = 0 -- signal
end
end
return fonts.identifiers[id], id
end
--[[ldx--
<p>Next follow the readers. This code was written while <l n='luatex'/>
evolved. Each one has its own way of dealing with its format.</p>
--ldx]]--
local function check_tfm(specification,fullname)
-- ofm directive blocks local path search unless set; btw, in context we
-- don't support ofm files anyway as this format is obsolete
local foundname = findbinfile(fullname, 'tfm') or "" -- just to be sure
if foundname == "" then
foundname = findbinfile(fullname, 'ofm') or "" -- bonus for usage outside context
end
if foundname == "" then
foundname = fonts.names.getfilename(fullname,"tfm")
end
if foundname ~= "" then
specification.filename, specification.format = foundname, "ofm"
return tfm.read_from_tfm(specification)
end
end
local function check_afm(specification,fullname)
local foundname = findbinfile(fullname, 'afm') or "" -- just to be sure
if foundname == "" then
foundname = fonts.names.getfilename(fullname,"afm")
end
if foundname == "" and tfm.autoprefixedafm then
local encoding, shortname = match(fullname,"^(.-)%-(.*)$") -- context: encoding-name.*
if encoding and shortname and fonts.enc.known[encoding] then
shortname = findbinfile(shortname,'afm') or "" -- just to be sure
if shortname ~= "" then
foundname = shortname
if trace_loading then
report_afm("stripping encoding prefix from filename %s",afmname)
end
end
end
end
if foundname ~= "" then
specification.filename, specification.format = foundname, "afm"
return tfm.read_from_afm(specification)
end
end
function readers.tfm(specification)
local fullname, tfmtable = specification.filename or "", nil
if fullname == "" then
local forced = specification.forced or ""
if forced ~= "" then
tfmtable = check_tfm(specification,specification.name .. "." .. forced)
end
if not tfmtable then
tfmtable = check_tfm(specification,specification.name)
end
else
tfmtable = check_tfm(specification,fullname)
end
return tfmtable
end
function readers.afm(specification,method)
local fullname, tfmtable = specification.filename or "", nil
if fullname == "" then
local forced = specification.forced or ""
if forced ~= "" then
tfmtable = check_afm(specification,specification.name .. "." .. forced)
end
if not tfmtable then
method = method or definers.method or "afm or tfm"
if method == "tfm" then
tfmtable = check_tfm(specification,specification.name)
elseif method == "afm" then
tfmtable = check_afm(specification,specification.name)
elseif method == "tfm or afm" then
tfmtable = check_tfm(specification,specification.name) or check_afm(specification,specification.name)
else -- method == "afm or tfm" or method == "" then
tfmtable = check_afm(specification,specification.name) or check_tfm(specification,specification.name)
end
end
else
tfmtable = check_afm(specification,fullname)
end
return tfmtable
end
function readers.pfb(specification,method) -- only called when forced
local original = specification.specification
if trace_loading then
report_afm("using afm reader for '%s'",original)
end
specification.specification = gsub(original,"%.pfb",".afm")
specification.forced = "afm"
return readers.afm(specification,method)
end
-- maybe some day a set of names
local function check_otf(forced,specification,suffix,what)
local name = specification.name
if forced then
name = file.addsuffix(name,suffix,true)
end
local fullname, tfmtable = findbinfile(name,suffix) or "", nil -- one shot
-- if false then -- can be enabled again when needed
-- if fullname == "" then
-- local fb = fonts.names.old_to_new[name]
-- if fb then
-- fullname = findbinfile(fb,suffix) or ""
-- end
-- end
-- if fullname == "" then
-- local fb = fonts.names.new_to_old[name]
-- if fb then
-- fullname = findbinfile(fb,suffix) or ""
-- end
-- end
-- end
if fullname == "" then
fullname = fonts.names.getfilename(name,suffix)
end
if fullname ~= "" then
specification.filename, specification.format = fullname, what -- hm, so we do set the filename, then
tfmtable = tfm.read_from_otf(specification) -- we need to do it for all matches / todo
end
return tfmtable
end
function readers.opentype(specification,suffix,what)
local forced = specification.forced or ""
if forced == "otf" then
return check_otf(true,specification,forced,"opentype")
elseif forced == "ttf" or forced == "ttc" or forced == "dfont" then
return check_otf(true,specification,forced,"truetype")
else
return check_otf(false,specification,suffix,what)
end
end
function readers.otf (specification) return readers.opentype(specification,"otf","opentype") end
function readers.ttf (specification) return readers.opentype(specification,"ttf","truetype") end
function readers.ttc (specification) return readers.opentype(specification,"ttf","truetype") end -- !!
function readers.dfont(specification) return readers.opentype(specification,"ttf","truetype") end -- !!
--[[ldx--
<p>We need to check for default features. For this we provide
a helper function.</p>
--ldx]]--
function definers.check(features,defaults) -- nb adapts features !
local done = false
if features and next(features) then
for k,v in next, defaults do
if features[k] == nil then
features[k], done = v, true
end
end
else
features, done = table.fastcopy(defaults), true
end
return features, done -- done signals a change
end
--[[ldx--
<p>So far the specifiers. Now comes the real definer. Here we cache
based on id's. Here we also intercept the virtual font handler. Since
it evolved stepwise I may rewrite this bit (combine code).</p>
In the previously defined reader (the one resulting in a <l n='tfm'/>
table) we cached the (scaled) instances. Here we cache them again, but
this time based on id. We could combine this in one cache but this does
not gain much. By the way, passing id's back to in the callback was
introduced later in the development.</p>
--ldx]]--
local lastdefined = nil -- we don't want this one to end up in s-tra-02
local internalized = { }
function definers.current() -- or maybe current
return lastdefined
end
function definers.register(tfmdata,id) -- will be overloaded
if tfmdata and id then
local hash = tfmdata.hash
if not internalized[hash] then
if trace_defining then
report_define("registering font, id: %s, hash: %s",id or "?",hash or "?")
end
fonts.identifiers[id] = tfmdata
internalized[hash] = id
end
end
end
function definers.registered(hash) -- will be overloaded
local id = internalized[hash]
return id, id and fonts.identifiers[id]
end
local cache_them = false
function tfm.make(specification)
-- currently fonts are scaled while constructing the font, so we
-- have to do scaling of commands in the vf at that point using
-- e.g. "local scale = g.factor or 1" after all, we need to work
-- with copies anyway and scaling needs to be done at some point;
-- however, when virtual tricks are used as feature (makes more
-- sense) we scale the commands in fonts.tfm.scale (and set the
-- factor there)
local fvm = definers.methods.variants[specification.features.vtf.preset]
if fvm then
return fvm(specification)
else
return nil
end
end
function definers.read(specification,size,id) -- id can be optional, name can already be table
statistics.starttiming(fonts)
if type(specification) == "string" then
specification = definers.analyze(specification,size)
end
local method = specification.method
if method and variants[method] then
specification = variants[method](specification)
end
specification = definers.resolve(specification)
local hash = tfm.hashinstance(specification)
if cache_them then
local tfmdata = containers.read(fonts.cache,hash) -- for tracing purposes
end
local tfmdata = definers.registered(hash) -- id
if not tfmdata then
if specification.features.vtf and specification.features.vtf.preset then
tfmdata = tfm.make(specification)
else
tfmdata = tfm.read(specification)
if tfmdata then
tfm.checkvirtualid(tfmdata)
end
end
if cache_them then
tfmdata = containers.write(fonts.cache,hash,tfmdata) -- for tracing purposes
end
if tfmdata then
tfmdata.hash = hash
tfmdata.cache = "no"
if id then
definers.register(tfmdata,id)
end
end
end
lastdefined = tfmdata or id -- todo ! ! ! ! !
if not tfmdata then -- or id?
report_define( "unknown font %s, loading aborted",specification.name)
elseif trace_defining and type(tfmdata) == "table" then
report_define("using %s font with id %s, name:%s size:%s bytes:%s encoding:%s fullname:%s filename:%s",
tfmdata.type or "unknown",
id or "?",
tfmdata.name or "?",
tfmdata.size or "default",
tfmdata.encodingbytes or "?",
tfmdata.encodingname or "unicode",
tfmdata.fullname or "?",
file.basename(tfmdata.filename or "?"))
end
statistics.stoptiming(fonts)
return tfmdata
end
function vf.find(name)
name = file.removesuffix(file.basename(name))
if tfm.resolvevirtualtoo then
local format = fonts.logger.format(name)
if format == 'tfm' or format == 'ofm' then
if trace_defining then
report_define("locating vf for %s",name)
end
return findbinfile(name,"ovf")
else
if trace_defining then
report_define("vf for %s is already taken care of",name)
end
return nil -- ""
end
else
if trace_defining then
report_define("locating vf for %s",name)
end
return findbinfile(name,"ovf")
end
end
--[[ldx--
<p>We overload both the <l n='tfm'/> and <l n='vf'/> readers.</p>
--ldx]]--
callbacks.register('define_font' , definers.read, "definition of fonts (tfmtable preparation)")
callbacks.register('find_vf_file', vf.find, "locating virtual fonts, insofar needed") -- not that relevant any more
|