Contiguous scope

data/fixtures/scopes/java/comment.block.scope

@@ -0,0 +1,15 @@
+/*
+  Hello world
+*/
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-2:2
+  >--
+0| /*
+1|   Hello world
+2| */
+   --<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/java/comment.block2.scope

@@ -0,0 +1,15 @@
+/**
+* Hello world
+*/
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-2:2
+  >---
+0| /**
+1| * Hello world
+2| */
+   --<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/java/comment.block3.scope

@@ -0,0 +1,13 @@
+// Hello
+// World
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-1:8
+  >--------
+0| // Hello
+1| // World
+   --------<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/java/comment.line.scope

@@ -0,0 +1,10 @@
+// Hello world
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-0:14
+  >--------------<
+0| // Hello world
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/javascript.core/comment.block3.scope

@@ -0,0 +1,13 @@
+// Hello
+// World
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-1:8
+  >--------
+0| // Hello
+1| // World
+   --------<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/python/comment.block.scope

@@ -0,0 +1,13 @@
+# Hello
+# World
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-1:7
+  >-------
+0| # Hello
+1| # World
+   -------<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/python/comment.line.scope

@@ -0,0 +1,10 @@
+# Hello world
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-0:13
+  >-------------<
+0| # Hello world
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/talon/comment.block.scope

@@ -0,0 +1,13 @@
+# Hello
+# World
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-1:7
+  >-------
+0| # Hello
+1| # World
+   -------<
+
+[Insertion delimiter] = "\n"

data/fixtures/scopes/talon/comment.line.scope

@@ -0,0 +1,10 @@
+# Hello world
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-0:13
+  >-------------<
+0| # Hello world
+
+[Insertion delimiter] = "\n"

packages/common/src/scopeSupportFacets/java.ts

@@ -23,6 +23,9 @@ export const javaScopeSupport: LanguageScopeSupportFacetMap = {
   "argument.actual": supported,
   "argument.actual.iteration": supported,
 
+  "comment.line": supported,
+  "comment.block": supported,
+
   element: notApplicable,
   tags: notApplicable,
   attribute: notApplicable,

packages/common/src/scopeSupportFacets/python.ts

@@ -23,6 +23,8 @@ export const pythonScopeSupport: LanguageScopeSupportFacetMap = {
   "argument.formal": supportedLegacy,
   "argument.formal.iteration": supportedLegacy,
 
+  "comment.line": supported,
+  "comment.block": supported,
   "branch.if": supported,
   "branch.if.iteration": supported,
   "branch.switchCase": supported,

packages/common/src/scopeSupportFacets/talon.ts

@@ -9,4 +9,7 @@ const { supported } = ScopeSupportFacetLevel;
 
 export const talonScopeSupport: LanguageScopeSupportFacetMap = {
   command: supported,
+
+  "comment.line": supported,
+  "comment.block": supported,
 };

packages/common/src/util/itertools.ts

@@ -65,3 +65,17 @@ export function isEmptyIterable(iterable: Iterable<unknown>): boolean {
 
   return true;
 }
+
+/**
+ * Returns the first element of the given iterable, or `undefined` if the
+ * iterable is empty
+ * @param iterable The iterable to get the first element of
+ * @returns The first element of the iterable, or `undefined` if the iterable
+ * is empty
+ */
+export function next<T>(generator: Iterable<T>): T | undefined {
+  for (const value of generator) {
+    return value;
+  }
+  return undefined;
+}

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

@@ -7,10 +7,12 @@ import {
 import { basename, dirname, join } from "path";
 import { TreeSitterScopeHandler } from "../processTargets/modifiers/scopeHandlers";
 import { ide } from "../singletons/ide.singleton";
-import { TreeSitter } from "../typings/TreeSitter";
+import type { TreeSitter } from "../typings/TreeSitter";
 import { matchAll } from "../util/regex";
 import { TreeSitterQuery } from "./TreeSitterQuery";
 import { validateQueryCaptures } from "./TreeSitterQuery/validateQueryCaptures";
+import type { ScopeHandler } from "../processTargets/modifiers/scopeHandlers/scopeHandler.types";
+import { ContiguousScopeHandler } from "../processTargets/modifiers/scopeHandlers/ContiguousScopeHandler";
 
 /**
  * Represents a language definition for a single language, including the
@@ -70,12 +72,21 @@ export class LanguageDefinition {
    * undefined if the given scope type / language id combination is still using
    * legacy pathways
    */
-  getScopeHandler(scopeType: ScopeType) {
+  getScopeHandler(scopeType: ScopeType): ScopeHandler | undefined {
     if (!this.query.captureNames.includes(scopeType.type)) {
       return undefined;
     }
 
-    return new TreeSitterScopeHandler(this.query, scopeType as SimpleScopeType);
+    const scopeHandler = new TreeSitterScopeHandler(
+      this.query,
+      scopeType as SimpleScopeType,
+    );
+
+    if (useContiguousScopeHandler(scopeType)) {
+      return new ContiguousScopeHandler(scopeHandler);
+    }
+
+    return scopeHandler;
   }
 }
 
@@ -168,6 +179,18 @@ async function readQueryFileAndImports(
   return Object.values(rawQueryStrings).join("\n");
 }
 
+/**
+ * Returns true if the given scope type should use a contiguous scope handler.
+ */
+function useContiguousScopeHandler(scopeType: ScopeType): boolean {
+  switch (scopeType.type) {
+    case "comment":
+      return true;
+    default:
+      return false;
+  }
+}
+
 function validateImportSyntax(
   file: string,
   relativeImportPath: string,

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

@@ -81,6 +81,7 @@ export class TreeSitterQuery {
             range: getNodeRange(node),
             insertionDelimiter: undefined,
             allowMultiple: false,
+            contiguous: false,
           })),
         }),
       )
@@ -113,6 +114,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,18 @@ class AllowMultiple extends QueryPredicateOperator<AllowMultiple> {
   }
 }
 
+/** Indicates that it's okay for this scope to extend contiguously through its siblings of same type. */
+class Contiguous extends QueryPredicateOperator<Contiguous> {
+  name = "contiguous!" as const;
+  schema = z.tuple([q.node]);
+
+  run(nodeInfo: MutableQueryCapture) {
+    nodeInfo.contiguous = true;
+
+    return true;
+  }
+}
+
 /**
  * A predicate operator that logs a node, for debugging.
  */
@@ -254,6 +266,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,