Use "wx" prefix for the GUIDs we (re)define in wxMSW code.

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

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

-// Name:        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,114 +18,136 @@
 
 #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"
 
 // ----------------------------------------------------------------------------

-// 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);
+
+// 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;
+}
+
+// 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;
+}

 
 

-wxTimerMap wxTimerList;

 
 

-void WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);

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

-// macros
+// private functions

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

-#ifdef __WIN32__
-    #define _EXPORT
-#else
-    #define _EXPORT _export
-#endif
-
-// should probably be in wx/msw/private.h
-#ifdef __WXMICROWIN__
-    #define MakeProcInstance(proc, hinst) proc
-#endif
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam);

 
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+// implemented in utils.cpp
+extern "C" WXDLLIMPEXP_BASE HWND
+wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);

 
 

-// ============================================================================
-// implementation
-// ============================================================================

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

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

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

-void wxTimer::Init()
+class wxTimerHiddenWindowModule : public wxModule

 {
 {

-    m_id = 0;
-}
+public:
+    // module init/finalize
+    virtual bool OnInit();
+    virtual void OnExit();

 
 

-wxTimer::~wxTimer()
-{
-    long id = m_id;
+    // get the hidden window (creates on demand)
+    static HWND GetHWND();

 
 

-    wxTimer::Stop();
+private:
+    // the HWND of the hidden window
+    static HWND ms_hwnd;

 
 

-    wxTimerList.erase(id);
-}
+    // the class used to create it
+    static const wxChar *ms_className;

 
 

-bool wxTimer::Start(int milliseconds, bool oneShot)
-{
-    (void)wxTimerBase::Start(milliseconds, oneShot);
+    DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule)
+};

 
 

-    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeour") );
+IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)

 
 

-#ifdef __WXWINCE__
-    m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                      (UINT)m_milli, (TIMERPROC) wxTimerProc);
-#else
-    TIMERPROC wxTimerProcInst = (TIMERPROC)
-        MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance());
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-    m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                      (UINT)m_milli, wxTimerProcInst);
-#endif

 
 

-    if ( m_id > 0 )
-    {
-        wxTimerList[m_id] = this;
+// ----------------------------------------------------------------------------
+// wxMSWTimerImpl class
+// ----------------------------------------------------------------------------

 
 

-        return true;
-    }
-    else
+bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
+{
+    if ( !wxTimerImpl::Start(milliseconds, oneShot) )
+        return false;
+
+    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;
     }
     {
         wxLogSysError(_("Couldn't create a timer"));
 
         return false;
     }

+
+    return true;

 }
 
 }
 

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

 {
 {

-    if ( m_id )
-    {
-        ::KillTimer(NULL, (UINT)m_id);
-
-        wxTimerList.erase(m_id);
-    }
-
+    ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
+    TimerMap().erase(m_id);

     m_id = 0;
 }
 
     m_id = 0;
 }
 


@@ -137,11 +155,9 @@ void wxTimer::Stop()
 // private functions
 // ----------------------------------------------------------------------------
 
 // private functions
 // ----------------------------------------------------------------------------
 

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

 {
 {

-    // Avoid to process spurious timer events
-    if ( timer.m_id == 0)
-        return;
+    wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );

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


@@ -149,16 +165,80 @@ void wxProcessTimer(wxTimer& timer)
     timer.Notify();
 }
 
     timer.Notify();
 }
 

-void WINAPI _EXPORT wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
+
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam)

 {
 {

-    
-    wxTimerMap::iterator node = wxTimerList.find((long)idTimer);
+    if ( message == WM_TIMER )
+    {
+        wxTimerMap::iterator node = TimerMap().find(wParam);
+
+        if ( node != TimerMap().end() )
+        {
+            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().
+    }
+
+    return ::DefWindowProc(hWnd, message, wParam, lParam);
+}
+
+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule functions
+// ----------------------------------------------------------------------------
+

 
 

-    wxASSERT_MSG( node != wxTimerList.end(), wxT("bogus timer id in wxTimerProc") );
+HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;

 
 

-    wxProcessTimer(*(node->second));
+const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
+
+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;
+}
+
+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;
+    }
+}
+
+/* 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 0;
+    return ms_hwnd;

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