Skip to content

Commit

Permalink
consistently indent using tabs (except data files)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mirroar
Mirroar committed Dec 7, 2014
1 parent b5ea613 commit 5cafaa0
Show file tree
Hide file tree
Showing 17 changed files with 3,006 additions and 3,006 deletions.
216 changes: 108 additions & 108 deletions calculation.class.lua
View file
Expand Up @@ -6,202 +6,202 @@ ns.Calculation = Calculation
-- create a new, empty calculation object
-- not advised, this class is meant to be inherited from by different calculation methods
function Calculation:construct(set)
self.AssertArgumentType(set, ns.Set)
self.AssertArgumentType(set, ns.Set)

self.running = false
self.started = false
self.set = set
self.elapsed = 0
self.availableItems = {}
for slotID, _ in pairs(ns.slotNames) do
self.availableItems[slotID] = {}
end
self:SetOperationsPerFrame(50) -- sensible default that is somewhat easy on the CPU
self.running = false
self.started = false
self.set = set
self.elapsed = 0
self.availableItems = {}
for slotID, _ in pairs(ns.slotNames) do
self.availableItems[slotID] = {}
end
self:SetOperationsPerFrame(50) -- sensible default that is somewhat easy on the CPU
end

function Calculation:UseSet(set)
self.AssertArgumentType(set, ns.Set)
self.AssertArgumentType(set, ns.Set)

self.set = set
self.set = set
end

function Calculation:GetUsedSet()
return self.set
return self.set
end

-- add an item to be available for the current calculation in the given slot (or all applicable slots if none is provided)
function Calculation:AddItem(item, slotID)
-- accepts item IDs, links and tables
assert(item, "Usage: calculation:AddItem(itemLink or itemID or itemTable[, slotID])")
if type(item) == 'table' then
if item.itemLink then item = item.itemLink
elseif item.itemID then item = item.itemID
else error("Usage: calculation:AddItem(itemLink or itemID or itemTable[, slotID])") end
end
local itemTable = ns:GetCachedItem(item)

if slotID then
assert(self.availableItems[slotID], "calculation:AddItem() - invalid slotID given: "..(slotID or "nil"))

tinsert(self.availableItems[slotID], itemTable)
else
for _, slotID in pairs(itemTable.equipLocationsByType) do
tinsert(self.availableItems[slotID], itemTable)
end
end
-- accepts item IDs, links and tables
assert(item, "Usage: calculation:AddItem(itemLink or itemID or itemTable[, slotID])")
if type(item) == 'table' then
if item.itemLink then item = item.itemLink
elseif item.itemID then item = item.itemID
else error("Usage: calculation:AddItem(itemLink or itemID or itemTable[, slotID])") end
end
local itemTable = ns:GetCachedItem(item)

if slotID then
assert(self.availableItems[slotID], "calculation:AddItem() - invalid slotID given: "..(slotID or "nil"))

tinsert(self.availableItems[slotID], itemTable)
else
for _, slotID in pairs(itemTable.equipLocationsByType) do
tinsert(self.availableItems[slotID], itemTable)
end
end
end

-- removes all currently available items from this calculation
function Calculation:ClearItems()
for _, slotTable in pairs(self.availableItems) do
wipe(slotTable)
end
for _, slotTable in pairs(self.availableItems) do
wipe(slotTable)
end
end

-- get available items for a slot
function Calculation:GetItems(slotID)
if not slotID then
return self.availableItems --TODO: copy tables or use provided table
elseif self.availableItems[slotID] then
assert(self.availableItems[slotID], "calculation:GetItems() - invalid slotID given: "..(slotID or "nil"))
return self.availableItems[slotID] --TODO: copy tables or use provided table
end
if not slotID then
return self.availableItems --TODO: copy tables or use provided table
elseif self.availableItems[slotID] then
assert(self.availableItems[slotID], "calculation:GetItems() - invalid slotID given: "..(slotID or "nil"))
return self.availableItems[slotID] --TODO: copy tables or use provided table
end
end

function Calculation:SetCallback(callback)
if callback then
self.AssertArgumentType(callback, "function")
end
self.callback = callback
if callback then
self.AssertArgumentType(callback, "function")
end
self.callback = callback
end

-- check whether the calculation is currently running
-- even if it is not running, it might be in progress but paused - check Calculation:IsStarted() for that
function Calculation:IsRunning()
return self.running
return self.running
end

-- check whether the calculation has been started and is not finished yet
-- it might be paused, though - check Calculation:IsRunning() for that
function Calculation:IsStarted()
return self.started
return self.started
end

-- start or resume this calculation
function Calculation:Start()
if not self:IsRunning() then
if not self:IsStarted() then
-- init and run
self.elapsed = 0 -- for performance testing
self:Initialize()
end
Calculation._RunCalculation(self)
self.running = true
self.started = true
end
if not self:IsRunning() then
if not self:IsStarted() then
-- init and run
self.elapsed = 0 -- for performance testing
self:Initialize()
end
Calculation._RunCalculation(self)
self.running = true
self.started = true
end
end
Calculation.Resume = Calculation.Start

-- pause the current calculation so it can be resumed later
function Calculation:Pause()
if self:IsRunning() then
self.running = false
end
if self:IsRunning() then
self.running = false
end
end

-- abort the current calculation completely
function Calculation:Abort()
if self:IsStarted() then
self.running = false
self.started = false
end
if self:IsStarted() then
self.running = false
self.started = false
end
end
Calculation.Stop = Calculation.Abort
Calculation.Cancel = Calculation.Abort

-- set the number of combinations to check each frame
function Calculation:SetOperationsPerFrame(ops)
self.AssertArgumentType(ops, 'number')
self.AssertArgumentType(ops, 'number')

self.operationsPerFrame = ops
self.operationsPerFrame = ops
end

-- get the number of combinations being checked each frame
function Calculation:GetOperationsPerFrame()
return self.operationsPerFrame
return self.operationsPerFrame
end

-- run steps needed for initializing the calculation process
function Calculation:Initialize()
-- empty and intended to be overridden
-- empty and intended to be overridden
end

-- run single step of this calculation
function Calculation:Step()
-- empty and intended to be overridden
self:Done()
-- empty and intended to be overridden
self:Done()
end

-- run final operation of this calculation and get ready to return a result
function Calculation:Finalize()
-- empty and intended to be overridden
-- empty and intended to be overridden
end

-- mark the current calculation as finished
function Calculation:Done()
self.running = false
self.started = false
self:Finalize()
self.running = false
self.started = false
self:Finalize()

if type(self.OnComplete) == 'function' then
self:OnComplete()
end
if type(self.callback) == 'function' then
self.callback() --TODO: also send results
end
if type(self.OnComplete) == 'function' then
self:OnComplete()
end
if type(self.callback) == 'function' then
self.callback() --TODO: also send results
end
end

-- run steps consecutively
function Calculation:RunSteps()
local operation = 0
while self.running and operation < self.operationsPerFrame do
self:Step()
operation = operation + 1
end
local operation = 0
while self.running and operation < self.operationsPerFrame do
self:Step()
operation = operation + 1
end

if type(self.OnUpdate) == 'function' then
self:OnUpdate() --TODO: we should also provide the current combination and/or progress (configurable?)
end
if type(self.OnUpdate) == 'function' then
self:OnUpdate() --TODO: we should also provide the current combination and/or progress (configurable?)
end
end

-- returns a value between 0 and 1 indicating how far along the calculation is
function Calculation:GetCurrentProgress()
return 0 -- this should be overridden
return 0 -- this should be overridden
end

local calculationsFrame = CreateFrame("Frame")
function Calculation._RunCalculation(calculation)
if not ns.activeCalculations then
ns.activeCalculations = {}
end
tinsert(ns.activeCalculations, calculation)
calculationsFrame:SetScript("OnUpdate", Calculation._ContinueActiveCalculations)
if not ns.activeCalculations then
ns.activeCalculations = {}
end
tinsert(ns.activeCalculations, calculation)
calculationsFrame:SetScript("OnUpdate", Calculation._ContinueActiveCalculations)
end

function Calculation._ContinueActiveCalculations(frame, elapsed)
ns:Debug("Continue")
if #(ns.activeCalculations) < 1 then
calculationsFrame:SetScript("OnUpdate", nil)
else
for i = #(ns.activeCalculations), 1, -1 do
ns:Debug("Continue "..i)
local calculation = ns.activeCalculations[i]
if not calculation:IsRunning() then
tremove(ns.activeCalculations, i)
else
calculation.elapsed = calculation.elapsed + elapsed
calculation:RunSteps()
end
end
end
ns:Debug("Continue")
if #(ns.activeCalculations) < 1 then
calculationsFrame:SetScript("OnUpdate", nil)
else
for i = #(ns.activeCalculations), 1, -1 do
ns:Debug("Continue "..i)
local calculation = ns.activeCalculations[i]
if not calculation:IsRunning() then
tremove(ns.activeCalculations, i)
else
calculation.elapsed = calculation.elapsed + elapsed
calculation:RunSteps()
end
end
end
end

0 comments on commit 5cafaa0

Please sign in to comment.