src/ltj-jfont.lua

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