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