src/ltj-jfont.lua

   1 --
   2 -- luatexja/jfont.lua
   3 --
   4 luatexbase.provides_module({
   5   name = 'luatexja.jfont',
   6   date = '2014/10/03',
   7   description = 'Loader for Japanese fonts',
   8 })
   9 module('luatexja.jfont', package.seeall)
  10
  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
  15
  16
  17 local Dnode = node.direct or node
  18
  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
  23
  24 local nullfunc = function(n) return n end
  25 local to_direct = (Dnode ~= node) and Dnode.todirect or nullfunc
  26
  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
  34
  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
  45
  46 ------------------------------------------------------------------------
  47 -- LOADING JFM
  48 ------------------------------------------------------------------------
  49
  50 metrics={} -- this table stores all metric informations
  51 font_metric_table={} -- [font number] -> jfm_name, jfm_var, size
  52
  53 luatexbase.create_callback("luatexja.load_jfm", "data", function (ft, jn) return ft end)
  54
  55 local jfm_file_name, jfm_var
  56 local defjfm_res
  57 local jfm_dir, is_def_jfont
  58
  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
  65    end
  66    t.char_type = {}; t.chars = {}
  67    for i,v in pairs(t) do
  68       if type(i) == 'number' then -- char_type
  69          if not v.chars then
  70             if i ~= 0 then defjfm_res= nil; return  end
  71             real_char = true
  72          else
  73             real_char = false
  74             for j,w in pairs(v.chars) do
  75                if type(w) == 'number' and w~=-1 then
  76                   real_char = true;
  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                end
  82                if not t.chars[w] then
  83                   t.chars[w] = i
  84                else
  85                   defjfm_res= nil; return
  86                end
  87             end
  88             if type(v.align)~='string' then
  89                v.align = 'left' -- left
  90             end
  91             if real_char then
  92                if type(v.width)~='number' and v.width~='prop' then
  93                   defjfm_res= nil; return
  94                else
  95                   if v.width=='prop' and jfm_dir=='tate' then
  96                      v.width = 1.0
  97                   end
  98                   if type(v.height)~='number' then
  99                      v.height = 0.0
 100                   end
 101                   if type(v.depth)~='number' then
 102                      v.depth = 0.0
 103                   end
 104                   if type(v.italic)~='number' then
 105                      v.italic = 0.0
 106                   end
 107                   if type(v.left)~='number' then
 108                      v.left = 0.0
 109                   end
 110                   if type(v.down)~='number' then
 111                      v.down = 0.0
 112                   end
 113                end
 114             end
 115             v.chars = nil
 116          end
 117          v.kern = v.kern or {}; v.glue = v.glue or {}
 118          for j in pairs(v.glue) do
 119             if v.kern[j] then defjfm_res= nil; return end
 120          end
 121          for j,x in pairs(v.kern) do
 122             if type(x)=='number' then
 123                v.kern[j] = {x, 0}
 124             elseif type(x)=='table' then
 125                v.kern[j] = {x[1], x[2] or 0}
 126             end
 127          end
 128          t.char_type[i] = v
 129          t[i] = nil
 130       end
 131    end
 132    t = luatexbase.call_callback("luatexja.load_jfm", t, jfm_file_name)
 133    t.size_cache = {}
 134    defjfm_res = t
 135 end
 136
 137 local update_jfm_cache
 138 do
 139    local node_copy = Dnode.copy
 140    local kern_skel = node_new(id_kern)
 141    set_attr(kern_skel, attr_icflag, FROM_JFM)
 142    setfield(kern_skel, 'subtype', 1)
 143
 144    local function mult_table(old,scale) -- modified from table.fastcopy
 145       if old then
 146          local new = { }
 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)
 152             else
 153                new[k] = v
 154             end
 155          end
 156          return new
 157       else return nil end
 158    end
 159
 160    update_jfm_cache = function (j,sz)
 161       if metrics[j].size_cache[sz] then return end
 162       local t = {}
 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)
 178             end
 179             for k,w in pairs(v.kern) do
 180                local g = node_copy(kern_skel)
 181                setfield(g, 'kern', w[1])
 182                v[k] = {false, g, w[2]/sz}
 183             end
 184          end
 185          v.glue, v.kern = nil, nil
 186       end
 187       t.kanjiskip = mult_table(metrics[j].kanjiskip, sz)
 188       t.xkanjiskip = mult_table(metrics[j].xkanjiskip,sz)
 189       t.zw = round(metrics[j].zw*sz)
 190       t.zh = round(metrics[j].zh*sz)
 191       t.size = sz
 192    end
 193 end
 194
 195 luatexbase.create_callback("luatexja.find_char_class", "data",
 196                            function (arg, fmtable, char)
 197                               return 0
 198                            end)
 199 do
 200    local start_time_measure = ltjb.start_time_measure
 201    local stop_time_measure = ltjb.stop_time_measure
 202    local fcc_temp = { chars_cbcache = {} }
 203    setmetatable(
 204       fcc_temp.chars_cbcache,
 205       {
 206          __index = function () return 0 end,
 207       })
 208    function find_char_class(c,m)
 209       -- c: character code, m:
 210       local r = (m or fcc_temp).chars_cbcache[c]
 211       if not r then
 212          r = m.chars[c] or
 213             luatexbase.call_callback("luatexja.find_char_class", 0, m, c)
 214          m.chars_cbcache[c or 0] = r
 215       end
 216       return r
 217    end
 218 end
 219
 220
 221 ------------------------------------------------------------------------
 222 -- LOADING JAPANESE FONTS
 223 ------------------------------------------------------------------------
 224
 225 do
 226    local cstemp
 227    local global_flag -- true if \globaljfont, false if \jfont
 228    local function load_jfont_metric()
 229       if jfm_file_name=='' then
 230          ltjb.package_error('luatexja',
 231                             'no JFM specified',
 232                             'To load and define a Japanese font, a JFM must be specified.'..
 233                             "The JFM 'ujis' will be  used for now.")
 234          jfm_file_name='ujis'
 235       end
 236       for j,v in ipairs(metrics) do
 237          if v.name==jfm_file_name then return j end
 238       end
 239       luatexja.load_lua('jfm-' .. jfm_file_name .. '.lua')
 240       if defjfm_res then
 241          defjfm_res.name = jfm_file_name
 242          table.insert(metrics, defjfm_res)
 243          return #metrics
 244       else
 245          return nil
 246       end
 247    end
 248
 249 -- EXT
 250    function jfontdefX(g, dir)
 251       jfm_dir, is_def_jfont = dir, true
 252       local t = token.get_next()
 253       cstemp=token.csname_name(t)
 254       global_flag = g and '\\global' or ''
 255       tex.sprint(cat_lp, '\\expandafter\\font\\csname ', cstemp, '\\endcsname')
 256    end
 257
 258    luatexbase.create_callback("luatexja.define_jfont", "data", function (ft, fn) return ft end)
 259
 260 -- EXT
 261    local identifiers = fonts.hashes.identifiers
 262    function jfontdefY()
 263       local j = load_jfont_metric(jfm_dir)
 264       local fn = font.id(cstemp)
 265       local f = font_getfont(fn)
 266       if not j then
 267          ltjb.package_error('luatexja',
 268                             "bad JFM `" .. jfm_file_name .. "'",
 269                             'The JFM file you specified is not valid JFM file.\n'..
 270                                'So defining Japanese font is cancelled.')
 271          tex.sprint(cat_lp, global_flag, '\\expandafter\\let\\csname ', cstemp,
 272                        '\\endcsname=\\relax')
 273          return
 274       end
 275       update_jfm_cache(j, f.size)
 276       local ad = identifiers[fn].parameters
 277       local sz = metrics[j].size_cache[f.size]
 278       local fmtable = { jfm = j, size = f.size, var = jfm_var,
 279                         zw = sz.zw, zh = sz.zh,
 280                         ascent = ad.ascender,
 281                         descent = ad.descender,
 282                         chars = sz.chars, char_type = sz.char_type,
 283                         kanjiskip = sz.kanjiskip, xkanjiskip = sz.xkanjiskip,
 284                         chars_cbcache = {},
 285       }
 286
 287       fmtable = luatexbase.call_callback("luatexja.define_jfont", fmtable, fn)
 288       font_metric_table[fn]=fmtable
 289       tex.sprint(cat_lp, global_flag, '\\protected\\expandafter\\def\\csname ',
 290                     cstemp , '\\endcsname{\\ltj@cur'..
 291                     (jfm_dir == 'yoko' and 'j' or 't') .. 'fnt', fn, '\\relax}')
 292    end
 293 end
 294
 295 do
 296    local get_dir_count = ltjd.get_dir_count
 297    local dir_tate = luatexja.dir_table.dir_tate
 298    local tex_get_attr = tex.getattribute
 299    -- PUBLIC function
 300    function get_zw()
 301       local a = font_metric_table[
 302          tex_get_attr((get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)]
 303       return a and a.zw or 0
 304    end
 305    function get_zh()
 306       local a = font_metric_table[
 307          tex_get_attr((get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)]
 308       return a and a.zw or 0
 309    end
 310 end
 311
 312 do
 313    -- extract jfm_file_name and jfm_var
 314    -- normalize position of 'jfm=' and 'jfmvar=' keys
 315    local function extract_metric(name)
 316       jfm_file_name = ''; jfm_var = ''
 317       local tmp, index = name:sub(1, 5), 1
 318       if tmp == 'file:' or tmp == 'name:' or tmp == 'psft:' then
 319          index = 6
 320       end
 321       local p = name:find(":", index); index = p and (p+1) or index
 322       while index do
 323          local l = name:len()+1
 324          local q = name:find(";", index+1) or l
 325          if name:sub(index, index+3)=='jfm=' and q>index+4 then
 326             jfm_file_name = name:sub(index+4, q-1)
 327             if l~=q then
 328                name = name:sub(1,index-1) .. name:sub(q+1)
 329             else
 330                name = name:sub(1,index-1)
 331                index = nil
 332             end
 333          elseif name:sub(index, index+6)=='jfmvar=' and q>index+6 then
 334             jfm_var = name:sub(index+7, q-1)
 335             if l~=q then
 336                name = name:sub(1,index-1) .. name:sub(q+1)
 337             else
 338                name = name:sub(1,index-1)
 339                index = nil
 340             end
 341          else
 342             index = (l~=q) and (q+1) or nil
 343          end
 344       end
 345       if jfm_file_name~='' then
 346          local l = name:sub(-1)
 347          name = name
 348             .. ((l==':' or l==';') and '' or ';')
 349             .. 'jfm=' .. jfm_file_name
 350          if jfm_var~='' then
 351             name = name .. 'jfmvar=' .. jfm_var
 352          end
 353       end
 354       if jfm_dir == 'tate' then
 355          if not name:match('vert') and not name:match('vrt2') then
 356             name = name .. ';vert;vrt2'
 357          end
 358       end
 359       return name
 360    end
 361
 362    -- define_font callback
 363    local otfl_fdr = fonts.definers.read
 364    local ltjr_font_callback = ltjr.font_callback
 365    function luatexja.font_callback(name, size, id)
 366       local new_name = is_def_jfont and extract_metric(name) or name
 367       is_def_jfont = false
 368       local res =  ltjr_font_callback(new_name, size, id, otfl_fdr)
 369       luatexbase.call_callback('luatexja.define_font', res, new_name, size, id)
 370       -- this callback processes variation selector, so we execute it always
 371       return res
 372    end
 373    luatexbase.create_callback('luatexja.define_font', 'simple', function (n) return n end)
 374    luatexbase.add_to_callback('define_font',luatexja.font_callback,"luatexja.font_callback", 1)
 375 end
 376
 377 ------------------------------------------------------------------------
 378 -- LATEX INTERFACE
 379 ------------------------------------------------------------------------
 380 do
 381    -- these function are called from ltj-latex.sty
 382    local kyenc_list, ktenc_list = {}, {}
 383    function add_kyenc_list(enc) kyenc_list[enc] = 'true ' end
 384    function add_ktenc_list(enc) ktenc_list[enc] = 'true ' end
 385    function is_kyenc(enc)
 386       tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (kyenc_list[enc] or 'false '))
 387    end
 388    function is_ktenc(enc)
 389       tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (ktenc_list[enc] or 'false '))
 390    end
 391    function is_kenc(enc)
 392       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 393                  .. (kyenc_list[enc] or ktenc_list[enc] or 'false '))
 394    end
 395
 396    local kfam_list, Nkfam_list = {}, {}
 397    function add_kfam_list(enc, fam)
 398       if not kfam_list[enc] then kfam_list[enc] = {} end
 399       kfam_list[enc][fam] = 'true '
 400    end
 401    function add_Nkfam_list(enc, fam)
 402       if not Nkfam_list[enc] then Nkfam_list[enc] = {} end
 403       Nkfam_list[enc][fam] = 'true '
 404    end
 405    function is_kfam(enc, fam)
 406       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 407                  .. (kfam_list[enc] and kfam_list[enc][fam] or 'false ')) end
 408    function is_Nkfam(enc, fam)
 409       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 410                  .. (Nkfam_list[enc] and Nkfam_list[enc][fam] or 'false ')) end
 411
 412    local ffam_list, Nffam_list = {}, {}
 413    function add_ffam_list(enc, fam)
 414       if not ffam_list[enc] then ffam_list[enc] = {} end
 415       ffam_list[enc][fam] = 'true '
 416    end
 417    function add_Nffam_list(enc, fam)
 418       if not Nffam_list[enc] then Nffam_list[enc] = {} end
 419       Nffam_list[enc][fam] = 'true '
 420    end
 421    function is_ffam(enc, fam)
 422       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 423                  .. (ffam_list[enc] and ffam_list[enc][fam] or 'false ')) end
 424    function is_Nffam(enc, fam)
 425       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 426                  .. (Nffam_list[enc] and Nffam_list[enc][fam] or 'false ')) end
 427 end
 428 ------------------------------------------------------------------------
 429 -- ALTERNATE FONTS
 430 ------------------------------------------------------------------------
 431 alt_font_table = {}
 432 local alt_font_table = alt_font_table
 433 local attr_curaltfnt = {}
 434 local ucs_out = 0x110000
 435
 436 ------ for TeX interface
 437 -- EXT
 438 function set_alt_font(b,e,ind,bfnt)
 439    -- ind: 新フォント, bfnt: 基底フォント
 440    if b>e then b, e = e, b end
 441    if b*e<=0 then
 442       ltjb.package_error('luatexja',
 443                         'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 444                            'I take the intersection with [0x80, 0x10ffff].')
 445       b, e = math.max(0x80,b),math.min(ucs_out-1,e)
 446    elseif e<0 then -- b<e<0
 447       -- do nothing
 448    elseif b<0x80 or e>=ucs_out then
 449       ltjb.package_warning('luatexja',
 450                            'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 451                               'I take the intersection with [0x80, 0x10ffff].')
 452       b, e = math.max(0x80,b), math.min(ucs_out-1,e)
 453    end
 454    if not alt_font_table[bfnt] then alt_font_table[bfnt]={} end
 455    local t = alt_font_table[bfnt]
 456    local ac = font_getfont(ind).characters
 457    if bfnt==ind then ind = nil end -- ind == bfnt の場合はテーブルから削除
 458    if e>=0 then -- character range
 459       for i=b, e do
 460          if ac[i]then  t[i]=ind end
 461       end
 462    else
 463       b, e = -e, -b
 464       local tx = font_metric_table[bfnt].chars
 465       for i,v in pairs(tx) do
 466          if b<=v and v<=e and ac[i] then t[i]=ind end
 467       end
 468    end
 469 end
 470
 471 -- EXT
 472 function clear_alt_font(bfnt)
 473    if alt_font_table[bfnt] then
 474       local t = alt_font_table[bfnt]
 475       for i,_ in pairs(t) do t[i]=nil; end
 476    end
 477 end
 478
 479 ------ used in ltjp.suppress_hyphenate_ja callback
 480 function replace_altfont(pf, pc)
 481    local a = alt_font_table[pf]
 482    return a and a[pc] or pf
 483 end
 484
 485 ------ for LaTeX interface
 486
 487 local alt_font_table_latex = {}
 488
 489 -- EXT
 490 function clear_alt_font_latex(bbase)
 491    local t = alt_font_table_latex[bbase]
 492    if t then
 493       for j,v in pairs(t) do t[j] = nil end
 494    end
 495 end
 496
 497 -- EXT
 498 function set_alt_font_latex(b,e,ind,bbase)
 499    -- ind: Alt font の enc/fam/ser/shape, bbase: 基底フォントの enc/fam/ser/shape
 500    if b>e then b, e = e, b end
 501    if b*e<=0 then
 502       ltjb.package_error('luatexja',
 503                         'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 504                            'I take the intersection with [0x80, 0x10ffff].')
 505       b, e = math.max(0x80,b),math.min(ucs_out-1,e)
 506    elseif e<0 then -- b<e<0
 507       -- do nothing
 508    elseif b<0x80 or e>=ucs_out then
 509       ltjb.package_warning('luatexja',
 510                            'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 511                               'I take the intersection with [0x80, 0x10ffff].')
 512       b, e = math.max(0x80,b), math.min(ucs_out-1,e)
 513    end
 514
 515    if not alt_font_table_latex[bbase] then alt_font_table_latex[bbase]={} end
 516    local t = alt_font_table_latex[bbase]
 517    if not t[ind] then t[ind] = {} end
 518    for i=b, e do
 519       for j,v in pairs(t) do
 520          if v[i] then -- remove old entry
 521             if j~=ind then v[i]=nil end; break
 522          end
 523       end
 524       t[ind][i]=true
 525    end
 526    -- remove the empty tables
 527    for j,v in pairs(t) do
 528       local flag_clear = true
 529       for k,_ in pairs(v) do flag_clear = false; break end
 530       if flag_clear then t[j]=nil end
 531    end
 532    if ind==bbase  then t[bbase] = nil end
 533 end
 534
 535 -- ここから先は 新 \selectfont の内部でしか実行されない
 536 do
 537    local alt_font_base, alt_font_base_num
 538    local aftl_base
 539    -- EXT
 540    function does_alt_set(bbase)
 541       aftl_base = alt_font_table_latex[bbase]
 542       tex.sprint(cat_lp, '\\if' .. (aftl_base and 'true' or 'false'))
 543    end
 544    -- EXT
 545    function print_aftl_address()
 546       tex.sprint(cat_lp, ';ltjaltfont' .. tostring(aftl_base):sub(8))
 547    end
 548
 549 -- EXT
 550    function output_alt_font_cmd(dir, bbase)
 551       alt_font_base = bbase
 552       if dir == 't' then
 553          alt_font_base_num = tex.getattribute(attr_curtfnt)
 554       else
 555          alt_font_base_num = tex.getattribute(attr_curjfnt)
 556       end
 557       local t = alt_font_table[alt_font_base_num]
 558       if t then
 559          for i,_ in pairs(t) do t[i]=nil end
 560       end
 561       t = alt_font_table_latex[bbase]
 562       if t then
 563        for i,_ in pairs(t) do
 564             tex.sprint(cat_lp, '\\ltj@pickup@altfont@aux' .. dir .. '{' .. i .. '}')
 565          end
 566       end
 567    end
 568
 569 -- EXT
 570    function pickup_alt_font_a(size_str)
 571       local t = alt_font_table_latex[alt_font_base]
 572       if t then
 573          for i,v in pairs(t) do
 574             tex.sprint(cat_lp, '\\expandafter\\ltj@pickup@altfont@copy'
 575                           .. '\\csname ' .. i .. '/' .. size_str .. '\\endcsname{' .. i .. '}')
 576          end
 577       end
 578    end
 579
 580    local function pickup_alt_font_class(class, afnt_num, afnt_chars)
 581       local t  = alt_font_table[alt_font_base_num]
 582       local tx = font_metric_table[alt_font_base_num].chars
 583       for i,v in pairs(tx) do
 584          if v==class and afnt_chars[i] then t[i]=afnt_num end
 585       end
 586    end
 587
 588 -- EXT
 589    function pickup_alt_font_b(afnt_num, afnt_base)
 590       local t = alt_font_table[alt_font_base_num]
 591       local ac = font_getfont(afnt_num).characters
 592       if not t then t = {}; alt_font_table[alt_font_base_num] = t end
 593       for i,v in pairs(alt_font_table_latex[alt_font_base]) do
 594          if i == afnt_base then
 595             for j,_ in pairs(v) do
 596                if j>=0 then
 597                   if ac[j] then t[j]=afnt_num end
 598                else  -- -n (n>=1) means that the character class n,
 599                      -- which is defined in the JFM
 600                   pickup_alt_font_class(-j, afnt_num, ac)
 601                end
 602             end
 603             return
 604          end
 605       end
 606    end
 607
 608 end
 609
 610 ------------------------------------------------------------------------
 611 -- 追加のフォント情報
 612 ------------------------------------------------------------------------
 613 font_extra_info = {}
 614 local font_extra_info = font_extra_info -- key: fontnumber
 615 local font_extra_basename = {} -- key: basename
 616
 617 -- IVS and vertical metrics
 618 local prepare_fl_data
 619 local supply_vkern_table
 620 do
 621    local fields = fontloader.fields
 622    local function glyph_vmetric(glyph)
 623       local flds = fields(glyph)
 624       local vw, tsb, vk = nil, nil, nil
 625       for _,i in ipairs(flds) do
 626          if i=='vwidth' then vw = glyph.vwidth end
 627          if i=='tsidebearing' then tsb = glyph.tsidebearing end
 628          if i=='vkerns' then vk = glyph.vkerns end
 629       end
 630       return vw, tsb, vk
 631    end
 632
 633    local sort = table.sort
 634    local function add_fl_table(dest, tg, unitable, glyphmax, asc_des, units)
 635       for i = 0, glyphmax-1 do
 636          local gv = tg[i]
 637          if gv then
 638             if gv.altuni then
 639                for _,at in pairs(gv.altuni) do
 640                   local bu, vsel = at.unicode, at.variant
 641                   if vsel then
 642                      if vsel>=0xE0100 then vsel = vsel - 0xE0100 end
 643                      dest = dest or {}; dest[bu] = dest[bu] or {}
 644                      local uniq_flag = true
 645                      for i,_ in pairs(dest[bu]) do
 646                         if i==vs then uniq_flag = false; break end
 647                      end
 648                      if uniq_flag then
 649                         dest[bu][vsel] = unitable[gv.name]
 650                      end
 651                   end
 652                end
 653             end
 654             -- vertical metric
 655             local vw, tsb, vk = glyph_vmetric(gv)
 656             local gi = unitable[gv.name]
 657             if gi and vw and vw~=asc_des then
 658                -- We do not use tsidebearing, since (1) fontloader does not read VORG table
 659                -- and (2) 'tsidebearing' doea not appear in the returned table by fontloader.fields.
 660                -- Hence, we assume that vertical origin == ascender
 661                -- (see capsule_glyph_tate in ltj-setwidth.lua)
 662                dest = dest or {}; dest[gi] = dest[gi] or {}
 663                dest[gi].vwidth = vw/units
 664             end
 665             -- vertical kern
 666             if gi and vk then
 667                dest = dest or {};
 668                local dest_vk = dest.vkerns or {}; dest.vkerns = dest_vk
 669                for _,v in pairs(vk) do
 670                   local vl = v.lookup
 671                   if type(vl)=='table' then
 672                      for _,vlt in pairs(vl) do
 673                         dest_vk[vlt] = dest_vk[vlt] or {}
 674                         dest_vk[vlt][gi] = dest_vk[vlt][gi] or {}
 675                         dest_vk[vlt][gi][unitable[v.char]] = v.off
 676                      end
 677                   else
 678                      dest_vk[vl] = dest_vk[vl] or {}
 679                      dest_vk[vl][gi] = dest_vk[vl][gi] or {}
 680                      dest_vk[vl][gi][unitable[v.char]] = v.off
 681                   end
 682                end
 683             end
 684          end
 685       end
 686       return dest
 687    end
 688    prepare_fl_data = function (dest, id)
 689       local fl = fontloader.open(id.filename)
 690       local unicodes = id.resources.unicodes
 691       if fl.glyphs then
 692          dest = add_fl_table(dest, fl.glyphs, id.resources.unicodes, fl.glyphmax,
 693                              fl.ascent + fl.descent, fl.units_per_em)
 694       end
 695       if fl.subfonts then
 696          for _,v in pairs(fl.subfonts) do
 697             dest = add_fl_table(dest, v.glyphs, id.resources.unicodes, v.glyphmax,
 698                                 fl.ascent + fl.descent, fl.units_per_em)
 699          end
 700       end
 701       fontloader.close(fl); collectgarbage("collect")
 702       return dest
 703    end
 704    -- supply vkern table
 705    supply_vkern_table = function(id, bname)
 706       local bx = font_extra_basename[bname].vkerns
 707       local lookuphash =  id.resources.lookuphash
 708       local desc = id.shared.rawdata.descriptions
 709       if bx then
 710          for i,v in pairs(bx) do
 711             lookuphash[i] = lookuphash[i] or v
 712             for j,w in pairs(v) do
 713                desc[j].kerns = desc[j].kerns or {}
 714                desc[j].kerns[i] = w
 715             end
 716          end
 717       end
 718    end
 719 end
 720
 721 -- 縦書き用字形への変換テーブル
 722 local prepare_vert_data
 723 do
 724    -- local function add_feature_table(tname, src, dest)
 725    --    for i,v in pairs(src) do
 726    --       if type(v.slookups)=='table' then
 727    --          local s = v.slookups[tname]
 728    --          if s  then
 729    --             dest = dest or {}
 730    --             dest[i] = dest[i]  or {}
 731    --             dest[i].vert = dest[i].vert or s
 732    --          end
 733    --       end
 734    --    end
 735    --    return dest
 736    -- end
 737    -- prepare_vert_data = function (dest, id)
 738    --    local a = id.resources.sequences
 739    --    if a then
 740    --       local s = id.shared.rawdata.descriptions
 741    --       for i,v in pairs(a) do
 742    --          if v.features.vert or v.features.vrt2 then
 743    --             dest= add_feature_table(v.subtables[1], s, dest)
 744    --          end
 745    --       end
 746    --    end
 747    --    return dest
 748    -- end
 749    -- -- 縦書き用字形への変換
 750    -- function get_vert_glyph(n, chr)
 751    --    local fn = font_extra_info[n]
 752    --    return (fn and fn[chr] and fn[chr].vert) or chr
 753    -- end
 754 end
 755
 756 --
 757 do
 758    local cache_ver = 6
 759    local checksum = file.checksum
 760
 761    local function prepare_extra_data_base(id)
 762       if not id then return end
 763       local bname = file.nameonly(id.filename or '')
 764       if not font_extra_basename[bname] then
 765          -- if the cache is present, read it
 766          local newsum = checksum(id.filename) -- MD5 checksum of the fontfile
 767          local v = "extra_" .. string.lower(file.nameonly(id.filename))
 768          local dat = ltjb.load_cache(
 769             v,
 770             function (t) return (t.version~=cache_ver) or (t.chksum~=newsum) end
 771          )
 772          -- if the cache is not found or outdated, save the cache
 773          if dat then
 774             font_extra_basename[bname] = dat[1] or {}
 775          else
 776             local dat = nil
 777             dat = prepare_fl_data(dat, id)
 778             font_extra_basename[bname] = dat or {}
 779             ltjb.save_cache( v,
 780                              {
 781                                 chksum = checksum(id.filename),
 782                                 version = cache_ver,
 783                                 dat,
 784                              })
 785          end
 786          return bname
 787       end
 788    end
 789    local function prepare_extra_data_font(id, res)
 790       if type(res)=='table' and res.shared then
 791          font_extra_info[id] = font_extra_basename[file.nameonly(res.filename)]
 792       end
 793    end
 794     luatexbase.add_to_callback(
 795        'luaotfload.patch_font',
 796        function (tfmdata)
 797           -- these function is executed one time per one fontfile
 798           local bname = prepare_extra_data_base(tfmdata)
 799           if bname then supply_vkern_table(tfmdata, bname) end
 800           return tfmdata
 801        end,
 802        'ltj.prepare_extra_data', 1)
 803    luatexbase.add_to_callback(
 804       'luatexja.define_font',
 805       function (res, name, size, id)
 806          prepare_extra_data_font(id, res)
 807       end,
 808       'ltj.prepare_extra_data', 1)
 809
 810    local nulltable = {} -- dummy
 811    ltjr.vert_addfunc = function (n) font_extra_info[n] = nulltable end
 812
 813    local identifiers = fonts.hashes.identifiers
 814    for i=1,font.nextid()-1 do
 815       if identifiers[i] then
 816          prepare_extra_data_base(identifiers[i])
 817          prepare_extra_data_font(i,identifiers[i])
 818       end
 819    end
 820 end
 821
 822
 823 ------------------------------------------------------------------------
 824 -- calculate vadvance
 825 ------------------------------------------------------------------------
 826 do
 827    local function acc_feature(table_vadv, table_vorg, subtables, ft,  already_vert)
 828       for char_num,v in pairs(ft.shared.rawdata.descriptions) do
 829          if v.slookups then
 830             for sn, sv in pairs(v.slookups) do
 831                if subtables[sn] and type(sv)=='table' then
 832                   if sv[4]~=0 then
 833                      table_vadv[char_num]
 834                         = (table_vadv[char_num] or 0) + sv[4]
 835                   end
 836                   if sv[2]~=0 and not already_vert then
 837                      table_vorg[char_num]
 838                         = (table_vorg[char_num] or 0) + sv[2]
 839                   end
 840                end
 841             end
 842          end
 843       end
 844    end
 845
 846 luatexbase.add_to_callback(
 847    "luatexja.define_jfont",
 848    function (fmtable, fnum)
 849       local vadv = {}; fmtable.v_advance = vadv
 850       local vorg = {}; fmtable.v_origin = vorg
 851       local ft = font_getfont(fnum)
 852       local subtables = {}
 853       if ft.specification then
 854          for feat_name,v in pairs(ft.specification.features.normal) do
 855             if v==true then
 856                for _,i in pairs(ft.resources.sequences) do
 857                   if i.order[1]== feat_name and i.type == 'gpos_single' then
 858                      for _,st in pairs(i.subtables) do
 859                         subtables[st] = true
 860                      end
 861                   end
 862                end
 863             end
 864          end
 865          acc_feature(vadv, vorg, subtables, ft,
 866                      ft.specification.features.normal.vrt2 or ft.specification.features.normal.vert)
 867          for i,v in pairs(vadv) do
 868             vadv[i]=vadv[i]/ft.units_per_em*fmtable.size
 869          end
 870          for i,v in pairs(vorg) do
 871             vorg[i]=vorg[i]/ft.units_per_em*fmtable.size
 872          end
 873       end
 874       return fmtable
 875    end, 1, 'ltj.v_advance'
 876 )
 877 end
 878 ------------------------------------------------------------------------
 879 -- MISC
 880 ------------------------------------------------------------------------
 881 do
 882    local get_dir_count = ltjd.get_dir_count
 883    local is_ucs_in_japanese_char = ltjc.is_ucs_in_japanese_char_direct
 884    local ensure_tex_attr = ltjb.ensure_tex_attr
 885    local font = font
 886    -- EXT: italic correction
 887    function append_italic()
 888       local p = to_direct(tex.nest[tex.nest.ptr].tail)
 889       if p and getid(p)==id_glyph then
 890          local f = getfont(p)
 891          local g = node_new(id_kern)
 892          setfield(g, 'subtype', 1)
 893          set_attr(g, attr_icflag, ITALIC)
 894          if is_ucs_in_japanese_char(p) then
 895             f = has_attr(p, (get_dir_count()==dir_tate) and attr_curtfnt or attr_curjfnt)
 896             local j = font_metric_table[f]
 897             setfield(g, 'kern', j.char_type[find_char_class(getchar(p), j)].italic)
 898          else
 899             local h = font_getfont(f) or font.fonts[f]
 900             if h then
 901                setfield(g, 'kern', h.characters[getchar(p)].italic)
 902             else
 903                ensure_tex_attr(attr_icflag, 0)
 904                return node_free(g)
 905             end
 906          end
 907          node_write(g)
 908          ensure_tex_attr(attr_icflag, 0)
 909       end
 910    end
 911 end