src/ltj-jfont.lua

   1 --
   2 -- luatexja/jfont.lua
   3 --
   4 luatexbase.provides_module({
   5   name = 'luatexja.jfont',
   6   date = '2014/02/01',
   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
  14 local mem_leak_glue, mem_leak_gs, mem_leak_kern = 0, 0, 0
  15
  16 local Dnode = node.direct or node
  17
  18 local setfield = (Dnode ~= node) and Dnode.setfield or function(n, i, c) n[i] = c end
  19 local getid = (Dnode ~= node) and Dnode.getid or function(n) return n.id end
  20 local getfont = (Dnode ~= node) and Dnode.getfont or function(n) return n.font end
  21 local getchar = (Dnode ~= node) and Dnode.getchar or function(n) return n.char end
  22
  23 local nullfunc = function(n) return n end
  24 local to_direct = (Dnode ~= node) and Dnode.todirect or nullfunc
  25
  26 local node_new = Dnode.new
  27 local node_free = Dnode.free
  28 local has_attr = Dnode.has_attribute
  29 local set_attr = Dnode.set_attribute
  30 local node_write = Dnode.write
  31 local round = tex.round
  32 local font_getfont = font.getfont
  33
  34 local attr_icflag = luatexbase.attributes['ltj@icflag']
  35 local attr_curjfnt = luatexbase.attributes['ltj@curjfnt']
  36 local id_glyph = node.id('glyph')
  37 local id_kern = node.id('kern')
  38 local id_glue_spec = node.id('glue_spec')
  39 local id_glue = node.id('glue')
  40 local cat_lp = luatexbase.catcodetables['latex-package']
  41 local ITALIC       = luatexja.icflag_table.ITALIC
  42 local FROM_JFM     = luatexja.icflag_table.FROM_JFM
  43
  44 ------------------------------------------------------------------------
  45 -- LOADING JFM
  46 ------------------------------------------------------------------------
  47
  48 metrics={} -- this table stores all metric informations
  49 font_metric_table={} -- [font number] -> jfm_name, jfm_var, size
  50
  51 luatexbase.create_callback("luatexja.load_jfm", "data", function (ft, jn) return ft end)
  52
  53 local jfm_file_name, jfm_var
  54 local defjfm_res
  55
  56 function define_jfm(t)
  57    local real_char -- Does current character class have the 'real' character?
  58    if t.dir~='yoko' then
  59       defjfm_res= nil; return
  60    elseif type(t.zw)~='number' or type(t.zh)~='number' then
  61       defjfm_res= nil; return
  62    end
  63    t.char_type = {}; t.chars = {}
  64    for i,v in pairs(t) do
  65       if type(i) == 'number' then -- char_type
  66          if not v.chars then
  67             if i ~= 0 then defjfm_res= nil; return  end
  68             real_char = true
  69          else
  70             real_char = false
  71             for j,w in pairs(v.chars) do
  72                if type(w) == 'number' then
  73                   real_char = true;
  74                elseif type(w) == 'string' and utf.len(w)==1 then
  75                   real_char = true; w = utf.byte(w)
  76                elseif type(w) == 'string' and utf.len(w)==2 and utf.sub(w,2) == '*' then
  77                   real_char = true; w = utf.byte(utf.sub(w,1,1))
  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 not t.chars[w] then
  85                   t.chars[w] = i
  86                else
  87                   defjfm_res= nil; return
  88                end
  89             end
  90             if type(v.align)~='string' then
  91                v.align = 'left' -- left
  92             end
  93             if real_char then
  94                if not (type(v.width)=='number' or v.width~='prop') then
  95                   defjfm_res= nil; return
  96                else
  97                   if type(v.height)~='number' then
  98                      v.height = 0.0
  99                   end
 100                   if type(v.depth)~='number' then
 101                      v.depth = 0.0
 102                   end
 103                   if type(v.italic)~='number' then
 104                      v.italic = 0.0
 105                   end
 106                   if type(v.left)~='number' then
 107                      v.left = 0.0
 108                   end
 109                   if type(v.down)~='number' then
 110                      v.down = 0.0
 111                   end
 112                end
 113             end
 114             v.chars = nil
 115          end
 116          v.kern = v.kern or {}; v.glue = v.glue or {}
 117          for j in pairs(v.glue) do
 118             if v.kern[j] then defjfm_res= nil; return end
 119          end
 120          for j,x in pairs(v.kern) do
 121             if type(x)=='number' then
 122                v.kern[j] = {x, 0}
 123             elseif type(x)=='table' then
 124                v.kern[j] = {x[1], x[2] or 0}
 125             end
 126          end
 127          t.char_type[i] = v
 128          t[i] = nil
 129       end
 130    end
 131    t = luatexbase.call_callback("luatexja.load_jfm", t, jfm_file_name)
 132    t.size_cache = {}
 133    defjfm_res = t
 134 end
 135
 136 local update_jfm_cache
 137 do
 138    local function mult_table(old,scale) -- modified from table.fastcopy
 139       if old then
 140          local new = { }
 141          for k,v in next, old do
 142             if type(v) == "table" then
 143                new[k] = mult_table(v,scale)
 144             elseif type(v) == "number" then
 145                new[k] = round(v*scale)
 146             else
 147                new[k] = v
 148             end
 149          end
 150          return new
 151       else return nil end
 152    end
 153
 154    update_jfm_cache = function (j,sz)
 155       if metrics[j].size_cache[sz] then return end
 156       local t = {}
 157       metrics[j].size_cache[sz] = t
 158       t.chars = metrics[j].chars
 159       t.char_type = mult_table(metrics[j].char_type, sz)
 160       for i,v in pairs(t.char_type) do
 161          v.align = (v.align=='left') and 0 or
 162             ((v.align=='right') and 1 or 0.5)
 163          if type(i) == 'number' then -- char_type
 164             for k,w in pairs(v.glue) do
 165                local h = node_new(id_glue_spec)
 166 mem_leak_gs = mem_leak_gs+1
 167                v[k] = {true, h, (w[5] and w[5]/sz or 0), FROM_JFM + (w[4] and w[4]/sz or 0)}
 168                setfield(h, 'width', w[1])
 169                setfield(h, 'stretch', w[2])
 170                setfield(h, 'shrink', w[3])
 171                setfield(h, 'stretch_order', 0)
 172                setfield(h, 'shrink_order', 0)
 173             end
 174             for k,w in pairs(v.kern) do
 175                local g = node_new(id_kern)
 176 mem_leak_kern = mem_leak_kern +1
 177                setfield(g, 'kern', w[1])
 178                setfield(g, 'subtype', 1)
 179                set_attr(g, attr_icflag, FROM_JFM)
 180                v[k] = {false, g, w[2]/sz}
 181             end
 182          end
 183       end
 184       t.kanjiskip = mult_table(metrics[j].kanjiskip, sz)
 185       t.xkanjiskip = mult_table(metrics[j].xkanjiskip,sz)
 186       t.zw = round(metrics[j].zw*sz)
 187       t.zh = round(metrics[j].zh*sz)
 188    end
 189 end
 190
 191 luatexbase.create_callback("luatexja.find_char_class", "data",
 192                            function (arg, fmtable, char)
 193                               return 0
 194                            end)
 195
 196 function find_char_class(c,m)
 197 -- c: character code, m:
 198    if not m then return 0 end
 199    return m.chars[c] or
 200       luatexbase.call_callback("luatexja.find_char_class", 0, m, c)
 201 end
 202
 203
 204 ------------------------------------------------------------------------
 205 -- LOADING JAPANESE FONTS
 206 ------------------------------------------------------------------------
 207
 208 do
 209    local cstemp
 210    local global_flag -- true if \globaljfont, false if \jfont
 211    local function load_jfont_metric()
 212       if jfm_file_name=='' then
 213          ltjb.package_error('luatexja',
 214                             'no JFM specified',
 215                             'To load and define a Japanese font, a JFM must be specified.'..
 216                             "The JFM 'ujis' will be  used for now.")
 217          jfm_file_name='ujis'
 218       end
 219       for j,v in ipairs(metrics) do
 220          if v.name==jfm_file_name then return j end
 221       end
 222       luatexja.load_lua('jfm-' .. jfm_file_name .. '.lua')
 223       if defjfm_res then
 224          defjfm_res.name = jfm_file_name
 225          table.insert(metrics, defjfm_res)
 226          return #metrics
 227       else
 228          return nil
 229       end
 230    end
 231
 232 -- EXT
 233    function jfontdefX(g)
 234       local t = token.get_next()
 235       cstemp=token.csname_name(t)
 236       global_flag = g and '\\global' or ''
 237       tex.sprint(cat_lp, '\\expandafter\\font\\csname ' .. cstemp .. '\\endcsname')
 238    end
 239
 240    luatexbase.create_callback("luatexja.define_jfont", "data", function (ft, fn) return ft end)
 241
 242 -- EXT
 243    function jfontdefY() -- for horizontal font
 244       local j = load_jfont_metric()
 245       local fn = font.id(cstemp)
 246       local f = font_getfont(fn)
 247       if not j then
 248          ltjb.package_error('luatexja',
 249                             "bad JFM `" .. jfm_file_name .. "'",
 250                             'The JFM file you specified is not valid JFM file.\n'..
 251                                'So defining Japanese font is cancelled.')
 252          tex.sprint(cat_lp, global_flag .. '\\expandafter\\let\\csname ' ..cstemp
 253                        .. '\\endcsname=\\relax')
 254          return
 255       end
 256       update_jfm_cache(j, f.size)
 257       --print('MEMORY LEAK (acc): ', mem_leak_glue, mem_leak_gs, mem_leak_kern)
 258       local sz = metrics[j].size_cache[f.size]
 259       local fmtable = { jfm = j, size = f.size, var = jfm_var,
 260                         zw = sz.zw, zh = sz.zh,
 261                         chars = sz.chars, char_type = sz.char_type,
 262                         kanjiskip = sz.kanjiskip, xkanjiskip = sz.xkanjiskip,
 263       }
 264
 265       fmtable = luatexbase.call_callback("luatexja.define_jfont", fmtable, fn)
 266       font_metric_table[fn]=fmtable
 267       tex.sprint(cat_lp, global_flag .. '\\protected\\expandafter\\def\\csname '
 268                     .. cstemp  .. '\\endcsname{\\ltj@curjfnt=' .. fn .. '\\relax}')
 269    end
 270 end
 271
 272 do
 273    -- PUBLIC function
 274    function get_zw()
 275       local a = font_metric_table[tex.attribute[attr_curjfnt]]
 276       return a and a.zw or 0
 277    end
 278    function get_zh()
 279       local a = font_metric_table[tex.attribute[attr_curjfnt]]
 280       return a and a.zw or 0
 281    end
 282 end
 283
 284 do
 285    -- extract jfm_file_name and jfm_var
 286    local function extract_metric(name)
 287       local basename=name
 288       local tmp = utf.sub(basename, 1, 5)
 289       jfm_file_name = ''; jfm_var = ''
 290       if tmp == 'file:' or tmp == 'name:' or tmp == 'psft:' then
 291          basename = utf.sub(basename, 6)
 292       end
 293       local p = utf.find(basename, ":")
 294       if p then
 295          basename = utf.sub(basename, p+1)
 296       else return
 297       end
 298       -- now basename contains 'features' only.
 299       p=1
 300       while p do
 301          local q = utf.find(basename, ";", p+1) or utf.len(basename)+1
 302          if utf.sub(basename, p, p+3)=='jfm=' and q>p+4 then
 303             jfm_file_name = utf.sub(basename, p+4, q-1)
 304          elseif utf.sub(basename, p, p+6)=='jfmvar=' and q>p+6 then
 305             jfm_var = utf.sub(basename, p+7, q-1)
 306          end
 307          if utf.len(basename)+1==q then p = nil else p = q + 1 end
 308       end
 309       return
 310    end
 311
 312    -- replace fonts.define.read()
 313    function font_callback(name, size, id, fallback)
 314       extract_metric(name)
 315       -- In the present imple., we don't remove "jfm=..." from name.
 316       return fallback(name, size, id)
 317    end
 318 end
 319
 320 ------------------------------------------------------------------------
 321 -- LATEX INTERFACE
 322 ------------------------------------------------------------------------
 323 do
 324    -- these function are called from ltj-latex.sty
 325    local kyenc_list, ktenc_list = {}, {}
 326    function add_kyenc_list(enc) kyenc_list[enc] = 'true ' end
 327    function add_ktenc_list(enc) ktenc_list[enc] = 'true ' end
 328    function is_kyenc(enc)
 329       tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (kyenc_list[enc] or 'false '))
 330    end
 331    function is_kyenc(enc)
 332       tex.sprint(cat_lp, '\\let\\ifin@\\if' .. (kyenc_list[enc] or 'false '))
 333    end
 334    function is_kenc(enc)
 335       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 336                  .. (kyenc_list[enc] or ktenc_list[enc] or 'false '))
 337    end
 338
 339    local kfam_list, Nkfam_list = {}, {}
 340    function add_kfam_list(enc, fam)
 341       if not kfam_list[enc] then kfam_list[enc] = {} end
 342       kfam_list[enc][fam] = 'true '
 343    end
 344    function add_Nkfam_list(enc, fam)
 345       if not Nkfam_list[enc] then Nkfam_list[enc] = {} end
 346       Nkfam_list[enc][fam] = 'true '
 347    end
 348    function is_kfam(enc, fam)
 349       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 350                  .. (kfam_list[enc] and kfam_list[enc][fam] or 'false ')) end
 351    function is_Nkfam(enc, fam)
 352       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 353                  .. (Nkfam_list[enc] and Nkfam_list[enc][fam] or 'false ')) end
 354
 355    local ffam_list, Nffam_list = {}, {}
 356    function add_ffam_list(enc, fam)
 357       if not ffam_list[enc] then ffam_list[enc] = {} end
 358       ffam_list[enc][fam] = 'true '
 359    end
 360    function add_Nffam_list(enc, fam)
 361       if not Nffam_list[enc] then Nffam_list[enc] = {} end
 362       Nffam_list[enc][fam] = 'true '
 363    end
 364    function is_ffam(enc, fam)
 365       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 366                  .. (ffam_list[enc] and ffam_list[enc][fam] or 'false ')) end
 367    function is_Nffam(enc, fam)
 368       tex.sprint(cat_lp, '\\let\\ifin@\\if'
 369                  .. (Nffam_list[enc] and Nffam_list[enc][fam] or 'false ')) end
 370 end
 371 ------------------------------------------------------------------------
 372 -- ALTERNATE FONTS
 373 ------------------------------------------------------------------------
 374 alt_font_table = {}
 375 local alt_font_table = alt_font_table
 376 local attr_curaltfnt = {}
 377 local ucs_out = 0x110000
 378
 379 ------ for TeX interface
 380 -- EXT
 381 function set_alt_font(b,e,ind,bfnt)
 382    -- ind: 新フォント, bfnt: 基底フォント
 383    if b>e then b, e = e, b end
 384    if b*e<=0 then
 385       ltjb.package_eror('luatexja',
 386                         'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 387                            'I take the intersection with [0x80, 0x10ffff].')
 388       b, e = math.max(0x80,b),math.min(ucs_out-1,e)
 389    elseif e<0 then -- b<e<0
 390       -- do nothing
 391    elseif b<0x80 or e>=ucs_out then
 392       ltjb.package_warning('luatexja',
 393                            'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 394                               'I take the intersection with [0x80, 0x10ffff].')
 395       b, e = math.max(0x80,b), math.min(ucs_out-1,e)
 396    end
 397    if not alt_font_table[bfnt] then alt_font_table[bfnt]={} end
 398    local t = alt_font_table[bfnt]
 399    local ac = font_getfont(ind).characters
 400    if bfnt==ind then ind = nil end -- ind == bfnt の場合はテーブルから削除
 401    if e>=0 then -- character range
 402       for i=b, e do
 403          if ac[i]then  t[i]=ind end
 404       end
 405    else
 406       b, e = -e, -b
 407       local tx = font_metric_table[bfnt].chars
 408       for i,v in pairs(tx) do
 409          if b<=v and v<=e and ac[i] then t[i]=ind end
 410       end
 411    end
 412 end
 413
 414 -- EXT
 415 function clear_alt_font(bfnt)
 416    if alt_font_table[bfnt] then
 417       local t = alt_font_table[bfnt]
 418       for i,_ in pairs(t) do t[i]=nil; end
 419    end
 420 end
 421
 422 ------ used in ltjp.suppress_hyphenate_ja callback
 423 function replace_altfont(pf, pc)
 424    local a = alt_font_table[pf]
 425    return a and a[pc] or pf
 426 end
 427
 428 ------ for LaTeX interface
 429
 430 local alt_font_table_latex = {}
 431
 432 -- EXT
 433 function clear_alt_font_latex(bbase)
 434    local t = alt_font_table_latex[bbase]
 435    if t then
 436       for j,v in pairs(t) do t[j] = nil end
 437    end
 438 end
 439
 440 -- EXT
 441 function set_alt_font_latex(b,e,ind,bbase)
 442    -- ind: Alt font の enc/fam/ser/shape, bbase: 基底フォントの enc/fam/ser/shape
 443    if b>e then b, e = e, b end
 444    if b*e<=0 then
 445       ltjb.package_eror('luatexja',
 446                         'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 447                            'I take the intersection with [0x80, 0x10ffff].')
 448       b, e = math.max(0x80,b),math.min(ucs_out-1,e)
 449    elseif e<0 then -- b<e<0
 450       -- do nothing
 451    elseif b<0x80 or e>=ucs_out then
 452       ltjb.package_warning('luatexja',
 453                            'bad character range ([' .. b .. ',' .. e .. ']). ' ..
 454                               'I take the intersection with [0x80, 0x10ffff].')
 455       b, e = math.max(0x80,b), math.min(ucs_out-1,e)
 456    end
 457
 458    if not alt_font_table_latex[bbase] then alt_font_table_latex[bbase]={} end
 459    local t = alt_font_table_latex[bbase]
 460    if not t[ind] then t[ind] = {} end
 461    for i=b, e do
 462       for j,v in pairs(t) do
 463          if v[i] then -- remove old entry
 464             if j~=ind then v[i]=nil end; break
 465          end
 466       end
 467       t[ind][i]=true
 468    end
 469    -- remove the empty tables
 470    for j,v in pairs(t) do
 471       local flag_clear = true
 472       for k,_ in pairs(v) do flag_clear = false; break end
 473       if flag_clear then t[j]=nil end
 474    end
 475    if ind==bbase  then t[bbase] = nil end
 476 end
 477
 478 -- ここから先は 新 \selectfont の内部でしか実行されない
 479 do
 480    local alt_font_base, alt_font_base_num
 481    local aftl_base
 482    -- EXT
 483    function does_alt_set(bbase)
 484       aftl_base = alt_font_table_latex[bbase]
 485       tex.sprint(cat_lp, '\\if' .. (aftl_base and 'true' or 'false'))
 486    end
 487    -- EXT
 488    function print_aftl_address()
 489       tex.sprint(cat_lp, ';ltjaltfont' .. tostring(aftl_base):sub(8))
 490    end
 491
 492 -- EXT
 493    function output_alt_font_cmd(bbase)
 494       alt_font_base = bbase
 495       alt_font_base_num = tex.getattribute(attr_curjfnt)
 496       local t = alt_font_table[alt_font_base_num]
 497       if t then
 498          for i,_ in pairs(t) do t[i]=nil end
 499       end
 500       t = alt_font_table_latex[bbase]
 501       if t then
 502          for i,_ in pairs(t) do
 503             tex.sprint(cat_lp, '\\ltj@pickup@altfont@aux{' .. i .. '}')
 504          end
 505       end
 506    end
 507
 508 -- EXT
 509    function pickup_alt_font_a(size_str)
 510       local t = alt_font_table_latex[alt_font_base]
 511       if t then
 512          for i,v in pairs(t) do
 513             tex.sprint(cat_lp, '\\expandafter\\ltj@pickup@altfont@copy'
 514                           .. '\\csname ' .. i .. '/' .. size_str .. '\\endcsname{' .. i .. '}')
 515          end
 516       end
 517    end
 518
 519    local function pickup_alt_font_class(class, afnt_num, afnt_chars)
 520       local t  = alt_font_table[alt_font_base_num]
 521       local tx = font_metric_table[alt_font_base_num].chars
 522       for i,v in pairs(tx) do
 523          if v==class and afnt_chars[i] then t[i]=afnt_num end
 524       end
 525    end
 526
 527 -- EXT
 528    function pickup_alt_font_b(afnt_num, afnt_base)
 529       local t = alt_font_table[alt_font_base_num]
 530       local ac = font_getfont(afnt_num).characters
 531       if not t then t = {}; alt_font_table[alt_font_base_num] = t end
 532       for i,v in pairs(alt_font_table_latex[alt_font_base]) do
 533          if i == afnt_base then
 534             for j,_ in pairs(v) do
 535                if j>=0 then
 536                   if ac[j] then t[j]=afnt_num end
 537                else  -- -n (n>=1) means that the character class n,
 538                      -- which is defined in the JFM
 539                   pickup_alt_font_class(-j, afnt_num, ac)
 540                end
 541             end
 542             return
 543          end
 544       end
 545    end
 546
 547 end
 548
 549
 550 ------------------------------------------------------------------------
 551 -- MISC
 552 ------------------------------------------------------------------------
 553
 554 local is_ucs_in_japanese_char = ltjc.is_ucs_in_japanese_char_direct
 555 -- EXT: italic correction
 556 function append_italic()
 557    local p = to_direct(tex.nest[tex.nest.ptr].tail)
 558    if p and getid(p)==id_glyph then
 559       local f = getfont(p)
 560       local g = node_new(id_kern)
 561       setfield(g, 'subtype', 1)
 562       set_attr(g, attr_icflag, ITALIC)
 563       if is_ucs_in_japanese_char(p) then
 564          f = has_attr(p, attr_curjfnt)
 565          local j = font_metric_table[f]
 566          setfield(g, 'kern', j.char_type[find_char_class(getchar(p), j)].italic)
 567       else
 568          local h = font_getfont(f)
 569          if h then
 570             setfield(g, 'kern', h.characters[getchar(p)].italic)
 571          else
 572             tex.attribute[attr_icflag] = 0
 573             return node_free(g)
 574          end
 575       end
 576       node_write(g)
 577       tex.attribute[attr_icflag] = 0
 578    end
 579 end