Renamed glyph_scope to literal_scope

cursorless-dev · Dec 8, 2023 · 4ed60fb · 4ed60fb
1 parent d426a66
commit 4ed60fb
Show file tree

Hide file tree

Showing 19 changed files with 66 additions and 66 deletions.
diff --git a/cursorless-talon/src/cheatsheet/sections/modifiers.py b/cursorless-talon/src/cheatsheet/sections/modifiers.py
@@ -10,7 +10,7 @@
     "previous_next_modifier",
     "forward_backward_modifier",
     "position",
-    "glyph_modifier",
+    "literal_modifier",
 ]
 
 
@@ -29,7 +29,7 @@ def get_modifiers():
         "next",
         "backward",
         "forward",
-        "glyph",
+        "literal",
     ]
     simple_modifiers = {
         key: value
@@ -104,12 +104,12 @@ def get_modifiers():
             ],
         },
         {
-            "id": "glyph",
+            "id": "literal",
             "type": "modifier",
             "variations": [
                 {
-                    "spokenForm": f"{complex_modifiers['glyph']} <glyph>",
-                    "description": "First instance of <glyph>",
+                    "spokenForm": f"{complex_modifiers['literal']} <literal>",
+                    "description": "First instance of <literal>",
                 },
             ],
         },

diff --git a/cursorless-talon/src/modifiers/glyph_scope.py b/cursorless-talon/src/modifiers/glyph_scope.py
diff --git a/cursorless-talon/src/modifiers/literal_scope.py b/cursorless-talon/src/modifiers/literal_scope.py
@@ -0,0 +1,30 @@
+from talon import Module
+
+mod = Module()
+
+mod.list(
+    "cursorless_literal_scope_type",
+    desc="Cursorless literal scope type",
+)
+mod.list(
+    "cursorless_literal_scope_type_plural",
+    desc="Plural version of Cursorless literal scope type",
+)
+
+
+@mod.capture(rule="{user.cursorless_literal_scope_type} <user.any_alphanumeric_key>")
+def cursorless_literal_scope_type(m) -> dict[str, str]:
+    return {
+        "type": "literal",
+        "literal": m.any_alphanumeric_key,
+    }
+
+
+@mod.capture(
+    rule="{user.cursorless_literal_scope_type_plural} <user.any_alphanumeric_key>"
+)
+def cursorless_literal_scope_type_plural(m) -> dict[str, str]:
+    return {
+        "type": "literal",
+        "literal": m.any_alphanumeric_key,
+    }
diff --git a/cursorless-talon/src/modifiers/scopes.py b/cursorless-talon/src/modifiers/scopes.py
@@ -15,7 +15,7 @@
 
 
 @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_literal_scope_type> | {user.cursorless_custom_regex_scope_type}"
 )
 def cursorless_scope_type(m) -> dict[str, str]:
     """Cursorless scope type singular"""
@@ -25,15 +25,15 @@ def cursorless_scope_type(m) -> dict[str, str]:
         pass
 
     try:
-        return m.cursorless_glyph_scope_type
+        return m.cursorless_literal_scope_type
     except AttributeError:
         pass
 
     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_literal_scope_type_plural> | {user.cursorless_custom_regex_scope_type_plural}"
 )
 def cursorless_scope_type_plural(m) -> dict[str, str]:
     """Cursorless scope type plural"""
@@ -43,7 +43,7 @@ def cursorless_scope_type_plural(m) -> dict[str, str]:
         pass
 
     try:
-        return m.cursorless_glyph_scope_type_plural
+        return m.cursorless_literal_scope_type_plural
     except AttributeError:
         pass
 

diff --git a/cursorless-talon/src/spoken_forms.json b/cursorless-talon/src/spoken_forms.json
@@ -171,8 +171,8 @@
     "surrounding_pair_scope_type": {
       "string": "string"
     },
-    "glyph_scope_type": {
-      "glyph": "glyph"
+    "literal_scope_type": {
+      "glyph": "literal"
     }
   },
   "paired_delimiters.csv": {

diff --git a/cursorless-talon/src/spoken_forms.py b/cursorless-talon/src/spoken_forms.py
@@ -68,7 +68,7 @@ def ret(filename: str, *args: P.args, **kwargs: P.kwargs) -> R:
     "wrapper_only_paired_delimiter": "pairedDelimiter",
     "surrounding_pair_scope_type": "pairedDelimiter",
     "scope_type": "simpleScopeTypeType",
-    "glyph_scope_type": "complexScopeTypeType",
+    "literal_scope_type": "complexScopeTypeType",
     "custom_regex_scope_type": "customRegex",
 }
 
@@ -126,7 +126,7 @@ def handle_new_values(csv_name: str, values: list[SpokenFormEntry]):
         handle_csv("experimental/miscellaneous.csv"),
         handle_csv(
             "modifier_scope_types.csv",
-            pluralize_lists=["scope_type", "glyph_scope_type"],
+            pluralize_lists=["scope_type", "literal_scope_type"],
             extra_allowed_values=[
                 "private.fieldAccess",
                 "private.switchStatementSubject",

diff --git a/packages/common/src/types/command/PartialTargetDescriptor.types.ts b/packages/common/src/types/command/PartialTargetDescriptor.types.ts
@@ -205,17 +205,17 @@ export interface OneOfScopeType {
   scopeTypes: ScopeType[];
 }
 
-export interface GlyphScopeType {
-  type: "glyph";
-  character: string;
+export interface LiteralScopeType {
+  type: "literal";
+  literal: string;
 }
 
 export type ScopeType =
   | SimpleScopeType
   | SurroundingPairScopeType
   | CustomRegexScopeType
   | OneOfScopeType
-  | GlyphScopeType;
+  | LiteralScopeType;
 
 export interface ContainingSurroundingPairModifier
   extends ContainingScopeModifier {

diff --git a/packages/cursorless-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts b/packages/cursorless-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts
@@ -208,10 +208,10 @@ export class PrimitiveTargetSpokenFormGenerator {
     switch (scopeType.type) {
       case "oneOf":
         throw new NoSpokenFormError(`Scope type '${scopeType.type}'`);
-      case "glyph":
+      case "literal":
         return [
-          this.spokenFormMap.complexScopeTypeType.glyph,
-          characterToSpokenForm(scopeType.character),
+          this.spokenFormMap.complexScopeTypeType.literal,
+          characterToSpokenForm(scopeType.literal),
         ];
       case "surroundingPair": {
         const pair = this.spokenFormMap.pairedDelimiter[scopeType.delimiter];

diff --git a/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts b/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts
@@ -1,7 +1,7 @@
 import {
   CustomRegexScopeType,
   Direction,
-  GlyphScopeType,
+  LiteralScopeType,
   ScopeType,
 } from "@cursorless/common";
 import { imap } from "itertools";
@@ -69,14 +69,14 @@ export class CustomRegexScopeHandler extends RegexStageBase {
   }
 }
 
-export class GlyphScopeHandler extends RegexStageBase {
+export class LiteralScopeHandler extends RegexStageBase {
   get regex() {
-    return new RegExp(escapeRegExp(this.scopeType.character), "gui");
+    return new RegExp(escapeRegExp(this.scopeType.literal), "gui");
   }
 
   constructor(
     scopeHandlerFactory: ScopeHandlerFactory,
-    readonly scopeType: GlyphScopeType,
+    readonly scopeType: LiteralScopeType,
     languageId: string,
   ) {
     super(scopeHandlerFactory, scopeType, languageId);

diff --git a/...s/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts b/...s/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts
@@ -8,7 +8,7 @@ import { OneOfScopeHandler } from "./OneOfScopeHandler";
 import { ParagraphScopeHandler } from "./ParagraphScopeHandler";
 import {
   CustomRegexScopeHandler,
-  GlyphScopeHandler,
+  LiteralScopeHandler,
   NonWhitespaceSequenceScopeHandler,
   UrlScopeHandler,
 } from "./RegexScopeHandler";
@@ -73,8 +73,8 @@ export class ScopeHandlerFactoryImpl implements ScopeHandlerFactory {
         return new UrlScopeHandler(this, scopeType, languageId);
       case "customRegex":
         return new CustomRegexScopeHandler(this, scopeType, languageId);
-      case "glyph":
-        return new GlyphScopeHandler(this, scopeType, languageId);
+      case "literal":
+        return new LiteralScopeHandler(this, scopeType, languageId);
       case "custom":
         return scopeType.scopeHandler;
       case "instance":

diff --git a/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts b/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts
@@ -173,7 +173,7 @@ function isLanguageSpecific(scopeType: ScopeType): boolean {
     case "notebookCell":
     case "surroundingPair":
     case "customRegex":
-    case "glyph":
+    case "literal":
       return false;
 
     case "oneOf":

diff --git a/packages/cursorless-engine/src/spokenForms/SpokenFormType.ts b/packages/cursorless-engine/src/spokenForms/SpokenFormType.ts
@@ -14,7 +14,7 @@ import {
 export interface SpokenFormMapKeyTypes {
   pairedDelimiter: SpeakableSurroundingPairName;
   simpleScopeTypeType: SimpleScopeTypeType;
-  complexScopeTypeType: "glyph";
+  complexScopeTypeType: "literal";
   surroundingPairForceDirection: "left" | "right";
 
   /**

diff --git a/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts b/packages/cursorless-engine/src/spokenForms/defaultSpokenFormMapCore.ts
@@ -101,7 +101,7 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = {
     ["private.switchStatementSubject"]: isPrivate("subject"),
   },
   complexScopeTypeType: {
-    glyph: "glyph",
+    literal: "glyph",
   },
 
   surroundingPairForceDirection: {

diff --git a/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearEveryGlyphAir.yml b/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearEveryGlyphAir.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: everyScope
-          scopeType: {type: glyph, character: a}
+          scopeType: {type: literal, literal: a}
   usePrePhraseSnapshot: true
 initialState:
   documentContents: abc$!4123a

diff --git a/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearFinalGlyphAir.yml b/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearFinalGlyphAir.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: ordinalScope
-          scopeType: {type: glyph, character: a}
+          scopeType: {type: literal, literal: a}
           start: -1
           length: 1
   usePrePhraseSnapshot: true

diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearGlyphAir.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearGlyphAir.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: containingScope
-          scopeType: {type: glyph, character: a}
+          scopeType: {type: literal, literal: a}
   usePrePhraseSnapshot: true
 initialState:
   documentContents: abc$!4123a

diff --git a/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphBat.yml b/packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphBat.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: relativeScope
-          scopeType: {type: glyph, character: b}
+          scopeType: {type: literal, literal: b}
           offset: 1
           length: 1
           direction: forward

diff --git a/...es/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphDollar.yml b/...es/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphDollar.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: relativeScope
-          scopeType: {type: glyph, character: $}
+          scopeType: {type: literal, literal: $}
           offset: 1
           length: 1
           direction: forward

diff --git a/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphOnyx.yml b/...ages/cursorless-vscode-e2e/src/suite/fixtures/recorded/scope/glyph/clearNextGlyphOnyx.yml
@@ -8,7 +8,7 @@ command:
       type: primitive
       modifiers:
         - type: relativeScope
-          scopeType: {type: glyph, character: å}
+          scopeType: {type: literal, literal: å}
           offset: 1
           length: 1
           direction: forward