diff --git a/packages/file_selector/file_selector_windows/.gitignore b/packages/file_selector/file_selector_windows/.gitignore new file mode 100644 index 000000000000..53e92cc4181f --- /dev/null +++ b/packages/file_selector/file_selector_windows/.gitignore @@ -0,0 +1,3 @@ +.packages +.flutter-plugins +pubspec.lock diff --git a/packages/file_selector/file_selector_windows/.metadata b/packages/file_selector/file_selector_windows/.metadata new file mode 100644 index 000000000000..720a4596c087 --- /dev/null +++ b/packages/file_selector/file_selector_windows/.metadata @@ -0,0 +1,10 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: 6d1c244b79f3a2747281f718297ce248bd5ad099 + channel: master + +project_type: plugin diff --git a/packages/file_selector/file_selector_windows/CHANGELOG.md b/packages/file_selector/file_selector_windows/CHANGELOG.md new file mode 100644 index 000000000000..6e35c1744919 --- /dev/null +++ b/packages/file_selector/file_selector_windows/CHANGELOG.md @@ -0,0 +1,3 @@ +## 0.0.1 + +* Initial Windows implementation of `file_selector`. diff --git a/packages/file_selector/file_selector_windows/LICENSE b/packages/file_selector/file_selector_windows/LICENSE new file mode 100644 index 000000000000..67c7e2c52e46 --- /dev/null +++ b/packages/file_selector/file_selector_windows/LICENSE @@ -0,0 +1,25 @@ +Copyright 2020 The Flutter Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + * Neither the name of Google Inc. nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/packages/file_selector/file_selector_windows/README.md b/packages/file_selector/file_selector_windows/README.md new file mode 100644 index 000000000000..776b836eee58 --- /dev/null +++ b/packages/file_selector/file_selector_windows/README.md @@ -0,0 +1,42 @@ +# file_selector_windows + +The Windows implementation of [`file_selector`][1]. + +## Backward compatible 1.0.0 version is coming +The plugin has reached a stable API, we guarantee that version `1.0.0` will be backward compatible with `0.0.y+z`. If you use +file_selector_windows directly, rather than as an implementation detail +of `file_selector`, please use `file_selector_windows: '>=0.0.y+x <2.0.0'` +as your dependency constraint to allow a smoother ecosystem migration. +For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 + +## Usage + +### Import the package + +This package has not yet been endorsed, meaning that you need to add `file_selector_windows` +as a dependency in your `pubspec.yaml`. It will be not yet be automatically included in your app +when you depend on `package:file_selector`. + +This is what the above means to your `pubspec.yaml`: + +```yaml +... +dependencies: + ... + file_selector: ^0.7.0 + file_selector_windows: ^0.0.1 + ... +``` + +If you wish to use the Windows package only, you can add `file_selector_windows` as a +dependency: + +```yaml +... +dependencies: + ... + file_selector_windows: ^0.0.1 + ... +``` + +[1]: ../file_selector/file_selector 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..9d532b18a01f --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/.gitignore @@ -0,0 +1,41 @@ +# 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 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..82cce8b18642 --- /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: 6d1c244b79f3a2747281f718297ce248bd5ad099 + channel: master + +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..689d7225e04b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/README.md @@ -0,0 +1,3 @@ +# file_selector_windows_example + +Demonstrates the file_selector_windows plugin. 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..a3f069fb364b --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/lib/main.dart @@ -0,0 +1,175 @@ +// Copyright 2017 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// ignore_for_file: public_member_api_docs + +import 'dart:async'; +import 'package:flutter/material.dart'; +import 'package:file_selector_platform_interface/file_selector_platform_interface.dart'; + +void main() { + runApp(MyApp()); +} + +class MyApp extends StatelessWidget { + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'File Selector', + theme: ThemeData( + primarySwatch: Colors.blue, + ), + home: MyHomePage(title: 'File Selector'), + ); + } +} + +class MyHomePage extends StatefulWidget { + MyHomePage({Key key, this.title}) : super(key: key); + final String title; + + @override + _MyHomePageState createState() => _MyHomePageState(); +} + +class _MyHomePageState extends State { + Future _selectorResult; + + Widget _showResult(BuildContext context, AsyncSnapshot snapshot) { + if (snapshot.hasError) { + return Text('Error: ${snapshot.error}'); + } else { + String text; + if (!snapshot.hasData) { + return Text(''); + } else if (snapshot.data is String) { + text = snapshot.data; + } else if (snapshot.data is XFile) { + text = (snapshot.data as XFile).path; + } else if (snapshot.data is List) { + text = (snapshot.data as List).map((e) => e.path).join(', '); + } else { + text = 'Unexpected return type: ${snapshot.data}'; + } + return Text(text); + } + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(widget.title), + ), + body: ListView( + children: [ + Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + ButtonBar( + alignment: MainAxisAlignment.center, + children: [ + RaisedButton( + child: Padding( + padding: const EdgeInsets.all(8.0), + child: const Text('SAVE'), + ), + onPressed: () { + setState(() { + _selectorResult = + FileSelectorPlatform.instance.getSavePath( + suggestedName: 'a_file.txt', + initialDirectory: r'C:\Users', + confirmButtonText: 'Save It', + ); + }); + }, + ), + RaisedButton( + child: Padding( + padding: const EdgeInsets.all(8.0), + child: const Text('OPEN MULTIPLE'), + ), + onPressed: () { + setState(() { + _selectorResult = + FileSelectorPlatform.instance.openFiles( + initialDirectory: r'C:\', + confirmButtonText: 'Open All', + acceptedTypeGroups: [ + XTypeGroup(label: 'Any'), + XTypeGroup( + label: 'Text', + extensions: [ + 'txt', + 'rtf', + ], + ), + ], + ); + }); + }, + ), + RaisedButton( + child: Padding( + padding: const EdgeInsets.all(8.0), + child: const Text('OPEN SINGLE MEDIA'), + ), + onPressed: () { + setState(() { + _selectorResult = + FileSelectorPlatform.instance.openFile( + acceptedTypeGroups: [ + XTypeGroup( + label: 'Images', + extensions: [ + 'bmp', + 'gif', + 'jpeg', + 'jpg', + 'png', + 'tiff', + 'webp', + ], + ), + XTypeGroup( + label: 'Video', + extensions: [ + 'webm', + 'mpg', + 'mpeg', + 'mov', + ], + ), + ], + ); + }); + }, + ), + RaisedButton( + child: Padding( + padding: const EdgeInsets.all(8.0), + child: const Text('OPEN DIRECTORY'), + ), + onPressed: () { + setState(() { + _selectorResult = + FileSelectorPlatform.instance.getDirectoryPath( + initialDirectory: r'C:\Users', + confirmButtonText: 'Open Directory', + ); + }); + }, + ), + ], + ), + FutureBuilder( + future: _selectorResult, builder: _showResult), + ], + ), + ], + ), + ); + } +} 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..cf35b278d432 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/pubspec.yaml @@ -0,0 +1,17 @@ +name: file_selector_example +description: Demonstrates the Windows implementation of the file_selector plugin. + +dependencies: + flutter: + sdk: flutter + file_selector_platform_interface: any + file_selector_windows: + path: ../ + +dev_dependencies: + flutter_driver: + sdk: flutter + pedantic: ^1.8.0 + +flutter: + uses-material-design: true diff --git a/packages/file_selector/file_selector_windows/example/windows/.gitignore b/packages/file_selector/file_selector_windows/example/windows/.gitignore new file mode 100644 index 000000000000..d492d0d98c8f --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt new file mode 100644 index 000000000000..abf90408efb4 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/CMakeLists.txt @@ -0,0 +1,95 @@ +cmake_minimum_required(VERSION 3.15) +project(example LANGUAGES CXX) + +set(BINARY_NAME "example") + +cmake_policy(SET CMP0063 NEW) + +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Configure build options. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() + +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") + +# Flutter library and tool build rules. +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build +add_subdirectory("runner") + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000000..c7a8c7607d81 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,101 @@ +cmake_minimum_required(VERSION 3.15) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" +) +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 $ +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.cc b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 000000000000..0cb14e795a59 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,12 @@ +// +// Generated file. Do not edit. +// + +#include "generated_plugin_registrant.h" + +#include + +void RegisterPlugins(flutter::PluginRegistry* registry) { + FileSelectorPluginRegisterWithRegistrar( + registry->GetRegistrarForPlugin("FileSelectorPlugin")); +} diff --git a/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 000000000000..9846246b4dac --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,13 @@ +// +// Generated file. Do not edit. +// + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/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..977e38b5d1d2 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/CMakeLists.txt @@ -0,0 +1,18 @@ +cmake_minimum_required(VERSION 3.15) +project(runner LANGUAGES CXX) + +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "run_loop.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) +apply_standard_settings(${BINARY_NAME}) +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/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..944329afc03a --- /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) 2020 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..c422723045ca --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.cpp @@ -0,0 +1,64 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(RunLoop* run_loop, + const flutter::DartProject& project) + : run_loop_(run_loop), project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + run_loop_->RegisterFlutterInstance(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + run_loop_->UnregisterFlutterInstance(flutter_controller_->engine()); + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opporutunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/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..b663ddd50125 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/flutter_window.h @@ -0,0 +1,39 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "run_loop.h" +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow driven by the |run_loop|, hosting a + // Flutter view running |project|. + explicit FlutterWindow(RunLoop* run_loop, + const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The run loop driving events for this window. + RunLoop* run_loop_; + + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/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..fc17fec6140c --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/main.cpp @@ -0,0 +1,36 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "run_loop.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + RunLoop run_loop; + + flutter::DartProject project(L"data"); + FlutterWindow window(&run_loop, project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.CreateAndShow(L"example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + run_loop.Run(); + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/resource.h b/packages/file_selector/file_selector_windows/example/windows/runner/resource.h new file mode 100644 index 000000000000..66a65d1e4a79 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico b/packages/file_selector/file_selector_windows/example/windows/runner/resources/app_icon.ico new file mode 100644 index 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/run_loop.cpp b/packages/file_selector/file_selector_windows/example/windows/runner/run_loop.cpp new file mode 100644 index 000000000000..2d6636ab6bc6 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/run_loop.cpp @@ -0,0 +1,66 @@ +#include "run_loop.h" + +#include + +#include + +RunLoop::RunLoop() {} + +RunLoop::~RunLoop() {} + +void RunLoop::Run() { + bool keep_running = true; + TimePoint next_flutter_event_time = TimePoint::clock::now(); + while (keep_running) { + std::chrono::nanoseconds wait_duration = + std::max(std::chrono::nanoseconds(0), + next_flutter_event_time - TimePoint::clock::now()); + ::MsgWaitForMultipleObjects( + 0, nullptr, FALSE, static_cast(wait_duration.count() / 1000), + QS_ALLINPUT); + bool processed_events = false; + MSG message; + // All pending Windows messages must be processed; MsgWaitForMultipleObjects + // won't return again for items left in the queue after PeekMessage. + while (::PeekMessage(&message, nullptr, 0, 0, PM_REMOVE)) { + processed_events = true; + if (message.message == WM_QUIT) { + keep_running = false; + break; + } + ::TranslateMessage(&message); + ::DispatchMessage(&message); + // Allow Flutter to process messages each time a Windows message is + // processed, to prevent starvation. + next_flutter_event_time = + std::min(next_flutter_event_time, ProcessFlutterMessages()); + } + // If the PeekMessage loop didn't run, process Flutter messages. + if (!processed_events) { + next_flutter_event_time = + std::min(next_flutter_event_time, ProcessFlutterMessages()); + } + } +} + +void RunLoop::RegisterFlutterInstance( + flutter::FlutterEngine* flutter_instance) { + flutter_instances_.insert(flutter_instance); +} + +void RunLoop::UnregisterFlutterInstance( + flutter::FlutterEngine* flutter_instance) { + flutter_instances_.erase(flutter_instance); +} + +RunLoop::TimePoint RunLoop::ProcessFlutterMessages() { + TimePoint next_event_time = TimePoint::max(); + for (auto instance : flutter_instances_) { + std::chrono::nanoseconds wait_duration = instance->ProcessMessages(); + if (wait_duration != std::chrono::nanoseconds::max()) { + next_event_time = + std::min(next_event_time, TimePoint::clock::now() + wait_duration); + } + } + return next_event_time; +} diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/run_loop.h b/packages/file_selector/file_selector_windows/example/windows/runner/run_loop.h new file mode 100644 index 000000000000..000d3624638e --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/run_loop.h @@ -0,0 +1,40 @@ +#ifndef RUNNER_RUN_LOOP_H_ +#define RUNNER_RUN_LOOP_H_ + +#include + +#include +#include + +// A runloop that will service events for Flutter instances as well +// as native messages. +class RunLoop { + public: + RunLoop(); + ~RunLoop(); + + // Prevent copying + RunLoop(RunLoop const&) = delete; + RunLoop& operator=(RunLoop const&) = delete; + + // Runs the run loop until the application quits. + void Run(); + + // Registers the given Flutter instance for event servicing. + void RegisterFlutterInstance( + flutter::FlutterEngine* flutter_instance); + + // Unregisters the given Flutter instance from event servicing. + void UnregisterFlutterInstance( + flutter::FlutterEngine* flutter_instance); + + private: + using TimePoint = std::chrono::steady_clock::time_point; + + // Processes all currently pending messages for registered Flutter instances. + TimePoint ProcessFlutterMessages(); + + std::set flutter_instances_; +}; + +#endif // RUNNER_RUN_LOOP_H_ diff --git a/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..37501e5db777 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.cpp @@ -0,0 +1,22 @@ +#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(); + } +} 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..d792603bb139 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/utils.h @@ -0,0 +1,8 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +#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..efc3eb9f2263 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.cpp @@ -0,0 +1,244 @@ +#include "win32_window.h" + +#include + +#include "resource.h" + +namespace { + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + FreeLibrary(user32_module); + } +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + return OnCreate(); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} diff --git a/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h new file mode 100644 index 000000000000..17ba431125b4 --- /dev/null +++ b/packages/file_selector/file_selector_windows/example/windows/runner/win32_window.h @@ -0,0 +1,98 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates and shows a win32 window with |title| and position and size using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size to will treat the width height passed in to this function + // as logical pixels and scale to appropriate for the default monitor. Returns + // true if the window was created successfully. + bool CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responsponds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ 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..6f8c754c5ed8 --- /dev/null +++ b/packages/file_selector/file_selector_windows/pubspec.yaml @@ -0,0 +1,21 @@ +name: file_selector_windows +description: Windows implementation of the file_selector plugin. +# 0.0.y+z is compatible with 1.0.0, if you land a breaking change bump +# the version to 2.0.0. +# See more details: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0 +version: 0.0.1 +homepage: https://github.com/flutter/plugins/tree/master/packages/file_selector/file_selector_windows + +flutter: + plugin: + platforms: + windows: + pluginClass: FileSelectorPlugin + +environment: + sdk: ">=2.1.0 <3.0.0" + flutter: ">=1.12.8 <2.0.0" + +dependencies: + flutter: + sdk: flutter diff --git a/packages/file_selector/file_selector_windows/windows/.gitignore b/packages/file_selector/file_selector_windows/windows/.gitignore new file mode 100644 index 000000000000..b3eb2be169a5 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/packages/file_selector/file_selector_windows/windows/CMakeLists.txt b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt new file mode 100644 index 000000000000..b8646d514710 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.10) +set(PROJECT_NAME "file_selector_windows") +project(${PROJECT_NAME} LANGUAGES CXX) + +set(PLUGIN_NAME "${PROJECT_NAME}_plugin") + +add_library(${PLUGIN_NAME} SHARED + "file_selector_plugin.cpp" +) +apply_standard_settings(${PLUGIN_NAME}) +set_target_properties(${PLUGIN_NAME} PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_compile_definitions(${PLUGIN_NAME} PRIVATE FLUTTER_PLUGIN_IMPL) +target_include_directories(${PLUGIN_NAME} INTERFACE + "${CMAKE_CURRENT_SOURCE_DIR}/include") +target_link_libraries(${PLUGIN_NAME} PRIVATE flutter flutter_wrapper_plugin) + +# List of absolute paths to libraries that should be bundled with the plugin +set(file_chooser_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp new file mode 100644 index 000000000000..b7627a8281b8 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/file_selector_plugin.cpp @@ -0,0 +1,403 @@ +// Copyright 2020 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#include "include/file_selector_windows/file_selector_plugin.h" + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +namespace { + +using flutter::EncodableList; +using flutter::EncodableMap; +using flutter::EncodableValue; + +// From method_channel_file_selector.dart +const char kChannelName[] = "plugins.flutter.io/file_selector"; + +const char kOpenFileMethod[] = "openFile"; +const char kGetSavePathMethod[] = "getSavePath"; +const char kGetDirectoryPathMethod[] = "getDirectoryPath"; + +const char kAcceptedTypeGroupsKey[] = "acceptedTypeGroups"; +const char kConfirmButtonTextKey[] = "confirmButtonText"; +const char kInitialDirectoryKey[] = "initialDirectory"; +const char kMultipleKey[] = "multiple"; +const char kSuggestedNameKey[] = "suggestedName"; + +// From x_type_group.dart +// Only 'extensions' are supported by Windows for filtering. +const char kTypeGroupLabelKey[] = "label"; +const char kTypeGroupExtensionsKey[] = "extensions"; + +// Converts the given UTF-16 string to UTF-8. +std::string Utf8FromUtf16(const std::wstring &utf16_string) { + if (utf16_string.empty()) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string.data(), + static_cast(utf16_string.length()), nullptr, 0, nullptr, nullptr); + if (target_length == 0) { + return std::string(); + } + std::string utf8_string; + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string.data(), + static_cast(utf16_string.length()), utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} + +// Converts the given UTF-8 string to UTF-16. +std::wstring Utf16FromUtf8(const std::string &utf8_string) { + if (utf8_string.empty()) { + return std::wstring(); + } + int target_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), nullptr, 0); + if (target_length == 0) { + return std::wstring(); + } + std::wstring utf16_string; + utf16_string.resize(target_length); + int converted_length = + ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8_string.data(), + static_cast(utf8_string.length()), + utf16_string.data(), target_length); + if (converted_length == 0) { + return std::wstring(); + } + return utf16_string; +} + +// Looks for |key| in |map|, returning the associated value if it is present, or +// a nullptr if not. +const EncodableValue *ValueOrNull(const EncodableMap &map, const char *key) { + auto it = map.find(EncodableValue(key)); + if (it == map.end()) { + return nullptr; + } + return &(it->second); +} + +// Returns the path for |shell_item| as a UTF-8 string, or an +// empty string on failure. +std::string GetPathForShellItem(IShellItem *shell_item) { + wchar_t *wide_path = nullptr; + if (!SUCCEEDED(shell_item->GetDisplayName(SIGDN_FILESYSPATH, &wide_path))) { + return ""; + } + std::string path = Utf8FromUtf16(wide_path); + CoTaskMemFree(wide_path); + return path; +} + +// Wraps an IFileDialog, managing object lifetime as a scoped object and +// providing a simplified API for interacting with it as needed for the plugin. +class DialogWrapper { + public: + explicit DialogWrapper(IID type) { + is_open_dialog_ = type == CLSID_FileOpenDialog; + last_result_ = CoCreateInstance(type, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&dialog_)); + } + + ~DialogWrapper() { + if (dialog_) { + dialog_->Release(); + } + } + + // Attempts to set the default folder for the dialog to |path|, + // if it exists. + void SetDefaultFolder(const std::string &path) { + std::wstring wide_path = Utf16FromUtf8(path); + IShellItem *item; + last_result_ = SHCreateItemFromParsingName(wide_path.c_str(), nullptr, + IID_PPV_ARGS(&item)); + if (!SUCCEEDED(last_result_)) { + return; + } + dialog_->SetDefaultFolder(item); + item->Release(); + } + + // Sets the file name that is initially shown in the dialog. + void SetFileName(const std::string &name) { + std::wstring wide_name = Utf16FromUtf8(name); + last_result_ = dialog_->SetFileName(wide_name.c_str()); + } + + // Sets the label of the confirmation button. + void SetOkButtonLabel(const std::string &label) { + std::wstring wide_label = Utf16FromUtf8(label); + last_result_ = dialog_->SetOkButtonLabel(wide_label.c_str()); + } + + // Adds the given options to the dialog's current option set. + void AddOptions(FILEOPENDIALOGOPTIONS new_options) { + FILEOPENDIALOGOPTIONS options; + last_result_ = dialog_->GetOptions(&options); + if (!SUCCEEDED(last_result_)) { + return; + } + options |= new_options; + if (options & FOS_PICKFOLDERS) { + opening_directory_ = true; + } + last_result_ = dialog_->SetOptions(options); + } + + // Sets the filters for allowed file types to select. + void SetFileTypeFilters(const EncodableList &filters) { + const std::wstring spec_delimiter = L";"; + const std::wstring file_wildcard = L"*."; + std::vector filter_specs; + // Temporary ownership of the constructed strings whose data is used in + // filter_specs, so that they live until the call to SetFileTypes is done. + std::vector filter_names; + std::vector filter_extensions; + filter_extensions.reserve(filters.size()); + filter_names.reserve(filters.size()); + + for (const EncodableValue &filter_info_value : filters) { + const auto &filter_info = std::get(filter_info_value); + const auto *filter_name = std::get_if( + ValueOrNull(filter_info, kTypeGroupLabelKey)); + const auto *extensions = std::get_if( + ValueOrNull(filter_info, kTypeGroupExtensionsKey)); + filter_names.push_back(filter_name ? Utf16FromUtf8(*filter_name) : L""); + filter_extensions.push_back(L""); + std::wstring &spec = filter_extensions.back(); + if (!extensions || extensions->empty()) { + spec += L"*.*"; + } else { + for (const EncodableValue &extension : *extensions) { + if (!spec.empty()) { + spec += spec_delimiter; + } + spec += + file_wildcard + Utf16FromUtf8(std::get(extension)); + } + } + filter_specs.push_back({filter_names.back().c_str(), spec.c_str()}); + } + last_result_ = dialog_->SetFileTypes(static_cast(filter_specs.size()), + filter_specs.data()); + } + + // Displays the dialog, and returns the selected file or files as an + // EncodableValue of type List (for open) or String (for save), or a null + // EncodableValue on cancel or error. + EncodableValue Show(HWND parent_window) { + assert(dialog_); + last_result_ = dialog_->Show(parent_window); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + + if (is_open_dialog_) { + IFileOpenDialog *open_dialog; + last_result_ = dialog_->QueryInterface(IID_PPV_ARGS(&open_dialog)); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + IShellItemArray *shell_items; + last_result_ = open_dialog->GetResults(&shell_items); + open_dialog->Release(); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + IEnumShellItems *item_enumerator; + last_result_ = shell_items->EnumItems(&item_enumerator); + if (!SUCCEEDED(last_result_)) { + shell_items->Release(); + return EncodableValue(); + } + EncodableList files; + IShellItem *shell_item; + while (item_enumerator->Next(1, &shell_item, nullptr) == S_OK) { + files.push_back(EncodableValue(GetPathForShellItem(shell_item))); + shell_item->Release(); + } + item_enumerator->Release(); + shell_items->Release(); + if (opening_directory_) { + // The directory option expects a String, not a List. + if (files.empty()) { + return EncodableValue(); + } + return EncodableValue(files[0]); + } else { + return EncodableValue(std::move(files)); + } + } else { + IShellItem *shell_item; + last_result_ = dialog_->GetResult(&shell_item); + if (!SUCCEEDED(last_result_)) { + return EncodableValue(); + } + EncodableValue file(GetPathForShellItem(shell_item)); + shell_item->Release(); + return file; + } + } + + // Returns the result of the last Win32 API call related to this object. + HRESULT last_result() { return last_result_; } + + private: + IFileDialog *dialog_ = nullptr; + bool is_open_dialog_; + bool opening_directory_ = false; + HRESULT last_result_; +}; + +// Displays the open or save dialog (according to |method|) and sends the +// selected file path(s) back to the engine via |result|, or sends an +// error on failure. +// +// |result| is guaranteed to be resolved by this function. +void ShowDialog(HWND parent_window, const std::string &method, + const EncodableMap &args, + std::unique_ptr> result) { + IID dialog_type = method.compare(kGetSavePathMethod) == 0 + ? CLSID_FileSaveDialog + : CLSID_FileOpenDialog; + DialogWrapper dialog(dialog_type); + if (!SUCCEEDED(dialog.last_result())) { + result->Error("System error", "Could not create dialog", + EncodableValue(dialog.last_result())); + return; + } + + FILEOPENDIALOGOPTIONS dialog_options = 0; + if (method.compare(kGetDirectoryPathMethod) == 0) { + dialog_options |= FOS_PICKFOLDERS; + } + const auto *allow_multiple_selection = + std::get_if(ValueOrNull(args, kMultipleKey)); + if (allow_multiple_selection && *allow_multiple_selection) { + dialog_options |= FOS_ALLOWMULTISELECT; + } + if (dialog_options != 0) { + dialog.AddOptions(dialog_options); + } + + const auto *initial_dir = + std::get_if(ValueOrNull(args, kInitialDirectoryKey)); + if (initial_dir) { + dialog.SetDefaultFolder(*initial_dir); + } + const auto *suggested_name = + std::get_if(ValueOrNull(args, kSuggestedNameKey)); + if (suggested_name) { + dialog.SetFileName(*suggested_name); + } + const auto *confirm_label = + std::get_if(ValueOrNull(args, kConfirmButtonTextKey)); + if (confirm_label) { + dialog.SetOkButtonLabel(*confirm_label); + } + const auto *accepted_types = + std::get_if(ValueOrNull(args, kAcceptedTypeGroupsKey)); + if (accepted_types && !accepted_types->empty()) { + dialog.SetFileTypeFilters(*accepted_types); + } + + EncodableValue files = dialog.Show(parent_window); + if (files.IsNull() && + dialog.last_result() != HRESULT_FROM_WIN32(ERROR_CANCELLED)) { + ; + result->Error("System error", "Could not show dialog", + EncodableValue(dialog.last_result())); + } + result->Success(files); +} + +// Returns the top-level window that owns |view|. +HWND GetRootWindow(flutter::FlutterView *view) { + return GetAncestor(view->GetNativeWindow(), GA_ROOT); +} + +class FileSelectorPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + + virtual ~FileSelectorPlugin(); + + private: + FileSelectorPlugin(flutter::PluginRegistrarWindows *registrar); + + // Called when a method is called on plugin channel; + void HandleMethodCall(const flutter::MethodCall<> &method_call, + std::unique_ptr> result); + + // The registrar for this plugin, for accessing the window. + flutter::PluginRegistrarWindows *registrar_; +}; + +// static +void FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows *registrar) { + auto channel = std::make_unique>( + registrar->messenger(), "plugins.flutter.io/file_selector", + &flutter::StandardMethodCodec::GetInstance()); + + // Uses new instead of make_unique due to private constructor. + std::unique_ptr plugin(new FileSelectorPlugin(registrar)); + + channel->SetMethodCallHandler( + [plugin_pointer = plugin.get()](const auto &call, auto result) { + plugin_pointer->HandleMethodCall(call, std::move(result)); + }); + + registrar->AddPlugin(std::move(plugin)); +} + +FileSelectorPlugin::FileSelectorPlugin( + flutter::PluginRegistrarWindows *registrar) + : registrar_(registrar) {} + +FileSelectorPlugin::~FileSelectorPlugin() = default; + +void FileSelectorPlugin::HandleMethodCall( + const flutter::MethodCall<> &method_call, + std::unique_ptr> result) { + const std::string &method_name = method_call.method_name(); + if (method_name.compare(kOpenFileMethod) == 0 || + method_name.compare(kGetSavePathMethod) == 0 || + method_name.compare(kGetDirectoryPathMethod) == 0) { + const auto *arguments = + std::get_if(method_call.arguments()); + assert(arguments); + ShowDialog(GetRootWindow(registrar_->GetView()), method_name, *arguments, + std::move(result)); + } else { + result->NotImplemented(); + } +} + +} // namespace + +void FileSelectorPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + FileSelectorPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h new file mode 100644 index 000000000000..7ad3bd2eb490 --- /dev/null +++ b/packages/file_selector/file_selector_windows/windows/include/file_selector_windows/file_selector_plugin.h @@ -0,0 +1,26 @@ +// Copyright 2020 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +#ifndef PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ +#define PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_ + +#include + +#ifdef FLUTTER_PLUGIN_IMPL +#define FLUTTER_PLUGIN_EXPORT __declspec(dllexport) +#else +#define FLUTTER_PLUGIN_EXPORT __declspec(dllimport) +#endif + +#if defined(__cplusplus) +extern "C" { +#endif + +FLUTTER_PLUGIN_EXPORT void FileSelectorPluginRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +#endif // PACKAGES_file_selector_file_selector_WINDOWS_WINDOWS_INCLUDE_file_selector_WINDOWS_file_selector_PLUGIN_H_