Skip to content

Remove CallableElementType. #3668

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.

Sign up for GitHub

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
Feb 22, 2024
Merged

Remove CallableElementType. #3668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 0 additions & 21 deletions lib/src/element_type.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,27 +406,6 @@ mixin Rendered implements ElementType {
ElementTypeRenderer<ElementType> get _renderer;
}

/// A callable type that may or may not be backed by a declaration using the
/// generic function syntax.
class CallableElementType extends DefinedElementType with Rendered, Callable {
CallableElementType._(
FunctionType super.t, super.library, super.packageGraph, super.element)
: super._();

@override
String get name => super.name.isNotEmpty ? super.name : 'Function';

@override
ElementTypeRenderer<CallableElementType> get _renderer =>
const CallableElementTypeRendererHtml();

@override
late final List<ElementType> typeArguments = type.alias?.typeArguments
.map((f) => modelBuilder.typeFrom(f, library))
.toList(growable: false) ??
const [];
}

extension on DartType {
/// The dartdoc nullability suffix for this type in [library].
String nullabilitySuffixWithin(Library library) {
Expand Down
34 changes: 0 additions & 34 deletions lib/src/render/element_type_renderer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,37 +176,3 @@ class AliasedElementTypeRendererHtml
elementType.aliasArguments,
);
}

class CallableElementTypeRendererHtml
extends ElementTypeRenderer<CallableElementType> {
const CallableElementTypeRendererHtml();

@override
String renderLinkedName(CallableElementType elementType) {
var buffer = StringBuffer()
..write(elementType.nameWithGenerics)
..write('(')
..write(const ParameterRendererHtml()
.renderLinkedParams(elementType.modelElement.parameters,
showNames: false)
.trim())
..write(') → ')
..write(elementType.returnType.linkedName);
return wrapNullabilityParens(elementType, buffer.toString());
}

@override
String renderNameWithGenerics(CallableElementType elementType) {
var buffer = StringBuffer()..write(elementType.name);
if (elementType.typeArguments.isNotEmpty &&
!elementType.typeArguments.every((t) => t.name == 'dynamic')) {
buffer
..write('&lt;')
..writeAll(
elementType.typeArguments.map((t) => t.nameWithGenerics), ', ')
..write('>');
}
buffer.write(elementType.nullabilitySuffix);
return buffer.toString();
}
}
57 changes: 27 additions & 30 deletions lib/src/render/parameter_renderer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ abstract class ParameterRenderer {
String required(String required);

String renderLinkedParams(List<Parameter> parameters,
{bool showMetadata = true, bool showNames = true}) {
{bool showMetadata = true}) {
var positionalParams = parameters
.where((Parameter p) => p.isRequiredPositional)
.toList(growable: false);
Expand All @@ -77,27 +77,33 @@ abstract class ParameterRenderer {

var buffer = StringBuffer();
if (positionalParams.isNotEmpty) {
_renderLinkedParameterSublist(positionalParams, buffer,
trailingComma:
optionalPositionalParams.isNotEmpty || namedParams.isNotEmpty,
showMetadata: showMetadata,
showNames: showNames);
_renderLinkedParameterSublist(
positionalParams,
buffer,
trailingComma:
optionalPositionalParams.isNotEmpty || namedParams.isNotEmpty,
showMetadata: showMetadata,
);
}
if (optionalPositionalParams.isNotEmpty) {
_renderLinkedParameterSublist(optionalPositionalParams, buffer,
trailingComma: namedParams.isNotEmpty,
openBracket: '[',
closeBracket: ']',
showMetadata: showMetadata,
showNames: showNames);
_renderLinkedParameterSublist(
optionalPositionalParams,
buffer,
trailingComma: namedParams.isNotEmpty,
openBracket: '[',
closeBracket: ']',
showMetadata: showMetadata,
);
}
if (namedParams.isNotEmpty) {
_renderLinkedParameterSublist(namedParams, buffer,
trailingComma: false,
openBracket: '{',
closeBracket: '}',
showMetadata: showMetadata,
showNames: showNames);
_renderLinkedParameterSublist(
namedParams,
buffer,
trailingComma: false,
openBracket: '{',
closeBracket: '}',
showMetadata: showMetadata,
);
}
return orderedList(buffer.toString());
}
Expand All @@ -109,7 +115,6 @@ abstract class ParameterRenderer {
String openBracket = '',
String closeBracket = '',
bool showMetadata = true,
bool showNames = true,
}) {
for (var p in parameters) {
var prefix = '';
Expand All @@ -128,7 +133,6 @@ abstract class ParameterRenderer {
prefix: prefix,
suffix: suffix,
showMetadata: showMetadata,
showNames: showNames,
);
buffer.write(listItem(parameter(renderedParameter, p.htmlId)));
}
Expand All @@ -139,7 +143,6 @@ abstract class ParameterRenderer {
required String prefix,
required String suffix,
bool showMetadata = true,
bool showNames = true,
}) {
final buffer = StringBuffer(prefix);
final modelType = param.modelType;
Expand All @@ -160,17 +163,12 @@ abstract class ParameterRenderer {
? modelType.linkedName
: modelType.returnType.linkedName;
buffer.write(typeName(returnTypeName));
if (showNames) {
buffer.write(' ${parameterName(param.name)}');
} else {
buffer.write(' ${parameterName(modelType.name)}');
}
buffer.write(' ${parameterName(param.name)}');
if (!modelType.isTypedef && modelType is DefinedElementType) {
buffer.write('(');
buffer.write(renderLinkedParams(
(modelType as DefinedElementType).modelElement.parameters,
showMetadata: showMetadata,
showNames: showNames,
));
buffer.write(')');
buffer.write(modelType.nullabilitySuffix);
Expand All @@ -180,7 +178,6 @@ abstract class ParameterRenderer {
buffer.write(renderLinkedParams(
modelType.parameters,
showMetadata: showMetadata,
showNames: showNames,
));
buffer.write(')');
buffer.write(modelType.nullabilitySuffix);
Expand All @@ -189,11 +186,11 @@ abstract class ParameterRenderer {
final linkedTypeName = modelType.linkedName;
if (linkedTypeName.isNotEmpty) {
buffer.write(typeName(linkedTypeName));
if (showNames && param.name.isNotEmpty) {
if (param.name.isNotEmpty) {
buffer.write(' ');
}
}
if (showNames && param.name.isNotEmpty) {
if (param.name.isNotEmpty) {
buffer.write(parameterName(param.name));
}
}
Expand Down
2 changes: 1 addition & 1 deletion test/end2end/model_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4379,7 +4379,7 @@ String? topLevelFunction(int param1, bool param2, Cool coolBeans,
test('a function requiring a Future<void> parameter', () {
expect(
ParameterRendererHtml().renderLinkedParams(aVoidParameter.parameters,
showMetadata: true, showNames: true),
showMetadata: true),
equals(
'<span class="parameter" id="aVoidParameter-param-p1"><span class="type-annotation">Future<span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span> <span class="parameter-name">p1</span></span>'));
});
Expand Down