Move pretty printing Scopes into PrintHIR

Author: poteto

compiler/forget/src/HIR/HIR.ts

@@ -63,7 +63,6 @@ export type HIRFunction = {
   body: HIR;
   generator: boolean;
   async: boolean;
-  extra?: string;
 };
 
 /**

compiler/forget/src/HIR/InferReactiveScopeDependencies.ts

@@ -18,31 +18,19 @@ import {
   ReactiveScope,
 } from "./HIR";
 import { BlockTerminal, Visitor, visitTree } from "./HIRTreeVisitor";
-import { printPlace } from "./PrintHIR";
 import { eachInstructionValueOperand } from "./visitors";
 
 export function inferReactiveScopeDependencies(fn: HIRFunction) {
   // TODO: visitTree is more of a transformer visitor, consider adding a new tree visitor
   // that only visits and replacing this usage
   const visitor = new ScopeDependenciesVisitor(fn);
   visitTree(fn, visitor);
-
-  const output = [];
-  for (const scope of visitor.allScopes) {
-    if (scope.dependencies.size > 0) {
-      output.push(
-        `scope${scope.id} [${scope.range.start}:${
-          scope.range.end
-        }]:\n${Array.from(scope.dependencies)
-          .map((p) => " - " + printPlace(p))
-          .join("\n")}`
-      );
-    }
-  }
-  fn.extra = output.join("\n");
 }
 
-function instructionInScope(instrId: InstructionId, scope: ReactiveScope) {
+export function instructionInScope(
+  instrId: InstructionId,
+  scope: ReactiveScope
+) {
   return instrId >= scope.range.start && instrId < scope.range.end;
 }
 
@@ -52,8 +40,6 @@ class ScopeDependenciesVisitor
   #identifiers: Map<Identifier, InstructionId> = new Map();
   // Scopes that are currently active at this point in the traversal
   #activeScopes: Set<ReactiveScope> = new Set();
-  // All scopes encountered during the traversal
-  allScopes: Set<ReactiveScope> = new Set();
 
   get #lastActiveScope(): ReactiveScope | null {
     const scopes = [...this.#activeScopes];
@@ -71,7 +57,6 @@ class ScopeDependenciesVisitor
 
   #recordActiveScope(scope: ReactiveScope) {
     this.#activeScopes.add(scope);
-    this.allScopes.add(scope);
   }
 
   /**

compiler/forget/src/HIR/PrintHIR.ts

@@ -24,6 +24,7 @@ import {
   Terminal,
 } from "./HIR";
 import { buildAliasSets } from "./InferAlias";
+import { eachReactiveScope } from "./visitors";
 
 export type Options = {
   indent: number;
@@ -32,9 +33,7 @@ export type Options = {
 export function printFunction(fn: HIRFunction): string {
   const output = [];
   output.push(printHIR(fn.body));
-  if (fn.extra !== undefined) {
-    output.push(fn.extra);
-  }
+  output.push(printReactiveScopes(fn.body));
   return output.join("\n");
 }
 
@@ -345,3 +344,25 @@ export function printAliases(aliases: DisjointSet<Identifier>): string {
 
   return items.join("\n");
 }
+
+export function printReactiveScopes(ir: HIR) {
+  const output = [];
+  for (const scope of eachReactiveScope(ir)) {
+    let shouldOutput = false;
+    const line = [
+      `scope${scope.id} [${scope.range.start}:${scope.range.end}]:`,
+    ];
+    if (scope.dependencies.size > 0) {
+      shouldOutput = true;
+      line.push(
+        `${Array.from(scope.dependencies)
+          .map((p) => "  - dependency: " + printPlace(p))
+          .join("\n")}`
+      );
+    }
+    if (shouldOutput) {
+      output.push(line.join("\n"));
+    }
+  }
+  return output.join("\n");
+}

compiler/forget/src/HIR/visitors.ts

@@ -9,10 +9,13 @@ import { assertExhaustive } from "../Common/utils";
 import {
   BasicBlock,
   BlockId,
+  HIR,
   Instruction,
   InstructionValue,
   makeInstructionId,
   Place,
+  ReactiveScope,
+  ScopeId,
   Terminal,
 } from "./HIR";
 
@@ -375,3 +378,19 @@ export function* eachBlockOperand(block: BasicBlock): Iterable<Place> {
   }
   yield* eachTerminalOperand(block.terminal);
 }
+
+export function* eachReactiveScope(ir: HIR): Iterable<ReactiveScope> {
+  const seenScopes: Set<ScopeId> = new Set();
+  for (const [, block] of ir.blocks) {
+    for (const operand of eachBlockOperand(block)) {
+      const scope = operand.identifier.scope;
+      if (scope != null) {
+        if (seenScopes.has(scope.id)) {
+          continue;
+        }
+        seenScopes.add(scope.id);
+        yield scope;
+      }
+    }
+  }
+}

compiler/forget/src/__tests__/fixtures/hir/_bug_expression-with-assignment.expect.md

@@ -21,11 +21,11 @@ bb0:
   [4] Const mutate $7_@3 = Binary read $6_@2 + read x$5_@1
   [5] Return read $7_@3
 scope2 [3:4]:
- - read x$5_@1
- - read x$5_@1
+  - dependency: read x$5_@1
+  - dependency: read x$5_@1
 scope3 [4:5]:
- - read $6_@2
- - read x$5_@1
+  - dependency: read $6_@2
+  - dependency: read x$5_@1
 ```
 
 ### CFG

compiler/forget/src/__tests__/fixtures/hir/_bug_inverted-if-else.expect.md

@@ -34,9 +34,9 @@ bb1:
   predecessor blocks: bb3 bb2
   [7] Return read x$11
 scope1 [3:4]:
- - read b$6
+  - dependency: read b$6
 scope2 [5:6]:
- - read c$7
+  - dependency: read c$7
 ```
 
 ### CFG

compiler/forget/src/__tests__/fixtures/hir/assignment-variations.expect.md

@@ -29,14 +29,14 @@ bb0:
   [7] Const mutate x$11_@6 = Binary read x$9_@4 >>> read $10_@5
   [8] Return
 scope2 [3:4]:
- - read x$5_@0
- - read $6_@1
+  - dependency: read x$5_@0
+  - dependency: read $6_@1
 scope4 [5:6]:
- - read x$7_@2
- - read $8_@3
+  - dependency: read x$7_@2
+  - dependency: read $8_@3
 scope6 [7:8]:
- - read x$9_@4
- - read $10_@5
+  - dependency: read x$9_@4
+  - dependency: read $10_@5
 ```
 
 ### CFG
@@ -82,7 +82,7 @@ bb0:
   [4] Reassign mutate [email protected][0:5] = Binary read [email protected] * read $6_@2
   [5] Return
 scope2 [3:4]:
- - mutate [email protected]
+  - dependency: mutate [email protected]
 ```
 
 ### CFG

compiler/forget/src/__tests__/fixtures/hir/call.expect.md

@@ -56,11 +56,11 @@ bb0:
   [8] Const mutate $15_@4 = JSX <read $14_@3 a={read a$10_@0} b={freeze b$11_@0} ></read $14_@3>
   [9] Return read $15_@4
 scope2 [5:6]:
- - read $12_@1
+  - dependency: read $12_@1
 scope4 [8:9]:
- - read $14_@3
- - read a$10_@0
- - freeze b$11_@0
+  - dependency: read $14_@3
+  - dependency: read a$10_@0
+  - dependency: freeze b$11_@0
 ```
 
 ### CFG

compiler/forget/src/__tests__/fixtures/hir/component.expect.md

@@ -89,9 +89,9 @@ bb2:
   [33] Const mutate $60_@18 = JSX <read $53_@11>{read $54_@12}{read $57_@15}{read $58_@16}{freeze renderedItems$29_@2}{read $59_@17}</read $53_@11>
   [34] Return read $60_@18
 scope0 [1:2]:
- - read props$26.items
+  - dependency: read props$26.items
 scope1 [2:3]:
- - read props$26.maxItems
+  - dependency: read props$26.maxItems
 ```
 
 ### CFG

compiler/forget/src/__tests__/fixtures/hir/conditional-break.expect.md

@@ -90,9 +90,9 @@ bb1:
   [6] Call mutate [email protected](read props$4.d)
   [7] Return freeze a_DEBUG$5_@0
 scope0 [1:7]:
- - read props$4.a
- - read props$4.b
- - read props$4.d
+  - dependency: read props$4.a
+  - dependency: read props$4.b
+  - dependency: read props$4.d
 ```
 
 ### CFG
@@ -157,10 +157,10 @@ bb1:
   [6] Call mutate [email protected](read props$3.d)
   [7] Return freeze a$4_@0
 scope0 [1:7]:
- - read props$3.a
- - read props$3.c
- - read props$3.b
- - read props$3.d
+  - dependency: read props$3.a
+  - dependency: read props$3.c
+  - dependency: read props$3.b
+  - dependency: read props$3.d
 ```
 
 ### CFG
@@ -227,10 +227,10 @@ bb1:
   [7] Call mutate [email protected](read props$4.d)
   [8] Return freeze a$5_@0
 scope0 [1:8]:
- - read props$4.a
- - read props$4.c
- - read props$4.b
- - read props$4.d
+  - dependency: read props$4.a
+  - dependency: read props$4.c
+  - dependency: read props$4.b
+  - dependency: read props$4.d
 ```
 
 ### CFG
@@ -297,10 +297,10 @@ bb1:
   [6] Call mutate [email protected](read props$3.d)
   [7] Return freeze a$4_@0
 scope0 [1:7]:
- - read props$3.a
- - read props$3.c
- - read props$3.b
- - read props$3.d
+  - dependency: read props$3.a
+  - dependency: read props$3.c
+  - dependency: read props$3.b
+  - dependency: read props$3.d
 ```
 
 ### CFG
@@ -366,9 +366,9 @@ bb1:
   [6] Call mutate [email protected](read props$3.d)
   [7] Return freeze a$4_@0
 scope0 [1:7]:
- - read props$3.a
- - read props$3.d
- - read props$3.c
+  - dependency: read props$3.a
+  - dependency: read props$3.d
+  - dependency: read props$3.c
 ```
 
 ### CFG