From 31ffa90f0e5a24697d1a5ad36cffb8fee9e675ac Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Fri, 24 Sep 2021 15:23:57 -0400 Subject: [PATCH 01/22] Initial copy directly from FDE --- .../file_selector_windows/.gitignore | 5 + .../file_selector_windows/.metadata | 10 + .../file_selector_windows/CHANGELOG.md | 11 + .../file_selector_windows/LICENSE | 25 ++ .../file_selector_windows/README.md | 19 + .../file_selector_windows/pubspec.yaml | 19 + .../file_selector_windows/windows/.gitignore | 17 + .../windows/CMakeLists.txt | 22 + .../windows/file_selector_plugin.cpp | 403 ++++++++++++++++++ .../file_selector_plugin.h | 26 ++ 10 files changed, 557 insertions(+) create mode 100644 packages/file_selector/file_selector_windows/.gitignore create mode 100644 packages/file_selector/file_selector_windows/.metadata create mode 100644 packages/file_selector/file_selector_windows/CHANGELOG.md create mode 100644 packages/file_selector/file_selector_windows/LICENSE create mode 100644 packages/file_selector/file_selector_windows/README.md create mode 100644 packages/file_selector/file_selector_windows/pubspec.yaml create mode 100644 packages/file_selector/file_selector_windows/windows/.gitignore create mode 100644 packages/file_selector/file_selector_windows/windows/CMakeLists.txt create mode 100644 packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h diff --git a/packages/file_selector/file_selector_windows/.gitignore b/packages/file_selector/file_selector_windows/.gitignore new file mode 100644 index 000000000000..0393a47ff732 --- /dev/null +++ b/packages/file_selector/file_selector_windows/.gitignore @@ -0,0 +1,5 @@ +.dart_tool +.packages +.flutter-plugins +.flutter-plugins-dependencies +pubspec.lock diff --git a/packages/file_selector/file_selector_windows/.metadata b/packages/file_selector/file_selector_windows/.metadata new file mode 100644 index 000000000000..720a4596c087 --- /dev/null +++ b/packages/file_selector/file_selector_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: 6d1c244b79f3a2747281f718297ce248bd5ad099 + channel: master + +project_type: plugin diff --git a/packages/file_selector/file_selector_windows/CHANGELOG.md b/packages/file_selector/file_selector_windows/CHANGELOG.md new file mode 100644 index 000000000000..a54a68875501 --- /dev/null +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -0,0 +1,11 @@ +## 0.0.2+1 + +* Update README + +## 0.0.2 + +* Update SDK constraint to signal compatibility with null safety. + +## 0.0.1 + +* Initial Windows implementation of `file_selector`. diff --git a/packages/file_selector/file_selector_windows/LICENSE b/packages/file_selector/file_selector_windows/LICENSE new file mode 100644 index 000000000000..67c7e2c52e46 --- /dev/null +++ b/packages/file_selector/file_selector_windows/LICENSE @@ -0,0 +1,25 @@ +Copyright 2020 The Flutter Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + * Neither the name of Google Inc. nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/packages/file_selector/file_selector_windows/README.md b/packages/file_selector/file_selector_windows/README.md new file mode 100644 index 000000000000..69fb088d599e --- /dev/null +++ b/packages/file_selector/file_selector_windows/README.md @@ -0,0 +1,19 @@ +# file\_selector\_windows + +The Windows implementation of [`file_selector`][1]. + +## Usage + +### Importing the package + +This implementation has not yet been endorsed, meaning that you need to +[depend on `file_selector_windows`][2] in addition to +[depending on `file_selector`][3]. + +Once your pubspec includes the Windows implementation, you can use the +`file_selector` APIs normally. You should not use the `file_selector_windows` +APIs directly. + +[1]: https://pub.dev/packages/file_selector +[2]: https://pub.dev/packages/file_selector_windows/install +[3]: https://pub.dev/packages/file_selector/install diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml new file mode 100644 index 000000000000..d13fa9e04f9e --- /dev/null +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -0,0 +1,19 @@ +name: file_selector_windows +description: Windows implementation of the file_selector plugin. +version: 0.0.2+1 +homepage: https://github.com/google/flutter-desktop-embedding/tree/master/plugins/file_selector/file_selector_windows + +flutter: + plugin: + implements: file_selector + platforms: + windows: + pluginClass: FileSelectorPlugin + +environment: + sdk: ">=2.12.0 <3.0.0" + flutter: ">=1.22.0" + +dependencies: + flutter: + sdk: flutter diff --git a/packages/file_selector/file_selector_windows/windows/.gitignore b/packages/file_selector/file_selector_windows/windows/.gitignore new file mode 100644 index 000000000000..b3eb2be169a5 --- /dev/null +++ b/packages/file_selector/file_selector_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/ diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt new file mode 100644 index 000000000000..56b2eeceb94d --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.10) +set(PROJECT_NAME "file_selector_windows") +project(${PROJECT_NAME} LANGUAGES CXX) + +set(PLUGIN_NAME "${PROJECT_NAME}_plugin") + +add_library(${PLUGIN_NAME} SHARED + "file_selector_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(file_selector_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp new file mode 100644 index 000000000000..f087f293bbf1 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -0,0 +1,403 @@ +// Copyright 2020 The Flutter Authors. 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/file_selector_windows/file_selector_plugin.h" + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +namespace { + +using flutter::EncodableList; +using flutter::EncodableMap; +using flutter::EncodableValue; + +// From method_channel_file_selector.dart +const char kChannelName[] = "plugins.flutter.io/file_selector"; + +const char kOpenFileMethod[] = "openFile"; +const char kGetSavePathMethod[] = "getSavePath"; +const char kGetDirectoryPathMethod[] = "getDirectoryPath"; + +const char kAcceptedTypeGroupsKey[] = "acceptedTypeGroups"; +const char kConfirmButtonTextKey[] = "confirmButtonText"; +const char kInitialDirectoryKey[] = "initialDirectory"; +const char kMultipleKey[] = "multiple"; +const char kSuggestedNameKey[] = "suggestedName"; + +// From x_type_group.dart +// Only 'extensions' are supported by Windows for filtering. +const char kTypeGroupLabelKey[] = "label"; +const char kTypeGroupExtensionsKey[] = "extensions"; + +// Converts the given UTF-16 string to UTF-8. +std::string Utf8FromUtf16(const std::wstring &utf16_string) { + if (utf16_string.empty()) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string.data(), + static_cast(utf16_string.length()), 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.data(), + static_cast(utf16_string.length()), utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} + +// Converts the given UTF-8 string to UTF-16. +std::wstring Utf16FromUtf8(const std::string &utf8_string) { + if (utf8_string.empty()) { + return std::wstring(); + } + int target_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), nullptr, 0); + if (target_length == 0) { + return std::wstring(); + } + std::wstring utf16_string; + utf16_string.resize(target_length); + int converted_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), + utf16_string.data(), target_length); + if (converted_length == 0) { + return std::wstring(); + } + return utf16_string; +} + +// Looks for |key| in |map|, returning the associated value if it is present, or +// a nullptr if not. +const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { + auto it = map.find(EncodableValue(key)); + if (it == map.end()) { + return nullptr; + } + return &(it->second); +} + +// Returns the path for |shell_item| as a UTF-8 string, or an +// empty string on failure. +std::string GetPathForShellItem(IShellItem *shell_item) { + wchar_t *wide_path = nullptr; + if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) { + return ""; + } + std::string path = Utf8FromUtf16(wide_path); + CoTaskMemFree(wide_path); + return path; +} + +// Wraps an IFileDialog, managing object lifetime as a scoped object and +// providing a simplified API for interacting with it as needed for the plugin. +class DialogWrapper { + public: + explicit DialogWrapper(IID type) { + is_open_dialog_ = type == CLSID_FileOpenDialog; + last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&dialog_)); + } + + ~DialogWrapper() { + if (dialog_) { + dialog_->Release(); + } + } + + // Attempts to set the default folder for the dialog to |path|, + // if it exists. + void SetDefaultFolder(const std::string &path) { + std::wstring wide_path = Utf16FromUtf8(path); + IShellItem *item; + last_result_ = SHCreateItemFromParsingName(wide_path.c_str(), nullptr, + IID_PPV_ARGS(&item)); + if (!SUCCEEDED(last_result_)) { + return; + } + dialog_->SetDefaultFolder(item); + item->Release(); + } + + // Sets the file name that is initially shown in the dialog. + void SetFileName(const std::string &name) { + std::wstring wide_name = Utf16FromUtf8(name); + last_result_ = dialog_->SetFileName(wide_name.c_str()); + } + + // Sets the label of the confirmation button. + void SetOkButtonLabel(const std::string &label) { + std::wstring wide_label = Utf16FromUtf8(label); + last_result_ = dialog_->SetOkButtonLabel(wide_label.c_str()); + } + + // Adds the given options to the dialog's current option set. + void AddOptions(FILEOPENDIALOGOPTIONS new_options) { + FILEOPENDIALOGOPTIONS options; + last_result_ = dialog_->GetOptions(&options); + if (!SUCCEEDED(last_result_)) { + return; + } + options |= new_options; + if (options & FOS_PICKFOLDERS) { + opening_directory_ = true; + } + last_result_ = dialog_->SetOptions(options); + } + + // Sets the filters for allowed file types to select. + void SetFileTypeFilters(const EncodableList &filters) { + const std::wstring spec_delimiter = L";"; + const std::wstring file_wildcard = L"*."; + std::vector filter_specs; + // Temporary ownership of the constructed strings whose data is used in + // filter_specs, so that they live until the call to SetFileTypes is done. + std::vector filter_names; + std::vector filter_extensions; + filter_extensions.reserve(filters.size()); + filter_names.reserve(filters.size()); + + for (const EncodableValue &filter_info_value : filters) { + const auto &filter_info = std::get(filter_info_value); + const auto *filter_name = std::get_if( + ValueOrNull(filter_info, kTypeGroupLabelKey)); + const auto *extensions = std::get_if( + ValueOrNull(filter_info, kTypeGroupExtensionsKey)); + filter_names.push_back(filter_name ? Utf16FromUtf8(*filter_name) : L""); + filter_extensions.push_back(L""); + std::wstring &spec = filter_extensions.back(); + if (!extensions || extensions->empty()) { + spec += L"*.*"; + } else { + for (const EncodableValue &extension : *extensions) { + if (!spec.empty()) { + spec += spec_delimiter; + } + spec += + file_wildcard + Utf16FromUtf8(std::get(extension)); + } + } + filter_specs.push_back({filter_names.back().c_str(), spec.c_str()}); + } + last_result_ = dialog_->SetFileTypes(static_cast(filter_specs.size()), + filter_specs.data()); + } + + // Displays the dialog, and returns the selected file or files as an + // EncodableValue of type List (for open) or String (for save), or a null + // EncodableValue on cancel or error. + EncodableValue Show(HWND parent_window) { + assert(dialog_); + last_result_ = dialog_->Show(parent_window); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + + if (is_open_dialog_) { + IFileOpenDialog *open_dialog; + last_result_ = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + IShellItemArray *shell_items; + last_result_ = open_dialog->GetResults(&shell_items); + open_dialog->Release(); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + IEnumShellItems *item_enumerator; + last_result_ = shell_items->EnumItems(&item_enumerator); + if (!SUCCEEDED(last_result_)) { + shell_items->Release(); + return EncodableValue(); + } + EncodableList files; + IShellItem *shell_item; + while (item_enumerator->Next(1, &shell_item, nullptr) == S_OK) { + files.push_back(EncodableValue(GetPathForShellItem(shell_item))); + shell_item->Release(); + } + item_enumerator->Release(); + shell_items->Release(); + if (opening_directory_) { + // The directory option expects a String, not a List. + if (files.empty()) { + return EncodableValue(); + } + return EncodableValue(files[0]); + } else { + return EncodableValue(std::move(files)); + } + } else { + IShellItem *shell_item; + last_result_ = dialog_->GetResult(&shell_item); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + EncodableValue file(GetPathForShellItem(shell_item)); + shell_item->Release(); + return file; + } + } + + // Returns the result of the last Win32 API call related to this object. + HRESULT last_result() { return last_result_; } + + private: + IFileDialog *dialog_ = nullptr; + bool is_open_dialog_; + bool opening_directory_ = false; + HRESULT last_result_; +}; + +// Displays the open or save dialog (according to |method|) and sends the +// selected file path(s) back to the engine via |result|, or sends an +// error on failure. +// +// |result| is guaranteed to be resolved by this function. +void ShowDialog(HWND parent_window, const std::string &method, + const EncodableMap &args, + std::unique_ptr> result) { + IID dialog_type = method.compare(kGetSavePathMethod) == 0 + ? CLSID_FileSaveDialog + : CLSID_FileOpenDialog; + DialogWrapper dialog(dialog_type); + if (!SUCCEEDED(dialog.last_result())) { + result->Error("System error", "Could not create dialog", + EncodableValue(dialog.last_result())); + return; + } + + FILEOPENDIALOGOPTIONS dialog_options = 0; + if (method.compare(kGetDirectoryPathMethod) == 0) { + dialog_options |= FOS_PICKFOLDERS; + } + const auto *allow_multiple_selection = + std::get_if(ValueOrNull(args, kMultipleKey)); + if (allow_multiple_selection && *allow_multiple_selection) { + dialog_options |= FOS_ALLOWMULTISELECT; + } + if (dialog_options != 0) { + dialog.AddOptions(dialog_options); + } + + const auto *initial_dir = + std::get_if(ValueOrNull(args, kInitialDirectoryKey)); + if (initial_dir) { + dialog.SetDefaultFolder(*initial_dir); + } + const auto *suggested_name = + std::get_if(ValueOrNull(args, kSuggestedNameKey)); + if (suggested_name) { + dialog.SetFileName(*suggested_name); + } + const auto *confirm_label = + std::get_if(ValueOrNull(args, kConfirmButtonTextKey)); + if (confirm_label) { + dialog.SetOkButtonLabel(*confirm_label); + } + const auto *accepted_types = + std::get_if(ValueOrNull(args, kAcceptedTypeGroupsKey)); + if (accepted_types && !accepted_types->empty()) { + dialog.SetFileTypeFilters(*accepted_types); + } + + EncodableValue files = dialog.Show(parent_window); + if (files.IsNull() && + dialog.last_result() != HRESULT_FROM_WIN32(ERROR_CANCELLED)) { + ; + result->Error("System error", "Could not show dialog", + EncodableValue(dialog.last_result())); + } + result->Success(files); +} + +// Returns the top-level window that owns |view|. +HWND GetRootWindow(flutter::FlutterView *view) { + return GetAncestor(view->GetNativeWindow(), GA_ROOT); +} + +class FileSelectorPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + + virtual ~FileSelectorPlugin(); + + private: + FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); + + // Called when a method is called on plugin channel; + void HandleMethodCall(const flutter::MethodCall<> &method_call, + std::unique_ptr> result); + + // The registrar for this plugin, for accessing the window. + flutter::PluginRegistrarWindows *registrar_; +}; + +// static +void FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows *registrar) { + auto channel = std::make_unique>( + registrar->messenger(), "plugins.flutter.io/file_selector", + &flutter::StandardMethodCodec::GetInstance()); + + // Uses new instead of make_unique due to private constructor. + std::unique_ptr plugin(new FileSelectorPlugin(registrar)); + + channel->SetMethodCallHandler( + [plugin_pointer = plugin.get()](const auto &call, auto result) { + plugin_pointer->HandleMethodCall(call, std::move(result)); + }); + + registrar->AddPlugin(std::move(plugin)); +} + +FileSelectorPlugin::FileSelectorPlugin( + flutter::PluginRegistrarWindows *registrar) + : registrar_(registrar) {} + +FileSelectorPlugin::~FileSelectorPlugin() = default; + +void FileSelectorPlugin::HandleMethodCall( + const flutter::MethodCall<> &method_call, + std::unique_ptr> result) { + const std::string &method_name = method_call.method_name(); + if (method_name.compare(kOpenFileMethod) == 0 || + method_name.compare(kGetSavePathMethod) == 0 || + method_name.compare(kGetDirectoryPathMethod) == 0) { + const auto *arguments = + std::get_if(method_call.arguments()); + assert(arguments); + ShowDialog(GetRootWindow(registrar_->GetView()), method_name, *arguments, + std::move(result)); + } else { + result->NotImplemented(); + } +} + +} // namespace + +void FileSelectorPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h new file mode 100644 index 000000000000..7ad3bd2eb490 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h @@ -0,0 +1,26 @@ +// Copyright 2020 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ +#define PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_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 FileSelectorPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +#endif // PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ From c0fbde3289769bbd03c21003fd6a511c2cfd9778 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Fri, 24 Sep 2021 15:32:36 -0400 Subject: [PATCH 02/22] Duplicate macOS example, and replace the macos/ boilerplate with windows/ boilerplate --- .../file_selector_windows/example/.gitignore | 48 ++++ .../file_selector_windows/example/.metadata | 10 + .../file_selector_windows/example/README.md | 4 + .../example/analysis_options.yaml | 29 +++ .../example/lib/get_directory_page.dart | 76 ++++++ .../example/lib/home_page.dart | 57 ++++ .../example/lib/main.dart | 37 +++ .../example/lib/open_image_page.dart | 87 +++++++ .../lib/open_multiple_images_page.dart | 98 +++++++ .../example/lib/open_text_page.dart | 83 ++++++ .../example/lib/save_text_page.dart | 77 ++++++ .../example/pubspec.yaml | 27 ++ .../example/windows/.gitignore | 17 ++ .../example/windows/CMakeLists.txt | 95 +++++++ .../example/windows/flutter/CMakeLists.txt | 103 ++++++++ .../flutter/generated_plugin_registrant.h | 15 ++ .../windows/flutter/generated_plugins.cmake | 16 ++ .../example/windows/runner/CMakeLists.txt | 17 ++ .../example/windows/runner/Runner.rc | 121 +++++++++ .../example/windows/runner/flutter_window.cpp | 61 +++++ .../example/windows/runner/flutter_window.h | 33 +++ .../example/windows/runner/main.cpp | 43 +++ .../example/windows/runner/resource.h | 16 ++ .../windows/runner/resources/app_icon.ico | Bin 0 -> 33772 bytes .../windows/runner/runner.exe.manifest | 20 ++ .../example/windows/runner/utils.cpp | 64 +++++ .../example/windows/runner/utils.h | 19 ++ .../example/windows/runner/win32_window.cpp | 245 ++++++++++++++++++ .../example/windows/runner/win32_window.h | 98 +++++++ 29 files changed, 1616 insertions(+) create mode 100644 packages/file_selector/file_selector_windows/example/.gitignore create mode 100644 packages/file_selector/file_selector_windows/example/.metadata create mode 100644 packages/file_selector/file_selector_windows/example/README.md create mode 100644 packages/file_selector/file_selector_windows/example/analysis_options.yaml create mode 100644 packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/home_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/main.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/open_image_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/open_text_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/lib/save_text_page.dart create mode 100644 packages/file_selector/file_selector_windows/example/pubspec.yaml create mode 100644 packages/file_selector/file_selector_windows/example/windows/.gitignore create mode 100644 packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt create mode 100644 packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt create mode 100644 packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h create mode 100644 packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugins.cmake create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/Runner.rc create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/main.cpp create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/resource.h create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/runner.exe.manifest create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/utils.h create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp create mode 100644 packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h diff --git a/packages/file_selector/file_selector_windows/example/.gitignore b/packages/file_selector/file_selector_windows/example/.gitignore new file mode 100644 index 000000000000..7abd0753cfc3 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/.gitignore @@ -0,0 +1,48 @@ +# 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 + +# Currently only web supported +android/ +ios/ + +# Exceptions to above rules. +!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages diff --git a/packages/file_selector/file_selector_windows/example/.metadata b/packages/file_selector/file_selector_windows/example/.metadata new file mode 100644 index 000000000000..897381f2373f --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/.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: 7736f3bc90270dcb0480db2ccffbf1d13c28db85 + channel: dev + +project_type: app diff --git a/packages/file_selector/file_selector_windows/example/README.md b/packages/file_selector/file_selector_windows/example/README.md new file mode 100644 index 000000000000..c8a3cce44a9a --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/README.md @@ -0,0 +1,4 @@ +# `file_selector_windows` Example + +Demonstrates Windows implementation of the +[`file_selector` plugin](https://pub.dev/packages/file_selector). diff --git a/packages/file_selector/file_selector_windows/example/analysis_options.yaml b/packages/file_selector/file_selector_windows/example/analysis_options.yaml new file mode 100644 index 000000000000..61b6c4de17c9 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/analysis_options.yaml @@ -0,0 +1,29 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at + # https://dart-lang.github.io/linter/lints/index.html. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart b/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart new file mode 100644 index 000000000000..9d95c1e70196 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart @@ -0,0 +1,76 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/material.dart'; + +/// Screen that shows an example of getDirectoryPath +class GetDirectoryPage extends StatelessWidget { + Future _getDirectoryPath(BuildContext context) async { + const String confirmButtonText = 'Choose'; + final String? directoryPath = + await FileSelectorPlatform.instance.getDirectoryPath( + confirmButtonText: confirmButtonText, + ); + if (directoryPath == null) { + // Operation was canceled by the user. + return; + } + await showDialog( + context: context, + builder: (BuildContext context) => TextDisplay(directoryPath), + ); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Open a text file'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ElevatedButton( + style: ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ), + child: const Text('Press to ask user to choose a directory'), + onPressed: () => _getDirectoryPath(context), + ), + ], + ), + ), + ); + } +} + +/// Widget that displays a text file in a dialog +class TextDisplay extends StatelessWidget { + /// Default Constructor + const TextDisplay(this.directoryPath); + + /// Directory path + final String directoryPath; + + @override + Widget build(BuildContext context) { + return AlertDialog( + title: const Text('Selected Directory'), + content: Scrollbar( + child: SingleChildScrollView( + child: Text(directoryPath), + ), + ), + actions: [ + TextButton( + child: const Text('Close'), + onPressed: () => Navigator.pop(context), + ), + ], + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/home_page.dart b/packages/file_selector/file_selector_windows/example/lib/home_page.dart new file mode 100644 index 000000000000..c598cbdf2611 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/home_page.dart @@ -0,0 +1,57 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:flutter/material.dart'; + +/// Home Page of the application +class HomePage extends StatelessWidget { + @override + Widget build(BuildContext context) { + final ButtonStyle style = ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ); + return Scaffold( + appBar: AppBar( + title: const Text('File Selector Demo Home Page'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ElevatedButton( + style: style, + child: const Text('Open a text file'), + onPressed: () => Navigator.pushNamed(context, '/open/text'), + ), + const SizedBox(height: 10), + ElevatedButton( + style: style, + child: const Text('Open an image'), + onPressed: () => Navigator.pushNamed(context, '/open/image'), + ), + const SizedBox(height: 10), + ElevatedButton( + style: style, + child: const Text('Open multiple images'), + onPressed: () => Navigator.pushNamed(context, '/open/images'), + ), + const SizedBox(height: 10), + ElevatedButton( + style: style, + child: const Text('Save a file'), + onPressed: () => Navigator.pushNamed(context, '/save/text'), + ), + const SizedBox(height: 10), + ElevatedButton( + style: style, + child: const Text('Open a get directory dialog'), + onPressed: () => Navigator.pushNamed(context, '/directory'), + ), + ], + ), + ), + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/main.dart b/packages/file_selector/file_selector_windows/example/lib/main.dart new file mode 100644 index 000000000000..14ce3f593f33 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/main.dart @@ -0,0 +1,37 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:example/get_directory_page.dart'; +import 'package:example/home_page.dart'; +import 'package:example/open_image_page.dart'; +import 'package:example/open_multiple_images_page.dart'; +import 'package:example/open_text_page.dart'; +import 'package:example/save_text_page.dart'; +import 'package:flutter/material.dart'; + +void main() { + runApp(MyApp()); +} + +/// MyApp is the Main Application +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'File Selector Demo', + theme: ThemeData( + primarySwatch: Colors.blue, + visualDensity: VisualDensity.adaptivePlatformDensity, + ), + home: HomePage(), + routes: { + '/open/image': (BuildContext context) => OpenImagePage(), + '/open/images': (BuildContext context) => OpenMultipleImagesPage(), + '/open/text': (BuildContext context) => OpenTextPage(), + '/save/text': (BuildContext context) => SaveTextPage(), + '/directory': (BuildContext context) => GetDirectoryPage(), + }, + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart new file mode 100644 index 000000000000..ceb307678368 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart @@ -0,0 +1,87 @@ +// Copyright 2013 The Flutter Authors. 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:io'; + +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; + +/// Screen that shows an example of openFiles +class OpenImagePage extends StatelessWidget { + Future _openImageFile(BuildContext context) async { + final XTypeGroup typeGroup = XTypeGroup( + label: 'images', + extensions: ['jpg', 'png'], + ); + final List files = await FileSelectorPlatform.instance + .openFiles(acceptedTypeGroups: [typeGroup]); + if (files.isEmpty) { + // Operation was canceled by the user. + return; + } + final XFile file = files[0]; + final String fileName = file.name; + final String filePath = file.path; + + await showDialog( + context: context, + builder: (BuildContext context) => ImageDisplay(fileName, filePath), + ); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Open an image'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ElevatedButton( + style: ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ), + child: const Text('Press to open an image file(png, jpg)'), + onPressed: () => _openImageFile(context), + ), + ], + ), + ), + ); + } +} + +/// Widget that displays a text file in a dialog +class ImageDisplay extends StatelessWidget { + /// Default Constructor + const ImageDisplay(this.fileName, this.filePath); + + /// Image's name + final String fileName; + + /// Image's path + final String filePath; + + @override + Widget build(BuildContext context) { + return AlertDialog( + title: Text(fileName), + // On web the filePath is a blob url + // while on other platforms it is a system path. + content: kIsWeb ? Image.network(filePath) : Image.file(File(filePath)), + actions: [ + TextButton( + child: const Text('Close'), + onPressed: () { + Navigator.pop(context); + }, + ), + ], + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart new file mode 100644 index 000000000000..2ab71339688c --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart @@ -0,0 +1,98 @@ +// Copyright 2013 The Flutter Authors. 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:io'; + +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; + +/// Screen that shows an example of openFiles +class OpenMultipleImagesPage extends StatelessWidget { + Future _openImageFile(BuildContext context) async { + final XTypeGroup jpgsTypeGroup = XTypeGroup( + label: 'JPEGs', + extensions: ['jpg', 'jpeg'], + ); + final XTypeGroup pngTypeGroup = XTypeGroup( + label: 'PNGs', + extensions: ['png'], + ); + final List files = await FileSelectorPlatform.instance + .openFiles(acceptedTypeGroups: [ + jpgsTypeGroup, + pngTypeGroup, + ]); + if (files.isEmpty) { + // Operation was canceled by the user. + return; + } + await showDialog( + context: context, + builder: (BuildContext context) => MultipleImagesDisplay(files), + ); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Open multiple images'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ElevatedButton( + style: ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ), + child: const Text('Press to open multiple images (png, jpg)'), + onPressed: () => _openImageFile(context), + ), + ], + ), + ), + ); + } +} + +/// Widget that displays a text file in a dialog +class MultipleImagesDisplay extends StatelessWidget { + /// Default Constructor + const MultipleImagesDisplay(this.files); + + /// The files containing the images + final List files; + + @override + Widget build(BuildContext context) { + return AlertDialog( + title: const Text('Gallery'), + // On web the filePath is a blob url + // while on other platforms it is a system path. + content: Center( + child: Row( + children: [ + ...files.map( + (XFile file) => Flexible( + child: kIsWeb + ? Image.network(file.path) + : Image.file(File(file.path))), + ) + ], + ), + ), + actions: [ + TextButton( + child: const Text('Close'), + onPressed: () { + Navigator.pop(context); + }, + ), + ], + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart new file mode 100644 index 000000000000..84f5f510f898 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart @@ -0,0 +1,83 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/material.dart'; + +/// Screen that shows an example of openFile +class OpenTextPage extends StatelessWidget { + Future _openTextFile(BuildContext context) async { + final XTypeGroup typeGroup = XTypeGroup( + label: 'text', + extensions: ['txt', 'json'], + ); + final XFile? file = await FileSelectorPlatform.instance + .openFile(acceptedTypeGroups: [typeGroup]); + if (file == null) { + // Operation was canceled by the user. + return; + } + final String fileName = file.name; + final String fileContent = await file.readAsString(); + + await showDialog( + context: context, + builder: (BuildContext context) => TextDisplay(fileName, fileContent), + ); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Open a text file'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ElevatedButton( + style: ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ), + child: const Text('Press to open a text file (json, txt)'), + onPressed: () => _openTextFile(context), + ), + ], + ), + ), + ); + } +} + +/// Widget that displays a text file in a dialog +class TextDisplay extends StatelessWidget { + /// Default Constructor + const TextDisplay(this.fileName, this.fileContent); + + /// File's name + final String fileName; + + /// File to display + final String fileContent; + + @override + Widget build(BuildContext context) { + return AlertDialog( + title: Text(fileName), + content: Scrollbar( + child: SingleChildScrollView( + child: Text(fileContent), + ), + ), + actions: [ + TextButton( + child: const Text('Close'), + onPressed: () => Navigator.pop(context), + ), + ], + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart b/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart new file mode 100644 index 000000000000..7f3f8aaad4b1 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart @@ -0,0 +1,77 @@ +// Copyright 2013 The Flutter Authors. 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:typed_data'; +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/material.dart'; + +/// Page for showing an example of saving with file_selector +class SaveTextPage extends StatelessWidget { + final TextEditingController _nameController = TextEditingController(); + final TextEditingController _contentController = TextEditingController(); + + Future _saveFile() async { + final String fileName = _nameController.text; + final String? path = await FileSelectorPlatform.instance.getSavePath( + // Operation was canceled by the user. + suggestedName: fileName, + ); + if (path == null) { + return; + } + final String text = _contentController.text; + final Uint8List fileData = Uint8List.fromList(text.codeUnits); + const String fileMimeType = 'text/plain'; + final XFile textFile = + XFile.fromData(fileData, mimeType: fileMimeType, name: fileName); + await textFile.saveTo(path); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Save text into a file'), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Container( + width: 300, + child: TextField( + minLines: 1, + maxLines: 12, + controller: _nameController, + decoration: const InputDecoration( + hintText: '(Optional) Suggest File Name', + ), + ), + ), + Container( + width: 300, + child: TextField( + minLines: 1, + maxLines: 12, + controller: _contentController, + decoration: const InputDecoration( + hintText: 'Enter File Contents', + ), + ), + ), + const SizedBox(height: 10), + ElevatedButton( + style: ElevatedButton.styleFrom( + primary: Colors.blue, + onPrimary: Colors.white, + ), + child: const Text('Press to save a text file'), + onPressed: _saveFile, + ), + ], + ), + ), + ); + } +} diff --git a/packages/file_selector/file_selector_windows/example/pubspec.yaml b/packages/file_selector/file_selector_windows/example/pubspec.yaml new file mode 100644 index 000000000000..40c7690cb935 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/pubspec.yaml @@ -0,0 +1,27 @@ +name: example +description: Example for file_selector_windows implementation. +publish_to: 'none' +version: 1.0.0 + +environment: + sdk: ">=2.12.0 <3.0.0" + flutter: ">=2.0.0" + +dependencies: + file_selector_windows: + # When depending on this package from a real application you should use: + # file_selector_windows: ^x.y.z + # See https://dart.dev/tools/pub/dependencies#version-constraints + # The example app is bundled with the plugin so we use a path dependency on + # the parent directory to use the current plugin's version. + path: .. + file_selector_platform_interface: ^2.0.0 + flutter: + sdk: flutter + +dev_dependencies: + flutter_test: + sdk: flutter + +flutter: + uses-material-design: true diff --git a/packages/file_selector/file_selector_windows/example/windows/.gitignore b/packages/file_selector/file_selector_windows/example/windows/.gitignore new file mode 100644 index 000000000000..d492d0d98c8f --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt new file mode 100644 index 000000000000..abf90408efb4 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -0,0 +1,95 @@ +cmake_minimum_required(VERSION 3.15) +project(example LANGUAGES CXX) + +set(BINARY_NAME "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/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000000..b02c5485c957 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 000000000000..dc139d85a931 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugins.cmake b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugins.cmake new file mode 100644 index 000000000000..63eda9b7b59f --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugins.cmake @@ -0,0 +1,16 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + file_selector_windows +) + +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/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt new file mode 100644 index 000000000000..0b899a0bcf13 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt @@ -0,0 +1,17 @@ +cmake_minimum_required(VERSION 3.15) +project(runner LANGUAGES CXX) + +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.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/packages/file_selector/file_selector_windows/example/windows/runner/Runner.rc b/packages/file_selector/file_selector_windows/example/windows/runner/Runner.rc new file mode 100644 index 000000000000..51812dcd4878 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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", "com.example" "\0" + VALUE "FileDescription", "A new Flutter project." "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2021 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "example.exe" "\0" + VALUE "ProductName", "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/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp new file mode 100644 index 000000000000..b43b9095ea3a --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp @@ -0,0 +1,61 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : 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()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + 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 opportunity 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/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h new file mode 100644 index 000000000000..6da0652f05f2 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(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 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/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp new file mode 100644 index 000000000000..bcb57b0e2aac --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.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); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.CreateAndShow(L"example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/resource.h b/packages/file_selector/file_selector_windows/example/windows/runner/resource.h new file mode 100644 index 000000000000..66a65d1e4a79 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico b/packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000000000000000000000000000000000000..c04e20caf6370ebb9253ad831cc31de4a9c965f6 GIT binary patch literal 33772 zcmeHQc|26z|35SKE&G-*mXah&B~fFkXr)DEO&hIfqby^T&>|8^_Ub8Vp#`BLl3lbZ zvPO!8k!2X>cg~Elr=IVxo~J*a`+9wR=A83c-k-DFd(XM&UI1VKCqM@V;DDtJ09WB} zRaHKiW(GT00brH|0EeTeKVbpbGZg?nK6-j827q-+NFM34gXjqWxJ*a#{b_apGN<-L_m3#8Z26atkEn& ze87Bvv^6vVmM+p+cQ~{u%=NJF>#(d;8{7Q{^rWKWNtf14H}>#&y7$lqmY6xmZryI& z($uy?c5-+cPnt2%)R&(KIWEXww>Cnz{OUpT>W$CbO$h1= z#4BPMkFG1Y)x}Ui+WXr?Z!w!t_hjRq8qTaWpu}FH{MsHlU{>;08goVLm{V<&`itk~ zE_Ys=D(hjiy+5=?=$HGii=Y5)jMe9|wWoD_K07(}edAxh`~LBorOJ!Cf@f{_gNCC| z%{*04ViE!#>@hc1t5bb+NO>ncf@@Dv01K!NxH$3Eg1%)|wLyMDF8^d44lV!_Sr}iEWefOaL z8f?ud3Q%Sen39u|%00W<#!E=-RpGa+H8}{ulxVl4mwpjaU+%2pzmi{3HM)%8vb*~-M9rPUAfGCSos8GUXp02|o~0BTV2l#`>>aFV&_P$ejS;nGwSVP8 zMbOaG7<7eKD>c12VdGH;?2@q7535sa7MN*L@&!m?L`ASG%boY7(&L5imY#EQ$KrBB z4@_tfP5m50(T--qv1BJcD&aiH#b-QC>8#7Fx@3yXlonJI#aEIi=8&ChiVpc#N=5le zM*?rDIdcpawoc5kizv$GEjnveyrp3sY>+5_R5;>`>erS%JolimF=A^EIsAK zsPoVyyUHCgf0aYr&alx`<)eb6Be$m&`JYSuBu=p8j%QlNNp$-5C{b4#RubPb|CAIS zGE=9OFLP7?Hgc{?k45)84biT0k&-C6C%Q}aI~q<(7BL`C#<6HyxaR%!dFx7*o^laG z=!GBF^cwK$IA(sn9y6>60Rw{mYRYkp%$jH z*xQM~+bp)G$_RhtFPYx2HTsWk80+p(uqv9@I9)y{b$7NK53rYL$ezbmRjdXS?V}fj zWxX_feWoLFNm3MG7pMUuFPs$qrQWO9!l2B(SIuy2}S|lHNbHzoE+M2|Zxhjq9+Ws8c{*}x^VAib7SbxJ*Q3EnY5lgI9 z=U^f3IW6T=TWaVj+2N%K3<%Un;CF(wUp`TC&Y|ZjyFu6co^uqDDB#EP?DV5v_dw~E zIRK*BoY9y-G_ToU2V_XCX4nJ32~`czdjT!zwme zGgJ0nOk3U4@IE5JwtM}pwimLjk{ln^*4HMU%Fl4~n(cnsLB}Ja-jUM>xIB%aY;Nq8 z)Fp8dv1tkqKanv<68o@cN|%thj$+f;zGSO7H#b+eMAV8xH$hLggtt?O?;oYEgbq@= zV(u9bbd12^%;?nyk6&$GPI%|+<_mEpJGNfl*`!KV;VfmZWw{n{rnZ51?}FDh8we_L z8OI9nE31skDqJ5Oa_ybn7|5@ui>aC`s34p4ZEu6-s!%{uU45$Zd1=p$^^dZBh zu<*pDDPLW+c>iWO$&Z_*{VSQKg7=YEpS3PssPn1U!lSm6eZIho*{@&20e4Y_lRklKDTUCKI%o4Pc<|G^Xgu$J^Q|B87U;`c1zGwf^-zH*VQ^x+i^OUWE0yd z;{FJq)2w!%`x7yg@>uGFFf-XJl4H`YtUG%0slGKOlXV`q?RP>AEWg#x!b{0RicxGhS!3$p7 zij;{gm!_u@D4$Ox%>>bPtLJ> zwKtYz?T_DR1jN>DkkfGU^<#6sGz|~p*I{y`aZ>^Di#TC|Z!7j_O1=Wo8thuit?WxR zh9_S>kw^{V^|g}HRUF=dcq>?q(pHxw!8rx4dC6vbQVmIhmICF#zU!HkHpQ>9S%Uo( zMw{eC+`&pb=GZRou|3;Po1}m46H6NGd$t<2mQh}kaK-WFfmj_66_17BX0|j-E2fe3Jat}ijpc53 zJV$$;PC<5aW`{*^Z6e5##^`Ed#a0nwJDT#Qq~^e8^JTA=z^Kl>La|(UQ!bI@#ge{Dzz@61p-I)kc2?ZxFt^QQ}f%ldLjO*GPj(5)V9IyuUakJX=~GnTgZ4$5!3E=V#t`yOG4U z(gphZB6u2zsj=qNFLYShhg$}lNpO`P9xOSnO*$@@UdMYES*{jJVj|9z-}F^riksLK zbsU+4-{281P9e2UjY6tse^&a)WM1MFw;p#_dHhWI7p&U*9TR0zKdVuQed%6{otTsq z$f~S!;wg#Bd9kez=Br{m|66Wv z#g1xMup<0)H;c2ZO6su_ii&m8j&+jJz4iKnGZ&wxoQX|5a>v&_e#6WA!MB_4asTxLRGQCC5cI(em z%$ZfeqP>!*q5kU>a+BO&ln=4Jm>Ef(QE8o&RgLkk%2}4Tf}U%IFP&uS7}&|Q-)`5< z+e>;s#4cJ-z%&-^&!xsYx777Wt(wZY9(3(avmr|gRe4cD+a8&!LY`1^T?7x{E<=kdY9NYw>A;FtTvQ=Y&1M%lyZPl$ss1oY^Sl8we}n}Aob#6 zl4jERwnt9BlSoWb@3HxYgga(752Vu6Y)k4yk9u~Kw>cA5&LHcrvn1Y-HoIuFWg~}4 zEw4bR`mXZQIyOAzo)FYqg?$5W<;^+XX%Uz61{-L6@eP|lLH%|w?g=rFc;OvEW;^qh z&iYXGhVt(G-q<+_j}CTbPS_=K>RKN0&;dubh0NxJyDOHFF;<1k!{k#7b{|Qok9hac z;gHz}6>H6C6RnB`Tt#oaSrX0p-j-oRJ;_WvS-qS--P*8}V943RT6kou-G=A+7QPGQ z!ze^UGxtW3FC0$|(lY9^L!Lx^?Q8cny(rR`es5U;-xBhphF%_WNu|aO<+e9%6LuZq zt(0PoagJG<%hyuf;te}n+qIl_Ej;czWdc{LX^pS>77s9t*2b4s5dvP_!L^3cwlc)E!(!kGrg~FescVT zZCLeua3f4;d;Tk4iXzt}g}O@nlK3?_o91_~@UMIl?@77Qc$IAlLE95#Z=TES>2E%z zxUKpK{_HvGF;5%Q7n&vA?`{%8ohlYT_?(3A$cZSi)MvIJygXD}TS-3UwyUxGLGiJP znblO~G|*uA^|ac8E-w#}uBtg|s_~s&t>-g0X%zIZ@;o_wNMr_;{KDg^O=rg`fhDZu zFp(VKd1Edj%F zWHPl+)FGj%J1BO3bOHVfH^3d1F{)*PL&sRX`~(-Zy3&9UQX)Z;c51tvaI2E*E7!)q zcz|{vpK7bjxix(k&6=OEIBJC!9lTkUbgg?4-yE{9+pFS)$Ar@vrIf`D0Bnsed(Cf? zObt2CJ>BKOl>q8PyFO6w)+6Iz`LW%T5^R`U_NIW0r1dWv6OY=TVF?N=EfA(k(~7VBW(S;Tu5m4Lg8emDG-(mOSSs=M9Q&N8jc^Y4&9RqIsk(yO_P(mcCr}rCs%1MW1VBrn=0-oQN(Xj!k%iKV zb%ricBF3G4S1;+8lzg5PbZ|$Se$)I=PwiK=cDpHYdov2QO1_a-*dL4KUi|g&oh>(* zq$<`dQ^fat`+VW?m)?_KLn&mp^-@d=&7yGDt<=XwZZC=1scwxO2^RRI7n@g-1o8ps z)&+et_~)vr8aIF1VY1Qrq~Xe``KJrQSnAZ{CSq3yP;V*JC;mmCT6oRLSs7=GA?@6g zUooM}@tKtx(^|aKK8vbaHlUQqwE0}>j&~YlN3H#vKGm@u)xxS?n9XrOWUfCRa< z`20Fld2f&;gg7zpo{Adh+mqNntMc-D$N^yWZAZRI+u1T1zWHPxk{+?vcS1D>08>@6 zLhE@`gt1Y9mAK6Z4p|u(5I%EkfU7rKFSM=E4?VG9tI;a*@?6!ey{lzN5=Y-!$WFSe z&2dtO>^0@V4WRc#L&P%R(?@KfSblMS+N+?xUN$u3K4Ys%OmEh+tq}fnU}i>6YHM?< zlnL2gl~sF!j!Y4E;j3eIU-lfa`RsOL*Tt<%EFC0gPzoHfNWAfKFIKZN8}w~(Yi~=q z>=VNLO2|CjkxP}RkutxjV#4fWYR1KNrPYq5ha9Wl+u>ipsk*I(HS@iLnmGH9MFlTU zaFZ*KSR0px>o+pL7BbhB2EC1%PJ{67_ z#kY&#O4@P=OV#-79y_W>Gv2dxL*@G7%LksNSqgId9v;2xJ zrh8uR!F-eU$NMx@S*+sk=C~Dxr9Qn7TfWnTupuHKuQ$;gGiBcU>GF5sWx(~4IP3`f zWE;YFO*?jGwYh%C3X<>RKHC-DZ!*r;cIr}GLOno^3U4tFSSoJp%oHPiSa%nh=Zgn% z14+8v@ygy0>UgEN1bczD6wK45%M>psM)y^)IfG*>3ItX|TzV*0i%@>L(VN!zdKb8S?Qf7BhjNpziA zR}?={-eu>9JDcl*R=OP9B8N$IcCETXah9SUDhr{yrld{G;PnCWRsPD7!eOOFBTWUQ=LrA_~)mFf&!zJX!Oc-_=kT<}m|K52 z)M=G#;p;Rdb@~h5D{q^K;^fX-m5V}L%!wVC2iZ1uu401Ll}#rocTeK|7FAeBRhNdQ zCc2d^aQnQp=MpOmak60N$OgS}a;p(l9CL`o4r(e-nN}mQ?M&isv-P&d$!8|1D1I(3-z!wi zTgoo)*Mv`gC?~bm?S|@}I|m-E2yqPEvYybiD5azInexpK8?9q*$9Yy9-t%5jU8~ym zgZDx>!@ujQ=|HJnwp^wv-FdD{RtzO9SnyfB{mH_(c!jHL*$>0o-(h(eqe*ZwF6Lvu z{7rkk%PEqaA>o+f{H02tzZ@TWy&su?VNw43! z-X+rN`6llvpUms3ZiSt)JMeztB~>9{J8SPmYs&qohxdYFi!ra8KR$35Zp9oR)eFC4 zE;P31#3V)n`w$fZ|4X-|%MX`xZDM~gJyl2W;O$H25*=+1S#%|53>|LyH za@yh+;325%Gq3;J&a)?%7X%t@WXcWL*BaaR*7UEZad4I8iDt7^R_Fd`XeUo256;sAo2F!HcIQKk;h})QxEsPE5BcKc7WyerTchgKmrfRX z!x#H_%cL#B9TWAqkA4I$R^8{%do3Y*&(;WFmJ zU7Dih{t1<{($VtJRl9|&EB?|cJ)xse!;}>6mSO$o5XIx@V|AA8ZcoD88ZM?C*;{|f zZVmf94_l1OmaICt`2sTyG!$^UeTHx9YuUP!omj(r|7zpm5475|yXI=rR>>fteLI+| z)MoiGho0oEt=*J(;?VY0QzwCqw@cVm?d7Y!z0A@u#H?sCJ*ecvyhj& z-F77lO;SH^dmf?L>3i>?Z*U}Em4ZYV_CjgfvzYsRZ+1B!Uo6H6mbS<-FFL`ytqvb& zE7+)2ahv-~dz(Hs+f})z{*4|{)b=2!RZK;PWwOnO=hG7xG`JU5>bAvUbdYd_CjvtHBHgtGdlO+s^9ca^Bv3`t@VRX2_AD$Ckg36OcQRF zXD6QtGfHdw*hx~V(MV-;;ZZF#dJ-piEF+s27z4X1qi5$!o~xBnvf=uopcn7ftfsZc zy@(PuOk`4GL_n(H9(E2)VUjqRCk9kR?w)v@xO6Jm_Mx})&WGEl=GS0#)0FAq^J*o! zAClhvoTsNP*-b~rN{8Yym3g{01}Ep^^Omf=SKqvN?{Q*C4HNNAcrowIa^mf+3PRy! z*_G-|3i8a;+q;iP@~Of_$(vtFkB8yOyWt2*K)vAn9El>=D;A$CEx6b*XF@4y_6M+2 zpeW`RHoI_p(B{%(&jTHI->hmNmZjHUj<@;7w0mx3&koy!2$@cfX{sN19Y}euYJFn& z1?)+?HCkD0MRI$~uB2UWri})0bru_B;klFdwsLc!ne4YUE;t41JqfG# zZJq6%vbsdx!wYeE<~?>o4V`A3?lN%MnKQ`z=uUivQN^vzJ|C;sdQ37Qn?;lpzg})y z)_2~rUdH}zNwX;Tp0tJ78+&I=IwOQ-fl30R79O8@?Ub8IIA(6I`yHn%lARVL`%b8+ z4$8D-|MZZWxc_)vu6@VZN!HsI$*2NOV&uMxBNzIbRgy%ob_ zhwEH{J9r$!dEix9XM7n&c{S(h>nGm?el;gaX0@|QnzFD@bne`el^CO$yXC?BDJ|Qg z+y$GRoR`?ST1z^e*>;!IS@5Ovb7*RlN>BV_UC!7E_F;N#ky%1J{+iixp(dUJj93aK zzHNN>R-oN7>kykHClPnoPTIj7zc6KM(Pnlb(|s??)SMb)4!sMHU^-ntJwY5Big7xv zb1Ew`Xj;|D2kzGja*C$eS44(d&RMU~c_Y14V9_TLTz0J#uHlsx`S6{nhsA0dWZ#cG zJ?`fO50E>*X4TQLv#nl%3GOk*UkAgt=IY+u0LNXqeln3Z zv$~&Li`ZJOKkFuS)dJRA>)b_Da%Q~axwA_8zNK{BH{#}#m}zGcuckz}riDE-z_Ms> zR8-EqAMcfyGJCtvTpaUVQtajhUS%c@Yj}&6Zz;-M7MZzqv3kA7{SuW$oW#=0az2wQ zg-WG@Vb4|D`pl~Il54N7Hmsauc_ne-a!o5#j3WaBBh@Wuefb!QJIOn5;d)%A#s+5% zuD$H=VNux9bE-}1&bcYGZ+>1Fo;3Z@e&zX^n!?JK*adSbONm$XW9z;Q^L>9U!}Toj2WdafJ%oL#h|yWWwyAGxzfrAWdDTtaKl zK4`5tDpPg5>z$MNv=X0LZ0d6l%D{(D8oT@+w0?ce$DZ6pv>{1&Ok67Ix1 zH}3=IEhPJEhItCC8E=`T`N5(k?G=B4+xzZ?<4!~ ze~z6Wk9!CHTI(0rLJ4{JU?E-puc;xusR?>G?;4vt;q~iI9=kDL=z0Rr%O$vU`30X$ zDZRFyZ`(omOy@u|i6h;wtJlP;+}$|Ak|k2dea7n?U1*$T!sXqqOjq^NxLPMmk~&qI zYg0W?yK8T(6+Ea+$YyspKK?kP$+B`~t3^Pib_`!6xCs32!i@pqXfFV6PmBIR<-QW= zN8L{pt0Vap0x`Gzn#E@zh@H)0FfVfA_Iu4fjYZ+umO1LXIbVc$pY+E234u)ttcrl$ z>s92z4vT%n6cMb>=XT6;l0+9e(|CZG)$@C7t7Z7Ez@a)h)!hyuV&B5K%%)P5?Lk|C zZZSVzdXp{@OXSP0hoU-gF8s8Um(#xzjP2Vem zec#-^JqTa&Y#QJ>-FBxd7tf`XB6e^JPUgagB8iBSEps;92KG`!#mvVcPQ5yNC-GEG zTiHEDYfH+0O15}r^+ z#jxj=@x8iNHWALe!P3R67TwmhItn**0JwnzSV2O&KE8KcT+0hWH^OPD1pwiuyx=b@ zNf5Jh0{9X)8;~Es)$t@%(3!OnbY+`@?i{mGX7Yy}8T_*0a6g;kaFPq;*=px5EhO{Cp%1kI<0?*|h8v!6WnO3cCJRF2-CRrU3JiLJnj@6;L)!0kWYAc_}F{2P))3HmCrz zQ&N&gE70;`!6*eJ4^1IR{f6j4(-l&X!tjHxkbHA^Zhrnhr9g{exN|xrS`5Pq=#Xf& zG%P=#ra-TyVFfgW%cZo5OSIwFL9WtXAlFOa+ubmI5t*3=g#Y zF%;70p5;{ZeFL}&}yOY1N1*Q;*<(kTB!7vM$QokF)yr2FlIU@$Ph58$Bz z0J?xQG=MlS4L6jA22eS42g|9*9pX@$#*sUeM(z+t?hr@r5J&D1rx}2pW&m*_`VDCW zUYY@v-;bAO0HqoAgbbiGGC<=ryf96}3pouhy3XJrX+!!u*O_>Si38V{uJmQ&USptX zKp#l(?>%^7;2%h(q@YWS#9;a!JhKlkR#Vd)ERILlgu!Hr@jA@V;sk4BJ-H#p*4EqC zDGjC*tl=@3Oi6)Bn^QwFpul18fpkbpg0+peH$xyPBqb%`$OUhPKyWb32o7clB*9Z< zN=i~NLjavrLtwgJ01bufP+>p-jR2I95|TpmKpQL2!oV>g(4RvS2pK4*ou%m(h6r3A zX#s&`9LU1ZG&;{CkOK!4fLDTnBys`M!vuz>Q&9OZ0hGQl!~!jSDg|~s*w52opC{sB ze|Cf2luD(*G13LcOAGA!s2FjSK8&IE5#W%J25w!vM0^VyQM!t)inj&RTiJ!wXzFgz z3^IqzB7I0L$llljsGq})thBy9UOyjtFO_*hYM_sgcMk>44jeH0V1FDyELc{S1F-;A zS;T^k^~4biG&V*Irq}O;e}j$$+E_#G?HKIn05iP3j|87TkGK~SqG!-KBg5+mN(aLm z8ybhIM`%C19UX$H$KY6JgXbY$0AT%rEpHC;u`rQ$Y=rxUdsc5*Kvc8jaYaO$^)cI6){P6K0r)I6DY4Wr4&B zLQUBraey#0HV|&c4v7PVo3n$zHj99(TZO^3?Ly%C4nYvJTL9eLBLHsM3WKKD>5!B` zQ=BsR3aR6PD(Fa>327E2HAu5TM~Wusc!)>~(gM)+3~m;92Jd;FnSib=M5d6;;5{%R zb4V7DEJ0V!CP-F*oU?gkc>ksUtAYP&V4ND5J>J2^jt*vcFflQWCrB&fLdT%O59PVJ zhid#toR=FNgD!q3&r8#wEBr`!wzvQu5zX?Q>nlSJ4i@WC*CN*-xU66F^V5crWevQ9gsq$I@z1o(a=k7LL~ z7m_~`o;_Ozha1$8Q}{WBehvAlO4EL60y5}8GDrZ< zXh&F}71JbW2A~8KfEWj&UWV#4+Z4p`b{uAj4&WC zha`}X@3~+Iz^WRlOHU&KngK>#j}+_o@LdBC1H-`gT+krWX3-;!)6?{FBp~%20a}FL zFP9%Emqcwa#(`=G>BBZ0qZDQhmZKJg_g8<=bBFKWr!dyg(YkpE+|R*SGpDVU!+VlU zFC54^DLv}`qa%49T>nNiA9Q7Ips#!Xx90tCU2gvK`(F+GPcL=J^>No{)~we#o@&mUb6c$ zCc*<|NJBk-#+{j9xkQ&ujB zI~`#kN~7W!f*-}wkG~Ld!JqZ@tK}eeSnsS5J1fMFXm|`LJx&}5`@dK3W^7#Wnm+_P zBZkp&j1fa2Y=eIjJ0}gh85jt43kaIXXv?xmo@eHrka!Z|vQv12HN#+!I5E z`(fbuW>gFiJL|uXJ!vKt#z3e3HlVdboH7;e#i3(2<)Fg-I@BR!qY#eof3MFZ&*Y@l zI|KJf&ge@p2Dq09Vu$$Qxb7!}{m-iRk@!)%KL)txi3;~Z4Pb}u@GsW;ELiWeG9V51 znX#}B&4Y2E7-H=OpNE@q{%hFLxwIpBF2t{vPREa8_{linXT;#1vMRWjOzLOP$-hf( z>=?$0;~~PnkqY;~K{EM6Vo-T(0K{A0}VUGmu*hR z{tw3hvBN%N3G3Yw`X5Te+F{J`(3w1s3-+1EbnFQKcrgrX1Jqvs@ADGe%M0s$EbK$$ zK)=y=upBc6SjGYAACCcI=Y*6Fi8_jgwZlLxD26fnQfJmb8^gHRN5(TemhX@0e=vr> zg`W}6U>x6VhoA3DqsGGD9uL1DhB3!OXO=k}59TqD@(0Nb{)Ut_luTioK_>7wjc!5C zIr@w}b`Fez3)0wQfKl&bae7;PcTA7%?f2xucM0G)wt_KO!Ewx>F~;=BI0j=Fb4>pp zv}0R^xM4eti~+^+gE$6b81p(kwzuDti(-K9bc|?+pJEl@H+jSYuxZQV8rl8 zjp@M{#%qItIUFN~KcO9Hed*`$5A-2~pAo~K&<-Q+`9`$CK>rzqAI4w~$F%vs9s{~x zg4BP%Gy*@m?;D6=SRX?888Q6peF@_4Z->8wAH~Cn!R$|Hhq2cIzFYqT_+cDourHbY z0qroxJnrZ4Gh+Ay+F`_c%+KRT>y3qw{)89?=hJ@=KO=@ep)aBJ$c!JHfBMJpsP*3G za7|)VJJ8B;4?n{~ldJF7%jmb`-ftIvNd~ekoufG(`K(3=LNc;HBY& z(lp#q8XAD#cIf}k49zX_i`*fO+#!zKA&%T3j@%)R+#yag067CU%yUEe47>wzGU8^` z1EXFT^@I!{J!F8!X?S6ph8J=gUi5tl93*W>7}_uR<2N2~e}FaG?}KPyugQ=-OGEZs z!GBoyYY+H*ANn4?Z)X4l+7H%`17i5~zRlRIX?t)6_eu=g2Q`3WBhxSUeea+M-S?RL zX9oBGKn%a!H+*hx4d2(I!gsi+@SQK%<{X22M~2tMulJoa)0*+z9=-YO+;DFEm5eE1U9b^B(Z}2^9!Qk`!A$wUE z7$Ar5?NRg2&G!AZqnmE64eh^Anss3i!{}%6@Et+4rr!=}!SBF8eZ2*J3ujCWbl;3; z48H~goPSv(8X61fKKdpP!Z7$88NL^Z?j`!^*I?-P4X^pMxyWz~@$(UeAcTSDd(`vO z{~rc;9|GfMJcApU3k}22a!&)k4{CU!e_ny^Y3cO;tOvOMKEyWz!vG(Kp*;hB?d|R3`2X~=5a6#^o5@qn?J-bI8Ppip{-yG z!k|VcGsq!jF~}7DMr49Wap-s&>o=U^T0!Lcy}!(bhtYsPQy z4|EJe{12QL#=c(suQ89Mhw9<`bui%nx7Nep`C&*M3~vMEACmcRYYRGtANq$F%zh&V zc)cEVeHz*Z1N)L7k-(k3np#{GcDh2Q@ya0YHl*n7fl*ZPAsbU-a94MYYtA#&!c`xGIaV;yzsmrjfieTEtqB_WgZp2*NplHx=$O{M~2#i_vJ{ps-NgK zQsxKK_CBM2PP_je+Xft`(vYfXXgIUr{=PA=7a8`2EHk)Ym2QKIforz# tySWtj{oF3N9@_;i*Fv5S)9x^z=nlWP>jpp-9)52ZmLVA=i*%6g{{fxOO~wEK literal 0 HcmV?d00001 diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/runner.exe.manifest b/packages/file_selector/file_selector_windows/example/windows/runner/runner.exe.manifest new file mode 100644 index 000000000000..c977c4a42589 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp new file mode 100644 index 000000000000..d19bdbbcc322 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/runner/utils.h b/packages/file_selector/file_selector_windows/example/windows/runner/utils.h new file mode 100644 index 000000000000..3879d5475579 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp new file mode 100644 index 000000000000..c10f08dc7da6 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h new file mode 100644 index 000000000000..17ba431125b4 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/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_ From e2dcf5fc6aa0788da967d42dce8a2628625b5943 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Fri, 24 Sep 2021 15:52:08 -0400 Subject: [PATCH 03/22] Extract the plugin class into its own files --- .../file_selector_windows/pubspec.yaml | 7 +++-- .../windows/CMakeLists.txt | 12 ++++++-- .../windows/file_selector_plugin.cpp | 30 ++++--------------- .../windows/file_selector_plugin.h | 26 ++++++++++++++++ .../windows/file_selector_windows.cpp | 15 ++++++++++ ...ector_plugin.h => file_selector_windows.h} | 8 ++--- 6 files changed, 63 insertions(+), 35 deletions(-) create mode 100644 packages/file_selector/file_selector_windows/windows/file_selector_plugin.h create mode 100644 packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp rename packages/file_selector/file_selector_windows/windows/include/file_selector_windows/{file_selector_plugin.h => file_selector_windows.h} (54%) diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml index d13fa9e04f9e..a08a44bed0d0 100644 --- a/packages/file_selector/file_selector_windows/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -1,14 +1,15 @@ name: file_selector_windows description: Windows implementation of the file_selector plugin. -version: 0.0.2+1 -homepage: https://github.com/google/flutter-desktop-embedding/tree/master/plugins/file_selector/file_selector_windows +homepage: https://github.com/flutter/plugins/tree/master/packages/file_selector/file_selector_windows +issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aopen+label%3A%22p%3A+file_selector%22 +version: 0.8.2 flutter: plugin: implements: file_selector platforms: windows: - pluginClass: FileSelectorPlugin + pluginClass: FileSelectorWindows environment: sdk: ">=2.12.0 <3.0.0" diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt index 56b2eeceb94d..5c35c9b555de 100644 --- a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -4,12 +4,18 @@ project(${PROJECT_NAME} LANGUAGES CXX) set(PLUGIN_NAME "${PROJECT_NAME}_plugin") -add_library(${PLUGIN_NAME} SHARED +list(APPEND PLUGIN_SOURCES "file_selector_plugin.cpp" + "file_selector_plugin.h" +) + +add_library(${PLUGIN_NAME} SHARED + "file_selector_windows.cpp" + "include/file_selector_windows/file_selector_windows.h" + ${PLUGIN_SOURCES} ) apply_standard_settings(${PLUGIN_NAME}) -set_target_properties(${PLUGIN_NAME} PROPERTIES - CXX_VISIBILITY_PRESET hidden) +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") diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index f087f293bbf1..2797e71ea9f5 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -1,7 +1,7 @@ // Copyright 2020 The Flutter Authors. 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/file_selector_windows/file_selector_plugin.h" +#include "file_selector_plugin.h" #include #include @@ -15,6 +15,8 @@ #include #include +namespace file_selector_windows { + namespace { using flutter::EncodableList; @@ -335,22 +337,7 @@ HWND GetRootWindow(flutter::FlutterView *view) { return GetAncestor(view->GetNativeWindow(), GA_ROOT); } -class FileSelectorPlugin : public flutter::Plugin { - public: - static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); - - virtual ~FileSelectorPlugin(); - - private: - FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); - - // Called when a method is called on plugin channel; - void HandleMethodCall(const flutter::MethodCall<> &method_call, - std::unique_ptr> result); - - // The registrar for this plugin, for accessing the window. - flutter::PluginRegistrarWindows *registrar_; -}; +} // namespace // static void FileSelectorPlugin::RegisterWithRegistrar( @@ -393,11 +380,4 @@ void FileSelectorPlugin::HandleMethodCall( } } -} // namespace - -void FileSelectorPluginRegisterWithRegistrar( - FlutterDesktopPluginRegistrarRef registrar) { - FileSelectorPlugin::RegisterWithRegistrar( - flutter::PluginRegistrarManager::GetInstance() - ->GetRegistrar(registrar)); -} +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h new file mode 100644 index 000000000000..4c863eff1377 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -0,0 +1,26 @@ +// Copyright 2020 The Flutter Authors. 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 + +namespace file_selector_windows { + +class FileSelectorPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + + virtual ~FileSelectorPlugin(); + + private: + FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); + + // Called when a method is called on plugin channel; + void HandleMethodCall(const flutter::MethodCall<> &method_call, + std::unique_ptr> result); + + // The registrar for this plugin, for accessing the window. + flutter::PluginRegistrarWindows *registrar_; +}; + +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp new file mode 100644 index 000000000000..ef06f83ad4ff --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp @@ -0,0 +1,15 @@ +// Copyright 2020 The Flutter Authors. 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/file_selector_windows/file_selector_windows.h" + +#include + +#include "file_selector_plugin.h" + +void FileSelectorWindowsRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + file_selector_windows::FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h similarity index 54% rename from packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h rename to packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h index 7ad3bd2eb490..efefc63912d2 100644 --- a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h +++ b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h @@ -1,8 +1,8 @@ // Copyright 2020 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -#ifndef PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ -#define PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_INCLUDE_FILE_SELECTOR_WINDOWS_FILE_SELECTOR_WINDOWS_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_INCLUDE_FILE_SELECTOR_WINDOWS_FILE_SELECTOR_WINDOWS_H_ #include @@ -16,11 +16,11 @@ extern "C" { #endif -FLUTTER_PLUGIN_EXPORT void FileSelectorPluginRegisterWithRegistrar( +FLUTTER_PLUGIN_EXPORT void FileSelectorWindowsRegisterWithRegistrar( FlutterDesktopPluginRegistrarRef registrar); #if defined(__cplusplus) } // extern "C" #endif -#endif // PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_INCLUDE_FILE_SELECTOR_WINDOWS_FILE_SELECTOR_WINDOWS_H_ From b0c1f49345766271f4e293642cb646983f74ef4c Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Fri, 24 Sep 2021 16:35:30 -0400 Subject: [PATCH 04/22] Placeholder tests --- .../example/windows/CMakeLists.txt | 3 ++ .../windows/CMakeLists.txt | 41 ++++++++++++++++ .../windows/file_selector_plugin.h | 4 +- .../test/file_selector_plugin_test.cpp | 49 +++++++++++++++++++ 4 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp diff --git a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt index abf90408efb4..b8aa18f9aabe 100644 --- a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -46,6 +46,9 @@ add_subdirectory(${FLUTTER_MANAGED_DIR}) # Application build add_subdirectory("runner") +# Enable the test target +set(include_file_selector_windows_tests TRUE) + # Generated plugin build rules, which manage building the plugins and adding # them to the application. include(flutter/generated_plugins.cmake) diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt index 5c35c9b555de..7164890a4445 100644 --- a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -26,3 +26,44 @@ set(file_selector_bundled_libraries "" PARENT_SCOPE ) + + +# === Tests === + +if (${include_${PROJECT_NAME}_tests}) +set(TEST_RUNNER "${PROJECT_NAME}_test") +enable_testing() +# TODO(stuartmorgan): Consider using a single shared, pre-checked-in googletest +# instance rather than downloading for each plugin. This approach makes sense +# for a template, but not for a monorepo with many plugins. +include(FetchContent) +FetchContent_Declare( + googletest + URL https://github.com/google/googletest/archive/release-1.11.0.zip +) +# Prevent overriding the parent project's compiler/linker settings +set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) +# Disable install commands for gtest so it doesn't end up in the bundle. +set(INSTALL_GTEST OFF CACHE BOOL "Disable installation of googletest" FORCE) + +FetchContent_MakeAvailable(googletest) + +# The plugin's C API is not very useful for unit testing, so build the sources +# directly into the test binary rather than using the DLL. +add_executable(${TEST_RUNNER} + test/file_selector_plugin_test.cpp + ${PLUGIN_SOURCES} +) +apply_standard_settings(${TEST_RUNNER}) +target_include_directories(${TEST_RUNNER} PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}") +target_link_libraries(${TEST_RUNNER} PRIVATE flutter_wrapper_plugin) +target_link_libraries(${TEST_RUNNER} PRIVATE gtest_main gmock) +# flutter_wrapper_plugin has link dependencies on the Flutter DLL. +add_custom_command(TARGET ${TEST_RUNNER} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E copy_if_different + "${FLUTTER_LIBRARY}" $ +) + +include(GoogleTest) +gtest_discover_tests(${TEST_RUNNER}) +endif() diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h index 4c863eff1377..7816e8fcb0a1 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -10,11 +10,11 @@ class FileSelectorPlugin : public flutter::Plugin { public: static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); + virtual ~FileSelectorPlugin(); private: - FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); - // Called when a method is called on plugin channel; void HandleMethodCall(const flutter::MethodCall<> &method_call, std::unique_ptr> result); diff --git a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp new file mode 100644 index 000000000000..5314a0267abd --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp @@ -0,0 +1,49 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#include "file_selector_plugin.h" + +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +namespace file_selector_windows { +namespace test { + +namespace { + +using flutter::EncodableMap; +using flutter::EncodableValue; +using ::testing::DoAll; +using ::testing::Pointee; +using ::testing::Return; +using ::testing::SetArgPointee; + +class MockMethodResult : public flutter::MethodResult<> { + public: + MOCK_METHOD(void, SuccessInternal, (const EncodableValue* result), + (override)); + MOCK_METHOD(void, ErrorInternal, + (const std::string& error_code, const std::string& error_message, + const EncodableValue* details), + (override)); + MOCK_METHOD(void, NotImplementedInternal, (), (override)); +}; + +} // namespace + +TEST(FileSelectorPlugin, Placeholder) { + FileSelectorPlugin plugin(nullptr); + + EXPECT_TRUE(true); +} + +} // namespace test +} // namespace file_selector_windows From e760f00b75b28edc834cc49c5ff1465e02e51caf Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 5 Oct 2021 12:03:45 -0400 Subject: [PATCH 05/22] Refactor for testability --- .../windows/CMakeLists.txt | 2 + .../windows/file_dialog_controller.cpp | 64 +++++++++++++++ .../windows/file_dialog_controller.h | 58 ++++++++++++++ .../windows/file_selector_plugin.cpp | 79 +++++++++++-------- .../windows/file_selector_plugin.h | 27 ++++++- .../test/file_selector_plugin_test.cpp | 27 ++++++- 6 files changed, 222 insertions(+), 35 deletions(-) create mode 100644 packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/file_dialog_controller.h diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt index 7164890a4445..80b2fcbb1a61 100644 --- a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -5,6 +5,8 @@ project(${PROJECT_NAME} LANGUAGES CXX) set(PLUGIN_NAME "${PROJECT_NAME}_plugin") list(APPEND PLUGIN_SOURCES + "file_dialog_controller.cpp" + "file_dialog_controller.h" "file_selector_plugin.cpp" "file_selector_plugin.h" ) diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp new file mode 100644 index 000000000000..32d65a41027d --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp @@ -0,0 +1,64 @@ +// Copyright 2020 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "file_dialog_controller.h" + +#include + +namespace file_selector_windows { + +FileDialogController::FileDialogController(IFileDialog* dialog) + : dialog_(dialog) { + dialog_->AddRef(); +} + +FileDialogController::~FileDialogController() { dialog_->Release(); } + +HRESULT FileDialogController::SetDefaultFolder(IShellItem* folder) { + return dialog_->SetDefaultFolder(folder); +} + +HRESULT FileDialogController::SetFileName(const wchar_t* name) { + return dialog_->SetFileName(name); +} + +HRESULT FileDialogController::SetFileTypes(UINT count, + COMDLG_FILTERSPEC* filters) { + return dialog_->SetFileTypes(count, filters); +} + +HRESULT FileDialogController::SetOkButtonLabel(const wchar_t* text) { + return dialog_->SetOkButtonLabel(text); +} + +HRESULT FileDialogController::GetOptions(FILEOPENDIALOGOPTIONS* out_options) { + return dialog_->GetOptions(out_options); +} + +HRESULT FileDialogController::SetOptions(FILEOPENDIALOGOPTIONS options) { + return dialog_->SetOptions(options); +} + +HRESULT FileDialogController::Show(HWND parent) { + return dialog_->Show(parent); +} + +HRESULT FileDialogController::GetResult(IShellItem** out_item) { + return dialog_->GetResult(out_item); +} + +HRESULT FileDialogController::GetResults(IShellItemArray** out_items) { + IFileOpenDialog* open_dialog; + HRESULT result = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); + if (!SUCCEEDED(result)) { + return result; + } + result = open_dialog->GetResults(out_items); + open_dialog->Release(); + return result; +} + +FileDialogControllerFactory::~FileDialogControllerFactory() {} + +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h new file mode 100644 index 000000000000..525c1a9d6a71 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h @@ -0,0 +1,58 @@ +// Copyright 2020 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ + +#include +#include + +#include + +namespace file_selector_windows { + +// A thin wrapper for IFileDialog to allow for faking and inspection in tests. +// +// Since this class defines the end of what can be unit tested, it should +// contain as little logic as possible. +class FileDialogController { + public: + // Creates a controller managing |dialog|. + FileDialogController(IFileDialog* dialog); + virtual ~FileDialogController(); + + // Disallow copy and assign. + FileDialogController(const FileDialogController&) = delete; + FileDialogController& operator=(const FileDialogController&) = delete; + + // IFileDialog wrappers: + virtual HRESULT SetDefaultFolder(IShellItem* folder); + virtual HRESULT SetFileName(const wchar_t* name); + virtual HRESULT SetFileTypes(UINT count, COMDLG_FILTERSPEC* filters); + virtual HRESULT SetOkButtonLabel(const wchar_t* text); + virtual HRESULT GetOptions(FILEOPENDIALOGOPTIONS* out_options); + virtual HRESULT SetOptions(FILEOPENDIALOGOPTIONS options); + virtual HRESULT Show(HWND parent); + virtual HRESULT GetResult(IShellItem** out_item); + + // IFileOpenDialog wrapper. This will fail if the IFileDialog* provided to the + // constructor was not an IFileOpenDialog instance. + virtual HRESULT GetResults(IShellItemArray** out_items); + + private: + IFileDialog* dialog_ = nullptr; +}; + +// Interface for creating FileDialogControllers, to allow for dependency +// injection. +class FileDialogControllerFactory { + public: + virtual ~FileDialogControllerFactory(); + + virtual std::unique_ptr CreateController( + IFileDialog* dialog) = 0; +}; + +} // namespace file_selector_windows + +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index 2797e71ea9f5..8cf84593fe2c 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -12,9 +12,12 @@ #include #include +#include #include #include +#include "file_dialog_controller.h" + namespace file_selector_windows { namespace { @@ -109,20 +112,35 @@ std::string GetPathForShellItem(IShellItem *shell_item) { return path; } +// Implementation of FileDialogControllerFactory that makes standard +// FileDialogController instances. +class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { + public: + DefaultFileDialogControllerFactory() {} + virtual ~DefaultFileDialogControllerFactory() {} + + // Disallow copy and assign. + DefaultFileDialogControllerFactory( + const DefaultFileDialogControllerFactory &) = delete; + DefaultFileDialogControllerFactory &operator=( + const DefaultFileDialogControllerFactory &) = delete; + + std::unique_ptr CreateController( + IFileDialog *dialog) override { + return std::make_unique(dialog); + } +}; + // Wraps an IFileDialog, managing object lifetime as a scoped object and // providing a simplified API for interacting with it as needed for the plugin. class DialogWrapper { public: explicit DialogWrapper(IID type) { is_open_dialog_ = type == CLSID_FileOpenDialog; + IFileDialog *dialog = nullptr; last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, - IID_PPV_ARGS(&dialog_)); - } - - ~DialogWrapper() { - if (dialog_) { - dialog_->Release(); - } + IID_PPV_ARGS(&dialog)); + dialog_controller_.emplace(dialog); } // Attempts to set the default folder for the dialog to |path|, @@ -135,26 +153,26 @@ class DialogWrapper { if (!SUCCEEDED(last_result_)) { return; } - dialog_->SetDefaultFolder(item); + dialog_controller_->SetDefaultFolder(item); item->Release(); } // Sets the file name that is initially shown in the dialog. void SetFileName(const std::string &name) { std::wstring wide_name = Utf16FromUtf8(name); - last_result_ = dialog_->SetFileName(wide_name.c_str()); + last_result_ = dialog_controller_->SetFileName(wide_name.c_str()); } // Sets the label of the confirmation button. void SetOkButtonLabel(const std::string &label) { std::wstring wide_label = Utf16FromUtf8(label); - last_result_ = dialog_->SetOkButtonLabel(wide_label.c_str()); + last_result_ = dialog_controller_->SetOkButtonLabel(wide_label.c_str()); } // Adds the given options to the dialog's current option set. void AddOptions(FILEOPENDIALOGOPTIONS new_options) { FILEOPENDIALOGOPTIONS options; - last_result_ = dialog_->GetOptions(&options); + last_result_ = dialog_controller_->GetOptions(&options); if (!SUCCEEDED(last_result_)) { return; } @@ -162,7 +180,7 @@ class DialogWrapper { if (options & FOS_PICKFOLDERS) { opening_directory_ = true; } - last_result_ = dialog_->SetOptions(options); + last_result_ = dialog_controller_->SetOptions(options); } // Sets the filters for allowed file types to select. @@ -199,29 +217,23 @@ class DialogWrapper { } filter_specs.push_back({filter_names.back().c_str(), spec.c_str()}); } - last_result_ = dialog_->SetFileTypes(static_cast(filter_specs.size()), - filter_specs.data()); + last_result_ = dialog_controller_->SetFileTypes( + static_cast(filter_specs.size()), filter_specs.data()); } // Displays the dialog, and returns the selected file or files as an // EncodableValue of type List (for open) or String (for save), or a null // EncodableValue on cancel or error. EncodableValue Show(HWND parent_window) { - assert(dialog_); - last_result_ = dialog_->Show(parent_window); + assert(dialog_controller_.has_value()); + last_result_ = dialog_controller_->Show(parent_window); if (!SUCCEEDED(last_result_)) { return EncodableValue(); } if (is_open_dialog_) { - IFileOpenDialog *open_dialog; - last_result_ = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); - if (!SUCCEEDED(last_result_)) { - return EncodableValue(); - } IShellItemArray *shell_items; - last_result_ = open_dialog->GetResults(&shell_items); - open_dialog->Release(); + last_result_ = dialog_controller_->GetResults(&shell_items); if (!SUCCEEDED(last_result_)) { return EncodableValue(); } @@ -250,7 +262,7 @@ class DialogWrapper { } } else { IShellItem *shell_item; - last_result_ = dialog_->GetResult(&shell_item); + last_result_ = dialog_controller_->GetResult(&shell_item); if (!SUCCEEDED(last_result_)) { return EncodableValue(); } @@ -264,7 +276,9 @@ class DialogWrapper { HRESULT last_result() { return last_result_; } private: - IFileDialog *dialog_ = nullptr; + // The dialog controller that all interactions are mediated through, to allow + // for unit testing. + std::optional dialog_controller_; bool is_open_dialog_; bool opening_directory_ = false; HRESULT last_result_; @@ -346,8 +360,10 @@ void FileSelectorPlugin::RegisterWithRegistrar( registrar->messenger(), "plugins.flutter.io/file_selector", &flutter::StandardMethodCodec::GetInstance()); - // Uses new instead of make_unique due to private constructor. - std::unique_ptr plugin(new FileSelectorPlugin(registrar)); + std::unique_ptr plugin = + std::make_unique( + [registrar] { return GetRootWindow(registrar->GetView()); }, + std::make_unique()); channel->SetMethodCallHandler( [plugin_pointer = plugin.get()](const auto &call, auto result) { @@ -358,8 +374,10 @@ void FileSelectorPlugin::RegisterWithRegistrar( } FileSelectorPlugin::FileSelectorPlugin( - flutter::PluginRegistrarWindows *registrar) - : registrar_(registrar) {} + FlutterRootWindowProvider window_provider, + std::unique_ptr dialog_controller_factory) + : get_root_window_(std::move(window_provider)), + controller_factory_(std::move(dialog_controller_factory)) {} FileSelectorPlugin::~FileSelectorPlugin() = default; @@ -373,8 +391,7 @@ void FileSelectorPlugin::HandleMethodCall( const auto *arguments = std::get_if(method_call.arguments()); assert(arguments); - ShowDialog(GetRootWindow(registrar_->GetView()), method_name, *arguments, - std::move(result)); + ShowDialog(get_root_window_(), method_name, *arguments, std::move(result)); } else { result->NotImplemented(); } diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h index 7816e8fcb0a1..7cc864cfc163 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -1,16 +1,32 @@ // Copyright 2020 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_SELECTOR_PLUGIN_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_SELECTOR_PLUGIN_H_ + #include #include +#include + +#include "file_dialog_controller.h" + namespace file_selector_windows { +// Abstraction for accessing the Flutter view's root window, to allow for faking +// in unit tests without creating fake window hierarchies, as well as to work +// around https://github.com/flutter/flutter/issues/90694. +using FlutterRootWindowProvider = std::function; + class FileSelectorPlugin : public flutter::Plugin { public: static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); - FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); + // Creates a new plugin instance for the given registar, using the given + // factory to create native dialog controllers. + FileSelectorPlugin( + FlutterRootWindowProvider window_provider, + std::unique_ptr dialog_controller_factory); virtual ~FileSelectorPlugin(); @@ -19,8 +35,13 @@ class FileSelectorPlugin : public flutter::Plugin { void HandleMethodCall(const flutter::MethodCall<> &method_call, std::unique_ptr> result); - // The registrar for this plugin, for accessing the window. - flutter::PluginRegistrarWindows *registrar_; + // The provider for the root window to attach the dialog to. + FlutterRootWindowProvider get_root_window_; + + // The factory for creating dialog controller instances. + std::unique_ptr controller_factory_; }; } // namespace file_selector_windows + +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_SELECTOR_PLUGIN_H_ diff --git a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp index 5314a0267abd..ab0dbaadf5d9 100644 --- a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp +++ b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp @@ -14,6 +14,8 @@ #include #include +#include "file_dialog_controller.h" + namespace file_selector_windows { namespace test { @@ -26,6 +28,28 @@ using ::testing::Pointee; using ::testing::Return; using ::testing::SetArgPointee; +// An extension of the normal file dialog controller that: +// - Allows for inspection of set values. +// - Allows faking the 'Show' interaction. +class TestFileDialogController : public FileDialogController {}; + +class TestFileDialogControllerFactory : public FileDialogControllerFactory { + public: + TestFileDialogControllerFactory() {} + virtual ~TestFileDialogControllerFactory() {} + + // Disallow copy and assign. + TestFileDialogControllerFactory(const TestFileDialogControllerFactory&) = + delete; + TestFileDialogControllerFactory& operator=( + const TestFileDialogControllerFactory&) = delete; + + std::unique_ptr CreateController( + IFileDialog* dialog) override { + return std::make_unique(dialog); + } +}; + class MockMethodResult : public flutter::MethodResult<> { public: MOCK_METHOD(void, SuccessInternal, (const EncodableValue* result), @@ -40,7 +64,8 @@ class MockMethodResult : public flutter::MethodResult<> { } // namespace TEST(FileSelectorPlugin, Placeholder) { - FileSelectorPlugin plugin(nullptr); + FileSelectorPlugin plugin( + nullptr, std::make_unique()); EXPECT_TRUE(true); } From d81ac0cdfbb728c5aeaaba28fe897b8449aa29f4 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Wed, 6 Oct 2021 15:27:32 -0400 Subject: [PATCH 06/22] Real tests --- .../file_selector_windows/LICENSE | 2 +- .../windows/CMakeLists.txt | 9 +- .../windows/file_dialog_controller.cpp | 9 +- .../windows/file_dialog_controller.h | 10 +- .../windows/file_selector_plugin.cpp | 74 +-- .../windows/file_selector_plugin.h | 4 +- .../windows/file_selector_windows.cpp | 2 +- .../file_selector_windows.h | 2 +- .../windows/string_utils.cpp | 60 +++ .../windows/string_utils.h | 21 + .../test/file_selector_plugin_test.cpp | 444 +++++++++++++++++- .../test/test_file_dialog_controller.cpp | 108 +++++ .../test/test_file_dialog_controller.h | 97 ++++ .../windows/test/test_main.cpp | 16 + .../windows/test/test_utils.cpp | 45 ++ .../windows/test/test_utils.h | 91 ++++ 16 files changed, 896 insertions(+), 98 deletions(-) create mode 100644 packages/file_selector/file_selector_windows/windows/string_utils.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/string_utils.h create mode 100644 packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h create mode 100644 packages/file_selector/file_selector_windows/windows/test/test_main.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/test/test_utils.cpp create mode 100644 packages/file_selector/file_selector_windows/windows/test/test_utils.h diff --git a/packages/file_selector/file_selector_windows/LICENSE b/packages/file_selector/file_selector_windows/LICENSE index 67c7e2c52e46..c6823b81eb84 100644 --- a/packages/file_selector/file_selector_windows/LICENSE +++ b/packages/file_selector/file_selector_windows/LICENSE @@ -1,4 +1,4 @@ -Copyright 2020 The Flutter Authors. All rights reserved. +Copyright 2013 The Flutter Authors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt index 80b2fcbb1a61..009bb46fd375 100644 --- a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -9,6 +9,8 @@ list(APPEND PLUGIN_SOURCES "file_dialog_controller.h" "file_selector_plugin.cpp" "file_selector_plugin.h" + "string_utils.cpp" + "string_utils.h" ) add_library(${PLUGIN_NAME} SHARED @@ -54,12 +56,17 @@ FetchContent_MakeAvailable(googletest) # directly into the test binary rather than using the DLL. add_executable(${TEST_RUNNER} test/file_selector_plugin_test.cpp + test/test_main.cpp + test/test_file_dialog_controller.cpp + test/test_file_dialog_controller.h + test/test_utils.cpp + test/test_utils.h ${PLUGIN_SOURCES} ) apply_standard_settings(${TEST_RUNNER}) target_include_directories(${TEST_RUNNER} PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}") target_link_libraries(${TEST_RUNNER} PRIVATE flutter_wrapper_plugin) -target_link_libraries(${TEST_RUNNER} PRIVATE gtest_main gmock) +target_link_libraries(${TEST_RUNNER} PRIVATE gtest gmock) # flutter_wrapper_plugin has link dependencies on the Flutter DLL. add_custom_command(TARGET ${TEST_RUNNER} POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp index 32d65a41027d..164d0b70307b 100644 --- a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. @@ -32,7 +32,8 @@ HRESULT FileDialogController::SetOkButtonLabel(const wchar_t* text) { return dialog_->SetOkButtonLabel(text); } -HRESULT FileDialogController::GetOptions(FILEOPENDIALOGOPTIONS* out_options) { +HRESULT FileDialogController::GetOptions( + FILEOPENDIALOGOPTIONS* out_options) const { return dialog_->GetOptions(out_options); } @@ -44,11 +45,11 @@ HRESULT FileDialogController::Show(HWND parent) { return dialog_->Show(parent); } -HRESULT FileDialogController::GetResult(IShellItem** out_item) { +HRESULT FileDialogController::GetResult(IShellItem** out_item) const { return dialog_->GetResult(out_item); } -HRESULT FileDialogController::GetResults(IShellItemArray** out_items) { +HRESULT FileDialogController::GetResults(IShellItemArray** out_items) const { IFileOpenDialog* open_dialog; HRESULT result = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); if (!SUCCEEDED(result)) { diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h index 525c1a9d6a71..8ade1b6957de 100644 --- a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ @@ -30,14 +30,14 @@ class FileDialogController { virtual HRESULT SetFileName(const wchar_t* name); virtual HRESULT SetFileTypes(UINT count, COMDLG_FILTERSPEC* filters); virtual HRESULT SetOkButtonLabel(const wchar_t* text); - virtual HRESULT GetOptions(FILEOPENDIALOGOPTIONS* out_options); + virtual HRESULT GetOptions(FILEOPENDIALOGOPTIONS* out_options) const; virtual HRESULT SetOptions(FILEOPENDIALOGOPTIONS options); virtual HRESULT Show(HWND parent); - virtual HRESULT GetResult(IShellItem** out_item); + virtual HRESULT GetResult(IShellItem** out_item) const; // IFileOpenDialog wrapper. This will fail if the IFileDialog* provided to the // constructor was not an IFileOpenDialog instance. - virtual HRESULT GetResults(IShellItemArray** out_items); + virtual HRESULT GetResults(IShellItemArray** out_items) const; private: IFileDialog* dialog_ = nullptr; @@ -50,7 +50,7 @@ class FileDialogControllerFactory { virtual ~FileDialogControllerFactory(); virtual std::unique_ptr CreateController( - IFileDialog* dialog) = 0; + IFileDialog* dialog) const = 0; }; } // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index 8cf84593fe2c..66a838bf7225 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "file_selector_plugin.h" @@ -12,11 +12,11 @@ #include #include -#include #include #include #include "file_dialog_controller.h" +#include "string_utils.h" namespace file_selector_windows { @@ -44,52 +44,6 @@ const char kSuggestedNameKey[] = "suggestedName"; const char kTypeGroupLabelKey[] = "label"; const char kTypeGroupExtensionsKey[] = "extensions"; -// Converts the given UTF-16 string to UTF-8. -std::string Utf8FromUtf16(const std::wstring &utf16_string) { - if (utf16_string.empty()) { - return std::string(); - } - int target_length = ::WideCharToMultiByte( - CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string.data(), - static_cast(utf16_string.length()), 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.data(), - static_cast(utf16_string.length()), utf8_string.data(), - target_length, nullptr, nullptr); - if (converted_length == 0) { - return std::string(); - } - return utf8_string; -} - -// Converts the given UTF-8 string to UTF-16. -std::wstring Utf16FromUtf8(const std::string &utf8_string) { - if (utf8_string.empty()) { - return std::wstring(); - } - int target_length = - ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), - static_cast(utf8_string.length()), nullptr, 0); - if (target_length == 0) { - return std::wstring(); - } - std::wstring utf16_string; - utf16_string.resize(target_length); - int converted_length = - ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), - static_cast(utf8_string.length()), - utf16_string.data(), target_length); - if (converted_length == 0) { - return std::wstring(); - } - return utf16_string; -} - // Looks for |key| in |map|, returning the associated value if it is present, or // a nullptr if not. const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { @@ -108,7 +62,7 @@ std::string GetPathForShellItem(IShellItem *shell_item) { return ""; } std::string path = Utf8FromUtf16(wide_path); - CoTaskMemFree(wide_path); + ::CoTaskMemFree(wide_path); return path; } @@ -126,7 +80,7 @@ class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { const DefaultFileDialogControllerFactory &) = delete; std::unique_ptr CreateController( - IFileDialog *dialog) override { + IFileDialog *dialog) const override { return std::make_unique(dialog); } }; @@ -135,12 +89,14 @@ class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { // providing a simplified API for interacting with it as needed for the plugin. class DialogWrapper { public: - explicit DialogWrapper(IID type) { + explicit DialogWrapper(const FileDialogControllerFactory &dialog_factory, + IID type) { is_open_dialog_ = type == CLSID_FileOpenDialog; IFileDialog *dialog = nullptr; last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&dialog)); - dialog_controller_.emplace(dialog); + dialog_controller_ = dialog_factory.CreateController(dialog); + dialog->Release(); } // Attempts to set the default folder for the dialog to |path|, @@ -225,7 +181,7 @@ class DialogWrapper { // EncodableValue of type List (for open) or String (for save), or a null // EncodableValue on cancel or error. EncodableValue Show(HWND parent_window) { - assert(dialog_controller_.has_value()); + assert(dialog_controller_); last_result_ = dialog_controller_->Show(parent_window); if (!SUCCEEDED(last_result_)) { return EncodableValue(); @@ -278,7 +234,7 @@ class DialogWrapper { private: // The dialog controller that all interactions are mediated through, to allow // for unit testing. - std::optional dialog_controller_; + std::unique_ptr dialog_controller_; bool is_open_dialog_; bool opening_directory_ = false; HRESULT last_result_; @@ -289,13 +245,14 @@ class DialogWrapper { // error on failure. // // |result| is guaranteed to be resolved by this function. -void ShowDialog(HWND parent_window, const std::string &method, +void ShowDialog(const FileDialogControllerFactory &dialog_factory, + HWND parent_window, const std::string &method, const EncodableMap &args, std::unique_ptr> result) { IID dialog_type = method.compare(kGetSavePathMethod) == 0 ? CLSID_FileSaveDialog : CLSID_FileOpenDialog; - DialogWrapper dialog(dialog_type); + DialogWrapper dialog(dialog_factory, dialog_type); if (!SUCCEEDED(dialog.last_result())) { result->Error("System error", "Could not create dialog", EncodableValue(dialog.last_result())); @@ -348,7 +305,7 @@ void ShowDialog(HWND parent_window, const std::string &method, // Returns the top-level window that owns |view|. HWND GetRootWindow(flutter::FlutterView *view) { - return GetAncestor(view->GetNativeWindow(), GA_ROOT); + return ::GetAncestor(view->GetNativeWindow(), GA_ROOT); } } // namespace @@ -391,7 +348,8 @@ void FileSelectorPlugin::HandleMethodCall( const auto *arguments = std::get_if(method_call.arguments()); assert(arguments); - ShowDialog(get_root_window_(), method_name, *arguments, std::move(result)); + ShowDialog(*controller_factory_, get_root_window_(), method_name, + *arguments, std::move(result)); } else { result->NotImplemented(); } diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h index 7cc864cfc163..9f81ae54fb48 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_SELECTOR_PLUGIN_H_ @@ -30,11 +30,11 @@ class FileSelectorPlugin : public flutter::Plugin { virtual ~FileSelectorPlugin(); - private: // Called when a method is called on plugin channel; void HandleMethodCall(const flutter::MethodCall<> &method_call, std::unique_ptr> result); + private: // The provider for the root window to attach the dialog to. FlutterRootWindowProvider get_root_window_; diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp index ef06f83ad4ff..e4d2c15fd89b 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. 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/file_selector_windows/file_selector_windows.h" diff --git a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h index efefc63912d2..7ee6ed3d29ff 100644 --- a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h +++ b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h @@ -1,4 +1,4 @@ -// Copyright 2020 The Flutter Authors. All rights reserved. +// Copyright 2013 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_INCLUDE_FILE_SELECTOR_WINDOWS_FILE_SELECTOR_WINDOWS_H_ diff --git a/packages/file_selector/file_selector_windows/windows/string_utils.cpp b/packages/file_selector/file_selector_windows/windows/string_utils.cpp new file mode 100644 index 000000000000..039986b0f060 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/string_utils.cpp @@ -0,0 +1,60 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "string_utils.h" + +#include +#include + +#include + +namespace file_selector_windows { + +// Converts the given UTF-16 string to UTF-8. +std::string Utf8FromUtf16(const std::wstring &utf16_string) { + if (utf16_string.empty()) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string.data(), + static_cast(utf16_string.length()), 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.data(), + static_cast(utf16_string.length()), utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} + +// Converts the given UTF-8 string to UTF-16. +std::wstring Utf16FromUtf8(const std::string &utf8_string) { + if (utf8_string.empty()) { + return std::wstring(); + } + int target_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), nullptr, 0); + if (target_length == 0) { + return std::wstring(); + } + std::wstring utf16_string; + utf16_string.resize(target_length); + int converted_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), + utf16_string.data(), target_length); + if (converted_length == 0) { + return std::wstring(); + } + return utf16_string; +} + +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/string_utils.h b/packages/file_selector/file_selector_windows/windows/string_utils.h new file mode 100644 index 000000000000..0634efda9041 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/string_utils.h @@ -0,0 +1,21 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_STRING_UTILS_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_STRING_UTILS_H_ + +#include + +#include + +namespace file_selector_windows { + +// Converts the given UTF-16 string to UTF-8. +std::string Utf8FromUtf16(const std::wstring &utf16_string); + +// Converts the given UTF-8 string to UTF-16. +std::wstring Utf16FromUtf8(const std::string &utf8_string); + +} // namespace file_selector_windows + +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_STRING_UTILS_H_ diff --git a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp index ab0dbaadf5d9..bd8ac9df2f3a 100644 --- a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp +++ b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp @@ -11,45 +11,30 @@ #include #include +#include #include #include +#include #include "file_dialog_controller.h" +#include "string_utils.h" +#include "test/test_file_dialog_controller.h" +#include "test/test_utils.h" namespace file_selector_windows { namespace test { namespace { +using flutter::EncodableList; using flutter::EncodableMap; using flutter::EncodableValue; +using flutter::MethodCall; using ::testing::DoAll; using ::testing::Pointee; using ::testing::Return; using ::testing::SetArgPointee; -// An extension of the normal file dialog controller that: -// - Allows for inspection of set values. -// - Allows faking the 'Show' interaction. -class TestFileDialogController : public FileDialogController {}; - -class TestFileDialogControllerFactory : public FileDialogControllerFactory { - public: - TestFileDialogControllerFactory() {} - virtual ~TestFileDialogControllerFactory() {} - - // Disallow copy and assign. - TestFileDialogControllerFactory(const TestFileDialogControllerFactory&) = - delete; - TestFileDialogControllerFactory& operator=( - const TestFileDialogControllerFactory&) = delete; - - std::unique_ptr CreateController( - IFileDialog* dialog) override { - return std::make_unique(dialog); - } -}; - class MockMethodResult : public flutter::MethodResult<> { public: MOCK_METHOD(void, SuccessInternal, (const EncodableValue* result), @@ -63,11 +48,420 @@ class MockMethodResult : public flutter::MethodResult<> { } // namespace -TEST(FileSelectorPlugin, Placeholder) { +TEST(FileSelectorPlugin, TestOpenSimple) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestShellItem fake_selected_file; + IShellItemArrayPtr fake_result_array; + ::SHCreateShellItemArrayFromShellItem(fake_selected_file.file(), + IID_PPV_ARGS(&fake_result_array)); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_result_array, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate options. + FILEOPENDIALOGOPTIONS options; + dialog.GetOptions(&options); + EXPECT_EQ(options & FOS_ALLOWMULTISELECT, 0U); + EXPECT_EQ(options & FOS_PICKFOLDERS, 0U); + + return MockShowResult(fake_result_array); + }; + EncodableValue expected_paths(EncodableList({ + EncodableValue(Utf8FromUtf16(fake_selected_file.path())), + })); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_paths))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("openFile", std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestOpenWithArguments) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestShellItem fake_selected_file; + IShellItemArrayPtr fake_result_array; + ::SHCreateShellItemArrayFromShellItem(fake_selected_file.file(), + IID_PPV_ARGS(&fake_result_array)); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_result_array, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate arguments. + EXPECT_EQ(dialog.GetDefaultFolderPath(), L"C:\\Program Files"); + EXPECT_EQ(dialog.GetFileName(), L"a name"); + EXPECT_EQ(dialog.GetOkButtonLabel(), L"Open it!"); + + return MockShowResult(fake_result_array); + }; + EncodableValue expected_paths(EncodableList({ + EncodableValue(Utf8FromUtf16(fake_selected_file.path())), + })); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_paths))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall( + "openFile", + std::make_unique(EncodableMap({ + // This directory must exist. + {EncodableValue("initialDirectory"), + EncodableValue("C:\\Program Files")}, + {EncodableValue("suggestedName"), EncodableValue("a name")}, + {EncodableValue("confirmButtonText"), EncodableValue("Open it!")}, + }))), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestOpenMultiple) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestFileIdList fake_selected_file_1; + ScopedTestFileIdList fake_selected_file_2; + LPCITEMIDLIST fake_selected_files[] = { + fake_selected_file_1.file(), + fake_selected_file_2.file(), + }; + IShellItemArrayPtr fake_result_array; + ::SHCreateShellItemArrayFromIDLists(2, fake_selected_files, + &fake_result_array); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_result_array, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate options. + FILEOPENDIALOGOPTIONS options; + dialog.GetOptions(&options); + EXPECT_NE(options & FOS_ALLOWMULTISELECT, 0U); + EXPECT_EQ(options & FOS_PICKFOLDERS, 0U); + + return MockShowResult(fake_result_array); + }; + EncodableValue expected_paths(EncodableList({ + EncodableValue(Utf8FromUtf16(fake_selected_file_1.path())), + EncodableValue(Utf8FromUtf16(fake_selected_file_2.path())), + })); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_paths))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("openFile", + std::make_unique(EncodableMap({ + {EncodableValue("multiple"), EncodableValue(true)}, + }))), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestOpenWithFilter) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestShellItem fake_selected_file; + IShellItemArrayPtr fake_result_array; + ::SHCreateShellItemArrayFromShellItem(fake_selected_file.file(), + IID_PPV_ARGS(&fake_result_array)); + + std::unique_ptr result = + std::make_unique(); + + const EncodableValue text_group = EncodableValue(EncodableMap({ + {EncodableValue("label"), EncodableValue("Text")}, + {EncodableValue("extensions"), EncodableValue(EncodableList({ + EncodableValue("txt"), + EncodableValue("json"), + }))}, + })); + const EncodableValue image_group = EncodableValue(EncodableMap({ + {EncodableValue("label"), EncodableValue("Images")}, + {EncodableValue("extensions"), EncodableValue(EncodableList({ + EncodableValue("png"), + EncodableValue("gif"), + EncodableValue("jpeg"), + }))}, + })); + const EncodableValue any_group = EncodableValue(EncodableMap({ + {EncodableValue("label"), EncodableValue("Any")}, + })); + + bool shown = false; + MockShow show_validator = [&shown, fake_result_array, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate filter. + const std::vector& filters = dialog.GetFileTypes(); + EXPECT_EQ(filters.size(), 3U); + if (filters.size() == 3U) { + EXPECT_EQ(filters[0].name, L"Text"); + EXPECT_EQ(filters[0].spec, L"*.txt;*.json"); + EXPECT_EQ(filters[1].name, L"Images"); + EXPECT_EQ(filters[1].spec, L"*.png;*.gif;*.jpeg"); + EXPECT_EQ(filters[2].name, L"Any"); + EXPECT_EQ(filters[2].spec, L"*.*"); + } + + return MockShowResult(fake_result_array); + }; + EncodableValue expected_paths(EncodableList({ + EncodableValue(Utf8FromUtf16(fake_selected_file.path())), + })); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_paths))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("openFile", std::make_unique(EncodableMap({ + {EncodableValue("acceptedTypeGroups"), + EncodableValue(EncodableList({ + text_group, + image_group, + any_group, + }))}, + }))), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestOpenCancel) { + const HWND fake_window = reinterpret_cast(1337); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + return MockShowResult(); + }; + // Cancel should return a null for the paths. + EncodableValue expected_paths; + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_paths))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("openFile", std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestSaveSimple) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestShellItem fake_selected_file; + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = + [&shown, fake_result = fake_selected_file.file(), fake_window]( + const TestFileDialogController& dialog, HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate options. + FILEOPENDIALOGOPTIONS options; + dialog.GetOptions(&options); + EXPECT_EQ(options & FOS_ALLOWMULTISELECT, 0U); + EXPECT_EQ(options & FOS_PICKFOLDERS, 0U); + + return MockShowResult(fake_result); + }; + EncodableValue expected_path(Utf8FromUtf16(fake_selected_file.path())); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_path))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("getSavePath", + std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestSaveWithArguments) { + const HWND fake_window = reinterpret_cast(1337); + ScopedTestShellItem fake_selected_file; + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = + [&shown, fake_result = fake_selected_file.file(), fake_window]( + const TestFileDialogController& dialog, HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate arguments. + EXPECT_EQ(dialog.GetDefaultFolderPath(), L"C:\\Program Files"); + EXPECT_EQ(dialog.GetOkButtonLabel(), L"Save it!"); + + return MockShowResult(fake_result); + }; + EncodableValue expected_path(Utf8FromUtf16(fake_selected_file.path())); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_path))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall( + "getSavePath", + std::make_unique(EncodableMap({ + // This directory must exist. + {EncodableValue("initialDirectory"), + EncodableValue("C:\\Program Files")}, + {EncodableValue("confirmButtonText"), EncodableValue("Save it!")}, + }))), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestSaveCancel) { + const HWND fake_window = reinterpret_cast(1337); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + return MockShowResult(); + }; + // Cancel should return a null for the path. + EncodableValue expected_path; + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_path))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("getSavePath", + std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestGetDirectorySimple) { + const HWND fake_window = reinterpret_cast(1337); + IShellItemPtr fake_selected_directory; + // This must be a directory that actually exists. + ::SHCreateItemFromParsingName(L"C:\\Program Files", nullptr, + IID_PPV_ARGS(&fake_selected_directory)); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_selected_directory, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + EXPECT_EQ(parent, fake_window); + + // Validate options. + FILEOPENDIALOGOPTIONS options; + dialog.GetOptions(&options); + EXPECT_EQ(options & FOS_ALLOWMULTISELECT, 0U); + EXPECT_NE(options & FOS_PICKFOLDERS, 0U); + + return MockShowResult(fake_selected_directory); + }; + EncodableValue expected_path("C:\\Program Files"); + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_path))); + + FileSelectorPlugin plugin( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("getDirectoryPath", + std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +TEST(FileSelectorPlugin, TestGetDirectoryCancel) { + const HWND fake_window = reinterpret_cast(1337); + + std::unique_ptr result = + std::make_unique(); + + bool shown = false; + MockShow show_validator = [&shown, fake_window]( + const TestFileDialogController& dialog, + HWND parent) { + shown = true; + return MockShowResult(); + }; + // Cancel should return a null for the path. + EncodableValue expected_path; + // Expect the mock path. + EXPECT_CALL(*result, SuccessInternal(Pointee(expected_path))); + FileSelectorPlugin plugin( - nullptr, std::make_unique()); + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("getDirectoryPath", + std::make_unique(EncodableMap())), + std::move(result)); - EXPECT_TRUE(true); + EXPECT_TRUE(shown); } } // namespace test diff --git a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp new file mode 100644 index 000000000000..46d92a9143c1 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp @@ -0,0 +1,108 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#include "test/test_file_dialog_controller.h" + +#include + +#include +#include +#include + +namespace file_selector_windows { +namespace test { + +TestFileDialogController::TestFileDialogController(IFileDialog* dialog, + MockShow mock_show) + : dialog_(dialog), + mock_show_(std::move(mock_show)), + FileDialogController(dialog) { + dialog_->AddRef(); +} + +TestFileDialogController::~TestFileDialogController() { dialog_->Release(); } + +HRESULT TestFileDialogController::SetFileTypes(UINT count, + COMDLG_FILTERSPEC* filters) { + filter_groups_.clear(); + for (unsigned int i = 0; i < count; ++i) { + filter_groups_.push_back( + DialogFilter(filters[i].pszName, filters[i].pszSpec)); + } + return FileDialogController::SetFileTypes(count, filters); +} + +HRESULT TestFileDialogController::SetOkButtonLabel(const wchar_t* text) { + ok_button_label_ = text; + return FileDialogController::SetOkButtonLabel(text); +} + +HRESULT TestFileDialogController::Show(HWND parent) { + mock_result_ = mock_show_(*this, parent); + if (std::holds_alternative(mock_result_)) { + return HRESULT_FROM_WIN32(ERROR_CANCELLED); + } + return S_OK; +} + +HRESULT TestFileDialogController::GetResult(IShellItem** out_item) const { + *out_item = std::get(mock_result_); + (*out_item)->AddRef(); + return S_OK; +} + +HRESULT TestFileDialogController::GetResults( + IShellItemArray** out_items) const { + *out_items = std::get(mock_result_); + (*out_items)->AddRef(); + return S_OK; +} + +std::wstring TestFileDialogController::GetDefaultFolderPath() const { + IShellItemPtr item; + if (!SUCCEEDED(dialog_->GetFolder(&item))) { + return L""; + } + + wchar_t* path_chars = nullptr; + if (!SUCCEEDED(item->GetDisplayName(SIGDN_FILESYSPATH, &path_chars))) { + return L""; + } + std::wstring path(path_chars); + ::CoTaskMemFree(path_chars); + return path; +} + +std::wstring TestFileDialogController::GetFileName() const { + wchar_t* name_chars = nullptr; + if (!SUCCEEDED(dialog_->GetFileName(&name_chars))) { + return L""; + } + std::wstring name(name_chars); + ::CoTaskMemFree(name_chars); + return name; +} + +const std::vector& TestFileDialogController::GetFileTypes() + const { + return filter_groups_; +} + +std::wstring TestFileDialogController::GetOkButtonLabel() const { + return ok_button_label_; +} + +// ---------------------------------------- + +TestFileDialogControllerFactory::TestFileDialogControllerFactory( + MockShow mock_show) + : mock_show_(std::move(mock_show)) {} +TestFileDialogControllerFactory::~TestFileDialogControllerFactory() {} + +std::unique_ptr +TestFileDialogControllerFactory::CreateController(IFileDialog* dialog) const { + return std::make_unique(dialog, mock_show_); +} + +} // namespace test +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h new file mode 100644 index 000000000000..c63ed105fbb4 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h @@ -0,0 +1,97 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_FILE_DIALOG_CONTROLLER_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_FILE_DIALOG_CONTROLLER_H_ + +#include + +#include +#include +#include +#include + +#include "file_dialog_controller.h" +#include "test/test_utils.h" + +namespace file_selector_windows { +namespace test { + +class TestFileDialogController; + +// A value to use for GetResult(s) in TestFileDialogController. The type depends +// on whether the dialog is an open or save dialog. +using MockShowResult = + std::variant; +// Called for TestFileDialogController::Show, to do validation and provide a +// mock return value for GetResult(s). +using MockShow = + std::function; + +// A C++-friendly version of a COMDLG_FILTERSPEC. +struct DialogFilter { + std::wstring name; + std::wstring spec; + + DialogFilter(const wchar_t* name, const wchar_t* spec) + : name(name), spec(spec) {} +}; + +// An extension of the normal file dialog controller that: +// - Allows for inspection of set values. +// - Allows faking the 'Show' interaction, providing tests an opportunity to +// validate the dialog settings and provide a return value, via MockShow. +class TestFileDialogController : public FileDialogController { + public: + TestFileDialogController(IFileDialog* dialog, MockShow mock_show); + ~TestFileDialogController(); + + // FileDialogController: + HRESULT SetFileTypes(UINT count, COMDLG_FILTERSPEC* filters) override; + HRESULT SetOkButtonLabel(const wchar_t* text) override; + HRESULT Show(HWND parent) override; + HRESULT GetResult(IShellItem** out_item) const override; + HRESULT GetResults(IShellItemArray** out_items) const override; + + // Accessors for validating IFileDialogController setter calls. + std::wstring GetDefaultFolderPath() const; + std::wstring GetFileName() const; + const std::vector& GetFileTypes() const; + std::wstring GetOkButtonLabel() const; + + private: + IFileDialog* dialog_; + MockShow mock_show_; + MockShowResult mock_result_; + + // The last set values, for IFileDialog properties that have setters but no + // corresponding getters. + std::wstring ok_button_label_; + std::vector filter_groups_; +}; + +// A controller factory that vends TestFileDialogController instances. +class TestFileDialogControllerFactory : public FileDialogControllerFactory { + public: + // Creates a factory whose instances use mock_show for the Show callback. + TestFileDialogControllerFactory(MockShow mock_show); + virtual ~TestFileDialogControllerFactory(); + + // Disallow copy and assign. + TestFileDialogControllerFactory(const TestFileDialogControllerFactory&) = + delete; + TestFileDialogControllerFactory& operator=( + const TestFileDialogControllerFactory&) = delete; + + // FileDialogControllerFactory: + std::unique_ptr CreateController( + IFileDialog* dialog) const override; + + private: + MockShow mock_show_; +}; + +} // namespace test +} // namespace file_selector_windows + +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_FILE_DIALOG_CONTROLLER_H_ diff --git a/packages/file_selector/file_selector_windows/windows/test/test_main.cpp b/packages/file_selector/file_selector_windows/windows/test/test_main.cpp new file mode 100644 index 000000000000..5a49b52c1c76 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_main.cpp @@ -0,0 +1,16 @@ +// Copyright 2013 The Flutter Authors. 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 + +int main(int argc, char** argv) { + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + testing::InitGoogleTest(&argc, argv); + int exit_code = RUN_ALL_TESTS(); + + ::CoUninitialize(); + + return exit_code; +} diff --git a/packages/file_selector/file_selector_windows/windows/test/test_utils.cpp b/packages/file_selector/file_selector_windows/windows/test/test_utils.cpp new file mode 100644 index 000000000000..3e3ab98a734a --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_utils.cpp @@ -0,0 +1,45 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#include "test/test_utils.h" + +#include +#include + +#include + +namespace file_selector_windows { +namespace test { + +namespace { + +// Creates a temp file and returns its path. +std::wstring CreateTempFile() { + wchar_t temp_dir[MAX_PATH]; + wchar_t temp_file[MAX_PATH]; + wchar_t long_path[MAX_PATH]; + ::GetTempPath(MAX_PATH, temp_dir); + ::GetTempFileName(temp_dir, L"test", 0, temp_file); + // Convert to long form to match what IShellItem queries will return. + ::GetLongPathName(temp_file, long_path, MAX_PATH); + return long_path; +} + +} // namespace + +ScopedTestShellItem::ScopedTestShellItem() { + path_ = CreateTempFile(); + ::SHCreateItemFromParsingName(path_.c_str(), nullptr, IID_PPV_ARGS(&item_)); +} + +ScopedTestShellItem::~ScopedTestShellItem() { ::DeleteFile(path_.c_str()); } + +ScopedTestFileIdList::ScopedTestFileIdList() { + path_ = CreateTempFile(); + item_ = ItemIdListPtr(::ILCreateFromPath(path_.c_str())); +} + +ScopedTestFileIdList::~ScopedTestFileIdList() { ::DeleteFile(path_.c_str()); } + +} // namespace test +} // namespace file_selector_windows diff --git a/packages/file_selector/file_selector_windows/windows/test/test_utils.h b/packages/file_selector/file_selector_windows/windows/test/test_utils.h new file mode 100644 index 000000000000..414362042b99 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_utils.h @@ -0,0 +1,91 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_UTILS_H_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_UTILS_H_ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "file_dialog_controller.h" + +_COM_SMARTPTR_TYPEDEF(IShellItem, IID_IShellItem); +_COM_SMARTPTR_TYPEDEF(IShellItemArray, IID_IShellItemArray); + +namespace file_selector_windows { +namespace test { + +// Creates a temp file, managed as an IShellItem, which will be deleted when +// the instance goes out of scope. +// +// This creates a file on the filesystem since creating IShellItem instances for +// files that don't exist is not-trivial. +class ScopedTestShellItem { + public: + ScopedTestShellItem(); + ~ScopedTestShellItem(); + + // Disallow copy and assign. + ScopedTestShellItem(const ScopedTestShellItem&) = delete; + ScopedTestShellItem& operator=(const ScopedTestShellItem&) = delete; + + // Returns the file's IShellItem reference. + IShellItemPtr file() { return item_; } + + // Returns the file's path. + const std::wstring& path() { return path_; } + + private: + IShellItemPtr item_; + std::wstring path_; +}; + +// Creates a temp file, managed as an ITEMIDLIST, which will be deleted when +// the instance goes out of scope. +// +// This creates a file on the filesystem since creating IShellItem instances for +// files that don't exist is not-trivial, and this is intended for use in +// creating IShellItemArray instances. +class ScopedTestFileIdList { + public: + ScopedTestFileIdList(); + ~ScopedTestFileIdList(); + + // Disallow copy and assign. + ScopedTestFileIdList(const ScopedTestFileIdList&) = delete; + ScopedTestFileIdList& operator=(const ScopedTestFileIdList&) = delete; + + // Returns the file's ITEMIDLIST reference. + PIDLIST_ABSOLUTE file() { return item_.get(); } + + // Returns the file's path. + const std::wstring& path() { return path_; } + + private: + // Smart pointer for managing ITEMIDLIST instances. + struct ItemIdListDeleter { + void operator()(LPITEMIDLIST item) { + if (item) { + ::ILFree(item); + } + } + }; + using ItemIdListPtr = std::unique_ptr, + ItemIdListDeleter>; + + ItemIdListPtr item_; + std::wstring path_; +}; + +} // namespace test +} // namespace file_selector_windows + +#endif // PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_UTILS_H_ From 1c2beff1cd8f31097b7f847459c1401dc3566aab Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 14:39:43 -0400 Subject: [PATCH 07/22] CHANGELOG --- packages/file_selector/file_selector_windows/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/file_selector/file_selector_windows/CHANGELOG.md b/packages/file_selector/file_selector_windows/CHANGELOG.md index a54a68875501..b1c5960a89be 100644 --- a/packages/file_selector/file_selector_windows/CHANGELOG.md +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.8.2 + +* Moved to flutter/plugins, and restructured to allow for unit testing. + ## 0.0.2+1 * Update README From 031aa60b1b3710474a745ee4cd86947058d83668 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 14:54:38 -0400 Subject: [PATCH 08/22] Exclude integration test --- .ci/scripts/drive_examples_win32.sh | 2 +- script/configs/exclude_integration_win32.yaml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 script/configs/exclude_integration_win32.yaml diff --git a/.ci/scripts/drive_examples_win32.sh b/.ci/scripts/drive_examples_win32.sh index 63abc06bec5a..c380523ca822 100644 --- a/.ci/scripts/drive_examples_win32.sh +++ b/.ci/scripts/drive_examples_win32.sh @@ -4,4 +4,4 @@ # found in the LICENSE file. dart ./script/tool/bin/flutter_plugin_tools.dart drive-examples --windows \ - --packages-for-branch + --exclude=script/configs/exclude_integration_win32.yaml --packages-for-branch diff --git a/script/configs/exclude_integration_win32.yaml b/script/configs/exclude_integration_win32.yaml new file mode 100644 index 000000000000..68aac9df1c4b --- /dev/null +++ b/script/configs/exclude_integration_win32.yaml @@ -0,0 +1,2 @@ +# Can't use Flutter integration tests due to native modal UI. +- file_selector_windows From 44d35cfaaaa8b3ca7fb12b6044a652d21af72718 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 15:23:58 -0400 Subject: [PATCH 09/22] Remove template-generated analysis options --- .../example/analysis_options.yaml | 29 ------------------- 1 file changed, 29 deletions(-) delete mode 100644 packages/file_selector/file_selector_windows/example/analysis_options.yaml diff --git a/packages/file_selector/file_selector_windows/example/analysis_options.yaml b/packages/file_selector/file_selector_windows/example/analysis_options.yaml deleted file mode 100644 index 61b6c4de17c9..000000000000 --- a/packages/file_selector/file_selector_windows/example/analysis_options.yaml +++ /dev/null @@ -1,29 +0,0 @@ -# This file configures the analyzer, which statically analyzes Dart code to -# check for errors, warnings, and lints. -# -# The issues identified by the analyzer are surfaced in the UI of Dart-enabled -# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be -# invoked from the command line by running `flutter analyze`. - -# The following line activates a set of recommended lints for Flutter apps, -# packages, and plugins designed to encourage good coding practices. -include: package:flutter_lints/flutter.yaml - -linter: - # The lint rules applied to this project can be customized in the - # section below to disable rules from the `package:flutter_lints/flutter.yaml` - # included above or to enable additional rules. A list of all available lints - # and their documentation is published at - # https://dart-lang.github.io/linter/lints/index.html. - # - # Instead of disabling a lint rule for the entire project in the - # section below, it can also be suppressed for a single line of code - # or a specific dart file by using the `// ignore: name_of_lint` and - # `// ignore_for_file: name_of_lint` syntax on the line or in the file - # producing the lint. - rules: - # avoid_print: false # Uncomment to disable the `avoid_print` rule - # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule - -# Additional information about this file can be found at -# https://dart.dev/guides/language/analysis-options From 698936cf6f3f138a9ce8b8a86a46a25a20a7a794 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 15:24:04 -0400 Subject: [PATCH 10/22] Add AUTHORS --- packages/file_selector/file_selector_windows/AUTHORS | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 packages/file_selector/file_selector_windows/AUTHORS diff --git a/packages/file_selector/file_selector_windows/AUTHORS b/packages/file_selector/file_selector_windows/AUTHORS new file mode 100644 index 000000000000..557dff97933b --- /dev/null +++ b/packages/file_selector/file_selector_windows/AUTHORS @@ -0,0 +1,6 @@ +# Below is a list of people and organizations that have contributed +# to the Flutter project. Names should be added to the list like so: +# +# Name/Organization + +Google Inc. From e49ba4811b27615d1c12af797a98ea2eb06a6492 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 16:09:33 -0400 Subject: [PATCH 11/22] Missing licenses in template code --- .../example/windows/runner/flutter_window.cpp | 3 +++ .../example/windows/runner/flutter_window.h | 3 +++ .../example/windows/runner/main.cpp | 6 ++++-- .../example/windows/runner/utils.cpp | 14 +++++++------ .../example/windows/runner/utils.h | 3 +++ .../example/windows/runner/win32_window.cpp | 21 +++++++------------ .../example/windows/runner/win32_window.h | 12 +++++------ 7 files changed, 35 insertions(+), 27 deletions(-) diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp index b43b9095ea3a..217bf9b69e67 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #include "flutter_window.h" #include diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h index 6da0652f05f2..7cbf3d3ebbb2 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #ifndef RUNNER_FLUTTER_WINDOW_H_ #define RUNNER_FLUTTER_WINDOW_H_ diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp index bcb57b0e2aac..d19f025485f1 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp +++ b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. 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 #include @@ -19,8 +22,7 @@ int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, flutter::DartProject project(L"data"); - std::vector command_line_arguments = - GetCommandLineArguments(); + std::vector command_line_arguments = GetCommandLineArguments(); project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp index d19bdbbcc322..8b8eaa54539a 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #include "utils.h" #include @@ -9,7 +12,7 @@ void CreateAndAttachConsole() { if (::AllocConsole()) { - FILE *unused; + FILE* unused; if (freopen_s(&unused, "CONOUT$", "w", stdout)) { _dup2(_fileno(stdout), 1); } @@ -45,17 +48,16 @@ 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); + 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(), + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, -1, utf8_string.data(), target_length, nullptr, nullptr); if (converted_length == 0) { return std::string(); diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/utils.h b/packages/file_selector/file_selector_windows/example/windows/runner/utils.h index 3879d5475579..6d1cc48f0426 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/utils.h +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.h @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #ifndef RUNNER_UTILS_H_ #define RUNNER_UTILS_H_ diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp index c10f08dc7da6..34738de2d35b 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #include "win32_window.h" #include @@ -93,17 +96,14 @@ void WindowClassRegistrar::UnregisterWindowClass() { class_registered_ = false; } -Win32Window::Win32Window() { - ++g_active_window_count; -} +Win32Window::Win32Window() { ++g_active_window_count; } Win32Window::~Win32Window() { --g_active_window_count; Destroy(); } -bool Win32Window::CreateAndShow(const std::wstring& title, - const Point& origin, +bool Win32Window::CreateAndShow(const std::wstring& title, const Point& origin, const Size& size) { Destroy(); @@ -130,8 +130,7 @@ bool Win32Window::CreateAndShow(const std::wstring& title, } // static -LRESULT CALLBACK Win32Window::WndProc(HWND const window, - UINT const message, +LRESULT CALLBACK Win32Window::WndProc(HWND const window, UINT const message, WPARAM const wparam, LPARAM const lparam) noexcept { if (message == WM_NCCREATE) { @@ -150,9 +149,7 @@ LRESULT CALLBACK Win32Window::WndProc(HWND const window, } LRESULT -Win32Window::MessageHandler(HWND hwnd, - UINT const message, - WPARAM const wparam, +Win32Window::MessageHandler(HWND hwnd, UINT const message, WPARAM const wparam, LPARAM const lparam) noexcept { switch (message) { case WM_DESTROY: @@ -227,9 +224,7 @@ RECT Win32Window::GetClientArea() { return frame; } -HWND Win32Window::GetHandle() { - return window_handle_; -} +HWND Win32Window::GetHandle() { return window_handle_; } void Win32Window::SetQuitOnClose(bool quit_on_close) { quit_on_close_ = quit_on_close; diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h index 17ba431125b4..0f8bd1b7f920 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h @@ -1,3 +1,6 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. #ifndef RUNNER_WIN32_WINDOW_H_ #define RUNNER_WIN32_WINDOW_H_ @@ -34,8 +37,7 @@ class Win32Window { // 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, + bool CreateAndShow(const std::wstring& title, const Point& origin, const Size& size); // Release OS resources associated with window. @@ -58,8 +60,7 @@ class Win32Window { // 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, + virtual LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, LPARAM const lparam) noexcept; @@ -78,8 +79,7 @@ class Win32Window { // 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, + static LRESULT CALLBACK WndProc(HWND const window, UINT const message, WPARAM const wparam, LPARAM const lparam) noexcept; From 27a942579d28190854f74711e8b2810842700129 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 16:36:09 -0400 Subject: [PATCH 12/22] More formatting --- .../example/windows/runner/resource.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/resource.h b/packages/file_selector/file_selector_windows/example/windows/runner/resource.h index 66a65d1e4a79..d5d958dc4257 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/resource.h +++ b/packages/file_selector/file_selector_windows/example/windows/runner/resource.h @@ -2,15 +2,15 @@ // Microsoft Visual C++ generated include file. // Used by Runner.rc // -#define IDI_APP_ICON 101 +#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 +#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 From a36d5d5662254e1b0121cebe9bf5983f66da1515 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Mon, 11 Oct 2021 16:46:38 -0400 Subject: [PATCH 13/22] Fix directory test --- .../windows/test/file_selector_plugin_test.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp index bd8ac9df2f3a..20e1bba2794f 100644 --- a/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp +++ b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp @@ -401,12 +401,15 @@ TEST(FileSelectorPlugin, TestGetDirectorySimple) { // This must be a directory that actually exists. ::SHCreateItemFromParsingName(L"C:\\Program Files", nullptr, IID_PPV_ARGS(&fake_selected_directory)); + IShellItemArrayPtr fake_result_array; + ::SHCreateShellItemArrayFromShellItem(fake_selected_directory, + IID_PPV_ARGS(&fake_result_array)); std::unique_ptr result = std::make_unique(); bool shown = false; - MockShow show_validator = [&shown, fake_selected_directory, fake_window]( + MockShow show_validator = [&shown, fake_result_array, fake_window]( const TestFileDialogController& dialog, HWND parent) { shown = true; @@ -418,7 +421,7 @@ TEST(FileSelectorPlugin, TestGetDirectorySimple) { EXPECT_EQ(options & FOS_ALLOWMULTISELECT, 0U); EXPECT_NE(options & FOS_PICKFOLDERS, 0U); - return MockShowResult(fake_selected_directory); + return MockShowResult(fake_result_array); }; EncodableValue expected_path("C:\\Program Files"); // Expect the mock path. From 1685aa557ae00d121a505bae8496815c01619ad6 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 12 Oct 2021 10:35:25 -0400 Subject: [PATCH 14/22] pubspec fixes --- .../file_selector/file_selector_windows/pubspec.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml index a08a44bed0d0..e8e316ff9259 100644 --- a/packages/file_selector/file_selector_windows/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -1,9 +1,13 @@ name: file_selector_windows description: Windows implementation of the file_selector plugin. -homepage: https://github.com/flutter/plugins/tree/master/packages/file_selector/file_selector_windows -issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aopen+label%3A%22p%3A+file_selector%22 +repository: https://github.com/flutter/plugins/tree/master/packages/file_selector/file_selector_windows +issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22 version: 0.8.2 +environment: + sdk: ">=2.12.0 <3.0.0" + flutter: ">=1.22.0" + flutter: plugin: implements: file_selector @@ -11,10 +15,6 @@ flutter: windows: pluginClass: FileSelectorWindows -environment: - sdk: ">=2.12.0 <3.0.0" - flutter: ">=1.22.0" - dependencies: flutter: sdk: flutter From 55f88269b3af95d97412ac4ab009ac74fa75c1e5 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 11 Jan 2022 13:43:30 -0500 Subject: [PATCH 15/22] Minor fixes --- packages/file_selector/file_selector_windows/CHANGELOG.md | 2 +- .../file_selector/file_selector_windows/example/pubspec.yaml | 2 +- packages/file_selector/file_selector_windows/pubspec.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/file_selector/file_selector_windows/CHANGELOG.md b/packages/file_selector/file_selector_windows/CHANGELOG.md index b1c5960a89be..472db74bd7de 100644 --- a/packages/file_selector/file_selector_windows/CHANGELOG.md +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -1,6 +1,6 @@ ## 0.8.2 -* Moved to flutter/plugins, and restructured to allow for unit testing. +* Moves source to flutter/plugins, and restructures to allow for unit testing. ## 0.0.2+1 diff --git a/packages/file_selector/file_selector_windows/example/pubspec.yaml b/packages/file_selector/file_selector_windows/example/pubspec.yaml index 40c7690cb935..b66a2023deb2 100644 --- a/packages/file_selector/file_selector_windows/example/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/example/pubspec.yaml @@ -8,6 +8,7 @@ environment: flutter: ">=2.0.0" dependencies: + file_selector_platform_interface: ^2.0.0 file_selector_windows: # When depending on this package from a real application you should use: # file_selector_windows: ^x.y.z @@ -15,7 +16,6 @@ dependencies: # The example app is bundled with the plugin so we use a path dependency on # the parent directory to use the current plugin's version. path: .. - file_selector_platform_interface: ^2.0.0 flutter: sdk: flutter diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml index e8e316ff9259..48f15bd68679 100644 --- a/packages/file_selector/file_selector_windows/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -6,7 +6,7 @@ version: 0.8.2 environment: sdk: ">=2.12.0 <3.0.0" - flutter: ">=1.22.0" + flutter: ">=2.5.0" flutter: plugin: From 22190238fb9c187115aa54251c743772bd258461 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 11 Jan 2022 14:45:34 -0500 Subject: [PATCH 16/22] Fix publish warning --- .../windows/flutter/generated_plugin_registrant.h | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h deleted file mode 100644 index dc139d85a931..000000000000 --- a/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h +++ /dev/null @@ -1,15 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#ifndef GENERATED_PLUGIN_REGISTRANT_ -#define GENERATED_PLUGIN_REGISTRANT_ - -#include - -// Registers Flutter plugins. -void RegisterPlugins(flutter::PluginRegistry* registry); - -#endif // GENERATED_PLUGIN_REGISTRANT_ From d67e159e06a4da6f0096ead15fa647197eb52124 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 11 Jan 2022 14:50:01 -0500 Subject: [PATCH 17/22] Update build for repo changes --- .../file_selector_windows/example/windows/CMakeLists.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt index b8aa18f9aabe..5b8fe9705e55 100644 --- a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -48,6 +48,8 @@ add_subdirectory("runner") # Enable the test target set(include_file_selector_windows_tests TRUE) +# Provide an alias for the test target using the name expected by repo tooling. +add_custom_target(unit_tests DEPENDS file_selector_windows_test) # Generated plugin build rules, which manage building the plugins and adding # them to the application. From 53348b84b03ba0857b857f75020fa3cadbaf827a Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 25 Jan 2022 16:05:28 -0500 Subject: [PATCH 18/22] Review comments --- .../example/lib/get_directory_page.dart | 9 ++-- .../example/lib/home_page.dart | 2 +- .../example/lib/main.dart | 2 +- .../example/lib/open_image_page.dart | 11 ++-- .../lib/open_multiple_images_page.dart | 9 ++-- .../example/lib/open_text_page.dart | 11 ++-- .../example/lib/save_text_page.dart | 3 +- .../example/windows/CMakeLists.txt | 2 +- .../example/windows/flutter/CMakeLists.txt | 2 +- .../example/windows/runner/CMakeLists.txt | 2 +- .../windows/CMakeLists.txt | 2 +- .../windows/file_dialog_controller.cpp | 13 ++--- .../windows/file_dialog_controller.h | 6 ++- .../windows/file_selector_plugin.cpp | 52 ++++++++++--------- .../test/test_file_dialog_controller.cpp | 6 +-- .../test/test_file_dialog_controller.h | 6 ++- .../windows/test/test_utils.h | 4 +- 17 files changed, 79 insertions(+), 63 deletions(-) diff --git a/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart b/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart index 9d95c1e70196..b282b9030d67 100644 --- a/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart @@ -5,7 +5,8 @@ import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; import 'package:flutter/material.dart'; -/// Screen that shows an example of getDirectoryPath +/// Screen that allows the user to select a directory using `getDirectoryPath`, +/// then displays the selected directory in a dialog. class GetDirectoryPage extends StatelessWidget { Future _getDirectoryPath(BuildContext context) async { const String confirmButtonText = 'Choose'; @@ -48,12 +49,12 @@ class GetDirectoryPage extends StatelessWidget { } } -/// Widget that displays a text file in a dialog +/// Widget that displays a text file in a dialog. class TextDisplay extends StatelessWidget { - /// Default Constructor + /// Creates a `TextDisplay`. const TextDisplay(this.directoryPath); - /// Directory path + /// The path selected in the dialog. final String directoryPath; @override diff --git a/packages/file_selector/file_selector_windows/example/lib/home_page.dart b/packages/file_selector/file_selector_windows/example/lib/home_page.dart index c598cbdf2611..958680be0e3b 100644 --- a/packages/file_selector/file_selector_windows/example/lib/home_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/home_page.dart @@ -4,7 +4,7 @@ import 'package:flutter/material.dart'; -/// Home Page of the application +/// Home Page of the application. class HomePage extends StatelessWidget { @override Widget build(BuildContext context) { diff --git a/packages/file_selector/file_selector_windows/example/lib/main.dart b/packages/file_selector/file_selector_windows/example/lib/main.dart index 14ce3f593f33..a49ebac1aea5 100644 --- a/packages/file_selector/file_selector_windows/example/lib/main.dart +++ b/packages/file_selector/file_selector_windows/example/lib/main.dart @@ -14,7 +14,7 @@ void main() { runApp(MyApp()); } -/// MyApp is the Main Application +/// MyApp is the Main Application. class MyApp extends StatelessWidget { @override Widget build(BuildContext context) { diff --git a/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart index ceb307678368..ecbc438ac5f6 100644 --- a/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart @@ -8,7 +8,8 @@ import 'package:file_selector_platform_interface/file_selector_platform_interfac import 'package:flutter/foundation.dart'; import 'package:flutter/material.dart'; -/// Screen that shows an example of openFiles +/// Screen that allows the user to select an image file using +/// `openFiles`, then displays the selected images in a gallery dialog. class OpenImagePage extends StatelessWidget { Future _openImageFile(BuildContext context) async { final XTypeGroup typeGroup = XTypeGroup( @@ -56,15 +57,15 @@ class OpenImagePage extends StatelessWidget { } } -/// Widget that displays a text file in a dialog +/// Widget that displays an image in a dialog. class ImageDisplay extends StatelessWidget { - /// Default Constructor + /// Default Constructor. const ImageDisplay(this.fileName, this.filePath); - /// Image's name + /// The name of the selected file. final String fileName; - /// Image's path + /// The path to the selected file. final String filePath; @override diff --git a/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart index 2ab71339688c..a030b8b4b10b 100644 --- a/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart @@ -8,7 +8,8 @@ import 'package:file_selector_platform_interface/file_selector_platform_interfac import 'package:flutter/foundation.dart'; import 'package:flutter/material.dart'; -/// Screen that shows an example of openFiles +/// Screen that allows the user to select multiple image files using +/// `openFiles`, then displays the selected images in a gallery dialog. class OpenMultipleImagesPage extends StatelessWidget { Future _openImageFile(BuildContext context) async { final XTypeGroup jpgsTypeGroup = XTypeGroup( @@ -59,12 +60,12 @@ class OpenMultipleImagesPage extends StatelessWidget { } } -/// Widget that displays a text file in a dialog +/// Widget that displays a text file in a dialog. class MultipleImagesDisplay extends StatelessWidget { - /// Default Constructor + /// Default Constructor. const MultipleImagesDisplay(this.files); - /// The files containing the images + /// The files containing the images. final List files; @override diff --git a/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart index 84f5f510f898..fa281a0020d5 100644 --- a/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart @@ -5,7 +5,8 @@ import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; import 'package:flutter/material.dart'; -/// Screen that shows an example of openFile +/// Screen that allows the user to select a text file using `openFile`, then +/// displays its contents in a dialog. class OpenTextPage extends StatelessWidget { Future _openTextFile(BuildContext context) async { final XTypeGroup typeGroup = XTypeGroup( @@ -52,15 +53,15 @@ class OpenTextPage extends StatelessWidget { } } -/// Widget that displays a text file in a dialog +/// Widget that displays a text file in a dialog. class TextDisplay extends StatelessWidget { - /// Default Constructor + /// Default Constructor. const TextDisplay(this.fileName, this.fileContent); - /// File's name + /// The name of the selected file. final String fileName; - /// File to display + /// The contents of the text file. final String fileContent; @override diff --git a/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart b/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart index 7f3f8aaad4b1..b87a51c3877d 100644 --- a/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart @@ -6,7 +6,8 @@ import 'dart:typed_data'; import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; import 'package:flutter/material.dart'; -/// Page for showing an example of saving with file_selector +/// Screen that allows the user to select a save location using `getSavePath`, +/// then writes text to a file at that location. class SaveTextPage extends StatelessWidget { final TextEditingController _nameController = TextEditingController(); final TextEditingController _contentController = TextEditingController(); diff --git a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt index 5b8fe9705e55..57d4c0c59d30 100644 --- a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.15) +cmake_minimum_required(VERSION 3.14) project(example LANGUAGES CXX) set(BINARY_NAME "example") diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt index b02c5485c957..b2e4bd8d658b 100644 --- a/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.15) +cmake_minimum_required(VERSION 3.14) set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt index 0b899a0bcf13..de2d8916b72b 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.15) +cmake_minimum_required(VERSION 3.14) project(runner LANGUAGES CXX) add_executable(${BINARY_NAME} WIN32 diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt index 009bb46fd375..01c9f58b98a2 100644 --- a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.10) +cmake_minimum_required(VERSION 3.14) set(PROJECT_NAME "file_selector_windows") project(${PROJECT_NAME} LANGUAGES CXX) diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp index 164d0b70307b..e4b1a2afcdde 100644 --- a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp @@ -4,16 +4,18 @@ #include "file_dialog_controller.h" +#include +#include #include +_COM_SMARTPTR_TYPEDEF(IFileOpenDialog, IID_IFileOpenDialog); + namespace file_selector_windows { FileDialogController::FileDialogController(IFileDialog* dialog) - : dialog_(dialog) { - dialog_->AddRef(); -} + : dialog_(dialog) {} -FileDialogController::~FileDialogController() { dialog_->Release(); } +FileDialogController::~FileDialogController() {} HRESULT FileDialogController::SetDefaultFolder(IShellItem* folder) { return dialog_->SetDefaultFolder(folder); @@ -50,13 +52,12 @@ HRESULT FileDialogController::GetResult(IShellItem** out_item) const { } HRESULT FileDialogController::GetResults(IShellItemArray** out_items) const { - IFileOpenDialog* open_dialog; + IFileOpenDialogPtr open_dialog; HRESULT result = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); if (!SUCCEEDED(result)) { return result; } result = open_dialog->GetResults(out_items); - open_dialog->Release(); return result; } diff --git a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h index 8ade1b6957de..e7357338243e 100644 --- a/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h @@ -4,11 +4,15 @@ #ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ #define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_FILE_DIALOG_CONTROLLER_H_ +#include +#include #include #include #include +_COM_SMARTPTR_TYPEDEF(IFileDialog, IID_IFileDialog); + namespace file_selector_windows { // A thin wrapper for IFileDialog to allow for faking and inspection in tests. @@ -40,7 +44,7 @@ class FileDialogController { virtual HRESULT GetResults(IShellItemArray** out_items) const; private: - IFileDialog* dialog_ = nullptr; + IFileDialogPtr dialog_ = nullptr; }; // Interface for creating FileDialogControllers, to allow for dependency diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index 66a838bf7225..ddb7bfb7e639 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -3,6 +3,8 @@ // found in the LICENSE file. #include "file_selector_plugin.h" +#include +#include #include #include #include @@ -18,6 +20,11 @@ #include "file_dialog_controller.h" #include "string_utils.h" +_COM_SMARTPTR_TYPEDEF(IEnumShellItems, IID_IEnumShellItems); +_COM_SMARTPTR_TYPEDEF(IFileDialog, IID_IFileDialog); +_COM_SMARTPTR_TYPEDEF(IShellItem, IID_IShellItem); +_COM_SMARTPTR_TYPEDEF(IShellItemArray, IID_IShellItemArray); + namespace file_selector_windows { namespace { @@ -27,22 +34,22 @@ using flutter::EncodableMap; using flutter::EncodableValue; // From method_channel_file_selector.dart -const char kChannelName[] = "plugins.flutter.io/file_selector"; +constexpr char kChannelName[] = "plugins.flutter.io/file_selector"; -const char kOpenFileMethod[] = "openFile"; -const char kGetSavePathMethod[] = "getSavePath"; -const char kGetDirectoryPathMethod[] = "getDirectoryPath"; +constexpr char kOpenFileMethod[] = "openFile"; +constexpr char kGetSavePathMethod[] = "getSavePath"; +constexpr char kGetDirectoryPathMethod[] = "getDirectoryPath"; -const char kAcceptedTypeGroupsKey[] = "acceptedTypeGroups"; -const char kConfirmButtonTextKey[] = "confirmButtonText"; -const char kInitialDirectoryKey[] = "initialDirectory"; -const char kMultipleKey[] = "multiple"; -const char kSuggestedNameKey[] = "suggestedName"; +constexpr char kAcceptedTypeGroupsKey[] = "acceptedTypeGroups"; +constexpr char kConfirmButtonTextKey[] = "confirmButtonText"; +constexpr char kInitialDirectoryKey[] = "initialDirectory"; +constexpr char kMultipleKey[] = "multiple"; +constexpr char kSuggestedNameKey[] = "suggestedName"; // From x_type_group.dart // Only 'extensions' are supported by Windows for filtering. -const char kTypeGroupLabelKey[] = "label"; -const char kTypeGroupExtensionsKey[] = "extensions"; +constexpr char kTypeGroupLabelKey[] = "label"; +constexpr char kTypeGroupExtensionsKey[] = "extensions"; // Looks for |key| in |map|, returning the associated value if it is present, or // a nullptr if not. @@ -57,6 +64,9 @@ const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { // Returns the path for |shell_item| as a UTF-8 string, or an // empty string on failure. std::string GetPathForShellItem(IShellItem *shell_item) { + if (shell_item == nullptr) { + return ""; + } wchar_t *wide_path = nullptr; if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) { return ""; @@ -81,6 +91,7 @@ class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { std::unique_ptr CreateController( IFileDialog *dialog) const override { + assert(dialog != nullptr); return std::make_unique(dialog); } }; @@ -92,25 +103,23 @@ class DialogWrapper { explicit DialogWrapper(const FileDialogControllerFactory &dialog_factory, IID type) { is_open_dialog_ = type == CLSID_FileOpenDialog; - IFileDialog *dialog = nullptr; + IFileDialogPtr dialog = nullptr; last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&dialog)); dialog_controller_ = dialog_factory.CreateController(dialog); - dialog->Release(); } // Attempts to set the default folder for the dialog to |path|, // if it exists. void SetDefaultFolder(const std::string &path) { std::wstring wide_path = Utf16FromUtf8(path); - IShellItem *item; + IShellItemPtr item; last_result_ = SHCreateItemFromParsingName(wide_path.c_str(), nullptr, IID_PPV_ARGS(&item)); if (!SUCCEEDED(last_result_)) { return; } dialog_controller_->SetDefaultFolder(item); - item->Release(); } // Sets the file name that is initially shown in the dialog. @@ -188,25 +197,21 @@ class DialogWrapper { } if (is_open_dialog_) { - IShellItemArray *shell_items; + IShellItemArrayPtr shell_items; last_result_ = dialog_controller_->GetResults(&shell_items); if (!SUCCEEDED(last_result_)) { return EncodableValue(); } - IEnumShellItems *item_enumerator; + IEnumShellItemsPtr item_enumerator; last_result_ = shell_items->EnumItems(&item_enumerator); if (!SUCCEEDED(last_result_)) { - shell_items->Release(); return EncodableValue(); } EncodableList files; - IShellItem *shell_item; + IShellItemPtr shell_item; while (item_enumerator->Next(1, &shell_item, nullptr) == S_OK) { files.push_back(EncodableValue(GetPathForShellItem(shell_item))); - shell_item->Release(); } - item_enumerator->Release(); - shell_items->Release(); if (opening_directory_) { // The directory option expects a String, not a List. if (files.empty()) { @@ -217,13 +222,12 @@ class DialogWrapper { return EncodableValue(std::move(files)); } } else { - IShellItem *shell_item; + IShellItemPtr shell_item; last_result_ = dialog_controller_->GetResult(&shell_item); if (!SUCCEEDED(last_result_)) { return EncodableValue(); } EncodableValue file(GetPathForShellItem(shell_item)); - shell_item->Release(); return file; } } diff --git a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp index 46d92a9143c1..a98b686ddd6e 100644 --- a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp @@ -16,11 +16,9 @@ TestFileDialogController::TestFileDialogController(IFileDialog* dialog, MockShow mock_show) : dialog_(dialog), mock_show_(std::move(mock_show)), - FileDialogController(dialog) { - dialog_->AddRef(); -} + FileDialogController(dialog) {} -TestFileDialogController::~TestFileDialogController() { dialog_->Release(); } +TestFileDialogController::~TestFileDialogController() {} HRESULT TestFileDialogController::SetFileTypes(UINT count, COMDLG_FILTERSPEC* filters) { diff --git a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h index c63ed105fbb4..2e7292bad4b2 100644 --- a/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h @@ -4,6 +4,8 @@ #ifndef PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_FILE_DIALOG_CONTROLLER_H_ #define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_TEST_TEST_FILE_DIALOG_CONTROLLER_H_ +#include +#include #include #include @@ -14,6 +16,8 @@ #include "file_dialog_controller.h" #include "test/test_utils.h" +_COM_SMARTPTR_TYPEDEF(IFileDialog, IID_IFileDialog); + namespace file_selector_windows { namespace test { @@ -60,7 +64,7 @@ class TestFileDialogController : public FileDialogController { std::wstring GetOkButtonLabel() const; private: - IFileDialog* dialog_; + IFileDialogPtr dialog_; MockShow mock_show_; MockShowResult mock_result_; diff --git a/packages/file_selector/file_selector_windows/windows/test/test_utils.h b/packages/file_selector/file_selector_windows/windows/test/test_utils.h index 414362042b99..34106c50092f 100644 --- a/packages/file_selector/file_selector_windows/windows/test/test_utils.h +++ b/packages/file_selector/file_selector_windows/windows/test/test_utils.h @@ -27,7 +27,7 @@ namespace test { // the instance goes out of scope. // // This creates a file on the filesystem since creating IShellItem instances for -// files that don't exist is not-trivial. +// files that don't exist is non-trivial. class ScopedTestShellItem { public: ScopedTestShellItem(); @@ -52,7 +52,7 @@ class ScopedTestShellItem { // the instance goes out of scope. // // This creates a file on the filesystem since creating IShellItem instances for -// files that don't exist is not-trivial, and this is intended for use in +// files that don't exist is non-trivial, and this is intended for use in // creating IShellItemArray instances. class ScopedTestFileIdList { public: From 6de2ea54eb8eae112e8aab8080a04ca3932f2076 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 25 Jan 2022 16:10:23 -0500 Subject: [PATCH 19/22] Fix pointer aligments --- .../example/windows/runner/main.cpp | 2 +- .../windows/file_selector_plugin.cpp | 64 +++++++++---------- .../windows/file_selector_plugin.h | 4 +- .../windows/string_utils.cpp | 4 +- .../windows/string_utils.h | 4 +- 5 files changed, 39 insertions(+), 39 deletions(-) diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp index d19f025485f1..1285aabf714a 100644 --- a/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp +++ b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp @@ -9,7 +9,7 @@ #include "utils.h" int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, - _In_ wchar_t *command_line, _In_ int show_command) { + _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()) { diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index ddb7bfb7e639..675594597d83 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -53,7 +53,7 @@ constexpr char kTypeGroupExtensionsKey[] = "extensions"; // Looks for |key| in |map|, returning the associated value if it is present, or // a nullptr if not. -const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { +const EncodableValue* ValueOrNull(const EncodableMap& map, const char* key) { auto it = map.find(EncodableValue(key)); if (it == map.end()) { return nullptr; @@ -63,11 +63,11 @@ const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { // Returns the path for |shell_item| as a UTF-8 string, or an // empty string on failure. -std::string GetPathForShellItem(IShellItem *shell_item) { +std::string GetPathForShellItem(IShellItem* shell_item) { if (shell_item == nullptr) { return ""; } - wchar_t *wide_path = nullptr; + wchar_t* wide_path = nullptr; if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) { return ""; } @@ -85,12 +85,12 @@ class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { // Disallow copy and assign. DefaultFileDialogControllerFactory( - const DefaultFileDialogControllerFactory &) = delete; - DefaultFileDialogControllerFactory &operator=( - const DefaultFileDialogControllerFactory &) = delete; + const DefaultFileDialogControllerFactory&) = delete; + DefaultFileDialogControllerFactory& operator=( + const DefaultFileDialogControllerFactory&) = delete; std::unique_ptr CreateController( - IFileDialog *dialog) const override { + IFileDialog* dialog) const override { assert(dialog != nullptr); return std::make_unique(dialog); } @@ -100,7 +100,7 @@ class DefaultFileDialogControllerFactory : public FileDialogControllerFactory { // providing a simplified API for interacting with it as needed for the plugin. class DialogWrapper { public: - explicit DialogWrapper(const FileDialogControllerFactory &dialog_factory, + explicit DialogWrapper(const FileDialogControllerFactory& dialog_factory, IID type) { is_open_dialog_ = type == CLSID_FileOpenDialog; IFileDialogPtr dialog = nullptr; @@ -111,7 +111,7 @@ class DialogWrapper { // Attempts to set the default folder for the dialog to |path|, // if it exists. - void SetDefaultFolder(const std::string &path) { + void SetDefaultFolder(const std::string& path) { std::wstring wide_path = Utf16FromUtf8(path); IShellItemPtr item; last_result_ = SHCreateItemFromParsingName(wide_path.c_str(), nullptr, @@ -123,13 +123,13 @@ class DialogWrapper { } // Sets the file name that is initially shown in the dialog. - void SetFileName(const std::string &name) { + void SetFileName(const std::string& name) { std::wstring wide_name = Utf16FromUtf8(name); last_result_ = dialog_controller_->SetFileName(wide_name.c_str()); } // Sets the label of the confirmation button. - void SetOkButtonLabel(const std::string &label) { + void SetOkButtonLabel(const std::string& label) { std::wstring wide_label = Utf16FromUtf8(label); last_result_ = dialog_controller_->SetOkButtonLabel(wide_label.c_str()); } @@ -149,7 +149,7 @@ class DialogWrapper { } // Sets the filters for allowed file types to select. - void SetFileTypeFilters(const EncodableList &filters) { + void SetFileTypeFilters(const EncodableList& filters) { const std::wstring spec_delimiter = L";"; const std::wstring file_wildcard = L"*."; std::vector filter_specs; @@ -160,19 +160,19 @@ class DialogWrapper { filter_extensions.reserve(filters.size()); filter_names.reserve(filters.size()); - for (const EncodableValue &filter_info_value : filters) { - const auto &filter_info = std::get(filter_info_value); - const auto *filter_name = std::get_if( + for (const EncodableValue& filter_info_value : filters) { + const auto& filter_info = std::get(filter_info_value); + const auto* filter_name = std::get_if( ValueOrNull(filter_info, kTypeGroupLabelKey)); - const auto *extensions = std::get_if( + const auto* extensions = std::get_if( ValueOrNull(filter_info, kTypeGroupExtensionsKey)); filter_names.push_back(filter_name ? Utf16FromUtf8(*filter_name) : L""); filter_extensions.push_back(L""); - std::wstring &spec = filter_extensions.back(); + std::wstring& spec = filter_extensions.back(); if (!extensions || extensions->empty()) { spec += L"*.*"; } else { - for (const EncodableValue &extension : *extensions) { + for (const EncodableValue& extension : *extensions) { if (!spec.empty()) { spec += spec_delimiter; } @@ -249,9 +249,9 @@ class DialogWrapper { // error on failure. // // |result| is guaranteed to be resolved by this function. -void ShowDialog(const FileDialogControllerFactory &dialog_factory, - HWND parent_window, const std::string &method, - const EncodableMap &args, +void ShowDialog(const FileDialogControllerFactory& dialog_factory, + HWND parent_window, const std::string& method, + const EncodableMap& args, std::unique_ptr> result) { IID dialog_type = method.compare(kGetSavePathMethod) == 0 ? CLSID_FileSaveDialog @@ -267,7 +267,7 @@ void ShowDialog(const FileDialogControllerFactory &dialog_factory, if (method.compare(kGetDirectoryPathMethod) == 0) { dialog_options |= FOS_PICKFOLDERS; } - const auto *allow_multiple_selection = + const auto* allow_multiple_selection = std::get_if(ValueOrNull(args, kMultipleKey)); if (allow_multiple_selection && *allow_multiple_selection) { dialog_options |= FOS_ALLOWMULTISELECT; @@ -276,22 +276,22 @@ void ShowDialog(const FileDialogControllerFactory &dialog_factory, dialog.AddOptions(dialog_options); } - const auto *initial_dir = + const auto* initial_dir = std::get_if(ValueOrNull(args, kInitialDirectoryKey)); if (initial_dir) { dialog.SetDefaultFolder(*initial_dir); } - const auto *suggested_name = + const auto* suggested_name = std::get_if(ValueOrNull(args, kSuggestedNameKey)); if (suggested_name) { dialog.SetFileName(*suggested_name); } - const auto *confirm_label = + const auto* confirm_label = std::get_if(ValueOrNull(args, kConfirmButtonTextKey)); if (confirm_label) { dialog.SetOkButtonLabel(*confirm_label); } - const auto *accepted_types = + const auto* accepted_types = std::get_if(ValueOrNull(args, kAcceptedTypeGroupsKey)); if (accepted_types && !accepted_types->empty()) { dialog.SetFileTypeFilters(*accepted_types); @@ -308,7 +308,7 @@ void ShowDialog(const FileDialogControllerFactory &dialog_factory, } // Returns the top-level window that owns |view|. -HWND GetRootWindow(flutter::FlutterView *view) { +HWND GetRootWindow(flutter::FlutterView* view) { return ::GetAncestor(view->GetNativeWindow(), GA_ROOT); } @@ -316,7 +316,7 @@ HWND GetRootWindow(flutter::FlutterView *view) { // static void FileSelectorPlugin::RegisterWithRegistrar( - flutter::PluginRegistrarWindows *registrar) { + flutter::PluginRegistrarWindows* registrar) { auto channel = std::make_unique>( registrar->messenger(), "plugins.flutter.io/file_selector", &flutter::StandardMethodCodec::GetInstance()); @@ -327,7 +327,7 @@ void FileSelectorPlugin::RegisterWithRegistrar( std::make_unique()); channel->SetMethodCallHandler( - [plugin_pointer = plugin.get()](const auto &call, auto result) { + [plugin_pointer = plugin.get()](const auto& call, auto result) { plugin_pointer->HandleMethodCall(call, std::move(result)); }); @@ -343,13 +343,13 @@ FileSelectorPlugin::FileSelectorPlugin( FileSelectorPlugin::~FileSelectorPlugin() = default; void FileSelectorPlugin::HandleMethodCall( - const flutter::MethodCall<> &method_call, + const flutter::MethodCall<>& method_call, std::unique_ptr> result) { - const std::string &method_name = method_call.method_name(); + const std::string& method_name = method_call.method_name(); if (method_name.compare(kOpenFileMethod) == 0 || method_name.compare(kGetSavePathMethod) == 0 || method_name.compare(kGetDirectoryPathMethod) == 0) { - const auto *arguments = + const auto* arguments = std::get_if(method_call.arguments()); assert(arguments); ShowDialog(*controller_factory_, get_root_window_(), method_name, diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h index 9f81ae54fb48..292d312bea30 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -20,7 +20,7 @@ using FlutterRootWindowProvider = std::function; class FileSelectorPlugin : public flutter::Plugin { public: - static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows* registrar); // Creates a new plugin instance for the given registar, using the given // factory to create native dialog controllers. @@ -31,7 +31,7 @@ class FileSelectorPlugin : public flutter::Plugin { virtual ~FileSelectorPlugin(); // Called when a method is called on plugin channel; - void HandleMethodCall(const flutter::MethodCall<> &method_call, + void HandleMethodCall(const flutter::MethodCall<>& method_call, std::unique_ptr> result); private: diff --git a/packages/file_selector/file_selector_windows/windows/string_utils.cpp b/packages/file_selector/file_selector_windows/windows/string_utils.cpp index 039986b0f060..933500f34445 100644 --- a/packages/file_selector/file_selector_windows/windows/string_utils.cpp +++ b/packages/file_selector/file_selector_windows/windows/string_utils.cpp @@ -12,7 +12,7 @@ namespace file_selector_windows { // Converts the given UTF-16 string to UTF-8. -std::string Utf8FromUtf16(const std::wstring &utf16_string) { +std::string Utf8FromUtf16(const std::wstring& utf16_string) { if (utf16_string.empty()) { return std::string(); } @@ -35,7 +35,7 @@ std::string Utf8FromUtf16(const std::wstring &utf16_string) { } // Converts the given UTF-8 string to UTF-16. -std::wstring Utf16FromUtf8(const std::string &utf8_string) { +std::wstring Utf16FromUtf8(const std::string& utf8_string) { if (utf8_string.empty()) { return std::wstring(); } diff --git a/packages/file_selector/file_selector_windows/windows/string_utils.h b/packages/file_selector/file_selector_windows/windows/string_utils.h index 0634efda9041..74c7d4f93934 100644 --- a/packages/file_selector/file_selector_windows/windows/string_utils.h +++ b/packages/file_selector/file_selector_windows/windows/string_utils.h @@ -11,10 +11,10 @@ namespace file_selector_windows { // Converts the given UTF-16 string to UTF-8. -std::string Utf8FromUtf16(const std::wstring &utf16_string); +std::string Utf8FromUtf16(const std::wstring& utf16_string); // Converts the given UTF-8 string to UTF-16. -std::wstring Utf16FromUtf8(const std::string &utf8_string); +std::wstring Utf16FromUtf8(const std::string& utf8_string); } // namespace file_selector_windows From 24ba33e1a716d406e5518c06f39e17de37a3737d Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 25 Jan 2022 16:27:12 -0500 Subject: [PATCH 20/22] Fix bug in single-file example --- .../file_selector_windows/example/lib/open_image_page.dart | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart index ecbc438ac5f6..aaf083603e72 100644 --- a/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart +++ b/packages/file_selector/file_selector_windows/example/lib/open_image_page.dart @@ -16,13 +16,12 @@ class OpenImagePage extends StatelessWidget { label: 'images', extensions: ['jpg', 'png'], ); - final List files = await FileSelectorPlatform.instance - .openFiles(acceptedTypeGroups: [typeGroup]); - if (files.isEmpty) { + final XFile? file = await FileSelectorPlatform.instance + .openFile(acceptedTypeGroups: [typeGroup]); + if (file == null) { // Operation was canceled by the user. return; } - final XFile file = files[0]; final String fileName = file.name; final String filePath = file.path; From 2e9d23b738a8a09b82e8274784157bdd04cabd65 Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 25 Jan 2022 16:34:39 -0500 Subject: [PATCH 21/22] Switch to internal method channel --- .../file_selector_windows/CHANGELOG.md | 1 + .../lib/file_selector_windows.dart | 97 +++++++ .../file_selector_windows/pubspec.yaml | 4 + .../test/file_selector_windows_test.dart | 257 ++++++++++++++++++ .../windows/file_selector_plugin.cpp | 6 +- 5 files changed, 362 insertions(+), 3 deletions(-) create mode 100644 packages/file_selector/file_selector_windows/lib/file_selector_windows.dart create mode 100644 packages/file_selector/file_selector_windows/test/file_selector_windows_test.dart diff --git a/packages/file_selector/file_selector_windows/CHANGELOG.md b/packages/file_selector/file_selector_windows/CHANGELOG.md index 472db74bd7de..63999f245d82 100644 --- a/packages/file_selector/file_selector_windows/CHANGELOG.md +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -1,6 +1,7 @@ ## 0.8.2 * Moves source to flutter/plugins, and restructures to allow for unit testing. +* Switches to an internal method channel implementation. ## 0.0.2+1 diff --git a/packages/file_selector/file_selector_windows/lib/file_selector_windows.dart b/packages/file_selector/file_selector_windows/lib/file_selector_windows.dart new file mode 100644 index 000000000000..a8b159711e2a --- /dev/null +++ b/packages/file_selector/file_selector_windows/lib/file_selector_windows.dart @@ -0,0 +1,97 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:cross_file/cross_file.dart'; +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/foundation.dart' show visibleForTesting; +import 'package:flutter/services.dart'; + +const MethodChannel _channel = + MethodChannel('plugins.flutter.io/file_selector_windows'); + +/// An implementation of [FileSelectorPlatform] for Windows. +class FileSelectorWindows extends FileSelectorPlatform { + /// The MethodChannel that is being used by this implementation of the plugin. + @visibleForTesting + MethodChannel get channel => _channel; + + /// Registers the Windows implementation. + static void registerWith() { + FileSelectorPlatform.instance = FileSelectorWindows(); + } + + @override + Future openFile({ + List? acceptedTypeGroups, + String? initialDirectory, + String? confirmButtonText, + }) async { + final List? path = await _channel.invokeListMethod( + 'openFile', + { + 'acceptedTypeGroups': acceptedTypeGroups + ?.map((XTypeGroup group) => group.toJSON()) + .toList(), + 'initialDirectory': initialDirectory, + 'confirmButtonText': confirmButtonText, + 'multiple': false, + }, + ); + return path == null ? null : XFile(path.first); + } + + @override + Future> openFiles({ + List? acceptedTypeGroups, + String? initialDirectory, + String? confirmButtonText, + }) async { + final List? pathList = await _channel.invokeListMethod( + 'openFile', + { + 'acceptedTypeGroups': acceptedTypeGroups + ?.map((XTypeGroup group) => group.toJSON()) + .toList(), + 'initialDirectory': initialDirectory, + 'confirmButtonText': confirmButtonText, + 'multiple': true, + }, + ); + return pathList?.map((String path) => XFile(path)).toList() ?? []; + } + + @override + Future getSavePath({ + List? acceptedTypeGroups, + String? initialDirectory, + String? suggestedName, + String? confirmButtonText, + }) async { + return _channel.invokeMethod( + 'getSavePath', + { + 'acceptedTypeGroups': acceptedTypeGroups + ?.map((XTypeGroup group) => group.toJSON()) + .toList(), + 'initialDirectory': initialDirectory, + 'suggestedName': suggestedName, + 'confirmButtonText': confirmButtonText, + }, + ); + } + + @override + Future getDirectoryPath({ + String? initialDirectory, + String? confirmButtonText, + }) async { + return _channel.invokeMethod( + 'getDirectoryPath', + { + 'initialDirectory': initialDirectory, + 'confirmButtonText': confirmButtonText, + }, + ); + } +} diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml index 48f15bd68679..88a4f64b64f6 100644 --- a/packages/file_selector/file_selector_windows/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -13,8 +13,12 @@ flutter: implements: file_selector platforms: windows: + dartPluginClass: FileSelectorWindows pluginClass: FileSelectorWindows dependencies: + file_selector_platform_interface: ^2.0.4 flutter: sdk: flutter + flutter_test: + sdk: flutter diff --git a/packages/file_selector/file_selector_windows/test/file_selector_windows_test.dart b/packages/file_selector/file_selector_windows/test/file_selector_windows_test.dart new file mode 100644 index 000000000000..72604dd1668c --- /dev/null +++ b/packages/file_selector/file_selector_windows/test/file_selector_windows_test.dart @@ -0,0 +1,257 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:file_selector_windows/file_selector_windows.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('$FileSelectorWindows()', () { + final FileSelectorWindows plugin = FileSelectorWindows(); + + final List log = []; + + setUp(() { + plugin.channel.setMockMethodCallHandler((MethodCall methodCall) async { + log.add(methodCall); + return null; + }); + + log.clear(); + }); + + test('registered instance', () { + FileSelectorWindows.registerWith(); + expect(FileSelectorPlatform.instance, isA()); + }); + + group('#openFile', () { + test('passes the accepted type groups correctly', () async { + final XTypeGroup group = XTypeGroup( + label: 'text', + extensions: ['txt'], + mimeTypes: ['text/plain'], + macUTIs: ['public.text'], + ); + + final XTypeGroup groupTwo = XTypeGroup( + label: 'image', + extensions: ['jpg'], + mimeTypes: ['image/jpg'], + macUTIs: ['public.image'], + webWildCards: ['image/*']); + + await plugin + .openFile(acceptedTypeGroups: [group, groupTwo]); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': >[ + group.toJSON(), + groupTwo.toJSON() + ], + 'initialDirectory': null, + 'confirmButtonText': null, + 'multiple': false, + }), + ], + ); + }); + test('passes initialDirectory correctly', () async { + await plugin.openFile(initialDirectory: '/example/directory'); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': '/example/directory', + 'confirmButtonText': null, + 'multiple': false, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.openFile(confirmButtonText: 'Open File'); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': null, + 'confirmButtonText': 'Open File', + 'multiple': false, + }), + ], + ); + }); + }); + group('#openFiles', () { + test('passes the accepted type groups correctly', () async { + final XTypeGroup group = XTypeGroup( + label: 'text', + extensions: ['txt'], + mimeTypes: ['text/plain'], + macUTIs: ['public.text'], + ); + + final XTypeGroup groupTwo = XTypeGroup( + label: 'image', + extensions: ['jpg'], + mimeTypes: ['image/jpg'], + macUTIs: ['public.image'], + webWildCards: ['image/*']); + + await plugin + .openFiles(acceptedTypeGroups: [group, groupTwo]); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': >[ + group.toJSON(), + groupTwo.toJSON() + ], + 'initialDirectory': null, + 'confirmButtonText': null, + 'multiple': true, + }), + ], + ); + }); + test('passes initialDirectory correctly', () async { + await plugin.openFiles(initialDirectory: '/example/directory'); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': '/example/directory', + 'confirmButtonText': null, + 'multiple': true, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.openFiles(confirmButtonText: 'Open File'); + + expect( + log, + [ + isMethodCall('openFile', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': null, + 'confirmButtonText': 'Open File', + 'multiple': true, + }), + ], + ); + }); + }); + + group('#getSavePath', () { + test('passes the accepted type groups correctly', () async { + final XTypeGroup group = XTypeGroup( + label: 'text', + extensions: ['txt'], + mimeTypes: ['text/plain'], + macUTIs: ['public.text'], + ); + + final XTypeGroup groupTwo = XTypeGroup( + label: 'image', + extensions: ['jpg'], + mimeTypes: ['image/jpg'], + macUTIs: ['public.image'], + webWildCards: ['image/*']); + + await plugin + .getSavePath(acceptedTypeGroups: [group, groupTwo]); + + expect( + log, + [ + isMethodCall('getSavePath', arguments: { + 'acceptedTypeGroups': >[ + group.toJSON(), + groupTwo.toJSON() + ], + 'initialDirectory': null, + 'suggestedName': null, + 'confirmButtonText': null, + }), + ], + ); + }); + test('passes initialDirectory correctly', () async { + await plugin.getSavePath(initialDirectory: '/example/directory'); + + expect( + log, + [ + isMethodCall('getSavePath', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': '/example/directory', + 'suggestedName': null, + 'confirmButtonText': null, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.getSavePath(confirmButtonText: 'Open File'); + + expect( + log, + [ + isMethodCall('getSavePath', arguments: { + 'acceptedTypeGroups': null, + 'initialDirectory': null, + 'suggestedName': null, + 'confirmButtonText': 'Open File', + }), + ], + ); + }); + group('#getDirectoryPath', () { + test('passes initialDirectory correctly', () async { + await plugin.getDirectoryPath(initialDirectory: '/example/directory'); + + expect( + log, + [ + isMethodCall('getDirectoryPath', arguments: { + 'initialDirectory': '/example/directory', + 'confirmButtonText': null, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.getDirectoryPath(confirmButtonText: 'Open File'); + + expect( + log, + [ + isMethodCall('getDirectoryPath', arguments: { + 'initialDirectory': null, + 'confirmButtonText': 'Open File', + }), + ], + ); + }); + }); + }); + }); +} diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp index 675594597d83..870bc281b6f6 100644 --- a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -33,8 +33,8 @@ using flutter::EncodableList; using flutter::EncodableMap; using flutter::EncodableValue; -// From method_channel_file_selector.dart -constexpr char kChannelName[] = "plugins.flutter.io/file_selector"; +// From file_selector_windows.dart +constexpr char kChannelName[] = "plugins.flutter.io/file_selector_windows"; constexpr char kOpenFileMethod[] = "openFile"; constexpr char kGetSavePathMethod[] = "getSavePath"; @@ -318,7 +318,7 @@ HWND GetRootWindow(flutter::FlutterView* view) { void FileSelectorPlugin::RegisterWithRegistrar( flutter::PluginRegistrarWindows* registrar) { auto channel = std::make_unique>( - registrar->messenger(), "plugins.flutter.io/file_selector", + registrar->messenger(), kChannelName, &flutter::StandardMethodCodec::GetInstance()); std::unique_ptr plugin = From 8f17b22c8dc36709affbaa87baee0e5fb0a5716e Mon Sep 17 00:00:00 2001 From: Stuart Morgan Date: Tue, 25 Jan 2022 20:40:17 -0500 Subject: [PATCH 22/22] Add cross_file to deps --- packages/file_selector/file_selector_windows/pubspec.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/file_selector/file_selector_windows/pubspec.yaml b/packages/file_selector/file_selector_windows/pubspec.yaml index 88a4f64b64f6..7b035e974293 100644 --- a/packages/file_selector/file_selector_windows/pubspec.yaml +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -17,6 +17,7 @@ flutter: pluginClass: FileSelectorWindows dependencies: + cross_file: ^0.3.1 file_selector_platform_interface: ^2.0.4 flutter: sdk: flutter