[PATCH v3 0/3] MR10039: comctl32: Fix the bug when the cInitial is too large which lead to CreateDIBSection fails.
When I was porting a software from windows, I met a problem that the icons in the imagelist were not displaying correctly. In the Application, the correct icons are: {width=269 height=29} But when I run it under wine is like this: {width=271 height=29} When I disassable the application code I found that the Application calls ImageList_Create by given a very large cInitial, which is 0xc0c0c0. This will lead to CreateDIBSection fail. Then the source hbitmap is lost, only hMask is left and shown up on the screen. I use windbg to debug this application on windows, I found that after ImageList_Create is called on Winodws, there is a valid hbitmap handle generated. When ImageList_Add is called for 4 times, it changed and called Bitblt to copy the hbitmap already added. So I guess windows has the error handling for ImageList_Create. If CreateDIBSection failes due to the large image count, it reduced the image count. By observing the action in ImageList_Add, I think the reduced count is 1 (4x1). Then fix the cMaxImage to 1+1 which is same as ImageListImpl_Initialize to make the hbitmap expand. The example in the attachment can reproduce this bug. [imagelist.7z](/uploads/b5f7013fa9383c00bbbc38f82383ff1a/imagelist.7z) -- v3: comctl32: Fix the bug when the cInitial is too large which lead to CreateDIBSection fails. https://gitlab.winehq.org/wine/wine/-/merge_requests/10039
From: Kun Yang <yangkun@uniontech.com> Logs: When CreateDIBSection does not return a valid hbitmap, the source image is lost that only masked icon is shown in imagelist. Signed-off-by: Kun Yang <yangkun@uniontech.com> --- dlls/comctl32/imagelist.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/dlls/comctl32/imagelist.c b/dlls/comctl32/imagelist.c index 93c502ec0bd..443078600e4 100644 --- a/dlls/comctl32/imagelist.c +++ b/dlls/comctl32/imagelist.c @@ -3088,6 +3088,15 @@ static HBITMAP ImageList_CreateImage(HDC hdc, HIMAGELIST himl, UINT count) } } hbmNewBitmap = CreateDIBSection(hdc, bmi, DIB_RGB_COLORS, NULL, 0, 0); + if(!hbmNewBitmap) + { + UINT newImageCount = 1; + //if CreateDIBSection failed, allocate for 1 image only. + bmi->bmiHeader.biHeight = newImageCount * himl->cy; + hbmNewBitmap = CreateDIBSection(hdc, bmi, DIB_RGB_COLORS, NULL, 0, 0); + //the max image count is set to 2, expand when exceeded. + himl->cMaxImage = newImageCount + 1; + } } else /*if (ilc == ILC_COLORDDB)*/ { -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/10039
From: Kun Yang <yangkun@uniontech.com> Logs: When CreateDIBSection does not return a valid hbitmap, the source image is lost that only masked icon is shown in imagelist. Signed-off-by: Kun Yang <yangkun@uniontech.com> --- dlls/comctl32/tests/imagelist.c | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/dlls/comctl32/tests/imagelist.c b/dlls/comctl32/tests/imagelist.c index c8a1a25b71d..2d885975f8f 100644 --- a/dlls/comctl32/tests/imagelist.c +++ b/dlls/comctl32/tests/imagelist.c @@ -2207,6 +2207,11 @@ static void test_create_destroy(void) INT cx, cy; BOOL rc; INT ret; + HDC hdc; + HBITMAP hbm; + BITMAPINFO bmi; + void *bits; + IMAGEINFO info; /* list with zero or negative image dimensions */ himl = pImageList_Create(0, 0, ILC_COLOR16, 0, 3); @@ -2263,6 +2268,23 @@ static void test_create_destroy(void) ok(himl == NULL, "got %p\n", himl); himl = pImageList_Create(1, -1, ILC_COLORDDB, 4, 4); ok(himl == NULL, "got %p\n", himl); + + /* Test create large cInitial image count */ + himl = pImageList_Create(32, 32, ILC_COLOR32 | ILC_MASK, 0xc0c0c0, 1); + hdc = CreateCompatibleDC(NULL); + memset(&bmi, 0, sizeof(bmi)); + bmi.bmiHeader.biSize = sizeof(bmi.bmiHeader); + bmi.bmiHeader.biWidth = 32; + bmi.bmiHeader.biHeight = -32; + bmi.bmiHeader.biPlanes = 1; + bmi.bmiHeader.biBitCount = 32; + bmi.bmiHeader.biCompression = BI_RGB; + hbm = CreateDIBSection(hdc, &bmi, DIB_RGB_COLORS, &bits, NULL, 0); + ret = pImageList_AddMasked(himl, hbm, RGB(0, 0, 0)); + ret = pImageList_GetImageInfo(himl, 0, &info); + ok(ret, "got %d\n", ret); + ok(info.hbmImage != NULL, "got %p\n", info.hbmImage); + ok(info.hbmMask != NULL, "got %p\n", info.hbmMask); } static void check_color_table(const char *name, HDC hdc, HIMAGELIST himl, UINT ilc, -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/10039
From: Kun Yang <yangkun@uniontech.com> Logs: When CreateDIBSection does not return a valid hbitmap, the source image is lost that only masked icon is shown in imagelist. Signed-off-by: Kun Yang <yangkun@uniontech.com> --- dlls/comctl32/imagelist.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dlls/comctl32/imagelist.c b/dlls/comctl32/imagelist.c index 443078600e4..978aeaa7755 100644 --- a/dlls/comctl32/imagelist.c +++ b/dlls/comctl32/imagelist.c @@ -3091,10 +3091,10 @@ static HBITMAP ImageList_CreateImage(HDC hdc, HIMAGELIST himl, UINT count) if(!hbmNewBitmap) { UINT newImageCount = 1; - //if CreateDIBSection failed, allocate for 1 image only. + /*if CreateDIBSection failed, allocate for 1 image only.*/ bmi->bmiHeader.biHeight = newImageCount * himl->cy; hbmNewBitmap = CreateDIBSection(hdc, bmi, DIB_RGB_COLORS, NULL, 0, 0); - //the max image count is set to 2, expand when exceeded. + /*the max image count is set to 2, expand when exceeded.*/ himl->cMaxImage = newImageCount + 1; } } -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/10039
@zhiyi 我已经更新了，我认为wine test只能测试一些对于windows可见的接口校验，这个问题由于HIMAGELIST是不公开的，因此在wine中接口层不能简单地判断出错误，我通过ImageList_GetImageInfo来获取其中的hbitmap来判断，因为错误的实例中hbitmap为空，导致只显示掩码。最直观的问题展示还是绘制到窗口之后。关于cMaxImage的个数，是根据wine原先的逻辑，由于初始给的很大，就不会在Imagelist_Add中溢出从而增长，导致在这个修改下只有4个图标是正常的，而设置为2是沿用了init中的逻辑，当前图像个数+1，所以超出这个范围可以正常更新，我认为这个部分不太好用wine test进行测试。 (I have updated the code. I believe wine test can only validate some interface checks that are visible to Windows app. This issue arises because HIMAGELIST is not publicly exposed, making it difficult for the interface layer in Wine to simply detect errors. To work around this, I used ImageList_GetImageInfo to retrieve the hbitmap for validation, as in erroneous instances the hbitmap is null, resulting in only the mask being displayed. The most straightforward way to observe the problem is still after rendering to the window. Regarding the count of cMaxImage, it follows Wine's original logic. Since the initial allocation is large enough, it prevents overflow and subsequent resizing during ImageList_Add, which under this modification would cause only 4 icons to display correctly. Setting it to 2 aligns with the initialization logic—current image count + 1—so exceeding this range allows for proper updates. I think this part is not very suitable for testing via Wine tests.) -- https://gitlab.winehq.org/wine/wine/-/merge_requests/10039#note_128961
On Fri Feb 6 10:25:55 2026 +0000, Kun Yang wrote:
@zhiyi 我已经更新了，我认为wine test只能测试一些对于windows可见的接口校验，这个问题由于HIMAGELIST是不公开的，因此在wine中接口层不能简单地判断出错误，我通过ImageList_GetImageInfo来获取其中的hbitmap来判断，因为错误的实例中hbitmap为空，导致只显示掩码。最直观的问题展示还是绘制到窗口之后。关于cMaxImage的个数，是根据wine原先的逻辑，由于初始给的很大，就不会在Imagelist_Add中溢出从而增长，导致在这个修改下只有4个图标是正常的，而设置为2是沿用了init中的逻辑，当前图像个数+1，所以超出这个范围可以正常更新，我认为这个部分不太好用wine test进行测试。 (I have updated the code. I believe wine test can only validate some interface checks that are visible to Windows app. This issue arises because HIMAGELIST is not publicly exposed, making it difficult for the interface layer in Wine to simply detect errors. To work around this, I used ImageList_GetImageInfo to retrieve the hbitmap for validation, as in erroneous instances the hbitmap is null, resulting in only the mask being displayed. The most straightforward way to observe the problem is still after rendering to the window. Regarding the count of cMaxImage, it follows Wine's original logic. Since the initial allocation is large enough, it prevents overflow and subsequent resizing during ImageList_Add, which under this modification would cause only 4 icons to display correctly. Setting it to 2 aligns with the initialization logic—current image count + 1—so exceeding this range allows for proper updates. I think this part is not very suitable for testing via Wine tests.) Please see wine/dlls/comctl32/imagelist.c#struct _IMAGELIST around line 53
struct _IMAGELIST
{
IImageList2 IImageList2_iface; /* 00: IImageList vtable */
INT cCurImage; /* 04: ImageCount */
INT cMaxImage; /* 08: maximages */
INT cGrow; /* 0C: cGrow */
INT cx; /* 10: cx */
INT cy; /* 14: cy */
Wine has the same structure layout for some fields, including cMaxImage. So you can cast the HIMAGELIST pointer to struct _IMAGELIST on Windows and get the cMaxImage. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/10039#note_128962
participants (3)
-
Kun Yang -
Kun Yang (＠yangkun)
-
Zhiyi Zhang (＠zhiyi)