Latex scope migration (#2341)

AndreasArvidsson · pokey · web-flow · commit 6d3c24429ce7 · 2024-05-24T12:25:00.000Z
## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet --------- Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
diff --git a/data/fixtures/recorded/languages/latex/clearElm.yml b/data/fixtures/recorded/languages/latex/clearElm.yml
diff --git a/data/fixtures/recorded/languages/latex/clearEndTag.yml b/data/fixtures/recorded/languages/latex/clearEndTag.yml
diff --git a/data/fixtures/recorded/languages/latex/clearStartTag.yml b/data/fixtures/recorded/languages/latex/clearStartTag.yml
diff --git a/data/fixtures/recorded/languages/latex/clearTags.yml b/data/fixtures/recorded/languages/latex/clearTags.yml
diff --git a/data/fixtures/recorded/languages/latex/pourEnvironment.yml b/data/fixtures/recorded/languages/latex/pourEnvironment.yml
diff --git a/data/fixtures/scopes/latex/element.scope b/data/fixtures/scopes/latex/element.scope
@@ -0,0 +1,25 @@
+\begin{quote}
+    Hello
+\end{quote}
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-2:11
+  >-------------
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   -----------<
+
+[Interior: Content] = 1:4-1:9
+      >-----<
+1|     Hello
+[Interior: Removal] = 0:13-2:0
+               >
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   <
+
+[Insertion delimiter] = "\n"
diff --git a/data/fixtures/scopes/latex/endTag.scope b/data/fixtures/scopes/latex/endTag.scope
@@ -0,0 +1,18 @@
+\begin{quote}
+    Hello
+\end{quote}
+---
+
+[Content] =
+[Removal] = 2:0-2:11
+  >-----------<
+2| \end{quote}
+
+[Domain] = 0:0-2:11
+  >-------------
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   -----------<
+
+[Insertion delimiter] = " "
diff --git a/data/fixtures/scopes/latex/environment.scope b/data/fixtures/scopes/latex/environment.scope
@@ -0,0 +1,25 @@
+\begin{quote}
+    Hello
+\end{quote}
+---
+
+[Content] =
+[Removal] =
+[Domain] = 0:0-2:11
+  >-------------
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   -----------<
+
+[Interior: Content] = 1:4-1:9
+      >-----<
+1|     Hello
+[Interior: Removal] = 0:13-2:0
+               >
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   <
+
+[Insertion delimiter] = "\n"
diff --git a/data/fixtures/scopes/latex/startTag.scope b/data/fixtures/scopes/latex/startTag.scope
@@ -0,0 +1,18 @@
+\begin{quote}
+    Hello
+\end{quote}
+---
+
+[Content] =
+[Removal] = 0:0-0:13
+  >-------------<
+0| \begin{quote}
+
+[Domain] = 0:0-2:11
+  >-------------
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   -----------<
+
+[Insertion delimiter] = " "
diff --git a/data/fixtures/scopes/latex/tags.scope b/data/fixtures/scopes/latex/tags.scope
@@ -0,0 +1,25 @@
+\begin{quote}
+    Hello
+\end{quote}
+---
+
+[.1 Content] =
+[.1 Removal] = 0:0-0:13
+  >-------------<
+0| \begin{quote}
+
+[.1 Insertion delimiter] = " "
+
+[.2 Content] =
+[.2 Removal] = 2:0-2:11
+  >-----------<
+2| \end{quote}
+
+[.2 Insertion delimiter] = " "
+
+[Domain] = 0:0-2:11
+  >-------------
+0| \begin{quote}
+1|     Hello
+2| \end{quote}
+   -----------<
diff --git a/packages/common/src/scopeSupportFacets/latex.ts b/packages/common/src/scopeSupportFacets/latex.ts
@@ -11,4 +11,9 @@ const { supported, unsupported, notApplicable } = ScopeSupportFacetLevel;
 export const latexScopeSupport: LanguageScopeSupportFacetMap = {
   "comment.line": supported,
   "comment.block": supported,
+  element: supported,
+  startTag: supported,
+  endTag: supported,
+  tags: supported,
+  environment: supported,
 };
diff --git a/packages/common/src/scopeSupportFacets/scopeSupportFacetInfos.ts b/packages/common/src/scopeSupportFacets/scopeSupportFacetInfos.ts
@@ -35,6 +35,11 @@ export const scopeSupportFacetInfos: Record<
     scopeType: "attribute",
   },
 
+  environment: {
+    description: "An environment, eg in LaTeX",
+    scopeType: "environment",
+  },
+
   list: {
     description: "A list/array",
     scopeType: "list",
diff --git a/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts b/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts
@@ -9,6 +9,8 @@ const scopeSupportFacets = [
   "endTag",
   "attribute",
 
+  "environment",
+
   "list",
   "map",
   "ifStatement",
diff --git a/packages/cursorless-engine/src/languages/latex.ts b/packages/cursorless-engine/src/languages/latex.ts
@@ -5,11 +5,7 @@ import {
   TextEditor,
 } from "@cursorless/common";
 import type { SyntaxNode } from "web-tree-sitter";
-import {
-  NodeMatcherAlternative,
-  SelectionWithContext,
-  SelectionWithEditor,
-} from "../typings/Types";
+import { NodeMatcherAlternative, SelectionWithContext } from "../typings/Types";
 import { patternFinder } from "../util/nodeFinders";
 import {
   ancestorChainNodeMatcher,
@@ -83,15 +79,6 @@ const SECTIONING = [
   "part",
 ];
 
-const ENVIRONMENTS = [
-  "generic_environment",
-  "comment_environment",
-  "verbatim_environment",
-  "listing_environment",
-  "minted_environment",
-  "pycode_environment",
-];
-
 const sectioningText = SECTIONING.map((s) => `${s}[text]`);
 const sectioningCommand = SECTIONING.map((s) => `${s}[command]`);
 
@@ -164,15 +151,6 @@ function extractItemContent(
   };
 }
 
-const getStartTag = patternMatcher(`*.begin!`);
-const getEndTag = patternMatcher(`*.end!`);
-
-const getTags = (selection: SelectionWithEditor, node: SyntaxNode) => {
-  const startTag = getStartTag(selection, node);
-  const endTag = getEndTag(selection, node);
-  return startTag != null && endTag != null ? startTag.concat(endTag) : null;
-};
-
 const nodeMatchers: Partial<
   Record<SimpleScopeTypeType, NodeMatcherAlternative>
 > = {
@@ -197,23 +175,8 @@ const nodeMatchers: Partial<
     matcher(patternFinder(...sectioningText), unwrapGroupParens),
     patternMatcher("begin[name][text]", "end[name][text]"),
   ),
-  functionCallee: "command_name",
 
   collectionItem: matcher(patternFinder("enum_item"), extractItemContent),
-
-  part: "part",
-  chapter: "chapter",
-  section: "section",
-  subSection: "subsection",
-  subSubSection: "subsubsection",
-  namedParagraph: "paragraph",
-  subParagraph: "subparagraph",
-
-  environment: ENVIRONMENTS,
-  xmlElement: ENVIRONMENTS,
-  xmlBothTags: getTags,
-  xmlStartTag: getStartTag,
-  xmlEndTag: getEndTag,
 };
 
 export default createPatternMatchers(nodeMatchers);
diff --git a/queries/latex.scm b/queries/latex.scm
@@ -2,3 +2,27 @@
   (block_comment)
   (line_comment)
 ] @comment
+
+(command_name) @functionCallee
+
+(part) @part
+(chapter) @chapter
+(section) @section
+(subsection) @subSection
+(subsubsection) @subSubSection
+(paragraph) @namedParagraph
+(subparagraph) @subParagraph
+
+(_
+  (begin) @xmlStartTag @environment.interior.start.endOf @xmlElement.interior.start.endOf
+  (end) @xmlEndTag @environment.interior.end.startOf @xmlElement.interior.end.startOf
+) @environment @xmlElement @_.domain
+
+(_
+  (begin) @xmlBothTags
+  (#allow-multiple! @xmlBothTags)
+) @_.domain
+(_
+  (end) @xmlBothTags
+  (#allow-multiple! @xmlBothTags)
+) @_.domain
