fix up enum / mixin as well

jcollins-g · jcollins-g · commit 40a85e226c82 · 2021-09-01T13:24:32.000-07:00
diff --git a/lib/src/generator/templates.aot_renderers_for_html.dart b/lib/src/generator/templates.aot_renderers_for_html.dart
diff --git a/lib/src/generator/templates.aot_renderers_for_md.dart b/lib/src/generator/templates.aot_renderers_for_md.dart
diff --git a/lib/src/generator/templates.runtime_renderers.dart b/lib/src/generator/templates.runtime_renderers.dart
@@ -1696,6 +1696,13 @@ class _Renderer_Class extends RendererBase<Class> {
                         parent: r);
                   },
                 ),
+                'hasModifiers': Property(
+                  getValue: (CT_ c) => c.hasModifiers,
+                  renderVariable: (CT_ c, Property<CT_> self,
+                          List<String> remainingNames) =>
+                      self.renderSimpleVariable(c, remainingNames, 'bool'),
+                  getBool: (CT_ c) => c.hasModifiers == true,
+                ),
                 'hasPublicMixedInTypes': Property(
                   getValue: (CT_ c) => c.hasPublicMixedInTypes,
                   renderVariable: (CT_ c, Property<CT_> self,
@@ -4284,7 +4291,20 @@ class _Renderer_Enum extends RendererBase<Enum> {
       _propertyMapCache.putIfAbsent(
           CT_,
           () => {
-                ..._Renderer_Class.propertyMap<CT_>(),
+                ..._Renderer_InheritingContainer.propertyMap<CT_>(),
+                'inheritanceChain': Property(
+                  getValue: (CT_ c) => c.inheritanceChain,
+                  renderVariable: (CT_ c, Property<CT_> self,
+                          List<String> remainingNames) =>
+                      self.renderSimpleVariable(
+                          c, remainingNames, 'List<InheritingContainer>'),
+                  renderIterable: (CT_ c, RendererBase<CT_> r,
+                      List<MustachioNode> ast, StringSink sink) {
+                    return c.inheritanceChain.map((e) =>
+                        _render_InheritingContainer(e, ast, r.template, sink,
+                            parent: r));
+                  },
+                ),
                 'kind': Property(
                   getValue: (CT_ c) => c.kind,
                   renderVariable:
@@ -4515,13 +4535,6 @@ class _Renderer_Extension extends RendererBase<Extension> {
                         parent: r);
                   },
                 ),
-                'hasPublicConstructors': Property(
-                  getValue: (CT_ c) => c.hasPublicConstructors,
-                  renderVariable: (CT_ c, Property<CT_> self,
-                          List<String> remainingNames) =>
-                      self.renderSimpleVariable(c, remainingNames, 'bool'),
-                  getBool: (CT_ c) => c.hasPublicConstructors == true,
-                ),
                 'href': Property(
                   getValue: (CT_ c) => c.href,
                   renderVariable:
@@ -4579,19 +4592,6 @@ class _Renderer_Extension extends RendererBase<Extension> {
                     _render_String(c.name, ast, r.template, sink, parent: r);
                   },
                 ),
-                'publicConstructorsSorted': Property(
-                  getValue: (CT_ c) => c.publicConstructorsSorted,
-                  renderVariable: (CT_ c, Property<CT_> self,
-                          List<String> remainingNames) =>
-                      self.renderSimpleVariable(
-                          c, remainingNames, 'Iterable<Constructor>'),
-                  renderIterable: (CT_ c, RendererBase<CT_> r,
-                      List<MustachioNode> ast, StringSink sink) {
-                    return c.publicConstructorsSorted.map((e) =>
-                        _render_Constructor(e, ast, r.template, sink,
-                            parent: r));
-                  },
-                ),
                 'referenceChildren': Property(
                   getValue: (CT_ c) => c.referenceChildren,
                   renderVariable: (CT_ c, Property<CT_> self,
@@ -13346,11 +13346,11 @@ class _Renderer_TopLevelContainer extends RendererBase<TopLevelContainer> {
                   renderVariable: (CT_ c, Property<CT_> self,
                           List<String> remainingNames) =>
                       self.renderSimpleVariable(
-                          c, remainingNames, 'Iterable<Class>'),
+                          c, remainingNames, 'Iterable<Container>'),
                   renderIterable: (CT_ c, RendererBase<CT_> r,
                       List<MustachioNode> ast, StringSink sink) {
                     return c.publicClassesSorted.map((e) =>
-                        _render_Class(e, ast, r.template, sink, parent: r));
+                        _render_Container(e, ast, r.template, sink, parent: r));
                   },
                 ),
                 'publicConstants': Property(
diff --git a/lib/src/model/class.dart b/lib/src/model/class.dart
@@ -214,13 +214,13 @@ class Class extends InheritingContainer with Constructable {
   @override
   String get kind => 'class';
 
+  List<InheritingContainer> _inheritanceChain;
+
   /// Not the same as superChain as it may include mixins.
   /// It's really not even the same as ordinary Dart inheritance, either,
   /// because we pretend that interfaces are part of the inheritance chain
   /// to include them in the set of things we might link to for documentation
   /// purposes in abstract classes.
-  List<InheritingContainer> _inheritanceChain;
-
   @override
   List<InheritingContainer> get inheritanceChain {
     if (_inheritanceChain == null) {
diff --git a/lib/src/model/enum.dart b/lib/src/model/enum.dart
@@ -7,10 +7,26 @@ import 'package:analyzer/dart/element/element.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:dartdoc/src/render/enum_field_renderer.dart';
 
-class Enum extends Class {
+class Enum extends InheritingContainer {
   Enum(ClassElement element, Library library, PackageGraph packageGraph)
       : super(element, library, packageGraph);
 
+  List<InheritingContainer> _inheritanceChain;
+
+  @override
+  List<InheritingContainer> get inheritanceChain {
+    if (_inheritanceChain == null) {
+      _inheritanceChain = [];
+      _inheritanceChain.add(this);
+
+      for (var c
+          in superChain.map((e) => (e.modelElement as InheritingContainer))) {
+        _inheritanceChain.addAll(c.inheritanceChain);
+      }
+    }
+    return _inheritanceChain.toList(growable: false);
+  }
+
   @override
   String get kind => 'enum';
 }
@@ -64,7 +80,7 @@ class EnumField extends Field {
     assert(!(canonicalLibrary == null || canonicalEnclosingContainer == null));
     assert(canonicalLibrary == library);
     assert(canonicalEnclosingContainer == enclosingElement);
-    return '${package.baseHref}${enclosingElement.library.dirName}/${(enclosingElement as Class).fileName}';
+    return '${package.baseHref}${enclosingElement.library.dirName}/${enclosingElement.fileName}';
   }
 
   @override
diff --git a/lib/src/model/extension.dart b/lib/src/model/extension.dart
@@ -127,10 +127,4 @@ class Extension extends Container implements EnclosedElement {
       ...super.referenceChildren,
     };
   }
-
-  @override
-  bool get hasPublicConstructors => false;
-
-  @override
-  Iterable<Constructor> get publicConstructorsSorted => [];
 }
diff --git a/lib/src/model/field.dart b/lib/src/model/field.dart
@@ -56,7 +56,7 @@ class Field extends ModelElement
   }
 
   @override
-  ModelElement get enclosingElement {
+  Container get enclosingElement {
     _enclosingContainer ??=
         ModelElement.from(field.enclosingElement, library, packageGraph);
     return _enclosingContainer;
diff --git a/lib/src/model/inheriting_container.dart b/lib/src/model/inheriting_container.dart
@@ -289,11 +289,9 @@ abstract class InheritingContainer extends Container
           // [packageGraph.specialClasses] is not available yet.
           bool _isDartCoreObject(ClassElement e) =>
               e.name == 'Object' && e.library.name == 'dart.core';
-          if (!(inheritanceChainElements
+          assert(inheritanceChainElements
                   .contains(imap[nameObj].enclosingElement) ||
-              _isDartCoreObject(imap[nameObj].enclosingElement))) {
-            print('wtf');
-          }
+              _isDartCoreObject(imap[nameObj].enclosingElement));
 
           // If the concrete object from [InheritanceManager3.getInheritedConcreteMap2]
           // is farther from this class in the inheritance chain than the one
diff --git a/lib/src/model/top_level_container.dart b/lib/src/model/top_level_container.dart
@@ -51,7 +51,10 @@ abstract class TopLevelContainer implements Nameable {
   Iterable<Class> get publicClasses => model_utils.filterNonPublic(classes);
 
   List<Class> _publicClassesSorted;
-  Iterable<Class> get publicClassesSorted =>
+  // TODO(jcollins-g):  Setting this type parameter to `Container` magically
+  // fixes a number of type problems in the AOT compiler, but I am mystified as
+  // to why that should be the case.
+  Iterable<Container> get publicClassesSorted =>
       _publicClassesSorted ??= publicClasses.toList()..sort(byName);
 
   Iterable<Extension> get publicExtensions =>
diff --git a/lib/templates/html/_container.html b/lib/templates/html/_container.html
diff --git a/lib/templates/html/_mixin.html b/lib/templates/html/_mixin.html
diff --git a/lib/templates/html/category.html b/lib/templates/html/category.html
@@ -23,7 +23,7 @@ <h2>Classes</h2>
 
     <dl>
       {{#publicClassesSorted}}
-      {{>class}}
+      {{>container}}
       {{/publicClassesSorted}}
     </dl>
   </section>
@@ -35,7 +35,7 @@ <h2>Mixins</h2>
 
     <dl>
       {{#publicMixinsSorted}}
-      {{>mixin}}
+      {{>container}}
       {{/publicMixinsSorted}}
     </dl>
   </section>
@@ -83,7 +83,7 @@ <h2>Enums</h2>
 
     <dl>
       {{#publicEnumsSorted}}
-      {{>class}}
+      {{>container}}
       {{/publicEnumsSorted}}
     </dl>
   </section>
@@ -107,7 +107,7 @@ <h2>Exceptions / Errors</h2>
 
     <dl>
       {{#publicExceptionsSorted}}
-      {{>class}}
+      {{>container}}
       {{/publicExceptionsSorted}}
     </dl>
   </section>
diff --git a/lib/templates/html/enum.html b/lib/templates/html/enum.html
@@ -33,15 +33,6 @@
         </dd>
         {{/hasPublicInterfaces}}
 
-        {{#hasPublicMixedInTypes}}
-        <dt>Mixed in types</dt>
-        <dd><ul class="comma-separated eNum-relationships">
-          {{#publicMixedInTypes}}
-          <li>{{{linkedName}}}</li>
-          {{/publicMixedInTypes}}
-        </ul></dd>
-        {{/hasPublicMixedInTypes}}
-
         {{#hasPublicImplementors}}
         <dt>Implementers</dt>
         <dd><ul class="comma-separated eNum-relationships">
@@ -75,29 +66,6 @@ <h2>Constants</h2>
     </section>
     {{/hasPublicConstantFields}}
 
-    {{#hasPublicConstructors}}
-    <section class="summary offset-anchor" id="constructors">
-      <h2>Constructors</h2>
-
-      <dl class="constructor-summary-list">
-        {{#publicConstructorsSorted}}
-        <dt id="{{htmlId}}" class="callable">
-          <span class="name">{{{linkedName}}}</span><span class="signature">({{{ linkedParams }}})</span>
-        </dt>
-        <dd>
-          {{{ oneLineDoc }}} {{{ extendedDocLink }}}
-          {{#isConst}}
-          <div class="constructor-modifier features">const</div>
-          {{/isConst}}
-          {{#isFactory}}
-          <div class="constructor-modifier features">factory</div>
-          {{/isFactory}}
-        </dd>
-        {{/publicConstructorsSorted}}
-      </dl>
-    </section>
-    {{/hasPublicConstructors}}
-
     {{#hasPublicInstanceFields}}
     <section class="summary offset-anchor{{ #publicInheritedInstanceFields }} inherited{{ /publicInheritedInstanceFields }}" id="instance-properties">
       <h2>Properties</h2>
diff --git a/lib/templates/html/library.html b/lib/templates/html/library.html
@@ -15,7 +15,7 @@ <h2>Classes</h2>
 
       <dl>
         {{#library.publicClassesSorted}}
-        {{>class}}
+        {{>container}}
         {{/library.publicClassesSorted}}
       </dl>
     </section>
@@ -27,7 +27,7 @@ <h2>Mixins</h2>
 
       <dl>
         {{#library.publicMixinsSorted}}
-        {{>mixin}}
+        {{>container}}
         {{/library.publicMixinsSorted}}
       </dl>
     </section>
@@ -87,7 +87,7 @@ <h2>Enums</h2>
 
       <dl>
         {{#library.publicEnumsSorted}}
-        {{>class}}
+        {{>container}}
         {{/library.publicEnumsSorted}}
       </dl>
     </section>
@@ -111,7 +111,7 @@ <h2>Exceptions / Errors</h2>
 
       <dl>
         {{#library.publicExceptionsSorted}}
-        {{>class}}
+        {{>container}}
         {{/library.publicExceptionsSorted}}
       </dl>
     </section>
diff --git a/lib/templates/md/_container.md b/lib/templates/md/_container.md
diff --git a/lib/templates/md/category.md b/lib/templates/md/category.md
@@ -18,7 +18,7 @@
 ## Classes
 
 {{#publicClassesSorted}}
-{{>class}}
+{{>container}}
 
 {{/publicClassesSorted}}
 {{/hasPublicClasses}}
@@ -27,7 +27,7 @@
 ## Mixins
 
 {{#publicMixinsSorted}}
-{{>mixin}}
+{{>container}}
 
 {{/publicMixinsSorted}}
 {{/hasPublicMixins}}
@@ -63,7 +63,7 @@
 ## Enums
 
 {{#publicEnumsSorted}}
-{{>class}}
+{{>container}}
 
 {{/publicEnumsSorted}}
 {{/hasPublicEnums}}
@@ -81,7 +81,7 @@
 ## Exceptions / Errors
 
 {{#publicExceptionsSorted}}
-{{>class}}
+{{>container}}
 
 {{/publicExceptionsSorted}}
 {{/hasPublicExceptions}}
diff --git a/lib/templates/md/enum.md b/lib/templates/md/enum.md
@@ -29,14 +29,6 @@
 {{/publicInterfaces}}
 {{/hasPublicInterfaces}}
 
-{{#hasPublicMixedInTypes}}
-**Mixed in types**
-
-{{#publicMixedInTypes}}
-- {{{linkedName}}}
-{{/publicMixedInTypes}}
-{{/hasPublicMixedInTypes}}
-
 {{#hasPublicImplementors}}
 **Implementers**
 
@@ -63,18 +55,6 @@
 {{/publicConstantFieldsSorted}}
 {{/hasPublicConstantFields}}
 
-{{#hasPublicConstructors}}
-## Constructors
-
-{{#publicConstructorsSorted}}
-{{{linkedName}}}({{{ linkedParams }}})
-
-{{{ oneLineDoc }}} {{{ extendedDocLink }}}  {{!two spaces intentional}}
-{{#isConst}}_const_{{/isConst}} {{#isFactory}}_factory_{{/isFactory}}
-
-{{/publicConstructorsSorted}}
-{{/hasPublicConstructors}}
-
 {{#hasPublicInstanceFields}}
 ## Properties
 
diff --git a/lib/templates/md/library.md b/lib/templates/md/library.md

Original file line number	Diff line number	Diff line change
`@@ -127,10 +127,4 @@ class Extension extends Container implements EnclosedElement {`
`127`	`127`	`...super.referenceChildren,`
`128`	`128`	`};`
`129`	`129`	`}`
`130`		`-`
`131`		`- @override`
`132`		`- bool get hasPublicConstructors => false;`
`133`		`-`
`134`		`- @override`
`135`		`- Iterable<Constructor> get publicConstructorsSorted => [];`
`136`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class Field extends ModelElement`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@override`
`59`		`- ModelElement get enclosingElement {`
	`59`	`+ Container get enclosingElement {`
`60`	`60`	`_enclosingContainer ??=`
`61`	`61`	`ModelElement.from(field.enclosingElement, library, packageGraph);`
`62`	`62`	`return _enclosingContainer;`