4 luatexbase.provides_module({
5 name = 'luatexja.jfont',
7 description = 'Loader for Japanese fonts',
9 module('luatexja.jfont', package.seeall)
11 luatexja.load_module('base'); local ltjb = luatexja.base
12 luatexja.load_module('charrange'); local ltjc = luatexja.charrange
13 luatexja.load_module('rmlgbm'); local ltjr = luatexja.rmlgbm
14 luatexja.load_module('direction'); local ltjd = luatexja.direction
17 local Dnode = node.direct or node
19 local setfield = (Dnode ~= node) and Dnode.setfield or function(n, i, c) n[i] = c end
20 local getid = (Dnode ~= node) and Dnode.getid or function(n) return n.id end
21 local getfont = (Dnode ~= node) and Dnode.getfont or function(n) return n.font end
22 local getchar = (Dnode ~= node) and Dnode.getchar or function(n) return n.char end
24 local nullfunc = function(n) return n end
25 local to_direct = (Dnode ~= node) and Dnode.todirect or nullfunc
27 local node_new = Dnode.new
28 local node_free = Dnode.free
29 local has_attr = Dnode.has_attribute
30 local set_attr = Dnode.set_attribute
31 local node_write = Dnode.write
32 local round = tex.round
33 local font_getfont = font.getfont
35 local attr_icflag = luatexbase.attributes['ltj@icflag']
36 local attr_curjfnt = luatexbase.attributes['ltj@curjfnt']
37 local attr_curtfnt = luatexbase.attributes['ltj@curtfnt']
38 local id_glyph = node.id('glyph')
39 local id_kern = node.id('kern')
40 local id_glue_spec = node.id('glue_spec')
41 local id_glue = node.id('glue')
42 local cat_lp = luatexbase.catcodetables['latex-package']
43 local ITALIC = luatexja.icflag_table.ITALIC
44 local FROM_JFM = luatexja.icflag_table.FROM_JFM
46 ------------------------------------------------------------------------
48 ------------------------------------------------------------------------
50 metrics={} -- this table stores all metric informations
51 font_metric_table={} -- [font number] -> jfm_name, jfm_var, size
53 luatexbase.create_callback("luatexja.load_jfm", "data", function (ft, jn) return ft end)
55 local jfm_file_name, jfm_var
59 function define_jfm(t)
60 local real_char -- Does current character class have the 'real' character?
61 if t.dir~=jfm_dir then
62 defjfm_res= nil; return
63 elseif type(t.zw)~='number' or type(t.zh)~='number' then
64 defjfm_res= nil; return
66 t.char_type = {}; t.chars = {}
67 for i,v in pairs(t) do
68 if type(i) == 'number' then -- char_type
70 if i ~= 0 then defjfm_res= nil; return end
74 for j,w in pairs(v.chars) do
75 if type(w) == 'number' and w~=-1 then
77 elseif type(w) == 'string' and utf.len(w)==1 then
78 real_char = true; w = utf.byte(w)
79 elseif type(w) == 'string' and utf.len(w)==2 and utf.sub(w,2) == '*' then
80 real_char = true; w = utf.byte(utf.sub(w,1,1))
81 if not t.chars[-w] then
84 defjfm_res= nil; return
87 if not t.chars[w] then
90 defjfm_res= nil; return
93 if type(v.align)~='string' then
94 v.align = 'left' -- left
97 if type(v.width)~='number' and v.width~='prop' then
98 defjfm_res= nil; return
100 if v.width=='prop' and jfm_dir=='tate' then
103 if type(v.height)~='number' then
106 if type(v.depth)~='number' then
109 if type(v.italic)~='number' then
112 if type(v.left)~='number' then
115 if type(v.down)~='number' then
122 v.kern = v.kern or {}; v.glue = v.glue or {}
123 for j in pairs(v.glue) do
124 if v.kern[j] then defjfm_res= nil; return end
126 for j,x in pairs(v.kern) do
127 if type(x)=='number' then
129 elseif type(x)=='table' then
130 v.kern[j] = {x[1], x[2] or 0}
137 t = luatexbase.call_callback("luatexja.load_jfm", t, jfm_file_name)
142 local update_jfm_cache
144 local function mult_table(old,scale) -- modified from table.fastcopy
147 for k,v in next, old do
148 if type(v) == "table" then
149 new[k] = mult_table(v,scale)
150 elseif type(v) == "number" then
151 new[k] = round(v*scale)
160 update_jfm_cache = function (j,sz)
161 if metrics[j].size_cache[sz] then return end
163 metrics[j].size_cache[sz] = t
164 t.chars = metrics[j].chars
165 t.char_type = mult_table(metrics[j].char_type, sz)
166 for i,v in pairs(t.char_type) do
167 v.align = (v.align=='left') and 0 or
168 ((v.align=='right') and 1 or 0.5)
169 if type(i) == 'number' then -- char_type
170 for k,w in pairs(v.glue) do
171 local h = node_new(id_glue_spec)
172 v[k] = {true, h, (w[5] and w[5]/sz or 0), FROM_JFM + (w[4] and w[4]/sz or 0)}
173 setfield(h, 'width', w[1])
174 setfield(h, 'stretch', w[2])
175 setfield(h, 'shrink', w[3])
176 setfield(h, 'stretch_order', 0)
177 setfield(h, 'shrink_order', 0)
179 for k,w in pairs(v.kern) do
180 local g = node_new(id_kern)
181 setfield(g, 'kern', w[1])
182 setfield(g, 'subtype', 1)
183 set_attr(g, attr_icflag, FROM_JFM)
184 v[k] = {false, g, w[2]/sz}
187 v.glue, v.kern = nil, nil
189 t.kanjiskip = mult_table(metrics[j].kanjiskip, sz)
190 t.xkanjiskip = mult_table(metrics[j].xkanjiskip,sz)
191 t.zw = round(metrics[j].zw*sz)
192 t.zh = round(metrics[j].zh*sz)
197 luatexbase.create_callback("luatexja.find_char_class", "data",
198 function (arg, fmtable, char)
202 local start_time_measure = ltjb.start_time_measure
203 local stop_time_measure = ltjb.stop_time_measure
204 local fcc_temp = { chars_cbcache = {} }
206 fcc_temp.chars_cbcache,
208 __index = function () return 0 end,
210 function find_char_class(c,m)
211 -- c: character code, m:
212 local r = (m or fcc_temp).chars_cbcache[c]
215 luatexbase.call_callback("luatexja.find_char_class", 0, m, c)
216 m.chars_cbcache[c or 0] = r
223 ------------------------------------------------------------------------
224 -- LOADING JAPANESE FONTS
225 ------------------------------------------------------------------------
229 local global_flag -- true if \globaljfont, false if \jfont
230 local function load_jfont_metric()
231 if jfm_file_name=='' then
232 ltjb.package_error('luatexja',
234 'To load and define a Japanese font, a JFM must be specified.'..
235 "The JFM 'ujis' will be used for now.")
238 for j,v in ipairs(metrics) do
239 if v.name==jfm_file_name then return j end
241 luatexja.load_lua('jfm-' .. jfm_file_name .. '.lua')
243 defjfm_res.name = jfm_file_name
244 table.insert(metrics, defjfm_res)
252 function jfontdefX(g)
253 local t = token.get_next()
254 cstemp=token.csname_name(t)
255 global_flag = g and '\\global' or ''
256 tex.sprint(cat_lp, '\\expandafter\\font\\csname ', cstemp, '\\endcsname')
259 luatexbase.create_callback("luatexja.define_jfont", "data", function (ft, fn) return ft end)
262 local identifiers = fonts.hashes.identifiers
263 function jfontdefY(dir)
265 local j = load_jfont_metric(dir)
266 local fn = font.id(cstemp)
267 local f = font_getfont(fn)
269 ltjb.package_error('luatexja',
270 "bad JFM `" .. jfm_file_name .. "'",
271 'The JFM file you specified is not valid JFM file.\n'..
272 'So defining Japanese font is cancelled.')
273 tex.sprint(cat_lp, global_flag, '\\expandafter\\let\\csname ', cstemp,
274 '\\endcsname=\\relax')
277 update_jfm_cache(j, f.size)
278 local ad = identifiers[fn].parameters
279 local sz = metrics[j].size_cache[f.size]
280 local fmtable = { jfm = j, size = f.size, var = jfm_var,
281 zw = sz.zw, zh = sz.zh,
282 ascent = ad.ascender,
283 descent = ad.descender,
284 chars = sz.chars, char_type = sz.char_type,
285 kanjiskip = sz.kanjiskip, xkanjiskip = sz.xkanjiskip,
289 fmtable = luatexbase.call_callback("luatexja.define_jfont", fmtable, fn)
290 font_metric_table[fn]=fmtable
291 tex.sprint(cat_lp, global_flag, '\\protected\\expandafter\\def\\csname ',
292 cstemp , '\\endcsname{\\ltj@cur'..
293 (dir == 'yoko' and 'j' or 't') .. 'fnt', fn, '\\relax}')
298 local get_dir_count = ltjd.get_dir_count
299 local dir_tate = luatexja.dir_table.dir_tate
300 local tex_get_attr = tex.getattribute
303 local a = font_metric_table[
304 tex_get_attr((get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)]
305 return a and a.zw or 0
308 local a = font_metric_table[
309 tex_get_attr((get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)]
310 return a and a.zw or 0
315 -- extract jfm_file_name and jfm_var
316 -- normalize position of 'jfm=' and 'jfmvar=' keys
317 local function extract_metric(name)
318 jfm_file_name = ''; jfm_var = ''
319 local tmp, index = name:sub(1, 5), 1
320 if tmp == 'file:' or tmp == 'name:' or tmp == 'psft:' then
323 local p = name:find(":", index); index = p and (p+1) or index
325 local l = name:len()+1
326 local q = name:find(";", index+1) or l
327 if name:sub(index, index+3)=='jfm=' and q>index+4 then
328 jfm_file_name = name:sub(index+4, q-1)
330 name = name:sub(1,index-1) .. name:sub(q+1)
332 name = name:sub(1,index-1)
335 elseif name:sub(index, index+6)=='jfmvar=' and q>index+6 then
336 jfm_var = name:sub(index+7, q-1)
338 name = name:sub(1,index-1) .. name:sub(q+1)
340 name = name:sub(1,index-1)
344 index = (l~=q) and (q+1) or nil
347 if jfm_file_name~='' then
348 local l = name:sub(-1)
350 .. ((l==':' or l==';') and '' or ';')
351 .. 'jfm=' .. jfm_file_name
353 name = name .. 'jfmvar=' .. jfm_var
359 -- define_font callback
360 local otfl_fdr = fonts.definers.read
361 local ltjr_font_callback = ltjr.font_callback
362 function luatexja.font_callback(name, size, id)
363 local new_name = extract_metric(name)
364 local res = ltjr_font_callback(new_name, size, id, otfl_fdr)
365 luatexbase.call_callback('luatexja.define_font', res, new_name, size, id)
368 luatexbase.create_callback('luatexja.define_font', 'simple', function (n) return n end)
369 luatexbase.add_to_callback('define_font',luatexja.font_callback,"luatexja.font_callback", 1)
372 ------------------------------------------------------------------------
374 ------------------------------------------------------------------------
376 -- these function are called from ltj-latex.sty
377 local kyenc_list, ktenc_list = {}, {}
378 function add_kyenc_list(enc) kyenc_list[enc] = 'true ' end
379 function add_ktenc_list(enc) ktenc_list[enc] = 'true ' end
380 function is_kyenc(enc)
381 tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (kyenc_list[enc] or 'false '))
383 function is_ktenc(enc)
384 tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (ktenc_list[enc] or 'false '))
386 function is_kenc(enc)
387 tex.sprint(cat_lp, '\\let\\ifin@\\if'
388 .. (kyenc_list[enc] or ktenc_list[enc] or 'false '))
391 local kfam_list, Nkfam_list = {}, {}
392 function add_kfam_list(enc, fam)
393 if not kfam_list[enc] then kfam_list[enc] = {} end
394 kfam_list[enc][fam] = 'true '
396 function add_Nkfam_list(enc, fam)
397 if not Nkfam_list[enc] then Nkfam_list[enc] = {} end
398 Nkfam_list[enc][fam] = 'true '
400 function is_kfam(enc, fam)
401 tex.sprint(cat_lp, '\\let\\ifin@\\if'
402 .. (kfam_list[enc] and kfam_list[enc][fam] or 'false ')) end
403 function is_Nkfam(enc, fam)
404 tex.sprint(cat_lp, '\\let\\ifin@\\if'
405 .. (Nkfam_list[enc] and Nkfam_list[enc][fam] or 'false ')) end
407 local ffam_list, Nffam_list = {}, {}
408 function add_ffam_list(enc, fam)
409 if not ffam_list[enc] then ffam_list[enc] = {} end
410 ffam_list[enc][fam] = 'true '
412 function add_Nffam_list(enc, fam)
413 if not Nffam_list[enc] then Nffam_list[enc] = {} end
414 Nffam_list[enc][fam] = 'true '
416 function is_ffam(enc, fam)
417 tex.sprint(cat_lp, '\\let\\ifin@\\if'
418 .. (ffam_list[enc] and ffam_list[enc][fam] or 'false ')) end
419 function is_Nffam(enc, fam)
420 tex.sprint(cat_lp, '\\let\\ifin@\\if'
421 .. (Nffam_list[enc] and Nffam_list[enc][fam] or 'false ')) end
423 ------------------------------------------------------------------------
425 ------------------------------------------------------------------------
427 local alt_font_table = alt_font_table
428 local attr_curaltfnt = {}
429 local ucs_out = 0x110000
431 ------ for TeX interface
433 function set_alt_font(b,e,ind,bfnt)
434 -- ind: 新フォント, bfnt: 基底フォント
435 if b>e then b, e = e, b end
437 ltjb.package_error('luatexja',
438 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
439 'I take the intersection with [0x80, 0x10ffff].')
440 b, e = math.max(0x80,b),math.min(ucs_out-1,e)
441 elseif e<0 then -- b<e<0
443 elseif b<0x80 or e>=ucs_out then
444 ltjb.package_warning('luatexja',
445 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
446 'I take the intersection with [0x80, 0x10ffff].')
447 b, e = math.max(0x80,b), math.min(ucs_out-1,e)
449 if not alt_font_table[bfnt] then alt_font_table[bfnt]={} end
450 local t = alt_font_table[bfnt]
451 local ac = font_getfont(ind).characters
452 if bfnt==ind then ind = nil end -- ind == bfnt の場合はテーブルから削除
453 if e>=0 then -- character range
455 if ac[i]then t[i]=ind end
459 local tx = font_metric_table[bfnt].chars
460 for i,v in pairs(tx) do
461 if b<=v and v<=e and ac[i] then t[i]=ind end
467 function clear_alt_font(bfnt)
468 if alt_font_table[bfnt] then
469 local t = alt_font_table[bfnt]
470 for i,_ in pairs(t) do t[i]=nil; end
474 ------ used in ltjp.suppress_hyphenate_ja callback
475 function replace_altfont(pf, pc)
476 local a = alt_font_table[pf]
477 return a and a[pc] or pf
480 ------ for LaTeX interface
482 local alt_font_table_latex = {}
485 function clear_alt_font_latex(bbase)
486 local t = alt_font_table_latex[bbase]
488 for j,v in pairs(t) do t[j] = nil end
493 function set_alt_font_latex(b,e,ind,bbase)
494 -- ind: Alt font の enc/fam/ser/shape, bbase: 基底フォントの enc/fam/ser/shape
495 if b>e then b, e = e, b end
497 ltjb.package_error('luatexja',
498 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
499 'I take the intersection with [0x80, 0x10ffff].')
500 b, e = math.max(0x80,b),math.min(ucs_out-1,e)
501 elseif e<0 then -- b<e<0
503 elseif b<0x80 or e>=ucs_out then
504 ltjb.package_warning('luatexja',
505 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
506 'I take the intersection with [0x80, 0x10ffff].')
507 b, e = math.max(0x80,b), math.min(ucs_out-1,e)
510 if not alt_font_table_latex[bbase] then alt_font_table_latex[bbase]={} end
511 local t = alt_font_table_latex[bbase]
512 if not t[ind] then t[ind] = {} end
514 for j,v in pairs(t) do
515 if v[i] then -- remove old entry
516 if j~=ind then v[i]=nil end; break
521 -- remove the empty tables
522 for j,v in pairs(t) do
523 local flag_clear = true
524 for k,_ in pairs(v) do flag_clear = false; break end
525 if flag_clear then t[j]=nil end
527 if ind==bbase then t[bbase] = nil end
530 -- ここから先は 新 \selectfont の内部でしか実行されない
532 local alt_font_base, alt_font_base_num
535 function does_alt_set(bbase)
536 aftl_base = alt_font_table_latex[bbase]
537 tex.sprint(cat_lp, '\\if' .. (aftl_base and 'true' or 'false'))
540 function print_aftl_address()
541 tex.sprint(cat_lp, ';ltjaltfont' .. tostring(aftl_base):sub(8))
545 function output_alt_font_cmd(dir, bbase)
546 alt_font_base = bbase
548 alt_font_base_num = tex.getattribute(attr_curtfnt)
550 alt_font_base_num = tex.getattribute(attr_curjfnt)
552 local t = alt_font_table[alt_font_base_num]
554 for i,_ in pairs(t) do t[i]=nil end
556 t = alt_font_table_latex[bbase]
558 for i,_ in pairs(t) do
559 tex.sprint(cat_lp, '\\ltj@pickup@altfont@aux' .. dir .. '{' .. i .. '}')
565 function pickup_alt_font_a(size_str)
566 local t = alt_font_table_latex[alt_font_base]
568 for i,v in pairs(t) do
569 tex.sprint(cat_lp, '\\expandafter\\ltj@pickup@altfont@copy'
570 .. '\\csname ' .. i .. '/' .. size_str .. '\\endcsname{' .. i .. '}')
575 local function pickup_alt_font_class(class, afnt_num, afnt_chars)
576 local t = alt_font_table[alt_font_base_num]
577 local tx = font_metric_table[alt_font_base_num].chars
578 for i,v in pairs(tx) do
579 if v==class and afnt_chars[i] then t[i]=afnt_num end
584 function pickup_alt_font_b(afnt_num, afnt_base)
585 local t = alt_font_table[alt_font_base_num]
586 local ac = font_getfont(afnt_num).characters
587 if not t then t = {}; alt_font_table[alt_font_base_num] = t end
588 for i,v in pairs(alt_font_table_latex[alt_font_base]) do
589 if i == afnt_base then
590 for j,_ in pairs(v) do
592 if ac[j] then t[j]=afnt_num end
593 else -- -n (n>=1) means that the character class n,
594 -- which is defined in the JFM
595 pickup_alt_font_class(-j, afnt_num, ac)
605 ------------------------------------------------------------------------
607 ------------------------------------------------------------------------
609 local font_extra_info = font_extra_info -- key: fontnumber
611 -- IVS and vertical metrics
612 local prepare_fl_data
615 local fields = fontloader.fields
616 local function glyph_vmetric(glyph)
617 local flds = fields(glyph)
618 local vw, tsb = nil, nil
619 for _,i in ipairs(flds) do
620 if i=='vwidth' then vw = glyph.vwidth end
621 if i=='tsidebearing' then tsb = glyph.tsidebearing end
626 local sort = table.sort
627 local function add_fl_table(dest, tg, unitable, glyphmax, asc_des, units)
628 for i = 0, glyphmax-1 do
632 for _,at in pairs(gv.altuni) do
633 local bu, vsel = at.unicode, at.variant
635 if vsel>=0xE0100 then vsel = vsel - 0xE0100 end
636 dest = dest or {}; dest[bu] = dest[bu] or {}
637 local uniq_flag = true
638 for i,_ in pairs(dest[bu]) do
639 if i==vs then uniq_flag = false; break end
642 dest[bu][vsel] = unitable[gv.name]
647 local vw, tsb = glyph_vmetric(gv)
648 if vw and vw~=asc_des then
649 local gi = unitable[gv.name]
650 -- We do not use tsidebearing, since fontloader does not read
651 -- VORG table. We assume that vertical origin == ascender
652 -- (see capsule_glyph_tate in ltj-setwidth.lua)
653 dest = dest or {}; dest[gi] = dest[gi] or {}
654 dest[gi].vwidth = vw/units
660 prepare_fl_data = function (dest, id, fname)
661 local fl = fontloader.open(fname)
662 local unicodes = id.resources.unicodes
664 dest = add_fl_table(dest, fl.glyphs, id.resources.unicodes, fl.glyphmax,
665 fl.ascent + fl.descent, fl.units_per_em)
668 for _,v in pairs(fl.subfonts) do
669 dest = add_fl_table(dest, v.glyphs, id.resources.unicodes, v.glyphmax,
670 fl.ascent + fl.descent, fl.units_per_em)
679 local prepare_vert_data
681 local function add_feature_table(tname, src, dest)
682 for i,v in pairs(src) do
683 if type(v.slookups)=='table' then
684 local s = v.slookups[tname]
686 if not dest then dest = {} end
687 if not dest[i] then dest[i] = {} end
688 dest[i].vert = dest[i].vert or s
694 prepare_vert_data = function (dest, id)
695 local a = id.resources.sequences
697 local s = id.shared.rawdata.descriptions
698 for i,v in pairs(a) do
699 if v.features.vert or v.features.vrt2 then
700 dest= add_feature_table(v.subtables[1], s, dest)
707 function get_vert_glyph(n, chr)
708 local fn = font_extra_info[n]
709 return (fn and fn[chr] and fn[chr].vert) or chr
715 local font_extra_basename = {} -- key: basename
717 local checksum = file.checksum
719 local function prepare_extra_data(n, id)
720 -- test if already loaded
721 if type(id)=='number' then -- sometimes id is an integer
723 elseif (not id) or font_extra_info[n] then return
725 local fname = id.filename
726 local bname = file.basename(fname)
728 font_extra_info[n] = {}; return
729 elseif font_extra_basename[bname] then
730 font_extra_info[n] = font_extra_basename[bname]; return
732 -- if the cache is present, read it
733 local newsum = checksum(fname) -- MD5 checksum of the fontfile
734 local v = "extra_" .. string.lower(file.nameonly(fname))
735 local dat = ltjb.load_cache(v,
736 function (t) return (t.version~=cache_ver) or (t.chksum~=newsum) end
738 -- if the cache is not found or outdated, save the cache
740 font_extra_basename[bname] = dat[1] or {}
743 dat = prepare_vert_data(dat, id)
744 dat = prepare_fl_data(dat, id, fname)
745 font_extra_basename[bname] = dat or {}
748 chksum = checksum(fname),
753 font_extra_info[n] = font_extra_basename[bname]
755 luatexbase.add_to_callback('luatexja.define_font',
756 function (res, name, size, id)
757 prepare_extra_data(id, res)
759 'ltj.prepare_extra_data', 1)
761 local function a (n, dat) font_extra_info[n] = dat end
762 ltjr.vert_addfunc = a
764 local identifiers = fonts.hashes.identifiers
765 for i=1,font.nextid()-1 do
766 if identifiers[i] then prepare_extra_data(i, identifiers[i]) end
770 ------------------------------------------------------------------------
772 ------------------------------------------------------------------------
774 local get_dir_count = ltjd.get_dir_count
775 local is_ucs_in_japanese_char = ltjc.is_ucs_in_japanese_char_direct
776 local tex_set_attr = tex.setattribute
778 -- EXT: italic correction
779 function append_italic()
780 local p = to_direct(tex.nest[tex.nest.ptr].tail)
781 if p and getid(p)==id_glyph then
783 local g = node_new(id_kern)
784 setfield(g, 'subtype', 1)
785 set_attr(g, attr_icflag, ITALIC)
786 if is_ucs_in_japanese_char(p) then
787 f = has_attr(p, (get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)
788 local j = font_metric_table[f]
789 setfield(g, 'kern', j.char_type[find_char_class(getchar(p), j)].italic)
791 local h = font_getfont(f) or font.fonts[f]
793 setfield(g, 'kern', h.characters[getchar(p)].italic)
795 tex_set_attr(attr_icflag, 0)
800 tex_set_attr(attr_icflag, 0)