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