src/luatexja.lua

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