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