[PATCH v2 0/1] MR2537: include: Add windows.ui.core.idl file.

[Mohamad Al-Jaf (＠maljaf)]

Needed for mingw Firefox build.

It looks like CoreDispatcher was added as a forward declaration for `ICompositionObject`: https://searchfox.org/mozilla-central/source/taskcluster/scripts/misc/mingw-...

However, just having `interface ICoreDispatcher;` alone does not generate the IUnknown methods. I don't know if commenting out the functions is acceptable.

--
  v2: include: Add windows.ui.core.idl file.

https://gitlab.winehq.org/wine/wine/-/merge_requests/2537

[PATCH v2 1/1] include: Add windows.ui.core.idl file.

[Mohamad Al-Jaf]

From: Mohamad Al-Jaf

Needed for mingw Firefox build.
---
 include/Makefile.in                      |   1 +
 include/windows.graphics.holographic.idl |   2 +-
 include/windows.ui.core.idl              | 130 +++++++++++++++++++++++
 include/windows.ui.viewmanagement.idl    |   2 +-
 4 files changed, 133 insertions(+), 2 deletions(-)
 create mode 100644 include/windows.ui.core.idl

diff --git a/include/Makefile.in b/include/Makefile.in
index 9bde0bcceb0..f0c0da3ed93 100644
--- a/include/Makefile.in
+++ b/include/Makefile.in
@@ -836,6 +836,7 @@ SOURCES = \
    windows.system.profile.systemmanufacturers.idl \
    windows.system.threading.idl \
    windows.system.userprofile.idl \
+	windows.ui.core.idl \
    windows.ui.idl \
    windows.ui.viewmanagement.idl \
    windowscontracts.idl \
diff --git a/include/windows.graphics.holographic.idl b/include/windows.graphics.holographic.idl
index 568003cd7a3..88a7aa914b8 100644
--- a/include/windows.graphics.holographic.idl
+++ b/include/windows.graphics.holographic.idl
@@ -30,7 +30,7 @@ import "windows.graphics.directx.idl";
 import "windows.graphics.directx.direct3d11.idl";
 /* import "windows.perception.idl"; */
 import "windows.perception.spatial.idl";
-/* import "windows.ui.core.idl"; */
+import "windows.ui.core.idl";

namespace Windows.Graphics.Holographic {
     typedef struct HolographicAdapterId HolographicAdapterId;
diff --git a/include/windows.ui.core.idl b/include/windows.ui.core.idl
new file mode 100644
index 00000000000..aa6d4b1f040
--- /dev/null
+++ b/include/windows.ui.core.idl
@@ -0,0 +1,130 @@
+/*
+ * Copyright (C) 2023 Mohamad Al-Jaf
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+#ifdef __WIDL__
+#pragma winrt ns_prefix
+#endif
+
+import "inspectable.idl";
+import "asyncinfo.idl";
+import "eventtoken.idl";
+import "windowscontracts.idl";
+import "windows.foundation.idl";
+import "windows.system.idl";
+import "windows.ui.idl";
+/* import "windows.ui.composition.idl"; */
+/* import "windows.ui.input.idl"; */
+/* import "windows.ui.input.inking.idl"; */
+/* import "windows.ui.input.inking.core.idl"; */
+/* import "windows.ui.popups.idl"; */
+
+namespace Windows.UI.Core {
+    typedef enum CoreDispatcherPriority CoreDispatcherPriority;
+    typedef enum CoreProcessEventsOption CoreProcessEventsOption;
+
+    interface ICoreAcceleratorKeys;
+    interface ICoreDispatcher;
+    interface ICoreDispatcher2;
+    interface ICoreDispatcherWithTaskPriority;
+    interface IIdleDispatchedHandlerArgs;
+
+    runtimeclass AcceleratorKeyEventArgs;
+    runtimeclass CoreDispatcher;
+    runtimeclass IdleDispatchedHandlerArgs;
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0)
+    ]
+    enum CoreDispatcherPriority
+    {
+        [contract(Windows.Foundation.UniversalApiContract, 1.0)]
+        Idle   = -2,
+        Low    = -1,
+        Normal =  0,
+        High   =  1,
+    };
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0)
+    ]
+    enum CoreProcessEventsOption
+    {
+        ProcessOneAndAllPending = 0,
+        ProcessOneIfPresent     = 1,
+        ProcessUntilQuit        = 2,
+        ProcessAllIfPresent     = 3,
+    };
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        uuid(d1f276c4-98d8-4636-bf49-eb79507548e9)
+    ]
+    delegate HRESULT DispatchedHandler();
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        uuid(a42b0c24-7f21-4abc-99c1-8f01007f0880)
+    ]
+    delegate HRESULT IdleDispatchedHandler([in] Windows.UI.Core.IdleDispatchedHandlerArgs *e);
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        exclusiveto(Windows.UI.Core.CoreDispatcher),
+        uuid(60db2fa8-b705-4fde-a7d6-ebbb1891d39e)
+    ]
+    interface ICoreDispatcher : IInspectable
+        requires Windows.UI.Core.ICoreAcceleratorKeys
+    {
+        [propget] HRESULT HasThreadAccess([out, retval] boolean *value);
+        HRESULT ProcessEvents([in] Windows.UI.Core.CoreProcessEventsOption options);
+        HRESULT RunAsync([in] Windows.UI.Core.CoreDispatcherPriority priority, [in] Windows.UI.Core.DispatchedHandler *callback,
+                         [out, retval] Windows.Foundation.IAsyncAction **action);
+        HRESULT RunIdleAsync([in] Windows.UI.Core.IdleDispatchedHandler *callback, [out, retval] Windows.Foundation.IAsyncAction **action);
+    }
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        exclusiveto(Windows.UI.Core.IdleDispatchedHandlerArgs),
+        uuid(98bb6a24-dc1c-43cb-b4ed-d1c0eb2391f3)
+    ]
+    interface IIdleDispatchedHandlerArgs : IInspectable
+    {
+        [propget] HRESULT IsDispatcherIdle([out, retval] boolean *value);
+    }
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        marshaling_behavior(agile)
+    ]
+    runtimeclass CoreDispatcher
+    {
+        [default] interface Windows.UI.Core.ICoreDispatcher;
+        interface Windows.UI.Core.ICoreAcceleratorKeys;
+        [contract(Windows.Foundation.UniversalApiContract, 1.0)] interface Windows.UI.Core.ICoreDispatcherWithTaskPriority;
+        [contract(Windows.Foundation.UniversalApiContract, 1.0)] interface Windows.UI.Core.ICoreDispatcher2;
+    }
+
+    [
+        contract(Windows.Foundation.UniversalApiContract, 1.0),
+        marshaling_behavior(standard)
+    ]
+    runtimeclass IdleDispatchedHandlerArgs
+    {
+        [default] interface Windows.UI.Core.IIdleDispatchedHandlerArgs;
+    }
+}
diff --git a/include/windows.ui.viewmanagement.idl b/include/windows.ui.viewmanagement.idl
index dcfa83aa74d..b98d34ff685 100644
--- a/include/windows.ui.viewmanagement.idl
+++ b/include/windows.ui.viewmanagement.idl
@@ -28,7 +28,7 @@ import "windows.foundation.idl";
 import "windows.devices.enumeration.idl";
 /* import "windows.phone.idl"; */
 import "windows.ui.idl";
-/* import "windows.ui.core.idl"; */
+import "windows.ui.core.idl";
 /* import "windows.ui.popups.idl"; */
 /* import "windows.ui.windowmanagement.idl"; */

[Mohamad Al-Jaf (＠maljaf)]

> I think it's best not to comment methods. They may be used to generate UUIDs, as part of the interface signature.

Does that matter in this case since the interface is only being used as a forward declaration?

In any case, it wasn't too bad adding the definition.

[Rémi Bernon (＠rbernon)]

On Fri Mar 31 04:55:37 2023 +0000, Mohamad Al-Jaf wrote:
> > I think it's best not to comment methods. They may be used to generate
>
> UUIDs, as part of the interface signature.
> Does that matter in this case since the interface is only being used as
> a forward declaration?
> In any case, it wasn't too bad adding the definition.

It doesn't but as soon as it's used in some generic type it might, I think the definitions should be complete as soon as we add them to not end up with silent problems later.

[PATCH v2 0/1] MR2537: include: Add windows.ui.core.idl file. - approved

[Rémi Bernon (＠rbernon)]

This merge request was approved by Rémi Bernon.