Skip to content

Migrate element_type to nnbd #2834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 96 additions & 103 deletions lib/src/element_type.dart

Large diffs are not rendered by default.

73 changes: 63 additions & 10 deletions lib/src/generator/templates.runtime_renderers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1883,16 +1883,26 @@ class _Renderer_CommentReferable extends RendererBase<CommentReferable> {
_propertyMapCache.putIfAbsent(
CT_,
() => {
'element': Property(
getValue: (CT_ c) => c.element,
renderVariable: (CT_ c, Property<CT_> self,
List<String> remainingNames) =>
self.renderSimpleVariable(c, remainingNames, 'Element'),
isNullValue: (CT_ c) => c.element == null,
'definingCommentReferable': Property(
getValue: (CT_ c) => c.definingCommentReferable,
renderVariable:
(CT_ c, Property<CT_> self, List<String> remainingNames) {
if (remainingNames.isEmpty) {
return self.getValue(c).toString();
}
var name = remainingNames.first;
var nextProperty =
_Renderer_CommentReferable.propertyMap().getValue(name);
return nextProperty.renderVariable(self.getValue(c),
nextProperty, [...remainingNames.skip(1)]);
},
isNullValue: (CT_ c) => c.definingCommentReferable == null,
renderValue: (CT_ c, RendererBase<CT_> r,
List<MustachioNode> ast, StringSink sink) {
renderSimple(c.element, ast, r.template, sink,
parent: r, getters: _invisibleGetters['Element']);
renderSimple(
c.definingCommentReferable, ast, r.template, sink,
parent: r,
getters: _invisibleGetters['CommentReferable']);
},
),
'href': Property(
Expand Down Expand Up @@ -3556,6 +3566,28 @@ class _Renderer_DefinedElementType extends RendererBase<DefinedElementType> {
CT_,
() => {
..._Renderer_ElementType.propertyMap<CT_>(),
'definingCommentReferable': Property(
getValue: (CT_ c) => c.definingCommentReferable,
renderVariable:
(CT_ c, Property<CT_> self, List<String> remainingNames) {
if (remainingNames.isEmpty) {
return self.getValue(c).toString();
}
var name = remainingNames.first;
var nextProperty =
_Renderer_CommentReferable.propertyMap().getValue(name);
return nextProperty.renderVariable(self.getValue(c),
nextProperty, [...remainingNames.skip(1)]);
},
isNullValue: (CT_ c) => c.definingCommentReferable == null,
renderValue: (CT_ c, RendererBase<CT_> r,
List<MustachioNode> ast, StringSink sink) {
renderSimple(
c.definingCommentReferable, ast, r.template, sink,
parent: r,
getters: _invisibleGetters['CommentReferable']);
},
),
'element': Property(
getValue: (CT_ c) => c.element,
renderVariable: (CT_ c, Property<CT_> self,
Expand Down Expand Up @@ -9511,6 +9543,28 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
getters: _invisibleGetters['DartdocOptionContext']);
},
),
'definingCommentReferable': Property(
getValue: (CT_ c) => c.definingCommentReferable,
renderVariable:
(CT_ c, Property<CT_> self, List<String> remainingNames) {
if (remainingNames.isEmpty) {
return self.getValue(c).toString();
}
var name = remainingNames.first;
var nextProperty =
_Renderer_CommentReferable.propertyMap().getValue(name);
return nextProperty.renderVariable(self.getValue(c),
nextProperty, [...remainingNames.skip(1)]);
},
isNullValue: (CT_ c) => c.definingCommentReferable == null,
renderValue: (CT_ c, RendererBase<CT_> r,
List<MustachioNode> ast, StringSink sink) {
renderSimple(
c.definingCommentReferable, ast, r.template, sink,
parent: r,
getters: _invisibleGetters['CommentReferable']);
},
),
'definingLibrary': Property(
getValue: (CT_ c) => c.definingLibrary,
renderVariable:
Expand Down Expand Up @@ -15177,7 +15231,7 @@ const _invisibleGetters = {
'referenceGrandparentOverrides',
'referenceName',
'library',
'element'
'definingCommentReferable'
},
'CompilationUnitElement': {
'hashCode',
Expand Down Expand Up @@ -15672,7 +15726,6 @@ const _invisibleGetters = {
'sdk',
'allLibrariesAdded',
'name',
'element',
'implementors',
'documentedExtensions',
'extensions',
Expand Down
7 changes: 5 additions & 2 deletions lib/src/model/comment_referable.dart
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,9 @@ mixin CommentReferable implements Nameable, ModelBuilderInterface {
// TODO(jcollins-g): Eliminate need for this in markdown_processor.
Library? get library => null;

// TODO(jcollins-g): Eliminate need for this in markdown_processor.
Element? get element;
@internal

/// For testing / comparison only, get the comment referable from where this
/// [ElementType] was defined. Override where an [Element] is available.
CommentReferable get definingCommentReferable => this;
}
6 changes: 6 additions & 0 deletions lib/src/model/model_element.dart
Original file line number Diff line number Diff line change
Expand Up @@ -996,4 +996,10 @@ abstract class ModelElement extends Canonicalization

return modelElementRenderer.renderLinkedName(this);
}

@internal
@override
CommentReferable get definingCommentReferable => element == null
? super.definingCommentReferable
: modelBuilder.fromElement(element);
}
3 changes: 0 additions & 3 deletions lib/src/model/package_graph.dart
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ class PackageGraph with CommentReferable, Nameable, ModelBuilder {
@override
String get name => null;

@override
Element get element => null;

/// Call during initialization to add a library to this [PackageGraph].
///
/// Libraries added in this manner are assumed to be part of documented
Expand Down
28 changes: 12 additions & 16 deletions lib/src/render/element_type_renderer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -182,14 +182,12 @@ class CallableElementTypeRendererHtml
String renderNameWithGenerics(CallableElementType elementType) {
var buf = StringBuffer();
buf.write(elementType.name);
if (elementType.typeArguments != null) {
if (elementType.typeArguments.isNotEmpty &&
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
buf.write('&lt;');
buf.writeAll(
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ');
buf.write('>');
}
if (elementType.typeArguments.isNotEmpty &&
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
buf.write('&lt;');
buf.writeAll(
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ');
buf.write('>');
}
return wrapNullability(elementType, buf.toString());
}
Expand Down Expand Up @@ -345,14 +343,12 @@ class CallableElementTypeRendererMd
String renderNameWithGenerics(CallableElementType elementType) {
var buf = StringBuffer();
buf.write(elementType.name);
if (elementType.typeArguments != null) {
if (elementType.typeArguments.isNotEmpty &&
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
buf.write('&lt;');
buf.writeAll(
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ');
buf.write('>');
}
if (elementType.typeArguments.isNotEmpty &&
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
buf.write('&lt;');
buf.writeAll(
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ');
buf.write('>');
}
return wrapNullability(elementType, buf.toString());
}
Expand Down
1 change: 0 additions & 1 deletion lib/src/warnings.dart
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,6 @@ const Map<PackageWarning, PackageWarningDefinition> packageWarningDefinitions =
/// Something that package warnings can be called on. Optionally associated
/// with an analyzer [element].
mixin Warnable implements Canonicalization, CommentReferable {
@override
Element? get element;

Warnable? get enclosingElement;
Expand Down
4 changes: 0 additions & 4 deletions test/comment_referable/comment_referable_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

library dartdoc.comment_reference_test;

import 'package:analyzer/dart/element/element.dart';
import 'package:dartdoc/src/model/comment_referable.dart';
import 'package:dartdoc/src/model/model_object_builder.dart';
import 'package:dartdoc/src/model/nameable.dart';
Expand Down Expand Up @@ -34,9 +33,6 @@ abstract class Base extends Nameable with CommentReferable {
referenceBy(value.split(_separator),
allowTree: allowTree ?? (_) => true, filter: filter ?? (_) => true);

@override
Element get element => throw UnimplementedError();

@override
Iterable<CommentReferable> get referenceGrandparentOverrides => null;
}
Expand Down
11 changes: 6 additions & 5 deletions test/src/utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,12 @@ two:lib/
/// as the original lookup code returns canonicalized results and the
/// new lookup code is only guaranteed to return equivalent results.
MatchingLinkResult definingLinkResult(MatchingLinkResult originalResult) {
if (originalResult.commentReferable?.element != null) {
return MatchingLinkResult(
originalResult.commentReferable.modelBuilder
.fromElement(originalResult.commentReferable.element),
warn: originalResult.warn);
var definingReferable =
originalResult.commentReferable?.definingCommentReferable;

if (definingReferable != null &&
definingReferable != originalResult.commentReferable) {
return MatchingLinkResult(definingReferable, warn: originalResult.warn);
}
return originalResult;
}
Expand Down