update to be coroutine friendly; see HS pull #2308

asmagill · asmagill · commit 0b5321fc336f · 2020-02-25T00:51:50.000Z
diff --git a/CGSConnection.h b/CGSConnection.h
@@ -1,22 +1,22 @@
 /*
  * Copyright (C) 2007-2008 Alacatia Labs
- * 
+ *
  * This software is provided 'as-is', without any express or implied
  * warranty.  In no event will the authors be held liable for any damages
  * arising from the use of this software.
- * 
+ *
  * Permission is granted to anyone to use this software for any purpose,
  * including commercial applications, and to alter it and redistribute it
  * freely, subject to the following restrictions:
- * 
+ *
  * 1. The origin of this software must not be misrepresented; you must not
  *    claim that you wrote the original software. If you use this software
  *    in a product, an acknowledgment in the product documentation would be
  *    appreciated but is not required.
  * 2. Altered source versions must be plainly marked as such, and must not be
  *    misrepresented as being the original software.
  * 3. This notice may not be removed or altered from any source distribution.
- * 
+ *
  * Joe Ranieri joe@alacatia.com
  *
  */
@@ -230,7 +230,7 @@ CG_EXTERN CGError CGSSetLoginwindowConnection(CGSConnectionID cid) AVAILABLE_MAC
 
 //! The data sent with kCGSNotificationAppUnresponsive and kCGSNotificationAppResponsive.
 typedef struct {
-#if __BIG_ENDIAN__
+#ifdef __BIG_ENDIAN__
 	uint16_t majorVersion;
 	uint16_t minorVersion;
 #else
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 current_dir := $(notdir $(patsubst %/,%,$(dir $(mkfile_path))))
 
-MODULE := $(current_dir)
+MODULE := $(lastword $(subst ., ,$(current_dir)))
 PREFIX ?= ~/.hammerspoon
 MODPATH = hs/_asm/undocumented
 VERSION ?= 0.x
@@ -35,8 +35,8 @@ ALLFILES += $(SOFILE)
 
 #CC=cc
 CC=@clang
-WARNINGS ?= -Weverything -Wno-objc-missing-property-synthesis -Wno-implicit-atomic-properties -Wno-direct-ivar-access -Wno-cstring-format-directive -Wno-padded -Wno-covered-switch-default -Wno-missing-prototypes -Werror-implicit-function-declaration
-EXTRA_CFLAGS ?= -F$(HS_APPLICATION)/Hammerspoon.app/Contents/Frameworks -mmacosx-version-min=10.10
+WARNINGS ?= -Weverything -Wno-objc-missing-property-synthesis -Wno-implicit-atomic-properties -Wno-direct-ivar-access -Wno-cstring-format-directive -Wno-padded -Wno-covered-switch-default -Wno-missing-prototypes -Werror-implicit-function-declaration -Wno-documentation-unknown-command
+EXTRA_CFLAGS ?= -F$(HS_APPLICATION)/Hammerspoon.app/Contents/Frameworks -mmacosx-version-min=10.12
 
 CFLAGS  += $(DEBUG_CFLAGS) -fmodules -fobjc-arc -DHS_EXTERNAL_MODULE $(WARNINGS) $(EXTRA_CFLAGS)
 LDFLAGS += -dynamiclib -undefined dynamic_lookup $(EXTRA_LDFLAGS)
diff --git a/docs.json b/docs.json
@@ -8,15 +8,13 @@
     ],
     "Function" : [
       {
-        "parameters" : [
-
-        ],
+        "name" : "count",
         "stripped_doc" : [
           "LEGACY: The number of spaces you currently have.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.count() -> number",
         "doc" : "LEGACY: The number of spaces you currently have.\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it worked by indexing the spaces ignoring that fullscreen applications are included in the list twice, and only worked with one monitor.  Use `hs._asm.undocumented.spaces.query` or `hs._asm.undocumented.spaces.spacesByScreenUUID`.",
-        "desc" : "LEGACY: The number of spaces you currently have.",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -27,19 +25,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.count() -> number",
-        "name" : "count"
-      },
-      {
+        "desc" : "LEGACY: The number of spaces you currently have.",
         "parameters" : [
 
-        ],
+        ]
+      },
+      {
+        "name" : "currentSpace",
         "stripped_doc" : [
           "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.currentSpace() -> number",
         "doc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it worked by indexing the spaces, which can be rearranged by the operating system anyways.  Use `hs._asm.undocumented.spaces.query` or `hs._asm.undocumented.spaces.spacesByScreenUUID`.",
-        "desc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -50,19 +48,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.currentSpace() -> number",
-        "name" : "currentSpace"
-      },
-      {
+        "desc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
         "parameters" : [
 
-        ],
+        ]
+      },
+      {
+        "name" : "moveToSpace",
         "stripped_doc" : [
           "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.moveToSpace(number)",
         "doc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it was never really reliable and worked by indexing the spaces, which can be rearranged by the operating system anyways.  Use `hs._asm.undocumented.spaces.changeToSpace`.",
-        "desc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -73,20 +71,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.moveToSpace(number)",
-        "name" : "moveToSpace"
+        "desc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
+        "parameters" : [
+
+        ]
       },
       {
-        "parameters" : [
-          " * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.",
-          ""
-        ],
+        "name" : "isAnimating",
         "stripped_doc" : [
           "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.isAnimating([screen]) -> bool",
         "doc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.\n\nParameters:\n * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.\n\nReturns:\n * a boolean value indicating whether or not a space changing animation is currently active.\n\nNotes:\n * This function can be used in `hs.eventtap` based space changing functions to determine when to release the mouse and key events.\n\n * This function is also added to the `hs.screen` object metatable so that you can check a specific screen's animation status with `hs.screen:spacesAnimating()`.",
-        "desc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
         "notes" : [
           " * This function can be used in `hs.eventtap` based space changing functions to determine when to release the mouse and key events.",
           "",
@@ -98,20 +95,20 @@
           " * a boolean value indicating whether or not a space changing animation is currently active.",
           ""
         ],
-        "def" : "hs._asm.undocumented.spaces.isAnimating([screen]) -> bool",
-        "name" : "isAnimating"
-      },
-      {
+        "desc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
         "parameters" : [
-          " * None",
+          " * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.",
           ""
-        ],
+        ]
+      },
+      {
+        "name" : "screensHaveSeparateSpaces",
         "stripped_doc" : [
           "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.screensHaveSeparateSpaces() -> bool",
         "doc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.\n\nParameters:\n * None\n\nReturns:\n * true or false representing the status of the \"Displays Have Separate Spaces\" option within Mission Control.\n\nNotes:\n * This function uses standard OS X APIs and is not likely to be affected by updates or patches.",
-        "desc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
         "notes" : [
           " * This function uses standard OS X APIs and is not likely to be affected by updates or patches."
         ],
@@ -121,8 +118,11 @@
           " * true or false representing the status of the \"Displays Have Separate Spaces\" option within Mission Control.",
           ""
         ],
-        "def" : "hs._asm.undocumented.spaces.screensHaveSeparateSpaces() -> bool",
-        "name" : "screensHaveSeparateSpaces"
+        "desc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
+        "parameters" : [
+          " * None",
+          ""
+        ]
       }
     ],
     "Variable" : [
@@ -134,14 +134,12 @@
     "Deprecated" : [
 
     ],
-    "type" : "Module",
     "desc" : "These functions utilize private API's within the OS X internals, and are known to have unpredictable behavior under Mavericks and Yosemite when \"Displays have separate Spaces\" is checked under the Mission Control system preferences.",
+    "type" : "Module",
     "Constructor" : [
 
     ],
-    "Field" : [
-
-    ],
+    "doc" : "These functions utilize private API's within the OS X internals, and are known to have unpredictable behavior under Mavericks and Yosemite when \"Displays have separate Spaces\" is checked under the Mission Control system preferences.",
     "Method" : [
 
     ],
@@ -150,15 +148,13 @@
     ],
     "items" : [
       {
-        "parameters" : [
-
-        ],
+        "name" : "count",
         "stripped_doc" : [
           "LEGACY: The number of spaces you currently have.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.count() -> number",
         "doc" : "LEGACY: The number of spaces you currently have.\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it worked by indexing the spaces ignoring that fullscreen applications are included in the list twice, and only worked with one monitor.  Use `hs._asm.undocumented.spaces.query` or `hs._asm.undocumented.spaces.spacesByScreenUUID`.",
-        "desc" : "LEGACY: The number of spaces you currently have.",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -169,19 +165,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.count() -> number",
-        "name" : "count"
-      },
-      {
+        "desc" : "LEGACY: The number of spaces you currently have.",
         "parameters" : [
 
-        ],
+        ]
+      },
+      {
+        "name" : "currentSpace",
         "stripped_doc" : [
           "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.currentSpace() -> number",
         "doc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it worked by indexing the spaces, which can be rearranged by the operating system anyways.  Use `hs._asm.undocumented.spaces.query` or `hs._asm.undocumented.spaces.spacesByScreenUUID`.",
-        "desc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -192,20 +188,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.currentSpace() -> number",
-        "name" : "currentSpace"
+        "desc" : "LEGACY: The index of the space you're currently on, 1-indexed (as usual).",
+        "parameters" : [
+
+        ]
       },
       {
-        "parameters" : [
-          " * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.",
-          ""
-        ],
+        "name" : "isAnimating",
         "stripped_doc" : [
           "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.isAnimating([screen]) -> bool",
         "doc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.\n\nParameters:\n * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.\n\nReturns:\n * a boolean value indicating whether or not a space changing animation is currently active.\n\nNotes:\n * This function can be used in `hs.eventtap` based space changing functions to determine when to release the mouse and key events.\n\n * This function is also added to the `hs.screen` object metatable so that you can check a specific screen's animation status with `hs.screen:spacesAnimating()`.",
-        "desc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
         "notes" : [
           " * This function can be used in `hs.eventtap` based space changing functions to determine when to release the mouse and key events.",
           "",
@@ -217,19 +212,20 @@
           " * a boolean value indicating whether or not a space changing animation is currently active.",
           ""
         ],
-        "def" : "hs._asm.undocumented.spaces.isAnimating([screen]) -> bool",
-        "name" : "isAnimating"
+        "desc" : "Returns the state of space changing animation for the specified monitor, or for any monitor if no parameter is specified.",
+        "parameters" : [
+          " * screen - an optional hs.screen object specifying the specific monitor to check the animation status for.",
+          ""
+        ]
       },
       {
-        "parameters" : [
-
-        ],
+        "name" : "moveToSpace",
         "stripped_doc" : [
           "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.moveToSpace(number)",
         "doc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).\n\nNotes:\n * this function may go away in a future update\n\n * this functions is included for backwards compatibility.  It is not recommended because it was never really reliable and worked by indexing the spaces, which can be rearranged by the operating system anyways.  Use `hs._asm.undocumented.spaces.changeToSpace`.",
-        "desc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
         "notes" : [
           " * this function may go away in a future update",
           "",
@@ -240,20 +236,19 @@
         "returns" : [
 
         ],
-        "def" : "hs._asm.undocumented.spaces.moveToSpace(number)",
-        "name" : "moveToSpace"
+        "desc" : "LEGACY: Switches to the space at the given index, 1-indexed (as usual).",
+        "parameters" : [
+
+        ]
       },
       {
-        "parameters" : [
-          " * None",
-          ""
-        ],
+        "name" : "screensHaveSeparateSpaces",
         "stripped_doc" : [
           "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
           ""
         ],
+        "def" : "hs._asm.undocumented.spaces.screensHaveSeparateSpaces() -> bool",
         "doc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.\n\nParameters:\n * None\n\nReturns:\n * true or false representing the status of the \"Displays Have Separate Spaces\" option within Mission Control.\n\nNotes:\n * This function uses standard OS X APIs and is not likely to be affected by updates or patches.",
-        "desc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
         "notes" : [
           " * This function uses standard OS X APIs and is not likely to be affected by updates or patches."
         ],
@@ -263,11 +258,17 @@
           " * true or false representing the status of the \"Displays Have Separate Spaces\" option within Mission Control.",
           ""
         ],
-        "def" : "hs._asm.undocumented.spaces.screensHaveSeparateSpaces() -> bool",
-        "name" : "screensHaveSeparateSpaces"
+        "desc" : "Determine if the user has enabled the \"Displays Have Separate Spaces\" option within Mission Control.",
+        "parameters" : [
+          " * None",
+          ""
+        ]
       }
     ],
-    "doc" : "These functions utilize private API's within the OS X internals, and are known to have unpredictable behavior under Mavericks and Yosemite when \"Displays have separate Spaces\" is checked under the Mission Control system preferences.",
+    "Field" : [
+
+    ],
     "name" : "hs._asm.undocumented.spaces"
   }
 ]
+Menu Developer Updated: Contents
diff --git a/init.lua b/init.lua
@@ -1,3 +1,6 @@
+if package.searchpath("hs._asm.coroutineshim", package.path) then
+    require"hs._asm.coroutineshim"
+end
 --- === hs._asm.undocumented.spaces ===
 ---
 --- These functions utilize private API's within the OS X internals, and are known to have unpredictable behavior under Mavericks and Yosemite when "Displays have separate Spaces" is checked under the Mission Control system preferences.
diff --git a/internal.m b/internal.m
diff --git a/spaces-v0.2-coroutineFriendly.tar.gz b/spaces-v0.2-coroutineFriendly.tar.gz
