Fixed hints being a window method but not supposed to be. Throw errors when certain things return null.

Author: ColonelThirtyTwo

build.sh

@@ -1,3 +1,3 @@
-
+#!/bin/bash
 set -e 
 gcc -E -dD -I ./gen/ ./gen/headers.h | python3 ./gen/cdef.py | cat - glfw_base.lua > glfw.lua

glfw_base.lua

@@ -37,30 +37,43 @@ Lib.glext = setmetatable({}, {
 	end,
 })
 
--- TODO: The docs say that `lib.foo` is faster than `local foo = lib.foo; foo()`, but is the overhead of a closure
+-- TODO: The docs say that `lib.foo()` is faster than `local foo = lib.foo; foo()`, but is the overhead of a closure
 -- worth it?
 local function wrap(lib, fname)
 	return function(...)
 		return lib[fname](...)
 	end
 end
 
+-- Similar to wrap, but errors if the returned object is null
+local function wrapErrorOnNull(lib, fname)
+	return function(...)
+		local obj = lib[fname](...)
+		if obj == nil then
+			error(fname.." failed",2)
+		end
+		return obj
+	end
+end
+
+-- Some buffers for out parameters
 local int_buffer = ffi.new("int[2]")
 local double_buffer = ffi.new("double[2]")
 
 ---------------------------------------------------------------------------------------------------------------------
 -- GLFW Global Functions
 
 -- C functions that don't need special handling
-Lib.terminate = wrap(glfw, "glfwTerminate")
-
-Lib.getTime            = wrap(glfw, "glfwGetTime")
-Lib.setTime            = wrap(glfw, "glfwSetTime")
 Lib.defaultWindowHints = wrap(glfw, "glfwDefaultWindowHints")
-Lib.swapInterval       = wrap(glfw, "glfwSwapInterval")
 Lib.getCurrentContext  = wrap(glfw, "glfwGetCurrentContext")
+Lib.getPrimaryMonitor  = wrapErrorOnNull(glfw, "glfwGetPrimaryMonitor")
 Lib.getProcAddress     = wrap(glfw, "glfwGetProcAddress")
+Lib.getTime            = wrap(glfw, "glfwGetTime")
+Lib.hint               = wrap(glfw, "glfwWindowHint")
 Lib.joystickPresent    = wrap(glfw, "glfwJoystickPresent")
+Lib.setTime            = wrap(glfw, "glfwSetTime")
+Lib.swapInterval       = wrap(glfw, "glfwSwapInterval")
+Lib.terminate          = wrap(glfw, "glfwTerminate")
 
 -- Functions with special Lua code
 
@@ -113,12 +126,14 @@ function Lib.getJoystickButtons(joy, arr)
 	return arr
 end
 
+-- Returns Lua string
 function Lib.getJoystickName(joy)
 	local name = glfw.glfwGetJoystickName(joy)
 	if name == nil then error("Invalid joystick: "..joy, 2) end
 	return ffi.string(name)
 end
 
+-- Returns Lua table
 function Lib.getMonitors()
 	local cmonitors = glfw.glfwGetMonitors(int_buffer)
 	if cmonitors == nil then error("glfwGetMonitors failed",2) end
@@ -130,12 +145,6 @@ function Lib.getMonitors()
 	return monitors
 end
 
-function Lib.getPrimaryMonitor()
-	local monitor = glfw.glfwGetPrimaryMonitor()
-	if monitor == nil then error("glfwGetPrimaryMonitor failed",2) end
-	return monitor
-end
-
 -- These functions can't be jit compiled, because they may call callbacks.
 -- Don't use wrap because jit.off affects the prototype, which will affect other functions too.
 Lib.pollEvents = function() return glfw.glfwPollEvents() end
@@ -159,41 +168,47 @@ function Window:__new(w, h, title, monitor, share)
 end
 
 -- C functions that don't need special handling
-Window.getAttrib                  = wrap(glfw, "glfwGetWindowAttrib")
+Window.__gc                       = wrap(glfw, "glfwDestroyWindow")
+Window.getInputMode               = wrap(glfw, "glfwGetInputMode")
+Window.getKey                     = wrap(glfw, "glfwGetKey")
 Window.getMonitor                 = wrap(glfw, "glfwGetWindowMonitor")
+Window.getMouseButton             = wrap(glfw, "glfwGetMouseButton")
 Window.hide                       = wrap(glfw, "glfwHideWindow")
 Window.iconify                    = wrap(glfw, "glfwIconifyWindow")
-Window.restore                    = wrap(glfw, "glfwRestoreWindow")
-Window.setPos                     = wrap(glfw, "glfwSetWindowPos")
-Window.setShouldClose             = wrap(glfw, "glfwSetWindowShouldClose")
-Window.setSize                    = wrap(glfw, "glfwSetWindowSize")
-Window.setTitle                   = wrap(glfw, "glfwSetWindowTitle")
-Window.show                       = wrap(glfw, "glfwShowWindow")
-Window.hint                       = wrap(glfw, "glfwWindowHint")
 Window.makeContextCurrent         = wrap(glfw, "glfwMakeContextCurrent")
-Window.swapBuffers                = wrap(glfw, "glfwSwapBuffers")
+Window.restore                    = wrap(glfw, "glfwRestoreWindow")
+Window.setCharCallback            = wrap(glfw, "glfwSetCharCallback")
 Window.setClipboardString         = wrap(glfw, "glfwSetClipboardString")
-Window.getInputMode               = wrap(glfw, "glfwGetInputMode")
-Window.setInputMode               = wrap(glfw, "glfwSetInputMode")
-Window.getKey                     = wrap(glfw, "glfwGetKey")
-Window.getMouseButton             = wrap(glfw, "glfwGetMouseButton")
-Window.setCursorPos               = wrap(glfw, "glfwSetCursorPos")
-Window.setFramebufferSizeCallback = wrap(glfw, "glfwSetFramebufferSizeCallback")
 Window.setCloseCallback           = wrap(glfw, "glfwSetWindowCloseCallback")
+Window.setCursorEnterCallback     = wrap(glfw, "glfwSetCursorEnterCallback")
+Window.setCursorPos               = wrap(glfw, "glfwSetCursorPos")
+Window.setCursorPosCallback       = wrap(glfw, "glfwSetCursorPosCallback")
 Window.setFocusCallback           = wrap(glfw, "glfwSetWindowFocusCallback")
+Window.setFramebufferSizeCallback = wrap(glfw, "glfwSetFramebufferSizeCallback")
 Window.setIconifyCallback         = wrap(glfw, "glfwSetWindowIconifyCallback")
-Window.setPosCallback             = wrap(glfw, "glfwSetWindowPosCallback")
-Window.setRefreshCallback         = wrap(glfw, "glfwSetWindowRefreshCallback")
-Window.setSizeCallback            = wrap(glfw, "glfwSetWindowSizeCallback")
+Window.setInputMode               = wrap(glfw, "glfwSetInputMode")
 Window.setKeyCallback             = wrap(glfw, "glfwSetKeyCallback")
-Window.setCharCallback            = wrap(glfw, "glfwSetCharCallback")
 Window.setMouseButtonCallback     = wrap(glfw, "glfwSetMouseButtonCallback")
-Window.setCursorPosCallback       = wrap(glfw, "glfwSetCursorPosCallback")
-Window.setCursorEnterCallback     = wrap(glfw, "glfwSetCursorEnterCallback")
+Window.setPos                     = wrap(glfw, "glfwSetWindowPos")
+Window.setPosCallback             = wrap(glfw, "glfwSetWindowPosCallback")
+Window.setRefreshCallback         = wrap(glfw, "glfwSetWindowRefreshCallback")
 Window.setScrollCallback          = wrap(glfw, "glfwSetScrollCallback")
+Window.setShouldClose             = wrap(glfw, "glfwSetWindowShouldClose")
+Window.setSize                    = wrap(glfw, "glfwSetWindowSize")
+Window.setSizeCallback            = wrap(glfw, "glfwSetWindowSizeCallback")
+Window.setTitle                   = wrap(glfw, "glfwSetWindowTitle")
+Window.show                       = wrap(glfw, "glfwShowWindow")
+Window.swapBuffers                = wrap(glfw, "glfwSwapBuffers")
 
 -- Functions with special Lua code
 
+-- Errors on zero
+function Window:getAttrib(attrib)
+	local v = glfw.glfwGetWindowAttrib(self, attrib)
+	if v == 0 then error("glfwGetWindowAttrib failed", 2) end
+	return v
+end
+
 -- Returns width, height instead of needing out parameters
 function Window:getFramebufferSize()
 	glfw.glfwGetFramebufferSize(self, int_buffer, int_buffer+1)
@@ -223,18 +238,16 @@ function Window:getCursorPos()
 	return double_buffer[0], double_buffer[1]
 end
 
+-- Returns a boolean
 function Window:shouldClose()
 	return glfw.glfwWindowShouldClose(self) ~= 0
 end
 
+-- Prevents the GC from double free'ing
 function Window:destroy()
 	glfw.glfwDestroyWindow(ffi.gc(self, nil))
 end
 
-function Window:__gc()
-	glfw.glfwDestroyWindow(self)
-end
-
 ffi.metatype(Window_t, Window)
 
 ---------------------------------------------------------------------------------------------------------------------
@@ -245,18 +258,31 @@ Monitor.__index = Monitor
 local Monitor_t = ffi.typeof("GLFWmonitor")
 Lib.Monitor = Monitor_t
 
-Monitor.setCallback = wrap(glfw, "glfwSetMonitorCallback")
+Monitor.setCallback  = wrap(glfw, "glfwSetMonitorCallback")
+Monitor.getVideoMode = wrapErrorOnNull(glfw, "glfwGetVideoMode")
 
+-- Returns x,y instead of needing out params
 function Monitor:getPos()
 	glfw.glfwGetMonitorPos(self, int_buffer, int_buffer+1)
 	return int_buffer[0], int_buffer[1]
 end
 
+-- Retruns w,h instead of needing out params
 function Monitor:getPhysicalSize()
 	glfw.glfwGetMonitorPhysicalSize(self, int_buffer, int_buffer+1)
 	return int_buffer[0], int_buffer[1]
 end
 
+-- Returns Lua table
+function Monitor:getVideoModes()
+	local carr = glfw.glfwGetVideoModes(self, int_buffer)
+	local arr = {}
+	for i=0,int_buffer[0]-1 do
+		arr[i+1] = carr[i]
+	end
+	return arr
+end
+
 ffi.metatype(Monitor_t, Monitor)
 
 ---------------------------------------------------------------------------------------------------------------------

readme.md

@@ -37,6 +37,8 @@ You can also use the following snippet to concisely localize the libraries.
 
 ```lua
 local gl, glc, glu, glfw, glext = luajit_glfw.libraries()
+-- Or if you just need the libraries:
+local gl, glc, glu, glfw, glext = require('glfw').libraries()
 ```
 
 Additionally, LuaJIT-GLFW wraps GLFW functions and sets metatypes for GLFW structs for convenience. See `glfw_base.lua`