WIP Added ccEvents

Author: ChristophLHR

.github/workflows/test.yml

@@ -13,12 +13,12 @@ jobs:
     - name: get lua
       uses: leafo/gh-actions-lua@v10
       with: 
-        luaVersion: "5.1"
+        luaVersion: "5.2"
 
     - name: get luarocks
       uses: leafo/gh-actions-luarocks@v4
       with: 
-        luaVersion: "5.1"
+        luaVersion: "5.2"
 
     - name: get busted and luasocket
       run: |

events.lua

@@ -0,0 +1,126 @@
+local class = require("ccClass")
+
+---@class Event
+---@field eventName string
+---@field eventArgs table | nil
+---@field receivedBy table
+
+---@class timer
+---@field id number
+---@field triggerAfter number
+
+---@class timerList
+---@field timers timer[]
+---@field currentID number
+
+---@class ccEvent
+---@field FIFOEventList Event[]
+---@field FIFOTimerList timerList
+---@field co thread
+---@field time number eq. os.time("ingame") from ccTweaked)
+---@field epoch number eq. os.epoch("ingame") from ccTweaked)
+---@field private tmpObj any
+local Events = {}
+
+---@param path string
+---@return ccEvent
+---@return table loadedModule
+function Events:new(path)
+
+    local eventObj = class(function(baseClass)
+        ---@cast baseClass ccEvent
+        baseClass.FIFOEventList = {}
+        baseClass.FIFOTimerList = {timers = {}, currentID = 1}
+        baseClass.time = 0
+        baseClass.epoch = 0
+        
+    end)()
+    
+    local env = {}
+        ---@class EventOS: oslib
+    env.os = setmetatable({
+
+        pullEvent = function(name)
+            local t = {coroutine.yield(name)}
+            while not t or (name and t[1] ~= name) do
+                t = {coroutine.yield(name, "does not match")}
+            end
+            return table.unpack(t)
+        end,
+        queueEvent = function(name, ...)
+            eventObj:invoke(name, arg)
+        end,
+        startTimer = function(time)
+            return eventObj:addTimer(time)
+        end,
+        cancleTimer = function(id)
+            eventObj:removeTimer(id)
+        end
+
+    }, {__index = os})
+    setmetatable(env, {__index = _G})
+    
+    print("stuff", env.os.pullEvent)
+    local func = assert(loadfile(path, "t", env))
+    print("func", func)
+
+    eventObj.co = coroutine.create(function ()
+        return func()
+    end)
+    local _, loadedModule = coroutine.resume(eventObj.co)
+    return eventObj, loadedModule
+end
+
+
+
+---@param ccEvent ccEvent
+local run = coroutine.create(function(ccEvent)
+    while true do
+        while #ccEvent.FIFOEventList > 0 and coroutine.status(ccEvent.co) == "suspended" do
+            coroutine.resume(ccEvent.co, table.remove(ccEvent.FIFOEventList, 1))
+            -- just empty the list until an event was valid OR no Events are left
+        end
+        coroutine.yield("tick")
+    end
+end)
+
+function Events:addTimer(time)
+    local triggerAt = time * 1000 + self.epoch
+    local id = self.FIFOTimerList.currentID
+    self.FIFOTimerList.currentID = self.FIFOTimerList.currentID + 1
+    table.insert(self.FIFOTimerList.timers, {triggerAt = triggerAt, id = id})
+    return id
+end
+
+function Events:removeTimer(id)
+    for k,v in pairs(self.FIFOTimerList.timers) do
+        if v.id == id then
+            self.FIFOTimerList.currentID[id] = nil
+        end
+    end
+end
+
+---Passes time (in Seconds)
+---Required for timers
+---@param time number seconds
+function Events:passTime(time)
+    self.time = (self.time + (time / 60 / 24)) % 24
+    self.epoch = self.epoch + time
+
+    for key, value in pairs(self.FIFOTimerList.timers) do
+        if value.triggerAfter <= self.epoch then
+            self:invoke("timer", value.id)
+        end
+    end
+
+end
+
+function Events:invoke(eventName, ...)
+    ---@type Event
+    local event = {eventName = eventName, receivedBy = {}, eventArgs = arg}
+    table.insert(self.FIFOEventList, event)
+    self.newEventAdded = true
+    coroutine.resume(run, "tick")
+end
+
+return Events

files.txt

@@ -4,4 +4,5 @@ fs.lua
 json.lua
 scm.lua
 textutils.lua
-settings.lua
+settings.lua
+events.lua

t.lua

@@ -0,0 +1,6 @@
+local co = coroutine.create(function (a,b)
+        local t = coroutine.yield("a")
+        print("t", t)
+        end)
+print(coroutine.resume(co, "b"))
+print(coroutine.resume(co, "b"))

tests/event_spec.lua

@@ -0,0 +1,51 @@
+---@class are
+---@field same string
+---@field equal string
+---@field equals string
+
+---@class is
+---@field truthy string
+---@field falsy string
+---@field not_true string
+---@field not_false string
+
+---@class has
+---@field error string
+---@field errors string
+
+---@class assert
+---@field are are
+---@field is is
+---@field are_not are
+---@field is_not is
+---@field has has
+---@field has_no has
+---@field True string
+---@field False string
+---@field has_error string
+---@field is_false string
+---@field is_true string
+---@field equal string
+assert = assert
+
+package.path = package.path .. ";"
+    .."libs/?.lua;"
+
+local EventEmulator = require("events")
+
+describe("Event-Tests", function ()
+    ---@type ccEvent, TestFile
+    local eventManager, testModule
+    before_each(function()
+        eventManager, testModule = EventEmulator:new("tests/testFiles/event_testFile.lua")
+    end)
+    describe("Basics", function()
+        it("pull And Invoke", function()
+            assert(type(testModule)=="table", type(testModule))
+            testModule:event1()
+            assert.is.falsy(testModule.status.event1)
+            eventManager:invoke("TestEvent")
+            assert.is.truthy(testModule.status.event1)
+        end)
+    end)
+end)

tests/settings_spec.lua

@@ -1,17 +1,17 @@
 ---@class are
----@field same function
----@field equal function
----@field equals function
+---@field same string
+---@field equal string
+---@field equals string
 
 ---@class is
----@field truthy function
----@field falsy function
----@field not_true function
----@field not_false function
+---@field truthy string
+---@field falsy string
+---@field not_true string
+---@field not_false string
 
 ---@class has
----@field error function
----@field errors function
+---@field error string
+---@field errors string
 
 ---@class assert
 ---@field are are
@@ -20,12 +20,12 @@
 ---@field is_not is
 ---@field has has
 ---@field has_no has
----@field True function
----@field False function
----@field has_error function
----@field is_false function
----@field is_true function
----@field equal function
+---@field True string
+---@field False string
+---@field has_error string
+---@field is_false string
+---@field is_true string
+---@field equal string
 assert = assert
 
 

tests/testFiles/event_testFile.lua

@@ -0,0 +1,15 @@
+---@class TestFile
+local TestFile = {
+    status = {}
+}
+
+function TestFile:event1()
+    print("os.execute", os.execute)
+    print("os.pullEvent", os.pullEvent)
+    os.pullEvent()
+    self.status.event1 = "Fired"
+end
+
+
+
+return TestFile

vector.lua

@@ -1,23 +1,23 @@
----@type function
+---@type string
 local class = require("ccClass")
 
 ---@class Vector
 ---@field x number
 ---@field y number
 ---@field z number
----@field new function @Create a new Vector
----@field add function @Add two vectors
----@field sub function @Subtract two vectors
----@field mul function @Multiply by value
----@field div function @Divide by value
----@field unm function @negate the vector
----@field dot function @dot product of two vectors
----@field cross function @cross product of two vectors
----@field length function @magnitude / length of the vector
----@field norm function @normalize the vector
----@field round function @round the vector
----@field toString function @Returns a String of the vector
----@field equals function @check if two vectors are equal
+---@field new string @Create a new Vector
+---@field add string @Add two vectors
+---@field sub string @Subtract two vectors
+---@field mul string @Multiply by value
+---@field div string @Divide by value
+---@field unm string @negate the vector
+---@field dot string @dot product of two vectors
+---@field cross string @cross product of two vectors
+---@field length string @magnitude / length of the vector
+---@field norm string @normalize the vector
+---@field round string @round the vector
+---@field toString string @Returns a String of the vector
+---@field equals string @check if two vectors are equal
 
 ---@type Vector
 ---@diagnostic disable-next-line: missing-fields