lib/src/model/class.dart

// Copyright (c) 2019, 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.

import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/dart/element/element2.dart';
// ignore: implementation_imports
import 'package:analyzer/src/utilities/extensions/element.dart';
import 'package:dartdoc/src/model/kind.dart';
import 'package:dartdoc/src/model/model.dart';

/// A [Container] defined with a `class` declaration.
///
/// Members follow similar naming rules to [Container], with the following
/// additions:
///
/// **instance**: As with [Container], but also includes inherited children.
/// **inherited**: Filtered getters giving only inherited children.
class Class extends InheritingContainer with Constructable, MixedInTypes {
  @override
  // ignore: analyzer_use_new_elements
  ClassElement get element => element2.asElement;

  @override
  final ClassElement2 element2;

  @override
  late final List<ModelElement> allModelElements = [
    ...super.allModelElements,
    ...constructors,
  ];

  @override
  String get sidebarPath =>
      '${canonicalLibraryOrThrow.dirName}/$name-class-sidebar.html';

  @override
  late final List<InheritingContainer> inheritanceChain = [
    this,

    // Caching should make this recursion a little less painful.
    for (var container in mixedInTypes.modelElements.reversed)
      ...container.inheritanceChain,

    for (var container in superChain.modelElements)
      ...container.inheritanceChain,

    // Interfaces need to come last, because classes in the superChain might
    // implement them even when they aren't mentioned.
    ...interfaceElements.expandInheritanceChain,
  ];

  Class(this.element2, Library library, PackageGraph packageGraph)
      : super(library, packageGraph) {
    if (element2.name3 == 'Object' &&
        library.element2.name3 == 'dart.core' &&
        package.name == 'Dart') {
      packageGraph.objectClass = this;
    }
  }

  @override
  String get fileName => '$name-class.html';

  @override
  bool get isAbstract => element2.isAbstract;

  @override
  bool get isBase => element2.isBase && !element2.isSealed;

  bool get isErrorOrException {
    bool isError(InterfaceElement2 e) =>
        e.library2.isDartCore && (e.name3 == 'Exception' || e.name3 == 'Error');

    if (isError(element2)) return true;
    return element2.allSupertypes.map((t) => t.element3).any(isError);
  }

  @override
  bool get isFinal => element2.isFinal && !element2.isSealed;

  @override
  bool get isImplementableInterface =>
      element2.isInterface && !element2.isSealed;

  @override
  bool get isMixinClass => element2.isMixinClass;

  @override
  bool get isSealed => element2.isSealed;

  @override
  Kind get kind => Kind.class_;

  @override
  String get relationshipsClass => 'clazz-relationships';
}