Migrated surrounding pair scope handler (#2457)

Fixes #2316

## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] 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
- [x] Add `@disqualifyDelimiter` for all languages
- [x] Add plural form of surrounding pair
[scopes.py](https://github.com/cursorless-dev/cursorless/blob/5e9a2e955570cb43d5d07de8c861365e8361cc36/cursorless-talon/src/modifiers/scopes.py#L48)
- [x] Run talon tests
- [x] add multiline quad tests for plaintext?

---------

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

Author: 3 people

src/modifiers/modifiers.py

@@ -27,7 +27,7 @@ def cursorless_simple_modifier(m) -> dict[str, str]:
     "<user.cursorless_simple_scope_modifier>",  # funk, state, class, every funk
     "<user.cursorless_ordinal_scope>",  # first past second word
     "<user.cursorless_relative_scope>",  # next funk, 3 funks
-    "<user.cursorless_surrounding_pair>",  # matching/pair [curly, round]
+    "<user.cursorless_surrounding_pair_force_direction>",  # DEPRECATED "left quad" / "right quad"
 ]
 
 modifiers = [

src/modifiers/scopes.py

@@ -15,7 +15,10 @@
 
 
 @mod.capture(
-    rule="{user.cursorless_scope_type} | <user.cursorless_glyph_scope_type> | {user.cursorless_custom_regex_scope_type}"
+    rule="{user.cursorless_scope_type}"
+    " | <user.cursorless_surrounding_pair_scope_type>"
+    " | <user.cursorless_glyph_scope_type>"
+    " | {user.cursorless_custom_regex_scope_type}"
 )
 def cursorless_scope_type(m) -> dict[str, str]:
     """Cursorless scope type singular"""
@@ -24,16 +27,27 @@ def cursorless_scope_type(m) -> dict[str, str]:
     except AttributeError:
         pass
 
+    try:
+        return m.cursorless_surrounding_pair_scope_type
+    except AttributeError:
+        pass
+
     try:
         return m.cursorless_glyph_scope_type
     except AttributeError:
         pass
 
-    return {"type": "customRegex", "regex": m.cursorless_custom_regex_scope_type}
+    return {
+        "type": "customRegex",
+        "regex": m.cursorless_custom_regex_scope_type,
+    }
 
 
 @mod.capture(
-    rule="{user.cursorless_scope_type_plural} | <user.cursorless_glyph_scope_type_plural> | {user.cursorless_custom_regex_scope_type_plural}"
+    rule="{user.cursorless_scope_type_plural}"
+    " | <user.cursorless_surrounding_pair_scope_type_plural>"
+    " | <user.cursorless_glyph_scope_type_plural>"
+    " | {user.cursorless_custom_regex_scope_type_plural}"
 )
 def cursorless_scope_type_plural(m) -> dict[str, str]:
     """Cursorless scope type plural"""
@@ -42,6 +56,11 @@ def cursorless_scope_type_plural(m) -> dict[str, str]:
     except AttributeError:
         pass
 
+    try:
+        return m.cursorless_surrounding_pair_scope_type_plural
+    except AttributeError:
+        pass
+
     try:
         return m.cursorless_glyph_scope_type_plural
     except AttributeError:

src/modifiers/surrounding_pair.py

@@ -22,6 +22,10 @@
     "cursorless_surrounding_pair_scope_type",
     desc="Scope types that can function as surrounding pairs",
 )
+mod.list(
+    "cursorless_surrounding_pair_scope_type_plural",
+    desc="Plural form of scope types that can function as surrounding pairs",
+)
 
 
 @mod.capture(
@@ -30,29 +34,43 @@
         "{user.cursorless_surrounding_pair_scope_type}"
     )
 )
-def cursorless_surrounding_pair_scope_type(m) -> str:
+def cursorless_surrounding_pair_scope_type(m) -> dict[str, str]:
     """Surrounding pair scope type"""
     try:
-        return m.cursorless_surrounding_pair_scope_type
+        delimiter = m.cursorless_surrounding_pair_scope_type
     except AttributeError:
-        return m.cursorless_selectable_paired_delimiter
+        delimiter = m.cursorless_selectable_paired_delimiter
+    return {
+        "type": "surroundingPair",
+        "delimiter": delimiter,
+    }
 
 
 @mod.capture(
-    rule="[{user.cursorless_delimiter_force_direction}] <user.cursorless_surrounding_pair_scope_type>"
+    rule=(
+        "<user.cursorless_selectable_paired_delimiter_plural> |"
+        "{user.cursorless_surrounding_pair_scope_type_plural}"
+    )
 )
-def cursorless_surrounding_pair(m) -> dict[str, Any]:
-    """Expand to containing surrounding pair"""
+def cursorless_surrounding_pair_scope_type_plural(m) -> dict[str, str]:
+    """Plural surrounding pair scope type"""
     try:
-        surrounding_pair_scope_type = m.cursorless_surrounding_pair_scope_type
+        delimiter = m.cursorless_surrounding_pair_scope_type_plural
     except AttributeError:
-        surrounding_pair_scope_type = "any"
-
-    scope_type = {
+        delimiter = m.cursorless_selectable_paired_delimiter_plural
+    return {
         "type": "surroundingPair",
-        "delimiter": surrounding_pair_scope_type,
+        "delimiter": delimiter,
     }
 
+
+@mod.capture(
+    rule="{user.cursorless_delimiter_force_direction} <user.cursorless_surrounding_pair_scope_type>"
+)
+def cursorless_surrounding_pair_force_direction(m) -> dict[str, Any]:
+    """DEPRECATED: Expand to containing surrounding pair"""
+    scope_type = m.cursorless_surrounding_pair_scope_type
+
     with suppress(AttributeError):
         scope_type["forceDirection"] = m.cursorless_delimiter_force_direction
 

src/paired_delimiter.py

@@ -15,6 +15,15 @@
     desc="A paired delimiter that can be used as a scope type and as a wrapper",
 )
 
+mod.list(
+    "cursorless_selectable_only_paired_delimiter_plural",
+    desc="Plural form of a paired delimiter that can only be used as a scope type",
+)
+mod.list(
+    "cursorless_wrapper_selectable_paired_delimiter_plural",
+    desc="Plural form of a paired delimiter that can be used as a scope type and as a wrapper",
+)
+
 # Maps from the id we use in the spoken form csv to the delimiter strings
 paired_delimiters = {
     "curlyBrackets": ["{", "}"],
@@ -58,3 +67,16 @@ def cursorless_selectable_paired_delimiter(m) -> str:
         return m.cursorless_selectable_only_paired_delimiter
     except AttributeError:
         return m.cursorless_wrapper_selectable_paired_delimiter
+
+
+@mod.capture(
+    rule=(
+        "{user.cursorless_selectable_only_paired_delimiter_plural} |"
+        "{user.cursorless_wrapper_selectable_paired_delimiter_plural}"
+    )
+)
+def cursorless_selectable_paired_delimiter_plural(m) -> str:
+    try:
+        return m.cursorless_selectable_only_paired_delimiter_plural
+    except AttributeError:
+        return m.cursorless_wrapper_selectable_paired_delimiter_plural

src/spoken_forms.py

@@ -133,18 +133,29 @@ def handle_new_values(csv_name: str, values: list[SpokenFormEntry]):
         handle_csv("target_connectives.csv"),
         handle_csv("modifiers.csv"),
         handle_csv("positions.csv"),
-        handle_csv("paired_delimiters.csv"),
+        handle_csv(
+            "paired_delimiters.csv",
+            pluralize_lists=[
+                "selectable_only_paired_delimiter",
+                "wrapper_selectable_paired_delimiter",
+            ],
+        ),
         handle_csv("special_marks.csv"),
         handle_csv("scope_visualizer.csv"),
         handle_csv("experimental/experimental_actions.csv"),
         handle_csv("experimental/miscellaneous.csv"),
         handle_csv(
             "modifier_scope_types.csv",
-            pluralize_lists=["scope_type", "glyph_scope_type"],
+            pluralize_lists=[
+                "scope_type",
+                "glyph_scope_type",
+                "surrounding_pair_scope_type",
+            ],
             extra_allowed_values=[
                 "private.fieldAccess",
                 "private.switchStatementSubject",
                 "textFragment",
+                "disqualifyDelimiter",
             ],
             default_list_name="scope_type",
         ),