Support complex relative grammar (cursorless-dev#987)

* Added support for plural lists

* Updated relative scope modifier grammar

* Added ordinals to relative modifier

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added plural list for regex scopes

* Update cursorless-talon/src/modifiers/relative_scope.py

Co-authored-by: Pokey Rule <[email protected]>

* Update cursorless-talon/src/modifiers/relative_scope.py

Co-authored-by: Pokey Rule <[email protected]>

* Added link to inflection license

* Use plural scope type in ordinal scope

* Added support for <ordinal> last scope grammar

* Clean up

* Added words to csv

* Updated modifier grammar

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Updated legend

* Added docs

* Update defaults.json

* Start tweaking modifier cheatsheet

* More cheatsheet updates

* More tweaks

* Cleanup cheatsheet representation

* Some talon cleanup

* Change formatting for cheatsheet captures

* Fix captures in cheatsheet

* More capture cleanup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revert ts config

* Revert old cheatsheet changes

* Fixes

* Tweak docs

* More doc tweaks

* Add diagram

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Pokey Rule <[email protected]>

Author: 3 people

src/cheatsheet_html/sections/actions.py

@@ -16,7 +16,7 @@ def get_actions():
         "rewrap",
     ]
     simple_actions = {
-        f"{key} <T>": value
+        f"{key} <target>": value
         for key, value in all_actions.items()
         if value not in multiple_target_action_names
     }
@@ -36,20 +36,20 @@ def get_actions():
             "action",
             simple_actions,
             {
-                "callAsFunction": "Call T on S",
+                "callAsFunction": "Call <target> on selection",
             },
         ),
         {
             "id": "replaceWithTarget",
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"{complex_actions['replaceWithTarget']} <T1> {source_destination_connective} <T2>",
-                    "description": "Replace T2 with T1",
+                    "spokenForm": f"{complex_actions['replaceWithTarget']} <target 1> {source_destination_connective} <target 2>",
+                    "description": "Replace <target 2> with <target 1>",
                 },
                 {
-                    "spokenForm": f"{complex_actions['replaceWithTarget']} <T>",
-                    "description": "Replace S with T",
+                    "spokenForm": f"{complex_actions['replaceWithTarget']} <target>",
+                    "description": "Replace selection with <target>",
                 },
             ],
         },
@@ -58,12 +58,12 @@ def get_actions():
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"{complex_actions['moveToTarget']} <T1> {source_destination_connective} <T2>",
-                    "description": "Move T1 to T2",
+                    "spokenForm": f"{complex_actions['moveToTarget']} <target 1> {source_destination_connective} <target 2>",
+                    "description": "Move <target 1> to <target 2>",
                 },
                 {
-                    "spokenForm": f"{complex_actions['moveToTarget']} <T>",
-                    "description": "Move T to S",
+                    "spokenForm": f"{complex_actions['moveToTarget']} <target>",
+                    "description": "Move <target> to selection",
                 },
             ],
         },
@@ -72,12 +72,12 @@ def get_actions():
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"{complex_actions['swapTargets']} <T1> {swap_connective} <T2>",
-                    "description": "Swap T1 with T2",
+                    "spokenForm": f"{complex_actions['swapTargets']} <target 1> {swap_connective} <target 2>",
+                    "description": "Swap <target 1> with <target 2>",
                 },
                 {
-                    "spokenForm": f"{complex_actions['swapTargets']} {swap_connective} <T>",
-                    "description": "Swap S with T",
+                    "spokenForm": f"{complex_actions['swapTargets']} {swap_connective} <target>",
+                    "description": "Swap selection with <target>",
                 },
             ],
         },
@@ -86,8 +86,8 @@ def get_actions():
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"{complex_actions['applyFormatter']} <F> at <T>",
-                    "description": "Reformat T as F",
+                    "spokenForm": f"{complex_actions['applyFormatter']} <formatter> at <target>",
+                    "description": "Reformat <target> as <formatter>",
                 }
             ],
         },
@@ -96,8 +96,8 @@ def get_actions():
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"<P> {complex_actions['wrapWithPairedDelimiter']} <T>",
-                    "description": "Wrap T with P",
+                    "spokenForm": f"<pair> {complex_actions['wrapWithPairedDelimiter']} <target>",
+                    "description": "Wrap <target> with <pair>",
                 }
             ],
         },
@@ -106,8 +106,8 @@ def get_actions():
             "type": "action",
             "variations": [
                 {
-                    "spokenForm": f"<P> {complex_actions['rewrap']} <T>",
-                    "description": "Rewrap T with P",
+                    "spokenForm": f"<pair> {complex_actions['rewrap']} <target>",
+                    "description": "Rewrap <target> with <pair>",
                 }
             ],
         },

src/cheatsheet_html/sections/compound_targets.py

@@ -27,8 +27,8 @@ def get_compound_targets():
             "type": "compoundTargetConnective",
             "variations": [
                 {
-                    "spokenForm": f"<T1> {list_connective_term} <T2>",
-                    "description": "T1 and T2",
+                    "spokenForm": f"<target 1> {list_connective_term} <target 2>",
+                    "description": "<target 1> and <target 2>",
                 },
             ],
         },
@@ -48,12 +48,12 @@ def get_entry(spoken_form, id):
         "type": "compoundTargetConnective",
         "variations": [
             {
-                "spokenForm": f"<T1> {spoken_form} <T2>",
-                "description": formatter("T1", "T2"),
+                "spokenForm": f"<target 1> {spoken_form} <target 2>",
+                "description": formatter("<target 1>", "<target 2>"),
             },
             {
-                "spokenForm": f"{spoken_form} <T>",
-                "description": formatter("S", "T"),
+                "spokenForm": f"{spoken_form} <target>",
+                "description": formatter("selection", "<target>"),
             },
         ],
     }

src/cheatsheet_html/sections/modifiers.py

@@ -4,6 +4,11 @@
     "simple_modifier",
     "interior_modifier",
     "head_tail_modifier",
+    "simple_scope_modifier",
+    "first_modifier",
+    "last_modifier",
+    "previous_next_modifier",
+    "backward_modifier",
 ]
 
 
@@ -15,6 +20,12 @@ def get_modifiers():
     complex_modifier_ids = [
         "extendThroughStartOf",
         "extendThroughEndOf",
+        "every",
+        "first",
+        "last",
+        "previous",
+        "next",
+        "backward",
     ]
     simple_modifiers = {
         key: value
@@ -47,8 +58,8 @@ def get_modifiers():
                     "description": "Extend through start of line",
                 },
                 {
-                    "spokenForm": f"{complex_modifiers['extendThroughStartOf']} <M>",
-                    "description": "Extend through start of <M>",
+                    "spokenForm": f"{complex_modifiers['extendThroughStartOf']} <modifier>",
+                    "description": "Extend through start of <modifier>",
                 },
             ],
         },
@@ -61,8 +72,88 @@ def get_modifiers():
                     "description": "Extend through end of line",
                 },
                 {
-                    "spokenForm": f"{complex_modifiers['extendThroughEndOf']} <M>",
-                    "description": "Extend through end of <M>",
+                    "spokenForm": f"{complex_modifiers['extendThroughEndOf']} <modifier>",
+                    "description": "Extend through end of <modifier>",
+                },
+            ],
+        },
+        {
+            "id": "containingScope",
+            "type": "modifier",
+            "variations": [
+                {
+                    "spokenForm": f"<scope>",
+                    "description": "Containing instance of <scope>",
+                },
+            ],
+        },
+        {
+            "id": "every",
+            "type": "modifier",
+            "variations": [
+                {
+                    "spokenForm": f"{complex_modifiers['every']} <scope>",
+                    "description": "Every instance of <scope>",
+                },
+            ],
+        },
+        {
+            "id": "relativeScope",
+            "type": "modifier",
+            "variations": [
+                {
+                    "spokenForm": f"{complex_modifiers['previous']} <scope>",
+                    "description": "Previous instance of <scope>",
+                },
+                {
+                    "spokenForm": f"{complex_modifiers['next']} <scope>",
+                    "description": "Next instance of <scope>",
+                },
+                {
+                    "spokenForm": f"<ordinal> {complex_modifiers['previous']} <scope>",
+                    "description": "<ordinal> instance of <scope> before target",
+                },
+                {
+                    "spokenForm": f"<ordinal> {complex_modifiers['next']} <scope>",
+                    "description": "<ordinal> instance of <scope> after target",
+                },
+                {
+                    "spokenForm": f"{complex_modifiers['previous']} <number> <scope>s",
+                    "description": "previous <number> instances of <scope>",
+                },
+                {
+                    "spokenForm": f"<number> <scope>s {complex_modifiers['backward']}",
+                    "description": "<number> instances of <scope> including target, going backwards",
+                },
+                {
+                    "spokenForm": f"<number> <scope>s",
+                    "description": "<number> instances of <scope> including target, going forwards",
+                },
+                {
+                    "spokenForm": f"{complex_modifiers['next']} <number> <scope>s",
+                    "description": "next <number> instances of <scope>",
+                },
+            ],
+        },
+        {
+            "id": "ordinalScope",
+            "type": "modifier",
+            "variations": [
+                {
+                    "spokenForm": f"<ordinal> <scope>",
+                    "description": "<ordinal> instance of <scope> in iteration scope",
+                },
+                {
+                    "spokenForm": f"<ordinal> {complex_modifiers['last']} <scope>",
+                    "description": "<ordinal>-to-last instance of <scope> in iteration scope",
+                },
+                {
+                    "spokenForm": f"{complex_modifiers['first']} <number> <scope>s",
+                    "description": "First <number> instances of <scope> in iteration scope",
+                },
+                {
+                    "spokenForm": f"{complex_modifiers['last']} <number> <scope>s",
+                    "description": "Last <number> instances of <scope> in iteration scope",
                 },
             ],
         },

src/csv_overrides.py

@@ -7,6 +7,7 @@
 from talon import Context, Module, actions, app, fs
 
 from .conventions import get_cursorless_list_name
+from .vendor.inflection import pluralize
 
 SPOKEN_FORM_HEADER = "Spoken form"
 CURSORLESS_IDENTIFIER_HEADER = "Cursorless identifier"
@@ -30,6 +31,7 @@ def init_csv_and_watch_changes(
     headers: list[str] = [SPOKEN_FORM_HEADER, CURSORLESS_IDENTIFIER_HEADER],
     ctx: Context = Context(),
     no_update_file: bool = False,
+    pluralize_lists: Optional[list[str]] = [],
 ):
     """
     Initialize a cursorless settings csv, creating it if necessary, and watch
@@ -56,6 +58,7 @@ def init_csv_and_watch_changes(
         unknown values in this list
         no_update_file Optional[bool]: Set this to `TRUE` to indicate that we should
         not update the csv. This is used generally in case there was an issue coming up with the default set of values so we don't want to persist those to disk
+        pluralize_lists: Create plural version of given lists
     """
     if extra_ignored_values is None:
         extra_ignored_values = []
@@ -80,6 +83,7 @@ def on_watch(path, flags):
                 extra_ignored_values,
                 allow_unknown_values,
                 default_list_name,
+                pluralize_lists,
                 ctx,
             )
 
@@ -100,6 +104,7 @@ def on_watch(path, flags):
             extra_ignored_values,
             allow_unknown_values,
             default_list_name,
+            pluralize_lists,
             ctx,
         )
     else:
@@ -111,6 +116,7 @@ def on_watch(path, flags):
             extra_ignored_values,
             allow_unknown_values,
             default_list_name,
+            pluralize_lists,
             ctx,
         )
 
@@ -130,6 +136,7 @@ def update_dicts(
     extra_ignored_values: list[str],
     allow_unknown_values: bool,
     default_list_name: Optional[str],
+    pluralize_lists: Optional[list[str]],
     ctx: Context,
 ):
     # Create map with all default values
@@ -173,7 +180,11 @@ def update_dicts(
 
     # Assign result to talon context list
     for list_name, dict in results.items():
-        ctx.lists[get_cursorless_list_name(list_name)] = dict
+        list_singular_name = get_cursorless_list_name(list_name)
+        ctx.lists[list_singular_name] = dict
+        if list_name in pluralize_lists:
+            list_plural_name = f"{list_singular_name}_plural"
+            ctx.lists[list_plural_name] = {pluralize(k): v for k, v in dict.items()}
 
 
 def update_file(

src/modifiers/modifiers.py

@@ -3,7 +3,10 @@
 from ..csv_overrides import init_csv_and_watch_changes
 from .head_tail import head_tail_modifiers
 from .interior import interior_modifiers
+from .ordinal_scope import first_modifiers, last_modifiers
 from .range_type import range_types
+from .relative_scope import backward_modifiers, previous_next_modifiers
+from .simple_scope_modifier import simple_scope_modifiers
 
 mod = Module()
 
@@ -40,9 +43,9 @@ def cursorless_simple_modifier(m) -> dict[str, str]:
 # rather than just "inside".
 head_tail_swallowed_modifiers = [
     "<user.cursorless_simple_modifier>",  # bounds, just, leading, trailing
-    "<user.cursorless_containing_scope>",  # funk, state, class
+    "<user.cursorless_simple_scope_modifier>",  # funk, state, class, every funk
     "<user.cursorless_ordinal_scope>",  # first past second word
-    "<user.cursorless_relative_scope>",  # next funk
+    "<user.cursorless_relative_scope>",  # next funk, 3 funks
     "<user.cursorless_surrounding_pair>",  # matching/pair [curly, round]
 ]
 
@@ -73,6 +76,11 @@ def on_ready():
             "interior_modifier": interior_modifiers,
             "head_tail_modifier": head_tail_modifiers,
             "range_type": range_types,
+            "simple_scope_modifier": simple_scope_modifiers,
+            "first_modifier": first_modifiers,
+            "last_modifier": last_modifiers,
+            "previous_next_modifier": previous_next_modifiers,
+            "backward_modifier": backward_modifiers,
         },
     )