[PATCH 0/1] MR1984: mshtml: Implement IHTMLRect2 for HTMLRect

[Evan Tang (＠etang-cw)]

Implements IHTMLRect2 for HTMLRect so `width` and `height` are available when in IE9+

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

[PATCH 1/1] mshtml: Implement IHTMLRect2 for HTMLRect

[Evan Tang]

From: Evan Tang <etang(a)codeweavers.com>

---
 dlls/mshtml/htmlelem.c       | 110 ++++++++++++++++++++++++++++++++++-
 dlls/mshtml/mshtml_private.h |   1 +
 dlls/mshtml/tests/dom.js     |   2 +
 include/mshtmdid.h           |   4 ++
 include/mshtml.idl           |  18 ++++++
 5 files changed, 134 insertions(+), 1 deletion(-)

diff --git a/dlls/mshtml/htmlelem.c b/dlls/mshtml/htmlelem.c
index b66b0c22552..f8b2eb46e6c 100644
--- a/dlls/mshtml/htmlelem.c
+++ b/dlls/mshtml/htmlelem.c
@@ -529,6 +529,7 @@ HRESULT create_element(HTMLDocumentNode *doc, const WCHAR *tag, HTMLElement **re
 typedef struct {
     DispatchEx dispex;
     IHTMLRect IHTMLRect_iface;
+    IHTMLRect2 IHTMLRect2_iface;
 
     LONG ref;
 
@@ -550,6 +551,8 @@ static HRESULT WINAPI HTMLRect_QueryInterface(IHTMLRect *iface, REFIID riid, voi
         *ppv = &This->IHTMLRect_iface;
     }else if(IsEqualGUID(&IID_IHTMLRect, riid)) {
         *ppv = &This->IHTMLRect_iface;
+    }else if (IsEqualGUID(&IID_IHTMLRect2, riid)) {
+        *ppv = &This->IHTMLRect2_iface;
     }else if(dispex_query_interface(&This->dispex, riid, ppv)) {
         return *ppv ? S_OK : E_NOINTERFACE;
     }else {
@@ -723,6 +726,91 @@ static HRESULT WINAPI HTMLRect_get_bottom(IHTMLRect *iface, LONG *p)
     return S_OK;
 }
 
+static inline HTMLRect *impl_from_IHTMLRect2(IHTMLRect2 *iface)
+{
+    return CONTAINING_RECORD(iface, HTMLRect, IHTMLRect2_iface);
+}
+
+static HRESULT WINAPI HTMLRect2_QueryInterface(IHTMLRect2 *iface, REFIID riid, void **ppv)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IHTMLRect_QueryInterface(&This->IHTMLRect_iface, riid, ppv);
+}
+
+static ULONG WINAPI HTMLRect2_AddRef(IHTMLRect2 *iface)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IHTMLRect_AddRef(&This->IHTMLRect_iface);
+}
+
+static ULONG WINAPI HTMLRect2_Release(IHTMLRect2 *iface)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IHTMLRect_Release(&This->IHTMLRect_iface);
+}
+
+static HRESULT WINAPI HTMLRect2_GetTypeInfoCount(IHTMLRect2 *iface, UINT *pctinfo)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IDispatchEx_GetTypeInfoCount(&This->dispex.IDispatchEx_iface, pctinfo);
+}
+
+static HRESULT WINAPI HTMLRect2_GetTypeInfo(IHTMLRect2 *iface, UINT iTInfo,
+        LCID lcid, ITypeInfo **ppTInfo)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IDispatchEx_GetTypeInfo(&This->dispex.IDispatchEx_iface, iTInfo, lcid, ppTInfo);
+}
+
+static HRESULT WINAPI HTMLRect2_GetIDsOfNames(IHTMLRect2 *iface, REFIID riid,
+        LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IDispatchEx_GetIDsOfNames(&This->dispex.IDispatchEx_iface, riid, rgszNames, cNames,
+            lcid, rgDispId);
+}
+
+static HRESULT WINAPI HTMLRect2_Invoke(IHTMLRect2 *iface, DISPID dispIdMember,
+        REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams,
+        VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    return IDispatchEx_Invoke(&This->dispex.IDispatchEx_iface, dispIdMember, riid, lcid, wFlags,
+            pDispParams, pVarResult, pExcepInfo, puArgErr);
+}
+
+static HRESULT WINAPI HTMLRect2_get_width(IHTMLRect2 *iface, FLOAT *p)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    nsresult nsres;
+
+    TRACE("(%p)->(%p)\n", This, p);
+
+    nsres = nsIDOMClientRect_GetWidth(This->nsrect, p);
+    if (NS_FAILED(nsres)) {
+        ERR("GetWidth failed: %08lx\n", nsres);
+        return E_FAIL;
+    }
+
+    return S_OK;
+}
+
+static HRESULT WINAPI HTMLRect2_get_height(IHTMLRect2 *iface, FLOAT *p)
+{
+    HTMLRect *This = impl_from_IHTMLRect2(iface);
+    nsresult nsres;
+
+    TRACE("(%p)->(%p)\n", This, p);
+
+    nsres = nsIDOMClientRect_GetHeight(This->nsrect, p);
+    if (NS_FAILED(nsres)) {
+        ERR("GetHeight failed: %08lx\n", nsres);
+        return E_FAIL;
+    }
+
+    return S_OK;
+}
+
 static const IHTMLRectVtbl HTMLRectVtbl = {
     HTMLRect_QueryInterface,
     HTMLRect_AddRef,
@@ -741,6 +829,24 @@ static const IHTMLRectVtbl HTMLRectVtbl = {
     HTMLRect_get_bottom
 };
 
+static const IHTMLRect2Vtbl HTMLRect2Vtbl = {
+    HTMLRect2_QueryInterface,
+    HTMLRect2_AddRef,
+    HTMLRect2_Release,
+    HTMLRect2_GetTypeInfoCount,
+    HTMLRect2_GetTypeInfo,
+    HTMLRect2_GetIDsOfNames,
+    HTMLRect2_Invoke,
+    HTMLRect2_get_width,
+    HTMLRect2_get_height,
+};
+
+void HTMLRect_init_dispex_info(dispex_data_t *info, compat_mode_t mode)
+{
+    if (mode >= COMPAT_MODE_IE9)
+        dispex_info_add_interface(info, IHTMLRect2_tid, NULL);
+}
+
 static const tid_t HTMLRect_iface_tids[] = {
     IHTMLRect_tid,
     0
@@ -749,7 +855,8 @@ static dispex_static_data_t HTMLRect_dispex = {
     L"ClientRect",
     NULL,
     IHTMLRect_tid,
-    HTMLRect_iface_tids
+    HTMLRect_iface_tids,
+    HTMLRect_init_dispex_info
 };
 
 static HRESULT create_html_rect(nsIDOMClientRect *nsrect, compat_mode_t compat_mode, IHTMLRect **ret)
@@ -761,6 +868,7 @@ static HRESULT create_html_rect(nsIDOMClientRect *nsrect, compat_mode_t compat_m
         return E_OUTOFMEMORY;
 
     rect->IHTMLRect_iface.lpVtbl = &HTMLRectVtbl;
+    rect->IHTMLRect2_iface.lpVtbl = &HTMLRect2Vtbl;
     rect->ref = 1;
 
     init_dispatch(&rect->dispex, (IUnknown*)&rect->IHTMLRect_iface, &HTMLRect_dispex, compat_mode);
diff --git a/dlls/mshtml/mshtml_private.h b/dlls/mshtml/mshtml_private.h
index d5a9e02aa13..870ba14c8b4 100644
--- a/dlls/mshtml/mshtml_private.h
+++ b/dlls/mshtml/mshtml_private.h
@@ -237,6 +237,7 @@ typedef struct EventTarget EventTarget;
     XIID(IHTMLPerformanceTiming) \
     XIID(IHTMLPluginsCollection) \
     XIID(IHTMLRect) \
+    XIID(IHTMLRect2) \
     XIID(IHTMLRectCollection) \
     XIID(IHTMLScreen) \
     XIID(IHTMLScriptElement) \
diff --git a/dlls/mshtml/tests/dom.js b/dlls/mshtml/tests/dom.js
index 5a31b869c8f..e5a07027f7c 100644
--- a/dlls/mshtml/tests/dom.js
+++ b/dlls/mshtml/tests/dom.js
@@ -293,6 +293,8 @@ sync_test("rects", function() {
     ok(rects.length === 1, "rect.length = " + rects.length);
     ok(rects[0].top === rect.top, "rects[0].top = " + rects[0].top + " rect.top = " + rect.top);
     ok(rects[0].bottom === rect.bottom, "rects[0].bottom = " + rects[0].bottom + " rect.bottom = " + rect.bottom);
+    ok(rect.height === rect.bottom - rect.top, "rect.height = " + rect.height + " rect.bottom = " + rect.bottom + " rect.top = " + rect.top);
+    ok(rect.width === rect.right - rect.left, "rect.width = " + rect.width + " rect.right = " + rect.right + " rect.left = " + rect.left);
 
     elem = document.createElement("style");
     rects = elem.getClientRects();
diff --git a/include/mshtmdid.h b/include/mshtmdid.h
index 0e95a7d7165..1673dd3cea0 100644
--- a/include/mshtmdid.h
+++ b/include/mshtmdid.h
@@ -4135,6 +4135,10 @@
 #define DISPID_IHTMLRECT_RIGHT   DISPID_OMRECT+3
 #define DISPID_IHTMLRECT_BOTTOM  DISPID_OMRECT+4
 
+/* IHTMLRect2 */
+#define DISPID_IHTMLRECT2_WIDTH  DISPID_OMRECT+5
+#define DISPID_IHTMLRECT2_HEIGHT DISPID_OMRECT+6
+
 /* IHTMLRectCollection */
 #define DISPID_IHTMLRECTCOLLECTION_LENGTH    DISPID_COLLECTION
 #define DISPID_IHTMLRECTCOLLECTION__NEWENUM  DISPID_NEWENUM
diff --git a/include/mshtml.idl b/include/mshtml.idl
index eff87a4593e..1a5c9bbaf28 100644
--- a/include/mshtml.idl
+++ b/include/mshtml.idl
@@ -7937,6 +7937,24 @@ interface IHTMLRect : IDispatch
     HRESULT bottom([retval, out] LONG *p);
 }
 
+/*****************************************************************************
+ *    IHTMLRect2 interface
+ */
+[
+    odl,
+    oleautomation,
+    dual,
+    uuid(3051076c-98b5-11cf-bb82-00aa00bdce0b)
+]
+interface IHTMLRect2 : IDispatch
+{
+    [propget, id(DISPID_IHTMLRECT2_WIDTH)]
+    HRESULT width([retval, out] FLOAT *p);
+
+    [propget, id(DISPID_IHTMLRECT2_HEIGHT)]
+    HRESULT height([retval, out] FLOAT *p);
+}
+
 /*****************************************************************************
  *    IHTMLRectCollection interface
  */
-- 
GitLab

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

[Jacek Caban (＠jacek)]

The patch looks good (after code freeze), but it would be nice to add a test to documentmode.js showing when the interface should be exposed to scripts.

-- 
https://gitlab.winehq.org/wine/wine/-/merge_requests/1984#note_21263