wined3d: Remove an obsolete comment.
[wine] / dlls / browseui / progressdlg.c
1 /*
2  *      Progress dialog
3  *
4  *      Copyright 2007  Mikolaj Zalewski
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22
23 #include <stdarg.h>
24
25 #define COBJMACROS
26
27 #include "wine/debug.h"
28 #include "windef.h"
29 #include "winbase.h"
30 #include "winreg.h"
31 #include "winuser.h"
32 #include "shlwapi.h"
33 #include "winerror.h"
34 #include "objbase.h"
35
36 #include "shlguid.h"
37 #include "shlobj.h"
38
39 #include "wine/unicode.h"
40
41 #include "browseui.h"
42 #include "resids.h"
43
44 WINE_DEFAULT_DEBUG_CHANNEL(browseui);
45
46 #define CANCEL_MSG_LINE 2
47
48 /* Note: to avoid a deadlock we don't want to send messages to the dialog
49  * with the critical section held. Instead we only mark what fields should be
50  * updated and the dialog proc does the update */
51 #define UPDATE_PROGRESS         0x1
52 #define UPDATE_TITLE            0x2
53 #define UPDATE_LINE1            0x4
54 #define UPDATE_LINE2            (UPDATE_LINE1<<1)
55 #define UPDATE_LINE3            (UPDATE_LINE2<<2)
56
57
58 #define WM_DLG_UPDATE   (WM_APP+1)  /* set to the dialog when it should update */
59 #define WM_DLG_DESTROY  (WM_APP+2)  /* DestroyWindow must be called from the owning thread */
60
61 typedef struct tagProgressDialog {
62     IProgressDialog IProgressDialog_iface;
63     LONG refCount;
64     CRITICAL_SECTION cs;
65     HWND hwnd;
66     DWORD dwFlags;
67     DWORD dwUpdate;
68     LPWSTR lines[3];
69     LPWSTR cancelMsg;
70     LPWSTR title;
71     BOOL isCancelled;
72     ULONGLONG ullCompleted;
73     ULONGLONG ullTotal;
74     HWND hwndDisabledParent;    /* For modal dialog: the parent that need to be re-enabled when the dialog ends */
75 } ProgressDialog;
76
77 static inline ProgressDialog *impl_from_IProgressDialog(IProgressDialog *iface)
78 {
79     return CONTAINING_RECORD(iface, ProgressDialog, IProgressDialog_iface);
80 }
81
82 static void set_buffer(LPWSTR *buffer, LPCWSTR string)
83 {
84     static const WCHAR empty_string[] = {0};
85     IMalloc *malloc;
86     ULONG cb;
87
88     if (string == NULL)
89         string = empty_string;
90     CoGetMalloc(1, &malloc);
91
92     cb = (strlenW(string) + 1)*sizeof(WCHAR);
93     if (*buffer == NULL || cb > IMalloc_GetSize(malloc, *buffer))
94         *buffer = IMalloc_Realloc(malloc, *buffer, cb);
95     memcpy(*buffer, string, cb);
96 }
97
98 struct create_params
99 {
100     ProgressDialog *This;
101     HANDLE hEvent;
102     HWND hwndParent;
103 };
104
105 static LPWSTR load_string(HINSTANCE hInstance, UINT uiResourceId)
106 {
107     WCHAR string[256];
108     LPWSTR ret;
109
110     LoadStringW(hInstance, uiResourceId, string, sizeof(string)/sizeof(string[0]));
111     ret = HeapAlloc(GetProcessHeap(), 0, (strlenW(string) + 1) * sizeof(WCHAR));
112     strcpyW(ret, string);
113     return ret;
114 }
115
116 static void set_progress_marquee(ProgressDialog *This)
117 {
118     HWND hProgress = GetDlgItem(This->hwnd, IDC_PROGRESS_BAR);
119     SetWindowLongW(hProgress, GWL_STYLE,
120         GetWindowLongW(hProgress, GWL_STYLE)|PBS_MARQUEE);
121 }
122
123 static void update_dialog(ProgressDialog *This, DWORD dwUpdate)
124 {
125     WCHAR empty[] = {0};
126
127     if (dwUpdate & UPDATE_TITLE)
128         SetWindowTextW(This->hwnd, This->title);
129
130     if (dwUpdate & UPDATE_LINE1)
131         SetDlgItemTextW(This->hwnd, IDC_TEXT_LINE, (This->isCancelled ? empty : This->lines[0]));
132     if (dwUpdate & UPDATE_LINE2)
133         SetDlgItemTextW(This->hwnd, IDC_TEXT_LINE+1, (This->isCancelled ? empty : This->lines[1]));
134     if (dwUpdate & UPDATE_LINE3)
135         SetDlgItemTextW(This->hwnd, IDC_TEXT_LINE+2, (This->isCancelled ? This->cancelMsg : This->lines[2]));
136
137     if (dwUpdate & UPDATE_PROGRESS)
138     {
139         ULONGLONG ullTotal = This->ullTotal;
140         ULONGLONG ullCompleted = This->ullCompleted;
141
142         /* progress bar requires 32-bit coordinates */
143         while (ullTotal >> 32)
144         {
145             ullTotal >>= 1;
146             ullCompleted >>= 1;
147         }
148
149         SendDlgItemMessageW(This->hwnd, IDC_PROGRESS_BAR, PBM_SETRANGE32, 0, (DWORD)ullTotal);
150         SendDlgItemMessageW(This->hwnd, IDC_PROGRESS_BAR, PBM_SETPOS, (DWORD)ullCompleted, 0);
151     }
152 }
153
154 static void end_dialog(ProgressDialog *This)
155 {
156     SendMessageW(This->hwnd, WM_DLG_DESTROY, 0, 0);
157     /* native doesn't reenable the window? */
158     if (This->hwndDisabledParent)
159         EnableWindow(This->hwndDisabledParent, TRUE);
160     This->hwnd = NULL;
161 }
162
163 static INT_PTR CALLBACK dialog_proc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
164 {
165     ProgressDialog *This = (ProgressDialog *)GetWindowLongPtrW(hwnd, DWLP_USER);
166
167     switch (msg)
168     {
169         case WM_INITDIALOG:
170         {
171             struct create_params *params = (struct create_params *)lParam;
172
173             /* Note: until we set the hEvent, the object is protected by
174              * the critical section held by StartProgress */
175             SetWindowLongPtrW(hwnd, DWLP_USER, (LONG_PTR)params->This);
176             This = params->This;
177             This->hwnd = hwnd;
178
179             if (This->dwFlags & PROGDLG_NOPROGRESSBAR)
180                 ShowWindow(GetDlgItem(hwnd, IDC_PROGRESS_BAR), SW_HIDE);
181             if (This->dwFlags & PROGDLG_NOCANCEL)
182                 ShowWindow(GetDlgItem(hwnd, IDCANCEL), SW_HIDE);
183             if (This->dwFlags & PROGDLG_MARQUEEPROGRESS)
184                 set_progress_marquee(This);
185             if (This->dwFlags & PROGDLG_NOMINIMIZE)
186                 SetWindowLongW(hwnd, GWL_STYLE, GetWindowLongW(hwnd, GWL_STYLE) & (~WS_MINIMIZEBOX));
187
188             update_dialog(This, 0xffffffff);
189             This->dwUpdate = 0;
190             This->isCancelled = FALSE;
191             SetEvent(params->hEvent);
192             return TRUE;
193         }
194
195         case WM_DLG_UPDATE:
196             EnterCriticalSection(&This->cs);
197             update_dialog(This, This->dwUpdate);
198             This->dwUpdate = 0;
199             LeaveCriticalSection(&This->cs);
200             return TRUE;
201
202         case WM_DLG_DESTROY:
203             DestroyWindow(hwnd);
204             PostThreadMessageW(GetCurrentThreadId(), WM_NULL, 0, 0); /* wake up the GetMessage */
205             return TRUE;
206
207         case WM_CLOSE:
208         case WM_COMMAND:
209             if (msg == WM_CLOSE || wParam == IDCANCEL)
210             {
211                 EnterCriticalSection(&This->cs);
212                 This->isCancelled = TRUE;
213
214                 if (!This->cancelMsg)
215                     This->cancelMsg = load_string(BROWSEUI_hinstance, IDS_CANCELLING);
216
217                 set_progress_marquee(This);
218                 EnableWindow(GetDlgItem(This->hwnd, IDCANCEL), FALSE);
219                 update_dialog(This, UPDATE_LINE1|UPDATE_LINE2|UPDATE_LINE3);
220                 LeaveCriticalSection(&This->cs);
221             }
222             return TRUE;
223     }
224     return FALSE;
225 }
226
227 static DWORD WINAPI dialog_thread(LPVOID lpParameter)
228 {
229     /* Note: until we set the hEvent in WM_INITDIALOG, the ProgressDialog object
230      * is protected by the critical section held by StartProgress */
231     struct create_params *params = lpParameter;
232     HWND hwnd;
233     MSG msg;
234
235     hwnd = CreateDialogParamW(BROWSEUI_hinstance, MAKEINTRESOURCEW(IDD_PROGRESS_DLG),
236         params->hwndParent, dialog_proc, (LPARAM)params);
237
238     while (GetMessageW(&msg, NULL, 0, 0) > 0)
239     {
240         if (!IsWindow(hwnd))
241             break;
242         if(!IsDialogMessageW(hwnd, &msg))
243         {
244             TranslateMessage(&msg);
245             DispatchMessageW(&msg);
246         }
247     }
248
249     return 0;
250 }
251
252 static void ProgressDialog_Destructor(ProgressDialog *This)
253 {
254     TRACE("destroying %p\n", This);
255     if (This->hwnd)
256         end_dialog(This);
257     heap_free(This->lines[0]);
258     heap_free(This->lines[1]);
259     heap_free(This->lines[2]);
260     heap_free(This->cancelMsg);
261     heap_free(This->title);
262     heap_free(This);
263     BROWSEUI_refCount--;
264 }
265
266 static HRESULT WINAPI ProgressDialog_QueryInterface(IProgressDialog *iface, REFIID iid, LPVOID *ppvOut)
267 {
268     ProgressDialog *This = impl_from_IProgressDialog(iface);
269     *ppvOut = NULL;
270
271     if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_IProgressDialog))
272     {
273         *ppvOut = This;
274     }
275
276     if (*ppvOut)
277     {
278         IUnknown_AddRef(iface);
279         return S_OK;
280     }
281
282     WARN("unsupported interface: %s\n", debugstr_guid(iid));
283     return E_NOINTERFACE;
284 }
285
286 static ULONG WINAPI ProgressDialog_AddRef(IProgressDialog *iface)
287 {
288     ProgressDialog *This = impl_from_IProgressDialog(iface);
289     return InterlockedIncrement(&This->refCount);
290 }
291
292 static ULONG WINAPI ProgressDialog_Release(IProgressDialog *iface)
293 {
294     ProgressDialog *This = impl_from_IProgressDialog(iface);
295     ULONG ret;
296
297     ret = InterlockedDecrement(&This->refCount);
298     if (ret == 0)
299         ProgressDialog_Destructor(This);
300     return ret;
301 }
302
303 static HRESULT WINAPI ProgressDialog_StartProgressDialog(IProgressDialog *iface, HWND hwndParent, IUnknown *punkEnableModeless, DWORD dwFlags, LPCVOID reserved)
304 {
305     ProgressDialog *This = impl_from_IProgressDialog(iface);
306     struct create_params params;
307     HANDLE hThread;
308
309     TRACE("(%p, %p, %x, %p)\n", iface, punkEnableModeless, dwFlags, reserved);
310     if (punkEnableModeless || reserved)
311         FIXME("Reserved parameters not null (%p, %p)\n", punkEnableModeless, reserved);
312     if (dwFlags & PROGDLG_AUTOTIME)
313         FIXME("Flags PROGDLG_AUTOTIME not supported\n");
314     if (dwFlags & PROGDLG_NOTIME)
315         FIXME("Flags PROGDLG_NOTIME not supported\n");
316
317     EnterCriticalSection(&This->cs);
318
319     if (This->hwnd)
320     {
321         LeaveCriticalSection(&This->cs);
322         return S_OK;  /* as on XP */
323     }
324     This->dwFlags = dwFlags;
325     params.This = This;
326     params.hwndParent = hwndParent;
327     params.hEvent = CreateEventW(NULL, TRUE, FALSE, NULL);
328
329     hThread = CreateThread(NULL, 0, dialog_thread, &params, 0, NULL);
330     WaitForSingleObject(params.hEvent, INFINITE);
331     CloseHandle(params.hEvent);
332     CloseHandle(hThread);
333
334     This->hwndDisabledParent = NULL;
335     if (hwndParent && (dwFlags & PROGDLG_MODAL))
336     {
337         HWND hwndDisable = GetAncestor(hwndParent, GA_ROOT);
338         if (EnableWindow(hwndDisable, FALSE))
339             This->hwndDisabledParent = hwndDisable;
340     }
341
342     LeaveCriticalSection(&This->cs);
343
344     return S_OK;
345 }
346
347 static HRESULT WINAPI ProgressDialog_StopProgressDialog(IProgressDialog *iface)
348 {
349     ProgressDialog *This = impl_from_IProgressDialog(iface);
350
351     EnterCriticalSection(&This->cs);
352     if (This->hwnd)
353         end_dialog(This);
354     LeaveCriticalSection(&This->cs);
355
356     return S_OK;
357 }
358
359 static HRESULT WINAPI ProgressDialog_SetTitle(IProgressDialog *iface, LPCWSTR pwzTitle)
360 {
361     ProgressDialog *This = impl_from_IProgressDialog(iface);
362     HWND hwnd;
363
364     TRACE("(%p, %s)\n", This, wine_dbgstr_w(pwzTitle));
365
366     EnterCriticalSection(&This->cs);
367     set_buffer(&This->title, pwzTitle);
368     This->dwUpdate |= UPDATE_TITLE;
369     hwnd = This->hwnd;
370     LeaveCriticalSection(&This->cs);
371
372     if (hwnd)
373         SendMessageW(hwnd, WM_DLG_UPDATE, 0, 0);
374
375     return S_OK;
376 }
377
378 static HRESULT WINAPI ProgressDialog_SetAnimation(IProgressDialog *iface, HINSTANCE hInstance, UINT uiResourceId)
379 {
380     FIXME("(%p, %p, %d) - stub\n", iface, hInstance, uiResourceId);
381     return S_OK;
382 }
383
384 static BOOL WINAPI ProgressDialog_HasUserCancelled(IProgressDialog *iface)
385 {
386     ProgressDialog *This = impl_from_IProgressDialog(iface);
387     return This->isCancelled;
388 }
389
390 static HRESULT WINAPI ProgressDialog_SetProgress64(IProgressDialog *iface, ULONGLONG ullCompleted, ULONGLONG ullTotal)
391 {
392     ProgressDialog *This = impl_from_IProgressDialog(iface);
393     HWND hwnd;
394
395     TRACE("(%p, 0x%s, 0x%s)\n", This, wine_dbgstr_longlong(ullCompleted), wine_dbgstr_longlong(ullTotal));
396
397     EnterCriticalSection(&This->cs);
398     This->ullTotal = ullTotal;
399     This->ullCompleted = ullCompleted;
400     This->dwUpdate |= UPDATE_PROGRESS;
401     hwnd = This->hwnd;
402     LeaveCriticalSection(&This->cs);
403
404     if (hwnd)
405         SendMessageW(hwnd, WM_DLG_UPDATE, 0, 0);
406
407     return S_OK;  /* Windows sometimes returns S_FALSE */
408 }
409
410 static HRESULT WINAPI ProgressDialog_SetProgress(IProgressDialog *iface, DWORD dwCompleted, DWORD dwTotal)
411 {
412     return IProgressDialog_SetProgress64(iface, dwCompleted, dwTotal);
413 }
414
415 static HRESULT WINAPI ProgressDialog_SetLine(IProgressDialog *iface, DWORD dwLineNum, LPCWSTR pwzLine, BOOL bPath, LPCVOID reserved)
416 {
417     ProgressDialog *This = impl_from_IProgressDialog(iface);
418     HWND hwnd;
419
420     TRACE("(%p, %d, %s, %d)\n", This, dwLineNum, wine_dbgstr_w(pwzLine), bPath);
421
422     if (reserved)
423         FIXME("reserved pointer not null (%p)\n", reserved);
424
425     dwLineNum--;
426     if (dwLineNum >= 3)  /* Windows seems to do something like that */
427         dwLineNum = 0;
428
429     EnterCriticalSection(&This->cs);
430     set_buffer(&This->lines[dwLineNum], pwzLine);
431     This->dwUpdate |= UPDATE_LINE1 << dwLineNum;
432     hwnd = (This->isCancelled ? NULL : This->hwnd); /* no sense to send the message if window cancelled */
433     LeaveCriticalSection(&This->cs);
434
435     if (hwnd)
436         SendMessageW(hwnd, WM_DLG_UPDATE, 0, 0);
437
438     return S_OK;
439 }
440
441 static HRESULT WINAPI ProgressDialog_SetCancelMsg(IProgressDialog *iface, LPCWSTR pwzMsg, LPCVOID reserved)
442 {
443     ProgressDialog *This = impl_from_IProgressDialog(iface);
444     HWND hwnd;
445
446     TRACE("(%p, %s)\n", This, wine_dbgstr_w(pwzMsg));
447
448     if (reserved)
449         FIXME("reserved pointer not null (%p)\n", reserved);
450
451     EnterCriticalSection(&This->cs);
452     set_buffer(&This->cancelMsg, pwzMsg);
453     This->dwUpdate |= UPDATE_LINE1 << CANCEL_MSG_LINE;
454     hwnd = (This->isCancelled ? This->hwnd : NULL); /* no sense to send the message if window not cancelled */
455     LeaveCriticalSection(&This->cs);
456
457     if (hwnd)
458         SendMessageW(hwnd, WM_DLG_UPDATE, 0, 0);
459
460     return S_OK;
461 }
462
463 static HRESULT WINAPI ProgressDialog_Timer(IProgressDialog *iface, DWORD dwTimerAction, LPCVOID reserved)
464 {
465     ProgressDialog *This = impl_from_IProgressDialog(iface);
466
467     FIXME("(%p, %d, %p) - stub\n", This, dwTimerAction, reserved);
468
469     if (reserved)
470         FIXME("Reserved field not NULL but %p\n", reserved);
471
472     return S_OK;
473 }
474
475 static const IProgressDialogVtbl ProgressDialogVtbl =
476 {
477     ProgressDialog_QueryInterface,
478     ProgressDialog_AddRef,
479     ProgressDialog_Release,
480
481     ProgressDialog_StartProgressDialog,
482     ProgressDialog_StopProgressDialog,
483     ProgressDialog_SetTitle,
484     ProgressDialog_SetAnimation,
485     ProgressDialog_HasUserCancelled,
486     ProgressDialog_SetProgress,
487     ProgressDialog_SetProgress64,
488     ProgressDialog_SetLine,
489     ProgressDialog_SetCancelMsg,
490     ProgressDialog_Timer
491 };
492
493 HRESULT ProgressDialog_Constructor(IUnknown *pUnkOuter, IUnknown **ppOut)
494 {
495     ProgressDialog *This;
496     if (pUnkOuter)
497         return CLASS_E_NOAGGREGATION;
498
499     This = heap_alloc_zero(sizeof(ProgressDialog));
500     if (This == NULL)
501         return E_OUTOFMEMORY;
502
503     This->IProgressDialog_iface.lpVtbl = &ProgressDialogVtbl;
504     This->refCount = 1;
505     InitializeCriticalSection(&This->cs);
506
507     TRACE("returning %p\n", This);
508     *ppOut = (IUnknown *)This;
509     BROWSEUI_refCount++;
510     return S_OK;
511 }