diff --git a/.ci/scripts/drive_examples_win32.sh b/.ci/scripts/drive_examples_win32.sh index 67f4fde5a70a..c3e2e7bc5447 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 --log-timing + --exclude=script/configs/exclude_integration_win32.yaml --packages-for-branch --log-timing 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/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. 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..63999f245d82 --- /dev/null +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -0,0 +1,16 @@ +## 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 + +* 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..c6823b81eb84 --- /dev/null +++ b/packages/file_selector/file_selector_windows/LICENSE @@ -0,0 +1,25 @@ +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: + + * 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/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/lib/get_directory_page.dart b/packages/file_selector/file_selector_windows/example/lib/get_directory_page.dart new file mode 100644 index 000000000000..b282b9030d67 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/get_directory_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 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; +import 'package:flutter/material.dart'; + +/// 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'; + 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 { + /// Creates a `TextDisplay`. + const TextDisplay(this.directoryPath); + + /// The path selected in the dialog. + 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..958680be0e3b --- /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..a49ebac1aea5 --- /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..aaf083603e72 --- /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 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( + label: 'images', + extensions: ['jpg', 'png'], + ); + 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 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 an image in a dialog. +class ImageDisplay extends StatelessWidget { + /// Default Constructor. + const ImageDisplay(this.fileName, this.filePath); + + /// The name of the selected file. + final String fileName; + + /// The path to the selected file. + 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..a030b8b4b10b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/open_multiple_images_page.dart @@ -0,0 +1,99 @@ +// 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 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( + 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..fa281a0020d5 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/open_text_page.dart @@ -0,0 +1,84 @@ +// 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 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( + 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); + + /// The name of the selected file. + final String fileName; + + /// The contents of the text file. + 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..b87a51c3877d --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/save_text_page.dart @@ -0,0 +1,78 @@ +// 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'; + +/// 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(); + + 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..b66a2023deb2 --- /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_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 + # 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: .. + 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..57d4c0c59d30 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -0,0 +1,100 @@ +cmake_minimum_required(VERSION 3.14) +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") + +# 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. +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..b2e4bd8d658b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,103 @@ +cmake_minimum_required(VERSION 3.14) + +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_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..de2d8916b72b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt @@ -0,0 +1,17 @@ +cmake_minimum_required(VERSION 3.14) +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..217bf9b69e67 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp @@ -0,0 +1,64 @@ +// 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 + +#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..7cbf3d3ebbb2 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h @@ -0,0 +1,36 @@ +// 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_ + +#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..1285aabf714a --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/main.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 +#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..d5d958dc4257 --- /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 000000000000..c04e20caf637 Binary files /dev/null and b/packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico differ 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..8b8eaa54539a --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp @@ -0,0 +1,66 @@ +// 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 +#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..6d1cc48f0426 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.h @@ -0,0 +1,22 @@ +// 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_ + +#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..34738de2d35b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp @@ -0,0 +1,240 @@ +// 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 + +#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..0f8bd1b7f920 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h @@ -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. +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates and shows a win32 window with |title| and position and size using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size to will treat the width height passed in to this function + // as logical pixels and scale to appropriate for the default monitor. Returns + // true if the window was created successfully. + bool CreateAndShow(const std::wstring& title, const Point& origin, + const Size& size); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responsponds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/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 new file mode 100644 index 000000000000..7b035e974293 --- /dev/null +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -0,0 +1,25 @@ +name: file_selector_windows +description: Windows implementation of the file_selector plugin. +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: ">=2.5.0" + +flutter: + plugin: + implements: file_selector + platforms: + windows: + dartPluginClass: FileSelectorWindows + pluginClass: FileSelectorWindows + +dependencies: + cross_file: ^0.3.1 + 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/.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..01c9f58b98a2 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -0,0 +1,78 @@ +cmake_minimum_required(VERSION 3.14) +set(PROJECT_NAME "file_selector_windows") +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" + "string_utils.cpp" + "string_utils.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) +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 +) + + +# === 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 + 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 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_dialog_controller.cpp b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp new file mode 100644 index 000000000000..e4b1a2afcdde --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.cpp @@ -0,0 +1,66 @@ +// 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_dialog_controller.h" + +#include +#include +#include + +_COM_SMARTPTR_TYPEDEF(IFileOpenDialog, IID_IFileOpenDialog); + +namespace file_selector_windows { + +FileDialogController::FileDialogController(IFileDialog* dialog) + : dialog_(dialog) {} + +FileDialogController::~FileDialogController() {} + +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) const { + 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) const { + return dialog_->GetResult(out_item); +} + +HRESULT FileDialogController::GetResults(IShellItemArray** out_items) const { + IFileOpenDialogPtr open_dialog; + HRESULT result = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); + if (!SUCCEEDED(result)) { + return result; + } + result = open_dialog->GetResults(out_items); + 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..e7357338243e --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_dialog_controller.h @@ -0,0 +1,62 @@ +// 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_ +#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. +// +// 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) const; + virtual HRESULT SetOptions(FILEOPENDIALOGOPTIONS options); + virtual HRESULT Show(HWND parent); + 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) const; + + private: + IFileDialogPtr dialog_ = nullptr; +}; + +// Interface for creating FileDialogControllers, to allow for dependency +// injection. +class FileDialogControllerFactory { + public: + virtual ~FileDialogControllerFactory(); + + virtual std::unique_ptr CreateController( + IFileDialog* dialog) const = 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 new file mode 100644 index 000000000000..870bc281b6f6 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -0,0 +1,362 @@ +// 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 +#include +#include +#include + +#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 { + +using flutter::EncodableList; +using flutter::EncodableMap; +using flutter::EncodableValue; + +// From file_selector_windows.dart +constexpr char kChannelName[] = "plugins.flutter.io/file_selector_windows"; + +constexpr char kOpenFileMethod[] = "openFile"; +constexpr char kGetSavePathMethod[] = "getSavePath"; +constexpr char kGetDirectoryPathMethod[] = "getDirectoryPath"; + +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. +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. +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) { + if (shell_item == nullptr) { + return ""; + } + 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; +} + +// 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) const override { + assert(dialog != nullptr); + 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(const FileDialogControllerFactory& dialog_factory, + IID type) { + is_open_dialog_ = type == CLSID_FileOpenDialog; + IFileDialogPtr dialog = nullptr; + last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&dialog)); + dialog_controller_ = dialog_factory.CreateController(dialog); + } + + // 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); + IShellItemPtr item; + last_result_ = SHCreateItemFromParsingName(wide_path.c_str(), nullptr, + IID_PPV_ARGS(&item)); + if (!SUCCEEDED(last_result_)) { + return; + } + dialog_controller_->SetDefaultFolder(item); + } + + // 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_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_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_controller_->GetOptions(&options); + if (!SUCCEEDED(last_result_)) { + return; + } + options |= new_options; + if (options & FOS_PICKFOLDERS) { + opening_directory_ = true; + } + last_result_ = dialog_controller_->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_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_controller_); + last_result_ = dialog_controller_->Show(parent_window); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + + if (is_open_dialog_) { + IShellItemArrayPtr shell_items; + last_result_ = dialog_controller_->GetResults(&shell_items); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + IEnumShellItemsPtr item_enumerator; + last_result_ = shell_items->EnumItems(&item_enumerator); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + EncodableList files; + IShellItemPtr shell_item; + while (item_enumerator->Next(1, &shell_item, nullptr) == S_OK) { + files.push_back(EncodableValue(GetPathForShellItem(shell_item))); + } + 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 { + IShellItemPtr shell_item; + last_result_ = dialog_controller_->GetResult(&shell_item); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + EncodableValue file(GetPathForShellItem(shell_item)); + return file; + } + } + + // Returns the result of the last Win32 API call related to this object. + HRESULT last_result() { return last_result_; } + + private: + // The dialog controller that all interactions are mediated through, to allow + // for unit testing. + std::unique_ptr dialog_controller_; + 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(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_factory, 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); +} + +} // namespace + +// static +void FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows* registrar) { + auto channel = std::make_unique>( + registrar->messenger(), kChannelName, + &flutter::StandardMethodCodec::GetInstance()); + + 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) { + plugin_pointer->HandleMethodCall(call, std::move(result)); + }); + + registrar->AddPlugin(std::move(plugin)); +} + +FileSelectorPlugin::FileSelectorPlugin( + 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; + +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(*controller_factory_, get_root_window_(), method_name, + *arguments, std::move(result)); + } else { + result->NotImplemented(); + } +} + +} // 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..292d312bea30 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.h @@ -0,0 +1,47 @@ +// 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_ +#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); + + // 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(); + + // 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_; + + // 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/file_selector_windows.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp new file mode 100644 index 000000000000..e4d2c15fd89b --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_windows.cpp @@ -0,0 +1,15 @@ +// 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" + +#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_windows.h b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h new file mode 100644 index 000000000000..7ee6ed3d29ff --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_windows.h @@ -0,0 +1,26 @@ +// 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_ +#define PACKAGES_FILE_SELECTOR_FILE_SELECTOR_WINDOWS_WINDOWS_INCLUDE_FILE_SELECTOR_WINDOWS_FILE_SELECTOR_WINDOWS_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 FileSelectorWindowsRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +#endif // 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..933500f34445 --- /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..74c7d4f93934 --- /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 new file mode 100644 index 000000000000..20e1bba2794f --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/file_selector_plugin_test.cpp @@ -0,0 +1,471 @@ +// 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 +#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; + +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, 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)); + 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_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_NE(options & FOS_PICKFOLDERS, 0U); + + return MockShowResult(fake_result_array); + }; + 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( + [fake_window] { return fake_window; }, + std::make_unique(show_validator)); + plugin.HandleMethodCall( + MethodCall("getDirectoryPath", + std::make_unique(EncodableMap())), + std::move(result)); + + EXPECT_TRUE(shown); +} + +} // namespace test +} // namespace file_selector_windows 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..a98b686ddd6e --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.cpp @@ -0,0 +1,106 @@ +// 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) {} + +TestFileDialogController::~TestFileDialogController() {} + +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..2e7292bad4b2 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/test/test_file_dialog_controller.h @@ -0,0 +1,101 @@ +// 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 +#include + +#include "file_dialog_controller.h" +#include "test/test_utils.h" + +_COM_SMARTPTR_TYPEDEF(IFileDialog, IID_IFileDialog); + +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: + IFileDialogPtr 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..34106c50092f --- /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 non-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 non-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_ 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