Added complex surrounding pair scope type

Author: Andreas Arvidsson

src/processTargets/modifiers/ItemStage/getIterationScope.ts

@@ -75,17 +75,16 @@ function getSurroundingPair(
   editor: TextEditor,
   contentRange: Range
 ) {
-  return processSurroundingPairForDelimiters(
-    context,
-    editor,
-    contentRange,
-    {
-      type: "surroundingPair",
-      delimiter: "any",
-      requireStrongContainment: true,
-    },
-    ["parentheses", "squareBrackets", "curlyBrackets", "angleBrackets"]
-  );
+  return processSurroundingPairForDelimiters(context, editor, contentRange, {
+    type: "surroundingPair",
+    requireStrongContainment: true,
+    delimiters: [
+      "parentheses",
+      "squareBrackets",
+      "curlyBrackets",
+      "angleBrackets",
+    ],
+  });
 }
 
 function getStringSurroundingPair(

src/processTargets/modifiers/surroundingPair/findDelimiterPairAdjacentToSelection.ts

@@ -1,4 +1,4 @@
-import { SurroundingPairScopeType } from "../../../typings/targetDescriptor.types";
+import { SurroundingPairComplexScopeType } from "../../../typings/targetDescriptor.types";
 import { findOppositeDelimiter } from "./findOppositeDelimiter";
 import { getSurroundingPairOffsets } from "./getSurroundingPairOffsets";
 import {
@@ -30,7 +30,7 @@ export function findDelimiterPairAdjacentToSelection(
   initialIndex: number,
   delimiterOccurrences: PossibleDelimiterOccurrence[],
   selectionOffsets: Offsets,
-  scopeType: SurroundingPairScopeType,
+  scopeType: SurroundingPairComplexScopeType,
   bailOnUnmatchedAdjacent: boolean = false
 ): SurroundingPairOffsets | null {
   const indicesToTry = [initialIndex + 1, initialIndex];

src/processTargets/modifiers/surroundingPair/findSurroundingPairCore.ts

@@ -1,14 +1,11 @@
 import { sortedIndexBy } from "lodash";
-import {
-  SimpleSurroundingPairName,
-  SurroundingPairScopeType,
-} from "../../../typings/targetDescriptor.types";
+import { SurroundingPairComplexScopeType } from "../../../typings/targetDescriptor.types";
 import { findDelimiterPairAdjacentToSelection } from "./findDelimiterPairAdjacentToSelection";
 import { findDelimiterPairContainingSelection } from "./findDelimiterPairContainingSelection";
 import {
-  SurroundingPairOffsets,
   Offsets,
   PossibleDelimiterOccurrence,
+  SurroundingPairOffsets,
 } from "./types";
 
 /**
@@ -23,7 +20,6 @@ import {
  * delimiter pair that contains the selection.
  *
  * @param delimiterOccurrences A list of delimiter occurrences.  Expected to be sorted by offsets
- * @param acceptableDelimiters A list of names of acceptable delimiters to look for
  * @param selectionOffsets The offsets of the selection
  * @param bailOnUnmatchedAdjacent If `true`, immediately return null if we find
  * an adjacent delimiter that we can't find a match for.  This variable will
@@ -33,9 +29,8 @@ import {
  * @returns
  */
 export function findSurroundingPairCore(
-  scopeType: SurroundingPairScopeType,
+  scopeType: SurroundingPairComplexScopeType,
   delimiterOccurrences: PossibleDelimiterOccurrence[],
-  acceptableDelimiters: SimpleSurroundingPairName[],
   selectionOffsets: Offsets,
   bailOnUnmatchedAdjacent: boolean = false
 ): SurroundingPairOffsets | null {
@@ -72,7 +67,7 @@ export function findSurroundingPairCore(
   return findDelimiterPairContainingSelection(
     initialIndex,
     delimiterOccurrences,
-    acceptableDelimiters,
+    scopeType.delimiters,
     selectionOffsets
   );
 }

src/processTargets/modifiers/surroundingPair/findSurroundingPairParseTreeBased.ts

@@ -1,9 +1,6 @@
 import { Range, TextDocument, TextEditor } from "vscode";
 import { SyntaxNode } from "web-tree-sitter";
-import {
-  SimpleSurroundingPairName,
-  SurroundingPairScopeType,
-} from "../../../typings/targetDescriptor.types";
+import { SurroundingPairComplexScopeType } from "../../../typings/targetDescriptor.types";
 import { getNodeRange } from "../../../util/nodeSelectors";
 import { isContainedInErrorNode } from "../../../util/treeSitterUtils";
 import { extractSelectionFromSurroundingPairOffsets } from "./extractSelectionFromSurroundingPairOffsets";
@@ -61,12 +58,11 @@ export function findSurroundingPairParseTreeBased(
   editor: TextEditor,
   selection: Range,
   node: SyntaxNode,
-  delimiters: SimpleSurroundingPairName[],
-  scopeType: SurroundingPairScopeType
+  scopeType: SurroundingPairComplexScopeType
 ) {
   const document: TextDocument = editor.document;
 
-  const individualDelimiters = getIndividualDelimiters(delimiters);
+  const individualDelimiters = getIndividualDelimiters(scopeType.delimiters);
 
   const delimiterTextToDelimiterInfoMap = Object.fromEntries(
     individualDelimiters.map((individualDelimiter) => [
@@ -86,7 +82,6 @@ export function findSurroundingPairParseTreeBased(
   const context: Context = {
     delimiterTextToDelimiterInfoMap,
     individualDelimiters,
-    delimiters,
     selectionOffsets,
     scopeType,
   };
@@ -139,17 +134,12 @@ interface Context {
    */
   individualDelimiters: IndividualDelimiter[];
 
-  /**
-   * The names of the delimiters that we're considering
-   */
-  delimiters: SimpleSurroundingPairName[];
-
   /**
    * The offsets of the selection
    */
   selectionOffsets: Offsets;
 
-  scopeType: SurroundingPairScopeType;
+  scopeType: SurroundingPairComplexScopeType;
 }
 
 /**
@@ -168,7 +158,6 @@ function findSurroundingPairContainedInNode(
   const {
     delimiterTextToDelimiterInfoMap,
     individualDelimiters,
-    delimiters,
     selectionOffsets,
     scopeType,
   } = context;
@@ -229,7 +218,6 @@ function findSurroundingPairContainedInNode(
   return findSurroundingPairCore(
     scopeType,
     delimiterOccurrences,
-    delimiters,
     selectionOffsets,
 
     // If we're not the root node of the parse tree (ie `node.parent !=

src/processTargets/modifiers/surroundingPair/findSurroundingPairTextBased.ts

@@ -1,9 +1,8 @@
 import { escapeRegExp, findLast, uniq } from "lodash";
 import { Range, TextDocument, TextEditor } from "vscode";
 import {
-  SimpleSurroundingPairName,
+  SurroundingPairComplexScopeType,
   SurroundingPairName,
-  SurroundingPairScopeType,
 } from "../../../typings/targetDescriptor.types";
 import { getDocumentRange } from "../../../util/range";
 import { matchAll } from "../../../util/regex";
@@ -69,13 +68,12 @@ export function findSurroundingPairTextBased(
   editor: TextEditor,
   range: Range,
   allowableRange: Range | null,
-  delimiters: SimpleSurroundingPairName[],
-  scopeType: SurroundingPairScopeType
+  scopeType: SurroundingPairComplexScopeType
 ) {
   const document: TextDocument = editor.document;
   const fullRange = allowableRange ?? getDocumentRange(document);
 
-  const individualDelimiters = getIndividualDelimiters(delimiters);
+  const individualDelimiters = getIndividualDelimiters(scopeType.delimiters);
 
   const delimiterTextToDelimiterInfoMap = Object.fromEntries(
     individualDelimiters.map((individualDelimiter) => [
@@ -108,7 +106,6 @@ export function findSurroundingPairTextBased(
   const context: Context = {
     scopeType,
     delimiterRegex,
-    delimiters,
     delimiterTextToDelimiterInfoMap,
   };
 
@@ -196,16 +193,11 @@ function getDelimiterRegex(individualDelimiters: IndividualDelimiter[]) {
  * Context to pass to nested call
  */
 interface Context {
-  scopeType: SurroundingPairScopeType;
+  scopeType: SurroundingPairComplexScopeType;
   delimiterTextToDelimiterInfoMap: {
     [k: string]: IndividualDelimiter;
   };
   delimiterRegex: RegExp;
-
-  /**
-   * The allowable delimiter names
-   */
-  delimiters: SimpleSurroundingPairName[];
 }
 
 /**
@@ -228,12 +220,8 @@ function getDelimiterPairOffsets(
   isAtStartOfFullRange: boolean,
   isAtEndOfFullRange: boolean
 ): SurroundingPairOffsets | null {
-  const {
-    scopeType,
-    delimiterTextToDelimiterInfoMap,
-    delimiterRegex,
-    delimiters,
-  } = context;
+  const { scopeType, delimiterTextToDelimiterInfoMap, delimiterRegex } =
+    context;
   const { forceDirection } = scopeType;
 
   // XXX: The below is a bit wasteful when there are multiple targets, because
@@ -293,7 +281,6 @@ function getDelimiterPairOffsets(
   const surroundingPair = findSurroundingPairCore(
     scopeType,
     delimiterOccurrences,
-    delimiters,
     selectionOffsets,
     !isAtStartOfFullRange || !isAtEndOfFullRange
   );

src/processTargets/modifiers/surroundingPair/index.ts

@@ -5,7 +5,7 @@ import getTextFragmentExtractor, {
 } from "../../../languages/getTextFragmentExtractor";
 import {
   ComplexSurroundingPairName,
-  SimpleSurroundingPairName,
+  SurroundingPairComplexScopeType,
   SurroundingPairScopeType,
 } from "../../../typings/targetDescriptor.types";
 import { ProcessedTargetsContext } from "../../../typings/Types";
@@ -34,16 +34,14 @@ export function processSurroundingPair(
   range: Range,
   scopeType: SurroundingPairScopeType
 ): SurroundingPairInfo | null {
+  const { delimiter, ...rest } = scopeType;
   const delimiters = complexDelimiterMap[
-    scopeType.delimiter as ComplexSurroundingPairName
-  ] ?? [scopeType.delimiter];
-  return processSurroundingPairForDelimiters(
-    context,
-    editor,
-    range,
-    scopeType,
-    delimiters
-  );
+    delimiter as ComplexSurroundingPairName
+  ] ?? [delimiter];
+  return processSurroundingPairForDelimiters(context, editor, range, {
+    ...rest,
+    delimiters,
+  });
 }
 
 /**
@@ -64,8 +62,7 @@ export function processSurroundingPairForDelimiters(
   context: ProcessedTargetsContext,
   editor: TextEditor,
   range: Range,
-  scopeType: SurroundingPairScopeType,
-  delimiters: SimpleSurroundingPairName[]
+  scopeType: SurroundingPairComplexScopeType
 ): SurroundingPairInfo | null {
   const document = editor.document;
   let node: SyntaxNode | null;
@@ -79,13 +76,7 @@ export function processSurroundingPairForDelimiters(
     if ((err as Error).name === "UnsupportedLanguageError") {
       // If we're in a language where we don't have a parse tree we use the text
       // based algorithm
-      return findSurroundingPairTextBased(
-        editor,
-        range,
-        null,
-        delimiters,
-        scopeType
-      );
+      return findSurroundingPairTextBased(editor, range, null, scopeType);
     } else {
       throw err;
     }
@@ -103,7 +94,6 @@ export function processSurroundingPairForDelimiters(
       editor,
       range,
       textFragmentRange,
-      delimiters,
       scopeType
     );
 
@@ -115,11 +105,5 @@ export function processSurroundingPairForDelimiters(
   // If we have a parse tree and either we are not in a string or comment or we
   // couldn't find a surrounding pair within a string or comment, we use the
   // parse tree-based algorithm
-  return findSurroundingPairParseTreeBased(
-    editor,
-    range,
-    node,
-    delimiters,
-    scopeType
-  );
+  return findSurroundingPairParseTreeBased(editor, range, node, scopeType);
 }

src/typings/targetDescriptor.types.ts

@@ -129,6 +129,15 @@ export interface SurroundingPairScopeType {
   requireStrongContainment?: boolean;
 }
 
+/** The same as `SurroundingPairScopeType` but with multiple delimiters */
+export interface SurroundingPairComplexScopeType
+  extends Omit<SurroundingPairScopeType, "delimiter"> {
+  /**
+   * The allowable delimiter names
+   */
+  delimiters: SimpleSurroundingPairName[];
+}
+
 export type ScopeType = SimpleScopeType | SurroundingPairScopeType;
 
 export interface ContainingSurroundingPairModifier