[analyzer] Expose some inheritance manager methods through the public API.

A few analyzer clients make use of the private `InheritanceManager3`
class, notably:

- `package:mockito`,
- `package:dartdoc`,
- `package:analyzer_plugin`
- The Google-internal logic to integrate Dart with Kythe.

This creates a breakage risk, because private classes of the analyzer
might get updated at any time without a major version number change.

This CL introduces new methods and getters to the `InterfaceElement2`
class, providing the functionality needed by the above clients. It
also exposes the formerly private `Name` class, which is referred to
by the new methods and getters. Once a new version of the analyzer
containing this change has been published, I will update the clients
to use the new public API.

Change-Id: I859409a5e3009521d1df8ff6187329aedfb73fa2
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/412621
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit-Queue: Paul Berry <[email protected]>

Author: stereotype441

pkg/analysis_server/lib/src/lsp/handlers/custom/handler_super.dart

@@ -11,7 +11,6 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/src/dart/analysis/session.dart';
 import 'package:analyzer/src/dart/ast/element_locator.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer/src/utilities/extensions/ast.dart';
 
 class SuperHandler

pkg/analysis_server/lib/src/services/correction/dart/create_method.dart

@@ -7,7 +7,6 @@ import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element2.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';

pkg/analysis_server/lib/src/services/correction/dart/encapsulate_field.dart

@@ -7,7 +7,6 @@ import 'package:analysis_server/src/utilities/extensions/ast.dart';
 import 'package:analysis_server_plugin/edit/dart/correction_producer.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element2.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer_plugin/utilities/assist/assist.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart';

pkg/analysis_server/lib/src/services/correction/dart/import_library.dart

@@ -18,7 +18,6 @@ import 'package:analyzer/dart/element/type_system.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:analyzer/src/dart/ast/extensions.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer/src/dart/element/type.dart';
 import 'package:analyzer/src/dart/resolver/applicable_extensions.dart';
 import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_dart.dart';

pkg/analysis_server/lib/src/services/correction/dart/rename_method_parameter.dart

@@ -8,7 +8,6 @@ import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/src/dart/ast/ast.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:analyzer_plugin/utilities/range_factory.dart';

pkg/analysis_server/lib/src/services/correction/dart/use_different_division_operator.dart

@@ -9,7 +9,6 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/dart/element/type.dart';
-import 'package:analyzer/src/dart/element/inheritance_manager3.dart';
 import 'package:analyzer/src/dart/element/type.dart';
 import 'package:analyzer/src/dart/resolver/applicable_extensions.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';

pkg/analyzer/api.txt

@@ -3917,12 +3917,19 @@ package:analyzer/dart/element/element2.dart:
     constructors2 (getter: List<ConstructorElement2>)
     firstFragment (getter: InterfaceFragment)
     fragments (getter: List<InterfaceFragment>)
+    inheritedConcreteMembers (getter: Map<Name, ExecutableElement2>)
+    inheritedMembers (getter: Map<Name, ExecutableElement2>)
+    interfaceMembers (getter: Map<Name, ExecutableElement2>)
     interfaces (getter: List<InterfaceType>)
     mixins (getter: List<InterfaceType>)
     supertype (getter: InterfaceType?)
     thisType (getter: InterfaceType)
     unnamedConstructor2 (getter: ConstructorElement2?)
+    getInheritedConcreteMember (method: ExecutableElement2? Function(Name))
+    getInheritedMember (method: ExecutableElement2? Function(Name))
+    getInterfaceMember (method: ExecutableElement2? Function(Name))
     getNamedConstructor2 (method: ConstructorElement2? Function(String))
+    getOverridden (method: List<ExecutableElement2>? Function(Name))
     instantiate (method: InterfaceType Function({required NullabilitySuffix nullabilitySuffix, required List<DartType> typeArguments}))
     lookUpConcreteMethod (method: MethodElement2? Function(String, LibraryElement2))
     lookUpInheritedMethod2 (method: MethodElement2? Function({required LibraryElement2 library, required String methodName}))
@@ -4128,6 +4135,19 @@ package:analyzer/dart/element/element2.dart:
     element (getter: MultiplyDefinedElement2)
     nextFragment (getter: Null)
     previousFragment (getter: Null)
+  Name (class extends Object):
+    forElement (static method: Name? Function(Element2))
+    forLibrary (constructor: Name Function(LibraryElement2?, String))
+    new (constructor: Name Function(Uri?, String))
+    forGetter (getter: Name)
+    forSetter (getter: Name)
+    hashCode (getter: int)
+    isPublic (getter: bool)
+    libraryUri (getter: Uri?)
+    name (getter: String)
+    == (method: bool Function(Object))
+    isAccessibleFor (method: bool Function(Uri))
+    toString (method: String Function())
   NamespaceCombinator (see above)
   PartInclude (class extends Object implements ElementDirective):
     new (constructor: PartInclude Function())

pkg/analyzer/lib/dart/element/element2.dart

@@ -64,6 +64,7 @@ import 'package:analyzer/dart/element/type_provider.dart';
 import 'package:analyzer/dart/element/type_system.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source.dart';
+import 'package:analyzer/src/dart/element/inheritance_manager3.dart' show Name;
 import 'package:analyzer/src/dart/resolver/scope.dart';
 import 'package:pub_semver/pub_semver.dart';
 
@@ -81,6 +82,7 @@ export 'package:analyzer/dart/element/element.dart'
         HideElementCombinator,
         NamespaceCombinator,
         ShowElementCombinator;
+export 'package:analyzer/src/dart/element/inheritance_manager3.dart' show Name;
 
 /// An element or fragment that can have either annotations (metadata), a
 /// documentation comment, or both associated with it.
@@ -1345,6 +1347,51 @@ abstract class InterfaceElement2 implements InstanceElement2 {
   @override
   List<InterfaceFragment> get fragments;
 
+  /// Returns a map of all concrete members that this type inherits from
+  /// superclasses and mixins, keyed by the member's [Name].
+  ///
+  /// Members declared in this type have no effect on the map. This means that:
+  /// - If this type contains a member named `foo`, but none of its superclasses
+  ///   or mixins contains a member named `foo`, then there will be no entry for
+  ///   `foo` in the map.
+  /// - If this type contains a member named `foo`, and one of its superclasses
+  ///   or mixins contains a member named `foo`, then there will be an entry for
+  ///   `foo` in this map, pointing to the declaration inherited from the
+  ///   superclass or mixin.
+  ///
+  /// This method is potentially expensive, since it needs to consider all
+  /// possible inherited names. If you only need to look up a certain specific
+  /// name (or names), use [getInheritedConcreteMember] instead.
+  Map<Name, ExecutableElement2> get inheritedConcreteMembers;
+
+  /// Returns a map of all members that this type inherits from supertypes via
+  /// `extends`, `with`, `implements`, or `on` clauses, keyed by the member's
+  /// [Name].
+  ///
+  /// Members declared in this type have no effect on the map. This means that:
+  /// - If this type contains a member named `foo`, but none of its supertypes
+  ///   contains a member named `foo`, then there will be no entry for `foo` in
+  ///   the map.
+  /// - If this type contains a member named `foo`, and one of its supertypes
+  ///   contains a member named `foo`, then there will be an entry for `foo` in
+  ///   this map, pointing to the declaration inherited from the supertype.
+  ///
+  /// This method is potentially expensive, since it needs to consider all
+  /// possible inherited names. If you only need to look up a certain specific
+  /// name (or names), use [getInheritedMember] instead.
+  Map<Name, ExecutableElement2> get inheritedMembers;
+
+  /// Returns a map of all members in the type's interface, keyed by the
+  /// member's [Name].
+  ///
+  /// Note that some names are not declared directly on [thisType], but are
+  /// inherited from supertypes.
+  ///
+  /// This method is potentially expensive, since it needs to consider all
+  /// possible interface names. If you only need to look up a certain specific
+  /// name (or names), use [getInterfaceMember] instead.
+  Map<Name, ExecutableElement2> get interfaceMembers;
+
   /// The interfaces that are implemented by this class.
   ///
   /// <b>Note:</b> Because the element model represents the state of the code,
@@ -1394,9 +1441,63 @@ abstract class InterfaceElement2 implements InstanceElement2 {
   /// constructor will be returned.
   ConstructorElement2? get unnamedConstructor2;
 
+  /// Returns the most specific member with the given [name] that this type
+  /// inherits from a superclass or mixin.
+  ///
+  /// Returns `null` if no member is inherited.
+  ///
+  /// This method is semantically equivalent to calling
+  /// [inheritedConcreteMembers] and then using the `[]` operator, but it
+  /// potentially has better performance, since it does not need to consider all
+  /// possible inherited names.
+  ExecutableElement2? getInheritedConcreteMember(Name name);
+
+  /// Returns the most specific member with the given [name] that this type
+  /// inherits from a supertype via an `extends`, `with`, `implements`, or `on`
+  /// clause.
+  ///
+  /// Returns `null` if no member is inherited because the member is not
+  /// declared at all, or because there is no the most specific signature.
+  ///
+  /// This method is semantically equivalent to calling [inheritedMembers] and
+  /// then using the `[]` operator, but it potentially has better performance,
+  /// since it does not need to consider all possible inherited names.
+  ExecutableElement2? getInheritedMember(Name name);
+
+  /// Returns the most specific member with the given [name] in this type's
+  /// interface.
+  ///
+  /// Returns `null` if there is no member with the given [name] in this type's
+  /// interface, either because the member is not declared at all, or because of
+  /// a conflict between inherited members.
+  ///
+  /// This method is semantically equivalent to calling [interfaceMembers] and
+  /// then using the `[]` operator, but it potentially has better performance,
+  /// since it does not need to consider all possible interface names.
+  ExecutableElement2? getInterfaceMember(Name name);
+
   /// Returns the constructor from [constructors2] that has the given [name].
   ConstructorElement2? getNamedConstructor2(String name);
 
+  /// Returns all members of mixins, superclasses, and interfaces that a member
+  /// with the given [name], defined in this element, would override; or `null`
+  /// if no members would be overridden.
+  ///
+  /// Transitive overrides are not included unless there is a direct path to
+  /// them. For example, if classes `A`, `B`, and `C` are defined as follows:
+  ///
+  ///     class A { void m() {} }
+  ///     class B extends A { void m() {} }
+  ///     class C extends B { void m() {} }
+  ///
+  /// Then a [getOverridden] query for name `m` on class `C` would return just a
+  /// single result: the element for `B.m`.
+  ///
+  /// However, if the example were changed so that `class C` both `extends B`
+  /// *and* `implements A`, then a list containing both `A.m` and `B.m` would be
+  /// returned.
+  List<ExecutableElement2>? getOverridden(Name name);
+
   /// Create the [InterfaceType] for this element with the given
   /// [typeArguments] and [nullabilitySuffix].
   InterfaceType instantiate({

pkg/analyzer/lib/src/dart/element/element.dart

@@ -6778,6 +6778,23 @@ abstract class InterfaceElementImpl2 extends InstanceElementImpl2
     return library2.session.inheritanceManager;
   }
 
+  @override
+  Map<Name, ExecutableElement2> get inheritedConcreteMembers =>
+      (session as AnalysisSessionImpl)
+          .inheritanceManager
+          .getInheritedConcreteMap(this);
+
+  @override
+  Map<Name, ExecutableElement2> get inheritedMembers =>
+      (session as AnalysisSessionImpl).inheritanceManager.getInheritedMap(this);
+
+  @override
+  Map<Name, ExecutableElement2> get interfaceMembers =>
+      (session as AnalysisSessionImpl)
+          .inheritanceManager
+          .getInterface2(this)
+          .map2;
+
   @override
   List<InterfaceTypeImpl> get interfaces => _interfaces;
 
@@ -6847,6 +6864,22 @@ abstract class InterfaceElementImpl2 extends InstanceElementImpl2
   ConstructorElementMixin2? get unnamedConstructor2 =>
       unnamedConstructor?.asElement2;
 
+  @override
+  ExecutableElement2? getInheritedConcreteMember(Name name) =>
+      inheritedConcreteMembers[name];
+
+  @override
+  ExecutableElement2? getInheritedMember(Name name) =>
+      (session as AnalysisSessionImpl)
+          .inheritanceManager
+          .getInherited4(this, name);
+
+  @override
+  ExecutableElement2? getInterfaceMember(Name name) =>
+      (session as AnalysisSessionImpl)
+          .inheritanceManager
+          .getMember4(this, name);
+
   @override
   ConstructorElementMixin? getNamedConstructor(String name) {
     name = name.ifEqualThen('new', '');
@@ -6858,6 +6891,12 @@ abstract class InterfaceElementImpl2 extends InstanceElementImpl2
     return constructors2.firstWhereOrNull((e) => e.name3 == name);
   }
 
+  @override
+  List<ExecutableElement2>? getOverridden(Name name) =>
+      (session as AnalysisSessionImpl)
+          .inheritanceManager
+          .getOverridden4(this, name);
+
   @override
   InterfaceTypeImpl instantiate({
     required List<DartType> typeArguments,

pkg/analyzer/lib/src/dart/element/inheritance_manager3.dart

@@ -4,6 +4,7 @@
 
 // ignore_for_file: analyzer_use_new_elements
 
+import 'package:_fe_analyzer_shared/src/base/analyzer_public_api.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/dart/element/type.dart';
@@ -1316,6 +1317,7 @@ class Interface {
 }
 
 /// A public name, or a private name qualified by a library URI.
+@AnalyzerPublicApi(message: 'Exposed by InterfaceElement2 methods')
 class Name {
   /// If the name is private, the URI of the defining library.
   /// Otherwise, it is `null`.