Fix typo in last commit

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 1ebd9535cf3877277eab4a062641c8fcbfac3d3d..fae7e00d87c712b541b601db363c7214413e310f 100644 (file)
--- a/src/msw/timer.cpp
+++ b/src/msw/timer.cpp
@@ -1,18 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxTimer implementation
 // Author:      Julian Smart
 // Purpose:     wxTimer implementation
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)

 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // 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,208 +18,227 @@
 
 #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/module.h"
-
-#include "wx/timer.h"
-

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

-// from utils.cpp
-extern "C" HWND
-wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
-

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

-// private functions
+// private globals

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

-WX_DECLARE_HASH_MAP( long,
-                     wxTimer *,
-                     wxIntegerHash,
-                     wxIntegerEqual,
-                     wxTimerMap );
+// define a hash containing all the timers: it is indexed by timer id and
+// contains the corresponding timer
+WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,
+                    wxTimerMap);

 
 

-wxTimerMap wxTimerList;
+// 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;

 
 

-void WINAPI wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+    return s_timerMap;
+}
+
+// This gets a unique, non-zero timer ID and creates an entry in the TimerMap
+UINT_PTR GetNewTimerId(wxMSWTimerImpl *t)
+{
+    static UINT_PTR lastTimerId = 0;
+
+    while (lastTimerId == 0 ||
+            TimerMap().find(lastTimerId) != TimerMap().end())
+    {
+        lastTimerId = lastTimerId + 1;
+    }
+
+    TimerMap()[lastTimerId] = t;
+
+    return lastTimerId;
+}

 
 

-// ----------------------------------------------------------------------------
-// macros
-// ----------------------------------------------------------------------------

 
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)

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

-// globals
+// private functions

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

-// these variables are for timer shared hwnd management
-static const wxChar *wxMSWTIMER_WNDCLASSNAME = wxT("_wxTimer_Internal_Class");
-static LPCTSTR s_classnameTimerWnd = NULL;
-static HWND s_hwndTimer = NULL;
+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);
+

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

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

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

-class wxTimerModule : public wxModule
+class wxTimerHiddenWindowModule : public wxModule

 {
 public:
 {
 public:

-    virtual bool OnInit() { return true; }
-    virtual void OnExit()
-    {
-        if ( s_hwndTimer )
-        {
-            ::DestroyWindow(s_hwndTimer);
-            s_hwndTimer = NULL;
-
-            if ( !::UnregisterClass(wxMSWTIMER_WNDCLASSNAME, wxGetInstance()) )
-            {
-                wxLogLastError(_T("UnregisterClass(wxTimerClass)"));
-            }
+    // module init/finalize
+    virtual bool OnInit();
+    virtual void OnExit();

 
 

-            s_classnameTimerWnd = NULL;
-        }
-    }
+    // get the hidden window (creates on demand)
+    static HWND GetHWND();

 
 private:
 
 private:

-    DECLARE_DYNAMIC_CLASS(wxTimerModule)
+    // 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()
+bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)

 {
 {

-    m_id = 0;
-    m_hwnd = NULL;
-}
+    if ( !wxTimerImpl::Start(milliseconds, oneShot) )
+        return false;

 
 

-wxTimer::~wxTimer()
-{
-    // save id as Stop() changes it
-    long id = m_id;
+    m_id = GetNewTimerId(this);
+    // SetTimer() normally returns just idTimer but this might change in the
+    // future so use its return value to be safe
+    UINT_PTR ret = ::SetTimer
+             (
+              wxTimerHiddenWindowModule::GetHWND(),  // window for WM_TIMER
+              m_id,                                  // timer ID to create
+              (UINT)m_milli,                         // delay
+              NULL                                   // timer proc (unused)
+             );
+
+    if ( ret == 0 )
+    {
+        wxLogSysError(_("Couldn't create a timer"));
+
+        return false;
+    }

 
 

-    wxTimer::Stop();
+    return true;
+}

 
 

-    wxTimerList.erase(id);
+void wxMSWTimerImpl::Stop()
+{
+    ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
+    TimerMap().erase(m_id);
+    m_id = 0;

 }
 
 }
 

-bool wxTimer::Start(int milliseconds, bool oneShot)
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+void wxProcessTimer(wxMSWTimerImpl& timer)

 {
 {

-    (void)wxTimerBase::Start(milliseconds, oneShot);
+    wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );

 
 

-    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
+    if ( timer.IsOneShot() )
+        timer.Stop();
+
+    timer.Notify();
+}

 
 

-    // find a window for SetTimer(): it should be a valid HWND owned by this
-    // thread (even if we had a non NULL m_hwnd before, reset it in case the
-    // owner has changed)
-    m_hwnd = NULL;

 
 

-    // first try the owner window
-    if ( m_owner )
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam)
+{
+    if ( message == WM_TIMER )

     {
     {

-        wxWindow *win = wxDynamicCast(m_owner, wxWindow);
-        if ( win )
+        wxTimerMap::iterator node = TimerMap().find(wParam);
+
+        if ( node != TimerMap().end() )

         {
         {

-            m_hwnd = win->GetHWND();
+            wxProcessTimer(*(node->second));
+
+            return 0;

         }
         }

+        //else: Unknown timer, probably one of our timers that had fired just
+        //      before being removed from the timers map by Stop().

     }
 
     }
 

-    // if not, use a shared hidden window
-    if ( !m_hwnd )
-    {
-        if ( !s_hwndTimer )
-        {
-            s_hwndTimer = wxCreateHiddenWindow
-                          (
-                            &s_classnameTimerWnd,
-                            wxMSWTIMER_WNDCLASSNAME,
-                            ::DefWindowProc
-                          );
-
-            if ( !s_hwndTimer )
-            {
-                wxASSERT_MSG( s_hwndTimer, wxT("can't create a HWND for wxTimer") );
-                return false;
-            }
-        }
+    return ::DefWindowProc(hWnd, message, wParam, lParam);
+}

 
 

-        m_hwnd = (WXHWND)s_hwndTimer;
+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule functions
+// ----------------------------------------------------------------------------

 
 

-    }

 
 

-    m_id = ::SetTimer
-             (
-                (HWND)m_hwnd,
-                (UINT)(m_id ? m_id : 1),
-                (UINT)m_milli,
-                (TIMERPROC)wxTimerProc
-             );
+HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;

 
 

-    if ( !m_id )
-    {
-        wxLogSysError(_("Couldn't create a timer"));
+const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;

 
 

-        return false;
-    }
-
-    wxTimerList[m_id] = this;
+bool wxTimerHiddenWindowModule::OnInit()
+{
+    // 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

 
     return true;
 }
 
 
     return true;
 }
 

-void wxTimer::Stop()
+void wxTimerHiddenWindowModule::OnExit()

 {
 {

-    if ( m_id )
+    if ( ms_hwnd )

     {
     {

-        ::KillTimer((HWND)m_hwnd, (UINT)m_id);
-        m_hwnd = NULL;
+        if ( !::DestroyWindow(ms_hwnd) )
+        {
+            wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
+        }

 
 

-        wxTimerList.erase(m_id);
+        ms_hwnd = NULL;

     }
 
     }
 

-    m_id = 0;
-}
-
-// ----------------------------------------------------------------------------
-// private functions
-// ----------------------------------------------------------------------------
-
-void wxProcessTimer(wxTimer& timer)
-{
-    // Avoid to process spurious timer events
-    if ( timer.m_id == 0)
-        return;
-
-    if ( timer.IsOneShot() )
-        timer.Stop();
+    if ( ms_className )
+    {
+        if ( !::UnregisterClass(ms_className, wxGetInstance()) )
+        {
+            wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
+        }

 
 

-    timer.Notify();
+        ms_className = NULL;
+    }

 }
 
 }
 

-void WINAPI wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
+/* static */
+HWND wxTimerHiddenWindowModule::GetHWND()

 {
 {

-    wxTimerMap::iterator node = wxTimerList.find((long)idTimer);
-
-    wxASSERT_MSG( node != wxTimerList.end(), wxT("bogus timer id in wxTimerProc") );
+    static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
+    if ( !ms_hwnd )
+    {
+        ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
+                                     wxTimerWndProc);
+    }

 
 

-    wxProcessTimer(*(node->second));
+    return ms_hwnd;

 }
 
 #endif // wxUSE_TIMER
 }
 
 #endif // wxUSE_TIMER

-