Also add a setter for the builder

Author: szuend

src/builder/builder.test.ts

@@ -144,6 +144,24 @@ describe("ScopeInfoBuilder", () => {
     });
   });
 
+  describe("setRangeDefinitionScope", () => {
+    it("sets the definition scope when it's provided as a number", () => {
+      const info = builder.startScope(0, 0).endScope(10, 0).startRange(0, 0)
+        .setRangeDefinitionScope(0).endRange(0, 10).build();
+
+      assertStrictEquals(info.scopes[0], info.ranges[0].originalScope);
+    });
+
+    it("sets the definition scope when it's provided directly", () => {
+      const scope = builder.startScope(0, 0).endScope(10, 0).lastScope();
+      const info = builder.startRange(0, 0).setRangeDefinitionScope(scope!)
+        .endRange(0, 10).build();
+
+      assertStrictEquals(info.scopes[0], info.ranges[0].originalScope);
+      assertStrictEquals(info.ranges[0].originalScope, scope);
+    });
+  });
+
   describe("endRange", () => {
     it("does nothing when no range is open", () => {
       builder.endRange(0, 20);

src/builder/builder.ts

@@ -139,6 +139,19 @@ export class ScopeInfoBuilder {
     return this;
   }
 
+  setRangeDefinitionScope(scope: number | OriginalScope): this {
+    const range = this.#rangeStack.at(-1);
+    if (!range) return this;
+
+    if (typeof scope === "number") {
+      range.originalScope = this.#countToScope.get(scope);
+    } else {
+      range.originalScope = scope;
+    }
+
+    return this;
+  }
+
   endRange(line: number, column: number): this {
     const range = this.#rangeStack.pop();
     if (!range) return this;

src/builder/safe_builder.test.ts

@@ -161,6 +161,34 @@ describe("SafeScopeInfoBuilder", () => {
     });
   });
 
+  describe("setRangeDefinitionScope", () => {
+    it("throws when no range is open", () => {
+      assertThrows(() => builder.setRangeDefinitionScope(0));
+    });
+
+    it("throws while building a scope", () => {
+      builder.startScope(0, 0);
+
+      assertThrows(() => builder.setRangeDefinitionScope(0));
+    });
+
+    it("throws when the definition scope doesnt point to a valid scope", () => {
+      assertThrows(() => builder.startRange(0, 0).setRangeDefinitionScope(0));
+    });
+
+    it("throws when the definition scope is not known to the builder", () => {
+      assertThrows(() =>
+        builder.startRange(0, 0).setRangeDefinitionScope({
+          start: { line: 0, column: 0 },
+          end: { line: 10, column: 10 },
+          isStackFrame: false,
+          variables: [],
+          children: [],
+        })
+      );
+    });
+  });
+
   describe("endRange", () => {
     it("throws when the range stack is empty", () => {
       assertThrows(() => builder.endRange(5, 0));

src/builder/safe_builder.ts

@@ -138,6 +138,30 @@ export class SafeScopeInfoBuilder extends ScopeInfoBuilder {
     return this;
   }
 
+  override setRangeDefinitionScope(scope: number | OriginalScope): this {
+    this.#verifyEmptyScopeStack("setRangeDefinitionScope");
+    this.#verifyRangePresent("setRangeDefinitionScope");
+
+    if (
+      typeof scope === "number" &&
+      !this.isValidScopeNumber(scope)
+    ) {
+      throw new Error(
+        `${scope} does not reference a valid OriginalScope`,
+      );
+    }
+    if (
+      typeof scope === "object" && !this.isKnownScope(scope)
+    ) {
+      throw new Error(
+        "The provided definition scope was not produced by this builder!",
+      );
+    }
+
+    super.setRangeDefinitionScope(scope);
+    return this;
+  }
+
   override endRange(line: number, column: number): this {
     this.#verifyEmptyScopeStack("endRange");
 
@@ -184,4 +208,10 @@ export class SafeScopeInfoBuilder extends ScopeInfoBuilder {
       throw new Error(`Can't ${op} while no OriginalScope is on the stack.`);
     }
   }
+
+  #verifyRangePresent(op: string): void {
+    if (this.rangeStack.length === 0) {
+      throw new Error(`Can't ${op} while no GeneratedRange is on the stack.`);
+    }
+  }
 }