Add "identifier" scope

Author: pokey

cursorless-talon/src/modifiers/scopes.py

@@ -57,6 +57,7 @@
     # Text-based scope types
     "char": "character",
     "word": "word",
+    "identifier": "identifier",
     "block": "paragraph",
     "cell": "notebookCell",
     "file": "document",

src/processTargets/modifiers/scopeHandlers/IdentifierScopeHandler.ts

@@ -0,0 +1,34 @@
+import { NestedScopeHandler } from ".";
+import { getMatcher } from "../../../core/tokenizer";
+import type { ScopeType } from "../../../typings/targetDescriptor.types";
+import { getMatchesInRange } from "../../../util/regex";
+import { TokenTarget } from "../../targets";
+import type { TargetScope } from "./scope.types";
+
+export default class IdentifierScopeHandler extends NestedScopeHandler {
+  public readonly scopeType: ScopeType = { type: "identifier" };
+  public readonly iterationScopeType: ScopeType = { type: "line" };
+
+  private regex: RegExp;
+
+  constructor(languageId: string) {
+    super(languageId);
+    this.regex = getMatcher(languageId).identifierMatcher;
+  }
+
+  protected getScopesInIterationScope({
+    editor,
+    domain,
+  }: TargetScope): TargetScope[] {
+    return getMatchesInRange(this.regex, editor, domain).map((range) => ({
+      editor,
+      domain: range,
+      getTarget: (isReversed) =>
+        new TokenTarget({
+          editor,
+          contentRange: range,
+          isReversed,
+        }),
+    }));
+  }
+}

src/processTargets/modifiers/scopeHandlers/getScopeHandler.ts

@@ -1,4 +1,4 @@
-import { LineScopeHandler, TokenScopeHandler } from ".";
+import { IdentifierScopeHandler, LineScopeHandler, TokenScopeHandler } from ".";
 import type { ScopeType } from "../../../typings/targetDescriptor.types";
 import type { ScopeHandler } from "./scopeHandler.types";
 
@@ -13,21 +13,23 @@ import type { ScopeHandler } from "./scopeHandler.types";
  * function.
  *
  * @param scopeType The scope type for which to get a scope handler
- * @param _languageId The language id of the document where the scope handler
+ * @param languageId The language id of the document where the scope handler
  * will be used
  * @returns A scope handler for the given scope type and language id, or
  * undefined if the given scope type / language id combination is still using
  * legacy pathways
  */
 export default function getScopeHandler(
   scopeType: ScopeType,
-  _languageId?: string
+  languageId?: string
 ): ScopeHandler | undefined {
   switch (scopeType.type) {
     case "token":
       return new TokenScopeHandler();
     case "line":
       return new LineScopeHandler();
+    case "identifier":
+      return new IdentifierScopeHandler(languageId!);
     default:
       return undefined;
   }

src/processTargets/modifiers/scopeHandlers/index.ts

@@ -2,6 +2,8 @@ export * from "./NestedScopeHandler";
 export { default as NestedScopeHandler } from "./NestedScopeHandler";
 export * from "./LineScopeHandler";
 export { default as LineScopeHandler } from "./LineScopeHandler";
+export * from "./IdentifierScopeHandler";
+export { default as IdentifierScopeHandler } from "./IdentifierScopeHandler";
 export * from "./TokenScopeHandler";
 export { default as TokenScopeHandler } from "./TokenScopeHandler";
 export * from "./getScopeHandler";

src/test/suite/fixtures/recorded/scopes/clearEveryIdentifier.yml

@@ -0,0 +1,25 @@
+languageId: plaintext
+command:
+  spokenForm: clear every identifier
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: everyScope
+          scopeType: {type: identifier}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: aaa bbb.
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: " ."
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+    - anchor: {line: 0, character: 1}
+      active: {line: 0, character: 1}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: everyScope, scopeType: {type: identifier}}]}]

src/test/suite/fixtures/recorded/scopes/clearIdentifier.yml

@@ -0,0 +1,23 @@
+languageId: plaintext
+command:
+  spokenForm: clear identifier
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: identifier}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: foo.
+  selections:
+    - anchor: {line: 0, character: 3}
+      active: {line: 0, character: 3}
+  marks: {}
+finalState:
+  documentContents: .
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: identifier}}]}]

src/test/suite/fixtures/recorded/scopes/clearIdentifier2.yml

@@ -0,0 +1,19 @@
+languageId: plaintext
+command:
+  spokenForm: clear identifier
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: identifier}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: .
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: identifier}}]}]
+thrownError: {name: NoContainingScopeError}

src/test/suite/fixtures/recorded/scopes/clearLastIdentifier.yml

@@ -0,0 +1,25 @@
+languageId: plaintext
+command:
+  spokenForm: clear last identifier
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: ordinalScope
+          scopeType: {type: identifier}
+          start: -1
+          length: 1
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: aaa bbb.
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: aaa .
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: ordinalScope, scopeType: {type: identifier}, start: -1, length: 1}]}]

src/typings/targetDescriptor.types.ts

@@ -128,6 +128,7 @@ export type SimpleScopeTypeType =
   | "document"
   | "character"
   | "word"
+  | "identifier"
   | "nonWhitespaceSequence"
   | "boundedNonWhitespaceSequence"
   | "url";