monolified-atl/xml.lua

-- MIT License
-- 
-- Copyright (c) 2019 monolifed
-- 
-- 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.

local table_concat = table.concat
local table_sort   = table.sort
local table_insert = table.insert
local table_remove = table.remove

local string_format = string.format
local string_sub    = string.sub
local string_gsub   = string.gsub
local string_find   = string.find
local string_gmatch = string.gmatch

local escaped = {
	['''] = [[']],
	['"'] = [["]],
	['&' ] = [[&]],
	['>'  ] = [[>]],
	['&lt;'  ] = [[<]],
}

-- (table) from attribute string ------------------
local re_attr = [[(%w+)=(["'])(.-)%2]]

local fromstring = function(s)
	local t = {}
	for k, _, v in string_gmatch(s, re_attr) do
		for e, c in pairs(escaped) do v = string_gsub(v, e, c) end
		t[k] = v
	end
	return t
end

-- (attribute string) from  table --
local fromtable = function(t)
	if not t then return "" end
	local s, sn = {}, 1
	for k, v in pairs(t) do
		v = tostring(v)
		for e, c in pairs(escaped) do v = string_gsub(v, c, e) end
		s[sn] = string_format(' %s="%s"', k, v); sn = sn + 1
	end
	table_sort(s)
	return table_concat(s)
end


-- XML string to DOM formatted table --
local re_tag = "<(/?)([%w:]+)(.-)(/?)>" -- ls, tag, attr, rs

local endtag_unexpected = "Unexpected end tag '%s'"
local endtag_mismatched = "Cannot close '%s' with '%s'"
local endtag_missing    = "Missing end tag for '%s'"

-- Based on classic Lua XML parser by Roberto Ierusalimschy
local parse = function(s)
	local stack = {}
	local top = {}
	table_insert(stack, top)
	
	local si, ei, ls, tag, attr, rs
	local i = 1
	local text
	while true do
		si, ei, ls, tag, attr, rs = string_find(s, re_tag, i)
		if not si then break end
		text = string_sub(s, i, si - 1)
		if string_find(text, "%S") then
			table_insert(top, text)
		end
		if rs == "/" then  -- self-closing tag
			table_insert(top, {_name = tag, _attr = fromstring(attr), empty = 1})
		elseif ls == "" then   -- start tag
			top = {_name = tag, _attr = fromstring(attr)}
			table_insert(stack, top)
		else  -- end tag
			local toclose = table_remove(stack)
			top = stack[#stack]
			if #stack < 1 then
				return nil, endtag_unexpected:format(tag)
			end
			if toclose._name ~= tag then
				return nil, endtag_mismatched:format(toclose._name, tag)
			end
			table_insert(top, toclose)
		end
		i = ei + 1
	end
	text = string_sub(s, i)
	if string_find(text, "%S") then
		table_insert(stack[#stack], text)
	end
	if #stack > 1 then
		return nil, endtag_missing:format(stack[#stack]._name)
	end
	return stack[1]
end

-- DOM formatted table to XML string --
local _toxml

_toxml = function(t, sub)
	if not sub then sub = {} end
	local tag = t._name
	local attr = fromtable(t._attr)
	if #t > 0 then
		sub[#sub + 1] = string_format("<%s%s>\n", tag, attr)
		for _, v in ipairs(t) do
			if type(v) == "table" then
				_toxml(v, sub)
			else
				sub[#sub + 1] = string.format("%s\n", v)
			end
		end
		sub[#sub + 1] = string_format("</%s>\n", tag)
	else
		sub[#sub + 1] = string_format("<%s%s/>\n", tag, attr)
	end
	
	return table_concat(sub)
end


return {
	parse = parse,
	toxml = function(t) return _toxml(t, {}) end
}