linking fix for wxUSE_VALIDATORS==0

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

diff --git a/src/msw/timer.cpp b/src/msw/timer.cpp
index 822ece8f3577d0e1dac104cf33b00e1d43ba4866..0db65998b1052be40bce756513de04237cad3d08 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
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-    #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,107 +18,137 @@
 
 #if wxUSE_TIMER
 
 
 #if wxUSE_TIMER
 

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

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/hashmap.h"
-    #include "wx/setup.h"
-    #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/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);

 
 

-wxTimerMap wxTimerList;
-UINT WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
+// 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;
+}

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

-// macros
+// private functions

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

-#ifdef __WIN32__
-    #define _EXPORT
-#else
-    #define _EXPORT _export
-#endif
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam);

 
 

-// should probably be in wx/msw/private.h
-#ifdef __WXMICROWIN__
-    #define MakeProcInstance(proc, hinst) proc
-#endif
+// implemented in utils.cpp
+extern "C" WXDLLIMPEXP_BASE HWND
+wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);

 
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
-
-// ============================================================================
-// 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)
+
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-    TIMERPROC wxTimerProcInst = (TIMERPROC)
-        MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance());

 
 

-    m_id = ::SetTimer(NULL, (UINT)(m_id ? m_id : 1),
-                      (UINT)m_milli, wxTimerProcInst);
+// ----------------------------------------------------------------------------
+// wxMSWTimerImpl class
+// ----------------------------------------------------------------------------

 
 

-    if ( m_id > 0 )
+bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
+{
+    if ( !wxTimerImpl::Start(milliseconds, oneShot) )
+        return false;
+
+    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 )

     {
     {

-        wxTimerList[m_id] = this;
+        wxLogSysError(_("Couldn't create a timer"));

 
 

-        return true;
+        return false;

     }
     }

-    else
+
+    // 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
+    //
+    // 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() )

     {
     {

-        wxLogSysError(_("Couldn't create a timer"));
+        wxLogError(_("Timer creation failed."));
+
+        ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
+        m_id = 0;

 
         return false;
     }
 
         return false;
     }

+
+    TimerMap()[m_id] = this;
+
+    return true;

 }
 
 }
 

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

 {
 {

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

 
 

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

 
     m_id = 0;
 }
 
     m_id = 0;
 }


@@ -131,11 +157,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();


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

-UINT WINAPI _EXPORT wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
-{
-    
-    wxTimerMap::iterator node = wxTimerList.find((long)idTimer);

 
 

-    wxCHECK_MSG( node != wxTimerList.end(), 0,
-                 wxT("bogus timer id in wxTimerProc") );
+LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
+                                        WPARAM wParam, LPARAM lParam)
+{
+    if ( message == WM_TIMER )
+    {
+        wxTimerMap::iterator node = TimerMap().find(wParam);

 
 

-    wxProcessTimer(*(node->second));
+        wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") );

 
 

+        wxProcessTimer(*(node->second));
+    }
+    else
+    {
+        return ::DefWindowProc(hWnd, message, wParam, lParam);
+    }

     return 0;
 }
 
     return 0;
 }
 

+// ----------------------------------------------------------------------------
+// wxTimerHiddenWindowModule functions
+// ----------------------------------------------------------------------------
+
+
+HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
+
+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 ms_hwnd;
+}
+

 #endif // wxUSE_TIMER
 #endif // wxUSE_TIMER