wow/ouroloot: core.lua comparison

comparison core.lua @ 125:a9cf9b2fbf9b

- Fix interactions with AddonLoader. - Plugins get a :Print with a clickable prefix, with overrideable behaviors. - 'Deactivate' event gets a [wrapper around] current raiders table. - Fix sorting bug in player history data. - Smarter status line text when viewing unfiltered history. - Do not disable history regeneration button when current history is empty. - :BuildMainDisplay can handle the CLI args now.

author	Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date	Sun, 19 Aug 2012 21:08:59 -0400
parents	fb4bda3ad05c
children	dc39ce56a62d

comparison

equal deleted inserted replaced

-:1a248faf1a3b
+:a9cf9b2fbf9b
 -    online     'online', 'offline', 'no_longer' [no longer in raid group]
 [both of these next two fields use time_t values:]
 -    join       time player joined the raid (or first time we've seen them)
 -    leave      time player left the raid (or time we've left the raid, if
 'online' is not 'no_longer')
+-    needinfo   true if haven't yet gotten close enough to player to request
+unit data; SHOULD be missing
 Common g_loot entry indices:
 - kind          time/boss/loot
 - hour          0-23, on the *physical instance server*, not the realm server
 - minute        0-59, ditto
 	-- COLOR can be ITEM_QUALITY_* or a formatting string ("|cff...")
 	-- FUNC can be "MethodName", "tab_title", or a function
 	--
 	-- Returns an opaque token and a matching number.  Calling tostring() on
 	-- the token will yield a formatted clickable string that can be displayed
-	-- in chat.  The MethodName and raw function callbacks will both be
+	-- in local chat.  Clicking a tab_title hyperlink opens the GUI to that
-	-- passed the addon table and the same matching number.
+	-- tab; the MethodName and raw function callbacks will be passed the addon
+	-- table, the same matching number, and the mouse button (ala OnClick) as
+	-- arguments.
 	--
 	-- This is largely an excuse to fool around with Lua data constructs.
 	function addon.format_hypertext (text, color, func)
 		local ret = newproxy(base)
 		local num = #text_map + 1
 	DEFAULT_CHAT_FRAME:HookScript("OnHyperlinkClick", function(self, link, fullstring, mousebutton)
 		local ltype, arg = strsplit(":",link)
 		if ltype ~= "OuroLoot" then return end
 		arg = tonumber(arg)
 		local f = func_map[text_map[arg]]
-		if type(f) == 'function' then
+		local t = type(f)
-			f (addon, arg)
+		if t == 'string' then
-		elseif type(f) == 'string' then
 			if type(addon[f]) == 'function' then
-				addon[f](addon,arg)         -- method name
+				addon[f](addon,arg,mousebutton)   -- method
 			else
-				addon:BuildMainDisplay(f)   -- tab title fragment
+				addon:BuildMainDisplay(f)         -- tab title fragment
 			end
+		elseif t == 'function' then
+			f (addon, arg, mousebutton)
 		end
 	end)
 	local old = ItemRefTooltip.SetHyperlink
 	function ItemRefTooltip:SetHyperlink (link, ...)
 	-- relogging during a raid and already have collected loot data
 	local OuroLootSV = OuroLootSV
 	g_restore_p = OuroLootSV ~= nil
 	self.dprint('flow', "oninit sets restore as", g_restore_p)
-	-- Primarily for plugins, but can be of use to me also...
+	-- Primarily for plugins, but can be of use to me also...  LCALLBACK
 	self.callbacks = LibStub("CallbackHandler-1.0"):New(self)
 	--function self.callbacks:OnUsed (target_aka_self, eventname)  end
 	--function self.callbacks:OnUnused (target_aka_self, eventname)  end
 	if _G.OuroLootOptsDB == nil then
 function addon:OnEnable()
 	self:RegisterEvent("PLAYER_LOGOUT")
 	self:RegisterEvent(RAID_ROSTER_UPDATE_EVENT,"RAID_ROSTER_UPDATE")
-	-- Cribbed from Talented.  I like the way jerry thinks: the first string
+	-- This Print cribbed from Talented.  I like the way jerry thinks: the
-	-- argument can be a format spec for the remainder of the arguments.
+	-- first string argument can be a format spec for the remainder of the
-	-- AceConsole:Printf isn't used because we can't specify a prefix without
+	-- arguments.  AceConsole:Printf isn't used because we can't specify a
-	-- jumping through ridonkulous hoops.  The part about overriding :Print
+	-- prefix without jumping through ridonkulous hoops.
-	-- with a version using prefix hyperlinks is my fault.
+	--
+	-- Everything dealing with a prefix hyperlink is my fault.
 	--
 	-- CFPrint added instead of the usual Print testing of the first arg for
 	-- frame-ness, which would slow down all printing and only rarely be useful.
 	--
 	-- There is no ITEM_QUALITY_LEGENDARY constant.  Sigh.
 	Stick something in the Blizzard addons options list, where most users
 	will probably look these days.  Try to be conservative about needless
 	frame creation.
 	]]
 	local bliz = CreateFrame("Frame")
-	bliz.name = "Ouro Loot"
+	bliz.name = "Ouro Loot"  -- must match X-LoadOn-InterfaceOptions
+	if AddonLoader then
+		AddonLoader:RemoveInterfaceOptions(bliz.name)
+	end
 	bliz:SetScript("OnShow", function(_b)
 		local button = CreateFrame("Button",nil,_b,"UIPanelButtonTemplate")
 		button:SetWidth(150)
 		button:SetHeight(22)
 		button:SetScript("OnClick", function()
 			InterfaceOptionsFrameCancel:Click()
 			HideUIPanel(GameMenuFrame)
-			addon:OpenMainDisplayToTab"Options"
+			addon:BuildMainDisplay('opt')
 		end)
-		button:SetText('"/ouroloot opt"')
+		button:SetText('"/ouroloot options"')
 		button:SetPoint("TOPLEFT",20,-20)
 		_b:SetScript("OnShow",nil)
 	end)
 	InterfaceOptions_AddCategory(bliz)
 	Module support (aka plugins).  Field names with special meanings:
 	- option_defaults:  (IN) Standard AceDB-style table.  Use a profiles key!
 	- db:  (OUT) AceDB object, set during init.
 	- opts:  (OUT) Pointer to plugin's "db.profile" subtable.
-	OnInitialize, [default_]OnEnable, register_text_generator, register_tab_control
+	Inherited unchanged:
-	are all inherited.
+	Inherited module variants:
+	- OnInitialize, OnEnable
+	- register_text_generator, register_tab_control:  also flag plugin as
+		a text-generating module in main addon
 	]]
 	local prototype = {}
-	local registry
+	local textgen_registry, chat_prefixes, chat_codes
 	-- By default, no plugins.  First one in sets up code for any after.
-	addon.get_plugin = flib.nullfunc
+	addon.get_textgen_plugin = flib.nullfunc
-	-- Fires before the plugin's own OnEnable (inherited or otherwise).
+	-- Called as part of NewModule, after embedding and metas are done.
+	-- Mostly this is one-time setup stuff that we don't need until a plugin
+	-- is actually built.
 	function addon:OnModuleCreated (plugin)
-		if not registry then
+		textgen_registry, chat_prefixes, chat_codes = {}, {}, {}
-			registry = {}
+		addon.get_textgen_plugin = function(a,t)
-			addon.get_plugin = function(a,t) return registry[t] end
+			return textgen_registry[t]
-			prototype.register_text_generator = function(p,t,...)
+		end
-				registry[t] = p
+		prototype.register_text_generator = function(p,t,...)
-				return addon:register_text_generator(t,...)
+			textgen_registry[t] = p
-			end
+			return addon:register_text_generator(t,...)
-			prototype.register_tab_control = function(p,t,...)
+		end
-				registry[t] = p
+		prototype.register_tab_control = function(p,t,...)
-				return addon:register_tab_control(t,...)
+			textgen_registry[t] = p
-			end
+			return addon:register_tab_control(t,...)
 		end
-	end
+		function addon:ModulePrefixClick (codenum, mousebutton)
-	local function module_OnInit (plugin)
+			local plugin = assert(chat_codes[codenum])
+			if not plugin:IsEnabled() then return end
+			if mousebutton == 'LeftButton' then
+				if plugin.PrefixLeftClick then
+					plugin:PrefixLeftClick(codenum)
+				else
+					self:BuildMainDisplay()
+				end
+			elseif mousebutton == 'RightButton' then
+				local uniqueval = plugin.name
+				if plugin.PrefixRightClick then
+					uniqueval = plugin:PrefixRightClick(codenum)
+				end
+				self:BuildMainDisplay('opt',uniqueval)
+			end
+		end
+		function addon:OnModuleCreated (plugin)
+			local token, code = self.format_hypertext (plugin.moduleName,
+				--[[heirloom]]7, "ModulePrefixClick")
+			chat_prefixes[plugin] = token
+			chat_codes[code] = plugin
+			-- remove the libraries' embedded pointers so that the prototype
+			-- can be inherited
+			plugin.Print = nil
+		end
+		return self:OnModuleCreated(plugin)
+	end
+	function prototype.OnInitialize (plugin)
 		if plugin.option_defaults then
 			plugin.db = addon.db:RegisterNamespace (plugin.moduleName, plugin.option_defaults)
 			plugin.opts = plugin.db.profile
 			--plugin:SetEnabledState(plugin.db.profile.enabled)  if that flag is needed later
 		end
 	end
-	local function module_OnEnable (plugin)
+	--function prototype.OnEnable (plugin)
-	end
+	--end
-	local function module_GetOption (plugin, info)
+	function prototype.GetOption (plugin, info)
 		local name = info[#info]
 		return plugin.db.profile[name]
 	end
-	local function module_SetOption (plugin, info, value)
+	function prototype.SetOption (plugin, info, value)
 		local name = info[#info]
 		plugin.db.profile[name] = value
 		local arg = info.arg
 		if type(arg) == 'function' then
 			plugin[arg](plugin,info)
 		end
 	end
-	prototype.OnInitialize = module_OnInit
+	-- may eventually just rework the main print routines and inherit all 3
-	prototype.OnEnable = module_OnEnable
+	function prototype.Print (plugin, str, ...)
-	prototype.default_OnEnable = module_OnEnable
+		local AC = LibStub("AceConsole-3.0")
-	prototype.GetOption = module_GetOption
+		local ps = tostring(chat_prefixes[plugin])
-	prototype.SetOption = module_SetOption
+		if type(str) == 'string' and str:find("%", nil, --[[plainmatch=]]true) then
+			return AC:Print (ps, str:format(...))
+		else
+			return AC:Print (ps, str, ...)
+		end
+	end
 	addon:SetDefaultModuleLibraries("AceConsole-3.0")
 	addon:SetDefaultModulePrototype(prototype)
 	local err = [[Module '%s' cannot register itself because it failed a required condition: '%s']]
 'Activate', enabled_p, rebroadcast_p, threshold
 The two boolean predicates are self-explanatory.  The threshold is an
 ITEM_QUALITY_* constant integer.
-'Deactivate'
+'Deactivate', raiderdata
-After all system events have been unregistered.
+After all system events have been unregistered.  Argument is a holder of
+	the current g_loot.raiders table (in 'raidersnap').
 'Reset'
 Clicking "Clear Loot", after all data manipulation is finished.
 'NewBoss', boss
 	self.rebroadcast = false
 	self:UnregisterEvent(RAID_ROSTER_UPDATE_EVENT)
 	self:UnregisterEvent("PLAYER_ENTERING_WORLD")
 	self:UnregisterEvent("CHAT_MSG_LOOT")
 	_LFR_suppressing = nil
-	self:Fire ('Deactivate')
+	-- Passing .raiders directly doesn't work with a proxy (again, WTB Lua
+	-- 5.2 and its __pairs iterators).  Give it the same structure as a boss
+	-- entry instead.
+	self:Fire ('Deactivate', { raidersnap = g_loot.raiders })
 	self:Print("Deactivated.")
 end
 function addon:Clear(verbose_p)
 	local repopup, st
 	-- formatted timestamp.  This is expensive, and destructive for P.unique.
 	local function compare_timestamps (L, R)
 		return L > R    -- reverse of normal order, newest first
 	end
 	local function sort_player (p)
-		local new_uniques, uniques_bywhen, when_array = new(), new(), new()
+		local new_uniques, uniques_bywhen, when_array = {}, new(), new()
 		for u,tstamp in pairs(p.when) do
 			uniques_bywhen[tstamp] = u
 			when_array[#when_array+1] = tstamp
 		end
 		table.sort (when_array, compare_timestamps)
 		for i,tstamp in ipairs(when_array) do
 			new_uniques[i] = uniques_bywhen[tstamp]
 		end
 		p.unique = new_uniques
-		del(new_uniques)  del(uniques_bywhen)  del(when_array)
+		del(uniques_bywhen)
+		del(when_array)
 	end
 	function addon:repair_history_integrity()
 		local rcount, pcount, hcount, errors = 0, 0, 0, 0
 		local empties_to_delete = {}

Mercurial > wow > ouroloot

comparison core.lua @ 125:a9cf9b2fbf9b