Renaming MoveFunctionDeclarations and associated flags and options to better reflect what it actually does and distinguish it from RescopeGlobalSymbols which does a completely different kind of rewriting.

PiperOrigin-RevId: 323101509

Author: concavelenz

src/com/google/javascript/jscomp/CompilerOptions.java

@@ -834,7 +834,7 @@ public void setReplaceMessagesWithChromeI18n(
   private Map<String, Object> tweakReplacements;
 
   /** Move top-level function declarations to the top */
-  public boolean moveFunctionDeclarations;
+  public boolean rewriteGlobalDeclarationsForTryCatchWrapping;
 
   boolean checksOnly;
 
@@ -1423,7 +1423,7 @@ public CompilerOptions() {
     defineReplacements = new HashMap<>();
     tweakProcessing = TweakProcessing.OFF;
     tweakReplacements = new HashMap<>();
-    moveFunctionDeclarations = false;
+    rewriteGlobalDeclarationsForTryCatchWrapping = false;
     checksOnly = false;
     outputJs = OutputJs.NORMAL;
     generateExports = false;
@@ -2549,8 +2549,13 @@ public void setTweakReplacements(Map<String, Object> tweakReplacements) {
     this.tweakReplacements = tweakReplacements;
   }
 
+  @Deprecated
   public void setMoveFunctionDeclarations(boolean moveFunctionDeclarations) {
-    this.moveFunctionDeclarations = moveFunctionDeclarations;
+    setRewriteGlobalDeclarationsForTryCatchWrapping(moveFunctionDeclarations);
+  }
+
+  public void setRewriteGlobalDeclarationsForTryCatchWrapping(boolean rewrite) {
+    this.rewriteGlobalDeclarationsForTryCatchWrapping = rewrite;
   }
 
   public void setCssRenamingMap(CssRenamingMap cssRenamingMap) {
@@ -3040,7 +3045,9 @@ public String toString() {
             .add("messageBundle", messageBundle)
             .add("moduleRoots", moduleRoots)
             .add("chunksToPrintAfterEachPassRegexList", chunksToPrintAfterEachPassRegexList)
-            .add("moveFunctionDeclarations", moveFunctionDeclarations)
+            .add(
+                "rewriteGlobalDeclarationsForTryCatchWrapping",
+                rewriteGlobalDeclarationsForTryCatchWrapping)
             .add("nameGenerator", nameGenerator)
             .add("optimizeArgumentsArray", optimizeArgumentsArray)
             .add("optimizeCalls", optimizeCalls)

src/com/google/javascript/jscomp/DefaultPassConfig.java

@@ -777,11 +777,11 @@ protected List<PassFactory> getOptimizations() {
     }
 
     // Move functions before extracting prototype member declarations.
-    if (options.moveFunctionDeclarations
-        // renamePrefixNamescape relies on moveFunctionDeclarations
+    if (options.rewriteGlobalDeclarationsForTryCatchWrapping
+        // renamePrefixNamescape relies on rewriteGlobalDeclarationsForTryCatchWrapping
         // to preserve semantics.
         || options.renamePrefixNamespace != null) {
-      passes.add(moveFunctionDeclarations);
+      passes.add(rewriteGlobalDeclarationsForTryCatchWrapping);
     }
 
     if (options.anonymousFunctionNaming == AnonymousFunctionNamingPolicy.MAPPED) {
@@ -2543,11 +2543,14 @@ compiler, PassNames.EXPLOIT_ASSIGN, new ExploitAssigns()))
           .setFeatureSetForOptimizations()
           .build();
 
-  /** Moves function declarations to the top, to simulate actual hoisting. */
-  private final PassFactory moveFunctionDeclarations =
+  /**
+   * Moves function declarations to the top to simulate actual hoisting and rewrites block scope
+   * declarations to 'var'.
+   */
+  private final PassFactory rewriteGlobalDeclarationsForTryCatchWrapping =
       PassFactory.builder()
-          .setName(PassNames.MOVE_FUNCTION_DECLARATIONS)
-          .setInternalFactory(MoveFunctionDeclarations::new)
+          .setName("rewriteGlobalDeclarationsForTryCatchWrapping")
+          .setInternalFactory(RewriteGlobalDeclarationsForTryCatchWrapping::new)
           .setFeatureSetForOptimizations()
           .build();
 

src/com/google/javascript/jscomp/PassNames.java

@@ -71,7 +71,6 @@ public final class PassNames {
   public static final String INLINE_TYPE_ALIASES = "inlineTypeAliases";
   public static final String INLINE_VARIABLES = "inlineVariables";
   public static final String LINT_CHECKS = "lintChecks";
-  public static final String MOVE_FUNCTION_DECLARATIONS = "moveFunctionDeclarations";
   public static final String NAME_ANONYMOUS_FUNCTIONS = "nameAnonymousFunctions";
   public static final String NORMALIZE = "normalize";
   public static final String OPTIMIZE_ARGUMENTS_ARRAY = "optimizeArgumentsArray";

src/com/google/javascript/jscomp/RescopeGlobalSymbols.java

@@ -28,27 +28,29 @@
 import java.util.Set;
 
 /**
- * Finds all references to global symbols and rewrites them to be property
- * accesses to a special object with the same name as the global symbol.
+ * Finds all references to global symbols and rewrites them to be property accesses to a special
+ * object with the same name as the global symbol.
+ *
+ * <p>Given the name of the global object is NS
  *
- * Given the name of the global object is NS
  * <pre> var a = 1; function b() { return a }</pre>
+ *
  * becomes
+ *
  * <pre> NS.a = 1; NS.b = function b() { return NS.a }</pre>
  *
- * This allows splitting code into modules that depend on each other's
- * global symbols, without using polluting JavaScript's global scope with those
- * symbols. You typically define just a single global symbol, wrap each module
- * in a function wrapper, and pass the global symbol around, eg,
+ * This allows splitting code into modules that depend on each other's global symbols, without using
+ * polluting JavaScript's global scope with those symbols. You typically define just a single global
+ * symbol, wrap each module in a function wrapper, and pass the global symbol around, eg,
+ *
  * <pre> var uniqueNs = uniqueNs || {}; </pre>
- * <pre> (function (NS) { ...your module code here... })(uniqueNs); </pre>
  *
+ * <pre> (function (NS) { ...your module code here... })(uniqueNs); </pre>
  *
- * <p>This compile step requires moveFunctionDeclarations to be turned on
- * to guarantee semantics.
+ * <p>This compile step requires rewriteGlobalDeclarationsForTryCatchWrapping to be turned on to
+ * guarantee semantics.
  *
  * <p>For lots of examples, see the unit test.
- *
  */
 final class RescopeGlobalSymbols implements CompilerPass {
 

src/com/google/javascript/jscomp/MoveFunctionDeclarations.java renamed to src/com/google/javascript/jscomp/RewriteGlobalDeclarationsForTryCatchWrapping.java

@@ -57,12 +57,12 @@
  * <p>NOTE: now that this pass also moves class declarations it should be renamed along with the
  * associated options.
  */
-class MoveFunctionDeclarations implements Callback, CompilerPass {
+class RewriteGlobalDeclarationsForTryCatchWrapping implements Callback, CompilerPass {
   private final AbstractCompiler compiler;
   private final ListMultimap<JSModule, Node> functions = ArrayListMultimap.create();
   private final ArrayList<Node> classes = new ArrayList<>();
 
-  MoveFunctionDeclarations(AbstractCompiler compiler) {
+  RewriteGlobalDeclarationsForTryCatchWrapping(AbstractCompiler compiler) {
     this.compiler = compiler;
   }
 

src/com/google/javascript/jscomp/debugger/common/CompilationParam.java

@@ -808,12 +808,12 @@ public String getJavaInfo() {
   MOVE_FUNCTION_DECLARATIONS(ParamGroup.OPTIMIZATION) {
     @Override
     public void apply(CompilerOptions options, boolean value) {
-      options.setMoveFunctionDeclarations(value);
+      options.setRewriteGlobalDeclarationsForTryCatchWrapping(value);
     }
 
     @Override
     public boolean isApplied(CompilerOptions options) {
-      return options.moveFunctionDeclarations;
+      return options.rewriteGlobalDeclarationsForTryCatchWrapping;
     }
   },
 

test/com/google/javascript/jscomp/MoveFunctionDeclarationsTest.java renamed to test/com/google/javascript/jscomp/RewriteGlobalDeclarationsForTryCatchWrappingTest.java

@@ -22,14 +22,14 @@
 import org.junit.runners.JUnit4;
 
 /**
- * Tests for {@link MoveFunctionDeclarations}
+ * Tests for {@link RewriteGlobalDeclarationsForTryCatchWrapping}
  */
 @RunWith(JUnit4.class)
-public final class MoveFunctionDeclarationsTest extends CompilerTestCase {
+public final class RewriteGlobalDeclarationsForTryCatchWrappingTest extends CompilerTestCase {
 
   @Override
   protected CompilerPass getProcessor(Compiler compiler) {
-    return new MoveFunctionDeclarations(compiler);
+    return new RewriteGlobalDeclarationsForTryCatchWrapping(compiler);
   }
 
   @Test

test/com/google/javascript/jscomp/integration/IntegrationTest.java

@@ -2062,12 +2062,12 @@ public void testCollapseAnonymousFunctions() {
   }
 
   @Test
-  public void testMoveFunctionDeclarations() {
+  public void testRewriteGlobalDeclarationsForTryCatchWrapping() {
     CompilerOptions options = createCompilerOptions();
     String code = "var x = f(); function f() { return 3; }";
     testSame(options, code);
 
-    options.moveFunctionDeclarations = true;
+    options.rewriteGlobalDeclarationsForTryCatchWrapping = true;
     test(options, code, "var f = function() { return 3; }; var x = f();");
   }
 
@@ -3284,11 +3284,11 @@ public void testRenameCollision() {
   }
 
   @Test
-  public void testRenamePrefixNamespaceActivatesMoveFunctionDeclarations() {
+  public void testRenamePrefixNamespaceActivatesRewriteGlobalDeclarationsForTryCatchWrapping() {
     CompilerOptions options = createCompilerOptions();
     String code = "var x = f; function f() { return 3; }";
     testSame(options, code);
-    assertThat(options.moveFunctionDeclarations).isFalse();
+    assertThat(options.rewriteGlobalDeclarationsForTryCatchWrapping).isFalse();
     options.setRenamePrefixNamespace("_");
     test(options, code, "_.f = function() { return 3; }; _.x = _.f;");
   }