improve mac support

core/settings.py

@@ -61,6 +61,14 @@
     desc="The key that is used as the NVDA key",
 )
 
+mod.setting(
+    "voiceover_key",
+    type=str,
+    default="capslock",
+    desc="The key that is used as the voiceover key",
+)
+
+
 mod.setting(
     "speak_errors",
     type=bool,

voiceover/readme.md

@@ -1,6 +1,6 @@
 # VoiceOver
 
-TODO
+This integration is a work in progress. VoiceOver is difficult to customize or script since it is all closed source and most of the best APIs are only able to be queried via objc or swift, not Python unless ffi is brought into play.
 
 ## Setup
 

voiceover/voiceover.py

@@ -1,14 +1,16 @@
 import os
 import sys
 
-from talon import Context, Module, actions, cron, settings
+from talon import Context, Module, actions, cron, settings, ui
 
 mod = Module()
 ctx = Context()
 ctx.matches = r"""
 os: mac
 """
 
+from talon.mac import applescript
+
 
 @ctx.action_class("user")
 class MacActions:
@@ -19,7 +21,7 @@ def with_voiceover_mod_press(key: str):
         """Presses the given key with the voiceover modifier key"""
         voiceover_key = settings.get("user.voiceover_key")
         actions.key(f"{voiceover_key}:down")
-        actions.sleep("50ms")
+        actions.sleep("100ms")
         actions.key(key)
         actions.sleep("10ms")
         actions.key(f"{voiceover_key}:up")
@@ -32,6 +34,7 @@ def with_voiceover_mod_press(key: str):
 def set_voiceover_running_tag():
     """Update tags based on if voiceover is running"""
     # Edge case on startup this might not be set yet we we catch all exceptions
+
     try:
         ctx.tags = (
             ["user.voiceover_running"] if actions.user.is_voiceover_running() else []
@@ -48,13 +51,23 @@ def set_voiceover_running_tag():
 class Actions:
     def is_voiceover_running() -> bool:
         """Returns true if voiceover is running"""
-        return True if "user.voiceover_running" in ctx.tags else False
+        if os.name != "darwin":
+            return False
+
+        # TODO : figure out how a way to check this without spamming subprocesses
+        return False
 
     def voiceover_tts(text: str):
         """text to speech with voiceover"""
 
     def with_voiceover_mod_press(key: str):
         """Presses the given key with the voiceover modifier key"""
+        voiceover_key = settings.get("user.voiceover_key")
+        actions.key(f"{voiceover_key}:down")
+        actions.sleep("50ms")
+        actions.key(key)
+        actions.sleep("10ms")
+        actions.key(f"{voiceover_key}:up")
 
 
 ctxVoiceoverRunning = Context()
@@ -65,8 +78,18 @@ def with_voiceover_mod_press(key: str):
 
 @ctxVoiceoverRunning.action_class("user")
 class VoiceoverActions:
-    def voiceover_tts(text: str):
+    def tts(text: str, interrupt: bool = True):
         """text to speech with voiceover"""
-        script_path = os.path.join(
-            os.path.dirname(__file__), "voiceover_tts.applescript"
-        )
+
+        def wrapper(text):
+            res = applescript.run(
+                f"""
+
+            tell application "VoiceOver"
+                output "{text}"
+            end tell
+            """
+            )
+
+        # spawn it on a different thread so if it stalls we don't hang
+        cron.after("0s", lambda: wrapper(text))

voiceover/voiceover.talon

@@ -0,0 +1,12 @@
+os: mac
+-
+
+read below: key(ctrl-alt-a)
+next heading: key(cmd-ctrl-alt-h)
+previous heading: key(cmd-ctrl-alt-shift-h)
+next landmark: key(ctrl-alt-cmd-n)
+
+# TODO voiceover mod not working
+reader help: user.with_voiceover_mod_press("h")
+
+screen curtain: user.with_voiceover_mod_press("shift-fn-_")