[pigeon] started parsing multiple parameters

packages/pigeon/CHANGELOG.md

@@ -5,6 +5,7 @@
 * [front-end] Added more errors for incorrect usage of Pigeon (previously they were just ignored).
 * Moved Pigeon to using a custom codec which allows collection types to contain custom classes.
 * Started allowing primitive data types as arguments and return types.
+* Started supporting generics' type arguments for fields in classes.
 
 ## 0.3.0
 

packages/pigeon/lib/ast.dart

@@ -20,27 +20,19 @@ class Method extends Node {
   Method({
     required this.name,
     required this.returnType,
-    required this.argType,
-    this.isArgNullable = false,
+    required this.arguments,
     this.isAsynchronous = false,
-    this.isReturnNullable = false,
     this.offset,
   });
 
   /// The name of the method.
   String name;
 
   /// The data-type of the return value.
-  String returnType;
-
-  /// True if the method can return a null value.
-  bool isReturnNullable;
+  Field returnType;
 
   /// The data-type of the argument.
-  String argType;
-
-  /// True if the argument has a null tag `?`.
-  bool isArgNullable;
+  List<Field> arguments;
 
   /// Whether the receiver of this method is expected to return synchronously or not.
   bool isAsynchronous;
@@ -50,7 +42,7 @@ class Method extends Node {
 
   @override
   String toString() {
-    return '(Api name:$name returnType:$returnType argType:$argType isAsynchronous:$isAsynchronous)';
+    return '(Api name:$name returnType:$returnType argType:$arguments isAsynchronous:$isAsynchronous)';
   }
 }
 
@@ -82,6 +74,30 @@ class Api extends Node {
   }
 }
 
+/// A parameter to a generic entity.  For example, "String" to "List<String>".
+class TypeArgument {
+  /// Constructor for [TypeArgument].
+  TypeArgument({
+    required this.dataType,
+    required this.isNullable,
+    this.typeArguments,
+  });
+
+  /// A string representation of the base datatype.
+  final String dataType;
+
+  /// The type arguments to this [TypeArgument].
+  final List<TypeArgument>? typeArguments;
+
+  /// True if the type is nullable.
+  final bool isNullable;
+
+  @override
+  String toString() {
+    return '(TypeArgument dataType:$dataType isNullable:$isNullable typeArguments:$typeArguments)';
+  }
+}
+
 /// Represents a field on a [Class].
 class Field extends Node {
   /// Parametric constructor for [Field].
@@ -106,11 +122,11 @@ class Field extends Node {
   bool isNullable;
 
   /// Type parameters used for generics.
-  List<Field>? typeArguments;
+  List<TypeArgument>? typeArguments;
 
   @override
   String toString() {
-    return '(Field name:$name dataType:$dataType)';
+    return '(Field name:$name dataType:$dataType typeArguments:$typeArguments)';
   }
 }
 

packages/pigeon/lib/dart_generator.dart

@@ -121,12 +121,12 @@ final BinaryMessenger$nullTag _binaryMessenger;
       }
       String argSignature = '';
       String sendArgument = 'null';
-      if (func.argType != 'void') {
-        argSignature = '${func.argType} arg';
+      if (func.arguments.isNotEmpty) {
+        argSignature = '${func.arguments[0].dataType} arg';
         sendArgument = 'arg';
       }
       indent.write(
-        'Future<${func.returnType}> ${func.name}($argSignature) async ',
+        'Future<${func.returnType.dataType}> ${func.name}($argSignature) async ',
       );
       indent.scoped('{', '}', () {
         final String channelName = makeChannelName(api, func);
@@ -137,9 +137,9 @@ final BinaryMessenger$nullTag _binaryMessenger;
             '\'$channelName\', codec, binaryMessenger: _binaryMessenger);',
           );
         });
-        final String returnStatement = func.returnType == 'void'
+        final String returnStatement = func.returnType.dataType == 'void'
             ? '// noop'
-            : 'return (replyMap[\'${Keys.result}\'] as ${func.returnType}$nullTag)$unwrapOperator;';
+            : 'return (replyMap[\'${Keys.result}\'] as ${func.returnType.dataType}$nullTag)$unwrapOperator;';
         indent.format('''
 final Map<Object$nullTag, Object$nullTag>$nullTag replyMap =\n\t\tawait channel.send($sendArgument) as Map<Object$nullTag, Object$nullTag>$nullTag;
 if (replyMap == null) {
@@ -181,10 +181,11 @@ void _writeFlutterApi(
     indent.addln('');
     for (final Method func in api.methods) {
       final bool isAsync = func.isAsynchronous;
-      final String returnType =
-          isAsync ? 'Future<${func.returnType}>' : func.returnType;
+      final String returnType = isAsync
+          ? 'Future<${func.returnType.dataType}>'
+          : func.returnType.dataType;
       final String argSignature =
-          func.argType == 'void' ? '' : '${func.argType} arg';
+          func.arguments.isEmpty ? '' : '${func.arguments[0].dataType} arg';
       indent.writeln('$returnType ${func.name}($argSignature);');
     }
     indent.write('static void setup(${api.name}$nullTag api) ');
@@ -215,19 +216,19 @@ void _writeFlutterApi(
               'channel.$messageHandlerSetter((Object$nullTag message) async ',
             );
             indent.scoped('{', '});', () {
-              final String argType = func.argType;
-              final String returnType = func.returnType;
+              final String returnType = func.returnType.dataType;
               final bool isAsync = func.isAsynchronous;
               final String emptyReturnStatement = isMockHandler
                   ? 'return <Object$nullTag, Object$nullTag>{};'
-                  : func.returnType == 'void'
+                  : func.returnType.dataType == 'void'
                       ? 'return;'
                       : 'return null;';
               String call;
-              if (argType == 'void') {
+              if (func.arguments.isEmpty) {
                 indent.writeln('// ignore message');
                 call = 'api.${func.name}()';
               } else {
+                final String argType = func.arguments[0].dataType;
                 indent.writeln(
                   'assert(message != null, \'Argument for $channelName was null. Expected $argType.\');',
                 );
@@ -263,14 +264,30 @@ void _writeFlutterApi(
   });
 }
 
-String _addGenericTypes(String dataType, String nullTag) {
-  switch (dataType) {
+/// Converts a [List] of [TypeArgument]s to a comma separated [String] to be
+/// used in Dart code.
+String _flattenTypeArguments(List<TypeArgument> args, String nullTag) {
+  return args
+      .map((TypeArgument arg) => arg.typeArguments == null
+          ? '${arg.dataType}$nullTag'
+          : '${arg.dataType}<${_flattenTypeArguments(arg.typeArguments!, nullTag)}>$nullTag')
+      .reduce((String value, String element) => '$value, $element');
+}
+
+/// Creates the type declaration for use in Dart code from a [Field] making sure
+/// that type arguments are used for primitive generic types.
+String _addGenericTypes(Field field, String nullTag) {
+  switch (field.dataType) {
     case 'List':
-      return 'List<Object$nullTag>$nullTag';
+      return (field.typeArguments == null)
+          ? 'List<Object$nullTag>$nullTag'
+          : 'List<${_flattenTypeArguments(field.typeArguments!, nullTag)}>$nullTag';
     case 'Map':
-      return 'Map<Object$nullTag, Object$nullTag>$nullTag';
+      return (field.typeArguments == null)
+          ? 'Map<Object$nullTag, Object$nullTag>$nullTag'
+          : 'Map<${_flattenTypeArguments(field.typeArguments!, nullTag)}>$nullTag';
     default:
-      return '$dataType$nullTag';
+      return '${field.dataType}$nullTag';
   }
 }
 
@@ -315,7 +332,7 @@ void generateDart(DartOptions opt, Root root, StringSink sink) {
     indent.write('class ${klass.name} ');
     indent.scoped('{', '}', () {
       for (final Field field in klass.fields) {
-        final String datatype = _addGenericTypes(field.dataType, nullTag);
+        final String datatype = _addGenericTypes(field, nullTag);
         indent.writeln('$datatype ${field.name};');
       }
       if (klass.fields.isNotEmpty) {
@@ -365,9 +382,13 @@ pigeonMap['${field.name}'] != null
 pigeonMap['${field.name}'] != null
 \t\t? ${field.dataType}.values[pigeonMap['${field.name}']$unwrapOperator as int]
 \t\t: null''', leadingSpace: false, trailingNewline: false);
+            } else if (field.dataType == 'Map' && field.typeArguments != null) {
+              indent.add(
+                '(pigeonMap[\'${field.name}\'] as Map<Object$nullTag, Object$nullTag>$nullTag)$nullTag.cast<${_flattenTypeArguments(field.typeArguments!, nullTag)}>()',
+              );
             } else {
               indent.add(
-                'pigeonMap[\'${field.name}\'] as ${_addGenericTypes(field.dataType, nullTag)}',
+                'pigeonMap[\'${field.name}\'] as ${_addGenericTypes(field, nullTag)}',
               );
             }
             indent.addln(index == klass.fields.length - 1 ? ';' : '');

packages/pigeon/lib/generator_tools.dart

@@ -159,9 +159,9 @@ class HostDatatype {
 /// `builtinResolver` will return the host datatype for the Dart datatype for
 /// builtin types.  `customResolver` can modify the datatype of custom types.
 HostDatatype getHostDatatype(Field field, List<Class> classes, List<Enum> enums,
-    String? Function(String) builtinResolver,
+    String? Function(Field) builtinResolver,
     {String Function(String)? customResolver}) {
-  final String? datatype = builtinResolver(field.dataType);
+  final String? datatype = builtinResolver(field);
   if (datatype == null) {
     if (classes.map((Class x) => x.name).contains(field.dataType)) {
       final String customName = customResolver != null
@@ -285,8 +285,10 @@ const int _minimumCodecFieldKey = 128;
 Iterable<EnumeratedClass> getCodecClasses(Api api) sync* {
   final Set<String> names = <String>{};
   for (final Method method in api.methods) {
-    names.add(method.returnType);
-    names.add(method.argType);
+    names.add(method.returnType.dataType);
+    if (method.arguments.isNotEmpty) {
+      names.add(method.arguments[0].dataType);
+    }
   }
   final List<String> sortedNames = names
       .where((String element) =>

packages/pigeon/lib/java_generator.dart

@@ -5,19 +5,6 @@
 import 'ast.dart';
 import 'generator_tools.dart';
 
-const Map<String, String> _javaTypeForDartTypeMap = <String, String>{
-  'bool': 'Boolean',
-  'int': 'Long',
-  'String': 'String',
-  'double': 'Double',
-  'Uint8List': 'byte[]',
-  'Int32List': 'int[]',
-  'Int64List': 'long[]',
-  'Float64List': 'double[]',
-  'List': 'List<Object>',
-  'Map': 'Map<Object, Object>',
-};
-
 /// Options that control how Java code will be generated.
 class JavaOptions {
   /// Creates a [JavaOptions] object
@@ -137,17 +124,19 @@ void _writeHostApi(Indent indent, Api api) {
   indent.write('public interface ${api.name} ');
   indent.scoped('{', '}', () {
     for (final Method method in api.methods) {
-      final String argType = _javaTypeForDartTypePassthrough(method.argType);
       final String returnType = method.isAsynchronous
           ? 'void'
-          : _javaTypeForDartTypePassthrough(method.returnType);
+          : _javaTypeForDartTypePassthrough(method.returnType.dataType);
       final List<String> argSignature = <String>[];
-      if (method.argType != 'void') {
+      if (method.arguments.isNotEmpty) {
+        final String argType =
+            _javaTypeForDartTypePassthrough(method.arguments[0].dataType);
         argSignature.add('$argType arg');
       }
       if (method.isAsynchronous) {
-        final String returnType =
-            method.returnType == 'void' ? 'Void' : method.returnType;
+        final String returnType = method.returnType.dataType == 'void'
+            ? 'Void'
+            : method.returnType.dataType;
         argSignature.add('Result<$returnType> result');
       }
       indent.writeln('$returnType ${method.name}(${argSignature.join(', ')});');
@@ -180,15 +169,15 @@ static MessageCodec<Object> getCodec() {
           indent.scoped('{', '} else {', () {
             indent.write('channel.setMessageHandler((message, reply) -> ');
             indent.scoped('{', '});', () {
-              final String argType =
-                  _javaTypeForDartTypePassthrough(method.argType);
               final String returnType =
-                  _javaTypeForDartTypePassthrough(method.returnType);
+                  _javaTypeForDartTypePassthrough(method.returnType.dataType);
               indent.writeln('Map<String, Object> wrapped = new HashMap<>();');
               indent.write('try ');
               indent.scoped('{', '}', () {
                 final List<String> methodArgument = <String>[];
-                if (argType != 'void') {
+                if (method.arguments.isNotEmpty) {
+                  final String argType = _javaTypeForDartTypePassthrough(
+                      method.arguments[0].dataType);
                   indent.writeln('@SuppressWarnings("ConstantConditions")');
                   indent.writeln('$argType input = ($argType)message;');
                   indent.write('if (input == null) ');
@@ -200,7 +189,7 @@ static MessageCodec<Object> getCodec() {
                 }
                 if (method.isAsynchronous) {
                   final String resultValue =
-                      method.returnType == 'void' ? 'null' : 'result';
+                      method.returnType.dataType == 'void' ? 'null' : 'result';
                   methodArgument.add(
                     'result -> { '
                     'wrapped.put("${Keys.result}", $resultValue); '
@@ -212,7 +201,7 @@ static MessageCodec<Object> getCodec() {
                     'api.${method.name}(${methodArgument.join(', ')})';
                 if (method.isAsynchronous) {
                   indent.writeln('$call;');
-                } else if (method.returnType == 'void') {
+                } else if (method.returnType.dataType == 'void') {
                   indent.writeln('$call;');
                   indent.writeln('wrapped.put("${Keys.result}", null);');
                 } else {
@@ -265,15 +254,16 @@ static MessageCodec<Object> getCodec() {
 ''');
     for (final Method func in api.methods) {
       final String channelName = makeChannelName(api, func);
-      final String returnType = func.returnType == 'void'
+      final String returnType = func.returnType.dataType == 'void'
           ? 'Void'
-          : _javaTypeForDartTypePassthrough(func.returnType);
-      final String argType = _javaTypeForDartTypePassthrough(func.argType);
+          : _javaTypeForDartTypePassthrough(func.returnType.dataType);
       String sendArgument;
-      if (func.argType == 'void') {
+      if (func.arguments.isEmpty) {
         indent.write('public void ${func.name}(Reply<$returnType> callback) ');
         sendArgument = 'null';
       } else {
+        final String argType =
+            _javaTypeForDartTypePassthrough(func.arguments[0].dataType);
         indent.write(
             'public void ${func.name}($argType argInput, Reply<$returnType> callback) ');
         sendArgument = 'argInput';
@@ -288,7 +278,7 @@ static MessageCodec<Object> getCodec() {
         indent.dec();
         indent.write('channel.send($sendArgument, channelReply -> ');
         indent.scoped('{', '});', () {
-          if (func.returnType == 'void') {
+          if (func.returnType.dataType == 'void') {
             indent.writeln('callback.reply(null);');
           } else {
             indent.writeln('@SuppressWarnings("ConstantConditions")');
@@ -313,8 +303,39 @@ String _makeSetter(Field field) {
   return 'set$uppercased';
 }
 
-String? _javaTypeForDartType(String datatype) {
-  return _javaTypeForDartTypeMap[datatype];
+/// Converts a [List] of [TypeArgument]s to a comma separated [String] to be
+/// used in Java code.
+String _flattenTypeArguments(List<TypeArgument> args) {
+  return args
+      .map((TypeArgument e) => e.typeArguments == null
+          ? _javaTypeForDartTypePassthrough(e.dataType)
+          : '${_javaTypeForDartTypePassthrough(e.dataType)}<${_flattenTypeArguments(e.typeArguments!)}>')
+      .reduce((String value, String element) => '$value, $element');
+}
+
+String? _javaTypeForDartType(Field field) {
+  const Map<String, String> javaTypeForDartTypeMap = <String, String>{
+    'bool': 'Boolean',
+    'int': 'Long',
+    'String': 'String',
+    'double': 'Double',
+    'Uint8List': 'byte[]',
+    'Int32List': 'int[]',
+    'Int64List': 'long[]',
+    'Float64List': 'double[]',
+    'Map': 'Map<Object, Object>',
+  };
+  if (javaTypeForDartTypeMap.containsKey(field.dataType)) {
+    return javaTypeForDartTypeMap[field.dataType];
+  } else if (field.dataType == 'List') {
+    if (field.typeArguments == null) {
+      return 'List<Object>';
+    } else {
+      return 'List<${_flattenTypeArguments(field.typeArguments!)}>';
+    }
+  } else {
+    return null;
+  }
 }
 
 String _castObject(