Support runtime check of function types.

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

 // Copyright (c) 2012, 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;
 
 /**
  * A function element that represents a closure call. The signature is copied
  * from the given element.
  */
@@ skipping 88 matching lines @@
   /**
    * Raw ClassElement symbols occuring in is-checks and type assertions.  If the
    * program contains parameterized checks `x is Set<int>` and
    * `x is Set<String>` then the ClassElement `Set` will occur once in
    * [checkedClasses].
    */
   Set<ClassElement> checkedClasses;
 
   /**
    * Raw Typedef symbols occuring in is-checks and type assertions.  If the
    * program contains `x is F<int>` and `x is F<bool>` then the TypedefElement

[karlklose, 2013/03/22 13:17:46]

Please update comment and change to use [::] instead of ``.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

    * `F` will occur once in [checkedTypedefs].
    */
-  Set<TypedefElement> checkedTypedefs;
+  Set<FunctionType> checkedFunctionTypes;
+
+  Map<ClassElement, Set<FunctionType>> checkedGenericFunctionTypes
+      = new Map<ClassElement, Set<FunctionType>>();

[karlklose, 2013/03/22 13:17:46]

Break after '='.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+
+  Set<FunctionType> checkedNonGenericFunctionTypes

[karlklose, 2013/03/22 13:17:46]

Ditto.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+      = new Set<FunctionType>();
+
+  void registerDynamicFunctionTypeCheck(FunctionType functionType) {
+    ClassElement classElement = Types.getClassContext(functionType);
+    if (classElement != null) {
+      checkedGenericFunctionTypes.putIfAbsent(classElement,
+          () => new Set<FunctionType>()).add(functionType);
+    } else {
+      checkedNonGenericFunctionTypes.add(functionType);
+    }
+  }
 
   final bool generateSourceMap;
 
   Iterable<ClassElement> cachedClassesUsingTypeVariableTests;
 
   Iterable<ClassElement> get classesUsingTypeVariableTests {
     if (cachedClassesUsingTypeVariableTests == null) {
       cachedClassesUsingTypeVariableTests = compiler.codegenWorld.isChecks
           .where((DartType t) => t is TypeVariableType)
           .map((TypeVariableType v) => v.element.getEnclosingClass())
@@ skipping 10 matching lines @@
         constantEmitter = new ConstantEmitter(compiler, namer),
         super(compiler) {
     nativeEmitter = new NativeEmitter(this);
   }
 
   void addComment(String comment, CodeBuffer buffer) {
     buffer.write(jsAst.prettyPrint(js.comment(comment), compiler));
   }
 
   void computeRequiredTypeChecks() {
-    assert(checkedClasses == null && checkedTypedefs == null);
+    assert(checkedClasses == null && checkedFunctionTypes == null);
 
     compiler.codegenWorld.addImplicitChecks(classesUsingTypeVariableTests);
 
     checkedClasses = new Set<ClassElement>();
-    checkedTypedefs = new Set<TypedefElement>();
+    checkedFunctionTypes = new Set<FunctionType>();
     compiler.codegenWorld.isChecks.forEach((DartType t) {
       if (t is InterfaceType) {
         checkedClasses.add(t.element);
-      } else if (t is TypedefType) {
-        checkedTypedefs.add(t.element);
+      } else if (t is FunctionType) {
+        checkedFunctionTypes.add(t);
       }
     });
   }
 
   jsAst.Expression constantReference(Constant value) {
     return constantEmitter.reference(value);
   }
 
   jsAst.Expression constantInitializerExpression(Constant value) {
     return constantEmitter.initializationExpression(value);
@@ skipping 1033 matching lines @@
         return;
       }
       if (nativeEmitter.requiresNativeIsCheck(other)) {
         code = js.fun([], [js.return_(true)]);
       } else {
         code = new jsAst.LiteralBool(true);
       }
       builder.addProperty(namer.operatorIs(other), code);
     }
 
+    void generateIsFunctionTypeTest(FunctionType type) {
+      String operator = namer.operatorIsType(type);
+      builder.addProperty(operator, new jsAst.LiteralBool(true));
+    }
+
+    void generateFunctionTypeSignature(Element method, FunctionType type) {
+      assert(method.isImplementation);
+      String thisAccess = 'this';
+      Node node = method.parseNode(compiler);
+      ClosureClassMap closureData =
+          compiler.closureToClassMapper.closureMappingCache[node];
+      if (closureData != null) {
+        Element thisElement =
+            closureData.freeVariableMapping[closureData.thisElement];
+        if (thisElement != null) {
+          String thisName = backend.namer.getName(thisElement);
+          thisAccess = 'this.$thisName';
+        }
+      }
+      RuntimeTypes rti = backend.rti;
+      String encoding = rti.getSignatureEncoding(type, () => '$thisAccess');
+      String operatorSignature = namer.operatorSignature();
+      builder.addProperty(operatorSignature,
+          new jsAst.LiteralExpression(encoding));
+    }
+
     void generateSubstitution(Element other, {bool emitNull: false}) {
       RuntimeTypes rti = backend.rti;
       // TODO(karlklose): support typedefs with variables.
       jsAst.Expression expression;
       bool needsNativeCheck = nativeEmitter.requiresNativeIsCheck(other);
       if (other.kind == ElementKind.CLASS) {
         String substitution = rti.getSupertypeSubstitution(classElement, other,
             alwaysGenerateFunction: true);
         if (substitution != null) {
           expression = new jsAst.LiteralExpression(substitution);
         } else if (emitNull || needsNativeCheck) {
           expression = new jsAst.LiteralNull();
         }
       }
       if (expression != null) {
         if (needsNativeCheck) {
           expression = js.fun([], js.return_(expression));
         }
         builder.addProperty(namer.substitutionName(other), expression);
       }
     }
 
-    generateIsTestsOn(classElement, generateIsTest, generateSubstitution);
+    generateIsTestsOn(classElement, generateIsTest,
+        generateIsFunctionTypeTest, generateFunctionTypeSignature,
+        generateSubstitution);
 
     if (identical(classElement, compiler.objectClass)
         && compiler.enabledNoSuchMethod) {
       // Emit the noSuchMethod handlers on the Object prototype now,
       // so that the code in the dynamicFunction helper can find
       // them. Note that this helper is invoked before analyzing the
       // full JS script.
       if (!nativeEmitter.handleNoSuchMethod) {
         emitNoSuchMethodHandlers(builder.addProperty);
       }
@@ skipping 33 matching lines @@
     }
 
     // Add checks to the constructors of instantiated classes or to the created
     // holder object.
     for (ClassElement cls in typeChecks) {
       String holder = namer.isolateAccess(cls);
       for (ClassElement check in typeChecks[cls]) {
         buffer.write('$holder.${namer.operatorIs(check)}$_=${_}true$N');
         String body = rti.getSupertypeSubstitution(cls, check);
         if (body != null) {
           buffer.write('$holder.${namer.substitutionName(check)}$_=${_}$body$N');

[karlklose, 2013/03/22 13:17:46]

Long line.

[Johnni Winther, 2013/06/21 12:19:14]

Stale.

         }
       };
     }
+
+    checkedNonGenericFunctionTypes.forEach((FunctionType type) {
+      String encoding = rti.getTypeEncoding(type);
+      buffer.add('${namer.signatureName(type)}$_=${_}$encoding$N');
+    });
+
+    checkedGenericFunctionTypes.forEach(
+        (ClassElement cls, Set<FunctionType> functionTypes) {
+          for (FunctionType type in functionTypes) {

[karlklose, 2013/03/22 13:17:46]

I would indent the body of the function by two spaces.

Did you need to break before the first argument; would that work?

checkedGenericFunctionTypes.forEach((ClassElement cls,             
                                     Set<FunctionType> functionTypes) {

[Johnni Winther, 2013/06/21 12:19:14]

Stale.

+            ClassElement contextClass = Types.getClassContext(type);
+            if (contextClass != null) {
+              maybeGenerateHolder(contextClass);
+            }
+            String encoding = rti.getTypeEncoding(type);
+            buffer.add('${namer.signatureName(type)}$_=${_}$encoding$N');
+          }
+        });
   }
 
   void visitNativeMixins(ClassElement classElement,
                          void visit(MixinApplicationElement mixinApplication)) {
     if (!classElement.isNative()) return;
     // Use recursion to make sure to visit the superclasses before the
     // subclasses. Once we start keeping track of the emitted fields
     // and members, we're going to want to visit these in the other
     // order so we get the most specialized definition first.
     void recurse(ClassElement cls) {
@@ skipping 142 matching lines @@
                              ClassBuilder builder) {
     assert(canGenerateCheckedSetter(member));
     DartType type = member.computeType(compiler);
     // TODO(ahe): Generate a dynamic type error here.
     if (type.element.isErroneous()) return;
     FunctionElement helperElement
         = backend.getCheckedModeHelper(type, typeCast: false);
     String helperName = namer.isolateAccess(helperElement);
     List<jsAst.Expression> arguments = <jsAst.Expression>[js['v']];
     if (helperElement.computeSignature(compiler).parameterCount != 1) {
-      arguments.add(js.string(namer.operatorIs(type.element)));
+      arguments.add(js.string(namer.operatorIsType(type)));
     }
 
     String setterName = namer.setterNameFromAccessorName(accessorName);
     String receiver = backend.isInterceptorClass(member.getEnclosingClass())
         ? 'receiver' : 'this';
     List<String> args = backend.isInterceptedMethod(member)
         ? ['receiver', 'v']
         : ['v'];
     builder.addProperty(setterName,
         js.fun(args,
@@ skipping 156 matching lines @@
     return arity;
   }
 
   int _compareSelectorNames(Selector selector1, Selector selector2) {
     String name1 = selector1.name.toString();
     String name2 = selector2.name.toString();
     if (name1 != name2) return Comparable.compare(name1, name2);
     return _selectorRank(selector1) - _selectorRank(selector2);
   }
 
-  Iterable<Element> getTypedefChecksOn(DartType type) {
-    bool isSubtype(TypedefElement typedef) {
-      FunctionType typedefType =
-          typedef.computeType(compiler).unalias(compiler);
-      return compiler.types.isSubtype(type, typedefType);
+  /**
+   * Returns a mapping containing all checked function types for which [type]
+   * can be a subtype. A function type is mapped to [:true:] if [type] is
+   * statically known to be a subtype of it.

[karlklose, 2013/03/22 13:17:46]

Explain what being false means.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+   */
+  // TODO(johnniwinther): Change to return a mapping from function types to
+  // a set of variable points and use this to detect statically/dynamically
+  // known subtype relations.
+  Map<FunctionType, bool> getFunctionTypeChecksOn(DartType type) {
+    Map<FunctionType, bool> functionTypeMap =
+        new LinkedHashMap<FunctionType, bool>();
+    for (FunctionType functionType in checkedFunctionTypes) {
+      if (compiler.types.isSubtype(type, functionType)) {
+        functionTypeMap[functionType] = true;
+      } else if (compiler.types.isPotentialSubtype(type, functionType)) {
+        functionTypeMap[functionType] = false;
+      }
     }
-    return checkedTypedefs.where(isSubtype).toList()
-        ..sort(Elements.compareByPosition);
+    // TODO(johnniwinther): Ensure stable ordering of the keys.
+    return functionTypeMap;
   }
 
   /**
    * Generate "is tests" for [cls]: itself, and the "is tests" for the
    * classes it implements and type argument substitution functions for these
    * tests.   We don't need to add the "is tests" of the super class because
    * they will be inherited at runtime, but we may need to generate the
    * substitutions, because they may have changed.
    */
   void generateIsTestsOn(ClassElement cls,
                          void emitIsTest(Element element),
+                         void emitIsFunctionTypeTest(FunctionType type),
+                         void emitFunctionTypeSignature(Element method, FunctionType type),

[karlklose, 2013/03/22 13:17:46]

Long line.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

                          void emitSubstitution(Element element, {emitNull})) {
     if (checkedClasses.contains(cls)) {
       emitIsTest(cls);
       emitSubstitution(cls);
     }
 
     RuntimeTypes rti = backend.rti;
     ClassElement superclass = cls.superclass;
 
     bool haveSameTypeVariables(ClassElement a, ClassElement b) {
@@ skipping 31 matching lines @@
         }
       }
       void emitNothing(_, {emitNull}) {};
       emitSubstitution = emitNothing;
     }
 
     Set<Element> generated = new Set<Element>();
     // A class that defines a [:call:] method implicitly implements
     // [Function] and needs checks for all typedefs that are used in is-checks.
     if (checkedClasses.contains(compiler.functionClass) ||
-        !checkedTypedefs.isEmpty) {
+        !checkedFunctionTypes.isEmpty) {
       FunctionElement call = cls.lookupLocalMember(Compiler.CALL_OPERATOR_NAME);
       if (call == null) {
         // If [cls] is a closure, it has a synthetic call operator method.
         call = cls.lookupBackendMember(Compiler.CALL_OPERATOR_NAME);
       }
       if (call != null) {
         generateInterfacesIsTests(compiler.functionClass,
                                   emitIsTest,
                                   emitSubstitution,
                                   generated);
-        getTypedefChecksOn(call.computeType(compiler)).forEach(emitIsTest);
-      }
+        FunctionType callType = call.computeType(compiler);
+        generateFunctionTypeTests(call, callType,
+            emitFunctionTypeSignature, emitIsFunctionTypeTest);
+     }
     }
 
     for (DartType interfaceType in cls.interfaces) {
       generateInterfacesIsTests(interfaceType.element, emitIsTest,
                                 emitSubstitution, generated);
     }
 
     // For native classes, we also have to run through their mixin
     // applications and make sure we deal with 'is' tests correctly
     // for those.
@@ skipping 32 matching lines @@
 
     // We need to also emit "is checks" for the superclass and its supertypes.
     ClassElement superclass = cls.superclass;
     if (superclass != null) {
       tryEmitTest(superclass);
       generateInterfacesIsTests(superclass, emitIsTest, emitSubstitution,
                                 alreadyGenerated);
     }
   }
 
+  void generateFunctionTypeTests(
+      Element method,
+      FunctionType methodType,
+      void emitFunctionTypeSignature(Element method, FunctionType methodType),
+      void emitIsFunctionTypeTest(FunctionType functionType)) {
+    Map<FunctionType, bool> functionTypeChecks =
+        getFunctionTypeChecksOn(methodType);
+    generateFunctionTypeTestsInternal(method, methodType, functionTypeChecks,
+        emitFunctionTypeSignature, emitIsFunctionTypeTest);
+  }
+
+  const int MAX_FUNCTION_TYPE_PREDICATES = 10;
+
+  void generateFunctionTypeTestsInternal(
+      Element method,
+      FunctionType methodType,
+      Map<FunctionType, bool> functionTypeChecks,
+      void emitFunctionTypeSignature(Element method, FunctionType methodType),
+      void emitIsFunctionTypeTest(FunctionType functionType)) {
+    bool hasDynamicFunctionTypeCheck = false;
+    int neededPredicates = 0;
+    functionTypeChecks.forEach((FunctionType functionType,
+        bool knownSubtype) {

[karlklose, 2013/03/22 13:17:46]

Align with '(FunctionType...'.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+      if (!knownSubtype) {
+        registerDynamicFunctionTypeCheck(functionType);

[karlklose, 2013/03/22 13:17:46]

Why are we registering it in the emitter. Shouldn't the codegen register it?

[Johnni Winther, 2013/06/21 12:19:14]

Which function type check that are dynamic depends on both the target and the
type so it cannot be determined before we know all potentially closurized
methods.

+        hasDynamicFunctionTypeCheck = true;
+      } else {
+        neededPredicates++;
+      }
+    });
+    bool hasSignature = false;

[karlklose, 2013/03/22 13:17:46]

'signatureEmitted'?

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+    if (hasDynamicFunctionTypeCheck ||
+        neededPredicates > MAX_FUNCTION_TYPE_PREDICATES) {
+      emitFunctionTypeSignature(method, methodType);
+      hasSignature = true;
+    }
+    functionTypeChecks.forEach((FunctionType functionType,
+        bool knownSubtype) {

[karlklose, 2013/03/22 13:17:46]

Align.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+      if (knownSubtype || !hasDynamicFunctionTypeCheck) {
+        if (hasSignature) {
+          registerDynamicFunctionTypeCheck(functionType);
+        } else {
+          emitIsFunctionTypeTest(functionType);
+        }
+      }
+    });
+  }
+
   /**
    * Return a function that returns true if its argument is a class
    * that needs to be emitted.
    */
   Function computeClassFilter() {
     Set<ClassElement> unneededClasses = new Set<ClassElement>();
     // The [Bool] class is not marked as abstract, but has a factory
     // constructor that always throws. We never need to emit it.
     unneededClasses.add(compiler.boolClass);
 
@@ skipping 109 matching lines @@
         jsAst.Expression assignment =
             js[isolateProperties][staticName][name].assign(value);
         buffer.write(jsAst.prettyPrint(assignment.toStatement(), compiler));
         buffer.write('$N');
       });
 
       // If a static function is used as a closure we need to add its name
       // in case it is used in spawnFunction.
       String fieldName = namer.STATIC_CLOSURE_NAME_NAME;
       buffer.write('$fieldAccess.$fieldName$_=$_"$staticName"$N');
-      getTypedefChecksOn(element.computeType(compiler)).forEach(
-        (Element typedef) {
-          String operator = namer.operatorIs(typedef);
-          buffer.write('$fieldAccess.$operator$_=${_}true$N');
-        }
-      );
+
+      void emitFunctionTypeSignature(Element method, FunctionType methodType) {
+        RuntimeTypes rti = backend.rti;
+        String encoding = rti.getSignatureEncoding(methodType, () => 'null');

[karlklose, 2013/03/22 13:17:46]

Please explain what null means here.

[Johnni Winther, 2013/06/21 12:19:14]

Done.

+        String operatorSignature = namer.operatorSignature();
+        buffer.add('$fieldAccess.$operatorSignature$_=${_}$encoding$N');
+      }
+
+      void emitIsFunctionTypeTest(FunctionType functionType) {
+        String operator = namer.operatorIsType(functionType);
+        buffer.write('$fieldAccess.$operator$_=${_}true$N');
+      }
+
+      generateFunctionTypeTests(element, element.computeType(compiler),
+          emitFunctionTypeSignature, emitIsFunctionTypeTest);
     }
   }
 
   void emitBoundClosureClassHeader(String mangledName,
                                    String superName,
                                    List<String> fieldNames,
                                    ClassBuilder builder) {
     builder.addProperty('',
         js.string("$superName;${fieldNames.join(',')}"));
   }
@@ skipping 40 matching lines @@
       extraArg = 'receiver';
     } else {
       cache = boundClosureCache;
     }
     List<String> fieldNames = compiler.enableMinification
         ? inInterceptor ? const ['a', 'b', 'c']
                         : const ['a', 'b']
         : inInterceptor ? const ['self', 'target', 'receiver']
                         : const ['self', 'target'];
 
-    Iterable<Element> typedefChecks =
-        getTypedefChecksOn(member.computeType(compiler));
-    bool hasTypedefChecks = !typedefChecks.isEmpty;
+    DartType memberType = member.computeType(compiler);
+    Map<FunctionType, bool> functionTypeChecks =
+        getFunctionTypeChecksOn(memberType);
+    bool hasFunctionTypeChecks = !functionTypeChecks.isEmpty;
 
-    bool canBeShared = !hasOptionalParameters && !hasTypedefChecks;
+    bool canBeShared = !hasOptionalParameters && !hasFunctionTypeChecks;
 
+    ClassElement classElement = member.getEnclosingClass();
     String closureClass = canBeShared ? cache[parameterCount] : null;
     if (closureClass == null) {
       // Either the class was not cached yet, or there are optional parameters.
       // Create a new closure class.
       String name;
       if (canBeShared) {
         if (inInterceptor) {
           name = 'BoundClosure\$i${parameterCount}';
         } else {
           name = 'BoundClosure\$${parameterCount}';
@@ skipping 36 matching lines @@
         arguments.add(js[name]);
       }
 
       jsAst.Expression fun = js.fun(
           parameters,
           js.return_(
               js['this'][fieldNames[0]][js['this'][fieldNames[1]]](arguments)));
       boundClosureBuilder.addProperty(invocationName, fun);
 
       addParameterStubs(callElement, boundClosureBuilder.addProperty);
-      typedefChecks.forEach((Element typedef) {
-        String operator = namer.operatorIs(typedef);
-        boundClosureBuilder.addProperty(operator, new jsAst.LiteralBool(true));
-      });
+
+      void emitFunctionTypeSignature(Element method, FunctionType methodType) {
+        RuntimeTypes rti = backend.rti;
+        String encoding = rti.getSignatureEncoding(
+            methodType, () => 'this.${fieldNames[0]}');
+        String operatorSignature = namer.operatorSignature();
+        boundClosureBuilder.addProperty(operatorSignature,
+            new jsAst.LiteralExpression(encoding));
+      }
+
+      void emitIsFunctionTypeTest(FunctionType functionType) {
+        String operator = namer.operatorIsType(functionType);
+        boundClosureBuilder.addProperty(operator,
+            new jsAst.LiteralBool(true));
+      }
+
+      generateFunctionTypeTestsInternal(member, memberType, functionTypeChecks,
+          emitFunctionTypeSignature, emitIsFunctionTypeTest);
 
       boundClosures.add(
           js[classesCollector][mangledName].assign(
               boundClosureBuilder.toObjectInitializer()));
 
       closureClass = namer.isolateAccess(closureClassElement);
 
       // Cache it.
       if (canBeShared) {
         cache[parameterCount] = closureClass;
       }
     }
 
     // And finally the getter.
     String getterName = namer.getterName(member);
     String targetName = namer.instanceMethodName(member);
 
     List<String> parameters = <String>[];
     List<jsAst.Expression> arguments = <jsAst.Expression>[];
     arguments.add(js['this']);
     arguments.add(js.string(targetName));
     if (inInterceptor) {
       parameters.add(extraArg);
       arguments.add(js[extraArg]);
     }
 
+    jsAst.Expression newClosure = js[closureClass].newWith(arguments);
     jsAst.Expression getterFunction = js.fun(
-        parameters,
-        js.return_(js[closureClass].newWith(arguments)));
+        parameters, js.return_(newClosure));
 
     defineStub(getterName, getterFunction);
   }
 
   /**
    * Documentation wanted -- johnniwinther
    *
    * Invariant: [member] must be a declaration element.
    */
   void emitCallStubForGetter(Element member,
@@ skipping 19 matching lines @@
             ? member.fixedBackendName()
             : namer.instanceFieldName(member);
         return js['this'][fieldName];
       }
     }
 
     // Two selectors may match but differ only in type.  To avoid generating
     // identical stubs for each we track untyped selectors which already have
     // stubs.
     Set<Selector> generatedSelectors = new Set<Selector>();
-
+    DartType memberType = member.computeType(compiler);
     for (Selector selector in selectors) {
       if (selector.applies(member, compiler)) {
         selector = selector.asUntyped;
         if (generatedSelectors.contains(selector)) continue;
         generatedSelectors.add(selector);
 
         String invocationName = namer.invocationName(selector);
         Selector callSelector = new Selector.callClosureFrom(selector);
         String closureCallName = namer.invocationName(callSelector);
 
@@ skipping 957 matching lines @@
 """;
 const String HOOKS_API_USAGE = """
 // The code supports the following hooks:
 // dartPrint(message)   - if this function is defined it is called
 //                        instead of the Dart [print] method.
 // dartMainRunner(main) - if this function is defined, the Dart [main]
 //                        method will not be invoked directly.
 //                        Instead, a closure that will invoke [main] is
 //                        passed to [dartMainRunner].
 """;