Skip to content

[pigeon] fix named parameters in flutter api #5663

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

Closed
schultek wants to merge 7 commits into from
Closed

[pigeon] fix named parameters in flutter api #5663

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
392eec5
fix named parameters in flutter api test
schultek Dec 13, 2023
981e984
add test for named parameters
Dec 13, 2023
3690036
update versioning
Dec 14, 2023
0f39fd3
add named methods to flutter api test
Dec 14, 2023
6f85a29
generate api outputs
Dec 14, 2023
c45ef1b
add named methods to host api test
Dec 14, 2023
ce38e9c
Revert "generate api outputs"
Dec 14, 2023
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
2 changes: 1 addition & 1 deletion packages/pigeon/lib/ast.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ class Parameter extends NamedType {
bool? isPositional,
bool? isRequired,
super.documentationComments,
}) : isNamed = isNamed ?? true,
Copy link
Author

@schultek schultek Dec 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fixes existing tests that don't specify this but still assume it's false.

Since this wasn't used anywhere besides toString, I don't consider this a breaking change.

}) : isNamed = isNamed ?? false,
isOptional = isOptional ?? false,
isPositional = isPositional ?? true,
isRequired = isRequired ?? true;
Expand Down
4 changes: 2 additions & 2 deletions packages/pigeon/lib/dart_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,9 +418,9 @@ $resultAt != null
}
});
final Iterable<String> argNames =
indexMap(func.parameters, (int index, NamedType field) {
indexMap(func.parameters, (int index, Parameter field) {
final String name = _getSafeArgumentName(index, field);
return '$name${field.type.isNullable ? '' : '!'}';
return '${field.isNamed ? '${field.name}: ' : ''}$name${field.type.isNullable ? '' : '!'}';
});
call = 'api.${func.name}(${argNames.join(', ')})';
}
Expand Down
8 changes: 4 additions & 4 deletions packages/pigeon/lib/pigeon_lib.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1132,10 +1132,10 @@ class _RootBuilder extends dart_ast_visitor.RecursiveAstVisitor<Object?> {
),
name: formalParameter.name?.lexeme ?? '',
offset: formalParameter.offset,
isNamed: isNamed,
isOptional: isOptional,
isPositional: isPositional,
isRequired: isRequired,
isNamed: isNamed ?? formalParameter.isNamed,
isOptional: isOptional ?? formalParameter.isOptional,
isPositional: isPositional ?? formalParameter.isPositional,
isRequired: isRequired ?? formalParameter.isRequired,
defaultValue: defaultValue,
);
} else if (simpleFormalParameter != null) {
Expand Down
35 changes: 35 additions & 0 deletions packages/pigeon/test/dart_generator_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1417,6 +1417,41 @@ void main() {
expect(code, contains('void doit(int? foo);'));
});

test('named argument flutter', () {
final Root root = Root(
apis: <Api>[
Api(name: 'Api', location: ApiLocation.flutter, methods: <Method>[
Method(
name: 'doit',
returnType: const TypeDeclaration.voidDeclaration(),
parameters: <Parameter>[
Parameter(
name: 'foo',
type: const TypeDeclaration(
baseName: 'int',
isNullable: false,
),
isNamed: true,
isPositional: false),
])
])
],
classes: <Class>[],
enums: <Enum>[],
);
final StringBuffer sink = StringBuffer();
const DartGenerator generator = DartGenerator();
generator.generate(
const DartOptions(),
root,
sink,
dartPackageName: DEFAULT_PACKAGE_NAME,
);
final String code = sink.toString();
expect(code, contains('void doit({required int foo});'));
expect(code, contains('api.doit(foo: arg_foo!)'));
});

test('uses output package name for imports', () {
const String overriddenPackageName = 'custom_name';
const String outputPackageName = 'some_output_package';
Expand Down