Rename Library.allClasses; tidy other collections (#3747)

Author: srawlins

lib/src/element_type.dart

@@ -10,6 +10,7 @@ library;
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/nullability_suffix.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:analyzer/dart/element/type_system.dart';
 import 'package:dartdoc/src/model/comment_referable.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:dartdoc/src/render/element_type_renderer.dart';
@@ -305,6 +306,8 @@ abstract class DefinedElementType extends ElementType {
     return canonicalClass.isPublic;
   }
 
+  TypeSystem get _typeSystem => library.element.typeSystem;
+
   DartType get _bound => type;
 
   /// This type, instantiated to bounds if it isn't already.
@@ -313,7 +316,7 @@ abstract class DefinedElementType extends ElementType {
     final bound = _bound;
     if (bound is InterfaceType &&
         !bound.typeArguments.every((t) => t is InterfaceType)) {
-      return library.typeSystem.instantiateInterfaceToBounds(
+      return _typeSystem.instantiateInterfaceToBounds(
           element: bound.element, nullabilitySuffix: _bound.nullabilitySuffix);
     } else {
       return _bound;
@@ -324,7 +327,7 @@ abstract class DefinedElementType extends ElementType {
   /// of [type].
   @override
   bool isSubtypeOf(ElementType type) =>
-      library.typeSystem.isSubtypeOf(instantiatedType, type.instantiatedType);
+      _typeSystem.isSubtypeOf(instantiatedType, type.instantiatedType);
 
   /// Whether at least one supertype (including via mixins and interfaces) is
   /// equivalent to or a subtype of `this` when instantiated to bounds.
@@ -334,7 +337,7 @@ abstract class DefinedElementType extends ElementType {
     if (type is InterfaceType) {
       var superTypes = type.allSupertypes;
       for (var superType in superTypes) {
-        if (library.typeSystem.isSubtypeOf(superType, instantiatedType)) {
+        if (_typeSystem.isSubtypeOf(superType, instantiatedType)) {
           return true;
         }
       }

lib/src/generator/generator_frontend.dart

@@ -164,7 +164,7 @@ class GeneratorFrontEnd implements Generator {
         indexAccumulator.add(lib);
         _generatorBackend.generateLibrary(packageGraph, lib);
 
-        for (var class_ in lib.allClasses.whereDocumented) {
+        for (var class_ in lib.classesAndExceptions.whereDocumented) {
           indexAccumulator.add(class_);
           _generatorBackend.generateClass(packageGraph, lib, class_);
 

lib/src/generator/templates.runtime_renderers.dart

@@ -8093,18 +8093,6 @@ class _Renderer_Library extends RendererBase<Library> {
                         parent: r);
                   },
                 ),
-                'allClasses': Property(
-                  getValue: (CT_ c) => c.allClasses,
-                  renderVariable: (CT_ c, Property<CT_> self,
-                          List<String> remainingNames) =>
-                      self.renderSimpleVariable(
-                          c, remainingNames, 'List<Class>'),
-                  renderIterable: (CT_ c, RendererBase<CT_> r,
-                      List<MustachioNode> ast, StringSink sink) {
-                    return c.allClasses.map((e) =>
-                        _render_Class(e, ast, r.template, sink, parent: r));
-                  },
-                ),
                 'allModelElements': Property(
                   getValue: (CT_ c) => c.allModelElements,
                   renderVariable: (CT_ c, Property<CT_> self,
@@ -8188,6 +8176,18 @@ class _Renderer_Library extends RendererBase<Library> {
                         _render_Class(e, ast, r.template, sink, parent: r));
                   },
                 ),
+                'classesAndExceptions': Property(
+                  getValue: (CT_ c) => c.classesAndExceptions,
+                  renderVariable: (CT_ c, Property<CT_> self,
+                          List<String> remainingNames) =>
+                      self.renderSimpleVariable(
+                          c, remainingNames, 'List<Class>'),
+                  renderIterable: (CT_ c, RendererBase<CT_> r,
+                      List<MustachioNode> ast, StringSink sink) {
+                    return c.classesAndExceptions.map((e) =>
+                        _render_Class(e, ast, r.template, sink, parent: r));
+                  },
+                ),
                 'compilationUnitElement': Property(
                   getValue: (CT_ c) => c.compilationUnitElement,
                   renderVariable: (CT_ c, Property<CT_> self,
@@ -8655,19 +8655,6 @@ class _Renderer_Library extends RendererBase<Library> {
                         parent: r);
                   },
                 ),
-                'typeSystem': Property(
-                  getValue: (CT_ c) => c.typeSystem,
-                  renderVariable: (CT_ c, Property<CT_> self,
-                          List<String> remainingNames) =>
-                      self.renderSimpleVariable(
-                          c, remainingNames, 'TypeSystem'),
-                  isNullValue: (CT_ c) => false,
-                  renderValue: (CT_ c, RendererBase<CT_> r,
-                      List<MustachioNode> ast, StringSink sink) {
-                    renderSimple(c.typeSystem, ast, r.template, sink,
-                        parent: r, getters: _invisibleGetters['TypeSystem']!);
-                  },
-                ),
                 'typedefs': Property(
                   getValue: (CT_ c) => c.typedefs,
                   renderVariable: (CT_ c, Property<CT_> self,
@@ -12435,7 +12422,7 @@ class _Renderer_Package extends RendererBase<Package> {
   }
 }
 
-String renderSearchPage(PackageTemplateData context, Template template) {
+String renderError(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
@@ -12673,13 +12660,13 @@ class _Renderer_PackageTemplateData extends RendererBase<PackageTemplateData> {
   }
 }
 
-String renderIndex(PackageTemplateData context, Template template) {
+String renderSearchPage(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
 }
 
-String renderError(PackageTemplateData context, Template template) {
+String renderIndex(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
@@ -16690,7 +16677,6 @@ const _invisibleGetters = {
     'name',
     'runtimeType'
   },
-  'TypeSystem': {'hashCode', 'runtimeType'},
   'int': {
     'bitLength',
     'hashCode',

lib/src/model/library.dart

@@ -6,7 +6,6 @@ import 'dart:collection';
 
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/scope.dart';
-import 'package:analyzer/dart/element/type_system.dart';
 import 'package:analyzer/source/line_info.dart';
 // ignore: implementation_imports
 import 'package:analyzer/src/generated/sdk.dart' show SdkLibrary;
@@ -58,7 +57,7 @@ class Library extends ModelElement
       // Initialize the list of elements defined in this library and
       // exported via its export directives.
       ...element.exportNamespace.definedNames.values,
-      // TODO(jcollins-g): Consider switch to [_libraryElement.topLevelElements].
+      // TODO(jcollins-g): Consider switch to `element.topLevelElements`.
       ..._getDefinedElements(element.definingCompilationUnit),
       ...element.parts
           .map((e) => e.uri)
@@ -110,21 +109,6 @@ class Library extends ModelElement
   CompilationUnitElement get compilationUnitElement =>
       element.definingCompilationUnit;
 
-  @override
-  Iterable<Class> get classes => allClasses.where((c) => !c.isErrorOrException);
-
-  @override
-  late final List<Extension> extensions = _exportedAndLocalElements
-      .whereType<ExtensionElement>()
-      .map((e) => getModelFor(e, this) as Extension)
-      .toList(growable: false);
-
-  @override
-  late final List<ExtensionType> extensionTypes = _exportedAndLocalElements
-      .whereType<ExtensionTypeElement>()
-      .map((e) => getModelFor(e, this) as ExtensionType)
-      .toList(growable: false);
-
   SdkLibrary? get _sdkLib =>
       packageGraph.sdkLibrarySources[element.librarySource];
 
@@ -144,10 +128,6 @@ class Library extends ModelElement
     return true;
   }
 
-  @override
-  Iterable<TopLevelVariable> get constants =>
-      _variables.where((v) => v.isConst);
-
   /// Map of each import prefix ('import "foo" as prefix;') to the set of
   /// libraries which are imported via that prefix.
   Map<String, Set<Library>> get _prefixToLibrary {
@@ -203,22 +183,6 @@ class Library extends ModelElement
   @override
   ModelElement? get enclosingElement => null;
 
-  @override
-  late final List<Enum> enums = _exportedAndLocalElements
-      .whereType<EnumElement>()
-      .map((e) => getModelFor(e, this) as Enum)
-      .toList(growable: false);
-
-  @override
-  late final List<Mixin> mixins = _exportedAndLocalElements
-      .whereType<MixinElement>()
-      .map((e) => getModelFor(e, this) as Mixin)
-      .toList(growable: false);
-
-  @override
-  late final List<Class> exceptions =
-      allClasses.where((c) => c.isErrorOrException).toList(growable: false);
-
   @override
   String get filePath => '${library.dirName}/$fileName';
 
@@ -235,12 +199,6 @@ class Library extends ModelElement
   @override
   String get belowSidebarPath => sidebarPath;
 
-  @override
-  late final List<ModelFunction> functions = _exportedAndLocalElements
-      .whereType<FunctionElement>()
-      .map((e) => getModelFor(e, this) as ModelFunction)
-      .toList(growable: false);
-
   @override
   String? get href {
     if (!identical(canonicalModelElement, this)) {
@@ -328,30 +286,62 @@ class Library extends ModelElement
   late final PackageMeta? packageMeta =
       packageGraph.packageMetaProvider.fromElement(element, config.sdkDir);
 
-  /// All variables ("properties") except constants.
+  late final List<Class> classesAndExceptions =
+      _elementsOfType<ClassElement, Class>();
+
   @override
-  late final List<TopLevelVariable> properties =
-      _variables.where((v) => !v.isConst).toList(growable: false);
+  Iterable<Class> get classes =>
+      classesAndExceptions.where((c) => !c.isErrorOrException);
 
   @override
-  late final List<Typedef> typedefs = _exportedAndLocalElements
-      .whereType<TypeAliasElement>()
-      .map((e) => packageGraph.getModelFor(e, this) as Typedef)
-      .toList(growable: false);
+  Iterable<TopLevelVariable> get constants =>
+      _variables.where((v) => v.isConst);
 
-  TypeSystem get typeSystem => element.typeSystem;
+  @override
+  late final List<Enum> enums = _elementsOfType<EnumElement, Enum>();
 
-  late final List<Class> allClasses = _exportedAndLocalElements
-      .whereType<ClassElement>()
-      .map((e) => packageGraph.getModelFor(e, this) as Class)
+  @override
+  late final List<Class> exceptions = classesAndExceptions
+      .where((c) => c.isErrorOrException)
       .toList(growable: false);
 
+  @override
+  late final List<Extension> extensions =
+      _elementsOfType<ExtensionElement, Extension>();
+
+  @override
+  late final List<ExtensionType> extensionTypes =
+      _elementsOfType<ExtensionTypeElement, ExtensionType>();
+
+  @override
+  late final List<ModelFunction> functions =
+      _elementsOfType<FunctionElement, ModelFunction>();
+
+  @override
+  late final List<Mixin> mixins = _elementsOfType<MixinElement, Mixin>();
+
+  @override
+  late final List<TopLevelVariable> properties =
+      _variables.where((v) => !v.isConst).toList(growable: false);
+
+  @override
+  late final List<Typedef> typedefs =
+      _elementsOfType<TypeAliasElement, Typedef>();
+
+  List<U> _elementsOfType<T extends Element, U extends ModelElement>() =>
+      _exportedAndLocalElements
+          .whereType<T>()
+          .map((e) => packageGraph.getModelFor(e, this) as U)
+          .toList(growable: false);
+
+  /// All top-level variables, including "properties" and constants.
   List<TopLevelVariable> get _variables {
-    var elements =
-        _exportedAndLocalElements.whereType<TopLevelVariableElement>().toSet();
-    elements.addAll(_exportedAndLocalElements
-        .whereType<PropertyAccessorElement>()
-        .map((a) => a.variable as TopLevelVariableElement));
+    var elements = {
+      ..._exportedAndLocalElements.whereType<TopLevelVariableElement>(),
+      ..._exportedAndLocalElements
+          .whereType<PropertyAccessorElement>()
+          .map((a) => a.variable as TopLevelVariableElement)
+    };
     var variables = <TopLevelVariable>[];
     for (var element in elements) {
       Accessor? getter;
@@ -378,15 +368,15 @@ class Library extends ModelElement
   late final HashMap<Element, Set<ModelElement>> modelElementsMap = () {
     var modelElements = HashMap<Element, Set<ModelElement>>();
     for (var modelElement in <ModelElement>[
-      ...library.constants,
-      ...library.functions,
-      ...library.properties,
-      ...library.typedefs,
-      ...library.extensions.expand((e) => [e, ...e.allModelElements]),
-      ...library.extensionTypes.expand((e) => [e, ...e.allModelElements]),
-      ...library.allClasses.expand((c) => [c, ...c.allModelElements]),
-      ...library.enums.expand((e) => [e, ...e.allModelElements]),
-      ...library.mixins.expand((m) => [m, ...m.allModelElements]),
+      ...constants,
+      ...functions,
+      ...properties,
+      ...typedefs,
+      ...extensions.expand((e) => [e, ...e.allModelElements]),
+      ...extensionTypes.expand((e) => [e, ...e.allModelElements]),
+      ...classesAndExceptions.expand((c) => [c, ...c.allModelElements]),
+      ...enums.expand((e) => [e, ...e.allModelElements]),
+      ...mixins.expand((m) => [m, ...m.allModelElements]),
     ]) {
       modelElements
           .putIfAbsent(modelElement.element, () => {})
@@ -454,7 +444,7 @@ class Library extends ModelElement
     var libraryMembers = [
       ...library.extensions,
       ...library.extensionTypes,
-      ...library.allClasses,
+      ...library.classesAndExceptions,
       ...library.enums,
       ...library.mixins,
       ...library.constants,

lib/src/model/package.dart

@@ -294,7 +294,7 @@ class Package extends LibraryContainer
         addToCategories(
             extensionType, (c) => c.extensionTypes.add(extensionType));
       }
-      for (var class_ in library.allClasses) {
+      for (var class_ in library.classesAndExceptions) {
         addToCategories(class_, (c) => c.addClass(class_));
       }
       for (var enum_ in library.enums) {

lib/src/model/package_graph.dart

@@ -151,7 +151,7 @@ class PackageGraph with CommentReferable, Nameable {
     // all packages are picked up.
     for (var package in _documentedPackages) {
       for (var library in package.libraries) {
-        _addToImplementers(library.allClasses);
+        _addToImplementers(library.classesAndExceptions);
         _addToImplementers(library.mixins);
         _addToImplementers(library.extensionTypes);
         _extensions.addAll(library.extensions);
@@ -645,7 +645,7 @@ class PackageGraph with CommentReferable, Nameable {
   /// The String name representing the `Object` type.
   late final String dartCoreObject = libraries
           .firstWhereOrNull((library) => library.name == 'dart:core')
-          ?.allClasses
+          ?.classes
           .firstWhereOrNull((c) => c.name == 'Object')
           ?.linkedName ??
       'Object';

lib/src/model/top_level_container.dart

@@ -12,8 +12,12 @@ import 'package:dartdoc/src/model_utils.dart' as model_utils;
 /// Do not call any methods or members excepting [name] and the private Lists
 /// below before finishing initialization of a [TopLevelContainer].
 mixin TopLevelContainer implements Nameable {
+  /// All top-level classes except those that subtype [Error] or [Exception].
   Iterable<Class> get classes;
 
+  /// All classes that subtype [Error] or [Exception].
+  Iterable<Class> get exceptions;
+
   Iterable<Extension> get extensions;
 
   Iterable<ExtensionType> get extensionTypes;
@@ -22,10 +26,10 @@ mixin TopLevelContainer implements Nameable {
 
   Iterable<Mixin> get mixins;
 
-  Iterable<Class> get exceptions;
-
+  /// All top-level constants.
   Iterable<TopLevelVariable> get constants;
 
+  /// All top-level variables ("properties") except constants.
   Iterable<TopLevelVariable> get properties;
 
   Iterable<ModelFunction> get functions;