src/ltj-jfont.lua

   1 --
   2 -- luatexja/jfont.lua
   3 --
   4 luatexbase.provides_module({
   5   name = 'luatexja.jfont',
   6   date = '2011/06/27',
   7   version = '0.1',
   8   description = 'Loader for Japanese fonts',
   9 })
  10 module('luatexja.jfont', package.seeall)
  11
  12 luatexja.load_module('base');      local ltjb = luatexja.base
  13 luatexja.load_module('charrange'); local ltjc = luatexja.charrange
  14
  15 local node_new = node.new
  16 local has_attr = node.has_attribute
  17 local set_attr = node.set_attribute
  18 local round = tex.round
  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 = 1
  28 local FROM_JFM = 4
  29 ------------------------------------------------------------------------
  30 -- LOADING JFM
  31 ------------------------------------------------------------------------
  32
  33 metrics={} -- this table stores all metric informations
  34 font_metric_table={} -- [font number] -> jfm_name, jfm_var, size
  35
  36 luatexbase.create_callback("luatexja.load_jfm", "data", function (ft, jn) return ft end)
  37
  38 local jfm_file_name, jfm_var
  39 local defjfm_res
  40
  41 function define_jfm(t)
  42    local real_char -- Does current character class have the 'real' character?
  43    if t.dir~='yoko' then
  44       defjfm_res= nil; return
  45    elseif type(t.zw)~='number' or type(t.zh)~='number' then
  46       defjfm_res= nil; return
  47    end
  48    t.char_type = {}; t.chars = {}
  49    for i,v in pairs(t) do
  50       if type(i) == 'number' then -- char_type
  51          if not v.chars then
  52             if i ~= 0 then defjfm_res= nil; return  end
  53             real_char = true
  54          else
  55             real_char = false
  56             for j,w in pairs(v.chars) do
  57                if w == 'lineend' then
  58                   if #v.chars ~= 1 then defjfm_res= nil; return end
  59                elseif type(w) == 'number' then
  60                   real_char = true;
  61                elseif type(w) == 'string' and utf.len(w)==1 then
  62                   real_char = true; w = utf.byte(w)
  63                elseif type(w) == 'string' and utf.len(w)==2 and utf.sub(w,2) == '*' then
  64                   real_char = true; w = utf.byte(utf.sub(w,1,1))
  65                   if not t.chars[-w] then
  66                      t.chars[-w] = i
  67                   else
  68                      defjfm_res= nil; return
  69                   end
  70                end
  71                if not t.chars[w] then
  72                   t.chars[w] = i
  73                else
  74                   defjfm_res= nil; return
  75                end
  76             end
  77             if real_char then
  78                if not (type(v.width)=='number' or v.width~='prop') then
  79                   defjfm_res= nil; return
  80                else
  81                   if type(v.height)~='number' then
  82                      v.height = 0.0
  83                   end
  84                   if type(v.depth)~='number' then
  85                      v.depth = 0.0
  86                   end
  87                   if type(v.italic)~='number' then
  88                      v.italic = 0.0
  89                   end
  90                   if type(v.left)~='number' then
  91                      v.left = 0.0
  92                   end
  93                   if type(v.down)~='number' then
  94                      v.down = 0.0
  95                   end
  96                   if type(v.align)=='nil' then
  97                      v.align = 'left'
  98                   end
  99                end
 100             end
 101             v.chars = nil
 102          end
 103          if not v.kern then v.kern = {} end
 104          if not v.glue then v.glue = {} end
 105          for j in pairs(v.glue) do
 106             if v.kern[j] then defjfm_res= nil; return end
 107          end
 108          t.char_type[i] = v
 109          t[i] = nil
 110       end
 111    end
 112    t = luatexbase.call_callback("luatexja.load_jfm", t, jfm_file_name)
 113    t.size_cache = {}
 114    defjfm_res = t
 115 end
 116
 117 local function mult_table(old,scale) -- modified from table.fastcopy
 118     if old then
 119        local new = { }
 120        for k,v in next, old do
 121           if type(v) == "table" then
 122              new[k] = mult_table(v,scale)
 123           elseif type(v) == "number" then
 124              new[k] = round(v*scale)
 125           else
 126              new[k] = v
 127           end
 128        end
 129        return new
 130     else return nil end
 131 end
 132
 133 local function update_jfm_cache(j,sz)
 134    if metrics[j].size_cache[sz] then return end
 135    local t = {}
 136    metrics[j].size_cache[sz] = t
 137    t.chars = metrics[j].chars
 138    t.char_type = mult_table(metrics[j].char_type, sz)
 139    for i,v in pairs(t.char_type) do
 140       if type(i) == 'number' then -- char_type
 141          for k,w in pairs(v.glue) do
 142             local g, h = node.new(id_glue), node_new(id_glue_spec); v.glue[k] = g
 143             h.width, h.stretch, h.shrink = w[1], w[2], w[3]
 144             h.stretch_order, h.shrink_order = 0, 0
 145             g.subtype = 0; g.spec = h; set_attr(g, attr_icflag, FROM_JFM);
 146          end
 147       end
 148    end
 149    t.kanjiskip = mult_table(metrics[j].kanjiskip, sz)
 150    t.xkanjiskip = mult_table(metrics[j].xkanjiskip,sz)
 151    t.zw = round(metrics[j].zw*sz)
 152    t.zh = round(metrics[j].zh*sz)
 153 end
 154
 155 luatexbase.create_callback("luatexja.find_char_class", "data",
 156                            function (arg, fmtable, char)
 157                               return 0
 158                            end)
 159
 160 function find_char_class(c,m)
 161 -- c: character code, m:
 162    if not m then return 0 end
 163    return m.size_cache.chars[c] or
 164       luatexbase.call_callback("luatexja.find_char_class", 0, m, c)
 165 end
 166
 167 local function load_jfont_metric()
 168    if jfm_file_name=='' then
 169       ltjb.package_error('luatexja',
 170                          'no JFM specified',
 171                          'To load and define a Japanese font, a JFM must be specified.'..
 172                           "The JFM 'ujis' will be  used for now.")
 173       jfm_file_name='ujis'
 174    end
 175    for j,v in ipairs(metrics) do
 176       if v.name==jfm_file_name then return j end
 177    end
 178    luatexja.load_lua('jfm-' .. jfm_file_name .. '.lua')
 179    if defjfm_res then
 180       defjfm_res.name = jfm_file_name
 181       table.insert(metrics, defjfm_res)
 182       return #metrics
 183    else
 184       return nil
 185    end
 186 end
 187
 188
 189 ------------------------------------------------------------------------
 190 -- LOADING JAPANESE FONTS
 191 ------------------------------------------------------------------------
 192 local cstemp
 193
 194 -- EXT
 195 function jfontdefX(g)
 196   local t = token.get_next()
 197   cstemp=token.csname_name(t)
 198   if g then luatexja.is_global = '\\global' else luatexja.is_global = '' end
 199   tex.sprint(cat_lp, '\\expandafter\\font\\csname ' .. cstemp .. '\\endcsname')
 200 end
 201
 202 luatexbase.create_callback("luatexja.define_jfont", "data", function (ft, fn) return ft end)
 203
 204 -- EXT
 205 function jfontdefY() -- for horizontal font
 206    local j = load_jfont_metric()
 207    local fn = font.id(cstemp)
 208    local f = font.fonts[fn]
 209    if not j then
 210       ltjb.package_error('luatexja',
 211                          "bad JFM `" .. jfm_file_name .. "'",
 212                          'The JFM file you specified is not valid JFM file.\n'..
 213                             'So defining Japanese font is cancelled.')
 214       tex.sprint(cat_lp, luatexja.is_global .. '\\expandafter\\let\\csname ' ..cstemp
 215              .. '\\endcsname=\\relax')
 216      return
 217    end
 218    update_jfm_cache(j, f.size)
 219    local fmtable = { jfm = j, size = f.size, var = jfm_var,
 220                      size_cache = metrics[j].size_cache[f.size] }
 221    fmtable = luatexbase.call_callback("luatexja.define_jfont", fmtable, fn)
 222    font_metric_table[fn]=fmtable
 223    tex.sprint(cat_lp, luatexja.is_global .. '\\protected\\expandafter\\def\\csname '
 224           .. cstemp  .. '\\endcsname{\\ltj@curjfnt=' .. fn .. '\\relax}')
 225 end
 226
 227 -- zw, zh
 228 function load_zw()
 229    local a = font_metric_table[tex.attribute[attr_curjfnt]]
 230    if a then
 231       tex.setdimen('ltj@zw', a.size_cache.zw)
 232    else
 233       tex.setdimen('ltj@zw',0)
 234    end
 235 end
 236
 237 function load_zh()
 238    local a = font_metric_table[tex.attribute[attr_curjfnt]]
 239    if a then
 240       tex.setdimen('ltj@zh', a.size_cache.zh)
 241    else
 242       tex.setdimen('ltj@zh',0)
 243    end
 244 end
 245
 246 -- extract jfm_file_name and jfm_var
 247 local function extract_metric(name)
 248    local basename=name
 249    local tmp = utf.sub(basename, 1, 5)
 250    jfm_file_name = ''; jfm_var = ''
 251    if tmp == 'file:' or tmp == 'name:' or tmp == 'psft:' then
 252       basename = utf.sub(basename, 6)
 253    end
 254    local p = utf.find(basename, ":")
 255    if p then
 256       basename = utf.sub(basename, p+1)
 257    else return
 258    end
 259    -- now basename contains 'features' only.
 260    p=1
 261    while p do
 262       local q = utf.find(basename, ";", p+1) or utf.len(basename)+1
 263       if utf.sub(basename, p, p+3)=='jfm=' and q>p+4 then
 264          jfm_file_name = utf.sub(basename, p+4, q-1)
 265       elseif utf.sub(basename, p, p+6)=='jfmvar=' and q>p+6 then
 266          jfm_var = utf.sub(basename, p+7, q-1)
 267       end
 268       if utf.len(basename)+1==q then p = nil else p = q + 1 end
 269    end
 270    return
 271 end
 272
 273 -- replace fonts.define.read()
 274 local ljft_dr_orig = fonts.define.read
 275 function fonts.define.read(name, size, id)
 276    extract_metric(name)
 277    -- In the present imple., we don't remove "jfm=..." from name.
 278    return ljft_dr_orig(name, size, id)
 279 end
 280
 281 ------------------------------------------------------------------------
 282 -- MISC
 283 ------------------------------------------------------------------------
 284
 285 -- EXT: italic correction
 286 function append_italic()
 287    local p = tex.nest[tex.nest.ptr].tail
 288    if p and p.id==id_glyph then
 289       local f = p.font
 290       local g = node_new(id_kern)
 291       g.subtype = 1; node.set_attribute(g, attr_icflag, ITALIC)
 292       if ltjc.is_ucs_in_japanese_char(p) then
 293          f = has_attr(p, attr_curjfnt)
 294          local j = font_metric_table[f]
 295          local c = find_char_class(p.char, j)
 296          g.kern = j.size_cache.char_type[c].italic
 297       else
 298          g.kern = font.fonts[f].characters[p.char].italic
 299       end
 300       node.write(g)
 301       tex.attribute[attr_icflag] = -(0x7FFFFFFF)
 302    end
 303 end