Skip to content

Commit caabb6f

Browse files
tarrinnealtarrinneal
authored
[pigeon] Adds package name to method channel. (#4443)
Adds package name to method channel name strings. The name can be added via command line, pigeon configuration, or automatically using `deducePackageName`. This pr also changes the `generate` function to format by default and adds an `n` command to not format if needed.
1 parent c649341 commit caabb6f

File tree

70 files changed

+4102
-1685
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+4102
-1685
lines changed

‎packages/pigeon/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 10.1.4
2+
3+
* Adds package name to method channel strings to avoid potential collisions between plugins.
4+
* Adds dartPackageName option to `pigeonOptions`.
5+
16
## 10.1.3
27

38
* Adds generic `Object` field support to data classes.

‎packages/pigeon/example/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ needed for your project.
3131
// Set this to a unique prefix for your plugin or application, per Objective-C naming conventions.
3232
objcOptions: ObjcOptions(prefix: 'PGN'),
3333
copyrightHeader: 'pigeons/copyright.txt',
34+
dartPackageName: 'pigeon_example_package',
3435
))
3536
```
3637
Then make a simple call to run pigeon on the Dart file containing your definitions.

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,9 @@ static void setup(@NonNull BinaryMessenger binaryMessenger, @Nullable ExampleHos
233233
{
234234
BasicMessageChannel<Object> channel =
235235
new BasicMessageChannel<>(
236-
binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.getHostLanguage", getCodec());
236+
binaryMessenger,
237+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage",
238+
getCodec());
237239
if (api != null) {
238240
channel.setMessageHandler(
239241
(message, reply) -> {
@@ -254,7 +256,9 @@ static void setup(@NonNull BinaryMessenger binaryMessenger, @Nullable ExampleHos
254256
{
255257
BasicMessageChannel<Object> channel =
256258
new BasicMessageChannel<>(
257-
binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.add", getCodec());
259+
binaryMessenger,
260+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add",
261+
getCodec());
258262
if (api != null) {
259263
channel.setMessageHandler(
260264
(message, reply) -> {
@@ -281,7 +285,9 @@ static void setup(@NonNull BinaryMessenger binaryMessenger, @Nullable ExampleHos
281285
{
282286
BasicMessageChannel<Object> channel =
283287
new BasicMessageChannel<>(
284-
binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.sendMessage", getCodec());
288+
binaryMessenger,
289+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage",
290+
getCodec());
285291
if (api != null) {
286292
channel.setMessageHandler(
287293
(message, reply) -> {
@@ -330,7 +336,9 @@ public interface Reply<T> {
330336
public void flutterMethod(@Nullable String aStringArg, @NonNull Reply<String> callback) {
331337
BasicMessageChannel<Object> channel =
332338
new BasicMessageChannel<>(
333-
binaryMessenger, "dev.flutter.pigeon.MessageFlutterApi.flutterMethod", getCodec());
339+
binaryMessenger,
340+
"dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod",
341+
getCodec());
334342
channel.send(
335343
new ArrayList<Object>(Collections.singletonList(aStringArg)),
336344
channelReply -> {

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ interface ExampleHostApi {
122122
@Suppress("UNCHECKED_CAST")
123123
fun setUp(binaryMessenger: BinaryMessenger, api: ExampleHostApi?) {
124124
run {
125-
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.getHostLanguage", codec)
125+
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage", codec)
126126
if (api != null) {
127127
channel.setMessageHandler { _, reply ->
128128
var wrapped: List<Any?>
@@ -138,7 +138,7 @@ interface ExampleHostApi {
138138
}
139139
}
140140
run {
141-
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.add", codec)
141+
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add", codec)
142142
if (api != null) {
143143
channel.setMessageHandler { message, reply ->
144144
val args = message as List<Any?>
@@ -157,7 +157,7 @@ interface ExampleHostApi {
157157
}
158158
}
159159
run {
160-
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.ExampleHostApi.sendMessage", codec)
160+
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage", codec)
161161
if (api != null) {
162162
channel.setMessageHandler { message, reply ->
163163
val args = message as List<Any?>
@@ -189,7 +189,7 @@ class MessageFlutterApi(private val binaryMessenger: BinaryMessenger) {
189189
}
190190
}
191191
fun flutterMethod(aStringArg: String?, callback: (String) -> Unit) {
192-
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.MessageFlutterApi.flutterMethod", codec)
192+
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod", codec)
193193
channel.send(listOf(aStringArg)) {
194194
val result = it as String
195195
callback(result)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ class ExampleHostApiSetup {
121121
static var codec: FlutterStandardMessageCodec { ExampleHostApiCodec.shared }
122122
/// Sets up an instance of `ExampleHostApi` to handle messages through the `binaryMessenger`.
123123
static func setUp(binaryMessenger: FlutterBinaryMessenger, api: ExampleHostApi?) {
124-
let getHostLanguageChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.ExampleHostApi.getHostLanguage", binaryMessenger: binaryMessenger, codec: codec)
124+
let getHostLanguageChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage", binaryMessenger: binaryMessenger, codec: codec)
125125
if let api = api {
126126
getHostLanguageChannel.setMessageHandler { _, reply in
127127
do {
@@ -134,7 +134,7 @@ class ExampleHostApiSetup {
134134
} else {
135135
getHostLanguageChannel.setMessageHandler(nil)
136136
}
137-
let addChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.ExampleHostApi.add", binaryMessenger: binaryMessenger, codec: codec)
137+
let addChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add", binaryMessenger: binaryMessenger, codec: codec)
138138
if let api = api {
139139
addChannel.setMessageHandler { message, reply in
140140
let args = message as! [Any?]
@@ -150,7 +150,7 @@ class ExampleHostApiSetup {
150150
} else {
151151
addChannel.setMessageHandler(nil)
152152
}
153-
let sendMessageChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.ExampleHostApi.sendMessage", binaryMessenger: binaryMessenger, codec: codec)
153+
let sendMessageChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage", binaryMessenger: binaryMessenger, codec: codec)
154154
if let api = api {
155155
sendMessageChannel.setMessageHandler { message, reply in
156156
let args = message as! [Any?]
@@ -176,7 +176,7 @@ class MessageFlutterApi {
176176
self.binaryMessenger = binaryMessenger
177177
}
178178
func flutterMethod(aString aStringArg: String?, completion: @escaping (String) -> Void) {
179-
let channel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.MessageFlutterApi.flutterMethod", binaryMessenger: binaryMessenger)
179+
let channel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod", binaryMessenger: binaryMessenger)
180180
channel.sendMessage([aStringArg] as [Any?]) { response in
181181
let result = response as! String
182182
completion(result)

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ class ExampleHostApi {
8787

8888
Future<String> getHostLanguage() async {
8989
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
90-
'dev.flutter.pigeon.ExampleHostApi.getHostLanguage', codec,
90+
'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage',
91+
codec,
9192
binaryMessenger: _binaryMessenger);
9293
final List<Object?>? replyList = await channel.send(null) as List<Object?>?;
9394
if (replyList == null) {
@@ -113,7 +114,7 @@ class ExampleHostApi {
113114

114115
Future<int> add(int arg_a, int arg_b) async {
115116
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
116-
'dev.flutter.pigeon.ExampleHostApi.add', codec,
117+
'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add', codec,
117118
binaryMessenger: _binaryMessenger);
118119
final List<Object?>? replyList =
119120
await channel.send(<Object?>[arg_a, arg_b]) as List<Object?>?;
@@ -140,7 +141,8 @@ class ExampleHostApi {
140141

141142
Future<bool> sendMessage(MessageData arg_message) async {
142143
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
143-
'dev.flutter.pigeon.ExampleHostApi.sendMessage', codec,
144+
'dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage',
145+
codec,
144146
binaryMessenger: _binaryMessenger);
145147
final List<Object?>? replyList =
146148
await channel.send(<Object?>[arg_message]) as List<Object?>?;
@@ -175,14 +177,15 @@ abstract class MessageFlutterApi {
175177
{BinaryMessenger? binaryMessenger}) {
176178
{
177179
final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
178-
'dev.flutter.pigeon.MessageFlutterApi.flutterMethod', codec,
180+
'dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod',
181+
codec,
179182
binaryMessenger: binaryMessenger);
180183
if (api == null) {
181184
channel.setMessageHandler(null);
182185
} else {
183186
channel.setMessageHandler((Object? message) async {
184187
assert(message != null,
185-
'Argument for dev.flutter.pigeon.MessageFlutterApi.flutterMethod was null.');
188+
'Argument for dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod was null.');
186189
final List<Object?> args = (message as List<Object?>?)!;
187190
final String? arg_aString = (args[0] as String?);
188191
final String output = api.flutterMethod(arg_aString);

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ void PGNExampleHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
121121
NSObject<PGNExampleHostApi> *api) {
122122
{
123123
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
124-
initWithName:@"dev.flutter.pigeon.ExampleHostApi.getHostLanguage"
124+
initWithName:@"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.getHostLanguage"
125125
binaryMessenger:binaryMessenger
126126
codec:PGNExampleHostApiGetCodec()];
127127
if (api) {
@@ -139,10 +139,10 @@ void PGNExampleHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
139139
}
140140
}
141141
{
142-
FlutterBasicMessageChannel *channel =
143-
[[FlutterBasicMessageChannel alloc] initWithName:@"dev.flutter.pigeon.ExampleHostApi.add"
144-
binaryMessenger:binaryMessenger
145-
codec:PGNExampleHostApiGetCodec()];
142+
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
143+
initWithName:@"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add"
144+
binaryMessenger:binaryMessenger
145+
codec:PGNExampleHostApiGetCodec()];
146146
if (api) {
147147
NSCAssert(
148148
[api respondsToSelector:@selector(addNumber:toNumber:error:)],
@@ -162,7 +162,7 @@ void PGNExampleHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
162162
}
163163
{
164164
FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
165-
initWithName:@"dev.flutter.pigeon.ExampleHostApi.sendMessage"
165+
initWithName:@"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage"
166166
binaryMessenger:binaryMessenger
167167
codec:PGNExampleHostApiGetCodec()];
168168
if (api) {
@@ -205,7 +205,8 @@ - (instancetype)initWithBinaryMessenger:(NSObject<FlutterBinaryMessenger> *)bina
205205
- (void)flutterMethodAString:(nullable NSString *)arg_aString
206206
completion:(void (^)(NSString *_Nullable, FlutterError *_Nullable))completion {
207207
FlutterBasicMessageChannel *channel = [FlutterBasicMessageChannel
208-
messageChannelWithName:@"dev.flutter.pigeon.MessageFlutterApi.flutterMethod"
208+
messageChannelWithName:
209+
@"dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi.flutterMethod"
209210
binaryMessenger:self.binaryMessenger
210211
codec:PGNMessageFlutterApiGetCodec()];
211212
[channel sendMessage:@[ arg_aString ?: [NSNull null] ]

‎packages/pigeon/example/app/pigeons/messages.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import 'package:pigeon/pigeon.dart';
2323
// Set this to a unique prefix for your plugin or application, per Objective-C naming conventions.
2424
objcOptions: ObjcOptions(prefix: 'PGN'),
2525
copyrightHeader: 'pigeons/copyright.txt',
26+
dartPackageName: 'pigeon_example_package',
2627
))
2728
// #enddocregion config
2829

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,9 @@ void ExampleHostApi::SetUp(flutter::BinaryMessenger* binary_messenger,
135135
ExampleHostApi* api) {
136136
{
137137
auto channel = std::make_unique<BasicMessageChannel<>>(
138-
binary_messenger, "dev.flutter.pigeon.ExampleHostApi.getHostLanguage",
138+
binary_messenger,
139+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi."
140+
"getHostLanguage",
139141
&GetCodec());
140142
if (api != nullptr) {
141143
channel->SetMessageHandler(
@@ -160,7 +162,9 @@ void ExampleHostApi::SetUp(flutter::BinaryMessenger* binary_messenger,
160162
}
161163
{
162164
auto channel = std::make_unique<BasicMessageChannel<>>(
163-
binary_messenger, "dev.flutter.pigeon.ExampleHostApi.add", &GetCodec());
165+
binary_messenger,
166+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.add",
167+
&GetCodec());
164168
if (api != nullptr) {
165169
channel->SetMessageHandler(
166170
[api](const EncodableValue& message,
@@ -197,7 +201,8 @@ void ExampleHostApi::SetUp(flutter::BinaryMessenger* binary_messenger,
197201
}
198202
{
199203
auto channel = std::make_unique<BasicMessageChannel<>>(
200-
binary_messenger, "dev.flutter.pigeon.ExampleHostApi.sendMessage",
204+
binary_messenger,
205+
"dev.flutter.pigeon.pigeon_example_package.ExampleHostApi.sendMessage",
201206
&GetCodec());
202207
if (api != nullptr) {
203208
channel->SetMessageHandler(
@@ -259,7 +264,9 @@ void MessageFlutterApi::FlutterMethod(
259264
std::function<void(const std::string&)>&& on_success,
260265
std::function<void(const FlutterError&)>&& on_error) {
261266
auto channel = std::make_unique<BasicMessageChannel<>>(
262-
binary_messenger_, "dev.flutter.pigeon.MessageFlutterApi.flutterMethod",
267+
binary_messenger_,
268+
"dev.flutter.pigeon.pigeon_example_package.MessageFlutterApi."
269+
"flutterMethod",
263270
&GetCodec());
264271
EncodableValue encoded_api_arguments = EncodableValue(EncodableList{
265272
a_string_arg ? EncodableValue(*a_string_arg) : EncodableValue(),

0 commit comments

Comments
 (0)