Generalize file-based RPC command client beyond VSCode

apps/vscode/command_client/command_client.py

@@ -1,5 +1,6 @@
 import json
 import os
+import string
 import time
 from dataclasses import dataclass
 from pathlib import Path
@@ -13,10 +14,10 @@
 # to remove it
 STALE_TIMEOUT_MS = 60_000
 
-# The amount of time to wait for VSCode to perform a command, in seconds
+# The amount of time to wait for client application to perform a command, in seconds
 VSCODE_COMMAND_TIMEOUT_SECONDS = 3.0
 
-# When doing exponential back off waiting for vscode to perform a command, how
+# When doing exponential back off waiting for client application to perform a command, how
 # long to sleep the first time
 MINIMUM_SLEEP_TIME_SECONDS = 0.0005
 
@@ -32,7 +33,7 @@
 linux_ctx = Context()
 
 ctx.matches = r"""
-app: vscode
+tag: command_client
 """
 mac_ctx.matches = r"""
 os: mac
@@ -49,13 +50,6 @@ def __repr__(self):
         return "<argument not set>"
 
 
-def run_vscode_command_by_command_palette(command_id: str):
-    """Execute command via command palette. Preserves the clipboard."""
-    actions.user.command_palette()
-    actions.user.paste(command_id)
-    actions.key("enter")
-
-
 def write_json_exclusive(path: Path, body: Any):
     """Writes jsonified object to file, failing if the file already exists
 
@@ -88,11 +82,9 @@ def to_dict(self):
 def write_request(request: Request, path: Path):
     """Converts the given request to json and writes it to the file, failing if
     the file already exists unless it is stale in which case it replaces it
-
     Args:
         request (Request): The request to serialize
         path (Path): The path to write to
-
     Raises:
         Exception: If another process has an active request file
     """
@@ -123,14 +115,13 @@ def handle_existing_request_file(path):
         robust_unlink(path)
 
 
-def run_vscode_command(
+def run_command(
     command_id: str,
     *args: str,
     wait_for_finish: bool = False,
     return_command_output: bool = False,
 ):
-    """Runs a VSCode command, using command server if available
-
+    """Runs a command, using command server if available
     Args:
         command_id (str): The ID of the VSCode command to run
         wait_for_finish (bool, optional): Whether to wait for the command to finish before returning. Defaults to False.
@@ -153,7 +144,7 @@ def run_vscode_command(
         if args or return_command_output:
             raise Exception("Must use command-server extension for advanced commands")
         print("Communication dir not found; falling back to command palette")
-        run_vscode_command_by_command_palette(command_id)
+        actions.user.command_client_fallback(command_id)
         return
 
     request_path = communication_dir_path / "request.json"
@@ -180,9 +171,9 @@ def run_vscode_command(
         print("WARNING: Found old response file")
         robust_unlink(response_path)
 
-    # Then, perform keystroke telling VSCode to execute the command in the
-    # request file.  Because only the active VSCode instance will accept
-    # keypresses, we can be sure that the active VSCode instance will be the
+    # Then, perform keystroke telling client application to execute the command in the
+    # request file.  Because only the active client application instance will accept
+    # keypresses, we can be sure that the active client application instance will be the
     # one to execute the command.
     actions.user.trigger_command_server_command_execution()
 
@@ -221,7 +212,7 @@ def get_communication_dir_path():
     if hasattr(os, "getuid"):
         suffix = f"-{os.getuid()}"
 
-    return Path(gettempdir()) / f"vscode-command-server{suffix}"
+    return Path(gettempdir()) / f"{actions.user.command_server_directory()}{suffix}"
 
 
 def robust_unlink(path: Path):
@@ -292,14 +283,14 @@ class Actions:
     def vscode(command_id: str):
         """Execute command via vscode command server, if available, or fallback
         to command palette."""
-        run_vscode_command(command_id)
+        run_command(command_id)
 
     def vscode_and_wait(command_id: str):
         """Execute command via vscode command server, if available, and wait
         for command to finish.  If command server not available, uses command
         palette and doesn't guarantee that it will wait for command to
         finish."""
-        run_vscode_command(command_id, wait_for_finish=True)
+        run_command(command_id, wait_for_finish=True)
 
     def vscode_with_plugin(
         command_id: str,
@@ -310,7 +301,7 @@ def vscode_with_plugin(
         arg5: Any = NotSet,
     ):
         """Execute command via vscode command server."""
-        run_vscode_command(
+        run_command(
             command_id,
             arg1,
             arg2,
@@ -328,7 +319,7 @@ def vscode_with_plugin_and_wait(
         arg5: Any = NotSet,
     ):
         """Execute command via vscode command server and wait for command to finish."""
-        run_vscode_command(
+        run_command(
             command_id,
             arg1,
             arg2,
@@ -347,7 +338,7 @@ def vscode_get(
         arg5: Any = NotSet,
     ) -> Any:
         """Execute command via vscode command server and return command output."""
-        return run_vscode_command(
+        return run_command(
             command_id,
             arg1,
             arg2,
@@ -357,18 +348,21 @@ def vscode_get(
             return_command_output=True,
         )
 
+    def command_server_directory() -> string:
+        """Return the final directory of the command server"""
+
     def trigger_command_server_command_execution():
         """Issue keystroke to trigger command server to execute command that
         was written to the file.  For internal use only"""
         actions.key("ctrl-shift-f17")
 
-    def emit_pre_phrase_signal() -> bool:
-        """Touches a file to indicate that a phrase is about to begin execution"""
-
     def did_emit_pre_phrase_signal() -> bool:
         """Indicates whether the pre-phrase signal was emitted at the start of this phrase"""
         return did_emit_pre_phrase_signal
 
+    def command_client_fallback(command_id: str):
+        """The strategy to use when no command server directory is located for the the application"""
+
 
 @mac_ctx.action_class("user")
 class MacUserActions:
@@ -406,10 +400,8 @@ class MissingCommunicationDir(Exception):
 def get_signal_path(name: str) -> Path:
     """
     Get the path to a signal in the signal subdirectory.
-
     Args:
         name (str): The name of the signal
-
     Returns:
         Path: The signal path
     """

apps/vscode/command_client/command_client_tag.py

@@ -0,0 +1,24 @@
+import string
+
+from talon import Module
+
+mod = Module()
+
+mod.tag(
+    "command_client", desc="For applications which implement File based RPC with Talon"
+)
+
+
+@mod.action_class
+class Actions:
+    def command_server_directory() -> string:
+        """The dirctory which contains the files required for communication between the application and Talon.
+        This is the only function which absolutly must be implemented for any application using the command-client."""
+
+    def emit_pre_phrase_signal() -> bool:
+        """The command client can touch a signal file at the start of a phrase, function has a default implementation
+        which does this, if your implementation does not require this signal file be touched simply return false."""
+
+    def command_client_fallback(command_id: str):
+        """Execute an alternative stratagy for issuing the command, if non exists just implemnt
+        there is not need to implement, the fall back is to do nothing."""

apps/vscode/command_client/visual_studio.py

@@ -0,0 +1,17 @@
+import string
+
+from talon import Context, actions
+
+ctx = Context()
+
+ctx.matches = r"""
+app: visual_studio
+"""
+
+ctx.tags = ["user.command_client"]
+
+
+@ctx.action_class("user")
+class VisualStudioActions:
+    def command_server_directory() -> string:
+        return "visual-studio-commandServer"

apps/vscode/command_client/vs_code.py

@@ -0,0 +1,22 @@
+import string
+
+from talon import Context, actions
+
+ctx = Context()
+
+ctx.matches = r"""
+app: vscode
+"""
+ctx.tags = ["user.command_client"]
+
+
+@ctx.action_class("user")
+class VsCodeAction:
+    def command_server_directory() -> string:
+        return "vscode-command-server"
+
+    def command_client_fallback(command_id: str):
+        """Execute command via command palette. Preserves the clipboard."""
+        actions.user.command_palette()
+        actions.user.paste(command_id)
+        actions.key("enter")