mirror of
https://github.com/koreader/koreader
synced 2024-11-10 01:10:34 +00:00
a2dcfe9aec
This commit standardizes the various todos around the code a bit in a manner recognized by LDoc. Besides drawing more attention by being displayed in the developer docs, they're also extractable with LDoc on the command line: ```sh ldoc --tags todo,fixme *.lua ``` However, whether that particular usage offers any advantage over other search tools is questionable at best. * and some random beautification
103 lines
2.3 KiB
Lua
103 lines
2.3 KiB
Lua
local logger = require("logger")
|
|
local dump = require("dump")
|
|
local isAndroid, android = pcall(require, "android")
|
|
|
|
local Dbg = {
|
|
-- set to nil so first debug:turnOff call won't be skipped
|
|
is_on = nil,
|
|
is_verbose = nil,
|
|
ev_log = nil,
|
|
}
|
|
|
|
local Dbg_mt = {}
|
|
|
|
local function LvDEBUG(lv, ...)
|
|
local line = ""
|
|
for i,v in ipairs({...}) do
|
|
if type(v) == "table" then
|
|
line = line .. " " .. dump(v, lv)
|
|
else
|
|
line = line .. " " .. tostring(v)
|
|
end
|
|
end
|
|
if isAndroid then
|
|
android.LOGV(line)
|
|
else
|
|
io.stdout:write(string.format("# %s %s\n", os.date("%x-%X"), line))
|
|
io.stdout:flush()
|
|
end
|
|
end
|
|
|
|
function Dbg:turnOn()
|
|
if self.is_on == true then return end
|
|
self.is_on = true
|
|
logger:setLevel(logger.levels.dbg)
|
|
|
|
Dbg_mt.__call = function(dbg, ...) LvDEBUG(math.huge, ...) end
|
|
Dbg.guard = function(_, mod, method, pre_guard, post_guard)
|
|
local old_method = mod[method]
|
|
mod[method] = function(...)
|
|
if pre_guard then
|
|
pre_guard(...)
|
|
end
|
|
local values = {old_method(...)}
|
|
if post_guard then
|
|
post_guard(...)
|
|
end
|
|
return unpack(values)
|
|
end
|
|
end
|
|
Dbg.dassert = function(check, msg)
|
|
assert(check, msg)
|
|
return check
|
|
end
|
|
|
|
--- @todo close ev.log fd for children
|
|
-- create or clear ev log file
|
|
self.ev_log = io.open("ev.log", "w")
|
|
end
|
|
|
|
function Dbg:turnOff()
|
|
if self.is_on == false then return end
|
|
self.is_on = false
|
|
logger:setLevel(logger.levels.info)
|
|
function Dbg_mt.__call() end
|
|
function Dbg.guard() end
|
|
Dbg.dassert = function(check)
|
|
return check
|
|
end
|
|
if self.ev_log then
|
|
io.close(self.ev_log)
|
|
self.ev_log = nil
|
|
end
|
|
end
|
|
|
|
function Dbg:setVerbose(verbose)
|
|
self.is_verbose = verbose
|
|
end
|
|
|
|
function Dbg:v(...)
|
|
if self.is_verbose then
|
|
LvDEBUG(math.huge, ...)
|
|
end
|
|
end
|
|
|
|
function Dbg:logEv(ev)
|
|
local ev_value = tostring(ev.value)
|
|
local log = ev.type.."|"..ev.code.."|"
|
|
..ev_value.."|"..ev.time.sec.."|"..ev.time.usec.."\n"
|
|
if self.ev_log then
|
|
self.ev_log:write(log)
|
|
self.ev_log:flush()
|
|
end
|
|
end
|
|
|
|
function Dbg:traceback()
|
|
LvDEBUG(math.huge, debug.traceback())
|
|
end
|
|
|
|
setmetatable(Dbg, Dbg_mt)
|
|
|
|
Dbg:turnOff()
|
|
return Dbg
|