[PATCH v2 0/1] MR6130: shell32: Added stub for IEnumObjects interface.

[Kevin Martinez (＠kevinrmartinez)]

Stub added for the IEnumObjects interface, so that programs won't crash
when calling it.

Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=53620

--
  v2: shell32: Added stub for IEnumObjects interface

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

[PATCH v2 1/1] shell32: Added stub for IEnumObjects interface

[Kevin Martinez]

From: Kevin Martinez

---
 dlls/shell32/Makefile.in         |   1 +
 dlls/shell32/enumobjects.c       | 163 +++++++++++++++++++++++++++++++
 dlls/shell32/shell32_classes.idl |   5 +
 dlls/shell32/shell32_main.h      |   1 +
 dlls/shell32/shellole.c          |   1 +
 include/shobjidl.idl             |  18 ++++
 6 files changed, 189 insertions(+)
 create mode 100644 dlls/shell32/enumobjects.c

diff --git a/dlls/shell32/Makefile.in b/dlls/shell32/Makefile.in
index 4a906ac59db..c2df32b62ec 100644
--- a/dlls/shell32/Makefile.in
+++ b/dlls/shell32/Makefile.in
@@ -21,6 +21,7 @@ SOURCES = \
    dragdrophelper.c \
    ebrowser.c \
    enumidlist.c \
+	enumobjects.c \
    folders.c \
    iconcache.c \
    new_menu.c \
diff --git a/dlls/shell32/enumobjects.c b/dlls/shell32/enumobjects.c
new file mode 100644
index 00000000000..7175e22de4d
--- /dev/null
+++ b/dlls/shell32/enumobjects.c
@@ -0,0 +1,163 @@
+    /*
+ * IEnumObjects
+ *
+ * Copyright 2024 Kevin Martinez
+ *
+ * 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
+ */
+
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define COBJMACROS
+
+#include "wine/debug.h"
+#include "windef.h"
+#include "winbase.h"
+#include "winreg.h"
+#include "shlwapi.h"
+
+#include "shell32_main.h"
+
+WINE_DEFAULT_DEBUG_CHANNEL(shell);
+
+struct enum_objects
+{
+    IEnumObjects IEnumObjects_iface;
+    LONG         ref;
+};
+
+static inline struct enum_objects *impl_from_IEnumObjects(IEnumObjects *iface)
+{
+    return CONTAINING_RECORD(iface, struct enum_objects, IEnumObjects_iface);
+}
+
+static HRESULT WINAPI enum_objects_QueryInterface(IEnumObjects *iface, REFIID riid, void **obj)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+
+    TRACE("(%p/%p)->(%s, %p)\n", This, iface, debugstr_guid(riid), obj);
+
+    if (IsEqualIID(&IID_IUnknown, riid) ||
+        IsEqualIID(&IID_IEnumObjects, riid))
+    {
+        *obj = &This->IEnumObjects_iface;
+    }
+    else
+    {
+        WARN("no interface for %s\n", debugstr_guid(riid));
+        *obj = NULL;
+        return E_NOINTERFACE;
+    }
+
+    IUnknown_AddRef((IUnknown*)*obj);
+    return S_OK;
+}
+
+static ULONG WINAPI enum_objects_AddRef(IEnumObjects *iface)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+    ULONG refcount = InterlockedIncrement(&This->ref);
+    
+    TRACE("(%p/%p)->(%lu)\n", This, iface, refcount);
+
+    return refcount;
+}
+
+ static ULONG WINAPI enum_objects_Release(IEnumObjects *iface)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+    ULONG refcount = InterlockedDecrement(&This->ref);
+
+    TRACE("(%p/%p)->(%lu)\n", This, iface, refcount);
+
+    if (!refcount)
+    {
+        free(This);
+    }
+
+    return refcount;
+}
+
+static HRESULT WINAPI enum_objects_Next(IEnumObjects *iface, ULONG celt, REFIID riid, void **rgelt, ULONG *celtFetched)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+
+    FIXME("(%p/%p %ld, %p)->(%p, %p): stub!\n", This, iface, celt, debugstr_guid(riid), rgelt, celtFetched);
+
+    if (celtFetched)
+        celtFetched = 0;
+
+    return S_FALSE;
+}
+
+static HRESULT WINAPI enum_objects_Skip(IEnumObjects *iface, ULONG celt)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+
+    FIXME("(%p/%p %ld): stub!\n", This, iface, celt);   
+
+    return E_NOTIMPL;
+}
+
+static HRESULT WINAPI enum_objects_Reset(IEnumObjects *iface)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+
+    FIXME("(%p/%p): stub!\n", This, iface);
+    
+    return E_NOTIMPL;
+}
+
+static HRESULT WINAPI enum_objects_Clone(IEnumObjects *iface, IEnumObjects **ppenum)
+{
+    struct enum_objects *This = impl_from_IEnumObjects(iface);
+
+    FIXME("(%p/%p)->(%p): stub!\n",This, iface, ppenum);
+
+    return E_NOTIMPL;
+}
+
+static const IEnumObjectsVtbl enum_objects_vtbl =
+{
+    enum_objects_QueryInterface,
+    enum_objects_AddRef,
+    enum_objects_Release,
+    enum_objects_Next,
+    enum_objects_Skip,
+    enum_objects_Reset,
+    enum_objects_Clone,
+};
+
+HRESULT WINAPI IEnumObjects_Constructor(IUnknown *outer, REFIID riid, void **obj)
+{
+    struct enum_objects *This;
+
+    TRACE("(%p, %s, %p)\n", outer, debugstr_guid(riid), obj);
+
+    if (outer)
+        return CLASS_E_NOAGGREGATION;
+
+    if (!(This = heap_alloc(sizeof(*This))))
+        return E_OUTOFMEMORY;
+
+    This->ref = 1;
+    This->IEnumObjects_iface.lpVtbl = &enum_objects_vtbl;
+
+    hr = IEnumObjects_QueryInterface(&This->IEnumObjects_iface, riid, obj);
+    IEnumObjects_Release(&This->IEnumObjects_iface);
+    return hr;
+}
diff --git a/dlls/shell32/shell32_classes.idl b/dlls/shell32/shell32_classes.idl
index 135ef52f7b0..872ecb31630 100644
--- a/dlls/shell32/shell32_classes.idl
+++ b/dlls/shell32/shell32_classes.idl
@@ -189,3 +189,8 @@ coclass KnownFolderManager { interface IKnownFolderManager; }
     uuid(d969a300-e7ff-11d0-a93b-00a0c90f2719)
 ]
 coclass NewMenu {}
+
+[
+    threading(apartment),
+    uuid(2d3468c1-36a7-43b6-ac24-d3f02fd9607a)
+] coclass EnumerableObjectCollection { interface IEnumObjects; }
diff --git a/dlls/shell32/shell32_main.h b/dlls/shell32/shell32_main.h
index 6b5575c6879..b25cba56317 100644
--- a/dlls/shell32/shell32_main.h
+++ b/dlls/shell32/shell32_main.h
@@ -103,6 +103,7 @@ HRESULT WINAPI ExplorerBrowser_Constructor(IUnknown *pUnkOuter, REFIID riid, LPV
 HRESULT WINAPI KnownFolderManager_Constructor(IUnknown *pUnkOuter, REFIID riid, LPVOID *ppv);
 HRESULT WINAPI IFileOperation_Constructor(IUnknown *outer, REFIID riid, void **out);
 HRESULT WINAPI ActiveDesktop_Constructor(IUnknown *outer, REFIID riid, void **out);
+HRESULT WINAPI IEnumObjects_Constructor(IUnknown *outer, REFIID riid, void **obj);

extern HRESULT CPanel_GetIconLocationW(LPCITEMIDLIST, LPWSTR, UINT, int*);
 HRESULT WINAPI CPanel_ExtractIconA(LPITEMIDLIST pidl, LPCSTR pszFile, UINT nIconIndex, HICON *phiconLarge, HICON *phiconSmall, UINT nIconSize);
diff --git a/dlls/shell32/shellole.c b/dlls/shell32/shellole.c
index aa9bd3e0f3e..b9cf6e633a0 100644
--- a/dlls/shell32/shellole.c
+++ b/dlls/shell32/shellole.c
@@ -87,6 +87,7 @@ static const struct {
    {&CLSID_ShellImageDataFactory, ShellImageDataFactory_Constructor},
    {&CLSID_FileOperation, IFileOperation_Constructor},
    {&CLSID_ActiveDesktop, ActiveDesktop_Constructor},
+	{&CLSID_EnumerableObjectCollection, IEnumObjects_Constructor},
    {NULL, NULL}
 };

diff --git a/include/shobjidl.idl b/include/shobjidl.idl
index 886cff89ef9..bb87fc31587 100644
--- a/include/shobjidl.idl
+++ b/include/shobjidl.idl
@@ -4126,3 +4126,21 @@ interface IFileOperation : IUnknown
     HRESULT PerformOperations();
     HRESULT GetAnyOperationsAborted([out] BOOL *aborted);
 }
+
+[
+    object,
+    uuid(2c1c7e2e-2d0e-4059-831e-1e6f82335c2e),
+    pointer_default(unique)
+]
+interface IEnumObjects : IUnknown
+{
+    HRESULT Next(
+        [in] ULONG  celt,
+        [in] REFIID riid,
+        [out, iid_is(riid)] void **rgelt,
+        [out, optional] ULONG *pceltFetched );
+
+    HRESULT Skip([in] ULONG celt);
+    HRESULT Reset();
+    HRESULT Clone([out] IEnumObjects **ppenum);
+}

[PATCH v2 1/1] shell32: Added stub for IEnumObjects interface

[Marvin]

Hi,

It looks like your patch introduced the new failures shown below.
Please investigate and fix them before resubmitting your patch.
If they are not new, fixing them anyway would help a lot. Otherwise
please ask for the known failures list to be updated.

The full results can be found at:
https://testbot.winehq.org/JobDetails.pl?Key=147321

Your paranoid android.

=== debian11 (build log) ===

../wine/dlls/shell32/enumobjects.c:160:5: error: ‘hr’ undeclared (first use in this function)
Task: The win32 Wine build failed

=== debian11b (build log) ===

../wine/dlls/shell32/enumobjects.c:160:5: error: ‘hr’ undeclared (first use in this function)
Task: The wow64 Wine build failed