src/luatexja.lua

   1
   2 require('lualibs')
   3
   4 ------------------------------------------------------------------------
   5 -- naming:
   6 --    ext_... : called from \directlua{}
   7 --    int_... : called from other Lua codes, but not from \directlua{}
   8 --    (other)     : only called from this file
   9 function luatexja.load_module(name)
  10    require('ltj-' .. name.. '.lua')
  11 end
  12 function luatexja.load_lua(fn)
  13    local found = kpse.find_file(fn, 'tex')
  14    if not found then
  15       tex.error("LuaTeX-ja error: File `" .. fn .. "' not found")
  16    else
  17       texio.write_nl('(' .. found .. ')')
  18       dofile(found)
  19    end
  20 end
  21
  22 --- 以下は全ファイルで共有される定数
  23 local icflag_table = {}
  24 luatexja.icflag_table = icflag_table
  25 icflag_table.ITALIC          = 1
  26 icflag_table.PACKED          = 2
  27 icflag_table.KINSOKU         = 3
  28 icflag_table.FROM_JFM        = 6
  29 -- FROM_JFM: 4, 5, 6, 7, 8 →優先度高（伸びやすく，縮みやすい）
  30 -- 6 が標準
  31 icflag_table.KANJI_SKIP      = 9
  32 icflag_table.KANJI_SKIP_JFM  = 10
  33 icflag_table.XKANJI_SKIP     = 11
  34 icflag_table.XKANJI_SKIP_JFM = 12
  35 icflag_table.PROCESSED       = 13
  36 icflag_table.IC_PROCESSED    = 14
  37 icflag_table.BOXBDD          = 15
  38 icflag_table.PROCESSED_BEGIN_FLAG = 128
  39
  40 local stack_table_index = {}
  41 luatexja.stack_table_index = stack_table_index
  42 stack_table_index.PRE  = 0x200000 -- characterごと
  43 stack_table_index.POST = 0x400000 -- characterごと
  44 stack_table_index.KCAT = 0x600000 -- characterごと
  45 stack_table_index.XSP  = 0x800000 -- characterごと
  46 stack_table_index.RIPRE  = 0xA00000 -- characterごと，ruby pre
  47 stack_table_index.RIPOST = 0xC00000 -- characterごと，ruby post
  48 stack_table_index.JWP  = 0 -- これだけ
  49 stack_table_index.KSK  = 1 -- これだけ
  50 stack_table_index.XSK  = 2 -- これだけ
  51 stack_table_index.MJT  = 0x100 -- 0--255
  52 stack_table_index.MJS  = 0x200 -- 0--255
  53 stack_table_index.MJSS = 0x300 -- 0--255
  54 stack_table_index.KSJ  = 0x400 -- 0--9
  55
  56 local userid_table = {}
  57 luatexja.userid_table = userid_table
  58 userid_table.IHB  = luatexbase.newuserwhatsitid('inhibitglue',  'luatexja') -- \inhibitglue
  59 userid_table.STCK = luatexbase.newuserwhatsitid('stack_marker', 'luatexja') -- スタック管理
  60 userid_table.BPAR = luatexbase.newuserwhatsitid('begin_par',    'luatexja') -- 「段落始め」
  61 userid_table.DIR  = luatexbase.newuserwhatsitid('direction',    'luatexja') -- 組方向
  62
  63 local dir_table = {}
  64 luatexja.dir_table = dir_table
  65 dir_table.dir_dtou = 1
  66 dir_table.dir_tate = 3
  67 dir_table.dir_yoko = 4
  68 dir_table.dir_node_auto   = 16 -- 組方向を合わせるために自動で作られたもの
  69 dir_table.dir_node_manual = 32 -- 寸法代入によって作られたもの
  70
  71
  72 ------------------------------------------------------------------------
  73 -- FIX node.remove
  74 ------------------------------------------------------------------------
  75 do
  76    local node_remove, node_next, node_prev = node.remove, node.next, node.prev
  77    function luatexja.node_remove (head, current)
  78       if head==current then
  79          local q, r = node_next(current), node_prev(current)
  80          if q then q.prev = r end
  81          if r and node_next(r)==current then
  82             r.next = q
  83          end
  84          return q, q
  85       else
  86          return node_remove(head, current)
  87       end
  88    end
  89    local Dnode = node.direct or node
  90    if Dnode~=node then
  91       local Dnode_remove, setfield = Dnode.remove, Dnode.setfield
  92       local Dnode_next, Dnode_prev = Dnode.getnext, Dnode.getprev
  93       function luatexja.Dnode_remove (head, current)
  94          if head==current then
  95             local q, r = Dnode_next(current), Dnode_prev(current)
  96             if q then setfield(q, 'prev', r) end
  97             if r and Dnode_next(r) == current then
  98                setfield(r, 'next', q)
  99             end
 100             return q, q
 101          else
 102             return Dnode_remove(head, current)
 103          end
 104       end
 105    else
 106       luatexja.Dnode_remove = luatexja.node_remove
 107    end
 108 end
 109
 110 --- 定義終わり
 111
 112 local load_module = luatexja.load_module
 113 load_module('base');      local ltjb = luatexja.base
 114 load_module('rmlgbm');    local ltjr = luatexja.rmlgbm -- must be 1st
 115
 116 if luatexja_debug then load_module('debug') end
 117
 118 load_module('charrange'); local ltjc = luatexja.charrange
 119 load_module('jfont');     local ltjf = luatexja.jfont
 120
 121 -- define_font
 122 do
 123    local otfl_fdr = fonts.definers.read
 124    local ltjr_font_callback = ltjr.font_callback
 125    local ltjf_extract_metric = ltjf.extract_metric
 126    function luatexja.font_callback(name, size, id)
 127       local new_name = ltjf_extract_metric(name)
 128       local res =  ltjr_font_callback(new_name, size, id, otfl_fdr)
 129       luatexbase.call_callback('luatexja.define_font', res, name, size, id)
 130       return res
 131    end
 132    luatexbase.create_callback('luatexja.define_font', 'simple', function (n) return n end)
 133    luatexbase.add_to_callback('define_font',luatexja.font_callback,"luatexja.font_callback", 1)
 134 end
 135
 136
 137 load_module('inputbuf');  local ltji = luatexja.inputbuf
 138 load_module('stack');     local ltjs = luatexja.stack
 139 load_module('pretreat');  local ltjp = luatexja.pretreat
 140 load_module('jfmglue');   local ltjj = luatexja.jfmglue
 141 load_module('setwidth');  local ltjw = luatexja.setwidth
 142 load_module('math');      local ltjm = luatexja.math
 143 load_module('tangle');    local ltjb = luatexja.base
 144 load_module('direction'); local ltjd = luatexja.direction
 145
 146 local attr_jchar_class = luatexbase.attributes['ltj@charclass']
 147 local attr_curjfnt = luatexbase.attributes['ltj@curjfnt']
 148 local attr_yablshift = luatexbase.attributes['ltj@yablshift']
 149 local attr_icflag = luatexbase.attributes['ltj@icflag']
 150 local attr_uniqid = luatexbase.attributes['ltj@uniqid']
 151 local attr_dir = luatexbase.attributes['ltj@dir']
 152 local cat_lp = luatexbase.catcodetables['latex-package']
 153
 154 -- Three aux. functions, bollowed from tex.web
 155
 156 local unity=65536
 157 local floor = math.floor
 158
 159 local function print_scaled(s)
 160    local out=''
 161    local delta=10
 162    if s<0 then
 163       out=out..'-'; s=-s
 164    end
 165    out=out..tostring(floor(s/unity)) .. '.'
 166    s=10*(s%unity)+5
 167    repeat
 168       if delta>unity then s=s+32768-50000 end
 169       out=out .. tostring(floor(s/unity))
 170       s=10*(s%unity)
 171       delta=delta*10
 172    until s<=delta
 173    return out
 174 end
 175
 176 local function print_glue(d,order)
 177    local out=print_scaled(d)
 178    if order>0 then
 179       out=out..'fi'
 180       while order>1 do
 181          out=out..'l'; order=order-1
 182       end
 183    else
 184       out=out..'pt'
 185    end
 186    return out
 187 end
 188
 189 local function print_spec(p)
 190    local out=print_scaled(p.width)..'pt'
 191    if p.stretch~=0 then
 192       out=out..' plus '..print_glue(p.stretch,p.stretch_order)
 193    end
 194    if p.shrink~=0 then
 195       out=out..' minus '..print_glue(p.shrink,p.shrink_order)
 196    end
 197 return out
 198 end
 199
 200
 201 ------------------------------------------------------------------------
 202 -- CODE FOR GETTING/SETTING PARAMETERS
 203 ------------------------------------------------------------------------
 204
 205 -- EXT: print parameters that don't need arguments
 206 do
 207    luatexja.unary_pars = {
 208       yalbaselineshift = function(t)
 209          return print_scaled(tex.getattribute('ltj@yablshift'))..'pt'
 210       end,
 211       yjabaselineshift = function(t)
 212          return print_scaled(tex.getattribute('ltj@ykblshift'))..'pt'
 213       end,
 214       talbaselineshift = function(t)
 215          return print_scaled(tex.getattribute('ltj@tablshift'))..'pt'
 216       end,
 217       tjabaselineshift = function(t)
 218          return print_scaled(tex.getattribute('ltj@tkblshift'))..'pt'
 219       end,
 220       kanjiskip = function(t)
 221          return print_spec(ltjs.get_stack_skip(stack_table_index.KSK, t))
 222       end,
 223       xkanjiskip = function(t)
 224          return print_spec(ltjs.get_stack_skip(stack_table_index.XSK, t))
 225       end,
 226       jcharwidowpenalty = function(t)
 227          return ltjs.get_stack_table(stack_table_index.JWP, 0, t)
 228       end,
 229       autospacing = function(t)
 230          return tex.getattribute('ltj@autospc')
 231       end,
 232       autoxspacing = function(t)
 233          return tex.getattribute('ltj@autoxspc')
 234       end,
 235       differentjfm = function(t)
 236          local f, r = luatexja.jfmglue.diffmet_rule, '???'
 237          if f == math.max then r = 'large'
 238          elseif f == math.min then r = 'small'
 239          elseif f == math.two_average then r = 'average'
 240          elseif f == math.two_paverage then r = 'paverage'
 241          elseif f == math.two_pleft then r = 'pleft'
 242          elseif f == math.two_pright then r = 'pright'
 243          elseif f == math.two_add then r = 'both'
 244          end
 245          return r
 246       end
 247    }
 248
 249    local unary_pars = luatexja.unary_pars
 250    function luatexja.ext_get_parameter_unary(k)
 251       if unary_pars[k] then
 252          tex.write(tostring(unary_pars[k](tex.getcount('ltj@@stack'))))
 253       end
 254    end
 255 end
 256
 257
 258 -- EXT: print parameters that need arguments
 259 do
 260    luatexja.binary_pars = {
 261       jacharrange = function(c, t)
 262          if type(c)~='number' or c<0 or c>31*ltjc.ATTR_RANGE then
 263             -- 0 はエラーにしない（隠し）
 264             ltjb.package_error('luatexja',
 265                                'invalid character range number (' .. tostring(c) .. ')',
 266                                'A character range number should be in the range 1..'
 267                                   .. 31*ltjc.ATTR_RANGE .. ",\n"..
 268                                   'So I changed this one to ' .. 31*ltjc.ATTR_RANGE .. ".")
 269             c=0 -- external range 217 == internal range 0
 270          elseif c==31*ltjc.ATTR_RANGE then c=0
 271          end
 272       -- 負の値は <U+0080 の文字の文字範囲，として出てくる．この時はいつも欧文文字なので 1 を返す
 273          return (c<0) and 1 or ltjc.get_range_setting(c)
 274       end,
 275       prebreakpenalty = function(c, t)
 276          return ltjs.get_stack_table(stack_table_index.PRE
 277                                           + ltjb.in_unicode(c, true), 0, t)
 278       end,
 279       postbreakpenalty = function(c, t)
 280          return ltjs.get_stack_table(stack_table_index.POST
 281                                           + ltjb.in_unicode(c, true), 0, t)
 282       end,
 283       kcatcode = function(c, t)
 284          return ltjs.get_stack_table(stack_table_index.KCAT
 285                                           + ltjb.in_unicode(c, false), 0, t)
 286       end,
 287       chartorange = function(c, t)
 288          return ltjc.char_to_range(ltjb.in_unicode(c, false))
 289       end,
 290       jaxspmode = function(c, t)
 291          return ltjs.get_stack_table(stack_table_index.XSP
 292                                           + ltjb.in_unicode(c, true), 3, t)
 293       end,
 294    }
 295    local binary_pars = luatexja.binary_pars
 296
 297    binary_pars.alxspmode = binary_pars.jaxspmode
 298    function luatexja.ext_get_parameter_binary(k,c)
 299       if binary_pars[k] then
 300          tex.write(tostring(binary_pars[k](c,tex.getcount('ltj@@stack'))))
 301       end
 302    end
 303 end
 304
 305 -- EXT: print \global if necessary
 306 function luatexja.ext_print_global()
 307    if luatexja.isglobal=='global' then tex.sprint(cat_lp, '\\global') end
 308 end
 309
 310
 311 -- main process
 312 do
 313    local start_time_measure, stop_time_measure
 314       = ltjb.start_time_measure, ltjb.stop_time_measure
 315    local Dnode = node.direct or node
 316    local nullfunc = function (n) return n end
 317    local to_node = (Dnode ~= node) and Dnode.tonode or nullfunc
 318    local to_direct = (Dnode ~= node) and Dnode.todirect or nullfunc
 319    local tex_set_attr = tex.setattribute
 320    -- mode = true iff main_process is called from pre_linebreak_filter
 321    local function main_process(head, mode, dir, gc)
 322       tex_set_attr('global', attr_icflag, 0)
 323       if gc == 'fin_row' then return head
 324       else
 325             local p = to_direct(head)
 326             start_time_measure('jfmglue')
 327             p = ltjj.main(p,mode)
 328             stop_time_measure('jfmglue'); start_time_measure('setwidth')
 329             if p then p = ltjw.set_ja_width(p, dir) end
 330             stop_time_measure('setwidth')
 331             return to_node(p)
 332       end
 333    end
 334
 335    local function adjust_icflag(h)
 336       -- kern from luaotfload will have icflag = 1
 337       -- (same as italic correction)
 338       tex_set_attr('global', attr_icflag, 1)
 339       return h
 340    end
 341
 342    -- callbacks
 343
 344    luatexbase.add_to_callback(
 345       'pre_linebreak_filter',
 346       function (head,groupcode)
 347          return main_process(head, true, tex.textdir, groupcode)
 348       end,'ltj.pre_linebreak_filter',
 349       luatexbase.priority_in_callback('pre_linebreak_filter',
 350                                       'luaotfload.node_processor') + 1)
 351    luatexbase.add_to_callback(
 352       'hpack_filter',
 353       function (head,groupcode,size,packtype, dir)
 354          return main_process(head, false, dir, groupcode)
 355       end,'ltj.hpack_filter',
 356       luatexbase.priority_in_callback('hpack_filter',
 357                                       'luaotfload.node_processor') + 1)
 358    luatexbase.add_to_callback('pre_linebreak_filter', adjust_icflag, 'ltj.adjust_icflag', 1)
 359    luatexbase.add_to_callback('hpack_filter', adjust_icflag, 'ltj.adjust_icflag', 1)
 360
 361 end
 362
 363 -- debug
 364
 365 do
 366
 367 local node_type = node.type
 368 local node_next = node.next
 369 local has_attr = node.has_attribute
 370
 371 local id_penalty = node.id('penalty')
 372 local id_glyph = node.id('glyph')
 373 local id_glue_spec = node.id('glue_spec')
 374 local id_glue = node.id('glue')
 375 local id_kern = node.id('kern')
 376 local id_hlist = node.id('hlist')
 377 local id_vlist = node.id('vlist')
 378 local id_rule = node.id('rule')
 379 local id_math = node.id('math')
 380 local id_whatsit = node.id('whatsit')
 381 local sid_user = node.subtype('user_defined')
 382
 383 local function get_attr_icflag(p)
 384    return (has_attr(p, attr_icflag) or 0) % icflag_table.PROCESSED_BEGIN_FLAG
 385 end
 386
 387 local debug_depth
 388
 389 local function debug_show_node_X(p,print_fn)
 390    local k = debug_depth
 391    local s
 392    local pt=node_type(p.id)
 393    local base = debug_depth .. string.format('%X', get_attr_icflag(p))
 394    .. ' ' .. pt .. ' ' .. tostring(p.subtype) .. ' '
 395    if pt == 'glyph' then
 396       s = base .. ' ' .. utf.char(p.char) .. ' '  .. tostring(p.font)
 397          .. ' (' .. print_scaled(p.height) .. '+'
 398          .. print_scaled(p.depth) .. ')x' .. print_scaled(p.width)
 399       print_fn(s)
 400    elseif pt=='hlist' or pt=='vlist' or pt=='unset' then
 401       s = base .. '(' .. print_scaled(p.height) .. '+'
 402          .. print_scaled(p.depth) .. ')x' .. print_scaled(p.width)
 403          .. ', dir=' .. tostring(node.has_attribute(p, attr_dir))
 404       if (p.shift or 0)~=0 then
 405          s = s .. ', shifted ' .. print_scaled(p.shift)
 406       end
 407       if p.glue_sign >= 1 then
 408          s = s .. ' glue set '
 409          if p.glue_sign == 2 then s = s .. '-' end
 410          s = s .. tostring(floor(p.glue_set*10000)/10000)
 411          if p.glue_order == 0 then
 412             s = s .. 'pt'
 413          else
 414             s = s .. 'fi'
 415             for i = 2,  p.glue_order do s = s .. 'l' end
 416          end
 417       end
 418       if get_attr_icflag(p) == icflag_table.PACKED then
 419          s = s .. ' (packed)'
 420       end
 421       print_fn(s); debug_depth=debug_depth.. '.'
 422       for q in node.traverse(p.head) do
 423          debug_show_node_X(q, print_fn)
 424       end
 425       debug_depth=k
 426    elseif pt == 'glue' then
 427       s = base .. ' ' ..  print_spec(p.spec)
 428       if get_attr_icflag(p)>icflag_table.KINSOKU
 429          and get_attr_icflag(p)<icflag_table.KANJI_SKIP then
 430          s = s .. ' (from JFM: priority ' .. get_attr_icflag(p)-icflag_table.FROM_JFM .. ')'
 431       elseif get_attr_icflag(p)==icflag_table.KANJI_SKIP then
 432          s = s .. ' (kanjiskip)'
 433       elseif get_attr_icflag(p)==icflag_table.KANJI_SKIP_JFM then
 434          s = s .. ' (kanjiskip, JFM specified)'
 435       elseif get_attr_icflag(p)==icflag_table.XKANJI_SKIP then
 436          s = s .. ' (xkanjiskip)'
 437       elseif get_attr_icflag(p)==icflag_table.XKANJI_SKIP_JFM then
 438          s = s .. ' (xkanjiskip, JFM specified)'
 439       end
 440       print_fn(s)
 441    elseif pt == 'kern' then
 442       s = base .. ' ' .. print_scaled(p.kern) .. 'pt'
 443       if p.subtype==2 then
 444          s = s .. ' (for accent)'
 445       elseif get_attr_icflag(p)==icflag_table.IC_PROCESSED then
 446          s = s .. ' (italic correction)'
 447          -- elseif get_attr_icflag(p)==ITALIC then
 448          --    s = s .. ' (italic correction)'
 449       elseif get_attr_icflag(p)>icflag_table.KINSOKU
 450          and get_attr_icflag(p)<icflag_table.KANJI_SKIP then
 451          s = s .. ' (from JFM: priority ' .. get_attr_icflag(p)-icflag_table.FROM_JFM .. ')'
 452       end
 453       print_fn(s)
 454    elseif pt == 'penalty' then
 455       s = base .. ' ' .. tostring(p.penalty)
 456       if get_attr_icflag(p)==icflag_table.KINSOKU then
 457          s = s .. ' (for kinsoku)'
 458       end
 459       print_fn(s)
 460    elseif pt == 'whatsit' then
 461       s = base
 462       if p.subtype==sid_user then
 463          local t = tostring(p.user_id) .. ' (' ..
 464             luatexbase.get_user_whatsit_name(p.user_id) .. ') '
 465          if p.type ~= 110 then
 466             s = s .. ' userid:' .. t .. p.value
 467             print_fn(s)
 468          else
 469             s = s .. ' userid:' .. t .. '(node list)'
 470             if p.user_id==userid_table.DIR then
 471                s = s .. ' dir: ' .. tostring(node.has_attribute(p, attr_dir))
 472             end
 473             print_fn(s)
 474             debug_depth=debug_depth.. '.'
 475             for q in node.traverse(p.value) do
 476                debug_show_node_X(q, print_fn)
 477             end
 478             debug_depth=k
 479          end
 480       else
 481          s = s .. node.subtype(p.subtype); print_fn(s)
 482       end
 483    -------- math node --------
 484    elseif pt=='noad' then
 485       s = base ; print_fn(s)
 486       if p.nucleus then
 487          debug_depth = k .. 'N'; debug_show_node_X(p.nucleus, print_fn);
 488       end
 489       if p.sup then
 490          debug_depth = k .. '^'; debug_show_node_X(p.sup, print_fn);
 491       end
 492       if p.sub then
 493          debug_depth = k .. '_'; debug_show_node_X(p.sub, print_fn);
 494       end
 495       debug_depth = k;
 496    elseif pt=='math_char' then
 497       s = base .. ' fam: ' .. p.fam .. ' , char = ' .. utf.char(p.char)
 498       print_fn(s)
 499    elseif pt=='sub_box' or pt=='sub_mlist' then
 500       print_fn(base)
 501       if p.head then
 502          debug_depth = k .. '.';
 503          for q in node.traverse(p.head) do
 504             debug_show_node_X(q, print_fn)
 505          end
 506       end
 507    else
 508       print_fn(base)
 509    end
 510    p=node_next(p)
 511 end
 512 function luatexja.ext_show_node_list(head,depth,print_fn)
 513    debug_depth = depth
 514    if head then
 515       while head do
 516          debug_show_node_X(head, print_fn); head = node_next(head)
 517       end
 518    else
 519       print_fn(debug_depth .. ' (null list)')
 520    end
 521 end
 522 function luatexja.ext_show_node(head,depth,print_fn)
 523    debug_depth = depth
 524    if head then
 525       debug_show_node_X(head, print_fn)
 526    else
 527       print_fn(debug_depth .. ' (null list)')
 528    end
 529 end
 530
 531 end
 532