GridUtils.lua

-- Misc functions

local media = LibStub("LibSharedMedia-3.0", true)
local L = LibStub:GetLibrary("AceLocale-3.0"):GetLocale("Grid2")
local Grid2 = Grid2
local select = select
local strtrim  = strtrim
local type = type
local pairs = pairs
local tonumber = tonumber
local tremove = table.remove

-- Dummy function
Grid2.Dummy = function() end

-- Fetch LibSharedMedia resources
function Grid2:MediaFetch(mediatype, key, def)
	return (key and media:Fetch(mediatype, key)) or (def and media:Fetch(mediatype, def))
end

-- Default Colors
do
	local defaultColors = {
		TRANSPARENT = {r=0,g=0,b=0,a=0},
		BLACK       = {r=0,g=0,b=0,a=1},
		WHITE       = {r=1,g=1,b=1,a=1},
	}
	function Grid2:MakeColor(color, default)
		return color or defaultColors[default or "TRANSPARENT"]
	end
	Grid2.defaultColors = defaultColors
end

-- Repeating Timer Management
do
	local frame = CreateFrame("Frame")
	local timers = {}
	local function SetDuration(self, duration)
		self.animation:SetDuration(duration)
	end
	-- Grid2:CreateTimer(func, duration, play)
	-- play=true|nil => timer running; play=false => timer paused
	-- timer methods: timer:Play() timer:Stop() timer:SetDuration()
	function Grid2:CreateTimer( func, duration, play )
		local timer = tremove(timers)
		if not timer then
			timer = frame:CreateAnimationGroup()
			timer.animation = timer:CreateAnimation()
			timer.SetDuration = SetDuration
			timer:SetLooping("REPEAT")
		end
		timer:SetScript("OnLoop", func)
		if duration then
			timer:SetDuration(duration)
			if play~=false then timer:Play() end
		end
		return timer
	end
	-- Grid2:CancelTimer(timer)
	function Grid2:CancelTimer( timer )
		if timer then
			timer:Stop()
			timers[#timers+1] = timer
		end
	end
end

-- hook helper functions
function Grid2:PreHookFunc(obj, funcName, hook)
	local prev = obj[funcName]
	obj[funcName] = function(...) prev(...); hook(...); end
end

function Grid2:PostHookFunc(obj, funcName, hook)
	local prev = obj[funcName]
	obj[funcName] = function(...) hook(...); prev(...); end
end

-- iterate over a list of values example: for value in Grid2.IterateValues(4,2,7,1) do
function Grid2.IterateValues(...)
  local i, t = 0, {...}
  return function() i = i + 1; return t[i] end
end

-- retrieve config value, falling back to default
function Grid2.GetSetupValue(condition, value, default)
	if condition and value~=nil then
		return value
	else
		return default
	end
end

-- UTF8 string truncate
do
	local strbyte = string.byte
	function Grid2.strcututf8(s, c)
		local l, i = #s, 1
		while c>0 and i<=l do
			local b = strbyte(s, i)
			if     b < 192 then	i = i + 1
			elseif b < 224 then i = i + 2
			elseif b < 240 then	i = i + 3
			else				i = i + 4
			end
			c = c - 1
		end
		return s:sub(1, i-1)
	end
end

-- Transliterate texts, cyrilic to latin conversion
do
	local gsub = string.gsub
	local Cyr2Lat = {
		["А"] = "A", ["а"] = "a", ["Б"] = "B", ["б"] = "b", ["В"] = "V", ["в"] = "v", ["Г"] = "G", ["г"] = "g", ["Д"] = "D", ["д"] = "d", ["Е"] = "E",
		["е"] = "e", ["Ё"] = "e", ["ё"] = "e", ["Ж"] = "Zh", ["ж"] = "zh", ["З"] = "Z", ["з"] = "z", ["И"] = "I", ["и"] = "i", ["Й"] = "Y", ["й"] = "y",
		["К"] = "K", ["к"] = "k", ["Л"] = "L", ["л"] = "l", ["М"] = "M", ["м"] = "m", ["Н"] = "N", ["н"] = "n", ["О"] = "O", ["о"] = "o", ["П"] = "P",
		["п"] = "p", ["Р"] = "R", ["р"] = "r", ["С"] = "S", ["с"] = "s", ["Т"] = "T", ["т"] = "t", ["У"] = "U", ["у"] = "u", ["Ф"] = "F", ["ф"] = "f",
		["Х"] = "Kh", ["х"] = "kh", ["Ц"] = "Ts", ["ц"] = "ts", ["Ч"] = "Ch", ["ч"] = "ch", ["Ш"] = "Sh", ["ш"] = "sh", ["Щ"] = "Shch",	["щ"] = "shch",
		["Ъ"] = "", ["ъ"] = "", ["Ы"] = "Y", ["ы"] = "y", ["Ь"] = "", ["ь"] = "", ["Э"] = "E", ["э"] = "e", ["Ю"] = "Yu", ["ю"] = "yu", ["Я"] = "Ya",
		["я"] = "ya"
	}
	function Grid2.strCyr2Lat(str)
		return gsub(str, "..", Cyr2Lat)
	end
end

-- Table Deep Copy used by GridDefaults.lua
function Grid2.CopyTable(src, dst)
	if type(dst)~="table" then dst = {} end
	for k,v in pairs(src) do
		if type(v)=="table" then
			dst[k] = Grid2.CopyTable(v,dst[k])
		elseif dst[k]==nil then
			dst[k] = v
		end
	end
	return dst
end

-- Remove item by value in a ipairs table
function Grid2.TableRemoveByValue(t,v)
	for i=#t,1,-1 do
		if t[i]==v then
			tremove(t, i)
			return
		end
	end
end

-- Creates a location table, used by GridDefaults.lua
function Grid2.CreateLocation(a,b,c,d)
    local p = a or "TOPLEFT"
	if type(b)=="string" then
		return { relPoint = p, point = b, x = c or 0, y = d or 0 }
	else
		return { relPoint = p, point = p, x = b or 0, y = c or 0 }
	end
end

-- Common methods repository for statuses
Grid2.statusLibrary = {
	IsActive = function()
		return true
	end,
	GetColor = function(self)
		local c = self.dbx.color1
		return c.r, c.g, c.b, c.a
	end,
	GetPercent = function(self)
		return self.dbx.color1.a
	end,
	UpdateAllUnits = function(self)
		for unit in Grid2:IterateRosterUnits() do
			self:UpdateIndicators(unit)
		end
	end,
	GetTexCoord = function()
		return 0.05, 0.95, 0.05, 0.95
	end,
	GetTexCoordZoomed = function()
		return 0.08, 0.92, 0.08, 0.92
	end,
}

-- Used by bar indicators
Grid2.AlignPoints= {
	HORIZONTAL = {
		[true]  = { "TOPLEFT", "TOPRIGHT", "BOTTOMLEFT", "BOTTOMRIGHT" },    -- normal Fill
		[false] = { "BOTTOMRIGHT",  "BOTTOMLEFT", "TOPRIGHT", "TOPLEFT"  },  -- reverse Fill
	},
	VERTICAL   = {
		[true]  = { "BOTTOMLEFT","TOPLEFT","BOTTOMRIGHT","TOPRIGHT" }, -- normal Fill
		[false] = { "TOPRIGHT", "BOTTOMRIGHT","TOPLEFT","BOTTOMLEFT" }, -- reverse Fill
	}
}

-- Create/Manage/Sets frame backdrops
do
	local format = string.format
	local tostring = tostring
	local backdrops = {}
	-- Generates a backdrop table, reuses tables avoiding to create duplicates
	function Grid2:GetBackdropTable(edgeFile, edgeSize, bgFile, tile, tileSize, inset)
		inset = inset or edgeSize
		local key = format("%s;%s;%d;%s;%d;%d", bgFile or "", edgeFile or "", edgeSize or -1, tostring(tile), tileSize or -1, inset or -1)
		local backdrop = backdrops[key]
		if not backdrop then
			backdrop = {
				bgFile = bgFile,
				tile = tile,
				tileSize = tileSize,
				edgeFile = edgeFile,
				edgeSize = edgeSize,
				insets = { left = inset, right = inset, top = inset, bottom = inset },
			}
			backdrops[key] = backdrop
		end
		return backdrop
	end
	-- Sets a backdrop only if necessary to alleviate game freezes, see ticket #640
	function Grid2:SetFrameBackdrop(frame, backdrop)
		if backdrop~=frame.currentBackdrop then
			frame:SetBackdrop(backdrop)
			frame.currentBackdrop = backdrop
		end
	end
end

-- Grid2:RunSecure(priority, object, method, arg)
-- Queue some methods to be executed when out of combat, if we are not in combat do nothing.
-- Methods with lower priority value override the execution of methods with higher priority value.
-- Methods executed (in order of priority):
-- ReloadProfile(1), ReloadTheme(2), ReloadLayout(3), ReloadFilter(4), FixRoster(5), UpdateFramesSizeByRaidSize(6), UpdateSize(7), UpdateVisibility(8)
do
	local sec_priority, sec_object, sec_method, sec_arg
	function Grid2:PLAYER_REGEN_ENABLED()
		if sec_priority then
			sec_priority = nil
			sec_object[sec_method](sec_object, sec_arg)
		end
	end
	function Grid2:RunSecure(priority, object, method, arg)
		if InCombatLockdown() then
			if not sec_priority or priority<sec_priority then
				sec_priority, sec_object, sec_method, sec_arg = priority, object, method, arg
			end
			return true
		end
	end
end

-- Grid2:RunThrottled(object or arg1, method or func, delay)
-- Delays and throttles the execution of a method or function
do
	local After = C_Timer.After
	local counts = {}
	function Grid2:RunThrottled(object, method, delay)
		local func  = object[method] or method
		local count = counts[func]
		counts[func] = (count or 0) + 1
		if not count then
			local callback
			callback = function()
				if counts[func]>0 then
					counts[func] = 0
					func(object)
					After(delay or 0.1, callback)
				else
					counts[func] = nil
				end
			end
			After(delay or 0.1, callback)
		end
	end
end

-- dispellable by player spells types tracking
do
	local IsPlayerSpell = IsPlayerSpell
	local class, dispel, func  = Grid2.playerClass, {}, Grid2.Dummy
	if Grid2.isCata then -- cataclysm
		if class == 'DRUID' then
			func = function()
				dispel.Magic  = IsPlayerSpell(88423)
				dispel.Curse  = IsPlayerSpell(2782)
				dispel.Poison = IsPlayerSpell(2782)
			end
		elseif class == 'PALADIN' then
			func = function()
				dispel.Magic   = IsPlayerSpell(53551)
				dispel.Disease = IsPlayerSpell(4987)
				dispel.Poison  = IsPlayerSpell(4987)
			end
		elseif class == 'PRIEST' then
			func = function()
				dispel.Magic   = IsPlayerSpell(527) and IsPlayerSpell(33167)
				dispel.Disease = IsPlayerSpell(528)
			end
		elseif class == 'SHAMAN' then
			func = function()
				dispel.Magic = IsPlayerSpell(77130)
				dispel.Curse = IsPlayerSpell(51886)
			end
		elseif class == 'MAGE' then
			func = function()
				dispel.Curse = IsPlayerSpell(475)
			end
		elseif class == 'WARLOCK' then
			func = function()
				dispel.Magic = IsPlayerSpell(19505)
			end
		end
	elseif Grid2.isClassic then -- vanilla/tbc/wotlk
		if class == 'DRUID' then
			func = function()
				dispel.Poison = IsPlayerSpell(2893) or IsPlayerSpell(8946)
				dispel.Curse  = IsPlayerSpell(2782)
			end
		elseif class == 'PALADIN' then
			func = function()
				dispel.Poison  = IsPlayerSpell(4987) or IsPlayerSpell(1152)
				dispel.Disease = IsPlayerSpell(4987) or IsPlayerSpell(1152)
				dispel.Magic   = IsPlayerSpell(4987)
			end
		elseif class == 'PRIEST' then
			func = function()
				dispel.Magic   = IsPlayerSpell(527)
				dispel.Disease = IsPlayerSpell(552) or IsPlayerSpell(528)
			end
		elseif class == 'SHAMAN' then
			func = Grid2.isWrath and (function()
				dispel.Disease = IsPlayerSpell(2870) or IsPlayerSpell(526) or IsPlayerSpell(51886)
				dispel.Poison  = IsPlayerSpell(526) or IsPlayerSpell(51886)
				dispel.Curse   = IsPlayerSpell(51886)
			end) or (function()
				dispel.Disease = IsPlayerSpell(2870)
				dispel.Poison  = IsPlayerSpell(526)
			end)
		elseif class == 'MAGE' then
			func = function()
				dispel.Curse = IsPlayerSpell(475)
				dispel.Magic = Grid2.isSoD and IsSpellKnownOrOverridesKnown(412113) or nil -- Remove Greater Curse from Advanced Warding Rune
			end
		elseif class == 'WARLOCK' then
			func = function()
				dispel.Magic = IsPlayerSpell(19505)
			end
		end
	else -- retail
		if class == 'DRUID' then
			func = function()
				dispel.Magic  = IsPlayerSpell(88423)
				dispel.Curse  = IsPlayerSpell(392378) or IsPlayerSpell(2782)
				dispel.Poison = IsPlayerSpell(392378) or IsPlayerSpell(2782)
			end
		elseif class == 'PALADIN' then
			func = function()
				dispel.Magic   = IsPlayerSpell(4987)
				dispel.Disease = IsPlayerSpell(393024) or IsPlayerSpell(213644)
				dispel.Poison  = IsPlayerSpell(393024) or IsPlayerSpell(213644)
			end
		elseif class == 'PRIEST' then
			func = function()
				dispel.Magic   = IsPlayerSpell(527) or IsPlayerSpell(32375)
				dispel.Disease = IsPlayerSpell(390632) or IsPlayerSpell(213634)
			end
		elseif class == 'SHAMAN' then
			func = function(self, event)
				dispel.Magic  = IsPlayerSpell(77130)
				dispel.Curse  = IsPlayerSpell(383016) or IsPlayerSpell(51886)
				dispel.Poison = IsPlayerSpell(383013)
			end
		elseif class == 'MAGE' then
			func = function()
				dispel.Curse = IsPlayerSpell(475)
			end
		elseif class == 'WARLOCK' then
			func = function()
				dispel.Magic = IsPlayerSpell(115276) or IsPlayerSpell(89808)
			end
		elseif class == 'MONK' then
			func = function()
				dispel.Magic   = IsPlayerSpell(115450)
				dispel.Disease = IsPlayerSpell(388874) or IsPlayerSpell(218164)
				dispel.Poison  = IsPlayerSpell(388874) or IsPlayerSpell(218164)
			end
		elseif class == 'EVOKER' then
			func = function()
				dispel.Magic   = IsPlayerSpell(360823)
				dispel.Curse   = IsPlayerSpell(374251)
				dispel.Poison  = IsPlayerSpell(360823) or IsPlayerSpell(365585)
				dispel.Disease = IsPlayerSpell(374251)
			end
		end
	end
	-- publish usefull tables and methods
	Grid2.debuffPlayerDispelTypes = dispel
	Grid2.UpdatePlayerDispelTypes = func
end

-- Change default theme, theme = number(theme index starting in 0) or string(theme name)
function Grid2:SetDefaultTheme(theme)
	local themes = self.db.profile.themes
	if type(theme)~='number' then
		for index,name in pairs(themes.names) do
			if theme==name then	theme = index; break; end
		end
		if type(theme)~='number' and (theme=='Default' or theme==L['Default']) then
			theme = 0
		end
	end
	if theme==0 or themes.names[theme] then
		themes.enabled.default = theme
		self:ReloadTheme()
		return true
	end
end

-- Enable or disable profiles per specialization
function Grid2:EnableProfilesPerSpec(enabled)
	local db = self.profiles.char
	if not enabled ~= not (db[1] and db.enabled) and self.versionCli>=30000 then
		wipe(db)
		db.enabled = enabled or nil
		if enabled then
			local pro = self.db:GetCurrentProfile()
			for i=1,self.GetNumSpecializations() or 0 do
				db[i] = pro
			end
		end
		self:ReloadProfile()
	end
end

-- Set a profile for the specified specIndex or the general profile if specIndex==nil
function Grid2:SetProfileForSpec(profileName, specIndex)
	if self.db.profiles[profileName] then
		if not specIndex then
			self.db:SetProfile(profileName)
		elseif self.profiles.char[specIndex] then
			self.profiles.char[specIndex] = profileName
			self:ReloadProfile()
		end
	end
end

-- MinimapIcon visibility: value = true | false | nil => toggle
function Grid2:SetMinimapIcon(value)
	local minimapIcon = Grid2.db.global.minimapIcon or Grid2Layout.db.shared.minimapIcon
	if value~='query' then
		if value==nil then
			minimapIcon.hide = not minimapIcon.hide
		else
			minimapIcon.hide = not value
		end
		if minimapIcon.hide then
			Grid2Layout.minimapIcon:Hide("Grid2")
		else
			Grid2Layout.minimapIcon:Show("Grid2")
		end
	end
	return not minimapIcon.hide
end

-- Hide blizzard frames
do
	local hiddenFrame

	local function rehide(self)
		if not InCombatLockdown() then self:Hide() end
	end

	local function unregister(f)
		if f then f:UnregisterAllEvents() end
	end

	local function hideFrame(frame,dontsave)
		if frame then
			UnregisterUnitWatch(frame)
			frame:Hide()
			frame:UnregisterAllEvents()
			frame:SetParent(hiddenFrame)
			frame:HookScript("OnShow", rehide)
			unregister(frame.healthbar)
			unregister(frame.manabar)
			unregister(frame.powerBarAlt)
			unregister(frame.spellbar)
			if dontsave then
				frame:SetDontSavePosition(true)
			end
		end
	end

	-- party frames, only for retail
	local function HidePartyFrames()
		if not PartyFrame then return end
		hiddenFrame = hiddenFrame or CreateFrame('Frame')
		hiddenFrame:Hide()
		hideFrame(PartyFrame)
		for frame in PartyFrame.PartyMemberFramePool:EnumerateActive() do
			hideFrame(frame)
			hideFrame(frame.HealthBar)
			hideFrame(frame.ManaBar)
		end
		PartyFrame.PartyMemberFramePool:ReleaseAll()
		hideFrame(CompactPartyFrame)
		UIParent:UnregisterEvent("GROUP_ROSTER_UPDATE") -- used by compact party frame
	end

	-- raid frames
	local function HideRaidFrames()
		if not CompactRaidFrameManager then return end
		local function HideFrames()
			CompactRaidFrameManager:SetAlpha(0)
			CompactRaidFrameManager:UnregisterAllEvents()
			CompactRaidFrameContainer:UnregisterAllEvents()
			if not InCombatLockdown() then
				CompactRaidFrameManager:Hide()
				local shown = CompactRaidFrameManager_GetSetting('IsShown')
				if shown and shown ~= '0' then
					CompactRaidFrameManager_SetSetting('IsShown', '0')
				end
			end
		end
		hiddenFrame = hiddenFrame or CreateFrame('Frame')
		hiddenFrame:Hide()
		hooksecurefunc('CompactRaidFrameManager_UpdateShown', HideFrames)
		CompactRaidFrameManager:HookScript('OnShow', HideFrames)
		CompactRaidFrameContainer:HookScript('OnShow', HideFrames)
		HideFrames()
	end

	function Grid2:UpdateBlizzardFrames()
		local hide = self.db.profile.hideBlizzard
		if hide then
			if hide.raid then
				HideRaidFrames()
			end
			if hide.party then
				HidePartyFrames()
			end
			if hide.pet then
				hideFrame(PetFrame, true)
			end
			if hide.focus then
				hideFrame(FocusFrame, true)
				hideFrame(FocusFrameToT)
			end
			if hide.target then
				hideFrame(TargetFrame,true)
				hideFrame(TargetFrameToT)
				hideFrame(ComboFrame)
			end
			if hide.player then
				hideFrame(PlayerFrame, true)
				hideFrame(PlayerFrameAlternateManaBar)
				hideFrame(AlternatePowerBar)
			end
		end
		self.UpdateBlizzardFrames = nil
	end
end