[federated_plugin] adds support for Windows (#533)

2025-11-10 23:08:59 +00:00 · 2020-09-18 04:48:20 +05:30
parent 9b731e8556
commit 358485d7fa
36 changed files with 1364 additions and 2 deletions
--- a/experimental/federated_plugin/federated_plugin_windows/.gitignore
+++ b/experimental/federated_plugin/federated_plugin_windows/.gitignore
@@ -0,0 +1,7 @@
+.DS_Store
+.dart_tool/
+
+.packages
+.pub/
+
+build/
--- a/experimental/federated_plugin/federated_plugin_windows/.metadata
+++ b/experimental/federated_plugin/federated_plugin_windows/.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: 780f5f99044ce7fcbcd868e2cf6878da02022db5
+  channel: master
+
+project_type: plugin
--- a/experimental/federated_plugin/federated_plugin_windows/example/README.md
+++ b/experimental/federated_plugin/federated_plugin_windows/example/README.md
@@ -0,0 +1,3 @@
+# federated_plugin_windows_example
+
+To view the usage of plugin, head over to [federated_plugin/example](../../federated_plugin/example).
--- a/experimental/federated_plugin/federated_plugin_windows/lib/federated_plugin_windows.dart
+++ b/experimental/federated_plugin/federated_plugin_windows/lib/federated_plugin_windows.dart
@@ -0,0 +1,2 @@
+// The federated_plugin_windows uses the default BatteryMethodChannel used by
+// federated_plugin_platform_interface to do platform calls.
--- a/experimental/federated_plugin/federated_plugin_windows/pubspec.lock
+++ b/experimental/federated_plugin/federated_plugin_windows/pubspec.lock
@@ -0,0 +1,147 @@
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages:
+  async:
+    dependency: transitive
+    description:
+      name: async
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.5.0-nullsafety"
+  boolean_selector:
+    dependency: transitive
+    description:
+      name: boolean_selector
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.1.0-nullsafety"
+  characters:
+    dependency: transitive
+    description:
+      name: characters
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety.2"
+  charcode:
+    dependency: transitive
+    description:
+      name: charcode
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.2.0-nullsafety"
+  clock:
+    dependency: transitive
+    description:
+      name: clock
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety"
+  collection:
+    dependency: transitive
+    description:
+      name: collection
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.15.0-nullsafety.2"
+  fake_async:
+    dependency: transitive
+    description:
+      name: fake_async
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety"
+  flutter:
+    dependency: "direct main"
+    description: flutter
+    source: sdk
+    version: "0.0.0"
+  flutter_test:
+    dependency: "direct dev"
+    description: flutter
+    source: sdk
+    version: "0.0.0"
+  matcher:
+    dependency: transitive
+    description:
+      name: matcher
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.12.10-nullsafety"
+  meta:
+    dependency: transitive
+    description:
+      name: meta
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.3.0-nullsafety.2"
+  path:
+    dependency: transitive
+    description:
+      name: path
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.8.0-nullsafety"
+  sky_engine:
+    dependency: transitive
+    description: flutter
+    source: sdk
+    version: "0.0.99"
+  source_span:
+    dependency: transitive
+    description:
+      name: source_span
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.8.0-nullsafety"
+  stack_trace:
+    dependency: transitive
+    description:
+      name: stack_trace
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.10.0-nullsafety"
+  stream_channel:
+    dependency: transitive
+    description:
+      name: stream_channel
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.1.0-nullsafety"
+  string_scanner:
+    dependency: transitive
+    description:
+      name: string_scanner
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.0-nullsafety"
+  term_glyph:
+    dependency: transitive
+    description:
+      name: term_glyph
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.2.0-nullsafety"
+  test_api:
+    dependency: transitive
+    description:
+      name: test_api
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.2.19-nullsafety"
+  typed_data:
+    dependency: transitive
+    description:
+      name: typed_data
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.3.0-nullsafety.2"
+  vector_math:
+    dependency: transitive
+    description:
+      name: vector_math
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.1.0-nullsafety.2"
+sdks:
+  dart: ">=2.10.0-0.0.dev <2.10.0"
+  flutter: ">=1.20.0 <2.0.0"
--- a/experimental/federated_plugin/federated_plugin_windows/pubspec.yaml
+++ b/experimental/federated_plugin/federated_plugin_windows/pubspec.yaml
@@ -0,0 +1,24 @@
+name: federated_plugin_windows
+description: Windows implementation of federated_plugin to retrieve current battery level.
+version: 0.0.1
+author:
+homepage:
+publish_to: none
+
+environment:
+  sdk: ">=2.7.0 <3.0.0"
+  flutter: ">=1.20.0 <2.0.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+
+flutter:
+  plugin:
+    platforms:
+      windows:
+        pluginClass: FederatedPluginWindowsPlugin
--- a/experimental/federated_plugin/federated_plugin_windows/windows/.gitignore
+++ b/experimental/federated_plugin/federated_plugin_windows/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/
--- a/experimental/federated_plugin/federated_plugin_windows/windows/CMakeLists.txt
+++ b/experimental/federated_plugin/federated_plugin_windows/windows/CMakeLists.txt
@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.15)
+set(PROJECT_NAME "federated_plugin_windows")
+project(${PROJECT_NAME} LANGUAGES CXX)
+
+set(PLUGIN_NAME "${PROJECT_NAME}_plugin")
+
+add_library(${PLUGIN_NAME} SHARED
+  "${PLUGIN_NAME}.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(federated_plugin_windows_bundled_libraries
+  ""
+  PARENT_SCOPE
+)
--- a/experimental/federated_plugin/federated_plugin_windows/windows/federated_plugin_windows_plugin.cpp
+++ b/experimental/federated_plugin/federated_plugin_windows/windows/federated_plugin_windows_plugin.cpp
@@ -0,0 +1,87 @@
+// Copyright 2020 The Flutter team. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "include/federated_plugin_windows/federated_plugin_windows_plugin.h"
+
+#include <windows.h>
+
+#include <flutter/method_channel.h>
+#include <flutter/plugin_registrar_windows.h>
+#include <flutter/standard_method_codec.h>
+
+#include <map>
+#include <memory>
+
+namespace {
+
+	class FederatedPluginWindowsPlugin : public flutter::Plugin {
+	public:
+		static void RegisterWithRegistrar(flutter::PluginRegistrarWindows* registrar);
+
+		FederatedPluginWindowsPlugin();
+
+		virtual ~FederatedPluginWindowsPlugin();
+
+	private:
+		// Called when a method is called on this plugin's channel from Dart.
+		void HandleMethodCall(
+			const flutter::MethodCall<flutter::EncodableValue>& method_call,
+			std::unique_ptr<flutter::MethodResult<flutter::EncodableValue>> result);
+	};
+
+	void FederatedPluginWindowsPlugin::RegisterWithRegistrar(
+		flutter::PluginRegistrarWindows* registrar) {
+		auto channel =
+			std::make_unique<flutter::MethodChannel<flutter::EncodableValue>>(
+				registrar->messenger(), "battery",
+				&flutter::StandardMethodCodec::GetInstance());
+
+		auto plugin = std::make_unique<FederatedPluginWindowsPlugin>();
+
+		channel->SetMethodCallHandler(
+			[plugin_pointer = plugin.get()](const auto& call, auto result) {
+			plugin_pointer->HandleMethodCall(call, std::move(result));
+		});
+
+		registrar->AddPlugin(std::move(plugin));
+	}
+
+	FederatedPluginWindowsPlugin::FederatedPluginWindowsPlugin() {}
+
+	FederatedPluginWindowsPlugin::~FederatedPluginWindowsPlugin() {}
+
+	void FederatedPluginWindowsPlugin::HandleMethodCall(
+		const flutter::MethodCall<flutter::EncodableValue>& method_call,
+		std::unique_ptr<flutter::MethodResult<flutter::EncodableValue>> result) {
+		if (method_call.method_name().compare("getBatteryLevel") == 0) {
+			SYSTEM_POWER_STATUS systemPower;
+			// GetSystemPowerStatus will retrieve the power status of the system.
+			if (GetSystemPowerStatus(&systemPower)) {
+				int batteryLevel = systemPower.BatteryLifePercent;
+				// The batteryLevel value in the range 0 to 100, or 255 if status is unknown.
+				if (batteryLevel != 255) {
+					flutter::EncodableValue response(batteryLevel);
+					result->Success(&response);
+				}
+				else {
+					result->Error("STATUS_UNAVAILABLE", "Not able to determine battery level.");
+				}
+			}
+			else {
+				result->Error("STATUS_UNAVAILABLE", "Not able to determine battery level.");
+			}
+		}
+		else {
+			result->NotImplemented();
+		}
+	}
+
+}
+
+void FederatedPluginWindowsPluginRegisterWithRegistrar(
+	FlutterDesktopPluginRegistrarRef registrar) {
+	FederatedPluginWindowsPlugin::RegisterWithRegistrar(
+		flutter::PluginRegistrarManager::GetInstance()
+		->GetRegistrar<flutter::PluginRegistrarWindows>(registrar));
+}
--- a/experimental/federated_plugin/federated_plugin_windows/windows/include/federated_plugin_windows/federated_plugin_windows_plugin.h
+++ b/experimental/federated_plugin/federated_plugin_windows/windows/include/federated_plugin_windows/federated_plugin_windows_plugin.h
@@ -0,0 +1,23 @@
+#ifndef FLUTTER_PLUGIN_FEDERATED_PLUGIN_WINDOWS_PLUGIN_H_
+#define FLUTTER_PLUGIN_FEDERATED_PLUGIN_WINDOWS_PLUGIN_H_
+
+#include <flutter_plugin_registrar.h>
+
+#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 FederatedPluginWindowsPluginRegisterWithRegistrar(
+    FlutterDesktopPluginRegistrarRef registrar);
+
+#if defined(__cplusplus)
+}  // extern "C"
+#endif
+
+#endif  // FLUTTER_PLUGIN_FEDERATED_PLUGIN_WINDOWS_PLUGIN_H_