src/ltj-adjust.lua

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