src/ltj-jfont.lua

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