flutter/packages
1
0
Fork 0
mirror of https://github.com/flutter/packages.git synced 2025-06-30 14:47:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

[pigeon] Minor C++ output adjustments (#3083)

Browse Source 
* [pigeon] Minor C++ output fixes

Removes a stray ; from an inline constructor.

Fixes indentation for an inline vector construction.

* Version bump

* Change list serialization construction and remove a bunch of flutter::s

* Move some implementation-file-only helpers into the class

* Remove more namespaces

* Update test expectations

* Improve test

* declaration-style comment

* Fix generator version
This commit is contained in:
stuartmorgan
2023-01-23 16:59:07 -08:00
committed by GitHub
parent 55294efc3b
commit cccfa44fcb
14 changed files with 800 additions and 808 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/pigeon/CHANGELOG.md
View File

@ -1,3 +1,7 @@
## 7.0.4
* [c++] Fixes minor output formatting issues.
## 7.0.3 ## 7.0.3
* Updates scoped methods to prevent symbol-less use. * Updates scoped methods to prevent symbol-less use.

305
packages/pigeon/lib/cpp_generator.dart
View File

@ -312,7 +312,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
indent.addScoped(' public:', '', () { indent.addScoped(' public:', '', () {
indent.writeln('${api.name}(const ${api.name}&) = delete;'); indent.writeln('${api.name}(const ${api.name}&) = delete;');
indent.writeln('${api.name}& operator=(const ${api.name}&) = delete;'); indent.writeln('${api.name}& operator=(const ${api.name}&) = delete;');
indent.writeln('virtual ~${api.name}() { };'); indent.writeln('virtual ~${api.name}() {}');
for (final Method method in api.methods) { for (final Method method in api.methods) {
final HostDatatype returnType = getHostDatatype(method.returnType, final HostDatatype returnType = getHostDatatype(method.returnType,
root.classes, root.enums, _baseCppTypeForBuiltinDartType); root.classes, root.enums, _baseCppTypeForBuiltinDartType);
@ -500,6 +500,22 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
} }
} }
@override
void writeGeneralUtilities(
CppOptions generatorOptions, Root root, Indent indent) {
final List<String> usingDirectives = <String>[
'flutter::BasicMessageChannel',
'flutter::CustomEncodableValue',
'flutter::EncodableList',
'flutter::EncodableMap',
'flutter::EncodableValue',
];
usingDirectives.sort();
for (final String using in usingDirectives) {
indent.writeln('using $using;');
}
}
@override @override
void writeDataClass( void writeDataClass(
CppOptions generatorOptions, Root root, Indent indent, Class klass) { CppOptions generatorOptions, Root root, Indent indent, Class klass) {
@ -539,18 +555,18 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
Set<String> customClassNames, Set<String> customClassNames,
Set<String> customEnumNames, Set<String> customEnumNames,
) { ) {
indent.write( indent.write('EncodableList ${klass.name}::ToEncodableList() const ');
'flutter::EncodableList ${klass.name}::ToEncodableList() const ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
indent.addScoped('return flutter::EncodableList{', '};', () { indent.writeln('EncodableList list;');
for (final NamedType field in getFieldsInSerializationOrder(klass)) { indent.writeln('list.reserve(${klass.fields.length});');
final HostDatatype hostDatatype = getFieldHostDatatype( for (final NamedType field in getFieldsInSerializationOrder(klass)) {
field, root.classes, root.enums, _baseCppTypeForBuiltinDartType); final HostDatatype hostDatatype = getFieldHostDatatype(field,
final String encodableValue = _wrappedHostApiArgumentExpression( root.classes, root.enums, _shortBaseCppTypeForBuiltinDartType);
root, _makeInstanceVariableName(field), field.type, hostDatatype); final String encodableValue = _wrappedHostApiArgumentExpression(
indent.writeln('$encodableValue,'); root, _makeInstanceVariableName(field), field.type, hostDatatype);
} indent.writeln('list.push_back($encodableValue);');
}); }
indent.writeln('return list;');
}); });
indent.newln(); indent.newln();
} }
@ -564,8 +580,7 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
Set<String> customClassNames, Set<String> customClassNames,
Set<String> customEnumNames, Set<String> customEnumNames,
) { ) {
indent.write( indent.write('${klass.name}::${klass.name}(const EncodableList& list) ');
'${klass.name}::${klass.name}(const flutter::EncodableList& list) ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
enumerate(getFieldsInSerializationOrder(klass), enumerate(getFieldsInSerializationOrder(klass),
(int index, final NamedType field) { (int index, final NamedType field) {
@ -579,8 +594,8 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
indent.writeln( indent.writeln(
'if (const int32_t* $pointerFieldName = std::get_if<int32_t>(&$encodableFieldName))\t$instanceVariableName = (${field.type.baseName})*$pointerFieldName;'); 'if (const int32_t* $pointerFieldName = std::get_if<int32_t>(&$encodableFieldName))\t$instanceVariableName = (${field.type.baseName})*$pointerFieldName;');
} else { } else {
final HostDatatype hostDatatype = getFieldHostDatatype( final HostDatatype hostDatatype = getFieldHostDatatype(field,
field, root.classes, root.enums, _baseCppTypeForBuiltinDartType); root.classes, root.enums, _shortBaseCppTypeForBuiltinDartType);
if (field.type.baseName == 'int') { if (field.type.baseName == 'int') {
indent.format(''' indent.format('''
if (const int32_t* $pointerFieldName = std::get_if<int32_t>(&$encodableFieldName)) if (const int32_t* $pointerFieldName = std::get_if<int32_t>(&$encodableFieldName))
@ -592,7 +607,7 @@ else if (const int64_t* ${pointerFieldName}_64 = std::get_if<int64_t>(&$encodabl
.map((Class x) => x.name) .map((Class x) => x.name)
.contains(field.type.baseName)) { .contains(field.type.baseName)) {
indent.write( indent.write(
'if (const flutter::EncodableList* $pointerFieldName = std::get_if<flutter::EncodableList>(&$encodableFieldName)) '); 'if (const EncodableList* $pointerFieldName = std::get_if<EncodableList>(&$encodableFieldName)) ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
indent.writeln( indent.writeln(
'$instanceVariableName = ${hostDatatype.datatype}(*$pointerFieldName);'); '$instanceVariableName = ${hostDatatype.datatype}(*$pointerFieldName);');
@ -639,14 +654,14 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
for (final Method func in api.methods) { for (final Method func in api.methods) {
final String channelName = makeChannelName(api, func); final String channelName = makeChannelName(api, func);
final HostDatatype returnType = getHostDatatype(func.returnType, final HostDatatype returnType = getHostDatatype(func.returnType,
root.classes, root.enums, _baseCppTypeForBuiltinDartType); root.classes, root.enums, _shortBaseCppTypeForBuiltinDartType);
// Determine the input paramater list, saved in a structured form for later // Determine the input paramater list, saved in a structured form for later
// use as platform channel call arguments. // use as platform channel call arguments.
final Iterable<_HostNamedType> hostParameters = final Iterable<_HostNamedType> hostParameters =
indexMap(func.arguments, (int i, NamedType arg) { indexMap(func.arguments, (int i, NamedType arg) {
final HostDatatype hostType = getFieldHostDatatype( final HostDatatype hostType = getFieldHostDatatype(
arg, root.classes, root.enums, _baseCppTypeForBuiltinDartType); arg, root.classes, root.enums, _shortBaseCppTypeForBuiltinDartType);
return _HostNamedType(_getSafeArgumentName(i, arg), hostType, arg.type); return _HostNamedType(_getSafeArgumentName(i, arg), hostType, arg.type);
}); });
final List<String> parameters = <String>[ final List<String> parameters = <String>[
@ -659,17 +674,16 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
indent.writeScoped('{', '}', () { indent.writeScoped('{', '}', () {
const String channel = 'channel'; const String channel = 'channel';
indent.writeln( indent.writeln(
'auto channel = std::make_unique<flutter::BasicMessageChannel<>>(binary_messenger_, ' 'auto channel = std::make_unique<BasicMessageChannel<>>(binary_messenger_, '
'"$channelName", &GetCodec());'); '"$channelName", &GetCodec());');
// Convert arguments to EncodableValue versions. // Convert arguments to EncodableValue versions.
const String argumentListVariableName = 'encoded_api_arguments'; const String argumentListVariableName = 'encoded_api_arguments';
indent.write('flutter::EncodableValue $argumentListVariableName = '); indent.write('EncodableValue $argumentListVariableName = ');
if (func.arguments.isEmpty) { if (func.arguments.isEmpty) {
indent.addln('flutter::EncodableValue();'); indent.addln('EncodableValue();');
} else { } else {
indent.addScoped( indent.addScoped('EncodableValue(EncodableList{', '});', () {
'flutter::EncodableValue(flutter::EncodableList{', '});', () {
for (final _HostNamedType param in hostParameters) { for (final _HostNamedType param in hostParameters) {
final String encodedArgument = _wrappedHostApiArgumentExpression( final String encodedArgument = _wrappedHostApiArgumentExpression(
root, param.name, param.originalType, param.hostType); root, param.name, param.originalType, param.hostType);
@ -691,7 +705,7 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
final String encodedReplyName = final String encodedReplyName =
'encodable_$successCallbackArgument'; 'encodable_$successCallbackArgument';
indent.writeln( indent.writeln(
'std::unique_ptr<flutter::EncodableValue> response = GetCodec().DecodeMessage(reply, reply_size);'); 'std::unique_ptr<EncodableValue> response = GetCodec().DecodeMessage(reply, reply_size);');
indent.writeln('const auto& $encodedReplyName = *response;'); indent.writeln('const auto& $encodedReplyName = *response;');
_writeEncodableValueArgumentUnwrapping(indent, returnType, _writeEncodableValueArgumentUnwrapping(indent, returnType,
argName: successCallbackArgument, argName: successCallbackArgument,
@ -730,19 +744,19 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
indent.write(''); indent.write('');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
indent.writeln( indent.writeln(
'auto channel = std::make_unique<flutter::BasicMessageChannel<>>(binary_messenger, ' 'auto channel = std::make_unique<BasicMessageChannel<>>(binary_messenger, '
'"$channelName", &GetCodec());'); '"$channelName", &GetCodec());');
indent.write('if (api != nullptr) '); indent.write('if (api != nullptr) ');
indent.addScoped('{', '} else {', () { indent.addScoped('{', '} else {', () {
indent.write( indent.write(
'channel->SetMessageHandler([api](const flutter::EncodableValue& message, const flutter::MessageReply<flutter::EncodableValue>& reply) '); 'channel->SetMessageHandler([api](const EncodableValue& message, const flutter::MessageReply<EncodableValue>& reply) ');
indent.addScoped('{', '});', () { indent.addScoped('{', '});', () {
indent.write('try '); indent.write('try ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
final List<String> methodArgument = <String>[]; final List<String> methodArgument = <String>[];
if (method.arguments.isNotEmpty) { if (method.arguments.isNotEmpty) {
indent.writeln( indent.writeln(
'const auto& args = std::get<flutter::EncodableList>(message);'); 'const auto& args = std::get<EncodableList>(message);');
enumerate(method.arguments, (int index, NamedType arg) { enumerate(method.arguments, (int index, NamedType arg) {
final HostDatatype hostType = getHostDatatype( final HostDatatype hostType = getHostDatatype(
@ -750,7 +764,7 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
root.classes, root.classes,
root.enums, root.enums,
(TypeDeclaration x) => (TypeDeclaration x) =>
_baseCppTypeForBuiltinDartType(x)); _shortBaseCppTypeForBuiltinDartType(x));
final String argName = _getSafeArgumentName(index, arg); final String argName = _getSafeArgumentName(index, arg);
final String encodableArgName = final String encodableArgName =
@ -775,7 +789,7 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
method.returnType, method.returnType,
root.classes, root.classes,
root.enums, root.enums,
_baseCppTypeForBuiltinDartType); _shortBaseCppTypeForBuiltinDartType);
final String returnTypeName = _hostApiReturnType(returnType); final String returnTypeName = _hostApiReturnType(returnType);
if (method.isAsynchronous) { if (method.isAsynchronous) {
methodArgument.add( methodArgument.add(
@ -816,17 +830,17 @@ const flutter::StandardMessageCodec& ${api.name}::GetCodec() {
indent.newln(); indent.newln();
indent.format(''' indent.format('''
flutter::EncodableValue ${api.name}::WrapError(std::string_view error_message) { EncodableValue ${api.name}::WrapError(std::string_view error_message) {
\treturn flutter::EncodableValue(flutter::EncodableList{ \treturn EncodableValue(EncodableList{
\t\tflutter::EncodableValue(std::string(error_message)), \t\tEncodableValue(std::string(error_message)),
\t\tflutter::EncodableValue("Error"), \t\tEncodableValue("Error"),
\t\tflutter::EncodableValue() \t\tEncodableValue()
\t}); \t});
} }
flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) { EncodableValue ${api.name}::WrapError(const FlutterError& error) {
\treturn flutter::EncodableValue(flutter::EncodableList{ \treturn EncodableValue(EncodableList{
\t\tflutter::EncodableValue(error.message()), \t\tEncodableValue(error.message()),
\t\tflutter::EncodableValue(error.code()), \t\tEncodableValue(error.code()),
\t\terror.details() \t\terror.details()
\t}); \t});
}'''); }''');
@ -844,7 +858,7 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
indent.newln(); indent.newln();
indent.writeln('$codeSerializerName::$codeSerializerName() {}'); indent.writeln('$codeSerializerName::$codeSerializerName() {}');
indent.write( indent.write(
'flutter::EncodableValue $codeSerializerName::ReadValueOfType(uint8_t type, flutter::ByteStreamReader* stream) const '); 'EncodableValue $codeSerializerName::ReadValueOfType(uint8_t type, flutter::ByteStreamReader* stream) const ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
indent.write('switch (type) '); indent.write('switch (type) ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
@ -852,7 +866,7 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
indent.writeln('case ${customClass.enumeration}:'); indent.writeln('case ${customClass.enumeration}:');
indent.nest(1, () { indent.nest(1, () {
indent.writeln( indent.writeln(
'return flutter::CustomEncodableValue(${customClass.name}(std::get<flutter::EncodableList>(ReadValue(stream))));'); 'return CustomEncodableValue(${customClass.name}(std::get<EncodableList>(ReadValue(stream))));');
}); });
} }
indent.writeln('default:'); indent.writeln('default:');
@ -864,10 +878,10 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
}); });
indent.newln(); indent.newln();
indent.write( indent.write(
'void $codeSerializerName::WriteValue(const flutter::EncodableValue& value, flutter::ByteStreamWriter* stream) const '); 'void $codeSerializerName::WriteValue(const EncodableValue& value, flutter::ByteStreamWriter* stream) const ');
indent.writeScoped('{', '}', () { indent.writeScoped('{', '}', () {
indent.write( indent.write(
'if (const flutter::CustomEncodableValue* custom_value = std::get_if<flutter::CustomEncodableValue>(&value)) '); 'if (const CustomEncodableValue* custom_value = std::get_if<CustomEncodableValue>(&value)) ');
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
for (final EnumeratedClass customClass in getCodecClasses(api, root)) { for (final EnumeratedClass customClass in getCodecClasses(api, root)) {
indent.write( indent.write(
@ -875,7 +889,7 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
indent.addScoped('{', '}', () { indent.addScoped('{', '}', () {
indent.writeln('stream->WriteByte(${customClass.enumeration});'); indent.writeln('stream->WriteByte(${customClass.enumeration});');
indent.writeln( indent.writeln(
'WriteValue(flutter::EncodableValue(std::any_cast<${customClass.name}>(*custom_value).ToEncodableList()), stream);'); 'WriteValue(EncodableValue(std::any_cast<${customClass.name}>(*custom_value).ToEncodableList()), stream);');
indent.writeln('return;'); indent.writeln('return;');
}); });
} }
@ -888,7 +902,7 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
void _writeCppSourceClassField(CppOptions generatorOptions, Root root, void _writeCppSourceClassField(CppOptions generatorOptions, Root root,
Indent indent, Class klass, NamedType field) { Indent indent, Class klass, NamedType field) {
final HostDatatype hostDatatype = getFieldHostDatatype( final HostDatatype hostDatatype = getFieldHostDatatype(
field, root.classes, root.enums, _baseCppTypeForBuiltinDartType); field, root.classes, root.enums, _shortBaseCppTypeForBuiltinDartType);
final String instanceVariableName = _makeInstanceVariableName(field); final String instanceVariableName = _makeInstanceVariableName(field);
final String qualifiedGetterName = final String qualifiedGetterName =
'${klass.name}::${_makeGetterName(field)}'; '${klass.name}::${_makeGetterName(field)}';
@ -928,18 +942,17 @@ flutter::EncodableValue ${api.name}::WrapError(const FlutterError& error) {
final String errorCondition; final String errorCondition;
final String errorGetter; final String errorGetter;
const String nullValue = 'flutter::EncodableValue()'; const String nullValue = 'EncodableValue()';
if (returnType.isVoid) { if (returnType.isVoid) {
nonErrorPath = '${prefix}wrapped.push_back($nullValue);'; nonErrorPath = '${prefix}wrapped.push_back($nullValue);';
errorCondition = 'output.has_value()'; errorCondition = 'output.has_value()';
errorGetter = 'value'; errorGetter = 'value';
} else { } else {
final HostDatatype hostType = getHostDatatype( final HostDatatype hostType = getHostDatatype(returnType, root.classes,
returnType, root.classes, root.enums, _baseCppTypeForBuiltinDartType); root.enums, _shortBaseCppTypeForBuiltinDartType);
const String extractedValue = 'std::move(output).TakeValue()'; const String extractedValue = 'std::move(output).TakeValue()';
final String wrapperType = hostType.isBuiltin final String wrapperType =
? 'flutter::EncodableValue' hostType.isBuiltin ? 'EncodableValue' : 'CustomEncodableValue';
: 'flutter::CustomEncodableValue';
if (returnType.isNullable) { if (returnType.isNullable) {
// The value is a std::optional, so needs an extra layer of // The value is a std::optional, so needs an extra layer of
// handling. // handling.
@ -966,9 +979,9 @@ ${prefix}if ($errorCondition) {
$prefix\treply(WrapError(output.$errorGetter())); $prefix\treply(WrapError(output.$errorGetter()));
$prefix\treturn; $prefix\treturn;
$prefix} $prefix}
${prefix}flutter::EncodableList wrapped; ${prefix}EncodableList wrapped;
$nonErrorPath $nonErrorPath
${prefix}reply(flutter::EncodableValue(std::move(wrapped)));'''; ${prefix}reply(EncodableValue(std::move(wrapped)));''';
} }
@override @override
@ -978,6 +991,96 @@ ${prefix}reply(flutter::EncodableValue(std::move(wrapped)));''';
indent.writeln('} // namespace ${generatorOptions.namespace}'); indent.writeln('} // namespace ${generatorOptions.namespace}');
} }
} }
/// Returns the expression to create an EncodableValue from a host API argument
/// with the given [variableName] and types.
String _wrappedHostApiArgumentExpression(Root root, String variableName,
TypeDeclaration dartType, HostDatatype hostType) {
final String encodableValue;
if (!hostType.isBuiltin &&
root.classes.any((Class c) => c.name == dartType.baseName)) {
final String operator = hostType.isNullable ? '->' : '.';
encodableValue =
'EncodableValue($variableName${operator}ToEncodableList())';
} else if (!hostType.isBuiltin &&
root.enums.any((Enum e) => e.name == dartType.baseName)) {
final String nonNullValue =
hostType.isNullable ? '(*$variableName)' : variableName;
encodableValue = 'EncodableValue((int)$nonNullValue)';
} else {
final String operator = hostType.isNullable ? '*' : '';
encodableValue = 'EncodableValue($operator$variableName)';
}
if (hostType.isNullable) {
return '$variableName ? $encodableValue : EncodableValue()';
}
return encodableValue;
}
/// Writes the code to declare and populate a variable of type [hostType]
/// called [argName] to use as a parameter to an API method call, from an
/// existing EncodableValue variable called [encodableArgName].
void _writeEncodableValueArgumentUnwrapping(
Indent indent,
HostDatatype hostType, {
required String argName,
required String encodableArgName,
}) {
if (hostType.isNullable) {
// Nullable arguments are always pointers, with nullptr corresponding to
// null.
if (hostType.datatype == 'int64_t') {
// The EncodableValue will either be an int32_t or an int64_t depending
// on the value, but the generated API requires an int64_t so that it can
// handle any case. Create a local variable for the 64-bit value...
final String valueVarName = '${argName}_value';
indent.writeln(
'const int64_t $valueVarName = $encodableArgName.IsNull() ? 0 : $encodableArgName.LongValue();');
// ... then declare the arg as a reference to that local.
indent.writeln(
'const auto* $argName = $encodableArgName.IsNull() ? nullptr : &$valueVarName;');
} else if (hostType.datatype == 'EncodableValue') {
// Generic objects just pass the EncodableValue through directly.
indent.writeln('const auto* $argName = &$encodableArgName;');
} else if (hostType.isBuiltin) {
indent.writeln(
'const auto* $argName = std::get_if<${hostType.datatype}>(&$encodableArgName);');
} else {
indent.writeln(
'const auto* $argName = &(std::any_cast<const ${hostType.datatype}&>(std::get<CustomEncodableValue>($encodableArgName)));');
}
} else {
// Non-nullable arguments are either passed by value or reference, but the
// extraction doesn't need to distinguish since those are the same at the
// call site.
if (hostType.datatype == 'int64_t') {
// The EncodableValue will either be an int32_t or an int64_t depending
// on the value, but the generated API requires an int64_t so that it can
// handle any case.
indent
.writeln('const int64_t $argName = $encodableArgName.LongValue();');
} else if (hostType.datatype == 'EncodableValue') {
// Generic objects just pass the EncodableValue through directly. This
// creates an alias just to avoid having to special-case the
// argName/encodableArgName distinction at a higher level.
indent.writeln('const auto& $argName = $encodableArgName;');
} else if (hostType.isBuiltin) {
indent.writeln(
'const auto& $argName = std::get<${hostType.datatype}>($encodableArgName);');
} else {
indent.writeln(
'const auto& $argName = std::any_cast<const ${hostType.datatype}&>(std::get<CustomEncodableValue>($encodableArgName));');
}
}
}
/// A wrapper for [_baseCppTypeForBuiltinDartType] that generated Flutter
/// types without the namespace, since the implementation file uses `using`
/// directives.
String? _shortBaseCppTypeForBuiltinDartType(TypeDeclaration type) {
return _baseCppTypeForBuiltinDartType(type, includeFlutterNamespace: false);
}
} }
/// Contains information about a host function argument. /// Contains information about a host function argument.
@ -1065,8 +1168,12 @@ bool _isPodType(HostDatatype type) {
return !_isReferenceType(type.datatype); return !_isReferenceType(type.datatype);
} }
String? _baseCppTypeForBuiltinDartType(TypeDeclaration type) { String? _baseCppTypeForBuiltinDartType(
const Map<String, String> cppTypeForDartTypeMap = <String, String>{ TypeDeclaration type, {
bool includeFlutterNamespace = true,
}) {
final String flutterNamespace = includeFlutterNamespace ? 'flutter::' : '';
final Map<String, String> cppTypeForDartTypeMap = <String, String>{
'void': 'void', 'void': 'void',
'bool': 'bool', 'bool': 'bool',
'int': 'int64_t', 'int': 'int64_t',
@ -1076,9 +1183,9 @@ String? _baseCppTypeForBuiltinDartType(TypeDeclaration type) {
'Int32List': 'std::vector<int32_t>', 'Int32List': 'std::vector<int32_t>',
'Int64List': 'std::vector<int64_t>', 'Int64List': 'std::vector<int64_t>',
'Float64List': 'std::vector<double>', 'Float64List': 'std::vector<double>',
'Map': 'flutter::EncodableMap', 'Map': '${flutterNamespace}EncodableMap',
'List': 'flutter::EncodableList', 'List': '${flutterNamespace}EncodableList',
'Object': 'flutter::EncodableValue', 'Object': '${flutterNamespace}EncodableValue',
}; };
if (cppTypeForDartTypeMap.containsKey(type.baseName)) { if (cppTypeForDartTypeMap.containsKey(type.baseName)) {
return cppTypeForDartTypeMap[type.baseName]; return cppTypeForDartTypeMap[type.baseName];
@ -1186,88 +1293,6 @@ void _writeSystemHeaderIncludeBlock(Indent indent, List<String> headers) {
} }
} }
/// Returns the expression to create an EncodableValue from a host API argument
/// with the given [variableName] and types.
String _wrappedHostApiArgumentExpression(Root root, String variableName,
TypeDeclaration dartType, HostDatatype hostType) {
final String encodableValue;
if (!hostType.isBuiltin &&
root.classes.any((Class c) => c.name == dartType.baseName)) {
final String operator = hostType.isNullable ? '->' : '.';
encodableValue =
'flutter::EncodableValue($variableName${operator}ToEncodableList())';
} else if (!hostType.isBuiltin &&
root.enums.any((Enum e) => e.name == dartType.baseName)) {
final String nonNullValue =
hostType.isNullable ? '(*$variableName)' : variableName;
encodableValue = 'flutter::EncodableValue((int)$nonNullValue)';
} else {
final String operator = hostType.isNullable ? '*' : '';
encodableValue = 'flutter::EncodableValue($operator$variableName)';
}
if (hostType.isNullable) {
return '$variableName ? $encodableValue : flutter::EncodableValue()';
}
return encodableValue;
}
// Writes the code to declare and populate a variable of type [hostType] called
// [argName] to use as a parameter to an API method call, from an existing
// EncodableValue variable called [encodableArgName].
void _writeEncodableValueArgumentUnwrapping(
Indent indent,
HostDatatype hostType, {
required String argName,
required String encodableArgName,
}) {
if (hostType.isNullable) {
// Nullable arguments are always pointers, with nullptr corresponding to
// null.
if (hostType.datatype == 'int64_t') {
// The EncodableValue will either be an int32_t or an int64_t depending
// on the value, but the generated API requires an int64_t so that it can
// handle any case. Create a local variable for the 64-bit value...
final String valueVarName = '${argName}_value';
indent.writeln(
'const int64_t $valueVarName = $encodableArgName.IsNull() ? 0 : $encodableArgName.LongValue();');
// ... then declare the arg as a reference to that local.
indent.writeln(
'const auto* $argName = $encodableArgName.IsNull() ? nullptr : &$valueVarName;');
} else if (hostType.datatype == 'flutter::EncodableValue') {
// Generic objects just pass the EncodableValue through directly.
indent.writeln('const auto* $argName = &$encodableArgName;');
} else if (hostType.isBuiltin) {
indent.writeln(
'const auto* $argName = std::get_if<${hostType.datatype}>(&$encodableArgName);');
} else {
indent.writeln(
'const auto* $argName = &(std::any_cast<const ${hostType.datatype}&>(std::get<flutter::CustomEncodableValue>($encodableArgName)));');
}
} else {
// Non-nullable arguments are either passed by value or reference, but the
// extraction doesn't need to distinguish since those are the same at the
// call site.
if (hostType.datatype == 'int64_t') {
// The EncodableValue will either be an int32_t or an int64_t depending
// on the value, but the generated API requires an int64_t so that it can
// handle any case.
indent.writeln('const int64_t $argName = $encodableArgName.LongValue();');
} else if (hostType.datatype == 'flutter::EncodableValue') {
// Generic objects just pass the EncodableValue through directly. This
// creates an alias just to avoid having to special-case the
// argName/encodableArgName distinction at a higher level.
indent.writeln('const auto& $argName = $encodableArgName;');
} else if (hostType.isBuiltin) {
indent.writeln(
'const auto& $argName = std::get<${hostType.datatype}>($encodableArgName);');
} else {
indent.writeln(
'const auto& $argName = std::any_cast<const ${hostType.datatype}&>(std::get<flutter::CustomEncodableValue>($encodableArgName));');
}
}
}
/// Validates an AST to make sure the cpp generator supports everything. /// Validates an AST to make sure the cpp generator supports everything.
List<Error> validateCpp(CppOptions options, Root root) { List<Error> validateCpp(CppOptions options, Root root) {
final List<Error> result = <Error>[]; final List<Error> result = <Error>[];

2
packages/pigeon/lib/generator_tools.dart
View File

@ -11,7 +11,7 @@ import 'ast.dart';
/// The current version of pigeon. /// The current version of pigeon.
/// ///
/// This must match the version in pubspec.yaml. /// This must match the version in pubspec.yaml.
const String pigeonVersion = '7.0.3'; const String pigeonVersion = '7.0.4';
/// Read all the content from [stdin] to a String. /// Read all the content from [stdin] to a String.
String readStdin() { String readStdin() {

2
packages/pigeon/platform_tests/alternate_language_test_plugin/android/src/main/java/com/example/alternate_language_test_plugin/CoreTests.java
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
package com.example.alternate_language_test_plugin; package com.example.alternate_language_test_plugin;

2
packages/pigeon/platform_tests/alternate_language_test_plugin/ios/Classes/CoreTests.gen.h
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
#import <Foundation/Foundation.h> #import <Foundation/Foundation.h>

2
packages/pigeon/platform_tests/alternate_language_test_plugin/ios/Classes/CoreTests.gen.m
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
#import "CoreTests.gen.h" #import "CoreTests.gen.h"

2
packages/pigeon/platform_tests/shared_test_plugin_code/lib/src/generated/core_tests.gen.dart
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import

2
packages/pigeon/platform_tests/test_plugin/android/src/main/kotlin/com/example/test_plugin/CoreTests.gen.kt
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
package com.example.test_plugin package com.example.test_plugin

2
packages/pigeon/platform_tests/test_plugin/ios/Classes/CoreTests.gen.swift
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
import Foundation import Foundation

2
packages/pigeon/platform_tests/test_plugin/macos/Classes/CoreTests.gen.swift
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
import Foundation import Foundation

1206
packages/pigeon/platform_tests/test_plugin/windows/pigeon/core_tests.gen.cpp
View File

File diff suppressed because it is too large Load Diff

6
packages/pigeon/platform_tests/test_plugin/windows/pigeon/core_tests.gen.h
View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
// //
// Autogenerated from Pigeon (v7.0.3), do not edit directly. // Autogenerated from Pigeon (v7.0.4), do not edit directly.
// See also: https://pub.dev/packages/pigeon // See also: https://pub.dev/packages/pigeon
#ifndef PIGEON_CORE_TESTS_GEN_H_ #ifndef PIGEON_CORE_TESTS_GEN_H_
@ -262,7 +262,7 @@ class HostIntegrationCoreApi {
public: public:
HostIntegrationCoreApi(const HostIntegrationCoreApi&) = delete; HostIntegrationCoreApi(const HostIntegrationCoreApi&) = delete;
HostIntegrationCoreApi& operator=(const HostIntegrationCoreApi&) = delete; HostIntegrationCoreApi& operator=(const HostIntegrationCoreApi&) = delete;
virtual ~HostIntegrationCoreApi(){}; virtual ~HostIntegrationCoreApi() {}
// A no-op function taking no arguments and returning no value, to sanity // A no-op function taking no arguments and returning no value, to sanity
// test basic calling. // test basic calling.
virtual std::optional<FlutterError> Noop() = 0; virtual std::optional<FlutterError> Noop() = 0;
@ -509,7 +509,7 @@ class HostTrivialApi {
public: public:
HostTrivialApi(const HostTrivialApi&) = delete; HostTrivialApi(const HostTrivialApi&) = delete;
HostTrivialApi& operator=(const HostTrivialApi&) = delete; HostTrivialApi& operator=(const HostTrivialApi&) = delete;
virtual ~HostTrivialApi(){}; virtual ~HostTrivialApi() {}
virtual std::optional<FlutterError> Noop() = 0; virtual std::optional<FlutterError> Noop() = 0;
// The codec used by HostTrivialApi. // The codec used by HostTrivialApi.

2
packages/pigeon/pubspec.yaml
View File

@ -2,7 +2,7 @@ name: pigeon
description: Code generator tool to make communication between Flutter and the host platform type-safe and easier. description: Code generator tool to make communication between Flutter and the host platform type-safe and easier.
repository: https://github.com/flutter/packages/tree/main/packages/pigeon repository: https://github.com/flutter/packages/tree/main/packages/pigeon
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3Apigeon issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3Apigeon
version: 7.0.3 # This must match the version in lib/generator_tools.dart version: 7.0.4 # This must match the version in lib/generator_tools.dart
environment: environment:
sdk: ">=2.12.0 <3.0.0" sdk: ">=2.12.0 <3.0.0"

69
packages/pigeon/test/cpp_generator_test.dart
View File

@ -57,6 +57,7 @@ void main() {
expect(code, contains('class Input')); expect(code, contains('class Input'));
expect(code, contains('class Output')); expect(code, contains('class Output'));
expect(code, contains('class Api')); expect(code, contains('class Api'));
expect(code, contains('virtual ~Api() {}\n'));
} }
{ {
final StringBuffer sink = StringBuffer(); final StringBuffer sink = StringBuffer();
@ -546,13 +547,22 @@ void main() {
// Serialization handles optionals. // Serialization handles optionals.
expect( expect(
code, code,
contains('nullable_bool_ ? flutter::EncodableValue(*nullable_bool_) ' contains('nullable_bool_ ? EncodableValue(*nullable_bool_) '
': flutter::EncodableValue()')); ': EncodableValue()'));
expect( expect(
code, code,
contains( contains(
'nullable_nested_ ? flutter::EncodableValue(nullable_nested_->ToEncodableList()) ' 'nullable_nested_ ? EncodableValue(nullable_nested_->ToEncodableList()) '
': flutter::EncodableValue()')); ': EncodableValue()'));
// Serialization should use push_back, not initializer lists, to avoid
// copies.
expect(code, contains('list.reserve(4)'));
expect(
code,
contains('list.push_back(nullable_bool_ ? '
'EncodableValue(*nullable_bool_) : '
'EncodableValue())'));
} }
}); });
@ -660,8 +670,14 @@ void main() {
expect(code, contains('non_nullable_string_ = value_arg;')); expect(code, contains('non_nullable_string_ = value_arg;'));
expect(code, contains('non_nullable_nested_ = value_arg;')); expect(code, contains('non_nullable_nested_ = value_arg;'));
// Serialization uses the value directly. // Serialization uses the value directly.
expect(code, contains('flutter::EncodableValue(non_nullable_bool_)')); expect(code, contains('EncodableValue(non_nullable_bool_)'));
expect(code, contains('non_nullable_nested_.ToEncodableList()')); expect(code, contains('non_nullable_nested_.ToEncodableList()'));
// Serialization should use push_back, not initializer lists, to avoid
// copies.
expect(code, contains('list.reserve(4)'));
expect(
code, contains('list.push_back(EncodableValue(non_nullable_bool_))'));
} }
}); });
@ -987,11 +1003,11 @@ void main() {
expect( expect(
code, code,
contains( contains(
'const auto* a_list_arg = std::get_if<flutter::EncodableList>(&encodable_a_list_arg);')); 'const auto* a_list_arg = std::get_if<EncodableList>(&encodable_a_list_arg);'));
expect( expect(
code, code,
contains( contains(
'const auto* a_map_arg = std::get_if<flutter::EncodableMap>(&encodable_a_map_arg);')); 'const auto* a_map_arg = std::get_if<EncodableMap>(&encodable_a_map_arg);'));
// Ints are complicated since there are two possible pointer types, but // Ints are complicated since there are two possible pointer types, but
// the paramter always needs an int64_t*. // the paramter always needs an int64_t*.
expect( expect(
@ -1006,7 +1022,7 @@ void main() {
expect( expect(
code, code,
contains( contains(
'const auto* an_object_arg = &(std::any_cast<const ParameterObject&>(std::get<flutter::CustomEncodableValue>(encodable_an_object_arg)));')); 'const auto* an_object_arg = &(std::any_cast<const ParameterObject&>(std::get<CustomEncodableValue>(encodable_an_object_arg)));'));
// "Object" requires no extraction at all since it has to use // "Object" requires no extraction at all since it has to use
// EncodableValue directly. // EncodableValue directly.
expect( expect(
@ -1128,11 +1144,11 @@ void main() {
expect( expect(
code, code,
contains( contains(
'const auto& a_list_arg = std::get<flutter::EncodableList>(encodable_a_list_arg);')); 'const auto& a_list_arg = std::get<EncodableList>(encodable_a_list_arg);'));
expect( expect(
code, code,
contains( contains(
'const auto& a_map_arg = std::get<flutter::EncodableMap>(encodable_a_map_arg);')); 'const auto& a_map_arg = std::get<EncodableMap>(encodable_a_map_arg);'));
// Ints use a copy since there are two possible reference types, but // Ints use a copy since there are two possible reference types, but
// the paramter always needs an int64_t. // the paramter always needs an int64_t.
expect( expect(
@ -1144,7 +1160,7 @@ void main() {
expect( expect(
code, code,
contains( contains(
'const auto& an_object_arg = std::any_cast<const ParameterObject&>(std::get<flutter::CustomEncodableValue>(encodable_an_object_arg));')); 'const auto& an_object_arg = std::any_cast<const ParameterObject&>(std::get<CustomEncodableValue>(encodable_an_object_arg));'));
// "Object" requires no extraction at all since it has to use // "Object" requires no extraction at all since it has to use
// EncodableValue directly. // EncodableValue directly.
expect( expect(
@ -1275,28 +1291,28 @@ void main() {
expect( expect(
code, code,
contains( contains(
'a_bool_arg ? flutter::EncodableValue(*a_bool_arg) : flutter::EncodableValue()')); 'a_bool_arg ? EncodableValue(*a_bool_arg) : EncodableValue()'));
expect( expect(
code, code,
contains( contains(
'an_int_arg ? flutter::EncodableValue(*an_int_arg) : flutter::EncodableValue()')); 'an_int_arg ? EncodableValue(*an_int_arg) : EncodableValue()'));
expect( expect(
code, code,
contains( contains(
'a_string_arg ? flutter::EncodableValue(*a_string_arg) : flutter::EncodableValue()')); 'a_string_arg ? EncodableValue(*a_string_arg) : EncodableValue()'));
expect( expect(
code, code,
contains( contains(
'a_list_arg ? flutter::EncodableValue(*a_list_arg) : flutter::EncodableValue()')); 'a_list_arg ? EncodableValue(*a_list_arg) : EncodableValue()'));
expect( expect(
code, code,
contains( contains(
'a_map_arg ? flutter::EncodableValue(*a_map_arg) : flutter::EncodableValue()')); 'a_map_arg ? EncodableValue(*a_map_arg) : EncodableValue()'));
// Class types use ToEncodableList. // Class types use ToEncodableList.
expect( expect(
code, code,
contains( contains(
'an_object_arg ? flutter::EncodableValue(an_object_arg->ToEncodableList()) : flutter::EncodableValue()')); 'an_object_arg ? EncodableValue(an_object_arg->ToEncodableList()) : EncodableValue()'));
} }
}); });
@ -1411,14 +1427,13 @@ void main() {
generator.generate(generatorOptions, root, sink); generator.generate(generatorOptions, root, sink);
final String code = sink.toString(); final String code = sink.toString();
// Standard types are wrapped an EncodableValues. // Standard types are wrapped an EncodableValues.
expect(code, contains('flutter::EncodableValue(a_bool_arg)')); expect(code, contains('EncodableValue(a_bool_arg)'));
expect(code, contains('flutter::EncodableValue(an_int_arg)')); expect(code, contains('EncodableValue(an_int_arg)'));
expect(code, contains('flutter::EncodableValue(a_string_arg)')); expect(code, contains('EncodableValue(a_string_arg)'));
expect(code, contains('flutter::EncodableValue(a_list_arg)')); expect(code, contains('EncodableValue(a_list_arg)'));
expect(code, contains('flutter::EncodableValue(a_map_arg)')); expect(code, contains('EncodableValue(a_map_arg)'));
// Class types use ToEncodableList. // Class types use ToEncodableList.
expect(code, expect(code, contains('EncodableValue(an_object_arg.ToEncodableList())'));
contains('flutter::EncodableValue(an_object_arg.ToEncodableList())'));
} }
}); });
@ -1452,9 +1467,7 @@ void main() {
// A bare 'auto' here would create a copy, not a reference, which is // A bare 'auto' here would create a copy, not a reference, which is
// ineffecient. // ineffecient.
expect( expect(
code, code, contains('const auto& args = std::get<EncodableList>(message);'));
contains(
'const auto& args = std::get<flutter::EncodableList>(message);'));
expect(code, contains('const auto& encodable_an_arg_arg = args.at(0);')); expect(code, contains('const auto& encodable_an_arg_arg = args.at(0);'));
}); });
@ -1732,7 +1745,7 @@ void main() {
generator.generate(generatorOptions, root, sink); generator.generate(generatorOptions, root, sink);
final String code = sink.toString(); final String code = sink.toString();
expect(code, isNot(contains('reply(wrap'))); expect(code, isNot(contains('reply(wrap')));
expect(code, contains('reply(flutter::EncodableValue(')); expect(code, contains('reply(EncodableValue('));
}); });
test('does not keep unowned references in async handlers', () { test('does not keep unowned references in async handlers', () {