change internal prefix names and add more tests to avoid conflicts

Author: tarrinneal

packages/pigeon/example/app/android/app/src/main/java/io/flutter/plugins/Messages.java

@@ -207,15 +207,15 @@ ArrayList<Object> toList() {
       return toListResult;
     }
 
-    static @NonNull MessageData fromList(@NonNull ArrayList<Object> __pigeon_list) {
+    static @NonNull MessageData fromList(@NonNull ArrayList<Object> pigeon_list) {
       MessageData pigeonResult = new MessageData();
-      Object name = __pigeon_list.get(0);
+      Object name = pigeon_list.get(0);
       pigeonResult.setName((String) name);
-      Object description = __pigeon_list.get(1);
+      Object description = pigeon_list.get(1);
       pigeonResult.setDescription((String) description);
-      Object code = __pigeon_list.get(2);
+      Object code = pigeon_list.get(2);
       pigeonResult.setCode((Code) code);
-      Object data = __pigeon_list.get(3);
+      Object data = pigeon_list.get(3);
       pigeonResult.setData((Map<String, String>) data);
       return pigeonResult;
     }

packages/pigeon/example/app/android/app/src/main/kotlin/dev/flutter/pigeon_example_app/Messages.g.kt

@@ -66,11 +66,11 @@ data class MessageData(
 ) {
   companion object {
     @Suppress("LocalVariableName")
-    fun fromList(__pigeon_list: List<Any?>): MessageData {
-      val name = __pigeon_list[0] as String?
-      val description = __pigeon_list[1] as String?
-      val code = __pigeon_list[2] as Code
-      val data = __pigeon_list[3] as Map<String?, String?>
+    fun fromList(pigeon_list: List<Any?>): MessageData {
+      val name = pigeon_list[0] as String?
+      val description = pigeon_list[1] as String?
+      val code = pigeon_list[2] as Code
+      val data = pigeon_list[3] as Map<String?, String?>
       return MessageData(name, description, code, data)
     }
   }

packages/pigeon/example/app/ios/Runner/Messages.g.swift

@@ -86,11 +86,11 @@ struct MessageData {
   var data: [String?: String?]
 
   // swift-format-ignore: AlwaysUseLowerCamelCase
-  static func fromList(_ __pigeon_list: [Any?]) -> MessageData? {
-    let name: String? = nilOrValue(__pigeon_list[0])
-    let description: String? = nilOrValue(__pigeon_list[1])
-    let code = __pigeon_list[2] as! Code
-    let data = __pigeon_list[3] as! [String?: String?]
+  static func fromList(_ pigeon_list: [Any?]) -> MessageData? {
+    let name: String? = nilOrValue(pigeon_list[0])
+    let description: String? = nilOrValue(pigeon_list[1])
+    let code = pigeon_list[2] as! Code
+    let data = pigeon_list[3] as! [String?: String?]
 
     return MessageData(
       name: name,
@@ -113,12 +113,11 @@ private class MessagesPigeonCodecReader: FlutterStandardReader {
   override func readValue(ofType type: UInt8) -> Any? {
     switch type {
     case 129:
-      var enumResult: Code? = nil
       let enumResultAsInt: Int? = nilOrValue(self.readValue() as? Int)
       if let enumResultAsInt = enumResultAsInt {
-        enumResult = Code(rawValue: enumResultAsInt)
+        return Code(rawValue: enumResultAsInt)
       }
-      return enumResult
+      return nil
     case 130:
       return MessageData.fromList(self.readValue() as! [Any?])
     default:

packages/pigeon/example/app/lib/src/messages.g.dart

@@ -105,99 +105,99 @@ class ExampleHostApi {
   /// BinaryMessenger will be used which routes to the host platform.
   ExampleHostApi(
       {BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
-      : __pigeon_binaryMessenger = binaryMessenger,
-        __pigeon_messageChannelSuffix =
+      : pigeon_binaryMessenger = binaryMessenger,
+        pigeon_messageChannelSuffix =
             messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
-  final BinaryMessenger? __pigeon_binaryMessenger;
+  final BinaryMessenger? pigeon_binaryMessenger;
 
   static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
 
-  final String __pigeon_messageChannelSuffix;
+  final String pigeon_messageChannelSuffix;
 
   Future<String> getHostLanguage() async {
-    final String __pigeon_channelName =
-        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage$__pigeon_messageChannelSuffix';
-    final BasicMessageChannel<Object?> __pigeon_channel =
+    final String pigeon_channelName =
+        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage$pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeon_channel =
         BasicMessageChannel<Object?>(
-      __pigeon_channelName,
+      pigeon_channelName,
       pigeonChannelCodec,
-      binaryMessenger: __pigeon_binaryMessenger,
+      binaryMessenger: pigeon_binaryMessenger,
     );
-    final List<Object?>? __pigeon_replyList =
-        await __pigeon_channel.send(null) as List<Object?>?;
-    if (__pigeon_replyList == null) {
-      throw _createConnectionError(__pigeon_channelName);
-    } else if (__pigeon_replyList.length > 1) {
+    final List<Object?>? pigeon_replyList =
+        await pigeon_channel.send(null) as List<Object?>?;
+    if (pigeon_replyList == null) {
+      throw _createConnectionError(pigeon_channelName);
+    } else if (pigeon_replyList.length > 1) {
       throw PlatformException(
-        code: __pigeon_replyList[0]! as String,
-        message: __pigeon_replyList[1] as String?,
-        details: __pigeon_replyList[2],
+        code: pigeon_replyList[0]! as String,
+        message: pigeon_replyList[1] as String?,
+        details: pigeon_replyList[2],
       );
-    } else if (__pigeon_replyList[0] == null) {
+    } else if (pigeon_replyList[0] == null) {
       throw PlatformException(
         code: 'null-error',
         message: 'Host platform returned null value for non-null return value.',
       );
     } else {
-      return (__pigeon_replyList[0] as String?)!;
+      return (pigeon_replyList[0] as String?)!;
     }
   }
 
   Future<int> add(int a, int b) async {
-    final String __pigeon_channelName =
-        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add$__pigeon_messageChannelSuffix';
-    final BasicMessageChannel<Object?> __pigeon_channel =
+    final String pigeon_channelName =
+        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add$pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeon_channel =
         BasicMessageChannel<Object?>(
-      __pigeon_channelName,
+      pigeon_channelName,
       pigeonChannelCodec,
-      binaryMessenger: __pigeon_binaryMessenger,
+      binaryMessenger: pigeon_binaryMessenger,
     );
-    final List<Object?>? __pigeon_replyList =
-        await __pigeon_channel.send(<Object?>[a, b]) as List<Object?>?;
-    if (__pigeon_replyList == null) {
-      throw _createConnectionError(__pigeon_channelName);
-    } else if (__pigeon_replyList.length > 1) {
+    final List<Object?>? pigeon_replyList =
+        await pigeon_channel.send(<Object?>[a, b]) as List<Object?>?;
+    if (pigeon_replyList == null) {
+      throw _createConnectionError(pigeon_channelName);
+    } else if (pigeon_replyList.length > 1) {
       throw PlatformException(
-        code: __pigeon_replyList[0]! as String,
-        message: __pigeon_replyList[1] as String?,
-        details: __pigeon_replyList[2],
+        code: pigeon_replyList[0]! as String,
+        message: pigeon_replyList[1] as String?,
+        details: pigeon_replyList[2],
       );
-    } else if (__pigeon_replyList[0] == null) {
+    } else if (pigeon_replyList[0] == null) {
       throw PlatformException(
         code: 'null-error',
         message: 'Host platform returned null value for non-null return value.',
       );
     } else {
-      return (__pigeon_replyList[0] as int?)!;
+      return (pigeon_replyList[0] as int?)!;
     }
   }
 
   Future<bool> sendMessage(MessageData message) async {
-    final String __pigeon_channelName =
-        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage$__pigeon_messageChannelSuffix';
-    final BasicMessageChannel<Object?> __pigeon_channel =
+    final String pigeon_channelName =
+        'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage$pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> pigeon_channel =
         BasicMessageChannel<Object?>(
-      __pigeon_channelName,
+      pigeon_channelName,
       pigeonChannelCodec,
-      binaryMessenger: __pigeon_binaryMessenger,
+      binaryMessenger: pigeon_binaryMessenger,
     );
-    final List<Object?>? __pigeon_replyList =
-        await __pigeon_channel.send(<Object?>[message]) as List<Object?>?;
-    if (__pigeon_replyList == null) {
-      throw _createConnectionError(__pigeon_channelName);
-    } else if (__pigeon_replyList.length > 1) {
+    final List<Object?>? pigeon_replyList =
+        await pigeon_channel.send(<Object?>[message]) as List<Object?>?;
+    if (pigeon_replyList == null) {
+      throw _createConnectionError(pigeon_channelName);
+    } else if (pigeon_replyList.length > 1) {
       throw PlatformException(
-        code: __pigeon_replyList[0]! as String,
-        message: __pigeon_replyList[1] as String?,
-        details: __pigeon_replyList[2],
+        code: pigeon_replyList[0]! as String,
+        message: pigeon_replyList[1] as String?,
+        details: pigeon_replyList[2],
       );
-    } else if (__pigeon_replyList[0] == null) {
+    } else if (pigeon_replyList[0] == null) {
       throw PlatformException(
         code: 'null-error',
         message: 'Host platform returned null value for non-null return value.',
       );
     } else {
-      return (__pigeon_replyList[0] as bool?)!;
+      return (pigeon_replyList[0] as bool?)!;
     }
   }
 }
@@ -215,15 +215,15 @@ abstract class MessageFlutterApi {
     messageChannelSuffix =
         messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
     {
-      final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<
+      final BasicMessageChannel<Object?> pigeon_channel = BasicMessageChannel<
               Object?>(
           'dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod$messageChannelSuffix',
           pigeonChannelCodec,
           binaryMessenger: binaryMessenger);
       if (api == null) {
-        __pigeon_channel.setMessageHandler(null);
+        pigeon_channel.setMessageHandler(null);
       } else {
-        __pigeon_channel.setMessageHandler((Object? message) async {
+        pigeon_channel.setMessageHandler((Object? message) async {
           assert(message != null,
               'Argument for dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod was null.');
           final List<Object?> args = (message as List<Object?>?)!;

packages/pigeon/example/app/macos/Runner/messages.g.m

@@ -71,8 +71,8 @@ + (PGNMessageData *)fromList:(NSArray<id> *)list {
   PGNMessageData *pigeonResult = [[PGNMessageData alloc] init];
   pigeonResult.name = GetNullableObjectAtIndex(list, 0);
   pigeonResult.description = GetNullableObjectAtIndex(list, 1);
-  PGNCodeBox *anPGNCodeBox = GetNullableObjectAtIndex(list, 2);
-  pigeonResult.code = anPGNCodeBox.value;
+  PGNCodeBox *boxedPGNCode = GetNullableObjectAtIndex(list, 2);
+  pigeonResult.code = boxedPGNCode.value;
   pigeonResult.data = GetNullableObjectAtIndex(list, 3);
   return pigeonResult;
 }

packages/pigeon/example/app/windows/runner/messages.g.cpp

@@ -102,9 +102,9 @@ MessageData MessageData::FromEncodableList(const EncodableList& list) {
   return decoded;
 }
 
-PigeonCodecSerializer::PigeonCodecSerializer() {}
+PigeonInternalCodecSerializer::PigeonInternalCodecSerializer() {}
 
-EncodableValue PigeonCodecSerializer::ReadValueOfType(
+EncodableValue PigeonInternalCodecSerializer::ReadValueOfType(
     uint8_t type, flutter::ByteStreamReader* stream) const {
   switch (type) {
     case 129: {
@@ -124,7 +124,7 @@ EncodableValue PigeonCodecSerializer::ReadValueOfType(
   }
 }
 
-void PigeonCodecSerializer::WriteValue(
+void PigeonInternalCodecSerializer::WriteValue(
     const EncodableValue& value, flutter::ByteStreamWriter* stream) const {
   if (const CustomEncodableValue* custom_value =
           std::get_if<CustomEncodableValue>(&value)) {
@@ -150,7 +150,7 @@ void PigeonCodecSerializer::WriteValue(
 /// The codec used by ExampleHostApi.
 const flutter::StandardMessageCodec& ExampleHostApi::GetCodec() {
   return flutter::StandardMessageCodec::GetInstance(
-      &PigeonCodecSerializer::GetInstance());
+      &PigeonInternalCodecSerializer::GetInstance());
 }
 
 // Sets up an instance of `ExampleHostApi` to handle messages through the
@@ -299,7 +299,7 @@ MessageFlutterApi::MessageFlutterApi(flutter::BinaryMessenger* binary_messenger,
 
 const flutter::StandardMessageCodec& MessageFlutterApi::GetCodec() {
   return flutter::StandardMessageCodec::GetInstance(
-      &PigeonCodecSerializer::GetInstance());
+      &PigeonInternalCodecSerializer::GetInstance());
 }
 
 void MessageFlutterApi::FlutterMethod(

packages/pigeon/example/app/windows/runner/messages.g.h

@@ -90,18 +90,18 @@ class MessageData {
   flutter::EncodableList ToEncodableList() const;
   friend class ExampleHostApi;
   friend class MessageFlutterApi;
-  friend class PigeonCodecSerializer;
+  friend class PigeonInternalCodecSerializer;
   std::optional<std::string> name_;
   std::optional<std::string> description_;
   Code code_;
   flutter::EncodableMap data_;
 };
 
-class PigeonCodecSerializer : public flutter::StandardCodecSerializer {
+class PigeonInternalCodecSerializer : public flutter::StandardCodecSerializer {
  public:
-  PigeonCodecSerializer();
-  inline static PigeonCodecSerializer& GetInstance() {
-    static PigeonCodecSerializer sInstance;
+  PigeonInternalCodecSerializer();
+  inline static PigeonInternalCodecSerializer& GetInstance() {
+    static PigeonInternalCodecSerializer sInstance;
     return sInstance;
   }
 

packages/pigeon/lib/cpp_generator.dart

@@ -21,9 +21,9 @@ const DocumentCommentSpecification _docCommentSpec =
 const String _standardCodecSerializer = 'flutter::StandardCodecSerializer';
 
 /// The name of the codec serializer.
-const String _codecSerializerName = 'PigeonCodecSerializer';
+const String _codecSerializerName = '${classNamePrefix}CodecSerializer';
 
-const String _overflowClassName = '${varNamePrefix}CodecOverflow';
+const String _overflowClassName = '${classNamePrefix}CodecOverflow';
 
 final NamedType _overflowType = NamedType(
     name: 'type',
@@ -255,7 +255,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
         indent,
         _overflowClass,
         dartPackageName: dartPackageName,
-        overflow: true,
+        isOverflowClass: true,
       );
     }
   }
@@ -267,7 +267,7 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
     Indent indent,
     Class classDefinition, {
     required String dartPackageName,
-    bool overflow = false,
+    bool isOverflowClass = false,
   }) {
     // When generating for a Pigeon unit test, add a test fixture friend class to
     // allow unit testing private methods, since testing serialization via public
@@ -364,17 +364,18 @@ class CppHeaderGenerator extends StructuredGenerator<CppOptions> {
 
       _writeAccessBlock(indent, _ClassAccess.private, () {
         _writeFunctionDeclaration(indent, 'FromEncodableList',
-            returnType:
-                overflow ? 'flutter::EncodableValue' : classDefinition.name,
+            returnType: isOverflowClass
+                ? 'flutter::EncodableValue'
+                : classDefinition.name,
             parameters: <String>['const flutter::EncodableList& list'],
             isStatic: true);
         _writeFunctionDeclaration(indent, 'ToEncodableList',
             returnType: 'flutter::EncodableList', isConst: true);
-        if (overflow) {
+        if (isOverflowClass) {
           _writeFunctionDeclaration(indent, 'Unwrap',
               returnType: 'flutter::EncodableValue');
         }
-        if (!overflow && root.requiresOverflowClass) {
+        if (!isOverflowClass && root.requiresOverflowClass) {
           indent.writeln('friend class $_overflowClassName;');
         }
         for (final Class friend in root.classes) {
@@ -952,14 +953,14 @@ class CppSourceGenerator extends StructuredGenerator<CppOptions> {
     );
 
     indent.format('''
-EncodableValue __pigeon_CodecOverflow::FromEncodableList(
+EncodableValue $_overflowClassName::FromEncodableList(
     const EncodableList& list) {
-  return __pigeon_CodecOverflow(list[0].LongValue(),
+  return $_overflowClassName(list[0].LongValue(),
                                 list[1].IsNull() ? EncodableValue() : list[1])
       .Unwrap();
 }''');
 
-    indent.writeScoped('EncodableValue __pigeon_CodecOverflow::Unwrap() {', '}',
+    indent.writeScoped('EncodableValue $_overflowClassName::Unwrap() {', '}',
         () {
       indent.writeScoped('if (wrapped_.IsNull()) {', '}', () {
         indent.writeln('return EncodableValue();');