src/ltj-debug.lua

   1 --
   2 -- ltj-debug.lua
   3 --
   4 local ltjdbg = {}
   5 luatexja.debug = ltjdbg
   6 local table, string = table, string
   7
   8 -------------------- pretty-print
   9
  10 local function get_serialize_param()
  11   return table.serialize_functions,
  12          table.serialize_compact,
  13          table.serialize_inline
  14 end
  15 local function set_serialize_param(s_f, s_c, s_i)
  16   table.serialize_functions = s_f
  17   table.serialize_compact = s_c
  18   table.serialize_inline = s_i
  19 end
  20
  21 local function normal_serialize(t)
  22   local s_f, s_c, s_i = get_serialize_param()
  23   set_serialize_param(true, true, true)
  24   local ret = table.serialize(t, false, false, true)
  25   set_serialize_param(s_f, s_c, s_i)
  26   return ret
  27 end
  28
  29 local function table_tosource(t)
  30   if not next(t) then return "{}" end
  31   local res_n = "\127"..normal_serialize({t}).."\127"
  32   local s, e, cap = res_n:find("\127{\n ({ .* }),\n}\127")
  33   if s == 1 and e == res_n:len() then return cap
  34   else return normal_serialize(t)
  35   end
  36 end
  37 ltjdbg.table_tosource = table_tosource
  38
  39 local function function_tosource(f)
  40   local res = normal_serialize({f})
  41   return res:sub(4, res:len() - 3)
  42 end
  43 ltjdbg.function_tosource = function_tosource
  44
  45 --! 値 v をそれを表すソース文字列に変換する.
  46 --! lualibs の table.serialize() の処理を利用している.
  47 local function tosource(v)
  48   local tv = type(v)
  49   if tv == "function" then return function_tosource(v)
  50   elseif tv == "table" then return table_tosource(v)
  51   elseif tv == "string" then return string.format('%q', v)
  52   else return tostring(v)
  53   end
  54 end
  55 ltjdbg.tosource = tosource
  56
  57 local function coerce(f, v)
  58   if f == "q" then return "s", tosource(v)
  59   elseif f == "s" then return f, tostring(v)
  60   else return f, tonumber(v) or 0
  61   end
  62 end
  63
  64 local function do_pformat(fmt, ...)
  65   fmt = fmt:gsub("``", "\127"):gsub("`", "%%"):gsub("\127", "`")
  66   local i, na, a = 0, {}, {...}
  67   local function proc(p, f)
  68     i = i + 1; f, na[i] = coerce(f, a[i])
  69     return p..f
  70   end
  71   fmt = fmt:gsub("(%%[-+#]?[%d%.]*)([a-zA-Z])", proc)
  72   return fmt:format(unpack(na))
  73 end
  74
  75 --! string.format() の拡張版. 以下の点が異なる.
  76 --!  - %q は全ての型について tosource() に変換
  77 --!  - <%> の代わりに <`> も使える (TeX での使用のため)
  78 --!  - %d, %s 等でキャストを行う
  79 local function pformat(fmt, ...)
  80   if type(fmt) == "string" then
  81     return do_pformat(fmt, ...)
  82   else
  83     return tosource(fmt)
  84   end
  85 end
  86 ltjdbg.pformat = pformat
  87
  88 -------------------- 所要時間合計
  89 do
  90    local max = math.max
  91    local gettime = os.socketgettime or (socket and socket.gettime)
  92    local time_stat = {}
  93    local function start_time_measure(n)
  94       if not time_stat[n] then
  95          time_stat[n] = {1, -gettime()}
  96       else
  97          local t = time_stat[n]
  98          t[1], t[2] = t[1]+1, t[2]-gettime()
  99       end
 100    end
 101    local function stop_time_measure(n)
 102       local t = time_stat[n]
 103       t[2] = t[2] + gettime()
 104    end
 105
 106    local function print_measure()
 107       stop_time_measure 'RUN'
 108       local temp = {}
 109       for i,v in pairs(time_stat) do
 110          temp[#temp+1] = { i, v[1], v[2], v[2]/v[1] }
 111       end
 112       table.sort(temp, function (a,b) return (a[4]>b[4]) end)
 113       print()
 114       print('desc', 'ave. (us)', 'times', 'total (ms)')
 115       for _,v in ipairs(temp) do
 116          print ((v[1] .. '                '):sub(1,16), 1000000*v[4], v[2], 1000*v[3])
 117       end
 118    end
 119    if luatexja.base then
 120       luatexja.base.start_time_measure = start_time_measure
 121       luatexja.base.stop_time_measure = stop_time_measure
 122       luatexbase.add_to_callback('stop_run', print_measure, 'luatexja.time_measure', 1)
 123       luatexbase.add_to_callback('pre_linebreak_filter',
 124                                  function(p)
 125                                     start_time_measure 'tex_linebreak'; return p
 126                                  end,
 127                                  'measure_tex_linebreak', 20000)
 128    end
 129 end
 130
 131 -------------------- debug logging
 132 do
 133 local debug_show_term = true
 134 local debug_show_log = true
 135 --! デバッグログを端末に出力するか
 136 local function show_term(v)
 137   debug_show_term = v
 138 end
 139 ltjdbg.show_term = show_term
 140 --! デバッグログをログファイルに出力するか
 141 function show_log(v)
 142   debug_show_log = v
 143 end
 144 ltjdbg.show_log = show_log
 145
 146 local function write_debug_log(s)
 147   local target
 148   if debug_show_term and debug_show_log then
 149     texio.write_nl("term and log", s)
 150   elseif debug_show_term and not debug_show_log then
 151     texio.write_nl("term", s)
 152   elseif not debug_show_term and debug_show_log then
 153     texio.write_nl("log", s)
 154   end
 155 end
 156
 157 --! デバッグログ出力. 引数は pformat() と同じ.
 158 local function out_debug(...)
 159   if debug_show_term or debug_show_log then
 160     write_debug_log("%DEBUG:"..pformat(...))
 161   end
 162 end
 163
 164 --! デバッグログ出力, パッケージ名付き.
 165 local function package_debug(pkg, ...)
 166   if debug_show_term or debug_show_log then
 167     write_debug_log("%DEBUG("..pkg.."):"..pformat(...))
 168   end
 169 end
 170
 171 --! パッケージ名付きデバッグログ出力器を得る.
 172 local function debug_logger(pkg)
 173   return function(...) package_debug(pkg, ...) end
 174 end
 175
 176 if luatexja.base then
 177   luatexja.base.out_debug = out_debug
 178   luatexja.base.package_debug = package_debug
 179   luatexja.base.debug_logger = debug_logger
 180   luatexja.base.show_term = show_term
 181   luatexja.base.show_log = show_log
 182 end
 183 end
 184
 185 -------------------- all done
 186 -- EOF