Added argument to call action (#1900)

AndreasArvidsson · pre-commit-ci-lite[bot] · auscompgeek · web-flow · commit c2fb509c7a65 · 2023-09-28T14:36:41.000Z
`call air on bat` ## Checklist - [x] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [x] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [x] I have not broken the cheatsheet --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com> Co-authored-by: David Vo <auscompgeek@users.noreply.github.com> Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
diff --git a/changelog/2023-09-addedArgumentTargetToCallAction.md b/changelog/2023-09-addedArgumentTargetToCallAction.md
@@ -0,0 +1,6 @@
+---
+tags: [enhancement, talon]
+pullRequest: 1900
+---
+
+- Added optional second target to action `call` to specify argument. eg: `"call air on bat"`.
diff --git a/cursorless-talon/src/actions/actions.py b/cursorless-talon/src/actions/actions.py
@@ -8,7 +8,6 @@
     ImplicitDestination,
 )
 from .bring_move import BringMoveTargets
-from .call import cursorless_call_action
 from .execute_command import cursorless_execute_command_action
 from .homophones import cursorless_homophones_action
 from .replace import cursorless_replace_action
@@ -44,11 +43,11 @@
     "wrap_action",
     "insert_snippet_action",
     "reformat_action",
+    "call_action",
     "experimental_action",
 ]
 
 callback_actions: dict[str, Callable[[CursorlessTarget], None]] = {
-    "callAsFunction": cursorless_call_action,
     "findInDocument": actions.user.private_cursorless_find,
     "nextHomophone": cursorless_homophones_action,
 }
@@ -70,6 +69,7 @@
         "{user.cursorless_simple_action} |"
         "{user.cursorless_experimental_action} |"
         "{user.cursorless_callback_action} |"
+        "{user.cursorless_call_action} |"
         "{user.cursorless_custom_action}"
     )
 )
@@ -96,6 +96,8 @@ def cursorless_command(action_name: str, target: CursorlessTarget):
             actions.user.private_cursorless_bring_move(
                 action_name, BringMoveTargets(target, ImplicitDestination())
             )
+        elif action_name == "callAsFunction":
+            actions.user.private_cursorless_call(target)
         elif action_name in no_wait_actions:
             action = {"name": action_name, "target": target}
             actions.user.private_cursorless_command_no_wait(action)
diff --git a/cursorless-talon/src/actions/call.py b/cursorless-talon/src/actions/call.py
@@ -1,13 +1,22 @@
-from talon import actions
+from talon import Module, actions
 
 from ..targets.target_types import CursorlessTarget, ImplicitTarget
 
+mod = Module()
+mod.list("cursorless_call_action", desc="Cursorless call action")
 
-def cursorless_call_action(target: CursorlessTarget):
-    actions.user.private_cursorless_command_and_wait(
-        {
-            "name": "callAsFunction",
-            "callee": target,
-            "argument": ImplicitTarget(),
-        }
-    )
+
+@mod.action_class
+class Actions:
+    def private_cursorless_call(
+        callee: CursorlessTarget,
+        argument: CursorlessTarget = ImplicitTarget(),
+    ):
+        """Execute Cursorless call action"""
+        actions.user.private_cursorless_command_and_wait(
+            {
+                "name": "callAsFunction",
+                "callee": callee,
+                "argument": argument,
+            }
+        )
diff --git a/cursorless-talon/src/cheatsheet/sections/actions.py b/cursorless-talon/src/cheatsheet/sections/actions.py
@@ -12,6 +12,7 @@ def get_actions():
         "moveToTarget",
         "swapTargets",
         "applyFormatter",
+        "callAsFunction",
         "wrapWithPairedDelimiter",
         "rewrap",
         "pasteFromClipboard",
@@ -34,7 +35,6 @@ def get_actions():
             "action",
             simple_actions,
             {
-                "callAsFunction": "Call <target> on selection",
                 "editNewLineAfter": "Edit new line/scope after",
                 "editNewLineBefore": "Edit new line/scope before",
             },
@@ -101,6 +101,20 @@ def get_actions():
                 }
             ],
         },
+        {
+            "id": "callAsFunction",
+            "type": "action",
+            "variations": [
+                {
+                    "spokenForm": f"{complex_actions['callAsFunction']} <target>",
+                    "description": "Call <target> on selection",
+                },
+                {
+                    "spokenForm": f"{complex_actions['callAsFunction']} <target 1> on <target 2>",
+                    "description": "Call <target 1> on <target 2>",
+                },
+            ],
+        },
         {
             "id": "wrapWithPairedDelimiter",
             "type": "action",
diff --git a/cursorless-talon/src/cursorless.talon b/cursorless-talon/src/cursorless.talon
@@ -18,6 +18,9 @@ tag: user.cursorless
 {user.cursorless_reformat_action} <user.formatters> at <user.cursorless_target>:
     user.private_cursorless_reformat(cursorless_target, formatters)
 
+{user.cursorless_call_action} <user.cursorless_target> on <user.cursorless_target>:
+    user.private_cursorless_call(cursorless_target_1, cursorless_target_2)
+
 <user.cursorless_wrapper_paired_delimiter> {user.cursorless_wrap_action} <user.cursorless_target>:
     user.private_cursorless_wrap_with_paired_delimiter(cursorless_wrap_action, cursorless_target, cursorless_wrapper_paired_delimiter)
 
diff --git a/cursorless-talon/src/spoken_forms.json b/cursorless-talon/src/spoken_forms.json
@@ -43,7 +43,6 @@
       "unfold": "unfoldRegion"
     },
     "callback_action": {
-      "call": "callAsFunction",
       "scout": "findInDocument",
       "phones": "nextHomophone"
     },
@@ -55,7 +54,8 @@
     "swap_action": { "swap": "swapTargets" },
     "wrap_action": { "wrap": "wrapWithPairedDelimiter", "repack": "rewrap" },
     "insert_snippet_action": { "snippet": "insertSnippet" },
-    "reformat_action": { "format": "applyFormatter" }
+    "reformat_action": { "format": "applyFormatter" },
+    "call_action": { "call": "callAsFunction" }
   },
   "target_connectives.csv": {
     "range_connective": {
diff --git a/cursorless-talon/src/spoken_forms.py b/cursorless-talon/src/spoken_forms.py
@@ -54,7 +54,7 @@ def update():
     for disposable in disposables:
         disposable()
 
-    with open(JSON_FILE) as file:
+    with open(JSON_FILE, encoding="utf-8") as file:
         spoken_forms = json.load(file)
 
     handle_csv = auto_construct_defaults(spoken_forms, init_csv_and_watch_changes)
diff --git a/packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json b/packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json
@@ -21,6 +21,10 @@
             {
               "spokenForm": "call <target>",
               "description": "Call <target> on selection"
+            },
+            {
+              "spokenForm": "call <target 1> on <target 2>",
+              "description": "Call <target 1> on <target 2>"
             }
           ]
         },
@@ -1188,6 +1192,16 @@
             }
           ]
         },
+        {
+          "id": "command",
+          "type": "scopeType",
+          "variations": [
+            {
+              "spokenForm": "command",
+              "description": "Command"
+            }
+          ]
+        },
         {
           "id": "comment",
           "type": "scopeType",
diff --git a/packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts b/packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts
@@ -76,13 +76,14 @@ function generateSpokenFormComponents(
       ];
 
     case "callAsFunction":
-      if (action.argument != null) {
-        throw new NoSpokenFormError(`Action '${action.name}' with argument`);
+      if (action.argument.type === "implicit") {
+        return [actions[action.name], targetToSpokenForm(action.callee)];
       }
       return [
         actions[action.name],
         targetToSpokenForm(action.callee),
-        // targetToSpokenForm(action.argument),
+        "on",
+        targetToSpokenForm(action.argument),
       ];
 
     case "wrapWithPairedDelimiter":
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callFine.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callFine.yml
@@ -7,7 +7,6 @@ command:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: f}
     - {type: primitive, isImplicit: true}
-spokenFormError: Action 'callAsFunction' with argument
 initialState:
   documentContents: |-
     foo;
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callFineOnBatt.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callFineOnBatt.yml
@@ -0,0 +1,41 @@
+languageId: plaintext
+command:
+  version: 6
+  spokenForm: call fine on bat
+  action:
+    name: callAsFunction
+    callee:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: f}
+    argument:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: b}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |-
+    foo
+    bar
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks:
+    default.f:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+    default.b:
+      start: {line: 1, character: 0}
+      end: {line: 1, character: 3}
+finalState:
+  documentContents: |-
+    foo
+    foo(bar)
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 1, character: 0}
+        end: {line: 1, character: 8}
+      isReversed: false
+      hasExplicitRange: true
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callVest.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callVest.yml
@@ -7,7 +7,6 @@ command:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: v}
     - {type: primitive, isImplicit: true}
-spokenFormError: Action 'callAsFunction' with argument
 initialState:
   documentContents: |
 
diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callVestOnCap.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/callVestOnCap.yml
@@ -8,7 +8,6 @@ command:
       mark: {type: decoratedSymbol, symbolColor: default, character: v}
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: c}
-spokenFormError: Action 'callAsFunction' with argument
 initialState:
   documentContents: |
 

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@`
`8`	`8`	`ImplicitDestination,`
`9`	`9`	`)`
`10`	`10`	`from .bring_move import BringMoveTargets`
`11`		`-from .call import cursorless_call_action`
`12`	`11`	`from .execute_command import cursorless_execute_command_action`
`13`	`12`	`from .homophones import cursorless_homophones_action`
`14`	`13`	`from .replace import cursorless_replace_action`
`@@ -44,11 +43,11 @@`
`44`	`43`	`"wrap_action",`
`45`	`44`	`"insert_snippet_action",`
`46`	`45`	`"reformat_action",`
	`46`	`+ "call_action",`
`47`	`47`	`"experimental_action",`
`48`	`48`	`]`
`49`	`49`
`50`	`50`	`callback_actions: dict[str, Callable[[CursorlessTarget], None]] = {`
`51`		`- "callAsFunction": cursorless_call_action,`
`52`	`51`	`"findInDocument": actions.user.private_cursorless_find,`
`53`	`52`	`"nextHomophone": cursorless_homophones_action,`
`54`	`53`	`}`
`@@ -70,6 +69,7 @@`
`70`	`69`	`"{user.cursorless_simple_action} \|"`
`71`	`70`	`"{user.cursorless_experimental_action} \|"`
`72`	`71`	`"{user.cursorless_callback_action} \|"`
	`72`	`+ "{user.cursorless_call_action} \|"`
`73`	`73`	`"{user.cursorless_custom_action}"`
`74`	`74`	`)`
`75`	`75`	`)`
`@@ -96,6 +96,8 @@ def cursorless_command(action_name: str, target: CursorlessTarget):`
`96`	`96`	`actions.user.private_cursorless_bring_move(`
`97`	`97`	`action_name, BringMoveTargets(target, ImplicitDestination())`
`98`	`98`	`)`
	`99`	`+ elif action_name == "callAsFunction":`
	`100`	`+ actions.user.private_cursorless_call(target)`
`99`	`101`	`elif action_name in no_wait_actions:`
`100`	`102`	`action = {"name": action_name, "target": target}`
`101`	`103`	`actions.user.private_cursorless_command_no_wait(action)`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,10 @@`
`21`	`21`	`{`
`22`	`22`	`"spokenForm": "call <target>",`
`23`	`23`	`"description": "Call <target> on selection"`
	`24`	`+ },`
	`25`	`+ {`
	`26`	`+ "spokenForm": "call <target 1> on <target 2>",`
	`27`	`+ "description": "Call <target 1> on <target 2>"`
`24`	`28`	`}`
`25`	`29`	`]`
`26`	`30`	`},`
`@@ -1188,6 +1192,16 @@`
`1188`	`1192`	`}`
`1189`	`1193`	`]`
`1190`	`1194`	`},`
	`1195`	`+ {`
	`1196`	`+ "id": "command",`
	`1197`	`+ "type": "scopeType",`
	`1198`	`+ "variations": [`
	`1199`	`+ {`
	`1200`	`+ "spokenForm": "command",`
	`1201`	`+ "description": "Command"`
	`1202`	`+ }`
	`1203`	`+ ]`
	`1204`	`+ },`
`1191`	`1205`	`{`
`1192`	`1206`	`"id": "comment",`
`1193`	`1207`	`"type": "scopeType",`