-- Lua Explorer „Advanced“,
-- based on Lua Explorer by EGez
-- modded by John Doe: http://forum.farmanager.com/viewtopic.php?f=60&t=7988
-- release 2.0.1
--[[
Lua Explorer
Explore Lua environment in your Far manager
Author: Eugen Gez (EGez/http://forum.farmanager.com)
updates, suggestions, etc.:
http://forum.farmanager.com/viewtopic.php?f=15&t=7521
BE CAREFUL:
calling some functions could cause deadlocks!!!
you will need to kill far process in such cases
do not call functions like debug.debug() or io.* functions
that read from stdin unless you know what you are doing
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
ANY USE IS AT YOUR OWN RISK.
Do what you want with this code, but please do not remove this comment
and write your changes down.
<obsolete changelog removed> --JD
UPDATED:
Change "msgbox" to "far.Message". Big thanks John Doe and Acerbic for idea! /* VictorVG */
]]
-- assert(Far, 'This is a LuaMacro for Far manager')
local uuid = win.Uuid('7646f761-8954-42ca-9cfc-e3f98a1c54d3')
local help = [[
There are some keys available:
F1 Show this help
F4 Edit selected object
Del Delete selected object
Ins Add an object to current table
Ctrl+M Show metatable
Ctrl+F Show/hide functions
Ctrl+T Toggle sort by type
for functions:
Enter Call function (params prompted)
F3 Show some function info
Shift+F3 Show some function info (LuaJIT required)
Alt+F4 Open function definition (if available) in editor
Ctrl+Up Show upvalues (editable)
Ctrl+Down Show environment (editable)
Copy to clipboard:
Ctrl+Ins value
Ctrl+Shift+Ins key
]]
local omit = {}
local brkeys = {}
local tables_first = true
-- format values for menu items and message boxes
local function valfmt(val,mode)
local t = type(val)
if t == 'string' then
if not val:utf8valid() then val = win.Utf16ToUtf8(win.MultiByteToWideChar(val,win.GetACP())) end
if val:match'%z' or mode=='edit' then
val = ('%q'):format(val)
elseif mode~='view' and (mode~='list' or val=='' or val:sub(-1,-1)==" ") then
val = '"'..val..'"'
end
return val,t
elseif t == 'number' then
return (mode=='edit' and '0x%x --[[ %s ]]' or '0x%08x (%s)'):format(val, val),t
end
return tostring(val),t
end
-- make menu item for far.Menu(...)
local key_w = 30
local item_fmt = ('%%-%s.%ss'):format(key_w,key_w)..'%s%-8s │%-25s'
local function makeItem(key, sval, vt)
local k = valfmt(key,'list')
local border = k:len()<=key_w and '│' or '…'
--local a,b=pcall(format, k, border, vt, sval)
if true then
--error(1)
--far.Show(tostring(k), border, vt, sval)
end
return {
text = item_fmt:format(k, border, vt, sval),
key = key,
type = vt,
checked = vt=='table' and '≡' --⁞≡•·÷»›►
or vt=='function' and '˜' --ᶠ¨˝˜
}
end
-- create sorted menu items with associated keys
local function makeMenuItems(obj)
local items = {}
-- grab all 'real' keys
for key in pairs(obj) do
local sval, vt = valfmt(obj[key],'list')
if not omit[vt] then
table.insert(items, makeItem(key, sval, vt))
end
end
-- Far uses some properties that in fact are functions in obj.properties
-- but they logically belong to the object itself. It's all Lua magic 
local success,props = pcall(function()return obj.properties end)
--if not success then far.Message(props,"Error in __index metamethod",nil,"wl") end
if type(props) == 'table' and not rawget(obj, 'properties') then
--if type(obj.properties) == 'table' and not rawget(obj, 'properties') then
for key in pairs(obj.properties) do
local sval, vt = valfmt(obj[key],'list')
if not omit[vt] then
table.insert(items, makeItem(key, sval, vt))
end
end
end
-- table.sort(items, function(v1, v2) return v1.text < v2.text end)
--[[
table.sort(items, function(v1, v2)
if tables_first and (v1.type=='table') ~= (v2.type=='table') then
return v1.type=='table'
else
return v1.text < v2.text
end
end)
--]]
---[[
table.sort(items, function(v1, v2)
if tables_first and v1.type~=v2.type then
return v1.type=='table' or v2.type~='table' and v1.type<v2.type
else
return v1.text < v2.text
end
end)
--]]
return items
end
local function luaexp_prompt(Title,Prompt,Src)
repeat
local expr = far.InputBox (nil, Title:gsub('&','&&',1), Prompt,
Title, Src, nil, nil, far.Flags.FIB_ENABLEEMPTY)
if not expr then return end
local f,err = loadstring('return '..expr)
if f then
local res = {pcall(f)}
if res[1] then table.remove(res,1); return res,expr
else far.Message(res[2],'Error',nil,'w')
end
else
far.Message(err,'Error in expression',nil,'wl')
end
until false
end
-- edit or remove object at obj[key]
local function editValue(obj, key, title, del)
if del then
if 1 == far.Message(('%s is a %s, do you want to remove it?'):format(valfmt(key),
type(obj[key]):upper()),
'REMOVE: ' .. title,
';YesNo',
'w') then
obj[key] = nil
end
else
local v, t = valfmt(obj[key], "edit")
if t == 'table' or t == 'function' then v = '' end
local prompt = ('%s is a %s, type new value as Lua code'):format(valfmt(key),t:upper())
local res = luaexp_prompt('EDIT: ' .. title, prompt, v)
obj[key] = res and res[1] or obj[key]
end
end
-- add new element to obj
local function insertValue(obj, title)
local res = luaexp_prompt('INSERT: ' .. title,
'type the key and value comma separated as Lua code')
if res then
local k, v = unpack(res)
if k~=nil then obj[k] = v end
end
end
local function concat(t,delim)
local s = tostring(t[1])
for i=2,#t do s = s..delim..tostring(t[i]) end
return s
end
local function getfParamsNames(f)
if not jit then return '...' end
local info = debug.getinfo(f)
local params = {}
for i=1,info.nparams or 1000 do
local k = debug.getlocal (f, i)
if not k then return params, #params, error(); end --impossible in lua 5.2 or luajit 2
params[i] = k
end
if info.isvararg then params[#params+1] = '...' end
local paramstr = #params>0 and table.concat(params,', ') or '<none>'
return paramstr, params
end
-- show a menu whose items are associated with the members of given object
local function process(obj, title, action)
title = title or ''
if action then brkeys[action]({obj}, 1, title); return end
local items, mprops = {}, {Id = uuid, Bottom = 'F1, F3, F4, Del, Ctrl+M',
Flags={FMENU_SHOWAMPERSAND=1,FMENU_WRAPMODE=1}}--,FMENU_AUTOHIGHLIGHT=1}}
local otype = type(obj)
local item, index
-- some member types, need specific behavior:
-- tables are submenus
-- functions can be called
if otype == 'function' then
--[[
local args,argstr
= luaexp_prompt(('CALL: %s (%s)'):format(title,getfParamsNames(obj)),
'Type arguments as Lua code or leave empty:')
--]]
---[[
local args,argstr = luaexp_prompt('CALL:'..title,
('arguments: %s (type as Lua code or leave empty)')
:format(getfParamsNames(obj)))
--]]
if args then
-- overwrite the function object with its return values
local res = {pcall(obj, unpack(args))}
if res[1] then
table.remove(res,1)
obj = res
title = ('%s(%s)'):format(title,argstr)
else
far.Message(([[
function: %s
arguments: %s
values: %s
%s]]):format(title,argstr,concat(args,', '),res[2]),'Error',nil,'wl')
return
end
else
return
end
-- other values are simply displayed in a message box
elseif otype ~= 'table' then
local value = valfmt(obj,"view")
far.Message(value, title:gsub('&','&&',1), nil, value:match'\n' and 'l' or '')
return
end
-- show this menu level again after each return from a submenu/function call ...
repeat
items = makeMenuItems(obj)
mprops.Title = title .. ' (' .. #items .. ')' .. (omit['function'] and '*' or '')
item, index = far.Menu(mprops, items, brkeys)
mprops.SelectIndex = index
-- show submenu/call function ...
if item then
local key = item.key or (index > 0 and items[index].key)
if item.key ~= nil then
process(obj[key], title .. '.' .. tostring(key))
elseif item.action then
if "break"==item.action(obj, key, (title .. '.' .. tostring(key))) then return end
end
end
-- until the user is bored and goes back
until not item
end
local function getAllUpvalues(f)
local upvalues = {}
for i=1,1000 do
local k,v = debug.getupvalue (f, i)
if not k then return upvalues, i-1 end
upvalues[k] = v
end
end
local function syncUpvalues(f,t,n)
for i=n,1,-1 do
local k,v = debug.getupvalue (f, i)
if t[k]~=v then
assert(k == debug.setupvalue (f, i, t[k]))
end
end
end
local function getAllLocals(level)
local locals = {}
for i=1,1000 do
local k,v = debug.getlocal (level+1, i)
if not k then return locals, i-1 end
locals[k] = v
end
end
local function syncLocals(level,t,n)
level = level + 1
for i=n,1,-1 do
local k,v = debug.getlocal (level, i)
if t[k]~=v then
assert(k == debug.setlocal (level, i, t[k]))
end
end
end
local function getVararg(level)
local vararg = {}
for i=1,1000 do
local k,v = debug.getlocal (level+1, -i)
if not k then return vararg end--(*vararg)
vararg[i] = v
end
end
local function syncVararg(level,t)
for i=1,#t do
local k,v = debug.getlocal (level+1, -i)
if v~=t[i] then debug.setlocal (level+1, -i, t[i]) end
end
end
local function getLocalsAndParams(level)
local locals,n = getAllLocals(level+1)
local info = debug.getinfo(level+1)
local vararg = getVararg(level+1)
vararg = vararg[1] and vararg
locals['(*vararg)'] = locals['(*vararg)'] or vararg or nil
local info = debug.getinfo(level+1)
local name = ('(*func: %s)'):format(info.name or '<noname>')
locals[name] = locals[name] or info.func
return locals,n,vararg
end
local function showLocals(level,shift)
--far.Show(level,shift)
if not shift then
shift = 0
for i = 1,1000 do
local info = debug.getinfo(i,'f')
if not info then break end
if info.func==process then shift = i end
end
if shift>900 then return end
end
level = level + shift
local info = debug.getinfo(level,'')
if not info then mf.beep() return end
local locals,n,vararg = getLocalsAndParams(level)
if n>0 or vararg then
process(locals, ('locals [%d]: %s'):format(level-shift,info.name or 'main chunk'))
syncLocals(level,locals,n)
if vararg then syncVararg(level,vararg) end
return 'break'
end
end
brkeys = {
{BreakKey = 'F9', action = function(info)
process(debug.getregistry(), 'debug.getregistry:')
end; name = 'registry'},
{BreakKey = 'Ctrl+1', action = function() return showLocals(1) end; name = 'locals'},
{BreakKey = 'Ctrl+2', action = function() return showLocals(2) end; name = 'locals2'},
{BreakKey = 'Ctrl+3', action = function() return showLocals(3) end; name = 'locals3'},
{BreakKey = 'Ctrl+4', action = function() return showLocals(4) end; name = 'locals4'},
{BreakKey = 'Ctrl+5', action = function() return showLocals(5) end; name = 'locals5'},
{BreakKey = 'Ctrl+6', action = function() return showLocals(6) end; name = 'locals6'},
{BreakKey = 'Ctrl+7', action = function() return showLocals(7) end; name = 'locals7'},
{BreakKey = 'Ctrl+8', action = function() return showLocals(8) end; name = 'locals8'},
{BreakKey = 'Ctrl+9', action = function() return showLocals(9) end; name = 'locals9'},
{BreakKey = 'Ctrl+0', action = function() return showLocals(0) end;},
{BreakKey = 'Ctrl+G', action = function() process(_G,'_G'); return "break" end},
{BreakKey = 'Ctrl+Insert', action = function(obj, key)
far.CopyToClipboard ((valfmt(obj[key])))
end},
{BreakKey = 'CtrlShift+Insert', action = function(obj, key)
far.CopyToClipboard ((valfmt(key)))
end},
{BreakKey = 'Ctrl+Up', action = function(obj, key, kpath)
local f = obj[key]
if type(f) == 'function' then
local t,n = getAllUpvalues(f)
if n>0 then
process(t, 'upvalues: ' .. kpath)
syncUpvalues(f,t,n)
end
end
end; name = 'upvalues'},
{BreakKey = 'Ctrl+Down', action = function(obj, key, kpath)
local f = obj[key]; local t = type(f)
if t=='function' or t=='userdata' or t=='thread' then
local env = debug.getfenv(f)
if (env~=_G or 1==far.Message('_G','Show global environment?',';OkCancel'))
and next(env) then
process(env, 'getfenv: ' .. kpath)
end
end
end; name = 'env'},
{BreakKey = 'Ctrl+Right', action = function(obj, key, kpath)
local f = obj[key]
if type(f) == 'function' then
local args,t = getfParamsNames(f)
if args:len()>0 then
process(t, 'params (f): ' .. kpath)
local name = debug.getinfo(f).name
--far.Message(('%s (%s)'):format(name or kpath,args), 'params')
end
end
end; name = 'params'},
{BreakKey = 'Alt+F4', action = function(obj, key, kpath)
local f = obj[key]
if type(f) == 'function' then
local info = debug.getinfo(f,'S')
local filename = info.source:match("^@(.+)$")
if filename then
editor.Editor(filename,nil,nil,nil,nil,nil,nil,info.linedefined)
end
end
end; name = 'edit'},
{BreakKey = 'F3', action = function(obj, key, kpath)
local f = obj[key]
if type(f) == 'function' then
process(debug.getinfo(f), 'debug.getinfo: ' .. kpath)
elseif type(f) == 'thread' then
far.Message(debug.traceback(f,"level 0",0),'debug.traceback: ' .. kpath,nil,'l')
--far.Show('debug.traceback: ' .. kpath .. debug.traceback(f,", level 0",0))
end
end; name = 'info'},
{BreakKey = 'F4', action = function(obj, key, kpath)
return key ~= nil and editValue(obj, key, kpath)
end},
{BreakKey = 'Ctrl+F', action = function()
omit['function'] = not omit['function']
end},
{BreakKey = 'Ctrl+T', action = function()
tables_first = not tables_first
end},
{BreakKey = 'Ctrl+M', action = function(obj, key, kpath)
local mt = key ~= nil and debug.getmetatable(obj[key])
return mt and process(mt, 'METATABLE: ' .. kpath)
end; name = 'mt'},
{BreakKey = 'DELETE', action = function(obj, key, kpath)
return key ~= nil and editValue(obj, key, kpath, true)
end},
{BreakKey = 'INSERT', action = function(obj, key, kpath)
insertValue(obj, kpath:sub(1, -(#tostring(key) + 2)))
end},
{BreakKey = 'F1', action = function()
far.Message(help,'Lua Explorer - Help',nil,'l')
end},
}
-- if LuaJIT is used, maybe we can show some more function info
if jit then
funcinfo = require('jit.util').funcinfo
table.insert(brkeys, {BreakKey = 'Shift+F3', action = function(obj, key, kpath)
if key ~= nil and type(obj[key]) == 'function' then
process(funcinfo(obj[key]), 'jit.util.funcinfo: ' .. kpath)
end
end; name = 'jitinfo'})
end
for i=1,#brkeys do
local bk = brkeys[i]; if bk.name then brkeys[bk.name] = bk.action end
end
if not Macro then return process end
Macro { description = "Lua Explorer";
area="Common"; key="CtrlShiftF12"; action=function()
process(_G,'_G')
--require"le"(_G,'_G')
end
}
-- it's possible to call via lm:post, e.g. from user menu:
-- lm:post dofile(win.GetEnv("FARPROFILE")..[[\Macros\scripts\le.lua]])(_G,'_G')
-- lm:post require"le"(_G,'_G')
|
