Support for constructor references in constant serializer and prelinker.

pkg/analyzer/test/src/summary/summary_common.dart

 // Copyright (c) 2015, 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.
 
 library analyzer.test.src.summary.summary_common;
 
 import 'package:analyzer/analyzer.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/src/generated/engine.dart';
@@ skipping 450 matching lines @@
    * to the compilation unit within which the [typeRef] appears; if not
    * specified they are assumed to refer to the defining compilation unit.
    * [expectedTargetUnit] is the index of the compilation unit in which the
    * target of the [typeRef] is expected to appear; if not specified it is
    * assumed to be the defining compilation unit.  [numTypeParameters] is the
    * number of type parameters of the thing being referred to.
    */
   void checkTypeRef(EntityRef typeRef, String absoluteUri, String relativeUri,
       String expectedName,
       {String expectedPrefix,
+      List<_PrefixExpectation> prefixExpectations,
       bool allowTypeParameters: false,
       ReferenceKind expectedKind: ReferenceKind.classOrEnum,
       int expectedTargetUnit: 0,
       LinkedUnit linkedSourceUnit,
       UnlinkedUnit unlinkedSourceUnit,
       int numTypeParameters: 0}) {
     linkedSourceUnit ??= definingUnit;
     expect(typeRef, new isInstanceOf<EntityRef>());
     expect(typeRef.paramReference, 0);
     int index = typeRef.reference;
     if (!allowTypeParameters) {
       expect(typeRef.typeArguments, isEmpty);
     }
     UnlinkedReference reference = checkTypeRefCommonElements(
         index,
         absoluteUri,
         relativeUri,
         expectedName,
         expectedKind,
         expectedTargetUnit,
         linkedSourceUnit,
         unlinkedSourceUnit,
         numTypeParameters);
     expect(reference, isNotNull,
         reason: 'Unlinked type refs must refer to an explicit reference');
     if (expectedKind == ReferenceKind.unresolved && !checkAstDerivedData) {
       // summarize_elements.dart isn't yet able to record the prefix of
       // unresolved references.  TODO(paulberry): fix this.
       expect(reference.prefixReference, 0);
-    } else if (expectedPrefix == null) {
+    } else if (expectedPrefix != null) {
+      checkPrefix(reference.prefixReference, expectedPrefix);
+    } else if (prefixExpectations != null) {
+      for (_PrefixExpectation expectation in prefixExpectations) {
+        expect(reference.prefixReference, isNot(0));
+        reference = checkTypeRefCommonElements(
+            reference.prefixReference,
+            expectation.inLibraryDefiningUnit ? null : absoluteUri,
+            expectation.inLibraryDefiningUnit ? null : relativeUri,
+            expectation.name,
+            expectation.kind,
+            expectedTargetUnit,
+            linkedSourceUnit,
+            unlinkedSourceUnit,
+            expectation.numTypeParameters);
+      }
       expect(reference.prefixReference, 0);
     } else {
-      checkPrefix(reference.prefixReference, expectedPrefix);
+      expect(reference.prefixReference, 0);
     }
   }
 
   /**
    * Check the data structures that are common between [checkTypeRef] and
    * [checkLinkedTypeRef].  If the type reference in question is an explicit
    * reference, return the [UnlinkedReference] that is used to make the
    * explicit reference.  If the type reference in question is an implicit
    * reference, return `null`.
    */
@@ skipping 991 matching lines @@
     _assertUnlinkedConst(variable.constExpr, operators: [
       UnlinkedConstOperation.pushInt,
       UnlinkedConstOperation.pushNull,
       UnlinkedConstOperation.identical
     ], ints: [
       42
     ]);
   }
 
   test_constExpr_invokeConstructor_named() {
-    if (checkAstDerivedData) {
-      // TODO(scheglov) at the moment we cannot link class member references
-      return;
-    }
     UnlinkedVariable variable = serializeVariableText('''
 class C {
   const C.named();
 }
 const v = const C.named();
 ''');
     _assertUnlinkedConst(variable.constExpr, operators: [
       UnlinkedConstOperation.invokeConstructor,
     ], ints: [
       0,
       0
-    ], strings: [
-      'named'
     ], referenceValidators: [
-      (EntityRef r) => checkTypeRef(r, null, null, 'C',
-          expectedKind: ReferenceKind.classOrEnum)
+      (EntityRef r) => checkTypeRef(r, null, null, 'named',
+              expectedKind: ReferenceKind.constructor,
+              prefixExpectations: [
+                new _PrefixExpectation(ReferenceKind.classOrEnum, 'C')
+              ])
     ]);
   }
 
   test_constExpr_invokeConstructor_named_imported() {
-    if (checkAstDerivedData) {
-      // TODO(scheglov) at the moment we cannot link class member references
-      return;
-    }
     addNamedSource(
         '/a.dart',
         '''
 class C {
   const C.named();
 }
 ''');
     UnlinkedVariable variable = serializeVariableText('''
 import 'a.dart';
 const v = const C.named();
 ''');
     _assertUnlinkedConst(variable.constExpr, operators: [
       UnlinkedConstOperation.invokeConstructor,
     ], ints: [
       0,
       0
-    ], strings: [
-      'named'
     ], referenceValidators: [
-      (EntityRef r) => checkTypeRef(r, absUri('/a.dart'), 'a.dart', 'C',
-          expectedKind: ReferenceKind.classOrEnum)
+      (EntityRef r) => checkTypeRef(r, absUri('/a.dart'), 'a.dart', 'named',
+              expectedKind: ReferenceKind.constructor,
+              prefixExpectations: [
+                new _PrefixExpectation(ReferenceKind.classOrEnum, 'C')
+              ])
     ]);
   }
 
   test_constExpr_invokeConstructor_named_imported_withPrefix() {
     addNamedSource(
         '/a.dart',
         '''
 class C {
   const C.named();
 }
 ''');
     UnlinkedVariable variable = serializeVariableText('''
 import 'a.dart' as p;
 const v = const p.C.named();
 ''');
     _assertUnlinkedConst(variable.constExpr, operators: [
       UnlinkedConstOperation.invokeConstructor,
     ], ints: [
       0,
       0
-    ], strings: [
-      'named'
     ], referenceValidators: [
-      (EntityRef r) => checkTypeRef(r, absUri('/a.dart'), 'a.dart', 'C',
-          expectedKind: ReferenceKind.classOrEnum, expectedPrefix: 'p')
+      (EntityRef r) => checkTypeRef(r, absUri('/a.dart'), 'a.dart', 'named',
+              expectedKind: ReferenceKind.constructor,
+              prefixExpectations: [
+                new _PrefixExpectation(ReferenceKind.classOrEnum, 'C'),
+                new _PrefixExpectation(ReferenceKind.prefix, 'p',
+                    inLibraryDefiningUnit: true)
+              ])
     ]);
   }
 
   test_constExpr_invokeConstructor_unnamed() {
     UnlinkedVariable variable = serializeVariableText('''
 class C {
   const C(a, b, c, d, {e, f, g});
 }
 const v = const C(11, 22, 3.3, '444', e: 55, g: '777', f: 66);
 ''');
@@ skipping 17 matching lines @@
       66,
       3,
       4,
     ], doubles: [
       3.3
     ], strings: [
       '444',
       '777',
       'e',
       'g',
-      'f',
-      ''
+      'f'
     ], referenceValidators: [
-      (EntityRef r) => checkTypeRef(r, null, null, 'C',
-          expectedKind: ReferenceKind.classOrEnum)
+      (EntityRef r) => checkTypeRef(r, null, null, '',
+              expectedKind: ReferenceKind.constructor,
+              prefixExpectations: [
+                new _PrefixExpectation(ReferenceKind.classOrEnum, 'C')
+              ])
     ]);
   }
 
   test_constExpr_length() {
     UnlinkedVariable variable =
         serializeVariableText('const v = "abc".length;');
     _assertUnlinkedConst(variable.constExpr, operators: [
       UnlinkedConstOperation.pushString,
       UnlinkedConstOperation.length
     ], strings: [
@@ skipping 1610 matching lines @@
     expect(cls.executables[0].parameters[0].inferredTypeSlot, 0);
   }
 
   test_field_inferred_type_nonstatic_explicit_initialized() {
     UnlinkedVariable v = serializeClassText('class C { num v = 0; }').fields[0];
     expect(v.inferredTypeSlot, 0);
   }
 
   test_field_inferred_type_nonstatic_explicit_uninitialized() {
     UnlinkedVariable v = serializeClassText(
-        'class C extends D { num v; } abstract class D { int get v; }',
-        className: 'C',
-        allowErrors: true).fields[0];
+            'class C extends D { num v; } abstract class D { int get v; }',
+            className: 'C',
+            allowErrors: true)
+        .fields[0];
     expect(v.inferredTypeSlot, 0);
   }
 
   test_field_inferred_type_nonstatic_implicit_initialized() {
     UnlinkedVariable v = serializeClassText('class C { var v = 0; }').fields[0];
     checkInferredTypeSlot(v.inferredTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_field_inferred_type_nonstatic_implicit_uninitialized() {
     UnlinkedVariable v = serializeClassText(
-        'class C extends D { var v; } abstract class D { int get v; }',
-        className: 'C').fields[0];
+            'class C extends D { var v; } abstract class D { int get v; }',
+            className: 'C')
+        .fields[0];
     checkInferredTypeSlot(v.inferredTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_field_inferred_type_static_explicit_initialized() {
     UnlinkedVariable v =
         serializeClassText('class C { static int v = 0; }').fields[0];
     expect(v.inferredTypeSlot, 0);
   }
 
   test_field_inferred_type_static_implicit_initialized() {
@@ skipping 77 matching lines @@
  * Docs
  */
 get f => null;''';
     UnlinkedExecutable executable = serializeExecutableText(text);
     expect(executable.documentationComment, isNotNull);
     checkDocumentationComment(executable.documentationComment, text);
   }
 
   test_getter_inferred_type_nonstatic_explicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { num get f => null; }'
-        ' abstract class D { int get f; }',
-        className: 'C',
-        allowErrors: true).executables[0];
+            'class C extends D { num get f => null; }'
+            ' abstract class D { int get f; }',
+            className: 'C',
+            allowErrors: true)
+        .executables[0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
   test_getter_inferred_type_nonstatic_implicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { get f => null; } abstract class D { int get f; }',
-        className: 'C').executables[0];
+            'class C extends D { get f => null; } abstract class D { int get f; }',
+            className: 'C')
+        .executables[0];
     checkInferredTypeSlot(
         f.inferredReturnTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_getter_inferred_type_static_implicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { static get f => null; }'
-        ' class D { static int get f => null; }',
-        className: 'C').executables[0];
+            'class C extends D { static get f => null; }'
+            ' class D { static int get f => null; }',
+            className: 'C')
+        .executables[0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
   test_implicit_dependencies_follow_other_dependencies() {
     if (skipFullyLinkedData) {
       return;
     }
     addNamedSource('/a.dart', 'import "b.dart"; class C {} D f() => null;');
     addNamedSource('/b.dart', 'class D {}');
     serializeLibraryText('import "a.dart"; final x = f(); C y;');
@@ skipping 369 matching lines @@
    */
   f() {}
 }''';
     UnlinkedExecutable executable = serializeClassText(text).executables[0];
     expect(executable.documentationComment, isNotNull);
     checkDocumentationComment(executable.documentationComment, text);
   }
 
   test_method_inferred_type_nonstatic_explicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { void f(num value) {} }'
-        ' abstract class D { void f(int value); }',
-        className: 'C').executables[0];
+            'class C extends D { void f(num value) {} }'
+            ' abstract class D { void f(int value); }',
+            className: 'C')
+        .executables[0];
     expect(f.parameters[0].inferredTypeSlot, 0);
   }
 
   test_method_inferred_type_nonstatic_explicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { num f() => null; } abstract class D { int f(); }',
-        className: 'C',
-        allowErrors: true).executables[0];
+            'class C extends D { num f() => null; } abstract class D { int f(); }',
+            className: 'C',
+            allowErrors: true)
+        .executables[0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
   test_method_inferred_type_nonstatic_implicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { void f(value) {} }'
-        ' abstract class D { void f(int value); }',
-        className: 'C').executables[0];
+            'class C extends D { void f(value) {} }'
+            ' abstract class D { void f(int value); }',
+            className: 'C')
+        .executables[0];
     checkInferredTypeSlot(
         f.parameters[0].inferredTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_method_inferred_type_nonstatic_implicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { f() => null; } abstract class D { int f(); }',
-        className: 'C').executables[0];
+            'class C extends D { f() => null; } abstract class D { int f(); }',
+            className: 'C')
+        .executables[0];
     checkInferredTypeSlot(
         f.inferredReturnTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_method_inferred_type_static_implicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { static void f(value) {} }'
-        ' class D { static void f(int value) {} }',
-        className: 'C').executables[0];
+            'class C extends D { static void f(value) {} }'
+            ' class D { static void f(int value) {} }',
+            className: 'C')
+        .executables[0];
     expect(f.parameters[0].inferredTypeSlot, 0);
   }
 
   test_method_inferred_type_static_implicit_return() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { static f() => null; }'
-        ' class D { static int f() => null; }',
-        className: 'C').executables[0];
+            'class C extends D { static f() => null; }'
+            ' class D { static int f() => null; }',
+            className: 'C')
+        .executables[0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
   test_part_declaration() {
     addNamedSource('/a.dart', 'part of my.lib;');
     String text = 'library my.lib; part "a.dart"; // <-part';
     serializeLibraryText(text);
     expect(unlinkedUnits[0].publicNamespace.parts, hasLength(1));
     expect(unlinkedUnits[0].publicNamespace.parts[0], 'a.dart');
     expect(unlinkedUnits[0].parts, hasLength(1));
@@ skipping 32 matching lines @@
  * Docs
  */
 void set f(value) {}''';
     UnlinkedExecutable executable = serializeExecutableText(text, 'f=');
     expect(executable.documentationComment, isNotNull);
     checkDocumentationComment(executable.documentationComment, text);
   }
 
   test_setter_inferred_type_nonstatic_explicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { void set f(num value) {} }'
-        ' abstract class D { void set f(int value); }',
-        className: 'C').executables[0];
+            'class C extends D { void set f(num value) {} }'
+            ' abstract class D { void set f(int value); }',
+            className: 'C')
+        .executables[0];
     expect(f.parameters[0].inferredTypeSlot, 0);
   }
 
   test_setter_inferred_type_nonstatic_explicit_return() {
     UnlinkedExecutable f =
         serializeClassText('class C { void set f(int value) {} }').executables[
             0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
   test_setter_inferred_type_nonstatic_implicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { void set f(value) {} }'
-        ' abstract class D { void set f(int value); }',
-        className: 'C').executables[0];
+            'class C extends D { void set f(value) {} }'
+            ' abstract class D { void set f(int value); }',
+            className: 'C')
+        .executables[0];
     checkInferredTypeSlot(
         f.parameters[0].inferredTypeSlot, 'dart:core', 'dart:core', 'int');
   }
 
   test_setter_inferred_type_nonstatic_implicit_return() {
     UnlinkedExecutable f =
         serializeClassText('class C { set f(int value) {} }').executables[0];
     checkInferredTypeSlot(f.inferredReturnTypeSlot, null, null, 'void');
   }
 
   test_setter_inferred_type_static_implicit_param() {
     UnlinkedExecutable f = serializeClassText(
-        'class C extends D { static void set f(value) {} }'
-        ' class D { static void set f(int value) {} }',
-        className: 'C').executables[0];
+            'class C extends D { static void set f(value) {} }'
+            ' class D { static void set f(int value) {} }',
+            className: 'C')
+        .executables[0];
     expect(f.parameters[0].inferredTypeSlot, 0);
   }
 
   test_setter_inferred_type_static_implicit_return() {
     UnlinkedExecutable f =
         serializeClassText('class C { static set f(int value) {} }')
             .executables[0];
     expect(f.inferredReturnTypeSlot, 0);
   }
 
@@ skipping 662 matching lines @@
     expect(constExpr.operations, operators);
     expect(constExpr.ints, ints);
     expect(constExpr.doubles, doubles);
     expect(constExpr.strings, strings);
     expect(constExpr.references, hasLength(referenceValidators.length));
     for (int i = 0; i < referenceValidators.length; i++) {
       referenceValidators[i](constExpr.references[i]);
     }
   }
 }
+
+class _PrefixExpectation {

[Paul Berry, 2016/01/26 00:47:21]

Some documentation for this class would be really helpful.

[scheglov, 2016/01/26 04:34:49]

Done.

+  final ReferenceKind kind;
+  final String name;
+  final bool inLibraryDefiningUnit;
+  final int numTypeParameters;
+
+  _PrefixExpectation(this.kind, this.name,
+      {this.inLibraryDefiningUnit: false, this.numTypeParameters: 0});
+}