opus-apps/debugger/debug.lua

local Config = require('opus.config')
local Event  = require('opus.event')
local UI     = require('opus.ui')
local Util   = require('opus.util')

local fs         = _G.fs
local getfenv    = _G.getfenv
local kernel     = _G.kernel
local multishell = _ENV.multishell
local shell      = _ENV.shell

local args = { ... }
local filename = shell.resolveProgram(table.remove(args, 1))

if not filename then
	error('file not found')
end

local config = Config.load('debugger')
if not config.filename then
	config.filename = { }
end

local breakpoints = config.filename
local currentFile
local debugFile, debugLine

local debugger = kernel.getCurrent()
local client

local function startClient()
	local env = kernel.makeEnv(_ENV)

	local clientId = multishell.openTab(nil, {
		env = env,
		title = fs.getName(filename):match('([^%.]+)'),
		args = args,
		fn = function(...)
			local dbg = require('debugger')
			local fn = loadfile(filename, env)

			local cocreate = coroutine.create
			env.coroutine = require('opus.util').shallowCopy(coroutine)
			env.coroutine.create = function(f, ...)
				local co = cocreate(f, ...)
				debug.sethook(co, dbg.hook, "l")
				return co
			end

			dbg.debugger = debugger
			dbg.breakpoints = breakpoints
			dbg.stopIn(fn)
			fn(...)
		end,
	})
	client = kernel.find(clientId)
end

local function loadSource(file)
	currentFile = file:match('@?(.*)')
	local src = { }
	local lines = Util.readLines(file:match('@?(.*)'))

	if lines then
		for i = 1, #lines do
			table.insert(src, { line = i, source = lines[i] })
		end
	end

	return src
end

local function message(...)
	client:resume('debugger', ...)
end

local page = UI.Page {
	menuBar = UI.MenuBar {
		buttons = {
			{ text = 'Continue',  event = 'cmd', cmd = 'c'  },
			{ text = 'Step',      event = 'cmd', cmd = 's' },
			{ text = 'Step Over', event = 'cmd', cmd = 'n' },
			{ text = 'Step Out',  event = 'cmd', cmd = 'f' },
			{ text = 'Restart',   event = 'restart', width = 9, ex = -1 },
		},
	},

	container = UI.Window {
		y = 2, ey = '50%',
		locals = UI.ScrollingGrid {
			ey = -2,
			disableHeader = true,
			columns = {
				{ heading = 'Key',   key = 'name' },
				{ heading = 'Value', key = 'value', textColor = 'yellow' },
			},
			--sortColumn = 'name',
			autospace = true,
			accelerators = {
				grid_select = 'show_variable',
			},
		},
		statusBar = UI.StatusBar {
			ex = -7, y = -1,
			backgroundColor = 'primary',
			textColor = 'white',
		},
		UI.Button {
			y = -1, x = -6,
			event = 'open',
			text = 'Open',
		}
	},

	tabs = UI.Tabs {
		y = '50%',
		source = UI.Tab {
			title = 'Source',
			index = 1,
			grid = UI.ScrollingGrid {
				disableHeader = true,
				columns = {
					{ key = 'marker', width = 1 },
					{ key = 'line', textColor = 'cyan', width = 4 },
					{ heading = 'heading', key = 'source' },
				},
				getDisplayValues = function(_, row)
					for _,v in pairs(breakpoints) do
						if v.file == currentFile and v.line == row.line then
							return {
								marker = '!',
								line = row.line,
								source = row.source,
							}
						end
					end
					return row
				end,
				getRowTextColor = function(self, row, selected)
					return row.line == debugLine and currentFile == debugFile and 'yellow'
						or UI.Grid.getRowTextColor(self, row, selected)
				end,
				eventHandler = function(self, event)
					if event.type == 'grid_select' then
						self:emit({
							type = 'toggle_breakpoint',
							file = currentFile,
							line = event.selected.line,
						})
					end
					return UI.Grid.eventHandler(self, event)
				end,
			},
		},

		stack = UI.Tab {
			title = 'Stack',
			index = 3,
			grid = UI.ScrollingGrid {
				columns = {
					{ key = 'index', width = 2 },
					{ heading = 'heading', key = 'desc' },
				},
				getRowTextColor = function(self, row, selected)
					return row.current and 'yellow'
						or UI.Grid.getRowTextColor(self, row, selected)
				end,
				sortColumn = 'index',
			},
			eventHandler = function(self, event)
				if event.type == 'grid_select' then
					message('r', event.selected.index)
				else
					return UI.Grid.eventHandler(self, event)
				end
			end,
		},

		env = UI.Tab {
			title = 'Env',
			index = 4,
			grid = UI.ScrollingGrid {
				columns = {
					{ heading = 'Key',   key = 'name' },
					{ heading = 'Value', key = 'value', textColor = 'yellow' },
				},
				autospace = true,
				accelerators = {
					grid_select = 'show_variable',
				},
				sortCompare = function() end,
			},
		},

		breaks = UI.Tab {
			title = 'Breakpoints',
			index = 2,
			menuBar = UI.MenuBar {
				buttons = {
					{ text = 'Toggle', event = 'toggle' },
					{ text = 'Remove', event = 'remove' },
					{ text = 'Clear',  event = 'clear' },
				},
			},
			grid = UI.ScrollingGrid {
				y = 2,
				columns = {
					{ heading = 'Line', key = 'line', width = 5 },
					{ heading = 'Name', key = 'short' },
					{ heading = 'Path', key = 'path', textColor = 'lightGray' },
				},
				values = breakpoints,
				autospace = true,
				getRowTextColor = function(self, row, selected)
					return row.disabled and 'lightGray'
						or UI.Grid.getRowTextColor(self, row, selected)
				end,
			},
			eventHandler = function(self, event)
				if event.type == 'clear' then
					Util.clear(self.grid.values)
					self:emit({ type = 'update_breakpoints' })

				elseif event.type == 'toggle' then
					local bp = self.grid:getSelected()
					if bp then
						bp.disabled = not bp.disabled
						self:emit({ type = 'update_breakpoints' })
					end

				elseif event.type == 'grid_select' then
					self:emit({
						type = 'open_file',
						file = event.selected.file,
						line = event.selected.line,
					})

				elseif event.type == 'remove' then
					local bp = self.grid:getSelected()
					if bp then
						Util.removeByValue(self.grid.values, bp)
						self:emit({ type = 'update_breakpoints' })
					end

				end
				return UI.Tab.eventHandler(self, event)
			end,
		},
	},

	quick_open = UI.QuickSelect {
		modal = true,
		enable = function() end,
		show = function(self)
			UI.QuickSelect.enable(self)
			self:focusFirst()
			self:draw()
			self:addTransition('expandUp', { easing = 'outBounce', ticks = 12 })
		end,
		eventHandler = function(self, event)
			if event.type == 'select_cancel' then
				self:disable()
			elseif event.type == 'select_file' then
				self.parent:openFile(event.file)
				self:disable()
			end
			return UI.QuickSelect.eventHandler(self, event)
		end,
	},

	openFile = function(self, file, line)
		if file ~= currentFile then
			local src = loadSource(file)
			self.tabs.source.grid:setValues(src)
		end
		if line then
			self.tabs.source.grid:setIndex(#self.tabs.source.grid.values)
			self.tabs.source.grid:setIndex(math.max(1, line - 4))
		end
		self.tabs.source.grid:setIndex(line or 1)
		self.tabs:selectTab(self.tabs.source)

		if currentFile == debugFile then
			self.container.statusBar:setStatus(
				string.format('%s : %d', fs.getName(file), debugLine))
		else
			self.container.statusBar:setStatus(fs.getName(file))
		end
		self:draw()
	end,
	eventHandler = function(self, event)
		if event.type == 'cmd' then
			self.container.statusBar:setStatus('Running...')
			message(event.element.cmd)

		elseif event.type == 'restart' then
			if kernel.find(client.uid) then
				client:resume('terminate')
			end
			startClient()

		elseif event.type == 'open' then
			self.quick_open:show()

		elseif event.type == 'open_file' then
			self:openFile(event.file, event.line)

		elseif event.type == 'update_breakpoints' then
			self.tabs.breaks.grid:update()
			self.tabs.breaks.grid:draw()
			self.tabs.source.grid:draw()
			message('b', breakpoints)
			Config.update('debugger', config)

		elseif event.type == 'toggle_breakpoint' then
			for k,v in pairs(breakpoints) do
				if v.file == event.file and v.line == event.line then
					table.remove(breakpoints, k)
					self:emit({ type = 'update_breakpoints' })
					return
				end
			end

			table.insert(breakpoints, {
				file = event.file,
				line = event.line,
				short = fs.getName(event.file),
				path = fs.getDir(event.file),
			})

			self:emit({ type = 'update_breakpoints' })

		elseif event.type == 'show_variable' then
			if type(event.selected.raw) == 'table' then
				if event.selected.children then
					event.selected.children = nil
				else
					event.selected.children = { }
					local t = event.selected.raw
					for k,v in pairs(t) do
						local depth = event.selected.depth or 0
						table.insert(event.selected.children,
							{ name = (' '):rep(depth + 2) .. k, value = tostring(v), raw = v, depth = depth + 2 })
					end
					table.sort(event.selected.children, function(a, b) return a.name < b.name end)
				end
				local t = { }
				local function insert(values)
					for _,v in pairs(values) do
						table.insert(t, v)
						if v.children then
							insert(v.children)
						end
					end
				end
				insert(event.element.orig)
				event.element:setValues(t)
				event.element:draw()
			end
		end
		return UI.Page.eventHandler(self, event)
	end,
	enable = function(self)
		UI.Page.enable(self)
		startClient()
	end,
}

Event.on('debugger', function(_, cmd, data)
	if cmd == 'info' then
		kernel.raise(debugger.uid)

		-- local tab
		local t = { }
		for k,v in pairs(data.locals or { }) do
			table.insert(t, { name = k, value = tostring(v), raw = v })
		end
		table.sort(t, function(a, b) return a.name < b.name end)
		page.container.locals:setValues(t)
		page.container.locals.orig = Util.shallowCopy(t)

		-- env tab
		t = { }
		for k,v in pairs(getfenv(data.info.func)) do
			table.insert(t, { name = k, value = tostring(v), raw = v })
		end
		page.tabs.env.grid:setValues(t)
		page.tabs.env.grid.orig = Util.shallowCopy(t)

		debugLine = data.info.currentline
		debugFile = data.info.source:match('@?(.*)')

		-- source tab
		page:openFile(debugFile, debugLine)

		-- stack
		page.tabs.stack.grid:setValues(data.stack)

		page:draw()
		page:sync()
	end
end)

UI:setPage(page)
UI:start()

message('d')