diff --git a/.github/workflows/test-package.yml b/.github/workflows/test-package.yml index f6e2f26..49ef6d2 100644 --- a/.github/workflows/test-package.yml +++ b/.github/workflows/test-package.yml @@ -18,7 +18,7 @@ env: jobs: # Check code formatting and static analysis on a single OS (linux) - # against Dart stable. + # against Flutter stable. analyze: runs-on: ubuntu-latest strategy: @@ -27,17 +27,20 @@ jobs: sdk: [stable] steps: - uses: actions/checkout@v2 - - uses: dart-lang/setup-dart@v1.0 + - uses: actions/setup-java@v1 with: - sdk: ${{ matrix.sdk }} + java-version: '12.x' + - uses: subosito/flutter-action@v1 + with: + channel: ${{ matrix.sdk }} - id: install name: Install dependencies - run: dart pub get + run: flutter pub get - name: Check formatting - run: dart format --output=none --set-exit-if-changed . + run: flutter format --set-exit-if-changed . if: always() && steps.install.outcome == 'success' - name: Analyze code - run: dart analyze --fatal-infos + run: flutter analyze --fatal-infos if: always() && steps.install.outcome == 'success' # Run tests on a matrix consisting of two dimensions: @@ -51,18 +54,22 @@ jobs: matrix: # Add macos-latest and/or windows-latest if relevant for this package. os: [ubuntu-latest, macos-latest, windows-latest] - sdk: [2.13.0, dev] + sdk: [stable, dev] steps: - uses: actions/checkout@v2 - - uses: dart-lang/setup-dart@v1.0 + - uses: actions/setup-java@v1 + with: + java-version: '12.x' + - uses: subosito/flutter-action@v1 with: - sdk: ${{ matrix.sdk }} + channel: ${{ matrix.sdk }} - id: install name: Install dependencies - run: dart pub get + run: flutter pub get - id: get_binaries name: Download/Build Cronet Binaries - run: dart run cronet:setup + run: flutter pub run cronet:setup + if: always() && steps.install.outcome == 'success' - name: Run VM tests - run: dart test --platform vm + run: flutter test if: always() && steps.install.outcome == 'success' diff --git a/.gitignore b/.gitignore index b4a057b..0c1dd38 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ doc/api/ .history .vscode compile_commands.json +*.log # IntelliJ *.iml diff --git a/CHANGELOG.md b/CHANGELOG.md index 914a1cf..543e91d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.0.4 + +* Added support for Android and Flutter Desktops (Windows/Linux). + ## 0.0.3 * Using `package:args` for handling CLI arguments. diff --git a/README.md b/README.md index 4b3676d..4b47342 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,14 @@ This is a [GSoC 2021 project](https://summerofcode.withgoogle.com/projects/#4757 ## Supported Platforms -Currently, 64 bit Desktop Platforms (Linux, Windows and MacOS) are supported. +Currently, 64 bit Android and Desktop Platforms (Linux, Windows and MacOS) are supported. ## Requirements 1. Dart SDK 2.12.0 or above. -2. CMake 3.15 or above. (If on windows, Visual Studio 2019 with C++ tools) +2. CMake 3.10 or above. (If on windows, Visual Studio 2019 with C++ tools) 3. C++ compiler. (g++/clang/msvc) +4. Android NDK if targeting Android. ## Usage @@ -20,13 +21,22 @@ Currently, 64 bit Desktop Platforms (Linux, Windows and MacOS) are supported. 2. Run this from the `root` of your project. - **Dart CLI** - ```bash - dart pub get - dart run cronet:setup # Downloads the cronet binaries. + flutter pub get + flutter pub run cronet:setup # Downloads the cronet binaries. + ``` + + We need to use `flutter pub` even if we want to use it with Dart CLI. See for further details. + + ***Note for Android:** Remember to Add the following permissions in `AndroidManifest.xml` file. + + ```xml + + ``` + Optionally, enable cleartext traffic by adding `android:usesCleartextTraffic="true"` to `AndroidManifest.xml` file. + 3. Import ```dart @@ -56,22 +66,34 @@ Currently, 64 bit Desktop Platforms (Linux, Windows and MacOS) are supported. ## Run Example +### Flutter + ```bash -cd example -dart run cronet:setup # Downloads the cronet binaries. -dart run +cd example/flutter +flutter pub get +flutter pub run cronet:setup # Downloads the cronet binaries. +flutter run +``` + +### Dart CLI + +```bash +cd example/cli +flutter pub get +flutter pub run cronet:setup # Downloads the cronet binaries. +dart run bin/example_dart.dart ``` ## Run Tests ```bash -dart pub get -dart run cronet:setup # Downloads the cronet binaries. -dart test --platform vm +flutter pub get +flutter pub run cronet:setup # Downloads the cronet binaries. +flutter test ``` You can also verify your cronet binaries using `dart run cronet:setup verify`. -Make sure to have `cmake 3.15`. +Make sure to have `cmake 3.10`. ## Benchmarking @@ -98,3 +120,5 @@ Note: Test results may get affected by: + + + + diff --git a/android/src/main/kotlin/dev/google/cronet/CronetPlugin.kt b/android/src/main/kotlin/dev/google/cronet/CronetPlugin.kt new file mode 100644 index 0000000..7f46e44 --- /dev/null +++ b/android/src/main/kotlin/dev/google/cronet/CronetPlugin.kt @@ -0,0 +1,41 @@ +package dev.google.cronet + +import androidx.annotation.NonNull + +import io.flutter.embedding.engine.plugins.FlutterPlugin +import io.flutter.plugin.common.MethodCall +import io.flutter.plugin.common.MethodChannel +import io.flutter.plugin.common.MethodChannel.MethodCallHandler +import io.flutter.plugin.common.MethodChannel.Result +import io.flutter.plugin.common.PluginRegistry.Registrar + +import org.chromium.base.ContextUtils + +/** CronetPlugin */ +class CronetPlugin: FlutterPlugin, MethodCallHandler { + /// The MethodChannel that will the communication between Flutter and native Android + /// + /// This local reference serves to register the plugin with the Flutter Engine and unregister it + /// when the Flutter Engine is detached from the Activity + private lateinit var channel : MethodChannel + + override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { + System.loadLibrary("cronet.86.0.4240.198") + System.loadLibrary("wrapper") + ContextUtils.initApplicationContext(flutterPluginBinding.applicationContext) + channel = MethodChannel(flutterPluginBinding.binaryMessenger, "cronet") + channel.setMethodCallHandler(this) + } + + override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) { + if (call.method == "getPlatformVersion") { + result.success("Android ${android.os.Build.VERSION.RELEASE}") + } else { + result.notImplemented() + } + } + + override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) { + channel.setMethodCallHandler(null) + } +} diff --git a/bin/setup.dart b/bin/setup.dart index ee70e9f..7c76fa1 100644 --- a/bin/setup.dart +++ b/bin/setup.dart @@ -9,6 +9,7 @@ import 'package:args/command_runner.dart'; import 'package:cli_util/cli_logging.dart' show Ansi, Logger; import 'package:cronet/src/constants.dart'; import 'package:cronet/src/third_party/ffigen/find_resource.dart'; +import 'package:path/path.dart'; // Extracts a tar.gz file. void extract(String fileName, [String dir = '']) { @@ -28,6 +29,27 @@ void extract(String fileName, [String dir = '']) { } } +/// Places downloaded mobile binaries to proper location. +void placeMobileBinaries(String platform, String fileName) { + Directory(androidPaths['cronet.jar']!).createSync(recursive: true); + Directory(tempAndroidDownloadPath['cronet.jar']!).listSync().forEach((jar) { + if (jar is File) { + jar.renameSync(join(androidPaths['cronet.jar']!, basename(jar.path))); + } + }); + Directory(androidPaths['cronet.so']!).createSync(recursive: true); + Directory(tempAndroidDownloadPath['cronet.so']!) + .listSync(recursive: true) + .forEach((cronet) { + if (cronet is File) { + Directory(join(androidPaths['cronet.so']!, basename(cronet.parent.path))) + .createSync(recursive: true); + cronet.renameSync(join(androidPaths['cronet.so']!, + basename(cronet.parent.path), basename(cronet.path))); + } + }); +} + /// Places downloaded binaries to proper location. void placeBinaries(String platform, String fileName) { final logger = Logger.standard(); @@ -35,6 +57,9 @@ void placeBinaries(String platform, String fileName) { logger.stdout('${ansi.yellow}Extracting Cronet for $platform${ansi.none}'); Directory(binaryStorageDir).createSync(recursive: true); extract(fileName, binaryStorageDir); + if (mobilePlatforms.contains(platform)) { + placeMobileBinaries(platform, fileName); + } logger.stdout('Done! Cleaning up...'); File(fileName).deleteSync(); @@ -75,9 +100,10 @@ Future downloadCronetBinaries(String platform) async { String _makeBuildOutputPath(String buildFolderPath, String fileName, {bool isDebug = false}) { if (Platform.isWindows) { - return '$buildFolderPath\\out\\${Platform.operatingSystem}\\${isDebug ? "Debug" : "Release"}\\$fileName'; + return join(buildFolderPath, 'out', Platform.operatingSystem, + isDebug ? 'Debug' : 'Release', fileName); } else if (Platform.isMacOS || Platform.isLinux) { - return '$buildFolderPath/out/${Platform.operatingSystem}/$fileName'; + return join(buildFolderPath, 'out', Platform.operatingSystem, fileName); } else { throw Exception('Unsupported Platform.'); } @@ -95,7 +121,7 @@ void buildWrapper() { final result = Process.runSync('cmake', [ 'CMakeLists.txt', '-B', - 'out/${Platform.operatingSystem}', + join('out', Platform.operatingSystem), '-DCMAKE_BUILD_TYPE=Release' ]); print(result.stdout); @@ -111,16 +137,20 @@ void buildWrapper() { } return; } - var result = Process.runSync('cmake', - ['--build', 'out/${Platform.operatingSystem}', '--config', 'Release']); + var result = Process.runSync('cmake', [ + '--build', + join('out', Platform.operatingSystem), + '--config', + 'Release' + ]); print(result.stdout); print(result.stderr); - if (result.exitCode != 0) return; + if (result.exitCode != 0) exit(result.exitCode); Directory.current = pwd; final moveLocation = '$binaryStorageDir${Platform.operatingSystem}64'; Directory(moveLocation).createSync(recursive: true); final buildOutputPath = _makeBuildOutputPath(wrapperPath, getWrapperName()); - File(buildOutputPath).copySync('$moveLocation/${getWrapperName()}'); + File(buildOutputPath).copySync(join(moveLocation, getWrapperName())); logger.stdout( '${ansi.green}Wrapper moved to $moveLocation. Success!${ansi.none}'); return; @@ -141,7 +171,7 @@ void verifyCronetBinary() { final logger = Logger.standard(); final ansi = Ansi(Ansi.terminalSupportsAnsi); final sampleSource = findPackageRoot() - .resolve('third_party/cronet_sample') + .resolve(join('third_party', 'cronet_sample')) .toFilePath(windows: Platform.isWindows); final buildName = _getCronetSampleBuildName(); final pwd = Directory.current; @@ -153,16 +183,16 @@ void verifyCronetBinary() { logger.stdout('Building Sample...'); var result = Process.runSync('cmake', [ - '$sampleSource/CMakeLists.txt', + join(sampleSource, 'CMakeLists.txt'), '-B', - '$sampleSource/out/${Platform.operatingSystem}' + join(sampleSource, 'out', Platform.operatingSystem) ], environment: { 'CURRENTDIR': pwd.path }); print(result.stdout); print(result.stderr); result = Process.runSync( - 'cmake', ['--build', '$sampleSource/out/${Platform.operatingSystem}'], + 'cmake', ['--build', join(sampleSource, 'out', Platform.operatingSystem)], environment: {'CURRENTDIR': pwd.path}); print(result.stdout); print(result.stderr); @@ -170,12 +200,13 @@ void verifyCronetBinary() { _makeBuildOutputPath(sampleSource, buildName, isDebug: true); logger.stdout('Copying...'); - final sample = File(buildOutputPath) - .copySync('.dart_tool/cronet/${Platform.operatingSystem}64/$buildName'); + final sample = File(buildOutputPath).copySync( + join('.dart_tool', 'cronet', Platform.operatingSystem + '64', buildName)); logger.stdout('Verifying...'); result = Process.runSync( - '.dart_tool/cronet/${Platform.operatingSystem}64/$buildName', []); + join('.dart_tool', 'cronet', Platform.operatingSystem + '64', buildName), + []); if (result.exitCode == 0) { logger.stdout('${ansi.green}Verified! Cronet is working fine.${ansi.none}'); } else { @@ -238,6 +269,9 @@ Future main(List args) async { if (validPlatforms.contains('${Platform.operatingSystem}64')) { await downloadCronetBinaries('${Platform.operatingSystem}64'); } + if (Directory('android').existsSync()) { + await downloadCronetBinaries('android'); + } } else { await runner.run(args); } diff --git a/example/README.md b/example/README.md index b347cb2..e829456 100644 --- a/example/README.md +++ b/example/README.md @@ -1,4 +1,5 @@ ## Examples - [Bare Minimum](https://github.com/google/cronet.dart#example) -- [Simple (Dart CLI)](https://github.com/google/cronet.dart/tree/main/example/) +- [Simple (Dart CLI)](https://github.com/google/cronet.dart/tree/main/example/cli) +- [Simple (Flutter)](https://github.com/google/cronet.dart/tree/main/example/flutter) diff --git a/example/cli/analysis_options.yaml b/example/cli/analysis_options.yaml new file mode 100644 index 0000000..3743f9b --- /dev/null +++ b/example/cli/analysis_options.yaml @@ -0,0 +1,14 @@ +# Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file +# for details. All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +include: package:lints/recommended.yaml + +analyzer: + strong-mode: + implicit-casts: false + implicit-dynamic: false +linter: + rules: + - directives_ordering + - lines_longer_than_80_chars diff --git a/example/cli/bin/example_dart.dart b/example/cli/bin/example_dart.dart new file mode 100644 index 0000000..cccf762 --- /dev/null +++ b/example/cli/bin/example_dart.dart @@ -0,0 +1,33 @@ +// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +import 'dart:convert'; + +import 'package:cronet/cronet.dart'; + +/* Trying to re-impliment: https://chromium.googlesource.com/chromium/src/+/master/components/cronet/native/sample/main.cc */ + +void main(List args) { + final stopwatch = Stopwatch()..start(); + final client = HttpClient(); + for (var i = 0; i < 3; i++) { + // Demo - with concurrent requests + client + .getUrl(Uri.parse('https://example.com')) + .then((HttpClientRequest request) { + if (i == 2) { + client.close(); // We will shut down the client after 3 connections. + } + return request.close(); + }).then((HttpClientResponse response) { + response.transform(utf8.decoder).listen((contents) { + print(contents); + }, onDone: () { + print('cronet implemenation took: ${stopwatch.elapsedMilliseconds} ms'); + }, onError: (Object e) { + print(e); + }); + }); + } +} diff --git a/example/pubspec.yaml b/example/cli/pubspec.yaml similarity index 93% rename from example/pubspec.yaml rename to example/cli/pubspec.yaml index 9d9c44a..9cd17fe 100644 --- a/example/pubspec.yaml +++ b/example/cli/pubspec.yaml @@ -8,7 +8,7 @@ environment: dependencies: cronet: - path: ../ + path: ../../ dev_dependencies: lints: ^1.0.1 diff --git a/example/flutter/.gitignore b/example/flutter/.gitignore new file mode 100644 index 0000000..0fa6b67 --- /dev/null +++ b/example/flutter/.gitignore @@ -0,0 +1,46 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ + +# Web related +lib/generated_plugin_registrant.dart + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/example/flutter/.metadata b/example/flutter/.metadata new file mode 100644 index 0000000..c1ee81b --- /dev/null +++ b/example/flutter/.metadata @@ -0,0 +1,10 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: 1d9032c7e1d867f071f2277eb1673e8f9b0274e3 + channel: stable + +project_type: app diff --git a/example/flutter/README.md b/example/flutter/README.md new file mode 100644 index 0000000..d82f773 --- /dev/null +++ b/example/flutter/README.md @@ -0,0 +1,18 @@ +# cronet_example + +Example usage of package:cronet in Flutter apps. Fetches the page `http://info.cern.ch/` and displays it in screen along with Cronet version information and time taken to get the data. + +## Getting Started + +### Get the dependencies + +```bash +flutter pub get +flutter pub run cronet:setup # Downloads the cronet binaries. +``` + +### Run the app + +```bash +flutter run +``` diff --git a/example/flutter/analysis_options.yaml b/example/flutter/analysis_options.yaml new file mode 100644 index 0000000..3743f9b --- /dev/null +++ b/example/flutter/analysis_options.yaml @@ -0,0 +1,14 @@ +# Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file +# for details. All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +include: package:lints/recommended.yaml + +analyzer: + strong-mode: + implicit-casts: false + implicit-dynamic: false +linter: + rules: + - directives_ordering + - lines_longer_than_80_chars diff --git a/example/flutter/android/.gitignore b/example/flutter/android/.gitignore new file mode 100644 index 0000000..0a741cb --- /dev/null +++ b/example/flutter/android/.gitignore @@ -0,0 +1,11 @@ +gradle-wrapper.jar +/.gradle +/captures/ +/gradlew +/gradlew.bat +/local.properties +GeneratedPluginRegistrant.java + +# Remember to never publicly share your keystore. +# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app +key.properties diff --git a/example/flutter/android/app/build.gradle b/example/flutter/android/app/build.gradle new file mode 100644 index 0000000..4393295 --- /dev/null +++ b/example/flutter/android/app/build.gradle @@ -0,0 +1,59 @@ +def localProperties = new Properties() +def localPropertiesFile = rootProject.file('local.properties') +if (localPropertiesFile.exists()) { + localPropertiesFile.withReader('UTF-8') { reader -> + localProperties.load(reader) + } +} + +def flutterRoot = localProperties.getProperty('flutter.sdk') +if (flutterRoot == null) { + throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.") +} + +def flutterVersionCode = localProperties.getProperty('flutter.versionCode') +if (flutterVersionCode == null) { + flutterVersionCode = '1' +} + +def flutterVersionName = localProperties.getProperty('flutter.versionName') +if (flutterVersionName == null) { + flutterVersionName = '1.0' +} + +apply plugin: 'com.android.application' +apply plugin: 'kotlin-android' +apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" + +android { + compileSdkVersion 30 + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). + applicationId "dev.google.cronet_example" + minSdkVersion 16 + targetSdkVersion 30 + versionCode flutterVersionCode.toInteger() + versionName flutterVersionName + } + + buildTypes { + release { + // TODO: Add your own signing config for the release build. + // Signing with the debug keys for now, so `flutter run --release` works. + signingConfig signingConfigs.debug + } + } +} + +flutter { + source '../..' +} + +dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" +} diff --git a/example/flutter/android/app/src/debug/AndroidManifest.xml b/example/flutter/android/app/src/debug/AndroidManifest.xml new file mode 100644 index 0000000..b9a3083 --- /dev/null +++ b/example/flutter/android/app/src/debug/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/example/flutter/android/app/src/main/AndroidManifest.xml b/example/flutter/android/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..30baccb --- /dev/null +++ b/example/flutter/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/example/flutter/android/app/src/main/kotlin/dev/google/cronet_example/MainActivity.kt b/example/flutter/android/app/src/main/kotlin/dev/google/cronet_example/MainActivity.kt new file mode 100644 index 0000000..e50b8b7 --- /dev/null +++ b/example/flutter/android/app/src/main/kotlin/dev/google/cronet_example/MainActivity.kt @@ -0,0 +1,6 @@ +package dev.google.cronet_example + +import io.flutter.embedding.android.FlutterActivity + +class MainActivity: FlutterActivity() { +} diff --git a/example/flutter/android/app/src/main/res/drawable-v21/launch_background.xml b/example/flutter/android/app/src/main/res/drawable-v21/launch_background.xml new file mode 100644 index 0000000..f74085f --- /dev/null +++ b/example/flutter/android/app/src/main/res/drawable-v21/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/example/flutter/android/app/src/main/res/drawable/launch_background.xml b/example/flutter/android/app/src/main/res/drawable/launch_background.xml new file mode 100644 index 0000000..304732f --- /dev/null +++ b/example/flutter/android/app/src/main/res/drawable/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/example/flutter/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/example/flutter/android/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000..db77bb4 Binary files /dev/null and b/example/flutter/android/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/example/flutter/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/example/flutter/android/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000..17987b7 Binary files /dev/null and b/example/flutter/android/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/example/flutter/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/example/flutter/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000..09d4391 Binary files /dev/null and b/example/flutter/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/example/flutter/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/example/flutter/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000..d5f1c8d Binary files /dev/null and b/example/flutter/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/example/flutter/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/example/flutter/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000..4d6372e Binary files /dev/null and b/example/flutter/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/example/flutter/android/app/src/main/res/values-night/styles.xml b/example/flutter/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 0000000..449a9f9 --- /dev/null +++ b/example/flutter/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/example/flutter/android/app/src/main/res/values/styles.xml b/example/flutter/android/app/src/main/res/values/styles.xml new file mode 100644 index 0000000..d74aa35 --- /dev/null +++ b/example/flutter/android/app/src/main/res/values/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/example/flutter/android/app/src/profile/AndroidManifest.xml b/example/flutter/android/app/src/profile/AndroidManifest.xml new file mode 100644 index 0000000..b9a3083 --- /dev/null +++ b/example/flutter/android/app/src/profile/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/example/flutter/android/build.gradle b/example/flutter/android/build.gradle new file mode 100644 index 0000000..c505a86 --- /dev/null +++ b/example/flutter/android/build.gradle @@ -0,0 +1,31 @@ +buildscript { + ext.kotlin_version = '1.3.50' + repositories { + google() + jcenter() + } + + dependencies { + classpath 'com.android.tools.build:gradle:4.1.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + } +} + +allprojects { + repositories { + google() + jcenter() + } +} + +rootProject.buildDir = '../build' +subprojects { + project.buildDir = "${rootProject.buildDir}/${project.name}" +} +subprojects { + project.evaluationDependsOn(':app') +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/example/flutter/android/gradle.properties b/example/flutter/android/gradle.properties new file mode 100644 index 0000000..94adc3a --- /dev/null +++ b/example/flutter/android/gradle.properties @@ -0,0 +1,3 @@ +org.gradle.jvmargs=-Xmx1536M +android.useAndroidX=true +android.enableJetifier=true diff --git a/example/flutter/android/gradle/wrapper/gradle-wrapper.properties b/example/flutter/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..bc6a58a --- /dev/null +++ b/example/flutter/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Fri Jun 23 08:50:38 CEST 2017 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip diff --git a/example/flutter/android/settings.gradle b/example/flutter/android/settings.gradle new file mode 100644 index 0000000..44e62bc --- /dev/null +++ b/example/flutter/android/settings.gradle @@ -0,0 +1,11 @@ +include ':app' + +def localPropertiesFile = new File(rootProject.projectDir, "local.properties") +def properties = new Properties() + +assert localPropertiesFile.exists() +localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) } + +def flutterSdkPath = properties.getProperty("flutter.sdk") +assert flutterSdkPath != null, "flutter.sdk not set in local.properties" +apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle" diff --git a/example/bin/example_dart.dart b/example/flutter/bin/example_dart.dart similarity index 100% rename from example/bin/example_dart.dart rename to example/flutter/bin/example_dart.dart diff --git a/example/flutter/lib/main.dart b/example/flutter/lib/main.dart new file mode 100644 index 0000000..4b695c9 --- /dev/null +++ b/example/flutter/lib/main.dart @@ -0,0 +1,84 @@ +// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +import 'dart:async'; +import 'dart:convert'; + +import 'package:cronet/cronet.dart'; +import 'package:flutter/material.dart'; + +void main() { + runApp(MyApp()); +} + +class MyApp extends StatefulWidget { + @override + _MyAppState createState() => _MyAppState(); +} + +class _MyAppState extends State { + String data = ''; + bool _fetching = false; + final client = HttpClient(); + final _stopwatch = Stopwatch(); + + @override + void initState() { + super.initState(); + request(); + } + + void request() { + setState(() { + _fetching = true; + data = ''; + }); + client + .getUrl(Uri.parse('http://info.cern.ch/')) + .then((HttpClientRequest request) { + _stopwatch.reset(); + _stopwatch.start(); + return request.close(); + }).then((Stream> response) { + response.transform(utf8.decoder).listen((contents) { + setState(() { + data += contents; + }); + }, onDone: () { + _stopwatch.stop(); + setState(() { + _fetching = false; + }); + }, onError: (dynamic e) { + setState(() { + data = e.toString(); + }); + }); + }); + } + + @override + Widget build(BuildContext context) { + return MaterialApp( + home: Scaffold( + appBar: AppBar( + title: const Text('Cronet Flutter Example'), + ), + body: Center( + child: Column(children: [ + Text('Cronet Version: ${client.httpClientVersion}'), + _fetching + ? CircularProgressIndicator() + : Expanded(child: SingleChildScrollView(child: Text(data))), + Text('Time taken: ${_stopwatch.elapsedMilliseconds} ms') + ])), + floatingActionButton: FloatingActionButton( + tooltip: 'Reload', + child: Icon(Icons.replay_outlined), + onPressed: () => request(), + ), + ), + ); + } +} diff --git a/example/flutter/linux/.gitignore b/example/flutter/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/example/flutter/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/example/flutter/linux/CMakeLists.txt b/example/flutter/linux/CMakeLists.txt new file mode 100644 index 0000000..8c959ed --- /dev/null +++ b/example/flutter/linux/CMakeLists.txt @@ -0,0 +1,106 @@ +cmake_minimum_required(VERSION 3.10) +project(runner LANGUAGES CXX) + +set(BINARY_NAME "cronet_example") +set(APPLICATION_ID "dev.google.cronet_example") + +cmake_policy(SET CMP0063 NEW) + +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Configure build options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") + +# Flutter library and tool build rules. +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Application build +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) +apply_standard_settings(${BINARY_NAME}) +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) +add_dependencies(${BINARY_NAME} flutter_assemble) +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/example/flutter/linux/flutter/CMakeLists.txt b/example/flutter/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..a1da1b9 --- /dev/null +++ b/example/flutter/linux/flutter/CMakeLists.txt @@ -0,0 +1,91 @@ +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) +pkg_check_modules(BLKID REQUIRED IMPORTED_TARGET blkid) +pkg_check_modules(LZMA REQUIRED IMPORTED_TARGET liblzma) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO + PkgConfig::BLKID + PkgConfig::LZMA +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + linux-x64 ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/example/flutter/linux/flutter/generated_plugin_registrant.cc b/example/flutter/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..d53da08 --- /dev/null +++ b/example/flutter/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,13 @@ +// +// Generated file. Do not edit. +// + +#include "generated_plugin_registrant.h" + +#include + +void fl_register_plugins(FlPluginRegistry* registry) { + g_autoptr(FlPluginRegistrar) cronet_registrar = + fl_plugin_registry_get_registrar_for_plugin(registry, "CronetPlugin"); + cronet_plugin_register_with_registrar(cronet_registrar); +} diff --git a/example/flutter/linux/flutter/generated_plugin_registrant.h b/example/flutter/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..9bf7478 --- /dev/null +++ b/example/flutter/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,13 @@ +// +// Generated file. Do not edit. +// + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/flutter/linux/flutter/generated_plugins.cmake b/example/flutter/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..6772a08 --- /dev/null +++ b/example/flutter/linux/flutter/generated_plugins.cmake @@ -0,0 +1,16 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + cronet +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) diff --git a/example/flutter/linux/main.cc b/example/flutter/linux/main.cc new file mode 100644 index 0000000..e7c5c54 --- /dev/null +++ b/example/flutter/linux/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/example/flutter/linux/my_application.cc b/example/flutter/linux/my_application.cc new file mode 100644 index 0000000..436dc6d --- /dev/null +++ b/example/flutter/linux/my_application.cc @@ -0,0 +1,104 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen *screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar *header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "cronet_example"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } + else { + gtk_window_set_title(window, "cronet_example"); + } + + gtk_window_set_default_size(window, 1280, 720); + gtk_widget_show(GTK_WIDGET(window)); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, gchar ***arguments, int *exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject *object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = my_application_local_command_line; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, + nullptr)); +} diff --git a/example/flutter/linux/my_application.h b/example/flutter/linux/my_application.h new file mode 100644 index 0000000..72271d5 --- /dev/null +++ b/example/flutter/linux/my_application.h @@ -0,0 +1,18 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, my_application, MY, APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/example/flutter/pubspec.yaml b/example/flutter/pubspec.yaml new file mode 100644 index 0000000..8368f16 --- /dev/null +++ b/example/flutter/pubspec.yaml @@ -0,0 +1,66 @@ +name: cronet_example +description: Demonstrates how to use the cronet plugin. + +# The following line prevents the package from being accidentally published to +# pub.dev using `pub publish`. This is preferred for private packages. +publish_to: 'none' # Remove this line if you wish to publish to pub.dev + +environment: + sdk: ">=2.12.0 <3.0.0" + +dependencies: + flutter: + sdk: flutter + cronet: + path: ../../ + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.2 + +dev_dependencies: + flutter_test: + sdk: flutter + lints: ^1.0.1 + +# For information on the generic Dart part of this file, see the +# following page: https://dart.dev/tools/pub/pubspec + +# The following section is specific to Flutter. +flutter: + + # The following line ensures that the Material Icons font is + # included with your application, so that you can use the icons in + # the material Icons class. + uses-material-design: true + + # To add assets to your application, add an assets section, like this: + # assets: + # - images/a_dot_burr.jpeg + # - images/a_dot_ham.jpeg + + # An image asset can refer to one or more resolution-specific "variants", see + # https://flutter.dev/assets-and-images/#resolution-aware. + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/assets-and-images/#from-packages + + # To add custom fonts to your application, add a fonts section here, + # in this "flutter" section. Each entry in this list should have a + # "family" key with the font family name, and a "fonts" key with a + # list giving the asset and other descriptors for the font. For + # example: + # fonts: + # - family: Schyler + # fonts: + # - asset: fonts/Schyler-Regular.ttf + # - asset: fonts/Schyler-Italic.ttf + # style: italic + # - family: Trajan Pro + # fonts: + # - asset: fonts/TrajanPro.ttf + # - asset: fonts/TrajanPro_Bold.ttf + # weight: 700 + # + # For details regarding fonts from package dependencies, + # see https://flutter.dev/custom-fonts/#from-packages \ No newline at end of file diff --git a/example/flutter/windows/.gitignore b/example/flutter/windows/.gitignore new file mode 100644 index 0000000..ec4098a --- /dev/null +++ b/example/flutter/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/example/flutter/windows/CMakeLists.txt b/example/flutter/windows/CMakeLists.txt new file mode 100644 index 0000000..716e134 --- /dev/null +++ b/example/flutter/windows/CMakeLists.txt @@ -0,0 +1,95 @@ +cmake_minimum_required(VERSION 3.15) +project(cronet_example LANGUAGES CXX) + +set(BINARY_NAME "cronet_example") + +cmake_policy(SET CMP0063 NEW) + +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Configure build options. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() + +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") + +# Flutter library and tool build rules. +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build +add_subdirectory("runner") + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/example/flutter/windows/flutter/CMakeLists.txt b/example/flutter/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..c10f4f6 --- /dev/null +++ b/example/flutter/windows/flutter/CMakeLists.txt @@ -0,0 +1,103 @@ +cmake_minimum_required(VERSION 3.15) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + windows-x64 $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/example/flutter/windows/flutter/generated_plugin_registrant.cc b/example/flutter/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..a76447e --- /dev/null +++ b/example/flutter/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,12 @@ +// +// Generated file. Do not edit. +// + +#include "generated_plugin_registrant.h" + +#include + +void RegisterPlugins(flutter::PluginRegistry* registry) { + CronetPluginRegisterWithRegistrar( + registry->GetRegistrarForPlugin("CronetPlugin")); +} diff --git a/example/flutter/windows/flutter/generated_plugin_registrant.h b/example/flutter/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..9846246 --- /dev/null +++ b/example/flutter/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,13 @@ +// +// Generated file. Do not edit. +// + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/flutter/windows/flutter/generated_plugins.cmake b/example/flutter/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2f82d2e --- /dev/null +++ b/example/flutter/windows/flutter/generated_plugins.cmake @@ -0,0 +1,16 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + cronet +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) diff --git a/example/flutter/windows/runner/CMakeLists.txt b/example/flutter/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..e993217 --- /dev/null +++ b/example/flutter/windows/runner/CMakeLists.txt @@ -0,0 +1,18 @@ +cmake_minimum_required(VERSION 3.15) +project(runner LANGUAGES CXX) + +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "run_loop.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) +apply_standard_settings(${BINARY_NAME}) +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/example/flutter/windows/runner/Runner.rc b/example/flutter/windows/runner/Runner.rc new file mode 100644 index 0000000..98d2c71 --- /dev/null +++ b/example/flutter/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#ifdef FLUTTER_BUILD_NUMBER +#define VERSION_AS_NUMBER FLUTTER_BUILD_NUMBER +#else +#define VERSION_AS_NUMBER 1,0,0 +#endif + +#ifdef FLUTTER_BUILD_NAME +#define VERSION_AS_STRING #FLUTTER_BUILD_NAME +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "dev.google" "\0" + VALUE "FileDescription", "A new Flutter project." "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "cronet_example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2021 dev.google. All rights reserved." "\0" + VALUE "OriginalFilename", "cronet_example.exe" "\0" + VALUE "ProductName", "cronet_example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/example/flutter/windows/runner/flutter_window.cpp b/example/flutter/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..ac04f77 --- /dev/null +++ b/example/flutter/windows/runner/flutter_window.cpp @@ -0,0 +1,64 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(RunLoop* run_loop, + const flutter::DartProject& project) + : run_loop_(run_loop), project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + run_loop_->RegisterFlutterInstance(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + run_loop_->UnregisterFlutterInstance(flutter_controller_->engine()); + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opporutunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/example/flutter/windows/runner/flutter_window.h b/example/flutter/windows/runner/flutter_window.h new file mode 100644 index 0000000..ba86031 --- /dev/null +++ b/example/flutter/windows/runner/flutter_window.h @@ -0,0 +1,39 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "run_loop.h" +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow driven by the |run_loop|, hosting a + // Flutter view running |project|. + explicit FlutterWindow(RunLoop* run_loop, + const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The run loop driving events for this window. + RunLoop* run_loop_; + + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/example/flutter/windows/runner/main.cpp b/example/flutter/windows/runner/main.cpp new file mode 100644 index 0000000..d7975a1 --- /dev/null +++ b/example/flutter/windows/runner/main.cpp @@ -0,0 +1,42 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "run_loop.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + RunLoop run_loop; + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(&run_loop, project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.CreateAndShow(L"cronet_example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + run_loop.Run(); + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/example/flutter/windows/runner/resource.h b/example/flutter/windows/runner/resource.h new file mode 100644 index 0000000..ddc7f3e --- /dev/null +++ b/example/flutter/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/example/flutter/windows/runner/resources/app_icon.ico b/example/flutter/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/example/flutter/windows/runner/resources/app_icon.ico differ diff --git a/example/flutter/windows/runner/run_loop.cpp b/example/flutter/windows/runner/run_loop.cpp new file mode 100644 index 0000000..0d91211 --- /dev/null +++ b/example/flutter/windows/runner/run_loop.cpp @@ -0,0 +1,66 @@ +#include "run_loop.h" + +#include + +#include + +RunLoop::RunLoop() {} + +RunLoop::~RunLoop() {} + +void RunLoop::Run() { + bool keep_running = true; + TimePoint next_flutter_event_time = TimePoint::clock::now(); + while (keep_running) { + std::chrono::nanoseconds wait_duration = + std::max(std::chrono::nanoseconds(0), + next_flutter_event_time - TimePoint::clock::now()); + ::MsgWaitForMultipleObjects( + 0, nullptr, FALSE, static_cast(wait_duration.count() / 1000), + QS_ALLINPUT); + bool processed_events = false; + MSG message; + // All pending Windows messages must be processed; MsgWaitForMultipleObjects + // won't return again for items left in the queue after PeekMessage. + while (::PeekMessage(&message, nullptr, 0, 0, PM_REMOVE)) { + processed_events = true; + if (message.message == WM_QUIT) { + keep_running = false; + break; + } + ::TranslateMessage(&message); + ::DispatchMessage(&message); + // Allow Flutter to process messages each time a Windows message is + // processed, to prevent starvation. + next_flutter_event_time = + std::min(next_flutter_event_time, ProcessFlutterMessages()); + } + // If the PeekMessage loop didn't run, process Flutter messages. + if (!processed_events) { + next_flutter_event_time = + std::min(next_flutter_event_time, ProcessFlutterMessages()); + } + } +} + +void RunLoop::RegisterFlutterInstance( + flutter::FlutterEngine* flutter_instance) { + flutter_instances_.insert(flutter_instance); +} + +void RunLoop::UnregisterFlutterInstance( + flutter::FlutterEngine* flutter_instance) { + flutter_instances_.erase(flutter_instance); +} + +RunLoop::TimePoint RunLoop::ProcessFlutterMessages() { + TimePoint next_event_time = TimePoint::max(); + for (auto instance : flutter_instances_) { + std::chrono::nanoseconds wait_duration = instance->ProcessMessages(); + if (wait_duration != std::chrono::nanoseconds::max()) { + next_event_time = + std::min(next_event_time, TimePoint::clock::now() + wait_duration); + } + } + return next_event_time; +} diff --git a/example/flutter/windows/runner/run_loop.h b/example/flutter/windows/runner/run_loop.h new file mode 100644 index 0000000..54927f9 --- /dev/null +++ b/example/flutter/windows/runner/run_loop.h @@ -0,0 +1,40 @@ +#ifndef RUNNER_RUN_LOOP_H_ +#define RUNNER_RUN_LOOP_H_ + +#include + +#include +#include + +// A runloop that will service events for Flutter instances as well +// as native messages. +class RunLoop { + public: + RunLoop(); + ~RunLoop(); + + // Prevent copying + RunLoop(RunLoop const&) = delete; + RunLoop& operator=(RunLoop const&) = delete; + + // Runs the run loop until the application quits. + void Run(); + + // Registers the given Flutter instance for event servicing. + void RegisterFlutterInstance( + flutter::FlutterEngine* flutter_instance); + + // Unregisters the given Flutter instance from event servicing. + void UnregisterFlutterInstance( + flutter::FlutterEngine* flutter_instance); + + private: + using TimePoint = std::chrono::steady_clock::time_point; + + // Processes all currently pending messages for registered Flutter instances. + TimePoint ProcessFlutterMessages(); + + std::set flutter_instances_; +}; + +#endif // RUNNER_RUN_LOOP_H_ diff --git a/example/flutter/windows/runner/runner.exe.manifest b/example/flutter/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..2c680b8 --- /dev/null +++ b/example/flutter/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/example/flutter/windows/runner/utils.cpp b/example/flutter/windows/runner/utils.cpp new file mode 100644 index 0000000..05b53c0 --- /dev/null +++ b/example/flutter/windows/runner/utils.cpp @@ -0,0 +1,64 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr); + if (target_length == 0) { + return std::string(); + } + std::string utf8_string; + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/example/flutter/windows/runner/utils.h b/example/flutter/windows/runner/utils.h new file mode 100644 index 0000000..3f0e05c --- /dev/null +++ b/example/flutter/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/example/flutter/windows/runner/win32_window.cpp b/example/flutter/windows/runner/win32_window.cpp new file mode 100644 index 0000000..97f4439 --- /dev/null +++ b/example/flutter/windows/runner/win32_window.cpp @@ -0,0 +1,245 @@ +#include "win32_window.h" + +#include + +#include "resource.h" + +namespace { + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + FreeLibrary(user32_module); + } +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + return OnCreate(); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} diff --git a/example/flutter/windows/runner/win32_window.h b/example/flutter/windows/runner/win32_window.h new file mode 100644 index 0000000..d9bcac1 --- /dev/null +++ b/example/flutter/windows/runner/win32_window.h @@ -0,0 +1,98 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates and shows a win32 window with |title| and position and size using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size to will treat the width height passed in to this function + // as logical pixels and scale to appropriate for the default monitor. Returns + // true if the window was created successfully. + bool CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responsponds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/lib/src/constants.dart b/lib/src/constants.dart index f0e8911..ae16135 100644 --- a/lib/src/constants.dart +++ b/lib/src/constants.dart @@ -4,8 +4,14 @@ import 'dart:io' show Platform; -const validPlatforms = ['linux64', 'windows64', 'macos64']; -const tag = 'binaries-v0.0.2'; +import 'package:path/path.dart' as p; + +import 'third_party/ffigen/find_resource.dart'; + +const desktopPlatforms = ['linux64', 'windows64', 'macos64']; +const mobilePlatforms = ['android']; +List get validPlatforms => desktopPlatforms + mobilePlatforms; +const tag = 'binaries-v0.0.4'; const cronetBinaryUrl = 'https://github.com/google/cronet.dart/releases/download/$tag/'; const cronetVersion = "86.0.4240.198"; @@ -13,6 +19,19 @@ const wrapperVersion = "1"; const binaryStorageDir = '.dart_tool/cronet/'; +// Contains paths where downloaded binaries are stored temporarily. +final tempAndroidDownloadPath = { + 'cronet.jar': p.join(binaryStorageDir, 'android', 'libs'), + 'cronet.so': p.join(binaryStorageDir, 'android', 'jniLibs') +}; + +// Contains paths where downloaded binaries are located for Android. +final androidRoot = p.fromUri(findPackageRoot().resolve('android')); +final androidPaths = { + 'cronet.jar': p.join(androidRoot, 'libs'), + 'cronet.so': p.join(androidRoot, 'src', 'main', 'jniLibs') +}; + String getDylibName(String name, [String platform = '']) { var ext = '.so'; var prefix = 'lib'; @@ -22,7 +41,9 @@ String getDylibName(String name, [String platform = '']) { ext = '.dll'; } else if (Platform.isMacOS || platform.startsWith('macos')) { ext = '.dylib'; - } else if (!(Platform.isLinux || platform.startsWith('linux'))) { + } else if (!(Platform.isLinux || + platform.startsWith('linux') || + Platform.isAndroid)) { // If NOT even linux, then unsupported. throw Exception('Unsupported Platform.'); } diff --git a/lib/src/third_party/ffigen/find_resource.dart b/lib/src/third_party/ffigen/find_resource.dart index 9c1968b..3ecc48c 100644 --- a/lib/src/third_party/ffigen/find_resource.dart +++ b/lib/src/third_party/ffigen/find_resource.dart @@ -60,5 +60,8 @@ bool isCronetAvailable(String platform) { .existsSync() && File.fromUri(Directory.current.uri.resolve(getCronetName(platform))) .existsSync(); - return cronetBinaries || inRoot; + final inAndroidDir = platform == 'android' && + File.fromUri(findPackageRoot().resolve('android/libs/cronet_api.jar')) + .existsSync(); + return cronetBinaries || inRoot || inAndroidDir; } diff --git a/linux/CMakeLists.txt b/linux/CMakeLists.txt new file mode 100644 index 0000000..852294a --- /dev/null +++ b/linux/CMakeLists.txt @@ -0,0 +1,25 @@ +cmake_minimum_required(VERSION 3.10) +set(PROJECT_NAME "cronet") +project(${PROJECT_NAME} LANGUAGES CXX) + +# This value is used when generating builds using this plugin, so it must +# not be changed +set(PLUGIN_NAME "cronet_plugin") + +add_library(${PLUGIN_NAME} SHARED + "cronet_plugin.cc" +) +apply_standard_settings(${PLUGIN_NAME}) +set_target_properties(${PLUGIN_NAME} PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL) +target_include_directories(${PLUGIN_NAME} INTERFACE + "${CMAKE_CURRENT_SOURCE_DIR}/include") +target_link_libraries(${PLUGIN_NAME} PRIVATE flutter) +target_link_libraries(${PLUGIN_NAME} PRIVATE PkgConfig::GTK) + +# List of absolute paths to libraries that should be bundled with the plugin +set(cronet_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/linux/cronet_plugin.cc b/linux/cronet_plugin.cc new file mode 100644 index 0000000..1c726fe --- /dev/null +++ b/linux/cronet_plugin.cc @@ -0,0 +1,70 @@ +#include "include/cronet/cronet_plugin.h" + +#include +#include +#include + +#include + +#define CRONET_PLUGIN(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), cronet_plugin_get_type(), \ + CronetPlugin)) + +struct _CronetPlugin { + GObject parent_instance; +}; + +G_DEFINE_TYPE(CronetPlugin, cronet_plugin, g_object_get_type()) + +// Called when a method call is received from Flutter. +static void cronet_plugin_handle_method_call( + CronetPlugin* self, + FlMethodCall* method_call) { + g_autoptr(FlMethodResponse) response = nullptr; + + const gchar* method = fl_method_call_get_name(method_call); + + if (strcmp(method, "getPlatformVersion") == 0) { + struct utsname uname_data = {}; + uname(&uname_data); + g_autofree gchar *version = g_strdup_printf("Linux %s", uname_data.version); + g_autoptr(FlValue) result = fl_value_new_string(version); + response = FL_METHOD_RESPONSE(fl_method_success_response_new(result)); + } else { + response = FL_METHOD_RESPONSE(fl_method_not_implemented_response_new()); + } + + fl_method_call_respond(method_call, response, nullptr); +} + +static void cronet_plugin_dispose(GObject* object) { + G_OBJECT_CLASS(cronet_plugin_parent_class)->dispose(object); +} + +static void cronet_plugin_class_init(CronetPluginClass* klass) { + G_OBJECT_CLASS(klass)->dispose = cronet_plugin_dispose; +} + +static void cronet_plugin_init(CronetPlugin* self) {} + +static void method_call_cb(FlMethodChannel* channel, FlMethodCall* method_call, + gpointer user_data) { + CronetPlugin* plugin = CRONET_PLUGIN(user_data); + cronet_plugin_handle_method_call(plugin, method_call); +} + +void cronet_plugin_register_with_registrar(FlPluginRegistrar* registrar) { + CronetPlugin* plugin = CRONET_PLUGIN( + g_object_new(cronet_plugin_get_type(), nullptr)); + + g_autoptr(FlStandardMethodCodec) codec = fl_standard_method_codec_new(); + g_autoptr(FlMethodChannel) channel = + fl_method_channel_new(fl_plugin_registrar_get_messenger(registrar), + "cronet", + FL_METHOD_CODEC(codec)); + fl_method_channel_set_method_call_handler(channel, method_call_cb, + g_object_ref(plugin), + g_object_unref); + + g_object_unref(plugin); +} diff --git a/linux/include/cronet/cronet_plugin.h b/linux/include/cronet/cronet_plugin.h new file mode 100644 index 0000000..a67a851 --- /dev/null +++ b/linux/include/cronet/cronet_plugin.h @@ -0,0 +1,26 @@ +#ifndef FLUTTER_PLUGIN_CRONET_PLUGIN_H_ +#define FLUTTER_PLUGIN_CRONET_PLUGIN_H_ + +#include + +G_BEGIN_DECLS + +#ifdef FLUTTER_PLUGIN_IMPL +#define FLUTTER_PLUGIN_EXPORT __attribute__((visibility("default"))) +#else +#define FLUTTER_PLUGIN_EXPORT +#endif + +typedef struct _CronetPlugin CronetPlugin; +typedef struct { + GObjectClass parent_class; +} CronetPluginClass; + +FLUTTER_PLUGIN_EXPORT GType cronet_plugin_get_type(); + +FLUTTER_PLUGIN_EXPORT void cronet_plugin_register_with_registrar( + FlPluginRegistrar* registrar); + +G_END_DECLS + +#endif // FLUTTER_PLUGIN_CRONET_PLUGIN_H_ diff --git a/pubspec.yaml b/pubspec.yaml index fc36e52..ae510e4 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -3,12 +3,13 @@ # BSD-style license that can be found in the LICENSE file. name: cronet -version: 0.0.3 +version: 0.0.4 homepage: https://github.com/google/cronet.dart description: Experimental Cronet dart bindings. environment: sdk: '>=2.12.0 <3.0.0' + flutter: '>=2.0.0' dependencies: ffi: ^1.1.2 @@ -20,4 +21,17 @@ dependencies: dev_dependencies: ffigen: ^2.4.2 lints: ^1.0.1 - test: ^1.17.5 + test: ^1.16.0 + flutter_test: + sdk: flutter + +flutter: + plugin: + platforms: + android: + package: dev.google.cronet + pluginClass: CronetPlugin + linux: + pluginClass: CronetPlugin + windows: + pluginClass: CronetPlugin diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 262a75f..8a76d9d 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.15) +cmake_minimum_required(VERSION 3.10) set(PROJECT_NAME "cronet") project(${PROJECT_NAME} LANGUAGES C CXX) set(CMAKE_EXPORT_COMPILE_COMMANDS ON) @@ -8,7 +8,9 @@ set(CMAKE_CXX_STANDARD 11) # not be changed set(PLUGIN_NAME "wrapper") -add_compile_definitions(DART_SHARED_LIB) +if(NOT ANDROID) + add_compile_definitions(DART_SHARED_LIB) +endif (NOT ANDROID) add_library(${PLUGIN_NAME} SHARED "wrapper.cc" @@ -26,11 +28,6 @@ target_include_directories(${PLUGIN_NAME} INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/../third_party/cronet" ) -if (WIN32) - set(DART_DIR "C:/tools/dart-sdk/bin") - find_library(DART_LIB dart.lib ${DART_DIR}) - target_link_libraries(${PLUGIN_NAME} PRIVATE ${DART_LIB}) -endif (WIN32) if (MSVC) set(MSVC_DISABLED_WARNINGS_LIST diff --git a/src/wrapper.cc b/src/wrapper.cc index a05a4a7..e78fc57 100644 --- a/src/wrapper.cc +++ b/src/wrapper.cc @@ -151,7 +151,7 @@ char *statusText(Cronet_UrlResponseInfoPtr info, int statusCode, int lBound, int uBound) { if (!(statusCode >= lBound && statusCode <= uBound)) { Cronet_String status = _Cronet_UrlResponseInfo_http_status_text_get(info); - int statusLen = strlen(status); + size_t statusLen = strlen(status); char *statusDup = (char *)malloc(statusLen + 1); memcpy(statusDup, status, statusLen + 1); return statusDup; @@ -186,7 +186,7 @@ void OnRedirectReceived(Cronet_UrlRequestCallbackPtr self, Cronet_UrlRequestPtr request, Cronet_UrlResponseInfoPtr info, Cronet_String newLocationUrl) { - int len = strlen(newLocationUrl); + size_t len = strlen(newLocationUrl); char *newLoc = (char *)malloc(len + 1); memcpy(newLoc, newLocationUrl, len + 1); int statusCode = _Cronet_UrlResponseInfo_http_status_code_get(info); @@ -231,7 +231,7 @@ void OnSucceeded(Cronet_UrlRequestCallbackPtr self, void OnFailed(Cronet_UrlRequestCallbackPtr self, Cronet_UrlRequestPtr request, Cronet_UrlResponseInfoPtr info, Cronet_ErrorPtr error) { Cronet_String errStr = _Cronet_Error_message_get(error); - int len = strlen(errStr); + size_t len = strlen(errStr); char *dupStr = (char *)malloc(len + 1); memcpy(dupStr, errStr, len + 1); DispatchCallback("OnFailed", request, CallbackArgBuilder(1, dupStr)); diff --git a/tool/update_tars.dart b/tool/update_tars.dart index cee886d..6f8d5b0 100644 --- a/tool/update_tars.dart +++ b/tool/update_tars.dart @@ -6,18 +6,48 @@ import 'dart:io'; import 'package:cronet/src/constants.dart'; +import 'package:path/path.dart'; void main() { - Directory.current = Directory.current.uri.resolve('.dart_tool/cronet').path; - for (final platform in validPlatforms) { - if (File('$platform/${getCronetName(platform)}').existsSync()) { + final pwd = Directory.current; + Directory.current = + Directory.current.uri.resolve(join('.dart_tool', 'cronet')).path; + for (final platform in desktopPlatforms) { + if (File(join(platform, getCronetName(platform))).existsSync()) { final result = Process.runSync('tar', ['-czvf', '$platform.tar.gz', platform]); print(result.stdout); print(result.stderr); } else { - print( - '${getCronetName(platform)} not found in .dart_tool/cronet/$platform'); + print('${getCronetName(platform)} not found in' + + join('.dart_tool', 'cronet', platform)); } } + // Make tarball for android releases. + Directory.current = pwd; + if (!Directory(androidPaths['cronet.jar']!).existsSync()) return; + Directory(tempAndroidDownloadPath['cronet.jar']!).createSync(recursive: true); + Directory(androidPaths['cronet.jar']!).listSync().forEach((jar) { + if (jar is File) { + jar.copySync( + join(tempAndroidDownloadPath['cronet.jar']!, basename(jar.path))); + } + }); + Directory(tempAndroidDownloadPath['cronet.so']!).createSync(recursive: true); + Directory(androidPaths['cronet.so']!) + .listSync(recursive: true) + .forEach((cronet) { + if (cronet is File) { + Directory(join(tempAndroidDownloadPath['cronet.so']!, + basename(cronet.parent.path))) + .createSync(recursive: true); + cronet.copySync(join(tempAndroidDownloadPath['cronet.so']!, + basename(cronet.parent.path), basename(cronet.path))); + } + }); + Directory.current = + Directory.current.uri.resolve(join('.dart_tool', 'cronet')).path; + final result = Process.runSync('tar', ['-czvf', 'android.tar.gz', 'android']); + print(result.stdout); + print(result.stderr); } diff --git a/windows/.gitignore b/windows/.gitignore new file mode 100644 index 0000000..808064a --- /dev/null +++ b/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/windows/CMakeLists.txt b/windows/CMakeLists.txt new file mode 100644 index 0000000..7bc570a --- /dev/null +++ b/windows/CMakeLists.txt @@ -0,0 +1,24 @@ +cmake_minimum_required(VERSION 3.15) +set(PROJECT_NAME "cronet") +project(${PROJECT_NAME} LANGUAGES CXX) + +# This value is used when generating builds using this plugin, so it must +# not be changed +set(PLUGIN_NAME "cronet_plugin") + +add_library(${PLUGIN_NAME} SHARED + "cronet_plugin.cpp" +) +apply_standard_settings(${PLUGIN_NAME}) +set_target_properties(${PLUGIN_NAME} PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL) +target_include_directories(${PLUGIN_NAME} INTERFACE + "${CMAKE_CURRENT_SOURCE_DIR}/include") +target_link_libraries(${PLUGIN_NAME} PRIVATE flutter flutter_wrapper_plugin) + +# List of absolute paths to libraries that should be bundled with the plugin +set(cronet_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/windows/cronet_plugin.cpp b/windows/cronet_plugin.cpp new file mode 100644 index 0000000..ae44241 --- /dev/null +++ b/windows/cronet_plugin.cpp @@ -0,0 +1,82 @@ +#include "include/cronet/cronet_plugin.h" + +// This must be included before many other Windows headers. +#include + +// For getPlatformVersion; remove unless needed for your plugin implementation. +#include + +#include +#include +#include + +#include +#include +#include + +namespace { + +class CronetPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + + CronetPlugin(); + + virtual ~CronetPlugin(); + + private: + // Called when a method is called on this plugin's channel from Dart. + void HandleMethodCall( + const flutter::MethodCall &method_call, + std::unique_ptr> result); +}; + +// static +void CronetPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows *registrar) { + auto channel = + std::make_unique>( + registrar->messenger(), "cronet", + &flutter::StandardMethodCodec::GetInstance()); + + auto plugin = std::make_unique(); + + channel->SetMethodCallHandler( + [plugin_pointer = plugin.get()](const auto &call, auto result) { + plugin_pointer->HandleMethodCall(call, std::move(result)); + }); + + registrar->AddPlugin(std::move(plugin)); +} + +CronetPlugin::CronetPlugin() {} + +CronetPlugin::~CronetPlugin() {} + +void CronetPlugin::HandleMethodCall( + const flutter::MethodCall &method_call, + std::unique_ptr> result) { + if (method_call.method_name().compare("getPlatformVersion") == 0) { + std::ostringstream version_stream; + version_stream << "Windows "; + if (IsWindows10OrGreater()) { + version_stream << "10+"; + } else if (IsWindows8OrGreater()) { + version_stream << "8"; + } else if (IsWindows7OrGreater()) { + version_stream << "7"; + } + result->Success(flutter::EncodableValue(version_stream.str())); + } else { + result->NotImplemented(); + } +} + +} // namespace + +void CronetPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + CronetPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/windows/include/cronet/cronet_plugin.h b/windows/include/cronet/cronet_plugin.h new file mode 100644 index 0000000..05c3eb5 --- /dev/null +++ b/windows/include/cronet/cronet_plugin.h @@ -0,0 +1,23 @@ +#ifndef FLUTTER_PLUGIN_CRONET_PLUGIN_H_ +#define FLUTTER_PLUGIN_CRONET_PLUGIN_H_ + +#include + +#ifdef FLUTTER_PLUGIN_IMPL +#define FLUTTER_PLUGIN_EXPORT __declspec(dllexport) +#else +#define FLUTTER_PLUGIN_EXPORT __declspec(dllimport) +#endif + +#if defined(__cplusplus) +extern "C" { +#endif + +FLUTTER_PLUGIN_EXPORT void CronetPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +#endif // FLUTTER_PLUGIN_CRONET_PLUGIN_H_