non-null

flutter · Aug 3, 2023 · 765618f · 765618f
1 parent 051d20a
commit 765618f
Show file tree

Hide file tree

Showing 43 changed files with 913 additions and 163 deletions.
diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 10.1.5
+
+* Adds primitive enum support.
+* Fixes Objc nullable enums.
+
 ## 10.1.4
 
 * Adds package name to method channel strings to avoid potential collisions between plugins.

diff --git a/packages/pigeon/example/app/macos/Runner/messages.g.h b/packages/pigeon/example/app/macos/Runner/messages.g.h
@@ -18,6 +18,13 @@ typedef NS_ENUM(NSUInteger, PGNCode) {
   PGNCodeTwo = 1,
 };
 
+@class PGNCodeWrapper;
+
+/// Wrapper for PGNCode to manage primitive and nullable use.
+@interface PGNCodeWrapper : NSObject
+@property(nonatomic, assign) PGNCode value;
+@end
+
 @class PGNMessageData;
 
 @interface PGNMessageData : NSObject

diff --git a/packages/pigeon/example/app/macos/Runner/messages.g.m b/packages/pigeon/example/app/macos/Runner/messages.g.m
@@ -16,6 +16,12 @@
 #error File requires ARC to be enabled.
 #endif
 
+@interface PGNCodeWrapper ()
+@end
+
+@implementation PGNCodeWrapper
+@end
+
 static NSArray *wrapResult(id result, FlutterError *error) {
   if (error) {
     return @[

diff --git a/packages/pigeon/lib/cpp_generator.dart b/packages/pigeon/lib/cpp_generator.dart
@@ -888,9 +888,13 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
             indent.writeln(
                 'std::unique_ptr<EncodableValue> response = GetCodec().DecodeMessage(reply, reply_size);');
             indent.writeln('const auto& $encodedReplyName = *response;');
-            _writeEncodableValueArgumentUnwrapping(indent, returnType,
-                argName: successCallbackArgument,
-                encodableArgName: encodedReplyName);
+            _writeEncodableValueArgumentUnwrapping(
+              indent,
+              root,
+              returnType,
+              argName: successCallbackArgument,
+              encodableArgName: encodedReplyName,
+            );
           }
           indent.writeln('on_success($successCallbackArgument);');
         });
@@ -968,8 +972,13 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
                         indent.writeln('return;');
                       });
                     }
-                    _writeEncodableValueArgumentUnwrapping(indent, hostType,
-                        argName: argName, encodableArgName: encodableArgName);
+                    _writeEncodableValueArgumentUnwrapping(
+                      indent,
+                      root,
+                      hostType,
+                      argName: argName,
+                      encodableArgName: encodableArgName,
+                    );
                     methodArgument.add(argName);
                   });
                 }
@@ -1205,9 +1214,15 @@ return EncodableValue(EncodableList{
     } else {
       final HostDatatype hostType = getHostDatatype(returnType, root.classes,
           root.enums, _shortBaseCppTypeForBuiltinDartType);
-      const String extractedValue = 'std::move(output).TakeValue()';
-      final String wrapperType =
-          hostType.isBuiltin ? 'EncodableValue' : 'CustomEncodableValue';
+      String enumPrefix = '';
+      if (isEnum(root, returnType)) {
+        enumPrefix = '(int) ';
+      }
+      final String extractedValue =
+          '${enumPrefix}std::move(output).TakeValue()';
+      final String wrapperType = hostType.isBuiltin || isEnum(root, returnType)
+          ? 'EncodableValue'
+          : 'CustomEncodableValue';
       if (returnType.isNullable) {
         // The value is a std::optional, so needs an extra layer of
         // handling.
@@ -1297,6 +1312,7 @@ ${prefix}reply(EncodableValue(std::move(wrapped)));''';
   /// existing EncodableValue variable called [encodableArgName].
   void _writeEncodableValueArgumentUnwrapping(
     Indent indent,
+    Root root,
     HostDatatype hostType, {
     required String argName,
     required String encodableArgName,
@@ -1320,6 +1336,9 @@ ${prefix}reply(EncodableValue(std::move(wrapped)));''';
       } else if (hostType.isBuiltin) {
         indent.writeln(
             'const auto* $argName = std::get_if<${hostType.datatype}>(&$encodableArgName);');
+      } else if (hostType.isEnum) {
+        indent.writeln(
+            'const auto* $argName = &((${hostType.datatype})std::get<int>($encodableArgName));');
       } else {
         indent.writeln(
             'const auto* $argName = &(std::any_cast<const ${hostType.datatype}&>(std::get<CustomEncodableValue>($encodableArgName)));');
@@ -1342,6 +1361,9 @@ ${prefix}reply(EncodableValue(std::move(wrapped)));''';
       } else if (hostType.isBuiltin) {
         indent.writeln(
             'const auto& $argName = std::get<${hostType.datatype}>($encodableArgName);');
+      } else if (hostType.isEnum) {
+        indent.writeln(
+            'const ${hostType.datatype}& $argName = (${hostType.datatype})$encodableArgName.LongValue();');
       } else {
         indent.writeln(
             'const auto& $argName = std::any_cast<const ${hostType.datatype}&>(std::get<CustomEncodableValue>($encodableArgName));');
@@ -1390,7 +1412,11 @@ String _getSafeArgumentName(int count, NamedType argument) =>
 /// Returns a non-nullable variant of [type].
 HostDatatype _nonNullableType(HostDatatype type) {
   return HostDatatype(
-      datatype: type.datatype, isBuiltin: type.isBuiltin, isNullable: false);
+    datatype: type.datatype,
+    isBuiltin: type.isBuiltin,
+    isNullable: false,
+    isEnum: type.isEnum,
+  );
 }
 
 String _pascalCaseFromCamelCase(String camelCase) =>

diff --git a/packages/pigeon/lib/dart_generator.dart b/packages/pigeon/lib/dart_generator.dart
@@ -487,6 +487,8 @@ $resultAt != null
       codecName = _getCodecName(api);
       _writeCodec(indent, codecName, api, root);
     }
+    final List<String> customEnumNames =
+        root.enums.map((Enum x) => x.name).toList();
     indent.newln();
     bool first = true;
     addDocumentationComments(
@@ -553,9 +555,21 @@ final BinaryMessenger? _binaryMessenger;
           final String nullHandler = func.returnType.isNullable
               ? (genericCastCall.isEmpty ? '' : '?')
               : '!';
-          final String returnStatement = func.returnType.isVoid
-              ? 'return;'
-              : 'return $nullablyTypedAccessor$nullHandler$genericCastCall;';
+          String returnStatement = 'return';
+          if (customEnumNames.contains(returnType)) {
+            if (func.returnType.isNullable) {
+              returnStatement =
+                  '$returnStatement $nullablyTypedAccessor == null ? null : $returnType.values[$accessor as int]';
+            } else {
+              returnStatement =
+                  '$returnStatement $returnType.values[$accessor! as int]';
+            }
+          } else if (!func.returnType.isVoid) {
+            returnStatement =
+                '$returnStatement $nullablyTypedAccessor$nullHandler$genericCastCall';
+          }
+          returnStatement = '$returnStatement;';
+
           indent.format('''
 final List<Object?>? replyList =
 \t\tawait channel.send($sendArgument) as List<Object?>?;

diff --git a/packages/pigeon/lib/generator_tools.dart b/packages/pigeon/lib/generator_tools.dart
@@ -13,7 +13,7 @@ import 'ast.dart';
 /// The current version of pigeon.
 ///
 /// This must match the version in pubspec.yaml.
-const String pigeonVersion = '10.1.4';
+const String pigeonVersion = '10.1.5';
 
 /// Read all the content from [stdin] to a String.
 String readStdin() {
@@ -176,6 +176,7 @@ class HostDatatype {
     required this.datatype,
     required this.isBuiltin,
     required this.isNullable,
+    required this.isEnum,
   });
 
   /// The [String] that can be printed into host code to represent the type.
@@ -186,6 +187,9 @@ class HostDatatype {
 
   /// `true` if the type corresponds to a nullable Dart datatype.
   final bool isNullable;
+
+  /// `true if the type is a custom enum.
+  final bool isEnum;
 }
 
 /// Calculates the [HostDatatype] for the provided [NamedType].
@@ -226,20 +230,32 @@ HostDatatype _getHostDatatype(TypeDeclaration type, List<Class> classes,
           ? customResolver(type.baseName)
           : type.baseName;
       return HostDatatype(
-          datatype: customName, isBuiltin: false, isNullable: type.isNullable);
+        datatype: customName,
+        isBuiltin: false,
+        isNullable: type.isNullable,
+        isEnum: false,
+      );
     } else if (enums.map((Enum x) => x.name).contains(type.baseName)) {
       final String customName = customResolver != null
           ? customResolver(type.baseName)
           : type.baseName;
       return HostDatatype(
-          datatype: customName, isBuiltin: false, isNullable: type.isNullable);
+        datatype: customName,
+        isBuiltin: false,
+        isNullable: type.isNullable,
+        isEnum: true,
+      );
     } else {
       throw Exception(
           'unrecognized datatype ${fieldName == null ? '' : 'for field:"$fieldName" '}of type:"${type.baseName}"');
     }
   } else {
     return HostDatatype(
-        datatype: datatype, isBuiltin: true, isNullable: type.isNullable);
+      datatype: datatype,
+      isBuiltin: true,
+      isNullable: type.isNullable,
+      isEnum: false,
+    );
   }
 }
 

diff --git a/packages/pigeon/lib/java_generator.dart b/packages/pigeon/lib/java_generator.dart
@@ -734,8 +734,12 @@ Result<$returnType> $resultName =
                   indent.writeln('$call;');
                   indent.writeln('wrapped.add(0, null);');
                 } else {
+                  String enumTag = '';
+                  if (isEnum(root, method.returnType)) {
+                    enumTag = '.index';
+                  }
                   indent.writeln('$returnType output = $call;');
-                  indent.writeln('wrapped.add(0, output);');
+                  indent.writeln('wrapped.add(0, output$enumTag);');
                 }
               });
               indent.add(' catch (Throwable exception) ');

diff --git a/packages/pigeon/lib/kotlin_generator.dart b/packages/pigeon/lib/kotlin_generator.dart
@@ -591,7 +591,11 @@ class KotlinGenerator extends StructuredGenerator<KotlinOptions> {
                         indent.writeln(call);
                         indent.writeln('wrapped = listOf<Any?>(null)');
                       } else {
-                        indent.writeln('wrapped = listOf<Any?>($call)');
+                        String enumTag = '';
+                        if (isEnum(root, method.returnType)) {
+                          enumTag = '.raw';
+                        }
+                        indent.writeln('wrapped = listOf<Any?>($call$enumTag)');
                       }
                     }, addTrailingNewline: false);
                     indent.add(' catch (exception: Throwable) ');