feature: Added support for FreeBSD, NetBSD, OpenBSD and DragonFly.

luau-project · luau-project · commit 75d62877f428 · 2024-11-15T17:16:55.000-03:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ on:
       - "docs/**"
 
 env:
-  ROCKSPEC_VERSION: 0.0.3
+  ROCKSPEC_VERSION: 0.0.4
   DEV_ROCKSPEC: lua-uuid-dev-1.rockspec
 
 jobs:
diff --git a/README.md b/README.md
@@ -6,9 +6,9 @@
 
 **lua-uuid** is a lightweight, native library for Lua (5.1 and newer) to deal with Universally Unique Id (UUID).
 
-* On Linux, it uses ```libuuid``` to generate UUIDs;
+* On Linux and BSD, it uses ```libuuid``` to generate UUIDs;
 * On Windows, it uses the WINAPI ```rpcrt4``` library;
-* On MacOS / iOS, it uses the ```CoreFoundation``` framework.
+* On macOS / iOS, it uses the ```CoreFoundation``` framework.
 
 ## Table of Contents
 
@@ -33,19 +33,25 @@
 
 > [!IMPORTANT]
 > 
-> On Linux, ```lua-uuid``` depends on ```libuuid```:
+> On Linux and BSD, ```lua-uuid``` depends on ```libuuid```:
 > 
-> * On Debian-based distributions:
+> * On Debian-based (e.g: Ubuntu) distributions:
 > 
 >     ```bash
 >     sudo apt install -y uuid-dev
 >     ```
 > 
-> * On RedHat-based distributions:
+> * On RedHat-based (e.g: Fedora) distributions:
 > 
 >     ```bash
 >     sudo dnf install libuuid-devel
 >     ```
+> 
+> * On BSD-based (e.g: FreeBSD) distributions:
+> 
+>     ```bash
+>     pkg install e2fsprogs-libuuid
+>     ```
 
 Assuming that [LuaRocks](https://luarocks.org/) is properly installed and configured on your system, execute the following command:
 
@@ -165,7 +171,7 @@ print(id3:isnil())
 
 ### parse
 
-* *Description*: Generates a new GUID / UUID from a string value
+* *Description*: Parses a GUID / UUID from a string value
 * *Signature*: ```parse(value)```
     * *value* (string): the string to be parsed
     * *return*: ```(userdata)```
@@ -207,8 +213,11 @@ print(id3:isnil())
 
 ## Change log
 
+* v0.0.4:
+    * Added support for BSD (e.g: FreeBSD, NetBSD, OpenBSD and DragonFly);
+    * Moved ```#include <lua.h>``` and ```LUA_UUID_EXPORT``` macro definition to outside of ```__cplusplus``` declarations on ```lua-uuid.h```.
 * v0.0.3:
-    * Changed to throw issue when ```lua_newuserdata``` returns ```NULL```;
+    * Changed to throw error when ```lua_newuserdata``` returns ```NULL```;
     * Added macro ```LUA_UUID_BUILD_SHARED``` to ```CFLAGS_EXTRA``` on macos;
     * Changed ```luajit-master``` to ```luajit``` on CI when testing for ```LuaJIT```;
     * Added print statements on [tostring.lua](./samples/tostring.lua) sample;
diff --git a/rockspecs/lua-uuid-0.0.4-0.rockspec b/rockspecs/lua-uuid-0.0.4-0.rockspec
@@ -0,0 +1,105 @@
+package = "lua-uuid"
+version = "0.0.4-0"
+
+source = {
+    url = "git://github.com/luau-project/lua-uuid.git",
+    tag = "v0.0.4"
+}
+
+description = {
+    homepage = "https://github.com/luau-project/lua-uuid",
+    summary = [[Lightweight, native GUID / UUID library for Lua]],
+    detailed = [=[
+lua-uuid is a lightweight, native library for Lua (5.1 and newer) to deal with Universally Unique Id (UUID).
+
+* On Linux and BSD, it uses libuuid to generate UUIDs;
+* On Windows, it uses the WINAPI rpcrt4 library;
+* On macOS / iOS, it uses the CoreFoundation framework.
+
+Visit the GitHub repository for more information.]=],
+    license = "MIT"
+}
+
+supported_platforms = { "linux", "windows", "cygwin", "macosx", "bsd" }
+
+dependencies = {
+    "lua >= 5.1"
+}
+
+external_dependencies = {
+    platforms = {
+        linux = {
+            ["UUID"] = {
+                header = "uuid/uuid.h"
+            }
+        },
+        bsd = {
+            ["UUID"] = {
+                header = "uuid/uuid.h"
+            }
+        }
+    }
+}
+
+local function build_plat(plat)
+    if (plat == "linux" or plat == "bsd") then
+        return {
+            type = "builtin",
+            modules = {
+                ["lua-uuid"] = {
+                    sources = { "src/lua-uuid.c" },
+                    libraries = { "uuid" },
+                    defines = { "LUA_UUID_BUILD_SHARED", "LUA_UUID_USE_LIBUUID" },
+                    incdirs = { "src", "$(UUID_INCDIR)" },
+                    libdirs = { "$(UUID_LIBDIR)" }
+                }
+            }
+        }
+    elseif (plat == "windows" or plat == "cygwin") then
+        return {
+            type = "builtin",
+            modules = {
+                ["lua-uuid"] = {
+                    sources = { "src/lua-uuid.c" },
+                    libraries = { "rpcrt4" },
+                    defines = { "LUA_UUID_BUILD_SHARED", "LUA_UUID_USE_WIN32" },
+                    incdirs = { "src" },
+                    libdirs = { }
+                }
+            }
+        }
+    elseif (plat == "macosx") then
+        return {
+            type = "make",
+            makefile = "Makefile.macosx",
+            build_variables = {
+                CFLAGS = "$(CFLAGS)",
+                LIBFLAG = "$(LIBFLAG)",
+                CFLAGS_EXTRA = "-DLUA_UUID_BUILD_SHARED -DLUA_UUID_USE_APPLE",
+                LIBFLAG_EXTRA = "-framework CoreFoundation",
+                LUA_INCDIR = "$(LUA_INCDIR)",
+                LUA_LIBDIR = "$(LUA_INCDIR)/../lib",
+                OBJ_EXTENSION = "$(OBJ_EXTENSION)",
+                LIB_EXTENSION = "$(LIB_EXTENSION)"
+            },
+            install_variables = {
+                INSTALL_PREFIX = "$(PREFIX)",
+                INSTALL_LIBDIR = "$(LIBDIR)",
+                LUA_VERSION = "$(LUA_VERSION)",
+                LIB_EXTENSION = "$(LIB_EXTENSION)"
+            }
+        }
+    else
+        error("Unknown platform", 2)
+    end
+end
+
+build = {
+    platforms = {
+        linux = build_plat("linux"),
+        windows = build_plat("windows"),
+        cygwin = build_plat("cygwin"),
+        macosx = build_plat("macosx"),
+        bsd = build_plat("bsd")
+    }
+}
diff --git a/rockspecs/lua-uuid-dev-1.rockspec b/rockspecs/lua-uuid-dev-1.rockspec
@@ -11,15 +11,15 @@ description = {
     detailed = [=[
 lua-uuid is a lightweight, native library for Lua (5.1 and newer) to deal with Universally Unique Id (UUID).
 
-* On Linux, it uses libuuid to generate UUIDs;
+* On Linux and BSD, it uses libuuid to generate UUIDs;
 * On Windows, it uses the WINAPI rpcrt4 library;
-* On MacOS / iOS, it uses the CoreFoundation framework.
+* On macOS / iOS, it uses the CoreFoundation framework.
 
 Visit the GitHub repository for more information.]=],
     license = "MIT"
 }
 
-supported_platforms = { "linux", "win32", "mingw", "cygwin", "macosx" }
+supported_platforms = { "linux", "windows", "cygwin", "macosx", "bsd" }
 
 dependencies = {
     "lua >= 5.1"
@@ -31,12 +31,17 @@ external_dependencies = {
             ["UUID"] = {
                 header = "uuid/uuid.h"
             }
+        },
+        bsd = {
+            ["UUID"] = {
+                header = "uuid/uuid.h"
+            }
         }
     }
 }
 
-local function make_plat(plat)
-    if (plat == "linux") then
+local function build_plat(plat)
+    if (plat == "linux" or plat == "bsd") then
         return {
             type = "builtin",
             modules = {
@@ -49,7 +54,7 @@ local function make_plat(plat)
                 }
             }
         }
-    elseif (plat == "win32" or plat == "mingw" or plat == "cygwin") then
+    elseif (plat == "windows" or plat == "cygwin") then
         return {
             type = "builtin",
             modules = {
@@ -58,7 +63,7 @@ local function make_plat(plat)
                     libraries = { "rpcrt4" },
                     defines = { "LUA_UUID_BUILD_SHARED", "LUA_UUID_USE_WIN32" },
                     incdirs = { "src" },
-                    libdirs = {}
+                    libdirs = { }
                 }
             }
         }
@@ -90,10 +95,10 @@ end
 
 build = {
     platforms = {
-        linux = make_plat("linux"),
-        win32 = make_plat("win32"),
-        mingw = make_plat("mingw"),
-        cygwin = make_plat("cygwin"),
-        macosx = make_plat("macosx")
+        linux = build_plat("linux"),
+        windows = build_plat("windows"),
+        cygwin = build_plat("cygwin"),
+        macosx = build_plat("macosx"),
+        bsd = build_plat("bsd")
     }
 }
diff --git a/src/lua-uuid.h b/src/lua-uuid.h
@@ -1,9 +1,7 @@
 #ifndef LUA_UUID_H
 #define LUA_UUID_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+#include <lua.h>
 
 #ifdef LUA_UUID_BUILD_STATIC
     #define LUA_UUID_EXPORT
@@ -31,7 +29,9 @@ extern "C" {
     #endif
 #endif
 
-#include <lua.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 LUA_UUID_EXPORT
 int luaopen_uuid(lua_State *L);

Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,15 @@ description = {`
`11`	`11`	`detailed = [=[`
`12`	`12`	`lua-uuid is a lightweight, native library for Lua (5.1 and newer) to deal with Universally Unique Id (UUID).`
`13`	`13`
`14`		`-* On Linux, it uses libuuid to generate UUIDs;`
	`14`	`+* On Linux and BSD, it uses libuuid to generate UUIDs;`
`15`	`15`	`* On Windows, it uses the WINAPI rpcrt4 library;`
`16`		`-* On MacOS / iOS, it uses the CoreFoundation framework.`
	`16`	`+* On macOS / iOS, it uses the CoreFoundation framework.`
`17`	`17`
`18`	`18`	`Visit the GitHub repository for more information.]=],`
`19`	`19`	`license = "MIT"`
`20`	`20`	`}`
`21`	`21`
`22`		`-supported_platforms = { "linux", "win32", "mingw", "cygwin", "macosx" }`
	`22`	`+supported_platforms = { "linux", "windows", "cygwin", "macosx", "bsd" }`
`23`	`23`
`24`	`24`	`dependencies = {`
`25`	`25`	`"lua >= 5.1"`
`@@ -31,12 +31,17 @@ external_dependencies = {`
`31`	`31`	`["UUID"] = {`
`32`	`32`	`header = "uuid/uuid.h"`
`33`	`33`	`}`
	`34`	`+ },`
	`35`	`+ bsd = {`
	`36`	`+ ["UUID"] = {`
	`37`	`+ header = "uuid/uuid.h"`
	`38`	`+ }`
`34`	`39`	`}`
`35`	`40`	`}`
`36`	`41`	`}`
`37`	`42`
`38`		`-local function make_plat(plat)`
`39`		`- if (plat == "linux") then`
	`43`	`+local function build_plat(plat)`
	`44`	`+ if (plat == "linux" or plat == "bsd") then`
`40`	`45`	`return {`
`41`	`46`	`type = "builtin",`
`42`	`47`	`modules = {`
`@@ -49,7 +54,7 @@ local function make_plat(plat)`
`49`	`54`	`}`
`50`	`55`	`}`
`51`	`56`	`}`
`52`		`- elseif (plat == "win32" or plat == "mingw" or plat == "cygwin") then`
	`57`	`+ elseif (plat == "windows" or plat == "cygwin") then`
`53`	`58`	`return {`
`54`	`59`	`type = "builtin",`
`55`	`60`	`modules = {`
`@@ -58,7 +63,7 @@ local function make_plat(plat)`
`58`	`63`	`libraries = { "rpcrt4" },`
`59`	`64`	`defines = { "LUA_UUID_BUILD_SHARED", "LUA_UUID_USE_WIN32" },`
`60`	`65`	`incdirs = { "src" },`
`61`		`- libdirs = {}`
	`66`	`+ libdirs = { }`
`62`	`67`	`}`
`63`	`68`	`}`
`64`	`69`	`}`
`@@ -90,10 +95,10 @@ end`
`90`	`95`
`91`	`96`	`build = {`
`92`	`97`	`platforms = {`
`93`		`- linux = make_plat("linux"),`
`94`		`- win32 = make_plat("win32"),`
`95`		`- mingw = make_plat("mingw"),`
`96`		`- cygwin = make_plat("cygwin"),`
`97`		`- macosx = make_plat("macosx")`
	`98`	`+ linux = build_plat("linux"),`
	`99`	`+ windows = build_plat("windows"),`
	`100`	`+ cygwin = build_plat("cygwin"),`
	`101`	`+ macosx = build_plat("macosx"),`
	`102`	`+ bsd = build_plat("bsd")`
`98`	`103`	`}`
`99`	`104`	`}`