collect.lua

   1 QuestHelper_File["collect.lua"] = "Development Version"
   2 QuestHelper_Loadtime["collect.lua"] = GetTime()
   3
   4 local debug_output = false
   5 if QuestHelper_File["collect.lua"] == "Development Version" then debug_output = true end
   6
   7 local QuestHelper_Collector_Version_Current = 7
   8
   9 QuestHelper_Collector = {}
  10 QuestHelper_Collector_Version = QuestHelper_Collector_Version_Current
  11
  12 local EventRegistrar = {}
  13 local OnUpdateRegistrar = {}
  14 local TooltipRegistrar = {}
  15
  16 local frame = CreateFrame("Frame")
  17
  18 local function OnEvent(_, event, ...)
  19   local tstart = GetTime()
  20   for _, v in pairs(EventRegistrar[event]) do
  21     v(...)
  22   end
  23   QH_Timeslice_Increment(GetTime() - tstart, "collect_event")
  24 end
  25
  26 frame:UnregisterAllEvents()
  27 frame:SetScript("OnEvent", OnEvent)
  28
  29 frame:Show()
  30
  31 local function EventHookRegistrar(event, func)
  32   QuestHelper: Assert(func)
  33   if not EventRegistrar[event] then
  34     frame:RegisterEvent(event)
  35     EventRegistrar[event] = {}
  36   end
  37   table.insert(EventRegistrar[event], func)
  38 end
  39
  40 local function OnUpdateHookRegistrar(func)
  41   QuestHelper: Assert(func)
  42   table.insert(OnUpdateRegistrar, func)
  43 end
  44
  45 local suppress = false
  46
  47  -- real tooltips don't use this function
  48 local SetTextScript = GameTooltip.SetText
  49 GameTooltip.SetText = function (...)
  50   suppress = true
  51   SetTextScript(...)
  52   suppress = false
  53 end
  54
  55 local function CollectTooltippery(self)
  56   if not self then self = GameTooltip end
  57
  58   local tstart = GetTime()
  59   for k, v in pairs(TooltipRegistrar) do
  60     v(self)
  61   end
  62   QH_Timeslice_Increment(GetTime() - tstart, "collect_tooltip")
  63
  64   -- anything past here is not my fault
  65 end
  66
  67 local ottsu = GameTooltip:GetScript("OnTooltipSetUnit")
  68 GameTooltip:SetScript("OnTooltipSetUnit", function (self, ...)
  69   CollectTooltippery(self)
  70   if ottsu then return ottsu(self, ...) end
  71 end)
  72
  73 local ottsi = GameTooltip:GetScript("OnTooltipSetItem")
  74 GameTooltip:SetScript("OnTooltipSetItem", function (self, ...)
  75   CollectTooltippery(self)
  76   if ottsi then return ottsi(self, ...) end
  77 end)
  78
  79
  80 local function TooltipHookRegistrar(func)
  81   QuestHelper: Assert(func)
  82   table.insert(TooltipRegistrar, func)
  83 end
  84
  85 local API = {
  86   Registrar_EventHook = EventHookRegistrar,
  87   Registrar_OnUpdateHook = OnUpdateHookRegistrar,
  88   Registrar_TooltipHook = TooltipHookRegistrar,
  89   Callback_Location_Raw = function () return QuestHelper:Location_RawRetrieve() end,
  90   Callback_Location_Absolute = function () return QuestHelper:Location_AbsoluteRetrieve() end,
  91 }
  92
  93 -- We do these early, because some things that aren't in collect may rely on these. Yes I realize that avoiding this was one of my main goals in the separate collect system, shut up go away I hate you (in all seriousness: crunch mode + lazy = some nasty bits.)
  94 -- TODO: Make a common collect/mainmodule system, then rely on that better.
  95 QH_Collect_Util_Init(nil, API)  -- Some may actually add their own functions to the API, and should go first. There's no real formalized order, I just know which depend on others, and it's heavily asserted so it will break if it goes in the wrong order.
  96 QH_Collect_Merger_Init(nil, API)
  97 QH_Collect_Bitstream_Init(nil, API)
  98 QH_Collect_Location_Init(nil, API)
  99 QH_Collect_Patterns_Init(nil, API)
 100 QH_Collect_Notifier_Init(nil, API)
 101 QH_Collect_Spec_Init(nil, API)
 102 QH_Collect_LZW_Init(nil, API)
 103
 104 local CompressCollection
 105
 106 function QH_Collector_Init()
 107   QH_Collector_UpgradeAll(QuestHelper_Collector)
 108
 109   for _, v in pairs(QuestHelper_Collector) do
 110     if not v.modified then v.modified = time() - 7 * 24 * 60 * 60 end  -- eugh. Yeah, we set it to be a week ago. It's pretty grim.
 111   end
 112
 113   QuestHelper_Collector_Version = QuestHelper_Collector_Version_Current
 114
 115   local sig = string.format("%s on %s/%s/%d", GetAddOnMetadata("QuestHelper", "Version"), GetBuildInfo(), GetLocale(), QuestHelper:PlayerFaction())
 116   local sig_altfaction = string.format("%s on %s/%s/%d", GetAddOnMetadata("QuestHelper", "Version"), GetBuildInfo(), GetLocale(), (QuestHelper:PlayerFaction() == 1) and 2 or 1)
 117   if not QuestHelper_Collector[sig] or QuestHelper_Collector[sig].compressed then QuestHelper_Collector[sig] = {version = QuestHelper_Collector_Version} end -- fuckin' bullshit, man
 118   local QHCData = QuestHelper_Collector[sig]
 119   QuestHelper: Assert(not QHCData.compressed)
 120   QuestHelper: Assert(QHCData.version == QuestHelper_Collector_Version_Current)
 121   QHCData.modified = time()
 122
 123   QH_Collect_Achievement_Init(QHCData, API)
 124   QH_Collect_Traveled_Init(QHCData, API)
 125   QH_Collect_Zone_Init(QHCData, API)
 126   QH_Collect_Monster_Init(QHCData, API)
 127   QH_Collect_Item_Init(QHCData, API)
 128   QH_Collect_Object_Init(QHCData, API)
 129   QH_Collect_Flight_Init(QHCData, API)
 130   QH_Collect_Quest_Init(QHCData, API)
 131   QH_Collect_Warp_Init(QHCData, API)
 132
 133   QH_Collect_Loot_Init(QHCData, API)
 134   QH_Collect_Equip_Init(QHCData, API)
 135   QH_Collect_Merchant_Init(QHCData, API)
 136
 137   if not QHCData.realms then QHCData.realms = {} end
 138   QHCData.realms[GetRealmName()] = (QHCData.realms[GetRealmName()] or 0) + 1 -- I'm not entirely sure why I'm counting
 139
 140   if false then  -- this will be disabled in most public releases, or set to a very rare probabalistic thing
 141     if not QHCData.routing_dump then QHCData.routing_dump = {} end
 142     local nt = {}
 143     table.insert(QHCData.routing_dump, nt)
 144     QH_Collect_Routing_Dump = nt
 145   end
 146
 147   do  -- Clean some stuff up!
 148     local obliterate = {}
 149     for k, v in pairs(QuestHelper_Collector) do
 150       if not v.modified or v.modified + 30 * 24 * 60 * 60 < GetTime() then
 151         table.insert(obliterate, k)
 152       end
 153     end
 154
 155     for _, v in ipairs(obliterate) do
 156       QuestHelper_Collector[k] = nil
 157     end
 158   end
 159
 160   -- So, why do we delay it?
 161   -- It's simple. People are gonna update to this version, and then they're going to look at the memory usage. Then they will panic because omg this version uses so much more memory, I bet that will somehow hurt my framerates in a way which is not adequately explained!
 162   -- So instead, we just wait half an hour before compressing. Compression will still get done, and I won't have to deal with panicked comments about how bloated QH has gotten.
 163   -- addendum: yeah naturally I'm getting all sorts of panicked comments about how bloated qh has gotten, sigh
 164   API.Utility_Notifier(GetTime() + (debug_output and 0 or (30 * 60)), function() CompressCollection(QHCData, QuestHelper_Collector[sig_altfaction], API.Utility_Merger, API.Utility_LZW.Compress) end)
 165 end
 166
 167 function QH_Collector_OnUpdate()
 168   local tstart = GetTime()
 169   for _, v in pairs(OnUpdateRegistrar) do
 170     v()
 171   end
 172   QH_Timeslice_Increment(GetTime() - tstart, "collect_update")
 173 end
 174
 175
 176
 177 --- I've tossed the compression stuff down here just 'cause I don't feel like making an entire file for it (even though I probably should.)
 178
 179 local noncompressible = {
 180   modified = true,
 181   version = true,
 182 }
 183
 184 local squarify
 185
 186 local seritem
 187
 188 local serializers = {
 189   ["nil"] = function(item, add)
 190     add("nil")
 191   end,
 192   ["number"] = function(item, add)
 193     add(tostring(item))
 194   end,
 195   ["string"] = function(item, add)
 196     add(string.format("%q", item))
 197   end,
 198   ["boolean"] = function(item, add)
 199     add(item and "true" or "false")
 200   end,
 201   ["table"] = function(item, add)
 202     add("{")
 203     local first = true
 204     for k, v in pairs(item) do
 205       if not first then add(",") end
 206       first = false
 207       add("[")
 208       seritem(k, add)
 209       add("]=")
 210       seritem(v, add)
 211     end
 212     add("}")
 213   end,
 214 }
 215
 216 seritem = function(item, add)
 217   QH_Timeslice_Yield()
 218   serializers[type(item)](item, add)
 219 end
 220
 221 local function DoCompress(item, merger, comp)
 222   if debug_output then QuestHelper: TextOut("Item condensing") end
 223   local ts = GetTime()
 224
 225   local target = {}
 226   for k, v in pairs(item) do
 227     if not noncompressible[k] then
 228       target[k] = v
 229     end
 230   end
 231
 232   local mg = {}
 233   seritem(target, function(dat) merger.Add(mg, dat) end)
 234
 235   local tg = merger.Finish(mg)
 236   if debug_output then QuestHelper: TextOut(string.format("Item condensed to %d bytes, %f taken so far", #tg, GetTime() - ts)) end
 237   mg = nil
 238
 239   local cmp = {}
 240   local cmptot = 0
 241
 242   local doublecheck = ""
 243   for chunk = 1, #tg, 1048576 do
 244     local fragment = tg:sub(chunk, chunk + 1048575)
 245     doublecheck = doublecheck .. fragment
 246     local ite = comp(fragment, 256, 8)
 247     cmptot = cmptot + #ite
 248     table.insert(cmp, ite)
 249   end
 250   QuestHelper: Assert(doublecheck == tg)
 251
 252   if #cmp == 1 then cmp = cmp[1] end
 253
 254   for k, v in pairs(target) do
 255     if not noncompressible[k] then
 256       item[k] = nil
 257     end
 258   end
 259   item.compressed = cmp
 260
 261   if debug_output then QuestHelper: TextOut(string.format("Item compressed to %d bytes in %d shards (previously %d), %f taken", cmptot, type(cmp) == "table" and #cmp or 1, #tg, GetTime() - ts)) end
 262 end
 263
 264 CompressCollection = function(active, active2, merger, comp)
 265   for _, v in pairs(QuestHelper_Collector) do
 266     if v ~= active and v ~= active2 and not v.compressed then
 267       QH_Timeslice_Add(function ()
 268         DoCompress(v, merger, comp)
 269         CompressCollection(active, active2, merger, comp)
 270       end, "compress")
 271       break
 272     end
 273   end
 274 end