Added tool to make debugging sprites in bsnes-plus easier

bsnes-launch.lua

@@ -1,10 +0,0 @@
-local base = string.gsub(@@LUA_SCRIPT_FILENAME@@, "(.*[/\\])(.*)", "%1")
-local config = dofile(base.."/config.lua")
-
--- Breakpoint format: <addr>[-<addr end>][=<value>][:<rwx>[:<source>]]
---     rwx = read / write / execute flags
---     source = cpu, smp, vram, oam, cgram, sa1, sfx, sgb
-
---bsnes --show-debugger --break-immediately ~/neat-donk/rom.sfc
-
-io.popen('bsnes --show-debugger --break-immediately "'..config.ROM..'"')

bsnes-launcher.lua

@@ -0,0 +1,125 @@
+local base = string.gsub(@@LUA_SCRIPT_FILENAME@@, "(.*[/\\])(.*)", "%1")
+
+local util = dofile(base.."/util.lua")
+local config = dofile(base.."/config.lua")
+local mem = dofile(base.."/mem.lua")
+
+local function text(text)
+    io.stderr:write(text)
+    io.stderr:write('\n')
+    print(text)
+end
+
+local function help()
+    text([[
+Syntax: BSNES_LAUNCHER_ARGS='<arguments>' lsnes --lua=]]..base..[[/bsnes-launcher.lua
+
+Sprite breakpoint arguments:
+These will create breakpoints for all sprite slots with properties matching the
+given pattern.
+]])
+    for propName,_ in pairs(mem.offset.sprite) do
+        text('--sprite-'..propName..'<Breakpoint format>')
+    end
+
+text([[
+
+Breakpoint format: --<switchname>[=<value>][:<rwx>]
+    rwx = read / write / execute flags
+
+For example, --sprite-x:r would match any reads of any sprite X position
+--sprite-x>10:w would match any writes of any sprite X position greater 
+than 0x10 (16). Omitting the rwx will create the breakpoints with the values
+specified but they will not trigger until you enable them manually.
+]])
+end
+
+local bps = {}
+
+--- Add breakpoint switch
+---@param switchName string The name of the switch, without dashes
+---@param source string address space
+---@param startAddress integer The start address
+---@param arg string The argument to test
+---@param valWidth integer byte size of value - defaults to 2
+---@param addrWidth integer byte size of address - defaults to 3
+local function bpSwitch(switchName, source, startAddress, arg, valWidth, addrWidth)
+    if addrWidth == nil then
+        addrWidth = 3
+    end
+    if valWidth == nil then
+        valWidth = 2
+    end
+    if arg:sub(1, #switchName+2) == '--'..switchName then
+        local op, valHex, rwx = arg:sub(#switchName+3):match('([><=]*)([0-9a-fA-F]*):?([rwxRWX]*)$')
+        local valPad = ''
+        if valHex ~= '' then
+            local val = tonumber(valHex, 16)
+            valPad = string.format('%0'..(valWidth*2)..'x', val)
+        end
+        local fmt = '%0'..(addrWidth*2)..'x%s%s:%s:%s'
+        if valWidth == 2 then
+            -- SNES is LE!
+            local valLeast = valPad:sub(3, 4)
+            local valMost = valPad:sub(1, 2)
+            local opLeast = '='
+            local opMost = '='
+
+            -- FIXME This is surely wrong but better than nothing?
+            if op == '>' then
+                opLeast = '>'
+                opMost = '>='
+            elseif op == '<' then
+                opLeast = '<'
+                opMost = '<='
+            elseif op == '<=' then
+                opLeast = '<='
+                opMost = '<='
+            elseif op == '>=' then
+                opLeast = '>='
+                opMost = '>='
+            else
+                opLeast = ''
+                opMost = ''
+                valLeast = ''
+                valMost = ''
+            end
+            table.insert(bps, string.format(fmt, startAddress, opLeast, valLeast, rwx, source))
+            table.insert(bps, string.format(fmt, startAddress + 1, opMost, valMost, rwx, source))
+        elseif valWidth == 1 then
+            table.insert(bps, string.format(fmt, startAddress, op, valPad, rwx, source))
+        end
+    end
+end
+
+local count = 0
+for arg in os.getenv('BSNES_LAUNCHER_ARGS'):gmatch('[^ ]+') do
+    count = count + 1
+    for propName,offset in pairs(mem.offset.sprite) do
+        for i=0,22,1 do
+            local startAddress = mem.addr.spriteBase + mem.size.sprite * i + offset
+            bpSwitch('sprite-'..propName, 'cpu', startAddress, arg)
+        end
+    end
+end
+
+local bpArgs = ''
+if #bps > 0 then
+    bpArgs = '-b "'..table.concat(bps, '" -b "')..'" '
+end
+
+local cmd = 'bsnes '..bpArgs..'--show-debugger --break-immediately "'..config.ROM..'"'
+
+if count == 0 then
+    text('====================')
+    help()
+end
+
+text('====================')
+
+text('Note that you will need to turn off breakpoint saving for this app to work correctly.')
+text('')
+text(cmd)
+text('====================')
+
+util.doCmd(cmd)

state-test.lua

@@ -1,9 +1,5 @@
-local errtest = io.popen("farts", 'r')
-errtest:read("*a")
-print(errtest:close())
-errtest = io.popen("dir", 'r')
-errtest:read("*a")
-local ok, exit, code = errtest:close()
-print(ok)
-print(exit)
-print(code)
+local classes = _SYSTEM.all_classes()
+io.stderr:write(classes:gsub(classes:sub(8,1), '\n'))
+for k,v in pairs(_SYSTEM) do
+    print(k)
+end