Allow more customization of control ids in thmutil.

Allow BAFunctions to set control ids. Make sure control ids don't collide.
author: Sean Hall <r.sean.hall@gmail.com> 2021-10-27 13:55:16 -0500
committer: Sean Hall <r.sean.hall@gmail.com> 2021-11-01 16:34:09 -0500
commit: 8fa040da9d0d3826f5ffda6bcbec4f53abd97452 (patch)
tree: a8a1094f3ac17bd6feed8a6f971c0d6008694345 /src/libs
parent: 4917383e6f52f0e44f63c60a645f1dd7e8f8d5f9 (diff)
download: wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.tar.gz
wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.tar.bz2
wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.zip
2 files changed, 81 insertions, 29 deletions
diff --git a/src/libs/dutil/WixToolset.DUtil/inc/thmutil.h b/src/libs/dutil/WixToolset.DUtil/inc/thmutil.h
index 6ac3711f..dc554219 100644
--- a/src/libs/dutil/WixToolset.DUtil/inc/thmutil.h
+++ b/src/libs/dutil/WixToolset.DUtil/inc/thmutil.h
@@ -95,6 +95,15 @@ typedef enum THEME_WINDOW_INITIAL_POSITION
    THEME_WINDOW_INITIAL_POSITION_CENTER_MONITOR_FROM_COORDINATES,
 } THEME_WINDOW_INITIAL_POSITION;
+// These messages are sent by thmutil to the parent window created in ThemeCreateParentWindow.
+// thmutil reserves the last values of WM_USER's range.
+typedef enum _WM_THMUTIL
+{
+    // Sent while creating a control.
+    // wparam is THEME_LOADINGCONTROL_ARGS* and lparam is THEME_LOADINGCONTROL_RESULTS*.
+    // Return code is TRUE if it was processed.
+    WM_THMUTIL_LOADING_CONTROL = WM_APP - 1,
+} WM_THMUTIL;
 struct THEME_COLUMN
 {
@@ -171,7 +180,7 @@ struct THEME_ASSIGN_CONTROL_ID
    LPCWSTR wzName; // name of control to match
 };
-const DWORD THEME_FIRST_ASSIGN_CONTROL_ID = 1024; // Recommended first control id to be assigned.
+const WORD THEME_FIRST_ASSIGN_CONTROL_ID = 0x4000; // Recommended first control id to be assigned.
 struct THEME_CONTROL
 {
@@ -325,7 +334,7 @@ struct THEME_FONT
 struct THEME
 {
-    WORD wId;
+    WORD wNextControlId;
    BOOL fAutoResize;
    BOOL fForceResize;
@@ -388,6 +397,24 @@ struct THEME
    LPVOID pvVariableContext;
 };
+typedef struct _THEME_LOADINGCONTROL_ARGS
+{
+    DWORD cbSize;
+    const THEME_CONTROL* pThemeControl;
+} THEME_LOADINGCONTROL_ARGS;
+typedef struct _THEME_LOADINGCONTROL_RESULTS
+{
+    DWORD cbSize;
+    HRESULT hr;
+    // Used to apply a specific id to the control (usually used for WM_COMMAND).
+    // If assigning an id, it is recommended to start with THEME_FIRST_ASSIGN_CONTROL_ID to avoid collisions with well known ids such as IDOK and IDCANCEL.
+    // The values [100, THEME_FIRST_ASSIGN_CONTROL_ID) are reserved for thmutil.
+    // Due to this value being packed into 16 bits for many system window messages, this is restricted to a WORD.
+    WORD wId;
+} THEME_LOADINGCONTROL_RESULTS;
 /********************************************************************
 ThemeInitialize - initialized theme management.
@@ -472,9 +499,7 @@ HRESULT DAPI ThemeCreateParentWindow(
 *******************************************************************/
 HRESULT DAPI ThemeLoadControls(
-    __in THEME* pTheme,
+    __in THEME* pTheme
-    __in_ecount_opt(cAssignControlIds) const THEME_ASSIGN_CONTROL_ID* rgAssignControlIds,
-    __in DWORD cAssignControlIds
    );
 /********************************************************************
diff --git a/src/libs/dutil/WixToolset.DUtil/thmutil.cpp b/src/libs/dutil/WixToolset.DUtil/thmutil.cpp
index 53257d8e..d796bbaf 100644
--- a/src/libs/dutil/WixToolset.DUtil/thmutil.cpp
+++ b/src/libs/dutil/WixToolset.DUtil/thmutil.cpp
@@ -39,6 +39,7 @@
 #define LWS_NOPREFIX        0x0004
 #endif
+const WORD THEME_FIRST_AUTO_ASSIGN_CONTROL_ID = 100;
 const DWORD THEME_INVALID_ID = 0xFFFFFFFF;
 const COLORREF THEME_INVISIBLE_COLORREF = 0xFFFFFFFF;
 const DWORD GROW_FONT_INSTANCES = 3;
@@ -272,11 +273,14 @@ static HRESULT FindImageList(
    __in_z LPCWSTR wzImageListName,
    __out HIMAGELIST *phImageList
    );
+static HRESULT OnLoadingControl(
+    __in THEME* pTheme,
+    __in const THEME_CONTROL* pControl,
+    __inout WORD* pwId
+    );
 static HRESULT LoadControls(
    __in THEME* pTheme,
-    __in_opt THEME_CONTROL* pParentControl,
+    __in_opt THEME_CONTROL* pParentControl
-    __in_ecount_opt(cAssignControlIds) const THEME_ASSIGN_CONTROL_ID* rgAssignControlIds,
-    __in DWORD cAssignControlIds
    );
 static HRESULT ShowControl(
    __in THEME* pTheme,
@@ -871,9 +875,7 @@ LExit:
 DAPI_(HRESULT) ThemeLoadControls(
-    __in THEME* pTheme,
+    __in THEME* pTheme
-    __in_ecount_opt(cAssignControlIds) const THEME_ASSIGN_CONTROL_ID* rgAssignControlIds,
-    __in DWORD cAssignControlIds
    )
 {
    HRESULT hr = S_OK;
@@ -883,7 +885,7 @@ DAPI_(HRESULT) ThemeLoadControls(
        ThmExitOnFailure(hr = E_INVALIDSTATE, "ThemeLoadControls called before theme parent window created.");
    }
-    hr = LoadControls(pTheme, NULL, rgAssignControlIds, cAssignControlIds);
+    hr = LoadControls(pTheme, NULL);
 LExit:
    return hr;
@@ -1844,8 +1846,6 @@ static HRESULT ParseTheme(
    __out THEME** ppTheme
    )
 {
-    static WORD wThemeId = 0;
    HRESULT hr = S_OK;
    THEME* pTheme = NULL;
    IXMLDOMElement *pThemeElement = NULL;
@@ -1858,8 +1858,8 @@ static HRESULT ParseTheme(
    pTheme = static_cast<THEME*>(MemAlloc(sizeof(THEME), TRUE));
    ThmExitOnNull(pTheme, hr, E_OUTOFMEMORY, "Failed to allocate memory for theme.");
-    pTheme->wId = ++wThemeId;
    pTheme->nDpi = USER_DEFAULT_SCREEN_DPI;
+    pTheme->wNextControlId = THEME_FIRST_AUTO_ASSIGN_CONTROL_ID;
    // Parse the optional background resource image.
    hr = GetAttributeImageFileOrResource(hModule, wzRelativePath, pThemeElement, &pBitmap);
@@ -5248,7 +5248,7 @@ static BOOL OnButtonClicked(
 LExit:
    return fHandled;
 }
-    
 static BOOL OnDpiChanged(
    __in THEME* pTheme,
    __in WPARAM wParam,
@@ -5934,11 +5934,38 @@ static LRESULT CALLBACK StaticOwnerDrawWndProc(
    }
 }
+static HRESULT OnLoadingControl(
+    __in THEME* pTheme,
+    __in const THEME_CONTROL* pControl,
+    __inout WORD* pwId
+    )
+{
+    HRESULT hr = S_OK;
+    THEME_LOADINGCONTROL_ARGS loadingControlArgs = { };
+    THEME_LOADINGCONTROL_RESULTS loadingControlResults = { };
+    loadingControlArgs.cbSize = sizeof(loadingControlArgs);
+    loadingControlArgs.pThemeControl = pControl;
+    loadingControlResults.cbSize = sizeof(loadingControlResults);
+    loadingControlResults.hr = E_NOTIMPL;
+    loadingControlResults.wId = *pwId;
+    if (::SendMessageW(pTheme->hwndParent, WM_THMUTIL_LOADING_CONTROL, reinterpret_cast<WPARAM>(&loadingControlArgs), reinterpret_cast<LPARAM>(&loadingControlResults)))
+    {
+        hr = loadingControlResults.hr;
+        if (SUCCEEDED(hr))
+        {
+            *pwId = loadingControlResults.wId;
+        }
+    }
+    return hr;
+}
 static HRESULT LoadControls(
    __in THEME* pTheme,
-    __in_opt THEME_CONTROL* pParentControl,
+    __in_opt THEME_CONTROL* pParentControl
-    __in_ecount_opt(cAssignControlIds) const THEME_ASSIGN_CONTROL_ID* rgAssignControlIds,
-    __in DWORD cAssignControlIds
    )
 {
    HRESULT hr = S_OK;
@@ -6101,16 +6128,16 @@ static HRESULT LoadControls(
        }
        ThmExitOnNull(wzWindowClass, hr, E_INVALIDDATA, "Failed to configure control %u because of unknown type: %u", i, pControl->type);
-        // Default control ids to the theme id and its index in the control array, unless there
+        // Default control ids to the next id, unless there is a specific id to assign to a control.
-        // is a specific id to assign to a named control.
+        WORD wControlId = THEME_FIRST_AUTO_ASSIGN_CONTROL_ID;
-        WORD wControlId = MAKEWORD(i, pTheme->wId);
+        hr = OnLoadingControl(pTheme, pControl, &wControlId);
-        for (DWORD iAssignControl = 0; pControl->sczName && iAssignControl < cAssignControlIds; ++iAssignControl)
+        ThmExitOnFailure(hr, "ThmLoadingControl failed.");
+        // This range is reserved for thmutil. The process will run out of available window handles before reaching the end of the range.
+        if (THEME_FIRST_AUTO_ASSIGN_CONTROL_ID <= wControlId && THEME_FIRST_ASSIGN_CONTROL_ID > wControlId)
        {
-            if (CSTR_EQUAL == ::CompareStringW(LOCALE_NEUTRAL, 0, pControl->sczName, -1, rgAssignControlIds[iAssignControl].wzName, -1))
+            wControlId = pTheme->wNextControlId;
-            {
+            pTheme->wNextControlId += 1;
-                wControlId = rgAssignControlIds[iAssignControl].wId;
-                break;
-            }
        }
        pControl->wId = wControlId;
@@ -6296,7 +6323,7 @@ static HRESULT LoadControls(
        if (pControl->cControls)
        {
-            hr = LoadControls(pTheme, pControl, rgAssignControlIds, cAssignControlIds);
+            hr = LoadControls(pTheme, pControl);
            ThmExitOnFailure(hr, "Failed to load child controls.");
        }
    }
author	Sean Hall <r.sean.hall@gmail.com>	2021-10-27 13:55:16 -0500
committer	Sean Hall <r.sean.hall@gmail.com>	2021-11-01 16:34:09 -0500
commit	8fa040da9d0d3826f5ffda6bcbec4f53abd97452 (patch)
tree	a8a1094f3ac17bd6feed8a6f971c0d6008694345 /src/libs
parent	4917383e6f52f0e44f63c60a645f1dd7e8f8d5f9 (diff)
download	wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.tar.gz wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.tar.bz2 wix-8fa040da9d0d3826f5ffda6bcbec4f53abd97452.zip