DEBUG.lua

--- Debug options and helper utilities.

--
-- Permission is hereby granted, free of charge, to any person obtaining
-- a copy of this software and associated documentation files (the
-- "Software"), to deal in the Software without restriction, including
-- without limitation the rights to use, copy, modify, merge, publish,
-- distribute, sublicense, and/or sell copies of the Software, and to
-- permit persons to whom the Software is furnished to do so, subject to
-- the following conditions:
--
-- The above copyright notice and this permission notice shall be
-- included in all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--
-- [ MIT license: http://www.opensource.org/licenses/mit-license.php ]
--

-- Modules --
local args = require("iterator_ops.args")
local array_index = require("tektite_core.array.index")
local button = require("corona_ui.widgets.button")
local checkbox = require("corona_ui.widgets.checkbox")
local game_loop = require("corona_boilerplate.game.loop")
local markers = require("s3_utils.effect.markers")
local movement = require("s3_utils.movement")
local tile_maps = require("s3_utils.tile_maps")

-- Corona globals --
local display = display

-- Corona modules --
local physics = require("physics")

--[[
	if Version == "Final" then
		return false
	end
]]

-- --
local Options = { "NONE", "PHYSICS", "GRID", "TILE_FLAGS" }

-- --
local Index = 1

-- --
local ButtonsToAdd = {}

-- --
local GameGroup, DebugLayer

--
local function AddDebugLayer ()
	DebugLayer = display.newGroup()

	GameGroup:insert(DebugLayer)
end

--
local Colors = {
	down = { 0, 0, 1 },
	left = { 1, 0, 1 },
	right = { 0, 1, 0 },
	up = { 1, 0, 0 }
}

--
local function SetDirections (keep)
	if Options[Index] == "TILE_FLAGS" then
		if keep ~= true and DebugLayer then -- keep = true, otherwise an event
			DebugLayer:removeSelf()

			AddDebugLayer()
		end

		local ncols, nrows = tile_maps.GetCounts()

		for tile = 1, ncols * nrows do
			local x, y = tile_maps.GetTilePos(tile)

			for dir in movement.Ways(tile) do
				local arrow = markers.StraightArrow(DebugLayer, dir, x, y, 3)

				arrow:setStrokeColor(unpack(Colors[dir]))
			end
		end
	end
end

-- Listen to events.
for _, name, event in args.ArgsByN(2,
	-- Flags Updated --
	"flags_updated", SetDirections,

	-- Leave Level --
	"leave_level", function()
		local choice = Options[Index]

		if choice ~= "NONE" then
			physics.setDrawMode("normal")
		end

		DebugLayer, GameGroup = nil
	end,

	-- Reset Level --
	"reset_level", SetDirections,

	-- Things Loaded --
	"things_loaded", function(level)
		GameGroup = level.game_group

		local y = 20

		for _, key, func in args.ArgsByN(2,
	--		"KillP", player.Kill,
			"Win", function()
				game_loop.UnloadLevel("won")
			end
		) do
			if ButtonsToAdd[key] then
				button.Button_XY(level.hud_group, "from_right -220", y, 200, 50, func, key)

				y = y + 70
			end
		end

		local choice = Options[Index]

		if choice == "NONE" then
			return
		end

		physics.setDrawMode("hybrid")

		if choice ~= "PHYSICS" then
			AddDebugLayer()

			if choice == "GRID" then
				local w, h = level.ncols * level.w, level.nrows * level.h

				for col = 1, level.ncols do
					local line = display.newLine(DebugLayer, col * level.w, 0, col * level.w, h)

					line.width = 3
				end

				for row = 1, level.nrows do
					local line = display.newLine(DebugLayer, 0, row * level.h, w, row * level.h)

					line.width = 3
				end

			else
				SetDirections(true)
			end
		end
	end
) do
	Runtime:addEventListener(name, event)
end

--
return function(what, arg_)
	if what == "options" then -- arg_: data group
		local message
		local button = button.Button_XY(arg_, 120, 210, 200, 50, function()
			Index = array_index.RotateIndex(Index, #Options)

			message.text = Options[Index]
		end, "Debug...")

		message = display.newText(arg_, Options[Index], 400, button.y, native.systemFont, 50)

		for i, key, text in args.ArgsByN(2,
--			"KillP", "Add 'Kill player' button?",
			"Win", "Add 'Win' button?"
		) do
			local y = 230 + i * 50

			local cb = checkbox.Checkbox_XY(arg_, 40, y, 30, 30, function(_, check)
				ButtonsToAdd[key] = check
			end)

			local str = display.newText(arg_, text, 0, y, native.systemFont, 20)

			str.anchorX, str.x = 0, cb.x + cb.width + 10

			cb:Check(ButtonsToAdd[key])
		end
	end
end