[PATCH v20 0/2] MR10393: Draft: vbscript: Check named item dispatch for Dim variable names.

[Francis De Brabandere (＠francisdb)]

When declaring variables with Dim in a visible named item context,
check the named item's IDispatch for each variable name via
GetIDsOfNames. This matches Windows VBScript behavior where Dim
probes the host object before creating the variable.

--
  v20: vbscript/tests: Cover host-dispatch probing for top-level declarations.
 
https://gitlab.winehq.org/wine/wine/-/merge_requests/10393

[PATCH v20 1/2] vbscript: Check named item dispatch for top-level declared names.

[Francis De Brabandere]

From: Francis De Brabandere <[e-mail]>

When parsing top-level declarations (Dim variables, Subs, Functions,
Classes) in a visible named item context, the first such parse
release-and-refetches the host IDispatch and probes each declared
name on it via GetIDsOfNames. This matches Windows VBScript behavior;
the variable/sub/function/class is always created regardless of
whether the name exists on the host dispatch.

Subsequent parses on the same named item reuse the cached dispatch
and only probe newly declared names.
---
 dlls/vbscript/vbscript.c | 58 ++++++++++++++++++++++++++++++++++++++++
 dlls/vbscript/vbscript.h |  1 +
 2 files changed, 59 insertions(+)

diff --git a/dlls/vbscript/vbscript.c b/dlls/vbscript/vbscript.c
index ff28b3b17ef..a758caa9d40 100644
--- a/dlls/vbscript/vbscript.c
+++ b/dlls/vbscript/vbscript.c
@@ -93,6 +93,8 @@ static inline BOOL is_started(VBScript *This)
         || This->state == SCRIPTSTATE_DISCONNECTED;
 }
 
+static HRESULT retrieve_named_item_disp(IActiveScriptSite *site, named_item_t *item);
+
 HRESULT exec_global_code(script_ctx_t *ctx, vbscode_t *code, VARIANT *res, BOOL extern_caller)
 {
     ScriptDisp *obj = ctx->script_obj;
@@ -138,6 +140,61 @@ HRESULT exec_global_code(script_ctx_t *ctx, vbscode_t *code, VARIANT *res, BOOL
         obj->global_funcs_size = cnt;
     }
 
+    /* For visible named items, the first exec_global_code with top-level
+       declarations release-and-refetches the host dispatch, then probes
+       each declared name (Dim variables, Subs, Functions, Classes) via
+       GetIDsOfNames. Subsequent parses reuse the cache. Names are always
+       declared regardless of whether they exist on the host dispatch.
+       TODO: It is unclear why Windows refetches the host dispatch on the
+       first declaration when the result is not used to skip name
+       creation. Perhaps it is used for some side effect or diagnostic
+       purpose that we have not yet identified. */
+    if(code->named_item && !(code->named_item->flags & SCRIPTITEM_CODEONLY)
+       && (code->main_code.var_cnt || code->funcs || code->classes))
+    {
+        if(!code->named_item->dim_disp_probed) {
+            if(code->named_item->disp) {
+                IDispatch_Release(code->named_item->disp);
+                code->named_item->disp = NULL;
+            }
+            retrieve_named_item_disp(ctx->site, code->named_item);
+            code->named_item->dim_disp_probed = TRUE;
+        }
+    }
+
+    if(code->named_item && code->named_item->disp
+       && !(code->named_item->flags & SCRIPTITEM_CODEONLY))
+    {
+        class_desc_t *class_iter;
+
+        /* Probe top-level declared names (Dim vars, Subs/Functions,
+           Classes) on the host dispatch. */
+        for (i = 0; i < code->main_code.var_cnt; i++) {
+            BSTR name = SysAllocString(code->main_code.vars[i].name);
+            if(name) {
+                DISPID id;
+                disp_get_id(code->named_item->disp, name, VBDISP_CALLGET, TRUE, &id);
+                SysFreeString(name);
+            }
+        }
+        for (func_iter = code->funcs; func_iter; func_iter = func_iter->next) {
+            BSTR name = SysAllocString(func_iter->name);
+            if(name) {
+                DISPID id;
+                disp_get_id(code->named_item->disp, name, VBDISP_CALLGET, TRUE, &id);
+                SysFreeString(name);
+            }
+        }
+        for (class_iter = code->classes; class_iter; class_iter = class_iter->next) {
+            BSTR name = SysAllocString(class_iter->name);
+            if(name) {
+                DISPID id;
+                disp_get_id(code->named_item->disp, name, VBDISP_CALLGET, TRUE, &id);
+                SysFreeString(name);
+            }
+        }
+    }
+
     for (i = 0; i < code->main_code.var_cnt; i++)
     {
         if (script_disp_find_var(obj, code->main_code.vars[i].name))
@@ -869,6 +926,7 @@ static HRESULT WINAPI VBScript_AddNamedItem(IActiveScript *iface, LPCOLESTR pstr
     item->disp = disp;
     item->flags = dwFlags;
     item->script_obj = NULL;
+    item->dim_disp_probed = FALSE;
     item->name = wcsdup(pstrName);
     if(!item->name) {
         if(disp)
diff --git a/dlls/vbscript/vbscript.h b/dlls/vbscript/vbscript.h
index 1420e2da0d1..b0a674cc67f 100644
--- a/dlls/vbscript/vbscript.h
+++ b/dlls/vbscript/vbscript.h
@@ -163,6 +163,7 @@ typedef struct named_item_t {
     unsigned ref;
     DWORD flags;
     LPWSTR name;
+    BOOL dim_disp_probed;
 
     struct list entry;
 } named_item_t;
-- 
GitLab


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

[PATCH v20 2/2] vbscript/tests: Cover host-dispatch probing for top-level declarations.

[Francis De Brabandere]

From: Francis De Brabandere <[e-mail]>

Native VBScript calls GetIDsOfNames once per top-level declared name
(Dim variable, Sub, Function, Class). Cover Dim, Sub, Function, and
Class shapes plus a multi-Dim and dim+sub combination, asserting the
exact host probe count for each.
---
 dlls/vbscript/tests/vbscript.c | 88 +++++++++++++++++++++++++++++++++-
 1 file changed, 86 insertions(+), 2 deletions(-)

diff --git a/dlls/vbscript/tests/vbscript.c b/dlls/vbscript/tests/vbscript.c
index 7500ec30a8d..2e2bbef2a1b 100644
--- a/dlls/vbscript/tests/vbscript.c
+++ b/dlls/vbscript/tests/vbscript.c
@@ -2088,8 +2088,8 @@ static void test_named_items(void)
     hres = IActiveScriptParse_ParseScriptText(parse, L"dim abc\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
     ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
     CHECK_CALLED(OnEnterScript);
-    todo_wine CHECK_CALLED(GetItemInfo_visible);
-    todo_wine CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(GetItemInfo_visible);
+    CHECK_CALLED(GetIDsOfNames_visible);
     CHECK_CALLED(OnLeaveScript);
     SET_EXPECT(OnEnterScript);
     SET_EXPECT(OnLeaveScript);
@@ -2113,6 +2113,90 @@ static void test_named_items(void)
     CHECK_CALLED(OnEnterScript);
     CHECK_CALLED(OnLeaveScript);
 
+    /* Probe: multiple names in a single Dim statement. Each name should
+     * be probed against the host dispatch via GetIDsOfNames. The host
+     * dispatch is already cached from the earlier "dim abc" parse, so
+     * GetItemInfo is not refetched. */
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT_MULTI(GetIDsOfNames_visible, 3);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"dim probe_a, probe_b, probe_c\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED_MULTI(GetIDsOfNames_visible, 3);
+    CHECK_CALLED(OnLeaveScript);
+
+    /* Probe: Dim with explicit array bounds. */
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"dim probe_arr(5)\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
+    /* Native probes the host with GetIDsOfNames once per top-level
+     * declared name, which includes bare Subs, Functions, and Classes
+     * (in addition to Dim variables). Inner Dims inside a Sub body are
+     * not probed. */
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"sub probe_sub\ndim probe_local\nend sub\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"class probe_cls\npublic probe_prop\nend class\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"sub probe_named_sub\nend sub\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"function probe_fn\nend function\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT_MULTI(GetIDsOfNames_visible, 2);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"dim probe_top\nsub probe_s3\nend sub\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED_MULTI(GetIDsOfNames_visible, 2);
+    CHECK_CALLED(OnLeaveScript);
+
+    /* Probe: a second top-level Dim parse on the same named item. The
+     * host dispatch is already cached, so GetItemInfo should not fire
+     * a second time. */
+    SET_EXPECT(OnEnterScript);
+    SET_EXPECT(GetIDsOfNames_visible);
+    SET_EXPECT(OnLeaveScript);
+    hres = IActiveScriptParse_ParseScriptText(parse, L"dim probe_second\n", L"visibleItem", NULL, NULL, 0, 0, 0, NULL, NULL);
+    ok(hres == S_OK, "ParseScriptText failed: %08lx\n", hres);
+    CHECK_CALLED(OnEnterScript);
+    CHECK_CALLED(GetIDsOfNames_visible);
+    CHECK_CALLED(OnLeaveScript);
+
     SET_EXPECT(OnEnterScript);
     SET_EXPECT(OnLeaveScript);
     hres = IActiveScriptParse_ParseScriptText(parse, L"set global_me = me\n", L"globalItem", NULL, NULL, 0, 0, SCRIPTTEXT_ISPERSISTENT, NULL, NULL);
-- 
GitLab

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