cartographer.lua

--- Tiled map loading and drawing library for LÖVE.
local cartographer = {
	_VERSION = 'Cartographer v2.2',
	_DESCRIPTION = 'Simple Tiled map loading for LÖVE.',
	_URL = 'https://github.com/tesselode/cartographer',
	_LICENSE = [[
		MIT License

		Copyright (c) 2020 Andrew Minnich

		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.
	]]
}

-- gets the error level needed to make an error appear
-- in the user's code, not the library code
local function getUserErrorLevel()
	local source = debug.getinfo(1).source
	local level = 1
	while debug.getinfo(level).source == source do
		level = level + 1
	end
	--[[
		we return level - 1 here and not just level
		because the level was calculated one function
		deeper than the function that will actually
		use this value. if we produced an error *inside*
		this function, level would be correct, but
		for the function calling this function, level - 1
		is correct.
	]]
	return level - 1
end

-- gets the name of the function that the user called
-- that eventually caused an error
local function getUserCalledFunctionName()
	return debug.getinfo(getUserErrorLevel() - 1).name
end

local function checkCondition(condition, message)
	if condition then return end
	error(message, getUserErrorLevel())
end

-- changes a list of types into a human-readable phrase
-- i.e. string, table, number -> "string, table, or number"
local function getAllowedTypesText(...)
	local numberOfArguments = select('#', ...)
	if numberOfArguments >= 3 then
		local text = ''
		for i = 1, numberOfArguments - 1 do
			text = text .. string.format('%s, ', select(i, ...))
		end
		text = text .. string.format('or %s', select(numberOfArguments, ...))
		return text
	elseif numberOfArguments == 2 then
		return string.format('%s or %s', select(1, ...), select(2, ...))
	end
	return select(1, ...)
end

-- makes sure all of the given arguments are non-nil
local function checkArgumentsExist(...)
	for i = 1, select('#', ...) do
		if select(i, ...) == nil then
			error(
				string.format(
					"wrong number of arguments to '%s'",
					getUserCalledFunctionName()
				),
				getUserErrorLevel()
			)
		end
	end
end

-- checks if an argument is of the correct type, and if not,
-- throws a "bad argument" error consistent with the ones
-- lua and love produce
local function checkArgument(argumentIndex, argument, ...)
	for i = 1, select('#', ...) do
		if type(argument) == select(i, ...) then return end
	end
	error(
		string.format(
			"bad argument #%i to '%s' (expected %s, got %s)",
			argumentIndex,
			getUserCalledFunctionName(),
			getAllowedTypesText(...),
			type(argument)
		),
		getUserErrorLevel()
	)
end

-- splits a path into directory, file (with filename), and just filename
-- i really only need the directory
-- https://stackoverflow.com/a/12191225
local function splitPath(path)
    return string.match(path, '(.-)([^\\/]-%.?([^%.\\/]*))$')
end

-- joins two paths together into a reasonable path that Lua can use.
-- handles going up a directory using ..
-- https://github.com/karai17/Simple-Tiled-Implementation/blob/master/sti/utils.lua#L5
local function formatPath(path)
	local npGen1, npGen2 = '[^SEP]+SEP%.%.SEP?', 'SEP+%.?SEP'
	local npPat1, npPat2 = npGen1:gsub('SEP', '/'), npGen2:gsub('SEP', '/')
	local k
	repeat path, k = path:gsub(npPat2, '/') until k == 0
	repeat path, k = path:gsub(npPat1, '') until k == 0
	if path == '' then path = '.' end
	return path
end

--[[
	Interprets a series of bytes as a series of unsigned 32-bit integers,
	and returns a table containing the integers
	https://github.com/karai17/Simple-Tiled-Implementation/blob/master/sti/utils.lua#L67
]]
local function bytesToIntegerList(bytes)
	local ffi = require 'ffi'
	local integers = {}
	local casted = ffi.cast('uint32_t*', bytes)
	for i = 0, (bytes:len() / ffi.sizeof('uint32_t')) - 1 do
		table.insert(integers, tonumber(casted[i]))
	end
	return integers
end

--[[
	Decodes (and optionally decompresses) data for a tile layer.
	Follows the process outlined in the Tiled docs here:
	https://doc.mapeditor.org/en/stable/reference/tmx-map-format/#data
]]
local function decodeTileData(encoded, compressionFormat)
	local data = love.data.decode('string', 'base64', encoded)
	checkCondition(compressionFormat ~= 'zstd', 'Zstandard is not a supported compression type')
	if compressionFormat == 'gzip' then
		data = love.data.decompress('string', 'gzip', data)
	elseif compressionFormat == 'zlib' then
		data = love.data.decompress('string', 'zlib', data)
	end
	return bytesToIntegerList(data)
end

-- given a grid with w items per row, return the column and row of the nth item
-- (going from left to right, top to bottom)
-- https://stackoverflow.com/a/9816217
local function indexToCoordinates(n, w)
	return (n - 1) % w, math.floor((n - 1) / w)
end

local function coordinatesToIndex(x, y, w)
	return x + w * y + 1
end

local getByNameMetatable = {
	__index = function(self, key)
		for _, item in ipairs(self) do
			if item.name == key then return item end
		end
		return rawget(self, key)
	end,
}

local function getLayer(self, ...)
	local numberOfArguments = select('#', ...)
	checkCondition(numberOfArguments > 0, 'must specify at least one layer name')
	for i = 1, numberOfArguments do
		local argument = select(i, ...)
		checkArgument(i, argument, 'string')
	end
	local layer
	local layerName = select(1, ...)
	if not self.layers[layerName] then return end
	layer = self.layers[layerName]
	for i = 2, numberOfArguments do
		layerName = select(i, ...)
		if not (layer.layers and layer.layers[layerName]) then return end
		layer = layer.layers[layerName]
	end
	return layer
end

--- The base class for all layers.
-- @type Layer
local Layer = {}

-- A common class for all layer types.
Layer.base = {}
Layer.base.__index = Layer.base

function Layer.base:_init(map)
	self._map = map
end

--- Converts grid coordinates to pixel coordinates for this layer.
-- @number x the column to get the pixel coordinates of
-- @number y the row to get the pixel coordinates of
-- @return the horizontal position of the grid cell in pixels
-- @return the vertical position of the grid cell in pixels
function Layer.base:gridToPixel(x, y)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	x, y = x * self._map.tilewidth, y * self._map.tileheight
	x, y = x + self.offsetx, y + self.offsety
	return x, y
end

--- Converts pixel coordinates for this layer to grid coordinates.
-- @number x the horizontal position to get the grid cell at
-- @number y the vertical position to get the grid cell at
-- @return the column of the grid cell
-- @return the row of the grid cell
function Layer.base:pixelToGrid(x, y)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	x, y = x - self.offsetx, y - self.offsety
	x, y = x / self._map.tilewidth, y / self._map.tileheight
	x, y = math.floor(x), math.floor(y)
	return x, y
end

--- Parent class for tile layers and object layers.
-- @type SpriteLayer
Layer.spritelayer = setmetatable({}, Layer.base)
Layer.spritelayer.__index = Layer.spritelayer

function Layer.spritelayer:_initAnimations()
	self._animations = {}
	for _, tileset in ipairs(self._map.tilesets) do
		for _, tile in ipairs(tileset.tiles) do
			if tile.animation then
				local gid = tileset.firstgid + tile.id
				self._animations[gid] = {
					tileset = tileset,
					frames = tile.animation,
					currentFrame = 1,
					timer = tile.animation[1].duration,
				}
			end
		end
	end
end

function Layer.spritelayer:_createSpriteBatches()
	self._spriteBatches = {}
	for _, tileset in ipairs(self._map.tilesets) do
		if tileset.image then
			local image = self._map._images[tileset.image]
			self._spriteBatches[tileset] = love.graphics.newSpriteBatch(image)
		end
	end
end

--[[
	About sprites
	-------------
	In Tiled, both tile layers and object layers can display tiles.
	Since this behavior is similar for both layer types, I encapsulated
	them in a parent type called a "sprite layer".

	In this case, a "sprite" is just an occurrence of a tile in the map.
	Each sprite has a tile global ID, an x position, and a y position.

	Tiled has two kinds of tilesets: single-image tilesets and image
	collection tilesets. In single-image tilesets, each tile is a rectangular
	piece of a single image. In image collection tilesets, each tile is the
	entirety of a separate image.

	For single-image tilesets, it makes sense to use sprite batches to draw
	each tile that belongs to the same image. For image collection tilesets,
	it does not. Therefore, sprites can either be batched or unbatched.
	Batched sprites have two additional fields:
	- spriteBatch - the sprite batch that the sprite belongs to
	- id - the ID of the sprite in the sprite batch (sorry for the confusing
	terminology)

	The setTile function adds, changes, and removes sprites as needed, and it
	adds and removes sprites from sprite batches automatically (depending
	on whether the sprite's tile belongs to a single-image or image collection
	tileset).

	A sprite layer draws all of its sprite batches first, and then it
	manually draws each unbatched sprite.

	How sprites are stored
	======================
	Each sprite has the following fields:
	- tileGid (number)
	- x (number)
	- y (number)
	- spriteBatch (spriteBatch or nil)
	- id (number or nil)

	Normally, I'd represent a list of sprites like this:

	sprites = {
		{
			tileGid = tileGid,
			x = x,
			...
		},
		{
			tileGid = tileGid,
			x = x,
			...
		},
		...
	}

	However, since large maps have a lot of sprites, all of these
	tables use a lot of memory. So instead, since I know that every
	sprite has the same fields, I organize them like this:

	sprites = {
		exists = {sprite1Exists, sprite2Exists, ...},
		tileGid = {sprite1TileGid, sprite2TileGid, ...},
		x = {sprite1X, sprite2X, ...},
		...
	}

	It's a little awkward to work with, but it means that I only ever
	have 7 tables total dedicated to sprites for any given item layer.

	The biggest concern is that you have to insert and remove from all of the
	tables at the same time, otherwise the data for each sprite will get
	misaligned. To keep Lua's table functions working smoothly, I set
	spriteBatch and id to false instead of nil when I want to "remove" them;
	that way I don't make holes in the tables.

	Note: the exists field isn't really necessary, but I'd feel weird using
	the x/y/tileGid fields as indicators that a sprite exists.
]]

function Layer.spritelayer:_setSprite(x, y, gid)
	-- if the gid is 0 (empty), remove the sprite at (x, y)
	-- (if it exists)
	if gid == 0 then
		for i = #self._sprites.exists, 1, -1 do
			if self._sprites.x[i] == x and self._sprites.y[i] == y then
				if self._sprites.spriteBatch[i] then
					self._sprites.spriteBatch[i]:set(self._sprites.id[i], 0, 0, 0, 0, 0)
				end
				table.remove(self._sprites.exists, i)
				table.remove(self._sprites.tileGid, i)
				table.remove(self._sprites.x, i)
				table.remove(self._sprites.y, i)
				table.remove(self._sprites.spriteBatch, i)
				table.remove(self._sprites.id, i)
				break
			end
		end
		return
	end
	local index
	-- check if a sprite already exists at (x, y)
	for i = 1, #self._sprites.exists do
		if self._sprites.x[i] == x and self._sprites.y[i] == y then
			index = i
			break
		end
	end
	-- if the sprite doesn't exist, create a new one and add it to the sprite batch
	if not index then
		table.insert(self._sprites.exists, true)
		table.insert(self._sprites.tileGid, gid)
		table.insert(self._sprites.x, x)
		table.insert(self._sprites.y, y)
		table.insert(self._sprites.spriteBatch, false)
		table.insert(self._sprites.id, false)
		index = #self._sprites.exists
	end
	-- update the sprite's tile GID
	self._sprites.tileGid[index] = gid
	local tileset = self._map:getTileset(gid)
	-- if the sprite should be batched...
	if tileset.image then
		-- get the new quad
		local animation = self._animations[gid]
		local quad = self._map:_getTileQuad(gid, animation and animation.currentFrame)
		-- if the sprite isn't batched, add it to the sprite batch
		if not self._sprites.spriteBatch[index] then
			self._sprites.spriteBatch[index] = self._spriteBatches[tileset]
			self._sprites.id[index] = self._spriteBatches[tileset]:add(quad, x, y)
		-- otherwise, just update the sprite batch
		else
			self._sprites.spriteBatch[index]:set(self._sprites.id[index], quad, x, y)
		end
	-- otherwise...
	else
		-- if the sprite is batched, remove it from the sprite batch
		if self._sprites.spriteBatch[index] then
			self._sprites.spriteBatch[index]:set(self._sprites.id[index], 0, 0, 0, 0, 0)
			self._sprites.spriteBatch[index] = false
			self._sprites.id[index] = false
		end
	end
end

function Layer.spritelayer:_init(map)
	Layer.base._init(self, map)
	self:_initAnimations()
	self:_createSpriteBatches()
	self._sprites = {
		exists = {},
		tileGid = {},
		x = {},
		y = {},
		spriteBatch = {},
		id = {},
	}
end

function Layer.spritelayer:_updateAnimations(dt)
	for gid, animation in pairs(self._animations) do
		-- decrement the animation timer
		animation.timer = animation.timer - 1000 * dt
		while animation.timer <= 0 do
			-- move to the next frame of animation
			animation.currentFrame = animation.currentFrame + 1
			if animation.currentFrame > #animation.frames then
				animation.currentFrame = 1
			end
			-- increment the animation timer by the duration of the new frame
			animation.timer = animation.timer + animation.frames[animation.currentFrame].duration
			-- update sprites
			local tileset = self._map:getTileset(gid)
			if tileset.image then
				local quad = self._map:_getTileQuad(gid, animation.currentFrame)
				for i = 1, #self._sprites.exists do
					if self._sprites.tileGid[i] == gid then
						self._sprites.spriteBatch[i]:set(self._sprites.id[i], quad, self._sprites.x[i], self._sprites.y[i])
					end
				end
			end
		end
	end
end

--- Updates animations on the layer.
-- @number dt the time elapsed since the last frame (in seconds)
function Layer.spritelayer:update(dt)
	checkArgument(1, dt, 'number')
	self:_updateAnimations(dt)
end

--- Draws the layer.
function Layer.spritelayer:draw()
	love.graphics.push()
	love.graphics.translate(self.offsetx, self.offsety)
	-- draw the sprite batches
	for _, spriteBatch in pairs(self._spriteBatches) do
		love.graphics.draw(spriteBatch)
	end
	-- draw the unbatched sprites
	for i = 1, #self._sprites.exists do
		if not self._sprites.spriteBatch[i] then
			local animation = self._animations[self._sprites.tileGid[i]]
			local image = self._map:_getTileImage(self._sprites.tileGid[i], animation and animation.currentFrame)
			love.graphics.draw(image, self._sprites.x[i], self._sprites.y[i])
		end
	end
	love.graphics.pop()
end

--- A layer that contains tiles placed on a grid.
--
-- Inherits from @{SpriteLayer}.
-- @type TileLayer
Layer.tilelayer = setmetatable({}, Layer.spritelayer)
Layer.tilelayer.__index = Layer.tilelayer

function Layer.tilelayer:_decodeData()
	if self.encoding ~= 'base64' then return end
	checkCondition(require 'ffi', 'Compressed maps require LuaJIT\'s FFI library. Switch '
		.. ' your interperator to LuaJIT or your tile layer format to \"CSV\".')
	if self.chunks then
		for _, chunk in ipairs(self.chunks) do
			if chunk.data then
				chunk.data = decodeTileData(chunk.data, self.compression)
			end
		end
	else
		self.data = decodeTileData(self.data, self.compression)
	end
end

function Layer.tilelayer:_init(map)
	Layer.spritelayer._init(self, map)
	self:_decodeData()
	for _, gid, _, _, pixelX, pixelY in self:getTiles() do
		self:_setSprite(pixelX, pixelY, gid)
	end
end

--- Gets the bounds of the layer (in tiles).
-- @return the left bound of the layer
-- @return the top bound of the layer
-- @return the right bound of the layer
-- @return the bottom bound of the layer
function Layer.tilelayer:getGridBounds()
	if self.chunks then
		local left, top, right, bottom
		for _, chunk in ipairs(self.chunks) do
			local chunkLeft = chunk.x
			local chunkTop = chunk.y
			local chunkRight = chunk.x + chunk.width - 1
			local chunkBottom = chunk.y + chunk.height - 1
			if not left or chunkLeft < left then left = chunkLeft end
			if not top or chunkTop < top then top = chunkTop end
			if not right or chunkRight > right then right = chunkRight end
			if not bottom or chunkBottom > bottom then bottom = chunkBottom end
		end
		return left, top, right, bottom
	end
	return self.x, self.y, self.x + self.width - 1, self.y + self.height - 1
end

--- Gets the bounds of the layer (in pixels).
-- @return the left bound of the layer
-- @return the top bound of the layer
-- @return the right bound of the layer
-- @return the bottom bound of the layer
function Layer.tilelayer:getPixelBounds()
	local left, top, right, bottom = self:getGridBounds()
	left, top = self:gridToPixel(left, top)
	right, bottom = self:gridToPixel(right + 1, bottom + 1)
	return left, top, right, bottom
end

--- Gets the tile at the given grid position.
-- @number x the column to get the tile at
-- @number y the row to get the tile at
-- @return the global ID of the tile at the given grid position,
-- or false if the tile is empty
function Layer.tilelayer:getTileAtGridPosition(x, y)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	local gid
	if self.chunks then
		for _, chunk in ipairs(self.chunks) do
			local pointInChunk = x >= chunk.x
							 and x < chunk.x + chunk.width
							 and y >= chunk.y
							 and y < chunk.y + chunk.height
			if pointInChunk then
				gid = chunk.data[coordinatesToIndex(x - chunk.x, y - chunk.y, chunk.width)]
			end
		end
	else
		gid = self.data[coordinatesToIndex(x, y, self.width)]
	end
	if gid == 0 then return false end
	return gid
end

--- Sets the tile at the given grid position.
-- @number x the column to set the tile at
-- @number y the row to set the tile at
-- @number gid the global ID to set the tile to
function Layer.tilelayer:setTileAtGridPosition(x, y, gid)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	checkArgument(3, gid, 'number')
	if self.chunks then
		for _, chunk in ipairs(self.chunks) do
			local pointInChunk = x >= chunk.x
							 and x < chunk.x + chunk.width
							 and y >= chunk.y
							 and y < chunk.y + chunk.height
			if pointInChunk then
				local index = coordinatesToIndex(x - chunk.x, y - chunk.y, chunk.width)
				chunk.data[index] = gid
			end
		end
	else
		self.data[coordinatesToIndex(x, y, self.width)] = gid
	end
	local pixelX, pixelY = self:gridToPixel(x, y)
	self:_setSprite(pixelX, pixelY, gid)
end

--- Gets the tile at the given pixel position.
-- @number x the horizontal position to get the tile at
-- @number y the vertical position to get the tile at
-- @return the global ID of the tile at the given pixel position,
-- or false if the tile is empty
function Layer.tilelayer:getTileAtPixelPosition(x, y)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	return self:getTileAtGridPosition(self:pixelToGrid(x, y))
end

--- Sets the tile at the given pixel position.
-- @number x the horizontal position to set the tile at
-- @number y the vertical position to set the tile at
-- @number gid the global ID to set the tile to
function Layer.tilelayer:setTileAtPixelPosition(x, y, gid)
	checkArgument(1, x, 'number')
	checkArgument(2, y, 'number')
	checkArgument(3, gid, 'number')
	local gridX, gridY = self:pixelToGrid(x, y)
	return self:setTileAtGridPosition(gridX, gridY, gid)
end

function Layer.tilelayer:_getTileAtIndex(index)
	-- for infinite maps, treat all the chunk data like one big array
	if self.chunks then
		for _, chunk in ipairs(self.chunks) do
			if index <= #chunk.data then
				local gid = chunk.data[index]
				local gridX, gridY = indexToCoordinates(index, chunk.width)
				gridX, gridY = gridX + chunk.x, gridY + chunk.y
				local pixelX, pixelY = self:gridToPixel(gridX, gridY)
				return gid, gridX, gridY, pixelX, pixelY
			else
				index = index - #chunk.data
			end
		end
	elseif self.data[index] then
		local gid = self.data[index]
		local gridX, gridY = indexToCoordinates(index, self.width)
		local pixelX, pixelY = self:gridToPixel(gridX, gridY)
		return gid, gridX, gridY, pixelX, pixelY
	end
end

function Layer.tilelayer:_tileIterator(i)
	while true do
		i = i + 1
		local gid, gridX, gridY, pixelX, pixelY = self:_getTileAtIndex(i)
		if not gid then break end
		if gid ~= 0 then return i, gid, gridX, gridY, pixelX, pixelY end
	end
end

--- Returns an iterator over all the tiles in this layer.
-- @return an iterator that returns that following values:
--
-- - the index of the tile
-- - the global ID of the tile
-- - the x position of the tile (in grid cells)
-- - the y position of the tile (in grid cells)
-- - the x position of the tile (in pixels)
-- - the y position of the tile (in pixels)
function Layer.tilelayer:getTiles()
	return self._tileIterator, self, 0
end

--- A layer that contains objects.
--
-- Inherits from @{SpriteLayer}.
-- @type ObjectGroup
Layer.objectgroup = setmetatable({}, Layer.spritelayer)
Layer.objectgroup.__index = Layer.objectgroup

function Layer.objectgroup:_init(map)
	Layer.spritelayer._init(self, map)
	for _, object in ipairs(self.objects) do
		if object.gid and object.visible then
			self:_setSprite(object.x, object.y - object.height, object.gid)
		end
	end
end

--- A layer that displays a single image.
-- @type ImageLayer
Layer.imagelayer = setmetatable({}, Layer.base)
Layer.imagelayer.__index = Layer.imagelayer

--- Draws the layer.
function Layer.imagelayer:draw()
	love.graphics.draw(self._map._images[self.image], self.offsetx, self.offsety)
end

--- A layer that contains other layers.
-- @type Group
Layer.group = setmetatable({}, Layer.base)
Layer.group.__index = Layer.group

function Layer.group:_init(map)
	Layer.base._init(self, map)
	for _, layer in ipairs(self.layers) do
		setmetatable(layer, Layer[layer.type])
		layer:_init(map)
	end
	setmetatable(self.layers, getByNameMetatable)
end

--- Gets a child layer by name.
--
-- Can get nested layers.
-- @string ... the name(s) of the layers to get
-- @return the @{Layer}, if it exists
function Layer.group:getLayer(...)
	return getLayer(self, ...)
end

--- Updates animations in all child layers.
-- @number dt the elapsed time since the last frame (in seconds)
function Layer.group:update(dt)
	checkArgument(1, dt, 'number')
	for _, layer in ipairs(self.layers) do
		if layer.update then layer:update(dt) end
	end
end

--- Draws the layer.
function Layer.group:draw()
	for _, layer in ipairs(self.layers) do
		if layer.visible and layer.draw then layer:draw() end
	end
end

--- A tiled map.
-- @type Map
local Map = {}
Map.__index = Map

-- Loads an image if it hasn't already been loaded yet.
-- Images are stored in map._images, and the key is the relative
-- path to the image.
function Map:_loadImage(relativeImagePath)
	if self._images[relativeImagePath] then return end
	local imagePath = formatPath(self.dir .. relativeImagePath)
	self._images[relativeImagePath] = love.graphics.newImage(imagePath)
end

-- Loads all of the images used by the map.
function Map:_loadImages()
	self._images = {}
	for _, tileset in ipairs(self.tilesets) do
		if tileset.image then self:_loadImage(tileset.image) end
		for _, tile in ipairs(tileset.tiles) do
			if tile.image then self:_loadImage(tile.image) end
		end
	end
	for _, layer in ipairs(self.layers) do
		if layer.type == 'imagelayer' then
			self:_loadImage(layer.image)
		end
	end
end

function Map:_initLayers()
	for _, layer in ipairs(self.layers) do
		setmetatable(layer, Layer[layer.type])
		layer:_init(self)
	end
	setmetatable(self.layers, getByNameMetatable)
end

function Map:_init(path)
	self.dir = splitPath(path)
	self:_loadImages()
	setmetatable(self.tilesets, getByNameMetatable)
	self:_initLayers()
end

-- Gets the quad of the tile with the given global ID.
-- Returns false if the tileset is an image collection.
function Map:_getTileQuad(gid, frame)
	frame = frame or 1
	local tileset = self:getTileset(gid)
	if not tileset.image then return false end
	local id = gid - tileset.firstgid
	local tile = self:getTile(gid)
	if tile and tile.animation then
		id = tile.animation[frame].tileid
	end
	local image = self._images[tileset.image]
	local x, y = indexToCoordinates(id + 1, tileset.columns)
	return love.graphics.newQuad(
		tileset.margin + (x * (tileset.tilewidth + tileset.spacing)),
		tileset.margin + (y * (tileset.tileheight + tileset.spacing)),
		tileset.tilewidth, tileset.tileheight,
		image:getWidth(), image:getHeight()
	)
end

-- Gets the quad of the tile with the given global ID.
-- Returns false if the tileset uses a single image.
function Map:_getTileImage(gid, frame)
	frame = frame or 1
	local tileset = self:getTileset(gid)
	if tileset.image then return false end
	local tile = self:getTile(gid)
	if tile and tile.animation then
		tile = self:getTile(tileset.firstgid + tile.animation[frame].tileid)
	end
	return self._images[tile.image]
end

--- Gets the tileset that has the tile with the given global ID.
-- @number gid the global ID of the tile
-- @return the tileset that contains the tile, if it exists
function Map:getTileset(gid)
	checkArgument(1, gid, 'number')
	for i = #self.tilesets, 1, -1 do
		local tileset = self.tilesets[i]
		if tileset.firstgid <= gid then
			return tileset
		end
	end
end

--- Gets a tile with the given global ID.
-- @number gid the global ID of the tile
-- @return the data table for the tile with the given global ID, if it exists
function Map:getTile(gid)
	checkArgument(1, gid, 'number')
	local tileset = self:getTileset(gid)
	for _, tile in ipairs(tileset.tiles) do
		if tileset.firstgid + tile.id == gid then
			return tile
		end
	end
end

--- Gets the type of a tile.
-- @number gid the global ID of the tile
-- @return the type of the tile with the given global ID, if it exists
function Map:getTileType(gid)
	checkArgument(1, gid, 'number')
	local tile = self:getTile(gid)
	if not tile then return end
	return tile.type
end

--- Gets the value of a property of a tile.
-- @number gid the global ID of the tile
-- @string propertyName the name of the property
-- @return the value of the property, if it exists
function Map:getTileProperty(gid, propertyName)
	checkArgument(1, gid, 'number')
	checkArgument(2, propertyName, 'string')
	local tile = self:getTile(gid)
	if not tile then return end
	if not tile.properties then return end
	return tile.properties[propertyName]
end

--- Sets the value of a tile property.
-- @number gid the global ID of the tile
-- @string propertyName the name of the property
-- @param propertyValue the value to set the property to
function Map:setTileProperty(gid, propertyName, propertyValue)
	checkArgumentsExist(gid, propertyName, propertyValue)
	checkArgument(1, gid, 'number')
	checkArgument(2, propertyName, 'string')
	local tile = self:getTile(gid)
	if not tile then
		local tileset = self:getTileset(gid)
		tile = {id = gid - tileset.firstgid}
		table.insert(tileset.tiles, tile)
	end
	tile.properties = tile.properties or {}
	tile.properties[propertyName] = propertyValue
end

--- Gets a layer by name.
--
-- Can get nested layers.
-- @string ... the name(s) of the layers to get
-- @return the @{Layer}, if it exists
function Map:getLayer(...)
	return getLayer(self, ...)
end

--- Updates all animations in the map.
-- @number dt the elapsed time since the last frame
function Map:update(dt)
	checkArgument(1, dt, 'number')
	for _, layer in ipairs(self.layers) do
		if layer.update then layer:update(dt) end
	end
end

--- Draws the solid color background of the map.
function Map:drawBackground()
	if self.backgroundcolor then
		love.graphics.push 'all'
		local r = self.backgroundcolor[1] / 255
		local g = self.backgroundcolor[2] / 255
		local b = self.backgroundcolor[3] / 255
		love.graphics.setColor(r, g, b)
		love.graphics.rectangle('fill', 0, 0,
			self.width * self.tilewidth,
			self.height * self.tileheight)
		love.graphics.pop()
	end
end

--- Draws the map.
function Map:draw()
	self:drawBackground()
	for _, layer in ipairs(self.layers) do
		if layer.visible and layer.draw then layer:draw() end
	end
end

--- @section end

--- Loads a Tiled map from an exported Lua file.
-- @string path the path to the Lua file
-- @return the loaded @{Map}
function cartographer.load(path)
	checkArgument(1, path, 'string')
	local map = setmetatable(love.filesystem.load(path)(), Map)
	map:_init(path)
	return map
end

return cartographer