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