src/ltj-adjust.lua

   1 --
   2 -- luatexja/otf.lua
   3 --
   4 luatexbase.provides_module({
   5   name = 'luatexja.adjust',
   6   date = '2014/01/26',
   7   description = 'Advanced line adjustment for LuaTeX-ja',
   8 })
   9 module('luatexja.adjust', package.seeall)
  10
  11 luatexja.load_module('jfont');     local ltjf = luatexja.jfont
  12 luatexja.load_module('jfmglue');   local ltjj = luatexja.jfmglue
  13 luatexja.load_module('stack');     local ltjs = luatexja.stack
  14
  15 local Dnode = node.direct or node
  16
  17 local nullfunc = function(n) return n end
  18 local to_node = (Dnode ~= node) and Dnode.tonode or nullfunc
  19 local to_direct = (Dnode ~= node) and Dnode.todirect or nullfunc
  20
  21 local setfield = (Dnode ~= node) and Dnode.setfield or function(n, i, c) n[i] = c end
  22 local getfield = (Dnode ~= node) and Dnode.getfield or function(n, i) return n[i] end
  23 local getlist = (Dnode ~= node) and Dnode.getlist or function(n) return n.head end
  24 local getid = (Dnode ~= node) and Dnode.getid or function(n) return n.id end
  25 local getfont = (Dnode ~= node) and Dnode.getfont or function(n) return n.font end
  26 local getsubtype = (Dnode ~= node) and Dnode.getsubtype or function(n) return n.subtype end
  27
  28 local node_traverse_id = Dnode.traverse_id
  29 local node_new = Dnode.new
  30 local node_copy = Dnode.copy
  31 local node_hpack = Dnode.hpack
  32 local node_next = Dnode.getnext
  33 local node_free = Dnode.free
  34 local node_prev = Dnode.getprev
  35 local node_tail = Dnode.tail
  36 local has_attr = Dnode.has_attribute
  37 local set_attr = Dnode.set_attribute
  38 local insert_after = Dnode.insert_after
  39
  40 local id_glyph = node.id('glyph')
  41 local id_kern = node.id('kern')
  42 local id_hlist = node.id('hlist')
  43 local id_glue  = node.id('glue')
  44 local id_glue_spec = node.id('glue_spec')
  45 local id_whatsit = node.id('whatsit')
  46 local attr_icflag = luatexbase.attributes['ltj@icflag']
  47 local attr_jchar_class = luatexbase.attributes['ltj@charclass']
  48 local attr_curjfnt = luatexbase.attributes['ltj@curjfnt']
  49
  50 local ltjf_font_metric_table = ltjf.font_metric_table
  51 local spec_zero_glue = ltjj.spec_zero_glue
  52 local round = tex.round
  53
  54 local PACKED       = luatexja.icflag_table.PACKED
  55 local FROM_JFM     = luatexja.icflag_table.FROM_JFM
  56 local KANJI_SKIP   = luatexja.icflag_table.KANJI_SKIP
  57 local KANJI_SKIP_JFM = luatexja.icflag_table.KANJI_SKIP_JFM
  58 local XKANJI_SKIP  = luatexja.icflag_table.XKANJI_SKIP
  59 local XKANJI_SKIP_JFM  = luatexja.icflag_table.XKANJI_SKIP_JFM
  60 local PROCESSED_BEGIN_FLAG = luatexja.icflag_table.PROCESSED_BEGIN_FLAG
  61
  62 local priority_table = {
  63    FROM_JFM + 2,
  64    FROM_JFM + 1,
  65    FROM_JFM,
  66    FROM_JFM - 1,
  67    FROM_JFM - 2,
  68    XKANJI_SKIP,
  69    KANJI_SKIP
  70 }
  71
  72 local function get_attr_icflag(p)
  73    return (has_attr(p, attr_icflag) or 0) % PROCESSED_BEGIN_FLAG
  74 end
  75
  76 -- box 内で伸縮された glue の合計値を計算
  77
  78 local function get_stretched(q, go, gs)
  79    local qs = getfield(q, 'spec')
  80    if not getfield(qs, 'writable') then return 0 end
  81    if gs == 1 then -- stretching
  82       if getfield(qs, 'stretch_order') == go then
  83          return getfield(qs, 'stretch')
  84       end
  85    else -- shrinking
  86       if getfield(qs, 'shrink_order') == go then
  87          return getfield(qs, 'shrink')
  88       end
  89    end
  90 end
  91
  92 local res = {}
  93 local function get_total_stretched(p)
  94    local go, gf, gs
  95       = getfield(p, 'glue_order'), getfield(p, 'glue_set'), getfield(p, 'glue_sign')
  96    res[0], res.glue_set, res.name = 0, gf, (gs==1) and 'stretch' or 'shrink'
  97    for i=1,#priority_table do res[priority_table[i]]=0 end
  98    if go ~= 0 then return nil end
  99    if gs ~= 1 and gs ~= 2 then return res end
 100    for q in node_traverse_id(id_glue, getlist(p)) do
 101       local a, ic = get_stretched(q, go, gs), get_attr_icflag(q)
 102       if   type(res[ic]) == 'number' then
 103          -- kanjiskip, xkanjiskip は段落内で spec を共有しているが，
 104          -- それはここでは望ましくないので，各 glue ごとに異なる spec を使う．
 105          -- （この仮定でメモリリークを起こしている！）
 106          -- JFM グルーはそれぞれ異なる glue_spec を用いているので，問題ない．
 107          if (ic == KANJI_SKIP or ic == XKANJI_SKIP) and getsubtype(q)==0 then
 108             local qs = getfield(q, 'spec')
 109             if qs ~= spec_zero_glue then
 110                local f = node_new(id_glue)
 111                setfield(f, 'spec', qs)
 112                setfield(q, 'spec', node_copy(qs))
 113                node_free(f)
 114             end
 115          elseif ic == KANJI_SKIP_JFM  then ic = KANJI_SKIP
 116          elseif ic == XKANJI_SKIP_JFM  then ic = XKANJI_SKIP
 117          end
 118          res[ic] = res[ic] + a
 119       else
 120          res[0]  = res[0]  + a
 121       end
 122    end
 123    return res
 124 end
 125
 126 local function clear_stretch(p, ic, name)
 127    for q in node_traverse_id(id_glue, getlist(p)) do
 128       if get_attr_icflag(q) == ic then
 129          local qs = getfield(q, 'spec')
 130          if getfield(qs, 'writable') then
 131             setfield(qs, name..'_order', 0)
 132             setfield(qs, name, 0)
 133          end
 134       end
 135    end
 136 end
 137
 138 local set_stretch_table = {}
 139 local function set_stretch(p, after, before, ic, name)
 140    if before > 0 then
 141       --print (ic, before, after)
 142       local ratio = after/before
 143       for i,_ in pairs(set_stretch_table) do
 144          set_stretch_table[i] = nil
 145       end
 146       for q in node_traverse_id(id_glue, getlist(p)) do
 147          local f = get_attr_icflag(q)
 148          if (f == ic) or ((ic ==KANJI_SKIP) and (f == KANJI_SKIP_JFM))
 149            or ((ic ==XKANJI_SKIP) and (f == XKANJI_SKIP_JFM)) then
 150             local qs, do_flag = getfield(q, 'spec'), true
 151             for i=1,#set_stretch_table do
 152                if set_stretch_table[i]==qs then do_flag = false end
 153             end
 154             if getfield(qs, 'writable') and getfield(qs, name..'_order')==0 and do_flag then
 155                setfield(qs, name, getfield(qs, name)*ratio)
 156                set_stretch_table[#set_stretch_table+1] = qs
 157             end
 158          end
 159       end
 160    end
 161 end
 162
 163 -- step 1: 行末に kern を挿入（句読点，中点用）
 164 local function aw_step1(p, res, total)
 165    local head = getlist(p)
 166    local x = node_tail(head); if not x then return false end
 167    x = node_prev(x); if not x then return false end
 168    -- 本当の行末の node を格納
 169    if getid(x) == id_glue and getsubtype(x) == 15 then
 170       -- 段落最終行のときは，\penalty10000 \parfillskip が入るので，
 171       -- その前の node が本来の末尾文字となる
 172       x = node_prev(node_prev(x))
 173    end
 174    local xi, xc = getid(x)
 175    if xi == id_glyph and has_attr(x, attr_curjfnt) == getfont(x) then
 176       -- 和文文字
 177       xc = x
 178    elseif xi == id_hlist and get_attr_icflag(x) == PACKED then
 179       -- packed JAchar
 180       xc = getlist(x)
 181       while getid(xc) == id_whatsit do xc = node_next(xc) end
 182    else
 183      return false-- それ以外は対象外．
 184    end
 185    local xk = ltjf_font_metric_table[getfont(xc)]
 186      xk = xk.char_type[has_attr(xc, attr_jchar_class) or 0]
 187      xk = xk['end_' .. res.name] or 0
 188
 189    if xk>0 and total>=xk then
 190       total = total - xk
 191       local kn = node_new(id_kern)
 192       setfield(kn, 'kern', (res.name=='shrink' and -1 or 1) * xk)
 193       set_attr(kn, attr_icflag, FROM_JFM)
 194       insert_after(head, x, kn)
 195       return true
 196    else return false
 197    end
 198 end
 199
 200 -- step 2: 行中の glue を変える
 201 local function aw_step2(p, res, total, added_flag)
 202    if total == 0 then -- もともと伸縮の必要なし
 203       if added_flag then -- 行末に kern 追加したので，それによる補正
 204          local f = node_hpack(getlist(p), getfield(p, 'width'), 'exactly')
 205          setfield(f, 'head', nil)
 206          setfield(p, 'glue_set', getfield(f, 'glue_set'))
 207          setfield(p, 'glue_order', getfield(f, 'glue_order'))
 208          setfield(p, 'glue_sign', getfield(f, 'glue_sign'))
 209          node_free(f)
 210          return
 211       end
 212    elseif total <= res[0] then -- 和文処理グルー以外で足りる
 213       for _,v in pairs(priority_table) do clear_stretch(p, v, res.name) end
 214       local f = node_hpack(getlist(p), getfield(p, 'width'), 'exactly')
 215       setfield(f, 'head', nil)
 216          setfield(p, 'glue_set', getfield(f, 'glue_set'))
 217          setfield(p, 'glue_order', getfield(f, 'glue_order'))
 218          setfield(p, 'glue_sign', getfield(f, 'glue_sign'))
 219       node_free(f)
 220    else
 221       local orig_total, avail = total, res[0]
 222       total, i = total - res[0], 1
 223       while i <= #priority_table do
 224          local v = priority_table[i]
 225          if total <= res[v] then
 226             for j = i+1,#priority_table do
 227                clear_stretch(p, priority_table[j], res.name)
 228             end
 229             set_stretch(p, total, res[v], v, res.name)
 230             avail = avail + total
 231             i = #priority_table + 9 -- ループから抜けさせたいため
 232          end
 233          total, i, avail = total - res[v], i+1, avail + res[v]
 234       end
 235       if i == #priority_table + 10 or added_flag then
 236          local f = node_hpack(getlist(p), getfield(p, 'width'), 'exactly')
 237          setfield(f, 'head', nil)
 238          setfield(p, 'glue_set', getfield(f, 'glue_set'))
 239          setfield(p, 'glue_order', getfield(f, 'glue_order'))
 240          setfield(p, 'glue_sign', getfield(f, 'glue_sign'))
 241          node_free(f)
 242       end
 243    end
 244 end
 245
 246
 247 local ltjs_fast_get_stack_skip = ltjs.fast_get_stack_skip
 248 local function adjust_width(head)
 249    if not head then return head end
 250    for p in node_traverse_id(id_hlist, to_direct(head)) do
 251       local res = get_total_stretched(p)
 252         -- this is the same table as the table which is def'd in l. 92
 253       if res then
 254          -- 調整量の合計
 255          local total = 0
 256          for i,v in pairs(res) do
 257             if type(i)=='number' then
 258                total = total + v
 259             end
 260          end; total = round(total * res.glue_set)
 261          aw_step2(p, res, total, aw_step1(p, res, total))
 262       end
 263    end
 264    return to_node(head)
 265 end
 266
 267 do
 268    local is_reg = false
 269    function enable_cb()
 270       if not is_reg then
 271          luatexbase.add_to_callback('post_linebreak_filter',
 272                                     adjust_width, 'Adjust width', 100)
 273          is_reg = true
 274       end
 275    end
 276    function disable_cb()
 277       if is_reg then
 278          luatexbase.remove_from_callback('post_linebreak_filter', 'Adjust width')
 279          is_reg = false
 280       end
 281    end
 282 end
 283
 284 luatexja.unary_pars.adjust = function(t)
 285    return is_reg and 1 or 0
 286 end