updated add_to_app sample to pigeon 1.0 (#894)

2026-04-04 02:32:25 +00:00 · 2021-09-08 11:07:11 -07:00
parent 69abb6146a
commit e43698fa01
10 changed files with 673 additions and 184 deletions
--- a/add_to_app/books/flutter_module_books/lib/api.dart
+++ b/add_to_app/books/flutter_module_books/lib/api.dart
@@ -1,61 +1,107 @@
-// Autogenerated from Pigeon (v0.1.17), do not edit directly.
+// Autogenerated from Pigeon (v1.0.1), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
-// ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import
-// @dart = 2.8
+// 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
+// @dart = 2.12
 import 'dart:async';
 import 'dart:typed_data' show Uint8List, Int32List, Int64List, Float64List;

+import 'package:flutter/foundation.dart' show WriteBuffer, ReadBuffer;
 import 'package:flutter/services.dart';

 class Book {
-  String title;
-  String subtitle;
-  String author;
-  String summary;
-  String publishDate;
-  int pageCount;
+  String? title;
+  String? subtitle;
+  String? author;
+  String? summary;
+  String? publishDate;
+  int? pageCount;
+  Thumbnail? thumbnail;

-  // ignore: unused_element
  Object encode() {
-    final Map<Object, Object> pigeonMap = <Object, Object>{};
+    final Map<Object?, Object?> pigeonMap = <Object?, Object?>{};
    pigeonMap['title'] = title;
    pigeonMap['subtitle'] = subtitle;
    pigeonMap['author'] = author;
    pigeonMap['summary'] = summary;
    pigeonMap['publishDate'] = publishDate;
    pigeonMap['pageCount'] = pageCount;
+    pigeonMap['thumbnail'] = thumbnail == null ? null : thumbnail!.encode();
    return pigeonMap;
  }

-  // ignore: unused_element
  static Book decode(Object message) {
-    final Map<Object, Object> pigeonMap = message as Map<Object, Object>;
+    final Map<Object?, Object?> pigeonMap = message as Map<Object?, Object?>;
    return Book()
-      ..title = pigeonMap['title'] as String
-      ..subtitle = pigeonMap['subtitle'] as String
-      ..author = pigeonMap['author'] as String
-      ..summary = pigeonMap['summary'] as String
-      ..publishDate = pigeonMap['publishDate'] as String
-      ..pageCount = pigeonMap['pageCount'] as int;
+      ..title = pigeonMap['title'] as String?
+      ..subtitle = pigeonMap['subtitle'] as String?
+      ..author = pigeonMap['author'] as String?
+      ..summary = pigeonMap['summary'] as String?
+      ..publishDate = pigeonMap['publishDate'] as String?
+      ..pageCount = pigeonMap['pageCount'] as int?
+      ..thumbnail = pigeonMap['thumbnail'] != null
+          ? Thumbnail.decode(pigeonMap['thumbnail']!)
+          : null;
+  }
+}
+
+class Thumbnail {
+  String? url;
+
+  Object encode() {
+    final Map<Object?, Object?> pigeonMap = <Object?, Object?>{};
+    pigeonMap['url'] = url;
+    return pigeonMap;
+  }
+
+  static Thumbnail decode(Object message) {
+    final Map<Object?, Object?> pigeonMap = message as Map<Object?, Object?>;
+    return Thumbnail()..url = pigeonMap['url'] as String?;
+  }
+}
+
+class _FlutterBookApiCodec extends StandardMessageCodec {
+  const _FlutterBookApiCodec();
+  @override
+  void writeValue(WriteBuffer buffer, Object? value) {
+    if (value is Book) {
+      buffer.putUint8(128);
+      writeValue(buffer, value.encode());
+    } else {
+      super.writeValue(buffer, value);
+    }
+  }
+
+  @override
+  Object? readValueOfType(int type, ReadBuffer buffer) {
+    switch (type) {
+      case 128:
+        return Book.decode(readValue(buffer)!);
+
+      default:
+        return super.readValueOfType(type, buffer);
+    }
  }
 }

 abstract class FlutterBookApi {
+  static const MessageCodec<Object?> codec = _FlutterBookApiCodec();
+
  void displayBookDetails(Book book);
-  static void setup(FlutterBookApi api) {
+  static void setup(FlutterBookApi? api) {
    {
-      const BasicMessageChannel<Object> channel = BasicMessageChannel<Object>(
-          'dev.flutter.pigeon.FlutterBookApi.displayBookDetails',
-          StandardMessageCodec());
+      const BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.FlutterBookApi.displayBookDetails', codec);
      if (api == null) {
        channel.setMessageHandler(null);
      } else {
-        channel.setMessageHandler((message) async {
-          if (message == null) {
-            return;
-          }
-          final Book input = Book.decode(message);
-          api.displayBookDetails(input);
+        channel.setMessageHandler((Object? message) async {
+          assert(message != null,
+              'Argument for dev.flutter.pigeon.FlutterBookApi.displayBookDetails was null.');
+          final List<Object?> args = (message as List<Object?>?)!;
+          final Book? arg_book = args[0] as Book?;
+          assert(arg_book != null,
+              'Argument for dev.flutter.pigeon.FlutterBookApi.displayBookDetails was null, expected non-null Book.');
+          api.displayBookDetails(arg_book!);
          return;
        });
      }
@@ -63,38 +109,47 @@ abstract class FlutterBookApi {
  }
 }

-class HostBookApi {
-  Future<void> cancel() async {
-    const BasicMessageChannel<Object> channel = BasicMessageChannel<Object>(
-        'dev.flutter.pigeon.HostBookApi.cancel', StandardMessageCodec());
-    final Map<Object, Object> replyMap =
-        await channel.send(null) as Map<Object, Object>;
-    if (replyMap == null) {
-      throw PlatformException(
-        code: 'channel-error',
-        message: 'Unable to establish connection on channel.',
-        details: null,
-      );
-    } else if (replyMap['error'] != null) {
-      final Map<Object, Object> error =
-          replyMap['error'] as Map<Object, Object>;
-      throw PlatformException(
-        code: error['code'] as String,
-        message: error['message'] as String,
-        details: error['details'],
-      );
+class _HostBookApiCodec extends StandardMessageCodec {
+  const _HostBookApiCodec();
+  @override
+  void writeValue(WriteBuffer buffer, Object? value) {
+    if (value is Book) {
+      buffer.putUint8(128);
+      writeValue(buffer, value.encode());
    } else {
-      // noop
+      super.writeValue(buffer, value);
    }
  }

-  Future<void> finishEditingBook(Book arg) async {
-    final Object encoded = arg.encode();
-    const BasicMessageChannel<Object> channel = BasicMessageChannel<Object>(
-        'dev.flutter.pigeon.HostBookApi.finishEditingBook',
-        StandardMessageCodec());
-    final Map<Object, Object> replyMap =
-        await channel.send(encoded) as Map<Object, Object>;
+  @override
+  Object? readValueOfType(int type, ReadBuffer buffer) {
+    switch (type) {
+      case 128:
+        return Book.decode(readValue(buffer)!);
+
+      default:
+        return super.readValueOfType(type, buffer);
+    }
+  }
+}
+
+class HostBookApi {
+  /// Constructor for [HostBookApi].  The [binaryMessenger] named argument is
+  /// available for dependency injection.  If it is left null, the default
+  /// BinaryMessenger will be used which routes to the host platform.
+  HostBookApi({BinaryMessenger? binaryMessenger})
+      : _binaryMessenger = binaryMessenger;
+
+  final BinaryMessenger? _binaryMessenger;
+
+  static const MessageCodec<Object?> codec = _HostBookApiCodec();
+
+  Future<void> cancel() async {
+    final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+        'dev.flutter.pigeon.HostBookApi.cancel', codec,
+        binaryMessenger: _binaryMessenger);
+    final Map<Object?, Object?>? replyMap =
+        await channel.send(null) as Map<Object?, Object?>?;
    if (replyMap == null) {
      throw PlatformException(
        code: 'channel-error',
@@ -102,15 +157,40 @@ class HostBookApi {
        details: null,
      );
    } else if (replyMap['error'] != null) {
-      final Map<Object, Object> error =
-          replyMap['error'] as Map<Object, Object>;
+      final Map<Object?, Object?> error =
+          (replyMap['error'] as Map<Object?, Object?>?)!;
      throw PlatformException(
-        code: error['code'] as String,
-        message: error['message'] as String,
+        code: (error['code'] as String?)!,
+        message: error['message'] as String?,
        details: error['details'],
      );
    } else {
-      // noop
+      return;
+    }
+  }
+
+  Future<void> finishEditingBook(Book arg_book) async {
+    final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+        'dev.flutter.pigeon.HostBookApi.finishEditingBook', codec,
+        binaryMessenger: _binaryMessenger);
+    final Map<Object?, Object?>? replyMap =
+        await channel.send(<Object>[arg_book]) as Map<Object?, Object?>?;
+    if (replyMap == null) {
+      throw PlatformException(
+        code: 'channel-error',
+        message: 'Unable to establish connection on channel.',
+        details: null,
+      );
+    } else if (replyMap['error'] != null) {
+      final Map<Object?, Object?> error =
+          (replyMap['error'] as Map<Object?, Object?>?)!;
+      throw PlatformException(
+        code: (error['code'] as String?)!,
+        message: error['message'] as String?,
+        details: error['details'],
+      );
+    } else {
+      return;
    }
  }
 }
--- a/add_to_app/books/flutter_module_books/pigeon/schema.dart
+++ b/add_to_app/books/flutter_module_books/pigeon/schema.dart
@@ -11,14 +11,12 @@ class Book {
  String summary;
  String publishDate;
  int pageCount;
-  // Thumbnail thumbnail;
+  Thumbnail thumbnail;
 }

-// TODO(gaaclarke): add this back when the https://github.com/flutter/flutter/issues/58896
-// crash is resolved.
-// class Thumbnail {
-//   String url;
-// }
+class Thumbnail {
+  String url;
+}

@FlutterApi()
 abstract class FlutterBookApi {
--- a/add_to_app/books/flutter_module_books/pubspec.lock
+++ b/add_to_app/books/flutter_module_books/pubspec.lock
@@ -1,20 +1,34 @@
 # Generated by pub
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages:
+  _fe_analyzer_shared:
+    dependency: transitive
+    description:
+      name: _fe_analyzer_shared
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "22.0.0"
+  analyzer:
+    dependency: transitive
+    description:
+      name: analyzer
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.7.2"
  args:
    dependency: transitive
    description:
      name: args
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.6.0"
+    version: "2.2.0"
  async:
    dependency: transitive
    description:
      name: async
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "2.6.1"
+    version: "2.8.2"
  boolean_selector:
    dependency: transitive
    description:
@@ -22,6 +36,27 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "2.1.0"
+  build:
+    dependency: transitive
+    description:
+      name: build
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.1.0"
+  built_collection:
+    dependency: transitive
+    description:
+      name: built_collection
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "5.1.1"
+  built_value:
+    dependency: transitive
+    description:
+      name: built_value
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "8.1.2"
  characters:
    dependency: transitive
    description:
@@ -35,7 +70,14 @@ packages:
      name: charcode
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.2.0"
+    version: "1.3.1"
+  cli_util:
+    dependency: transitive
+    description:
+      name: cli_util
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.3.3"
  clock:
    dependency: transitive
    description:
@@ -43,6 +85,13 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.1.0"
+  code_builder:
+    dependency: transitive
+    description:
+      name: code_builder
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "4.1.0"
  collection:
    dependency: transitive
    description:
@@ -50,6 +99,27 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.15.0"
+  convert:
+    dependency: transitive
+    description:
+      name: convert
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "3.0.1"
+  crypto:
+    dependency: transitive
+    description:
+      name: crypto
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "3.0.1"
+  dart_style:
+    dependency: transitive
+    description:
+      name: dart_style
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.3"
  fake_async:
    dependency: transitive
    description:
@@ -57,6 +127,20 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.2.0"
+  file:
+    dependency: transitive
+    description:
+      name: file
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "6.1.2"
+  fixnum:
+    dependency: transitive
+    description:
+      name: fixnum
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.0"
  flutter:
    dependency: "direct main"
    description: flutter
@@ -74,6 +158,13 @@ packages:
    description: flutter
    source: sdk
    version: "0.0.0"
+  glob:
+    dependency: transitive
+    description:
+      name: glob
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.1"
  lints:
    dependency: transitive
    description:
@@ -81,27 +172,41 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.0.1"
+  logging:
+    dependency: transitive
+    description:
+      name: logging
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.1"
  matcher:
    dependency: transitive
    description:
      name: matcher
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.12.10"
+    version: "0.12.11"
  meta:
    dependency: transitive
    description:
      name: meta
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.3.0"
+    version: "1.7.0"
  mockito:
    dependency: "direct dev"
    description:
      name: mockito
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "4.1.1+1"
+    version: "5.0.15"
+  package_config:
+    dependency: transitive
+    description:
+      name: package_config
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.0"
  path:
    dependency: transitive
    description:
@@ -109,18 +214,39 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "1.8.0"
+  pedantic:
+    dependency: transitive
+    description:
+      name: pedantic
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.11.1"
  pigeon:
    dependency: "direct dev"
    description:
      name: pigeon
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.1.23"
+    version: "1.0.1"
+  pub_semver:
+    dependency: transitive
+    description:
+      name: pub_semver
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.0"
  sky_engine:
    dependency: transitive
    description: flutter
    source: sdk
    version: "0.0.99"
+  source_gen:
+    dependency: transitive
+    description:
+      name: source_gen
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.3"
  source_span:
    dependency: transitive
    description:
@@ -162,7 +288,7 @@ packages:
      name: test_api
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "0.3.0"
+    version: "0.4.3"
  typed_data:
    dependency: transitive
    description:
@@ -177,5 +303,19 @@ packages:
      url: "https://pub.dartlang.org"
    source: hosted
    version: "2.1.0"
+  watcher:
+    dependency: transitive
+    description:
+      name: watcher
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.0"
+  yaml:
+    dependency: transitive
+    description:
+      name: yaml
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "3.1.0"
 sdks:
  dart: ">=2.12.0 <3.0.0"
--- a/add_to_app/books/flutter_module_books/pubspec.yaml
+++ b/add_to_app/books/flutter_module_books/pubspec.yaml
@@ -13,8 +13,8 @@ dependencies:
    sdk: flutter

 dev_dependencies:
-  pigeon: ^0.1.0
-  mockito: ^4.1.1
+  pigeon: ^1.0.0
+  mockito: ^5.0.0
  flutter_test:
    sdk: flutter
  flutter_lints: ^1.0.0