4 luatexbase.provides_module({
5 name = 'luatexja.jfont',
7 description = 'Loader for Japanese fonts',
9 module('luatexja.jfont', package.seeall)
11 luatexja.load_module('base'); local ltjb = luatexja.base
12 luatexja.load_module('charrange'); local ltjc = luatexja.charrange
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
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
30 ------------------------------------------------------------------------
32 ------------------------------------------------------------------------
34 metrics={} -- this table stores all metric informations
35 font_metric_table={} -- [font number] -> jfm_name, jfm_var, size
37 luatexbase.create_callback("luatexja.load_jfm", "data", function (ft, jn) return ft end)
39 local jfm_file_name, jfm_var
42 function define_jfm(t)
43 local real_char -- Does current character class have the 'real' character?
45 defjfm_res= nil; return
46 elseif type(t.zw)~='number' or type(t.zh)~='number' then
47 defjfm_res= nil; return
49 t.char_type = {}; t.chars = {}
50 for i,v in pairs(t) do
51 if type(i) == 'number' then -- char_type
53 if i ~= 0 then defjfm_res= nil; return end
57 for j,w in pairs(v.chars) do
58 if type(w) == 'number' then
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
67 defjfm_res= nil; return
70 if not t.chars[w] then
73 defjfm_res= nil; return
76 if type(v.align)~='string' then
77 v.align = 'left' -- left
80 if not (type(v.width)=='number' or v.width~='prop') then
81 defjfm_res= nil; return
83 if type(v.height)~='number' then
86 if type(v.depth)~='number' then
89 if type(v.italic)~='number' then
92 if type(v.left)~='number' then
95 if type(v.down)~='number' then
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
106 for j,x in pairs(v.kern) do
107 if type(x)=='number' then
109 elseif type(x)=='table' then
110 v.kern[j] = {x[1], x[2] or 0}
117 t = luatexbase.call_callback("luatexja.load_jfm", t, jfm_file_name)
123 local function mult_table(old,scale) -- modified from table.fastcopy
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)
139 function update_jfm_cache(j,sz)
140 if metrics[j].size_cache[sz] then return end
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));
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}
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)
169 local update_jfm_cache = update_jfm_cache
170 luatexbase.create_callback("luatexja.find_char_class", "data",
171 function (arg, fmtable, char)
175 function find_char_class(c,m)
176 -- c: character code, m:
177 if not m then return 0 end
179 luatexbase.call_callback("luatexja.find_char_class", 0, m, c)
183 ------------------------------------------------------------------------
184 -- LOADING JAPANESE FONTS
185 ------------------------------------------------------------------------
189 local function load_jfont_metric()
190 if jfm_file_name=='' then
191 ltjb.package_error('luatexja',
193 'To load and define a Japanese font, a JFM must be specified.'..
194 "The JFM 'ujis' will be used for now.")
197 for j,v in ipairs(metrics) do
198 if v.name==jfm_file_name then return j end
200 luatexja.load_lua('jfm-' .. jfm_file_name .. '.lua')
202 defjfm_res.name = jfm_file_name
203 table.insert(metrics, defjfm_res)
211 function jfontdefX(g)
212 local t = token.get_next()
213 cstemp=token.csname_name(t)
214 if g then luatexja.is_global = '\\global' else luatexja.is_global = '' end
215 tex.sprint(cat_lp, '\\expandafter\\font\\csname ' .. cstemp .. '\\endcsname')
218 luatexbase.create_callback("luatexja.define_jfont", "data", function (ft, fn) return ft end)
221 function jfontdefY() -- for horizontal font
222 local j = load_jfont_metric()
223 local fn = font.id(cstemp)
224 local f = getfont(fn)
226 ltjb.package_error('luatexja',
227 "bad JFM `" .. jfm_file_name .. "'",
228 'The JFM file you specified is not valid JFM file.\n'..
229 'So defining Japanese font is cancelled.')
230 tex.sprint(cat_lp, luatexja.is_global .. '\\expandafter\\let\\csname ' ..cstemp
231 .. '\\endcsname=\\relax')
234 update_jfm_cache(j, f.size)
235 local sz = metrics[j].size_cache[f.size]
236 local fmtable = { jfm = j, size = f.size, var = jfm_var,
237 zw = sz.zw, zh = sz.zh,
238 chars = sz.chars, char_type = sz.char_type,
239 kanjiskip = sz.kanjiskip, xkanjiskip = sz.xkanjiskip,
242 fmtable = luatexbase.call_callback("luatexja.define_jfont", fmtable, fn)
243 font_metric_table[fn]=fmtable
244 tex.sprint(cat_lp, luatexja.is_global .. '\\protected\\expandafter\\def\\csname '
245 .. cstemp .. '\\endcsname{\\ltj@curjfnt=' .. fn .. '\\relax}')
252 local a = font_metric_table[tex.attribute[attr_curjfnt]]
253 tex.setdimen('ltj@zw', a and a.zw or 0)
257 local a = font_metric_table[tex.attribute[attr_curjfnt]]
258 tex.setdimen('ltj@zh', a and a.zh or 0)
263 -- extract jfm_file_name and jfm_var
264 local function extract_metric(name)
266 local tmp = utf.sub(basename, 1, 5)
267 jfm_file_name = ''; jfm_var = ''
268 if tmp == 'file:' or tmp == 'name:' or tmp == 'psft:' then
269 basename = utf.sub(basename, 6)
271 local p = utf.find(basename, ":")
273 basename = utf.sub(basename, p+1)
276 -- now basename contains 'features' only.
279 local q = utf.find(basename, ";", p+1) or utf.len(basename)+1
280 if utf.sub(basename, p, p+3)=='jfm=' and q>p+4 then
281 jfm_file_name = utf.sub(basename, p+4, q-1)
282 elseif utf.sub(basename, p, p+6)=='jfmvar=' and q>p+6 then
283 jfm_var = utf.sub(basename, p+7, q-1)
285 if utf.len(basename)+1==q then p = nil else p = q + 1 end
290 -- replace fonts.define.read()
291 function font_callback(name, size, id, fallback)
293 -- In the present imple., we don't remove "jfm=..." from name.
294 return fallback(name, size, id)
298 ------------------------------------------------------------------------
300 ------------------------------------------------------------------------
302 local alt_font_table = alt_font_table
303 local attr_curaltfnt = {}
304 local ucs_out = 0x110000
306 ------ for TeX interface
308 function set_alt_font(b,e,ind,bfnt)
309 -- ind: 新フォント, bfnt: 基底フォント
310 if b>e then b, e = e, b end
312 ltjb.package_eror('luatexja',
313 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
314 'I take the intersection with [0x80, 0x10ffff].')
315 b, e = math.max(0x80,b),math.min(ucs_out-1,e)
316 elseif e<0 then -- b<e<0
318 elseif b<0x80 or e>=ucs_out then
319 ltjb.package_warning('luatexja',
320 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
321 'I take the intersection with [0x80, 0x10ffff].')
322 b, e = math.max(0x80,b), math.min(ucs_out-1,e)
324 if not alt_font_table[bfnt] then alt_font_table[bfnt]={} end
325 local t = alt_font_table[bfnt]
326 local ac = getfont(ind).characters
327 if bfnt==ind then ind = nil end -- ind == bfnt の場合はテーブルから削除
328 if e>=0 then -- character range
330 if ac[i]then t[i]=ind end
334 local tx = font_metric_table[bfnt].chars
335 for i,v in pairs(tx) do
336 if b<=v and v<=e and ac[i] then t[i]=ind end
342 function clear_alt_font(bfnt)
343 if alt_font_table[bfnt] then
344 local t = alt_font_table[bfnt]
345 for i,_ in pairs(t) do t[i]=nil; end
349 ------ used in ltjp.suppress_hyphenate_ja callback
350 function replace_altfont(pf, pc)
351 return (alt_font_table[pf] and alt_font_table[pf][pc])
352 and alt_font_table[pf][pc] or pf
355 ------ for LaTeX interface
357 local alt_font_table_latex = {}
360 function clear_alt_font_latex(bbase)
361 local t = alt_font_table_latex[bbase]
363 for j,v in pairs(t) do t[j] = nil end
368 function set_alt_font_latex(b,e,ind,bbase)
369 -- ind: Alt font の enc/fam/ser/shape, bbase: 基底フォントの enc/fam/ser/shape
370 if b>e then b, e = e, b end
372 ltjb.package_eror('luatexja',
373 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
374 'I take the intersection with [0x80, 0x10ffff].')
375 b, e = math.max(0x80,b),math.min(ucs_out-1,e)
376 elseif e<0 then -- b<e<0
378 elseif b<0x80 or e>=ucs_out then
379 ltjb.package_warning('luatexja',
380 'bad character range ([' .. b .. ',' .. e .. ']). ' ..
381 'I take the intersection with [0x80, 0x10ffff].')
382 b, e = math.max(0x80,b), math.min(ucs_out-1,e)
385 if not alt_font_table_latex[bbase] then alt_font_table_latex[bbase]={} end
386 local t = alt_font_table_latex[bbase]
387 if not t[ind] then t[ind] = {} end
389 for j,v in pairs(t) do
390 if v[i] then -- remove old entry
391 if j~=ind then v[i]=nil end; break
396 -- remove the empty tables
397 for j,v in pairs(t) do
398 local flag_clear = true
399 for k,_ in pairs(v) do flag_clear = false; break end
400 if flag_clear then t[j]=nil end
402 if ind==bbase then t[bbase] = nil end
405 -- ここから先は 新 \selectfont の内部でしか実行されない
407 local alt_font_base, alt_font_base_num
410 function print_aftl_address(bbase)
411 local t = alt_font_table_latex[bbase]
412 if not t then t = {}; alt_font_table_latex[bbase] = t end
413 tex.sprint(cat_lp, (tostring(t):gsub('table: 0x','ltjaltfont')))
416 function output_alt_font_cmd(bbase)
417 alt_font_base = bbase
418 alt_font_base_num = tex.getattribute(attr_curjfnt)
419 local t = alt_font_table[alt_font_base_num]
421 for i,_ in pairs(t) do t[i]=nil end
423 t = alt_font_table_latex[bbase]
425 for i,_ in pairs(t) do
426 tex.sprint(cat_lp, '\\ltj@pickup@altfont@aux{' .. i .. '}')
432 function pickup_alt_font_a(size_str)
433 local t = alt_font_table_latex[alt_font_base]
435 for i,v in pairs(t) do
436 tex.sprint(cat_lp, '\\expandafter\\ltj@pickup@altfont@copy'
437 .. '\\csname ' .. i .. '/' .. size_str .. '\\endcsname{' .. i .. '}')
442 local function pickup_alt_font_class(class, afnt_num, afnt_chars)
443 local t = alt_font_table[alt_font_base_num]
444 local tx = font_metric_table[alt_font_base_num].chars
445 for i,v in pairs(tx) do
446 if v==class and afnt_chars[i] then t[i]=afnt_num end
451 function pickup_alt_font_b(afnt_num, afnt_base)
452 local t = alt_font_table[alt_font_base_num]
453 local ac = getfont(afnt_num).characters
454 if not t then t = {}; alt_font_table[alt_font_base_num] = t end
455 for i,v in pairs(alt_font_table_latex[alt_font_base]) do
456 if i == afnt_base then
457 for j,_ in pairs(v) do
459 if ac[j] then t[j]=afnt_num end
460 else -- -n (n>=1) means that the character class n,
461 -- which is defined in the JFM
462 pickup_alt_font_class(-j, afnt_num, ac)
473 ------------------------------------------------------------------------
475 ------------------------------------------------------------------------
477 local is_ucs_in_japanese_char = ltjc.is_ucs_in_japanese_char
478 -- EXT: italic correction
479 function append_italic()
480 local p = tex.nest[tex.nest.ptr].tail
481 if p and p.id==id_glyph then
483 local g = node_new(id_kern)
484 g.subtype = 1; node.set_attribute(g, attr_icflag, ITALIC)
485 if is_ucs_in_japanese_char(p) then
486 f = has_attr(p, attr_curjfnt)
487 local j = font_metric_table[f]
488 g.kern = j.char_type[find_char_class(p.char, j)].italic
492 g.kern = h.characters[p.char].italic
494 tex.attribute[attr_icflag] = -(0x7FFFFFFF)
499 tex.attribute[attr_icflag] = -(0x7FFFFFFF)