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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
|
if not modules then modules = { } end modules ['grph-inc'] = {
version = 1.001,
comment = "companion to grph-inc.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- lowercase types
-- mps tex tmp svg
-- partly qualified
-- dimensions
-- consult rlx
-- figures.boxnumber can go as we now can use names
--[[
The ConTeXt figure inclusion mechanisms are among the oldest code
in ConTeXt and evolve dinto a complex whole. One reason is that we
deal with backend in an abstract way. What complicates matters is
that we deal with internal graphics as well: TeX code, MetaPost code,
etc. Later on figure databases were introduced, which resulted in
a plug in model for locating images. On top of that runs a conversion
mechanism (with caching) and resource logging.
Porting that to Lua is not that trivial because quite some
status information is kept between al these stages. Of course, image
reuse also has some price, and so I decided to implement the graphics
inclusion in several layers: detection, loading, inclusion, etc.
Object sharing and scaling can happen at each stage, depending on the
way the resource is dealt with.
The TeX-Lua mix is suboptimal. This has to do with the fact that we cannot
run TeX code from within Lua. Some more functionality will move to Lua.
]]--
local format, lower, find, match, gsub, gmatch = string.format, string.lower, string.find, string.match, string.gsub, string.gmatch
local texsprint, texbox = tex.sprint, tex.box
local contains = table.contains
local concat = table.concat
local todimen = string.todimen
local ctxcatcodes = tex.ctxcatcodes
local variables = interfaces.variables
local trace_figures = false trackers.register("figures.locating", function(v) trace_figures = v end)
local trace_bases = false trackers.register("figures.bases", function(v) trace_bases = v end)
local trace_programs = false trackers.register("figures.programs", function(v) trace_programs = v end)
local trace_conversion = false trackers.register("figures.conversion", function(v) trace_conversion = v end)
local trace_inclusion = false trackers.register("figures.inclusion", function(v) trace_inclusion = v end)
--- some extra img functions ---
local imgkeys = img.keys()
function img.totable(imgtable)
local result = { }
for k=1,#imgkeys do
local key = imgkeys[k]
result[key] = imgtable[key]
end
return result
end
function img.serialize(i)
return table.serialize(img.totable(i))
end
function img.clone(i,data)
i.width = data.width or i.width
i.height = data.height or i.height
-- attr etc
return i
end
local validsizes = table.tohash(img.boxes())
local validtypes = table.tohash(img.types())
function img.check_size(size)
if size then
size = gsub(size,"box","")
return (validsizes[size] and size) or "crop"
else
return "crop"
end
end
---
figures = figures or { }
figures.loaded = figures.loaded or { }
figures.used = figures.used or { }
figures.found = figures.found or { }
figures.suffixes = figures.suffixes or { }
figures.patterns = figures.patterns or { }
figures.boxnumber = figures.boxnumber or 0
figures.defaultsearch = true
figures.defaultwidth = 0
figures.defaultheight = 0
figures.defaultdepth = 0
figures.n = 0
figures.prefer_quality = true -- quality over location
figures.localpaths = {
".", "..", "../.."
}
figures.cachepaths = {
prefix = "",
path = ".",
subpath = ".",
}
figures.paths = table.copy(figures.localpaths)
figures.order = {
"pdf", "mps", "jpg", "png", "jbig", "svg", "eps", "gif", "mov", "buffer", "tex",
}
figures.formats = {
["pdf"] = { list = { "pdf" } },
["mps"] = { patterns = { "mps", "%d+" } },
["jpg"] = { list = { "jpg", "jpeg" } },
["png"] = { list = { "png" } },
["jbig"] = { list = { "jbig", "jbig2", "jb2" } },
["svg"] = { list = { "svg", "svgz" } },
["eps"] = { list = { "eps", "ai" } },
["gif"] = { list = { "gif" } },
["mov"] = { list = { "mov", "avi" } },
["buffer"] = { list = { "tmp", "buffer", "buf" } },
["tex"] = { list = { "tex" } },
}
function figures.setlookups()
figures.suffixes, figures.patterns = { }, { }
for _, format in pairs(figures.order) do
local data = figures.formats[format]
local fs, fp = figures.suffixes, figures.patterns
if data.list then
for _, s in ipairs(data.list) do
fs[s] = format -- hash
end
else
fs[format] = format
end
if data.patterns then
for _, s in ipairs(data.patterns) do
fp[#fp+1] = { s, format } -- array
end
end
end
end
figures.setlookups()
local function register(tag,target,what)
local data = figures.formats[target] -- resolver etc
if not data then
data = { }
figures.formats[target] = data
end
local d = data[tag] -- list or pattern
if d and not contains(d,what) then
d[#d+1] = what -- suffix or patternspec
else
data[tag] = { what }
end
if not contains(figures.order,target) then
figures.order[#figures.order+1] = target
end
figures.setlookups()
end
function figures.registersuffix (suffix, target) register('list', target,suffix ) end
function figures.registerpattern(pattern,target) register('pattern',target,pattern) end
local last_locationset, last_pathlist = last_locationset or nil, last_pathlist or nil
function figures.setpaths(locationset,pathlist)
if last_locationset == locationset and last_pathlist == pathlist then
-- this function can be called each graphic so we provide this optimization
return
end
local iv, t, h = interfaces.variables, figures.paths, locationset:tohash()
if last_locationset ~= locationset then
-- change == reset (actually, a 'reset' would indeed reset
if h[iv["local"]] then
t = table.fastcopy(figures.localpaths or { })
else
t = { }
end
figures.defaultsearch = h[iv["default"]]
last_locationset = locationset
end
if h[iv["global"]] then
-- for s in gmatch(pathlist,",* *([^,]+)") do
for _, s in ipairs(aux.settings_to_array(pathlist)) do
if not contains(t,s) then
t[#t+1] = s
end
end
end
figures.paths, last_pathlist = t, pathlist
if trace_figures then
commands.writestatus("figures","locations: %s",last_locationset)
commands.writestatus("figures","path list: %s",concat(figures.paths, " "))
end
end
-- check conversions and handle it here
--~ local keys = img.keys()
--~ function figures.hash(data)
--~ local i = data.status.private
--~ local t = { }
--~ for _, v in ipairs(keys) do
--~ local iv = i[v]
--~ if iv then
--~ t[#t+1] = v .. '=' .. iv
--~ end
--~ end
--~ return table.concat(t,"+")
--~ end
function figures.hash(data)
return data.status.hash or tostring(data.status.private) -- the <img object>
-- return data.status.fullname .. "+".. (data.status.page or data.request.page or 1) -- img is still not perfect
end
-- interfacing to tex
do
local figuredata = { }
local callstack = { }
function figures.new()
figuredata = {
request = {
name = false,
label = false,
format = false,
page = false,
width = false,
height = false,
preview = false,
["repeat"] = false,
controls = false,
display = false,
conversion = false,
cache = false,
prefix = false,
size = false,
},
used = {
fullname = false,
format = false,
name = false,
path = false,
suffix = false,
width = false,
height = false,
},
status = {
status = 0,
converted = false,
cached = false,
fullname = false,
format = false,
},
}
return figuredata
end
function figures.push(request)
local ncs = #callstack + 1
if ncs == 1 then
statistics.starttiming(figures)
end
local figuredata = figures.new()
if request then
local iv = interfaces.variables
-- request.width/height are strings and are only used when no natural dimensions
-- can be determined; at some point the handlers might set them to numbers instead
-- local w, h = tonumber(request.width), tonumber(request.height)
request.page = math.max(tonumber(request.page) or 1,1)
request.size = img.check_size(request.size)
request.object = iv[request.object] == variables.yes
request["repeat"] = iv[request["repeat"]] == variables.yes
request.preview = iv[request.preview] == variables.yes
request.cache = request.cache ~= "" and request.cache
request.prefix = request.prefix ~= "" and request.prefix
request.format = request.format ~= "" and request.format
-- request.width = (w and w > 0) or false
-- request.height = (h and h > 0) or false
table.merge(figuredata.request,request)
end
callstack[ncs] = figuredata
return figuredata
end
function figures.pop()
local ncs = #callstack
figuredata = callstack[ncs]
callstack[ncs] = nil
if ncs == 1 then
statistics.stoptiming(figures)
end
end
-- maybe move texsprint to tex
function figures.get(category,tag,default)
local value = figuredata[category]
value = value and value[tag]
if not value or value == "" or value == true then
return default or ""
else
return value
end
end
function figures.tprint(category,tag,default)
texsprint(ctxcatcodes,figures.get(category,tag,default))
end
function figures.current()
return callstack[#callstack]
end
end
local defaultformat = "pdf"
local defaultprefix = "m_k_v_i_"
local function register(askedname,specification)
if specification then
local format = specification.format
if format then
local conversion = specification.conversion
if conversion == "" then
conversion = nil
end
local newformat = conversion
if not newformat or newformat == "" then
newformat = defaultformat
end
local converter = (newformat ~= format) and figures.converters[format]
if trace_conversion then
logs.report("figures","checking conversion of '%s': old format '%s', new format '%s', conversion '%s'",
askedname,format,newformat,conversion or "default")
end
if converter then
if converter[newformat] then
converter = converter[newformat]
else
newformat = defaultformat
if converter[newformat] then
converter = converter[newformat]
else
newformat = defaultformat
end
end
end
if converter then
local oldname = specification.fullname
local newpath = file.dirname(oldname)
local oldbase = file.basename(oldname)
local newbase = file.replacesuffix(oldbase,newformat)
local fc = specification.cache or figures.cachepaths.path
if fc and fc ~= "" and fc ~= "." then
newpath = fc
else
newbase = defaultprefix .. newbase
end
local subpath = specification.subpath or figures.cachepaths.subpath
if subpath and subpath ~= "" and subpath ~= "." then
newpath = newpath .. "/" .. subpath
end
local prefix = specification.prefix or figures.cachepaths.prefix
if prefix and prefix ~= "" then
newbase = prefix .. newbase
end
local newname = file.join(newpath,newbase)
dir.makedirs(newpath)
oldname = file.collapse_path(oldname)
newname = file.collapse_path(newname)
local oldtime = lfs.attributes(oldname,'modification') or 0
local newtime = lfs.attributes(newname,'modification') or 0
if oldtime > newtime then
if trace_conversion then
logs.report("figures","converting '%s' from '%s' to '%s'",askedname,format,newformat)
end
converter(oldname,newname)
else
if trace_conversion then
logs.report("figures","no need to convert '%s' from '%s' to '%s'",askedname,format,newformat)
end
end
if io.exists(newname) then
specification.foundname = oldname
specification.fullname = newname
specification.prefix = prefix
specification.subpath = subpath
specification.converted = true
format = newformat
elseif io.exists(oldname) then
specification.fullname = newname
specification.converted = false
end
end
end
local found = figures.suffixes[format] -- validtypes[format]
if not found then
specification.found = false
if trace_figures then
commands.writestatus("figures","format not supported: %s",format)
end
else
specification.found = true
if trace_figures then
if validtypes[format] then
commands.writestatus("figures","format natively supported by backend: %s",format)
else
commands.writestatus("figures","format supported by output file format: %s",format)
end
end
end
else
specification = { }
end
specification.foundname = specification.foundname or specification.fullname
figures.found[askedname .. "->" .. (specification.conversion or "default")] = specification
return specification
end
local resolve_too = true -- urls
local function locate(request) -- name, format, cache
local askedname = resolvers.clean_path(request.name)
local foundname = figures.found[askedname .. "->" .. (request.conversion or "default")]
if foundname then
return foundname
end
-- protocol check
local hashed = url.hashed(askedname)
if hashed and hashed.scheme ~= "file" then
local foundname = resolvers.findbinfile(askedname)
if foundname then
askedname = foundname
end
end
-- we could use the hashed data instead
local askedpath= file.is_rootbased_path(askedname)
local askedbase = file.basename(askedname)
local askedformat = (request.format ~= "" and request.format ~= "unknown" and request.format) or file.extname(askedname) or ""
local askedcache = request.cache
local askedconversion = request.conversion
if askedformat ~= "" then
if trace_figures then
commands.writestatus("figures","strategy: forced format")
end
askedformat = lower(askedformat)
local format = figures.suffixes[askedformat]
if not format then
for _, pattern in ipairs(figures.patterns) do
if find(askedformat,pattern[1]) then
format = pattern[2]
break
end
end
end
if format then
local foundname = figures.exists(askedname,format,resolve_too) -- not askedformat
if foundname then
return register(askedname, {
askedname = askedname,
fullname = askedname,
format = format,
cache = askedcache,
foundname = foundname,
conversion = askedconversion,
})
end
end
if askedpath then
-- path and type given, todo: strip pieces of path
if figures.exists(askedname,askedformat,resolve_too) then
return register(askedname, {
askedname = askedname,
fullname = askedname,
format = askedformat,
cache = askedcache,
conversion = askedconversion,
})
end
else
-- type given
for _, path in ipairs(figures.paths) do
local check = path .. "/" .. askedname
-- we pass 'true' as it can be an url as well, as the type
-- is given we don't waste much time
if figures.exists(check,askedformat,resolve_too) then
return register(check, {
askedname = askedname,
fullname = check,
format = askedformat,
cache = askedcache,
conversion = askedconversion,
})
end
end
if figures.defaultsearch then
local check = resolvers.find_file(askedname)
if check and check ~= "" then
return register(askedname, {
askedname = askedname,
fullname = check,
format = askedformat,
cache = askedcache,
conversion = askedconversion,
})
end
end
end
elseif askedpath then
if trace_figures then
commands.writestatus("figures","strategy: rootbased path")
end
for _, format in ipairs(figures.order) do
local list = figures.formats[format].list or { format }
for _, suffix in ipairs(list) do
local check = file.addsuffix(askedname,suffix)
if figures.exists(check,format,resolve_too) then
return register(askedname, {
askedname = askedname,
fullname = check,
format = format,
cache = askedcache,
conversion = askedconversion,
})
end
end
end
else
if figures.prefer_quality then
if trace_figures then
commands.writestatus("figures","strategy: unknown format, prefer quality")
end
for _, format in ipairs(figures.order) do
local list = figures.formats[format].list or { format }
for _, suffix in ipairs(list) do
-- local name = file.replacesuffix(askedbase,suffix)
local name = file.replacesuffix(askedname,suffix)
for _, path in ipairs(figures.paths) do
local check = path .. "/" .. name
local isfile = url.hashed(check).scheme == "file"
if not isfile then
if trace_figures then
commands.writestatus("figures","warning: skipping path %s",path)
end
elseif figures.exists(check,format,true) then
return register(askedname, {
askedname = askedname,
fullname = check,
format = format,
cache = askedcache,
conversion = askedconversion,
})
end
end
end
end
else -- 'location'
if trace_figures then
commands.writestatus("figures","strategy: unknown format, prefer path")
end
for _, path in ipairs(figures.paths) do
for _, format in ipairs(figures.order) do
local list = figures.formats[format].list or { format }
for _, suffix in ipairs(list) do
local check = path .. "/" .. file.replacesuffix(askedbase,suffix)
if figures.exists(check,format,resolve_too) then
return register(askedname, {
askedname = askedname,
fullname = check,
format = format,
cache = askedcache,
conversion = askedconversion,
})
end
end
end
end
end
if figures.defaultsearch then
if trace_figures then
commands.writestatus("figures","strategy: default tex path")
end
for _, format in ipairs(figures.order) do
local list = figures.formats[format].list or { format }
for _, suffix in ipairs(list) do
local check = resolvers.find_file(file.replacesuffix(askedname,suffix))
if check and check ~= "" then
return register(askedname, {
askedname = askedname,
fullname = check,
format = format,
cache = askedcache,
conversion = askedconversion,
})
end
end
end
end
end
return register(askedname)
end
-- -- -- plugins -- -- --
figures.existers = figures.existers or { }
figures.checkers = figures.checkers or { }
figures.includers = figures.includers or { }
figures.converters = figures.converters or { }
figures.identifiers = figures.identifiers or { }
figures.programs = figures.programs or { }
figures.identifiers.list = {
figures.identifiers.default
}
function figures.identifiers.default(data)
local dr, du, ds = data.request, data.used, data.status
local l = locate(dr)
local foundname = l.foundname
local fullname = l.fullname or foundname
if fullname then
du.format = l.format or false
du.fullname = fullname -- can be cached
ds.fullname = foundname -- original
ds.format = l.format
ds.status = (l.found and 10) or 0
end
return data
end
function figures.identify(data)
data = data or figures.current()
for _, identifier in ipairs(figures.identifiers.list) do
data = identifier(data)
if data.status.status > 0 then
break
end
end
return data
end
function figures.exists(askedname,format,resolve)
return (figures.existers[format] or figures.existers.generic)(askedname,resolve)
end
function figures.check(data)
data = data or figures.current()
local dr, du, ds = data.request, data.used, data.status
return (figures.checkers[ds.format] or figures.checkers.generic)(data)
end
function figures.include(data)
data = data or figures.current()
local dr, du, ds = data.request, data.used, data.status
return (figures.includers[ds.format] or figures.includers.generic)(data)
end
function figures.scale(data) -- will become lua code
texsprint(ctxcatcodes,"\\doscalefigure")
return data
end
function figures.done(data)
figures.n = figures.n + 1
data = data or figures.current()
local dr, du, ds, nr = data.request, data.used, data.status, figures.boxnumber
local box = tex.box[nr]
ds.width = box.width
ds.height = box.height
ds.xscale = ds.width /(du.width or 1)
ds.yscale = ds.height/(du.height or 1)
return data
end
function figures.dummy(data)
data = data or figures.current()
local dr, du, ds, nr = data.request, data.used, data.status, figures.boxnumber
local box = node.new("hlist")
box.width = du.width or figures.defaultwidth
box.height = du.height or figures.defaultheight
box.depth = du.depth or figures.defaultdepth
texbox[nr] = box
end
-- -- -- generic -- -- --
function figures.existers.generic(askedname,resolve)
-- not findbinfile
local result
if lfs.isfile(askedname) then
result = askedname
elseif resolve then
result = resolvers.findbinfile(askedname) or ""
if result == "" then result = false end
end
if trace_figures then
if result then
commands.writestatus("figures","found: %s -> %s",askedname,result)
else
commands.writestatus("figures","not found: %s",askedname)
end
end
return result
end
function figures.checkers.generic(data)
local dr, du, ds = data.request, data.used, data.status
local name, page, size, color = du.fullname or "unknown generic", du.page or dr.page, dr.size or "crop", dr.color or "natural"
local conversion = dr.conversion
if not conversion or conversion == "" then
conversion = "unknown"
end
local hash = name .. "->" .. page .. "->" .. size .. "->" .. color .. "->" .. conversion
local figure = figures.loaded[hash]
if figure == nil then
figure = img.new { filename = name, page = page, pagebox = dr.size }
backends.codeinjections.setfigurecolorspace(data,figure)
figure = (figure and img.scan(figure)) or false
local f, d = backends.codeinjections.setfigurealternative(data,figure)
figure, data = f or figure, d or data
figures.loaded[hash] = figure
if trace_conversion then
logs.report("figures","new graphic, hash: %s",hash)
end
else
if trace_conversion then
logs.report("figures","existing graphic, hash: %s",hash)
end
end
if figure then
du.width = figure.width
du.height = figure.height
du.pages = figure.pages
ds.private = figure
ds.hash = hash
end
return data
end
function figures.includers.generic(data)
local dr, du, ds = data.request, data.used, data.status
-- here we set the 'natural dimensions'
dr.width = du.width
dr.height = du.height
local hash = figures.hash(data)
local figure = figures.used[hash]
if figure == nil then
figure = ds.private
if figure then
figure = img.copy(figure)
figure = (figure and img.clone(figure,data.request)) or false
end
figures.used[hash] = figure
end
if figure then
local nr = figures.boxnumber
-- it looks like we have a leak in attributes here .. todo
local box = node.hpack(img.node(figure)) -- img.node(figure) not longer valid
box.width, box.height, box.depth = figure.width, figure.height, 0 -- new, hm, tricky, we need to do that in tex (yet)
texbox[nr] = box
ds.objectnumber = figure.objnum
texsprint(ctxcatcodes,"\\relocateexternalfigure")
end
return data
end
-- -- -- nongeneric -- -- --
function figures.checkers.nongeneric(data,command)
local dr, du, ds = data.request, data.used, data.status
local name = du.fullname or "unknown nongeneric"
local hash = name
if dr.object then
-- hm, bugged
if not jobobjects.get("FIG::"..hash) then
texsprint(ctxcatcodes,command)
texsprint(ctxcatcodes,format("\\setobject{FIG}{%s}\\vbox{\\box\\foundexternalfigure}",hash))
end
texsprint(ctxcatcodes,format("\\global\\setbox\\foundexternalfigure\\vbox{\\getobject{FIG}{%s}}",hash))
else
texsprint(ctxcatcodes,command)
end
return data
end
function figures.includers.nongeneric(data)
return data
end
-- -- -- mov -- -- --
function figures.checkers.mov(data)
local dr, du, ds = data.request, data.used, data.status
local width = todimen(dr.width or figures.defaultwidth)
local height = todimen(dr.height or figures.defaultheight)
local foundname = du.fullname
dr.width, dr.height = width, height
du.width, du.height, du.foundname = width, height, foundname
if trace_inclusion then
logs.report("figures","including movie '%s': width %s, height %s",foundname,width,height)
end
-- we need to push the node.write in between ... we could make a shared helper for this
context.startfoundexternalfigure(width .. "sp",height .. "sp")
context(function()
backends.codeinjections.insertmovie {
width = width,
height = height,
factor = number.dimenfactors.bp,
["repeat"] = dr["repeat"],
controls = dr.controls,
preview = dr.preview,
label = dr.label,
foundname = foundname,
}
end)
context.stopfoundexternalfigure()
return data
end
figures.includers.mov = figures.includers.nongeneric
-- -- -- mps -- -- --
local function internal(askedname)
local spec, mprun, mpnum = match(lower(askedname),"mprun(:?)(.-)%.(%d+)")
if spec == ":" then
return mprun, mpnum
else
return "", mpnum
end
end
function figures.existers.mps(askedname)
local mprun, mpnum = internal(askedname)
if mpnum then
return askedname
else
return figures.existers.generic(askedname)
end
end
function figures.checkers.mps(data)
local mprun, mpnum = internal(data.used.fullname)
if mpnum then
return figures.checkers.nongeneric(data,format("\\docheckfiguremprun{%s}{%s}",mprun,mpnum))
else
return figures.checkers.nongeneric(data,format("\\docheckfiguremps{%s}",data.used.fullname))
end
end
figures.includers.mps = figures.includers.nongeneric
-- -- -- buffer -- -- --
function figures.existers.buffer(askedname)
askedname = file.nameonly(askedname)
return buffers.exists(askedname) and askedname
end
function figures.checkers.buffer(data)
return figures.checkers.nongeneric(data,format("\\docheckfigurebuffer{%s}", file.nameonly(data.used.fullname)))
end
figures.includers.buffers = figures.includers.nongeneric
-- -- -- tex -- -- --
function figures.existers.tex(askedname)
askedname = resolvers.find_file(askedname)
return (askedname ~= "" and askedname) or false
end
function figures.checkers.tex(data)
return figures.checkers.nongeneric(data,format("\\docheckfiguretex{%s}", data.used.fullname))
end
figures.includers.tex = figures.includers.nongeneric
-- -- -- converters -- -- --
local function makeoptions(program)
local to = type(options)
return (to == "table" and concat(options," ")) or (to == "string" and options) or ""
end
local function runprogram(...)
local command = format(...)
if trace_conversion or trace_programs then
logs.report("figures","running %s",command)
end
os.spawn(command)
end
-- -- -- eps -- -- --
local epsconverter = { }
figures.converters.eps = epsconverter
figures.programs.gs = {
options = {
"-dAutoRotatePages=/None",
"-dPDFSETTINGS=/prepress",
"-dEPSCrop",
},
command = (os.type == "windows" and "gswin32") or "gs"
}
function epsconverter.pdf(oldname,newname)
local gs = figures.programs.gs
runprogram (
'%s -q -sDEVICE=pdfwrite -dNOPAUSE -dNOCACHE -dBATCH %s -sOutputFile="%s" "%s" -c quit',
gs.command, makeoptions(gs.options), newname, oldname
)
end
epsconverter.default = epsconverter.pdf
-- -- -- svg -- -- --
local svgconverter = { }
figures.converters.svg = svgconverter
figures.converters.svgz = svgconverter
-- inkscape on windows only works with complete paths
figures.programs.inkscape = {
options = {
"--export-dpi=600"
},
command = "inkscape"
}
function svgconverter.pdf(oldname,newname)
local inkscape = figures.programs.inkscape
runprogram (
'%s "%s" --export-pdf="%s" %s',
inkscape.command, oldname, newname, makeoptions(inkscape.options)
)
end
function svgconverter.png(oldname,newname)
local inkscape = figures.programs.inkscape
runprogram (
'%s "%s" --export-png="%s" %s',
inkscape.command, oldname, newname, makeoptions(inkscape.options)
)
end
svgconverter.default = svgconverter.pdf
-- -- -- gif -- -- --
local gifconverter = { }
figures.converters.gif = gifconverter
figures.programs.convert = {
command = "convert" -- imagemagick
}
function gifconverter.pdf(oldname,newname)
local convert = figures.programs.convert
runprogram (
"convert %s %s",
convert.command, makeoptions(convert.options), oldname, newname
)
end
gifconverter.default = gifconverter.pdf
-- todo: lowres
-- -- -- bases -- -- --
figures.bases = { }
figures.bases.list = { } -- index => { basename, fullname, xmlroot }
figures.bases.used = { } -- [basename] => { basename, fullname, xmlroot } -- pointer to list
figures.bases.found = { }
figures.bases.enabled = false
local bases = figures.bases
function bases.use(basename)
if basename == "reset" then
bases.list, bases.used, bases.found, bases.enabled = { }, { }, { }, false
else
basename = file.addsuffix(basename,"xml")
if not bases.used[basename] then
local t = { basename, nil, nil }
bases.used[basename] = t
bases.list[#bases.list+1] = t
if not bases.enabled then
bases.enabled = true
xml.registerns("rlx","http://www.pragma-ade.com/schemas/rlx") -- we should be able to do this per xml file
end
if trace_bases then
commands.writestatus("figures","registering base '%s'",basename)
end
end
end
end
function bases.find(basename,askedlabel)
if trace_bases then
commands.writestatus("figures","checking for '%s' in base '%s'",askedlabel,basename)
end
basename = file.addsuffix(basename,"xml")
local t = bases.found[askedlabel]
if t == nil then
local base = bases.used[basename]
local page = 0
if base[2] == nil then
-- no yet located
for _, path in ipairs(figures.paths) do
local xmlfile = path .. "/" .. basename
if io.exists(xmlfile) then
base[2] = xmlfile
base[3] = xml.load(xmlfile)
if trace_bases then
commands.writestatus("figures","base '%s' loaded",xmlfile)
end
break
end
end
end
t = false
if base[2] and base[3] then -- rlx:library
for e in xml.collected(base[3],"/(*:library|figurelibrary)/*:figure/*:label") do
page = page + 1
if xml.text(e) == askedlabel then
t = {
base = file.replacesuffix(base[2],"pdf"),
format = "pdf",
name = xml.text(e,"../*:file"), -- to be checked
page = page,
}
bases.found[askedlabel] = t
if trace_bases then
commands.writestatus("figures","figure '%s' found in base '%s'",askedlabel,base[2])
end
return t
end
end
if trace_bases and not t then
commands.writestatus("figures","figure '%s' not found in base '%s'",askedlabel,base[2])
end
end
end
return t
end
-- we can access sequential or by name
function bases.locate(askedlabel)
for _, entry in ipairs(bases.list) do
local t = bases.find(entry[1],askedlabel)
if t then
return t
end
end
return false
end
function figures.identifiers.base(data)
if bases.enabled then
local dr, du, ds = data.request, data.used, data.status
local fbl = bases.locate(dr.name or dr.label)
if fbl then
du.page = fbl.page
du.format = fbl.format
du.fullname = fbl.base
ds.fullname = fbl.name
ds.format = fbl.format
ds.page = fbl.page
ds.status = 10
end
end
return data
end
figures.identifiers.list = {
figures.identifiers.base,
figures.identifiers.default
}
-- tracing
statistics.register("graphics processing time", function()
local n = figures.n
if n > 0 then
return format("%s seconds including tex, n=%s", statistics.elapsedtime(figures),n)
else
return nil
end
end)
|