Add basic support for WinRT asynchronous methods #465

halildurmus · 2022-05-31T23:28:04Z

Fixes #39
Fixes #97

Adds support for WinRT asynchronous methods that return IAsyncAction or IAsyncOperation delegates. This is achieved by polling their status property every 10 milliseconds (I don't have a strong opinion on what this value should be) until it completes.

The other WinRT projections use the completed callback but we can't use that at the moment as async callbacks are not supported yet. This also prevents us from adding support for the asynchronous methods that return IAsyncActionWithProgress and IAsyncOperationWithProgress delegates (they report progress updates to callers through their progress callback).

Furthermore, I added IInitializeWithWindow interface and a wrapper for it (in winrt_com_interop_helpers.dart). This is necessary for APIs that depend on CoreWindow (Display WinRT UI objects that depend on CoreWindow explains this).

Also added the BasicProperties class and partially generated the StorageFile APIs (I'll fully generate them later as StorageFile has so many dependencies).

timsneath · 2022-12-30T19:51:57Z

Woah! Is this ready for review? That would be the best Christmas present!

halildurmus · 2022-12-30T19:58:41Z

Woah! Is this ready for review? That would be the best Christmas present!

Yeah, I think this is finally ready for review :).

timsneath · 2022-12-31T03:13:05Z

example/winrt_picker.dart

 import 'package:win32/winrt.dart';

 void main() async {
  winrtInitialize();
-  final pIndex = calloc<Uint32>();

  final picker = FileOpenPicker()
    ..suggestedStartLocation = PickerLocationId.desktop


I'm not sure why, but neither the suggestedStartLocation nor the viewMode property appear to be working on my machine. I've tried changing them to various other values, but they don't seem to affect the presented dialog box. Can you replicate?

FileOpenPicker.SuggestedStartLocation Property states:

The SuggestedStartLocation is not always used as the start location for the file picker. To give the user a sense of consistency, the file picker remembers the last location that the user navigated to and will generally start at that location.

As for the viewMode property, I can't get it to work either. I'm installing Visual Studio right now. I'll try this example in a UWP app to see if this works properly there.

Interesting, it doesn't work in a UWP app either.

Very strange. Investigating here too...

lib/src/winrt/internal/async_helpers.dart

timsneath · 2022-12-31T05:52:35Z

lib/src/winrt_com_interop_helpers.dart

+  /// [target] must be a WinRT object that implements the
+  /// `IInitializeWithWindow` interface (e.g. `FileOpenPicker`).
+  ///
+  /// [hwnd] represents the handle of the window to be used as the owner window.


I'm curious if there are only specific types of HWND that are valid. I used GetActiveWindow() (which I would have thought would be the natural choice), and got an error: Error 0x80070578: Invalid window handle., which suggests that there's some specific criteria beyond being a valid HWND. I wasn't able to find documentation that answered this beyond this article.

I'm curious if there are only specific types of HWND that are valid. I used GetActiveWindow() (which I would have thought would be the natural choice), and got an error: Error 0x80070578: Invalid window handle., which suggests that there's some specific criteria beyond being a valid HWND. I wasn't able to find documentation that answered this beyond this article.

I don't know. I found GetConsoleWindow() and GetShellWindow() by trial and error.

I just noticed that GetForegroundWindow() works for both console and Flutter apps (yay!). I wonder, should I make the necessary changes so that we use GetForegroundWindow() everywhere?

GetForegroundWindow() is good, but it's not perfect -- for example, if there's another window from another process that has gained focus, it will become the parent for the file picker. That's why I'm a bit bemused that GetActiveWindow() isn't working here, since that means "the current window from the current process". (More here: https://devblogs.microsoft.com/oldnewthing/20081006-00/?p=20643)

Ah, I see. It was too good to be true anyway :).

This seems to explain it:
https://devblogs.microsoft.com/oldnewthing/20190412-00/?p=102413

(TL;DR Not every window has a CoreWindow associated with it. We ought to figure out how to do IInitializeWithWindow from Dart).

lib/src/winrt/internal/async_helpers.dart

timsneath

Added some general comments above. Hopefully helpful!

timsneath

There's probably a little more iteration to be done on the example, but I think we're good to merge this as a baseline. This is awesome work, @halildurmus. I don't think I could have gotten there myself. Thank you so much!

halildurmus · 2022-12-31T20:21:45Z

There's probably a little more iteration to be done on the example, but I think we're good to merge this as a baseline. This is awesome work, @halildurmus. I don't think I could have gotten there myself. Thank you so much!

Thank you. Let's do this 🎉.

clarkezone · 2023-01-02T19:09:31Z

Awesome would love to give this a try!

halildurmus mentioned this pull request Jun 3, 2022

Support generic collections in implementsMappers #480

Closed

halildurmus changed the title ~~[WIP] Support WinRT asynchronous APIs~~ Add basic support for WinRT asynchronous methods Nov 28, 2022

halildurmus added feature A new feature or request winrt package: generator Issue with package:generator labels Nov 28, 2022

halildurmus added 16 commits December 23, 2022 22:07

Add comments to IObservableMap

61b84d8

Generate missing parameter arguments

6a23308

Parse the type arguments of IAsyncOperation correctly

1e5ffb4

Update IAsyncOperation

456b603

Add basic support for asynchronous methods

fec5ddc

Add BasicProperties

176f83a

Regenerate files

da36917

Add basic support for StorageFile

74223e2

Don't export IAsyncXX delegates

e77e33b

Fix tests

8c09ff2

Add IInitializeWithWindow

bd9c8d1

Add WinRT COM Interop helpers

5b19668

Update WinRT picker example

d169f1c

Add WinRT picker example to README.md

83300f8

Clean up documentation

2d1e18b

Add some TODOs

fa2e6f9

halildurmus marked this pull request as ready for review December 25, 2022 12:43

halildurmus added 8 commits December 25, 2022 21:26

Update storagefile.dart

ef95c96

Update istoragefilestatics.dart

1fe9755

Clean up async helpers

fe9b6dd

Return void instead of Future<void>

1f38f1a

Format istoragefile.dart

8b52f53

Fix onCompletedCallback

ab04b58

Update documentation

935279a

Tweak picker example

1d60320

halildurmus added 2 commits December 30, 2022 12:43

Generate some imports for the WinRT interfaces only

086df45

Merge branch 'main' into winrt-async

0f08e7c

Add test

2780cff

halildurmus added 2 commits December 30, 2022 23:05

Merge branch 'main' into winrt-async

0735135

Fix code sample

967ab14

timsneath reviewed Dec 31, 2022

View reviewed changes

lib/src/winrt/internal/async_helpers.dart Show resolved Hide resolved

timsneath reviewed Dec 31, 2022

View reviewed changes

lib/src/winrt/internal/async_helpers.dart Outdated Show resolved Hide resolved

timsneath reviewed Dec 31, 2022

View reviewed changes

halildurmus and others added 2 commits December 31, 2022 11:14

Set the poll frequency to 1/60s

f5e84b7

Merge branch 'main' into winrt-async

96fdc89

timsneath approved these changes Dec 31, 2022

View reviewed changes

halildurmus merged commit 3f6140e into halildurmus:main Dec 31, 2022

halildurmus deleted the winrt-async branch December 31, 2022 20:22

halildurmus mentioned this pull request Jan 6, 2023

Methods/properties that return WinRT objects should be nullable #647

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic support for WinRT asynchronous methods #465

Add basic support for WinRT asynchronous methods #465

halildurmus commented May 31, 2022 •

edited

Loading

timsneath commented Dec 30, 2022

halildurmus commented Dec 30, 2022

timsneath Dec 31, 2022 •

edited

Loading

halildurmus Dec 31, 2022 •

edited

Loading

halildurmus Dec 31, 2022

timsneath Dec 31, 2022

timsneath Dec 31, 2022

halildurmus Dec 31, 2022

timsneath Dec 31, 2022

halildurmus Dec 31, 2022

timsneath Dec 31, 2022

timsneath left a comment

timsneath left a comment

halildurmus commented Dec 31, 2022

clarkezone commented Jan 2, 2023

Add basic support for WinRT asynchronous methods #465

Add basic support for WinRT asynchronous methods #465

Conversation

halildurmus commented May 31, 2022 • edited Loading

timsneath commented Dec 30, 2022

halildurmus commented Dec 30, 2022

timsneath Dec 31, 2022 • edited Loading

Choose a reason for hiding this comment

halildurmus Dec 31, 2022 • edited Loading

Choose a reason for hiding this comment

halildurmus Dec 31, 2022

Choose a reason for hiding this comment

timsneath Dec 31, 2022

Choose a reason for hiding this comment

timsneath Dec 31, 2022

Choose a reason for hiding this comment

halildurmus Dec 31, 2022

Choose a reason for hiding this comment

timsneath Dec 31, 2022

Choose a reason for hiding this comment

halildurmus Dec 31, 2022

Choose a reason for hiding this comment

timsneath Dec 31, 2022

Choose a reason for hiding this comment

timsneath left a comment

Choose a reason for hiding this comment

timsneath left a comment

Choose a reason for hiding this comment

halildurmus commented Dec 31, 2022

clarkezone commented Jan 2, 2023

halildurmus commented May 31, 2022 •

edited

Loading

timsneath Dec 31, 2022 •

edited

Loading

halildurmus Dec 31, 2022 •

edited

Loading