1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/app.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
23 #if defined(__BORLANDC__)
28 #include "wx/msw/wrapcctl.h"
29 #include "wx/dynarray.h"
33 #include "wx/gdicmn.h"
36 #include "wx/cursor.h"
38 #include "wx/palette.h"
40 #include "wx/dialog.h"
41 #include "wx/msgdlg.h"
45 #include "wx/module.h"
48 #include "wx/apptrait.h"
49 #include "wx/filename.h"
50 #include "wx/dynlib.h"
51 #include "wx/evtloop.h"
52 #include "wx/thread.h"
54 #include "wx/msw/private.h"
55 #include "wx/msw/dc.h"
56 #include "wx/msw/ole/oleutils.h"
57 #include "wx/msw/private/timer.h"
60 #include "wx/tooltip.h"
61 #endif // wxUSE_TOOLTIPS
63 // OLE is used for drag-and-drop, clipboard, OLE Automation..., but some
64 // compilers don't support it (missing headers, libs, ...)
65 #if defined(__GNUWIN32_OLD__) || defined(__SYMANTEC__)
69 #endif // broken compilers
71 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
83 #include "wx/msw/missing.h"
85 // instead of including <shlwapi.h> which is not part of the core SDK and not
86 // shipped at all with other compilers, we always define the parts of it we
87 // need here ourselves
89 // NB: DLLVER_PLATFORM_WINDOWS will be defined if shlwapi.h had been somehow
91 #ifndef DLLVER_PLATFORM_WINDOWS
92 // hopefully we don't need to change packing as DWORDs should be already
97 DWORD dwMajorVersion
; // Major version
98 DWORD dwMinorVersion
; // Minor version
99 DWORD dwBuildNumber
; // Build number
100 DWORD dwPlatformID
; // DLLVER_PLATFORM_*
103 typedef HRESULT (CALLBACK
* DLLGETVERSIONPROC
)(DLLVERSIONINFO
*);
104 #endif // defined(DLLVERSIONINFO)
107 // ---------------------------------------------------------------------------
109 // ---------------------------------------------------------------------------
111 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
112 extern void wxSetKeyboardHook(bool doIt
);
115 // NB: all "NoRedraw" classes must have the same names as the "normal" classes
116 // with NR suffix - wxWindow::MSWCreate() supposes this
118 WXDLLIMPEXP_CORE wxChar
*wxCanvasClassName
;
119 WXDLLIMPEXP_CORE wxChar
*wxCanvasClassNameNR
;
121 WXDLLIMPEXP_CORE
const wxChar
*wxCanvasClassName
= wxT("wxWindowClass");
122 WXDLLIMPEXP_CORE
const wxChar
*wxCanvasClassNameNR
= wxT("wxWindowClassNR");
124 WXDLLIMPEXP_CORE
const wxChar
*wxMDIFrameClassName
= wxT("wxMDIFrameClass");
125 WXDLLIMPEXP_CORE
const wxChar
*wxMDIFrameClassNameNoRedraw
= wxT("wxMDIFrameClassNR");
126 WXDLLIMPEXP_CORE
const wxChar
*wxMDIChildFrameClassName
= wxT("wxMDIChildFrameClass");
127 WXDLLIMPEXP_CORE
const wxChar
*wxMDIChildFrameClassNameNoRedraw
= wxT("wxMDIChildFrameClassNR");
129 // ----------------------------------------------------------------------------
131 // ----------------------------------------------------------------------------
133 LRESULT WXDLLEXPORT APIENTRY
wxWndProc(HWND
, UINT
, WPARAM
, LPARAM
);
135 // ===========================================================================
136 // wxGUIAppTraits implementation
137 // ===========================================================================
139 // private class which we use to pass parameters from BeforeChildWaitLoop() to
140 // AfterChildWaitLoop()
141 struct ChildWaitLoopData
143 ChildWaitLoopData(wxWindowDisabler
*wd_
, wxWindow
*winActive_
)
146 winActive
= winActive_
;
149 wxWindowDisabler
*wd
;
153 void *wxGUIAppTraits::BeforeChildWaitLoop()
156 We use a dirty hack here to disable all application windows (which we
157 must do because otherwise the calls to wxYield() could lead to some very
158 unexpected reentrancies in the users code) but to avoid losing
159 focus/activation entirely when the child process terminates which would
160 happen if we simply disabled everything using wxWindowDisabler. Indeed,
161 remember that Windows will never activate a disabled window and when the
162 last childs window is closed and Windows looks for a window to activate
163 all our windows are still disabled. There is no way to enable them in
164 time because we don't know when the childs windows are going to be
165 closed, so the solution we use here is to keep one special tiny frame
166 enabled all the time. Then when the child terminates it will get
167 activated and when we close it below -- after reenabling all the other
168 windows! -- the previously active window becomes activated again and
173 // first disable all existing windows
174 wxWindowDisabler
*wd
= new wxWindowDisabler
;
176 // then create an "invisible" frame: it has minimal size, is positioned
177 // (hopefully) outside the screen and doesn't appear on the taskbar
178 wxWindow
*winActive
= new wxFrame
180 wxTheApp
->GetTopWindow(),
183 wxPoint(32600, 32600),
185 wxDEFAULT_FRAME_STYLE
| wxFRAME_NO_TASKBAR
189 return new ChildWaitLoopData(wd
, winActive
);
192 void wxGUIAppTraits::AlwaysYield()
197 void wxGUIAppTraits::AfterChildWaitLoop(void *dataOrig
)
201 ChildWaitLoopData
* const data
= (ChildWaitLoopData
*)dataOrig
;
205 // finally delete the dummy frame and, as wd has been already destroyed and
206 // the other windows reenabled, the activation is going to return to the
207 // window which had had it before
208 data
->winActive
->Destroy();
210 // also delete the temporary data object itself
214 bool wxGUIAppTraits::DoMessageFromThreadWait()
216 // we should return false only if the app should exit, i.e. only if
217 // Dispatch() determines that the main event loop should terminate
218 wxEventLoopBase
* const evtLoop
= wxEventLoop::GetActive();
219 if ( !evtLoop
|| !evtLoop
->Pending() )
221 // no events means no quit event
225 return evtLoop
->Dispatch();
228 DWORD
wxGUIAppTraits::WaitForThread(WXHANDLE hThread
)
230 // if we don't have a running event loop, we shouldn't wait for the
231 // messages as we never remove them from the message queue and so we enter
232 // an infinite loop as MsgWaitForMultipleObjects() keeps returning
234 if ( !wxEventLoop::GetActive() )
235 return DoSimpleWaitForThread(hThread
);
237 return ::MsgWaitForMultipleObjects
239 1, // number of objects to wait for
240 (HANDLE
*)&hThread
, // the objects
241 false, // wait for any objects, not all
242 INFINITE
, // no timeout
243 QS_ALLINPUT
| // return as soon as there are any events
248 wxPortId
wxGUIAppTraits::GetToolkitVersion(int *majVer
, int *minVer
) const
253 // on Windows, the toolkit version is the same of the OS version
254 // as Windows integrates the OS kernel with the GUI toolkit.
255 info
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
256 if ( ::GetVersionEx(&info
) )
259 *majVer
= info
.dwMajorVersion
;
261 *minVer
= info
.dwMinorVersion
;
264 #if defined(__WXHANDHELD__) || defined(__WXWINCE__)
273 wxTimerImpl
*wxGUIAppTraits::CreateTimerImpl(wxTimer
*timer
)
275 return new wxMSWTimerImpl(timer
);
278 #endif // wxUSE_TIMER
280 wxEventLoopBase
* wxGUIAppTraits::CreateEventLoop()
282 return new wxEventLoop
;
285 // ===========================================================================
286 // wxApp implementation
287 // ===========================================================================
289 int wxApp::m_nCmdShow
= SW_SHOWNORMAL
;
291 // ---------------------------------------------------------------------------
293 // ---------------------------------------------------------------------------
295 IMPLEMENT_DYNAMIC_CLASS(wxApp
, wxEvtHandler
)
297 BEGIN_EVENT_TABLE(wxApp
, wxEvtHandler
)
298 EVT_IDLE(wxApp::OnIdle
)
299 EVT_END_SESSION(wxApp::OnEndSession
)
300 EVT_QUERY_END_SESSION(wxApp::OnQueryEndSession
)
303 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
305 class wxCallBaseCleanup
308 wxCallBaseCleanup(wxApp
*app
) : m_app(app
) { }
309 ~wxCallBaseCleanup() { if ( m_app
) m_app
->wxAppBase::CleanUp(); }
311 void Dismiss() { m_app
= NULL
; }
318 bool wxApp::Initialize(int& argc
, wxChar
**argv
)
320 if ( !wxAppBase::Initialize(argc
, argv
) )
323 // ensure that base cleanup is done if we return too early
324 wxCallBaseCleanup
callBaseCleanup(this);
327 wxString tmp
= GetAppName();
328 tmp
+= wxT("ClassName");
329 wxCanvasClassName
= wxStrdup( tmp
.wc_str() );
331 wxCanvasClassNameNR
= wxStrdup( tmp
.wc_str() );
332 HWND hWnd
= FindWindow( wxCanvasClassNameNR
, NULL
);
335 SetForegroundWindow( (HWND
)(((DWORD
)hWnd
)|0x01) );
340 #if !defined(__WXMICROWIN__)
341 InitCommonControls();
342 #endif // !defined(__WXMICROWIN__)
344 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
345 SHInitExtraControls();
349 // Don't show a message box if a function such as SHGetFileInfo
350 // fails to find a device.
351 SetErrorMode(SEM_FAILCRITICALERRORS
|SEM_NOOPENFILEERRORBOX
);
356 RegisterWindowClasses();
358 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
359 wxSetKeyboardHook(true);
362 callBaseCleanup
.Dismiss();
367 // ---------------------------------------------------------------------------
368 // RegisterWindowClasses
369 // ---------------------------------------------------------------------------
371 // TODO we should only register classes really used by the app. For this it
372 // would be enough to just delay the class registration until an attempt
373 // to create a window of this class is made.
374 bool wxApp::RegisterWindowClasses()
377 wxZeroMemory(wndclass
);
379 // for each class we register one with CS_(V|H)REDRAW style and one
380 // without for windows created with wxNO_FULL_REDRAW_ON_REPAINT flag
381 static const long styleNormal
= CS_HREDRAW
| CS_VREDRAW
| CS_DBLCLKS
;
382 static const long styleNoRedraw
= CS_DBLCLKS
;
384 // the fields which are common to all classes
385 wndclass
.lpfnWndProc
= (WNDPROC
)wxWndProc
;
386 wndclass
.hInstance
= wxhInstance
;
387 wndclass
.hCursor
= ::LoadCursor((HINSTANCE
)NULL
, IDC_ARROW
);
389 // register the class for all normal windows
390 wndclass
.hbrBackground
= (HBRUSH
)(COLOR_BTNFACE
+ 1);
391 wndclass
.lpszClassName
= wxCanvasClassName
;
392 wndclass
.style
= styleNormal
;
394 if ( !RegisterClass(&wndclass
) )
396 wxLogLastError(wxT("RegisterClass(frame)"));
400 wndclass
.lpszClassName
= wxCanvasClassNameNR
;
401 wndclass
.style
= styleNoRedraw
;
403 if ( !RegisterClass(&wndclass
) )
405 wxLogLastError(wxT("RegisterClass(no redraw frame)"));
408 // Register the MDI frame window class.
409 wndclass
.hbrBackground
= (HBRUSH
)NULL
; // paint MDI frame ourselves
410 wndclass
.lpszClassName
= wxMDIFrameClassName
;
411 wndclass
.style
= styleNormal
;
413 if ( !RegisterClass(&wndclass
) )
415 wxLogLastError(wxT("RegisterClass(MDI parent)"));
418 // "no redraw" MDI frame
419 wndclass
.lpszClassName
= wxMDIFrameClassNameNoRedraw
;
420 wndclass
.style
= styleNoRedraw
;
422 if ( !RegisterClass(&wndclass
) )
424 wxLogLastError(wxT("RegisterClass(no redraw MDI parent frame)"));
427 // Register the MDI child frame window class.
428 wndclass
.hbrBackground
= (HBRUSH
)(COLOR_WINDOW
+ 1);
429 wndclass
.lpszClassName
= wxMDIChildFrameClassName
;
430 wndclass
.style
= styleNormal
;
432 if ( !RegisterClass(&wndclass
) )
434 wxLogLastError(wxT("RegisterClass(MDI child)"));
437 // "no redraw" MDI child frame
438 wndclass
.lpszClassName
= wxMDIChildFrameClassNameNoRedraw
;
439 wndclass
.style
= styleNoRedraw
;
441 if ( !RegisterClass(&wndclass
) )
443 wxLogLastError(wxT("RegisterClass(no redraw MDI child)"));
449 // ---------------------------------------------------------------------------
450 // UnregisterWindowClasses
451 // ---------------------------------------------------------------------------
453 bool wxApp::UnregisterWindowClasses()
457 #ifndef __WXMICROWIN__
458 // MDI frame window class.
459 if ( !::UnregisterClass(wxMDIFrameClassName
, wxhInstance
) )
461 wxLogLastError(wxT("UnregisterClass(MDI parent)"));
466 // "no redraw" MDI frame
467 if ( !::UnregisterClass(wxMDIFrameClassNameNoRedraw
, wxhInstance
) )
469 wxLogLastError(wxT("UnregisterClass(no redraw MDI parent frame)"));
474 // MDI child frame window class.
475 if ( !::UnregisterClass(wxMDIChildFrameClassName
, wxhInstance
) )
477 wxLogLastError(wxT("UnregisterClass(MDI child)"));
482 // "no redraw" MDI child frame
483 if ( !::UnregisterClass(wxMDIChildFrameClassNameNoRedraw
, wxhInstance
) )
485 wxLogLastError(wxT("UnregisterClass(no redraw MDI child)"));
491 if ( !::UnregisterClass(wxCanvasClassName
, wxhInstance
) )
493 wxLogLastError(wxT("UnregisterClass(canvas)"));
498 if ( !::UnregisterClass(wxCanvasClassNameNR
, wxhInstance
) )
500 wxLogLastError(wxT("UnregisterClass(no redraw canvas)"));
504 #endif // __WXMICROWIN__
509 void wxApp::CleanUp()
511 // all objects pending for deletion must be deleted first, otherwise
512 // UnregisterWindowClasses() call wouldn't succeed (because windows
513 // using the classes being unregistered still exist), so call the base
514 // class method first and only then do our clean up
515 wxAppBase::CleanUp();
517 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
518 wxSetKeyboardHook(false);
523 // for an EXE the classes are unregistered when it terminates but DLL may
524 // be loaded several times (load/unload/load) into the same process in
525 // which case the registration will fail after the first time if we don't
526 // unregister the classes now
527 UnregisterWindowClasses();
530 free( wxCanvasClassName
);
531 free( wxCanvasClassNameNR
);
535 // ----------------------------------------------------------------------------
537 // ----------------------------------------------------------------------------
541 m_printMode
= wxPRINT_WINDOWS
;
548 // ----------------------------------------------------------------------------
549 // wxApp idle handling
550 // ----------------------------------------------------------------------------
552 void wxApp::OnIdle(wxIdleEvent
& WXUNUSED(event
))
554 #if wxUSE_DC_CACHEING
555 // automated DC cache management: clear the cached DCs and bitmap
556 // if it's likely that the app has finished with them, that is, we
557 // get an idle event and we're not dragging anything.
558 if (!::GetKeyState(MK_LBUTTON
) && !::GetKeyState(MK_MBUTTON
) && !::GetKeyState(MK_RBUTTON
))
559 wxMSWDCImpl::ClearCache();
560 #endif // wxUSE_DC_CACHEING
563 void wxApp::WakeUpIdle()
565 // Send the top window a dummy message so idle handler processing will
566 // start up again. Doing it this way ensures that the idle handler
567 // wakes up in the right thread (see also wxWakeUpMainThread() which does
568 // the same for the main app thread only)
569 wxWindow
* const topWindow
= wxTheApp
->GetTopWindow();
572 HWND hwndTop
= GetHwndOf(topWindow
);
574 // Do not post WM_NULL if there's already a pending WM_NULL to avoid
575 // overflowing the message queue.
577 // Notice that due to a limitation of PeekMessage() API (which handles
578 // 0,0 range specially), we have to check the range from 0-1 instead.
579 // This still makes it possible to overflow the queue with WM_NULLs by
580 // interspersing the calles to WakeUpIdle() with windows creation but
581 // it should be rather hard to do it accidentally.
583 if ( !::PeekMessage(&msg
, hwndTop
, 0, 1, PM_NOREMOVE
) ||
584 ::PeekMessage(&msg
, hwndTop
, 1, 1, PM_NOREMOVE
) )
586 if ( !::PostMessage(hwndTop
, WM_NULL
, 0, 0) )
588 // should never happen
589 wxLogLastError(wxT("PostMessage(WM_NULL)"));
595 // ----------------------------------------------------------------------------
596 // other wxApp event hanlders
597 // ----------------------------------------------------------------------------
599 void wxApp::OnEndSession(wxCloseEvent
& WXUNUSED(event
))
601 // Windows will terminate the process soon after we return from
602 // WM_ENDSESSION handler or when we delete our last window, so make sure we
603 // at least execute our cleanup code before
605 // prevent the window from being destroyed when the corresponding wxTLW is
606 // destroyed: this will result in a leak of a HWND, of course, but who
607 // cares when the process is being killed anyhow
608 if ( !wxTopLevelWindows
.empty() )
609 wxTopLevelWindows
[0]->SetHWND(0);
611 const int rc
= OnExit();
615 // calling exit() instead of ExitProcess() or not doing anything at all and
616 // being killed by Windows has the advantage of executing the dtors of
621 // Default behaviour: close the application with prompts. The
622 // user can veto the close, and therefore the end session.
623 void wxApp::OnQueryEndSession(wxCloseEvent
& event
)
627 if (!GetTopWindow()->Close(!event
.CanVeto()))
632 // ----------------------------------------------------------------------------
633 // system DLL versions
634 // ----------------------------------------------------------------------------
636 // these functions have trivial inline implementations for CE
639 #if wxUSE_DYNLIB_CLASS
644 // helper function: retrieve the DLL version by using DllGetVersion(), returns
645 // 0 if the DLL doesn't export such function
646 int CallDllGetVersion(wxDynamicLibrary
& dll
)
648 // now check if the function is available during run-time
649 wxDYNLIB_FUNCTION( DLLGETVERSIONPROC
, DllGetVersion
, dll
);
650 if ( !pfnDllGetVersion
)
654 dvi
.cbSize
= sizeof(dvi
);
656 HRESULT hr
= (*pfnDllGetVersion
)(&dvi
);
659 wxLogApiError(_T("DllGetVersion"), hr
);
664 return 100*dvi
.dwMajorVersion
+ dvi
.dwMinorVersion
;
667 } // anonymous namespace
670 int wxApp::GetComCtl32Version()
674 // NB: this is MT-ok as in the worst case we'd compute s_verComCtl32 twice,
675 // but as its value should be the same both times it doesn't matter
676 static int s_verComCtl32
= -1;
678 if ( s_verComCtl32
== -1 )
680 // we're prepared to handle the errors
683 // the DLL should really be available
684 wxDynamicLibrary
dllComCtl32(_T("comctl32.dll"), wxDL_VERBATIM
);
685 if ( !dllComCtl32
.IsLoaded() )
691 // try DllGetVersion() for recent DLLs
692 s_verComCtl32
= CallDllGetVersion(dllComCtl32
);
694 // if DllGetVersion() is unavailable either during compile or
695 // run-time, try to guess the version otherwise
696 if ( !s_verComCtl32
)
698 // InitCommonControlsEx is unique to 4.70 and later
699 void *pfn
= dllComCtl32
.GetSymbol(_T("InitCommonControlsEx"));
702 // not found, must be 4.00
707 // many symbols appeared in comctl32 4.71, could use any of
708 // them except may be DllInstall()
709 pfn
= dllComCtl32
.GetSymbol(_T("InitializeFlatSB"));
712 // not found, must be 4.70
717 // found, must be 4.71 or later
724 return s_verComCtl32
;
728 int wxApp::GetShell32Version()
730 static int s_verShell32
= -1;
731 if ( s_verShell32
== -1 )
733 // we're prepared to handle the errors
736 wxDynamicLibrary
dllShell32(_T("shell32.dll"), wxDL_VERBATIM
);
737 if ( dllShell32
.IsLoaded() )
739 s_verShell32
= CallDllGetVersion(dllShell32
);
743 // there doesn't seem to be any way to distinguish between 4.00
744 // and 4.70 (starting from 4.71 we have DllGetVersion()) so
745 // just assume it is 4.0
749 else // failed load the DLL?
758 #else // !wxUSE_DYNLIB_CLASS
761 int wxApp::GetComCtl32Version()
767 int wxApp::GetShell32Version()
772 #endif // wxUSE_DYNLIB_CLASS/!wxUSE_DYNLIB_CLASS
774 #endif // !__WXWINCE__
776 // ----------------------------------------------------------------------------
777 // Yield to incoming messages
778 // ----------------------------------------------------------------------------
780 bool wxApp::Yield(bool onlyIfNeeded
)
783 static bool s_inYield
= false;
786 // disable log flushing from here because a call to wxYield() shouldn't
787 // normally result in message boxes popping up &c
795 wxFAIL_MSG( wxT("wxYield called recursively" ) );
803 // we don't want to process WM_QUIT from here - it should be processed in
804 // the main event loop in order to stop it
806 while ( PeekMessage(&msg
, (HWND
)0, 0, 0, PM_NOREMOVE
) &&
807 msg
.message
!= WM_QUIT
)
810 wxMutexGuiLeaveOrEnter();
811 #endif // wxUSE_THREADS
813 if ( !wxTheApp
->Dispatch() )
817 // if there are pending events, we must process them.
818 ProcessPendingEvents();
821 // let the logs be flashed again
832 // ----------------------------------------------------------------------------
833 // exception handling
834 // ----------------------------------------------------------------------------
836 bool wxApp::OnExceptionInMainLoop()
838 // ask the user about what to do: use the Win32 API function here as it
839 // could be dangerous to use any wxWidgets code in this state
844 _T("An unhandled exception occurred. Press \"Abort\" to \
845 terminate the program,\r\n\
846 \"Retry\" to exit the program normally and \"Ignore\" to try to continue."),
847 _T("Unhandled exception"),
848 MB_ABORTRETRYIGNORE
|
858 wxFAIL_MSG( _T("unexpected MessageBox() return code") );
869 #endif // wxUSE_EXCEPTIONS