wow/ouroloot: core.lua comparison

comparison core.lua @ 16:5ee4edd24c13

- new blizz methods for editboxes in dialog popups - initial code for dropdowns in history (not active yet) - hovering and shift-clicking to link out of history - proper confirmations for history rewriting - options checkboxes more grid-like - saved texts get a scrollbar instead of expanding indefinitely (duh) - rearranged savedvars a bit (and added transition code) - stores raider join/leave times and "demographic" info, all for MLEQDKP - minor bugfixes and tweaks

author	Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date	Thu, 25 Aug 2011 00:45:31 +0000
parents	d8fee518ce5d
children	d929c40cdb09

comparison

equal deleted inserted replaced

-:d8fee518ce5d
+:5ee4edd24c13
 --[==[
 g_loot's numeric indices are loot entries (including titles, separators,
 etc); its named indices are:
 - forum:		saved text from forum markup window, default nil
 - attend:		saved text from raid attendence window, default nil
-- printed.FOO:	last index formatted into text window FOO, default 0
+- printed.FOO:	last loot index formatted into text window FOO, default 0
-- saved:		table of copies of saved texts, default nil; keys are numeric
-				indices of tables, subkeys of those are name/forum/attend/date
-- autoshard:	optional name of disenchanting player, default nil
-- threshold:	optional loot threshold, default nil
 Functions arranged like this, with these lables (for jumping to).  As a
 rule, member functions with UpperCamelCase names are called directly by
 user-facing code, ones with lowercase names are "one step removed", and
 names with leading underscores are strictly internal helper functions.
 This started off as part of a raid addon package written by somebody else.
 After he retired, I began modifying the code.  Eventually I set aside the
 entire package and rewrote the loot tracker module from scratch.  Many of the
 variable/function naming conventions (sv_*, g_*, and family) stayed across the
-rewrite.  Some variables are needlessly initialized to nil just to look uniform.
+rewrite.
+Some variables are needlessly initialized to nil just to look uniform.
 ]==]
 ------ Saved variables
-OuroLootSV		= nil   -- possible copy of g_loot
+OuroLootSV       = nil   -- possible copy of g_loot
-OuroLootSV_opts	= nil   -- same as option_defaults until changed
+OuroLootSV_saved = nil   -- table of copies of saved texts, default nil; keys
-OuroLootSV_hist	= nil
+-- are numeric indices of tables, subkeys of those
+						 -- are name/forum/attend/date
+OuroLootSV_opts  = nil   -- same as option_defaults until changed
+-- autoshard:  optional name of disenchanting player, default nil
+-- threshold:  optional loot threshold, default nil
+OuroLootSV_hist  = nil
 ------ Constants
 local option_defaults = {
 	['popup_on_join'] = true,
 ------ Globals
 local g_loot			= nil
 local g_restore_p		= nil
-local g_saved_tmp		= nil   -- restoring across a clear
 local g_wafer_thin		= nil   -- for prompting for additional rebroadcasters
 local g_today			= nil   -- "today" entry in g_loot
+local g_boss_signpost	= nil
 local opts				= nil
 local pairs, ipairs, tinsert, tremove, tonumber = pairs, ipairs, table.insert, table.remove, tonumber
 local pprint, tabledump = addon.pprint, flib.tabledump
 local GetNumRaidMembers = GetNumRaidMembers
 	opts["forum_use_itemid"] = nil
 	if opts["forum_format"] then
 		opts.forum["Custom..."] = opts["forum_format"]
 		opts["forum_format"] = nil
 	end
+	if OuroLootSV then  -- may not be the same as testing g_restore_p soon
+		if OuroLootSV.saved then
+			OuroLootSV_saved = OuroLootSV.saved; OuroLootSV.saved = nil
+		end
+		if OuroLootSV.threshold then
+			opts.threshold = OuroLootSV.threshold; OuroLootSV.threshold = nil
+		end
+		if OuroLootSV.autoshard then
+			opts.autoshard = OuroLootSV.autoshard; OuroLootSV.autoshard = nil
+		end
+	end
 	-- get item filter table if needed
 	if opts.itemfilter == nil then
 		opts.itemfilter = addon.default_itemfilter
 	end
 	addon.default_itemfilter = nil
 ------ Event handlers
 function addon:_clear_SVs()
 	g_loot = {}  -- not saved, just fooling PLAYER_LOGOUT tests
 	OuroLootSV = nil
+	OuroLootSV_saved = nil
 	OuroLootSV_opts = nil
 	OuroLootSV_hist = nil
 	ReloadUI()
 end
 function addon:PLAYER_LOGOUT()
-	if (#g_loot > 0) or g_loot.saved
+	self:UnregisterEvent("RAID_ROSTER_UPDATE")
-		-- someday make this smarter
+	self:UnregisterEvent("PLAYER_ENTERING_WORLD")
-	   or (g_loot.forum and g_loot.forum ~= "")
-	   or (g_loot.attend and g_loot.attend ~= "")
+	local worth_saving = #g_loot > 0 or next(g_loot.raiders)
-	then
+	if not worth_saving then for text in self:registered_textgen_iter() do
-		g_loot.autoshard = self.sharder
+		worth_saving = worth_saving or g_loot.printed[text] > 0
-		g_loot.threshold = self.threshold
+	end end
+	if worth_saving then
+		opts.autoshard = self.sharder
+		opts.threshold = self.threshold
 		for i,e in ipairs(g_loot) do
 			e.cols = nil
 		end
 		OuroLootSV = g_loot
-	end
+	else
+		OuroLootSV = nil
+	end
 	for r,t in pairs(self.history_all) do if type(t) == 'table' then
 		if #t == 0 then
 			self.history_all[r] = nil
 		else
 			t.realm = nil
 		  		UnitLevel, UnitInRaid, UnitIsVisible, GetGuildInfo
 	local time, difftime = time, difftime
 	local R_ACTIVE, R_OFFLINE, R_LEFT = 1, 2, 3
 	local lastevent, now = 0, 0
-	local timer_handle
+	local redo_count = 0
+	local redo, timer_handle
 	function addon:CheckRoster (leaving_p, now_a)
 		if not g_loot.raiders then return end -- bad transition
 		now = now_a or time()
 		if leaving_p then
+			if timer_handle then
+				self:CancelTimer(timer_handle)
+				timer_handle = nil
+			end
 			for name,r in pairs(g_loot.raiders) do
 				r.leave = r.leave or now
 			end
 			return
 		end
 				r.online = R_LEFT
 				r.leave = now
 			end
 		end
-		local redo = false
+		if redo then
+			redo_count = redo_count + 1
+		end
+		redo = false
 		for i = 1, GetNumRaidMembers() do
 			local unit = 'raid'..i
 			local name = UnitName(unit)
 			-- No, that's not my typo, it really is "uknownbeing" in Blizzard's code.
 			if name and name ~= UNKNOWN and name ~= UNKNOWNOBJECT and name ~= UKNOWNBEING then
 					r.online = R_OFFLINE
 				end
 				redo = redo or r.needinfo
 			end
 		end
-		if redo then
+		if redo then  -- XXX test redo_count here and eventually give up?
-			timer_handle = self:ScheduleRepeatingTimer("RAID_ROSTER_UPDATE", 60)
+			if not timer_handle then
-		elseif timer_handle then
+				timer_handle = self:ScheduleRepeatingTimer("RAID_ROSTER_UPDATE", 60)
-			self:CancelTimer(timer_handle)
+			end
-			timer_handle = nil
+		else
+			redo_count = 0
+			if timer_handle then
+				self:CancelTimer(timer_handle)
+				timer_handle = nil
+			end
 		end
 	end
 	function addon:RAID_ROSTER_UPDATE (event)
 		if GetNumRaidMembers() == 0 then
+			-- Leaving a raid group.
 			-- Because of PLAYER_ENTERING_WORLD, this code also executes on load
 			-- screens while soloing and in regular groups.  Take care.
-			if self.enabled then
+			self.dprint('flow', "GetNumRaidMembers == 0")
+			if self.enabled and not self.debug.notraid then
+				self.dprint('flow', "enabled, leaving raid")
 				self.popped = nil
-				self:UnregisterEvent("CHAT_MSG_LOOT")
+				self:Deactivate()  -- self:UnregisterEvent("CHAT_MSG_LOOT")
 				self:CheckRoster(--[[leaving raid]]true)
 			end
 			return
 		end
 			docheck = true
 		elseif event == "RAID_ROSTER_UPDATE" then
 			-- hot code path, be careful
 			-- event registration from onload, joined a raid, maybe show popup
+			self.dprint('flow', "RRU check:", self.popped, opts.popup_on_join)
 			if (not self.popped) and opts.popup_on_join then
 				self.popped = StaticPopup_Show "OUROL_REMIND"
 				self.popped.data = self
 				return
 			end
 end
 ------ On/off
 function addon:Activate (opt_threshold, opt_bcast_only)
+	self.dprint('flow', ":Activate is running")
 	self:RegisterEvent("RAID_ROSTER_UPDATE")
-	self:RegisterEvent("PLAYER_ENTERING_WORLD","RAID_ROSTER_UPDATE")
+	self:RegisterEvent("PLAYER_ENTERING_WORLD",
+		function() self:ScheduleTimer("RAID_ROSTER_UPDATE", 5, "PLAYER_ENTERING_WORLD") end)
 	self.popped = true
 	if GetNumRaidMembers() > 0 then
+		self.dprint('flow', ">:Activate calling RRU")
 		self:RAID_ROSTER_UPDATE("Activate")
 	elseif self.debug.notraid then
+		self.dprint('flow', ">:Activate registering loot and bossmods")
 		self:RegisterEvent("CHAT_MSG_LOOT")
 		_register_bossmod(self)
 	elseif g_restore_p then
 		g_restore_p = nil
-		if #g_loot == 0 then return end -- only saved texts, not worth verbage
+		self.popped = nil  -- get the reminder if later joining a raid
+		if #g_loot == 0 then
+			-- only generated text and raider join/leave data, not worth verbage
+			self.dprint('flow', ">:Activate restored generated texts, un-popping")
+			return
+		end
 		self:Print("Ouro Raid Loot restored previous data, but not in a raid",
 				"and 5-person mode not active.  |cffff0505NOT tracking loot|r;",
 				"use 'enable' to activate loot tracking, or 'clear' to erase",
 				"previous data, or 'help' to read about saved-texts commands.")
-		self.popped = nil  -- get the reminder if later joining a raid
 		return
 	end
 	self.rebroadcast = true  -- hardcode to true; this used to be more complicated
 	self.enabled = not opt_bcast_only
 	if opt_threshold then
 		self.display:Hide()
 	end
 	g_restore_p = nil
 	OuroLootSV = nil
 	self:_reset_timestamps()
-	g_saved_tmp = g_loot.saved
 	if verbose_p then
-		if (g_saved_tmp and #g_saved_tmp>0) then
+		if (OuroLootSV_saved and #OuroLootSV_saved>0) then
-			self:Print("Current loot data cleared, %d saved sets remaining.", #g_saved_tmp)
+			self:Print("Current loot data cleared, %d saved sets remaining.", #OuroLootSV_saved)
 		else
 			self:Print("Current loot data cleared.")
 		end
 	end
 	_init(self,st)
 		return (t == ITEM_HEROIC) or nil
 	end
 end
 -- Called when first loading up, and then also when a 'clear' is being
--- performed.  If SV's are present then restore_p will be true.
+-- performed.  If SV's are present then g_restore_p will be true.
 function _init (self, possible_st)
 	self.dprint('flow',"_init running")
 	self.loot_clean = nil
 	self.hist_clean = nil
 	if g_restore_p then
 		g_loot = OuroLootSV
-		self.popped = true
+		self.popped = #g_loot > 0
 		self.dprint('flow', "restoring", #g_loot, "entries")
-		self:ScheduleTimer("Activate", 12, g_loot.threshold)
+		self:ScheduleTimer("Activate", 12, opts.threshold)
 		-- FIXME printed could be too large if entries were deleted, how much do we care?
-		self.sharder = g_loot.autoshard
+		self.sharder = opts.autoshard
 	else
 		g_loot = { printed = {}, raiders = {} }
-		g_loot.saved = g_saved_tmp; g_saved_tmp = nil	-- potentially restore across a clear
+	end
-	end
+	self.threshold = opts.threshold or self.threshold -- in the case of restoring but not tracking
-	self.threshold = g_loot.threshold or self.threshold -- in the case of restoring but not tracking
 	self:gui_init(g_loot)
+	opts.autoshard = nil
+	opts.threshold = nil
 	if g_restore_p then
 		self:zero_printed_fenceposts()                  -- g_loot.printed.* = previous/safe values
 	else
 		self:zero_printed_fenceposts(0)                 -- g_loot.printed.* = 0
 					break
 				end
 			end
 		end
 		bossi = addon._addLootEntry(boss)
+		--
+		bossi = addon._adjustBossOrder (bossi, g_boss_signpost)
+		g_boss_signpost = nil
 		addon.dprint('loot', "added entry", bossi)
 		if boss.reason == 'kill' then
 			addon:_mark_boss_kill (bossi)
 			if opts.chatty_on_kill then
 				addon:Print("Registered kill for '%s' in %s!", boss.bosskill, boss.instance)
 			local signature = bossname .. reason
 			if not_from_local and self.recent_boss:test(signature) then
 				self.dprint('cache', "boss <",signature,"> already in cache, skipping")
 			else
 				self.recent_boss:add(signature)
+				g_boss_signpost = #g_loot + 1
 				-- Possible scenarios:  (1) we don't see a boss event at all (e.g., we're
 				-- outside the instance) and so this only happens once as a non-local event,
 				-- (2) we see a local event first and all non-local events are filtered
 				-- by the cache, (3) we happen to get some non-local events before doing
 				-- our local event (not because of network weirdness but because our local
 	addon.on_boss_broadcast = _do_boss
 	function addon:_mark_boss_kill (index)
 		local e = g_loot[index]
 		if not e.bosskill then
-			return self:Print("Something horribly wrong;", index, "is not a boss entry!")
+			self:Print("Something horribly wrong;", index, "is not a boss entry!")
+			return
 		end
 		if e.reason ~= 'wipe' then
 			-- enh, bail
 			self.loot_clean = index-1
 		end
 		e.stamp = time_t --localuptime
 		local index = #g_loot + 1
 		g_loot[index] = e
 		return index
 	end
+	-- Problem:  (1) boss kill happens, (2) fast looting happens, (3) boss
+	-- cache cleanup fires.  Result:  loot shows up before boss kill entry.
+	-- Solution:  We need to shuffle the boss entry above any of the loot
+	-- from that boss.
+	function addon._adjustBossOrder (is, should_be)
+		--pprint('loot', is, should_be)
+		if is == should_be then --pprint('loot', "equal, yay")
+			return
+		end
+		if is < should_be then --pprint('loot', "...the hell? bailing")
+			return
+		end
+		if g_loot[should_be].kind == 'time' then
+			should_be = should_be + 1
+			if is == should_be then
+				--pprint('loot', "needed to mark day entry, otherwise equal, yay")
+				return
+			end
+		end
+		assert(g_loot[is].kind == 'boss')
+		local boss = tremove (g_loot, is)
+		--pprint('loot', "MOVING", boss.bosskill)
+		tinsert (g_loot, should_be, boss)
+		return should_be
+	end
 end
 ------ Saved texts
 function addon:check_saved_table(silent_p)
-	local s = g_loot.saved
+	local s = OuroLootSV_saved
 	if s and (#s > 0) then return s end
-	g_loot.saved = nil
+	OuroLootSV_saved = nil
 	if not silent_p then self:Print("There are no saved loot texts.") end
 end
 function addon:save_list()
 	local s = self:check_saved_table(); if not s then return end;
 		self:Print("#%d   %s    %d entries     %s", i, t.date, t.count, t.name)
 	end
 end
 function addon:save_saveas(name)
-	g_loot.saved = g_loot.saved or {}
+	OuroLootSV_saved = OuroLootSV_saved or {}
-	local n = #(g_loot.saved) + 1
+	local SV = OuroLootSV_saved
+	local n = #SV + 1
 	local save = {
 		name = name,
 		date = makedate(),
 		count = #g_loot,
 	}
 	for text in self:registered_textgen_iter() do
 		save[text] = g_loot[text]
 	end
 	self:Print("Saving current loot texts to #%d '%s'", n, name)
-	g_loot.saved[n] = save
+	SV[n] = save
 	return self:save_list()
 end
 function addon:save_restore(num)
 	local s = self:check_saved_table(); if not s then return end;

Mercurial > wow > ouroloot

comparison core.lua @ 16:5ee4edd24c13