未验证 提交 927f8cbc 编写于 作者: S stuartmorgan 提交者: GitHub

Remove path_provider_fde (#801)

Removes path_provider_fde, since path_provider now supports Windows.

flutter_plugins is no longer needed as a concept since the APIs have stabilized
on all platforms, so this removes it entirely, and updates all the READMEs
accordingly.

All the previous-flutter_plugins-plugins have been removed from testbed, since
there is no longer any reason to test them in this repository.
上级 66728170
......@@ -21,20 +21,12 @@ tracker](https://github.com/flutter/flutter/issues).
For bug reports and feature requests **related to the plugins in this repository**,
please file issues here. Before filing a bug, see Supported Versions below.
## Supported Versions
Breaking changes in Flutter for desktop are still relatively common. The plugins here
are not guaranteed to work in anything other than the latest version of the [Flutter master
channel](https://github.com/flutter/flutter/wiki/Flutter-build-release-channels#how-to-change-channels).
## Repository Structure
The `plugins` directory contains all the plugins. See
[its README](plugins/README.md) to get started.
`testbed` is a a simple test application for the plugins above. (The typical
structure of having an example app in each plugin is not used here to avoid
the overhead of updating many applications each time there is a breaking change.)
`testbed` is a a simple test application for the plugins above.
## Caveats
......
......@@ -4,18 +4,12 @@ See [the Flutter desktop
page](https://github.com/flutter/flutter/wiki/Desktop-shells#plugins)
for an overview of the current state of plugin development on desktop.
This directory contains two types of plugins:
* `flutter_plugins`, which contain Windows and Linux implementations of plugins
from [the flutter/plugins repository](https://github.com/flutter/plugins).
They are expected to move to that repository once the plugin APIs for those
platforms are sufficiently stable.
* Plugins that prototype functionality that will likely become part of
Flutter itself.
This directory contains plugins that prototype functionality that will likely
either become part of Flutter itself, or become officially supported plugins.
## Using Plugins
Since the plugins in this repository are not intended to live here long term,
and the `flutter` tool's plugin support isn't finalized on all platforms yet,
these plugins are not published on pub.dev like normal Flutter plugins. Instead,
you should include them directly from this repository:
......
# Windows Implementations of flutter/plugins Plugins
Each plugin in this directory corresponds to a
[`flutter/plugins`](https://github.com/flutter/plugins) plugin with the
same name, minus the `_fde` suffix.
These implementations exist here only as a temporary solution to use these
plugins while the plugin APIs on Windows stabilize enough that
they can move to the official location and be distributed as normal Flutter
plugins. macOS and Linux plugin APIs and tooling are stable, so are already
hosted normally rather than here.
## Using These Plugins
For these plugins, the Dart code comes from the official plugin, so you
must include that in your `pubspec.yaml` as well. For instance, to use
path\_provider on Windows, you would include both `path_provider` and
`path_provider_fde` in your pubspec.yaml (see [the main plugin
README](../README.md) for instructions on adding these plugins to your
`pubspec.yaml`).
Since the Dart code for those plugins comes from the official plugin, you
do not need to add any `import` in the Dart code other than the main
plugin's `import`. For instance, you would just
`import 'package:path_provider/path_provider.dart';` to use path\_provider\_fde.
## Contributing
If you are interested in implementing a flutter/plugins plugin for Windows
please open a PR!
.dart_tool
.packages
.flutter-plugins
.flutter-plugins-dependencies
pubspec.lock
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# path_provider_fde
Prototype Windows implementation of
[path_provider](https://pub.dev/packages/path_provider)
See [the main flutter_plugins README](../README.md) for general information about what
this plugin is and how to use it.
## Supported Platforms
- [x] Windows
macOS and Linux are already supported by `path_provider`.
## Caveats
The paths returned by this plugin may change in the future. Most notably,
`getApplicationSupportDirectory` will likely return a different path in the
future.
name: path_provider_fde
description: Temporary desktop implmentations of path_provider from flutter/plugins
version: 0.0.1
# Do not publish this plugin. See:
# https://github.com/google/flutter-desktop-embedding/blob/master/plugins/README.md#using-plugins
publish_to: none
flutter:
plugin:
platforms:
windows:
pluginClass: PathProviderPlugin
environment:
sdk: ">=2.1.0 <3.0.0"
dependencies:
flutter:
sdk: flutter
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/
cmake_minimum_required(VERSION 3.10)
set(PROJECT_NAME "path_provider_fde")
project(${PROJECT_NAME} LANGUAGES CXX)
set(PLUGIN_NAME "${PROJECT_NAME}_plugin")
add_library(${PLUGIN_NAME} SHARED
"path_provider_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_compile_definitions(${PLUGIN_NAME} PRIVATE _SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING)
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(path_provider_fde_bundled_libraries
""
PARENT_SCOPE
)
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef PLUGINS_PATH_PROVIDER_PLUGIN_WINDOWS_H_
#define PLUGINS_PATH_PROVIDER_PLUGIN_WINDOWS_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 PathProviderPluginRegisterWithRegistrar(
FlutterDesktopPluginRegistrarRef registrar);
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // PLUGINS_PATH_PROVIDER_PLUGIN_WINDOWS_H_
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "include/path_provider_fde/path_provider_plugin.h"
#include <ShlObj.h>
#include <flutter/method_channel.h>
#include <flutter/plugin_registrar_windows.h>
#include <flutter/standard_method_codec.h>
#include <windows.h>
#include <codecvt>
#include <memory>
#include <sstream>
#include <string>
namespace {
using flutter::EncodableValue;
// Converts an null-terminated array of wchar_t's to a std::string.
std::string StdStringFromWideChars(wchar_t *wide_chars) {
std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>> wide_to_utf8;
return wide_to_utf8.to_bytes(wide_chars);
}
// Gets the path to the given folder ID, without verifying that it exists,
// or an empty string on failure.
std::string GetFolderPath(REFKNOWNFOLDERID folder_id) {
wchar_t *wide_path = nullptr;
if (!SUCCEEDED(SHGetKnownFolderPath(folder_id, KF_FLAG_DONT_VERIFY, nullptr,
&wide_path))) {
return "";
}
std::string path = StdStringFromWideChars(wide_path);
CoTaskMemFree(wide_path);
return path;
}
// Returns the name of the executable, without the .exe extension, or an empty
// string on failure.
std::string GetExecutableName() {
wchar_t buffer[MAX_PATH];
if (GetModuleFileName(nullptr, buffer, MAX_PATH) == 0) {
return "";
}
std::string executable_path = StdStringFromWideChars(buffer);
size_t last_separator_position = executable_path.find_last_of('\\');
std::string executable_name;
if (last_separator_position == std::string::npos) {
executable_name = executable_path;
} else {
executable_name = executable_path.substr(last_separator_position + 1);
}
// Strip the .exe extension, if present.
std::string extension = ".exe";
if (executable_name.compare(executable_name.size() - extension.size(),
extension.size(), extension) == 0) {
executable_name =
executable_name.substr(0, executable_name.size() - extension.size());
}
return executable_name;
}
class PathProviderPlugin : public flutter::Plugin {
public:
static void RegisterWithRegistrar(flutter::PluginRegistrar *registrar);
virtual ~PathProviderPlugin();
private:
PathProviderPlugin();
// Called when a method is called on plugin channel;
void HandleMethodCall(
const flutter::MethodCall<> &method_call,
std::unique_ptr<flutter::MethodResult<>> result);
};
// static
void PathProviderPlugin::RegisterWithRegistrar(
flutter::PluginRegistrar *registrar) {
auto channel = std::make_unique<flutter::MethodChannel<>>(
registrar->messenger(), "plugins.flutter.io/path_provider",
&flutter::StandardMethodCodec::GetInstance());
// Uses new instead of make_unique due to private constructor.
std::unique_ptr<PathProviderPlugin> plugin(new PathProviderPlugin());
channel->SetMethodCallHandler(
[plugin_pointer = plugin.get()](const auto &call, auto result) {
plugin_pointer->HandleMethodCall(call, std::move(result));
});
registrar->AddPlugin(std::move(plugin));
}
PathProviderPlugin::PathProviderPlugin() = default;
PathProviderPlugin::~PathProviderPlugin() = default;
void PathProviderPlugin::HandleMethodCall(
const flutter::MethodCall<> &method_call,
std::unique_ptr<flutter::MethodResult<>> result) {
if (method_call.method_name().compare("getTemporaryDirectory") == 0) {
wchar_t path_buffer[MAX_PATH];
DWORD length = GetTempPath(MAX_PATH, path_buffer);
if (length == 0 || length > MAX_PATH) {
result->Error("Unable to get temporary path");
return;
}
std::string result_path = StdStringFromWideChars(path_buffer);
result->Success(EncodableValue(result_path));
} else if (method_call.method_name().compare(
"getApplicationSupportDirectory") == 0) {
std::string path = GetFolderPath(FOLDERID_RoamingAppData);
if (path.empty()) {
result->Error("Unable to get application data path");
return;
}
// Use the executable name as the subdirectory for now.
std::string exe_name = GetExecutableName();
if (exe_name.empty()) {
result->Error("Unable to get exe name");
return;
}
std::ostringstream response_stream;
response_stream << path << "\\" << exe_name;
result->Success(EncodableValue(response_stream.str()));
} else if (method_call.method_name().compare(
"getApplicationDocumentsDirectory") == 0) {
std::string path = GetFolderPath(FOLDERID_Documents);
if (path.empty()) {
result->Error("Unable to get documents path");
return;
}
result->Success(EncodableValue(path));
} else if (method_call.method_name().compare("getDownloadsDirectory") == 0) {
std::string path = GetFolderPath(FOLDERID_Downloads);
if (path.empty()) {
result->Error("Unable to get downloads path");
return;
}
result->Success(EncodableValue(path));
} else {
result->NotImplemented();
}
}
} // namespace
void PathProviderPluginRegisterWithRegistrar(
FlutterDesktopPluginRegistrarRef registrar) {
PathProviderPlugin::RegisterWithRegistrar(
flutter::PluginRegistrarManager::GetInstance()
->GetRegistrar<flutter::PluginRegistrarWindows>(registrar));
}
......@@ -14,9 +14,3 @@ This application is only likely to be useful if:
Since it serves as simple test environment for the plugins that are part of
this project, and some desktop-specific Flutter functionality, it is a
collection of unrelated functionality rather than a usable application.
## Setting Up
This application uses all of the plugins in this repository, so make sure you
have all the dependencies for
[building the plugins on your platform](../plugins/README.md).
......@@ -19,16 +19,10 @@ import 'package:flutter/services.dart';
import 'package:file_chooser/file_chooser.dart';
import 'package:menubar/menubar.dart';
import 'package:path_provider/path_provider.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:url_launcher/url_launcher.dart' as url_launcher;
import 'package:window_size/window_size.dart' as window_size;
import 'keyboard_test_page.dart';
// The shared_preferences key for the testbed's color.
const _prefKeyColor = 'color';
void main() {
// Try to resize and reposition the window to be half the width and height
// of its screen, centered horizontally and shifted up from center.
......@@ -62,16 +56,6 @@ class MyApp extends StatefulWidget {
}
class _AppState extends State<MyApp> {
_AppState() {
if (Platform.isMacOS || Platform.isLinux) {
SharedPreferences.getInstance().then((prefs) {
if (prefs.containsKey(_prefKeyColor)) {
setPrimaryColor(Color(prefs.getInt(_prefKeyColor)));
}
});
}
}
Color _primaryColor = Colors.blue;
int _counter = 0;
......@@ -83,14 +67,6 @@ class _AppState extends State<MyApp> {
setState(() {
_primaryColor = color;
});
_saveColor();