Generic typedefs and their referents.

runtime/lib/mirrors.cc

 // 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.
 
 #include "lib/invocation_mirror.h"
 #include "vm/bootstrap_natives.h"
 #include "vm/class_finalizer.h"
 #include "vm/compiler.h"
 #include "vm/dart_entry.h"
 #include "vm/exceptions.h"
@@ skipping 217 matching lines @@
     ASSERT(type.IsFinalized());
     name ^= type.name();
     result.SetAt(2 * i, name);
     result.SetAt(2 * i + 1, type);
   }
   return result.raw();
 }
 
 
 static RawInstance* CreateTypedefMirror(const Class& cls,
+                                        const AbstractType& type,
+                                        const Bool& is_declaration,
                                         const Instance& owner_mirror) {
-  const Array& args = Array::Handle(Array::New(3));
+  const Array& args = Array::Handle(Array::New(6));
   args.SetAt(0, MirrorReference::Handle(MirrorReference::New(cls)));
-  args.SetAt(1, String::Handle(cls.UserVisibleName()));
-  args.SetAt(2, owner_mirror);
+  args.SetAt(1, type);
+  args.SetAt(2, String::Handle(cls.UserVisibleName()));
+  args.SetAt(3, Bool::Get(cls.NumTypeParameters() != 0));
+  args.SetAt(4, cls.NumTypeParameters() == 0 ? Bool::False() : is_declaration);
+  args.SetAt(5, owner_mirror);
   return CreateMirror(Symbols::_LocalTypedefMirrorImpl(), args);
 }
 
 
 static RawInstance* CreateFunctionTypeMirror(const Class& cls,
                                              const AbstractType& type) {
   const Array& args = Array::Handle(Array::New(2));
   args.SetAt(0, MirrorReference::Handle(MirrorReference::New(cls)));
   args.SetAt(1, type);
   return CreateMirror(Symbols::_LocalFunctionTypeMirrorImpl(), args);
@@ skipping 68 matching lines @@
   ASSERT(!cls.IsDynamicClass() && !cls.IsVoidClass());
   ASSERT(!type.IsNull());
   ASSERT(type.IsFinalized());
 
   if (cls.IsSignatureClass()) {
     if (cls.IsCanonicalSignatureClass()) {
       // We represent function types as canonical signature classes.
       return CreateFunctionTypeMirror(cls, type);
     } else {
       // We represent typedefs as non-canonical signature classes.
-      return CreateTypedefMirror(cls, owner_mirror);
+      return CreateTypedefMirror(cls, type, is_declaration, owner_mirror);
     }
   }
 
   const Bool& is_generic = Bool::Get(cls.NumTypeParameters() != 0);
   const Bool& is_mixin_typedef = Bool::Get(cls.is_mixin_typedef());
 
   const Array& args = Array::Handle(Array::New(6));
   args.SetAt(0, MirrorReference::Handle(MirrorReference::New(cls)));
   args.SetAt(1, type);
   // We do not set the names of anonymous mixin applications because the mirrors
@@ skipping 479 matching lines @@
     }
   }
 
   // Fall through case: Indicate that we didn't find any function or field using
   // a special null instance. This is different from a field being null. Callers
   // make sure that this null does not leak into Dartland.
   return Object::sentinel().raw();
 }
 
 
+static RawAbstractType* InstantiateType(const AbstractType& type,
+                                        const AbstractType& instantiator) {
+  ASSERT(type.IsFinalized());
+  ASSERT(instantiator.IsFinalized());
+  ASSERT(!type.IsMalformed());
+  ASSERT(!instantiator.IsMalformed());
+
+  if (type.IsInstantiated()) {
+    return type.raw();

[regis, 2013/10/21 19:42:27]

Do you care if the type is canonical or not?

[rmacnak, 2013/10/21 19:57:06]

We do want to deal with canonical types, and rely on this to implement mirror
equality.

Fixed as "return type.Canonicalize();"

+  }
+
+  const AbstractTypeArguments& type_args =
+      AbstractTypeArguments::Handle(instantiator.arguments());
+  Error& bound_error = Error::Handle();
+  AbstractType& result =
+      AbstractType::Handle(type.InstantiateFrom(type_args, &bound_error));
+  if (!bound_error.IsNull()) {
+    ThrowInvokeError(bound_error);

[regis, 2013/10/21 19:42:27]

Are you sure you want to throw the bound error directly? It is a language error,
i.e. compile-time error.

[rmacnak, 2013/10/21 19:57:06]

ThrowInvokeError will wrap it in a MirroredCompilationError. We do the same
thing if ObjectMirror.invoke hits a compile-time error. Unfortunately, this will
be hidden behind a flag in 1.0 (concerns re dart2js), and with the flag unset
ThrowInvokeError will propagate the error directly, resulting in the isolate
being suspended.

+    UNREACHABLE();
+  }
+  ASSERT(result.IsFinalized());
+  return result.Canonicalize();
+}
+
+
 DEFINE_NATIVE_ENTRY(Mirrors_makeLocalMirrorSystem, 0) {
   return CreateMirrorSystem();
 }
 
 
 DEFINE_NATIVE_ENTRY(Mirrors_makeLocalClassMirror, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(AbstractType, type, arguments->NativeArgAt(0));
   ASSERT(!type.IsMalformed());
   ASSERT(type.IsFinalized());
   ASSERT(type.HasResolvedTypeClass());
@@ skipping 131 matching lines @@
   if (!type.HasResolvedTypeClass()) {
     Exceptions::ThrowArgumentError(type);
     UNREACHABLE();
   }
   const Class& cls = Class::Handle(type.type_class());
   const AbstractType& super_type = AbstractType::Handle(cls.super_type());
   ASSERT(super_type.IsNull() || super_type.IsFinalized());
   return super_type.raw();
 }
 
+
 DEFINE_NATIVE_ENTRY(ClassMirror_supertype_instantiated, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(AbstractType, type, arguments->NativeArgAt(0));
   ASSERT(!type.IsMalformed());
   ASSERT(type.IsFinalized());
   if (!type.HasResolvedTypeClass()) {
     Exceptions::ThrowArgumentError(type);
     UNREACHABLE();
   }
   const Class& cls = Class::Handle(type.type_class());
-  AbstractType& super_type = AbstractType::Handle(cls.super_type());
-  AbstractType& result = AbstractType::Handle(super_type.raw());
-
-  ASSERT(super_type.IsType());
-  if (!super_type.IsInstantiated()) {
-    AbstractTypeArguments& type_args =
-        AbstractTypeArguments::Handle(type.arguments());
-    Error& bound_error = Error::Handle();
-    result ^= super_type.InstantiateFrom(type_args, &bound_error);
-    if (!bound_error.IsNull()) {
-      ThrowInvokeError(bound_error);
-      UNREACHABLE();
-    }
-    result ^= result.Canonicalize();
-    ASSERT(result.IsType());
-  }
-
-  ASSERT(result.IsFinalized());
-  return result.raw();
+  const AbstractType& super_type = AbstractType::Handle(cls.super_type());
+  return InstantiateType(super_type, type);
 }
 
 
 DEFINE_NATIVE_ENTRY(ClassMirror_interfaces, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(AbstractType, type, arguments->NativeArgAt(0));
   ASSERT(!type.IsMalformed());
   ASSERT(type.IsFinalized());
   if (!type.HasResolvedTypeClass()) {
     Exceptions::ThrowArgumentError(type);
     UNREACHABLE();
@@ skipping 14 matching lines @@
   if (!type.HasResolvedTypeClass()) {
     Exceptions::ThrowArgumentError(type);
     UNREACHABLE();
   }
   const Class& cls = Class::Handle(type.type_class());
   const Error& error = Error::Handle(cls.EnsureIsFinalized(isolate));
   if (!error.IsNull()) {
     ThrowInvokeError(error);
   }
 
-  AbstractTypeArguments& type_args =
-      AbstractTypeArguments::Handle(type.arguments());
-  Error& bound_error = Error::Handle();
-
   Array& interfaces = Array::Handle(cls.interfaces());
   Array& interfaces_inst = Array::Handle(Array::New(interfaces.Length()));
   AbstractType& interface = AbstractType::Handle();
 
   for (int i = 0; i < interfaces.Length(); i++) {
     interface ^= interfaces.At(i);
-    ASSERT(interface.IsType());
-    if (!interface.IsInstantiated()) {
-      bound_error ^= Object::null();
-      interface ^= interface.InstantiateFrom(type_args, &bound_error);
-      if (!bound_error.IsNull()) {
-        ThrowInvokeError(bound_error);
-        UNREACHABLE();
-      }
-      interface ^= interface.Canonicalize();
-      ASSERT(interface.IsType());
-    }
+    interface = InstantiateType(interface, type);
     interfaces_inst.SetAt(i, interface);
   }
 
   return interfaces_inst.raw();
 }
 
 
 DEFINE_NATIVE_ENTRY(ClassMirror_mixin, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(AbstractType, type, arguments->NativeArgAt(0));
   ASSERT(!type.IsMalformed());
@@ skipping 18 matching lines @@
   ASSERT(type.IsFinalized());
   if (!type.HasResolvedTypeClass()) {
     Exceptions::ThrowArgumentError(type);
     UNREACHABLE();
   }
   const Class& cls = Class::Handle(type.type_class());
   const AbstractType& mixin_type = AbstractType::Handle(cls.mixin());
   if (mixin_type.IsNull()) {
     return mixin_type.raw();
   }
-  ASSERT(mixin_type.IsFinalized());
 
-  ASSERT(!instantiator.IsMalformed());
-  ASSERT(instantiator.IsFinalized());
-
-  AbstractType& result = AbstractType::Handle(mixin_type.raw());
-
-  ASSERT(mixin_type.IsType());
-  if (!mixin_type.IsInstantiated()) {
-    AbstractTypeArguments& type_args =
-        AbstractTypeArguments::Handle(instantiator.arguments());
-    Error& bound_error = Error::Handle();
-    result ^= mixin_type.InstantiateFrom(type_args, &bound_error);
-    if (!bound_error.IsNull()) {
-      ThrowInvokeError(bound_error);
-      UNREACHABLE();
-    }
-    result ^= result.Canonicalize();
-    ASSERT(result.IsType());
-  }
-
-  ASSERT(result.IsFinalized());
-  return result.raw();
+  return InstantiateType(mixin_type, instantiator);
 }
 
 
 DEFINE_NATIVE_ENTRY(ClassMirror_members, 2) {
   GET_NON_NULL_NATIVE_ARGUMENT(Instance,
                                owner_mirror,
                                arguments->NativeArgAt(0));
   GET_NON_NULL_NATIVE_ARGUMENT(MirrorReference, ref, arguments->NativeArgAt(1));
   const Class& klass = Class::Handle(ref.GetClassReferent());
 
@@ skipping 176 matching lines @@
 
 DEFINE_NATIVE_ENTRY(TypeVariableMirror_upper_bound, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(TypeParameter, param, arguments->NativeArgAt(0));
   return param.bound();
 }
 
 
 DEFINE_NATIVE_ENTRY(TypeVariableMirror_instantiate_from, 2) {
   GET_NON_NULL_NATIVE_ARGUMENT(TypeParameter, param, arguments->NativeArgAt(0));
   GET_NON_NULL_NATIVE_ARGUMENT(Type, instantiator, arguments->NativeArgAt(1));
-
   ASSERT(param.parameterized_class() == instantiator.type_class());
-
-  AbstractTypeArguments& type_args =
-      AbstractTypeArguments::Handle(instantiator.arguments());
-  Error& bound_error = Error::Handle();
-  AbstractType& result =
-      AbstractType::Handle(param.InstantiateFrom(type_args, &bound_error));
-  ASSERT(bound_error.IsNull());
-  ASSERT(result.IsFinalized());
-  return result.raw();
+  return InstantiateType(param, instantiator);
 }
 
 
+DEFINE_NATIVE_ENTRY(TypedefMirror_instantiate_from, 2) {
+  GET_NON_NULL_NATIVE_ARGUMENT(Type, type, arguments->NativeArgAt(0));
+  GET_NON_NULL_NATIVE_ARGUMENT(Type, instantiator, arguments->NativeArgAt(1));
+  const Class& cls = Class::Handle(type.type_class());
+  // We represent typedefs as non-canonical signature classes.
+  ASSERT(cls.IsSignatureClass() && !cls.IsCanonicalSignatureClass());
+  return InstantiateType(type, instantiator);
+}
+
+
+
+DEFINE_NATIVE_ENTRY(TypedefMirror_declaration, 1) {
+  GET_NON_NULL_NATIVE_ARGUMENT(Type, type, arguments->NativeArgAt(0));
+  const Class& cls = Class::Handle(type.type_class());
+  // We represent typedefs as non-canonical signature classes.
+  ASSERT(cls.IsSignatureClass() && !cls.IsCanonicalSignatureClass());
+  return CreateTypedefMirror(cls,
+                             AbstractType::Handle(cls.DeclarationType()),
+                             Bool::True(),  // is_declaration
+                             Object::null_instance());
+}
+
 DEFINE_NATIVE_ENTRY(InstanceMirror_invoke, 5) {
   // Argument 0 is the mirror, which is unused by the native. It exists
   // because this native is an instance method in order to be polymorphic
   // with its cousins.
   GET_NATIVE_ARGUMENT(Instance, reflectee, arguments->NativeArgAt(1));
   GET_NON_NULL_NATIVE_ARGUMENT(
       String, function_name, arguments->NativeArgAt(2));
   GET_NON_NULL_NATIVE_ARGUMENT(Array, args, arguments->NativeArgAt(3));
   GET_NON_NULL_NATIVE_ARGUMENT(Array, arg_names, arguments->NativeArgAt(4));
 
@@ skipping 603 matching lines @@
       (tkit.CurrentTokenKind() == Token::kRPAREN) ||                  // Case 2.
       (tkit.CurrentTokenKind() == Token::kSEMICOLON &&
        String::Handle(func.name()).Equals("<anonymous closure>"))) {  // Case 3.
     last_tok_len = 0;
   }
   return script.GetSnippet(from_line, from_col, to_line, to_col + last_tok_len);
 }
 
 
 DEFINE_NATIVE_ENTRY(TypedefMirror_referent, 1) {
-  GET_NON_NULL_NATIVE_ARGUMENT(MirrorReference, ref, arguments->NativeArgAt(0));
-  const Class& cls = Class::Handle(ref.GetClassReferent());
+  GET_NON_NULL_NATIVE_ARGUMENT(Type, type, arguments->NativeArgAt(0));
+  const Class& cls = Class::Handle(type.type_class());
   const Function& sig_func = Function::Handle(cls.signature_function());
   const Class& sig_cls = Class::Handle(sig_func.signature_class());
-  return MirrorReference::New(sig_cls);
+
+  AbstractType& referent_type = AbstractType::Handle(sig_cls.DeclarationType());
+  referent_type = InstantiateType(referent_type, type);
+
+  return CreateFunctionTypeMirror(sig_cls, referent_type);
 }
 
 
 DEFINE_NATIVE_ENTRY(ParameterMirror_type, 2) {
   GET_NON_NULL_NATIVE_ARGUMENT(MirrorReference, ref, arguments->NativeArgAt(0));
   GET_NON_NULL_NATIVE_ARGUMENT(Smi, pos, arguments->NativeArgAt(1));
   const Function& func = Function::Handle(ref.GetFunctionReferent());
   return func.ParameterTypeAt(func.NumImplicitParameters() + pos.Value());
 }
 
 
 DEFINE_NATIVE_ENTRY(VariableMirror_type, 1) {
   GET_NON_NULL_NATIVE_ARGUMENT(MirrorReference, ref, arguments->NativeArgAt(0));
   const Field& field = Field::Handle(ref.GetFieldReferent());
   return field.type();
 }
 
 }  // namespace dart