Merge remote-tracking branch 'refs/remotes/origin/Add-ccEvents' into Add-ccEvents

Author: ChristophLHR

README.md

@@ -7,6 +7,7 @@ This emulates the basic ccTweaked functions missing in basic-lua.
 - vector-functions
 - settings
   - (no validations what so ever as of yet)
+- os.pullEvent etc.
 
 Additionally it emulates our **[scm](https://github.com/mc-cc-scripts/script-manager)** script and includes the **[json](https://gist.github.com/tylerneylon/59f4bcf316be525b30ab)** handler - which makes tests a lot easier.
 
@@ -34,6 +35,10 @@ local scriptToTest = require("scriptToTest")
 -- without any need to modify the script you want to test
 ```
 
+#### os
+[how to test with os functions](docs/ccOS.md)
+
+
 ### How to import these scripts
 
 For how to import the scipts, an example is already used by this repo for some of ITS dependancies (which you will also need):

events.lua renamed to ccOS.lua

@@ -28,15 +28,15 @@ local class = require("ccClass")
 ---@field waiting boolean To confirm if a function was actually called or is just wrapped.
 -- Relevant for Events.run, as it resumes ALL coroutines - therefore invoking each method if not for this check
 
----@class ccEvent : subThread
+---@class ccOS : subThread
 ---@field FIFOEventList Event[]
 ---@field TimerList timerList
 ---@field subThreads table<string, subThread>
 ---@field time number eq. os.time("ingame") from ccTweaked)
 ---@field epoch number eq. os.epoch("ingame") from ccTweaked)
-local Events = class(
+local ccOS = class(
     function(baseClass)
-        ---@cast baseClass ccEvent
+        ---@cast baseClass ccOS
         baseClass.FIFOEventList = {}
         baseClass.TimerList = {timers = {}, currentID = 1}
         baseClass.time = 0
@@ -48,7 +48,7 @@ local Events = class(
 ---comment
 ---@param threadHolder subThread
 ---@param ... any
-function Events:resumeThread(threadHolder, ...)
+function ccOS:resumeThread(threadHolder, ...)
     local ok
     local wrapper
     local result
@@ -77,9 +77,9 @@ end
 ---@param wrapModule? boolean This will modify the Module!
 ---@param ... any If loading a Module, these are the parameters
 ---@return T|nil result if module is wrapped, it returns the wrapped module. 
-function Events:wrap(func, wrapModule, ...)
+function ccOS:wrap(func, wrapModule, ...)
     assert(self.subThreads, "Do not use Eventclass, create an Event-Object via 'local eventObj = ccEvent()'")
-    local manager = self
+    local ccOSInstance = self
     local env = {}
         ---@class EventOS: oslib
     env.os = setmetatable({
@@ -95,15 +95,31 @@ function Events:wrap(func, wrapModule, ...)
             return table.unpack(event)
         end,
         queueEvent = function(name, ...)
-            manager:invoke(name, ...)
+            ccOSInstance:invoke(name, ...)
         end,
         startTimer = function(time)
-            assert(type(time) == "number")
-            return manager:addTimer(time)
+            assert(type(time) == "number" ,type(time))
+            return ccOSInstance:addTimer(time)
         end,
         cancleTimer = function(id)
-            manager:removeTimer(id)
-        end
+            ccOSInstance:removeTimer(id)
+        end,
+        sleep = function(time)
+            local expectedId = env.os.startTimer(time)
+            local correctTimer = false
+            while not correctTimer do
+                local _, id = env.os.pullEvent("timer")
+                correctTimer = id == expectedId
+            end
+        end,
+        time = function()
+            -- TODO: add locale
+            return ccOSInstance.time
+        end,
+        epoch = function()
+            -- TODO: add args
+            return ccOSInstance.epoch
+        end,
 
     }, {__index = os})
     setmetatable(env, {__index = _G})
@@ -167,7 +183,7 @@ end
 
 ---@param time number seconds
 ---@return number timerID
-function Events:addTimer(time)
+function ccOS:addTimer(time)
     assert(type(time) == "number" and time > 0)
     local triggerAfter = time * 1000 + self.epoch - 1
     local id = self.TimerList.currentID
@@ -176,19 +192,19 @@ function Events:addTimer(time)
     return id
 end
 
-function Events:removeTimer(id)
+function ccOS:removeTimer(id)
     assert(type(id) == "number")
     for k,v in pairs(self.TimerList.timers) do
         if v.id == id then
-            self.TimerList.currentID[id] = nil
+            self.TimerList.timers[id] = nil
         end
     end
 end
 
 ---Passes time (in Seconds)
 ---Required for timers
 ---@param time number seconds
-function Events:passTime(time)
+function ccOS:passTime(time)
     assert(type(time) == "number")
     time = time * 1000
     self.time = (self.time + (time / 60 / 24)) % 24
@@ -203,14 +219,14 @@ function Events:passTime(time)
 
 end
 
-function Events:invoke(eventName, ...)
+function ccOS:invoke(eventName, ...)
     ---@type Event
     local event = {eventName = eventName, receivedBy = {}, eventArgs = {...}}
     table.insert(self.FIFOEventList, event)
     self:checkForUpdates()
 end
 
-function Events:checkForUpdates()
+function ccOS:checkForUpdates()
     local modifier = 0
 
     local removeEvent = function(i)
@@ -243,4 +259,4 @@ function Events:checkForUpdates()
 end
 
 
-return Events
+return ccOS

docs/ccOS.md

@@ -0,0 +1,55 @@
+# OS
+
+Restrictions:
+---
+
+__YOU CANNOT USE EVENTS GLOBALLY.__
+
+_You cannot yield the "main" coroutine, therefore os.pullevent() cannot just be set globally.
+Therefore You need to wrap everything you intent to run in the wrapper._
+
+___Modules CANNOT yield outside of their fields__
+
+```lua 
+local TestModule = {}
+-- ...
+coroutine.yield() -- <- Breaks the EventManager, as the module cannot be wrapped
+-- ...
+return TestModule
+```
+
+
+## How to use
+
+### for functions
+```lua
+-- import 
+local osEmulator = require("ccOS")
+
+-- create instance
+local osInstance = osEmulator()
+
+local testFunction = osInstance:wrap(function()
+    os.pullEvent("CustomEvent")
+    print("Event got called")
+end)
+
+testFunction() -- < Programm yields until event gets invoked, in the instances' thread
+osInstance:invoke("CustomEvent") -- < Programm continues -> prints: "Event got called"
+
+```
+
+### for Modules
+```lua
+local osEmulator = require("ccOS")
+-- create instance
+local osInstance = osEmulator()
+
+local moduleFile = loadfile("pathToFile","t")
+local testModule = osInstance:wrap(moduleFile, true, ...)
+-- <true> tells the wrapper to wrap all functioncalls, so they run in a coroutine thread, instead of the callers thread
+-- <...> as the module will need to be called once, you can provide additional parameters as need
+
+testModule:someFunction(...)
+-- the function will now run on the osInstance-Thread, knowing all currently implemented os-Functions
+```