Added cache

Author: AndreasArvidsson

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

@@ -13,10 +13,13 @@ import {
   type TextDocument,
 } from "@cursorless/common";
 import { TreeSitterScopeHandler } from "../processTargets/modifiers/scopeHandlers";
+import { LanguageDefinitionCache } from "./LanguageDefinitionCache";
 import { TreeSitterQuery } from "./TreeSitterQuery";
 import type { QueryCapture } from "./TreeSitterQuery/QueryCapture";
 import { validateQueryCaptures } from "./TreeSitterQuery/validateQueryCaptures";
 
+const cache = new LanguageDefinitionCache();
+
 /**
  * Represents a language definition for a single language, including the
  * tree-sitter query used to extract scopes for the given language
@@ -94,28 +97,26 @@ export class LanguageDefinition {
     document: TextDocument,
     captureName: SimpleScopeTypeType,
   ): QueryCapture[] {
-    return this.query
-      .matches(document)
-      .map((match) => match.captures.find(({ name }) => name === captureName))
-      .filter((capture) => capture != null);
+    if (!cache.isValid(document)) {
+      cache.update(document, this.getCapturesMap(document));
+    }
+
+    return cache.get(captureName);
   }
 
-  getMultipleCaptures(
-    document: TextDocument,
-    captureNames: SimpleScopeTypeType[],
-  ): StringRecord<QueryCapture[]> {
+  /**
+   * This is a low level function that returns a map of all captures in the document.
+   */
+  private getCapturesMap(document: TextDocument): StringRecord<QueryCapture[]> {
     const matches = this.query.matches(document);
     const result: StringRecord<QueryCapture[]> = {};
-    const captureNamesSet = new Set<string>(captureNames);
 
     for (const match of matches) {
       for (const capture of match.captures) {
-        if (captureNamesSet.has(capture.name)) {
-          if (result[capture.name] == null) {
-            result[capture.name] = [];
-          }
-          result[capture.name]!.push(capture);
+        if (result[capture.name] == null) {
+          result[capture.name] = [];
         }
+        result[capture.name]!.push(capture);
       }
     }
 

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

@@ -0,0 +1,36 @@
+import type {
+  SimpleScopeTypeType,
+  StringRecord,
+  TextDocument,
+} from "@cursorless/common";
+import type { QueryCapture } from "./TreeSitterQuery/QueryCapture";
+import { ide } from "..";
+
+export class LanguageDefinitionCache {
+  private languageId: string = "";
+  private documentUri: string = "";
+  private documentVersion: number = -1;
+  private captures: StringRecord<QueryCapture[]> = {};
+
+  isValid(document: TextDocument) {
+    if (ide().runMode === "test") {
+      return false;
+    }
+    return (
+      this.languageId === document.languageId &&
+      this.documentUri === document.uri.toString() &&
+      this.documentVersion === document.version
+    );
+  }
+
+  update(document: TextDocument, captures: StringRecord<QueryCapture[]>) {
+    this.languageId = document.languageId;
+    this.documentUri = document.uri.toString();
+    this.documentVersion = document.version;
+    this.captures = captures;
+  }
+
+  get(captureName: SimpleScopeTypeType): QueryCapture[] {
+    return this.captures[captureName] ?? [];
+  }
+}

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/getDelimiterOccurrences.ts

@@ -22,14 +22,12 @@ export function getDelimiterOccurrences(
     return [];
   }
 
-  const captures = languageDefinition?.getMultipleCaptures(document, [
-    "disqualifyDelimiter",
-    "textFragment",
-  ]);
   const disqualifyDelimiters = createRangeIterator(
-    captures?.disqualifyDelimiter,
+    languageDefinition?.getCaptures(document, "disqualifyDelimiter"),
+  );
+  const textFragments = createRangeIterator(
+    languageDefinition?.getCaptures(document, "textFragment"),
   );
-  const textFragments = createRangeIterator(captures?.textFragment);
 
   const delimiterTextToDelimiterInfoMap = Object.fromEntries(
     individualDelimiters.map((individualDelimiter) => [