Initial commit

Update gh-pages.yml, packaging.yml, and 6 more files...

.github/workflows/gh-pages.yml

@@ -0,0 +1,36 @@
+
+name: Deploy GitHub Pages
+
+on:
+  push:
+  pull_request:  
+  workflow_dispatch:
+
+concurrency:
+  group: cicd-docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Git submodules
+        uses: actions/checkout@v6
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - name: Build LDoc documentation
+        uses: lunarmodules/ldoc@v1.5.0
+        with:
+          args: .
+      
+      - name: Deploy documentation to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        #if: ${{ github.ref == 'refs/heads/master' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc

.github/workflows/packaging.yml

@@ -0,0 +1,44 @@
+name: Packaging Lua
+
+on:
+  push:
+  #  branches:
+  #    - master
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: packaging-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Git submodules
+        uses: actions/checkout@v6
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - name: Preparing build directory
+        run: |
+          mkdir -p build/lua
+
+      - name: Copying files
+        run: |
+          cp readme.md build/readme.md
+          cp LICENSE build/LICENSE
+          cp lua/*.lua build/lua/
+
+      - name: Upload artifact (socket.7z)
+        uses: actions/upload-artifact@v4
+        #if: ${{ github.ref == 'refs/heads/master' }}
+        with:
+          name: sleep.7z
+          path: build/
+          compression-level: 0
+          retention-days: 30

.gitignore

@@ -0,0 +1,25 @@
+# IDEs
+.vs/
+.idea/
+vs/
+
+# Runtimes
+bin/
+lua.exe
+luajit.exe
+lua51.dll
+lua/jit/
+
+# Tools
+scripts/luapack.lua
+
+# Trash
+*.pb.cfg
+*.pbi.cfg
+*.pbf.cfg
+*.exe
+
+# Build artifacts
+*.packed.lua
+*.lua.bin
+*.lua.raw

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

config.ld

@@ -0,0 +1,14 @@
+project = "LuaJIT-Sleep"
+title = "NibblePoker's LuaJIT Sleep Library"
+dir = "doc"
+format = "markdown"
+
+file = {
+  "lua/sleep.lua",
+}
+
+readme = {
+  "readme.md",
+}
+
+all = true

demo.lua

@@ -0,0 +1,11 @@
+local sleep_lib = require("sleep")
+
+print("Now sleeping for 3 seconds...")
+
+sleep_lib.sleep_s(3)
+
+print("Now sleeping for 500 milliseconds...")
+
+sleep_lib.sleep_ms(500)
+
+print("I'm back and awake")

lua/sleep.lua

@@ -0,0 +1,123 @@
+--- Pure LuaJIT bindings for Windows and Linux native `sleep` function.
+-- 
+-- @module sleep
+-- @author Herwin Bozet (NibblePoker)
+-- @license CC0 1.0 Universal (CC0 1.0) (Public Domain)
+-- @copyright 2026
+--
+-- @release 1.0.0
+
+
+-- Setup
+-- -----
+
+local ffi = require("ffi")
+
+local _is_win32 = ffi.os == "Windows"
+local _is_linux = ffi.os == "Linux"
+
+local M = {}
+
+
+
+-- Config
+-- ------
+
+--- Allows you to ignore errors about negative numbers and others returned by the OS.
+M.ignore_errors = false
+
+
+
+-- Private globals
+-- ---------------
+
+-- @function _win32_sleep
+local _win32_sleep
+
+-- @function _linux_nanosleep
+local _linux_nanosleep
+
+
+
+-- Bindings
+-- --------
+
+if _is_win32 then
+    -- Documentation:
+    --  * https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-sleep
+
+    local _kernel32_lib = ffi.load("kernel32")
+
+    ffi.cdef [[
+        typedef unsigned long DWORD;
+        void Sleep(DWORD dwMilliseconds);
+    ]]
+
+    _win32_sleep = _kernel32_lib.Sleep
+
+elseif _is_linux then
+    -- Documentation:
+    --  * https://man7.org/linux/man-pages/man3/sleep.3.html
+    --  * https://man7.org/linux/man-pages/man2/nanosleep.2.html
+
+    ffi.cdef [[
+        typedef long time_t;
+    
+        typedef struct {
+            time_t tv_sec;
+            long   tv_nsec;
+        } timespec_t;
+    
+        int nanosleep(const timespec_t *req, timespec_t *rem);
+    ]]
+
+    _linux_nanosleep = ffi.C.nanosleep
+
+else
+    error("Library must be used on Win32 or Linux platforms ! (os: " .. ffi.os .. ")")
+end
+
+
+
+-- Wrappers
+-- --------
+
+--- Sleeps for a given amount of milliseconds and returns. \
+--- May be interrupted by the OS.
+--- @param milliseconds number Amount of milliseconds to sleep.
+function M.sleep_ms(milliseconds)
+    if milliseconds < 0 then
+        if M.ignore_errors then
+            milliseconds = 0
+        else
+            error("milliseconds: argument must be a non-negative integer")
+        end
+    end
+
+    if _is_win32 then
+        _win32_sleep(milliseconds)
+    elseif _is_linux then
+        -- timespec_t { seconds, milliseconds_left_as_ns }
+        local req = ffi.new(
+            "timespec_t", math.floor(milliseconds / 1000), (milliseconds % 1000) * 1e6
+        )
+
+        if _linux_nanosleep(req, nil) ~= 0 then
+            if not M.ignore_errors then
+                error(string.format("sleep_ms: sleep: nanosleep failed (errno %d)", ffi.errno()))
+            end
+        end
+    else
+        error("Library must be used on Win32 or Linux platforms ! (os: " .. ffi.os .. ")")
+    end
+end
+
+--- Sleeps for a given amount of seconds and returns. \
+--- May be interrupted by the OS.
+--- @param seconds number Amount of seconds to sleep.
+function M.sleep_s(seconds)
+    return M.sleep_ms(seconds * 1000)
+end
+
+
+return M

readme.md

@@ -0,0 +1,52 @@
+# LuaJIT - Sleep
+Pure LuaJIT bindings and wrappers for native sleep functions on Win32 and Linux.
+
+**📢 This is library is in low maintenance mode** \
+I consider it feature-complete, and unless a bug is found, I don't plan on updating it.
+
+
+## Features
+* Second-level sleeps
+* Millisecond-level sleeps
+* Ability to supress all errors
+
+
+## Requirements
+* A somewhat modern OS
+    * Windows XP or newer *(x86/x64) (Untested on ARM32/ARM64)*
+    * Windows Server 2003 or newer *(x86/x64) (Untested on ARM32/ARM64)*
+    * Linux 4.4+ *(x86/x64) (Untested on ARM32/ARM64/RISCV/...)*
+* *LuaJIT v2.1.*
+
+
+## Installation
+
+### Manual
+1. Download the [latest release](https://github.com/aziascreations/LuaJIT-Sleep/releases).
+2. Extract the content of the archive in your `lua/` folder.
+
+### LuaRocks
+* TODO: Will be done soon-ish
+
+
+## Example
+
+```lua
+local sleep_lib = require("sleep")
+
+print("Now sleeping for 3 seconds...")
+
+sleep_lib.sleep_s(3)
+
+print("Now sleeping for 500 milliseconds...")
+
+sleep_lib.sleep_ms(500)
+
+print("I'm back and awake")
+```
+
+
+## License
+
+The code in this repository is licensed under
+[CC0 1.0 Universal (CC0 1.0) (Public Domain)](LICENSE).