Cleanup the namer, and add a test with fields that used to clash with internal names used by the co…

sdk/lib/_internal/compiler/implementation/js_backend/namer.dart

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of js_backend;
 
 /**
  * Assigns JavaScript identifiers to Dart variables, class-names and members.
  */
 class Namer implements ClosureNamer {
+
+  static const javaScriptKeywords = const <String>[
+    // These are current keywords

[kasperl, 2013/01/23 14:05:36]

Terminate comment with .

[ngeoffray, 2013/01/23 14:42:04]

Done.

+    "break", "delete", "function", "return", "typeof", "case", "do", "if",
+    "switch", "var", "catch", "else", "in", "this", "void", "continue",
+    "false", "instanceof", "throw", "while", "debugger", "finally", "new",
+    "true", "with", "default", "for", "null", "try",
+
+    // These are future keywords

[kasperl, 2013/01/23 14:05:36]

Ditto.

[ngeoffray, 2013/01/23 14:42:04]

Done.

+    "abstract", "double", "goto", "native", "static", "boolean", "enum",
+    "implements", "package", "super", "byte", "export", "import", "private",
+    "synchronized", "char", "extends", "int", "protected", "throws",
+    "class", "final", "interface", "public", "transient", "const", "float",
+    "long", "short", "volatile"
+  ];
+
+  static const reservedPropertySymbols =
+      const <String>["__PROTO__", "prototype", "constructor"];
+
   static Set<String> _jsReserved = null;
   Set<String> get jsReserved {
     if (_jsReserved == null) {
       _jsReserved = new Set<String>();
-      _jsReserved.addAll(JsNames.javaScriptKeywords);
-      _jsReserved.addAll(JsNames.reservedPropertySymbols);
+      _jsReserved.addAll(javaScriptKeywords);
+      _jsReserved.addAll(reservedPropertySymbols);
     }
     return _jsReserved;
   }
 
   final String CURRENT_ISOLATE = r'$';
 
   /**
    * Map from top-level or static elements to their unique identifiers provided
    * by [getName].
    *
    * Invariant: Keys must be declaration elements.
    */
   final Compiler compiler;
   final Map<Element, String> globals;
   final Map<String, LibraryElement> shortPrivateNameOwners;
   final Set<String> usedGlobalNames;
   final Set<String> usedInstanceNames;
   final Map<String, String> globalNameMap;
   final Map<String, String> instanceNameMap;
+  final Map<String, String> operatorNameMap;
   final Map<String, int> popularNameCounters;
 
   /**
    * A cache of names used for bailout methods. We make sure two
    * bailout methods cannot have the same name because if the two
    * bailout methods are in a class and a subclass, we would
    * call the wrong bailout method at runtime. To make it
    * simple, we don't keep track of inheritance and always avoid
    * similar names.
    */
   final Set<String> usedBailoutInstanceNames;
   final Map<Element, String> bailoutNames;
 
   final Map<Constant, String> constantNames;
 
   Namer(this.compiler)
       : globals = new Map<Element, String>(),
         shortPrivateNameOwners = new Map<String, LibraryElement>(),
         bailoutNames = new Map<Element, String>(),
         usedBailoutInstanceNames = new Set<String>(),
         usedGlobalNames = new Set<String>(),
         usedInstanceNames = new Set<String>(),
         instanceNameMap = new Map<String, String>(),
+        operatorNameMap = new Map<String, String>(),
         globalNameMap = new Map<String, String>(),
         constantNames = new Map<Constant, String>(),
         popularNameCounters = new Map<String, int>();
 
   String get isolateName => 'Isolate';
   String get isolatePropertiesName => r'$isolateProperties';
   /**
    * Some closures must contain their name. The name is stored in
    * [STATIC_CLOSURE_NAME_NAME].
    */
@@ skipping 17 matching lines @@
           // The minifier always constructs a new name, using the argument as
           // input to its hashing algorithm.  The given name does not need to be
           // valid.
           longName = stringConstant.value.slowToString();
         } else {
           longName = "C";
         }
       } else {
         longName = "CONSTANT";
       }
-      result = getFreshName(longName, usedGlobalNames);
+      result = getFreshName(longName, usedGlobalNames, true);
       constantNames[constant] = result;
     }
     return result;
   }
 
   String breakLabelName(LabelElement label) {
     return '\$${label.labelName}\$${label.target.nestingLevel}';
   }
 
   String implicitBreakLabelName(TargetElement target) {
@@ skipping 35 matching lines @@
 
     // If a library name does not start with the [LIBRARY_PREFIX] then our
     // assumptions about clashing with mangled private members do not hold.
     String libraryName = getName(library);
     assert(shouldMinify || libraryName.startsWith(LIBRARY_PREFIX));
     // TODO(erikcorry): Fix this with other manglings to avoid clashes.
     return '_lib$libraryName\$$nameString';
   }
 
   String instanceMethodName(FunctionElement element) {
-    SourceString name = Elements.operatorNameToIdentifier(element.name);
-    LibraryElement library = element.getLibrary();
-    if (element.kind == ElementKind.GENERATIVE_CONSTRUCTOR_BODY) {
-      ConstructorBodyElement bodyElement = element;
-      name = bodyElement.constructor.name;
+    SourceString name = operatorNameToIdentifier(element.name);

[kasperl, 2013/01/23 14:05:36]

This pattern where you check if the operatorNameToIdentifier method mapped the
element name into something else seems a little bit iffy. Maybe if you used an
early bailout:

   SourceString name = operatorName...(element.name);
   if (name != element.name) return getMapped...(...);

it would seem more light-weight? Also the comparison using == has the classic
problem that we will not notice if we ever change element.name to return
something not a SourceString except that the condition will be false too often.

[ngeoffray, 2013/01/23 14:42:04]

Done.

+    if (name == element.name) {
+      LibraryElement library = element.getLibrary();
+      if (element.kind == ElementKind.GENERATIVE_CONSTRUCTOR_BODY) {
+        ConstructorBodyElement bodyElement = element;
+        name = bodyElement.constructor.name;
+      }
+      FunctionSignature signature = element.computeSignature(compiler);
+      String methodName =
+          '${privateName(library, name)}\$${signature.parameterCount}';
+      if (signature.optionalParametersAreNamed &&
+          !signature.optionalParameters.isEmpty) {
+        StringBuffer buffer = new StringBuffer();
+        signature.orderedOptionalParameters.forEach((Element element) {
+          buffer.add('\$${safeName(element.name.slowToString())}');
+        });
+        methodName = '$methodName$buffer';
+      }
+      if (name == closureInvocationSelectorName) return methodName;
+      return getMappedInstanceName(methodName);
+    } else {
+      return getMappedOperatorName(name.slowToString());
     }
-    FunctionSignature signature = element.computeSignature(compiler);
-    String methodName =
-        '${privateName(library, name)}\$${signature.parameterCount}';
-    if (signature.optionalParametersAreNamed &&
-        !signature.optionalParameters.isEmpty) {
-      StringBuffer buffer = new StringBuffer();
-      signature.orderedOptionalParameters.forEach((Element element) {
-        buffer.add('\$${JsNames.getValid(element.name.slowToString())}');
-      });
-      methodName = '$methodName$buffer';
-    }
-    if (name == closureInvocationSelectorName) return methodName;
-    return getMappedInstanceName(methodName);
   }
 
   String publicInstanceMethodNameByArity(SourceString name, int arity) {
-    name = Elements.operatorNameToIdentifier(name);
-    assert(!name.isPrivate());
-    var base = name.slowToString();
-    // We don't mangle the closure invoking function name because it
-    // is generated by string concatenation in applyFunction from
-    // js_helper.dart.
-    var proposedName = '$base\$$arity';
-    if (name == closureInvocationSelectorName) return proposedName;
-    return getMappedInstanceName(proposedName);
+    SourceString newName = operatorNameToIdentifier(name);
+    if (newName == name) {
+      assert(!name.isPrivate());
+      var base = name.slowToString();
+      // We don't mangle the closure invoking function name because it
+      // is generated by string concatenation in applyFunction from
+      // js_helper.dart.
+      var proposedName = '$base\$$arity';
+      if (name == closureInvocationSelectorName) return proposedName;
+      return getMappedInstanceName(proposedName);
+    } else {
+      return getMappedOperatorName(newName.slowToString());
+    }
   }
 
   String invocationName(Selector selector) {
     if (selector.isGetter()) {
       String proposedName = privateName(selector.library, selector.name);
       return 'get\$${getMappedInstanceName(proposedName)}';
     } else if (selector.isSetter()) {
       String proposedName = privateName(selector.library, selector.name);
       return 'set\$${getMappedInstanceName(proposedName)}';
     } else {
-      SourceString name = Elements.operatorNameToIdentifier(selector.name);
-      StringBuffer buffer = new StringBuffer();
-      for (SourceString argumentName in selector.getOrderedNamedArguments()) {
-        buffer.add(r'$');
-        argumentName.printOn(buffer);
+      SourceString name = operatorNameToIdentifier(selector.name);
+      if (name == selector.name) {
+        StringBuffer buffer = new StringBuffer();
+        for (SourceString argumentName in selector.getOrderedNamedArguments()) {
+          buffer.add(r'$');
+          argumentName.printOn(buffer);
+        }
+        String suffix = '\$${selector.argumentCount}$buffer';
+        // We don't mangle the closure invoking function name because it
+        // is generated by string concatenation in applyFunction from
+        // js_helper.dart.
+        if (selector.isCall() && name == closureInvocationSelectorName) {

[kasperl, 2013/01/23 13:58:29]

Could this be selector.isClosureCall() now that you've added that (again)?

[ngeoffray, 2013/01/23 14:00:16]

Yes it can. Done.

+          return "${name.slowToString()}$suffix";
+        } else {
+        String proposedName = privateName(selector.library, name);
+        return getMappedInstanceName('$proposedName$suffix');
+        }
+      } else {
+        return getMappedOperatorName(name.slowToString());
       }
-      String suffix = '\$${selector.argumentCount}$buffer';
-      // We don't mangle the closure invoking function name because it
-      // is generated by string concatenation in applyFunction from
-      // js_helper.dart.
-      if (selector.isCall() && name == closureInvocationSelectorName) {
-        return "${name.slowToString()}$suffix";
-      }
-      String proposedName = privateName(selector.library, name);
-      return getMappedInstanceName('$proposedName$suffix');
     }
   }
 
   /**
    * Returns the internal name used for an invocation mirror of this selector.
    */
   String invocationMirrorInternalName(Selector selector)
       => invocationName(selector);
 
   String instanceFieldName(Element element) {
     String proposedName = privateName(element.getLibrary(), element.name);
     return getMappedInstanceName(proposedName);
   }
 
   // Construct a new name for the element based on the library and class it is
   // in.  The name here is not important, we just need to make sure it is
   // unique.  If we are minifying, we actually construct the name from the
   // minified versions of the class and instance names, but the result is
   // minified once again, so that is not visible in the end result.
   String shadowedFieldName(Element fieldElement) {
     // Check for following situation: Native field ${fieldElement.name} has
     // fixed JSName ${fieldElement.nativeName()}, but a subclass shadows this
     // name.  We normally handle that by renaming the superclass field, but we
-    // can't do that because native fields have fixed JsNames.  In practice
-    // this can't happen because we can't inherit from native classes.
+    // can't do that because native fields have fixed JavaScript names.
+    // In practice this can't happen because we can't inherit from native
+    // classes.
     assert (!fieldElement.hasFixedBackendName());
 
     String libraryName = getName(fieldElement.getLibrary());
     String className = getName(fieldElement.getEnclosingClass());
     String instanceName = instanceFieldName(fieldElement);
     return getMappedInstanceName('$libraryName\$$className\$$instanceName');
   }
 
   String setterName(Element element) {
     // We dynamically create setters from the field-name. The setter name must
@@ skipping 26 matching lines @@
     // We dynamically create getters from the field-name. The getter name must
     // therefore be derived from the instance field-name.
     LibraryElement library = element.getLibrary();
     String name = getMappedInstanceName(privateName(library, element.name));
     return 'get\$$name';
   }
 
   String getMappedGlobalName(String proposedName) {
     var newName = globalNameMap[proposedName];
     if (newName == null) {
-      newName = getFreshName(proposedName, usedGlobalNames);
+      newName = getFreshName(proposedName, usedGlobalNames, true);
       globalNameMap[proposedName] = newName;
     }
     return newName;
   }
 
   String getMappedInstanceName(String proposedName) {
     var newName = instanceNameMap[proposedName];
     if (newName == null) {
-      newName = getFreshName(proposedName, usedInstanceNames);
+      newName = getFreshName(proposedName, usedInstanceNames, true);
       instanceNameMap[proposedName] = newName;
     }
     return newName;
   }
 
-  String getFreshName(String proposedName, Set<String> usedNames) {
+  String getMappedOperatorName(String proposedName) {
+    var newName = operatorNameMap[proposedName];
+    if (newName == null) {
+      newName = getFreshName(proposedName, usedInstanceNames, false);
+      operatorNameMap[proposedName] = newName;
+    }
+    return newName;
+  }
+
+  String getFreshName(String proposedName,
+                      Set<String> usedNames,
+                      bool ensureSafe) {
     var candidate;
-    proposedName = safeName(proposedName);
+    if (ensureSafe) {
+      proposedName = safeName(proposedName);
+    }
     if (!usedNames.contains(proposedName)) {
       candidate = proposedName;
     } else {
       var counter = popularNameCounters[proposedName];
       var i = counter == null ? 0 : counter;
       while (usedNames.contains("$proposedName$i")) {
         i++;
       }
       popularNameCounters[proposedName] = i + 1;
       candidate = "$proposedName$i";
@@ skipping 119 matching lines @@
           kind == ElementKind.LIBRARY ||
           kind == ElementKind.MALFORMED_TYPE) {
         bool fixedName = false;
         if (kind == ElementKind.CLASS) {
           ClassElement classElement = element;
         }
         if (Elements.isInstanceField(element)) {
           fixedName = element.hasFixedBackendName();
         }
         String result =
-            fixedName ? guess : getFreshName(guess, usedGlobalNames);
+            fixedName ? guess : getFreshName(guess, usedGlobalNames, true);
         globals[element] = result;
         return result;
       }
       compiler.internalError('getName for unknown kind: ${element.kind}',
                               node: element.parseNode(compiler));
     }
   }
 
   String getLazyInitializerName(Element element) {
     assert(Elements.isStaticOrTopLevelField(element));
@@ skipping 10 matching lines @@
 
   String isolateBailoutAccess(Element element) {
     String newName = getMappedGlobalName('${getName(element)}\$bailout');
     return '$CURRENT_ISOLATE.$newName';
   }
 
   String isolateLazyInitializerAccess(Element element) {
     return "$CURRENT_ISOLATE.${getLazyInitializerName(element)}";
   }
 
+  String operatorIsPrefix() => r'$is';
+
   String operatorIs(Element element) {
-    // TODO(erikcorry): Reduce from is$x to ix when we are minifying.
-    return 'is\$${getName(element)}';
+    // TODO(erikcorry): Reduce from $isx to ix when we are minifying.
+    return '${operatorIsPrefix()}${getName(element)}';
   }
 
+  /*
+   * Returns a name that does not clash with reserved JS keywords,
+   * and also ensures it won't clash with other identifiers.
+   */
   String safeName(String name) {
-    if (jsReserved.contains(name) || name.startsWith('\$')) {
-      name = "\$$name";
-      assert(!jsReserved.contains(name));
+    if (jsReserved.contains(name) || name.startsWith(r'$')) {
+      name = '\$$name';
     }
+    assert(!jsReserved.contains(name));
     return name;
   }
+
+  SourceString operatorNameToIdentifier(SourceString name) {
+    if (name == null) return null;
+    String value = name.stringValue;
+    if (value == null) {
+      return name;
+    } else if (identical(value, '==')) {
+      return const SourceString(r'$eq');
+    } else if (identical(value, '~')) {
+      return const SourceString(r'$not');
+    } else if (identical(value, '[]')) {
+      return const SourceString(r'$index');
+    } else if (identical(value, '[]=')) {
+      return const SourceString(r'$indexSet');
+    } else if (identical(value, '*')) {
+      return const SourceString(r'$mul');
+    } else if (identical(value, '/')) {
+      return const SourceString(r'$div');
+    } else if (identical(value, '%')) {
+      return const SourceString(r'$mod');
+    } else if (identical(value, '~/')) {
+      return const SourceString(r'$tdiv');
+    } else if (identical(value, '+')) {
+      return const SourceString(r'$add');
+    } else if (identical(value, '<<')) {
+      return const SourceString(r'$shl');
+    } else if (identical(value, '>>')) {
+      return const SourceString(r'$shr');
+    } else if (identical(value, '>=')) {
+      return const SourceString(r'$ge');
+    } else if (identical(value, '>')) {
+      return const SourceString(r'$gt');
+    } else if (identical(value, '<=')) {
+      return const SourceString(r'$le');
+    } else if (identical(value, '<')) {
+      return const SourceString(r'$lt');
+    } else if (identical(value, '&')) {
+      return const SourceString(r'$and');
+    } else if (identical(value, '^')) {
+      return const SourceString(r'$xor');
+    } else if (identical(value, '|')) {
+      return const SourceString(r'$or');
+    } else if (identical(value, '-')) {
+      return const SourceString(r'$sub');
+    } else if (identical(value, 'unary-')) {
+      return const SourceString(r'$negate');
+    } else {
+      return name;
+    }
+  }
 }