No changes, just minor cleanup.

[wxWidgets.git] / src / msw / timer.cpp

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 883f67bfa2fc9909148d0d304b429122b32d13b2..0db65998b1052be40bce756513de04237cad3d08 100644 (file)
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msw/timer.cpp
+// Name:        src/msw/timer.cpp

 // Purpose:     wxTimer implementation
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)
 // Purpose:     wxTimer implementation
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)


@@ -9,10 +9,6 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "timer.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -22,19 +18,18 @@
 
 #if wxUSE_TIMER
 
 
 #if wxUSE_TIMER
 

+#include "wx/msw/private/timer.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/window.h"

     #include "wx/list.h"
     #include "wx/event.h"
     #include "wx/app.h"
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/list.h"
     #include "wx/event.h"
     #include "wx/app.h"
     #include "wx/intl.h"
     #include "wx/log.h"

+    #include "wx/hashmap.h"
+    #include "wx/module.h"

 #endif
 
 #endif
 

-#include "wx/hashmap.h"
-
-#include "wx/timer.h"
-

 #include "wx/msw/private.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/msw/private.h"
 
 // ----------------------------------------------------------------------------


@@ -43,55 +38,79 @@
 
 // define a hash containing all the timers: it is indexed by timer id and
 // contains the corresponding timer
 
 // define a hash containing all the timers: it is indexed by timer id and
 // contains the corresponding timer

-WX_DECLARE_HASH_MAP(unsigned long, wxTimer *, wxIntegerHash, wxIntegerEqual,
+WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,

                     wxTimerMap);
 
                     wxTimerMap);
 

-static wxTimerMap g_timerMap;
+// instead of using a global here, wrap it in a static function as otherwise it
+// could have been used before being initialized if a timer object were created
+// globally
+static wxTimerMap& TimerMap()
+{
+    static wxTimerMap s_timerMap;
+
+    return s_timerMap;
+}

 
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 

-// timer callback used for all timers
-void WINAPI wxTimerProc(HWND hwnd, UINT msg, UINT idTimer, DWORD dwTime);
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam);
+
+// implemented in utils.cpp
+extern "C" WXDLLIMPEXP_BASE HWND
+wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
+

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// macros
+// wxTimerHiddenWindowModule: used to manage the hidden window used for
+// catching timer messages (we need a module to ensure that the window is
+// always deleted)

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
+class wxTimerHiddenWindowModule : public wxModule
+{
+public:
+    // module init/finalize
+    virtual bool OnInit();
+    virtual void OnExit();
+
+    // get the hidden window (creates on demand)
+    static HWND GetHWND();
+
+private:
+    // the HWND of the hidden window
+    static HWND ms_hwnd;
+
+    // the class used to create it
+    static const wxChar *ms_className;
+
+    DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule)
+};
+
+IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 
 // ============================================================================
 // implementation
 // ============================================================================
 

+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxTimer class
+// wxMSWTimerImpl class

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-void wxTimer::Init()
-{
-    m_id = 0;
-}
-
-wxTimer::~wxTimer()
-{
-    wxTimer::Stop();
-}
-
-bool wxTimer::Start(int milliseconds, bool oneShot)
+bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)

 {
 {

-    (void)wxTimerBase::Start(milliseconds, oneShot);
-
-    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
+    if ( !wxTimerImpl::Start(milliseconds, oneShot) )
+        return false;

 
 

-    m_id = ::SetTimer
-             (
-                NULL,                       // don't use window
-                1,                          // id ignored with NULL hwnd anyhow
-                (UINT)m_milli,              // delay
-                wxTimerProc                 // timer proc to call
-             );
+    m_id = ::SetTimer(
+        wxTimerHiddenWindowModule::GetHWND(),  // window to send the messages to
+        GetId(),                               // timer ID
+        (UINT)m_milli,                         // delay
+        NULL                                   // timer proc.  Not used since we pass hwnd
+        );

 
     if ( !m_id )
     {
 
     if ( !m_id )
     {


@@ -103,29 +122,33 @@ bool wxTimer::Start(int milliseconds, bool oneShot)
     // check that SetTimer() didn't reuse an existing id: according to the MSDN
     // this can happen and this would be catastrophic to us as we rely on ids
     // uniquely identifying the timers because we use them as keys in the hash
     // check that SetTimer() didn't reuse an existing id: according to the MSDN
     // this can happen and this would be catastrophic to us as we rely on ids
     // uniquely identifying the timers because we use them as keys in the hash

-    if ( g_timerMap.find(m_id) != g_timerMap.end() )
+    //
+    // notice that this also happens if the same id is reused for multiple
+    // timers: this used to work in previous versions but was never supported
+    // and absolutely shouldn't be done, use wxID_ANY to assign an id to the
+    // timer automatically or ensure that all your timers have unique ids
+    if ( TimerMap().find(m_id) != TimerMap().end() )

     {
         wxLogError(_("Timer creation failed."));
 
     {
         wxLogError(_("Timer creation failed."));
 

-        ::KillTimer(NULL, m_id);
+        ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);

         m_id = 0;
 
         return false;
     }
 
         m_id = 0;
 
         return false;
     }
 

-    g_timerMap[m_id] = this;
+    TimerMap()[m_id] = this;

 
     return true;
 }
 
 
     return true;
 }
 

-void wxTimer::Stop()
+void wxMSWTimerImpl::Stop()

 {
 {

-    if ( m_id )
-    {
-        ::KillTimer(NULL, m_id);
+    wxASSERT_MSG( m_id, wxT("should be running") );

 
 

-        g_timerMap.erase(m_id);
-    }
+    ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
+
+    TimerMap().erase(m_id);

 
     m_id = 0;
 }
 
     m_id = 0;
 }


@@ -134,9 +157,9 @@ void wxTimer::Stop()
 // private functions
 // ----------------------------------------------------------------------------
 
 // private functions
 // ----------------------------------------------------------------------------
 

-void wxProcessTimer(wxTimer& timer)
+void wxProcessTimer(wxMSWTimerImpl& timer)

 {
 {

-    wxASSERT_MSG( timer.m_id != 0, _T("bogus timer id") );
+    wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );

 
     if ( timer.IsOneShot() )
         timer.Stop();
 
     if ( timer.IsOneShot() )
         timer.Stop();


@@ -144,18 +167,78 @@ void wxProcessTimer(wxTimer& timer)
     timer.Notify();
 }
 
     timer.Notify();
 }
 

-void WINAPI
-wxTimerProc(HWND WXUNUSED(hwnd),
-            UINT WXUNUSED(msg),
-            UINT idTimer,
-            DWORD WXUNUSED(dwTime))
+
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam)
+{
+    if ( message == WM_TIMER )
+    {
+        wxTimerMap::iterator node = TimerMap().find(wParam);
+
+        wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") );
+
+        wxProcessTimer(*(node->second));
+    }
+    else
+    {
+        return ::DefWindowProc(hWnd, message, wParam, lParam);
+    }
+    return 0;
+}
+
+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule functions
+// ----------------------------------------------------------------------------
+
+
+HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
+
+const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
+
+bool wxTimerHiddenWindowModule::OnInit()

 {
 {

-    wxTimerMap::iterator node = g_timerMap.find(idTimer);
+    // do not initialize ms_hwnd to ms_className to NULL here: it may happen
+    // that our GetHWND() is called before the modules are initialized if a
+    // timer is created from wxApp-derived class ctor and in this case we
+    // shouldn't overwrite it

 
 

-    wxCHECK_RET( node != g_timerMap.end(), wxT("bogus timer id in wxTimerProc") );
+    return true;
+}

 
 

-    wxProcessTimer(*(node->second));
+void wxTimerHiddenWindowModule::OnExit()
+{
+    if ( ms_hwnd )
+    {
+        if ( !::DestroyWindow(ms_hwnd) )
+        {
+            wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
+        }
+
+        ms_hwnd = NULL;
+    }
+
+    if ( ms_className )
+    {
+        if ( !::UnregisterClass(ms_className, wxGetInstance()) )
+        {
+            wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
+        }
+
+        ms_className = NULL;
+    }

 }
 
 }
 

-#endif // wxUSE_TIMER
+/* static */
+HWND wxTimerHiddenWindowModule::GetHWND()
+{
+    static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
+    if ( !ms_hwnd )
+    {
+        ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
+                                     wxTimerWndProc);
+    }

 
 

+    return ms_hwnd;
+}
+
+#endif // wxUSE_TIMER