Add original scope variables to builder

Author: szuend

src/builder/builder.test.ts

@@ -41,27 +41,47 @@ describe("ScopeInfoBuilder", () => {
     assertStrictEquals(info.scopes[0], info.scopes[0].children[0].parent);
   });
 
-  it("can set the name via option", () => {
-    const info = builder.startScope(0, 0, { name: "foo" }).endScope(5, 0)
-      .build();
+  describe("startScope", () => {
+    it("can set the name via option", () => {
+      const info = builder.startScope(0, 0, { name: "foo" }).endScope(5, 0)
+        .build();
 
-    assertStrictEquals(info.scopes[0]?.name, "foo");
-  });
+      assertStrictEquals(info.scopes[0]?.name, "foo");
+    });
 
-  it("can set kind via option", () => {
-    const info = builder.startScope(0, 0, { kind: "Global" }).endScope(10, 0)
-      .build();
+    it("can set kind via option", () => {
+      const info = builder.startScope(0, 0, { kind: "Global" }).endScope(10, 0)
+        .build();
 
-    assertStrictEquals(info.scopes[0]?.kind, "Global");
-  });
+      assertStrictEquals(info.scopes[0]?.kind, "Global");
+    });
 
-  it("can set isStackFrame via option", () => {
-    const info = builder.startScope(0, 0, { isStackFrame: true }).endScope(
-      10,
-      0,
-    ).build();
+    it("can set isStackFrame via option", () => {
+      const info = builder.startScope(0, 0, { isStackFrame: true }).endScope(
+        10,
+        0,
+      ).build();
 
-    assertStrictEquals(info.scopes[0]?.isStackFrame, true);
+      assertStrictEquals(info.scopes[0]?.isStackFrame, true);
+    });
+
+    it("can set variables via option", () => {
+      const info = builder.startScope(0, 0, { variables: ["a", "b"] }).endScope(
+        10,
+        0,
+      ).build();
+
+      assertEquals(info.scopes[0]?.variables, ["a", "b"]);
+    });
+
+    it("copies the variables passed via options", () => {
+      const variables = ["a", "b"];
+      const info = builder.startScope(0, 0, { variables }).endScope(10, 0)
+        .build();
+      variables.push("c");
+
+      assertEquals(info.scopes[0]?.variables, ["a", "b"]);
+    });
   });
 
   describe("setScopeName", () => {
@@ -104,6 +124,24 @@ describe("ScopeInfoBuilder", () => {
     });
   });
 
+  describe("setScopeVariables", () => {
+    it("sets variables", () => {
+      const info = builder.startScope(0, 0).setScopeVariables(["a", "b"])
+        .endScope(10, 0).build();
+
+      assertEquals(info.scopes[0]?.variables, ["a", "b"]);
+    });
+
+    it("creates a copy of the variables", () => {
+      const variables = ["a", "b"];
+      const info = builder.startScope(0, 0).setScopeVariables(variables)
+        .endScope(10, 0).build();
+      variables.push("c");
+
+      assertEquals(info.scopes[0]?.variables, ["a", "b"]);
+    });
+  });
+
   describe("endScope", () => {
     it("does nothing when no scope is open", () => {
       builder.endScope(10, 0);

src/builder/builder.ts

@@ -34,12 +34,17 @@ export class ScopeInfoBuilder {
   startScope(
     line: number,
     column: number,
-    options?: { name?: string; kind?: string; isStackFrame?: boolean },
+    options?: {
+      name?: string;
+      kind?: string;
+      isStackFrame?: boolean;
+      variables?: string[];
+    },
   ): this {
     const scope: OriginalScope = {
       start: { line, column },
       end: { line, column },
-      variables: [],
+      variables: options?.variables?.slice(0) ?? [],
       children: [],
       isStackFrame: Boolean(options?.isStackFrame),
     };
@@ -75,6 +80,13 @@ export class ScopeInfoBuilder {
     return this;
   }
 
+  setScopeVariables(variables: string[]): this {
+    const scope = this.#scopeStack.at(-1);
+    if (scope) scope.variables = variables.slice(0);
+
+    return this;
+  }
+
   endScope(line: number, column: number): this {
     const scope = this.#scopeStack.pop();
     if (!scope) return this;

src/builder/safe_builder.test.ts

@@ -99,6 +99,18 @@ describe("SafeScopeInfoBuilder", () => {
     });
   });
 
+  describe("setScopeVariables", () => {
+    it("throws when no scope is on open", () => {
+      assertThrows(() => builder.setScopeVariables(["foo"]));
+    });
+
+    it("throws while building a range", () => {
+      builder.startRange(0, 0);
+
+      assertThrows(() => builder.setScopeVariables(["foo"]));
+    });
+  });
+
   describe("endScope", () => {
     it("throws when the scope stack is empty", () => {
       assertThrows(() => builder.endScope(5, 0));

src/builder/safe_builder.ts

@@ -22,7 +22,12 @@ export class SafeScopeInfoBuilder extends ScopeInfoBuilder {
   override startScope(
     line: number,
     column: number,
-    options?: { name?: string; kind?: string; isStackFrame?: boolean },
+    options?: {
+      name?: string;
+      kind?: string;
+      isStackFrame?: boolean;
+      variables?: string[];
+    },
   ): this {
     this.#verifyEmptyRangeStack("start scope");
 
@@ -74,6 +79,14 @@ export class SafeScopeInfoBuilder extends ScopeInfoBuilder {
     return this;
   }
 
+  override setScopeVariables(variables: string[]): this {
+    this.#verifyScopePresent("setScopeVariables");
+    this.#verifyEmptyRangeStack("setScopeVariables");
+
+    super.setScopeVariables(variables);
+    return this;
+  }
+
   override endScope(line: number, column: number): this {
     this.#verifyEmptyRangeStack("end scope");