root/lu/LUTask.lua

--------------------------------------------------------------------------------
-- Title:               LUTask.lua
-- Description:         Like a square peg in a round hole
-- Author:              Raphaël Szwarc http://alt.textdrive.com/lua/
-- Creation Date:       February 1, 2005
-- Legal:               Copyright (C) 2005 Raphaël Szwarc
--------------------------------------------------------------------------------

-- import dependencies
local LUObject = require( "LUObject" )
local LURunLoop = require( "LURunLoop" )
local LULog = require( "LULog" )
local coroutine = require( "coroutine" )

-- define the class
local super = LUObject
local self = super()

-- class variable(s)
local _currentTask = nil

-- method to access the current task
function self:currentTask()
        return _currentTask
end

-- initialization method
function self:init( aTarget, aRunLoop )
        self = super.init( self )

        self._target = aTarget
        self._runloop = aRunLoop
        
        return self
end
        
-- method to create a (co)routine
function self:routine()
        if self._routine == nil then
                local aFunction = function()                        
                        self:target():run() 
                end
        
                self._routine = coroutine.create( aFunction )
        end
        
        return self._routine
end

-- method to 'run' the coroutine by registering it with the class run loop
function self:run()
        if self._routine == nil then
                self:routine()
                
                self:runloop():addTask( self )
        end
        
        return self
end

 -- method to access this task run loop
function self:runloop()
        if self._runloop == nil then
                self._runloop = LURunLoop:default()
        end
        
        return self._runloop
end

 -- method to access this task target
function self:target()
        return self._target
end

-- method to return the coroutine status
function self:status()
        local aRoutine = self._routine

        if aRoutine ~= nil then
                return coroutine.status( aRoutine )
        end
        
        return nil
end

-- method to resume the coroutine
function self:resume( ... )
        local aRoutine = self._routine

        if aRoutine ~= nil then
                _currentTask = self
        
                local aStatus, aMessage = coroutine.resume( aRoutine, ... )
                
                _currentTask = nil
                
                if aStatus == false then
                        LULog:warning( aMessage )
                end
                
                return aStatus, aMessage
        end

        return nil
end

-- method to yield the coroutine
function self:yield( ... )
        return coroutine.yield( ... )
end

return self