Added predicate

Author: AndreasArvidsson

packages/cursorless-engine/src/languages/TreeSitterQuery/QueryCapture.ts

@@ -36,6 +36,9 @@ export interface QueryCapture {
    * content ranges. */
   readonly allowMultiple: boolean;
 
+  /** Whether this scope should expand contiguously to its siblings. */
+  readonly contiguous: boolean;
+
   /** The insertion delimiter to use if any */
   readonly insertionDelimiter: string | undefined;
 }
@@ -63,6 +66,7 @@ export interface MutableQueryCapture extends QueryCapture {
   readonly document: TextDocument;
   range: Range;
   allowMultiple: boolean;
+  contiguous: boolean;
   insertionDelimiter: string | undefined;
 }
 

packages/cursorless-engine/src/languages/TreeSitterQuery/TreeSitterQuery.ts

@@ -82,6 +82,7 @@ export class TreeSitterQuery {
             range: getNodeRange(node),
             insertionDelimiter: undefined,
             allowMultiple: false,
+            contiguous: false,
           })),
         }),
       )
@@ -114,6 +115,7 @@ export class TreeSitterQuery {
               .map(({ range }) => range)
               .reduce((accumulator, range) => range.union(accumulator)),
             allowMultiple: captures.some((capture) => capture.allowMultiple),
+            contiguous: captures.some((capture) => capture.contiguous),
             insertionDelimiter: captures.find(
               (capture) => capture.insertionDelimiter != null,
             )?.insertionDelimiter,

packages/cursorless-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts

@@ -5,7 +5,10 @@ import assert from "assert";
 
 interface TestCase {
   name: string;
-  captures: Omit<QueryCapture, "allowMultiple" | "insertionDelimiter">[];
+  captures: Omit<
+    QueryCapture,
+    "allowMultiple" | "contiguous" | "insertionDelimiter"
+  >[];
   isValid: boolean;
   expectedErrorMessageIds: string[];
 }
@@ -192,6 +195,7 @@ suite("checkCaptureStartEnd", () => {
         testCase.captures.map((capture) => ({
           ...capture,
           allowMultiple: false,
+          contiguous: false,
           insertionDelimiter: undefined,
         })),
         messages,

packages/cursorless-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts

@@ -185,6 +185,23 @@ class AllowMultiple extends QueryPredicateOperator<AllowMultiple> {
   }
 }
 
+/** Indicates that it's okay for this scope to extend contiguously it through its siblings. */
+class Contiguous extends QueryPredicateOperator<Contiguous> {
+  name = "contiguous!" as const;
+  schema = z.union([z.tuple([q.node]), z.tuple([q.node, q.string])]);
+
+  run(nodeInfo: MutableQueryCapture, pattern?: string) {
+    if (pattern != null) {
+      const text = nodeInfo.document.getText(nodeInfo.range);
+      nodeInfo.contiguous = new RegExp(pattern, "s").test(text);
+    } else {
+      nodeInfo.contiguous = true;
+    }
+
+    return true;
+  }
+}
+
 /**
  * A predicate operator that logs a node, for debugging.
  */
@@ -254,6 +271,7 @@ export const queryPredicateOperators = [
   new ChildRange(),
   new ShrinkToMatch(),
   new AllowMultiple(),
+  new Contiguous(),
   new InsertionDelimiter(),
   new SingleOrMultilineDelimiter(),
   new HasMultipleChildrenOfType(),

packages/cursorless-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.test.ts

@@ -54,6 +54,7 @@ function fillOutCapture(capture: NameRange): MutableQueryCapture {
   return {
     ...capture,
     allowMultiple: false,
+    contiguous: false,
     insertionDelimiter: undefined,
     document: null as unknown as TextDocument,
     node: null as unknown as SyntaxNode,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ContiguousScopeHandler.ts

@@ -116,6 +116,10 @@ function* generateTargetRangesInDirection(
 }
 
 function isAdjacent(scope1: TargetScope, scope2: TargetScope): boolean {
+  if (!scope1.contiguous || !scope2.contiguous) {
+    return false;
+  }
+
   if (scope1.domain.isRangeEqual(scope2.domain)) {
     return true;
   }

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/BaseTreeSitterScopeHandler.ts

@@ -95,4 +95,5 @@ export abstract class BaseTreeSitterScopeHandler extends BaseScopeHandler {
 
 export interface ExtendedTargetScope extends TargetScope {
   allowMultiple: boolean;
+  contiguous: boolean;
 }

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/TreeSitterIterationScopeHandler.ts

@@ -42,7 +42,7 @@ export class TreeSitterIterationScopeHandler extends BaseTreeSitterScopeHandler
       return undefined;
     }
 
-    const { range: contentRange, allowMultiple } = capture;
+    const { range: contentRange, allowMultiple, contiguous } = capture;
 
     const domain =
       getRelatedRange(match, scopeTypeType, "iteration.domain", false) ??
@@ -52,6 +52,7 @@ export class TreeSitterIterationScopeHandler extends BaseTreeSitterScopeHandler
       editor,
       domain,
       allowMultiple,
+      contiguous,
       getTargets: (isReversed) => [
         new PlainTarget({
           editor,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/TreeSitterScopeHandler.ts

@@ -48,7 +48,12 @@ export class TreeSitterScopeHandler extends BaseTreeSitterScopeHandler {
       return undefined;
     }
 
-    const { range: contentRange, allowMultiple, insertionDelimiter } = capture;
+    const {
+      range: contentRange,
+      allowMultiple,
+      contiguous,
+      insertionDelimiter,
+    } = capture;
 
     const domain =
       getRelatedRange(match, scopeTypeType, "domain", true) ?? contentRange;
@@ -87,6 +92,7 @@ export class TreeSitterScopeHandler extends BaseTreeSitterScopeHandler {
       editor,
       domain,
       allowMultiple,
+      contiguous,
       getTargets: (isReversed) => [
         new ScopeTypeTarget({
           scopeTypeType,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/TreeSitterTextFragmentScopeHandler.ts

@@ -38,7 +38,7 @@ export class TreeSitterTextFragmentScopeHandler extends BaseTreeSitterScopeHandl
       return undefined;
     }
 
-    const { range: contentRange, allowMultiple } = capture;
+    const { range: contentRange, allowMultiple, contiguous } = capture;
 
     if (allowMultiple) {
       throw Error(
@@ -50,6 +50,7 @@ export class TreeSitterTextFragmentScopeHandler extends BaseTreeSitterScopeHandl
       editor,
       domain: contentRange,
       allowMultiple,
+      contiguous,
       getTargets: (isReversed) => [
         new PlainTarget({
           editor,