Allow cursors to be loaded at full size + Add destroyCursor() method

Author: ANSH3LL

Corona/cursor3.ani

@@ -4,7 +4,7 @@ local cursor = require('plugin.hwcursor')
 local hidden = false
 cursor.initPlugin()
 
--- New in this branch
+-- New in this version
 
 -- Call cursor.loadCursor the first time with the path to the cursor
 -- and store the return value, which is a pointer to the cursor resource (preload step)
@@ -14,8 +14,9 @@ cursor.initPlugin()
 
 -- Cursors must be preloaded before being used
 local cursors = {
-    cursor1 = cursor.loadCursor(system.pathForFile('cursor1.cur')),
-    cursor2 = cursor.loadCursor(system.pathForFile('cursor2.ani'))
+    cursor1 = cursor.loadCursor(system.pathForFile('cursor1.cur')), -- Bigger than normal
+    cursor2 = cursor.loadCursor(system.pathForFile('cursor2.ani')), -- Regular size
+    cursor3 = cursor.loadCursor(system.pathForFile('cursor3.ani'))  -- Huge (256x256)
 }
 
 display.newText(
@@ -80,6 +81,21 @@ widget.newButton(
         shape = 'roundedRect',
         x = display.contentCenterX,
         y = display.contentCenterY + 50,
+        label = 'Custom cursor 3',
+        -- Set cursor using stored pointer
+        onRelease = function() cursor.loadCursor(cursors.cursor3) end,
+        labelColor = { default = { 1, 1, 1 }, over = { 0, 0, 0, 0.5 } },
+        fillColor = { default = { 1, 0.2, 0.5, 0.7 }, over = { 1, 0.2, 0.5, 1 } }
+    }
+)
+
+widget.newButton(
+    {
+        width = 200,
+        height = 30,
+        shape = 'roundedRect',
+        x = display.contentCenterX,
+        y = display.contentCenterY + 100,
         label = 'Show/Hide cursor',
         onRelease = function()
             if hidden then
@@ -100,10 +116,14 @@ widget.newButton(
         height = 30,
         shape = 'roundedRect',
         x = display.contentCenterX,
-        y = display.contentCenterY + 100,
+        y = display.contentCenterY + 150,
         label = 'Exit application',
         onRelease = function()
-            cursor.resetCursor()
+            -- Destroy all cursors before exiting
+            for k, v in pairs(cursors) do
+                cursor.destroyCursor(v)
+                cursors[k] = nil
+            end
             cursor.freePlugin()
             native.requestExit()
         end,
@@ -112,6 +132,59 @@ widget.newButton(
     }
 )
 
+--[[
+widget.newButton(
+    {
+        width = 200,
+        height = 30,
+        shape = 'roundedRect',
+        x = display.contentCenterX,
+        y = display.contentCenterY + 200,
+        label = 'Destroy cursor 1',
+        onRelease = function()
+            cursor.destroyCursor(cursors.cursor1)
+            cursors.cursor1 = nil
+        end,
+        labelColor = { default = { 1, 1, 1 }, over = { 0, 0, 0, 0.5 } },
+        fillColor = { default = { 1, 0.2, 0.5, 0.7 }, over = { 1, 0.2, 0.5, 1 } }
+    }
+)
+
+widget.newButton(
+    {
+        width = 200,
+        height = 30,
+        shape = 'roundedRect',
+        x = display.contentCenterX,
+        y = display.contentCenterY + 250,
+        label = 'Destroy cursor 2',
+        onRelease = function()
+            cursor.destroyCursor(cursors.cursor2)
+            cursors.cursor2 = nil
+        end,
+        labelColor = { default = { 1, 1, 1 }, over = { 0, 0, 0, 0.5 } },
+        fillColor = { default = { 1, 0.2, 0.5, 0.7 }, over = { 1, 0.2, 0.5, 1 } }
+    }
+)
+
+widget.newButton(
+    {
+        width = 200,
+        height = 30,
+        shape = 'roundedRect',
+        x = display.contentCenterX,
+        y = display.contentCenterY + 300,
+        label = 'Destroy cursor 3',
+        onRelease = function()
+            cursor.destroyCursor(cursors.cursor3)
+            cursors.cursor3 = nil
+        end,
+        labelColor = { default = { 1, 1, 1 }, over = { 0, 0, 0, 0.5 } },
+        fillColor = { default = { 1, 0.2, 0.5, 0.7 }, over = { 1, 0.2, 0.5, 1 } }
+    }
+)
+]]--
+
 Runtime:addEventListener('key',
     function(event)
         if event.phase == 'up' then

Corona/main.lua

@@ -12,6 +12,7 @@ Refer to example project in ```Corona/``` directory
 - ```showCursor``` - shows the cursor if it was hidden
 - ```hideCursor``` - hides the cursor if it was visible
 - ```resetCursor``` - resets the cursor to the default arrow cursor
+- ```destroyCursor``` - destroys the cursor handle and frees its memory
 - ```loadWinCursor``` - loads the specified windows-provided cursor
 
 # Valid arguments to loadWinCursor()
@@ -37,4 +38,5 @@ Refer to example project in ```Corona/``` directory
 
 # Caveats
 - Only supports windows for now
+- Destroy preloaded cursors before exiting the application programmatically. Call ```plugin.destroyCursor(cursor)```.
 - You must call ```plugin.freePlugin()``` while exiting the application programmatically. An example of how this should be done is provided.

README.md

@@ -29,6 +29,7 @@ int luaopen_plugin_hwcursor(lua_State *L) {
             {"showCursor", showCursor},
             {"hideCursor", hideCursor},
             {"resetCursor", resetCursor},
+            {"destroyCursor", destroyCursor},
             {"loadWinCursor", loadWinCursor},
             {"regExitCallback", regExitCallback},
             {NULL, NULL}
@@ -63,12 +64,12 @@ LRESULT CALLBACK WindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam,
         if(exitCallback != 0) {
             lua_rawgeti(state, LUA_REGISTRYINDEX, exitCallback);
             if(lua_pcall(state, 0, 0, 0) != 0) {
-                CoronaLuaLog(state, "[hwcursor] the error below occurred while calling the callback function");
-                CoronaLuaLog(state, lua_tostring(state, -1));
+                CoronaLuaError(state, "[hwcursor] The error below occurred while calling the callback function");
+                CoronaLuaError(state, lua_tostring(state, -1));
             }
         }
         else {
-            CoronaLuaLog(state, "[hwcursor] no exit callback was found");
+            CoronaLuaError(state, "[hwcursor] No exit callback was found");
         }
 
         return false;
@@ -106,7 +107,9 @@ static int loadCursor(lua_State *L) {
     }
     else {
         std::string cursorLoc = lua_tostring(L, 1);
-        HCURSOR cursor = LoadCursorFromFile(s2ws(cursorLoc).c_str());
+        // Allows for actual cursor size to be used with no constraints, i.e: even 256x256 size cursors will display at this
+        // size with no downsizing being performed as happens with LoadCursorFromFile
+        HCURSOR cursor = (HCURSOR)LoadImage(NULL, s2ws(cursorLoc).c_str(), IMAGE_CURSOR, 0, 0, LR_LOADFROMFILE);
         lua_pushlightuserdata(L, cursor);
         return 1;
     }
@@ -136,6 +139,25 @@ static int hideCursor(lua_State *L) {
 
 static int resetCursor(lua_State *L) {
     currentCursor = NULL;
+    SetCursor(currentCursor);
+    return 0;
+}
+
+// ----------------------------------------------------------------------------
+
+static int destroyCursor(lua_State *L) {
+    HCURSOR cursor = (HCURSOR)lua_touserdata(L, 1);
+    if(cursor == currentCursor) {
+        currentCursor = NULL;
+        SetCursor(currentCursor);
+    }
+    DestroyCursor(cursor);
+    /*
+    if(!DestroyCursor(cursor)) {
+        CoronaLuaError(L, "[hwcursor] The error below occurred while destroying the cursor");
+        CoronaLuaError(L, GetLastErrorAsString().c_str());
+    }
+    */
     return 0;
 }
 

shared/PluginHwCursor.cpp

@@ -31,6 +31,7 @@ static int loadCursor(lua_State *L);
 static int showCursor(lua_State *L);
 static int hideCursor(lua_State *L);
 static int resetCursor(lua_State *L);
+static int destroyCursor(lua_State *L);
 static int loadWinCursor(lua_State *L);
 static int regExitCallback(lua_State *L);
 
@@ -45,3 +46,29 @@ std::wstring s2ws(const std::string &s) {
     MultiByteToWideChar(CP_ACP, 0, s.c_str(), slength, const_cast<wchar_t*>(buf.c_str()), len);
     return buf;
 }
+
+// ----------------------------------------------------------------------------
+// https://stackoverflow.com/a/17387176
+/*
+std::string GetLastErrorAsString() {
+    //Get the error message ID, if any.
+    DWORD errorMessageID = GetLastError();
+    if(errorMessageID == 0) {
+        return std::string(); //No error message has been recorded
+    }
+
+    LPSTR messageBuffer = nullptr;
+
+    //Ask Win32 to give us the string version of that message ID.
+    //The parameters we pass in, tell Win32 to create the buffer that holds the message for us (because we don't yet know how long the message string will be).
+    size_t size = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, errorMessageID, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&messageBuffer, 0, NULL);
+
+    //Copy the error message into a std::string.
+    std::string message(messageBuffer, size);
+
+    //Free the Win32's string's buffer.
+    LocalFree(messageBuffer);
+
+    return message;
+}
+*/